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 enum {
 147         PERF_IP_FLAG_BRANCH             = 1ULL << 0,
 148         PERF_IP_FLAG_CALL               = 1ULL << 1,
 149         PERF_IP_FLAG_RETURN             = 1ULL << 2,
 150         PERF_IP_FLAG_CONDITIONAL        = 1ULL << 3,
 151         PERF_IP_FLAG_SYSCALLRET         = 1ULL << 4,
 152         PERF_IP_FLAG_ASYNC              = 1ULL << 5,
 153         PERF_IP_FLAG_INTERRUPT          = 1ULL << 6,
 154         PERF_IP_FLAG_TX_ABORT           = 1ULL << 7,
 155         PERF_IP_FLAG_TRACE_BEGIN        = 1ULL << 8,
 156         PERF_IP_FLAG_TRACE_END          = 1ULL << 9,
 157         PERF_IP_FLAG_IN_TX              = 1ULL << 10,
 158 };
 159
 160 #define PERF_IP_FLAG_CHARS "bcrosyiABEx"
 161
 162 #define PERF_BRANCH_MASK                (\
 163         PERF_IP_FLAG_BRANCH             |\
 164         PERF_IP_FLAG_CALL               |\
 165         PERF_IP_FLAG_RETURN             |\
 166         PERF_IP_FLAG_CONDITIONAL        |\
 167         PERF_IP_FLAG_SYSCALLRET         |\
 168         PERF_IP_FLAG_ASYNC              |\
 169         PERF_IP_FLAG_INTERRUPT          |\
 170         PERF_IP_FLAG_TX_ABORT           |\
 171         PERF_IP_FLAG_TRACE_BEGIN        |\
 172         PERF_IP_FLAG_TRACE_END)
 173
 174 struct perf_sample {
 175         u64 ip;
 176         u32 pid, tid;
 177         u64 time;
 178         u64 addr;
 179         u64 id;
 180         u64 stream_id;
 181         u64 period;
 182         u64 weight;
 183         u64 transaction;
 184         u32 cpu;
 185         u32 raw_size;
 186         u64 data_src;
 187         u32 flags;
 188         u16 insn_len;
 189         void *raw_data;
 190         struct ip_callchain *callchain;
 191         struct branch_stack *branch_stack;
 192         struct regs_dump  user_regs;
 193         struct regs_dump  intr_regs;
 194         struct stack_dump user_stack;
 195         struct sample_read read;
 196 };
 197
 198 #define PERF_MEM_DATA_SRC_NONE \
 199         (PERF_MEM_S(OP, NA) |\
 200          PERF_MEM_S(LVL, NA) |\
 201          PERF_MEM_S(SNOOP, NA) |\
 202          PERF_MEM_S(LOCK, NA) |\
 203          PERF_MEM_S(TLB, NA))
 204
 205 struct build_id_event {
 206         struct perf_event_header header;
 207         pid_t                    pid;
 208         u8                       build_id[PERF_ALIGN(BUILD_ID_SIZE, sizeof(u64))];
 209         char                     filename[];
 210 };
 211
 212 enum perf_user_event_type { /* above any possible kernel type */
 213         PERF_RECORD_USER_TYPE_START             = 64,
 214         PERF_RECORD_HEADER_ATTR                 = 64,
 215         PERF_RECORD_HEADER_EVENT_TYPE           = 65, /* depreceated */
 216         PERF_RECORD_HEADER_TRACING_DATA         = 66,
 217         PERF_RECORD_HEADER_BUILD_ID             = 67,
 218         PERF_RECORD_FINISHED_ROUND              = 68,
 219         PERF_RECORD_ID_INDEX                    = 69,
 220         PERF_RECORD_AUXTRACE_INFO               = 70,
 221         PERF_RECORD_AUXTRACE                    = 71,
 222         PERF_RECORD_AUXTRACE_ERROR              = 72,
 223         PERF_RECORD_HEADER_MAX
 224 };
 225
 226 enum auxtrace_error_type {
 227         PERF_AUXTRACE_ERROR_ITRACE  = 1,
 228         PERF_AUXTRACE_ERROR_MAX
 229 };
 230
 231 /*
 232  * The kernel collects the number of events it couldn't send in a stretch and
 233  * when possible sends this number in a PERF_RECORD_LOST event. The number of
 234  * such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
 235  * total_lost tells exactly how many events the kernel in fact lost, i.e. it is
 236  * the sum of all struct lost_event.lost fields reported.
 237  *
 238  * The total_period is needed because by default auto-freq is used, so
 239  * multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
 240  * the total number of low level events, it is necessary to to sum all struct
 241  * sample_event.period and stash the result in total_period.
 242  */
 243 struct events_stats {
 244         u64 total_period;
 245         u64 total_non_filtered_period;
 246         u64 total_lost;
 247         u64 total_invalid_chains;
 248         u32 nr_events[PERF_RECORD_HEADER_MAX];
 249         u32 nr_non_filtered_samples;
 250         u32 nr_lost_warned;
 251         u32 nr_unknown_events;
 252         u32 nr_invalid_chains;
 253         u32 nr_unknown_id;
 254         u32 nr_unprocessable_samples;
 255         u32 nr_auxtrace_errors[PERF_AUXTRACE_ERROR_MAX];
 256 };
 257
 258 struct attr_event {
 259         struct perf_event_header header;
 260         struct perf_event_attr attr;
 261         u64 id[];
 262 };
 263
 264 #define MAX_EVENT_NAME 64
 265
 266 struct perf_trace_event_type {
 267         u64     event_id;
 268         char    name[MAX_EVENT_NAME];
 269 };
 270
 271 struct event_type_event {
 272         struct perf_event_header header;
 273         struct perf_trace_event_type event_type;
 274 };
 275
 276 struct tracing_data_event {
 277         struct perf_event_header header;
 278         u32 size;
 279 };
 280
 281 struct id_index_entry {
 282         u64 id;
 283         u64 idx;
 284         u64 cpu;
 285         u64 tid;
 286 };
 287
 288 struct id_index_event {
 289         struct perf_event_header header;
 290         u64 nr;
 291         struct id_index_entry entries[0];
 292 };
 293
 294 struct auxtrace_info_event {
 295         struct perf_event_header header;
 296         u32 type;
 297         u32 reserved__; /* For alignment */
 298         u64 priv[];
 299 };
 300
 301 struct auxtrace_event {
 302         struct perf_event_header header;
 303         u64 size;
 304         u64 offset;
 305         u64 reference;
 306         u32 idx;
 307         u32 tid;
 308         u32 cpu;
 309         u32 reserved__; /* For alignment */
 310 };
 311
 312 #define MAX_AUXTRACE_ERROR_MSG 64
 313
 314 struct auxtrace_error_event {
 315         struct perf_event_header header;
 316         u32 type;
 317         u32 code;
 318         u32 cpu;
 319         u32 pid;
 320         u32 tid;
 321         u32 reserved__; /* For alignment */
 322         u64 ip;
 323         char msg[MAX_AUXTRACE_ERROR_MSG];
 324 };
 325
 326 struct aux_event {
 327         struct perf_event_header header;
 328         u64     aux_offset;
 329         u64     aux_size;
 330         u64     flags;
 331 };
 332
 333 struct itrace_start_event {
 334         struct perf_event_header header;
 335         u32 pid, tid;
 336 };
 337
 338 union perf_event {
 339         struct perf_event_header        header;
 340         struct mmap_event               mmap;
 341         struct mmap2_event              mmap2;
 342         struct comm_event               comm;
 343         struct fork_event               fork;
 344         struct lost_event               lost;
 345         struct read_event               read;
 346         struct throttle_event           throttle;
 347         struct sample_event             sample;
 348         struct attr_event               attr;
 349         struct event_type_event         event_type;
 350         struct tracing_data_event       tracing_data;
 351         struct build_id_event           build_id;
 352         struct id_index_event           id_index;
 353         struct auxtrace_info_event      auxtrace_info;
 354         struct auxtrace_event           auxtrace;
 355         struct auxtrace_error_event     auxtrace_error;
 356         struct aux_event                aux;
 357         struct itrace_start_event       itrace_start;
 358 };
 359
 360 void perf_event__print_totals(void);
 361
 362 struct perf_tool;
 363 struct thread_map;
 364
 365 typedef int (*perf_event__handler_t)(struct perf_tool *tool,
 366                                      union perf_event *event,
 367                                      struct perf_sample *sample,
 368                                      struct machine *machine);
 369
 370 int perf_event__synthesize_thread_map(struct perf_tool *tool,
 371                                       struct thread_map *threads,
 372                                       perf_event__handler_t process,
 373                                       struct machine *machine, bool mmap_data);
 374 int perf_event__synthesize_threads(struct perf_tool *tool,
 375                                    perf_event__handler_t process,
 376                                    struct machine *machine, bool mmap_data);
 377 int perf_event__synthesize_kernel_mmap(struct perf_tool *tool,
 378                                        perf_event__handler_t process,
 379                                        struct machine *machine);
 380
 381 int perf_event__synthesize_modules(struct perf_tool *tool,
 382                                    perf_event__handler_t process,
 383                                    struct machine *machine);
 384
 385 int perf_event__process_comm(struct perf_tool *tool,
 386                              union perf_event *event,
 387                              struct perf_sample *sample,
 388                              struct machine *machine);
 389 int perf_event__process_lost(struct perf_tool *tool,
 390                              union perf_event *event,
 391                              struct perf_sample *sample,
 392                              struct machine *machine);
 393 int perf_event__process_aux(struct perf_tool *tool,
 394                             union perf_event *event,
 395                             struct perf_sample *sample,
 396                             struct machine *machine);
 397 int perf_event__process_itrace_start(struct perf_tool *tool,
 398                                      union perf_event *event,
 399                                      struct perf_sample *sample,
 400                                      struct machine *machine);
 401 int perf_event__process_mmap(struct perf_tool *tool,
 402                              union perf_event *event,
 403                              struct perf_sample *sample,
 404                              struct machine *machine);
 405 int perf_event__process_mmap2(struct perf_tool *tool,
 406                              union perf_event *event,
 407                              struct perf_sample *sample,
 408                              struct machine *machine);
 409 int perf_event__process_fork(struct perf_tool *tool,
 410                              union perf_event *event,
 411                              struct perf_sample *sample,
 412                              struct machine *machine);
 413 int perf_event__process_exit(struct perf_tool *tool,
 414                              union perf_event *event,
 415                              struct perf_sample *sample,
 416                              struct machine *machine);
 417 int perf_event__process(struct perf_tool *tool,
 418                         union perf_event *event,
 419                         struct perf_sample *sample,
 420                         struct machine *machine);
 421
 422 struct addr_location;
 423
 424 int perf_event__preprocess_sample(const union perf_event *event,
 425                                   struct machine *machine,
 426                                   struct addr_location *al,
 427                                   struct perf_sample *sample);
 428
 429 struct thread;
 430
 431 bool is_bts_event(struct perf_event_attr *attr);
 432 bool sample_addr_correlates_sym(struct perf_event_attr *attr);
 433 void perf_event__preprocess_sample_addr(union perf_event *event,
 434                                         struct perf_sample *sample,
 435                                         struct thread *thread,
 436                                         struct addr_location *al);
 437
 438 const char *perf_event__name(unsigned int id);
 439
 440 size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type,
 441                                      u64 read_format);
 442 int perf_event__synthesize_sample(union perf_event *event, u64 type,
 443                                   u64 read_format,
 444                                   const struct perf_sample *sample,
 445                                   bool swapped);
 446
 447 int perf_event__synthesize_mmap_events(struct perf_tool *tool,
 448                                        union perf_event *event,
 449                                        pid_t pid, pid_t tgid,
 450                                        perf_event__handler_t process,
 451                                        struct machine *machine,
 452                                        bool mmap_data);
 453
 454 size_t perf_event__fprintf_comm(union perf_event *event, FILE *fp);
 455 size_t perf_event__fprintf_mmap(union perf_event *event, FILE *fp);
 456 size_t perf_event__fprintf_mmap2(union perf_event *event, FILE *fp);
 457 size_t perf_event__fprintf_task(union perf_event *event, FILE *fp);
 458 size_t perf_event__fprintf_aux(union perf_event *event, FILE *fp);
 459 size_t perf_event__fprintf_itrace_start(union perf_event *event, FILE *fp);
 460 size_t perf_event__fprintf(union perf_event *event, FILE *fp);
 461
 462 u64 kallsyms__get_function_start(const char *kallsyms_filename,
 463                                  const char *symbol_name);
 464
 465 #endif /* __PERF_RECORD_H */