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

#include <string.h>
#include <stdlib.h>

9 10 11 12 13 14 15 16
#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>
17

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

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

29
struct cfi_init_state initial_func_cfi;
30

31 32
struct instruction *find_insn(struct objtool_file *file,
			      struct section *sec, unsigned long offset)
33 34 35
{
	struct instruction *insn;

36
	hash_for_each_possible(file->insn_hash, insn, hash, sec_offset_hash(sec, offset)) {
37 38
		if (insn->sec == sec && insn->offset == offset)
			return insn;
39
	}
40 41 42 43 44 45 46 47 48

	return NULL;
}

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

49
	if (!next || &next->list == &file->insn_list || next->sec != insn->sec)
50 51 52 53 54
		return NULL;

	return next;
}

55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
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);
}

75 76 77 78 79 80 81 82 83 84 85
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;
}

86
#define func_for_each_insn(file, func, insn)				\
87 88 89 90
	for (insn = find_insn(file, func->sec, func->offset);		\
	     insn;							\
	     insn = next_insn_same_func(file, insn))

91 92
#define sym_for_each_insn(file, sym, insn)				\
	for (insn = find_insn(file, sym->sec, sym->offset);		\
93
	     insn && &insn->list != &file->insn_list &&			\
94 95
		insn->sec == sym->sec &&				\
		insn->offset < sym->offset + sym->len;			\
96 97
	     insn = list_next_entry(insn, list))

98
#define sym_for_each_insn_continue_reverse(file, sym, insn)		\
99 100
	for (insn = list_prev_entry(insn, list);			\
	     &insn->list != &file->insn_list &&				\
101
		insn->sec == sym->sec && insn->offset >= sym->offset;	\
102 103 104 105 106
	     insn = list_prev_entry(insn, list))

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

107 108 109
#define sec_for_each_insn_continue(file, insn)				\
	for (insn = next_insn_same_sec(file, insn); insn;		\
	     insn = next_insn_same_sec(file, insn))
110

111 112
static bool is_sibling_call(struct instruction *insn)
{
113 114 115 116 117 118 119 120
	/*
	 * 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;

121 122 123 124 125
	/* An indirect jump is either a sibling call or a jump to a table. */
	if (insn->type == INSN_JUMP_DYNAMIC)
		return list_empty(&insn->alts);

	/* add_jump_destinations() sets insn->call_dest for sibling calls. */
126
	return (is_static_jump(insn) && insn->call_dest);
127 128
}

129 130 131 132 133 134 135 136 137
/*
 * 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.
 */
138 139
static bool __dead_end_function(struct objtool_file *file, struct symbol *func,
				int recursion)
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
{
	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",
		"__module_put_and_exit",
		"complete_and_exit",
		"__reiserfs_panic",
		"lbug_with_loc",
		"fortify_panic",
159
		"usercopy_abort",
160
		"machine_real_restart",
161
		"rewind_stack_do_exit",
162
		"kunit_try_catch_throw",
163
		"xen_start_kernel",
164 165
	};

166 167 168
	if (!func)
		return false;

169
	if (func->bind == STB_WEAK)
170
		return false;
171 172 173 174

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

177
	if (!func->len)
178
		return false;
179

180 181
	insn = find_insn(file, func->sec, func->offset);
	if (!insn->func)
182
		return false;
183

184
	func_for_each_insn(file, func, insn) {
185 186 187
		empty = false;

		if (insn->type == INSN_RETURN)
188
			return false;
189 190 191
	}

	if (empty)
192
		return false;
193 194 195 196 197 198

	/*
	 * 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.
	 */
