tools/objtool/include/objtool/arch.h

   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
  14 enum 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_OTHER,
  31 };
  32
  33 enum op_dest_type {
  34         OP_DEST_REG,
  35         OP_DEST_REG_INDIRECT,
  36         OP_DEST_MEM,
  37         OP_DEST_PUSH,
  38         OP_DEST_PUSHF,
  39 };
  40
  41 struct op_dest {
  42         enum op_dest_type type;
  43         unsigned char reg;
  44         int offset;
  45 };
  46
  47 enum op_src_type {
  48         OP_SRC_REG,
  49         OP_SRC_REG_INDIRECT,
  50         OP_SRC_CONST,
  51         OP_SRC_POP,
  52         OP_SRC_POPF,
  53         OP_SRC_ADD,
  54         OP_SRC_AND,
  55 };
  56
  57 struct op_src {
  58         enum op_src_type type;
  59         unsigned char reg;
  60         int offset;
  61 };
  62
  63 struct stack_op {
  64         struct op_dest dest;
  65         struct op_src src;
  66         struct list_head list;
  67 };
  68
  69 struct instruction;
  70
  71 void arch_initial_func_cfi_state(struct cfi_init_state *state);
  72
  73 int arch_decode_instruction(const struct elf *elf, const struct section *sec,
  74                             unsigned long offset, unsigned int maxlen,
  75                             unsigned int *len, enum insn_type *type,
  76                             unsigned long *immediate,
  77                             struct list_head *ops_list);
  78
  79 bool arch_callee_saved_reg(unsigned char reg);
  80
  81 unsigned long arch_jump_destination(struct instruction *insn);
  82
  83 unsigned long arch_dest_reloc_offset(int addend);
  84
  85 const char *arch_nop_insn(int len);
  86 const char *arch_ret_insn(int len);
  87
  88 int arch_decode_hint_reg(u8 sp_reg, int *base);
  89
  90 bool arch_is_retpoline(struct symbol *sym);
  91 bool arch_is_rethunk(struct symbol *sym);
  92
  93 int arch_rewrite_retpolines(struct objtool_file *file);
  94
  95 #endif /* _ARCH_H */