check.c 70.9 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 164
	};

165 166 167
	if (!func)
		return false;

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

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

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

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

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

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

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

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

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

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

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

220
	return true;
221 222
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

327
	return 0;
328 329 330 331

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

334 335 336 337 338 339 340 341 342 343 344 345 346
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;
}

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

356 357 358 359 360 361 362 363 364 365 366
	/*
	 * 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.
	 */
367 368
	sec = find_section_by_name(file->elf, ".rela.discard.unreachable");
	if (!sec)
369
		goto reachable;
370

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

		insn->dead_end = true;
	}

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

		insn->dead_end = false;
	}

430 431 432
	return 0;
}

433 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
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));
474

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

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

488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
		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) {
			WARN("static_call: can't find static_call_key symbol: %s", tmp);
			return -1;
		}
		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 已提交
522
		reloc->addend = is_sibling_call(insn) ? STATIC_CALL_SITE_TAIL : 0;
523 524 525 526 527 528 529 530 531 532 533 534 535 536
		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;
}

537 538 539 540 541 542 543 544
/*
 * 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 已提交
545
	struct reloc *reloc;
546

P
Peter Zijlstra 已提交
547 548 549
	sec = find_section_by_name(file->elf, ".rela.discard.func_stack_frame_non_standard");
	if (!sec)
		return;
550

M
Matt Helsley 已提交
551 552
	list_for_each_entry(reloc, &sec->reloc_list, list) {
		switch (reloc->sym->type) {
P
Peter Zijlstra 已提交
553
		case STT_FUNC:
M
Matt Helsley 已提交
554
			func = reloc->sym;
P
Peter Zijlstra 已提交
555 556 557
			break;

		case STT_SECTION:
M
Matt Helsley 已提交
558
			func = find_func_by_offset(reloc->sym->sec, reloc->addend);
559
			if (!func)
560
				continue;
P
Peter Zijlstra 已提交
561
			break;
562

P
Peter Zijlstra 已提交
563
		default:
M
Matt Helsley 已提交
564
			WARN("unexpected relocation symbol type in %s: %d", sec->name, reloc->sym->type);
P
Peter Zijlstra 已提交
565
			continue;
566
		}
P
Peter Zijlstra 已提交
567

568
		func_for_each_insn(file, func, insn)
P
Peter Zijlstra 已提交
569
			insn->ignore = true;
570 571 572
	}
}

P
Peter Zijlstra 已提交
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596
/*
 * 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",
	"check_memory_region",
	/* 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",
597 598
	"__kasan_check_read",
	"__kasan_check_write",
P
Peter Zijlstra 已提交
599 600 601 602 603 604 605 606 607 608 609 610 611
	/* 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",
612
	/* KCSAN */
613
	"__kcsan_check_access",
614 615
	"kcsan_found_watchpoint",
	"kcsan_setup_watchpoint",
616
	"kcsan_check_scoped_accesses",
617 618
	"kcsan_disable_current",
	"kcsan_enable_current_nowarn",
619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
	/* 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",
634 635 636 637 638
	"__tsan_read_write1",
	"__tsan_read_write2",
	"__tsan_read_write4",
	"__tsan_read_write8",
	"__tsan_read_write16",
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688
	"__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 已提交
689 690
	/* KCOV */
	"write_comp_data",
691
	"check_kcov_mode",
P
Peter Zijlstra 已提交
692 693 694 695 696 697 698 699 700
	"__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",
701
	"__sanitizer_cov_trace_switch",
P
Peter Zijlstra 已提交
702 703 704 705
	/* UBSAN */
	"ubsan_type_mismatch_common",
	"__ubsan_handle_type_mismatch",
	"__ubsan_handle_type_mismatch_v1",
706
	"__ubsan_handle_shift_out_of_bounds",
P
Peter Zijlstra 已提交
707 708
	/* misc */
	"csum_partial_copy_generic",
709 710
	"copy_mc_fragile",
	"copy_mc_fragile_handle_tail",
711
	"copy_mc_enhanced_fast_string",
P
Peter Zijlstra 已提交
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728
	"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;

729
		func->uaccess_safe = true;
730 731 732
	}
}

733 734 735 736 737 738
/*
 * 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.
 */
739
static int add_ignore_alternatives(struct objtool_file *file)
740 741
{
	struct section *sec;
M
Matt Helsley 已提交
742
	struct reloc *reloc;
743 744
	struct instruction *insn;

745
	sec = find_section_by_name(file->elf, ".rela.discard.ignore_alts");
746 747 748
	if (!sec)
		return 0;

M
Matt Helsley 已提交
749 750
	list_for_each_entry(reloc, &sec->reloc_list, list) {
		if (reloc->sym->type != STT_SECTION) {
751 752 753 754
			WARN("unexpected relocation symbol type in %s", sec->name);
			return -1;
		}

M
Matt Helsley 已提交
755
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
756
		if (!insn) {
757
			WARN("bad .discard.ignore_alts entry");
758 759 760 761 762 763 764 765 766
			return -1;
		}

		insn->ignore_alts = true;
	}

	return 0;
}

767 768 769 770 771 772
/*
 * Find the destination instructions for all jumps.
 */
static int add_jump_destinations(struct objtool_file *file)
{
	struct instruction *insn;
M
Matt Helsley 已提交
773
	struct reloc *reloc;
774 775 776 777
	struct section *dest_sec;
	unsigned long dest_off;

	for_each_insn(file, insn) {
778
		if (!is_static_jump(insn))
779 780
			continue;

M
Matt Helsley 已提交
781
		reloc = find_reloc_by_dest_range(file->elf, insn->sec,
782
						 insn->offset, insn->len);
M
Matt Helsley 已提交
783
		if (!reloc) {
784
			dest_sec = insn->sec;
785
			dest_off = arch_jump_destination(insn);
M
Matt Helsley 已提交
786 787 788
		} else if (reloc->sym->type == STT_SECTION) {
			dest_sec = reloc->sym->sec;
			dest_off = arch_dest_reloc_offset(reloc->addend);
789 790
		} else if (!strncmp(reloc->sym->name, "__x86_indirect_thunk_", 21) ||
			   !strncmp(reloc->sym->name, "__x86_retpoline_", 16)) {
791 792 793 794
			/*
			 * Retpoline jumps are really dynamic jumps in
			 * disguise, so convert them accordingly.
			 */
795 796 797 798 799
			if (insn->type == INSN_JUMP_UNCONDITIONAL)
				insn->type = INSN_JUMP_DYNAMIC;
			else
				insn->type = INSN_JUMP_DYNAMIC_CONDITIONAL;

800
			insn->retpoline_safe = true;
801
			continue;
802 803
		} else if (insn->func) {
			/* internal or external sibling call (with reloc) */
M
Matt Helsley 已提交
804
			insn->call_dest = reloc->sym;
P
Peter Zijlstra 已提交
805 806 807 808
			if (insn->call_dest->static_call_tramp) {
				list_add_tail(&insn->static_call_node,
					      &file->static_call_list);
			}
809
			continue;
810 811 812 813 814 815 816
		} 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;
817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
		}

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

		/*
837
		 * Cross-function jump.
838 839
		 */
		if (insn->func && insn->jump_dest->func &&
840 841 842 843 844 845 846 847 848 849 850 851 852 853 854
		    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
855
			 * subfunction is through a jump table.
856
			 */
857 858
			if (!strstr(insn->func->name, ".cold") &&
			    strstr(insn->jump_dest->func->name, ".cold")) {
859 860 861 862 863 864
				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) {

865
				/* internal sibling call (without reloc) */
866
				insn->call_dest = insn->jump_dest->func;
P
Peter Zijlstra 已提交
867 868 869 870
				if (insn->call_dest->static_call_tramp) {
					list_add_tail(&insn->static_call_node,
						      &file->static_call_list);
				}
871
			}
872
		}
873 874 875 876 877
	}

	return 0;
}

