check.c 69.1 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
#include "builtin.h"
10 11
#include "cfi.h"
#include "arch.h"
12 13 14
#include "check.h"
#include "special.h"
#include "warn.h"
P
Peter Zijlstra 已提交
15
#include "arch_elf.h"
16

17
#include <linux/objtool.h>
18 19
#include <linux/hashtable.h>
#include <linux/kernel.h>
20
#include <linux/static_call_types.h>
21

22 23
#define FAKE_JUMP_OFFSET -1

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

30
struct cfi_init_state initial_func_cfi;
31

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

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

	return NULL;
}

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

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

	return next;
}

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

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

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

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

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

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

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

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

118
	if (!is_static_jump(insn))
119 120 121 122 123 124
		return false;

	/* add_jump_destinations() sets insn->call_dest for sibling calls. */
	return !!insn->call_dest;
}

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

161 162 163
	if (!func)
		return false;

164
	if (func->bind == STB_WEAK)
165
		return false;
166 167 168 169

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

172
	if (!func->len)
173
		return false;
174

175 176
	insn = find_insn(file, func->sec, func->offset);
	if (!insn->func)
177
		return false;
178

179
	func_for_each_insn(file, func, insn) {
180 181 182
		empty = false;

		if (insn->type == INSN_RETURN)
183
			return false;
184 185 186
	}

	if (empty)
187
		return false;
188 189 190 191 192 193

	/*
	 * 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.
	 */
194
	func_for_each_insn(file, func, insn) {
195
		if (is_sibling_call(insn)) {
196 197 198 199
			struct instruction *dest = insn->jump_dest;

			if (!dest)
				/* sibling call to another file */
200
				return false;
201

202 203 204 205 206 207 208 209
			/* 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;
210 211
			}

212 213
			return __dead_end_function(file, dest->func, recursion+1);
		}
214 215
	}

216
	return true;
217 218
}

219
static bool dead_end_function(struct objtool_file *file, struct symbol *func)
220 221 222 223
{
	return __dead_end_function(file, func, 0);
}

224
static void init_cfi_state(struct cfi_state *cfi)
225 226 227
{
	int i;

228
	for (i = 0; i < CFI_NUM_REGS; i++) {
229 230
		cfi->regs[i].base = CFI_UNDEFINED;
		cfi->vals[i].base = CFI_UNDEFINED;
231
	}
232 233 234 235 236
	cfi->cfa.base = CFI_UNDEFINED;
	cfi->drap_reg = CFI_UNDEFINED;
	cfi->drap_offset = -1;
}

237
static void init_insn_state(struct insn_state *state, struct section *sec)
238 239 240
{
	memset(state, 0, sizeof(*state));
	init_cfi_state(&state->cfi);
241 242 243 244 245 246 247 248

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

251 252 253 254 255 256 257 258 259 260
/*
 * 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 已提交
261
	unsigned long nr_insns = 0;
262 263
	int ret;

264
	for_each_sec(file, sec) {
265 266 267 268

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

269 270 271 272 273
		if (strcmp(sec->name, ".altinstr_replacement") &&
		    strcmp(sec->name, ".altinstr_aux") &&
		    strncmp(sec->name, ".discard.", 9))
			sec->text = true;

274 275
		if (!strcmp(sec->name, ".noinstr.text") ||
		    !strcmp(sec->name, ".entry.text"))
276 277
			sec->noinstr = true;

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

289 290 291 292 293 294
			insn->sec = sec;
			insn->offset = offset;

			ret = arch_decode_instruction(file->elf, sec, offset,
						      sec->len - offset,
						      &insn->len, &insn->type,
295
						      &insn->immediate,
296
						      &insn->stack_ops);
297
			if (ret)
298
				goto err;
299

300
			hash_add(file->insn_hash, &insn->hash, sec_offset_hash(sec, insn->offset));
301
			list_add_tail(&insn->list, &file->insn_list);
P
Peter Zijlstra 已提交
302
			nr_insns++;
303 304 305
		}

		list_for_each_entry(func, &sec->symbol_list, list) {
306
			if (func->type != STT_FUNC || func->alias != func)
307 308 309 310 311 312 313 314
				continue;

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

315
			sym_for_each_insn(file, func, insn)
316
				insn->func = func;
317 318 319
		}
	}

P
Peter Zijlstra 已提交
320 321 322
	if (stats)
		printf("nr_insns: %lu\n", nr_insns);

323
	return 0;
324 325 326 327

err:
	free(insn);
	return ret;
328 329
}

330 331 332 333 334 335 336 337 338 339 340 341 342
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;
}

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

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

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

		insn->dead_end = true;
	}

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

		insn->dead_end = false;
	}

426 427 428
	return 0;
}

429 430 431 432 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
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));
470

471 472 473 474 475
		if (!reloc) {
			perror("malloc");
			return -1;
		}
		memset(reloc, 0, sizeof(*reloc));
476 477 478 479 480 481 482 483

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

484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
		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 已提交
518
		reloc->addend = is_sibling_call(insn) ? STATIC_CALL_SITE_TAIL : 0;
519 520 521 522 523 524 525 526 527 528 529 530 531 532
		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;
}

533 534 535 536 537 538 539 540
/*
 * 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 已提交
541
	struct reloc *reloc;
542

P
Peter Zijlstra 已提交
543 544 545
	sec = find_section_by_name(file->elf, ".rela.discard.func_stack_frame_non_standard");
	if (!sec)
		return;
546

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

		case STT_SECTION:
M
Matt Helsley 已提交
554
			func = find_func_by_offset(reloc->sym->sec, reloc->addend);
555
			if (!func)
556
				continue;
P
Peter Zijlstra 已提交
557
			break;
558

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

564
		func_for_each_insn(file, func, insn)
P
Peter Zijlstra 已提交
565
			insn->ignore = true;
566 567 568
	}
}

P
Peter Zijlstra 已提交
569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
/*
 * 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",
593 594
	"__kasan_check_read",
	"__kasan_check_write",
P
Peter Zijlstra 已提交
595 596 597 598 599 600 601 602 603 604 605 606 607
	/* 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",
608
	/* KCSAN */
609
	"__kcsan_check_access",
610 611
	"kcsan_found_watchpoint",
	"kcsan_setup_watchpoint",
612
	"kcsan_check_scoped_accesses",
613 614
	"kcsan_disable_current",
	"kcsan_enable_current_nowarn",
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
	/* 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",
630 631 632 633 634
	"__tsan_read_write1",
	"__tsan_read_write2",
	"__tsan_read_write4",
	"__tsan_read_write8",
	"__tsan_read_write16",
635 636 637 638 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
	"__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 已提交
685 686
	/* KCOV */
	"write_comp_data",
687
	"check_kcov_mode",
P
Peter Zijlstra 已提交
688 689 690 691 692 693 694 695 696
	"__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",
697
	"__sanitizer_cov_trace_switch",
P
Peter Zijlstra 已提交
698 699 700 701
	/* UBSAN */
	"ubsan_type_mismatch_common",
	"__ubsan_handle_type_mismatch",
	"__ubsan_handle_type_mismatch_v1",
702
	"__ubsan_handle_shift_out_of_bounds",
P
Peter Zijlstra 已提交
703 704
	/* misc */
	"csum_partial_copy_generic",
705 706
	"copy_mc_fragile",
	"copy_mc_fragile_handle_tail",
707
	"copy_mc_enhanced_fast_string",
P
Peter Zijlstra 已提交
708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724
	"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;

725
		func->uaccess_safe = true;
726 727 728
	}
}

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

