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 "map.h"
   9 #include "build-id.h"
  10
  11 enum dso_binary_type {
  12         DSO_BINARY_TYPE__KALLSYMS = 0,
  13         DSO_BINARY_TYPE__GUEST_KALLSYMS,
  14         DSO_BINARY_TYPE__VMLINUX,
  15         DSO_BINARY_TYPE__GUEST_VMLINUX,
  16         DSO_BINARY_TYPE__JAVA_JIT,
  17         DSO_BINARY_TYPE__DEBUGLINK,
  18         DSO_BINARY_TYPE__BUILD_ID_CACHE,
  19         DSO_BINARY_TYPE__FEDORA_DEBUGINFO,
  20         DSO_BINARY_TYPE__UBUNTU_DEBUGINFO,
  21         DSO_BINARY_TYPE__BUILDID_DEBUGINFO,
  22         DSO_BINARY_TYPE__SYSTEM_PATH_DSO,
  23         DSO_BINARY_TYPE__GUEST_KMODULE,
  24         DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE,
  25         DSO_BINARY_TYPE__KCORE,
  26         DSO_BINARY_TYPE__GUEST_KCORE,
  27         DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO,
  28         DSO_BINARY_TYPE__NOT_FOUND,
  29 };
  30
  31 enum dso_kernel_type {
  32         DSO_TYPE_USER = 0,
  33         DSO_TYPE_KERNEL,
  34         DSO_TYPE_GUEST_KERNEL
  35 };
  36
  37 enum dso_swap_type {
  38         DSO_SWAP__UNSET,
  39         DSO_SWAP__NO,
  40         DSO_SWAP__YES,
  41 };
  42
  43 #define DSO__SWAP(dso, type, val)                       \
  44 ({                                                      \
  45         type ____r = val;                               \
  46         BUG_ON(dso->needs_swap == DSO_SWAP__UNSET);     \
  47         if (dso->needs_swap == DSO_SWAP__YES) {         \
  48                 switch (sizeof(____r)) {                \
  49                 case 2:                                 \
  50                         ____r = bswap_16(val);          \
  51                         break;                          \
  52                 case 4:                                 \
  53                         ____r = bswap_32(val);          \
  54                         break;                          \
  55                 case 8:                                 \
  56                         ____r = bswap_64(val);          \
  57                         break;                          \
  58                 default:                                \
  59                         BUG_ON(1);                      \
  60                 }                                       \
  61         }                                               \
  62         ____r;                                          \
  63 })
  64
  65 #define DSO__DATA_CACHE_SIZE 4096
  66 #define DSO__DATA_CACHE_MASK ~(DSO__DATA_CACHE_SIZE - 1)
  67
  68 struct dso_cache {
  69         struct rb_node  rb_node;
  70         u64 offset;
  71         u64 size;
  72         char data[0];
  73 };
  74
  75 struct dso {
  76         struct list_head node;
  77         struct rb_root   symbols[MAP__NR_TYPES];
  78         struct rb_root   symbol_names[MAP__NR_TYPES];
  79         void             *a2l;
  80         char             *symsrc_filename;
  81         unsigned int     a2l_fails;
  82         enum dso_kernel_type    kernel;
  83         enum dso_swap_type      needs_swap;
  84         enum dso_binary_type    symtab_type;
  85         enum dso_binary_type    binary_type;
  86         u8               adjust_symbols:1;
  87         u8               has_build_id:1;
  88         u8               has_srcline:1;
  89         u8               hit:1;
  90         u8               annotate_warned:1;
  91         u8               short_name_allocated:1;
  92         u8               long_name_allocated:1;
  93         u8               sorted_by_name;
  94         u8               loaded;
  95         u8               rel;
  96         u8               build_id[BUILD_ID_SIZE];
  97         const char       *short_name;
  98         const char       *long_name;
  99         u16              long_name_len;
 100         u16              short_name_len;
 101
 102         /* dso data file */
 103         struct {
 104                 struct rb_root   cache;
 105                 int              fd;
 106                 size_t           file_size;
 107                 struct list_head open_entry;
 108         } data;
 109
 110         char             name[0];
 111 };
 112
 113 /* dso__for_each_symbol - iterate over the symbols of given type
 114  *
 115  * @dso: the 'struct dso *' in which symbols itereated
 116  * @pos: the 'struct symbol *' to use as a loop cursor
 117  * @n: the 'struct rb_node *' to use as a temporary storage
 118  * @type: the 'enum map_type' type of symbols
 119  */
 120 #define dso__for_each_symbol(dso, pos, n, type) \
 121         symbols__for_each_entry(&(dso)->symbols[(type)], pos, n)
 122
 123 static inline void dso__set_loaded(struct dso *dso, enum map_type type)
 124 {
 125         dso->loaded |= (1 << type);
 126 }
 127
 128 struct dso *dso__new(const char *name);
 129 void dso__delete(struct dso *dso);
 130
 131 void dso__set_short_name(struct dso *dso, const char *name, bool name_allocated);
 132 void dso__set_long_name(struct dso *dso, const char *name, bool name_allocated);
 133
 134 int dso__name_len(const struct dso *dso);
 135
 136 bool dso__loaded(const struct dso *dso, enum map_type type);
 137
 138 bool dso__sorted_by_name(const struct dso *dso, enum map_type type);
 139 void dso__set_sorted_by_name(struct dso *dso, enum map_type type);
 140 void dso__sort_by_name(struct dso *dso, enum map_type type);
 141
 142 void dso__set_build_id(struct dso *dso, void *build_id);
 143 bool dso__build_id_equal(const struct dso *dso, u8 *build_id);
 144 void dso__read_running_kernel_build_id(struct dso *dso,
 145                                        struct machine *machine);
 146 int dso__kernel_module_get_build_id(struct dso *dso, const char *root_dir);
 147
 148 char dso__symtab_origin(const struct dso *dso);
 149 int dso__read_binary_type_filename(const struct dso *dso, enum dso_binary_type type,
 150                                    char *root_dir, char *filename, size_t size);
 151
 152 /*
 153  * The dso__data_* external interface provides following functions:
 154  *   dso__data_fd
 155  *   dso__data_close
 156  *   dso__data_read_offset
 157  *   dso__data_read_addr
 158  *
 159  * Please refer to the dso.c object code for each function and
 160  * arguments documentation. Following text tries to explain the
 161  * dso file descriptor caching.
 162  *
 163  * The dso__data* interface allows caching of opened file descriptors
 164  * to speed up the dso data accesses. The idea is to leave the file
 165  * descriptor opened ideally for the whole life of the dso object.
 166  *
 167  * The current usage of the dso__data_* interface is as follows:
 168  *
 169  * Get DSO's fd:
 170  *   int fd = dso__data_fd(dso, machine);
 171  *   USE 'fd' SOMEHOW
 172  *
 173  * Read DSO's data:
 174  *   n = dso__data_read_offset(dso_0, &machine, 0, buf, BUFSIZE);
 175  *   n = dso__data_read_addr(dso_0, &machine, 0, buf, BUFSIZE);
 176  *
 177  * Eventually close DSO's fd:
 178  *   dso__data_close(dso);
 179  *
 180  * It is not necessary to close the DSO object data file. Each time new
 181  * DSO data file is opened, the limit (RLIMIT_NOFILE/2) is checked. Once
 182  * it is crossed, the oldest opened DSO object is closed.
 183  *
 184  * The dso__delete function calls close_dso function to ensure the
 185  * data file descriptor gets closed/unmapped before the dso object
 186  * is freed.
 187  *
 188  * TODO
 189 */
 190 int dso__data_fd(struct dso *dso, struct machine *machine);
 191 void dso__data_close(struct dso *dso);
 192
 193 ssize_t dso__data_read_offset(struct dso *dso, struct machine *machine,
 194                               u64 offset, u8 *data, ssize_t size);
 195 ssize_t dso__data_read_addr(struct dso *dso, struct map *map,
 196                             struct machine *machine, u64 addr,
 197                             u8 *data, ssize_t size);
 198
 199 struct map *dso__new_map(const char *name);
 200 struct dso *dso__kernel_findnew(struct machine *machine, const char *name,
 201                                 const char *short_name, int dso_type);
 202
 203 void dsos__add(struct list_head *head, struct dso *dso);
 204 struct dso *dsos__find(const struct list_head *head, const char *name,
 205                        bool cmp_short);
 206 struct dso *__dsos__findnew(struct list_head *head, const char *name);
 207 bool __dsos__read_build_ids(struct list_head *head, bool with_hits);
 208
 209 size_t __dsos__fprintf_buildid(struct list_head *head, FILE *fp,
 210                                bool (skip)(struct dso *dso, int parm), int parm);
 211 size_t __dsos__fprintf(struct list_head *head, FILE *fp);
 212
 213 size_t dso__fprintf_buildid(struct dso *dso, FILE *fp);
 214 size_t dso__fprintf_symbols_by_name(struct dso *dso,
 215                                     enum map_type type, FILE *fp);
 216 size_t dso__fprintf(struct dso *dso, enum map_type type, FILE *fp);
 217
 218 static inline bool dso__is_vmlinux(struct dso *dso)
 219 {
 220         return dso->binary_type == DSO_BINARY_TYPE__VMLINUX ||
 221                dso->binary_type == DSO_BINARY_TYPE__GUEST_VMLINUX;
 222 }
 223
 224 static inline bool dso__is_kcore(struct dso *dso)
 225 {
 226         return dso->binary_type == DSO_BINARY_TYPE__KCORE ||
 227                dso->binary_type == DSO_BINARY_TYPE__GUEST_KCORE;
 228 }
 229
 230 void dso__free_a2l(struct dso *dso);
 231
 232 #endif /* __PERF_DSO */