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 /* 94 * DSOs are put into both a list for fast iteration and rbtree for fast 95 * long name lookup. 96 */ 97 struct dsos { 98 struct list_head head; 99 struct rb_root root; /* rbtree root sorted by long name */ 100 }; 101 102 struct dso { 103 struct list_head node; 104 struct rb_node rb_node; /* rbtree node sorted by long name */ 105 struct rb_root symbols[MAP__NR_TYPES]; 106 struct rb_root symbol_names[MAP__NR_TYPES]; 107 void *a2l; 108 char *symsrc_filename; 109 unsigned int a2l_fails; 110 enum dso_kernel_type kernel; 111 enum dso_swap_type needs_swap; 112 enum dso_binary_type symtab_type; 113 enum dso_binary_type binary_type; 114 u8 adjust_symbols:1; 115 u8 has_build_id:1; 116 u8 has_srcline:1; 117 u8 hit:1; 118 u8 annotate_warned:1; 119 u8 short_name_allocated:1; 120 u8 long_name_allocated:1; 121 u8 is_64_bit:1; 122 u8 sorted_by_name; 123 u8 loaded; 124 u8 rel; 125 u8 build_id[BUILD_ID_SIZE]; 126 const char *short_name; 127 const char *long_name; 128 u16 long_name_len; 129 u16 short_name_len; 130 131 /* dso data file */ 132 struct { 133 struct rb_root cache; 134 int fd; 135 int status; 136 u32 status_seen; 137 size_t file_size; 138 struct list_head open_entry; 139 } data; 140 141 char name[0]; 142 }; 143 144 /* dso__for_each_symbol - iterate over the symbols of given type 145 * 146 * @dso: the 'struct dso *' in which symbols itereated 147 * @pos: the 'struct symbol *' to use as a loop cursor 148 * @n: the 'struct rb_node *' to use as a temporary storage 149 * @type: the 'enum map_type' type of symbols 150 */ 151 #define dso__for_each_symbol(dso, pos, n, type) \ 152 symbols__for_each_entry(&(dso)->symbols[(type)], pos, n) 153 154 static inline void dso__set_loaded(struct dso *dso, enum map_type type) 155 { 156 dso->loaded |= (1 << type); 157 } 158 159 struct dso *dso__new(const char *name); 160 void dso__delete(struct dso *dso); 161 162 void dso__set_short_name(struct dso *dso, const char *name, bool name_allocated); 163 void dso__set_long_name(struct dso *dso, const char *name, bool name_allocated); 164 165 int dso__name_len(const struct dso *dso); 166 167 bool dso__loaded(const struct dso *dso, enum map_type type); 168 169 bool dso__sorted_by_name(const struct dso *dso, enum map_type type); 170 void dso__set_sorted_by_name(struct dso *dso, enum map_type type); 171 void dso__sort_by_name(struct dso *dso, enum map_type type); 172 173 void dso__set_build_id(struct dso *dso, void *build_id); 174 bool dso__build_id_equal(const struct dso *dso, u8 *build_id); 175 void dso__read_running_kernel_build_id(struct dso *dso, 176 struct machine *machine); 177 int dso__kernel_module_get_build_id(struct dso *dso, const char *root_dir); 178 179 char dso__symtab_origin(const struct dso *dso); 180 int dso__read_binary_type_filename(const struct dso *dso, enum dso_binary_type type, 181 char *root_dir, char *filename, size_t size); 182 183 /* 184 * The dso__data_* external interface provides following functions: 185 * dso__data_fd 186 * dso__data_close 187 * dso__data_size 188 * dso__data_read_offset 189 * dso__data_read_addr 190 * 191 * Please refer to the dso.c object code for each function and 192 * arguments documentation. Following text tries to explain the 193 * dso file descriptor caching. 194 * 195 * The dso__data* interface allows caching of opened file descriptors 196 * to speed up the dso data accesses. The idea is to leave the file 197 * descriptor opened ideally for the whole life of the dso object. 198 * 199 * The current usage of the dso__data_* interface is as follows: 200 * 201 * Get DSO's fd: 202 * int fd = dso__data_fd(dso, machine); 203 * USE 'fd' SOMEHOW 204 * 205 * Read DSO's data: 206 * n = dso__data_read_offset(dso_0, &machine, 0, buf, BUFSIZE); 207 * n = dso__data_read_addr(dso_0, &machine, 0, buf, BUFSIZE); 208 * 209 * Eventually close DSO's fd: 210 * dso__data_close(dso); 211 * 212 * It is not necessary to close the DSO object data file. Each time new 213 * DSO data file is opened, the limit (RLIMIT_NOFILE/2) is checked. Once 214 * it is crossed, the oldest opened DSO object is closed. 215 * 216 * The dso__delete function calls close_dso function to ensure the 217 * data file descriptor gets closed/unmapped before the dso object 218 * is freed. 219 * 220 * TODO 221 */ 222 int dso__data_fd(struct dso *dso, struct machine *machine); 223 void dso__data_close(struct dso *dso); 224 225 off_t dso__data_size(struct dso *dso, struct machine *machine); 226 ssize_t dso__data_read_offset(struct dso *dso, struct machine *machine, 227 u64 offset, u8 *data, ssize_t size); 228 ssize_t dso__data_read_addr(struct dso *dso, struct map *map, 229 struct machine *machine, u64 addr, 230 u8 *data, ssize_t size); 231 bool dso__data_status_seen(struct dso *dso, enum dso_data_status_seen by); 232 233 struct map *dso__new_map(const char *name); 234 struct dso *dso__kernel_findnew(struct machine *machine, const char *name, 235 const char *short_name, int dso_type); 236 237 void dsos__add(struct dsos *dsos, struct dso *dso); 238 struct dso *dsos__find(const struct dsos *dsos, const char *name, 239 bool cmp_short); 240 struct dso *__dsos__findnew(struct dsos *dsos, const char *name); 241 bool __dsos__read_build_ids(struct list_head *head, bool with_hits); 242 243 size_t __dsos__fprintf_buildid(struct list_head *head, FILE *fp, 244 bool (skip)(struct dso *dso, int parm), int parm); 245 size_t __dsos__fprintf(struct list_head *head, FILE *fp); 246 247 size_t dso__fprintf_buildid(struct dso *dso, FILE *fp); 248 size_t dso__fprintf_symbols_by_name(struct dso *dso, 249 enum map_type type, FILE *fp); 250 size_t dso__fprintf(struct dso *dso, enum map_type type, FILE *fp); 251 252 static inline bool dso__is_vmlinux(struct dso *dso) 253 { 254 return dso->binary_type == DSO_BINARY_TYPE__VMLINUX || 255 dso->binary_type == DSO_BINARY_TYPE__GUEST_VMLINUX; 256 } 257 258 static inline bool dso__is_kcore(struct dso *dso) 259 { 260 return dso->binary_type == DSO_BINARY_TYPE__KCORE || 261 dso->binary_type == DSO_BINARY_TYPE__GUEST_KCORE; 262 } 263 264 void dso__free_a2l(struct dso *dso); 265 266 enum dso_type dso__type(struct dso *dso, struct machine *machine); 267 268 #endif /* __PERF_DSO */ 269