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         u64                     pgoff;
  39         u64                     reloc;
  40         u32                     maj, min; /* only valid for MMAP2 record */
  41         u64                     ino;      /* only valid for MMAP2 record */
  42         u64                     ino_generation;/* only valid for MMAP2 record */
  43
  44         /* ip -> dso rip */
  45         u64                     (*map_ip)(struct map *, u64);
  46         /* dso rip -> ip */
  47         u64                     (*unmap_ip)(struct map *, u64);
  48
  49         struct dso              *dso;
  50         struct map_groups       *groups;
  51 };
  52
  53 struct kmap {
  54         struct ref_reloc_sym    *ref_reloc_sym;
  55         struct map_groups       *kmaps;
  56 };
  57
  58 struct map_groups {
  59         struct rb_root   maps[MAP__NR_TYPES];
  60         struct list_head removed_maps[MAP__NR_TYPES];
  61         struct machine   *machine;
  62         int              refcnt;
  63 };
  64
  65 struct map_groups *map_groups__new(void);
  66 void map_groups__delete(struct map_groups *mg);
  67
  68 static inline struct map_groups *map_groups__get(struct map_groups *mg)
  69 {
  70         ++mg->refcnt;
  71         return mg;
  72 }
  73
  74 void map_groups__put(struct map_groups *mg);
  75
  76 static inline struct kmap *map__kmap(struct map *map)
  77 {
  78         return (struct kmap *)(map + 1);
  79 }
  80
  81 static inline u64 map__map_ip(struct map *map, u64 ip)
  82 {
  83         return ip - map->start + map->pgoff;
  84 }
  85
  86 static inline u64 map__unmap_ip(struct map *map, u64 ip)
  87 {
  88         return ip + map->start - map->pgoff;
  89 }
  90
  91 static inline u64 identity__map_ip(struct map *map __maybe_unused, u64 ip)
  92 {
  93         return ip;
  94 }
  95
  96
  97 /* rip/ip <-> addr suitable for passing to `objdump --start-address=` */
  98 u64 map__rip_2objdump(struct map *map, u64 rip);
  99
 100 /* objdump address -> memory address */
 101 u64 map__objdump_2mem(struct map *map, u64 ip);
 102
 103 struct symbol;
 104
 105 /* map__for_each_symbol - iterate over the symbols in the given map
 106  *
 107  * @map: the 'struct map *' in which symbols itereated
 108  * @pos: the 'struct symbol *' to use as a loop cursor
 109  * @n: the 'struct rb_node *' to use as a temporary storage
 110  * Note: caller must ensure map->dso is not NULL (map is loaded).
 111  */
 112 #define map__for_each_symbol(map, pos, n)       \
 113         dso__for_each_symbol(map->dso, pos, n, map->type)
 114
 115 typedef int (*symbol_filter_t)(struct map *map, struct symbol *sym);
 116
 117 void map__init(struct map *map, enum map_type type,
 118                u64 start, u64 end, u64 pgoff, struct dso *dso);
 119 struct map *map__new(struct list_head *dsos__list, u64 start, u64 len,
 120                      u64 pgoff, u32 pid, u32 d_maj, u32 d_min, u64 ino,
 121                      u64 ino_gen,
 122                      char *filename, enum map_type type);
 123 struct map *map__new2(u64 start, struct dso *dso, enum map_type type);
 124 void map__delete(struct map *map);
 125 struct map *map__clone(struct map *map);
 126 int map__overlap(struct map *l, struct map *r);
 127 size_t map__fprintf(struct map *map, FILE *fp);
 128 size_t map__fprintf_dsoname(struct map *map, FILE *fp);
 129 int map__fprintf_srcline(struct map *map, u64 addr, const char *prefix,
 130                          FILE *fp);
 131
 132 int map__load(struct map *map, symbol_filter_t filter);
 133 struct symbol *map__find_symbol(struct map *map,
 134                                 u64 addr, symbol_filter_t filter);
 135 struct symbol *map__find_symbol_by_name(struct map *map, const char *name,
 136                                         symbol_filter_t filter);
 137 void map__fixup_start(struct map *map);
 138 void map__fixup_end(struct map *map);
 139
 140 void map__reloc_vmlinux(struct map *map);
 141
 142 size_t __map_groups__fprintf_maps(struct map_groups *mg,
 143                                   enum map_type type, int verbose, FILE *fp);
 144 void maps__insert(struct rb_root *maps, struct map *map);
 145 void maps__remove(struct rb_root *maps, struct map *map);
 146 struct map *maps__find(struct rb_root *maps, u64 addr);
 147 struct map *maps__first(struct rb_root *maps);
 148 struct map *maps__next(struct map *map);
 149 void map_groups__init(struct map_groups *mg);
 150 void map_groups__exit(struct map_groups *mg);
 151 int map_groups__clone(struct map_groups *mg,
 152                       struct map_groups *parent, enum map_type type);
 153 size_t map_groups__fprintf(struct map_groups *mg, int verbose, FILE *fp);
 154 size_t map_groups__fprintf_maps(struct map_groups *mg, int verbose, FILE *fp);
 155
 156 int maps__set_kallsyms_ref_reloc_sym(struct map **maps, const char *symbol_name,
 157                                      u64 addr);
 158
 159 static inline void map_groups__insert(struct map_groups *mg, struct map *map)
 160 {
 161         maps__insert(&mg->maps[map->type], map);
 162         map->groups = mg;
 163 }
 164
 165 static inline void map_groups__remove(struct map_groups *mg, struct map *map)
 166 {
 167         maps__remove(&mg->maps[map->type], map);
 168 }
 169
 170 static inline struct map *map_groups__find(struct map_groups *mg,
 171                                            enum map_type type, u64 addr)
 172 {
 173         return maps__find(&mg->maps[type], addr);
 174 }
 175
 176 static inline struct map *map_groups__first(struct map_groups *mg,
 177                                             enum map_type type)
 178 {
 179         return maps__first(&mg->maps[type]);
 180 }
 181
 182 static inline struct map *map_groups__next(struct map *map)
 183 {
 184         return maps__next(map);
 185 }
 186
 187 struct symbol *map_groups__find_symbol(struct map_groups *mg,
 188                                        enum map_type type, u64 addr,
 189                                        struct map **mapp,
 190                                        symbol_filter_t filter);
 191
 192 struct symbol *map_groups__find_symbol_by_name(struct map_groups *mg,
 193                                                enum map_type type,
 194                                                const char *name,
 195                                                struct map **mapp,
 196                                                symbol_filter_t filter);
 197
 198 struct addr_map_symbol;
 199
 200 int map_groups__find_ams(struct addr_map_symbol *ams, symbol_filter_t filter);
 201
 202 static inline
 203 struct symbol *map_groups__find_function_by_name(struct map_groups *mg,
 204                                                  const char *name, struct map **mapp,
 205                                                  symbol_filter_t filter)
 206 {
 207         return map_groups__find_symbol_by_name(mg, MAP__FUNCTION, name, mapp, filter);
 208 }
 209
 210 int map_groups__fixup_overlappings(struct map_groups *mg, struct map *map,
 211                                    int verbose, FILE *fp);
 212
 213 struct map *map_groups__find_by_name(struct map_groups *mg,
 214                                      enum map_type type, const char *name);
 215
 216 void map_groups__flush(struct map_groups *mg);
 217
 218 #endif /* __PERF_MAP_H */