check.c 90.0 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0-or-later
2 3 4 5 6 7
/*
 * Copyright (C) 2015-2017 Josh Poimboeuf <jpoimboe@redhat.com>
 */

#include <string.h>
#include <stdlib.h>
P
Peter Zijlstra 已提交
8
#include <sys/mman.h>
9

10 11 12 13 14 15 16 17
#include <arch/elf.h>
#include <objtool/builtin.h>
#include <objtool/cfi.h>
#include <objtool/arch.h>
#include <objtool/check.h>
#include <objtool/special.h>
#include <objtool/warn.h>
#include <objtool/endianness.h>
18

19
#include <linux/objtool.h>
20 21
#include <linux/hashtable.h>
#include <linux/kernel.h>
22
#include <linux/static_call_types.h>
23 24 25 26

struct alternative {
	struct list_head list;
	struct instruction *insn;
P
Peter Zijlstra 已提交
27
	bool skip_orig;
28 29
};

P
Peter Zijlstra 已提交
30 31 32 33 34
static unsigned long nr_cfi, nr_cfi_reused, nr_cfi_cache;

static struct cfi_init_state initial_func_cfi;
static struct cfi_state init_cfi;
static struct cfi_state func_cfi;
35

36 37
struct instruction *find_insn(struct objtool_file *file,
			      struct section *sec, unsigned long offset)
38 39 40
{
	struct instruction *insn;

41
	hash_for_each_possible(file->insn_hash, insn, hash, sec_offset_hash(sec, offset)) {
42 43
		if (insn->sec == sec && insn->offset == offset)
			return insn;
44
	}
45 46 47 48 49 50 51 52 53

	return NULL;
}

static struct instruction *next_insn_same_sec(struct objtool_file *file,
					      struct instruction *insn)
{
	struct instruction *next = list_next_entry(insn, list);

54
	if (!next || &next->list == &file->insn_list || next->sec != insn->sec)
55 56 57 58 59
		return NULL;

	return next;
}

60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
static struct instruction *next_insn_same_func(struct objtool_file *file,
					       struct instruction *insn)
{
	struct instruction *next = list_next_entry(insn, list);
	struct symbol *func = insn->func;

	if (!func)
		return NULL;

	if (&next->list != &file->insn_list && next->func == func)
		return next;

	/* Check if we're already in the subfunction: */
	if (func == func->cfunc)
		return NULL;

	/* Move to the subfunction: */
	return find_insn(file, func->cfunc->sec, func->cfunc->offset);
}

80 81 82 83 84 85 86 87 88 89 90
static struct instruction *prev_insn_same_sym(struct objtool_file *file,
					       struct instruction *insn)
{
	struct instruction *prev = list_prev_entry(insn, list);

	if (&prev->list != &file->insn_list && prev->func == insn->func)
		return prev;

	return NULL;
}

91
#define func_for_each_insn(file, func, insn)				\
92 93 94 95
	for (insn = find_insn(file, func->sec, func->offset);		\
	     insn;							\
	     insn = next_insn_same_func(file, insn))

96 97
#define sym_for_each_insn(file, sym, insn)				\
	for (insn = find_insn(file, sym->sec, sym->offset);		\
98
	     insn && &insn->list != &file->insn_list &&			\
99 100
		insn->sec == sym->sec &&				\
		insn->offset < sym->offset + sym->len;			\
101 102
	     insn = list_next_entry(insn, list))

103
#define sym_for_each_insn_continue_reverse(file, sym, insn)		\
104 105
	for (insn = list_prev_entry(insn, list);			\
	     &insn->list != &file->insn_list &&				\
106
		insn->sec == sym->sec && insn->offset >= sym->offset;	\
107 108 109 110 111
	     insn = list_prev_entry(insn, list))

#define sec_for_each_insn_from(file, insn)				\
	for (; insn; insn = next_insn_same_sec(file, insn))

112 113 114
#define sec_for_each_insn_continue(file, insn)				\
	for (insn = next_insn_same_sec(file, insn); insn;		\
	     insn = next_insn_same_sec(file, insn))
115

116 117 118 119 120 121 122 123 124 125 126 127
static bool is_jump_table_jump(struct instruction *insn)
{
	struct alt_group *alt_group = insn->alt_group;

	if (insn->jump_table)
		return true;

	/* Retpoline alternative for a jump table? */
	return alt_group && alt_group->orig_group &&
	       alt_group->orig_group->first_insn->jump_table;
}

128 129
static bool is_sibling_call(struct instruction *insn)
{
130 131 132 133 134 135 136 137
	/*
	 * Assume only ELF functions can make sibling calls.  This ensures
	 * sibling call detection consistency between vmlinux.o and individual
	 * objects.
	 */
	if (!insn->func)
		return false;

138 139
	/* An indirect jump is either a sibling call or a jump to a table. */
	if (insn->type == INSN_JUMP_DYNAMIC)
140
		return !is_jump_table_jump(insn);
141 142

	/* add_jump_destinations() sets insn->call_dest for sibling calls. */
143
	return (is_static_jump(insn) && insn->call_dest);
144 145
}

146 147 148 149 150 151 152 153 154
/*
 * This checks to see if the given function is a "noreturn" function.
 *
 * For global functions which are outside the scope of this object file, we
 * have to keep a manual list of them.
 *
 * For local functions, we have to detect them manually by simply looking for
 * the lack of a return instruction.
 */
155 156
static bool __dead_end_function(struct objtool_file *file, struct symbol *func,
				int recursion)
157 158 159 160 161 162 163 164 165 166 167 168 169 170
{
	int i;
	struct instruction *insn;
	bool empty = true;

	/*
	 * Unfortunately these have to be hard coded because the noreturn
	 * attribute isn't provided in ELF data.
	 */
	static const char * const global_noreturns[] = {
		"__stack_chk_fail",
		"panic",
		"do_exit",
		"do_task_dead",
E
Eric W. Biederman 已提交
171
		"kthread_exit",
172
		"make_task_dead",
173
		"__module_put_and_kthread_exit",
174
		"kthread_complete_and_exit",
175 176 177
		"__reiserfs_panic",
		"lbug_with_loc",
		"fortify_panic",
178
		"usercopy_abort",
179
		"machine_real_restart",
180
		"rewind_stack_and_make_dead",
181
		"kunit_try_catch_throw",
182
		"xen_start_kernel",
183
		"cpu_bringup_and_idle",
184
		"do_group_exit",
185
		"stop_this_cpu",
186
		"__invalid_creds",
187 188
	};

189 190 191
	if (!func)
		return false;

192
	if (func->bind == STB_WEAK)
193
		return false;
194 195 196 197

	if (func->bind == STB_GLOBAL)
		for (i = 0; i < ARRAY_SIZE(global_noreturns); i++)
			if (!strcmp(func->name, global_noreturns[i]))
198
				return true;
199

200
	if (!func->len)
201
		return false;
202

203 204
	insn = find_insn(file, func->sec, func->offset);
	if (!insn->func)
205
		return false;
206

207
	func_for_each_insn(file, func, insn) {
208 209 210
		empty = false;

		if (insn->type == INSN_RETURN)
211
			return false;
212 213 214
	}

	if (empty)
215
		return false;
216 217 218 219 220 221

	/*
	 * A function can have a sibling call instead of a return.  In that
	 * case, the function's dead-end status depends on whether the target
	 * of the sibling call returns.
	 */
222
	func_for_each_insn(file, func, insn) {
223
		if (is_sibling_call(insn)) {
224 225 226 227
			struct instruction *dest = insn->jump_dest;

			if (!dest)
				/* sibling call to another file */
228
				return false;
229

230 231 232 233 234 235 236 237
			/* local sibling call */
			if (recursion == 5) {
				/*
				 * Infinite recursion: two functions have
				 * sibling calls to each other.  This is a very
				 * rare case.  It means they aren't dead ends.
				 */
				return false;
238 239
			}

240 241
			return __dead_end_function(file, dest->func, recursion+1);
		}
242 243
	}

244
	return true;
245 246
}

247
static bool dead_end_function(struct objtool_file *file, struct symbol *func)
248 249 250 251
{
	return __dead_end_function(file, func, 0);
}

252
static void init_cfi_state(struct cfi_state *cfi)
253 254 255
{
	int i;

256
	for (i = 0; i < CFI_NUM_REGS; i++) {
257 258
		cfi->regs[i].base = CFI_UNDEFINED;
		cfi->vals[i].base = CFI_UNDEFINED;
259
	}
260 261 262 263 264
	cfi->cfa.base = CFI_UNDEFINED;
	cfi->drap_reg = CFI_UNDEFINED;
	cfi->drap_offset = -1;
}

265
static void init_insn_state(struct insn_state *state, struct section *sec)
266 267 268
{
	memset(state, 0, sizeof(*state));
	init_cfi_state(&state->cfi);
269 270 271 272 273 274

	/*
	 * We need the full vmlinux for noinstr validation, otherwise we can
	 * not correctly determine insn->call_dest->sec (external symbols do
	 * not have a section).
	 */
275
	if (vmlinux && noinstr && sec)
276
		state->noinstr = sec->noinstr;
277 278
}

P
Peter Zijlstra 已提交
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
static struct cfi_state *cfi_alloc(void)
{
	struct cfi_state *cfi = calloc(sizeof(struct cfi_state), 1);
	if (!cfi) {
		WARN("calloc failed");
		exit(1);
	}
	nr_cfi++;
	return cfi;
}

static int cfi_bits;
static struct hlist_head *cfi_hash;

static inline bool cficmp(struct cfi_state *cfi1, struct cfi_state *cfi2)
{
	return memcmp((void *)cfi1 + sizeof(cfi1->hash),
		      (void *)cfi2 + sizeof(cfi2->hash),
		      sizeof(struct cfi_state) - sizeof(struct hlist_node));
}

static inline u32 cfi_key(struct cfi_state *cfi)
{
	return jhash((void *)cfi + sizeof(cfi->hash),
		     sizeof(*cfi) - sizeof(cfi->hash), 0);
}

static struct cfi_state *cfi_hash_find_or_add(struct cfi_state *cfi)
{
	struct hlist_head *head = &cfi_hash[hash_min(cfi_key(cfi), cfi_bits)];
	struct cfi_state *obj;

	hlist_for_each_entry(obj, head, hash) {
		if (!cficmp(cfi, obj)) {
			nr_cfi_cache++;
			return obj;
		}
	}

	obj = cfi_alloc();
	*obj = *cfi;
	hlist_add_head(&obj->hash, head);

	return obj;
}

static void cfi_hash_add(struct cfi_state *cfi)
{
	struct hlist_head *head = &cfi_hash[hash_min(cfi_key(cfi), cfi_bits)];

	hlist_add_head(&cfi->hash, head);
}

static void *cfi_hash_alloc(unsigned long size)
{
	cfi_bits = max(10, ilog2(size));
	cfi_hash = mmap(NULL, sizeof(struct hlist_head) << cfi_bits,
			PROT_READ|PROT_WRITE,
			MAP_PRIVATE|MAP_ANON, -1, 0);
	if (cfi_hash == (void *)-1L) {
		WARN("mmap fail cfi_hash");
		cfi_hash = NULL;
	}  else if (stats) {
		printf("cfi_bits: %d\n", cfi_bits);
	}

	return cfi_hash;
}

static unsigned long nr_insns;
static unsigned long nr_insns_visited;

351 352 353 354 355 356 357 358 359 360 361 362
/*
 * Call the arch-specific instruction decoder for all the instructions and add
 * them to the global instruction list.
 */
static int decode_instructions(struct objtool_file *file)
{
	struct section *sec;
	struct symbol *func;
	unsigned long offset;
	struct instruction *insn;
	int ret;

363
	for_each_sec(file, sec) {
364 365 366 367

		if (!(sec->sh.sh_flags & SHF_EXECINSTR))
			continue;

368 369 370 371 372
		if (strcmp(sec->name, ".altinstr_replacement") &&
		    strcmp(sec->name, ".altinstr_aux") &&
		    strncmp(sec->name, ".discard.", 9))
			sec->text = true;

373 374
		if (!strcmp(sec->name, ".noinstr.text") ||
		    !strcmp(sec->name, ".entry.text"))
375 376
			sec->noinstr = true;

377
		for (offset = 0; offset < sec->sh.sh_size; offset += insn->len) {
378
			insn = malloc(sizeof(*insn));
379 380 381 382
			if (!insn) {
				WARN("malloc failed");
				return -1;
			}
383 384
			memset(insn, 0, sizeof(*insn));
			INIT_LIST_HEAD(&insn->alts);
385
			INIT_LIST_HEAD(&insn->stack_ops);
386

387 388 389
			insn->sec = sec;
			insn->offset = offset;

390
			ret = arch_decode_instruction(file, sec, offset,
391
						      sec->sh.sh_size - offset,
392
						      &insn->len, &insn->type,
393
						      &insn->immediate,
394
						      &insn->stack_ops);
395
			if (ret)
396
				goto err;
397

P
Peter Zijlstra 已提交
398 399 400 401 402 403 404 405
			/*
			 * By default, "ud2" is a dead end unless otherwise
			 * annotated, because GCC 7 inserts it for certain
			 * divide-by-zero cases.
			 */
			if (insn->type == INSN_BUG)
				insn->dead_end = true;

406
			hash_add(file->insn_hash, &insn->hash, sec_offset_hash(sec, insn->offset));
407
			list_add_tail(&insn->list, &file->insn_list);
P
Peter Zijlstra 已提交
408
			nr_insns++;
409 410 411
		}

		list_for_each_entry(func, &sec->symbol_list, list) {
412
			if (func->type != STT_FUNC || func->alias != func)
413 414 415 416 417 418 419 420
				continue;

			if (!find_insn(file, sec, func->offset)) {
				WARN("%s(): can't find starting instruction",
				     func->name);
				return -1;
			}

421
			sym_for_each_insn(file, func, insn) {
422
				insn->func = func;
423 424 425 426 427 428 429 430
				if (insn->type == INSN_ENDBR) {
					if (insn->offset == insn->func->offset) {
						file->nr_endbr++;
					} else {
						file->nr_endbr_int++;
					}
				}
			}
431 432 433
		}
	}

P
Peter Zijlstra 已提交
434 435 436
	if (stats)
		printf("nr_insns: %lu\n", nr_insns);

437
	return 0;
438 439 440 441

err:
	free(insn);
	return ret;
442 443
}

444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519
/*
 * Read the pv_ops[] .data table to find the static initialized values.
 */
static int add_pv_ops(struct objtool_file *file, const char *symname)
{
	struct symbol *sym, *func;
	unsigned long off, end;
	struct reloc *rel;
	int idx;

	sym = find_symbol_by_name(file->elf, symname);
	if (!sym)
		return 0;

	off = sym->offset;
	end = off + sym->len;
	for (;;) {
		rel = find_reloc_by_dest_range(file->elf, sym->sec, off, end - off);
		if (!rel)
			break;

		func = rel->sym;
		if (func->type == STT_SECTION)
			func = find_symbol_by_offset(rel->sym->sec, rel->addend);

		idx = (rel->offset - sym->offset) / sizeof(unsigned long);

		objtool_pv_add(file, idx, func);

		off = rel->offset + 1;
		if (off > end)
			break;
	}

	return 0;
}

/*
 * Allocate and initialize file->pv_ops[].
 */
static int init_pv_ops(struct objtool_file *file)
{
	static const char *pv_ops_tables[] = {
		"pv_ops",
		"xen_cpu_ops",
		"xen_irq_ops",
		"xen_mmu_ops",
		NULL,
	};
	const char *pv_ops;
	struct symbol *sym;
	int idx, nr;

	if (!noinstr)
		return 0;

	file->pv_ops = NULL;

	sym = find_symbol_by_name(file->elf, "pv_ops");
	if (!sym)
		return 0;

	nr = sym->len / sizeof(unsigned long);
	file->pv_ops = calloc(sizeof(struct pv_state), nr);
	if (!file->pv_ops)
		return -1;

	for (idx = 0; idx < nr; idx++)
		INIT_LIST_HEAD(&file->pv_ops[idx].targets);

	for (idx = 0; (pv_ops = pv_ops_tables[idx]); idx++)
		add_pv_ops(file, pv_ops);

	return 0;
}

520 521 522 523 524
static struct instruction *find_last_insn(struct objtool_file *file,
					  struct section *sec)
{
	struct instruction *insn = NULL;
	unsigned int offset;
525
	unsigned int end = (sec->sh.sh_size > 10) ? sec->sh.sh_size - 10 : 0;
526

527
	for (offset = sec->sh.sh_size - 1; offset >= end && !insn; offset--)
528 529 530 531 532
		insn = find_insn(file, sec, offset);

	return insn;
}