741
	sec = find_section_by_name(file->elf, ".rela.discard.ignore_alts");
742 743 744
	if (!sec)
		return 0;

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

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

		insn->ignore_alts = true;
	}

	return 0;
}

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

	for_each_insn(file, insn) {
774
		if (!is_static_jump(insn))
775 776
			continue;

777
		if (insn->offset == FAKE_JUMP_OFFSET)
778 779
			continue;

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

802
			insn->retpoline_safe = true;
803
			continue;
804
		} else {
805
			/* external sibling call */
M
Matt Helsley 已提交
806
			insn->call_dest = reloc->sym;
P
Peter Zijlstra 已提交
807 808 809 810
			if (insn->call_dest->static_call_tramp) {
				list_add_tail(&insn->static_call_node,
					      &file->static_call_list);
			}
811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829
			continue;
		}

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

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

860
				/* internal sibling call */
861
				insn->call_dest = insn->jump_dest->func;
P
Peter Zijlstra 已提交
862 863 864 865
				if (insn->call_dest->static_call_tramp) {
					list_add_tail(&insn->static_call_node,
						      &file->static_call_list);
				}
866
			}
867
		}
868 869 870 871 872
	}

	return 0;
}

873 874 875 876 877 878 879 880 881 882
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);
	}
}

883 884 885 886 887 888 889 890 891 892 893
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;
}

894 895 896 897 898 899 900
/*
 * 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 已提交
901
	struct reloc *reloc;
902 903 904 905 906

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

M
Matt Helsley 已提交
907
		reloc = find_reloc_by_dest_range(file->elf, insn->sec,
908
					       insn->offset, insn->len);
M
Matt Helsley 已提交
909
		if (!reloc) {
910
			dest_off = arch_jump_destination(insn);
911
			insn->call_dest = find_call_destination(insn->sec, dest_off);
912

913 914 915 916
			if (insn->ignore)
				continue;

			if (!insn->call_dest) {
917
				WARN_FUNC("unannotated intra-function call", insn->sec, insn->offset);
918 919
				return -1;
			}
920

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

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

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

959 960 961 962 963 964 965 966
		/*
		 * 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);
967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993
	}

	return 0;
}

/*
 * The .alternatives section requires some extra special care, over and above
 * what other special sections require:
 *
 * 1. Because alternatives are patched in-place, we need to insert a fake jump
 *    instruction at the end so that validate_branch() skips all the original
 *    replaced instructions when validating the new instruction path.
 *
 * 2. An added wrinkle is that the new instruction length might be zero.  In
 *    that case the old instructions are replaced with noops.  We simulate that
 *    by creating a fake jump as the only new instruction.
 *
 * 3. In some cases, the alternative section includes an instruction which
 *    conditionally jumps to the _end_ of the entry.  We have to modify these
 *    jumps' destinations to point back to .text rather than the end of the
 *    entry in .altinstr_replacement.
 */
static int handle_group_alt(struct objtool_file *file,
			    struct special_alt *special_alt,
			    struct instruction *orig_insn,
			    struct instruction **new_insn)
{
994
	static unsigned int alt_group_next_index = 1;
995
	struct instruction *last_orig_insn, *last_new_insn, *insn, *fake_jump = NULL;
996
	unsigned int alt_group = alt_group_next_index++;
997 998 999 1000 1001 1002 1003 1004
	unsigned long dest_off;

	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;

1005
		insn->alt_group = alt_group;
1006 1007 1008
		last_orig_insn = insn;
	}

1009 1010 1011 1012 1013 1014 1015 1016
	if (next_insn_same_sec(file, last_orig_insn)) {
		fake_jump = malloc(sizeof(*fake_jump));
		if (!fake_jump) {
			WARN("malloc failed");
			return -1;
		}
		memset(fake_jump, 0, sizeof(*fake_jump));
		INIT_LIST_HEAD(&fake_jump->alts);
1017
		INIT_LIST_HEAD(&fake_jump->stack_ops);
1018
		init_cfi_state(&fake_jump->cfi);
1019 1020

		fake_jump->sec = special_alt->new_sec;
1021
		fake_jump->offset = FAKE_JUMP_OFFSET;
1022 1023
		fake_jump->type = INSN_JUMP_UNCONDITIONAL;
		fake_jump->jump_dest = list_next_entry(last_orig_insn, list);
1024
		fake_jump->func = orig_insn->func;
1025 1026 1027
	}

	if (!special_alt->new_len) {
1028 1029 1030 1031 1032 1033
		if (!fake_jump) {
			WARN("%s: empty alternative at end of section",
			     special_alt->orig_sec->name);
			return -1;
		}

1034 1035 1036 1037 1038
		*new_insn = fake_jump;
		return 0;
	}

	last_new_insn = NULL;
1039
	alt_group = alt_group_next_index++;
1040 1041
	insn = *new_insn;
	sec_for_each_insn_from(file, insn) {
1042 1043
		struct reloc *alt_reloc;

1044 1045 1046 1047 1048
		if (insn->offset >= special_alt->new_off + special_alt->new_len)
			break;

		last_new_insn = insn;

1049
		insn->ignore = orig_insn->ignore_alts;
1050
		insn->func = orig_insn->func;
1051
		insn->alt_group = alt_group;
1052

1053 1054 1055 1056 1057 1058 1059 1060
		/*
		 * 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.
		 */
1061 1062 1063 1064
		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)) {
1065 1066 1067 1068 1069 1070

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

1071
		if (!is_static_jump(insn))
1072 1073 1074 1075 1076
			continue;

		if (!insn->immediate)
			continue;

1077
		dest_off = arch_jump_destination(insn);
1078 1079 1080 1081 1082 1083
		if (dest_off == special_alt->new_off + special_alt->new_len) {
			if (!fake_jump) {
				WARN("%s: alternative jump to end of section",
				     special_alt->orig_sec->name);
				return -1;
			}
1084
			insn->jump_dest = fake_jump;
1085
		}
1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099

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

1100 1101
	if (fake_jump)
		list_add(&fake_jump->list, &last_new_insn->list);
1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 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

	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) {
1172 1173 1174 1175 1176 1177
			if (!special_alt->orig_len) {
				WARN_FUNC("empty alternative entry",
					  orig_insn->sec, orig_insn->offset);
				continue;
			}

1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188
			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;
		}

1189 1190 1191 1192 1193 1194 1195
		alt = malloc(sizeof(*alt));
		if (!alt) {
			WARN("malloc failed");
			ret = -1;
			goto out;
		}

1196
		alt->insn = new_insn;
P
Peter Zijlstra 已提交
1197
		alt->skip_orig = special_alt->skip_orig;
P
Peter Zijlstra 已提交
1198
		orig_insn->ignore_alts |= special_alt->skip_alt;
1199 1200 1201 1202 1203 1204 1205 1206 1207 1208
		list_add_tail(&alt->list, &orig_insn->alts);

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

out:
	return ret;
}

1209
static int add_jump_table(struct objtool_file *file, struct instruction *insn,
M
Matt Helsley 已提交
1210
			    struct reloc *table)
