1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Copyright (C) 2015-2017 Josh Poimboeuf <jpoimboe@redhat.com>
16 #include <linux/hashtable.h>
17 #include <linux/kernel.h>
19 #define FAKE_JUMP_OFFSET -1
21 #define C_JUMP_TABLE_SECTION ".rodata..c_jump_table"
24 struct list_head list;
25 struct instruction *insn;
30 struct cfi_state initial_func_cfi;
32 struct instruction *find_insn(struct objtool_file *file,
33 struct section *sec, unsigned long offset)
35 struct instruction *insn;
37 hash_for_each_possible(file->insn_hash, insn, hash, offset)
38 if (insn->sec == sec && insn->offset == offset)
44 static struct instruction *next_insn_same_sec(struct objtool_file *file,
45 struct instruction *insn)
47 struct instruction *next = list_next_entry(insn, list);
49 if (!next || &next->list == &file->insn_list || next->sec != insn->sec)
55 static struct instruction *next_insn_same_func(struct objtool_file *file,
56 struct instruction *insn)
58 struct instruction *next = list_next_entry(insn, list);
59 struct symbol *func = insn->func;
64 if (&next->list != &file->insn_list && next->func == func)
67 /* Check if we're already in the subfunction: */
68 if (func == func->cfunc)
71 /* Move to the subfunction: */
72 return find_insn(file, func->cfunc->sec, func->cfunc->offset);
75 #define func_for_each_insn_all(file, func, insn) \
76 for (insn = find_insn(file, func->sec, func->offset); \
78 insn = next_insn_same_func(file, insn))
80 #define func_for_each_insn(file, func, insn) \
81 for (insn = find_insn(file, func->sec, func->offset); \
82 insn && &insn->list != &file->insn_list && \
83 insn->sec == func->sec && \
84 insn->offset < func->offset + func->len; \
85 insn = list_next_entry(insn, list))
87 #define func_for_each_insn_continue_reverse(file, func, insn) \
88 for (insn = list_prev_entry(insn, list); \
89 &insn->list != &file->insn_list && \
90 insn->sec == func->sec && insn->offset >= func->offset; \
91 insn = list_prev_entry(insn, list))
93 #define sec_for_each_insn_from(file, insn) \
94 for (; insn; insn = next_insn_same_sec(file, insn))
96 #define sec_for_each_insn_continue(file, insn) \
97 for (insn = next_insn_same_sec(file, insn); insn; \
98 insn = next_insn_same_sec(file, insn))
101 * This checks to see if the given function is a "noreturn" function.
103 * For global functions which are outside the scope of this object file, we
104 * have to keep a manual list of them.
106 * For local functions, we have to detect them manually by simply looking for
107 * the lack of a return instruction.
114 static int __dead_end_function(struct objtool_file *file, struct symbol *func,
118 struct instruction *insn;
122 * Unfortunately these have to be hard coded because the noreturn
123 * attribute isn't provided in ELF data.
125 static const char * const global_noreturns[] = {
130 "__module_put_and_exit",
132 "kvm_spurious_fault",
137 "machine_real_restart",
138 "rewind_stack_do_exit",
141 if (func->bind == STB_WEAK)
144 if (func->bind == STB_GLOBAL)
145 for (i = 0; i < ARRAY_SIZE(global_noreturns); i++)
146 if (!strcmp(func->name, global_noreturns[i]))
152 insn = find_insn(file, func->sec, func->offset);
156 func_for_each_insn_all(file, func, insn) {
159 if (insn->type == INSN_RETURN)
167 * A function can have a sibling call instead of a return. In that
168 * case, the function's dead-end status depends on whether the target
169 * of the sibling call returns.
171 func_for_each_insn_all(file, func, insn) {
172 if (insn->type == INSN_JUMP_UNCONDITIONAL) {
173 struct instruction *dest = insn->jump_dest;
176 /* sibling call to another file */
179 if (dest->func && dest->func->pfunc != insn->func->pfunc) {
181 /* local sibling call */
182 if (recursion == 5) {
184 * Infinite recursion: two functions
185 * have sibling calls to each other.
186 * This is a very rare case. It means
187 * they aren't dead ends.
192 return __dead_end_function(file, dest->func,
197 if (insn->type == INSN_JUMP_DYNAMIC && list_empty(&insn->alts))
205 static int dead_end_function(struct objtool_file *file, struct symbol *func)
207 return __dead_end_function(file, func, 0);
210 static void clear_insn_state(struct insn_state *state)
214 memset(state, 0, sizeof(*state));
215 state->cfa.base = CFI_UNDEFINED;
216 for (i = 0; i < CFI_NUM_REGS; i++) {
217 state->regs[i].base = CFI_UNDEFINED;
218 state->vals[i].base = CFI_UNDEFINED;
220 state->drap_reg = CFI_UNDEFINED;
221 state->drap_offset = -1;
225 * Call the arch-specific instruction decoder for all the instructions and add
226 * them to the global instruction list.
228 static int decode_instructions(struct objtool_file *file)
232 unsigned long offset;
233 struct instruction *insn;
236 for_each_sec(file, sec) {
238 if (!(sec->sh.sh_flags & SHF_EXECINSTR))
241 if (strcmp(sec->name, ".altinstr_replacement") &&
242 strcmp(sec->name, ".altinstr_aux") &&
243 strncmp(sec->name, ".discard.", 9))
246 for (offset = 0; offset < sec->len; offset += insn->len) {
247 insn = malloc(sizeof(*insn));
249 WARN("malloc failed");
252 memset(insn, 0, sizeof(*insn));
253 INIT_LIST_HEAD(&insn->alts);
254 clear_insn_state(&insn->state);
257 insn->offset = offset;
259 ret = arch_decode_instruction(file->elf, sec, offset,
261 &insn->len, &insn->type,
267 if (!insn->type || insn->type > INSN_LAST) {
268 WARN_FUNC("invalid instruction type %d",
269 insn->sec, insn->offset, insn->type);
274 hash_add(file->insn_hash, &insn->hash, insn->offset);
275 list_add_tail(&insn->list, &file->insn_list);
278 list_for_each_entry(func, &sec->symbol_list, list) {
279 if (func->type != STT_FUNC)
282 if (!find_insn(file, sec, func->offset)) {
283 WARN("%s(): can't find starting instruction",
288 func_for_each_insn(file, func, insn)
302 * Mark "ud2" instructions and manually annotated dead ends.
304 static int add_dead_ends(struct objtool_file *file)
308 struct instruction *insn;
312 * By default, "ud2" is a dead end unless otherwise annotated, because
313 * GCC 7 inserts it for certain divide-by-zero cases.
315 for_each_insn(file, insn)
316 if (insn->type == INSN_BUG)
317 insn->dead_end = true;
320 * Check for manually annotated dead ends.
322 sec = find_section_by_name(file->elf, ".rela.discard.unreachable");
326 list_for_each_entry(rela, &sec->rela_list, list) {
327 if (rela->sym->type != STT_SECTION) {
328 WARN("unexpected relocation symbol type in %s", sec->name);
331 insn = find_insn(file, rela->sym->sec, rela->addend);
333 insn = list_prev_entry(insn, list);
334 else if (rela->addend == rela->sym->sec->len) {
336 list_for_each_entry_reverse(insn, &file->insn_list, list) {
337 if (insn->sec == rela->sym->sec) {
344 WARN("can't find unreachable insn at %s+0x%x",
345 rela->sym->sec->name, rela->addend);
349 WARN("can't find unreachable insn at %s+0x%x",
350 rela->sym->sec->name, rela->addend);
354 insn->dead_end = true;
359 * These manually annotated reachable checks are needed for GCC 4.4,
360 * where the Linux unreachable() macro isn't supported. In that case
361 * GCC doesn't know the "ud2" is fatal, so it generates code as if it's
364 sec = find_section_by_name(file->elf, ".rela.discard.reachable");
368 list_for_each_entry(rela, &sec->rela_list, list) {
369 if (rela->sym->type != STT_SECTION) {
370 WARN("unexpected relocation symbol type in %s", sec->name);
373 insn = find_insn(file, rela->sym->sec, rela->addend);
375 insn = list_prev_entry(insn, list);
376 else if (rela->addend == rela->sym->sec->len) {
378 list_for_each_entry_reverse(insn, &file->insn_list, list) {
379 if (insn->sec == rela->sym->sec) {
386 WARN("can't find reachable insn at %s+0x%x",
387 rela->sym->sec->name, rela->addend);
391 WARN("can't find reachable insn at %s+0x%x",
392 rela->sym->sec->name, rela->addend);
396 insn->dead_end = false;
403 * Warnings shouldn't be reported for ignored functions.
405 static void add_ignores(struct objtool_file *file)
407 struct instruction *insn;
412 sec = find_section_by_name(file->elf, ".rela.discard.func_stack_frame_non_standard");
416 list_for_each_entry(rela, &sec->rela_list, list) {
417 switch (rela->sym->type) {
423 func = find_symbol_by_offset(rela->sym->sec, rela->addend);
424 if (!func || func->type != STT_FUNC)
429 WARN("unexpected relocation symbol type in %s: %d", sec->name, rela->sym->type);
433 func_for_each_insn_all(file, func, insn)
439 * This is a whitelist of functions that is allowed to be called with AC set.
440 * The list is meant to be minimal and only contains compiler instrumentation
441 * ABI and a few functions used to implement *_{to,from}_user() functions.
443 * These functions must not directly change AC, but may PUSHF/POPF.
445 static const char *uaccess_safe_builtin[] = {
448 "check_memory_region",
449 /* KASAN out-of-line */
450 "__asan_loadN_noabort",
451 "__asan_load1_noabort",
452 "__asan_load2_noabort",
453 "__asan_load4_noabort",
454 "__asan_load8_noabort",
455 "__asan_load16_noabort",
456 "__asan_storeN_noabort",
457 "__asan_store1_noabort",
458 "__asan_store2_noabort",
459 "__asan_store4_noabort",
460 "__asan_store8_noabort",
461 "__asan_store16_noabort",
463 "__asan_report_load_n_noabort",
464 "__asan_report_load1_noabort",
465 "__asan_report_load2_noabort",
466 "__asan_report_load4_noabort",
467 "__asan_report_load8_noabort",
468 "__asan_report_load16_noabort",
469 "__asan_report_store_n_noabort",
470 "__asan_report_store1_noabort",
471 "__asan_report_store2_noabort",
472 "__asan_report_store4_noabort",
473 "__asan_report_store8_noabort",
474 "__asan_report_store16_noabort",
477 "__sanitizer_cov_trace_pc",
478 "__sanitizer_cov_trace_const_cmp1",
479 "__sanitizer_cov_trace_const_cmp2",
480 "__sanitizer_cov_trace_const_cmp4",
481 "__sanitizer_cov_trace_const_cmp8",
482 "__sanitizer_cov_trace_cmp1",
483 "__sanitizer_cov_trace_cmp2",
484 "__sanitizer_cov_trace_cmp4",
485 "__sanitizer_cov_trace_cmp8",
487 "ubsan_type_mismatch_common",
488 "__ubsan_handle_type_mismatch",
489 "__ubsan_handle_type_mismatch_v1",
491 "csum_partial_copy_generic",
493 "ftrace_likely_update", /* CONFIG_TRACE_BRANCH_PROFILING */
497 static void add_uaccess_safe(struct objtool_file *file)
505 for (name = uaccess_safe_builtin; *name; name++) {
506 func = find_symbol_by_name(file->elf, *name);
510 func->alias->uaccess_safe = true;
515 * FIXME: For now, just ignore any alternatives which add retpolines. This is
516 * a temporary hack, as it doesn't allow ORC to unwind from inside a retpoline.
517 * But it at least allows objtool to understand the control flow *around* the
520 static int add_ignore_alternatives(struct objtool_file *file)
524 struct instruction *insn;
526 sec = find_section_by_name(file->elf, ".rela.discard.ignore_alts");
530 list_for_each_entry(rela, &sec->rela_list, list) {
531 if (rela->sym->type != STT_SECTION) {
532 WARN("unexpected relocation symbol type in %s", sec->name);
536 insn = find_insn(file, rela->sym->sec, rela->addend);
538 WARN("bad .discard.ignore_alts entry");
542 insn->ignore_alts = true;
549 * Find the destination instructions for all jumps.
551 static int add_jump_destinations(struct objtool_file *file)
553 struct instruction *insn;
555 struct section *dest_sec;
556 unsigned long dest_off;
558 for_each_insn(file, insn) {
559 if (insn->type != INSN_JUMP_CONDITIONAL &&
560 insn->type != INSN_JUMP_UNCONDITIONAL)
563 if (insn->ignore || insn->offset == FAKE_JUMP_OFFSET)
566 rela = find_rela_by_dest_range(insn->sec, insn->offset,
569 dest_sec = insn->sec;
570 dest_off = insn->offset + insn->len + insn->immediate;
571 } else if (rela->sym->type == STT_SECTION) {
572 dest_sec = rela->sym->sec;
573 dest_off = rela->addend + 4;
574 } else if (rela->sym->sec->idx) {
575 dest_sec = rela->sym->sec;
576 dest_off = rela->sym->sym.st_value + rela->addend + 4;
577 } else if (strstr(rela->sym->name, "_indirect_thunk_")) {
579 * Retpoline jumps are really dynamic jumps in
580 * disguise, so convert them accordingly.
582 insn->type = INSN_JUMP_DYNAMIC;
583 insn->retpoline_safe = true;
587 insn->call_dest = rela->sym;
588 insn->jump_dest = NULL;
592 insn->jump_dest = find_insn(file, dest_sec, dest_off);
593 if (!insn->jump_dest) {
596 * This is a special case where an alt instruction
597 * jumps past the end of the section. These are
598 * handled later in handle_group_alt().
600 if (!strcmp(insn->sec->name, ".altinstr_replacement"))
603 WARN_FUNC("can't find jump dest instruction at %s+0x%lx",
604 insn->sec, insn->offset, dest_sec->name,
610 * Cross-function jump.
612 if (insn->func && insn->jump_dest->func &&
613 insn->func != insn->jump_dest->func) {
616 * For GCC 8+, create parent/child links for any cold
617 * subfunctions. This is _mostly_ redundant with a
618 * similar initialization in read_symbols().
620 * If a function has aliases, we want the *first* such
621 * function in the symbol table to be the subfunction's
622 * parent. In that case we overwrite the
623 * initialization done in read_symbols().
625 * However this code can't completely replace the
626 * read_symbols() code because this doesn't detect the
627 * case where the parent function's only reference to a
628 * subfunction is through a switch table.
630 if (!strstr(insn->func->name, ".cold.") &&
631 strstr(insn->jump_dest->func->name, ".cold.")) {
632 insn->func->cfunc = insn->jump_dest->func;
633 insn->jump_dest->func->pfunc = insn->func;
635 } else if (insn->jump_dest->func->pfunc != insn->func->pfunc &&
636 insn->jump_dest->offset == insn->jump_dest->func->offset) {
639 insn->call_dest = insn->jump_dest->func;
640 insn->jump_dest = NULL;
649 * Find the destination instructions for all calls.
651 static int add_call_destinations(struct objtool_file *file)
653 struct instruction *insn;
654 unsigned long dest_off;
657 for_each_insn(file, insn) {
658 if (insn->type != INSN_CALL)
661 rela = find_rela_by_dest_range(insn->sec, insn->offset,
664 dest_off = insn->offset + insn->len + insn->immediate;
665 insn->call_dest = find_symbol_by_offset(insn->sec,
668 if (!insn->call_dest && !insn->ignore) {
669 WARN_FUNC("unsupported intra-function call",
670 insn->sec, insn->offset);
672 WARN("If this is a retpoline, please patch it in with alternatives and annotate it with ANNOTATE_NOSPEC_ALTERNATIVE.");
676 } else if (rela->sym->type == STT_SECTION) {
677 insn->call_dest = find_symbol_by_offset(rela->sym->sec,
679 if (!insn->call_dest ||
680 insn->call_dest->type != STT_FUNC) {
681 WARN_FUNC("can't find call dest symbol at %s+0x%x",
682 insn->sec, insn->offset,
683 rela->sym->sec->name,
688 insn->call_dest = rela->sym;
695 * The .alternatives section requires some extra special care, over and above
696 * what other special sections require:
698 * 1. Because alternatives are patched in-place, we need to insert a fake jump
699 * instruction at the end so that validate_branch() skips all the original
700 * replaced instructions when validating the new instruction path.
702 * 2. An added wrinkle is that the new instruction length might be zero. In
703 * that case the old instructions are replaced with noops. We simulate that
704 * by creating a fake jump as the only new instruction.
706 * 3. In some cases, the alternative section includes an instruction which
707 * conditionally jumps to the _end_ of the entry. We have to modify these
708 * jumps' destinations to point back to .text rather than the end of the
709 * entry in .altinstr_replacement.
711 static int handle_group_alt(struct objtool_file *file,
712 struct special_alt *special_alt,
713 struct instruction *orig_insn,
714 struct instruction **new_insn)
716 struct instruction *last_orig_insn, *last_new_insn, *insn, *fake_jump = NULL;
717 unsigned long dest_off;
719 last_orig_insn = NULL;
721 sec_for_each_insn_from(file, insn) {
722 if (insn->offset >= special_alt->orig_off + special_alt->orig_len)
725 insn->alt_group = true;
726 last_orig_insn = insn;
729 if (next_insn_same_sec(file, last_orig_insn)) {
730 fake_jump = malloc(sizeof(*fake_jump));
732 WARN("malloc failed");
735 memset(fake_jump, 0, sizeof(*fake_jump));
736 INIT_LIST_HEAD(&fake_jump->alts);
737 clear_insn_state(&fake_jump->state);
739 fake_jump->sec = special_alt->new_sec;
740 fake_jump->offset = FAKE_JUMP_OFFSET;
741 fake_jump->type = INSN_JUMP_UNCONDITIONAL;
742 fake_jump->jump_dest = list_next_entry(last_orig_insn, list);
743 fake_jump->func = orig_insn->func;
746 if (!special_alt->new_len) {
748 WARN("%s: empty alternative at end of section",
749 special_alt->orig_sec->name);
753 *new_insn = fake_jump;
757 last_new_insn = NULL;
759 sec_for_each_insn_from(file, insn) {
760 if (insn->offset >= special_alt->new_off + special_alt->new_len)
763 last_new_insn = insn;
765 insn->ignore = orig_insn->ignore_alts;
766 insn->func = orig_insn->func;
768 if (insn->type != INSN_JUMP_CONDITIONAL &&
769 insn->type != INSN_JUMP_UNCONDITIONAL)
772 if (!insn->immediate)
775 dest_off = insn->offset + insn->len + insn->immediate;
776 if (dest_off == special_alt->new_off + special_alt->new_len) {
778 WARN("%s: alternative jump to end of section",
779 special_alt->orig_sec->name);
782 insn->jump_dest = fake_jump;
785 if (!insn->jump_dest) {
786 WARN_FUNC("can't find alternative jump destination",
787 insn->sec, insn->offset);
792 if (!last_new_insn) {
793 WARN_FUNC("can't find last new alternative instruction",
794 special_alt->new_sec, special_alt->new_off);
799 list_add(&fake_jump->list, &last_new_insn->list);
805 * A jump table entry can either convert a nop to a jump or a jump to a nop.
806 * If the original instruction is a jump, make the alt entry an effective nop
807 * by just skipping the original instruction.
809 static int handle_jump_alt(struct objtool_file *file,
810 struct special_alt *special_alt,
811 struct instruction *orig_insn,
812 struct instruction **new_insn)
814 if (orig_insn->type == INSN_NOP)
817 if (orig_insn->type != INSN_JUMP_UNCONDITIONAL) {
818 WARN_FUNC("unsupported instruction at jump label",
819 orig_insn->sec, orig_insn->offset);
823 *new_insn = list_next_entry(orig_insn, list);
828 * Read all the special sections which have alternate instructions which can be
829 * patched in or redirected to at runtime. Each instruction having alternate
830 * instruction(s) has them added to its insn->alts list, which will be
831 * traversed in validate_branch().
833 static int add_special_section_alts(struct objtool_file *file)
835 struct list_head special_alts;
836 struct instruction *orig_insn, *new_insn;
837 struct special_alt *special_alt, *tmp;
838 struct alternative *alt;
841 ret = special_get_alts(file->elf, &special_alts);
845 list_for_each_entry_safe(special_alt, tmp, &special_alts, list) {
847 orig_insn = find_insn(file, special_alt->orig_sec,
848 special_alt->orig_off);
850 WARN_FUNC("special: can't find orig instruction",
851 special_alt->orig_sec, special_alt->orig_off);
857 if (!special_alt->group || special_alt->new_len) {
858 new_insn = find_insn(file, special_alt->new_sec,
859 special_alt->new_off);
861 WARN_FUNC("special: can't find new instruction",
862 special_alt->new_sec,
863 special_alt->new_off);
869 if (special_alt->group) {
870 ret = handle_group_alt(file, special_alt, orig_insn,
874 } else if (special_alt->jump_or_nop) {
875 ret = handle_jump_alt(file, special_alt, orig_insn,
881 alt = malloc(sizeof(*alt));
883 WARN("malloc failed");
888 alt->insn = new_insn;
889 alt->skip_orig = special_alt->skip_orig;
890 orig_insn->ignore_alts |= special_alt->skip_alt;
891 list_add_tail(&alt->list, &orig_insn->alts);
893 list_del(&special_alt->list);
901 static int add_switch_table(struct objtool_file *file, struct instruction *insn,
902 struct rela *table, struct rela *next_table)
904 struct rela *rela = table;
905 struct instruction *alt_insn;
906 struct alternative *alt;
907 struct symbol *pfunc = insn->func->pfunc;
908 unsigned int prev_offset = 0;
910 list_for_each_entry_from(rela, &table->rela_sec->rela_list, list) {
911 if (rela == next_table)
914 /* Make sure the switch table entries are consecutive: */
915 if (prev_offset && rela->offset != prev_offset + 8)
918 /* Detect function pointers from contiguous objects: */
919 if (rela->sym->sec == pfunc->sec &&
920 rela->addend == pfunc->offset)
923 alt_insn = find_insn(file, rela->sym->sec, rela->addend);
927 /* Make sure the jmp dest is in the function or subfunction: */
928 if (alt_insn->func->pfunc != pfunc)
931 alt = malloc(sizeof(*alt));
933 WARN("malloc failed");
937 alt->insn = alt_insn;
938 list_add_tail(&alt->list, &insn->alts);
939 prev_offset = rela->offset;
943 WARN_FUNC("can't find switch jump table",
944 insn->sec, insn->offset);
952 * find_switch_table() - Given a dynamic jump, find the switch jump table in
953 * .rodata associated with it.
955 * There are 3 basic patterns:
957 * 1. jmpq *[rodata addr](,%reg,8)
959 * This is the most common case by far. It jumps to an address in a simple
960 * jump table which is stored in .rodata.
962 * 2. jmpq *[rodata addr](%rip)
964 * This is caused by a rare GCC quirk, currently only seen in three driver
965 * functions in the kernel, only with certain obscure non-distro configs.
967 * As part of an optimization, GCC makes a copy of an existing switch jump
968 * table, modifies it, and then hard-codes the jump (albeit with an indirect
969 * jump) to use a single entry in the table. The rest of the jump table and
970 * some of its jump targets remain as dead code.
972 * In such a case we can just crudely ignore all unreachable instruction
973 * warnings for the entire object file. Ideally we would just ignore them
974 * for the function, but that would require redesigning the code quite a
975 * bit. And honestly that's just not worth doing: unreachable instruction
976 * warnings are of questionable value anyway, and this is such a rare issue.
978 * 3. mov [rodata addr],%reg1
979 * ... some instructions ...
980 * jmpq *(%reg1,%reg2,8)
982 * This is a fairly uncommon pattern which is new for GCC 6. As of this
983 * writing, there are 11 occurrences of it in the allmodconfig kernel.
985 * As of GCC 7 there are quite a few more of these and the 'in between' code
986 * is significant. Esp. with KASAN enabled some of the code between the mov
987 * and jmpq uses .rodata itself, which can confuse things.
989 * TODO: Once we have DWARF CFI and smarter instruction decoding logic,
990 * ensure the same register is used in the mov and jump instructions.
992 * NOTE: RETPOLINE made it harder still to decode dynamic jumps.
994 static struct rela *find_switch_table(struct objtool_file *file,
996 struct instruction *insn)
998 struct rela *text_rela, *rodata_rela;
999 struct instruction *orig_insn = insn;
1000 struct section *rodata_sec;
1001 unsigned long table_offset;
1004 * Backward search using the @first_jump_src links, these help avoid
1005 * much of the 'in between' code. Which avoids us getting confused by
1009 &insn->list != &file->insn_list &&
1010 insn->sec == func->sec &&
1011 insn->offset >= func->offset;
1013 insn = insn->first_jump_src ?: list_prev_entry(insn, list)) {
1015 if (insn != orig_insn && insn->type == INSN_JUMP_DYNAMIC)
1018 /* allow small jumps within the range */
1019 if (insn->type == INSN_JUMP_UNCONDITIONAL &&
1021 (insn->jump_dest->offset <= insn->offset ||
1022 insn->jump_dest->offset > orig_insn->offset))
1025 /* look for a relocation which references .rodata */
1026 text_rela = find_rela_by_dest_range(insn->sec, insn->offset,
1028 if (!text_rela || text_rela->sym->type != STT_SECTION ||
1029 !text_rela->sym->sec->rodata)
1032 table_offset = text_rela->addend;
1033 rodata_sec = text_rela->sym->sec;
1035 if (text_rela->type == R_X86_64_PC32)
1039 * Make sure the .rodata address isn't associated with a
1040 * symbol. GCC jump tables are anonymous data.
1042 * Also support C jump tables which are in the same format as
1043 * switch jump tables. For objtool to recognize them, they
1044 * need to be placed in the C_JUMP_TABLE_SECTION section. They
1045 * have symbols associated with them.
1047 if (find_symbol_containing(rodata_sec, table_offset) &&
1048 strcmp(rodata_sec->name, C_JUMP_TABLE_SECTION))
1051 rodata_rela = find_rela_by_dest(rodata_sec, table_offset);
1054 * Use of RIP-relative switch jumps is quite rare, and
1055 * indicates a rare GCC quirk/bug which can leave dead
1058 if (text_rela->type == R_X86_64_PC32)
1059 file->ignore_unreachables = true;
1069 static int add_func_switch_tables(struct objtool_file *file,
1070 struct symbol *func)
1072 struct instruction *insn, *last = NULL, *prev_jump = NULL;
1073 struct rela *rela, *prev_rela = NULL;
1076 func_for_each_insn_all(file, func, insn) {
1081 * Store back-pointers for unconditional forward jumps such
1082 * that find_switch_table() can back-track using those and
1083 * avoid some potentially confusing code.
1085 if (insn->type == INSN_JUMP_UNCONDITIONAL && insn->jump_dest &&
1086 insn->offset > last->offset &&
1087 insn->jump_dest->offset > insn->offset &&
1088 !insn->jump_dest->first_jump_src) {
1090 insn->jump_dest->first_jump_src = insn;
1091 last = insn->jump_dest;
1094 if (insn->type != INSN_JUMP_DYNAMIC)
1097 rela = find_switch_table(file, func, insn);
1102 * We found a switch table, but we don't know yet how big it
1103 * is. Don't add it until we reach the end of the function or
1104 * the beginning of another switch table in the same function.
1107 ret = add_switch_table(file, prev_jump, prev_rela, rela);
1117 ret = add_switch_table(file, prev_jump, prev_rela, NULL);
1126 * For some switch statements, gcc generates a jump table in the .rodata
1127 * section which contains a list of addresses within the function to jump to.
1128 * This finds these jump tables and adds them to the insn->alts lists.
1130 static int add_switch_table_alts(struct objtool_file *file)
1132 struct section *sec;
1133 struct symbol *func;
1139 for_each_sec(file, sec) {
1140 list_for_each_entry(func, &sec->symbol_list, list) {
1141 if (func->type != STT_FUNC)
1144 ret = add_func_switch_tables(file, func);
1153 static int read_unwind_hints(struct objtool_file *file)
1155 struct section *sec, *relasec;
1157 struct unwind_hint *hint;
1158 struct instruction *insn;
1159 struct cfi_reg *cfa;
1162 sec = find_section_by_name(file->elf, ".discard.unwind_hints");
1166 relasec = sec->rela;
1168 WARN("missing .rela.discard.unwind_hints section");
1172 if (sec->len % sizeof(struct unwind_hint)) {
1173 WARN("struct unwind_hint size mismatch");
1179 for (i = 0; i < sec->len / sizeof(struct unwind_hint); i++) {
1180 hint = (struct unwind_hint *)sec->data->d_buf + i;
1182 rela = find_rela_by_dest(sec, i * sizeof(*hint));
1184 WARN("can't find rela for unwind_hints[%d]", i);
1188 insn = find_insn(file, rela->sym->sec, rela->addend);
1190 WARN("can't find insn for unwind_hints[%d]", i);
1194 cfa = &insn->state.cfa;
1196 if (hint->type == UNWIND_HINT_TYPE_SAVE) {
1200 } else if (hint->type == UNWIND_HINT_TYPE_RESTORE) {
1201 insn->restore = true;
1208 switch (hint->sp_reg) {
1209 case ORC_REG_UNDEFINED:
1210 cfa->base = CFI_UNDEFINED;
1218 case ORC_REG_SP_INDIRECT:
1219 cfa->base = CFI_SP_INDIRECT;
1222 cfa->base = CFI_R10;
1225 cfa->base = CFI_R13;
1234 WARN_FUNC("unsupported unwind_hint sp base reg %d",
1235 insn->sec, insn->offset, hint->sp_reg);
1239 cfa->offset = hint->sp_offset;
1240 insn->state.type = hint->type;
1241 insn->state.end = hint->end;
1247 static int read_retpoline_hints(struct objtool_file *file)
1249 struct section *sec;
1250 struct instruction *insn;
1253 sec = find_section_by_name(file->elf, ".rela.discard.retpoline_safe");
1257 list_for_each_entry(rela, &sec->rela_list, list) {
1258 if (rela->sym->type != STT_SECTION) {
1259 WARN("unexpected relocation symbol type in %s", sec->name);
1263 insn = find_insn(file, rela->sym->sec, rela->addend);
1265 WARN("bad .discard.retpoline_safe entry");
1269 if (insn->type != INSN_JUMP_DYNAMIC &&
1270 insn->type != INSN_CALL_DYNAMIC) {
1271 WARN_FUNC("retpoline_safe hint not an indirect jump/call",
1272 insn->sec, insn->offset);
1276 insn->retpoline_safe = true;
1282 static void mark_rodata(struct objtool_file *file)
1284 struct section *sec;
1288 * Search for the following rodata sections, each of which can
1289 * potentially contain jump tables:
1291 * - .rodata: can contain GCC switch tables
1292 * - .rodata.<func>: same, if -fdata-sections is being used
1293 * - .rodata..c_jump_table: contains C annotated jump tables
1295 * .rodata.str1.* sections are ignored; they don't contain jump tables.
1297 for_each_sec(file, sec) {
1298 if ((!strncmp(sec->name, ".rodata", 7) && !strstr(sec->name, ".str1.")) ||
1299 !strcmp(sec->name, C_JUMP_TABLE_SECTION)) {
1305 file->rodata = found;
1308 static int decode_sections(struct objtool_file *file)
1314 ret = decode_instructions(file);
1318 ret = add_dead_ends(file);
1323 add_uaccess_safe(file);
1325 ret = add_ignore_alternatives(file);
1329 ret = add_jump_destinations(file);
1333 ret = add_special_section_alts(file);
1337 ret = add_call_destinations(file);
1341 ret = add_switch_table_alts(file);
1345 ret = read_unwind_hints(file);
1349 ret = read_retpoline_hints(file);
1356 static bool is_fentry_call(struct instruction *insn)
1358 if (insn->type == INSN_CALL &&
1359 insn->call_dest->type == STT_NOTYPE &&
1360 !strcmp(insn->call_dest->name, "__fentry__"))
1366 static bool has_modified_stack_frame(struct insn_state *state)
1370 if (state->cfa.base != initial_func_cfi.cfa.base ||
1371 state->cfa.offset != initial_func_cfi.cfa.offset ||
1372 state->stack_size != initial_func_cfi.cfa.offset ||
1376 for (i = 0; i < CFI_NUM_REGS; i++)
1377 if (state->regs[i].base != initial_func_cfi.regs[i].base ||
1378 state->regs[i].offset != initial_func_cfi.regs[i].offset)
1384 static bool has_valid_stack_frame(struct insn_state *state)
1386 if (state->cfa.base == CFI_BP && state->regs[CFI_BP].base == CFI_CFA &&
1387 state->regs[CFI_BP].offset == -16)
1390 if (state->drap && state->regs[CFI_BP].base == CFI_BP)
1396 static int update_insn_state_regs(struct instruction *insn, struct insn_state *state)
1398 struct cfi_reg *cfa = &state->cfa;
1399 struct stack_op *op = &insn->stack_op;
1401 if (cfa->base != CFI_SP)
1405 if (op->dest.type == OP_DEST_PUSH || op->dest.type == OP_DEST_PUSHF)
1409 if (op->src.type == OP_SRC_POP || op->src.type == OP_SRC_POPF)
1412 /* add immediate to sp */
1413 if (op->dest.type == OP_DEST_REG && op->src.type == OP_SRC_ADD &&
1414 op->dest.reg == CFI_SP && op->src.reg == CFI_SP)
1415 cfa->offset -= op->src.offset;
1420 static void save_reg(struct insn_state *state, unsigned char reg, int base,
1423 if (arch_callee_saved_reg(reg) &&
1424 state->regs[reg].base == CFI_UNDEFINED) {
1425 state->regs[reg].base = base;
1426 state->regs[reg].offset = offset;
1430 static void restore_reg(struct insn_state *state, unsigned char reg)
1432 state->regs[reg].base = CFI_UNDEFINED;
1433 state->regs[reg].offset = 0;
1437 * A note about DRAP stack alignment:
1439 * GCC has the concept of a DRAP register, which is used to help keep track of
1440 * the stack pointer when aligning the stack. r10 or r13 is used as the DRAP
1441 * register. The typical DRAP pattern is:
1443 * 4c 8d 54 24 08 lea 0x8(%rsp),%r10
1444 * 48 83 e4 c0 and $0xffffffffffffffc0,%rsp
1445 * 41 ff 72 f8 pushq -0x8(%r10)
1447 * 48 89 e5 mov %rsp,%rbp
1454 * 49 8d 62 f8 lea -0x8(%r10),%rsp
1457 * There are some variations in the epilogues, like:
1465 * 49 8d 62 f8 lea -0x8(%r10),%rsp
1470 * 4c 8b 55 e8 mov -0x18(%rbp),%r10
1471 * 48 8b 5d e0 mov -0x20(%rbp),%rbx
1472 * 4c 8b 65 f0 mov -0x10(%rbp),%r12
1473 * 4c 8b 6d f8 mov -0x8(%rbp),%r13
1475 * 49 8d 62 f8 lea -0x8(%r10),%rsp
1478 * Sometimes r13 is used as the DRAP register, in which case it's saved and
1479 * restored beforehand:
1482 * 4c 8d 6c 24 10 lea 0x10(%rsp),%r13
1483 * 48 83 e4 f0 and $0xfffffffffffffff0,%rsp
1485 * 49 8d 65 f0 lea -0x10(%r13),%rsp
1489 static int update_insn_state(struct instruction *insn, struct insn_state *state)
1491 struct stack_op *op = &insn->stack_op;
1492 struct cfi_reg *cfa = &state->cfa;
1493 struct cfi_reg *regs = state->regs;
1495 /* stack operations don't make sense with an undefined CFA */
1496 if (cfa->base == CFI_UNDEFINED) {
1498 WARN_FUNC("undefined stack state", insn->sec, insn->offset);
1504 if (state->type == ORC_TYPE_REGS || state->type == ORC_TYPE_REGS_IRET)
1505 return update_insn_state_regs(insn, state);
1507 switch (op->dest.type) {
1510 switch (op->src.type) {
1513 if (op->src.reg == CFI_SP && op->dest.reg == CFI_BP &&
1514 cfa->base == CFI_SP &&
1515 regs[CFI_BP].base == CFI_CFA &&
1516 regs[CFI_BP].offset == -cfa->offset) {
1518 /* mov %rsp, %rbp */
1519 cfa->base = op->dest.reg;
1520 state->bp_scratch = false;
1523 else if (op->src.reg == CFI_SP &&
1524 op->dest.reg == CFI_BP && state->drap) {
1526 /* drap: mov %rsp, %rbp */
1527 regs[CFI_BP].base = CFI_BP;
1528 regs[CFI_BP].offset = -state->stack_size;
1529 state->bp_scratch = false;
1532 else if (op->src.reg == CFI_SP && cfa->base == CFI_SP) {
1537 * This is needed for the rare case where GCC
1544 state->vals[op->dest.reg].base = CFI_CFA;
1545 state->vals[op->dest.reg].offset = -state->stack_size;
1548 else if (op->src.reg == CFI_BP && op->dest.reg == CFI_SP &&
1549 cfa->base == CFI_BP) {
1554 * Restore the original stack pointer (Clang).
1556 state->stack_size = -state->regs[CFI_BP].offset;
1559 else if (op->dest.reg == cfa->base) {
1561 /* mov %reg, %rsp */
1562 if (cfa->base == CFI_SP &&
1563 state->vals[op->src.reg].base == CFI_CFA) {
1566 * This is needed for the rare case
1567 * where GCC does something dumb like:
1569 * lea 0x8(%rsp), %rcx
1573 cfa->offset = -state->vals[op->src.reg].offset;
1574 state->stack_size = cfa->offset;
1577 cfa->base = CFI_UNDEFINED;
1585 if (op->dest.reg == CFI_SP && op->src.reg == CFI_SP) {
1588 state->stack_size -= op->src.offset;
1589 if (cfa->base == CFI_SP)
1590 cfa->offset -= op->src.offset;
1594 if (op->dest.reg == CFI_SP && op->src.reg == CFI_BP) {
1596 /* lea disp(%rbp), %rsp */
1597 state->stack_size = -(op->src.offset + regs[CFI_BP].offset);
1601 if (op->src.reg == CFI_SP && cfa->base == CFI_SP) {
1603 /* drap: lea disp(%rsp), %drap */
1604 state->drap_reg = op->dest.reg;
1607 * lea disp(%rsp), %reg
1609 * This is needed for the rare case where GCC
1610 * does something dumb like:
1612 * lea 0x8(%rsp), %rcx
1616 state->vals[op->dest.reg].base = CFI_CFA;
1617 state->vals[op->dest.reg].offset = \
1618 -state->stack_size + op->src.offset;
1623 if (state->drap && op->dest.reg == CFI_SP &&
1624 op->src.reg == state->drap_reg) {
1626 /* drap: lea disp(%drap), %rsp */
1628 cfa->offset = state->stack_size = -op->src.offset;
1629 state->drap_reg = CFI_UNDEFINED;
1630 state->drap = false;
1634 if (op->dest.reg == state->cfa.base) {
1635 WARN_FUNC("unsupported stack register modification",
1636 insn->sec, insn->offset);
1643 if (op->dest.reg != CFI_SP ||
1644 (state->drap_reg != CFI_UNDEFINED && cfa->base != CFI_SP) ||
1645 (state->drap_reg == CFI_UNDEFINED && cfa->base != CFI_BP)) {
1646 WARN_FUNC("unsupported stack pointer realignment",
1647 insn->sec, insn->offset);
1651 if (state->drap_reg != CFI_UNDEFINED) {
1652 /* drap: and imm, %rsp */
1653 cfa->base = state->drap_reg;
1654 cfa->offset = state->stack_size = 0;
1659 * Older versions of GCC (4.8ish) realign the stack
1660 * without DRAP, with a frame pointer.
1667 if (!state->drap && op->dest.type == OP_DEST_REG &&
1668 op->dest.reg == cfa->base) {
1674 if (state->drap && cfa->base == CFI_BP_INDIRECT &&
1675 op->dest.type == OP_DEST_REG &&
1676 op->dest.reg == state->drap_reg &&
1677 state->drap_offset == -state->stack_size) {
1679 /* drap: pop %drap */
1680 cfa->base = state->drap_reg;
1682 state->drap_offset = -1;
1684 } else if (regs[op->dest.reg].offset == -state->stack_size) {
1687 restore_reg(state, op->dest.reg);
1690 state->stack_size -= 8;
1691 if (cfa->base == CFI_SP)
1696 case OP_SRC_REG_INDIRECT:
1697 if (state->drap && op->src.reg == CFI_BP &&
1698 op->src.offset == state->drap_offset) {
1700 /* drap: mov disp(%rbp), %drap */
1701 cfa->base = state->drap_reg;
1703 state->drap_offset = -1;
1706 if (state->drap && op->src.reg == CFI_BP &&
1707 op->src.offset == regs[op->dest.reg].offset) {
1709 /* drap: mov disp(%rbp), %reg */
1710 restore_reg(state, op->dest.reg);
1712 } else if (op->src.reg == cfa->base &&
1713 op->src.offset == regs[op->dest.reg].offset + cfa->offset) {
1715 /* mov disp(%rbp), %reg */
1716 /* mov disp(%rsp), %reg */
1717 restore_reg(state, op->dest.reg);
1723 WARN_FUNC("unknown stack-related instruction",
1724 insn->sec, insn->offset);
1732 state->stack_size += 8;
1733 if (cfa->base == CFI_SP)
1736 if (op->src.type != OP_SRC_REG)
1740 if (op->src.reg == cfa->base && op->src.reg == state->drap_reg) {
1742 /* drap: push %drap */
1743 cfa->base = CFI_BP_INDIRECT;
1744 cfa->offset = -state->stack_size;
1746 /* save drap so we know when to restore it */
1747 state->drap_offset = -state->stack_size;
1749 } else if (op->src.reg == CFI_BP && cfa->base == state->drap_reg) {
1751 /* drap: push %rbp */
1752 state->stack_size = 0;
1754 } else if (regs[op->src.reg].base == CFI_UNDEFINED) {
1756 /* drap: push %reg */
1757 save_reg(state, op->src.reg, CFI_BP, -state->stack_size);
1763 save_reg(state, op->src.reg, CFI_CFA, -state->stack_size);
1766 /* detect when asm code uses rbp as a scratch register */
1767 if (!no_fp && insn->func && op->src.reg == CFI_BP &&
1768 cfa->base != CFI_BP)
1769 state->bp_scratch = true;
1772 case OP_DEST_REG_INDIRECT:
1775 if (op->src.reg == cfa->base && op->src.reg == state->drap_reg) {
1777 /* drap: mov %drap, disp(%rbp) */
1778 cfa->base = CFI_BP_INDIRECT;
1779 cfa->offset = op->dest.offset;
1781 /* save drap offset so we know when to restore it */
1782 state->drap_offset = op->dest.offset;
1785 else if (regs[op->src.reg].base == CFI_UNDEFINED) {
1787 /* drap: mov reg, disp(%rbp) */
1788 save_reg(state, op->src.reg, CFI_BP, op->dest.offset);
1791 } else if (op->dest.reg == cfa->base) {
1793 /* mov reg, disp(%rbp) */
1794 /* mov reg, disp(%rsp) */
1795 save_reg(state, op->src.reg, CFI_CFA,
1796 op->dest.offset - state->cfa.offset);
1802 if ((!state->drap && cfa->base != CFI_BP) ||
1803 (state->drap && cfa->base != state->drap_reg)) {
1804 WARN_FUNC("leave instruction with modified stack frame",
1805 insn->sec, insn->offset);
1809 /* leave (mov %rbp, %rsp; pop %rbp) */
1811 state->stack_size = -state->regs[CFI_BP].offset - 8;
1812 restore_reg(state, CFI_BP);
1822 if (op->src.type != OP_SRC_POP && op->src.type != OP_SRC_POPF) {
1823 WARN_FUNC("unknown stack-related memory operation",
1824 insn->sec, insn->offset);
1829 state->stack_size -= 8;
1830 if (cfa->base == CFI_SP)
1836 WARN_FUNC("unknown stack-related instruction",
1837 insn->sec, insn->offset);
1844 static bool insn_state_match(struct instruction *insn, struct insn_state *state)
1846 struct insn_state *state1 = &insn->state, *state2 = state;
1849 if (memcmp(&state1->cfa, &state2->cfa, sizeof(state1->cfa))) {
1850 WARN_FUNC("stack state mismatch: cfa1=%d%+d cfa2=%d%+d",
1851 insn->sec, insn->offset,
1852 state1->cfa.base, state1->cfa.offset,
1853 state2->cfa.base, state2->cfa.offset);
1855 } else if (memcmp(&state1->regs, &state2->regs, sizeof(state1->regs))) {
1856 for (i = 0; i < CFI_NUM_REGS; i++) {
1857 if (!memcmp(&state1->regs[i], &state2->regs[i],
1858 sizeof(struct cfi_reg)))
1861 WARN_FUNC("stack state mismatch: reg1[%d]=%d%+d reg2[%d]=%d%+d",
1862 insn->sec, insn->offset,
1863 i, state1->regs[i].base, state1->regs[i].offset,
1864 i, state2->regs[i].base, state2->regs[i].offset);
1868 } else if (state1->type != state2->type) {
1869 WARN_FUNC("stack state mismatch: type1=%d type2=%d",
1870 insn->sec, insn->offset, state1->type, state2->type);
1872 } else if (state1->drap != state2->drap ||
1873 (state1->drap && state1->drap_reg != state2->drap_reg) ||
1874 (state1->drap && state1->drap_offset != state2->drap_offset)) {
1875 WARN_FUNC("stack state mismatch: drap1=%d(%d,%d) drap2=%d(%d,%d)",
1876 insn->sec, insn->offset,
1877 state1->drap, state1->drap_reg, state1->drap_offset,
1878 state2->drap, state2->drap_reg, state2->drap_offset);
1886 static inline bool func_uaccess_safe(struct symbol *func)
1889 return func->alias->uaccess_safe;
1894 static inline const char *insn_dest_name(struct instruction *insn)
1896 if (insn->call_dest)
1897 return insn->call_dest->name;
1902 static int validate_call(struct instruction *insn, struct insn_state *state)
1904 if (state->uaccess && !func_uaccess_safe(insn->call_dest)) {
1905 WARN_FUNC("call to %s() with UACCESS enabled",
1906 insn->sec, insn->offset, insn_dest_name(insn));
1911 WARN_FUNC("call to %s() with DF set",
1912 insn->sec, insn->offset, insn_dest_name(insn));
1919 static int validate_sibling_call(struct instruction *insn, struct insn_state *state)
1921 if (has_modified_stack_frame(state)) {
1922 WARN_FUNC("sibling call from callable instruction with modified stack frame",
1923 insn->sec, insn->offset);
1927 return validate_call(insn, state);
1931 * Follow the branch starting at the given instruction, and recursively follow
1932 * any other branches (jumps). Meanwhile, track the frame pointer state at
1933 * each instruction and validate all the rules described in
1934 * tools/objtool/Documentation/stack-validation.txt.
1936 static int validate_branch(struct objtool_file *file, struct instruction *first,
1937 struct insn_state state)
1939 struct alternative *alt;
1940 struct instruction *insn, *next_insn;
1941 struct section *sec;
1942 struct symbol *func = NULL;
1948 if (insn->alt_group && list_empty(&insn->alts)) {
1949 WARN_FUNC("don't know how to handle branch to middle of alternative instruction group",
1955 next_insn = next_insn_same_sec(file, insn);
1957 if (file->c_file && func && insn->func && func != insn->func->pfunc) {
1958 WARN("%s() falls through to next function %s()",
1959 func->name, insn->func->name);
1964 func = insn->func->pfunc;
1966 if (func && insn->ignore) {
1967 WARN_FUNC("BUG: why am I validating an ignored function?",
1972 if (insn->visited) {
1973 if (!insn->hint && !insn_state_match(insn, &state))
1976 /* If we were here with AC=0, but now have AC=1, go again */
1977 if (insn->state.uaccess || !state.uaccess)
1982 if (insn->restore) {
1983 struct instruction *save_insn, *i;
1987 func_for_each_insn_continue_reverse(file, insn->func, i) {
1995 WARN_FUNC("no corresponding CFI save for CFI restore",
2000 if (!save_insn->visited) {
2002 * Oops, no state to copy yet.
2003 * Hopefully we can reach this
2004 * instruction from another branch
2005 * after the save insn has been
2011 WARN_FUNC("objtool isn't smart enough to handle this CFI save/restore combo",
2016 insn->state = save_insn->state;
2019 state = insn->state;
2022 insn->state = state;
2024 insn->visited = true;
2026 if (!insn->ignore_alts) {
2027 bool skip_orig = false;
2029 list_for_each_entry(alt, &insn->alts, list) {
2033 ret = validate_branch(file, alt->insn, state);
2036 BT_FUNC("(alt)", insn);
2045 switch (insn->type) {
2048 if (state.uaccess && !func_uaccess_safe(func)) {
2049 WARN_FUNC("return with UACCESS enabled", sec, insn->offset);
2053 if (!state.uaccess && func_uaccess_safe(func)) {
2054 WARN_FUNC("return with UACCESS disabled from a UACCESS-safe function", sec, insn->offset);
2059 WARN_FUNC("return with DF set", sec, insn->offset);
2063 if (func && has_modified_stack_frame(&state)) {
2064 WARN_FUNC("return with modified stack frame",
2069 if (state.bp_scratch) {
2070 WARN("%s uses BP as a scratch register",
2078 case INSN_CALL_DYNAMIC:
2079 ret = validate_call(insn, &state);
2083 if (insn->type == INSN_CALL) {
2084 if (is_fentry_call(insn))
2087 ret = dead_end_function(file, insn->call_dest);
2094 if (!no_fp && func && !has_valid_stack_frame(&state)) {
2095 WARN_FUNC("call without frame pointer save/setup",
2101 case INSN_JUMP_CONDITIONAL:
2102 case INSN_JUMP_UNCONDITIONAL:
2103 if (func && !insn->jump_dest) {
2104 ret = validate_sibling_call(insn, &state);
2108 } else if (insn->jump_dest &&
2109 (!func || !insn->jump_dest->func ||
2110 insn->jump_dest->func->pfunc == func)) {
2111 ret = validate_branch(file, insn->jump_dest,
2115 BT_FUNC("(branch)", insn);
2120 if (insn->type == INSN_JUMP_UNCONDITIONAL)
2125 case INSN_JUMP_DYNAMIC:
2126 if (func && list_empty(&insn->alts)) {
2127 ret = validate_sibling_call(insn, &state);
2134 case INSN_CONTEXT_SWITCH:
2135 if (func && (!next_insn || !next_insn->hint)) {
2136 WARN_FUNC("unsupported instruction in callable function",
2143 if (update_insn_state(insn, &state))
2146 if (insn->stack_op.dest.type == OP_DEST_PUSHF) {
2147 if (!state.uaccess_stack) {
2148 state.uaccess_stack = 1;
2149 } else if (state.uaccess_stack >> 31) {
2150 WARN_FUNC("PUSHF stack exhausted", sec, insn->offset);
2153 state.uaccess_stack <<= 1;
2154 state.uaccess_stack |= state.uaccess;
2157 if (insn->stack_op.src.type == OP_SRC_POPF) {
2158 if (state.uaccess_stack) {
2159 state.uaccess = state.uaccess_stack & 1;
2160 state.uaccess_stack >>= 1;
2161 if (state.uaccess_stack == 1)
2162 state.uaccess_stack = 0;
2169 if (state.uaccess) {
2170 WARN_FUNC("recursive UACCESS enable", sec, insn->offset);
2174 state.uaccess = true;
2178 if (!state.uaccess && insn->func) {
2179 WARN_FUNC("redundant UACCESS disable", sec, insn->offset);
2183 if (func_uaccess_safe(func) && !state.uaccess_stack) {
2184 WARN_FUNC("UACCESS-safe disables UACCESS", sec, insn->offset);
2188 state.uaccess = false;
2193 WARN_FUNC("recursive STD", sec, insn->offset);
2199 if (!state.df && insn->func)
2200 WARN_FUNC("redundant CLD", sec, insn->offset);
2213 if (state.cfa.base == CFI_UNDEFINED)
2215 WARN("%s: unexpected end of section", sec->name);
2225 static int validate_unwind_hints(struct objtool_file *file)
2227 struct instruction *insn;
2228 int ret, warnings = 0;
2229 struct insn_state state;
2234 clear_insn_state(&state);
2236 for_each_insn(file, insn) {
2237 if (insn->hint && !insn->visited) {
2238 ret = validate_branch(file, insn, state);
2239 if (ret && backtrace)
2240 BT_FUNC("<=== (hint)", insn);
2248 static int validate_retpoline(struct objtool_file *file)
2250 struct instruction *insn;
2253 for_each_insn(file, insn) {
2254 if (insn->type != INSN_JUMP_DYNAMIC &&
2255 insn->type != INSN_CALL_DYNAMIC)
2258 if (insn->retpoline_safe)
2262 * .init.text code is ran before userspace and thus doesn't
2263 * strictly need retpolines, except for modules which are
2264 * loaded late, they very much do need retpoline in their
2267 if (!strcmp(insn->sec->name, ".init.text") && !module)
2270 WARN_FUNC("indirect %s found in RETPOLINE build",
2271 insn->sec, insn->offset,
2272 insn->type == INSN_JUMP_DYNAMIC ? "jump" : "call");
2280 static bool is_kasan_insn(struct instruction *insn)
2282 return (insn->type == INSN_CALL &&
2283 !strcmp(insn->call_dest->name, "__asan_handle_no_return"));
2286 static bool is_ubsan_insn(struct instruction *insn)
2288 return (insn->type == INSN_CALL &&
2289 !strcmp(insn->call_dest->name,
2290 "__ubsan_handle_builtin_unreachable"));
2293 static bool ignore_unreachable_insn(struct instruction *insn)
2297 if (insn->ignore || insn->type == INSN_NOP)
2301 * Ignore any unused exceptions. This can happen when a whitelisted
2302 * function has an exception table entry.
2304 * Also ignore alternative replacement instructions. This can happen
2305 * when a whitelisted function uses one of the ALTERNATIVE macros.
2307 if (!strcmp(insn->sec->name, ".fixup") ||
2308 !strcmp(insn->sec->name, ".altinstr_replacement") ||
2309 !strcmp(insn->sec->name, ".altinstr_aux"))
2313 * Check if this (or a subsequent) instruction is related to
2314 * CONFIG_UBSAN or CONFIG_KASAN.
2316 * End the search at 5 instructions to avoid going into the weeds.
2320 for (i = 0; i < 5; i++) {
2322 if (is_kasan_insn(insn) || is_ubsan_insn(insn))
2325 if (insn->type == INSN_JUMP_UNCONDITIONAL) {
2326 if (insn->jump_dest &&
2327 insn->jump_dest->func == insn->func) {
2328 insn = insn->jump_dest;
2335 if (insn->offset + insn->len >= insn->func->offset + insn->func->len)
2338 insn = list_next_entry(insn, list);
2344 static int validate_functions(struct objtool_file *file)
2346 struct section *sec;
2347 struct symbol *func;
2348 struct instruction *insn;
2349 struct insn_state state;
2350 int ret, warnings = 0;
2352 clear_insn_state(&state);
2354 state.cfa = initial_func_cfi.cfa;
2355 memcpy(&state.regs, &initial_func_cfi.regs,
2356 CFI_NUM_REGS * sizeof(struct cfi_reg));
2357 state.stack_size = initial_func_cfi.cfa.offset;
2359 for_each_sec(file, sec) {
2360 list_for_each_entry(func, &sec->symbol_list, list) {
2361 if (func->type != STT_FUNC || func->pfunc != func)
2364 insn = find_insn(file, sec, func->offset);
2365 if (!insn || insn->ignore)
2368 state.uaccess = func->alias->uaccess_safe;
2370 ret = validate_branch(file, insn, state);
2371 if (ret && backtrace)
2372 BT_FUNC("<=== (func)", insn);
2380 static int validate_reachable_instructions(struct objtool_file *file)
2382 struct instruction *insn;
2384 if (file->ignore_unreachables)
2387 for_each_insn(file, insn) {
2388 if (insn->visited || ignore_unreachable_insn(insn))
2391 WARN_FUNC("unreachable instruction", insn->sec, insn->offset);
2398 static void cleanup(struct objtool_file *file)
2400 struct instruction *insn, *tmpinsn;
2401 struct alternative *alt, *tmpalt;
2403 list_for_each_entry_safe(insn, tmpinsn, &file->insn_list, list) {
2404 list_for_each_entry_safe(alt, tmpalt, &insn->alts, list) {
2405 list_del(&alt->list);
2408 list_del(&insn->list);
2409 hash_del(&insn->hash);
2412 elf_close(file->elf);
2415 static struct objtool_file file;
2417 int check(const char *_objname, bool orc)
2419 int ret, warnings = 0;
2423 file.elf = elf_read(objname, orc ? O_RDWR : O_RDONLY);
2427 INIT_LIST_HEAD(&file.insn_list);
2428 hash_init(file.insn_hash);
2429 file.c_file = find_section_by_name(file.elf, ".comment");
2430 file.ignore_unreachables = no_unreachable;
2433 arch_initial_func_cfi_state(&initial_func_cfi);
2435 ret = decode_sections(&file);
2440 if (list_empty(&file.insn_list))
2444 ret = validate_retpoline(&file);
2450 ret = validate_functions(&file);
2455 ret = validate_unwind_hints(&file);
2461 ret = validate_reachable_instructions(&file);
2468 ret = create_orc(&file);
2472 ret = create_orc_sections(&file);
2476 ret = elf_write(file.elf);
2484 /* ignore warnings for now until we get all the code cleaned up */
2485 if (ret || warnings)