533
/*
534
 * Mark "ud2" instructions and manually annotated dead ends.
535 536 537 538
 */
static int add_dead_ends(struct objtool_file *file)
{
	struct section *sec;
M
Matt Helsley 已提交
539
	struct reloc *reloc;
540 541
	struct instruction *insn;

542 543 544
	/*
	 * Check for manually annotated dead ends.
	 */
545 546
	sec = find_section_by_name(file->elf, ".rela.discard.unreachable");
	if (!sec)
547
		goto reachable;
548

M
Matt Helsley 已提交
549 550
	list_for_each_entry(reloc, &sec->reloc_list, list) {
		if (reloc->sym->type != STT_SECTION) {
551 552 553
			WARN("unexpected relocation symbol type in %s", sec->name);
			return -1;
		}
M
Matt Helsley 已提交
554
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
555 556
		if (insn)
			insn = list_prev_entry(insn, list);
557
		else if (reloc->addend == reloc->sym->sec->sh.sh_size) {
M
Matt Helsley 已提交
558
			insn = find_last_insn(file, reloc->sym->sec);
559
			if (!insn) {
560
				WARN("can't find unreachable insn at %s+0x%x",
M
Matt Helsley 已提交
561
				     reloc->sym->sec->name, reloc->addend);
562 563 564 565
				return -1;
			}
		} else {
			WARN("can't find unreachable insn at %s+0x%x",
M
Matt Helsley 已提交
566
			     reloc->sym->sec->name, reloc->addend);
567 568 569 570 571 572
			return -1;
		}

		insn->dead_end = true;
	}

573 574 575 576 577 578 579 580 581 582 583
reachable:
	/*
	 * These manually annotated reachable checks are needed for GCC 4.4,
	 * where the Linux unreachable() macro isn't supported.  In that case
	 * GCC doesn't know the "ud2" is fatal, so it generates code as if it's
	 * not a dead end.
	 */
	sec = find_section_by_name(file->elf, ".rela.discard.reachable");
	if (!sec)
		return 0;

M
Matt Helsley 已提交
584 585
	list_for_each_entry(reloc, &sec->reloc_list, list) {
		if (reloc->sym->type != STT_SECTION) {
586 587 588
			WARN("unexpected relocation symbol type in %s", sec->name);
			return -1;
		}
M
Matt Helsley 已提交
589
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
590 591
		if (insn)
			insn = list_prev_entry(insn, list);
592
		else if (reloc->addend == reloc->sym->sec->sh.sh_size) {
M
Matt Helsley 已提交
593
			insn = find_last_insn(file, reloc->sym->sec);
594
			if (!insn) {
595
				WARN("can't find reachable insn at %s+0x%x",
M
Matt Helsley 已提交
596
				     reloc->sym->sec->name, reloc->addend);
597 598 599 600
				return -1;
			}
		} else {
			WARN("can't find reachable insn at %s+0x%x",
M
Matt Helsley 已提交
601
			     reloc->sym->sec->name, reloc->addend);
602 603 604 605 606 607
			return -1;
		}

		insn->dead_end = false;
	}

608 609 610
	return 0;
}

611 612
static int create_static_call_sections(struct objtool_file *file)
{
613
	struct section *sec;
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630
	struct static_call_site *site;
	struct instruction *insn;
	struct symbol *key_sym;
	char *key_name, *tmp;
	int idx;

	sec = find_section_by_name(file->elf, ".static_call_sites");
	if (sec) {
		INIT_LIST_HEAD(&file->static_call_list);
		WARN("file already has .static_call_sites section, skipping");
		return 0;
	}

	if (list_empty(&file->static_call_list))
		return 0;

	idx = 0;
631
	list_for_each_entry(insn, &file->static_call_list, call_node)
632 633 634 635 636 637 638 639
		idx++;

	sec = elf_create_section(file->elf, ".static_call_sites", SHF_WRITE,
				 sizeof(struct static_call_site), idx);
	if (!sec)
		return -1;

	idx = 0;
640
	list_for_each_entry(insn, &file->static_call_list, call_node) {
641 642 643 644 645

		site = (struct static_call_site *)sec->data->d_buf + idx;
		memset(site, 0, sizeof(struct static_call_site));

		/* populate reloc for 'addr' */
646 647 648 649
		if (elf_add_reloc_to_insn(file->elf, sec,
					  idx * sizeof(struct static_call_site),
					  R_X86_64_PC32,
					  insn->sec, insn->offset))
650
			return -1;
651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667

		/* find key symbol */
		key_name = strdup(insn->call_dest->name);
		if (!key_name) {
			perror("strdup");
			return -1;
		}
		if (strncmp(key_name, STATIC_CALL_TRAMP_PREFIX_STR,
			    STATIC_CALL_TRAMP_PREFIX_LEN)) {
			WARN("static_call: trampoline name malformed: %s", key_name);
			return -1;
		}
		tmp = key_name + STATIC_CALL_TRAMP_PREFIX_LEN - STATIC_CALL_KEY_PREFIX_LEN;
		memcpy(tmp, STATIC_CALL_KEY_PREFIX_STR, STATIC_CALL_KEY_PREFIX_LEN);

		key_sym = find_symbol_by_name(file->elf, tmp);
		if (!key_sym) {
668 669 670 671 672 673 674 675 676 677 678 679 680 681 682
			if (!module) {
				WARN("static_call: can't find static_call_key symbol: %s", tmp);
				return -1;
			}

			/*
			 * For modules(), the key might not be exported, which
			 * means the module can make static calls but isn't
			 * allowed to change them.
			 *
			 * In that case we temporarily set the key to be the
			 * trampoline address.  This is fixed up in
			 * static_call_add_module().
			 */
			key_sym = insn->call_dest;
683 684 685 686
		}
		free(key_name);

		/* populate reloc for 'key' */
687 688 689 690
		if (elf_add_reloc(file->elf, sec,
				  idx * sizeof(struct static_call_site) + 4,
				  R_X86_64_PC32, key_sym,
				  is_sibling_call(insn) * STATIC_CALL_SITE_TAIL))
691 692 693 694 695 696 697 698
			return -1;

		idx++;
	}

	return 0;
}

699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744
static int create_retpoline_sites_sections(struct objtool_file *file)
{
	struct instruction *insn;
	struct section *sec;
	int idx;

	sec = find_section_by_name(file->elf, ".retpoline_sites");
	if (sec) {
		WARN("file already has .retpoline_sites, skipping");
		return 0;
	}

	idx = 0;
	list_for_each_entry(insn, &file->retpoline_call_list, call_node)
		idx++;

	if (!idx)
		return 0;

	sec = elf_create_section(file->elf, ".retpoline_sites", 0,
				 sizeof(int), idx);
	if (!sec) {
		WARN("elf_create_section: .retpoline_sites");
		return -1;
	}

	idx = 0;
	list_for_each_entry(insn, &file->retpoline_call_list, call_node) {

		int *site = (int *)sec->data->d_buf + idx;
		*site = 0;

		if (elf_add_reloc_to_insn(file->elf, sec,
					  idx * sizeof(int),
					  R_X86_64_PC32,
					  insn->sec, insn->offset)) {
			WARN("elf_add_reloc_to_insn: .retpoline_sites");
			return -1;
		}

		idx++;
	}

	return 0;
}

745 746
static int create_mcount_loc_sections(struct objtool_file *file)
{
747
	struct section *sec;
748 749 750 751 752 753 754 755 756 757 758 759 760 761 762
	unsigned long *loc;
	struct instruction *insn;
	int idx;

	sec = find_section_by_name(file->elf, "__mcount_loc");
	if (sec) {
		INIT_LIST_HEAD(&file->mcount_loc_list);
		WARN("file already has __mcount_loc section, skipping");
		return 0;
	}

	if (list_empty(&file->mcount_loc_list))
		return 0;

	idx = 0;
763
	list_for_each_entry(insn, &file->mcount_loc_list, call_node)
764 765 766 767 768 769 770
		idx++;

	sec = elf_create_section(file->elf, "__mcount_loc", 0, sizeof(unsigned long), idx);
	if (!sec)
		return -1;

	idx = 0;
771
	list_for_each_entry(insn, &file->mcount_loc_list, call_node) {
772 773 774 775

		loc = (unsigned long *)sec->data->d_buf + idx;
		memset(loc, 0, sizeof(unsigned long));

776 777 778 779
		if (elf_add_reloc_to_insn(file->elf, sec,
					  idx * sizeof(unsigned long),
					  R_X86_64_64,
					  insn->sec, insn->offset))
780 781 782 783 784 785 786 787
			return -1;

		idx++;
	}

	return 0;
}

788 789 790 791 792 793 794 795
/*
 * Warnings shouldn't be reported for ignored functions.
 */
static void add_ignores(struct objtool_file *file)
{
	struct instruction *insn;
	struct section *sec;
	struct symbol *func;
M
Matt Helsley 已提交
796
	struct reloc *reloc;
797

P
Peter Zijlstra 已提交
798 799 800
	sec = find_section_by_name(file->elf, ".rela.discard.func_stack_frame_non_standard");
	if (!sec)
		return;
801

M
Matt Helsley 已提交
802 803
	list_for_each_entry(reloc, &sec->reloc_list, list) {
		switch (reloc->sym->type) {
P
Peter Zijlstra 已提交
804
		case STT_FUNC:
M
Matt Helsley 已提交
805
			func = reloc->sym;
P
Peter Zijlstra 已提交
806 807 808
			break;

		case STT_SECTION:
M
Matt Helsley 已提交
809
			func = find_func_by_offset(reloc->sym->sec, reloc->addend);
810
			if (!func)
811
				continue;
P
Peter Zijlstra 已提交
812
			break;
813

P
Peter Zijlstra 已提交
814
		default:
M
Matt Helsley 已提交
815
			WARN("unexpected relocation symbol type in %s: %d", sec->name, reloc->sym->type);
P
Peter Zijlstra 已提交
816
			continue;
817
		}
P
Peter Zijlstra 已提交
818

819
		func_for_each_insn(file, func, insn)
P
Peter Zijlstra 已提交
820
			insn->ignore = true;
821 822 823
	}
}

P
Peter Zijlstra 已提交
824 825 826 827 828 829 830 831 832 833
/*
 * This is a whitelist of functions that is allowed to be called with AC set.
 * The list is meant to be minimal and only contains compiler instrumentation
 * ABI and a few functions used to implement *_{to,from}_user() functions.
 *
 * These functions must not directly change AC, but may PUSHF/POPF.
 */
static const char *uaccess_safe_builtin[] = {
	/* KASAN */
	"kasan_report",
834
	"kasan_check_range",
P
Peter Zijlstra 已提交
835 836 837 838 839 840 841 842 843 844 845 846 847
	/* KASAN out-of-line */
	"__asan_loadN_noabort",
	"__asan_load1_noabort",
	"__asan_load2_noabort",
	"__asan_load4_noabort",
	"__asan_load8_noabort",
	"__asan_load16_noabort",
	"__asan_storeN_noabort",
	"__asan_store1_noabort",
	"__asan_store2_noabort",
	"__asan_store4_noabort",
	"__asan_store8_noabort",
	"__asan_store16_noabort",
848 849
	"__kasan_check_read",
	"__kasan_check_write",
P
Peter Zijlstra 已提交
850 851 852 853 854 855 856 857 858 859 860 861 862
	/* KASAN in-line */
	"__asan_report_load_n_noabort",
	"__asan_report_load1_noabort",
	"__asan_report_load2_noabort",
	"__asan_report_load4_noabort",
	"__asan_report_load8_noabort",
	"__asan_report_load16_noabort",
	"__asan_report_store_n_noabort",
	"__asan_report_store1_noabort",
	"__asan_report_store2_noabort",
	"__asan_report_store4_noabort",
	"__asan_report_store8_noabort",
	"__asan_report_store16_noabort",
863
	/* KCSAN */
864
	"__kcsan_check_access",
865 866 867 868
	"__kcsan_mb",
	"__kcsan_wmb",
	"__kcsan_rmb",
	"__kcsan_release",
869 870
	"kcsan_found_watchpoint",
	"kcsan_setup_watchpoint",
871
	"kcsan_check_scoped_accesses",
872 873
	"kcsan_disable_current",
	"kcsan_enable_current_nowarn",
874 875 876 877 878 879 880 881 882 883 884 885 886 887 888
	/* KCSAN/TSAN */
	"__tsan_func_entry",
	"__tsan_func_exit",
	"__tsan_read_range",
	"__tsan_write_range",
	"__tsan_read1",
	"__tsan_read2",
	"__tsan_read4",
	"__tsan_read8",
	"__tsan_read16",
	"__tsan_write1",
	"__tsan_write2",
	"__tsan_write4",
	"__tsan_write8",
	"__tsan_write16",
889 890 891 892 893
	"__tsan_read_write1",
	"__tsan_read_write2",
	"__tsan_read_write4",
	"__tsan_read_write8",
	"__tsan_read_write16",
894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943
	"__tsan_atomic8_load",
	"__tsan_atomic16_load",
	"__tsan_atomic32_load",
	"__tsan_atomic64_load",
	"__tsan_atomic8_store",
	"__tsan_atomic16_store",
	"__tsan_atomic32_store",
	"__tsan_atomic64_store",
	"__tsan_atomic8_exchange",
	"__tsan_atomic16_exchange",
	"__tsan_atomic32_exchange",
	"__tsan_atomic64_exchange",
	"__tsan_atomic8_fetch_add",
	"__tsan_atomic16_fetch_add",
	"__tsan_atomic32_fetch_add",
	"__tsan_atomic64_fetch_add",
	"__tsan_atomic8_fetch_sub",
	"__tsan_atomic16_fetch_sub",
	"__tsan_atomic32_fetch_sub",
	"__tsan_atomic64_fetch_sub",
	"__tsan_atomic8_fetch_and",
	"__tsan_atomic16_fetch_and",
	"__tsan_atomic32_fetch_and",
	"__tsan_atomic64_fetch_and",
	"__tsan_atomic8_fetch_or",
	"__tsan_atomic16_fetch_or",
	"__tsan_atomic32_fetch_or",
	"__tsan_atomic64_fetch_or",
	"__tsan_atomic8_fetch_xor",
	"__tsan_atomic16_fetch_xor",
	"__tsan_atomic32_fetch_xor",
	"__tsan_atomic64_fetch_xor",
	"__tsan_atomic8_fetch_nand",
	"__tsan_atomic16_fetch_nand",
	"__tsan_atomic32_fetch_nand",
	"__tsan_atomic64_fetch_nand",
	"__tsan_atomic8_compare_exchange_strong",
	"__tsan_atomic16_compare_exchange_strong",
	"__tsan_atomic32_compare_exchange_strong",
	"__tsan_atomic64_compare_exchange_strong",
	"__tsan_atomic8_compare_exchange_weak",
	"__tsan_atomic16_compare_exchange_weak",
	"__tsan_atomic32_compare_exchange_weak",
	"__tsan_atomic64_compare_exchange_weak",
	"__tsan_atomic8_compare_exchange_val",
	"__tsan_atomic16_compare_exchange_val",
	"__tsan_atomic32_compare_exchange_val",
	"__tsan_atomic64_compare_exchange_val",
	"__tsan_atomic_thread_fence",
	"__tsan_atomic_signal_fence",
P
Peter Zijlstra 已提交
944 945
	/* KCOV */
	"write_comp_data",
946
	"check_kcov_mode",
P
Peter Zijlstra 已提交
947 948 949 950 951 952 953 954 955
	"__sanitizer_cov_trace_pc",
	"__sanitizer_cov_trace_const_cmp1",
	"__sanitizer_cov_trace_const_cmp2",
	"__sanitizer_cov_trace_const_cmp4",
	"__sanitizer_cov_trace_const_cmp8",
	"__sanitizer_cov_trace_cmp1",
	"__sanitizer_cov_trace_cmp2",
	"__sanitizer_cov_trace_cmp4",
	"__sanitizer_cov_trace_cmp8",
956
	"__sanitizer_cov_trace_switch",
P
Peter Zijlstra 已提交
957 958 959 960
	/* UBSAN */
	"ubsan_type_mismatch_common",
	"__ubsan_handle_type_mismatch",
	"__ubsan_handle_type_mismatch_v1",
961
	"__ubsan_handle_shift_out_of_bounds",
P
Peter Zijlstra 已提交
962 963
	/* misc */
	"csum_partial_copy_generic",
964 965
	"copy_mc_fragile",
	"copy_mc_fragile_handle_tail",
966
	"copy_mc_enhanced_fast_string",
P
Peter Zijlstra 已提交
967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983
	"ftrace_likely_update", /* CONFIG_TRACE_BRANCH_PROFILING */
	NULL
};