1211
{
M
Matt Helsley 已提交
1212
	struct reloc *reloc = table;
1213
	struct instruction *dest_insn;
1214
	struct alternative *alt;
1215 1216
	struct symbol *pfunc = insn->func->pfunc;
	unsigned int prev_offset = 0;
1217

1218
	/*
M
Matt Helsley 已提交
1219
	 * Each @reloc is a switch table relocation which points to the target
1220 1221
	 * instruction.
	 */
M
Matt Helsley 已提交
1222
	list_for_each_entry_from(reloc, &table->sec->reloc_list, list) {
1223 1224

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

1228
		/* Make sure the table entries are consecutive: */
M
Matt Helsley 已提交
1229
		if (prev_offset && reloc->offset != prev_offset + 8)
1230 1231 1232
			break;

		/* Detect function pointers from contiguous objects: */
M
Matt Helsley 已提交
1233 1234
		if (reloc->sym->sec == pfunc->sec &&
		    reloc->addend == pfunc->offset)
1235 1236
			break;

M
Matt Helsley 已提交
1237
		dest_insn = find_insn(file, reloc->sym->sec, reloc->addend);
1238
		if (!dest_insn)
1239 1240
			break;

1241
		/* Make sure the destination is in the same function: */
1242
		if (!dest_insn->func || dest_insn->func->pfunc != pfunc)
1243
			break;
1244 1245 1246 1247 1248 1249 1250

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

1251
		alt->insn = dest_insn;
1252
		list_add_tail(&alt->list, &insn->alts);
M
Matt Helsley 已提交
1253
		prev_offset = reloc->offset;
1254 1255 1256 1257 1258 1259
	}

	if (!prev_offset) {
		WARN_FUNC("can't find switch jump table",
			  insn->sec, insn->offset);
		return -1;
1260 1261 1262 1263 1264 1265
	}

	return 0;
}

/*
1266 1267
 * find_jump_table() - Given a dynamic jump, find the switch jump table
 * associated with it.
1268
 */
M
Matt Helsley 已提交
1269
static struct reloc *find_jump_table(struct objtool_file *file,
1270 1271 1272
				      struct symbol *func,
				      struct instruction *insn)
{
1273
	struct reloc *table_reloc;
1274
	struct instruction *dest_insn, *orig_insn = insn;
1275

1276 1277 1278 1279 1280
	/*
	 * Backward search using the @first_jump_src links, these help avoid
	 * much of the 'in between' code. Which avoids us getting confused by
	 * it.
	 */
1281
	for (;
1282 1283
	     insn && insn->func && insn->func->pfunc == func;
	     insn = insn->first_jump_src ?: prev_insn_same_sym(file, insn)) {
1284

1285
		if (insn != orig_insn && insn->type == INSN_JUMP_DYNAMIC)
1286 1287 1288 1289 1290 1291 1292 1293 1294
			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;

1295
		table_reloc = arch_find_switch_table(file, insn);
M
Matt Helsley 已提交
1296
		if (!table_reloc)
1297
			continue;
M
Matt Helsley 已提交
1298
		dest_insn = find_insn(file, table_reloc->sym->sec, table_reloc->addend);
1299 1300
		if (!dest_insn || !dest_insn->func || dest_insn->func->pfunc != func)
			continue;
1301

M
Matt Helsley 已提交
1302
		return table_reloc;
1303 1304 1305 1306 1307
	}

	return NULL;
}

1308 1309 1310 1311 1312 1313
/*
 * 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)
1314
{
1315
	struct instruction *insn, *last = NULL;
M
Matt Helsley 已提交
1316
	struct reloc *reloc;
1317

1318
	func_for_each_insn(file, func, insn) {
1319 1320 1321 1322 1323
		if (!last)
			last = insn;

		/*
		 * Store back-pointers for unconditional forward jumps such
1324
		 * that find_jump_table() can back-track using those and
1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335
		 * 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;
		}

1336 1337 1338
		if (insn->type != INSN_JUMP_DYNAMIC)
			continue;

M
Matt Helsley 已提交
1339 1340 1341 1342
		reloc = find_jump_table(file, func, insn);
		if (reloc) {
			reloc->jump_table_start = true;
			insn->jump_table = reloc;
1343 1344
		}
	}
1345 1346 1347 1348 1349 1350 1351 1352
}

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

1353
	func_for_each_insn(file, func, insn) {
1354 1355
		if (!insn->jump_table)
			continue;
1356

1357
		ret = add_jump_table(file, insn, insn->jump_table);
1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369
		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.
 */
1370
static int add_jump_table_alts(struct objtool_file *file)
1371 1372 1373 1374 1375
{
	struct section *sec;
	struct symbol *func;
	int ret;

1376
	if (!file->rodata)
1377 1378
		return 0;

1379
	for_each_sec(file, sec) {
1380 1381 1382 1383
		list_for_each_entry(func, &sec->symbol_list, list) {
			if (func->type != STT_FUNC)
				continue;

1384
			mark_func_jump_tables(file, func);
1385
			ret = add_func_jump_tables(file, func);
1386 1387 1388 1389 1390 1391 1392 1393
			if (ret)
				return ret;
		}
	}

	return 0;
}

1394 1395
static int read_unwind_hints(struct objtool_file *file)
{
M
Matt Helsley 已提交
1396 1397
	struct section *sec, *relocsec;
	struct reloc *reloc;
1398 1399 1400 1401 1402 1403 1404 1405 1406
	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 已提交
1407 1408
	relocsec = sec->reloc;
	if (!relocsec) {
1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422
		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 已提交
1423 1424 1425
		reloc = find_reloc_by_dest(file->elf, sec, i * sizeof(*hint));
		if (!reloc) {
			WARN("can't find reloc for unwind_hints[%d]", i);
1426 1427 1428
			return -1;
		}

M
Matt Helsley 已提交
1429
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
1430 1431 1432 1433 1434
		if (!insn) {
			WARN("can't find insn for unwind_hints[%d]", i);
			return -1;
		}

1435
		cfa = &insn->cfi.cfa;
1436

1437
		if (hint->type == UNWIND_HINT_TYPE_RET_OFFSET) {
1438
			insn->ret_offset = hint->sp_offset;
1439 1440 1441 1442 1443
			continue;
		}

		insn->hint = true;

1444
		if (arch_decode_hint_reg(insn, hint->sp_reg)) {
1445 1446 1447 1448 1449 1450
			WARN_FUNC("unsupported unwind_hint sp base reg %d",
				  insn->sec, insn->offset, hint->sp_reg);
			return -1;
		}

		cfa->offset = hint->sp_offset;
1451 1452
		insn->cfi.type = hint->type;
		insn->cfi.end = hint->end;
1453 1454 1455 1456 1457
	}

	return 0;
}

1458 1459
static int read_retpoline_hints(struct objtool_file *file)
{
J
Josh Poimboeuf 已提交
1460
	struct section *sec;
1461
	struct instruction *insn;
M
Matt Helsley 已提交
1462
	struct reloc *reloc;
1463

J
Josh Poimboeuf 已提交
1464
	sec = find_section_by_name(file->elf, ".rela.discard.retpoline_safe");
1465 1466 1467
	if (!sec)
		return 0;

M
Matt Helsley 已提交
1468 1469
	list_for_each_entry(reloc, &sec->reloc_list, list) {
		if (reloc->sym->type != STT_SECTION) {
J
Josh Poimboeuf 已提交
1470
			WARN("unexpected relocation symbol type in %s", sec->name);
1471 1472 1473
			return -1;
		}

M
Matt Helsley 已提交
1474
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
1475
		if (!insn) {
J
Josh Poimboeuf 已提交
1476
			WARN("bad .discard.retpoline_safe entry");
1477 1478 1479 1480 1481
			return -1;
		}

		if (insn->type != INSN_JUMP_DYNAMIC &&
		    insn->type != INSN_CALL_DYNAMIC) {
J
Josh Poimboeuf 已提交
1482
			WARN_FUNC("retpoline_safe hint not an indirect jump/call",
1483 1484 1485 1486 1487 1488 1489 1490 1491 1492
				  insn->sec, insn->offset);
			return -1;
		}

		insn->retpoline_safe = true;
	}

	return 0;
}