199
	func_for_each_insn(file, func, insn) {
200
		if (is_sibling_call(insn)) {
201 202 203 204
			struct instruction *dest = insn->jump_dest;

			if (!dest)
				/* sibling call to another file */
205
				return false;
206

207 208 209 210 211 212 213 214
			/* 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;
215 216
			}

217 218
			return __dead_end_function(file, dest->func, recursion+1);
		}
219 220
	}

221
	return true;
222 223
}

224
static bool dead_end_function(struct objtool_file *file, struct symbol *func)
225 226 227 228
{
	return __dead_end_function(file, func, 0);
}

229
static void init_cfi_state(struct cfi_state *cfi)
230 231 232
{
	int i;

233
	for (i = 0; i < CFI_NUM_REGS; i++) {
234 235
		cfi->regs[i].base = CFI_UNDEFINED;
		cfi->vals[i].base = CFI_UNDEFINED;
236
	}
237 238 239 240 241
	cfi->cfa.base = CFI_UNDEFINED;
	cfi->drap_reg = CFI_UNDEFINED;
	cfi->drap_offset = -1;
}

242
static void init_insn_state(struct insn_state *state, struct section *sec)
243 244 245
{
	memset(state, 0, sizeof(*state));
	init_cfi_state(&state->cfi);
246 247 248 249 250 251

	/*
	 * 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).
	 */
252
	if (vmlinux && noinstr && sec)
253
		state->noinstr = sec->noinstr;
254 255
}

256 257 258 259 260 261 262 263 264 265
/*
 * 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;
P
Peter Zijlstra 已提交
266
	unsigned long nr_insns = 0;
267 268
	int ret;

269
	for_each_sec(file, sec) {
270 271 272 273

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

274 275 276 277 278
		if (strcmp(sec->name, ".altinstr_replacement") &&
		    strcmp(sec->name, ".altinstr_aux") &&
		    strncmp(sec->name, ".discard.", 9))
			sec->text = true;

279 280
		if (!strcmp(sec->name, ".noinstr.text") ||
		    !strcmp(sec->name, ".entry.text"))
281 282
			sec->noinstr = true;

283 284
		for (offset = 0; offset < sec->len; offset += insn->len) {
			insn = malloc(sizeof(*insn));
285 286 287 288
			if (!insn) {
				WARN("malloc failed");
				return -1;
			}
289 290
			memset(insn, 0, sizeof(*insn));
			INIT_LIST_HEAD(&insn->alts);
291
			INIT_LIST_HEAD(&insn->stack_ops);
292
			init_cfi_state(&insn->cfi);
293

294 295 296 297 298 299
			insn->sec = sec;
			insn->offset = offset;

			ret = arch_decode_instruction(file->elf, sec, offset,
						      sec->len - offset,
						      &insn->len, &insn->type,
300
						      &insn->immediate,
301
						      &insn->stack_ops);
302
			if (ret)
303
				goto err;
304

305
			hash_add(file->insn_hash, &insn->hash, sec_offset_hash(sec, insn->offset));
306
			list_add_tail(&insn->list, &file->insn_list);
P
Peter Zijlstra 已提交
307
			nr_insns++;
308 309 310
		}

		list_for_each_entry(func, &sec->symbol_list, list) {
311
			if (func->type != STT_FUNC || func->alias != func)
312 313 314 315 316 317 318 319
				continue;

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

320
			sym_for_each_insn(file, func, insn)
321
				insn->func = func;
322 323 324
		}
	}

P
Peter Zijlstra 已提交
325 326 327
	if (stats)
		printf("nr_insns: %lu\n", nr_insns);

328
	return 0;
329 330 331 332

err:
	free(insn);
	return ret;
333 334
}

335 336 337 338 339 340 341 342 343 344 345 346 347
static struct instruction *find_last_insn(struct objtool_file *file,
					  struct section *sec)
{
	struct instruction *insn = NULL;
	unsigned int offset;
	unsigned int end = (sec->len > 10) ? sec->len - 10 : 0;

	for (offset = sec->len - 1; offset >= end && !insn; offset--)
		insn = find_insn(file, sec, offset);

	return insn;
}

348
/*
349
 * Mark "ud2" instructions and manually annotated dead ends.
350 351 352 353
 */
static int add_dead_ends(struct objtool_file *file)
{
	struct section *sec;
M
Matt Helsley 已提交
354
	struct reloc *reloc;
355 356
	struct instruction *insn;

357 358 359 360 361 362 363 364 365 366 367
	/*
	 * By default, "ud2" is a dead end unless otherwise annotated, because
	 * GCC 7 inserts it for certain divide-by-zero cases.
	 */
	for_each_insn(file, insn)
		if (insn->type == INSN_BUG)
			insn->dead_end = true;

	/*
	 * Check for manually annotated dead ends.
	 */
368 369
	sec = find_section_by_name(file->elf, ".rela.discard.unreachable");
	if (!sec)
370
		goto reachable;
371

M
Matt Helsley 已提交
372 373
	list_for_each_entry(reloc, &sec->reloc_list, list) {
		if (reloc->sym->type != STT_SECTION) {
374 375 376
			WARN("unexpected relocation symbol type in %s", sec->name);
			return -1;
		}
M
Matt Helsley 已提交
377
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
378 379
		if (insn)
			insn = list_prev_entry(insn, list);
M
Matt Helsley 已提交
380 381
		else if (reloc->addend == reloc->sym->sec->len) {
			insn = find_last_insn(file, reloc->sym->sec);
382
			if (!insn) {
383
				WARN("can't find unreachable insn at %s+0x%x",
M
Matt Helsley 已提交
384
				     reloc->sym->sec->name, reloc->addend);
385 386 387 388
				return -1;
			}
		} else {
			WARN("can't find unreachable insn at %s+0x%x",
M
Matt Helsley 已提交
389
			     reloc->sym->sec->name, reloc->addend);
390 391 392 393 394 395
			return -1;
		}

		insn->dead_end = true;
	}

396 397 398 399 400 401 402 403 404 405 406
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 已提交
407 408
	list_for_each_entry(reloc, &sec->reloc_list, list) {
		if (reloc->sym->type != STT_SECTION) {
409 410 411
			WARN("unexpected relocation symbol type in %s", sec->name);
			return -1;
		}
M
Matt Helsley 已提交
412
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
413 414
		if (insn)
			insn = list_prev_entry(insn, list);
M
Matt Helsley 已提交
415 416
		else if (reloc->addend == reloc->sym->sec->len) {
			insn = find_last_insn(file, reloc->sym->sec);
417
			if (!insn) {
418
				WARN("can't find reachable insn at %s+0x%x",
M
Matt Helsley 已提交
419
				     reloc->sym->sec->name, reloc->addend);
420 421 422 423
				return -1;
			}
		} else {
			WARN("can't find reachable insn at %s+0x%x",
M
Matt Helsley 已提交
424
			     reloc->sym->sec->name, reloc->addend);
425 426 427 428 429 430
			return -1;
		}

		insn->dead_end = false;
	}

431 432 433
	return 0;
}

434 435 436 437 438 439 440 441 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
static int create_static_call_sections(struct objtool_file *file)
{
	struct section *sec, *reloc_sec;
	struct reloc *reloc;
	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;
	list_for_each_entry(insn, &file->static_call_list, static_call_node)
		idx++;

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

	reloc_sec = elf_create_reloc_section(file->elf, sec, SHT_RELA);
	if (!reloc_sec)
		return -1;

	idx = 0;
	list_for_each_entry(insn, &file->static_call_list, static_call_node) {

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

		/* populate reloc for 'addr' */
		reloc = malloc(sizeof(*reloc));
475

476 477 478 479 480
		if (!reloc) {
			perror("malloc");
			return -1;
		}
		memset(reloc, 0, sizeof(*reloc));
481 482 483 484 485 486 487 488

		insn_to_reloc_sym_addend(insn->sec, insn->offset, reloc);
		if (!reloc->sym) {
			WARN_FUNC("static call tramp: missing containing symbol",
				  insn->sec, insn->offset);
			return -1;
		}

489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509
		reloc->type = R_X86_64_PC32;
		reloc->offset = idx * sizeof(struct static_call_site);
		reloc->sec = reloc_sec;
		elf_add_reloc(file->elf, reloc);

		/* 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) {
510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
			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;
525 526 527 528 529 530 531 532 533 534 535
		}
		free(key_name);

		/* populate reloc for 'key' */
		reloc = malloc(sizeof(*reloc));
		if (!reloc) {
			perror("malloc");
			return -1;
		}
		memset(reloc, 0, sizeof(*reloc));
		reloc->sym = key_sym;
P
Peter Zijlstra 已提交
536
		reloc->addend = is_sibling_call(insn) ? STATIC_CALL_SITE_TAIL : 0;
537 538 539 540 541 542 543 544 545 546 547 548 549 550
		reloc->type = R_X86_64_PC32;
		reloc->offset = idx * sizeof(struct static_call_site) + 4;
		reloc->sec = reloc_sec;
		elf_add_reloc(file->elf, reloc);

		idx++;
	}

	if (elf_rebuild_reloc_section(file->elf, reloc_sec))
		return -1;

	return 0;
}

551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593
static int create_mcount_loc_sections(struct objtool_file *file)
{
	struct section *sec, *reloc_sec;
	struct reloc *reloc;
	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;
	list_for_each_entry(insn, &file->mcount_loc_list, mcount_loc_node)
		idx++;

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

	reloc_sec = elf_create_reloc_section(file->elf, sec, SHT_RELA);
	if (!reloc_sec)
		return -1;

	idx = 0;
	list_for_each_entry(insn, &file->mcount_loc_list, mcount_loc_node) {

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

		reloc = malloc(sizeof(*reloc));
		if (!reloc) {
			perror("malloc");
			return -1;
		}
		memset(reloc, 0, sizeof(*reloc));

594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
		if (insn->sec->sym) {
			reloc->sym = insn->sec->sym;
			reloc->addend = insn->offset;
		} else {
			reloc->sym = find_symbol_containing(insn->sec, insn->offset);

			if (!reloc->sym) {
				WARN("missing symbol for insn at offset 0x%lx\n",
				     insn->offset);
				return -1;
			}

			reloc->addend = insn->offset - reloc->sym->offset;
		}

609 610 611 612 613 614 615 616 617 618 619 620 621 622
		reloc->type = R_X86_64_64;
		reloc->offset = idx * sizeof(unsigned long);
		reloc->sec = reloc_sec;
		elf_add_reloc(file->elf, reloc);

		idx++;
	}

	if (elf_rebuild_reloc_section(file->elf, reloc_sec))
		return -1;

	return 0;
}

623 624 625 626 627 628 629 630
/*
 * 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 已提交
631
	struct reloc *reloc;
632

P
Peter Zijlstra 已提交
633 634 635
	sec = find_section_by_name(file->elf, ".rela.discard.func_stack_frame_non_standard");
	if (!sec)
		return;
636

M
Matt Helsley 已提交
637 638
	list_for_each_entry(reloc, &sec->reloc_list, list) {
		switch (reloc->sym->type) {
P
Peter Zijlstra 已提交
639
		case STT_FUNC:
M
Matt Helsley 已提交
640
			func = reloc->sym;
P
Peter Zijlstra 已提交
641 642 643
			break;

		case STT_SECTION:
M
Matt Helsley 已提交
644
			func = find_func_by_offset(reloc->sym->sec, reloc->addend);
645
			if (!func)
646
				continue;
P
Peter Zijlstra 已提交
647
			break;
648

P
Peter Zijlstra 已提交
649
		default:
M
Matt Helsley 已提交
650
			WARN("unexpected relocation symbol type in %s: %d", sec->name, reloc->sym->type);
P
Peter Zijlstra 已提交
651
			continue;
652
		}
P
Peter Zijlstra 已提交
653

654
		func_for_each_insn(file, func, insn)
P
Peter Zijlstra 已提交
655
			insn->ignore = true;
656 657 658
	}
}

P
Peter Zijlstra 已提交
659 660 661 662 663 664 665 666 667 668
/*
 * 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",
669
	"kasan_check_range",
P
Peter Zijlstra 已提交
670 671 672 673 674 675 676 677 678 679 680 681 682
	/* 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",
683 684
	"__kasan_check_read",
	"__kasan_check_write",
P
Peter Zijlstra 已提交
685 686 687 688 689 690 691 692 693 694 695 696 697
	/* 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",
698
	/* KCSAN */
699
	"__kcsan_check_access",
700 701
	"kcsan_found_watchpoint",
	"kcsan_setup_watchpoint",
702
	"kcsan_check_scoped_accesses",
703 704
	"kcsan_disable_current",
	"kcsan_enable_current_nowarn",
705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
	/* 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",
720 721 722 723 724
	"__tsan_read_write1",
	"__tsan_read_write2",
	"__tsan_read_write4",
	"__tsan_read_write8",
	"__tsan_read_write16",
725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774
	"__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 已提交
775 776
	/* KCOV */
	"write_comp_data",
777
	"check_kcov_mode",
P
Peter Zijlstra 已提交
778 779 780 781 782 783 784 785 786
	"__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",
787
	"__sanitizer_cov_trace_switch",
P
Peter Zijlstra 已提交
788 789 790 791
	/* UBSAN */
	"ubsan_type_mismatch_common",
	"__ubsan_handle_type_mismatch",
	"__ubsan_handle_type_mismatch_v1",
792
	"__ubsan_handle_shift_out_of_bounds",
P
Peter Zijlstra 已提交
793 794
	/* misc */
	"csum_partial_copy_generic",
795 796
	"copy_mc_fragile",
	"copy_mc_fragile_handle_tail",
797
	"copy_mc_enhanced_fast_string",
P
Peter Zijlstra 已提交
798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814
	"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;

815
		func->uaccess_safe = true;
816 817 818
	}
}

819 820 821 822 823 824
/*
 * 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.
 */
825
static int add_ignore_alternatives(struct objtool_file *file)
826 827
{
	struct section *sec;
M
Matt Helsley 已提交
828
	struct reloc *reloc;
829 830
	struct instruction *insn;

831
	sec = find_section_by_name(file->elf, ".rela.discard.ignore_alts");
832 833 834
	if (!sec)
		return 0;

M
Matt Helsley 已提交
835 836
	list_for_each_entry(reloc, &sec->reloc_list, list) {
		if (reloc->sym->type != STT_SECTION) {
837 838 839 840
			WARN("unexpected relocation symbol type in %s", sec->name);
			return -1;
		}

M
Matt Helsley 已提交
841
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
842
		if (!insn) {
843
			WARN("bad .discard.ignore_alts entry");
844 845 846 847 848 849 850 851 852
			return -1;
		}

		insn->ignore_alts = true;
	}

	return 0;
}

853 854 855 856 857 858
/*
 * Find the destination instructions for all jumps.
 */
