tools/perf/util/map.h

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