tools/perf/util/dso.h

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