static int add_jump_destinations(struct objtool_file *file)
{
	struct instruction *insn;
M
Matt Helsley 已提交
859
	struct reloc *reloc;
860 861 862 863
	struct section *dest_sec;
	unsigned long dest_off;

	for_each_insn(file, insn) {
864
		if (!is_static_jump(insn))
865 866
			continue;

M
Matt Helsley 已提交
867
		reloc = find_reloc_by_dest_range(file->elf, insn->sec,
868
						 insn->offset, insn->len);
M
Matt Helsley 已提交
869
		if (!reloc) {
870
			dest_sec = insn->sec;
871
			dest_off = arch_jump_destination(insn);
M
Matt Helsley 已提交
872 873 874
		} else if (reloc->sym->type == STT_SECTION) {
			dest_sec = reloc->sym->sec;
			dest_off = arch_dest_reloc_offset(reloc->addend);
875 876
		} else if (!strncmp(reloc->sym->name, "__x86_indirect_thunk_", 21) ||
			   !strncmp(reloc->sym->name, "__x86_retpoline_", 16)) {
877 878 879 880
			/*
			 * Retpoline jumps are really dynamic jumps in
			 * disguise, so convert them accordingly.
			 */
881 882 883 884 885
			if (insn->type == INSN_JUMP_UNCONDITIONAL)
				insn->type = INSN_JUMP_DYNAMIC;
			else
				insn->type = INSN_JUMP_DYNAMIC_CONDITIONAL;

886
			insn->retpoline_safe = true;
887
			continue;
888 889
		} else if (insn->func) {
			/* internal or external sibling call (with reloc) */
M
Matt Helsley 已提交
890
			insn->call_dest = reloc->sym;
P
Peter Zijlstra 已提交
891 892 893 894
			if (insn->call_dest->static_call_tramp) {
				list_add_tail(&insn->static_call_node,
					      &file->static_call_list);
			}
895
			continue;
896 897 898 899 900 901 902
		} 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;
903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920
		}

		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;
		}
921 922

		/*
923
		 * Cross-function jump.
924 925
		 */
		if (insn->func && insn->jump_dest->func &&
926 927 928 929 930 931 932 933 934 935 936 937 938 939 940
		    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
941
			 * subfunction is through a jump table.
942
			 */
943 944
			if (!strstr(insn->func->name, ".cold") &&
			    strstr(insn->jump_dest->func->name, ".cold")) {
945 946 947 948 949 950
				insn->func->cfunc = insn->jump_dest->func;
				insn->jump_dest->func->pfunc = insn->func;

			} else if (insn->jump_dest->func->pfunc != insn->func->pfunc &&
				   insn->jump_dest->offset == insn->jump_dest->func->offset) {

951
				/* internal sibling call (without reloc) */
952
				insn->call_dest = insn->jump_dest->func;
P
Peter Zijlstra 已提交
953 954 955 956
				if (insn->call_dest->static_call_tramp) {
					list_add_tail(&insn->static_call_node,
						      &file->static_call_list);
				}
957
			}
958
		}
959 960 961 962 963
	}

	return 0;
}

964 965 966 967 968 969 970 971 972 973
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);
	}
}

974 975 976 977 978 979 980 981 982 983 984
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;
}

985 986 987 988 989 990 991
/*
 * Find the destination instructions for all calls.
 */
static int add_call_destinations(struct objtool_file *file)
{
	struct instruction *insn;
	unsigned long dest_off;
M
Matt Helsley 已提交
992
	struct reloc *reloc;
993 994 995 996 997

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

M
Matt Helsley 已提交
998
		reloc = find_reloc_by_dest_range(file->elf, insn->sec,
999
					       insn->offset, insn->len);
M
Matt Helsley 已提交
1000
		if (!reloc) {
1001
			dest_off = arch_jump_destination(insn);
1002
			insn->call_dest = find_call_destination(insn->sec, dest_off);
1003

1004 1005 1006 1007
			if (insn->ignore)
				continue;

			if (!insn->call_dest) {
1008
				WARN_FUNC("unannotated intra-function call", insn->sec, insn->offset);
1009 1010
				return -1;
			}
1011

1012 1013 1014 1015 1016 1017
			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 已提交
1018 1019
		} else if (reloc->sym->type == STT_SECTION) {
			dest_off = arch_dest_reloc_offset(reloc->addend);
1020 1021
			insn->call_dest = find_call_destination(reloc->sym->sec,
								dest_off);
1022
			if (!insn->call_dest) {
1023
				WARN_FUNC("can't find call dest symbol at %s+0x%lx",
1024
					  insn->sec, insn->offset,
M
Matt Helsley 已提交
1025
					  reloc->sym->sec->name,
1026
					  dest_off);
1027 1028 1029
				return -1;
			}
		} else
M
Matt Helsley 已提交
1030
			insn->call_dest = reloc->sym;
1031

P
Peter Zijlstra 已提交
1032 1033 1034 1035 1036 1037 1038
		/*
		 * Many compilers cannot disable KCOV with a function attribute
		 * so they need a little help, NOP out any KCOV calls from noinstr
		 * text.
		 */
		if (insn->sec->noinstr &&
		    !strncmp(insn->call_dest->name, "__sanitizer_cov_", 16)) {
1039 1040 1041
			if (reloc) {
				reloc->type = R_NONE;
				elf_write_reloc(file->elf, reloc);
P
Peter Zijlstra 已提交
1042 1043 1044 1045 1046 1047 1048 1049
			}

			elf_write_insn(file->elf, insn->sec,
				       insn->offset, insn->len,
				       arch_nop_insn(insn->len));
			insn->type = INSN_NOP;
		}

1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065
		if (mcount && !strcmp(insn->call_dest->name, "__fentry__")) {
			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;

			list_add_tail(&insn->mcount_loc_node,
				      &file->mcount_loc_list);
		}

1066 1067 1068 1069 1070 1071 1072 1073
		/*
		 * 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);
1074 1075 1076 1077 1078 1079
	}

	return 0;
}

/*
1080 1081
 * The .alternatives section requires some extra special care over and above
 * other special sections because alternatives are patched in place.
1082 1083 1084 1085 1086 1087
 */
static int handle_group_alt(struct objtool_file *file,
			    struct special_alt *special_alt,
			    struct instruction *orig_insn,
			    struct instruction **new_insn)
{
1088
	struct instruction *last_orig_insn, *last_new_insn = NULL, *insn, *nop = NULL;
J
Josh Poimboeuf 已提交
1089
	struct alt_group *orig_alt_group, *new_alt_group;
1090 1091
	unsigned long dest_off;

J
Josh Poimboeuf 已提交
1092 1093 1094 1095 1096 1097

	orig_alt_group = malloc(sizeof(*orig_alt_group));
	if (!orig_alt_group) {
		WARN("malloc failed");
		return -1;
	}
1098 1099 1100 1101 1102 1103 1104
	orig_alt_group->cfi = calloc(special_alt->orig_len,
				     sizeof(struct cfi_state *));
	if (!orig_alt_group->cfi) {
		WARN("calloc failed");
		return -1;
	}

1105 1106 1107 1108 1109 1110
	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 已提交
1111
		insn->alt_group = orig_alt_group;
1112 1113
		last_orig_insn = insn;
	}
J
Josh Poimboeuf 已提交
1114 1115 1116
	orig_alt_group->orig_group = NULL;
	orig_alt_group->first_insn = orig_insn;
	orig_alt_group->last_insn = last_orig_insn;
1117

1118

1119 1120 1121 1122
	new_alt_group = malloc(sizeof(*new_alt_group));
	if (!new_alt_group) {
		WARN("malloc failed");
		return -1;
1123 1124
	}

1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135
	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");
1136 1137
			return -1;
		}
1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
		memset(nop, 0, sizeof(*nop));
		INIT_LIST_HEAD(&nop->alts);
		INIT_LIST_HEAD(&nop->stack_ops);
		init_cfi_state(&nop->cfi);

		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;
1150
	}
1151

1152 1153 1154
	if (!special_alt->new_len) {
		*new_insn = nop;
		goto end;
1155 1156 1157 1158
	}

	insn = *new_insn;
	sec_for_each_insn_from(file, insn) {
1159 1160
		struct reloc *alt_reloc;

1161 1162 1163 1164 1165
		if (insn->offset >= special_alt->new_off + special_alt->new_len)
			break;

		last_new_insn = insn;

1166
		insn->ignore = orig_insn->ignore_alts;
1167
		insn->func = orig_insn->func;
J
Josh Poimboeuf 已提交
1168
		insn->alt_group = new_alt_group;
1169

1170 1171 1172 1173 1174 1175 1176 1177
		/*
		 * 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.
		 */
1178 1179 1180 1181
		alt_reloc = find_reloc_by_dest_range(file->elf, insn->sec,
						   insn->offset, insn->len);
		if (alt_reloc &&
		    !arch_support_alt_relocation(special_alt, insn, alt_reloc)) {
1182 1183 1184 1185 1186 1187

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

1188
		if (!is_static_jump(insn))
1189 1190 1191 1192 1193
			continue;

		if (!insn->immediate)
			continue;

1194
		dest_off = arch_jump_destination(insn);
1195 1196
		if (dest_off == special_alt->new_off + special_alt->new_len)
			insn->jump_dest = next_insn_same_sec(file, last_orig_insn);
1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210

		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;
	}

1211 1212 1213
	if (nop)
		list_add(&nop->list, &last_new_insn->list);
end:
J
Josh Poimboeuf 已提交
1214 1215
	new_alt_group->orig_group = orig_alt_group;
	new_alt_group->first_insn = *new_insn;
1216 1217
	new_alt_group->last_insn = nop ? : last_new_insn;
	new_alt_group->cfi = orig_alt_group->cfi;
1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286
	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)
{
	if (orig_insn->type == INSN_NOP)
		return 0;

	if (orig_insn->type != INSN_JUMP_UNCONDITIONAL) {
		WARN_FUNC("unsupported instruction at jump label",
			  orig_insn->sec, orig_insn->offset);
		return -1;
	}

	*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) {
1287 1288 1289 1290 1291 1292
			if (!special_alt->orig_len) {
				WARN_FUNC("empty alternative entry",
					  orig_insn->sec, orig_insn->offset);
				continue;
			}

1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303
			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;
		}