878 879 880 881 882 883 884 885 886 887
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);
	}
}

888 889 890 891 892 893 894 895 896 897 898
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;
}

899 900 901 902 903 904 905
/*
 * 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 已提交
906
	struct reloc *reloc;
907 908 909 910 911

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

M
Matt Helsley 已提交
912
		reloc = find_reloc_by_dest_range(file->elf, insn->sec,
913
					       insn->offset, insn->len);
M
Matt Helsley 已提交
914
		if (!reloc) {
915
			dest_off = arch_jump_destination(insn);
916
			insn->call_dest = find_call_destination(insn->sec, dest_off);
917

918 919 920 921
			if (insn->ignore)
				continue;

			if (!insn->call_dest) {
922
				WARN_FUNC("unannotated intra-function call", insn->sec, insn->offset);
923 924
				return -1;
			}
925

926 927 928 929 930 931
			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 已提交
932 933
		} else if (reloc->sym->type == STT_SECTION) {
			dest_off = arch_dest_reloc_offset(reloc->addend);
934 935
			insn->call_dest = find_call_destination(reloc->sym->sec,
								dest_off);
936
			if (!insn->call_dest) {
937
				WARN_FUNC("can't find call dest symbol at %s+0x%lx",
938
					  insn->sec, insn->offset,
M
Matt Helsley 已提交
939
					  reloc->sym->sec->name,
940
					  dest_off);
941 942 943
				return -1;
			}
		} else
M
Matt Helsley 已提交
944
			insn->call_dest = reloc->sym;
945

P
Peter Zijlstra 已提交
946 947 948 949 950 951 952
		/*
		 * 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)) {
953 954 955
			if (reloc) {
				reloc->type = R_NONE;
				elf_write_reloc(file->elf, reloc);
P
Peter Zijlstra 已提交
956 957 958 959 960 961 962 963
			}

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

964 965 966 967 968 969 970 971
		/*
		 * 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);
972 973 974 975 976 977
	}

	return 0;
}

/*
978 979
 * The .alternatives section requires some extra special care over and above
 * other special sections because alternatives are patched in place.
980 981 982 983 984 985
 */
static int handle_group_alt(struct objtool_file *file,
			    struct special_alt *special_alt,
			    struct instruction *orig_insn,
			    struct instruction **new_insn)
{
986
	struct instruction *last_orig_insn, *last_new_insn = NULL, *insn, *nop = NULL;
J
Josh Poimboeuf 已提交
987
	struct alt_group *orig_alt_group, *new_alt_group;
988 989
	unsigned long dest_off;

J
Josh Poimboeuf 已提交
990 991 992 993 994 995

	orig_alt_group = malloc(sizeof(*orig_alt_group));
	if (!orig_alt_group) {
		WARN("malloc failed");
		return -1;
	}
996 997 998 999 1000 1001 1002
	orig_alt_group->cfi = calloc(special_alt->orig_len,
				     sizeof(struct cfi_state *));
	if (!orig_alt_group->cfi) {
		WARN("calloc failed");
		return -1;
	}

1003 1004 1005 1006 1007 1008
	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 已提交
1009
		insn->alt_group = orig_alt_group;
1010 1011
		last_orig_insn = insn;
	}
J
Josh Poimboeuf 已提交
1012 1013 1014
	orig_alt_group->orig_group = NULL;
	orig_alt_group->first_insn = orig_insn;
	orig_alt_group->last_insn = last_orig_insn;
1015

1016

1017 1018 1019 1020
	new_alt_group = malloc(sizeof(*new_alt_group));
	if (!new_alt_group) {
		WARN("malloc failed");
		return -1;
1021 1022
	}

1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
	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");
1034 1035
			return -1;
		}
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
		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;
1048 1049
	}

1050 1051 1052
	if (!special_alt->new_len) {
		*new_insn = nop;
		goto end;
J
Josh Poimboeuf 已提交
1053 1054
	}

1055 1056
	insn = *new_insn;
	sec_for_each_insn_from(file, insn) {
1057 1058
		struct reloc *alt_reloc;

1059 1060 1061 1062 1063
		if (insn->offset >= special_alt->new_off + special_alt->new_len)
			break;

		last_new_insn = insn;

1064
		insn->ignore = orig_insn->ignore_alts;
1065
		insn->func = orig_insn->func;
J
Josh Poimboeuf 已提交
1066
		insn->alt_group = new_alt_group;
1067

1068 1069 1070 1071 1072 1073 1074 1075
		/*
		 * 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.
		 */
1076 1077 1078 1079
		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)) {
1080 1081 1082 1083 1084 1085

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

1086
		if (!is_static_jump(insn))
1087 1088 1089 1090 1091
			continue;

		if (!insn->immediate)
			continue;

1092
		dest_off = arch_jump_destination(insn);
1093 1094
		if (dest_off == special_alt->new_off + special_alt->new_len)
			insn->jump_dest = next_insn_same_sec(file, last_orig_insn);
1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108

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

1109 1110 1111
	if (nop)
		list_add(&nop->list, &last_new_insn->list);
end:
J
Josh Poimboeuf 已提交
1112 1113
	new_alt_group->orig_group = orig_alt_group;
	new_alt_group->first_insn = *new_insn;
1114 1115
	new_alt_group->last_insn = nop ? : last_new_insn;
	new_alt_group->cfi = orig_alt_group->cfi;
1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184
	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) {
1185 1186 1187 1188 1189 1190
			if (!special_alt->orig_len) {
				WARN_FUNC("empty alternative entry",
					  orig_insn->sec, orig_insn->offset);
				continue;
			}

1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201
			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;
		}

1202 1203 1204 1205 1206 1207 1208
		alt = malloc(sizeof(*alt));
		if (!alt) {
			WARN("malloc failed");
			ret = -1;
			goto out;
		}

1209
		alt->insn = new_insn;
P
Peter Zijlstra 已提交
1210
		alt->skip_orig = special_alt->skip_orig;
P
Peter Zijlstra 已提交
1211
		orig_insn->ignore_alts |= special_alt->skip_alt;
1212 1213 1214 1215 1216 1217 1218 1219 1220 1221
		list_add_tail(&alt->list, &orig_insn->alts);

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

out:
	return ret;
}

1222
static int add_jump_table(struct objtool_file *file, struct instruction *insn,
M
Matt Helsley 已提交
1223
			    struct reloc *table)
