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