2 * Copyright (C) 2009, 2010 Red Hat Inc, Steven Rostedt <srostedt@redhat.com>
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!)
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.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this program; if not, see <http://www.gnu.org/licenses>
18 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 #ifndef _PARSE_EVENTS_H
21 #define _PARSE_EVENTS_H
29 #include "trace-seq.h"
31 #ifndef __maybe_unused
32 #define __maybe_unused __attribute__((unused))
36 #define DEBUG_RECORD 0
40 unsigned long long ts;
41 unsigned long long offset;
42 long long missed_events; /* buffer dropped events before */
43 int record_size; /* size of binary record */
44 int size; /* size of data */
48 int locked; /* Do not free, even if ref_count is zero */
51 struct tep_record *prev;
52 struct tep_record *next;
57 /* ----------------------- tep ----------------------- */
62 typedef int (*tep_event_handler_func)(struct trace_seq *s,
63 struct tep_record *record,
64 struct tep_event *event,
67 typedef int (*tep_plugin_load_func)(struct tep_handle *tep);
68 typedef int (*tep_plugin_unload_func)(struct tep_handle *tep);
70 struct tep_plugin_option {
71 struct tep_plugin_option *next;
83 * Plugin hooks that can be called:
85 * TEP_PLUGIN_LOADER: (required)
86 * The function name to initialized the plugin.
88 * int TEP_PLUGIN_LOADER(struct tep_handle *tep)
90 * TEP_PLUGIN_UNLOADER: (optional)
91 * The function called just before unloading
93 * int TEP_PLUGIN_UNLOADER(struct tep_handle *tep)
95 * TEP_PLUGIN_OPTIONS: (optional)
96 * Plugin options that can be set before loading
98 * struct tep_plugin_option TEP_PLUGIN_OPTIONS[] = {
100 * .name = "option-name",
101 * .plugin_alias = "override-file-name", (optional)
102 * .description = "description of option to show users",
109 * Array must end with .name = NULL;
112 * .plugin_alias is used to give a shorter name to access
113 * the vairable. Useful if a plugin handles more than one event.
115 * If .value is not set, then it is considered a boolean and only
116 * .set will be processed. If .value is defined, then it is considered
117 * a string option and .set will be ignored.
119 * TEP_PLUGIN_ALIAS: (optional)
120 * The name to use for finding options (uses filename if not defined)
122 #define TEP_PLUGIN_LOADER tep_plugin_loader
123 #define TEP_PLUGIN_UNLOADER tep_plugin_unloader
124 #define TEP_PLUGIN_OPTIONS tep_plugin_options
125 #define TEP_PLUGIN_ALIAS tep_plugin_alias
126 #define _MAKE_STR(x) #x
127 #define MAKE_STR(x) _MAKE_STR(x)
128 #define TEP_PLUGIN_LOADER_NAME MAKE_STR(TEP_PLUGIN_LOADER)
129 #define TEP_PLUGIN_UNLOADER_NAME MAKE_STR(TEP_PLUGIN_UNLOADER)
130 #define TEP_PLUGIN_OPTIONS_NAME MAKE_STR(TEP_PLUGIN_OPTIONS)
131 #define TEP_PLUGIN_ALIAS_NAME MAKE_STR(TEP_PLUGIN_ALIAS)
133 enum tep_format_flags {
134 TEP_FIELD_IS_ARRAY = 1,
135 TEP_FIELD_IS_POINTER = 2,
136 TEP_FIELD_IS_SIGNED = 4,
137 TEP_FIELD_IS_STRING = 8,
138 TEP_FIELD_IS_DYNAMIC = 16,
139 TEP_FIELD_IS_LONG = 32,
140 TEP_FIELD_IS_FLAG = 64,
141 TEP_FIELD_IS_SYMBOLIC = 128,
144 struct tep_format_field {
145 struct tep_format_field *next;
146 struct tep_event *event;
152 unsigned int arraylen;
153 unsigned int elementsize;
160 struct tep_format_field *common_fields;
161 struct tep_format_field *fields;
164 struct tep_print_arg_atom {
168 struct tep_print_arg_string {
173 struct tep_print_arg_bitmask {
178 struct tep_print_arg_field {
180 struct tep_format_field *field;
183 struct tep_print_flag_sym {
184 struct tep_print_flag_sym *next;
189 struct tep_print_arg_typecast {
191 struct tep_print_arg *item;
194 struct tep_print_arg_flags {
195 struct tep_print_arg *field;
197 struct tep_print_flag_sym *flags;
200 struct tep_print_arg_symbol {
201 struct tep_print_arg *field;
202 struct tep_print_flag_sym *symbols;
205 struct tep_print_arg_hex {
206 struct tep_print_arg *field;
207 struct tep_print_arg *size;
210 struct tep_print_arg_int_array {
211 struct tep_print_arg *field;
212 struct tep_print_arg *count;
213 struct tep_print_arg *el_size;
216 struct tep_print_arg_dynarray {
217 struct tep_format_field *field;
218 struct tep_print_arg *index;
221 struct tep_print_arg;
223 struct tep_print_arg_op {
226 struct tep_print_arg *left;
227 struct tep_print_arg *right;
230 struct tep_function_handler;
232 struct tep_print_arg_func {
233 struct tep_function_handler *func;
234 struct tep_print_arg *args;
237 enum tep_print_arg_type {
248 TEP_PRINT_DYNAMIC_ARRAY,
252 TEP_PRINT_DYNAMIC_ARRAY_LEN,
256 struct tep_print_arg {
257 struct tep_print_arg *next;
258 enum tep_print_arg_type type;
260 struct tep_print_arg_atom atom;
261 struct tep_print_arg_field field;
262 struct tep_print_arg_typecast typecast;
263 struct tep_print_arg_flags flags;
264 struct tep_print_arg_symbol symbol;
265 struct tep_print_arg_hex hex;
266 struct tep_print_arg_int_array int_array;
267 struct tep_print_arg_func func;
268 struct tep_print_arg_string string;
269 struct tep_print_arg_bitmask bitmask;
270 struct tep_print_arg_op op;
271 struct tep_print_arg_dynarray dynarray;
275 struct tep_print_fmt {
277 struct tep_print_arg *args;
281 struct tep_handle *tep;
285 struct tep_format format;
286 struct tep_print_fmt print_fmt;
288 tep_event_handler_func handler;
293 TEP_EVENT_FL_ISFTRACE = 0x01,
294 TEP_EVENT_FL_ISPRINT = 0x02,
295 TEP_EVENT_FL_ISBPRINT = 0x04,
296 TEP_EVENT_FL_ISFUNCENT = 0x10,
297 TEP_EVENT_FL_ISFUNCRET = 0x20,
298 TEP_EVENT_FL_NOHANDLE = 0x40,
299 TEP_EVENT_FL_PRINTRAW = 0x80,
301 TEP_EVENT_FL_FAILED = 0x80000000
304 enum tep_event_sort_type {
307 TEP_EVENT_SORT_SYSTEM,
310 enum tep_event_type {
322 typedef unsigned long long (*tep_func_handler)(struct trace_seq *s,
323 unsigned long long *args);
325 enum tep_func_arg_type {
331 TEP_FUNC_ARG_MAX_TYPES
335 TEP_NSEC_OUTPUT = 1, /* output in NSECS */
336 TEP_DISABLE_SYS_PLUGINS = 1 << 1,
337 TEP_DISABLE_PLUGINS = 1 << 2,
341 _PE(MEM_ALLOC_FAILED, "failed to allocate memory"), \
342 _PE(PARSE_EVENT_FAILED, "failed to parse event"), \
343 _PE(READ_ID_FAILED, "failed to read event id"), \
344 _PE(READ_FORMAT_FAILED, "failed to read event format"), \
345 _PE(READ_PRINT_FAILED, "failed to read event print fmt"), \
346 _PE(OLD_FTRACE_ARG_FAILED,"failed to allocate field name for ftrace"),\
347 _PE(INVALID_ARG_TYPE, "invalid argument type"), \
348 _PE(INVALID_EXP_TYPE, "invalid expression type"), \
349 _PE(INVALID_OP_TYPE, "invalid operator type"), \
350 _PE(INVALID_EVENT_NAME, "invalid event name"), \
351 _PE(EVENT_NOT_FOUND, "no event found"), \
352 _PE(SYNTAX_ERROR, "syntax error"), \
353 _PE(ILLEGAL_RVALUE, "illegal rvalue"), \
354 _PE(ILLEGAL_LVALUE, "illegal lvalue for string comparison"), \
355 _PE(INVALID_REGEX, "regex did not compute"), \
356 _PE(ILLEGAL_STRING_CMP, "illegal comparison for string"), \
357 _PE(ILLEGAL_INTEGER_CMP,"illegal comparison for integer"), \
358 _PE(REPARENT_NOT_OP, "cannot reparent other than OP"), \
359 _PE(REPARENT_FAILED, "failed to reparent filter OP"), \
360 _PE(BAD_FILTER_ARG, "bad arg in filter tree"), \
361 _PE(UNEXPECTED_TYPE, "unexpected type (not a value)"), \
362 _PE(ILLEGAL_TOKEN, "illegal token"), \
363 _PE(INVALID_PAREN, "open parenthesis cannot come here"), \
364 _PE(UNBALANCED_PAREN, "unbalanced number of parenthesis"), \
365 _PE(UNKNOWN_TOKEN, "unknown token"), \
366 _PE(FILTER_NOT_FOUND, "no filter found"), \
367 _PE(NOT_A_NUMBER, "must have number field"), \
368 _PE(NO_FILTER, "no filters exists"), \
369 _PE(FILTER_MISS, "record does not match to filter")
372 #define _PE(__code, __str) TEP_ERRNO__ ## __code
374 TEP_ERRNO__SUCCESS = 0,
375 TEP_ERRNO__FILTER_MATCH = TEP_ERRNO__SUCCESS,
378 * Choose an arbitrary negative big number not to clash with standard
379 * errno since SUS requires the errno has distinct positive values.
380 * See 'Issue 6' in the link below.
382 * https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
384 __TEP_ERRNO__START = -100000,
392 struct tep_plugin_list;
394 #define INVALID_PLUGIN_LIST_OPTION ((char **)((unsigned long)-1))
396 struct tep_plugin_list *tep_load_plugins(struct tep_handle *tep);
397 void tep_unload_plugins(struct tep_plugin_list *plugin_list,
398 struct tep_handle *tep);
399 char **tep_plugin_list_options(void);
400 void tep_plugin_free_options_list(char **list);
401 int tep_plugin_add_options(const char *name,
402 struct tep_plugin_option *options);
403 void tep_plugin_remove_options(struct tep_plugin_option *options);
404 void tep_print_plugins(struct trace_seq *s,
405 const char *prefix, const char *suffix,
406 const struct tep_plugin_list *list);
409 typedef char *(tep_func_resolver_t)(void *priv,
410 unsigned long long *addrp, char **modp);
411 void tep_set_flag(struct tep_handle *tep, int flag);
412 void tep_clear_flag(struct tep_handle *tep, enum tep_flag flag);
413 bool tep_test_flag(struct tep_handle *tep, enum tep_flag flags);
415 static inline int tep_is_bigendian(void)
417 unsigned char str[] = { 0x1, 0x2, 0x3, 0x4 };
420 memcpy(&val, str, 4);
421 return val == 0x01020304;
424 /* taken from kernel/trace/trace.h */
425 enum trace_flag_type {
426 TRACE_FLAG_IRQS_OFF = 0x01,
427 TRACE_FLAG_IRQS_NOSUPPORT = 0x02,
428 TRACE_FLAG_NEED_RESCHED = 0x04,
429 TRACE_FLAG_HARDIRQ = 0x08,
430 TRACE_FLAG_SOFTIRQ = 0x10,
433 int tep_set_function_resolver(struct tep_handle *tep,
434 tep_func_resolver_t *func, void *priv);
435 void tep_reset_function_resolver(struct tep_handle *tep);
436 int tep_register_comm(struct tep_handle *tep, const char *comm, int pid);
437 int tep_override_comm(struct tep_handle *tep, const char *comm, int pid);
438 int tep_register_function(struct tep_handle *tep, char *name,
439 unsigned long long addr, char *mod);
440 int tep_register_print_string(struct tep_handle *tep, const char *fmt,
441 unsigned long long addr);
442 bool tep_is_pid_registered(struct tep_handle *tep, int pid);
444 struct tep_event *tep_get_event(struct tep_handle *tep, int index);
446 #define TEP_PRINT_INFO "INFO"
447 #define TEP_PRINT_INFO_RAW "INFO_RAW"
448 #define TEP_PRINT_COMM "COMM"
449 #define TEP_PRINT_LATENCY "LATENCY"
450 #define TEP_PRINT_NAME "NAME"
451 #define TEP_PRINT_PID 1U
452 #define TEP_PRINT_TIME 2U
453 #define TEP_PRINT_CPU 3U
455 void tep_print_event(struct tep_handle *tep, struct trace_seq *s,
456 struct tep_record *record, const char *fmt, ...)
457 __attribute__ ((format (printf, 4, 5)));
459 int tep_parse_header_page(struct tep_handle *tep, char *buf, unsigned long size,
462 enum tep_errno tep_parse_event(struct tep_handle *tep, const char *buf,
463 unsigned long size, const char *sys);
464 enum tep_errno tep_parse_format(struct tep_handle *tep,
465 struct tep_event **eventp,
467 unsigned long size, const char *sys);
469 void *tep_get_field_raw(struct trace_seq *s, struct tep_event *event,
470 const char *name, struct tep_record *record,
473 int tep_get_field_val(struct trace_seq *s, struct tep_event *event,
474 const char *name, struct tep_record *record,
475 unsigned long long *val, int err);
476 int tep_get_common_field_val(struct trace_seq *s, struct tep_event *event,
477 const char *name, struct tep_record *record,
478 unsigned long long *val, int err);
479 int tep_get_any_field_val(struct trace_seq *s, struct tep_event *event,
480 const char *name, struct tep_record *record,
481 unsigned long long *val, int err);
483 int tep_print_num_field(struct trace_seq *s, const char *fmt,
484 struct tep_event *event, const char *name,
485 struct tep_record *record, int err);
487 int tep_print_func_field(struct trace_seq *s, const char *fmt,
488 struct tep_event *event, const char *name,
489 struct tep_record *record, int err);
491 enum tep_reg_handler {
492 TEP_REGISTER_SUCCESS = 0,
493 TEP_REGISTER_SUCCESS_OVERWRITE,
496 int tep_register_event_handler(struct tep_handle *tep, int id,
497 const char *sys_name, const char *event_name,
498 tep_event_handler_func func, void *context);
499 int tep_unregister_event_handler(struct tep_handle *tep, int id,
500 const char *sys_name, const char *event_name,
501 tep_event_handler_func func, void *context);
502 int tep_register_print_function(struct tep_handle *tep,
503 tep_func_handler func,
504 enum tep_func_arg_type ret_type,
506 int tep_unregister_print_function(struct tep_handle *tep,
507 tep_func_handler func, char *name);
509 struct tep_format_field *tep_find_common_field(struct tep_event *event, const char *name);
510 struct tep_format_field *tep_find_field(struct tep_event *event, const char *name);
511 struct tep_format_field *tep_find_any_field(struct tep_event *event, const char *name);
513 const char *tep_find_function(struct tep_handle *tep, unsigned long long addr);
515 tep_find_function_address(struct tep_handle *tep, unsigned long long addr);
516 unsigned long long tep_read_number(struct tep_handle *tep, const void *ptr, int size);
517 int tep_read_number_field(struct tep_format_field *field, const void *data,
518 unsigned long long *value);
520 struct tep_event *tep_get_first_event(struct tep_handle *tep);
521 int tep_get_events_count(struct tep_handle *tep);
522 struct tep_event *tep_find_event(struct tep_handle *tep, int id);
525 tep_find_event_by_name(struct tep_handle *tep, const char *sys, const char *name);
527 tep_find_event_by_record(struct tep_handle *tep, struct tep_record *record);
529 int tep_data_type(struct tep_handle *tep, struct tep_record *rec);
530 int tep_data_pid(struct tep_handle *tep, struct tep_record *rec);
531 int tep_data_preempt_count(struct tep_handle *tep, struct tep_record *rec);
532 int tep_data_flags(struct tep_handle *tep, struct tep_record *rec);
533 const char *tep_data_comm_from_pid(struct tep_handle *tep, int pid);
535 struct tep_cmdline *tep_data_pid_from_comm(struct tep_handle *tep, const char *comm,
536 struct tep_cmdline *next);
537 int tep_cmdline_pid(struct tep_handle *tep, struct tep_cmdline *cmdline);
539 void tep_print_field(struct trace_seq *s, void *data,
540 struct tep_format_field *field);
541 void tep_print_fields(struct trace_seq *s, void *data,
542 int size __maybe_unused, struct tep_event *event);
543 int tep_strerror(struct tep_handle *tep, enum tep_errno errnum,
544 char *buf, size_t buflen);
546 struct tep_event **tep_list_events(struct tep_handle *tep, enum tep_event_sort_type);
547 struct tep_event **tep_list_events_copy(struct tep_handle *tep,
548 enum tep_event_sort_type);
549 struct tep_format_field **tep_event_common_fields(struct tep_event *event);
550 struct tep_format_field **tep_event_fields(struct tep_event *event);
553 TEP_LITTLE_ENDIAN = 0,
556 int tep_get_cpus(struct tep_handle *tep);
557 void tep_set_cpus(struct tep_handle *tep, int cpus);
558 int tep_get_long_size(struct tep_handle *tep);
559 void tep_set_long_size(struct tep_handle *tep, int long_size);
560 int tep_get_page_size(struct tep_handle *tep);
561 void tep_set_page_size(struct tep_handle *tep, int _page_size);
562 bool tep_is_file_bigendian(struct tep_handle *tep);
563 void tep_set_file_bigendian(struct tep_handle *tep, enum tep_endian endian);
564 bool tep_is_local_bigendian(struct tep_handle *tep);
565 void tep_set_local_bigendian(struct tep_handle *tep, enum tep_endian endian);
566 int tep_get_header_page_size(struct tep_handle *tep);
567 int tep_get_header_timestamp_size(struct tep_handle *tep);
568 bool tep_is_old_format(struct tep_handle *tep);
569 void tep_set_test_filters(struct tep_handle *tep, int test_filters);
571 struct tep_handle *tep_alloc(void);
572 void tep_free(struct tep_handle *tep);
573 void tep_ref(struct tep_handle *tep);
574 void tep_unref(struct tep_handle *tep);
575 int tep_get_ref(struct tep_handle *tep);
577 /* access to the internal parser */
578 void tep_buffer_init(const char *buf, unsigned long long size);
579 enum tep_event_type tep_read_token(char **tok);
580 void tep_free_token(char *token);
581 int tep_peek_char(void);
582 const char *tep_get_input_buf(void);
583 unsigned long long tep_get_input_buf_ptr(void);
586 void tep_print_funcs(struct tep_handle *tep);
587 void tep_print_printk(struct tep_handle *tep);
589 /* ----------------------- filtering ----------------------- */
591 enum tep_filter_boolean_type {
596 enum tep_filter_op_type {
597 TEP_FILTER_OP_AND = 1,
602 enum tep_filter_cmp_type {
610 TEP_FILTER_CMP_MATCH,
611 TEP_FILTER_CMP_NOT_MATCH,
612 TEP_FILTER_CMP_REGEX,
613 TEP_FILTER_CMP_NOT_REGEX,
616 enum tep_filter_exp_type {
623 TEP_FILTER_EXP_RSHIFT,
624 TEP_FILTER_EXP_LSHIFT,
631 enum tep_filter_arg_type {
633 TEP_FILTER_ARG_BOOLEAN,
634 TEP_FILTER_ARG_VALUE,
635 TEP_FILTER_ARG_FIELD,
642 enum tep_filter_value_type {
648 struct tep_filter_arg;
650 struct tep_filter_arg_boolean {
651 enum tep_filter_boolean_type value;
654 struct tep_filter_arg_field {
655 struct tep_format_field *field;
658 struct tep_filter_arg_value {
659 enum tep_filter_value_type type;
662 unsigned long long val;
666 struct tep_filter_arg_op {
667 enum tep_filter_op_type type;
668 struct tep_filter_arg *left;
669 struct tep_filter_arg *right;
672 struct tep_filter_arg_exp {
673 enum tep_filter_exp_type type;
674 struct tep_filter_arg *left;
675 struct tep_filter_arg *right;
678 struct tep_filter_arg_num {
679 enum tep_filter_cmp_type type;
680 struct tep_filter_arg *left;
681 struct tep_filter_arg *right;
684 struct tep_filter_arg_str {
685 enum tep_filter_cmp_type type;
686 struct tep_format_field *field;
692 struct tep_filter_arg {
693 enum tep_filter_arg_type type;
695 struct tep_filter_arg_boolean boolean;
696 struct tep_filter_arg_field field;
697 struct tep_filter_arg_value value;
698 struct tep_filter_arg_op op;
699 struct tep_filter_arg_exp exp;
700 struct tep_filter_arg_num num;
701 struct tep_filter_arg_str str;
705 struct tep_filter_type {
707 struct tep_event *event;
708 struct tep_filter_arg *filter;
711 #define TEP_FILTER_ERROR_BUFSZ 1024
713 struct tep_event_filter {
714 struct tep_handle *tep;
716 struct tep_filter_type *event_filters;
717 char error_buffer[TEP_FILTER_ERROR_BUFSZ];
720 struct tep_event_filter *tep_filter_alloc(struct tep_handle *tep);
722 /* for backward compatibility */
723 #define FILTER_NONE TEP_ERRNO__NO_FILTER
724 #define FILTER_NOEXIST TEP_ERRNO__FILTER_NOT_FOUND
725 #define FILTER_MISS TEP_ERRNO__FILTER_MISS
726 #define FILTER_MATCH TEP_ERRNO__FILTER_MATCH
728 enum tep_errno tep_filter_add_filter_str(struct tep_event_filter *filter,
729 const char *filter_str);
731 enum tep_errno tep_filter_match(struct tep_event_filter *filter,
732 struct tep_record *record);
734 int tep_filter_strerror(struct tep_event_filter *filter, enum tep_errno err,
735 char *buf, size_t buflen);
737 int tep_event_filtered(struct tep_event_filter *filter,
740 void tep_filter_reset(struct tep_event_filter *filter);
742 void tep_filter_free(struct tep_event_filter *filter);
744 char *tep_filter_make_string(struct tep_event_filter *filter, int event_id);
746 int tep_filter_remove_event(struct tep_event_filter *filter,
749 int tep_filter_copy(struct tep_event_filter *dest, struct tep_event_filter *source);
751 int tep_filter_compare(struct tep_event_filter *filter1, struct tep_event_filter *filter2);
753 #endif /* _PARSE_EVENTS_H */