1224
{
M
Matt Helsley 已提交
1225
	struct reloc *reloc = table;
1226
	struct instruction *dest_insn;
1227
	struct alternative *alt;
1228 1229
	struct symbol *pfunc = insn->func->pfunc;
	unsigned int prev_offset = 0;
1230

1231
	/*
M
Matt Helsley 已提交
1232
	 * Each @reloc is a switch table relocation which points to the target
1233 1234
	 * instruction.
	 */
M
Matt Helsley 已提交
1235
	list_for_each_entry_from(reloc, &table->sec->reloc_list, list) {
1236 1237

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

1241
		/* Make sure the table entries are consecutive: */
M
Matt Helsley 已提交
1242
		if (prev_offset && reloc->offset != prev_offset + 8)
1243 1244 1245
			break;

		/* Detect function pointers from contiguous objects: */
M
Matt Helsley 已提交
1246 1247
		if (reloc->sym->sec == pfunc->sec &&
		    reloc->addend == pfunc->offset)
1248 1249
			break;

M
Matt Helsley 已提交
1250
		dest_insn = find_insn(file, reloc->sym->sec, reloc->addend);
1251
		if (!dest_insn)
1252 1253
			break;

1254
		/* Make sure the destination is in the same function: */
1255
		if (!dest_insn->func || dest_insn->func->pfunc != pfunc)
1256
			break;
1257 1258 1259 1260 1261 1262 1263

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

1264
		alt->insn = dest_insn;
1265
		list_add_tail(&alt->list, &insn->alts);
M
Matt Helsley 已提交
1266
		prev_offset = reloc->offset;
1267 1268 1269 1270 1271 1272
	}

	if (!prev_offset) {
		WARN_FUNC("can't find switch jump table",
			  insn->sec, insn->offset);
		return -1;
1273 1274 1275 1276 1277 1278
	}

	return 0;
}

/*
1279 1280
 * find_jump_table() - Given a dynamic jump, find the switch jump table
 * associated with it.
1281
 */
M
Matt Helsley 已提交
1282
static struct reloc *find_jump_table(struct objtool_file *file,
1283 1284 1285
				      struct symbol *func,
				      struct instruction *insn)
{
1286
	struct reloc *table_reloc;
1287
	struct instruction *dest_insn, *orig_insn = insn;
1288

1289 1290 1291 1292 1293
	/*
	 * Backward search using the @first_jump_src links, these help avoid
	 * much of the 'in between' code. Which avoids us getting confused by
	 * it.
	 */
1294
	for (;
1295 1296
	     insn && insn->func && insn->func->pfunc == func;
	     insn = insn->first_jump_src ?: prev_insn_same_sym(file, insn)) {
1297

1298
		if (insn != orig_insn && insn->type == INSN_JUMP_DYNAMIC)
1299 1300 1301 1302 1303 1304 1305 1306 1307
			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;

1308
		table_reloc = arch_find_switch_table(file, insn);
M
Matt Helsley 已提交
1309
		if (!table_reloc)
1310
			continue;
M
Matt Helsley 已提交
1311
		dest_insn = find_insn(file, table_reloc->sym->sec, table_reloc->addend);
1312 1313
		if (!dest_insn || !dest_insn->func || dest_insn->func->pfunc != func)
			continue;
1314

M
Matt Helsley 已提交
1315
		return table_reloc;
1316 1317 1318 1319 1320
	}

	return NULL;
}

1321 1322 1323 1324 1325 1326
/*
 * 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)
1327
{
1328
	struct instruction *insn, *last = NULL;
M
Matt Helsley 已提交
1329
	struct reloc *reloc;
1330

1331
	func_for_each_insn(file, func, insn) {
1332 1333 1334 1335 1336
		if (!last)
			last = insn;

		/*
		 * Store back-pointers for unconditional forward jumps such
1337
		 * that find_jump_table() can back-track using those and
1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348
		 * 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;
		}

1349 1350 1351
		if (insn->type != INSN_JUMP_DYNAMIC)
			continue;

M
Matt Helsley 已提交
1352 1353 1354 1355
		reloc = find_jump_table(file, func, insn);
		if (reloc) {
			reloc->jump_table_start = true;
			insn->jump_table = reloc;
1356 1357
		}
	}
1358 1359 1360 1361 1362 1363 1364 1365
}

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

1366
	func_for_each_insn(file, func, insn) {
1367 1368
		if (!insn->jump_table)
			continue;
1369

1370
		ret = add_jump_table(file, insn, insn->jump_table);
1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382
		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.
 */
1383
static int add_jump_table_alts(struct objtool_file *file)
1384 1385 1386 1387 1388
{
	struct section *sec;
	struct symbol *func;
	int ret;

1389
	if (!file->rodata)
1390 1391
		return 0;

1392
	for_each_sec(file, sec) {
1393 1394 1395 1396
		list_for_each_entry(func, &sec->symbol_list, list) {
			if (func->type != STT_FUNC)
				continue;

1397
			mark_func_jump_tables(file, func);
1398
			ret = add_func_jump_tables(file, func);
1399 1400 1401 1402 1403 1404 1405 1406
			if (ret)
				return ret;
		}
	}

	return 0;
}

1407 1408
static int read_unwind_hints(struct objtool_file *file)
{
M
Matt Helsley 已提交
1409 1410
	struct section *sec, *relocsec;
	struct reloc *reloc;
1411 1412 1413 1414 1415 1416 1417 1418 1419
	struct unwind_hint *hint;
	struct instruction *insn;
	struct cfi_reg *cfa;
	int i;

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

M
Matt Helsley 已提交
1420 1421
	relocsec = sec->reloc;
	if (!relocsec) {
1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435
		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 已提交
1436 1437 1438
		reloc = find_reloc_by_dest(file->elf, sec, i * sizeof(*hint));
		if (!reloc) {
			WARN("can't find reloc for unwind_hints[%d]", i);
1439 1440 1441
			return -1;
		}

M
Matt Helsley 已提交
1442
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
1443 1444 1445 1446 1447
		if (!insn) {
			WARN("can't find insn for unwind_hints[%d]", i);
			return -1;
		}

1448
		cfa = &insn->cfi.cfa;
1449

1450
		if (hint->type == UNWIND_HINT_TYPE_RET_OFFSET) {
1451
			insn->ret_offset = bswap_if_needed(hint->sp_offset);
1452 1453 1454 1455 1456
			continue;
		}

		insn->hint = true;

1457
		if (arch_decode_hint_reg(insn, hint->sp_reg)) {
1458 1459 1460 1461 1462
			WARN_FUNC("unsupported unwind_hint sp base reg %d",
				  insn->sec, insn->offset, hint->sp_reg);
			return -1;
		}

1463
		cfa->offset = bswap_if_needed(hint->sp_offset);
1464 1465
		insn->cfi.type = hint->type;
		insn->cfi.end = hint->end;
1466 1467 1468 1469 1470
	}

	return 0;
}

1471 1472
static int read_retpoline_hints(struct objtool_file *file)
{
J
Josh Poimboeuf 已提交
1473
	struct section *sec;
1474
	struct instruction *insn;
M
Matt Helsley 已提交
1475
	struct reloc *reloc;
1476

J
Josh Poimboeuf 已提交
1477
	sec = find_section_by_name(file->elf, ".rela.discard.retpoline_safe");
1478 1479 1480
	if (!sec)
		return 0;

M
Matt Helsley 已提交
1481 1482
	list_for_each_entry(reloc, &sec->reloc_list, list) {
		if (reloc->sym->type != STT_SECTION) {
J
Josh Poimboeuf 已提交
1483
			WARN("unexpected relocation symbol type in %s", sec->name);
1484 1485 1486
			return -1;
		}

M
Matt Helsley 已提交
1487
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
1488
		if (!insn) {
J
Josh Poimboeuf 已提交
1489
			WARN("bad .discard.retpoline_safe entry");
1490 1491 1492 1493 1494
			return -1;
		}

		if (insn->type != INSN_JUMP_DYNAMIC &&
		    insn->type != INSN_CALL_DYNAMIC) {
J
Josh Poimboeuf 已提交
1495
			WARN_FUNC("retpoline_safe hint not an indirect jump/call",
1496 1497 1498 1499 1500 1501 1502 1503 1504 1505
				  insn->sec, insn->offset);
			return -1;
		}

		insn->retpoline_safe = true;
	}

	return 0;
}

