tools/perf/util/dso.h

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