check.c 66.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 12 13 14 15 16 17 18
#include "check.h"
#include "elf.h"
#include "special.h"
#include "arch.h"
#include "warn.h"

#include <linux/hashtable.h>
#include <linux/kernel.h>

19 20
#define FAKE_JUMP_OFFSET -1

21 22
#define C_JUMP_TABLE_SECTION ".rodata..c_jump_table"

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

const char *objname;
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_static_jump(struct instruction *insn)
{
	return insn->type == INSN_JUMP_CONDITIONAL ||
	       insn->type == INSN_JUMP_UNCONDITIONAL;
}

118 119 120 121 122 123
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);

124
	if (!is_static_jump(insn))
125 126 127 128 129 130
		return false;

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

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

167 168 169
	if (!func)
		return false;

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

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

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

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

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

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

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

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

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

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

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

222
	return true;
223 224
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

329
	return 0;
330 331 332 333

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

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

349
/*
350
 * Mark "ud2" instructions and manually annotated dead ends.
351 352 353 354 355 356 357
 */
static int add_dead_ends(struct objtool_file *file)
{
	struct section *sec;
	struct rela *rela;
	struct instruction *insn;

358 359 360 361 362 363 364 365 366 367 368
	/*
	 * 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.
	 */
369 370
	sec = find_section_by_name(file->elf, ".rela.discard.unreachable");
	if (!sec)
371
		goto reachable;
372 373 374 375 376 377 378 379 380 381

	list_for_each_entry(rela, &sec->rela_list, list) {
		if (rela->sym->type != STT_SECTION) {
			WARN("unexpected relocation symbol type in %s", sec->name);
			return -1;
		}
		insn = find_insn(file, rela->sym->sec, rela->addend);
		if (insn)
			insn = list_prev_entry(insn, list);
		else if (rela->addend == rela->sym->sec->len) {
382 383
			insn = find_last_insn(file, rela->sym->sec);
			if (!insn) {
384 385 386 387 388 389 390 391 392 393 394 395 396
				WARN("can't find unreachable insn at %s+0x%x",
				     rela->sym->sec->name, rela->addend);
				return -1;
			}
		} else {
			WARN("can't find unreachable insn at %s+0x%x",
			     rela->sym->sec->name, rela->addend);
			return -1;
		}

		insn->dead_end = true;
	}

397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
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;

	list_for_each_entry(rela, &sec->rela_list, list) {
		if (rela->sym->type != STT_SECTION) {
			WARN("unexpected relocation symbol type in %s", sec->name);
			return -1;
		}
		insn = find_insn(file, rela->sym->sec, rela->addend);
		if (insn)
			insn = list_prev_entry(insn, list);
		else if (rela->addend == rela->sym->sec->len) {
417 418
			insn = find_last_insn(file, rela->sym->sec);
			if (!insn) {
419 420 421 422 423 424 425 426 427 428 429 430 431
				WARN("can't find reachable insn at %s+0x%x",
				     rela->sym->sec->name, rela->addend);
				return -1;
			}
		} else {
			WARN("can't find reachable insn at %s+0x%x",
			     rela->sym->sec->name, rela->addend);
			return -1;
		}

		insn->dead_end = false;
	}

432 433 434 435 436 437 438 439 440 441 442
	return 0;
}

/*
 * 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;
P
Peter Zijlstra 已提交
443
	struct rela *rela;
444

P
Peter Zijlstra 已提交
445 446 447
	sec = find_section_by_name(file->elf, ".rela.discard.func_stack_frame_non_standard");
	if (!sec)
		return;
448

P
Peter Zijlstra 已提交
449 450 451 452 453 454 455
	list_for_each_entry(rela, &sec->rela_list, list) {
		switch (rela->sym->type) {
		case STT_FUNC:
			func = rela->sym;
			break;

		case STT_SECTION:
456 457
			func = find_func_by_offset(rela->sym->sec, rela->addend);
			if (!func)
458
				continue;
P
Peter Zijlstra 已提交
459
			break;
460

P
Peter Zijlstra 已提交
461 462 463
		default:
			WARN("unexpected relocation symbol type in %s: %d", sec->name, rela->sym->type);
			continue;
464
		}
P
Peter Zijlstra 已提交
465

466
		func_for_each_insn(file, func, insn)
P
Peter Zijlstra 已提交
467
			insn->ignore = true;
468 469 470
	}
}

P
Peter Zijlstra 已提交
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
/*
 * 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",
	/* 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",
	/* KCOV */
	"write_comp_data",
	"__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",
519
	"__sanitizer_cov_trace_switch",
P
Peter Zijlstra 已提交
520 521 522 523
	/* UBSAN */
	"ubsan_type_mismatch_common",
	"__ubsan_handle_type_mismatch",
	"__ubsan_handle_type_mismatch_v1",
524
	"__ubsan_handle_shift_out_of_bounds",
P
Peter Zijlstra 已提交
525 526 527
	/* misc */
	"csum_partial_copy_generic",
	"__memcpy_mcsafe",
528
	"mcsafe_handle_tail",
P
Peter Zijlstra 已提交
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545
	"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;

546
		func->uaccess_safe = true;
547 548 549
	}
}

550 551 552 553 554 555
/*
 * 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.
 */
556
static int add_ignore_alternatives(struct objtool_file *file)
557 558 559 560 561
{
	struct section *sec;
	struct rela *rela;
	struct instruction *insn;

562
	sec = find_section_by_name(file->elf, ".rela.discard.ignore_alts");
563 564 565 566 567 568 569 570 571 572 573
	if (!sec)
		return 0;

	list_for_each_entry(rela, &sec->rela_list, list) {
		if (rela->sym->type != STT_SECTION) {
			WARN("unexpected relocation symbol type in %s", sec->name);
			return -1;
		}

		insn = find_insn(file, rela->sym->sec, rela->addend);
		if (!insn) {
574
			WARN("bad .discard.ignore_alts entry");
575 576 577 578 579 580 581 582 583
			return -1;
		}

		insn->ignore_alts = true;
	}

	return 0;
}

584 585 586 587 588 589 590 591 592 593 594
/*
 * Find the destination instructions for all jumps.
 */
static int add_jump_destinations(struct objtool_file *file)
{
	struct instruction *insn;
	struct rela *rela;
	struct section *dest_sec;
	unsigned long dest_off;

	for_each_insn(file, insn) {
595
		if (!is_static_jump(insn))
596 597
			continue;

598
		if (insn->ignore || insn->offset == FAKE_JUMP_OFFSET)
599 600
			continue;

601 602
		rela = find_rela_by_dest_range(file->elf, insn->sec,
					       insn->offset, insn->len);
603 604
		if (!rela) {
			dest_sec = insn->sec;
605
			dest_off = arch_jump_destination(insn);
606 607
		} else if (rela->sym->type == STT_SECTION) {
			dest_sec = rela->sym->sec;
608
			dest_off = arch_dest_rela_offset(rela->addend);
609 610
		} else if (rela->sym->sec->idx) {
			dest_sec = rela->sym->sec;
611 612
			dest_off = rela->sym->sym.st_value +
				   arch_dest_rela_offset(rela->addend);
613 614 615 616 617
		} else if (strstr(rela->sym->name, "_indirect_thunk_")) {
			/*
			 * Retpoline jumps are really dynamic jumps in
			 * disguise, so convert them accordingly.
			 */
618 619 620 621 622
			if (insn->type == INSN_JUMP_UNCONDITIONAL)
				insn->type = INSN_JUMP_DYNAMIC;
			else
				insn->type = INSN_JUMP_DYNAMIC_CONDITIONAL;

623
			insn->retpoline_safe = true;
624
			continue;
625
		} else {
626
			/* external sibling call */
627
			insn->call_dest = rela->sym;
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646
			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;
		}
647 648

		/*
649
		 * Cross-function jump.
650 651
		 */
		if (insn->func && insn->jump_dest->func &&
652 653 654 655 656 657 658 659 660 661 662 663 664 665 666
		    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
667
			 * subfunction is through a jump table.
668 669 670 671 672 673 674 675 676
			 */
			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) {

677
				/* internal sibling call */
678 679
				insn->call_dest = insn->jump_dest->func;
			}
680
		}
681 682 683 684 685
	}

	return 0;
}

