1/* SPDX-License-Identifier: GPL-2.0-or-later */
 2/*
 3 * Copyright (C) 2015 Josh Poimboeuf <jpoimboe@redhat.com>
 4 */
 5
 6#ifndef _ARCH_H
 7#define _ARCH_H
 8
 9#include <stdbool.h>
10#include <linux/list.h>
11#include <objtool/objtool.h>
12#include <objtool/cfi.h>
13
14enum insn_type {
15	INSN_JUMP_CONDITIONAL,
16	INSN_JUMP_UNCONDITIONAL,
17	INSN_JUMP_DYNAMIC,
18	INSN_JUMP_DYNAMIC_CONDITIONAL,
19	INSN_CALL,
20	INSN_CALL_DYNAMIC,
21	INSN_RETURN,
22	INSN_CONTEXT_SWITCH,
23	INSN_BUG,
24	INSN_NOP,
25	INSN_STAC,
26	INSN_CLAC,
27	INSN_STD,
28	INSN_CLD,
29	INSN_TRAP,
30	INSN_ENDBR,
31	INSN_OTHER,
32};
33
34enum op_dest_type {
35	OP_DEST_REG,
36	OP_DEST_REG_INDIRECT,
37	OP_DEST_MEM,
38	OP_DEST_PUSH,
39	OP_DEST_PUSHF,
40};
41
42struct op_dest {
43	enum op_dest_type type;
44	unsigned char reg;
45	int offset;
46};
47
48enum op_src_type {
49	OP_SRC_REG,
50	OP_SRC_REG_INDIRECT,
51	OP_SRC_CONST,
52	OP_SRC_POP,
53	OP_SRC_POPF,
54	OP_SRC_ADD,
55	OP_SRC_AND,
56};
57
58struct op_src {
59	enum op_src_type type;
60	unsigned char reg;
61	int offset;
62};
63
64struct stack_op {
65	struct stack_op *next;
66	struct op_dest dest;
67	struct op_src src;
68};
69
70struct instruction;
71
72int arch_ftrace_match(char *name);
73
74void arch_initial_func_cfi_state(struct cfi_init_state *state);
75
76int arch_decode_instruction(struct objtool_file *file, const struct section *sec,
77			    unsigned long offset, unsigned int maxlen,
78			    struct instruction *insn);
79
80bool arch_callee_saved_reg(unsigned char reg);
81
82unsigned long arch_jump_destination(struct instruction *insn);
83
84unsigned long arch_dest_reloc_offset(int addend);
85
86const char *arch_nop_insn(int len);
87const char *arch_ret_insn(int len);
88
89int arch_decode_hint_reg(u8 sp_reg, int *base);
90
91bool arch_is_retpoline(struct symbol *sym);
92bool arch_is_rethunk(struct symbol *sym);
93bool arch_is_embedded_insn(struct symbol *sym);
94
95int arch_rewrite_retpolines(struct objtool_file *file);
96
97bool arch_pc_relative_reloc(struct reloc *reloc);
98
99#endif /* _ARCH_H */