1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef __PERF_DSO 3 #define __PERF_DSO 4 5 #include <linux/refcount.h> 6 #include <linux/types.h> 7 #include <linux/rbtree.h> 8 #include <sys/types.h> 9 #include <stdbool.h> 10 #include <stdio.h> 11 #include <linux/bitops.h> 12 #include "build-id.h" 13 #include "mutex.h" 14 15 struct machine; 16 struct map; 17 struct perf_env; 18 19 #define DSO__NAME_KALLSYMS "[kernel.kallsyms]" 20 #define DSO__NAME_KCORE "[kernel.kcore]" 21 22 enum dso_binary_type { 23 DSO_BINARY_TYPE__KALLSYMS = 0, 24 DSO_BINARY_TYPE__GUEST_KALLSYMS, 25 DSO_BINARY_TYPE__VMLINUX, 26 DSO_BINARY_TYPE__GUEST_VMLINUX, 27 DSO_BINARY_TYPE__JAVA_JIT, 28 DSO_BINARY_TYPE__DEBUGLINK, 29 DSO_BINARY_TYPE__BUILD_ID_CACHE, 30 DSO_BINARY_TYPE__BUILD_ID_CACHE_DEBUGINFO, 31 DSO_BINARY_TYPE__FEDORA_DEBUGINFO, 32 DSO_BINARY_TYPE__UBUNTU_DEBUGINFO, 33 DSO_BINARY_TYPE__MIXEDUP_UBUNTU_DEBUGINFO, 34 DSO_BINARY_TYPE__BUILDID_DEBUGINFO, 35 DSO_BINARY_TYPE__SYSTEM_PATH_DSO, 36 DSO_BINARY_TYPE__GUEST_KMODULE, 37 DSO_BINARY_TYPE__GUEST_KMODULE_COMP, 38 DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE, 39 DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP, 40 DSO_BINARY_TYPE__KCORE, 41 DSO_BINARY_TYPE__GUEST_KCORE, 42 DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO, 43 DSO_BINARY_TYPE__BPF_PROG_INFO, 44 DSO_BINARY_TYPE__BPF_IMAGE, 45 DSO_BINARY_TYPE__OOL, 46 DSO_BINARY_TYPE__NOT_FOUND, 47 }; 48 49 enum dso_space_type { 50 DSO_SPACE__USER = 0, 51 DSO_SPACE__KERNEL, 52 DSO_SPACE__KERNEL_GUEST 53 }; 54 55 enum dso_swap_type { 56 DSO_SWAP__UNSET, 57 DSO_SWAP__NO, 58 DSO_SWAP__YES, 59 }; 60 61 enum dso_data_status { 62 DSO_DATA_STATUS_ERROR = -1, 63 DSO_DATA_STATUS_UNKNOWN = 0, 64 DSO_DATA_STATUS_OK = 1, 65 }; 66 67 enum dso_data_status_seen { 68 DSO_DATA_STATUS_SEEN_ITRACE, 69 }; 70 71 enum dso_type { 72 DSO__TYPE_UNKNOWN, 73 DSO__TYPE_64BIT, 74 DSO__TYPE_32BIT, 75 DSO__TYPE_X32BIT, 76 }; 77 78 enum dso_load_errno { 79 DSO_LOAD_ERRNO__SUCCESS = 0, 80 81 /* 82 * Choose an arbitrary negative big number not to clash with standard 83 * errno since SUS requires the errno has distinct positive values. 84 * See 'Issue 6' in the link below. 85 * 86 * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html 87 */ 88 __DSO_LOAD_ERRNO__START = -10000, 89 90 DSO_LOAD_ERRNO__INTERNAL_ERROR = __DSO_LOAD_ERRNO__START, 91 92 /* for symsrc__init() */ 93 DSO_LOAD_ERRNO__INVALID_ELF, 94 DSO_LOAD_ERRNO__CANNOT_READ_BUILDID, 95 DSO_LOAD_ERRNO__MISMATCHING_BUILDID, 96 97 /* for decompress_kmodule */ 98 DSO_LOAD_ERRNO__DECOMPRESSION_FAILURE, 99 100 __DSO_LOAD_ERRNO__END, 101 }; 102 103 #define DSO__SWAP(dso, type, val) \ 104 ({ \ 105 type ____r = val; \ 106 BUG_ON(dso->needs_swap == DSO_SWAP__UNSET); \ 107 if (dso->needs_swap == DSO_SWAP__YES) { \ 108 switch (sizeof(____r)) { \ 109 case 2: \ 110 ____r = bswap_16(val); \ 111 break; \ 112 case 4: \ 113 ____r = bswap_32(val); \ 114 break; \ 115 case 8: \ 116 ____r = bswap_64(val); \ 117 break; \ 118 default: \ 119 BUG_ON(1); \ 120 } \ 121 } \ 122 ____r; \ 123 }) 124 125 #define DSO__DATA_CACHE_SIZE 4096 126 #define DSO__DATA_CACHE_MASK ~(DSO__DATA_CACHE_SIZE - 1) 127 128 /* 129 * Data about backing storage DSO, comes from PERF_RECORD_MMAP2 meta events 130 */ 131 struct dso_id { 132 u32 maj; 133 u32 min; 134 u64 ino; 135 u64 ino_generation; 136 }; 137 138 struct dso_cache { 139 struct rb_node rb_node; 140 u64 offset; 141 u64 size; 142 char data[]; 143 }; 144 145 struct auxtrace_cache; 146 147 struct dso { 148 struct mutex lock; 149 struct list_head node; 150 struct rb_node rb_node; /* rbtree node sorted by long name */ 151 struct rb_root *root; /* root of rbtree that rb_node is in */ 152 struct rb_root_cached symbols; 153 struct symbol **symbol_names; 154 size_t symbol_names_len; 155 struct rb_root_cached inlined_nodes; 156 struct rb_root_cached srclines; 157 struct rb_root data_types; 158 struct rb_root global_vars; 159 160 struct { 161 u64 addr; 162 struct symbol *symbol; 163 } last_find_result; 164 void *a2l; 165 char *symsrc_filename; 166 unsigned int a2l_fails; 167 enum dso_space_type kernel; 168 bool is_kmod; 169 enum dso_swap_type needs_swap; 170 enum dso_binary_type symtab_type; 171 enum dso_binary_type binary_type; 172 enum dso_load_errno load_errno; 173 u8 adjust_symbols:1; 174 u8 has_build_id:1; 175 u8 header_build_id:1; 176 u8 has_srcline:1; 177 u8 hit:1; 178 u8 annotate_warned:1; 179 u8 auxtrace_warned:1; 180 u8 short_name_allocated:1; 181 u8 long_name_allocated:1; 182 u8 is_64_bit:1; 183 bool sorted_by_name; 184 bool loaded; 185 u8 rel; 186 struct build_id bid; 187 u64 text_offset; 188 u64 text_end; 189 const char *short_name; 190 const char *long_name; 191 u16 long_name_len; 192 u16 short_name_len; 193 void *dwfl; /* DWARF debug info */ 194 struct auxtrace_cache *auxtrace_cache; 195 int comp; 196 197 /* dso data file */ 198 struct { 199 struct rb_root cache; 200 int fd; 201 int status; 202 u32 status_seen; 203 u64 file_size; 204 struct list_head open_entry; 205 u64 elf_base_addr; 206 u64 debug_frame_offset; 207 u64 eh_frame_hdr_addr; 208 u64 eh_frame_hdr_offset; 209 } data; 210 /* bpf prog information */ 211 struct { 212 u32 id; 213 u32 sub_id; 214 struct perf_env *env; 215 } bpf_prog; 216 217 union { /* Tool specific area */ 218 void *priv; 219 u64 db_id; 220 }; 221 struct nsinfo *nsinfo; 222 struct dso_id id; 223 refcount_t refcnt; 224 char name[]; 225 }; 226 227 /* dso__for_each_symbol - iterate over the symbols of given type 228 * 229 * @dso: the 'struct dso *' in which symbols are iterated 230 * @pos: the 'struct symbol *' to use as a loop cursor 231 * @n: the 'struct rb_node *' to use as a temporary storage 232 */ 233 #define dso__for_each_symbol(dso, pos, n) \ 234 symbols__for_each_entry(&(dso)->symbols, pos, n) 235 236 #define dsos__for_each_with_build_id(pos, head) \ 237 list_for_each_entry(pos, head, node) \ 238 if (!pos->has_build_id) \ 239 continue; \ 240 else 241 242 static inline void dso__set_loaded(struct dso *dso) 243 { 244 dso->loaded = true; 245 } 246 247 struct dso *dso__new_id(const char *name, struct dso_id *id); 248 struct dso *dso__new(const char *name); 249 void dso__delete(struct dso *dso); 250 251 int dso__cmp_id(struct dso *a, struct dso *b); 252 void dso__set_short_name(struct dso *dso, const char *name, bool name_allocated); 253 void dso__set_long_name(struct dso *dso, const char *name, bool name_allocated); 254 255 int dso__name_len(const struct dso *dso); 256 257 struct dso *dso__get(struct dso *dso); 258 void dso__put(struct dso *dso); 259 260 static inline void __dso__zput(struct dso **dso) 261 { 262 dso__put(*dso); 263 *dso = NULL; 264 } 265 266 #define dso__zput(dso) __dso__zput(&dso) 267 268 bool dso__loaded(const struct dso *dso); 269 270 static inline bool dso__has_symbols(const struct dso *dso) 271 { 272 return !RB_EMPTY_ROOT(&dso->symbols.rb_root); 273 } 274 275 char *dso__filename_with_chroot(const struct dso *dso, const char *filename); 276 277 bool dso__sorted_by_name(const struct dso *dso); 278 void dso__set_sorted_by_name(struct dso *dso); 279 void dso__sort_by_name(struct dso *dso); 280 281 void dso__set_build_id(struct dso *dso, struct build_id *bid); 282 bool dso__build_id_equal(const struct dso *dso, struct build_id *bid); 283 void dso__read_running_kernel_build_id(struct dso *dso, 284 struct machine *machine); 285 int dso__kernel_module_get_build_id(struct dso *dso, const char *root_dir); 286 287 char dso__symtab_origin(const struct dso *dso); 288 int dso__read_binary_type_filename(const struct dso *dso, enum dso_binary_type type, 289 char *root_dir, char *filename, size_t size); 290 bool is_kernel_module(const char *pathname, int cpumode); 291 bool dso__needs_decompress(struct dso *dso); 292 int dso__decompress_kmodule_fd(struct dso *dso, const char *name); 293 int dso__decompress_kmodule_path(struct dso *dso, const char *name, 294 char *pathname, size_t len); 295 int filename__decompress(const char *name, char *pathname, 296 size_t len, int comp, int *err); 297 298 #define KMOD_DECOMP_NAME "/tmp/perf-kmod-XXXXXX" 299 #define KMOD_DECOMP_LEN sizeof(KMOD_DECOMP_NAME) 300 301 struct kmod_path { 302 char *name; 303 int comp; 304 bool kmod; 305 }; 306 307 int __kmod_path__parse(struct kmod_path *m, const char *path, 308 bool alloc_name); 309 310 #define kmod_path__parse(__m, __p) __kmod_path__parse(__m, __p, false) 311 #define kmod_path__parse_name(__m, __p) __kmod_path__parse(__m, __p, true) 312 313 void dso__set_module_info(struct dso *dso, struct kmod_path *m, 314 struct machine *machine); 315 316 /* 317 * The dso__data_* external interface provides following functions: 318 * dso__data_get_fd 319 * dso__data_put_fd 320 * dso__data_close 321 * dso__data_size 322 * dso__data_read_offset 323 * dso__data_read_addr 324 * dso__data_write_cache_offs 325 * dso__data_write_cache_addr 326 * 327 * Please refer to the dso.c object code for each function and 328 * arguments documentation. Following text tries to explain the 329 * dso file descriptor caching. 330 * 331 * The dso__data* interface allows caching of opened file descriptors 332 * to speed up the dso data accesses. The idea is to leave the file 333 * descriptor opened ideally for the whole life of the dso object. 334 * 335 * The current usage of the dso__data_* interface is as follows: 336 * 337 * Get DSO's fd: 338 * int fd = dso__data_get_fd(dso, machine); 339 * if (fd >= 0) { 340 * USE 'fd' SOMEHOW 341 * dso__data_put_fd(dso); 342 * } 343 * 344 * Read DSO's data: 345 * n = dso__data_read_offset(dso_0, &machine, 0, buf, BUFSIZE); 346 * n = dso__data_read_addr(dso_0, &machine, 0, buf, BUFSIZE); 347 * 348 * Eventually close DSO's fd: 349 * dso__data_close(dso); 350 * 351 * It is not necessary to close the DSO object data file. Each time new 352 * DSO data file is opened, the limit (RLIMIT_NOFILE/2) is checked. Once 353 * it is crossed, the oldest opened DSO object is closed. 354 * 355 * The dso__delete function calls close_dso function to ensure the 356 * data file descriptor gets closed/unmapped before the dso object 357 * is freed. 358 * 359 * TODO 360 */ 361 int dso__data_get_fd(struct dso *dso, struct machine *machine); 362 void dso__data_put_fd(struct dso *dso); 363 void dso__data_close(struct dso *dso); 364 365 int dso__data_file_size(struct dso *dso, struct machine *machine); 366 off_t dso__data_size(struct dso *dso, struct machine *machine); 367 ssize_t dso__data_read_offset(struct dso *dso, struct machine *machine, 368 u64 offset, u8 *data, ssize_t size); 369 ssize_t dso__data_read_addr(struct dso *dso, struct map *map, 370 struct machine *machine, u64 addr, 371 u8 *data, ssize_t size); 372 bool dso__data_status_seen(struct dso *dso, enum dso_data_status_seen by); 373 ssize_t dso__data_write_cache_offs(struct dso *dso, struct machine *machine, 374 u64 offset, const u8 *data, ssize_t size); 375 ssize_t dso__data_write_cache_addr(struct dso *dso, struct map *map, 376 struct machine *machine, u64 addr, 377 const u8 *data, ssize_t size); 378 379 struct map *dso__new_map(const char *name); 380 struct dso *machine__findnew_kernel(struct machine *machine, const char *name, 381 const char *short_name, int dso_type); 382 383 void dso__reset_find_symbol_cache(struct dso *dso); 384 385 size_t dso__fprintf_symbols_by_name(struct dso *dso, FILE *fp); 386 size_t dso__fprintf(struct dso *dso, FILE *fp); 387 388 static inline bool dso__is_vmlinux(const struct dso *dso) 389 { 390 return dso->binary_type == DSO_BINARY_TYPE__VMLINUX || 391 dso->binary_type == DSO_BINARY_TYPE__GUEST_VMLINUX; 392 } 393 394 static inline bool dso__is_kcore(const struct dso *dso) 395 { 396 return dso->binary_type == DSO_BINARY_TYPE__KCORE || 397 dso->binary_type == DSO_BINARY_TYPE__GUEST_KCORE; 398 } 399 400 static inline bool dso__is_kallsyms(const struct dso *dso) 401 { 402 return dso->kernel && dso->long_name[0] != '/'; 403 } 404 405 bool dso__is_object_file(const struct dso *dso); 406 407 void dso__free_a2l(struct dso *dso); 408 409 enum dso_type dso__type(struct dso *dso, struct machine *machine); 410 411 int dso__strerror_load(struct dso *dso, char *buf, size_t buflen); 412 413 void reset_fd_limit(void); 414 415 u64 dso__find_global_type(struct dso *dso, u64 addr); 416 u64 dso__findnew_global_type(struct dso *dso, u64 addr, u64 offset); 417 418 #endif /* __PERF_DSO */ 419