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