aboutsummaryrefslogtreecommitdiff
path: root/Documentation/trace-cmd/trace-cmd-dump.1.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/trace-cmd/trace-cmd-dump.1.txt')
-rw-r--r--Documentation/trace-cmd/trace-cmd-dump.1.txt142
1 files changed, 142 insertions, 0 deletions
diff --git a/Documentation/trace-cmd/trace-cmd-dump.1.txt b/Documentation/trace-cmd/trace-cmd-dump.1.txt
new file mode 100644
index 00000000..9c95244b
--- /dev/null
+++ b/Documentation/trace-cmd/trace-cmd-dump.1.txt
@@ -0,0 +1,142 @@
+TRACE-CMD-DUMP(1)
+===================
+
+NAME
+----
+trace-cmd-dump - show a meta data from a trace file, created by trace-cmd record
+
+SYNOPSIS
+--------
+*trace-cmd dump* ['OPTIONS'] ['input-file']
+
+DESCRIPTION
+-----------
+The trace-cmd(1) dump command will display the meta data from a trace file
+created by trace-cmd record.
+
+OPTIONS
+-------
+*-i* 'input-file'::
+ By default, trace-cmd dump will read the file 'trace.dat'. But the *-i*
+ option open up the given 'input-file' instead. Note, the input file may
+ also be specified as the last item on the command line.
+*-v*, *--validate*::
+ Check if the input file is a valid trace file, created by trace-cmd.
+*--summary*::
+ Print a meta data summary - initial format and a short description of each
+ file section. This is the default action, if no arguments are specified.
+*--head-page*::
+ Print the header page information, stored in the file.
+*--head-event*::
+ Print the event header information, stored in the file.
+*--ftrace-events*::
+ Print formats of ftrace specific events.
+*--systems*::
+ Print information of event systems, stored in the file - name and number of
+ events for each system.
+*--events*::
+ Print formats of all events, stored in the file.
+*--kallsyms*::
+ Print information of the mapping of function addresses to the function names.
+*--printk*::
+ Print trace_printk() format strings, stored in the file.
+*--cmd-lines*::
+ Print mapping a PID to a process name.
+*--options*::
+ Print all options, stored in the file.
+*--flyrecord*::
+ Print the offset and the size of tracing data per each CPU.
+*--clock*::
+ Print the trace clock, used for timestamp of the tracing events, stored in the file.
+*--all*::
+ Print all meta data from the file.
+*--help*::
+ Print usage information.
+*--verbose*[='level']::
+ Set the log level. Supported log levels are "none", "critical", "error", "warning",
+ "info", "debug", "all" or their identifiers "0", "1", "2", "3", "4", "5", "6". Setting the log
+ level to specific value enables all logs from that and all previous levels.
+ The level will default to "info" if one is not specified.
+
+ Example: enable all critical, error and warning logs
+
+ trace-cmd report --verbose=warning
+
+EXAMPLES
+--------
+
+# trace-cmd dump --summary -i trace.dat
+
+ Tracing meta data in file trace.dat:
+ [Initial format]
+ 6 [Version]
+ 0 [Little endian]
+ 8 [Bytes in a long]
+ 4096 [Page size, bytes]
+ [Header info, 205 bytes]
+ [Header event, 205 bytes]
+ [Ftrace format, 15 events]
+ [Events format, 2 systems]
+ [Kallsyms, 7144493 bytes]
+ [Trace printk, 2131 bytes]
+ [Saved command lines, 117 bytes]
+ 8 [CPUs with tracing data]
+ [12 options]
+ [Flyrecord tracing data]
+------------------------------------------
+
+# trace-cmd dump --flyrecord -i trace.dat
+ [Flyrecord tracing data]
+ 7176192 0 [offset, size of cpu 0]
+ 7176192 0 [offset, size of cpu 1]
+ 7176192 0 [offset, size of cpu 2]
+ 7176192 4096 [offset, size of cpu 3]
+ 7180288 4096 [offset, size of cpu 4]
+ 7184384 0 [offset, size of cpu 5]
+ 7184384 0 [offset, size of cpu 6]
+ 7184384 0 [offset, size of cpu 7]
+------------------------------------------
+
+# trace-cmd dump --summary --systems -i trace.dat
+
+ Tracing meta data in file trace.dat:
+ [Initial format]
+ 6 [Version]
+ 0 [Little endian]
+ 8 [Bytes in a long]
+ 4096 [Page size, bytes]
+ [Header info, 205 bytes]
+ [Header event, 205 bytes]
+ [Ftrace format, 15 events]
+ [Events format, 3 systems]
+ sched 23 [system, events]
+ irq 5 [system, events]
+ kvm 70 [system, events]
+ [Kallsyms, 7144493 bytes]
+ [Trace printk, 2131 bytes]
+ [Saved command lines, 157 bytes]
+ 8 [CPUs with tracing data]
+ [11 options]
+ [Flyrecord tracing data]
+------------------------------------------
+
+# trace-cmd dump --summary --systems -i trace.dat
+File trace.dat is a valid trace-cmd file
+------------------------------------------
+SEE ALSO
+--------
+trace-cmd(1), trace-cmd.dat(1)
+
+AUTHOR
+------
+*Steven Rostedt* <rostedt@goodmis.org>, author of *trace-cmd*.
+*Tzvetomir Stoyanov* <tz.stoyanov@gmail.com>, author of this man page.
+
+RESOURCES
+---------
+https://git.kernel.org/pub/scm/utils/trace-cmd/trace-cmd.git/
+
+COPYING
+-------
+Copyright \(C) 2010 Red Hat, Inc. Free use of this software is granted under
+the terms of the GNU Public License (GPL).