static void add_uaccess_safe(struct objtool_file *file)
{
	struct symbol *func;
	const char **name;

	if (!uaccess)
		return;

	for (name = uaccess_safe_builtin; *name; name++) {
		func = find_symbol_by_name(file->elf, *name);
		if (!func)
			continue;

984
		func->uaccess_safe = true;
985 986 987
	}
}

988 989 990 991 992 993
/*
 * FIXME: For now, just ignore any alternatives which add retpolines.  This is
 * a temporary hack, as it doesn't allow ORC to unwind from inside a retpoline.
 * But it at least allows objtool to understand the control flow *around* the
 * retpoline.
 */
994
static int add_ignore_alternatives(struct objtool_file *file)
995 996
{
	struct section *sec;
M
Matt Helsley 已提交
997
	struct reloc *reloc;
998 999
	struct instruction *insn;

1000
	sec = find_section_by_name(file->elf, ".rela.discard.ignore_alts");
1001 1002 1003
	if (!sec)
		return 0;

M
Matt Helsley 已提交
1004 1005
	list_for_each_entry(reloc, &sec->reloc_list, list) {
		if (reloc->sym->type != STT_SECTION) {
1006 1007 1008 1009
			WARN("unexpected relocation symbol type in %s", sec->name);
			return -1;
		}

M
Matt Helsley 已提交
1010
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
1011
		if (!insn) {
1012
			WARN("bad .discard.ignore_alts entry");
1013 1014 1015 1016 1017 1018 1019 1020 1021
			return -1;
		}

		insn->ignore_alts = true;
	}

	return 0;
}

1022 1023 1024 1025 1026
__weak bool arch_is_retpoline(struct symbol *sym)
{
	return false;
}

1027 1028 1029 1030 1031 1032 1033 1034
#define NEGATIVE_RELOC	((void *)-1L)

static struct reloc *insn_reloc(struct objtool_file *file, struct instruction *insn)
{
	if (insn->reloc == NEGATIVE_RELOC)
		return NULL;

	if (!insn->reloc) {
1035 1036 1037
		if (!file)
			return NULL;

1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
		insn->reloc = find_reloc_by_dest_range(file->elf, insn->sec,
						       insn->offset, insn->len);
		if (!insn->reloc) {
			insn->reloc = NEGATIVE_RELOC;
			return NULL;
		}
	}

	return insn->reloc;
}

1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
static void remove_insn_ops(struct instruction *insn)
{
	struct stack_op *op, *tmp;

	list_for_each_entry_safe(op, tmp, &insn->stack_ops, list) {
		list_del(&op->list);
		free(op);
	}
}

1059 1060
static void annotate_call_site(struct objtool_file *file,
			       struct instruction *insn, bool sibling)
1061 1062
{
	struct reloc *reloc = insn_reloc(file, insn);
1063
	struct symbol *sym = insn->call_dest;
1064

1065 1066 1067 1068 1069 1070 1071 1072 1073 1074
	if (!sym)
		sym = reloc->sym;

	/*
	 * Alternative replacement code is just template code which is
	 * sometimes copied to the original instruction. For now, don't
	 * annotate it. (In the future we might consider annotating the
	 * original instruction if/when it ever makes sense to do so.)
	 */
	if (!strcmp(insn->sec->name, ".altinstr_replacement"))
1075 1076
		return;

1077 1078 1079
	if (sym->static_call_tramp) {
		list_add_tail(&insn->call_node, &file->static_call_list);
		return;
1080 1081
	}

1082 1083 1084 1085 1086
	if (sym->retpoline_thunk) {
		list_add_tail(&insn->call_node, &file->retpoline_call_list);
		return;
	}

1087
	/*
1088 1089 1090
	 * Many compilers cannot disable KCOV or sanitizer calls with a function
	 * attribute so they need a little help, NOP out any such calls from
	 * noinstr text.
1091
	 */
1092
	if (insn->sec->noinstr && sym->profiling_func) {
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
		if (reloc) {
			reloc->type = R_NONE;
			elf_write_reloc(file->elf, reloc);
		}

		elf_write_insn(file->elf, insn->sec,
			       insn->offset, insn->len,
			       sibling ? arch_ret_insn(insn->len)
			               : arch_nop_insn(insn->len));

		insn->type = sibling ? INSN_RETURN : INSN_NOP;
1104
		return;
1105 1106
	}

1107
	if (mcount && sym->fentry) {
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
		if (sibling)
			WARN_FUNC("Tail call to __fentry__ !?!?", insn->sec, insn->offset);

		if (reloc) {
			reloc->type = R_NONE;
			elf_write_reloc(file->elf, reloc);
		}

		elf_write_insn(file->elf, insn->sec,
			       insn->offset, insn->len,
			       arch_nop_insn(insn->len));

		insn->type = INSN_NOP;

1122
		list_add_tail(&insn->call_node, &file->mcount_loc_list);
1123
		return;
1124
	}
P
Peter Zijlstra 已提交
1125 1126 1127

	if (!sibling && dead_end_function(file, sym))
		insn->dead_end = true;
1128 1129 1130 1131 1132 1133 1134 1135
}

static void add_call_dest(struct objtool_file *file, struct instruction *insn,
			  struct symbol *dest, bool sibling)
{
	insn->call_dest = dest;
	if (!dest)
		return;
1136 1137 1138 1139 1140 1141 1142 1143 1144

	/*
	 * Whatever stack impact regular CALLs have, should be undone
	 * by the RETURN of the called function.
	 *
	 * Annotated intra-function calls retain the stack_ops but
	 * are converted to JUMP, see read_intra_function_calls().
	 */
	remove_insn_ops(insn);
1145 1146

	annotate_call_site(file, insn, sibling);
1147 1148
}

1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181
static void add_retpoline_call(struct objtool_file *file, struct instruction *insn)
{
	/*
	 * Retpoline calls/jumps are really dynamic calls/jumps in disguise,
	 * so convert them accordingly.
	 */
	switch (insn->type) {
	case INSN_CALL:
		insn->type = INSN_CALL_DYNAMIC;
		break;
	case INSN_JUMP_UNCONDITIONAL:
		insn->type = INSN_JUMP_DYNAMIC;
		break;
	case INSN_JUMP_CONDITIONAL:
		insn->type = INSN_JUMP_DYNAMIC_CONDITIONAL;
		break;
	default:
		return;
	}

	insn->retpoline_safe = true;

	/*
	 * Whatever stack impact regular CALLs have, should be undone
	 * by the RETURN of the called function.
	 *
	 * Annotated intra-function calls retain the stack_ops but
	 * are converted to JUMP, see read_intra_function_calls().
	 */
	remove_insn_ops(insn);

	annotate_call_site(file, insn, false);
}
1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194

static bool same_function(struct instruction *insn1, struct instruction *insn2)
{
	return insn1->func->pfunc == insn2->func->pfunc;
}

static bool is_first_func_insn(struct instruction *insn)
{
	return insn->offset == insn->func->offset ||
	       (insn->type == INSN_ENDBR &&
		insn->offset == insn->func->offset + insn->len);
}

1195 1196 1197 1198 1199 1200
/*
 * Find the destination instructions for all jumps.
 */
static int add_jump_destinations(struct objtool_file *file)
{
	struct instruction *insn;
M
Matt Helsley 已提交
1201
	struct reloc *reloc;
1202 1203 1204 1205
	struct section *dest_sec;
	unsigned long dest_off;

	for_each_insn(file, insn) {
1206
		if (!is_static_jump(insn))
1207 1208
			continue;

1209
		reloc = insn_reloc(file, insn);
M
Matt Helsley 已提交
1210
		if (!reloc) {
1211
			dest_sec = insn->sec;
1212
			dest_off = arch_jump_destination(insn);
M
Matt Helsley 已提交
1213 1214 1215
		} else if (reloc->sym->type == STT_SECTION) {
			dest_sec = reloc->sym->sec;
			dest_off = arch_dest_reloc_offset(reloc->addend);
P
Peter Zijlstra 已提交
1216
		} else if (reloc->sym->retpoline_thunk) {
1217
			add_retpoline_call(file, insn);
1218
			continue;
1219 1220
		} else if (insn->func) {
			/* internal or external sibling call (with reloc) */
1221
			add_call_dest(file, insn, reloc->sym, true);
1222
			continue;
1223 1224 1225 1226 1227 1228 1229
		} else if (reloc->sym->sec->idx) {
			dest_sec = reloc->sym->sec;
			dest_off = reloc->sym->sym.st_value +
				   arch_dest_reloc_offset(reloc->addend);
		} else {
			/* non-func asm code jumping to another file */
			continue;
1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247
		}

		insn->jump_dest = find_insn(file, dest_sec, dest_off);
		if (!insn->jump_dest) {

			/*
			 * This is a special case where an alt instruction
			 * jumps past the end of the section.  These are
			 * handled later in handle_group_alt().
			 */
			if (!strcmp(insn->sec->name, ".altinstr_replacement"))
				continue;

			WARN_FUNC("can't find jump dest instruction at %s+0x%lx",
				  insn->sec, insn->offset, dest_sec->name,
				  dest_off);
			return -1;
		}
1248 1249

		/*
1250
		 * Cross-function jump.
1251 1252
		 */
		if (insn->func && insn->jump_dest->func &&
1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267
		    insn->func != insn->jump_dest->func) {

			/*
			 * For GCC 8+, create parent/child links for any cold
			 * subfunctions.  This is _mostly_ redundant with a
			 * similar initialization in read_symbols().
			 *
			 * If a function has aliases, we want the *first* such
			 * function in the symbol table to be the subfunction's
			 * parent.  In that case we overwrite the
			 * initialization done in read_symbols().
			 *
			 * However this code can't completely replace the
			 * read_symbols() code because this doesn't detect the
			 * case where the parent function's only reference to a
1268
			 * subfunction is through a jump table.
1269
			 */
1270 1271
			if (!strstr(insn->func->name, ".cold") &&
			    strstr(insn->jump_dest->func->name, ".cold")) {
1272 1273 1274
				insn->func->cfunc = insn->jump_dest->func;
				insn->jump_dest->func->pfunc = insn->func;

1275 1276
			} else if (!same_function(insn, insn->jump_dest) &&
				   is_first_func_insn(insn->jump_dest)) {
1277
				/* internal sibling call (without reloc) */
1278
				add_call_dest(file, insn, insn->jump_dest->func, true);
1279
			}
1280
		}
1281 1282 1283 1284 1285
	}

	return 0;
}

1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296
static struct symbol *find_call_destination(struct section *sec, unsigned long offset)
{
	struct symbol *call_dest;

	call_dest = find_func_by_offset(sec, offset);
	if (!call_dest)
		call_dest = find_symbol_by_offset(sec, offset);

	return call_dest;
}

1297 1298 1299 1300 1301 1302 1303
/*
 * Find the destination instructions for all calls.
 */
static int add_call_destinations(struct objtool_file *file)
{
	struct instruction *insn;
	unsigned long dest_off;
1304
	struct symbol *dest;
M
Matt Helsley 已提交
1305
	struct reloc *reloc;
1306 1307 1308 1309 1310

	for_each_insn(file, insn) {
		if (insn->type != INSN_CALL)
			continue;

1311
		reloc = insn_reloc(file, insn);
M
Matt Helsley 已提交
1312
		if (!reloc) {
1313
			dest_off = arch_jump_destination(insn);
1314 1315 1316
			dest = find_call_destination(insn->sec, dest_off);

			add_call_dest(file, insn, dest, false);
1317

1318 1319 1320 1321
			if (insn->ignore)
				continue;

			if (!insn->call_dest) {
1322
				WARN_FUNC("unannotated intra-function call", insn->sec, insn->offset);
1323 1324
				return -1;
			}
1325

1326 1327 1328 1329 1330 1331
			if (insn->func && insn->call_dest->type != STT_FUNC) {
				WARN_FUNC("unsupported call to non-function",
					  insn->sec, insn->offset);
				return -1;
			}

M
Matt Helsley 已提交
1332 1333
		} else if (reloc->sym->type == STT_SECTION) {
			dest_off = arch_dest_reloc_offset(reloc->addend);
1334 1335
			dest = find_call_destination(reloc->sym->sec, dest_off);
			if (!dest) {
1336
				WARN_FUNC("can't find call dest symbol at %s+0x%lx",
1337
					  insn->sec, insn->offset,
M
Matt Helsley 已提交
1338
					  reloc->sym->sec->name,
1339
					  dest_off);
1340 1341
				return -1;
			}
1342

1343 1344
			add_call_dest(file, insn, dest, false);

P
Peter Zijlstra 已提交
1345
		} else if (reloc->sym->retpoline_thunk) {
1346
			add_retpoline_call(file, insn);
1347

1348
		} else
1349
			add_call_dest(file, insn, reloc->sym, false);
1350 1351 1352 1353 1354 1355
	}

	return 0;
}

/*
1356 1357
 * The .alternatives section requires some extra special care over and above
 * other special sections because alternatives are patched in place.
1358 1359 1360 1361 1362 1363
 */
static int handle_group_alt(struct objtool_file *file,
			    struct special_alt *special_alt,
			    struct instruction *orig_insn,
			    struct instruction **new_insn)
{
1364
	struct instruction *last_orig_insn, *last_new_insn = NULL, *insn, *nop = NULL;
J
Josh Poimboeuf 已提交
1365
	struct alt_group *orig_alt_group, *new_alt_group;
1366 1367
	unsigned long dest_off;

J
Josh Poimboeuf 已提交
1368 1369 1370 1371 1372 1373

	orig_alt_group = malloc(sizeof(*orig_alt_group));
	if (!orig_alt_group) {
		WARN("malloc failed");
		return -1;
	}
1374 1375 1376 1377 1378 1379 1380
	orig_alt_group->cfi = calloc(special_alt->orig_len,
				     sizeof(struct cfi_state *));
	if (!orig_alt_group->cfi) {
		WARN("calloc failed");
		return -1;
	}

1381 1382 1383 1384 1385 1386
	last_orig_insn = NULL;
	insn = orig_insn;
	sec_for_each_insn_from(file, insn) {
		if (insn->offset >= special_alt->orig_off + special_alt->orig_len)
			break;

J
Josh Poimboeuf 已提交
1387
		insn->alt_group = orig_alt_group;
1388 1389
		last_orig_insn = insn;
	}
J
Josh Poimboeuf 已提交
1390 1391 1392
	orig_alt_group->orig_group = NULL;
	orig_alt_group->first_insn = orig_insn;
	orig_alt_group->last_insn = last_orig_insn;
1393

1394

1395 1396 1397 1398
	new_alt_group = malloc(sizeof(*new_alt_group));
	if (!new_alt_group) {
		WARN("malloc failed");
		return -1;
1399 1400
	}

1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411
	if (special_alt->new_len < special_alt->orig_len) {
		/*
		 * Insert a fake nop at the end to make the replacement
		 * alt_group the same size as the original.  This is needed to
		 * allow propagate_alt_cfi() to do its magic.  When the last
		 * instruction affects the stack, the instruction after it (the
		 * nop) will propagate the new state to the shared CFI array.
		 */
		nop = malloc(sizeof(*nop));
		if (!nop) {
			WARN("malloc failed");
1412 1413
			return -1;
		}
1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424
		memset(nop, 0, sizeof(*nop));
		INIT_LIST_HEAD(&nop->alts);
		INIT_LIST_HEAD(&nop->stack_ops);

		nop->sec = special_alt->new_sec;
		nop->offset = special_alt->new_off + special_alt->new_len;
		nop->len = special_alt->orig_len - special_alt->new_len;
		nop->type = INSN_NOP;
		nop->func = orig_insn->func;
		nop->alt_group = new_alt_group;
		nop->ignore = orig_insn->ignore_alts;
1425
	}
1426

1427 1428 1429
	if (!special_alt->new_len) {
		*new_insn = nop;
		goto end;
1430 1431 1432 1433
	}

	insn = *new_insn;
	sec_for_each_insn_from(file, insn) {
1434 1435
		struct reloc *alt_reloc;

1436 1437 1438 1439 1440
		if (insn->offset >= special_alt->new_off + special_alt->new_len)
			break;

		last_new_insn = insn;

1441
		insn->ignore = orig_insn->ignore_alts;
1442
		insn->func = orig_insn->func;
J
Josh Poimboeuf 已提交
1443
		insn->alt_group = new_alt_group;
1444

1445 1446 1447 1448 1449 1450 1451 1452
		/*
		 * Since alternative replacement code is copy/pasted by the
		 * kernel after applying relocations, generally such code can't
		 * have relative-address relocation references to outside the
		 * .altinstr_replacement section, unless the arch's
		 * alternatives code can adjust the relative offsets
		 * accordingly.
		 */
1453
		alt_reloc = insn_reloc(file, insn);
1454 1455
		if (alt_reloc &&
		    !arch_support_alt_relocation(special_alt, insn, alt_reloc)) {
1456 1457 1458 1459 1460 1461

			WARN_FUNC("unsupported relocation in alternatives section",
				  insn->sec, insn->offset);
			return -1;
		}

1462
		if (!is_static_jump(insn))
1463 1464 1465 1466 1467
			continue;

		if (!insn->immediate)
			continue;

1468
		dest_off = arch_jump_destination(insn);
1469 1470
		if (dest_off == special_alt->new_off + special_alt->new_len)
			insn->jump_dest = next_insn_same_sec(file, last_orig_insn);
1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484

		if (!insn->jump_dest) {
			WARN_FUNC("can't find alternative jump destination",
				  insn->sec, insn->offset);
			return -1;
		}
	}

