xref: /OK3568_Linux_fs/kernel/tools/lib/traceevent/Documentation/libtraceevent-parse_head.txt (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyunlibtraceevent(3)
2*4882a593Smuzhiyun================
3*4882a593Smuzhiyun
4*4882a593SmuzhiyunNAME
5*4882a593Smuzhiyun----
6*4882a593Smuzhiyuntep_parse_header_page - Parses the data stored in the header page.
7*4882a593Smuzhiyun
8*4882a593SmuzhiyunSYNOPSIS
9*4882a593Smuzhiyun--------
10*4882a593Smuzhiyun[verse]
11*4882a593Smuzhiyun--
12*4882a593Smuzhiyun*#include <event-parse.h>*
13*4882a593Smuzhiyun
14*4882a593Smuzhiyunint *tep_parse_header_page*(struct tep_handle pass:[*]_tep_, char pass:[*]_buf_, unsigned long _size_, int _long_size_);
15*4882a593Smuzhiyun--
16*4882a593Smuzhiyun
17*4882a593SmuzhiyunDESCRIPTION
18*4882a593Smuzhiyun-----------
19*4882a593SmuzhiyunThe _tep_parse_header_page()_ function parses the header page data from _buf_,
20*4882a593Smuzhiyunand initializes the _tep_, trace event parser context, with it. The buffer
21*4882a593Smuzhiyun_buf_ is with _size_, and is supposed to be copied from
22*4882a593Smuzhiyuntracefs/events/header_page.
23*4882a593Smuzhiyun
24*4882a593SmuzhiyunSome old kernels do not have header page info, in this case the
25*4882a593Smuzhiyun_tep_parse_header_page()_ function  can be called with _size_ equal to 0. The
26*4882a593Smuzhiyun_tep_ context is initialized with default values. The _long_size_ can be used in
27*4882a593Smuzhiyunthis use case, to set the size of a long integer to be used.
28*4882a593Smuzhiyun
29*4882a593SmuzhiyunRETURN VALUE
30*4882a593Smuzhiyun------------
31*4882a593SmuzhiyunThe _tep_parse_header_page()_ function returns 0 in case of success, or -1
32*4882a593Smuzhiyunin case of an error.
33*4882a593Smuzhiyun
34*4882a593SmuzhiyunEXAMPLE
35*4882a593Smuzhiyun-------
36*4882a593Smuzhiyun[source,c]
37*4882a593Smuzhiyun--
38*4882a593Smuzhiyun#include <event-parse.h>
39*4882a593Smuzhiyun...
40*4882a593Smuzhiyunstruct tep_handle *tep = tep_alloc();
41*4882a593Smuzhiyun...
42*4882a593Smuzhiyunchar *buf;
43*4882a593Smuzhiyunint size;
44*4882a593Smuzhiyunbuf = read_file("/sys/kernel/tracing/events/header_page", &size);
45*4882a593Smuzhiyunif (tep_parse_header_page(tep, buf, size, sizeof(unsigned long)) != 0) {
46*4882a593Smuzhiyun	/* Failed to parse the header page */
47*4882a593Smuzhiyun}
48*4882a593Smuzhiyun...
49*4882a593Smuzhiyun--
50*4882a593Smuzhiyun
51*4882a593SmuzhiyunFILES
52*4882a593Smuzhiyun-----
53*4882a593Smuzhiyun[verse]
54*4882a593Smuzhiyun--
55*4882a593Smuzhiyun*event-parse.h*
56*4882a593Smuzhiyun	Header file to include in order to have access to the library APIs.
57*4882a593Smuzhiyun*-ltraceevent*
58*4882a593Smuzhiyun	Linker switch to add when building a program that uses the library.
59*4882a593Smuzhiyun--
60*4882a593Smuzhiyun
61*4882a593SmuzhiyunSEE ALSO
62*4882a593Smuzhiyun--------
63*4882a593Smuzhiyun_libtraceevent(3)_, _trace-cmd(1)_
64*4882a593Smuzhiyun
65*4882a593SmuzhiyunAUTHOR
66*4882a593Smuzhiyun------
67*4882a593Smuzhiyun[verse]
68*4882a593Smuzhiyun--
69*4882a593Smuzhiyun*Steven Rostedt* <rostedt@goodmis.org>, author of *libtraceevent*.
70*4882a593Smuzhiyun*Tzvetomir Stoyanov* <tz.stoyanov@gmail.com>, author of this man page.
71*4882a593Smuzhiyun--
72*4882a593SmuzhiyunREPORTING BUGS
73*4882a593Smuzhiyun--------------
74*4882a593SmuzhiyunReport bugs to  <linux-trace-devel@vger.kernel.org>
75*4882a593Smuzhiyun
76*4882a593SmuzhiyunLICENSE
77*4882a593Smuzhiyun-------
78*4882a593Smuzhiyunlibtraceevent is Free Software licensed under the GNU LGPL 2.1
79*4882a593Smuzhiyun
80*4882a593SmuzhiyunRESOURCES
81*4882a593Smuzhiyun---------
82*4882a593Smuzhiyunhttps://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
83