1304 1305 1306 1307 1308 1309 1310
		alt = malloc(sizeof(*alt));
		if (!alt) {
			WARN("malloc failed");
			ret = -1;
			goto out;
		}

1311
		alt->insn = new_insn;
P
Peter Zijlstra 已提交
1312
		alt->skip_orig = special_alt->skip_orig;
P
Peter Zijlstra 已提交
1313
		orig_insn->ignore_alts |= special_alt->skip_alt;
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323
		list_add_tail(&alt->list, &orig_insn->alts);

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

out:
	return ret;
}

1324
static int add_jump_table(struct objtool_file *file, struct instruction *insn,
M
Matt Helsley 已提交
1325
			    struct reloc *table)
1326
{
M
Matt Helsley 已提交
1327
	struct reloc *reloc = table;
1328
	struct instruction *dest_insn;
1329
	struct alternative *alt;
1330 1331
	struct symbol *pfunc = insn->func->pfunc;
	unsigned int prev_offset = 0;
1332

1333
	/*
M
Matt Helsley 已提交
1334
	 * Each @reloc is a switch table relocation which points to the target
1335 1336
	 * instruction.
	 */
M
Matt Helsley 已提交
1337
	list_for_each_entry_from(reloc, &table->sec->reloc_list, list) {
1338 1339

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

1343
		/* Make sure the table entries are consecutive: */
M
Matt Helsley 已提交
1344
		if (prev_offset && reloc->offset != prev_offset + 8)
1345 1346 1347
			break;

		/* Detect function pointers from contiguous objects: */
M
Matt Helsley 已提交
1348 1349
		if (reloc->sym->sec == pfunc->sec &&
		    reloc->addend == pfunc->offset)
1350 1351
			break;

M
Matt Helsley 已提交
1352
		dest_insn = find_insn(file, reloc->sym->sec, reloc->addend);
1353
		if (!dest_insn)
1354 1355
			break;

1356
		/* Make sure the destination is in the same function: */
1357
		if (!dest_insn->func || dest_insn->func->pfunc != pfunc)
1358
			break;
1359 1360 1361 1362 1363 1364 1365

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

1366
		alt->insn = dest_insn;
1367
		list_add_tail(&alt->list, &insn->alts);
M
Matt Helsley 已提交
1368
		prev_offset = reloc->offset;
1369 1370 1371 1372 1373 1374
	}

	if (!prev_offset) {
		WARN_FUNC("can't find switch jump table",
			  insn->sec, insn->offset);
		return -1;
1375 1376 1377 1378 1379 1380
	}

	return 0;
}

/*
1381 1382
 * find_jump_table() - Given a dynamic jump, find the switch jump table
 * associated with it.
1383
 */
M
Matt Helsley 已提交
1384
static struct reloc *find_jump_table(struct objtool_file *file,
1385 1386 1387
				      struct symbol *func,
				      struct instruction *insn)
{
1388
	struct reloc *table_reloc;
1389
	struct instruction *dest_insn, *orig_insn = insn;
1390

1391 1392 1393 1394 1395
	/*
	 * Backward search using the @first_jump_src links, these help avoid
	 * much of the 'in between' code. Which avoids us getting confused by
	 * it.
	 */
1396
	for (;
1397 1398
	     insn && insn->func && insn->func->pfunc == func;
	     insn = insn->first_jump_src ?: prev_insn_same_sym(file, insn)) {
1399

1400
		if (insn != orig_insn && insn->type == INSN_JUMP_DYNAMIC)
1401 1402 1403 1404 1405 1406 1407 1408 1409
			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;

1410
		table_reloc = arch_find_switch_table(file, insn);
M
Matt Helsley 已提交
1411
		if (!table_reloc)
1412
			continue;
M
Matt Helsley 已提交
1413
		dest_insn = find_insn(file, table_reloc->sym->sec, table_reloc->addend);
1414 1415
		if (!dest_insn || !dest_insn->func || dest_insn->func->pfunc != func)
			continue;
1416

M
Matt Helsley 已提交
1417
		return table_reloc;
1418 1419 1420 1421 1422
	}

	return NULL;
}

1423 1424 1425 1426 1427 1428
/*
 * 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)
1429
{
1430
	struct instruction *insn, *last = NULL;
M
Matt Helsley 已提交
1431
	struct reloc *reloc;
1432

1433
	func_for_each_insn(file, func, insn) {
1434 1435 1436 1437 1438
		if (!last)
			last = insn;

		/*
		 * Store back-pointers for unconditional forward jumps such
1439
		 * that find_jump_table() can back-track using those and
1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450
		 * 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;
		}

1451 1452 1453
		if (insn->type != INSN_JUMP_DYNAMIC)
			continue;

M
Matt Helsley 已提交
1454 1455 1456 1457
		reloc = find_jump_table(file, func, insn);
		if (reloc) {
			reloc->jump_table_start = true;
			insn->jump_table = reloc;
1458 1459
		}
	}
1460 1461 1462 1463 1464 1465 1466 1467
}

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

1468
	func_for_each_insn(file, func, insn) {
1469 1470
		if (!insn->jump_table)
			continue;
1471

1472
		ret = add_jump_table(file, insn, insn->jump_table);
1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484
		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.
 */
1485
static int add_jump_table_alts(struct objtool_file *file)
1486 1487 1488 1489 1490
{
	struct section *sec;
	struct symbol *func;
	int ret;

1491
	if (!file->rodata)
1492 1493
		return 0;

1494
	for_each_sec(file, sec) {
1495 1496 1497 1498
		list_for_each_entry(func, &sec->symbol_list, list) {
			if (func->type != STT_FUNC)
				continue;

1499
			mark_func_jump_tables(file, func);
1500
			ret = add_func_jump_tables(file, func);
1501 1502 1503 1504 1505 1506 1507 1508
			if (ret)
				return ret;
		}
	}

	return 0;
}

1509 1510 1511 1512 1513 1514 1515 1516
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;
}

1517 1518
static int read_unwind_hints(struct objtool_file *file)
{
M
Matt Helsley 已提交
1519 1520
	struct section *sec, *relocsec;
	struct reloc *reloc;
1521 1522 1523 1524 1525 1526 1527 1528
	struct unwind_hint *hint;
	struct instruction *insn;
	int i;

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

M
Matt Helsley 已提交
1529 1530
	relocsec = sec->reloc;
	if (!relocsec) {
1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544
		WARN("missing .rela.discard.unwind_hints section");
		return -1;
	}

	if (sec->len % sizeof(struct unwind_hint)) {
		WARN("struct unwind_hint size mismatch");
		return -1;
	}

	file->hints = true;

	for (i = 0; i < sec->len / sizeof(struct unwind_hint); i++) {
		hint = (struct unwind_hint *)sec->data->d_buf + i;

M
Matt Helsley 已提交
1545 1546 1547
		reloc = find_reloc_by_dest(file->elf, sec, i * sizeof(*hint));
		if (!reloc) {
			WARN("can't find reloc for unwind_hints[%d]", i);
1548 1549 1550
			return -1;
		}

M
Matt Helsley 已提交
1551
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
1552 1553 1554 1555 1556
		if (!insn) {
			WARN("can't find insn for unwind_hints[%d]", i);
			return -1;
		}

1557
		insn->hint = true;
1558

1559 1560
		if (hint->type == UNWIND_HINT_TYPE_FUNC) {
			set_func_state(&insn->cfi);
1561 1562 1563
			continue;
		}

1564
		if (arch_decode_hint_reg(insn, hint->sp_reg)) {
1565 1566 1567 1568 1569
			WARN_FUNC("unsupported unwind_hint sp base reg %d",
				  insn->sec, insn->offset, hint->sp_reg);
			return -1;
		}

1570
		insn->cfi.cfa.offset = bswap_if_needed(hint->sp_offset);
1571 1572
		insn->cfi.type = hint->type;
		insn->cfi.end = hint->end;
1573 1574 1575 1576 1577
	}

	return 0;
}

1578 1579
static int read_retpoline_hints(struct objtool_file *file)
{
J
Josh Poimboeuf 已提交
1580
	struct section *sec;
1581
	struct instruction *insn;
M
Matt Helsley 已提交
1582
	struct reloc *reloc;
1583

J
Josh Poimboeuf 已提交
1584
	sec = find_section_by_name(file->elf, ".rela.discard.retpoline_safe");
1585 1586 1587
	if (!sec)
		return 0;

M
Matt Helsley 已提交
1588 1589
	list_for_each_entry(reloc, &sec->reloc_list, list) {
		if (reloc->sym->type != STT_SECTION) {
J
Josh Poimboeuf 已提交
1590
			WARN("unexpected relocation symbol type in %s", sec->name);
1591 1592 1593
			return -1;
		}

M
Matt Helsley 已提交
1594
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
1595
		if (!insn) {
J
Josh Poimboeuf 已提交
1596
			WARN("bad .discard.retpoline_safe entry");
1597 1598 1599 1600 1601
			return -1;
		}

		if (insn->type != INSN_JUMP_DYNAMIC &&
		    insn->type != INSN_CALL_DYNAMIC) {
J
Josh Poimboeuf 已提交
1602
			WARN_FUNC("retpoline_safe hint not an indirect jump/call",
1603 1604 1605 1606 1607 1608 1609 1610 1611 1612
				  insn->sec, insn->offset);
			return -1;
		}

		insn->retpoline_safe = true;
	}

	return 0;
}