	if (!last_new_insn) {
		WARN_FUNC("can't find last new alternative instruction",
			  special_alt->new_sec, special_alt->new_off);
		return -1;
	}

1485 1486 1487
	if (nop)
		list_add(&nop->list, &last_new_insn->list);
end:
J
Josh Poimboeuf 已提交
1488 1489
	new_alt_group->orig_group = orig_alt_group;
	new_alt_group->first_insn = *new_insn;
1490 1491
	new_alt_group->last_insn = nop ? : last_new_insn;
	new_alt_group->cfi = orig_alt_group->cfi;
1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504
	return 0;
}

/*
 * A jump table entry can either convert a nop to a jump or a jump to a nop.
 * If the original instruction is a jump, make the alt entry an effective nop
 * by just skipping the original instruction.
 */
static int handle_jump_alt(struct objtool_file *file,
			   struct special_alt *special_alt,
			   struct instruction *orig_insn,
			   struct instruction **new_insn)
{
1505 1506
	if (orig_insn->type != INSN_JUMP_UNCONDITIONAL &&
	    orig_insn->type != INSN_NOP) {
1507

1508 1509 1510 1511 1512
		WARN_FUNC("unsupported instruction at jump label",
			  orig_insn->sec, orig_insn->offset);
		return -1;
	}

1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523
	if (special_alt->key_addend & 2) {
		struct reloc *reloc = insn_reloc(file, orig_insn);

		if (reloc) {
			reloc->type = R_NONE;
			elf_write_reloc(file->elf, reloc);
		}
		elf_write_insn(file->elf, orig_insn->sec,
			       orig_insn->offset, orig_insn->len,
			       arch_nop_insn(orig_insn->len));
		orig_insn->type = INSN_NOP;
1524 1525 1526 1527 1528 1529 1530 1531 1532
	}

	if (orig_insn->type == INSN_NOP) {
		if (orig_insn->len == 2)
			file->jl_nop_short++;
		else
			file->jl_nop_long++;

		return 0;
1533 1534
	}

1535 1536 1537 1538 1539
	if (orig_insn->len == 2)
		file->jl_short++;
	else
		file->jl_long++;

1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586
	*new_insn = list_next_entry(orig_insn, list);
	return 0;
}

/*
 * Read all the special sections which have alternate instructions which can be
 * patched in or redirected to at runtime.  Each instruction having alternate
 * instruction(s) has them added to its insn->alts list, which will be
 * traversed in validate_branch().
 */
static int add_special_section_alts(struct objtool_file *file)
{
	struct list_head special_alts;
	struct instruction *orig_insn, *new_insn;
	struct special_alt *special_alt, *tmp;
	struct alternative *alt;
	int ret;

	ret = special_get_alts(file->elf, &special_alts);
	if (ret)
		return ret;

	list_for_each_entry_safe(special_alt, tmp, &special_alts, list) {

		orig_insn = find_insn(file, special_alt->orig_sec,
				      special_alt->orig_off);
		if (!orig_insn) {
			WARN_FUNC("special: can't find orig instruction",
				  special_alt->orig_sec, special_alt->orig_off);
			ret = -1;
			goto out;
		}

		new_insn = NULL;
		if (!special_alt->group || special_alt->new_len) {
			new_insn = find_insn(file, special_alt->new_sec,
					     special_alt->new_off);
			if (!new_insn) {
				WARN_FUNC("special: can't find new instruction",
					  special_alt->new_sec,
					  special_alt->new_off);
				ret = -1;
				goto out;
			}
		}

		if (special_alt->group) {
1587 1588 1589 1590 1591 1592
			if (!special_alt->orig_len) {
				WARN_FUNC("empty alternative entry",
					  orig_insn->sec, orig_insn->offset);
				continue;
			}

1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603
			ret = handle_group_alt(file, special_alt, orig_insn,
					       &new_insn);
			if (ret)
				goto out;
		} else if (special_alt->jump_or_nop) {
			ret = handle_jump_alt(file, special_alt, orig_insn,
					      &new_insn);
			if (ret)
				goto out;
		}

1604 1605 1606 1607 1608 1609 1610
		alt = malloc(sizeof(*alt));
		if (!alt) {
			WARN("malloc failed");
			ret = -1;
			goto out;
		}

1611
		alt->insn = new_insn;
P
Peter Zijlstra 已提交
1612
		alt->skip_orig = special_alt->skip_orig;
P
Peter Zijlstra 已提交
1613
		orig_insn->ignore_alts |= special_alt->skip_alt;
1614 1615 1616 1617 1618 1619
		list_add_tail(&alt->list, &orig_insn->alts);

		list_del(&special_alt->list);
		free(special_alt);
	}

1620 1621 1622 1623 1624 1625
	if (stats) {
		printf("jl\\\tNOP\tJMP\n");
		printf("short:\t%ld\t%ld\n", file->jl_nop_short, file->jl_short);
		printf("long:\t%ld\t%ld\n", file->jl_nop_long, file->jl_long);
	}

1626 1627 1628 1629
out:
	return ret;
}

1630
static int add_jump_table(struct objtool_file *file, struct instruction *insn,
M
Matt Helsley 已提交
1631
			    struct reloc *table)
1632
{
M
Matt Helsley 已提交
1633
	struct reloc *reloc = table;
1634
	struct instruction *dest_insn;
1635
	struct alternative *alt;
1636 1637
	struct symbol *pfunc = insn->func->pfunc;
	unsigned int prev_offset = 0;
1638

1639
	/*
M
Matt Helsley 已提交
1640
	 * Each @reloc is a switch table relocation which points to the target
1641 1642
	 * instruction.
	 */
M
Matt Helsley 已提交
1643
	list_for_each_entry_from(reloc, &table->sec->reloc_list, list) {
1644 1645

		/* Check for the end of the table: */
M
Matt Helsley 已提交
1646
		if (reloc != table && reloc->jump_table_start)
1647 1648
			break;

1649
		/* Make sure the table entries are consecutive: */
M
Matt Helsley 已提交
1650
		if (prev_offset && reloc->offset != prev_offset + 8)
1651 1652 1653
			break;

		/* Detect function pointers from contiguous objects: */
M
Matt Helsley 已提交
1654 1655
		if (reloc->sym->sec == pfunc->sec &&
		    reloc->addend == pfunc->offset)
1656 1657
			break;

M
Matt Helsley 已提交
1658
		dest_insn = find_insn(file, reloc->sym->sec, reloc->addend);
1659
		if (!dest_insn)
1660 1661
			break;

1662
		/* Make sure the destination is in the same function: */
1663
		if (!dest_insn->func || dest_insn->func->pfunc != pfunc)
1664
			break;
1665 1666 1667 1668 1669 1670 1671

		alt = malloc(sizeof(*alt));
		if (!alt) {
			WARN("malloc failed");
			return -1;
		}

1672
		alt->insn = dest_insn;
1673
		list_add_tail(&alt->list, &insn->alts);
M
Matt Helsley 已提交
1674
		prev_offset = reloc->offset;
1675 1676 1677 1678 1679 1680
	}

	if (!prev_offset) {
		WARN_FUNC("can't find switch jump table",
			  insn->sec, insn->offset);
		return -1;
1681 1682 1683 1684 1685 1686
	}

	return 0;
}

/*
1687 1688
 * find_jump_table() - Given a dynamic jump, find the switch jump table
 * associated with it.
1689
 */
M
Matt Helsley 已提交
1690
static struct reloc *find_jump_table(struct objtool_file *file,
1691 1692 1693
				      struct symbol *func,
				      struct instruction *insn)
{
1694
	struct reloc *table_reloc;
1695
	struct instruction *dest_insn, *orig_insn = insn;
1696

1697 1698 1699 1700 1701
	/*
	 * Backward search using the @first_jump_src links, these help avoid
	 * much of the 'in between' code. Which avoids us getting confused by
	 * it.
	 */
1702
	for (;
1703 1704
	     insn && insn->func && insn->func->pfunc == func;
	     insn = insn->first_jump_src ?: prev_insn_same_sym(file, insn)) {
1705

1706
		if (insn != orig_insn && insn->type == INSN_JUMP_DYNAMIC)
1707 1708 1709 1710 1711 1712 1713 1714 1715
			break;

		/* allow small jumps within the range */
		if (insn->type == INSN_JUMP_UNCONDITIONAL &&
		    insn->jump_dest &&
		    (insn->jump_dest->offset <= insn->offset ||
		     insn->jump_dest->offset > orig_insn->offset))
		    break;

1716
		table_reloc = arch_find_switch_table(file, insn);
M
Matt Helsley 已提交
1717
		if (!table_reloc)
1718
			continue;
M
Matt Helsley 已提交
1719
		dest_insn = find_insn(file, table_reloc->sym->sec, table_reloc->addend);
1720 1721
		if (!dest_insn || !dest_insn->func || dest_insn->func->pfunc != func)
			continue;
1722

M
Matt Helsley 已提交
1723
		return table_reloc;
1724 1725 1726 1727 1728
	}

	return NULL;
}

1729 1730 1731 1732 1733 1734
/*
 * First pass: Mark the head of each jump table so that in the next pass,
 * we know when a given jump table ends and the next one starts.
 */
static void mark_func_jump_tables(struct objtool_file *file,
				    struct symbol *func)
1735
{
1736
	struct instruction *insn, *last = NULL;
M
Matt Helsley 已提交
1737
	struct reloc *reloc;
1738

1739
	func_for_each_insn(file, func, insn) {
1740 1741 1742 1743 1744
		if (!last)
			last = insn;

		/*
		 * Store back-pointers for unconditional forward jumps such
1745
		 * that find_jump_table() can back-track using those and
1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756
		 * avoid some potentially confusing code.
		 */
		if (insn->type == INSN_JUMP_UNCONDITIONAL && insn->jump_dest &&
		    insn->offset > last->offset &&
		    insn->jump_dest->offset > insn->offset &&
		    !insn->jump_dest->first_jump_src) {

			insn->jump_dest->first_jump_src = insn;
			last = insn->jump_dest;
		}

1757 1758 1759
		if (insn->type != INSN_JUMP_DYNAMIC)
			continue;

M
Matt Helsley 已提交
1760 1761 1762 1763
		reloc = find_jump_table(file, func, insn);
		if (reloc) {
			reloc->jump_table_start = true;
			insn->jump_table = reloc;
1764 1765
		}
	}
1766 1767 1768 1769 1770 1771 1772 1773
}

static int add_func_jump_tables(struct objtool_file *file,
				  struct symbol *func)
{
	struct instruction *insn;
	int ret;

1774
	func_for_each_insn(file, func, insn) {
1775 1776
		if (!insn->jump_table)
			continue;
1777

1778
		ret = add_jump_table(file, insn, insn->jump_table);
1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790
		if (ret)
			return ret;
	}

	return 0;
}

/*
 * For some switch statements, gcc generates a jump table in the .rodata
 * section which contains a list of addresses within the function to jump to.
 * This finds these jump tables and adds them to the insn->alts lists.
 */
1791
static int add_jump_table_alts(struct objtool_file *file)
1792 1793 1794 1795 1796
{
	struct section *sec;
	struct symbol *func;
	int ret;

1797
	if (!file->rodata)
1798 1799
		return 0;

1800
	for_each_sec(file, sec) {
1801 1802 1803 1804
		list_for_each_entry(func, &sec->symbol_list, list) {
			if (func->type != STT_FUNC)
				continue;

1805
			mark_func_jump_tables(file, func);
1806
			ret = add_func_jump_tables(file, func);
1807 1808 1809 1810 1811 1812 1813 1814
			if (ret)
				return ret;
		}
	}

	return 0;
}

1815 1816 1817 1818 1819 1820 1821 1822
static void set_func_state(struct cfi_state *state)
{
	state->cfa = initial_func_cfi.cfa;
	memcpy(&state->regs, &initial_func_cfi.regs,
	       CFI_NUM_REGS * sizeof(struct cfi_reg));
	state->stack_size = initial_func_cfi.cfa.offset;
}

1823 1824
static int read_unwind_hints(struct objtool_file *file)
{
P
Peter Zijlstra 已提交
1825
	struct cfi_state cfi = init_cfi;
M
Matt Helsley 已提交
1826
	struct section *sec, *relocsec;
1827 1828
	struct unwind_hint *hint;
	struct instruction *insn;
P
Peter Zijlstra 已提交
1829
	struct reloc *reloc;
1830 1831 1832 1833 1834 1835
	int i;

	sec = find_section_by_name(file->elf, ".discard.unwind_hints");
	if (!sec)
		return 0;

M
Matt Helsley 已提交
1836 1837
	relocsec = sec->reloc;
	if (!relocsec) {
1838 1839 1840 1841
		WARN("missing .rela.discard.unwind_hints section");
		return -1;
	}

1842
	if (sec->sh.sh_size % sizeof(struct unwind_hint)) {
1843 1844 1845 1846 1847 1848
		WARN("struct unwind_hint size mismatch");
		return -1;
	}

	file->hints = true;

1849
	for (i = 0; i < sec->sh.sh_size / sizeof(struct unwind_hint); i++) {
1850 1851
		hint = (struct unwind_hint *)sec->data->d_buf + i;

M
Matt Helsley 已提交
1852 1853 1854
		reloc = find_reloc_by_dest(file->elf, sec, i * sizeof(*hint));
		if (!reloc) {
			WARN("can't find reloc for unwind_hints[%d]", i);
1855 1856 1857
			return -1;
		}

M
Matt Helsley 已提交
1858
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
1859 1860 1861 1862 1863
		if (!insn) {
			WARN("can't find insn for unwind_hints[%d]", i);
			return -1;
		}

1864
		insn->hint = true;
1865

1866 1867 1868 1869 1870 1871 1872 1873 1874 1875
		if (ibt && hint->type == UNWIND_HINT_TYPE_REGS_PARTIAL) {
			struct symbol *sym = find_symbol_by_offset(insn->sec, insn->offset);

			if (sym && sym->bind == STB_GLOBAL &&
			    insn->type != INSN_ENDBR && !insn->noendbr) {
				WARN_FUNC("UNWIND_HINT_IRET_REGS without ENDBR",
					  insn->sec, insn->offset);
			}
		}

1876
		if (hint->type == UNWIND_HINT_TYPE_FUNC) {
P
Peter Zijlstra 已提交
1877
			insn->cfi = &func_cfi;
1878 1879 1880
			continue;
		}

P
Peter Zijlstra 已提交
1881 1882 1883 1884
		if (insn->cfi)
			cfi = *(insn->cfi);

		if (arch_decode_hint_reg(hint->sp_reg, &cfi.cfa.base)) {
1885 1886 1887 1888 1889
			WARN_FUNC("unsupported unwind_hint sp base reg %d",
				  insn->sec, insn->offset, hint->sp_reg);
			return -1;
		}

P
Peter Zijlstra 已提交
1890 1891 1892 1893 1894
		cfi.cfa.offset = bswap_if_needed(hint->sp_offset);
		cfi.type = hint->type;
		cfi.end = hint->end;

		insn->cfi = cfi_hash_find_or_add(&cfi);
1895 1896 1897 1898 1899
	}

	return 0;
}

1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916
static int read_noendbr_hints(struct objtool_file *file)
{
	struct section *sec;
	struct instruction *insn;
	struct reloc *reloc;

	sec = find_section_by_name(file->elf, ".rela.discard.noendbr");
	if (!sec)
		return 0;

	list_for_each_entry(reloc, &sec->reloc_list, list) {
		insn = find_insn(file, reloc->sym->sec, reloc->sym->offset + reloc->addend);
		if (!insn) {
			WARN("bad .discard.noendbr entry");
			return -1;
		}

1917 1918 1919
		if (insn->type == INSN_ENDBR)
			WARN_FUNC("ANNOTATE_NOENDBR on ENDBR", insn->sec, insn->offset);

1920 1921 1922 1923 1924 1925
		insn->noendbr = 1;
	}

	return 0;
}

