archive mirror
 help / color / mirror / Atom feed
From: Alexey Budankov <>
To: Jonatan Corbet <>,
	Kees Cook <>,
	Thomas Gleixner <>,
	Ingo Molnar <>,
	Peter Zijlstra <>
Cc: Jann Horn <>,
	Arnaldo Carvalho de Melo <>,
	Jiri Olsa <>, Namhyung Kim <>,
	Alexander Shishkin <>,
	Andi Kleen <>,
	Mark Rutland <>,
	Tvrtko Ursulin <>,
	"" <>,
	linux-kernel <>
Subject: [PATCH v3 1/4] perf-security: document perf_events/Perf resource control
Date: Mon, 11 Feb 2019 16:42:58 +0300	[thread overview]
Message-ID: <> (raw)
In-Reply-To: <>

Extend perf-security.rst file with perf_events/Perf resource control
section describing RLIMIT_NOFILE and perf_event_mlock_kb settings for
performance monitoring user processes.

Signed-off-by: Alexey Budankov <>
Changes in v3:
- added two more paragraphs on open fds and memory allocation
- applied comments and corrected typos

Changes in v2:
- applied comments on v1

 Documentation/admin-guide/perf-security.rst | 42 +++++++++++++++++++++
 1 file changed, 42 insertions(+)

diff --git a/Documentation/admin-guide/perf-security.rst b/Documentation/admin-guide/perf-security.rst
index f73ebfe9bfe2..bac599e3c55f 100644
--- a/Documentation/admin-guide/perf-security.rst
+++ b/Documentation/admin-guide/perf-security.rst
@@ -84,6 +84,46 @@ governed by perf_event_paranoid [2]_ setting:
      locking limit is imposed but ignored for unprivileged processes with
      CAP_IPC_LOCK capability.
+perf_events/Perf resource control
+Open file descriptors
+The perf_events system call API [2]_ allocates file descriptors for every configured
+PMU event. Open file descriptors are a per-process accountable resource governed
+by the RLIMIT_NOFILE [11]_ limit (ulimit -n), which is usually derived from the login
+shell process. When configuring Perf collection for a long list of events on a
+large server system, this limit can be easily hit preventing required monitoring
+configuration. RLIMIT_NOFILE limit can be increased on per-user basis modifying
+content of the limits.conf file [12]_ . Ordinarily, a Perf sampling session
+(perf record) requires an amount of open perf_event file descriptors that is not
+less than the number of monitored events multiplied by the number of monitored CPUs.
+Memory allocation
+The amount of memory available to user processes for capturing performance monitoring
+data is governed by the perf_event_mlock_kb [2]_ setting. This perf_event specific
+resource setting defines overall per-cpu limits of memory allowed for mapping
+by the user processes to execute performance monitoring. The setting essentially
+extends the RLIMIT_MEMLOCK [11]_ limit, but only for memory regions mapped specifically
+for capturing monitored performance events and related data.
+For example, if a machine has eight cores and perf_event_mlock_kb limit is set
+to 516 KiB, then a user process is provided with 516 KiB * 8 = 4128 KiB of memory
+above the RLIMIT_MEMLOCK limit (ulimit -l) for perf_event mmap buffers. In particular,
+this means that, if the user wants to start two or more performance monitoring
+processes, the user is required to manually distribute the available 4128 KiB between the
+monitoring processes, for example, using the --mmap-pages Perf record mode option.
+Otherwise, the first started performance monitoring process allocates all available
+4128 KiB and the other processes will fail to proceed due to the lack of memory.
+RLIMIT_MEMLOCK and perf_event_mlock_kb resource constraints are ignored for
+processes with the CAP_IPC_LOCK capability. Thus, perf_events/Perf privileged users
+can be provided with memory above the constraints for perf_events/Perf performance
+monitoring purpose by providing the Perf executable with CAP_IPC_LOCK capability.
@@ -94,4 +134,6 @@ Bibliography
 .. [5] `<>`_
 .. [6] `<>`_
 .. [7] `<>`_
+.. [11] `<>`_
+.. [12] `<>`_

  reply	other threads:[~2019-02-11 13:42 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-02-11 13:32 [PATCH v3 0/3] admin-guide: extend perf-security with resource control, data categories and privileged users Alexey Budankov
2019-02-11 13:42 ` Alexey Budankov [this message]
2019-02-11 13:43 ` [PATCH v3 2/4] perf-security: document collected perf_events/Perf data categories Alexey Budankov
2019-02-11 13:44 ` [PATCH v3 3/4] perf-security: elaborate on perf_events/Perf privileged users Alexey Budankov
2019-02-11 13:45 ` [PATCH v3 4/4] perf-security: wrap paragraphs on 72 columns Alexey Budankov
2019-02-11 14:58 ` Alexey Budankov
2019-02-17 23:14 ` [PATCH v3 0/3] admin-guide: extend perf-security with resource control, data categories and privileged users Jonathan Corbet
2019-02-18  8:56   ` Alexey Budankov

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:

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

  git send-email \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \

* 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;
as well as URLs for NNTP newsgroup(s).