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
This commit is contained in:
committed by
Marc Zyngier
parent
f51e714674
commit
051ece6758
@@ -2,6 +2,21 @@
|
|||||||
/*
|
/*
|
||||||
* Common arm64 stack unwinder code.
|
* 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.
|
* Copyright (C) 2012 ARM Ltd.
|
||||||
*/
|
*/
|
||||||
#ifndef __ASM_STACKTRACE_COMMON_H
|
#ifndef __ASM_STACKTRACE_COMMON_H
|
||||||
|
|||||||
Reference in New Issue
Block a user