1926 1927
static int read_retpoline_hints(struct objtool_file *file)
{
J
Josh Poimboeuf 已提交
1928
	struct section *sec;
1929
	struct instruction *insn;
M
Matt Helsley 已提交
1930
	struct reloc *reloc;
1931

J
Josh Poimboeuf 已提交
1932
	sec = find_section_by_name(file->elf, ".rela.discard.retpoline_safe");
1933 1934 1935
	if (!sec)
		return 0;

M
Matt Helsley 已提交
1936 1937
	list_for_each_entry(reloc, &sec->reloc_list, list) {
		if (reloc->sym->type != STT_SECTION) {
J
Josh Poimboeuf 已提交
1938
			WARN("unexpected relocation symbol type in %s", sec->name);
1939 1940 1941
			return -1;
		}

M
Matt Helsley 已提交
1942
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
1943
		if (!insn) {
J
Josh Poimboeuf 已提交
1944
			WARN("bad .discard.retpoline_safe entry");
1945 1946 1947 1948 1949
			return -1;
		}

		if (insn->type != INSN_JUMP_DYNAMIC &&
		    insn->type != INSN_CALL_DYNAMIC) {
J
Josh Poimboeuf 已提交
1950
			WARN_FUNC("retpoline_safe hint not an indirect jump/call",
1951 1952 1953 1954 1955 1956 1957 1958 1959 1960
				  insn->sec, insn->offset);
			return -1;
		}

		insn->retpoline_safe = true;
	}

	return 0;
}

1961 1962 1963 1964
static int read_instr_hints(struct objtool_file *file)
{
	struct section *sec;
	struct instruction *insn;
M
Matt Helsley 已提交
1965
	struct reloc *reloc;
1966 1967 1968 1969 1970

	sec = find_section_by_name(file->elf, ".rela.discard.instr_end");
	if (!sec)
		return 0;

M
Matt Helsley 已提交
1971 1972
	list_for_each_entry(reloc, &sec->reloc_list, list) {
		if (reloc->sym->type != STT_SECTION) {
1973 1974 1975 1976
			WARN("unexpected relocation symbol type in %s", sec->name);
			return -1;
		}

M
Matt Helsley 已提交
1977
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989
		if (!insn) {
			WARN("bad .discard.instr_end entry");
			return -1;
		}

		insn->instr--;
	}

	sec = find_section_by_name(file->elf, ".rela.discard.instr_begin");
	if (!sec)
		return 0;

M
Matt Helsley 已提交
1990 1991
	list_for_each_entry(reloc, &sec->reloc_list, list) {
		if (reloc->sym->type != STT_SECTION) {
1992 1993 1994 1995
			WARN("unexpected relocation symbol type in %s", sec->name);
			return -1;
		}

M
Matt Helsley 已提交
1996
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007
		if (!insn) {
			WARN("bad .discard.instr_begin entry");
			return -1;
		}

		insn->instr++;
	}

	return 0;
}

2008 2009 2010 2011
static int read_intra_function_calls(struct objtool_file *file)
{
	struct instruction *insn;
	struct section *sec;
M
Matt Helsley 已提交
2012
	struct reloc *reloc;
2013 2014 2015 2016 2017

	sec = find_section_by_name(file->elf, ".rela.discard.intra_function_calls");
	if (!sec)
		return 0;

M
Matt Helsley 已提交
2018
	list_for_each_entry(reloc, &sec->reloc_list, list) {
2019 2020
		unsigned long dest_off;

M
Matt Helsley 已提交
2021
		if (reloc->sym->type != STT_SECTION) {
2022 2023 2024 2025 2026
			WARN("unexpected relocation symbol type in %s",
			     sec->name);
			return -1;
		}

M
Matt Helsley 已提交
2027
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058
		if (!insn) {
			WARN("bad .discard.intra_function_call entry");
			return -1;
		}

		if (insn->type != INSN_CALL) {
			WARN_FUNC("intra_function_call not a direct call",
				  insn->sec, insn->offset);
			return -1;
		}

		/*
		 * Treat intra-function CALLs as JMPs, but with a stack_op.
		 * See add_call_destinations(), which strips stack_ops from
		 * normal CALLs.
		 */
		insn->type = INSN_JUMP_UNCONDITIONAL;

		dest_off = insn->offset + insn->len + insn->immediate;
		insn->jump_dest = find_insn(file, insn->sec, dest_off);
		if (!insn->jump_dest) {
			WARN_FUNC("can't find call dest at %s+0x%lx",
				  insn->sec, insn->offset,
				  insn->sec->name, dest_off);
			return -1;
		}
	}

	return 0;
}

2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083
/*
 * Return true if name matches an instrumentation function, where calls to that
 * function from noinstr code can safely be removed, but compilers won't do so.
 */
static bool is_profiling_func(const char *name)
{
	/*
	 * Many compilers cannot disable KCOV with a function attribute.
	 */
	if (!strncmp(name, "__sanitizer_cov_", 16))
		return true;

	/*
	 * Some compilers currently do not remove __tsan_func_entry/exit nor
	 * __tsan_atomic_signal_fence (used for barrier instrumentation) with
	 * the __no_sanitize_thread attribute, remove them. Once the kernel's
	 * minimum Clang version is 14.0, this can be removed.
	 */
	if (!strncmp(name, "__tsan_func_", 12) ||
	    !strcmp(name, "__tsan_atomic_signal_fence"))
		return true;

	return false;
}

P
Peter Zijlstra 已提交
2084
static int classify_symbols(struct objtool_file *file)
2085 2086 2087 2088 2089 2090
{
	struct section *sec;
	struct symbol *func;

	for_each_sec(file, sec) {
		list_for_each_entry(func, &sec->symbol_list, list) {
P
Peter Zijlstra 已提交
2091 2092 2093 2094
			if (func->bind != STB_GLOBAL)
				continue;

			if (!strncmp(func->name, STATIC_CALL_TRAMP_PREFIX_STR,
2095 2096
				     strlen(STATIC_CALL_TRAMP_PREFIX_STR)))
				func->static_call_tramp = true;
P
Peter Zijlstra 已提交
2097 2098 2099 2100 2101 2102 2103

			if (arch_is_retpoline(func))
				func->retpoline_thunk = true;

			if (!strcmp(func->name, "__fentry__"))
				func->fentry = true;

2104 2105
			if (is_profiling_func(func->name))
				func->profiling_func = true;
2106 2107 2108 2109 2110 2111
		}
	}

	return 0;
}

2112 2113 2114 2115 2116 2117
static void mark_rodata(struct objtool_file *file)
{
	struct section *sec;
	bool found = false;

	/*
2118 2119 2120 2121 2122 2123 2124 2125
	 * Search for the following rodata sections, each of which can
	 * potentially contain jump tables:
	 *
	 * - .rodata: can contain GCC switch tables
	 * - .rodata.<func>: same, if -fdata-sections is being used
	 * - .rodata..c_jump_table: contains C annotated jump tables
	 *
	 * .rodata.str1.* sections are ignored; they don't contain jump tables.
2126 2127
	 */
	for_each_sec(file, sec) {
2128 2129
		if (!strncmp(sec->name, ".rodata", 7) &&
		    !strstr(sec->name, ".str1.")) {
2130 2131 2132 2133 2134 2135 2136 2137
			sec->rodata = true;
			found = true;
		}
	}

	file->rodata = found;
}

2138 2139 2140 2141
static int decode_sections(struct objtool_file *file)
{
	int ret;

2142 2143
	mark_rodata(file);

2144 2145 2146 2147
	ret = init_pv_ops(file);
	if (ret)
		return ret;

2148 2149 2150 2151 2152
	ret = decode_instructions(file);
	if (ret)
		return ret;

	add_ignores(file);
P
Peter Zijlstra 已提交
2153
	add_uaccess_safe(file);
2154

2155
	ret = add_ignore_alternatives(file);
2156 2157 2158
	if (ret)
		return ret;

2159 2160 2161
	/*
	 * Must be before read_unwind_hints() since that needs insn->noendbr.
	 */
2162 2163 2164 2165
	ret = read_noendbr_hints(file);
	if (ret)
		return ret;

2166 2167 2168
	/*
	 * Must be before add_{jump_call}_destination.
	 */
P
Peter Zijlstra 已提交
2169
	ret = classify_symbols(file);
P
Peter Zijlstra 已提交
2170 2171 2172
	if (ret)
		return ret;

2173 2174 2175 2176
	/*
	 * Must be before add_special_section_alts() as that depends on
	 * jump_dest being set.
	 */
2177 2178 2179 2180
	ret = add_jump_destinations(file);
	if (ret)
		return ret;

2181
	ret = add_special_section_alts(file);
2182 2183 2184
	if (ret)
		return ret;

2185 2186 2187 2188
	/*
	 * Must be before add_call_destination(); it changes INSN_CALL to
	 * INSN_JUMP.
	 */
2189 2190 2191 2192
	ret = read_intra_function_calls(file);
	if (ret)
		return ret;

2193
	ret = add_call_destinations(file);
2194 2195 2196
	if (ret)
		return ret;

P
Peter Zijlstra 已提交
2197 2198 2199 2200 2201 2202 2203 2204
	/*
	 * Must be after add_call_destinations() such that it can override
	 * dead_end_function() marks.
	 */
	ret = add_dead_ends(file);
	if (ret)
		return ret;

2205
	ret = add_jump_table_alts(file);
2206 2207 2208
	if (ret)
		return ret;

2209 2210 2211 2212
	ret = read_unwind_hints(file);
	if (ret)
		return ret;

2213 2214 2215 2216
	ret = read_retpoline_hints(file);
	if (ret)
		return ret;

2217 2218 2219 2220
	ret = read_instr_hints(file);
	if (ret)
		return ret;

2221 2222 2223 2224 2225
	return 0;
}

static bool is_fentry_call(struct instruction *insn)
{
P
Peter Zijlstra 已提交
2226 2227 2228
	if (insn->type == INSN_CALL &&
	    insn->call_dest &&
	    insn->call_dest->fentry)
2229 2230 2231 2232 2233
		return true;

	return false;
}

2234
static bool has_modified_stack_frame(struct instruction *insn, struct insn_state *state)
2235
{
2236
	struct cfi_state *cfi = &state->cfi;
2237 2238
	int i;

2239
	if (cfi->cfa.base != initial_func_cfi.cfa.base || cfi->drap)
2240 2241
		return true;

2242
	if (cfi->cfa.offset != initial_func_cfi.cfa.offset)
2243 2244
		return true;

2245
	if (cfi->stack_size != initial_func_cfi.cfa.offset)
2246 2247 2248
		return true;

	for (i = 0; i < CFI_NUM_REGS; i++) {
2249 2250
		if (cfi->regs[i].base != initial_func_cfi.regs[i].base ||
		    cfi->regs[i].offset != initial_func_cfi.regs[i].offset)
2251
			return true;
2252
	}
2253 2254 2255 2256

	return false;
}

2257 2258 2259 2260 2261 2262 2263
static bool check_reg_frame_pos(const struct cfi_reg *reg,
				int expected_offset)
{
	return reg->base == CFI_CFA &&
	       reg->offset == expected_offset;
}

2264 2265
static bool has_valid_stack_frame(struct insn_state *state)
{
2266 2267
	struct cfi_state *cfi = &state->cfi;

2268 2269 2270
	if (cfi->cfa.base == CFI_BP &&
	    check_reg_frame_pos(&cfi->regs[CFI_BP], -cfi->cfa.offset) &&
	    check_reg_frame_pos(&cfi->regs[CFI_RA], -cfi->cfa.offset + 8))
2271 2272
		return true;

2273
	if (cfi->drap && cfi->regs[CFI_BP].base == CFI_BP)
2274 2275 2276
		return true;

	return false;
2277 2278
}

2279 2280
static int update_cfi_state_regs(struct instruction *insn,
				  struct cfi_state *cfi,
2281
				  struct stack_op *op)
2282
{
2283
	struct cfi_reg *cfa = &cfi->cfa;
2284

2285
	if (cfa->base != CFI_SP && cfa->base != CFI_SP_INDIRECT)
2286 2287 2288
		return 0;

	/* push */
P
Peter Zijlstra 已提交
2289
	if (op->dest.type == OP_DEST_PUSH || op->dest.type == OP_DEST_PUSHF)
2290 2291 2292
		cfa->offset += 8;

	/* pop */
P
Peter Zijlstra 已提交
2293
	if (op->src.type == OP_SRC_POP || op->src.type == OP_SRC_POPF)
2294 2295 2296 2297 2298 2299 2300 2301 2302 2303
		cfa->offset -= 8;

	/* add immediate to sp */
	if (op->dest.type == OP_DEST_REG && op->src.type == OP_SRC_ADD &&
	    op->dest.reg == CFI_SP && op->src.reg == CFI_SP)
		cfa->offset -= op->src.offset;

	return 0;
}

2304
static void save_reg(struct cfi_state *cfi, unsigned char reg, int base, int offset)
2305
{
2306
	if (arch_callee_saved_reg(reg) &&
2307 2308 2309
	    cfi->regs[reg].base == CFI_UNDEFINED) {
		cfi->regs[reg].base = base;
		cfi->regs[reg].offset = offset;
2310
	}
2311 2312
}

2313
static void restore_reg(struct cfi_state *cfi, unsigned char reg)
2314
{
2315 2316
	cfi->regs[reg].base = initial_func_cfi.regs[reg].base;
	cfi->regs[reg].offset = initial_func_cfi.regs[reg].offset;
2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371
}

/*
 * A note about DRAP stack alignment:
 *
 * GCC has the concept of a DRAP register, which is used to help keep track of
 * the stack pointer when aligning the stack.  r10 or r13 is used as the DRAP
 * register.  The typical DRAP pattern is:
 *
 *   4c 8d 54 24 08		lea    0x8(%rsp),%r10
 *   48 83 e4 c0		and    $0xffffffffffffffc0,%rsp
 *   41 ff 72 f8		pushq  -0x8(%r10)
 *   55				push   %rbp
 *   48 89 e5			mov    %rsp,%rbp
 *				(more pushes)
 *   41 52			push   %r10
 *				...
 *   41 5a			pop    %r10
 *				(more pops)
 *   5d				pop    %rbp
 *   49 8d 62 f8		lea    -0x8(%r10),%rsp
 *   c3				retq
 *
 * There are some variations in the epilogues, like:
 *
 *   5b				pop    %rbx
 *   41 5a			pop    %r10
 *   41 5c			pop    %r12
 *   41 5d			pop    %r13
 *   41 5e			pop    %r14
 *   c9				leaveq
 *   49 8d 62 f8		lea    -0x8(%r10),%rsp
 *   c3				retq
 *
 * and:
 *
 *   4c 8b 55 e8		mov    -0x18(%rbp),%r10
 *   48 8b 5d e0		mov    -0x20(%rbp),%rbx
 *   4c 8b 65 f0		mov    -0x10(%rbp),%r12
 *   4c 8b 6d f8		mov    -0x8(%rbp),%r13
 *   c9				leaveq
 *   49 8d 62 f8		lea    -0x8(%r10),%rsp
 *   c3				retq
 *
 * Sometimes r13 is used as the DRAP register, in which case it's saved and
 * restored beforehand:
 *
 *   41 55			push   %r13
 *   4c 8d 6c 24 10		lea    0x10(%rsp),%r13
 *   48 83 e4 f0		and    $0xfffffffffffffff0,%rsp
 *				...
 *   49 8d 65 f0		lea    -0x10(%r13),%rsp
 *   41 5d			pop    %r13
 *   c3				retq
 */
2372 2373 2374
static int update_cfi_state(struct instruction *insn,
			    struct instruction *next_insn,
			    struct cfi_state *cfi, struct stack_op *op)