1493 1494 1495 1496
static int read_instr_hints(struct objtool_file *file)
{
	struct section *sec;
	struct instruction *insn;
M
Matt Helsley 已提交
1497
	struct reloc *reloc;
1498 1499 1500 1501 1502

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

M
Matt Helsley 已提交
1503 1504
	list_for_each_entry(reloc, &sec->reloc_list, list) {
		if (reloc->sym->type != STT_SECTION) {
1505 1506 1507 1508
			WARN("unexpected relocation symbol type in %s", sec->name);
			return -1;
		}

M
Matt Helsley 已提交
1509
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521
		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 已提交
1522 1523
	list_for_each_entry(reloc, &sec->reloc_list, list) {
		if (reloc->sym->type != STT_SECTION) {
1524 1525 1526 1527
			WARN("unexpected relocation symbol type in %s", sec->name);
			return -1;
		}

M
Matt Helsley 已提交
1528
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539
		if (!insn) {
			WARN("bad .discard.instr_begin entry");
			return -1;
		}

		insn->instr++;
	}

	return 0;
}

1540 1541 1542 1543
static int read_intra_function_calls(struct objtool_file *file)
{
	struct instruction *insn;
	struct section *sec;
M
Matt Helsley 已提交
1544
	struct reloc *reloc;
1545 1546 1547 1548 1549

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

M
Matt Helsley 已提交
1550
	list_for_each_entry(reloc, &sec->reloc_list, list) {
1551 1552
		unsigned long dest_off;

M
Matt Helsley 已提交
1553
		if (reloc->sym->type != STT_SECTION) {
1554 1555 1556 1557 1558
			WARN("unexpected relocation symbol type in %s",
			     sec->name);
			return -1;
		}

M
Matt Helsley 已提交
1559
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590
		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;
}

1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607
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;
}

1608 1609 1610 1611 1612 1613
static void mark_rodata(struct objtool_file *file)
{
	struct section *sec;
	bool found = false;

	/*
1614 1615 1616 1617 1618 1619 1620 1621
	 * 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.
1622 1623
	 */
	for_each_sec(file, sec) {
1624 1625
		if (!strncmp(sec->name, ".rodata", 7) &&
		    !strstr(sec->name, ".str1.")) {
1626 1627 1628 1629 1630 1631 1632 1633
			sec->rodata = true;
			found = true;
		}
	}

	file->rodata = found;
}

1634 1635 1636 1637
static int decode_sections(struct objtool_file *file)
{
	int ret;

1638 1639
	mark_rodata(file);

1640 1641 1642 1643 1644 1645 1646 1647 1648
	ret = decode_instructions(file);
	if (ret)
		return ret;

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

	add_ignores(file);
P
Peter Zijlstra 已提交
1649
	add_uaccess_safe(file);
1650

1651
	ret = add_ignore_alternatives(file);
1652 1653 1654
	if (ret)
		return ret;

P
Peter Zijlstra 已提交
1655 1656 1657 1658
	ret = read_static_call_tramps(file);
	if (ret)
		return ret;

1659 1660 1661 1662
	ret = add_jump_destinations(file);
	if (ret)
		return ret;

1663
	ret = add_special_section_alts(file);
1664 1665 1666
	if (ret)
		return ret;

1667 1668 1669 1670
	ret = read_intra_function_calls(file);
	if (ret)
		return ret;

1671
	ret = add_call_destinations(file);
1672 1673 1674
	if (ret)
		return ret;

1675
	ret = add_jump_table_alts(file);
1676 1677 1678
	if (ret)
		return ret;

1679 1680 1681 1682
	ret = read_unwind_hints(file);
	if (ret)
		return ret;

1683 1684 1685 1686
	ret = read_retpoline_hints(file);
	if (ret)
		return ret;

1687 1688 1689 1690
	ret = read_instr_hints(file);
	if (ret)
		return ret;

1691 1692 1693 1694 1695
	return 0;
}

static bool is_fentry_call(struct instruction *insn)
{
1696
	if (insn->type == INSN_CALL && insn->call_dest &&
1697 1698 1699 1700 1701 1702 1703
	    insn->call_dest->type == STT_NOTYPE &&
	    !strcmp(insn->call_dest->name, "__fentry__"))
		return true;

	return false;
}

1704
static bool has_modified_stack_frame(struct instruction *insn, struct insn_state *state)
1705
{
1706
	u8 ret_offset = insn->ret_offset;
1707
	struct cfi_state *cfi = &state->cfi;
1708 1709
	int i;

1710
	if (cfi->cfa.base != initial_func_cfi.cfa.base || cfi->drap)
1711 1712
		return true;

1713
	if (cfi->cfa.offset != initial_func_cfi.cfa.offset + ret_offset)
1714 1715
		return true;

1716
	if (cfi->stack_size != initial_func_cfi.cfa.offset + ret_offset)
1717 1718
		return true;

1719 1720 1721 1722 1723 1724 1725 1726
	/*
	 * 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;

1727
	for (i = 0; i < CFI_NUM_REGS; i++) {
1728 1729
		if (cfi->regs[i].base != initial_func_cfi.regs[i].base ||
		    cfi->regs[i].offset != initial_func_cfi.regs[i].offset)
1730
			return true;
1731
	}
1732 1733 1734 1735 1736 1737

	return false;
}

static bool has_valid_stack_frame(struct insn_state *state)
{
1738 1739 1740 1741
	struct cfi_state *cfi = &state->cfi;

	if (cfi->cfa.base == CFI_BP && cfi->regs[CFI_BP].base == CFI_CFA &&
	    cfi->regs[CFI_BP].offset == -16)
1742 1743
		return true;

1744
	if (cfi->drap && cfi->regs[CFI_BP].base == CFI_BP)
1745 1746 1747
		return true;

	return false;
1748 1749
}

1750 1751
static int update_cfi_state_regs(struct instruction *insn,
				  struct cfi_state *cfi,
1752
				  struct stack_op *op)
1753
{
1754
	struct cfi_reg *cfa = &cfi->cfa;
1755

1756
	if (cfa->base != CFI_SP && cfa->base != CFI_SP_INDIRECT)
1757 1758 1759
		return 0;

	/* push */
P
Peter Zijlstra 已提交
1760
	if (op->dest.type == OP_DEST_PUSH || op->dest.type == OP_DEST_PUSHF)
1761 1762 1763
		cfa->offset += 8;

	/* pop */
P
Peter Zijlstra 已提交
1764
	if (op->src.type == OP_SRC_POP || op->src.type == OP_SRC_POPF)
1765 1766 1767 1768 1769 1770 1771 1772 1773 1774
		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;
}

1775
static void save_reg(struct cfi_state *cfi, unsigned char reg, int base, int offset)
1776
{
1777
	if (arch_callee_saved_reg(reg) &&
1778 1779 1780
	    cfi->regs[reg].base == CFI_UNDEFINED) {
		cfi->regs[reg].base = base;
		cfi->regs[reg].offset = offset;
1781
	}
1782 1783
}

1784
static void restore_reg(struct cfi_state *cfi, unsigned char reg)
1785
{
1786 1787
	cfi->regs[reg].base = initial_func_cfi.regs[reg].base;
	cfi->regs[reg].offset = initial_func_cfi.regs[reg].offset;
1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 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
}

/*
 * 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
 */
1843
static int update_cfi_state(struct instruction *insn, struct cfi_state *cfi,
1844
			     struct stack_op *op)
1845
{
1846 1847
	struct cfi_reg *cfa = &cfi->cfa;
	struct cfi_reg *regs = cfi->regs;
1848 1849 1850 1851 1852 1853 1854 1855 1856 1857

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

1858 1859
	if (cfi->type == UNWIND_HINT_TYPE_REGS ||
	    cfi->type == UNWIND_HINT_TYPE_REGS_PARTIAL)
1860
		return update_cfi_state_regs(insn, cfi, op);
1861

1862 1863 1864 1865 1866 1867
	switch (op->dest.type) {

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

		case OP_SRC_REG:
1868 1869 1870 1871 1872 1873 1874
			if (op->src.reg == CFI_SP && op->dest.reg == CFI_BP &&
			    cfa->base == CFI_SP &&
			    regs[CFI_BP].base == CFI_CFA &&
			    regs[CFI_BP].offset == -cfa->offset) {

				/* mov %rsp, %rbp */
				cfa->base = op->dest.reg;
1875
				cfi->bp_scratch = false;
1876
			}
1877

1878
			else if (op->src.reg == CFI_SP &&
1879
				 op->dest.reg == CFI_BP && cfi->drap) {
1880

1881 1882
				/* drap: mov %rsp, %rbp */
				regs[CFI_BP].base = CFI_BP;
1883 1884
				regs[CFI_BP].offset = -cfi->stack_size;
				cfi->bp_scratch = false;
1885
			}
1886

1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898
			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
				 */
1899 1900
				cfi->vals[op->dest.reg].base = CFI_CFA;
				cfi->vals[op->dest.reg].offset = -cfi->stack_size;
1901 1902
			}

J
Josh Poimboeuf 已提交
1903 1904 1905 1906 1907 1908 1909 1910
			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).
				 */
1911
				cfi->stack_size = -cfi->regs[CFI_BP].offset;
J
Josh Poimboeuf 已提交
1912 1913
			}

