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__SYSTEM_PATH_KMODULE, 26 DSO_BINARY_TYPE__KCORE, 27 DSO_BINARY_TYPE__GUEST_KCORE, 28 DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO, 29 DSO_BINARY_TYPE__NOT_FOUND, 30 }; 31 32 enum dso_kernel_type { 33 DSO_TYPE_USER = 0, 34 DSO_TYPE_KERNEL, 35 DSO_TYPE_GUEST_KERNEL 36 }; 37 38 enum dso_swap_type { 39 DSO_SWAP__UNSET, 40 DSO_SWAP__NO, 41 DSO_SWAP__YES, 42 }; 43 44 enum dso_data_status { 45 DSO_DATA_STATUS_ERROR = -1, 46 DSO_DATA_STATUS_UNKNOWN = 0, 47 DSO_DATA_STATUS_OK = 1, 48 }; 49 50 enum dso_data_status_seen { 51 DSO_DATA_STATUS_SEEN_ITRACE, 52 }; 53 54 enum dso_type { 55 DSO__TYPE_UNKNOWN, 56 DSO__TYPE_64BIT, 57 DSO__TYPE_32BIT, 58 DSO__TYPE_X32BIT, 59 }; 60 61 #define DSO__SWAP(dso, type, val) \ 62 ({ \ 63 type ____r = val; \ 64 BUG_ON(dso->needs_swap == DSO_SWAP__UNSET); \ 65 if (dso->needs_swap == DSO_SWAP__YES) { \ 66 switch (sizeof(____r)) { \ 67 case 2: \ 68 ____r = bswap_16(val); \ 69 break; \ 70 case 4: \ 71 ____r = bswap_32(val); \ 72 break; \ 73 case 8: \ 74 ____r = bswap_64(val); \ 75 break; \ 76 default: \ 77 BUG_ON(1); \ 78 } \ 79 } \ 80 ____r; \ 81 }) 82 83 #define DSO__DATA_CACHE_SIZE 4096 84 #define DSO__DATA_CACHE_MASK ~(DSO__DATA_CACHE_SIZE - 1) 85 86 struct dso_cache { 87 struct rb_node rb_node; 88 u64 offset; 89 u64 size; 90 char data[0]; 91 }; 92 93 struct dso { 94 struct list_head node; 95 struct rb_root symbols[MAP__NR_TYPES]; 96 struct rb_root symbol_names[MAP__NR_TYPES]; 97 void *a2l; 98 char *symsrc_filename; 99 unsigned int a2l_fails; 100 enum dso_kernel_type kernel; 101 enum dso_swap_type needs_swap; 102 enum dso_binary_type symtab_type; 103 enum dso_binary_type binary_type; 104 u8 adjust_symbols:1; 105 u8 has_build_id:1; 106 u8 has_srcline:1; 107 u8 hit:1; 108 u8 annotate_warned:1; 109 u8 short_name_allocated:1; 110 u8 long_name_allocated:1; 111 u8 is_64_bit:1; 112 u8 sorted_by_name; 113 u8 loaded; 114 u8 rel; 115 u8 build_id[BUILD_ID_SIZE]; 116 const char *short_name; 117 const char *long_name; 118 u16 long_name_len; 119 u16 short_name_len; 120 121 /* dso data file */ 122 struct { 123 struct rb_root cache; 124 int fd; 125 int status; 126 u32 status_seen; 127 size_t file_size; 128 struct list_head open_entry; 129 } data; 130 131 char name[0]; 132 }; 133 134 /* dso__for_each_symbol - iterate over the symbols of given type 135 * 136 * @dso: the 'struct dso *' in which symbols itereated 137 * @pos: the 'struct symbol *' to use as a loop cursor 138 * @n: the 'struct rb_node *' to use as a temporary storage 139 * @type: the 'enum map_type' type of symbols 140 */ 141 #define dso__for_each_symbol(dso, pos, n, type) \ 142 symbols__for_each_entry(&(dso)->symbols[(type)], pos, n) 143 144 static inline void dso__set_loaded(struct dso *dso, enum map_type type) 145 { 146 dso->loaded |= (1 << type); 147 } 148 149 struct dso *dso__new(const char *name); 150 void dso__delete(struct dso *dso); 151 152 void dso__set_short_name(struct dso *dso, const char *name, bool name_allocated); 153 void dso__set_long_name(struct dso *dso, const char *name, bool name_allocated); 154 155 int dso__name_len(const struct dso *dso); 156 157 bool dso__loaded(const struct dso *dso, enum map_type type); 158 159 bool dso__sorted_by_name(const struct dso *dso, enum map_type type); 160 void dso__set_sorted_by_name(struct dso *dso, enum map_type type); 161 void dso__sort_by_name(struct dso *dso, enum map_type type); 162 163 void dso__set_build_id(struct dso *dso, void *build_id); 164 bool dso__build_id_equal(const struct dso *dso, u8 *build_id); 165 void dso__read_running_kernel_build_id(struct dso *dso, 166 struct machine *machine); 167 int dso__kernel_module_get_build_id(struct dso *dso, const char *root_dir); 168 169 char dso__symtab_origin(const struct dso *dso); 170 int dso__read_binary_type_filename(const struct dso *dso, enum dso_binary_type type, 171 char *root_dir, char *filename, size_t size); 172 173 /* 174 * The dso__data_* external interface provides following functions: 175 * dso__data_fd 176 * dso__data_close 177 * dso__data_size 178 * dso__data_read_offset 179 * dso__data_read_addr 180 * 181 * Please refer to the dso.c object code for each function and 182 * arguments documentation. Following text tries to explain the 183 * dso file descriptor caching. 184 * 185 * The dso__data* interface allows caching of opened file descriptors 186 * to speed up the dso data accesses. The idea is to leave the file 187 * descriptor opened ideally for the whole life of the dso object. 188 * 189 * The current usage of the dso__data_* interface is as follows: 190 * 191 * Get DSO's fd: 192 * int fd = dso__data_fd(dso, machine); 193 * USE 'fd' SOMEHOW 194 * 195 * Read DSO's data: 196 * n = dso__data_read_offset(dso_0, &machine, 0, buf, BUFSIZE); 197 * n = dso__data_read_addr(dso_0, &machine, 0, buf, BUFSIZE); 198 * 199 * Eventually close DSO's fd: 200 * dso__data_close(dso); 201 * 202 * It is not necessary to close the DSO object data file. Each time new 203 * DSO data file is opened, the limit (RLIMIT_NOFILE/2) is checked. Once 204 * it is crossed, the oldest opened DSO object is closed. 205 * 206 * The dso__delete function calls close_dso function to ensure the 207 * data file descriptor gets closed/unmapped before the dso object 208 * is freed. 209 * 210 * TODO 211 */ 212 int dso__data_fd(struct dso *dso, struct machine *machine); 213 void dso__data_close(struct dso *dso); 214 215 off_t dso__data_size(struct dso *dso, struct machine *machine); 216 ssize_t dso__data_read_offset(struct dso *dso, struct machine *machine, 217 u64 offset, u8 *data, ssize_t size); 218 ssize_t dso__data_read_addr(struct dso *dso, struct map *map, 219 struct machine *machine, u64 addr, 220 u8 *data, ssize_t size); 221 bool dso__data_status_seen(struct dso *dso, enum dso_data_status_seen by); 222 223 struct map *dso__new_map(const char *name); 224 struct dso *dso__kernel_findnew(struct machine *machine, const char *name, 225 const char *short_name, int dso_type); 226 227 void dsos__add(struct list_head *head, struct dso *dso); 228 struct dso *dsos__find(const struct list_head *head, const char *name, 229 bool cmp_short); 230 struct dso *__dsos__findnew(struct list_head *head, const char *name); 231 bool __dsos__read_build_ids(struct list_head *head, bool with_hits); 232 233 size_t __dsos__fprintf_buildid(struct list_head *head, FILE *fp, 234 bool (skip)(struct dso *dso, int parm), int parm); 235 size_t __dsos__fprintf(struct list_head *head, FILE *fp); 236 237 size_t dso__fprintf_buildid(struct dso *dso, FILE *fp); 238 size_t dso__fprintf_symbols_by_name(struct dso *dso, 239 enum map_type type, FILE *fp); 240 size_t dso__fprintf(struct dso *dso, enum map_type type, FILE *fp); 241 242 static inline bool dso__is_vmlinux(struct dso *dso) 243 { 244 return dso->binary_type == DSO_BINARY_TYPE__VMLINUX || 245 dso->binary_type == DSO_BINARY_TYPE__GUEST_VMLINUX; 246 } 247 248 static inline bool dso__is_kcore(struct dso *dso) 249 { 250 return dso->binary_type == DSO_BINARY_TYPE__KCORE || 251 dso->binary_type == DSO_BINARY_TYPE__GUEST_KCORE; 252 } 253 254 void dso__free_a2l(struct dso *dso); 255 256 enum dso_type dso__type(struct dso *dso, struct machine *machine); 257 258 #endif /* __PERF_DSO */ 259