perf test: Make leafloop workload immune to compiler options
James Clark
reviewerPATCH v2 1/1 perf test: Make leafloop workload immune to compiler options
Since the leafloop test program was moved into the main Perf binary as a workload, it inherited the same compiler options as Perf. In this case the -fstack-protector option broke the assumption that simple leaf frames don't have a stack frame on Arm. This causes test_arm_callgraph_fp.sh to pass even if the stack isn't augmented with the link register, making the test useless.
Fix it by rewriting the leaf function in assembly seeing as it's so simple. Adding -fno-stack-protector would also work, but wouldn't be robust against other future compiler option additions.
The local variables and 'a' variable were never needed so remove them to simplify.
---
Changes in v2:
- Push and pop asm sections - (Sashiko)
- Add .size directive - (Sashiko)
- Add asm label for done and test with LTO enabled - (Sashiko)
- Link to v1: https://lore.kernel.org/r/[email protected]
--- tools/perf/tests/workloads/leafloop.c | 40 +++++++++++++++++++++++++++-------- 1 file changed, 31 insertions(+), 9 deletions(-)
tools/perf/tests/workloads/leafloop.c +31 -9
@@ -6,26 +6,48 @@#include "../tests.h" /* We want to check these symbols in perf script */ -noinline void leaf(volatile int b); -noinline void parent(volatile int b); +noinline void leaf(void); +noinline void parent(void); -static volatile int a; -static volatile sig_atomic_t done; +static volatile sig_atomic_t done asm("leafloop_done" );static void sighandler (int sig__maybe_unused ) { done =1 ; } -noinline void leaf(volatile int b) +#if defined(__aarch64__) +/* +* Write leaf() in assembly so it stays as a minimal leaf function with no +* stack frame and won't get silently broken in the future by any Perf wide +* compilation options like -fstack-protector-all. +*/ +asm( +".pushsection .text,\"ax\",%progbits\n" +".global leaf\n" +".type leaf, %function\n" +"leaf:\n" +" adrp x1, leafloop_done\n" +" ldr w2, [x1, #:lo12:leafloop_done]\n" +" cbz w2, leaf\n" +" ret\n" +".size leaf, .-leaf\n" +".popsection\n" +); + +#else + +noinline void leaf(void) {while (!done) - a += b; + ; } -noinline void parent(volatile int b) +#endif + +noinline void parent(void) { -leaf (b); +leaf (); }static int leafloop (int argc,const char **argv)
@@ -39,7 +61,7 @@ static int leafloop(int argc, const char **argv)signal (SIGALRM , sighandler);alarm (sec); -parent (sec); +parent ();return 0 ; }
---
base-commit: 8c8f2093614373ea8179b562320212a25cf937c0
change-id: 20260508-james-perf-leafloop-stack-c221600eddf2
Best regards,
Signature · 1 line
James Clark <[email protected]>
Quoted 58 lines · James Clark
Since the leafloop test program was moved into the main Perf binary as a workload, it inherited the same compiler options as Perf. In this case the -fstack-protector option broke the assumption that simple leaf frames don't have a stack frame on Arm. This causes
test_arm_callgraph_fp.shto pass even if the stack isn't augmented with the link register, making the test useless.Fix it by rewriting the leaf function in assembly seeing as it's so simple. Adding -fno-stack-protector would also work, but wouldn't be robust against other future compiler option additions.
The local variables and 'a' variable were never needed so remove them to simplify.
Assisted-by GitHub-Copilot:GPT-5.5Signed-off-by James Clark <[email protected]>---
Changes in v2:
- Push and pop asm sections - (Sashiko)
- Add .size directive - (Sashiko)
- Add asm label for done and test with LTO enabled - (Sashiko)
- Link to v1: https://lore.kernel.org/r/[email protected]--- tools/perf/tests/workloads/leafloop.c | 40 +++++++++++++++++++++++++++-------- 1 file changed, 31 insertions(+), 9 deletions(-)tools/perf/tests/workloads/leafloop.c +11
-5@@ -6,26 +6,48 @@#include "../tests.h" /* We want to check these symbols in perf script */ -noinline void leaf(volatile int b); -noinline void parent(volatile int b); +noinline void leaf(void); +noinline void parent(void); -static volatile int a; -static volatile sig_atomic_t done; +static volatile sig_atomic_t done asm("leafloop_done" );static void sighandler (int sig__maybe_unused ) { done =1 ; } -noinline void leaf(volatile int b) +#if defined(__aarch64__) +/* +* Write leaf() in assembly so it stays as a minimal leaf function with no +* stack frame and won't get silently broken in the future by any Perf wide +* compilation options like -fstack-protector-all. +*/ +asm( + ".pushsection .text,\"ax\",%progbits\n"
tools/perf/tests/workloads/leafloop.c line 36
Quoted 10 lines
tools/perf/tests/workloads/leafloop.c +10
-0+".global leaf\n" +".type leaf, %function\n" +"leaf:\n" +" adrp x1, leafloop_done\n" +" ldr w2, [x1, #:lo12:leafloop_done]\n" +" cbz w2, leaf\n" +" ret\n" +".size leaf, .-leaf\n" +".popsection\n" +);
On reading this I thought, why can't we just use an asm block in a function, but I get it, you want specific function entry/exit to test the leaf unwinding feature.
Fwiw, looking at the test the command line is somewhat unusual:
https://web.git.kernel.org/pub/scm/linux/kernel/git/perf/perf-tools-next.git/tree/tools/perf/tests/shell/test_arm_callgraph_fp.sh?h=perf-tools-next#n32
``` perf record -o "$PERF_DATA" --call-graph fp -e cycles//u --user-callchains -- $TEST_PROGRAM ```
cycles//u rather than cycles:u and why the extra --user-callchains?
Thanks,
Ian
Quoted 38 lines
tools/perf/tests/workloads/leafloop.c +10
-5+ +#else + +noinline void leaf(void) {while (!done) - a += b; + ; } -noinline void parent(volatile int b) +#endif + +noinline void parent(void) { -leaf (b); +leaf (); }static int leafloop (int argc,const char **argv)@@ -39,7 +61,7 @@ static int leafloop(int argc, const char **argv)signal (SIGALRM , sighandler);alarm (sec); -parent (sec); +parent ();return 0 ; } ---base-commit:
8c8f2093614373ea8179b562320212a25cf937c0
change-id: 20260508-james-perf-leafloop-stack-c221600eddf2Best regards,
--
James Clark <[email protected]>
James Clark
reviewerQuoted 78 lines · Ian Rogers
Quoted 58 lines · James Clark
Since the leafloop test program was moved into the main Perf binary as a workload, it inherited the same compiler options as Perf. In this case the -fstack-protector option broke the assumption that simple leaf frames don't have a stack frame on Arm. This causes
test_arm_callgraph_fp.shto pass even if the stack isn't augmented with the link register, making the test useless.Fix it by rewriting the leaf function in assembly seeing as it's so simple. Adding -fno-stack-protector would also work, but wouldn't be robust against other future compiler option additions.
The local variables and 'a' variable were never needed so remove them to simplify.
Assisted-by GitHub-Copilot:GPT-5.5Signed-off-by James Clark <[email protected]>---
Changes in v2:
- Push and pop asm sections - (Sashiko)
- Add .size directive - (Sashiko)
- Add asm label for done and test with LTO enabled - (Sashiko)
- Link to v1: https://lore.kernel.org/r/[email protected]--- tools/perf/tests/workloads/leafloop.c | 40 +++++++++++++++++++++++++++-------- 1 file changed, 31 insertions(+), 9 deletions(-)tools/perf/tests/workloads/leafloop.c +11
-5@@ -6,26 +6,48 @@#include "../tests.h" /* We want to check these symbols in perf script */ -noinline void leaf(volatile int b); -noinline void parent(volatile int b); +noinline void leaf(void); +noinline void parent(void); -static volatile int a; -static volatile sig_atomic_t done; +static volatile sig_atomic_t done asm("leafloop_done" );static void sighandler (int sig__maybe_unused ) { done =1 ; } -noinline void leaf(volatile int b) +#if defined(__aarch64__) +/* +* Write leaf() in assembly so it stays as a minimal leaf function with no +* stack frame and won't get silently broken in the future by any Perf wide +* compilation options like -fstack-protector-all. +*/ +asm( + ".pushsection .text,\"ax\",%progbits\n"tools/perf/tests/workloads/leafloop.c line 36
Quoted 10 lines
tools/perf/tests/workloads/leafloop.c +10
-0+".global leaf\n" +".type leaf, %function\n" +"leaf:\n" +" adrp x1, leafloop_done\n" +" ldr w2, [x1, #:lo12:leafloop_done]\n" +" cbz w2, leaf\n" +" ret\n" +".size leaf, .-leaf\n" +".popsection\n" +);On reading this I thought, why can't we just use an asm block in a function, but I get it, you want specific function entry/exit to test the leaf unwinding feature.
Reviewed-by Ian Rogers <[email protected]>Fwiw, looking at the test the command line is somewhat unusual:
https://web.git.kernel.org/pub/scm/linux/kernel/git/perf/perf-tools-next.git/tree/tools/perf/tests/shell/test_arm_callgraph_fp.sh?h=perf-tools-next#n32
Quoted 9 lines
``` perf record -o "$PERF_DATA" --call-graph fp -e cycles//u --user-callchains -- $TEST_PROGRAM ```cycles//u rather than cycles:u and why the extra --user-callchains?
Thanks,
Ian
--user-callchains looks like it was to make the grep in the test easier so it didn't have to ignore the kernel part. But it might be redundant now after a later change I made.
cycles//u has always been there so there's no explanation. I thought that was a valid way to open an event? Is it weird because // is for options in perf record and not stat?
Quoted 38 lines
Quoted 38 lines
tools/perf/tests/workloads/leafloop.c +10
-5+ +#else + +noinline void leaf(void) {while (!done) - a += b; + ; } -noinline void parent(volatile int b) +#endif + +noinline void parent(void) { -leaf (b); +leaf (); }static int leafloop (int argc,const char **argv)@@ -39,7 +61,7 @@ static int leafloop(int argc, const char **argv)signal (SIGALRM , sighandler);alarm (sec); -parent (sec); +parent ();return 0 ; } ---base-commit:
8c8f2093614373ea8179b562320212a25cf937c0
change-id: 20260508-james-perf-leafloop-stack-c221600eddf2Best regards,
--
James Clark <[email protected]>
Quoted 74 lines · Ian Rogers
Quoted 58 lines · James Clark
Since the leafloop test program was moved into the main Perf binary as a workload, it inherited the same compiler options as Perf. In this case the -fstack-protector option broke the assumption that simple leaf frames don't have a stack frame on Arm. This causes
test_arm_callgraph_fp.shto pass even if the stack isn't augmented with the link register, making the test useless.Fix it by rewriting the leaf function in assembly seeing as it's so simple. Adding -fno-stack-protector would also work, but wouldn't be robust against other future compiler option additions.
The local variables and 'a' variable were never needed so remove them to simplify.
Assisted-by GitHub-Copilot:GPT-5.5Signed-off-by James Clark <[email protected]>---
Changes in v2:
- Push and pop asm sections - (Sashiko)
- Add .size directive - (Sashiko)
- Add asm label for done and test with LTO enabled - (Sashiko)
- Link to v1: https://lore.kernel.org/r/[email protected]--- tools/perf/tests/workloads/leafloop.c | 40 +++++++++++++++++++++++++++-------- 1 file changed, 31 insertions(+), 9 deletions(-)tools/perf/tests/workloads/leafloop.c +11
-5@@ -6,26 +6,48 @@#include "../tests.h" /* We want to check these symbols in perf script */ -noinline void leaf(volatile int b); -noinline void parent(volatile int b); +noinline void leaf(void); +noinline void parent(void); -static volatile int a; -static volatile sig_atomic_t done; +static volatile sig_atomic_t done asm("leafloop_done" );static void sighandler (int sig__maybe_unused ) { done =1 ; } -noinline void leaf(volatile int b) +#if defined(__aarch64__) +/* +* Write leaf() in assembly so it stays as a minimal leaf function with no +* stack frame and won't get silently broken in the future by any Perf wide +* compilation options like -fstack-protector-all. +*/ +asm( + ".pushsection .text,\"ax\",%progbits\n"tools/perf/tests/workloads/leafloop.c line 36
Quoted 10 lines
tools/perf/tests/workloads/leafloop.c +10
-0+".global leaf\n" +".type leaf, %function\n" +"leaf:\n" +" adrp x1, leafloop_done\n" +" ldr w2, [x1, #:lo12:leafloop_done]\n" +" cbz w2, leaf\n" +" ret\n" +".size leaf, .-leaf\n" +".popsection\n" +);On reading this I thought, why can't we just use an asm block in a function, but I get it, you want specific function entry/exit to test the leaf unwinding feature.
Quoted 1 line
Reviewed-by Ian Rogers <[email protected]>
Thanks, applied to perf-tools-next, for v7.2.
- Arnaldo