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 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         u32                     priv;
  37         u64                     pgoff;
  38
  39         /* ip -> dso rip */
  40         u64                     (*map_ip)(struct map *, u64);
  41         /* dso rip -> ip */
  42         u64                     (*unmap_ip)(struct map *, u64);
  43
  44         struct dso              *dso;
  45         struct map_groups       *groups;
  46 };
  47
  48 struct kmap {
  49         struct ref_reloc_sym    *ref_reloc_sym;
  50         struct map_groups       *kmaps;
  51 };
  52
  53 struct map_groups {
  54         struct rb_root   maps[MAP__NR_TYPES];
  55         struct list_head removed_maps[MAP__NR_TYPES];
  56         struct machine   *machine;
  57 };
  58
  59 /* Native host kernel uses -1 as pid index in machine */
  60 #define HOST_KERNEL_ID                  (-1)
  61 #define DEFAULT_GUEST_KERNEL_ID         (0)
  62
  63 struct machine {
  64         struct rb_node    rb_node;
  65         pid_t             pid;
  66         u16               id_hdr_size;
  67         char              *root_dir;
  68         struct rb_root    threads;
  69         struct list_head  dead_threads;
  70         struct thread     *last_match;
  71         struct list_head  user_dsos;
  72         struct list_head  kernel_dsos;
  73         struct map_groups kmaps;
  74         struct map        *vmlinux_maps[MAP__NR_TYPES];
  75 };
  76
  77 static inline
  78 struct map *machine__kernel_map(struct machine *self, enum map_type type)
  79 {
  80         return self->vmlinux_maps[type];
  81 }
  82
  83 static inline struct kmap *map__kmap(struct map *self)
  84 {
  85         return (struct kmap *)(self + 1);
  86 }
  87
  88 static inline u64 map__map_ip(struct map *map, u64 ip)
  89 {
  90         return ip - map->start + map->pgoff;
  91 }
  92
  93 static inline u64 map__unmap_ip(struct map *map, u64 ip)
  94 {
  95         return ip + map->start - map->pgoff;
  96 }
  97
  98 static inline u64 identity__map_ip(struct map *map __used, u64 ip)
  99 {
 100         return ip;
 101 }
 102
 103
 104 /* rip/ip <-> addr suitable for passing to `objdump --start-address=` */
 105 u64 map__rip_2objdump(struct map *map, u64 rip);
 106 u64 map__objdump_2ip(struct map *map, u64 addr);
 107
 108 struct symbol;
 109
 110 typedef int (*symbol_filter_t)(struct map *map, struct symbol *sym);
 111
 112 void map__init(struct map *self, enum map_type type,
 113                u64 start, u64 end, u64 pgoff, struct dso *dso);
 114 struct map *map__new(struct list_head *dsos__list, u64 start, u64 len,
 115                      u64 pgoff, u32 pid, char *filename,
 116                      enum map_type type);
 117 void map__delete(struct map *self);
 118 struct map *map__clone(struct map *self);
 119 int map__overlap(struct map *l, struct map *r);
 120 size_t map__fprintf(struct map *self, FILE *fp);
 121 size_t map__fprintf_dsoname(struct map *map, FILE *fp);
 122
 123 int map__load(struct map *self, symbol_filter_t filter);
 124 struct symbol *map__find_symbol(struct map *self,
 125                                 u64 addr, symbol_filter_t filter);
 126 struct symbol *map__find_symbol_by_name(struct map *self, const char *name,
 127                                         symbol_filter_t filter);
 128 void map__fixup_start(struct map *self);
 129 void map__fixup_end(struct map *self);
 130
 131 void map__reloc_vmlinux(struct map *self);
 132
 133 size_t __map_groups__fprintf_maps(struct map_groups *mg,
 134                                   enum map_type type, int verbose, FILE *fp);
 135 void maps__insert(struct rb_root *maps, struct map *map);
 136 void maps__remove(struct rb_root *maps, struct map *map);
 137 struct map *maps__find(struct rb_root *maps, u64 addr);
 138 void map_groups__init(struct map_groups *mg);
 139 void map_groups__exit(struct map_groups *mg);
 140 int map_groups__clone(struct map_groups *mg,
 141                       struct map_groups *parent, enum map_type type);
 142 size_t map_groups__fprintf(struct map_groups *mg, int verbose, FILE *fp);
 143 size_t map_groups__fprintf_maps(struct map_groups *mg, int verbose, FILE *fp);
 144
 145 typedef void (*machine__process_t)(struct machine *self, void *data);
 146
 147 void machines__process(struct rb_root *self, machine__process_t process, void *data);
 148 struct machine *machines__add(struct rb_root *self, pid_t pid,
 149                               const char *root_dir);
 150 struct machine *machines__find_host(struct rb_root *self);
 151 struct machine *machines__find(struct rb_root *self, pid_t pid);
 152 struct machine *machines__findnew(struct rb_root *self, pid_t pid);
 153 char *machine__mmap_name(struct machine *self, char *bf, size_t size);
 154 int machine__init(struct machine *self, const char *root_dir, pid_t pid);
 155 void machine__exit(struct machine *self);
 156 void machine__delete(struct machine *self);
 157
 158 int machine__resolve_callchain(struct machine *machine,
 159                                struct perf_evsel *evsel, struct thread *thread,
 160                                struct ip_callchain *chain,
 161                                struct symbol **parent);
 162 int maps__set_kallsyms_ref_reloc_sym(struct map **maps, const char *symbol_name,
 163                                      u64 addr);
 164
 165 /*
 166  * Default guest kernel is defined by parameter --guestkallsyms
 167  * and --guestmodules
 168  */
 169 static inline bool machine__is_default_guest(struct machine *self)
 170 {
 171         return self ? self->pid == DEFAULT_GUEST_KERNEL_ID : false;
 172 }
 173
 174 static inline bool machine__is_host(struct machine *self)
 175 {
 176         return self ? self->pid == HOST_KERNEL_ID : false;
 177 }
 178
 179 static inline void map_groups__insert(struct map_groups *mg, struct map *map)
 180 {
 181         maps__insert(&mg->maps[map->type], map);
 182         map->groups = mg;
 183 }
 184
 185 static inline void map_groups__remove(struct map_groups *mg, struct map *map)
 186 {
 187         maps__remove(&mg->maps[map->type], map);
 188 }
 189
 190 static inline struct map *map_groups__find(struct map_groups *mg,
 191                                            enum map_type type, u64 addr)
 192 {
 193         return maps__find(&mg->maps[type], addr);
 194 }
 195
 196 struct symbol *map_groups__find_symbol(struct map_groups *mg,
 197                                        enum map_type type, u64 addr,
 198                                        struct map **mapp,
 199                                        symbol_filter_t filter);
 200
 201 struct symbol *map_groups__find_symbol_by_name(struct map_groups *mg,
 202                                                enum map_type type,
 203                                                const char *name,
 204                                                struct map **mapp,
 205                                                symbol_filter_t filter);
 206
 207
 208 struct thread *machine__findnew_thread(struct machine *machine, pid_t pid);
 209 void machine__remove_thread(struct machine *machine, struct thread *th);
 210
 211 size_t machine__fprintf(struct machine *machine, FILE *fp);
 212
 213 static inline
 214 struct symbol *machine__find_kernel_symbol(struct machine *self,
 215                                            enum map_type type, u64 addr,
 216                                            struct map **mapp,
 217                                            symbol_filter_t filter)
 218 {
 219         return map_groups__find_symbol(&self->kmaps, type, addr, mapp, filter);
 220 }
 221
 222 static inline
 223 struct symbol *machine__find_kernel_function(struct machine *self, u64 addr,
 224                                              struct map **mapp,
 225                                              symbol_filter_t filter)
 226 {
 227         return machine__find_kernel_symbol(self, MAP__FUNCTION, addr, mapp, filter);
 228 }
 229
 230 static inline
 231 struct symbol *map_groups__find_function_by_name(struct map_groups *mg,
 232                                                  const char *name, struct map **mapp,
 233                                                  symbol_filter_t filter)
 234 {
 235         return map_groups__find_symbol_by_name(mg, MAP__FUNCTION, name, mapp, filter);
 236 }
 237
 238 static inline
 239 struct symbol *machine__find_kernel_function_by_name(struct machine *self,
 240                                                      const char *name,
 241                                                      struct map **mapp,
 242                                                      symbol_filter_t filter)
 243 {
 244         return map_groups__find_function_by_name(&self->kmaps, name, mapp,
 245                                                  filter);
 246 }
 247
 248 int map_groups__fixup_overlappings(struct map_groups *mg, struct map *map,
 249                                    int verbose, FILE *fp);
 250
 251 struct map *map_groups__find_by_name(struct map_groups *mg,
 252                                      enum map_type type, const char *name);
 253 struct map *machine__new_module(struct machine *self, u64 start, const char *filename);
 254
 255 void map_groups__flush(struct map_groups *mg);
 256
 257 #endif /* __PERF_MAP_H */