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(file, func, insn) \
76 for (insn = find_insn(file, func->sec, func->offset); \
78 insn = next_insn_same_func(file, insn))
80 #define sym_for_each_insn(file, sym, insn) \
81 for (insn = find_insn(file, sym->sec, sym->offset); \
82 insn && &insn->list != &file->insn_list && \
83 insn->sec == sym->sec && \
84 insn->offset < sym->offset + sym->len; \
85 insn = list_next_entry(insn, list))
87 #define sym_for_each_insn_continue_reverse(file, sym, insn) \
88 for (insn = list_prev_entry(insn, list); \
89 &insn->list != &file->insn_list && \
90 insn->sec == sym->sec && insn->offset >= sym->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))
100 static bool is_static_jump(struct instruction *insn)
102 return insn->type == INSN_JUMP_CONDITIONAL ||
103 insn->type == INSN_JUMP_UNCONDITIONAL;
106 static bool is_sibling_call(struct instruction *insn)
108 /* An indirect jump is either a sibling call or a jump to a table. */
109 if (insn->type == INSN_JUMP_DYNAMIC)
110 return list_empty(&insn->alts);
112 if (!is_static_jump(insn))
115 /* add_jump_destinations() sets insn->call_dest for sibling calls. */
116 return !!insn->call_dest;
120 * This checks to see if the given function is a "noreturn" function.
122 * For global functions which are outside the scope of this object file, we
123 * have to keep a manual list of them.
125 * For local functions, we have to detect them manually by simply looking for
126 * the lack of a return instruction.
128 static bool __dead_end_function(struct objtool_file *file, struct symbol *func,
132 struct instruction *insn;
136 * Unfortunately these have to be hard coded because the noreturn
137 * attribute isn't provided in ELF data.
139 static const char * const global_noreturns[] = {
144 "__module_put_and_exit",
150 "machine_real_restart",
151 "rewind_stack_do_exit",
152 "kunit_try_catch_throw",
158 if (func->bind == STB_WEAK)
161 if (func->bind == STB_GLOBAL)
162 for (i = 0; i < ARRAY_SIZE(global_noreturns); i++)
163 if (!strcmp(func->name, global_noreturns[i]))
169 insn = find_insn(file, func->sec, func->offset);
173 func_for_each_insn(file, func, insn) {
176 if (insn->type == INSN_RETURN)
184 * A function can have a sibling call instead of a return. In that
185 * case, the function's dead-end status depends on whether the target
186 * of the sibling call returns.
188 func_for_each_insn(file, func, insn) {
189 if (is_sibling_call(insn)) {
190 struct instruction *dest = insn->jump_dest;
193 /* sibling call to another file */
196 /* local sibling call */
197 if (recursion == 5) {
199 * Infinite recursion: two functions have
200 * sibling calls to each other. This is a very
201 * rare case. It means they aren't dead ends.
206 return __dead_end_function(file, dest->func, recursion+1);
213 static bool dead_end_function(struct objtool_file *file, struct symbol *func)
215 return __dead_end_function(file, func, 0);
218 static void clear_insn_state(struct insn_state *state)
222 memset(state, 0, sizeof(*state));
223 state->cfa.base = CFI_UNDEFINED;
224 for (i = 0; i < CFI_NUM_REGS; i++) {
225 state->regs[i].base = CFI_UNDEFINED;
226 state->vals[i].base = CFI_UNDEFINED;
228 state->drap_reg = CFI_UNDEFINED;
229 state->drap_offset = -1;
233 * Call the arch-specific instruction decoder for all the instructions and add
234 * them to the global instruction list.
236 static int decode_instructions(struct objtool_file *file)
240 unsigned long offset;
241 struct instruction *insn;
242 unsigned long nr_insns = 0;
245 for_each_sec(file, sec) {
247 if (!(sec->sh.sh_flags & SHF_EXECINSTR))
250 if (strcmp(sec->name, ".altinstr_replacement") &&
251 strcmp(sec->name, ".altinstr_aux") &&
252 strncmp(sec->name, ".discard.", 9))
255 for (offset = 0; offset < sec->len; offset += insn->len) {
256 insn = malloc(sizeof(*insn));
258 WARN("malloc failed");
261 memset(insn, 0, sizeof(*insn));
262 INIT_LIST_HEAD(&insn->alts);
263 INIT_LIST_HEAD(&insn->stack_ops);
264 clear_insn_state(&insn->state);
267 insn->offset = offset;
269 ret = arch_decode_instruction(file->elf, sec, offset,
271 &insn->len, &insn->type,
277 hash_add(file->insn_hash, &insn->hash, insn->offset);
278 list_add_tail(&insn->list, &file->insn_list);
282 list_for_each_entry(func, &sec->symbol_list, list) {
283 if (func->type != STT_FUNC || func->alias != func)
286 if (!find_insn(file, sec, func->offset)) {
287 WARN("%s(): can't find starting instruction",
292 sym_for_each_insn(file, func, insn)
298 printf("nr_insns: %lu\n", nr_insns);
308 * Mark "ud2" instructions and manually annotated dead ends.
310 static int add_dead_ends(struct objtool_file *file)
314 struct instruction *insn;
318 * By default, "ud2" is a dead end unless otherwise annotated, because
319 * GCC 7 inserts it for certain divide-by-zero cases.
321 for_each_insn(file, insn)
322 if (insn->type == INSN_BUG)
323 insn->dead_end = true;
326 * Check for manually annotated dead ends.
328 sec = find_section_by_name(file->elf, ".rela.discard.unreachable");
332 list_for_each_entry(rela, &sec->rela_list, list) {
333 if (rela->sym->type != STT_SECTION) {
334 WARN("unexpected relocation symbol type in %s", sec->name);
337 insn = find_insn(file, rela->sym->sec, rela->addend);
339 insn = list_prev_entry(insn, list);
340 else if (rela->addend == rela->sym->sec->len) {
342 list_for_each_entry_reverse(insn, &file->insn_list, list) {
343 if (insn->sec == rela->sym->sec) {
350 WARN("can't find unreachable insn at %s+0x%x",
351 rela->sym->sec->name, rela->addend);
355 WARN("can't find unreachable insn at %s+0x%x",
356 rela->sym->sec->name, rela->addend);
360 insn->dead_end = true;
365 * These manually annotated reachable checks are needed for GCC 4.4,
366 * where the Linux unreachable() macro isn't supported. In that case
367 * GCC doesn't know the "ud2" is fatal, so it generates code as if it's
370 sec = find_section_by_name(file->elf, ".rela.discard.reachable");
374 list_for_each_entry(rela, &sec->rela_list, list) {
375 if (rela->sym->type != STT_SECTION) {
376 WARN("unexpected relocation symbol type in %s", sec->name);
379 insn = find_insn(file, rela->sym->sec, rela->addend);
381 insn = list_prev_entry(insn, list);
382 else if (rela->addend == rela->sym->sec->len) {
384 list_for_each_entry_reverse(insn, &file->insn_list, list) {
385 if (insn->sec == rela->sym->sec) {
392 WARN("can't find reachable insn at %s+0x%x",
393 rela->sym->sec->name, rela->addend);
397 WARN("can't find reachable insn at %s+0x%x",
398 rela->sym->sec->name, rela->addend);
402 insn->dead_end = false;
409 * Warnings shouldn't be reported for ignored functions.
411 static void add_ignores(struct objtool_file *file)
413 struct instruction *insn;
418 sec = find_section_by_name(file->elf, ".rela.discard.func_stack_frame_non_standard");
422 list_for_each_entry(rela, &sec->rela_list, list) {
423 switch (rela->sym->type) {
429 func = find_func_by_offset(rela->sym->sec, rela->addend);
435 WARN("unexpected relocation symbol type in %s: %d", sec->name, rela->sym->type);
439 func_for_each_insn(file, func, insn)
445 * This is a whitelist of functions that is allowed to be called with AC set.
446 * The list is meant to be minimal and only contains compiler instrumentation
447 * ABI and a few functions used to implement *_{to,from}_user() functions.
449 * These functions must not directly change AC, but may PUSHF/POPF.
451 static const char *uaccess_safe_builtin[] = {
454 "check_memory_region",
455 /* KASAN out-of-line */
456 "__asan_loadN_noabort",
457 "__asan_load1_noabort",
458 "__asan_load2_noabort",
459 "__asan_load4_noabort",
460 "__asan_load8_noabort",
461 "__asan_load16_noabort",
462 "__asan_storeN_noabort",
463 "__asan_store1_noabort",
464 "__asan_store2_noabort",
465 "__asan_store4_noabort",
466 "__asan_store8_noabort",
467 "__asan_store16_noabort",
469 "__asan_report_load_n_noabort",
470 "__asan_report_load1_noabort",
471 "__asan_report_load2_noabort",
472 "__asan_report_load4_noabort",
473 "__asan_report_load8_noabort",
474 "__asan_report_load16_noabort",
475 "__asan_report_store_n_noabort",
476 "__asan_report_store1_noabort",
477 "__asan_report_store2_noabort",
478 "__asan_report_store4_noabort",
479 "__asan_report_store8_noabort",
480 "__asan_report_store16_noabort",
483 "__sanitizer_cov_trace_pc",
484 "__sanitizer_cov_trace_const_cmp1",
485 "__sanitizer_cov_trace_const_cmp2",
486 "__sanitizer_cov_trace_const_cmp4",
487 "__sanitizer_cov_trace_const_cmp8",
488 "__sanitizer_cov_trace_cmp1",
489 "__sanitizer_cov_trace_cmp2",
490 "__sanitizer_cov_trace_cmp4",
491 "__sanitizer_cov_trace_cmp8",
492 "__sanitizer_cov_trace_switch",
494 "ubsan_type_mismatch_common",
495 "__ubsan_handle_type_mismatch",
496 "__ubsan_handle_type_mismatch_v1",
497 "__ubsan_handle_shift_out_of_bounds",
499 "csum_partial_copy_generic",
501 "mcsafe_handle_tail",
502 "ftrace_likely_update", /* CONFIG_TRACE_BRANCH_PROFILING */
506 static void add_uaccess_safe(struct objtool_file *file)
514 for (name = uaccess_safe_builtin; *name; name++) {
515 func = find_symbol_by_name(file->elf, *name);
519 func->uaccess_safe = true;
524 * FIXME: For now, just ignore any alternatives which add retpolines. This is
525 * a temporary hack, as it doesn't allow ORC to unwind from inside a retpoline.
526 * But it at least allows objtool to understand the control flow *around* the
529 static int add_ignore_alternatives(struct objtool_file *file)
533 struct instruction *insn;
535 sec = find_section_by_name(file->elf, ".rela.discard.ignore_alts");
539 list_for_each_entry(rela, &sec->rela_list, list) {
540 if (rela->sym->type != STT_SECTION) {
541 WARN("unexpected relocation symbol type in %s", sec->name);
545 insn = find_insn(file, rela->sym->sec, rela->addend);
547 WARN("bad .discard.ignore_alts entry");
551 insn->ignore_alts = true;
558 * Find the destination instructions for all jumps.
560 static int add_jump_destinations(struct objtool_file *file)
562 struct instruction *insn;
564 struct section *dest_sec;
565 unsigned long dest_off;
567 for_each_insn(file, insn) {
568 if (!is_static_jump(insn))
571 if (insn->ignore || insn->offset == FAKE_JUMP_OFFSET)
574 rela = find_rela_by_dest_range(file->elf, insn->sec,
575 insn->offset, insn->len);
577 dest_sec = insn->sec;
578 dest_off = arch_jump_destination(insn);
579 } else if (rela->sym->type == STT_SECTION) {
580 dest_sec = rela->sym->sec;
581 dest_off = arch_dest_rela_offset(rela->addend);
582 } else if (rela->sym->sec->idx) {
583 dest_sec = rela->sym->sec;
584 dest_off = rela->sym->sym.st_value +
585 arch_dest_rela_offset(rela->addend);
586 } else if (strstr(rela->sym->name, "_indirect_thunk_")) {
588 * Retpoline jumps are really dynamic jumps in
589 * disguise, so convert them accordingly.
591 if (insn->type == INSN_JUMP_UNCONDITIONAL)
592 insn->type = INSN_JUMP_DYNAMIC;
594 insn->type = INSN_JUMP_DYNAMIC_CONDITIONAL;
596 insn->retpoline_safe = true;
599 /* external sibling call */
600 insn->call_dest = rela->sym;
604 insn->jump_dest = find_insn(file, dest_sec, dest_off);
605 if (!insn->jump_dest) {
608 * This is a special case where an alt instruction
609 * jumps past the end of the section. These are
610 * handled later in handle_group_alt().
612 if (!strcmp(insn->sec->name, ".altinstr_replacement"))
615 WARN_FUNC("can't find jump dest instruction at %s+0x%lx",
616 insn->sec, insn->offset, dest_sec->name,
622 * Cross-function jump.
624 if (insn->func && insn->jump_dest->func &&
625 insn->func != insn->jump_dest->func) {
628 * For GCC 8+, create parent/child links for any cold
629 * subfunctions. This is _mostly_ redundant with a
630 * similar initialization in read_symbols().
632 * If a function has aliases, we want the *first* such
633 * function in the symbol table to be the subfunction's
634 * parent. In that case we overwrite the
635 * initialization done in read_symbols().
637 * However this code can't completely replace the
638 * read_symbols() code because this doesn't detect the
639 * case where the parent function's only reference to a
640 * subfunction is through a jump table.
642 if (!strstr(insn->func->name, ".cold.") &&
643 strstr(insn->jump_dest->func->name, ".cold.")) {
644 insn->func->cfunc = insn->jump_dest->func;
645 insn->jump_dest->func->pfunc = insn->func;
647 } else if (insn->jump_dest->func->pfunc != insn->func->pfunc &&
648 insn->jump_dest->offset == insn->jump_dest->func->offset) {
650 /* internal sibling call */
651 insn->call_dest = insn->jump_dest->func;
660 * Find the destination instructions for all calls.
662 static int add_call_destinations(struct objtool_file *file)
664 struct instruction *insn;
665 unsigned long dest_off;
668 for_each_insn(file, insn) {
669 if (insn->type != INSN_CALL)
672 rela = find_rela_by_dest_range(file->elf, insn->sec,
673 insn->offset, insn->len);
675 dest_off = arch_jump_destination(insn);
676 insn->call_dest = find_func_by_offset(insn->sec, dest_off);
677 if (!insn->call_dest)
678 insn->call_dest = find_symbol_by_offset(insn->sec, dest_off);
683 if (!insn->call_dest) {
684 WARN_FUNC("unsupported intra-function call",
685 insn->sec, insn->offset);
687 WARN("If this is a retpoline, please patch it in with alternatives and annotate it with ANNOTATE_NOSPEC_ALTERNATIVE.");
691 if (insn->func && insn->call_dest->type != STT_FUNC) {
692 WARN_FUNC("unsupported call to non-function",
693 insn->sec, insn->offset);
697 } else if (rela->sym->type == STT_SECTION) {
698 dest_off = arch_dest_rela_offset(rela->addend);
699 insn->call_dest = find_func_by_offset(rela->sym->sec,
701 if (!insn->call_dest) {
702 WARN_FUNC("can't find call dest symbol at %s+0x%lx",
703 insn->sec, insn->offset,
704 rela->sym->sec->name,
709 insn->call_dest = rela->sym;
716 * The .alternatives section requires some extra special care, over and above
717 * what other special sections require:
719 * 1. Because alternatives are patched in-place, we need to insert a fake jump
720 * instruction at the end so that validate_branch() skips all the original
721 * replaced instructions when validating the new instruction path.
723 * 2. An added wrinkle is that the new instruction length might be zero. In
724 * that case the old instructions are replaced with noops. We simulate that
725 * by creating a fake jump as the only new instruction.
727 * 3. In some cases, the alternative section includes an instruction which
728 * conditionally jumps to the _end_ of the entry. We have to modify these
729 * jumps' destinations to point back to .text rather than the end of the
730 * entry in .altinstr_replacement.
732 static int handle_group_alt(struct objtool_file *file,
733 struct special_alt *special_alt,
734 struct instruction *orig_insn,
735 struct instruction **new_insn)
737 struct instruction *last_orig_insn, *last_new_insn, *insn, *fake_jump = NULL;
738 unsigned long dest_off;
740 last_orig_insn = NULL;
742 sec_for_each_insn_from(file, insn) {
743 if (insn->offset >= special_alt->orig_off + special_alt->orig_len)
746 insn->alt_group = true;
747 last_orig_insn = insn;
750 if (next_insn_same_sec(file, last_orig_insn)) {
751 fake_jump = malloc(sizeof(*fake_jump));
753 WARN("malloc failed");
756 memset(fake_jump, 0, sizeof(*fake_jump));
757 INIT_LIST_HEAD(&fake_jump->alts);
758 INIT_LIST_HEAD(&fake_jump->stack_ops);
759 clear_insn_state(&fake_jump->state);
761 fake_jump->sec = special_alt->new_sec;
762 fake_jump->offset = FAKE_JUMP_OFFSET;
763 fake_jump->type = INSN_JUMP_UNCONDITIONAL;
764 fake_jump->jump_dest = list_next_entry(last_orig_insn, list);
765 fake_jump->func = orig_insn->func;
768 if (!special_alt->new_len) {
770 WARN("%s: empty alternative at end of section",
771 special_alt->orig_sec->name);
775 *new_insn = fake_jump;
779 last_new_insn = NULL;
781 sec_for_each_insn_from(file, insn) {
782 if (insn->offset >= special_alt->new_off + special_alt->new_len)
785 last_new_insn = insn;
787 insn->ignore = orig_insn->ignore_alts;
788 insn->func = orig_insn->func;
791 * Since alternative replacement code is copy/pasted by the
792 * kernel after applying relocations, generally such code can't
793 * have relative-address relocation references to outside the
794 * .altinstr_replacement section, unless the arch's
795 * alternatives code can adjust the relative offsets
798 * The x86 alternatives code adjusts the offsets only when it
799 * encounters a branch instruction at the very beginning of the
802 if ((insn->offset != special_alt->new_off ||
803 (insn->type != INSN_CALL && !is_static_jump(insn))) &&
804 find_rela_by_dest_range(file->elf, insn->sec, insn->offset, insn->len)) {
806 WARN_FUNC("unsupported relocation in alternatives section",
807 insn->sec, insn->offset);
811 if (!is_static_jump(insn))
814 if (!insn->immediate)
817 dest_off = arch_jump_destination(insn);
818 if (dest_off == special_alt->new_off + special_alt->new_len) {
820 WARN("%s: alternative jump to end of section",
821 special_alt->orig_sec->name);
824 insn->jump_dest = fake_jump;
827 if (!insn->jump_dest) {
828 WARN_FUNC("can't find alternative jump destination",
829 insn->sec, insn->offset);
834 if (!last_new_insn) {
835 WARN_FUNC("can't find last new alternative instruction",
836 special_alt->new_sec, special_alt->new_off);
841 list_add(&fake_jump->list, &last_new_insn->list);
847 * A jump table entry can either convert a nop to a jump or a jump to a nop.
848 * If the original instruction is a jump, make the alt entry an effective nop
849 * by just skipping the original instruction.
851 static int handle_jump_alt(struct objtool_file *file,
852 struct special_alt *special_alt,
853 struct instruction *orig_insn,
854 struct instruction **new_insn)
856 if (orig_insn->type == INSN_NOP)
859 if (orig_insn->type != INSN_JUMP_UNCONDITIONAL) {
860 WARN_FUNC("unsupported instruction at jump label",
861 orig_insn->sec, orig_insn->offset);
865 *new_insn = list_next_entry(orig_insn, list);
870 * Read all the special sections which have alternate instructions which can be
871 * patched in or redirected to at runtime. Each instruction having alternate
872 * instruction(s) has them added to its insn->alts list, which will be
873 * traversed in validate_branch().
875 static int add_special_section_alts(struct objtool_file *file)
877 struct list_head special_alts;
878 struct instruction *orig_insn, *new_insn;
879 struct special_alt *special_alt, *tmp;
880 struct alternative *alt;
883 ret = special_get_alts(file->elf, &special_alts);
887 list_for_each_entry_safe(special_alt, tmp, &special_alts, list) {
889 orig_insn = find_insn(file, special_alt->orig_sec,
890 special_alt->orig_off);
892 WARN_FUNC("special: can't find orig instruction",
893 special_alt->orig_sec, special_alt->orig_off);
899 if (!special_alt->group || special_alt->new_len) {
900 new_insn = find_insn(file, special_alt->new_sec,
901 special_alt->new_off);
903 WARN_FUNC("special: can't find new instruction",
904 special_alt->new_sec,
905 special_alt->new_off);
911 if (special_alt->group) {
912 if (!special_alt->orig_len) {
913 WARN_FUNC("empty alternative entry",
914 orig_insn->sec, orig_insn->offset);
918 ret = handle_group_alt(file, special_alt, orig_insn,
922 } else if (special_alt->jump_or_nop) {
923 ret = handle_jump_alt(file, special_alt, orig_insn,
929 alt = malloc(sizeof(*alt));
931 WARN("malloc failed");
936 alt->insn = new_insn;
937 alt->skip_orig = special_alt->skip_orig;
938 orig_insn->ignore_alts |= special_alt->skip_alt;
939 list_add_tail(&alt->list, &orig_insn->alts);
941 list_del(&special_alt->list);
949 static int add_jump_table(struct objtool_file *file, struct instruction *insn,
952 struct rela *rela = table;
953 struct instruction *dest_insn;
954 struct alternative *alt;
955 struct symbol *pfunc = insn->func->pfunc;
956 unsigned int prev_offset = 0;
959 * Each @rela is a switch table relocation which points to the target
962 list_for_each_entry_from(rela, &table->sec->rela_list, list) {
964 /* Check for the end of the table: */
965 if (rela != table && rela->jump_table_start)
968 /* Make sure the table entries are consecutive: */
969 if (prev_offset && rela->offset != prev_offset + 8)
972 /* Detect function pointers from contiguous objects: */
973 if (rela->sym->sec == pfunc->sec &&
974 rela->addend == pfunc->offset)
977 dest_insn = find_insn(file, rela->sym->sec, rela->addend);
981 /* Make sure the destination is in the same function: */
982 if (!dest_insn->func || dest_insn->func->pfunc != pfunc)
985 alt = malloc(sizeof(*alt));
987 WARN("malloc failed");
991 alt->insn = dest_insn;
992 list_add_tail(&alt->list, &insn->alts);
993 prev_offset = rela->offset;
997 WARN_FUNC("can't find switch jump table",
998 insn->sec, insn->offset);
1006 * find_jump_table() - Given a dynamic jump, find the switch jump table in
1007 * .rodata associated with it.
1009 * There are 3 basic patterns:
1011 * 1. jmpq *[rodata addr](,%reg,8)
1013 * This is the most common case by far. It jumps to an address in a simple
1014 * jump table which is stored in .rodata.
1016 * 2. jmpq *[rodata addr](%rip)
1018 * This is caused by a rare GCC quirk, currently only seen in three driver
1019 * functions in the kernel, only with certain obscure non-distro configs.
1021 * As part of an optimization, GCC makes a copy of an existing switch jump
1022 * table, modifies it, and then hard-codes the jump (albeit with an indirect
1023 * jump) to use a single entry in the table. The rest of the jump table and
1024 * some of its jump targets remain as dead code.
1026 * In such a case we can just crudely ignore all unreachable instruction
1027 * warnings for the entire object file. Ideally we would just ignore them
1028 * for the function, but that would require redesigning the code quite a
1029 * bit. And honestly that's just not worth doing: unreachable instruction
1030 * warnings are of questionable value anyway, and this is such a rare issue.
1032 * 3. mov [rodata addr],%reg1
1033 * ... some instructions ...
1034 * jmpq *(%reg1,%reg2,8)
1036 * This is a fairly uncommon pattern which is new for GCC 6. As of this
1037 * writing, there are 11 occurrences of it in the allmodconfig kernel.
1039 * As of GCC 7 there are quite a few more of these and the 'in between' code
1040 * is significant. Esp. with KASAN enabled some of the code between the mov
1041 * and jmpq uses .rodata itself, which can confuse things.
1043 * TODO: Once we have DWARF CFI and smarter instruction decoding logic,
1044 * ensure the same register is used in the mov and jump instructions.
1046 * NOTE: RETPOLINE made it harder still to decode dynamic jumps.
1048 static struct rela *find_jump_table(struct objtool_file *file,
1049 struct symbol *func,
1050 struct instruction *insn)
1052 struct rela *text_rela, *table_rela;
1053 struct instruction *dest_insn, *orig_insn = insn;
1054 struct section *table_sec;
1055 unsigned long table_offset;
1058 * Backward search using the @first_jump_src links, these help avoid
1059 * much of the 'in between' code. Which avoids us getting confused by
1063 &insn->list != &file->insn_list && insn->func && insn->func->pfunc == func;
1064 insn = insn->first_jump_src ?: list_prev_entry(insn, list)) {
1066 if (insn != orig_insn && insn->type == INSN_JUMP_DYNAMIC)
1069 /* allow small jumps within the range */
1070 if (insn->type == INSN_JUMP_UNCONDITIONAL &&
1072 (insn->jump_dest->offset <= insn->offset ||
1073 insn->jump_dest->offset > orig_insn->offset))
1076 /* look for a relocation which references .rodata */
1077 text_rela = find_rela_by_dest_range(file->elf, insn->sec,
1078 insn->offset, insn->len);
1079 if (!text_rela || text_rela->sym->type != STT_SECTION ||
1080 !text_rela->sym->sec->rodata)
1083 table_offset = text_rela->addend;
1084 table_sec = text_rela->sym->sec;
1086 if (text_rela->type == R_X86_64_PC32)
1090 * Make sure the .rodata address isn't associated with a
1091 * symbol. GCC jump tables are anonymous data.
1093 * Also support C jump tables which are in the same format as
1094 * switch jump tables. For objtool to recognize them, they
1095 * need to be placed in the C_JUMP_TABLE_SECTION section. They
1096 * have symbols associated with them.
1098 if (find_symbol_containing(table_sec, table_offset) &&
1099 strcmp(table_sec->name, C_JUMP_TABLE_SECTION))
1103 * Each table entry has a rela associated with it. The rela
1104 * should reference text in the same function as the original
1107 table_rela = find_rela_by_dest(file->elf, table_sec, table_offset);
1110 dest_insn = find_insn(file, table_rela->sym->sec, table_rela->addend);
1111 if (!dest_insn || !dest_insn->func || dest_insn->func->pfunc != func)
1115 * Use of RIP-relative switch jumps is quite rare, and
1116 * indicates a rare GCC quirk/bug which can leave dead code
1119 if (text_rela->type == R_X86_64_PC32)
1120 file->ignore_unreachables = true;
1129 * First pass: Mark the head of each jump table so that in the next pass,
1130 * we know when a given jump table ends and the next one starts.
1132 static void mark_func_jump_tables(struct objtool_file *file,
1133 struct symbol *func)
1135 struct instruction *insn, *last = NULL;
1138 func_for_each_insn(file, func, insn) {
1143 * Store back-pointers for unconditional forward jumps such
1144 * that find_jump_table() can back-track using those and
1145 * avoid some potentially confusing code.
1147 if (insn->type == INSN_JUMP_UNCONDITIONAL && insn->jump_dest &&
1148 insn->offset > last->offset &&
1149 insn->jump_dest->offset > insn->offset &&
1150 !insn->jump_dest->first_jump_src) {
1152 insn->jump_dest->first_jump_src = insn;
1153 last = insn->jump_dest;
1156 if (insn->type != INSN_JUMP_DYNAMIC)
1159 rela = find_jump_table(file, func, insn);
1161 rela->jump_table_start = true;
1162 insn->jump_table = rela;
1167 static int add_func_jump_tables(struct objtool_file *file,
1168 struct symbol *func)
1170 struct instruction *insn;
1173 func_for_each_insn(file, func, insn) {
1174 if (!insn->jump_table)
1177 ret = add_jump_table(file, insn, insn->jump_table);
1186 * For some switch statements, gcc generates a jump table in the .rodata
1187 * section which contains a list of addresses within the function to jump to.
1188 * This finds these jump tables and adds them to the insn->alts lists.
1190 static int add_jump_table_alts(struct objtool_file *file)
1192 struct section *sec;
1193 struct symbol *func;
1199 for_each_sec(file, sec) {
1200 list_for_each_entry(func, &sec->symbol_list, list) {
1201 if (func->type != STT_FUNC)
1204 mark_func_jump_tables(file, func);
1205 ret = add_func_jump_tables(file, func);
1214 static int read_unwind_hints(struct objtool_file *file)
1216 struct section *sec, *relasec;
1218 struct unwind_hint *hint;
1219 struct instruction *insn;
1220 struct cfi_reg *cfa;
1223 sec = find_section_by_name(file->elf, ".discard.unwind_hints");
1227 relasec = sec->rela;
1229 WARN("missing .rela.discard.unwind_hints section");
1233 if (sec->len % sizeof(struct unwind_hint)) {
1234 WARN("struct unwind_hint size mismatch");
1240 for (i = 0; i < sec->len / sizeof(struct unwind_hint); i++) {
1241 hint = (struct unwind_hint *)sec->data->d_buf + i;
1243 rela = find_rela_by_dest(file->elf, sec, i * sizeof(*hint));
1245 WARN("can't find rela for unwind_hints[%d]", i);
1249 insn = find_insn(file, rela->sym->sec, rela->addend);
1251 WARN("can't find insn for unwind_hints[%d]", i);
1255 cfa = &insn->state.cfa;
1257 if (hint->type == UNWIND_HINT_TYPE_SAVE) {
1261 } else if (hint->type == UNWIND_HINT_TYPE_RESTORE) {
1262 insn->restore = true;
1269 switch (hint->sp_reg) {
1270 case ORC_REG_UNDEFINED:
1271 cfa->base = CFI_UNDEFINED;
1279 case ORC_REG_SP_INDIRECT:
1280 cfa->base = CFI_SP_INDIRECT;
1283 cfa->base = CFI_R10;
1286 cfa->base = CFI_R13;
1295 WARN_FUNC("unsupported unwind_hint sp base reg %d",
1296 insn->sec, insn->offset, hint->sp_reg);
1300 cfa->offset = hint->sp_offset;
1301 insn->state.type = hint->type;
1302 insn->state.end = hint->end;
1308 static int read_retpoline_hints(struct objtool_file *file)
1310 struct section *sec;
1311 struct instruction *insn;
1314 sec = find_section_by_name(file->elf, ".rela.discard.retpoline_safe");
1318 list_for_each_entry(rela, &sec->rela_list, list) {
1319 if (rela->sym->type != STT_SECTION) {
1320 WARN("unexpected relocation symbol type in %s", sec->name);
1324 insn = find_insn(file, rela->sym->sec, rela->addend);
1326 WARN("bad .discard.retpoline_safe entry");
1330 if (insn->type != INSN_JUMP_DYNAMIC &&
1331 insn->type != INSN_CALL_DYNAMIC) {
1332 WARN_FUNC("retpoline_safe hint not an indirect jump/call",
1333 insn->sec, insn->offset);
1337 insn->retpoline_safe = true;
1343 static void mark_rodata(struct objtool_file *file)
1345 struct section *sec;
1349 * Search for the following rodata sections, each of which can
1350 * potentially contain jump tables:
1352 * - .rodata: can contain GCC switch tables
1353 * - .rodata.<func>: same, if -fdata-sections is being used
1354 * - .rodata..c_jump_table: contains C annotated jump tables
1356 * .rodata.str1.* sections are ignored; they don't contain jump tables.
1358 for_each_sec(file, sec) {
1359 if (!strncmp(sec->name, ".rodata", 7) &&
1360 !strstr(sec->name, ".str1.")) {
1366 file->rodata = found;
1369 static int decode_sections(struct objtool_file *file)
1375 ret = decode_instructions(file);
1379 ret = add_dead_ends(file);
1384 add_uaccess_safe(file);
1386 ret = add_ignore_alternatives(file);
1390 ret = add_jump_destinations(file);
1394 ret = add_special_section_alts(file);
1398 ret = add_call_destinations(file);
1402 ret = add_jump_table_alts(file);
1406 ret = read_unwind_hints(file);
1410 ret = read_retpoline_hints(file);
1417 static bool is_fentry_call(struct instruction *insn)
1419 if (insn->type == INSN_CALL &&
1420 insn->call_dest->type == STT_NOTYPE &&
1421 !strcmp(insn->call_dest->name, "__fentry__"))
1427 static bool has_modified_stack_frame(struct insn_state *state)
1431 if (state->cfa.base != initial_func_cfi.cfa.base ||
1432 state->cfa.offset != initial_func_cfi.cfa.offset ||
1433 state->stack_size != initial_func_cfi.cfa.offset ||
1437 for (i = 0; i < CFI_NUM_REGS; i++)
1438 if (state->regs[i].base != initial_func_cfi.regs[i].base ||
1439 state->regs[i].offset != initial_func_cfi.regs[i].offset)
1445 static bool has_valid_stack_frame(struct insn_state *state)
1447 if (state->cfa.base == CFI_BP && state->regs[CFI_BP].base == CFI_CFA &&
1448 state->regs[CFI_BP].offset == -16)
1451 if (state->drap && state->regs[CFI_BP].base == CFI_BP)
1457 static int update_insn_state_regs(struct instruction *insn,
1458 struct insn_state *state,
1459 struct stack_op *op)
1461 struct cfi_reg *cfa = &state->cfa;
1463 if (cfa->base != CFI_SP)
1467 if (op->dest.type == OP_DEST_PUSH || op->dest.type == OP_DEST_PUSHF)
1471 if (op->src.type == OP_SRC_POP || op->src.type == OP_SRC_POPF)
1474 /* add immediate to sp */
1475 if (op->dest.type == OP_DEST_REG && op->src.type == OP_SRC_ADD &&
1476 op->dest.reg == CFI_SP && op->src.reg == CFI_SP)
1477 cfa->offset -= op->src.offset;
1482 static void save_reg(struct insn_state *state, unsigned char reg, int base,
1485 if (arch_callee_saved_reg(reg) &&
1486 state->regs[reg].base == CFI_UNDEFINED) {
1487 state->regs[reg].base = base;
1488 state->regs[reg].offset = offset;
1492 static void restore_reg(struct insn_state *state, unsigned char reg)
1494 state->regs[reg].base = initial_func_cfi.regs[reg].base;
1495 state->regs[reg].offset = initial_func_cfi.regs[reg].offset;
1499 * A note about DRAP stack alignment:
1501 * GCC has the concept of a DRAP register, which is used to help keep track of
1502 * the stack pointer when aligning the stack. r10 or r13 is used as the DRAP
1503 * register. The typical DRAP pattern is:
1505 * 4c 8d 54 24 08 lea 0x8(%rsp),%r10
1506 * 48 83 e4 c0 and $0xffffffffffffffc0,%rsp
1507 * 41 ff 72 f8 pushq -0x8(%r10)
1509 * 48 89 e5 mov %rsp,%rbp
1516 * 49 8d 62 f8 lea -0x8(%r10),%rsp
1519 * There are some variations in the epilogues, like:
1527 * 49 8d 62 f8 lea -0x8(%r10),%rsp
1532 * 4c 8b 55 e8 mov -0x18(%rbp),%r10
1533 * 48 8b 5d e0 mov -0x20(%rbp),%rbx
1534 * 4c 8b 65 f0 mov -0x10(%rbp),%r12
1535 * 4c 8b 6d f8 mov -0x8(%rbp),%r13
1537 * 49 8d 62 f8 lea -0x8(%r10),%rsp
1540 * Sometimes r13 is used as the DRAP register, in which case it's saved and
1541 * restored beforehand:
1544 * 4c 8d 6c 24 10 lea 0x10(%rsp),%r13
1545 * 48 83 e4 f0 and $0xfffffffffffffff0,%rsp
1547 * 49 8d 65 f0 lea -0x10(%r13),%rsp
1551 static int update_insn_state(struct instruction *insn, struct insn_state *state,
1552 struct stack_op *op)
1554 struct cfi_reg *cfa = &state->cfa;
1555 struct cfi_reg *regs = state->regs;
1557 /* stack operations don't make sense with an undefined CFA */
1558 if (cfa->base == CFI_UNDEFINED) {
1560 WARN_FUNC("undefined stack state", insn->sec, insn->offset);
1566 if (state->type == ORC_TYPE_REGS || state->type == ORC_TYPE_REGS_IRET)
1567 return update_insn_state_regs(insn, state, op);
1569 switch (op->dest.type) {
1572 switch (op->src.type) {
1575 if (op->src.reg == CFI_SP && op->dest.reg == CFI_BP &&
1576 cfa->base == CFI_SP &&
1577 regs[CFI_BP].base == CFI_CFA &&
1578 regs[CFI_BP].offset == -cfa->offset) {
1580 /* mov %rsp, %rbp */
1581 cfa->base = op->dest.reg;
1582 state->bp_scratch = false;
1585 else if (op->src.reg == CFI_SP &&
1586 op->dest.reg == CFI_BP && state->drap) {
1588 /* drap: mov %rsp, %rbp */
1589 regs[CFI_BP].base = CFI_BP;
1590 regs[CFI_BP].offset = -state->stack_size;
1591 state->bp_scratch = false;
1594 else if (op->src.reg == CFI_SP && cfa->base == CFI_SP) {
1599 * This is needed for the rare case where GCC
1606 state->vals[op->dest.reg].base = CFI_CFA;
1607 state->vals[op->dest.reg].offset = -state->stack_size;
1610 else if (op->src.reg == CFI_BP && op->dest.reg == CFI_SP &&
1611 cfa->base == CFI_BP) {
1616 * Restore the original stack pointer (Clang).
1618 state->stack_size = -state->regs[CFI_BP].offset;
1621 else if (op->dest.reg == cfa->base) {
1623 /* mov %reg, %rsp */
1624 if (cfa->base == CFI_SP &&
1625 state->vals[op->src.reg].base == CFI_CFA) {
1628 * This is needed for the rare case
1629 * where GCC does something dumb like:
1631 * lea 0x8(%rsp), %rcx
1635 cfa->offset = -state->vals[op->src.reg].offset;
1636 state->stack_size = cfa->offset;
1639 cfa->base = CFI_UNDEFINED;
1647 if (op->dest.reg == CFI_SP && op->src.reg == CFI_SP) {
1650 state->stack_size -= op->src.offset;
1651 if (cfa->base == CFI_SP)
1652 cfa->offset -= op->src.offset;
1656 if (op->dest.reg == CFI_SP && op->src.reg == CFI_BP) {
1658 /* lea disp(%rbp), %rsp */
1659 state->stack_size = -(op->src.offset + regs[CFI_BP].offset);
1663 if (op->src.reg == CFI_SP && cfa->base == CFI_SP) {
1665 /* drap: lea disp(%rsp), %drap */
1666 state->drap_reg = op->dest.reg;
1669 * lea disp(%rsp), %reg
1671 * This is needed for the rare case where GCC
1672 * does something dumb like:
1674 * lea 0x8(%rsp), %rcx
1678 state->vals[op->dest.reg].base = CFI_CFA;
1679 state->vals[op->dest.reg].offset = \
1680 -state->stack_size + op->src.offset;
1685 if (state->drap && op->dest.reg == CFI_SP &&
1686 op->src.reg == state->drap_reg) {
1688 /* drap: lea disp(%drap), %rsp */
1690 cfa->offset = state->stack_size = -op->src.offset;
1691 state->drap_reg = CFI_UNDEFINED;
1692 state->drap = false;
1696 if (op->dest.reg == state->cfa.base) {
1697 WARN_FUNC("unsupported stack register modification",
1698 insn->sec, insn->offset);
1705 if (op->dest.reg != CFI_SP ||
1706 (state->drap_reg != CFI_UNDEFINED && cfa->base != CFI_SP) ||
1707 (state->drap_reg == CFI_UNDEFINED && cfa->base != CFI_BP)) {
1708 WARN_FUNC("unsupported stack pointer realignment",
1709 insn->sec, insn->offset);
1713 if (state->drap_reg != CFI_UNDEFINED) {
1714 /* drap: and imm, %rsp */
1715 cfa->base = state->drap_reg;
1716 cfa->offset = state->stack_size = 0;
1721 * Older versions of GCC (4.8ish) realign the stack
1722 * without DRAP, with a frame pointer.
1729 if (!state->drap && op->dest.reg == cfa->base) {
1735 if (state->drap && cfa->base == CFI_BP_INDIRECT &&
1736 op->dest.reg == state->drap_reg &&
1737 state->drap_offset == -state->stack_size) {
1739 /* drap: pop %drap */
1740 cfa->base = state->drap_reg;
1742 state->drap_offset = -1;
1744 } else if (regs[op->dest.reg].offset == -state->stack_size) {
1747 restore_reg(state, op->dest.reg);
1750 state->stack_size -= 8;
1751 if (cfa->base == CFI_SP)
1756 case OP_SRC_REG_INDIRECT:
1757 if (state->drap && op->src.reg == CFI_BP &&
1758 op->src.offset == state->drap_offset) {
1760 /* drap: mov disp(%rbp), %drap */
1761 cfa->base = state->drap_reg;
1763 state->drap_offset = -1;
1766 if (state->drap && op->src.reg == CFI_BP &&
1767 op->src.offset == regs[op->dest.reg].offset) {
1769 /* drap: mov disp(%rbp), %reg */
1770 restore_reg(state, op->dest.reg);
1772 } else if (op->src.reg == cfa->base &&
1773 op->src.offset == regs[op->dest.reg].offset + cfa->offset) {
1775 /* mov disp(%rbp), %reg */
1776 /* mov disp(%rsp), %reg */
1777 restore_reg(state, op->dest.reg);
1783 WARN_FUNC("unknown stack-related instruction",
1784 insn->sec, insn->offset);
1792 state->stack_size += 8;
1793 if (cfa->base == CFI_SP)
1796 if (op->src.type != OP_SRC_REG)
1800 if (op->src.reg == cfa->base && op->src.reg == state->drap_reg) {
1802 /* drap: push %drap */
1803 cfa->base = CFI_BP_INDIRECT;
1804 cfa->offset = -state->stack_size;
1806 /* save drap so we know when to restore it */
1807 state->drap_offset = -state->stack_size;
1809 } else if (op->src.reg == CFI_BP && cfa->base == state->drap_reg) {
1811 /* drap: push %rbp */
1812 state->stack_size = 0;
1814 } else if (regs[op->src.reg].base == CFI_UNDEFINED) {
1816 /* drap: push %reg */
1817 save_reg(state, op->src.reg, CFI_BP, -state->stack_size);
1823 save_reg(state, op->src.reg, CFI_CFA, -state->stack_size);
1826 /* detect when asm code uses rbp as a scratch register */
1827 if (!no_fp && insn->func && op->src.reg == CFI_BP &&
1828 cfa->base != CFI_BP)
1829 state->bp_scratch = true;
1832 case OP_DEST_REG_INDIRECT:
1835 if (op->src.reg == cfa->base && op->src.reg == state->drap_reg) {
1837 /* drap: mov %drap, disp(%rbp) */
1838 cfa->base = CFI_BP_INDIRECT;
1839 cfa->offset = op->dest.offset;
1841 /* save drap offset so we know when to restore it */
1842 state->drap_offset = op->dest.offset;
1845 else if (regs[op->src.reg].base == CFI_UNDEFINED) {
1847 /* drap: mov reg, disp(%rbp) */
1848 save_reg(state, op->src.reg, CFI_BP, op->dest.offset);
1851 } else if (op->dest.reg == cfa->base) {
1853 /* mov reg, disp(%rbp) */
1854 /* mov reg, disp(%rsp) */
1855 save_reg(state, op->src.reg, CFI_CFA,
1856 op->dest.offset - state->cfa.offset);
1862 if ((!state->drap && cfa->base != CFI_BP) ||
1863 (state->drap && cfa->base != state->drap_reg)) {
1864 WARN_FUNC("leave instruction with modified stack frame",
1865 insn->sec, insn->offset);
1869 /* leave (mov %rbp, %rsp; pop %rbp) */
1871 state->stack_size = -state->regs[CFI_BP].offset - 8;
1872 restore_reg(state, CFI_BP);
1882 if (op->src.type != OP_SRC_POP && op->src.type != OP_SRC_POPF) {
1883 WARN_FUNC("unknown stack-related memory operation",
1884 insn->sec, insn->offset);
1889 state->stack_size -= 8;
1890 if (cfa->base == CFI_SP)
1896 WARN_FUNC("unknown stack-related instruction",
1897 insn->sec, insn->offset);
1904 static int handle_insn_ops(struct instruction *insn, struct insn_state *state)
1906 struct stack_op *op;
1908 list_for_each_entry(op, &insn->stack_ops, list) {
1911 res = update_insn_state(insn, state, op);
1915 if (op->dest.type == OP_DEST_PUSHF) {
1916 if (!state->uaccess_stack) {
1917 state->uaccess_stack = 1;
1918 } else if (state->uaccess_stack >> 31) {
1919 WARN_FUNC("PUSHF stack exhausted",
1920 insn->sec, insn->offset);
1923 state->uaccess_stack <<= 1;
1924 state->uaccess_stack |= state->uaccess;
1927 if (op->src.type == OP_SRC_POPF) {
1928 if (state->uaccess_stack) {
1929 state->uaccess = state->uaccess_stack & 1;
1930 state->uaccess_stack >>= 1;
1931 if (state->uaccess_stack == 1)
1932 state->uaccess_stack = 0;
1940 static bool insn_state_match(struct instruction *insn, struct insn_state *state)
1942 struct insn_state *state1 = &insn->state, *state2 = state;
1945 if (memcmp(&state1->cfa, &state2->cfa, sizeof(state1->cfa))) {
1946 WARN_FUNC("stack state mismatch: cfa1=%d%+d cfa2=%d%+d",
1947 insn->sec, insn->offset,
1948 state1->cfa.base, state1->cfa.offset,
1949 state2->cfa.base, state2->cfa.offset);
1951 } else if (memcmp(&state1->regs, &state2->regs, sizeof(state1->regs))) {
1952 for (i = 0; i < CFI_NUM_REGS; i++) {
1953 if (!memcmp(&state1->regs[i], &state2->regs[i],
1954 sizeof(struct cfi_reg)))
1957 WARN_FUNC("stack state mismatch: reg1[%d]=%d%+d reg2[%d]=%d%+d",
1958 insn->sec, insn->offset,
1959 i, state1->regs[i].base, state1->regs[i].offset,
1960 i, state2->regs[i].base, state2->regs[i].offset);
1964 } else if (state1->type != state2->type) {
1965 WARN_FUNC("stack state mismatch: type1=%d type2=%d",
1966 insn->sec, insn->offset, state1->type, state2->type);
1968 } else if (state1->drap != state2->drap ||
1969 (state1->drap && state1->drap_reg != state2->drap_reg) ||
1970 (state1->drap && state1->drap_offset != state2->drap_offset)) {
1971 WARN_FUNC("stack state mismatch: drap1=%d(%d,%d) drap2=%d(%d,%d)",
1972 insn->sec, insn->offset,
1973 state1->drap, state1->drap_reg, state1->drap_offset,
1974 state2->drap, state2->drap_reg, state2->drap_offset);
1982 static inline bool func_uaccess_safe(struct symbol *func)
1985 return func->uaccess_safe;
1990 static inline const char *call_dest_name(struct instruction *insn)
1992 if (insn->call_dest)
1993 return insn->call_dest->name;
1998 static int validate_call(struct instruction *insn, struct insn_state *state)
2000 if (state->uaccess && !func_uaccess_safe(insn->call_dest)) {
2001 WARN_FUNC("call to %s() with UACCESS enabled",
2002 insn->sec, insn->offset, call_dest_name(insn));
2007 WARN_FUNC("call to %s() with DF set",
2008 insn->sec, insn->offset, call_dest_name(insn));
2015 static int validate_sibling_call(struct instruction *insn, struct insn_state *state)
2017 if (has_modified_stack_frame(state)) {
2018 WARN_FUNC("sibling call from callable instruction with modified stack frame",
2019 insn->sec, insn->offset);
2023 return validate_call(insn, state);
2026 static int validate_return(struct symbol *func, struct instruction *insn, struct insn_state *state)
2028 if (state->uaccess && !func_uaccess_safe(func)) {
2029 WARN_FUNC("return with UACCESS enabled",
2030 insn->sec, insn->offset);
2034 if (!state->uaccess && func_uaccess_safe(func)) {
2035 WARN_FUNC("return with UACCESS disabled from a UACCESS-safe function",
2036 insn->sec, insn->offset);
2041 WARN_FUNC("return with DF set",
2042 insn->sec, insn->offset);
2046 if (func && has_modified_stack_frame(state)) {
2047 WARN_FUNC("return with modified stack frame",
2048 insn->sec, insn->offset);
2052 if (state->bp_scratch) {
2053 WARN_FUNC("BP used as a scratch register",
2054 insn->sec, insn->offset);
2062 * Follow the branch starting at the given instruction, and recursively follow
2063 * any other branches (jumps). Meanwhile, track the frame pointer state at
2064 * each instruction and validate all the rules described in
2065 * tools/objtool/Documentation/stack-validation.txt.
2067 static int validate_branch(struct objtool_file *file, struct symbol *func,
2068 struct instruction *first, struct insn_state state)
2070 struct alternative *alt;
2071 struct instruction *insn, *next_insn;
2072 struct section *sec;
2079 if (insn->alt_group && list_empty(&insn->alts)) {
2080 WARN_FUNC("don't know how to handle branch to middle of alternative instruction group",
2086 next_insn = next_insn_same_sec(file, insn);
2088 if (file->c_file && func && insn->func && func != insn->func->pfunc) {
2089 WARN("%s() falls through to next function %s()",
2090 func->name, insn->func->name);
2094 if (func && insn->ignore) {
2095 WARN_FUNC("BUG: why am I validating an ignored function?",
2100 visited = 1 << state.uaccess;
2101 if (insn->visited) {
2102 if (!insn->hint && !insn_state_match(insn, &state))
2105 if (insn->visited & visited)
2110 if (insn->restore) {
2111 struct instruction *save_insn, *i;
2115 sym_for_each_insn_continue_reverse(file, func, i) {
2123 WARN_FUNC("no corresponding CFI save for CFI restore",
2128 if (!save_insn->visited) {
2130 * Oops, no state to copy yet.
2131 * Hopefully we can reach this
2132 * instruction from another branch
2133 * after the save insn has been
2139 WARN_FUNC("objtool isn't smart enough to handle this CFI save/restore combo",
2144 insn->state = save_insn->state;
2147 state = insn->state;
2150 insn->state = state;
2152 insn->visited |= visited;
2154 if (!insn->ignore_alts) {
2155 bool skip_orig = false;
2157 list_for_each_entry(alt, &insn->alts, list) {
2161 ret = validate_branch(file, func, alt->insn, state);
2164 BT_FUNC("(alt)", insn);
2173 switch (insn->type) {
2176 return validate_return(func, insn, &state);
2179 case INSN_CALL_DYNAMIC:
2180 ret = validate_call(insn, &state);
2184 if (!no_fp && func && !is_fentry_call(insn) &&
2185 !has_valid_stack_frame(&state)) {
2186 WARN_FUNC("call without frame pointer save/setup",
2191 if (dead_end_function(file, insn->call_dest))
2196 case INSN_JUMP_CONDITIONAL:
2197 case INSN_JUMP_UNCONDITIONAL:
2198 if (func && is_sibling_call(insn)) {
2199 ret = validate_sibling_call(insn, &state);
2203 } else if (insn->jump_dest) {
2204 ret = validate_branch(file, func,
2205 insn->jump_dest, state);
2208 BT_FUNC("(branch)", insn);
2213 if (insn->type == INSN_JUMP_UNCONDITIONAL)
2218 case INSN_JUMP_DYNAMIC:
2219 case INSN_JUMP_DYNAMIC_CONDITIONAL:
2220 if (func && is_sibling_call(insn)) {
2221 ret = validate_sibling_call(insn, &state);
2226 if (insn->type == INSN_JUMP_DYNAMIC)
2231 case INSN_CONTEXT_SWITCH:
2232 if (func && (!next_insn || !next_insn->hint)) {
2233 WARN_FUNC("unsupported instruction in callable function",
2240 if (handle_insn_ops(insn, &state))
2245 if (state.uaccess) {
2246 WARN_FUNC("recursive UACCESS enable", sec, insn->offset);
2250 state.uaccess = true;
2254 if (!state.uaccess && func) {
2255 WARN_FUNC("redundant UACCESS disable", sec, insn->offset);
2259 if (func_uaccess_safe(func) && !state.uaccess_stack) {
2260 WARN_FUNC("UACCESS-safe disables UACCESS", sec, insn->offset);
2264 state.uaccess = false;
2269 WARN_FUNC("recursive STD", sec, insn->offset);
2275 if (!state.df && func)
2276 WARN_FUNC("redundant CLD", sec, insn->offset);
2289 if (state.cfa.base == CFI_UNDEFINED)
2291 WARN("%s: unexpected end of section", sec->name);
2301 static int validate_unwind_hints(struct objtool_file *file)
2303 struct instruction *insn;
2304 int ret, warnings = 0;
2305 struct insn_state state;
2310 clear_insn_state(&state);
2312 for_each_insn(file, insn) {
2313 if (insn->hint && !insn->visited) {
2314 ret = validate_branch(file, insn->func, insn, state);
2315 if (ret && backtrace)
2316 BT_FUNC("<=== (hint)", insn);
2324 static int validate_retpoline(struct objtool_file *file)
2326 struct instruction *insn;
2329 for_each_insn(file, insn) {
2330 if (insn->type != INSN_JUMP_DYNAMIC &&
2331 insn->type != INSN_CALL_DYNAMIC)
2334 if (insn->retpoline_safe)
2338 * .init.text code is ran before userspace and thus doesn't
2339 * strictly need retpolines, except for modules which are
2340 * loaded late, they very much do need retpoline in their
2343 if (!strcmp(insn->sec->name, ".init.text") && !module)
2346 WARN_FUNC("indirect %s found in RETPOLINE build",
2347 insn->sec, insn->offset,
2348 insn->type == INSN_JUMP_DYNAMIC ? "jump" : "call");
2356 static bool is_kasan_insn(struct instruction *insn)
2358 return (insn->type == INSN_CALL &&
2359 !strcmp(insn->call_dest->name, "__asan_handle_no_return"));
2362 static bool is_ubsan_insn(struct instruction *insn)
2364 return (insn->type == INSN_CALL &&
2365 !strcmp(insn->call_dest->name,
2366 "__ubsan_handle_builtin_unreachable"));
2369 static bool ignore_unreachable_insn(struct instruction *insn)
2373 if (insn->ignore || insn->type == INSN_NOP)
2377 * Ignore any unused exceptions. This can happen when a whitelisted
2378 * function has an exception table entry.
2380 * Also ignore alternative replacement instructions. This can happen
2381 * when a whitelisted function uses one of the ALTERNATIVE macros.
2383 if (!strcmp(insn->sec->name, ".fixup") ||
2384 !strcmp(insn->sec->name, ".altinstr_replacement") ||
2385 !strcmp(insn->sec->name, ".altinstr_aux"))
2392 * CONFIG_UBSAN_TRAP inserts a UD2 when it sees
2393 * __builtin_unreachable(). The BUG() macro has an unreachable() after
2394 * the UD2, which causes GCC's undefined trap logic to emit another UD2
2395 * (or occasionally a JMP to UD2).
2397 if (list_prev_entry(insn, list)->dead_end &&
2398 (insn->type == INSN_BUG ||
2399 (insn->type == INSN_JUMP_UNCONDITIONAL &&
2400 insn->jump_dest && insn->jump_dest->type == INSN_BUG)))
2404 * Check if this (or a subsequent) instruction is related to
2405 * CONFIG_UBSAN or CONFIG_KASAN.
2407 * End the search at 5 instructions to avoid going into the weeds.
2409 for (i = 0; i < 5; i++) {
2411 if (is_kasan_insn(insn) || is_ubsan_insn(insn))
2414 if (insn->type == INSN_JUMP_UNCONDITIONAL) {
2415 if (insn->jump_dest &&
2416 insn->jump_dest->func == insn->func) {
2417 insn = insn->jump_dest;
2424 if (insn->offset + insn->len >= insn->func->offset + insn->func->len)
2427 insn = list_next_entry(insn, list);
2433 static int validate_section(struct objtool_file *file, struct section *sec)
2435 struct symbol *func;
2436 struct instruction *insn;
2437 struct insn_state state;
2438 int ret, warnings = 0;
2440 list_for_each_entry(func, &sec->symbol_list, list) {
2441 if (func->type != STT_FUNC)
2445 WARN("%s() is missing an ELF size annotation",
2450 if (func->pfunc != func || func->alias != func)
2453 insn = find_insn(file, sec, func->offset);
2454 if (!insn || insn->ignore || insn->visited)
2457 clear_insn_state(&state);
2458 state.cfa = initial_func_cfi.cfa;
2459 memcpy(&state.regs, &initial_func_cfi.regs,
2460 CFI_NUM_REGS * sizeof(struct cfi_reg));
2461 state.stack_size = initial_func_cfi.cfa.offset;
2463 state.uaccess = func->uaccess_safe;
2465 ret = validate_branch(file, func, insn, state);
2466 if (ret && backtrace)
2467 BT_FUNC("<=== (func)", insn);
2474 static int validate_functions(struct objtool_file *file)
2476 struct section *sec;
2479 for_each_sec(file, sec)
2480 warnings += validate_section(file, sec);
2485 static int validate_reachable_instructions(struct objtool_file *file)
2487 struct instruction *insn;
2489 if (file->ignore_unreachables)
2492 for_each_insn(file, insn) {
2493 if (insn->visited || ignore_unreachable_insn(insn))
2496 WARN_FUNC("unreachable instruction", insn->sec, insn->offset);
2503 static struct objtool_file file;
2505 int check(const char *_objname, bool orc)
2507 int ret, warnings = 0;
2511 file.elf = elf_read(objname, orc ? O_RDWR : O_RDONLY);
2515 INIT_LIST_HEAD(&file.insn_list);
2516 hash_init(file.insn_hash);
2517 file.c_file = find_section_by_name(file.elf, ".comment");
2518 file.ignore_unreachables = no_unreachable;
2521 arch_initial_func_cfi_state(&initial_func_cfi);
2523 ret = decode_sections(&file);
2528 if (list_empty(&file.insn_list))
2532 ret = validate_retpoline(&file);
2538 ret = validate_functions(&file);
2543 ret = validate_unwind_hints(&file);
2549 ret = validate_reachable_instructions(&file);
2556 ret = create_orc(&file);
2560 ret = create_orc_sections(&file);
2564 ret = elf_write(file.elf);
2572 * Fatal error. The binary is corrupt or otherwise broken in
2573 * some way, or objtool itself is broken. Fail the kernel