xref: /aosp_15_r20/external/trace-cmd/Documentation/libtracecmd/libtracecmd.txt (revision 58e6ee5f017f6a8912852c892d18457e4bafb554)
1*58e6ee5fSAndroid Build Coastguard Workerlibtracecmd(3)
2*58e6ee5fSAndroid Build Coastguard Worker=============
3*58e6ee5fSAndroid Build Coastguard Worker
4*58e6ee5fSAndroid Build Coastguard WorkerNAME
5*58e6ee5fSAndroid Build Coastguard Worker----
6*58e6ee5fSAndroid Build Coastguard Workerlibtracecmd - trace-cmd library APIs
7*58e6ee5fSAndroid Build Coastguard Worker
8*58e6ee5fSAndroid Build Coastguard WorkerSYNOPSIS
9*58e6ee5fSAndroid Build Coastguard Worker--------
10*58e6ee5fSAndroid Build Coastguard Worker[verse]
11*58e6ee5fSAndroid Build Coastguard Worker--
12*58e6ee5fSAndroid Build Coastguard Worker*#include <trace-cmd.h>*
13*58e6ee5fSAndroid Build Coastguard Worker
14*58e6ee5fSAndroid Build Coastguard WorkerOpen and close trace file:
15*58e6ee5fSAndroid Build Coastguard Worker	struct tracecmd_input pass:[*]*tracecmd_open*(const char pass:[*]_file_, int _flags_);
16*58e6ee5fSAndroid Build Coastguard Worker	struct tracecmd_input pass:[*]*tracecmd_open_fd*(int _fd_, int _flags_);
17*58e6ee5fSAndroid Build Coastguard Worker	struct tracecmd_input pass:[*]*tracecmd_open_head*(const char pass:[*]_file_, int _flags_);
18*58e6ee5fSAndroid Build Coastguard Worker	void *tracecmd_close*(struct tracecmd_input pass:[*]_handle_);
19*58e6ee5fSAndroid Build Coastguard Worker
20*58e6ee5fSAndroid Build Coastguard WorkerRead tracing records from a trace file:
21*58e6ee5fSAndroid Build Coastguard Worker	int *tracecmd_init_data*(struct tracecmd_input pass:[*]_handle_);
22*58e6ee5fSAndroid Build Coastguard Worker	struct tep_record pass:[*]*tracecmd_read_cpu_first*(struct tracecmd_input pass:[*]_handle_, int _cpu_);
23*58e6ee5fSAndroid Build Coastguard Worker	struct tep_record pass:[*]*tracecmd_read_data*(struct tracecmd_input pass:[*]_handle_, int _cpu_);
24*58e6ee5fSAndroid Build Coastguard Worker	struct tep_record pass:[*]*tracecmd_read_at*(struct tracecmd_input pass:[*]_handle_, unsigned long long _offset_, int pass:[*]_cpu_);
25*58e6ee5fSAndroid Build Coastguard Worker	void *tracecmd_free_record*(struct tep_record pass:[*]_record_);
26*58e6ee5fSAndroid Build Coastguard Worker	struct tep_handle pass:[*]*tracecmd_get_tep*(struct tracecmd_input pass:[*]_handle_);
27*58e6ee5fSAndroid Build Coastguard Worker
28*58e6ee5fSAndroid Build Coastguard WorkerRead tracing instances from a trace file:
29*58e6ee5fSAndroid Build Coastguard Worker	int *tracecmd_buffer_instances*(struct tracecmd_input pass:[*]_handle_);
30*58e6ee5fSAndroid Build Coastguard Worker	const char pass:[*]*tracecmd_buffer_instance_name*(struct tracecmd_input pass:[*]_handle_, int _indx_);
31*58e6ee5fSAndroid Build Coastguard Worker	struct tracecmd_input pass:[*]*tracecmd_buffer_instance_handle*(struct tracecmd_input pass:[*]_handle_, int _indx_);
32*58e6ee5fSAndroid Build Coastguard Worker
33*58e6ee5fSAndroid Build Coastguard WorkerGet traceing peer information from a trace file:
34*58e6ee5fSAndroid Build Coastguard Worker	unsigned long long *tracecmd_get_traceid*(struct tracecmd_input pass:[*]_handle_);
35*58e6ee5fSAndroid Build Coastguard Worker	int *tracecmd_get_guest_cpumap*(struct tracecmd_input pass:[*]_handle_, unsigned long long _trace_id_, const char pass:[*]pass:[*]_name_, int pass:[*]_vcpu_count_, const int pass:[*]pass:[*]_cpu_pid_);
36*58e6ee5fSAndroid Build Coastguard Worker
37*58e6ee5fSAndroid Build Coastguard WorkerControl library logs:
38*58e6ee5fSAndroid Build Coastguard Worker	int *tracecmd_set_loglevel*(enum tep_loglevel _level_);
39*58e6ee5fSAndroid Build Coastguard Worker--
40*58e6ee5fSAndroid Build Coastguard Worker
41*58e6ee5fSAndroid Build Coastguard WorkerDESCRIPTION
42*58e6ee5fSAndroid Build Coastguard Worker-----------
43*58e6ee5fSAndroid Build Coastguard WorkerThe libtracecmd(3) library provides APIs to read, parse and write
44*58e6ee5fSAndroid Build Coastguard Worker_trace-cmd.dat(5)_ files, recorded with _trace-cmd(1)_ application and containing
45*58e6ee5fSAndroid Build Coastguard Workertracing information from ftrace, the official Linux kernel tracer.
46*58e6ee5fSAndroid Build Coastguard Worker
47*58e6ee5fSAndroid Build Coastguard WorkerFILES
48*58e6ee5fSAndroid Build Coastguard Worker-----
49*58e6ee5fSAndroid Build Coastguard Worker[verse]
50*58e6ee5fSAndroid Build Coastguard Worker--
51*58e6ee5fSAndroid Build Coastguard Worker*trace-cmd.h*
52*58e6ee5fSAndroid Build Coastguard Worker	Header file to include in order to have access to the library APIs.
53*58e6ee5fSAndroid Build Coastguard Worker*-ltracecmd*
54*58e6ee5fSAndroid Build Coastguard Worker	Linker switch to add when building a program that uses the library.
55*58e6ee5fSAndroid Build Coastguard Worker--
56*58e6ee5fSAndroid Build Coastguard Worker
57*58e6ee5fSAndroid Build Coastguard WorkerSEE ALSO
58*58e6ee5fSAndroid Build Coastguard Worker--------
59*58e6ee5fSAndroid Build Coastguard Worker_libtraceevent(3)_
60*58e6ee5fSAndroid Build Coastguard Worker_libtracefs(3)_
61*58e6ee5fSAndroid Build Coastguard Worker_trace-cmd(1)_
62*58e6ee5fSAndroid Build Coastguard Worker_trace-cmd.dat(5)_
63*58e6ee5fSAndroid Build Coastguard Worker
64*58e6ee5fSAndroid Build Coastguard WorkerAUTHOR
65*58e6ee5fSAndroid Build Coastguard Worker------
66*58e6ee5fSAndroid Build Coastguard Worker[verse]
67*58e6ee5fSAndroid Build Coastguard Worker--
68*58e6ee5fSAndroid Build Coastguard Worker*Steven Rostedt* <[email protected]>
69*58e6ee5fSAndroid Build Coastguard Worker*Tzvetomir Stoyanov* <[email protected]>
70*58e6ee5fSAndroid Build Coastguard Worker--
71*58e6ee5fSAndroid Build Coastguard WorkerREPORTING BUGS
72*58e6ee5fSAndroid Build Coastguard Worker--------------
73*58e6ee5fSAndroid Build Coastguard WorkerReport bugs to  <[email protected]>
74*58e6ee5fSAndroid Build Coastguard Worker
75*58e6ee5fSAndroid Build Coastguard WorkerLICENSE
76*58e6ee5fSAndroid Build Coastguard Worker-------
77*58e6ee5fSAndroid Build Coastguard Workerlibtracecmd is Free Software licensed under the GNU LGPL 2.1
78*58e6ee5fSAndroid Build Coastguard Worker
79*58e6ee5fSAndroid Build Coastguard WorkerRESOURCES
80*58e6ee5fSAndroid Build Coastguard Worker---------
81*58e6ee5fSAndroid Build Coastguard Workerhttps://git.kernel.org/pub/scm/utils/trace-cmd/trace-cmd.git/
82*58e6ee5fSAndroid Build Coastguard Worker
83*58e6ee5fSAndroid Build Coastguard WorkerCOPYING
84*58e6ee5fSAndroid Build Coastguard Worker-------
85*58e6ee5fSAndroid Build Coastguard WorkerCopyright \(C) 2020 VMware, Inc. Free use of this software is granted under
86*58e6ee5fSAndroid Build Coastguard Workerthe terms of the GNU Public License (GPL).
87