686 687 688 689 690 691 692 693 694 695
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);
	}
}

696 697 698 699 700 701 702 703 704 705 706 707 708
/*
 * Find the destination instructions for all calls.
 */
static int add_call_destinations(struct objtool_file *file)
{
	struct instruction *insn;
	unsigned long dest_off;
	struct rela *rela;

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

709 710
		rela = find_rela_by_dest_range(file->elf, insn->sec,
					       insn->offset, insn->len);
711
		if (!rela) {
712
			dest_off = arch_jump_destination(insn);
713 714 715
			insn->call_dest = find_func_by_offset(insn->sec, dest_off);
			if (!insn->call_dest)
				insn->call_dest = find_symbol_by_offset(insn->sec, dest_off);
716

717 718 719 720
			if (insn->ignore)
				continue;

			if (!insn->call_dest) {
721
				WARN_FUNC("unannotated intra-function call", insn->sec, insn->offset);
722 723
				return -1;
			}
724

725 726 727 728 729 730
			if (insn->func && insn->call_dest->type != STT_FUNC) {
				WARN_FUNC("unsupported call to non-function",
					  insn->sec, insn->offset);
				return -1;
			}

731
		} else if (rela->sym->type == STT_SECTION) {
732
			dest_off = arch_dest_rela_offset(rela->addend);
733
			insn->call_dest = find_func_by_offset(rela->sym->sec,
734
							      dest_off);
735
			if (!insn->call_dest) {
736
				WARN_FUNC("can't find call dest symbol at %s+0x%lx",
737 738
					  insn->sec, insn->offset,
					  rela->sym->sec->name,
739
					  dest_off);
740 741 742 743
				return -1;
			}
		} else
			insn->call_dest = rela->sym;
744 745 746 747 748 749 750 751 752

		/*
		 * 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);
753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779
	}

	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)
{
780
	static unsigned int alt_group_next_index = 1;
781
	struct instruction *last_orig_insn, *last_new_insn, *insn, *fake_jump = NULL;
782
	unsigned int alt_group = alt_group_next_index++;
783 784 785 786 787 788 789 790
	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;

791
		insn->alt_group = alt_group;
792 793 794
		last_orig_insn = insn;
	}

795 796 797 798 799 800 801 802
	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);
803
		INIT_LIST_HEAD(&fake_jump->stack_ops);
804
		init_cfi_state(&fake_jump->cfi);
805 806

		fake_jump->sec = special_alt->new_sec;
807
		fake_jump->offset = FAKE_JUMP_OFFSET;
808 809
		fake_jump->type = INSN_JUMP_UNCONDITIONAL;
		fake_jump->jump_dest = list_next_entry(last_orig_insn, list);
810
		fake_jump->func = orig_insn->func;
811 812 813
	}

	if (!special_alt->new_len) {
814 815 816 817 818 819
		if (!fake_jump) {
			WARN("%s: empty alternative at end of section",
			     special_alt->orig_sec->name);
			return -1;
		}

820 821 822 823 824
		*new_insn = fake_jump;
		return 0;
	}

	last_new_insn = NULL;
825
	alt_group = alt_group_next_index++;
826 827 828 829 830 831 832
	insn = *new_insn;
	sec_for_each_insn_from(file, insn) {
		if (insn->offset >= special_alt->new_off + special_alt->new_len)
			break;

		last_new_insn = insn;

833
		insn->ignore = orig_insn->ignore_alts;
834
		insn->func = orig_insn->func;
835
		insn->alt_group = alt_group;
836

837 838 839 840 841 842 843 844 845 846 847 848 849 850
		/*
		 * 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.
		 *
		 * The x86 alternatives code adjusts the offsets only when it
		 * encounters a branch instruction at the very beginning of the
		 * replacement group.
		 */
		if ((insn->offset != special_alt->new_off ||
		    (insn->type != INSN_CALL && !is_static_jump(insn))) &&
851
		    find_rela_by_dest_range(file->elf, insn->sec, insn->offset, insn->len)) {
852 853 854 855 856 857

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

858
		if (!is_static_jump(insn))
859 860 861 862 863
			continue;

		if (!insn->immediate)
			continue;

864
		dest_off = arch_jump_destination(insn);
865 866 867 868 869 870
		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;
			}
871
			insn->jump_dest = fake_jump;
872
		}
873 874 875 876 877 878 879 880 881 882 883 884 885 886

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

887 888
	if (fake_jump)
		list_add(&fake_jump->list, &last_new_insn->list);
889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958

	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) {
959 960 961 962 963 964
			if (!special_alt->orig_len) {
				WARN_FUNC("empty alternative entry",
					  orig_insn->sec, orig_insn->offset);
				continue;
			}

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

976 977 978 979 980 981 982
		alt = malloc(sizeof(*alt));
		if (!alt) {
			WARN("malloc failed");
			ret = -1;
			goto out;
		}

983
		alt->insn = new_insn;
P
Peter Zijlstra 已提交
984
		alt->skip_orig = special_alt->skip_orig;
P
Peter Zijlstra 已提交
985
		orig_insn->ignore_alts |= special_alt->skip_alt;
986 987 988 989 990 991 992 993 994 995
		list_add_tail(&alt->list, &orig_insn->alts);

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

out:
	return ret;
}

996
static int add_jump_table(struct objtool_file *file, struct instruction *insn,
997
			    struct rela *table)
998 999
{
	struct rela *rela = table;
1000
	struct instruction *dest_insn;
1001
	struct alternative *alt;
1002 1003
	struct symbol *pfunc = insn->func->pfunc;
	unsigned int prev_offset = 0;
1004

1005 1006 1007 1008 1009
	/*
	 * Each @rela is a switch table relocation which points to the target
	 * instruction.
	 */
	list_for_each_entry_from(rela, &table->sec->rela_list, list) {
1010 1011 1012

		/* Check for the end of the table: */
		if (rela != table && rela->jump_table_start)
1013 1014
			break;

1015
		/* Make sure the table entries are consecutive: */
1016 1017 1018 1019 1020 1021 1022 1023
		if (prev_offset && rela->offset != prev_offset + 8)
			break;

		/* Detect function pointers from contiguous objects: */
		if (rela->sym->sec == pfunc->sec &&
		    rela->addend == pfunc->offset)
			break;

1024 1025
		dest_insn = find_insn(file, rela->sym->sec, rela->addend);
		if (!dest_insn)
1026 1027
			break;

1028
		/* Make sure the destination is in the same function: */
1029
		if (!dest_insn->func || dest_insn->func->pfunc != pfunc)
1030
			break;
1031 1032 1033 1034 1035 1036 1037

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

1038
		alt->insn = dest_insn;
1039
		list_add_tail(&alt->list, &insn->alts);
1040 1041 1042 1043 1044 1045 1046
		prev_offset = rela->offset;
	}

	if (!prev_offset) {
		WARN_FUNC("can't find switch jump table",
			  insn->sec, insn->offset);
		return -1;
1047 1048 1049 1050 1051 1052
	}

	return 0;
}

/*
1053
 * find_jump_table() - Given a dynamic jump, find the switch jump table in
1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085
 * .rodata associated with it.
 *
 * There are 3 basic patterns:
 *
 * 1. jmpq *[rodata addr](,%reg,8)
 *
 *    This is the most common case by far.  It jumps to an address in a simple
 *    jump table which is stored in .rodata.
 *
 * 2. jmpq *[rodata addr](%rip)
 *
 *    This is caused by a rare GCC quirk, currently only seen in three driver
 *    functions in the kernel, only with certain obscure non-distro configs.
 *
 *    As part of an optimization, GCC makes a copy of an existing switch jump
 *    table, modifies it, and then hard-codes the jump (albeit with an indirect
 *    jump) to use a single entry in the table.  The rest of the jump table and
 *    some of its jump targets remain as dead code.
 *
 *    In such a case we can just crudely ignore all unreachable instruction
 *    warnings for the entire object file.  Ideally we would just ignore them
 *    for the function, but that would require redesigning the code quite a
 *    bit.  And honestly that's just not worth doing: unreachable instruction
 *    warnings are of questionable value anyway, and this is such a rare issue.
 *
 * 3. mov [rodata addr],%reg1
 *    ... some instructions ...
 *    jmpq *(%reg1,%reg2,8)
 *
 *    This is a fairly uncommon pattern which is new for GCC 6.  As of this
 *    writing, there are 11 occurrences of it in the allmodconfig kernel.
 *
1086 1087 1088 1089
 *    As of GCC 7 there are quite a few more of these and the 'in between' code
 *    is significant. Esp. with KASAN enabled some of the code between the mov
 *    and jmpq uses .rodata itself, which can confuse things.
 *
1090 1091
 *    TODO: Once we have DWARF CFI and smarter instruction decoding logic,
 *    ensure the same register is used in the mov and jump instructions.
1092 1093
 *
 *    NOTE: RETPOLINE made it harder still to decode dynamic jumps.
1094
 */
1095
static struct rela *find_jump_table(struct objtool_file *file,
1096 1097 1098
				      struct symbol *func,
				      struct instruction *insn)
{
1099
	struct rela *text_rela, *table_rela;
1100
	struct instruction *dest_insn, *orig_insn = insn;
1101
	struct section *table_sec;
1102
	unsigned long table_offset;
1103

1104 1105 1106 1107 1108
	/*
	 * Backward search using the @first_jump_src links, these help avoid
	 * much of the 'in between' code. Which avoids us getting confused by
	 * it.
	 */
1109
	for (;
1110 1111
	     insn && insn->func && insn->func->pfunc == func;
	     insn = insn->first_jump_src ?: prev_insn_same_sym(file, insn)) {
1112

1113
		if (insn != orig_insn && insn->type == INSN_JUMP_DYNAMIC)
1114 1115 1116 1117 1118 1119 1120 1121 1122 1123
			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;

		/* look for a relocation which references .rodata */
1124 1125
		text_rela = find_rela_by_dest_range(file->elf, insn->sec,
						    insn->offset, insn->len);
1126 1127
		if (!text_rela || text_rela->sym->type != STT_SECTION ||
		    !text_rela->sym->sec->rodata)
1128 1129
			continue;

1130
		table_offset = text_rela->addend;
1131
		table_sec = text_rela->sym->sec;
1132

1133 1134 1135
		if (text_rela->type == R_X86_64_PC32)
			table_offset += 4;

1136 1137
		/*
		 * Make sure the .rodata address isn't associated with a
1138 1139 1140 1141 1142 1143
		 * symbol.  GCC jump tables are anonymous data.
		 *
		 * Also support C jump tables which are in the same format as
		 * switch jump tables.  For objtool to recognize them, they
		 * need to be placed in the C_JUMP_TABLE_SECTION section.  They
		 * have symbols associated with them.
1144
		 */
1145 1146
		if (find_symbol_containing(table_sec, table_offset) &&
		    strcmp(table_sec->name, C_JUMP_TABLE_SECTION))
1147 1148
			continue;

1149 1150 1151 1152 1153
		/*
		 * Each table entry has a rela associated with it.  The rela
		 * should reference text in the same function as the original
		 * instruction.
		 */
1154
		table_rela = find_rela_by_dest(file->elf, table_sec, table_offset);
1155 1156
		if (!table_rela)
			continue;
1157 1158 1159
		dest_insn = find_insn(file, table_rela->sym->sec, table_rela->addend);
		if (!dest_insn || !dest_insn->func || dest_insn->func->pfunc != func)
			continue;
1160

1161 1162 1163 1164 1165 1166 1167 1168 1169
		/*
		 * Use of RIP-relative switch jumps is quite rare, and
		 * indicates a rare GCC quirk/bug which can leave dead code
		 * behind.
		 */
		if (text_rela->type == R_X86_64_PC32)
			file->ignore_unreachables = true;

		return table_rela;
1170 1171 1172 1173 1174
	}

	return NULL;
}

1175 1176 1177 1178 1179 1180
/*
 * 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)
1181
{
1182 1183
	struct instruction *insn, *last = NULL;
	struct rela *rela;
1184

1185
	func_for_each_insn(file, func, insn) {
1186 1187 1188 1189 1190
		if (!last)
			last = insn;

		/*
		 * Store back-pointers for unconditional forward jumps such
1191
		 * that find_jump_table() can back-track using those and
1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202
		 * 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;
		}

1203 1204 1205
		if (insn->type != INSN_JUMP_DYNAMIC)
			continue;

1206
		rela = find_jump_table(file, func, insn);
1207 1208 1209
		if (rela) {
			rela->jump_table_start = true;
			insn->jump_table = rela;
1210 1211
		}
	}
1212 1213 1214 1215 1216 1217 1218 1219
}

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

1220
	func_for_each_insn(file, func, insn) {
1221 1222
		if (!insn->jump_table)
			continue;
1223

1224
		ret = add_jump_table(file, insn, insn->jump_table);
1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236
		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.
 */
1237
static int add_jump_table_alts(struct objtool_file *file)
1238 1239 1240 1241 1242
{
	struct section *sec;
	struct symbol *func;
	int ret;

1243
	if (!file->rodata)
1244 1245
		return 0;

1246
	for_each_sec(file, sec) {
1247 1248 1249 1250
		list_for_each_entry(func, &sec->symbol_list, list) {
			if (func->type != STT_FUNC)
				continue;

1251
			mark_func_jump_tables(file, func);
1252
			ret = add_func_jump_tables(file, func);
1253 1254 1255 1256 1257 1258 1259 1260
			if (ret)
				return ret;
		}
	}

	return 0;
}

