Scroll to navigation

UFTRACE(1) UFTRACE(1)

NAME

uftrace - Function graph tracer for userspace

SYNOPSIS

uftrace [record|replay|live|report|info|dump|recv|graph|script|tui] [options] COMMAND [command-options]

DESCRIPTION

The uftrace tool is a function tracer that traces the execution of given COMMAND at the function level. COMMAND should be a C or C++ executable built with compiler instrumentation (-pg or -finstrument-functions). COMMAND needs to have an ELF symbol table (i.e. not be strip(1)-ed) in order for the names of traced functions to be available.

The uftrace command consists of a number of sub-commands, in the manner of git(1) or perf(1). Below is a short description of each sub-command. For more detailed information, see the respective manual pages. The options in this page can be given to any sub-command also.

For convenience, if no sub-command is given, uftrace acts as though the live sub-command was specified, which runs the record and replay sub-commands in turn. See uftrace-live(1) for options belonging to the live sub-command. For more detailed analysis, it is better to use uftrace-record(1) to save trace data, and then analyze it with other uftrace commands like uftrace-replay(1), uftrace-report(1), uftrace-info(1), uftrace-dump(1), uftrace-script(1) or uftrace-tui(1).

SUB-COMMANDS

Run a given command and save trace data in a data file or directory.
Print recorded function trace data with time durations.
Do live tracing. Print function trace of the given command.
Print various statistics and summary of the recorded trace data.
Print side-band information like OS version, CPU info, command line and so on.
Print raw tracing data in the data files.
Save tracing data sent to network
Print function call graph
Run a script for recorded function trace
Show text user interface for graph and report

OPTIONS

Print help message and list of options with description
Print usage string
Print program version
Print verbose messages. This option increases a debug level and can be used at most 3 times.
Print debug messages. This option is same as -v/--verbose and is provided only for backward compatibility.
Limit the printing of debug messages to those belonging to one of the DOMAINs specified. Available domains are: uftrace, symbol, demangle, filter, fstack, session, kernel, mcount, dynamic, event, script and dwarf. The domains can have an their own debug level optionally (preceded by a colon). For example, -v --debug-domain=filter:2 will apply debug level of 2 to the “filter” domain and apply debug level of 1 to others.
Specify name of trace data (directory). Default is uftrace.data.
Save warning and debug messages into this file instead of stderr.
Enable or disable color on the output. Possible values are “yes”(= “true” | “1” | “on” ), “no”(= “false” | “0” | “off” ) and “auto”. The “auto” value is default and turns on coloring if stdout is a terminal.
Do not use a pager.
Read command-line options from the FILE.

SEE ALSO

uftrace-live(1), uftrace-record(1), uftrace-replay(1), uftrace-report(1), uftrace-info(1), uftrace-dump(1), uftrace-recv(1), uftrace-graph(1), uftrace-script(1), uftrace-tui(1)

AUTHORS

Namhyung Kim <namhyung@gmail.com>.

Sep, 2018 Uftrace User Manuals