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 { 158 u64 addr; 159 struct symbol *symbol; 160 } last_find_result; 161 void *a2l; 162 char *symsrc_filename; 163 unsigned int a2l_fails; 164 enum dso_space_type kernel; 165 bool is_kmod; 166 enum dso_swap_type needs_swap; 167 enum dso_binary_type symtab_type; 168 enum dso_binary_type binary_type; 169 enum dso_load_errno load_errno; 170 u8 adjust_symbols:1; 171 u8 has_build_id:1; 172 u8 header_build_id:1; 173 u8 has_srcline:1; 174 u8 hit:1; 175 u8 annotate_warned:1; 176 u8 auxtrace_warned:1; 177 u8 short_name_allocated:1; 178 u8 long_name_allocated:1; 179 u8 is_64_bit:1; 180 bool sorted_by_name; 181 bool loaded; 182 u8 rel; 183 struct build_id bid; 184 u64 text_offset; 185 u64 text_end; 186 const char *short_name; 187 const char *long_name; 188 u16 long_name_len; 189 u16 short_name_len; 190 void *dwfl; /* DWARF debug info */ 191 struct auxtrace_cache *auxtrace_cache; 192 int comp; 193 194 /* dso data file */ 195 struct { 196 struct rb_root cache; 197 int fd; 198 int status; 199 u32 status_seen; 200 u64 file_size; 201 struct list_head open_entry; 202 u64 elf_base_addr; 203 u64 debug_frame_offset; 204 u64 eh_frame_hdr_addr; 205 u64 eh_frame_hdr_offset; 206 } data; 207 /* bpf prog information */ 208 struct { 209 u32 id; 210 u32 sub_id; 211 struct perf_env *env; 212 } bpf_prog; 213 214 union { /* Tool specific area */ 215 void *priv; 216 u64 db_id; 217 }; 218 struct nsinfo *nsinfo; 219 struct dso_id id; 220 refcount_t refcnt; 221 char name[]; 222 }; 223 224 /* dso__for_each_symbol - iterate over the symbols of given type 225 * 226 * @dso: the 'struct dso *' in which symbols are iterated 227 * @pos: the 'struct symbol *' to use as a loop cursor 228 * @n: the 'struct rb_node *' to use as a temporary storage 229 */ 230 #define dso__for_each_symbol(dso, pos, n) \ 231 symbols__for_each_entry(&(dso)->symbols, pos, n) 232 233 #define dsos__for_each_with_build_id(pos, head) \ 234 list_for_each_entry(pos, head, node) \ 235 if (!pos->has_build_id) \ 236 continue; \ 237 else 238 239 static inline void dso__set_loaded(struct dso *dso) 240 { 241 dso->loaded = true; 242 } 243 244 struct dso *dso__new_id(const char *name, struct dso_id *id); 245 struct dso *dso__new(const char *name); 246 void dso__delete(struct dso *dso); 247 248 int dso__cmp_id(struct dso *a, struct dso *b); 249 void dso__set_short_name(struct dso *dso, const char *name, bool name_allocated); 250 void dso__set_long_name(struct dso *dso, const char *name, bool name_allocated); 251 252 int dso__name_len(const struct dso *dso); 253 254 struct dso *dso__get(struct dso *dso); 255 void dso__put(struct dso *dso); 256 257 static inline void __dso__zput(struct dso **dso) 258 { 259 dso__put(*dso); 260 *dso = NULL; 261 } 262 263 #define dso__zput(dso) __dso__zput(&dso) 264 265 bool dso__loaded(const struct dso *dso); 266 267 static inline bool dso__has_symbols(const struct dso *dso) 268 { 269 return !RB_EMPTY_ROOT(&dso->symbols.rb_root); 270 } 271 272 char *dso__filename_with_chroot(const struct dso *dso, const char *filename); 273 274 bool dso__sorted_by_name(const struct dso *dso); 275 void dso__set_sorted_by_name(struct dso *dso); 276 void dso__sort_by_name(struct dso *dso); 277 278 void dso__set_build_id(struct dso *dso, struct build_id *bid); 279 bool dso__build_id_equal(const struct dso *dso, struct build_id *bid); 280 void dso__read_running_kernel_build_id(struct dso *dso, 281 struct machine *machine); 282 int dso__kernel_module_get_build_id(struct dso *dso, const char *root_dir); 283 284 char dso__symtab_origin(const struct dso *dso); 285 int dso__read_binary_type_filename(const struct dso *dso, enum dso_binary_type type, 286 char *root_dir, char *filename, size_t size); 287 bool is_kernel_module(const char *pathname, int cpumode); 288 bool dso__needs_decompress(struct dso *dso); 289 int dso__decompress_kmodule_fd(struct dso *dso, const char *name); 290 int dso__decompress_kmodule_path(struct dso *dso, const char *name, 291 char *pathname, size_t len); 292 int filename__decompress(const char *name, char *pathname, 293 size_t len, int comp, int *err); 294 295 #define KMOD_DECOMP_NAME "/tmp/perf-kmod-XXXXXX" 296 #define KMOD_DECOMP_LEN sizeof(KMOD_DECOMP_NAME) 297 298 struct kmod_path { 299 char *name; 300 int comp; 301 bool kmod; 302 }; 303 304 int __kmod_path__parse(struct kmod_path *m, const char *path, 305 bool alloc_name); 306 307 #define kmod_path__parse(__m, __p) __kmod_path__parse(__m, __p, false) 308 #define kmod_path__parse_name(__m, __p) __kmod_path__parse(__m, __p, true) 309 310 void dso__set_module_info(struct dso *dso, struct kmod_path *m, 311 struct machine *machine); 312 313 /* 314 * The dso__data_* external interface provides following functions: 315 * dso__data_get_fd 316 * dso__data_put_fd 317 * dso__data_close 318 * dso__data_size 319 * dso__data_read_offset 320 * dso__data_read_addr 321 * dso__data_write_cache_offs 322 * dso__data_write_cache_addr 323 * 324 * Please refer to the dso.c object code for each function and 325 * arguments documentation. Following text tries to explain the 326 * dso file descriptor caching. 327 * 328 * The dso__data* interface allows caching of opened file descriptors 329 * to speed up the dso data accesses. The idea is to leave the file 330 * descriptor opened ideally for the whole life of the dso object. 331 * 332 * The current usage of the dso__data_* interface is as follows: 333 * 334 * Get DSO's fd: 335 * int fd = dso__data_get_fd(dso, machine); 336 * if (fd >= 0) { 337 * USE 'fd' SOMEHOW 338 * dso__data_put_fd(dso); 339 * } 340 * 341 * Read DSO's data: 342 * n = dso__data_read_offset(dso_0, &machine, 0, buf, BUFSIZE); 343 * n = dso__data_read_addr(dso_0, &machine, 0, buf, BUFSIZE); 344 * 345 * Eventually close DSO's fd: 346 * dso__data_close(dso); 347 * 348 * It is not necessary to close the DSO object data file. Each time new 349 * DSO data file is opened, the limit (RLIMIT_NOFILE/2) is checked. Once 350 * it is crossed, the oldest opened DSO object is closed. 351 * 352 * The dso__delete function calls close_dso function to ensure the 353 * data file descriptor gets closed/unmapped before the dso object 354 * is freed. 355 * 356 * TODO 357 */ 358 int dso__data_get_fd(struct dso *dso, struct machine *machine); 359 void dso__data_put_fd(struct dso *dso); 360 void dso__data_close(struct dso *dso); 361 362 int dso__data_file_size(struct dso *dso, struct machine *machine); 363 off_t dso__data_size(struct dso *dso, struct machine *machine); 364 ssize_t dso__data_read_offset(struct dso *dso, struct machine *machine, 365 u64 offset, u8 *data, ssize_t size); 366 ssize_t dso__data_read_addr(struct dso *dso, struct map *map, 367 struct machine *machine, u64 addr, 368 u8 *data, ssize_t size); 369 bool dso__data_status_seen(struct dso *dso, enum dso_data_status_seen by); 370 ssize_t dso__data_write_cache_offs(struct dso *dso, struct machine *machine, 371 u64 offset, const u8 *data, ssize_t size); 372 ssize_t dso__data_write_cache_addr(struct dso *dso, struct map *map, 373 struct machine *machine, u64 addr, 374 const u8 *data, ssize_t size); 375 376 struct map *dso__new_map(const char *name); 377 struct dso *machine__findnew_kernel(struct machine *machine, const char *name, 378 const char *short_name, int dso_type); 379 380 void dso__reset_find_symbol_cache(struct dso *dso); 381 382 size_t dso__fprintf_symbols_by_name(struct dso *dso, FILE *fp); 383 size_t dso__fprintf(struct dso *dso, FILE *fp); 384 385 static inline bool dso__is_vmlinux(const struct dso *dso) 386 { 387 return dso->binary_type == DSO_BINARY_TYPE__VMLINUX || 388 dso->binary_type == DSO_BINARY_TYPE__GUEST_VMLINUX; 389 } 390 391 static inline bool dso__is_kcore(const struct dso *dso) 392 { 393 return dso->binary_type == DSO_BINARY_TYPE__KCORE || 394 dso->binary_type == DSO_BINARY_TYPE__GUEST_KCORE; 395 } 396 397 static inline bool dso__is_kallsyms(const struct dso *dso) 398 { 399 return dso->kernel && dso->long_name[0] != '/'; 400 } 401 402 bool dso__is_object_file(const struct dso *dso); 403 404 void dso__free_a2l(struct dso *dso); 405 406 enum dso_type dso__type(struct dso *dso, struct machine *machine); 407 408 int dso__strerror_load(struct dso *dso, char *buf, size_t buflen); 409 410 void reset_fd_limit(void); 411 412 #endif /* __PERF_DSO */ 413