1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289
static int read_unwind_hints(struct objtool_file *file)
{
	struct section *sec, *relasec;
	struct rela *rela;
	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;

	relasec = sec->rela;
	if (!relasec) {
		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;

1290
		rela = find_rela_by_dest(file->elf, sec, i * sizeof(*hint));
1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301
		if (!rela) {
			WARN("can't find rela for unwind_hints[%d]", i);
			return -1;
		}

		insn = find_insn(file, rela->sym->sec, rela->addend);
		if (!insn) {
			WARN("can't find insn for unwind_hints[%d]", i);
			return -1;
		}

1302
		cfa = &insn->cfi.cfa;
1303

1304
		if (hint->type == UNWIND_HINT_TYPE_RET_OFFSET) {
1305
			insn->ret_offset = hint->sp_offset;
1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342
			continue;
		}

		insn->hint = true;

		switch (hint->sp_reg) {
		case ORC_REG_UNDEFINED:
			cfa->base = CFI_UNDEFINED;
			break;
		case ORC_REG_SP:
			cfa->base = CFI_SP;
			break;
		case ORC_REG_BP:
			cfa->base = CFI_BP;
			break;
		case ORC_REG_SP_INDIRECT:
			cfa->base = CFI_SP_INDIRECT;
			break;
		case ORC_REG_R10:
			cfa->base = CFI_R10;
			break;
		case ORC_REG_R13:
			cfa->base = CFI_R13;
			break;
		case ORC_REG_DI:
			cfa->base = CFI_DI;
			break;
		case ORC_REG_DX:
			cfa->base = CFI_DX;
			break;
		default:
			WARN_FUNC("unsupported unwind_hint sp base reg %d",
				  insn->sec, insn->offset, hint->sp_reg);
			return -1;
		}

		cfa->offset = hint->sp_offset;
1343 1344
		insn->cfi.type = hint->type;
		insn->cfi.end = hint->end;
1345 1346 1347 1348 1349
	}

	return 0;
}

1350 1351
static int read_retpoline_hints(struct objtool_file *file)
{
J
Josh Poimboeuf 已提交
1352
	struct section *sec;
1353 1354 1355
	struct instruction *insn;
	struct rela *rela;

J
Josh Poimboeuf 已提交
1356
	sec = find_section_by_name(file->elf, ".rela.discard.retpoline_safe");
1357 1358 1359
	if (!sec)
		return 0;

J
Josh Poimboeuf 已提交
1360 1361 1362
	list_for_each_entry(rela, &sec->rela_list, list) {
		if (rela->sym->type != STT_SECTION) {
			WARN("unexpected relocation symbol type in %s", sec->name);
1363 1364 1365 1366 1367
			return -1;
		}

		insn = find_insn(file, rela->sym->sec, rela->addend);
		if (!insn) {
J
Josh Poimboeuf 已提交
1368
			WARN("bad .discard.retpoline_safe entry");
1369 1370 1371 1372 1373
			return -1;
		}

		if (insn->type != INSN_JUMP_DYNAMIC &&
		    insn->type != INSN_CALL_DYNAMIC) {
J
Josh Poimboeuf 已提交
1374
			WARN_FUNC("retpoline_safe hint not an indirect jump/call",
1375 1376 1377 1378 1379 1380 1381 1382 1383 1384
				  insn->sec, insn->offset);
			return -1;
		}

		insn->retpoline_safe = true;
	}

	return 0;
}

1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431
static int read_instr_hints(struct objtool_file *file)
{
	struct section *sec;
	struct instruction *insn;
	struct rela *rela;

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

	list_for_each_entry(rela, &sec->rela_list, list) {
		if (rela->sym->type != STT_SECTION) {
			WARN("unexpected relocation symbol type in %s", sec->name);
			return -1;
		}

		insn = find_insn(file, rela->sym->sec, rela->addend);
		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;

	list_for_each_entry(rela, &sec->rela_list, list) {
		if (rela->sym->type != STT_SECTION) {
			WARN("unexpected relocation symbol type in %s", sec->name);
			return -1;
		}

		insn = find_insn(file, rela->sym->sec, rela->addend);
		if (!insn) {
			WARN("bad .discard.instr_begin entry");
			return -1;
		}

		insn->instr++;
	}

	return 0;
}

1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482
static int read_intra_function_calls(struct objtool_file *file)
{
	struct instruction *insn;
	struct section *sec;
	struct rela *rela;

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

	list_for_each_entry(rela, &sec->rela_list, list) {
		unsigned long dest_off;

		if (rela->sym->type != STT_SECTION) {
			WARN("unexpected relocation symbol type in %s",
			     sec->name);
			return -1;
		}

		insn = find_insn(file, rela->sym->sec, rela->addend);
		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;
}

1483 1484 1485 1486 1487 1488
static void mark_rodata(struct objtool_file *file)
{
	struct section *sec;
	bool found = false;

	/*
1489 1490 1491 1492 1493 1494 1495 1496
	 * 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.
1497 1498
	 */
	for_each_sec(file, sec) {
1499 1500
		if (!strncmp(sec->name, ".rodata", 7) &&
		    !strstr(sec->name, ".str1.")) {
1501 1502 1503 1504 1505 1506 1507 1508
			sec->rodata = true;
			found = true;
		}
	}

	file->rodata = found;
}

1509 1510 1511 1512
static int decode_sections(struct objtool_file *file)
{
	int ret;

1513 1514
	mark_rodata(file);

1515 1516 1517 1518 1519 1520 1521 1522 1523
	ret = decode_instructions(file);
	if (ret)
		return ret;

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

	add_ignores(file);
P
Peter Zijlstra 已提交
1524
	add_uaccess_safe(file);
1525

1526
	ret = add_ignore_alternatives(file);
1527 1528 1529
	if (ret)
		return ret;

1530 1531 1532 1533
	ret = add_jump_destinations(file);
	if (ret)
		return ret;

1534
	ret = add_special_section_alts(file);
1535 1536 1537
	if (ret)
		return ret;

1538 1539 1540 1541
	ret = read_intra_function_calls(file);
	if (ret)
		return ret;

1542
	ret = add_call_destinations(file);
1543 1544 1545
	if (ret)
		return ret;

1546
	ret = add_jump_table_alts(file);
1547 1548 1549
	if (ret)
		return ret;

1550 1551 1552 1553
	ret = read_unwind_hints(file);
	if (ret)
		return ret;

1554 1555 1556 1557
	ret = read_retpoline_hints(file);
	if (ret)
		return ret;

1558 1559 1560 1561
	ret = read_instr_hints(file);
	if (ret)
		return ret;

1562 1563 1564 1565 1566
	return 0;
}

static bool is_fentry_call(struct instruction *insn)
{
1567
	if (insn->type == INSN_CALL && insn->call_dest &&
1568 1569 1570 1571 1572 1573 1574
	    insn->call_dest->type == STT_NOTYPE &&
	    !strcmp(insn->call_dest->name, "__fentry__"))
		return true;

	return false;
}

1575
static bool has_modified_stack_frame(struct instruction *insn, struct insn_state *state)
1576
{
1577
	u8 ret_offset = insn->ret_offset;
1578
	struct cfi_state *cfi = &state->cfi;
1579 1580
	int i;

1581
	if (cfi->cfa.base != initial_func_cfi.cfa.base || cfi->drap)
1582 1583
		return true;

1584
	if (cfi->cfa.offset != initial_func_cfi.cfa.offset + ret_offset)
1585 1586
		return true;

1587
	if (cfi->stack_size != initial_func_cfi.cfa.offset + ret_offset)
1588 1589
		return true;

1590 1591 1592 1593 1594 1595 1596 1597
	/*
	 * 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;

1598
	for (i = 0; i < CFI_NUM_REGS; i++) {
1599 1600
		if (cfi->regs[i].base != initial_func_cfi.regs[i].base ||
		    cfi->regs[i].offset != initial_func_cfi.regs[i].offset)
1601
			return true;
1602
	}
1603 1604 1605 1606 1607 1608

	return false;
}

static bool has_valid_stack_frame(struct insn_state *state)
{
1609 1610 1611 1612
	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)
1613 1614
		return true;

1615
	if (cfi->drap && cfi->regs[CFI_BP].base == CFI_BP)
1616 1617 1618
		return true;

	return false;
1619 1620
}

1621 1622
static int update_cfi_state_regs(struct instruction *insn,
				  struct cfi_state *cfi,
1623
				  struct stack_op *op)
1624
{
1625
	struct cfi_reg *cfa = &cfi->cfa;
1626

1627
	if (cfa->base != CFI_SP && cfa->base != CFI_SP_INDIRECT)
1628 1629 1630
		return 0;

	/* push */
P
Peter Zijlstra 已提交
1631
	if (op->dest.type == OP_DEST_PUSH || op->dest.type == OP_DEST_PUSHF)
1632 1633 1634
		cfa->offset += 8;

	/* pop */
P
Peter Zijlstra 已提交
1635
	if (op->src.type == OP_SRC_POP || op->src.type == OP_SRC_POPF)
1636 1637 1638 1639 1640 1641 1642 1643 1644 1645
		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;
}

1646
static void save_reg(struct cfi_state *cfi, unsigned char reg, int base, int offset)
1647
{
1648
	if (arch_callee_saved_reg(reg) &&
1649 1650 1651
	    cfi->regs[reg].base == CFI_UNDEFINED) {
		cfi->regs[reg].base = base;
		cfi->regs[reg].offset = offset;
1652
	}
1653 1654
}

1655
static void restore_reg(struct cfi_state *cfi, unsigned char reg)
1656
{
1657 1658
	cfi->regs[reg].base = initial_func_cfi.regs[reg].base;
	cfi->regs[reg].offset = initial_func_cfi.regs[reg].offset;
1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713
}

/*
 * 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
 */
1714
static int update_cfi_state(struct instruction *insn, struct cfi_state *cfi,
1715
			     struct stack_op *op)
1716
{
1717 1718
	struct cfi_reg *cfa = &cfi->cfa;
	struct cfi_reg *regs = cfi->regs;
1719 1720 1721 1722 1723 1724 1725 1726 1727 1728

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

1729 1730
	if (cfi->type == ORC_TYPE_REGS || cfi->type == ORC_TYPE_REGS_IRET)
		return update_cfi_state_regs(insn, cfi, op);
1731

1732 1733 1734 1735 1736 1737
	switch (op->dest.type) {

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

		case OP_SRC_REG:
1738 1739 1740 1741 1742 1743 1744
			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;
1745
				cfi->bp_scratch = false;
1746
			}
1747

1748
			else if (op->src.reg == CFI_SP &&
1749
				 op->dest.reg == CFI_BP && cfi->drap) {
1750

1751 1752
				/* drap: mov %rsp, %rbp */
				regs[CFI_BP].base = CFI_BP;
1753 1754
				regs[CFI_BP].offset = -cfi->stack_size;
				cfi->bp_scratch = false;
1755
			}
1756

1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768
			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
				 */
1769 1770
				cfi->vals[op->dest.reg].base = CFI_CFA;
				cfi->vals[op->dest.reg].offset = -cfi->stack_size;
1771 1772
			}

J
Josh Poimboeuf 已提交
1773 1774 1775 1776 1777 1778 1779 1780
			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).
				 */
1781
				cfi->stack_size = -cfi->regs[CFI_BP].offset;
J
Josh Poimboeuf 已提交
1782 1783
			}

1784 1785 1786 1787
			else if (op->dest.reg == cfa->base) {

				/* mov %reg, %rsp */
				if (cfa->base == CFI_SP &&
1788
				    cfi->vals[op->src.reg].base == CFI_CFA) {
1789 1790 1791 1792 1793 1794 1795 1796 1797

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

				} else {
					cfa->base = CFI_UNDEFINED;
					cfa->offset = 0;
				}
1805 1806 1807 1808 1809 1810 1811 1812
			}

			break;

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

				/* add imm, %rsp */
1813
				cfi->stack_size -= op->src.offset;
1814 1815 1816 1817 1818 1819 1820 1821
				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 */
1822
				cfi->stack_size = -(op->src.offset + regs[CFI_BP].offset);
1823 1824 1825
				break;
			}

1826
			if (op->src.reg == CFI_SP && cfa->base == CFI_SP) {
1827 1828

				/* drap: lea disp(%rsp), %drap */
1829
				cfi->drap_reg = op->dest.reg;
1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840

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

1845 1846 1847
				break;
			}

1848 1849
			if (cfi->drap && op->dest.reg == CFI_SP &&
			    op->src.reg == cfi->drap_reg) {
1850 1851 1852

				 /* drap: lea disp(%drap), %rsp */
				cfa->base = CFI_SP;
1853 1854 1855
				cfa->offset = cfi->stack_size = -op->src.offset;
				cfi->drap_reg = CFI_UNDEFINED;
				cfi->drap = false;
1856 1857 1858
				break;
			}

1859
			if (op->dest.reg == cfi->cfa.base) {
1860 1861 1862 1863 1864 1865 1866 1867 1868
				WARN_FUNC("unsupported stack register modification",
					  insn->sec, insn->offset);
				return -1;
			}

			break;

		case OP_SRC_AND:
			if (op->dest.reg != CFI_SP ||
1869 1870
			    (cfi->drap_reg != CFI_UNDEFINED && cfa->base != CFI_SP) ||
			    (cfi->drap_reg == CFI_UNDEFINED && cfa->base != CFI_BP)) {
1871 1872 1873 1874 1875
				WARN_FUNC("unsupported stack pointer realignment",
					  insn->sec, insn->offset);
				return -1;
			}

1876
			if (cfi->drap_reg != CFI_UNDEFINED) {
1877
				/* drap: and imm, %rsp */
1878 1879 1880
				cfa->base = cfi->drap_reg;
				cfa->offset = cfi->stack_size = 0;
				cfi->drap = true;
1881 1882 1883 1884 1885 1886 1887 1888 1889 1890
			}

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

			break;

		case OP_SRC_POP:
P
Peter Zijlstra 已提交
1891
		case OP_SRC_POPF:
1892
			if (!cfi->drap && op->dest.reg == cfa->base) {
1893 1894 1895 1896 1897

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

1898 1899 1900
			if (cfi->drap && cfa->base == CFI_BP_INDIRECT &&
			    op->dest.reg == cfi->drap_reg &&
			    cfi->drap_offset == -cfi->stack_size) {
1901

1902
				/* drap: pop %drap */
1903
				cfa->base = cfi->drap_reg;
1904
				cfa->offset = 0;
1905
				cfi->drap_offset = -1;
1906

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

1909
				/* pop %reg */
1910
				restore_reg(cfi, op->dest.reg);
1911 1912
			}

1913
			cfi->stack_size -= 8;
1914 1915 1916 1917 1918 1919
			if (cfa->base == CFI_SP)
				cfa->offset -= 8;

			break;

		case OP_SRC_REG_INDIRECT:
1920 1921
			if (cfi->drap && op->src.reg == CFI_BP &&
			    op->src.offset == cfi->drap_offset) {
1922 1923

				/* drap: mov disp(%rbp), %drap */
1924
				cfa->base = cfi->drap_reg;
1925
				cfa->offset = 0;
1926
				cfi->drap_offset = -1;
1927 1928
			}

1929
			if (cfi->drap && op->src.reg == CFI_BP &&
1930 1931 1932
			    op->src.offset == regs[op->dest.reg].offset) {

				/* drap: mov disp(%rbp), %reg */
1933
				restore_reg(cfi, op->dest.reg);
1934 1935 1936 1937 1938 1939

			} 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 */
1940
				restore_reg(cfi, op->dest.reg);
1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953
			}

			break;

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

		break;

	case OP_DEST_PUSH:
P
Peter Zijlstra 已提交
1954
	case OP_DEST_PUSHF:
1955
		cfi->stack_size += 8;
1956 1957 1958 1959 1960 1961
		if (cfa->base == CFI_SP)
			cfa->offset += 8;

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

1962 1963
		if (cfi->drap) {
			if (op->src.reg == cfa->base && op->src.reg == cfi->drap_reg) {
1964 1965 1966

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

1969
				/* save drap so we know when to restore it */
1970
				cfi->drap_offset = -cfi->stack_size;
1971

1972
			} else if (op->src.reg == CFI_BP && cfa->base == cfi->drap_reg) {
1973 1974

				/* drap: push %rbp */
1975
				cfi->stack_size = 0;
1976 1977 1978 1979

			} else if (regs[op->src.reg].base == CFI_UNDEFINED) {

				/* drap: push %reg */
1980
				save_reg(cfi, op->src.reg, CFI_BP, -cfi->stack_size);
1981 1982 1983 1984 1985
			}

		} else {

			/* push %reg */
1986
			save_reg(cfi, op->src.reg, CFI_CFA, -cfi->stack_size);
1987 1988 1989
		}

		/* detect when asm code uses rbp as a scratch register */
1990
		if (!no_fp && insn->func && op->src.reg == CFI_BP &&
1991
		    cfa->base != CFI_BP)
1992
			cfi->bp_scratch = true;
1993 1994 1995 1996
		break;

	case OP_DEST_REG_INDIRECT:

1997 1998
		if (cfi->drap) {
			if (op->src.reg == cfa->base && op->src.reg == cfi->drap_reg) {
1999 2000 2001 2002 2003

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

2004
				/* save drap offset so we know when to restore it */
2005
				cfi->drap_offset = op->dest.offset;
2006 2007 2008 2009 2010
			}

			else if (regs[op->src.reg].base == CFI_UNDEFINED) {

				/* drap: mov reg, disp(%rbp) */
2011
				save_reg(cfi, op->src.reg, CFI_BP, op->dest.offset);
2012 2013 2014 2015 2016 2017
			}

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

			/* mov reg, disp(%rbp) */
			/* mov reg, disp(%rsp) */
2018 2019
			save_reg(cfi, op->src.reg, CFI_CFA,
				 op->dest.offset - cfi->cfa.offset);
2020 2021 2022 2023 2024
		}

		break;

	case OP_DEST_LEAVE:
2025 2026
		if ((!cfi->drap && cfa->base != CFI_BP) ||
		    (cfi->drap && cfa->base != cfi->drap_reg)) {
2027 2028 2029 2030 2031 2032 2033
			WARN_FUNC("leave instruction with modified stack frame",
				  insn->sec, insn->offset);
			return -1;
		}

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

2034 2035
		cfi->stack_size = -cfi->regs[CFI_BP].offset - 8;
		restore_reg(cfi, CFI_BP);
2036

2037
		if (!cfi->drap) {
2038 2039 2040 2041 2042 2043 2044
			cfa->base = CFI_SP;
			cfa->offset -= 8;
		}

		break;

	case OP_DEST_MEM:
P
Peter Zijlstra 已提交
2045
		if (op->src.type != OP_SRC_POP && op->src.type != OP_SRC_POPF) {
2046 2047 2048 2049 2050 2051
			WARN_FUNC("unknown stack-related memory operation",
				  insn->sec, insn->offset);
			return -1;
		}

		/* pop mem */
2052
		cfi->stack_size -= 8;
2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066
		if (cfa->base == CFI_SP)
			cfa->offset -= 8;

		break;

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

	return 0;
}

2067 2068 2069 2070 2071
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) {
2072
		struct cfi_state old_cfi = state->cfi;
2073 2074
		int res;

2075
		res = update_cfi_state(insn, &state->cfi, op);
2076 2077 2078
		if (res)
			return res;

2079 2080 2081 2082 2083
		if (insn->alt_group && memcmp(&state->cfi, &old_cfi, sizeof(struct cfi_state))) {
			WARN_FUNC("alternative modifies stack", insn->sec, insn->offset);
			return -1;
		}

2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108
		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;
}

2109
static bool insn_cfi_match(struct instruction *insn, struct cfi_state *cfi2)
2110
{
2111
	struct cfi_state *cfi1 = &insn->cfi;
2112 2113
	int i;

2114 2115
	if (memcmp(&cfi1->cfa, &cfi2->cfa, sizeof(cfi1->cfa))) {

2116 2117
		WARN_FUNC("stack state mismatch: cfa1=%d%+d cfa2=%d%+d",
			  insn->sec, insn->offset,
2118 2119
			  cfi1->cfa.base, cfi1->cfa.offset,
			  cfi2->cfa.base, cfi2->cfa.offset);
2120

2121
	} else if (memcmp(&cfi1->regs, &cfi2->regs, sizeof(cfi1->regs))) {
2122
		for (i = 0; i < CFI_NUM_REGS; i++) {
2123
			if (!memcmp(&cfi1->regs[i], &cfi2->regs[i],
2124 2125 2126 2127 2128
				    sizeof(struct cfi_reg)))
				continue;

			WARN_FUNC("stack state mismatch: reg1[%d]=%d%+d reg2[%d]=%d%+d",
				  insn->sec, insn->offset,
2129 2130
				  i, cfi1->regs[i].base, cfi1->regs[i].offset,
				  i, cfi2->regs[i].base, cfi2->regs[i].offset);
2131 2132 2133
			break;
		}

2134 2135
	} else if (cfi1->type != cfi2->type) {

2136
		WARN_FUNC("stack state mismatch: type1=%d type2=%d",
2137 2138 2139 2140 2141
			  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)) {
2142

2143
		WARN_FUNC("stack state mismatch: drap1=%d(%d,%d) drap2=%d(%d,%d)",
2144
			  insn->sec, insn->offset,
2145 2146
			  cfi1->drap, cfi1->drap_reg, cfi1->drap_offset,
			  cfi2->drap, cfi2->drap_reg, cfi2->drap_offset);
2147 2148 2149 2150 2151

	} else
		return true;

	return false;
2152 2153
}

P
Peter Zijlstra 已提交
2154 2155 2156
static inline bool func_uaccess_safe(struct symbol *func)
{
	if (func)
2157
		return func->uaccess_safe;
P
Peter Zijlstra 已提交
2158 2159 2160 2161

	return false;
}

2162
static inline const char *call_dest_name(struct instruction *insn)
P
Peter Zijlstra 已提交
2163 2164 2165 2166 2167 2168 2169 2170 2171
{
	if (insn->call_dest)
		return insn->call_dest->name;

	return "{dynamic}";
}

