check.c 70.2 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
		"xen_start_kernel",
160
		"cpu_bringup_and_idle",
161 162
	};

163 164 165
	if (!func)
		return false;

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

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

174
	if (!func->len)
175
		return false;
176

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

181
	func_for_each_insn(file, func, insn) {
182 183 184
		empty = false;

		if (insn->type == INSN_RETURN)
185
			return false;
186 187 188
	}

	if (empty)
189
		return false;
190 191 192 193 194 195

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

			if (!dest)
				/* sibling call to another file */
202
				return false;
203

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

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

218
	return true;
219 220
}

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

226
static void init_cfi_state(struct cfi_state *cfi)
227 228 229
{
	int i;

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

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

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

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

266
	for_each_sec(file, sec) {
267 268 269 270

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

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

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

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

291 292 293 294 295 296
			insn->sec = sec;
			insn->offset = offset;

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

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

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

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

317
			sym_for_each_insn(file, func, insn)
318
				insn->func = func;
319 320 321
		}
	}

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

325
	return 0;
326 327 328 329

err:
	free(insn);
	return ret;
330 331
}

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

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

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

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

		insn->dead_end = true;
	}

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

		insn->dead_end = false;
	}

428 429 430
	return 0;
}

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 470 471
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));
472

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

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

486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
		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) {
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
			if (!module) {
				WARN("static_call: can't find static_call_key symbol: %s", tmp);
				return -1;
			}

			/*
			 * For modules(), the key might not be exported, which
			 * means the module can make static calls but isn't
			 * allowed to change them.
			 *
			 * In that case we temporarily set the key to be the
			 * trampoline address.  This is fixed up in
			 * static_call_add_module().
			 */
			key_sym = insn->call_dest;
522 523 524 525 526 527 528 529 530 531 532
		}
		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 已提交
533
		reloc->addend = is_sibling_call(insn) ? STATIC_CALL_SITE_TAIL : 0;
534 535 536 537 538 539 540 541 542 543 544 545 546 547
		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;
}

548 549 550 551 552 553 554 555
/*
 * 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 已提交
556
	struct reloc *reloc;
557

P
Peter Zijlstra 已提交
558 559 560
	sec = find_section_by_name(file->elf, ".rela.discard.func_stack_frame_non_standard");
	if (!sec)
		return;
561

M
Matt Helsley 已提交
562 563
	list_for_each_entry(reloc, &sec->reloc_list, list) {
		switch (reloc->sym->type) {
P
Peter Zijlstra 已提交
564
		case STT_FUNC:
M
Matt Helsley 已提交
565
			func = reloc->sym;
P
Peter Zijlstra 已提交
566 567 568
			break;

		case STT_SECTION:
M
Matt Helsley 已提交
569
			func = find_func_by_offset(reloc->sym->sec, reloc->addend);
570
			if (!func)
571
				continue;
P
Peter Zijlstra 已提交
572
			break;
573

P
Peter Zijlstra 已提交
574
		default:
M
Matt Helsley 已提交
575
			WARN("unexpected relocation symbol type in %s: %d", sec->name, reloc->sym->type);
P
Peter Zijlstra 已提交
576
			continue;
577
		}
P
Peter Zijlstra 已提交
578

579
		func_for_each_insn(file, func, insn)
P
Peter Zijlstra 已提交
580
			insn->ignore = true;
581 582 583
	}
}

P
Peter Zijlstra 已提交
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607
/*
 * 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",
608 609
	"__kasan_check_read",
	"__kasan_check_write",
P
Peter Zijlstra 已提交
610 611 612 613 614 615 616 617 618 619 620 621 622
	/* 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",
623
	/* KCSAN */
624
	"__kcsan_check_access",
625 626
	"kcsan_found_watchpoint",
	"kcsan_setup_watchpoint",
627
	"kcsan_check_scoped_accesses",
628 629
	"kcsan_disable_current",
	"kcsan_enable_current_nowarn",
630 631 632 633 634 635 636 637 638 639 640 641 642 643 644
	/* 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",
645 646 647 648 649
	"__tsan_read_write1",
	"__tsan_read_write2",
	"__tsan_read_write4",
	"__tsan_read_write8",
	"__tsan_read_write16",
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 689 690 691 692 693 694 695 696 697 698 699
	"__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 已提交
700 701
	/* KCOV */
	"write_comp_data",
702
	"check_kcov_mode",
P
Peter Zijlstra 已提交
703 704 705 706 707 708 709 710 711
	"__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",
712
	"__sanitizer_cov_trace_switch",
P
Peter Zijlstra 已提交
713 714 715 716
	/* UBSAN */
	"ubsan_type_mismatch_common",
	"__ubsan_handle_type_mismatch",
	"__ubsan_handle_type_mismatch_v1",
717
	"__ubsan_handle_shift_out_of_bounds",
P
Peter Zijlstra 已提交
718 719
	/* misc */
	"csum_partial_copy_generic",
720 721
	"copy_mc_fragile",
	"copy_mc_fragile_handle_tail",
722
	"copy_mc_enhanced_fast_string",
P
Peter Zijlstra 已提交
723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739
	"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;

740
		func->uaccess_safe = true;
741 742 743
	}
}

744 745 746 747 748 749
/*
 * 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.
 */
750
static int add_ignore_alternatives(struct objtool_file *file)
751 752
{
	struct section *sec;
M
Matt Helsley 已提交
753
	struct reloc *reloc;
754 755
	struct instruction *insn;

756
	sec = find_section_by_name(file->elf, ".rela.discard.ignore_alts");
757 758 759
	if (!sec)
		return 0;

M
Matt Helsley 已提交
760 761
	list_for_each_entry(reloc, &sec->reloc_list, list) {
		if (reloc->sym->type != STT_SECTION) {
762 763 764 765
			WARN("unexpected relocation symbol type in %s", sec->name);
			return -1;
		}

M
Matt Helsley 已提交
766
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
767
		if (!insn) {
768
			WARN("bad .discard.ignore_alts entry");
769 770 771 772 773 774 775 776 777
			return -1;
		}

		insn->ignore_alts = true;
	}

	return 0;
}

778 779 780 781 782 783
/*
 * Find the destination instructions for all jumps.
 */
