xref: /OK3568_Linux_fs/kernel/tools/lib/traceevent/Documentation/libtraceevent-file_endian.txt (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyunlibtraceevent(3)
2*4882a593Smuzhiyun================
3*4882a593Smuzhiyun
4*4882a593SmuzhiyunNAME
5*4882a593Smuzhiyun----
6*4882a593Smuzhiyuntep_is_file_bigendian, tep_set_file_bigendian - Get / set the endianness of the
7*4882a593Smuzhiyunraw data being accessed by the tep handler.
8*4882a593Smuzhiyun
9*4882a593SmuzhiyunSYNOPSIS
10*4882a593Smuzhiyun--------
11*4882a593Smuzhiyun[verse]
12*4882a593Smuzhiyun--
13*4882a593Smuzhiyun*#include <event-parse.h>*
14*4882a593Smuzhiyun
15*4882a593Smuzhiyunenum *tep_endian* {
16*4882a593Smuzhiyun	TEP_LITTLE_ENDIAN = 0,
17*4882a593Smuzhiyun	TEP_BIG_ENDIAN
18*4882a593Smuzhiyun};
19*4882a593Smuzhiyun
20*4882a593Smuzhiyunbool *tep_is_file_bigendian*(struct tep_handle pass:[*]_tep_);
21*4882a593Smuzhiyunvoid *tep_set_file_bigendian*(struct tep_handle pass:[*]_tep_, enum tep_endian _endian_);
22*4882a593Smuzhiyun
23*4882a593Smuzhiyun--
24*4882a593SmuzhiyunDESCRIPTION
25*4882a593Smuzhiyun-----------
26*4882a593SmuzhiyunThe _tep_is_file_bigendian()_ function gets the endianness of the raw data,
27*4882a593Smuzhiyunbeing accessed by the tep handler. The _tep_ argument is trace event parser
28*4882a593Smuzhiyuncontext.
29*4882a593Smuzhiyun
30*4882a593SmuzhiyunThe _tep_set_file_bigendian()_ function sets the endianness of raw data being
31*4882a593Smuzhiyunaccessed by the tep handler. The _tep_ argument is trace event parser context.
32*4882a593Smuzhiyun[verse]
33*4882a593Smuzhiyun--
34*4882a593SmuzhiyunThe _endian_ argument is the endianness:
35*4882a593Smuzhiyun	_TEP_LITTLE_ENDIAN_ - the raw data is in little endian format,
36*4882a593Smuzhiyun	_TEP_BIG_ENDIAN_ - the raw data is in big endian format.
37*4882a593Smuzhiyun--
38*4882a593SmuzhiyunRETURN VALUE
39*4882a593Smuzhiyun------------
40*4882a593SmuzhiyunThe _tep_is_file_bigendian()_ function returns true if the data is in bigendian
41*4882a593Smuzhiyunformat, false otherwise.
42*4882a593Smuzhiyun
43*4882a593SmuzhiyunEXAMPLE
44*4882a593Smuzhiyun-------
45*4882a593Smuzhiyun[source,c]
46*4882a593Smuzhiyun--
47*4882a593Smuzhiyun#include <event-parse.h>
48*4882a593Smuzhiyun...
49*4882a593Smuzhiyunstruct tep_handle *tep = tep_alloc();
50*4882a593Smuzhiyun...
51*4882a593Smuzhiyun	tep_set_file_bigendian(tep, TEP_LITTLE_ENDIAN);
52*4882a593Smuzhiyun...
53*4882a593Smuzhiyun	if (tep_is_file_bigendian(tep)) {
54*4882a593Smuzhiyun		/* The raw data is in big endian */
55*4882a593Smuzhiyun	} else {
56*4882a593Smuzhiyun		/* The raw data is in little endian */
57*4882a593Smuzhiyun	}
58*4882a593Smuzhiyun--
59*4882a593Smuzhiyun
60*4882a593SmuzhiyunFILES
61*4882a593Smuzhiyun-----
62*4882a593Smuzhiyun[verse]
63*4882a593Smuzhiyun--
64*4882a593Smuzhiyun*event-parse.h*
65*4882a593Smuzhiyun	Header file to include in order to have access to the library APIs.
66*4882a593Smuzhiyun*-ltraceevent*
67*4882a593Smuzhiyun	Linker switch to add when building a program that uses the library.
68*4882a593Smuzhiyun--
69*4882a593Smuzhiyun
70*4882a593SmuzhiyunSEE ALSO
71*4882a593Smuzhiyun--------
72*4882a593Smuzhiyun_libtraceevent(3)_, _trace-cmd(1)_
73*4882a593Smuzhiyun
74*4882a593SmuzhiyunAUTHOR
75*4882a593Smuzhiyun------
76*4882a593Smuzhiyun[verse]
77*4882a593Smuzhiyun--
78*4882a593Smuzhiyun*Steven Rostedt* <rostedt@goodmis.org>, author of *libtraceevent*.
79*4882a593Smuzhiyun*Tzvetomir Stoyanov* <tz.stoyanov@gmail.com>, author of this man page.
80*4882a593Smuzhiyun--
81*4882a593SmuzhiyunREPORTING BUGS
82*4882a593Smuzhiyun--------------
83*4882a593SmuzhiyunReport bugs to  <linux-trace-devel@vger.kernel.org>
84*4882a593Smuzhiyun
85*4882a593SmuzhiyunLICENSE
86*4882a593Smuzhiyun-------
87*4882a593Smuzhiyunlibtraceevent is Free Software licensed under the GNU LGPL 2.1
88*4882a593Smuzhiyun
89*4882a593SmuzhiyunRESOURCES
90*4882a593Smuzhiyun---------
91*4882a593Smuzhiyunhttps://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
92