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")
370 #define _PE(__code, __str) PEVENT_ERRNO__ ## __code
372 PEVENT_ERRNO__SUCCESS = 0,
375 * Choose an arbitrary negative big number not to clash with standard
376 * errno since SUS requires the errno has distinct positive values.
377 * See 'Issue 6' in the link below.
379 * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
381 __PEVENT_ERRNO__START = -100000,
391 struct plugin_list *traceevent_load_plugins(struct pevent *pevent);
392 void traceevent_unload_plugins(struct plugin_list *plugin_list);
398 struct event_handler;
403 int header_page_ts_offset;
404 int header_page_ts_size;
405 int header_page_size_offset;
406 int header_page_size_size;
407 int header_page_data_offset;
408 int header_page_data_size;
409 int header_page_overwrite;
422 struct cmdline *cmdlines;
423 struct cmdline_list *cmdlist;
426 struct func_map *func_map;
427 struct func_list *funclist;
428 unsigned int func_count;
430 struct printk_map *printk_map;
431 struct printk_list *printklist;
432 unsigned int printk_count;
435 struct event_format **events;
437 struct event_format **sort_events;
438 enum event_sort_type last_type;
461 struct format_field *bprint_ip_field;
462 struct format_field *bprint_fmt_field;
463 struct format_field *bprint_buf_field;
465 struct event_handler *handlers;
466 struct pevent_function_handler *func_handlers;
469 struct event_format *last_event;
474 static inline void pevent_set_flag(struct pevent *pevent, int flag)
476 pevent->flags |= flag;
479 static inline unsigned short
480 __data2host2(struct pevent *pevent, unsigned short data)
484 if (pevent->host_bigendian == pevent->file_bigendian)
487 swap = ((data & 0xffULL) << 8) |
488 ((data & (0xffULL << 8)) >> 8);
493 static inline unsigned int
494 __data2host4(struct pevent *pevent, unsigned int data)
498 if (pevent->host_bigendian == pevent->file_bigendian)
501 swap = ((data & 0xffULL) << 24) |
502 ((data & (0xffULL << 8)) << 8) |
503 ((data & (0xffULL << 16)) >> 8) |
504 ((data & (0xffULL << 24)) >> 24);
509 static inline unsigned long long
510 __data2host8(struct pevent *pevent, unsigned long long data)
512 unsigned long long swap;
514 if (pevent->host_bigendian == pevent->file_bigendian)
517 swap = ((data & 0xffULL) << 56) |
518 ((data & (0xffULL << 8)) << 40) |
519 ((data & (0xffULL << 16)) << 24) |
520 ((data & (0xffULL << 24)) << 8) |
521 ((data & (0xffULL << 32)) >> 8) |
522 ((data & (0xffULL << 40)) >> 24) |
523 ((data & (0xffULL << 48)) >> 40) |
524 ((data & (0xffULL << 56)) >> 56);
529 #define data2host2(pevent, ptr) __data2host2(pevent, *(unsigned short *)(ptr))
530 #define data2host4(pevent, ptr) __data2host4(pevent, *(unsigned int *)(ptr))
531 #define data2host8(pevent, ptr) \
533 unsigned long long __val; \
535 memcpy(&__val, (ptr), sizeof(unsigned long long)); \
536 __data2host8(pevent, __val); \
539 static inline int traceevent_host_bigendian(void)
541 unsigned char str[] = { 0x1, 0x2, 0x3, 0x4 };
544 memcpy(&val, str, 4);
545 return val == 0x01020304;
548 /* taken from kernel/trace/trace.h */
549 enum trace_flag_type {
550 TRACE_FLAG_IRQS_OFF = 0x01,
551 TRACE_FLAG_IRQS_NOSUPPORT = 0x02,
552 TRACE_FLAG_NEED_RESCHED = 0x04,
553 TRACE_FLAG_HARDIRQ = 0x08,
554 TRACE_FLAG_SOFTIRQ = 0x10,
557 int pevent_register_comm(struct pevent *pevent, const char *comm, int pid);
558 void pevent_register_trace_clock(struct pevent *pevent, char *trace_clock);
559 int pevent_register_function(struct pevent *pevent, char *name,
560 unsigned long long addr, char *mod);
561 int pevent_register_print_string(struct pevent *pevent, const char *fmt,
562 unsigned long long addr);
563 int pevent_pid_is_registered(struct pevent *pevent, int pid);
565 void pevent_print_event(struct pevent *pevent, struct trace_seq *s,
566 struct pevent_record *record, bool use_trace_clock);
568 int pevent_parse_header_page(struct pevent *pevent, char *buf, unsigned long size,
571 enum pevent_errno pevent_parse_event(struct pevent *pevent, const char *buf,
572 unsigned long size, const char *sys);
573 enum pevent_errno pevent_parse_format(struct pevent *pevent,
574 struct event_format **eventp,
576 unsigned long size, const char *sys);
577 void pevent_free_format(struct event_format *event);
579 void *pevent_get_field_raw(struct trace_seq *s, struct event_format *event,
580 const char *name, struct pevent_record *record,
583 int pevent_get_field_val(struct trace_seq *s, struct event_format *event,
584 const char *name, struct pevent_record *record,
585 unsigned long long *val, int err);
586 int pevent_get_common_field_val(struct trace_seq *s, struct event_format *event,
587 const char *name, struct pevent_record *record,
588 unsigned long long *val, int err);
589 int pevent_get_any_field_val(struct trace_seq *s, struct event_format *event,
590 const char *name, struct pevent_record *record,
591 unsigned long long *val, int err);
593 int pevent_print_num_field(struct trace_seq *s, const char *fmt,
594 struct event_format *event, const char *name,
595 struct pevent_record *record, int err);
597 int pevent_print_func_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_register_event_handler(struct pevent *pevent, int id,
602 const char *sys_name, const char *event_name,
603 pevent_event_handler_func func, void *context);
604 int pevent_register_print_function(struct pevent *pevent,
605 pevent_func_handler func,
606 enum pevent_func_arg_type ret_type,
609 struct format_field *pevent_find_common_field(struct event_format *event, const char *name);
610 struct format_field *pevent_find_field(struct event_format *event, const char *name);
611 struct format_field *pevent_find_any_field(struct event_format *event, const char *name);
613 const char *pevent_find_function(struct pevent *pevent, unsigned long long addr);
615 pevent_find_function_address(struct pevent *pevent, unsigned long long addr);
616 unsigned long long pevent_read_number(struct pevent *pevent, const void *ptr, int size);
617 int pevent_read_number_field(struct format_field *field, const void *data,
618 unsigned long long *value);
620 struct event_format *pevent_find_event(struct pevent *pevent, int id);
622 struct event_format *
623 pevent_find_event_by_name(struct pevent *pevent, const char *sys, const char *name);
625 void pevent_data_lat_fmt(struct pevent *pevent,
626 struct trace_seq *s, struct pevent_record *record);
627 int pevent_data_type(struct pevent *pevent, struct pevent_record *rec);
628 struct event_format *pevent_data_event_from_type(struct pevent *pevent, int type);
629 int pevent_data_pid(struct pevent *pevent, struct pevent_record *rec);
630 const char *pevent_data_comm_from_pid(struct pevent *pevent, int pid);
631 void pevent_event_info(struct trace_seq *s, struct event_format *event,
632 struct pevent_record *record);
633 int pevent_strerror(struct pevent *pevent, enum pevent_errno errnum,
634 char *buf, size_t buflen);
636 struct event_format **pevent_list_events(struct pevent *pevent, enum event_sort_type);
637 struct format_field **pevent_event_common_fields(struct event_format *event);
638 struct format_field **pevent_event_fields(struct event_format *event);
640 static inline int pevent_get_cpus(struct pevent *pevent)
645 static inline void pevent_set_cpus(struct pevent *pevent, int cpus)
650 static inline int pevent_get_long_size(struct pevent *pevent)
652 return pevent->long_size;
655 static inline void pevent_set_long_size(struct pevent *pevent, int long_size)
657 pevent->long_size = long_size;
660 static inline int pevent_get_page_size(struct pevent *pevent)
662 return pevent->page_size;
665 static inline void pevent_set_page_size(struct pevent *pevent, int _page_size)
667 pevent->page_size = _page_size;
670 static inline int pevent_is_file_bigendian(struct pevent *pevent)
672 return pevent->file_bigendian;
675 static inline void pevent_set_file_bigendian(struct pevent *pevent, int endian)
677 pevent->file_bigendian = endian;
680 static inline int pevent_is_host_bigendian(struct pevent *pevent)
682 return pevent->host_bigendian;
685 static inline void pevent_set_host_bigendian(struct pevent *pevent, int endian)
687 pevent->host_bigendian = endian;
690 static inline int pevent_is_latency_format(struct pevent *pevent)
692 return pevent->latency_format;
695 static inline void pevent_set_latency_format(struct pevent *pevent, int lat)
697 pevent->latency_format = lat;
700 struct pevent *pevent_alloc(void);
701 void pevent_free(struct pevent *pevent);
702 void pevent_ref(struct pevent *pevent);
703 void pevent_unref(struct pevent *pevent);
705 /* access to the internal parser */
706 void pevent_buffer_init(const char *buf, unsigned long long size);
707 enum event_type pevent_read_token(char **tok);
708 void pevent_free_token(char *token);
709 int pevent_peek_char(void);
710 const char *pevent_get_input_buf(void);
711 unsigned long long pevent_get_input_buf_ptr(void);
714 void pevent_print_funcs(struct pevent *pevent);
715 void pevent_print_printk(struct pevent *pevent);
717 /* ----------------------- filtering ----------------------- */
719 enum filter_boolean_type {
724 enum filter_op_type {
730 enum filter_cmp_type {
739 FILTER_CMP_NOT_MATCH,
741 FILTER_CMP_NOT_REGEX,
744 enum filter_exp_type {
759 enum filter_arg_type {
770 enum filter_value_type {
778 struct filter_arg_boolean {
779 enum filter_boolean_type value;
782 struct filter_arg_field {
783 struct format_field *field;
786 struct filter_arg_value {
787 enum filter_value_type type;
790 unsigned long long val;
794 struct filter_arg_op {
795 enum filter_op_type type;
796 struct filter_arg *left;
797 struct filter_arg *right;
800 struct filter_arg_exp {
801 enum filter_exp_type type;
802 struct filter_arg *left;
803 struct filter_arg *right;
806 struct filter_arg_num {
807 enum filter_cmp_type type;
808 struct filter_arg *left;
809 struct filter_arg *right;
812 struct filter_arg_str {
813 enum filter_cmp_type type;
814 struct format_field *field;
821 enum filter_arg_type type;
823 struct filter_arg_boolean boolean;
824 struct filter_arg_field field;
825 struct filter_arg_value value;
826 struct filter_arg_op op;
827 struct filter_arg_exp exp;
828 struct filter_arg_num num;
829 struct filter_arg_str str;
835 struct event_format *event;
836 struct filter_arg *filter;
839 struct event_filter {
840 struct pevent *pevent;
842 struct filter_type *event_filters;
845 struct event_filter *pevent_filter_alloc(struct pevent *pevent);
847 #define FILTER_NONE -2
848 #define FILTER_NOEXIST -1
849 #define FILTER_MISS 0
850 #define FILTER_MATCH 1
852 enum filter_trivial_type {
853 FILTER_TRIVIAL_FALSE,
858 int pevent_filter_add_filter_str(struct event_filter *filter,
859 const char *filter_str,
863 int pevent_filter_match(struct event_filter *filter,
864 struct pevent_record *record);
866 int pevent_event_filtered(struct event_filter *filter,
869 void pevent_filter_reset(struct event_filter *filter);
871 int pevent_filter_clear_trivial(struct event_filter *filter,
872 enum filter_trivial_type type);
874 void pevent_filter_free(struct event_filter *filter);
876 char *pevent_filter_make_string(struct event_filter *filter, int event_id);
878 int pevent_filter_remove_event(struct event_filter *filter,
881 int pevent_filter_event_has_trivial(struct event_filter *filter,
883 enum filter_trivial_type type);
885 int pevent_filter_copy(struct event_filter *dest, struct event_filter *source);
887 int pevent_update_trivial(struct event_filter *dest, struct event_filter *source,
888 enum filter_trivial_type type);
890 int pevent_filter_compare(struct event_filter *filter1, struct event_filter *filter2);
892 #endif /* _PARSE_EVENTS_H */