rename test.c to gen_asm.c

Author: kristjanvalur

.gitignore

@@ -53,6 +53,7 @@ dkms.conf
 
 # custom
 bin/
+gen_asm.s
 
 # Visual Studio noise
 # Visual Studio 2015/2017 cache/options directory

README.md

@@ -111,7 +111,8 @@ behaviour on the C-stack level, could make use of simple, stable code, that can
 platforms as they come along.
 
 ## Cross-compilation
-Linux on x86-64 can be used to cross compile for x86 and ARM targets.  This is most useful to generate assembly code, e.g. when compiling src/platform/test.c
+Linux on x86-64 can be used to cross compile for x86 and ARM targets.  This is most useful to generate assembly code, e.g. when compiling
+src/platform/gen_asm.c
  - x86 requires the -m32 flag to compilers and linkers.
  - arm32 requires to use the arm-linux-gnueabi-* tools, including cc and linker
  - aarch64 requires the aarch64-linux-gnu-* tools.

lib/sysv_i386/libstackman.a

@@ -1,16 +1,14 @@
 /* function to test the generation
  * of assembly code under e.g. Gcc.
  * use by calling, for example:
- *  cc -S -m32 -fcf-protection=none test.c
+ *  cc -S -m32 -fcf-protection=none gen_asm.c
  * and examinine the generated test.s assembly code.
  * -m32 selects 32 bit mode, use other directives to select a different platform.
- * The -fcf-protection
- * flag disables generation of intel CET compatible code, but stack switching
- * is not compatible with the proposed shadow stack.
+ * The -fcf-protection flag disables generation of intel CET compatible code, but stack switching
+ * is not compatible with the proposed shadow stack.  Only the latest compilers have it.
  */
 
 #define STACKMAN_VERBOSE
-#define STACKMAN_SWITCH_IMPL
 #define STACKMAN_INLINE_ASM 1
 #define STACKMAN_BUILD_LIB /* so that we don´t generate indirection shims */
-#include "platform.h"
+#include "../stackman_impl.h"

src/platforms/test.c renamed to src/platforms/gen_asm.c

@@ -5,12 +5,12 @@
  * implementation that is independent of subtleties of inline
  * assembly code which may change with compiler versions.
  * The file is generated using
- * "aarch64-linux-gnu-gcc -DSTACKMAN_SWITCH_IMPL -S test.c"
- * and then copying the code from test.s into this file.
+ * "aarch64-linux-gnu-gcc -S gen_asm.c"
+ * and then copying the code from gen_asm.s into this file.
  * 
  */
 	.arch armv8-a
-	.file	"test.c"
+	.file	"gen_asm.c"
 	.text
 	.align	2
 	.global	stackman_switch

src/platforms/switch_aarch64_gcc.S

@@ -23,9 +23,9 @@
 #if !__ASSEMBLER__ && !defined(STACKMAN_ASSEMBLY_SRC)
 
 /* 
- * To test this, #include this file in a file, test.c and
- * gcc -S -DSTACKMAN_SWITCH_IMPL test.c
- * then examine test.s for the result.
+ * To test this, compile with appropriate cross platform flags, e.g.
+ * "arm-linux-gnueabi-gcc -S gen_asm.c"
+ * then examine gen_asm.s for the result.
  * We instruct optimizer to not omit frame pointers, -fno-omit_frame_pointer
  * and not use local stack vars, -O1.
  * option is applied with an __attribute__.

src/platforms/switch_aarch64_gcc.h

@@ -3,8 +3,8 @@
  * dependable, such as with clang on linux x86_64 or if
  * STACKMAN_INLINE_ASM is false
  * The file is generated using
- * "arm-linux-gnueabi-gcc -DSTACKMAN_SWITCH_IMPL -S test.c" and then copying the code
- * from test.s into this file.
+ * "arm-linux-gnueabi-gcc -S gen_asm.c" and then copying the code
+ * from gen_asm.s into this file.
  * 
  */
 	.arch armv5t
@@ -17,7 +17,7 @@
 	.eabi_attribute 30, 6
 	.eabi_attribute 34, 0
 	.eabi_attribute 18, 4
-	.file	"test.c"
+	.file	"gen_asm.c"
 	.text
 	.align	2
 	.global	stackman_switch

src/platforms/switch_arm_gcc.S

@@ -29,10 +29,10 @@
  * stack pointer on function exit, thereby invalidating our changes
  * to the stack pointer.
  * To arrive at reasonable assembler, follow some approach similar to:
- * cp switch_arm_gcc.h test.c
- * gcc -S -O -DSTACKMAN_SWITCH_IMPL test.c
- * mv test.s switch_arm_gcc.s
- * assembly code which can then be modified for actual use.  Simple optimized
+ * "gcc -S gen_asm.c"
+ *  to generate gen_asm.s which can then be 
+ * modified for actual use.
+ * Simple optimized
  * version is better than no-optimized because the latter uses stack
  * variables for arguments.  And it turns out that this version actually
  * runs because it does not use fp for restoring the stack pointer

src/platforms/switch_arm_gcc.h

@@ -5,11 +5,11 @@
  * implementation that is independent of subtleties of inline
  * assembly code which may change with compiler versions.
  * The file is generated using
- * "gcc -DSTACKMAN_SWITCH_IMPL -S -fcf-protection=none test.c"
- * and then copying the code from test.s into this file.
+ * "gcc -S -fcf-protection=none gen_asm.c"
+ * and then copying the code from gen_asm.s into this file.
  * 
  */
-	.file	"test.c"
+	.file	"gen_asm.c"
 	.text
 	.globl	stackman_switch
 	.type	stackman_switch, @function

src/platforms/switch_x86_64_gcc.S

@@ -5,11 +5,11 @@
  * implementation that is independent of subtleties of inline
  * assembly code which may change with compiler versions.
  * The file is generated using
- * "gcc -DSTACKMAN_SWITCH_IMPL -S -m32 -fcf-protection=none test.c"
- * and then copying the code from test.s into this file.
+ * "gcc -S -m32 -fcf-protection=none gen_asm.c"
+ * and then copying the code from gen_asm.s into this file.
  * 
  */
-	.file	"test.c"
+	.file	"gen_asm.c"
 	.text
 	.globl	stackman_switch
 	.type	stackman_switch, @function