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