2375
{
2376 2377
	struct cfi_reg *cfa = &cfi->cfa;
	struct cfi_reg *regs = cfi->regs;
2378 2379 2380 2381 2382 2383 2384 2385 2386 2387

	/* stack operations don't make sense with an undefined CFA */
	if (cfa->base == CFI_UNDEFINED) {
		if (insn->func) {
			WARN_FUNC("undefined stack state", insn->sec, insn->offset);
			return -1;
		}
		return 0;
	}

2388 2389
	if (cfi->type == UNWIND_HINT_TYPE_REGS ||
	    cfi->type == UNWIND_HINT_TYPE_REGS_PARTIAL)
2390
		return update_cfi_state_regs(insn, cfi, op);
2391

2392 2393 2394 2395 2396 2397
	switch (op->dest.type) {

	case OP_DEST_REG:
		switch (op->src.type) {

		case OP_SRC_REG:
2398 2399
			if (op->src.reg == CFI_SP && op->dest.reg == CFI_BP &&
			    cfa->base == CFI_SP &&
2400
			    check_reg_frame_pos(&regs[CFI_BP], -cfa->offset)) {
2401 2402 2403

				/* mov %rsp, %rbp */
				cfa->base = op->dest.reg;
2404
				cfi->bp_scratch = false;
2405
			}
2406

2407
			else if (op->src.reg == CFI_SP &&
2408
				 op->dest.reg == CFI_BP && cfi->drap) {
2409

2410 2411
				/* drap: mov %rsp, %rbp */
				regs[CFI_BP].base = CFI_BP;
2412 2413
				regs[CFI_BP].offset = -cfi->stack_size;
				cfi->bp_scratch = false;
2414
			}
2415

2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427
			else if (op->src.reg == CFI_SP && cfa->base == CFI_SP) {

				/*
				 * mov %rsp, %reg
				 *
				 * This is needed for the rare case where GCC
				 * does:
				 *
				 *   mov    %rsp, %rax
				 *   ...
				 *   mov    %rax, %rsp
				 */
2428 2429
				cfi->vals[op->dest.reg].base = CFI_CFA;
				cfi->vals[op->dest.reg].offset = -cfi->stack_size;
2430 2431
			}

J
Josh Poimboeuf 已提交
2432
			else if (op->src.reg == CFI_BP && op->dest.reg == CFI_SP &&
P
Peter Zijlstra 已提交
2433
				 (cfa->base == CFI_BP || cfa->base == cfi->drap_reg)) {
J
Josh Poimboeuf 已提交
2434 2435 2436 2437 2438 2439

				/*
				 * mov %rbp, %rsp
				 *
				 * Restore the original stack pointer (Clang).
				 */
2440
				cfi->stack_size = -cfi->regs[CFI_BP].offset;
J
Josh Poimboeuf 已提交
2441 2442
			}

2443 2444 2445 2446
			else if (op->dest.reg == cfa->base) {

				/* mov %reg, %rsp */
				if (cfa->base == CFI_SP &&
2447
				    cfi->vals[op->src.reg].base == CFI_CFA) {
2448 2449 2450 2451 2452 2453 2454 2455 2456

					/*
					 * This is needed for the rare case
					 * where GCC does something dumb like:
					 *
					 *   lea    0x8(%rsp), %rcx
					 *   ...
					 *   mov    %rcx, %rsp
					 */
2457 2458
					cfa->offset = -cfi->vals[op->src.reg].offset;
					cfi->stack_size = cfa->offset;
2459

P
Peter Zijlstra 已提交
2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491
				} else if (cfa->base == CFI_SP &&
					   cfi->vals[op->src.reg].base == CFI_SP_INDIRECT &&
					   cfi->vals[op->src.reg].offset == cfa->offset) {

					/*
					 * Stack swizzle:
					 *
					 * 1: mov %rsp, (%[tos])
					 * 2: mov %[tos], %rsp
					 *    ...
					 * 3: pop %rsp
					 *
					 * Where:
					 *
					 * 1 - places a pointer to the previous
					 *     stack at the Top-of-Stack of the
					 *     new stack.
					 *
					 * 2 - switches to the new stack.
					 *
					 * 3 - pops the Top-of-Stack to restore
					 *     the original stack.
					 *
					 * Note: we set base to SP_INDIRECT
					 * here and preserve offset. Therefore
					 * when the unwinder reaches ToS it
					 * will dereference SP and then add the
					 * offset to find the next frame, IOW:
					 * (%rsp) + offset.
					 */
					cfa->base = CFI_SP_INDIRECT;

2492 2493 2494 2495
				} else {
					cfa->base = CFI_UNDEFINED;
					cfa->offset = 0;
				}
2496 2497
			}

2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511
			else if (op->dest.reg == CFI_SP &&
				 cfi->vals[op->src.reg].base == CFI_SP_INDIRECT &&
				 cfi->vals[op->src.reg].offset == cfa->offset) {

				/*
				 * The same stack swizzle case 2) as above. But
				 * because we can't change cfa->base, case 3)
				 * will become a regular POP. Pretend we're a
				 * PUSH so things don't go unbalanced.
				 */
				cfi->stack_size += 8;
			}


2512 2513 2514 2515 2516 2517
			break;

		case OP_SRC_ADD:
			if (op->dest.reg == CFI_SP && op->src.reg == CFI_SP) {

				/* add imm, %rsp */
2518
				cfi->stack_size -= op->src.offset;
2519 2520 2521 2522 2523 2524 2525 2526
				if (cfa->base == CFI_SP)
					cfa->offset -= op->src.offset;
				break;
			}

			if (op->dest.reg == CFI_SP && op->src.reg == CFI_BP) {

				/* lea disp(%rbp), %rsp */
2527
				cfi->stack_size = -(op->src.offset + regs[CFI_BP].offset);
2528 2529 2530
				break;
			}

2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541
			if (!cfi->drap && op->src.reg == CFI_SP &&
			    op->dest.reg == CFI_BP && cfa->base == CFI_SP &&
			    check_reg_frame_pos(&regs[CFI_BP], -cfa->offset + op->src.offset)) {

				/* lea disp(%rsp), %rbp */
				cfa->base = CFI_BP;
				cfa->offset -= op->src.offset;
				cfi->bp_scratch = false;
				break;
			}

2542
			if (op->src.reg == CFI_SP && cfa->base == CFI_SP) {
2543 2544

				/* drap: lea disp(%rsp), %drap */
2545
				cfi->drap_reg = op->dest.reg;
2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556

				/*
				 * lea disp(%rsp), %reg
				 *
				 * This is needed for the rare case where GCC
				 * does something dumb like:
				 *
				 *   lea    0x8(%rsp), %rcx
				 *   ...
				 *   mov    %rcx, %rsp
				 */
2557 2558 2559
				cfi->vals[op->dest.reg].base = CFI_CFA;
				cfi->vals[op->dest.reg].offset = \
					-cfi->stack_size + op->src.offset;
2560

2561 2562 2563
				break;
			}

2564 2565
			if (cfi->drap && op->dest.reg == CFI_SP &&
			    op->src.reg == cfi->drap_reg) {
2566 2567 2568

				 /* drap: lea disp(%drap), %rsp */
				cfa->base = CFI_SP;
2569 2570 2571
				cfa->offset = cfi->stack_size = -op->src.offset;
				cfi->drap_reg = CFI_UNDEFINED;
				cfi->drap = false;
2572 2573 2574
				break;
			}

2575
			if (op->dest.reg == cfi->cfa.base && !(next_insn && next_insn->hint)) {
2576 2577 2578 2579 2580 2581 2582 2583 2584
				WARN_FUNC("unsupported stack register modification",
					  insn->sec, insn->offset);
				return -1;
			}

			break;

		case OP_SRC_AND:
			if (op->dest.reg != CFI_SP ||
2585 2586
			    (cfi->drap_reg != CFI_UNDEFINED && cfa->base != CFI_SP) ||
			    (cfi->drap_reg == CFI_UNDEFINED && cfa->base != CFI_BP)) {
2587 2588 2589 2590 2591
				WARN_FUNC("unsupported stack pointer realignment",
					  insn->sec, insn->offset);
				return -1;
			}

2592
			if (cfi->drap_reg != CFI_UNDEFINED) {
2593
				/* drap: and imm, %rsp */
2594 2595 2596
				cfa->base = cfi->drap_reg;
				cfa->offset = cfi->stack_size = 0;
				cfi->drap = true;
2597 2598 2599 2600 2601 2602 2603 2604 2605 2606
			}

			/*
			 * Older versions of GCC (4.8ish) realign the stack
			 * without DRAP, with a frame pointer.
			 */

			break;

		case OP_SRC_POP:
P
Peter Zijlstra 已提交
2607
		case OP_SRC_POPF:
P
Peter Zijlstra 已提交
2608 2609 2610 2611 2612 2613 2614
			if (op->dest.reg == CFI_SP && cfa->base == CFI_SP_INDIRECT) {

				/* pop %rsp; # restore from a stack swizzle */
				cfa->base = CFI_SP;
				break;
			}

2615
			if (!cfi->drap && op->dest.reg == cfa->base) {
2616 2617 2618 2619 2620

				/* pop %rbp */
				cfa->base = CFI_SP;
			}

2621 2622 2623
			if (cfi->drap && cfa->base == CFI_BP_INDIRECT &&
			    op->dest.reg == cfi->drap_reg &&
			    cfi->drap_offset == -cfi->stack_size) {
2624

2625
				/* drap: pop %drap */
2626
				cfa->base = cfi->drap_reg;
2627
				cfa->offset = 0;
2628
				cfi->drap_offset = -1;
2629

P
Peter Zijlstra 已提交
2630
			} else if (cfi->stack_size == -regs[op->dest.reg].offset) {
2631

2632
				/* pop %reg */
2633
				restore_reg(cfi, op->dest.reg);
2634 2635
			}

2636
			cfi->stack_size -= 8;
2637 2638 2639 2640 2641 2642
			if (cfa->base == CFI_SP)
				cfa->offset -= 8;

			break;

		case OP_SRC_REG_INDIRECT:
2643 2644 2645 2646 2647 2648 2649 2650
			if (!cfi->drap && op->dest.reg == cfa->base &&
			    op->dest.reg == CFI_BP) {

				/* mov disp(%rsp), %rbp */
				cfa->base = CFI_SP;
				cfa->offset = cfi->stack_size;
			}

2651 2652
			if (cfi->drap && op->src.reg == CFI_BP &&
			    op->src.offset == cfi->drap_offset) {
2653 2654

				/* drap: mov disp(%rbp), %drap */
2655
				cfa->base = cfi->drap_reg;
2656
				cfa->offset = 0;
2657
				cfi->drap_offset = -1;
2658 2659
			}

2660
			if (cfi->drap && op->src.reg == CFI_BP &&
2661 2662 2663
			    op->src.offset == regs[op->dest.reg].offset) {

				/* drap: mov disp(%rbp), %reg */
2664
				restore_reg(cfi, op->dest.reg);
2665 2666 2667 2668 2669 2670

			} else if (op->src.reg == cfa->base &&
			    op->src.offset == regs[op->dest.reg].offset + cfa->offset) {

				/* mov disp(%rbp), %reg */
				/* mov disp(%rsp), %reg */
2671
				restore_reg(cfi, op->dest.reg);
2672 2673 2674 2675 2676 2677

			} else if (op->src.reg == CFI_SP &&
				   op->src.offset == regs[op->dest.reg].offset + cfi->stack_size) {

				/* mov disp(%rsp), %reg */
				restore_reg(cfi, op->dest.reg);
2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690
			}

			break;

		default:
			WARN_FUNC("unknown stack-related instruction",
				  insn->sec, insn->offset);
			return -1;
		}

		break;

	case OP_DEST_PUSH:
P
Peter Zijlstra 已提交
2691
	case OP_DEST_PUSHF:
2692
		cfi->stack_size += 8;
2693 2694 2695 2696 2697 2698
		if (cfa->base == CFI_SP)
			cfa->offset += 8;

		if (op->src.type != OP_SRC_REG)
			break;

2699 2700
		if (cfi->drap) {
			if (op->src.reg == cfa->base && op->src.reg == cfi->drap_reg) {
2701 2702 2703

				/* drap: push %drap */
				cfa->base = CFI_BP_INDIRECT;
2704
				cfa->offset = -cfi->stack_size;
2705

2706
				/* save drap so we know when to restore it */
2707
				cfi->drap_offset = -cfi->stack_size;
2708

2709
			} else if (op->src.reg == CFI_BP && cfa->base == cfi->drap_reg) {
2710 2711

				/* drap: push %rbp */
2712
				cfi->stack_size = 0;
2713

2714
			} else {
2715 2716

				/* drap: push %reg */
2717
				save_reg(cfi, op->src.reg, CFI_BP, -cfi->stack_size);
2718 2719 2720 2721 2722
			}

		} else {

			/* push %reg */
2723
			save_reg(cfi, op->src.reg, CFI_CFA, -cfi->stack_size);
2724 2725 2726
		}

		/* detect when asm code uses rbp as a scratch register */
2727
		if (!no_fp && insn->func && op->src.reg == CFI_BP &&
2728
		    cfa->base != CFI_BP)
2729
			cfi->bp_scratch = true;
2730 2731 2732 2733
		break;

	case OP_DEST_REG_INDIRECT:

2734 2735
		if (cfi->drap) {
			if (op->src.reg == cfa->base && op->src.reg == cfi->drap_reg) {
2736 2737 2738 2739 2740

				/* drap: mov %drap, disp(%rbp) */
				cfa->base = CFI_BP_INDIRECT;
				cfa->offset = op->dest.offset;

2741
				/* save drap offset so we know when to restore it */
2742
				cfi->drap_offset = op->dest.offset;
2743
			} else {
2744 2745

				/* drap: mov reg, disp(%rbp) */
2746
				save_reg(cfi, op->src.reg, CFI_BP, op->dest.offset);
2747 2748 2749 2750 2751 2752
			}

		} else if (op->dest.reg == cfa->base) {

			/* mov reg, disp(%rbp) */
			/* mov reg, disp(%rsp) */
2753 2754
			save_reg(cfi, op->src.reg, CFI_CFA,
				 op->dest.offset - cfi->cfa.offset);
2755 2756 2757 2758 2759 2760

		} else if (op->dest.reg == CFI_SP) {

			/* mov reg, disp(%rsp) */
			save_reg(cfi, op->src.reg, CFI_CFA,
				 op->dest.offset - cfi->stack_size);
P
Peter Zijlstra 已提交
2761 2762 2763 2764 2765 2766

		} else if (op->src.reg == CFI_SP && op->dest.offset == 0) {

			/* mov %rsp, (%reg); # setup a stack swizzle. */
			cfi->vals[op->dest.reg].base = CFI_SP_INDIRECT;
			cfi->vals[op->dest.reg].offset = cfa->offset;
2767 2768 2769 2770 2771
		}

		break;

	case OP_DEST_MEM:
P
Peter Zijlstra 已提交
2772
		if (op->src.type != OP_SRC_POP && op->src.type != OP_SRC_POPF) {
2773 2774 2775 2776 2777 2778
			WARN_FUNC("unknown stack-related memory operation",
				  insn->sec, insn->offset);
			return -1;
		}

		/* pop mem */
2779
		cfi->stack_size -= 8;
2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793
		if (cfa->base == CFI_SP)
			cfa->offset -= 8;

		break;

	default:
		WARN_FUNC("unknown stack-related instruction",
			  insn->sec, insn->offset);
		return -1;
	}

	return 0;
}

2794 2795 2796 2797 2798 2799 2800 2801 2802 2803
/*
 * The stack layouts of alternatives instructions can sometimes diverge when
 * they have stack modifications.  That's fine as long as the potential stack
 * layouts don't conflict at any given potential instruction boundary.
 *
 * Flatten the CFIs of the different alternative code streams (both original
 * and replacement) into a single shared CFI array which can be used to detect
 * conflicts and nicely feed a linear array of ORC entries to the unwinder.
 */
static int propagate_alt_cfi(struct objtool_file *file, struct instruction *insn)
2804
{
2805 2806
	struct cfi_state **alt_cfi;
	int group_off;
2807

2808 2809
	if (!insn->alt_group)
		return 0;
2810

P
Peter Zijlstra 已提交
2811 2812 2813 2814 2815
	if (!insn->cfi) {
		WARN("CFI missing");
		return -1;
	}

2816 2817
	alt_cfi = insn->alt_group->cfi;
	group_off = insn->offset - insn->alt_group->first_insn->offset;
2818

2819
	if (!alt_cfi[group_off]) {
P
Peter Zijlstra 已提交
2820
		alt_cfi[group_off] = insn->cfi;
2821
	} else {
P
Peter Zijlstra 已提交
2822
		if (cficmp(alt_cfi[group_off], insn->cfi)) {
2823 2824
			WARN_FUNC("stack layout conflict in alternatives",
				  insn->sec, insn->offset);
2825 2826
			return -1;
		}
2827 2828 2829 2830 2831
	}

	return 0;
}

2832 2833 2834
static int handle_insn_ops(struct instruction *insn,
			   struct instruction *next_insn,
			   struct insn_state *state)
2835 2836 2837 2838 2839
{
	struct stack_op *op;

	list_for_each_entry(op, &insn->stack_ops, list) {

2840
		if (update_cfi_state(insn, next_insn, &state->cfi, op))
2841
			return 1;
2842

2843 2844 2845
		if (!insn->alt_group)
			continue;

2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870
		if (op->dest.type == OP_DEST_PUSHF) {
			if (!state->uaccess_stack) {
				state->uaccess_stack = 1;
			} else if (state->uaccess_stack >> 31) {
				WARN_FUNC("PUSHF stack exhausted",
					  insn->sec, insn->offset);
				return 1;
			}
			state->uaccess_stack <<= 1;
			state->uaccess_stack  |= state->uaccess;
		}

		if (op->src.type == OP_SRC_POPF) {
			if (state->uaccess_stack) {
				state->uaccess = state->uaccess_stack & 1;
				state->uaccess_stack >>= 1;
				if (state->uaccess_stack == 1)
					state->uaccess_stack = 0;
			}
		}
	}

	return 0;
}

