zsh-completions/src/_perf

728 lines
40 KiB
Plaintext
Raw Normal View History

2012-03-26 20:54:21 +00:00
#compdef perf
# ------------------------------------------------------------------------------
# Description
# -----------
#
# Completion script for Linux performance counters 3.3 (perf.wiki.kernel.org).
#
# ------------------------------------------------------------------------------
# Authors
# -------
#
# * Julien Nicoulaud <julien.nicoulaud@gmail.com>
2020-05-09 11:44:00 +00:00
# * Shohei YOSHIDA <syohex@gmail.com>
2012-03-26 20:54:21 +00:00
#
# ------------------------------------------------------------------------------
2020-05-09 11:44:00 +00:00
_perf_events() {
local -a events=(${(@f)$(perf list | sed -n -e 's/^ \([^ =]*\).*$/\1/p')})
_values -s ',' 'events' $events
}
_perf_top_fields() {
local fields=(overhead overhead_sys overhead_us overhead_children sample period)
_values -s ',' 'fields' $fields
}
2012-03-26 20:54:21 +00:00
_perf_pids() {
local -a pids=(/proc/[1-9]*(:t))
_values -s ',' 'pids' $pids
}
_perf_stat_command() {
_alternative "_command_names -e" "subcommand:command:(record report)"
}
2020-05-10 23:14:08 +00:00
_perf_c2c_coalesce() {
local columns=(tid pid iaddr dso)
_values -s ',' 'columns' $columns
}
2020-05-11 15:38:29 +00:00
_perf_mem_type() {
local types=(load store)
_values -s ',' 'type' $types
}
2020-05-11 14:17:10 +00:00
_perf_test_list() {
# TODO show test detail
local -a test_list=(${(@f)$(perf test list 2>&1 | sed -n -e 's/^ *\([^ ]*\): \(.*\)$/\1/p')})
_values -s ',' 'test' $test_list
}
2020-05-13 14:14:40 +00:00
_perf_report_sort_keys() {
local -a sort_keys=(
"comm" "pid" "dso" "dso_size" "symbol" "symbol_size" "parent" "cpu"
"socket" "srcline" "srcfile" "weight" "local_weight" "cgroup_id"
"transaction" "overhead" "overhead_sys" "overhead_us" "overhead_guest_sys"
"overhead_guest_us" "sample" "period" "time" "dso_from" "dso_to" "symbol_from"
"symbol_to" "srcline_from" "srcline_to" "mispredict" "in_tx" "abort" "cycles"
"symbol_daddr" "dso_daddr" "locked" "tlb" "mem" "snoop" "dcacheline"
"phys_daddr" "trace" "trace_fields"
)
_values -s ',' 'keys' $sort_keys
}
2020-05-13 00:30:08 +00:00
_perf_branch_filter() {
local -a filters=(
'any:any type of branches'
2020-05-13 14:14:40 +00:00
'any_call:any function call or system call'
'any_ret:any function return or system call return'
'ind_call:any indirect branch'
'call:direct calls, including far (to/from kernel) calls'
'u:only when the branch target is at the user level'
'k:only when the branch target is in the kernel'
'hv:only when the target is at the hypervisor level'
'in_tx:only when the target is in a hardware transaction'
'no_tx:only when the target is not in a hardware transaction'
'abort_tx:only when the target is a hardware transaction abort'
'cond:conditional branches'
'save_type:save branch type during sampling in case binary is not available later'
2020-05-13 00:30:08 +00:00
)
_describe -t filters 'branch filter' filters
}
_perf_clock_id() {
local clocks=(CLOCK_MONOTONIC CLOCK_MONOTONIC_RAW CLOCK_BOOTTIME CLOCK_REALTIME CLOCK_TAI)
_values 'clocks' $clocks
}
2012-03-26 20:54:21 +00:00
_perf() {
local context curcontext="$curcontext" state line
typeset -A opt_args
2012-03-26 20:54:21 +00:00
local ret=1
_arguments -C \
'(- : *)--version[show version number and exit]' \
'(- : *)--help[show help]: :_perf_cmds' \
'1: :_perf_cmds' \
'*::arg:->args' \
&& ret=0
case $state in
(args)
curcontext="${curcontext%:*:*}:perf-cmd-$words[1]:"
case $line[1] in
(annotate)
# TODO Complete CPU list
# TODO Complete disassembler style
_arguments \
'(- : *)'{-a,--all}'[prints all the available commands on the standard output]' \
'(-i --input)'{-i,--input=}'[input file name]: :_files' \
'(-d --dsos)'{-d,--dsos=}'[only consider symbols in these dsos]:dso list' \
'(-s --symbol)'{-s,--symbol=}'[symbol to annotate]:symbol' \
'(-f --force)'{-f,--force}'[do not complain, do it]' \
'(-v --verbose)'{-v,--verbose}'[be more verbose]' \
'(-D --dump-raw-trace)'{-D,--dump-raw-trace}'[dump raw trace in ASCII]' \
'(-k --vmlinux)'{-k,--vmlinux=}'[vmlinux pathname]: :_files' \
'(-m --modules)'{-m,--modules}'[load module symbols]' \
'(-l --print-line)'{-l,--print-line}'[print matching source lines]' \
'(-P --full-paths)'{-P,--full-paths}'[don'\''t shorten the displayed pathnames]' \
'--stdio[use the stdio interface]' \
'--tui[use the TUI interface]' \
'(-C --cpu)'{-C,--cpu}'[only report samples for the list of CPUs provided]:CPU list' \
'--asm-raw[show raw instruction encoding of assembly instructions]' \
'(--no-source)--source[interleave source code with assembly code]' \
'(--source)--no-source[don'\''t interleave source code with assembly code]' \
'--symfs=[look for files with symbols relative to this directory]: :_files -/' \
'(-M --disassembler-style)'{-M,--disassembler-style=}'[set disassembler style for objdump]:disassembler style' \
'1::symbol name' \
&& ret=0
;;
(archive)
_arguments \
'1: :_files' \
&& ret=0
;;
(bench)
# TODO Complete subsystems
# TODO Complete suites
_arguments \
'(-f --format)'{-f,--format=}'[specify format style]: :((default\:mainly\ for\ human\ reading simple\:friendly\ for\ automated\ processing\ by\ scripts))' \
'1::subsystem' \
'2::suite' \
&& ret=0
;;
(buildid-cache)
_arguments \
'(-a --add)'{-a,--add=}'[add specified file to the cache]: :_files' \
'(-f --force)'{-f,--force}'[do not complain, do it]' \
'(-k --kcore)'{-k,--kcore=}'[add specified kcore file to core]:kcore:_files' \
2012-03-26 20:54:21 +00:00
'(-r --remove)'{-r,--remove=}'[remove specified file from the cache]: :_files' \
'(-p,--purge)'{-p,--purge=}'[purge all cached binaries including older caches which have specified path]: :_files' \
'(-P,--purge-all)'{-P,--purge-all}'[puge all cached binaries]' \
'(-M,--missing)'{-M,--missing=}'[list missing build ids in the cache for the specified file]: :_files' \
'(-u,--update)'{-u,--update=}'[update specified file of the cache]: :_files' \
'(-l,--list)'{-l,--list}'[list all valid binaries from cache]' \
2012-03-26 20:54:21 +00:00
'(-v --verbose)'{-v,--verbose}'[be more verbose]' \
'--target-ns=[obtain mount namespace information from the target pid]: :_pids' \
2012-03-26 20:54:21 +00:00
&& ret=0
;;
(buildid-list)
_arguments \
'(-H --with-hits)'{-H,--with-hits}'[show only DSOs with hits]' \
'(-i --input)'{-i,--input=}'[input file name]: :_files' \
'(-f --force)'{-f,--force}'[don'\''t do ownership validation]' \
'(-k --kernel)'{-k,--kernel}'[show running kernel build id]' \
'(-v --verbose)'{-v,--verbose}'[be more verbose]' \
&& ret=0
;;
2020-05-10 10:01:08 +00:00
(c2c)
2020-05-10 23:14:08 +00:00
_arguments \
'1:subcmd:(record report)' \
'*:: :->c2c_args'
2020-05-10 10:01:08 +00:00
;;
(config)
_arguments \
'(-l --list)'{-l,--list}'[show current config variables for all sections]' \
'--user[read or write user config]' \
'--system[read or write system config]' \
&& ret=0
2020-05-10 10:01:08 +00:00
;;
(data)
2020-05-12 14:54:47 +00:00
_arguments \
'1:command:((convert))' \
'*:: :->data_args' \
&& ret=0
2020-05-10 10:01:08 +00:00
;;
2012-03-26 20:54:21 +00:00
(diff)
_arguments \
'(-M --displacement)'{-M,--displacement}'[show position displacement relative to baseline]' \
'(-D --dump-raw-trace)'{-D,--dump-raw-trace}'[dump raw trace in ASCII]' \
'(-m --modules)'{-m,--modules}'[load module symbols]' \
'(-d --dsos)'{-d,--dsos=}'[only consider symbols in these dsos]:dso list' \
'(-C --comms)'{-C,--comms=}'[only consider symbols in these comms]:comm list' \
'(-S --symbols)'{-S,--symbols=}'[only consider these symbols]:symbol list' \
'(-s --sort)'{-s,--sort=}'[sort by key(s)]: :_values -s , key pid comm dso symbol' \
'(-t --field-separator)'{-t,--field-separator=}'[use a special separator character and don'\''t pad with spaces]:separator' \
'(-v --verbose)'{-v,--verbose}'[be verbose, for instance, show the raw counts in addition to the diff]' \
'(-f --force)'{-f,--force}'[don'\''t complain, do it]' \
'--symfs=[look for files with symbols relative to this directory]: :_files -/' \
'1:old file:_files' \
'2:new file:_files' \
&& ret=0
;;
(evlist)
_arguments \
'(-i --input)'{-i,--input=}'[input file name]: :_files' \
&& ret=0
;;
2020-05-10 10:01:08 +00:00
(ftrace)
_arguments \
'(-t --tracer)'{-t,--tracer=}'[tracer to use]:tracer:(function_tracer function)' \
'(-v --verbose)'{-v,--verbose=}'[verbosity level]:level:' \
'(-p --pid)'{-p,--pid=}'[trace on existing process ID]:pids:_perf_pids' \
'(-a --all-cpus)'{-a,--all-cpus}'[force system-wide collection]' \
'(-C --cpu)'{-C,--cpu=}'[only trace for the list of CPUs]:cpu_list:' \
\*{-T,--trace-funcs=}'[only trace functions given by the argument]:func:' \
\*{-N,--notrace-funcs=}'[do not trace functions given by the argument]:func:' \
\*{-G,--graph-funcs=}'[set graph filter on the given function]:func:' \
\*{-g,--nograph-funcs=}'[set graph notrace filter on the given function]:func:' \
'(-D,--graph-depth)'{-D,--graph-depth=}'[set max depth for function graph tracer]' \
&& ret=0
2020-05-10 10:01:08 +00:00
;;
2012-03-26 20:54:21 +00:00
(inject)
_arguments \
'(-b --build-ids)'{-b,--build-ids=}'[inject build-ids into the output stream]:build-id list' \
'(-v --verbose)'{-v,--verbose}'[be more verbose]' \
'(-i --input)'{-i,--input=}'[input file name]:input:_files' \
'(-o --output)'{-o,--output=}'[output file name]:output:_files' \
'(-s --sched-stat)'{-s,--sched-stat}'[merge sched_stat and sched_switch for getting events]' \
'--kallsyms=[kallsyms file]:kallsyms:_files' \
'--itrace=[decode instruction tracing data]' \
'--strip[use with --itrace to strip out non-synthesized events]' \
'(-j --jit)'{-j,--jit}'[process jitdump files]' \
'(-f --force)'{-f,--force}'[do not complain, do it]' \
2012-03-26 20:54:21 +00:00
&& ret=0
;;
(kallsyms)
_arguments \
'(-v --verbose)'{-v,--verbose=}'[increse verbosity level]' \
&& ret=0
2020-05-10 10:01:08 +00:00
;;
2012-03-26 20:54:21 +00:00
(kmem)
# TODO Complete 'record' command
_arguments \
'(-i --input)'{-i,--input=}'[input file name]: :_files' \
'--caller[show per-callsite statistics]' \
'--alloc[show per-allocation statistics]' \
'(-s --sort)'{-s,--sort=}'[sort by output]: :_values -s , key frag hit bytes' \
'(-n --lines)'{-n,--lines}'[print n lines only]:number' \
'1:command:((record\:record\ the\ kmem\ events\ of\ an\ arbitrary\ workload stat\:report\ kernel\ memory\ statistics))' \
&& ret=0
;;
(kvm)
_arguments \
'(-i --input)'{-i,--input=}'[input file name]: :_files' \
'(-o --output)'{-o,--output=}'[output file name]: :_files' \
'--host=[collect host side performance profile]:host' \
'--guest=[collect guest side performance profile]:guest' \
'--guestmount=[guest os root file system mount directory]: :_files -/' \
'--guestkallsyms=[guest os /proc/kallsyms file copy]: :_files' \
'--guestmodules=[guest os /proc/modules file copy]: :_files' \
'--guestvmlinux=[guest os kernel vmlinux]: :_files' \
'1:command:((top record report diff buildid-list))' \
&& ret=0
;;
(list)
_arguments \
'1:event type:((hw\:hardware\ events hardware\:hardware\ events sw\:software\ events software\:software\ events cache\:cache\ events hwcache\:cache\ events tracepoint\:tracepoint\ events))' \
&& ret=0
;;
(lock)
# TODO Complete 'record' command
# TODO Complete 'report' command options
_arguments \
'(-i --input)'{-i,--input=}'[input file name]: :_files' \
'(-v --verbose)'{-v,--verbose}'[be more verbose]' \
'(-D --dump-raw-trace)'{-D,--dump-raw-trace}'[dump raw trace in ASCII]' \
'1:command:((record\:record\ lock\ events trace\:show\ raw\ lock\ events report\:report\ statistical\ data))' \
&& ret=0
;;
2020-05-10 10:01:08 +00:00
(mem)
2020-05-11 15:38:29 +00:00
_arguments \
'(-i --input)'{-i,--input=}'[input file name]:file:_files' \
'(-f --force)'{-f,--force}'[do not ownership validation]' \
'(-t --type)'{-t,--type=}'[select the memory operation type]:type:_perf_mem_type' \
'(-D --dump-raw-samples)'{-D,--dump-raw-trace}'[dump the raw decoded samples]' \
'(-x --field-separator)'{-x,--field-separator=}'[specify the field separator used when raw samples]:separator:' \
'(-C --cpu)'{-C,--cpu=}'[monitor only on the list of CPUs provided]:cpus:' \
'(-U --hide-unresolved)'{-U,--hide-unresolved}'[only display entries resolved to a symbol]' \
'(-p --phys-data)'{-p,--phys-data}'[record/report sample phisical addresses]' \
'1:command:(record report)' \
'*::arg:->mem_args' \
&& ret=0
2020-05-10 10:01:08 +00:00
;;
2012-03-26 20:54:21 +00:00
(probe)
2020-05-10 01:50:16 +00:00
_arguments \
'(-k --vmlinux)'{-k,--vmlinux=}'[specify vmlinux path which has debuginfo]:path:_files' \
'(-m --module)'{-m,--module=}'[specify module name]:modname_or_path:_files' \
'(-s --source)'{-s,--source=}'[specify path to kernel source]:path:_files -/' \
'(-v --verbose -q --quiet)'{-v,--verbose}'[be more verbose]' \
'(-q --quiet -v --verbose)'{-q,--quiet}'[be quiet]' \
\*{-a,--add=}'[define a probe event]:probe:' \
\*{-d,--del=}'[delete probe events]:probe:' \
'(-l --list)'{-l,--list=}'[list up current probe events]:event:' \
'(-L --line)'{-L,--line=}'[show source code lines which can be probed]' \
\*{-V,--vars=}'[show available local variables at given probe point]:probe:' \
'--externs[show external defined variables]' \
'--no-inlines[search only for non-inlined functions]' \
\*{-F,--funcs=}'[show available functions in given module or kernel]:filter:' \
\*{-D,--definition=}'[show trace-event definition]:probe:' \
'*--filter=[set filter]:filter:' \
'(-f --force)'{-f,--force}'[forcibly add events with existing name]' \
'(-n --dry-run)'{-n,--dry-run}'[dry run]' \
'--cache[cache the probes]' \
'--max-probes=[set the maximum number of probe points for an event]:number:' \
'--target-ns=[obtain mount namespace information from the target pid]:pid:_pids' \
'(-x --exec)'{-x,--exec=}'[specify path to the executable of shared library]:path:_files' \
'--demangle-kernel[demangle kernel symbols]' \
&& ret=0
2012-03-26 20:54:21 +00:00
;;
(record)
2020-05-13 00:30:08 +00:00
_arguments \
\*{-e,--events=}'[select the PMU event]:event:_perf_events' \
'*--filter=[event filter]:filter:' \
'--exclude-perf[do not record events issued by perf itself]' \
'(-a --all-cpus)'{-a,--all-cpus}'[system-wide collection from all CPUs]' \
'(-p --pid)'{-p,--pid=}'[record events on existing process ID]:pids:_perf_pids' \
'(-t --tid)'{-t,--tid=}'[record events on existing thread ID]:tids:' \
'(-u --uid)'{-u,--uid=}'[record events in threads owned by uid]:uid:' \
'(-r --realtime)'{-r,--realtime=}'[collect data with this RT SCHED_FIFO priority]:priority:' \
'--no-buffering[collect data without buffering]' \
'(-c --count)'{-c,--count=}'[event period to sample]:period:' \
'(-o --output)'{-o,--output=}'[output file name]:out_file:_files' \
'(-i --no-inherit)'{-i,--no-inherit}'[child tasks do not inherit counters]' \
'(-F --freq)'{-F,--freq=}'[profile at this frequency]:freq:(max)' \
'--string-freq[fail if the specified frequency cannot be used]' \
'(-m --mmap-pages)'{-m,--mmap-pages=}'[number of mmap data pages]:pages:' \
'--group[put all events in a single event group]' \
'-g[enables call-graph recording]' \
'--call-graph=[setup and enable call-graph recording]:method:(fp dwarf lbr)' \
'(-q --quiet)'{-q,--quiet}'[do not print any message]' \
'(-v --verbose)'{-v,--verbose}'[be more verbose]' \
'(-s --stat)'{-s,--stat}'[record per-thread event counts]' \
'(-d --data)'{-d,--data}'[record the sample virtual addresses]' \
'--phys-data[record the sample physical addresses]' \
'(-T --timestamp)'{-T,--timestamp}'[record the sample timestamps]' \
'(-P --period)'{-P,--period}'[record the sample period]' \
'--sample-cpu[record the sample cpu]' \
'(-n --no-samples)'{-n,--no-samples}'[do not sample]' \
'(-C --cpu)'{-C,--cpu=}'[collect samples only on the list of CPUs provided]:cpus:' \
'(-B --no-buildid)'{-B,--no-buildid}'[do not save the build ids of binaries in the perf.data files]' \
'(-N --no-buildid-cache)'{-N,--no-buildid-cache}'[do not update the buildid cache]' \
\*{-G,--cgroup=}'[monitor only in the container (cgroup) called "name"]:name:' \
'(-b --branch-any)'{-b,--branch-any}'[enable taken branch stack sampling]' \
'(-j --branch-filter)'{-j,--branch-filter=}'[specify stack sampling filter]:filter:_perf_branch_filter' \
'--weight[enable weightened sampling]' \
'--namespaces[record events of type PREF_RECORD_NAMESPACES]' \
'--tarnsaction[record transaction flags for transaction related events]' \
'(-D --delay)'{-D,--delay=}'[wait msecs before measuring]' \
'(-I,--intr-regs)'{-I,--intr-regs=}'[capture machine state (registers) at interrupt]:registers:' \
'--user-regs=[capture user registers at sample time]:registers:' \
'--running-time[record running and enabled time for read events]' \
'(-k --clockid)'{-k,--clockid=}'[sets the clockid to use for time fields]:clock_id:_perf_clock_id' \
'--proc-map-timeout=[time out(ms) limit of processing /proc/XXX/mmap]:msecs:' \
'--switch-events[record context switch events]' \
'--clang-path=[path to clang binary to use compiling BPF scripts]:clang_path:_files' \
'--clang-opt=[option passed to clang when compiling BPF scripts]:clang_opt:' \
'--vmlinux=[specify vmlinux path which has debuginfo]:vmlinux_path:_files' \
'--buildid-all[record build-id of all DSOs]' \
'--aio=[use "n" control blocks in asynchronous trace writing mode]:number:' \
'--affinity=[set affinity mask by mode value]' \
'--mmap-flush=[specify minimal number of bytes]:bytes:' \
'(-z --compression-level)'{-z,--compression-level=}'[compressed level]:level:' \
'--all-kernel[configure all used events to run in kernel space]' \
'--all-user[configure all used events to run in user space]' \
'(--user-callchains)--kernel-callchains[collect callchains only from kernel space]' \
'(--kernel-callchains)--user-callchains[collect callchains only from user space]' \
'--timestamp-filename[append timestamp to output file name]' \
'--timestamp-boundary[record timestamp boundary]' \
'--switch-output=[generate multiple perf.data files based on mode]:mode:' \
'--switch-max-files=[when rotating perf.data only keep N files]:number:' \
'--dry-run[parse options then exit]' \
'--tail-synthesize[collect samples during finalization instead of beginning of recording]' \
'--overwrite[makes all events use an overwritable ring buffer]' \
'1:command:_command_names -e' \
'*::args:_normal' \
&& ret=0
2012-03-26 20:54:21 +00:00
;;
(report)
2020-05-13 14:14:40 +00:00
_arguments \
'(-i --input)'{-i,--input=}'[input file name]:file:_files' \
'(-v --verbose)'{-v,--verbose}'[be more verbose]' \
'(-q --quiet)'{-q,--quiet}'[do not show any message]' \
'(-n --show-nr-samples)'{-n,--show-nr-samples}'[show the number of samples for each symbol]' \
'--show-cpu-utilization[show sample percentage for different cpu modes]' \
'(-T --threads)'{-T,--threads}'[show per-thread event counters]' \
'(-c --comms)'{-c,--comms=}'[only condier symbols in these comms]:comms:' \
'--pid=[only show events for given process ID]:pid:_perf_pids' \
'--tid=[only show events for given thread ID]:tid:' \
\*{-d,--dsos=}'[only consider symbols in these dsos]:dsos:' \
\*{-S,--symbols=}'[only consider these symbols]:symbol:' \
'--symbol-filter=[only show symbols that match with this filter]:filter:' \
'(-U --hide-unresolved)'{-U,--hide-unresolved}'[only display entries resolved to a symbol]' \
'(-s --sort)'{-s,--sort=}'[sort histogram entries by given keys]:keys:_perf_report_sort_keys' \
'(-F --fields)'{-F,--fields=}'[specify output field]:field:(overhead overhead_sys overhead_us overhead_children sample period)' \
'(-p --parent)'{-p,--parent=}'[a regex filter to identify parent]:regex:' \
'(-x --exclude-other)'{-x,--exclude-other}'[only display entries with parent-match]' \
'(-w --column-widths)'{-w,--column-widths=}'[force each column width to the provided list]' \
'(-t --field-separator)'{-t,--field-separator=}'[use a special separator character]:sep:' \
'(-D --dump-raw-trace)'{-D,--dump-raw-trace}'[dump raw trace in ASCII]' \
'(-g --call-graph)'{-g,--call-graph=}'[display call chains using this argument]' \
'--children[accumulate callchain of children to parent entry]' \
'--max-stack=[set the stack depth limit]:number:' \
'(-G --inverted)'{-G,--inverted}'[alias for inverted caller based call graph]' \
'--ignore-callees=[regex for ignoring callees of the function]:regex:' \
'--pretty=[pretty printing style]:style:(normal raw)' \
'--stdio[use the stdio interface]' \
'--stdio-color=[color output configuring]:type:(always never auto)' \
'--tui[use the TUI interface]' \
'--gtk[use the GTK2 interface]' \
'(-k --vmlinux --ignore-vmlinux)'{-k,--vmlinux=}'[vmlinux pathname]:vmlinux:_files' \
'(-k --vmlinux)--ignore-vmlinux[ignore vmlinux files]' \
'--kallsyms=[kallsyms pathname]:kallsyms:_files' \
'(-m --modules)'{-m,--modules}'[load module symbols]' \
'(-f --force)'{-f,--force}'[do not do ownership validation]' \
'--symfs=[look for files with symbols relative to this directory]:symfs:_files -/' \
'(-C --cpu)'{-C,--cpu=}'[only report sample for the list of CPUs provided]' \
'(-M --disassembler-style)'{-M,--disassembler-style=}'[set disassembler style for objdump]:style:' \
'--source[interleave source code with assembly code]' \
'--asm-raw[show raw instruction encoding of assembly instructions]' \
'--show-total-period[show a column with sum of periods]' \
'(-I --show-info)'{-I,--show-info}'[display extended information about the perf.data file]' \
'(-b --branch-stack)'{-b,--branch-stack}'[use the addressed of sampled taken branch]' \
'--branch-history[add the addresses of sampled taken branches to the callstack]' \
'--objdump=[path to objdump binary]:path:_files' \
'--group[show event group information together]' \
'--demangle[demangle symbol names to human readable form]' \
'--demangle-kernel[demangle kernel symbol names to human readable form]' \
'--mem-mode[use the data addresses of samples]' \
'--percent-limit=[do not show entries which have an overhead under this percent]:number:' \
'--percentage=[determine how to display the overhead percentage of filtered entries]:number:' \
'--header[show header information in the perf.data file]' \
'--header-only[show only perf.data header]' \
'--time=[only analyze samples within given time window]:time:' \
'--switch-on=[only consider events after this event is found]:event:' \
'--switch-off=[stop considering events after this event is found]:event:' \
'--show-on-off-events[show the --switch-on/off events too]' \
'--itrace=[options for decoding instruction tracing data]' \
'--full-source-path[show the full path for source files]' \
'--show-ref-call-graph[show reference callgraphs]' \
'--socket-filter[only report the samples on the processor socket]' \
'--samples=[save N individual samples for each histogram entry]:number:' \
'--raw-trace[do not use print fmt or plugins]' \
'--hierarchy[enable hierarchical output]' \
'(--no-inline)--inline[print inline stack]' \
'(--inline)--no-inline[do not print inline stack]' \
'--mmaps[show --tasks output plus mmap information]' \
'--ns[show time stamps in nanoseconds]' \
'--stat[display overall events statistics without any further processing]' \
'--tasks[display monitored taks stored in perf data]' \
'--percent-type=[set annotation percent type]:type:(global-period local-period global-hits local-hits)' \
'--time-quantum=[configure time quantum for time sort key]' \
&& ret=0
2012-03-26 20:54:21 +00:00
;;
(sched)
# TODO Complete 'record' command
_arguments \
'(-i --input)'{-i,--input=}'[input file name]: :_files' \
'(-v --verbose)'{-v,--verbose}'[be more verbose]' \
'(-D --dump-raw-trace)'{-D,--dump-raw-trace}'[dump raw trace in ASCII]' \
'1:command:((record\:record\ scheduling\ events script\:see\ a\ detailed\ trace replay\:simulate\ the\ workload map\:print\ a\ textual\ context-switching\ outline))' \
&& ret=0
;;
(script)
# TODO not implemented
;;
(stat)
_arguments \
2020-05-10 23:14:08 +00:00
\*{-e,--events=}'[select the PMU event]:event:_perf_events' \
'(-i --no-inherit)'{-i,--no-inherit}'[child tasks do not inherit conters]' \
'(-p --pid)'{-p,--pid=}'[stat events on existing process id]:pid:_pids' \
'(-t --tid)'{-t,--tid=}'[stat events on existing thread id]:tid:' \
'(-a --all-cpus)'{-a,--all-cpus}'[system-wide collection from all CPUs]' \
'--no-scale[do not scale/normalize counter values]' \
\*{-d,--detailed}'[print more detailed statistics]' \
'(-r --repeat)'{-r,--repeat=}'[repeat command and print average + stddev]:count:' \
'(-B --big-num)'{-B,--big-num}'[print large numbers with thousands separators according to locale]' \
'(-C --cpu)'{-C,--cpu=}'[count only the list of CPUs]:cpus:' \
'(-A --no-aggr)'{-A,--no-aggr}'[do not aggregate counts across all monitored CPUs]' \
'(-n --null)'{-n,--null}'[null run]' \
'(-v --verbose)'{-v,--verbose}'[be more verbose]' \
'(-x --field-seperator)'{-x,--field-separator=}'[print separator]' \
'--table[display time for each run in a table format]' \
'(-G --cgroup)'{-G,--cgroup=}'[monitor only in the container called this name]' \
'(-o --output)'{-o,--output=}'[print the output into this file]:file:_files' \
'--append[append to the output file desinated with -o option]' \
'--log-fd[log output to fd, instead of stderr]' \
'--pre[pre measurement hook]: :_command_names -e' \
'--post[post measurement hook]: :_command_names -e' \
'(-I --interval-print)'{-I,--interval-print=}'[print count deltas every millseconds]:msec:' \
'--interval-count[print count delta for fixed number of times]:times:' \
'--interval-clear[clear the screen before next interval]' \
'--timeout[stop the perf stat session and print count after milliseconds]:msec:' \
'--metric-only[only print compted metrics]' \
'--per-socket[aggregate counts per processor socket for system-wide mode measurements]' \
'--per-die[aggregate counts per processor die for sytem-wide mode measurements]' \
'--per-core[aggregate counts per phisical processor for sytem-wide mode measurements]' \
'--per-thread[aggregate counts per mmonitored threads]' \
'(-D --delay)'{-D,--delay=}'[wait msecs before measuring]:msec:' \
'(-T --transaction)'{-T,--transaction}'[print statistics of transactional execution]' \
'(-)1:command:_perf_stat_command' \
'*::arg:_normal' \
&& ret=0
# TODO report/record sub-subcommand completion
2012-03-26 20:54:21 +00:00
;;
(test)
_arguments \
'(-v --verbose)'{-v,--verbose}'[be more verbose]' \
2020-05-11 14:17:10 +00:00
'(-s --skip)'{-s,--skip=}'[Tests to skip]:tests:_perf_test_list' \
'(-F --dont-fork)'{-F,--dont-fork}'[do not fork child for each test]' \
'1:command:((list))' \
2012-03-26 20:54:21 +00:00
&& ret=0
;;
(timechart)
# TODO Complete 'record' command
_arguments \
'(-i --input)'{-i,--input=}'[input file name]: :_files' \
'(-o --output)'{-o,--output=}'[output file name]: :_files' \
'(-w --width)'{-w,--width=}'[select the width of the SVG file]:width' \
'(-P --power-only)'{-P,--power-only}'[only output the CPU power section of the diagram]' \
'(-p --process)'{-p,--process}'[select the processes to display, by name or PID]:process' \
'--symfs=[look for files with symbols relative to this directory]: :_files -/' \
'1:command:((record))' \
&& ret=0
;;
(top)
2020-05-09 11:44:00 +00:00
_arguments \
'(-a --all-cpus)'{-a,--all-cpus}'[system wide collection]' \
'(-c --count)'{-c,--count=}'[event period to sample]:count:' \
'(-C --cpu)'{-C,--cpu=}'[monitor only the list of CPUs provided]:cpu_list:' \
'(-d --delay)'{-d,--delay=}'[number of seconds to delay between refreshes]' \
2020-05-10 23:14:08 +00:00
\*{-e,--event=}'[select the PMU event]:event:_perf_events' \
2020-05-09 11:44:00 +00:00
'(-E --entries)'{-E,--entries=}'[display thie many functions]' \
'(-f --count-filter)'{-f,--count-filter=}'[only display fnctions with more events than this]:count:' \
'--group[put the counters into a counter group]' \
'(-F --freq)'{-F,--freq=}'[profile at thie frequency]:freq:(max)' \
'(-i --inherit)'{-i,--inherit}'[child tasks do not inherit counters]' \
'(-k --vmlinux --ignore-vmlinux)'{-k,--vmlinux=}'[path to vmlinux]:vmlinux:_files' \
'(-k --vmlinux)--ignore-vmlinux[ignore vmlinux files]' \
'--kallsyms=[kallsyms pathname]:sym_path:_files' \
'(-m --mmap-pages)'{-m,--mmap-pages=}'[number of mmap data pages or size]:number:' \
'(-p --pid)'{-p,--pid=}'[profile events on existing process ID]:pid:_pids' \
'(-t --tid)'{-t,--tid=}'[profile events on existing thread ID]:tid:' \
'(-u --uid)'{-u,--uid=}'[record events in threads owned by uid]:uid:' \
'(-r --realtime)'{-r,--realtime=}'[collect data with this RT SCHED_FIFO priority]:priority:' \
'--sym-annotate=[annotate this symbol]' \
'(-K --hide_kernel_symbols)'{-K,--hide_kernel_symbols}'[hide kernel symbols]' \
'(-U --hide_user_symbols)'{-K,--hide_user_symbols}'[hide user symbols]' \
'--demangle-kernel[demangle kernel symbols]' \
'(-D --dump-symtab)'{-D,--dump-symtab}'[dump the symbol table used for profiling]' \
'(-v --verbose)'{-v,--verbose}'[be more verbose]' \
'(-z --zero)'{-z,--zero}'[zero history access display updates]' \
'(-s --sort)'{-s,--sort}'[sort by keys]' \
'--fields=[specify output field ]:fields:_perf_top_fields' \
'(-n --show-nr-samples)'{-n,--show-nr-samples}'[show a column with the number of samples]' \
'--show-total-period[show a column with the sum of periods]' \
'--dsos[only consider symbols in these dsos]' \
'--comms[only consider symbols in these comms]' \
'--symbols[only consider these symbols]' \
'(-M --disassembler-style)'{-M,--disassembler-style=}'[set disassembler style]:style:' \
'(--no-source)--source[interleave source code with assembly code]' \
'(--source)--no-source[disable interleaving source code]' \
'--asm-raw[show raw instruction encoding of assembly instructions]' \
'-g[Enables call-graph recording]' \
'--call-graph[setup and enable call-graph recording]' \
'--children[accumulate callchain of children to parent entry]' \
'--max-stack[set the stack depth limit]' \
'--ignore-callees=[ignore callees of functions regex]:regex:' \
'--percent-limit[do not show entries which have an overhead under that percent]' \
'(-w --column-widths)'{-w,--column-widths=}'[force each column width to this list]' \
'--proc-map-timeout[set timeout limit for processing process map]' \
'(-b --branch-any)'{-b,--branch-any}'[enable taken branch stack sampling]' \
'(-j --branch-filter)'{-j,--branch-filter}'[enable taken branch stack sampling]' \
'--raw-trace[do not use print fmt or plugins]' \
'--hierarchy[enable hierarchy output]' \
'--overwrite[overwrite records]' \
'--force[do not do ownership validation]' \
'--num-thread-synthesize[threads to run when synthesizing events for existing processes]'\
'--namespaces[record events of type PREF_RECORD_NAMESPACES]' \
'--switch-on=[only consider events after this event is found]:event:' \
'--switch-off=[stop considering events after this event is found]:event:' \
'--show-on-off-events[show the --switch-on/off events too]' \
&& ret=0
2012-03-26 20:54:21 +00:00
;;
2020-05-10 10:01:08 +00:00
(trace)
# TODO not implemented
;;
(version)
_arguments \
'--build-options[the status of compiled-in libraries are printed]' \
&& ret=0
;;
2012-03-26 20:54:21 +00:00
(help)
_arguments \
'(- : *)'{-a,--all}'[prints all the available commands on the standard output]' \
'1: :_perf_cmds' \
&& ret=0
;;
*)
_call_function ret _perf_cmd_$words[1] && ret=0
(( ret )) && _message 'no more arguments'
;;
esac
;;
esac
2020-05-10 23:14:08 +00:00
case $state in
(c2c_args)
case $words[1] in
(record)
_arguments \
\*{-e,--event=}'[select the PMU event]:events:_perf_events' \
'(-v --verbose)'{-v,--verbose}'[be more verbose]' \
'(-l --ldlat)'{-l,--ldlat=}'[configure mem-loads latency]:latency:' \
'(-k --all-kernel)'{-k,--all-kernel}'[configure all used events to run in the kernel space]' \
'(-u --all-user)'{-u,--all-user}'[configure all used events to run in user space]' \
'1:command:_command_names -e' \
'*::args:_normal' \
&& ret=0
;;
(report)
_arguments \
'(-k --vmlinux)'{-k,--vmlinux=}'[vmlinux pathname]:vmlinux:_files' \
'(-v --verbose)'{-v,--verbose}'[be more verbose]' \
'(-i --input)'{-i,--input=}'[specify the input file to process]:proc_file:_files' \
'(-N --node-info)'{-N,--node-info}'[show extra node info in report]' \
'(-c --coalesce)'{-c,--coalesce=}'[specify sorting fields for single cacheline display]:field:_perf_c2c_coalesce' \
'(-g --call-graph)'{-g,--call-graph}'[setup callchains parameters]' \
'--stdio[force the stdio output]' \
'--stats[display only statistic tables]' \
'--full-symbols[display full length of symbols]' \
'--no-source[do not display source line column]' \
'--show-all[show all captured HITM lines]' \
'(-f --force)'{-f,--force}'[do not do ownership validation]' \
'(-d --display)'{-d,--display=}'[switch to HITM type]:hitm_type:(rmt lcl)' \
&& ret=0
;;
esac
;;
2020-05-12 14:54:47 +00:00
(data_args)
if [[ $words[1] == "convert" ]]; then
_arguments \
'--to-ctf=[specify the path of CTF data directory]:data_dir:_files -/' \
'-i[specify input perf data file path]:path:_files' \
'(-f --force)'{-f,--force}'[do not complain do it]' \
'(-v --verbose)'{-v,--verbose}'[be more verbose]' \
'--all[convert all events including non-sample events to output]' \
&& ret=0
fi
;;
2020-05-11 15:38:29 +00:00
(mem_args)
case $words[1] in
(record)
_arguments \
\*{-e,--event=}'[event selector]:events:_perf_events' \
'(-K --all-kernel)'{-K,--all-kernel}'[configure all used events to run in kernel space]' \
'(-U --all-user)'{-K,--all-user}'[configure all used events to run in user space]' \
'(-v --verbose)'{-v,--verbose}'[be more verbose]' \
'--ldlat=[specify desired latency for loads event]:latency:' \
'1:command:_command_names -e' \
'*::args:_normal' \
&& ret=0
;;
esac
;;
2020-05-10 23:14:08 +00:00
esac
2012-03-26 20:54:21 +00:00
}
# FIXME Parse 'perf --help' instead of hard-coding.
(( $+functions[_perf_cmds] )) ||
_perf_cmds() {
local commands; commands=(
'annotate:read perf.data (created by perf record) and display annotated code'
'archive:create archive with object files with build-ids found in perf.data file'
'bench:general framework for benchmark suites'
'buildid-cache:manage build-id cache'
'buildid-list:list the buildids in a perf.data file'
2020-05-10 10:01:08 +00:00
'c2c:shared data C2C/HITM analyzer'
'config:get and set variables in a configuration file'
'data:data file related processing'
2012-03-26 20:54:21 +00:00
'diff:read two perf.data files and display the differential profile'
'evlist:list the event names in a perf.data file'
2020-05-10 10:01:08 +00:00
'ftrace:simple wrapper for kernel ftrace functionality'
2012-03-26 20:54:21 +00:00
'inject:filter to augment the events stream with additional information'
2020-05-10 10:01:08 +00:00
'kallsyms:searches running kernel for symbols'
2012-03-26 20:54:21 +00:00
'kmem:tool to trace/measure kernel memory(slab) properties'
'kvm:tool to trace/measure kvm guest os'
'list:list all symbolic event types'
'lock:analyze lock events'
2020-05-10 10:01:08 +00:00
'mem:profile memory access'
2012-03-26 20:54:21 +00:00
'probe:define new dynamic tracepoints'
'record:run a command and record its profile into perf.data'
'report:read perf.data (created by perf record) and display the profile'
'sched:tool to trace/measure scheduler properties (latencies)'
'script:read perf.data (created by perf record) and display trace output'
'stat:run a command and gather performance counter statistics'
'test:runs sanity tests'
'timechart:tool to visualize total system behavior during a workload'
'top:system profiling tool'
2020-05-10 10:01:08 +00:00
'trace:strace inspired tool'
'version:display the version of perf binary'
2012-03-26 20:54:21 +00:00
'help:show command usage information'
)
_describe -t commands 'command' commands "$@"
}
_perf "$@"
# Local Variables:
# mode: Shell-Script
# sh-indentation: 2
# indent-tabs-mode: nil
# sh-basic-offset: 2
# End:
# vim: ft=zsh sw=2 ts=2 et