tools/perf/util/dso.h

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