tools/lib/traceevent/event-parse.h

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