mirror of
https://github.com/xen-project/xen.git
synced 2026-10-29 18:50:05 +01:00
Andrew Cooper
014b165f9b
And transform to POD to match our other manpages.
The content is identical (other than one correction), although the
layout differs slightly with certain indentation.
As a correction, remove the reference to xentrace_cpusplit(1) which was
removed in c/s 9b9ca98b6a, more than 10 years ago!
Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
Acked-by: Wei Liu <wei.liu2@citrix.com>
47 lines
1.4 KiB
Groff
47 lines
1.4 KiB
Groff
=head1 NAME
|
|
|
|
xentrace_format - pretty-print Xen trace data
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
B<xentrace_format> [ I<DEFS-FILE> ]
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
B<xentrace_format> parses trace data in B<xentrace> binary format from
|
|
standard input and reformats it according to the rules in a file of
|
|
definitions (I<DEFS-FILE>), printing to standard output.
|
|
|
|
The rules in I<DEFS-FILE> should have the format shown below:
|
|
|
|
I<event_id> I<whitespace> I<format>
|
|
|
|
Each rule should start on a new line.
|
|
|
|
The format string may include format specifiers, such as:
|
|
%(cpu)d, %(tsc)d, %(event)d, %(1)d, %(2)d, %(3)d, %(4)d, %(5)d
|
|
|
|
[ the `d' format specifier output in decimal, alternatively `x'
|
|
will output in hexadecimal and `o' will output in octal ]
|
|
|
|
These correspond to the CPU number, event ID, timestamp counter and
|
|
the 5 data fields from the trace record. There should be one such
|
|
rule for each type of event to be pretty-printed (events which do not
|
|
have formatting rules are ignored).
|
|
|
|
A sample format file for Xen's predefined trace events is available
|
|
in the file tools/xentrace/formats in the Xen source tree.
|
|
|
|
Depending on your system and the rate at which trace data is produced,
|
|
this script may not be able to keep up with the output of
|
|
B<xentrace> if it is piped directly. In these circumstances you
|
|
should have B<xentrace> output to a file for processing off-line.
|
|
|
|
=head1 AUTHOR
|
|
|
|
Mark A. Williamson <mark.a.williamson@intel.com>
|
|
|
|
=head1 SEE ALSO
|
|
|
|
xentrace(8)
|