static int add_jump_destinations(struct objtool_file *file)
{
	struct instruction *insn;
M
Matt Helsley 已提交
784
	struct reloc *reloc;
785 786 787 788
	struct section *dest_sec;
	unsigned long dest_off;

	for_each_insn(file, insn) {
789
		if (!is_static_jump(insn))
790 791
			continue;

792
		if (insn->offset == FAKE_JUMP_OFFSET)
793 794
			continue;

M
Matt Helsley 已提交
795
		reloc = find_reloc_by_dest_range(file->elf, insn->sec,
796
					       insn->offset, insn->len);
M
Matt Helsley 已提交
797
		if (!reloc) {
798
			dest_sec = insn->sec;
799
			dest_off = arch_jump_destination(insn);
M
Matt Helsley 已提交
800 801 802 803 804 805 806
		} 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);
807 808
		} else if (!strncmp(reloc->sym->name, "__x86_indirect_thunk_", 21) ||
			   !strncmp(reloc->sym->name, "__x86_retpoline_", 16)) {
809 810 811 812
			/*
			 * Retpoline jumps are really dynamic jumps in
			 * disguise, so convert them accordingly.
			 */
813 814 815 816 817
			if (insn->type == INSN_JUMP_UNCONDITIONAL)
				insn->type = INSN_JUMP_DYNAMIC;
			else
				insn->type = INSN_JUMP_DYNAMIC_CONDITIONAL;

818
			insn->retpoline_safe = true;
819
			continue;
820
		} else {
821
			/* external sibling call */
M
Matt Helsley 已提交
822
			insn->call_dest = reloc->sym;
P
Peter Zijlstra 已提交
823 824 825 826
			if (insn->call_dest->static_call_tramp) {
				list_add_tail(&insn->static_call_node,
					      &file->static_call_list);
			}
827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845
			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;
		}
846 847

		/*
848
		 * Cross-function jump.
849 850
		 */
		if (insn->func && insn->jump_dest->func &&
851 852 853 854 855 856 857 858 859 860 861 862 863 864 865
		    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
866
			 * subfunction is through a jump table.
867
			 */
868 869
			if (!strstr(insn->func->name, ".cold") &&
			    strstr(insn->jump_dest->func->name, ".cold")) {
870 871 872 873 874 875
				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) {

876
				/* internal sibling call */
877
				insn->call_dest = insn->jump_dest->func;
P
Peter Zijlstra 已提交
878 879 880 881
				if (insn->call_dest->static_call_tramp) {
					list_add_tail(&insn->static_call_node,
						      &file->static_call_list);
				}
882
			}
883
		}
884 885 886 887 888
	}

	return 0;
}

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

899 900 901 902 903 904 905 906 907 908 909
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;
}

910 911 912 913 914 915 916
/*
 * 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 已提交
917
	struct reloc *reloc;
918 919 920 921 922

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

M
Matt Helsley 已提交
923
		reloc = find_reloc_by_dest_range(file->elf, insn->sec,
924
					       insn->offset, insn->len);
M
Matt Helsley 已提交
925
		if (!reloc) {
926
			dest_off = arch_jump_destination(insn);
927
			insn->call_dest = find_call_destination(insn->sec, dest_off);
928

929 930 931 932
			if (insn->ignore)
				continue;

			if (!insn->call_dest) {
933
				WARN_FUNC("unannotated intra-function call", insn->sec, insn->offset);
934 935
				return -1;
			}
936

937 938 939 940 941 942
			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 已提交
943 944
		} else if (reloc->sym->type == STT_SECTION) {
			dest_off = arch_dest_reloc_offset(reloc->addend);
945 946
			insn->call_dest = find_call_destination(reloc->sym->sec,
								dest_off);
947
			if (!insn->call_dest) {
948
				WARN_FUNC("can't find call dest symbol at %s+0x%lx",
949
					  insn->sec, insn->offset,
M
Matt Helsley 已提交
950
					  reloc->sym->sec->name,
951
					  dest_off);
952 953 954
				return -1;
			}
		} else
M
Matt Helsley 已提交
955
			insn->call_dest = reloc->sym;
956

957 958 959 960 961
		if (insn->call_dest && insn->call_dest->static_call_tramp) {
			list_add_tail(&insn->static_call_node,
				      &file->static_call_list);
		}

P
Peter Zijlstra 已提交
962 963 964 965 966 967 968
		/*
		 * 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)) {
969 970 971
			if (reloc) {
				reloc->type = R_NONE;
				elf_write_reloc(file->elf, reloc);
P
Peter Zijlstra 已提交
972 973 974 975 976 977 978 979
			}

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

980 981 982 983 984 985 986 987
		/*
		 * 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);
988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
	}

	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)
{
1015
	struct instruction *last_orig_insn, *last_new_insn, *insn, *fake_jump = NULL;
J
Josh Poimboeuf 已提交
1016
	struct alt_group *orig_alt_group, *new_alt_group;
1017 1018
	unsigned long dest_off;

J
Josh Poimboeuf 已提交
1019 1020 1021 1022 1023 1024

	orig_alt_group = malloc(sizeof(*orig_alt_group));
	if (!orig_alt_group) {
		WARN("malloc failed");
		return -1;
	}
1025 1026 1027 1028 1029 1030
	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 已提交
1031
		insn->alt_group = orig_alt_group;
1032 1033
		last_orig_insn = insn;
	}
J
Josh Poimboeuf 已提交
1034 1035 1036
	orig_alt_group->orig_group = NULL;
	orig_alt_group->first_insn = orig_insn;
	orig_alt_group->last_insn = last_orig_insn;
1037

1038 1039 1040 1041 1042 1043 1044 1045
	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);
1046
		INIT_LIST_HEAD(&fake_jump->stack_ops);
1047
		init_cfi_state(&fake_jump->cfi);
1048 1049

		fake_jump->sec = special_alt->new_sec;
1050
		fake_jump->offset = FAKE_JUMP_OFFSET;
1051 1052
		fake_jump->type = INSN_JUMP_UNCONDITIONAL;
		fake_jump->jump_dest = list_next_entry(last_orig_insn, list);
1053
		fake_jump->func = orig_insn->func;
1054 1055 1056
	}

	if (!special_alt->new_len) {
1057 1058 1059 1060 1061 1062
		if (!fake_jump) {
			WARN("%s: empty alternative at end of section",
			     special_alt->orig_sec->name);
			return -1;
		}

1063 1064 1065 1066
		*new_insn = fake_jump;
		return 0;
	}

J
Josh Poimboeuf 已提交
1067 1068 1069 1070 1071 1072
	new_alt_group = malloc(sizeof(*new_alt_group));
	if (!new_alt_group) {
		WARN("malloc failed");
		return -1;
	}

1073 1074 1075
	last_new_insn = NULL;
	insn = *new_insn;
	sec_for_each_insn_from(file, insn) {
1076 1077
		struct reloc *alt_reloc;

1078 1079 1080 1081 1082
		if (insn->offset >= special_alt->new_off + special_alt->new_len)
			break;

		last_new_insn = insn;

1083
		insn->ignore = orig_insn->ignore_alts;
1084
		insn->func = orig_insn->func;
J
Josh Poimboeuf 已提交
1085
		insn->alt_group = new_alt_group;
1086

1087 1088 1089 1090 1091 1092 1093 1094
		/*
		 * 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.
		 */
1095 1096 1097 1098
		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)) {
1099 1100 1101 1102 1103 1104

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

1105
		if (!is_static_jump(insn))
1106 1107 1108 1109 1110
			continue;

		if (!insn->immediate)
			continue;

1111
		dest_off = arch_jump_destination(insn);
1112 1113 1114 1115 1116 1117
		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;
			}
1118
			insn->jump_dest = fake_jump;
1119
		}
1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133

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

