1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef _LINUX_OBJTOOL_H 3 #define _LINUX_OBJTOOL_H 4 5 #ifndef __ASSEMBLY__ 6 7 #include <linux/types.h> 8 9 /* 10 * This struct is used by asm and inline asm code to manually annotate the 11 * location of registers on the stack. 12 */ 13 struct unwind_hint { 14 u32 ip; 15 s16 sp_offset; 16 u8 sp_reg; 17 u8 type; 18 u8 end; 19 }; 20 #endif 21 22 /* 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. 26 * 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. 29 * 30 * UNWIND_HINT_TYPE_REGS_PARTIAL: Used in entry code to indicate that 31 * sp_reg+sp_offset points to the iret return frame. 32 * 33 * UNWIND_HINT_FUNC: Generate the unwind metadata of a callable function. 34 * Useful for code which doesn't have an ELF function annotation. 35 */ 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 40 41 #ifdef CONFIG_STACK_VALIDATION 42 43 #ifndef __ASSEMBLY__ 44 45 #define UNWIND_HINT(sp_reg, sp_offset, type, end) \ 46 "987: \n\t" \ 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" \ 54 ".balign 4 \n\t" \ 55 ".popsection\n\t" 56 57 /* 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. 62 * 63 * For more information, see tools/objtool/Documentation/stack-validation.txt. 64 */ 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 68 69 /* 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. 73 */ 74 #ifdef CONFIG_FRAME_POINTER 75 #define STACK_FRAME_NON_STANDARD_FP(func) STACK_FRAME_NON_STANDARD(func) 76 #else 77 #define STACK_FRAME_NON_STANDARD_FP(func) 78 #endif 79 80 #define ANNOTATE_NOENDBR \ 81 "986: \n\t" \ 82 ".pushsection .discard.noendbr\n\t" \ 83 _ASM_PTR " 986b\n\t" \ 84 ".popsection\n\t" 85 86 #else /* __ASSEMBLY__ */ 87 88 /* 89 * This macro indicates that the following intra-function call is valid. 90 * Any non-annotated intra-function call will cause objtool to issue a warning. 91 */ 92 #define ANNOTATE_INTRA_FUNCTION_CALL \ 93 999: \ 94 .pushsection .discard.intra_function_calls; \ 95 .long 999b; \ 96 .popsection; 97 98 /* 99 * In asm, there are two kinds of code: normal C-type callable functions and 100 * the rest. The normal callable functions can be called by other code, and 101 * don't do anything unusual with the stack. Such normal callable functions 102 * are annotated with the ENTRY/ENDPROC macros. Most asm code falls in this 103 * category. In this case, no special debugging annotations are needed because 104 * objtool can automatically generate the ORC data for the ORC unwinder to read 105 * at runtime. 106 * 107 * Anything which doesn't fall into the above category, such as syscall and 108 * interrupt handlers, tends to not be called directly by other functions, and 109 * often does unusual non-C-function-type things with the stack pointer. Such 110 * code needs to be annotated such that objtool can understand it. The 111 * following CFI hint macros are for this type of code. 112 * 113 * These macros provide hints to objtool about the state of the stack at each 114 * instruction. Objtool starts from the hints and follows the code flow, 115 * making automatic CFI adjustments when it sees pushes and pops, filling out 116 * the debuginfo as necessary. It will also warn if it sees any 117 * inconsistencies. 118 */ 119 .macro UNWIND_HINT sp_reg:req sp_offset=0 type:req end=0 120 .Lunwind_hint_ip_\@: 121 .pushsection .discard.unwind_hints 122 /* struct unwind_hint */ 123 .long .Lunwind_hint_ip_\@ - . 124 .short \sp_offset 125 .byte \sp_reg 126 .byte \type 127 .byte \end 128 .balign 4 129 .popsection 130 .endm 131 132 .macro STACK_FRAME_NON_STANDARD func:req 133 .pushsection .discard.func_stack_frame_non_standard, "aw" 134 .long \func - . 135 .popsection 136 .endm 137 138 .macro ANNOTATE_NOENDBR 139 .Lhere_\@: 140 .pushsection .discard.noendbr 141 .quad .Lhere_\@ 142 .popsection 143 .endm 144 145 #endif /* __ASSEMBLY__ */ 146 147 #else /* !CONFIG_STACK_VALIDATION */ 148 149 #ifndef __ASSEMBLY__ 150 151 #define UNWIND_HINT(sp_reg, sp_offset, type, end) \ 152 "\n\t" 153 #define STACK_FRAME_NON_STANDARD(func) 154 #define STACK_FRAME_NON_STANDARD_FP(func) 155 #define ANNOTATE_NOENDBR 156 #else 157 #define ANNOTATE_INTRA_FUNCTION_CALL 158 .macro UNWIND_HINT sp_reg:req sp_offset=0 type:req end=0 159 .endm 160 .macro STACK_FRAME_NON_STANDARD func:req 161 .endm 162 .macro ANNOTATE_NOENDBR 163 .endm 164 #endif 165 166 #endif /* CONFIG_STACK_VALIDATION */ 167 168 #endif /* _LINUX_OBJTOOL_H */ 169