tools/objtool/include/objtool/elf.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 /*
   3  * Copyright (C) 2015 Josh Poimboeuf <jpoimboe@redhat.com>
   4  */
   5
   6 #ifndef _OBJTOOL_ELF_H
   7 #define _OBJTOOL_ELF_H
   8
   9 #include <stdio.h>
  10 #include <gelf.h>
  11 #include <linux/list.h>
  12 #include <linux/hashtable.h>
  13 #include <linux/rbtree.h>
  14 #include <linux/jhash.h>
  15
  16 #ifdef LIBELF_USE_DEPRECATED
  17 # define elf_getshdrnum    elf_getshnum
  18 # define elf_getshdrstrndx elf_getshstrndx
  19 #endif
  20
  21 /*
  22  * Fallback for systems without this "read, mmaping if possible" cmd.
  23  */
  24 #ifndef ELF_C_READ_MMAP
  25 #define ELF_C_READ_MMAP ELF_C_READ
  26 #endif
  27
  28 struct section {
  29         struct list_head list;
  30         struct hlist_node hash;
  31         struct hlist_node name_hash;
  32         GElf_Shdr sh;
  33         struct rb_root symbol_tree;
  34         struct list_head symbol_list;
  35         struct list_head reloc_list;
  36         struct section *base, *reloc;
  37         struct symbol *sym;
  38         Elf_Data *data;
  39         char *name;
  40         int idx;
  41         bool changed, text, rodata, noinstr;
  42 };
  43
  44 struct symbol {
  45         struct list_head list;
  46         struct rb_node node;
  47         struct hlist_node hash;
  48         struct hlist_node name_hash;
  49         GElf_Sym sym;
  50         struct section *sec;
  51         char *name;
  52         unsigned int idx;
  53         unsigned char bind, type;
  54         unsigned long offset;
  55         unsigned int len;
  56         struct symbol *pfunc, *cfunc, *alias;
  57         u8 uaccess_safe      : 1;
  58         u8 static_call_tramp : 1;
  59         u8 retpoline_thunk   : 1;
  60         u8 return_thunk      : 1;
  61         u8 fentry            : 1;
  62         u8 profiling_func    : 1;
  63         u8 embedded_insn     : 1;
  64         struct list_head pv_target;
  65 };
  66
  67 struct reloc {
  68         struct list_head list;
  69         struct hlist_node hash;
  70         union {
  71                 GElf_Rela rela;
  72                 GElf_Rel  rel;
  73         };
  74         struct section *sec;
  75         struct symbol *sym;
  76         unsigned long offset;
  77         unsigned int type;
  78         s64 addend;
  79         int idx;
  80         bool jump_table_start;
  81 };
  82
  83 #define ELF_HASH_BITS   20
  84
  85 struct elf {
  86         Elf *elf;
  87         GElf_Ehdr ehdr;
  88         int fd;
  89         bool changed;
  90         char *name;
  91         unsigned int text_size, num_files;
  92         struct list_head sections;
  93
  94         int symbol_bits;
  95         int symbol_name_bits;
  96         int section_bits;
  97         int section_name_bits;
  98         int reloc_bits;
  99
 100         struct hlist_head *symbol_hash;
 101         struct hlist_head *symbol_name_hash;
 102         struct hlist_head *section_hash;
 103         struct hlist_head *section_name_hash;
 104         struct hlist_head *reloc_hash;
 105 };
 106
 107 #define OFFSET_STRIDE_BITS      4
 108 #define OFFSET_STRIDE           (1UL << OFFSET_STRIDE_BITS)
 109 #define OFFSET_STRIDE_MASK      (~(OFFSET_STRIDE - 1))
 110
 111 #define for_offset_range(_offset, _start, _end)                 \
 112         for (_offset = ((_start) & OFFSET_STRIDE_MASK);         \
 113              _offset >= ((_start) & OFFSET_STRIDE_MASK) &&      \
 114              _offset <= ((_end) & OFFSET_STRIDE_MASK);          \
 115              _offset += OFFSET_STRIDE)
 116
 117 static inline u32 sec_offset_hash(struct section *sec, unsigned long offset)
 118 {
 119         u32 ol, oh, idx = sec->idx;
 120
 121         offset &= OFFSET_STRIDE_MASK;
 122
 123         ol = offset;
 124         oh = (offset >> 16) >> 16;
 125
 126         __jhash_mix(ol, oh, idx);
 127
 128         return ol;
 129 }
 130
 131 static inline u32 reloc_hash(struct reloc *reloc)
 132 {
 133         return sec_offset_hash(reloc->sec, reloc->offset);
 134 }
 135
 136 /*
 137  * Try to see if it's a whole archive (vmlinux.o or module).
 138  *
 139  * Note this will miss the case where a module only has one source file.
 140  */
 141 static inline bool has_multiple_files(struct elf *elf)
 142 {
 143         return elf->num_files > 1;
 144 }
 145
 146 struct elf *elf_open_read(const char *name, int flags);
 147 struct section *elf_create_section(struct elf *elf, const char *name, unsigned int sh_flags, size_t entsize, int nr);
 148
 149 int elf_add_reloc(struct elf *elf, struct section *sec, unsigned long offset,
 150                   unsigned int type, struct symbol *sym, s64 addend);
 151 int elf_add_reloc_to_insn(struct elf *elf, struct section *sec,
 152                           unsigned long offset, unsigned int type,
 153                           struct section *insn_sec, unsigned long insn_off);
 154
 155 int elf_write_insn(struct elf *elf, struct section *sec,
 156                    unsigned long offset, unsigned int len,
 157                    const char *insn);
 158 int elf_write_reloc(struct elf *elf, struct reloc *reloc);
 159 int elf_write(struct elf *elf);
 160 void elf_close(struct elf *elf);
 161
 162 struct section *find_section_by_name(const struct elf *elf, const char *name);
 163 struct symbol *find_func_by_offset(struct section *sec, unsigned long offset);
 164 struct symbol *find_symbol_by_offset(struct section *sec, unsigned long offset);
 165 struct symbol *find_symbol_by_name(const struct elf *elf, const char *name);
 166 struct symbol *find_symbol_containing(const struct section *sec, unsigned long offset);
 167 int find_symbol_hole_containing(const struct section *sec, unsigned long offset);
 168 struct reloc *find_reloc_by_dest(const struct elf *elf, struct section *sec, unsigned long offset);
 169 struct reloc *find_reloc_by_dest_range(const struct elf *elf, struct section *sec,
 170                                      unsigned long offset, unsigned int len);
 171 struct symbol *find_func_containing(struct section *sec, unsigned long offset);
 172
 173 #define for_each_sec(file, sec)                                         \
 174         list_for_each_entry(sec, &file->elf->sections, list)
 175
 176 #endif /* _OBJTOOL_ELF_H */