This change restores the previous default behaviour for "perf lock
report", making the current aggregate-by-address behaviour available via
the new "--lock-addr" command line parameter.
This makes the behaviour consistent with "perf lock contention" (which
also aggregates by caller by default, or by address when "--lock-addr"
is specified).
Commit 688d2e8de231 ("perf lock contention: Add -l/--lock-addr option")
introduced aggregation modes for "perf lock contention" and (potentially
inadvertently) changed the behaviour of "perf lock report" from
aggregate-by-caller to aggregate-by-address (making the prior behaviour
inaccessible).
Example aggregate-by-address output:
$ perf lock report -F acquired
Name acquired
event_mutex 34
21
1
Example aggregate-by-caller output:
$ perf lock report -F acquired
Name acquired
perf_trace_init+... 34
lock_mm_and_find... 20
inherit_event.co... 1
do_madvise+0x1f8 1
Cc: stable@kernel.org
Fixes: 688d2e8de231 ("perf lock contention: Add -l/--lock-addr option")
Signed-off-by: Nick Forrington <nick.forrington@arm.com>
---
tools/perf/Documentation/perf-lock.txt | 4 ++++
tools/perf/builtin-lock.c | 24 +++++++++++++++++++++---
2 files changed, 25 insertions(+), 3 deletions(-)
diff --git a/tools/perf/Documentation/perf-lock.txt b/tools/perf/Documentation/perf-lock.txt
index 503abcba1438..349333acbbfc 100644
--- a/tools/perf/Documentation/perf-lock.txt
+++ b/tools/perf/Documentation/perf-lock.txt
@@ -80,6 +80,10 @@ REPORT OPTIONS
--combine-locks::
Merge lock instances in the same class (based on name).
+-l::
+--lock-addr::
+ Show lock contention stat by address
+
-t::
--threads::
The -t option is to show per-thread lock stat like below:
diff --git a/tools/perf/builtin-lock.c b/tools/perf/builtin-lock.c
index fa7419978353..3aa8ba5ad928 100644
--- a/tools/perf/builtin-lock.c
+++ b/tools/perf/builtin-lock.c
@@ -78,7 +78,7 @@ struct callstack_filter {
static struct lock_filter filters;
-static enum lock_aggr_mode aggr_mode = LOCK_AGGR_ADDR;
+static enum lock_aggr_mode aggr_mode = LOCK_AGGR_CALLER;
static bool needs_callstack(void)
{
@@ -1983,8 +1983,8 @@ static int __cmd_report(bool display_info)
if (select_key(false))
goto out_delete;
- if (show_thread_stats)
- aggr_mode = LOCK_AGGR_TASK;
+ aggr_mode = show_thread_stats ? LOCK_AGGR_TASK :
+ show_lock_addrs ? LOCK_AGGR_ADDR : LOCK_AGGR_CALLER;
err = perf_session__process_events(session);
if (err)
@@ -2008,6 +2008,19 @@ static void sighandler(int sig __maybe_unused)
{
}
+static int check_lock_report_options(const struct option *options,
+ const char * const *usage)
+{
+ if (show_thread_stats && show_lock_addrs) {
+ pr_err("Cannot use thread and addr mode together\n");
+ parse_options_usage(usage, options, "threads", 0);
+ parse_options_usage(NULL, options, "lock-addr", 0);
+ return -1;
+ }
+
+ return 0;
+}
+
static int check_lock_contention_options(const struct option *options,
const char * const *usage)
@@ -2589,6 +2602,7 @@ int cmd_lock(int argc, const char **argv)
/* TODO: type */
OPT_BOOLEAN('c', "combine-locks", &combine_locks,
"combine locks in the same class"),
+ OPT_BOOLEAN('l', "lock-addr", &show_lock_addrs, "show lock stats by address"),
OPT_BOOLEAN('t', "threads", &show_thread_stats,
"show per-thread lock stats"),
OPT_INTEGER('E', "entries", &print_nr_entries, "display this many functions"),
@@ -2680,6 +2694,10 @@ int cmd_lock(int argc, const char **argv)
if (argc)
usage_with_options(report_usage, report_options);
}
+
+ if (check_lock_report_options(report_options, report_usage) < 0)
+ return -1;
+
rc = __cmd_report(false);
} else if (!strcmp(argv[0], "script")) {
/* Aliased to 'perf script' */
--
2.42.0
On 31/10/2023 12:05, Nick Forrington wrote:
> This change restores the previous default behaviour for "perf lock
> report", making the current aggregate-by-address behaviour available via
> the new "--lock-addr" command line parameter.
>
> This makes the behaviour consistent with "perf lock contention" (which
> also aggregates by caller by default, or by address when "--lock-addr"
> is specified).
>
> Commit 688d2e8de231 ("perf lock contention: Add -l/--lock-addr option")
> introduced aggregation modes for "perf lock contention" and (potentially
> inadvertently) changed the behaviour of "perf lock report" from
> aggregate-by-caller to aggregate-by-address (making the prior behaviour
> inaccessible).
>
> Example aggregate-by-address output:
>
> $ perf lock report -F acquired
> Name acquired
>
> event_mutex 34
> 21
> 1
>
> Example aggregate-by-caller output:
>
> $ perf lock report -F acquired
> Name acquired
>
> perf_trace_init+... 34
> lock_mm_and_find... 20
> inherit_event.co... 1
> do_madvise+0x1f8 1
>
> Cc: stable@kernel.org
> Fixes: 688d2e8de231 ("perf lock contention: Add -l/--lock-addr option")
> Signed-off-by: Nick Forrington <nick.forrington@arm.com>
> ---
> tools/perf/Documentation/perf-lock.txt | 4 ++++
> tools/perf/builtin-lock.c | 24 +++++++++++++++++++++---
> 2 files changed, 25 insertions(+), 3 deletions(-)
>
Reviewed-by: James Clark <james.clark@arm.com>
> diff --git a/tools/perf/Documentation/perf-lock.txt b/tools/perf/Documentation/perf-lock.txt
> index 503abcba1438..349333acbbfc 100644
> --- a/tools/perf/Documentation/perf-lock.txt
> +++ b/tools/perf/Documentation/perf-lock.txt
> @@ -80,6 +80,10 @@ REPORT OPTIONS
> --combine-locks::
> Merge lock instances in the same class (based on name).
>
> +-l::
> +--lock-addr::
> + Show lock contention stat by address
> +
> -t::
> --threads::
> The -t option is to show per-thread lock stat like below:
> diff --git a/tools/perf/builtin-lock.c b/tools/perf/builtin-lock.c
> index fa7419978353..3aa8ba5ad928 100644
> --- a/tools/perf/builtin-lock.c
> +++ b/tools/perf/builtin-lock.c
> @@ -78,7 +78,7 @@ struct callstack_filter {
>
> static struct lock_filter filters;
>
> -static enum lock_aggr_mode aggr_mode = LOCK_AGGR_ADDR;
> +static enum lock_aggr_mode aggr_mode = LOCK_AGGR_CALLER;
>
> static bool needs_callstack(void)
> {
> @@ -1983,8 +1983,8 @@ static int __cmd_report(bool display_info)
> if (select_key(false))
> goto out_delete;
>
> - if (show_thread_stats)
> - aggr_mode = LOCK_AGGR_TASK;
> + aggr_mode = show_thread_stats ? LOCK_AGGR_TASK :
> + show_lock_addrs ? LOCK_AGGR_ADDR : LOCK_AGGR_CALLER;
>
> err = perf_session__process_events(session);
> if (err)
> @@ -2008,6 +2008,19 @@ static void sighandler(int sig __maybe_unused)
> {
> }
>
> +static int check_lock_report_options(const struct option *options,
> + const char * const *usage)
> +{
> + if (show_thread_stats && show_lock_addrs) {
> + pr_err("Cannot use thread and addr mode together\n");
> + parse_options_usage(usage, options, "threads", 0);
> + parse_options_usage(NULL, options, "lock-addr", 0);
> + return -1;
> + }
> +
> + return 0;
> +}
> +
> static int check_lock_contention_options(const struct option *options,
> const char * const *usage)
>
> @@ -2589,6 +2602,7 @@ int cmd_lock(int argc, const char **argv)
> /* TODO: type */
> OPT_BOOLEAN('c', "combine-locks", &combine_locks,
> "combine locks in the same class"),
> + OPT_BOOLEAN('l', "lock-addr", &show_lock_addrs, "show lock stats by address"),
> OPT_BOOLEAN('t', "threads", &show_thread_stats,
> "show per-thread lock stats"),
> OPT_INTEGER('E', "entries", &print_nr_entries, "display this many functions"),
> @@ -2680,6 +2694,10 @@ int cmd_lock(int argc, const char **argv)
> if (argc)
> usage_with_options(report_usage, report_options);
> }
> +
> + if (check_lock_report_options(report_options, report_usage) < 0)
> + return -1;
> +
> rc = __cmd_report(false);
> } else if (!strcmp(argv[0], "script")) {
> /* Aliased to 'perf script' */
© 2016 - 2025 Red Hat, Inc.