1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Copyright (C) 2015-2017 Josh Poimboeuf <jpoimboe@redhat.com>
12 #include <objtool/builtin.h>
13 #include <objtool/cfi.h>
14 #include <objtool/arch.h>
15 #include <objtool/check.h>
16 #include <objtool/special.h>
17 #include <objtool/warn.h>
18 #include <objtool/endianness.h>
20 #include <linux/objtool.h>
21 #include <linux/hashtable.h>
22 #include <linux/kernel.h>
23 #include <linux/static_call_types.h>
26 struct list_head list;
27 struct instruction *insn;
31 static unsigned long nr_cfi, nr_cfi_reused, nr_cfi_cache;
33 static struct cfi_init_state initial_func_cfi;
34 static struct cfi_state init_cfi;
35 static struct cfi_state func_cfi;
37 struct instruction *find_insn(struct objtool_file *file,
38 struct section *sec, unsigned long offset)
40 struct instruction *insn;
42 hash_for_each_possible(file->insn_hash, insn, hash, sec_offset_hash(sec, offset)) {
43 if (insn->sec == sec && insn->offset == offset)
50 static struct instruction *next_insn_same_sec(struct objtool_file *file,
51 struct instruction *insn)
53 struct instruction *next = list_next_entry(insn, list);
55 if (!next || &next->list == &file->insn_list || next->sec != insn->sec)
61 static struct instruction *next_insn_same_func(struct objtool_file *file,
62 struct instruction *insn)
64 struct instruction *next = list_next_entry(insn, list);
65 struct symbol *func = insn->func;
70 if (&next->list != &file->insn_list && next->func == func)
73 /* Check if we're already in the subfunction: */
74 if (func == func->cfunc)
77 /* Move to the subfunction: */
78 return find_insn(file, func->cfunc->sec, func->cfunc->offset);
81 static struct instruction *prev_insn_same_sym(struct objtool_file *file,
82 struct instruction *insn)
84 struct instruction *prev = list_prev_entry(insn, list);
86 if (&prev->list != &file->insn_list && prev->func == insn->func)
92 #define func_for_each_insn(file, func, insn) \
93 for (insn = find_insn(file, func->sec, func->offset); \
95 insn = next_insn_same_func(file, insn))
97 #define sym_for_each_insn(file, sym, insn) \
98 for (insn = find_insn(file, sym->sec, sym->offset); \
99 insn && &insn->list != &file->insn_list && \
100 insn->sec == sym->sec && \
101 insn->offset < sym->offset + sym->len; \
102 insn = list_next_entry(insn, list))
104 #define sym_for_each_insn_continue_reverse(file, sym, insn) \
105 for (insn = list_prev_entry(insn, list); \
106 &insn->list != &file->insn_list && \
107 insn->sec == sym->sec && insn->offset >= sym->offset; \
108 insn = list_prev_entry(insn, list))
110 #define sec_for_each_insn_from(file, insn) \
111 for (; insn; insn = next_insn_same_sec(file, insn))
113 #define sec_for_each_insn_continue(file, insn) \
114 for (insn = next_insn_same_sec(file, insn); insn; \
115 insn = next_insn_same_sec(file, insn))
117 static bool is_jump_table_jump(struct instruction *insn)
119 struct alt_group *alt_group = insn->alt_group;
121 if (insn->jump_table)
124 /* Retpoline alternative for a jump table? */
125 return alt_group && alt_group->orig_group &&
126 alt_group->orig_group->first_insn->jump_table;
129 static bool is_sibling_call(struct instruction *insn)
132 * Assume only ELF functions can make sibling calls. This ensures
133 * sibling call detection consistency between vmlinux.o and individual
139 /* An indirect jump is either a sibling call or a jump to a table. */
140 if (insn->type == INSN_JUMP_DYNAMIC)
141 return !is_jump_table_jump(insn);
143 /* add_jump_destinations() sets insn->call_dest for sibling calls. */
144 return (is_static_jump(insn) && insn->call_dest);
148 * This checks to see if the given function is a "noreturn" function.
150 * For global functions which are outside the scope of this object file, we
151 * have to keep a manual list of them.
153 * For local functions, we have to detect them manually by simply looking for
154 * the lack of a return instruction.
156 static bool __dead_end_function(struct objtool_file *file, struct symbol *func,
160 struct instruction *insn;
164 * Unfortunately these have to be hard coded because the noreturn
165 * attribute isn't provided in ELF data. Keep 'em sorted.
167 static const char * const global_noreturns[] = {
169 "__module_put_and_kthread_exit",
172 "__ubsan_handle_builtin_unreachable",
173 "cpu_bringup_and_idle",
178 "ex_handler_msr_mce",
180 "kthread_complete_and_exit",
182 "kunit_try_catch_throw",
184 "machine_real_restart",
187 "rewind_stack_and_make_dead",
198 if (func->bind == STB_WEAK)
201 if (func->bind == STB_GLOBAL)
202 for (i = 0; i < ARRAY_SIZE(global_noreturns); i++)
203 if (!strcmp(func->name, global_noreturns[i]))
209 insn = find_insn(file, func->sec, func->offset);
210 if (!insn || !insn->func)
213 func_for_each_insn(file, func, insn) {
216 if (insn->type == INSN_RETURN)
224 * A function can have a sibling call instead of a return. In that
225 * case, the function's dead-end status depends on whether the target
226 * of the sibling call returns.
228 func_for_each_insn(file, func, insn) {
229 if (is_sibling_call(insn)) {
230 struct instruction *dest = insn->jump_dest;
233 /* sibling call to another file */
236 /* local sibling call */
237 if (recursion == 5) {
239 * Infinite recursion: two functions have
240 * sibling calls to each other. This is a very
241 * rare case. It means they aren't dead ends.
246 return __dead_end_function(file, dest->func, recursion+1);
253 static bool dead_end_function(struct objtool_file *file, struct symbol *func)
255 return __dead_end_function(file, func, 0);
258 static void init_cfi_state(struct cfi_state *cfi)
262 for (i = 0; i < CFI_NUM_REGS; i++) {
263 cfi->regs[i].base = CFI_UNDEFINED;
264 cfi->vals[i].base = CFI_UNDEFINED;
266 cfi->cfa.base = CFI_UNDEFINED;
267 cfi->drap_reg = CFI_UNDEFINED;
268 cfi->drap_offset = -1;
271 static void init_insn_state(struct objtool_file *file, struct insn_state *state,
274 memset(state, 0, sizeof(*state));
275 init_cfi_state(&state->cfi);
278 * We need the full vmlinux for noinstr validation, otherwise we can
279 * not correctly determine insn->call_dest->sec (external symbols do
280 * not have a section).
282 if (opts.link && opts.noinstr && sec)
283 state->noinstr = sec->noinstr;
286 static struct cfi_state *cfi_alloc(void)
288 struct cfi_state *cfi = calloc(sizeof(struct cfi_state), 1);
290 WARN("calloc failed");
298 static struct hlist_head *cfi_hash;
300 static inline bool cficmp(struct cfi_state *cfi1, struct cfi_state *cfi2)
302 return memcmp((void *)cfi1 + sizeof(cfi1->hash),
303 (void *)cfi2 + sizeof(cfi2->hash),
304 sizeof(struct cfi_state) - sizeof(struct hlist_node));
307 static inline u32 cfi_key(struct cfi_state *cfi)
309 return jhash((void *)cfi + sizeof(cfi->hash),
310 sizeof(*cfi) - sizeof(cfi->hash), 0);
313 static struct cfi_state *cfi_hash_find_or_add(struct cfi_state *cfi)
315 struct hlist_head *head = &cfi_hash[hash_min(cfi_key(cfi), cfi_bits)];
316 struct cfi_state *obj;
318 hlist_for_each_entry(obj, head, hash) {
319 if (!cficmp(cfi, obj)) {
327 hlist_add_head(&obj->hash, head);
332 static void cfi_hash_add(struct cfi_state *cfi)
334 struct hlist_head *head = &cfi_hash[hash_min(cfi_key(cfi), cfi_bits)];
336 hlist_add_head(&cfi->hash, head);
339 static void *cfi_hash_alloc(unsigned long size)
341 cfi_bits = max(10, ilog2(size));
342 cfi_hash = mmap(NULL, sizeof(struct hlist_head) << cfi_bits,
343 PROT_READ|PROT_WRITE,
344 MAP_PRIVATE|MAP_ANON, -1, 0);
345 if (cfi_hash == (void *)-1L) {
346 WARN("mmap fail cfi_hash");
348 } else if (opts.stats) {
349 printf("cfi_bits: %d\n", cfi_bits);
355 static unsigned long nr_insns;
356 static unsigned long nr_insns_visited;
359 * Call the arch-specific instruction decoder for all the instructions and add
360 * them to the global instruction list.
362 static int decode_instructions(struct objtool_file *file)
366 unsigned long offset;
367 struct instruction *insn;
370 for_each_sec(file, sec) {
372 if (!(sec->sh.sh_flags & SHF_EXECINSTR))
375 if (strcmp(sec->name, ".altinstr_replacement") &&
376 strcmp(sec->name, ".altinstr_aux") &&
377 strncmp(sec->name, ".discard.", 9))
380 if (!strcmp(sec->name, ".noinstr.text") ||
381 !strcmp(sec->name, ".entry.text") ||
382 !strncmp(sec->name, ".text.__x86.", 12))
385 for (offset = 0; offset < sec->sh.sh_size; offset += insn->len) {
386 insn = malloc(sizeof(*insn));
388 WARN("malloc failed");
391 memset(insn, 0, sizeof(*insn));
392 INIT_LIST_HEAD(&insn->alts);
393 INIT_LIST_HEAD(&insn->stack_ops);
394 INIT_LIST_HEAD(&insn->call_node);
397 insn->offset = offset;
399 ret = arch_decode_instruction(file, sec, offset,
400 sec->sh.sh_size - offset,
401 &insn->len, &insn->type,
408 * By default, "ud2" is a dead end unless otherwise
409 * annotated, because GCC 7 inserts it for certain
410 * divide-by-zero cases.
412 if (insn->type == INSN_BUG)
413 insn->dead_end = true;
415 hash_add(file->insn_hash, &insn->hash, sec_offset_hash(sec, insn->offset));
416 list_add_tail(&insn->list, &file->insn_list);
420 list_for_each_entry(func, &sec->symbol_list, list) {
421 if (func->type != STT_FUNC || func->alias != func)
424 if (!find_insn(file, sec, func->offset)) {
425 WARN("%s(): can't find starting instruction",
430 sym_for_each_insn(file, func, insn) {
432 if (insn->type == INSN_ENDBR && list_empty(&insn->call_node)) {
433 if (insn->offset == insn->func->offset) {
434 list_add_tail(&insn->call_node, &file->endbr_list);
437 file->nr_endbr_int++;
445 printf("nr_insns: %lu\n", nr_insns);
455 * Read the pv_ops[] .data table to find the static initialized values.
457 static int add_pv_ops(struct objtool_file *file, const char *symname)
459 struct symbol *sym, *func;
460 unsigned long off, end;
464 sym = find_symbol_by_name(file->elf, symname);
469 end = off + sym->len;
471 rel = find_reloc_by_dest_range(file->elf, sym->sec, off, end - off);
476 if (func->type == STT_SECTION)
477 func = find_symbol_by_offset(rel->sym->sec, rel->addend);
479 idx = (rel->offset - sym->offset) / sizeof(unsigned long);
481 objtool_pv_add(file, idx, func);
483 off = rel->offset + 1;
492 * Allocate and initialize file->pv_ops[].
494 static int init_pv_ops(struct objtool_file *file)
496 static const char *pv_ops_tables[] = {
512 sym = find_symbol_by_name(file->elf, "pv_ops");
516 nr = sym->len / sizeof(unsigned long);
517 file->pv_ops = calloc(sizeof(struct pv_state), nr);
521 for (idx = 0; idx < nr; idx++)
522 INIT_LIST_HEAD(&file->pv_ops[idx].targets);
524 for (idx = 0; (pv_ops = pv_ops_tables[idx]); idx++)
525 add_pv_ops(file, pv_ops);
530 static struct instruction *find_last_insn(struct objtool_file *file,
533 struct instruction *insn = NULL;
535 unsigned int end = (sec->sh.sh_size > 10) ? sec->sh.sh_size - 10 : 0;
537 for (offset = sec->sh.sh_size - 1; offset >= end && !insn; offset--)
538 insn = find_insn(file, sec, offset);
544 * Mark "ud2" instructions and manually annotated dead ends.
546 static int add_dead_ends(struct objtool_file *file)
550 struct instruction *insn;
553 * Check for manually annotated dead ends.
555 sec = find_section_by_name(file->elf, ".rela.discard.unreachable");
559 list_for_each_entry(reloc, &sec->reloc_list, list) {
560 if (reloc->sym->type != STT_SECTION) {
561 WARN("unexpected relocation symbol type in %s", sec->name);
564 insn = find_insn(file, reloc->sym->sec, reloc->addend);
566 insn = list_prev_entry(insn, list);
567 else if (reloc->addend == reloc->sym->sec->sh.sh_size) {
568 insn = find_last_insn(file, reloc->sym->sec);
570 WARN("can't find unreachable insn at %s+0x%" PRIx64,
571 reloc->sym->sec->name, reloc->addend);
575 WARN("can't find unreachable insn at %s+0x%" PRIx64,
576 reloc->sym->sec->name, reloc->addend);
580 insn->dead_end = true;
585 * These manually annotated reachable checks are needed for GCC 4.4,
586 * where the Linux unreachable() macro isn't supported. In that case
587 * GCC doesn't know the "ud2" is fatal, so it generates code as if it's
590 sec = find_section_by_name(file->elf, ".rela.discard.reachable");
594 list_for_each_entry(reloc, &sec->reloc_list, list) {
595 if (reloc->sym->type != STT_SECTION) {
596 WARN("unexpected relocation symbol type in %s", sec->name);
599 insn = find_insn(file, reloc->sym->sec, reloc->addend);
601 insn = list_prev_entry(insn, list);
602 else if (reloc->addend == reloc->sym->sec->sh.sh_size) {
603 insn = find_last_insn(file, reloc->sym->sec);
605 WARN("can't find reachable insn at %s+0x%" PRIx64,
606 reloc->sym->sec->name, reloc->addend);
610 WARN("can't find reachable insn at %s+0x%" PRIx64,
611 reloc->sym->sec->name, reloc->addend);
615 insn->dead_end = false;
621 static int create_static_call_sections(struct objtool_file *file)
624 struct static_call_site *site;
625 struct instruction *insn;
626 struct symbol *key_sym;
627 char *key_name, *tmp;
630 sec = find_section_by_name(file->elf, ".static_call_sites");
632 INIT_LIST_HEAD(&file->static_call_list);
633 WARN("file already has .static_call_sites section, skipping");
637 if (list_empty(&file->static_call_list))
641 list_for_each_entry(insn, &file->static_call_list, call_node)
644 sec = elf_create_section(file->elf, ".static_call_sites", SHF_WRITE,
645 sizeof(struct static_call_site), idx);
650 list_for_each_entry(insn, &file->static_call_list, call_node) {
652 site = (struct static_call_site *)sec->data->d_buf + idx;
653 memset(site, 0, sizeof(struct static_call_site));
655 /* populate reloc for 'addr' */
656 if (elf_add_reloc_to_insn(file->elf, sec,
657 idx * sizeof(struct static_call_site),
659 insn->sec, insn->offset))
662 /* find key symbol */
663 key_name = strdup(insn->call_dest->name);
668 if (strncmp(key_name, STATIC_CALL_TRAMP_PREFIX_STR,
669 STATIC_CALL_TRAMP_PREFIX_LEN)) {
670 WARN("static_call: trampoline name malformed: %s", key_name);
673 tmp = key_name + STATIC_CALL_TRAMP_PREFIX_LEN - STATIC_CALL_KEY_PREFIX_LEN;
674 memcpy(tmp, STATIC_CALL_KEY_PREFIX_STR, STATIC_CALL_KEY_PREFIX_LEN);
676 key_sym = find_symbol_by_name(file->elf, tmp);
679 WARN("static_call: can't find static_call_key symbol: %s", tmp);
684 * For modules(), the key might not be exported, which
685 * means the module can make static calls but isn't
686 * allowed to change them.
688 * In that case we temporarily set the key to be the
689 * trampoline address. This is fixed up in
690 * static_call_add_module().
692 key_sym = insn->call_dest;
696 /* populate reloc for 'key' */
697 if (elf_add_reloc(file->elf, sec,
698 idx * sizeof(struct static_call_site) + 4,
699 R_X86_64_PC32, key_sym,
700 is_sibling_call(insn) * STATIC_CALL_SITE_TAIL))
709 static int create_retpoline_sites_sections(struct objtool_file *file)
711 struct instruction *insn;
715 sec = find_section_by_name(file->elf, ".retpoline_sites");
717 WARN("file already has .retpoline_sites, skipping");
722 list_for_each_entry(insn, &file->retpoline_call_list, call_node)
728 sec = elf_create_section(file->elf, ".retpoline_sites", 0,
731 WARN("elf_create_section: .retpoline_sites");
736 list_for_each_entry(insn, &file->retpoline_call_list, call_node) {
738 int *site = (int *)sec->data->d_buf + idx;
741 if (elf_add_reloc_to_insn(file->elf, sec,
744 insn->sec, insn->offset)) {
745 WARN("elf_add_reloc_to_insn: .retpoline_sites");
755 static int create_return_sites_sections(struct objtool_file *file)
757 struct instruction *insn;
761 sec = find_section_by_name(file->elf, ".return_sites");
763 WARN("file already has .return_sites, skipping");
768 list_for_each_entry(insn, &file->return_thunk_list, call_node)
774 sec = elf_create_section(file->elf, ".return_sites", 0,
777 WARN("elf_create_section: .return_sites");
782 list_for_each_entry(insn, &file->return_thunk_list, call_node) {
784 int *site = (int *)sec->data->d_buf + idx;
787 if (elf_add_reloc_to_insn(file->elf, sec,
790 insn->sec, insn->offset)) {
791 WARN("elf_add_reloc_to_insn: .return_sites");
801 static int create_ibt_endbr_seal_sections(struct objtool_file *file)
803 struct instruction *insn;
807 sec = find_section_by_name(file->elf, ".ibt_endbr_seal");
809 WARN("file already has .ibt_endbr_seal, skipping");
814 list_for_each_entry(insn, &file->endbr_list, call_node)
818 printf("ibt: ENDBR at function start: %d\n", file->nr_endbr);
819 printf("ibt: ENDBR inside functions: %d\n", file->nr_endbr_int);
820 printf("ibt: superfluous ENDBR: %d\n", idx);
826 sec = elf_create_section(file->elf, ".ibt_endbr_seal", 0,
829 WARN("elf_create_section: .ibt_endbr_seal");
834 list_for_each_entry(insn, &file->endbr_list, call_node) {
836 int *site = (int *)sec->data->d_buf + idx;
839 if (elf_add_reloc_to_insn(file->elf, sec,
842 insn->sec, insn->offset)) {
843 WARN("elf_add_reloc_to_insn: .ibt_endbr_seal");
853 static int create_mcount_loc_sections(struct objtool_file *file)
857 struct instruction *insn;
860 sec = find_section_by_name(file->elf, "__mcount_loc");
862 INIT_LIST_HEAD(&file->mcount_loc_list);
863 WARN("file already has __mcount_loc section, skipping");
867 if (list_empty(&file->mcount_loc_list))
871 list_for_each_entry(insn, &file->mcount_loc_list, call_node)
874 sec = elf_create_section(file->elf, "__mcount_loc", 0, sizeof(unsigned long), idx);
879 list_for_each_entry(insn, &file->mcount_loc_list, call_node) {
881 loc = (unsigned long *)sec->data->d_buf + idx;
882 memset(loc, 0, sizeof(unsigned long));
884 if (elf_add_reloc_to_insn(file->elf, sec,
885 idx * sizeof(unsigned long),
887 insn->sec, insn->offset))
897 * Warnings shouldn't be reported for ignored functions.
899 static void add_ignores(struct objtool_file *file)
901 struct instruction *insn;
906 sec = find_section_by_name(file->elf, ".rela.discard.func_stack_frame_non_standard");
910 list_for_each_entry(reloc, &sec->reloc_list, list) {
911 switch (reloc->sym->type) {
917 func = find_func_by_offset(reloc->sym->sec, reloc->addend);
923 WARN("unexpected relocation symbol type in %s: %d", sec->name, reloc->sym->type);
927 func_for_each_insn(file, func, insn)
933 * This is a whitelist of functions that is allowed to be called with AC set.
934 * The list is meant to be minimal and only contains compiler instrumentation
935 * ABI and a few functions used to implement *_{to,from}_user() functions.
937 * These functions must not directly change AC, but may PUSHF/POPF.
939 static const char *uaccess_safe_builtin[] = {
943 /* KASAN out-of-line */
944 "__asan_loadN_noabort",
945 "__asan_load1_noabort",
946 "__asan_load2_noabort",
947 "__asan_load4_noabort",
948 "__asan_load8_noabort",
949 "__asan_load16_noabort",
950 "__asan_storeN_noabort",
951 "__asan_store1_noabort",
952 "__asan_store2_noabort",
953 "__asan_store4_noabort",
954 "__asan_store8_noabort",
955 "__asan_store16_noabort",
956 "__kasan_check_read",
957 "__kasan_check_write",
959 "__asan_report_load_n_noabort",
960 "__asan_report_load1_noabort",
961 "__asan_report_load2_noabort",
962 "__asan_report_load4_noabort",
963 "__asan_report_load8_noabort",
964 "__asan_report_load16_noabort",
965 "__asan_report_store_n_noabort",
966 "__asan_report_store1_noabort",
967 "__asan_report_store2_noabort",
968 "__asan_report_store4_noabort",
969 "__asan_report_store8_noabort",
970 "__asan_report_store16_noabort",
972 "__kcsan_check_access",
977 "kcsan_found_watchpoint",
978 "kcsan_setup_watchpoint",
979 "kcsan_check_scoped_accesses",
980 "kcsan_disable_current",
981 "kcsan_enable_current_nowarn",
986 "__tsan_write_range",
997 "__tsan_read_write1",
998 "__tsan_read_write2",
999 "__tsan_read_write4",
1000 "__tsan_read_write8",
1001 "__tsan_read_write16",
1002 "__tsan_volatile_read1",
1003 "__tsan_volatile_read2",
1004 "__tsan_volatile_read4",
1005 "__tsan_volatile_read8",
1006 "__tsan_volatile_read16",
1007 "__tsan_volatile_write1",
1008 "__tsan_volatile_write2",
1009 "__tsan_volatile_write4",
1010 "__tsan_volatile_write8",
1011 "__tsan_volatile_write16",
1012 "__tsan_atomic8_load",
1013 "__tsan_atomic16_load",
1014 "__tsan_atomic32_load",
1015 "__tsan_atomic64_load",
1016 "__tsan_atomic8_store",
1017 "__tsan_atomic16_store",
1018 "__tsan_atomic32_store",
1019 "__tsan_atomic64_store",
1020 "__tsan_atomic8_exchange",
1021 "__tsan_atomic16_exchange",
1022 "__tsan_atomic32_exchange",
1023 "__tsan_atomic64_exchange",
1024 "__tsan_atomic8_fetch_add",
1025 "__tsan_atomic16_fetch_add",
1026 "__tsan_atomic32_fetch_add",
1027 "__tsan_atomic64_fetch_add",
1028 "__tsan_atomic8_fetch_sub",
1029 "__tsan_atomic16_fetch_sub",
1030 "__tsan_atomic32_fetch_sub",
1031 "__tsan_atomic64_fetch_sub",
1032 "__tsan_atomic8_fetch_and",
1033 "__tsan_atomic16_fetch_and",
1034 "__tsan_atomic32_fetch_and",
1035 "__tsan_atomic64_fetch_and",
1036 "__tsan_atomic8_fetch_or",
1037 "__tsan_atomic16_fetch_or",
1038 "__tsan_atomic32_fetch_or",
1039 "__tsan_atomic64_fetch_or",
1040 "__tsan_atomic8_fetch_xor",
1041 "__tsan_atomic16_fetch_xor",
1042 "__tsan_atomic32_fetch_xor",
1043 "__tsan_atomic64_fetch_xor",
1044 "__tsan_atomic8_fetch_nand",
1045 "__tsan_atomic16_fetch_nand",
1046 "__tsan_atomic32_fetch_nand",
1047 "__tsan_atomic64_fetch_nand",
1048 "__tsan_atomic8_compare_exchange_strong",
1049 "__tsan_atomic16_compare_exchange_strong",
1050 "__tsan_atomic32_compare_exchange_strong",
1051 "__tsan_atomic64_compare_exchange_strong",
1052 "__tsan_atomic8_compare_exchange_weak",
1053 "__tsan_atomic16_compare_exchange_weak",
1054 "__tsan_atomic32_compare_exchange_weak",
1055 "__tsan_atomic64_compare_exchange_weak",
1056 "__tsan_atomic8_compare_exchange_val",
1057 "__tsan_atomic16_compare_exchange_val",
1058 "__tsan_atomic32_compare_exchange_val",
1059 "__tsan_atomic64_compare_exchange_val",
1060 "__tsan_atomic_thread_fence",
1061 "__tsan_atomic_signal_fence",
1065 "__sanitizer_cov_trace_pc",
1066 "__sanitizer_cov_trace_const_cmp1",
1067 "__sanitizer_cov_trace_const_cmp2",
1068 "__sanitizer_cov_trace_const_cmp4",
1069 "__sanitizer_cov_trace_const_cmp8",
1070 "__sanitizer_cov_trace_cmp1",
1071 "__sanitizer_cov_trace_cmp2",
1072 "__sanitizer_cov_trace_cmp4",
1073 "__sanitizer_cov_trace_cmp8",
1074 "__sanitizer_cov_trace_switch",
1076 "kmsan_copy_to_user",
1078 "kmsan_unpoison_entry_regs",
1079 "kmsan_unpoison_memory",
1080 "__msan_chain_origin",
1081 "__msan_get_context_state",
1082 "__msan_instrument_asm_store",
1083 "__msan_metadata_ptr_for_load_1",
1084 "__msan_metadata_ptr_for_load_2",
1085 "__msan_metadata_ptr_for_load_4",
1086 "__msan_metadata_ptr_for_load_8",
1087 "__msan_metadata_ptr_for_load_n",
1088 "__msan_metadata_ptr_for_store_1",
1089 "__msan_metadata_ptr_for_store_2",
1090 "__msan_metadata_ptr_for_store_4",
1091 "__msan_metadata_ptr_for_store_8",
1092 "__msan_metadata_ptr_for_store_n",
1093 "__msan_poison_alloca",
1096 "ubsan_type_mismatch_common",
1097 "__ubsan_handle_type_mismatch",
1098 "__ubsan_handle_type_mismatch_v1",
1099 "__ubsan_handle_shift_out_of_bounds",
1101 "csum_partial_copy_generic",
1103 "copy_mc_fragile_handle_tail",
1104 "copy_mc_enhanced_fast_string",
1105 "ftrace_likely_update", /* CONFIG_TRACE_BRANCH_PROFILING */
1107 "clear_user_rep_good",
1108 "clear_user_original",
1112 static void add_uaccess_safe(struct objtool_file *file)
1114 struct symbol *func;
1120 for (name = uaccess_safe_builtin; *name; name++) {
1121 func = find_symbol_by_name(file->elf, *name);
1125 func->uaccess_safe = true;
1130 * FIXME: For now, just ignore any alternatives which add retpolines. This is
1131 * a temporary hack, as it doesn't allow ORC to unwind from inside a retpoline.
1132 * But it at least allows objtool to understand the control flow *around* the
1135 static int add_ignore_alternatives(struct objtool_file *file)
1137 struct section *sec;
1138 struct reloc *reloc;
1139 struct instruction *insn;
1141 sec = find_section_by_name(file->elf, ".rela.discard.ignore_alts");
1145 list_for_each_entry(reloc, &sec->reloc_list, list) {
1146 if (reloc->sym->type != STT_SECTION) {
1147 WARN("unexpected relocation symbol type in %s", sec->name);
1151 insn = find_insn(file, reloc->sym->sec, reloc->addend);
1153 WARN("bad .discard.ignore_alts entry");
1157 insn->ignore_alts = true;
1163 __weak bool arch_is_retpoline(struct symbol *sym)
1168 __weak bool arch_is_rethunk(struct symbol *sym)
1173 #define NEGATIVE_RELOC ((void *)-1L)
1175 static struct reloc *insn_reloc(struct objtool_file *file, struct instruction *insn)
1177 if (insn->reloc == NEGATIVE_RELOC)
1184 insn->reloc = find_reloc_by_dest_range(file->elf, insn->sec,
1185 insn->offset, insn->len);
1187 insn->reloc = NEGATIVE_RELOC;
1195 static void remove_insn_ops(struct instruction *insn)
1197 struct stack_op *op, *tmp;
1199 list_for_each_entry_safe(op, tmp, &insn->stack_ops, list) {
1200 list_del(&op->list);
1205 static void annotate_call_site(struct objtool_file *file,
1206 struct instruction *insn, bool sibling)
1208 struct reloc *reloc = insn_reloc(file, insn);
1209 struct symbol *sym = insn->call_dest;
1215 * Alternative replacement code is just template code which is
1216 * sometimes copied to the original instruction. For now, don't
1217 * annotate it. (In the future we might consider annotating the
1218 * original instruction if/when it ever makes sense to do so.)
1220 if (!strcmp(insn->sec->name, ".altinstr_replacement"))
1223 if (sym->static_call_tramp) {
1224 list_add_tail(&insn->call_node, &file->static_call_list);
1228 if (sym->retpoline_thunk) {
1229 list_add_tail(&insn->call_node, &file->retpoline_call_list);
1234 * Many compilers cannot disable KCOV or sanitizer calls with a function
1235 * attribute so they need a little help, NOP out any such calls from
1238 if (opts.hack_noinstr && insn->sec->noinstr && sym->profiling_func) {
1240 reloc->type = R_NONE;
1241 elf_write_reloc(file->elf, reloc);
1244 elf_write_insn(file->elf, insn->sec,
1245 insn->offset, insn->len,
1246 sibling ? arch_ret_insn(insn->len)
1247 : arch_nop_insn(insn->len));
1249 insn->type = sibling ? INSN_RETURN : INSN_NOP;
1253 * We've replaced the tail-call JMP insn by two new
1254 * insn: RET; INT3, except we only have a single struct
1255 * insn here. Mark it retpoline_safe to avoid the SLS
1256 * warning, instead of adding another insn.
1258 insn->retpoline_safe = true;
1264 if (opts.mcount && sym->fentry) {
1266 WARN_FUNC("Tail call to __fentry__ !?!?", insn->sec, insn->offset);
1269 reloc->type = R_NONE;
1270 elf_write_reloc(file->elf, reloc);
1273 elf_write_insn(file->elf, insn->sec,
1274 insn->offset, insn->len,
1275 arch_nop_insn(insn->len));
1277 insn->type = INSN_NOP;
1279 list_add_tail(&insn->call_node, &file->mcount_loc_list);
1283 if (!sibling && dead_end_function(file, sym))
1284 insn->dead_end = true;
1287 static void add_call_dest(struct objtool_file *file, struct instruction *insn,
1288 struct symbol *dest, bool sibling)
1290 insn->call_dest = dest;
1295 * Whatever stack impact regular CALLs have, should be undone
1296 * by the RETURN of the called function.
1298 * Annotated intra-function calls retain the stack_ops but
1299 * are converted to JUMP, see read_intra_function_calls().
1301 remove_insn_ops(insn);
1303 annotate_call_site(file, insn, sibling);
1306 static void add_retpoline_call(struct objtool_file *file, struct instruction *insn)
1309 * Retpoline calls/jumps are really dynamic calls/jumps in disguise,
1310 * so convert them accordingly.
1312 switch (insn->type) {
1314 insn->type = INSN_CALL_DYNAMIC;
1316 case INSN_JUMP_UNCONDITIONAL:
1317 insn->type = INSN_JUMP_DYNAMIC;
1319 case INSN_JUMP_CONDITIONAL:
1320 insn->type = INSN_JUMP_DYNAMIC_CONDITIONAL;
1326 insn->retpoline_safe = true;
1329 * Whatever stack impact regular CALLs have, should be undone
1330 * by the RETURN of the called function.
1332 * Annotated intra-function calls retain the stack_ops but
1333 * are converted to JUMP, see read_intra_function_calls().
1335 remove_insn_ops(insn);
1337 annotate_call_site(file, insn, false);
1340 static void add_return_call(struct objtool_file *file, struct instruction *insn, bool add)
1343 * Return thunk tail calls are really just returns in disguise,
1344 * so convert them accordingly.
1346 insn->type = INSN_RETURN;
1347 insn->retpoline_safe = true;
1350 list_add_tail(&insn->call_node, &file->return_thunk_list);
1353 static bool same_function(struct instruction *insn1, struct instruction *insn2)
1355 return insn1->func->pfunc == insn2->func->pfunc;
1358 static bool is_first_func_insn(struct objtool_file *file, struct instruction *insn)
1360 if (insn->offset == insn->func->offset)
1364 struct instruction *prev = prev_insn_same_sym(file, insn);
1366 if (prev && prev->type == INSN_ENDBR &&
1367 insn->offset == insn->func->offset + prev->len)
1375 * Find the destination instructions for all jumps.
1377 static int add_jump_destinations(struct objtool_file *file)
1379 struct instruction *insn, *jump_dest;
1380 struct reloc *reloc;
1381 struct section *dest_sec;
1382 unsigned long dest_off;
1384 for_each_insn(file, insn) {
1385 if (insn->jump_dest) {
1387 * handle_group_alt() may have previously set
1388 * 'jump_dest' for some alternatives.
1392 if (!is_static_jump(insn))
1395 reloc = insn_reloc(file, insn);
1397 dest_sec = insn->sec;
1398 dest_off = arch_jump_destination(insn);
1399 } else if (reloc->sym->type == STT_SECTION) {
1400 dest_sec = reloc->sym->sec;
1401 dest_off = arch_dest_reloc_offset(reloc->addend);
1402 } else if (reloc->sym->retpoline_thunk) {
1403 add_retpoline_call(file, insn);
1405 } else if (reloc->sym->return_thunk) {
1406 add_return_call(file, insn, true);
1408 } else if (insn->func) {
1410 * External sibling call or internal sibling call with
1413 add_call_dest(file, insn, reloc->sym, true);
1415 } else if (reloc->sym->sec->idx) {
1416 dest_sec = reloc->sym->sec;
1417 dest_off = reloc->sym->sym.st_value +
1418 arch_dest_reloc_offset(reloc->addend);
1420 /* non-func asm code jumping to another file */
1424 jump_dest = find_insn(file, dest_sec, dest_off);
1426 struct symbol *sym = find_symbol_by_offset(dest_sec, dest_off);
1429 * This is a special case for zen_untrain_ret().
1430 * It jumps to __x86_return_thunk(), but objtool
1431 * can't find the thunk's starting RET
1432 * instruction, because the RET is also in the
1433 * middle of another instruction. Objtool only
1434 * knows about the outer instruction.
1436 if (sym && sym->return_thunk) {
1437 add_return_call(file, insn, false);
1441 WARN_FUNC("can't find jump dest instruction at %s+0x%lx",
1442 insn->sec, insn->offset, dest_sec->name,
1448 * Cross-function jump.
1450 if (insn->func && jump_dest->func &&
1451 insn->func != jump_dest->func) {
1454 * For GCC 8+, create parent/child links for any cold
1455 * subfunctions. This is _mostly_ redundant with a
1456 * similar initialization in read_symbols().
1458 * If a function has aliases, we want the *first* such
1459 * function in the symbol table to be the subfunction's
1460 * parent. In that case we overwrite the
1461 * initialization done in read_symbols().
1463 * However this code can't completely replace the
1464 * read_symbols() code because this doesn't detect the
1465 * case where the parent function's only reference to a
1466 * subfunction is through a jump table.
1468 if (!strstr(insn->func->name, ".cold") &&
1469 strstr(jump_dest->func->name, ".cold")) {
1470 insn->func->cfunc = jump_dest->func;
1471 jump_dest->func->pfunc = insn->func;
1473 } else if (!same_function(insn, jump_dest) &&
1474 is_first_func_insn(file, jump_dest)) {
1476 * Internal sibling call without reloc or with
1477 * STT_SECTION reloc.
1479 add_call_dest(file, insn, jump_dest->func, true);
1484 insn->jump_dest = jump_dest;
1490 static struct symbol *find_call_destination(struct section *sec, unsigned long offset)
1492 struct symbol *call_dest;
1494 call_dest = find_func_by_offset(sec, offset);
1496 call_dest = find_symbol_by_offset(sec, offset);
1502 * Find the destination instructions for all calls.
1504 static int add_call_destinations(struct objtool_file *file)
1506 struct instruction *insn;
1507 unsigned long dest_off;
1508 struct symbol *dest;
1509 struct reloc *reloc;
1511 for_each_insn(file, insn) {
1512 if (insn->type != INSN_CALL)
1515 reloc = insn_reloc(file, insn);
1517 dest_off = arch_jump_destination(insn);
1518 dest = find_call_destination(insn->sec, dest_off);
1520 add_call_dest(file, insn, dest, false);
1525 if (!insn->call_dest) {
1526 WARN_FUNC("unannotated intra-function call", insn->sec, insn->offset);
1530 if (insn->func && insn->call_dest->type != STT_FUNC) {
1531 WARN_FUNC("unsupported call to non-function",
1532 insn->sec, insn->offset);
1536 } else if (reloc->sym->type == STT_SECTION) {
1537 dest_off = arch_dest_reloc_offset(reloc->addend);
1538 dest = find_call_destination(reloc->sym->sec, dest_off);
1540 WARN_FUNC("can't find call dest symbol at %s+0x%lx",
1541 insn->sec, insn->offset,
1542 reloc->sym->sec->name,
1547 add_call_dest(file, insn, dest, false);
1549 } else if (reloc->sym->retpoline_thunk) {
1550 add_retpoline_call(file, insn);
1553 add_call_dest(file, insn, reloc->sym, false);
1560 * The .alternatives section requires some extra special care over and above
1561 * other special sections because alternatives are patched in place.
1563 static int handle_group_alt(struct objtool_file *file,
1564 struct special_alt *special_alt,
1565 struct instruction *orig_insn,
1566 struct instruction **new_insn)
1568 struct instruction *last_orig_insn, *last_new_insn = NULL, *insn, *nop = NULL;
1569 struct alt_group *orig_alt_group, *new_alt_group;
1570 unsigned long dest_off;
1573 orig_alt_group = malloc(sizeof(*orig_alt_group));
1574 if (!orig_alt_group) {
1575 WARN("malloc failed");
1578 orig_alt_group->cfi = calloc(special_alt->orig_len,
1579 sizeof(struct cfi_state *));
1580 if (!orig_alt_group->cfi) {
1581 WARN("calloc failed");
1585 last_orig_insn = NULL;
1587 sec_for_each_insn_from(file, insn) {
1588 if (insn->offset >= special_alt->orig_off + special_alt->orig_len)
1591 insn->alt_group = orig_alt_group;
1592 last_orig_insn = insn;
1594 orig_alt_group->orig_group = NULL;
1595 orig_alt_group->first_insn = orig_insn;
1596 orig_alt_group->last_insn = last_orig_insn;
1599 new_alt_group = malloc(sizeof(*new_alt_group));
1600 if (!new_alt_group) {
1601 WARN("malloc failed");
1605 if (special_alt->new_len < special_alt->orig_len) {
1607 * Insert a fake nop at the end to make the replacement
1608 * alt_group the same size as the original. This is needed to
1609 * allow propagate_alt_cfi() to do its magic. When the last
1610 * instruction affects the stack, the instruction after it (the
1611 * nop) will propagate the new state to the shared CFI array.
1613 nop = malloc(sizeof(*nop));
1615 WARN("malloc failed");
1618 memset(nop, 0, sizeof(*nop));
1619 INIT_LIST_HEAD(&nop->alts);
1620 INIT_LIST_HEAD(&nop->stack_ops);
1622 nop->sec = special_alt->new_sec;
1623 nop->offset = special_alt->new_off + special_alt->new_len;
1624 nop->len = special_alt->orig_len - special_alt->new_len;
1625 nop->type = INSN_NOP;
1626 nop->func = orig_insn->func;
1627 nop->alt_group = new_alt_group;
1628 nop->ignore = orig_insn->ignore_alts;
1631 if (!special_alt->new_len) {
1637 sec_for_each_insn_from(file, insn) {
1638 struct reloc *alt_reloc;
1640 if (insn->offset >= special_alt->new_off + special_alt->new_len)
1643 last_new_insn = insn;
1645 insn->ignore = orig_insn->ignore_alts;
1646 insn->func = orig_insn->func;
1647 insn->alt_group = new_alt_group;
1650 * Since alternative replacement code is copy/pasted by the
1651 * kernel after applying relocations, generally such code can't
1652 * have relative-address relocation references to outside the
1653 * .altinstr_replacement section, unless the arch's
1654 * alternatives code can adjust the relative offsets
1657 alt_reloc = insn_reloc(file, insn);
1659 !arch_support_alt_relocation(special_alt, insn, alt_reloc)) {
1661 WARN_FUNC("unsupported relocation in alternatives section",
1662 insn->sec, insn->offset);
1666 if (!is_static_jump(insn))
1669 if (!insn->immediate)
1672 dest_off = arch_jump_destination(insn);
1673 if (dest_off == special_alt->new_off + special_alt->new_len) {
1674 insn->jump_dest = next_insn_same_sec(file, last_orig_insn);
1675 if (!insn->jump_dest) {
1676 WARN_FUNC("can't find alternative jump destination",
1677 insn->sec, insn->offset);
1683 if (!last_new_insn) {
1684 WARN_FUNC("can't find last new alternative instruction",
1685 special_alt->new_sec, special_alt->new_off);
1690 list_add(&nop->list, &last_new_insn->list);
1692 new_alt_group->orig_group = orig_alt_group;
1693 new_alt_group->first_insn = *new_insn;
1694 new_alt_group->last_insn = nop ? : last_new_insn;
1695 new_alt_group->cfi = orig_alt_group->cfi;
1700 * A jump table entry can either convert a nop to a jump or a jump to a nop.
1701 * If the original instruction is a jump, make the alt entry an effective nop
1702 * by just skipping the original instruction.
1704 static int handle_jump_alt(struct objtool_file *file,
1705 struct special_alt *special_alt,
1706 struct instruction *orig_insn,
1707 struct instruction **new_insn)
1709 if (orig_insn->type != INSN_JUMP_UNCONDITIONAL &&
1710 orig_insn->type != INSN_NOP) {
1712 WARN_FUNC("unsupported instruction at jump label",
1713 orig_insn->sec, orig_insn->offset);
1717 if (opts.hack_jump_label && special_alt->key_addend & 2) {
1718 struct reloc *reloc = insn_reloc(file, orig_insn);
1721 reloc->type = R_NONE;
1722 elf_write_reloc(file->elf, reloc);
1724 elf_write_insn(file->elf, orig_insn->sec,
1725 orig_insn->offset, orig_insn->len,
1726 arch_nop_insn(orig_insn->len));
1727 orig_insn->type = INSN_NOP;
1730 if (orig_insn->type == INSN_NOP) {
1731 if (orig_insn->len == 2)
1732 file->jl_nop_short++;
1734 file->jl_nop_long++;
1739 if (orig_insn->len == 2)
1744 *new_insn = list_next_entry(orig_insn, list);
1749 * Read all the special sections which have alternate instructions which can be
1750 * patched in or redirected to at runtime. Each instruction having alternate
1751 * instruction(s) has them added to its insn->alts list, which will be
1752 * traversed in validate_branch().
1754 static int add_special_section_alts(struct objtool_file *file)
1756 struct list_head special_alts;
1757 struct instruction *orig_insn, *new_insn;
1758 struct special_alt *special_alt, *tmp;
1759 struct alternative *alt;
1762 ret = special_get_alts(file->elf, &special_alts);
1766 list_for_each_entry_safe(special_alt, tmp, &special_alts, list) {
1768 orig_insn = find_insn(file, special_alt->orig_sec,
1769 special_alt->orig_off);
1771 WARN_FUNC("special: can't find orig instruction",
1772 special_alt->orig_sec, special_alt->orig_off);
1778 if (!special_alt->group || special_alt->new_len) {
1779 new_insn = find_insn(file, special_alt->new_sec,
1780 special_alt->new_off);
1782 WARN_FUNC("special: can't find new instruction",
1783 special_alt->new_sec,
1784 special_alt->new_off);
1790 if (special_alt->group) {
1791 if (!special_alt->orig_len) {
1792 WARN_FUNC("empty alternative entry",
1793 orig_insn->sec, orig_insn->offset);
1797 ret = handle_group_alt(file, special_alt, orig_insn,
1801 } else if (special_alt->jump_or_nop) {
1802 ret = handle_jump_alt(file, special_alt, orig_insn,
1808 alt = malloc(sizeof(*alt));
1810 WARN("malloc failed");
1815 alt->insn = new_insn;
1816 alt->skip_orig = special_alt->skip_orig;
1817 orig_insn->ignore_alts |= special_alt->skip_alt;
1818 list_add_tail(&alt->list, &orig_insn->alts);
1820 list_del(&special_alt->list);
1825 printf("jl\\\tNOP\tJMP\n");
1826 printf("short:\t%ld\t%ld\n", file->jl_nop_short, file->jl_short);
1827 printf("long:\t%ld\t%ld\n", file->jl_nop_long, file->jl_long);
1834 static int add_jump_table(struct objtool_file *file, struct instruction *insn,
1835 struct reloc *table)
1837 struct reloc *reloc = table;
1838 struct instruction *dest_insn;
1839 struct alternative *alt;
1840 struct symbol *pfunc = insn->func->pfunc;
1841 unsigned int prev_offset = 0;
1844 * Each @reloc is a switch table relocation which points to the target
1847 list_for_each_entry_from(reloc, &table->sec->reloc_list, list) {
1849 /* Check for the end of the table: */
1850 if (reloc != table && reloc->jump_table_start)
1853 /* Make sure the table entries are consecutive: */
1854 if (prev_offset && reloc->offset != prev_offset + 8)
1857 /* Detect function pointers from contiguous objects: */
1858 if (reloc->sym->sec == pfunc->sec &&
1859 reloc->addend == pfunc->offset)
1862 dest_insn = find_insn(file, reloc->sym->sec, reloc->addend);
1866 /* Make sure the destination is in the same function: */
1867 if (!dest_insn->func || dest_insn->func->pfunc != pfunc)
1870 alt = malloc(sizeof(*alt));
1872 WARN("malloc failed");
1876 alt->insn = dest_insn;
1877 list_add_tail(&alt->list, &insn->alts);
1878 prev_offset = reloc->offset;
1882 WARN_FUNC("can't find switch jump table",
1883 insn->sec, insn->offset);
1891 * find_jump_table() - Given a dynamic jump, find the switch jump table
1892 * associated with it.
1894 static struct reloc *find_jump_table(struct objtool_file *file,
1895 struct symbol *func,
1896 struct instruction *insn)
1898 struct reloc *table_reloc;
1899 struct instruction *dest_insn, *orig_insn = insn;
1902 * Backward search using the @first_jump_src links, these help avoid
1903 * much of the 'in between' code. Which avoids us getting confused by
1907 insn && insn->func && insn->func->pfunc == func;
1908 insn = insn->first_jump_src ?: prev_insn_same_sym(file, insn)) {
1910 if (insn != orig_insn && insn->type == INSN_JUMP_DYNAMIC)
1913 /* allow small jumps within the range */
1914 if (insn->type == INSN_JUMP_UNCONDITIONAL &&
1916 (insn->jump_dest->offset <= insn->offset ||
1917 insn->jump_dest->offset > orig_insn->offset))
1920 table_reloc = arch_find_switch_table(file, insn);
1923 dest_insn = find_insn(file, table_reloc->sym->sec, table_reloc->addend);
1924 if (!dest_insn || !dest_insn->func || dest_insn->func->pfunc != func)
1934 * First pass: Mark the head of each jump table so that in the next pass,
1935 * we know when a given jump table ends and the next one starts.
1937 static void mark_func_jump_tables(struct objtool_file *file,
1938 struct symbol *func)
1940 struct instruction *insn, *last = NULL;
1941 struct reloc *reloc;
1943 func_for_each_insn(file, func, insn) {
1948 * Store back-pointers for unconditional forward jumps such
1949 * that find_jump_table() can back-track using those and
1950 * avoid some potentially confusing code.
1952 if (insn->type == INSN_JUMP_UNCONDITIONAL && insn->jump_dest &&
1953 insn->offset > last->offset &&
1954 insn->jump_dest->offset > insn->offset &&
1955 !insn->jump_dest->first_jump_src) {
1957 insn->jump_dest->first_jump_src = insn;
1958 last = insn->jump_dest;
1961 if (insn->type != INSN_JUMP_DYNAMIC)
1964 reloc = find_jump_table(file, func, insn);
1966 reloc->jump_table_start = true;
1967 insn->jump_table = reloc;
1972 static int add_func_jump_tables(struct objtool_file *file,
1973 struct symbol *func)
1975 struct instruction *insn;
1978 func_for_each_insn(file, func, insn) {
1979 if (!insn->jump_table)
1982 ret = add_jump_table(file, insn, insn->jump_table);
1991 * For some switch statements, gcc generates a jump table in the .rodata
1992 * section which contains a list of addresses within the function to jump to.
1993 * This finds these jump tables and adds them to the insn->alts lists.
1995 static int add_jump_table_alts(struct objtool_file *file)
1997 struct section *sec;
1998 struct symbol *func;
2004 for_each_sec(file, sec) {
2005 list_for_each_entry(func, &sec->symbol_list, list) {
2006 if (func->type != STT_FUNC)
2009 mark_func_jump_tables(file, func);
2010 ret = add_func_jump_tables(file, func);
2019 static void set_func_state(struct cfi_state *state)
2021 state->cfa = initial_func_cfi.cfa;
2022 memcpy(&state->regs, &initial_func_cfi.regs,
2023 CFI_NUM_REGS * sizeof(struct cfi_reg));
2024 state->stack_size = initial_func_cfi.cfa.offset;
2027 static int read_unwind_hints(struct objtool_file *file)
2029 struct cfi_state cfi = init_cfi;
2030 struct section *sec, *relocsec;
2031 struct unwind_hint *hint;
2032 struct instruction *insn;
2033 struct reloc *reloc;
2036 sec = find_section_by_name(file->elf, ".discard.unwind_hints");
2040 relocsec = sec->reloc;
2042 WARN("missing .rela.discard.unwind_hints section");
2046 if (sec->sh.sh_size % sizeof(struct unwind_hint)) {
2047 WARN("struct unwind_hint size mismatch");
2053 for (i = 0; i < sec->sh.sh_size / sizeof(struct unwind_hint); i++) {
2054 hint = (struct unwind_hint *)sec->data->d_buf + i;
2056 reloc = find_reloc_by_dest(file->elf, sec, i * sizeof(*hint));
2058 WARN("can't find reloc for unwind_hints[%d]", i);
2062 insn = find_insn(file, reloc->sym->sec, reloc->addend);
2064 WARN("can't find insn for unwind_hints[%d]", i);
2070 if (hint->type == UNWIND_HINT_TYPE_SAVE) {
2076 if (hint->type == UNWIND_HINT_TYPE_RESTORE) {
2077 insn->restore = true;
2081 if (hint->type == UNWIND_HINT_TYPE_REGS_PARTIAL) {
2082 struct symbol *sym = find_symbol_by_offset(insn->sec, insn->offset);
2084 if (sym && sym->bind == STB_GLOBAL) {
2085 if (opts.ibt && insn->type != INSN_ENDBR && !insn->noendbr) {
2086 WARN_FUNC("UNWIND_HINT_IRET_REGS without ENDBR",
2087 insn->sec, insn->offset);
2094 if (hint->type == UNWIND_HINT_TYPE_ENTRY) {
2095 hint->type = UNWIND_HINT_TYPE_CALL;
2099 if (hint->type == UNWIND_HINT_TYPE_FUNC) {
2100 insn->cfi = &func_cfi;
2107 if (arch_decode_hint_reg(hint->sp_reg, &cfi.cfa.base)) {
2108 WARN_FUNC("unsupported unwind_hint sp base reg %d",
2109 insn->sec, insn->offset, hint->sp_reg);
2113 cfi.cfa.offset = bswap_if_needed(hint->sp_offset);
2114 cfi.type = hint->type;
2115 cfi.end = hint->end;
2117 insn->cfi = cfi_hash_find_or_add(&cfi);
2123 static int read_noendbr_hints(struct objtool_file *file)
2125 struct section *sec;
2126 struct instruction *insn;
2127 struct reloc *reloc;
2129 sec = find_section_by_name(file->elf, ".rela.discard.noendbr");
2133 list_for_each_entry(reloc, &sec->reloc_list, list) {
2134 insn = find_insn(file, reloc->sym->sec, reloc->sym->offset + reloc->addend);
2136 WARN("bad .discard.noendbr entry");
2146 static int read_retpoline_hints(struct objtool_file *file)
2148 struct section *sec;
2149 struct instruction *insn;
2150 struct reloc *reloc;
2152 sec = find_section_by_name(file->elf, ".rela.discard.retpoline_safe");
2156 list_for_each_entry(reloc, &sec->reloc_list, list) {
2157 if (reloc->sym->type != STT_SECTION) {
2158 WARN("unexpected relocation symbol type in %s", sec->name);
2162 insn = find_insn(file, reloc->sym->sec, reloc->addend);
2164 WARN("bad .discard.retpoline_safe entry");
2168 if (insn->type != INSN_JUMP_DYNAMIC &&
2169 insn->type != INSN_CALL_DYNAMIC &&
2170 insn->type != INSN_RETURN &&
2171 insn->type != INSN_NOP) {
2172 WARN_FUNC("retpoline_safe hint not an indirect jump/call/ret/nop",
2173 insn->sec, insn->offset);
2177 insn->retpoline_safe = true;
2183 static int read_instr_hints(struct objtool_file *file)
2185 struct section *sec;
2186 struct instruction *insn;
2187 struct reloc *reloc;
2189 sec = find_section_by_name(file->elf, ".rela.discard.instr_end");
2193 list_for_each_entry(reloc, &sec->reloc_list, list) {
2194 if (reloc->sym->type != STT_SECTION) {
2195 WARN("unexpected relocation symbol type in %s", sec->name);
2199 insn = find_insn(file, reloc->sym->sec, reloc->addend);
2201 WARN("bad .discard.instr_end entry");
2208 sec = find_section_by_name(file->elf, ".rela.discard.instr_begin");
2212 list_for_each_entry(reloc, &sec->reloc_list, list) {
2213 if (reloc->sym->type != STT_SECTION) {
2214 WARN("unexpected relocation symbol type in %s", sec->name);
2218 insn = find_insn(file, reloc->sym->sec, reloc->addend);
2220 WARN("bad .discard.instr_begin entry");
2230 static int read_intra_function_calls(struct objtool_file *file)
2232 struct instruction *insn;
2233 struct section *sec;
2234 struct reloc *reloc;
2236 sec = find_section_by_name(file->elf, ".rela.discard.intra_function_calls");
2240 list_for_each_entry(reloc, &sec->reloc_list, list) {
2241 unsigned long dest_off;
2243 if (reloc->sym->type != STT_SECTION) {
2244 WARN("unexpected relocation symbol type in %s",
2249 insn = find_insn(file, reloc->sym->sec, reloc->addend);
2251 WARN("bad .discard.intra_function_call entry");
2255 if (insn->type != INSN_CALL) {
2256 WARN_FUNC("intra_function_call not a direct call",
2257 insn->sec, insn->offset);
2262 * Treat intra-function CALLs as JMPs, but with a stack_op.
2263 * See add_call_destinations(), which strips stack_ops from
2266 insn->type = INSN_JUMP_UNCONDITIONAL;
2268 dest_off = arch_jump_destination(insn);
2269 insn->jump_dest = find_insn(file, insn->sec, dest_off);
2270 if (!insn->jump_dest) {
2271 WARN_FUNC("can't find call dest at %s+0x%lx",
2272 insn->sec, insn->offset,
2273 insn->sec->name, dest_off);
2282 * Return true if name matches an instrumentation function, where calls to that
2283 * function from noinstr code can safely be removed, but compilers won't do so.
2285 static bool is_profiling_func(const char *name)
2288 * Many compilers cannot disable KCOV with a function attribute.
2290 if (!strncmp(name, "__sanitizer_cov_", 16))
2294 * Some compilers currently do not remove __tsan_func_entry/exit nor
2295 * __tsan_atomic_signal_fence (used for barrier instrumentation) with
2296 * the __no_sanitize_thread attribute, remove them. Once the kernel's
2297 * minimum Clang version is 14.0, this can be removed.
2299 if (!strncmp(name, "__tsan_func_", 12) ||
2300 !strcmp(name, "__tsan_atomic_signal_fence"))
2306 static int classify_symbols(struct objtool_file *file)
2308 struct section *sec;
2309 struct symbol *func;
2311 for_each_sec(file, sec) {
2312 list_for_each_entry(func, &sec->symbol_list, list) {
2313 if (func->bind != STB_GLOBAL)
2316 if (!strncmp(func->name, STATIC_CALL_TRAMP_PREFIX_STR,
2317 strlen(STATIC_CALL_TRAMP_PREFIX_STR)))
2318 func->static_call_tramp = true;
2320 if (arch_is_retpoline(func))
2321 func->retpoline_thunk = true;
2323 if (arch_is_rethunk(func))
2324 func->return_thunk = true;
2326 if (!strcmp(func->name, "__fentry__"))
2327 func->fentry = true;
2329 if (is_profiling_func(func->name))
2330 func->profiling_func = true;
2337 static void mark_rodata(struct objtool_file *file)
2339 struct section *sec;
2343 * Search for the following rodata sections, each of which can
2344 * potentially contain jump tables:
2346 * - .rodata: can contain GCC switch tables
2347 * - .rodata.<func>: same, if -fdata-sections is being used
2348 * - .rodata..c_jump_table: contains C annotated jump tables
2350 * .rodata.str1.* sections are ignored; they don't contain jump tables.
2352 for_each_sec(file, sec) {
2353 if (!strncmp(sec->name, ".rodata", 7) &&
2354 !strstr(sec->name, ".str1.")) {
2360 file->rodata = found;
2363 static int decode_sections(struct objtool_file *file)
2369 ret = init_pv_ops(file);
2373 ret = decode_instructions(file);
2378 add_uaccess_safe(file);
2380 ret = add_ignore_alternatives(file);
2385 * Must be before read_unwind_hints() since that needs insn->noendbr.
2387 ret = read_noendbr_hints(file);
2392 * Must be before add_{jump_call}_destination.
2394 ret = classify_symbols(file);
2399 * Must be before add_jump_destinations(), which depends on 'func'
2400 * being set for alternatives, to enable proper sibling call detection.
2402 ret = add_special_section_alts(file);
2406 ret = add_jump_destinations(file);
2411 * Must be before add_call_destination(); it changes INSN_CALL to
2414 ret = read_intra_function_calls(file);
2418 ret = add_call_destinations(file);
2423 * Must be after add_call_destinations() such that it can override
2424 * dead_end_function() marks.
2426 ret = add_dead_ends(file);
2430 ret = add_jump_table_alts(file);
2434 ret = read_unwind_hints(file);
2438 ret = read_retpoline_hints(file);
2442 ret = read_instr_hints(file);
2449 static bool is_fentry_call(struct instruction *insn)
2451 if (insn->type == INSN_CALL &&
2453 insn->call_dest->fentry)
2459 static bool has_modified_stack_frame(struct instruction *insn, struct insn_state *state)
2461 struct cfi_state *cfi = &state->cfi;
2464 if (cfi->cfa.base != initial_func_cfi.cfa.base || cfi->drap)
2467 if (cfi->cfa.offset != initial_func_cfi.cfa.offset)
2470 if (cfi->stack_size != initial_func_cfi.cfa.offset)
2473 for (i = 0; i < CFI_NUM_REGS; i++) {
2474 if (cfi->regs[i].base != initial_func_cfi.regs[i].base ||
2475 cfi->regs[i].offset != initial_func_cfi.regs[i].offset)
2482 static bool check_reg_frame_pos(const struct cfi_reg *reg,
2483 int expected_offset)
2485 return reg->base == CFI_CFA &&
2486 reg->offset == expected_offset;
2489 static bool has_valid_stack_frame(struct insn_state *state)
2491 struct cfi_state *cfi = &state->cfi;
2493 if (cfi->cfa.base == CFI_BP &&
2494 check_reg_frame_pos(&cfi->regs[CFI_BP], -cfi->cfa.offset) &&
2495 check_reg_frame_pos(&cfi->regs[CFI_RA], -cfi->cfa.offset + 8))
2498 if (cfi->drap && cfi->regs[CFI_BP].base == CFI_BP)
2504 static int update_cfi_state_regs(struct instruction *insn,
2505 struct cfi_state *cfi,
2506 struct stack_op *op)
2508 struct cfi_reg *cfa = &cfi->cfa;
2510 if (cfa->base != CFI_SP && cfa->base != CFI_SP_INDIRECT)
2514 if (op->dest.type == OP_DEST_PUSH || op->dest.type == OP_DEST_PUSHF)
2518 if (op->src.type == OP_SRC_POP || op->src.type == OP_SRC_POPF)
2521 /* add immediate to sp */
2522 if (op->dest.type == OP_DEST_REG && op->src.type == OP_SRC_ADD &&
2523 op->dest.reg == CFI_SP && op->src.reg == CFI_SP)
2524 cfa->offset -= op->src.offset;
2529 static void save_reg(struct cfi_state *cfi, unsigned char reg, int base, int offset)
2531 if (arch_callee_saved_reg(reg) &&
2532 cfi->regs[reg].base == CFI_UNDEFINED) {
2533 cfi->regs[reg].base = base;
2534 cfi->regs[reg].offset = offset;
2538 static void restore_reg(struct cfi_state *cfi, unsigned char reg)
2540 cfi->regs[reg].base = initial_func_cfi.regs[reg].base;
2541 cfi->regs[reg].offset = initial_func_cfi.regs[reg].offset;
2545 * A note about DRAP stack alignment:
2547 * GCC has the concept of a DRAP register, which is used to help keep track of
2548 * the stack pointer when aligning the stack. r10 or r13 is used as the DRAP
2549 * register. The typical DRAP pattern is:
2551 * 4c 8d 54 24 08 lea 0x8(%rsp),%r10
2552 * 48 83 e4 c0 and $0xffffffffffffffc0,%rsp
2553 * 41 ff 72 f8 pushq -0x8(%r10)
2555 * 48 89 e5 mov %rsp,%rbp
2562 * 49 8d 62 f8 lea -0x8(%r10),%rsp
2565 * There are some variations in the epilogues, like:
2573 * 49 8d 62 f8 lea -0x8(%r10),%rsp
2578 * 4c 8b 55 e8 mov -0x18(%rbp),%r10
2579 * 48 8b 5d e0 mov -0x20(%rbp),%rbx
2580 * 4c 8b 65 f0 mov -0x10(%rbp),%r12
2581 * 4c 8b 6d f8 mov -0x8(%rbp),%r13
2583 * 49 8d 62 f8 lea -0x8(%r10),%rsp
2586 * Sometimes r13 is used as the DRAP register, in which case it's saved and
2587 * restored beforehand:
2590 * 4c 8d 6c 24 10 lea 0x10(%rsp),%r13
2591 * 48 83 e4 f0 and $0xfffffffffffffff0,%rsp
2593 * 49 8d 65 f0 lea -0x10(%r13),%rsp
2597 static int update_cfi_state(struct instruction *insn,
2598 struct instruction *next_insn,
2599 struct cfi_state *cfi, struct stack_op *op)
2601 struct cfi_reg *cfa = &cfi->cfa;
2602 struct cfi_reg *regs = cfi->regs;
2604 /* stack operations don't make sense with an undefined CFA */
2605 if (cfa->base == CFI_UNDEFINED) {
2607 WARN_FUNC("undefined stack state", insn->sec, insn->offset);
2613 if (cfi->type == UNWIND_HINT_TYPE_REGS ||
2614 cfi->type == UNWIND_HINT_TYPE_REGS_PARTIAL)
2615 return update_cfi_state_regs(insn, cfi, op);
2617 switch (op->dest.type) {
2620 switch (op->src.type) {
2623 if (op->src.reg == CFI_SP && op->dest.reg == CFI_BP &&
2624 cfa->base == CFI_SP &&
2625 check_reg_frame_pos(®s[CFI_BP], -cfa->offset)) {
2627 /* mov %rsp, %rbp */
2628 cfa->base = op->dest.reg;
2629 cfi->bp_scratch = false;
2632 else if (op->src.reg == CFI_SP &&
2633 op->dest.reg == CFI_BP && cfi->drap) {
2635 /* drap: mov %rsp, %rbp */
2636 regs[CFI_BP].base = CFI_BP;
2637 regs[CFI_BP].offset = -cfi->stack_size;
2638 cfi->bp_scratch = false;
2641 else if (op->src.reg == CFI_SP && cfa->base == CFI_SP) {
2646 * This is needed for the rare case where GCC
2653 cfi->vals[op->dest.reg].base = CFI_CFA;
2654 cfi->vals[op->dest.reg].offset = -cfi->stack_size;
2657 else if (op->src.reg == CFI_BP && op->dest.reg == CFI_SP &&
2658 (cfa->base == CFI_BP || cfa->base == cfi->drap_reg)) {
2663 * Restore the original stack pointer (Clang).
2665 cfi->stack_size = -cfi->regs[CFI_BP].offset;
2668 else if (op->dest.reg == cfa->base) {
2670 /* mov %reg, %rsp */
2671 if (cfa->base == CFI_SP &&
2672 cfi->vals[op->src.reg].base == CFI_CFA) {
2675 * This is needed for the rare case
2676 * where GCC does something dumb like:
2678 * lea 0x8(%rsp), %rcx
2682 cfa->offset = -cfi->vals[op->src.reg].offset;
2683 cfi->stack_size = cfa->offset;
2685 } else if (cfa->base == CFI_SP &&
2686 cfi->vals[op->src.reg].base == CFI_SP_INDIRECT &&
2687 cfi->vals[op->src.reg].offset == cfa->offset) {
2692 * 1: mov %rsp, (%[tos])
2693 * 2: mov %[tos], %rsp
2699 * 1 - places a pointer to the previous
2700 * stack at the Top-of-Stack of the
2703 * 2 - switches to the new stack.
2705 * 3 - pops the Top-of-Stack to restore
2706 * the original stack.
2708 * Note: we set base to SP_INDIRECT
2709 * here and preserve offset. Therefore
2710 * when the unwinder reaches ToS it
2711 * will dereference SP and then add the
2712 * offset to find the next frame, IOW:
2715 cfa->base = CFI_SP_INDIRECT;
2718 cfa->base = CFI_UNDEFINED;
2723 else if (op->dest.reg == CFI_SP &&
2724 cfi->vals[op->src.reg].base == CFI_SP_INDIRECT &&
2725 cfi->vals[op->src.reg].offset == cfa->offset) {
2728 * The same stack swizzle case 2) as above. But
2729 * because we can't change cfa->base, case 3)
2730 * will become a regular POP. Pretend we're a
2731 * PUSH so things don't go unbalanced.
2733 cfi->stack_size += 8;
2740 if (op->dest.reg == CFI_SP && op->src.reg == CFI_SP) {
2743 cfi->stack_size -= op->src.offset;
2744 if (cfa->base == CFI_SP)
2745 cfa->offset -= op->src.offset;
2749 if (op->dest.reg == CFI_SP && op->src.reg == CFI_BP) {
2751 /* lea disp(%rbp), %rsp */
2752 cfi->stack_size = -(op->src.offset + regs[CFI_BP].offset);
2756 if (!cfi->drap && op->src.reg == CFI_SP &&
2757 op->dest.reg == CFI_BP && cfa->base == CFI_SP &&
2758 check_reg_frame_pos(®s[CFI_BP], -cfa->offset + op->src.offset)) {
2760 /* lea disp(%rsp), %rbp */
2762 cfa->offset -= op->src.offset;
2763 cfi->bp_scratch = false;
2767 if (op->src.reg == CFI_SP && cfa->base == CFI_SP) {
2769 /* drap: lea disp(%rsp), %drap */
2770 cfi->drap_reg = op->dest.reg;
2773 * lea disp(%rsp), %reg
2775 * This is needed for the rare case where GCC
2776 * does something dumb like:
2778 * lea 0x8(%rsp), %rcx
2782 cfi->vals[op->dest.reg].base = CFI_CFA;
2783 cfi->vals[op->dest.reg].offset = \
2784 -cfi->stack_size + op->src.offset;
2789 if (cfi->drap && op->dest.reg == CFI_SP &&
2790 op->src.reg == cfi->drap_reg) {
2792 /* drap: lea disp(%drap), %rsp */
2794 cfa->offset = cfi->stack_size = -op->src.offset;
2795 cfi->drap_reg = CFI_UNDEFINED;
2800 if (op->dest.reg == cfi->cfa.base && !(next_insn && next_insn->hint)) {
2801 WARN_FUNC("unsupported stack register modification",
2802 insn->sec, insn->offset);
2809 if (op->dest.reg != CFI_SP ||
2810 (cfi->drap_reg != CFI_UNDEFINED && cfa->base != CFI_SP) ||
2811 (cfi->drap_reg == CFI_UNDEFINED && cfa->base != CFI_BP)) {
2812 WARN_FUNC("unsupported stack pointer realignment",
2813 insn->sec, insn->offset);
2817 if (cfi->drap_reg != CFI_UNDEFINED) {
2818 /* drap: and imm, %rsp */
2819 cfa->base = cfi->drap_reg;
2820 cfa->offset = cfi->stack_size = 0;
2825 * Older versions of GCC (4.8ish) realign the stack
2826 * without DRAP, with a frame pointer.
2833 if (op->dest.reg == CFI_SP && cfa->base == CFI_SP_INDIRECT) {
2835 /* pop %rsp; # restore from a stack swizzle */
2840 if (!cfi->drap && op->dest.reg == cfa->base) {
2846 if (cfi->drap && cfa->base == CFI_BP_INDIRECT &&
2847 op->dest.reg == cfi->drap_reg &&
2848 cfi->drap_offset == -cfi->stack_size) {
2850 /* drap: pop %drap */
2851 cfa->base = cfi->drap_reg;
2853 cfi->drap_offset = -1;
2855 } else if (cfi->stack_size == -regs[op->dest.reg].offset) {
2858 restore_reg(cfi, op->dest.reg);
2861 cfi->stack_size -= 8;
2862 if (cfa->base == CFI_SP)
2867 case OP_SRC_REG_INDIRECT:
2868 if (!cfi->drap && op->dest.reg == cfa->base &&
2869 op->dest.reg == CFI_BP) {
2871 /* mov disp(%rsp), %rbp */
2873 cfa->offset = cfi->stack_size;
2876 if (cfi->drap && op->src.reg == CFI_BP &&
2877 op->src.offset == cfi->drap_offset) {
2879 /* drap: mov disp(%rbp), %drap */
2880 cfa->base = cfi->drap_reg;
2882 cfi->drap_offset = -1;
2885 if (cfi->drap && op->src.reg == CFI_BP &&
2886 op->src.offset == regs[op->dest.reg].offset) {
2888 /* drap: mov disp(%rbp), %reg */
2889 restore_reg(cfi, op->dest.reg);
2891 } else if (op->src.reg == cfa->base &&
2892 op->src.offset == regs[op->dest.reg].offset + cfa->offset) {
2894 /* mov disp(%rbp), %reg */
2895 /* mov disp(%rsp), %reg */
2896 restore_reg(cfi, op->dest.reg);
2898 } else if (op->src.reg == CFI_SP &&
2899 op->src.offset == regs[op->dest.reg].offset + cfi->stack_size) {
2901 /* mov disp(%rsp), %reg */
2902 restore_reg(cfi, op->dest.reg);
2908 WARN_FUNC("unknown stack-related instruction",
2909 insn->sec, insn->offset);
2917 cfi->stack_size += 8;
2918 if (cfa->base == CFI_SP)
2921 if (op->src.type != OP_SRC_REG)
2925 if (op->src.reg == cfa->base && op->src.reg == cfi->drap_reg) {
2927 /* drap: push %drap */
2928 cfa->base = CFI_BP_INDIRECT;
2929 cfa->offset = -cfi->stack_size;
2931 /* save drap so we know when to restore it */
2932 cfi->drap_offset = -cfi->stack_size;
2934 } else if (op->src.reg == CFI_BP && cfa->base == cfi->drap_reg) {
2936 /* drap: push %rbp */
2937 cfi->stack_size = 0;
2941 /* drap: push %reg */
2942 save_reg(cfi, op->src.reg, CFI_BP, -cfi->stack_size);
2948 save_reg(cfi, op->src.reg, CFI_CFA, -cfi->stack_size);
2951 /* detect when asm code uses rbp as a scratch register */
2952 if (opts.stackval && insn->func && op->src.reg == CFI_BP &&
2953 cfa->base != CFI_BP)
2954 cfi->bp_scratch = true;
2957 case OP_DEST_REG_INDIRECT:
2960 if (op->src.reg == cfa->base && op->src.reg == cfi->drap_reg) {
2962 /* drap: mov %drap, disp(%rbp) */
2963 cfa->base = CFI_BP_INDIRECT;
2964 cfa->offset = op->dest.offset;
2966 /* save drap offset so we know when to restore it */
2967 cfi->drap_offset = op->dest.offset;
2970 /* drap: mov reg, disp(%rbp) */
2971 save_reg(cfi, op->src.reg, CFI_BP, op->dest.offset);
2974 } else if (op->dest.reg == cfa->base) {
2976 /* mov reg, disp(%rbp) */
2977 /* mov reg, disp(%rsp) */
2978 save_reg(cfi, op->src.reg, CFI_CFA,
2979 op->dest.offset - cfi->cfa.offset);
2981 } else if (op->dest.reg == CFI_SP) {
2983 /* mov reg, disp(%rsp) */
2984 save_reg(cfi, op->src.reg, CFI_CFA,
2985 op->dest.offset - cfi->stack_size);
2987 } else if (op->src.reg == CFI_SP && op->dest.offset == 0) {
2989 /* mov %rsp, (%reg); # setup a stack swizzle. */
2990 cfi->vals[op->dest.reg].base = CFI_SP_INDIRECT;
2991 cfi->vals[op->dest.reg].offset = cfa->offset;
2997 if (op->src.type != OP_SRC_POP && op->src.type != OP_SRC_POPF) {
2998 WARN_FUNC("unknown stack-related memory operation",
2999 insn->sec, insn->offset);
3004 cfi->stack_size -= 8;
3005 if (cfa->base == CFI_SP)
3011 WARN_FUNC("unknown stack-related instruction",
3012 insn->sec, insn->offset);
3020 * The stack layouts of alternatives instructions can sometimes diverge when
3021 * they have stack modifications. That's fine as long as the potential stack
3022 * layouts don't conflict at any given potential instruction boundary.
3024 * Flatten the CFIs of the different alternative code streams (both original
3025 * and replacement) into a single shared CFI array which can be used to detect
3026 * conflicts and nicely feed a linear array of ORC entries to the unwinder.
3028 static int propagate_alt_cfi(struct objtool_file *file, struct instruction *insn)
3030 struct cfi_state **alt_cfi;
3033 if (!insn->alt_group)
3037 WARN("CFI missing");
3041 alt_cfi = insn->alt_group->cfi;
3042 group_off = insn->offset - insn->alt_group->first_insn->offset;
3044 if (!alt_cfi[group_off]) {
3045 alt_cfi[group_off] = insn->cfi;
3047 if (cficmp(alt_cfi[group_off], insn->cfi)) {
3048 WARN_FUNC("stack layout conflict in alternatives",
3049 insn->sec, insn->offset);
3057 static int handle_insn_ops(struct instruction *insn,
3058 struct instruction *next_insn,
3059 struct insn_state *state)
3061 struct stack_op *op;
3063 list_for_each_entry(op, &insn->stack_ops, list) {
3065 if (update_cfi_state(insn, next_insn, &state->cfi, op))
3068 if (!insn->alt_group)
3071 if (op->dest.type == OP_DEST_PUSHF) {
3072 if (!state->uaccess_stack) {
3073 state->uaccess_stack = 1;
3074 } else if (state->uaccess_stack >> 31) {
3075 WARN_FUNC("PUSHF stack exhausted",
3076 insn->sec, insn->offset);
3079 state->uaccess_stack <<= 1;
3080 state->uaccess_stack |= state->uaccess;
3083 if (op->src.type == OP_SRC_POPF) {
3084 if (state->uaccess_stack) {
3085 state->uaccess = state->uaccess_stack & 1;
3086 state->uaccess_stack >>= 1;
3087 if (state->uaccess_stack == 1)
3088 state->uaccess_stack = 0;
3096 static bool insn_cfi_match(struct instruction *insn, struct cfi_state *cfi2)
3098 struct cfi_state *cfi1 = insn->cfi;
3102 WARN("CFI missing");
3106 if (memcmp(&cfi1->cfa, &cfi2->cfa, sizeof(cfi1->cfa))) {
3108 WARN_FUNC("stack state mismatch: cfa1=%d%+d cfa2=%d%+d",
3109 insn->sec, insn->offset,
3110 cfi1->cfa.base, cfi1->cfa.offset,
3111 cfi2->cfa.base, cfi2->cfa.offset);
3113 } else if (memcmp(&cfi1->regs, &cfi2->regs, sizeof(cfi1->regs))) {
3114 for (i = 0; i < CFI_NUM_REGS; i++) {
3115 if (!memcmp(&cfi1->regs[i], &cfi2->regs[i],
3116 sizeof(struct cfi_reg)))
3119 WARN_FUNC("stack state mismatch: reg1[%d]=%d%+d reg2[%d]=%d%+d",
3120 insn->sec, insn->offset,
3121 i, cfi1->regs[i].base, cfi1->regs[i].offset,
3122 i, cfi2->regs[i].base, cfi2->regs[i].offset);
3126 } else if (cfi1->type != cfi2->type) {
3128 WARN_FUNC("stack state mismatch: type1=%d type2=%d",
3129 insn->sec, insn->offset, cfi1->type, cfi2->type);
3131 } else if (cfi1->drap != cfi2->drap ||
3132 (cfi1->drap && cfi1->drap_reg != cfi2->drap_reg) ||
3133 (cfi1->drap && cfi1->drap_offset != cfi2->drap_offset)) {
3135 WARN_FUNC("stack state mismatch: drap1=%d(%d,%d) drap2=%d(%d,%d)",
3136 insn->sec, insn->offset,
3137 cfi1->drap, cfi1->drap_reg, cfi1->drap_offset,
3138 cfi2->drap, cfi2->drap_reg, cfi2->drap_offset);
3146 static inline bool func_uaccess_safe(struct symbol *func)
3149 return func->uaccess_safe;
3154 static inline const char *call_dest_name(struct instruction *insn)
3156 static char pvname[19];
3160 if (insn->call_dest)
3161 return insn->call_dest->name;
3163 rel = insn_reloc(NULL, insn);
3164 if (rel && !strcmp(rel->sym->name, "pv_ops")) {
3165 idx = (rel->addend / sizeof(void *));
3166 snprintf(pvname, sizeof(pvname), "pv_ops[%d]", idx);
3173 static bool pv_call_dest(struct objtool_file *file, struct instruction *insn)
3175 struct symbol *target;
3179 rel = insn_reloc(file, insn);
3180 if (!rel || strcmp(rel->sym->name, "pv_ops"))
3183 idx = (arch_dest_reloc_offset(rel->addend) / sizeof(void *));
3185 if (file->pv_ops[idx].clean)
3188 file->pv_ops[idx].clean = true;
3190 list_for_each_entry(target, &file->pv_ops[idx].targets, pv_target) {
3191 if (!target->sec->noinstr) {
3192 WARN("pv_ops[%d]: %s", idx, target->name);
3193 file->pv_ops[idx].clean = false;
3197 return file->pv_ops[idx].clean;
3200 static inline bool noinstr_call_dest(struct objtool_file *file,
3201 struct instruction *insn,
3202 struct symbol *func)
3205 * We can't deal with indirect function calls at present;
3206 * assume they're instrumented.
3210 return pv_call_dest(file, insn);
3216 * If the symbol is from a noinstr section; we good.
3218 if (func->sec->noinstr)
3222 * The __ubsan_handle_*() calls are like WARN(), they only happen when
3223 * something 'BAD' happened. At the risk of taking the machine down,
3224 * let them proceed to get the message out.
3226 if (!strncmp(func->name, "__ubsan_handle_", 15))
3232 static int validate_call(struct objtool_file *file,
3233 struct instruction *insn,
3234 struct insn_state *state)
3236 if (state->noinstr && state->instr <= 0 &&
3237 !noinstr_call_dest(file, insn, insn->call_dest)) {
3238 WARN_FUNC("call to %s() leaves .noinstr.text section",
3239 insn->sec, insn->offset, call_dest_name(insn));
3243 if (state->uaccess && !func_uaccess_safe(insn->call_dest)) {
3244 WARN_FUNC("call to %s() with UACCESS enabled",
3245 insn->sec, insn->offset, call_dest_name(insn));
3250 WARN_FUNC("call to %s() with DF set",
3251 insn->sec, insn->offset, call_dest_name(insn));
3258 static int validate_sibling_call(struct objtool_file *file,
3259 struct instruction *insn,
3260 struct insn_state *state)
3262 if (has_modified_stack_frame(insn, state)) {
3263 WARN_FUNC("sibling call from callable instruction with modified stack frame",
3264 insn->sec, insn->offset);
3268 return validate_call(file, insn, state);
3271 static int validate_return(struct symbol *func, struct instruction *insn, struct insn_state *state)
3273 if (state->noinstr && state->instr > 0) {
3274 WARN_FUNC("return with instrumentation enabled",
3275 insn->sec, insn->offset);
3279 if (state->uaccess && !func_uaccess_safe(func)) {
3280 WARN_FUNC("return with UACCESS enabled",
3281 insn->sec, insn->offset);
3285 if (!state->uaccess && func_uaccess_safe(func)) {
3286 WARN_FUNC("return with UACCESS disabled from a UACCESS-safe function",
3287 insn->sec, insn->offset);
3292 WARN_FUNC("return with DF set",
3293 insn->sec, insn->offset);
3297 if (func && has_modified_stack_frame(insn, state)) {
3298 WARN_FUNC("return with modified stack frame",
3299 insn->sec, insn->offset);
3303 if (state->cfi.bp_scratch) {
3304 WARN_FUNC("BP used as a scratch register",
3305 insn->sec, insn->offset);
3312 static struct instruction *next_insn_to_validate(struct objtool_file *file,
3313 struct instruction *insn)
3315 struct alt_group *alt_group = insn->alt_group;
3318 * Simulate the fact that alternatives are patched in-place. When the
3319 * end of a replacement alt_group is reached, redirect objtool flow to
3320 * the end of the original alt_group.
3322 if (alt_group && insn == alt_group->last_insn && alt_group->orig_group)
3323 return next_insn_same_sec(file, alt_group->orig_group->last_insn);
3325 return next_insn_same_sec(file, insn);
3329 * Follow the branch starting at the given instruction, and recursively follow
3330 * any other branches (jumps). Meanwhile, track the frame pointer state at
3331 * each instruction and validate all the rules described in
3332 * tools/objtool/Documentation/objtool.txt.
3334 static int validate_branch(struct objtool_file *file, struct symbol *func,
3335 struct instruction *insn, struct insn_state state)
3337 struct alternative *alt;
3338 struct instruction *next_insn, *prev_insn = NULL;
3339 struct section *sec;
3346 next_insn = next_insn_to_validate(file, insn);
3348 if (func && insn->func && func != insn->func->pfunc) {
3349 /* Ignore KCFI type preambles, which always fall through */
3350 if (!strncmp(func->name, "__cfi_", 6))
3353 WARN("%s() falls through to next function %s()",
3354 func->name, insn->func->name);
3358 if (func && insn->ignore) {
3359 WARN_FUNC("BUG: why am I validating an ignored function?",
3364 visited = VISITED_BRANCH << state.uaccess;
3365 if (insn->visited & VISITED_BRANCH_MASK) {
3366 if (!insn->hint && !insn_cfi_match(insn, &state.cfi))
3369 if (insn->visited & visited)
3376 state.instr += insn->instr;
3379 if (insn->restore) {
3380 struct instruction *save_insn, *i;
3385 sym_for_each_insn_continue_reverse(file, func, i) {
3393 WARN_FUNC("no corresponding CFI save for CFI restore",
3398 if (!save_insn->visited) {
3399 WARN_FUNC("objtool isn't smart enough to handle this CFI save/restore combo",
3404 insn->cfi = save_insn->cfi;
3408 state.cfi = *insn->cfi;
3410 /* XXX track if we actually changed state.cfi */
3412 if (prev_insn && !cficmp(prev_insn->cfi, &state.cfi)) {
3413 insn->cfi = prev_insn->cfi;
3416 insn->cfi = cfi_hash_find_or_add(&state.cfi);
3420 insn->visited |= visited;
3422 if (propagate_alt_cfi(file, insn))
3425 if (!insn->ignore_alts && !list_empty(&insn->alts)) {
3426 bool skip_orig = false;
3428 list_for_each_entry(alt, &insn->alts, list) {
3432 ret = validate_branch(file, func, alt->insn, state);
3435 BT_FUNC("(alt)", insn);
3444 if (handle_insn_ops(insn, next_insn, &state))
3447 switch (insn->type) {
3450 return validate_return(func, insn, &state);
3453 case INSN_CALL_DYNAMIC:
3454 ret = validate_call(file, insn, &state);
3458 if (opts.stackval && func && !is_fentry_call(insn) &&
3459 !has_valid_stack_frame(&state)) {
3460 WARN_FUNC("call without frame pointer save/setup",
3470 case INSN_JUMP_CONDITIONAL:
3471 case INSN_JUMP_UNCONDITIONAL:
3472 if (is_sibling_call(insn)) {
3473 ret = validate_sibling_call(file, insn, &state);
3477 } else if (insn->jump_dest) {
3478 ret = validate_branch(file, func,
3479 insn->jump_dest, state);
3482 BT_FUNC("(branch)", insn);
3487 if (insn->type == INSN_JUMP_UNCONDITIONAL)
3492 case INSN_JUMP_DYNAMIC:
3493 case INSN_JUMP_DYNAMIC_CONDITIONAL:
3494 if (is_sibling_call(insn)) {
3495 ret = validate_sibling_call(file, insn, &state);
3500 if (insn->type == INSN_JUMP_DYNAMIC)
3505 case INSN_CONTEXT_SWITCH:
3506 if (func && (!next_insn || !next_insn->hint)) {
3507 WARN_FUNC("unsupported instruction in callable function",
3514 if (state.uaccess) {
3515 WARN_FUNC("recursive UACCESS enable", sec, insn->offset);
3519 state.uaccess = true;
3523 if (!state.uaccess && func) {
3524 WARN_FUNC("redundant UACCESS disable", sec, insn->offset);
3528 if (func_uaccess_safe(func) && !state.uaccess_stack) {
3529 WARN_FUNC("UACCESS-safe disables UACCESS", sec, insn->offset);
3533 state.uaccess = false;
3538 WARN_FUNC("recursive STD", sec, insn->offset);
3546 if (!state.df && func) {
3547 WARN_FUNC("redundant CLD", sec, insn->offset);
3562 if (state.cfi.cfa.base == CFI_UNDEFINED)
3564 WARN("%s: unexpected end of section", sec->name);
3575 static int validate_unwind_hints(struct objtool_file *file, struct section *sec)
3577 struct instruction *insn;
3578 struct insn_state state;
3579 int ret, warnings = 0;
3584 init_insn_state(file, &state, sec);
3587 insn = find_insn(file, sec, 0);
3591 insn = list_first_entry(&file->insn_list, typeof(*insn), list);
3594 while (&insn->list != &file->insn_list && (!sec || insn->sec == sec)) {
3595 if (insn->hint && !insn->visited && !insn->ignore) {
3596 ret = validate_branch(file, insn->func, insn, state);
3597 if (ret && opts.backtrace)
3598 BT_FUNC("<=== (hint)", insn);
3602 insn = list_next_entry(insn, list);
3609 * Validate rethunk entry constraint: must untrain RET before the first RET.
3611 * Follow every branch (intra-function) and ensure ANNOTATE_UNRET_END comes
3612 * before an actual RET instruction.
3614 static int validate_entry(struct objtool_file *file, struct instruction *insn)
3616 struct instruction *next, *dest;
3617 int ret, warnings = 0;
3620 next = next_insn_to_validate(file, insn);
3622 if (insn->visited & VISITED_ENTRY)
3625 insn->visited |= VISITED_ENTRY;
3627 if (!insn->ignore_alts && !list_empty(&insn->alts)) {
3628 struct alternative *alt;
3629 bool skip_orig = false;
3631 list_for_each_entry(alt, &insn->alts, list) {
3635 ret = validate_entry(file, alt->insn);
3638 BT_FUNC("(alt)", insn);
3647 switch (insn->type) {
3649 case INSN_CALL_DYNAMIC:
3650 case INSN_JUMP_DYNAMIC:
3651 case INSN_JUMP_DYNAMIC_CONDITIONAL:
3652 WARN_FUNC("early indirect call", insn->sec, insn->offset);
3655 case INSN_JUMP_UNCONDITIONAL:
3656 case INSN_JUMP_CONDITIONAL:
3657 if (!is_sibling_call(insn)) {
3658 if (!insn->jump_dest) {
3659 WARN_FUNC("unresolved jump target after linking?!?",
3660 insn->sec, insn->offset);
3663 ret = validate_entry(file, insn->jump_dest);
3665 if (opts.backtrace) {
3666 BT_FUNC("(branch%s)", insn,
3667 insn->type == INSN_JUMP_CONDITIONAL ? "-cond" : "");
3672 if (insn->type == INSN_JUMP_UNCONDITIONAL)
3680 dest = find_insn(file, insn->call_dest->sec,
3681 insn->call_dest->offset);
3683 WARN("Unresolved function after linking!?: %s",
3684 insn->call_dest->name);
3688 ret = validate_entry(file, dest);
3691 BT_FUNC("(call)", insn);
3695 * If a call returns without error, it must have seen UNTRAIN_RET.
3696 * Therefore any non-error return is a success.
3701 WARN_FUNC("RET before UNTRAIN", insn->sec, insn->offset);
3705 if (insn->retpoline_safe)
3714 WARN_FUNC("teh end!", insn->sec, insn->offset);
3724 * Validate that all branches starting at 'insn->entry' encounter UNRET_END
3727 static int validate_unret(struct objtool_file *file)
3729 struct instruction *insn;
3730 int ret, warnings = 0;
3732 for_each_insn(file, insn) {
3736 ret = validate_entry(file, insn);
3738 WARN_FUNC("Failed UNRET validation", insn->sec, insn->offset);
3747 static int validate_retpoline(struct objtool_file *file)
3749 struct instruction *insn;
3752 for_each_insn(file, insn) {
3753 if (insn->type != INSN_JUMP_DYNAMIC &&
3754 insn->type != INSN_CALL_DYNAMIC &&
3755 insn->type != INSN_RETURN)
3758 if (insn->retpoline_safe)
3762 * .init.text code is ran before userspace and thus doesn't
3763 * strictly need retpolines, except for modules which are
3764 * loaded late, they very much do need retpoline in their
3767 if (!strcmp(insn->sec->name, ".init.text") && !opts.module)
3770 if (insn->type == INSN_RETURN) {
3772 WARN_FUNC("'naked' return found in RETHUNK build",
3773 insn->sec, insn->offset);
3777 WARN_FUNC("indirect %s found in RETPOLINE build",
3778 insn->sec, insn->offset,
3779 insn->type == INSN_JUMP_DYNAMIC ? "jump" : "call");
3788 static bool is_kasan_insn(struct instruction *insn)
3790 return (insn->type == INSN_CALL &&
3791 !strcmp(insn->call_dest->name, "__asan_handle_no_return"));
3794 static bool is_ubsan_insn(struct instruction *insn)
3796 return (insn->type == INSN_CALL &&
3797 !strcmp(insn->call_dest->name,
3798 "__ubsan_handle_builtin_unreachable"));
3801 static bool ignore_unreachable_insn(struct objtool_file *file, struct instruction *insn)
3804 struct instruction *prev_insn;
3806 if (insn->ignore || insn->type == INSN_NOP || insn->type == INSN_TRAP)
3810 * Ignore alternative replacement instructions. This can happen
3811 * when a whitelisted function uses one of the ALTERNATIVE macros.
3813 if (!strcmp(insn->sec->name, ".altinstr_replacement") ||
3814 !strcmp(insn->sec->name, ".altinstr_aux"))
3818 * Whole archive runs might encounter dead code from weak symbols.
3819 * This is where the linker will have dropped the weak symbol in
3820 * favour of a regular symbol, but leaves the code in place.
3822 * In this case we'll find a piece of code (whole function) that is not
3823 * covered by a !section symbol. Ignore them.
3825 if (opts.link && !insn->func) {
3826 int size = find_symbol_hole_containing(insn->sec, insn->offset);
3827 unsigned long end = insn->offset + size;
3829 if (!size) /* not a hole */
3832 if (size < 0) /* hole until the end */
3835 sec_for_each_insn_continue(file, insn) {
3837 * If we reach a visited instruction at or before the
3838 * end of the hole, ignore the unreachable.
3843 if (insn->offset >= end)
3847 * If this hole jumps to a .cold function, mark it ignore too.
3849 if (insn->jump_dest && insn->jump_dest->func &&
3850 strstr(insn->jump_dest->func->name, ".cold")) {
3851 struct instruction *dest = insn->jump_dest;
3852 func_for_each_insn(file, dest->func, dest)
3853 dest->ignore = true;
3863 if (insn->func->static_call_tramp)
3867 * CONFIG_UBSAN_TRAP inserts a UD2 when it sees
3868 * __builtin_unreachable(). The BUG() macro has an unreachable() after
3869 * the UD2, which causes GCC's undefined trap logic to emit another UD2
3870 * (or occasionally a JMP to UD2).
3872 * It may also insert a UD2 after calling a __noreturn function.
3874 prev_insn = list_prev_entry(insn, list);
3875 if ((prev_insn->dead_end || dead_end_function(file, prev_insn->call_dest)) &&
3876 (insn->type == INSN_BUG ||
3877 (insn->type == INSN_JUMP_UNCONDITIONAL &&
3878 insn->jump_dest && insn->jump_dest->type == INSN_BUG)))
3882 * Check if this (or a subsequent) instruction is related to
3883 * CONFIG_UBSAN or CONFIG_KASAN.
3885 * End the search at 5 instructions to avoid going into the weeds.
3887 for (i = 0; i < 5; i++) {
3889 if (is_kasan_insn(insn) || is_ubsan_insn(insn))
3892 if (insn->type == INSN_JUMP_UNCONDITIONAL) {
3893 if (insn->jump_dest &&
3894 insn->jump_dest->func == insn->func) {
3895 insn = insn->jump_dest;
3902 if (insn->offset + insn->len >= insn->func->offset + insn->func->len)
3905 insn = list_next_entry(insn, list);
3911 static int validate_symbol(struct objtool_file *file, struct section *sec,
3912 struct symbol *sym, struct insn_state *state)
3914 struct instruction *insn;
3918 WARN("%s() is missing an ELF size annotation", sym->name);
3922 if (sym->pfunc != sym || sym->alias != sym)
3925 insn = find_insn(file, sec, sym->offset);
3926 if (!insn || insn->ignore || insn->visited)
3929 state->uaccess = sym->uaccess_safe;
3931 ret = validate_branch(file, insn->func, insn, *state);
3932 if (ret && opts.backtrace)
3933 BT_FUNC("<=== (sym)", insn);
3937 static int validate_section(struct objtool_file *file, struct section *sec)
3939 struct insn_state state;
3940 struct symbol *func;
3943 list_for_each_entry(func, &sec->symbol_list, list) {
3944 if (func->type != STT_FUNC)
3947 init_insn_state(file, &state, sec);
3948 set_func_state(&state.cfi);
3950 warnings += validate_symbol(file, sec, func, &state);
3956 static int validate_noinstr_sections(struct objtool_file *file)
3958 struct section *sec;
3961 sec = find_section_by_name(file->elf, ".noinstr.text");
3963 warnings += validate_section(file, sec);
3964 warnings += validate_unwind_hints(file, sec);
3967 sec = find_section_by_name(file->elf, ".entry.text");
3969 warnings += validate_section(file, sec);
3970 warnings += validate_unwind_hints(file, sec);
3976 static int validate_functions(struct objtool_file *file)
3978 struct section *sec;
3981 for_each_sec(file, sec) {
3982 if (!(sec->sh.sh_flags & SHF_EXECINSTR))
3985 warnings += validate_section(file, sec);
3991 static void mark_endbr_used(struct instruction *insn)
3993 if (!list_empty(&insn->call_node))
3994 list_del_init(&insn->call_node);
3997 static int validate_ibt_insn(struct objtool_file *file, struct instruction *insn)
3999 struct instruction *dest;
4000 struct reloc *reloc;
4005 * Looking for function pointer load relocations. Ignore
4006 * direct/indirect branches:
4008 switch (insn->type) {
4010 case INSN_CALL_DYNAMIC:
4011 case INSN_JUMP_CONDITIONAL:
4012 case INSN_JUMP_UNCONDITIONAL:
4013 case INSN_JUMP_DYNAMIC:
4014 case INSN_JUMP_DYNAMIC_CONDITIONAL:
4022 for (reloc = insn_reloc(file, insn);
4024 reloc = find_reloc_by_dest_range(file->elf, insn->sec,
4026 (insn->offset + insn->len) - (reloc->offset + 1))) {
4029 * static_call_update() references the trampoline, which
4030 * doesn't have (or need) ENDBR. Skip warning in that case.
4032 if (reloc->sym->static_call_tramp)
4035 off = reloc->sym->offset;
4036 if (reloc->type == R_X86_64_PC32 || reloc->type == R_X86_64_PLT32)
4037 off += arch_dest_reloc_offset(reloc->addend);
4039 off += reloc->addend;
4041 dest = find_insn(file, reloc->sym->sec, off);
4045 if (dest->type == INSN_ENDBR) {
4046 mark_endbr_used(dest);
4050 if (dest->func && dest->func == insn->func) {
4052 * Anything from->to self is either _THIS_IP_ or
4055 * There is no sane way to annotate _THIS_IP_ since the
4056 * compiler treats the relocation as a constant and is
4057 * happy to fold in offsets, skewing any annotation we
4058 * do, leading to vast amounts of false-positives.
4060 * There's also compiler generated _THIS_IP_ through
4061 * KCOV and such which we have no hope of annotating.
4063 * As such, blanket accept self-references without
4072 WARN_FUNC("relocation to !ENDBR: %s",
4073 insn->sec, insn->offset,
4074 offstr(dest->sec, dest->offset));
4082 static int validate_ibt_data_reloc(struct objtool_file *file,
4083 struct reloc *reloc)
4085 struct instruction *dest;
4087 dest = find_insn(file, reloc->sym->sec,
4088 reloc->sym->offset + reloc->addend);
4092 if (dest->type == INSN_ENDBR) {
4093 mark_endbr_used(dest);
4100 WARN_FUNC("data relocation to !ENDBR: %s",
4101 reloc->sec->base, reloc->offset,
4102 offstr(dest->sec, dest->offset));
4108 * Validate IBT rules and remove used ENDBR instructions from the seal list.
4109 * Unused ENDBR instructions will be annotated for sealing (i.e., replaced with
4110 * NOPs) later, in create_ibt_endbr_seal_sections().
4112 static int validate_ibt(struct objtool_file *file)
4114 struct section *sec;
4115 struct reloc *reloc;
4116 struct instruction *insn;
4119 for_each_insn(file, insn)
4120 warnings += validate_ibt_insn(file, insn);
4122 for_each_sec(file, sec) {
4124 /* Already done by validate_ibt_insn() */
4125 if (sec->sh.sh_flags & SHF_EXECINSTR)
4132 * These sections can reference text addresses, but not with
4133 * the intent to indirect branch to them.
4135 if ((!strncmp(sec->name, ".discard", 8) &&
4136 strcmp(sec->name, ".discard.ibt_endbr_noseal")) ||
4137 !strncmp(sec->name, ".debug", 6) ||
4138 !strcmp(sec->name, ".altinstructions") ||
4139 !strcmp(sec->name, ".ibt_endbr_seal") ||
4140 !strcmp(sec->name, ".orc_unwind_ip") ||
4141 !strcmp(sec->name, ".parainstructions") ||
4142 !strcmp(sec->name, ".retpoline_sites") ||
4143 !strcmp(sec->name, ".smp_locks") ||
4144 !strcmp(sec->name, ".static_call_sites") ||
4145 !strcmp(sec->name, "_error_injection_whitelist") ||
4146 !strcmp(sec->name, "_kprobe_blacklist") ||
4147 !strcmp(sec->name, "__bug_table") ||
4148 !strcmp(sec->name, "__ex_table") ||
4149 !strcmp(sec->name, "__jump_table") ||
4150 !strcmp(sec->name, "__mcount_loc") ||
4151 !strcmp(sec->name, ".kcfi_traps") ||
4152 strstr(sec->name, "__patchable_function_entries"))
4155 list_for_each_entry(reloc, &sec->reloc->reloc_list, list)
4156 warnings += validate_ibt_data_reloc(file, reloc);
4162 static int validate_sls(struct objtool_file *file)
4164 struct instruction *insn, *next_insn;
4167 for_each_insn(file, insn) {
4168 next_insn = next_insn_same_sec(file, insn);
4170 if (insn->retpoline_safe)
4173 switch (insn->type) {
4175 if (!next_insn || next_insn->type != INSN_TRAP) {
4176 WARN_FUNC("missing int3 after ret",
4177 insn->sec, insn->offset);
4182 case INSN_JUMP_DYNAMIC:
4183 if (!next_insn || next_insn->type != INSN_TRAP) {
4184 WARN_FUNC("missing int3 after indirect jump",
4185 insn->sec, insn->offset);
4197 static int validate_reachable_instructions(struct objtool_file *file)
4199 struct instruction *insn;
4201 if (file->ignore_unreachables)
4204 for_each_insn(file, insn) {
4205 if (insn->visited || ignore_unreachable_insn(file, insn))
4208 WARN_FUNC("unreachable instruction", insn->sec, insn->offset);
4215 int check(struct objtool_file *file)
4217 int ret, warnings = 0;
4219 arch_initial_func_cfi_state(&initial_func_cfi);
4220 init_cfi_state(&init_cfi);
4221 init_cfi_state(&func_cfi);
4222 set_func_state(&func_cfi);
4224 if (!cfi_hash_alloc(1UL << (file->elf->symbol_bits - 3)))
4227 cfi_hash_add(&init_cfi);
4228 cfi_hash_add(&func_cfi);
4230 ret = decode_sections(file);
4236 if (list_empty(&file->insn_list))
4239 if (opts.retpoline) {
4240 ret = validate_retpoline(file);
4246 if (opts.stackval || opts.orc || opts.uaccess) {
4247 ret = validate_functions(file);
4252 ret = validate_unwind_hints(file, NULL);
4258 ret = validate_reachable_instructions(file);
4264 } else if (opts.noinstr) {
4265 ret = validate_noinstr_sections(file);
4273 * Must be after validate_branch() and friends, it plays
4274 * further games with insn->visited.
4276 ret = validate_unret(file);
4283 ret = validate_ibt(file);
4290 ret = validate_sls(file);
4296 if (opts.static_call) {
4297 ret = create_static_call_sections(file);
4303 if (opts.retpoline) {
4304 ret = create_retpoline_sites_sections(file);
4311 ret = create_return_sites_sections(file);
4318 ret = create_mcount_loc_sections(file);
4325 ret = create_ibt_endbr_seal_sections(file);
4331 if (opts.orc && !list_empty(&file->insn_list)) {
4332 ret = orc_create(file);
4340 printf("nr_insns_visited: %ld\n", nr_insns_visited);
4341 printf("nr_cfi: %ld\n", nr_cfi);
4342 printf("nr_cfi_reused: %ld\n", nr_cfi_reused);
4343 printf("nr_cfi_cache: %ld\n", nr_cfi_cache);
4348 * For now, don't fail the kernel build on fatal warnings. These
4349 * errors are still fairly common due to the growing matrix of
4350 * supported toolchains and their recent pace of change.