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