2871
static bool insn_cfi_match(struct instruction *insn, struct cfi_state *cfi2)
2872
{
P
Peter Zijlstra 已提交
2873
	struct cfi_state *cfi1 = insn->cfi;
2874 2875
	int i;

P
Peter Zijlstra 已提交
2876 2877 2878 2879 2880
	if (!cfi1) {
		WARN("CFI missing");
		return false;
	}

2881 2882
	if (memcmp(&cfi1->cfa, &cfi2->cfa, sizeof(cfi1->cfa))) {

2883 2884
		WARN_FUNC("stack state mismatch: cfa1=%d%+d cfa2=%d%+d",
			  insn->sec, insn->offset,
2885 2886
			  cfi1->cfa.base, cfi1->cfa.offset,
			  cfi2->cfa.base, cfi2->cfa.offset);
2887

2888
	} else if (memcmp(&cfi1->regs, &cfi2->regs, sizeof(cfi1->regs))) {
2889
		for (i = 0; i < CFI_NUM_REGS; i++) {
2890
			if (!memcmp(&cfi1->regs[i], &cfi2->regs[i],
2891 2892 2893 2894 2895
				    sizeof(struct cfi_reg)))
				continue;

			WARN_FUNC("stack state mismatch: reg1[%d]=%d%+d reg2[%d]=%d%+d",
				  insn->sec, insn->offset,
2896 2897
				  i, cfi1->regs[i].base, cfi1->regs[i].offset,
				  i, cfi2->regs[i].base, cfi2->regs[i].offset);
2898 2899 2900
			break;
		}

2901 2902
	} else if (cfi1->type != cfi2->type) {

2903
		WARN_FUNC("stack state mismatch: type1=%d type2=%d",
2904 2905 2906 2907 2908
			  insn->sec, insn->offset, cfi1->type, cfi2->type);

	} else if (cfi1->drap != cfi2->drap ||
		   (cfi1->drap && cfi1->drap_reg != cfi2->drap_reg) ||
		   (cfi1->drap && cfi1->drap_offset != cfi2->drap_offset)) {
2909

2910
		WARN_FUNC("stack state mismatch: drap1=%d(%d,%d) drap2=%d(%d,%d)",
2911
			  insn->sec, insn->offset,
2912 2913
			  cfi1->drap, cfi1->drap_reg, cfi1->drap_offset,
			  cfi2->drap, cfi2->drap_reg, cfi2->drap_offset);
2914 2915 2916 2917 2918

	} else
		return true;

	return false;
2919 2920
}

P
Peter Zijlstra 已提交
2921 2922 2923
static inline bool func_uaccess_safe(struct symbol *func)
{
	if (func)
2924
		return func->uaccess_safe;
P
Peter Zijlstra 已提交
2925 2926 2927 2928

	return false;
}

2929
static inline const char *call_dest_name(struct instruction *insn)
P
Peter Zijlstra 已提交
2930
{
2931
	static char pvname[19];
2932 2933 2934
	struct reloc *rel;
	int idx;

P
Peter Zijlstra 已提交
2935 2936 2937
	if (insn->call_dest)
		return insn->call_dest->name;

2938 2939 2940 2941 2942 2943 2944
	rel = insn_reloc(NULL, insn);
	if (rel && !strcmp(rel->sym->name, "pv_ops")) {
		idx = (rel->addend / sizeof(void *));
		snprintf(pvname, sizeof(pvname), "pv_ops[%d]", idx);
		return pvname;
	}

P
Peter Zijlstra 已提交
2945 2946 2947
	return "{dynamic}";
}

2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977
static bool pv_call_dest(struct objtool_file *file, struct instruction *insn)
{
	struct symbol *target;
	struct reloc *rel;
	int idx;

	rel = insn_reloc(file, insn);
	if (!rel || strcmp(rel->sym->name, "pv_ops"))
		return false;

	idx = (arch_dest_reloc_offset(rel->addend) / sizeof(void *));

	if (file->pv_ops[idx].clean)
		return true;

	file->pv_ops[idx].clean = true;

	list_for_each_entry(target, &file->pv_ops[idx].targets, pv_target) {
		if (!target->sec->noinstr) {
			WARN("pv_ops[%d]: %s", idx, target->name);
			file->pv_ops[idx].clean = false;
		}
	}

	return file->pv_ops[idx].clean;
}

static inline bool noinstr_call_dest(struct objtool_file *file,
				     struct instruction *insn,
				     struct symbol *func)
2978 2979 2980 2981 2982
{
	/*
	 * We can't deal with indirect function calls at present;
	 * assume they're instrumented.
	 */
2983 2984 2985 2986
	if (!func) {
		if (file->pv_ops)
			return pv_call_dest(file, insn);

2987
		return false;
2988
	}
2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006

	/*
	 * If the symbol is from a noinstr section; we good.
	 */
	if (func->sec->noinstr)
		return true;

	/*
	 * The __ubsan_handle_*() calls are like WARN(), they only happen when
	 * something 'BAD' happened. At the risk of taking the machine down,
	 * let them proceed to get the message out.
	 */
	if (!strncmp(func->name, "__ubsan_handle_", 15))
		return true;

	return false;
}

3007 3008 3009
static int validate_call(struct objtool_file *file,
			 struct instruction *insn,
			 struct insn_state *state)
P
Peter Zijlstra 已提交
3010
{
3011
	if (state->noinstr && state->instr <= 0 &&
3012
	    !noinstr_call_dest(file, insn, insn->call_dest)) {
3013 3014 3015 3016 3017
		WARN_FUNC("call to %s() leaves .noinstr.text section",
				insn->sec, insn->offset, call_dest_name(insn));
		return 1;
	}

P
Peter Zijlstra 已提交
3018 3019
	if (state->uaccess && !func_uaccess_safe(insn->call_dest)) {
		WARN_FUNC("call to %s() with UACCESS enabled",
3020
				insn->sec, insn->offset, call_dest_name(insn));
P
Peter Zijlstra 已提交
3021 3022 3023
		return 1;
	}

3024 3025
	if (state->df) {
		WARN_FUNC("call to %s() with DF set",
3026
				insn->sec, insn->offset, call_dest_name(insn));
3027 3028 3029
		return 1;
	}

P
Peter Zijlstra 已提交
3030 3031 3032
	return 0;
}

3033 3034 3035
static int validate_sibling_call(struct objtool_file *file,
				 struct instruction *insn,
				 struct insn_state *state)
3036
{
3037
	if (has_modified_stack_frame(insn, state)) {
3038 3039 3040 3041 3042
		WARN_FUNC("sibling call from callable instruction with modified stack frame",
				insn->sec, insn->offset);
		return 1;
	}

3043
	return validate_call(file, insn, state);
3044 3045
}

3046 3047
static int validate_return(struct symbol *func, struct instruction *insn, struct insn_state *state)
{
3048 3049 3050 3051 3052 3053
	if (state->noinstr && state->instr > 0) {
		WARN_FUNC("return with instrumentation enabled",
			  insn->sec, insn->offset);
		return 1;
	}

3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071
	if (state->uaccess && !func_uaccess_safe(func)) {
		WARN_FUNC("return with UACCESS enabled",
			  insn->sec, insn->offset);
		return 1;
	}

	if (!state->uaccess && func_uaccess_safe(func)) {
		WARN_FUNC("return with UACCESS disabled from a UACCESS-safe function",
			  insn->sec, insn->offset);
		return 1;
	}

	if (state->df) {
		WARN_FUNC("return with DF set",
			  insn->sec, insn->offset);
		return 1;
	}

3072
	if (func && has_modified_stack_frame(insn, state)) {
3073 3074 3075 3076 3077
		WARN_FUNC("return with modified stack frame",
			  insn->sec, insn->offset);
		return 1;
	}

3078
	if (state->cfi.bp_scratch) {
3079 3080
		WARN_FUNC("BP used as a scratch register",
			  insn->sec, insn->offset);
3081 3082 3083 3084 3085 3086
		return 1;
	}

	return 0;
}

3087 3088
static struct instruction *next_insn_to_validate(struct objtool_file *file,
						 struct instruction *insn)
3089
{
J
Josh Poimboeuf 已提交
3090
	struct alt_group *alt_group = insn->alt_group;
3091

3092 3093 3094 3095 3096 3097 3098 3099 3100
	/*
	 * Simulate the fact that alternatives are patched in-place.  When the
	 * end of a replacement alt_group is reached, redirect objtool flow to
	 * the end of the original alt_group.
	 */
	if (alt_group && insn == alt_group->last_insn && alt_group->orig_group)
		return next_insn_same_sec(file, alt_group->orig_group->last_insn);

	return next_insn_same_sec(file, insn);
3101 3102
}

3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207
static struct instruction *
validate_ibt_reloc(struct objtool_file *file, struct reloc *reloc)
{
	struct instruction *dest;
	struct section *sec;
	unsigned long off;

	sec = reloc->sym->sec;
	off = reloc->sym->offset;

	if ((reloc->sec->base->sh.sh_flags & SHF_EXECINSTR) &&
	    (reloc->type == R_X86_64_PC32 || reloc->type == R_X86_64_PLT32))
		off += arch_dest_reloc_offset(reloc->addend);
	else
		off += reloc->addend;

	dest = find_insn(file, sec, off);
	if (!dest)
		return NULL;

	if (dest->type == INSN_ENDBR)
		return NULL;

	if (reloc->sym->static_call_tramp)
		return NULL;

	return dest;
}

static void warn_noendbr(const char *msg, struct section *sec, unsigned long offset,
			 struct instruction *dest)
{
	WARN_FUNC("%srelocation to !ENDBR: %s+0x%lx", sec, offset, msg,
		  dest->func ? dest->func->name : dest->sec->name,
		  dest->func ? dest->offset - dest->func->offset : dest->offset);
}

static void validate_ibt_dest(struct objtool_file *file, struct instruction *insn,
			      struct instruction *dest)
{
	if (dest->func && dest->func == insn->func) {
		/*
		 * Anything from->to self is either _THIS_IP_ or IRET-to-self.
		 *
		 * There is no sane way to annotate _THIS_IP_ since the compiler treats the
		 * relocation as a constant and is happy to fold in offsets, skewing any
		 * annotation we do, leading to vast amounts of false-positives.
		 *
		 * There's also compiler generated _THIS_IP_ through KCOV and
		 * such which we have no hope of annotating.
		 *
		 * As such, blanket accept self-references without issue.
		 */
		return;
	}

	if (dest->noendbr)
		return;

	warn_noendbr("", insn->sec, insn->offset, dest);
}

static void validate_ibt_insn(struct objtool_file *file, struct instruction *insn)
{
	struct instruction *dest;
	struct reloc *reloc;

	switch (insn->type) {
	case INSN_CALL:
	case INSN_CALL_DYNAMIC:
	case INSN_JUMP_CONDITIONAL:
	case INSN_JUMP_UNCONDITIONAL:
	case INSN_JUMP_DYNAMIC:
	case INSN_JUMP_DYNAMIC_CONDITIONAL:
	case INSN_RETURN:
		/*
		 * We're looking for code references setting up indirect code
		 * flow. As such, ignore direct code flow and the actual
		 * dynamic branches.
		 */
		return;

	case INSN_NOP:
		/*
		 * handle_group_alt() will create INSN_NOP instruction that
		 * don't belong to any section, ignore all NOP since they won't
		 * carry a (useful) relocation anyway.
		 */
		return;

	default:
		break;
	}

	for (reloc = insn_reloc(file, insn);
	     reloc;
	     reloc = find_reloc_by_dest_range(file->elf, insn->sec,
					      reloc->offset + 1,
					      (insn->offset + insn->len) - (reloc->offset + 1))) {
		dest = validate_ibt_reloc(file, reloc);
		if (dest)
			validate_ibt_dest(file, insn, dest);
	}
}

3208 3209 3210 3211 3212 3213
/*
 * Follow the branch starting at the given instruction, and recursively follow
 * any other branches (jumps).  Meanwhile, track the frame pointer state at
 * each instruction and validate all the rules described in
 * tools/objtool/Documentation/stack-validation.txt.
 */
3214
static int validate_branch(struct objtool_file *file, struct symbol *func,
P
Peter Zijlstra 已提交
3215
			   struct instruction *insn, struct insn_state state)
3216 3217
{
	struct alternative *alt;
P
Peter Zijlstra 已提交
3218
	struct instruction *next_insn, *prev_insn = NULL;
3219
	struct section *sec;
3220
	u8 visited;
3221 3222 3223 3224 3225
	int ret;

	sec = insn->sec;

	while (1) {
3226
		next_insn = next_insn_to_validate(file, insn);
3227

3228
		if (file->c_file && func && insn->func && func != insn->func->pfunc) {
3229 3230 3231
			WARN("%s() falls through to next function %s()",
			     func->name, insn->func->name);
			return 1;
3232 3233
		}

3234 3235 3236
		if (func && insn->ignore) {
			WARN_FUNC("BUG: why am I validating an ignored function?",
				  sec, insn->offset);
3237
			return 1;
3238 3239
		}

3240
		visited = 1 << state.uaccess;
3241
		if (insn->visited) {
3242
			if (!insn->hint && !insn_cfi_match(insn, &state.cfi))
3243 3244
				return 1;

3245
			if (insn->visited & visited)
P
Peter Zijlstra 已提交
3246
				return 0;
P
Peter Zijlstra 已提交
3247 3248
		} else {
			nr_insns_visited++;
3249 3250
		}

3251 3252 3253
		if (state.noinstr)
			state.instr += insn->instr;

P
Peter Zijlstra 已提交
3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265
		if (insn->hint) {
			state.cfi = *insn->cfi;
		} else {
			/* XXX track if we actually changed state.cfi */

			if (prev_insn && !cficmp(prev_insn->cfi, &state.cfi)) {
				insn->cfi = prev_insn->cfi;
				nr_cfi_reused++;
			} else {
				insn->cfi = cfi_hash_find_or_add(&state.cfi);
			}
		}
3266

3267
		insn->visited |= visited;
3268

3269 3270 3271
		if (propagate_alt_cfi(file, insn))
			return 1;

3272
		if (!insn->ignore_alts && !list_empty(&insn->alts)) {
P
Peter Zijlstra 已提交
3273 3274
			bool skip_orig = false;

3275
			list_for_each_entry(alt, &insn->alts, list) {
P
Peter Zijlstra 已提交
3276 3277 3278
				if (alt->skip_orig)
					skip_orig = true;

3279
				ret = validate_branch(file, func, alt->insn, state);
3280 3281 3282 3283 3284
				if (ret) {
					if (backtrace)
						BT_FUNC("(alt)", insn);
					return ret;
				}
3285
			}
P
Peter Zijlstra 已提交
3286 3287 3288

			if (skip_orig)
				return 0;
3289 3290
		}

3291
		if (handle_insn_ops(insn, next_insn, &state))
3292 3293
			return 1;

3294 3295 3296
		switch (insn->type) {

		case INSN_RETURN:
3297 3298
			if (sls && !insn->retpoline_safe &&
			    next_insn && next_insn->type != INSN_TRAP) {
3299 3300 3301
				WARN_FUNC("missing int3 after ret",
					  insn->sec, insn->offset);
			}
3302
			return validate_return(func, insn, &state);
3303 3304

		case INSN_CALL:
P
Peter Zijlstra 已提交
3305
		case INSN_CALL_DYNAMIC:
3306
			ret = validate_call(file, insn, &state);
P
Peter Zijlstra 已提交
3307 3308
			if (ret)
				return ret;
3309

3310 3311
			if (!no_fp && func && !is_fentry_call(insn) &&
			    !has_valid_stack_frame(&state)) {
3312 3313 3314 3315
				WARN_FUNC("call without frame pointer save/setup",
					  sec, insn->offset);
				return 1;
			}
3316

P
Peter Zijlstra 已提交
3317
			if (insn->dead_end)
3318 3319
				return 0;

3320 3321 3322 3323
			break;

		case INSN_JUMP_CONDITIONAL:
		case INSN_JUMP_UNCONDITIONAL:
3324
			if (is_sibling_call(insn)) {
3325
				ret = validate_sibling_call(file, insn, &state);
3326
				if (ret)
3327
					return ret;
3328

3329
			} else if (insn->jump_dest) {
3330 3331
				ret = validate_branch(file, func,
						      insn->jump_dest, state);
3332 3333 3334 3335 3336
				if (ret) {
					if (backtrace)
						BT_FUNC("(branch)", insn);
					return ret;
				}
3337
			}
3338 3339 3340 3341 3342 3343 3344

			if (insn->type == INSN_JUMP_UNCONDITIONAL)
				return 0;

			break;

		case INSN_JUMP_DYNAMIC:
3345 3346
			if (sls && !insn->retpoline_safe &&
			    next_insn && next_insn->type != INSN_TRAP) {
3347 3348 3349 3350 3351
				WARN_FUNC("missing int3 after indirect jump",
					  insn->sec, insn->offset);
			}

			/* fallthrough */
3352
		case INSN_JUMP_DYNAMIC_CONDITIONAL:
3353
			if (is_sibling_call(insn)) {
3354
				ret = validate_sibling_call(file, insn, &state);
3355 3356
				if (ret)
					return ret;
3357 3358
			}

3359 3360 3361 3362
			if (insn->type == INSN_JUMP_DYNAMIC)
				return 0;

			break;
3363

3364 3365 3366 3367 3368 3369 3370 3371
		case INSN_CONTEXT_SWITCH:
			if (func && (!next_insn || !next_insn->hint)) {
				WARN_FUNC("unsupported instruction in callable function",
					  sec, insn->offset);
				return 1;
			}
			return 0;

P
Peter Zijlstra 已提交
3372 3373 3374 3375 3376 3377 3378 3379 3380 3381
		case INSN_STAC:
			if (state.uaccess) {
				WARN_FUNC("recursive UACCESS enable", sec, insn->offset);
				return 1;
			}

			state.uaccess = true;
			break;

		case INSN_CLAC:
3382
			if (!state.uaccess && func) {
P
Peter Zijlstra 已提交
3383 3384 3385 3386 3387 3388 3389 3390 3391 3392
				WARN_FUNC("redundant UACCESS disable", sec, insn->offset);
				return 1;
			}

			if (func_uaccess_safe(func) && !state.uaccess_stack) {
				WARN_FUNC("UACCESS-safe disables UACCESS", sec, insn->offset);
				return 1;
			}

			state.uaccess = false;
3393 3394
			break;

3395
		case INSN_STD:
3396
			if (state.df) {
3397
				WARN_FUNC("recursive STD", sec, insn->offset);
3398 3399
				return 1;
			}
3400 3401 3402 3403 3404

			state.df = true;
			break;

		case INSN_CLD:
3405
			if (!state.df && func) {
3406
				WARN_FUNC("redundant CLD", sec, insn->offset);
3407 3408
				return 1;
			}
3409 3410

			state.df = false;
3411 3412
			break;

3413 3414 3415 3416
		default:
			break;
		}

3417 3418 3419
		if (ibt)
			validate_ibt_insn(file, insn);

3420 3421 3422
		if (insn->dead_end)
			return 0;

3423
		if (!next_insn) {
3424
			if (state.cfi.cfa.base == CFI_UNDEFINED)
3425
				return 0;
3426 3427 3428
			WARN("%s: unexpected end of section", sec->name);
			return 1;
		}
3429

P
Peter Zijlstra 已提交
3430
		prev_insn = insn;
3431
		insn = next_insn;
3432 3433 3434 3435 3436
	}

	return 0;
}

