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 <pthread.h>
  10 #include <stdio.h>
  11 #include <stdbool.h>
  12 #include <linux/types.h>
  13 #include "rwsem.h"
  14
  15 enum map_type {
  16         MAP__FUNCTION = 0,
  17         MAP__VARIABLE,
  18 };
  19
  20 #define MAP__NR_TYPES (MAP__VARIABLE + 1)
  21
  22 extern const char *map_type__name[MAP__NR_TYPES];
  23
  24 struct dso;
  25 struct ip_callchain;
  26 struct ref_reloc_sym;
  27 struct map_groups;
  28 struct machine;
  29 struct perf_evsel;
  30
  31 struct map {
  32         union {
  33                 struct rb_node  rb_node;
  34                 struct list_head node;
  35         };
  36         u64                     start;
  37         u64                     end;
  38         u8 /* enum map_type */  type;
  39         bool                    erange_warned;
  40         u32                     priv;
  41         u32                     prot;
  42         u32                     flags;
  43         u64                     pgoff;
  44         u64                     reloc;
  45         u32                     maj, min; /* only valid for MMAP2 record */
  46         u64                     ino;      /* only valid for MMAP2 record */
  47         u64                     ino_generation;/* only valid for MMAP2 record */
  48
  49         /* ip -> dso rip */
  50         u64                     (*map_ip)(struct map *, u64);
  51         /* dso rip -> ip */
  52         u64                     (*unmap_ip)(struct map *, u64);
  53
  54         struct dso              *dso;
  55         struct map_groups       *groups;
  56         refcount_t              refcnt;
  57 };
  58
  59 struct kmap {
  60         struct ref_reloc_sym    *ref_reloc_sym;
  61         struct map_groups       *kmaps;
  62 };
  63
  64 struct maps {
  65         struct rb_root   entries;
  66         struct rw_semaphore lock;
  67 };
  68
  69 struct map_groups {
  70         struct maps      maps[MAP__NR_TYPES];
  71         struct machine   *machine;
  72         refcount_t       refcnt;
  73 };
  74
  75 struct map_groups *map_groups__new(struct machine *machine);
  76 void map_groups__delete(struct map_groups *mg);
  77 bool map_groups__empty(struct map_groups *mg);
  78
  79 static inline struct map_groups *map_groups__get(struct map_groups *mg)
  80 {
  81         if (mg)
  82                 refcount_inc(&mg->refcnt);
  83         return mg;
  84 }
  85
  86 void map_groups__put(struct map_groups *mg);
  87
  88 struct kmap *map__kmap(struct map *map);
  89 struct map_groups *map__kmaps(struct map *map);
  90
  91 static inline u64 map__map_ip(struct map *map, u64 ip)
  92 {
  93         return ip - map->start + map->pgoff;
  94 }
  95
  96 static inline u64 map__unmap_ip(struct map *map, u64 ip)
  97 {
  98         return ip + map->start - map->pgoff;
  99 }
 100
 101 static inline u64 identity__map_ip(struct map *map __maybe_unused, u64 ip)
 102 {
 103         return ip;
 104 }
 105
 106
 107 /* rip/ip <-> addr suitable for passing to `objdump --start-address=` */
 108 u64 map__rip_2objdump(struct map *map, u64 rip);
 109
 110 /* objdump address -> memory address */
 111 u64 map__objdump_2mem(struct map *map, u64 ip);
 112
 113 struct symbol;
 114 struct thread;
 115
 116 /* map__for_each_symbol - iterate over the symbols in the given map
 117  *
 118  * @map: the 'struct map *' in which symbols itereated
 119  * @pos: the 'struct symbol *' to use as a loop cursor
 120  * @n: the 'struct rb_node *' to use as a temporary storage
 121  * Note: caller must ensure map->dso is not NULL (map is loaded).
 122  */
 123 #define map__for_each_symbol(map, pos, n)       \
 124         dso__for_each_symbol(map->dso, pos, n, map->type)
 125
 126 /* map__for_each_symbol_with_name - iterate over the symbols in the given map
 127  *                                  that have the given name
 128  *
 129  * @map: the 'struct map *' in which symbols itereated
 130  * @sym_name: the symbol name
 131  * @pos: the 'struct symbol *' to use as a loop cursor
 132  */
 133 #define __map__for_each_symbol_by_name(map, sym_name, pos)      \
 134         for (pos = map__find_symbol_by_name(map, sym_name);     \
 135              pos &&                                             \
 136              !symbol__match_symbol_name(pos->name, sym_name,    \
 137                                         SYMBOL_TAG_INCLUDE__DEFAULT_ONLY); \
 138              pos = symbol__next_by_name(pos))
 139
 140 #define map__for_each_symbol_by_name(map, sym_name, pos)                \
 141         __map__for_each_symbol_by_name(map, sym_name, (pos))
 142
 143 void map__init(struct map *map, enum map_type type,
 144                u64 start, u64 end, u64 pgoff, struct dso *dso);
 145 struct map *map__new(struct machine *machine, u64 start, u64 len,
 146                      u64 pgoff, u32 d_maj, u32 d_min, u64 ino,
 147                      u64 ino_gen, u32 prot, u32 flags,
 148                      char *filename, enum map_type type, struct thread *thread);
 149 struct map *map__new2(u64 start, struct dso *dso, enum map_type type);
 150 void map__delete(struct map *map);
 151 struct map *map__clone(struct map *map);
 152
 153 static inline struct map *map__get(struct map *map)
 154 {
 155         if (map)
 156                 refcount_inc(&map->refcnt);
 157         return map;
 158 }
 159
 160 void map__put(struct map *map);
 161
 162 static inline void __map__zput(struct map **map)
 163 {
 164         map__put(*map);
 165         *map = NULL;
 166 }
 167
 168 #define map__zput(map) __map__zput(&map)
 169
 170 int map__overlap(struct map *l, struct map *r);
 171 size_t map__fprintf(struct map *map, FILE *fp);
 172 size_t map__fprintf_dsoname(struct map *map, FILE *fp);
 173 int map__fprintf_srcline(struct map *map, u64 addr, const char *prefix,
 174                          FILE *fp);
 175
 176 int map__load(struct map *map);
 177 struct symbol *map__find_symbol(struct map *map, u64 addr);
 178 struct symbol *map__find_symbol_by_name(struct map *map, const char *name);
 179 void map__fixup_start(struct map *map);
 180 void map__fixup_end(struct map *map);
 181
 182 void map__reloc_vmlinux(struct map *map);
 183
 184 size_t __map_groups__fprintf_maps(struct map_groups *mg, enum map_type type,
 185                                   FILE *fp);
 186 void maps__insert(struct maps *maps, struct map *map);
 187 void maps__remove(struct maps *maps, struct map *map);
 188 struct map *maps__find(struct maps *maps, u64 addr);
 189 struct map *maps__first(struct maps *maps);
 190 struct map *map__next(struct map *map);
 191 struct symbol *maps__find_symbol_by_name(struct maps *maps, const char *name,
 192                                          struct map **mapp);
 193 void map_groups__init(struct map_groups *mg, struct machine *machine);
 194 void map_groups__exit(struct map_groups *mg);
 195 int map_groups__clone(struct thread *thread,
 196                       struct map_groups *parent, enum map_type type);
 197 size_t map_groups__fprintf(struct map_groups *mg, FILE *fp);
 198
 199 int maps__set_kallsyms_ref_reloc_sym(struct map **maps, const char *symbol_name,
 200                                      u64 addr);
 201
 202 static inline void map_groups__insert(struct map_groups *mg, struct map *map)
 203 {
 204         maps__insert(&mg->maps[map->type], map);
 205         map->groups = mg;
 206 }
 207
 208 static inline void map_groups__remove(struct map_groups *mg, struct map *map)
 209 {
 210         maps__remove(&mg->maps[map->type], map);
 211 }
 212
 213 static inline struct map *map_groups__find(struct map_groups *mg,
 214                                            enum map_type type, u64 addr)
 215 {
 216         return maps__find(&mg->maps[type], addr);
 217 }
 218
 219 static inline struct map *map_groups__first(struct map_groups *mg,
 220                                             enum map_type type)
 221 {
 222         return maps__first(&mg->maps[type]);
 223 }
 224
 225 static inline struct map *map_groups__next(struct map *map)
 226 {
 227         return map__next(map);
 228 }
 229
 230 struct symbol *map_groups__find_symbol(struct map_groups *mg,
 231                                        enum map_type type, u64 addr,
 232                                        struct map **mapp);
 233
 234 struct symbol *map_groups__find_symbol_by_name(struct map_groups *mg,
 235                                                enum map_type type,
 236                                                const char *name,
 237                                                struct map **mapp);
 238
 239 struct addr_map_symbol;
 240
 241 int map_groups__find_ams(struct addr_map_symbol *ams);
 242
 243 static inline
 244 struct symbol *map_groups__find_function_by_name(struct map_groups *mg,
 245                                                  const char *name, struct map **mapp)
 246 {
 247         return map_groups__find_symbol_by_name(mg, MAP__FUNCTION, name, mapp);
 248 }
 249
 250 int map_groups__fixup_overlappings(struct map_groups *mg, struct map *map,
 251                                    FILE *fp);
 252
 253 struct map *map_groups__find_by_name(struct map_groups *mg,
 254                                      enum map_type type, const char *name);
 255
 256 bool __map__is_kernel(const struct map *map);
 257
 258 static inline bool __map__is_kmodule(const struct map *map)
 259 {
 260         return !__map__is_kernel(map);
 261 }
 262
 263 #endif /* __PERF_MAP_H */