1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3 * Copyright (C) 2015-2017 Josh Poimboeuf <jpoimboe@redhat.com>
4 */
5
6 #include <string.h>
7 #include <stdlib.h>
8 #include <inttypes.h>
9 #include <sys/mman.h>
10
11 #include <objtool/builtin.h>
12 #include <objtool/cfi.h>
13 #include <objtool/arch.h>
14 #include <objtool/check.h>
15 #include <objtool/special.h>
16 #include <objtool/warn.h>
17 #include <objtool/endianness.h>
18
19 #include <linux/objtool_types.h>
20 #include <linux/hashtable.h>
21 #include <linux/kernel.h>
22 #include <linux/static_call_types.h>
23 #include <linux/string.h>
24
25 struct alternative {
26 struct alternative *next;
27 struct instruction *insn;
28 };
29
30 static unsigned long nr_cfi, nr_cfi_reused, nr_cfi_cache;
31
32 static struct cfi_init_state initial_func_cfi;
33 static struct cfi_state init_cfi;
34 static struct cfi_state func_cfi;
35 static struct cfi_state force_undefined_cfi;
36
find_insn(struct objtool_file * file,struct section * sec,unsigned long offset)37 struct instruction *find_insn(struct objtool_file *file,
38 struct section *sec, unsigned long offset)
39 {
40 struct instruction *insn;
41
42 hash_for_each_possible(file->insn_hash, insn, hash, sec_offset_hash(sec, offset)) {
43 if (insn->sec == sec && insn->offset == offset)
44 return insn;
45 }
46
47 return NULL;
48 }
49
next_insn_same_sec(struct objtool_file * file,struct instruction * insn)50 struct instruction *next_insn_same_sec(struct objtool_file *file,
51 struct instruction *insn)
52 {
53 if (insn->idx == INSN_CHUNK_MAX)
54 return find_insn(file, insn->sec, insn->offset + insn->len);
55
56 insn++;
57 if (!insn->len)
58 return NULL;
59
60 return insn;
61 }
62
next_insn_same_func(struct objtool_file * file,struct instruction * insn)63 static struct instruction *next_insn_same_func(struct objtool_file *file,
64 struct instruction *insn)
65 {
66 struct instruction *next = next_insn_same_sec(file, insn);
67 struct symbol *func = insn_func(insn);
68
69 if (!func)
70 return NULL;
71
72 if (next && insn_func(next) == func)
73 return next;
74
75 /* Check if we're already in the subfunction: */
76 if (func == func->cfunc)
77 return NULL;
78
79 /* Move to the subfunction: */
80 return find_insn(file, func->cfunc->sec, func->cfunc->offset);
81 }
82
prev_insn_same_sec(struct objtool_file * file,struct instruction * insn)83 static struct instruction *prev_insn_same_sec(struct objtool_file *file,
84 struct instruction *insn)
85 {
86 if (insn->idx == 0) {
87 if (insn->prev_len)
88 return find_insn(file, insn->sec, insn->offset - insn->prev_len);
89 return NULL;
90 }
91
92 return insn - 1;
93 }
94
prev_insn_same_sym(struct objtool_file * file,struct instruction * insn)95 static struct instruction *prev_insn_same_sym(struct objtool_file *file,
96 struct instruction *insn)
97 {
98 struct instruction *prev = prev_insn_same_sec(file, insn);
99
100 if (prev && insn_func(prev) == insn_func(insn))
101 return prev;
102
103 return NULL;
104 }
105
106 #define for_each_insn(file, insn) \
107 for (struct section *__sec, *__fake = (struct section *)1; \
108 __fake; __fake = NULL) \
109 for_each_sec(file, __sec) \
110 sec_for_each_insn(file, __sec, insn)
111
112 #define func_for_each_insn(file, func, insn) \
113 for (insn = find_insn(file, func->sec, func->offset); \
114 insn; \
115 insn = next_insn_same_func(file, insn))
116
117 #define sym_for_each_insn(file, sym, insn) \
118 for (insn = find_insn(file, sym->sec, sym->offset); \
119 insn && insn->offset < sym->offset + sym->len; \
120 insn = next_insn_same_sec(file, insn))
121
122 #define sym_for_each_insn_continue_reverse(file, sym, insn) \
123 for (insn = prev_insn_same_sec(file, insn); \
124 insn && insn->offset >= sym->offset; \
125 insn = prev_insn_same_sec(file, insn))
126
127 #define sec_for_each_insn_from(file, insn) \
128 for (; insn; insn = next_insn_same_sec(file, insn))
129
130 #define sec_for_each_insn_continue(file, insn) \
131 for (insn = next_insn_same_sec(file, insn); insn; \
132 insn = next_insn_same_sec(file, insn))
133
insn_call_dest(struct instruction * insn)134 static inline struct symbol *insn_call_dest(struct instruction *insn)
135 {
136 if (insn->type == INSN_JUMP_DYNAMIC ||
137 insn->type == INSN_CALL_DYNAMIC)
138 return NULL;
139
140 return insn->_call_dest;
141 }
142
insn_jump_table(struct instruction * insn)143 static inline struct reloc *insn_jump_table(struct instruction *insn)
144 {
145 if (insn->type == INSN_JUMP_DYNAMIC ||
146 insn->type == INSN_CALL_DYNAMIC)
147 return insn->_jump_table;
148
149 return NULL;
150 }
151
insn_jump_table_size(struct instruction * insn)152 static inline unsigned long insn_jump_table_size(struct instruction *insn)
153 {
154 if (insn->type == INSN_JUMP_DYNAMIC ||
155 insn->type == INSN_CALL_DYNAMIC)
156 return insn->_jump_table_size;
157
158 return 0;
159 }
160
is_jump_table_jump(struct instruction * insn)161 static bool is_jump_table_jump(struct instruction *insn)
162 {
163 struct alt_group *alt_group = insn->alt_group;
164
165 if (insn_jump_table(insn))
166 return true;
167
168 /* Retpoline alternative for a jump table? */
169 return alt_group && alt_group->orig_group &&
170 insn_jump_table(alt_group->orig_group->first_insn);
171 }
172
is_sibling_call(struct instruction * insn)173 static bool is_sibling_call(struct instruction *insn)
174 {
175 /*
176 * Assume only STT_FUNC calls have jump-tables.
177 */
178 if (insn_func(insn)) {
179 /* An indirect jump is either a sibling call or a jump to a table. */
180 if (insn->type == INSN_JUMP_DYNAMIC)
181 return !is_jump_table_jump(insn);
182 }
183
184 /* add_jump_destinations() sets insn_call_dest(insn) for sibling calls. */
185 return (is_static_jump(insn) && insn_call_dest(insn));
186 }
187
188 /*
189 * Checks if a string ends with another.
190 */
str_ends_with(const char * s,const char * sub)191 static bool str_ends_with(const char *s, const char *sub)
192 {
193 const int slen = strlen(s);
194 const int sublen = strlen(sub);
195
196 if (sublen > slen)
197 return 0;
198
199 return !memcmp(s + slen - sublen, sub, sublen);
200 }
201
202 /*
203 * Checks if a function is a Rust "noreturn" one.
204 */
is_rust_noreturn(const struct symbol * func)205 static bool is_rust_noreturn(const struct symbol *func)
206 {
207 /*
208 * If it does not start with "_R", then it is not a Rust symbol.
209 */
210 if (strncmp(func->name, "_R", 2))
211 return false;
212
213 /*
214 * These are just heuristics -- we do not control the precise symbol
215 * name, due to the crate disambiguators (which depend on the compiler)
216 * as well as changes to the source code itself between versions (since
217 * these come from the Rust standard library).
218 */
219 return str_ends_with(func->name, "_4core5sliceSp15copy_from_slice17len_mismatch_fail") ||
220 str_ends_with(func->name, "_4core6option13unwrap_failed") ||
221 str_ends_with(func->name, "_4core6result13unwrap_failed") ||
222 str_ends_with(func->name, "_4core9panicking5panic") ||
223 str_ends_with(func->name, "_4core9panicking9panic_fmt") ||
224 str_ends_with(func->name, "_4core9panicking14panic_explicit") ||
225 str_ends_with(func->name, "_4core9panicking14panic_nounwind") ||
226 str_ends_with(func->name, "_4core9panicking18panic_bounds_check") ||
227 str_ends_with(func->name, "_4core9panicking19assert_failed_inner") ||
228 str_ends_with(func->name, "_4core9panicking30panic_null_pointer_dereference") ||
229 str_ends_with(func->name, "_4core9panicking36panic_misaligned_pointer_dereference") ||
230 str_ends_with(func->name, "_7___rustc17rust_begin_unwind") ||
231 strstr(func->name, "_4core9panicking13assert_failed") ||
232 strstr(func->name, "_4core9panicking11panic_const24panic_const_") ||
233 (strstr(func->name, "_4core5slice5index") &&
234 strstr(func->name, "slice_") &&
235 str_ends_with(func->name, "_fail"));
236 }
237
238 /*
239 * This checks to see if the given function is a "noreturn" function.
240 *
241 * For global functions which are outside the scope of this object file, we
242 * have to keep a manual list of them.
243 *
244 * For local functions, we have to detect them manually by simply looking for
245 * the lack of a return instruction.
246 */
__dead_end_function(struct objtool_file * file,struct symbol * func,int recursion)247 static bool __dead_end_function(struct objtool_file *file, struct symbol *func,
248 int recursion)
249 {
250 int i;
251 struct instruction *insn;
252 bool empty = true;
253
254 #define NORETURN(func) __stringify(func),
255 static const char * const global_noreturns[] = {
256 #include "noreturns.h"
257 };
258 #undef NORETURN
259
260 if (!func)
261 return false;
262
263 if (func->bind == STB_GLOBAL || func->bind == STB_WEAK) {
264 if (is_rust_noreturn(func))
265 return true;
266
267 for (i = 0; i < ARRAY_SIZE(global_noreturns); i++)
268 if (!strcmp(func->name, global_noreturns[i]))
269 return true;
270 }
271
272 if (func->bind == STB_WEAK)
273 return false;
274
275 if (!func->len)
276 return false;
277
278 insn = find_insn(file, func->sec, func->offset);
279 if (!insn || !insn_func(insn))
280 return false;
281
282 func_for_each_insn(file, func, insn) {
283 empty = false;
284
285 if (insn->type == INSN_RETURN)
286 return false;
287 }
288
289 if (empty)
290 return false;
291
292 /*
293 * A function can have a sibling call instead of a return. In that
294 * case, the function's dead-end status depends on whether the target
295 * of the sibling call returns.
296 */
297 func_for_each_insn(file, func, insn) {
298 if (is_sibling_call(insn)) {
299 struct instruction *dest = insn->jump_dest;
300
301 if (!dest)
302 /* sibling call to another file */
303 return false;
304
305 /* local sibling call */
306 if (recursion == 5) {
307 /*
308 * Infinite recursion: two functions have
309 * sibling calls to each other. This is a very
310 * rare case. It means they aren't dead ends.
311 */
312 return false;
313 }
314
315 return __dead_end_function(file, insn_func(dest), recursion+1);
316 }
317 }
318
319 return true;
320 }
321
dead_end_function(struct objtool_file * file,struct symbol * func)322 static bool dead_end_function(struct objtool_file *file, struct symbol *func)
323 {
324 return __dead_end_function(file, func, 0);
325 }
326
init_cfi_state(struct cfi_state * cfi)327 static void init_cfi_state(struct cfi_state *cfi)
328 {
329 int i;
330
331 for (i = 0; i < CFI_NUM_REGS; i++) {
332 cfi->regs[i].base = CFI_UNDEFINED;
333 cfi->vals[i].base = CFI_UNDEFINED;
334 }
335 cfi->cfa.base = CFI_UNDEFINED;
336 cfi->drap_reg = CFI_UNDEFINED;
337 cfi->drap_offset = -1;
338 }
339
init_insn_state(struct objtool_file * file,struct insn_state * state,struct section * sec)340 static void init_insn_state(struct objtool_file *file, struct insn_state *state,
341 struct section *sec)
342 {
343 memset(state, 0, sizeof(*state));
344 init_cfi_state(&state->cfi);
345
346 if (opts.noinstr && sec)
347 state->noinstr = sec->noinstr;
348 }
349
cfi_alloc(void)350 static struct cfi_state *cfi_alloc(void)
351 {
352 struct cfi_state *cfi = calloc(1, sizeof(struct cfi_state));
353 if (!cfi) {
354 ERROR_GLIBC("calloc");
355 exit(1);
356 }
357 nr_cfi++;
358 return cfi;
359 }
360
361 static int cfi_bits;
362 static struct hlist_head *cfi_hash;
363
cficmp(struct cfi_state * cfi1,struct cfi_state * cfi2)364 static inline bool cficmp(struct cfi_state *cfi1, struct cfi_state *cfi2)
365 {
366 return memcmp((void *)cfi1 + sizeof(cfi1->hash),
367 (void *)cfi2 + sizeof(cfi2->hash),
368 sizeof(struct cfi_state) - sizeof(struct hlist_node));
369 }
370
cfi_key(struct cfi_state * cfi)371 static inline u32 cfi_key(struct cfi_state *cfi)
372 {
373 return jhash((void *)cfi + sizeof(cfi->hash),
374 sizeof(*cfi) - sizeof(cfi->hash), 0);
375 }
376
cfi_hash_find_or_add(struct cfi_state * cfi)377 static struct cfi_state *cfi_hash_find_or_add(struct cfi_state *cfi)
378 {
379 struct hlist_head *head = &cfi_hash[hash_min(cfi_key(cfi), cfi_bits)];
380 struct cfi_state *obj;
381
382 hlist_for_each_entry(obj, head, hash) {
383 if (!cficmp(cfi, obj)) {
384 nr_cfi_cache++;
385 return obj;
386 }
387 }
388
389 obj = cfi_alloc();
390 *obj = *cfi;
391 hlist_add_head(&obj->hash, head);
392
393 return obj;
394 }
395
cfi_hash_add(struct cfi_state * cfi)396 static void cfi_hash_add(struct cfi_state *cfi)
397 {
398 struct hlist_head *head = &cfi_hash[hash_min(cfi_key(cfi), cfi_bits)];
399
400 hlist_add_head(&cfi->hash, head);
401 }
402
cfi_hash_alloc(unsigned long size)403 static void *cfi_hash_alloc(unsigned long size)
404 {
405 cfi_bits = max(10, ilog2(size));
406 cfi_hash = mmap(NULL, sizeof(struct hlist_head) << cfi_bits,
407 PROT_READ|PROT_WRITE,
408 MAP_PRIVATE|MAP_ANON, -1, 0);
409 if (cfi_hash == (void *)-1L) {
410 ERROR_GLIBC("mmap fail cfi_hash");
411 cfi_hash = NULL;
412 } else if (opts.stats) {
413 printf("cfi_bits: %d\n", cfi_bits);
414 }
415
416 return cfi_hash;
417 }
418
419 static unsigned long nr_insns;
420 static unsigned long nr_insns_visited;
421
422 /*
423 * Call the arch-specific instruction decoder for all the instructions and add
424 * them to the global instruction list.
425 */
decode_instructions(struct objtool_file * file)426 static int decode_instructions(struct objtool_file *file)
427 {
428 struct section *sec;
429 struct symbol *func;
430 unsigned long offset;
431 struct instruction *insn;
432 int ret;
433
434 for_each_sec(file, sec) {
435 struct instruction *insns = NULL;
436 u8 prev_len = 0;
437 u8 idx = 0;
438
439 if (!(sec->sh.sh_flags & SHF_EXECINSTR))
440 continue;
441
442 if (strcmp(sec->name, ".altinstr_replacement") &&
443 strcmp(sec->name, ".altinstr_aux") &&
444 strncmp(sec->name, ".discard.", 9))
445 sec->text = true;
446
447 if (!strcmp(sec->name, ".noinstr.text") ||
448 !strcmp(sec->name, ".entry.text") ||
449 !strcmp(sec->name, ".cpuidle.text") ||
450 !strncmp(sec->name, ".text..__x86.", 13))
451 sec->noinstr = true;
452
453 /*
454 * .init.text code is ran before userspace and thus doesn't
455 * strictly need retpolines, except for modules which are
456 * loaded late, they very much do need retpoline in their
457 * .init.text
458 */
459 if (!strcmp(sec->name, ".init.text") && !opts.module)
460 sec->init = true;
461
462 for (offset = 0; offset < sec->sh.sh_size; offset += insn->len) {
463 if (!insns || idx == INSN_CHUNK_MAX) {
464 insns = calloc(sizeof(*insn), INSN_CHUNK_SIZE);
465 if (!insns) {
466 ERROR_GLIBC("calloc");
467 return -1;
468 }
469 idx = 0;
470 } else {
471 idx++;
472 }
473 insn = &insns[idx];
474 insn->idx = idx;
475
476 INIT_LIST_HEAD(&insn->call_node);
477 insn->sec = sec;
478 insn->offset = offset;
479 insn->prev_len = prev_len;
480
481 ret = arch_decode_instruction(file, sec, offset,
482 sec->sh.sh_size - offset,
483 insn);
484 if (ret)
485 return ret;
486
487 prev_len = insn->len;
488
489 /*
490 * By default, "ud2" is a dead end unless otherwise
491 * annotated, because GCC 7 inserts it for certain
492 * divide-by-zero cases.
493 */
494 if (insn->type == INSN_BUG)
495 insn->dead_end = true;
496
497 hash_add(file->insn_hash, &insn->hash, sec_offset_hash(sec, insn->offset));
498 nr_insns++;
499 }
500
501 sec_for_each_sym(sec, func) {
502 if (func->type != STT_NOTYPE && func->type != STT_FUNC)
503 continue;
504
505 if (func->offset == sec->sh.sh_size) {
506 /* Heuristic: likely an "end" symbol */
507 if (func->type == STT_NOTYPE)
508 continue;
509 ERROR("%s(): STT_FUNC at end of section", func->name);
510 return -1;
511 }
512
513 if (func->embedded_insn || func->alias != func)
514 continue;
515
516 if (!find_insn(file, sec, func->offset)) {
517 ERROR("%s(): can't find starting instruction", func->name);
518 return -1;
519 }
520
521 sym_for_each_insn(file, func, insn) {
522 insn->sym = func;
523 if (func->type == STT_FUNC &&
524 insn->type == INSN_ENDBR &&
525 list_empty(&insn->call_node)) {
526 if (insn->offset == func->offset) {
527 list_add_tail(&insn->call_node, &file->endbr_list);
528 file->nr_endbr++;
529 } else {
530 file->nr_endbr_int++;
531 }
532 }
533 }
534 }
535 }
536
537 if (opts.stats)
538 printf("nr_insns: %lu\n", nr_insns);
539
540 return 0;
541 }
542
543 /*
544 * Read the pv_ops[] .data table to find the static initialized values.
545 */
add_pv_ops(struct objtool_file * file,const char * symname)546 static int add_pv_ops(struct objtool_file *file, const char *symname)
547 {
548 struct symbol *sym, *func;
549 unsigned long off, end;
550 struct reloc *reloc;
551 int idx;
552
553 sym = find_symbol_by_name(file->elf, symname);
554 if (!sym)
555 return 0;
556
557 off = sym->offset;
558 end = off + sym->len;
559 for (;;) {
560 reloc = find_reloc_by_dest_range(file->elf, sym->sec, off, end - off);
561 if (!reloc)
562 break;
563
564 idx = (reloc_offset(reloc) - sym->offset) / sizeof(unsigned long);
565
566 func = reloc->sym;
567 if (func->type == STT_SECTION)
568 func = find_symbol_by_offset(reloc->sym->sec,
569 reloc_addend(reloc));
570 if (!func) {
571 ERROR_FUNC(reloc->sym->sec, reloc_addend(reloc),
572 "can't find func at %s[%d]", symname, idx);
573 return -1;
574 }
575
576 if (objtool_pv_add(file, idx, func))
577 return -1;
578
579 off = reloc_offset(reloc) + 1;
580 if (off > end)
581 break;
582 }
583
584 return 0;
585 }
586
587 /*
588 * Allocate and initialize file->pv_ops[].
589 */
init_pv_ops(struct objtool_file * file)590 static int init_pv_ops(struct objtool_file *file)
591 {
592 static const char *pv_ops_tables[] = {
593 "pv_ops",
594 "xen_cpu_ops",
595 "xen_irq_ops",
596 "xen_mmu_ops",
597 NULL,
598 };
599 const char *pv_ops;
600 struct symbol *sym;
601 int idx, nr, ret;
602
603 if (!opts.noinstr)
604 return 0;
605
606 file->pv_ops = NULL;
607
608 sym = find_symbol_by_name(file->elf, "pv_ops");
609 if (!sym)
610 return 0;
611
612 nr = sym->len / sizeof(unsigned long);
613 file->pv_ops = calloc(sizeof(struct pv_state), nr);
614 if (!file->pv_ops) {
615 ERROR_GLIBC("calloc");
616 return -1;
617 }
618
619 for (idx = 0; idx < nr; idx++)
620 INIT_LIST_HEAD(&file->pv_ops[idx].targets);
621
622 for (idx = 0; (pv_ops = pv_ops_tables[idx]); idx++) {
623 ret = add_pv_ops(file, pv_ops);
624 if (ret)
625 return ret;
626 }
627
628 return 0;
629 }
630
create_static_call_sections(struct objtool_file * file)631 static int create_static_call_sections(struct objtool_file *file)
632 {
633 struct static_call_site *site;
634 struct section *sec;
635 struct instruction *insn;
636 struct symbol *key_sym;
637 char *key_name, *tmp;
638 int idx;
639
640 sec = find_section_by_name(file->elf, ".static_call_sites");
641 if (sec) {
642 INIT_LIST_HEAD(&file->static_call_list);
643 WARN("file already has .static_call_sites section, skipping");
644 return 0;
645 }
646
647 if (list_empty(&file->static_call_list))
648 return 0;
649
650 idx = 0;
651 list_for_each_entry(insn, &file->static_call_list, call_node)
652 idx++;
653
654 sec = elf_create_section_pair(file->elf, ".static_call_sites",
655 sizeof(*site), idx, idx * 2);
656 if (!sec)
657 return -1;
658
659 /* Allow modules to modify the low bits of static_call_site::key */
660 sec->sh.sh_flags |= SHF_WRITE;
661
662 idx = 0;
663 list_for_each_entry(insn, &file->static_call_list, call_node) {
664
665 /* populate reloc for 'addr' */
666 if (!elf_init_reloc_text_sym(file->elf, sec,
667 idx * sizeof(*site), idx * 2,
668 insn->sec, insn->offset))
669 return -1;
670
671 /* find key symbol */
672 key_name = strdup(insn_call_dest(insn)->name);
673 if (!key_name) {
674 ERROR_GLIBC("strdup");
675 return -1;
676 }
677 if (strncmp(key_name, STATIC_CALL_TRAMP_PREFIX_STR,
678 STATIC_CALL_TRAMP_PREFIX_LEN)) {
679 ERROR("static_call: trampoline name malformed: %s", key_name);
680 return -1;
681 }
682 tmp = key_name + STATIC_CALL_TRAMP_PREFIX_LEN - STATIC_CALL_KEY_PREFIX_LEN;
683 memcpy(tmp, STATIC_CALL_KEY_PREFIX_STR, STATIC_CALL_KEY_PREFIX_LEN);
684
685 key_sym = find_symbol_by_name(file->elf, tmp);
686 if (!key_sym) {
687 if (!opts.module) {
688 ERROR("static_call: can't find static_call_key symbol: %s", tmp);
689 return -1;
690 }
691
692 /*
693 * For modules(), the key might not be exported, which
694 * means the module can make static calls but isn't
695 * allowed to change them.
696 *
697 * In that case we temporarily set the key to be the
698 * trampoline address. This is fixed up in
699 * static_call_add_module().
700 */
701 key_sym = insn_call_dest(insn);
702 }
703
704 /* populate reloc for 'key' */
705 if (!elf_init_reloc_data_sym(file->elf, sec,
706 idx * sizeof(*site) + 4,
707 (idx * 2) + 1, key_sym,
708 is_sibling_call(insn) * STATIC_CALL_SITE_TAIL))
709 return -1;
710
711 idx++;
712 }
713
714 return 0;
715 }
716
create_retpoline_sites_sections(struct objtool_file * file)717 static int create_retpoline_sites_sections(struct objtool_file *file)
718 {
719 struct instruction *insn;
720 struct section *sec;
721 int idx;
722
723 sec = find_section_by_name(file->elf, ".retpoline_sites");
724 if (sec) {
725 WARN("file already has .retpoline_sites, skipping");
726 return 0;
727 }
728
729 idx = 0;
730 list_for_each_entry(insn, &file->retpoline_call_list, call_node)
731 idx++;
732
733 if (!idx)
734 return 0;
735
736 sec = elf_create_section_pair(file->elf, ".retpoline_sites",
737 sizeof(int), idx, idx);
738 if (!sec)
739 return -1;
740
741 idx = 0;
742 list_for_each_entry(insn, &file->retpoline_call_list, call_node) {
743
744 if (!elf_init_reloc_text_sym(file->elf, sec,
745 idx * sizeof(int), idx,
746 insn->sec, insn->offset))
747 return -1;
748
749 idx++;
750 }
751
752 return 0;
753 }
754
create_return_sites_sections(struct objtool_file * file)755 static int create_return_sites_sections(struct objtool_file *file)
756 {
757 struct instruction *insn;
758 struct section *sec;
759 int idx;
760
761 sec = find_section_by_name(file->elf, ".return_sites");
762 if (sec) {
763 WARN("file already has .return_sites, skipping");
764 return 0;
765 }
766
767 idx = 0;
768 list_for_each_entry(insn, &file->return_thunk_list, call_node)
769 idx++;
770
771 if (!idx)
772 return 0;
773
774 sec = elf_create_section_pair(file->elf, ".return_sites",
775 sizeof(int), idx, idx);
776 if (!sec)
777 return -1;
778
779 idx = 0;
780 list_for_each_entry(insn, &file->return_thunk_list, call_node) {
781
782 if (!elf_init_reloc_text_sym(file->elf, sec,
783 idx * sizeof(int), idx,
784 insn->sec, insn->offset))
785 return -1;
786
787 idx++;
788 }
789
790 return 0;
791 }
792
create_ibt_endbr_seal_sections(struct objtool_file * file)793 static int create_ibt_endbr_seal_sections(struct objtool_file *file)
794 {
795 struct instruction *insn;
796 struct section *sec;
797 int idx;
798
799 sec = find_section_by_name(file->elf, ".ibt_endbr_seal");
800 if (sec) {
801 WARN("file already has .ibt_endbr_seal, skipping");
802 return 0;
803 }
804
805 idx = 0;
806 list_for_each_entry(insn, &file->endbr_list, call_node)
807 idx++;
808
809 if (opts.stats) {
810 printf("ibt: ENDBR at function start: %d\n", file->nr_endbr);
811 printf("ibt: ENDBR inside functions: %d\n", file->nr_endbr_int);
812 printf("ibt: superfluous ENDBR: %d\n", idx);
813 }
814
815 if (!idx)
816 return 0;
817
818 sec = elf_create_section_pair(file->elf, ".ibt_endbr_seal",
819 sizeof(int), idx, idx);
820 if (!sec)
821 return -1;
822
823 idx = 0;
824 list_for_each_entry(insn, &file->endbr_list, call_node) {
825
826 int *site = (int *)sec->data->d_buf + idx;
827 struct symbol *sym = insn->sym;
828 *site = 0;
829
830 if (opts.module && sym && sym->type == STT_FUNC &&
831 insn->offset == sym->offset &&
832 (!strcmp(sym->name, "init_module") ||
833 !strcmp(sym->name, "cleanup_module"))) {
834 ERROR("%s(): Magic init_module() function name is deprecated, use module_init(fn) instead",
835 sym->name);
836 return -1;
837 }
838
839 if (!elf_init_reloc_text_sym(file->elf, sec,
840 idx * sizeof(int), idx,
841 insn->sec, insn->offset))
842 return -1;
843
844 idx++;
845 }
846
847 return 0;
848 }
849
create_cfi_sections(struct objtool_file * file)850 static int create_cfi_sections(struct objtool_file *file)
851 {
852 struct section *sec;
853 struct symbol *sym;
854 int idx;
855
856 sec = find_section_by_name(file->elf, ".cfi_sites");
857 if (sec) {
858 INIT_LIST_HEAD(&file->call_list);
859 WARN("file already has .cfi_sites section, skipping");
860 return 0;
861 }
862
863 idx = 0;
864 for_each_sym(file, sym) {
865 if (sym->type != STT_FUNC)
866 continue;
867
868 if (strncmp(sym->name, "__cfi_", 6))
869 continue;
870
871 idx++;
872 }
873
874 sec = elf_create_section_pair(file->elf, ".cfi_sites",
875 sizeof(unsigned int), idx, idx);
876 if (!sec)
877 return -1;
878
879 idx = 0;
880 for_each_sym(file, sym) {
881 if (sym->type != STT_FUNC)
882 continue;
883
884 if (strncmp(sym->name, "__cfi_", 6))
885 continue;
886
887 if (!elf_init_reloc_text_sym(file->elf, sec,
888 idx * sizeof(unsigned int), idx,
889 sym->sec, sym->offset))
890 return -1;
891
892 idx++;
893 }
894
895 return 0;
896 }
897
create_mcount_loc_sections(struct objtool_file * file)898 static int create_mcount_loc_sections(struct objtool_file *file)
899 {
900 size_t addr_size = elf_addr_size(file->elf);
901 struct instruction *insn;
902 struct section *sec;
903 int idx;
904
905 sec = find_section_by_name(file->elf, "__mcount_loc");
906 if (sec) {
907 INIT_LIST_HEAD(&file->mcount_loc_list);
908 WARN("file already has __mcount_loc section, skipping");
909 return 0;
910 }
911
912 if (list_empty(&file->mcount_loc_list))
913 return 0;
914
915 idx = 0;
916 list_for_each_entry(insn, &file->mcount_loc_list, call_node)
917 idx++;
918
919 sec = elf_create_section_pair(file->elf, "__mcount_loc", addr_size,
920 idx, idx);
921 if (!sec)
922 return -1;
923
924 sec->sh.sh_addralign = addr_size;
925
926 idx = 0;
927 list_for_each_entry(insn, &file->mcount_loc_list, call_node) {
928
929 struct reloc *reloc;
930
931 reloc = elf_init_reloc_text_sym(file->elf, sec, idx * addr_size, idx,
932 insn->sec, insn->offset);
933 if (!reloc)
934 return -1;
935
936 set_reloc_type(file->elf, reloc, addr_size == 8 ? R_ABS64 : R_ABS32);
937
938 idx++;
939 }
940
941 return 0;
942 }
943
create_direct_call_sections(struct objtool_file * file)944 static int create_direct_call_sections(struct objtool_file *file)
945 {
946 struct instruction *insn;
947 struct section *sec;
948 int idx;
949
950 sec = find_section_by_name(file->elf, ".call_sites");
951 if (sec) {
952 INIT_LIST_HEAD(&file->call_list);
953 WARN("file already has .call_sites section, skipping");
954 return 0;
955 }
956
957 if (list_empty(&file->call_list))
958 return 0;
959
960 idx = 0;
961 list_for_each_entry(insn, &file->call_list, call_node)
962 idx++;
963
964 sec = elf_create_section_pair(file->elf, ".call_sites",
965 sizeof(unsigned int), idx, idx);
966 if (!sec)
967 return -1;
968
969 idx = 0;
970 list_for_each_entry(insn, &file->call_list, call_node) {
971
972 if (!elf_init_reloc_text_sym(file->elf, sec,
973 idx * sizeof(unsigned int), idx,
974 insn->sec, insn->offset))
975 return -1;
976
977 idx++;
978 }
979
980 return 0;
981 }
982
983 /*
984 * Warnings shouldn't be reported for ignored functions.
985 */
add_ignores(struct objtool_file * file)986 static int add_ignores(struct objtool_file *file)
987 {
988 struct section *rsec;
989 struct symbol *func;
990 struct reloc *reloc;
991
992 rsec = find_section_by_name(file->elf, ".rela.discard.func_stack_frame_non_standard");
993 if (!rsec)
994 return 0;
995
996 for_each_reloc(rsec, reloc) {
997 switch (reloc->sym->type) {
998 case STT_FUNC:
999 func = reloc->sym;
1000 break;
1001
1002 case STT_SECTION:
1003 func = find_func_by_offset(reloc->sym->sec, reloc_addend(reloc));
1004 if (!func)
1005 continue;
1006 break;
1007
1008 default:
1009 ERROR("unexpected relocation symbol type in %s: %d",
1010 rsec->name, reloc->sym->type);
1011 return -1;
1012 }
1013
1014 func->ignore = true;
1015 if (func->cfunc)
1016 func->cfunc->ignore = true;
1017 }
1018
1019 return 0;
1020 }
1021
1022 /*
1023 * This is a whitelist of functions that is allowed to be called with AC set.
1024 * The list is meant to be minimal and only contains compiler instrumentation
1025 * ABI and a few functions used to implement *_{to,from}_user() functions.
1026 *
1027 * These functions must not directly change AC, but may PUSHF/POPF.
1028 */
1029 static const char *uaccess_safe_builtin[] = {
1030 /* KASAN */
1031 "kasan_report",
1032 "kasan_check_range",
1033 /* KASAN out-of-line */
1034 "__asan_loadN_noabort",
1035 "__asan_load1_noabort",
1036 "__asan_load2_noabort",
1037 "__asan_load4_noabort",
1038 "__asan_load8_noabort",
1039 "__asan_load16_noabort",
1040 "__asan_storeN_noabort",
1041 "__asan_store1_noabort",
1042 "__asan_store2_noabort",
1043 "__asan_store4_noabort",
1044 "__asan_store8_noabort",
1045 "__asan_store16_noabort",
1046 "__kasan_check_read",
1047 "__kasan_check_write",
1048 /* KASAN in-line */
1049 "__asan_report_load_n_noabort",
1050 "__asan_report_load1_noabort",
1051 "__asan_report_load2_noabort",
1052 "__asan_report_load4_noabort",
1053 "__asan_report_load8_noabort",
1054 "__asan_report_load16_noabort",
1055 "__asan_report_store_n_noabort",
1056 "__asan_report_store1_noabort",
1057 "__asan_report_store2_noabort",
1058 "__asan_report_store4_noabort",
1059 "__asan_report_store8_noabort",
1060 "__asan_report_store16_noabort",
1061 /* KCSAN */
1062 "__kcsan_check_access",
1063 "__kcsan_mb",
1064 "__kcsan_wmb",
1065 "__kcsan_rmb",
1066 "__kcsan_release",
1067 "kcsan_found_watchpoint",
1068 "kcsan_setup_watchpoint",
1069 "kcsan_check_scoped_accesses",
1070 "kcsan_disable_current",
1071 "kcsan_enable_current_nowarn",
1072 /* KCSAN/TSAN */
1073 "__tsan_func_entry",
1074 "__tsan_func_exit",
1075 "__tsan_read_range",
1076 "__tsan_write_range",
1077 "__tsan_read1",
1078 "__tsan_read2",
1079 "__tsan_read4",
1080 "__tsan_read8",
1081 "__tsan_read16",
1082 "__tsan_write1",
1083 "__tsan_write2",
1084 "__tsan_write4",
1085 "__tsan_write8",
1086 "__tsan_write16",
1087 "__tsan_read_write1",
1088 "__tsan_read_write2",
1089 "__tsan_read_write4",
1090 "__tsan_read_write8",
1091 "__tsan_read_write16",
1092 "__tsan_volatile_read1",
1093 "__tsan_volatile_read2",
1094 "__tsan_volatile_read4",
1095 "__tsan_volatile_read8",
1096 "__tsan_volatile_read16",
1097 "__tsan_volatile_write1",
1098 "__tsan_volatile_write2",
1099 "__tsan_volatile_write4",
1100 "__tsan_volatile_write8",
1101 "__tsan_volatile_write16",
1102 "__tsan_atomic8_load",
1103 "__tsan_atomic16_load",
1104 "__tsan_atomic32_load",
1105 "__tsan_atomic64_load",
1106 "__tsan_atomic8_store",
1107 "__tsan_atomic16_store",
1108 "__tsan_atomic32_store",
1109 "__tsan_atomic64_store",
1110 "__tsan_atomic8_exchange",
1111 "__tsan_atomic16_exchange",
1112 "__tsan_atomic32_exchange",
1113 "__tsan_atomic64_exchange",
1114 "__tsan_atomic8_fetch_add",
1115 "__tsan_atomic16_fetch_add",
1116 "__tsan_atomic32_fetch_add",
1117 "__tsan_atomic64_fetch_add",
1118 "__tsan_atomic8_fetch_sub",
1119 "__tsan_atomic16_fetch_sub",
1120 "__tsan_atomic32_fetch_sub",
1121 "__tsan_atomic64_fetch_sub",
1122 "__tsan_atomic8_fetch_and",
1123 "__tsan_atomic16_fetch_and",
1124 "__tsan_atomic32_fetch_and",
1125 "__tsan_atomic64_fetch_and",
1126 "__tsan_atomic8_fetch_or",
1127 "__tsan_atomic16_fetch_or",
1128 "__tsan_atomic32_fetch_or",
1129 "__tsan_atomic64_fetch_or",
1130 "__tsan_atomic8_fetch_xor",
1131 "__tsan_atomic16_fetch_xor",
1132 "__tsan_atomic32_fetch_xor",
1133 "__tsan_atomic64_fetch_xor",
1134 "__tsan_atomic8_fetch_nand",
1135 "__tsan_atomic16_fetch_nand",
1136 "__tsan_atomic32_fetch_nand",
1137 "__tsan_atomic64_fetch_nand",
1138 "__tsan_atomic8_compare_exchange_strong",
1139 "__tsan_atomic16_compare_exchange_strong",
1140 "__tsan_atomic32_compare_exchange_strong",
1141 "__tsan_atomic64_compare_exchange_strong",
1142 "__tsan_atomic8_compare_exchange_weak",
1143 "__tsan_atomic16_compare_exchange_weak",
1144 "__tsan_atomic32_compare_exchange_weak",
1145 "__tsan_atomic64_compare_exchange_weak",
1146 "__tsan_atomic8_compare_exchange_val",
1147 "__tsan_atomic16_compare_exchange_val",
1148 "__tsan_atomic32_compare_exchange_val",
1149 "__tsan_atomic64_compare_exchange_val",
1150 "__tsan_atomic_thread_fence",
1151 "__tsan_atomic_signal_fence",
1152 "__tsan_unaligned_read16",
1153 "__tsan_unaligned_write16",
1154 /* KCOV */
1155 "write_comp_data",
1156 "check_kcov_mode",
1157 "__sanitizer_cov_trace_pc",
1158 "__sanitizer_cov_trace_const_cmp1",
1159 "__sanitizer_cov_trace_const_cmp2",
1160 "__sanitizer_cov_trace_const_cmp4",
1161 "__sanitizer_cov_trace_const_cmp8",
1162 "__sanitizer_cov_trace_cmp1",
1163 "__sanitizer_cov_trace_cmp2",
1164 "__sanitizer_cov_trace_cmp4",
1165 "__sanitizer_cov_trace_cmp8",
1166 "__sanitizer_cov_trace_switch",
1167 /* KMSAN */
1168 "kmsan_copy_to_user",
1169 "kmsan_disable_current",
1170 "kmsan_enable_current",
1171 "kmsan_report",
1172 "kmsan_unpoison_entry_regs",
1173 "kmsan_unpoison_memory",
1174 "__msan_chain_origin",
1175 "__msan_get_context_state",
1176 "__msan_instrument_asm_store",
1177 "__msan_metadata_ptr_for_load_1",
1178 "__msan_metadata_ptr_for_load_2",
1179 "__msan_metadata_ptr_for_load_4",
1180 "__msan_metadata_ptr_for_load_8",
1181 "__msan_metadata_ptr_for_load_n",
1182 "__msan_metadata_ptr_for_store_1",
1183 "__msan_metadata_ptr_for_store_2",
1184 "__msan_metadata_ptr_for_store_4",
1185 "__msan_metadata_ptr_for_store_8",
1186 "__msan_metadata_ptr_for_store_n",
1187 "__msan_poison_alloca",
1188 "__msan_warning",
1189 /* UBSAN */
1190 "ubsan_type_mismatch_common",
1191 "__ubsan_handle_type_mismatch",
1192 "__ubsan_handle_type_mismatch_v1",
1193 "__ubsan_handle_shift_out_of_bounds",
1194 "__ubsan_handle_load_invalid_value",
1195 /* STACKLEAK */
1196 "stackleak_track_stack",
1197 /* TRACE_BRANCH_PROFILING */
1198 "ftrace_likely_update",
1199 /* STACKPROTECTOR */
1200 "__stack_chk_fail",
1201 /* misc */
1202 "csum_partial_copy_generic",
1203 "copy_mc_fragile",
1204 "copy_mc_fragile_handle_tail",
1205 "copy_mc_enhanced_fast_string",
1206 "rep_stos_alternative",
1207 "rep_movs_alternative",
1208 "__copy_user_nocache",
1209 NULL
1210 };
1211
add_uaccess_safe(struct objtool_file * file)1212 static void add_uaccess_safe(struct objtool_file *file)
1213 {
1214 struct symbol *func;
1215 const char **name;
1216
1217 if (!opts.uaccess)
1218 return;
1219
1220 for (name = uaccess_safe_builtin; *name; name++) {
1221 func = find_symbol_by_name(file->elf, *name);
1222 if (!func)
1223 continue;
1224
1225 func->uaccess_safe = true;
1226 }
1227 }
1228
1229 /*
1230 * Symbols that replace INSN_CALL_DYNAMIC, every (tail) call to such a symbol
1231 * will be added to the .retpoline_sites section.
1232 */
arch_is_retpoline(struct symbol * sym)1233 __weak bool arch_is_retpoline(struct symbol *sym)
1234 {
1235 return false;
1236 }
1237
1238 /*
1239 * Symbols that replace INSN_RETURN, every (tail) call to such a symbol
1240 * will be added to the .return_sites section.
1241 */
arch_is_rethunk(struct symbol * sym)1242 __weak bool arch_is_rethunk(struct symbol *sym)
1243 {
1244 return false;
1245 }
1246
1247 /*
1248 * Symbols that are embedded inside other instructions, because sometimes crazy
1249 * code exists. These are mostly ignored for validation purposes.
1250 */
arch_is_embedded_insn(struct symbol * sym)1251 __weak bool arch_is_embedded_insn(struct symbol *sym)
1252 {
1253 return false;
1254 }
1255
insn_reloc(struct objtool_file * file,struct instruction * insn)1256 static struct reloc *insn_reloc(struct objtool_file *file, struct instruction *insn)
1257 {
1258 struct reloc *reloc;
1259
1260 if (insn->no_reloc)
1261 return NULL;
1262
1263 if (!file)
1264 return NULL;
1265
1266 reloc = find_reloc_by_dest_range(file->elf, insn->sec,
1267 insn->offset, insn->len);
1268 if (!reloc) {
1269 insn->no_reloc = 1;
1270 return NULL;
1271 }
1272
1273 return reloc;
1274 }
1275
remove_insn_ops(struct instruction * insn)1276 static void remove_insn_ops(struct instruction *insn)
1277 {
1278 struct stack_op *op, *next;
1279
1280 for (op = insn->stack_ops; op; op = next) {
1281 next = op->next;
1282 free(op);
1283 }
1284 insn->stack_ops = NULL;
1285 }
1286
annotate_call_site(struct objtool_file * file,struct instruction * insn,bool sibling)1287 static int annotate_call_site(struct objtool_file *file,
1288 struct instruction *insn, bool sibling)
1289 {
1290 struct reloc *reloc = insn_reloc(file, insn);
1291 struct symbol *sym = insn_call_dest(insn);
1292
1293 if (!sym)
1294 sym = reloc->sym;
1295
1296 if (sym->static_call_tramp) {
1297 list_add_tail(&insn->call_node, &file->static_call_list);
1298 return 0;
1299 }
1300
1301 if (sym->retpoline_thunk) {
1302 list_add_tail(&insn->call_node, &file->retpoline_call_list);
1303 return 0;
1304 }
1305
1306 /*
1307 * Many compilers cannot disable KCOV or sanitizer calls with a function
1308 * attribute so they need a little help, NOP out any such calls from
1309 * noinstr text.
1310 */
1311 if (opts.hack_noinstr && insn->sec->noinstr && sym->profiling_func) {
1312 if (reloc)
1313 set_reloc_type(file->elf, reloc, R_NONE);
1314
1315 if (elf_write_insn(file->elf, insn->sec,
1316 insn->offset, insn->len,
1317 sibling ? arch_ret_insn(insn->len)
1318 : arch_nop_insn(insn->len))) {
1319 return -1;
1320 }
1321
1322 insn->type = sibling ? INSN_RETURN : INSN_NOP;
1323
1324 if (sibling) {
1325 /*
1326 * We've replaced the tail-call JMP insn by two new
1327 * insn: RET; INT3, except we only have a single struct
1328 * insn here. Mark it retpoline_safe to avoid the SLS
1329 * warning, instead of adding another insn.
1330 */
1331 insn->retpoline_safe = true;
1332 }
1333
1334 return 0;
1335 }
1336
1337 if (opts.mcount && sym->fentry) {
1338 if (sibling)
1339 WARN_INSN(insn, "tail call to __fentry__ !?!?");
1340 if (opts.mnop) {
1341 if (reloc)
1342 set_reloc_type(file->elf, reloc, R_NONE);
1343
1344 if (elf_write_insn(file->elf, insn->sec,
1345 insn->offset, insn->len,
1346 arch_nop_insn(insn->len))) {
1347 return -1;
1348 }
1349
1350 insn->type = INSN_NOP;
1351 }
1352
1353 list_add_tail(&insn->call_node, &file->mcount_loc_list);
1354 return 0;
1355 }
1356
1357 if (insn->type == INSN_CALL && !insn->sec->init &&
1358 !insn->_call_dest->embedded_insn)
1359 list_add_tail(&insn->call_node, &file->call_list);
1360
1361 if (!sibling && dead_end_function(file, sym))
1362 insn->dead_end = true;
1363
1364 return 0;
1365 }
1366
add_call_dest(struct objtool_file * file,struct instruction * insn,struct symbol * dest,bool sibling)1367 static int add_call_dest(struct objtool_file *file, struct instruction *insn,
1368 struct symbol *dest, bool sibling)
1369 {
1370 insn->_call_dest = dest;
1371 if (!dest)
1372 return 0;
1373
1374 /*
1375 * Whatever stack impact regular CALLs have, should be undone
1376 * by the RETURN of the called function.
1377 *
1378 * Annotated intra-function calls retain the stack_ops but
1379 * are converted to JUMP, see read_intra_function_calls().
1380 */
1381 remove_insn_ops(insn);
1382
1383 return annotate_call_site(file, insn, sibling);
1384 }
1385
add_retpoline_call(struct objtool_file * file,struct instruction * insn)1386 static int add_retpoline_call(struct objtool_file *file, struct instruction *insn)
1387 {
1388 /*
1389 * Retpoline calls/jumps are really dynamic calls/jumps in disguise,
1390 * so convert them accordingly.
1391 */
1392 switch (insn->type) {
1393 case INSN_CALL:
1394 insn->type = INSN_CALL_DYNAMIC;
1395 break;
1396 case INSN_JUMP_UNCONDITIONAL:
1397 insn->type = INSN_JUMP_DYNAMIC;
1398 break;
1399 case INSN_JUMP_CONDITIONAL:
1400 insn->type = INSN_JUMP_DYNAMIC_CONDITIONAL;
1401 break;
1402 default:
1403 return 0;
1404 }
1405
1406 insn->retpoline_safe = true;
1407
1408 /*
1409 * Whatever stack impact regular CALLs have, should be undone
1410 * by the RETURN of the called function.
1411 *
1412 * Annotated intra-function calls retain the stack_ops but
1413 * are converted to JUMP, see read_intra_function_calls().
1414 */
1415 remove_insn_ops(insn);
1416
1417 return annotate_call_site(file, insn, false);
1418 }
1419
add_return_call(struct objtool_file * file,struct instruction * insn,bool add)1420 static void add_return_call(struct objtool_file *file, struct instruction *insn, bool add)
1421 {
1422 /*
1423 * Return thunk tail calls are really just returns in disguise,
1424 * so convert them accordingly.
1425 */
1426 insn->type = INSN_RETURN;
1427 insn->retpoline_safe = true;
1428
1429 if (add)
1430 list_add_tail(&insn->call_node, &file->return_thunk_list);
1431 }
1432
is_first_func_insn(struct objtool_file * file,struct instruction * insn,struct symbol * sym)1433 static bool is_first_func_insn(struct objtool_file *file,
1434 struct instruction *insn, struct symbol *sym)
1435 {
1436 if (insn->offset == sym->offset)
1437 return true;
1438
1439 /* Allow direct CALL/JMP past ENDBR */
1440 if (opts.ibt) {
1441 struct instruction *prev = prev_insn_same_sym(file, insn);
1442
1443 if (prev && prev->type == INSN_ENDBR &&
1444 insn->offset == sym->offset + prev->len)
1445 return true;
1446 }
1447
1448 return false;
1449 }
1450
1451 /*
1452 * A sibling call is a tail-call to another symbol -- to differentiate from a
1453 * recursive tail-call which is to the same symbol.
1454 */
jump_is_sibling_call(struct objtool_file * file,struct instruction * from,struct instruction * to)1455 static bool jump_is_sibling_call(struct objtool_file *file,
1456 struct instruction *from, struct instruction *to)
1457 {
1458 struct symbol *fs = from->sym;
1459 struct symbol *ts = to->sym;
1460
1461 /* Not a sibling call if from/to a symbol hole */
1462 if (!fs || !ts)
1463 return false;
1464
1465 /* Not a sibling call if not targeting the start of a symbol. */
1466 if (!is_first_func_insn(file, to, ts))
1467 return false;
1468
1469 /* Disallow sibling calls into STT_NOTYPE */
1470 if (ts->type == STT_NOTYPE)
1471 return false;
1472
1473 /* Must not be self to be a sibling */
1474 return fs->pfunc != ts->pfunc;
1475 }
1476
1477 /*
1478 * Find the destination instructions for all jumps.
1479 */
add_jump_destinations(struct objtool_file * file)1480 static int add_jump_destinations(struct objtool_file *file)
1481 {
1482 struct instruction *insn, *jump_dest;
1483 struct reloc *reloc;
1484 struct section *dest_sec;
1485 unsigned long dest_off;
1486 int ret;
1487
1488 for_each_insn(file, insn) {
1489 struct symbol *func = insn_func(insn);
1490
1491 if (insn->jump_dest) {
1492 /*
1493 * handle_group_alt() may have previously set
1494 * 'jump_dest' for some alternatives.
1495 */
1496 continue;
1497 }
1498 if (!is_static_jump(insn))
1499 continue;
1500
1501 reloc = insn_reloc(file, insn);
1502 if (!reloc) {
1503 dest_sec = insn->sec;
1504 dest_off = arch_jump_destination(insn);
1505 } else if (reloc->sym->type == STT_SECTION) {
1506 dest_sec = reloc->sym->sec;
1507 dest_off = arch_dest_reloc_offset(reloc_addend(reloc));
1508 } else if (reloc->sym->retpoline_thunk) {
1509 ret = add_retpoline_call(file, insn);
1510 if (ret)
1511 return ret;
1512 continue;
1513 } else if (reloc->sym->return_thunk) {
1514 add_return_call(file, insn, true);
1515 continue;
1516 } else if (func) {
1517 /*
1518 * External sibling call or internal sibling call with
1519 * STT_FUNC reloc.
1520 */
1521 ret = add_call_dest(file, insn, reloc->sym, true);
1522 if (ret)
1523 return ret;
1524 continue;
1525 } else if (reloc->sym->sec->idx) {
1526 dest_sec = reloc->sym->sec;
1527 dest_off = reloc->sym->sym.st_value +
1528 arch_dest_reloc_offset(reloc_addend(reloc));
1529 } else {
1530 /* non-func asm code jumping to another file */
1531 continue;
1532 }
1533
1534 jump_dest = find_insn(file, dest_sec, dest_off);
1535 if (!jump_dest) {
1536 struct symbol *sym = find_symbol_by_offset(dest_sec, dest_off);
1537
1538 /*
1539 * This is a special case for retbleed_untrain_ret().
1540 * It jumps to __x86_return_thunk(), but objtool
1541 * can't find the thunk's starting RET
1542 * instruction, because the RET is also in the
1543 * middle of another instruction. Objtool only
1544 * knows about the outer instruction.
1545 */
1546 if (sym && sym->embedded_insn) {
1547 add_return_call(file, insn, false);
1548 continue;
1549 }
1550
1551 /*
1552 * GCOV/KCOV dead code can jump to the end of the
1553 * function/section.
1554 */
1555 if (file->ignore_unreachables && func &&
1556 dest_sec == insn->sec &&
1557 dest_off == func->offset + func->len)
1558 continue;
1559
1560 ERROR_INSN(insn, "can't find jump dest instruction at %s+0x%lx",
1561 dest_sec->name, dest_off);
1562 return -1;
1563 }
1564
1565 /*
1566 * An intra-TU jump in retpoline.o might not have a relocation
1567 * for its jump dest, in which case the above
1568 * add_{retpoline,return}_call() didn't happen.
1569 */
1570 if (jump_dest->sym && jump_dest->offset == jump_dest->sym->offset) {
1571 if (jump_dest->sym->retpoline_thunk) {
1572 ret = add_retpoline_call(file, insn);
1573 if (ret)
1574 return ret;
1575 continue;
1576 }
1577 if (jump_dest->sym->return_thunk) {
1578 add_return_call(file, insn, true);
1579 continue;
1580 }
1581 }
1582
1583 /*
1584 * Cross-function jump.
1585 */
1586 if (func && insn_func(jump_dest) && func != insn_func(jump_dest)) {
1587
1588 /*
1589 * For GCC 8+, create parent/child links for any cold
1590 * subfunctions. This is _mostly_ redundant with a
1591 * similar initialization in read_symbols().
1592 *
1593 * If a function has aliases, we want the *first* such
1594 * function in the symbol table to be the subfunction's
1595 * parent. In that case we overwrite the
1596 * initialization done in read_symbols().
1597 *
1598 * However this code can't completely replace the
1599 * read_symbols() code because this doesn't detect the
1600 * case where the parent function's only reference to a
1601 * subfunction is through a jump table.
1602 */
1603 if (!strstr(func->name, ".cold") &&
1604 strstr(insn_func(jump_dest)->name, ".cold")) {
1605 func->cfunc = insn_func(jump_dest);
1606 insn_func(jump_dest)->pfunc = func;
1607 }
1608 }
1609
1610 if (jump_is_sibling_call(file, insn, jump_dest)) {
1611 /*
1612 * Internal sibling call without reloc or with
1613 * STT_SECTION reloc.
1614 */
1615 ret = add_call_dest(file, insn, insn_func(jump_dest), true);
1616 if (ret)
1617 return ret;
1618 continue;
1619 }
1620
1621 insn->jump_dest = jump_dest;
1622 }
1623
1624 return 0;
1625 }
1626
find_call_destination(struct section * sec,unsigned long offset)1627 static struct symbol *find_call_destination(struct section *sec, unsigned long offset)
1628 {
1629 struct symbol *call_dest;
1630
1631 call_dest = find_func_by_offset(sec, offset);
1632 if (!call_dest)
1633 call_dest = find_symbol_by_offset(sec, offset);
1634
1635 return call_dest;
1636 }
1637
1638 /*
1639 * Find the destination instructions for all calls.
1640 */
add_call_destinations(struct objtool_file * file)1641 static int add_call_destinations(struct objtool_file *file)
1642 {
1643 struct instruction *insn;
1644 unsigned long dest_off;
1645 struct symbol *dest;
1646 struct reloc *reloc;
1647 int ret;
1648
1649 for_each_insn(file, insn) {
1650 struct symbol *func = insn_func(insn);
1651 if (insn->type != INSN_CALL)
1652 continue;
1653
1654 reloc = insn_reloc(file, insn);
1655 if (!reloc) {
1656 dest_off = arch_jump_destination(insn);
1657 dest = find_call_destination(insn->sec, dest_off);
1658
1659 ret = add_call_dest(file, insn, dest, false);
1660 if (ret)
1661 return ret;
1662
1663 if (func && func->ignore)
1664 continue;
1665
1666 if (!insn_call_dest(insn)) {
1667 ERROR_INSN(insn, "unannotated intra-function call");
1668 return -1;
1669 }
1670
1671 if (func && insn_call_dest(insn)->type != STT_FUNC) {
1672 ERROR_INSN(insn, "unsupported call to non-function");
1673 return -1;
1674 }
1675
1676 } else if (reloc->sym->type == STT_SECTION) {
1677 dest_off = arch_dest_reloc_offset(reloc_addend(reloc));
1678 dest = find_call_destination(reloc->sym->sec, dest_off);
1679 if (!dest) {
1680 ERROR_INSN(insn, "can't find call dest symbol at %s+0x%lx",
1681 reloc->sym->sec->name, dest_off);
1682 return -1;
1683 }
1684
1685 ret = add_call_dest(file, insn, dest, false);
1686 if (ret)
1687 return ret;
1688
1689 } else if (reloc->sym->retpoline_thunk) {
1690 ret = add_retpoline_call(file, insn);
1691 if (ret)
1692 return ret;
1693
1694 } else {
1695 ret = add_call_dest(file, insn, reloc->sym, false);
1696 if (ret)
1697 return ret;
1698 }
1699 }
1700
1701 return 0;
1702 }
1703
1704 /*
1705 * The .alternatives section requires some extra special care over and above
1706 * other special sections because alternatives are patched in place.
1707 */
handle_group_alt(struct objtool_file * file,struct special_alt * special_alt,struct instruction * orig_insn,struct instruction ** new_insn)1708 static int handle_group_alt(struct objtool_file *file,
1709 struct special_alt *special_alt,
1710 struct instruction *orig_insn,
1711 struct instruction **new_insn)
1712 {
1713 struct instruction *last_new_insn = NULL, *insn, *nop = NULL;
1714 struct alt_group *orig_alt_group, *new_alt_group;
1715 unsigned long dest_off;
1716
1717 orig_alt_group = orig_insn->alt_group;
1718 if (!orig_alt_group) {
1719 struct instruction *last_orig_insn = NULL;
1720
1721 orig_alt_group = calloc(1, sizeof(*orig_alt_group));
1722 if (!orig_alt_group) {
1723 ERROR_GLIBC("calloc");
1724 return -1;
1725 }
1726 orig_alt_group->cfi = calloc(special_alt->orig_len,
1727 sizeof(struct cfi_state *));
1728 if (!orig_alt_group->cfi) {
1729 ERROR_GLIBC("calloc");
1730 return -1;
1731 }
1732
1733 insn = orig_insn;
1734 sec_for_each_insn_from(file, insn) {
1735 if (insn->offset >= special_alt->orig_off + special_alt->orig_len)
1736 break;
1737
1738 insn->alt_group = orig_alt_group;
1739 last_orig_insn = insn;
1740 }
1741 orig_alt_group->orig_group = NULL;
1742 orig_alt_group->first_insn = orig_insn;
1743 orig_alt_group->last_insn = last_orig_insn;
1744 orig_alt_group->nop = NULL;
1745 orig_alt_group->ignore = orig_insn->ignore_alts;
1746 } else {
1747 if (orig_alt_group->last_insn->offset + orig_alt_group->last_insn->len -
1748 orig_alt_group->first_insn->offset != special_alt->orig_len) {
1749 ERROR_INSN(orig_insn, "weirdly overlapping alternative! %ld != %d",
1750 orig_alt_group->last_insn->offset +
1751 orig_alt_group->last_insn->len -
1752 orig_alt_group->first_insn->offset,
1753 special_alt->orig_len);
1754 return -1;
1755 }
1756 }
1757
1758 new_alt_group = calloc(1, sizeof(*new_alt_group));
1759 if (!new_alt_group) {
1760 ERROR_GLIBC("calloc");
1761 return -1;
1762 }
1763
1764 if (special_alt->new_len < special_alt->orig_len) {
1765 /*
1766 * Insert a fake nop at the end to make the replacement
1767 * alt_group the same size as the original. This is needed to
1768 * allow propagate_alt_cfi() to do its magic. When the last
1769 * instruction affects the stack, the instruction after it (the
1770 * nop) will propagate the new state to the shared CFI array.
1771 */
1772 nop = calloc(1, sizeof(*nop));
1773 if (!nop) {
1774 ERROR_GLIBC("calloc");
1775 return -1;
1776 }
1777 memset(nop, 0, sizeof(*nop));
1778
1779 nop->sec = special_alt->new_sec;
1780 nop->offset = special_alt->new_off + special_alt->new_len;
1781 nop->len = special_alt->orig_len - special_alt->new_len;
1782 nop->type = INSN_NOP;
1783 nop->sym = orig_insn->sym;
1784 nop->alt_group = new_alt_group;
1785 }
1786
1787 if (!special_alt->new_len) {
1788 *new_insn = nop;
1789 goto end;
1790 }
1791
1792 insn = *new_insn;
1793 sec_for_each_insn_from(file, insn) {
1794 struct reloc *alt_reloc;
1795
1796 if (insn->offset >= special_alt->new_off + special_alt->new_len)
1797 break;
1798
1799 last_new_insn = insn;
1800
1801 insn->sym = orig_insn->sym;
1802 insn->alt_group = new_alt_group;
1803
1804 /*
1805 * Since alternative replacement code is copy/pasted by the
1806 * kernel after applying relocations, generally such code can't
1807 * have relative-address relocation references to outside the
1808 * .altinstr_replacement section, unless the arch's
1809 * alternatives code can adjust the relative offsets
1810 * accordingly.
1811 */
1812 alt_reloc = insn_reloc(file, insn);
1813 if (alt_reloc && arch_pc_relative_reloc(alt_reloc) &&
1814 !arch_support_alt_relocation(special_alt, insn, alt_reloc)) {
1815
1816 ERROR_INSN(insn, "unsupported relocation in alternatives section");
1817 return -1;
1818 }
1819
1820 if (!is_static_jump(insn))
1821 continue;
1822
1823 if (!insn->immediate)
1824 continue;
1825
1826 dest_off = arch_jump_destination(insn);
1827 if (dest_off == special_alt->new_off + special_alt->new_len) {
1828 insn->jump_dest = next_insn_same_sec(file, orig_alt_group->last_insn);
1829 if (!insn->jump_dest) {
1830 ERROR_INSN(insn, "can't find alternative jump destination");
1831 return -1;
1832 }
1833 }
1834 }
1835
1836 if (!last_new_insn) {
1837 ERROR_FUNC(special_alt->new_sec, special_alt->new_off,
1838 "can't find last new alternative instruction");
1839 return -1;
1840 }
1841
1842 end:
1843 new_alt_group->orig_group = orig_alt_group;
1844 new_alt_group->first_insn = *new_insn;
1845 new_alt_group->last_insn = last_new_insn;
1846 new_alt_group->nop = nop;
1847 new_alt_group->ignore = (*new_insn)->ignore_alts;
1848 new_alt_group->cfi = orig_alt_group->cfi;
1849 return 0;
1850 }
1851
1852 /*
1853 * A jump table entry can either convert a nop to a jump or a jump to a nop.
1854 * If the original instruction is a jump, make the alt entry an effective nop
1855 * by just skipping the original instruction.
1856 */
handle_jump_alt(struct objtool_file * file,struct special_alt * special_alt,struct instruction * orig_insn,struct instruction ** new_insn)1857 static int handle_jump_alt(struct objtool_file *file,
1858 struct special_alt *special_alt,
1859 struct instruction *orig_insn,
1860 struct instruction **new_insn)
1861 {
1862 if (orig_insn->type != INSN_JUMP_UNCONDITIONAL &&
1863 orig_insn->type != INSN_NOP) {
1864
1865 ERROR_INSN(orig_insn, "unsupported instruction at jump label");
1866 return -1;
1867 }
1868
1869 if (opts.hack_jump_label && special_alt->key_addend & 2) {
1870 struct reloc *reloc = insn_reloc(file, orig_insn);
1871
1872 if (reloc)
1873 set_reloc_type(file->elf, reloc, R_NONE);
1874
1875 if (elf_write_insn(file->elf, orig_insn->sec,
1876 orig_insn->offset, orig_insn->len,
1877 arch_nop_insn(orig_insn->len))) {
1878 return -1;
1879 }
1880
1881 orig_insn->type = INSN_NOP;
1882 }
1883
1884 if (orig_insn->type == INSN_NOP) {
1885 if (orig_insn->len == 2)
1886 file->jl_nop_short++;
1887 else
1888 file->jl_nop_long++;
1889
1890 return 0;
1891 }
1892
1893 if (orig_insn->len == 2)
1894 file->jl_short++;
1895 else
1896 file->jl_long++;
1897
1898 *new_insn = next_insn_same_sec(file, orig_insn);
1899 return 0;
1900 }
1901
1902 /*
1903 * Read all the special sections which have alternate instructions which can be
1904 * patched in or redirected to at runtime. Each instruction having alternate
1905 * instruction(s) has them added to its insn->alts list, which will be
1906 * traversed in validate_branch().
1907 */
add_special_section_alts(struct objtool_file * file)1908 static int add_special_section_alts(struct objtool_file *file)
1909 {
1910 struct list_head special_alts;
1911 struct instruction *orig_insn, *new_insn;
1912 struct special_alt *special_alt, *tmp;
1913 struct alternative *alt;
1914 int ret;
1915
1916 if (special_get_alts(file->elf, &special_alts))
1917 return -1;
1918
1919 list_for_each_entry_safe(special_alt, tmp, &special_alts, list) {
1920
1921 orig_insn = find_insn(file, special_alt->orig_sec,
1922 special_alt->orig_off);
1923 if (!orig_insn) {
1924 ERROR_FUNC(special_alt->orig_sec, special_alt->orig_off,
1925 "special: can't find orig instruction");
1926 return -1;
1927 }
1928
1929 new_insn = NULL;
1930 if (!special_alt->group || special_alt->new_len) {
1931 new_insn = find_insn(file, special_alt->new_sec,
1932 special_alt->new_off);
1933 if (!new_insn) {
1934 ERROR_FUNC(special_alt->new_sec, special_alt->new_off,
1935 "special: can't find new instruction");
1936 return -1;
1937 }
1938 }
1939
1940 if (special_alt->group) {
1941 if (!special_alt->orig_len) {
1942 ERROR_INSN(orig_insn, "empty alternative entry");
1943 continue;
1944 }
1945
1946 ret = handle_group_alt(file, special_alt, orig_insn,
1947 &new_insn);
1948 if (ret)
1949 return ret;
1950
1951 } else if (special_alt->jump_or_nop) {
1952 ret = handle_jump_alt(file, special_alt, orig_insn,
1953 &new_insn);
1954 if (ret)
1955 return ret;
1956 }
1957
1958 alt = calloc(1, sizeof(*alt));
1959 if (!alt) {
1960 ERROR_GLIBC("calloc");
1961 return -1;
1962 }
1963
1964 alt->insn = new_insn;
1965 alt->next = orig_insn->alts;
1966 orig_insn->alts = alt;
1967
1968 list_del(&special_alt->list);
1969 free(special_alt);
1970 }
1971
1972 if (opts.stats) {
1973 printf("jl\\\tNOP\tJMP\n");
1974 printf("short:\t%ld\t%ld\n", file->jl_nop_short, file->jl_short);
1975 printf("long:\t%ld\t%ld\n", file->jl_nop_long, file->jl_long);
1976 }
1977
1978 return 0;
1979 }
1980
arch_jump_table_sym_offset(struct reloc * reloc,struct reloc * table)1981 __weak unsigned long arch_jump_table_sym_offset(struct reloc *reloc, struct reloc *table)
1982 {
1983 return reloc->sym->offset + reloc_addend(reloc);
1984 }
1985
add_jump_table(struct objtool_file * file,struct instruction * insn)1986 static int add_jump_table(struct objtool_file *file, struct instruction *insn)
1987 {
1988 unsigned long table_size = insn_jump_table_size(insn);
1989 struct symbol *pfunc = insn_func(insn)->pfunc;
1990 struct reloc *table = insn_jump_table(insn);
1991 struct instruction *dest_insn;
1992 unsigned int prev_offset = 0;
1993 struct reloc *reloc = table;
1994 struct alternative *alt;
1995 unsigned long sym_offset;
1996
1997 /*
1998 * Each @reloc is a switch table relocation which points to the target
1999 * instruction.
2000 */
2001 for_each_reloc_from(table->sec, reloc) {
2002
2003 /* Check for the end of the table: */
2004 if (table_size && reloc_offset(reloc) - reloc_offset(table) >= table_size)
2005 break;
2006 if (reloc != table && is_jump_table(reloc))
2007 break;
2008
2009 /* Make sure the table entries are consecutive: */
2010 if (prev_offset && reloc_offset(reloc) != prev_offset + arch_reloc_size(reloc))
2011 break;
2012
2013 sym_offset = arch_jump_table_sym_offset(reloc, table);
2014
2015 /* Detect function pointers from contiguous objects: */
2016 if (reloc->sym->sec == pfunc->sec && sym_offset == pfunc->offset)
2017 break;
2018
2019 /*
2020 * Clang sometimes leaves dangling unused jump table entries
2021 * which point to the end of the function. Ignore them.
2022 */
2023 if (reloc->sym->sec == pfunc->sec &&
2024 sym_offset == pfunc->offset + pfunc->len)
2025 goto next;
2026
2027 dest_insn = find_insn(file, reloc->sym->sec, sym_offset);
2028 if (!dest_insn)
2029 break;
2030
2031 /* Make sure the destination is in the same function: */
2032 if (!insn_func(dest_insn) || insn_func(dest_insn)->pfunc != pfunc)
2033 break;
2034
2035 alt = calloc(1, sizeof(*alt));
2036 if (!alt) {
2037 ERROR_GLIBC("calloc");
2038 return -1;
2039 }
2040
2041 alt->insn = dest_insn;
2042 alt->next = insn->alts;
2043 insn->alts = alt;
2044 next:
2045 prev_offset = reloc_offset(reloc);
2046 }
2047
2048 if (!prev_offset) {
2049 ERROR_INSN(insn, "can't find switch jump table");
2050 return -1;
2051 }
2052
2053 return 0;
2054 }
2055
2056 /*
2057 * find_jump_table() - Given a dynamic jump, find the switch jump table
2058 * associated with it.
2059 */
find_jump_table(struct objtool_file * file,struct symbol * func,struct instruction * insn)2060 static void find_jump_table(struct objtool_file *file, struct symbol *func,
2061 struct instruction *insn)
2062 {
2063 struct reloc *table_reloc;
2064 struct instruction *dest_insn, *orig_insn = insn;
2065 unsigned long table_size;
2066 unsigned long sym_offset;
2067
2068 /*
2069 * Backward search using the @first_jump_src links, these help avoid
2070 * much of the 'in between' code. Which avoids us getting confused by
2071 * it.
2072 */
2073 for (;
2074 insn && insn_func(insn) && insn_func(insn)->pfunc == func;
2075 insn = insn->first_jump_src ?: prev_insn_same_sym(file, insn)) {
2076
2077 if (insn != orig_insn && insn->type == INSN_JUMP_DYNAMIC)
2078 break;
2079
2080 /* allow small jumps within the range */
2081 if (insn->type == INSN_JUMP_UNCONDITIONAL &&
2082 insn->jump_dest &&
2083 (insn->jump_dest->offset <= insn->offset ||
2084 insn->jump_dest->offset > orig_insn->offset))
2085 break;
2086
2087 table_reloc = arch_find_switch_table(file, insn, &table_size);
2088 if (!table_reloc)
2089 continue;
2090
2091 sym_offset = table_reloc->sym->offset + reloc_addend(table_reloc);
2092
2093 dest_insn = find_insn(file, table_reloc->sym->sec, sym_offset);
2094 if (!dest_insn || !insn_func(dest_insn) || insn_func(dest_insn)->pfunc != func)
2095 continue;
2096
2097 set_jump_table(table_reloc);
2098 orig_insn->_jump_table = table_reloc;
2099 orig_insn->_jump_table_size = table_size;
2100
2101 break;
2102 }
2103 }
2104
2105 /*
2106 * First pass: Mark the head of each jump table so that in the next pass,
2107 * we know when a given jump table ends and the next one starts.
2108 */
mark_func_jump_tables(struct objtool_file * file,struct symbol * func)2109 static void mark_func_jump_tables(struct objtool_file *file,
2110 struct symbol *func)
2111 {
2112 struct instruction *insn, *last = NULL;
2113
2114 func_for_each_insn(file, func, insn) {
2115 if (!last)
2116 last = insn;
2117
2118 /*
2119 * Store back-pointers for unconditional forward jumps such
2120 * that find_jump_table() can back-track using those and
2121 * avoid some potentially confusing code.
2122 */
2123 if (insn->type == INSN_JUMP_UNCONDITIONAL && insn->jump_dest &&
2124 insn->offset > last->offset &&
2125 insn->jump_dest->offset > insn->offset &&
2126 !insn->jump_dest->first_jump_src) {
2127
2128 insn->jump_dest->first_jump_src = insn;
2129 last = insn->jump_dest;
2130 }
2131
2132 if (insn->type != INSN_JUMP_DYNAMIC)
2133 continue;
2134
2135 find_jump_table(file, func, insn);
2136 }
2137 }
2138
add_func_jump_tables(struct objtool_file * file,struct symbol * func)2139 static int add_func_jump_tables(struct objtool_file *file,
2140 struct symbol *func)
2141 {
2142 struct instruction *insn;
2143 int ret;
2144
2145 func_for_each_insn(file, func, insn) {
2146 if (!insn_jump_table(insn))
2147 continue;
2148
2149 ret = add_jump_table(file, insn);
2150 if (ret)
2151 return ret;
2152 }
2153
2154 return 0;
2155 }
2156
2157 /*
2158 * For some switch statements, gcc generates a jump table in the .rodata
2159 * section which contains a list of addresses within the function to jump to.
2160 * This finds these jump tables and adds them to the insn->alts lists.
2161 */
add_jump_table_alts(struct objtool_file * file)2162 static int add_jump_table_alts(struct objtool_file *file)
2163 {
2164 struct symbol *func;
2165 int ret;
2166
2167 if (!file->rodata)
2168 return 0;
2169
2170 for_each_sym(file, func) {
2171 if (func->type != STT_FUNC)
2172 continue;
2173
2174 mark_func_jump_tables(file, func);
2175 ret = add_func_jump_tables(file, func);
2176 if (ret)
2177 return ret;
2178 }
2179
2180 return 0;
2181 }
2182
set_func_state(struct cfi_state * state)2183 static void set_func_state(struct cfi_state *state)
2184 {
2185 state->cfa = initial_func_cfi.cfa;
2186 memcpy(&state->regs, &initial_func_cfi.regs,
2187 CFI_NUM_REGS * sizeof(struct cfi_reg));
2188 state->stack_size = initial_func_cfi.cfa.offset;
2189 state->type = UNWIND_HINT_TYPE_CALL;
2190 }
2191
read_unwind_hints(struct objtool_file * file)2192 static int read_unwind_hints(struct objtool_file *file)
2193 {
2194 struct cfi_state cfi = init_cfi;
2195 struct section *sec;
2196 struct unwind_hint *hint;
2197 struct instruction *insn;
2198 struct reloc *reloc;
2199 unsigned long offset;
2200 int i;
2201
2202 sec = find_section_by_name(file->elf, ".discard.unwind_hints");
2203 if (!sec)
2204 return 0;
2205
2206 if (!sec->rsec) {
2207 ERROR("missing .rela.discard.unwind_hints section");
2208 return -1;
2209 }
2210
2211 if (sec->sh.sh_size % sizeof(struct unwind_hint)) {
2212 ERROR("struct unwind_hint size mismatch");
2213 return -1;
2214 }
2215
2216 file->hints = true;
2217
2218 for (i = 0; i < sec->sh.sh_size / sizeof(struct unwind_hint); i++) {
2219 hint = (struct unwind_hint *)sec->data->d_buf + i;
2220
2221 reloc = find_reloc_by_dest(file->elf, sec, i * sizeof(*hint));
2222 if (!reloc) {
2223 ERROR("can't find reloc for unwind_hints[%d]", i);
2224 return -1;
2225 }
2226
2227 if (reloc->sym->type == STT_SECTION) {
2228 offset = reloc_addend(reloc);
2229 } else if (reloc->sym->local_label) {
2230 offset = reloc->sym->offset;
2231 } else {
2232 ERROR("unexpected relocation symbol type in %s", sec->rsec->name);
2233 return -1;
2234 }
2235
2236 insn = find_insn(file, reloc->sym->sec, offset);
2237 if (!insn) {
2238 ERROR("can't find insn for unwind_hints[%d]", i);
2239 return -1;
2240 }
2241
2242 insn->hint = true;
2243
2244 if (hint->type == UNWIND_HINT_TYPE_UNDEFINED) {
2245 insn->cfi = &force_undefined_cfi;
2246 continue;
2247 }
2248
2249 if (hint->type == UNWIND_HINT_TYPE_SAVE) {
2250 insn->hint = false;
2251 insn->save = true;
2252 continue;
2253 }
2254
2255 if (hint->type == UNWIND_HINT_TYPE_RESTORE) {
2256 insn->restore = true;
2257 continue;
2258 }
2259
2260 if (hint->type == UNWIND_HINT_TYPE_REGS_PARTIAL) {
2261 struct symbol *sym = find_symbol_by_offset(insn->sec, insn->offset);
2262
2263 if (sym && sym->bind == STB_GLOBAL) {
2264 if (opts.ibt && insn->type != INSN_ENDBR && !insn->noendbr) {
2265 ERROR_INSN(insn, "UNWIND_HINT_IRET_REGS without ENDBR");
2266 return -1;
2267 }
2268 }
2269 }
2270
2271 if (hint->type == UNWIND_HINT_TYPE_FUNC) {
2272 insn->cfi = &func_cfi;
2273 continue;
2274 }
2275
2276 if (insn->cfi)
2277 cfi = *(insn->cfi);
2278
2279 if (arch_decode_hint_reg(hint->sp_reg, &cfi.cfa.base)) {
2280 ERROR_INSN(insn, "unsupported unwind_hint sp base reg %d", hint->sp_reg);
2281 return -1;
2282 }
2283
2284 cfi.cfa.offset = bswap_if_needed(file->elf, hint->sp_offset);
2285 cfi.type = hint->type;
2286 cfi.signal = hint->signal;
2287
2288 insn->cfi = cfi_hash_find_or_add(&cfi);
2289 }
2290
2291 return 0;
2292 }
2293
read_annotate(struct objtool_file * file,int (* func)(struct objtool_file * file,int type,struct instruction * insn))2294 static int read_annotate(struct objtool_file *file,
2295 int (*func)(struct objtool_file *file, int type, struct instruction *insn))
2296 {
2297 struct section *sec;
2298 struct instruction *insn;
2299 struct reloc *reloc;
2300 uint64_t offset;
2301 int type, ret;
2302
2303 sec = find_section_by_name(file->elf, ".discard.annotate_insn");
2304 if (!sec)
2305 return 0;
2306
2307 if (!sec->rsec)
2308 return 0;
2309
2310 if (sec->sh.sh_entsize != 8) {
2311 static bool warned = false;
2312 if (!warned && opts.verbose) {
2313 WARN("%s: dodgy linker, sh_entsize != 8", sec->name);
2314 warned = true;
2315 }
2316 sec->sh.sh_entsize = 8;
2317 }
2318
2319 for_each_reloc(sec->rsec, reloc) {
2320 type = *(u32 *)(sec->data->d_buf + (reloc_idx(reloc) * sec->sh.sh_entsize) + 4);
2321 type = bswap_if_needed(file->elf, type);
2322
2323 offset = reloc->sym->offset + reloc_addend(reloc);
2324 insn = find_insn(file, reloc->sym->sec, offset);
2325
2326 if (!insn) {
2327 ERROR("bad .discard.annotate_insn entry: %d of type %d", reloc_idx(reloc), type);
2328 return -1;
2329 }
2330
2331 ret = func(file, type, insn);
2332 if (ret < 0)
2333 return ret;
2334 }
2335
2336 return 0;
2337 }
2338
__annotate_early(struct objtool_file * file,int type,struct instruction * insn)2339 static int __annotate_early(struct objtool_file *file, int type, struct instruction *insn)
2340 {
2341 switch (type) {
2342
2343 /* Must be before add_special_section_alts() */
2344 case ANNOTYPE_IGNORE_ALTS:
2345 insn->ignore_alts = true;
2346 break;
2347
2348 /*
2349 * Must be before read_unwind_hints() since that needs insn->noendbr.
2350 */
2351 case ANNOTYPE_NOENDBR:
2352 insn->noendbr = 1;
2353 break;
2354
2355 default:
2356 break;
2357 }
2358
2359 return 0;
2360 }
2361
__annotate_ifc(struct objtool_file * file,int type,struct instruction * insn)2362 static int __annotate_ifc(struct objtool_file *file, int type, struct instruction *insn)
2363 {
2364 unsigned long dest_off;
2365
2366 if (type != ANNOTYPE_INTRA_FUNCTION_CALL)
2367 return 0;
2368
2369 if (insn->type != INSN_CALL) {
2370 ERROR_INSN(insn, "intra_function_call not a direct call");
2371 return -1;
2372 }
2373
2374 /*
2375 * Treat intra-function CALLs as JMPs, but with a stack_op.
2376 * See add_call_destinations(), which strips stack_ops from
2377 * normal CALLs.
2378 */
2379 insn->type = INSN_JUMP_UNCONDITIONAL;
2380
2381 dest_off = arch_jump_destination(insn);
2382 insn->jump_dest = find_insn(file, insn->sec, dest_off);
2383 if (!insn->jump_dest) {
2384 ERROR_INSN(insn, "can't find call dest at %s+0x%lx",
2385 insn->sec->name, dest_off);
2386 return -1;
2387 }
2388
2389 return 0;
2390 }
2391
__annotate_late(struct objtool_file * file,int type,struct instruction * insn)2392 static int __annotate_late(struct objtool_file *file, int type, struct instruction *insn)
2393 {
2394 switch (type) {
2395 case ANNOTYPE_NOENDBR:
2396 /* early */
2397 break;
2398
2399 case ANNOTYPE_RETPOLINE_SAFE:
2400 if (insn->type != INSN_JUMP_DYNAMIC &&
2401 insn->type != INSN_CALL_DYNAMIC &&
2402 insn->type != INSN_RETURN &&
2403 insn->type != INSN_NOP) {
2404 ERROR_INSN(insn, "retpoline_safe hint not an indirect jump/call/ret/nop");
2405 return -1;
2406 }
2407
2408 insn->retpoline_safe = true;
2409 break;
2410
2411 case ANNOTYPE_INSTR_BEGIN:
2412 insn->instr++;
2413 break;
2414
2415 case ANNOTYPE_INSTR_END:
2416 insn->instr--;
2417 break;
2418
2419 case ANNOTYPE_UNRET_BEGIN:
2420 insn->unret = 1;
2421 break;
2422
2423 case ANNOTYPE_IGNORE_ALTS:
2424 /* early */
2425 break;
2426
2427 case ANNOTYPE_INTRA_FUNCTION_CALL:
2428 /* ifc */
2429 break;
2430
2431 case ANNOTYPE_REACHABLE:
2432 insn->dead_end = false;
2433 break;
2434
2435 default:
2436 ERROR_INSN(insn, "Unknown annotation type: %d", type);
2437 return -1;
2438 }
2439
2440 return 0;
2441 }
2442
2443 /*
2444 * Return true if name matches an instrumentation function, where calls to that
2445 * function from noinstr code can safely be removed, but compilers won't do so.
2446 */
is_profiling_func(const char * name)2447 static bool is_profiling_func(const char *name)
2448 {
2449 /*
2450 * Many compilers cannot disable KCOV with a function attribute.
2451 */
2452 if (!strncmp(name, "__sanitizer_cov_", 16))
2453 return true;
2454
2455 /*
2456 * Some compilers currently do not remove __tsan_func_entry/exit nor
2457 * __tsan_atomic_signal_fence (used for barrier instrumentation) with
2458 * the __no_sanitize_thread attribute, remove them. Once the kernel's
2459 * minimum Clang version is 14.0, this can be removed.
2460 */
2461 if (!strncmp(name, "__tsan_func_", 12) ||
2462 !strcmp(name, "__tsan_atomic_signal_fence"))
2463 return true;
2464
2465 return false;
2466 }
2467
classify_symbols(struct objtool_file * file)2468 static int classify_symbols(struct objtool_file *file)
2469 {
2470 struct symbol *func;
2471
2472 for_each_sym(file, func) {
2473 if (func->type == STT_NOTYPE && strstarts(func->name, ".L"))
2474 func->local_label = true;
2475
2476 if (func->bind != STB_GLOBAL)
2477 continue;
2478
2479 if (!strncmp(func->name, STATIC_CALL_TRAMP_PREFIX_STR,
2480 strlen(STATIC_CALL_TRAMP_PREFIX_STR)))
2481 func->static_call_tramp = true;
2482
2483 if (arch_is_retpoline(func))
2484 func->retpoline_thunk = true;
2485
2486 if (arch_is_rethunk(func))
2487 func->return_thunk = true;
2488
2489 if (arch_is_embedded_insn(func))
2490 func->embedded_insn = true;
2491
2492 if (arch_ftrace_match(func->name))
2493 func->fentry = true;
2494
2495 if (is_profiling_func(func->name))
2496 func->profiling_func = true;
2497 }
2498
2499 return 0;
2500 }
2501
mark_rodata(struct objtool_file * file)2502 static void mark_rodata(struct objtool_file *file)
2503 {
2504 struct section *sec;
2505 bool found = false;
2506
2507 /*
2508 * Search for the following rodata sections, each of which can
2509 * potentially contain jump tables:
2510 *
2511 * - .rodata: can contain GCC switch tables
2512 * - .rodata.<func>: same, if -fdata-sections is being used
2513 * - .data.rel.ro.c_jump_table: contains C annotated jump tables
2514 *
2515 * .rodata.str1.* sections are ignored; they don't contain jump tables.
2516 */
2517 for_each_sec(file, sec) {
2518 if ((!strncmp(sec->name, ".rodata", 7) &&
2519 !strstr(sec->name, ".str1.")) ||
2520 !strncmp(sec->name, ".data.rel.ro", 12)) {
2521 sec->rodata = true;
2522 found = true;
2523 }
2524 }
2525
2526 file->rodata = found;
2527 }
2528
decode_sections(struct objtool_file * file)2529 static int decode_sections(struct objtool_file *file)
2530 {
2531 int ret;
2532
2533 mark_rodata(file);
2534
2535 ret = init_pv_ops(file);
2536 if (ret)
2537 return ret;
2538
2539 /*
2540 * Must be before add_{jump_call}_destination.
2541 */
2542 ret = classify_symbols(file);
2543 if (ret)
2544 return ret;
2545
2546 ret = decode_instructions(file);
2547 if (ret)
2548 return ret;
2549
2550 ret = add_ignores(file);
2551 if (ret)
2552 return ret;
2553
2554 add_uaccess_safe(file);
2555
2556 ret = read_annotate(file, __annotate_early);
2557 if (ret)
2558 return ret;
2559
2560 /*
2561 * Must be before add_jump_destinations(), which depends on 'func'
2562 * being set for alternatives, to enable proper sibling call detection.
2563 */
2564 if (opts.stackval || opts.orc || opts.uaccess || opts.noinstr) {
2565 ret = add_special_section_alts(file);
2566 if (ret)
2567 return ret;
2568 }
2569
2570 ret = add_jump_destinations(file);
2571 if (ret)
2572 return ret;
2573
2574 /*
2575 * Must be before add_call_destination(); it changes INSN_CALL to
2576 * INSN_JUMP.
2577 */
2578 ret = read_annotate(file, __annotate_ifc);
2579 if (ret)
2580 return ret;
2581
2582 ret = add_call_destinations(file);
2583 if (ret)
2584 return ret;
2585
2586 ret = add_jump_table_alts(file);
2587 if (ret)
2588 return ret;
2589
2590 ret = read_unwind_hints(file);
2591 if (ret)
2592 return ret;
2593
2594 /*
2595 * Must be after add_call_destinations() such that it can override
2596 * dead_end_function() marks.
2597 */
2598 ret = read_annotate(file, __annotate_late);
2599 if (ret)
2600 return ret;
2601
2602 return 0;
2603 }
2604
is_special_call(struct instruction * insn)2605 static bool is_special_call(struct instruction *insn)
2606 {
2607 if (insn->type == INSN_CALL) {
2608 struct symbol *dest = insn_call_dest(insn);
2609
2610 if (!dest)
2611 return false;
2612
2613 if (dest->fentry || dest->embedded_insn)
2614 return true;
2615 }
2616
2617 return false;
2618 }
2619
has_modified_stack_frame(struct instruction * insn,struct insn_state * state)2620 static bool has_modified_stack_frame(struct instruction *insn, struct insn_state *state)
2621 {
2622 struct cfi_state *cfi = &state->cfi;
2623 int i;
2624
2625 if (cfi->cfa.base != initial_func_cfi.cfa.base || cfi->drap)
2626 return true;
2627
2628 if (cfi->cfa.offset != initial_func_cfi.cfa.offset)
2629 return true;
2630
2631 if (cfi->stack_size != initial_func_cfi.cfa.offset)
2632 return true;
2633
2634 for (i = 0; i < CFI_NUM_REGS; i++) {
2635 if (cfi->regs[i].base != initial_func_cfi.regs[i].base ||
2636 cfi->regs[i].offset != initial_func_cfi.regs[i].offset)
2637 return true;
2638 }
2639
2640 return false;
2641 }
2642
check_reg_frame_pos(const struct cfi_reg * reg,int expected_offset)2643 static bool check_reg_frame_pos(const struct cfi_reg *reg,
2644 int expected_offset)
2645 {
2646 return reg->base == CFI_CFA &&
2647 reg->offset == expected_offset;
2648 }
2649
has_valid_stack_frame(struct insn_state * state)2650 static bool has_valid_stack_frame(struct insn_state *state)
2651 {
2652 struct cfi_state *cfi = &state->cfi;
2653
2654 if (cfi->cfa.base == CFI_BP &&
2655 check_reg_frame_pos(&cfi->regs[CFI_BP], -cfi->cfa.offset) &&
2656 check_reg_frame_pos(&cfi->regs[CFI_RA], -cfi->cfa.offset + 8))
2657 return true;
2658
2659 if (cfi->drap && cfi->regs[CFI_BP].base == CFI_BP)
2660 return true;
2661
2662 return false;
2663 }
2664
update_cfi_state_regs(struct instruction * insn,struct cfi_state * cfi,struct stack_op * op)2665 static int update_cfi_state_regs(struct instruction *insn,
2666 struct cfi_state *cfi,
2667 struct stack_op *op)
2668 {
2669 struct cfi_reg *cfa = &cfi->cfa;
2670
2671 if (cfa->base != CFI_SP && cfa->base != CFI_SP_INDIRECT)
2672 return 0;
2673
2674 /* push */
2675 if (op->dest.type == OP_DEST_PUSH || op->dest.type == OP_DEST_PUSHF)
2676 cfa->offset += 8;
2677
2678 /* pop */
2679 if (op->src.type == OP_SRC_POP || op->src.type == OP_SRC_POPF)
2680 cfa->offset -= 8;
2681
2682 /* add immediate to sp */
2683 if (op->dest.type == OP_DEST_REG && op->src.type == OP_SRC_ADD &&
2684 op->dest.reg == CFI_SP && op->src.reg == CFI_SP)
2685 cfa->offset -= op->src.offset;
2686
2687 return 0;
2688 }
2689
save_reg(struct cfi_state * cfi,unsigned char reg,int base,int offset)2690 static void save_reg(struct cfi_state *cfi, unsigned char reg, int base, int offset)
2691 {
2692 if (arch_callee_saved_reg(reg) &&
2693 cfi->regs[reg].base == CFI_UNDEFINED) {
2694 cfi->regs[reg].base = base;
2695 cfi->regs[reg].offset = offset;
2696 }
2697 }
2698
restore_reg(struct cfi_state * cfi,unsigned char reg)2699 static void restore_reg(struct cfi_state *cfi, unsigned char reg)
2700 {
2701 cfi->regs[reg].base = initial_func_cfi.regs[reg].base;
2702 cfi->regs[reg].offset = initial_func_cfi.regs[reg].offset;
2703 }
2704
2705 /*
2706 * A note about DRAP stack alignment:
2707 *
2708 * GCC has the concept of a DRAP register, which is used to help keep track of
2709 * the stack pointer when aligning the stack. r10 or r13 is used as the DRAP
2710 * register. The typical DRAP pattern is:
2711 *
2712 * 4c 8d 54 24 08 lea 0x8(%rsp),%r10
2713 * 48 83 e4 c0 and $0xffffffffffffffc0,%rsp
2714 * 41 ff 72 f8 pushq -0x8(%r10)
2715 * 55 push %rbp
2716 * 48 89 e5 mov %rsp,%rbp
2717 * (more pushes)
2718 * 41 52 push %r10
2719 * ...
2720 * 41 5a pop %r10
2721 * (more pops)
2722 * 5d pop %rbp
2723 * 49 8d 62 f8 lea -0x8(%r10),%rsp
2724 * c3 retq
2725 *
2726 * There are some variations in the epilogues, like:
2727 *
2728 * 5b pop %rbx
2729 * 41 5a pop %r10
2730 * 41 5c pop %r12
2731 * 41 5d pop %r13
2732 * 41 5e pop %r14
2733 * c9 leaveq
2734 * 49 8d 62 f8 lea -0x8(%r10),%rsp
2735 * c3 retq
2736 *
2737 * and:
2738 *
2739 * 4c 8b 55 e8 mov -0x18(%rbp),%r10
2740 * 48 8b 5d e0 mov -0x20(%rbp),%rbx
2741 * 4c 8b 65 f0 mov -0x10(%rbp),%r12
2742 * 4c 8b 6d f8 mov -0x8(%rbp),%r13
2743 * c9 leaveq
2744 * 49 8d 62 f8 lea -0x8(%r10),%rsp
2745 * c3 retq
2746 *
2747 * Sometimes r13 is used as the DRAP register, in which case it's saved and
2748 * restored beforehand:
2749 *
2750 * 41 55 push %r13
2751 * 4c 8d 6c 24 10 lea 0x10(%rsp),%r13
2752 * 48 83 e4 f0 and $0xfffffffffffffff0,%rsp
2753 * ...
2754 * 49 8d 65 f0 lea -0x10(%r13),%rsp
2755 * 41 5d pop %r13
2756 * c3 retq
2757 */
update_cfi_state(struct instruction * insn,struct instruction * next_insn,struct cfi_state * cfi,struct stack_op * op)2758 static int update_cfi_state(struct instruction *insn,
2759 struct instruction *next_insn,
2760 struct cfi_state *cfi, struct stack_op *op)
2761 {
2762 struct cfi_reg *cfa = &cfi->cfa;
2763 struct cfi_reg *regs = cfi->regs;
2764
2765 /* ignore UNWIND_HINT_UNDEFINED regions */
2766 if (cfi->force_undefined)
2767 return 0;
2768
2769 /* stack operations don't make sense with an undefined CFA */
2770 if (cfa->base == CFI_UNDEFINED) {
2771 if (insn_func(insn)) {
2772 WARN_INSN(insn, "undefined stack state");
2773 return 1;
2774 }
2775 return 0;
2776 }
2777
2778 if (cfi->type == UNWIND_HINT_TYPE_REGS ||
2779 cfi->type == UNWIND_HINT_TYPE_REGS_PARTIAL)
2780 return update_cfi_state_regs(insn, cfi, op);
2781
2782 switch (op->dest.type) {
2783
2784 case OP_DEST_REG:
2785 switch (op->src.type) {
2786
2787 case OP_SRC_REG:
2788 if (op->src.reg == CFI_SP && op->dest.reg == CFI_BP &&
2789 cfa->base == CFI_SP &&
2790 check_reg_frame_pos(®s[CFI_BP], -cfa->offset)) {
2791
2792 /* mov %rsp, %rbp */
2793 cfa->base = op->dest.reg;
2794 cfi->bp_scratch = false;
2795 }
2796
2797 else if (op->src.reg == CFI_SP &&
2798 op->dest.reg == CFI_BP && cfi->drap) {
2799
2800 /* drap: mov %rsp, %rbp */
2801 regs[CFI_BP].base = CFI_BP;
2802 regs[CFI_BP].offset = -cfi->stack_size;
2803 cfi->bp_scratch = false;
2804 }
2805
2806 else if (op->src.reg == CFI_SP && cfa->base == CFI_SP) {
2807
2808 /*
2809 * mov %rsp, %reg
2810 *
2811 * This is needed for the rare case where GCC
2812 * does:
2813 *
2814 * mov %rsp, %rax
2815 * ...
2816 * mov %rax, %rsp
2817 */
2818 cfi->vals[op->dest.reg].base = CFI_CFA;
2819 cfi->vals[op->dest.reg].offset = -cfi->stack_size;
2820 }
2821
2822 else if (op->src.reg == CFI_BP && op->dest.reg == CFI_SP &&
2823 (cfa->base == CFI_BP || cfa->base == cfi->drap_reg)) {
2824
2825 /*
2826 * mov %rbp, %rsp
2827 *
2828 * Restore the original stack pointer (Clang).
2829 */
2830 cfi->stack_size = -cfi->regs[CFI_BP].offset;
2831 }
2832
2833 else if (op->dest.reg == cfa->base) {
2834
2835 /* mov %reg, %rsp */
2836 if (cfa->base == CFI_SP &&
2837 cfi->vals[op->src.reg].base == CFI_CFA) {
2838
2839 /*
2840 * This is needed for the rare case
2841 * where GCC does something dumb like:
2842 *
2843 * lea 0x8(%rsp), %rcx
2844 * ...
2845 * mov %rcx, %rsp
2846 */
2847 cfa->offset = -cfi->vals[op->src.reg].offset;
2848 cfi->stack_size = cfa->offset;
2849
2850 } else if (cfa->base == CFI_SP &&
2851 cfi->vals[op->src.reg].base == CFI_SP_INDIRECT &&
2852 cfi->vals[op->src.reg].offset == cfa->offset) {
2853
2854 /*
2855 * Stack swizzle:
2856 *
2857 * 1: mov %rsp, (%[tos])
2858 * 2: mov %[tos], %rsp
2859 * ...
2860 * 3: pop %rsp
2861 *
2862 * Where:
2863 *
2864 * 1 - places a pointer to the previous
2865 * stack at the Top-of-Stack of the
2866 * new stack.
2867 *
2868 * 2 - switches to the new stack.
2869 *
2870 * 3 - pops the Top-of-Stack to restore
2871 * the original stack.
2872 *
2873 * Note: we set base to SP_INDIRECT
2874 * here and preserve offset. Therefore
2875 * when the unwinder reaches ToS it
2876 * will dereference SP and then add the
2877 * offset to find the next frame, IOW:
2878 * (%rsp) + offset.
2879 */
2880 cfa->base = CFI_SP_INDIRECT;
2881
2882 } else {
2883 cfa->base = CFI_UNDEFINED;
2884 cfa->offset = 0;
2885 }
2886 }
2887
2888 else if (op->dest.reg == CFI_SP &&
2889 cfi->vals[op->src.reg].base == CFI_SP_INDIRECT &&
2890 cfi->vals[op->src.reg].offset == cfa->offset) {
2891
2892 /*
2893 * The same stack swizzle case 2) as above. But
2894 * because we can't change cfa->base, case 3)
2895 * will become a regular POP. Pretend we're a
2896 * PUSH so things don't go unbalanced.
2897 */
2898 cfi->stack_size += 8;
2899 }
2900
2901
2902 break;
2903
2904 case OP_SRC_ADD:
2905 if (op->dest.reg == CFI_SP && op->src.reg == CFI_SP) {
2906
2907 /* add imm, %rsp */
2908 cfi->stack_size -= op->src.offset;
2909 if (cfa->base == CFI_SP)
2910 cfa->offset -= op->src.offset;
2911 break;
2912 }
2913
2914 if (op->dest.reg == CFI_BP && op->src.reg == CFI_SP &&
2915 insn->sym->frame_pointer) {
2916 /* addi.d fp,sp,imm on LoongArch */
2917 if (cfa->base == CFI_SP && cfa->offset == op->src.offset) {
2918 cfa->base = CFI_BP;
2919 cfa->offset = 0;
2920 }
2921 break;
2922 }
2923
2924 if (op->dest.reg == CFI_SP && op->src.reg == CFI_BP) {
2925 /* addi.d sp,fp,imm on LoongArch */
2926 if (cfa->base == CFI_BP && cfa->offset == 0) {
2927 if (insn->sym->frame_pointer) {
2928 cfa->base = CFI_SP;
2929 cfa->offset = -op->src.offset;
2930 }
2931 } else {
2932 /* lea disp(%rbp), %rsp */
2933 cfi->stack_size = -(op->src.offset + regs[CFI_BP].offset);
2934 }
2935 break;
2936 }
2937
2938 if (op->src.reg == CFI_SP && cfa->base == CFI_SP) {
2939
2940 /* drap: lea disp(%rsp), %drap */
2941 cfi->drap_reg = op->dest.reg;
2942
2943 /*
2944 * lea disp(%rsp), %reg
2945 *
2946 * This is needed for the rare case where GCC
2947 * does something dumb like:
2948 *
2949 * lea 0x8(%rsp), %rcx
2950 * ...
2951 * mov %rcx, %rsp
2952 */
2953 cfi->vals[op->dest.reg].base = CFI_CFA;
2954 cfi->vals[op->dest.reg].offset = \
2955 -cfi->stack_size + op->src.offset;
2956
2957 break;
2958 }
2959
2960 if (cfi->drap && op->dest.reg == CFI_SP &&
2961 op->src.reg == cfi->drap_reg) {
2962
2963 /* drap: lea disp(%drap), %rsp */
2964 cfa->base = CFI_SP;
2965 cfa->offset = cfi->stack_size = -op->src.offset;
2966 cfi->drap_reg = CFI_UNDEFINED;
2967 cfi->drap = false;
2968 break;
2969 }
2970
2971 if (op->dest.reg == cfi->cfa.base && !(next_insn && next_insn->hint)) {
2972 WARN_INSN(insn, "unsupported stack register modification");
2973 return -1;
2974 }
2975
2976 break;
2977
2978 case OP_SRC_AND:
2979 if (op->dest.reg != CFI_SP ||
2980 (cfi->drap_reg != CFI_UNDEFINED && cfa->base != CFI_SP) ||
2981 (cfi->drap_reg == CFI_UNDEFINED && cfa->base != CFI_BP)) {
2982 WARN_INSN(insn, "unsupported stack pointer realignment");
2983 return -1;
2984 }
2985
2986 if (cfi->drap_reg != CFI_UNDEFINED) {
2987 /* drap: and imm, %rsp */
2988 cfa->base = cfi->drap_reg;
2989 cfa->offset = cfi->stack_size = 0;
2990 cfi->drap = true;
2991 }
2992
2993 /*
2994 * Older versions of GCC (4.8ish) realign the stack
2995 * without DRAP, with a frame pointer.
2996 */
2997
2998 break;
2999
3000 case OP_SRC_POP:
3001 case OP_SRC_POPF:
3002 if (op->dest.reg == CFI_SP && cfa->base == CFI_SP_INDIRECT) {
3003
3004 /* pop %rsp; # restore from a stack swizzle */
3005 cfa->base = CFI_SP;
3006 break;
3007 }
3008
3009 if (!cfi->drap && op->dest.reg == cfa->base) {
3010
3011 /* pop %rbp */
3012 cfa->base = CFI_SP;
3013 }
3014
3015 if (cfi->drap && cfa->base == CFI_BP_INDIRECT &&
3016 op->dest.reg == cfi->drap_reg &&
3017 cfi->drap_offset == -cfi->stack_size) {
3018
3019 /* drap: pop %drap */
3020 cfa->base = cfi->drap_reg;
3021 cfa->offset = 0;
3022 cfi->drap_offset = -1;
3023
3024 } else if (cfi->stack_size == -regs[op->dest.reg].offset) {
3025
3026 /* pop %reg */
3027 restore_reg(cfi, op->dest.reg);
3028 }
3029
3030 cfi->stack_size -= 8;
3031 if (cfa->base == CFI_SP)
3032 cfa->offset -= 8;
3033
3034 break;
3035
3036 case OP_SRC_REG_INDIRECT:
3037 if (!cfi->drap && op->dest.reg == cfa->base &&
3038 op->dest.reg == CFI_BP) {
3039
3040 /* mov disp(%rsp), %rbp */
3041 cfa->base = CFI_SP;
3042 cfa->offset = cfi->stack_size;
3043 }
3044
3045 if (cfi->drap && op->src.reg == CFI_BP &&
3046 op->src.offset == cfi->drap_offset) {
3047
3048 /* drap: mov disp(%rbp), %drap */
3049 cfa->base = cfi->drap_reg;
3050 cfa->offset = 0;
3051 cfi->drap_offset = -1;
3052 }
3053
3054 if (cfi->drap && op->src.reg == CFI_BP &&
3055 op->src.offset == regs[op->dest.reg].offset) {
3056
3057 /* drap: mov disp(%rbp), %reg */
3058 restore_reg(cfi, op->dest.reg);
3059
3060 } else if (op->src.reg == cfa->base &&
3061 op->src.offset == regs[op->dest.reg].offset + cfa->offset) {
3062
3063 /* mov disp(%rbp), %reg */
3064 /* mov disp(%rsp), %reg */
3065 restore_reg(cfi, op->dest.reg);
3066
3067 } else if (op->src.reg == CFI_SP &&
3068 op->src.offset == regs[op->dest.reg].offset + cfi->stack_size) {
3069
3070 /* mov disp(%rsp), %reg */
3071 restore_reg(cfi, op->dest.reg);
3072 }
3073
3074 break;
3075
3076 default:
3077 WARN_INSN(insn, "unknown stack-related instruction");
3078 return -1;
3079 }
3080
3081 break;
3082
3083 case OP_DEST_PUSH:
3084 case OP_DEST_PUSHF:
3085 cfi->stack_size += 8;
3086 if (cfa->base == CFI_SP)
3087 cfa->offset += 8;
3088
3089 if (op->src.type != OP_SRC_REG)
3090 break;
3091
3092 if (cfi->drap) {
3093 if (op->src.reg == cfa->base && op->src.reg == cfi->drap_reg) {
3094
3095 /* drap: push %drap */
3096 cfa->base = CFI_BP_INDIRECT;
3097 cfa->offset = -cfi->stack_size;
3098
3099 /* save drap so we know when to restore it */
3100 cfi->drap_offset = -cfi->stack_size;
3101
3102 } else if (op->src.reg == CFI_BP && cfa->base == cfi->drap_reg) {
3103
3104 /* drap: push %rbp */
3105 cfi->stack_size = 0;
3106
3107 } else {
3108
3109 /* drap: push %reg */
3110 save_reg(cfi, op->src.reg, CFI_BP, -cfi->stack_size);
3111 }
3112
3113 } else {
3114
3115 /* push %reg */
3116 save_reg(cfi, op->src.reg, CFI_CFA, -cfi->stack_size);
3117 }
3118
3119 /* detect when asm code uses rbp as a scratch register */
3120 if (opts.stackval && insn_func(insn) && op->src.reg == CFI_BP &&
3121 cfa->base != CFI_BP)
3122 cfi->bp_scratch = true;
3123 break;
3124
3125 case OP_DEST_REG_INDIRECT:
3126
3127 if (cfi->drap) {
3128 if (op->src.reg == cfa->base && op->src.reg == cfi->drap_reg) {
3129
3130 /* drap: mov %drap, disp(%rbp) */
3131 cfa->base = CFI_BP_INDIRECT;
3132 cfa->offset = op->dest.offset;
3133
3134 /* save drap offset so we know when to restore it */
3135 cfi->drap_offset = op->dest.offset;
3136 } else {
3137
3138 /* drap: mov reg, disp(%rbp) */
3139 save_reg(cfi, op->src.reg, CFI_BP, op->dest.offset);
3140 }
3141
3142 } else if (op->dest.reg == cfa->base) {
3143
3144 /* mov reg, disp(%rbp) */
3145 /* mov reg, disp(%rsp) */
3146 save_reg(cfi, op->src.reg, CFI_CFA,
3147 op->dest.offset - cfi->cfa.offset);
3148
3149 } else if (op->dest.reg == CFI_SP) {
3150
3151 /* mov reg, disp(%rsp) */
3152 save_reg(cfi, op->src.reg, CFI_CFA,
3153 op->dest.offset - cfi->stack_size);
3154
3155 } else if (op->src.reg == CFI_SP && op->dest.offset == 0) {
3156
3157 /* mov %rsp, (%reg); # setup a stack swizzle. */
3158 cfi->vals[op->dest.reg].base = CFI_SP_INDIRECT;
3159 cfi->vals[op->dest.reg].offset = cfa->offset;
3160 }
3161
3162 break;
3163
3164 case OP_DEST_MEM:
3165 if (op->src.type != OP_SRC_POP && op->src.type != OP_SRC_POPF) {
3166 WARN_INSN(insn, "unknown stack-related memory operation");
3167 return -1;
3168 }
3169
3170 /* pop mem */
3171 cfi->stack_size -= 8;
3172 if (cfa->base == CFI_SP)
3173 cfa->offset -= 8;
3174
3175 break;
3176
3177 default:
3178 WARN_INSN(insn, "unknown stack-related instruction");
3179 return -1;
3180 }
3181
3182 return 0;
3183 }
3184
3185 /*
3186 * The stack layouts of alternatives instructions can sometimes diverge when
3187 * they have stack modifications. That's fine as long as the potential stack
3188 * layouts don't conflict at any given potential instruction boundary.
3189 *
3190 * Flatten the CFIs of the different alternative code streams (both original
3191 * and replacement) into a single shared CFI array which can be used to detect
3192 * conflicts and nicely feed a linear array of ORC entries to the unwinder.
3193 */
propagate_alt_cfi(struct objtool_file * file,struct instruction * insn)3194 static int propagate_alt_cfi(struct objtool_file *file, struct instruction *insn)
3195 {
3196 struct cfi_state **alt_cfi;
3197 int group_off;
3198
3199 if (!insn->alt_group)
3200 return 0;
3201
3202 if (!insn->cfi) {
3203 WARN("CFI missing");
3204 return -1;
3205 }
3206
3207 alt_cfi = insn->alt_group->cfi;
3208 group_off = insn->offset - insn->alt_group->first_insn->offset;
3209
3210 if (!alt_cfi[group_off]) {
3211 alt_cfi[group_off] = insn->cfi;
3212 } else {
3213 if (cficmp(alt_cfi[group_off], insn->cfi)) {
3214 struct alt_group *orig_group = insn->alt_group->orig_group ?: insn->alt_group;
3215 struct instruction *orig = orig_group->first_insn;
3216 WARN_INSN(orig, "stack layout conflict in alternatives: %s",
3217 offstr(insn->sec, insn->offset));
3218 return -1;
3219 }
3220 }
3221
3222 return 0;
3223 }
3224
handle_insn_ops(struct instruction * insn,struct instruction * next_insn,struct insn_state * state)3225 static int handle_insn_ops(struct instruction *insn,
3226 struct instruction *next_insn,
3227 struct insn_state *state)
3228 {
3229 struct stack_op *op;
3230 int ret;
3231
3232 for (op = insn->stack_ops; op; op = op->next) {
3233
3234 ret = update_cfi_state(insn, next_insn, &state->cfi, op);
3235 if (ret)
3236 return ret;
3237
3238 if (!opts.uaccess || !insn->alt_group)
3239 continue;
3240
3241 if (op->dest.type == OP_DEST_PUSHF) {
3242 if (!state->uaccess_stack) {
3243 state->uaccess_stack = 1;
3244 } else if (state->uaccess_stack >> 31) {
3245 WARN_INSN(insn, "PUSHF stack exhausted");
3246 return 1;
3247 }
3248 state->uaccess_stack <<= 1;
3249 state->uaccess_stack |= state->uaccess;
3250 }
3251
3252 if (op->src.type == OP_SRC_POPF) {
3253 if (state->uaccess_stack) {
3254 state->uaccess = state->uaccess_stack & 1;
3255 state->uaccess_stack >>= 1;
3256 if (state->uaccess_stack == 1)
3257 state->uaccess_stack = 0;
3258 }
3259 }
3260 }
3261
3262 return 0;
3263 }
3264
insn_cfi_match(struct instruction * insn,struct cfi_state * cfi2)3265 static bool insn_cfi_match(struct instruction *insn, struct cfi_state *cfi2)
3266 {
3267 struct cfi_state *cfi1 = insn->cfi;
3268 int i;
3269
3270 if (!cfi1) {
3271 WARN("CFI missing");
3272 return false;
3273 }
3274
3275 if (memcmp(&cfi1->cfa, &cfi2->cfa, sizeof(cfi1->cfa))) {
3276
3277 WARN_INSN(insn, "stack state mismatch: cfa1=%d%+d cfa2=%d%+d",
3278 cfi1->cfa.base, cfi1->cfa.offset,
3279 cfi2->cfa.base, cfi2->cfa.offset);
3280 return false;
3281
3282 }
3283
3284 if (memcmp(&cfi1->regs, &cfi2->regs, sizeof(cfi1->regs))) {
3285 for (i = 0; i < CFI_NUM_REGS; i++) {
3286
3287 if (!memcmp(&cfi1->regs[i], &cfi2->regs[i], sizeof(struct cfi_reg)))
3288 continue;
3289
3290 WARN_INSN(insn, "stack state mismatch: reg1[%d]=%d%+d reg2[%d]=%d%+d",
3291 i, cfi1->regs[i].base, cfi1->regs[i].offset,
3292 i, cfi2->regs[i].base, cfi2->regs[i].offset);
3293 }
3294 return false;
3295 }
3296
3297 if (cfi1->type != cfi2->type) {
3298
3299 WARN_INSN(insn, "stack state mismatch: type1=%d type2=%d",
3300 cfi1->type, cfi2->type);
3301 return false;
3302 }
3303
3304 if (cfi1->drap != cfi2->drap ||
3305 (cfi1->drap && cfi1->drap_reg != cfi2->drap_reg) ||
3306 (cfi1->drap && cfi1->drap_offset != cfi2->drap_offset)) {
3307
3308 WARN_INSN(insn, "stack state mismatch: drap1=%d(%d,%d) drap2=%d(%d,%d)",
3309 cfi1->drap, cfi1->drap_reg, cfi1->drap_offset,
3310 cfi2->drap, cfi2->drap_reg, cfi2->drap_offset);
3311 return false;
3312 }
3313
3314 return true;
3315 }
3316
func_uaccess_safe(struct symbol * func)3317 static inline bool func_uaccess_safe(struct symbol *func)
3318 {
3319 if (func)
3320 return func->uaccess_safe;
3321
3322 return false;
3323 }
3324
call_dest_name(struct instruction * insn)3325 static inline const char *call_dest_name(struct instruction *insn)
3326 {
3327 static char pvname[19];
3328 struct reloc *reloc;
3329 int idx;
3330
3331 if (insn_call_dest(insn))
3332 return insn_call_dest(insn)->name;
3333
3334 reloc = insn_reloc(NULL, insn);
3335 if (reloc && !strcmp(reloc->sym->name, "pv_ops")) {
3336 idx = (reloc_addend(reloc) / sizeof(void *));
3337 snprintf(pvname, sizeof(pvname), "pv_ops[%d]", idx);
3338 return pvname;
3339 }
3340
3341 return "{dynamic}";
3342 }
3343
pv_call_dest(struct objtool_file * file,struct instruction * insn)3344 static bool pv_call_dest(struct objtool_file *file, struct instruction *insn)
3345 {
3346 struct symbol *target;
3347 struct reloc *reloc;
3348 int idx;
3349
3350 reloc = insn_reloc(file, insn);
3351 if (!reloc || strcmp(reloc->sym->name, "pv_ops"))
3352 return false;
3353
3354 idx = (arch_dest_reloc_offset(reloc_addend(reloc)) / sizeof(void *));
3355
3356 if (file->pv_ops[idx].clean)
3357 return true;
3358
3359 file->pv_ops[idx].clean = true;
3360
3361 list_for_each_entry(target, &file->pv_ops[idx].targets, pv_target) {
3362 if (!target->sec->noinstr) {
3363 WARN("pv_ops[%d]: %s", idx, target->name);
3364 file->pv_ops[idx].clean = false;
3365 }
3366 }
3367
3368 return file->pv_ops[idx].clean;
3369 }
3370
noinstr_call_dest(struct objtool_file * file,struct instruction * insn,struct symbol * func)3371 static inline bool noinstr_call_dest(struct objtool_file *file,
3372 struct instruction *insn,
3373 struct symbol *func)
3374 {
3375 /*
3376 * We can't deal with indirect function calls at present;
3377 * assume they're instrumented.
3378 */
3379 if (!func) {
3380 if (file->pv_ops)
3381 return pv_call_dest(file, insn);
3382
3383 return false;
3384 }
3385
3386 /*
3387 * If the symbol is from a noinstr section; we good.
3388 */
3389 if (func->sec->noinstr)
3390 return true;
3391
3392 /*
3393 * If the symbol is a static_call trampoline, we can't tell.
3394 */
3395 if (func->static_call_tramp)
3396 return true;
3397
3398 /*
3399 * The __ubsan_handle_*() calls are like WARN(), they only happen when
3400 * something 'BAD' happened. At the risk of taking the machine down,
3401 * let them proceed to get the message out.
3402 */
3403 if (!strncmp(func->name, "__ubsan_handle_", 15))
3404 return true;
3405
3406 return false;
3407 }
3408
validate_call(struct objtool_file * file,struct instruction * insn,struct insn_state * state)3409 static int validate_call(struct objtool_file *file,
3410 struct instruction *insn,
3411 struct insn_state *state)
3412 {
3413 if (state->noinstr && state->instr <= 0 &&
3414 !noinstr_call_dest(file, insn, insn_call_dest(insn))) {
3415 WARN_INSN(insn, "call to %s() leaves .noinstr.text section", call_dest_name(insn));
3416 return 1;
3417 }
3418
3419 if (state->uaccess && !func_uaccess_safe(insn_call_dest(insn))) {
3420 WARN_INSN(insn, "call to %s() with UACCESS enabled", call_dest_name(insn));
3421 return 1;
3422 }
3423
3424 if (state->df) {
3425 WARN_INSN(insn, "call to %s() with DF set", call_dest_name(insn));
3426 return 1;
3427 }
3428
3429 return 0;
3430 }
3431
validate_sibling_call(struct objtool_file * file,struct instruction * insn,struct insn_state * state)3432 static int validate_sibling_call(struct objtool_file *file,
3433 struct instruction *insn,
3434 struct insn_state *state)
3435 {
3436 if (insn_func(insn) && has_modified_stack_frame(insn, state)) {
3437 WARN_INSN(insn, "sibling call from callable instruction with modified stack frame");
3438 return 1;
3439 }
3440
3441 return validate_call(file, insn, state);
3442 }
3443
validate_return(struct symbol * func,struct instruction * insn,struct insn_state * state)3444 static int validate_return(struct symbol *func, struct instruction *insn, struct insn_state *state)
3445 {
3446 if (state->noinstr && state->instr > 0) {
3447 WARN_INSN(insn, "return with instrumentation enabled");
3448 return 1;
3449 }
3450
3451 if (state->uaccess && !func_uaccess_safe(func)) {
3452 WARN_INSN(insn, "return with UACCESS enabled");
3453 return 1;
3454 }
3455
3456 if (!state->uaccess && func_uaccess_safe(func)) {
3457 WARN_INSN(insn, "return with UACCESS disabled from a UACCESS-safe function");
3458 return 1;
3459 }
3460
3461 if (state->df) {
3462 WARN_INSN(insn, "return with DF set");
3463 return 1;
3464 }
3465
3466 if (func && has_modified_stack_frame(insn, state)) {
3467 WARN_INSN(insn, "return with modified stack frame");
3468 return 1;
3469 }
3470
3471 if (state->cfi.bp_scratch) {
3472 WARN_INSN(insn, "BP used as a scratch register");
3473 return 1;
3474 }
3475
3476 return 0;
3477 }
3478
next_insn_to_validate(struct objtool_file * file,struct instruction * insn)3479 static struct instruction *next_insn_to_validate(struct objtool_file *file,
3480 struct instruction *insn)
3481 {
3482 struct alt_group *alt_group = insn->alt_group;
3483
3484 /*
3485 * Simulate the fact that alternatives are patched in-place. When the
3486 * end of a replacement alt_group is reached, redirect objtool flow to
3487 * the end of the original alt_group.
3488 *
3489 * insn->alts->insn -> alt_group->first_insn
3490 * ...
3491 * alt_group->last_insn
3492 * [alt_group->nop] -> next(orig_group->last_insn)
3493 */
3494 if (alt_group) {
3495 if (alt_group->nop) {
3496 /* ->nop implies ->orig_group */
3497 if (insn == alt_group->last_insn)
3498 return alt_group->nop;
3499 if (insn == alt_group->nop)
3500 goto next_orig;
3501 }
3502 if (insn == alt_group->last_insn && alt_group->orig_group)
3503 goto next_orig;
3504 }
3505
3506 return next_insn_same_sec(file, insn);
3507
3508 next_orig:
3509 return next_insn_same_sec(file, alt_group->orig_group->last_insn);
3510 }
3511
skip_alt_group(struct instruction * insn)3512 static bool skip_alt_group(struct instruction *insn)
3513 {
3514 struct instruction *alt_insn = insn->alts ? insn->alts->insn : NULL;
3515
3516 /* ANNOTATE_IGNORE_ALTERNATIVE */
3517 if (insn->alt_group && insn->alt_group->ignore)
3518 return true;
3519
3520 /*
3521 * For NOP patched with CLAC/STAC, only follow the latter to avoid
3522 * impossible code paths combining patched CLAC with unpatched STAC
3523 * or vice versa.
3524 *
3525 * ANNOTATE_IGNORE_ALTERNATIVE could have been used here, but Linus
3526 * requested not to do that to avoid hurting .s file readability
3527 * around CLAC/STAC alternative sites.
3528 */
3529
3530 if (!alt_insn)
3531 return false;
3532
3533 /* Don't override ASM_{CLAC,STAC}_UNSAFE */
3534 if (alt_insn->alt_group && alt_insn->alt_group->ignore)
3535 return false;
3536
3537 return alt_insn->type == INSN_CLAC || alt_insn->type == INSN_STAC;
3538 }
3539
3540 /*
3541 * Follow the branch starting at the given instruction, and recursively follow
3542 * any other branches (jumps). Meanwhile, track the frame pointer state at
3543 * each instruction and validate all the rules described in
3544 * tools/objtool/Documentation/objtool.txt.
3545 */
validate_branch(struct objtool_file * file,struct symbol * func,struct instruction * insn,struct insn_state state)3546 static int validate_branch(struct objtool_file *file, struct symbol *func,
3547 struct instruction *insn, struct insn_state state)
3548 {
3549 struct alternative *alt;
3550 struct instruction *next_insn, *prev_insn = NULL;
3551 struct section *sec;
3552 u8 visited;
3553 int ret;
3554
3555 if (func && func->ignore)
3556 return 0;
3557
3558 sec = insn->sec;
3559
3560 while (1) {
3561 next_insn = next_insn_to_validate(file, insn);
3562
3563 if (func && insn_func(insn) && func != insn_func(insn)->pfunc) {
3564 /* Ignore KCFI type preambles, which always fall through */
3565 if (!strncmp(func->name, "__cfi_", 6) ||
3566 !strncmp(func->name, "__pfx_", 6))
3567 return 0;
3568
3569 if (file->ignore_unreachables)
3570 return 0;
3571
3572 WARN("%s() falls through to next function %s()",
3573 func->name, insn_func(insn)->name);
3574 func->warned = 1;
3575
3576 return 1;
3577 }
3578
3579 visited = VISITED_BRANCH << state.uaccess;
3580 if (insn->visited & VISITED_BRANCH_MASK) {
3581 if (!insn->hint && !insn_cfi_match(insn, &state.cfi))
3582 return 1;
3583
3584 if (insn->visited & visited)
3585 return 0;
3586 } else {
3587 nr_insns_visited++;
3588 }
3589
3590 if (state.noinstr)
3591 state.instr += insn->instr;
3592
3593 if (insn->hint) {
3594 if (insn->restore) {
3595 struct instruction *save_insn, *i;
3596
3597 i = insn;
3598 save_insn = NULL;
3599
3600 sym_for_each_insn_continue_reverse(file, func, i) {
3601 if (i->save) {
3602 save_insn = i;
3603 break;
3604 }
3605 }
3606
3607 if (!save_insn) {
3608 WARN_INSN(insn, "no corresponding CFI save for CFI restore");
3609 return 1;
3610 }
3611
3612 if (!save_insn->visited) {
3613 /*
3614 * If the restore hint insn is at the
3615 * beginning of a basic block and was
3616 * branched to from elsewhere, and the
3617 * save insn hasn't been visited yet,
3618 * defer following this branch for now.
3619 * It will be seen later via the
3620 * straight-line path.
3621 */
3622 if (!prev_insn)
3623 return 0;
3624
3625 WARN_INSN(insn, "objtool isn't smart enough to handle this CFI save/restore combo");
3626 return 1;
3627 }
3628
3629 insn->cfi = save_insn->cfi;
3630 nr_cfi_reused++;
3631 }
3632
3633 state.cfi = *insn->cfi;
3634 } else {
3635 /* XXX track if we actually changed state.cfi */
3636
3637 if (prev_insn && !cficmp(prev_insn->cfi, &state.cfi)) {
3638 insn->cfi = prev_insn->cfi;
3639 nr_cfi_reused++;
3640 } else {
3641 insn->cfi = cfi_hash_find_or_add(&state.cfi);
3642 }
3643 }
3644
3645 insn->visited |= visited;
3646
3647 if (propagate_alt_cfi(file, insn))
3648 return 1;
3649
3650 if (insn->alts) {
3651 for (alt = insn->alts; alt; alt = alt->next) {
3652 ret = validate_branch(file, func, alt->insn, state);
3653 if (ret) {
3654 BT_INSN(insn, "(alt)");
3655 return ret;
3656 }
3657 }
3658 }
3659
3660 if (skip_alt_group(insn))
3661 return 0;
3662
3663 if (handle_insn_ops(insn, next_insn, &state))
3664 return 1;
3665
3666 switch (insn->type) {
3667
3668 case INSN_RETURN:
3669 return validate_return(func, insn, &state);
3670
3671 case INSN_CALL:
3672 case INSN_CALL_DYNAMIC:
3673 ret = validate_call(file, insn, &state);
3674 if (ret)
3675 return ret;
3676
3677 if (opts.stackval && func && !is_special_call(insn) &&
3678 !has_valid_stack_frame(&state)) {
3679 WARN_INSN(insn, "call without frame pointer save/setup");
3680 return 1;
3681 }
3682
3683 break;
3684
3685 case INSN_JUMP_CONDITIONAL:
3686 case INSN_JUMP_UNCONDITIONAL:
3687 if (is_sibling_call(insn)) {
3688 ret = validate_sibling_call(file, insn, &state);
3689 if (ret)
3690 return ret;
3691
3692 } else if (insn->jump_dest) {
3693 ret = validate_branch(file, func,
3694 insn->jump_dest, state);
3695 if (ret) {
3696 BT_INSN(insn, "(branch)");
3697 return ret;
3698 }
3699 }
3700
3701 if (insn->type == INSN_JUMP_UNCONDITIONAL)
3702 return 0;
3703
3704 break;
3705
3706 case INSN_JUMP_DYNAMIC:
3707 case INSN_JUMP_DYNAMIC_CONDITIONAL:
3708 if (is_sibling_call(insn)) {
3709 ret = validate_sibling_call(file, insn, &state);
3710 if (ret)
3711 return ret;
3712 }
3713
3714 if (insn->type == INSN_JUMP_DYNAMIC)
3715 return 0;
3716
3717 break;
3718
3719 case INSN_SYSCALL:
3720 if (func && (!next_insn || !next_insn->hint)) {
3721 WARN_INSN(insn, "unsupported instruction in callable function");
3722 return 1;
3723 }
3724
3725 break;
3726
3727 case INSN_SYSRET:
3728 if (func && (!next_insn || !next_insn->hint)) {
3729 WARN_INSN(insn, "unsupported instruction in callable function");
3730 return 1;
3731 }
3732
3733 return 0;
3734
3735 case INSN_STAC:
3736 if (!opts.uaccess)
3737 break;
3738
3739 if (state.uaccess) {
3740 WARN_INSN(insn, "recursive UACCESS enable");
3741 return 1;
3742 }
3743
3744 state.uaccess = true;
3745 break;
3746
3747 case INSN_CLAC:
3748 if (!opts.uaccess)
3749 break;
3750
3751 if (!state.uaccess && func) {
3752 WARN_INSN(insn, "redundant UACCESS disable");
3753 return 1;
3754 }
3755
3756 if (func_uaccess_safe(func) && !state.uaccess_stack) {
3757 WARN_INSN(insn, "UACCESS-safe disables UACCESS");
3758 return 1;
3759 }
3760
3761 state.uaccess = false;
3762 break;
3763
3764 case INSN_STD:
3765 if (state.df) {
3766 WARN_INSN(insn, "recursive STD");
3767 return 1;
3768 }
3769
3770 state.df = true;
3771 break;
3772
3773 case INSN_CLD:
3774 if (!state.df && func) {
3775 WARN_INSN(insn, "redundant CLD");
3776 return 1;
3777 }
3778
3779 state.df = false;
3780 break;
3781
3782 default:
3783 break;
3784 }
3785
3786 if (insn->dead_end)
3787 return 0;
3788
3789 if (!next_insn) {
3790 if (state.cfi.cfa.base == CFI_UNDEFINED)
3791 return 0;
3792 if (file->ignore_unreachables)
3793 return 0;
3794
3795 WARN("%s%sunexpected end of section %s",
3796 func ? func->name : "", func ? "(): " : "",
3797 sec->name);
3798 return 1;
3799 }
3800
3801 prev_insn = insn;
3802 insn = next_insn;
3803 }
3804
3805 return 0;
3806 }
3807
validate_unwind_hint(struct objtool_file * file,struct instruction * insn,struct insn_state * state)3808 static int validate_unwind_hint(struct objtool_file *file,
3809 struct instruction *insn,
3810 struct insn_state *state)
3811 {
3812 if (insn->hint && !insn->visited) {
3813 int ret = validate_branch(file, insn_func(insn), insn, *state);
3814 if (ret)
3815 BT_INSN(insn, "<=== (hint)");
3816 return ret;
3817 }
3818
3819 return 0;
3820 }
3821
validate_unwind_hints(struct objtool_file * file,struct section * sec)3822 static int validate_unwind_hints(struct objtool_file *file, struct section *sec)
3823 {
3824 struct instruction *insn;
3825 struct insn_state state;
3826 int warnings = 0;
3827
3828 if (!file->hints)
3829 return 0;
3830
3831 init_insn_state(file, &state, sec);
3832
3833 if (sec) {
3834 sec_for_each_insn(file, sec, insn)
3835 warnings += validate_unwind_hint(file, insn, &state);
3836 } else {
3837 for_each_insn(file, insn)
3838 warnings += validate_unwind_hint(file, insn, &state);
3839 }
3840
3841 return warnings;
3842 }
3843
3844 /*
3845 * Validate rethunk entry constraint: must untrain RET before the first RET.
3846 *
3847 * Follow every branch (intra-function) and ensure VALIDATE_UNRET_END comes
3848 * before an actual RET instruction.
3849 */
validate_unret(struct objtool_file * file,struct instruction * insn)3850 static int validate_unret(struct objtool_file *file, struct instruction *insn)
3851 {
3852 struct instruction *next, *dest;
3853 int ret;
3854
3855 for (;;) {
3856 next = next_insn_to_validate(file, insn);
3857
3858 if (insn->visited & VISITED_UNRET)
3859 return 0;
3860
3861 insn->visited |= VISITED_UNRET;
3862
3863 if (insn->alts) {
3864 struct alternative *alt;
3865 for (alt = insn->alts; alt; alt = alt->next) {
3866 ret = validate_unret(file, alt->insn);
3867 if (ret) {
3868 BT_INSN(insn, "(alt)");
3869 return ret;
3870 }
3871 }
3872 }
3873
3874 switch (insn->type) {
3875
3876 case INSN_CALL_DYNAMIC:
3877 case INSN_JUMP_DYNAMIC:
3878 case INSN_JUMP_DYNAMIC_CONDITIONAL:
3879 WARN_INSN(insn, "early indirect call");
3880 return 1;
3881
3882 case INSN_JUMP_UNCONDITIONAL:
3883 case INSN_JUMP_CONDITIONAL:
3884 if (!is_sibling_call(insn)) {
3885 if (!insn->jump_dest) {
3886 WARN_INSN(insn, "unresolved jump target after linking?!?");
3887 return 1;
3888 }
3889 ret = validate_unret(file, insn->jump_dest);
3890 if (ret) {
3891 BT_INSN(insn, "(branch%s)",
3892 insn->type == INSN_JUMP_CONDITIONAL ? "-cond" : "");
3893 return ret;
3894 }
3895
3896 if (insn->type == INSN_JUMP_UNCONDITIONAL)
3897 return 0;
3898
3899 break;
3900 }
3901
3902 /* fallthrough */
3903 case INSN_CALL:
3904 dest = find_insn(file, insn_call_dest(insn)->sec,
3905 insn_call_dest(insn)->offset);
3906 if (!dest) {
3907 WARN("Unresolved function after linking!?: %s",
3908 insn_call_dest(insn)->name);
3909 return 1;
3910 }
3911
3912 ret = validate_unret(file, dest);
3913 if (ret) {
3914 BT_INSN(insn, "(call)");
3915 return ret;
3916 }
3917 /*
3918 * If a call returns without error, it must have seen UNTRAIN_RET.
3919 * Therefore any non-error return is a success.
3920 */
3921 return 0;
3922
3923 case INSN_RETURN:
3924 WARN_INSN(insn, "RET before UNTRAIN");
3925 return 1;
3926
3927 case INSN_SYSCALL:
3928 break;
3929
3930 case INSN_SYSRET:
3931 return 0;
3932
3933 case INSN_NOP:
3934 if (insn->retpoline_safe)
3935 return 0;
3936 break;
3937
3938 default:
3939 break;
3940 }
3941
3942 if (insn->dead_end)
3943 return 0;
3944
3945 if (!next) {
3946 WARN_INSN(insn, "teh end!");
3947 return 1;
3948 }
3949 insn = next;
3950 }
3951
3952 return 0;
3953 }
3954
3955 /*
3956 * Validate that all branches starting at VALIDATE_UNRET_BEGIN encounter
3957 * VALIDATE_UNRET_END before RET.
3958 */
validate_unrets(struct objtool_file * file)3959 static int validate_unrets(struct objtool_file *file)
3960 {
3961 struct instruction *insn;
3962 int warnings = 0;
3963
3964 for_each_insn(file, insn) {
3965 if (!insn->unret)
3966 continue;
3967
3968 warnings += validate_unret(file, insn);
3969 }
3970
3971 return warnings;
3972 }
3973
validate_retpoline(struct objtool_file * file)3974 static int validate_retpoline(struct objtool_file *file)
3975 {
3976 struct instruction *insn;
3977 int warnings = 0;
3978
3979 for_each_insn(file, insn) {
3980 if (insn->type != INSN_JUMP_DYNAMIC &&
3981 insn->type != INSN_CALL_DYNAMIC &&
3982 insn->type != INSN_RETURN)
3983 continue;
3984
3985 if (insn->retpoline_safe)
3986 continue;
3987
3988 if (insn->sec->init)
3989 continue;
3990
3991 if (insn->type == INSN_RETURN) {
3992 if (opts.rethunk) {
3993 WARN_INSN(insn, "'naked' return found in MITIGATION_RETHUNK build");
3994 warnings++;
3995 }
3996 continue;
3997 }
3998
3999 WARN_INSN(insn, "indirect %s found in MITIGATION_RETPOLINE build",
4000 insn->type == INSN_JUMP_DYNAMIC ? "jump" : "call");
4001 warnings++;
4002 }
4003
4004 return warnings;
4005 }
4006
is_kasan_insn(struct instruction * insn)4007 static bool is_kasan_insn(struct instruction *insn)
4008 {
4009 return (insn->type == INSN_CALL &&
4010 !strcmp(insn_call_dest(insn)->name, "__asan_handle_no_return"));
4011 }
4012
is_ubsan_insn(struct instruction * insn)4013 static bool is_ubsan_insn(struct instruction *insn)
4014 {
4015 return (insn->type == INSN_CALL &&
4016 !strcmp(insn_call_dest(insn)->name,
4017 "__ubsan_handle_builtin_unreachable"));
4018 }
4019
ignore_unreachable_insn(struct objtool_file * file,struct instruction * insn)4020 static bool ignore_unreachable_insn(struct objtool_file *file, struct instruction *insn)
4021 {
4022 struct symbol *func = insn_func(insn);
4023 struct instruction *prev_insn;
4024 int i;
4025
4026 if (insn->type == INSN_NOP || insn->type == INSN_TRAP || (func && func->ignore))
4027 return true;
4028
4029 /*
4030 * Ignore alternative replacement instructions. This can happen
4031 * when a whitelisted function uses one of the ALTERNATIVE macros.
4032 */
4033 if (!strcmp(insn->sec->name, ".altinstr_replacement") ||
4034 !strcmp(insn->sec->name, ".altinstr_aux"))
4035 return true;
4036
4037 /*
4038 * Whole archive runs might encounter dead code from weak symbols.
4039 * This is where the linker will have dropped the weak symbol in
4040 * favour of a regular symbol, but leaves the code in place.
4041 *
4042 * In this case we'll find a piece of code (whole function) that is not
4043 * covered by a !section symbol. Ignore them.
4044 */
4045 if (opts.link && !func) {
4046 int size = find_symbol_hole_containing(insn->sec, insn->offset);
4047 unsigned long end = insn->offset + size;
4048
4049 if (!size) /* not a hole */
4050 return false;
4051
4052 if (size < 0) /* hole until the end */
4053 return true;
4054
4055 sec_for_each_insn_continue(file, insn) {
4056 /*
4057 * If we reach a visited instruction at or before the
4058 * end of the hole, ignore the unreachable.
4059 */
4060 if (insn->visited)
4061 return true;
4062
4063 if (insn->offset >= end)
4064 break;
4065
4066 /*
4067 * If this hole jumps to a .cold function, mark it ignore too.
4068 */
4069 if (insn->jump_dest && insn_func(insn->jump_dest) &&
4070 strstr(insn_func(insn->jump_dest)->name, ".cold")) {
4071 insn_func(insn->jump_dest)->ignore = true;
4072 }
4073 }
4074
4075 return false;
4076 }
4077
4078 if (!func)
4079 return false;
4080
4081 if (func->static_call_tramp)
4082 return true;
4083
4084 /*
4085 * CONFIG_UBSAN_TRAP inserts a UD2 when it sees
4086 * __builtin_unreachable(). The BUG() macro has an unreachable() after
4087 * the UD2, which causes GCC's undefined trap logic to emit another UD2
4088 * (or occasionally a JMP to UD2).
4089 *
4090 * It may also insert a UD2 after calling a __noreturn function.
4091 */
4092 prev_insn = prev_insn_same_sec(file, insn);
4093 if (prev_insn && prev_insn->dead_end &&
4094 (insn->type == INSN_BUG ||
4095 (insn->type == INSN_JUMP_UNCONDITIONAL &&
4096 insn->jump_dest && insn->jump_dest->type == INSN_BUG)))
4097 return true;
4098
4099 /*
4100 * Check if this (or a subsequent) instruction is related to
4101 * CONFIG_UBSAN or CONFIG_KASAN.
4102 *
4103 * End the search at 5 instructions to avoid going into the weeds.
4104 */
4105 for (i = 0; i < 5; i++) {
4106
4107 if (is_kasan_insn(insn) || is_ubsan_insn(insn))
4108 return true;
4109
4110 if (insn->type == INSN_JUMP_UNCONDITIONAL) {
4111 if (insn->jump_dest &&
4112 insn_func(insn->jump_dest) == func) {
4113 insn = insn->jump_dest;
4114 continue;
4115 }
4116
4117 break;
4118 }
4119
4120 if (insn->offset + insn->len >= func->offset + func->len)
4121 break;
4122
4123 insn = next_insn_same_sec(file, insn);
4124 }
4125
4126 return false;
4127 }
4128
add_prefix_symbol(struct objtool_file * file,struct symbol * func)4129 static int add_prefix_symbol(struct objtool_file *file, struct symbol *func)
4130 {
4131 struct instruction *insn, *prev;
4132 struct cfi_state *cfi;
4133
4134 insn = find_insn(file, func->sec, func->offset);
4135 if (!insn)
4136 return -1;
4137
4138 for (prev = prev_insn_same_sec(file, insn);
4139 prev;
4140 prev = prev_insn_same_sec(file, prev)) {
4141 u64 offset;
4142
4143 if (prev->type != INSN_NOP)
4144 return -1;
4145
4146 offset = func->offset - prev->offset;
4147
4148 if (offset > opts.prefix)
4149 return -1;
4150
4151 if (offset < opts.prefix)
4152 continue;
4153
4154 elf_create_prefix_symbol(file->elf, func, opts.prefix);
4155 break;
4156 }
4157
4158 if (!prev)
4159 return -1;
4160
4161 if (!insn->cfi) {
4162 /*
4163 * This can happen if stack validation isn't enabled or the
4164 * function is annotated with STACK_FRAME_NON_STANDARD.
4165 */
4166 return 0;
4167 }
4168
4169 /* Propagate insn->cfi to the prefix code */
4170 cfi = cfi_hash_find_or_add(insn->cfi);
4171 for (; prev != insn; prev = next_insn_same_sec(file, prev))
4172 prev->cfi = cfi;
4173
4174 return 0;
4175 }
4176
add_prefix_symbols(struct objtool_file * file)4177 static int add_prefix_symbols(struct objtool_file *file)
4178 {
4179 struct section *sec;
4180 struct symbol *func;
4181
4182 for_each_sec(file, sec) {
4183 if (!(sec->sh.sh_flags & SHF_EXECINSTR))
4184 continue;
4185
4186 sec_for_each_sym(sec, func) {
4187 if (func->type != STT_FUNC)
4188 continue;
4189
4190 add_prefix_symbol(file, func);
4191 }
4192 }
4193
4194 return 0;
4195 }
4196
validate_symbol(struct objtool_file * file,struct section * sec,struct symbol * sym,struct insn_state * state)4197 static int validate_symbol(struct objtool_file *file, struct section *sec,
4198 struct symbol *sym, struct insn_state *state)
4199 {
4200 struct instruction *insn;
4201 int ret;
4202
4203 if (!sym->len) {
4204 WARN("%s() is missing an ELF size annotation", sym->name);
4205 return 1;
4206 }
4207
4208 if (sym->pfunc != sym || sym->alias != sym)
4209 return 0;
4210
4211 insn = find_insn(file, sec, sym->offset);
4212 if (!insn || insn->visited)
4213 return 0;
4214
4215 if (opts.uaccess)
4216 state->uaccess = sym->uaccess_safe;
4217
4218 ret = validate_branch(file, insn_func(insn), insn, *state);
4219 if (ret)
4220 BT_INSN(insn, "<=== (sym)");
4221 return ret;
4222 }
4223
validate_section(struct objtool_file * file,struct section * sec)4224 static int validate_section(struct objtool_file *file, struct section *sec)
4225 {
4226 struct insn_state state;
4227 struct symbol *func;
4228 int warnings = 0;
4229
4230 sec_for_each_sym(sec, func) {
4231 if (func->type != STT_FUNC)
4232 continue;
4233
4234 init_insn_state(file, &state, sec);
4235 set_func_state(&state.cfi);
4236
4237 warnings += validate_symbol(file, sec, func, &state);
4238 }
4239
4240 return warnings;
4241 }
4242
validate_noinstr_sections(struct objtool_file * file)4243 static int validate_noinstr_sections(struct objtool_file *file)
4244 {
4245 struct section *sec;
4246 int warnings = 0;
4247
4248 sec = find_section_by_name(file->elf, ".noinstr.text");
4249 if (sec) {
4250 warnings += validate_section(file, sec);
4251 warnings += validate_unwind_hints(file, sec);
4252 }
4253
4254 sec = find_section_by_name(file->elf, ".entry.text");
4255 if (sec) {
4256 warnings += validate_section(file, sec);
4257 warnings += validate_unwind_hints(file, sec);
4258 }
4259
4260 sec = find_section_by_name(file->elf, ".cpuidle.text");
4261 if (sec) {
4262 warnings += validate_section(file, sec);
4263 warnings += validate_unwind_hints(file, sec);
4264 }
4265
4266 return warnings;
4267 }
4268
validate_functions(struct objtool_file * file)4269 static int validate_functions(struct objtool_file *file)
4270 {
4271 struct section *sec;
4272 int warnings = 0;
4273
4274 for_each_sec(file, sec) {
4275 if (!(sec->sh.sh_flags & SHF_EXECINSTR))
4276 continue;
4277
4278 warnings += validate_section(file, sec);
4279 }
4280
4281 return warnings;
4282 }
4283
mark_endbr_used(struct instruction * insn)4284 static void mark_endbr_used(struct instruction *insn)
4285 {
4286 if (!list_empty(&insn->call_node))
4287 list_del_init(&insn->call_node);
4288 }
4289
noendbr_range(struct objtool_file * file,struct instruction * insn)4290 static bool noendbr_range(struct objtool_file *file, struct instruction *insn)
4291 {
4292 struct symbol *sym = find_symbol_containing(insn->sec, insn->offset-1);
4293 struct instruction *first;
4294
4295 if (!sym)
4296 return false;
4297
4298 first = find_insn(file, sym->sec, sym->offset);
4299 if (!first)
4300 return false;
4301
4302 if (first->type != INSN_ENDBR && !first->noendbr)
4303 return false;
4304
4305 return insn->offset == sym->offset + sym->len;
4306 }
4307
__validate_ibt_insn(struct objtool_file * file,struct instruction * insn,struct instruction * dest)4308 static int __validate_ibt_insn(struct objtool_file *file, struct instruction *insn,
4309 struct instruction *dest)
4310 {
4311 if (dest->type == INSN_ENDBR) {
4312 mark_endbr_used(dest);
4313 return 0;
4314 }
4315
4316 if (insn_func(dest) && insn_func(insn) &&
4317 insn_func(dest)->pfunc == insn_func(insn)->pfunc) {
4318 /*
4319 * Anything from->to self is either _THIS_IP_ or
4320 * IRET-to-self.
4321 *
4322 * There is no sane way to annotate _THIS_IP_ since the
4323 * compiler treats the relocation as a constant and is
4324 * happy to fold in offsets, skewing any annotation we
4325 * do, leading to vast amounts of false-positives.
4326 *
4327 * There's also compiler generated _THIS_IP_ through
4328 * KCOV and such which we have no hope of annotating.
4329 *
4330 * As such, blanket accept self-references without
4331 * issue.
4332 */
4333 return 0;
4334 }
4335
4336 /*
4337 * Accept anything ANNOTATE_NOENDBR.
4338 */
4339 if (dest->noendbr)
4340 return 0;
4341
4342 /*
4343 * Accept if this is the instruction after a symbol
4344 * that is (no)endbr -- typical code-range usage.
4345 */
4346 if (noendbr_range(file, dest))
4347 return 0;
4348
4349 WARN_INSN(insn, "relocation to !ENDBR: %s", offstr(dest->sec, dest->offset));
4350 return 1;
4351 }
4352
validate_ibt_insn(struct objtool_file * file,struct instruction * insn)4353 static int validate_ibt_insn(struct objtool_file *file, struct instruction *insn)
4354 {
4355 struct instruction *dest;
4356 struct reloc *reloc;
4357 unsigned long off;
4358 int warnings = 0;
4359
4360 /*
4361 * Looking for function pointer load relocations. Ignore
4362 * direct/indirect branches:
4363 */
4364 switch (insn->type) {
4365
4366 case INSN_CALL:
4367 case INSN_CALL_DYNAMIC:
4368 case INSN_JUMP_CONDITIONAL:
4369 case INSN_JUMP_UNCONDITIONAL:
4370 case INSN_JUMP_DYNAMIC:
4371 case INSN_JUMP_DYNAMIC_CONDITIONAL:
4372 case INSN_RETURN:
4373 case INSN_NOP:
4374 return 0;
4375
4376 case INSN_LEA_RIP:
4377 if (!insn_reloc(file, insn)) {
4378 /* local function pointer reference without reloc */
4379
4380 off = arch_jump_destination(insn);
4381
4382 dest = find_insn(file, insn->sec, off);
4383 if (!dest) {
4384 WARN_INSN(insn, "corrupt function pointer reference");
4385 return 1;
4386 }
4387
4388 return __validate_ibt_insn(file, insn, dest);
4389 }
4390 break;
4391
4392 default:
4393 break;
4394 }
4395
4396 for (reloc = insn_reloc(file, insn);
4397 reloc;
4398 reloc = find_reloc_by_dest_range(file->elf, insn->sec,
4399 reloc_offset(reloc) + 1,
4400 (insn->offset + insn->len) - (reloc_offset(reloc) + 1))) {
4401
4402 off = reloc->sym->offset;
4403 if (reloc_type(reloc) == R_X86_64_PC32 ||
4404 reloc_type(reloc) == R_X86_64_PLT32)
4405 off += arch_dest_reloc_offset(reloc_addend(reloc));
4406 else
4407 off += reloc_addend(reloc);
4408
4409 dest = find_insn(file, reloc->sym->sec, off);
4410 if (!dest)
4411 continue;
4412
4413 warnings += __validate_ibt_insn(file, insn, dest);
4414 }
4415
4416 return warnings;
4417 }
4418
validate_ibt_data_reloc(struct objtool_file * file,struct reloc * reloc)4419 static int validate_ibt_data_reloc(struct objtool_file *file,
4420 struct reloc *reloc)
4421 {
4422 struct instruction *dest;
4423
4424 dest = find_insn(file, reloc->sym->sec,
4425 reloc->sym->offset + reloc_addend(reloc));
4426 if (!dest)
4427 return 0;
4428
4429 if (dest->type == INSN_ENDBR) {
4430 mark_endbr_used(dest);
4431 return 0;
4432 }
4433
4434 if (dest->noendbr)
4435 return 0;
4436
4437 WARN_FUNC(reloc->sec->base, reloc_offset(reloc),
4438 "data relocation to !ENDBR: %s", offstr(dest->sec, dest->offset));
4439
4440 return 1;
4441 }
4442
4443 /*
4444 * Validate IBT rules and remove used ENDBR instructions from the seal list.
4445 * Unused ENDBR instructions will be annotated for sealing (i.e., replaced with
4446 * NOPs) later, in create_ibt_endbr_seal_sections().
4447 */
validate_ibt(struct objtool_file * file)4448 static int validate_ibt(struct objtool_file *file)
4449 {
4450 struct section *sec;
4451 struct reloc *reloc;
4452 struct instruction *insn;
4453 int warnings = 0;
4454
4455 for_each_insn(file, insn)
4456 warnings += validate_ibt_insn(file, insn);
4457
4458 for_each_sec(file, sec) {
4459
4460 /* Already done by validate_ibt_insn() */
4461 if (sec->sh.sh_flags & SHF_EXECINSTR)
4462 continue;
4463
4464 if (!sec->rsec)
4465 continue;
4466
4467 /*
4468 * These sections can reference text addresses, but not with
4469 * the intent to indirect branch to them.
4470 */
4471 if ((!strncmp(sec->name, ".discard", 8) &&
4472 strcmp(sec->name, ".discard.ibt_endbr_noseal")) ||
4473 !strncmp(sec->name, ".debug", 6) ||
4474 !strcmp(sec->name, ".altinstructions") ||
4475 !strcmp(sec->name, ".ibt_endbr_seal") ||
4476 !strcmp(sec->name, ".orc_unwind_ip") ||
4477 !strcmp(sec->name, ".parainstructions") ||
4478 !strcmp(sec->name, ".retpoline_sites") ||
4479 !strcmp(sec->name, ".smp_locks") ||
4480 !strcmp(sec->name, ".static_call_sites") ||
4481 !strcmp(sec->name, "_error_injection_whitelist") ||
4482 !strcmp(sec->name, "_kprobe_blacklist") ||
4483 !strcmp(sec->name, "__bug_table") ||
4484 !strcmp(sec->name, "__ex_table") ||
4485 !strcmp(sec->name, "__jump_table") ||
4486 !strcmp(sec->name, "__mcount_loc") ||
4487 !strcmp(sec->name, ".kcfi_traps") ||
4488 !strcmp(sec->name, ".llvm.call-graph-profile") ||
4489 !strcmp(sec->name, ".llvm_bb_addr_map") ||
4490 !strcmp(sec->name, "__tracepoints") ||
4491 strstr(sec->name, "__patchable_function_entries"))
4492 continue;
4493
4494 for_each_reloc(sec->rsec, reloc)
4495 warnings += validate_ibt_data_reloc(file, reloc);
4496 }
4497
4498 return warnings;
4499 }
4500
validate_sls(struct objtool_file * file)4501 static int validate_sls(struct objtool_file *file)
4502 {
4503 struct instruction *insn, *next_insn;
4504 int warnings = 0;
4505
4506 for_each_insn(file, insn) {
4507 next_insn = next_insn_same_sec(file, insn);
4508
4509 if (insn->retpoline_safe)
4510 continue;
4511
4512 switch (insn->type) {
4513 case INSN_RETURN:
4514 if (!next_insn || next_insn->type != INSN_TRAP) {
4515 WARN_INSN(insn, "missing int3 after ret");
4516 warnings++;
4517 }
4518
4519 break;
4520 case INSN_JUMP_DYNAMIC:
4521 if (!next_insn || next_insn->type != INSN_TRAP) {
4522 WARN_INSN(insn, "missing int3 after indirect jump");
4523 warnings++;
4524 }
4525 break;
4526 default:
4527 break;
4528 }
4529 }
4530
4531 return warnings;
4532 }
4533
validate_reachable_instructions(struct objtool_file * file)4534 static int validate_reachable_instructions(struct objtool_file *file)
4535 {
4536 struct instruction *insn, *prev_insn;
4537 struct symbol *call_dest;
4538 int warnings = 0;
4539
4540 if (file->ignore_unreachables)
4541 return 0;
4542
4543 for_each_insn(file, insn) {
4544 if (insn->visited || ignore_unreachable_insn(file, insn))
4545 continue;
4546
4547 prev_insn = prev_insn_same_sec(file, insn);
4548 if (prev_insn && prev_insn->dead_end) {
4549 call_dest = insn_call_dest(prev_insn);
4550 if (call_dest) {
4551 WARN_INSN(insn, "%s() missing __noreturn in .c/.h or NORETURN() in noreturns.h",
4552 call_dest->name);
4553 warnings++;
4554 continue;
4555 }
4556 }
4557
4558 WARN_INSN(insn, "unreachable instruction");
4559 warnings++;
4560 }
4561
4562 return warnings;
4563 }
4564
4565 /* 'funcs' is a space-separated list of function names */
disas_funcs(const char * funcs)4566 static void disas_funcs(const char *funcs)
4567 {
4568 const char *objdump_str, *cross_compile;
4569 int size, ret;
4570 char *cmd;
4571
4572 cross_compile = getenv("CROSS_COMPILE");
4573 if (!cross_compile)
4574 cross_compile = "";
4575
4576 objdump_str = "%sobjdump -wdr %s | gawk -M -v _funcs='%s' '"
4577 "BEGIN { split(_funcs, funcs); }"
4578 "/^$/ { func_match = 0; }"
4579 "/<.*>:/ { "
4580 "f = gensub(/.*<(.*)>:/, \"\\\\1\", 1);"
4581 "for (i in funcs) {"
4582 "if (funcs[i] == f) {"
4583 "func_match = 1;"
4584 "base = strtonum(\"0x\" $1);"
4585 "break;"
4586 "}"
4587 "}"
4588 "}"
4589 "{"
4590 "if (func_match) {"
4591 "addr = strtonum(\"0x\" $1);"
4592 "printf(\"%%04x \", addr - base);"
4593 "print;"
4594 "}"
4595 "}' 1>&2";
4596
4597 /* fake snprintf() to calculate the size */
4598 size = snprintf(NULL, 0, objdump_str, cross_compile, objname, funcs) + 1;
4599 if (size <= 0) {
4600 WARN("objdump string size calculation failed");
4601 return;
4602 }
4603
4604 cmd = malloc(size);
4605
4606 /* real snprintf() */
4607 snprintf(cmd, size, objdump_str, cross_compile, objname, funcs);
4608 ret = system(cmd);
4609 if (ret) {
4610 WARN("disassembly failed: %d", ret);
4611 return;
4612 }
4613 }
4614
disas_warned_funcs(struct objtool_file * file)4615 static void disas_warned_funcs(struct objtool_file *file)
4616 {
4617 struct symbol *sym;
4618 char *funcs = NULL, *tmp;
4619
4620 for_each_sym(file, sym) {
4621 if (sym->warned) {
4622 if (!funcs) {
4623 funcs = malloc(strlen(sym->name) + 1);
4624 if (!funcs) {
4625 ERROR_GLIBC("malloc");
4626 return;
4627 }
4628 strcpy(funcs, sym->name);
4629 } else {
4630 tmp = malloc(strlen(funcs) + strlen(sym->name) + 2);
4631 if (!tmp) {
4632 ERROR_GLIBC("malloc");
4633 return;
4634 }
4635 sprintf(tmp, "%s %s", funcs, sym->name);
4636 free(funcs);
4637 funcs = tmp;
4638 }
4639 }
4640 }
4641
4642 if (funcs)
4643 disas_funcs(funcs);
4644 }
4645
4646 struct insn_chunk {
4647 void *addr;
4648 struct insn_chunk *next;
4649 };
4650
4651 /*
4652 * Reduce peak RSS usage by freeing insns memory before writing the ELF file,
4653 * which can trigger more allocations for .debug_* sections whose data hasn't
4654 * been read yet.
4655 */
free_insns(struct objtool_file * file)4656 static void free_insns(struct objtool_file *file)
4657 {
4658 struct instruction *insn;
4659 struct insn_chunk *chunks = NULL, *chunk;
4660
4661 for_each_insn(file, insn) {
4662 if (!insn->idx) {
4663 chunk = malloc(sizeof(*chunk));
4664 chunk->addr = insn;
4665 chunk->next = chunks;
4666 chunks = chunk;
4667 }
4668 }
4669
4670 for (chunk = chunks; chunk; chunk = chunk->next)
4671 free(chunk->addr);
4672 }
4673
check(struct objtool_file * file)4674 int check(struct objtool_file *file)
4675 {
4676 int ret = 0, warnings = 0;
4677
4678 arch_initial_func_cfi_state(&initial_func_cfi);
4679 init_cfi_state(&init_cfi);
4680 init_cfi_state(&func_cfi);
4681 set_func_state(&func_cfi);
4682 init_cfi_state(&force_undefined_cfi);
4683 force_undefined_cfi.force_undefined = true;
4684
4685 if (!cfi_hash_alloc(1UL << (file->elf->symbol_bits - 3))) {
4686 ret = -1;
4687 goto out;
4688 }
4689
4690 cfi_hash_add(&init_cfi);
4691 cfi_hash_add(&func_cfi);
4692
4693 ret = decode_sections(file);
4694 if (ret)
4695 goto out;
4696
4697 if (!nr_insns)
4698 goto out;
4699
4700 if (opts.retpoline)
4701 warnings += validate_retpoline(file);
4702
4703 if (opts.stackval || opts.orc || opts.uaccess) {
4704 int w = 0;
4705
4706 w += validate_functions(file);
4707 w += validate_unwind_hints(file, NULL);
4708 if (!w)
4709 w += validate_reachable_instructions(file);
4710
4711 warnings += w;
4712
4713 } else if (opts.noinstr) {
4714 warnings += validate_noinstr_sections(file);
4715 }
4716
4717 if (opts.unret) {
4718 /*
4719 * Must be after validate_branch() and friends, it plays
4720 * further games with insn->visited.
4721 */
4722 warnings += validate_unrets(file);
4723 }
4724
4725 if (opts.ibt)
4726 warnings += validate_ibt(file);
4727
4728 if (opts.sls)
4729 warnings += validate_sls(file);
4730
4731 if (opts.static_call) {
4732 ret = create_static_call_sections(file);
4733 if (ret)
4734 goto out;
4735 }
4736
4737 if (opts.retpoline) {
4738 ret = create_retpoline_sites_sections(file);
4739 if (ret)
4740 goto out;
4741 }
4742
4743 if (opts.cfi) {
4744 ret = create_cfi_sections(file);
4745 if (ret)
4746 goto out;
4747 }
4748
4749 if (opts.rethunk) {
4750 ret = create_return_sites_sections(file);
4751 if (ret)
4752 goto out;
4753
4754 if (opts.hack_skylake) {
4755 ret = create_direct_call_sections(file);
4756 if (ret)
4757 goto out;
4758 }
4759 }
4760
4761 if (opts.mcount) {
4762 ret = create_mcount_loc_sections(file);
4763 if (ret)
4764 goto out;
4765 }
4766
4767 if (opts.prefix) {
4768 ret = add_prefix_symbols(file);
4769 if (ret)
4770 goto out;
4771 }
4772
4773 if (opts.ibt) {
4774 ret = create_ibt_endbr_seal_sections(file);
4775 if (ret)
4776 goto out;
4777 }
4778
4779 if (opts.orc && nr_insns) {
4780 ret = orc_create(file);
4781 if (ret)
4782 goto out;
4783 }
4784
4785 free_insns(file);
4786
4787 if (opts.stats) {
4788 printf("nr_insns_visited: %ld\n", nr_insns_visited);
4789 printf("nr_cfi: %ld\n", nr_cfi);
4790 printf("nr_cfi_reused: %ld\n", nr_cfi_reused);
4791 printf("nr_cfi_cache: %ld\n", nr_cfi_cache);
4792 }
4793
4794 out:
4795 if (!ret && !warnings)
4796 return 0;
4797
4798 if (opts.werror && warnings)
4799 ret = 1;
4800
4801 if (opts.verbose) {
4802 if (opts.werror && warnings)
4803 WARN("%d warning(s) upgraded to errors", warnings);
4804 print_args();
4805 disas_warned_funcs(file);
4806 }
4807
4808 return ret;
4809 }
4810