J
Josh Poimboeuf 已提交
1134 1135 1136 1137
	new_alt_group->orig_group = orig_alt_group;
	new_alt_group->first_insn = *new_insn;
	new_alt_group->last_insn = last_new_insn;

1138 1139
	if (fake_jump)
		list_add(&fake_jump->list, &last_new_insn->list);
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 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209

	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) {
1210 1211 1212 1213 1214 1215
			if (!special_alt->orig_len) {
				WARN_FUNC("empty alternative entry",
					  orig_insn->sec, orig_insn->offset);
				continue;
			}

1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226
			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;
		}

1227 1228 1229 1230 1231 1232 1233
		alt = malloc(sizeof(*alt));
		if (!alt) {
			WARN("malloc failed");
			ret = -1;
			goto out;
		}

1234
		alt->insn = new_insn;
P
Peter Zijlstra 已提交
1235
		alt->skip_orig = special_alt->skip_orig;
P
Peter Zijlstra 已提交
1236
		orig_insn->ignore_alts |= special_alt->skip_alt;
1237 1238 1239 1240 1241 1242 1243 1244 1245 1246
		list_add_tail(&alt->list, &orig_insn->alts);

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

out:
	return ret;
}

1247
static int add_jump_table(struct objtool_file *file, struct instruction *insn,
M
Matt Helsley 已提交
1248
			    struct reloc *table)
1249
{
M
Matt Helsley 已提交
1250
	struct reloc *reloc = table;
1251
	struct instruction *dest_insn;
1252
	struct alternative *alt;
1253 1254
	struct symbol *pfunc = insn->func->pfunc;
	unsigned int prev_offset = 0;
1255

1256
	/*
M
Matt Helsley 已提交
1257
	 * Each @reloc is a switch table relocation which points to the target
1258 1259
	 * instruction.
	 */
M
Matt Helsley 已提交
1260
	list_for_each_entry_from(reloc, &table->sec->reloc_list, list) {
1261 1262

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

1266
		/* Make sure the table entries are consecutive: */
M
Matt Helsley 已提交
1267
		if (prev_offset && reloc->offset != prev_offset + 8)
1268 1269 1270
			break;

		/* Detect function pointers from contiguous objects: */
M
Matt Helsley 已提交
1271 1272
		if (reloc->sym->sec == pfunc->sec &&
		    reloc->addend == pfunc->offset)
1273 1274
			break;

M
Matt Helsley 已提交
1275
		dest_insn = find_insn(file, reloc->sym->sec, reloc->addend);
1276
		if (!dest_insn)
1277 1278
			break;

1279
		/* Make sure the destination is in the same function: */
1280
		if (!dest_insn->func || dest_insn->func->pfunc != pfunc)
1281
			break;
1282 1283 1284 1285 1286 1287 1288

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

1289
		alt->insn = dest_insn;
1290
		list_add_tail(&alt->list, &insn->alts);
M
Matt Helsley 已提交
1291
		prev_offset = reloc->offset;
1292 1293 1294 1295 1296 1297
	}

	if (!prev_offset) {
		WARN_FUNC("can't find switch jump table",
			  insn->sec, insn->offset);
		return -1;
1298 1299 1300 1301 1302 1303
	}

	return 0;
}

/*
1304 1305
 * find_jump_table() - Given a dynamic jump, find the switch jump table
 * associated with it.
1306
 */
M
Matt Helsley 已提交
1307
static struct reloc *find_jump_table(struct objtool_file *file,
1308 1309 1310
				      struct symbol *func,
				      struct instruction *insn)
{
1311
	struct reloc *table_reloc;
1312
	struct instruction *dest_insn, *orig_insn = insn;
1313

1314 1315 1316 1317 1318
	/*
	 * Backward search using the @first_jump_src links, these help avoid
	 * much of the 'in between' code. Which avoids us getting confused by
	 * it.
	 */
1319
	for (;
1320 1321
	     insn && insn->func && insn->func->pfunc == func;
	     insn = insn->first_jump_src ?: prev_insn_same_sym(file, insn)) {
1322

1323
		if (insn != orig_insn && insn->type == INSN_JUMP_DYNAMIC)
1324 1325 1326 1327 1328 1329 1330 1331 1332
			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;

1333
		table_reloc = arch_find_switch_table(file, insn);
M
Matt Helsley 已提交
1334
		if (!table_reloc)
1335
			continue;
M
Matt Helsley 已提交
1336
		dest_insn = find_insn(file, table_reloc->sym->sec, table_reloc->addend);
1337 1338
		if (!dest_insn || !dest_insn->func || dest_insn->func->pfunc != func)
			continue;
1339

M
Matt Helsley 已提交
1340
		return table_reloc;
1341 1342 1343 1344 1345
	}

	return NULL;
}

1346 1347 1348 1349 1350 1351
/*
 * 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)
1352
{
1353
	struct instruction *insn, *last = NULL;
M
Matt Helsley 已提交
1354
	struct reloc *reloc;
1355

1356
	func_for_each_insn(file, func, insn) {
1357 1358 1359 1360 1361
		if (!last)
			last = insn;

		/*
		 * Store back-pointers for unconditional forward jumps such
1362
		 * that find_jump_table() can back-track using those and
1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373
		 * 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;
		}

1374 1375 1376
		if (insn->type != INSN_JUMP_DYNAMIC)
			continue;

M
Matt Helsley 已提交
1377 1378 1379 1380
		reloc = find_jump_table(file, func, insn);
		if (reloc) {
			reloc->jump_table_start = true;
			insn->jump_table = reloc;
1381 1382
		}
	}
1383 1384 1385 1386 1387 1388 1389 1390
}

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

1391
	func_for_each_insn(file, func, insn) {
1392 1393
		if (!insn->jump_table)
			continue;
1394

1395
		ret = add_jump_table(file, insn, insn->jump_table);
1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407
		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.
 */
1408
static int add_jump_table_alts(struct objtool_file *file)
1409 1410 1411 1412 1413
{
	struct section *sec;
	struct symbol *func;
	int ret;

1414
	if (!file->rodata)
1415 1416
		return 0;

1417
	for_each_sec(file, sec) {
1418 1419 1420 1421
		list_for_each_entry(func, &sec->symbol_list, list) {
			if (func->type != STT_FUNC)
				continue;

1422
			mark_func_jump_tables(file, func);
1423
			ret = add_func_jump_tables(file, func);
1424 1425 1426 1427 1428 1429 1430 1431
			if (ret)
				return ret;
		}
	}

	return 0;
}

