Skip to contentSkip to conversation

perf tools: Add progress diagnostics and a false-sharing workload

PATCH Superseded Arnaldo Carvalho de Melo 2 participants 9 messages Sep 28 perf events

v1 of 12 Superseded Latest is v12 →

lore
Share & tools
lore

Arnaldo Carvalho de Melo

author maintainer
#0 lore raw

cover perf tools: Add progress diagnostics and a false-sharing workload

Hi,

This series adds progress and stuck-process diagnostics to perf, and a workload that makes false sharing visible to data type profiling.

The changes are:

- move perf_config__set_variable() to util/config.c and serialize config parser and read-modify-write state, so non-builtin perf code can persist configuration changes safely;

- add 'perf report --progress' for stdio users, showing the current phase,

    percentage, and counts while a session is processed;

- add the prototype tools/perf/scripts/perf-stuck.sh helper, which samples a running perf process and can invoke the accompanying GDB commands when progress stops;

- add 'perf test -w false_sharing', a synthetic TCP-shaped workload with identity and packet counters sharing a cacheline, and include it in the data type profiling shell test.

The progress backend handles nested phases and completes them on error paths as well as successful paths. The false-sharing workload uses a shared volatile instance so the data type profiler can resolve direct accesses to the individual members.

The perf-stuck helper is intentionally a prototype and requires the usual /proc access; its optional GDB mode additionally requires gdb and suitable debug information. When only one CPU is available, the false-sharing workload warns that it cannot produce cross-CPU traffic but still runs.

Best regards,

- Arnaldo

 tools/perf/Documentation/perf-report.txt      |  13 ++
 tools/perf/builtin-config.c                   |  70 +-------
 tools/perf/builtin-report.c                   |  10 ++
 tools/perf/scripts/perf-stuck.gdb             | 106 ++++++++++++
 tools/perf/scripts/perf-stuck.sh              | 181 ++++++++++++++++++++
 tools/perf/tests/builtin-test.c               |   1 +
 tools/perf/tests/shell/data_type_profiling.sh |   9 +-
 tools/perf/tests/tests.h                      |   1 +
 tools/perf/tests/workloads/Build              |   2 +
 tools/perf/tests/workloads/false_sharing.c    | 236 ++++++++++++++++++++++++++
 tools/perf/ui/Build                           |   1 +
 tools/perf/ui/progress.h                      |   2 +
 tools/perf/ui/stdio/progress.c                | 162 ++++++++++++++++++
 tools/perf/util/config.c                      | 124 +++++++++++++-
 tools/perf/util/config.h                      |   2 +
 tools/perf/util/ordered-events.c              |  16 +-
 tools/perf/util/session.c                     |  12 +-
 17 files changed, 865 insertions(+), 83 deletions(-)

base-commit: 0ae6fc78c5ce0dfd
--

Assisted-by OpenCode: GPT-5.6 Luna
author maintainer
#1 lore raw

PATCH 1/4 perf config: Move perf_config__set_variable() to util/config.c

From: Arnaldo Carvalho de Melo <[email protected]>

Move perf_config__set_variable() out of the 'perf config' builtin so that opt-in features can persist their choice from outside it, e.g. util/debuginfo.c writing core.debuginfod=false when the user disables debuginfod for the rest of the session. The
set_config() body becomes perf_config_set__write(), with the system_config choice as an argument, as the builtin's use_system_config/use_user_config statics are not available outside it.

All config file access shares the static parser state and can now run on more than one thread, with a feature writing the config while perf top's display thread reads it, so serialize parsing and rewriting with a mutex, and the whole read-modify-write of perf_config__set_variable() against itself.

---
 tools/perf/builtin-config.c |  70 +-------------------
 tools/perf/util/config.c    | 124 ++++++++++++++++++++++++++++++++++--
 tools/perf/util/config.h    |   2 +
 3 files changed, 122 insertions(+), 74 deletions(-)
