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