1432 1433
static int read_unwind_hints(struct objtool_file *file)
{
M
Matt Helsley 已提交
1434 1435
	struct section *sec, *relocsec;
	struct reloc *reloc;
1436 1437 1438 1439 1440 1441 1442 1443 1444
	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 已提交
1445 1446
	relocsec = sec->reloc;
	if (!relocsec) {
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460
		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 已提交
1461 1462 1463
		reloc = find_reloc_by_dest(file->elf, sec, i * sizeof(*hint));
		if (!reloc) {
			WARN("can't find reloc for unwind_hints[%d]", i);
1464 1465 1466
			return -1;
		}

M
Matt Helsley 已提交
1467
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
1468 1469 1470 1471 1472
		if (!insn) {
			WARN("can't find insn for unwind_hints[%d]", i);
			return -1;
		}

1473
		cfa = &insn->cfi.cfa;
1474

1475
		if (hint->type == UNWIND_HINT_TYPE_RET_OFFSET) {
1476
			insn->ret_offset = hint->sp_offset;
1477 1478 1479 1480 1481
			continue;
		}

		insn->hint = true;

1482
		if (arch_decode_hint_reg(insn, hint->sp_reg)) {
1483 1484 1485 1486 1487 1488
			WARN_FUNC("unsupported unwind_hint sp base reg %d",
				  insn->sec, insn->offset, hint->sp_reg);
			return -1;
		}

		cfa->offset = hint->sp_offset;
1489 1490
		insn->cfi.type = hint->type;
		insn->cfi.end = hint->end;
1491 1492 1493 1494 1495
	}

	return 0;
}

1496 1497
static int read_retpoline_hints(struct objtool_file *file)
{
J
Josh Poimboeuf 已提交
1498
	struct section *sec;
1499
	struct instruction *insn;
M
Matt Helsley 已提交
1500
	struct reloc *reloc;
1501

J
Josh Poimboeuf 已提交
1502
	sec = find_section_by_name(file->elf, ".rela.discard.retpoline_safe");
1503 1504 1505
	if (!sec)
		return 0;

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

M
Matt Helsley 已提交
1512
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
1513
		if (!insn) {
J
Josh Poimboeuf 已提交
1514
			WARN("bad .discard.retpoline_safe entry");
1515 1516 1517 1518 1519
			return -1;
		}

		if (insn->type != INSN_JUMP_DYNAMIC &&
		    insn->type != INSN_CALL_DYNAMIC) {
J
Josh Poimboeuf 已提交
1520
			WARN_FUNC("retpoline_safe hint not an indirect jump/call",
1521 1522 1523 1524 1525 1526 1527 1528 1529 1530
				  insn->sec, insn->offset);
			return -1;
		}

		insn->retpoline_safe = true;
	}

	return 0;
}

1531 1532 1533 1534
static int read_instr_hints(struct objtool_file *file)
{
	struct section *sec;
	struct instruction *insn;
M
Matt Helsley 已提交
1535
	struct reloc *reloc;
1536 1537 1538 1539 1540

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

M
Matt Helsley 已提交
1541 1542
	list_for_each_entry(reloc, &sec->reloc_list, list) {
		if (reloc->sym->type != STT_SECTION) {
1543 1544 1545 1546
			WARN("unexpected relocation symbol type in %s", sec->name);
			return -1;
		}

M
Matt Helsley 已提交
1547
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559
		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 已提交
1560 1561
	list_for_each_entry(reloc, &sec->reloc_list, list) {
		if (reloc->sym->type != STT_SECTION) {
1562 1563 1564 1565
			WARN("unexpected relocation symbol type in %s", sec->name);
			return -1;
		}

M
Matt Helsley 已提交
1566
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577
		if (!insn) {
			WARN("bad .discard.instr_begin entry");
			return -1;
		}

		insn->instr++;
	}

	return 0;
}

1578 1579 1580 1581
static int read_intra_function_calls(struct objtool_file *file)
{
	struct instruction *insn;
	struct section *sec;
M
Matt Helsley 已提交
1582
	struct reloc *reloc;
1583 1584 1585 1586 1587

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

M
Matt Helsley 已提交
1588
	list_for_each_entry(reloc, &sec->reloc_list, list) {
1589 1590
		unsigned long dest_off;

M
Matt Helsley 已提交
1591
		if (reloc->sym->type != STT_SECTION) {
1592 1593 1594 1595 1596
			WARN("unexpected relocation symbol type in %s",
			     sec->name);
			return -1;
		}

M
Matt Helsley 已提交
1597
		insn = find_insn(file, reloc->sym->sec, reloc->addend);
1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628
		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;
}

1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645
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;
}

1646 1647 1648 1649 1650 1651
static void mark_rodata(struct objtool_file *file)
{
	struct section *sec;
	bool found = false;

	/*
1652 1653 1654 1655 1656 1657 1658 1659
	 * 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.
1660 1661
	 */
	for_each_sec(file, sec) {
1662 1663
		if (!strncmp(sec->name, ".rodata", 7) &&
		    !strstr(sec->name, ".str1.")) {
1664 1665 1666 1667 1668 1669 1670 1671
			sec->rodata = true;
			found = true;
		}
	}

	file->rodata = found;
}

1672 1673 1674 1675
static int decode_sections(struct objtool_file *file)
{
	int ret;

1676 1677
	mark_rodata(file);

1678 1679 1680 1681 1682 1683 1684 1685 1686
	ret = decode_instructions(file);
	if (ret)
		return ret;

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

	add_ignores(file);
P
Peter Zijlstra 已提交
1687
	add_uaccess_safe(file);
1688

1689
	ret = add_ignore_alternatives(file);
1690 1691 1692
	if (ret)
		return ret;

1693 1694 1695
	/*
	 * Must be before add_{jump_call}_destination.
	 */
P
Peter Zijlstra 已提交
1696 1697 1698 1699
	ret = read_static_call_tramps(file);
	if (ret)
		return ret;

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

1704
	ret = add_special_section_alts(file);
1705 1706 1707
	if (ret)
		return ret;

1708 1709 1710 1711
	/*
	 * Must be before add_call_destination(); it changes INSN_CALL to
	 * INSN_JUMP.
	 */
1712 1713 1714 1715
	ret = read_intra_function_calls(file);
	if (ret)
		return ret;

1716
	ret = add_call_destinations(file);
1717 1718 1719
	if (ret)
		return ret;

1720
	ret = add_jump_table_alts(file);
1721 1722 1723
	if (ret)
		return ret;

1724 1725 1726 1727
	ret = read_unwind_hints(file);
	if (ret)
		return ret;

1728 1729 1730 1731
	ret = read_retpoline_hints(file);
	if (ret)
		return ret;

1732 1733 1734 1735
	ret = read_instr_hints(file);
	if (ret)
		return ret;

1736 1737 1738 1739 1740
	return 0;
}

static bool is_fentry_call(struct instruction *insn)
{
1741
	if (insn->type == INSN_CALL && insn->call_dest &&
1742 1743 1744 1745 1746 1747 1748
	    insn->call_dest->type == STT_NOTYPE &&
	    !strcmp(insn->call_dest->name, "__fentry__"))
		return true;

	return false;
}

1749
static bool has_modified_stack_frame(struct instruction *insn, struct insn_state *state)
1750
{
1751
	u8 ret_offset = insn->ret_offset;
1752
	struct cfi_state *cfi = &state->cfi;
1753 1754
	int i;

1755
	if (cfi->cfa.base != initial_func_cfi.cfa.base || cfi->drap)
1756 1757
		return true;

1758
	if (cfi->cfa.offset != initial_func_cfi.cfa.offset + ret_offset)
1759 1760
		return true;

1761
	if (cfi->stack_size != initial_func_cfi.cfa.offset + ret_offset)
1762 1763
		return true;

1764 1765 1766 1767 1768 1769 1770 1771
	/*
	 * 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;

1772
	for (i = 0; i < CFI_NUM_REGS; i++) {
1773 1774
		if (cfi->regs[i].base != initial_func_cfi.regs[i].base ||
		    cfi->regs[i].offset != initial_func_cfi.regs[i].offset)
1775
			return true;
1776
	}
1777 1778 1779 1780 1781 1782

	return false;
}

static bool has_valid_stack_frame(struct insn_state *state)
{
1783 1784 1785 1786
	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)
1787 1788
		return true;

1789
	if (cfi->drap && cfi->regs[CFI_BP].base == CFI_BP)
1790 1791 1792
		return true;

	return false;
1793 1794
}

1795 1796
static int update_cfi_state_regs(struct instruction *insn,
				  struct cfi_state *cfi,
1797
				  struct stack_op *op)
1798
{
1799
	struct cfi_reg *cfa = &cfi->cfa;
1800

1801
	if (cfa->base != CFI_SP && cfa->base != CFI_SP_INDIRECT)
1802 1803 1804
		return 0;

	/* push */
P
Peter Zijlstra 已提交
1805
	if (op->dest.type == OP_DEST_PUSH || op->dest.type == OP_DEST_PUSHF)
1806 1807 1808
		cfa->offset += 8;

	/* pop */
P
Peter Zijlstra 已提交
1809
	if (op->src.type == OP_SRC_POP || op->src.type == OP_SRC_POPF)
1810 1811 1812 1813 1814 1815 1816 1817 1818 1819
		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;
}

1820
static void save_reg(struct cfi_state *cfi, unsigned char reg, int base, int offset)
1821
{
1822
	if (arch_callee_saved_reg(reg) &&
1823 1824 1825
	    cfi->regs[reg].base == CFI_UNDEFINED) {
		cfi->regs[reg].base = base;
		cfi->regs[reg].offset = offset;
1826
	}
1827 1828
}

1829
static void restore_reg(struct cfi_state *cfi, unsigned char reg)
1830
{
1831 1832
	cfi->regs[reg].base = initial_func_cfi.regs[reg].base;
	cfi->regs[reg].offset = initial_func_cfi.regs[reg].offset;
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 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887
}

/*
 * 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
 */
1888
static int update_cfi_state(struct instruction *insn, struct cfi_state *cfi,
1889
			     struct stack_op *op)
1890
{
1891 1892
	struct cfi_reg *cfa = &cfi->cfa;
	struct cfi_reg *regs = cfi->regs;
1893 1894 1895 1896 1897 1898 1899 1900 1901 1902

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

1903 1904
	if (cfi->type == UNWIND_HINT_TYPE_REGS ||
	    cfi->type == UNWIND_HINT_TYPE_REGS_PARTIAL)
1905
		return update_cfi_state_regs(insn, cfi, op);
1906

1907 1908 1909 1910 1911 1912
	switch (op->dest.type) {

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

		case OP_SRC_REG:
1913 1914 1915 1916 1917 1918 1919
			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;
1920
				cfi->bp_scratch = false;
1921
			}
1922

1923
			else if (op->src.reg == CFI_SP &&
1924
				 op->dest.reg == CFI_BP && cfi->drap) {
1925

1926 1927
				/* drap: mov %rsp, %rbp */
				regs[CFI_BP].base = CFI_BP;
1928 1929
				regs[CFI_BP].offset = -cfi->stack_size;
				cfi->bp_scratch = false;
1930
			}
1931

1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943
			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
				 */
1944 1945
				cfi->vals[op->dest.reg].base = CFI_CFA;
				cfi->vals[op->dest.reg].offset = -cfi->stack_size;
1946 1947
			}

J
Josh Poimboeuf 已提交
1948 1949 1950 1951 1952 1953 1954 1955
			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).
				 */