1613 1614 1615 1616
static int read_instr_hints(struct objtool_file *file)
{
	struct section *sec;
	struct instruction *insn;
M
Matt Helsley 已提交
1617
	struct reloc *reloc;
1618 1619 1620 1621 1622

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

M
Matt Helsley 已提交
1623 1624
	list_for_each_entry(reloc, &sec->reloc_list, list) {
		if (reloc->sym->type != STT_SECTION) {
1625 1626 1627 1628
			WARN("unexpected relocation symbol type in %s", sec->name);
			return -1;
		}

M
Matt Helsley 已提交
1629
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641
		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 已提交
1642 1643
	list_for_each_entry(reloc, &sec->reloc_list, list) {
		if (reloc->sym->type != STT_SECTION) {
1644 1645 1646 1647
			WARN("unexpected relocation symbol type in %s", sec->name);
			return -1;
		}

M
Matt Helsley 已提交
1648
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659
		if (!insn) {
			WARN("bad .discard.instr_begin entry");
			return -1;
		}

		insn->instr++;
	}

	return 0;
}

1660 1661 1662 1663
static int read_intra_function_calls(struct objtool_file *file)
{
	struct instruction *insn;
	struct section *sec;
M
Matt Helsley 已提交
1664
	struct reloc *reloc;
1665 1666 1667 1668 1669

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

M
Matt Helsley 已提交
1670
	list_for_each_entry(reloc, &sec->reloc_list, list) {
1671 1672
		unsigned long dest_off;

M
Matt Helsley 已提交
1673
		if (reloc->sym->type != STT_SECTION) {
1674 1675 1676 1677 1678
			WARN("unexpected relocation symbol type in %s",
			     sec->name);
			return -1;
		}

M
Matt Helsley 已提交
1679
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710
		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;
}

1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727
static int read_static_call_tramps(struct objtool_file *file)
{
	struct section *sec;
	struct symbol *func;

	for_each_sec(file, sec) {
		list_for_each_entry(func, &sec->symbol_list, list) {
			if (func->bind == STB_GLOBAL &&
			    !strncmp(func->name, STATIC_CALL_TRAMP_PREFIX_STR,
				     strlen(STATIC_CALL_TRAMP_PREFIX_STR)))
				func->static_call_tramp = true;
		}
	}

	return 0;
}

1728 1729 1730 1731 1732 1733
static void mark_rodata(struct objtool_file *file)
{
	struct section *sec;
	bool found = false;

	/*
1734 1735 1736 1737 1738 1739 1740 1741
	 * 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.
1742 1743
	 */
	for_each_sec(file, sec) {
1744 1745
		if (!strncmp(sec->name, ".rodata", 7) &&
		    !strstr(sec->name, ".str1.")) {
1746 1747 1748 1749 1750 1751 1752 1753
			sec->rodata = true;
			found = true;
		}
	}

	file->rodata = found;
}

1754 1755 1756 1757
static int decode_sections(struct objtool_file *file)
{
	int ret;

1758 1759
	mark_rodata(file);

1760 1761 1762 1763 1764 1765 1766 1767 1768
	ret = decode_instructions(file);
	if (ret)
		return ret;

	ret = add_dead_ends(file);
	if (ret)
		return ret;

	add_ignores(file);
P
Peter Zijlstra 已提交
1769
	add_uaccess_safe(file);
1770

1771
	ret = add_ignore_alternatives(file);
1772 1773 1774
	if (ret)
		return ret;

P
Peter Zijlstra 已提交
1775 1776 1777 1778
	ret = read_static_call_tramps(file);
	if (ret)
		return ret;

1779 1780 1781 1782
	ret = add_jump_destinations(file);
	if (ret)
		return ret;

1783
	ret = add_special_section_alts(file);
1784 1785 1786
	if (ret)
		return ret;

1787 1788 1789 1790
	ret = read_intra_function_calls(file);
	if (ret)
		return ret;

1791
	ret = add_call_destinations(file);
1792 1793 1794
	if (ret)
		return ret;

1795
	ret = add_jump_table_alts(file);
1796 1797 1798
	if (ret)
		return ret;

1799 1800 1801 1802
	ret = read_unwind_hints(file);
	if (ret)
		return ret;

1803 1804 1805 1806
	ret = read_retpoline_hints(file);
	if (ret)
		return ret;

1807 1808 1809 1810
	ret = read_instr_hints(file);
	if (ret)
		return ret;

1811 1812 1813 1814 1815
	return 0;
}

static bool is_fentry_call(struct instruction *insn)
{
1816
	if (insn->type == INSN_CALL && insn->call_dest &&
1817 1818 1819 1820 1821 1822 1823
	    insn->call_dest->type == STT_NOTYPE &&
	    !strcmp(insn->call_dest->name, "__fentry__"))
		return true;

	return false;
}

1824
static bool has_modified_stack_frame(struct instruction *insn, struct insn_state *state)
1825
{
1826
	struct cfi_state *cfi = &state->cfi;
1827 1828
	int i;

1829
	if (cfi->cfa.base != initial_func_cfi.cfa.base || cfi->drap)
1830 1831
		return true;

1832
	if (cfi->cfa.offset != initial_func_cfi.cfa.offset)
1833 1834
		return true;

1835
	if (cfi->stack_size != initial_func_cfi.cfa.offset)
1836 1837 1838
		return true;

	for (i = 0; i < CFI_NUM_REGS; i++) {
1839 1840
		if (cfi->regs[i].base != initial_func_cfi.regs[i].base ||
		    cfi->regs[i].offset != initial_func_cfi.regs[i].offset)
1841
			return true;
1842
	}
1843 1844 1845 1846

	return false;
}

1847 1848 1849 1850 1851 1852 1853
static bool check_reg_frame_pos(const struct cfi_reg *reg,
				int expected_offset)
{
	return reg->base == CFI_CFA &&
	       reg->offset == expected_offset;
}

1854 1855
static bool has_valid_stack_frame(struct insn_state *state)
{
1856 1857
	struct cfi_state *cfi = &state->cfi;

1858 1859 1860
	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))
1861 1862
		return true;

1863
	if (cfi->drap && cfi->regs[CFI_BP].base == CFI_BP)
1864 1865 1866
		return true;

	return false;
1867 1868
}

1869 1870
static int update_cfi_state_regs(struct instruction *insn,
				  struct cfi_state *cfi,
1871
				  struct stack_op *op)
1872
{
1873
	struct cfi_reg *cfa = &cfi->cfa;
1874

1875
	if (cfa->base != CFI_SP && cfa->base != CFI_SP_INDIRECT)
1876 1877 1878
		return 0;

	/* push */
P
Peter Zijlstra 已提交
1879
	if (op->dest.type == OP_DEST_PUSH || op->dest.type == OP_DEST_PUSHF)
1880 1881 1882
		cfa->offset += 8;

	/* pop */
P
Peter Zijlstra 已提交
1883
	if (op->src.type == OP_SRC_POP || op->src.type == OP_SRC_POPF)
1884 1885 1886 1887 1888 1889 1890 1891 1892 1893
		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;
}

1894
static void save_reg(struct cfi_state *cfi, unsigned char reg, int base, int offset)
1895
{
1896
	if (arch_callee_saved_reg(reg) &&
1897 1898 1899
	    cfi->regs[reg].base == CFI_UNDEFINED) {
		cfi->regs[reg].base = base;
		cfi->regs[reg].offset = offset;
1900
	}
1901 1902
}

1903
static void restore_reg(struct cfi_state *cfi, unsigned char reg)
1904
{
1905 1906
	cfi->regs[reg].base = initial_func_cfi.regs[reg].base;
	cfi->regs[reg].offset = initial_func_cfi.regs[reg].offset;
1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961
}

/*
 * 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
 */
1962
static int update_cfi_state(struct instruction *insn, struct cfi_state *cfi,
1963
			     struct stack_op *op)
1964
{
1965 1966
	struct cfi_reg *cfa = &cfi->cfa;
	struct cfi_reg *regs = cfi->regs;
1967 1968 1969 1970 1971 1972 1973 1974 1975 1976

	/* 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;
	}

1977 1978
	if (cfi->type == UNWIND_HINT_TYPE_REGS ||
	    cfi->type == UNWIND_HINT_TYPE_REGS_PARTIAL)
1979
		return update_cfi_state_regs(insn, cfi, op);
1980

1981 1982 1983 1984 1985 1986
	switch (op->dest.type) {

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

		case OP_SRC_REG:
1987 1988
			if (op->src.reg == CFI_SP && op->dest.reg == CFI_BP &&
			    cfa->base == CFI_SP &&
1989
			    check_reg_frame_pos(&regs[CFI_BP], -cfa->offset)) {
1990 1991 1992

				/* mov %rsp, %rbp */
				cfa->base = op->dest.reg;
1993
				cfi->bp_scratch = false;
1994
			}
1995

1996
			else if (op->src.reg == CFI_SP &&
1997
				 op->dest.reg == CFI_BP && cfi->drap) {
1998

1999 2000
				/* drap: mov %rsp, %rbp */
				regs[CFI_BP].base = CFI_BP;
2001 2002
				regs[CFI_BP].offset = -cfi->stack_size;
				cfi->bp_scratch = false;
2003
			}
2004

2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016
			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
				 */