1506 1507 1508 1509
static int read_instr_hints(struct objtool_file *file)
{
	struct section *sec;
	struct instruction *insn;
M
Matt Helsley 已提交
1510
	struct reloc *reloc;
1511 1512 1513 1514 1515

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

M
Matt Helsley 已提交
1516 1517
	list_for_each_entry(reloc, &sec->reloc_list, list) {
		if (reloc->sym->type != STT_SECTION) {
1518 1519 1520 1521
			WARN("unexpected relocation symbol type in %s", sec->name);
			return -1;
		}

M
Matt Helsley 已提交
1522
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534
		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 已提交
1535 1536
	list_for_each_entry(reloc, &sec->reloc_list, list) {
		if (reloc->sym->type != STT_SECTION) {
1537 1538 1539 1540
			WARN("unexpected relocation symbol type in %s", sec->name);
			return -1;
		}

M
Matt Helsley 已提交
1541
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552
		if (!insn) {
			WARN("bad .discard.instr_begin entry");
			return -1;
		}

		insn->instr++;
	}

	return 0;
}

1553 1554 1555 1556
static int read_intra_function_calls(struct objtool_file *file)
{
	struct instruction *insn;
	struct section *sec;
M
Matt Helsley 已提交
1557
	struct reloc *reloc;
1558 1559 1560 1561 1562

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

M
Matt Helsley 已提交
1563
	list_for_each_entry(reloc, &sec->reloc_list, list) {
1564 1565
		unsigned long dest_off;

M
Matt Helsley 已提交
1566
		if (reloc->sym->type != STT_SECTION) {
1567 1568 1569 1570 1571
			WARN("unexpected relocation symbol type in %s",
			     sec->name);
			return -1;
		}

M
Matt Helsley 已提交
1572
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603
		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;
}

1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620
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;
}

1621 1622 1623 1624 1625 1626
static void mark_rodata(struct objtool_file *file)
{
	struct section *sec;
	bool found = false;

	/*
1627 1628 1629 1630 1631 1632 1633 1634
	 * 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.
1635 1636
	 */
	for_each_sec(file, sec) {
1637 1638
		if (!strncmp(sec->name, ".rodata", 7) &&
		    !strstr(sec->name, ".str1.")) {
1639 1640 1641 1642 1643 1644 1645 1646
			sec->rodata = true;
			found = true;
		}
	}

	file->rodata = found;
}

1647 1648 1649 1650
static int decode_sections(struct objtool_file *file)
{
	int ret;

1651 1652
	mark_rodata(file);

1653 1654 1655 1656 1657 1658 1659 1660 1661
	ret = decode_instructions(file);
	if (ret)
		return ret;

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

	add_ignores(file);
P
Peter Zijlstra 已提交
1662
	add_uaccess_safe(file);
1663

1664
	ret = add_ignore_alternatives(file);
1665 1666 1667
	if (ret)
		return ret;

P
Peter Zijlstra 已提交
1668 1669 1670 1671
	ret = read_static_call_tramps(file);
	if (ret)
		return ret;

1672 1673 1674 1675
	ret = add_jump_destinations(file);
	if (ret)
		return ret;

1676
	ret = add_special_section_alts(file);
1677 1678 1679
	if (ret)
		return ret;

1680 1681 1682 1683
	ret = read_intra_function_calls(file);
	if (ret)
		return ret;

1684
	ret = add_call_destinations(file);
1685 1686 1687
	if (ret)
		return ret;

1688
	ret = add_jump_table_alts(file);
1689 1690 1691
	if (ret)
		return ret;

1692 1693 1694 1695
	ret = read_unwind_hints(file);
	if (ret)
		return ret;

1696 1697 1698 1699
	ret = read_retpoline_hints(file);
	if (ret)
		return ret;

1700 1701 1702 1703
	ret = read_instr_hints(file);
	if (ret)
		return ret;

1704 1705 1706 1707 1708
	return 0;
}

static bool is_fentry_call(struct instruction *insn)
{
1709
	if (insn->type == INSN_CALL && insn->call_dest &&
1710 1711 1712 1713 1714 1715 1716
	    insn->call_dest->type == STT_NOTYPE &&
	    !strcmp(insn->call_dest->name, "__fentry__"))
		return true;

	return false;
}

1717
static bool has_modified_stack_frame(struct instruction *insn, struct insn_state *state)
1718
{
1719
	u8 ret_offset = insn->ret_offset;
1720
	struct cfi_state *cfi = &state->cfi;
1721 1722
	int i;

1723
	if (cfi->cfa.base != initial_func_cfi.cfa.base || cfi->drap)
1724 1725
		return true;

1726
	if (cfi->cfa.offset != initial_func_cfi.cfa.offset + ret_offset)
1727 1728
		return true;

1729
	if (cfi->stack_size != initial_func_cfi.cfa.offset + ret_offset)
1730 1731
		return true;

1732 1733 1734 1735 1736 1737 1738 1739
	/*
	 * If there is a ret offset hint then don't check registers
	 * because a callee-saved register might have been pushed on
	 * the stack.
	 */
	if (ret_offset)
		return false;

1740
	for (i = 0; i < CFI_NUM_REGS; i++) {
1741 1742
		if (cfi->regs[i].base != initial_func_cfi.regs[i].base ||
		    cfi->regs[i].offset != initial_func_cfi.regs[i].offset)
1743
			return true;
1744
	}
1745 1746 1747 1748

	return false;
}

1749 1750 1751 1752 1753 1754 1755
static bool check_reg_frame_pos(const struct cfi_reg *reg,
				int expected_offset)
{
	return reg->base == CFI_CFA &&
	       reg->offset == expected_offset;
}

1756 1757
static bool has_valid_stack_frame(struct insn_state *state)
{
1758 1759
	struct cfi_state *cfi = &state->cfi;

1760 1761 1762
	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))
1763 1764
		return true;

1765
	if (cfi->drap && cfi->regs[CFI_BP].base == CFI_BP)
1766 1767 1768
		return true;

	return false;
1769 1770
}

1771 1772
static int update_cfi_state_regs(struct instruction *insn,
				  struct cfi_state *cfi,
1773
				  struct stack_op *op)
1774
{
1775
	struct cfi_reg *cfa = &cfi->cfa;
1776

1777
	if (cfa->base != CFI_SP && cfa->base != CFI_SP_INDIRECT)
1778 1779 1780
		return 0;

	/* push */
P
Peter Zijlstra 已提交
1781
	if (op->dest.type == OP_DEST_PUSH || op->dest.type == OP_DEST_PUSHF)
1782 1783 1784
		cfa->offset += 8;

	/* pop */
P
Peter Zijlstra 已提交
1785
	if (op->src.type == OP_SRC_POP || op->src.type == OP_SRC_POPF)
1786 1787 1788 1789 1790 1791 1792 1793 1794 1795
		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;
}

