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
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_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_hex
{
230 struct print_arg
*field
;
231 struct print_arg
*size
;
234 struct print_arg_dynarray
{
235 struct format_field
*field
;
236 struct print_arg
*index
;
241 struct print_arg_op
{
244 struct print_arg
*left
;
245 struct print_arg
*right
;
248 struct pevent_function_handler
;
250 struct print_arg_func
{
251 struct pevent_function_handler
*func
;
252 struct print_arg
*args
;
255 enum print_arg_type
{
271 struct print_arg
*next
;
272 enum print_arg_type type
;
274 struct print_arg_atom atom
;
275 struct print_arg_field field
;
276 struct print_arg_typecast typecast
;
277 struct print_arg_flags flags
;
278 struct print_arg_symbol symbol
;
279 struct print_arg_hex hex
;
280 struct print_arg_func func
;
281 struct print_arg_string string
;
282 struct print_arg_op op
;
283 struct print_arg_dynarray dynarray
;
289 struct print_arg
*args
;
292 struct event_format
{
293 struct pevent
*pevent
;
297 struct format format
;
298 struct print_fmt print_fmt
;
300 pevent_event_handler_func handler
;
305 EVENT_FL_ISFTRACE
= 0x01,
306 EVENT_FL_ISPRINT
= 0x02,
307 EVENT_FL_ISBPRINT
= 0x04,
308 EVENT_FL_ISFUNCENT
= 0x10,
309 EVENT_FL_ISFUNCRET
= 0x20,
311 EVENT_FL_FAILED
= 0x80000000
314 enum event_sort_type
{
332 typedef unsigned long long (*pevent_func_handler
)(struct trace_seq
*s
,
333 unsigned long long *args
);
335 enum pevent_func_arg_type
{
336 PEVENT_FUNC_ARG_VOID
,
338 PEVENT_FUNC_ARG_LONG
,
339 PEVENT_FUNC_ARG_STRING
,
341 PEVENT_FUNC_ARG_MAX_TYPES
345 PEVENT_NSEC_OUTPUT
= 1, /* output in NSECS */
348 #define PEVENT_ERRORS \
349 _PE(MEM_ALLOC_FAILED, "failed to allocate memory"), \
350 _PE(PARSE_EVENT_FAILED, "failed to parse event"), \
351 _PE(READ_ID_FAILED, "failed to read event id"), \
352 _PE(READ_FORMAT_FAILED, "failed to read event format"), \
353 _PE(READ_PRINT_FAILED, "failed to read event print fmt"), \
354 _PE(OLD_FTRACE_ARG_FAILED,"failed to allocate field name for ftrace"),\
355 _PE(INVALID_ARG_TYPE, "invalid argument type")
358 #define _PE(__code, __str) PEVENT_ERRNO__ ## __code
360 PEVENT_ERRNO__SUCCESS
= 0,
363 * Choose an arbitrary negative big number not to clash with standard
364 * errno since SUS requires the errno has distinct positive values.
365 * See 'Issue 6' in the link below.
367 * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
369 __PEVENT_ERRNO__START
= -100000,
381 struct event_handler
;
386 int header_page_ts_offset
;
387 int header_page_ts_size
;
388 int header_page_size_offset
;
389 int header_page_size_size
;
390 int header_page_data_offset
;
391 int header_page_data_size
;
392 int header_page_overwrite
;
404 struct cmdline
*cmdlines
;
405 struct cmdline_list
*cmdlist
;
408 struct func_map
*func_map
;
409 struct func_list
*funclist
;
410 unsigned int func_count
;
412 struct printk_map
*printk_map
;
413 struct printk_list
*printklist
;
414 unsigned int printk_count
;
417 struct event_format
**events
;
419 struct event_format
**sort_events
;
420 enum event_sort_type last_type
;
443 struct format_field
*bprint_ip_field
;
444 struct format_field
*bprint_fmt_field
;
445 struct format_field
*bprint_buf_field
;
447 struct event_handler
*handlers
;
448 struct pevent_function_handler
*func_handlers
;
451 struct event_format
*last_event
;
454 static inline void pevent_set_flag(struct pevent
*pevent
, int flag
)
456 pevent
->flags
|= flag
;
459 static inline unsigned short
460 __data2host2(struct pevent
*pevent
, unsigned short data
)
464 if (pevent
->host_bigendian
== pevent
->file_bigendian
)
467 swap
= ((data
& 0xffULL
) << 8) |
468 ((data
& (0xffULL
<< 8)) >> 8);
473 static inline unsigned int
474 __data2host4(struct pevent
*pevent
, unsigned int data
)
478 if (pevent
->host_bigendian
== pevent
->file_bigendian
)
481 swap
= ((data
& 0xffULL
) << 24) |
482 ((data
& (0xffULL
<< 8)) << 8) |
483 ((data
& (0xffULL
<< 16)) >> 8) |
484 ((data
& (0xffULL
<< 24)) >> 24);
489 static inline unsigned long long
490 __data2host8(struct pevent
*pevent
, unsigned long long data
)
492 unsigned long long swap
;
494 if (pevent
->host_bigendian
== pevent
->file_bigendian
)
497 swap
= ((data
& 0xffULL
) << 56) |
498 ((data
& (0xffULL
<< 8)) << 40) |
499 ((data
& (0xffULL
<< 16)) << 24) |
500 ((data
& (0xffULL
<< 24)) << 8) |
501 ((data
& (0xffULL
<< 32)) >> 8) |
502 ((data
& (0xffULL
<< 40)) >> 24) |
503 ((data
& (0xffULL
<< 48)) >> 40) |
504 ((data
& (0xffULL
<< 56)) >> 56);
509 #define data2host2(pevent, ptr) __data2host2(pevent, *(unsigned short *)(ptr))
510 #define data2host4(pevent, ptr) __data2host4(pevent, *(unsigned int *)(ptr))
511 #define data2host8(pevent, ptr) \
513 unsigned long long __val; \
515 memcpy(&__val, (ptr), sizeof(unsigned long long)); \
516 __data2host8(pevent, __val); \
519 /* taken from kernel/trace/trace.h */
520 enum trace_flag_type
{
521 TRACE_FLAG_IRQS_OFF
= 0x01,
522 TRACE_FLAG_IRQS_NOSUPPORT
= 0x02,
523 TRACE_FLAG_NEED_RESCHED
= 0x04,
524 TRACE_FLAG_HARDIRQ
= 0x08,
525 TRACE_FLAG_SOFTIRQ
= 0x10,
528 int pevent_register_comm(struct pevent
*pevent
, const char *comm
, int pid
);
529 int pevent_register_function(struct pevent
*pevent
, char *name
,
530 unsigned long long addr
, char *mod
);
531 int pevent_register_print_string(struct pevent
*pevent
, char *fmt
,
532 unsigned long long addr
);
533 int pevent_pid_is_registered(struct pevent
*pevent
, int pid
);
535 void pevent_print_event(struct pevent
*pevent
, struct trace_seq
*s
,
536 struct pevent_record
*record
);
538 int pevent_parse_header_page(struct pevent
*pevent
, char *buf
, unsigned long size
,
541 enum pevent_errno
pevent_parse_event(struct pevent
*pevent
, const char *buf
,
542 unsigned long size
, const char *sys
);
543 enum pevent_errno
pevent_parse_format(struct event_format
**eventp
, const char *buf
,
544 unsigned long size
, const char *sys
);
545 void pevent_free_format(struct event_format
*event
);
547 void *pevent_get_field_raw(struct trace_seq
*s
, struct event_format
*event
,
548 const char *name
, struct pevent_record
*record
,
551 int pevent_get_field_val(struct trace_seq
*s
, struct event_format
*event
,
552 const char *name
, struct pevent_record
*record
,
553 unsigned long long *val
, int err
);
554 int pevent_get_common_field_val(struct trace_seq
*s
, struct event_format
*event
,
555 const char *name
, struct pevent_record
*record
,
556 unsigned long long *val
, int err
);
557 int pevent_get_any_field_val(struct trace_seq
*s
, struct event_format
*event
,
558 const char *name
, struct pevent_record
*record
,
559 unsigned long long *val
, int err
);
561 int pevent_print_num_field(struct trace_seq
*s
, const char *fmt
,
562 struct event_format
*event
, const char *name
,
563 struct pevent_record
*record
, int err
);
565 int pevent_register_event_handler(struct pevent
*pevent
, int id
, char *sys_name
, char *event_name
,
566 pevent_event_handler_func func
, void *context
);
567 int pevent_register_print_function(struct pevent
*pevent
,
568 pevent_func_handler func
,
569 enum pevent_func_arg_type ret_type
,
572 struct format_field
*pevent_find_common_field(struct event_format
*event
, const char *name
);
573 struct format_field
*pevent_find_field(struct event_format
*event
, const char *name
);
574 struct format_field
*pevent_find_any_field(struct event_format
*event
, const char *name
);
576 const char *pevent_find_function(struct pevent
*pevent
, unsigned long long addr
);
578 pevent_find_function_address(struct pevent
*pevent
, unsigned long long addr
);
579 unsigned long long pevent_read_number(struct pevent
*pevent
, const void *ptr
, int size
);
580 int pevent_read_number_field(struct format_field
*field
, const void *data
,
581 unsigned long long *value
);
583 struct event_format
*pevent_find_event(struct pevent
*pevent
, int id
);
585 struct event_format
*
586 pevent_find_event_by_name(struct pevent
*pevent
, const char *sys
, const char *name
);
588 void pevent_data_lat_fmt(struct pevent
*pevent
,
589 struct trace_seq
*s
, struct pevent_record
*record
);
590 int pevent_data_type(struct pevent
*pevent
, struct pevent_record
*rec
);
591 struct event_format
*pevent_data_event_from_type(struct pevent
*pevent
, int type
);
592 int pevent_data_pid(struct pevent
*pevent
, struct pevent_record
*rec
);
593 const char *pevent_data_comm_from_pid(struct pevent
*pevent
, int pid
);
594 void pevent_event_info(struct trace_seq
*s
, struct event_format
*event
,
595 struct pevent_record
*record
);
596 int pevent_strerror(struct pevent
*pevent
, enum pevent_errno errnum
,
597 char *buf
, size_t buflen
);
599 struct event_format
**pevent_list_events(struct pevent
*pevent
, enum event_sort_type
);
600 struct format_field
**pevent_event_common_fields(struct event_format
*event
);
601 struct format_field
**pevent_event_fields(struct event_format
*event
);
603 static inline int pevent_get_cpus(struct pevent
*pevent
)
608 static inline void pevent_set_cpus(struct pevent
*pevent
, int cpus
)
613 static inline int pevent_get_long_size(struct pevent
*pevent
)
615 return pevent
->long_size
;
618 static inline void pevent_set_long_size(struct pevent
*pevent
, int long_size
)
620 pevent
->long_size
= long_size
;
623 static inline int pevent_is_file_bigendian(struct pevent
*pevent
)
625 return pevent
->file_bigendian
;
628 static inline void pevent_set_file_bigendian(struct pevent
*pevent
, int endian
)
630 pevent
->file_bigendian
= endian
;
633 static inline int pevent_is_host_bigendian(struct pevent
*pevent
)
635 return pevent
->host_bigendian
;
638 static inline void pevent_set_host_bigendian(struct pevent
*pevent
, int endian
)
640 pevent
->host_bigendian
= endian
;
643 static inline int pevent_is_latency_format(struct pevent
*pevent
)
645 return pevent
->latency_format
;
648 static inline void pevent_set_latency_format(struct pevent
*pevent
, int lat
)
650 pevent
->latency_format
= lat
;
653 struct pevent
*pevent_alloc(void);
654 void pevent_free(struct pevent
*pevent
);
655 void pevent_ref(struct pevent
*pevent
);
656 void pevent_unref(struct pevent
*pevent
);
658 /* access to the internal parser */
659 void pevent_buffer_init(const char *buf
, unsigned long long size
);
660 enum event_type
pevent_read_token(char **tok
);
661 void pevent_free_token(char *token
);
662 int pevent_peek_char(void);
663 const char *pevent_get_input_buf(void);
664 unsigned long long pevent_get_input_buf_ptr(void);
667 void pevent_print_funcs(struct pevent
*pevent
);
668 void pevent_print_printk(struct pevent
*pevent
);
670 /* ----------------------- filtering ----------------------- */
672 enum filter_boolean_type
{
677 enum filter_op_type
{
683 enum filter_cmp_type
{
692 FILTER_CMP_NOT_MATCH
,
694 FILTER_CMP_NOT_REGEX
,
697 enum filter_exp_type
{
712 enum filter_arg_type
{
723 enum filter_value_type
{
731 struct filter_arg_boolean
{
732 enum filter_boolean_type value
;
735 struct filter_arg_field
{
736 struct format_field
*field
;
739 struct filter_arg_value
{
740 enum filter_value_type type
;
743 unsigned long long val
;
747 struct filter_arg_op
{
748 enum filter_op_type type
;
749 struct filter_arg
*left
;
750 struct filter_arg
*right
;
753 struct filter_arg_exp
{
754 enum filter_exp_type type
;
755 struct filter_arg
*left
;
756 struct filter_arg
*right
;
759 struct filter_arg_num
{
760 enum filter_cmp_type type
;
761 struct filter_arg
*left
;
762 struct filter_arg
*right
;
765 struct filter_arg_str
{
766 enum filter_cmp_type type
;
767 struct format_field
*field
;
774 enum filter_arg_type type
;
776 struct filter_arg_boolean boolean
;
777 struct filter_arg_field field
;
778 struct filter_arg_value value
;
779 struct filter_arg_op op
;
780 struct filter_arg_exp exp
;
781 struct filter_arg_num num
;
782 struct filter_arg_str str
;
788 struct event_format
*event
;
789 struct filter_arg
*filter
;
792 struct event_filter
{
793 struct pevent
*pevent
;
795 struct filter_type
*event_filters
;
798 struct event_filter
*pevent_filter_alloc(struct pevent
*pevent
);
800 #define FILTER_NONE -2
801 #define FILTER_NOEXIST -1
802 #define FILTER_MISS 0
803 #define FILTER_MATCH 1
805 enum filter_trivial_type
{
806 FILTER_TRIVIAL_FALSE
,
811 int pevent_filter_add_filter_str(struct event_filter
*filter
,
812 const char *filter_str
,
816 int pevent_filter_match(struct event_filter
*filter
,
817 struct pevent_record
*record
);
819 int pevent_event_filtered(struct event_filter
*filter
,
822 void pevent_filter_reset(struct event_filter
*filter
);
824 void pevent_filter_clear_trivial(struct event_filter
*filter
,
825 enum filter_trivial_type type
);
827 void pevent_filter_free(struct event_filter
*filter
);
829 char *pevent_filter_make_string(struct event_filter
*filter
, int event_id
);
831 int pevent_filter_remove_event(struct event_filter
*filter
,
834 int pevent_filter_event_has_trivial(struct event_filter
*filter
,
836 enum filter_trivial_type type
);
838 int pevent_filter_copy(struct event_filter
*dest
, struct event_filter
*source
);
840 int pevent_update_trivial(struct event_filter
*dest
, struct event_filter
*source
,
841 enum filter_trivial_type type
);
843 int pevent_filter_compare(struct event_filter
*filter1
, struct event_filter
*filter2
);
845 #endif /* _PARSE_EVENTS_H */