2017 2018
				cfi->vals[op->dest.reg].base = CFI_CFA;
				cfi->vals[op->dest.reg].offset = -cfi->stack_size;
2019 2020
			}

J
Josh Poimboeuf 已提交
2021 2022 2023 2024 2025 2026 2027 2028
			else if (op->src.reg == CFI_BP && op->dest.reg == CFI_SP &&
				 cfa->base == CFI_BP) {

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

2032 2033 2034 2035
			else if (op->dest.reg == cfa->base) {

				/* mov %reg, %rsp */
				if (cfa->base == CFI_SP &&
2036
				    cfi->vals[op->src.reg].base == CFI_CFA) {
2037 2038 2039 2040 2041 2042 2043 2044 2045

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

P
Peter Zijlstra 已提交
2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080
				} 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;

2081 2082 2083 2084
				} else {
					cfa->base = CFI_UNDEFINED;
					cfa->offset = 0;
				}
2085 2086
			}

2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100
			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;
			}


2101 2102 2103 2104 2105 2106
			break;

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

				/* add imm, %rsp */
2107
				cfi->stack_size -= op->src.offset;
2108 2109 2110 2111 2112 2113 2114 2115
				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 */
2116
				cfi->stack_size = -(op->src.offset + regs[CFI_BP].offset);
2117 2118 2119
				break;
			}

2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130
			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;
			}

2131
			if (op->src.reg == CFI_SP && cfa->base == CFI_SP) {
2132 2133

				/* drap: lea disp(%rsp), %drap */
2134
				cfi->drap_reg = op->dest.reg;
2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145

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

2150 2151 2152
				break;
			}

2153 2154
			if (cfi->drap && op->dest.reg == CFI_SP &&
			    op->src.reg == cfi->drap_reg) {
2155 2156 2157

				 /* drap: lea disp(%drap), %rsp */
				cfa->base = CFI_SP;
2158 2159 2160
				cfa->offset = cfi->stack_size = -op->src.offset;
				cfi->drap_reg = CFI_UNDEFINED;
				cfi->drap = false;
2161 2162 2163
				break;
			}

2164
			if (op->dest.reg == cfi->cfa.base) {
2165 2166 2167 2168 2169 2170 2171 2172 2173
				WARN_FUNC("unsupported stack register modification",
					  insn->sec, insn->offset);
				return -1;
			}

			break;

		case OP_SRC_AND:
			if (op->dest.reg != CFI_SP ||
2174 2175
			    (cfi->drap_reg != CFI_UNDEFINED && cfa->base != CFI_SP) ||
			    (cfi->drap_reg == CFI_UNDEFINED && cfa->base != CFI_BP)) {
2176 2177 2178 2179 2180
				WARN_FUNC("unsupported stack pointer realignment",
					  insn->sec, insn->offset);
				return -1;
			}

2181
			if (cfi->drap_reg != CFI_UNDEFINED) {
2182
				/* drap: and imm, %rsp */
2183 2184 2185
				cfa->base = cfi->drap_reg;
				cfa->offset = cfi->stack_size = 0;
				cfi->drap = true;
2186 2187 2188 2189 2190 2191 2192 2193 2194 2195
			}

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

			break;

		case OP_SRC_POP:
P
Peter Zijlstra 已提交
2196
		case OP_SRC_POPF:
P
Peter Zijlstra 已提交
2197 2198 2199 2200 2201 2202 2203
			if (op->dest.reg == CFI_SP && cfa->base == CFI_SP_INDIRECT) {

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

2204
			if (!cfi->drap && op->dest.reg == cfa->base) {
2205 2206 2207 2208 2209

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

2210 2211 2212
			if (cfi->drap && cfa->base == CFI_BP_INDIRECT &&
			    op->dest.reg == cfi->drap_reg &&
			    cfi->drap_offset == -cfi->stack_size) {
2213

2214
				/* drap: pop %drap */
2215
				cfa->base = cfi->drap_reg;
2216
				cfa->offset = 0;
2217
				cfi->drap_offset = -1;
2218

2219
			} else if (regs[op->dest.reg].offset == -cfi->stack_size) {
2220

2221
				/* pop %reg */
2222
				restore_reg(cfi, op->dest.reg);
2223 2224
			}

2225
			cfi->stack_size -= 8;
2226 2227 2228 2229 2230 2231
			if (cfa->base == CFI_SP)
				cfa->offset -= 8;

			break;

		case OP_SRC_REG_INDIRECT:
2232 2233 2234 2235 2236 2237 2238 2239
			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;
			}

2240 2241
			if (cfi->drap && op->src.reg == CFI_BP &&
			    op->src.offset == cfi->drap_offset) {
2242 2243

				/* drap: mov disp(%rbp), %drap */
2244
				cfa->base = cfi->drap_reg;
2245
				cfa->offset = 0;
2246
				cfi->drap_offset = -1;
2247 2248
			}

2249
			if (cfi->drap && op->src.reg == CFI_BP &&
2250 2251 2252
			    op->src.offset == regs[op->dest.reg].offset) {

				/* drap: mov disp(%rbp), %reg */
2253
				restore_reg(cfi, op->dest.reg);
2254 2255 2256 2257 2258 2259

			} 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 */
2260
				restore_reg(cfi, op->dest.reg);
2261 2262 2263 2264 2265 2266

			} 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);
2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279
			}

			break;

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

		break;

	case OP_DEST_PUSH:
P
Peter Zijlstra 已提交
2280
	case OP_DEST_PUSHF:
2281
		cfi->stack_size += 8;
2282 2283 2284 2285 2286 2287
		if (cfa->base == CFI_SP)
			cfa->offset += 8;

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

2288 2289
		if (cfi->drap) {
			if (op->src.reg == cfa->base && op->src.reg == cfi->drap_reg) {
2290 2291 2292

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

2295
				/* save drap so we know when to restore it */
2296
				cfi->drap_offset = -cfi->stack_size;
2297

2298
			} else if (op->src.reg == CFI_BP && cfa->base == cfi->drap_reg) {
2299 2300

				/* drap: push %rbp */
2301
				cfi->stack_size = 0;
2302

2303
			} else {
2304 2305

				/* drap: push %reg */
2306
				save_reg(cfi, op->src.reg, CFI_BP, -cfi->stack_size);
2307 2308 2309 2310 2311
			}

		} else {

			/* push %reg */
2312
			save_reg(cfi, op->src.reg, CFI_CFA, -cfi->stack_size);
2313 2314 2315
		}

		/* detect when asm code uses rbp as a scratch register */
2316
		if (!no_fp && insn->func && op->src.reg == CFI_BP &&
2317
		    cfa->base != CFI_BP)
2318
			cfi->bp_scratch = true;
2319 2320 2321 2322
		break;

	case OP_DEST_REG_INDIRECT:

2323 2324
		if (cfi->drap) {
			if (op->src.reg == cfa->base && op->src.reg == cfi->drap_reg) {
2325 2326 2327 2328 2329

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

2330
				/* save drap offset so we know when to restore it */
2331
				cfi->drap_offset = op->dest.offset;
2332
			} else {
2333 2334

				/* drap: mov reg, disp(%rbp) */
2335
				save_reg(cfi, op->src.reg, CFI_BP, op->dest.offset);
2336 2337 2338 2339 2340 2341
			}

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

			/* mov reg, disp(%rbp) */
			/* mov reg, disp(%rsp) */
2342 2343
			save_reg(cfi, op->src.reg, CFI_CFA,
				 op->dest.offset - cfi->cfa.offset);
2344 2345 2346 2347 2348 2349

		} 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 已提交
2350 2351 2352 2353 2354 2355

		} 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;
2356 2357 2358 2359 2360
		}

		break;

	case OP_DEST_LEAVE:
2361 2362
		if ((!cfi->drap && cfa->base != CFI_BP) ||
		    (cfi->drap && cfa->base != cfi->drap_reg)) {
2363 2364 2365 2366 2367 2368 2369
			WARN_FUNC("leave instruction with modified stack frame",
				  insn->sec, insn->offset);
			return -1;
		}

		/* leave (mov %rbp, %rsp; pop %rbp) */

2370 2371
		cfi->stack_size = -cfi->regs[CFI_BP].offset - 8;
		restore_reg(cfi, CFI_BP);
2372

2373
		if (!cfi->drap) {
2374 2375 2376 2377 2378 2379 2380
			cfa->base = CFI_SP;
			cfa->offset -= 8;
		}

		break;

	case OP_DEST_MEM:
P
Peter Zijlstra 已提交
2381
		if (op->src.type != OP_SRC_POP && op->src.type != OP_SRC_POPF) {
2382 2383 2384 2385 2386 2387
			WARN_FUNC("unknown stack-related memory operation",
				  insn->sec, insn->offset);
			return -1;
		}

		/* pop mem */
2388
		cfi->stack_size -= 8;
2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402
		if (cfa->base == CFI_SP)
			cfa->offset -= 8;

		break;

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

	return 0;
}