1796
static void save_reg(struct cfi_state *cfi, unsigned char reg, int base, int offset)
1797
{
1798
	if (arch_callee_saved_reg(reg) &&
1799 1800 1801
	    cfi->regs[reg].base == CFI_UNDEFINED) {
		cfi->regs[reg].base = base;
		cfi->regs[reg].offset = offset;
1802
	}
1803 1804
}

1805
static void restore_reg(struct cfi_state *cfi, unsigned char reg)
1806
{
1807 1808
	cfi->regs[reg].base = initial_func_cfi.regs[reg].base;
	cfi->regs[reg].offset = initial_func_cfi.regs[reg].offset;
1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863
}

/*
 * 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
 */
1864
static int update_cfi_state(struct instruction *insn, struct cfi_state *cfi,
1865
			     struct stack_op *op)
1866
{
1867 1868
	struct cfi_reg *cfa = &cfi->cfa;
	struct cfi_reg *regs = cfi->regs;
1869 1870 1871 1872 1873 1874 1875 1876 1877 1878

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

1879 1880
	if (cfi->type == UNWIND_HINT_TYPE_REGS ||
	    cfi->type == UNWIND_HINT_TYPE_REGS_PARTIAL)
1881
		return update_cfi_state_regs(insn, cfi, op);
1882

1883 1884 1885 1886 1887 1888
	switch (op->dest.type) {

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

		case OP_SRC_REG:
1889 1890
			if (op->src.reg == CFI_SP && op->dest.reg == CFI_BP &&
			    cfa->base == CFI_SP &&
1891
			    check_reg_frame_pos(&regs[CFI_BP], -cfa->offset)) {
1892 1893 1894

				/* mov %rsp, %rbp */
				cfa->base = op->dest.reg;
1895
				cfi->bp_scratch = false;
1896
			}
1897

1898
			else if (op->src.reg == CFI_SP &&
1899
				 op->dest.reg == CFI_BP && cfi->drap) {
1900

1901 1902
				/* drap: mov %rsp, %rbp */
				regs[CFI_BP].base = CFI_BP;
1903 1904
				regs[CFI_BP].offset = -cfi->stack_size;
				cfi->bp_scratch = false;
1905
			}
1906

1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918
			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
				 */
1919 1920
				cfi->vals[op->dest.reg].base = CFI_CFA;
				cfi->vals[op->dest.reg].offset = -cfi->stack_size;
1921 1922
			}

J
Josh Poimboeuf 已提交
1923 1924 1925 1926 1927 1928 1929 1930
			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).
				 */
1931
				cfi->stack_size = -cfi->regs[CFI_BP].offset;
J
Josh Poimboeuf 已提交
1932 1933
			}

1934 1935 1936 1937
			else if (op->dest.reg == cfa->base) {

				/* mov %reg, %rsp */
				if (cfa->base == CFI_SP &&
1938
				    cfi->vals[op->src.reg].base == CFI_CFA) {
1939 1940 1941 1942 1943 1944 1945 1946 1947

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

				} else {
					cfa->base = CFI_UNDEFINED;
					cfa->offset = 0;
				}
1955 1956 1957 1958 1959 1960 1961 1962
			}

			break;

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

				/* add imm, %rsp */
1963
				cfi->stack_size -= op->src.offset;
1964 1965 1966 1967 1968 1969 1970 1971
				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 */
1972
				cfi->stack_size = -(op->src.offset + regs[CFI_BP].offset);
1973 1974 1975
				break;
			}

1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986
			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;
			}

1987
			if (op->src.reg == CFI_SP && cfa->base == CFI_SP) {
1988 1989

				/* drap: lea disp(%rsp), %drap */
1990
				cfi->drap_reg = op->dest.reg;
1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001

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

2006 2007 2008
				break;
			}

2009 2010
			if (cfi->drap && op->dest.reg == CFI_SP &&
			    op->src.reg == cfi->drap_reg) {
2011 2012 2013

				 /* drap: lea disp(%drap), %rsp */
				cfa->base = CFI_SP;
2014 2015 2016
				cfa->offset = cfi->stack_size = -op->src.offset;
				cfi->drap_reg = CFI_UNDEFINED;
				cfi->drap = false;
2017 2018 2019
				break;
			}

2020
			if (op->dest.reg == cfi->cfa.base) {
2021 2022 2023 2024 2025 2026 2027 2028 2029
				WARN_FUNC("unsupported stack register modification",
					  insn->sec, insn->offset);
				return -1;
			}

			break;

		case OP_SRC_AND:
			if (op->dest.reg != CFI_SP ||
2030 2031
			    (cfi->drap_reg != CFI_UNDEFINED && cfa->base != CFI_SP) ||
			    (cfi->drap_reg == CFI_UNDEFINED && cfa->base != CFI_BP)) {
2032 2033 2034 2035 2036
				WARN_FUNC("unsupported stack pointer realignment",
					  insn->sec, insn->offset);
				return -1;
			}

2037
			if (cfi->drap_reg != CFI_UNDEFINED) {
2038
				/* drap: and imm, %rsp */
2039 2040 2041
				cfa->base = cfi->drap_reg;
				cfa->offset = cfi->stack_size = 0;
				cfi->drap = true;
2042 2043 2044 2045 2046 2047 2048 2049 2050 2051
			}

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

			break;

		case OP_SRC_POP:
P
Peter Zijlstra 已提交
2052
		case OP_SRC_POPF:
2053
			if (!cfi->drap && op->dest.reg == cfa->base) {
2054 2055 2056 2057 2058

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

2059 2060 2061
			if (cfi->drap && cfa->base == CFI_BP_INDIRECT &&
			    op->dest.reg == cfi->drap_reg &&
			    cfi->drap_offset == -cfi->stack_size) {
2062

2063
				/* drap: pop %drap */
2064
				cfa->base = cfi->drap_reg;
2065
				cfa->offset = 0;
2066
				cfi->drap_offset = -1;
2067

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

2070
				/* pop %reg */
2071
				restore_reg(cfi, op->dest.reg);
2072 2073
			}

2074
			cfi->stack_size -= 8;
2075 2076 2077 2078 2079 2080
			if (cfa->base == CFI_SP)
				cfa->offset -= 8;

			break;

		case OP_SRC_REG_INDIRECT:
2081 2082 2083 2084 2085 2086 2087 2088
			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;
			}

2089 2090
			if (cfi->drap && op->src.reg == CFI_BP &&
			    op->src.offset == cfi->drap_offset) {
2091 2092

				/* drap: mov disp(%rbp), %drap */
2093
				cfa->base = cfi->drap_reg;
2094
				cfa->offset = 0;
2095
				cfi->drap_offset = -1;
2096 2097
			}

2098
			if (cfi->drap && op->src.reg == CFI_BP &&
2099 2100 2101
			    op->src.offset == regs[op->dest.reg].offset) {

				/* drap: mov disp(%rbp), %reg */
2102
				restore_reg(cfi, op->dest.reg);
2103 2104 2105 2106 2107 2108

			} 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 */
2109
				restore_reg(cfi, op->dest.reg);
2110 2111 2112 2113 2114 2115

			} 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);
2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128
			}

			break;

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

		break;

	case OP_DEST_PUSH:
P
Peter Zijlstra 已提交
2129
	case OP_DEST_PUSHF:
2130
		cfi->stack_size += 8;
2131 2132 2133 2134 2135 2136
		if (cfa->base == CFI_SP)
			cfa->offset += 8;

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