1914 1915 1916 1917
			else if (op->dest.reg == cfa->base) {

				/* mov %reg, %rsp */
				if (cfa->base == CFI_SP &&
1918
				    cfi->vals[op->src.reg].base == CFI_CFA) {
1919 1920 1921 1922 1923 1924 1925 1926 1927

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

				} else {
					cfa->base = CFI_UNDEFINED;
					cfa->offset = 0;
				}
1935 1936 1937 1938 1939 1940 1941 1942
			}

			break;

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

				/* add imm, %rsp */
1943
				cfi->stack_size -= op->src.offset;
1944 1945 1946 1947 1948 1949 1950 1951
				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 */
1952
				cfi->stack_size = -(op->src.offset + regs[CFI_BP].offset);
1953 1954 1955
				break;
			}

1956
			if (op->src.reg == CFI_SP && cfa->base == CFI_SP) {
1957 1958

				/* drap: lea disp(%rsp), %drap */
1959
				cfi->drap_reg = op->dest.reg;
1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970

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

1975 1976 1977
				break;
			}

1978 1979
			if (cfi->drap && op->dest.reg == CFI_SP &&
			    op->src.reg == cfi->drap_reg) {
1980 1981 1982

				 /* drap: lea disp(%drap), %rsp */
				cfa->base = CFI_SP;
1983 1984 1985
				cfa->offset = cfi->stack_size = -op->src.offset;
				cfi->drap_reg = CFI_UNDEFINED;
				cfi->drap = false;
1986 1987 1988
				break;
			}

1989
			if (op->dest.reg == cfi->cfa.base) {
1990 1991 1992 1993 1994 1995 1996 1997 1998
				WARN_FUNC("unsupported stack register modification",
					  insn->sec, insn->offset);
				return -1;
			}

			break;

		case OP_SRC_AND:
			if (op->dest.reg != CFI_SP ||
1999 2000
			    (cfi->drap_reg != CFI_UNDEFINED && cfa->base != CFI_SP) ||
			    (cfi->drap_reg == CFI_UNDEFINED && cfa->base != CFI_BP)) {
2001 2002 2003 2004 2005
				WARN_FUNC("unsupported stack pointer realignment",
					  insn->sec, insn->offset);
				return -1;
			}

2006
			if (cfi->drap_reg != CFI_UNDEFINED) {
2007
				/* drap: and imm, %rsp */
2008 2009 2010
				cfa->base = cfi->drap_reg;
				cfa->offset = cfi->stack_size = 0;
				cfi->drap = true;
2011 2012 2013 2014 2015 2016 2017 2018 2019 2020
			}

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

			break;

		case OP_SRC_POP:
P
Peter Zijlstra 已提交
2021
		case OP_SRC_POPF:
2022
			if (!cfi->drap && op->dest.reg == cfa->base) {
2023 2024 2025 2026 2027

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

2028 2029 2030
			if (cfi->drap && cfa->base == CFI_BP_INDIRECT &&
			    op->dest.reg == cfi->drap_reg &&
			    cfi->drap_offset == -cfi->stack_size) {
2031

2032
				/* drap: pop %drap */
2033
				cfa->base = cfi->drap_reg;
2034
				cfa->offset = 0;
2035
				cfi->drap_offset = -1;
2036

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

2039
				/* pop %reg */
2040
				restore_reg(cfi, op->dest.reg);
2041 2042
			}

2043
			cfi->stack_size -= 8;
2044 2045 2046 2047 2048 2049
			if (cfa->base == CFI_SP)
				cfa->offset -= 8;

			break;

		case OP_SRC_REG_INDIRECT:
2050 2051
			if (cfi->drap && op->src.reg == CFI_BP &&
			    op->src.offset == cfi->drap_offset) {
2052 2053

				/* drap: mov disp(%rbp), %drap */
2054
				cfa->base = cfi->drap_reg;
2055
				cfa->offset = 0;
2056
				cfi->drap_offset = -1;
2057 2058
			}

2059
			if (cfi->drap && op->src.reg == CFI_BP &&
2060 2061 2062
			    op->src.offset == regs[op->dest.reg].offset) {

				/* drap: mov disp(%rbp), %reg */
2063
				restore_reg(cfi, op->dest.reg);
2064 2065 2066 2067 2068 2069

			} 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 */
2070
				restore_reg(cfi, op->dest.reg);
2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083
			}

			break;

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

		break;

	case OP_DEST_PUSH:
P
Peter Zijlstra 已提交
2084
	case OP_DEST_PUSHF:
2085
		cfi->stack_size += 8;
2086 2087 2088 2089 2090 2091
		if (cfa->base == CFI_SP)
			cfa->offset += 8;

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