tools/perf/builtin-config.c +1 -69
index cefd042e4f853466..3b074aca8d344539 100644
@@ -41,37 +41,7 @@ static struct option config_options[] = {
 
 static int set_config(struct perf_config_set *set, const char *file_name)
 {
-	struct perf_config_section *section = NULL;
-	struct perf_config_item *item = NULL;
-	const char *first_line = "# this file is auto-generated.";
-	FILE *fp;
-
-	if (set == NULL)
-		return -1;
-
-	fp = fopen(file_name, "w");
-	if (!fp)
-		return -1;
-
-	fprintf(fp, "%s\n", first_line);
-
-	/* overwrite configvariables */
-	perf_config_items__for_each_entry(&set->sections, section) {
-		if (!use_system_config && section->from_system_config)
-			continue;
-		fprintf(fp, "[%s]\n", section->name);
-
-		perf_config_items__for_each_entry(&section->items, item) {
-			if (!use_system_config && item->from_system_config)
-				continue;
-			if (item->value)
-				fprintf(fp, "\t%s = %s\n",
-					item->name, item->value);
-		}
-	}
-	fclose(fp);
-
-	return 0;
+	return perf_config_set__write(set, file_name, use_system_config);
 }
 
 static int show_spec_config(struct perf_config_set *set, const char *var)
@@ -158,44 +128,6 @@ static int parse_config_arg(char *arg, char **var, char **value)
 	return 0;
 }
 
