1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef __PERF_MAP_H 3 #define __PERF_MAP_H 4 5 #include <linux/refcount.h> 6 #include <linux/compiler.h> 7 #include <linux/list.h> 8 #include <linux/rbtree.h> 9 #include <pthread.h> 10 #include <stdio.h> 11 #include <string.h> 12 #include <stdbool.h> 13 #include <linux/types.h> 14 #include "rwsem.h" 15 16 struct dso; 17 struct ip_callchain; 18 struct ref_reloc_sym; 19 struct map_groups; 20 struct machine; 21 struct perf_evsel; 22 23 struct map { 24 union { 25 struct rb_node rb_node; 26 struct list_head node; 27 }; 28 struct rb_node rb_node_name; 29 u64 start; 30 u64 end; 31 bool erange_warned; 32 u32 priv; 33 u32 prot; 34 u32 flags; 35 u64 pgoff; 36 u64 reloc; 37 u32 maj, min; /* only valid for MMAP2 record */ 38 u64 ino; /* only valid for MMAP2 record */ 39 u64 ino_generation;/* only valid for MMAP2 record */ 40 41 /* ip -> dso rip */ 42 u64 (*map_ip)(struct map *, u64); 43 /* dso rip -> ip */ 44 u64 (*unmap_ip)(struct map *, u64); 45 46 struct dso *dso; 47 struct map_groups *groups; 48 refcount_t refcnt; 49 }; 50 51 #define KMAP_NAME_LEN 256 52 53 struct kmap { 54 struct ref_reloc_sym *ref_reloc_sym; 55 struct map_groups *kmaps; 56 char name[KMAP_NAME_LEN]; 57 }; 58 59 struct maps { 60 struct rb_root entries; 61 struct rb_root names; 62 struct rw_semaphore lock; 63 }; 64 65 struct map_groups { 66 struct maps maps; 67 struct machine *machine; 68 refcount_t refcnt; 69 }; 70 71 struct map_groups *map_groups__new(struct machine *machine); 72 void map_groups__delete(struct map_groups *mg); 73 bool map_groups__empty(struct map_groups *mg); 74 75 static inline struct map_groups *map_groups__get(struct map_groups *mg) 76 { 77 if (mg) 78 refcount_inc(&mg->refcnt); 79 return mg; 80 } 81 82 void map_groups__put(struct map_groups *mg); 83 84 struct kmap *__map__kmap(struct map *map); 85 struct kmap *map__kmap(struct map *map); 86 struct map_groups *map__kmaps(struct map *map); 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 __maybe_unused, u64 ip) 99 { 100 return ip; 101 } 102 103 static inline size_t map__size(const struct map *map) 104 { 105 return map->end - map->start; 106 } 107 108 /* rip/ip <-> addr suitable for passing to `objdump --start-address=` */ 109 u64 map__rip_2objdump(struct map *map, u64 rip); 110 111 /* objdump address -> memory address */ 112 u64 map__objdump_2mem(struct map *map, u64 ip); 113 114 struct symbol; 115 struct thread; 116 117 /* map__for_each_symbol - iterate over the symbols in the given map 118 * 119 * @map: the 'struct map *' in which symbols itereated 120 * @pos: the 'struct symbol *' to use as a loop cursor 121 * @n: the 'struct rb_node *' to use as a temporary storage 122 * Note: caller must ensure map->dso is not NULL (map is loaded). 123 */ 124 #define map__for_each_symbol(map, pos, n) \ 125 dso__for_each_symbol(map->dso, pos, n) 126 127 /* map__for_each_symbol_with_name - iterate over the symbols in the given map 128 * that have the given name 129 * 130 * @map: the 'struct map *' in which symbols itereated 131 * @sym_name: the symbol name 132 * @pos: the 'struct symbol *' to use as a loop cursor 133 */ 134 #define __map__for_each_symbol_by_name(map, sym_name, pos) \ 135 for (pos = map__find_symbol_by_name(map, sym_name); \ 136 pos && \ 137 !symbol__match_symbol_name(pos->name, sym_name, \ 138 SYMBOL_TAG_INCLUDE__DEFAULT_ONLY); \ 139 pos = symbol__next_by_name(pos)) 140 141 #define map__for_each_symbol_by_name(map, sym_name, pos) \ 142 __map__for_each_symbol_by_name(map, sym_name, (pos)) 143 144 void map__init(struct map *map, 145 u64 start, u64 end, u64 pgoff, struct dso *dso); 146 struct map *map__new(struct machine *machine, u64 start, u64 len, 147 u64 pgoff, u32 d_maj, u32 d_min, u64 ino, 148 u64 ino_gen, u32 prot, u32 flags, 149 char *filename, struct thread *thread); 150 struct map *map__new2(u64 start, struct dso *dso); 151 void map__delete(struct map *map); 152 struct map *map__clone(struct map *map); 153 154 static inline struct map *map__get(struct map *map) 155 { 156 if (map) 157 refcount_inc(&map->refcnt); 158 return map; 159 } 160 161 void map__put(struct map *map); 162 163 static inline void __map__zput(struct map **map) 164 { 165 map__put(*map); 166 *map = NULL; 167 } 168 169 #define map__zput(map) __map__zput(&map) 170 171 size_t map__fprintf(struct map *map, FILE *fp); 172 size_t map__fprintf_dsoname(struct map *map, FILE *fp); 173 char *map__srcline(struct map *map, u64 addr, struct symbol *sym); 174 int map__fprintf_srcline(struct map *map, u64 addr, const char *prefix, 175 FILE *fp); 176 177 struct srccode_state { 178 char *srcfile; 179 unsigned line; 180 }; 181 182 static inline void srccode_state_init(struct srccode_state *state) 183 { 184 state->srcfile = NULL; 185 state->line = 0; 186 } 187 188 void srccode_state_free(struct srccode_state *state); 189 190 int map__fprintf_srccode(struct map *map, u64 addr, 191 FILE *fp, struct srccode_state *state); 192 193 int map__load(struct map *map); 194 struct symbol *map__find_symbol(struct map *map, u64 addr); 195 struct symbol *map__find_symbol_by_name(struct map *map, const char *name); 196 void map__fixup_start(struct map *map); 197 void map__fixup_end(struct map *map); 198 199 void map__reloc_vmlinux(struct map *map); 200 201 void maps__insert(struct maps *maps, struct map *map); 202 void maps__remove(struct maps *maps, struct map *map); 203 struct map *maps__find(struct maps *maps, u64 addr); 204 struct map *maps__first(struct maps *maps); 205 struct map *map__next(struct map *map); 206 struct symbol *maps__find_symbol_by_name(struct maps *maps, const char *name, 207 struct map **mapp); 208 void map_groups__init(struct map_groups *mg, struct machine *machine); 209 void map_groups__exit(struct map_groups *mg); 210 int map_groups__clone(struct thread *thread, 211 struct map_groups *parent); 212 size_t map_groups__fprintf(struct map_groups *mg, FILE *fp); 213 214 int map__set_kallsyms_ref_reloc_sym(struct map *map, const char *symbol_name, 215 u64 addr); 216 217 static inline void map_groups__insert(struct map_groups *mg, struct map *map) 218 { 219 maps__insert(&mg->maps, map); 220 map->groups = mg; 221 } 222 223 static inline void map_groups__remove(struct map_groups *mg, struct map *map) 224 { 225 maps__remove(&mg->maps, map); 226 } 227 228 static inline struct map *map_groups__find(struct map_groups *mg, u64 addr) 229 { 230 return maps__find(&mg->maps, addr); 231 } 232 233 struct map *map_groups__first(struct map_groups *mg); 234 235 static inline struct map *map_groups__next(struct map *map) 236 { 237 return map__next(map); 238 } 239 240 struct symbol *map_groups__find_symbol(struct map_groups *mg, 241 u64 addr, struct map **mapp); 242 243 struct symbol *map_groups__find_symbol_by_name(struct map_groups *mg, 244 const char *name, 245 struct map **mapp); 246 247 struct addr_map_symbol; 248 249 int map_groups__find_ams(struct addr_map_symbol *ams); 250 251 int map_groups__fixup_overlappings(struct map_groups *mg, struct map *map, 252 FILE *fp); 253 254 struct map *map_groups__find_by_name(struct map_groups *mg, const char *name); 255 256 bool __map__is_kernel(const struct map *map); 257 bool __map__is_extra_kernel_map(const struct map *map); 258 259 static inline bool __map__is_kmodule(const struct map *map) 260 { 261 return !__map__is_kernel(map) && !__map__is_extra_kernel_map(map); 262 } 263 264 bool map__has_symbols(const struct map *map); 265 266 #define ENTRY_TRAMPOLINE_NAME "__entry_SYSCALL_64_trampoline" 267 268 static inline bool is_entry_trampoline(const char *name) 269 { 270 return !strcmp(name, ENTRY_TRAMPOLINE_NAME); 271 } 272 273 #endif /* __PERF_MAP_H */ 274