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 "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 ref_reloc_sym;
  22 struct map_groups;
  23 struct machine;
  24
  25 struct map {
  26         union {
  27                 struct rb_node  rb_node;
  28                 struct list_head node;
  29         };
  30         u64                     start;
  31         u64                     end;
  32         enum map_type           type;
  33         u32                     priv;
  34         u64                     pgoff;
  35
  36         /* ip -> dso rip */
  37         u64                     (*map_ip)(struct map *, u64);
  38         /* dso rip -> ip */
  39         u64                     (*unmap_ip)(struct map *, u64);
  40
  41         struct dso              *dso;
  42         struct map_groups       *groups;
  43 };
  44
  45 struct kmap {
  46         struct ref_reloc_sym    *ref_reloc_sym;
  47         struct map_groups       *kmaps;
  48 };
  49
  50 struct map_groups {
  51         struct rb_root   maps[MAP__NR_TYPES];
  52         struct list_head removed_maps[MAP__NR_TYPES];
  53         struct machine   *machine;
  54 };
  55
  56 /* Native host kernel uses -1 as pid index in machine */
  57 #define HOST_KERNEL_ID                  (-1)
  58 #define DEFAULT_GUEST_KERNEL_ID         (0)
  59
  60 struct machine {
  61         struct rb_node    rb_node;
  62         pid_t             pid;
  63         char              *root_dir;
  64         struct list_head  user_dsos;
  65         struct list_head  kernel_dsos;
  66         struct map_groups kmaps;
  67         struct map        *vmlinux_maps[MAP__NR_TYPES];
  68 };
  69
  70 static inline
  71 struct map *machine__kernel_map(struct machine *self, enum map_type type)
  72 {
  73         return self->vmlinux_maps[type];
  74 }
  75
  76 static inline struct kmap *map__kmap(struct map *self)
  77 {
  78         return (struct kmap *)(self + 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 __used, 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 u64 map__objdump_2ip(struct map *map, u64 addr);
 100
 101 struct symbol;
 102
 103 typedef int (*symbol_filter_t)(struct map *map, struct symbol *sym);
 104
 105 void map__init(struct map *self, enum map_type type,
 106                u64 start, u64 end, u64 pgoff, struct dso *dso);
 107 struct map *map__new(struct list_head *dsos__list, u64 start, u64 len,
 108                      u64 pgoff, u32 pid, char *filename,
 109                      enum map_type type);
 110 void map__delete(struct map *self);
 111 struct map *map__clone(struct map *self);
 112 int map__overlap(struct map *l, struct map *r);
 113 size_t map__fprintf(struct map *self, FILE *fp);
 114
 115 int map__load(struct map *self, symbol_filter_t filter);
 116 struct symbol *map__find_symbol(struct map *self,
 117                                 u64 addr, symbol_filter_t filter);
 118 struct symbol *map__find_symbol_by_name(struct map *self, const char *name,
 119                                         symbol_filter_t filter);
 120 void map__fixup_start(struct map *self);
 121 void map__fixup_end(struct map *self);
 122
 123 void map__reloc_vmlinux(struct map *self);
 124
 125 size_t __map_groups__fprintf_maps(struct map_groups *self,
 126                                   enum map_type type, int verbose, FILE *fp);
 127 void maps__insert(struct rb_root *maps, struct map *map);
 128 struct map *maps__find(struct rb_root *maps, u64 addr);
 129 void map_groups__init(struct map_groups *self);
 130 void map_groups__exit(struct map_groups *self);
 131 int map_groups__clone(struct map_groups *self,
 132                       struct map_groups *parent, enum map_type type);
 133 size_t map_groups__fprintf(struct map_groups *self, int verbose, FILE *fp);
 134 size_t map_groups__fprintf_maps(struct map_groups *self, int verbose, FILE *fp);
 135
 136 typedef void (*machine__process_t)(struct machine *self, void *data);
 137
 138 void machines__process(struct rb_root *self, machine__process_t process, void *data);
 139 struct machine *machines__add(struct rb_root *self, pid_t pid,
 140                               const char *root_dir);
 141 struct machine *machines__find_host(struct rb_root *self);
 142 struct machine *machines__find(struct rb_root *self, pid_t pid);
 143 struct machine *machines__findnew(struct rb_root *self, pid_t pid);
 144 char *machine__mmap_name(struct machine *self, char *bf, size_t size);
 145 int machine__init(struct machine *self, const char *root_dir, pid_t pid);
 146 void machine__exit(struct machine *self);
 147
 148 /*
 149  * Default guest kernel is defined by parameter --guestkallsyms
 150  * and --guestmodules
 151  */
 152 static inline bool machine__is_default_guest(struct machine *self)
 153 {
 154         return self ? self->pid == DEFAULT_GUEST_KERNEL_ID : false;
 155 }
 156
 157 static inline bool machine__is_host(struct machine *self)
 158 {
 159         return self ? self->pid == HOST_KERNEL_ID : false;
 160 }
 161
 162 static inline void map_groups__insert(struct map_groups *self, struct map *map)
 163 {
 164         maps__insert(&self->maps[map->type], map);
 165         map->groups = self;
 166 }
 167
 168 static inline struct map *map_groups__find(struct map_groups *self,
 169                                            enum map_type type, u64 addr)
 170 {
 171         return maps__find(&self->maps[type], addr);
 172 }
 173
 174 struct symbol *map_groups__find_symbol(struct map_groups *self,
 175                                        enum map_type type, u64 addr,
 176                                        struct map **mapp,
 177                                        symbol_filter_t filter);
 178
 179 struct symbol *map_groups__find_symbol_by_name(struct map_groups *self,
 180                                                enum map_type type,
 181                                                const char *name,
 182                                                struct map **mapp,
 183                                                symbol_filter_t filter);
 184
 185 static inline
 186 struct symbol *machine__find_kernel_symbol(struct machine *self,
 187                                            enum map_type type, u64 addr,
 188                                            struct map **mapp,
 189                                            symbol_filter_t filter)
 190 {
 191         return map_groups__find_symbol(&self->kmaps, type, addr, mapp, filter);
 192 }
 193
 194 static inline
 195 struct symbol *machine__find_kernel_function(struct machine *self, u64 addr,
 196                                              struct map **mapp,
 197                                              symbol_filter_t filter)
 198 {
 199         return machine__find_kernel_symbol(self, MAP__FUNCTION, addr, mapp, filter);
 200 }
 201
 202 static inline
 203 struct symbol *map_groups__find_function_by_name(struct map_groups *self,
 204                                                  const char *name, struct map **mapp,
 205                                                  symbol_filter_t filter)
 206 {
 207         return map_groups__find_symbol_by_name(self, MAP__FUNCTION, name, mapp, filter);
 208 }
 209
 210 int map_groups__fixup_overlappings(struct map_groups *self, struct map *map,
 211                                    int verbose, FILE *fp);
 212
 213 struct map *map_groups__find_by_name(struct map_groups *self,
 214                                      enum map_type type, const char *name);
 215 struct map *machine__new_module(struct machine *self, u64 start, const char *filename);
 216
 217 void map_groups__flush(struct map_groups *self);
 218
 219 #endif /* __PERF_MAP_H */