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

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

9
#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
#define func_for_each_insn(file, func, insn)				\
77 78 79 80
	for (insn = find_insn(file, func->sec, func->offset);		\
	     insn;							\
	     insn = next_insn_same_func(file, insn))

81 82
#define sym_for_each_insn(file, sym, insn)				\
	for (insn = find_insn(file, sym->sec, sym->offset);		\
83
	     insn && &insn->list != &file->insn_list &&			\
84 85
		insn->sec == sym->sec &&				\
		insn->offset < sym->offset + sym->len;			\
86 87
	     insn = list_next_entry(insn, list))

88
#define sym_for_each_insn_continue_reverse(file, sym, insn)		\
89 90
	for (insn = list_prev_entry(insn, list);			\
	     &insn->list != &file->insn_list &&				\
91
		insn->sec == sym->sec && insn->offset >= sym->offset;	\
92 93 94 95 96
	     insn = list_prev_entry(insn, list))

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

97 98 99
#define sec_for_each_insn_continue(file, insn)				\
	for (insn = next_insn_same_sec(file, insn); insn;		\
	     insn = next_insn_same_sec(file, insn))
100

101 102 103 104 105 106
static bool is_static_jump(struct instruction *insn)
{
	return insn->type == INSN_JUMP_CONDITIONAL ||
	       insn->type == INSN_JUMP_UNCONDITIONAL;
}

107 108 109 110 111 112
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);

113
	if (!is_static_jump(insn))
114 115 116 117 118 119
		return false;

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

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

156 157 158
	if (!func)
		return false;

159
	if (func->bind == STB_WEAK)
160
		return false;
161 162 163 164

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

167
	if (!func->len)
168
		return false;
169

170 171
	insn = find_insn(file, func->sec, func->offset);
	if (!insn->func)
172
		return false;
173

174
	func_for_each_insn(file, func, insn) {
175 176 177
		empty = false;

		if (insn->type == INSN_RETURN)
178
			return false;
179 180 181
	}

	if (empty)
182
		return false;
183 184 185 186 187 188

	/*
	 * 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.
	 */
189
	func_for_each_insn(file, func, insn) {
190
		if (is_sibling_call(insn)) {
191 192 193 194
			struct instruction *dest = insn->jump_dest;

			if (!dest)
				/* sibling call to another file */
195
				return false;
196

197 198 199 200 201 202 203 204
			/* 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;
205 206
			}

207 208
			return __dead_end_function(file, dest->func, recursion+1);
		}
209 210
	}

211
	return true;
212 213
}

214
static bool dead_end_function(struct objtool_file *file, struct symbol *func)
215 216 217 218
{
	return __dead_end_function(file, func, 0);
}

219
static void init_cfi_state(struct cfi_state *cfi)
220 221 222
{
	int i;

223
	for (i = 0; i < CFI_NUM_REGS; i++) {
224 225
		cfi->regs[i].base = CFI_UNDEFINED;
		cfi->vals[i].base = CFI_UNDEFINED;
226
	}
227 228 229 230 231
	cfi->cfa.base = CFI_UNDEFINED;
	cfi->drap_reg = CFI_UNDEFINED;
	cfi->drap_offset = -1;
}

232
static void init_insn_state(struct insn_state *state, struct section *sec)
233 234 235
{
	memset(state, 0, sizeof(*state));
	init_cfi_state(&state->cfi);
236 237 238 239 240 241 242 243

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

246 247 248 249 250 251 252 253 254 255
/*
 * 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 已提交
256
	unsigned long nr_insns = 0;
257 258
	int ret;

259
	for_each_sec(file, sec) {
260 261 262 263

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

264 265 266 267 268
		if (strcmp(sec->name, ".altinstr_replacement") &&
		    strcmp(sec->name, ".altinstr_aux") &&
		    strncmp(sec->name, ".discard.", 9))
			sec->text = true;

269 270
		if (!strcmp(sec->name, ".noinstr.text") ||
		    !strcmp(sec->name, ".entry.text"))
271 272
			sec->noinstr = true;

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

284 285 286 287 288 289
			insn->sec = sec;
			insn->offset = offset;

			ret = arch_decode_instruction(file->elf, sec, offset,
						      sec->len - offset,
						      &insn->len, &insn->type,
290
						      &insn->immediate,
291
						      &insn->stack_ops);
292
			if (ret)
293
				goto err;
294

295
			hash_add(file->insn_hash, &insn->hash, sec_offset_hash(sec, insn->offset));
296
			list_add_tail(&insn->list, &file->insn_list);
P
Peter Zijlstra 已提交
297
			nr_insns++;
298 299 300
		}

		list_for_each_entry(func, &sec->symbol_list, list) {
301
			if (func->type != STT_FUNC || func->alias != func)
302 303 304 305 306 307 308 309
				continue;

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

310
			sym_for_each_insn(file, func, insn)
311
				insn->func = func;
312 313 314
		}
	}

P
Peter Zijlstra 已提交
315 316 317
	if (stats)
		printf("nr_insns: %lu\n", nr_insns);

318
	return 0;
319 320 321 322

err:
	free(insn);
	return ret;
323 324 325
}

/*
326
 * Mark "ud2" instructions and manually annotated dead ends.
327 328 329 330 331 332 333 334
 */
static int add_dead_ends(struct objtool_file *file)
{
	struct section *sec;
	struct rela *rela;
	struct instruction *insn;
	bool found;

335 336 337 338 339 340 341 342 343 344 345
	/*
	 * 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.
	 */
346 347
	sec = find_section_by_name(file->elf, ".rela.discard.unreachable");
	if (!sec)
348
		goto reachable;
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380

	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) {
			found = false;
			list_for_each_entry_reverse(insn, &file->insn_list, list) {
				if (insn->sec == rela->sym->sec) {
					found = true;
					break;
				}
			}

			if (!found) {
				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;
	}

381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
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) {
			found = false;
			list_for_each_entry_reverse(insn, &file->insn_list, list) {
				if (insn->sec == rela->sym->sec) {
					found = true;
					break;
				}
			}

			if (!found) {
				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;
	}

423 424 425 426 427 428 429 430 431 432 433
	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 已提交
434
	struct rela *rela;
435

P
Peter Zijlstra 已提交
436 437 438
	sec = find_section_by_name(file->elf, ".rela.discard.func_stack_frame_non_standard");
	if (!sec)
		return;
439

P
Peter Zijlstra 已提交
440 441 442 443 444 445 446
	list_for_each_entry(rela, &sec->rela_list, list) {
		switch (rela->sym->type) {
		case STT_FUNC:
			func = rela->sym;
			break;

		case STT_SECTION:
447 448
			func = find_func_by_offset(rela->sym->sec, rela->addend);
			if (!func)
449
				continue;
P
Peter Zijlstra 已提交
450
			break;
451

P
Peter Zijlstra 已提交
452 453 454
		default:
			WARN("unexpected relocation symbol type in %s: %d", sec->name, rela->sym->type);
			continue;
455
		}
P
Peter Zijlstra 已提交
456

457
		func_for_each_insn(file, func, insn)
P
Peter Zijlstra 已提交
458
			insn->ignore = true;
459 460 461
	}
}

P
Peter Zijlstra 已提交
462 463 464 465 466 467 468 469 470 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
/*
 * 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",
510
	"__sanitizer_cov_trace_switch",
P
Peter Zijlstra 已提交
511 512 513 514
	/* UBSAN */
	"ubsan_type_mismatch_common",
	"__ubsan_handle_type_mismatch",
	"__ubsan_handle_type_mismatch_v1",
515
	"__ubsan_handle_shift_out_of_bounds",
P
Peter Zijlstra 已提交
516 517 518
	/* misc */
	"csum_partial_copy_generic",
	"__memcpy_mcsafe",
519
	"mcsafe_handle_tail",
P
Peter Zijlstra 已提交
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
	"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;

537
		func->uaccess_safe = true;
538 539 540
	}
}

541 542 543 544 545 546
/*
 * 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.
 */
547
static int add_ignore_alternatives(struct objtool_file *file)
548 549 550 551 552
{
	struct section *sec;
	struct rela *rela;
	struct instruction *insn;

553
	sec = find_section_by_name(file->elf, ".rela.discard.ignore_alts");
554 555 556 557 558 559 560 561 562 563 564
	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) {
565
			WARN("bad .discard.ignore_alts entry");
566 567 568 569 570 571 572 573 574
			return -1;
		}

		insn->ignore_alts = true;
	}

	return 0;
}

575 576 577 578 579 580 581 582 583 584 585
/*
 * 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) {
586
		if (!is_static_jump(insn))
587 588
			continue;

589
		if (insn->ignore || insn->offset == FAKE_JUMP_OFFSET)
590 591
			continue;

592 593
		rela = find_rela_by_dest_range(file->elf, insn->sec,
					       insn->offset, insn->len);
594 595
		if (!rela) {
			dest_sec = insn->sec;
596
			dest_off = arch_jump_destination(insn);
597 598
		} else if (rela->sym->type == STT_SECTION) {
			dest_sec = rela->sym->sec;
599
			dest_off = arch_dest_rela_offset(rela->addend);
600 601
		} else if (rela->sym->sec->idx) {
			dest_sec = rela->sym->sec;
602 603
			dest_off = rela->sym->sym.st_value +
				   arch_dest_rela_offset(rela->addend);
604 605 606 607 608
		} else if (strstr(rela->sym->name, "_indirect_thunk_")) {
			/*
			 * Retpoline jumps are really dynamic jumps in
			 * disguise, so convert them accordingly.
			 */
609 610 611 612 613
			if (insn->type == INSN_JUMP_UNCONDITIONAL)
				insn->type = INSN_JUMP_DYNAMIC;
			else
				insn->type = INSN_JUMP_DYNAMIC_CONDITIONAL;

614
			insn->retpoline_safe = true;
615
			continue;
616
		} else {
617
			/* external sibling call */
618
			insn->call_dest = rela->sym;
619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
			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;
		}
638 639

		/*
640
		 * Cross-function jump.
641 642
		 */
		if (insn->func && insn->jump_dest->func &&
643 644 645 646 647 648 649 650 651 652 653 654 655 656 657
		    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
658
			 * subfunction is through a jump table.
659 660 661 662 663 664 665 666 667
			 */
			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) {

668
				/* internal sibling call */
669 670
				insn->call_dest = insn->jump_dest->func;
			}
671
		}
672 673 674 675 676
	}

	return 0;
}

677 678 679 680 681 682 683 684 685 686
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);
	}
}

687 688 689 690 691 692 693 694 695 696 697 698 699
/*
 * 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;

700 701
		rela = find_rela_by_dest_range(file->elf, insn->sec,
					       insn->offset, insn->len);
702
		if (!rela) {
703
			dest_off = arch_jump_destination(insn);
704 705 706
			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);
707

708 709 710 711
			if (insn->ignore)
				continue;

			if (!insn->call_dest) {
712
				WARN_FUNC("unannotated intra-function call", insn->sec, insn->offset);
713 714
				return -1;
			}
715

716 717 718 719 720 721
			if (insn->func && insn->call_dest->type != STT_FUNC) {
				WARN_FUNC("unsupported call to non-function",
					  insn->sec, insn->offset);
				return -1;
			}

722
		} else if (rela->sym->type == STT_SECTION) {
723
			dest_off = arch_dest_rela_offset(rela->addend);
724
			insn->call_dest = find_func_by_offset(rela->sym->sec,
725
							      dest_off);
726
			if (!insn->call_dest) {
727
				WARN_FUNC("can't find call dest symbol at %s+0x%lx",
728 729
					  insn->sec, insn->offset,
					  rela->sym->sec->name,
730
					  dest_off);
731 732 733 734
				return -1;
			}
		} else
			insn->call_dest = rela->sym;
735 736 737 738 739 740 741 742 743

		/*
		 * 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);
744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770
	}

	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)
{
771
	static unsigned int alt_group_next_index = 1;
772
	struct instruction *last_orig_insn, *last_new_insn, *insn, *fake_jump = NULL;
773
	unsigned int alt_group = alt_group_next_index++;
774 775 776 777 778 779 780 781
	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;

782
		insn->alt_group = alt_group;
783 784 785
		last_orig_insn = insn;
	}

786 787 788 789 790 791 792 793
	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);
794
		INIT_LIST_HEAD(&fake_jump->stack_ops);
795
		init_cfi_state(&fake_jump->cfi);
796 797

		fake_jump->sec = special_alt->new_sec;
798
		fake_jump->offset = FAKE_JUMP_OFFSET;
799 800
		fake_jump->type = INSN_JUMP_UNCONDITIONAL;
		fake_jump->jump_dest = list_next_entry(last_orig_insn, list);
801
		fake_jump->func = orig_insn->func;
802 803 804
	}

	if (!special_alt->new_len) {
805 806 807 808 809 810
		if (!fake_jump) {
			WARN("%s: empty alternative at end of section",
			     special_alt->orig_sec->name);
			return -1;
		}

811 812 813 814 815
		*new_insn = fake_jump;
		return 0;
	}

	last_new_insn = NULL;
816
	alt_group = alt_group_next_index++;
817 818 819 820 821 822 823
	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;

824
		insn->ignore = orig_insn->ignore_alts;
825
		insn->func = orig_insn->func;
826
		insn->alt_group = alt_group;
827

828 829 830 831 832 833 834 835 836 837 838 839 840 841
		/*
		 * 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))) &&
842
		    find_rela_by_dest_range(file->elf, insn->sec, insn->offset, insn->len)) {
843 844 845 846 847 848

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

849
		if (!is_static_jump(insn))
850 851 852 853 854
			continue;

		if (!insn->immediate)
			continue;

855
		dest_off = arch_jump_destination(insn);
856 857 858 859 860 861
		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;
			}
862
			insn->jump_dest = fake_jump;
863
		}
864 865 866 867 868 869 870 871 872 873 874 875 876 877

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

878 879
	if (fake_jump)
		list_add(&fake_jump->list, &last_new_insn->list);
880 881 882 883 884 885 886 887 888 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

	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) {
950 951 952 953 954 955
			if (!special_alt->orig_len) {
				WARN_FUNC("empty alternative entry",
					  orig_insn->sec, orig_insn->offset);
				continue;
			}

956 957 958 959 960 961 962 963 964 965 966
			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;
		}

967 968 969 970 971 972 973
		alt = malloc(sizeof(*alt));
		if (!alt) {
			WARN("malloc failed");
			ret = -1;
			goto out;
		}

974
		alt->insn = new_insn;
P
Peter Zijlstra 已提交
975
		alt->skip_orig = special_alt->skip_orig;
P
Peter Zijlstra 已提交
976
		orig_insn->ignore_alts |= special_alt->skip_alt;
977 978 979 980 981 982 983 984 985 986
		list_add_tail(&alt->list, &orig_insn->alts);

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

out:
	return ret;
}

987
static int add_jump_table(struct objtool_file *file, struct instruction *insn,
988
			    struct rela *table)
989 990
{
	struct rela *rela = table;
991
	struct instruction *dest_insn;
992
	struct alternative *alt;
993 994
	struct symbol *pfunc = insn->func->pfunc;
	unsigned int prev_offset = 0;
995

996 997 998 999 1000
	/*
	 * Each @rela is a switch table relocation which points to the target
	 * instruction.
	 */
	list_for_each_entry_from(rela, &table->sec->rela_list, list) {
1001 1002 1003

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

1006
		/* Make sure the table entries are consecutive: */
1007 1008 1009 1010 1011 1012 1013 1014
		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;

1015 1016
		dest_insn = find_insn(file, rela->sym->sec, rela->addend);
		if (!dest_insn)
1017 1018
			break;

1019
		/* Make sure the destination is in the same function: */
1020
		if (!dest_insn->func || dest_insn->func->pfunc != pfunc)
1021
			break;
1022 1023 1024 1025 1026 1027 1028

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

1029
		alt->insn = dest_insn;
1030
		list_add_tail(&alt->list, &insn->alts);
1031 1032 1033 1034 1035 1036 1037
		prev_offset = rela->offset;
	}

	if (!prev_offset) {
		WARN_FUNC("can't find switch jump table",
			  insn->sec, insn->offset);
		return -1;
1038 1039 1040 1041 1042 1043
	}

	return 0;
}