static int validate_call(struct instruction *insn, struct insn_state *state)
{
2172
	if (state->noinstr && state->instr <= 0 &&
2173
	    (!insn->call_dest || !insn->call_dest->sec->noinstr)) {
2174 2175 2176 2177 2178
		WARN_FUNC("call to %s() leaves .noinstr.text section",
				insn->sec, insn->offset, call_dest_name(insn));
		return 1;
	}

P
Peter Zijlstra 已提交
2179 2180
	if (state->uaccess && !func_uaccess_safe(insn->call_dest)) {
		WARN_FUNC("call to %s() with UACCESS enabled",
2181
				insn->sec, insn->offset, call_dest_name(insn));
P
Peter Zijlstra 已提交
2182 2183 2184
		return 1;
	}

2185 2186
	if (state->df) {
		WARN_FUNC("call to %s() with DF set",
2187
				insn->sec, insn->offset, call_dest_name(insn));
2188 2189 2190
		return 1;
	}

P
Peter Zijlstra 已提交
2191 2192 2193
	return 0;
}

2194 2195
static int validate_sibling_call(struct instruction *insn, struct insn_state *state)
{
2196
	if (has_modified_stack_frame(insn, state)) {
2197 2198 2199 2200 2201
		WARN_FUNC("sibling call from callable instruction with modified stack frame",
				insn->sec, insn->offset);
		return 1;
	}

P
Peter Zijlstra 已提交
2202
	return validate_call(insn, state);
2203 2204
}

2205 2206
static int validate_return(struct symbol *func, struct instruction *insn, struct insn_state *state)
{
2207 2208 2209 2210 2211 2212
	if (state->noinstr && state->instr > 0) {
		WARN_FUNC("return with instrumentation enabled",
			  insn->sec, insn->offset);
		return 1;
	}

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

2231
	if (func && has_modified_stack_frame(insn, state)) {
2232 2233 2234 2235 2236
		WARN_FUNC("return with modified stack frame",
			  insn->sec, insn->offset);
		return 1;
	}

2237
	if (state->cfi.bp_scratch) {
2238 2239
		WARN_FUNC("BP used as a scratch register",
			  insn->sec, insn->offset);
2240 2241 2242 2243 2244 2245
		return 1;
	}

	return 0;
}

2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269
/*
 * 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;
	}
}

2270 2271 2272 2273 2274 2275
/*
 * 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.
 */
2276
static int validate_branch(struct objtool_file *file, struct symbol *func,
P
Peter Zijlstra 已提交
2277
			   struct instruction *insn, struct insn_state state)
2278 2279
{
	struct alternative *alt;
P
Peter Zijlstra 已提交
2280
	struct instruction *next_insn;
2281
	struct section *sec;
2282
	u8 visited;
2283 2284 2285 2286 2287
	int ret;

	sec = insn->sec;

	while (1) {
2288 2289
		next_insn = next_insn_same_sec(file, insn);

2290
		if (file->c_file && func && insn->func && func != insn->func->pfunc) {
2291 2292 2293
			WARN("%s() falls through to next function %s()",
			     func->name, insn->func->name);
			return 1;
2294 2295
		}

2296 2297 2298
		if (func && insn->ignore) {
			WARN_FUNC("BUG: why am I validating an ignored function?",
				  sec, insn->offset);
2299
			return 1;
2300 2301
		}

2302
		visited = 1 << state.uaccess;
2303
		if (insn->visited) {
2304
			if (!insn->hint && !insn_cfi_match(insn, &state.cfi))
2305 2306
				return 1;

2307
			if (insn->visited & visited)
P
Peter Zijlstra 已提交
2308
				return 0;
2309 2310
		}

2311 2312 2313
		if (state.noinstr)
			state.instr += insn->instr;

2314
		if (insn->hint)
2315
			state.cfi = insn->cfi;
2316
		else
2317
			insn->cfi = state.cfi;
2318

2319
		insn->visited |= visited;
2320

2321
		if (!insn->ignore_alts && !list_empty(&insn->alts)) {
P
Peter Zijlstra 已提交
2322 2323
			bool skip_orig = false;

2324
			list_for_each_entry(alt, &insn->alts, list) {
P
Peter Zijlstra 已提交
2325 2326 2327
				if (alt->skip_orig)
					skip_orig = true;

2328
				ret = validate_branch(file, func, alt->insn, state);
2329 2330 2331 2332 2333
				if (ret) {
					if (backtrace)
						BT_FUNC("(alt)", insn);
					return ret;
				}
2334
			}
P
Peter Zijlstra 已提交
2335

2336 2337 2338
			if (insn->alt_group)
				fill_alternative_cfi(file, insn);

P
Peter Zijlstra 已提交
2339 2340
			if (skip_orig)
				return 0;
2341 2342
		}

2343 2344 2345
		if (handle_insn_ops(insn, &state))
			return 1;

2346 2347 2348
		switch (insn->type) {

		case INSN_RETURN:
2349
			return validate_return(func, insn, &state);
2350 2351

		case INSN_CALL:
P
Peter Zijlstra 已提交
2352 2353 2354 2355
		case INSN_CALL_DYNAMIC:
			ret = validate_call(insn, &state);
			if (ret)
				return ret;
2356

2357 2358
			if (!no_fp && func && !is_fentry_call(insn) &&
			    !has_valid_stack_frame(&state)) {
2359 2360 2361 2362
				WARN_FUNC("call without frame pointer save/setup",
					  sec, insn->offset);
				return 1;
			}
2363 2364 2365 2366

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

2367 2368 2369 2370
			break;

		case INSN_JUMP_CONDITIONAL:
		case INSN_JUMP_UNCONDITIONAL:
2371
			if (func && is_sibling_call(insn)) {
2372
				ret = validate_sibling_call(insn, &state);
2373
				if (ret)
2374
					return ret;
2375

2376
			} else if (insn->jump_dest) {
2377 2378
				ret = validate_branch(file, func,
						      insn->jump_dest, state);
2379 2380 2381 2382 2383
				if (ret) {
					if (backtrace)
						BT_FUNC("(branch)", insn);
					return ret;
				}
2384
			}
2385 2386 2387 2388 2389 2390 2391

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

			break;

		case INSN_JUMP_DYNAMIC:
2392
		case INSN_JUMP_DYNAMIC_CONDITIONAL:
2393
			if (func && is_sibling_call(insn)) {
2394 2395 2396
				ret = validate_sibling_call(insn, &state);
				if (ret)
					return ret;
2397 2398
			}

2399 2400 2401 2402
			if (insn->type == INSN_JUMP_DYNAMIC)
				return 0;

			break;
2403

2404 2405 2406 2407 2408 2409 2410 2411
		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 已提交
2412 2413 2414 2415 2416 2417 2418 2419 2420 2421
		case INSN_STAC:
			if (state.uaccess) {
				WARN_FUNC("recursive UACCESS enable", sec, insn->offset);
				return 1;
			}

			state.uaccess = true;
			break;

		case INSN_CLAC:
2422
			if (!state.uaccess && func) {
P
Peter Zijlstra 已提交
2423 2424 2425 2426 2427 2428 2429 2430 2431 2432
				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;
2433 2434
			break;

2435 2436 2437 2438 2439 2440 2441 2442
		case INSN_STD:
			if (state.df)
				WARN_FUNC("recursive STD", sec, insn->offset);

			state.df = true;
			break;

		case INSN_CLD:
2443
			if (!state.df && func)
2444 2445 2446
				WARN_FUNC("redundant CLD", sec, insn->offset);

			state.df = false;
2447 2448
			break;

2449 2450 2451 2452 2453 2454 2455
		default:
			break;
		}

		if (insn->dead_end)
			return 0;

2456
		if (!next_insn) {
2457
			if (state.cfi.cfa.base == CFI_UNDEFINED)
2458
				return 0;
2459 2460 2461
			WARN("%s: unexpected end of section", sec->name);
			return 1;
		}
2462 2463

		insn = next_insn;
2464 2465 2466 2467 2468
	}

	return 0;
}

2469
static int validate_unwind_hints(struct objtool_file *file, struct section *sec)
2470 2471 2472
{
	struct instruction *insn;
	struct insn_state state;
2473
	int ret, warnings = 0;
2474 2475 2476 2477

	if (!file->hints)
		return 0;

2478
	init_insn_state(&state, sec);
2479

2480 2481 2482 2483 2484 2485 2486 2487 2488
	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)) {
2489
		if (insn->hint && !insn->visited) {
2490
			ret = validate_branch(file, insn->func, insn, state);
2491 2492
			if (ret && backtrace)
				BT_FUNC("<=== (hint)", insn);
2493 2494
			warnings += ret;
		}
2495 2496

		insn = list_next_entry(insn, list);
2497 2498 2499 2500 2501
	}

	return warnings;
}

