1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_OBJTOOL_H
3 #define _LINUX_OBJTOOL_H
7 #include <linux/types.h>
10 * This struct is used by asm and inline asm code to manually annotate the
11 * location of registers on the stack.
23 * UNWIND_HINT_TYPE_CALL: Indicates that sp_reg+sp_offset resolves to PREV_SP
24 * (the caller's SP right before it made the call). Used for all callable
25 * functions, i.e. all C code and all callable asm functions.
27 * UNWIND_HINT_TYPE_REGS: Used in entry code to indicate that sp_reg+sp_offset
28 * points to a fully populated pt_regs from a syscall, interrupt, or exception.
30 * UNWIND_HINT_TYPE_REGS_PARTIAL: Used in entry code to indicate that
31 * sp_reg+sp_offset points to the iret return frame.
33 * UNWIND_HINT_FUNC: Generate the unwind metadata of a callable function.
34 * Useful for code which doesn't have an ELF function annotation.
36 #define UNWIND_HINT_TYPE_CALL 0
37 #define UNWIND_HINT_TYPE_REGS 1
38 #define UNWIND_HINT_TYPE_REGS_PARTIAL 2
39 #define UNWIND_HINT_TYPE_FUNC 3
41 #ifdef CONFIG_STACK_VALIDATION
45 #define UNWIND_HINT(sp_reg, sp_offset, type, end) \
47 ".pushsection .discard.unwind_hints\n\t" \
48 /* struct unwind_hint */ \
49 ".long 987b - .\n\t" \
50 ".short " __stringify(sp_offset) "\n\t" \
51 ".byte " __stringify(sp_reg) "\n\t" \
52 ".byte " __stringify(type) "\n\t" \
53 ".byte " __stringify(end) "\n\t" \
58 * This macro marks the given function's stack frame as "non-standard", which
59 * tells objtool to ignore the function when doing stack metadata validation.
60 * It should only be used in special cases where you're 100% sure it won't
61 * affect the reliability of frame pointers and kernel stack traces.
63 * For more information, see tools/objtool/Documentation/stack-validation.txt.
65 #define STACK_FRAME_NON_STANDARD(func) \
66 static void __used __section(".discard.func_stack_frame_non_standard") \
67 *__func_stack_frame_non_standard_##func = func
70 * STACK_FRAME_NON_STANDARD_FP() is a frame-pointer-specific function ignore
71 * for the case where a function is intentionally missing frame pointer setup,
72 * but otherwise needs objtool/ORC coverage when frame pointers are disabled.
74 #ifdef CONFIG_FRAME_POINTER
75 #define STACK_FRAME_NON_STANDARD_FP(func) STACK_FRAME_NON_STANDARD(func)
77 #define STACK_FRAME_NON_STANDARD_FP(func)
80 #else /* __ASSEMBLY__ */
83 * This macro indicates that the following intra-function call is valid.
84 * Any non-annotated intra-function call will cause objtool to issue a warning.
86 #define ANNOTATE_INTRA_FUNCTION_CALL \
88 .pushsection .discard.intra_function_calls; \
93 * In asm, there are two kinds of code: normal C-type callable functions and
94 * the rest. The normal callable functions can be called by other code, and
95 * don't do anything unusual with the stack. Such normal callable functions
96 * are annotated with the ENTRY/ENDPROC macros. Most asm code falls in this
97 * category. In this case, no special debugging annotations are needed because
98 * objtool can automatically generate the ORC data for the ORC unwinder to read
101 * Anything which doesn't fall into the above category, such as syscall and
102 * interrupt handlers, tends to not be called directly by other functions, and
103 * often does unusual non-C-function-type things with the stack pointer. Such
104 * code needs to be annotated such that objtool can understand it. The
105 * following CFI hint macros are for this type of code.
107 * These macros provide hints to objtool about the state of the stack at each
108 * instruction. Objtool starts from the hints and follows the code flow,
109 * making automatic CFI adjustments when it sees pushes and pops, filling out
110 * the debuginfo as necessary. It will also warn if it sees any
113 .macro UNWIND_HINT sp_reg:req sp_offset=0 type:req end=0
115 .pushsection .discard.unwind_hints
116 /* struct unwind_hint */
117 .long .Lunwind_hint_ip_\@ - .
126 .macro STACK_FRAME_NON_STANDARD func:req
127 .pushsection .discard.func_stack_frame_non_standard, "aw"
132 #endif /* __ASSEMBLY__ */
134 #else /* !CONFIG_STACK_VALIDATION */
138 #define UNWIND_HINT(sp_reg, sp_offset, type, end) \
140 #define STACK_FRAME_NON_STANDARD(func)
141 #define STACK_FRAME_NON_STANDARD_FP(func)
143 #define ANNOTATE_INTRA_FUNCTION_CALL
144 .macro UNWIND_HINT sp_reg:req sp_offset=0 type:req end=0
146 .macro STACK_FRAME_NON_STANDARD func:req
150 #endif /* CONFIG_STACK_VALIDATION */
152 #endif /* _LINUX_OBJTOOL_H */