public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
From: Alexandre Ghiti <alexghiti@rivosinc.com>
To: Jonathan Corbet <corbet@lwn.net>,
	Peter Zijlstra <peterz@infradead.org>,
	Ingo Molnar <mingo@redhat.com>,
	Arnaldo Carvalho de Melo <acme@kernel.org>,
	Mark Rutland <mark.rutland@arm.com>,
	Alexander Shishkin <alexander.shishkin@linux.intel.com>,
	Jiri Olsa <jolsa@kernel.org>, Namhyung Kim <namhyung@kernel.org>,
	Ian Rogers <irogers@google.com>,
	Paul Walmsley <paul.walmsley@sifive.com>,
	Palmer Dabbelt <palmer@dabbelt.com>,
	Albert Ou <aou@eecs.berkeley.edu>,
	Atish Patra <atishp@atishpatra.org>,
	Anup Patel <anup@brainfault.org>, Will Deacon <will@kernel.org>,
	Rob Herring <robh@kernel.org>,
	Andrew Jones <ajones@ventanamicro.com>,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	linux-perf-users@vger.kernel.org,
	linux-riscv@lists.infradead.org,
	linux-arm-kernel@lists.infradead.org
Cc: Alexandre Ghiti <alexghiti@rivosinc.com>
Subject: [PATCH v3 08/10] Documentation: admin-guide: Add riscv sysctl_perf_user_access
Date: Fri, 30 Jun 2023 10:30:11 +0200	[thread overview]
Message-ID: <20230630083013.102334-9-alexghiti@rivosinc.com> (raw)
In-Reply-To: <20230630083013.102334-1-alexghiti@rivosinc.com>

riscv now uses this sysctl so document its usage for this architecture.

Signed-off-by: Alexandre Ghiti <alexghiti@rivosinc.com>
---
 Documentation/admin-guide/sysctl/kernel.rst | 26 +++++++++++++++++----
 1 file changed, 22 insertions(+), 4 deletions(-)

diff --git a/Documentation/admin-guide/sysctl/kernel.rst b/Documentation/admin-guide/sysctl/kernel.rst
index d85d90f5d000..c376692b372b 100644
--- a/Documentation/admin-guide/sysctl/kernel.rst
+++ b/Documentation/admin-guide/sysctl/kernel.rst
@@ -941,16 +941,34 @@ enabled, otherwise writing to this file will return ``-EBUSY``.
 The default value is 8.
 
 
-perf_user_access (arm64 only)
-=================================
+perf_user_access (arm64 and riscv only)
+=======================================
+
+Controls user space access for reading perf event counters.
 
-Controls user space access for reading perf event counters. When set to 1,
-user space can read performance monitor counter registers directly.
+arm64
+=====
 
 The default value is 0 (access disabled).
+When set to 1, user space can read performance monitor counter registers
+directly.
 
 See Documentation/arm64/perf.rst for more information.
 
+riscv
+=====
+
+When set to 0, user access is disabled.
+
+When set to 1, user space can read performance monitor counter registers
+directly only through perf, any direct access without perf intervention will
+trigger an illegal instruction.
+
+The default value is 2, which enables legacy mode (user space has direct
+access to cycle and insret CSRs only). Note that this legacy value
+is deprecated and will be removed once all userspace applications are fixed.
+
+Note that the time CSR is for now always accessible to all modes.
 
 pid_max
 =======
-- 
2.39.2


  parent reply	other threads:[~2023-06-30  8:40 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-06-30  8:30 [PATCH v3 00/10] riscv: Allow userspace to directly access perf counters Alexandre Ghiti
2023-06-30  8:30 ` [PATCH v3 01/10] perf: Fix wrong comment about default event_idx Alexandre Ghiti
2023-06-30  8:30 ` [PATCH v3 02/10] include: riscv: Fix wrong include guard in riscv_pmu.h Alexandre Ghiti
2023-06-30  8:30 ` [PATCH v3 03/10] riscv: Make legacy counter enum match the HW numbering Alexandre Ghiti
2023-06-30 10:35   ` Andrew Jones
2023-06-30  8:30 ` [PATCH v3 04/10] drivers: perf: Rename riscv pmu sbi driver Alexandre Ghiti
2023-06-30  8:30 ` [PATCH v3 05/10] riscv: Prepare for user-space perf event mmap support Alexandre Ghiti
2023-06-30  8:30 ` [PATCH v3 06/10] drivers: perf: Implement perf event mmap support in the legacy backend Alexandre Ghiti
2023-06-30  8:30 ` [PATCH v3 07/10] drivers: perf: Implement perf event mmap support in the SBI backend Alexandre Ghiti
2023-06-30 11:08   ` Andrew Jones
2023-07-03  9:21     ` Alexandre Ghiti
2023-06-30  8:30 ` Alexandre Ghiti [this message]
2023-06-30 11:16   ` [PATCH v3 08/10] Documentation: admin-guide: Add riscv sysctl_perf_user_access Andrew Jones
2023-07-03  9:45     ` Alexandre Ghiti
2023-06-30  8:30 ` [PATCH v3 09/10] tools: lib: perf: Implement riscv mmap support Alexandre Ghiti
2023-06-30  8:30 ` [PATCH v3 10/10] perf: tests: Adapt mmap-basic.c for riscv Alexandre Ghiti

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230630083013.102334-9-alexghiti@rivosinc.com \
    --to=alexghiti@rivosinc.com \
    --cc=acme@kernel.org \
    --cc=ajones@ventanamicro.com \
    --cc=alexander.shishkin@linux.intel.com \
    --cc=anup@brainfault.org \
    --cc=aou@eecs.berkeley.edu \
    --cc=atishp@atishpatra.org \
    --cc=corbet@lwn.net \
    --cc=irogers@google.com \
    --cc=jolsa@kernel.org \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-perf-users@vger.kernel.org \
    --cc=linux-riscv@lists.infradead.org \
    --cc=mark.rutland@arm.com \
    --cc=mingo@redhat.com \
    --cc=namhyung@kernel.org \
    --cc=palmer@dabbelt.com \
    --cc=paul.walmsley@sifive.com \
    --cc=peterz@infradead.org \
    --cc=robh@kernel.org \
    --cc=will@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox