Section 1: user commands and tools
NAME perf-stat – Run a command and gather performance counter statistics SYNOPSIS perf stat[-e<EVENT> | –event = EVENT][-a]<command> perf stat[-e<EVENT> | –event = EVENT][-a]– – <command>[<options>] DESCRIPTION This command runs a command and gathers performance counter statistics from it. OPTIONS <command>… Any command you can specify in a shell. -e, –event= Select the PMU event….
NAME perf-script – Read perf.data (created by perf record) and display trace output SYNOPSIS perf script[<options>] perf script[<options>] record<script>[<record – options>]<command> perf script[<options>] report<script>[script – args] perf script[<options>]<script><required – script – args>[<record – options>]<command> perf script[<options>]<top – script>[script – args] DESCRIPTION This command reads the input file and displays the trace recorded. There are several…
NAME perf-script-python – Process trace data with a Python script SYNOPSIS perf script [-s[Python]:script[.py]] DESCRIPTION This perf script option is used to process perf script data using perf’s built-in Python interpreter. It reads and processes the input file and displays the results of the trace analysis implemented in the given Python script, if any. A…
NAME perf-script-perl – Process trace data with a Perl script SYNOPSIS perf script [-s[Perl]:script[.pl]] DESCRIPTION This perf script option is used to process perf script data using perf’s built-in Perl interpreter. It reads and processes the input file and displays the results of the trace analysis implemented in the given Perl script, if any. STARTER…
NAME perf-sched – Tool to trace/measure scheduler properties (latencies) SYNOPSIS perf sched {record|latency|map|replay|script} DESCRIPTION There are five variants of perf sched: ‘perf sched record <command>’ to record the scheduling events of an arbitrary workload. ‘perf sched latency’ to report the per task scheduling latencies and other scheduling properties of the workload. ‘perf sched script’ to…
NAME perf-report – Read perf.data (created by perf record) and display the profile SYNOPSIS perf report [-i <file> | –input=file] DESCRIPTION This command displays the performance counter profile information recorded via perf record. OPTIONS -i, –input= Input file name. (default: perf.data unless stdin is a fifo) -v, –verbose Be more verbose. (show symbol address, etc)…
NAME perf-record – Run a command and record its profile into perf.data SYNOPSIS perf record[-e<EVENT> | –event = EVENT][-l][-a]<command> perf record[-e<EVENT> | –event = EVENT][-l][-a]– – <command>[<options>] DESCRIPTION This command runs a command and gathers a performance counter profile from it, into perf.data – without displaying anything. This file can then be inspected later on,…
NAME perf-probe – Define new dynamic tracepoints SYNOPSIS perf probe[options]– add = PROBE[…] or perf probe[options] PROBE or perf probe[options]– del = [GROUP:] EVENT[…] or perf probe– list or perf probe[options]– line = LINE or perf probe[options]– vars = PROBEPOINT DESCRIPTION This command defines dynamic tracepoint events, by symbol and registers without debuginfo, or by…
NAME perf-mem – Profile memory accesses SYNOPSIS perf mem[<options>](record[<command>] | report) DESCRIPTION "perf mem -t <TYPE> record" runs a command and gathers memory operation data from it, into perf.data. Perf record options are accepted and are passed through. "perf mem -t <TYPE> report" displays the result. It invokes perf report with the right set of…
NAME perf-lock – Analyze lock events SYNOPSIS perf lock {record|report|script|info} DESCRIPTION You can analyze various lock behaviours and statistics with this perf lock command. ‘perf lock record <command>’ records lock events between start and end <command>. And this command produces the file "perf.data" which contains tracing results of lock events. ‘perf lock report’ reports statistical…
NAME perf-list – List all symbolic event types SYNOPSIS perf list [hw|sw|cache|tracepoint|pmu|event_glob] DESCRIPTION This command displays the symbolic event types which can be selected in the various perf commands with the -e option. EVENT MODIFIERS Events can optionally have a modifier by appending a colon and one or more modifiers. Modifiers allow the user to…
NAME perf-kvm – Tool to trace/measure kvm guest os SYNOPSIS perf kvm[–host][–guest][–guestmount = <path>[–guestkallsyms = <path> –guestmodules = <path> | –guestvmlinux = <path>]]{top | record | report | diff | buildid – list}[<options>] perf kvm[–host][–guest][–guestkallsyms = <path> –guestmodules = <path> | –guestvmlinux = <path>]{top | record | report | diff | buildid – list |…
NAME perf-kmem – Tool to trace/measure kernel memory(slab) properties SYNOPSIS perf kmem{record | stat}[<options>] DESCRIPTION There are two variants of perf kmem: ‘perf kmem record <command>’ to record the kmem events of an arbitrary workload. ‘perf kmem stat’ to report kernel memory statistics. OPTIONS -i <file>, –input=<file> Select the input file (default: perf.data unless stdin…
NAME perf-inject – Filter to augment the events stream with additional information SYNOPSIS perf inject <options> DESCRIPTION perf-inject reads a perf-record event stream and repipes it to stdout. At any point the processing code can inject other events into the event stream – in this case build-ids (-b option) are read and injected as needed…
NAME perf-help – display help information about perf SYNOPSIS perf help [-a|–all] [COMMAND] DESCRIPTION With no options and no COMMAND given, the synopsis of the perf command and a list of the most commonly used perf commands are printed on the standard output. If the option –all or -a is given, then all available commands…
NAME perf-evlist – List the event names in a perf.data file SYNOPSIS perf evlist <options> DESCRIPTION This command displays the names of events sampled in a perf.data file. OPTIONS -i, –input= Input file name. (default: perf.data unless stdin is a fifo) -F, –freq= Show just the sample frequency used for each event. -v, –verbose= Show…
NAME perf-diff – Read perf.data files and display the differential profile SYNOPSIS perf diff[baseline file][data file1][[data file2]…] DESCRIPTION This command displays the performance difference amongst two or more perf.data files captured via perf record. If no parameters are passed it will assume perf.data.old and perf.data. The differential profile is displayed only for events matching both…
NAME perf-buildid-list – List the buildids in a perf.data file SYNOPSIS perf buildid-list <options> DESCRIPTION This command displays the buildids found in a perf.data file, so that other tools can be used to fetch packages with matching symbol tables for use by perf report. It can also be used to show the build id of…
NAME perf-buildid-cache – Manage build-id cache. SYNOPSIS perf buildid-cache <options> DESCRIPTION This command manages the build-id cache. It can add and remove files to/from the cache. In the future it should as well purge older entries, set upper limits for the space used by the cache, etc. OPTIONS -a, –add= Add specified file to the…
NAME perf-bench – General framework for benchmark suites SYNOPSIS perf bench[<common options>]<subsystem><suite>[<options>] DESCRIPTION This perf bench command is a general framework for benchmark suites. COMMON OPTIONS -r, –repeat= Specify amount of times to repeat the run (default 10). -f, –format= Specify format style. Current available format styles are: default Default style. This is mainly for…