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