/*
1044
 * find_jump_table() - Given a dynamic jump, find the switch jump table in
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
 * .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.
 *
1077 1078 1079 1080
 *    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.
 *
1081 1082
 *    TODO: Once we have DWARF CFI and smarter instruction decoding logic,
 *    ensure the same register is used in the mov and jump instructions.
1083 1084
 *
 *    NOTE: RETPOLINE made it harder still to decode dynamic jumps.
1085
 */
1086
static struct rela *find_jump_table(struct objtool_file *file,
1087 1088 1089
				      struct symbol *func,
				      struct instruction *insn)
{
1090
	struct rela *text_rela, *table_rela;
1091
	struct instruction *dest_insn, *orig_insn = insn;
1092
	struct section *table_sec;
1093
	unsigned long table_offset;
1094

1095 1096 1097 1098 1099
	/*
	 * Backward search using the @first_jump_src links, these help avoid
	 * much of the 'in between' code. Which avoids us getting confused by
	 * it.
	 */
1100
	for (;
1101
	     &insn->list != &file->insn_list && insn->func && insn->func->pfunc == func;
1102 1103
	     insn = insn->first_jump_src ?: list_prev_entry(insn, list)) {

1104
		if (insn != orig_insn && insn->type == INSN_JUMP_DYNAMIC)
1105 1106 1107 1108 1109 1110 1111 1112 1113 1114
			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 */
1115 1116
		text_rela = find_rela_by_dest_range(file->elf, insn->sec,
						    insn->offset, insn->len);
1117 1118
		if (!text_rela || text_rela->sym->type != STT_SECTION ||
		    !text_rela->sym->sec->rodata)
1119 1120
			continue;

1121
		table_offset = text_rela->addend;
1122
		table_sec = text_rela->sym->sec;
1123

1124 1125 1126
		if (text_rela->type == R_X86_64_PC32)
			table_offset += 4;

1127 1128
		/*
		 * Make sure the .rodata address isn't associated with a
1129 1130 1131 1132 1133 1134
		 * 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.
1135
		 */
1136 1137
		if (find_symbol_containing(table_sec, table_offset) &&
		    strcmp(table_sec->name, C_JUMP_TABLE_SECTION))
1138 1139
			continue;

1140 1141 1142 1143 1144
		/*
		 * Each table entry has a rela associated with it.  The rela
		 * should reference text in the same function as the original
		 * instruction.
		 */
1145
		table_rela = find_rela_by_dest(file->elf, table_sec, table_offset);
1146 1147
		if (!table_rela)
			continue;
1148 1149 1150
		dest_insn = find_insn(file, table_rela->sym->sec, table_rela->addend);
		if (!dest_insn || !dest_insn->func || dest_insn->func->pfunc != func)
			continue;
1151

1152 1153 1154 1155 1156 1157 1158 1159 1160
		/*
		 * 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;
1161 1162 1163 1164 1165
	}

	return NULL;
}

1166 1167 1168 1169 1170 1171
/*
 * 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)
1172
{
1173 1174
	struct instruction *insn, *last = NULL;
	struct rela *rela;
1175

1176
	func_for_each_insn(file, func, insn) {
1177 1178 1179 1180 1181
		if (!last)
			last = insn;

		/*
		 * Store back-pointers for unconditional forward jumps such
1182
		 * that find_jump_table() can back-track using those and
1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193
		 * 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;
		}

1194 1195 1196
		if (insn->type != INSN_JUMP_DYNAMIC)
			continue;

1197
		rela = find_jump_table(file, func, insn);
1198 1199 1200
		if (rela) {
			rela->jump_table_start = true;
			insn->jump_table = rela;
1201 1202
		}
	}
1203 1204 1205 1206 1207 1208 1209 1210
}

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

1211
	func_for_each_insn(file, func, insn) {
1212 1213
		if (!insn->jump_table)
			continue;
1214

1215
		ret = add_jump_table(file, insn, insn->jump_table);
1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227
		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.
 */
1228
static int add_jump_table_alts(struct objtool_file *file)
1229 1230 1231 1232 1233
{
	struct section *sec;
	struct symbol *func;
	int ret;

1234
	if (!file->rodata)
1235 1236
		return 0;

1237
	for_each_sec(file, sec) {
1238 1239 1240 1241
		list_for_each_entry(func, &sec->symbol_list, list) {
			if (func->type != STT_FUNC)
				continue;

1242
			mark_func_jump_tables(file, func);
1243
			ret = add_func_jump_tables(file, func);
1244 1245 1246 1247 1248 1249 1250 1251
			if (ret)
				return ret;
		}
	}

	return 0;
}

1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280
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;

1281
		rela = find_rela_by_dest(file->elf, sec, i * sizeof(*hint));
1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292
		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;
		}

1293
		cfa = &insn->cfi.cfa;
1294

1295
		if (hint->type == UNWIND_HINT_TYPE_RET_OFFSET) {
1296
			insn->ret_offset = hint->sp_offset;
1297 1298 1299 1300 1301 1302 1303 1304 1305 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
			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;
1334 1335
		insn->cfi.type = hint->type;
		insn->cfi.end = hint->end;
1336 1337 1338 1339 1340
	}