2092 2093
		if (cfi->drap) {
			if (op->src.reg == cfa->base && op->src.reg == cfi->drap_reg) {
2094 2095 2096

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

2099
				/* save drap so we know when to restore it */
2100
				cfi->drap_offset = -cfi->stack_size;
2101

2102
			} else if (op->src.reg == CFI_BP && cfa->base == cfi->drap_reg) {
2103 2104

				/* drap: push %rbp */
2105
				cfi->stack_size = 0;
2106

2107
			} else {
2108 2109

				/* drap: push %reg */
2110
				save_reg(cfi, op->src.reg, CFI_BP, -cfi->stack_size);
2111 2112 2113 2114 2115
			}

		} else {

			/* push %reg */
2116
			save_reg(cfi, op->src.reg, CFI_CFA, -cfi->stack_size);
2117 2118 2119
		}

		/* detect when asm code uses rbp as a scratch register */
2120
		if (!no_fp && insn->func && op->src.reg == CFI_BP &&
2121
		    cfa->base != CFI_BP)
2122
			cfi->bp_scratch = true;
2123 2124 2125 2126
		break;

	case OP_DEST_REG_INDIRECT:

2127 2128
		if (cfi->drap) {
			if (op->src.reg == cfa->base && op->src.reg == cfi->drap_reg) {
2129 2130 2131 2132 2133

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

2134
				/* save drap offset so we know when to restore it */
2135
				cfi->drap_offset = op->dest.offset;
2136
			} else {
2137 2138

				/* drap: mov reg, disp(%rbp) */
2139
				save_reg(cfi, op->src.reg, CFI_BP, op->dest.offset);
2140 2141 2142 2143 2144 2145
			}

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

			/* mov reg, disp(%rbp) */
			/* mov reg, disp(%rsp) */
2146 2147
			save_reg(cfi, op->src.reg, CFI_CFA,
				 op->dest.offset - cfi->cfa.offset);
2148 2149 2150 2151 2152
		}

		break;

	case OP_DEST_LEAVE:
2153 2154
		if ((!cfi->drap && cfa->base != CFI_BP) ||
		    (cfi->drap && cfa->base != cfi->drap_reg)) {
2155 2156 2157 2158 2159 2160 2161
			WARN_FUNC("leave instruction with modified stack frame",
				  insn->sec, insn->offset);
			return -1;
		}

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

2162 2163
		cfi->stack_size = -cfi->regs[CFI_BP].offset - 8;
		restore_reg(cfi, CFI_BP);
2164

2165
		if (!cfi->drap) {
2166 2167 2168 2169 2170 2171 2172
			cfa->base = CFI_SP;
			cfa->offset -= 8;
		}

		break;

	case OP_DEST_MEM:
P
Peter Zijlstra 已提交
2173
		if (op->src.type != OP_SRC_POP && op->src.type != OP_SRC_POPF) {
2174 2175 2176 2177 2178 2179
			WARN_FUNC("unknown stack-related memory operation",
				  insn->sec, insn->offset);
			return -1;
		}

		/* pop mem */
2180
		cfi->stack_size -= 8;
2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194
		if (cfa->base == CFI_SP)
			cfa->offset -= 8;

		break;

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

	return 0;
}

2195 2196 2197 2198 2199
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) {
2200
		struct cfi_state old_cfi = state->cfi;
2201 2202
		int res;

2203
		res = update_cfi_state(insn, &state->cfi, op);
2204 2205 2206
		if (res)
			return res;

2207 2208 2209 2210 2211
		if (insn->alt_group && memcmp(&state->cfi, &old_cfi, sizeof(struct cfi_state))) {
			WARN_FUNC("alternative modifies stack", insn->sec, insn->offset);
			return -1;
		}

2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236
		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;
}

2237
static bool insn_cfi_match(struct instruction *insn, struct cfi_state *cfi2)
2238
{
2239
	struct cfi_state *cfi1 = &insn->cfi;
2240 2241
	int i;

2242 2243
	if (memcmp(&cfi1->cfa, &cfi2->cfa, sizeof(cfi1->cfa))) {

2244 2245
		WARN_FUNC("stack state mismatch: cfa1=%d%+d cfa2=%d%+d",
			  insn->sec, insn->offset,
2246 2247
			  cfi1->cfa.base, cfi1->cfa.offset,
			  cfi2->cfa.base, cfi2->cfa.offset);
2248

2249
	} else if (memcmp(&cfi1->regs, &cfi2->regs, sizeof(cfi1->regs))) {
2250
		for (i = 0; i < CFI_NUM_REGS; i++) {
2251
			if (!memcmp(&cfi1->regs[i], &cfi2->regs[i],
2252 2253 2254 2255 2256
				    sizeof(struct cfi_reg)))
				continue;

			WARN_FUNC("stack state mismatch: reg1[%d]=%d%+d reg2[%d]=%d%+d",
				  insn->sec, insn->offset,
2257 2258
				  i, cfi1->regs[i].base, cfi1->regs[i].offset,
				  i, cfi2->regs[i].base, cfi2->regs[i].offset);
2259 2260 2261
			break;
		}

2262 2263
	} else if (cfi1->type != cfi2->type) {

2264
		WARN_FUNC("stack state mismatch: type1=%d type2=%d",
2265 2266 2267 2268 2269
			  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)) {
2270

2271
		WARN_FUNC("stack state mismatch: drap1=%d(%d,%d) drap2=%d(%d,%d)",
2272
			  insn->sec, insn->offset,
2273 2274
			  cfi1->drap, cfi1->drap_reg, cfi1->drap_offset,
			  cfi2->drap, cfi2->drap_reg, cfi2->drap_offset);
2275 2276 2277 2278 2279

	} else
		return true;

	return false;
2280 2281
}

P
Peter Zijlstra 已提交
2282 2283 2284
static inline bool func_uaccess_safe(struct symbol *func)
{
	if (func)
2285
		return func->uaccess_safe;
P
Peter Zijlstra 已提交
2286 2287 2288 2289

	return false;
}

2290
static inline const char *call_dest_name(struct instruction *insn)
P
Peter Zijlstra 已提交
2291 2292 2293 2294 2295 2296 2297
{
	if (insn->call_dest)
		return insn->call_dest->name;

	return "{dynamic}";
}

2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323
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 已提交
2324 2325
static int validate_call(struct instruction *insn, struct insn_state *state)
{
2326
	if (state->noinstr && state->instr <= 0 &&
2327
	    !noinstr_call_dest(insn->call_dest)) {
2328 2329 2330 2331 2332
		WARN_FUNC("call to %s() leaves .noinstr.text section",
				insn->sec, insn->offset, call_dest_name(insn));
		return 1;
	}

P
Peter Zijlstra 已提交
2333 2334
	if (state->uaccess && !func_uaccess_safe(insn->call_dest)) {
		WARN_FUNC("call to %s() with UACCESS enabled",
2335
				insn->sec, insn->offset, call_dest_name(insn));
P
Peter Zijlstra 已提交
2336 2337 2338
		return 1;
	}

2339 2340
	if (state->df) {
		WARN_FUNC("call to %s() with DF set",
2341
				insn->sec, insn->offset, call_dest_name(insn));
2342 2343 2344
		return 1;
	}

P
Peter Zijlstra 已提交
2345 2346 2347
	return 0;
}

2348 2349
static int validate_sibling_call(struct instruction *insn, struct insn_state *state)
{
2350
	if (has_modified_stack_frame(insn, state)) {
2351 2352 2353 2354 2355
		WARN_FUNC("sibling call from callable instruction with modified stack frame",
				insn->sec, insn->offset);
		return 1;
	}

P
Peter Zijlstra 已提交
2356
	return validate_call(insn, state);
2357 2358
}

