xref: /aosp_15_r20/external/libtraceevent/Documentation/libtraceevent-file_endian.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_is_file_bigendian, tep_set_file_bigendian - Get / set the endianness of the
7*436bf2bcSAndroid Build Coastguard Workerraw data being accessed by the tep handler.
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 Workerenum *tep_endian* {
16*436bf2bcSAndroid Build Coastguard Worker	TEP_LITTLE_ENDIAN = 0,
17*436bf2bcSAndroid Build Coastguard Worker	TEP_BIG_ENDIAN
18*436bf2bcSAndroid Build Coastguard Worker};
19*436bf2bcSAndroid Build Coastguard Worker
20*436bf2bcSAndroid Build Coastguard Workerbool *tep_is_file_bigendian*(struct tep_handle pass:[*]_tep_);
21*436bf2bcSAndroid Build Coastguard Workervoid *tep_set_file_bigendian*(struct tep_handle pass:[*]_tep_, enum tep_endian _endian_);
22*436bf2bcSAndroid Build Coastguard Worker
23*436bf2bcSAndroid Build Coastguard Worker--
24*436bf2bcSAndroid Build Coastguard WorkerDESCRIPTION
25*436bf2bcSAndroid Build Coastguard Worker-----------
26*436bf2bcSAndroid Build Coastguard WorkerThe *tep_is_file_bigendian()* function gets the endianness of the raw data,
27*436bf2bcSAndroid Build Coastguard Workerbeing accessed by the tep handler. The _tep_ argument is trace event parser
28*436bf2bcSAndroid Build Coastguard Workercontext.
29*436bf2bcSAndroid Build Coastguard Worker
30*436bf2bcSAndroid Build Coastguard WorkerThe *tep_set_file_bigendian()* function sets the endianness of raw data being
31*436bf2bcSAndroid Build Coastguard Workeraccessed by the tep handler. The _tep_ argument is trace event parser context.
32*436bf2bcSAndroid Build Coastguard Worker[verse]
33*436bf2bcSAndroid Build Coastguard Worker--
34*436bf2bcSAndroid Build Coastguard WorkerThe _endian_ argument is the endianness:
35*436bf2bcSAndroid Build Coastguard Worker	_TEP_LITTLE_ENDIAN_ - the raw data is in little endian format,
36*436bf2bcSAndroid Build Coastguard Worker	_TEP_BIG_ENDIAN_ - the raw data is in big endian format.
37*436bf2bcSAndroid Build Coastguard Worker--
38*436bf2bcSAndroid Build Coastguard WorkerRETURN VALUE
39*436bf2bcSAndroid Build Coastguard Worker------------
40*436bf2bcSAndroid Build Coastguard WorkerThe *tep_is_file_bigendian()* function returns true if the data is in bigendian
41*436bf2bcSAndroid Build Coastguard Workerformat, false otherwise.
42*436bf2bcSAndroid Build Coastguard Worker
43*436bf2bcSAndroid Build Coastguard WorkerEXAMPLE
44*436bf2bcSAndroid Build Coastguard Worker-------
45*436bf2bcSAndroid Build Coastguard Worker[source,c]
46*436bf2bcSAndroid Build Coastguard Worker--
47*436bf2bcSAndroid Build Coastguard Worker#include <event-parse.h>
48*436bf2bcSAndroid Build Coastguard Worker...
49*436bf2bcSAndroid Build Coastguard Workerstruct tep_handle *tep = tep_alloc();
50*436bf2bcSAndroid Build Coastguard Worker...
51*436bf2bcSAndroid Build Coastguard Worker	tep_set_file_bigendian(tep, TEP_LITTLE_ENDIAN);
52*436bf2bcSAndroid Build Coastguard Worker...
53*436bf2bcSAndroid Build Coastguard Worker	if (tep_is_file_bigendian(tep)) {
54*436bf2bcSAndroid Build Coastguard Worker		/* The raw data is in big endian */
55*436bf2bcSAndroid Build Coastguard Worker	} else {
56*436bf2bcSAndroid Build Coastguard Worker		/* The raw data is in little endian */
57*436bf2bcSAndroid Build Coastguard Worker	}
58*436bf2bcSAndroid Build Coastguard Worker--
59*436bf2bcSAndroid Build Coastguard Worker
60*436bf2bcSAndroid Build Coastguard WorkerFILES
61*436bf2bcSAndroid Build Coastguard Worker-----
62*436bf2bcSAndroid Build Coastguard Worker[verse]
63*436bf2bcSAndroid Build Coastguard Worker--
64*436bf2bcSAndroid Build Coastguard Worker*event-parse.h*
65*436bf2bcSAndroid Build Coastguard Worker	Header file to include in order to have access to the library APIs.
66*436bf2bcSAndroid Build Coastguard Worker*-ltraceevent*
67*436bf2bcSAndroid Build Coastguard Worker	Linker switch to add when building a program that uses the library.
68*436bf2bcSAndroid Build Coastguard Worker--
69*436bf2bcSAndroid Build Coastguard Worker
70*436bf2bcSAndroid Build Coastguard WorkerSEE ALSO
71*436bf2bcSAndroid Build Coastguard Worker--------
72*436bf2bcSAndroid Build Coastguard Worker*libtraceevent*(3), *trace-cmd*(1)
73*436bf2bcSAndroid Build Coastguard Worker
74*436bf2bcSAndroid Build Coastguard WorkerAUTHOR
75*436bf2bcSAndroid Build Coastguard Worker------
76*436bf2bcSAndroid Build Coastguard Worker[verse]
77*436bf2bcSAndroid Build Coastguard Worker--
78*436bf2bcSAndroid Build Coastguard Worker*Steven Rostedt* <[email protected]>, author of *libtraceevent*.
79*436bf2bcSAndroid Build Coastguard Worker*Tzvetomir Stoyanov* <[email protected]>, author of this man page.
80*436bf2bcSAndroid Build Coastguard Worker--
81*436bf2bcSAndroid Build Coastguard WorkerREPORTING BUGS
82*436bf2bcSAndroid Build Coastguard Worker--------------
83*436bf2bcSAndroid Build Coastguard WorkerReport bugs to  <[email protected]>
84*436bf2bcSAndroid Build Coastguard Worker
85*436bf2bcSAndroid Build Coastguard WorkerLICENSE
86*436bf2bcSAndroid Build Coastguard Worker-------
87*436bf2bcSAndroid Build Coastguard Workerlibtraceevent is Free Software licensed under the GNU LGPL 2.1
88*436bf2bcSAndroid Build Coastguard Worker
89*436bf2bcSAndroid Build Coastguard WorkerRESOURCES
90*436bf2bcSAndroid Build Coastguard Worker---------
91*436bf2bcSAndroid Build Coastguard Workerhttps://git.kernel.org/pub/scm/libs/libtrace/libtraceevent.git/
92