Skip to contentSkip to conversation

perf riscv: Add perf_regs_load and enable the dwarf unwind test

PATCH Superseded Chen Pei 2 participants 2 messages Sep 16

Subsystems (2)

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore

Chen Pei

author
#0 lore raw

PATCH v2 1/1 perf riscv: Add perf_regs_load and enable the dwarf unwind test

riscv has no arch level perf test: tests/builtin-test.c only picks up arch_tests[] for x86, arm64 and powerpc64, tests/Build only builds the generic dwarf unwind test driver for x86, arm, arm64 and powerpc, and arch/riscv/tests/ did not exist. "Test dwarf unwind" was therefore never registered on riscv, even though DWARF is the only reliable way to walk a riscv user stack -- the arch callchain code walks frame pointers only -- and both unwinders already support riscv, elfutils libdw generically and libunwind through util/libunwind-arch/libunwind-riscv.c.

Add perf_regs_load() and the arch unwind sample helper modelled on the arm64 ones, and wire riscv into the two gates. The x1..x31 slots of enum perf_event_riscv_regs match the hardware registers one to one, and PERF_REG_RISCV_PC is filled with ra so that unwinding starts at the caller.

---

Changes since v1:
- Add explicit #include <stdlib.h> per Ian Rogers' review.
- Add Reviewed-by: Ian Rogers <[email protected]>

Tested on riscv64 (QEMU virt, kernel 6.18, rv64gcv userspace) with both the libdw and the libunwind unwinder, and in both callchain orders. All eight expected frames resolve, including the one in libc:

  # ./perf test -v "dwarf unwind"
   71: Test dwarf unwind                                     : Ok

got: test__dwarf_unwind 0x555593375c45, expecting test__dwarf_unwind
got: test_dwarf_unwind__krava_1 0x555593375b7f, expecting test_dwarf_unwind__krava_1
got: test_dwarf_unwind__krava_2 0x555593375b43, expecting test_dwarf_unwind__krava_2
got: test_dwarf_unwind__krava_3 0x555593375aff, expecting test_dwarf_unwind__krava_3
got: bsearch 0x7fff9aad575b, expecting bsearch
got: test_dwarf_unwind__compare 0x555593375a5d, expecting test_dwarf_unwind__compare
got: test_dwarf_unwind__thread 0x555593375939, expecting test_dwarf_unwind__thread
got: test__arch_unwind_sample 0x5555933788a0, expecting test__arch_unwind_sample

The libunwind build links libunwind-riscv.so.8, so the riscv specific remote unwinder in util/libunwind-arch/libunwind-riscv.c is what runs.

A build with DWARF unwinding disabled was checked too: it still links, arch_tests[] degrades to the NULL only array, and the test is simply absent from "perf test list".

 tools/perf/arch/riscv/Build                |  1 +
 tools/perf/arch/riscv/include/arch-tests.h |  9 +++
 tools/perf/arch/riscv/include/perf_regs.h  |  2 +
 tools/perf/arch/riscv/tests/Build          |  4 ++
 tools/perf/arch/riscv/tests/arch-tests.c   | 10 ++++
 tools/perf/arch/riscv/tests/dwarf-unwind.c | 65 ++++++++++++++++++++++
 tools/perf/arch/riscv/tests/regs_load.S    | 58 +++++++++++++++++++
 tools/perf/tests/Build                     |  2 +-
 tools/perf/tests/builtin-test.c            |  3 +-
 9 files changed, 152 insertions(+), 2 deletions(-)
 create mode 100644 tools/perf/arch/riscv/include/arch-tests.h
 create mode 100644 tools/perf/arch/riscv/tests/Build
 create mode 100644 tools/perf/arch/riscv/tests/arch-tests.c
 create mode 100644 tools/perf/arch/riscv/tests/dwarf-unwind.c
 create mode 100644 tools/perf/arch/riscv/tests/regs_load.S