2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514
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;

2515 2516 2517 2518 2519 2520 2521 2522 2523
		/*
		 * .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;

2524 2525 2526 2527 2528 2529 2530 2531 2532 2533
		WARN_FUNC("indirect %s found in RETPOLINE build",
			  insn->sec, insn->offset,
			  insn->type == INSN_JUMP_DYNAMIC ? "jump" : "call");

		warnings++;
	}

	return warnings;
}

2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546
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"));
}

2547
static bool ignore_unreachable_insn(struct instruction *insn)
2548 2549 2550
{
	int i;

2551 2552 2553 2554 2555 2556
	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.
2557 2558 2559
	 *
	 * Also ignore alternative replacement instructions.  This can happen
	 * when a whitelisted function uses one of the ALTERNATIVE macros.
2560
	 */
2561 2562 2563
	if (!strcmp(insn->sec->name, ".fixup") ||
	    !strcmp(insn->sec->name, ".altinstr_replacement") ||
	    !strcmp(insn->sec->name, ".altinstr_aux"))
2564 2565
		return true;

2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580
	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).
	 */
	if (list_prev_entry(insn, list)->dead_end &&
	    (insn->type == INSN_BUG ||
	     (insn->type == INSN_JUMP_UNCONDITIONAL &&
	      insn->jump_dest && insn->jump_dest->type == INSN_BUG)))
		return true;

2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591
	/*
	 * 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;

2592 2593 2594 2595 2596 2597 2598 2599
		if (insn->type == INSN_JUMP_UNCONDITIONAL) {
			if (insn->jump_dest &&
			    insn->jump_dest->func == insn->func) {
				insn = insn->jump_dest;
				continue;
			}

			break;
2600 2601
		}

2602
		if (insn->offset + insn->len >= insn->func->offset + insn->func->len)
2603
			break;
2604

2605 2606 2607 2608 2609 2610
		insn = list_next_entry(insn, list);
	}

	return false;
}

2611 2612
static int validate_symbol(struct objtool_file *file, struct section *sec,
			   struct symbol *sym, struct insn_state *state)
2613 2614
{
	struct instruction *insn;
2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638
	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)
{
2639
	struct insn_state state;
2640 2641
	struct symbol *func;
	int warnings = 0;
2642

2643 2644 2645
	list_for_each_entry(func, &sec->symbol_list, list) {
		if (func->type != STT_FUNC)
			continue;
2646

2647
		init_insn_state(&state, sec);
2648 2649
		state.cfi.cfa = initial_func_cfi.cfa;
		memcpy(&state.cfi.regs, &initial_func_cfi.regs,
2650
		       CFI_NUM_REGS * sizeof(struct cfi_reg));
2651
		state.cfi.stack_size = initial_func_cfi.cfa.offset;
2652

2653
		warnings += validate_symbol(file, sec, func, &state);
2654 2655 2656 2657 2658
	}

	return warnings;
}

2659 2660 2661
static int validate_vmlinux_functions(struct objtool_file *file)
{
	struct section *sec;
2662
	int warnings = 0;
2663 2664

	sec = find_section_by_name(file->elf, ".noinstr.text");
2665 2666 2667 2668
	if (sec) {
		warnings += validate_section(file, sec);
		warnings += validate_unwind_hints(file, sec);
	}
2669

2670 2671 2672 2673 2674
	sec = find_section_by_name(file->elf, ".entry.text");
	if (sec) {
		warnings += validate_section(file, sec);
		warnings += validate_unwind_hints(file, sec);
	}
2675 2676

	return warnings;
2677 2678
}

2679 2680 2681 2682 2683
static int validate_functions(struct objtool_file *file)
{
	struct section *sec;
	int warnings = 0;

2684 2685 2686 2687
	for_each_sec(file, sec) {
		if (!(sec->sh.sh_flags & SHF_EXECINSTR))
			continue;

2688
		warnings += validate_section(file, sec);
2689
	}
2690 2691 2692 2693

	return warnings;
}

2694
static int validate_reachable_instructions(struct objtool_file *file)
2695 2696
{
	struct instruction *insn;
2697 2698 2699

	if (file->ignore_unreachables)
		return 0;
2700 2701

	for_each_insn(file, insn) {
2702 2703 2704 2705 2706
		if (insn->visited || ignore_unreachable_insn(insn))
			continue;

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

2709
	return 0;
2710 2711
}

2712 2713
static struct objtool_file file;

2714
int check(const char *_objname, bool orc)
2715 2716 2717 2718 2719
{
	int ret, warnings = 0;

	objname = _objname;

2720
	file.elf = elf_open_read(objname, orc ? O_RDWR : O_RDONLY);
2721
	if (!file.elf)
2722 2723 2724 2725 2726
		return 1;

	INIT_LIST_HEAD(&file.insn_list);
	hash_init(file.insn_hash);
	file.c_file = find_section_by_name(file.elf, ".comment");
2727
	file.ignore_unreachables = no_unreachable;
2728
	file.hints = false;
2729

2730 2731
	arch_initial_func_cfi_state(&initial_func_cfi);

2732 2733 2734 2735 2736
	ret = decode_sections(&file);
	if (ret < 0)
		goto out;
	warnings += ret;

2737
	if (list_empty(&file.insn_list))
2738 2739
		goto out;

2740 2741 2742 2743 2744 2745 2746 2747 2748
	if (vmlinux && !validate_dup) {
		ret = validate_vmlinux_functions(&file);
		if (ret < 0)
			goto out;

		warnings += ret;
		goto out;
	}

2749 2750 2751 2752 2753 2754 2755
	if (retpoline) {
		ret = validate_retpoline(&file);
		if (ret < 0)
			return ret;
		warnings += ret;
	}

2756
	ret = validate_functions(&file);
2757 2758 2759 2760
	if (ret < 0)
		goto out;
	warnings += ret;

2761
	ret = validate_unwind_hints(&file, NULL);
2762 2763 2764 2765
	if (ret < 0)
		goto out;
	warnings += ret;

2766 2767 2768 2769 2770 2771 2772
	if (!warnings) {
		ret = validate_reachable_instructions(&file);
		if (ret < 0)
			goto out;
		warnings += ret;
	}

2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786
	if (orc) {
		ret = create_orc(&file);
		if (ret < 0)
			goto out;

		ret = create_orc_sections(&file);
		if (ret < 0)
			goto out;

		ret = elf_write(file.elf);
		if (ret < 0)
			goto out;
	}

2787
out:
2788 2789 2790 2791 2792 2793 2794 2795 2796
	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;
	}

2797 2798
	return 0;
}