2359 2360
static int validate_return(struct symbol *func, struct instruction *insn, struct insn_state *state)
{
2361 2362 2363 2364 2365 2366
	if (state->noinstr && state->instr > 0) {
		WARN_FUNC("return with instrumentation enabled",
			  insn->sec, insn->offset);
		return 1;
	}

2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384
	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;
	}

2385
	if (func && has_modified_stack_frame(insn, state)) {
2386 2387 2388 2389 2390
		WARN_FUNC("return with modified stack frame",
			  insn->sec, insn->offset);
		return 1;
	}

2391
	if (state->cfi.bp_scratch) {
2392 2393
		WARN_FUNC("BP used as a scratch register",
			  insn->sec, insn->offset);
2394 2395 2396 2397 2398 2399
		return 1;
	}

	return 0;
}

2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423
/*
 * Alternatives should not contain any ORC entries, this in turn means they
 * should not contain any CFI ops, which implies all instructions should have
 * the same same CFI state.
 *
 * It is possible to constuct alternatives that have unreachable holes that go
 * unreported (because they're NOPs), such holes would result in CFI_UNDEFINED
 * states which then results in ORC entries, which we just said we didn't want.
 *
 * Avoid them by copying the CFI entry of the first instruction into the whole
 * alternative.
 */
static void fill_alternative_cfi(struct objtool_file *file, struct instruction *insn)
{
	struct instruction *first_insn = insn;
	int alt_group = insn->alt_group;

	sec_for_each_insn_continue(file, insn) {
		if (insn->alt_group != alt_group)
			break;
		insn->cfi = first_insn->cfi;
	}
}

2424 2425 2426 2427 2428 2429
/*
 * 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.
 */
2430
static int validate_branch(struct objtool_file *file, struct symbol *func,
P
Peter Zijlstra 已提交
2431
			   struct instruction *insn, struct insn_state state)
2432 2433
{
	struct alternative *alt;
P
Peter Zijlstra 已提交
2434
	struct instruction *next_insn;
2435
	struct section *sec;
2436
	u8 visited;
2437 2438 2439 2440 2441
	int ret;

	sec = insn->sec;

	while (1) {
2442 2443
		next_insn = next_insn_same_sec(file, insn);

2444
		if (file->c_file && func && insn->func && func != insn->func->pfunc) {
2445 2446 2447
			WARN("%s() falls through to next function %s()",
			     func->name, insn->func->name);
			return 1;
2448 2449
		}

2450 2451 2452
		if (func && insn->ignore) {
			WARN_FUNC("BUG: why am I validating an ignored function?",
				  sec, insn->offset);
2453
			return 1;
2454 2455
		}

2456
		visited = 1 << state.uaccess;
2457
		if (insn->visited) {
2458
			if (!insn->hint && !insn_cfi_match(insn, &state.cfi))
2459 2460
				return 1;

2461
			if (insn->visited & visited)
P
Peter Zijlstra 已提交
2462
				return 0;
2463 2464
		}

2465 2466 2467
		if (state.noinstr)
			state.instr += insn->instr;

2468
		if (insn->hint)
2469
			state.cfi = insn->cfi;
2470
		else
2471
			insn->cfi = state.cfi;
2472

2473
		insn->visited |= visited;
2474

2475
		if (!insn->ignore_alts && !list_empty(&insn->alts)) {
P
Peter Zijlstra 已提交
2476 2477
			bool skip_orig = false;

2478
			list_for_each_entry(alt, &insn->alts, list) {
P
Peter Zijlstra 已提交
2479 2480 2481
				if (alt->skip_orig)
					skip_orig = true;

2482
				ret = validate_branch(file, func, alt->insn, state);
2483 2484 2485 2486 2487
				if (ret) {
					if (backtrace)
						BT_FUNC("(alt)", insn);
					return ret;
				}
2488
			}
P
Peter Zijlstra 已提交
2489

2490 2491 2492
			if (insn->alt_group)
				fill_alternative_cfi(file, insn);

P
Peter Zijlstra 已提交
2493 2494
			if (skip_orig)
				return 0;
2495 2496
		}

2497 2498 2499
		if (handle_insn_ops(insn, &state))
			return 1;

2500 2501 2502
		switch (insn->type) {

		case INSN_RETURN:
2503
			return validate_return(func, insn, &state);
2504 2505

		case INSN_CALL:
P
Peter Zijlstra 已提交
2506 2507 2508 2509
		case INSN_CALL_DYNAMIC:
			ret = validate_call(insn, &state);
			if (ret)
				return ret;
2510

2511 2512
			if (!no_fp && func && !is_fentry_call(insn) &&
			    !has_valid_stack_frame(&state)) {
2513 2514 2515 2516
				WARN_FUNC("call without frame pointer save/setup",
					  sec, insn->offset);
				return 1;
			}
2517 2518 2519 2520

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

2521 2522 2523 2524 2525
			if (insn->type == INSN_CALL && insn->call_dest->static_call_tramp) {
				list_add_tail(&insn->static_call_node,
					      &file->static_call_list);
			}

2526 2527 2528 2529
			break;

		case INSN_JUMP_CONDITIONAL:
		case INSN_JUMP_UNCONDITIONAL:
2530
			if (func && is_sibling_call(insn)) {
2531
				ret = validate_sibling_call(insn, &state);
2532
				if (ret)
2533
					return ret;
2534

2535
			} else if (insn->jump_dest) {
2536 2537
				ret = validate_branch(file, func,
						      insn->jump_dest, state);
2538 2539 2540 2541 2542
				if (ret) {
					if (backtrace)
						BT_FUNC("(branch)", insn);
					return ret;
				}
2543
			}
2544 2545 2546 2547 2548 2549 2550

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

			break;

		case INSN_JUMP_DYNAMIC:
2551
		case INSN_JUMP_DYNAMIC_CONDITIONAL:
2552
			if (func && is_sibling_call(insn)) {
2553 2554 2555
				ret = validate_sibling_call(insn, &state);
				if (ret)
					return ret;
2556 2557
			}

2558 2559 2560 2561
			if (insn->type == INSN_JUMP_DYNAMIC)
				return 0;

			break;
2562

2563 2564 2565 2566 2567 2568 2569 2570
		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 已提交
2571 2572 2573 2574 2575 2576 2577 2578 2579 2580
		case INSN_STAC:
			if (state.uaccess) {
				WARN_FUNC("recursive UACCESS enable", sec, insn->offset);
				return 1;
			}

			state.uaccess = true;
			break;

		case INSN_CLAC:
2581
			if (!state.uaccess && func) {
P
Peter Zijlstra 已提交
2582 2583 2584 2585 2586 2587 2588 2589 2590 2591
				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;
2592 2593
			break;

2594 2595 2596 2597 2598 2599 2600 2601
		case INSN_STD:
			if (state.df)
				WARN_FUNC("recursive STD", sec, insn->offset);

			state.df = true;
			break;

		case INSN_CLD:
2602
			if (!state.df && func)
2603 2604 2605
				WARN_FUNC("redundant CLD", sec, insn->offset);

			state.df = false;
2606 2607
			break;

2608 2609 2610 2611 2612 2613 2614
		default:
			break;
		}

		if (insn->dead_end)
			return 0;

2615
		if (!next_insn) {
2616
			if (state.cfi.cfa.base == CFI_UNDEFINED)
2617
				return 0;
2618 2619 2620
			WARN("%s: unexpected end of section", sec->name);
			return 1;
		}
2621 2622

		insn = next_insn;
2623 2624 2625 2626 2627
	}

	return 0;
}

2628
static int validate_unwind_hints(struct objtool_file *file, struct section *sec)
2629 2630 2631
{
	struct instruction *insn;
	struct insn_state state;
2632
	int ret, warnings = 0;
2633 2634 2635 2636

	if (!file->hints)
		return 0;

2637
	init_insn_state(&state, sec);
2638

2639 2640 2641 2642 2643 2644 2645 2646 2647
	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)) {
2648
		if (insn->hint && !insn->visited) {
2649
			ret = validate_branch(file, insn->func, insn, state);
2650 2651
			if (ret && backtrace)
				BT_FUNC("<=== (hint)", insn);
2652 2653
			warnings += ret;
		}
2654 2655

		insn = list_next_entry(insn, list);
2656 2657 2658 2659 2660
	}

	return warnings;
}

