blob: 620c27a72960f0cfe19a6044f21c4565a4e0746b [file] [log] [blame]
Steven Rostedtf7d82352012-04-06 00:47:53 +02001/*
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
Jon Stanley7b9f6b42012-09-07 16:32:46 -040016 * License along with this program; if not, see <http://www.gnu.org/licenses>
Steven Rostedtf7d82352012-04-06 00:47:53 +020017 *
18 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
19 */
20#ifndef _PARSE_EVENTS_H
21#define _PARSE_EVENTS_H
22
Yoshihiro YUNOMAE1b372ca2013-11-01 17:53:53 -040023#include <stdbool.h>
Steven Rostedtf7d82352012-04-06 00:47:53 +020024#include <stdarg.h>
25#include <regex.h>
Jiri Olsa91a058a2013-12-03 14:09:18 +010026#include <string.h>
Steven Rostedtf7d82352012-04-06 00:47:53 +020027
Irina Tirdea1d037ca2012-09-11 01:15:03 +030028#ifndef __maybe_unused
29#define __maybe_unused __attribute__((unused))
Steven Rostedtf7d82352012-04-06 00:47:53 +020030#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
Steven Rostedt1c698182012-04-06 00:48:06 +020043struct pevent_record {
Steven Rostedtf7d82352012-04-06 00:47:53 +020044 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 */
Steven Rostedtff1a70e2012-08-23 11:22:01 -040053 void *priv;
Steven Rostedtf7d82352012-04-06 00:47:53 +020054#if DEBUG_RECORD
Steven Rostedt1c698182012-04-06 00:48:06 +020055 struct pevent_record *prev;
56 struct pevent_record *next;
Steven Rostedtf7d82352012-04-06 00:47:53 +020057 long alloc_addr;
58#endif
59};
60
61/*
62 * Trace sequences are used to allow a function to call several other functions
63 * to create a string of data to use (up to a max of PAGE_SIZE).
64 */
65
66struct trace_seq {
67 char *buffer;
68 unsigned int buffer_size;
69 unsigned int len;
70 unsigned int readpos;
71};
72
73void trace_seq_init(struct trace_seq *s);
Namhyung Kim6a48aec2013-06-04 14:20:19 +090074void trace_seq_reset(struct trace_seq *s);
Steven Rostedtf7d82352012-04-06 00:47:53 +020075void trace_seq_destroy(struct trace_seq *s);
76
77extern int trace_seq_printf(struct trace_seq *s, const char *fmt, ...)
78 __attribute__ ((format (printf, 2, 3)));
79extern int trace_seq_vprintf(struct trace_seq *s, const char *fmt, va_list args)
80 __attribute__ ((format (printf, 2, 0)));
81
82extern int trace_seq_puts(struct trace_seq *s, const char *str);
83extern int trace_seq_putc(struct trace_seq *s, unsigned char c);
84
85extern void trace_seq_terminate(struct trace_seq *s);
86
87extern int trace_seq_do_printf(struct trace_seq *s);
88
89
90/* ----------------------- pevent ----------------------- */
91
92struct pevent;
93struct event_format;
94
95typedef int (*pevent_event_handler_func)(struct trace_seq *s,
Steven Rostedt1c698182012-04-06 00:48:06 +020096 struct pevent_record *record,
Steven Rostedtf7d82352012-04-06 00:47:53 +020097 struct event_format *event,
98 void *context);
99
100typedef int (*pevent_plugin_load_func)(struct pevent *pevent);
101typedef int (*pevent_plugin_unload_func)(void);
102
103struct plugin_option {
104 struct plugin_option *next;
105 void *handle;
106 char *file;
107 char *name;
108 char *plugin_alias;
109 char *description;
110 char *value;
Steven Rostedtff1a70e2012-08-23 11:22:01 -0400111 void *priv;
Steven Rostedtf7d82352012-04-06 00:47:53 +0200112 int set;
113};
114
115/*
116 * Plugin hooks that can be called:
117 *
118 * PEVENT_PLUGIN_LOADER: (required)
119 * The function name to initialized the plugin.
120 *
121 * int PEVENT_PLUGIN_LOADER(struct pevent *pevent)
122 *
123 * PEVENT_PLUGIN_UNLOADER: (optional)
124 * The function called just before unloading
125 *
126 * int PEVENT_PLUGIN_UNLOADER(void)
127 *
128 * PEVENT_PLUGIN_OPTIONS: (optional)
129 * Plugin options that can be set before loading
130 *
131 * struct plugin_option PEVENT_PLUGIN_OPTIONS[] = {
132 * {
133 * .name = "option-name",
134 * .plugin_alias = "overide-file-name", (optional)
135 * .description = "description of option to show users",
136 * },
137 * {
138 * .name = NULL,
139 * },
140 * };
141 *
142 * Array must end with .name = NULL;
143 *
144 *
145 * .plugin_alias is used to give a shorter name to access
146 * the vairable. Useful if a plugin handles more than one event.
147 *
148 * PEVENT_PLUGIN_ALIAS: (optional)
149 * The name to use for finding options (uses filename if not defined)
150 */
151#define PEVENT_PLUGIN_LOADER pevent_plugin_loader
152#define PEVENT_PLUGIN_UNLOADER pevent_plugin_unloader
153#define PEVENT_PLUGIN_OPTIONS pevent_plugin_options
154#define PEVENT_PLUGIN_ALIAS pevent_plugin_alias
155#define _MAKE_STR(x) #x
156#define MAKE_STR(x) _MAKE_STR(x)
157#define PEVENT_PLUGIN_LOADER_NAME MAKE_STR(PEVENT_PLUGIN_LOADER)
158#define PEVENT_PLUGIN_UNLOADER_NAME MAKE_STR(PEVENT_PLUGIN_UNLOADER)
159#define PEVENT_PLUGIN_OPTIONS_NAME MAKE_STR(PEVENT_PLUGIN_OPTIONS)
160#define PEVENT_PLUGIN_ALIAS_NAME MAKE_STR(PEVENT_PLUGIN_ALIAS)
161
162#define NSECS_PER_SEC 1000000000ULL
163#define NSECS_PER_USEC 1000ULL
164
165enum format_flags {
166 FIELD_IS_ARRAY = 1,
167 FIELD_IS_POINTER = 2,
168 FIELD_IS_SIGNED = 4,
169 FIELD_IS_STRING = 8,
170 FIELD_IS_DYNAMIC = 16,
171 FIELD_IS_LONG = 32,
Steven Rostedt668fe012012-04-06 00:47:55 +0200172 FIELD_IS_FLAG = 64,
173 FIELD_IS_SYMBOLIC = 128,
Steven Rostedtf7d82352012-04-06 00:47:53 +0200174};
175
176struct format_field {
177 struct format_field *next;
178 struct event_format *event;
179 char *type;
180 char *name;
181 int offset;
182 int size;
183 unsigned int arraylen;
184 unsigned int elementsize;
185 unsigned long flags;
186};
187
188struct format {
189 int nr_common;
190 int nr_fields;
191 struct format_field *common_fields;
192 struct format_field *fields;
193};
194
195struct print_arg_atom {
196 char *atom;
197};
198
199struct print_arg_string {
200 char *string;
201 int offset;
202};
203
204struct print_arg_field {
205 char *name;
206 struct format_field *field;
207};
208
209struct print_flag_sym {
210 struct print_flag_sym *next;
211 char *value;
212 char *str;
213};
214
215struct print_arg_typecast {
216 char *type;
217 struct print_arg *item;
218};
219
220struct print_arg_flags {
221 struct print_arg *field;
222 char *delim;
223 struct print_flag_sym *flags;
224};
225
226struct print_arg_symbol {
227 struct print_arg *field;
228 struct print_flag_sym *symbols;
229};
230
Namhyung Kime080e6f2012-06-27 09:41:41 +0900231struct print_arg_hex {
232 struct print_arg *field;
233 struct print_arg *size;
234};
235
Steven Rostedtf7d82352012-04-06 00:47:53 +0200236struct print_arg_dynarray {
237 struct format_field *field;
238 struct print_arg *index;
239};
240
241struct print_arg;
242
243struct print_arg_op {
244 char *op;
245 int prio;
246 struct print_arg *left;
247 struct print_arg *right;
248};
249
250struct pevent_function_handler;
251
252struct print_arg_func {
253 struct pevent_function_handler *func;
254 struct print_arg *args;
255};
256
257enum print_arg_type {
258 PRINT_NULL,
259 PRINT_ATOM,
260 PRINT_FIELD,
261 PRINT_FLAGS,
262 PRINT_SYMBOL,
Namhyung Kime080e6f2012-06-27 09:41:41 +0900263 PRINT_HEX,
Steven Rostedtf7d82352012-04-06 00:47:53 +0200264 PRINT_TYPE,
265 PRINT_STRING,
266 PRINT_BSTRING,
267 PRINT_DYNAMIC_ARRAY,
268 PRINT_OP,
269 PRINT_FUNC,
270};
271
272struct print_arg {
273 struct print_arg *next;
274 enum print_arg_type type;
275 union {
276 struct print_arg_atom atom;
277 struct print_arg_field field;
278 struct print_arg_typecast typecast;
279 struct print_arg_flags flags;
280 struct print_arg_symbol symbol;
Namhyung Kime080e6f2012-06-27 09:41:41 +0900281 struct print_arg_hex hex;
Steven Rostedtf7d82352012-04-06 00:47:53 +0200282 struct print_arg_func func;
283 struct print_arg_string string;
284 struct print_arg_op op;
285 struct print_arg_dynarray dynarray;
286 };
287};
288
289struct print_fmt {
290 char *format;
291 struct print_arg *args;
292};
293
294struct event_format {
295 struct pevent *pevent;
296 char *name;
297 int id;
298 int flags;
299 struct format format;
300 struct print_fmt print_fmt;
301 char *system;
302 pevent_event_handler_func handler;
303 void *context;
304};
305
306enum {
307 EVENT_FL_ISFTRACE = 0x01,
308 EVENT_FL_ISPRINT = 0x02,
309 EVENT_FL_ISBPRINT = 0x04,
310 EVENT_FL_ISFUNCENT = 0x10,
311 EVENT_FL_ISFUNCRET = 0x20,
Steven Rostedtc6c2b962013-11-01 17:53:59 -0400312 EVENT_FL_NOHANDLE = 0x40,
313 EVENT_FL_PRINTRAW = 0x80,
Steven Rostedtf7d82352012-04-06 00:47:53 +0200314
315 EVENT_FL_FAILED = 0x80000000
316};
317
318enum event_sort_type {
319 EVENT_SORT_ID,
320 EVENT_SORT_NAME,
321 EVENT_SORT_SYSTEM,
322};
323
324enum event_type {
325 EVENT_ERROR,
326 EVENT_NONE,
327 EVENT_SPACE,
328 EVENT_NEWLINE,
329 EVENT_OP,
330 EVENT_DELIM,
331 EVENT_ITEM,
332 EVENT_DQUOTE,
333 EVENT_SQUOTE,
334};
335
336typedef unsigned long long (*pevent_func_handler)(struct trace_seq *s,
337 unsigned long long *args);
338
339enum pevent_func_arg_type {
340 PEVENT_FUNC_ARG_VOID,
341 PEVENT_FUNC_ARG_INT,
342 PEVENT_FUNC_ARG_LONG,
343 PEVENT_FUNC_ARG_STRING,
344 PEVENT_FUNC_ARG_PTR,
345 PEVENT_FUNC_ARG_MAX_TYPES
346};
347
Steven Rostedt4dc10242012-04-06 00:47:57 +0200348enum pevent_flag {
349 PEVENT_NSEC_OUTPUT = 1, /* output in NSECS */
350};
351
Namhyung Kim2f197b92012-08-22 16:00:30 +0900352#define PEVENT_ERRORS \
353 _PE(MEM_ALLOC_FAILED, "failed to allocate memory"), \
354 _PE(PARSE_EVENT_FAILED, "failed to parse event"), \
355 _PE(READ_ID_FAILED, "failed to read event id"), \
356 _PE(READ_FORMAT_FAILED, "failed to read event format"), \
357 _PE(READ_PRINT_FAILED, "failed to read event print fmt"), \
Namhyung Kim67ed9392012-09-07 11:49:47 +0900358 _PE(OLD_FTRACE_ARG_FAILED,"failed to allocate field name for ftrace"),\
359 _PE(INVALID_ARG_TYPE, "invalid argument type")
Namhyung Kim2f197b92012-08-22 16:00:30 +0900360
361#undef _PE
362#define _PE(__code, __str) PEVENT_ERRNO__ ## __code
Namhyung Kimbffddff2012-08-22 16:00:29 +0900363enum pevent_errno {
364 PEVENT_ERRNO__SUCCESS = 0,
365
366 /*
367 * Choose an arbitrary negative big number not to clash with standard
368 * errno since SUS requires the errno has distinct positive values.
369 * See 'Issue 6' in the link below.
370 *
371 * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
372 */
373 __PEVENT_ERRNO__START = -100000,
374
Namhyung Kim2f197b92012-08-22 16:00:30 +0900375 PEVENT_ERRORS,
Namhyung Kimbffddff2012-08-22 16:00:29 +0900376
377 __PEVENT_ERRNO__END,
378};
Namhyung Kim2f197b92012-08-22 16:00:30 +0900379#undef _PE
Namhyung Kimbffddff2012-08-22 16:00:29 +0900380
Jiri Olsac877bbd2013-12-03 14:09:16 +0100381struct plugin_list;
382
383struct plugin_list *traceevent_load_plugins(struct pevent *pevent);
384void traceevent_unload_plugins(struct plugin_list *plugin_list);
385
Steven Rostedtf7d82352012-04-06 00:47:53 +0200386struct cmdline;
387struct cmdline_list;
388struct func_map;
389struct func_list;
390struct event_handler;
391
392struct pevent {
393 int ref_count;
394
395 int header_page_ts_offset;
396 int header_page_ts_size;
397 int header_page_size_offset;
398 int header_page_size_size;
399 int header_page_data_offset;
400 int header_page_data_size;
401 int header_page_overwrite;
402
403 int file_bigendian;
404 int host_bigendian;
405
406 int latency_format;
407
408 int old_format;
409
410 int cpus;
411 int long_size;
Namhyung Kim012ac692013-06-04 14:20:20 +0900412 int page_size;
Steven Rostedtf7d82352012-04-06 00:47:53 +0200413
414 struct cmdline *cmdlines;
415 struct cmdline_list *cmdlist;
416 int cmdline_count;
417
418 struct func_map *func_map;
419 struct func_list *funclist;
420 unsigned int func_count;
421
422 struct printk_map *printk_map;
423 struct printk_list *printklist;
424 unsigned int printk_count;
425
Steven Rostedt4dc10242012-04-06 00:47:57 +0200426
Steven Rostedtf7d82352012-04-06 00:47:53 +0200427 struct event_format **events;
428 int nr_events;
429 struct event_format **sort_events;
430 enum event_sort_type last_type;
431
432 int type_offset;
433 int type_size;
434
435 int pid_offset;
436 int pid_size;
437
438 int pc_offset;
439 int pc_size;
440
441 int flags_offset;
442 int flags_size;
443
444 int ld_offset;
445 int ld_size;
446
447 int print_raw;
448
449 int test_filters;
450
Steven Rostedt4dc10242012-04-06 00:47:57 +0200451 int flags;
452
Steven Rostedtf7d82352012-04-06 00:47:53 +0200453 struct format_field *bprint_ip_field;
454 struct format_field *bprint_fmt_field;
455 struct format_field *bprint_buf_field;
456
457 struct event_handler *handlers;
458 struct pevent_function_handler *func_handlers;
459
460 /* cache */
461 struct event_format *last_event;
Yoshihiro YUNOMAE1b372ca2013-11-01 17:53:53 -0400462
463 char *trace_clock;
Steven Rostedtf7d82352012-04-06 00:47:53 +0200464};
465
Steven Rostedt4dc10242012-04-06 00:47:57 +0200466static inline void pevent_set_flag(struct pevent *pevent, int flag)
467{
468 pevent->flags |= flag;
469}
470
Steven Rostedtf7d82352012-04-06 00:47:53 +0200471static inline unsigned short
472__data2host2(struct pevent *pevent, unsigned short data)
473{
474 unsigned short swap;
475
476 if (pevent->host_bigendian == pevent->file_bigendian)
477 return data;
478
479 swap = ((data & 0xffULL) << 8) |
480 ((data & (0xffULL << 8)) >> 8);
481
482 return swap;
483}
484
485static inline unsigned int
486__data2host4(struct pevent *pevent, unsigned int data)
487{
488 unsigned int swap;
489
490 if (pevent->host_bigendian == pevent->file_bigendian)
491 return data;
492
493 swap = ((data & 0xffULL) << 24) |
494 ((data & (0xffULL << 8)) << 8) |
495 ((data & (0xffULL << 16)) >> 8) |
496 ((data & (0xffULL << 24)) >> 24);
497
498 return swap;
499}
500
501static inline unsigned long long
502__data2host8(struct pevent *pevent, unsigned long long data)
503{
504 unsigned long long swap;
505
506 if (pevent->host_bigendian == pevent->file_bigendian)
507 return data;
508
509 swap = ((data & 0xffULL) << 56) |
510 ((data & (0xffULL << 8)) << 40) |
511 ((data & (0xffULL << 16)) << 24) |
512 ((data & (0xffULL << 24)) << 8) |
513 ((data & (0xffULL << 32)) >> 8) |
514 ((data & (0xffULL << 40)) >> 24) |
515 ((data & (0xffULL << 48)) >> 40) |
516 ((data & (0xffULL << 56)) >> 56);
517
518 return swap;
519}
520
521#define data2host2(pevent, ptr) __data2host2(pevent, *(unsigned short *)(ptr))
522#define data2host4(pevent, ptr) __data2host4(pevent, *(unsigned int *)(ptr))
523#define data2host8(pevent, ptr) \
524({ \
525 unsigned long long __val; \
526 \
527 memcpy(&__val, (ptr), sizeof(unsigned long long)); \
528 __data2host8(pevent, __val); \
529})
530
Jiri Olsa91a058a2013-12-03 14:09:18 +0100531static inline int traceevent_host_bigendian(void)
532{
533 unsigned char str[] = { 0x1, 0x2, 0x3, 0x4 };
534 unsigned int val;
535
536 memcpy(&val, str, 4);
537 return val == 0x01020304;
538}
539
Steven Rostedtf7d82352012-04-06 00:47:53 +0200540/* taken from kernel/trace/trace.h */
541enum trace_flag_type {
542 TRACE_FLAG_IRQS_OFF = 0x01,
543 TRACE_FLAG_IRQS_NOSUPPORT = 0x02,
544 TRACE_FLAG_NEED_RESCHED = 0x04,
545 TRACE_FLAG_HARDIRQ = 0x08,
546 TRACE_FLAG_SOFTIRQ = 0x10,
547};
548
549int pevent_register_comm(struct pevent *pevent, const char *comm, int pid);
Yoshihiro YUNOMAE1b372ca2013-11-01 17:53:53 -0400550void pevent_register_trace_clock(struct pevent *pevent, char *trace_clock);
Steven Rostedtf7d82352012-04-06 00:47:53 +0200551int pevent_register_function(struct pevent *pevent, char *name,
552 unsigned long long addr, char *mod);
Steven Rostedt (Red Hat)18900af2013-11-01 17:53:54 -0400553int pevent_register_print_string(struct pevent *pevent, const char *fmt,
Steven Rostedtf7d82352012-04-06 00:47:53 +0200554 unsigned long long addr);
555int pevent_pid_is_registered(struct pevent *pevent, int pid);
556
557void pevent_print_event(struct pevent *pevent, struct trace_seq *s,
Yoshihiro YUNOMAE1b372ca2013-11-01 17:53:53 -0400558 struct pevent_record *record, bool use_trace_clock);
Steven Rostedtf7d82352012-04-06 00:47:53 +0200559
560int pevent_parse_header_page(struct pevent *pevent, char *buf, unsigned long size,
561 int long_size);
562
Namhyung Kimbffddff2012-08-22 16:00:29 +0900563enum pevent_errno pevent_parse_event(struct pevent *pevent, const char *buf,
564 unsigned long size, const char *sys);
Jiri Olsa71ad9582013-12-03 14:09:19 +0100565enum pevent_errno pevent_parse_format(struct pevent *pevent,
566 struct event_format **eventp,
567 const char *buf,
Arnaldo Carvalho de Melo2b291752012-09-18 11:13:15 -0300568 unsigned long size, const char *sys);
569void pevent_free_format(struct event_format *event);
Steven Rostedtf7d82352012-04-06 00:47:53 +0200570
571void *pevent_get_field_raw(struct trace_seq *s, struct event_format *event,
Steven Rostedt1c698182012-04-06 00:48:06 +0200572 const char *name, struct pevent_record *record,
Steven Rostedtf7d82352012-04-06 00:47:53 +0200573 int *len, int err);
574
575int pevent_get_field_val(struct trace_seq *s, struct event_format *event,
Steven Rostedt1c698182012-04-06 00:48:06 +0200576 const char *name, struct pevent_record *record,
Steven Rostedtf7d82352012-04-06 00:47:53 +0200577 unsigned long long *val, int err);
578int pevent_get_common_field_val(struct trace_seq *s, struct event_format *event,
Steven Rostedt1c698182012-04-06 00:48:06 +0200579 const char *name, struct pevent_record *record,
Steven Rostedtf7d82352012-04-06 00:47:53 +0200580 unsigned long long *val, int err);
581int pevent_get_any_field_val(struct trace_seq *s, struct event_format *event,
Steven Rostedt1c698182012-04-06 00:48:06 +0200582 const char *name, struct pevent_record *record,
Steven Rostedtf7d82352012-04-06 00:47:53 +0200583 unsigned long long *val, int err);
584
585int pevent_print_num_field(struct trace_seq *s, const char *fmt,
586 struct event_format *event, const char *name,
Steven Rostedt1c698182012-04-06 00:48:06 +0200587 struct pevent_record *record, int err);
Steven Rostedtf7d82352012-04-06 00:47:53 +0200588
Steven Rostedt6d862b82013-11-01 17:54:00 -0400589int pevent_print_func_field(struct trace_seq *s, const char *fmt,
590 struct event_format *event, const char *name,
591 struct pevent_record *record, int err);
592
Namhyung Kim79d5adf2013-06-04 14:20:18 +0900593int pevent_register_event_handler(struct pevent *pevent, int id,
594 const char *sys_name, const char *event_name,
Steven Rostedtf7d82352012-04-06 00:47:53 +0200595 pevent_event_handler_func func, void *context);
596int pevent_register_print_function(struct pevent *pevent,
597 pevent_func_handler func,
598 enum pevent_func_arg_type ret_type,
599 char *name, ...);
600
601struct format_field *pevent_find_common_field(struct event_format *event, const char *name);
602struct format_field *pevent_find_field(struct event_format *event, const char *name);
603struct format_field *pevent_find_any_field(struct event_format *event, const char *name);
604
605const char *pevent_find_function(struct pevent *pevent, unsigned long long addr);
606unsigned long long
607pevent_find_function_address(struct pevent *pevent, unsigned long long addr);
608unsigned long long pevent_read_number(struct pevent *pevent, const void *ptr, int size);
609int pevent_read_number_field(struct format_field *field, const void *data,
610 unsigned long long *value);
611
612struct event_format *pevent_find_event(struct pevent *pevent, int id);
613
614struct event_format *
615pevent_find_event_by_name(struct pevent *pevent, const char *sys, const char *name);
616
617void pevent_data_lat_fmt(struct pevent *pevent,
Steven Rostedt1c698182012-04-06 00:48:06 +0200618 struct trace_seq *s, struct pevent_record *record);
619int pevent_data_type(struct pevent *pevent, struct pevent_record *rec);
Steven Rostedtf7d82352012-04-06 00:47:53 +0200620struct event_format *pevent_data_event_from_type(struct pevent *pevent, int type);
Steven Rostedt1c698182012-04-06 00:48:06 +0200621int pevent_data_pid(struct pevent *pevent, struct pevent_record *rec);
Steven Rostedtf7d82352012-04-06 00:47:53 +0200622const char *pevent_data_comm_from_pid(struct pevent *pevent, int pid);
623void pevent_event_info(struct trace_seq *s, struct event_format *event,
Steven Rostedt1c698182012-04-06 00:48:06 +0200624 struct pevent_record *record);
Namhyung Kim2f197b92012-08-22 16:00:30 +0900625int pevent_strerror(struct pevent *pevent, enum pevent_errno errnum,
626 char *buf, size_t buflen);
Steven Rostedtf7d82352012-04-06 00:47:53 +0200627
628struct event_format **pevent_list_events(struct pevent *pevent, enum event_sort_type);
629struct format_field **pevent_event_common_fields(struct event_format *event);
630struct format_field **pevent_event_fields(struct event_format *event);
631
632static inline int pevent_get_cpus(struct pevent *pevent)
633{
634 return pevent->cpus;
635}
636
637static inline void pevent_set_cpus(struct pevent *pevent, int cpus)
638{
639 pevent->cpus = cpus;
640}
641
642static inline int pevent_get_long_size(struct pevent *pevent)
643{
644 return pevent->long_size;
645}
646
647static inline void pevent_set_long_size(struct pevent *pevent, int long_size)
648{
649 pevent->long_size = long_size;
650}
651
Namhyung Kim012ac692013-06-04 14:20:20 +0900652static inline int pevent_get_page_size(struct pevent *pevent)
653{
654 return pevent->page_size;
655}
656
657static inline void pevent_set_page_size(struct pevent *pevent, int _page_size)
658{
659 pevent->page_size = _page_size;
660}
661
Steven Rostedtf7d82352012-04-06 00:47:53 +0200662static inline int pevent_is_file_bigendian(struct pevent *pevent)
663{
664 return pevent->file_bigendian;
665}
666
667static inline void pevent_set_file_bigendian(struct pevent *pevent, int endian)
668{
669 pevent->file_bigendian = endian;
670}
671
672static inline int pevent_is_host_bigendian(struct pevent *pevent)
673{
674 return pevent->host_bigendian;
675}
676
677static inline void pevent_set_host_bigendian(struct pevent *pevent, int endian)
678{
679 pevent->host_bigendian = endian;
680}
681
682static inline int pevent_is_latency_format(struct pevent *pevent)
683{
684 return pevent->latency_format;
685}
686
687static inline void pevent_set_latency_format(struct pevent *pevent, int lat)
688{
689 pevent->latency_format = lat;
690}
691
692struct pevent *pevent_alloc(void);
693void pevent_free(struct pevent *pevent);
694void pevent_ref(struct pevent *pevent);
695void pevent_unref(struct pevent *pevent);
696
697/* access to the internal parser */
698void pevent_buffer_init(const char *buf, unsigned long long size);
699enum event_type pevent_read_token(char **tok);
700void pevent_free_token(char *token);
701int pevent_peek_char(void);
702const char *pevent_get_input_buf(void);
703unsigned long long pevent_get_input_buf_ptr(void);
704
705/* for debugging */
706void pevent_print_funcs(struct pevent *pevent);
707void pevent_print_printk(struct pevent *pevent);
708
709/* ----------------------- filtering ----------------------- */
710
711enum filter_boolean_type {
712 FILTER_FALSE,
713 FILTER_TRUE,
714};
715
716enum filter_op_type {
717 FILTER_OP_AND = 1,
718 FILTER_OP_OR,
719 FILTER_OP_NOT,
720};
721
722enum filter_cmp_type {
723 FILTER_CMP_NONE,
724 FILTER_CMP_EQ,
725 FILTER_CMP_NE,
726 FILTER_CMP_GT,
727 FILTER_CMP_LT,
728 FILTER_CMP_GE,
729 FILTER_CMP_LE,
730 FILTER_CMP_MATCH,
731 FILTER_CMP_NOT_MATCH,
732 FILTER_CMP_REGEX,
733 FILTER_CMP_NOT_REGEX,
734};
735
736enum filter_exp_type {
737 FILTER_EXP_NONE,
738 FILTER_EXP_ADD,
739 FILTER_EXP_SUB,
740 FILTER_EXP_MUL,
741 FILTER_EXP_DIV,
742 FILTER_EXP_MOD,
743 FILTER_EXP_RSHIFT,
744 FILTER_EXP_LSHIFT,
745 FILTER_EXP_AND,
746 FILTER_EXP_OR,
747 FILTER_EXP_XOR,
748 FILTER_EXP_NOT,
749};
750
751enum filter_arg_type {
752 FILTER_ARG_NONE,
753 FILTER_ARG_BOOLEAN,
754 FILTER_ARG_VALUE,
755 FILTER_ARG_FIELD,
756 FILTER_ARG_EXP,
757 FILTER_ARG_OP,
758 FILTER_ARG_NUM,
759 FILTER_ARG_STR,
760};
761
762enum filter_value_type {
763 FILTER_NUMBER,
764 FILTER_STRING,
765 FILTER_CHAR
766};
767
768struct fliter_arg;
769
770struct filter_arg_boolean {
771 enum filter_boolean_type value;
772};
773
774struct filter_arg_field {
775 struct format_field *field;
776};
777
778struct filter_arg_value {
779 enum filter_value_type type;
780 union {
781 char *str;
782 unsigned long long val;
783 };
784};
785
786struct filter_arg_op {
787 enum filter_op_type type;
788 struct filter_arg *left;
789 struct filter_arg *right;
790};
791
792struct filter_arg_exp {
793 enum filter_exp_type type;
794 struct filter_arg *left;
795 struct filter_arg *right;
796};
797
798struct filter_arg_num {
799 enum filter_cmp_type type;
800 struct filter_arg *left;
801 struct filter_arg *right;
802};
803
804struct filter_arg_str {
805 enum filter_cmp_type type;
806 struct format_field *field;
807 char *val;
808 char *buffer;
809 regex_t reg;
810};
811
812struct filter_arg {
813 enum filter_arg_type type;
814 union {
Steven Rostedt668fe012012-04-06 00:47:55 +0200815 struct filter_arg_boolean boolean;
Steven Rostedtf7d82352012-04-06 00:47:53 +0200816 struct filter_arg_field field;
817 struct filter_arg_value value;
818 struct filter_arg_op op;
819 struct filter_arg_exp exp;
820 struct filter_arg_num num;
821 struct filter_arg_str str;
822 };
823};
824
825struct filter_type {
826 int event_id;
827 struct event_format *event;
828 struct filter_arg *filter;
829};
830
831struct event_filter {
832 struct pevent *pevent;
833 int filters;
834 struct filter_type *event_filters;
835};
836
837struct event_filter *pevent_filter_alloc(struct pevent *pevent);
838
839#define FILTER_NONE -2
840#define FILTER_NOEXIST -1
841#define FILTER_MISS 0
842#define FILTER_MATCH 1
843
844enum filter_trivial_type {
845 FILTER_TRIVIAL_FALSE,
846 FILTER_TRIVIAL_TRUE,
847 FILTER_TRIVIAL_BOTH,
848};
849
850int pevent_filter_add_filter_str(struct event_filter *filter,
851 const char *filter_str,
852 char **error_str);
853
854
855int pevent_filter_match(struct event_filter *filter,
Steven Rostedt1c698182012-04-06 00:48:06 +0200856 struct pevent_record *record);
Steven Rostedtf7d82352012-04-06 00:47:53 +0200857
858int pevent_event_filtered(struct event_filter *filter,
859 int event_id);
860
861void pevent_filter_reset(struct event_filter *filter);
862
863void pevent_filter_clear_trivial(struct event_filter *filter,
864 enum filter_trivial_type type);
865
866void pevent_filter_free(struct event_filter *filter);
867
868char *pevent_filter_make_string(struct event_filter *filter, int event_id);
869
870int pevent_filter_remove_event(struct event_filter *filter,
871 int event_id);
872
873int pevent_filter_event_has_trivial(struct event_filter *filter,
874 int event_id,
875 enum filter_trivial_type type);
876
877int pevent_filter_copy(struct event_filter *dest, struct event_filter *source);
878
879int pevent_update_trivial(struct event_filter *dest, struct event_filter *source,
880 enum filter_trivial_type type);
881
882int pevent_filter_compare(struct event_filter *filter1, struct event_filter *filter2);
883
884#endif /* _PARSE_EVENTS_H */