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, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
21 #ifndef _PARSE_EVENTS_H
22 #define _PARSE_EVENTS_H
28 #define __unused __attribute__ ((unused))
31 /* ----------------------- trace_seq ----------------------- */
34 #ifndef TRACE_SEQ_BUF_SIZE
35 #define TRACE_SEQ_BUF_SIZE 4096
39 #define DEBUG_RECORD 0
42 struct 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 */
51 int locked; /* Do not free, even if ref_count is zero */
54 struct pevent_record *prev;
55 struct pevent_record *next;
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).
67 unsigned int buffer_size;
72 void trace_seq_init(struct trace_seq *s);
73 void trace_seq_destroy(struct trace_seq *s);
75 extern int trace_seq_printf(struct trace_seq *s, const char *fmt, ...)
76 __attribute__ ((format (printf, 2, 3)));
77 extern int trace_seq_vprintf(struct trace_seq *s, const char *fmt, va_list args)
78 __attribute__ ((format (printf, 2, 0)));
80 extern int trace_seq_puts(struct trace_seq *s, const char *str);
81 extern int trace_seq_putc(struct trace_seq *s, unsigned char c);
83 extern void trace_seq_terminate(struct trace_seq *s);
85 extern int trace_seq_do_printf(struct trace_seq *s);
88 /* ----------------------- pevent ----------------------- */
93 typedef int (*pevent_event_handler_func)(struct trace_seq *s,
94 struct pevent_record *record,
95 struct event_format *event,
98 typedef int (*pevent_plugin_load_func)(struct pevent *pevent);
99 typedef int (*pevent_plugin_unload_func)(void);
101 struct plugin_option {
102 struct plugin_option *next;
114 * Plugin hooks that can be called:
116 * PEVENT_PLUGIN_LOADER: (required)
117 * The function name to initialized the plugin.
119 * int PEVENT_PLUGIN_LOADER(struct pevent *pevent)
121 * PEVENT_PLUGIN_UNLOADER: (optional)
122 * The function called just before unloading
124 * int PEVENT_PLUGIN_UNLOADER(void)
126 * PEVENT_PLUGIN_OPTIONS: (optional)
127 * Plugin options that can be set before loading
129 * struct plugin_option PEVENT_PLUGIN_OPTIONS[] = {
131 * .name = "option-name",
132 * .plugin_alias = "overide-file-name", (optional)
133 * .description = "description of option to show users",
140 * Array must end with .name = NULL;
143 * .plugin_alias is used to give a shorter name to access
144 * the vairable. Useful if a plugin handles more than one event.
146 * PEVENT_PLUGIN_ALIAS: (optional)
147 * The name to use for finding options (uses filename if not defined)
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)
160 #define NSECS_PER_SEC 1000000000ULL
161 #define NSECS_PER_USEC 1000ULL
165 FIELD_IS_POINTER = 2,
168 FIELD_IS_DYNAMIC = 16,
171 FIELD_IS_SYMBOLIC = 128,
174 struct format_field {
175 struct format_field *next;
176 struct event_format *event;
181 unsigned int arraylen;
182 unsigned int elementsize;
189 struct format_field *common_fields;
190 struct format_field *fields;
193 struct print_arg_atom {
197 struct print_arg_string {
202 struct print_arg_field {
204 struct format_field *field;
207 struct print_flag_sym {
208 struct print_flag_sym *next;
213 struct print_arg_typecast {
215 struct print_arg *item;
218 struct print_arg_flags {
219 struct print_arg *field;
221 struct print_flag_sym *flags;
224 struct print_arg_symbol {
225 struct print_arg *field;
226 struct print_flag_sym *symbols;
229 struct print_arg_dynarray {
230 struct format_field *field;
231 struct print_arg *index;
236 struct print_arg_op {
239 struct print_arg *left;
240 struct print_arg *right;
243 struct pevent_function_handler;
245 struct print_arg_func {
246 struct pevent_function_handler *func;
247 struct print_arg *args;
250 enum print_arg_type {
265 struct print_arg *next;
266 enum print_arg_type type;
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;
282 struct print_arg *args;
285 struct event_format {
286 struct pevent *pevent;
290 struct format format;
291 struct print_fmt print_fmt;
293 pevent_event_handler_func handler;
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,
304 EVENT_FL_FAILED = 0x80000000
307 enum event_sort_type {
325 typedef unsigned long long (*pevent_func_handler)(struct trace_seq *s,
326 unsigned long long *args);
328 enum pevent_func_arg_type {
329 PEVENT_FUNC_ARG_VOID,
331 PEVENT_FUNC_ARG_LONG,
332 PEVENT_FUNC_ARG_STRING,
334 PEVENT_FUNC_ARG_MAX_TYPES
338 PEVENT_NSEC_OUTPUT = 1, /* output in NSECS */
345 struct event_handler;
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;
368 struct cmdline *cmdlines;
369 struct cmdline_list *cmdlist;
372 struct func_map *func_map;
373 struct func_list *funclist;
374 unsigned int func_count;
376 struct printk_map *printk_map;
377 struct printk_list *printklist;
378 unsigned int printk_count;
381 struct event_format **events;
383 struct event_format **sort_events;
384 enum event_sort_type last_type;
407 struct format_field *bprint_ip_field;
408 struct format_field *bprint_fmt_field;
409 struct format_field *bprint_buf_field;
411 struct event_handler *handlers;
412 struct pevent_function_handler *func_handlers;
415 struct event_format *last_event;
418 static inline void pevent_set_flag(struct pevent *pevent, int flag)
420 pevent->flags |= flag;
423 static inline unsigned short
424 __data2host2(struct pevent *pevent, unsigned short data)
428 if (pevent->host_bigendian == pevent->file_bigendian)
431 swap = ((data & 0xffULL) << 8) |
432 ((data & (0xffULL << 8)) >> 8);
437 static inline unsigned int
438 __data2host4(struct pevent *pevent, unsigned int data)
442 if (pevent->host_bigendian == pevent->file_bigendian)
445 swap = ((data & 0xffULL) << 24) |
446 ((data & (0xffULL << 8)) << 8) |
447 ((data & (0xffULL << 16)) >> 8) |
448 ((data & (0xffULL << 24)) >> 24);
453 static inline unsigned long long
454 __data2host8(struct pevent *pevent, unsigned long long data)
456 unsigned long long swap;
458 if (pevent->host_bigendian == pevent->file_bigendian)
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);
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) \
477 unsigned long long __val; \
479 memcpy(&__val, (ptr), sizeof(unsigned long long)); \
480 __data2host8(pevent, __val); \
483 /* taken from kernel/trace/trace.h */
484 enum 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,
492 int pevent_register_comm(struct pevent *pevent, const char *comm, int pid);
493 int pevent_register_function(struct pevent *pevent, char *name,
494 unsigned long long addr, char *mod);
495 int pevent_register_print_string(struct pevent *pevent, char *fmt,
496 unsigned long long addr);
497 int pevent_pid_is_registered(struct pevent *pevent, int pid);
499 void pevent_print_event(struct pevent *pevent, struct trace_seq *s,
500 struct pevent_record *record);
502 int pevent_parse_header_page(struct pevent *pevent, char *buf, unsigned long size,
505 int pevent_parse_event(struct pevent *pevent, const char *buf,
506 unsigned long size, const char *sys);
508 void *pevent_get_field_raw(struct trace_seq *s, struct event_format *event,
509 const char *name, struct pevent_record *record,
512 int 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);
515 int 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);
518 int 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);
522 int 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);
526 int pevent_register_event_handler(struct pevent *pevent, int id, char *sys_name, char *event_name,
527 pevent_event_handler_func func, void *context);
528 int pevent_register_print_function(struct pevent *pevent,
529 pevent_func_handler func,
530 enum pevent_func_arg_type ret_type,
533 struct format_field *pevent_find_common_field(struct event_format *event, const char *name);
534 struct format_field *pevent_find_field(struct event_format *event, const char *name);
535 struct format_field *pevent_find_any_field(struct event_format *event, const char *name);
537 const char *pevent_find_function(struct pevent *pevent, unsigned long long addr);
539 pevent_find_function_address(struct pevent *pevent, unsigned long long addr);
540 unsigned long long pevent_read_number(struct pevent *pevent, const void *ptr, int size);
541 int pevent_read_number_field(struct format_field *field, const void *data,
542 unsigned long long *value);
544 struct event_format *pevent_find_event(struct pevent *pevent, int id);
546 struct event_format *
547 pevent_find_event_by_name(struct pevent *pevent, const char *sys, const char *name);
549 void pevent_data_lat_fmt(struct pevent *pevent,
550 struct trace_seq *s, struct pevent_record *record);
551 int pevent_data_type(struct pevent *pevent, struct pevent_record *rec);
552 struct event_format *pevent_data_event_from_type(struct pevent *pevent, int type);
553 int pevent_data_pid(struct pevent *pevent, struct pevent_record *rec);
554 const char *pevent_data_comm_from_pid(struct pevent *pevent, int pid);
555 void pevent_event_info(struct trace_seq *s, struct event_format *event,
556 struct pevent_record *record);
558 struct event_format **pevent_list_events(struct pevent *pevent, enum event_sort_type);
559 struct format_field **pevent_event_common_fields(struct event_format *event);
560 struct format_field **pevent_event_fields(struct event_format *event);
562 static inline int pevent_get_cpus(struct pevent *pevent)
567 static inline void pevent_set_cpus(struct pevent *pevent, int cpus)
572 static inline int pevent_get_long_size(struct pevent *pevent)
574 return pevent->long_size;
577 static inline void pevent_set_long_size(struct pevent *pevent, int long_size)
579 pevent->long_size = long_size;
582 static inline int pevent_is_file_bigendian(struct pevent *pevent)
584 return pevent->file_bigendian;
587 static inline void pevent_set_file_bigendian(struct pevent *pevent, int endian)
589 pevent->file_bigendian = endian;
592 static inline int pevent_is_host_bigendian(struct pevent *pevent)
594 return pevent->host_bigendian;
597 static inline void pevent_set_host_bigendian(struct pevent *pevent, int endian)
599 pevent->host_bigendian = endian;
602 static inline int pevent_is_latency_format(struct pevent *pevent)
604 return pevent->latency_format;
607 static inline void pevent_set_latency_format(struct pevent *pevent, int lat)
609 pevent->latency_format = lat;
612 struct pevent *pevent_alloc(void);
613 void pevent_free(struct pevent *pevent);
614 void pevent_ref(struct pevent *pevent);
615 void pevent_unref(struct pevent *pevent);
617 /* access to the internal parser */
618 void pevent_buffer_init(const char *buf, unsigned long long size);
619 enum event_type pevent_read_token(char **tok);
620 void pevent_free_token(char *token);
621 int pevent_peek_char(void);
622 const char *pevent_get_input_buf(void);
623 unsigned long long pevent_get_input_buf_ptr(void);
626 void pevent_print_funcs(struct pevent *pevent);
627 void pevent_print_printk(struct pevent *pevent);
629 /* ----------------------- filtering ----------------------- */
631 enum filter_boolean_type {
636 enum filter_op_type {
642 enum filter_cmp_type {
651 FILTER_CMP_NOT_MATCH,
653 FILTER_CMP_NOT_REGEX,
656 enum filter_exp_type {
671 enum filter_arg_type {
682 enum filter_value_type {
690 struct filter_arg_boolean {
691 enum filter_boolean_type value;
694 struct filter_arg_field {
695 struct format_field *field;
698 struct filter_arg_value {
699 enum filter_value_type type;
702 unsigned long long val;
706 struct filter_arg_op {
707 enum filter_op_type type;
708 struct filter_arg *left;
709 struct filter_arg *right;
712 struct filter_arg_exp {
713 enum filter_exp_type type;
714 struct filter_arg *left;
715 struct filter_arg *right;
718 struct filter_arg_num {
719 enum filter_cmp_type type;
720 struct filter_arg *left;
721 struct filter_arg *right;
724 struct filter_arg_str {
725 enum filter_cmp_type type;
726 struct format_field *field;
733 enum filter_arg_type type;
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;
747 struct event_format *event;
748 struct filter_arg *filter;
751 struct event_filter {
752 struct pevent *pevent;
754 struct filter_type *event_filters;
757 struct event_filter *pevent_filter_alloc(struct pevent *pevent);
759 #define FILTER_NONE -2
760 #define FILTER_NOEXIST -1
761 #define FILTER_MISS 0
762 #define FILTER_MATCH 1
764 enum filter_trivial_type {
765 FILTER_TRIVIAL_FALSE,
770 int pevent_filter_add_filter_str(struct event_filter *filter,
771 const char *filter_str,
775 int pevent_filter_match(struct event_filter *filter,
776 struct pevent_record *record);
778 int pevent_event_filtered(struct event_filter *filter,
781 void pevent_filter_reset(struct event_filter *filter);
783 void pevent_filter_clear_trivial(struct event_filter *filter,
784 enum filter_trivial_type type);
786 void pevent_filter_free(struct event_filter *filter);
788 char *pevent_filter_make_string(struct event_filter *filter, int event_id);
790 int pevent_filter_remove_event(struct event_filter *filter,
793 int pevent_filter_event_has_trivial(struct event_filter *filter,
795 enum filter_trivial_type type);
797 int pevent_filter_copy(struct event_filter *dest, struct event_filter *source);
799 int pevent_update_trivial(struct event_filter *dest, struct event_filter *source,
800 enum filter_trivial_type type);
802 int pevent_filter_compare(struct event_filter *filter1, struct event_filter *filter2);
804 #endif /* _PARSE_EVENTS_H */