2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673
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;

2674 2675 2676 2677 2678 2679 2680 2681 2682
		/*
		 * .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;

2683 2684 2685 2686 2687 2688 2689 2690 2691 2692
		WARN_FUNC("indirect %s found in RETPOLINE build",
			  insn->sec, insn->offset,
			  insn->type == INSN_JUMP_DYNAMIC ? "jump" : "call");

		warnings++;
	}

	return warnings;
}

2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705
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"));
}

2706
static bool ignore_unreachable_insn(struct objtool_file *file, struct instruction *insn)
2707 2708
{
	int i;
2709
	struct instruction *prev_insn;
2710

2711 2712 2713 2714 2715 2716
	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.
2717 2718 2719
	 *
	 * Also ignore alternative replacement instructions.  This can happen
	 * when a whitelisted function uses one of the ALTERNATIVE macros.
2720
	 */
2721 2722 2723
	if (!strcmp(insn->sec->name, ".fixup") ||
	    !strcmp(insn->sec->name, ".altinstr_replacement") ||
	    !strcmp(insn->sec->name, ".altinstr_aux"))
2724 2725
		return true;

2726 2727 2728
	if (insn->type == INSN_JUMP_UNCONDITIONAL && insn->offset == FAKE_JUMP_OFFSET)
		return true;

2729 2730 2731 2732 2733 2734 2735 2736
	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).
2737 2738
	 *
	 * It may also insert a UD2 after calling a __noreturn function.
2739
	 */
2740 2741
	prev_insn = list_prev_entry(insn, list);
	if ((prev_insn->dead_end || dead_end_function(file, prev_insn->call_dest)) &&
2742 2743 2744 2745 2746
	    (insn->type == INSN_BUG ||
	     (insn->type == INSN_JUMP_UNCONDITIONAL &&
	      insn->jump_dest && insn->jump_dest->type == INSN_BUG)))
		return true;

2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757
	/*
	 * 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;

2758 2759 2760 2761 2762 2763 2764 2765
		if (insn->type == INSN_JUMP_UNCONDITIONAL) {
			if (insn->jump_dest &&
			    insn->jump_dest->func == insn->func) {
				insn = insn->jump_dest;
				continue;
			}

			break;
2766 2767
		}

2768
		if (insn->offset + insn->len >= insn->func->offset + insn->func->len)
2769
			break;
2770

2771 2772 2773 2774 2775 2776
		insn = list_next_entry(insn, list);
	}

	return false;
}

2777 2778
static int validate_symbol(struct objtool_file *file, struct section *sec,
			   struct symbol *sym, struct insn_state *state)
2779 2780
{
	struct instruction *insn;
2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804
	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)
{
2805
	struct insn_state state;
2806 2807
	struct symbol *func;
	int warnings = 0;
2808

2809 2810 2811
	list_for_each_entry(func, &sec->symbol_list, list) {
		if (func->type != STT_FUNC)
			continue;
2812

2813
		init_insn_state(&state, sec);
2814 2815
		state.cfi.cfa = initial_func_cfi.cfa;
		memcpy(&state.cfi.regs, &initial_func_cfi.regs,
2816
		       CFI_NUM_REGS * sizeof(struct cfi_reg));
2817
		state.cfi.stack_size = initial_func_cfi.cfa.offset;
2818

2819
		warnings += validate_symbol(file, sec, func, &state);
2820 2821 2822 2823 2824
	}

	return warnings;
}

2825 2826 2827
static int validate_vmlinux_functions(struct objtool_file *file)
{
	struct section *sec;
2828
	int warnings = 0;
2829 2830

	sec = find_section_by_name(file->elf, ".noinstr.text");
2831 2832 2833 2834
	if (sec) {
		warnings += validate_section(file, sec);
		warnings += validate_unwind_hints(file, sec);
	}
2835

2836 2837 2838 2839 2840
	sec = find_section_by_name(file->elf, ".entry.text");
	if (sec) {
		warnings += validate_section(file, sec);
		warnings += validate_unwind_hints(file, sec);
	}
2841 2842

	return warnings;
2843 2844
}

2845 2846 2847 2848 2849
static int validate_functions(struct objtool_file *file)
{
	struct section *sec;
	int warnings = 0;

2850 2851 2852 2853
	for_each_sec(file, sec) {
		if (!(sec->sh.sh_flags & SHF_EXECINSTR))
			continue;

2854
		warnings += validate_section(file, sec);
2855
	}
2856 2857 2858 2859

	return warnings;
}

2860
static int validate_reachable_instructions(struct objtool_file *file)
2861 2862
{
	struct instruction *insn;
2863 2864 2865

	if (file->ignore_unreachables)
		return 0;
2866 2867

	for_each_insn(file, insn) {
2868
		if (insn->visited || ignore_unreachable_insn(file, insn))
2869 2870 2871 2872
			continue;

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

2875
	return 0;
2876 2877
}

2878
int check(struct objtool_file *file)
2879 2880 2881
{
	int ret, warnings = 0;

2882 2883
	arch_initial_func_cfi_state(&initial_func_cfi);

2884
	ret = decode_sections(file);
2885 2886 2887 2888
	if (ret < 0)
		goto out;
	warnings += ret;

2889
	if (list_empty(&file->insn_list))
2890 2891
		goto out;

2892
	if (vmlinux && !validate_dup) {
2893
		ret = validate_vmlinux_functions(file);
2894 2895 2896 2897 2898 2899 2900
		if (ret < 0)
			goto out;

		warnings += ret;
		goto out;
	}

2901
	if (retpoline) {
2902
		ret = validate_retpoline(file);
2903 2904 2905 2906 2907
		if (ret < 0)
			return ret;
		warnings += ret;
	}

2908
	ret = validate_functions(file);
2909 2910 2911 2912
	if (ret < 0)
		goto out;
	warnings += ret;

2913
	ret = validate_unwind_hints(file, NULL);
2914 2915 2916 2917
	if (ret < 0)
		goto out;
	warnings += ret;

2918
	if (!warnings) {
2919
		ret = validate_reachable_instructions(file);
2920 2921 2922 2923 2924
		if (ret < 0)
			goto out;
		warnings += ret;
	}

2925
	ret = create_static_call_sections(file);
2926 2927 2928 2929
	if (ret < 0)
		goto out;
	warnings += ret;

2930
out:
2931 2932 2933 2934 2935 2936 2937 2938 2939
	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;
	}

2940 2941
	return 0;
}