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