3437
static int validate_unwind_hints(struct objtool_file *file, struct section *sec)
3438 3439 3440
{
	struct instruction *insn;
	struct insn_state state;
3441
	int ret, warnings = 0;
3442 3443 3444 3445

	if (!file->hints)
		return 0;

3446
	init_insn_state(&state, sec);
3447

3448 3449 3450 3451 3452 3453 3454 3455 3456
	if (sec) {
		insn = find_insn(file, sec, 0);
		if (!insn)
			return 0;
	} else {
		insn = list_first_entry(&file->insn_list, typeof(*insn), list);
	}

	while (&insn->list != &file->insn_list && (!sec || insn->sec == sec)) {
3457
		if (insn->hint && !insn->visited && !insn->ignore) {
3458
			ret = validate_branch(file, insn->func, insn, state);
3459 3460
			if (ret && backtrace)
				BT_FUNC("<=== (hint)", insn);
3461 3462
			warnings += ret;
		}
3463 3464

		insn = list_next_entry(insn, list);
3465 3466 3467 3468 3469
	}

	return warnings;
}

3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482
static int validate_retpoline(struct objtool_file *file)
{
	struct instruction *insn;
	int warnings = 0;

	for_each_insn(file, insn) {
		if (insn->type != INSN_JUMP_DYNAMIC &&
		    insn->type != INSN_CALL_DYNAMIC)
			continue;

		if (insn->retpoline_safe)
			continue;

3483 3484 3485 3486 3487 3488 3489 3490 3491
		/*
		 * .init.text code is ran before userspace and thus doesn't
		 * strictly need retpolines, except for modules which are
		 * loaded late, they very much do need retpoline in their
		 * .init.text
		 */
		if (!strcmp(insn->sec->name, ".init.text") && !module)
			continue;

3492 3493 3494 3495 3496 3497 3498 3499 3500 3501
		WARN_FUNC("indirect %s found in RETPOLINE build",
			  insn->sec, insn->offset,
			  insn->type == INSN_JUMP_DYNAMIC ? "jump" : "call");

		warnings++;
	}

	return warnings;
}

3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514
static bool is_kasan_insn(struct instruction *insn)
{
	return (insn->type == INSN_CALL &&
		!strcmp(insn->call_dest->name, "__asan_handle_no_return"));
}

static bool is_ubsan_insn(struct instruction *insn)
{
	return (insn->type == INSN_CALL &&
		!strcmp(insn->call_dest->name,
			"__ubsan_handle_builtin_unreachable"));
}

3515
static bool ignore_unreachable_insn(struct objtool_file *file, struct instruction *insn)
3516 3517
{
	int i;
3518
	struct instruction *prev_insn;
3519

3520
	if (insn->ignore || insn->type == INSN_NOP || insn->type == INSN_TRAP)
3521 3522 3523
		return true;

	/*
P
Peter Zijlstra 已提交
3524
	 * Ignore alternative replacement instructions.  This can happen
3525
	 * when a whitelisted function uses one of the ALTERNATIVE macros.
3526
	 */
P
Peter Zijlstra 已提交
3527
	if (!strcmp(insn->sec->name, ".altinstr_replacement") ||
3528
	    !strcmp(insn->sec->name, ".altinstr_aux"))
3529 3530
		return true;

3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573
	/*
	 * Whole archive runs might encounder dead code from weak symbols.
	 * This is where the linker will have dropped the weak symbol in
	 * favour of a regular symbol, but leaves the code in place.
	 *
	 * In this case we'll find a piece of code (whole function) that is not
	 * covered by a !section symbol. Ignore them.
	 */
	if (!insn->func && lto) {
		int size = find_symbol_hole_containing(insn->sec, insn->offset);
		unsigned long end = insn->offset + size;

		if (!size) /* not a hole */
			return false;

		if (size < 0) /* hole until the end */
			return true;

		sec_for_each_insn_continue(file, insn) {
			/*
			 * If we reach a visited instruction at or before the
			 * end of the hole, ignore the unreachable.
			 */
			if (insn->visited)
				return true;

			if (insn->offset >= end)
				break;

			/*
			 * If this hole jumps to a .cold function, mark it ignore too.
			 */
			if (insn->jump_dest && insn->jump_dest->func &&
			    strstr(insn->jump_dest->func->name, ".cold")) {
				struct instruction *dest = insn->jump_dest;
				func_for_each_insn(file, dest->func, dest)
					dest->ignore = true;
			}
		}

		return false;
	}

3574 3575 3576
	if (!insn->func)
		return false;

3577 3578 3579
	if (insn->func->static_call_tramp)
		return true;

3580 3581 3582 3583 3584
	/*
	 * CONFIG_UBSAN_TRAP inserts a UD2 when it sees
	 * __builtin_unreachable().  The BUG() macro has an unreachable() after
	 * the UD2, which causes GCC's undefined trap logic to emit another UD2
	 * (or occasionally a JMP to UD2).
3585 3586
	 *
	 * It may also insert a UD2 after calling a __noreturn function.
3587
	 */
3588 3589
	prev_insn = list_prev_entry(insn, list);
	if ((prev_insn->dead_end || dead_end_function(file, prev_insn->call_dest)) &&
3590 3591 3592 3593 3594
	    (insn->type == INSN_BUG ||
	     (insn->type == INSN_JUMP_UNCONDITIONAL &&
	      insn->jump_dest && insn->jump_dest->type == INSN_BUG)))
		return true;

3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605
	/*
	 * Check if this (or a subsequent) instruction is related to
	 * CONFIG_UBSAN or CONFIG_KASAN.
	 *
	 * End the search at 5 instructions to avoid going into the weeds.
	 */
	for (i = 0; i < 5; i++) {

		if (is_kasan_insn(insn) || is_ubsan_insn(insn))
			return true;

3606 3607 3608 3609 3610 3611 3612 3613
		if (insn->type == INSN_JUMP_UNCONDITIONAL) {
			if (insn->jump_dest &&
			    insn->jump_dest->func == insn->func) {
				insn = insn->jump_dest;
				continue;
			}

			break;
3614 3615
		}

3616
		if (insn->offset + insn->len >= insn->func->offset + insn->func->len)
3617
			break;
3618

3619 3620 3621 3622 3623 3624
		insn = list_next_entry(insn, list);
	}

	return false;
}

3625 3626
static int validate_symbol(struct objtool_file *file, struct section *sec,
			   struct symbol *sym, struct insn_state *state)
3627 3628
{
	struct instruction *insn;
3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652
	int ret;

	if (!sym->len) {
		WARN("%s() is missing an ELF size annotation", sym->name);
		return 1;
	}

	if (sym->pfunc != sym || sym->alias != sym)
		return 0;

	insn = find_insn(file, sec, sym->offset);
	if (!insn || insn->ignore || insn->visited)
		return 0;

	state->uaccess = sym->uaccess_safe;

	ret = validate_branch(file, insn->func, insn, *state);
	if (ret && backtrace)
		BT_FUNC("<=== (sym)", insn);
	return ret;
}

static int validate_section(struct objtool_file *file, struct section *sec)
{
3653
	struct insn_state state;
3654 3655
	struct symbol *func;
	int warnings = 0;
3656

3657 3658 3659
	list_for_each_entry(func, &sec->symbol_list, list) {
		if (func->type != STT_FUNC)
			continue;
3660

3661
		init_insn_state(&state, sec);
3662
		set_func_state(&state.cfi);
3663

3664
		warnings += validate_symbol(file, sec, func, &state);
3665 3666 3667 3668 3669
	}

	return warnings;
}

3670 3671 3672
static int validate_vmlinux_functions(struct objtool_file *file)
{
	struct section *sec;
3673
	int warnings = 0;
3674 3675

	sec = find_section_by_name(file->elf, ".noinstr.text");
3676 3677 3678 3679
	if (sec) {
		warnings += validate_section(file, sec);
		warnings += validate_unwind_hints(file, sec);
	}
3680

3681 3682 3683 3684 3685
	sec = find_section_by_name(file->elf, ".entry.text");
	if (sec) {
		warnings += validate_section(file, sec);
		warnings += validate_unwind_hints(file, sec);
	}
3686 3687

	return warnings;
3688 3689
}

3690 3691 3692 3693 3694
static int validate_functions(struct objtool_file *file)
{
	struct section *sec;
	int warnings = 0;

3695 3696 3697 3698
	for_each_sec(file, sec) {
		if (!(sec->sh.sh_flags & SHF_EXECINSTR))
			continue;

3699
		warnings += validate_section(file, sec);
3700
	}
3701 3702 3703 3704

	return warnings;
}

3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751
static int validate_ibt(struct objtool_file *file)
{
	struct section *sec;
	struct reloc *reloc;

	for_each_sec(file, sec) {
		bool is_data;

		/* already done in validate_branch() */
		if (sec->sh.sh_flags & SHF_EXECINSTR)
			continue;

		if (!sec->reloc)
			continue;

		if (!strncmp(sec->name, ".orc", 4))
			continue;

		if (!strncmp(sec->name, ".discard", 8))
			continue;

		if (!strncmp(sec->name, ".debug", 6))
			continue;

		if (!strcmp(sec->name, "_error_injection_whitelist"))
			continue;

		if (!strcmp(sec->name, "_kprobe_blacklist"))
			continue;

		is_data = strstr(sec->name, ".data") || strstr(sec->name, ".rodata");

		list_for_each_entry(reloc, &sec->reloc->reloc_list, list) {
			struct instruction *dest;

			dest = validate_ibt_reloc(file, reloc);
			if (is_data && dest && !dest->noendbr) {
				warn_noendbr("data ", reloc->sym->sec,
					     reloc->sym->offset + reloc->addend,
					     dest);
			}
		}
	}

	return 0;
}

3752
static int validate_reachable_instructions(struct objtool_file *file)
3753 3754
{
	struct instruction *insn;
3755 3756 3757

	if (file->ignore_unreachables)
		return 0;
3758 3759

	for_each_insn(file, insn) {
3760
		if (insn->visited || ignore_unreachable_insn(file, insn))
3761 3762 3763 3764
			continue;

		WARN_FUNC("unreachable instruction", insn->sec, insn->offset);
		return 1;
3765 3766
	}

3767
	return 0;
3768 3769
}

3770
int check(struct objtool_file *file)
3771 3772 3773
{
	int ret, warnings = 0;

3774 3775 3776 3777 3778
	if (lto && !(vmlinux || module)) {
		fprintf(stderr, "--lto requires: --vmlinux or --module\n");
		return 1;
	}

3779 3780 3781 3782 3783
	if (ibt && !lto) {
		fprintf(stderr, "--ibt requires: --lto\n");
		return 1;
	}

3784
	arch_initial_func_cfi_state(&initial_func_cfi);
P
Peter Zijlstra 已提交
3785 3786 3787 3788 3789 3790 3791 3792 3793
	init_cfi_state(&init_cfi);
	init_cfi_state(&func_cfi);
	set_func_state(&func_cfi);

	if (!cfi_hash_alloc(1UL << (file->elf->symbol_bits - 3)))
		goto out;

	cfi_hash_add(&init_cfi);
	cfi_hash_add(&func_cfi);
3794

3795
	ret = decode_sections(file);
3796 3797
	if (ret < 0)
		goto out;
P
Peter Zijlstra 已提交
3798

3799 3800
	warnings += ret;

3801
	if (list_empty(&file->insn_list))
3802 3803
		goto out;

3804
	if (vmlinux && !lto) {
3805
		ret = validate_vmlinux_functions(file);
3806 3807 3808 3809 3810 3811 3812
		if (ret < 0)
			goto out;

		warnings += ret;
		goto out;
	}

3813
	if (retpoline) {
3814
		ret = validate_retpoline(file);
3815 3816 3817 3818 3819
		if (ret < 0)
			return ret;
		warnings += ret;
	}

3820
	ret = validate_functions(file);
3821 3822 3823 3824
	if (ret < 0)
		goto out;
	warnings += ret;

3825
	ret = validate_unwind_hints(file, NULL);
3826 3827 3828 3829
	if (ret < 0)
		goto out;
	warnings += ret;

3830 3831 3832 3833 3834 3835 3836
	if (ibt) {
		ret = validate_ibt(file);
		if (ret < 0)
			goto out;
		warnings += ret;
	}

3837
	if (!warnings) {
3838
		ret = validate_reachable_instructions(file);
3839 3840 3841 3842 3843
		if (ret < 0)
			goto out;
		warnings += ret;
	}

3844
	ret = create_static_call_sections(file);
3845 3846 3847 3848
	if (ret < 0)
		goto out;
	warnings += ret;

3849 3850 3851 3852 3853 3854 3855
	if (retpoline) {
		ret = create_retpoline_sites_sections(file);
		if (ret < 0)
			goto out;
		warnings += ret;
	}

3856 3857 3858 3859 3860 3861 3862
	if (mcount) {
		ret = create_mcount_loc_sections(file);
		if (ret < 0)
			goto out;
		warnings += ret;
	}

P
Peter Zijlstra 已提交
3863 3864 3865 3866 3867 3868 3869
	if (stats) {
		printf("nr_insns_visited: %ld\n", nr_insns_visited);
		printf("nr_cfi: %ld\n", nr_cfi);
		printf("nr_cfi_reused: %ld\n", nr_cfi_reused);
		printf("nr_cfi_cache: %ld\n", nr_cfi_cache);
	}

3870
out:
3871 3872 3873 3874 3875
	/*
	 *  For now, don't fail the kernel build on fatal warnings.  These
	 *  errors are still fairly common due to the growing matrix of
	 *  supported toolchains and their recent pace of change.
	 */
3876 3877
	return 0;
}