	return 0;
}

1341 1342
static int read_retpoline_hints(struct objtool_file *file)
{
J
Josh Poimboeuf 已提交
1343
	struct section *sec;
1344 1345 1346
	struct instruction *insn;
	struct rela *rela;

J
Josh Poimboeuf 已提交
1347
	sec = find_section_by_name(file->elf, ".rela.discard.retpoline_safe");
1348 1349 1350
	if (!sec)
		return 0;

J
Josh Poimboeuf 已提交
1351 1352 1353
	list_for_each_entry(rela, &sec->rela_list, list) {
		if (rela->sym->type != STT_SECTION) {
			WARN("unexpected relocation symbol type in %s", sec->name);
1354 1355 1356 1357 1358
			return -1;
		}

		insn = find_insn(file, rela->sym->sec, rela->addend);
		if (!insn) {
J
Josh Poimboeuf 已提交
1359
			WARN("bad .discard.retpoline_safe entry");
1360 1361 1362 1363 1364
			return -1;
		}

		if (insn->type != INSN_JUMP_DYNAMIC &&
		    insn->type != INSN_CALL_DYNAMIC) {
J
Josh Poimboeuf 已提交
1365
			WARN_FUNC("retpoline_safe hint not an indirect jump/call",
1366 1367 1368 1369 1370 1371 1372 1373 1374 1375
				  insn->sec, insn->offset);
			return -1;
		}

		insn->retpoline_safe = true;
	}

	return 0;
}

1376 1377 1378 1379 1380 1381 1382 1383 1384 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
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;
}

1423 1424 1425 1426 1427 1428 1429 1430 1431 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
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;
}

1474 1475 1476 1477 1478 1479
static void mark_rodata(struct objtool_file *file)
{
	struct section *sec;
	bool found = false;

	/*
1480 1481 1482 1483 1484 1485 1486 1487
	 * 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.
1488 1489
	 */
	for_each_sec(file, sec) {
1490 1491
		if (!strncmp(sec->name, ".rodata", 7) &&
		    !strstr(sec->name, ".str1.")) {
1492 1493 1494 1495 1496 1497 1498 1499
			sec->rodata = true;
			found = true;
		}
	}

	file->rodata = found;
}

1500 1501 1502 1503
static int decode_sections(struct objtool_file *file)
{
	int ret;

1504 1505
	mark_rodata(file);

1506 1507 1508 1509 1510 1511 1512 1513 1514
	ret = decode_instructions(file);
	if (ret)
		return ret;

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

	add_ignores(file);
P
Peter Zijlstra 已提交
1515
	add_uaccess_safe(file);
1516

1517
	ret = add_ignore_alternatives(file);
1518 1519 1520
	if (ret)
		return ret;

1521 1522 1523 1524
	ret = add_jump_destinations(file);
	if (ret)
		return ret;

1525
	ret = add_special_section_alts(file);
1526 1527 1528
	if (ret)
		return ret;

1529 1530 1531 1532
	ret = read_intra_function_calls(file);
	if (ret)
		return ret;

1533
	ret = add_call_destinations(file);
1534 1535 1536
	if (ret)
		return ret;

1537
	ret = add_jump_table_alts(file);
1538 1539 1540
	if (ret)
		return ret;

1541 1542 1543 1544
	ret = read_unwind_hints(file);
	if (ret)
		return ret;

1545 1546 1547 1548
	ret = read_retpoline_hints(file);
	if (ret)
		return ret;

1549 1550 1551 1552
	ret = read_instr_hints(file);
	if (ret)
		return ret;

1553 1554 1555 1556 1557
	return 0;
}

static bool is_fentry_call(struct instruction *insn)
{
1558
	if (insn->type == INSN_CALL && insn->call_dest &&
1559 1560 1561 1562 1563 1564 1565
	    insn->call_dest->type == STT_NOTYPE &&
	    !strcmp(insn->call_dest->name, "__fentry__"))
		return true;

	return false;
}

1566
static bool has_modified_stack_frame(struct instruction *insn, struct insn_state *state)
1567
{
1568
	u8 ret_offset = insn->ret_offset;
1569
	struct cfi_state *cfi = &state->cfi;
1570 1571
	int i;

1572
	if (cfi->cfa.base != initial_func_cfi.cfa.base || cfi->drap)
1573 1574
		return true;

1575
	if (cfi->cfa.offset != initial_func_cfi.cfa.offset + ret_offset)
1576 1577
		return true;

1578
	if (cfi->stack_size != initial_func_cfi.cfa.offset + ret_offset)
1579 1580
		return true;

1581 1582 1583 1584 1585 1586 1587 1588
	/*
	 * 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;

1589
	for (i = 0; i < CFI_NUM_REGS; i++) {
1590 1591
		if (cfi->regs[i].base != initial_func_cfi.regs[i].base ||
		    cfi->regs[i].offset != initial_func_cfi.regs[i].offset)
1592
			return true;
1593
	}
1594 1595 1596 1597 1598 1599

	return false;
}

static bool has_valid_stack_frame(struct insn_state *state)
{
1600 1601 1602 1603
	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)
1604 1605
		return true;

1606
	if (cfi->drap && cfi->regs[CFI_BP].base == CFI_BP)
1607 1608 1609
		return true;

	return false;
1610 1611
}

1612 1613
static int update_cfi_state_regs(struct instruction *insn,
				  struct cfi_state *cfi,
1614
				  struct stack_op *op)
1615
{
1616
	struct cfi_reg *cfa = &cfi->cfa;
1617 1618 1619 1620 1621

	if (cfa->base != CFI_SP)
		return 0;

	/* push */
P
Peter Zijlstra 已提交
1622
	if (op->dest.type == OP_DEST_PUSH || op->dest.type == OP_DEST_PUSHF)
1623 1624 1625
		cfa->offset += 8;

	/* pop */
P
Peter Zijlstra 已提交
1626
	if (op->src.type == OP_SRC_POP || op->src.type == OP_SRC_POPF)
1627 1628 1629 1630 1631 1632 1633 1634 1635 1636
		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;
}