tools/perf/arch/riscv/Build +1 -0
index e63eabc2c8f4..12ebc65ea7a3 100644
@@ -1 +1,2 @@
 perf-util-y += util/
+perf-test-y += tests/
tools/perf/arch/riscv/include/arch-tests.h new file +9 -0
new file mode 100644
index 000000000000..2b3834a5ddbb
@@ -0,0 +1,9 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+#ifndef ARCH_TESTS_H
+#define ARCH_TESTS_H
+
+struct test_suite;
+
+extern struct test_suite *arch_tests[];
+
+#endif
tools/perf/arch/riscv/include/perf_regs.h +2 -0
index af7a1b47bf66..30cfd3f63eb5 100644
@@ -8,6 +8,8 @@
 #include <linux/types.h>
 #include "../../../../arch/riscv/include/uapi/asm/perf_regs.h"
 
+void perf_regs_load(u64 *regs);
+
 #define PERF_REGS_MASK	((1ULL << PERF_REG_RISCV_MAX) - 1)
 #define PERF_REGS_MAX	PERF_REG_RISCV_MAX
 
tools/perf/arch/riscv/tests/Build new file +4 -0
new file mode 100644
index 000000000000..bd15c6bbc1b2
@@ -0,0 +1,4 @@
+perf-test-y += regs_load.o
+perf-test-$(CONFIG_DWARF_UNWIND) += dwarf-unwind.o
+
+perf-test-y += arch-tests.o
tools/perf/arch/riscv/tests/arch-tests.c new file +10 -0
new file mode 100644
index 000000000000..756706a09609
@@ -0,0 +1,10 @@
+// SPDX-License-Identifier: GPL-2.0
+#include "tests/tests.h"
+#include "arch-tests.h"
+
+struct test_suite *arch_tests[] = {
+#ifdef HAVE_DWARF_UNWIND_SUPPORT
+	&suite__dwarf_unwind,
+#endif
+	NULL,
+};
tools/perf/arch/riscv/tests/dwarf-unwind.c new file +65 -0

65 lines not on this page · raw message

tools/perf/arch/riscv/tests/regs_load.S new file +58 -0

58 lines not on this page · raw message

tools/perf/tests/Build +1 -1
index 66944a4f4968..c457504e052d 100644
@@ -72,7 +72,7 @@ perf-test-y += tool_pmu.o
 perf-test-y += subcmd-help.o
 perf-test-y += kallsyms-split.o
 
-ifeq ($(SRCARCH),$(filter $(SRCARCH),x86 arm arm64 powerpc))
+ifeq ($(SRCARCH),$(filter $(SRCARCH),x86 arm arm64 powerpc riscv))
 perf-test-$(CONFIG_DWARF_UNWIND) += dwarf-unwind.o
 endif
 
tools/perf/tests/builtin-test.c +2 -1
index 4d0784b16723..a0478dd3e9cc 100644
@@ -67,7 +67,8 @@ static const char *workload_control;
  * dependent on the initialization, as such GCC with LTO complains of
  * conflicting definitions with a weak symbol.
  */
