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