Loading...
1/* SPDX-License-Identifier: LGPL-2.1 */
2/*
3 * Copyright (C) 2009, 2010 Red Hat Inc, Steven Rostedt <srostedt@redhat.com>
4 *
5 */
6#ifndef _PARSE_EVENTS_H
7#define _PARSE_EVENTS_H
8
9#include <stdbool.h>
10#include <stdarg.h>
11#include <stdio.h>
12#include <regex.h>
13#include <string.h>
14
15#include "trace-seq.h"
16
17#ifndef __maybe_unused
18#define __maybe_unused __attribute__((unused))
19#endif
20
21#ifndef DEBUG_RECORD
22#define DEBUG_RECORD 0
23#endif
24
25struct tep_record {
26 unsigned long long ts;
27 unsigned long long offset;
28 long long missed_events; /* buffer dropped events before */
29 int record_size; /* size of binary record */
30 int size; /* size of data */
31 void *data;
32 int cpu;
33 int ref_count;
34 int locked; /* Do not free, even if ref_count is zero */
35 void *priv;
36#if DEBUG_RECORD
37 struct tep_record *prev;
38 struct tep_record *next;
39 long alloc_addr;
40#endif
41};
42
43/* ----------------------- tep ----------------------- */
44
45struct tep_handle;
46struct tep_event;
47
48typedef int (*tep_event_handler_func)(struct trace_seq *s,
49 struct tep_record *record,
50 struct tep_event *event,
51 void *context);
52
53typedef int (*tep_plugin_load_func)(struct tep_handle *tep);
54typedef int (*tep_plugin_unload_func)(struct tep_handle *tep);
55
56struct tep_plugin_option {
57 struct tep_plugin_option *next;
58 void *handle;
59 char *file;
60 char *name;
61 char *plugin_alias;
62 char *description;
63 const char *value;
64 void *priv;
65 int set;
66};
67
68/*
69 * Plugin hooks that can be called:
70 *
71 * TEP_PLUGIN_LOADER: (required)
72 * The function name to initialized the plugin.
73 *
74 * int TEP_PLUGIN_LOADER(struct tep_handle *tep)
75 *
76 * TEP_PLUGIN_UNLOADER: (optional)
77 * The function called just before unloading
78 *
79 * int TEP_PLUGIN_UNLOADER(struct tep_handle *tep)
80 *
81 * TEP_PLUGIN_OPTIONS: (optional)
82 * Plugin options that can be set before loading
83 *
84 * struct tep_plugin_option TEP_PLUGIN_OPTIONS[] = {
85 * {
86 * .name = "option-name",
87 * .plugin_alias = "override-file-name", (optional)
88 * .description = "description of option to show users",
89 * },
90 * {
91 * .name = NULL,
92 * },
93 * };
94 *
95 * Array must end with .name = NULL;
96 *
97 *
98 * .plugin_alias is used to give a shorter name to access
99 * the vairable. Useful if a plugin handles more than one event.
100 *
101 * If .value is not set, then it is considered a boolean and only
102 * .set will be processed. If .value is defined, then it is considered
103 * a string option and .set will be ignored.
104 *
105 * TEP_PLUGIN_ALIAS: (optional)
106 * The name to use for finding options (uses filename if not defined)
107 */
108#define TEP_PLUGIN_LOADER tep_plugin_loader
109#define TEP_PLUGIN_UNLOADER tep_plugin_unloader
110#define TEP_PLUGIN_OPTIONS tep_plugin_options
111#define TEP_PLUGIN_ALIAS tep_plugin_alias
112#define _MAKE_STR(x) #x
113#define MAKE_STR(x) _MAKE_STR(x)
114#define TEP_PLUGIN_LOADER_NAME MAKE_STR(TEP_PLUGIN_LOADER)
115#define TEP_PLUGIN_UNLOADER_NAME MAKE_STR(TEP_PLUGIN_UNLOADER)
116#define TEP_PLUGIN_OPTIONS_NAME MAKE_STR(TEP_PLUGIN_OPTIONS)
117#define TEP_PLUGIN_ALIAS_NAME MAKE_STR(TEP_PLUGIN_ALIAS)
118
119enum tep_format_flags {
120 TEP_FIELD_IS_ARRAY = 1,
121 TEP_FIELD_IS_POINTER = 2,
122 TEP_FIELD_IS_SIGNED = 4,
123 TEP_FIELD_IS_STRING = 8,
124 TEP_FIELD_IS_DYNAMIC = 16,
125 TEP_FIELD_IS_LONG = 32,
126 TEP_FIELD_IS_FLAG = 64,
127 TEP_FIELD_IS_SYMBOLIC = 128,
128};
129
130struct tep_format_field {
131 struct tep_format_field *next;
132 struct tep_event *event;
133 char *type;
134 char *name;
135 char *alias;
136 int offset;
137 int size;
138 unsigned int arraylen;
139 unsigned int elementsize;
140 unsigned long flags;
141};
142
143struct tep_format {
144 int nr_common;
145 int nr_fields;
146 struct tep_format_field *common_fields;
147 struct tep_format_field *fields;
148};
149
150struct tep_print_arg_atom {
151 char *atom;
152};
153
154struct tep_print_arg_string {
155 char *string;
156 int offset;
157};
158
159struct tep_print_arg_bitmask {
160 char *bitmask;
161 int offset;
162};
163
164struct tep_print_arg_field {
165 char *name;
166 struct tep_format_field *field;
167};
168
169struct tep_print_flag_sym {
170 struct tep_print_flag_sym *next;
171 char *value;
172 char *str;
173};
174
175struct tep_print_arg_typecast {
176 char *type;
177 struct tep_print_arg *item;
178};
179
180struct tep_print_arg_flags {
181 struct tep_print_arg *field;
182 char *delim;
183 struct tep_print_flag_sym *flags;
184};
185
186struct tep_print_arg_symbol {
187 struct tep_print_arg *field;
188 struct tep_print_flag_sym *symbols;
189};
190
191struct tep_print_arg_hex {
192 struct tep_print_arg *field;
193 struct tep_print_arg *size;
194};
195
196struct tep_print_arg_int_array {
197 struct tep_print_arg *field;
198 struct tep_print_arg *count;
199 struct tep_print_arg *el_size;
200};
201
202struct tep_print_arg_dynarray {
203 struct tep_format_field *field;
204 struct tep_print_arg *index;
205};
206
207struct tep_print_arg;
208
209struct tep_print_arg_op {
210 char *op;
211 int prio;
212 struct tep_print_arg *left;
213 struct tep_print_arg *right;
214};
215
216struct tep_function_handler;
217
218struct tep_print_arg_func {
219 struct tep_function_handler *func;
220 struct tep_print_arg *args;
221};
222
223enum tep_print_arg_type {
224 TEP_PRINT_NULL,
225 TEP_PRINT_ATOM,
226 TEP_PRINT_FIELD,
227 TEP_PRINT_FLAGS,
228 TEP_PRINT_SYMBOL,
229 TEP_PRINT_HEX,
230 TEP_PRINT_INT_ARRAY,
231 TEP_PRINT_TYPE,
232 TEP_PRINT_STRING,
233 TEP_PRINT_BSTRING,
234 TEP_PRINT_DYNAMIC_ARRAY,
235 TEP_PRINT_OP,
236 TEP_PRINT_FUNC,
237 TEP_PRINT_BITMASK,
238 TEP_PRINT_DYNAMIC_ARRAY_LEN,
239 TEP_PRINT_HEX_STR,
240};
241
242struct tep_print_arg {
243 struct tep_print_arg *next;
244 enum tep_print_arg_type type;
245 union {
246 struct tep_print_arg_atom atom;
247 struct tep_print_arg_field field;
248 struct tep_print_arg_typecast typecast;
249 struct tep_print_arg_flags flags;
250 struct tep_print_arg_symbol symbol;
251 struct tep_print_arg_hex hex;
252 struct tep_print_arg_int_array int_array;
253 struct tep_print_arg_func func;
254 struct tep_print_arg_string string;
255 struct tep_print_arg_bitmask bitmask;
256 struct tep_print_arg_op op;
257 struct tep_print_arg_dynarray dynarray;
258 };
259};
260
261struct tep_print_parse;
262
263struct tep_print_fmt {
264 char *format;
265 struct tep_print_arg *args;
266 struct tep_print_parse *print_cache;
267};
268
269struct tep_event {
270 struct tep_handle *tep;
271 char *name;
272 int id;
273 int flags;
274 struct tep_format format;
275 struct tep_print_fmt print_fmt;
276 char *system;
277 tep_event_handler_func handler;
278 void *context;
279};
280
281enum {
282 TEP_EVENT_FL_ISFTRACE = 0x01,
283 TEP_EVENT_FL_ISPRINT = 0x02,
284 TEP_EVENT_FL_ISBPRINT = 0x04,
285 TEP_EVENT_FL_ISFUNCENT = 0x10,
286 TEP_EVENT_FL_ISFUNCRET = 0x20,
287 TEP_EVENT_FL_NOHANDLE = 0x40,
288 TEP_EVENT_FL_PRINTRAW = 0x80,
289
290 TEP_EVENT_FL_FAILED = 0x80000000
291};
292
293enum tep_event_sort_type {
294 TEP_EVENT_SORT_ID,
295 TEP_EVENT_SORT_NAME,
296 TEP_EVENT_SORT_SYSTEM,
297};
298
299enum tep_event_type {
300 TEP_EVENT_ERROR,
301 TEP_EVENT_NONE,
302 TEP_EVENT_SPACE,
303 TEP_EVENT_NEWLINE,
304 TEP_EVENT_OP,
305 TEP_EVENT_DELIM,
306 TEP_EVENT_ITEM,
307 TEP_EVENT_DQUOTE,
308 TEP_EVENT_SQUOTE,
309};
310
311typedef unsigned long long (*tep_func_handler)(struct trace_seq *s,
312 unsigned long long *args);
313
314enum tep_func_arg_type {
315 TEP_FUNC_ARG_VOID,
316 TEP_FUNC_ARG_INT,
317 TEP_FUNC_ARG_LONG,
318 TEP_FUNC_ARG_STRING,
319 TEP_FUNC_ARG_PTR,
320 TEP_FUNC_ARG_MAX_TYPES
321};
322
323enum tep_flag {
324 TEP_NSEC_OUTPUT = 1, /* output in NSECS */
325 TEP_DISABLE_SYS_PLUGINS = 1 << 1,
326 TEP_DISABLE_PLUGINS = 1 << 2,
327};
328
329#define TEP_ERRORS \
330 _PE(MEM_ALLOC_FAILED, "failed to allocate memory"), \
331 _PE(PARSE_EVENT_FAILED, "failed to parse event"), \
332 _PE(READ_ID_FAILED, "failed to read event id"), \
333 _PE(READ_FORMAT_FAILED, "failed to read event format"), \
334 _PE(READ_PRINT_FAILED, "failed to read event print fmt"), \
335 _PE(OLD_FTRACE_ARG_FAILED,"failed to allocate field name for ftrace"),\
336 _PE(INVALID_ARG_TYPE, "invalid argument type"), \
337 _PE(INVALID_EXP_TYPE, "invalid expression type"), \
338 _PE(INVALID_OP_TYPE, "invalid operator type"), \
339 _PE(INVALID_EVENT_NAME, "invalid event name"), \
340 _PE(EVENT_NOT_FOUND, "no event found"), \
341 _PE(SYNTAX_ERROR, "syntax error"), \
342 _PE(ILLEGAL_RVALUE, "illegal rvalue"), \
343 _PE(ILLEGAL_LVALUE, "illegal lvalue for string comparison"), \
344 _PE(INVALID_REGEX, "regex did not compute"), \
345 _PE(ILLEGAL_STRING_CMP, "illegal comparison for string"), \
346 _PE(ILLEGAL_INTEGER_CMP,"illegal comparison for integer"), \
347 _PE(REPARENT_NOT_OP, "cannot reparent other than OP"), \
348 _PE(REPARENT_FAILED, "failed to reparent filter OP"), \
349 _PE(BAD_FILTER_ARG, "bad arg in filter tree"), \
350 _PE(UNEXPECTED_TYPE, "unexpected type (not a value)"), \
351 _PE(ILLEGAL_TOKEN, "illegal token"), \
352 _PE(INVALID_PAREN, "open parenthesis cannot come here"), \
353 _PE(UNBALANCED_PAREN, "unbalanced number of parenthesis"), \
354 _PE(UNKNOWN_TOKEN, "unknown token"), \
355 _PE(FILTER_NOT_FOUND, "no filter found"), \
356 _PE(NOT_A_NUMBER, "must have number field"), \
357 _PE(NO_FILTER, "no filters exists"), \
358 _PE(FILTER_MISS, "record does not match to filter")
359
360#undef _PE
361#define _PE(__code, __str) TEP_ERRNO__ ## __code
362enum tep_errno {
363 TEP_ERRNO__SUCCESS = 0,
364 TEP_ERRNO__FILTER_MATCH = TEP_ERRNO__SUCCESS,
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 * https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
372 */
373 __TEP_ERRNO__START = -100000,
374
375 TEP_ERRORS,
376
377 __TEP_ERRNO__END,
378};
379#undef _PE
380
381struct tep_plugin_list;
382
383#define INVALID_PLUGIN_LIST_OPTION ((char **)((unsigned long)-1))
384
385enum tep_plugin_load_priority {
386 TEP_PLUGIN_FIRST,
387 TEP_PLUGIN_LAST,
388};
389
390int tep_add_plugin_path(struct tep_handle *tep, char *path,
391 enum tep_plugin_load_priority prio);
392struct tep_plugin_list *tep_load_plugins(struct tep_handle *tep);
393void tep_unload_plugins(struct tep_plugin_list *plugin_list,
394 struct tep_handle *tep);
395void tep_load_plugins_hook(struct tep_handle *tep, const char *suffix,
396 void (*load_plugin)(struct tep_handle *tep,
397 const char *path,
398 const char *name,
399 void *data),
400 void *data);
401char **tep_plugin_list_options(void);
402void tep_plugin_free_options_list(char **list);
403int tep_plugin_add_options(const char *name,
404 struct tep_plugin_option *options);
405int tep_plugin_add_option(const char *name, const char *val);
406void tep_plugin_remove_options(struct tep_plugin_option *options);
407void tep_plugin_print_options(struct trace_seq *s);
408void tep_print_plugins(struct trace_seq *s,
409 const char *prefix, const char *suffix,
410 const struct tep_plugin_list *list);
411
412/* tep_handle */
413typedef char *(tep_func_resolver_t)(void *priv,
414 unsigned long long *addrp, char **modp);
415void tep_set_flag(struct tep_handle *tep, int flag);
416void tep_clear_flag(struct tep_handle *tep, enum tep_flag flag);
417bool tep_test_flag(struct tep_handle *tep, enum tep_flag flags);
418
419static inline int tep_is_bigendian(void)
420{
421 unsigned char str[] = { 0x1, 0x2, 0x3, 0x4 };
422 unsigned int val;
423
424 memcpy(&val, str, 4);
425 return val == 0x01020304;
426}
427
428/* taken from kernel/trace/trace.h */
429enum trace_flag_type {
430 TRACE_FLAG_IRQS_OFF = 0x01,
431 TRACE_FLAG_IRQS_NOSUPPORT = 0x02,
432 TRACE_FLAG_NEED_RESCHED = 0x04,
433 TRACE_FLAG_HARDIRQ = 0x08,
434 TRACE_FLAG_SOFTIRQ = 0x10,
435};
436
437int tep_set_function_resolver(struct tep_handle *tep,
438 tep_func_resolver_t *func, void *priv);
439void tep_reset_function_resolver(struct tep_handle *tep);
440int tep_register_comm(struct tep_handle *tep, const char *comm, int pid);
441int tep_override_comm(struct tep_handle *tep, const char *comm, int pid);
442int tep_register_function(struct tep_handle *tep, char *name,
443 unsigned long long addr, char *mod);
444int tep_register_print_string(struct tep_handle *tep, const char *fmt,
445 unsigned long long addr);
446bool tep_is_pid_registered(struct tep_handle *tep, int pid);
447
448struct tep_event *tep_get_event(struct tep_handle *tep, int index);
449
450#define TEP_PRINT_INFO "INFO"
451#define TEP_PRINT_INFO_RAW "INFO_RAW"
452#define TEP_PRINT_COMM "COMM"
453#define TEP_PRINT_LATENCY "LATENCY"
454#define TEP_PRINT_NAME "NAME"
455#define TEP_PRINT_PID 1U
456#define TEP_PRINT_TIME 2U
457#define TEP_PRINT_CPU 3U
458
459void tep_print_event(struct tep_handle *tep, struct trace_seq *s,
460 struct tep_record *record, const char *fmt, ...)
461 __attribute__ ((format (printf, 4, 5)));
462
463int tep_parse_header_page(struct tep_handle *tep, char *buf, unsigned long size,
464 int long_size);
465
466enum tep_errno tep_parse_event(struct tep_handle *tep, const char *buf,
467 unsigned long size, const char *sys);
468enum tep_errno tep_parse_format(struct tep_handle *tep,
469 struct tep_event **eventp,
470 const char *buf,
471 unsigned long size, const char *sys);
472
473void *tep_get_field_raw(struct trace_seq *s, struct tep_event *event,
474 const char *name, struct tep_record *record,
475 int *len, int err);
476
477int tep_get_field_val(struct trace_seq *s, struct tep_event *event,
478 const char *name, struct tep_record *record,
479 unsigned long long *val, int err);
480int tep_get_common_field_val(struct trace_seq *s, struct tep_event *event,
481 const char *name, struct tep_record *record,
482 unsigned long long *val, int err);
483int tep_get_any_field_val(struct trace_seq *s, struct tep_event *event,
484 const char *name, struct tep_record *record,
485 unsigned long long *val, int err);
486
487int tep_print_num_field(struct trace_seq *s, const char *fmt,
488 struct tep_event *event, const char *name,
489 struct tep_record *record, int err);
490
491int tep_print_func_field(struct trace_seq *s, const char *fmt,
492 struct tep_event *event, const char *name,
493 struct tep_record *record, int err);
494
495enum tep_reg_handler {
496 TEP_REGISTER_SUCCESS = 0,
497 TEP_REGISTER_SUCCESS_OVERWRITE,
498};
499
500int tep_register_event_handler(struct tep_handle *tep, int id,
501 const char *sys_name, const char *event_name,
502 tep_event_handler_func func, void *context);
503int tep_unregister_event_handler(struct tep_handle *tep, int id,
504 const char *sys_name, const char *event_name,
505 tep_event_handler_func func, void *context);
506int tep_register_print_function(struct tep_handle *tep,
507 tep_func_handler func,
508 enum tep_func_arg_type ret_type,
509 char *name, ...);
510int tep_unregister_print_function(struct tep_handle *tep,
511 tep_func_handler func, char *name);
512
513struct tep_format_field *tep_find_common_field(struct tep_event *event, const char *name);
514struct tep_format_field *tep_find_field(struct tep_event *event, const char *name);
515struct tep_format_field *tep_find_any_field(struct tep_event *event, const char *name);
516
517const char *tep_find_function(struct tep_handle *tep, unsigned long long addr);
518unsigned long long
519tep_find_function_address(struct tep_handle *tep, unsigned long long addr);
520unsigned long long tep_read_number(struct tep_handle *tep, const void *ptr, int size);
521int tep_read_number_field(struct tep_format_field *field, const void *data,
522 unsigned long long *value);
523
524struct tep_event *tep_get_first_event(struct tep_handle *tep);
525int tep_get_events_count(struct tep_handle *tep);
526struct tep_event *tep_find_event(struct tep_handle *tep, int id);
527
528struct tep_event *
529tep_find_event_by_name(struct tep_handle *tep, const char *sys, const char *name);
530struct tep_event *
531tep_find_event_by_record(struct tep_handle *tep, struct tep_record *record);
532
533int tep_data_type(struct tep_handle *tep, struct tep_record *rec);
534int tep_data_pid(struct tep_handle *tep, struct tep_record *rec);
535int tep_data_preempt_count(struct tep_handle *tep, struct tep_record *rec);
536int tep_data_flags(struct tep_handle *tep, struct tep_record *rec);
537const char *tep_data_comm_from_pid(struct tep_handle *tep, int pid);
538struct tep_cmdline;
539struct tep_cmdline *tep_data_pid_from_comm(struct tep_handle *tep, const char *comm,
540 struct tep_cmdline *next);
541int tep_cmdline_pid(struct tep_handle *tep, struct tep_cmdline *cmdline);
542
543void tep_print_field(struct trace_seq *s, void *data,
544 struct tep_format_field *field);
545void tep_print_fields(struct trace_seq *s, void *data,
546 int size __maybe_unused, struct tep_event *event);
547int tep_strerror(struct tep_handle *tep, enum tep_errno errnum,
548 char *buf, size_t buflen);
549
550struct tep_event **tep_list_events(struct tep_handle *tep, enum tep_event_sort_type);
551struct tep_event **tep_list_events_copy(struct tep_handle *tep,
552 enum tep_event_sort_type);
553struct tep_format_field **tep_event_common_fields(struct tep_event *event);
554struct tep_format_field **tep_event_fields(struct tep_event *event);
555
556enum tep_endian {
557 TEP_LITTLE_ENDIAN = 0,
558 TEP_BIG_ENDIAN
559};
560int tep_get_cpus(struct tep_handle *tep);
561void tep_set_cpus(struct tep_handle *tep, int cpus);
562int tep_get_long_size(struct tep_handle *tep);
563void tep_set_long_size(struct tep_handle *tep, int long_size);
564int tep_get_page_size(struct tep_handle *tep);
565void tep_set_page_size(struct tep_handle *tep, int _page_size);
566bool tep_is_file_bigendian(struct tep_handle *tep);
567void tep_set_file_bigendian(struct tep_handle *tep, enum tep_endian endian);
568bool tep_is_local_bigendian(struct tep_handle *tep);
569void tep_set_local_bigendian(struct tep_handle *tep, enum tep_endian endian);
570int tep_get_header_page_size(struct tep_handle *tep);
571int tep_get_header_timestamp_size(struct tep_handle *tep);
572bool tep_is_old_format(struct tep_handle *tep);
573void tep_set_test_filters(struct tep_handle *tep, int test_filters);
574
575struct tep_handle *tep_alloc(void);
576void tep_free(struct tep_handle *tep);
577void tep_ref(struct tep_handle *tep);
578void tep_unref(struct tep_handle *tep);
579int tep_get_ref(struct tep_handle *tep);
580
581/* access to the internal parser */
582void tep_buffer_init(const char *buf, unsigned long long size);
583enum tep_event_type tep_read_token(char **tok);
584void tep_free_token(char *token);
585int tep_peek_char(void);
586const char *tep_get_input_buf(void);
587unsigned long long tep_get_input_buf_ptr(void);
588
589/* for debugging */
590void tep_print_funcs(struct tep_handle *tep);
591void tep_print_printk(struct tep_handle *tep);
592
593/* ----------------------- filtering ----------------------- */
594
595enum tep_filter_boolean_type {
596 TEP_FILTER_FALSE,
597 TEP_FILTER_TRUE,
598};
599
600enum tep_filter_op_type {
601 TEP_FILTER_OP_AND = 1,
602 TEP_FILTER_OP_OR,
603 TEP_FILTER_OP_NOT,
604};
605
606enum tep_filter_cmp_type {
607 TEP_FILTER_CMP_NONE,
608 TEP_FILTER_CMP_EQ,
609 TEP_FILTER_CMP_NE,
610 TEP_FILTER_CMP_GT,
611 TEP_FILTER_CMP_LT,
612 TEP_FILTER_CMP_GE,
613 TEP_FILTER_CMP_LE,
614 TEP_FILTER_CMP_MATCH,
615 TEP_FILTER_CMP_NOT_MATCH,
616 TEP_FILTER_CMP_REGEX,
617 TEP_FILTER_CMP_NOT_REGEX,
618};
619
620enum tep_filter_exp_type {
621 TEP_FILTER_EXP_NONE,
622 TEP_FILTER_EXP_ADD,
623 TEP_FILTER_EXP_SUB,
624 TEP_FILTER_EXP_MUL,
625 TEP_FILTER_EXP_DIV,
626 TEP_FILTER_EXP_MOD,
627 TEP_FILTER_EXP_RSHIFT,
628 TEP_FILTER_EXP_LSHIFT,
629 TEP_FILTER_EXP_AND,
630 TEP_FILTER_EXP_OR,
631 TEP_FILTER_EXP_XOR,
632 TEP_FILTER_EXP_NOT,
633};
634
635enum tep_filter_arg_type {
636 TEP_FILTER_ARG_NONE,
637 TEP_FILTER_ARG_BOOLEAN,
638 TEP_FILTER_ARG_VALUE,
639 TEP_FILTER_ARG_FIELD,
640 TEP_FILTER_ARG_EXP,
641 TEP_FILTER_ARG_OP,
642 TEP_FILTER_ARG_NUM,
643 TEP_FILTER_ARG_STR,
644};
645
646enum tep_filter_value_type {
647 TEP_FILTER_NUMBER,
648 TEP_FILTER_STRING,
649 TEP_FILTER_CHAR
650};
651
652struct tep_filter_arg;
653
654struct tep_filter_arg_boolean {
655 enum tep_filter_boolean_type value;
656};
657
658struct tep_filter_arg_field {
659 struct tep_format_field *field;
660};
661
662struct tep_filter_arg_value {
663 enum tep_filter_value_type type;
664 union {
665 char *str;
666 unsigned long long val;
667 };
668};
669
670struct tep_filter_arg_op {
671 enum tep_filter_op_type type;
672 struct tep_filter_arg *left;
673 struct tep_filter_arg *right;
674};
675
676struct tep_filter_arg_exp {
677 enum tep_filter_exp_type type;
678 struct tep_filter_arg *left;
679 struct tep_filter_arg *right;
680};
681
682struct tep_filter_arg_num {
683 enum tep_filter_cmp_type type;
684 struct tep_filter_arg *left;
685 struct tep_filter_arg *right;
686};
687
688struct tep_filter_arg_str {
689 enum tep_filter_cmp_type type;
690 struct tep_format_field *field;
691 char *val;
692 char *buffer;
693 regex_t reg;
694};
695
696struct tep_filter_arg {
697 enum tep_filter_arg_type type;
698 union {
699 struct tep_filter_arg_boolean boolean;
700 struct tep_filter_arg_field field;
701 struct tep_filter_arg_value value;
702 struct tep_filter_arg_op op;
703 struct tep_filter_arg_exp exp;
704 struct tep_filter_arg_num num;
705 struct tep_filter_arg_str str;
706 };
707};
708
709struct tep_filter_type {
710 int event_id;
711 struct tep_event *event;
712 struct tep_filter_arg *filter;
713};
714
715#define TEP_FILTER_ERROR_BUFSZ 1024
716
717struct tep_event_filter {
718 struct tep_handle *tep;
719 int filters;
720 struct tep_filter_type *event_filters;
721 char error_buffer[TEP_FILTER_ERROR_BUFSZ];
722};
723
724struct tep_event_filter *tep_filter_alloc(struct tep_handle *tep);
725
726/* for backward compatibility */
727#define FILTER_NONE TEP_ERRNO__NO_FILTER
728#define FILTER_NOEXIST TEP_ERRNO__FILTER_NOT_FOUND
729#define FILTER_MISS TEP_ERRNO__FILTER_MISS
730#define FILTER_MATCH TEP_ERRNO__FILTER_MATCH
731
732enum tep_errno tep_filter_add_filter_str(struct tep_event_filter *filter,
733 const char *filter_str);
734
735enum tep_errno tep_filter_match(struct tep_event_filter *filter,
736 struct tep_record *record);
737
738int tep_filter_strerror(struct tep_event_filter *filter, enum tep_errno err,
739 char *buf, size_t buflen);
740
741int tep_event_filtered(struct tep_event_filter *filter,
742 int event_id);
743
744void tep_filter_reset(struct tep_event_filter *filter);
745
746void tep_filter_free(struct tep_event_filter *filter);
747
748char *tep_filter_make_string(struct tep_event_filter *filter, int event_id);
749
750int tep_filter_remove_event(struct tep_event_filter *filter,
751 int event_id);
752
753int tep_filter_copy(struct tep_event_filter *dest, struct tep_event_filter *source);
754
755int tep_filter_compare(struct tep_event_filter *filter1, struct tep_event_filter *filter2);
756
757#endif /* _PARSE_EVENTS_H */
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, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 */
21#ifndef _PARSE_EVENTS_H
22#define _PARSE_EVENTS_H
23
24#include <stdarg.h>
25#include <regex.h>
26
27#ifndef __unused
28#define __unused __attribute__ ((unused))
29#endif
30
31/* ----------------------- trace_seq ----------------------- */
32
33
34#ifndef TRACE_SEQ_BUF_SIZE
35#define TRACE_SEQ_BUF_SIZE 4096
36#endif
37
38#ifndef DEBUG_RECORD
39#define DEBUG_RECORD 0
40#endif
41
42struct pevent_record {
43 unsigned long long ts;
44 unsigned long long offset;
45 long long missed_events; /* buffer dropped events before */
46 int record_size; /* size of binary record */
47 int size; /* size of data */
48 void *data;
49 int cpu;
50 int ref_count;
51 int locked; /* Do not free, even if ref_count is zero */
52 void *private;
53#if DEBUG_RECORD
54 struct pevent_record *prev;
55 struct pevent_record *next;
56 long alloc_addr;
57#endif
58};
59
60/*
61 * Trace sequences are used to allow a function to call several other functions
62 * to create a string of data to use (up to a max of PAGE_SIZE).
63 */
64
65struct trace_seq {
66 char *buffer;
67 unsigned int buffer_size;
68 unsigned int len;
69 unsigned int readpos;
70};
71
72void trace_seq_init(struct trace_seq *s);
73void trace_seq_destroy(struct trace_seq *s);
74
75extern int trace_seq_printf(struct trace_seq *s, const char *fmt, ...)
76 __attribute__ ((format (printf, 2, 3)));
77extern int trace_seq_vprintf(struct trace_seq *s, const char *fmt, va_list args)
78 __attribute__ ((format (printf, 2, 0)));
79
80extern int trace_seq_puts(struct trace_seq *s, const char *str);
81extern int trace_seq_putc(struct trace_seq *s, unsigned char c);
82
83extern void trace_seq_terminate(struct trace_seq *s);
84
85extern int trace_seq_do_printf(struct trace_seq *s);
86
87
88/* ----------------------- pevent ----------------------- */
89
90struct pevent;
91struct event_format;
92
93typedef int (*pevent_event_handler_func)(struct trace_seq *s,
94 struct pevent_record *record,
95 struct event_format *event,
96 void *context);
97
98typedef int (*pevent_plugin_load_func)(struct pevent *pevent);
99typedef int (*pevent_plugin_unload_func)(void);
100
101struct plugin_option {
102 struct plugin_option *next;
103 void *handle;
104 char *file;
105 char *name;
106 char *plugin_alias;
107 char *description;
108 char *value;
109 void *private;
110 int set;
111};
112
113/*
114 * Plugin hooks that can be called:
115 *
116 * PEVENT_PLUGIN_LOADER: (required)
117 * The function name to initialized the plugin.
118 *
119 * int PEVENT_PLUGIN_LOADER(struct pevent *pevent)
120 *
121 * PEVENT_PLUGIN_UNLOADER: (optional)
122 * The function called just before unloading
123 *
124 * int PEVENT_PLUGIN_UNLOADER(void)
125 *
126 * PEVENT_PLUGIN_OPTIONS: (optional)
127 * Plugin options that can be set before loading
128 *
129 * struct plugin_option PEVENT_PLUGIN_OPTIONS[] = {
130 * {
131 * .name = "option-name",
132 * .plugin_alias = "overide-file-name", (optional)
133 * .description = "description of option to show users",
134 * },
135 * {
136 * .name = NULL,
137 * },
138 * };
139 *
140 * Array must end with .name = NULL;
141 *
142 *
143 * .plugin_alias is used to give a shorter name to access
144 * the vairable. Useful if a plugin handles more than one event.
145 *
146 * PEVENT_PLUGIN_ALIAS: (optional)
147 * The name to use for finding options (uses filename if not defined)
148 */
149#define PEVENT_PLUGIN_LOADER pevent_plugin_loader
150#define PEVENT_PLUGIN_UNLOADER pevent_plugin_unloader
151#define PEVENT_PLUGIN_OPTIONS pevent_plugin_options
152#define PEVENT_PLUGIN_ALIAS pevent_plugin_alias
153#define _MAKE_STR(x) #x
154#define MAKE_STR(x) _MAKE_STR(x)
155#define PEVENT_PLUGIN_LOADER_NAME MAKE_STR(PEVENT_PLUGIN_LOADER)
156#define PEVENT_PLUGIN_UNLOADER_NAME MAKE_STR(PEVENT_PLUGIN_UNLOADER)
157#define PEVENT_PLUGIN_OPTIONS_NAME MAKE_STR(PEVENT_PLUGIN_OPTIONS)
158#define PEVENT_PLUGIN_ALIAS_NAME MAKE_STR(PEVENT_PLUGIN_ALIAS)
159
160#define NSECS_PER_SEC 1000000000ULL
161#define NSECS_PER_USEC 1000ULL
162
163enum format_flags {
164 FIELD_IS_ARRAY = 1,
165 FIELD_IS_POINTER = 2,
166 FIELD_IS_SIGNED = 4,
167 FIELD_IS_STRING = 8,
168 FIELD_IS_DYNAMIC = 16,
169 FIELD_IS_LONG = 32,
170 FIELD_IS_FLAG = 64,
171 FIELD_IS_SYMBOLIC = 128,
172};
173
174struct format_field {
175 struct format_field *next;
176 struct event_format *event;
177 char *type;
178 char *name;
179 int offset;
180 int size;
181 unsigned int arraylen;
182 unsigned int elementsize;
183 unsigned long flags;
184};
185
186struct format {
187 int nr_common;
188 int nr_fields;
189 struct format_field *common_fields;
190 struct format_field *fields;
191};
192
193struct print_arg_atom {
194 char *atom;
195};
196
197struct print_arg_string {
198 char *string;
199 int offset;
200};
201
202struct print_arg_field {
203 char *name;
204 struct format_field *field;
205};
206
207struct print_flag_sym {
208 struct print_flag_sym *next;
209 char *value;
210 char *str;
211};
212
213struct print_arg_typecast {
214 char *type;
215 struct print_arg *item;
216};
217
218struct print_arg_flags {
219 struct print_arg *field;
220 char *delim;
221 struct print_flag_sym *flags;
222};
223
224struct print_arg_symbol {
225 struct print_arg *field;
226 struct print_flag_sym *symbols;
227};
228
229struct print_arg_dynarray {
230 struct format_field *field;
231 struct print_arg *index;
232};
233
234struct print_arg;
235
236struct print_arg_op {
237 char *op;
238 int prio;
239 struct print_arg *left;
240 struct print_arg *right;
241};
242
243struct pevent_function_handler;
244
245struct print_arg_func {
246 struct pevent_function_handler *func;
247 struct print_arg *args;
248};
249
250enum print_arg_type {
251 PRINT_NULL,
252 PRINT_ATOM,
253 PRINT_FIELD,
254 PRINT_FLAGS,
255 PRINT_SYMBOL,
256 PRINT_TYPE,
257 PRINT_STRING,
258 PRINT_BSTRING,
259 PRINT_DYNAMIC_ARRAY,
260 PRINT_OP,
261 PRINT_FUNC,
262};
263
264struct print_arg {
265 struct print_arg *next;
266 enum print_arg_type type;
267 union {
268 struct print_arg_atom atom;
269 struct print_arg_field field;
270 struct print_arg_typecast typecast;
271 struct print_arg_flags flags;
272 struct print_arg_symbol symbol;
273 struct print_arg_func func;
274 struct print_arg_string string;
275 struct print_arg_op op;
276 struct print_arg_dynarray dynarray;
277 };
278};
279
280struct print_fmt {
281 char *format;
282 struct print_arg *args;
283};
284
285struct event_format {
286 struct pevent *pevent;
287 char *name;
288 int id;
289 int flags;
290 struct format format;
291 struct print_fmt print_fmt;
292 char *system;
293 pevent_event_handler_func handler;
294 void *context;
295};
296
297enum {
298 EVENT_FL_ISFTRACE = 0x01,
299 EVENT_FL_ISPRINT = 0x02,
300 EVENT_FL_ISBPRINT = 0x04,
301 EVENT_FL_ISFUNCENT = 0x10,
302 EVENT_FL_ISFUNCRET = 0x20,
303
304 EVENT_FL_FAILED = 0x80000000
305};
306
307enum event_sort_type {
308 EVENT_SORT_ID,
309 EVENT_SORT_NAME,
310 EVENT_SORT_SYSTEM,
311};
312
313enum event_type {
314 EVENT_ERROR,
315 EVENT_NONE,
316 EVENT_SPACE,
317 EVENT_NEWLINE,
318 EVENT_OP,
319 EVENT_DELIM,
320 EVENT_ITEM,
321 EVENT_DQUOTE,
322 EVENT_SQUOTE,
323};
324
325typedef unsigned long long (*pevent_func_handler)(struct trace_seq *s,
326 unsigned long long *args);
327
328enum pevent_func_arg_type {
329 PEVENT_FUNC_ARG_VOID,
330 PEVENT_FUNC_ARG_INT,
331 PEVENT_FUNC_ARG_LONG,
332 PEVENT_FUNC_ARG_STRING,
333 PEVENT_FUNC_ARG_PTR,
334 PEVENT_FUNC_ARG_MAX_TYPES
335};
336
337enum pevent_flag {
338 PEVENT_NSEC_OUTPUT = 1, /* output in NSECS */
339};
340
341struct cmdline;
342struct cmdline_list;
343struct func_map;
344struct func_list;
345struct event_handler;
346
347struct pevent {
348 int ref_count;
349
350 int header_page_ts_offset;
351 int header_page_ts_size;
352 int header_page_size_offset;
353 int header_page_size_size;
354 int header_page_data_offset;
355 int header_page_data_size;
356 int header_page_overwrite;
357
358 int file_bigendian;
359 int host_bigendian;
360
361 int latency_format;
362
363 int old_format;
364
365 int cpus;
366 int long_size;
367
368 struct cmdline *cmdlines;
369 struct cmdline_list *cmdlist;
370 int cmdline_count;
371
372 struct func_map *func_map;
373 struct func_list *funclist;
374 unsigned int func_count;
375
376 struct printk_map *printk_map;
377 struct printk_list *printklist;
378 unsigned int printk_count;
379
380
381 struct event_format **events;
382 int nr_events;
383 struct event_format **sort_events;
384 enum event_sort_type last_type;
385
386 int type_offset;
387 int type_size;
388
389 int pid_offset;
390 int pid_size;
391
392 int pc_offset;
393 int pc_size;
394
395 int flags_offset;
396 int flags_size;
397
398 int ld_offset;
399 int ld_size;
400
401 int print_raw;
402
403 int test_filters;
404
405 int flags;
406
407 struct format_field *bprint_ip_field;
408 struct format_field *bprint_fmt_field;
409 struct format_field *bprint_buf_field;
410
411 struct event_handler *handlers;
412 struct pevent_function_handler *func_handlers;
413
414 /* cache */
415 struct event_format *last_event;
416};
417
418static inline void pevent_set_flag(struct pevent *pevent, int flag)
419{
420 pevent->flags |= flag;
421}
422
423static inline unsigned short
424__data2host2(struct pevent *pevent, unsigned short data)
425{
426 unsigned short swap;
427
428 if (pevent->host_bigendian == pevent->file_bigendian)
429 return data;
430
431 swap = ((data & 0xffULL) << 8) |
432 ((data & (0xffULL << 8)) >> 8);
433
434 return swap;
435}
436
437static inline unsigned int
438__data2host4(struct pevent *pevent, unsigned int data)
439{
440 unsigned int swap;
441
442 if (pevent->host_bigendian == pevent->file_bigendian)
443 return data;
444
445 swap = ((data & 0xffULL) << 24) |
446 ((data & (0xffULL << 8)) << 8) |
447 ((data & (0xffULL << 16)) >> 8) |
448 ((data & (0xffULL << 24)) >> 24);
449
450 return swap;
451}
452
453static inline unsigned long long
454__data2host8(struct pevent *pevent, unsigned long long data)
455{
456 unsigned long long swap;
457
458 if (pevent->host_bigendian == pevent->file_bigendian)
459 return data;
460
461 swap = ((data & 0xffULL) << 56) |
462 ((data & (0xffULL << 8)) << 40) |
463 ((data & (0xffULL << 16)) << 24) |
464 ((data & (0xffULL << 24)) << 8) |
465 ((data & (0xffULL << 32)) >> 8) |
466 ((data & (0xffULL << 40)) >> 24) |
467 ((data & (0xffULL << 48)) >> 40) |
468 ((data & (0xffULL << 56)) >> 56);
469
470 return swap;
471}
472
473#define data2host2(pevent, ptr) __data2host2(pevent, *(unsigned short *)(ptr))
474#define data2host4(pevent, ptr) __data2host4(pevent, *(unsigned int *)(ptr))
475#define data2host8(pevent, ptr) \
476({ \
477 unsigned long long __val; \
478 \
479 memcpy(&__val, (ptr), sizeof(unsigned long long)); \
480 __data2host8(pevent, __val); \
481})
482
483/* taken from kernel/trace/trace.h */
484enum trace_flag_type {
485 TRACE_FLAG_IRQS_OFF = 0x01,
486 TRACE_FLAG_IRQS_NOSUPPORT = 0x02,
487 TRACE_FLAG_NEED_RESCHED = 0x04,
488 TRACE_FLAG_HARDIRQ = 0x08,
489 TRACE_FLAG_SOFTIRQ = 0x10,
490};
491
492int pevent_register_comm(struct pevent *pevent, const char *comm, int pid);
493int pevent_register_function(struct pevent *pevent, char *name,
494 unsigned long long addr, char *mod);
495int pevent_register_print_string(struct pevent *pevent, char *fmt,
496 unsigned long long addr);
497int pevent_pid_is_registered(struct pevent *pevent, int pid);
498
499void pevent_print_event(struct pevent *pevent, struct trace_seq *s,
500 struct pevent_record *record);
501
502int pevent_parse_header_page(struct pevent *pevent, char *buf, unsigned long size,
503 int long_size);
504
505int pevent_parse_event(struct pevent *pevent, const char *buf,
506 unsigned long size, const char *sys);
507
508void *pevent_get_field_raw(struct trace_seq *s, struct event_format *event,
509 const char *name, struct pevent_record *record,
510 int *len, int err);
511
512int pevent_get_field_val(struct trace_seq *s, struct event_format *event,
513 const char *name, struct pevent_record *record,
514 unsigned long long *val, int err);
515int pevent_get_common_field_val(struct trace_seq *s, struct event_format *event,
516 const char *name, struct pevent_record *record,
517 unsigned long long *val, int err);
518int pevent_get_any_field_val(struct trace_seq *s, struct event_format *event,
519 const char *name, struct pevent_record *record,
520 unsigned long long *val, int err);
521
522int pevent_print_num_field(struct trace_seq *s, const char *fmt,
523 struct event_format *event, const char *name,
524 struct pevent_record *record, int err);
525
526int pevent_register_event_handler(struct pevent *pevent, int id, char *sys_name, char *event_name,
527 pevent_event_handler_func func, void *context);
528int pevent_register_print_function(struct pevent *pevent,
529 pevent_func_handler func,
530 enum pevent_func_arg_type ret_type,
531 char *name, ...);
532
533struct format_field *pevent_find_common_field(struct event_format *event, const char *name);
534struct format_field *pevent_find_field(struct event_format *event, const char *name);
535struct format_field *pevent_find_any_field(struct event_format *event, const char *name);
536
537const char *pevent_find_function(struct pevent *pevent, unsigned long long addr);
538unsigned long long
539pevent_find_function_address(struct pevent *pevent, unsigned long long addr);
540unsigned long long pevent_read_number(struct pevent *pevent, const void *ptr, int size);
541int pevent_read_number_field(struct format_field *field, const void *data,
542 unsigned long long *value);
543
544struct event_format *pevent_find_event(struct pevent *pevent, int id);
545
546struct event_format *
547pevent_find_event_by_name(struct pevent *pevent, const char *sys, const char *name);
548
549void pevent_data_lat_fmt(struct pevent *pevent,
550 struct trace_seq *s, struct pevent_record *record);
551int pevent_data_type(struct pevent *pevent, struct pevent_record *rec);
552struct event_format *pevent_data_event_from_type(struct pevent *pevent, int type);
553int pevent_data_pid(struct pevent *pevent, struct pevent_record *rec);
554const char *pevent_data_comm_from_pid(struct pevent *pevent, int pid);
555void pevent_event_info(struct trace_seq *s, struct event_format *event,
556 struct pevent_record *record);
557
558struct event_format **pevent_list_events(struct pevent *pevent, enum event_sort_type);
559struct format_field **pevent_event_common_fields(struct event_format *event);
560struct format_field **pevent_event_fields(struct event_format *event);
561
562static inline int pevent_get_cpus(struct pevent *pevent)
563{
564 return pevent->cpus;
565}
566
567static inline void pevent_set_cpus(struct pevent *pevent, int cpus)
568{
569 pevent->cpus = cpus;
570}
571
572static inline int pevent_get_long_size(struct pevent *pevent)
573{
574 return pevent->long_size;
575}
576
577static inline void pevent_set_long_size(struct pevent *pevent, int long_size)
578{
579 pevent->long_size = long_size;
580}
581
582static inline int pevent_is_file_bigendian(struct pevent *pevent)
583{
584 return pevent->file_bigendian;
585}
586
587static inline void pevent_set_file_bigendian(struct pevent *pevent, int endian)
588{
589 pevent->file_bigendian = endian;
590}
591
592static inline int pevent_is_host_bigendian(struct pevent *pevent)
593{
594 return pevent->host_bigendian;
595}
596
597static inline void pevent_set_host_bigendian(struct pevent *pevent, int endian)
598{
599 pevent->host_bigendian = endian;
600}
601
602static inline int pevent_is_latency_format(struct pevent *pevent)
603{
604 return pevent->latency_format;
605}
606
607static inline void pevent_set_latency_format(struct pevent *pevent, int lat)
608{
609 pevent->latency_format = lat;
610}
611
612struct pevent *pevent_alloc(void);
613void pevent_free(struct pevent *pevent);
614void pevent_ref(struct pevent *pevent);
615void pevent_unref(struct pevent *pevent);
616
617/* access to the internal parser */
618void pevent_buffer_init(const char *buf, unsigned long long size);
619enum event_type pevent_read_token(char **tok);
620void pevent_free_token(char *token);
621int pevent_peek_char(void);
622const char *pevent_get_input_buf(void);
623unsigned long long pevent_get_input_buf_ptr(void);
624
625/* for debugging */
626void pevent_print_funcs(struct pevent *pevent);
627void pevent_print_printk(struct pevent *pevent);
628
629/* ----------------------- filtering ----------------------- */
630
631enum filter_boolean_type {
632 FILTER_FALSE,
633 FILTER_TRUE,
634};
635
636enum filter_op_type {
637 FILTER_OP_AND = 1,
638 FILTER_OP_OR,
639 FILTER_OP_NOT,
640};
641
642enum filter_cmp_type {
643 FILTER_CMP_NONE,
644 FILTER_CMP_EQ,
645 FILTER_CMP_NE,
646 FILTER_CMP_GT,
647 FILTER_CMP_LT,
648 FILTER_CMP_GE,
649 FILTER_CMP_LE,
650 FILTER_CMP_MATCH,
651 FILTER_CMP_NOT_MATCH,
652 FILTER_CMP_REGEX,
653 FILTER_CMP_NOT_REGEX,
654};
655
656enum filter_exp_type {
657 FILTER_EXP_NONE,
658 FILTER_EXP_ADD,
659 FILTER_EXP_SUB,
660 FILTER_EXP_MUL,
661 FILTER_EXP_DIV,
662 FILTER_EXP_MOD,
663 FILTER_EXP_RSHIFT,
664 FILTER_EXP_LSHIFT,
665 FILTER_EXP_AND,
666 FILTER_EXP_OR,
667 FILTER_EXP_XOR,
668 FILTER_EXP_NOT,
669};
670
671enum filter_arg_type {
672 FILTER_ARG_NONE,
673 FILTER_ARG_BOOLEAN,
674 FILTER_ARG_VALUE,
675 FILTER_ARG_FIELD,
676 FILTER_ARG_EXP,
677 FILTER_ARG_OP,
678 FILTER_ARG_NUM,
679 FILTER_ARG_STR,
680};
681
682enum filter_value_type {
683 FILTER_NUMBER,
684 FILTER_STRING,
685 FILTER_CHAR
686};
687
688struct fliter_arg;
689
690struct filter_arg_boolean {
691 enum filter_boolean_type value;
692};
693
694struct filter_arg_field {
695 struct format_field *field;
696};
697
698struct filter_arg_value {
699 enum filter_value_type type;
700 union {
701 char *str;
702 unsigned long long val;
703 };
704};
705
706struct filter_arg_op {
707 enum filter_op_type type;
708 struct filter_arg *left;
709 struct filter_arg *right;
710};
711
712struct filter_arg_exp {
713 enum filter_exp_type type;
714 struct filter_arg *left;
715 struct filter_arg *right;
716};
717
718struct filter_arg_num {
719 enum filter_cmp_type type;
720 struct filter_arg *left;
721 struct filter_arg *right;
722};
723
724struct filter_arg_str {
725 enum filter_cmp_type type;
726 struct format_field *field;
727 char *val;
728 char *buffer;
729 regex_t reg;
730};
731
732struct filter_arg {
733 enum filter_arg_type type;
734 union {
735 struct filter_arg_boolean boolean;
736 struct filter_arg_field field;
737 struct filter_arg_value value;
738 struct filter_arg_op op;
739 struct filter_arg_exp exp;
740 struct filter_arg_num num;
741 struct filter_arg_str str;
742 };
743};
744
745struct filter_type {
746 int event_id;
747 struct event_format *event;
748 struct filter_arg *filter;
749};
750
751struct event_filter {
752 struct pevent *pevent;
753 int filters;
754 struct filter_type *event_filters;
755};
756
757struct event_filter *pevent_filter_alloc(struct pevent *pevent);
758
759#define FILTER_NONE -2
760#define FILTER_NOEXIST -1
761#define FILTER_MISS 0
762#define FILTER_MATCH 1
763
764enum filter_trivial_type {
765 FILTER_TRIVIAL_FALSE,
766 FILTER_TRIVIAL_TRUE,
767 FILTER_TRIVIAL_BOTH,
768};
769
770int pevent_filter_add_filter_str(struct event_filter *filter,
771 const char *filter_str,
772 char **error_str);
773
774
775int pevent_filter_match(struct event_filter *filter,
776 struct pevent_record *record);
777
778int pevent_event_filtered(struct event_filter *filter,
779 int event_id);
780
781void pevent_filter_reset(struct event_filter *filter);
782
783void pevent_filter_clear_trivial(struct event_filter *filter,
784 enum filter_trivial_type type);
785
786void pevent_filter_free(struct event_filter *filter);
787
788char *pevent_filter_make_string(struct event_filter *filter, int event_id);
789
790int pevent_filter_remove_event(struct event_filter *filter,
791 int event_id);
792
793int pevent_filter_event_has_trivial(struct event_filter *filter,
794 int event_id,
795 enum filter_trivial_type type);
796
797int pevent_filter_copy(struct event_filter *dest, struct event_filter *source);
798
799int pevent_update_trivial(struct event_filter *dest, struct event_filter *source,
800 enum filter_trivial_type type);
801
802int pevent_filter_compare(struct event_filter *filter1, struct event_filter *filter2);
803
804#endif /* _PARSE_EVENTS_H */