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