Re: [v5 4/9] RISC-V: Add a simple platform driver for RISC-V legacy perf

From: Anup Patel
Date: Tue Jan 18 2022 - 00:23:42 EST


On Sat, Dec 25, 2021 at 11:17 AM Atish Patra <atishp@xxxxxxxxxxxxxx> wrote:
>
> From: Atish Patra <atish.patra@xxxxxxx>
>
> The old RISC-V perf implementation allowed counting of only
> cycle/instruction counters using perf. Restore that feature by implementing
> a simple platform driver under a separate config to provide backward
> compatibility. Any existing software stack will continue to work as it is.
> However, it provides an easy way out in future where we can remove the
> legacy driver.
>
> Signed-off-by: Atish Patra <atish.patra@xxxxxxx>
> Signed-off-by: Atish Patra <atishp@xxxxxxxxxxxx>
> ---
> drivers/perf/Kconfig | 10 +++
> drivers/perf/Makefile | 3 +
> drivers/perf/riscv_pmu_legacy.c | 143 ++++++++++++++++++++++++++++++++
> include/linux/perf/riscv_pmu.h | 6 ++
> 4 files changed, 162 insertions(+)
> create mode 100644 drivers/perf/riscv_pmu_legacy.c
>
> diff --git a/drivers/perf/Kconfig b/drivers/perf/Kconfig
> index 03ca0315df73..6bd12663c8d3 100644
> --- a/drivers/perf/Kconfig
> +++ b/drivers/perf/Kconfig
> @@ -66,6 +66,16 @@ config RISCV_PMU
> PMU functionalities in a core library so that different PMU drivers
> can reuse it.
>
> +config RISCV_PMU_LEGACY
> + depends on RISCV_PMU
> + bool "RISC-V legacy PMU implementation"
> + default y
> + help
> + Say y if you want to use the legacy CPU performance monitor
> + implementation on RISC-V based systems. This only allows counting
> + of cycle/instruction counter and doesn't support counter overflow,
> + or programmable counters. It will be removed in future.
> +
> config ARM_PMU_ACPI
> depends on ARM_PMU && ACPI
> def_bool y
> diff --git a/drivers/perf/Makefile b/drivers/perf/Makefile
> index 76e5c50e24bb..e8aa666a9d28 100644
> --- a/drivers/perf/Makefile
> +++ b/drivers/perf/Makefile
> @@ -11,6 +11,9 @@ obj-$(CONFIG_HISI_PMU) += hisilicon/
> obj-$(CONFIG_QCOM_L2_PMU) += qcom_l2_pmu.o
> obj-$(CONFIG_QCOM_L3_PMU) += qcom_l3_pmu.o
> obj-$(CONFIG_RISCV_PMU) += riscv_pmu.o
> +ifeq ($(CONFIG_RISCV_PMU), y)
> +obj-$(CONFIG_RISCV_PMU_LEGACY) += riscv_pmu_legacy.o
> +endif

RISCV_PMU_LEGACY already depends on RISCV_PMU.

Do you still need this "ifeq ()" check ?

> obj-$(CONFIG_THUNDERX2_PMU) += thunderx2_pmu.o
> obj-$(CONFIG_XGENE_PMU) += xgene_pmu.o
> obj-$(CONFIG_ARM_SPE_PMU) += arm_spe_pmu.o
> diff --git a/drivers/perf/riscv_pmu_legacy.c b/drivers/perf/riscv_pmu_legacy.c
> new file mode 100644
> index 000000000000..8bb973f2d9f7
> --- /dev/null
> +++ b/drivers/perf/riscv_pmu_legacy.c
> @@ -0,0 +1,143 @@
> +// SPDX-License-Identifier: GPL-2.0
> +/*
> + * RISC-V performance counter support.
> + *
> + * Copyright (C) 2021 Western Digital Corporation or its affiliates.
> + *
> + * This implementation is based on old RISC-V perf and ARM perf event code
> + * which are in turn based on sparc64 and x86 code.
> + */
> +
> +#include <linux/mod_devicetable.h>
> +#include <linux/perf/riscv_pmu.h>
> +#include <linux/platform_device.h>
> +
> +#define RISCV_PMU_LEGACY_CYCLE 0
> +#define RISCV_PMU_LEGACY_INSTRET 1
> +#define RISCV_PMU_LEGACY_NUM_CTR 2
> +
> +bool pmu_init_done;

This should be a static variable.

