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 <stdio.h> 10 #include <string.h> 11 #include <stdbool.h> 12 #include <linux/types.h> 13 14 struct dso; 15 struct maps; 16 struct machine; 17 18 struct map { 19 u64 start; 20 u64 end; 21 bool erange_warned:1; 22 bool priv:1; 23 u32 prot; 24 u64 pgoff; 25 u64 reloc; 26 27 /* ip -> dso rip */ 28 u64 (*map_ip)(const struct map *, u64); 29 /* dso rip -> ip */ 30 u64 (*unmap_ip)(const struct map *, u64); 31 32 struct dso *dso; 33 refcount_t refcnt; 34 u32 flags; 35 }; 36 37 struct kmap; 38 39 struct kmap *__map__kmap(struct map *map); 40 struct kmap *map__kmap(struct map *map); 41 struct maps *map__kmaps(struct map *map); 42 43 /* ip -> dso rip */ 44 u64 map__dso_map_ip(const struct map *map, u64 ip); 45 /* dso rip -> ip */ 46 u64 map__dso_unmap_ip(const struct map *map, u64 ip); 47 /* Returns ip */ 48 u64 identity__map_ip(const struct map *map __maybe_unused, u64 ip); 49 50 static inline struct dso *map__dso(const struct map *map) 51 { 52 return map->dso; 53 } 54 55 static inline u64 map__map_ip(const struct map *map, u64 ip) 56 { 57 return map->map_ip(map, ip); 58 } 59 60 static inline u64 map__unmap_ip(const struct map *map, u64 ip) 61 { 62 return map->unmap_ip(map, ip); 63 } 64 65 static inline u64 map__start(const struct map *map) 66 { 67 return map->start; 68 } 69 70 static inline u64 map__end(const struct map *map) 71 { 72 return map->end; 73 } 74 75 static inline u64 map__pgoff(const struct map *map) 76 { 77 return map->pgoff; 78 } 79 80 static inline u64 map__reloc(const struct map *map) 81 { 82 return map->reloc; 83 } 84 85 static inline u32 map__flags(const struct map *map) 86 { 87 return map->flags; 88 } 89 90 static inline u32 map__prot(const struct map *map) 91 { 92 return map->prot; 93 } 94 95 static inline bool map__priv(const struct map *map) 96 { 97 return map->priv; 98 } 99 100 static inline size_t map__size(const struct map *map) 101 { 102 return map__end(map) - map__start(map); 103 } 104 105 /* rip/ip <-> addr suitable for passing to `objdump --start-address=` */ 106 u64 map__rip_2objdump(struct map *map, u64 rip); 107 108 /* objdump address -> memory address */ 109 u64 map__objdump_2mem(struct map *map, u64 ip); 110 111 struct symbol; 112 struct thread; 113 114 /* map__for_each_symbol - iterate over the symbols in the given map 115 * 116 * @map: the 'struct map *' in which symbols are iterated 117 * @pos: the 'struct symbol *' to use as a loop cursor 118 * @n: the 'struct rb_node *' to use as a temporary storage 119 * Note: caller must ensure map->dso is not NULL (map is loaded). 120 */ 121 #define map__for_each_symbol(map, pos, n) \ 122 dso__for_each_symbol(map__dso(map), pos, n) 123 124 /* map__for_each_symbol_with_name - iterate over the symbols in the given map 125 * that have the given name 126 * 127 * @map: the 'struct map *' in which symbols are iterated 128 * @sym_name: the symbol name 129 * @pos: the 'struct symbol *' to use as a loop cursor 130 */ 131 #define __map__for_each_symbol_by_name(map, sym_name, pos) \ 132 for (pos = map__find_symbol_by_name(map, sym_name); \ 133 pos && \ 134 !symbol__match_symbol_name(pos->name, sym_name, \ 135 SYMBOL_TAG_INCLUDE__DEFAULT_ONLY); \ 136 pos = symbol__next_by_name(pos)) 137 138 #define map__for_each_symbol_by_name(map, sym_name, pos) \ 139 __map__for_each_symbol_by_name(map, sym_name, (pos)) 140 141 void map__init(struct map *map, 142 u64 start, u64 end, u64 pgoff, struct dso *dso); 143 144 struct dso_id; 145 struct build_id; 146 147 struct map *map__new(struct machine *machine, u64 start, u64 len, 148 u64 pgoff, struct dso_id *id, u32 prot, u32 flags, 149 struct build_id *bid, 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 int map__load(struct map *map); 178 struct symbol *map__find_symbol(struct map *map, u64 addr); 179 struct symbol *map__find_symbol_by_name(struct map *map, const char *name); 180 void map__fixup_start(struct map *map); 181 void map__fixup_end(struct map *map); 182 183 int map__set_kallsyms_ref_reloc_sym(struct map *map, const char *symbol_name, 184 u64 addr); 185 186 bool __map__is_kernel(const struct map *map); 187 bool __map__is_extra_kernel_map(const struct map *map); 188 bool __map__is_bpf_prog(const struct map *map); 189 bool __map__is_bpf_image(const struct map *map); 190 bool __map__is_ool(const struct map *map); 191 192 static inline bool __map__is_kmodule(const struct map *map) 193 { 194 return !__map__is_kernel(map) && !__map__is_extra_kernel_map(map) && 195 !__map__is_bpf_prog(map) && !__map__is_ool(map) && 196 !__map__is_bpf_image(map); 197 } 198 199 bool map__has_symbols(const struct map *map); 200 201 bool map__contains_symbol(const struct map *map, const struct symbol *sym); 202 203 #define ENTRY_TRAMPOLINE_NAME "__entry_SYSCALL_64_trampoline" 204 205 static inline bool is_entry_trampoline(const char *name) 206 { 207 return !strcmp(name, ENTRY_TRAMPOLINE_NAME); 208 } 209 210 static inline bool is_bpf_image(const char *name) 211 { 212 return strncmp(name, "bpf_trampoline_", sizeof("bpf_trampoline_") - 1) == 0 || 213 strncmp(name, "bpf_dispatcher_", sizeof("bpf_dispatcher_") - 1) == 0; 214 } 215 216 static inline int is_anon_memory(const char *filename) 217 { 218 return !strcmp(filename, "//anon") || 219 !strncmp(filename, "/dev/zero", sizeof("/dev/zero") - 1) || 220 !strncmp(filename, "/anon_hugepage", sizeof("/anon_hugepage") - 1); 221 } 222 223 static inline int is_no_dso_memory(const char *filename) 224 { 225 return !strncmp(filename, "[stack", 6) || 226 !strncmp(filename, "/SYSV", 5) || 227 !strcmp(filename, "[heap]"); 228 } 229 #endif /* __PERF_MAP_H */ 230