git: 54a8d1fbbf65 - main - getrlimit(2): document RLIMIT_PIPEBUF

From: Konstantin Belousov <kib_at_FreeBSD.org>
Date: Fri, 20 Sep 2024 06:46:48 UTC
The branch main has been updated by kib:

URL: https://cgit.FreeBSD.org/src/commit/?id=54a8d1fbbf65e976132809718525ba051a5525cf

commit 54a8d1fbbf65e976132809718525ba051a5525cf
Author:     Konstantin Belousov <kib@FreeBSD.org>
AuthorDate: 2024-09-10 04:11:55 +0000
Commit:     Konstantin Belousov <kib@FreeBSD.org>
CommitDate: 2024-09-20 06:46:06 +0000

    getrlimit(2): document RLIMIT_PIPEBUF
    
    Sponsored by:   The FreeBSD Foundation
    MFC after:      1 week
    Differential revision:  https://reviews.freebsd.org/D46619
---
 lib/libsys/getrlimit.2 | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/lib/libsys/getrlimit.2 b/lib/libsys/getrlimit.2
index d9b8b7cb896c..d54dc703ada0 100644
--- a/lib/libsys/getrlimit.2
+++ b/lib/libsys/getrlimit.2
@@ -84,6 +84,16 @@ The maximum number of open files for this process.
 The maximum number of simultaneous processes for this user id.
 .It Dv RLIMIT_NPTS
 The maximum number of pseudo-terminals this user id is allowed to create.
+.It Dv RLIMIT_PIPEBUF
+The maximum total size of in-kernel buffers for bi-directional pipes/fifos
+that this user id is allowed to consume.
+The buffers for kernel FIFOs created on the first open of a filesystem
+object created by
+.Pq Xr mkfifo 2
+are also charged to the user ID of the process opening it,
+not the FIFO's filesystem owner.
+Despite somewhat unexpected, this is in fact fair, since user of the fifo
+is not necessary its creator.
 .It Dv RLIMIT_RSS
 When there is memory pressure and swap is available, prioritize eviction of
 a process' resident pages beyond this amount (in bytes).