Commit 84c6f88f authored by Hitoshi Mitake's avatar Hitoshi Mitake Committed by Frederic Weisbecker
Browse files

perf lock: Fix and add misc documentally things 



I've forgot to add 'perf lock' line to command-list.txt,
so users of perf could not find perf lock when they type 'perf'.

Fixing command-list.txt requires document
(tools/perf/Documentation/perf-lock.txt).
But perf lock is too much "under construction" to write a
stable document, so this is something like pseudo document for now.

And I wrote description of perf lock at help section of
CONFIG_LOCK_STAT, this will navigate users of lock trace events.

Signed-off-by: default avatarHitoshi Mitake <mitake@dcl.info.waseda.ac.jp>
Cc: Peter Zijlstra <a.p.zijlstra@chello.nl>
Cc: Paul Mackerras <paulus@samba.org>
Cc: Arnaldo Carvalho de Melo <acme@ghostprotocols.net>
LKML-Reference: <1265267295-8388-1-git-send-email-mitake@dcl.info.waseda.ac.jp>
Signed-off-by: default avatarFrederic Weisbecker <fweisbec@gmail.com>
parent 44ee6358

lib/Kconfig.debug

+6 −0
Original line number Diff line number Diff line
@@ -520,6 +520,12 @@ config LOCK_STAT 


	 For more details, see Documentation/lockstat.txt



	 You can analyze lock events with "perf lock", subcommand of perf.

	 If you want to use "perf lock", you need to turn on CONFIG_EVENT_TRACING.



	 CONFIG_LOCK_STAT defines "contended" and "acquired" lock events.

 	 (CONFIG_LOCKDEP defines "acquire" and "release" events.)



config DEBUG_LOCKDEP

	bool "Lock dependency engine debugging"

	depends on DEBUG_KERNEL && LOCKDEP

tools/perf/Documentation/perf-lock.txt

0 → 100644
+29 −0
Original line number Diff line number Diff line 
perf-lock(1)

============



NAME

----

perf-lock - Analyze lock events



SYNOPSIS

--------

[verse]

'perf lock' {record|report|trace}



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 trace' shows raw lock events.



  'perf lock report' reports statistical data.



SEE ALSO

--------

linkperf:perf[1]

tools/perf/command-list.txt

+1 −0
Original line number Diff line number Diff line
@@ -18,3 +18,4 @@ perf-top mainporcelain common 
perf-trace			mainporcelain common

perf-probe			mainporcelain common

perf-kmem			mainporcelain common

perf-lock			mainporcelain common

CRA Git | Maintained and supported by SUSTech CRA and CCSE