> +
> +static int pmu_legacy_ctr_get_idx(struct perf_event *event)
> +{
> + struct perf_event_attr *attr = &event->attr;
> +
> + if (event->attr.type != PERF_TYPE_HARDWARE)
> + return -EOPNOTSUPP;
> + if (attr->config == PERF_COUNT_HW_CPU_CYCLES)
> + return RISCV_PMU_LEGACY_CYCLE;
> + else if (attr->config == PERF_COUNT_HW_INSTRUCTIONS)
> + return RISCV_PMU_LEGACY_INSTRET;
> + else
> + return -EOPNOTSUPP;
> +}
> +
> +/* For legacy config & counter index are same */
> +static int pmu_legacy_event_map(struct perf_event *event, u64 *config)
> +{
> + return pmu_legacy_ctr_get_idx(event);
> +}
> +
> +static u64 pmu_legacy_read_ctr(struct perf_event *event)
> +{
> + struct hw_perf_event *hwc = &event->hw;
> + int idx = hwc->idx;
> + u64 val;
> +
> + if (idx == RISCV_PMU_LEGACY_CYCLE) {
> + val = riscv_pmu_ctr_read_csr(CSR_CYCLE);
> + if (IS_ENABLED(CONFIG_32BIT))
> + val = (u64)riscv_pmu_ctr_read_csr(CSR_CYCLEH) << 32 | val;
> + } else if (idx == RISCV_PMU_LEGACY_INSTRET) {
> + val = riscv_pmu_ctr_read_csr(CSR_INSTRET);
> + if (IS_ENABLED(CONFIG_32BIT))
> + val = ((u64)riscv_pmu_ctr_read_csr(CSR_INSTRETH)) << 32 | val;
> + } else
> + return 0;
> +
> + return val;
> +}
> +
> +static void pmu_legacy_ctr_start(struct perf_event *event, u64 ival)
> +{
> + struct hw_perf_event *hwc = &event->hw;
> + u64 initial_val = pmu_legacy_read_ctr(event);
> +
> + /**
> + * The legacy method doesn't really have a start/stop method.
> + * It also can not update the counter with a initial value.
> + * But we still need to set the prev_count so that read() can compute
> + * the delta. Just use the current counter value to set the prev_count.
> + */
> + local64_set(&hwc->prev_count, initial_val);
> +}
> +
> +/**
> + * This is just a simple implementation to allow legacy implementations
> + * compatible with new RISC-V PMU driver framework.
> + * This driver only allows reading two counters i.e CYCLE & INSTRET.
> + * However, it can not start or stop the counter. Thus, it is not very useful
> + * will be removed in future.
> + */
> +static void pmu_legacy_init(struct riscv_pmu *pmu)
> +{
> + pr_info("Legacy PMU implementation is available\n");
> +
> + pmu->num_counters = RISCV_PMU_LEGACY_NUM_CTR;
> + pmu->ctr_start = pmu_legacy_ctr_start;
> + pmu->ctr_stop = NULL;
> + pmu->event_map = pmu_legacy_event_map;
> + pmu->ctr_get_idx = pmu_legacy_ctr_get_idx;
> + pmu->ctr_get_width = NULL;
> + pmu->ctr_clear_idx = NULL;
> + pmu->ctr_read = pmu_legacy_read_ctr;
> +
> + perf_pmu_register(&pmu->pmu, "cpu", PERF_TYPE_RAW);
> +}
> +
> +static int pmu_legacy_device_probe(struct platform_device *pdev)
> +{
> + struct riscv_pmu *pmu = NULL;
> +
> + pmu = riscv_pmu_alloc();
> + if (!pmu)
> + return -ENOMEM;
> + pmu_legacy_init(pmu);
> +
> + return 0;
> +}
> +
> +static struct platform_driver pmu_legacy_driver = {
> + .probe = pmu_legacy_device_probe,
> + .driver = {
> + .name = RISCV_PMU_LEGACY_PDEV_NAME,
> + },
> +};
> +
> +static int __init riscv_pmu_legacy_devinit(void)
> +{
> + int ret;
> + struct platform_device *pdev;
> +
> + if (likely(pmu_init_done))
> + return 0;
> +
> + ret = platform_driver_register(&pmu_legacy_driver);
> + if (ret)
> + return ret;
> +
> + pdev = platform_device_register_simple(RISCV_PMU_LEGACY_PDEV_NAME, -1, NULL, 0);
> + if (IS_ERR(pdev)) {
> + platform_driver_unregister(&pmu_legacy_driver);
> + return PTR_ERR(pdev);
> + }
> +
> + return ret;
> +}
> +late_initcall(riscv_pmu_legacy_devinit);
> +
> +void riscv_pmu_legacy_init(bool done)

I would suggest renaming riscv_pmu_legacy_init()
to riscv_pmu_legacy_skip_init().

Also, no need for "done" parameter.

> +{
> + if (done)
> + pmu_init_done = true;

I would also suggest renaming "pmu_init_done" to
"legacy_pmu_init_done" or something similar.

> +}
> diff --git a/include/linux/perf/riscv_pmu.h b/include/linux/perf/riscv_pmu.h
> index 0d8979765d79..52672de540c2 100644
> --- a/include/linux/perf/riscv_pmu.h
> +++ b/include/linux/perf/riscv_pmu.h
> @@ -22,6 +22,7 @@
> #define RISCV_MAX_COUNTERS 64
> #define RISCV_OP_UNSUPP (-EOPNOTSUPP)
> #define RISCV_PMU_PDEV_NAME "riscv-pmu"
> +#define RISCV_PMU_LEGACY_PDEV_NAME "riscv-pmu-legacy"
>
> #define RISCV_PMU_STOP_FLAG_RESET 1
>
> @@ -58,6 +59,11 @@ unsigned long riscv_pmu_ctr_read_csr(unsigned long csr);
> int riscv_pmu_event_set_period(struct perf_event *event);
> uint64_t riscv_pmu_ctr_get_width_mask(struct perf_event *event);
> u64 riscv_pmu_event_update(struct perf_event *event);
> +#ifdef CONFIG_RISCV_PMU_LEGACY
> +void riscv_pmu_legacy_init(bool init_done);
> +#else
> +static inline void riscv_pmu_legacy_init(bool init_done) {};
> +#endif
> struct riscv_pmu *riscv_pmu_alloc(void);
>
> #endif /* CONFIG_RISCV_PMU */
> --
> 2.33.1
>

Apart from minor comments above, it looks good to me.

Reviewed-by: Anup Patel <anup@xxxxxxxxxxxxxx>

Regards,
Anup