xref: /aosp_15_r20/external/libtraceevent/Documentation/libtraceevent-cpus.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_get_cpus, tep_set_cpus - Get / set the number of CPUs, which have a tracing
7*436bf2bcSAndroid Build Coastguard Workerbuffer representing it. Note, the buffer may be empty.
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
15*436bf2bcSAndroid Build Coastguard Workerint *tep_get_cpus*(struct tep_handle pass:[*]_tep_);
16*436bf2bcSAndroid Build Coastguard Workervoid *tep_set_cpus*(struct tep_handle pass:[*]_tep_, int _cpus_);
17*436bf2bcSAndroid Build Coastguard Worker--
18*436bf2bcSAndroid Build Coastguard Worker
19*436bf2bcSAndroid Build Coastguard WorkerDESCRIPTION
20*436bf2bcSAndroid Build Coastguard Worker-----------
21*436bf2bcSAndroid Build Coastguard WorkerThe *tep_get_cpus()* function gets the number of CPUs, which have a tracing
22*436bf2bcSAndroid Build Coastguard Workerbuffer representing it. The _tep_ argument is trace event parser context.
23*436bf2bcSAndroid Build Coastguard Worker
24*436bf2bcSAndroid Build Coastguard WorkerThe *tep_set_cpus()* function sets the number of CPUs, which have a tracing
25*436bf2bcSAndroid Build Coastguard Workerbuffer representing it. The _tep_ argument is trace event parser context.
26*436bf2bcSAndroid Build Coastguard WorkerThe _cpu_ argument is the number of CPUs with tracing data.
27*436bf2bcSAndroid Build Coastguard Worker
28*436bf2bcSAndroid Build Coastguard WorkerRETURN VALUE
29*436bf2bcSAndroid Build Coastguard Worker------------
30*436bf2bcSAndroid Build Coastguard WorkerThe *tep_get_cpus()* functions returns the number of CPUs, which have tracing
31*436bf2bcSAndroid Build Coastguard Workerdata recorded.
32*436bf2bcSAndroid Build Coastguard Worker
33*436bf2bcSAndroid Build Coastguard WorkerEXAMPLE
34*436bf2bcSAndroid Build Coastguard Worker-------
35*436bf2bcSAndroid Build Coastguard Worker[source,c]
36*436bf2bcSAndroid Build Coastguard Worker--
37*436bf2bcSAndroid Build Coastguard Worker#include <event-parse.h>
38*436bf2bcSAndroid Build Coastguard Worker...
39*436bf2bcSAndroid Build Coastguard Workerstruct tep_handle *tep = tep_alloc();
40*436bf2bcSAndroid Build Coastguard Worker...
41*436bf2bcSAndroid Build Coastguard Worker	tep_set_cpus(tep, 5);
42*436bf2bcSAndroid Build Coastguard Worker...
43*436bf2bcSAndroid Build Coastguard Worker	printf("We have tracing data for %d CPUs", tep_get_cpus(tep));
44*436bf2bcSAndroid Build Coastguard Worker--
45*436bf2bcSAndroid Build Coastguard Worker
46*436bf2bcSAndroid Build Coastguard WorkerFILES
47*436bf2bcSAndroid Build Coastguard Worker-----
48*436bf2bcSAndroid Build Coastguard Worker[verse]
49*436bf2bcSAndroid Build Coastguard Worker--
50*436bf2bcSAndroid Build Coastguard Worker*event-parse.h*
51*436bf2bcSAndroid Build Coastguard Worker	Header file to include in order to have access to the library APIs.
52*436bf2bcSAndroid Build Coastguard Worker*-ltraceevent*
53*436bf2bcSAndroid Build Coastguard Worker	Linker switch to add when building a program that uses the library.
54*436bf2bcSAndroid Build Coastguard Worker--
55*436bf2bcSAndroid Build Coastguard Worker
56*436bf2bcSAndroid Build Coastguard WorkerSEE ALSO
57*436bf2bcSAndroid Build Coastguard Worker--------
58*436bf2bcSAndroid Build Coastguard Worker*libtraceevent*(3), *trace-cmd*(1)
59*436bf2bcSAndroid Build Coastguard Worker
60*436bf2bcSAndroid Build Coastguard WorkerAUTHOR
61*436bf2bcSAndroid Build Coastguard Worker------
62*436bf2bcSAndroid Build Coastguard Worker[verse]
63*436bf2bcSAndroid Build Coastguard Worker--
64*436bf2bcSAndroid Build Coastguard Worker*Steven Rostedt* <[email protected]>, author of *libtraceevent*.
65*436bf2bcSAndroid Build Coastguard Worker*Tzvetomir Stoyanov* <[email protected]>, author of this man page.
66*436bf2bcSAndroid Build Coastguard Worker--
67*436bf2bcSAndroid Build Coastguard WorkerREPORTING BUGS
68*436bf2bcSAndroid Build Coastguard Worker--------------
69*436bf2bcSAndroid Build Coastguard WorkerReport bugs to  <[email protected]>
70*436bf2bcSAndroid Build Coastguard Worker
71*436bf2bcSAndroid Build Coastguard WorkerLICENSE
72*436bf2bcSAndroid Build Coastguard Worker-------
73*436bf2bcSAndroid Build Coastguard Workerlibtraceevent is Free Software licensed under the GNU LGPL 2.1
74*436bf2bcSAndroid Build Coastguard Worker
75*436bf2bcSAndroid Build Coastguard WorkerRESOURCES
76*436bf2bcSAndroid Build Coastguard Worker---------
77*436bf2bcSAndroid Build Coastguard Workerhttps://git.kernel.org/pub/scm/libs/libtrace/libtraceevent.git/
78