2403 2404 2405 2406 2407 2408 2409 2410 2411 2412
/*
 * 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)
2413
{
2414 2415
	struct cfi_state **alt_cfi;
	int group_off;
2416

2417 2418
	if (!insn->alt_group)
		return 0;
2419

2420 2421
	alt_cfi = insn->alt_group->cfi;
	group_off = insn->offset - insn->alt_group->first_insn->offset;
2422

2423 2424 2425 2426 2427 2428
	if (!alt_cfi[group_off]) {
		alt_cfi[group_off] = &insn->cfi;
	} else {
		if (memcmp(alt_cfi[group_off], &insn->cfi, sizeof(struct cfi_state))) {
			WARN_FUNC("stack layout conflict in alternatives",
				  insn->sec, insn->offset);
2429 2430
			return -1;
		}
2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443
	}

	return 0;
}

static int handle_insn_ops(struct instruction *insn, struct insn_state *state)
{
	struct stack_op *op;

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

		if (update_cfi_state(insn, &state->cfi, op))
			return 1;
2444

2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469
		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;
}

2470
static bool insn_cfi_match(struct instruction *insn, struct cfi_state *cfi2)
2471
{
2472
	struct cfi_state *cfi1 = &insn->cfi;
2473 2474
	int i;

2475 2476
	if (memcmp(&cfi1->cfa, &cfi2->cfa, sizeof(cfi1->cfa))) {

2477 2478
		WARN_FUNC("stack state mismatch: cfa1=%d%+d cfa2=%d%+d",
			  insn->sec, insn->offset,
2479 2480
			  cfi1->cfa.base, cfi1->cfa.offset,
			  cfi2->cfa.base, cfi2->cfa.offset);
2481

2482
	} else if (memcmp(&cfi1->regs, &cfi2->regs, sizeof(cfi1->regs))) {
2483
		for (i = 0; i < CFI_NUM_REGS; i++) {
2484
			if (!memcmp(&cfi1->regs[i], &cfi2->regs[i],
2485 2486 2487 2488 2489
				    sizeof(struct cfi_reg)))
				continue;

			WARN_FUNC("stack state mismatch: reg1[%d]=%d%+d reg2[%d]=%d%+d",
				  insn->sec, insn->offset,
2490 2491
				  i, cfi1->regs[i].base, cfi1->regs[i].offset,
				  i, cfi2->regs[i].base, cfi2->regs[i].offset);
2492 2493 2494
			break;
		}

2495 2496
	} else if (cfi1->type != cfi2->type) {

2497
		WARN_FUNC("stack state mismatch: type1=%d type2=%d",
2498 2499 2500 2501 2502
			  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)) {
2503

2504
		WARN_FUNC("stack state mismatch: drap1=%d(%d,%d) drap2=%d(%d,%d)",
2505
			  insn->sec, insn->offset,
2506 2507
			  cfi1->drap, cfi1->drap_reg, cfi1->drap_offset,
			  cfi2->drap, cfi2->drap_reg, cfi2->drap_offset);
2508 2509 2510 2511 2512

	} else
		return true;

	return false;
2513 2514
}

P
Peter Zijlstra 已提交
2515 2516 2517
static inline bool func_uaccess_safe(struct symbol *func)
{
	if (func)
2518
		return func->uaccess_safe;
P
Peter Zijlstra 已提交
2519 2520 2521 2522

	return false;
}

2523
static inline const char *call_dest_name(struct instruction *insn)
P
Peter Zijlstra 已提交
2524 2525 2526 2527 2528 2529 2530
{
	if (insn->call_dest)
		return insn->call_dest->name;

	return "{dynamic}";
}

2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556
static inline bool noinstr_call_dest(struct symbol *func)
{
	/*
	 * We can't deal with indirect function calls at present;
	 * assume they're instrumented.
	 */
	if (!func)
		return false;

	/*
	 * 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;
}

P
Peter Zijlstra 已提交
2557 2558
static int validate_call(struct instruction *insn, struct insn_state *state)
{
2559
	if (state->noinstr && state->instr <= 0 &&
2560
	    !noinstr_call_dest(insn->call_dest)) {
2561 2562 2563 2564 2565
		WARN_FUNC("call to %s() leaves .noinstr.text section",
				insn->sec, insn->offset, call_dest_name(insn));
		return 1;
	}

P
Peter Zijlstra 已提交
2566 2567
	if (state->uaccess && !func_uaccess_safe(insn->call_dest)) {
		WARN_FUNC("call to %s() with UACCESS enabled",
2568
				insn->sec, insn->offset, call_dest_name(insn));
P
Peter Zijlstra 已提交
2569 2570 2571
		return 1;
	}

2572 2573
	if (state->df) {
		WARN_FUNC("call to %s() with DF set",
2574
				insn->sec, insn->offset, call_dest_name(insn));
2575 2576 2577
		return 1;
	}

P
Peter Zijlstra 已提交
2578 2579 2580
	return 0;
}

2581 2582
static int validate_sibling_call(struct instruction *insn, struct insn_state *state)
{
2583
	if (has_modified_stack_frame(insn, state)) {
2584 2585 2586 2587 2588
		WARN_FUNC("sibling call from callable instruction with modified stack frame",
				insn->sec, insn->offset);
		return 1;
	}

P
Peter Zijlstra 已提交
2589
	return validate_call(insn, state);
2590 2591
}

2592 2593
static int validate_return(struct symbol *func, struct instruction *insn, struct insn_state *state)
{
2594 2595 2596 2597 2598 2599
	if (state->noinstr && state->instr > 0) {
		WARN_FUNC("return with instrumentation enabled",
			  insn->sec, insn->offset);
		return 1;
	}

2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617
	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;
	}

2618
	if (func && has_modified_stack_frame(insn, state)) {
2619 2620 2621 2622 2623
		WARN_FUNC("return with modified stack frame",
			  insn->sec, insn->offset);
		return 1;
	}

2624
	if (state->cfi.bp_scratch) {
2625 2626
		WARN_FUNC("BP used as a scratch register",
			  insn->sec, insn->offset);
2627 2628 2629 2630 2631 2632
		return 1;
	}

	return 0;
}

2633 2634
static struct instruction *next_insn_to_validate(struct objtool_file *file,
						 struct instruction *insn)
2635
{
J
Josh Poimboeuf 已提交
2636
	struct alt_group *alt_group = insn->alt_group;
2637

2638 2639 2640 2641 2642 2643 2644 2645 2646
	/*
	 * 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);
2647 2648
}

2649 2650 2651 2652 2653 2654
/*
 * 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.
 */
2655
static int validate_branch(struct objtool_file *file, struct symbol *func,
P
Peter Zijlstra 已提交
2656
			   struct instruction *insn, struct insn_state state)
2657 2658
{
	struct alternative *alt;
P
Peter Zijlstra 已提交
2659
	struct instruction *next_insn;
2660
	struct section *sec;
2661
	u8 visited;
2662 2663 2664 2665 2666
	int ret;

	sec = insn->sec;

	while (1) {
2667
		next_insn = next_insn_to_validate(file, insn);
2668

2669
		if (file->c_file && func && insn->func && func != insn->func->pfunc) {
2670 2671 2672
			WARN("%s() falls through to next function %s()",
			     func->name, insn->func->name);
			return 1;
2673 2674
		}

2675 2676 2677
		if (func && insn->ignore) {
			WARN_FUNC("BUG: why am I validating an ignored function?",
				  sec, insn->offset);
2678
			return 1;
2679 2680
		}

2681
		visited = 1 << state.uaccess;
2682
		if (insn->visited) {
2683
			if (!insn->hint && !insn_cfi_match(insn, &state.cfi))
2684 2685
				return 1;

2686
			if (insn->visited & visited)
P
Peter Zijlstra 已提交
2687
				return 0;
2688 2689
		}

2690 2691 2692
		if (state.noinstr)
			state.instr += insn->instr;

2693
		if (insn->hint)
2694
			state.cfi = insn->cfi;
2695
		else
2696
			insn->cfi = state.cfi;
2697

2698
		insn->visited |= visited;
2699

2700 2701 2702
		if (propagate_alt_cfi(file, insn))
			return 1;

2703
		if (!insn->ignore_alts && !list_empty(&insn->alts)) {
P
Peter Zijlstra 已提交
2704 2705
			bool skip_orig = false;

2706
			list_for_each_entry(alt, &insn->alts, list) {
P
Peter Zijlstra 已提交
2707 2708 2709
				if (alt->skip_orig)
					skip_orig = true;

2710
				ret = validate_branch(file, func, alt->insn, state);
2711 2712 2713 2714 2715
				if (ret) {
					if (backtrace)
						BT_FUNC("(alt)", insn);
					return ret;
				}
2716
			}
P
Peter Zijlstra 已提交
2717 2718 2719

			if (skip_orig)
				return 0;
2720 2721
		}

2722 2723 2724
		if (handle_insn_ops(insn, &state))
			return 1;

2725 2726 2727
		switch (insn->type) {

		case INSN_RETURN:
2728
			return validate_return(func, insn, &state);
2729 2730

		case INSN_CALL:
P
Peter Zijlstra 已提交
2731 2732 2733 2734
		case INSN_CALL_DYNAMIC:
			ret = validate_call(insn, &state);
			if (ret)
				return ret;
2735

2736 2737
			if (!no_fp && func && !is_fentry_call(insn) &&
			    !has_valid_stack_frame(&state)) {
2738 2739 2740 2741
				WARN_FUNC("call without frame pointer save/setup",
					  sec, insn->offset);
				return 1;
			}
2742 2743 2744 2745

			if (dead_end_function(file, insn->call_dest))
				return 0;

2746 2747 2748 2749 2750
			if (insn->type == INSN_CALL && insn->call_dest->static_call_tramp) {
				list_add_tail(&insn->static_call_node,
					      &file->static_call_list);
			}

2751 2752 2753 2754
			break;

		case INSN_JUMP_CONDITIONAL:
		case INSN_JUMP_UNCONDITIONAL:
2755
			if (is_sibling_call(insn)) {
2756
				ret = validate_sibling_call(insn, &state);
2757
				if (ret)
2758
					return ret;
2759

2760
			} else if (insn->jump_dest) {
2761 2762
				ret = validate_branch(file, func,
						      insn->jump_dest, state);
2763 2764 2765 2766 2767
				if (ret) {
					if (backtrace)
						BT_FUNC("(branch)", insn);
					return ret;
				}
2768
			}
2769 2770 2771 2772 2773 2774 2775

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

			break;

		case INSN_JUMP_DYNAMIC:
2776
		case INSN_JUMP_DYNAMIC_CONDITIONAL:
2777
			if (is_sibling_call(insn)) {
2778 2779 2780
				ret = validate_sibling_call(insn, &state);
				if (ret)
					return ret;
2781 2782
			}

2783 2784 2785 2786
			if (insn->type == INSN_JUMP_DYNAMIC)
				return 0;

			break;
2787

2788 2789 2790 2791 2792 2793 2794 2795
		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 已提交
2796 2797 2798 2799 2800 2801 2802 2803 2804 2805
		case INSN_STAC:
			if (state.uaccess) {
				WARN_FUNC("recursive UACCESS enable", sec, insn->offset);
				return 1;
			}

			state.uaccess = true;
			break;

		case INSN_CLAC:
2806
			if (!state.uaccess && func) {
P
Peter Zijlstra 已提交
2807 2808 2809 2810 2811 2812 2813 2814 2815 2816
				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;
2817 2818
			break;

2819
		case INSN_STD:
2820
			if (state.df) {
2821
				WARN_FUNC("recursive STD", sec, insn->offset);
2822 2823
				return 1;
			}
2824 2825 2826 2827 2828

			state.df = true;
			break;

		case INSN_CLD:
2829
			if (!state.df && func) {
2830
				WARN_FUNC("redundant CLD", sec, insn->offset);
2831 2832
				return 1;
			}
2833 2834

			state.df = false;
2835 2836
			break;

2837 2838 2839 2840 2841 2842 2843
		default:
			break;
		}

		if (insn->dead_end)
			return 0;

2844
		if (!next_insn) {
2845
			if (state.cfi.cfa.base == CFI_UNDEFINED)
2846
				return 0;
2847 2848 2849
			WARN("%s: unexpected end of section", sec->name);
			return 1;
		}
2850 2851

		insn = next_insn;
2852 2853 2854 2855 2856
	}

	return 0;
}

2857
static int validate_unwind_hints(struct objtool_file *file, struct section *sec)
2858 2859 2860
{
	struct instruction *insn;
	struct insn_state state;
2861
	int ret, warnings = 0;
2862 2863 2864 2865

	if (!file->hints)
		return 0;

2866
	init_insn_state(&state, sec);
2867

2868 2869 2870 2871 2872 2873 2874 2875 2876
	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)) {
2877
		if (insn->hint && !insn->visited) {
2878
			ret = validate_branch(file, insn->func, insn, state);
2879 2880
			if (ret && backtrace)
				BT_FUNC("<=== (hint)", insn);
2881 2882
			warnings += ret;
		}
2883 2884

		insn = list_next_entry(insn, list);
2885 2886 2887 2888 2889
	}

	return warnings;
}

