tools/lib/traceevent/event-parse.h

   1 /*
   2  * Copyright (C) 2009, 2010 Red Hat Inc, Steven Rostedt <srostedt@redhat.com>
   3  *
   4  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation;
   8  * version 2.1 of the License (not later!)
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this program; if not,  see <http://www.gnu.org/licenses>
  17  *
  18  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  19  */
  20 #ifndef _PARSE_EVENTS_H
  21 #define _PARSE_EVENTS_H
  22
  23 #include <stdbool.h>
  24 #include <stdarg.h>
  25 #include <regex.h>
  26 #include <string.h>
  27
  28 #ifndef __maybe_unused
  29 #define __maybe_unused __attribute__((unused))
  30 #endif
  31
  32 /* ----------------------- trace_seq ----------------------- */
  33
  34
  35 #ifndef TRACE_SEQ_BUF_SIZE
  36 #define TRACE_SEQ_BUF_SIZE 4096
  37 #endif
  38
  39 #ifndef DEBUG_RECORD
  40 #define DEBUG_RECORD 0
  41 #endif
  42
  43 struct pevent_record {
  44         unsigned long long      ts;
  45         unsigned long long      offset;
  46         long long               missed_events;  /* buffer dropped events before */
  47         int                     record_size;    /* size of binary record */
  48         int                     size;           /* size of data */
  49         void                    *data;
  50         int                     cpu;
  51         int                     ref_count;
  52         int                     locked;         /* Do not free, even if ref_count is zero */
  53         void                    *priv;
  54 #if DEBUG_RECORD
  55         struct pevent_record    *prev;
  56         struct pevent_record    *next;
  57         long                    alloc_addr;
  58 #endif
  59 };
  60
  61 /*
  62  * Trace sequences are used to allow a function to call several other functions
  63  * to create a string of data to use (up to a max of PAGE_SIZE).
  64  */
  65
  66 struct trace_seq {
  67         char                    *buffer;
  68         unsigned int            buffer_size;
  69         unsigned int            len;
  70         unsigned int            readpos;
  71 };
  72
  73 void trace_seq_init(struct trace_seq *s);
  74 void trace_seq_reset(struct trace_seq *s);
  75 void trace_seq_destroy(struct trace_seq *s);
  76
  77 extern int trace_seq_printf(struct trace_seq *s, const char *fmt, ...)
  78         __attribute__ ((format (printf, 2, 3)));
  79 extern int trace_seq_vprintf(struct trace_seq *s, const char *fmt, va_list args)
  80         __attribute__ ((format (printf, 2, 0)));
  81
  82 extern int trace_seq_puts(struct trace_seq *s, const char *str);
  83 extern int trace_seq_putc(struct trace_seq *s, unsigned char c);
  84
  85 extern void trace_seq_terminate(struct trace_seq *s);
  86
  87 extern int trace_seq_do_printf(struct trace_seq *s);
  88
  89
  90 /* ----------------------- pevent ----------------------- */
  91
  92 struct pevent;
  93 struct event_format;
  94
  95 typedef int (*pevent_event_handler_func)(struct trace_seq *s,
  96                                          struct pevent_record *record,
  97                                          struct event_format *event,
  98                                          void *context);
  99
 100 typedef int (*pevent_plugin_load_func)(struct pevent *pevent);
 101 typedef int (*pevent_plugin_unload_func)(void);
 102
 103 struct plugin_option {
 104         struct plugin_option            *next;
 105         void                            *handle;
 106         char                            *file;
 107         char                            *name;
 108         char                            *plugin_alias;
 109         char                            *description;
 110         char                            *value;
 111         void                            *priv;
 112         int                             set;
 113 };
 114
 115 /*
 116  * Plugin hooks that can be called:
 117  *
 118  * PEVENT_PLUGIN_LOADER:  (required)
 119  *   The function name to initialized the plugin.
 120  *
 121  *   int PEVENT_PLUGIN_LOADER(struct pevent *pevent)
 122  *
 123  * PEVENT_PLUGIN_UNLOADER:  (optional)
 124  *   The function called just before unloading
 125  *
 126  *   int PEVENT_PLUGIN_UNLOADER(void)
 127  *
 128  * PEVENT_PLUGIN_OPTIONS:  (optional)
 129  *   Plugin options that can be set before loading
 130  *
 131  *   struct plugin_option PEVENT_PLUGIN_OPTIONS[] = {
 132  *      {
 133  *              .name = "option-name",
 134  *              .plugin_alias = "overide-file-name", (optional)
 135  *              .description = "description of option to show users",
 136  *      },
 137  *      {
 138  *              .name = NULL,
 139  *      },
 140  *   };
 141  *
 142  *   Array must end with .name = NULL;
 143  *
 144  *
 145  *   .plugin_alias is used to give a shorter name to access
 146  *   the vairable. Useful if a plugin handles more than one event.
 147  *
 148  * PEVENT_PLUGIN_ALIAS: (optional)
 149  *   The name to use for finding options (uses filename if not defined)
 150  */
 151 #define PEVENT_PLUGIN_LOADER pevent_plugin_loader
 152 #define PEVENT_PLUGIN_UNLOADER pevent_plugin_unloader
 153 #define PEVENT_PLUGIN_OPTIONS pevent_plugin_options
 154 #define PEVENT_PLUGIN_ALIAS pevent_plugin_alias
 155 #define _MAKE_STR(x)    #x
 156 #define MAKE_STR(x)     _MAKE_STR(x)
 157 #define PEVENT_PLUGIN_LOADER_NAME MAKE_STR(PEVENT_PLUGIN_LOADER)
 158 #define PEVENT_PLUGIN_UNLOADER_NAME MAKE_STR(PEVENT_PLUGIN_UNLOADER)
 159 #define PEVENT_PLUGIN_OPTIONS_NAME MAKE_STR(PEVENT_PLUGIN_OPTIONS)
 160 #define PEVENT_PLUGIN_ALIAS_NAME MAKE_STR(PEVENT_PLUGIN_ALIAS)
 161
 162 #define NSECS_PER_SEC           1000000000ULL
 163 #define NSECS_PER_USEC          1000ULL
 164
 165 enum format_flags {
 166         FIELD_IS_ARRAY          = 1,
 167         FIELD_IS_POINTER        = 2,
 168         FIELD_IS_SIGNED         = 4,
 169         FIELD_IS_STRING         = 8,
 170         FIELD_IS_DYNAMIC        = 16,
 171         FIELD_IS_LONG           = 32,
 172         FIELD_IS_FLAG           = 64,
 173         FIELD_IS_SYMBOLIC       = 128,
 174 };
 175
 176 struct format_field {
 177         struct format_field     *next;
 178         struct event_format     *event;
 179         char                    *type;
 180         char                    *name;
 181         int                     offset;
 182         int                     size;
 183         unsigned int            arraylen;
 184         unsigned int            elementsize;
 185         unsigned long           flags;
 186 };
 187
 188 struct format {
 189         int                     nr_common;
 190         int                     nr_fields;
 191         struct format_field     *common_fields;
 192         struct format_field     *fields;
 193 };
 194
 195 struct print_arg_atom {
 196         char                    *atom;
 197 };
 198
 199 struct print_arg_string {
 200         char                    *string;
 201         int                     offset;
 202 };
 203
 204 struct print_arg_field {
 205         char                    *name;
 206         struct format_field     *field;
 207 };
 208
 209 struct print_flag_sym {
 210         struct print_flag_sym   *next;
 211         char                    *value;
 212         char                    *str;
 213 };
 214
 215 struct print_arg_typecast {
 216         char                    *type;
 217         struct print_arg        *item;
 218 };
 219
 220 struct print_arg_flags {
 221         struct print_arg        *field;
 222         char                    *delim;
 223         struct print_flag_sym   *flags;
 224 };
 225
 226 struct print_arg_symbol {
 227         struct print_arg        *field;
 228         struct print_flag_sym   *symbols;
 229 };
 230
 231 struct print_arg_hex {
 232         struct print_arg        *field;
 233         struct print_arg        *size;
 234 };
 235
 236 struct print_arg_dynarray {
 237         struct format_field     *field;
 238         struct print_arg        *index;
 239 };
 240
 241 struct print_arg;
 242
 243 struct print_arg_op {
 244         char                    *op;
 245         int                     prio;
 246         struct print_arg        *left;
 247         struct print_arg        *right;
 248 };
 249
 250 struct pevent_function_handler;
 251
 252 struct print_arg_func {
 253         struct pevent_function_handler  *func;
 254         struct print_arg                *args;
 255 };
 256
 257 enum print_arg_type {
 258         PRINT_NULL,
 259         PRINT_ATOM,
 260         PRINT_FIELD,
 261         PRINT_FLAGS,
 262         PRINT_SYMBOL,
 263         PRINT_HEX,
 264         PRINT_TYPE,
 265         PRINT_STRING,
 266         PRINT_BSTRING,
 267         PRINT_DYNAMIC_ARRAY,
 268         PRINT_OP,
 269         PRINT_FUNC,
 270 };
 271
 272 struct print_arg {
 273         struct print_arg                *next;
 274         enum print_arg_type             type;
 275         union {
 276                 struct print_arg_atom           atom;
 277                 struct print_arg_field          field;
 278                 struct print_arg_typecast       typecast;
 279                 struct print_arg_flags          flags;
 280                 struct print_arg_symbol         symbol;
 281                 struct print_arg_hex            hex;
 282                 struct print_arg_func           func;
 283                 struct print_arg_string         string;
 284                 struct print_arg_op             op;
 285                 struct print_arg_dynarray       dynarray;
 286         };
 287 };
 288
 289 struct print_fmt {
 290         char                    *format;
 291         struct print_arg        *args;
 292 };
 293
 294 struct event_format {
 295         struct pevent           *pevent;
 296         char                    *name;
 297         int                     id;
 298         int                     flags;
 299         struct format           format;
 300         struct print_fmt        print_fmt;
 301         char                    *system;
 302         pevent_event_handler_func handler;
 303         void                    *context;
 304 };
 305
 306 enum {
 307         EVENT_FL_ISFTRACE       = 0x01,
 308         EVENT_FL_ISPRINT        = 0x02,
 309         EVENT_FL_ISBPRINT       = 0x04,
 310         EVENT_FL_ISFUNCENT      = 0x10,
 311         EVENT_FL_ISFUNCRET      = 0x20,
 312         EVENT_FL_NOHANDLE       = 0x40,
 313         EVENT_FL_PRINTRAW       = 0x80,
 314
 315         EVENT_FL_FAILED         = 0x80000000
 316 };
 317
 318 enum event_sort_type {
 319         EVENT_SORT_ID,
 320         EVENT_SORT_NAME,
 321         EVENT_SORT_SYSTEM,
 322 };
 323
 324 enum event_type {
 325         EVENT_ERROR,
 326         EVENT_NONE,
 327         EVENT_SPACE,
 328         EVENT_NEWLINE,
 329         EVENT_OP,
 330         EVENT_DELIM,
 331         EVENT_ITEM,
 332         EVENT_DQUOTE,
 333         EVENT_SQUOTE,
 334 };
 335
 336 typedef unsigned long long (*pevent_func_handler)(struct trace_seq *s,
 337                                              unsigned long long *args);
 338
 339 enum pevent_func_arg_type {
 340         PEVENT_FUNC_ARG_VOID,
 341         PEVENT_FUNC_ARG_INT,
 342         PEVENT_FUNC_ARG_LONG,
 343         PEVENT_FUNC_ARG_STRING,
 344         PEVENT_FUNC_ARG_PTR,
 345         PEVENT_FUNC_ARG_MAX_TYPES
 346 };
 347
 348 enum pevent_flag {
 349         PEVENT_NSEC_OUTPUT              = 1,    /* output in NSECS */
 350 };
 351
 352 #define PEVENT_ERRORS                                                         \
 353         _PE(MEM_ALLOC_FAILED,   "failed to allocate memory"),                 \
 354         _PE(PARSE_EVENT_FAILED, "failed to parse event"),                     \
 355         _PE(READ_ID_FAILED,     "failed to read event id"),                   \
 356         _PE(READ_FORMAT_FAILED, "failed to read event format"),               \
 357         _PE(READ_PRINT_FAILED,  "failed to read event print fmt"),            \
 358         _PE(OLD_FTRACE_ARG_FAILED,"failed to allocate field name for ftrace"),\
 359         _PE(INVALID_ARG_TYPE,   "invalid argument type"),                     \
 360         _PE(INVALID_EVENT_NAME, "invalid event name"),                        \
 361         _PE(EVENT_NOT_FOUND,    "no event found"),                            \
 362         _PE(SYNTAX_ERROR,       "syntax error"),                              \
 363         _PE(ILLEGAL_RVALUE,     "illegal rvalue"),                            \
 364         _PE(ILLEGAL_LVALUE,     "illegal lvalue for string comparison"),      \
 365         _PE(INVALID_REGEX,      "regex did not compute"),                     \
 366         _PE(ILLEGAL_STRING_CMP, "illegal comparison for string"),             \
 367         _PE(ILLEGAL_INTEGER_CMP,"illegal comparison for integer"),            \
 368         _PE(REPARENT_NOT_OP,    "cannot reparent other than OP"),             \
 369         _PE(REPARENT_FAILED,    "failed to reparent filter OP"),              \
 370         _PE(BAD_FILTER_ARG,     "bad arg in filter tree"),                    \
 371         _PE(UNEXPECTED_TYPE,    "unexpected type (not a value)"),             \
 372         _PE(ILLEGAL_TOKEN,      "illegal token"),                             \
 373         _PE(INVALID_PAREN,      "open parenthesis cannot come here"),         \
 374         _PE(UNBALANCED_PAREN,   "unbalanced number of parenthesis"),          \
 375         _PE(UNKNOWN_TOKEN,      "unknown token")
 376
 377 #undef _PE
 378 #define _PE(__code, __str) PEVENT_ERRNO__ ## __code
 379 enum pevent_errno {
 380         PEVENT_ERRNO__SUCCESS                   = 0,
 381
 382         /*
 383          * Choose an arbitrary negative big number not to clash with standard
 384          * errno since SUS requires the errno has distinct positive values.
 385          * See 'Issue 6' in the link below.
 386          *
 387          * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
 388          */
 389         __PEVENT_ERRNO__START                   = -100000,
 390
 391         PEVENT_ERRORS,
 392
 393         __PEVENT_ERRNO__END,
 394 };
 395 #undef _PE
 396
 397 struct plugin_list;
 398
 399 struct plugin_list *traceevent_load_plugins(struct pevent *pevent);
 400 void traceevent_unload_plugins(struct plugin_list *plugin_list);
 401
 402 struct cmdline;
 403 struct cmdline_list;
 404 struct func_map;
 405 struct func_list;
 406 struct event_handler;
 407
 408 struct pevent {
 409         int ref_count;
 410
 411         int header_page_ts_offset;
 412         int header_page_ts_size;
 413         int header_page_size_offset;
 414         int header_page_size_size;
 415         int header_page_data_offset;
 416         int header_page_data_size;
 417         int header_page_overwrite;
 418
 419         int file_bigendian;
 420         int host_bigendian;
 421
 422         int latency_format;
 423
 424         int old_format;
 425
 426         int cpus;
 427         int long_size;
 428         int page_size;
 429
 430         struct cmdline *cmdlines;
 431         struct cmdline_list *cmdlist;
 432         int cmdline_count;
 433
 434         struct func_map *func_map;
 435         struct func_list *funclist;
 436         unsigned int func_count;
 437
 438         struct printk_map *printk_map;
 439         struct printk_list *printklist;
 440         unsigned int printk_count;
 441
 442
 443         struct event_format **events;
 444         int nr_events;
 445         struct event_format **sort_events;
 446         enum event_sort_type last_type;
 447
 448         int type_offset;
 449         int type_size;
 450
 451         int pid_offset;
 452         int pid_size;
 453
 454         int pc_offset;
 455         int pc_size;
 456
 457         int flags_offset;
 458         int flags_size;
 459
 460         int ld_offset;
 461         int ld_size;
 462
 463         int print_raw;
 464
 465         int test_filters;
 466
 467         int flags;
 468
 469         struct format_field *bprint_ip_field;
 470         struct format_field *bprint_fmt_field;
 471         struct format_field *bprint_buf_field;
 472
 473         struct event_handler *handlers;
 474         struct pevent_function_handler *func_handlers;
 475
 476         /* cache */
 477         struct event_format *last_event;
 478
 479         char *trace_clock;
 480 };
 481
 482 static inline void pevent_set_flag(struct pevent *pevent, int flag)
 483 {
 484         pevent->flags |= flag;
 485 }
 486
 487 static inline unsigned short
 488 __data2host2(struct pevent *pevent, unsigned short data)
 489 {
 490         unsigned short swap;
 491
 492         if (pevent->host_bigendian == pevent->file_bigendian)
 493                 return data;
 494
 495         swap = ((data & 0xffULL) << 8) |
 496                 ((data & (0xffULL << 8)) >> 8);
 497
 498         return swap;
 499 }
 500
 501 static inline unsigned int
 502 __data2host4(struct pevent *pevent, unsigned int data)
 503 {
 504         unsigned int swap;
 505
 506         if (pevent->host_bigendian == pevent->file_bigendian)
 507                 return data;
 508
 509         swap = ((data & 0xffULL) << 24) |
 510                 ((data & (0xffULL << 8)) << 8) |
 511                 ((data & (0xffULL << 16)) >> 8) |
 512                 ((data & (0xffULL << 24)) >> 24);
 513
 514         return swap;
 515 }
 516
 517 static inline unsigned long long
 518 __data2host8(struct pevent *pevent, unsigned long long data)
 519 {
 520         unsigned long long swap;
 521
 522         if (pevent->host_bigendian == pevent->file_bigendian)
 523                 return data;
 524
 525         swap = ((data & 0xffULL) << 56) |
 526                 ((data & (0xffULL << 8)) << 40) |
 527                 ((data & (0xffULL << 16)) << 24) |
 528                 ((data & (0xffULL << 24)) << 8) |
 529                 ((data & (0xffULL << 32)) >> 8) |
 530                 ((data & (0xffULL << 40)) >> 24) |
 531                 ((data & (0xffULL << 48)) >> 40) |
 532                 ((data & (0xffULL << 56)) >> 56);
 533
 534         return swap;
 535 }
 536
 537 #define data2host2(pevent, ptr)         __data2host2(pevent, *(unsigned short *)(ptr))
 538 #define data2host4(pevent, ptr)         __data2host4(pevent, *(unsigned int *)(ptr))
 539 #define data2host8(pevent, ptr)                                 \
 540 ({                                                              \
 541         unsigned long long __val;                               \
 542                                                                 \
 543         memcpy(&__val, (ptr), sizeof(unsigned long long));      \
 544         __data2host8(pevent, __val);                            \
 545 })
 546
 547 static inline int traceevent_host_bigendian(void)
 548 {
 549         unsigned char str[] = { 0x1, 0x2, 0x3, 0x4 };
 550         unsigned int val;
 551
 552         memcpy(&val, str, 4);
 553         return val == 0x01020304;
 554 }
 555
 556 /* taken from kernel/trace/trace.h */
 557 enum trace_flag_type {
 558         TRACE_FLAG_IRQS_OFF             = 0x01,
 559         TRACE_FLAG_IRQS_NOSUPPORT       = 0x02,
 560         TRACE_FLAG_NEED_RESCHED         = 0x04,
 561         TRACE_FLAG_HARDIRQ              = 0x08,
 562         TRACE_FLAG_SOFTIRQ              = 0x10,
 563 };
 564
 565 int pevent_register_comm(struct pevent *pevent, const char *comm, int pid);
 566 void pevent_register_trace_clock(struct pevent *pevent, char *trace_clock);
 567 int pevent_register_function(struct pevent *pevent, char *name,
 568                              unsigned long long addr, char *mod);
 569 int pevent_register_print_string(struct pevent *pevent, const char *fmt,
 570                                  unsigned long long addr);
 571 int pevent_pid_is_registered(struct pevent *pevent, int pid);
 572
 573 void pevent_print_event(struct pevent *pevent, struct trace_seq *s,
 574                         struct pevent_record *record, bool use_trace_clock);
 575
 576 int pevent_parse_header_page(struct pevent *pevent, char *buf, unsigned long size,
 577                              int long_size);
 578
 579 enum pevent_errno pevent_parse_event(struct pevent *pevent, const char *buf,
 580                                      unsigned long size, const char *sys);
 581 enum pevent_errno pevent_parse_format(struct pevent *pevent,
 582                                       struct event_format **eventp,
 583                                       const char *buf,
 584                                       unsigned long size, const char *sys);
 585 void pevent_free_format(struct event_format *event);
 586
 587 void *pevent_get_field_raw(struct trace_seq *s, struct event_format *event,
 588                            const char *name, struct pevent_record *record,
 589                            int *len, int err);
 590
 591 int pevent_get_field_val(struct trace_seq *s, struct event_format *event,
 592                          const char *name, struct pevent_record *record,
 593                          unsigned long long *val, int err);
 594 int pevent_get_common_field_val(struct trace_seq *s, struct event_format *event,
 595                                 const char *name, struct pevent_record *record,
 596                                 unsigned long long *val, int err);
 597 int pevent_get_any_field_val(struct trace_seq *s, struct event_format *event,
 598                              const char *name, struct pevent_record *record,
 599                              unsigned long long *val, int err);
 600
 601 int pevent_print_num_field(struct trace_seq *s, const char *fmt,
 602                            struct event_format *event, const char *name,
 603                            struct pevent_record *record, int err);
 604
 605 int pevent_print_func_field(struct trace_seq *s, const char *fmt,
 606                            struct event_format *event, const char *name,
 607                            struct pevent_record *record, int err);
 608
 609 int pevent_register_event_handler(struct pevent *pevent, int id,
 610                                   const char *sys_name, const char *event_name,
 611                                   pevent_event_handler_func func, void *context);
 612 int pevent_register_print_function(struct pevent *pevent,
 613                                    pevent_func_handler func,
 614                                    enum pevent_func_arg_type ret_type,
 615                                    char *name, ...);
 616
 617 struct format_field *pevent_find_common_field(struct event_format *event, const char *name);
 618 struct format_field *pevent_find_field(struct event_format *event, const char *name);
 619 struct format_field *pevent_find_any_field(struct event_format *event, const char *name);
 620
 621 const char *pevent_find_function(struct pevent *pevent, unsigned long long addr);
 622 unsigned long long
 623 pevent_find_function_address(struct pevent *pevent, unsigned long long addr);
 624 unsigned long long pevent_read_number(struct pevent *pevent, const void *ptr, int size);
 625 int pevent_read_number_field(struct format_field *field, const void *data,
 626                              unsigned long long *value);
 627
 628 struct event_format *pevent_find_event(struct pevent *pevent, int id);
 629
 630 struct event_format *
 631 pevent_find_event_by_name(struct pevent *pevent, const char *sys, const char *name);
 632
 633 void pevent_data_lat_fmt(struct pevent *pevent,
 634                          struct trace_seq *s, struct pevent_record *record);
 635 int pevent_data_type(struct pevent *pevent, struct pevent_record *rec);
 636 struct event_format *pevent_data_event_from_type(struct pevent *pevent, int type);
 637 int pevent_data_pid(struct pevent *pevent, struct pevent_record *rec);
 638 const char *pevent_data_comm_from_pid(struct pevent *pevent, int pid);
 639 void pevent_event_info(struct trace_seq *s, struct event_format *event,
 640                        struct pevent_record *record);
 641 int pevent_strerror(struct pevent *pevent, enum pevent_errno errnum,
 642                     char *buf, size_t buflen);
 643
 644 struct event_format **pevent_list_events(struct pevent *pevent, enum event_sort_type);
 645 struct format_field **pevent_event_common_fields(struct event_format *event);
 646 struct format_field **pevent_event_fields(struct event_format *event);
 647
 648 static inline int pevent_get_cpus(struct pevent *pevent)
 649 {
 650         return pevent->cpus;
 651 }
 652
 653 static inline void pevent_set_cpus(struct pevent *pevent, int cpus)
 654 {
 655         pevent->cpus = cpus;
 656 }
 657
 658 static inline int pevent_get_long_size(struct pevent *pevent)
 659 {
 660         return pevent->long_size;
 661 }
 662
 663 static inline void pevent_set_long_size(struct pevent *pevent, int long_size)
 664 {
 665         pevent->long_size = long_size;
 666 }
 667
 668 static inline int pevent_get_page_size(struct pevent *pevent)
 669 {
 670         return pevent->page_size;
 671 }
 672
 673 static inline void pevent_set_page_size(struct pevent *pevent, int _page_size)
 674 {
 675         pevent->page_size = _page_size;
 676 }
 677
 678 static inline int pevent_is_file_bigendian(struct pevent *pevent)
 679 {
 680         return pevent->file_bigendian;
 681 }
 682
 683 static inline void pevent_set_file_bigendian(struct pevent *pevent, int endian)
 684 {
 685         pevent->file_bigendian = endian;
 686 }
 687
 688 static inline int pevent_is_host_bigendian(struct pevent *pevent)
 689 {
 690         return pevent->host_bigendian;
 691 }
 692
 693 static inline void pevent_set_host_bigendian(struct pevent *pevent, int endian)
 694 {
 695         pevent->host_bigendian = endian;
 696 }
 697
 698 static inline int pevent_is_latency_format(struct pevent *pevent)
 699 {
 700         return pevent->latency_format;
 701 }
 702
 703 static inline void pevent_set_latency_format(struct pevent *pevent, int lat)
 704 {
 705         pevent->latency_format = lat;
 706 }
 707
 708 struct pevent *pevent_alloc(void);
 709 void pevent_free(struct pevent *pevent);
 710 void pevent_ref(struct pevent *pevent);
 711 void pevent_unref(struct pevent *pevent);
 712
 713 /* access to the internal parser */
 714 void pevent_buffer_init(const char *buf, unsigned long long size);
 715 enum event_type pevent_read_token(char **tok);
 716 void pevent_free_token(char *token);
 717 int pevent_peek_char(void);
 718 const char *pevent_get_input_buf(void);
 719 unsigned long long pevent_get_input_buf_ptr(void);
 720
 721 /* for debugging */
 722 void pevent_print_funcs(struct pevent *pevent);
 723 void pevent_print_printk(struct pevent *pevent);
 724
 725 /* ----------------------- filtering ----------------------- */
 726
 727 enum filter_boolean_type {
 728         FILTER_FALSE,
 729         FILTER_TRUE,
 730 };
 731
 732 enum filter_op_type {
 733         FILTER_OP_AND = 1,
 734         FILTER_OP_OR,
 735         FILTER_OP_NOT,
 736 };
 737
 738 enum filter_cmp_type {
 739         FILTER_CMP_NONE,
 740         FILTER_CMP_EQ,
 741         FILTER_CMP_NE,
 742         FILTER_CMP_GT,
 743         FILTER_CMP_LT,
 744         FILTER_CMP_GE,
 745         FILTER_CMP_LE,
 746         FILTER_CMP_MATCH,
 747         FILTER_CMP_NOT_MATCH,
 748         FILTER_CMP_REGEX,
 749         FILTER_CMP_NOT_REGEX,
 750 };
 751
 752 enum filter_exp_type {
 753         FILTER_EXP_NONE,
 754         FILTER_EXP_ADD,
 755         FILTER_EXP_SUB,
 756         FILTER_EXP_MUL,
 757         FILTER_EXP_DIV,
 758         FILTER_EXP_MOD,
 759         FILTER_EXP_RSHIFT,
 760         FILTER_EXP_LSHIFT,
 761         FILTER_EXP_AND,
 762         FILTER_EXP_OR,
 763         FILTER_EXP_XOR,
 764         FILTER_EXP_NOT,
 765 };
 766
 767 enum filter_arg_type {
 768         FILTER_ARG_NONE,
 769         FILTER_ARG_BOOLEAN,
 770         FILTER_ARG_VALUE,
 771         FILTER_ARG_FIELD,
 772         FILTER_ARG_EXP,
 773         FILTER_ARG_OP,
 774         FILTER_ARG_NUM,
 775         FILTER_ARG_STR,
 776 };
 777
 778 enum filter_value_type {
 779         FILTER_NUMBER,
 780         FILTER_STRING,
 781         FILTER_CHAR
 782 };
 783
 784 struct fliter_arg;
 785
 786 struct filter_arg_boolean {
 787         enum filter_boolean_type        value;
 788 };
 789
 790 struct filter_arg_field {
 791         struct format_field     *field;
 792 };
 793
 794 struct filter_arg_value {
 795         enum filter_value_type  type;
 796         union {
 797                 char                    *str;
 798                 unsigned long long      val;
 799         };
 800 };
 801
 802 struct filter_arg_op {
 803         enum filter_op_type     type;
 804         struct filter_arg       *left;
 805         struct filter_arg       *right;
 806 };
 807
 808 struct filter_arg_exp {
 809         enum filter_exp_type    type;
 810         struct filter_arg       *left;
 811         struct filter_arg       *right;
 812 };
 813
 814 struct filter_arg_num {
 815         enum filter_cmp_type    type;
 816         struct filter_arg       *left;
 817         struct filter_arg       *right;
 818 };
 819
 820 struct filter_arg_str {
 821         enum filter_cmp_type    type;
 822         struct format_field     *field;
 823         char                    *val;
 824         char                    *buffer;
 825         regex_t                 reg;
 826 };
 827
 828 struct filter_arg {
 829         enum filter_arg_type    type;
 830         union {
 831                 struct filter_arg_boolean       boolean;
 832                 struct filter_arg_field         field;
 833                 struct filter_arg_value         value;
 834                 struct filter_arg_op            op;
 835                 struct filter_arg_exp           exp;
 836                 struct filter_arg_num           num;
 837                 struct filter_arg_str           str;
 838         };
 839 };
 840
 841 struct filter_type {
 842         int                     event_id;
 843         struct event_format     *event;
 844         struct filter_arg       *filter;
 845 };
 846
 847 struct event_filter {
 848         struct pevent           *pevent;
 849         int                     filters;
 850         struct filter_type      *event_filters;
 851 };
 852
 853 struct event_filter *pevent_filter_alloc(struct pevent *pevent);
 854
 855 #define FILTER_NONE             -2
 856 #define FILTER_NOEXIST          -1
 857 #define FILTER_MISS             0
 858 #define FILTER_MATCH            1
 859
 860 enum filter_trivial_type {
 861         FILTER_TRIVIAL_FALSE,
 862         FILTER_TRIVIAL_TRUE,
 863         FILTER_TRIVIAL_BOTH,
 864 };
 865
 866 int pevent_filter_add_filter_str(struct event_filter *filter,
 867                                  const char *filter_str,
 868                                  char **error_str);
 869
 870
 871 int pevent_filter_match(struct event_filter *filter,
 872                         struct pevent_record *record);
 873
 874 int pevent_event_filtered(struct event_filter *filter,
 875                           int event_id);
 876
 877 void pevent_filter_reset(struct event_filter *filter);
 878
 879 int pevent_filter_clear_trivial(struct event_filter *filter,
 880                                  enum filter_trivial_type type);
 881
 882 void pevent_filter_free(struct event_filter *filter);
 883
 884 char *pevent_filter_make_string(struct event_filter *filter, int event_id);
 885
 886 int pevent_filter_remove_event(struct event_filter *filter,
 887                                int event_id);
 888
 889 int pevent_filter_event_has_trivial(struct event_filter *filter,
 890                                     int event_id,
 891                                     enum filter_trivial_type type);
 892
 893 int pevent_filter_copy(struct event_filter *dest, struct event_filter *source);
 894
 895 int pevent_update_trivial(struct event_filter *dest, struct event_filter *source,
 896                           enum filter_trivial_type type);
 897
 898 int pevent_filter_compare(struct event_filter *filter1, struct event_filter *filter2);
 899
 900 #endif /* _PARSE_EVENTS_H */