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
26 #ifndef __maybe_unused
27 #define __maybe_unused __attribute__((unused))
30 /* ----------------------- trace_seq ----------------------- */
33 #ifndef TRACE_SEQ_BUF_SIZE
34 #define TRACE_SEQ_BUF_SIZE 4096
38 #define DEBUG_RECORD 0
41 struct pevent_record
{
42 unsigned long long ts
;
43 unsigned long long offset
;
44 long long missed_events
; /* buffer dropped events before */
45 int record_size
; /* size of binary record */
46 int size
; /* size of data */
50 int locked
; /* Do not free, even if ref_count is zero */
53 struct pevent_record
*prev
;
54 struct pevent_record
*next
;
60 * Trace sequences are used to allow a function to call several other functions
61 * to create a string of data to use (up to a max of PAGE_SIZE).
66 unsigned int buffer_size
;
71 void trace_seq_init(struct trace_seq
*s
);
72 void trace_seq_destroy(struct trace_seq
*s
);
74 extern int trace_seq_printf(struct trace_seq
*s
, const char *fmt
, ...)
75 __attribute__ ((format (printf
, 2, 3)));
76 extern int trace_seq_vprintf(struct trace_seq
*s
, const char *fmt
, va_list args
)
77 __attribute__ ((format (printf
, 2, 0)));
79 extern int trace_seq_puts(struct trace_seq
*s
, const char *str
);
80 extern int trace_seq_putc(struct trace_seq
*s
, unsigned char c
);
82 extern void trace_seq_terminate(struct trace_seq
*s
);
84 extern int trace_seq_do_printf(struct trace_seq
*s
);
87 /* ----------------------- pevent ----------------------- */
92 typedef int (*pevent_event_handler_func
)(struct trace_seq
*s
,
93 struct pevent_record
*record
,
94 struct event_format
*event
,
97 typedef int (*pevent_plugin_load_func
)(struct pevent
*pevent
);
98 typedef int (*pevent_plugin_unload_func
)(void);
100 struct plugin_option
{
101 struct plugin_option
*next
;
113 * Plugin hooks that can be called:
115 * PEVENT_PLUGIN_LOADER: (required)
116 * The function name to initialized the plugin.
118 * int PEVENT_PLUGIN_LOADER(struct pevent *pevent)
120 * PEVENT_PLUGIN_UNLOADER: (optional)
121 * The function called just before unloading
123 * int PEVENT_PLUGIN_UNLOADER(void)
125 * PEVENT_PLUGIN_OPTIONS: (optional)
126 * Plugin options that can be set before loading
128 * struct plugin_option PEVENT_PLUGIN_OPTIONS[] = {
130 * .name = "option-name",
131 * .plugin_alias = "overide-file-name", (optional)
132 * .description = "description of option to show users",
139 * Array must end with .name = NULL;
142 * .plugin_alias is used to give a shorter name to access
143 * the vairable. Useful if a plugin handles more than one event.
145 * PEVENT_PLUGIN_ALIAS: (optional)
146 * The name to use for finding options (uses filename if not defined)
148 #define PEVENT_PLUGIN_LOADER pevent_plugin_loader
149 #define PEVENT_PLUGIN_UNLOADER pevent_plugin_unloader
150 #define PEVENT_PLUGIN_OPTIONS pevent_plugin_options
151 #define PEVENT_PLUGIN_ALIAS pevent_plugin_alias
152 #define _MAKE_STR(x) #x
153 #define MAKE_STR(x) _MAKE_STR(x)
154 #define PEVENT_PLUGIN_LOADER_NAME MAKE_STR(PEVENT_PLUGIN_LOADER)
155 #define PEVENT_PLUGIN_UNLOADER_NAME MAKE_STR(PEVENT_PLUGIN_UNLOADER)
156 #define PEVENT_PLUGIN_OPTIONS_NAME MAKE_STR(PEVENT_PLUGIN_OPTIONS)
157 #define PEVENT_PLUGIN_ALIAS_NAME MAKE_STR(PEVENT_PLUGIN_ALIAS)
159 #define NSECS_PER_SEC 1000000000ULL
160 #define NSECS_PER_USEC 1000ULL
164 FIELD_IS_POINTER
= 2,
167 FIELD_IS_DYNAMIC
= 16,
170 FIELD_IS_SYMBOLIC
= 128,
173 struct format_field
{
174 struct format_field
*next
;
175 struct event_format
*event
;
180 unsigned int arraylen
;
181 unsigned int elementsize
;
188 struct format_field
*common_fields
;
189 struct format_field
*fields
;
192 struct print_arg_atom
{
196 struct print_arg_string
{
201 struct print_arg_field
{
203 struct format_field
*field
;
206 struct print_flag_sym
{
207 struct print_flag_sym
*next
;
212 struct print_arg_typecast
{
214 struct print_arg
*item
;
217 struct print_arg_flags
{
218 struct print_arg
*field
;
220 struct print_flag_sym
*flags
;
223 struct print_arg_symbol
{
224 struct print_arg
*field
;
225 struct print_flag_sym
*symbols
;
228 struct print_arg_hex
{
229 struct print_arg
*field
;
230 struct print_arg
*size
;
233 struct print_arg_dynarray
{
234 struct format_field
*field
;
235 struct print_arg
*index
;
240 struct print_arg_op
{
243 struct print_arg
*left
;
244 struct print_arg
*right
;
247 struct pevent_function_handler
;
249 struct print_arg_func
{
250 struct pevent_function_handler
*func
;
251 struct print_arg
*args
;
254 enum print_arg_type
{
270 struct print_arg
*next
;
271 enum print_arg_type type
;
273 struct print_arg_atom atom
;
274 struct print_arg_field field
;
275 struct print_arg_typecast typecast
;
276 struct print_arg_flags flags
;
277 struct print_arg_symbol symbol
;
278 struct print_arg_hex hex
;
279 struct print_arg_func func
;
280 struct print_arg_string string
;
281 struct print_arg_op op
;
282 struct print_arg_dynarray dynarray
;
288 struct print_arg
*args
;
291 struct event_format
{
292 struct pevent
*pevent
;
296 struct format format
;
297 struct print_fmt print_fmt
;
299 pevent_event_handler_func handler
;
304 EVENT_FL_ISFTRACE
= 0x01,
305 EVENT_FL_ISPRINT
= 0x02,
306 EVENT_FL_ISBPRINT
= 0x04,
307 EVENT_FL_ISFUNCENT
= 0x10,
308 EVENT_FL_ISFUNCRET
= 0x20,
310 EVENT_FL_FAILED
= 0x80000000
313 enum event_sort_type
{
331 typedef unsigned long long (*pevent_func_handler
)(struct trace_seq
*s
,
332 unsigned long long *args
);
334 enum pevent_func_arg_type
{
335 PEVENT_FUNC_ARG_VOID
,
337 PEVENT_FUNC_ARG_LONG
,
338 PEVENT_FUNC_ARG_STRING
,
340 PEVENT_FUNC_ARG_MAX_TYPES
344 PEVENT_NSEC_OUTPUT
= 1, /* output in NSECS */
347 #define PEVENT_ERRORS \
348 _PE(MEM_ALLOC_FAILED, "failed to allocate memory"), \
349 _PE(PARSE_EVENT_FAILED, "failed to parse event"), \
350 _PE(READ_ID_FAILED, "failed to read event id"), \
351 _PE(READ_FORMAT_FAILED, "failed to read event format"), \
352 _PE(READ_PRINT_FAILED, "failed to read event print fmt"), \
353 _PE(OLD_FTRACE_ARG_FAILED,"failed to allocate field name for ftrace"),\
354 _PE(INVALID_ARG_TYPE, "invalid argument type")
357 #define _PE(__code, __str) PEVENT_ERRNO__ ## __code
359 PEVENT_ERRNO__SUCCESS
= 0,
362 * Choose an arbitrary negative big number not to clash with standard
363 * errno since SUS requires the errno has distinct positive values.
364 * See 'Issue 6' in the link below.
366 * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
368 __PEVENT_ERRNO__START
= -100000,
380 struct event_handler
;
385 int header_page_ts_offset
;
386 int header_page_ts_size
;
387 int header_page_size_offset
;
388 int header_page_size_size
;
389 int header_page_data_offset
;
390 int header_page_data_size
;
391 int header_page_overwrite
;
403 struct cmdline
*cmdlines
;
404 struct cmdline_list
*cmdlist
;
407 struct func_map
*func_map
;
408 struct func_list
*funclist
;
409 unsigned int func_count
;
411 struct printk_map
*printk_map
;
412 struct printk_list
*printklist
;
413 unsigned int printk_count
;
416 struct event_format
**events
;
418 struct event_format
**sort_events
;
419 enum event_sort_type last_type
;
442 struct format_field
*bprint_ip_field
;
443 struct format_field
*bprint_fmt_field
;
444 struct format_field
*bprint_buf_field
;
446 struct event_handler
*handlers
;
447 struct pevent_function_handler
*func_handlers
;
450 struct event_format
*last_event
;
453 static inline void pevent_set_flag(struct pevent
*pevent
, int flag
)
455 pevent
->flags
|= flag
;
458 static inline unsigned short
459 __data2host2(struct pevent
*pevent
, unsigned short data
)
463 if (pevent
->host_bigendian
== pevent
->file_bigendian
)
466 swap
= ((data
& 0xffULL
) << 8) |
467 ((data
& (0xffULL
<< 8)) >> 8);
472 static inline unsigned int
473 __data2host4(struct pevent
*pevent
, unsigned int data
)
477 if (pevent
->host_bigendian
== pevent
->file_bigendian
)
480 swap
= ((data
& 0xffULL
) << 24) |
481 ((data
& (0xffULL
<< 8)) << 8) |
482 ((data
& (0xffULL
<< 16)) >> 8) |
483 ((data
& (0xffULL
<< 24)) >> 24);
488 static inline unsigned long long
489 __data2host8(struct pevent
*pevent
, unsigned long long data
)
491 unsigned long long swap
;
493 if (pevent
->host_bigendian
== pevent
->file_bigendian
)
496 swap
= ((data
& 0xffULL
) << 56) |
497 ((data
& (0xffULL
<< 8)) << 40) |
498 ((data
& (0xffULL
<< 16)) << 24) |
499 ((data
& (0xffULL
<< 24)) << 8) |
500 ((data
& (0xffULL
<< 32)) >> 8) |
501 ((data
& (0xffULL
<< 40)) >> 24) |
502 ((data
& (0xffULL
<< 48)) >> 40) |
503 ((data
& (0xffULL
<< 56)) >> 56);
508 #define data2host2(pevent, ptr) __data2host2(pevent, *(unsigned short *)(ptr))
509 #define data2host4(pevent, ptr) __data2host4(pevent, *(unsigned int *)(ptr))
510 #define data2host8(pevent, ptr) \
512 unsigned long long __val; \
514 memcpy(&__val, (ptr), sizeof(unsigned long long)); \
515 __data2host8(pevent, __val); \
518 /* taken from kernel/trace/trace.h */
519 enum trace_flag_type
{
520 TRACE_FLAG_IRQS_OFF
= 0x01,
521 TRACE_FLAG_IRQS_NOSUPPORT
= 0x02,
522 TRACE_FLAG_NEED_RESCHED
= 0x04,
523 TRACE_FLAG_HARDIRQ
= 0x08,
524 TRACE_FLAG_SOFTIRQ
= 0x10,
527 int pevent_register_comm(struct pevent
*pevent
, const char *comm
, int pid
);
528 int pevent_register_function(struct pevent
*pevent
, char *name
,
529 unsigned long long addr
, char *mod
);
530 int pevent_register_print_string(struct pevent
*pevent
, char *fmt
,
531 unsigned long long addr
);
532 int pevent_pid_is_registered(struct pevent
*pevent
, int pid
);
534 void pevent_print_event(struct pevent
*pevent
, struct trace_seq
*s
,
535 struct pevent_record
*record
);
537 int pevent_parse_header_page(struct pevent
*pevent
, char *buf
, unsigned long size
,
540 enum pevent_errno
pevent_parse_event(struct pevent
*pevent
, const char *buf
,
541 unsigned long size
, const char *sys
);
542 enum pevent_errno
pevent_parse_format(struct event_format
**eventp
, const char *buf
,
543 unsigned long size
, const char *sys
);
544 void pevent_free_format(struct event_format
*event
);
546 void *pevent_get_field_raw(struct trace_seq
*s
, struct event_format
*event
,
547 const char *name
, struct pevent_record
*record
,
550 int pevent_get_field_val(struct trace_seq
*s
, struct event_format
*event
,
551 const char *name
, struct pevent_record
*record
,
552 unsigned long long *val
, int err
);
553 int pevent_get_common_field_val(struct trace_seq
*s
, struct event_format
*event
,
554 const char *name
, struct pevent_record
*record
,
555 unsigned long long *val
, int err
);
556 int pevent_get_any_field_val(struct trace_seq
*s
, struct event_format
*event
,
557 const char *name
, struct pevent_record
*record
,
558 unsigned long long *val
, int err
);
560 int pevent_print_num_field(struct trace_seq
*s
, const char *fmt
,
561 struct event_format
*event
, const char *name
,
562 struct pevent_record
*record
, int err
);
564 int pevent_register_event_handler(struct pevent
*pevent
, int id
, char *sys_name
, char *event_name
,
565 pevent_event_handler_func func
, void *context
);
566 int pevent_register_print_function(struct pevent
*pevent
,
567 pevent_func_handler func
,
568 enum pevent_func_arg_type ret_type
,
571 struct format_field
*pevent_find_common_field(struct event_format
*event
, const char *name
);
572 struct format_field
*pevent_find_field(struct event_format
*event
, const char *name
);
573 struct format_field
*pevent_find_any_field(struct event_format
*event
, const char *name
);
575 const char *pevent_find_function(struct pevent
*pevent
, unsigned long long addr
);
577 pevent_find_function_address(struct pevent
*pevent
, unsigned long long addr
);
578 unsigned long long pevent_read_number(struct pevent
*pevent
, const void *ptr
, int size
);
579 int pevent_read_number_field(struct format_field
*field
, const void *data
,
580 unsigned long long *value
);
582 struct event_format
*pevent_find_event(struct pevent
*pevent
, int id
);
584 struct event_format
*
585 pevent_find_event_by_name(struct pevent
*pevent
, const char *sys
, const char *name
);
587 void pevent_data_lat_fmt(struct pevent
*pevent
,
588 struct trace_seq
*s
, struct pevent_record
*record
);
589 int pevent_data_type(struct pevent
*pevent
, struct pevent_record
*rec
);
590 struct event_format
*pevent_data_event_from_type(struct pevent
*pevent
, int type
);
591 int pevent_data_pid(struct pevent
*pevent
, struct pevent_record
*rec
);
592 const char *pevent_data_comm_from_pid(struct pevent
*pevent
, int pid
);
593 void pevent_event_info(struct trace_seq
*s
, struct event_format
*event
,
594 struct pevent_record
*record
);
595 int pevent_strerror(struct pevent
*pevent
, enum pevent_errno errnum
,
596 char *buf
, size_t buflen
);
598 struct event_format
**pevent_list_events(struct pevent
*pevent
, enum event_sort_type
);
599 struct format_field
**pevent_event_common_fields(struct event_format
*event
);
600 struct format_field
**pevent_event_fields(struct event_format
*event
);
602 static inline int pevent_get_cpus(struct pevent
*pevent
)
607 static inline void pevent_set_cpus(struct pevent
*pevent
, int cpus
)
612 static inline int pevent_get_long_size(struct pevent
*pevent
)
614 return pevent
->long_size
;
617 static inline void pevent_set_long_size(struct pevent
*pevent
, int long_size
)
619 pevent
->long_size
= long_size
;
622 static inline int pevent_is_file_bigendian(struct pevent
*pevent
)
624 return pevent
->file_bigendian
;
627 static inline void pevent_set_file_bigendian(struct pevent
*pevent
, int endian
)
629 pevent
->file_bigendian
= endian
;
632 static inline int pevent_is_host_bigendian(struct pevent
*pevent
)
634 return pevent
->host_bigendian
;
637 static inline void pevent_set_host_bigendian(struct pevent
*pevent
, int endian
)
639 pevent
->host_bigendian
= endian
;
642 static inline int pevent_is_latency_format(struct pevent
*pevent
)
644 return pevent
->latency_format
;
647 static inline void pevent_set_latency_format(struct pevent
*pevent
, int lat
)
649 pevent
->latency_format
= lat
;
652 struct pevent
*pevent_alloc(void);
653 void pevent_free(struct pevent
*pevent
);
654 void pevent_ref(struct pevent
*pevent
);
655 void pevent_unref(struct pevent
*pevent
);
657 /* access to the internal parser */
658 void pevent_buffer_init(const char *buf
, unsigned long long size
);
659 enum event_type
pevent_read_token(char **tok
);
660 void pevent_free_token(char *token
);
661 int pevent_peek_char(void);
662 const char *pevent_get_input_buf(void);
663 unsigned long long pevent_get_input_buf_ptr(void);
666 void pevent_print_funcs(struct pevent
*pevent
);
667 void pevent_print_printk(struct pevent
*pevent
);
669 /* ----------------------- filtering ----------------------- */
671 enum filter_boolean_type
{
676 enum filter_op_type
{
682 enum filter_cmp_type
{
691 FILTER_CMP_NOT_MATCH
,
693 FILTER_CMP_NOT_REGEX
,
696 enum filter_exp_type
{
711 enum filter_arg_type
{
722 enum filter_value_type
{
730 struct filter_arg_boolean
{
731 enum filter_boolean_type value
;
734 struct filter_arg_field
{
735 struct format_field
*field
;
738 struct filter_arg_value
{
739 enum filter_value_type type
;
742 unsigned long long val
;
746 struct filter_arg_op
{
747 enum filter_op_type type
;
748 struct filter_arg
*left
;
749 struct filter_arg
*right
;
752 struct filter_arg_exp
{
753 enum filter_exp_type type
;
754 struct filter_arg
*left
;
755 struct filter_arg
*right
;
758 struct filter_arg_num
{
759 enum filter_cmp_type type
;
760 struct filter_arg
*left
;
761 struct filter_arg
*right
;
764 struct filter_arg_str
{
765 enum filter_cmp_type type
;
766 struct format_field
*field
;
773 enum filter_arg_type type
;
775 struct filter_arg_boolean boolean
;
776 struct filter_arg_field field
;
777 struct filter_arg_value value
;
778 struct filter_arg_op op
;
779 struct filter_arg_exp exp
;
780 struct filter_arg_num num
;
781 struct filter_arg_str str
;
787 struct event_format
*event
;
788 struct filter_arg
*filter
;
791 struct event_filter
{
792 struct pevent
*pevent
;
794 struct filter_type
*event_filters
;
797 struct event_filter
*pevent_filter_alloc(struct pevent
*pevent
);
799 #define FILTER_NONE -2
800 #define FILTER_NOEXIST -1
801 #define FILTER_MISS 0
802 #define FILTER_MATCH 1
804 enum filter_trivial_type
{
805 FILTER_TRIVIAL_FALSE
,
810 int pevent_filter_add_filter_str(struct event_filter
*filter
,
811 const char *filter_str
,
815 int pevent_filter_match(struct event_filter
*filter
,
816 struct pevent_record
*record
);
818 int pevent_event_filtered(struct event_filter
*filter
,
821 void pevent_filter_reset(struct event_filter
*filter
);
823 void pevent_filter_clear_trivial(struct event_filter
*filter
,
824 enum filter_trivial_type type
);
826 void pevent_filter_free(struct event_filter
*filter
);
828 char *pevent_filter_make_string(struct event_filter
*filter
, int event_id
);
830 int pevent_filter_remove_event(struct event_filter
*filter
,
833 int pevent_filter_event_has_trivial(struct event_filter
*filter
,
835 enum filter_trivial_type type
);
837 int pevent_filter_copy(struct event_filter
*dest
, struct event_filter
*source
);
839 int pevent_update_trivial(struct event_filter
*dest
, struct event_filter
*source
,
840 enum filter_trivial_type type
);
842 int pevent_filter_compare(struct event_filter
*filter1
, struct event_filter
*filter2
);
844 #endif /* _PARSE_EVENTS_H */