1956
				cfi->stack_size = -cfi->regs[CFI_BP].offset;
J
Josh Poimboeuf 已提交
1957 1958
			}

1959 1960 1961 1962
			else if (op->dest.reg == cfa->base) {

				/* mov %reg, %rsp */
				if (cfa->base == CFI_SP &&
1963
				    cfi->vals[op->src.reg].base == CFI_CFA) {
1964 1965 1966 1967 1968 1969 1970 1971 1972

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

				} else {
					cfa->base = CFI_UNDEFINED;
					cfa->offset = 0;
				}
1980 1981 1982 1983 1984 1985 1986 1987
			}

			break;

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

				/* add imm, %rsp */
1988
				cfi->stack_size -= op->src.offset;
1989 1990 1991 1992 1993 1994 1995 1996
				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 */
1997
				cfi->stack_size = -(op->src.offset + regs[CFI_BP].offset);
1998 1999 2000
				break;
			}

2001
			if (op->src.reg == CFI_SP && cfa->base == CFI_SP) {
2002 2003

				/* drap: lea disp(%rsp), %drap */
2004
				cfi->drap_reg = op->dest.reg;
2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015

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

2020 2021 2022
				break;
			}

2023 2024
			if (cfi->drap && op->dest.reg == CFI_SP &&
			    op->src.reg == cfi->drap_reg) {
2025 2026 2027

				 /* drap: lea disp(%drap), %rsp */
				cfa->base = CFI_SP;
2028 2029 2030
				cfa->offset = cfi->stack_size = -op->src.offset;
				cfi->drap_reg = CFI_UNDEFINED;
				cfi->drap = false;
2031 2032 2033
				break;
			}

2034
			if (op->dest.reg == cfi->cfa.base) {
2035 2036 2037 2038 2039 2040 2041 2042 2043
				WARN_FUNC("unsupported stack register modification",
					  insn->sec, insn->offset);
				return -1;
			}

			break;

		case OP_SRC_AND:
			if (op->dest.reg != CFI_SP ||
2044 2045
			    (cfi->drap_reg != CFI_UNDEFINED && cfa->base != CFI_SP) ||
			    (cfi->drap_reg == CFI_UNDEFINED && cfa->base != CFI_BP)) {
2046 2047 2048 2049 2050
				WARN_FUNC("unsupported stack pointer realignment",
					  insn->sec, insn->offset);
				return -1;
			}

2051
			if (cfi->drap_reg != CFI_UNDEFINED) {
2052
				/* drap: and imm, %rsp */
2053 2054 2055
				cfa->base = cfi->drap_reg;
				cfa->offset = cfi->stack_size = 0;
				cfi->drap = true;
2056 2057 2058 2059 2060 2061 2062 2063 2064 2065
			}

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

			break;

		case OP_SRC_POP:
P
Peter Zijlstra 已提交
2066
		case OP_SRC_POPF:
2067
			if (!cfi->drap && op->dest.reg == cfa->base) {
2068 2069 2070 2071 2072

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

2073 2074 2075
			if (cfi->drap && cfa->base == CFI_BP_INDIRECT &&
			    op->dest.reg == cfi->drap_reg &&
			    cfi->drap_offset == -cfi->stack_size) {
2076

2077
				/* drap: pop %drap */
2078
				cfa->base = cfi->drap_reg;
2079
				cfa->offset = 0;
2080
				cfi->drap_offset = -1;
2081

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

2084
				/* pop %reg */
2085
				restore_reg(cfi, op->dest.reg);
2086 2087
			}

2088
			cfi->stack_size -= 8;
2089 2090 2091 2092 2093 2094
			if (cfa->base == CFI_SP)
				cfa->offset -= 8;

			break;

		case OP_SRC_REG_INDIRECT:
2095 2096
			if (cfi->drap && op->src.reg == CFI_BP &&
			    op->src.offset == cfi->drap_offset) {
2097 2098

				/* drap: mov disp(%rbp), %drap */
2099
				cfa->base = cfi->drap_reg;
2100
				cfa->offset = 0;
2101
				cfi->drap_offset = -1;
2102 2103
			}

2104
			if (cfi->drap && op->src.reg == CFI_BP &&
2105 2106 2107
			    op->src.offset == regs[op->dest.reg].offset) {

				/* drap: mov disp(%rbp), %reg */
2108
				restore_reg(cfi, op->dest.reg);
2109 2110 2111 2112 2113 2114

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

		break;

	case OP_DEST_LEAVE:
2198 2199
		if ((!cfi->drap && cfa->base != CFI_BP) ||
		    (cfi->drap && cfa->base != cfi->drap_reg)) {
2200 2201 2202 2203 2204 2205 2206
			WARN_FUNC("leave instruction with modified stack frame",
				  insn->sec, insn->offset);
			return -1;
		}

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

2207 2208
		cfi->stack_size = -cfi->regs[CFI_BP].offset - 8;
		restore_reg(cfi, CFI_BP);
2209

2210
		if (!cfi->drap) {
2211 2212 2213 2214 2215 2216 2217
			cfa->base = CFI_SP;
			cfa->offset -= 8;
		}

		break;

	case OP_DEST_MEM:
P
Peter Zijlstra 已提交
2218
		if (op->src.type != OP_SRC_POP && op->src.type != OP_SRC_POPF) {
2219 2220 2221 2222 2223 2224
			WARN_FUNC("unknown stack-related memory operation",
				  insn->sec, insn->offset);
			return -1;
		}

		/* pop mem */
2225
		cfi->stack_size -= 8;
2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239
		if (cfa->base == CFI_SP)
			cfa->offset -= 8;

		break;

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

	return 0;
}

2240 2241 2242 2243 2244
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) {
2245
		struct cfi_state old_cfi = state->cfi;
2246 2247
		int res;

2248
		res = update_cfi_state(insn, &state->cfi, op);
2249 2250 2251
		if (res)
			return res;

2252 2253 2254 2255 2256
		if (insn->alt_group && memcmp(&state->cfi, &old_cfi, sizeof(struct cfi_state))) {
			WARN_FUNC("alternative modifies stack", insn->sec, insn->offset);
			return -1;
		}

2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281
		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;
}

2282
static bool insn_cfi_match(struct instruction *insn, struct cfi_state *cfi2)
2283
{
2284
	struct cfi_state *cfi1 = &insn->cfi;
2285 2286
	int i;

2287 2288
	if (memcmp(&cfi1->cfa, &cfi2->cfa, sizeof(cfi1->cfa))) {

2289 2290
		WARN_FUNC("stack state mismatch: cfa1=%d%+d cfa2=%d%+d",
			  insn->sec, insn->offset,
2291 2292
			  cfi1->cfa.base, cfi1->cfa.offset,
			  cfi2->cfa.base, cfi2->cfa.offset);
2293

2294
	} else if (memcmp(&cfi1->regs, &cfi2->regs, sizeof(cfi1->regs))) {
2295
		for (i = 0; i < CFI_NUM_REGS; i++) {
2296
			if (!memcmp(&cfi1->regs[i], &cfi2->regs[i],
2297 2298 2299 2300 2301
				    sizeof(struct cfi_reg)))
				continue;

			WARN_FUNC("stack state mismatch: reg1[%d]=%d%+d reg2[%d]=%d%+d",
				  insn->sec, insn->offset,
2302 2303
				  i, cfi1->regs[i].base, cfi1->regs[i].offset,
				  i, cfi2->regs[i].base, cfi2->regs[i].offset);
2304 2305 2306
			break;
		}

2307 2308
	} else if (cfi1->type != cfi2->type) {

2309
		WARN_FUNC("stack state mismatch: type1=%d type2=%d",
2310 2311 2312 2313 2314
			  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)) {
2315

2316
		WARN_FUNC("stack state mismatch: drap1=%d(%d,%d) drap2=%d(%d,%d)",
2317
			  insn->sec, insn->offset,
2318 2319
			  cfi1->drap, cfi1->drap_reg, cfi1->drap_offset,
			  cfi2->drap, cfi2->drap_reg, cfi2->drap_offset);
2320 2321 2322 2323 2324

	} else
		return true;

	return false;
2325 2326
}

P
Peter Zijlstra 已提交
2327 2328 2329
static inline bool func_uaccess_safe(struct symbol *func)
{
	if (func)
2330
		return func->uaccess_safe;
P
Peter Zijlstra 已提交
2331 2332 2333 2334

	return false;
}

2335
static inline const char *call_dest_name(struct instruction *insn)
P
Peter Zijlstra 已提交
2336 2337 2338 2339 2340 2341 2342
{
	if (insn->call_dest)
		return insn->call_dest->name;

	return "{dynamic}";
}

2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368
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 已提交
2369 2370
static int validate_call(struct instruction *insn, struct insn_state *state)
{
2371
	if (state->noinstr && state->instr <= 0 &&
2372
	    !noinstr_call_dest(insn->call_dest)) {
2373 2374 2375 2376 2377
		WARN_FUNC("call to %s() leaves .noinstr.text section",
				insn->sec, insn->offset, call_dest_name(insn));
		return 1;
	}

P
Peter Zijlstra 已提交
2378 2379
	if (state->uaccess && !func_uaccess_safe(insn->call_dest)) {
		WARN_FUNC("call to %s() with UACCESS enabled",
2380
				insn->sec, insn->offset, call_dest_name(insn));
P
Peter Zijlstra 已提交
2381 2382 2383
		return 1;
	}

2384 2385
	if (state->df) {
		WARN_FUNC("call to %s() with DF set",
2386
				insn->sec, insn->offset, call_dest_name(insn));
2387 2388 2389
		return 1;
	}

P
Peter Zijlstra 已提交
2390 2391 2392
	return 0;
}

2393 2394
static int validate_sibling_call(struct instruction *insn, struct insn_state *state)
{
2395
	if (has_modified_stack_frame(insn, state)) {
2396 2397 2398 2399 2400
		WARN_FUNC("sibling call from callable instruction with modified stack frame",
				insn->sec, insn->offset);
		return 1;
	}

P
Peter Zijlstra 已提交
2401
	return validate_call(insn, state);
2402 2403
}