-#if defined(__i386__) || defined(__x86_64__) || defined(__aarch64__) || defined(__powerpc64__)
+#if defined(__i386__) || defined(__x86_64__) || defined(__aarch64__) || \
+	defined(__powerpc64__) || defined(__riscv)
 extern struct test_suite *arch_tests[];
 #else
 static struct test_suite *arch_tests[] = {
Signature · 1 line
2.50.1
#1 lore raw
Thank you for your contribution! Sashiko AI review found 3 potential issue(s) to consider: - [Medium] perf riscv: unchecked return from perf_sample__user_regs() causes crash on OOM - [Low] perf…

Thank you for your contribution! Sashiko AI review found 3 potential issue(s) to consider:
- [Medium] perf riscv: unchecked return from perf_sample__user_regs() causes crash on OOM
- [Low] perf riscv: missing explicit POSIX header inclusion for NULL in arch-tests.c
- [Low] perf riscv: misleading error message for sample_ustack() allocation failure --

commit e16ea72472ccddd24553a422bc4e281ff9984621
Author: Chen Pei <[email protected]>

perf riscv: Add perf_regs_load and enable the dwarf unwind test

This patch adds perf_regs_load() and the arch unwind sample helper for RISC-V, wiring it into the gates. It also enables the generic dwarf unwind test driver to support RISC-V.

Quoted 6 lines
tools/perf/arch/riscv/tests/arch-tests.c new file +0 -0
new file mode 100644
index 0000000000000..756706a09609e

tools/perf/arch/riscv/tests/arch-tests.c line 9

Quoted 9 lines
tools/perf/arch/riscv/tests/arch-tests.c new file +9 -0
@@ -0,0 +1,10 @@
+// SPDX-License-Identifier: GPL-2.0
+#include "tests/tests.h"
+#include "arch-tests.h"
+
+struct test_suite *arch_tests[] = {
+#ifdef HAVE_DWARF_UNWIND_SUPPORT
+	&suite__dwarf_unwind,
+#endif
+	NULL,
        ^^^^

[Severity: Low]
Does this code need an explicit POSIX header inclusion for NULL?

The perf subsystem guidelines require explicit, direct header inclusions for POSIX libc constants like NULL (e.g. <stddef.h>) to prevent compilation failures on musl libc.

Quoted 8 lines
tools/perf/arch/riscv/tests/arch-tests.c new file +1 -0
+};
tools/perf/arch/riscv/tests/dwarf-unwind.c new file +0 -0
new file mode 100644
index 0000000000000..fe0c32ea0e05a
@@ -0,0 +1,65 @@

[ ... ]

tools/perf/arch/riscv/tests/dwarf-unwind.c line 24

Quoted 11 lines
tools/perf/arch/riscv/tests/dwarf-unwind.c new file +11 -0
+static int sample_ustack(struct perf_sample *sample,
+		struct thread *thread, u64 *regs)
+{
+	struct stack_dump *stack = &sample->user_stack;
+	struct map *map;
+	unsigned long sp;
+	u64 stack_size, *buf;
+
+	buf = malloc(STACK_SIZE);
+	if (!buf) {
+		pr_debug("failed to allocate sample uregs data\n");
                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

[Severity: Low]
Is this error message accurate?

Since the allocation in sample_ustack() is for the user stack (STACK_SIZE), this appears to be a copy-paste error from test__arch_unwind_sample().

Quoted 2 lines
tools/perf/arch/riscv/tests/dwarf-unwind.c new file +2 -0
+		return -1;
+	}

[ ... ]

Quoted 4 lines
tools/perf/arch/riscv/tests/dwarf-unwind.c new file +4 -0
+int test__arch_unwind_sample(struct perf_sample *sample,
+		struct thread *thread)
+{
+	struct regs_dump *regs = perf_sample__user_regs(sample);

tools/perf/arch/riscv/tests/dwarf-unwind.c line 60

Quoted 10 lines
tools/perf/arch/riscv/tests/dwarf-unwind.c new file +10 -0
+	u64 *buf;
+
+	buf = calloc(PERF_REGS_MAX, sizeof(u64));
+	if (!buf) {
+		pr_debug("failed to allocate sample uregs data\n");
+		return -1;
+	}
+
+	perf_regs_load(buf);
+	regs->abi  = PERF_SAMPLE_REGS_ABI;
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

[Severity: Medium]
Could regs be a NULL pointer here?

If perf_sample__user_regs(sample) fails its internal allocation (zalloc()) on OOM, it returns NULL. This would result in an unconditional NULL pointer dereference when setting regs->abi.

Quoted 5 lines
tools/perf/arch/riscv/tests/dwarf-unwind.c new file +5 -0
+	regs->regs = buf;
+	regs->mask = PERF_REGS_MASK;
+
+	return sample_ustack(sample, thread, buf);
+}
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=1