2137 2138
		if (cfi->drap) {
			if (op->src.reg == cfa->base && op->src.reg == cfi->drap_reg) {
2139 2140 2141

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

2144
				/* save drap so we know when to restore it */
2145
				cfi->drap_offset = -cfi->stack_size;
2146

2147
			} else if (op->src.reg == CFI_BP && cfa->base == cfi->drap_reg) {
2148 2149

				/* drap: push %rbp */
2150
				cfi->stack_size = 0;
2151

2152
			} else {
2153 2154

				/* drap: push %reg */
2155
				save_reg(cfi, op->src.reg, CFI_BP, -cfi->stack_size);
2156 2157 2158 2159 2160
			}

		} else {

			/* push %reg */
2161
			save_reg(cfi, op->src.reg, CFI_CFA, -cfi->stack_size);
2162 2163 2164
		}

		/* detect when asm code uses rbp as a scratch register */
2165
		if (!no_fp && insn->func && op->src.reg == CFI_BP &&
2166
		    cfa->base != CFI_BP)
2167
			cfi->bp_scratch = true;
2168 2169 2170 2171
		break;

	case OP_DEST_REG_INDIRECT:

2172 2173
		if (cfi->drap) {
			if (op->src.reg == cfa->base && op->src.reg == cfi->drap_reg) {
2174 2175 2176 2177 2178

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

2179
				/* save drap offset so we know when to restore it */
2180
				cfi->drap_offset = op->dest.offset;
2181
			} else {
2182 2183

				/* drap: mov reg, disp(%rbp) */
2184
				save_reg(cfi, op->src.reg, CFI_BP, op->dest.offset);
2185 2186 2187 2188 2189 2190
			}

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

			/* mov reg, disp(%rbp) */
			/* mov reg, disp(%rsp) */
2191 2192
			save_reg(cfi, op->src.reg, CFI_CFA,
				 op->dest.offset - cfi->cfa.offset);
2193 2194 2195 2196 2197 2198

		} 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);
2199 2200 2201 2202 2203
		}

		break;

	case OP_DEST_LEAVE:
2204 2205
		if ((!cfi->drap && cfa->base != CFI_BP) ||
		    (cfi->drap && cfa->base != cfi->drap_reg)) {
2206 2207 2208 2209 2210 2211 2212
			WARN_FUNC("leave instruction with modified stack frame",
				  insn->sec, insn->offset);
			return -1;
		}

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

2213 2214
		cfi->stack_size = -cfi->regs[CFI_BP].offset - 8;
		restore_reg(cfi, CFI_BP);
2215

2216
		if (!cfi->drap) {
2217 2218 2219 2220 2221 2222 2223
			cfa->base = CFI_SP;
			cfa->offset -= 8;
		}

		break;

	case OP_DEST_MEM:
P
Peter Zijlstra 已提交
2224
		if (op->src.type != OP_SRC_POP && op->src.type != OP_SRC_POPF) {
2225 2226 2227 2228 2229 2230
			WARN_FUNC("unknown stack-related memory operation",
				  insn->sec, insn->offset);
			return -1;
		}

		/* pop mem */
2231
		cfi->stack_size -= 8;
2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245
		if (cfa->base == CFI_SP)
			cfa->offset -= 8;

		break;

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

	return 0;
}

2246 2247 2248 2249 2250 2251 2252 2253 2254 2255
/*
 * 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)
2256
{
2257 2258
	struct cfi_state **alt_cfi;
	int group_off;
2259

2260 2261
	if (!insn->alt_group)
		return 0;
2262

2263 2264
	alt_cfi = insn->alt_group->cfi;
	group_off = insn->offset - insn->alt_group->first_insn->offset;
2265

2266 2267 2268 2269 2270 2271
	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);
2272 2273
			return -1;
		}
2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286
	}

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

2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312
		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;
}

2313
static bool insn_cfi_match(struct instruction *insn, struct cfi_state *cfi2)
2314
{
2315
	struct cfi_state *cfi1 = &insn->cfi;
2316 2317
	int i;

2318 2319
	if (memcmp(&cfi1->cfa, &cfi2->cfa, sizeof(cfi1->cfa))) {

2320 2321
		WARN_FUNC("stack state mismatch: cfa1=%d%+d cfa2=%d%+d",
			  insn->sec, insn->offset,
2322 2323
			  cfi1->cfa.base, cfi1->cfa.offset,
			  cfi2->cfa.base, cfi2->cfa.offset);
2324

2325
	} else if (memcmp(&cfi1->regs, &cfi2->regs, sizeof(cfi1->regs))) {
2326
		for (i = 0; i < CFI_NUM_REGS; i++) {
2327
			if (!memcmp(&cfi1->regs[i], &cfi2->regs[i],
2328 2329 2330 2331 2332
				    sizeof(struct cfi_reg)))
				continue;

			WARN_FUNC("stack state mismatch: reg1[%d]=%d%+d reg2[%d]=%d%+d",
				  insn->sec, insn->offset,
2333 2334
				  i, cfi1->regs[i].base, cfi1->regs[i].offset,
				  i, cfi2->regs[i].base, cfi2->regs[i].offset);
2335 2336 2337
			break;
		}

2338 2339
	} else if (cfi1->type != cfi2->type) {

2340
		WARN_FUNC("stack state mismatch: type1=%d type2=%d",
2341 2342 2343 2344 2345
			  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)) {
2346

2347
		WARN_FUNC("stack state mismatch: drap1=%d(%d,%d) drap2=%d(%d,%d)",
2348
			  insn->sec, insn->offset,
2349 2350
			  cfi1->drap, cfi1->drap_reg, cfi1->drap_offset,
			  cfi2->drap, cfi2->drap_reg, cfi2->drap_offset);
2351 2352 2353 2354 2355

	} else
		return true;

	return false;
2356 2357
}

P
Peter Zijlstra 已提交
2358 2359 2360
static inline bool func_uaccess_safe(struct symbol *func)
{
	if (func)
2361
		return func->uaccess_safe;
P
Peter Zijlstra 已提交
2362 2363 2364 2365

	return false;
}

2366
static inline const char *call_dest_name(struct instruction *insn)
P
Peter Zijlstra 已提交
2367 2368 2369 2370 2371 2372 2373
{
	if (insn->call_dest)
		return insn->call_dest->name;

	return "{dynamic}";
}

2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399
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 已提交
2400 2401
static int validate_call(struct instruction *insn, struct insn_state *state)
{
2402
	if (state->noinstr && state->instr <= 0 &&
2403
	    !noinstr_call_dest(insn->call_dest)) {
2404 2405 2406 2407 2408
		WARN_FUNC("call to %s() leaves .noinstr.text section",
				insn->sec, insn->offset, call_dest_name(insn));
		return 1;
	}

P
Peter Zijlstra 已提交
2409 2410
	if (state->uaccess && !func_uaccess_safe(insn->call_dest)) {
		WARN_FUNC("call to %s() with UACCESS enabled",
2411
				insn->sec, insn->offset, call_dest_name(insn));
P
Peter Zijlstra 已提交
2412 2413 2414
		return 1;
	}

2415 2416
	if (state->df) {
		WARN_FUNC("call to %s() with DF set",
2417
				insn->sec, insn->offset, call_dest_name(insn));
2418 2419 2420
		return 1;
	}

P
Peter Zijlstra 已提交
2421 2422 2423
	return 0;
}

2424 2425
static int validate_sibling_call(struct instruction *insn, struct insn_state *state)
{
2426
	if (has_modified_stack_frame(insn, state)) {
2427 2428 2429 2430 2431
		WARN_FUNC("sibling call from callable instruction with modified stack frame",
				insn->sec, insn->offset);
		return 1;
	}

P
Peter Zijlstra 已提交
2432
	return validate_call(insn, state);
2433 2434
}

2435 2436
static int validate_return(struct symbol *func, struct instruction *insn, struct insn_state *state)
{
2437 2438 2439 2440 2441 2442
	if (state->noinstr && state->instr > 0) {
		WARN_FUNC("return with instrumentation enabled",
			  insn->sec, insn->offset);
		return 1;
	}

2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460
	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;
	}

2461
	if (func && has_modified_stack_frame(insn, state)) {
2462 2463 2464 2465 2466
		WARN_FUNC("return with modified stack frame",
			  insn->sec, insn->offset);
		return 1;
	}

2467
	if (state->cfi.bp_scratch) {
2468 2469
		WARN_FUNC("BP used as a scratch register",
			  insn->sec, insn->offset);
2470 2471 2472 2473 2474 2475
		return 1;
	}

	return 0;
}

2476 2477
static struct instruction *next_insn_to_validate(struct objtool_file *file,
						 struct instruction *insn)
2478
{
J
Josh Poimboeuf 已提交
2479
	struct alt_group *alt_group = insn->alt_group;
2480

2481 2482 2483 2484 2485 2486 2487 2488 2489
	/*
	 * 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);
2490 2491
}

2492 2493 2494 2495 2496 2497
/*
 * 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.
 */
