prctl.2: doc PR_SET/GET_IO_FLUSHER - V4
PATCH 1/1 prctl.2: doc PR_SET/GET_IO_FLUSHER - V4
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 <[email protected]> Date: Mon Nov 11 18:19:00 2019 -0600
prctl: PR_{G,S}ET_IO_FLUSHER to support controlling memory reclaim
---
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.
man2/prctl.2 | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+)
man2/prctl.2 +26 -0
@@ -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.
Signature · 1 line
2.21.0
Quoted 4 lines · Mike Christie
+.TP
+.BPR_GET_IO_FLUSHER(Since Linux 5.6)
+Return as the function result 1 if the caller is in theIO_FLUSHERstate and +0 if not.
Although I'm not at all a language expert, the word order at the start of the above sentence seems a bit weird to me?
Thanks,
Bart.
Quoted 8 lines · Bart Van Assche
Quoted 4 lines · Mike Christie
+.TP
+.BPR_GET_IO_FLUSHER(Since Linux 5.6)
+Return as the function result 1 if the caller is in theIO_FLUSHERstate and +0 if not.Although I'm not at all a language expert, the word order at the start of the above sentence seems a bit weird to me?
Thanks for spotting that Bart. I changed the text to:
If a user process is involved in the block layer or filesystem I/O path, and can allocate memory while process‐ ing I/O requests it must set arg2 to 1. This will put the process in the IO_FLUSHER state, which allows it special treatment to make progress when allocating memory. If arg2 is 0, the process will clear the IO_FLUSHER state, and the default behavior will be used.
Cheers,
Michael
Signature · 3 lines
Michael Kerrisk Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/ Linux/UNIX System Programming Training: http://man7.org/training/
Quoted 9 lines · Bart Van Assche
Quoted 4 lines · Mike Christie
+.TP
+.BPR_GET_IO_FLUSHER(Since Linux 5.6)
+Return as the function result 1 if the caller is in theIO_FLUSHERstate and +0 if not.Although I'm not at all a language expert, the word order at the start of the above sentence seems a bit weird to me?
Do you mean the "Return as the function result" part or something else?
That is how the other commands worded it. It looks like I messed up and dropped the (). This is how they did it:
"Return (as the function result)"
I will resend with that fix.
If I misunderstood you I will fix that too.
Quoted 14 lines · Michael Christie
Quoted 9 lines · Bart Van Assche
Quoted 4 lines · Mike Christie
+.TP
+.BPR_GET_IO_FLUSHER(Since Linux 5.6)
+Return as the function result 1 if the caller is in theIO_FLUSHERstate and +0 if not.Although I'm not at all a language expert, the word order at the start of the above sentence seems a bit weird to me?
Do you mean the "Return as the function result" part or something else?
Quoted 8 lines
That is how the other commands worded it. It looks like I messed up and dropped the (). This is how they did it:
"Return (as the function result)"
I will resend with that fix.
If I misunderstood you I will fix that too.
I already fixed this piece. There are still the open questions in my other mail though.
Signature · 3 lines
Michael Kerrisk Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/ Linux/UNIX System Programming Training: http://man7.org/training/
Quoted 10 lines · Mike Christie
This patch documents the
PR_SET_IO_FLUSHERandPR_GET_IO_FLUSHERprctl commands added to the linux kernel for 5.6 in commit:commit
8d19f1c8e1937baf74e1962aae9f90fa3aeab463Author: Mike Christie <[email protected]> Date: Mon Nov 11 18:19:00 2019 -0600prctl: PR_{G,S}ET_IO_FLUSHER to support controlling memory reclaim
Signed-off-by Mike Christie <[email protected]>
Yes this wording is much better than the previous version.
Quoted 64 lines
---
V4:
- Remove internal details.
- AddCAP_SYS_RESOURCErequirement 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 <[email protected]>man2/prctl.2 | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+)man2/prctl.2 +26
-0@@ -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.Signature · 1 line
2.21.0
Signature · 2 lines
Michal Hocko SUSE Labs
Quoted 8 lines · Michal Hocko
Quoted 7 lines · Mike Christie
This patch documents the
PR_SET_IO_FLUSHERandPR_GET_IO_FLUSHERprctl commands added to the linux kernel for 5.6 in commit:commit
8d19f1c8e1937baf74e1962aae9f90fa3aeab463Author: Mike Christie <[email protected]> Date: Mon Nov 11 18:19:00 2019 -0600
Quoted 7 lines
Quoted 3 lines
prctl: PR_{G,S}ET_IO_FLUSHER to support controlling memory reclaim
Signed-off-by Mike Christie <[email protected]>Yes this wording is much better than the previous version.
Acked-by Michal Hocko <[email protected]>
Thanks for the review, Michal!
Signature · 3 lines
Michael Kerrisk Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/ Linux/UNIX System Programming Training: http://man7.org/training/
Hello Mike,
Quoted 9 lines · Mike Christie
This patch documents the
PR_SET_IO_FLUSHERandPR_GET_IO_FLUSHERprctl commands added to the linux kernel for 5.6 in commit:commit
8d19f1c8e1937baf74e1962aae9f90fa3aeab463Author: Mike Christie <[email protected]> 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 <[email protected]>
I've applied this patch, but I have some questions:
(a) What happens to the IO_FLUSHER setting in the child of fork(2)?
(b) What happens to the IO_FLUSHER setting during an execve(2)? (Is it preserved, reset, something else?)
Thanks,
Michael
Quoted 63 lines
---
V4:
- Remove internal details.
- AddCAP_SYS_RESOURCErequirement 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 <[email protected]>man2/prctl.2 | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+)man2/prctl.2 +26
-0@@ -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.
Signature · 3 lines
Michael Kerrisk Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/ Linux/UNIX System Programming Training: http://man7.org/training/
Quoted 6 lines · Michael Kerrisk (man-pages)
Hello Mike,
Quoted 3 lines · Mike Christie
This patch documents the
PR_SET_IO_FLUSHERandPR_GET_IO_FLUSHERprctl commands added to the linux kernel for 5.6 in commit:
Quoted 8 lines
Quoted 6 lines
commit
8d19f1c8e1937baf74e1962aae9f90fa3aeab463Author: Mike Christie <[email protected]> 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 <[email protected]>I've applied this patch, but I have some questions:
Hey,
Thanks for fixing up the patch for me.
Quoted 2 lines
(a) What happens to the
IO_FLUSHERsetting in the child of fork(2)?
The child will inherit the setting.
Quoted 2 lines
(b) What happens to the
IO_FLUSHERsetting during an execve(2)? (Is it preserved, reset, something else?)
It's preserved.
Hi Mike,
Quoted 13 lines · Mike Christie
Quoted 11 lines · Michael Kerrisk (man-pages)
Hello Mike,
Quoted 8 lines · Mike Christie
This patch documents the
PR_SET_IO_FLUSHERandPR_GET_IO_FLUSHERprctl commands added to the linux kernel for 5.6 in commit:commit
8d19f1c8e1937baf74e1962aae9f90fa3aeab463Author: Mike Christie <[email protected]> Date: Mon Nov 11 18:19:00 2019 -0600>prctl: PR_{G,S}ET_IO_FLUSHER to support controlling memory reclaim
Quoted 7 lines
Quoted 3 lines
Quoted 1 line
Signed-off-by Mike Christie <[email protected]>I've applied this patch, but I have some questions:
Hey,
Thanks for fixing up the patch for me.
you're welcome.
Quoted 8 lines
Quoted 1 line
(a) What happens to the
IO_FLUSHERsetting in the child of fork(2)?The child will inherit the setting.
Quoted 2 lines
(b) What happens to the
IO_FLUSHERsetting during an execve(2)? (Is it preserved, reset, something else?)It's preserved.
Thanks. I added this text:
The IO_FLUSHER state is inherited by a child process cre‐ ated via fork(2) and is preserved across execve(2).
Cheers,
Michael
Signature · 3 lines
Michael Kerrisk Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/ Linux/UNIX System Programming Training: http://man7.org/training/