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 * UNWIND_HINT_ENTRY: machine entry without stack, SYSCALL/SYSENTER etc. 37 */ 38 #define UNWIND_HINT_TYPE_CALL 0 39 #define UNWIND_HINT_TYPE_REGS 1 40 #define UNWIND_HINT_TYPE_REGS_PARTIAL 2 41 #define UNWIND_HINT_TYPE_FUNC 3 42 #define UNWIND_HINT_TYPE_ENTRY 4 43 44 #ifdef CONFIG_OBJTOOL 45 46 #include <asm/asm.h> 47 48 #ifndef __ASSEMBLY__ 49 50 #define UNWIND_HINT(sp_reg, sp_offset, type, end) \ 51 "987: \n\t" \ 52 ".pushsection .discard.unwind_hints\n\t" \ 53 /* struct unwind_hint */ \ 54 ".long 987b - .\n\t" \ 55 ".short " __stringify(sp_offset) "\n\t" \ 56 ".byte " __stringify(sp_reg) "\n\t" \ 57 ".byte " __stringify(type) "\n\t" \ 58 ".byte " __stringify(end) "\n\t" \ 59 ".balign 4 \n\t" \ 60 ".popsection\n\t" 61 62 /* 63 * This macro marks the given function's stack frame as "non-standard", which 64 * tells objtool to ignore the function when doing stack metadata validation. 65 * It should only be used in special cases where you're 100% sure it won't 66 * affect the reliability of frame pointers and kernel stack traces. 67 * 68 * For more information, see tools/objtool/Documentation/stack-validation.txt. 69 */ 70 #define STACK_FRAME_NON_STANDARD(func) \ 71 static void __used __section(".discard.func_stack_frame_non_standard") \ 72 *__func_stack_frame_non_standard_##func = func 73 74 /* 75 * STACK_FRAME_NON_STANDARD_FP() is a frame-pointer-specific function ignore 76 * for the case where a function is intentionally missing frame pointer setup, 77 * but otherwise needs objtool/ORC coverage when frame pointers are disabled. 78 */ 79 #ifdef CONFIG_FRAME_POINTER 80 #define STACK_FRAME_NON_STANDARD_FP(func) STACK_FRAME_NON_STANDARD(func) 81 #else 82 #define STACK_FRAME_NON_STANDARD_FP(func) 83 #endif 84 85 #define ANNOTATE_NOENDBR \ 86 "986: \n\t" \ 87 ".pushsection .discard.noendbr\n\t" \ 88 _ASM_PTR " 986b\n\t" \ 89 ".popsection\n\t" 90 91 #define ASM_REACHABLE \ 92 "998:\n\t" \ 93 ".pushsection .discard.reachable\n\t" \ 94 ".long 998b - .\n\t" \ 95 ".popsection\n\t" 96 97 #else /* __ASSEMBLY__ */ 98 99 /* 100 * This macro indicates that the following intra-function call is valid. 101 * Any non-annotated intra-function call will cause objtool to issue a warning. 102 */ 103 #define ANNOTATE_INTRA_FUNCTION_CALL \ 104 999: \ 105 .pushsection .discard.intra_function_calls; \ 106 .long 999b; \ 107 .popsection; 108 109 /* 110 * In asm, there are two kinds of code: normal C-type callable functions and 111 * the rest. The normal callable functions can be called by other code, and 112 * don't do anything unusual with the stack. Such normal callable functions 113 * are annotated with the ENTRY/ENDPROC macros. Most asm code falls in this 114 * category. In this case, no special debugging annotations are needed because 115 * objtool can automatically generate the ORC data for the ORC unwinder to read 116 * at runtime. 117 * 118 * Anything which doesn't fall into the above category, such as syscall and 119 * interrupt handlers, tends to not be called directly by other functions, and 120 * often does unusual non-C-function-type things with the stack pointer. Such 121 * code needs to be annotated such that objtool can understand it. The 122 * following CFI hint macros are for this type of code. 123 * 124 * These macros provide hints to objtool about the state of the stack at each 125 * instruction. Objtool starts from the hints and follows the code flow, 126 * making automatic CFI adjustments when it sees pushes and pops, filling out 127 * the debuginfo as necessary. It will also warn if it sees any 128 * inconsistencies. 129 */ 130 .macro UNWIND_HINT sp_reg:req sp_offset=0 type:req end=0 131 .Lunwind_hint_ip_\@: 132 .pushsection .discard.unwind_hints 133 /* struct unwind_hint */ 134 .long .Lunwind_hint_ip_\@ - . 135 .short \sp_offset 136 .byte \sp_reg 137 .byte \type 138 .byte \end 139 .balign 4 140 .popsection 141 .endm 142 143 .macro STACK_FRAME_NON_STANDARD func:req 144 .pushsection .discard.func_stack_frame_non_standard, "aw" 145 _ASM_PTR \func 146 .popsection 147 .endm 148 149 .macro STACK_FRAME_NON_STANDARD_FP func:req 150 #ifdef CONFIG_FRAME_POINTER 151 STACK_FRAME_NON_STANDARD \func 152 #endif 153 .endm 154 155 .macro ANNOTATE_NOENDBR 156 .Lhere_\@: 157 .pushsection .discard.noendbr 158 .quad .Lhere_\@ 159 .popsection 160 .endm 161 162 .macro REACHABLE 163 .Lhere_\@: 164 .pushsection .discard.reachable 165 .long .Lhere_\@ - . 166 .popsection 167 .endm 168 169 #endif /* __ASSEMBLY__ */ 170 171 #else /* !CONFIG_OBJTOOL */ 172 173 #ifndef __ASSEMBLY__ 174 175 #define UNWIND_HINT(sp_reg, sp_offset, type, end) \ 176 "\n\t" 177 #define STACK_FRAME_NON_STANDARD(func) 178 #define STACK_FRAME_NON_STANDARD_FP(func) 179 #define ANNOTATE_NOENDBR 180 #define ASM_REACHABLE 181 #else 182 #define ANNOTATE_INTRA_FUNCTION_CALL 183 .macro UNWIND_HINT sp_reg:req sp_offset=0 type:req end=0 184 .endm 185 .macro STACK_FRAME_NON_STANDARD func:req 186 .endm 187 .macro ANNOTATE_NOENDBR 188 .endm 189 .macro REACHABLE 190 .endm 191 #endif 192 193 #endif /* CONFIG_OBJTOOL */ 194 195 #endif /* _LINUX_OBJTOOL_H */ 196