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
27 #ifndef __maybe_unused
28 #define __maybe_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_reset(struct trace_seq
*s
);
74 void trace_seq_destroy(struct trace_seq
*s
);
76 extern int trace_seq_printf(struct trace_seq
*s
, const char *fmt
, ...)
77 __attribute__ ((format (printf
, 2, 3)));
78 extern int trace_seq_vprintf(struct trace_seq
*s
, const char *fmt
, va_list args
)
79 __attribute__ ((format (printf
, 2, 0)));
81 extern int trace_seq_puts(struct trace_seq
*s
, const char *str
);
82 extern int trace_seq_putc(struct trace_seq
*s
, unsigned char c
);
84 extern void trace_seq_terminate(struct trace_seq
*s
);
86 extern int trace_seq_do_printf(struct trace_seq
*s
);
89 /* ----------------------- pevent ----------------------- */
94 typedef int (*pevent_event_handler_func
)(struct trace_seq
*s
,
95 struct pevent_record
*record
,
96 struct event_format
*event
,
99 typedef int (*pevent_plugin_load_func
)(struct pevent
*pevent
);
100 typedef int (*pevent_plugin_unload_func
)(void);
102 struct plugin_option
{
103 struct plugin_option
*next
;
115 * Plugin hooks that can be called:
117 * PEVENT_PLUGIN_LOADER: (required)
118 * The function name to initialized the plugin.
120 * int PEVENT_PLUGIN_LOADER(struct pevent *pevent)
122 * PEVENT_PLUGIN_UNLOADER: (optional)
123 * The function called just before unloading
125 * int PEVENT_PLUGIN_UNLOADER(void)
127 * PEVENT_PLUGIN_OPTIONS: (optional)
128 * Plugin options that can be set before loading
130 * struct plugin_option PEVENT_PLUGIN_OPTIONS[] = {
132 * .name = "option-name",
133 * .plugin_alias = "overide-file-name", (optional)
134 * .description = "description of option to show users",
141 * Array must end with .name = NULL;
144 * .plugin_alias is used to give a shorter name to access
145 * the vairable. Useful if a plugin handles more than one event.
147 * PEVENT_PLUGIN_ALIAS: (optional)
148 * The name to use for finding options (uses filename if not defined)
150 #define PEVENT_PLUGIN_LOADER pevent_plugin_loader
151 #define PEVENT_PLUGIN_UNLOADER pevent_plugin_unloader
152 #define PEVENT_PLUGIN_OPTIONS pevent_plugin_options
153 #define PEVENT_PLUGIN_ALIAS pevent_plugin_alias
154 #define _MAKE_STR(x) #x
155 #define MAKE_STR(x) _MAKE_STR(x)
156 #define PEVENT_PLUGIN_LOADER_NAME MAKE_STR(PEVENT_PLUGIN_LOADER)
157 #define PEVENT_PLUGIN_UNLOADER_NAME MAKE_STR(PEVENT_PLUGIN_UNLOADER)
158 #define PEVENT_PLUGIN_OPTIONS_NAME MAKE_STR(PEVENT_PLUGIN_OPTIONS)
159 #define PEVENT_PLUGIN_ALIAS_NAME MAKE_STR(PEVENT_PLUGIN_ALIAS)
161 #define NSECS_PER_SEC 1000000000ULL
162 #define NSECS_PER_USEC 1000ULL
166 FIELD_IS_POINTER
= 2,
169 FIELD_IS_DYNAMIC
= 16,
172 FIELD_IS_SYMBOLIC
= 128,
175 struct format_field
{
176 struct format_field
*next
;
177 struct event_format
*event
;
182 unsigned int arraylen
;
183 unsigned int elementsize
;
190 struct format_field
*common_fields
;
191 struct format_field
*fields
;
194 struct print_arg_atom
{
198 struct print_arg_string
{
203 struct print_arg_field
{
205 struct format_field
*field
;
208 struct print_flag_sym
{
209 struct print_flag_sym
*next
;
214 struct print_arg_typecast
{
216 struct print_arg
*item
;
219 struct print_arg_flags
{
220 struct print_arg
*field
;
222 struct print_flag_sym
*flags
;
225 struct print_arg_symbol
{
226 struct print_arg
*field
;
227 struct print_flag_sym
*symbols
;
230 struct print_arg_hex
{
231 struct print_arg
*field
;
232 struct print_arg
*size
;
235 struct print_arg_dynarray
{
236 struct format_field
*field
;
237 struct print_arg
*index
;
242 struct print_arg_op
{
245 struct print_arg
*left
;
246 struct print_arg
*right
;
249 struct pevent_function_handler
;
251 struct print_arg_func
{
252 struct pevent_function_handler
*func
;
253 struct print_arg
*args
;
256 enum print_arg_type
{
272 struct print_arg
*next
;
273 enum print_arg_type type
;
275 struct print_arg_atom atom
;
276 struct print_arg_field field
;
277 struct print_arg_typecast typecast
;
278 struct print_arg_flags flags
;
279 struct print_arg_symbol symbol
;
280 struct print_arg_hex hex
;
281 struct print_arg_func func
;
282 struct print_arg_string string
;
283 struct print_arg_op op
;
284 struct print_arg_dynarray dynarray
;
290 struct print_arg
*args
;
293 struct event_format
{
294 struct pevent
*pevent
;
298 struct format format
;
299 struct print_fmt print_fmt
;
301 pevent_event_handler_func handler
;
306 EVENT_FL_ISFTRACE
= 0x01,
307 EVENT_FL_ISPRINT
= 0x02,
308 EVENT_FL_ISBPRINT
= 0x04,
309 EVENT_FL_ISFUNCENT
= 0x10,
310 EVENT_FL_ISFUNCRET
= 0x20,
311 EVENT_FL_NOHANDLE
= 0x40,
312 EVENT_FL_PRINTRAW
= 0x80,
314 EVENT_FL_FAILED
= 0x80000000
317 enum event_sort_type
{
335 typedef unsigned long long (*pevent_func_handler
)(struct trace_seq
*s
,
336 unsigned long long *args
);
338 enum pevent_func_arg_type
{
339 PEVENT_FUNC_ARG_VOID
,
341 PEVENT_FUNC_ARG_LONG
,
342 PEVENT_FUNC_ARG_STRING
,
344 PEVENT_FUNC_ARG_MAX_TYPES
348 PEVENT_NSEC_OUTPUT
= 1, /* output in NSECS */
351 #define PEVENT_ERRORS \
352 _PE(MEM_ALLOC_FAILED, "failed to allocate memory"), \
353 _PE(PARSE_EVENT_FAILED, "failed to parse event"), \
354 _PE(READ_ID_FAILED, "failed to read event id"), \
355 _PE(READ_FORMAT_FAILED, "failed to read event format"), \
356 _PE(READ_PRINT_FAILED, "failed to read event print fmt"), \
357 _PE(OLD_FTRACE_ARG_FAILED,"failed to allocate field name for ftrace"),\
358 _PE(INVALID_ARG_TYPE, "invalid argument type")
361 #define _PE(__code, __str) PEVENT_ERRNO__ ## __code
363 PEVENT_ERRNO__SUCCESS
= 0,
366 * Choose an arbitrary negative big number not to clash with standard
367 * errno since SUS requires the errno has distinct positive values.
368 * See 'Issue 6' in the link below.
370 * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
372 __PEVENT_ERRNO__START
= -100000,
384 struct event_handler
;
389 int header_page_ts_offset
;
390 int header_page_ts_size
;
391 int header_page_size_offset
;
392 int header_page_size_size
;
393 int header_page_data_offset
;
394 int header_page_data_size
;
395 int header_page_overwrite
;
408 struct cmdline
*cmdlines
;
409 struct cmdline_list
*cmdlist
;
412 struct func_map
*func_map
;
413 struct func_list
*funclist
;
414 unsigned int func_count
;
416 struct printk_map
*printk_map
;
417 struct printk_list
*printklist
;
418 unsigned int printk_count
;
421 struct event_format
**events
;
423 struct event_format
**sort_events
;
424 enum event_sort_type last_type
;
447 struct format_field
*bprint_ip_field
;
448 struct format_field
*bprint_fmt_field
;
449 struct format_field
*bprint_buf_field
;
451 struct event_handler
*handlers
;
452 struct pevent_function_handler
*func_handlers
;
455 struct event_format
*last_event
;
460 static inline void pevent_set_flag(struct pevent
*pevent
, int flag
)
462 pevent
->flags
|= flag
;
465 static inline unsigned short
466 __data2host2(struct pevent
*pevent
, unsigned short data
)
470 if (pevent
->host_bigendian
== pevent
->file_bigendian
)
473 swap
= ((data
& 0xffULL
) << 8) |
474 ((data
& (0xffULL
<< 8)) >> 8);
479 static inline unsigned int
480 __data2host4(struct pevent
*pevent
, unsigned int data
)
484 if (pevent
->host_bigendian
== pevent
->file_bigendian
)
487 swap
= ((data
& 0xffULL
) << 24) |
488 ((data
& (0xffULL
<< 8)) << 8) |
489 ((data
& (0xffULL
<< 16)) >> 8) |
490 ((data
& (0xffULL
<< 24)) >> 24);
495 static inline unsigned long long
496 __data2host8(struct pevent
*pevent
, unsigned long long data
)
498 unsigned long long swap
;
500 if (pevent
->host_bigendian
== pevent
->file_bigendian
)
503 swap
= ((data
& 0xffULL
) << 56) |
504 ((data
& (0xffULL
<< 8)) << 40) |
505 ((data
& (0xffULL
<< 16)) << 24) |
506 ((data
& (0xffULL
<< 24)) << 8) |
507 ((data
& (0xffULL
<< 32)) >> 8) |
508 ((data
& (0xffULL
<< 40)) >> 24) |
509 ((data
& (0xffULL
<< 48)) >> 40) |
510 ((data
& (0xffULL
<< 56)) >> 56);
515 #define data2host2(pevent, ptr) __data2host2(pevent, *(unsigned short *)(ptr))
516 #define data2host4(pevent, ptr) __data2host4(pevent, *(unsigned int *)(ptr))
517 #define data2host8(pevent, ptr) \
519 unsigned long long __val; \
521 memcpy(&__val, (ptr), sizeof(unsigned long long)); \
522 __data2host8(pevent, __val); \
525 /* taken from kernel/trace/trace.h */
526 enum trace_flag_type
{
527 TRACE_FLAG_IRQS_OFF
= 0x01,
528 TRACE_FLAG_IRQS_NOSUPPORT
= 0x02,
529 TRACE_FLAG_NEED_RESCHED
= 0x04,
530 TRACE_FLAG_HARDIRQ
= 0x08,
531 TRACE_FLAG_SOFTIRQ
= 0x10,
534 int pevent_register_comm(struct pevent
*pevent
, const char *comm
, int pid
);
535 void pevent_register_trace_clock(struct pevent
*pevent
, char *trace_clock
);
536 int pevent_register_function(struct pevent
*pevent
, char *name
,
537 unsigned long long addr
, char *mod
);
538 int pevent_register_print_string(struct pevent
*pevent
, const char *fmt
,
539 unsigned long long addr
);
540 int pevent_pid_is_registered(struct pevent
*pevent
, int pid
);
542 void pevent_print_event(struct pevent
*pevent
, struct trace_seq
*s
,
543 struct pevent_record
*record
, bool use_trace_clock
);
545 int pevent_parse_header_page(struct pevent
*pevent
, char *buf
, unsigned long size
,
548 enum pevent_errno
pevent_parse_event(struct pevent
*pevent
, const char *buf
,
549 unsigned long size
, const char *sys
);
550 enum pevent_errno
pevent_parse_format(struct event_format
**eventp
, const char *buf
,
551 unsigned long size
, const char *sys
);
552 void pevent_free_format(struct event_format
*event
);
554 void *pevent_get_field_raw(struct trace_seq
*s
, struct event_format
*event
,
555 const char *name
, struct pevent_record
*record
,
558 int pevent_get_field_val(struct trace_seq
*s
, struct event_format
*event
,
559 const char *name
, struct pevent_record
*record
,
560 unsigned long long *val
, int err
);
561 int pevent_get_common_field_val(struct trace_seq
*s
, struct event_format
*event
,
562 const char *name
, struct pevent_record
*record
,
563 unsigned long long *val
, int err
);
564 int pevent_get_any_field_val(struct trace_seq
*s
, struct event_format
*event
,
565 const char *name
, struct pevent_record
*record
,
566 unsigned long long *val
, int err
);
568 int pevent_print_num_field(struct trace_seq
*s
, const char *fmt
,
569 struct event_format
*event
, const char *name
,
570 struct pevent_record
*record
, int err
);
572 int pevent_print_func_field(struct trace_seq
*s
, const char *fmt
,
573 struct event_format
*event
, const char *name
,
574 struct pevent_record
*record
, int err
);
576 int pevent_register_event_handler(struct pevent
*pevent
, int id
,
577 const char *sys_name
, const char *event_name
,
578 pevent_event_handler_func func
, void *context
);
579 int pevent_register_print_function(struct pevent
*pevent
,
580 pevent_func_handler func
,
581 enum pevent_func_arg_type ret_type
,
584 struct format_field
*pevent_find_common_field(struct event_format
*event
, const char *name
);
585 struct format_field
*pevent_find_field(struct event_format
*event
, const char *name
);
586 struct format_field
*pevent_find_any_field(struct event_format
*event
, const char *name
);
588 const char *pevent_find_function(struct pevent
*pevent
, unsigned long long addr
);
590 pevent_find_function_address(struct pevent
*pevent
, unsigned long long addr
);
591 unsigned long long pevent_read_number(struct pevent
*pevent
, const void *ptr
, int size
);
592 int pevent_read_number_field(struct format_field
*field
, const void *data
,
593 unsigned long long *value
);
595 struct event_format
*pevent_find_event(struct pevent
*pevent
, int id
);
597 struct event_format
*
598 pevent_find_event_by_name(struct pevent
*pevent
, const char *sys
, const char *name
);
600 void pevent_data_lat_fmt(struct pevent
*pevent
,
601 struct trace_seq
*s
, struct pevent_record
*record
);
602 int pevent_data_type(struct pevent
*pevent
, struct pevent_record
*rec
);
603 struct event_format
*pevent_data_event_from_type(struct pevent
*pevent
, int type
);
604 int pevent_data_pid(struct pevent
*pevent
, struct pevent_record
*rec
);
605 const char *pevent_data_comm_from_pid(struct pevent
*pevent
, int pid
);
606 void pevent_event_info(struct trace_seq
*s
, struct event_format
*event
,
607 struct pevent_record
*record
);
608 int pevent_strerror(struct pevent
*pevent
, enum pevent_errno errnum
,
609 char *buf
, size_t buflen
);
611 struct event_format
**pevent_list_events(struct pevent
*pevent
, enum event_sort_type
);
612 struct format_field
**pevent_event_common_fields(struct event_format
*event
);
613 struct format_field
**pevent_event_fields(struct event_format
*event
);
615 static inline int pevent_get_cpus(struct pevent
*pevent
)
620 static inline void pevent_set_cpus(struct pevent
*pevent
, int cpus
)
625 static inline int pevent_get_long_size(struct pevent
*pevent
)
627 return pevent
->long_size
;
630 static inline void pevent_set_long_size(struct pevent
*pevent
, int long_size
)
632 pevent
->long_size
= long_size
;
635 static inline int pevent_get_page_size(struct pevent
*pevent
)
637 return pevent
->page_size
;
640 static inline void pevent_set_page_size(struct pevent
*pevent
, int _page_size
)
642 pevent
->page_size
= _page_size
;
645 static inline int pevent_is_file_bigendian(struct pevent
*pevent
)
647 return pevent
->file_bigendian
;
650 static inline void pevent_set_file_bigendian(struct pevent
*pevent
, int endian
)
652 pevent
->file_bigendian
= endian
;
655 static inline int pevent_is_host_bigendian(struct pevent
*pevent
)
657 return pevent
->host_bigendian
;
660 static inline void pevent_set_host_bigendian(struct pevent
*pevent
, int endian
)
662 pevent
->host_bigendian
= endian
;
665 static inline int pevent_is_latency_format(struct pevent
*pevent
)
667 return pevent
->latency_format
;
670 static inline void pevent_set_latency_format(struct pevent
*pevent
, int lat
)
672 pevent
->latency_format
= lat
;
675 struct pevent
*pevent_alloc(void);
676 void pevent_free(struct pevent
*pevent
);
677 void pevent_ref(struct pevent
*pevent
);
678 void pevent_unref(struct pevent
*pevent
);
680 /* access to the internal parser */
681 void pevent_buffer_init(const char *buf
, unsigned long long size
);
682 enum event_type
pevent_read_token(char **tok
);
683 void pevent_free_token(char *token
);
684 int pevent_peek_char(void);
685 const char *pevent_get_input_buf(void);
686 unsigned long long pevent_get_input_buf_ptr(void);
689 void pevent_print_funcs(struct pevent
*pevent
);
690 void pevent_print_printk(struct pevent
*pevent
);
692 /* ----------------------- filtering ----------------------- */
694 enum filter_boolean_type
{
699 enum filter_op_type
{
705 enum filter_cmp_type
{
714 FILTER_CMP_NOT_MATCH
,
716 FILTER_CMP_NOT_REGEX
,
719 enum filter_exp_type
{
734 enum filter_arg_type
{
745 enum filter_value_type
{
753 struct filter_arg_boolean
{
754 enum filter_boolean_type value
;
757 struct filter_arg_field
{
758 struct format_field
*field
;
761 struct filter_arg_value
{
762 enum filter_value_type type
;
765 unsigned long long val
;
769 struct filter_arg_op
{
770 enum filter_op_type type
;
771 struct filter_arg
*left
;
772 struct filter_arg
*right
;
775 struct filter_arg_exp
{
776 enum filter_exp_type type
;
777 struct filter_arg
*left
;
778 struct filter_arg
*right
;
781 struct filter_arg_num
{
782 enum filter_cmp_type type
;
783 struct filter_arg
*left
;
784 struct filter_arg
*right
;
787 struct filter_arg_str
{
788 enum filter_cmp_type type
;
789 struct format_field
*field
;
796 enum filter_arg_type type
;
798 struct filter_arg_boolean boolean
;
799 struct filter_arg_field field
;
800 struct filter_arg_value value
;
801 struct filter_arg_op op
;
802 struct filter_arg_exp exp
;
803 struct filter_arg_num num
;
804 struct filter_arg_str str
;
810 struct event_format
*event
;
811 struct filter_arg
*filter
;
814 struct event_filter
{
815 struct pevent
*pevent
;
817 struct filter_type
*event_filters
;
820 struct event_filter
*pevent_filter_alloc(struct pevent
*pevent
);
822 #define FILTER_NONE -2
823 #define FILTER_NOEXIST -1
824 #define FILTER_MISS 0
825 #define FILTER_MATCH 1
827 enum filter_trivial_type
{
828 FILTER_TRIVIAL_FALSE
,
833 int pevent_filter_add_filter_str(struct event_filter
*filter
,
834 const char *filter_str
,
838 int pevent_filter_match(struct event_filter
*filter
,
839 struct pevent_record
*record
);
841 int pevent_event_filtered(struct event_filter
*filter
,
844 void pevent_filter_reset(struct event_filter
*filter
);
846 void pevent_filter_clear_trivial(struct event_filter
*filter
,
847 enum filter_trivial_type type
);
849 void pevent_filter_free(struct event_filter
*filter
);
851 char *pevent_filter_make_string(struct event_filter
*filter
, int event_id
);
853 int pevent_filter_remove_event(struct event_filter
*filter
,
856 int pevent_filter_event_has_trivial(struct event_filter
*filter
,
858 enum filter_trivial_type type
);
860 int pevent_filter_copy(struct event_filter
*dest
, struct event_filter
*source
);
862 int pevent_update_trivial(struct event_filter
*dest
, struct event_filter
*source
,
863 enum filter_trivial_type type
);
865 int pevent_filter_compare(struct event_filter
*filter1
, struct event_filter
*filter2
);
867 #endif /* _PARSE_EVENTS_H */