1=head1 NAME
2
3xentrace_format - pretty-print Xen trace data
4
5=head1 SYNOPSIS
6
7B<xentrace_format> [ I<DEFS-FILE> ]
8
9=head1 DESCRIPTION
10
11B<xentrace_format> parses trace data in B<xentrace> binary format from
12standard input and reformats it according to the rules in a file of
13definitions (I<DEFS-FILE>), printing to standard output.
14
15The rules in I<DEFS-FILE> should have the format shown below:
16
17I<event_id> I<whitespace> I<format>
18
19Each rule should start on a new line.
20
21The format string may include format specifiers, such as:
22%(cpu)d, %(tsc)d, %(event)d, %(1)d, %(2)d, %(3)d, %(4)d, %(5)d
23
24[ the `d' format specifier output in decimal, alternatively `x'
25  will output in hexadecimal and `o' will output in octal ]
26
27These correspond to the CPU number, event ID, timestamp counter and
28the 5 data fields from the trace record.  There should be one such
29rule for each type of event to be pretty-printed (events which do not
30have formatting rules are ignored).
31
32A sample format file for Xen's predefined trace events is available
33in the file tools/xentrace/formats in the Xen source tree.
34
35Depending on your system and the rate at which trace data is produced,
36this script may not be able to keep up with the output of
37B<xentrace> if it is piped directly.  In these circumstances you
38should have B<xentrace> output to a file for processing off-line.
39
40=head1 AUTHOR
41
42Mark A. Williamson <mark.a.williamson@intel.com>
43
44=head1 SEE ALSO
45
46xentrace(8)
47