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