From bf9e187637ca3d85cee7407e3af93995868cc87c Mon Sep 17 00:00:00 2001 From: Ingo Molnar Date: Tue, 2 Jun 2009 23:37:05 +0200 Subject: [PATCH] perf_counter tools: Make source code headers more coherent The perf commands had different ways of describing themselves, introduce a coherent command-file-header format taken from the Git project. Cc: Peter Zijlstra Cc: Mike Galbraith Cc: Paul Mackerras Cc: Corey Ashford Cc: Marcelo Tosatti Cc: Arnaldo Carvalho de Melo Cc: Thomas Gleixner Cc: John Kacur LKML-Reference: Signed-off-by: Ingo Molnar --- Documentation/perf_counter/builtin-record.c | 11 ++-- Documentation/perf_counter/builtin-report.c | 10 +++- Documentation/perf_counter/builtin-stat.c | 29 ++++++---- Documentation/perf_counter/builtin-top.c | 60 +++++++-------------- Documentation/perf_counter/perf.c | 9 ++++ 5 files changed, 62 insertions(+), 57 deletions(-) diff --git a/Documentation/perf_counter/builtin-record.c b/Documentation/perf_counter/builtin-record.c index 8feb1192e09e..2741b3561bb7 100644 --- a/Documentation/perf_counter/builtin-record.c +++ b/Documentation/perf_counter/builtin-record.c @@ -1,9 +1,14 @@ /* - * perf record: Record the profile of a workload (or a CPU, or a PID) into - * the perf.data output file - for later analysis via perf report. + * builtin-record.c + * + * Builtin record command: Record the profile of a workload + * (or a CPU, or a PID) into the perf.data output file - for + * later analysis via perf report. */ -#include "perf.h" #include "builtin.h" + +#include "perf.h" + #include "util/util.h" #include "util/parse-options.h" #include "util/parse-events.h" diff --git a/Documentation/perf_counter/builtin-report.c b/Documentation/perf_counter/builtin-report.c index 270e986c2d42..9da990fba4a5 100644 --- a/Documentation/perf_counter/builtin-report.c +++ b/Documentation/perf_counter/builtin-report.c @@ -1,6 +1,14 @@ -#include "util/util.h" +/* + * builtin-report.c + * + * Builtin report command: Analyze the perf.data input file, + * look up and read DSOs and symbol information and display + * a histogram of results, along various sorting keys. + */ #include "builtin.h" +#include "util/util.h" + #include "util/list.h" #include "util/cache.h" #include "util/rbtree.h" diff --git a/Documentation/perf_counter/builtin-stat.c b/Documentation/perf_counter/builtin-stat.c index 27abe6a2db3b..2357a663b675 100644 --- a/Documentation/perf_counter/builtin-stat.c +++ b/Documentation/perf_counter/builtin-stat.c @@ -1,20 +1,27 @@ /* - * perf stat: /usr/bin/time -alike performance counter statistics utility + * builtin-stat.c + * + * Builtin stat command: Give a precise performance counters summary + * overview about any workload, CPU or specific PID. + * + * Sample output: - It summarizes the counter events of all tasks (and child tasks), - covering all CPUs that the command (or workload) executes on. - It only counts the per-task events of the workload started, - independent of how many other tasks run on those CPUs. + $ perf stat ~/hackbench 10 + Time: 0.104 - Sample output: + Performance counter stats for '/home/mingo/hackbench': - $ perf stat -e 1 -e 3 -e 5 ls -lR /usr/include/ >/dev/null + 1255.538611 task clock ticks # 10.143 CPU utilization factor + 54011 context switches # 0.043 M/sec + 385 CPU migrations # 0.000 M/sec + 17755 pagefaults # 0.014 M/sec + 3808323185 CPU cycles # 3033.219 M/sec + 1575111190 instructions # 1254.530 M/sec + 17367895 cache references # 13.833 M/sec + 7674421 cache misses # 6.112 M/sec - Performance counter stats for 'ls': + Wall-clock time elapsed: 123.786620 msecs - 163516953 instructions - 2295 cache-misses - 2855182 branch-misses * * Copyright (C) 2008, Red Hat Inc, Ingo Molnar * diff --git a/Documentation/perf_counter/builtin-top.c b/Documentation/perf_counter/builtin-top.c index 5029d8e6cd9c..a63935276cac 100644 --- a/Documentation/perf_counter/builtin-top.c +++ b/Documentation/perf_counter/builtin-top.c @@ -1,49 +1,25 @@ /* - * kerneltop.c: show top kernel functions - performance counters showcase - - Build with: - - make -C Documentation/perf_counter/ - - Sample output: - ------------------------------------------------------------------------------- - KernelTop: 2669 irqs/sec [cache-misses/cache-refs], (all, cpu: 2) ------------------------------------------------------------------------------- - - weight RIP kernel function - ______ ________________ _______________ - - 35.20 - ffffffff804ce74b : skb_copy_and_csum_dev - 33.00 - ffffffff804cb740 : sock_alloc_send_skb - 31.26 - ffffffff804ce808 : skb_push - 22.43 - ffffffff80510004 : tcp_established_options - 19.00 - ffffffff8027d250 : find_get_page - 15.76 - ffffffff804e4fc9 : eth_type_trans - 15.20 - ffffffff804d8baa : dst_release - 14.86 - ffffffff804cf5d8 : skb_release_head_state - 14.00 - ffffffff802217d5 : read_hpet - 12.00 - ffffffff804ffb7f : __ip_local_out - 11.97 - ffffffff804fc0c8 : ip_local_deliver_finish - 8.54 - ffffffff805001a3 : ip_queue_xmit + * builtin-top.c + * + * Builtin top command: Display a continuously updated profile of + * any workload, CPU or specific PID. + * + * Copyright (C) 2008, Red Hat Inc, Ingo Molnar + * + * Improvements and fixes by: + * + * Arjan van de Ven + * Yanmin Zhang + * Wu Fengguang + * Mike Galbraith + * Paul Mackerras + * + * Released under the GPL v2. (and only v2, not any later version) */ - - /* - * Copyright (C) 2008, Red Hat Inc, Ingo Molnar - * - * Improvements and fixes by: - * - * Arjan van de Ven - * Yanmin Zhang - * Wu Fengguang - * Mike Galbraith - * Paul Mackerras - * - * Released under the GPL v2. (and only v2, not any later version) - */ +#include "builtin.h" #include "perf.h" -#include "builtin.h" + #include "util/symbol.h" #include "util/util.h" #include "util/rbtree.h" diff --git a/Documentation/perf_counter/perf.c b/Documentation/perf_counter/perf.c index e8a85842b493..ec7edb7fbe29 100644 --- a/Documentation/perf_counter/perf.c +++ b/Documentation/perf_counter/perf.c @@ -1,4 +1,13 @@ +/* + * perf.c + * + * Performance analysis utility. + * + * This is the main hub from which the sub-commands (perf stat, + * perf top, perf record, perf report, etc.) are started. + */ #include "builtin.h" + #include "util/exec_cmd.h" #include "util/cache.h" #include "util/quote.h" -- 2.30.2