tools/perf/util/map.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef __PERF_MAP_H
   3 #define __PERF_MAP_H
   4
   5 #include <linux/refcount.h>
   6 #include <linux/compiler.h>
   7 #include <linux/list.h>
   8 #include <linux/rbtree.h>
   9 #include <stdio.h>
  10 #include <string.h>
  11 #include <stdbool.h>
  12 #include <linux/types.h>
  13
  14 struct dso;
  15 struct ip_callchain;
  16 struct ref_reloc_sym;
  17 struct map_groups;
  18 struct machine;
  19 struct evsel;
  20
  21 struct map {
  22         union {
  23                 struct rb_node  rb_node;
  24                 struct list_head node;
  25         };
  26         u64                     start;
  27         u64                     end;
  28         bool                    erange_warned:1;
  29         bool                    priv:1;
  30         u32                     prot;
  31         u64                     pgoff;
  32         u64                     reloc;
  33         u32                     maj, min; /* only valid for MMAP2 record */
  34         u64                     ino;      /* only valid for MMAP2 record */
  35         u64                     ino_generation;/* only valid for MMAP2 record */
  36
  37         /* ip -> dso rip */
  38         u64                     (*map_ip)(struct map *, u64);
  39         /* dso rip -> ip */
  40         u64                     (*unmap_ip)(struct map *, u64);
  41
  42         struct dso              *dso;
  43         refcount_t              refcnt;
  44         u32                     flags;
  45 };
  46
  47 struct kmap;
  48
  49 struct kmap *__map__kmap(struct map *map);
  50 struct kmap *map__kmap(struct map *map);
  51 struct map_groups *map__kmaps(struct map *map);
  52
  53 static inline u64 map__map_ip(struct map *map, u64 ip)
  54 {
  55         return ip - map->start + map->pgoff;
  56 }
  57
  58 static inline u64 map__unmap_ip(struct map *map, u64 ip)
  59 {
  60         return ip + map->start - map->pgoff;
  61 }
  62
  63 static inline u64 identity__map_ip(struct map *map __maybe_unused, u64 ip)
  64 {
  65         return ip;
  66 }
  67
  68 static inline size_t map__size(const struct map *map)
  69 {
  70         return map->end - map->start;
  71 }
  72
  73 /* rip/ip <-> addr suitable for passing to `objdump --start-address=` */
  74 u64 map__rip_2objdump(struct map *map, u64 rip);
  75
  76 /* objdump address -> memory address */
  77 u64 map__objdump_2mem(struct map *map, u64 ip);
  78
  79 struct symbol;
  80 struct thread;
  81
  82 /* map__for_each_symbol - iterate over the symbols in the given map
  83  *
  84  * @map: the 'struct map *' in which symbols itereated
  85  * @pos: the 'struct symbol *' to use as a loop cursor
  86  * @n: the 'struct rb_node *' to use as a temporary storage
  87  * Note: caller must ensure map->dso is not NULL (map is loaded).
  88  */
  89 #define map__for_each_symbol(map, pos, n)       \
  90         dso__for_each_symbol(map->dso, pos, n)
  91
  92 /* map__for_each_symbol_with_name - iterate over the symbols in the given map
  93  *                                  that have the given name
  94  *
  95  * @map: the 'struct map *' in which symbols itereated
  96  * @sym_name: the symbol name
  97  * @pos: the 'struct symbol *' to use as a loop cursor
  98  */
  99 #define __map__for_each_symbol_by_name(map, sym_name, pos)      \
 100         for (pos = map__find_symbol_by_name(map, sym_name);     \
 101              pos &&                                             \
 102              !symbol__match_symbol_name(pos->name, sym_name,    \
 103                                         SYMBOL_TAG_INCLUDE__DEFAULT_ONLY); \
 104              pos = symbol__next_by_name(pos))
 105
 106 #define map__for_each_symbol_by_name(map, sym_name, pos)                \
 107         __map__for_each_symbol_by_name(map, sym_name, (pos))
 108
 109 void map__init(struct map *map,
 110                u64 start, u64 end, u64 pgoff, struct dso *dso);
 111 struct map *map__new(struct machine *machine, u64 start, u64 len,
 112                      u64 pgoff, u32 d_maj, u32 d_min, u64 ino,
 113                      u64 ino_gen, u32 prot, u32 flags,
 114                      char *filename, struct thread *thread);
 115 struct map *map__new2(u64 start, struct dso *dso);
 116 void map__delete(struct map *map);
 117 struct map *map__clone(struct map *map);
 118
 119 static inline struct map *map__get(struct map *map)
 120 {
 121         if (map)
 122                 refcount_inc(&map->refcnt);
 123         return map;
 124 }
 125
 126 void map__put(struct map *map);
 127
 128 static inline void __map__zput(struct map **map)
 129 {
 130         map__put(*map);
 131         *map = NULL;
 132 }
 133
 134 #define map__zput(map) __map__zput(&map)
 135
 136 size_t map__fprintf(struct map *map, FILE *fp);
 137 size_t map__fprintf_dsoname(struct map *map, FILE *fp);
 138 char *map__srcline(struct map *map, u64 addr, struct symbol *sym);
 139 int map__fprintf_srcline(struct map *map, u64 addr, const char *prefix,
 140                          FILE *fp);
 141
 142 struct srccode_state;
 143
 144 int map__fprintf_srccode(struct map *map, u64 addr,
 145                          FILE *fp, struct srccode_state *state);
 146
 147 int map__load(struct map *map);
 148 struct symbol *map__find_symbol(struct map *map, u64 addr);
 149 struct symbol *map__find_symbol_by_name(struct map *map, const char *name);
 150 void map__fixup_start(struct map *map);
 151 void map__fixup_end(struct map *map);
 152
 153 void map__reloc_vmlinux(struct map *map);
 154
 155 int map__set_kallsyms_ref_reloc_sym(struct map *map, const char *symbol_name,
 156                                     u64 addr);
 157
 158 bool __map__is_kernel(const struct map *map);
 159 bool __map__is_extra_kernel_map(const struct map *map);
 160 bool __map__is_bpf_prog(const struct map *map);
 161
 162 static inline bool __map__is_kmodule(const struct map *map)
 163 {
 164         return !__map__is_kernel(map) && !__map__is_extra_kernel_map(map) &&
 165                !__map__is_bpf_prog(map);
 166 }
 167
 168 bool map__has_symbols(const struct map *map);
 169
 170 #define ENTRY_TRAMPOLINE_NAME "__entry_SYSCALL_64_trampoline"
 171
 172 static inline bool is_entry_trampoline(const char *name)
 173 {
 174         return !strcmp(name, ENTRY_TRAMPOLINE_NAME);
 175 }
 176
 177 #endif /* __PERF_MAP_H */