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