summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKalesh Singh <kaleshsingh@google.com>2022-07-26 00:37:39 -0700
committerMarc Zyngier <maz@kernel.org>2022-07-26 10:48:54 +0100
commit051ece6758cc10c2a6f1700ffe86d23fbb0b2553 (patch)
treee692f5151f3a844a987a5b6ca04dda1c5c8ea2b7
parentf51e7146740514347d6c5526a2c393e224a19c0d (diff)
arm64: stacktrace: Add description of stacktrace/common.h
Add brief description on how to use stacktrace/common.h to implement a stack unwinder. Signed-off-by: Kalesh Singh <kaleshsingh@google.com> Reviewed-by: Fuad Tabba <tabba@google.com> Signed-off-by: Marc Zyngier <maz@kernel.org> Link: https://lore.kernel.org/r/20220726073750.3219117-7-kaleshsingh@google.com
-rw-r--r--arch/arm64/include/asm/stacktrace/common.h15
1 files changed, 15 insertions, 0 deletions
diff --git a/arch/arm64/include/asm/stacktrace/common.h b/arch/arm64/include/asm/stacktrace/common.h
index 4b632141d91c..45474b383630 100644
--- a/arch/arm64/include/asm/stacktrace/common.h
+++ b/arch/arm64/include/asm/stacktrace/common.h
@@ -2,6 +2,21 @@
/*
* Common arm64 stack unwinder code.
*
+ * 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.
+ *
+ * See: arch/arm64/include/asm/stacktrace.h for reference
+ * implementations.
+ *
* Copyright (C) 2012 ARM Ltd.
*/
#ifndef __ASM_STACKTRACE_COMMON_H