aboutsummaryrefslogtreecommitdiffstats
path: root/arch/arm64/include/asm/stacktrace/common.h
diff options
context:
space:
mode:
authorMarc Zyngier <maz@kernel.org>2022-07-27 15:29:06 +0100
committerMarc Zyngier <maz@kernel.org>2022-07-27 18:18:47 +0100
commita4c750e2328a117dc9b19a2a61db0d4347902029 (patch)
tree6175b5c5557b3fa55f32e9c2cc96b3733538e08c /arch/arm64/include/asm/stacktrace/common.h
parentKVM: arm64: Don't open code ARRAY_SIZE() (diff)
downloadlinux-dev-a4c750e2328a117dc9b19a2a61db0d4347902029.tar.xz
linux-dev-a4c750e2328a117dc9b19a2a61db0d4347902029.zip
arm64: Update 'unwinder howto'
Implementing a new unwinder is a bit more involved than writing a couple of helpers, so let's not lure the reader into a false sense of comfort. Instead, let's point out what they should call into, and what sort of parameter they need to provide. Signed-off-by: Marc Zyngier <maz@kernel.org> Reviewed-by: Kalesh Singh <kaleshsingh@google.com> Tested-by: Kalesh Singh <kaleshsingh@google.com> Reviewed-by: Oliver Upton <oliver.upton@linux.dev> Link: https://lore.kernel.org/r/20220727142906.1856759-7-maz@kernel.org
Diffstat (limited to '')
-rw-r--r--arch/arm64/include/asm/stacktrace/common.h14
1 files changed, 4 insertions, 10 deletions
diff --git a/arch/arm64/include/asm/stacktrace/common.h b/arch/arm64/include/asm/stacktrace/common.h
index 18046a7248a2..f58eb944c46f 100644
--- a/arch/arm64/include/asm/stacktrace/common.h
+++ b/arch/arm64/include/asm/stacktrace/common.h
@@ -5,17 +5,11 @@
* To implement a new arm64 stack unwinder:
* 1) Include this header
*
- * 2) Provide implementations for the following functions:
- * on_overflow_stack(): Returns true if SP is on the overflow
- * stack.
- * on_accessible_stack(): Returns true is SP is on any accessible
- * stack.
- * unwind_next(): Performs validation checks on the frame
- * pointer, and transitions unwind_state
- * to the next frame.
+ * 2) Call into unwind_next_common() from your top level unwind
+ * function, passing it the validation and translation callbacks
+ * (though the later can be NULL if no translation is required).
*
- * See: arch/arm64/include/asm/stacktrace.h for reference
- * implementations.
+ * See: arch/arm64/kernel/stacktrace.c for the reference implementation.
*
* Copyright (C) 2012 ARM Ltd.
*/