2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902
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;

2903 2904 2905 2906 2907 2908 2909 2910 2911
		/*
		 * .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;

2912 2913 2914 2915 2916 2917 2918 2919 2920 2921
		WARN_FUNC("indirect %s found in RETPOLINE build",
			  insn->sec, insn->offset,
			  insn->type == INSN_JUMP_DYNAMIC ? "jump" : "call");

		warnings++;
	}

	return warnings;
}

2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934
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"));
}

2935
static bool ignore_unreachable_insn(struct objtool_file *file, struct instruction *insn)
2936 2937
{
	int i;
2938
	struct instruction *prev_insn;
2939

2940 2941 2942 2943 2944 2945
	if (insn->ignore || insn->type == INSN_NOP)
		return true;

	/*
	 * Ignore any unused exceptions.  This can happen when a whitelisted
	 * function has an exception table entry.
2946 2947 2948
	 *
	 * Also ignore alternative replacement instructions.  This can happen
	 * when a whitelisted function uses one of the ALTERNATIVE macros.
2949
	 */
2950 2951 2952
	if (!strcmp(insn->sec->name, ".fixup") ||
	    !strcmp(insn->sec->name, ".altinstr_replacement") ||
	    !strcmp(insn->sec->name, ".altinstr_aux"))
2953 2954
		return true;

2955 2956 2957 2958 2959 2960 2961 2962
	if (!insn->func)
		return false;

	/*
	 * 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).
2963 2964
	 *
	 * It may also insert a UD2 after calling a __noreturn function.
2965
	 */
2966 2967
	prev_insn = list_prev_entry(insn, list);
	if ((prev_insn->dead_end || dead_end_function(file, prev_insn->call_dest)) &&
2968 2969 2970 2971 2972
	    (insn->type == INSN_BUG ||
	     (insn->type == INSN_JUMP_UNCONDITIONAL &&
	      insn->jump_dest && insn->jump_dest->type == INSN_BUG)))
		return true;

2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983
	/*
	 * 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;

2984 2985 2986 2987 2988 2989 2990 2991
		if (insn->type == INSN_JUMP_UNCONDITIONAL) {
			if (insn->jump_dest &&
			    insn->jump_dest->func == insn->func) {
				insn = insn->jump_dest;
				continue;
			}

			break;
2992 2993
		}

2994
		if (insn->offset + insn->len >= insn->func->offset + insn->func->len)
2995
			break;
2996

2997 2998 2999 3000 3001 3002
		insn = list_next_entry(insn, list);
	}

	return false;
}

3003 3004
static int validate_symbol(struct objtool_file *file, struct section *sec,
			   struct symbol *sym, struct insn_state *state)
3005 3006
{
	struct instruction *insn;
3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030
	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)
{
3031
	struct insn_state state;
3032 3033
	struct symbol *func;
	int warnings = 0;
3034

3035 3036 3037
	list_for_each_entry(func, &sec->symbol_list, list) {
		if (func->type != STT_FUNC)
			continue;
3038

3039
		init_insn_state(&state, sec);
3040
		set_func_state(&state.cfi);
3041

3042
		warnings += validate_symbol(file, sec, func, &state);
3043 3044 3045 3046 3047
	}

	return warnings;
}

3048 3049 3050
static int validate_vmlinux_functions(struct objtool_file *file)
{
	struct section *sec;
3051
	int warnings = 0;
3052 3053

	sec = find_section_by_name(file->elf, ".noinstr.text");
3054 3055 3056 3057
	if (sec) {
		warnings += validate_section(file, sec);
		warnings += validate_unwind_hints(file, sec);
	}
3058

3059 3060 3061 3062 3063
	sec = find_section_by_name(file->elf, ".entry.text");
	if (sec) {
		warnings += validate_section(file, sec);
		warnings += validate_unwind_hints(file, sec);
	}
3064 3065

	return warnings;
3066 3067
}

3068 3069 3070 3071 3072
static int validate_functions(struct objtool_file *file)
{
	struct section *sec;
	int warnings = 0;

3073 3074 3075 3076
	for_each_sec(file, sec) {
		if (!(sec->sh.sh_flags & SHF_EXECINSTR))
			continue;

3077
		warnings += validate_section(file, sec);
3078
	}
3079 3080 3081 3082

	return warnings;
}

3083
static int validate_reachable_instructions(struct objtool_file *file)
3084 3085
{
	struct instruction *insn;
3086 3087 3088

	if (file->ignore_unreachables)
		return 0;
3089 3090

	for_each_insn(file, insn) {
3091
		if (insn->visited || ignore_unreachable_insn(file, insn))
3092 3093 3094 3095
			continue;

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

3098
	return 0;
3099 3100
}

3101
int check(struct objtool_file *file)
3102 3103 3104
{
	int ret, warnings = 0;

3105 3106
	arch_initial_func_cfi_state(&initial_func_cfi);

3107
	ret = decode_sections(file);
3108 3109 3110 3111
	if (ret < 0)
		goto out;
	warnings += ret;

3112
	if (list_empty(&file->insn_list))
3113 3114
		goto out;

3115
	if (vmlinux && !validate_dup) {
3116
		ret = validate_vmlinux_functions(file);
3117 3118 3119 3120 3121 3122 3123
		if (ret < 0)
			goto out;

		warnings += ret;
		goto out;
	}

3124
	if (retpoline) {
3125
		ret = validate_retpoline(file);
3126 3127 3128 3129 3130
		if (ret < 0)
			return ret;
		warnings += ret;
	}

3131
	ret = validate_functions(file);
3132 3133 3134 3135
	if (ret < 0)
		goto out;
	warnings += ret;

3136
	ret = validate_unwind_hints(file, NULL);
3137 3138 3139 3140
	if (ret < 0)
		goto out;
	warnings += ret;

3141
	if (!warnings) {
3142
		ret = validate_reachable_instructions(file);
3143 3144 3145 3146 3147
		if (ret < 0)
			goto out;
		warnings += ret;
	}

3148
	ret = create_static_call_sections(file);
3149 3150 3151 3152
	if (ret < 0)
		goto out;
	warnings += ret;

3153 3154 3155 3156 3157 3158 3159
	if (mcount) {
		ret = create_mcount_loc_sections(file);
		if (ret < 0)
			goto out;
		warnings += ret;
	}

3160
out:
3161 3162 3163 3164 3165
	/*
	 *  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.
	 */
3166 3167
	return 0;
}