1637
static void save_reg(struct cfi_state *cfi, unsigned char reg, int base, int offset)
1638
{
1639
	if (arch_callee_saved_reg(reg) &&
1640 1641 1642
	    cfi->regs[reg].base == CFI_UNDEFINED) {
		cfi->regs[reg].base = base;
		cfi->regs[reg].offset = offset;
1643
	}
1644 1645
}

1646
static void restore_reg(struct cfi_state *cfi, unsigned char reg)
1647
{
1648 1649
	cfi->regs[reg].base = initial_func_cfi.regs[reg].base;
	cfi->regs[reg].offset = initial_func_cfi.regs[reg].offset;
1650 1651 1652 1653 1654 1655 1656 1657 1658 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
}

/*
 * 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
 */
1705
static int update_cfi_state(struct instruction *insn, struct cfi_state *cfi,
1706
			     struct stack_op *op)
1707
{
1708 1709
	struct cfi_reg *cfa = &cfi->cfa;
	struct cfi_reg *regs = cfi->regs;
1710 1711 1712 1713 1714 1715 1716 1717 1718 1719

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

1720 1721
	if (cfi->type == ORC_TYPE_REGS || cfi->type == ORC_TYPE_REGS_IRET)
		return update_cfi_state_regs(insn, cfi, op);
1722

1723 1724 1725 1726 1727 1728
	switch (op->dest.type) {

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

		case OP_SRC_REG:
1729 1730 1731 1732 1733 1734 1735
			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;
1736
				cfi->bp_scratch = false;
1737
			}
1738

1739
			else if (op->src.reg == CFI_SP &&
1740
				 op->dest.reg == CFI_BP && cfi->drap) {
1741

1742 1743
				/* drap: mov %rsp, %rbp */
				regs[CFI_BP].base = CFI_BP;
1744 1745
				regs[CFI_BP].offset = -cfi->stack_size;
				cfi->bp_scratch = false;
1746
			}
1747

1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759
			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
				 */
1760 1761
				cfi->vals[op->dest.reg].base = CFI_CFA;
				cfi->vals[op->dest.reg].offset = -cfi->stack_size;
1762 1763
			}

J
Josh Poimboeuf 已提交
1764 1765 1766 1767 1768 1769 1770 1771
			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).
				 */
1772
				cfi->stack_size = -cfi->regs[CFI_BP].offset;
J
Josh Poimboeuf 已提交
1773 1774
			}

1775 1776 1777 1778
			else if (op->dest.reg == cfa->base) {

				/* mov %reg, %rsp */
				if (cfa->base == CFI_SP &&
1779
				    cfi->vals[op->src.reg].base == CFI_CFA) {
1780 1781 1782 1783 1784 1785 1786 1787 1788

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

				} else {
					cfa->base = CFI_UNDEFINED;
					cfa->offset = 0;
				}
1796 1797 1798 1799 1800 1801 1802 1803
			}

			break;

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

				/* add imm, %rsp */
1804
				cfi->stack_size -= op->src.offset;
1805 1806 1807 1808 1809 1810 1811 1812
				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 */
1813
				cfi->stack_size = -(op->src.offset + regs[CFI_BP].offset);
1814 1815 1816
				break;
			}

1817
			if (op->src.reg == CFI_SP && cfa->base == CFI_SP) {
1818 1819

				/* drap: lea disp(%rsp), %drap */
1820
				cfi->drap_reg = op->dest.reg;
1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831

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

1836 1837 1838
				break;
			}

1839 1840
			if (cfi->drap && op->dest.reg == CFI_SP &&
			    op->src.reg == cfi->drap_reg) {
1841 1842 1843

				 /* drap: lea disp(%drap), %rsp */
				cfa->base = CFI_SP;
1844 1845 1846
				cfa->offset = cfi->stack_size = -op->src.offset;
				cfi->drap_reg = CFI_UNDEFINED;
				cfi->drap = false;
1847 1848 1849
				break;
			}

1850
			if (op->dest.reg == cfi->cfa.base) {
1851 1852 1853 1854 1855 1856 1857 1858 1859
				WARN_FUNC("unsupported stack register modification",
					  insn->sec, insn->offset);
				return -1;
			}

			break;

		case OP_SRC_AND:
			if (op->dest.reg != CFI_SP ||
1860 1861
			    (cfi->drap_reg != CFI_UNDEFINED && cfa->base != CFI_SP) ||
			    (cfi->drap_reg == CFI_UNDEFINED && cfa->base != CFI_BP)) {
1862 1863 1864 1865 1866
				WARN_FUNC("unsupported stack pointer realignment",
					  insn->sec, insn->offset);
				return -1;
			}

1867
			if (cfi->drap_reg != CFI_UNDEFINED) {
1868
				/* drap: and imm, %rsp */
1869 1870 1871
				cfa->base = cfi->drap_reg;
				cfa->offset = cfi->stack_size = 0;
				cfi->drap = true;
1872 1873 1874 1875 1876 1877 1878 1879 1880 1881
			}

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

			break;

		case OP_SRC_POP:
P
Peter Zijlstra 已提交
1882
		case OP_SRC_POPF:
1883
			if (!cfi->drap && op->dest.reg == cfa->base) {
1884 1885 1886 1887 1888

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

1889 1890 1891
			if (cfi->drap && cfa->base == CFI_BP_INDIRECT &&
			    op->dest.reg == cfi->drap_reg &&
			    cfi->drap_offset == -cfi->stack_size) {
1892

1893
				/* drap: pop %drap */
1894
				cfa->base = cfi->drap_reg;
1895
				cfa->offset = 0;
1896
				cfi->drap_offset = -1;
1897

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

1900
				/* pop %reg */
1901
				restore_reg(cfi, op->dest.reg);
1902 1903
			}

1904
			cfi->stack_size -= 8;
1905 1906 1907 1908 1909 1910
			if (cfa->base == CFI_SP)
				cfa->offset -= 8;

			break;

		case OP_SRC_REG_INDIRECT:
1911 1912
			if (cfi->drap && op->src.reg == CFI_BP &&
			    op->src.offset == cfi->drap_offset) {
1913 1914

				/* drap: mov disp(%rbp), %drap */
1915
				cfa->base = cfi->drap_reg;
1916
				cfa->offset = 0;
1917
				cfi->drap_offset = -1;
1918 1919
			}

1920
			if (cfi->drap && op->src.reg == CFI_BP &&
1921 1922 1923
			    op->src.offset == regs[op->dest.reg].offset) {

				/* drap: mov disp(%rbp), %reg */
1924
				restore_reg(cfi, op->dest.reg);
1925 1926 1927 1928 1929 1930

			} 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 */
1931
				restore_reg(cfi, op->dest.reg);
1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944
			}

			break;

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

		break;

	case OP_DEST_PUSH:
P
Peter Zijlstra 已提交
1945
	case OP_DEST_PUSHF:
1946
		cfi->stack_size += 8;
1947 1948 1949 1950 1951 1952
		if (cfa->base == CFI_SP)
			cfa->offset += 8;

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

