tools/perf/util/map.h

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