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 struct lost_samples_event {
  56         struct perf_event_header header;
  57         u64 lost;
  58 };
  59
  60 /*
  61  * PERF_FORMAT_ENABLED | PERF_FORMAT_RUNNING | PERF_FORMAT_ID
  62  */
  63 struct read_event {
  64         struct perf_event_header header;
  65         u32 pid, tid;
  66         u64 value;
  67         u64 time_enabled;
  68         u64 time_running;
  69         u64 id;
  70 };
  71
  72 struct throttle_event {
  73         struct perf_event_header header;
  74         u64 time;
  75         u64 id;
  76         u64 stream_id;
  77 };
  78
  79 #define PERF_SAMPLE_MASK                                \
  80         (PERF_SAMPLE_IP | PERF_SAMPLE_TID |             \
  81          PERF_SAMPLE_TIME | PERF_SAMPLE_ADDR |          \
  82         PERF_SAMPLE_ID | PERF_SAMPLE_STREAM_ID |        \
  83          PERF_SAMPLE_CPU | PERF_SAMPLE_PERIOD |         \
  84          PERF_SAMPLE_IDENTIFIER)
  85
  86 /* perf sample has 16 bits size limit */
  87 #define PERF_SAMPLE_MAX_SIZE (1 << 16)
  88
  89 struct sample_event {
  90         struct perf_event_header        header;
  91         u64 array[];
  92 };
  93
  94 struct regs_dump {
  95         u64 abi;
  96         u64 mask;
  97         u64 *regs;
  98
  99         /* Cached values/mask filled by first register access. */
 100         u64 cache_regs[PERF_REGS_MAX];
 101         u64 cache_mask;
 102 };
 103
 104 struct stack_dump {
 105         u16 offset;
 106         u64 size;
 107         char *data;
 108 };
 109
 110 struct sample_read_value {
 111         u64 value;
 112         u64 id;
 113 };
 114
 115 struct sample_read {
 116         u64 time_enabled;
 117         u64 time_running;
 118         union {
 119                 struct {
 120                         u64 nr;
 121                         struct sample_read_value *values;
 122                 } group;
 123                 struct sample_read_value one;
 124         };
 125 };
 126
 127 struct ip_callchain {
 128         u64 nr;
 129         u64 ips[0];
 130 };
 131
 132 struct branch_flags {
 133         u64 mispred:1;
 134         u64 predicted:1;
 135         u64 in_tx:1;
 136         u64 abort:1;
 137         u64 cycles:16;
 138         u64 reserved:44;
 139 };
 140
 141 struct branch_entry {
 142         u64                     from;
 143         u64                     to;
 144         struct branch_flags     flags;
 145 };
 146
 147 struct branch_stack {
 148         u64                     nr;
 149         struct branch_entry     entries[0];
 150 };
 151
 152 enum {
 153         PERF_IP_FLAG_BRANCH             = 1ULL << 0,
 154         PERF_IP_FLAG_CALL               = 1ULL << 1,
 155         PERF_IP_FLAG_RETURN             = 1ULL << 2,
 156         PERF_IP_FLAG_CONDITIONAL        = 1ULL << 3,
 157         PERF_IP_FLAG_SYSCALLRET         = 1ULL << 4,
 158         PERF_IP_FLAG_ASYNC              = 1ULL << 5,
 159         PERF_IP_FLAG_INTERRUPT          = 1ULL << 6,
 160         PERF_IP_FLAG_TX_ABORT           = 1ULL << 7,
 161         PERF_IP_FLAG_TRACE_BEGIN        = 1ULL << 8,
 162         PERF_IP_FLAG_TRACE_END          = 1ULL << 9,
 163         PERF_IP_FLAG_IN_TX              = 1ULL << 10,
 164 };
 165
 166 #define PERF_IP_FLAG_CHARS "bcrosyiABEx"
 167
 168 #define PERF_BRANCH_MASK                (\
 169         PERF_IP_FLAG_BRANCH             |\
 170         PERF_IP_FLAG_CALL               |\
 171         PERF_IP_FLAG_RETURN             |\
 172         PERF_IP_FLAG_CONDITIONAL        |\
 173         PERF_IP_FLAG_SYSCALLRET         |\
 174         PERF_IP_FLAG_ASYNC              |\
 175         PERF_IP_FLAG_INTERRUPT          |\
 176         PERF_IP_FLAG_TX_ABORT           |\
 177         PERF_IP_FLAG_TRACE_BEGIN        |\
 178         PERF_IP_FLAG_TRACE_END)
 179
 180 struct perf_sample {
 181         u64 ip;
 182         u32 pid, tid;
 183         u64 time;
 184         u64 addr;
 185         u64 id;
 186         u64 stream_id;
 187         u64 period;
 188         u64 weight;
 189         u64 transaction;
 190         u32 cpu;
 191         u32 raw_size;
 192         u64 data_src;
 193         u32 flags;
 194         u16 insn_len;
 195         void *raw_data;
 196         struct ip_callchain *callchain;
 197         struct branch_stack *branch_stack;
 198         struct regs_dump  user_regs;
 199         struct regs_dump  intr_regs;
 200         struct stack_dump user_stack;
 201         struct sample_read read;
 202 };
 203
 204 #define PERF_MEM_DATA_SRC_NONE \
 205         (PERF_MEM_S(OP, NA) |\
 206          PERF_MEM_S(LVL, NA) |\
 207          PERF_MEM_S(SNOOP, NA) |\
 208          PERF_MEM_S(LOCK, NA) |\
 209          PERF_MEM_S(TLB, NA))
 210
 211 struct build_id_event {
 212         struct perf_event_header header;
 213         pid_t                    pid;
 214         u8                       build_id[PERF_ALIGN(BUILD_ID_SIZE, sizeof(u64))];
 215         char                     filename[];
 216 };
 217
 218 enum perf_user_event_type { /* above any possible kernel type */
 219         PERF_RECORD_USER_TYPE_START             = 64,
 220         PERF_RECORD_HEADER_ATTR                 = 64,
 221         PERF_RECORD_HEADER_EVENT_TYPE           = 65, /* depreceated */
 222         PERF_RECORD_HEADER_TRACING_DATA         = 66,
 223         PERF_RECORD_HEADER_BUILD_ID             = 67,
 224         PERF_RECORD_FINISHED_ROUND              = 68,
 225         PERF_RECORD_ID_INDEX                    = 69,
 226         PERF_RECORD_AUXTRACE_INFO               = 70,
 227         PERF_RECORD_AUXTRACE                    = 71,
 228         PERF_RECORD_AUXTRACE_ERROR              = 72,
 229         PERF_RECORD_HEADER_MAX
 230 };
 231
 232 enum auxtrace_error_type {
 233         PERF_AUXTRACE_ERROR_ITRACE  = 1,
 234         PERF_AUXTRACE_ERROR_MAX
 235 };
 236
 237 /*
 238  * The kernel collects the number of events it couldn't send in a stretch and
 239  * when possible sends this number in a PERF_RECORD_LOST event. The number of
 240  * such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
 241  * total_lost tells exactly how many events the kernel in fact lost, i.e. it is
 242  * the sum of all struct lost_event.lost fields reported.
 243  *
 244  * The kernel discards mixed up samples and sends the number in a
 245  * PERF_RECORD_LOST_SAMPLES event. The number of lost-samples events is stored
 246  * in .nr_events[PERF_RECORD_LOST_SAMPLES] while total_lost_samples tells
 247  * exactly how many samples the kernel in fact dropped, i.e. it is the sum of
 248  * all struct lost_samples_event.lost fields reported.
 249  *
 250  * The total_period is needed because by default auto-freq is used, so
 251  * multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
 252  * the total number of low level events, it is necessary to to sum all struct
 253  * sample_event.period and stash the result in total_period.
 254  */
 255 struct events_stats {
 256         u64 total_period;
 257         u64 total_non_filtered_period;
 258         u64 total_lost;
 259         u64 total_lost_samples;
 260         u64 total_aux_lost;
 261         u64 total_invalid_chains;
 262         u32 nr_events[PERF_RECORD_HEADER_MAX];
 263         u32 nr_non_filtered_samples;
 264         u32 nr_lost_warned;
 265         u32 nr_unknown_events;
 266         u32 nr_invalid_chains;
 267         u32 nr_unknown_id;
 268         u32 nr_unprocessable_samples;
 269         u32 nr_auxtrace_errors[PERF_AUXTRACE_ERROR_MAX];
 270         u32 nr_proc_map_timeout;
 271 };
 272
 273 struct attr_event {
 274         struct perf_event_header header;
 275         struct perf_event_attr attr;
 276         u64 id[];
 277 };
 278
 279 #define MAX_EVENT_NAME 64
 280
 281 struct perf_trace_event_type {
 282         u64     event_id;
 283         char    name[MAX_EVENT_NAME];
 284 };
 285
 286 struct event_type_event {
 287         struct perf_event_header header;
 288         struct perf_trace_event_type event_type;
 289 };
 290
 291 struct tracing_data_event {
 292         struct perf_event_header header;
 293         u32 size;
 294 };
 295
 296 struct id_index_entry {
 297         u64 id;
 298         u64 idx;
 299         u64 cpu;
 300         u64 tid;
 301 };
 302
 303 struct id_index_event {
 304         struct perf_event_header header;
 305         u64 nr;
 306         struct id_index_entry entries[0];
 307 };
 308
 309 struct auxtrace_info_event {
 310         struct perf_event_header header;
 311         u32 type;
 312         u32 reserved__; /* For alignment */
 313         u64 priv[];
 314 };
 315
 316 struct auxtrace_event {
 317         struct perf_event_header header;
 318         u64 size;
 319         u64 offset;
 320         u64 reference;
 321         u32 idx;
 322         u32 tid;
 323         u32 cpu;
 324         u32 reserved__; /* For alignment */
 325 };
 326
 327 #define MAX_AUXTRACE_ERROR_MSG 64
 328
 329 struct auxtrace_error_event {
 330         struct perf_event_header header;
 331         u32 type;
 332         u32 code;
 333         u32 cpu;
 334         u32 pid;
 335         u32 tid;
 336         u32 reserved__; /* For alignment */
 337         u64 ip;
 338         char msg[MAX_AUXTRACE_ERROR_MSG];
 339 };
 340
 341 struct aux_event {
 342         struct perf_event_header header;
 343         u64     aux_offset;
 344         u64     aux_size;
 345         u64     flags;
 346 };
 347
 348 struct itrace_start_event {
 349         struct perf_event_header header;
 350         u32 pid, tid;
 351 };
 352
 353 struct context_switch_event {
 354         struct perf_event_header header;
 355         u32 next_prev_pid;
 356         u32 next_prev_tid;
 357 };
 358
 359 union perf_event {
 360         struct perf_event_header        header;
 361         struct mmap_event               mmap;
 362         struct mmap2_event              mmap2;
 363         struct comm_event               comm;
 364         struct fork_event               fork;
 365         struct lost_event               lost;
 366         struct lost_samples_event       lost_samples;
 367         struct read_event               read;
 368         struct throttle_event           throttle;
 369         struct sample_event             sample;
 370         struct attr_event               attr;
 371         struct event_type_event         event_type;
 372         struct tracing_data_event       tracing_data;
 373         struct build_id_event           build_id;
 374         struct id_index_event           id_index;
 375         struct auxtrace_info_event      auxtrace_info;
 376         struct auxtrace_event           auxtrace;
 377         struct auxtrace_error_event     auxtrace_error;
 378         struct aux_event                aux;
 379         struct itrace_start_event       itrace_start;
 380         struct context_switch_event     context_switch;
 381 };
 382
 383 void perf_event__print_totals(void);
 384
 385 struct perf_tool;
 386 struct thread_map;
 387
 388 typedef int (*perf_event__handler_t)(struct perf_tool *tool,
 389                                      union perf_event *event,
 390                                      struct perf_sample *sample,
 391                                      struct machine *machine);
 392
 393 int perf_event__synthesize_thread_map(struct perf_tool *tool,
 394                                       struct thread_map *threads,
 395                                       perf_event__handler_t process,
 396                                       struct machine *machine, bool mmap_data,
 397                                       unsigned int proc_map_timeout);
 398 int perf_event__synthesize_threads(struct perf_tool *tool,
 399                                    perf_event__handler_t process,
 400                                    struct machine *machine, bool mmap_data,
 401                                    unsigned int proc_map_timeout);
 402 int perf_event__synthesize_kernel_mmap(struct perf_tool *tool,
 403                                        perf_event__handler_t process,
 404                                        struct machine *machine);
 405
 406 int perf_event__synthesize_modules(struct perf_tool *tool,
 407                                    perf_event__handler_t process,
 408                                    struct machine *machine);
 409
 410 int perf_event__process_comm(struct perf_tool *tool,
 411                              union perf_event *event,
 412                              struct perf_sample *sample,
 413                              struct machine *machine);
 414 int perf_event__process_lost(struct perf_tool *tool,
 415                              union perf_event *event,
 416                              struct perf_sample *sample,
 417                              struct machine *machine);
 418 int perf_event__process_lost_samples(struct perf_tool *tool,
 419                                      union perf_event *event,
 420                                      struct perf_sample *sample,
 421                                      struct machine *machine);
 422 int perf_event__process_aux(struct perf_tool *tool,
 423                             union perf_event *event,
 424                             struct perf_sample *sample,
 425                             struct machine *machine);
 426 int perf_event__process_itrace_start(struct perf_tool *tool,
 427                                      union perf_event *event,
 428                                      struct perf_sample *sample,
 429                                      struct machine *machine);
 430 int perf_event__process_switch(struct perf_tool *tool,
 431                                union perf_event *event,
 432                                struct perf_sample *sample,
 433                                struct machine *machine);
 434 int perf_event__process_mmap(struct perf_tool *tool,
 435                              union perf_event *event,
 436                              struct perf_sample *sample,
 437                              struct machine *machine);
 438 int perf_event__process_mmap2(struct perf_tool *tool,
 439                              union perf_event *event,
 440                              struct perf_sample *sample,
 441                              struct machine *machine);
 442 int perf_event__process_fork(struct perf_tool *tool,
 443                              union perf_event *event,
 444                              struct perf_sample *sample,
 445                              struct machine *machine);
 446 int perf_event__process_exit(struct perf_tool *tool,
 447                              union perf_event *event,
 448                              struct perf_sample *sample,
 449                              struct machine *machine);
 450 int perf_event__process(struct perf_tool *tool,
 451                         union perf_event *event,
 452                         struct perf_sample *sample,
 453                         struct machine *machine);
 454
 455 struct addr_location;
 456
 457 int perf_event__preprocess_sample(const union perf_event *event,
 458                                   struct machine *machine,
 459                                   struct addr_location *al,
 460                                   struct perf_sample *sample);
 461
 462 void addr_location__put(struct addr_location *al);
 463
 464 struct thread;
 465
 466 bool is_bts_event(struct perf_event_attr *attr);
 467 bool sample_addr_correlates_sym(struct perf_event_attr *attr);
 468 void perf_event__preprocess_sample_addr(union perf_event *event,
 469                                         struct perf_sample *sample,
 470                                         struct thread *thread,
 471                                         struct addr_location *al);
 472
 473 const char *perf_event__name(unsigned int id);
 474
 475 size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type,
 476                                      u64 read_format);
 477 int perf_event__synthesize_sample(union perf_event *event, u64 type,
 478                                   u64 read_format,
 479                                   const struct perf_sample *sample,
 480                                   bool swapped);
 481
 482 pid_t perf_event__synthesize_comm(struct perf_tool *tool,
 483                                   union perf_event *event, pid_t pid,
 484                                   perf_event__handler_t process,
 485                                   struct machine *machine);
 486
 487 int perf_event__synthesize_mmap_events(struct perf_tool *tool,
 488                                        union perf_event *event,
 489                                        pid_t pid, pid_t tgid,
 490                                        perf_event__handler_t process,
 491                                        struct machine *machine,
 492                                        bool mmap_data,
 493                                        unsigned int proc_map_timeout);
 494
 495 size_t perf_event__fprintf_comm(union perf_event *event, FILE *fp);
 496 size_t perf_event__fprintf_mmap(union perf_event *event, FILE *fp);
 497 size_t perf_event__fprintf_mmap2(union perf_event *event, FILE *fp);
 498 size_t perf_event__fprintf_task(union perf_event *event, FILE *fp);
 499 size_t perf_event__fprintf_aux(union perf_event *event, FILE *fp);
 500 size_t perf_event__fprintf_itrace_start(union perf_event *event, FILE *fp);
 501 size_t perf_event__fprintf_switch(union perf_event *event, FILE *fp);
 502 size_t perf_event__fprintf(union perf_event *event, FILE *fp);
 503
 504 u64 kallsyms__get_function_start(const char *kallsyms_filename,
 505                                  const char *symbol_name);
 506
 507 #endif /* __PERF_RECORD_H */