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