1953 1954
		if (cfi->drap) {
			if (op->src.reg == cfa->base && op->src.reg == cfi->drap_reg) {
1955 1956 1957

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

1960
				/* save drap so we know when to restore it */
1961
				cfi->drap_offset = -cfi->stack_size;
1962

1963
			} else if (op->src.reg == CFI_BP && cfa->base == cfi->drap_reg) {
1964 1965

				/* drap: push %rbp */
1966
				cfi->stack_size = 0;
1967 1968 1969 1970

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

				/* drap: push %reg */
1971
				save_reg(cfi, op->src.reg, CFI_BP, -cfi->stack_size);
1972 1973 1974 1975 1976
			}

		} else {

			/* push %reg */
1977
			save_reg(cfi, op->src.reg, CFI_CFA, -cfi->stack_size);
1978 1979 1980
		}

		/* detect when asm code uses rbp as a scratch register */
1981
		if (!no_fp && insn->func && op->src.reg == CFI_BP &&
1982
		    cfa->base != CFI_BP)
1983
			cfi->bp_scratch = true;
1984 1985 1986 1987
		break;

	case OP_DEST_REG_INDIRECT:

1988 1989
		if (cfi->drap) {
			if (op->src.reg == cfa->base && op->src.reg == cfi->drap_reg) {
1990 1991 1992 1993 1994

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

1995
				/* save drap offset so we know when to restore it */
1996
				cfi->drap_offset = op->dest.offset;
1997 1998 1999 2000 2001
			}

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

				/* drap: mov reg, disp(%rbp) */
2002
				save_reg(cfi, op->src.reg, CFI_BP, op->dest.offset);
2003 2004 2005 2006 2007 2008
			}

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

			/* mov reg, disp(%rbp) */
			/* mov reg, disp(%rsp) */
2009 2010
			save_reg(cfi, op->src.reg, CFI_CFA,
				 op->dest.offset - cfi->cfa.offset);
2011 2012 2013 2014 2015
		}

		break;

	case OP_DEST_LEAVE:
2016 2017
		if ((!cfi->drap && cfa->base != CFI_BP) ||
		    (cfi->drap && cfa->base != cfi->drap_reg)) {
2018 2019 2020 2021 2022 2023 2024
			WARN_FUNC("leave instruction with modified stack frame",
				  insn->sec, insn->offset);
			return -1;
		}

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

2025 2026
		cfi->stack_size = -cfi->regs[CFI_BP].offset - 8;
		restore_reg(cfi, CFI_BP);
2027

2028
		if (!cfi->drap) {
2029 2030 2031 2032 2033 2034 2035
			cfa->base = CFI_SP;
			cfa->offset -= 8;
		}

		break;

	case OP_DEST_MEM:
P
Peter Zijlstra 已提交
2036
		if (op->src.type != OP_SRC_POP && op->src.type != OP_SRC_POPF) {
2037 2038 2039 2040 2041 2042
			WARN_FUNC("unknown stack-related memory operation",
				  insn->sec, insn->offset);
			return -1;
		}

		/* pop mem */
2043
		cfi->stack_size -= 8;
2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057
		if (cfa->base == CFI_SP)
			cfa->offset -= 8;

		break;

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

	return 0;
}

2058 2059 2060 2061 2062 2063 2064
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) {
		int res;

2065 2066 2067 2068 2069
		if (insn->alt_group) {
			WARN_FUNC("alternative modifies stack", insn->sec, insn->offset);
			return -1;
		}

2070
		res = update_cfi_state(insn, &state->cfi, op);
2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098
		if (res)
			return res;

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

2099
static bool insn_cfi_match(struct instruction *insn, struct cfi_state *cfi2)
2100
{
2101
	struct cfi_state *cfi1 = &insn->cfi;
2102 2103
	int i;

2104 2105
	if (memcmp(&cfi1->cfa, &cfi2->cfa, sizeof(cfi1->cfa))) {

2106 2107
		WARN_FUNC("stack state mismatch: cfa1=%d%+d cfa2=%d%+d",
			  insn->sec, insn->offset,
2108 2109
			  cfi1->cfa.base, cfi1->cfa.offset,
			  cfi2->cfa.base, cfi2->cfa.offset);
2110

2111
	} else if (memcmp(&cfi1->regs, &cfi2->regs, sizeof(cfi1->regs))) {
2112
		for (i = 0; i < CFI_NUM_REGS; i++) {
2113
			if (!memcmp(&cfi1->regs[i], &cfi2->regs[i],
2114 2115 2116 2117 2118
				    sizeof(struct cfi_reg)))
				continue;

			WARN_FUNC("stack state mismatch: reg1[%d]=%d%+d reg2[%d]=%d%+d",
				  insn->sec, insn->offset,
2119 2120
				  i, cfi1->regs[i].base, cfi1->regs[i].offset,
				  i, cfi2->regs[i].base, cfi2->regs[i].offset);
2121 2122 2123
			break;
		}

2124 2125
	} else if (cfi1->type != cfi2->type) {

2126
		WARN_FUNC("stack state mismatch: type1=%d type2=%d",
2127 2128 2129 2130 2131
			  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)) {
2132

2133
		WARN_FUNC("stack state mismatch: drap1=%d(%d,%d) drap2=%d(%d,%d)",
2134
			  insn->sec, insn->offset,
2135 2136
			  cfi1->drap, cfi1->drap_reg, cfi1->drap_offset,
			  cfi2->drap, cfi2->drap_reg, cfi2->drap_offset);
2137 2138 2139 2140 2141

	} else
		return true;

	return false;
2142 2143
}

P
Peter Zijlstra 已提交
2144 2145 2146
static inline bool func_uaccess_safe(struct symbol *func)
{
	if (func)
2147
		return func->uaccess_safe;
P
Peter Zijlstra 已提交
2148 2149 2150 2151

	return false;
}

2152
static inline const char *call_dest_name(struct instruction *insn)
P
Peter Zijlstra 已提交
2153 2154 2155 2156 2157 2158 2159 2160 2161
{
	if (insn->call_dest)
		return insn->call_dest->name;

	return "{dynamic}";
}

static int validate_call(struct instruction *insn, struct insn_state *state)
{
2162
	if (state->noinstr && state->instr <= 0 &&
2163
	    (!insn->call_dest || !insn->call_dest->sec->noinstr)) {
2164 2165 2166 2167 2168
		WARN_FUNC("call to %s() leaves .noinstr.text section",
				insn->sec, insn->offset, call_dest_name(insn));
		return 1;
	}

P
Peter Zijlstra 已提交
2169 2170
	if (state->uaccess && !func_uaccess_safe(insn->call_dest)) {
		WARN_FUNC("call to %s() with UACCESS enabled",
2171
				insn->sec, insn->offset, call_dest_name(insn));
P
Peter Zijlstra 已提交
2172 2173 2174
		return 1;
	}

2175 2176
	if (state->df) {
		WARN_FUNC("call to %s() with DF set",
2177
				insn->sec, insn->offset, call_dest_name(insn));
2178 2179 2180
		return 1;
	}

P
Peter Zijlstra 已提交
2181 2182 2183
	return 0;
}

2184 2185
static int validate_sibling_call(struct instruction *insn, struct insn_state *state)
{
2186
	if (has_modified_stack_frame(insn, state)) {
2187 2188 2189 2190 2191
		WARN_FUNC("sibling call from callable instruction with modified stack frame",
				insn->sec, insn->offset);
		return 1;
	}

P
Peter Zijlstra 已提交
2192
	return validate_call(insn, state);
2193 2194
}

2195 2196
static int validate_return(struct symbol *func, struct instruction *insn, struct insn_state *state)
{
2197 2198 2199 2200 2201 2202
	if (state->noinstr && state->instr > 0) {
		WARN_FUNC("return with instrumentation enabled",
			  insn->sec, insn->offset);
		return 1;
	}

2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220
	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;
	}

2221
	if (func && has_modified_stack_frame(insn, state)) {
2222 2223 2224 2225 2226
		WARN_FUNC("return with modified stack frame",
			  insn->sec, insn->offset);
		return 1;
	}

2227
	if (state->cfi.bp_scratch) {
2228 2229
		WARN_FUNC("BP used as a scratch register",
			  insn->sec, insn->offset);
2230 2231 2232 2233 2234 2235
		return 1;
	}

	return 0;
}

