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