2404 2405
static int validate_return(struct symbol *func, struct instruction *insn, struct insn_state *state)
{
2406 2407 2408 2409 2410 2411
	if (state->noinstr && state->instr > 0) {
		WARN_FUNC("return with instrumentation enabled",
			  insn->sec, insn->offset);
		return 1;
	}

2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429
	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;
	}

2430
	if (func && has_modified_stack_frame(insn, state)) {
2431 2432 2433 2434 2435
		WARN_FUNC("return with modified stack frame",
			  insn->sec, insn->offset);
		return 1;
	}

2436
	if (state->cfi.bp_scratch) {
2437 2438
		WARN_FUNC("BP used as a scratch register",
			  insn->sec, insn->offset);
2439 2440 2441 2442 2443 2444
		return 1;
	}

	return 0;
}

2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459
/*
 * 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;
J
Josh Poimboeuf 已提交
2460
	struct alt_group *alt_group = insn->alt_group;
2461 2462 2463 2464 2465 2466 2467 2468

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

2469 2470 2471 2472 2473 2474
/*
 * 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.
 */
2475
static int validate_branch(struct objtool_file *file, struct symbol *func,
P
Peter Zijlstra 已提交
2476
			   struct instruction *insn, struct insn_state state)
2477 2478
{
	struct alternative *alt;
P
Peter Zijlstra 已提交
2479
	struct instruction *next_insn;
2480
	struct section *sec;
2481
	u8 visited;
2482 2483 2484 2485 2486
	int ret;

	sec = insn->sec;

	while (1) {
2487 2488
		next_insn = next_insn_same_sec(file, insn);

2489
		if (file->c_file && func && insn->func && func != insn->func->pfunc) {
2490 2491 2492
			WARN("%s() falls through to next function %s()",
			     func->name, insn->func->name);
			return 1;
2493 2494
		}

2495 2496 2497
		if (func && insn->ignore) {
			WARN_FUNC("BUG: why am I validating an ignored function?",
				  sec, insn->offset);
2498
			return 1;
2499 2500
		}

2501
		visited = 1 << state.uaccess;
2502
		if (insn->visited) {
2503
			if (!insn->hint && !insn_cfi_match(insn, &state.cfi))
2504 2505
				return 1;

2506
			if (insn->visited & visited)
P
Peter Zijlstra 已提交
2507
				return 0;
2508 2509
		}

2510 2511 2512
		if (state.noinstr)
			state.instr += insn->instr;

2513
		if (insn->hint)
2514
			state.cfi = insn->cfi;
2515
		else
2516
			insn->cfi = state.cfi;
2517

2518
		insn->visited |= visited;
2519

2520
		if (!insn->ignore_alts && !list_empty(&insn->alts)) {
P
Peter Zijlstra 已提交
2521 2522
			bool skip_orig = false;

2523
			list_for_each_entry(alt, &insn->alts, list) {
P
Peter Zijlstra 已提交
2524 2525 2526
				if (alt->skip_orig)
					skip_orig = true;

2527
				ret = validate_branch(file, func, alt->insn, state);
2528 2529 2530 2531 2532
				if (ret) {
					if (backtrace)
						BT_FUNC("(alt)", insn);
					return ret;
				}
2533
			}
P
Peter Zijlstra 已提交
2534

2535 2536 2537
			if (insn->alt_group)
				fill_alternative_cfi(file, insn);

P
Peter Zijlstra 已提交
2538 2539
			if (skip_orig)
				return 0;
2540 2541
		}

2542 2543 2544
		if (handle_insn_ops(insn, &state))
			return 1;

2545 2546 2547
		switch (insn->type) {

		case INSN_RETURN:
2548
			return validate_return(func, insn, &state);
2549 2550

		case INSN_CALL:
P
Peter Zijlstra 已提交
2551 2552 2553 2554
		case INSN_CALL_DYNAMIC:
			ret = validate_call(insn, &state);
			if (ret)
				return ret;
2555

2556 2557
			if (!no_fp && func && !is_fentry_call(insn) &&
			    !has_valid_stack_frame(&state)) {
2558 2559 2560 2561
				WARN_FUNC("call without frame pointer save/setup",
					  sec, insn->offset);
				return 1;
			}
2562 2563 2564 2565

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

2566 2567 2568 2569
			break;

		case INSN_JUMP_CONDITIONAL:
		case INSN_JUMP_UNCONDITIONAL:
2570
			if (func && is_sibling_call(insn)) {
2571
				ret = validate_sibling_call(insn, &state);
2572
				if (ret)
2573
					return ret;
2574

2575
			} else if (insn->jump_dest) {
2576 2577
				ret = validate_branch(file, func,
						      insn->jump_dest, state);
2578 2579 2580 2581 2582
				if (ret) {
					if (backtrace)
						BT_FUNC("(branch)", insn);
					return ret;
				}
2583
			}
2584 2585 2586 2587 2588 2589 2590

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

			break;

		case INSN_JUMP_DYNAMIC:
2591
		case INSN_JUMP_DYNAMIC_CONDITIONAL:
2592
			if (func && is_sibling_call(insn)) {
2593 2594 2595
				ret = validate_sibling_call(insn, &state);
				if (ret)
					return ret;
2596 2597
			}

2598 2599 2600 2601
			if (insn->type == INSN_JUMP_DYNAMIC)
				return 0;

			break;
2602

2603 2604 2605 2606 2607 2608 2609 2610
		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 已提交
2611 2612 2613 2614 2615 2616 2617 2618 2619 2620
		case INSN_STAC:
			if (state.uaccess) {
				WARN_FUNC("recursive UACCESS enable", sec, insn->offset);
				return 1;
			}

			state.uaccess = true;
			break;

		case INSN_CLAC:
2621
			if (!state.uaccess && func) {
P
Peter Zijlstra 已提交
2622 2623 2624 2625 2626 2627 2628 2629 2630 2631
				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;
2632 2633
			break;

2634
		case INSN_STD:
2635
			if (state.df) {
2636
				WARN_FUNC("recursive STD", sec, insn->offset);
2637 2638
				return 1;
			}
2639 2640 2641 2642 2643

			state.df = true;
			break;

		case INSN_CLD:
2644
			if (!state.df && func) {
2645
				WARN_FUNC("redundant CLD", sec, insn->offset);
2646 2647
				return 1;
			}
2648 2649

			state.df = false;
2650 2651
			break;

2652 2653 2654 2655 2656 2657 2658
		default:
			break;
		}

		if (insn->dead_end)
			return 0;

2659
		if (!next_insn) {
2660
			if (state.cfi.cfa.base == CFI_UNDEFINED)
2661
				return 0;
2662 2663 2664
			WARN("%s: unexpected end of section", sec->name);
			return 1;
		}
2665 2666

		insn = next_insn;
2667 2668 2669 2670 2671
	}

	return 0;
}

2672
static int validate_unwind_hints(struct objtool_file *file, struct section *sec)
2673 2674 2675
{
	struct instruction *insn;
	struct insn_state state;
2676
	int ret, warnings = 0;
2677 2678 2679 2680

	if (!file->hints)
		return 0;

2681
	init_insn_state(&state, sec);
2682

2683 2684 2685 2686 2687 2688 2689 2690 2691
	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)) {
2692
		if (insn->hint && !insn->visited) {
2693
			ret = validate_branch(file, insn->func, insn, state);
2694 2695
			if (ret && backtrace)
				BT_FUNC("<=== (hint)", insn);
2696 2697
			warnings += ret;
		}
2698 2699

		insn = list_next_entry(insn, list);
2700 2701 2702 2703 2704
	}

	return warnings;
}

