xref: /aosp_15_r20/external/libtraceevent/Documentation/libtraceevent-debug.txt (revision 436bf2bcd5202612ffffe471bbcc1f277cc8d28e)
1libtraceevent(3)
2================
3
4NAME
5----
6tep_print_printk, tep_print_funcs, tep_set_test_filters, tep_plugin_print_options -
7Print libtraceevent internal information.
8
9SYNOPSIS
10--------
11[verse]
12--
13*#include <event-parse.h>*
14*#include <trace-seq.h>*
15
16void *tep_print_printk*(struct tep_handle pass:[*]tep);
17void *tep_print_funcs*(struct tep_handle pass:[*]tep);
18void *tep_set_test_filters*(struct tep_handle pass:[*]tep, int test_filters);
19void *tep_plugin_print_options*(struct trace_seq pass:[*]s);
20--
21
22DESCRIPTION
23-----------
24The *tep_print_printk()* function prints the printk string formats that were
25stored for this tracing session. The _tep_ argument is trace event parser context.
26
27The *tep_print_funcs()* function prints the stored function name to address mapping
28for this tracing session. The _tep_ argument is trace event parser context.
29
30The *tep_set_test_filters()* function sets a flag to test a filter string. If this
31flag is set, when *tep_filter_add_filter_str()* API as called, it will print the filter
32string instead of adding it. The _tep_ argument is trace event parser context.
33The _test_filters_ argument is the test flag that will be set.
34
35The *tep_plugin_print_options()* function writes a list of the registered plugin options
36into _s_.
37
38EXAMPLE
39-------
40[source,c]
41--
42#include <event-parse.h>
43#include <trace-seq.h>
44...
45struct tep_handle *tep = tep_alloc();
46...
47	tep_print_printk(tep);
48...
49	tep_print_funcs(tep);
50...
51struct tep_event_filter *filter = tep_filter_alloc(tep);
52	tep_set_test_filters(tep, 1);
53	tep_filter_add_filter_str(filter, "sched/sched_wakeup:target_cpu==1");
54	tep_set_test_filters(tep, 0);
55	tep_filter_free(filter);
56...
57struct trace_seq seq;
58trace_seq_init(&seq);
59
60	tep_plugin_print_options(&s);
61...
62--
63
64FILES
65-----
66[verse]
67--
68*event-parse.h*
69	Header file to include in order to have access to the library APIs.
70*-ltraceevent*
71	Linker switch to add when building a program that uses the library.
72--
73
74SEE ALSO
75--------
76*libtraceevent*(3), *trace-cmd*(1)
77
78AUTHOR
79------
80[verse]
81--
82*Steven Rostedt* <[email protected]>, author of *libtraceevent*.
83*Tzvetomir Stoyanov* <[email protected]>, author of this man page.
84--
85REPORTING BUGS
86--------------
87Report bugs to  <[email protected]>
88
89LICENSE
90-------
91libtraceevent is Free Software licensed under the GNU LGPL 2.1
92
93RESOURCES
94---------
95https://git.kernel.org/pub/scm/libs/libtrace/libtraceevent.git/
96