-int perf_config__set_variable(const char *var, const char *value)
-{
-	char path[PATH_MAX];
-	char *user_config = mkpath(path, sizeof(path), "%s/.perfconfig", getenv("HOME"));
-	const char *config_filename;
-	struct perf_config_set *set;
-	int ret = -1;
-
-	if (use_system_config)
-		config_exclusive_filename = perf_etc_perfconfig();
-	else if (use_user_config)
-		config_exclusive_filename = user_config;
-
-	if (!config_exclusive_filename)
-		config_filename = user_config;
-	else
-		config_filename = config_exclusive_filename;
-
-	set = perf_config_set__new();
-	if (!set)
-		goto out_err;
-
-	if (perf_config_set__collect(set, config_filename, var, value) < 0) {
-		pr_err("Failed to add '%s=%s'\n", var, value);
-		goto out_err;
-	}
-
-	if (set_config(set, config_filename) < 0) {
-		pr_err("Failed to set the configs on %s\n", config_filename);
-		goto out_err;
-	}
-
-	ret = 0;
-out_err:
-	perf_config_set__delete(set);
-	return ret;
-}
-
 int cmd_config(int argc, const char **argv)
 {
 	int i, ret = -1;
tools/perf/util/config.c +119 -5

165 lines not on this page · raw message

tools/perf/util/config.h +2 -0
index 987b47cf54c350ba..9098f8a045850c97 100644
@@ -33,6 +33,8 @@ int perf_config_scan(const char *name, const char *fmt, ...) __scanf(2, 3);
 const char *perf_config_get(const char *name);
 int perf_config_set(struct perf_config_set *set,
 		    config_fn_t fn, void *data);
+int perf_config_set__write(struct perf_config_set *set,
+			   const char *file_name, bool system_config);
 int perf_config_int(int *dest, const char *, const char *);
 int perf_config_u8(u8 *dest, const char *name, const char *value);
 int perf_config_u64(u64 *dest, const char *, const char *);
Signature · 1 line
2.55.0
author maintainer
#3 lore raw

PATCH 2/4 perf report: Add --progress option

In reply to Arnaldo Carvalho de Melo

From: Arnaldo Carvalho de Melo <[email protected]>

Processing a large session with stdio output gives no feedback about which phase perf is in or how far along it is: ui_progress updates are only shown by the TUI. Add --progress, installing a stdio backend (ui/stdio/progress.c) that prints the phase title, percentage and counts:

Processing events... [42.3%] 317M / 746M

Phases can be nested, so the backend tracks the ones started to complete the right one on ui_progress__finish(); that requires init()/finish() pairs, fixed in ordered-events.c and the pipe and directory event processing.

---
 tools/perf/Documentation/perf-report.txt |  13 ++
 tools/perf/builtin-report.c              |  10 ++
 tools/perf/ui/Build                      |   1 +
 tools/perf/ui/progress.h                 |   2 +
 tools/perf/ui/stdio/progress.c           | 162 +++++++++++++++++++++++
 tools/perf/util/ordered-events.c         |  16 ++-
 tools/perf/util/session.c                |  12 +-
 7 files changed, 209 insertions(+), 7 deletions(-)
 create mode 100644 tools/perf/ui/stdio/progress.c
tools/perf/Documentation/perf-report.txt +13 -0
index 3718ebd297ce0673..9b0a62fd361fd58f 100644
@@ -29,6 +29,19 @@ OPTIONS
 --quiet::
 	Do not show any warnings or messages.  (Suppress -v)
 
+--progress::
+	Show progress for each of the processing phases, printing the
+	percentage done and the current/total counts: the first phase
+	counts the bytes of the perf.data file processed so far, the
+	merge and sort phases count hist entries, e.g.:
+
+	Processing events... [ 42.3%] 4G / 10G
+	Merging related events... [  7.1%] 1024 / 14387
+	Sorting events for output... [ 98.2%] 14132 / 14387
+
+	It is a no-op when using the TUI or GTK browsers, that already
+	present progress information.
+
 -n::
 --show-nr-samples::
 	Show the number of samples for each symbol
tools/perf/builtin-report.c +10 -0
index 57225bc87731d074..d89a63742f622fde 100644
@@ -87,6 +87,7 @@ struct report {
 	bool			use_gtk;
 #endif
 	bool			use_stdio;
+	bool			progress;
 	bool			show_full_info;
 	bool			show_threads;
 	bool			inverted_callchain;
@@ -1384,6 +1385,8 @@ int cmd_report(int argc, const char **argv)
 		    "Use the stdio interface"),
 	OPT_BOOLEAN(0, "weights", &symbol_conf.annotate_weight,
 			"Show or hide weight columns in annotation. Default show if non-zero."),
+	OPT_BOOLEAN(0, "progress", &report.progress,
+		    "Show progress while processing the perf.data file"),
 	OPT_BOOLEAN(0, "header", &report.header, "Show data header."),
 	OPT_BOOLEAN(0, "header-only", &report.header_only,
 		    "Show only data header."),
@@ -1790,6 +1793,13 @@ int cmd_report(int argc, const char **argv)
 	else
 		use_browser = 0;
 
+	/*
+	 * For the stdio case: print the percentage of the perf.data file
+	 * processed so far for each processing phase.
+	 */
+	if (report.progress && use_browser == 0)
+		stdio_progress__init();
+
 	if (report.data_type && use_browser == 1) {
 		symbol_conf.annotate_data_member = true;
 		symbol_conf.annotate_data_sample = true;
tools/perf/ui/Build +1 -0
index 6005f813c9e3990c..a7b1740d51c80f23 100644
@@ -4,6 +4,7 @@ perf-ui-y += progress.o
 perf-ui-y += util.o
 perf-ui-y += hist.o
 perf-ui-y += stdio/hist.o
+perf-ui-y += stdio/progress.o
 
 CFLAGS_setup.o += -DLIBDIR="BUILD_STR($(LIBDIR))"
 
tools/perf/ui/progress.h +2 -0
index 4f52c37b2f099a82..03f1a8bb260ba076 100644
@@ -23,6 +23,8 @@ void __ui_progress__init(struct ui_progress *p, u64 total,
 
 void ui_progress__update(struct ui_progress *p, u64 adv);
 
+void stdio_progress__init(void);
+
 struct ui_progress_ops {
 	void (*init)(struct ui_progress *p);
 	void (*update)(struct ui_progress *p);
tools/perf/ui/stdio/progress.c new file +162 -0

162 lines not on this page · raw message

tools/perf/util/ordered-events.c +12 -4
index a5857f9f5af2d3de..54c85663e733be4d 100644
@@ -237,14 +237,16 @@ static int do_flush(struct ordered_events *oe, bool show_progress)
 		ui_progress__init(&prog, oe->nr_events, "Processing time ordered events...");
 
 	list_for_each_entry_safe(iter, tmp, head, list) {
-		if (session_done())
-			return 0;
+		if (session_done()) {
+			ret = 0;
+			goto out_progress;
+		}
 
 		if (iter->timestamp > limit)
 			break;
 		ret = oe->deliver(oe, iter);
 		if (ret < 0)
-			return ret;
+			goto out_progress;
 
 		ordered_events__delete(oe, iter);
 		oe->last_flush = iter->timestamp;
@@ -258,10 +260,16 @@ static int do_flush(struct ordered_events *oe, bool show_progress)
 	else if (last_ts <= limit)
 		oe->last = list_entry(head->prev, struct ordered_event, list);
 
+	ret = 0;
+out_progress:
+	/*
+	 * Always pair ui_progress__init() with ui_progress__finish(), the
+	 * stdio backend tracks the phases on a stack.
+	 */
 	if (show_progress)
 		ui_progress__finish();
 
-	return 0;
+	return ret;
 }
 
 static int __ordered_events__flush(struct ordered_events *oe, enum oe_flush how,
tools/perf/util/session.c +9 -3
index 7fea9e72726c936c..c4b4c7fb3b864589 100644
@@ -3253,8 +3253,12 @@ static int __perf_session__process_pipe_events(struct perf_session *session)
 	cur_size = sizeof(union perf_event);
 
 	buf = malloc(cur_size);
-	if (!buf)
-		return -errno;
+	if (!buf) {
+		err = -errno;
+		if (update_prog)
+			ui_progress__finish();
+		return err;
+	}
 	ordered_events__set_copy_on_queue(oe, true);
 more:
 	event = buf;
@@ -3753,8 +3757,10 @@ static int __perf_session__process_dir_events(struct perf_session *session)
 	}
 
 	rd = calloc(nr_readers, sizeof(struct reader));
-	if (!rd)
+	if (!rd) {
+		ui_progress__finish();
 		return -ENOMEM;
+	}
 
 	rd[0] = (struct reader) {
 		.fd		 = perf_data__fd(session->data),
Signature · 1 line
2.55.0
author maintainer
#5 lore raw

PATCH 3/4 perf scripts: Add perf-stuck, to tell where a running perf is stuck

In reply to Arnaldo Carvalho de Melo

From: Arnaldo Carvalho de Melo <[email protected]>

A perf that takes forever is hard to tell apart from one stuck in a loop, and there is no way to see where without attaching gdb. perf-stuck.sh samples a running process' /proc entries and its progress line at a fixed interval, and with -g runs gdb (perf-stuck.gdb, adding the perf-die-chain command) when no progress is made across two samples, printing the DIE chain a DWARF type chase is stuck in.

It is a prototype: the plan is to turn it into a first class 'perf stuck' command. The process name is resolved with pgrep among the caller's own processes only, as root an unscoped one would attach gdb to the first process of any user with a matching name.

---
 tools/perf/scripts/perf-stuck.gdb | 106 +++++++++++++++++
 tools/perf/scripts/perf-stuck.sh  | 181 ++++++++++++++++++++++++++++++
 2 files changed, 287 insertions(+)
 create mode 100644 tools/perf/scripts/perf-stuck.gdb
 create mode 100755 tools/perf/scripts/perf-stuck.sh
tools/perf/scripts/perf-stuck.gdb new file +106 -0
new file mode 100644
index 0000000000000000..ad595392f6beb460
@@ -0,0 +1,106 @@
+# SPDX-License-Identifier: GPL-2.0
+#
+# gdb commands for a stuck perf, used by perf-stuck.sh -g and usable directly:
+#
+#   gdb -p $(pgrep -x perf) -batch -x perf-stuck.gdb -ex bt
+#
+# PROTOTYPE: part of the perf-stuck.sh stopgap, wants to become a first
+# class 'perf stuck' command printing these DIE chains without gdb.
+#
+# The commands are for the DWARF type chasers in util/dwarf-aux.c:
+#
+#   perf-die-chain <function> <die variable> [iterations]
+#   perf-die-chain-all [iterations]
+#   perf-dso
+#
+# For each iteration of the chasing loop they print the DIE address, the
+# CU, its file offset, tag and name: a cycle shows as the same (addr, cu)
+# pairs repeating, and a CU changing between iterations means the chase
+# hops between a debug file and its dwz common file.
+# hopping between a debug file and its dwz common file.
+
+set pagination off
+set confirm off
+set debuginfod enabled off
+set print pretty on
+set height 0
+set width 0
+
+define perf-die-chain
+  if $argc < 2
+    printf "usage: perf-die-chain <function> <die variable> [iterations]\n"
+  else
+    frame function $arg0
+    if $argc == 3
+      set $perf_die_chain_n = $arg2
+    else
+      set $perf_die_chain_n = 10
+    end
+    set $perf_die_chain_head = $pc
+    set $perf_die_chain_i = 0
+    while $perf_die_chain_i < $perf_die_chain_n
+      # Pointer type DIEs have no DW_AT_name, so dwarf_diename() can
+      # return NULL: printf %s of it would error out and abort this
+      # batch script, handle it.
+      set $perf_die_chain_name = (char *) dwarf_diename($arg1)
+      printf "chain[%d] die=%p addr=%p cu=%p off=0x%lx tag=%d name=", $perf_die_chain_i, $arg1, $arg1->addr, $arg1->cu, ((Dwarf_Off) dwarf_dieoffset($arg1)), ((int) dwarf_tag($arg1))
+      if $perf_die_chain_name == 0
+	printf "(null)\n"
+      else
+	printf "%s\n", $perf_die_chain_name
+      end
+      until *$perf_die_chain_head
+      set $perf_die_chain_i = $perf_die_chain_i + 1
+    end
+  end
+end
+
+document perf-die-chain
+Print the DIE chain being walked by a DWARF type chasing loop.
+usage: perf-die-chain <function> <die variable> [iterations]
+  perf-die-chain die_get_pointer_type type_die
+  perf-die-chain __die_get_real_type vr_die
+  perf-die-chain die_get_real_type vr_die
+end
+
+define perf-die-chain-all
+  if $argc == 0
+    set $perf_die_chain_n = 10
+  else
+    set $perf_die_chain_n = $arg0
+  end
+  if $_any_caller_is("die_get_pointer_type", 20)
+    printf "stuck in die_get_pointer_type():\n"
+    perf-die-chain die_get_pointer_type type_die $perf_die_chain_n
+  else
+    if $_any_caller_is("__die_get_real_type", 20)
+      printf "stuck in __die_get_real_type():\n"
+      perf-die-chain __die_get_real_type vr_die $perf_die_chain_n
+    else
+      if $_any_caller_is("die_get_real_type", 20)
+        printf "stuck in die_get_real_type():\n"
+        perf-die-chain die_get_real_type vr_die $perf_die_chain_n
+      else
+        printf "not in a DWARF type chaser, try: bt\n"
+      end
+    end
+  end
+end
+
+document perf-die-chain-all
+Find which DWARF type chaser the process is in and print the DIE chain.
+usage: perf-die-chain-all [iterations]
+end
+
+define perf-dso
+  if $_any_caller_is("find_data_type", 20)
+    frame function find_data_type
+    printf "dso=%s ip=0x%lx sym=%s\n", dloc->ms->map->dso->name, dloc->ip, dloc->ms->sym->name
+  else
+    printf "not in find_data_type()\n"
+  end
+end
+
+document perf-dso
+Print the dso, ip and symbol of the data location being resolved.
+end
tools/perf/scripts/perf-stuck.sh new file +181 -0

181 lines not on this page · raw message

Signature · 1 line
2.55.0
author maintainer
#7 lore raw

PATCH 4/4 perf test: Add false_sharing workload exhibiting cross-CPU false sharing

In reply to Arnaldo Carvalho de Melo

From: Arnaldo Carvalho de Melo <[email protected]>

Add a 'perf test -w false_sharing' workload that hammers one shared struct from several CPUs, shaped as a TCP connection: a read-mostly identity (five-tuple) shares a cacheline with per-packet rx counters (the false-sharing line), a second line has packet-path private tx and congestion control counters, and a third the connection config.

The packet path runs in the main thread and up to four lookup threads hash the five-tuple and pull the config, reading one volatile shared instance directly so the accesses are PC-relative and resolvable by the data type profiler.

---
 tools/perf/tests/builtin-test.c               |   1 +
 tools/perf/tests/shell/data_type_profiling.sh |   9 +-
 tools/perf/tests/tests.h                      |   1 +
 tools/perf/tests/workloads/Build              |   2 +
 tools/perf/tests/workloads/false_sharing.c    | 236 ++++++++++++++++++
 5 files changed, 247 insertions(+), 2 deletions(-)
 create mode 100644 tools/perf/tests/workloads/false_sharing.c
tools/perf/tests/builtin-test.c +1 -0
index d2f594921e25bda9..98134b1c74cf80f4 100644
@@ -175,6 +175,7 @@ static struct test_workload *workloads[] = {
 	&workload__context_switch_loop,
 	&workload__deterministic,
 	&workload__callchain,
+	&workload__false_sharing,
 
 #ifdef HAVE_RUST_SUPPORT
 	&workload__code_with_type,
tools/perf/tests/shell/data_type_profiling.sh +7 -2
index a916c410274aa888..57203e0e5f857540 100755
@@ -8,8 +8,8 @@ set -e
 # data type profiling manifestation
 
 # Values in testtypes and testprogs should match
-testtypes=("# data-type: struct Buf" "# data-type: struct buf")
-testprogs=("perf test -w code_with_type" "perf test -w datasym")
+testtypes=("# data-type: struct Buf" "# data-type: struct buf" "# data-type: struct net_conn")
+testprogs=("perf test -w code_with_type" "perf test -w datasym" "perf test -w false_sharing")
 
 err=0
 perfdata=$(mktemp /tmp/__perf_test.perf.data.XXXXX)
@@ -59,6 +59,9 @@ test_basic_annotate() {
 
     "xC")
     index=1 ;;
+
+    "xFS")
+    index=2 ;;
   esac
 
   # Under 'set -e' a bare failing command aborts the script through the EXIT
@@ -114,6 +117,8 @@ test_basic_annotate Basic Rust
 test_basic_annotate Pipe Rust
 test_basic_annotate Basic C
 test_basic_annotate Pipe C
+test_basic_annotate Basic FS
+test_basic_annotate Pipe FS
 
 cleanup
 exit $err
tools/perf/tests/tests.h +1 -0
index 9c96f33483d14356..f379620069d34f3a 100644
@@ -250,6 +250,7 @@ DECLARE_WORKLOAD(jitdump);
 DECLARE_WORKLOAD(context_switch_loop);
 DECLARE_WORKLOAD(deterministic);
 DECLARE_WORKLOAD(callchain);
+DECLARE_WORKLOAD(false_sharing);
 
 #ifdef HAVE_RUST_SUPPORT
 DECLARE_WORKLOAD(code_with_type);
tools/perf/tests/workloads/Build +2 -0
index 048e371eb63e3164..18fceddccb56c013 100644
@@ -14,6 +14,7 @@ perf-test-y += jitdump.o
 perf-test-y += context_switch_loop.o
 perf-test-y += deterministic.o
 perf-test-y += callchain.o
+perf-test-y += false_sharing.o
 
 ifeq ($(CONFIG_RUST_SUPPORT),y)
     perf-test-y += code_with_type.o
@@ -29,3 +30,4 @@ CFLAGS_inlineloop.o       = -g -O2
 CFLAGS_deterministic.o    = -g -O0 -fno-inline -U_FORTIFY_SOURCE
 CFLAGS_named_threads.o    = -g -O0 -fno-inline -U_FORTIFY_SOURCE
 CFLAGS_callchain.o        = -g -O0 -fno-inline -U_FORTIFY_SOURCE
+CFLAGS_false_sharing.o    = -g -O0 -fno-inline -U_FORTIFY_SOURCE
tools/perf/tests/workloads/false_sharing.c new file +236 -0

236 lines not on this page · raw message

Signature · 1 line
2.55.0
#4 lore raw

Re: [PATCH 2/4] perf report: Add --progress option

In reply to Arnaldo Carvalho de Melo
Sashiko has reviewed this patch and found no issues. It looks great!
Quoted 10 lines

From: Arnaldo Carvalho de Melo <[email protected]>

Processing a large session with stdio output gives no feedback about which phase perf is in or how far along it is: ui_progress updates are only shown by the TUI. Add --progress, installing a stdio backend (ui/stdio/progress.c) that prints the phase title, percentage and counts:

Processing events... [42.3%] 317M / 746M

Quoted 7 lines

Phases can be nested, so the backend tracks the ones started to complete the right one on ui_progress__finish(); that requires init()/finish() pairs, fixed in ordered-events.c and the pipe and directory event processing.

Sashiko has reviewed this patch and found no issues. It looks great!

Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=2
#8 lore raw

Re: [PATCH 4/4] perf test: Add false_sharing workload exhibiting cross-CPU false sharing

In reply to Arnaldo Carvalho de Melo
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider: - [Medium] perf test: stack buffer overflow in false_sharing via CPU_SET(-1) --

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Medium] perf test: stack buffer overflow in false_sharing via CPU_SET(-1) --

commit ca3d54512dd3bcec14cdfc83ca90f31bcb2e15f0
Author: Arnaldo Carvalho de Melo <[email protected]>

perf test: Add false_sharing workload exhibiting cross-CPU false sharing

Add a 'perf test -w false_sharing' workload that hammers one shared struct from several CPUs, shaped as a TCP connection. The packet path runs in the main thread and up to four lookup threads hash the five-tuple and pull the config.

Quoted 5 lines
tools/perf/tests/workloads/false_sharing.c new file +0 -0
new file mode 100644
index 0000000000000..6fccb81e3ed1c

[ ... ]

tools/perf/tests/workloads/false_sharing.c line 79

Quoted 6 lines
tools/perf/tests/workloads/false_sharing.c new file +6 -0
+static void pin_to_cpu(int cpu)
+{
+	cpu_set_t set;
+
+	CPU_ZERO(&set);
+	CPU_SET(cpu, &set);

[Severity: Medium]
When false_sharing() runs on a single-core machine or a restricted cpuset (where nallowed <= 1), it assigns -1 to the reader thread's target CPU:

false_sharing() {
    ...
    for (i = 0; i < nreaders; i++) {
        int cpu = nallowed > 1 ? allowed[(i + 1) % nallowed] : -1;
        readers[i].cpu = cpu;
        ...
    }
}

Unlike the writer thread, which correctly guards the call with
if (writer_cpu >= 0), the reader thread unconditionally calls pin_to_cpu(-1):

reader_fn() {
    ...
    pin_to_cpu(r->cpu);
    ...
}

This passes -1 directly to CPU_SET() without any bounds checking. Could this negative index result in an out-of-bounds stack write that corrupts memory?

Quoted 3 lines
tools/perf/tests/workloads/false_sharing.c new file +3 -0
+	/* Best effort: in a restricted cpuset this fails and the thread runs unpinned. */
+	pthread_setaffinity_np(pthread_self(), sizeof(set), &set);
+}
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=4
#6 lore raw

Re: [PATCH 3/4] perf scripts: Add perf-stuck, to tell where a running perf is stuck

In reply to Arnaldo Carvalho de Melo
Thank you for your contribution! Sashiko AI review found 4 potential issue(s) to consider: - [Medium] perf-stuck: hang detection fails if progress log is empty - [Medium] perf-stuck.gdb: libdw…

Thank you for your contribution! Sashiko AI review found 4 potential issue(s) to consider:
- [Medium] perf-stuck: hang detection fails if progress log is empty
- [Medium] perf-stuck.gdb: libdw inferior calls lack function pointer casts
- [Medium] perf-stuck.gdb: structure access fails with REFCNT_CHECKING enabled
- [Medium] perf-stuck.gdb: perf-dso macro accesses non-existent dso->name field --

commit 95092b23c716d33f8c9a4a12147c43af4f703f93
Author: Arnaldo Carvalho de Melo <[email protected]>
Subject: perf scripts: Add perf-stuck, to tell where a running perf is stuck

This commit adds a prototype perf-stuck.sh script to monitor a running perf process and detect hangs using /proc sampling. If it detects a hang, it uses perf-stuck.gdb to attach GDB and print the DWARF type chasing loops to diagnose where it is stuck.

Quoted 4 lines
tools/perf/scripts/perf-stuck.gdb new file +0 -0
index 0000000000000..ad595392f6beb

[ ... ]

Quoted 1 line

+define perf-die-chain

[ ... ]

tools/perf/scripts/perf-stuck.gdb line 46

Quoted 5 lines
tools/perf/scripts/perf-stuck.gdb new file +5 -0
+      # Pointer type DIEs have no DW_AT_name, so dwarf_diename() can
+      # return NULL: printf %s of it would error out and abort this
+      # batch script, handle it.
+      set $perf_die_chain_name = (char *) dwarf_diename($arg1)
+      printf "chain[%d] die=%p addr=%p cu=%p off=0x%lx tag=%d name=", $perf_die_chain_i, $arg1, $arg1->addr, $arg1->cu, ((Dwarf_Off) dwarf_dieoffset($arg1)), ((int) dwarf_tag($arg1))

[Severity: Medium]
Will these inferior calls to libdw functions like dwarf_diename(), dwarf_dieoffset(), and dwarf_tag() fail without explicit function pointer casts?

Since GDB typically lacks debug information for the shared libdw library, it does not know the return type of these functions. This can cause modern GDB to abort the script with an "unknown return type" error.

On older GDB versions, this might truncate the 64-bit pointer return to 32 bits, leading to an invalid memory access during the (char *) cast.

[ ... ]

tools/perf/scripts/perf-stuck.gdb line 98

Quoted 4 lines
tools/perf/scripts/perf-stuck.gdb new file +4 -0
+define perf-dso
+  if $_any_caller_is("find_data_type", 20)
+    frame function find_data_type
+    printf "dso=%s ip=0x%lx sym=%s\n", dloc->ms->map->dso->name, dloc->ip, dloc->ms->sym->name

[Severity: Medium]
Does struct dso have a name field?

In the perf codebase, struct dso uses short_name and long_name rather than name. Accessing a non-existent structure field will cause GDB to throw an error like "There is no member named name" and immediately abort the execution of the perf-dso macro.

[Severity: Medium]
Will direct structure accesses like dloc->ms->map->dso fail when perf is compiled with Address/Leak Sanitizers (which enables REFCNT_CHECKING)?

When REFCNT_CHECKING is enabled, reference-counted structures like map and dso are wrapped in an intermediary proxy struct.

The true data fields are hidden behind an orig pointer, so GDB will throw an evaluation error like "There is no member named dso" instead of resolving the fields.

Quoted 4 lines
tools/perf/scripts/perf-stuck.sh new file +0 -0
index 0000000000000..3b9b22124dbda

[ ... ]

tools/perf/scripts/perf-stuck.sh line 152

Quoted 11 lines
tools/perf/scripts/perf-stuck.sh new file +11 -0
+	if [ -n "$prev_cpu" ]; then
+		cpu_delta=$(( cpu - prev_cpu ))
+		# With a progress log, count the samples that show no progress,
+		# without one there is no progress to look at, so count them all:
+		# -g then looks at where the process is after two intervals.
+		if [ -z "$progress_log" ] ||
+		   { [ -n "$progress" ] && [ "$progress" = "$prev_progress" ]; }; then
+			stuck=$((stuck + 1))
+		else
+			stuck=0
+		fi

[Severity: Medium]
Does this logic unintentionally disable hang detection if a progress log file is specified but remains empty?

If a progress log file is specified but hasn't been written to (e.g., during early initialization hangs), the progress variable remains empty. The check [ -n "$progress" ] evaluates to false, causing the script to fall back to the else block and unconditionally set stuck=0.

This continuously resets the stuck counter, which will prevent the script from ever triggering GDB.

Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=3
#2 lore raw

Re: [PATCH 1/4] perf config: Move perf_config__set_variable() to util/config.c

In reply to Arnaldo Carvalho de Melo
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider: - [Medium] perf: NULL pointer dereference in perf_config__set_variable() --

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Medium] perf: NULL pointer dereference in perf_config__set_variable()
--

commit 0d5767702c97c90061c56a5a96f7d7f30aec5f53
Author: Arnaldo Carvalho de Melo <[email protected]>

perf config: Move perf_config__set_variable() to util/config.c

This commit moves perf_config__set_variable() out of the perf config builtin to util/config.c so that opt-in features can persist their choices from outside it. It also introduces mutexes to serialize configuration parsing and rewriting.

Quoted 4 lines
tools/perf/util/config.c +0 -0
index 8fe43b032e9af..43994786eb964 100644

[ ... ]

tools/perf/util/config.c void perf_config__exit(void) · line 974

Quoted 11 lines
tools/perf/util/config.c +11 -0
+int perf_config__set_variable(const char *var, const char *value)
+{
+	char path[PATH_MAX];
+	char *user_config = mkpath(path, sizeof(path), "%s/.perfconfig", getenv("HOME"));
+	const char *config_filename = config_exclusive_filename ?: user_config;
+		/*
+	 * When rewriting the system wide file all entries are marked as coming
+	 * from it and must be kept, or it would be truncated down to its
+	 * header.
+	 */
+	bool system_config = strcmp(config_filename, perf_etc_perfconfig()) == 0;

[Severity: Medium]
When the system is under memory pressure, strdup() inside system_path() can fail and return NULL for absolute paths like ETC_PERFCONFIG. In this case, perf_etc_perfconfig() caches and returns this NULL value.

Since strcmp() is called directly with the return value of perf_etc_perfconfig() as its second argument in perf_config__set_variable(), could this unconditionally dereference a NULL pointer and cause a crash under memory exhaustion?

Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=1