2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259
/*
 * 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;
	}
}

2260 2261 2262 2263 2264 2265
/*
 * 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.
 */
2266
static int validate_branch(struct objtool_file *file, struct symbol *func,
P
Peter Zijlstra 已提交
2267
			   struct instruction *insn, struct insn_state state)
2268 2269
{
	struct alternative *alt;
P
Peter Zijlstra 已提交
2270
	struct instruction *next_insn;
2271
	struct section *sec;
2272
	u8 visited;
2273 2274 2275 2276 2277
	int ret;

	sec = insn->sec;

	while (1) {
2278 2279
		next_insn = next_insn_same_sec(file, insn);

2280
		if (file->c_file && func && insn->func && func != insn->func->pfunc) {
2281 2282 2283
			WARN("%s() falls through to next function %s()",
			     func->name, insn->func->name);
			return 1;
2284 2285
		}

2286 2287 2288
		if (func && insn->ignore) {
			WARN_FUNC("BUG: why am I validating an ignored function?",
				  sec, insn->offset);
2289
			return 1;
2290 2291
		}

2292
		visited = 1 << state.uaccess;
2293
		if (insn->visited) {
2294
			if (!insn->hint && !insn_cfi_match(insn, &state.cfi))
2295 2296
				return 1;

2297
			if (insn->visited & visited)
P
Peter Zijlstra 已提交
2298
				return 0;
2299 2300
		}

2301 2302 2303
		if (state.noinstr)
			state.instr += insn->instr;

2304
		if (insn->hint)
2305
			state.cfi = insn->cfi;
2306
		else
2307
			insn->cfi = state.cfi;
2308

2309
		insn->visited |= visited;
2310

2311
		if (!insn->ignore_alts && !list_empty(&insn->alts)) {
P
Peter Zijlstra 已提交
2312 2313
			bool skip_orig = false;

2314
			list_for_each_entry(alt, &insn->alts, list) {
P
Peter Zijlstra 已提交
2315 2316 2317
				if (alt->skip_orig)
					skip_orig = true;

2318
				ret = validate_branch(file, func, alt->insn, state);
2319 2320 2321 2322 2323
				if (ret) {
					if (backtrace)
						BT_FUNC("(alt)", insn);
					return ret;
				}
2324
			}
P
Peter Zijlstra 已提交
2325

2326 2327 2328
			if (insn->alt_group)
				fill_alternative_cfi(file, insn);

P
Peter Zijlstra 已提交
2329 2330
			if (skip_orig)
				return 0;
2331 2332
		}

2333 2334 2335
		if (handle_insn_ops(insn, &state))
			return 1;

2336 2337 2338
		switch (insn->type) {

		case INSN_RETURN:
2339
			return validate_return(func, insn, &state);
2340 2341

		case INSN_CALL:
P
Peter Zijlstra 已提交
2342 2343 2344 2345
		case INSN_CALL_DYNAMIC:
			ret = validate_call(insn, &state);
			if (ret)
				return ret;
2346

2347 2348
			if (!no_fp && func && !is_fentry_call(insn) &&
			    !has_valid_stack_frame(&state)) {
2349 2350 2351 2352
				WARN_FUNC("call without frame pointer save/setup",
					  sec, insn->offset);
				return 1;
			}
2353 2354 2355 2356

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

2357 2358 2359 2360
			break;

		case INSN_JUMP_CONDITIONAL:
		case INSN_JUMP_UNCONDITIONAL:
2361
			if (func && is_sibling_call(insn)) {
2362
				ret = validate_sibling_call(insn, &state);
2363
				if (ret)
2364
					return ret;
2365

2366
			} else if (insn->jump_dest) {
2367 2368
				ret = validate_branch(file, func,
						      insn->jump_dest, state);
2369 2370 2371 2372 2373
				if (ret) {
					if (backtrace)
						BT_FUNC("(branch)", insn);
					return ret;
				}
2374
			}
2375 2376 2377 2378 2379 2380 2381

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

			break;

		case INSN_JUMP_DYNAMIC:
2382
		case INSN_JUMP_DYNAMIC_CONDITIONAL:
2383
			if (func && is_sibling_call(insn)) {
2384 2385 2386
				ret = validate_sibling_call(insn, &state);
				if (ret)
					return ret;
2387 2388
			}

2389 2390 2391 2392
			if (insn->type == INSN_JUMP_DYNAMIC)
				return 0;

			break;
2393

2394 2395 2396 2397 2398 2399 2400 2401
		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 已提交
2402 2403 2404 2405 2406 2407 2408 2409 2410 2411
		case INSN_STAC:
			if (state.uaccess) {
				WARN_FUNC("recursive UACCESS enable", sec, insn->offset);
				return 1;
			}

			state.uaccess = true;
			break;

		case INSN_CLAC:
2412
			if (!state.uaccess && func) {
P
Peter Zijlstra 已提交
2413 2414 2415 2416 2417 2418 2419 2420 2421 2422
				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;
2423 2424
			break;

2425 2426 2427 2428 2429 2430 2431 2432
		case INSN_STD:
			if (state.df)
				WARN_FUNC("recursive STD", sec, insn->offset);

			state.df = true;
			break;

		case INSN_CLD:
2433
			if (!state.df && func)
2434 2435 2436
				WARN_FUNC("redundant CLD", sec, insn->offset);

			state.df = false;
2437 2438
			break;

2439 2440 2441 2442 2443 2444 2445
		default:
			break;
		}

		if (insn->dead_end)
			return 0;

2446
		if (!next_insn) {
2447
			if (state.cfi.cfa.base == CFI_UNDEFINED)
2448
				return 0;
2449 2450 2451
			WARN("%s: unexpected end of section", sec->name);
			return 1;
		}
2452 2453

		insn = next_insn;
2454 2455 2456 2457 2458
	}

	return 0;
}

2459
static int validate_unwind_hints(struct objtool_file *file, struct section *sec)
2460 2461 2462
{
	struct instruction *insn;
	struct insn_state state;
2463
	int ret, warnings = 0;
2464 2465 2466 2467

	if (!file->hints)
		return 0;

2468
	init_insn_state(&state, sec);
2469

2470 2471 2472 2473 2474 2475 2476 2477 2478
	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)) {
2479
		if (insn->hint && !insn->visited) {
2480
			ret = validate_branch(file, insn->func, insn, state);
2481 2482
			if (ret && backtrace)
				BT_FUNC("<=== (hint)", insn);
2483 2484
			warnings += ret;
		}
2485 2486

		insn = list_next_entry(insn, list);
2487 2488 2489 2490 2491
	}

	return warnings;
}

