'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 data.

'perf lock script' shows raw lock events.

'perf lock info' shows metadata like threads or addresses
of lock instances.

'perf lock contention' shows contention statistics.

Input file name. (default: perf.data unless stdin is a fifo)

Output file name for perf lock contention and report.

Be more verbose (show symbol address, etc).

Do not show any warnings or messages. (Suppress -v)

Dump raw trace in ASCII.

Don’t complain, do it.

vmlinux pathname

kallsyms pathname

Sorting key. Possible values: acquired (default), contended, avg_wait, wait_total, wait_max, wait_min.

Output fields. By default it shows all the fields but users can customize that using this. Possible values: acquired, contended, avg_wait, wait_total, wait_max, wait_min.

Merge lock instances in the same class (based on name).

The -t option is to show per-thread lock stat like below:

Display this many entries.

dump thread list in perf.data

dump map of lock instances (address:name table)

-k::
--key=<value>::


        Sorting key. Possible values: contended, wait_total (default),


        wait_max, wait_min, avg_wait.
-F::
--field=<value>::


        Output fields. By default it shows all but the wait_min fields


        and users can customize that using this.  Possible values:


        contended, wait_total, wait_max, wait_min, avg_wait.
-t::
--threads::


        Show per-thread lock contention stat
-b::
--use-bpf::


        Use BPF program to collect lock contention stats instead of


        using the input data.
-a::
--all-cpus::


        System-wide collection from all CPUs.
-C::
--cpu=<value>::


        Collect samples only on the list of CPUs provided. Multiple CPUs can be


        provided as a comma-separated list with no space: 0,1. Ranges of CPUs


        are specified with -: 0-2.  Default is to monitor all CPUs.
-p::
--pid=<value>::


        Record events on existing process ID (comma separated list).
--tid=<value>::


        Record events on existing thread ID (comma separated list).
-M::
--map-nr-entries=<value>::


        Maximum number of BPF map entries (default: 16384).


        This will be aligned to a power of 2.
--max-stack=<value>::


        Maximum stack depth when collecting lock contention (default: 8).
--stack-skip=<value>::


        Number of stack depth to skip when finding a lock caller (default: 3).
-E::
--entries=<value>::


        Display this many entries.
-l::
--lock-addr::


        Show lock contention stat by address
-o::
--lock-owner::


        Show lock contention stat by owners.  Implies --threads and


        requires --use-bpf.
-Y::
--type-filter=<value>::


        Show lock contention only for given lock types (comma separated list).


        Available values are:


          semaphore, spinlock, rwlock, rwlock:R, rwlock:W, rwsem, rwsem:R, rwsem:W,


          rtmutex, rwlock-rt, rwlock-rt:R, rwlock-rt:W, pcpu-sem, pcpu-sem:R, pcpu-sem:W,


          mutex


        Note that RW-variant of locks have :R and :W suffix.  Names without the


        suffix are shortcuts for the both variants.  Ex) rwsem = rwsem:R + rwsem:W.
-L::
--lock-filter=<value>::


        Show lock contention only for given lock addresses or names (comma separated list).
-S::
--callstack-filter=<value>::


        Show lock contention only if the callstack contains the given string.


        Note that it matches the substring so 'rq' would match both 'raw_spin_rq_lock'


        and 'irq_enter_rcu'.
-x::
--field-separator=<SEP>::


        Show results using a CSV-style output to make it easy to import directly


        into spreadsheets. Columns are separated by the string specified in SEP.
SEE ALSO
--------
linkperf:perf[1]