tools/perf/util/event.h

   1 #ifndef __PERF_RECORD_H
   2 #define __PERF_RECORD_H
   3
   4 #include <limits.h>
   5 #include <stdio.h>
   6
   7 #include "../perf.h"
   8 #include "map.h"
   9 #include "build-id.h"
  10 #include "perf_regs.h"
  11
  12 struct mmap_event {
  13         struct perf_event_header header;
  14         u32 pid, tid;
  15         u64 start;
  16         u64 len;
  17         u64 pgoff;
  18         char filename[PATH_MAX];
  19 };
  20
  21 struct mmap2_event {
  22         struct perf_event_header header;
  23         u32 pid, tid;
  24         u64 start;
  25         u64 len;
  26         u64 pgoff;
  27         u32 maj;
  28         u32 min;
  29         u64 ino;
  30         u64 ino_generation;
  31         u32 prot;
  32         u32 flags;
  33         char filename[PATH_MAX];
  34 };
  35
  36 struct comm_event {
  37         struct perf_event_header header;
  38         u32 pid, tid;
  39         char comm[16];
  40 };
  41
  42 struct fork_event {
  43         struct perf_event_header header;
  44         u32 pid, ppid;
  45         u32 tid, ptid;
  46         u64 time;
  47 };
  48
  49 struct lost_event {
  50         struct perf_event_header header;
  51         u64 id;
  52         u64 lost;
  53 };
  54
  55 /*
  56  * PERF_FORMAT_ENABLED | PERF_FORMAT_RUNNING | PERF_FORMAT_ID
  57  */
  58 struct read_event {
  59         struct perf_event_header header;
  60         u32 pid, tid;
  61         u64 value;
  62         u64 time_enabled;
  63         u64 time_running;
  64         u64 id;
  65 };
  66
  67 struct throttle_event {
  68         struct perf_event_header header;
  69         u64 time;
  70         u64 id;
  71         u64 stream_id;
  72 };
  73
  74 #define PERF_SAMPLE_MASK                                \
  75         (PERF_SAMPLE_IP | PERF_SAMPLE_TID |             \
  76          PERF_SAMPLE_TIME | PERF_SAMPLE_ADDR |          \
  77         PERF_SAMPLE_ID | PERF_SAMPLE_STREAM_ID |        \
  78          PERF_SAMPLE_CPU | PERF_SAMPLE_PERIOD |         \
  79          PERF_SAMPLE_IDENTIFIER)
  80
  81 /* perf sample has 16 bits size limit */
  82 #define PERF_SAMPLE_MAX_SIZE (1 << 16)
  83
  84 struct sample_event {
  85         struct perf_event_header        header;
  86         u64 array[];
  87 };
  88
  89 struct regs_dump {
  90         u64 abi;
  91         u64 mask;
  92         u64 *regs;
  93
  94         /* Cached values/mask filled by first register access. */
  95         u64 cache_regs[PERF_REGS_MAX];
  96         u64 cache_mask;
  97 };
  98
  99 struct stack_dump {
 100         u16 offset;
 101         u64 size;
 102         char *data;
 103 };
 104
 105 struct sample_read_value {
 106         u64 value;
 107         u64 id;
 108 };
 109
 110 struct sample_read {
 111         u64 time_enabled;
 112         u64 time_running;
 113         union {
 114                 struct {
 115                         u64 nr;
 116                         struct sample_read_value *values;
 117                 } group;
 118                 struct sample_read_value one;
 119         };
 120 };
 121
 122 struct ip_callchain {
 123         u64 nr;
 124         u64 ips[0];
 125 };
 126
 127 struct branch_flags {
 128         u64 mispred:1;
 129         u64 predicted:1;
 130         u64 in_tx:1;
 131         u64 abort:1;
 132         u64 reserved:60;
 133 };
 134
 135 struct branch_entry {
 136         u64                     from;
 137         u64                     to;
 138         struct branch_flags     flags;
 139 };
 140
 141 struct branch_stack {
 142         u64                     nr;
 143         struct branch_entry     entries[0];
 144 };
 145
 146 struct perf_sample {
 147         u64 ip;
 148         u32 pid, tid;
 149         u64 time;
 150         u64 addr;
 151         u64 id;
 152         u64 stream_id;
 153         u64 period;
 154         u64 weight;
 155         u64 transaction;
 156         u32 cpu;
 157         u32 raw_size;
 158         u64 data_src;
 159         u32 flags;
 160         u16 insn_len;
 161         void *raw_data;
 162         struct ip_callchain *callchain;
 163         struct branch_stack *branch_stack;
 164         struct regs_dump  user_regs;
 165         struct stack_dump user_stack;
 166         struct sample_read read;
 167 };
 168
 169 #define PERF_MEM_DATA_SRC_NONE \
 170         (PERF_MEM_S(OP, NA) |\
 171          PERF_MEM_S(LVL, NA) |\
 172          PERF_MEM_S(SNOOP, NA) |\
 173          PERF_MEM_S(LOCK, NA) |\
 174          PERF_MEM_S(TLB, NA))
 175
 176 struct build_id_event {
 177         struct perf_event_header header;
 178         pid_t                    pid;
 179         u8                       build_id[PERF_ALIGN(BUILD_ID_SIZE, sizeof(u64))];
 180         char                     filename[];
 181 };
 182
 183 enum perf_user_event_type { /* above any possible kernel type */
 184         PERF_RECORD_USER_TYPE_START             = 64,
 185         PERF_RECORD_HEADER_ATTR                 = 64,
 186         PERF_RECORD_HEADER_EVENT_TYPE           = 65, /* depreceated */
 187         PERF_RECORD_HEADER_TRACING_DATA         = 66,
 188         PERF_RECORD_HEADER_BUILD_ID             = 67,
 189         PERF_RECORD_FINISHED_ROUND              = 68,
 190         PERF_RECORD_ID_INDEX                    = 69,
 191         PERF_RECORD_HEADER_MAX
 192 };
 193
 194 /*
 195  * The kernel collects the number of events it couldn't send in a stretch and
 196  * when possible sends this number in a PERF_RECORD_LOST event. The number of
 197  * such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
 198  * total_lost tells exactly how many events the kernel in fact lost, i.e. it is
 199  * the sum of all struct lost_event.lost fields reported.
 200  *
 201  * The total_period is needed because by default auto-freq is used, so
 202  * multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
 203  * the total number of low level events, it is necessary to to sum all struct
 204  * sample_event.period and stash the result in total_period.
 205  */
 206 struct events_stats {
 207         u64 total_period;
 208         u64 total_non_filtered_period;
 209         u64 total_lost;
 210         u64 total_invalid_chains;
 211         u32 nr_events[PERF_RECORD_HEADER_MAX];
 212         u32 nr_non_filtered_samples;
 213         u32 nr_lost_warned;
 214         u32 nr_unknown_events;
 215         u32 nr_invalid_chains;
 216         u32 nr_unknown_id;
 217         u32 nr_unprocessable_samples;
 218 };
 219
 220 struct attr_event {
 221         struct perf_event_header header;
 222         struct perf_event_attr attr;
 223         u64 id[];
 224 };
 225
 226 #define MAX_EVENT_NAME 64
 227
 228 struct perf_trace_event_type {
 229         u64     event_id;
 230         char    name[MAX_EVENT_NAME];
 231 };
 232
 233 struct event_type_event {
 234         struct perf_event_header header;
 235         struct perf_trace_event_type event_type;
 236 };
 237
 238 struct tracing_data_event {
 239         struct perf_event_header header;
 240         u32 size;
 241 };
 242
 243 struct id_index_entry {
 244         u64 id;
 245         u64 idx;
 246         u64 cpu;
 247         u64 tid;
 248 };
 249
 250 struct id_index_event {
 251         struct perf_event_header header;
 252         u64 nr;
 253         struct id_index_entry entries[0];
 254 };
 255
 256 union perf_event {
 257         struct perf_event_header        header;
 258         struct mmap_event               mmap;
 259         struct mmap2_event              mmap2;
 260         struct comm_event               comm;
 261         struct fork_event               fork;
 262         struct lost_event               lost;
 263         struct read_event               read;
 264         struct throttle_event           throttle;
 265         struct sample_event             sample;
 266         struct attr_event               attr;
 267         struct event_type_event         event_type;
 268         struct tracing_data_event       tracing_data;
 269         struct build_id_event           build_id;
 270         struct id_index_event           id_index;
 271 };
 272
 273 void perf_event__print_totals(void);
 274
 275 struct perf_tool;
 276 struct thread_map;
 277
 278 typedef int (*perf_event__handler_t)(struct perf_tool *tool,
 279                                      union perf_event *event,
 280                                      struct perf_sample *sample,
 281                                      struct machine *machine);
 282
 283 int perf_event__synthesize_thread_map(struct perf_tool *tool,
 284                                       struct thread_map *threads,
 285                                       perf_event__handler_t process,
 286                                       struct machine *machine, bool mmap_data);
 287 int perf_event__synthesize_threads(struct perf_tool *tool,
 288                                    perf_event__handler_t process,
 289                                    struct machine *machine, bool mmap_data);
 290 int perf_event__synthesize_kernel_mmap(struct perf_tool *tool,
 291                                        perf_event__handler_t process,
 292                                        struct machine *machine);
 293
 294 int perf_event__synthesize_modules(struct perf_tool *tool,
 295                                    perf_event__handler_t process,
 296                                    struct machine *machine);
 297
 298 int perf_event__process_comm(struct perf_tool *tool,
 299                              union perf_event *event,
 300                              struct perf_sample *sample,
 301                              struct machine *machine);
 302 int perf_event__process_lost(struct perf_tool *tool,
 303                              union perf_event *event,
 304                              struct perf_sample *sample,
 305                              struct machine *machine);
 306 int perf_event__process_mmap(struct perf_tool *tool,
 307                              union perf_event *event,
 308                              struct perf_sample *sample,
 309                              struct machine *machine);
 310 int perf_event__process_mmap2(struct perf_tool *tool,
 311                              union perf_event *event,
 312                              struct perf_sample *sample,
 313                              struct machine *machine);
 314 int perf_event__process_fork(struct perf_tool *tool,
 315                              union perf_event *event,
 316                              struct perf_sample *sample,
 317                              struct machine *machine);
 318 int perf_event__process_exit(struct perf_tool *tool,
 319                              union perf_event *event,
 320                              struct perf_sample *sample,
 321                              struct machine *machine);
 322 int perf_event__process(struct perf_tool *tool,
 323                         union perf_event *event,
 324                         struct perf_sample *sample,
 325                         struct machine *machine);
 326
 327 struct addr_location;
 328
 329 int perf_event__preprocess_sample(const union perf_event *event,
 330                                   struct machine *machine,
 331                                   struct addr_location *al,
 332                                   struct perf_sample *sample);
 333
 334 struct thread;
 335
 336 bool is_bts_event(struct perf_event_attr *attr);
 337 bool sample_addr_correlates_sym(struct perf_event_attr *attr);
 338 void perf_event__preprocess_sample_addr(union perf_event *event,
 339                                         struct perf_sample *sample,
 340                                         struct thread *thread,
 341                                         struct addr_location *al);
 342
 343 const char *perf_event__name(unsigned int id);
 344
 345 size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type,
 346                                      u64 read_format);
 347 int perf_event__synthesize_sample(union perf_event *event, u64 type,
 348                                   u64 read_format,
 349                                   const struct perf_sample *sample,
 350                                   bool swapped);
 351
 352 int perf_event__synthesize_mmap_events(struct perf_tool *tool,
 353                                        union perf_event *event,
 354                                        pid_t pid, pid_t tgid,
 355                                        perf_event__handler_t process,
 356                                        struct machine *machine,
 357                                        bool mmap_data);
 358
 359 size_t perf_event__fprintf_comm(union perf_event *event, FILE *fp);
 360 size_t perf_event__fprintf_mmap(union perf_event *event, FILE *fp);
 361 size_t perf_event__fprintf_mmap2(union perf_event *event, FILE *fp);
 362 size_t perf_event__fprintf_task(union perf_event *event, FILE *fp);
 363 size_t perf_event__fprintf(union perf_event *event, FILE *fp);
 364
 365 u64 kallsyms__get_function_start(const char *kallsyms_filename,
 366                                  const char *symbol_name);
 367
 368 #endif /* __PERF_RECORD_H */