original_kernel/tools/perf/Documentation
Madadi Vineeth Reddy 6fe61cb4ae perf sched: Rename 'switches' column header to 'count' and add usage description, options for latency
Rename 'Switches' to 'Count' and document metrics shown for perf
sched latency output. Also add options possible with perf sched
latency.

Initially, after seeing the output of 'perf sched latency', the term
'Switches' seemed like it's the number of context switches-in for a
particular task, but upon going through the code, it was observed that
it's actually keeping track of number of times a delay was calculated so
that it is used in calculation of the average delay.

Actually, the switches here is a subset of number of context switches-in
because there are some cases where the count is not incremented in
switch-in handler 'add_sched_in_event'. For example when a task is
switched-in while it's state is not ready to run(!= THREAD_WAIT_CPU).

commit d9340c1db3 ("perf sched: Display time in milliseconds,
reorganize output") changed it from the original count to switches.

So, renamed switches to count to make things a bit more clearer and
added the metrics description of latency in the document.

Reviewed-by: Aditya Gupta <adityag@linux.ibm.com>
Signed-off-by: Madadi Vineeth Reddy <vineethr@linux.ibm.com>
Cc: Adrian Hunter <adrian.hunter@intel.com>
Cc: Alexander Shishkin <alexander.shishkin@linux.intel.com>
Cc: Ian Rogers <irogers@google.com>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Jiri Olsa <jolsa@kernel.org>
Cc: Mark Rutland <mark.rutland@arm.com>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Link: https://lore.kernel.org/r/20240328090005.8321-1-vineethr@linux.ibm.com
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
2024-05-10 11:10:03 -03:00
..
Build.txt
Makefile
android.txt
arm-coresight.txt
asciidoc.conf
asciidoctor-extensions.rb
build-docdep.perl
build-xed.txt
callchain-overhead-calculation.txt
cat-texi.perl
db-export.txt
examples.txt
guest-files.txt
guestmount.txt
intel-bts.txt
intel-hybrid.txt
intel-pt.txt
itrace.txt
jit-interface.txt
jitdump-specification.txt
manpage-1.72.xsl
manpage-base.xsl
manpage-bold-literal.xsl
manpage-normal.xsl
manpage-suppress-sp.xsl
perf-annotate.txt perf annotate: Add --type-stat option for debugging 2023-12-23 22:40:13 -03:00
perf-archive.txt
perf-arm-spe.txt perf docs arm_spe: Clarify more SPE requirements related to KPTI 2024-03-21 10:41:27 -03:00
perf-bench.txt
perf-buildid-cache.txt
perf-buildid-list.txt
perf-c2c.txt
perf-config.txt
perf-daemon.txt
perf-data.txt
perf-diff.txt
perf-dlfilter.txt
perf-evlist.txt
perf-ftrace.txt
perf-help.txt
perf-inject.txt
perf-intel-pt.txt perf: script: prefer capstone to XED 2024-02-20 18:07:34 -08:00
perf-iostat.txt
perf-kallsyms.txt
perf-kmem.txt
perf-kvm.txt
perf-kwork.txt
perf-list.txt perf docs: Document bpf event modifier 2024-04-18 22:22:51 -03:00
perf-lock.txt perf docs: Fix man page formatting for 'perf lock' 2023-12-03 21:25:44 -03:00
perf-mem.txt
perf-probe.txt
perf-record.txt
perf-report.txt perf report: Add weight[123] output fields 2024-04-17 12:21:39 -03:00
perf-sched.txt perf sched: Rename 'switches' column header to 'count' and add usage description, options for latency 2024-05-10 11:10:03 -03:00
perf-script-perl.txt
perf-script-python.txt tools: perf: Expose sample ID / stream ID to python scripts 2024-02-02 18:05:40 -08:00
perf-script.txt perf script: Add capstone support for '-F +brstackdisasm' 2024-04-05 10:43:07 -03:00
perf-stat.txt perf stat: Support per-cluster aggregation 2024-02-09 14:59:53 -08:00
perf-test.txt perf test: Reintroduce -p/--parallel and make -S/--sequential the default 2024-04-26 22:28:08 -03:00
perf-timechart.txt
perf-top.txt perf tools: Add -H short option for --hierarchy 2024-01-25 15:24:04 -08:00
perf-trace.txt
perf-version.txt
perf.data-directory-format.txt
perf.data-file-format.txt
perf.txt perf tools: Make it possible to see perf's kernel and module memory mappings 2024-02-08 15:49:39 -08:00
perfconfig.example
security.txt
tips.txt perf Documentation: Add some more hints to tips.txt 2024-02-01 22:18:18 -08:00
topdown.txt