Linux Audio

Check our new training course

Loading...
v6.2
   1// SPDX-License-Identifier: GPL-2.0-or-later
   2/*
   3 * Copyright (C) 2015-2017 Josh Poimboeuf <jpoimboe@redhat.com>
   4 */
   5
   6#include <string.h>
   7#include <stdlib.h>
   8#include <inttypes.h>
   9#include <sys/mman.h>
  10
  11#include <arch/elf.h>
  12#include <objtool/builtin.h>
  13#include <objtool/cfi.h>
  14#include <objtool/arch.h>
  15#include <objtool/check.h>
  16#include <objtool/special.h>
  17#include <objtool/warn.h>
  18#include <objtool/endianness.h>
  19
  20#include <linux/objtool.h>
  21#include <linux/hashtable.h>
  22#include <linux/kernel.h>
  23#include <linux/static_call_types.h>
 
  24
  25struct alternative {
  26	struct list_head list;
  27	struct instruction *insn;
  28	bool skip_orig;
  29};
  30
  31static unsigned long nr_cfi, nr_cfi_reused, nr_cfi_cache;
  32
  33static struct cfi_init_state initial_func_cfi;
  34static struct cfi_state init_cfi;
  35static struct cfi_state func_cfi;
 
  36
  37struct instruction *find_insn(struct objtool_file *file,
  38			      struct section *sec, unsigned long offset)
  39{
  40	struct instruction *insn;
  41
  42	hash_for_each_possible(file->insn_hash, insn, hash, sec_offset_hash(sec, offset)) {
  43		if (insn->sec == sec && insn->offset == offset)
  44			return insn;
  45	}
  46
  47	return NULL;
  48}
  49
  50static struct instruction *next_insn_same_sec(struct objtool_file *file,
  51					      struct instruction *insn)
  52{
  53	struct instruction *next = list_next_entry(insn, list);
 
  54
  55	if (!next || &next->list == &file->insn_list || next->sec != insn->sec)
 
  56		return NULL;
  57
  58	return next;
  59}
  60
  61static struct instruction *next_insn_same_func(struct objtool_file *file,
  62					       struct instruction *insn)
  63{
  64	struct instruction *next = list_next_entry(insn, list);
  65	struct symbol *func = insn_func(insn);
  66
  67	if (!func)
  68		return NULL;
  69
  70	if (&next->list != &file->insn_list && insn_func(next) == func)
  71		return next;
  72
  73	/* Check if we're already in the subfunction: */
  74	if (func == func->cfunc)
  75		return NULL;
  76
  77	/* Move to the subfunction: */
  78	return find_insn(file, func->cfunc->sec, func->cfunc->offset);
  79}
  80
 
 
 
 
 
 
 
 
 
 
 
 
  81static struct instruction *prev_insn_same_sym(struct objtool_file *file,
  82					       struct instruction *insn)
  83{
  84	struct instruction *prev = list_prev_entry(insn, list);
  85
  86	if (&prev->list != &file->insn_list && insn_func(prev) == insn_func(insn))
  87		return prev;
  88
  89	return NULL;
  90}
  91
 
 
 
 
 
 
  92#define func_for_each_insn(file, func, insn)				\
  93	for (insn = find_insn(file, func->sec, func->offset);		\
  94	     insn;							\
  95	     insn = next_insn_same_func(file, insn))
  96
  97#define sym_for_each_insn(file, sym, insn)				\
  98	for (insn = find_insn(file, sym->sec, sym->offset);		\
  99	     insn && &insn->list != &file->insn_list &&			\
 100		insn->sec == sym->sec &&				\
 101		insn->offset < sym->offset + sym->len;			\
 102	     insn = list_next_entry(insn, list))
 103
 104#define sym_for_each_insn_continue_reverse(file, sym, insn)		\
 105	for (insn = list_prev_entry(insn, list);			\
 106	     &insn->list != &file->insn_list &&				\
 107		insn->sec == sym->sec && insn->offset >= sym->offset;	\
 108	     insn = list_prev_entry(insn, list))
 109
 110#define sec_for_each_insn_from(file, insn)				\
 111	for (; insn; insn = next_insn_same_sec(file, insn))
 112
 113#define sec_for_each_insn_continue(file, insn)				\
 114	for (insn = next_insn_same_sec(file, insn); insn;		\
 115	     insn = next_insn_same_sec(file, insn))
 116
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 117static bool is_jump_table_jump(struct instruction *insn)
 118{
 119	struct alt_group *alt_group = insn->alt_group;
 120
 121	if (insn->jump_table)
 122		return true;
 123
 124	/* Retpoline alternative for a jump table? */
 125	return alt_group && alt_group->orig_group &&
 126	       alt_group->orig_group->first_insn->jump_table;
 127}
 128
 129static bool is_sibling_call(struct instruction *insn)
 130{
 131	/*
 132	 * Assume only STT_FUNC calls have jump-tables.
 133	 */
 134	if (insn_func(insn)) {
 135		/* An indirect jump is either a sibling call or a jump to a table. */
 136		if (insn->type == INSN_JUMP_DYNAMIC)
 137			return !is_jump_table_jump(insn);
 138	}
 139
 140	/* add_jump_destinations() sets insn->call_dest for sibling calls. */
 141	return (is_static_jump(insn) && insn->call_dest);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 142}
 143
 144/*
 145 * This checks to see if the given function is a "noreturn" function.
 146 *
 147 * For global functions which are outside the scope of this object file, we
 148 * have to keep a manual list of them.
 149 *
 150 * For local functions, we have to detect them manually by simply looking for
 151 * the lack of a return instruction.
 152 */
 153static bool __dead_end_function(struct objtool_file *file, struct symbol *func,
 154				int recursion)
 155{
 156	int i;
 157	struct instruction *insn;
 158	bool empty = true;
 159
 160	/*
 161	 * Unfortunately these have to be hard coded because the noreturn
 162	 * attribute isn't provided in ELF data. Keep 'em sorted.
 163	 */
 164	static const char * const global_noreturns[] = {
 165		"__invalid_creds",
 166		"__module_put_and_kthread_exit",
 167		"__reiserfs_panic",
 168		"__stack_chk_fail",
 169		"__ubsan_handle_builtin_unreachable",
 170		"cpu_bringup_and_idle",
 171		"cpu_startup_entry",
 172		"do_exit",
 173		"do_group_exit",
 174		"do_task_dead",
 175		"ex_handler_msr_mce",
 176		"fortify_panic",
 177		"kthread_complete_and_exit",
 178		"kthread_exit",
 179		"kunit_try_catch_throw",
 180		"lbug_with_loc",
 181		"machine_real_restart",
 182		"make_task_dead",
 183		"panic",
 184		"rewind_stack_and_make_dead",
 185		"sev_es_terminate",
 186		"snp_abort",
 187		"stop_this_cpu",
 188		"usercopy_abort",
 189		"xen_start_kernel",
 190	};
 
 191
 192	if (!func)
 193		return false;
 194
 195	if (func->bind == STB_WEAK)
 196		return false;
 
 197
 198	if (func->bind == STB_GLOBAL)
 199		for (i = 0; i < ARRAY_SIZE(global_noreturns); i++)
 200			if (!strcmp(func->name, global_noreturns[i]))
 201				return true;
 
 
 
 
 202
 203	if (!func->len)
 204		return false;
 205
 206	insn = find_insn(file, func->sec, func->offset);
 207	if (!insn || !insn_func(insn))
 208		return false;
 209
 210	func_for_each_insn(file, func, insn) {
 211		empty = false;
 212
 213		if (insn->type == INSN_RETURN)
 214			return false;
 215	}
 216
 217	if (empty)
 218		return false;
 219
 220	/*
 221	 * A function can have a sibling call instead of a return.  In that
 222	 * case, the function's dead-end status depends on whether the target
 223	 * of the sibling call returns.
 224	 */
 225	func_for_each_insn(file, func, insn) {
 226		if (is_sibling_call(insn)) {
 227			struct instruction *dest = insn->jump_dest;
 228
 229			if (!dest)
 230				/* sibling call to another file */
 231				return false;
 232
 233			/* local sibling call */
 234			if (recursion == 5) {
 235				/*
 236				 * Infinite recursion: two functions have
 237				 * sibling calls to each other.  This is a very
 238				 * rare case.  It means they aren't dead ends.
 239				 */
 240				return false;
 241			}
 242
 243			return __dead_end_function(file, insn_func(dest), recursion+1);
 244		}
 245	}
 246
 247	return true;
 248}
 249
 250static bool dead_end_function(struct objtool_file *file, struct symbol *func)
 251{
 252	return __dead_end_function(file, func, 0);
 253}
 254
 255static void init_cfi_state(struct cfi_state *cfi)
 256{
 257	int i;
 258
 259	for (i = 0; i < CFI_NUM_REGS; i++) {
 260		cfi->regs[i].base = CFI_UNDEFINED;
 261		cfi->vals[i].base = CFI_UNDEFINED;
 262	}
 263	cfi->cfa.base = CFI_UNDEFINED;
 264	cfi->drap_reg = CFI_UNDEFINED;
 265	cfi->drap_offset = -1;
 266}
 267
 268static void init_insn_state(struct objtool_file *file, struct insn_state *state,
 269			    struct section *sec)
 270{
 271	memset(state, 0, sizeof(*state));
 272	init_cfi_state(&state->cfi);
 273
 274	/*
 275	 * We need the full vmlinux for noinstr validation, otherwise we can
 276	 * not correctly determine insn->call_dest->sec (external symbols do
 277	 * not have a section).
 278	 */
 279	if (opts.link && opts.noinstr && sec)
 280		state->noinstr = sec->noinstr;
 281}
 282
 283static struct cfi_state *cfi_alloc(void)
 284{
 285	struct cfi_state *cfi = calloc(sizeof(struct cfi_state), 1);
 286	if (!cfi) {
 287		WARN("calloc failed");
 288		exit(1);
 289	}
 290	nr_cfi++;
 291	return cfi;
 292}
 293
 294static int cfi_bits;
 295static struct hlist_head *cfi_hash;
 296
 297static inline bool cficmp(struct cfi_state *cfi1, struct cfi_state *cfi2)
 298{
 299	return memcmp((void *)cfi1 + sizeof(cfi1->hash),
 300		      (void *)cfi2 + sizeof(cfi2->hash),
 301		      sizeof(struct cfi_state) - sizeof(struct hlist_node));
 302}
 303
 304static inline u32 cfi_key(struct cfi_state *cfi)
 305{
 306	return jhash((void *)cfi + sizeof(cfi->hash),
 307		     sizeof(*cfi) - sizeof(cfi->hash), 0);
 308}
 309
 310static struct cfi_state *cfi_hash_find_or_add(struct cfi_state *cfi)
 311{
 312	struct hlist_head *head = &cfi_hash[hash_min(cfi_key(cfi), cfi_bits)];
 313	struct cfi_state *obj;
 314
 315	hlist_for_each_entry(obj, head, hash) {
 316		if (!cficmp(cfi, obj)) {
 317			nr_cfi_cache++;
 318			return obj;
 319		}
 320	}
 321
 322	obj = cfi_alloc();
 323	*obj = *cfi;
 324	hlist_add_head(&obj->hash, head);
 325
 326	return obj;
 327}
 328
 329static void cfi_hash_add(struct cfi_state *cfi)
 330{
 331	struct hlist_head *head = &cfi_hash[hash_min(cfi_key(cfi), cfi_bits)];
 332
 333	hlist_add_head(&cfi->hash, head);
 334}
 335
 336static void *cfi_hash_alloc(unsigned long size)
 337{
 338	cfi_bits = max(10, ilog2(size));
 339	cfi_hash = mmap(NULL, sizeof(struct hlist_head) << cfi_bits,
 340			PROT_READ|PROT_WRITE,
 341			MAP_PRIVATE|MAP_ANON, -1, 0);
 342	if (cfi_hash == (void *)-1L) {
 343		WARN("mmap fail cfi_hash");
 344		cfi_hash = NULL;
 345	}  else if (opts.stats) {
 346		printf("cfi_bits: %d\n", cfi_bits);
 347	}
 348
 349	return cfi_hash;
 350}
 351
 352static unsigned long nr_insns;
 353static unsigned long nr_insns_visited;
 354
 355/*
 356 * Call the arch-specific instruction decoder for all the instructions and add
 357 * them to the global instruction list.
 358 */
 359static int decode_instructions(struct objtool_file *file)
 360{
 361	struct section *sec;
 362	struct symbol *func;
 363	unsigned long offset;
 364	struct instruction *insn;
 365	int ret;
 366
 367	for_each_sec(file, sec) {
 
 
 
 368
 369		if (!(sec->sh.sh_flags & SHF_EXECINSTR))
 370			continue;
 371
 372		if (strcmp(sec->name, ".altinstr_replacement") &&
 373		    strcmp(sec->name, ".altinstr_aux") &&
 374		    strncmp(sec->name, ".discard.", 9))
 375			sec->text = true;
 376
 377		if (!strcmp(sec->name, ".noinstr.text") ||
 378		    !strcmp(sec->name, ".entry.text") ||
 379		    !strncmp(sec->name, ".text.__x86.", 12))
 
 380			sec->noinstr = true;
 381
 382		/*
 383		 * .init.text code is ran before userspace and thus doesn't
 384		 * strictly need retpolines, except for modules which are
 385		 * loaded late, they very much do need retpoline in their
 386		 * .init.text
 387		 */
 388		if (!strcmp(sec->name, ".init.text") && !opts.module)
 389			sec->init = true;
 390
 391		for (offset = 0; offset < sec->sh.sh_size; offset += insn->len) {
 392			insn = malloc(sizeof(*insn));
 393			if (!insn) {
 394				WARN("malloc failed");
 395				return -1;
 
 
 
 
 
 396			}
 397			memset(insn, 0, sizeof(*insn));
 398			INIT_LIST_HEAD(&insn->alts);
 399			INIT_LIST_HEAD(&insn->stack_ops);
 400			INIT_LIST_HEAD(&insn->call_node);
 401
 
 402			insn->sec = sec;
 403			insn->offset = offset;
 
 404
 405			ret = arch_decode_instruction(file, sec, offset,
 406						      sec->sh.sh_size - offset,
 407						      &insn->len, &insn->type,
 408						      &insn->immediate,
 409						      &insn->stack_ops);
 410			if (ret)
 411				goto err;
 
 
 412
 413			/*
 414			 * By default, "ud2" is a dead end unless otherwise
 415			 * annotated, because GCC 7 inserts it for certain
 416			 * divide-by-zero cases.
 417			 */
 418			if (insn->type == INSN_BUG)
 419				insn->dead_end = true;
 420
 421			hash_add(file->insn_hash, &insn->hash, sec_offset_hash(sec, insn->offset));
 422			list_add_tail(&insn->list, &file->insn_list);
 423			nr_insns++;
 424		}
 425
 426		list_for_each_entry(func, &sec->symbol_list, list) {
 
 
 427			if (func->type != STT_NOTYPE && func->type != STT_FUNC)
 428				continue;
 429
 430			if (func->offset == sec->sh.sh_size) {
 431				/* Heuristic: likely an "end" symbol */
 432				if (func->type == STT_NOTYPE)
 433					continue;
 434				WARN("%s(): STT_FUNC at end of section",
 435				     func->name);
 436				return -1;
 437			}
 438
 439			if (func->return_thunk || func->alias != func)
 440				continue;
 441
 442			if (!find_insn(file, sec, func->offset)) {
 443				WARN("%s(): can't find starting instruction",
 444				     func->name);
 445				return -1;
 446			}
 447
 448			sym_for_each_insn(file, func, insn) {
 449				insn->sym = func;
 450				if (func->type == STT_FUNC &&
 451				    insn->type == INSN_ENDBR &&
 452				    list_empty(&insn->call_node)) {
 453					if (insn->offset == func->offset) {
 454						list_add_tail(&insn->call_node, &file->endbr_list);
 455						file->nr_endbr++;
 456					} else {
 457						file->nr_endbr_int++;
 458					}
 459				}
 460			}
 461		}
 462	}
 463
 464	if (opts.stats)
 465		printf("nr_insns: %lu\n", nr_insns);
 466
 467	return 0;
 468
 469err:
 470	free(insn);
 471	return ret;
 472}
 473
 474/*
 475 * Read the pv_ops[] .data table to find the static initialized values.
 476 */
 477static int add_pv_ops(struct objtool_file *file, const char *symname)
 478{
 479	struct symbol *sym, *func;
 480	unsigned long off, end;
 481	struct reloc *rel;
 482	int idx;
 483
 484	sym = find_symbol_by_name(file->elf, symname);
 485	if (!sym)
 486		return 0;
 487
 488	off = sym->offset;
 489	end = off + sym->len;
 490	for (;;) {
 491		rel = find_reloc_by_dest_range(file->elf, sym->sec, off, end - off);
 492		if (!rel)
 493			break;
 494
 495		func = rel->sym;
 496		if (func->type == STT_SECTION)
 497			func = find_symbol_by_offset(rel->sym->sec, rel->addend);
 
 498
 499		idx = (rel->offset - sym->offset) / sizeof(unsigned long);
 500
 501		objtool_pv_add(file, idx, func);
 502
 503		off = rel->offset + 1;
 504		if (off > end)
 505			break;
 506	}
 507
 508	return 0;
 509}
 510
 511/*
 512 * Allocate and initialize file->pv_ops[].
 513 */
 514static int init_pv_ops(struct objtool_file *file)
 515{
 516	static const char *pv_ops_tables[] = {
 517		"pv_ops",
 518		"xen_cpu_ops",
 519		"xen_irq_ops",
 520		"xen_mmu_ops",
 521		NULL,
 522	};
 523	const char *pv_ops;
 524	struct symbol *sym;
 525	int idx, nr;
 526
 527	if (!opts.noinstr)
 528		return 0;
 529
 530	file->pv_ops = NULL;
 531
 532	sym = find_symbol_by_name(file->elf, "pv_ops");
 533	if (!sym)
 534		return 0;
 535
 536	nr = sym->len / sizeof(unsigned long);
 537	file->pv_ops = calloc(sizeof(struct pv_state), nr);
 538	if (!file->pv_ops)
 539		return -1;
 540
 541	for (idx = 0; idx < nr; idx++)
 542		INIT_LIST_HEAD(&file->pv_ops[idx].targets);
 543
 544	for (idx = 0; (pv_ops = pv_ops_tables[idx]); idx++)
 545		add_pv_ops(file, pv_ops);
 546
 547	return 0;
 548}
 549
 550static struct instruction *find_last_insn(struct objtool_file *file,
 551					  struct section *sec)
 552{
 553	struct instruction *insn = NULL;
 554	unsigned int offset;
 555	unsigned int end = (sec->sh.sh_size > 10) ? sec->sh.sh_size - 10 : 0;
 556
 557	for (offset = sec->sh.sh_size - 1; offset >= end && !insn; offset--)
 558		insn = find_insn(file, sec, offset);
 559
 560	return insn;
 561}
 562
 563/*
 564 * Mark "ud2" instructions and manually annotated dead ends.
 565 */
 566static int add_dead_ends(struct objtool_file *file)
 567{
 568	struct section *sec;
 569	struct reloc *reloc;
 570	struct instruction *insn;
 
 571
 572	/*
 573	 * Check for manually annotated dead ends.
 
 574	 */
 575	sec = find_section_by_name(file->elf, ".rela.discard.unreachable");
 576	if (!sec)
 577		goto reachable;
 578
 579	list_for_each_entry(reloc, &sec->reloc_list, list) {
 580		if (reloc->sym->type != STT_SECTION) {
 581			WARN("unexpected relocation symbol type in %s", sec->name);
 582			return -1;
 583		}
 584		insn = find_insn(file, reloc->sym->sec, reloc->addend);
 585		if (insn)
 586			insn = list_prev_entry(insn, list);
 587		else if (reloc->addend == reloc->sym->sec->sh.sh_size) {
 588			insn = find_last_insn(file, reloc->sym->sec);
 589			if (!insn) {
 590				WARN("can't find unreachable insn at %s+0x%" PRIx64,
 591				     reloc->sym->sec->name, reloc->addend);
 592				return -1;
 593			}
 594		} else {
 595			WARN("can't find unreachable insn at %s+0x%" PRIx64,
 596			     reloc->sym->sec->name, reloc->addend);
 597			return -1;
 598		}
 599
 600		insn->dead_end = true;
 601	}
 602
 603reachable:
 604	/*
 605	 * These manually annotated reachable checks are needed for GCC 4.4,
 606	 * where the Linux unreachable() macro isn't supported.  In that case
 607	 * GCC doesn't know the "ud2" is fatal, so it generates code as if it's
 608	 * not a dead end.
 609	 */
 610	sec = find_section_by_name(file->elf, ".rela.discard.reachable");
 611	if (!sec)
 612		return 0;
 613
 614	list_for_each_entry(reloc, &sec->reloc_list, list) {
 615		if (reloc->sym->type != STT_SECTION) {
 616			WARN("unexpected relocation symbol type in %s", sec->name);
 617			return -1;
 618		}
 619		insn = find_insn(file, reloc->sym->sec, reloc->addend);
 620		if (insn)
 621			insn = list_prev_entry(insn, list);
 622		else if (reloc->addend == reloc->sym->sec->sh.sh_size) {
 623			insn = find_last_insn(file, reloc->sym->sec);
 624			if (!insn) {
 625				WARN("can't find reachable insn at %s+0x%" PRIx64,
 626				     reloc->sym->sec->name, reloc->addend);
 627				return -1;
 628			}
 629		} else {
 630			WARN("can't find reachable insn at %s+0x%" PRIx64,
 631			     reloc->sym->sec->name, reloc->addend);
 632			return -1;
 633		}
 634
 635		insn->dead_end = false;
 636	}
 637
 638	return 0;
 639}
 640
 641static int create_static_call_sections(struct objtool_file *file)
 642{
 643	struct section *sec;
 644	struct static_call_site *site;
 
 645	struct instruction *insn;
 646	struct symbol *key_sym;
 647	char *key_name, *tmp;
 648	int idx;
 649
 650	sec = find_section_by_name(file->elf, ".static_call_sites");
 651	if (sec) {
 652		INIT_LIST_HEAD(&file->static_call_list);
 653		WARN("file already has .static_call_sites section, skipping");
 654		return 0;
 655	}
 656
 657	if (list_empty(&file->static_call_list))
 658		return 0;
 659
 660	idx = 0;
 661	list_for_each_entry(insn, &file->static_call_list, call_node)
 662		idx++;
 663
 664	sec = elf_create_section(file->elf, ".static_call_sites", SHF_WRITE,
 665				 sizeof(struct static_call_site), idx);
 666	if (!sec)
 667		return -1;
 668
 
 
 
 669	idx = 0;
 670	list_for_each_entry(insn, &file->static_call_list, call_node) {
 671
 672		site = (struct static_call_site *)sec->data->d_buf + idx;
 673		memset(site, 0, sizeof(struct static_call_site));
 674
 675		/* populate reloc for 'addr' */
 676		if (elf_add_reloc_to_insn(file->elf, sec,
 677					  idx * sizeof(struct static_call_site),
 678					  R_X86_64_PC32,
 679					  insn->sec, insn->offset))
 680			return -1;
 681
 682		/* find key symbol */
 683		key_name = strdup(insn->call_dest->name);
 684		if (!key_name) {
 685			perror("strdup");
 686			return -1;
 687		}
 688		if (strncmp(key_name, STATIC_CALL_TRAMP_PREFIX_STR,
 689			    STATIC_CALL_TRAMP_PREFIX_LEN)) {
 690			WARN("static_call: trampoline name malformed: %s", key_name);
 
 691			return -1;
 692		}
 693		tmp = key_name + STATIC_CALL_TRAMP_PREFIX_LEN - STATIC_CALL_KEY_PREFIX_LEN;
 694		memcpy(tmp, STATIC_CALL_KEY_PREFIX_STR, STATIC_CALL_KEY_PREFIX_LEN);
 695
 696		key_sym = find_symbol_by_name(file->elf, tmp);
 697		if (!key_sym) {
 698			if (!opts.module) {
 699				WARN("static_call: can't find static_call_key symbol: %s", tmp);
 
 700				return -1;
 701			}
 702
 703			/*
 704			 * For modules(), the key might not be exported, which
 705			 * means the module can make static calls but isn't
 706			 * allowed to change them.
 707			 *
 708			 * In that case we temporarily set the key to be the
 709			 * trampoline address.  This is fixed up in
 710			 * static_call_add_module().
 711			 */
 712			key_sym = insn->call_dest;
 713		}
 714		free(key_name);
 715
 716		/* populate reloc for 'key' */
 717		if (elf_add_reloc(file->elf, sec,
 718				  idx * sizeof(struct static_call_site) + 4,
 719				  R_X86_64_PC32, key_sym,
 720				  is_sibling_call(insn) * STATIC_CALL_SITE_TAIL))
 721			return -1;
 722
 723		idx++;
 724	}
 725
 726	return 0;
 727}
 728
 729static int create_retpoline_sites_sections(struct objtool_file *file)
 730{
 731	struct instruction *insn;
 732	struct section *sec;
 733	int idx;
 734
 735	sec = find_section_by_name(file->elf, ".retpoline_sites");
 736	if (sec) {
 737		WARN("file already has .retpoline_sites, skipping");
 738		return 0;
 739	}
 740
 741	idx = 0;
 742	list_for_each_entry(insn, &file->retpoline_call_list, call_node)
 743		idx++;
 744
 745	if (!idx)
 746		return 0;
 747
 748	sec = elf_create_section(file->elf, ".retpoline_sites", 0,
 749				 sizeof(int), idx);
 750	if (!sec) {
 751		WARN("elf_create_section: .retpoline_sites");
 752		return -1;
 753	}
 754
 755	idx = 0;
 756	list_for_each_entry(insn, &file->retpoline_call_list, call_node) {
 757
 758		int *site = (int *)sec->data->d_buf + idx;
 759		*site = 0;
 760
 761		if (elf_add_reloc_to_insn(file->elf, sec,
 762					  idx * sizeof(int),
 763					  R_X86_64_PC32,
 764					  insn->sec, insn->offset)) {
 765			WARN("elf_add_reloc_to_insn: .retpoline_sites");
 766			return -1;
 767		}
 768
 769		idx++;
 770	}
 771
 772	return 0;
 773}
 774
 775static int create_return_sites_sections(struct objtool_file *file)
 776{
 777	struct instruction *insn;
 778	struct section *sec;
 779	int idx;
 780
 781	sec = find_section_by_name(file->elf, ".return_sites");
 782	if (sec) {
 783		WARN("file already has .return_sites, skipping");
 784		return 0;
 785	}
 786
 787	idx = 0;
 788	list_for_each_entry(insn, &file->return_thunk_list, call_node)
 789		idx++;
 790
 791	if (!idx)
 792		return 0;
 793
 794	sec = elf_create_section(file->elf, ".return_sites", 0,
 795				 sizeof(int), idx);
 796	if (!sec) {
 797		WARN("elf_create_section: .return_sites");
 798		return -1;
 799	}
 800
 801	idx = 0;
 802	list_for_each_entry(insn, &file->return_thunk_list, call_node) {
 803
 804		int *site = (int *)sec->data->d_buf + idx;
 805		*site = 0;
 806
 807		if (elf_add_reloc_to_insn(file->elf, sec,
 808					  idx * sizeof(int),
 809					  R_X86_64_PC32,
 810					  insn->sec, insn->offset)) {
 811			WARN("elf_add_reloc_to_insn: .return_sites");
 812			return -1;
 813		}
 814
 815		idx++;
 816	}
 817
 818	return 0;
 819}
 820
 821static int create_ibt_endbr_seal_sections(struct objtool_file *file)
 822{
 823	struct instruction *insn;
 824	struct section *sec;
 825	int idx;
 826
 827	sec = find_section_by_name(file->elf, ".ibt_endbr_seal");
 828	if (sec) {
 829		WARN("file already has .ibt_endbr_seal, skipping");
 830		return 0;
 831	}
 832
 833	idx = 0;
 834	list_for_each_entry(insn, &file->endbr_list, call_node)
 835		idx++;
 836
 837	if (opts.stats) {
 838		printf("ibt: ENDBR at function start: %d\n", file->nr_endbr);
 839		printf("ibt: ENDBR inside functions:  %d\n", file->nr_endbr_int);
 840		printf("ibt: superfluous ENDBR:       %d\n", idx);
 841	}
 842
 843	if (!idx)
 844		return 0;
 845
 846	sec = elf_create_section(file->elf, ".ibt_endbr_seal", 0,
 847				 sizeof(int), idx);
 848	if (!sec) {
 849		WARN("elf_create_section: .ibt_endbr_seal");
 850		return -1;
 851	}
 852
 853	idx = 0;
 854	list_for_each_entry(insn, &file->endbr_list, call_node) {
 855
 856		int *site = (int *)sec->data->d_buf + idx;
 
 857		*site = 0;
 858
 859		if (elf_add_reloc_to_insn(file->elf, sec,
 860					  idx * sizeof(int),
 861					  R_X86_64_PC32,
 862					  insn->sec, insn->offset)) {
 863			WARN("elf_add_reloc_to_insn: .ibt_endbr_seal");
 
 
 
 
 864			return -1;
 865		}
 866
 867		idx++;
 868	}
 869
 870	return 0;
 871}
 872
 873static int create_cfi_sections(struct objtool_file *file)
 874{
 875	struct section *sec, *s;
 876	struct symbol *sym;
 877	unsigned int *loc;
 878	int idx;
 879
 880	sec = find_section_by_name(file->elf, ".cfi_sites");
 881	if (sec) {
 882		INIT_LIST_HEAD(&file->call_list);
 883		WARN("file already has .cfi_sites section, skipping");
 884		return 0;
 885	}
 886
 887	idx = 0;
 888	for_each_sec(file, s) {
 889		if (!s->text)
 890			continue;
 891
 892		list_for_each_entry(sym, &s->symbol_list, list) {
 893			if (sym->type != STT_FUNC)
 894				continue;
 895
 896			if (strncmp(sym->name, "__cfi_", 6))
 897				continue;
 898
 899			idx++;
 900		}
 901	}
 902
 903	sec = elf_create_section(file->elf, ".cfi_sites", 0, sizeof(unsigned int), idx);
 
 904	if (!sec)
 905		return -1;
 906
 907	idx = 0;
 908	for_each_sec(file, s) {
 909		if (!s->text)
 910			continue;
 911
 912		list_for_each_entry(sym, &s->symbol_list, list) {
 913			if (sym->type != STT_FUNC)
 914				continue;
 915
 916			if (strncmp(sym->name, "__cfi_", 6))
 917				continue;
 918
 919			loc = (unsigned int *)sec->data->d_buf + idx;
 920			memset(loc, 0, sizeof(unsigned int));
 921
 922			if (elf_add_reloc_to_insn(file->elf, sec,
 923						  idx * sizeof(unsigned int),
 924						  R_X86_64_PC32,
 925						  s, sym->offset))
 926				return -1;
 927
 928			idx++;
 929		}
 930	}
 931
 932	return 0;
 933}
 934
 935static int create_mcount_loc_sections(struct objtool_file *file)
 936{
 937	int addrsize = elf_class_addrsize(file->elf);
 938	struct instruction *insn;
 939	struct section *sec;
 940	int idx;
 941
 942	sec = find_section_by_name(file->elf, "__mcount_loc");
 943	if (sec) {
 944		INIT_LIST_HEAD(&file->mcount_loc_list);
 945		WARN("file already has __mcount_loc section, skipping");
 946		return 0;
 947	}
 948
 949	if (list_empty(&file->mcount_loc_list))
 950		return 0;
 951
 952	idx = 0;
 953	list_for_each_entry(insn, &file->mcount_loc_list, call_node)
 954		idx++;
 955
 956	sec = elf_create_section(file->elf, "__mcount_loc", 0, addrsize, idx);
 
 957	if (!sec)
 958		return -1;
 959
 960	sec->sh.sh_addralign = addrsize;
 961
 962	idx = 0;
 963	list_for_each_entry(insn, &file->mcount_loc_list, call_node) {
 964		void *loc;
 965
 966		loc = sec->data->d_buf + idx;
 967		memset(loc, 0, addrsize);
 968
 969		if (elf_add_reloc_to_insn(file->elf, sec, idx,
 970					  addrsize == sizeof(u64) ? R_ABS64 : R_ABS32,
 971					  insn->sec, insn->offset))
 972			return -1;
 973
 974		idx += addrsize;
 
 
 975	}
 976
 977	return 0;
 978}
 979
 980static int create_direct_call_sections(struct objtool_file *file)
 981{
 982	struct instruction *insn;
 983	struct section *sec;
 984	unsigned int *loc;
 985	int idx;
 986
 987	sec = find_section_by_name(file->elf, ".call_sites");
 988	if (sec) {
 989		INIT_LIST_HEAD(&file->call_list);
 990		WARN("file already has .call_sites section, skipping");
 991		return 0;
 992	}
 993
 994	if (list_empty(&file->call_list))
 995		return 0;
 996
 997	idx = 0;
 998	list_for_each_entry(insn, &file->call_list, call_node)
 999		idx++;
1000
1001	sec = elf_create_section(file->elf, ".call_sites", 0, sizeof(unsigned int), idx);
 
1002	if (!sec)
1003		return -1;
1004
1005	idx = 0;
1006	list_for_each_entry(insn, &file->call_list, call_node) {
1007
1008		loc = (unsigned int *)sec->data->d_buf + idx;
1009		memset(loc, 0, sizeof(unsigned int));
1010
1011		if (elf_add_reloc_to_insn(file->elf, sec,
1012					  idx * sizeof(unsigned int),
1013					  R_X86_64_PC32,
1014					  insn->sec, insn->offset))
1015			return -1;
1016
1017		idx++;
1018	}
1019
1020	return 0;
1021}
1022
1023/*
1024 * Warnings shouldn't be reported for ignored functions.
1025 */
1026static void add_ignores(struct objtool_file *file)
1027{
1028	struct instruction *insn;
1029	struct section *sec;
1030	struct symbol *func;
1031	struct reloc *reloc;
1032
1033	sec = find_section_by_name(file->elf, ".rela.discard.func_stack_frame_non_standard");
1034	if (!sec)
1035		return;
1036
1037	list_for_each_entry(reloc, &sec->reloc_list, list) {
1038		switch (reloc->sym->type) {
1039		case STT_FUNC:
1040			func = reloc->sym;
1041			break;
1042
1043		case STT_SECTION:
1044			func = find_func_by_offset(reloc->sym->sec, reloc->addend);
1045			if (!func)
1046				continue;
1047			break;
1048
1049		default:
1050			WARN("unexpected relocation symbol type in %s: %d", sec->name, reloc->sym->type);
 
1051			continue;
1052		}
1053
1054		func_for_each_insn(file, func, insn)
1055			insn->ignore = true;
1056	}
1057}
1058
1059/*
1060 * This is a whitelist of functions that is allowed to be called with AC set.
1061 * The list is meant to be minimal and only contains compiler instrumentation
1062 * ABI and a few functions used to implement *_{to,from}_user() functions.
1063 *
1064 * These functions must not directly change AC, but may PUSHF/POPF.
1065 */
1066static const char *uaccess_safe_builtin[] = {
1067	/* KASAN */
1068	"kasan_report",
1069	"kasan_check_range",
1070	/* KASAN out-of-line */
1071	"__asan_loadN_noabort",
1072	"__asan_load1_noabort",
1073	"__asan_load2_noabort",
1074	"__asan_load4_noabort",
1075	"__asan_load8_noabort",
1076	"__asan_load16_noabort",
1077	"__asan_storeN_noabort",
1078	"__asan_store1_noabort",
1079	"__asan_store2_noabort",
1080	"__asan_store4_noabort",
1081	"__asan_store8_noabort",
1082	"__asan_store16_noabort",
1083	"__kasan_check_read",
1084	"__kasan_check_write",
1085	/* KASAN in-line */
1086	"__asan_report_load_n_noabort",
1087	"__asan_report_load1_noabort",
1088	"__asan_report_load2_noabort",
1089	"__asan_report_load4_noabort",
1090	"__asan_report_load8_noabort",
1091	"__asan_report_load16_noabort",
1092	"__asan_report_store_n_noabort",
1093	"__asan_report_store1_noabort",
1094	"__asan_report_store2_noabort",
1095	"__asan_report_store4_noabort",
1096	"__asan_report_store8_noabort",
1097	"__asan_report_store16_noabort",
1098	/* KCSAN */
1099	"__kcsan_check_access",
1100	"__kcsan_mb",
1101	"__kcsan_wmb",
1102	"__kcsan_rmb",
1103	"__kcsan_release",
1104	"kcsan_found_watchpoint",
1105	"kcsan_setup_watchpoint",
1106	"kcsan_check_scoped_accesses",
1107	"kcsan_disable_current",
1108	"kcsan_enable_current_nowarn",
1109	/* KCSAN/TSAN */
1110	"__tsan_func_entry",
1111	"__tsan_func_exit",
1112	"__tsan_read_range",
1113	"__tsan_write_range",
1114	"__tsan_read1",
1115	"__tsan_read2",
1116	"__tsan_read4",
1117	"__tsan_read8",
1118	"__tsan_read16",
1119	"__tsan_write1",
1120	"__tsan_write2",
1121	"__tsan_write4",
1122	"__tsan_write8",
1123	"__tsan_write16",
1124	"__tsan_read_write1",
1125	"__tsan_read_write2",
1126	"__tsan_read_write4",
1127	"__tsan_read_write8",
1128	"__tsan_read_write16",
1129	"__tsan_volatile_read1",
1130	"__tsan_volatile_read2",
1131	"__tsan_volatile_read4",
1132	"__tsan_volatile_read8",
1133	"__tsan_volatile_read16",
1134	"__tsan_volatile_write1",
1135	"__tsan_volatile_write2",
1136	"__tsan_volatile_write4",
1137	"__tsan_volatile_write8",
1138	"__tsan_volatile_write16",
1139	"__tsan_atomic8_load",
1140	"__tsan_atomic16_load",
1141	"__tsan_atomic32_load",
1142	"__tsan_atomic64_load",
1143	"__tsan_atomic8_store",
1144	"__tsan_atomic16_store",
1145	"__tsan_atomic32_store",
1146	"__tsan_atomic64_store",
1147	"__tsan_atomic8_exchange",
1148	"__tsan_atomic16_exchange",
1149	"__tsan_atomic32_exchange",
1150	"__tsan_atomic64_exchange",
1151	"__tsan_atomic8_fetch_add",
1152	"__tsan_atomic16_fetch_add",
1153	"__tsan_atomic32_fetch_add",
1154	"__tsan_atomic64_fetch_add",
1155	"__tsan_atomic8_fetch_sub",
1156	"__tsan_atomic16_fetch_sub",
1157	"__tsan_atomic32_fetch_sub",
1158	"__tsan_atomic64_fetch_sub",
1159	"__tsan_atomic8_fetch_and",
1160	"__tsan_atomic16_fetch_and",
1161	"__tsan_atomic32_fetch_and",
1162	"__tsan_atomic64_fetch_and",
1163	"__tsan_atomic8_fetch_or",
1164	"__tsan_atomic16_fetch_or",
1165	"__tsan_atomic32_fetch_or",
1166	"__tsan_atomic64_fetch_or",
1167	"__tsan_atomic8_fetch_xor",
1168	"__tsan_atomic16_fetch_xor",
1169	"__tsan_atomic32_fetch_xor",
1170	"__tsan_atomic64_fetch_xor",
1171	"__tsan_atomic8_fetch_nand",
1172	"__tsan_atomic16_fetch_nand",
1173	"__tsan_atomic32_fetch_nand",
1174	"__tsan_atomic64_fetch_nand",
1175	"__tsan_atomic8_compare_exchange_strong",
1176	"__tsan_atomic16_compare_exchange_strong",
1177	"__tsan_atomic32_compare_exchange_strong",
1178	"__tsan_atomic64_compare_exchange_strong",
1179	"__tsan_atomic8_compare_exchange_weak",
1180	"__tsan_atomic16_compare_exchange_weak",
1181	"__tsan_atomic32_compare_exchange_weak",
1182	"__tsan_atomic64_compare_exchange_weak",
1183	"__tsan_atomic8_compare_exchange_val",
1184	"__tsan_atomic16_compare_exchange_val",
1185	"__tsan_atomic32_compare_exchange_val",
1186	"__tsan_atomic64_compare_exchange_val",
1187	"__tsan_atomic_thread_fence",
1188	"__tsan_atomic_signal_fence",
 
 
1189	/* KCOV */
1190	"write_comp_data",
1191	"check_kcov_mode",
1192	"__sanitizer_cov_trace_pc",
1193	"__sanitizer_cov_trace_const_cmp1",
1194	"__sanitizer_cov_trace_const_cmp2",
1195	"__sanitizer_cov_trace_const_cmp4",
1196	"__sanitizer_cov_trace_const_cmp8",
1197	"__sanitizer_cov_trace_cmp1",
1198	"__sanitizer_cov_trace_cmp2",
1199	"__sanitizer_cov_trace_cmp4",
1200	"__sanitizer_cov_trace_cmp8",
1201	"__sanitizer_cov_trace_switch",
1202	/* KMSAN */
1203	"kmsan_copy_to_user",
 
 
1204	"kmsan_report",
1205	"kmsan_unpoison_entry_regs",
1206	"kmsan_unpoison_memory",
1207	"__msan_chain_origin",
1208	"__msan_get_context_state",
1209	"__msan_instrument_asm_store",
1210	"__msan_metadata_ptr_for_load_1",
1211	"__msan_metadata_ptr_for_load_2",
1212	"__msan_metadata_ptr_for_load_4",
1213	"__msan_metadata_ptr_for_load_8",
1214	"__msan_metadata_ptr_for_load_n",
1215	"__msan_metadata_ptr_for_store_1",
1216	"__msan_metadata_ptr_for_store_2",
1217	"__msan_metadata_ptr_for_store_4",
1218	"__msan_metadata_ptr_for_store_8",
1219	"__msan_metadata_ptr_for_store_n",
1220	"__msan_poison_alloca",
1221	"__msan_warning",
1222	/* UBSAN */
1223	"ubsan_type_mismatch_common",
1224	"__ubsan_handle_type_mismatch",
1225	"__ubsan_handle_type_mismatch_v1",
1226	"__ubsan_handle_shift_out_of_bounds",
 
 
 
1227	/* misc */
1228	"csum_partial_copy_generic",
1229	"copy_mc_fragile",
1230	"copy_mc_fragile_handle_tail",
1231	"copy_mc_enhanced_fast_string",
1232	"ftrace_likely_update", /* CONFIG_TRACE_BRANCH_PROFILING */
1233	"clear_user_erms",
1234	"clear_user_rep_good",
1235	"clear_user_original",
1236	NULL
1237};
1238
1239static void add_uaccess_safe(struct objtool_file *file)
1240{
1241	struct symbol *func;
1242	const char **name;
1243
1244	if (!opts.uaccess)
1245		return;
1246
1247	for (name = uaccess_safe_builtin; *name; name++) {
1248		func = find_symbol_by_name(file->elf, *name);
1249		if (!func)
1250			continue;
1251
1252		func->uaccess_safe = true;
1253	}
1254}
1255
1256/*
1257 * FIXME: For now, just ignore any alternatives which add retpolines.  This is
1258 * a temporary hack, as it doesn't allow ORC to unwind from inside a retpoline.
1259 * But it at least allows objtool to understand the control flow *around* the
1260 * retpoline.
1261 */
1262static int add_ignore_alternatives(struct objtool_file *file)
1263{
1264	struct section *sec;
1265	struct reloc *reloc;
1266	struct instruction *insn;
1267
1268	sec = find_section_by_name(file->elf, ".rela.discard.ignore_alts");
1269	if (!sec)
1270		return 0;
1271
1272	list_for_each_entry(reloc, &sec->reloc_list, list) {
1273		if (reloc->sym->type != STT_SECTION) {
1274			WARN("unexpected relocation symbol type in %s", sec->name);
1275			return -1;
1276		}
1277
1278		insn = find_insn(file, reloc->sym->sec, reloc->addend);
1279		if (!insn) {
1280			WARN("bad .discard.ignore_alts entry");
1281			return -1;
1282		}
1283
1284		insn->ignore_alts = true;
1285	}
1286
1287	return 0;
1288}
1289
 
 
 
 
1290__weak bool arch_is_retpoline(struct symbol *sym)
1291{
1292	return false;
1293}
1294
 
 
 
 
1295__weak bool arch_is_rethunk(struct symbol *sym)
1296{
1297	return false;
1298}
1299
1300#define NEGATIVE_RELOC	((void *)-1L)
 
 
 
 
 
 
 
1301
1302static struct reloc *insn_reloc(struct objtool_file *file, struct instruction *insn)
1303{
1304	if (insn->reloc == NEGATIVE_RELOC)
 
 
1305		return NULL;
1306
1307	if (!insn->reloc) {
1308		if (!file)
1309			return NULL;
1310
1311		insn->reloc = find_reloc_by_dest_range(file->elf, insn->sec,
1312						       insn->offset, insn->len);
1313		if (!insn->reloc) {
1314			insn->reloc = NEGATIVE_RELOC;
1315			return NULL;
1316		}
1317	}
1318
1319	return insn->reloc;
1320}
1321
1322static void remove_insn_ops(struct instruction *insn)
1323{
1324	struct stack_op *op, *tmp;
1325
1326	list_for_each_entry_safe(op, tmp, &insn->stack_ops, list) {
1327		list_del(&op->list);
1328		free(op);
1329	}
 
1330}
1331
1332static void annotate_call_site(struct objtool_file *file,
1333			       struct instruction *insn, bool sibling)
1334{
1335	struct reloc *reloc = insn_reloc(file, insn);
1336	struct symbol *sym = insn->call_dest;
1337
1338	if (!sym)
1339		sym = reloc->sym;
1340
1341	/*
1342	 * Alternative replacement code is just template code which is
1343	 * sometimes copied to the original instruction. For now, don't
1344	 * annotate it. (In the future we might consider annotating the
1345	 * original instruction if/when it ever makes sense to do so.)
1346	 */
1347	if (!strcmp(insn->sec->name, ".altinstr_replacement"))
1348		return;
1349
1350	if (sym->static_call_tramp) {
1351		list_add_tail(&insn->call_node, &file->static_call_list);
1352		return;
1353	}
1354
1355	if (sym->retpoline_thunk) {
1356		list_add_tail(&insn->call_node, &file->retpoline_call_list);
1357		return;
1358	}
1359
1360	/*
1361	 * Many compilers cannot disable KCOV or sanitizer calls with a function
1362	 * attribute so they need a little help, NOP out any such calls from
1363	 * noinstr text.
1364	 */
1365	if (opts.hack_noinstr && insn->sec->noinstr && sym->profiling_func) {
1366		if (reloc) {
1367			reloc->type = R_NONE;
1368			elf_write_reloc(file->elf, reloc);
1369		}
1370
1371		elf_write_insn(file->elf, insn->sec,
1372			       insn->offset, insn->len,
1373			       sibling ? arch_ret_insn(insn->len)
1374			               : arch_nop_insn(insn->len));
1375
1376		insn->type = sibling ? INSN_RETURN : INSN_NOP;
1377
1378		if (sibling) {
1379			/*
1380			 * We've replaced the tail-call JMP insn by two new
1381			 * insn: RET; INT3, except we only have a single struct
1382			 * insn here. Mark it retpoline_safe to avoid the SLS
1383			 * warning, instead of adding another insn.
1384			 */
1385			insn->retpoline_safe = true;
1386		}
1387
1388		return;
1389	}
1390
1391	if (opts.mcount && sym->fentry) {
1392		if (sibling)
1393			WARN_FUNC("Tail call to __fentry__ !?!?", insn->sec, insn->offset);
1394		if (opts.mnop) {
1395			if (reloc) {
1396				reloc->type = R_NONE;
1397				elf_write_reloc(file->elf, reloc);
1398			}
1399
1400			elf_write_insn(file->elf, insn->sec,
1401				       insn->offset, insn->len,
1402				       arch_nop_insn(insn->len));
1403
1404			insn->type = INSN_NOP;
1405		}
1406
1407		list_add_tail(&insn->call_node, &file->mcount_loc_list);
1408		return;
1409	}
1410
1411	if (insn->type == INSN_CALL && !insn->sec->init)
1412		list_add_tail(&insn->call_node, &file->call_list);
1413
1414	if (!sibling && dead_end_function(file, sym))
1415		insn->dead_end = true;
1416}
1417
1418static void add_call_dest(struct objtool_file *file, struct instruction *insn,
1419			  struct symbol *dest, bool sibling)
1420{
1421	insn->call_dest = dest;
1422	if (!dest)
1423		return;
1424
1425	/*
1426	 * Whatever stack impact regular CALLs have, should be undone
1427	 * by the RETURN of the called function.
1428	 *
1429	 * Annotated intra-function calls retain the stack_ops but
1430	 * are converted to JUMP, see read_intra_function_calls().
1431	 */
1432	remove_insn_ops(insn);
1433
1434	annotate_call_site(file, insn, sibling);
1435}
1436
1437static void add_retpoline_call(struct objtool_file *file, struct instruction *insn)
1438{
1439	/*
1440	 * Retpoline calls/jumps are really dynamic calls/jumps in disguise,
1441	 * so convert them accordingly.
1442	 */
1443	switch (insn->type) {
1444	case INSN_CALL:
1445		insn->type = INSN_CALL_DYNAMIC;
1446		break;
1447	case INSN_JUMP_UNCONDITIONAL:
1448		insn->type = INSN_JUMP_DYNAMIC;
1449		break;
1450	case INSN_JUMP_CONDITIONAL:
1451		insn->type = INSN_JUMP_DYNAMIC_CONDITIONAL;
1452		break;
1453	default:
1454		return;
1455	}
1456
1457	insn->retpoline_safe = true;
1458
1459	/*
1460	 * Whatever stack impact regular CALLs have, should be undone
1461	 * by the RETURN of the called function.
1462	 *
1463	 * Annotated intra-function calls retain the stack_ops but
1464	 * are converted to JUMP, see read_intra_function_calls().
1465	 */
1466	remove_insn_ops(insn);
1467
1468	annotate_call_site(file, insn, false);
1469}
1470
1471static void add_return_call(struct objtool_file *file, struct instruction *insn, bool add)
1472{
1473	/*
1474	 * Return thunk tail calls are really just returns in disguise,
1475	 * so convert them accordingly.
1476	 */
1477	insn->type = INSN_RETURN;
1478	insn->retpoline_safe = true;
1479
1480	if (add)
1481		list_add_tail(&insn->call_node, &file->return_thunk_list);
1482}
1483
1484static bool is_first_func_insn(struct objtool_file *file,
1485			       struct instruction *insn, struct symbol *sym)
1486{
1487	if (insn->offset == sym->offset)
1488		return true;
1489
1490	/* Allow direct CALL/JMP past ENDBR */
1491	if (opts.ibt) {
1492		struct instruction *prev = prev_insn_same_sym(file, insn);
1493
1494		if (prev && prev->type == INSN_ENDBR &&
1495		    insn->offset == sym->offset + prev->len)
1496			return true;
1497	}
1498
1499	return false;
1500}
1501
1502/*
1503 * A sibling call is a tail-call to another symbol -- to differentiate from a
1504 * recursive tail-call which is to the same symbol.
1505 */
1506static bool jump_is_sibling_call(struct objtool_file *file,
1507				 struct instruction *from, struct instruction *to)
1508{
1509	struct symbol *fs = from->sym;
1510	struct symbol *ts = to->sym;
1511
1512	/* Not a sibling call if from/to a symbol hole */
1513	if (!fs || !ts)
1514		return false;
1515
1516	/* Not a sibling call if not targeting the start of a symbol. */
1517	if (!is_first_func_insn(file, to, ts))
1518		return false;
1519
1520	/* Disallow sibling calls into STT_NOTYPE */
1521	if (ts->type == STT_NOTYPE)
1522		return false;
1523
1524	/* Must not be self to be a sibling */
1525	return fs->pfunc != ts->pfunc;
1526}
1527
1528/*
1529 * Find the destination instructions for all jumps.
1530 */
1531static int add_jump_destinations(struct objtool_file *file)
1532{
1533	struct instruction *insn, *jump_dest;
1534	struct reloc *reloc;
1535	struct section *dest_sec;
1536	unsigned long dest_off;
1537
1538	for_each_insn(file, insn) {
1539		if (insn->jump_dest) {
1540			/*
1541			 * handle_group_alt() may have previously set
1542			 * 'jump_dest' for some alternatives.
1543			 */
1544			continue;
1545		}
1546		if (!is_static_jump(insn))
1547			continue;
1548
1549		reloc = insn_reloc(file, insn);
1550		if (!reloc) {
1551			dest_sec = insn->sec;
1552			dest_off = arch_jump_destination(insn);
1553		} else if (reloc->sym->type == STT_SECTION) {
1554			dest_sec = reloc->sym->sec;
1555			dest_off = arch_dest_reloc_offset(reloc->addend);
1556		} else if (reloc->sym->retpoline_thunk) {
1557			add_retpoline_call(file, insn);
1558			continue;
1559		} else if (reloc->sym->return_thunk) {
1560			add_return_call(file, insn, true);
1561			continue;
1562		} else if (insn_func(insn)) {
1563			/*
1564			 * External sibling call or internal sibling call with
1565			 * STT_FUNC reloc.
1566			 */
1567			add_call_dest(file, insn, reloc->sym, true);
1568			continue;
1569		} else if (reloc->sym->sec->idx) {
1570			dest_sec = reloc->sym->sec;
1571			dest_off = reloc->sym->sym.st_value +
1572				   arch_dest_reloc_offset(reloc->addend);
1573		} else {
1574			/* non-func asm code jumping to another file */
1575			continue;
1576		}
1577
1578		jump_dest = find_insn(file, dest_sec, dest_off);
1579		if (!jump_dest) {
1580			struct symbol *sym = find_symbol_by_offset(dest_sec, dest_off);
1581
1582			/*
1583			 * This is a special case for zen_untrain_ret().
1584			 * It jumps to __x86_return_thunk(), but objtool
1585			 * can't find the thunk's starting RET
1586			 * instruction, because the RET is also in the
1587			 * middle of another instruction.  Objtool only
1588			 * knows about the outer instruction.
1589			 */
1590			if (sym && sym->return_thunk) {
1591				add_return_call(file, insn, false);
1592				continue;
1593			}
1594
1595			WARN_FUNC("can't find jump dest instruction at %s+0x%lx",
1596				  insn->sec, insn->offset, dest_sec->name,
1597				  dest_off);
1598			return -1;
1599		}
1600
1601		/*
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1602		 * Cross-function jump.
1603		 */
1604		if (insn_func(insn) && insn_func(jump_dest) &&
1605		    insn_func(insn) != insn_func(jump_dest)) {
1606
1607			/*
1608			 * For GCC 8+, create parent/child links for any cold
1609			 * subfunctions.  This is _mostly_ redundant with a
1610			 * similar initialization in read_symbols().
1611			 *
1612			 * If a function has aliases, we want the *first* such
1613			 * function in the symbol table to be the subfunction's
1614			 * parent.  In that case we overwrite the
1615			 * initialization done in read_symbols().
1616			 *
1617			 * However this code can't completely replace the
1618			 * read_symbols() code because this doesn't detect the
1619			 * case where the parent function's only reference to a
1620			 * subfunction is through a jump table.
1621			 */
1622			if (!strstr(insn_func(insn)->name, ".cold") &&
1623			    strstr(insn_func(jump_dest)->name, ".cold")) {
1624				insn_func(insn)->cfunc = insn_func(jump_dest);
1625				insn_func(jump_dest)->pfunc = insn_func(insn);
1626			}
1627		}
1628
1629		if (jump_is_sibling_call(file, insn, jump_dest)) {
1630			/*
1631			 * Internal sibling call without reloc or with
1632			 * STT_SECTION reloc.
1633			 */
1634			add_call_dest(file, insn, insn_func(jump_dest), true);
1635			continue;
1636		}
1637
1638		insn->jump_dest = jump_dest;
1639	}
1640
1641	return 0;
1642}
1643
1644static struct symbol *find_call_destination(struct section *sec, unsigned long offset)
1645{
1646	struct symbol *call_dest;
1647
1648	call_dest = find_func_by_offset(sec, offset);
1649	if (!call_dest)
1650		call_dest = find_symbol_by_offset(sec, offset);
1651
1652	return call_dest;
1653}
1654
1655/*
1656 * Find the destination instructions for all calls.
1657 */
1658static int add_call_destinations(struct objtool_file *file)
1659{
1660	struct instruction *insn;
1661	unsigned long dest_off;
1662	struct symbol *dest;
1663	struct reloc *reloc;
1664
1665	for_each_insn(file, insn) {
1666		if (insn->type != INSN_CALL)
1667			continue;
1668
1669		reloc = insn_reloc(file, insn);
1670		if (!reloc) {
1671			dest_off = arch_jump_destination(insn);
1672			dest = find_call_destination(insn->sec, dest_off);
1673
1674			add_call_dest(file, insn, dest, false);
1675
1676			if (insn->ignore)
1677				continue;
1678
1679			if (!insn->call_dest) {
1680				WARN_FUNC("unannotated intra-function call", insn->sec, insn->offset);
1681				return -1;
1682			}
1683
1684			if (insn_func(insn) && insn->call_dest->type != STT_FUNC) {
1685				WARN_FUNC("unsupported call to non-function",
1686					  insn->sec, insn->offset);
1687				return -1;
1688			}
1689
1690		} else if (reloc->sym->type == STT_SECTION) {
1691			dest_off = arch_dest_reloc_offset(reloc->addend);
1692			dest = find_call_destination(reloc->sym->sec, dest_off);
1693			if (!dest) {
1694				WARN_FUNC("can't find call dest symbol at %s+0x%lx",
1695					  insn->sec, insn->offset,
1696					  reloc->sym->sec->name,
1697					  dest_off);
1698				return -1;
1699			}
1700
1701			add_call_dest(file, insn, dest, false);
1702
1703		} else if (reloc->sym->retpoline_thunk) {
1704			add_retpoline_call(file, insn);
1705
1706		} else
1707			add_call_dest(file, insn, reloc->sym, false);
1708	}
1709
1710	return 0;
1711}
1712
1713/*
1714 * The .alternatives section requires some extra special care over and above
1715 * other special sections because alternatives are patched in place.
1716 */
1717static int handle_group_alt(struct objtool_file *file,
1718			    struct special_alt *special_alt,
1719			    struct instruction *orig_insn,
1720			    struct instruction **new_insn)
1721{
1722	struct instruction *last_orig_insn, *last_new_insn = NULL, *insn, *nop = NULL;
1723	struct alt_group *orig_alt_group, *new_alt_group;
1724	unsigned long dest_off;
1725
1726
1727	orig_alt_group = malloc(sizeof(*orig_alt_group));
1728	if (!orig_alt_group) {
1729		WARN("malloc failed");
1730		return -1;
1731	}
1732	orig_alt_group->cfi = calloc(special_alt->orig_len,
1733				     sizeof(struct cfi_state *));
1734	if (!orig_alt_group->cfi) {
1735		WARN("calloc failed");
1736		return -1;
1737	}
1738
1739	last_orig_insn = NULL;
1740	insn = orig_insn;
1741	sec_for_each_insn_from(file, insn) {
1742		if (insn->offset >= special_alt->orig_off + special_alt->orig_len)
1743			break;
 
 
 
 
 
 
1744
1745		insn->alt_group = orig_alt_group;
1746		last_orig_insn = insn;
1747	}
1748	orig_alt_group->orig_group = NULL;
1749	orig_alt_group->first_insn = orig_insn;
1750	orig_alt_group->last_insn = last_orig_insn;
1751
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1752
1753	new_alt_group = malloc(sizeof(*new_alt_group));
1754	if (!new_alt_group) {
1755		WARN("malloc failed");
1756		return -1;
1757	}
1758
1759	if (special_alt->new_len < special_alt->orig_len) {
1760		/*
1761		 * Insert a fake nop at the end to make the replacement
1762		 * alt_group the same size as the original.  This is needed to
1763		 * allow propagate_alt_cfi() to do its magic.  When the last
1764		 * instruction affects the stack, the instruction after it (the
1765		 * nop) will propagate the new state to the shared CFI array.
1766		 */
1767		nop = malloc(sizeof(*nop));
1768		if (!nop) {
1769			WARN("malloc failed");
1770			return -1;
1771		}
1772		memset(nop, 0, sizeof(*nop));
1773		INIT_LIST_HEAD(&nop->alts);
1774		INIT_LIST_HEAD(&nop->stack_ops);
1775
1776		nop->sec = special_alt->new_sec;
1777		nop->offset = special_alt->new_off + special_alt->new_len;
1778		nop->len = special_alt->orig_len - special_alt->new_len;
1779		nop->type = INSN_NOP;
1780		nop->sym = orig_insn->sym;
1781		nop->alt_group = new_alt_group;
1782		nop->ignore = orig_insn->ignore_alts;
1783	}
1784
1785	if (!special_alt->new_len) {
1786		*new_insn = nop;
1787		goto end;
1788	}
1789
1790	insn = *new_insn;
1791	sec_for_each_insn_from(file, insn) {
1792		struct reloc *alt_reloc;
1793
1794		if (insn->offset >= special_alt->new_off + special_alt->new_len)
1795			break;
1796
1797		last_new_insn = insn;
1798
1799		insn->ignore = orig_insn->ignore_alts;
1800		insn->sym = orig_insn->sym;
1801		insn->alt_group = new_alt_group;
1802
1803		/*
1804		 * Since alternative replacement code is copy/pasted by the
1805		 * kernel after applying relocations, generally such code can't
1806		 * have relative-address relocation references to outside the
1807		 * .altinstr_replacement section, unless the arch's
1808		 * alternatives code can adjust the relative offsets
1809		 * accordingly.
1810		 */
1811		alt_reloc = insn_reloc(file, insn);
1812		if (alt_reloc && arch_pc_relative_reloc(alt_reloc) &&
1813		    !arch_support_alt_relocation(special_alt, insn, alt_reloc)) {
1814
1815			WARN_FUNC("unsupported relocation in alternatives section",
1816				  insn->sec, insn->offset);
1817			return -1;
1818		}
1819
1820		if (!is_static_jump(insn))
1821			continue;
1822
1823		if (!insn->immediate)
1824			continue;
1825
1826		dest_off = arch_jump_destination(insn);
1827		if (dest_off == special_alt->new_off + special_alt->new_len) {
1828			insn->jump_dest = next_insn_same_sec(file, last_orig_insn);
1829			if (!insn->jump_dest) {
1830				WARN_FUNC("can't find alternative jump destination",
1831					  insn->sec, insn->offset);
1832				return -1;
1833			}
1834		}
1835	}
1836
1837	if (!last_new_insn) {
1838		WARN_FUNC("can't find last new alternative instruction",
1839			  special_alt->new_sec, special_alt->new_off);
1840		return -1;
1841	}
1842
1843	if (nop)
1844		list_add(&nop->list, &last_new_insn->list);
1845end:
1846	new_alt_group->orig_group = orig_alt_group;
1847	new_alt_group->first_insn = *new_insn;
1848	new_alt_group->last_insn = nop ? : last_new_insn;
 
1849	new_alt_group->cfi = orig_alt_group->cfi;
1850	return 0;
1851}
1852
1853/*
1854 * A jump table entry can either convert a nop to a jump or a jump to a nop.
1855 * If the original instruction is a jump, make the alt entry an effective nop
1856 * by just skipping the original instruction.
1857 */
1858static int handle_jump_alt(struct objtool_file *file,
1859			   struct special_alt *special_alt,
1860			   struct instruction *orig_insn,
1861			   struct instruction **new_insn)
1862{
1863	if (orig_insn->type != INSN_JUMP_UNCONDITIONAL &&
1864	    orig_insn->type != INSN_NOP) {
1865
1866		WARN_FUNC("unsupported instruction at jump label",
1867			  orig_insn->sec, orig_insn->offset);
1868		return -1;
1869	}
1870
1871	if (opts.hack_jump_label && special_alt->key_addend & 2) {
1872		struct reloc *reloc = insn_reloc(file, orig_insn);
1873
1874		if (reloc) {
1875			reloc->type = R_NONE;
1876			elf_write_reloc(file->elf, reloc);
1877		}
1878		elf_write_insn(file->elf, orig_insn->sec,
1879			       orig_insn->offset, orig_insn->len,
1880			       arch_nop_insn(orig_insn->len));
1881		orig_insn->type = INSN_NOP;
1882	}
1883
1884	if (orig_insn->type == INSN_NOP) {
1885		if (orig_insn->len == 2)
1886			file->jl_nop_short++;
1887		else
1888			file->jl_nop_long++;
1889
1890		return 0;
1891	}
1892
1893	if (orig_insn->len == 2)
1894		file->jl_short++;
1895	else
1896		file->jl_long++;
1897
1898	*new_insn = list_next_entry(orig_insn, list);
1899	return 0;
1900}
1901
1902/*
1903 * Read all the special sections which have alternate instructions which can be
1904 * patched in or redirected to at runtime.  Each instruction having alternate
1905 * instruction(s) has them added to its insn->alts list, which will be
1906 * traversed in validate_branch().
1907 */
1908static int add_special_section_alts(struct objtool_file *file)
1909{
1910	struct list_head special_alts;
1911	struct instruction *orig_insn, *new_insn;
1912	struct special_alt *special_alt, *tmp;
1913	struct alternative *alt;
1914	int ret;
1915
1916	ret = special_get_alts(file->elf, &special_alts);
1917	if (ret)
1918		return ret;
1919
1920	list_for_each_entry_safe(special_alt, tmp, &special_alts, list) {
1921
1922		orig_insn = find_insn(file, special_alt->orig_sec,
1923				      special_alt->orig_off);
1924		if (!orig_insn) {
1925			WARN_FUNC("special: can't find orig instruction",
1926				  special_alt->orig_sec, special_alt->orig_off);
1927			ret = -1;
1928			goto out;
1929		}
1930
1931		new_insn = NULL;
1932		if (!special_alt->group || special_alt->new_len) {
1933			new_insn = find_insn(file, special_alt->new_sec,
1934					     special_alt->new_off);
1935			if (!new_insn) {
1936				WARN_FUNC("special: can't find new instruction",
1937					  special_alt->new_sec,
1938					  special_alt->new_off);
1939				ret = -1;
1940				goto out;
1941			}
1942		}
1943
1944		if (special_alt->group) {
1945			if (!special_alt->orig_len) {
1946				WARN_FUNC("empty alternative entry",
1947					  orig_insn->sec, orig_insn->offset);
1948				continue;
1949			}
1950
1951			ret = handle_group_alt(file, special_alt, orig_insn,
1952					       &new_insn);
1953			if (ret)
1954				goto out;
1955		} else if (special_alt->jump_or_nop) {
1956			ret = handle_jump_alt(file, special_alt, orig_insn,
1957					      &new_insn);
1958			if (ret)
1959				goto out;
1960		}
1961
1962		alt = malloc(sizeof(*alt));
1963		if (!alt) {
1964			WARN("malloc failed");
1965			ret = -1;
1966			goto out;
1967		}
1968
1969		alt->insn = new_insn;
1970		alt->skip_orig = special_alt->skip_orig;
1971		orig_insn->ignore_alts |= special_alt->skip_alt;
1972		list_add_tail(&alt->list, &orig_insn->alts);
 
1973
1974		list_del(&special_alt->list);
1975		free(special_alt);
1976	}
1977
1978	if (opts.stats) {
1979		printf("jl\\\tNOP\tJMP\n");
1980		printf("short:\t%ld\t%ld\n", file->jl_nop_short, file->jl_short);
1981		printf("long:\t%ld\t%ld\n", file->jl_nop_long, file->jl_long);
1982	}
1983
1984out:
1985	return ret;
1986}
1987
1988static int add_jump_table(struct objtool_file *file, struct instruction *insn,
1989			    struct reloc *table)
1990{
1991	struct reloc *reloc = table;
1992	struct instruction *dest_insn;
1993	struct alternative *alt;
1994	struct symbol *pfunc = insn_func(insn)->pfunc;
 
 
1995	unsigned int prev_offset = 0;
 
 
1996
1997	/*
1998	 * Each @reloc is a switch table relocation which points to the target
1999	 * instruction.
2000	 */
2001	list_for_each_entry_from(reloc, &table->sec->reloc_list, list) {
2002
2003		/* Check for the end of the table: */
2004		if (reloc != table && reloc->jump_table_start)
2005			break;
2006
2007		/* Make sure the table entries are consecutive: */
2008		if (prev_offset && reloc->offset != prev_offset + 8)
2009			break;
2010
2011		/* Detect function pointers from contiguous objects: */
2012		if (reloc->sym->sec == pfunc->sec &&
2013		    reloc->addend == pfunc->offset)
2014			break;
2015
2016		dest_insn = find_insn(file, reloc->sym->sec, reloc->addend);
2017		if (!dest_insn)
2018			break;
2019
2020		/* Make sure the destination is in the same function: */
2021		if (!insn_func(dest_insn) || insn_func(dest_insn)->pfunc != pfunc)
2022			break;
2023
2024		alt = malloc(sizeof(*alt));
2025		if (!alt) {
2026			WARN("malloc failed");
2027			return -1;
2028		}
2029
2030		alt->insn = dest_insn;
2031		list_add_tail(&alt->list, &insn->alts);
2032		prev_offset = reloc->offset;
 
2033	}
2034
2035	if (!prev_offset) {
2036		WARN_FUNC("can't find switch jump table",
2037			  insn->sec, insn->offset);
2038		return -1;
2039	}
2040
2041	return 0;
2042}
2043
2044/*
2045 * find_jump_table() - Given a dynamic jump, find the switch jump table
2046 * associated with it.
2047 */
2048static struct reloc *find_jump_table(struct objtool_file *file,
2049				      struct symbol *func,
2050				      struct instruction *insn)
2051{
2052	struct reloc *table_reloc;
2053	struct instruction *dest_insn, *orig_insn = insn;
2054
2055	/*
2056	 * Backward search using the @first_jump_src links, these help avoid
2057	 * much of the 'in between' code. Which avoids us getting confused by
2058	 * it.
2059	 */
2060	for (;
2061	     insn && insn_func(insn) && insn_func(insn)->pfunc == func;
2062	     insn = insn->first_jump_src ?: prev_insn_same_sym(file, insn)) {
2063
2064		if (insn != orig_insn && insn->type == INSN_JUMP_DYNAMIC)
2065			break;
2066
2067		/* allow small jumps within the range */
2068		if (insn->type == INSN_JUMP_UNCONDITIONAL &&
2069		    insn->jump_dest &&
2070		    (insn->jump_dest->offset <= insn->offset ||
2071		     insn->jump_dest->offset > orig_insn->offset))
2072		    break;
2073
2074		table_reloc = arch_find_switch_table(file, insn);
2075		if (!table_reloc)
2076			continue;
2077		dest_insn = find_insn(file, table_reloc->sym->sec, table_reloc->addend);
2078		if (!dest_insn || !insn_func(dest_insn) || insn_func(dest_insn)->pfunc != func)
2079			continue;
2080
2081		return table_reloc;
2082	}
2083
2084	return NULL;
2085}
2086
2087/*
2088 * First pass: Mark the head of each jump table so that in the next pass,
2089 * we know when a given jump table ends and the next one starts.
2090 */
2091static void mark_func_jump_tables(struct objtool_file *file,
2092				    struct symbol *func)
2093{
2094	struct instruction *insn, *last = NULL;
2095	struct reloc *reloc;
2096
2097	func_for_each_insn(file, func, insn) {
2098		if (!last)
2099			last = insn;
2100
2101		/*
2102		 * Store back-pointers for unconditional forward jumps such
2103		 * that find_jump_table() can back-track using those and
2104		 * avoid some potentially confusing code.
2105		 */
2106		if (insn->type == INSN_JUMP_UNCONDITIONAL && insn->jump_dest &&
2107		    insn->offset > last->offset &&
2108		    insn->jump_dest->offset > insn->offset &&
2109		    !insn->jump_dest->first_jump_src) {
2110
2111			insn->jump_dest->first_jump_src = insn;
2112			last = insn->jump_dest;
2113		}
2114
2115		if (insn->type != INSN_JUMP_DYNAMIC)
2116			continue;
2117
2118		reloc = find_jump_table(file, func, insn);
2119		if (reloc) {
2120			reloc->jump_table_start = true;
2121			insn->jump_table = reloc;
2122		}
2123	}
2124}
2125
2126static int add_func_jump_tables(struct objtool_file *file,
2127				  struct symbol *func)
2128{
2129	struct instruction *insn;
2130	int ret;
2131
2132	func_for_each_insn(file, func, insn) {
2133		if (!insn->jump_table)
2134			continue;
2135
2136		ret = add_jump_table(file, insn, insn->jump_table);
 
 
 
 
 
 
 
2137		if (ret)
2138			return ret;
 
 
2139	}
2140
2141	return 0;
 
 
 
2142}
2143
2144/*
2145 * For some switch statements, gcc generates a jump table in the .rodata
2146 * section which contains a list of addresses within the function to jump to.
2147 * This finds these jump tables and adds them to the insn->alts lists.
2148 */
2149static int add_jump_table_alts(struct objtool_file *file)
2150{
2151	struct section *sec;
2152	struct symbol *func;
2153	int ret;
2154
2155	if (!file->rodata)
2156		return 0;
2157
2158	for_each_sec(file, sec) {
2159		list_for_each_entry(func, &sec->symbol_list, list) {
2160			if (func->type != STT_FUNC)
2161				continue;
2162
2163			mark_func_jump_tables(file, func);
2164			ret = add_func_jump_tables(file, func);
2165			if (ret)
2166				return ret;
2167		}
2168	}
2169
2170	return 0;
2171}
2172
2173static void set_func_state(struct cfi_state *state)
2174{
2175	state->cfa = initial_func_cfi.cfa;
2176	memcpy(&state->regs, &initial_func_cfi.regs,
2177	       CFI_NUM_REGS * sizeof(struct cfi_reg));
2178	state->stack_size = initial_func_cfi.cfa.offset;
 
2179}
2180
2181static int read_unwind_hints(struct objtool_file *file)
2182{
2183	struct cfi_state cfi = init_cfi;
2184	struct section *sec, *relocsec;
2185	struct unwind_hint *hint;
2186	struct instruction *insn;
2187	struct reloc *reloc;
 
2188	int i;
2189
2190	sec = find_section_by_name(file->elf, ".discard.unwind_hints");
2191	if (!sec)
2192		return 0;
2193
2194	relocsec = sec->reloc;
2195	if (!relocsec) {
2196		WARN("missing .rela.discard.unwind_hints section");
2197		return -1;
2198	}
2199
2200	if (sec->sh.sh_size % sizeof(struct unwind_hint)) {
2201		WARN("struct unwind_hint size mismatch");
2202		return -1;
2203	}
2204
2205	file->hints = true;
2206
2207	for (i = 0; i < sec->sh.sh_size / sizeof(struct unwind_hint); i++) {
2208		hint = (struct unwind_hint *)sec->data->d_buf + i;
2209
2210		reloc = find_reloc_by_dest(file->elf, sec, i * sizeof(*hint));
2211		if (!reloc) {
2212			WARN("can't find reloc for unwind_hints[%d]", i);
2213			return -1;
2214		}
2215
2216		insn = find_insn(file, reloc->sym->sec, reloc->addend);
 
 
 
 
 
 
 
 
 
2217		if (!insn) {
2218			WARN("can't find insn for unwind_hints[%d]", i);
2219			return -1;
2220		}
2221
2222		insn->hint = true;
2223
 
 
 
 
 
2224		if (hint->type == UNWIND_HINT_TYPE_SAVE) {
2225			insn->hint = false;
2226			insn->save = true;
2227			continue;
2228		}
2229
2230		if (hint->type == UNWIND_HINT_TYPE_RESTORE) {
2231			insn->restore = true;
2232			continue;
2233		}
2234
2235		if (hint->type == UNWIND_HINT_TYPE_REGS_PARTIAL) {
2236			struct symbol *sym = find_symbol_by_offset(insn->sec, insn->offset);
2237
2238			if (sym && sym->bind == STB_GLOBAL) {
2239				if (opts.ibt && insn->type != INSN_ENDBR && !insn->noendbr) {
2240					WARN_FUNC("UNWIND_HINT_IRET_REGS without ENDBR",
2241						  insn->sec, insn->offset);
2242				}
2243
2244				insn->entry = 1;
2245			}
2246		}
2247
2248		if (hint->type == UNWIND_HINT_TYPE_ENTRY) {
2249			hint->type = UNWIND_HINT_TYPE_CALL;
2250			insn->entry = 1;
2251		}
2252
2253		if (hint->type == UNWIND_HINT_TYPE_FUNC) {
2254			insn->cfi = &func_cfi;
2255			continue;
2256		}
2257
2258		if (insn->cfi)
2259			cfi = *(insn->cfi);
2260
2261		if (arch_decode_hint_reg(hint->sp_reg, &cfi.cfa.base)) {
2262			WARN_FUNC("unsupported unwind_hint sp base reg %d",
2263				  insn->sec, insn->offset, hint->sp_reg);
2264			return -1;
2265		}
2266
2267		cfi.cfa.offset = bswap_if_needed(file->elf, hint->sp_offset);
2268		cfi.type = hint->type;
2269		cfi.end = hint->end;
2270
2271		insn->cfi = cfi_hash_find_or_add(&cfi);
2272	}
2273
2274	return 0;
2275}
2276
2277static int read_noendbr_hints(struct objtool_file *file)
2278{
2279	struct section *sec;
2280	struct instruction *insn;
 
2281	struct reloc *reloc;
2282
2283	sec = find_section_by_name(file->elf, ".rela.discard.noendbr");
2284	if (!sec)
2285		return 0;
2286
2287	list_for_each_entry(reloc, &sec->reloc_list, list) {
2288		insn = find_insn(file, reloc->sym->sec, reloc->sym->offset + reloc->addend);
 
2289		if (!insn) {
2290			WARN("bad .discard.noendbr entry");
2291			return -1;
2292		}
2293
2294		insn->noendbr = 1;
2295	}
2296
2297	return 0;
2298}
2299
2300static int read_retpoline_hints(struct objtool_file *file)
2301{
2302	struct section *sec;
2303	struct instruction *insn;
2304	struct reloc *reloc;
2305
2306	sec = find_section_by_name(file->elf, ".rela.discard.retpoline_safe");
2307	if (!sec)
2308		return 0;
2309
2310	list_for_each_entry(reloc, &sec->reloc_list, list) {
2311		if (reloc->sym->type != STT_SECTION) {
2312			WARN("unexpected relocation symbol type in %s", sec->name);
2313			return -1;
2314		}
2315
2316		insn = find_insn(file, reloc->sym->sec, reloc->addend);
2317		if (!insn) {
2318			WARN("bad .discard.retpoline_safe entry");
2319			return -1;
2320		}
2321
2322		if (insn->type != INSN_JUMP_DYNAMIC &&
2323		    insn->type != INSN_CALL_DYNAMIC &&
2324		    insn->type != INSN_RETURN &&
2325		    insn->type != INSN_NOP) {
2326			WARN_FUNC("retpoline_safe hint not an indirect jump/call/ret/nop",
2327				  insn->sec, insn->offset);
2328			return -1;
2329		}
2330
2331		insn->retpoline_safe = true;
2332	}
2333
2334	return 0;
2335}
2336
2337static int read_instr_hints(struct objtool_file *file)
2338{
2339	struct section *sec;
2340	struct instruction *insn;
2341	struct reloc *reloc;
2342
2343	sec = find_section_by_name(file->elf, ".rela.discard.instr_end");
2344	if (!sec)
2345		return 0;
2346
2347	list_for_each_entry(reloc, &sec->reloc_list, list) {
2348		if (reloc->sym->type != STT_SECTION) {
2349			WARN("unexpected relocation symbol type in %s", sec->name);
2350			return -1;
2351		}
2352
2353		insn = find_insn(file, reloc->sym->sec, reloc->addend);
2354		if (!insn) {
2355			WARN("bad .discard.instr_end entry");
2356			return -1;
2357		}
2358
2359		insn->instr--;
2360	}
2361
2362	sec = find_section_by_name(file->elf, ".rela.discard.instr_begin");
2363	if (!sec)
2364		return 0;
2365
2366	list_for_each_entry(reloc, &sec->reloc_list, list) {
2367		if (reloc->sym->type != STT_SECTION) {
2368			WARN("unexpected relocation symbol type in %s", sec->name);
2369			return -1;
2370		}
2371
2372		insn = find_insn(file, reloc->sym->sec, reloc->addend);
2373		if (!insn) {
2374			WARN("bad .discard.instr_begin entry");
2375			return -1;
2376		}
2377
2378		insn->instr++;
2379	}
2380
2381	return 0;
2382}
2383
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2384static int read_intra_function_calls(struct objtool_file *file)
2385{
2386	struct instruction *insn;
2387	struct section *sec;
2388	struct reloc *reloc;
2389
2390	sec = find_section_by_name(file->elf, ".rela.discard.intra_function_calls");
2391	if (!sec)
2392		return 0;
2393
2394	list_for_each_entry(reloc, &sec->reloc_list, list) {
2395		unsigned long dest_off;
2396
2397		if (reloc->sym->type != STT_SECTION) {
2398			WARN("unexpected relocation symbol type in %s",
2399			     sec->name);
2400			return -1;
2401		}
2402
2403		insn = find_insn(file, reloc->sym->sec, reloc->addend);
2404		if (!insn) {
2405			WARN("bad .discard.intra_function_call entry");
2406			return -1;
2407		}
2408
2409		if (insn->type != INSN_CALL) {
2410			WARN_FUNC("intra_function_call not a direct call",
2411				  insn->sec, insn->offset);
2412			return -1;
2413		}
2414
2415		/*
2416		 * Treat intra-function CALLs as JMPs, but with a stack_op.
2417		 * See add_call_destinations(), which strips stack_ops from
2418		 * normal CALLs.
2419		 */
2420		insn->type = INSN_JUMP_UNCONDITIONAL;
2421
2422		dest_off = arch_jump_destination(insn);
2423		insn->jump_dest = find_insn(file, insn->sec, dest_off);
2424		if (!insn->jump_dest) {
2425			WARN_FUNC("can't find call dest at %s+0x%lx",
2426				  insn->sec, insn->offset,
2427				  insn->sec->name, dest_off);
2428			return -1;
2429		}
2430	}
2431
2432	return 0;
2433}
2434
2435/*
2436 * Return true if name matches an instrumentation function, where calls to that
2437 * function from noinstr code can safely be removed, but compilers won't do so.
2438 */
2439static bool is_profiling_func(const char *name)
2440{
2441	/*
2442	 * Many compilers cannot disable KCOV with a function attribute.
2443	 */
2444	if (!strncmp(name, "__sanitizer_cov_", 16))
2445		return true;
2446
2447	/*
2448	 * Some compilers currently do not remove __tsan_func_entry/exit nor
2449	 * __tsan_atomic_signal_fence (used for barrier instrumentation) with
2450	 * the __no_sanitize_thread attribute, remove them. Once the kernel's
2451	 * minimum Clang version is 14.0, this can be removed.
2452	 */
2453	if (!strncmp(name, "__tsan_func_", 12) ||
2454	    !strcmp(name, "__tsan_atomic_signal_fence"))
2455		return true;
2456
2457	return false;
2458}
2459
2460static int classify_symbols(struct objtool_file *file)
2461{
2462	struct section *sec;
2463	struct symbol *func;
2464
2465	for_each_sec(file, sec) {
2466		list_for_each_entry(func, &sec->symbol_list, list) {
2467			if (func->bind != STB_GLOBAL)
2468				continue;
2469
2470			if (!strncmp(func->name, STATIC_CALL_TRAMP_PREFIX_STR,
2471				     strlen(STATIC_CALL_TRAMP_PREFIX_STR)))
2472				func->static_call_tramp = true;
2473
2474			if (arch_is_retpoline(func))
2475				func->retpoline_thunk = true;
 
2476
2477			if (arch_is_rethunk(func))
2478				func->return_thunk = true;
2479
2480			if (arch_ftrace_match(func->name))
2481				func->fentry = true;
2482
2483			if (is_profiling_func(func->name))
2484				func->profiling_func = true;
2485		}
 
 
 
 
 
2486	}
2487
2488	return 0;
2489}
2490
2491static void mark_rodata(struct objtool_file *file)
2492{
2493	struct section *sec;
2494	bool found = false;
2495
2496	/*
2497	 * Search for the following rodata sections, each of which can
2498	 * potentially contain jump tables:
2499	 *
2500	 * - .rodata: can contain GCC switch tables
2501	 * - .rodata.<func>: same, if -fdata-sections is being used
2502	 * - .rodata..c_jump_table: contains C annotated jump tables
2503	 *
2504	 * .rodata.str1.* sections are ignored; they don't contain jump tables.
2505	 */
2506	for_each_sec(file, sec) {
2507		if (!strncmp(sec->name, ".rodata", 7) &&
2508		    !strstr(sec->name, ".str1.")) {
 
2509			sec->rodata = true;
2510			found = true;
2511		}
2512	}
2513
2514	file->rodata = found;
2515}
2516
2517static int decode_sections(struct objtool_file *file)
2518{
2519	int ret;
2520
2521	mark_rodata(file);
2522
2523	ret = init_pv_ops(file);
2524	if (ret)
2525		return ret;
2526
2527	/*
2528	 * Must be before add_{jump_call}_destination.
2529	 */
2530	ret = classify_symbols(file);
2531	if (ret)
2532		return ret;
2533
2534	ret = decode_instructions(file);
2535	if (ret)
2536		return ret;
2537
2538	add_ignores(file);
2539	add_uaccess_safe(file);
2540
2541	ret = add_ignore_alternatives(file);
2542	if (ret)
2543		return ret;
2544
2545	/*
2546	 * Must be before read_unwind_hints() since that needs insn->noendbr.
2547	 */
2548	ret = read_noendbr_hints(file);
2549	if (ret)
2550		return ret;
2551
2552	/*
2553	 * Must be before add_jump_destinations(), which depends on 'func'
2554	 * being set for alternatives, to enable proper sibling call detection.
2555	 */
2556	if (opts.stackval || opts.orc || opts.uaccess || opts.noinstr) {
2557		ret = add_special_section_alts(file);
2558		if (ret)
2559			return ret;
2560	}
2561
2562	ret = add_jump_destinations(file);
2563	if (ret)
2564		return ret;
2565
2566	/*
2567	 * Must be before add_call_destination(); it changes INSN_CALL to
2568	 * INSN_JUMP.
2569	 */
2570	ret = read_intra_function_calls(file);
2571	if (ret)
2572		return ret;
2573
2574	ret = add_call_destinations(file);
2575	if (ret)
2576		return ret;
2577
2578	/*
2579	 * Must be after add_call_destinations() such that it can override
2580	 * dead_end_function() marks.
2581	 */
2582	ret = add_dead_ends(file);
2583	if (ret)
2584		return ret;
2585
2586	ret = add_jump_table_alts(file);
2587	if (ret)
2588		return ret;
2589
2590	ret = read_unwind_hints(file);
2591	if (ret)
2592		return ret;
2593
2594	ret = read_retpoline_hints(file);
2595	if (ret)
2596		return ret;
2597
2598	ret = read_instr_hints(file);
2599	if (ret)
2600		return ret;
2601
 
 
 
 
2602	return 0;
2603}
2604
2605static bool is_fentry_call(struct instruction *insn)
2606{
2607	if (insn->type == INSN_CALL &&
2608	    insn->call_dest &&
2609	    insn->call_dest->fentry)
2610		return true;
 
 
 
 
 
2611
2612	return false;
2613}
2614
2615static bool has_modified_stack_frame(struct instruction *insn, struct insn_state *state)
2616{
2617	struct cfi_state *cfi = &state->cfi;
2618	int i;
2619
2620	if (cfi->cfa.base != initial_func_cfi.cfa.base || cfi->drap)
2621		return true;
2622
2623	if (cfi->cfa.offset != initial_func_cfi.cfa.offset)
2624		return true;
2625
2626	if (cfi->stack_size != initial_func_cfi.cfa.offset)
2627		return true;
2628
2629	for (i = 0; i < CFI_NUM_REGS; i++) {
2630		if (cfi->regs[i].base != initial_func_cfi.regs[i].base ||
2631		    cfi->regs[i].offset != initial_func_cfi.regs[i].offset)
2632			return true;
2633	}
2634
2635	return false;
2636}
2637
2638static bool check_reg_frame_pos(const struct cfi_reg *reg,
2639				int expected_offset)
2640{
2641	return reg->base == CFI_CFA &&
2642	       reg->offset == expected_offset;
2643}
2644
2645static bool has_valid_stack_frame(struct insn_state *state)
2646{
2647	struct cfi_state *cfi = &state->cfi;
2648
2649	if (cfi->cfa.base == CFI_BP &&
2650	    check_reg_frame_pos(&cfi->regs[CFI_BP], -cfi->cfa.offset) &&
2651	    check_reg_frame_pos(&cfi->regs[CFI_RA], -cfi->cfa.offset + 8))
2652		return true;
2653
2654	if (cfi->drap && cfi->regs[CFI_BP].base == CFI_BP)
2655		return true;
2656
2657	return false;
2658}
2659
2660static int update_cfi_state_regs(struct instruction *insn,
2661				  struct cfi_state *cfi,
2662				  struct stack_op *op)
2663{
2664	struct cfi_reg *cfa = &cfi->cfa;
2665
2666	if (cfa->base != CFI_SP && cfa->base != CFI_SP_INDIRECT)
2667		return 0;
2668
2669	/* push */
2670	if (op->dest.type == OP_DEST_PUSH || op->dest.type == OP_DEST_PUSHF)
2671		cfa->offset += 8;
2672
2673	/* pop */
2674	if (op->src.type == OP_SRC_POP || op->src.type == OP_SRC_POPF)
2675		cfa->offset -= 8;
2676
2677	/* add immediate to sp */
2678	if (op->dest.type == OP_DEST_REG && op->src.type == OP_SRC_ADD &&
2679	    op->dest.reg == CFI_SP && op->src.reg == CFI_SP)
2680		cfa->offset -= op->src.offset;
2681
2682	return 0;
2683}
2684
2685static void save_reg(struct cfi_state *cfi, unsigned char reg, int base, int offset)
2686{
2687	if (arch_callee_saved_reg(reg) &&
2688	    cfi->regs[reg].base == CFI_UNDEFINED) {
2689		cfi->regs[reg].base = base;
2690		cfi->regs[reg].offset = offset;
2691	}
2692}
2693
2694static void restore_reg(struct cfi_state *cfi, unsigned char reg)
2695{
2696	cfi->regs[reg].base = initial_func_cfi.regs[reg].base;
2697	cfi->regs[reg].offset = initial_func_cfi.regs[reg].offset;
2698}
2699
2700/*
2701 * A note about DRAP stack alignment:
2702 *
2703 * GCC has the concept of a DRAP register, which is used to help keep track of
2704 * the stack pointer when aligning the stack.  r10 or r13 is used as the DRAP
2705 * register.  The typical DRAP pattern is:
2706 *
2707 *   4c 8d 54 24 08		lea    0x8(%rsp),%r10
2708 *   48 83 e4 c0		and    $0xffffffffffffffc0,%rsp
2709 *   41 ff 72 f8		pushq  -0x8(%r10)
2710 *   55				push   %rbp
2711 *   48 89 e5			mov    %rsp,%rbp
2712 *				(more pushes)
2713 *   41 52			push   %r10
2714 *				...
2715 *   41 5a			pop    %r10
2716 *				(more pops)
2717 *   5d				pop    %rbp
2718 *   49 8d 62 f8		lea    -0x8(%r10),%rsp
2719 *   c3				retq
2720 *
2721 * There are some variations in the epilogues, like:
2722 *
2723 *   5b				pop    %rbx
2724 *   41 5a			pop    %r10
2725 *   41 5c			pop    %r12
2726 *   41 5d			pop    %r13
2727 *   41 5e			pop    %r14
2728 *   c9				leaveq
2729 *   49 8d 62 f8		lea    -0x8(%r10),%rsp
2730 *   c3				retq
2731 *
2732 * and:
2733 *
2734 *   4c 8b 55 e8		mov    -0x18(%rbp),%r10
2735 *   48 8b 5d e0		mov    -0x20(%rbp),%rbx
2736 *   4c 8b 65 f0		mov    -0x10(%rbp),%r12
2737 *   4c 8b 6d f8		mov    -0x8(%rbp),%r13
2738 *   c9				leaveq
2739 *   49 8d 62 f8		lea    -0x8(%r10),%rsp
2740 *   c3				retq
2741 *
2742 * Sometimes r13 is used as the DRAP register, in which case it's saved and
2743 * restored beforehand:
2744 *
2745 *   41 55			push   %r13
2746 *   4c 8d 6c 24 10		lea    0x10(%rsp),%r13
2747 *   48 83 e4 f0		and    $0xfffffffffffffff0,%rsp
2748 *				...
2749 *   49 8d 65 f0		lea    -0x10(%r13),%rsp
2750 *   41 5d			pop    %r13
2751 *   c3				retq
2752 */
2753static int update_cfi_state(struct instruction *insn,
2754			    struct instruction *next_insn,
2755			    struct cfi_state *cfi, struct stack_op *op)
2756{
2757	struct cfi_reg *cfa = &cfi->cfa;
2758	struct cfi_reg *regs = cfi->regs;
2759
 
 
 
 
2760	/* stack operations don't make sense with an undefined CFA */
2761	if (cfa->base == CFI_UNDEFINED) {
2762		if (insn_func(insn)) {
2763			WARN_FUNC("undefined stack state", insn->sec, insn->offset);
2764			return -1;
2765		}
2766		return 0;
2767	}
2768
2769	if (cfi->type == UNWIND_HINT_TYPE_REGS ||
2770	    cfi->type == UNWIND_HINT_TYPE_REGS_PARTIAL)
2771		return update_cfi_state_regs(insn, cfi, op);
2772
2773	switch (op->dest.type) {
2774
2775	case OP_DEST_REG:
2776		switch (op->src.type) {
2777
2778		case OP_SRC_REG:
2779			if (op->src.reg == CFI_SP && op->dest.reg == CFI_BP &&
2780			    cfa->base == CFI_SP &&
2781			    check_reg_frame_pos(&regs[CFI_BP], -cfa->offset)) {
2782
2783				/* mov %rsp, %rbp */
2784				cfa->base = op->dest.reg;
2785				cfi->bp_scratch = false;
2786			}
2787
2788			else if (op->src.reg == CFI_SP &&
2789				 op->dest.reg == CFI_BP && cfi->drap) {
2790
2791				/* drap: mov %rsp, %rbp */
2792				regs[CFI_BP].base = CFI_BP;
2793				regs[CFI_BP].offset = -cfi->stack_size;
2794				cfi->bp_scratch = false;
2795			}
2796
2797			else if (op->src.reg == CFI_SP && cfa->base == CFI_SP) {
2798
2799				/*
2800				 * mov %rsp, %reg
2801				 *
2802				 * This is needed for the rare case where GCC
2803				 * does:
2804				 *
2805				 *   mov    %rsp, %rax
2806				 *   ...
2807				 *   mov    %rax, %rsp
2808				 */
2809				cfi->vals[op->dest.reg].base = CFI_CFA;
2810				cfi->vals[op->dest.reg].offset = -cfi->stack_size;
2811			}
2812
2813			else if (op->src.reg == CFI_BP && op->dest.reg == CFI_SP &&
2814				 (cfa->base == CFI_BP || cfa->base == cfi->drap_reg)) {
2815
2816				/*
2817				 * mov %rbp, %rsp
2818				 *
2819				 * Restore the original stack pointer (Clang).
2820				 */
2821				cfi->stack_size = -cfi->regs[CFI_BP].offset;
2822			}
2823
2824			else if (op->dest.reg == cfa->base) {
2825
2826				/* mov %reg, %rsp */
2827				if (cfa->base == CFI_SP &&
2828				    cfi->vals[op->src.reg].base == CFI_CFA) {
2829
2830					/*
2831					 * This is needed for the rare case
2832					 * where GCC does something dumb like:
2833					 *
2834					 *   lea    0x8(%rsp), %rcx
2835					 *   ...
2836					 *   mov    %rcx, %rsp
2837					 */
2838					cfa->offset = -cfi->vals[op->src.reg].offset;
2839					cfi->stack_size = cfa->offset;
2840
2841				} else if (cfa->base == CFI_SP &&
2842					   cfi->vals[op->src.reg].base == CFI_SP_INDIRECT &&
2843					   cfi->vals[op->src.reg].offset == cfa->offset) {
2844
2845					/*
2846					 * Stack swizzle:
2847					 *
2848					 * 1: mov %rsp, (%[tos])
2849					 * 2: mov %[tos], %rsp
2850					 *    ...
2851					 * 3: pop %rsp
2852					 *
2853					 * Where:
2854					 *
2855					 * 1 - places a pointer to the previous
2856					 *     stack at the Top-of-Stack of the
2857					 *     new stack.
2858					 *
2859					 * 2 - switches to the new stack.
2860					 *
2861					 * 3 - pops the Top-of-Stack to restore
2862					 *     the original stack.
2863					 *
2864					 * Note: we set base to SP_INDIRECT
2865					 * here and preserve offset. Therefore
2866					 * when the unwinder reaches ToS it
2867					 * will dereference SP and then add the
2868					 * offset to find the next frame, IOW:
2869					 * (%rsp) + offset.
2870					 */
2871					cfa->base = CFI_SP_INDIRECT;
2872
2873				} else {
2874					cfa->base = CFI_UNDEFINED;
2875					cfa->offset = 0;
2876				}
2877			}
2878
2879			else if (op->dest.reg == CFI_SP &&
2880				 cfi->vals[op->src.reg].base == CFI_SP_INDIRECT &&
2881				 cfi->vals[op->src.reg].offset == cfa->offset) {
2882
2883				/*
2884				 * The same stack swizzle case 2) as above. But
2885				 * because we can't change cfa->base, case 3)
2886				 * will become a regular POP. Pretend we're a
2887				 * PUSH so things don't go unbalanced.
2888				 */
2889				cfi->stack_size += 8;
2890			}
2891
2892
2893			break;
2894
2895		case OP_SRC_ADD:
2896			if (op->dest.reg == CFI_SP && op->src.reg == CFI_SP) {
2897
2898				/* add imm, %rsp */
2899				cfi->stack_size -= op->src.offset;
2900				if (cfa->base == CFI_SP)
2901					cfa->offset -= op->src.offset;
2902				break;
2903			}
2904
2905			if (op->dest.reg == CFI_SP && op->src.reg == CFI_BP) {
2906
2907				/* lea disp(%rbp), %rsp */
2908				cfi->stack_size = -(op->src.offset + regs[CFI_BP].offset);
 
 
 
2909				break;
2910			}
2911
2912			if (!cfi->drap && op->src.reg == CFI_SP &&
2913			    op->dest.reg == CFI_BP && cfa->base == CFI_SP &&
2914			    check_reg_frame_pos(&regs[CFI_BP], -cfa->offset + op->src.offset)) {
2915
2916				/* lea disp(%rsp), %rbp */
2917				cfa->base = CFI_BP;
2918				cfa->offset -= op->src.offset;
2919				cfi->bp_scratch = false;
 
 
 
2920				break;
2921			}
2922
2923			if (op->src.reg == CFI_SP && cfa->base == CFI_SP) {
2924
2925				/* drap: lea disp(%rsp), %drap */
2926				cfi->drap_reg = op->dest.reg;
2927
2928				/*
2929				 * lea disp(%rsp), %reg
2930				 *
2931				 * This is needed for the rare case where GCC
2932				 * does something dumb like:
2933				 *
2934				 *   lea    0x8(%rsp), %rcx
2935				 *   ...
2936				 *   mov    %rcx, %rsp
2937				 */
2938				cfi->vals[op->dest.reg].base = CFI_CFA;
2939				cfi->vals[op->dest.reg].offset = \
2940					-cfi->stack_size + op->src.offset;
2941
2942				break;
2943			}
2944
2945			if (cfi->drap && op->dest.reg == CFI_SP &&
2946			    op->src.reg == cfi->drap_reg) {
2947
2948				 /* drap: lea disp(%drap), %rsp */
2949				cfa->base = CFI_SP;
2950				cfa->offset = cfi->stack_size = -op->src.offset;
2951				cfi->drap_reg = CFI_UNDEFINED;
2952				cfi->drap = false;
2953				break;
2954			}
2955
2956			if (op->dest.reg == cfi->cfa.base && !(next_insn && next_insn->hint)) {
2957				WARN_FUNC("unsupported stack register modification",
2958					  insn->sec, insn->offset);
2959				return -1;
2960			}
2961
2962			break;
2963
2964		case OP_SRC_AND:
2965			if (op->dest.reg != CFI_SP ||
2966			    (cfi->drap_reg != CFI_UNDEFINED && cfa->base != CFI_SP) ||
2967			    (cfi->drap_reg == CFI_UNDEFINED && cfa->base != CFI_BP)) {
2968				WARN_FUNC("unsupported stack pointer realignment",
2969					  insn->sec, insn->offset);
2970				return -1;
2971			}
2972
2973			if (cfi->drap_reg != CFI_UNDEFINED) {
2974				/* drap: and imm, %rsp */
2975				cfa->base = cfi->drap_reg;
2976				cfa->offset = cfi->stack_size = 0;
2977				cfi->drap = true;
2978			}
2979
2980			/*
2981			 * Older versions of GCC (4.8ish) realign the stack
2982			 * without DRAP, with a frame pointer.
2983			 */
2984
2985			break;
2986
2987		case OP_SRC_POP:
2988		case OP_SRC_POPF:
2989			if (op->dest.reg == CFI_SP && cfa->base == CFI_SP_INDIRECT) {
2990
2991				/* pop %rsp; # restore from a stack swizzle */
2992				cfa->base = CFI_SP;
2993				break;
2994			}
2995
2996			if (!cfi->drap && op->dest.reg == cfa->base) {
2997
2998				/* pop %rbp */
2999				cfa->base = CFI_SP;
3000			}
3001
3002			if (cfi->drap && cfa->base == CFI_BP_INDIRECT &&
3003			    op->dest.reg == cfi->drap_reg &&
3004			    cfi->drap_offset == -cfi->stack_size) {
3005
3006				/* drap: pop %drap */
3007				cfa->base = cfi->drap_reg;
3008				cfa->offset = 0;
3009				cfi->drap_offset = -1;
3010
3011			} else if (cfi->stack_size == -regs[op->dest.reg].offset) {
3012
3013				/* pop %reg */
3014				restore_reg(cfi, op->dest.reg);
3015			}
3016
3017			cfi->stack_size -= 8;
3018			if (cfa->base == CFI_SP)
3019				cfa->offset -= 8;
3020
3021			break;
3022
3023		case OP_SRC_REG_INDIRECT:
3024			if (!cfi->drap && op->dest.reg == cfa->base &&
3025			    op->dest.reg == CFI_BP) {
3026
3027				/* mov disp(%rsp), %rbp */
3028				cfa->base = CFI_SP;
3029				cfa->offset = cfi->stack_size;
3030			}
3031
3032			if (cfi->drap && op->src.reg == CFI_BP &&
3033			    op->src.offset == cfi->drap_offset) {
3034
3035				/* drap: mov disp(%rbp), %drap */
3036				cfa->base = cfi->drap_reg;
3037				cfa->offset = 0;
3038				cfi->drap_offset = -1;
3039			}
3040
3041			if (cfi->drap && op->src.reg == CFI_BP &&
3042			    op->src.offset == regs[op->dest.reg].offset) {
3043
3044				/* drap: mov disp(%rbp), %reg */
3045				restore_reg(cfi, op->dest.reg);
3046
3047			} else if (op->src.reg == cfa->base &&
3048			    op->src.offset == regs[op->dest.reg].offset + cfa->offset) {
3049
3050				/* mov disp(%rbp), %reg */
3051				/* mov disp(%rsp), %reg */
3052				restore_reg(cfi, op->dest.reg);
3053
3054			} else if (op->src.reg == CFI_SP &&
3055				   op->src.offset == regs[op->dest.reg].offset + cfi->stack_size) {
3056
3057				/* mov disp(%rsp), %reg */
3058				restore_reg(cfi, op->dest.reg);
3059			}
3060
3061			break;
3062
3063		default:
3064			WARN_FUNC("unknown stack-related instruction",
3065				  insn->sec, insn->offset);
3066			return -1;
3067		}
3068
3069		break;
3070
3071	case OP_DEST_PUSH:
3072	case OP_DEST_PUSHF:
3073		cfi->stack_size += 8;
3074		if (cfa->base == CFI_SP)
3075			cfa->offset += 8;
3076
3077		if (op->src.type != OP_SRC_REG)
3078			break;
3079
3080		if (cfi->drap) {
3081			if (op->src.reg == cfa->base && op->src.reg == cfi->drap_reg) {
3082
3083				/* drap: push %drap */
3084				cfa->base = CFI_BP_INDIRECT;
3085				cfa->offset = -cfi->stack_size;
3086
3087				/* save drap so we know when to restore it */
3088				cfi->drap_offset = -cfi->stack_size;
3089
3090			} else if (op->src.reg == CFI_BP && cfa->base == cfi->drap_reg) {
3091
3092				/* drap: push %rbp */
3093				cfi->stack_size = 0;
3094
3095			} else {
3096
3097				/* drap: push %reg */
3098				save_reg(cfi, op->src.reg, CFI_BP, -cfi->stack_size);
3099			}
3100
3101		} else {
3102
3103			/* push %reg */
3104			save_reg(cfi, op->src.reg, CFI_CFA, -cfi->stack_size);
3105		}
3106
3107		/* detect when asm code uses rbp as a scratch register */
3108		if (opts.stackval && insn_func(insn) && op->src.reg == CFI_BP &&
3109		    cfa->base != CFI_BP)
3110			cfi->bp_scratch = true;
3111		break;
3112
3113	case OP_DEST_REG_INDIRECT:
3114
3115		if (cfi->drap) {
3116			if (op->src.reg == cfa->base && op->src.reg == cfi->drap_reg) {
3117
3118				/* drap: mov %drap, disp(%rbp) */
3119				cfa->base = CFI_BP_INDIRECT;
3120				cfa->offset = op->dest.offset;
3121
3122				/* save drap offset so we know when to restore it */
3123				cfi->drap_offset = op->dest.offset;
3124			} else {
3125
3126				/* drap: mov reg, disp(%rbp) */
3127				save_reg(cfi, op->src.reg, CFI_BP, op->dest.offset);
3128			}
3129
3130		} else if (op->dest.reg == cfa->base) {
3131
3132			/* mov reg, disp(%rbp) */
3133			/* mov reg, disp(%rsp) */
3134			save_reg(cfi, op->src.reg, CFI_CFA,
3135				 op->dest.offset - cfi->cfa.offset);
3136
3137		} else if (op->dest.reg == CFI_SP) {
3138
3139			/* mov reg, disp(%rsp) */
3140			save_reg(cfi, op->src.reg, CFI_CFA,
3141				 op->dest.offset - cfi->stack_size);
3142
3143		} else if (op->src.reg == CFI_SP && op->dest.offset == 0) {
3144
3145			/* mov %rsp, (%reg); # setup a stack swizzle. */
3146			cfi->vals[op->dest.reg].base = CFI_SP_INDIRECT;
3147			cfi->vals[op->dest.reg].offset = cfa->offset;
3148		}
3149
3150		break;
3151
3152	case OP_DEST_MEM:
3153		if (op->src.type != OP_SRC_POP && op->src.type != OP_SRC_POPF) {
3154			WARN_FUNC("unknown stack-related memory operation",
3155				  insn->sec, insn->offset);
3156			return -1;
3157		}
3158
3159		/* pop mem */
3160		cfi->stack_size -= 8;
3161		if (cfa->base == CFI_SP)
3162			cfa->offset -= 8;
3163
3164		break;
3165
3166	default:
3167		WARN_FUNC("unknown stack-related instruction",
3168			  insn->sec, insn->offset);
3169		return -1;
3170	}
3171
3172	return 0;
3173}
3174
3175/*
3176 * The stack layouts of alternatives instructions can sometimes diverge when
3177 * they have stack modifications.  That's fine as long as the potential stack
3178 * layouts don't conflict at any given potential instruction boundary.
3179 *
3180 * Flatten the CFIs of the different alternative code streams (both original
3181 * and replacement) into a single shared CFI array which can be used to detect
3182 * conflicts and nicely feed a linear array of ORC entries to the unwinder.
3183 */
3184static int propagate_alt_cfi(struct objtool_file *file, struct instruction *insn)
3185{
3186	struct cfi_state **alt_cfi;
3187	int group_off;
3188
3189	if (!insn->alt_group)
3190		return 0;
3191
3192	if (!insn->cfi) {
3193		WARN("CFI missing");
3194		return -1;
3195	}
3196
3197	alt_cfi = insn->alt_group->cfi;
3198	group_off = insn->offset - insn->alt_group->first_insn->offset;
3199
3200	if (!alt_cfi[group_off]) {
3201		alt_cfi[group_off] = insn->cfi;
3202	} else {
3203		if (cficmp(alt_cfi[group_off], insn->cfi)) {
3204			WARN_FUNC("stack layout conflict in alternatives",
3205				  insn->sec, insn->offset);
 
 
 
3206			return -1;
3207		}
3208	}
3209
3210	return 0;
3211}
3212
3213static int handle_insn_ops(struct instruction *insn,
3214			   struct instruction *next_insn,
3215			   struct insn_state *state)
3216{
3217	struct stack_op *op;
3218
3219	list_for_each_entry(op, &insn->stack_ops, list) {
3220
3221		if (update_cfi_state(insn, next_insn, &state->cfi, op))
3222			return 1;
3223
3224		if (!insn->alt_group)
3225			continue;
3226
3227		if (op->dest.type == OP_DEST_PUSHF) {
3228			if (!state->uaccess_stack) {
3229				state->uaccess_stack = 1;
3230			} else if (state->uaccess_stack >> 31) {
3231				WARN_FUNC("PUSHF stack exhausted",
3232					  insn->sec, insn->offset);
3233				return 1;
3234			}
3235			state->uaccess_stack <<= 1;
3236			state->uaccess_stack  |= state->uaccess;
3237		}
3238
3239		if (op->src.type == OP_SRC_POPF) {
3240			if (state->uaccess_stack) {
3241				state->uaccess = state->uaccess_stack & 1;
3242				state->uaccess_stack >>= 1;
3243				if (state->uaccess_stack == 1)
3244					state->uaccess_stack = 0;
3245			}
3246		}
3247	}
3248
3249	return 0;
3250}
3251
3252static bool insn_cfi_match(struct instruction *insn, struct cfi_state *cfi2)
3253{
3254	struct cfi_state *cfi1 = insn->cfi;
3255	int i;
3256
3257	if (!cfi1) {
3258		WARN("CFI missing");
3259		return false;
3260	}
3261
3262	if (memcmp(&cfi1->cfa, &cfi2->cfa, sizeof(cfi1->cfa))) {
3263
3264		WARN_FUNC("stack state mismatch: cfa1=%d%+d cfa2=%d%+d",
3265			  insn->sec, insn->offset,
3266			  cfi1->cfa.base, cfi1->cfa.offset,
3267			  cfi2->cfa.base, cfi2->cfa.offset);
3268
3269	} else if (memcmp(&cfi1->regs, &cfi2->regs, sizeof(cfi1->regs))) {
3270		for (i = 0; i < CFI_NUM_REGS; i++) {
3271			if (!memcmp(&cfi1->regs[i], &cfi2->regs[i],
3272				    sizeof(struct cfi_reg)))
3273				continue;
3274
3275			WARN_FUNC("stack state mismatch: reg1[%d]=%d%+d reg2[%d]=%d%+d",
3276				  insn->sec, insn->offset,
3277				  i, cfi1->regs[i].base, cfi1->regs[i].offset,
3278				  i, cfi2->regs[i].base, cfi2->regs[i].offset);
3279			break;
3280		}
3281
3282	} else if (cfi1->type != cfi2->type) {
3283
3284		WARN_FUNC("stack state mismatch: type1=%d type2=%d",
3285			  insn->sec, insn->offset, cfi1->type, cfi2->type);
3286
3287	} else if (cfi1->drap != cfi2->drap ||
3288		   (cfi1->drap && cfi1->drap_reg != cfi2->drap_reg) ||
3289		   (cfi1->drap && cfi1->drap_offset != cfi2->drap_offset)) {
3290
3291		WARN_FUNC("stack state mismatch: drap1=%d(%d,%d) drap2=%d(%d,%d)",
3292			  insn->sec, insn->offset,
3293			  cfi1->drap, cfi1->drap_reg, cfi1->drap_offset,
3294			  cfi2->drap, cfi2->drap_reg, cfi2->drap_offset);
3295
3296	} else
3297		return true;
3298
3299	return false;
3300}
3301
3302static inline bool func_uaccess_safe(struct symbol *func)
3303{
3304	if (func)
3305		return func->uaccess_safe;
3306
3307	return false;
3308}
3309
3310static inline const char *call_dest_name(struct instruction *insn)
3311{
3312	static char pvname[19];
3313	struct reloc *rel;
3314	int idx;
3315
3316	if (insn->call_dest)
3317		return insn->call_dest->name;
3318
3319	rel = insn_reloc(NULL, insn);
3320	if (rel && !strcmp(rel->sym->name, "pv_ops")) {
3321		idx = (rel->addend / sizeof(void *));
3322		snprintf(pvname, sizeof(pvname), "pv_ops[%d]", idx);
3323		return pvname;
3324	}
3325
3326	return "{dynamic}";
3327}
3328
3329static bool pv_call_dest(struct objtool_file *file, struct instruction *insn)
3330{
3331	struct symbol *target;
3332	struct reloc *rel;
3333	int idx;
3334
3335	rel = insn_reloc(file, insn);
3336	if (!rel || strcmp(rel->sym->name, "pv_ops"))
3337		return false;
3338
3339	idx = (arch_dest_reloc_offset(rel->addend) / sizeof(void *));
3340
3341	if (file->pv_ops[idx].clean)
3342		return true;
3343
3344	file->pv_ops[idx].clean = true;
3345
3346	list_for_each_entry(target, &file->pv_ops[idx].targets, pv_target) {
3347		if (!target->sec->noinstr) {
3348			WARN("pv_ops[%d]: %s", idx, target->name);
3349			file->pv_ops[idx].clean = false;
3350		}
3351	}
3352
3353	return file->pv_ops[idx].clean;
3354}
3355
3356static inline bool noinstr_call_dest(struct objtool_file *file,
3357				     struct instruction *insn,
3358				     struct symbol *func)
3359{
3360	/*
3361	 * We can't deal with indirect function calls at present;
3362	 * assume they're instrumented.
3363	 */
3364	if (!func) {
3365		if (file->pv_ops)
3366			return pv_call_dest(file, insn);
3367
3368		return false;
3369	}
3370
3371	/*
3372	 * If the symbol is from a noinstr section; we good.
3373	 */
3374	if (func->sec->noinstr)
3375		return true;
3376
3377	/*
 
 
 
 
 
 
3378	 * The __ubsan_handle_*() calls are like WARN(), they only happen when
3379	 * something 'BAD' happened. At the risk of taking the machine down,
3380	 * let them proceed to get the message out.
3381	 */
3382	if (!strncmp(func->name, "__ubsan_handle_", 15))
3383		return true;
3384
3385	return false;
3386}
3387
3388static int validate_call(struct objtool_file *file,
3389			 struct instruction *insn,
3390			 struct insn_state *state)
3391{
3392	if (state->noinstr && state->instr <= 0 &&
3393	    !noinstr_call_dest(file, insn, insn->call_dest)) {
3394		WARN_FUNC("call to %s() leaves .noinstr.text section",
3395				insn->sec, insn->offset, call_dest_name(insn));
3396		return 1;
3397	}
3398
3399	if (state->uaccess && !func_uaccess_safe(insn->call_dest)) {
3400		WARN_FUNC("call to %s() with UACCESS enabled",
3401				insn->sec, insn->offset, call_dest_name(insn));
3402		return 1;
3403	}
3404
3405	if (state->df) {
3406		WARN_FUNC("call to %s() with DF set",
3407				insn->sec, insn->offset, call_dest_name(insn));
3408		return 1;
3409	}
3410
3411	return 0;
3412}
3413
3414static int validate_sibling_call(struct objtool_file *file,
3415				 struct instruction *insn,
3416				 struct insn_state *state)
3417{
3418	if (insn_func(insn) && has_modified_stack_frame(insn, state)) {
3419		WARN_FUNC("sibling call from callable instruction with modified stack frame",
3420				insn->sec, insn->offset);
3421		return 1;
3422	}
3423
3424	return validate_call(file, insn, state);
3425}
3426
3427static int validate_return(struct symbol *func, struct instruction *insn, struct insn_state *state)
3428{
3429	if (state->noinstr && state->instr > 0) {
3430		WARN_FUNC("return with instrumentation enabled",
3431			  insn->sec, insn->offset);
3432		return 1;
3433	}
3434
3435	if (state->uaccess && !func_uaccess_safe(func)) {
3436		WARN_FUNC("return with UACCESS enabled",
3437			  insn->sec, insn->offset);
3438		return 1;
3439	}
3440
3441	if (!state->uaccess && func_uaccess_safe(func)) {
3442		WARN_FUNC("return with UACCESS disabled from a UACCESS-safe function",
3443			  insn->sec, insn->offset);
3444		return 1;
3445	}
3446
3447	if (state->df) {
3448		WARN_FUNC("return with DF set",
3449			  insn->sec, insn->offset);
3450		return 1;
3451	}
3452
3453	if (func && has_modified_stack_frame(insn, state)) {
3454		WARN_FUNC("return with modified stack frame",
3455			  insn->sec, insn->offset);
3456		return 1;
3457	}
3458
3459	if (state->cfi.bp_scratch) {
3460		WARN_FUNC("BP used as a scratch register",
3461			  insn->sec, insn->offset);
3462		return 1;
3463	}
3464
3465	return 0;
3466}
3467
3468static struct instruction *next_insn_to_validate(struct objtool_file *file,
3469						 struct instruction *insn)
3470{
3471	struct alt_group *alt_group = insn->alt_group;
3472
3473	/*
3474	 * Simulate the fact that alternatives are patched in-place.  When the
3475	 * end of a replacement alt_group is reached, redirect objtool flow to
3476	 * the end of the original alt_group.
 
 
 
 
 
3477	 */
3478	if (alt_group && insn == alt_group->last_insn && alt_group->orig_group)
3479		return next_insn_same_sec(file, alt_group->orig_group->last_insn);
 
 
 
 
 
 
 
 
 
3480
3481	return next_insn_same_sec(file, insn);
 
 
 
3482}
3483
3484/*
3485 * Follow the branch starting at the given instruction, and recursively follow
3486 * any other branches (jumps).  Meanwhile, track the frame pointer state at
3487 * each instruction and validate all the rules described in
3488 * tools/objtool/Documentation/objtool.txt.
3489 */
3490static int validate_branch(struct objtool_file *file, struct symbol *func,
3491			   struct instruction *insn, struct insn_state state)
3492{
3493	struct alternative *alt;
3494	struct instruction *next_insn, *prev_insn = NULL;
3495	struct section *sec;
3496	u8 visited;
3497	int ret;
3498
3499	sec = insn->sec;
3500
3501	while (1) {
3502		next_insn = next_insn_to_validate(file, insn);
3503
3504		if (func && insn_func(insn) && func != insn_func(insn)->pfunc) {
3505			/* Ignore KCFI type preambles, which always fall through */
3506			if (!strncmp(func->name, "__cfi_", 6) ||
3507			    !strncmp(func->name, "__pfx_", 6))
3508				return 0;
3509
3510			WARN("%s() falls through to next function %s()",
3511			     func->name, insn_func(insn)->name);
3512			return 1;
3513		}
3514
3515		if (func && insn->ignore) {
3516			WARN_FUNC("BUG: why am I validating an ignored function?",
3517				  sec, insn->offset);
3518			return 1;
3519		}
3520
3521		visited = VISITED_BRANCH << state.uaccess;
3522		if (insn->visited & VISITED_BRANCH_MASK) {
3523			if (!insn->hint && !insn_cfi_match(insn, &state.cfi))
3524				return 1;
3525
3526			if (insn->visited & visited)
3527				return 0;
3528		} else {
3529			nr_insns_visited++;
3530		}
3531
3532		if (state.noinstr)
3533			state.instr += insn->instr;
3534
3535		if (insn->hint) {
3536			if (insn->restore) {
3537				struct instruction *save_insn, *i;
3538
3539				i = insn;
3540				save_insn = NULL;
3541
3542				sym_for_each_insn_continue_reverse(file, func, i) {
3543					if (i->save) {
3544						save_insn = i;
3545						break;
3546					}
3547				}
3548
3549				if (!save_insn) {
3550					WARN_FUNC("no corresponding CFI save for CFI restore",
3551						  sec, insn->offset);
3552					return 1;
3553				}
3554
3555				if (!save_insn->visited) {
3556					WARN_FUNC("objtool isn't smart enough to handle this CFI save/restore combo",
3557						  sec, insn->offset);
 
 
 
 
 
 
 
 
 
 
 
3558					return 1;
3559				}
3560
3561				insn->cfi = save_insn->cfi;
3562				nr_cfi_reused++;
3563			}
3564
3565			state.cfi = *insn->cfi;
3566		} else {
3567			/* XXX track if we actually changed state.cfi */
3568
3569			if (prev_insn && !cficmp(prev_insn->cfi, &state.cfi)) {
3570				insn->cfi = prev_insn->cfi;
3571				nr_cfi_reused++;
3572			} else {
3573				insn->cfi = cfi_hash_find_or_add(&state.cfi);
3574			}
3575		}
3576
3577		insn->visited |= visited;
3578
3579		if (propagate_alt_cfi(file, insn))
3580			return 1;
3581
3582		if (!insn->ignore_alts && !list_empty(&insn->alts)) {
3583			bool skip_orig = false;
3584
3585			list_for_each_entry(alt, &insn->alts, list) {
3586				if (alt->skip_orig)
3587					skip_orig = true;
3588
3589				ret = validate_branch(file, func, alt->insn, state);
3590				if (ret) {
3591					if (opts.backtrace)
3592						BT_FUNC("(alt)", insn);
3593					return ret;
3594				}
3595			}
3596
3597			if (skip_orig)
3598				return 0;
3599		}
3600
3601		if (handle_insn_ops(insn, next_insn, &state))
3602			return 1;
3603
3604		switch (insn->type) {
3605
3606		case INSN_RETURN:
3607			return validate_return(func, insn, &state);
3608
3609		case INSN_CALL:
3610		case INSN_CALL_DYNAMIC:
3611			ret = validate_call(file, insn, &state);
3612			if (ret)
3613				return ret;
3614
3615			if (opts.stackval && func && !is_fentry_call(insn) &&
3616			    !has_valid_stack_frame(&state)) {
3617				WARN_FUNC("call without frame pointer save/setup",
3618					  sec, insn->offset);
3619				return 1;
3620			}
3621
3622			if (insn->dead_end)
3623				return 0;
3624
3625			break;
3626
3627		case INSN_JUMP_CONDITIONAL:
3628		case INSN_JUMP_UNCONDITIONAL:
3629			if (is_sibling_call(insn)) {
3630				ret = validate_sibling_call(file, insn, &state);
3631				if (ret)
3632					return ret;
3633
3634			} else if (insn->jump_dest) {
3635				ret = validate_branch(file, func,
3636						      insn->jump_dest, state);
3637				if (ret) {
3638					if (opts.backtrace)
3639						BT_FUNC("(branch)", insn);
3640					return ret;
3641				}
3642			}
3643
3644			if (insn->type == INSN_JUMP_UNCONDITIONAL)
3645				return 0;
3646
3647			break;
3648
3649		case INSN_JUMP_DYNAMIC:
3650		case INSN_JUMP_DYNAMIC_CONDITIONAL:
3651			if (is_sibling_call(insn)) {
3652				ret = validate_sibling_call(file, insn, &state);
3653				if (ret)
3654					return ret;
3655			}
3656
3657			if (insn->type == INSN_JUMP_DYNAMIC)
3658				return 0;
3659
3660			break;
3661
3662		case INSN_CONTEXT_SWITCH:
3663			if (func && (!next_insn || !next_insn->hint)) {
3664				WARN_FUNC("unsupported instruction in callable function",
3665					  sec, insn->offset);
3666				return 1;
 
 
3667			}
3668			return 0;
3669
3670		case INSN_STAC:
3671			if (state.uaccess) {
3672				WARN_FUNC("recursive UACCESS enable", sec, insn->offset);
3673				return 1;
3674			}
3675
3676			state.uaccess = true;
3677			break;
3678
3679		case INSN_CLAC:
3680			if (!state.uaccess && func) {
3681				WARN_FUNC("redundant UACCESS disable", sec, insn->offset);
3682				return 1;
3683			}
3684
3685			if (func_uaccess_safe(func) && !state.uaccess_stack) {
3686				WARN_FUNC("UACCESS-safe disables UACCESS", sec, insn->offset);
3687				return 1;
3688			}
3689
3690			state.uaccess = false;
3691			break;
3692
3693		case INSN_STD:
3694			if (state.df) {
3695				WARN_FUNC("recursive STD", sec, insn->offset);
3696				return 1;
3697			}
3698
3699			state.df = true;
3700			break;
3701
3702		case INSN_CLD:
3703			if (!state.df && func) {
3704				WARN_FUNC("redundant CLD", sec, insn->offset);
3705				return 1;
3706			}
3707
3708			state.df = false;
3709			break;
3710
3711		default:
3712			break;
3713		}
3714
3715		if (insn->dead_end)
3716			return 0;
3717
3718		if (!next_insn) {
3719			if (state.cfi.cfa.base == CFI_UNDEFINED)
3720				return 0;
3721			WARN("%s: unexpected end of section", sec->name);
3722			return 1;
3723		}
3724
3725		prev_insn = insn;
3726		insn = next_insn;
3727	}
3728
3729	return 0;
3730}
3731
 
 
 
 
 
 
 
 
 
 
 
 
 
 
3732static int validate_unwind_hints(struct objtool_file *file, struct section *sec)
3733{
3734	struct instruction *insn;
3735	struct insn_state state;
3736	int ret, warnings = 0;
3737
3738	if (!file->hints)
3739		return 0;
3740
3741	init_insn_state(file, &state, sec);
3742
3743	if (sec) {
3744		insn = find_insn(file, sec, 0);
3745		if (!insn)
3746			return 0;
3747	} else {
3748		insn = list_first_entry(&file->insn_list, typeof(*insn), list);
3749	}
3750
3751	while (&insn->list != &file->insn_list && (!sec || insn->sec == sec)) {
3752		if (insn->hint && !insn->visited && !insn->ignore) {
3753			ret = validate_branch(file, insn_func(insn), insn, state);
3754			if (ret && opts.backtrace)
3755				BT_FUNC("<=== (hint)", insn);
3756			warnings += ret;
3757		}
3758
3759		insn = list_next_entry(insn, list);
3760	}
3761
3762	return warnings;
3763}
3764
3765/*
3766 * Validate rethunk entry constraint: must untrain RET before the first RET.
3767 *
3768 * Follow every branch (intra-function) and ensure ANNOTATE_UNRET_END comes
3769 * before an actual RET instruction.
3770 */
3771static int validate_entry(struct objtool_file *file, struct instruction *insn)
3772{
3773	struct instruction *next, *dest;
3774	int ret, warnings = 0;
3775
3776	for (;;) {
3777		next = next_insn_to_validate(file, insn);
3778
3779		if (insn->visited & VISITED_ENTRY)
3780			return 0;
3781
3782		insn->visited |= VISITED_ENTRY;
3783
3784		if (!insn->ignore_alts && !list_empty(&insn->alts)) {
3785			struct alternative *alt;
3786			bool skip_orig = false;
3787
3788			list_for_each_entry(alt, &insn->alts, list) {
3789				if (alt->skip_orig)
3790					skip_orig = true;
3791
3792				ret = validate_entry(file, alt->insn);
3793				if (ret) {
3794				        if (opts.backtrace)
3795						BT_FUNC("(alt)", insn);
3796					return ret;
3797				}
3798			}
3799
3800			if (skip_orig)
3801				return 0;
3802		}
3803
3804		switch (insn->type) {
3805
3806		case INSN_CALL_DYNAMIC:
3807		case INSN_JUMP_DYNAMIC:
3808		case INSN_JUMP_DYNAMIC_CONDITIONAL:
3809			WARN_FUNC("early indirect call", insn->sec, insn->offset);
3810			return 1;
3811
3812		case INSN_JUMP_UNCONDITIONAL:
3813		case INSN_JUMP_CONDITIONAL:
3814			if (!is_sibling_call(insn)) {
3815				if (!insn->jump_dest) {
3816					WARN_FUNC("unresolved jump target after linking?!?",
3817						  insn->sec, insn->offset);
3818					return -1;
3819				}
3820				ret = validate_entry(file, insn->jump_dest);
3821				if (ret) {
3822					if (opts.backtrace) {
3823						BT_FUNC("(branch%s)", insn,
3824							insn->type == INSN_JUMP_CONDITIONAL ? "-cond" : "");
3825					}
3826					return ret;
3827				}
3828
3829				if (insn->type == INSN_JUMP_UNCONDITIONAL)
3830					return 0;
3831
3832				break;
3833			}
3834
3835			/* fallthrough */
3836		case INSN_CALL:
3837			dest = find_insn(file, insn->call_dest->sec,
3838					 insn->call_dest->offset);
3839			if (!dest) {
3840				WARN("Unresolved function after linking!?: %s",
3841				     insn->call_dest->name);
3842				return -1;
3843			}
3844
3845			ret = validate_entry(file, dest);
3846			if (ret) {
3847				if (opts.backtrace)
3848					BT_FUNC("(call)", insn);
3849				return ret;
3850			}
3851			/*
3852			 * If a call returns without error, it must have seen UNTRAIN_RET.
3853			 * Therefore any non-error return is a success.
3854			 */
3855			return 0;
3856
3857		case INSN_RETURN:
3858			WARN_FUNC("RET before UNTRAIN", insn->sec, insn->offset);
3859			return 1;
3860
3861		case INSN_NOP:
3862			if (insn->retpoline_safe)
3863				return 0;
3864			break;
3865
3866		default:
3867			break;
3868		}
3869
3870		if (!next) {
3871			WARN_FUNC("teh end!", insn->sec, insn->offset);
3872			return -1;
3873		}
3874		insn = next;
3875	}
3876
3877	return warnings;
3878}
3879
3880/*
3881 * Validate that all branches starting at 'insn->entry' encounter UNRET_END
3882 * before RET.
3883 */
3884static int validate_unret(struct objtool_file *file)
3885{
3886	struct instruction *insn;
3887	int ret, warnings = 0;
3888
3889	for_each_insn(file, insn) {
3890		if (!insn->entry)
3891			continue;
3892
3893		ret = validate_entry(file, insn);
3894		if (ret < 0) {
3895			WARN_FUNC("Failed UNRET validation", insn->sec, insn->offset);
3896			return ret;
3897		}
3898		warnings += ret;
3899	}
3900
3901	return warnings;
3902}
3903
3904static int validate_retpoline(struct objtool_file *file)
3905{
3906	struct instruction *insn;
3907	int warnings = 0;
3908
3909	for_each_insn(file, insn) {
3910		if (insn->type != INSN_JUMP_DYNAMIC &&
3911		    insn->type != INSN_CALL_DYNAMIC &&
3912		    insn->type != INSN_RETURN)
3913			continue;
3914
3915		if (insn->retpoline_safe)
3916			continue;
3917
3918		if (insn->sec->init)
3919			continue;
3920
3921		if (insn->type == INSN_RETURN) {
3922			if (opts.rethunk) {
3923				WARN_FUNC("'naked' return found in RETHUNK build",
3924					  insn->sec, insn->offset);
3925			} else
3926				continue;
3927		} else {
3928			WARN_FUNC("indirect %s found in RETPOLINE build",
3929				  insn->sec, insn->offset,
3930				  insn->type == INSN_JUMP_DYNAMIC ? "jump" : "call");
3931		}
3932
3933		warnings++;
3934	}
3935
3936	return warnings;
3937}
3938
3939static bool is_kasan_insn(struct instruction *insn)
3940{
3941	return (insn->type == INSN_CALL &&
3942		!strcmp(insn->call_dest->name, "__asan_handle_no_return"));
3943}
3944
3945static bool is_ubsan_insn(struct instruction *insn)
3946{
3947	return (insn->type == INSN_CALL &&
3948		!strcmp(insn->call_dest->name,
3949			"__ubsan_handle_builtin_unreachable"));
3950}
3951
3952static bool ignore_unreachable_insn(struct objtool_file *file, struct instruction *insn)
3953{
3954	int i;
3955	struct instruction *prev_insn;
3956
3957	if (insn->ignore || insn->type == INSN_NOP || insn->type == INSN_TRAP)
3958		return true;
3959
3960	/*
3961	 * Ignore alternative replacement instructions.  This can happen
3962	 * when a whitelisted function uses one of the ALTERNATIVE macros.
3963	 */
3964	if (!strcmp(insn->sec->name, ".altinstr_replacement") ||
3965	    !strcmp(insn->sec->name, ".altinstr_aux"))
3966		return true;
3967
3968	/*
3969	 * Whole archive runs might encounter dead code from weak symbols.
3970	 * This is where the linker will have dropped the weak symbol in
3971	 * favour of a regular symbol, but leaves the code in place.
3972	 *
3973	 * In this case we'll find a piece of code (whole function) that is not
3974	 * covered by a !section symbol. Ignore them.
3975	 */
3976	if (opts.link && !insn_func(insn)) {
3977		int size = find_symbol_hole_containing(insn->sec, insn->offset);
3978		unsigned long end = insn->offset + size;
3979
3980		if (!size) /* not a hole */
3981			return false;
3982
3983		if (size < 0) /* hole until the end */
3984			return true;
3985
3986		sec_for_each_insn_continue(file, insn) {
3987			/*
3988			 * If we reach a visited instruction at or before the
3989			 * end of the hole, ignore the unreachable.
3990			 */
3991			if (insn->visited)
3992				return true;
3993
3994			if (insn->offset >= end)
3995				break;
3996
3997			/*
3998			 * If this hole jumps to a .cold function, mark it ignore too.
3999			 */
4000			if (insn->jump_dest && insn_func(insn->jump_dest) &&
4001			    strstr(insn_func(insn->jump_dest)->name, ".cold")) {
4002				struct instruction *dest = insn->jump_dest;
4003				func_for_each_insn(file, insn_func(dest), dest)
4004					dest->ignore = true;
4005			}
4006		}
4007
4008		return false;
4009	}
4010
4011	if (!insn_func(insn))
4012		return false;
4013
4014	if (insn_func(insn)->static_call_tramp)
4015		return true;
4016
4017	/*
4018	 * CONFIG_UBSAN_TRAP inserts a UD2 when it sees
4019	 * __builtin_unreachable().  The BUG() macro has an unreachable() after
4020	 * the UD2, which causes GCC's undefined trap logic to emit another UD2
4021	 * (or occasionally a JMP to UD2).
4022	 *
4023	 * It may also insert a UD2 after calling a __noreturn function.
4024	 */
4025	prev_insn = list_prev_entry(insn, list);
4026	if ((prev_insn->dead_end || dead_end_function(file, prev_insn->call_dest)) &&
4027	    (insn->type == INSN_BUG ||
4028	     (insn->type == INSN_JUMP_UNCONDITIONAL &&
4029	      insn->jump_dest && insn->jump_dest->type == INSN_BUG)))
4030		return true;
4031
4032	/*
4033	 * Check if this (or a subsequent) instruction is related to
4034	 * CONFIG_UBSAN or CONFIG_KASAN.
4035	 *
4036	 * End the search at 5 instructions to avoid going into the weeds.
4037	 */
4038	for (i = 0; i < 5; i++) {
4039
4040		if (is_kasan_insn(insn) || is_ubsan_insn(insn))
4041			return true;
4042
4043		if (insn->type == INSN_JUMP_UNCONDITIONAL) {
4044			if (insn->jump_dest &&
4045			    insn_func(insn->jump_dest) == insn_func(insn)) {
4046				insn = insn->jump_dest;
4047				continue;
4048			}
4049
4050			break;
4051		}
4052
4053		if (insn->offset + insn->len >= insn_func(insn)->offset + insn_func(insn)->len)
4054			break;
4055
4056		insn = list_next_entry(insn, list);
4057	}
4058
4059	return false;
4060}
4061
4062static int add_prefix_symbol(struct objtool_file *file, struct symbol *func,
4063			     struct instruction *insn)
4064{
4065	if (!opts.prefix)
4066		return 0;
4067
4068	for (;;) {
4069		struct instruction *prev = list_prev_entry(insn, list);
4070		u64 offset;
4071
4072		if (&prev->list == &file->insn_list)
4073			break;
 
 
4074
4075		if (prev->type != INSN_NOP)
4076			break;
4077
4078		offset = func->offset - prev->offset;
4079		if (offset >= opts.prefix) {
4080			if (offset == opts.prefix) {
4081				/*
4082				 * Since the sec->symbol_list is ordered by
4083				 * offset (see elf_add_symbol()) the added
4084				 * symbol will not be seen by the iteration in
4085				 * validate_section().
4086				 *
4087				 * Hence the lack of list_for_each_entry_safe()
4088				 * there.
4089				 *
4090				 * The direct concequence is that prefix symbols
4091				 * don't get visited (because pointless), except
4092				 * for the logic in ignore_unreachable_insn()
4093				 * that needs the terminating insn to be visited
4094				 * otherwise it will report the hole.
4095				 *
4096				 * Hence mark the first instruction of the
4097				 * prefix symbol as visisted.
4098				 */
4099				prev->visited |= VISITED_BRANCH;
4100				elf_create_prefix_symbol(file->elf, func, opts.prefix);
4101			}
4102			break;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
4103		}
4104		insn = prev;
4105	}
4106
4107	return 0;
4108}
4109
4110static int validate_symbol(struct objtool_file *file, struct section *sec,
4111			   struct symbol *sym, struct insn_state *state)
4112{
4113	struct instruction *insn;
4114	int ret;
4115
4116	if (!sym->len) {
4117		WARN("%s() is missing an ELF size annotation", sym->name);
4118		return 1;
4119	}
4120
4121	if (sym->pfunc != sym || sym->alias != sym)
4122		return 0;
4123
4124	insn = find_insn(file, sec, sym->offset);
4125	if (!insn || insn->ignore || insn->visited)
4126		return 0;
4127
4128	add_prefix_symbol(file, sym, insn);
4129
4130	state->uaccess = sym->uaccess_safe;
4131
4132	ret = validate_branch(file, insn_func(insn), insn, *state);
4133	if (ret && opts.backtrace)
4134		BT_FUNC("<=== (sym)", insn);
4135	return ret;
4136}
4137
4138static int validate_section(struct objtool_file *file, struct section *sec)
4139{
4140	struct insn_state state;
4141	struct symbol *func;
4142	int warnings = 0;
4143
4144	list_for_each_entry(func, &sec->symbol_list, list) {
4145		if (func->type != STT_FUNC)
4146			continue;
4147
4148		init_insn_state(file, &state, sec);
4149		set_func_state(&state.cfi);
4150
4151		warnings += validate_symbol(file, sec, func, &state);
4152	}
4153
4154	return warnings;
4155}
4156
4157static int validate_noinstr_sections(struct objtool_file *file)
4158{
4159	struct section *sec;
4160	int warnings = 0;
4161
4162	sec = find_section_by_name(file->elf, ".noinstr.text");
4163	if (sec) {
4164		warnings += validate_section(file, sec);
4165		warnings += validate_unwind_hints(file, sec);
4166	}
4167
4168	sec = find_section_by_name(file->elf, ".entry.text");
4169	if (sec) {
4170		warnings += validate_section(file, sec);
4171		warnings += validate_unwind_hints(file, sec);
4172	}
4173
 
 
 
 
 
 
4174	return warnings;
4175}
4176
4177static int validate_functions(struct objtool_file *file)
4178{
4179	struct section *sec;
4180	int warnings = 0;
4181
4182	for_each_sec(file, sec) {
4183		if (!(sec->sh.sh_flags & SHF_EXECINSTR))
4184			continue;
4185
4186		warnings += validate_section(file, sec);
4187	}
4188
4189	return warnings;
4190}
4191
4192static void mark_endbr_used(struct instruction *insn)
4193{
4194	if (!list_empty(&insn->call_node))
4195		list_del_init(&insn->call_node);
4196}
4197
4198static bool noendbr_range(struct objtool_file *file, struct instruction *insn)
4199{
4200	struct symbol *sym = find_symbol_containing(insn->sec, insn->offset-1);
4201	struct instruction *first;
4202
4203	if (!sym)
4204		return false;
4205
4206	first = find_insn(file, sym->sec, sym->offset);
4207	if (!first)
4208		return false;
4209
4210	if (first->type != INSN_ENDBR && !first->noendbr)
4211		return false;
4212
4213	return insn->offset == sym->offset + sym->len;
4214}
4215
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
4216static int validate_ibt_insn(struct objtool_file *file, struct instruction *insn)
4217{
4218	struct instruction *dest;
4219	struct reloc *reloc;
4220	unsigned long off;
4221	int warnings = 0;
4222
4223	/*
4224	 * Looking for function pointer load relocations.  Ignore
4225	 * direct/indirect branches:
4226	 */
4227	switch (insn->type) {
 
4228	case INSN_CALL:
4229	case INSN_CALL_DYNAMIC:
4230	case INSN_JUMP_CONDITIONAL:
4231	case INSN_JUMP_UNCONDITIONAL:
4232	case INSN_JUMP_DYNAMIC:
4233	case INSN_JUMP_DYNAMIC_CONDITIONAL:
4234	case INSN_RETURN:
4235	case INSN_NOP:
4236		return 0;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
4237	default:
4238		break;
4239	}
4240
4241	for (reloc = insn_reloc(file, insn);
4242	     reloc;
4243	     reloc = find_reloc_by_dest_range(file->elf, insn->sec,
4244					      reloc->offset + 1,
4245					      (insn->offset + insn->len) - (reloc->offset + 1))) {
4246
4247		/*
4248		 * static_call_update() references the trampoline, which
4249		 * doesn't have (or need) ENDBR.  Skip warning in that case.
4250		 */
4251		if (reloc->sym->static_call_tramp)
4252			continue;
4253
4254		off = reloc->sym->offset;
4255		if (reloc->type == R_X86_64_PC32 || reloc->type == R_X86_64_PLT32)
4256			off += arch_dest_reloc_offset(reloc->addend);
 
4257		else
4258			off += reloc->addend;
4259
4260		dest = find_insn(file, reloc->sym->sec, off);
4261		if (!dest)
4262			continue;
4263
4264		if (dest->type == INSN_ENDBR) {
4265			mark_endbr_used(dest);
4266			continue;
4267		}
4268
4269		if (insn_func(dest) && insn_func(dest) == insn_func(insn)) {
4270			/*
4271			 * Anything from->to self is either _THIS_IP_ or
4272			 * IRET-to-self.
4273			 *
4274			 * There is no sane way to annotate _THIS_IP_ since the
4275			 * compiler treats the relocation as a constant and is
4276			 * happy to fold in offsets, skewing any annotation we
4277			 * do, leading to vast amounts of false-positives.
4278			 *
4279			 * There's also compiler generated _THIS_IP_ through
4280			 * KCOV and such which we have no hope of annotating.
4281			 *
4282			 * As such, blanket accept self-references without
4283			 * issue.
4284			 */
4285			continue;
4286		}
4287
4288		/*
4289		 * Accept anything ANNOTATE_NOENDBR.
4290		 */
4291		if (dest->noendbr)
4292			continue;
4293
4294		/*
4295		 * Accept if this is the instruction after a symbol
4296		 * that is (no)endbr -- typical code-range usage.
4297		 */
4298		if (noendbr_range(file, dest))
4299			continue;
4300
4301		WARN_FUNC("relocation to !ENDBR: %s",
4302			  insn->sec, insn->offset,
4303			  offstr(dest->sec, dest->offset));
4304
4305		warnings++;
4306	}
4307
4308	return warnings;
4309}
4310
4311static int validate_ibt_data_reloc(struct objtool_file *file,
4312				   struct reloc *reloc)
4313{
4314	struct instruction *dest;
4315
4316	dest = find_insn(file, reloc->sym->sec,
4317			 reloc->sym->offset + reloc->addend);
4318	if (!dest)
4319		return 0;
4320
4321	if (dest->type == INSN_ENDBR) {
4322		mark_endbr_used(dest);
4323		return 0;
4324	}
4325
4326	if (dest->noendbr)
4327		return 0;
4328
4329	WARN_FUNC("data relocation to !ENDBR: %s",
4330		  reloc->sec->base, reloc->offset,
4331		  offstr(dest->sec, dest->offset));
4332
4333	return 1;
4334}
4335
4336/*
4337 * Validate IBT rules and remove used ENDBR instructions from the seal list.
4338 * Unused ENDBR instructions will be annotated for sealing (i.e., replaced with
4339 * NOPs) later, in create_ibt_endbr_seal_sections().
4340 */
4341static int validate_ibt(struct objtool_file *file)
4342{
4343	struct section *sec;
4344	struct reloc *reloc;
4345	struct instruction *insn;
4346	int warnings = 0;
4347
4348	for_each_insn(file, insn)
4349		warnings += validate_ibt_insn(file, insn);
4350
4351	for_each_sec(file, sec) {
4352
4353		/* Already done by validate_ibt_insn() */
4354		if (sec->sh.sh_flags & SHF_EXECINSTR)
4355			continue;
4356
4357		if (!sec->reloc)
4358			continue;
4359
4360		/*
4361		 * These sections can reference text addresses, but not with
4362		 * the intent to indirect branch to them.
4363		 */
4364		if ((!strncmp(sec->name, ".discard", 8) &&
4365		     strcmp(sec->name, ".discard.ibt_endbr_noseal"))	||
4366		    !strncmp(sec->name, ".debug", 6)			||
4367		    !strcmp(sec->name, ".altinstructions")		||
4368		    !strcmp(sec->name, ".ibt_endbr_seal")		||
4369		    !strcmp(sec->name, ".orc_unwind_ip")		||
4370		    !strcmp(sec->name, ".parainstructions")		||
4371		    !strcmp(sec->name, ".retpoline_sites")		||
4372		    !strcmp(sec->name, ".smp_locks")			||
4373		    !strcmp(sec->name, ".static_call_sites")		||
4374		    !strcmp(sec->name, "_error_injection_whitelist")	||
4375		    !strcmp(sec->name, "_kprobe_blacklist")		||
4376		    !strcmp(sec->name, "__bug_table")			||
4377		    !strcmp(sec->name, "__ex_table")			||
4378		    !strcmp(sec->name, "__jump_table")			||
4379		    !strcmp(sec->name, "__mcount_loc")			||
4380		    !strcmp(sec->name, ".kcfi_traps")			||
 
 
 
4381		    strstr(sec->name, "__patchable_function_entries"))
4382			continue;
4383
4384		list_for_each_entry(reloc, &sec->reloc->reloc_list, list)
4385			warnings += validate_ibt_data_reloc(file, reloc);
4386	}
4387
4388	return warnings;
4389}
4390
4391static int validate_sls(struct objtool_file *file)
4392{
4393	struct instruction *insn, *next_insn;
4394	int warnings = 0;
4395
4396	for_each_insn(file, insn) {
4397		next_insn = next_insn_same_sec(file, insn);
4398
4399		if (insn->retpoline_safe)
4400			continue;
4401
4402		switch (insn->type) {
4403		case INSN_RETURN:
4404			if (!next_insn || next_insn->type != INSN_TRAP) {
4405				WARN_FUNC("missing int3 after ret",
4406					  insn->sec, insn->offset);
4407				warnings++;
4408			}
4409
4410			break;
4411		case INSN_JUMP_DYNAMIC:
4412			if (!next_insn || next_insn->type != INSN_TRAP) {
4413				WARN_FUNC("missing int3 after indirect jump",
4414					  insn->sec, insn->offset);
4415				warnings++;
4416			}
4417			break;
4418		default:
4419			break;
4420		}
4421	}
4422
4423	return warnings;
4424}
4425
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
4426static int validate_reachable_instructions(struct objtool_file *file)
4427{
4428	struct instruction *insn;
 
 
4429
4430	if (file->ignore_unreachables)
4431		return 0;
4432
4433	for_each_insn(file, insn) {
4434		if (insn->visited || ignore_unreachable_insn(file, insn))
4435			continue;
4436
4437		WARN_FUNC("unreachable instruction", insn->sec, insn->offset);
4438		return 1;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
4439	}
4440
 
 
 
4441	return 0;
4442}
4443
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
4444int check(struct objtool_file *file)
4445{
4446	int ret, warnings = 0;
4447
4448	arch_initial_func_cfi_state(&initial_func_cfi);
4449	init_cfi_state(&init_cfi);
4450	init_cfi_state(&func_cfi);
4451	set_func_state(&func_cfi);
 
 
4452
4453	if (!cfi_hash_alloc(1UL << (file->elf->symbol_bits - 3)))
4454		goto out;
4455
4456	cfi_hash_add(&init_cfi);
4457	cfi_hash_add(&func_cfi);
4458
4459	ret = decode_sections(file);
4460	if (ret < 0)
4461		goto out;
4462
4463	warnings += ret;
4464
4465	if (list_empty(&file->insn_list))
4466		goto out;
4467
4468	if (opts.retpoline) {
4469		ret = validate_retpoline(file);
4470		if (ret < 0)
4471			return ret;
4472		warnings += ret;
4473	}
4474
4475	if (opts.stackval || opts.orc || opts.uaccess) {
4476		ret = validate_functions(file);
4477		if (ret < 0)
4478			goto out;
4479		warnings += ret;
4480
4481		ret = validate_unwind_hints(file, NULL);
4482		if (ret < 0)
4483			goto out;
4484		warnings += ret;
4485
4486		if (!warnings) {
4487			ret = validate_reachable_instructions(file);
4488			if (ret < 0)
4489				goto out;
4490			warnings += ret;
4491		}
4492
4493	} else if (opts.noinstr) {
4494		ret = validate_noinstr_sections(file);
4495		if (ret < 0)
4496			goto out;
4497		warnings += ret;
4498	}
4499
4500	if (opts.unret) {
4501		/*
4502		 * Must be after validate_branch() and friends, it plays
4503		 * further games with insn->visited.
4504		 */
4505		ret = validate_unret(file);
4506		if (ret < 0)
4507			return ret;
4508		warnings += ret;
4509	}
4510
4511	if (opts.ibt) {
4512		ret = validate_ibt(file);
4513		if (ret < 0)
4514			goto out;
4515		warnings += ret;
4516	}
4517
4518	if (opts.sls) {
4519		ret = validate_sls(file);
4520		if (ret < 0)
4521			goto out;
4522		warnings += ret;
4523	}
4524
4525	if (opts.static_call) {
4526		ret = create_static_call_sections(file);
4527		if (ret < 0)
4528			goto out;
4529		warnings += ret;
4530	}
4531
4532	if (opts.retpoline) {
4533		ret = create_retpoline_sites_sections(file);
4534		if (ret < 0)
4535			goto out;
4536		warnings += ret;
4537	}
4538
4539	if (opts.cfi) {
4540		ret = create_cfi_sections(file);
4541		if (ret < 0)
4542			goto out;
4543		warnings += ret;
4544	}
4545
4546	if (opts.rethunk) {
4547		ret = create_return_sites_sections(file);
4548		if (ret < 0)
4549			goto out;
4550		warnings += ret;
4551
4552		if (opts.hack_skylake) {
4553			ret = create_direct_call_sections(file);
4554			if (ret < 0)
4555				goto out;
4556			warnings += ret;
4557		}
4558	}
4559
4560	if (opts.mcount) {
4561		ret = create_mcount_loc_sections(file);
4562		if (ret < 0)
4563			goto out;
4564		warnings += ret;
4565	}
4566
 
 
 
 
 
 
 
4567	if (opts.ibt) {
4568		ret = create_ibt_endbr_seal_sections(file);
4569		if (ret < 0)
4570			goto out;
4571		warnings += ret;
4572	}
4573
4574	if (opts.orc && !list_empty(&file->insn_list)) {
4575		ret = orc_create(file);
4576		if (ret < 0)
4577			goto out;
4578		warnings += ret;
4579	}
4580
 
 
 
 
4581
4582	if (opts.stats) {
4583		printf("nr_insns_visited: %ld\n", nr_insns_visited);
4584		printf("nr_cfi: %ld\n", nr_cfi);
4585		printf("nr_cfi_reused: %ld\n", nr_cfi_reused);
4586		printf("nr_cfi_cache: %ld\n", nr_cfi_cache);
4587	}
4588
4589out:
4590	/*
4591	 *  For now, don't fail the kernel build on fatal warnings.  These
4592	 *  errors are still fairly common due to the growing matrix of
4593	 *  supported toolchains and their recent pace of change.
4594	 */
4595	return 0;
4596}
v6.13.7
   1// SPDX-License-Identifier: GPL-2.0-or-later
   2/*
   3 * Copyright (C) 2015-2017 Josh Poimboeuf <jpoimboe@redhat.com>
   4 */
   5
   6#include <string.h>
   7#include <stdlib.h>
   8#include <inttypes.h>
   9#include <sys/mman.h>
  10
 
  11#include <objtool/builtin.h>
  12#include <objtool/cfi.h>
  13#include <objtool/arch.h>
  14#include <objtool/check.h>
  15#include <objtool/special.h>
  16#include <objtool/warn.h>
  17#include <objtool/endianness.h>
  18
  19#include <linux/objtool_types.h>
  20#include <linux/hashtable.h>
  21#include <linux/kernel.h>
  22#include <linux/static_call_types.h>
  23#include <linux/string.h>
  24
  25struct alternative {
  26	struct alternative *next;
  27	struct instruction *insn;
  28	bool skip_orig;
  29};
  30
  31static unsigned long nr_cfi, nr_cfi_reused, nr_cfi_cache;
  32
  33static struct cfi_init_state initial_func_cfi;
  34static struct cfi_state init_cfi;
  35static struct cfi_state func_cfi;
  36static struct cfi_state force_undefined_cfi;
  37
  38struct instruction *find_insn(struct objtool_file *file,
  39			      struct section *sec, unsigned long offset)
  40{
  41	struct instruction *insn;
  42
  43	hash_for_each_possible(file->insn_hash, insn, hash, sec_offset_hash(sec, offset)) {
  44		if (insn->sec == sec && insn->offset == offset)
  45			return insn;
  46	}
  47
  48	return NULL;
  49}
  50
  51struct instruction *next_insn_same_sec(struct objtool_file *file,
  52				       struct instruction *insn)
  53{
  54	if (insn->idx == INSN_CHUNK_MAX)
  55		return find_insn(file, insn->sec, insn->offset + insn->len);
  56
  57	insn++;
  58	if (!insn->len)
  59		return NULL;
  60
  61	return insn;
  62}
  63
  64static struct instruction *next_insn_same_func(struct objtool_file *file,
  65					       struct instruction *insn)
  66{
  67	struct instruction *next = next_insn_same_sec(file, insn);
  68	struct symbol *func = insn_func(insn);
  69
  70	if (!func)
  71		return NULL;
  72
  73	if (next && insn_func(next) == func)
  74		return next;
  75
  76	/* Check if we're already in the subfunction: */
  77	if (func == func->cfunc)
  78		return NULL;
  79
  80	/* Move to the subfunction: */
  81	return find_insn(file, func->cfunc->sec, func->cfunc->offset);
  82}
  83
  84static struct instruction *prev_insn_same_sec(struct objtool_file *file,
  85					      struct instruction *insn)
  86{
  87	if (insn->idx == 0) {
  88		if (insn->prev_len)
  89			return find_insn(file, insn->sec, insn->offset - insn->prev_len);
  90		return NULL;
  91	}
  92
  93	return insn - 1;
  94}
  95
  96static struct instruction *prev_insn_same_sym(struct objtool_file *file,
  97					      struct instruction *insn)
  98{
  99	struct instruction *prev = prev_insn_same_sec(file, insn);
 100
 101	if (prev && insn_func(prev) == insn_func(insn))
 102		return prev;
 103
 104	return NULL;
 105}
 106
 107#define for_each_insn(file, insn)					\
 108	for (struct section *__sec, *__fake = (struct section *)1;	\
 109	     __fake; __fake = NULL)					\
 110		for_each_sec(file, __sec)				\
 111			sec_for_each_insn(file, __sec, insn)
 112
 113#define func_for_each_insn(file, func, insn)				\
 114	for (insn = find_insn(file, func->sec, func->offset);		\
 115	     insn;							\
 116	     insn = next_insn_same_func(file, insn))
 117
 118#define sym_for_each_insn(file, sym, insn)				\
 119	for (insn = find_insn(file, sym->sec, sym->offset);		\
 120	     insn && insn->offset < sym->offset + sym->len;		\
 121	     insn = next_insn_same_sec(file, insn))
 
 
 122
 123#define sym_for_each_insn_continue_reverse(file, sym, insn)		\
 124	for (insn = prev_insn_same_sec(file, insn);			\
 125	     insn && insn->offset >= sym->offset;			\
 126	     insn = prev_insn_same_sec(file, insn))
 
 127
 128#define sec_for_each_insn_from(file, insn)				\
 129	for (; insn; insn = next_insn_same_sec(file, insn))
 130
 131#define sec_for_each_insn_continue(file, insn)				\
 132	for (insn = next_insn_same_sec(file, insn); insn;		\
 133	     insn = next_insn_same_sec(file, insn))
 134
 135static inline struct symbol *insn_call_dest(struct instruction *insn)
 136{
 137	if (insn->type == INSN_JUMP_DYNAMIC ||
 138	    insn->type == INSN_CALL_DYNAMIC)
 139		return NULL;
 140
 141	return insn->_call_dest;
 142}
 143
 144static inline struct reloc *insn_jump_table(struct instruction *insn)
 145{
 146	if (insn->type == INSN_JUMP_DYNAMIC ||
 147	    insn->type == INSN_CALL_DYNAMIC)
 148		return insn->_jump_table;
 149
 150	return NULL;
 151}
 152
 153static bool is_jump_table_jump(struct instruction *insn)
 154{
 155	struct alt_group *alt_group = insn->alt_group;
 156
 157	if (insn_jump_table(insn))
 158		return true;
 159
 160	/* Retpoline alternative for a jump table? */
 161	return alt_group && alt_group->orig_group &&
 162	       insn_jump_table(alt_group->orig_group->first_insn);
 163}
 164
 165static bool is_sibling_call(struct instruction *insn)
 166{
 167	/*
 168	 * Assume only STT_FUNC calls have jump-tables.
 169	 */
 170	if (insn_func(insn)) {
 171		/* An indirect jump is either a sibling call or a jump to a table. */
 172		if (insn->type == INSN_JUMP_DYNAMIC)
 173			return !is_jump_table_jump(insn);
 174	}
 175
 176	/* add_jump_destinations() sets insn_call_dest(insn) for sibling calls. */
 177	return (is_static_jump(insn) && insn_call_dest(insn));
 178}
 179
 180/*
 181 * Checks if a string ends with another.
 182 */
 183static bool str_ends_with(const char *s, const char *sub)
 184{
 185	const int slen = strlen(s);
 186	const int sublen = strlen(sub);
 187
 188	if (sublen > slen)
 189		return 0;
 190
 191	return !memcmp(s + slen - sublen, sub, sublen);
 192}
 193
 194/*
 195 * Checks if a function is a Rust "noreturn" one.
 196 */
 197static bool is_rust_noreturn(const struct symbol *func)
 198{
 199	/*
 200	 * If it does not start with "_R", then it is not a Rust symbol.
 201	 */
 202	if (strncmp(func->name, "_R", 2))
 203		return false;
 204
 205	/*
 206	 * These are just heuristics -- we do not control the precise symbol
 207	 * name, due to the crate disambiguators (which depend on the compiler)
 208	 * as well as changes to the source code itself between versions (since
 209	 * these come from the Rust standard library).
 210	 */
 211	return str_ends_with(func->name, "_4core5sliceSp15copy_from_slice17len_mismatch_fail")		||
 212	       str_ends_with(func->name, "_4core6option13unwrap_failed")				||
 213	       str_ends_with(func->name, "_4core6result13unwrap_failed")				||
 214	       str_ends_with(func->name, "_4core9panicking5panic")					||
 215	       str_ends_with(func->name, "_4core9panicking9panic_fmt")					||
 216	       str_ends_with(func->name, "_4core9panicking14panic_explicit")				||
 217	       str_ends_with(func->name, "_4core9panicking14panic_nounwind")				||
 218	       str_ends_with(func->name, "_4core9panicking18panic_bounds_check")			||
 219	       str_ends_with(func->name, "_4core9panicking19assert_failed_inner")			||
 220	       str_ends_with(func->name, "_4core9panicking36panic_misaligned_pointer_dereference")	||
 221	       strstr(func->name, "_4core9panicking13assert_failed")					||
 222	       strstr(func->name, "_4core9panicking11panic_const24panic_const_")			||
 223	       (strstr(func->name, "_4core5slice5index24slice_") &&
 224		str_ends_with(func->name, "_fail"));
 225}
 226
 227/*
 228 * This checks to see if the given function is a "noreturn" function.
 229 *
 230 * For global functions which are outside the scope of this object file, we
 231 * have to keep a manual list of them.
 232 *
 233 * For local functions, we have to detect them manually by simply looking for
 234 * the lack of a return instruction.
 235 */
 236static bool __dead_end_function(struct objtool_file *file, struct symbol *func,
 237				int recursion)
 238{
 239	int i;
 240	struct instruction *insn;
 241	bool empty = true;
 242
 243#define NORETURN(func) __stringify(func),
 
 
 
 244	static const char * const global_noreturns[] = {
 245#include "noreturns.h"
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 246	};
 247#undef NORETURN
 248
 249	if (!func)
 250		return false;
 251
 252	if (func->bind == STB_GLOBAL || func->bind == STB_WEAK) {
 253		if (is_rust_noreturn(func))
 254			return true;
 255
 
 256		for (i = 0; i < ARRAY_SIZE(global_noreturns); i++)
 257			if (!strcmp(func->name, global_noreturns[i]))
 258				return true;
 259	}
 260
 261	if (func->bind == STB_WEAK)
 262		return false;
 263
 264	if (!func->len)
 265		return false;
 266
 267	insn = find_insn(file, func->sec, func->offset);
 268	if (!insn || !insn_func(insn))
 269		return false;
 270
 271	func_for_each_insn(file, func, insn) {
 272		empty = false;
 273
 274		if (insn->type == INSN_RETURN)
 275			return false;
 276	}
 277
 278	if (empty)
 279		return false;
 280
 281	/*
 282	 * A function can have a sibling call instead of a return.  In that
 283	 * case, the function's dead-end status depends on whether the target
 284	 * of the sibling call returns.
 285	 */
 286	func_for_each_insn(file, func, insn) {
 287		if (is_sibling_call(insn)) {
 288			struct instruction *dest = insn->jump_dest;
 289
 290			if (!dest)
 291				/* sibling call to another file */
 292				return false;
 293
 294			/* local sibling call */
 295			if (recursion == 5) {
 296				/*
 297				 * Infinite recursion: two functions have
 298				 * sibling calls to each other.  This is a very
 299				 * rare case.  It means they aren't dead ends.
 300				 */
 301				return false;
 302			}
 303
 304			return __dead_end_function(file, insn_func(dest), recursion+1);
 305		}
 306	}
 307
 308	return true;
 309}
 310
 311static bool dead_end_function(struct objtool_file *file, struct symbol *func)
 312{
 313	return __dead_end_function(file, func, 0);
 314}
 315
 316static void init_cfi_state(struct cfi_state *cfi)
 317{
 318	int i;
 319
 320	for (i = 0; i < CFI_NUM_REGS; i++) {
 321		cfi->regs[i].base = CFI_UNDEFINED;
 322		cfi->vals[i].base = CFI_UNDEFINED;
 323	}
 324	cfi->cfa.base = CFI_UNDEFINED;
 325	cfi->drap_reg = CFI_UNDEFINED;
 326	cfi->drap_offset = -1;
 327}
 328
 329static void init_insn_state(struct objtool_file *file, struct insn_state *state,
 330			    struct section *sec)
 331{
 332	memset(state, 0, sizeof(*state));
 333	init_cfi_state(&state->cfi);
 334
 335	/*
 336	 * We need the full vmlinux for noinstr validation, otherwise we can
 337	 * not correctly determine insn_call_dest(insn)->sec (external symbols
 338	 * do not have a section).
 339	 */
 340	if (opts.link && opts.noinstr && sec)
 341		state->noinstr = sec->noinstr;
 342}
 343
 344static struct cfi_state *cfi_alloc(void)
 345{
 346	struct cfi_state *cfi = calloc(1, sizeof(struct cfi_state));
 347	if (!cfi) {
 348		WARN("calloc failed");
 349		exit(1);
 350	}
 351	nr_cfi++;
 352	return cfi;
 353}
 354
 355static int cfi_bits;
 356static struct hlist_head *cfi_hash;
 357
 358static inline bool cficmp(struct cfi_state *cfi1, struct cfi_state *cfi2)
 359{
 360	return memcmp((void *)cfi1 + sizeof(cfi1->hash),
 361		      (void *)cfi2 + sizeof(cfi2->hash),
 362		      sizeof(struct cfi_state) - sizeof(struct hlist_node));
 363}
 364
 365static inline u32 cfi_key(struct cfi_state *cfi)
 366{
 367	return jhash((void *)cfi + sizeof(cfi->hash),
 368		     sizeof(*cfi) - sizeof(cfi->hash), 0);
 369}
 370
 371static struct cfi_state *cfi_hash_find_or_add(struct cfi_state *cfi)
 372{
 373	struct hlist_head *head = &cfi_hash[hash_min(cfi_key(cfi), cfi_bits)];
 374	struct cfi_state *obj;
 375
 376	hlist_for_each_entry(obj, head, hash) {
 377		if (!cficmp(cfi, obj)) {
 378			nr_cfi_cache++;
 379			return obj;
 380		}
 381	}
 382
 383	obj = cfi_alloc();
 384	*obj = *cfi;
 385	hlist_add_head(&obj->hash, head);
 386
 387	return obj;
 388}
 389
 390static void cfi_hash_add(struct cfi_state *cfi)
 391{
 392	struct hlist_head *head = &cfi_hash[hash_min(cfi_key(cfi), cfi_bits)];
 393
 394	hlist_add_head(&cfi->hash, head);
 395}
 396
 397static void *cfi_hash_alloc(unsigned long size)
 398{
 399	cfi_bits = max(10, ilog2(size));
 400	cfi_hash = mmap(NULL, sizeof(struct hlist_head) << cfi_bits,
 401			PROT_READ|PROT_WRITE,
 402			MAP_PRIVATE|MAP_ANON, -1, 0);
 403	if (cfi_hash == (void *)-1L) {
 404		WARN("mmap fail cfi_hash");
 405		cfi_hash = NULL;
 406	}  else if (opts.stats) {
 407		printf("cfi_bits: %d\n", cfi_bits);
 408	}
 409
 410	return cfi_hash;
 411}
 412
 413static unsigned long nr_insns;
 414static unsigned long nr_insns_visited;
 415
 416/*
 417 * Call the arch-specific instruction decoder for all the instructions and add
 418 * them to the global instruction list.
 419 */
 420static int decode_instructions(struct objtool_file *file)
 421{
 422	struct section *sec;
 423	struct symbol *func;
 424	unsigned long offset;
 425	struct instruction *insn;
 426	int ret;
 427
 428	for_each_sec(file, sec) {
 429		struct instruction *insns = NULL;
 430		u8 prev_len = 0;
 431		u8 idx = 0;
 432
 433		if (!(sec->sh.sh_flags & SHF_EXECINSTR))
 434			continue;
 435
 436		if (strcmp(sec->name, ".altinstr_replacement") &&
 437		    strcmp(sec->name, ".altinstr_aux") &&
 438		    strncmp(sec->name, ".discard.", 9))
 439			sec->text = true;
 440
 441		if (!strcmp(sec->name, ".noinstr.text") ||
 442		    !strcmp(sec->name, ".entry.text") ||
 443		    !strcmp(sec->name, ".cpuidle.text") ||
 444		    !strncmp(sec->name, ".text..__x86.", 13))
 445			sec->noinstr = true;
 446
 447		/*
 448		 * .init.text code is ran before userspace and thus doesn't
 449		 * strictly need retpolines, except for modules which are
 450		 * loaded late, they very much do need retpoline in their
 451		 * .init.text
 452		 */
 453		if (!strcmp(sec->name, ".init.text") && !opts.module)
 454			sec->init = true;
 455
 456		for (offset = 0; offset < sec->sh.sh_size; offset += insn->len) {
 457			if (!insns || idx == INSN_CHUNK_MAX) {
 458				insns = calloc(sizeof(*insn), INSN_CHUNK_SIZE);
 459				if (!insns) {
 460					WARN("malloc failed");
 461					return -1;
 462				}
 463				idx = 0;
 464			} else {
 465				idx++;
 466			}
 467			insn = &insns[idx];
 468			insn->idx = idx;
 
 
 469
 470			INIT_LIST_HEAD(&insn->call_node);
 471			insn->sec = sec;
 472			insn->offset = offset;
 473			insn->prev_len = prev_len;
 474
 475			ret = arch_decode_instruction(file, sec, offset,
 476						      sec->sh.sh_size - offset,
 477						      insn);
 
 
 478			if (ret)
 479				return ret;
 480
 481			prev_len = insn->len;
 482
 483			/*
 484			 * By default, "ud2" is a dead end unless otherwise
 485			 * annotated, because GCC 7 inserts it for certain
 486			 * divide-by-zero cases.
 487			 */
 488			if (insn->type == INSN_BUG)
 489				insn->dead_end = true;
 490
 491			hash_add(file->insn_hash, &insn->hash, sec_offset_hash(sec, insn->offset));
 
 492			nr_insns++;
 493		}
 494
 495//		printf("%s: last chunk used: %d\n", sec->name, (int)idx);
 496
 497		sec_for_each_sym(sec, func) {
 498			if (func->type != STT_NOTYPE && func->type != STT_FUNC)
 499				continue;
 500
 501			if (func->offset == sec->sh.sh_size) {
 502				/* Heuristic: likely an "end" symbol */
 503				if (func->type == STT_NOTYPE)
 504					continue;
 505				WARN("%s(): STT_FUNC at end of section",
 506				     func->name);
 507				return -1;
 508			}
 509
 510			if (func->embedded_insn || func->alias != func)
 511				continue;
 512
 513			if (!find_insn(file, sec, func->offset)) {
 514				WARN("%s(): can't find starting instruction",
 515				     func->name);
 516				return -1;
 517			}
 518
 519			sym_for_each_insn(file, func, insn) {
 520				insn->sym = func;
 521				if (func->type == STT_FUNC &&
 522				    insn->type == INSN_ENDBR &&
 523				    list_empty(&insn->call_node)) {
 524					if (insn->offset == func->offset) {
 525						list_add_tail(&insn->call_node, &file->endbr_list);
 526						file->nr_endbr++;
 527					} else {
 528						file->nr_endbr_int++;
 529					}
 530				}
 531			}
 532		}
 533	}
 534
 535	if (opts.stats)
 536		printf("nr_insns: %lu\n", nr_insns);
 537
 538	return 0;
 
 
 
 
 539}
 540
 541/*
 542 * Read the pv_ops[] .data table to find the static initialized values.
 543 */
 544static int add_pv_ops(struct objtool_file *file, const char *symname)
 545{
 546	struct symbol *sym, *func;
 547	unsigned long off, end;
 548	struct reloc *reloc;
 549	int idx;
 550
 551	sym = find_symbol_by_name(file->elf, symname);
 552	if (!sym)
 553		return 0;
 554
 555	off = sym->offset;
 556	end = off + sym->len;
 557	for (;;) {
 558		reloc = find_reloc_by_dest_range(file->elf, sym->sec, off, end - off);
 559		if (!reloc)
 560			break;
 561
 562		func = reloc->sym;
 563		if (func->type == STT_SECTION)
 564			func = find_symbol_by_offset(reloc->sym->sec,
 565						     reloc_addend(reloc));
 566
 567		idx = (reloc_offset(reloc) - sym->offset) / sizeof(unsigned long);
 568
 569		objtool_pv_add(file, idx, func);
 570
 571		off = reloc_offset(reloc) + 1;
 572		if (off > end)
 573			break;
 574	}
 575
 576	return 0;
 577}
 578
 579/*
 580 * Allocate and initialize file->pv_ops[].
 581 */
 582static int init_pv_ops(struct objtool_file *file)
 583{
 584	static const char *pv_ops_tables[] = {
 585		"pv_ops",
 586		"xen_cpu_ops",
 587		"xen_irq_ops",
 588		"xen_mmu_ops",
 589		NULL,
 590	};
 591	const char *pv_ops;
 592	struct symbol *sym;
 593	int idx, nr;
 594
 595	if (!opts.noinstr)
 596		return 0;
 597
 598	file->pv_ops = NULL;
 599
 600	sym = find_symbol_by_name(file->elf, "pv_ops");
 601	if (!sym)
 602		return 0;
 603
 604	nr = sym->len / sizeof(unsigned long);
 605	file->pv_ops = calloc(sizeof(struct pv_state), nr);
 606	if (!file->pv_ops)
 607		return -1;
 608
 609	for (idx = 0; idx < nr; idx++)
 610		INIT_LIST_HEAD(&file->pv_ops[idx].targets);
 611
 612	for (idx = 0; (pv_ops = pv_ops_tables[idx]); idx++)
 613		add_pv_ops(file, pv_ops);
 614
 615	return 0;
 616}
 617
 618static struct instruction *find_last_insn(struct objtool_file *file,
 619					  struct section *sec)
 620{
 621	struct instruction *insn = NULL;
 622	unsigned int offset;
 623	unsigned int end = (sec->sh.sh_size > 10) ? sec->sh.sh_size - 10 : 0;
 624
 625	for (offset = sec->sh.sh_size - 1; offset >= end && !insn; offset--)
 626		insn = find_insn(file, sec, offset);
 627
 628	return insn;
 629}
 630
 631/*
 632 * Mark "ud2" instructions and manually annotated dead ends.
 633 */
 634static int add_dead_ends(struct objtool_file *file)
 635{
 636	struct section *rsec;
 637	struct reloc *reloc;
 638	struct instruction *insn;
 639	uint64_t offset;
 640
 641	/*
 642	 * UD2 defaults to being a dead-end, allow them to be annotated for
 643	 * non-fatal, eg WARN.
 644	 */
 645	rsec = find_section_by_name(file->elf, ".rela.discard.reachable");
 646	if (!rsec)
 647		return 0;
 648
 649	for_each_reloc(rsec, reloc) {
 650		if (reloc->sym->type == STT_SECTION) {
 651			offset = reloc_addend(reloc);
 652		} else if (reloc->sym->local_label) {
 653			offset = reloc->sym->offset;
 
 
 
 
 
 
 
 
 
 
 654		} else {
 655			WARN("unexpected relocation symbol type in %s", rsec->name);
 
 656			return -1;
 657		}
 658
 659		insn = find_insn(file, reloc->sym->sec, offset);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 660		if (insn)
 661			insn = prev_insn_same_sec(file, insn);
 662		else if (offset == reloc->sym->sec->sh.sh_size) {
 663			insn = find_last_insn(file, reloc->sym->sec);
 664			if (!insn) {
 665				WARN("can't find reachable insn at %s+0x%" PRIx64,
 666				     reloc->sym->sec->name, offset);
 667				return -1;
 668			}
 669		} else {
 670			WARN("can't find reachable insn at %s+0x%" PRIx64,
 671			     reloc->sym->sec->name, offset);
 672			return -1;
 673		}
 674
 675		insn->dead_end = false;
 676	}
 677
 678	return 0;
 679}
 680
 681static int create_static_call_sections(struct objtool_file *file)
 682{
 
 683	struct static_call_site *site;
 684	struct section *sec;
 685	struct instruction *insn;
 686	struct symbol *key_sym;
 687	char *key_name, *tmp;
 688	int idx;
 689
 690	sec = find_section_by_name(file->elf, ".static_call_sites");
 691	if (sec) {
 692		INIT_LIST_HEAD(&file->static_call_list);
 693		WARN("file already has .static_call_sites section, skipping");
 694		return 0;
 695	}
 696
 697	if (list_empty(&file->static_call_list))
 698		return 0;
 699
 700	idx = 0;
 701	list_for_each_entry(insn, &file->static_call_list, call_node)
 702		idx++;
 703
 704	sec = elf_create_section_pair(file->elf, ".static_call_sites",
 705				      sizeof(*site), idx, idx * 2);
 706	if (!sec)
 707		return -1;
 708
 709	/* Allow modules to modify the low bits of static_call_site::key */
 710	sec->sh.sh_flags |= SHF_WRITE;
 711
 712	idx = 0;
 713	list_for_each_entry(insn, &file->static_call_list, call_node) {
 714
 
 
 
 715		/* populate reloc for 'addr' */
 716		if (!elf_init_reloc_text_sym(file->elf, sec,
 717					     idx * sizeof(*site), idx * 2,
 718					     insn->sec, insn->offset))
 
 719			return -1;
 720
 721		/* find key symbol */
 722		key_name = strdup(insn_call_dest(insn)->name);
 723		if (!key_name) {
 724			perror("strdup");
 725			return -1;
 726		}
 727		if (strncmp(key_name, STATIC_CALL_TRAMP_PREFIX_STR,
 728			    STATIC_CALL_TRAMP_PREFIX_LEN)) {
 729			WARN("static_call: trampoline name malformed: %s", key_name);
 730			free(key_name);
 731			return -1;
 732		}
 733		tmp = key_name + STATIC_CALL_TRAMP_PREFIX_LEN - STATIC_CALL_KEY_PREFIX_LEN;
 734		memcpy(tmp, STATIC_CALL_KEY_PREFIX_STR, STATIC_CALL_KEY_PREFIX_LEN);
 735
 736		key_sym = find_symbol_by_name(file->elf, tmp);
 737		if (!key_sym) {
 738			if (!opts.module) {
 739				WARN("static_call: can't find static_call_key symbol: %s", tmp);
 740				free(key_name);
 741				return -1;
 742			}
 743
 744			/*
 745			 * For modules(), the key might not be exported, which
 746			 * means the module can make static calls but isn't
 747			 * allowed to change them.
 748			 *
 749			 * In that case we temporarily set the key to be the
 750			 * trampoline address.  This is fixed up in
 751			 * static_call_add_module().
 752			 */
 753			key_sym = insn_call_dest(insn);
 754		}
 755		free(key_name);
 756
 757		/* populate reloc for 'key' */
 758		if (!elf_init_reloc_data_sym(file->elf, sec,
 759					     idx * sizeof(*site) + 4,
 760					     (idx * 2) + 1, key_sym,
 761					     is_sibling_call(insn) * STATIC_CALL_SITE_TAIL))
 762			return -1;
 763
 764		idx++;
 765	}
 766
 767	return 0;
 768}
 769
 770static int create_retpoline_sites_sections(struct objtool_file *file)
 771{
 772	struct instruction *insn;
 773	struct section *sec;
 774	int idx;
 775
 776	sec = find_section_by_name(file->elf, ".retpoline_sites");
 777	if (sec) {
 778		WARN("file already has .retpoline_sites, skipping");
 779		return 0;
 780	}
 781
 782	idx = 0;
 783	list_for_each_entry(insn, &file->retpoline_call_list, call_node)
 784		idx++;
 785
 786	if (!idx)
 787		return 0;
 788
 789	sec = elf_create_section_pair(file->elf, ".retpoline_sites",
 790				      sizeof(int), idx, idx);
 791	if (!sec)
 
 792		return -1;
 
 793
 794	idx = 0;
 795	list_for_each_entry(insn, &file->retpoline_call_list, call_node) {
 796
 797		if (!elf_init_reloc_text_sym(file->elf, sec,
 798					     idx * sizeof(int), idx,
 799					     insn->sec, insn->offset))
 
 
 
 
 
 800			return -1;
 
 801
 802		idx++;
 803	}
 804
 805	return 0;
 806}
 807
 808static int create_return_sites_sections(struct objtool_file *file)
 809{
 810	struct instruction *insn;
 811	struct section *sec;
 812	int idx;
 813
 814	sec = find_section_by_name(file->elf, ".return_sites");
 815	if (sec) {
 816		WARN("file already has .return_sites, skipping");
 817		return 0;
 818	}
 819
 820	idx = 0;
 821	list_for_each_entry(insn, &file->return_thunk_list, call_node)
 822		idx++;
 823
 824	if (!idx)
 825		return 0;
 826
 827	sec = elf_create_section_pair(file->elf, ".return_sites",
 828				      sizeof(int), idx, idx);
 829	if (!sec)
 
 830		return -1;
 
 831
 832	idx = 0;
 833	list_for_each_entry(insn, &file->return_thunk_list, call_node) {
 834
 835		if (!elf_init_reloc_text_sym(file->elf, sec,
 836					     idx * sizeof(int), idx,
 837					     insn->sec, insn->offset))
 
 
 
 
 
 838			return -1;
 
 839
 840		idx++;
 841	}
 842
 843	return 0;
 844}
 845
 846static int create_ibt_endbr_seal_sections(struct objtool_file *file)
 847{
 848	struct instruction *insn;
 849	struct section *sec;
 850	int idx;
 851
 852	sec = find_section_by_name(file->elf, ".ibt_endbr_seal");
 853	if (sec) {
 854		WARN("file already has .ibt_endbr_seal, skipping");
 855		return 0;
 856	}
 857
 858	idx = 0;
 859	list_for_each_entry(insn, &file->endbr_list, call_node)
 860		idx++;
 861
 862	if (opts.stats) {
 863		printf("ibt: ENDBR at function start: %d\n", file->nr_endbr);
 864		printf("ibt: ENDBR inside functions:  %d\n", file->nr_endbr_int);
 865		printf("ibt: superfluous ENDBR:       %d\n", idx);
 866	}
 867
 868	if (!idx)
 869		return 0;
 870
 871	sec = elf_create_section_pair(file->elf, ".ibt_endbr_seal",
 872				      sizeof(int), idx, idx);
 873	if (!sec)
 
 874		return -1;
 
 875
 876	idx = 0;
 877	list_for_each_entry(insn, &file->endbr_list, call_node) {
 878
 879		int *site = (int *)sec->data->d_buf + idx;
 880		struct symbol *sym = insn->sym;
 881		*site = 0;
 882
 883		if (opts.module && sym && sym->type == STT_FUNC &&
 884		    insn->offset == sym->offset &&
 885		    (!strcmp(sym->name, "init_module") ||
 886		     !strcmp(sym->name, "cleanup_module")))
 887			WARN("%s(): not an indirect call target", sym->name);
 888
 889		if (!elf_init_reloc_text_sym(file->elf, sec,
 890					     idx * sizeof(int), idx,
 891					     insn->sec, insn->offset))
 892			return -1;
 
 893
 894		idx++;
 895	}
 896
 897	return 0;
 898}
 899
 900static int create_cfi_sections(struct objtool_file *file)
 901{
 902	struct section *sec;
 903	struct symbol *sym;
 
 904	int idx;
 905
 906	sec = find_section_by_name(file->elf, ".cfi_sites");
 907	if (sec) {
 908		INIT_LIST_HEAD(&file->call_list);
 909		WARN("file already has .cfi_sites section, skipping");
 910		return 0;
 911	}
 912
 913	idx = 0;
 914	for_each_sym(file, sym) {
 915		if (sym->type != STT_FUNC)
 916			continue;
 917
 918		if (strncmp(sym->name, "__cfi_", 6))
 919			continue;
 
 
 
 
 920
 921		idx++;
 
 922	}
 923
 924	sec = elf_create_section_pair(file->elf, ".cfi_sites",
 925				      sizeof(unsigned int), idx, idx);
 926	if (!sec)
 927		return -1;
 928
 929	idx = 0;
 930	for_each_sym(file, sym) {
 931		if (sym->type != STT_FUNC)
 932			continue;
 933
 934		if (strncmp(sym->name, "__cfi_", 6))
 935			continue;
 
 
 
 
 
 
 
 936
 937		if (!elf_init_reloc_text_sym(file->elf, sec,
 938					     idx * sizeof(unsigned int), idx,
 939					     sym->sec, sym->offset))
 940			return -1;
 
 941
 942		idx++;
 
 943	}
 944
 945	return 0;
 946}
 947
 948static int create_mcount_loc_sections(struct objtool_file *file)
 949{
 950	size_t addr_size = elf_addr_size(file->elf);
 951	struct instruction *insn;
 952	struct section *sec;
 953	int idx;
 954
 955	sec = find_section_by_name(file->elf, "__mcount_loc");
 956	if (sec) {
 957		INIT_LIST_HEAD(&file->mcount_loc_list);
 958		WARN("file already has __mcount_loc section, skipping");
 959		return 0;
 960	}
 961
 962	if (list_empty(&file->mcount_loc_list))
 963		return 0;
 964
 965	idx = 0;
 966	list_for_each_entry(insn, &file->mcount_loc_list, call_node)
 967		idx++;
 968
 969	sec = elf_create_section_pair(file->elf, "__mcount_loc", addr_size,
 970				      idx, idx);
 971	if (!sec)
 972		return -1;
 973
 974	sec->sh.sh_addralign = addr_size;
 975
 976	idx = 0;
 977	list_for_each_entry(insn, &file->mcount_loc_list, call_node) {
 
 978
 979		struct reloc *reloc;
 
 980
 981		reloc = elf_init_reloc_text_sym(file->elf, sec, idx * addr_size, idx,
 982					       insn->sec, insn->offset);
 983		if (!reloc)
 984			return -1;
 985
 986		set_reloc_type(file->elf, reloc, addr_size == 8 ? R_ABS64 : R_ABS32);
 987
 988		idx++;
 989	}
 990
 991	return 0;
 992}
 993
 994static int create_direct_call_sections(struct objtool_file *file)
 995{
 996	struct instruction *insn;
 997	struct section *sec;
 
 998	int idx;
 999
1000	sec = find_section_by_name(file->elf, ".call_sites");
1001	if (sec) {
1002		INIT_LIST_HEAD(&file->call_list);
1003		WARN("file already has .call_sites section, skipping");
1004		return 0;
1005	}
1006
1007	if (list_empty(&file->call_list))
1008		return 0;
1009
1010	idx = 0;
1011	list_for_each_entry(insn, &file->call_list, call_node)
1012		idx++;
1013
1014	sec = elf_create_section_pair(file->elf, ".call_sites",
1015				      sizeof(unsigned int), idx, idx);
1016	if (!sec)
1017		return -1;
1018
1019	idx = 0;
1020	list_for_each_entry(insn, &file->call_list, call_node) {
1021
1022		if (!elf_init_reloc_text_sym(file->elf, sec,
1023					     idx * sizeof(unsigned int), idx,
1024					     insn->sec, insn->offset))
 
 
 
 
1025			return -1;
1026
1027		idx++;
1028	}
1029
1030	return 0;
1031}
1032
1033/*
1034 * Warnings shouldn't be reported for ignored functions.
1035 */
1036static void add_ignores(struct objtool_file *file)
1037{
1038	struct instruction *insn;
1039	struct section *rsec;
1040	struct symbol *func;
1041	struct reloc *reloc;
1042
1043	rsec = find_section_by_name(file->elf, ".rela.discard.func_stack_frame_non_standard");
1044	if (!rsec)
1045		return;
1046
1047	for_each_reloc(rsec, reloc) {
1048		switch (reloc->sym->type) {
1049		case STT_FUNC:
1050			func = reloc->sym;
1051			break;
1052
1053		case STT_SECTION:
1054			func = find_func_by_offset(reloc->sym->sec, reloc_addend(reloc));
1055			if (!func)
1056				continue;
1057			break;
1058
1059		default:
1060			WARN("unexpected relocation symbol type in %s: %d",
1061			     rsec->name, reloc->sym->type);
1062			continue;
1063		}
1064
1065		func_for_each_insn(file, func, insn)
1066			insn->ignore = true;
1067	}
1068}
1069
1070/*
1071 * This is a whitelist of functions that is allowed to be called with AC set.
1072 * The list is meant to be minimal and only contains compiler instrumentation
1073 * ABI and a few functions used to implement *_{to,from}_user() functions.
1074 *
1075 * These functions must not directly change AC, but may PUSHF/POPF.
1076 */
1077static const char *uaccess_safe_builtin[] = {
1078	/* KASAN */
1079	"kasan_report",
1080	"kasan_check_range",
1081	/* KASAN out-of-line */
1082	"__asan_loadN_noabort",
1083	"__asan_load1_noabort",
1084	"__asan_load2_noabort",
1085	"__asan_load4_noabort",
1086	"__asan_load8_noabort",
1087	"__asan_load16_noabort",
1088	"__asan_storeN_noabort",
1089	"__asan_store1_noabort",
1090	"__asan_store2_noabort",
1091	"__asan_store4_noabort",
1092	"__asan_store8_noabort",
1093	"__asan_store16_noabort",
1094	"__kasan_check_read",
1095	"__kasan_check_write",
1096	/* KASAN in-line */
1097	"__asan_report_load_n_noabort",
1098	"__asan_report_load1_noabort",
1099	"__asan_report_load2_noabort",
1100	"__asan_report_load4_noabort",
1101	"__asan_report_load8_noabort",
1102	"__asan_report_load16_noabort",
1103	"__asan_report_store_n_noabort",
1104	"__asan_report_store1_noabort",
1105	"__asan_report_store2_noabort",
1106	"__asan_report_store4_noabort",
1107	"__asan_report_store8_noabort",
1108	"__asan_report_store16_noabort",
1109	/* KCSAN */
1110	"__kcsan_check_access",
1111	"__kcsan_mb",
1112	"__kcsan_wmb",
1113	"__kcsan_rmb",
1114	"__kcsan_release",
1115	"kcsan_found_watchpoint",
1116	"kcsan_setup_watchpoint",
1117	"kcsan_check_scoped_accesses",
1118	"kcsan_disable_current",
1119	"kcsan_enable_current_nowarn",
1120	/* KCSAN/TSAN */
1121	"__tsan_func_entry",
1122	"__tsan_func_exit",
1123	"__tsan_read_range",
1124	"__tsan_write_range",
1125	"__tsan_read1",
1126	"__tsan_read2",
1127	"__tsan_read4",
1128	"__tsan_read8",
1129	"__tsan_read16",
1130	"__tsan_write1",
1131	"__tsan_write2",
1132	"__tsan_write4",
1133	"__tsan_write8",
1134	"__tsan_write16",
1135	"__tsan_read_write1",
1136	"__tsan_read_write2",
1137	"__tsan_read_write4",
1138	"__tsan_read_write8",
1139	"__tsan_read_write16",
1140	"__tsan_volatile_read1",
1141	"__tsan_volatile_read2",
1142	"__tsan_volatile_read4",
1143	"__tsan_volatile_read8",
1144	"__tsan_volatile_read16",
1145	"__tsan_volatile_write1",
1146	"__tsan_volatile_write2",
1147	"__tsan_volatile_write4",
1148	"__tsan_volatile_write8",
1149	"__tsan_volatile_write16",
1150	"__tsan_atomic8_load",
1151	"__tsan_atomic16_load",
1152	"__tsan_atomic32_load",
1153	"__tsan_atomic64_load",
1154	"__tsan_atomic8_store",
1155	"__tsan_atomic16_store",
1156	"__tsan_atomic32_store",
1157	"__tsan_atomic64_store",
1158	"__tsan_atomic8_exchange",
1159	"__tsan_atomic16_exchange",
1160	"__tsan_atomic32_exchange",
1161	"__tsan_atomic64_exchange",
1162	"__tsan_atomic8_fetch_add",
1163	"__tsan_atomic16_fetch_add",
1164	"__tsan_atomic32_fetch_add",
1165	"__tsan_atomic64_fetch_add",
1166	"__tsan_atomic8_fetch_sub",
1167	"__tsan_atomic16_fetch_sub",
1168	"__tsan_atomic32_fetch_sub",
1169	"__tsan_atomic64_fetch_sub",
1170	"__tsan_atomic8_fetch_and",
1171	"__tsan_atomic16_fetch_and",
1172	"__tsan_atomic32_fetch_and",
1173	"__tsan_atomic64_fetch_and",
1174	"__tsan_atomic8_fetch_or",
1175	"__tsan_atomic16_fetch_or",
1176	"__tsan_atomic32_fetch_or",
1177	"__tsan_atomic64_fetch_or",
1178	"__tsan_atomic8_fetch_xor",
1179	"__tsan_atomic16_fetch_xor",
1180	"__tsan_atomic32_fetch_xor",
1181	"__tsan_atomic64_fetch_xor",
1182	"__tsan_atomic8_fetch_nand",
1183	"__tsan_atomic16_fetch_nand",
1184	"__tsan_atomic32_fetch_nand",
1185	"__tsan_atomic64_fetch_nand",
1186	"__tsan_atomic8_compare_exchange_strong",
1187	"__tsan_atomic16_compare_exchange_strong",
1188	"__tsan_atomic32_compare_exchange_strong",
1189	"__tsan_atomic64_compare_exchange_strong",
1190	"__tsan_atomic8_compare_exchange_weak",
1191	"__tsan_atomic16_compare_exchange_weak",
1192	"__tsan_atomic32_compare_exchange_weak",
1193	"__tsan_atomic64_compare_exchange_weak",
1194	"__tsan_atomic8_compare_exchange_val",
1195	"__tsan_atomic16_compare_exchange_val",
1196	"__tsan_atomic32_compare_exchange_val",
1197	"__tsan_atomic64_compare_exchange_val",
1198	"__tsan_atomic_thread_fence",
1199	"__tsan_atomic_signal_fence",
1200	"__tsan_unaligned_read16",
1201	"__tsan_unaligned_write16",
1202	/* KCOV */
1203	"write_comp_data",
1204	"check_kcov_mode",
1205	"__sanitizer_cov_trace_pc",
1206	"__sanitizer_cov_trace_const_cmp1",
1207	"__sanitizer_cov_trace_const_cmp2",
1208	"__sanitizer_cov_trace_const_cmp4",
1209	"__sanitizer_cov_trace_const_cmp8",
1210	"__sanitizer_cov_trace_cmp1",
1211	"__sanitizer_cov_trace_cmp2",
1212	"__sanitizer_cov_trace_cmp4",
1213	"__sanitizer_cov_trace_cmp8",
1214	"__sanitizer_cov_trace_switch",
1215	/* KMSAN */
1216	"kmsan_copy_to_user",
1217	"kmsan_disable_current",
1218	"kmsan_enable_current",
1219	"kmsan_report",
1220	"kmsan_unpoison_entry_regs",
1221	"kmsan_unpoison_memory",
1222	"__msan_chain_origin",
1223	"__msan_get_context_state",
1224	"__msan_instrument_asm_store",
1225	"__msan_metadata_ptr_for_load_1",
1226	"__msan_metadata_ptr_for_load_2",
1227	"__msan_metadata_ptr_for_load_4",
1228	"__msan_metadata_ptr_for_load_8",
1229	"__msan_metadata_ptr_for_load_n",
1230	"__msan_metadata_ptr_for_store_1",
1231	"__msan_metadata_ptr_for_store_2",
1232	"__msan_metadata_ptr_for_store_4",
1233	"__msan_metadata_ptr_for_store_8",
1234	"__msan_metadata_ptr_for_store_n",
1235	"__msan_poison_alloca",
1236	"__msan_warning",
1237	/* UBSAN */
1238	"ubsan_type_mismatch_common",
1239	"__ubsan_handle_type_mismatch",
1240	"__ubsan_handle_type_mismatch_v1",
1241	"__ubsan_handle_shift_out_of_bounds",
1242	"__ubsan_handle_load_invalid_value",
1243	/* STACKLEAK */
1244	"stackleak_track_stack",
1245	/* misc */
1246	"csum_partial_copy_generic",
1247	"copy_mc_fragile",
1248	"copy_mc_fragile_handle_tail",
1249	"copy_mc_enhanced_fast_string",
1250	"ftrace_likely_update", /* CONFIG_TRACE_BRANCH_PROFILING */
1251	"rep_stos_alternative",
1252	"rep_movs_alternative",
1253	"__copy_user_nocache",
1254	NULL
1255};
1256
1257static void add_uaccess_safe(struct objtool_file *file)
1258{
1259	struct symbol *func;
1260	const char **name;
1261
1262	if (!opts.uaccess)
1263		return;
1264
1265	for (name = uaccess_safe_builtin; *name; name++) {
1266		func = find_symbol_by_name(file->elf, *name);
1267		if (!func)
1268			continue;
1269
1270		func->uaccess_safe = true;
1271	}
1272}
1273
1274/*
1275 * FIXME: For now, just ignore any alternatives which add retpolines.  This is
1276 * a temporary hack, as it doesn't allow ORC to unwind from inside a retpoline.
1277 * But it at least allows objtool to understand the control flow *around* the
1278 * retpoline.
1279 */
1280static int add_ignore_alternatives(struct objtool_file *file)
1281{
1282	struct section *rsec;
1283	struct reloc *reloc;
1284	struct instruction *insn;
1285
1286	rsec = find_section_by_name(file->elf, ".rela.discard.ignore_alts");
1287	if (!rsec)
1288		return 0;
1289
1290	for_each_reloc(rsec, reloc) {
1291		if (reloc->sym->type != STT_SECTION) {
1292			WARN("unexpected relocation symbol type in %s", rsec->name);
1293			return -1;
1294		}
1295
1296		insn = find_insn(file, reloc->sym->sec, reloc_addend(reloc));
1297		if (!insn) {
1298			WARN("bad .discard.ignore_alts entry");
1299			return -1;
1300		}
1301
1302		insn->ignore_alts = true;
1303	}
1304
1305	return 0;
1306}
1307
1308/*
1309 * Symbols that replace INSN_CALL_DYNAMIC, every (tail) call to such a symbol
1310 * will be added to the .retpoline_sites section.
1311 */
1312__weak bool arch_is_retpoline(struct symbol *sym)
1313{
1314	return false;
1315}
1316
1317/*
1318 * Symbols that replace INSN_RETURN, every (tail) call to such a symbol
1319 * will be added to the .return_sites section.
1320 */
1321__weak bool arch_is_rethunk(struct symbol *sym)
1322{
1323	return false;
1324}
1325
1326/*
1327 * Symbols that are embedded inside other instructions, because sometimes crazy
1328 * code exists. These are mostly ignored for validation purposes.
1329 */
1330__weak bool arch_is_embedded_insn(struct symbol *sym)
1331{
1332	return false;
1333}
1334
1335static struct reloc *insn_reloc(struct objtool_file *file, struct instruction *insn)
1336{
1337	struct reloc *reloc;
1338
1339	if (insn->no_reloc)
1340		return NULL;
1341
1342	if (!file)
1343		return NULL;
 
1344
1345	reloc = find_reloc_by_dest_range(file->elf, insn->sec,
1346					 insn->offset, insn->len);
1347	if (!reloc) {
1348		insn->no_reloc = 1;
1349		return NULL;
 
1350	}
1351
1352	return reloc;
1353}
1354
1355static void remove_insn_ops(struct instruction *insn)
1356{
1357	struct stack_op *op, *next;
1358
1359	for (op = insn->stack_ops; op; op = next) {
1360		next = op->next;
1361		free(op);
1362	}
1363	insn->stack_ops = NULL;
1364}
1365
1366static void annotate_call_site(struct objtool_file *file,
1367			       struct instruction *insn, bool sibling)
1368{
1369	struct reloc *reloc = insn_reloc(file, insn);
1370	struct symbol *sym = insn_call_dest(insn);
1371
1372	if (!sym)
1373		sym = reloc->sym;
1374
1375	/*
1376	 * Alternative replacement code is just template code which is
1377	 * sometimes copied to the original instruction. For now, don't
1378	 * annotate it. (In the future we might consider annotating the
1379	 * original instruction if/when it ever makes sense to do so.)
1380	 */
1381	if (!strcmp(insn->sec->name, ".altinstr_replacement"))
1382		return;
1383
1384	if (sym->static_call_tramp) {
1385		list_add_tail(&insn->call_node, &file->static_call_list);
1386		return;
1387	}
1388
1389	if (sym->retpoline_thunk) {
1390		list_add_tail(&insn->call_node, &file->retpoline_call_list);
1391		return;
1392	}
1393
1394	/*
1395	 * Many compilers cannot disable KCOV or sanitizer calls with a function
1396	 * attribute so they need a little help, NOP out any such calls from
1397	 * noinstr text.
1398	 */
1399	if (opts.hack_noinstr && insn->sec->noinstr && sym->profiling_func) {
1400		if (reloc)
1401			set_reloc_type(file->elf, reloc, R_NONE);
 
 
1402
1403		elf_write_insn(file->elf, insn->sec,
1404			       insn->offset, insn->len,
1405			       sibling ? arch_ret_insn(insn->len)
1406			               : arch_nop_insn(insn->len));
1407
1408		insn->type = sibling ? INSN_RETURN : INSN_NOP;
1409
1410		if (sibling) {
1411			/*
1412			 * We've replaced the tail-call JMP insn by two new
1413			 * insn: RET; INT3, except we only have a single struct
1414			 * insn here. Mark it retpoline_safe to avoid the SLS
1415			 * warning, instead of adding another insn.
1416			 */
1417			insn->retpoline_safe = true;
1418		}
1419
1420		return;
1421	}
1422
1423	if (opts.mcount && sym->fentry) {
1424		if (sibling)
1425			WARN_INSN(insn, "tail call to __fentry__ !?!?");
1426		if (opts.mnop) {
1427			if (reloc)
1428				set_reloc_type(file->elf, reloc, R_NONE);
 
 
1429
1430			elf_write_insn(file->elf, insn->sec,
1431				       insn->offset, insn->len,
1432				       arch_nop_insn(insn->len));
1433
1434			insn->type = INSN_NOP;
1435		}
1436
1437		list_add_tail(&insn->call_node, &file->mcount_loc_list);
1438		return;
1439	}
1440
1441	if (insn->type == INSN_CALL && !insn->sec->init)
1442		list_add_tail(&insn->call_node, &file->call_list);
1443
1444	if (!sibling && dead_end_function(file, sym))
1445		insn->dead_end = true;
1446}
1447
1448static void add_call_dest(struct objtool_file *file, struct instruction *insn,
1449			  struct symbol *dest, bool sibling)
1450{
1451	insn->_call_dest = dest;
1452	if (!dest)
1453		return;
1454
1455	/*
1456	 * Whatever stack impact regular CALLs have, should be undone
1457	 * by the RETURN of the called function.
1458	 *
1459	 * Annotated intra-function calls retain the stack_ops but
1460	 * are converted to JUMP, see read_intra_function_calls().
1461	 */
1462	remove_insn_ops(insn);
1463
1464	annotate_call_site(file, insn, sibling);
1465}
1466
1467static void add_retpoline_call(struct objtool_file *file, struct instruction *insn)
1468{
1469	/*
1470	 * Retpoline calls/jumps are really dynamic calls/jumps in disguise,
1471	 * so convert them accordingly.
1472	 */
1473	switch (insn->type) {
1474	case INSN_CALL:
1475		insn->type = INSN_CALL_DYNAMIC;
1476		break;
1477	case INSN_JUMP_UNCONDITIONAL:
1478		insn->type = INSN_JUMP_DYNAMIC;
1479		break;
1480	case INSN_JUMP_CONDITIONAL:
1481		insn->type = INSN_JUMP_DYNAMIC_CONDITIONAL;
1482		break;
1483	default:
1484		return;
1485	}
1486
1487	insn->retpoline_safe = true;
1488
1489	/*
1490	 * Whatever stack impact regular CALLs have, should be undone
1491	 * by the RETURN of the called function.
1492	 *
1493	 * Annotated intra-function calls retain the stack_ops but
1494	 * are converted to JUMP, see read_intra_function_calls().
1495	 */
1496	remove_insn_ops(insn);
1497
1498	annotate_call_site(file, insn, false);
1499}
1500
1501static void add_return_call(struct objtool_file *file, struct instruction *insn, bool add)
1502{
1503	/*
1504	 * Return thunk tail calls are really just returns in disguise,
1505	 * so convert them accordingly.
1506	 */
1507	insn->type = INSN_RETURN;
1508	insn->retpoline_safe = true;
1509
1510	if (add)
1511		list_add_tail(&insn->call_node, &file->return_thunk_list);
1512}
1513
1514static bool is_first_func_insn(struct objtool_file *file,
1515			       struct instruction *insn, struct symbol *sym)
1516{
1517	if (insn->offset == sym->offset)
1518		return true;
1519
1520	/* Allow direct CALL/JMP past ENDBR */
1521	if (opts.ibt) {
1522		struct instruction *prev = prev_insn_same_sym(file, insn);
1523
1524		if (prev && prev->type == INSN_ENDBR &&
1525		    insn->offset == sym->offset + prev->len)
1526			return true;
1527	}
1528
1529	return false;
1530}
1531
1532/*
1533 * A sibling call is a tail-call to another symbol -- to differentiate from a
1534 * recursive tail-call which is to the same symbol.
1535 */
1536static bool jump_is_sibling_call(struct objtool_file *file,
1537				 struct instruction *from, struct instruction *to)
1538{
1539	struct symbol *fs = from->sym;
1540	struct symbol *ts = to->sym;
1541
1542	/* Not a sibling call if from/to a symbol hole */
1543	if (!fs || !ts)
1544		return false;
1545
1546	/* Not a sibling call if not targeting the start of a symbol. */
1547	if (!is_first_func_insn(file, to, ts))
1548		return false;
1549
1550	/* Disallow sibling calls into STT_NOTYPE */
1551	if (ts->type == STT_NOTYPE)
1552		return false;
1553
1554	/* Must not be self to be a sibling */
1555	return fs->pfunc != ts->pfunc;
1556}
1557
1558/*
1559 * Find the destination instructions for all jumps.
1560 */
1561static int add_jump_destinations(struct objtool_file *file)
1562{
1563	struct instruction *insn, *jump_dest;
1564	struct reloc *reloc;
1565	struct section *dest_sec;
1566	unsigned long dest_off;
1567
1568	for_each_insn(file, insn) {
1569		if (insn->jump_dest) {
1570			/*
1571			 * handle_group_alt() may have previously set
1572			 * 'jump_dest' for some alternatives.
1573			 */
1574			continue;
1575		}
1576		if (!is_static_jump(insn))
1577			continue;
1578
1579		reloc = insn_reloc(file, insn);
1580		if (!reloc) {
1581			dest_sec = insn->sec;
1582			dest_off = arch_jump_destination(insn);
1583		} else if (reloc->sym->type == STT_SECTION) {
1584			dest_sec = reloc->sym->sec;
1585			dest_off = arch_dest_reloc_offset(reloc_addend(reloc));
1586		} else if (reloc->sym->retpoline_thunk) {
1587			add_retpoline_call(file, insn);
1588			continue;
1589		} else if (reloc->sym->return_thunk) {
1590			add_return_call(file, insn, true);
1591			continue;
1592		} else if (insn_func(insn)) {
1593			/*
1594			 * External sibling call or internal sibling call with
1595			 * STT_FUNC reloc.
1596			 */
1597			add_call_dest(file, insn, reloc->sym, true);
1598			continue;
1599		} else if (reloc->sym->sec->idx) {
1600			dest_sec = reloc->sym->sec;
1601			dest_off = reloc->sym->sym.st_value +
1602				   arch_dest_reloc_offset(reloc_addend(reloc));
1603		} else {
1604			/* non-func asm code jumping to another file */
1605			continue;
1606		}
1607
1608		jump_dest = find_insn(file, dest_sec, dest_off);
1609		if (!jump_dest) {
1610			struct symbol *sym = find_symbol_by_offset(dest_sec, dest_off);
1611
1612			/*
1613			 * This is a special case for retbleed_untrain_ret().
1614			 * It jumps to __x86_return_thunk(), but objtool
1615			 * can't find the thunk's starting RET
1616			 * instruction, because the RET is also in the
1617			 * middle of another instruction.  Objtool only
1618			 * knows about the outer instruction.
1619			 */
1620			if (sym && sym->embedded_insn) {
1621				add_return_call(file, insn, false);
1622				continue;
1623			}
1624
1625			WARN_INSN(insn, "can't find jump dest instruction at %s+0x%lx",
1626				  dest_sec->name, dest_off);
 
1627			return -1;
1628		}
1629
1630		/*
1631		 * An intra-TU jump in retpoline.o might not have a relocation
1632		 * for its jump dest, in which case the above
1633		 * add_{retpoline,return}_call() didn't happen.
1634		 */
1635		if (jump_dest->sym && jump_dest->offset == jump_dest->sym->offset) {
1636			if (jump_dest->sym->retpoline_thunk) {
1637				add_retpoline_call(file, insn);
1638				continue;
1639			}
1640			if (jump_dest->sym->return_thunk) {
1641				add_return_call(file, insn, true);
1642				continue;
1643			}
1644		}
1645
1646		/*
1647		 * Cross-function jump.
1648		 */
1649		if (insn_func(insn) && insn_func(jump_dest) &&
1650		    insn_func(insn) != insn_func(jump_dest)) {
1651
1652			/*
1653			 * For GCC 8+, create parent/child links for any cold
1654			 * subfunctions.  This is _mostly_ redundant with a
1655			 * similar initialization in read_symbols().
1656			 *
1657			 * If a function has aliases, we want the *first* such
1658			 * function in the symbol table to be the subfunction's
1659			 * parent.  In that case we overwrite the
1660			 * initialization done in read_symbols().
1661			 *
1662			 * However this code can't completely replace the
1663			 * read_symbols() code because this doesn't detect the
1664			 * case where the parent function's only reference to a
1665			 * subfunction is through a jump table.
1666			 */
1667			if (!strstr(insn_func(insn)->name, ".cold") &&
1668			    strstr(insn_func(jump_dest)->name, ".cold")) {
1669				insn_func(insn)->cfunc = insn_func(jump_dest);
1670				insn_func(jump_dest)->pfunc = insn_func(insn);
1671			}
1672		}
1673
1674		if (jump_is_sibling_call(file, insn, jump_dest)) {
1675			/*
1676			 * Internal sibling call without reloc or with
1677			 * STT_SECTION reloc.
1678			 */
1679			add_call_dest(file, insn, insn_func(jump_dest), true);
1680			continue;
1681		}
1682
1683		insn->jump_dest = jump_dest;
1684	}
1685
1686	return 0;
1687}
1688
1689static struct symbol *find_call_destination(struct section *sec, unsigned long offset)
1690{
1691	struct symbol *call_dest;
1692
1693	call_dest = find_func_by_offset(sec, offset);
1694	if (!call_dest)
1695		call_dest = find_symbol_by_offset(sec, offset);
1696
1697	return call_dest;
1698}
1699
1700/*
1701 * Find the destination instructions for all calls.
1702 */
1703static int add_call_destinations(struct objtool_file *file)
1704{
1705	struct instruction *insn;
1706	unsigned long dest_off;
1707	struct symbol *dest;
1708	struct reloc *reloc;
1709
1710	for_each_insn(file, insn) {
1711		if (insn->type != INSN_CALL)
1712			continue;
1713
1714		reloc = insn_reloc(file, insn);
1715		if (!reloc) {
1716			dest_off = arch_jump_destination(insn);
1717			dest = find_call_destination(insn->sec, dest_off);
1718
1719			add_call_dest(file, insn, dest, false);
1720
1721			if (insn->ignore)
1722				continue;
1723
1724			if (!insn_call_dest(insn)) {
1725				WARN_INSN(insn, "unannotated intra-function call");
1726				return -1;
1727			}
1728
1729			if (insn_func(insn) && insn_call_dest(insn)->type != STT_FUNC) {
1730				WARN_INSN(insn, "unsupported call to non-function");
 
1731				return -1;
1732			}
1733
1734		} else if (reloc->sym->type == STT_SECTION) {
1735			dest_off = arch_dest_reloc_offset(reloc_addend(reloc));
1736			dest = find_call_destination(reloc->sym->sec, dest_off);
1737			if (!dest) {
1738				WARN_INSN(insn, "can't find call dest symbol at %s+0x%lx",
1739					  reloc->sym->sec->name, dest_off);
 
 
1740				return -1;
1741			}
1742
1743			add_call_dest(file, insn, dest, false);
1744
1745		} else if (reloc->sym->retpoline_thunk) {
1746			add_retpoline_call(file, insn);
1747
1748		} else
1749			add_call_dest(file, insn, reloc->sym, false);
1750	}
1751
1752	return 0;
1753}
1754
1755/*
1756 * The .alternatives section requires some extra special care over and above
1757 * other special sections because alternatives are patched in place.
1758 */
1759static int handle_group_alt(struct objtool_file *file,
1760			    struct special_alt *special_alt,
1761			    struct instruction *orig_insn,
1762			    struct instruction **new_insn)
1763{
1764	struct instruction *last_new_insn = NULL, *insn, *nop = NULL;
1765	struct alt_group *orig_alt_group, *new_alt_group;
1766	unsigned long dest_off;
1767
1768	orig_alt_group = orig_insn->alt_group;
 
1769	if (!orig_alt_group) {
1770		struct instruction *last_orig_insn = NULL;
 
 
 
 
 
 
 
 
1771
1772		orig_alt_group = malloc(sizeof(*orig_alt_group));
1773		if (!orig_alt_group) {
1774			WARN("malloc failed");
1775			return -1;
1776		}
1777		orig_alt_group->cfi = calloc(special_alt->orig_len,
1778					     sizeof(struct cfi_state *));
1779		if (!orig_alt_group->cfi) {
1780			WARN("calloc failed");
1781			return -1;
1782		}
1783
1784		insn = orig_insn;
1785		sec_for_each_insn_from(file, insn) {
1786			if (insn->offset >= special_alt->orig_off + special_alt->orig_len)
1787				break;
 
 
1788
1789			insn->alt_group = orig_alt_group;
1790			last_orig_insn = insn;
1791		}
1792		orig_alt_group->orig_group = NULL;
1793		orig_alt_group->first_insn = orig_insn;
1794		orig_alt_group->last_insn = last_orig_insn;
1795		orig_alt_group->nop = NULL;
1796	} else {
1797		if (orig_alt_group->last_insn->offset + orig_alt_group->last_insn->len -
1798		    orig_alt_group->first_insn->offset != special_alt->orig_len) {
1799			WARN_INSN(orig_insn, "weirdly overlapping alternative! %ld != %d",
1800				  orig_alt_group->last_insn->offset +
1801				  orig_alt_group->last_insn->len -
1802				  orig_alt_group->first_insn->offset,
1803				  special_alt->orig_len);
1804			return -1;
1805		}
1806	}
1807
1808	new_alt_group = malloc(sizeof(*new_alt_group));
1809	if (!new_alt_group) {
1810		WARN("malloc failed");
1811		return -1;
1812	}
1813
1814	if (special_alt->new_len < special_alt->orig_len) {
1815		/*
1816		 * Insert a fake nop at the end to make the replacement
1817		 * alt_group the same size as the original.  This is needed to
1818		 * allow propagate_alt_cfi() to do its magic.  When the last
1819		 * instruction affects the stack, the instruction after it (the
1820		 * nop) will propagate the new state to the shared CFI array.
1821		 */
1822		nop = malloc(sizeof(*nop));
1823		if (!nop) {
1824			WARN("malloc failed");
1825			return -1;
1826		}
1827		memset(nop, 0, sizeof(*nop));
 
 
1828
1829		nop->sec = special_alt->new_sec;
1830		nop->offset = special_alt->new_off + special_alt->new_len;
1831		nop->len = special_alt->orig_len - special_alt->new_len;
1832		nop->type = INSN_NOP;
1833		nop->sym = orig_insn->sym;
1834		nop->alt_group = new_alt_group;
1835		nop->ignore = orig_insn->ignore_alts;
1836	}
1837
1838	if (!special_alt->new_len) {
1839		*new_insn = nop;
1840		goto end;
1841	}
1842
1843	insn = *new_insn;
1844	sec_for_each_insn_from(file, insn) {
1845		struct reloc *alt_reloc;
1846
1847		if (insn->offset >= special_alt->new_off + special_alt->new_len)
1848			break;
1849
1850		last_new_insn = insn;
1851
1852		insn->ignore = orig_insn->ignore_alts;
1853		insn->sym = orig_insn->sym;
1854		insn->alt_group = new_alt_group;
1855
1856		/*
1857		 * Since alternative replacement code is copy/pasted by the
1858		 * kernel after applying relocations, generally such code can't
1859		 * have relative-address relocation references to outside the
1860		 * .altinstr_replacement section, unless the arch's
1861		 * alternatives code can adjust the relative offsets
1862		 * accordingly.
1863		 */
1864		alt_reloc = insn_reloc(file, insn);
1865		if (alt_reloc && arch_pc_relative_reloc(alt_reloc) &&
1866		    !arch_support_alt_relocation(special_alt, insn, alt_reloc)) {
1867
1868			WARN_INSN(insn, "unsupported relocation in alternatives section");
 
1869			return -1;
1870		}
1871
1872		if (!is_static_jump(insn))
1873			continue;
1874
1875		if (!insn->immediate)
1876			continue;
1877
1878		dest_off = arch_jump_destination(insn);
1879		if (dest_off == special_alt->new_off + special_alt->new_len) {
1880			insn->jump_dest = next_insn_same_sec(file, orig_alt_group->last_insn);
1881			if (!insn->jump_dest) {
1882				WARN_INSN(insn, "can't find alternative jump destination");
 
1883				return -1;
1884			}
1885		}
1886	}
1887
1888	if (!last_new_insn) {
1889		WARN_FUNC("can't find last new alternative instruction",
1890			  special_alt->new_sec, special_alt->new_off);
1891		return -1;
1892	}
1893
 
 
1894end:
1895	new_alt_group->orig_group = orig_alt_group;
1896	new_alt_group->first_insn = *new_insn;
1897	new_alt_group->last_insn = last_new_insn;
1898	new_alt_group->nop = nop;
1899	new_alt_group->cfi = orig_alt_group->cfi;
1900	return 0;
1901}
1902
1903/*
1904 * A jump table entry can either convert a nop to a jump or a jump to a nop.
1905 * If the original instruction is a jump, make the alt entry an effective nop
1906 * by just skipping the original instruction.
1907 */
1908static int handle_jump_alt(struct objtool_file *file,
1909			   struct special_alt *special_alt,
1910			   struct instruction *orig_insn,
1911			   struct instruction **new_insn)
1912{
1913	if (orig_insn->type != INSN_JUMP_UNCONDITIONAL &&
1914	    orig_insn->type != INSN_NOP) {
1915
1916		WARN_INSN(orig_insn, "unsupported instruction at jump label");
 
1917		return -1;
1918	}
1919
1920	if (opts.hack_jump_label && special_alt->key_addend & 2) {
1921		struct reloc *reloc = insn_reloc(file, orig_insn);
1922
1923		if (reloc)
1924			set_reloc_type(file->elf, reloc, R_NONE);
 
 
1925		elf_write_insn(file->elf, orig_insn->sec,
1926			       orig_insn->offset, orig_insn->len,
1927			       arch_nop_insn(orig_insn->len));
1928		orig_insn->type = INSN_NOP;
1929	}
1930
1931	if (orig_insn->type == INSN_NOP) {
1932		if (orig_insn->len == 2)
1933			file->jl_nop_short++;
1934		else
1935			file->jl_nop_long++;
1936
1937		return 0;
1938	}
1939
1940	if (orig_insn->len == 2)
1941		file->jl_short++;
1942	else
1943		file->jl_long++;
1944
1945	*new_insn = next_insn_same_sec(file, orig_insn);
1946	return 0;
1947}
1948
1949/*
1950 * Read all the special sections which have alternate instructions which can be
1951 * patched in or redirected to at runtime.  Each instruction having alternate
1952 * instruction(s) has them added to its insn->alts list, which will be
1953 * traversed in validate_branch().
1954 */
1955static int add_special_section_alts(struct objtool_file *file)
1956{
1957	struct list_head special_alts;
1958	struct instruction *orig_insn, *new_insn;
1959	struct special_alt *special_alt, *tmp;
1960	struct alternative *alt;
1961	int ret;
1962
1963	ret = special_get_alts(file->elf, &special_alts);
1964	if (ret)
1965		return ret;
1966
1967	list_for_each_entry_safe(special_alt, tmp, &special_alts, list) {
1968
1969		orig_insn = find_insn(file, special_alt->orig_sec,
1970				      special_alt->orig_off);
1971		if (!orig_insn) {
1972			WARN_FUNC("special: can't find orig instruction",
1973				  special_alt->orig_sec, special_alt->orig_off);
1974			ret = -1;
1975			goto out;
1976		}
1977
1978		new_insn = NULL;
1979		if (!special_alt->group || special_alt->new_len) {
1980			new_insn = find_insn(file, special_alt->new_sec,
1981					     special_alt->new_off);
1982			if (!new_insn) {
1983				WARN_FUNC("special: can't find new instruction",
1984					  special_alt->new_sec,
1985					  special_alt->new_off);
1986				ret = -1;
1987				goto out;
1988			}
1989		}
1990
1991		if (special_alt->group) {
1992			if (!special_alt->orig_len) {
1993				WARN_INSN(orig_insn, "empty alternative entry");
 
1994				continue;
1995			}
1996
1997			ret = handle_group_alt(file, special_alt, orig_insn,
1998					       &new_insn);
1999			if (ret)
2000				goto out;
2001		} else if (special_alt->jump_or_nop) {
2002			ret = handle_jump_alt(file, special_alt, orig_insn,
2003					      &new_insn);
2004			if (ret)
2005				goto out;
2006		}
2007
2008		alt = malloc(sizeof(*alt));
2009		if (!alt) {
2010			WARN("malloc failed");
2011			ret = -1;
2012			goto out;
2013		}
2014
2015		alt->insn = new_insn;
2016		alt->skip_orig = special_alt->skip_orig;
2017		orig_insn->ignore_alts |= special_alt->skip_alt;
2018		alt->next = orig_insn->alts;
2019		orig_insn->alts = alt;
2020
2021		list_del(&special_alt->list);
2022		free(special_alt);
2023	}
2024
2025	if (opts.stats) {
2026		printf("jl\\\tNOP\tJMP\n");
2027		printf("short:\t%ld\t%ld\n", file->jl_nop_short, file->jl_short);
2028		printf("long:\t%ld\t%ld\n", file->jl_nop_long, file->jl_long);
2029	}
2030
2031out:
2032	return ret;
2033}
2034
2035static int add_jump_table(struct objtool_file *file, struct instruction *insn,
2036			  struct reloc *next_table)
2037{
 
 
 
2038	struct symbol *pfunc = insn_func(insn)->pfunc;
2039	struct reloc *table = insn_jump_table(insn);
2040	struct instruction *dest_insn;
2041	unsigned int prev_offset = 0;
2042	struct reloc *reloc = table;
2043	struct alternative *alt;
2044
2045	/*
2046	 * Each @reloc is a switch table relocation which points to the target
2047	 * instruction.
2048	 */
2049	for_each_reloc_from(table->sec, reloc) {
2050
2051		/* Check for the end of the table: */
2052		if (reloc != table && reloc == next_table)
2053			break;
2054
2055		/* Make sure the table entries are consecutive: */
2056		if (prev_offset && reloc_offset(reloc) != prev_offset + 8)
2057			break;
2058
2059		/* Detect function pointers from contiguous objects: */
2060		if (reloc->sym->sec == pfunc->sec &&
2061		    reloc_addend(reloc) == pfunc->offset)
2062			break;
2063
2064		dest_insn = find_insn(file, reloc->sym->sec, reloc_addend(reloc));
2065		if (!dest_insn)
2066			break;
2067
2068		/* Make sure the destination is in the same function: */
2069		if (!insn_func(dest_insn) || insn_func(dest_insn)->pfunc != pfunc)
2070			break;
2071
2072		alt = malloc(sizeof(*alt));
2073		if (!alt) {
2074			WARN("malloc failed");
2075			return -1;
2076		}
2077
2078		alt->insn = dest_insn;
2079		alt->next = insn->alts;
2080		insn->alts = alt;
2081		prev_offset = reloc_offset(reloc);
2082	}
2083
2084	if (!prev_offset) {
2085		WARN_INSN(insn, "can't find switch jump table");
 
2086		return -1;
2087	}
2088
2089	return 0;
2090}
2091
2092/*
2093 * find_jump_table() - Given a dynamic jump, find the switch jump table
2094 * associated with it.
2095 */
2096static struct reloc *find_jump_table(struct objtool_file *file,
2097				      struct symbol *func,
2098				      struct instruction *insn)
2099{
2100	struct reloc *table_reloc;
2101	struct instruction *dest_insn, *orig_insn = insn;
2102
2103	/*
2104	 * Backward search using the @first_jump_src links, these help avoid
2105	 * much of the 'in between' code. Which avoids us getting confused by
2106	 * it.
2107	 */
2108	for (;
2109	     insn && insn_func(insn) && insn_func(insn)->pfunc == func;
2110	     insn = insn->first_jump_src ?: prev_insn_same_sym(file, insn)) {
2111
2112		if (insn != orig_insn && insn->type == INSN_JUMP_DYNAMIC)
2113			break;
2114
2115		/* allow small jumps within the range */
2116		if (insn->type == INSN_JUMP_UNCONDITIONAL &&
2117		    insn->jump_dest &&
2118		    (insn->jump_dest->offset <= insn->offset ||
2119		     insn->jump_dest->offset > orig_insn->offset))
2120		    break;
2121
2122		table_reloc = arch_find_switch_table(file, insn);
2123		if (!table_reloc)
2124			continue;
2125		dest_insn = find_insn(file, table_reloc->sym->sec, reloc_addend(table_reloc));
2126		if (!dest_insn || !insn_func(dest_insn) || insn_func(dest_insn)->pfunc != func)
2127			continue;
2128
2129		return table_reloc;
2130	}
2131
2132	return NULL;
2133}
2134
2135/*
2136 * First pass: Mark the head of each jump table so that in the next pass,
2137 * we know when a given jump table ends and the next one starts.
2138 */
2139static void mark_func_jump_tables(struct objtool_file *file,
2140				    struct symbol *func)
2141{
2142	struct instruction *insn, *last = NULL;
2143	struct reloc *reloc;
2144
2145	func_for_each_insn(file, func, insn) {
2146		if (!last)
2147			last = insn;
2148
2149		/*
2150		 * Store back-pointers for unconditional forward jumps such
2151		 * that find_jump_table() can back-track using those and
2152		 * avoid some potentially confusing code.
2153		 */
2154		if (insn->type == INSN_JUMP_UNCONDITIONAL && insn->jump_dest &&
2155		    insn->offset > last->offset &&
2156		    insn->jump_dest->offset > insn->offset &&
2157		    !insn->jump_dest->first_jump_src) {
2158
2159			insn->jump_dest->first_jump_src = insn;
2160			last = insn->jump_dest;
2161		}
2162
2163		if (insn->type != INSN_JUMP_DYNAMIC)
2164			continue;
2165
2166		reloc = find_jump_table(file, func, insn);
2167		if (reloc)
2168			insn->_jump_table = reloc;
 
 
2169	}
2170}
2171
2172static int add_func_jump_tables(struct objtool_file *file,
2173				  struct symbol *func)
2174{
2175	struct instruction *insn, *insn_t1 = NULL, *insn_t2;
2176	int ret = 0;
2177
2178	func_for_each_insn(file, func, insn) {
2179		if (!insn_jump_table(insn))
2180			continue;
2181
2182		if (!insn_t1) {
2183			insn_t1 = insn;
2184			continue;
2185		}
2186
2187		insn_t2 = insn;
2188
2189		ret = add_jump_table(file, insn_t1, insn_jump_table(insn_t2));
2190		if (ret)
2191			return ret;
2192
2193		insn_t1 = insn_t2;
2194	}
2195
2196	if (insn_t1)
2197		ret = add_jump_table(file, insn_t1, NULL);
2198
2199	return ret;
2200}
2201
2202/*
2203 * For some switch statements, gcc generates a jump table in the .rodata
2204 * section which contains a list of addresses within the function to jump to.
2205 * This finds these jump tables and adds them to the insn->alts lists.
2206 */
2207static int add_jump_table_alts(struct objtool_file *file)
2208{
 
2209	struct symbol *func;
2210	int ret;
2211
2212	if (!file->rodata)
2213		return 0;
2214
2215	for_each_sym(file, func) {
2216		if (func->type != STT_FUNC)
2217			continue;
 
2218
2219		mark_func_jump_tables(file, func);
2220		ret = add_func_jump_tables(file, func);
2221		if (ret)
2222			return ret;
 
2223	}
2224
2225	return 0;
2226}
2227
2228static void set_func_state(struct cfi_state *state)
2229{
2230	state->cfa = initial_func_cfi.cfa;
2231	memcpy(&state->regs, &initial_func_cfi.regs,
2232	       CFI_NUM_REGS * sizeof(struct cfi_reg));
2233	state->stack_size = initial_func_cfi.cfa.offset;
2234	state->type = UNWIND_HINT_TYPE_CALL;
2235}
2236
2237static int read_unwind_hints(struct objtool_file *file)
2238{
2239	struct cfi_state cfi = init_cfi;
2240	struct section *sec;
2241	struct unwind_hint *hint;
2242	struct instruction *insn;
2243	struct reloc *reloc;
2244	unsigned long offset;
2245	int i;
2246
2247	sec = find_section_by_name(file->elf, ".discard.unwind_hints");
2248	if (!sec)
2249		return 0;
2250
2251	if (!sec->rsec) {
 
2252		WARN("missing .rela.discard.unwind_hints section");
2253		return -1;
2254	}
2255
2256	if (sec->sh.sh_size % sizeof(struct unwind_hint)) {
2257		WARN("struct unwind_hint size mismatch");
2258		return -1;
2259	}
2260
2261	file->hints = true;
2262
2263	for (i = 0; i < sec->sh.sh_size / sizeof(struct unwind_hint); i++) {
2264		hint = (struct unwind_hint *)sec->data->d_buf + i;
2265
2266		reloc = find_reloc_by_dest(file->elf, sec, i * sizeof(*hint));
2267		if (!reloc) {
2268			WARN("can't find reloc for unwind_hints[%d]", i);
2269			return -1;
2270		}
2271
2272		if (reloc->sym->type == STT_SECTION) {
2273			offset = reloc_addend(reloc);
2274		} else if (reloc->sym->local_label) {
2275			offset = reloc->sym->offset;
2276		} else {
2277			WARN("unexpected relocation symbol type in %s", sec->rsec->name);
2278			return -1;
2279		}
2280
2281		insn = find_insn(file, reloc->sym->sec, offset);
2282		if (!insn) {
2283			WARN("can't find insn for unwind_hints[%d]", i);
2284			return -1;
2285		}
2286
2287		insn->hint = true;
2288
2289		if (hint->type == UNWIND_HINT_TYPE_UNDEFINED) {
2290			insn->cfi = &force_undefined_cfi;
2291			continue;
2292		}
2293
2294		if (hint->type == UNWIND_HINT_TYPE_SAVE) {
2295			insn->hint = false;
2296			insn->save = true;
2297			continue;
2298		}
2299
2300		if (hint->type == UNWIND_HINT_TYPE_RESTORE) {
2301			insn->restore = true;
2302			continue;
2303		}
2304
2305		if (hint->type == UNWIND_HINT_TYPE_REGS_PARTIAL) {
2306			struct symbol *sym = find_symbol_by_offset(insn->sec, insn->offset);
2307
2308			if (sym && sym->bind == STB_GLOBAL) {
2309				if (opts.ibt && insn->type != INSN_ENDBR && !insn->noendbr) {
2310					WARN_INSN(insn, "UNWIND_HINT_IRET_REGS without ENDBR");
 
2311				}
 
 
2312			}
2313		}
2314
 
 
 
 
 
2315		if (hint->type == UNWIND_HINT_TYPE_FUNC) {
2316			insn->cfi = &func_cfi;
2317			continue;
2318		}
2319
2320		if (insn->cfi)
2321			cfi = *(insn->cfi);
2322
2323		if (arch_decode_hint_reg(hint->sp_reg, &cfi.cfa.base)) {
2324			WARN_INSN(insn, "unsupported unwind_hint sp base reg %d", hint->sp_reg);
 
2325			return -1;
2326		}
2327
2328		cfi.cfa.offset = bswap_if_needed(file->elf, hint->sp_offset);
2329		cfi.type = hint->type;
2330		cfi.signal = hint->signal;
2331
2332		insn->cfi = cfi_hash_find_or_add(&cfi);
2333	}
2334
2335	return 0;
2336}
2337
2338static int read_noendbr_hints(struct objtool_file *file)
2339{
 
2340	struct instruction *insn;
2341	struct section *rsec;
2342	struct reloc *reloc;
2343
2344	rsec = find_section_by_name(file->elf, ".rela.discard.noendbr");
2345	if (!rsec)
2346		return 0;
2347
2348	for_each_reloc(rsec, reloc) {
2349		insn = find_insn(file, reloc->sym->sec,
2350				 reloc->sym->offset + reloc_addend(reloc));
2351		if (!insn) {
2352			WARN("bad .discard.noendbr entry");
2353			return -1;
2354		}
2355
2356		insn->noendbr = 1;
2357	}
2358
2359	return 0;
2360}
2361
2362static int read_retpoline_hints(struct objtool_file *file)
2363{
2364	struct section *rsec;
2365	struct instruction *insn;
2366	struct reloc *reloc;
2367
2368	rsec = find_section_by_name(file->elf, ".rela.discard.retpoline_safe");
2369	if (!rsec)
2370		return 0;
2371
2372	for_each_reloc(rsec, reloc) {
2373		if (reloc->sym->type != STT_SECTION) {
2374			WARN("unexpected relocation symbol type in %s", rsec->name);
2375			return -1;
2376		}
2377
2378		insn = find_insn(file, reloc->sym->sec, reloc_addend(reloc));
2379		if (!insn) {
2380			WARN("bad .discard.retpoline_safe entry");
2381			return -1;
2382		}
2383
2384		if (insn->type != INSN_JUMP_DYNAMIC &&
2385		    insn->type != INSN_CALL_DYNAMIC &&
2386		    insn->type != INSN_RETURN &&
2387		    insn->type != INSN_NOP) {
2388			WARN_INSN(insn, "retpoline_safe hint not an indirect jump/call/ret/nop");
 
2389			return -1;
2390		}
2391
2392		insn->retpoline_safe = true;
2393	}
2394
2395	return 0;
2396}
2397
2398static int read_instr_hints(struct objtool_file *file)
2399{
2400	struct section *rsec;
2401	struct instruction *insn;
2402	struct reloc *reloc;
2403
2404	rsec = find_section_by_name(file->elf, ".rela.discard.instr_end");
2405	if (!rsec)
2406		return 0;
2407
2408	for_each_reloc(rsec, reloc) {
2409		if (reloc->sym->type != STT_SECTION) {
2410			WARN("unexpected relocation symbol type in %s", rsec->name);
2411			return -1;
2412		}
2413
2414		insn = find_insn(file, reloc->sym->sec, reloc_addend(reloc));
2415		if (!insn) {
2416			WARN("bad .discard.instr_end entry");
2417			return -1;
2418		}
2419
2420		insn->instr--;
2421	}
2422
2423	rsec = find_section_by_name(file->elf, ".rela.discard.instr_begin");
2424	if (!rsec)
2425		return 0;
2426
2427	for_each_reloc(rsec, reloc) {
2428		if (reloc->sym->type != STT_SECTION) {
2429			WARN("unexpected relocation symbol type in %s", rsec->name);
2430			return -1;
2431		}
2432
2433		insn = find_insn(file, reloc->sym->sec, reloc_addend(reloc));
2434		if (!insn) {
2435			WARN("bad .discard.instr_begin entry");
2436			return -1;
2437		}
2438
2439		insn->instr++;
2440	}
2441
2442	return 0;
2443}
2444
2445static int read_validate_unret_hints(struct objtool_file *file)
2446{
2447	struct section *rsec;
2448	struct instruction *insn;
2449	struct reloc *reloc;
2450
2451	rsec = find_section_by_name(file->elf, ".rela.discard.validate_unret");
2452	if (!rsec)
2453		return 0;
2454
2455	for_each_reloc(rsec, reloc) {
2456		if (reloc->sym->type != STT_SECTION) {
2457			WARN("unexpected relocation symbol type in %s", rsec->name);
2458			return -1;
2459		}
2460
2461		insn = find_insn(file, reloc->sym->sec, reloc_addend(reloc));
2462		if (!insn) {
2463			WARN("bad .discard.instr_end entry");
2464			return -1;
2465		}
2466		insn->unret = 1;
2467	}
2468
2469	return 0;
2470}
2471
2472
2473static int read_intra_function_calls(struct objtool_file *file)
2474{
2475	struct instruction *insn;
2476	struct section *rsec;
2477	struct reloc *reloc;
2478
2479	rsec = find_section_by_name(file->elf, ".rela.discard.intra_function_calls");
2480	if (!rsec)
2481		return 0;
2482
2483	for_each_reloc(rsec, reloc) {
2484		unsigned long dest_off;
2485
2486		if (reloc->sym->type != STT_SECTION) {
2487			WARN("unexpected relocation symbol type in %s",
2488			     rsec->name);
2489			return -1;
2490		}
2491
2492		insn = find_insn(file, reloc->sym->sec, reloc_addend(reloc));
2493		if (!insn) {
2494			WARN("bad .discard.intra_function_call entry");
2495			return -1;
2496		}
2497
2498		if (insn->type != INSN_CALL) {
2499			WARN_INSN(insn, "intra_function_call not a direct call");
 
2500			return -1;
2501		}
2502
2503		/*
2504		 * Treat intra-function CALLs as JMPs, but with a stack_op.
2505		 * See add_call_destinations(), which strips stack_ops from
2506		 * normal CALLs.
2507		 */
2508		insn->type = INSN_JUMP_UNCONDITIONAL;
2509
2510		dest_off = arch_jump_destination(insn);
2511		insn->jump_dest = find_insn(file, insn->sec, dest_off);
2512		if (!insn->jump_dest) {
2513			WARN_INSN(insn, "can't find call dest at %s+0x%lx",
 
2514				  insn->sec->name, dest_off);
2515			return -1;
2516		}
2517	}
2518
2519	return 0;
2520}
2521
2522/*
2523 * Return true if name matches an instrumentation function, where calls to that
2524 * function from noinstr code can safely be removed, but compilers won't do so.
2525 */
2526static bool is_profiling_func(const char *name)
2527{
2528	/*
2529	 * Many compilers cannot disable KCOV with a function attribute.
2530	 */
2531	if (!strncmp(name, "__sanitizer_cov_", 16))
2532		return true;
2533
2534	/*
2535	 * Some compilers currently do not remove __tsan_func_entry/exit nor
2536	 * __tsan_atomic_signal_fence (used for barrier instrumentation) with
2537	 * the __no_sanitize_thread attribute, remove them. Once the kernel's
2538	 * minimum Clang version is 14.0, this can be removed.
2539	 */
2540	if (!strncmp(name, "__tsan_func_", 12) ||
2541	    !strcmp(name, "__tsan_atomic_signal_fence"))
2542		return true;
2543
2544	return false;
2545}
2546
2547static int classify_symbols(struct objtool_file *file)
2548{
 
2549	struct symbol *func;
2550
2551	for_each_sym(file, func) {
2552		if (func->type == STT_NOTYPE && strstarts(func->name, ".L"))
2553			func->local_label = true;
 
2554
2555		if (func->bind != STB_GLOBAL)
2556			continue;
 
2557
2558		if (!strncmp(func->name, STATIC_CALL_TRAMP_PREFIX_STR,
2559			     strlen(STATIC_CALL_TRAMP_PREFIX_STR)))
2560			func->static_call_tramp = true;
2561
2562		if (arch_is_retpoline(func))
2563			func->retpoline_thunk = true;
2564
2565		if (arch_is_rethunk(func))
2566			func->return_thunk = true;
2567
2568		if (arch_is_embedded_insn(func))
2569			func->embedded_insn = true;
2570
2571		if (arch_ftrace_match(func->name))
2572			func->fentry = true;
2573
2574		if (is_profiling_func(func->name))
2575			func->profiling_func = true;
2576	}
2577
2578	return 0;
2579}
2580
2581static void mark_rodata(struct objtool_file *file)
2582{
2583	struct section *sec;
2584	bool found = false;
2585
2586	/*
2587	 * Search for the following rodata sections, each of which can
2588	 * potentially contain jump tables:
2589	 *
2590	 * - .rodata: can contain GCC switch tables
2591	 * - .rodata.<func>: same, if -fdata-sections is being used
2592	 * - .data.rel.ro.c_jump_table: contains C annotated jump tables
2593	 *
2594	 * .rodata.str1.* sections are ignored; they don't contain jump tables.
2595	 */
2596	for_each_sec(file, sec) {
2597		if ((!strncmp(sec->name, ".rodata", 7) &&
2598		     !strstr(sec->name, ".str1.")) ||
2599		    !strncmp(sec->name, ".data.rel.ro", 12)) {
2600			sec->rodata = true;
2601			found = true;
2602		}
2603	}
2604
2605	file->rodata = found;
2606}
2607
2608static int decode_sections(struct objtool_file *file)
2609{
2610	int ret;
2611
2612	mark_rodata(file);
2613
2614	ret = init_pv_ops(file);
2615	if (ret)
2616		return ret;
2617
2618	/*
2619	 * Must be before add_{jump_call}_destination.
2620	 */
2621	ret = classify_symbols(file);
2622	if (ret)
2623		return ret;
2624
2625	ret = decode_instructions(file);
2626	if (ret)
2627		return ret;
2628
2629	add_ignores(file);
2630	add_uaccess_safe(file);
2631
2632	ret = add_ignore_alternatives(file);
2633	if (ret)
2634		return ret;
2635
2636	/*
2637	 * Must be before read_unwind_hints() since that needs insn->noendbr.
2638	 */
2639	ret = read_noendbr_hints(file);
2640	if (ret)
2641		return ret;
2642
2643	/*
2644	 * Must be before add_jump_destinations(), which depends on 'func'
2645	 * being set for alternatives, to enable proper sibling call detection.
2646	 */
2647	if (opts.stackval || opts.orc || opts.uaccess || opts.noinstr) {
2648		ret = add_special_section_alts(file);
2649		if (ret)
2650			return ret;
2651	}
2652
2653	ret = add_jump_destinations(file);
2654	if (ret)
2655		return ret;
2656
2657	/*
2658	 * Must be before add_call_destination(); it changes INSN_CALL to
2659	 * INSN_JUMP.
2660	 */
2661	ret = read_intra_function_calls(file);
2662	if (ret)
2663		return ret;
2664
2665	ret = add_call_destinations(file);
2666	if (ret)
2667		return ret;
2668
2669	/*
2670	 * Must be after add_call_destinations() such that it can override
2671	 * dead_end_function() marks.
2672	 */
2673	ret = add_dead_ends(file);
2674	if (ret)
2675		return ret;
2676
2677	ret = add_jump_table_alts(file);
2678	if (ret)
2679		return ret;
2680
2681	ret = read_unwind_hints(file);
2682	if (ret)
2683		return ret;
2684
2685	ret = read_retpoline_hints(file);
2686	if (ret)
2687		return ret;
2688
2689	ret = read_instr_hints(file);
2690	if (ret)
2691		return ret;
2692
2693	ret = read_validate_unret_hints(file);
2694	if (ret)
2695		return ret;
2696
2697	return 0;
2698}
2699
2700static bool is_special_call(struct instruction *insn)
2701{
2702	if (insn->type == INSN_CALL) {
2703		struct symbol *dest = insn_call_dest(insn);
2704
2705		if (!dest)
2706			return false;
2707
2708		if (dest->fentry || dest->embedded_insn)
2709			return true;
2710	}
2711
2712	return false;
2713}
2714
2715static bool has_modified_stack_frame(struct instruction *insn, struct insn_state *state)
2716{
2717	struct cfi_state *cfi = &state->cfi;
2718	int i;
2719
2720	if (cfi->cfa.base != initial_func_cfi.cfa.base || cfi->drap)
2721		return true;
2722
2723	if (cfi->cfa.offset != initial_func_cfi.cfa.offset)
2724		return true;
2725
2726	if (cfi->stack_size != initial_func_cfi.cfa.offset)
2727		return true;
2728
2729	for (i = 0; i < CFI_NUM_REGS; i++) {
2730		if (cfi->regs[i].base != initial_func_cfi.regs[i].base ||
2731		    cfi->regs[i].offset != initial_func_cfi.regs[i].offset)
2732			return true;
2733	}
2734
2735	return false;
2736}
2737
2738static bool check_reg_frame_pos(const struct cfi_reg *reg,
2739				int expected_offset)
2740{
2741	return reg->base == CFI_CFA &&
2742	       reg->offset == expected_offset;
2743}
2744
2745static bool has_valid_stack_frame(struct insn_state *state)
2746{
2747	struct cfi_state *cfi = &state->cfi;
2748
2749	if (cfi->cfa.base == CFI_BP &&
2750	    check_reg_frame_pos(&cfi->regs[CFI_BP], -cfi->cfa.offset) &&
2751	    check_reg_frame_pos(&cfi->regs[CFI_RA], -cfi->cfa.offset + 8))
2752		return true;
2753
2754	if (cfi->drap && cfi->regs[CFI_BP].base == CFI_BP)
2755		return true;
2756
2757	return false;
2758}
2759
2760static int update_cfi_state_regs(struct instruction *insn,
2761				  struct cfi_state *cfi,
2762				  struct stack_op *op)
2763{
2764	struct cfi_reg *cfa = &cfi->cfa;
2765
2766	if (cfa->base != CFI_SP && cfa->base != CFI_SP_INDIRECT)
2767		return 0;
2768
2769	/* push */
2770	if (op->dest.type == OP_DEST_PUSH || op->dest.type == OP_DEST_PUSHF)
2771		cfa->offset += 8;
2772
2773	/* pop */
2774	if (op->src.type == OP_SRC_POP || op->src.type == OP_SRC_POPF)
2775		cfa->offset -= 8;
2776
2777	/* add immediate to sp */
2778	if (op->dest.type == OP_DEST_REG && op->src.type == OP_SRC_ADD &&
2779	    op->dest.reg == CFI_SP && op->src.reg == CFI_SP)
2780		cfa->offset -= op->src.offset;
2781
2782	return 0;
2783}
2784
2785static void save_reg(struct cfi_state *cfi, unsigned char reg, int base, int offset)
2786{
2787	if (arch_callee_saved_reg(reg) &&
2788	    cfi->regs[reg].base == CFI_UNDEFINED) {
2789		cfi->regs[reg].base = base;
2790		cfi->regs[reg].offset = offset;
2791	}
2792}
2793
2794static void restore_reg(struct cfi_state *cfi, unsigned char reg)
2795{
2796	cfi->regs[reg].base = initial_func_cfi.regs[reg].base;
2797	cfi->regs[reg].offset = initial_func_cfi.regs[reg].offset;
2798}
2799
2800/*
2801 * A note about DRAP stack alignment:
2802 *
2803 * GCC has the concept of a DRAP register, which is used to help keep track of
2804 * the stack pointer when aligning the stack.  r10 or r13 is used as the DRAP
2805 * register.  The typical DRAP pattern is:
2806 *
2807 *   4c 8d 54 24 08		lea    0x8(%rsp),%r10
2808 *   48 83 e4 c0		and    $0xffffffffffffffc0,%rsp
2809 *   41 ff 72 f8		pushq  -0x8(%r10)
2810 *   55				push   %rbp
2811 *   48 89 e5			mov    %rsp,%rbp
2812 *				(more pushes)
2813 *   41 52			push   %r10
2814 *				...
2815 *   41 5a			pop    %r10
2816 *				(more pops)
2817 *   5d				pop    %rbp
2818 *   49 8d 62 f8		lea    -0x8(%r10),%rsp
2819 *   c3				retq
2820 *
2821 * There are some variations in the epilogues, like:
2822 *
2823 *   5b				pop    %rbx
2824 *   41 5a			pop    %r10
2825 *   41 5c			pop    %r12
2826 *   41 5d			pop    %r13
2827 *   41 5e			pop    %r14
2828 *   c9				leaveq
2829 *   49 8d 62 f8		lea    -0x8(%r10),%rsp
2830 *   c3				retq
2831 *
2832 * and:
2833 *
2834 *   4c 8b 55 e8		mov    -0x18(%rbp),%r10
2835 *   48 8b 5d e0		mov    -0x20(%rbp),%rbx
2836 *   4c 8b 65 f0		mov    -0x10(%rbp),%r12
2837 *   4c 8b 6d f8		mov    -0x8(%rbp),%r13
2838 *   c9				leaveq
2839 *   49 8d 62 f8		lea    -0x8(%r10),%rsp
2840 *   c3				retq
2841 *
2842 * Sometimes r13 is used as the DRAP register, in which case it's saved and
2843 * restored beforehand:
2844 *
2845 *   41 55			push   %r13
2846 *   4c 8d 6c 24 10		lea    0x10(%rsp),%r13
2847 *   48 83 e4 f0		and    $0xfffffffffffffff0,%rsp
2848 *				...
2849 *   49 8d 65 f0		lea    -0x10(%r13),%rsp
2850 *   41 5d			pop    %r13
2851 *   c3				retq
2852 */
2853static int update_cfi_state(struct instruction *insn,
2854			    struct instruction *next_insn,
2855			    struct cfi_state *cfi, struct stack_op *op)
2856{
2857	struct cfi_reg *cfa = &cfi->cfa;
2858	struct cfi_reg *regs = cfi->regs;
2859
2860	/* ignore UNWIND_HINT_UNDEFINED regions */
2861	if (cfi->force_undefined)
2862		return 0;
2863
2864	/* stack operations don't make sense with an undefined CFA */
2865	if (cfa->base == CFI_UNDEFINED) {
2866		if (insn_func(insn)) {
2867			WARN_INSN(insn, "undefined stack state");
2868			return -1;
2869		}
2870		return 0;
2871	}
2872
2873	if (cfi->type == UNWIND_HINT_TYPE_REGS ||
2874	    cfi->type == UNWIND_HINT_TYPE_REGS_PARTIAL)
2875		return update_cfi_state_regs(insn, cfi, op);
2876
2877	switch (op->dest.type) {
2878
2879	case OP_DEST_REG:
2880		switch (op->src.type) {
2881
2882		case OP_SRC_REG:
2883			if (op->src.reg == CFI_SP && op->dest.reg == CFI_BP &&
2884			    cfa->base == CFI_SP &&
2885			    check_reg_frame_pos(&regs[CFI_BP], -cfa->offset)) {
2886
2887				/* mov %rsp, %rbp */
2888				cfa->base = op->dest.reg;
2889				cfi->bp_scratch = false;
2890			}
2891
2892			else if (op->src.reg == CFI_SP &&
2893				 op->dest.reg == CFI_BP && cfi->drap) {
2894
2895				/* drap: mov %rsp, %rbp */
2896				regs[CFI_BP].base = CFI_BP;
2897				regs[CFI_BP].offset = -cfi->stack_size;
2898				cfi->bp_scratch = false;
2899			}
2900
2901			else if (op->src.reg == CFI_SP && cfa->base == CFI_SP) {
2902
2903				/*
2904				 * mov %rsp, %reg
2905				 *
2906				 * This is needed for the rare case where GCC
2907				 * does:
2908				 *
2909				 *   mov    %rsp, %rax
2910				 *   ...
2911				 *   mov    %rax, %rsp
2912				 */
2913				cfi->vals[op->dest.reg].base = CFI_CFA;
2914				cfi->vals[op->dest.reg].offset = -cfi->stack_size;
2915			}
2916
2917			else if (op->src.reg == CFI_BP && op->dest.reg == CFI_SP &&
2918				 (cfa->base == CFI_BP || cfa->base == cfi->drap_reg)) {
2919
2920				/*
2921				 * mov %rbp, %rsp
2922				 *
2923				 * Restore the original stack pointer (Clang).
2924				 */
2925				cfi->stack_size = -cfi->regs[CFI_BP].offset;
2926			}
2927
2928			else if (op->dest.reg == cfa->base) {
2929
2930				/* mov %reg, %rsp */
2931				if (cfa->base == CFI_SP &&
2932				    cfi->vals[op->src.reg].base == CFI_CFA) {
2933
2934					/*
2935					 * This is needed for the rare case
2936					 * where GCC does something dumb like:
2937					 *
2938					 *   lea    0x8(%rsp), %rcx
2939					 *   ...
2940					 *   mov    %rcx, %rsp
2941					 */
2942					cfa->offset = -cfi->vals[op->src.reg].offset;
2943					cfi->stack_size = cfa->offset;
2944
2945				} else if (cfa->base == CFI_SP &&
2946					   cfi->vals[op->src.reg].base == CFI_SP_INDIRECT &&
2947					   cfi->vals[op->src.reg].offset == cfa->offset) {
2948
2949					/*
2950					 * Stack swizzle:
2951					 *
2952					 * 1: mov %rsp, (%[tos])
2953					 * 2: mov %[tos], %rsp
2954					 *    ...
2955					 * 3: pop %rsp
2956					 *
2957					 * Where:
2958					 *
2959					 * 1 - places a pointer to the previous
2960					 *     stack at the Top-of-Stack of the
2961					 *     new stack.
2962					 *
2963					 * 2 - switches to the new stack.
2964					 *
2965					 * 3 - pops the Top-of-Stack to restore
2966					 *     the original stack.
2967					 *
2968					 * Note: we set base to SP_INDIRECT
2969					 * here and preserve offset. Therefore
2970					 * when the unwinder reaches ToS it
2971					 * will dereference SP and then add the
2972					 * offset to find the next frame, IOW:
2973					 * (%rsp) + offset.
2974					 */
2975					cfa->base = CFI_SP_INDIRECT;
2976
2977				} else {
2978					cfa->base = CFI_UNDEFINED;
2979					cfa->offset = 0;
2980				}
2981			}
2982
2983			else if (op->dest.reg == CFI_SP &&
2984				 cfi->vals[op->src.reg].base == CFI_SP_INDIRECT &&
2985				 cfi->vals[op->src.reg].offset == cfa->offset) {
2986
2987				/*
2988				 * The same stack swizzle case 2) as above. But
2989				 * because we can't change cfa->base, case 3)
2990				 * will become a regular POP. Pretend we're a
2991				 * PUSH so things don't go unbalanced.
2992				 */
2993				cfi->stack_size += 8;
2994			}
2995
2996
2997			break;
2998
2999		case OP_SRC_ADD:
3000			if (op->dest.reg == CFI_SP && op->src.reg == CFI_SP) {
3001
3002				/* add imm, %rsp */
3003				cfi->stack_size -= op->src.offset;
3004				if (cfa->base == CFI_SP)
3005					cfa->offset -= op->src.offset;
3006				break;
3007			}
3008
3009			if (op->dest.reg == CFI_BP && op->src.reg == CFI_SP &&
3010			    insn->sym->frame_pointer) {
3011				/* addi.d fp,sp,imm on LoongArch */
3012				if (cfa->base == CFI_SP && cfa->offset == op->src.offset) {
3013					cfa->base = CFI_BP;
3014					cfa->offset = 0;
3015				}
3016				break;
3017			}
3018
3019			if (op->dest.reg == CFI_SP && op->src.reg == CFI_BP) {
3020				/* addi.d sp,fp,imm on LoongArch */
3021				if (cfa->base == CFI_BP && cfa->offset == 0) {
3022					if (insn->sym->frame_pointer) {
3023						cfa->base = CFI_SP;
3024						cfa->offset = -op->src.offset;
3025					}
3026				} else {
3027					/* lea disp(%rbp), %rsp */
3028					cfi->stack_size = -(op->src.offset + regs[CFI_BP].offset);
3029				}
3030				break;
3031			}
3032
3033			if (op->src.reg == CFI_SP && cfa->base == CFI_SP) {
3034
3035				/* drap: lea disp(%rsp), %drap */
3036				cfi->drap_reg = op->dest.reg;
3037
3038				/*
3039				 * lea disp(%rsp), %reg
3040				 *
3041				 * This is needed for the rare case where GCC
3042				 * does something dumb like:
3043				 *
3044				 *   lea    0x8(%rsp), %rcx
3045				 *   ...
3046				 *   mov    %rcx, %rsp
3047				 */
3048				cfi->vals[op->dest.reg].base = CFI_CFA;
3049				cfi->vals[op->dest.reg].offset = \
3050					-cfi->stack_size + op->src.offset;
3051
3052				break;
3053			}
3054
3055			if (cfi->drap && op->dest.reg == CFI_SP &&
3056			    op->src.reg == cfi->drap_reg) {
3057
3058				 /* drap: lea disp(%drap), %rsp */
3059				cfa->base = CFI_SP;
3060				cfa->offset = cfi->stack_size = -op->src.offset;
3061				cfi->drap_reg = CFI_UNDEFINED;
3062				cfi->drap = false;
3063				break;
3064			}
3065
3066			if (op->dest.reg == cfi->cfa.base && !(next_insn && next_insn->hint)) {
3067				WARN_INSN(insn, "unsupported stack register modification");
 
3068				return -1;
3069			}
3070
3071			break;
3072
3073		case OP_SRC_AND:
3074			if (op->dest.reg != CFI_SP ||
3075			    (cfi->drap_reg != CFI_UNDEFINED && cfa->base != CFI_SP) ||
3076			    (cfi->drap_reg == CFI_UNDEFINED && cfa->base != CFI_BP)) {
3077				WARN_INSN(insn, "unsupported stack pointer realignment");
 
3078				return -1;
3079			}
3080
3081			if (cfi->drap_reg != CFI_UNDEFINED) {
3082				/* drap: and imm, %rsp */
3083				cfa->base = cfi->drap_reg;
3084				cfa->offset = cfi->stack_size = 0;
3085				cfi->drap = true;
3086			}
3087
3088			/*
3089			 * Older versions of GCC (4.8ish) realign the stack
3090			 * without DRAP, with a frame pointer.
3091			 */
3092
3093			break;
3094
3095		case OP_SRC_POP:
3096		case OP_SRC_POPF:
3097			if (op->dest.reg == CFI_SP && cfa->base == CFI_SP_INDIRECT) {
3098
3099				/* pop %rsp; # restore from a stack swizzle */
3100				cfa->base = CFI_SP;
3101				break;
3102			}
3103
3104			if (!cfi->drap && op->dest.reg == cfa->base) {
3105
3106				/* pop %rbp */
3107				cfa->base = CFI_SP;
3108			}
3109
3110			if (cfi->drap && cfa->base == CFI_BP_INDIRECT &&
3111			    op->dest.reg == cfi->drap_reg &&
3112			    cfi->drap_offset == -cfi->stack_size) {
3113
3114				/* drap: pop %drap */
3115				cfa->base = cfi->drap_reg;
3116				cfa->offset = 0;
3117				cfi->drap_offset = -1;
3118
3119			} else if (cfi->stack_size == -regs[op->dest.reg].offset) {
3120
3121				/* pop %reg */
3122				restore_reg(cfi, op->dest.reg);
3123			}
3124
3125			cfi->stack_size -= 8;
3126			if (cfa->base == CFI_SP)
3127				cfa->offset -= 8;
3128
3129			break;
3130
3131		case OP_SRC_REG_INDIRECT:
3132			if (!cfi->drap && op->dest.reg == cfa->base &&
3133			    op->dest.reg == CFI_BP) {
3134
3135				/* mov disp(%rsp), %rbp */
3136				cfa->base = CFI_SP;
3137				cfa->offset = cfi->stack_size;
3138			}
3139
3140			if (cfi->drap && op->src.reg == CFI_BP &&
3141			    op->src.offset == cfi->drap_offset) {
3142
3143				/* drap: mov disp(%rbp), %drap */
3144				cfa->base = cfi->drap_reg;
3145				cfa->offset = 0;
3146				cfi->drap_offset = -1;
3147			}
3148
3149			if (cfi->drap && op->src.reg == CFI_BP &&
3150			    op->src.offset == regs[op->dest.reg].offset) {
3151
3152				/* drap: mov disp(%rbp), %reg */
3153				restore_reg(cfi, op->dest.reg);
3154
3155			} else if (op->src.reg == cfa->base &&
3156			    op->src.offset == regs[op->dest.reg].offset + cfa->offset) {
3157
3158				/* mov disp(%rbp), %reg */
3159				/* mov disp(%rsp), %reg */
3160				restore_reg(cfi, op->dest.reg);
3161
3162			} else if (op->src.reg == CFI_SP &&
3163				   op->src.offset == regs[op->dest.reg].offset + cfi->stack_size) {
3164
3165				/* mov disp(%rsp), %reg */
3166				restore_reg(cfi, op->dest.reg);
3167			}
3168
3169			break;
3170
3171		default:
3172			WARN_INSN(insn, "unknown stack-related instruction");
 
3173			return -1;
3174		}
3175
3176		break;
3177
3178	case OP_DEST_PUSH:
3179	case OP_DEST_PUSHF:
3180		cfi->stack_size += 8;
3181		if (cfa->base == CFI_SP)
3182			cfa->offset += 8;
3183
3184		if (op->src.type != OP_SRC_REG)
3185			break;
3186
3187		if (cfi->drap) {
3188			if (op->src.reg == cfa->base && op->src.reg == cfi->drap_reg) {
3189
3190				/* drap: push %drap */
3191				cfa->base = CFI_BP_INDIRECT;
3192				cfa->offset = -cfi->stack_size;
3193
3194				/* save drap so we know when to restore it */
3195				cfi->drap_offset = -cfi->stack_size;
3196
3197			} else if (op->src.reg == CFI_BP && cfa->base == cfi->drap_reg) {
3198
3199				/* drap: push %rbp */
3200				cfi->stack_size = 0;
3201
3202			} else {
3203
3204				/* drap: push %reg */
3205				save_reg(cfi, op->src.reg, CFI_BP, -cfi->stack_size);
3206			}
3207
3208		} else {
3209
3210			/* push %reg */
3211			save_reg(cfi, op->src.reg, CFI_CFA, -cfi->stack_size);
3212		}
3213
3214		/* detect when asm code uses rbp as a scratch register */
3215		if (opts.stackval && insn_func(insn) && op->src.reg == CFI_BP &&
3216		    cfa->base != CFI_BP)
3217			cfi->bp_scratch = true;
3218		break;
3219
3220	case OP_DEST_REG_INDIRECT:
3221
3222		if (cfi->drap) {
3223			if (op->src.reg == cfa->base && op->src.reg == cfi->drap_reg) {
3224
3225				/* drap: mov %drap, disp(%rbp) */
3226				cfa->base = CFI_BP_INDIRECT;
3227				cfa->offset = op->dest.offset;
3228
3229				/* save drap offset so we know when to restore it */
3230				cfi->drap_offset = op->dest.offset;
3231			} else {
3232
3233				/* drap: mov reg, disp(%rbp) */
3234				save_reg(cfi, op->src.reg, CFI_BP, op->dest.offset);
3235			}
3236
3237		} else if (op->dest.reg == cfa->base) {
3238
3239			/* mov reg, disp(%rbp) */
3240			/* mov reg, disp(%rsp) */
3241			save_reg(cfi, op->src.reg, CFI_CFA,
3242				 op->dest.offset - cfi->cfa.offset);
3243
3244		} else if (op->dest.reg == CFI_SP) {
3245
3246			/* mov reg, disp(%rsp) */
3247			save_reg(cfi, op->src.reg, CFI_CFA,
3248				 op->dest.offset - cfi->stack_size);
3249
3250		} else if (op->src.reg == CFI_SP && op->dest.offset == 0) {
3251
3252			/* mov %rsp, (%reg); # setup a stack swizzle. */
3253			cfi->vals[op->dest.reg].base = CFI_SP_INDIRECT;
3254			cfi->vals[op->dest.reg].offset = cfa->offset;
3255		}
3256
3257		break;
3258
3259	case OP_DEST_MEM:
3260		if (op->src.type != OP_SRC_POP && op->src.type != OP_SRC_POPF) {
3261			WARN_INSN(insn, "unknown stack-related memory operation");
 
3262			return -1;
3263		}
3264
3265		/* pop mem */
3266		cfi->stack_size -= 8;
3267		if (cfa->base == CFI_SP)
3268			cfa->offset -= 8;
3269
3270		break;
3271
3272	default:
3273		WARN_INSN(insn, "unknown stack-related instruction");
 
3274		return -1;
3275	}
3276
3277	return 0;
3278}
3279
3280/*
3281 * The stack layouts of alternatives instructions can sometimes diverge when
3282 * they have stack modifications.  That's fine as long as the potential stack
3283 * layouts don't conflict at any given potential instruction boundary.
3284 *
3285 * Flatten the CFIs of the different alternative code streams (both original
3286 * and replacement) into a single shared CFI array which can be used to detect
3287 * conflicts and nicely feed a linear array of ORC entries to the unwinder.
3288 */
3289static int propagate_alt_cfi(struct objtool_file *file, struct instruction *insn)
3290{
3291	struct cfi_state **alt_cfi;
3292	int group_off;
3293
3294	if (!insn->alt_group)
3295		return 0;
3296
3297	if (!insn->cfi) {
3298		WARN("CFI missing");
3299		return -1;
3300	}
3301
3302	alt_cfi = insn->alt_group->cfi;
3303	group_off = insn->offset - insn->alt_group->first_insn->offset;
3304
3305	if (!alt_cfi[group_off]) {
3306		alt_cfi[group_off] = insn->cfi;
3307	} else {
3308		if (cficmp(alt_cfi[group_off], insn->cfi)) {
3309			struct alt_group *orig_group = insn->alt_group->orig_group ?: insn->alt_group;
3310			struct instruction *orig = orig_group->first_insn;
3311			char *where = offstr(insn->sec, insn->offset);
3312			WARN_INSN(orig, "stack layout conflict in alternatives: %s", where);
3313			free(where);
3314			return -1;
3315		}
3316	}
3317
3318	return 0;
3319}
3320
3321static int handle_insn_ops(struct instruction *insn,
3322			   struct instruction *next_insn,
3323			   struct insn_state *state)
3324{
3325	struct stack_op *op;
3326
3327	for (op = insn->stack_ops; op; op = op->next) {
3328
3329		if (update_cfi_state(insn, next_insn, &state->cfi, op))
3330			return 1;
3331
3332		if (!insn->alt_group)
3333			continue;
3334
3335		if (op->dest.type == OP_DEST_PUSHF) {
3336			if (!state->uaccess_stack) {
3337				state->uaccess_stack = 1;
3338			} else if (state->uaccess_stack >> 31) {
3339				WARN_INSN(insn, "PUSHF stack exhausted");
 
3340				return 1;
3341			}
3342			state->uaccess_stack <<= 1;
3343			state->uaccess_stack  |= state->uaccess;
3344		}
3345
3346		if (op->src.type == OP_SRC_POPF) {
3347			if (state->uaccess_stack) {
3348				state->uaccess = state->uaccess_stack & 1;
3349				state->uaccess_stack >>= 1;
3350				if (state->uaccess_stack == 1)
3351					state->uaccess_stack = 0;
3352			}
3353		}
3354	}
3355
3356	return 0;
3357}
3358
3359static bool insn_cfi_match(struct instruction *insn, struct cfi_state *cfi2)
3360{
3361	struct cfi_state *cfi1 = insn->cfi;
3362	int i;
3363
3364	if (!cfi1) {
3365		WARN("CFI missing");
3366		return false;
3367	}
3368
3369	if (memcmp(&cfi1->cfa, &cfi2->cfa, sizeof(cfi1->cfa))) {
3370
3371		WARN_INSN(insn, "stack state mismatch: cfa1=%d%+d cfa2=%d%+d",
 
3372			  cfi1->cfa.base, cfi1->cfa.offset,
3373			  cfi2->cfa.base, cfi2->cfa.offset);
3374
3375	} else if (memcmp(&cfi1->regs, &cfi2->regs, sizeof(cfi1->regs))) {
3376		for (i = 0; i < CFI_NUM_REGS; i++) {
3377			if (!memcmp(&cfi1->regs[i], &cfi2->regs[i],
3378				    sizeof(struct cfi_reg)))
3379				continue;
3380
3381			WARN_INSN(insn, "stack state mismatch: reg1[%d]=%d%+d reg2[%d]=%d%+d",
 
3382				  i, cfi1->regs[i].base, cfi1->regs[i].offset,
3383				  i, cfi2->regs[i].base, cfi2->regs[i].offset);
3384			break;
3385		}
3386
3387	} else if (cfi1->type != cfi2->type) {
3388
3389		WARN_INSN(insn, "stack state mismatch: type1=%d type2=%d",
3390			  cfi1->type, cfi2->type);
3391
3392	} else if (cfi1->drap != cfi2->drap ||
3393		   (cfi1->drap && cfi1->drap_reg != cfi2->drap_reg) ||
3394		   (cfi1->drap && cfi1->drap_offset != cfi2->drap_offset)) {
3395
3396		WARN_INSN(insn, "stack state mismatch: drap1=%d(%d,%d) drap2=%d(%d,%d)",
 
3397			  cfi1->drap, cfi1->drap_reg, cfi1->drap_offset,
3398			  cfi2->drap, cfi2->drap_reg, cfi2->drap_offset);
3399
3400	} else
3401		return true;
3402
3403	return false;
3404}
3405
3406static inline bool func_uaccess_safe(struct symbol *func)
3407{
3408	if (func)
3409		return func->uaccess_safe;
3410
3411	return false;
3412}
3413
3414static inline const char *call_dest_name(struct instruction *insn)
3415{
3416	static char pvname[19];
3417	struct reloc *reloc;
3418	int idx;
3419
3420	if (insn_call_dest(insn))
3421		return insn_call_dest(insn)->name;
3422
3423	reloc = insn_reloc(NULL, insn);
3424	if (reloc && !strcmp(reloc->sym->name, "pv_ops")) {
3425		idx = (reloc_addend(reloc) / sizeof(void *));
3426		snprintf(pvname, sizeof(pvname), "pv_ops[%d]", idx);
3427		return pvname;
3428	}
3429
3430	return "{dynamic}";
3431}
3432
3433static bool pv_call_dest(struct objtool_file *file, struct instruction *insn)
3434{
3435	struct symbol *target;
3436	struct reloc *reloc;
3437	int idx;
3438
3439	reloc = insn_reloc(file, insn);
3440	if (!reloc || strcmp(reloc->sym->name, "pv_ops"))
3441		return false;
3442
3443	idx = (arch_dest_reloc_offset(reloc_addend(reloc)) / sizeof(void *));
3444
3445	if (file->pv_ops[idx].clean)
3446		return true;
3447
3448	file->pv_ops[idx].clean = true;
3449
3450	list_for_each_entry(target, &file->pv_ops[idx].targets, pv_target) {
3451		if (!target->sec->noinstr) {
3452			WARN("pv_ops[%d]: %s", idx, target->name);
3453			file->pv_ops[idx].clean = false;
3454		}
3455	}
3456
3457	return file->pv_ops[idx].clean;
3458}
3459
3460static inline bool noinstr_call_dest(struct objtool_file *file,
3461				     struct instruction *insn,
3462				     struct symbol *func)
3463{
3464	/*
3465	 * We can't deal with indirect function calls at present;
3466	 * assume they're instrumented.
3467	 */
3468	if (!func) {
3469		if (file->pv_ops)
3470			return pv_call_dest(file, insn);
3471
3472		return false;
3473	}
3474
3475	/*
3476	 * If the symbol is from a noinstr section; we good.
3477	 */
3478	if (func->sec->noinstr)
3479		return true;
3480
3481	/*
3482	 * If the symbol is a static_call trampoline, we can't tell.
3483	 */
3484	if (func->static_call_tramp)
3485		return true;
3486
3487	/*
3488	 * The __ubsan_handle_*() calls are like WARN(), they only happen when
3489	 * something 'BAD' happened. At the risk of taking the machine down,
3490	 * let them proceed to get the message out.
3491	 */
3492	if (!strncmp(func->name, "__ubsan_handle_", 15))
3493		return true;
3494
3495	return false;
3496}
3497
3498static int validate_call(struct objtool_file *file,
3499			 struct instruction *insn,
3500			 struct insn_state *state)
3501{
3502	if (state->noinstr && state->instr <= 0 &&
3503	    !noinstr_call_dest(file, insn, insn_call_dest(insn))) {
3504		WARN_INSN(insn, "call to %s() leaves .noinstr.text section", call_dest_name(insn));
 
3505		return 1;
3506	}
3507
3508	if (state->uaccess && !func_uaccess_safe(insn_call_dest(insn))) {
3509		WARN_INSN(insn, "call to %s() with UACCESS enabled", call_dest_name(insn));
 
3510		return 1;
3511	}
3512
3513	if (state->df) {
3514		WARN_INSN(insn, "call to %s() with DF set", call_dest_name(insn));
 
3515		return 1;
3516	}
3517
3518	return 0;
3519}
3520
3521static int validate_sibling_call(struct objtool_file *file,
3522				 struct instruction *insn,
3523				 struct insn_state *state)
3524{
3525	if (insn_func(insn) && has_modified_stack_frame(insn, state)) {
3526		WARN_INSN(insn, "sibling call from callable instruction with modified stack frame");
 
3527		return 1;
3528	}
3529
3530	return validate_call(file, insn, state);
3531}
3532
3533static int validate_return(struct symbol *func, struct instruction *insn, struct insn_state *state)
3534{
3535	if (state->noinstr && state->instr > 0) {
3536		WARN_INSN(insn, "return with instrumentation enabled");
 
3537		return 1;
3538	}
3539
3540	if (state->uaccess && !func_uaccess_safe(func)) {
3541		WARN_INSN(insn, "return with UACCESS enabled");
 
3542		return 1;
3543	}
3544
3545	if (!state->uaccess && func_uaccess_safe(func)) {
3546		WARN_INSN(insn, "return with UACCESS disabled from a UACCESS-safe function");
 
3547		return 1;
3548	}
3549
3550	if (state->df) {
3551		WARN_INSN(insn, "return with DF set");
 
3552		return 1;
3553	}
3554
3555	if (func && has_modified_stack_frame(insn, state)) {
3556		WARN_INSN(insn, "return with modified stack frame");
 
3557		return 1;
3558	}
3559
3560	if (state->cfi.bp_scratch) {
3561		WARN_INSN(insn, "BP used as a scratch register");
 
3562		return 1;
3563	}
3564
3565	return 0;
3566}
3567
3568static struct instruction *next_insn_to_validate(struct objtool_file *file,
3569						 struct instruction *insn)
3570{
3571	struct alt_group *alt_group = insn->alt_group;
3572
3573	/*
3574	 * Simulate the fact that alternatives are patched in-place.  When the
3575	 * end of a replacement alt_group is reached, redirect objtool flow to
3576	 * the end of the original alt_group.
3577	 *
3578	 * insn->alts->insn -> alt_group->first_insn
3579	 *		       ...
3580	 *		       alt_group->last_insn
3581	 *		       [alt_group->nop]      -> next(orig_group->last_insn)
3582	 */
3583	if (alt_group) {
3584		if (alt_group->nop) {
3585			/* ->nop implies ->orig_group */
3586			if (insn == alt_group->last_insn)
3587				return alt_group->nop;
3588			if (insn == alt_group->nop)
3589				goto next_orig;
3590		}
3591		if (insn == alt_group->last_insn && alt_group->orig_group)
3592			goto next_orig;
3593	}
3594
3595	return next_insn_same_sec(file, insn);
3596
3597next_orig:
3598	return next_insn_same_sec(file, alt_group->orig_group->last_insn);
3599}
3600
3601/*
3602 * Follow the branch starting at the given instruction, and recursively follow
3603 * any other branches (jumps).  Meanwhile, track the frame pointer state at
3604 * each instruction and validate all the rules described in
3605 * tools/objtool/Documentation/objtool.txt.
3606 */
3607static int validate_branch(struct objtool_file *file, struct symbol *func,
3608			   struct instruction *insn, struct insn_state state)
3609{
3610	struct alternative *alt;
3611	struct instruction *next_insn, *prev_insn = NULL;
3612	struct section *sec;
3613	u8 visited;
3614	int ret;
3615
3616	sec = insn->sec;
3617
3618	while (1) {
3619		next_insn = next_insn_to_validate(file, insn);
3620
3621		if (func && insn_func(insn) && func != insn_func(insn)->pfunc) {
3622			/* Ignore KCFI type preambles, which always fall through */
3623			if (!strncmp(func->name, "__cfi_", 6) ||
3624			    !strncmp(func->name, "__pfx_", 6))
3625				return 0;
3626
3627			WARN("%s() falls through to next function %s()",
3628			     func->name, insn_func(insn)->name);
3629			return 1;
3630		}
3631
3632		if (func && insn->ignore) {
3633			WARN_INSN(insn, "BUG: why am I validating an ignored function?");
 
3634			return 1;
3635		}
3636
3637		visited = VISITED_BRANCH << state.uaccess;
3638		if (insn->visited & VISITED_BRANCH_MASK) {
3639			if (!insn->hint && !insn_cfi_match(insn, &state.cfi))
3640				return 1;
3641
3642			if (insn->visited & visited)
3643				return 0;
3644		} else {
3645			nr_insns_visited++;
3646		}
3647
3648		if (state.noinstr)
3649			state.instr += insn->instr;
3650
3651		if (insn->hint) {
3652			if (insn->restore) {
3653				struct instruction *save_insn, *i;
3654
3655				i = insn;
3656				save_insn = NULL;
3657
3658				sym_for_each_insn_continue_reverse(file, func, i) {
3659					if (i->save) {
3660						save_insn = i;
3661						break;
3662					}
3663				}
3664
3665				if (!save_insn) {
3666					WARN_INSN(insn, "no corresponding CFI save for CFI restore");
 
3667					return 1;
3668				}
3669
3670				if (!save_insn->visited) {
3671					/*
3672					 * If the restore hint insn is at the
3673					 * beginning of a basic block and was
3674					 * branched to from elsewhere, and the
3675					 * save insn hasn't been visited yet,
3676					 * defer following this branch for now.
3677					 * It will be seen later via the
3678					 * straight-line path.
3679					 */
3680					if (!prev_insn)
3681						return 0;
3682
3683					WARN_INSN(insn, "objtool isn't smart enough to handle this CFI save/restore combo");
3684					return 1;
3685				}
3686
3687				insn->cfi = save_insn->cfi;
3688				nr_cfi_reused++;
3689			}
3690
3691			state.cfi = *insn->cfi;
3692		} else {
3693			/* XXX track if we actually changed state.cfi */
3694
3695			if (prev_insn && !cficmp(prev_insn->cfi, &state.cfi)) {
3696				insn->cfi = prev_insn->cfi;
3697				nr_cfi_reused++;
3698			} else {
3699				insn->cfi = cfi_hash_find_or_add(&state.cfi);
3700			}
3701		}
3702
3703		insn->visited |= visited;
3704
3705		if (propagate_alt_cfi(file, insn))
3706			return 1;
3707
3708		if (!insn->ignore_alts && insn->alts) {
3709			bool skip_orig = false;
3710
3711			for (alt = insn->alts; alt; alt = alt->next) {
3712				if (alt->skip_orig)
3713					skip_orig = true;
3714
3715				ret = validate_branch(file, func, alt->insn, state);
3716				if (ret) {
3717					BT_INSN(insn, "(alt)");
 
3718					return ret;
3719				}
3720			}
3721
3722			if (skip_orig)
3723				return 0;
3724		}
3725
3726		if (handle_insn_ops(insn, next_insn, &state))
3727			return 1;
3728
3729		switch (insn->type) {
3730
3731		case INSN_RETURN:
3732			return validate_return(func, insn, &state);
3733
3734		case INSN_CALL:
3735		case INSN_CALL_DYNAMIC:
3736			ret = validate_call(file, insn, &state);
3737			if (ret)
3738				return ret;
3739
3740			if (opts.stackval && func && !is_special_call(insn) &&
3741			    !has_valid_stack_frame(&state)) {
3742				WARN_INSN(insn, "call without frame pointer save/setup");
 
3743				return 1;
3744			}
3745
3746			if (insn->dead_end)
3747				return 0;
3748
3749			break;
3750
3751		case INSN_JUMP_CONDITIONAL:
3752		case INSN_JUMP_UNCONDITIONAL:
3753			if (is_sibling_call(insn)) {
3754				ret = validate_sibling_call(file, insn, &state);
3755				if (ret)
3756					return ret;
3757
3758			} else if (insn->jump_dest) {
3759				ret = validate_branch(file, func,
3760						      insn->jump_dest, state);
3761				if (ret) {
3762					BT_INSN(insn, "(branch)");
 
3763					return ret;
3764				}
3765			}
3766
3767			if (insn->type == INSN_JUMP_UNCONDITIONAL)
3768				return 0;
3769
3770			break;
3771
3772		case INSN_JUMP_DYNAMIC:
3773		case INSN_JUMP_DYNAMIC_CONDITIONAL:
3774			if (is_sibling_call(insn)) {
3775				ret = validate_sibling_call(file, insn, &state);
3776				if (ret)
3777					return ret;
3778			}
3779
3780			if (insn->type == INSN_JUMP_DYNAMIC)
3781				return 0;
3782
3783			break;
3784
3785		case INSN_CONTEXT_SWITCH:
3786			if (func) {
3787				if (!next_insn || !next_insn->hint) {
3788					WARN_INSN(insn, "unsupported instruction in callable function");
3789					return 1;
3790				}
3791				break;
3792			}
3793			return 0;
3794
3795		case INSN_STAC:
3796			if (state.uaccess) {
3797				WARN_INSN(insn, "recursive UACCESS enable");
3798				return 1;
3799			}
3800
3801			state.uaccess = true;
3802			break;
3803
3804		case INSN_CLAC:
3805			if (!state.uaccess && func) {
3806				WARN_INSN(insn, "redundant UACCESS disable");
3807				return 1;
3808			}
3809
3810			if (func_uaccess_safe(func) && !state.uaccess_stack) {
3811				WARN_INSN(insn, "UACCESS-safe disables UACCESS");
3812				return 1;
3813			}
3814
3815			state.uaccess = false;
3816			break;
3817
3818		case INSN_STD:
3819			if (state.df) {
3820				WARN_INSN(insn, "recursive STD");
3821				return 1;
3822			}
3823
3824			state.df = true;
3825			break;
3826
3827		case INSN_CLD:
3828			if (!state.df && func) {
3829				WARN_INSN(insn, "redundant CLD");
3830				return 1;
3831			}
3832
3833			state.df = false;
3834			break;
3835
3836		default:
3837			break;
3838		}
3839
3840		if (insn->dead_end)
3841			return 0;
3842
3843		if (!next_insn) {
3844			if (state.cfi.cfa.base == CFI_UNDEFINED)
3845				return 0;
3846			WARN("%s: unexpected end of section", sec->name);
3847			return 1;
3848		}
3849
3850		prev_insn = insn;
3851		insn = next_insn;
3852	}
3853
3854	return 0;
3855}
3856
3857static int validate_unwind_hint(struct objtool_file *file,
3858				  struct instruction *insn,
3859				  struct insn_state *state)
3860{
3861	if (insn->hint && !insn->visited && !insn->ignore) {
3862		int ret = validate_branch(file, insn_func(insn), insn, *state);
3863		if (ret)
3864			BT_INSN(insn, "<=== (hint)");
3865		return ret;
3866	}
3867
3868	return 0;
3869}
3870
3871static int validate_unwind_hints(struct objtool_file *file, struct section *sec)
3872{
3873	struct instruction *insn;
3874	struct insn_state state;
3875	int warnings = 0;
3876
3877	if (!file->hints)
3878		return 0;
3879
3880	init_insn_state(file, &state, sec);
3881
3882	if (sec) {
3883		sec_for_each_insn(file, sec, insn)
3884			warnings += validate_unwind_hint(file, insn, &state);
 
3885	} else {
3886		for_each_insn(file, insn)
3887			warnings += validate_unwind_hint(file, insn, &state);
 
 
 
 
 
 
 
 
 
 
3888	}
3889
3890	return warnings;
3891}
3892
3893/*
3894 * Validate rethunk entry constraint: must untrain RET before the first RET.
3895 *
3896 * Follow every branch (intra-function) and ensure VALIDATE_UNRET_END comes
3897 * before an actual RET instruction.
3898 */
3899static int validate_unret(struct objtool_file *file, struct instruction *insn)
3900{
3901	struct instruction *next, *dest;
3902	int ret;
3903
3904	for (;;) {
3905		next = next_insn_to_validate(file, insn);
3906
3907		if (insn->visited & VISITED_UNRET)
3908			return 0;
3909
3910		insn->visited |= VISITED_UNRET;
3911
3912		if (!insn->ignore_alts && insn->alts) {
3913			struct alternative *alt;
3914			bool skip_orig = false;
3915
3916			for (alt = insn->alts; alt; alt = alt->next) {
3917				if (alt->skip_orig)
3918					skip_orig = true;
3919
3920				ret = validate_unret(file, alt->insn);
3921				if (ret) {
3922					BT_INSN(insn, "(alt)");
 
3923					return ret;
3924				}
3925			}
3926
3927			if (skip_orig)
3928				return 0;
3929		}
3930
3931		switch (insn->type) {
3932
3933		case INSN_CALL_DYNAMIC:
3934		case INSN_JUMP_DYNAMIC:
3935		case INSN_JUMP_DYNAMIC_CONDITIONAL:
3936			WARN_INSN(insn, "early indirect call");
3937			return 1;
3938
3939		case INSN_JUMP_UNCONDITIONAL:
3940		case INSN_JUMP_CONDITIONAL:
3941			if (!is_sibling_call(insn)) {
3942				if (!insn->jump_dest) {
3943					WARN_INSN(insn, "unresolved jump target after linking?!?");
 
3944					return -1;
3945				}
3946				ret = validate_unret(file, insn->jump_dest);
3947				if (ret) {
3948					BT_INSN(insn, "(branch%s)",
3949						insn->type == INSN_JUMP_CONDITIONAL ? "-cond" : "");
 
 
3950					return ret;
3951				}
3952
3953				if (insn->type == INSN_JUMP_UNCONDITIONAL)
3954					return 0;
3955
3956				break;
3957			}
3958
3959			/* fallthrough */
3960		case INSN_CALL:
3961			dest = find_insn(file, insn_call_dest(insn)->sec,
3962					 insn_call_dest(insn)->offset);
3963			if (!dest) {
3964				WARN("Unresolved function after linking!?: %s",
3965				     insn_call_dest(insn)->name);
3966				return -1;
3967			}
3968
3969			ret = validate_unret(file, dest);
3970			if (ret) {
3971				BT_INSN(insn, "(call)");
 
3972				return ret;
3973			}
3974			/*
3975			 * If a call returns without error, it must have seen UNTRAIN_RET.
3976			 * Therefore any non-error return is a success.
3977			 */
3978			return 0;
3979
3980		case INSN_RETURN:
3981			WARN_INSN(insn, "RET before UNTRAIN");
3982			return 1;
3983
3984		case INSN_NOP:
3985			if (insn->retpoline_safe)
3986				return 0;
3987			break;
3988
3989		default:
3990			break;
3991		}
3992
3993		if (!next) {
3994			WARN_INSN(insn, "teh end!");
3995			return -1;
3996		}
3997		insn = next;
3998	}
3999
4000	return 0;
4001}
4002
4003/*
4004 * Validate that all branches starting at VALIDATE_UNRET_BEGIN encounter
4005 * VALIDATE_UNRET_END before RET.
4006 */
4007static int validate_unrets(struct objtool_file *file)
4008{
4009	struct instruction *insn;
4010	int ret, warnings = 0;
4011
4012	for_each_insn(file, insn) {
4013		if (!insn->unret)
4014			continue;
4015
4016		ret = validate_unret(file, insn);
4017		if (ret < 0) {
4018			WARN_INSN(insn, "Failed UNRET validation");
4019			return ret;
4020		}
4021		warnings += ret;
4022	}
4023
4024	return warnings;
4025}
4026
4027static int validate_retpoline(struct objtool_file *file)
4028{
4029	struct instruction *insn;
4030	int warnings = 0;
4031
4032	for_each_insn(file, insn) {
4033		if (insn->type != INSN_JUMP_DYNAMIC &&
4034		    insn->type != INSN_CALL_DYNAMIC &&
4035		    insn->type != INSN_RETURN)
4036			continue;
4037
4038		if (insn->retpoline_safe)
4039			continue;
4040
4041		if (insn->sec->init)
4042			continue;
4043
4044		if (insn->type == INSN_RETURN) {
4045			if (opts.rethunk) {
4046				WARN_INSN(insn, "'naked' return found in MITIGATION_RETHUNK build");
 
4047			} else
4048				continue;
4049		} else {
4050			WARN_INSN(insn, "indirect %s found in MITIGATION_RETPOLINE build",
 
4051				  insn->type == INSN_JUMP_DYNAMIC ? "jump" : "call");
4052		}
4053
4054		warnings++;
4055	}
4056
4057	return warnings;
4058}
4059
4060static bool is_kasan_insn(struct instruction *insn)
4061{
4062	return (insn->type == INSN_CALL &&
4063		!strcmp(insn_call_dest(insn)->name, "__asan_handle_no_return"));
4064}
4065
4066static bool is_ubsan_insn(struct instruction *insn)
4067{
4068	return (insn->type == INSN_CALL &&
4069		!strcmp(insn_call_dest(insn)->name,
4070			"__ubsan_handle_builtin_unreachable"));
4071}
4072
4073static bool ignore_unreachable_insn(struct objtool_file *file, struct instruction *insn)
4074{
4075	int i;
4076	struct instruction *prev_insn;
4077
4078	if (insn->ignore || insn->type == INSN_NOP || insn->type == INSN_TRAP)
4079		return true;
4080
4081	/*
4082	 * Ignore alternative replacement instructions.  This can happen
4083	 * when a whitelisted function uses one of the ALTERNATIVE macros.
4084	 */
4085	if (!strcmp(insn->sec->name, ".altinstr_replacement") ||
4086	    !strcmp(insn->sec->name, ".altinstr_aux"))
4087		return true;
4088
4089	/*
4090	 * Whole archive runs might encounter dead code from weak symbols.
4091	 * This is where the linker will have dropped the weak symbol in
4092	 * favour of a regular symbol, but leaves the code in place.
4093	 *
4094	 * In this case we'll find a piece of code (whole function) that is not
4095	 * covered by a !section symbol. Ignore them.
4096	 */
4097	if (opts.link && !insn_func(insn)) {
4098		int size = find_symbol_hole_containing(insn->sec, insn->offset);
4099		unsigned long end = insn->offset + size;
4100
4101		if (!size) /* not a hole */
4102			return false;
4103
4104		if (size < 0) /* hole until the end */
4105			return true;
4106
4107		sec_for_each_insn_continue(file, insn) {
4108			/*
4109			 * If we reach a visited instruction at or before the
4110			 * end of the hole, ignore the unreachable.
4111			 */
4112			if (insn->visited)
4113				return true;
4114
4115			if (insn->offset >= end)
4116				break;
4117
4118			/*
4119			 * If this hole jumps to a .cold function, mark it ignore too.
4120			 */
4121			if (insn->jump_dest && insn_func(insn->jump_dest) &&
4122			    strstr(insn_func(insn->jump_dest)->name, ".cold")) {
4123				struct instruction *dest = insn->jump_dest;
4124				func_for_each_insn(file, insn_func(dest), dest)
4125					dest->ignore = true;
4126			}
4127		}
4128
4129		return false;
4130	}
4131
4132	if (!insn_func(insn))
4133		return false;
4134
4135	if (insn_func(insn)->static_call_tramp)
4136		return true;
4137
4138	/*
4139	 * CONFIG_UBSAN_TRAP inserts a UD2 when it sees
4140	 * __builtin_unreachable().  The BUG() macro has an unreachable() after
4141	 * the UD2, which causes GCC's undefined trap logic to emit another UD2
4142	 * (or occasionally a JMP to UD2).
4143	 *
4144	 * It may also insert a UD2 after calling a __noreturn function.
4145	 */
4146	prev_insn = prev_insn_same_sec(file, insn);
4147	if (prev_insn->dead_end &&
4148	    (insn->type == INSN_BUG ||
4149	     (insn->type == INSN_JUMP_UNCONDITIONAL &&
4150	      insn->jump_dest && insn->jump_dest->type == INSN_BUG)))
4151		return true;
4152
4153	/*
4154	 * Check if this (or a subsequent) instruction is related to
4155	 * CONFIG_UBSAN or CONFIG_KASAN.
4156	 *
4157	 * End the search at 5 instructions to avoid going into the weeds.
4158	 */
4159	for (i = 0; i < 5; i++) {
4160
4161		if (is_kasan_insn(insn) || is_ubsan_insn(insn))
4162			return true;
4163
4164		if (insn->type == INSN_JUMP_UNCONDITIONAL) {
4165			if (insn->jump_dest &&
4166			    insn_func(insn->jump_dest) == insn_func(insn)) {
4167				insn = insn->jump_dest;
4168				continue;
4169			}
4170
4171			break;
4172		}
4173
4174		if (insn->offset + insn->len >= insn_func(insn)->offset + insn_func(insn)->len)
4175			break;
4176
4177		insn = next_insn_same_sec(file, insn);
4178	}
4179
4180	return false;
4181}
4182
4183static int add_prefix_symbol(struct objtool_file *file, struct symbol *func)
 
4184{
4185	struct instruction *insn, *prev;
4186	struct cfi_state *cfi;
4187
4188	insn = find_insn(file, func->sec, func->offset);
4189	if (!insn)
4190		return -1;
4191
4192	for (prev = prev_insn_same_sec(file, insn);
4193	     prev;
4194	     prev = prev_insn_same_sec(file, prev)) {
4195		u64 offset;
4196
4197		if (prev->type != INSN_NOP)
4198			return -1;
4199
4200		offset = func->offset - prev->offset;
4201
4202		if (offset > opts.prefix)
4203			return -1;
4204
4205		if (offset < opts.prefix)
4206			continue;
4207
4208		elf_create_prefix_symbol(file->elf, func, opts.prefix);
4209		break;
4210	}
4211
4212	if (!prev)
4213		return -1;
4214
4215	if (!insn->cfi) {
4216		/*
4217		 * This can happen if stack validation isn't enabled or the
4218		 * function is annotated with STACK_FRAME_NON_STANDARD.
4219		 */
4220		return 0;
4221	}
4222
4223	/* Propagate insn->cfi to the prefix code */
4224	cfi = cfi_hash_find_or_add(insn->cfi);
4225	for (; prev != insn; prev = next_insn_same_sec(file, prev))
4226		prev->cfi = cfi;
4227
4228	return 0;
4229}
4230
4231static int add_prefix_symbols(struct objtool_file *file)
4232{
4233	struct section *sec;
4234	struct symbol *func;
4235
4236	for_each_sec(file, sec) {
4237		if (!(sec->sh.sh_flags & SHF_EXECINSTR))
4238			continue;
4239
4240		sec_for_each_sym(sec, func) {
4241			if (func->type != STT_FUNC)
4242				continue;
4243
4244			add_prefix_symbol(file, func);
4245		}
 
4246	}
4247
4248	return 0;
4249}
4250
4251static int validate_symbol(struct objtool_file *file, struct section *sec,
4252			   struct symbol *sym, struct insn_state *state)
4253{
4254	struct instruction *insn;
4255	int ret;
4256
4257	if (!sym->len) {
4258		WARN("%s() is missing an ELF size annotation", sym->name);
4259		return 1;
4260	}
4261
4262	if (sym->pfunc != sym || sym->alias != sym)
4263		return 0;
4264
4265	insn = find_insn(file, sec, sym->offset);
4266	if (!insn || insn->ignore || insn->visited)
4267		return 0;
4268
 
 
4269	state->uaccess = sym->uaccess_safe;
4270
4271	ret = validate_branch(file, insn_func(insn), insn, *state);
4272	if (ret)
4273		BT_INSN(insn, "<=== (sym)");
4274	return ret;
4275}
4276
4277static int validate_section(struct objtool_file *file, struct section *sec)
4278{
4279	struct insn_state state;
4280	struct symbol *func;
4281	int warnings = 0;
4282
4283	sec_for_each_sym(sec, func) {
4284		if (func->type != STT_FUNC)
4285			continue;
4286
4287		init_insn_state(file, &state, sec);
4288		set_func_state(&state.cfi);
4289
4290		warnings += validate_symbol(file, sec, func, &state);
4291	}
4292
4293	return warnings;
4294}
4295
4296static int validate_noinstr_sections(struct objtool_file *file)
4297{
4298	struct section *sec;
4299	int warnings = 0;
4300
4301	sec = find_section_by_name(file->elf, ".noinstr.text");
4302	if (sec) {
4303		warnings += validate_section(file, sec);
4304		warnings += validate_unwind_hints(file, sec);
4305	}
4306
4307	sec = find_section_by_name(file->elf, ".entry.text");
4308	if (sec) {
4309		warnings += validate_section(file, sec);
4310		warnings += validate_unwind_hints(file, sec);
4311	}
4312
4313	sec = find_section_by_name(file->elf, ".cpuidle.text");
4314	if (sec) {
4315		warnings += validate_section(file, sec);
4316		warnings += validate_unwind_hints(file, sec);
4317	}
4318
4319	return warnings;
4320}
4321
4322static int validate_functions(struct objtool_file *file)
4323{
4324	struct section *sec;
4325	int warnings = 0;
4326
4327	for_each_sec(file, sec) {
4328		if (!(sec->sh.sh_flags & SHF_EXECINSTR))
4329			continue;
4330
4331		warnings += validate_section(file, sec);
4332	}
4333
4334	return warnings;
4335}
4336
4337static void mark_endbr_used(struct instruction *insn)
4338{
4339	if (!list_empty(&insn->call_node))
4340		list_del_init(&insn->call_node);
4341}
4342
4343static bool noendbr_range(struct objtool_file *file, struct instruction *insn)
4344{
4345	struct symbol *sym = find_symbol_containing(insn->sec, insn->offset-1);
4346	struct instruction *first;
4347
4348	if (!sym)
4349		return false;
4350
4351	first = find_insn(file, sym->sec, sym->offset);
4352	if (!first)
4353		return false;
4354
4355	if (first->type != INSN_ENDBR && !first->noendbr)
4356		return false;
4357
4358	return insn->offset == sym->offset + sym->len;
4359}
4360
4361static int __validate_ibt_insn(struct objtool_file *file, struct instruction *insn,
4362			       struct instruction *dest)
4363{
4364	if (dest->type == INSN_ENDBR) {
4365		mark_endbr_used(dest);
4366		return 0;
4367	}
4368
4369	if (insn_func(dest) && insn_func(insn) &&
4370	    insn_func(dest)->pfunc == insn_func(insn)->pfunc) {
4371		/*
4372		 * Anything from->to self is either _THIS_IP_ or
4373		 * IRET-to-self.
4374		 *
4375		 * There is no sane way to annotate _THIS_IP_ since the
4376		 * compiler treats the relocation as a constant and is
4377		 * happy to fold in offsets, skewing any annotation we
4378		 * do, leading to vast amounts of false-positives.
4379		 *
4380		 * There's also compiler generated _THIS_IP_ through
4381		 * KCOV and such which we have no hope of annotating.
4382		 *
4383		 * As such, blanket accept self-references without
4384		 * issue.
4385		 */
4386		return 0;
4387	}
4388
4389	/*
4390	 * Accept anything ANNOTATE_NOENDBR.
4391	 */
4392	if (dest->noendbr)
4393		return 0;
4394
4395	/*
4396	 * Accept if this is the instruction after a symbol
4397	 * that is (no)endbr -- typical code-range usage.
4398	 */
4399	if (noendbr_range(file, dest))
4400		return 0;
4401
4402	WARN_INSN(insn, "relocation to !ENDBR: %s", offstr(dest->sec, dest->offset));
4403	return 1;
4404}
4405
4406static int validate_ibt_insn(struct objtool_file *file, struct instruction *insn)
4407{
4408	struct instruction *dest;
4409	struct reloc *reloc;
4410	unsigned long off;
4411	int warnings = 0;
4412
4413	/*
4414	 * Looking for function pointer load relocations.  Ignore
4415	 * direct/indirect branches:
4416	 */
4417	switch (insn->type) {
4418
4419	case INSN_CALL:
4420	case INSN_CALL_DYNAMIC:
4421	case INSN_JUMP_CONDITIONAL:
4422	case INSN_JUMP_UNCONDITIONAL:
4423	case INSN_JUMP_DYNAMIC:
4424	case INSN_JUMP_DYNAMIC_CONDITIONAL:
4425	case INSN_RETURN:
4426	case INSN_NOP:
4427		return 0;
4428
4429	case INSN_LEA_RIP:
4430		if (!insn_reloc(file, insn)) {
4431			/* local function pointer reference without reloc */
4432
4433			off = arch_jump_destination(insn);
4434
4435			dest = find_insn(file, insn->sec, off);
4436			if (!dest) {
4437				WARN_INSN(insn, "corrupt function pointer reference");
4438				return 1;
4439			}
4440
4441			return __validate_ibt_insn(file, insn, dest);
4442		}
4443		break;
4444
4445	default:
4446		break;
4447	}
4448
4449	for (reloc = insn_reloc(file, insn);
4450	     reloc;
4451	     reloc = find_reloc_by_dest_range(file->elf, insn->sec,
4452					      reloc_offset(reloc) + 1,
4453					      (insn->offset + insn->len) - (reloc_offset(reloc) + 1))) {
 
 
 
 
 
 
 
4454
4455		off = reloc->sym->offset;
4456		if (reloc_type(reloc) == R_X86_64_PC32 ||
4457		    reloc_type(reloc) == R_X86_64_PLT32)
4458			off += arch_dest_reloc_offset(reloc_addend(reloc));
4459		else
4460			off += reloc_addend(reloc);
4461
4462		dest = find_insn(file, reloc->sym->sec, off);
4463		if (!dest)
4464			continue;
4465
4466		warnings += __validate_ibt_insn(file, insn, dest);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
4467	}
4468
4469	return warnings;
4470}
4471
4472static int validate_ibt_data_reloc(struct objtool_file *file,
4473				   struct reloc *reloc)
4474{
4475	struct instruction *dest;
4476
4477	dest = find_insn(file, reloc->sym->sec,
4478			 reloc->sym->offset + reloc_addend(reloc));
4479	if (!dest)
4480		return 0;
4481
4482	if (dest->type == INSN_ENDBR) {
4483		mark_endbr_used(dest);
4484		return 0;
4485	}
4486
4487	if (dest->noendbr)
4488		return 0;
4489
4490	WARN_FUNC("data relocation to !ENDBR: %s",
4491		  reloc->sec->base, reloc_offset(reloc),
4492		  offstr(dest->sec, dest->offset));
4493
4494	return 1;
4495}
4496
4497/*
4498 * Validate IBT rules and remove used ENDBR instructions from the seal list.
4499 * Unused ENDBR instructions will be annotated for sealing (i.e., replaced with
4500 * NOPs) later, in create_ibt_endbr_seal_sections().
4501 */
4502static int validate_ibt(struct objtool_file *file)
4503{
4504	struct section *sec;
4505	struct reloc *reloc;
4506	struct instruction *insn;
4507	int warnings = 0;
4508
4509	for_each_insn(file, insn)
4510		warnings += validate_ibt_insn(file, insn);
4511
4512	for_each_sec(file, sec) {
4513
4514		/* Already done by validate_ibt_insn() */
4515		if (sec->sh.sh_flags & SHF_EXECINSTR)
4516			continue;
4517
4518		if (!sec->rsec)
4519			continue;
4520
4521		/*
4522		 * These sections can reference text addresses, but not with
4523		 * the intent to indirect branch to them.
4524		 */
4525		if ((!strncmp(sec->name, ".discard", 8) &&
4526		     strcmp(sec->name, ".discard.ibt_endbr_noseal"))	||
4527		    !strncmp(sec->name, ".debug", 6)			||
4528		    !strcmp(sec->name, ".altinstructions")		||
4529		    !strcmp(sec->name, ".ibt_endbr_seal")		||
4530		    !strcmp(sec->name, ".orc_unwind_ip")		||
4531		    !strcmp(sec->name, ".parainstructions")		||
4532		    !strcmp(sec->name, ".retpoline_sites")		||
4533		    !strcmp(sec->name, ".smp_locks")			||
4534		    !strcmp(sec->name, ".static_call_sites")		||
4535		    !strcmp(sec->name, "_error_injection_whitelist")	||
4536		    !strcmp(sec->name, "_kprobe_blacklist")		||
4537		    !strcmp(sec->name, "__bug_table")			||
4538		    !strcmp(sec->name, "__ex_table")			||
4539		    !strcmp(sec->name, "__jump_table")			||
4540		    !strcmp(sec->name, "__mcount_loc")			||
4541		    !strcmp(sec->name, ".kcfi_traps")			||
4542		    !strcmp(sec->name, ".llvm.call-graph-profile")	||
4543		    !strcmp(sec->name, ".llvm_bb_addr_map")		||
4544		    !strcmp(sec->name, "__tracepoints")			||
4545		    strstr(sec->name, "__patchable_function_entries"))
4546			continue;
4547
4548		for_each_reloc(sec->rsec, reloc)
4549			warnings += validate_ibt_data_reloc(file, reloc);
4550	}
4551
4552	return warnings;
4553}
4554
4555static int validate_sls(struct objtool_file *file)
4556{
4557	struct instruction *insn, *next_insn;
4558	int warnings = 0;
4559
4560	for_each_insn(file, insn) {
4561		next_insn = next_insn_same_sec(file, insn);
4562
4563		if (insn->retpoline_safe)
4564			continue;
4565
4566		switch (insn->type) {
4567		case INSN_RETURN:
4568			if (!next_insn || next_insn->type != INSN_TRAP) {
4569				WARN_INSN(insn, "missing int3 after ret");
 
4570				warnings++;
4571			}
4572
4573			break;
4574		case INSN_JUMP_DYNAMIC:
4575			if (!next_insn || next_insn->type != INSN_TRAP) {
4576				WARN_INSN(insn, "missing int3 after indirect jump");
 
4577				warnings++;
4578			}
4579			break;
4580		default:
4581			break;
4582		}
4583	}
4584
4585	return warnings;
4586}
4587
4588static bool ignore_noreturn_call(struct instruction *insn)
4589{
4590	struct symbol *call_dest = insn_call_dest(insn);
4591
4592	/*
4593	 * FIXME: hack, we need a real noreturn solution
4594	 *
4595	 * Problem is, exc_double_fault() may or may not return, depending on
4596	 * whether CONFIG_X86_ESPFIX64 is set.  But objtool has no visibility
4597	 * to the kernel config.
4598	 *
4599	 * Other potential ways to fix it:
4600	 *
4601	 *   - have compiler communicate __noreturn functions somehow
4602	 *   - remove CONFIG_X86_ESPFIX64
4603	 *   - read the .config file
4604	 *   - add a cmdline option
4605	 *   - create a generic objtool annotation format (vs a bunch of custom
4606	 *     formats) and annotate it
4607	 */
4608	if (!strcmp(call_dest->name, "exc_double_fault")) {
4609		/* prevent further unreachable warnings for the caller */
4610		insn->sym->warned = 1;
4611		return true;
4612	}
4613
4614	return false;
4615}
4616
4617static int validate_reachable_instructions(struct objtool_file *file)
4618{
4619	struct instruction *insn, *prev_insn;
4620	struct symbol *call_dest;
4621	int warnings = 0;
4622
4623	if (file->ignore_unreachables)
4624		return 0;
4625
4626	for_each_insn(file, insn) {
4627		if (insn->visited || ignore_unreachable_insn(file, insn))
4628			continue;
4629
4630		prev_insn = prev_insn_same_sec(file, insn);
4631		if (prev_insn && prev_insn->dead_end) {
4632			call_dest = insn_call_dest(prev_insn);
4633			if (call_dest && !ignore_noreturn_call(prev_insn)) {
4634				WARN_INSN(insn, "%s() is missing a __noreturn annotation",
4635					  call_dest->name);
4636				warnings++;
4637				continue;
4638			}
4639		}
4640
4641		WARN_INSN(insn, "unreachable instruction");
4642		warnings++;
4643	}
4644
4645	return warnings;
4646}
4647
4648/* 'funcs' is a space-separated list of function names */
4649static int disas_funcs(const char *funcs)
4650{
4651	const char *objdump_str, *cross_compile;
4652	int size, ret;
4653	char *cmd;
4654
4655	cross_compile = getenv("CROSS_COMPILE");
4656
4657	objdump_str = "%sobjdump -wdr %s | gawk -M -v _funcs='%s' '"
4658			"BEGIN { split(_funcs, funcs); }"
4659			"/^$/ { func_match = 0; }"
4660			"/<.*>:/ { "
4661				"f = gensub(/.*<(.*)>:/, \"\\\\1\", 1);"
4662				"for (i in funcs) {"
4663					"if (funcs[i] == f) {"
4664						"func_match = 1;"
4665						"base = strtonum(\"0x\" $1);"
4666						"break;"
4667					"}"
4668				"}"
4669			"}"
4670			"{"
4671				"if (func_match) {"
4672					"addr = strtonum(\"0x\" $1);"
4673					"printf(\"%%04x \", addr - base);"
4674					"print;"
4675				"}"
4676			"}' 1>&2";
4677
4678	/* fake snprintf() to calculate the size */
4679	size = snprintf(NULL, 0, objdump_str, cross_compile, objname, funcs) + 1;
4680	if (size <= 0) {
4681		WARN("objdump string size calculation failed");
4682		return -1;
4683	}
4684
4685	cmd = malloc(size);
4686
4687	/* real snprintf() */
4688	snprintf(cmd, size, objdump_str, cross_compile, objname, funcs);
4689	ret = system(cmd);
4690	if (ret) {
4691		WARN("disassembly failed: %d", ret);
4692		return -1;
4693	}
4694
4695	return 0;
4696}
4697
4698static int disas_warned_funcs(struct objtool_file *file)
4699{
4700	struct symbol *sym;
4701	char *funcs = NULL, *tmp;
4702
4703	for_each_sym(file, sym) {
4704		if (sym->warned) {
4705			if (!funcs) {
4706				funcs = malloc(strlen(sym->name) + 1);
4707				strcpy(funcs, sym->name);
4708			} else {
4709				tmp = malloc(strlen(funcs) + strlen(sym->name) + 2);
4710				sprintf(tmp, "%s %s", funcs, sym->name);
4711				free(funcs);
4712				funcs = tmp;
4713			}
4714		}
4715	}
4716
4717	if (funcs)
4718		disas_funcs(funcs);
4719
4720	return 0;
4721}
4722
4723struct insn_chunk {
4724	void *addr;
4725	struct insn_chunk *next;
4726};
4727
4728/*
4729 * Reduce peak RSS usage by freeing insns memory before writing the ELF file,
4730 * which can trigger more allocations for .debug_* sections whose data hasn't
4731 * been read yet.
4732 */
4733static void free_insns(struct objtool_file *file)
4734{
4735	struct instruction *insn;
4736	struct insn_chunk *chunks = NULL, *chunk;
4737
4738	for_each_insn(file, insn) {
4739		if (!insn->idx) {
4740			chunk = malloc(sizeof(*chunk));
4741			chunk->addr = insn;
4742			chunk->next = chunks;
4743			chunks = chunk;
4744		}
4745	}
4746
4747	for (chunk = chunks; chunk; chunk = chunk->next)
4748		free(chunk->addr);
4749}
4750
4751int check(struct objtool_file *file)
4752{
4753	int ret, warnings = 0;
4754
4755	arch_initial_func_cfi_state(&initial_func_cfi);
4756	init_cfi_state(&init_cfi);
4757	init_cfi_state(&func_cfi);
4758	set_func_state(&func_cfi);
4759	init_cfi_state(&force_undefined_cfi);
4760	force_undefined_cfi.force_undefined = true;
4761
4762	if (!cfi_hash_alloc(1UL << (file->elf->symbol_bits - 3)))
4763		goto out;
4764
4765	cfi_hash_add(&init_cfi);
4766	cfi_hash_add(&func_cfi);
4767
4768	ret = decode_sections(file);
4769	if (ret < 0)
4770		goto out;
4771
4772	warnings += ret;
4773
4774	if (!nr_insns)
4775		goto out;
4776
4777	if (opts.retpoline) {
4778		ret = validate_retpoline(file);
4779		if (ret < 0)
4780			return ret;
4781		warnings += ret;
4782	}
4783
4784	if (opts.stackval || opts.orc || opts.uaccess) {
4785		ret = validate_functions(file);
4786		if (ret < 0)
4787			goto out;
4788		warnings += ret;
4789
4790		ret = validate_unwind_hints(file, NULL);
4791		if (ret < 0)
4792			goto out;
4793		warnings += ret;
4794
4795		if (!warnings) {
4796			ret = validate_reachable_instructions(file);
4797			if (ret < 0)
4798				goto out;
4799			warnings += ret;
4800		}
4801
4802	} else if (opts.noinstr) {
4803		ret = validate_noinstr_sections(file);
4804		if (ret < 0)
4805			goto out;
4806		warnings += ret;
4807	}
4808
4809	if (opts.unret) {
4810		/*
4811		 * Must be after validate_branch() and friends, it plays
4812		 * further games with insn->visited.
4813		 */
4814		ret = validate_unrets(file);
4815		if (ret < 0)
4816			return ret;
4817		warnings += ret;
4818	}
4819
4820	if (opts.ibt) {
4821		ret = validate_ibt(file);
4822		if (ret < 0)
4823			goto out;
4824		warnings += ret;
4825	}
4826
4827	if (opts.sls) {
4828		ret = validate_sls(file);
4829		if (ret < 0)
4830			goto out;
4831		warnings += ret;
4832	}
4833
4834	if (opts.static_call) {
4835		ret = create_static_call_sections(file);
4836		if (ret < 0)
4837			goto out;
4838		warnings += ret;
4839	}
4840
4841	if (opts.retpoline) {
4842		ret = create_retpoline_sites_sections(file);
4843		if (ret < 0)
4844			goto out;
4845		warnings += ret;
4846	}
4847
4848	if (opts.cfi) {
4849		ret = create_cfi_sections(file);
4850		if (ret < 0)
4851			goto out;
4852		warnings += ret;
4853	}
4854
4855	if (opts.rethunk) {
4856		ret = create_return_sites_sections(file);
4857		if (ret < 0)
4858			goto out;
4859		warnings += ret;
4860
4861		if (opts.hack_skylake) {
4862			ret = create_direct_call_sections(file);
4863			if (ret < 0)
4864				goto out;
4865			warnings += ret;
4866		}
4867	}
4868
4869	if (opts.mcount) {
4870		ret = create_mcount_loc_sections(file);
4871		if (ret < 0)
4872			goto out;
4873		warnings += ret;
4874	}
4875
4876	if (opts.prefix) {
4877		ret = add_prefix_symbols(file);
4878		if (ret < 0)
4879			return ret;
4880		warnings += ret;
4881	}
4882
4883	if (opts.ibt) {
4884		ret = create_ibt_endbr_seal_sections(file);
4885		if (ret < 0)
4886			goto out;
4887		warnings += ret;
4888	}
4889
4890	if (opts.orc && nr_insns) {
4891		ret = orc_create(file);
4892		if (ret < 0)
4893			goto out;
4894		warnings += ret;
4895	}
4896
4897	free_insns(file);
4898
4899	if (opts.verbose)
4900		disas_warned_funcs(file);
4901
4902	if (opts.stats) {
4903		printf("nr_insns_visited: %ld\n", nr_insns_visited);
4904		printf("nr_cfi: %ld\n", nr_cfi);
4905		printf("nr_cfi_reused: %ld\n", nr_cfi_reused);
4906		printf("nr_cfi_cache: %ld\n", nr_cfi_cache);
4907	}
4908
4909out:
4910	/*
4911	 *  For now, don't fail the kernel build on fatal warnings.  These
4912	 *  errors are still fairly common due to the growing matrix of
4913	 *  supported toolchains and their recent pace of change.
4914	 */
4915	return 0;
4916}