~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/tools/lib/traceevent/event-parse.h

Version: ~ [ linux-5.14-rc3 ] ~ [ linux-5.13.5 ] ~ [ linux-5.12.19 ] ~ [ linux-5.11.22 ] ~ [ linux-5.10.53 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.135 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.198 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.240 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.276 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.276 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.18.140 ] ~ [ linux-3.16.85 ] ~ [ linux-3.14.79 ] ~ [ linux-3.12.74 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

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

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp