From: David Ahern <dsah...@gmail.com> Add entry to perf-sched documentation for timehist command and its options.
Signed-off-by: David Ahern <dsah...@gmail.com> Signed-off-by: Namhyung Kim <namhy...@kernel.org> --- tools/perf/Documentation/perf-sched.txt | 46 +++++++++++++++++++++++++++++++-- 1 file changed, 44 insertions(+), 2 deletions(-) diff --git a/tools/perf/Documentation/perf-sched.txt b/tools/perf/Documentation/perf-sched.txt index 1cc08cc47ac5..a0344643f008 100644 --- a/tools/perf/Documentation/perf-sched.txt +++ b/tools/perf/Documentation/perf-sched.txt @@ -8,11 +8,11 @@ perf-sched - Tool to trace/measure scheduler properties (latencies) SYNOPSIS -------- [verse] -'perf sched' {record|latency|map|replay|script} +'perf sched' {record|latency|map|replay|script|timehist} DESCRIPTION ----------- -There are five variants of perf sched: +There are several variants of perf sched: 'perf sched record <command>' to record the scheduling events of an arbitrary workload. @@ -36,6 +36,11 @@ There are five variants of perf sched: are running on a CPU. A '*' denotes the CPU that had the event, and a dot signals an idle CPU. + 'perf sched timehist' to show context-switching analysis with times + between schedule-in, schedule delay, and run time. If callchains are + present stack trace is dumped at the end of the line. A summary of + run times can be shown as well. + OPTIONS ------- -i:: @@ -66,6 +71,43 @@ OPTIONS for 'perf sched map' --color-pids:: Highlight the given pids. +OPTIONS for 'perf sched timehist' +--------------------------------- +-k:: +--vmlinux=<file>:: + vmlinux pathname + +--kallsyms=<file>:: + kallsyms pathname + +-s:: +--summary:: + Show only a summary of scheduling by thread with min, max, and average + run times (in sec) and relative stddev. + +-S:: +--with-summary:: + Show all scheduling events followed by a summary by thread with min, + max, and average run times (in sec) and relative stddev. + +-w:: +--wakeups:: + Show wakeup events. + +--call-graph:: + Display call chains. Default is on. Use --no-call-graph to suppress + +--max-stack:: + Set the stack depth limit when showing the callchains. Default: 5 + +--symfs=<directory>:: + Look for files with symbols relative to this directory. + +-V:: +--cpu-visual:: + Add a visual that better emphasizes activity by cpu. Idle times + are denoted with 'i'; schedule events with an 's'. + SEE ALSO -------- linkperf:perf-record[1] -- 2.10.1