2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504
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;

2505 2506 2507 2508 2509 2510 2511 2512 2513
		/*
		 * .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;

2514 2515 2516 2517 2518 2519 2520 2521 2522 2523
		WARN_FUNC("indirect %s found in RETPOLINE build",
			  insn->sec, insn->offset,
			  insn->type == INSN_JUMP_DYNAMIC ? "jump" : "call");

		warnings++;
	}

	return warnings;
}

2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536
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"));
}

2537
static bool ignore_unreachable_insn(struct instruction *insn)
2538 2539 2540
{
	int i;

2541 2542 2543 2544 2545 2546
	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.
2547 2548 2549
	 *
	 * Also ignore alternative replacement instructions.  This can happen
	 * when a whitelisted function uses one of the ALTERNATIVE macros.
2550
	 */
2551 2552 2553
	if (!strcmp(insn->sec->name, ".fixup") ||
	    !strcmp(insn->sec->name, ".altinstr_replacement") ||
	    !strcmp(insn->sec->name, ".altinstr_aux"))
2554 2555
		return true;

2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570
	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;

2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581
	/*
	 * 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;

2582 2583 2584 2585 2586 2587 2588 2589
		if (insn->type == INSN_JUMP_UNCONDITIONAL) {
			if (insn->jump_dest &&
			    insn->jump_dest->func == insn->func) {
				insn = insn->jump_dest;
				continue;
			}

			break;
2590 2591
		}

2592
		if (insn->offset + insn->len >= insn->func->offset + insn->func->len)
2593
			break;
2594

2595 2596 2597 2598 2599 2600
		insn = list_next_entry(insn, list);
	}

	return false;
}

2601 2602
static int validate_symbol(struct objtool_file *file, struct section *sec,
			   struct symbol *sym, struct insn_state *state)
2603 2604
{
	struct instruction *insn;
2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628
	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)
{
2629
	struct insn_state state;
2630 2631
	struct symbol *func;
	int warnings = 0;
2632

2633 2634 2635
	list_for_each_entry(func, &sec->symbol_list, list) {
		if (func->type != STT_FUNC)
			continue;
2636

2637
		init_insn_state(&state, sec);
2638 2639
		state.cfi.cfa = initial_func_cfi.cfa;
		memcpy(&state.cfi.regs, &initial_func_cfi.regs,
2640
		       CFI_NUM_REGS * sizeof(struct cfi_reg));
2641
		state.cfi.stack_size = initial_func_cfi.cfa.offset;
2642

2643
		warnings += validate_symbol(file, sec, func, &state);
2644 2645 2646 2647 2648
	}

	return warnings;
}

2649 2650 2651
static int validate_vmlinux_functions(struct objtool_file *file)
{
	struct section *sec;
2652
	int warnings = 0;
2653 2654

	sec = find_section_by_name(file->elf, ".noinstr.text");
2655 2656 2657 2658
	if (sec) {
		warnings += validate_section(file, sec);
		warnings += validate_unwind_hints(file, sec);
	}
2659

2660 2661 2662 2663 2664
	sec = find_section_by_name(file->elf, ".entry.text");
	if (sec) {
		warnings += validate_section(file, sec);
		warnings += validate_unwind_hints(file, sec);
	}
2665 2666

	return warnings;
2667 2668
}

2669 2670 2671 2672 2673
static int validate_functions(struct objtool_file *file)
{
	struct section *sec;
	int warnings = 0;

2674 2675 2676 2677
	for_each_sec(file, sec) {
		if (!(sec->sh.sh_flags & SHF_EXECINSTR))
			continue;

2678
		warnings += validate_section(file, sec);
2679
	}
2680 2681 2682 2683

	return warnings;
}

2684
static int validate_reachable_instructions(struct objtool_file *file)
2685 2686
{
	struct instruction *insn;
2687 2688 2689

	if (file->ignore_unreachables)
		return 0;
2690 2691

	for_each_insn(file, insn) {
2692 2693 2694 2695 2696
		if (insn->visited || ignore_unreachable_insn(insn))
			continue;

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

2699
	return 0;
2700 2701
}

2702 2703
static struct objtool_file file;

2704
int check(const char *_objname, bool orc)
2705 2706 2707 2708 2709
{
	int ret, warnings = 0;

	objname = _objname;

2710
	file.elf = elf_open_read(objname, orc ? O_RDWR : O_RDONLY);
2711
	if (!file.elf)
2712 2713 2714 2715 2716
		return 1;

	INIT_LIST_HEAD(&file.insn_list);
	hash_init(file.insn_hash);
	file.c_file = find_section_by_name(file.elf, ".comment");
2717
	file.ignore_unreachables = no_unreachable;
2718
	file.hints = false;
2719

2720 2721
	arch_initial_func_cfi_state(&initial_func_cfi);

2722 2723 2724 2725 2726
	ret = decode_sections(&file);
	if (ret < 0)
		goto out;
	warnings += ret;

2727
	if (list_empty(&file.insn_list))
2728 2729
		goto out;

2730 2731 2732 2733 2734 2735 2736 2737 2738
	if (vmlinux && !validate_dup) {
		ret = validate_vmlinux_functions(&file);
		if (ret < 0)
			goto out;

		warnings += ret;
		goto out;
	}

2739 2740 2741 2742 2743 2744 2745
	if (retpoline) {
		ret = validate_retpoline(&file);
		if (ret < 0)
			return ret;
		warnings += ret;
	}

2746
	ret = validate_functions(&file);
2747 2748 2749 2750
	if (ret < 0)
		goto out;
	warnings += ret;

2751
	ret = validate_unwind_hints(&file, NULL);
2752 2753 2754 2755
	if (ret < 0)
		goto out;
	warnings += ret;

2756 2757 2758 2759 2760 2761 2762
	if (!warnings) {
		ret = validate_reachable_instructions(&file);
		if (ret < 0)
			goto out;
		warnings += ret;
	}

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

2777
out:
2778 2779 2780 2781 2782 2783 2784 2785 2786
	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;
	}

2787 2788
	return 0;
}