2498
static int validate_branch(struct objtool_file *file, struct symbol *func,
P
Peter Zijlstra 已提交
2499
			   struct instruction *insn, struct insn_state state)
2500 2501
{
	struct alternative *alt;
P
Peter Zijlstra 已提交
2502
	struct instruction *next_insn;
2503
	struct section *sec;
2504
	u8 visited;
2505 2506 2507 2508 2509
	int ret;

	sec = insn->sec;

	while (1) {
2510
		next_insn = next_insn_to_validate(file, insn);
2511

2512
		if (file->c_file && func && insn->func && func != insn->func->pfunc) {
2513 2514 2515
			WARN("%s() falls through to next function %s()",
			     func->name, insn->func->name);
			return 1;
2516 2517
		}

2518 2519 2520
		if (func && insn->ignore) {
			WARN_FUNC("BUG: why am I validating an ignored function?",
				  sec, insn->offset);
2521
			return 1;
2522 2523
		}

2524
		visited = 1 << state.uaccess;
2525
		if (insn->visited) {
2526
			if (!insn->hint && !insn_cfi_match(insn, &state.cfi))
2527 2528
				return 1;

2529
			if (insn->visited & visited)
P
Peter Zijlstra 已提交
2530
				return 0;
2531 2532
		}

2533 2534 2535
		if (state.noinstr)
			state.instr += insn->instr;

2536
		if (insn->hint)
2537
			state.cfi = insn->cfi;
2538
		else
2539
			insn->cfi = state.cfi;
2540

2541
		insn->visited |= visited;
2542

2543 2544 2545
		if (propagate_alt_cfi(file, insn))
			return 1;

2546
		if (!insn->ignore_alts && !list_empty(&insn->alts)) {
P
Peter Zijlstra 已提交
2547 2548
			bool skip_orig = false;

2549
			list_for_each_entry(alt, &insn->alts, list) {
P
Peter Zijlstra 已提交
2550 2551 2552
				if (alt->skip_orig)
					skip_orig = true;

2553
				ret = validate_branch(file, func, alt->insn, state);
2554 2555 2556 2557 2558
				if (ret) {
					if (backtrace)
						BT_FUNC("(alt)", insn);
					return ret;
				}
2559
			}
P
Peter Zijlstra 已提交
2560 2561 2562

			if (skip_orig)
				return 0;
2563 2564
		}

2565 2566 2567
		if (handle_insn_ops(insn, &state))
			return 1;

2568 2569 2570
		switch (insn->type) {

		case INSN_RETURN:
2571
			return validate_return(func, insn, &state);
2572 2573

		case INSN_CALL:
P
Peter Zijlstra 已提交
2574 2575 2576 2577
		case INSN_CALL_DYNAMIC:
			ret = validate_call(insn, &state);
			if (ret)
				return ret;
2578

2579 2580
			if (!no_fp && func && !is_fentry_call(insn) &&
			    !has_valid_stack_frame(&state)) {
2581 2582 2583 2584
				WARN_FUNC("call without frame pointer save/setup",
					  sec, insn->offset);
				return 1;
			}
2585 2586 2587 2588

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

2589 2590 2591 2592 2593
			if (insn->type == INSN_CALL && insn->call_dest->static_call_tramp) {
				list_add_tail(&insn->static_call_node,
					      &file->static_call_list);
			}

2594 2595 2596 2597
			break;

		case INSN_JUMP_CONDITIONAL:
		case INSN_JUMP_UNCONDITIONAL:
2598
			if (is_sibling_call(insn)) {
2599
				ret = validate_sibling_call(insn, &state);
2600
				if (ret)
2601
					return ret;
2602

2603
			} else if (insn->jump_dest) {
2604 2605
				ret = validate_branch(file, func,
						      insn->jump_dest, state);
2606 2607 2608 2609 2610
				if (ret) {
					if (backtrace)
						BT_FUNC("(branch)", insn);
					return ret;
				}
2611
			}
2612 2613 2614 2615 2616 2617 2618

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

			break;

		case INSN_JUMP_DYNAMIC:
2619
		case INSN_JUMP_DYNAMIC_CONDITIONAL:
2620
			if (is_sibling_call(insn)) {
2621 2622 2623
				ret = validate_sibling_call(insn, &state);
				if (ret)
					return ret;
2624 2625
			}

2626 2627 2628 2629
			if (insn->type == INSN_JUMP_DYNAMIC)
				return 0;

			break;
2630

2631 2632 2633 2634 2635 2636 2637 2638
		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 已提交
2639 2640 2641 2642 2643 2644 2645 2646 2647 2648
		case INSN_STAC:
			if (state.uaccess) {
				WARN_FUNC("recursive UACCESS enable", sec, insn->offset);
				return 1;
			}

			state.uaccess = true;
			break;

		case INSN_CLAC:
2649
			if (!state.uaccess && func) {
P
Peter Zijlstra 已提交
2650 2651 2652 2653 2654 2655 2656 2657 2658 2659
				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;
2660 2661
			break;

2662
		case INSN_STD:
2663
			if (state.df) {
2664
				WARN_FUNC("recursive STD", sec, insn->offset);
2665 2666
				return 1;
			}
2667 2668 2669 2670 2671

			state.df = true;
			break;

		case INSN_CLD:
2672
			if (!state.df && func) {
2673
				WARN_FUNC("redundant CLD", sec, insn->offset);
2674 2675
				return 1;
			}
2676 2677

			state.df = false;
2678 2679
			break;

2680 2681 2682 2683 2684 2685 2686
		default:
			break;
		}

		if (insn->dead_end)
			return 0;

2687
		if (!next_insn) {
2688
			if (state.cfi.cfa.base == CFI_UNDEFINED)
2689
				return 0;
2690 2691 2692
			WARN("%s: unexpected end of section", sec->name);
			return 1;
		}
2693 2694

		insn = next_insn;
2695 2696 2697 2698 2699
	}

	return 0;
}

2700
static int validate_unwind_hints(struct objtool_file *file, struct section *sec)
2701 2702 2703
{
	struct instruction *insn;
	struct insn_state state;
2704
	int ret, warnings = 0;
2705 2706 2707 2708

	if (!file->hints)
		return 0;

2709
	init_insn_state(&state, sec);
2710

2711 2712 2713 2714 2715 2716 2717 2718 2719
	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)) {
2720
		if (insn->hint && !insn->visited) {
2721
			ret = validate_branch(file, insn->func, insn, state);
2722 2723
			if (ret && backtrace)
				BT_FUNC("<=== (hint)", insn);
2724 2725
			warnings += ret;
		}
2726 2727

		insn = list_next_entry(insn, list);
2728 2729 2730 2731 2732
	}

	return warnings;
}