2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717
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;

2718 2719 2720 2721 2722 2723 2724 2725 2726
		/*
		 * .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;

2727 2728 2729 2730 2731 2732 2733 2734 2735 2736
		WARN_FUNC("indirect %s found in RETPOLINE build",
			  insn->sec, insn->offset,
			  insn->type == INSN_JUMP_DYNAMIC ? "jump" : "call");

		warnings++;
	}

	return warnings;
}

2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749
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"));
}

2750
static bool ignore_unreachable_insn(struct objtool_file *file, struct instruction *insn)
2751 2752
{
	int i;
2753
	struct instruction *prev_insn;
2754

2755 2756 2757 2758 2759 2760
	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.
2761 2762 2763
	 *
	 * Also ignore alternative replacement instructions.  This can happen
	 * when a whitelisted function uses one of the ALTERNATIVE macros.
2764
	 */
2765 2766 2767
	if (!strcmp(insn->sec->name, ".fixup") ||
	    !strcmp(insn->sec->name, ".altinstr_replacement") ||
	    !strcmp(insn->sec->name, ".altinstr_aux"))
2768 2769
		return true;

2770 2771 2772
	if (insn->type == INSN_JUMP_UNCONDITIONAL && insn->offset == FAKE_JUMP_OFFSET)
		return true;

2773 2774 2775 2776 2777 2778 2779 2780
	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).
2781 2782
	 *
	 * It may also insert a UD2 after calling a __noreturn function.
2783
	 */
2784 2785
	prev_insn = list_prev_entry(insn, list);
	if ((prev_insn->dead_end || dead_end_function(file, prev_insn->call_dest)) &&
2786 2787 2788 2789 2790
	    (insn->type == INSN_BUG ||
	     (insn->type == INSN_JUMP_UNCONDITIONAL &&
	      insn->jump_dest && insn->jump_dest->type == INSN_BUG)))
		return true;

2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801
	/*
	 * 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;

2802 2803 2804 2805 2806 2807 2808 2809
		if (insn->type == INSN_JUMP_UNCONDITIONAL) {
			if (insn->jump_dest &&
			    insn->jump_dest->func == insn->func) {
				insn = insn->jump_dest;
				continue;
			}

			break;
2810 2811
		}

2812
		if (insn->offset + insn->len >= insn->func->offset + insn->func->len)
2813
			break;
2814

2815 2816 2817 2818 2819 2820
		insn = list_next_entry(insn, list);
	}

	return false;
}

2821 2822
static int validate_symbol(struct objtool_file *file, struct section *sec,
			   struct symbol *sym, struct insn_state *state)
2823 2824
{
	struct instruction *insn;
2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848
	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)
{
2849
	struct insn_state state;
2850 2851
	struct symbol *func;
	int warnings = 0;
2852

2853 2854 2855
	list_for_each_entry(func, &sec->symbol_list, list) {
		if (func->type != STT_FUNC)
			continue;
2856

2857
		init_insn_state(&state, sec);
2858 2859
		state.cfi.cfa = initial_func_cfi.cfa;
		memcpy(&state.cfi.regs, &initial_func_cfi.regs,
2860
		       CFI_NUM_REGS * sizeof(struct cfi_reg));
2861
		state.cfi.stack_size = initial_func_cfi.cfa.offset;
2862

2863
		warnings += validate_symbol(file, sec, func, &state);
2864 2865 2866 2867 2868
	}

	return warnings;
}

2869 2870 2871
static int validate_vmlinux_functions(struct objtool_file *file)
{
	struct section *sec;
2872
	int warnings = 0;
2873 2874

	sec = find_section_by_name(file->elf, ".noinstr.text");
2875 2876 2877 2878
	if (sec) {
		warnings += validate_section(file, sec);
		warnings += validate_unwind_hints(file, sec);
	}
2879

2880 2881 2882 2883 2884
	sec = find_section_by_name(file->elf, ".entry.text");
	if (sec) {
		warnings += validate_section(file, sec);
		warnings += validate_unwind_hints(file, sec);
	}
2885 2886

	return warnings;
2887 2888
}

2889 2890 2891 2892 2893
static int validate_functions(struct objtool_file *file)
{
	struct section *sec;
	int warnings = 0;

2894 2895 2896 2897
	for_each_sec(file, sec) {
		if (!(sec->sh.sh_flags & SHF_EXECINSTR))
			continue;

2898
		warnings += validate_section(file, sec);
2899
	}
2900 2901 2902 2903

	return warnings;
}

2904
static int validate_reachable_instructions(struct objtool_file *file)
2905 2906
{
	struct instruction *insn;
2907 2908 2909

	if (file->ignore_unreachables)
		return 0;
2910 2911

	for_each_insn(file, insn) {
2912
		if (insn->visited || ignore_unreachable_insn(file, insn))
2913 2914 2915 2916
			continue;

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

2919
	return 0;
2920 2921
}

2922
int check(struct objtool_file *file)
2923 2924 2925
{
	int ret, warnings = 0;

2926 2927
	arch_initial_func_cfi_state(&initial_func_cfi);

2928
	ret = decode_sections(file);
2929 2930 2931 2932
	if (ret < 0)
		goto out;
	warnings += ret;

2933
	if (list_empty(&file->insn_list))
2934 2935
		goto out;

2936
	if (vmlinux && !validate_dup) {
2937
		ret = validate_vmlinux_functions(file);
2938 2939 2940 2941 2942 2943 2944
		if (ret < 0)
			goto out;

		warnings += ret;
		goto out;
	}

2945
	if (retpoline) {
2946
		ret = validate_retpoline(file);
2947 2948 2949 2950 2951
		if (ret < 0)
			return ret;
		warnings += ret;
	}

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

2957
	ret = validate_unwind_hints(file, NULL);
2958 2959 2960 2961
	if (ret < 0)
		goto out;
	warnings += ret;

2962
	if (!warnings) {
2963
		ret = validate_reachable_instructions(file);
2964 2965 2966 2967 2968
		if (ret < 0)
			goto out;
		warnings += ret;
	}

2969
	ret = create_static_call_sections(file);
2970 2971 2972 2973
	if (ret < 0)
		goto out;
	warnings += ret;

2974
out:
2975 2976 2977 2978 2979
	/*
	 *  For now, don't fail the kernel build on fatal warnings.  These
	 *  errors are still fairly common due to the growing matrix of
	 *  supported toolchains and their recent pace of change.
	 */
2980 2981
	return 0;
}