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
28 #ifndef __maybe_unused
29 #define __maybe_unused __attribute__((unused))
32 /* ----------------------- trace_seq ----------------------- */
35 #ifndef TRACE_SEQ_BUF_SIZE
36 #define TRACE_SEQ_BUF_SIZE 4096
40 #define DEBUG_RECORD 0
43 struct pevent_record {
44 unsigned long long ts;
45 unsigned long long offset;
46 long long missed_events; /* buffer dropped events before */
47 int record_size; /* size of binary record */
48 int size; /* size of data */
52 int locked; /* Do not free, even if ref_count is zero */
55 struct pevent_record *prev;
56 struct pevent_record *next;
62 * Trace sequences are used to allow a function to call several other functions
63 * to create a string of data to use (up to a max of PAGE_SIZE).
68 unsigned int buffer_size;
73 void trace_seq_init(struct trace_seq *s);
74 void trace_seq_reset(struct trace_seq *s);
75 void trace_seq_destroy(struct trace_seq *s);
77 extern int trace_seq_printf(struct trace_seq *s, const char *fmt, ...)
78 __attribute__ ((format (printf, 2, 3)));
79 extern int trace_seq_vprintf(struct trace_seq *s, const char *fmt, va_list args)
80 __attribute__ ((format (printf, 2, 0)));
82 extern int trace_seq_puts(struct trace_seq *s, const char *str);
83 extern int trace_seq_putc(struct trace_seq *s, unsigned char c);
85 extern void trace_seq_terminate(struct trace_seq *s);
87 extern int trace_seq_do_printf(struct trace_seq *s);
90 /* ----------------------- pevent ----------------------- */
95 typedef int (*pevent_event_handler_func)(struct trace_seq *s,
96 struct pevent_record *record,
97 struct event_format *event,
100 typedef int (*pevent_plugin_load_func)(struct pevent *pevent);
101 typedef int (*pevent_plugin_unload_func)(void);
103 struct plugin_option {
104 struct plugin_option *next;
116 * Plugin hooks that can be called:
118 * PEVENT_PLUGIN_LOADER: (required)
119 * The function name to initialized the plugin.
121 * int PEVENT_PLUGIN_LOADER(struct pevent *pevent)
123 * PEVENT_PLUGIN_UNLOADER: (optional)
124 * The function called just before unloading
126 * int PEVENT_PLUGIN_UNLOADER(void)
128 * PEVENT_PLUGIN_OPTIONS: (optional)
129 * Plugin options that can be set before loading
131 * struct plugin_option PEVENT_PLUGIN_OPTIONS[] = {
133 * .name = "option-name",
134 * .plugin_alias = "overide-file-name", (optional)
135 * .description = "description of option to show users",
142 * Array must end with .name = NULL;
145 * .plugin_alias is used to give a shorter name to access
146 * the vairable. Useful if a plugin handles more than one event.
148 * PEVENT_PLUGIN_ALIAS: (optional)
149 * The name to use for finding options (uses filename if not defined)
151 #define PEVENT_PLUGIN_LOADER pevent_plugin_loader
152 #define PEVENT_PLUGIN_UNLOADER pevent_plugin_unloader
153 #define PEVENT_PLUGIN_OPTIONS pevent_plugin_options
154 #define PEVENT_PLUGIN_ALIAS pevent_plugin_alias
155 #define _MAKE_STR(x) #x
156 #define MAKE_STR(x) _MAKE_STR(x)
157 #define PEVENT_PLUGIN_LOADER_NAME MAKE_STR(PEVENT_PLUGIN_LOADER)
158 #define PEVENT_PLUGIN_UNLOADER_NAME MAKE_STR(PEVENT_PLUGIN_UNLOADER)
159 #define PEVENT_PLUGIN_OPTIONS_NAME MAKE_STR(PEVENT_PLUGIN_OPTIONS)
160 #define PEVENT_PLUGIN_ALIAS_NAME MAKE_STR(PEVENT_PLUGIN_ALIAS)
162 #define NSECS_PER_SEC 1000000000ULL
163 #define NSECS_PER_USEC 1000ULL
167 FIELD_IS_POINTER = 2,
170 FIELD_IS_DYNAMIC = 16,
173 FIELD_IS_SYMBOLIC = 128,
176 struct format_field {
177 struct format_field *next;
178 struct event_format *event;
183 unsigned int arraylen;
184 unsigned int elementsize;
191 struct format_field *common_fields;
192 struct format_field *fields;
195 struct print_arg_atom {
199 struct print_arg_string {
204 struct print_arg_field {
206 struct format_field *field;
209 struct print_flag_sym {
210 struct print_flag_sym *next;
215 struct print_arg_typecast {
217 struct print_arg *item;
220 struct print_arg_flags {
221 struct print_arg *field;
223 struct print_flag_sym *flags;
226 struct print_arg_symbol {
227 struct print_arg *field;
228 struct print_flag_sym *symbols;
231 struct print_arg_hex {
232 struct print_arg *field;
233 struct print_arg *size;
236 struct print_arg_dynarray {
237 struct format_field *field;
238 struct print_arg *index;
243 struct print_arg_op {
246 struct print_arg *left;
247 struct print_arg *right;
250 struct pevent_function_handler;
252 struct print_arg_func {
253 struct pevent_function_handler *func;
254 struct print_arg *args;
257 enum print_arg_type {
273 struct print_arg *next;
274 enum print_arg_type type;
276 struct print_arg_atom atom;
277 struct print_arg_field field;
278 struct print_arg_typecast typecast;
279 struct print_arg_flags flags;
280 struct print_arg_symbol symbol;
281 struct print_arg_hex hex;
282 struct print_arg_func func;
283 struct print_arg_string string;
284 struct print_arg_op op;
285 struct print_arg_dynarray dynarray;
291 struct print_arg *args;
294 struct event_format {
295 struct pevent *pevent;
299 struct format format;
300 struct print_fmt print_fmt;
302 pevent_event_handler_func handler;
307 EVENT_FL_ISFTRACE = 0x01,
308 EVENT_FL_ISPRINT = 0x02,
309 EVENT_FL_ISBPRINT = 0x04,
310 EVENT_FL_ISFUNCENT = 0x10,
311 EVENT_FL_ISFUNCRET = 0x20,
312 EVENT_FL_NOHANDLE = 0x40,
313 EVENT_FL_PRINTRAW = 0x80,
315 EVENT_FL_FAILED = 0x80000000
318 enum event_sort_type {
336 typedef unsigned long long (*pevent_func_handler)(struct trace_seq *s,
337 unsigned long long *args);
339 enum pevent_func_arg_type {
340 PEVENT_FUNC_ARG_VOID,
342 PEVENT_FUNC_ARG_LONG,
343 PEVENT_FUNC_ARG_STRING,
345 PEVENT_FUNC_ARG_MAX_TYPES
349 PEVENT_NSEC_OUTPUT = 1, /* output in NSECS */
352 #define PEVENT_ERRORS \
353 _PE(MEM_ALLOC_FAILED, "failed to allocate memory"), \
354 _PE(PARSE_EVENT_FAILED, "failed to parse event"), \
355 _PE(READ_ID_FAILED, "failed to read event id"), \
356 _PE(READ_FORMAT_FAILED, "failed to read event format"), \
357 _PE(READ_PRINT_FAILED, "failed to read event print fmt"), \
358 _PE(OLD_FTRACE_ARG_FAILED,"failed to allocate field name for ftrace"),\
359 _PE(INVALID_ARG_TYPE, "invalid argument type"), \
360 _PE(INVALID_EVENT_NAME, "invalid event name"), \
361 _PE(EVENT_NOT_FOUND, "no event found"), \
362 _PE(SYNTAX_ERROR, "syntax error"), \
363 _PE(ILLEGAL_RVALUE, "illegal rvalue"), \
364 _PE(ILLEGAL_LVALUE, "illegal lvalue for string comparison"), \
365 _PE(INVALID_REGEX, "regex did not compute"), \
366 _PE(ILLEGAL_STRING_CMP, "illegal comparison for string"), \
367 _PE(ILLEGAL_INTEGER_CMP,"illegal comparison for integer"), \
368 _PE(REPARENT_NOT_OP, "cannot reparent other than OP"), \
369 _PE(REPARENT_FAILED, "failed to reparent filter OP"), \
370 _PE(BAD_FILTER_ARG, "bad arg in filter tree"), \
371 _PE(UNEXPECTED_TYPE, "unexpected type (not a value)")
374 #define _PE(__code, __str) PEVENT_ERRNO__ ## __code
376 PEVENT_ERRNO__SUCCESS = 0,
379 * Choose an arbitrary negative big number not to clash with standard
380 * errno since SUS requires the errno has distinct positive values.
381 * See 'Issue 6' in the link below.
383 * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
385 __PEVENT_ERRNO__START = -100000,
395 struct plugin_list *traceevent_load_plugins(struct pevent *pevent);
396 void traceevent_unload_plugins(struct plugin_list *plugin_list);
402 struct event_handler;
407 int header_page_ts_offset;
408 int header_page_ts_size;
409 int header_page_size_offset;
410 int header_page_size_size;
411 int header_page_data_offset;
412 int header_page_data_size;
413 int header_page_overwrite;
426 struct cmdline *cmdlines;
427 struct cmdline_list *cmdlist;
430 struct func_map *func_map;
431 struct func_list *funclist;
432 unsigned int func_count;
434 struct printk_map *printk_map;
435 struct printk_list *printklist;
436 unsigned int printk_count;
439 struct event_format **events;
441 struct event_format **sort_events;
442 enum event_sort_type last_type;
465 struct format_field *bprint_ip_field;
466 struct format_field *bprint_fmt_field;
467 struct format_field *bprint_buf_field;
469 struct event_handler *handlers;
470 struct pevent_function_handler *func_handlers;
473 struct event_format *last_event;
478 static inline void pevent_set_flag(struct pevent *pevent, int flag)
480 pevent->flags |= flag;
483 static inline unsigned short
484 __data2host2(struct pevent *pevent, unsigned short data)
488 if (pevent->host_bigendian == pevent->file_bigendian)
491 swap = ((data & 0xffULL) << 8) |
492 ((data & (0xffULL << 8)) >> 8);
497 static inline unsigned int
498 __data2host4(struct pevent *pevent, unsigned int data)
502 if (pevent->host_bigendian == pevent->file_bigendian)
505 swap = ((data & 0xffULL) << 24) |
506 ((data & (0xffULL << 8)) << 8) |
507 ((data & (0xffULL << 16)) >> 8) |
508 ((data & (0xffULL << 24)) >> 24);
513 static inline unsigned long long
514 __data2host8(struct pevent *pevent, unsigned long long data)
516 unsigned long long swap;
518 if (pevent->host_bigendian == pevent->file_bigendian)
521 swap = ((data & 0xffULL) << 56) |
522 ((data & (0xffULL << 8)) << 40) |
523 ((data & (0xffULL << 16)) << 24) |
524 ((data & (0xffULL << 24)) << 8) |
525 ((data & (0xffULL << 32)) >> 8) |
526 ((data & (0xffULL << 40)) >> 24) |
527 ((data & (0xffULL << 48)) >> 40) |
528 ((data & (0xffULL << 56)) >> 56);
533 #define data2host2(pevent, ptr) __data2host2(pevent, *(unsigned short *)(ptr))
534 #define data2host4(pevent, ptr) __data2host4(pevent, *(unsigned int *)(ptr))
535 #define data2host8(pevent, ptr) \
537 unsigned long long __val; \
539 memcpy(&__val, (ptr), sizeof(unsigned long long)); \
540 __data2host8(pevent, __val); \
543 static inline int traceevent_host_bigendian(void)
545 unsigned char str[] = { 0x1, 0x2, 0x3, 0x4 };
548 memcpy(&val, str, 4);
549 return val == 0x01020304;
552 /* taken from kernel/trace/trace.h */
553 enum trace_flag_type {
554 TRACE_FLAG_IRQS_OFF = 0x01,
555 TRACE_FLAG_IRQS_NOSUPPORT = 0x02,
556 TRACE_FLAG_NEED_RESCHED = 0x04,
557 TRACE_FLAG_HARDIRQ = 0x08,
558 TRACE_FLAG_SOFTIRQ = 0x10,
561 int pevent_register_comm(struct pevent *pevent, const char *comm, int pid);
562 void pevent_register_trace_clock(struct pevent *pevent, char *trace_clock);
563 int pevent_register_function(struct pevent *pevent, char *name,
564 unsigned long long addr, char *mod);
565 int pevent_register_print_string(struct pevent *pevent, const char *fmt,
566 unsigned long long addr);
567 int pevent_pid_is_registered(struct pevent *pevent, int pid);
569 void pevent_print_event(struct pevent *pevent, struct trace_seq *s,
570 struct pevent_record *record, bool use_trace_clock);
572 int pevent_parse_header_page(struct pevent *pevent, char *buf, unsigned long size,
575 enum pevent_errno pevent_parse_event(struct pevent *pevent, const char *buf,
576 unsigned long size, const char *sys);
577 enum pevent_errno pevent_parse_format(struct pevent *pevent,
578 struct event_format **eventp,
580 unsigned long size, const char *sys);
581 void pevent_free_format(struct event_format *event);
583 void *pevent_get_field_raw(struct trace_seq *s, struct event_format *event,
584 const char *name, struct pevent_record *record,
587 int pevent_get_field_val(struct trace_seq *s, struct event_format *event,
588 const char *name, struct pevent_record *record,
589 unsigned long long *val, int err);
590 int pevent_get_common_field_val(struct trace_seq *s, struct event_format *event,
591 const char *name, struct pevent_record *record,
592 unsigned long long *val, int err);
593 int pevent_get_any_field_val(struct trace_seq *s, struct event_format *event,
594 const char *name, struct pevent_record *record,
595 unsigned long long *val, int err);
597 int pevent_print_num_field(struct trace_seq *s, const char *fmt,
598 struct event_format *event, const char *name,
599 struct pevent_record *record, int err);
601 int pevent_print_func_field(struct trace_seq *s, const char *fmt,
602 struct event_format *event, const char *name,
603 struct pevent_record *record, int err);
605 int pevent_register_event_handler(struct pevent *pevent, int id,
606 const char *sys_name, const char *event_name,
607 pevent_event_handler_func func, void *context);
608 int pevent_register_print_function(struct pevent *pevent,
609 pevent_func_handler func,
610 enum pevent_func_arg_type ret_type,
613 struct format_field *pevent_find_common_field(struct event_format *event, const char *name);
614 struct format_field *pevent_find_field(struct event_format *event, const char *name);
615 struct format_field *pevent_find_any_field(struct event_format *event, const char *name);
617 const char *pevent_find_function(struct pevent *pevent, unsigned long long addr);
619 pevent_find_function_address(struct pevent *pevent, unsigned long long addr);
620 unsigned long long pevent_read_number(struct pevent *pevent, const void *ptr, int size);
621 int pevent_read_number_field(struct format_field *field, const void *data,
622 unsigned long long *value);
624 struct event_format *pevent_find_event(struct pevent *pevent, int id);
626 struct event_format *
627 pevent_find_event_by_name(struct pevent *pevent, const char *sys, const char *name);
629 void pevent_data_lat_fmt(struct pevent *pevent,
630 struct trace_seq *s, struct pevent_record *record);
631 int pevent_data_type(struct pevent *pevent, struct pevent_record *rec);
632 struct event_format *pevent_data_event_from_type(struct pevent *pevent, int type);
633 int pevent_data_pid(struct pevent *pevent, struct pevent_record *rec);
634 const char *pevent_data_comm_from_pid(struct pevent *pevent, int pid);
635 void pevent_event_info(struct trace_seq *s, struct event_format *event,
636 struct pevent_record *record);
637 int pevent_strerror(struct pevent *pevent, enum pevent_errno errnum,
638 char *buf, size_t buflen);
640 struct event_format **pevent_list_events(struct pevent *pevent, enum event_sort_type);
641 struct format_field **pevent_event_common_fields(struct event_format *event);
642 struct format_field **pevent_event_fields(struct event_format *event);
644 static inline int pevent_get_cpus(struct pevent *pevent)
649 static inline void pevent_set_cpus(struct pevent *pevent, int cpus)
654 static inline int pevent_get_long_size(struct pevent *pevent)
656 return pevent->long_size;
659 static inline void pevent_set_long_size(struct pevent *pevent, int long_size)
661 pevent->long_size = long_size;
664 static inline int pevent_get_page_size(struct pevent *pevent)
666 return pevent->page_size;
669 static inline void pevent_set_page_size(struct pevent *pevent, int _page_size)
671 pevent->page_size = _page_size;
674 static inline int pevent_is_file_bigendian(struct pevent *pevent)
676 return pevent->file_bigendian;
679 static inline void pevent_set_file_bigendian(struct pevent *pevent, int endian)
681 pevent->file_bigendian = endian;
684 static inline int pevent_is_host_bigendian(struct pevent *pevent)
686 return pevent->host_bigendian;
689 static inline void pevent_set_host_bigendian(struct pevent *pevent, int endian)
691 pevent->host_bigendian = endian;
694 static inline int pevent_is_latency_format(struct pevent *pevent)
696 return pevent->latency_format;
699 static inline void pevent_set_latency_format(struct pevent *pevent, int lat)
701 pevent->latency_format = lat;
704 struct pevent *pevent_alloc(void);
705 void pevent_free(struct pevent *pevent);
706 void pevent_ref(struct pevent *pevent);
707 void pevent_unref(struct pevent *pevent);
709 /* access to the internal parser */
710 void pevent_buffer_init(const char *buf, unsigned long long size);
711 enum event_type pevent_read_token(char **tok);
712 void pevent_free_token(char *token);
713 int pevent_peek_char(void);
714 const char *pevent_get_input_buf(void);
715 unsigned long long pevent_get_input_buf_ptr(void);
718 void pevent_print_funcs(struct pevent *pevent);
719 void pevent_print_printk(struct pevent *pevent);
721 /* ----------------------- filtering ----------------------- */
723 enum filter_boolean_type {
728 enum filter_op_type {
734 enum filter_cmp_type {
743 FILTER_CMP_NOT_MATCH,
745 FILTER_CMP_NOT_REGEX,
748 enum filter_exp_type {
763 enum filter_arg_type {
774 enum filter_value_type {
782 struct filter_arg_boolean {
783 enum filter_boolean_type value;
786 struct filter_arg_field {
787 struct format_field *field;
790 struct filter_arg_value {
791 enum filter_value_type type;
794 unsigned long long val;
798 struct filter_arg_op {
799 enum filter_op_type type;
800 struct filter_arg *left;
801 struct filter_arg *right;
804 struct filter_arg_exp {
805 enum filter_exp_type type;
806 struct filter_arg *left;
807 struct filter_arg *right;
810 struct filter_arg_num {
811 enum filter_cmp_type type;
812 struct filter_arg *left;
813 struct filter_arg *right;
816 struct filter_arg_str {
817 enum filter_cmp_type type;
818 struct format_field *field;
825 enum filter_arg_type type;
827 struct filter_arg_boolean boolean;
828 struct filter_arg_field field;
829 struct filter_arg_value value;
830 struct filter_arg_op op;
831 struct filter_arg_exp exp;
832 struct filter_arg_num num;
833 struct filter_arg_str str;
839 struct event_format *event;
840 struct filter_arg *filter;
843 struct event_filter {
844 struct pevent *pevent;
846 struct filter_type *event_filters;
849 struct event_filter *pevent_filter_alloc(struct pevent *pevent);
851 #define FILTER_NONE -2
852 #define FILTER_NOEXIST -1
853 #define FILTER_MISS 0
854 #define FILTER_MATCH 1
856 enum filter_trivial_type {
857 FILTER_TRIVIAL_FALSE,
862 int pevent_filter_add_filter_str(struct event_filter *filter,
863 const char *filter_str,
867 int pevent_filter_match(struct event_filter *filter,
868 struct pevent_record *record);
870 int pevent_event_filtered(struct event_filter *filter,
873 void pevent_filter_reset(struct event_filter *filter);
875 int pevent_filter_clear_trivial(struct event_filter *filter,
876 enum filter_trivial_type type);
878 void pevent_filter_free(struct event_filter *filter);
880 char *pevent_filter_make_string(struct event_filter *filter, int event_id);
882 int pevent_filter_remove_event(struct event_filter *filter,
885 int pevent_filter_event_has_trivial(struct event_filter *filter,
887 enum filter_trivial_type type);
889 int pevent_filter_copy(struct event_filter *dest, struct event_filter *source);
891 int pevent_update_trivial(struct event_filter *dest, struct event_filter *source,
892 enum filter_trivial_type type);
894 int pevent_filter_compare(struct event_filter *filter1, struct event_filter *filter2);
896 #endif /* _PARSE_EVENTS_H */