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
  34         /* ip -> dso rip */
  35         u64                     (*map_ip)(struct map *, u64);
  36         /* dso rip -> ip */
  37         u64                     (*unmap_ip)(struct map *, u64);
  38
  39         struct dso              *dso;
  40         refcount_t              refcnt;
  41         u32                     flags;
  42 };
  43
  44 struct kmap;
  45
  46 struct kmap *__map__kmap(struct map *map);
  47 struct kmap *map__kmap(struct map *map);
  48 struct map_groups *map__kmaps(struct map *map);
  49
  50 static inline u64 map__map_ip(struct map *map, u64 ip)
  51 {
  52         return ip - map->start + map->pgoff;
  53 }
  54
  55 static inline u64 map__unmap_ip(struct map *map, u64 ip)
  56 {
  57         return ip + map->start - map->pgoff;
  58 }
  59
  60 static inline u64 identity__map_ip(struct map *map __maybe_unused, u64 ip)
  61 {
  62         return ip;
  63 }
  64
  65 static inline size_t map__size(const struct map *map)
  66 {
  67         return map->end - map->start;
  68 }
  69
  70 /* rip/ip <-> addr suitable for passing to `objdump --start-address=` */
  71 u64 map__rip_2objdump(struct map *map, u64 rip);
  72
  73 /* objdump address -> memory address */
  74 u64 map__objdump_2mem(struct map *map, u64 ip);
  75
  76 struct symbol;
  77 struct thread;
  78
  79 /* map__for_each_symbol - iterate over the symbols in the given map
  80  *
  81  * @map: the 'struct map *' in which symbols itereated
  82  * @pos: the 'struct symbol *' to use as a loop cursor
  83  * @n: the 'struct rb_node *' to use as a temporary storage
  84  * Note: caller must ensure map->dso is not NULL (map is loaded).
  85  */
  86 #define map__for_each_symbol(map, pos, n)       \
  87         dso__for_each_symbol(map->dso, pos, n)
  88
  89 /* map__for_each_symbol_with_name - iterate over the symbols in the given map
  90  *                                  that have the given name
  91  *
  92  * @map: the 'struct map *' in which symbols itereated
  93  * @sym_name: the symbol name
  94  * @pos: the 'struct symbol *' to use as a loop cursor
  95  */
  96 #define __map__for_each_symbol_by_name(map, sym_name, pos)      \
  97         for (pos = map__find_symbol_by_name(map, sym_name);     \
  98              pos &&                                             \
  99              !symbol__match_symbol_name(pos->name, sym_name,    \
 100                                         SYMBOL_TAG_INCLUDE__DEFAULT_ONLY); \
 101              pos = symbol__next_by_name(pos))
 102
 103 #define map__for_each_symbol_by_name(map, sym_name, pos)                \
 104         __map__for_each_symbol_by_name(map, sym_name, (pos))
 105
 106 void map__init(struct map *map,
 107                u64 start, u64 end, u64 pgoff, struct dso *dso);
 108
 109 struct dso_id;
 110
 111 struct map *map__new(struct machine *machine, u64 start, u64 len,
 112                      u64 pgoff, struct dso_id *id, u32 prot, u32 flags,
 113                      char *filename, struct thread *thread);
 114 struct map *map__new2(u64 start, struct dso *dso);
 115 void map__delete(struct map *map);
 116 struct map *map__clone(struct map *map);
 117
 118 static inline struct map *map__get(struct map *map)
 119 {
 120         if (map)
 121                 refcount_inc(&map->refcnt);
 122         return map;
 123 }
 124
 125 void map__put(struct map *map);
 126
 127 static inline void __map__zput(struct map **map)
 128 {
 129         map__put(*map);
 130         *map = NULL;
 131 }
 132
 133 #define map__zput(map) __map__zput(&map)
 134
 135 size_t map__fprintf(struct map *map, FILE *fp);
 136 size_t map__fprintf_dsoname(struct map *map, FILE *fp);
 137 char *map__srcline(struct map *map, u64 addr, struct symbol *sym);
 138 int map__fprintf_srcline(struct map *map, u64 addr, const char *prefix,
 139                          FILE *fp);
 140
 141 struct srccode_state;
 142
 143 int map__fprintf_srccode(struct map *map, u64 addr,
 144                          FILE *fp, struct srccode_state *state);
 145
 146 int map__load(struct map *map);
 147 struct symbol *map__find_symbol(struct map *map, u64 addr);
 148 struct symbol *map__find_symbol_by_name(struct map *map, const char *name);
 149 void map__fixup_start(struct map *map);
 150 void map__fixup_end(struct map *map);
 151
 152 void map__reloc_vmlinux(struct map *map);
 153
 154 int map__set_kallsyms_ref_reloc_sym(struct map *map, const char *symbol_name,
 155                                     u64 addr);
 156
 157 bool __map__is_kernel(const struct map *map);
 158 bool __map__is_extra_kernel_map(const struct map *map);
 159 bool __map__is_bpf_prog(const struct map *map);
 160
 161 static inline bool __map__is_kmodule(const struct map *map)
 162 {
 163         return !__map__is_kernel(map) && !__map__is_extra_kernel_map(map) &&
 164                !__map__is_bpf_prog(map);
 165 }
 166
 167 bool map__has_symbols(const struct map *map);
 168
 169 #define ENTRY_TRAMPOLINE_NAME "__entry_SYSCALL_64_trampoline"
 170
 171 static inline bool is_entry_trampoline(const char *name)
 172 {
 173         return !strcmp(name, ENTRY_TRAMPOLINE_NAME);
 174 }
 175
 176 #endif /* __PERF_MAP_H */