Commit 051ece67 authored by Kalesh Singh's avatar Kalesh Singh Committed by Marc Zyngier
Browse files

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: default avatarKalesh Singh <kaleshsingh@google.com>
Reviewed-by: default avatarFuad Tabba <tabba@google.com>
Signed-off-by: default avatarMarc Zyngier <maz@kernel.org>
Link: https://lore.kernel.org/r/20220726073750.3219117-7-kaleshsingh@google.com
parent f51e7146

arch/arm64/include/asm/stacktrace/common.h

+15 −0
Original line number Diff line number Diff line
@@ -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