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