elf_symtab.h

   1 #ifndef _ELF_SYMTAB_H_
   2 #define _ELF_SYMTAB_H_ 1
   3 /*
   4   SPDX-License-Identifier: GPL-2.0-only
   5
   6   Copyright (C) 2009 Red Hat Inc.
   7   Copyright (C) 2009 Arnaldo Carvalho de Melo <acme@redhat.com>
   8 */
   9
  10 #include <stdbool.h>
  11 #include <stdint.h>
  12 #include <gelf.h>
  13 #include <elf.h>
  14
  15 struct elf_symtab {
  16         uint32_t  nr_syms;
  17         Elf_Data  *syms;
  18         Elf_Data  *symstrs;
  19         /* Data of SHT_SYMTAB_SHNDX section. */
  20         Elf_Data  *syms_sec_idx_table;
  21         char      *name;
  22 };
  23
  24 struct elf_symtab *elf_symtab__new(const char *name, Elf *elf);
  25 void elf_symtab__delete(struct elf_symtab *symtab);
  26
  27 static inline uint32_t elf_symtab__nr_symbols(const struct elf_symtab *symtab)
  28 {
  29         return symtab->nr_syms;
  30 }
  31
  32 static inline const char *elf_sym__name(const GElf_Sym *sym,
  33                                         const struct elf_symtab *symtab)
  34 {
  35         return symtab->symstrs->d_buf + sym->st_name;
  36 }
  37
  38 static inline uint8_t elf_sym__type(const GElf_Sym *sym)
  39 {
  40         return GELF_ST_TYPE(sym->st_info);
  41 }
  42
  43 static inline uint16_t elf_sym__section(const GElf_Sym *sym)
  44 {
  45         return sym->st_shndx;
  46 }
  47
  48 static inline uint8_t elf_sym__bind(const GElf_Sym *sym)
  49 {
  50         return GELF_ST_BIND(sym->st_info);
  51 }
  52
  53 static inline uint8_t elf_sym__visibility(const GElf_Sym *sym)
  54 {
  55         return GELF_ST_VISIBILITY(sym->st_other);
  56 }
  57
  58 static inline uint32_t elf_sym__size(const GElf_Sym *sym)
  59 {
  60         return sym->st_size;
  61 }
  62
  63 static inline uint64_t elf_sym__value(const GElf_Sym *sym)
  64 {
  65         return sym->st_value;
  66 }
  67
  68 static inline bool elf_sym__is_local_function(const GElf_Sym *sym)
  69 {
  70         return elf_sym__type(sym) == STT_FUNC &&
  71                sym->st_name != 0 &&
  72                sym->st_shndx != SHN_UNDEF;
  73 }
  74
  75 static inline bool elf_sym__is_local_object(const GElf_Sym *sym)
  76 {
  77         return elf_sym__type(sym) == STT_OBJECT &&
  78                sym->st_name != 0 &&
  79                sym->st_shndx != SHN_UNDEF;
  80 }
  81
  82 static inline bool
  83 elf_sym__get(Elf_Data *syms, Elf_Data *syms_sec_idx_table,
  84              int id, GElf_Sym *sym, Elf32_Word *sym_sec_idx)
  85 {
  86         if (!gelf_getsymshndx(syms, syms_sec_idx_table, id, sym, sym_sec_idx))
  87                 return false;
  88
  89         if (sym->st_shndx != SHN_XINDEX)
  90                 *sym_sec_idx = sym->st_shndx;
  91
  92         return true;
  93 }
  94
  95 /**
  96  * elf_symtab__for_each_symbol - iterate thru all the symbols
  97  *
  98  * @symtab: struct elf_symtab instance to iterate
  99  * @index: uint32_t index
 100  * @sym: GElf_Sym iterator
 101  */
 102 #define elf_symtab__for_each_symbol(symtab, index, sym) \
 103         for (index = 0, gelf_getsym(symtab->syms, index, &sym);\
 104              index < symtab->nr_syms; \
 105              index++, gelf_getsym(symtab->syms, index, &sym))
 106
 107 /**
 108  * elf_symtab__for_each_symbol_index - iterate through all the symbols,
 109  * that takes extended symbols indexes into account
 110  *
 111  * @symtab: struct elf_symtab instance to iterate
 112  * @index: uint32_t index
 113  * @sym: GElf_Sym iterator
 114  * @sym_sec_idx: symbol's index
 115  */
 116 #define elf_symtab__for_each_symbol_index(symtab, id, sym, sym_sec_idx)         \
 117         for (id = 0; id < symtab->nr_syms; id++)                                \
 118                 if (elf_sym__get(symtab->syms, symtab->syms_sec_idx_table,      \
 119                                  id, &sym, &sym_sec_idx))
 120
 121 #endif /* _ELF_SYMTAB_H_ */