From: Mike Christie <mchristi@redhat.com>
To: linux-api@vger.kernel.org, david@fromorbit.com, mhocko@suse.com,
masato.suzuki@wdc.com, damien.lemoal@wdc.com,
darrick.wong@oracle.com, bvanassche@acm.org,
mtk.manpages@gmail.com, linux-man@vger.kernel.org
Cc: Mike Christie <mchristi@redhat.com>
Subject: [PATCH] prctl.2: doc PR_SET/GET_IO_FLUSHER - V4
Date: Wed, 1 Apr 2020 21:08:50 -0500 [thread overview]
Message-ID: <20200402020850.7218-1-mchristi@redhat.com> (raw)
This patch documents the PR_SET_IO_FLUSHER and PR_GET_IO_FLUSHER
prctl commands added to the linux kernel for 5.6 in commit:
commit 8d19f1c8e1937baf74e1962aae9f90fa3aeab463
Author: Mike Christie <mchristi@redhat.com>
Date: Mon Nov 11 18:19:00 2019 -0600
prctl: PR_{G,S}ET_IO_FLUSHER to support controlling memory reclaim
Signed-off-by: Mike Christie <mchristi@redhat.com>
---
V4:
- Remove internal details.
- Add CAP_SYS_RESOURCE requirement info.
V3:
- Replace emulation device example.
V2:
- My initial patch for this was very bad. This version is almost 100%
taken word for word from Dave Chinner's review comments.
Signed-off-by: Mike Christie <mchristi@redhat.com>
man2/prctl.2 | 26 ++++++++++++++++++++++++++
1 file changed, 26 insertions(+)
diff --git a/man2/prctl.2 b/man2/prctl.2
index 720ec04e4..3c3355439 100644
--- a/man2/prctl.2
+++ b/man2/prctl.2
@@ -1381,6 +1381,31 @@ system call on Tru64).
for information on versions and architectures.)
Return unaligned access control bits, in the location pointed to by
.IR "(unsigned int\ *) arg2" .
+.TP
+.B PR_SET_IO_FLUSHER (Since Linux 5.6)
+If a user process is involved in the block layer or file system IO path,
+and can allocate memory while processing IO requests it must set
+\fIarg2\fP to 1. This will put the process in the IO_FLUSHER state which
+allows it special treatment to make progress when allocating memory.
+If \fIarg2\fP is 0, the process will clear the IO_FLUSHER state, and
+the default behavior will be used.
+
+The calling process must have the
+.BR CAP_SYS_RESOURCE
+capability.
+
+Examples of IO_FLUSHER applications are FUSE daemons, SCSI device
+emulation daemons, and daemons that perform error handling like multipath
+path recovery applications.
+
+.TP
+.B PR_GET_IO_FLUSHER (Since Linux 5.6)
+Return as the function result 1 if the caller is in the IO_FLUSHER state and
+0 if not.
+
+The calling process must have the
+.BR CAP_SYS_RESOURCE
+capability.
.SH RETURN VALUE
On success,
.BR PR_GET_DUMPABLE ,
@@ -1395,6 +1420,7 @@ On success,
.BR PR_GET_SPECULATION_CTRL ,
.BR PR_MCE_KILL_GET ,
.BR PR_CAP_AMBIENT + PR_CAP_AMBIENT_IS_SET ,
+.BR PR_GET_IO_FLUSHER ,
and (if it returns)
.BR PR_GET_SECCOMP
return the nonnegative values described above.
--
2.21.0
next reply other threads:[~2020-04-02 2:08 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-04-02 2:08 Mike Christie [this message]
2020-04-02 3:46 ` [PATCH] prctl.2: doc PR_SET/GET_IO_FLUSHER - V4 Bart Van Assche
2020-04-02 12:16 ` Michael Kerrisk (man-pages)
2020-04-02 14:01 ` Michael Christie
2020-04-02 20:12 ` Michael Kerrisk (man-pages)
2020-04-02 6:47 ` Michal Hocko
2020-04-02 12:16 ` Michael Kerrisk (man-pages)
2020-04-02 12:16 ` Michael Kerrisk (man-pages)
2020-04-04 21:07 ` Mike Christie
2020-04-06 11:00 ` Michael Kerrisk (man-pages)
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=20200402020850.7218-1-mchristi@redhat.com \
--to=mchristi@redhat.com \
--cc=bvanassche@acm.org \
--cc=damien.lemoal@wdc.com \
--cc=darrick.wong@oracle.com \
--cc=david@fromorbit.com \
--cc=linux-api@vger.kernel.org \
--cc=linux-man@vger.kernel.org \
--cc=masato.suzuki@wdc.com \
--cc=mhocko@suse.com \
--cc=mtk.manpages@gmail.com \
/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;
as well as URLs for NNTP newsgroup(s).