tools/perf/util/dso.h

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