2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745
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;

2746 2747 2748 2749 2750 2751 2752 2753 2754
		/*
		 * .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;

2755 2756 2757 2758 2759 2760 2761 2762 2763 2764
		WARN_FUNC("indirect %s found in RETPOLINE build",
			  insn->sec, insn->offset,
			  insn->type == INSN_JUMP_DYNAMIC ? "jump" : "call");

		warnings++;
	}

	return warnings;
}

2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777
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"));
}

2778
static bool ignore_unreachable_insn(struct objtool_file *file, struct instruction *insn)
2779 2780
{
	int i;
2781
	struct instruction *prev_insn;
2782

2783 2784 2785 2786 2787 2788
	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.
2789 2790 2791
	 *
	 * Also ignore alternative replacement instructions.  This can happen
	 * when a whitelisted function uses one of the ALTERNATIVE macros.
2792
	 */
2793 2794 2795
	if (!strcmp(insn->sec->name, ".fixup") ||
	    !strcmp(insn->sec->name, ".altinstr_replacement") ||
	    !strcmp(insn->sec->name, ".altinstr_aux"))
2796 2797
		return true;

2798 2799 2800 2801 2802 2803 2804 2805
	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).
2806 2807
	 *
	 * It may also insert a UD2 after calling a __noreturn function.
2808
	 */
2809 2810
	prev_insn = list_prev_entry(insn, list);
	if ((prev_insn->dead_end || dead_end_function(file, prev_insn->call_dest)) &&
2811 2812 2813 2814 2815
	    (insn->type == INSN_BUG ||
	     (insn->type == INSN_JUMP_UNCONDITIONAL &&
	      insn->jump_dest && insn->jump_dest->type == INSN_BUG)))
		return true;

2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826
	/*
	 * 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;

2827 2828 2829 2830 2831 2832 2833 2834
		if (insn->type == INSN_JUMP_UNCONDITIONAL) {
			if (insn->jump_dest &&
			    insn->jump_dest->func == insn->func) {
				insn = insn->jump_dest;
				continue;
			}

			break;
2835 2836
		}

2837
		if (insn->offset + insn->len >= insn->func->offset + insn->func->len)
2838
			break;
2839

2840 2841 2842 2843 2844 2845
		insn = list_next_entry(insn, list);
	}

	return false;
}

2846 2847
static int validate_symbol(struct objtool_file *file, struct section *sec,
			   struct symbol *sym, struct insn_state *state)
2848 2849
{
	struct instruction *insn;
2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873
	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)
{
2874
	struct insn_state state;
2875 2876
	struct symbol *func;
	int warnings = 0;
2877

2878 2879 2880
	list_for_each_entry(func, &sec->symbol_list, list) {
		if (func->type != STT_FUNC)
			continue;
2881

2882
		init_insn_state(&state, sec);
2883 2884
		state.cfi.cfa = initial_func_cfi.cfa;
		memcpy(&state.cfi.regs, &initial_func_cfi.regs,
2885
		       CFI_NUM_REGS * sizeof(struct cfi_reg));
2886
		state.cfi.stack_size = initial_func_cfi.cfa.offset;
2887

2888
		warnings += validate_symbol(file, sec, func, &state);
2889 2890 2891 2892 2893
	}

	return warnings;
}

2894 2895 2896
static int validate_vmlinux_functions(struct objtool_file *file)
{
	struct section *sec;
2897
	int warnings = 0;
2898 2899

	sec = find_section_by_name(file->elf, ".noinstr.text");
2900 2901 2902 2903
	if (sec) {
		warnings += validate_section(file, sec);
		warnings += validate_unwind_hints(file, sec);
	}
2904

2905 2906 2907 2908 2909
	sec = find_section_by_name(file->elf, ".entry.text");
	if (sec) {
		warnings += validate_section(file, sec);
		warnings += validate_unwind_hints(file, sec);
	}
2910 2911

	return warnings;
2912 2913
}

2914 2915 2916 2917 2918
static int validate_functions(struct objtool_file *file)
{
	struct section *sec;
	int warnings = 0;

2919 2920 2921 2922
	for_each_sec(file, sec) {
		if (!(sec->sh.sh_flags & SHF_EXECINSTR))
			continue;

2923
		warnings += validate_section(file, sec);
2924
	}
2925 2926 2927 2928

	return warnings;
}

2929
static int validate_reachable_instructions(struct objtool_file *file)
2930 2931
{
	struct instruction *insn;
2932 2933 2934

	if (file->ignore_unreachables)
		return 0;
2935 2936

	for_each_insn(file, insn) {
2937
		if (insn->visited || ignore_unreachable_insn(file, insn))
2938 2939 2940 2941
			continue;

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

2944
	return 0;
2945 2946
}

2947
int check(struct objtool_file *file)
2948 2949 2950
{
	int ret, warnings = 0;

2951 2952
	arch_initial_func_cfi_state(&initial_func_cfi);

2953
	ret = decode_sections(file);
2954 2955 2956 2957
	if (ret < 0)
		goto out;
	warnings += ret;

2958
	if (list_empty(&file->insn_list))
2959 2960
		goto out;

2961
	if (vmlinux && !validate_dup) {
2962
		ret = validate_vmlinux_functions(file);
2963 2964 2965 2966 2967 2968 2969
		if (ret < 0)
			goto out;

		warnings += ret;
		goto out;
	}

2970
	if (retpoline) {
2971
		ret = validate_retpoline(file);
2972 2973 2974 2975 2976
		if (ret < 0)
			return ret;
		warnings += ret;
	}

2977
	ret = validate_functions(file);
2978 2979 2980 2981
	if (ret < 0)
		goto out;
	warnings += ret;

2982
	ret = validate_unwind_hints(file, NULL);
2983 2984 2985 2986
	if (ret < 0)
		goto out;
	warnings += ret;

2987
	if (!warnings) {
2988
		ret = validate_reachable_instructions(file);
2989 2990 2991 2992 2993
		if (ret < 0)
			goto out;
		warnings += ret;
	}

2994
	ret = create_static_call_sections(file);
2995 2996 2997 2998
	if (ret < 0)
		goto out;
	warnings += ret;

2999
out:
3000 3001 3002 3003 3004 3005 3006 3007 3008
	if (ret < 0) {
		/*
		 *  Fatal error.  The binary is corrupt or otherwise broken in
		 *  some way, or objtool itself is broken.  Fail the kernel
		 *  build.
		 */
		return ret;
	}

3009 3010
	return 0;
}