Hello Christian,
Thanks for this patch!
On 5/18/20 7:55 PM, Christian Brauner wrote:
> From: Christian Brauner <christian.brauner@xxxxxxxxxx>
>
> Signed-off-by: Christian Brauner <christian.brauner@xxxxxxxxxx>
> ---
> /* v2 */
> - Michael Kerrisk (man-pages) <mtk.manpages@xxxxxxxxx>:
> - Fix various types and add examples and how to specify the file
> descriptor.
> ---
> man2/clone.2 | 43 +++++++++++++++++++++++++++++++++++++++++++
> 1 file changed, 43 insertions(+)
>
> diff --git a/man2/clone.2 b/man2/clone.2
> index 8b70b78a4..33594ddc5 100644
> --- a/man2/clone.2
> +++ b/man2/clone.2
> @@ -197,6 +197,7 @@ struct clone_args {
> u64 tls; /* Location of new TLS */
> u64 set_tid; /* Pointer to a \fIpid_t\fP array */
> u64 set_tid_size; /* Number of elements in \fIset_tid\fP */
> + u64 cgroup; /* Target cgroup file descriptor for the child process */
> };
> .EE
> .in
> @@ -448,6 +449,48 @@ Specifying this flag together with
> .B CLONE_SIGHAND
> is nonsensical and disallowed.
> .TP
> +.BR CLONE_INTO_CGROUP " (since Linux 5.7)"
> +.\" commit ef2c41cf38a7559bbf91af42d5b6a4429db8fc68
> +By default, the child process will be placed in the same version 2
> +cgroup as its parent.
> +If this flag is specified the child process will be created in a
> +different cgroup than its parent.
> +Note, that
> +.BR CLONE_INTO_CGROUP
> +is limited to version 2 cgroups. To use this feature, callers
> +need to raise
> +.BR CLONE_INTO_CGROUP
> +in
> +.I cl_args.flags
> +and pass a directory file descriptor (see the
> +.BR O_DIRECTORY
> +flag for the
> +.BR open (2)
> +syscall) in the
I think the mention of O_DIRECTORY here is a bit misleading. That
flag does not need to be used. O_RDONLY or O_PATH suffices; I
reworded somewhat.
> +.I cl_args.cgroup.
> +The caller may also pass an
> +.BR O_PATH
> +(see
> +.BR open (2))
> +file descriptor for the target cgroup.
> +Note, that all usual version 2 cgroup migration restrictions (see
> +.BR cgroups (7)
> +for details) apply.
Here I presume you mean things like the "no internal processes
rule" and the restriction around putting a process into a
"domain invalid" cgroup, right? I reworded a things and added
a couple of cases in ERRORS.
> +
> +Spawning a process into a cgroup different from the parent's cgroup
> +makes it possible for a service manager to directly spawn new
> +services into dedicated cgroups. This allows eliminating accounting
> +jitter which would be caused by the new process living in the
> +parent's cgroup for a short amount of time before being
> +moved into the target cgroup. This flag also allows the creation of
> +frozen child process by spawning them into a frozen cgroup (see
> +.BR cgroups (7)
> +for a description of the freezer feature in version 2 cgroups).
> +For threaded applications or even thread implementations which
> +make use of cgroups to limit individual threads it is possible to
> +establish a fixed cgroup layout before spawning each thread
> +directly into its target cgroup.
Thanks for these use cases; that's great!
So, I did some fairly heavy editing, which resulted in the
following (the sum of the diffs is shown at the end of this
mail):
CLONE_INTO_CGROUP (since Linux 5.7)
By default, a child process is placed in the same version 2
cgroup as its parent. The CLONE_INTO_CGROUP allows the
child process to be created in a different version 2
cgroup. (Note that CLONE_INTO_CGROUP has effect only for
version 2 cgroups.)
In order to place the child process in a different cgroup,
the caller specifies CLONE_INTO_CGROUP in cl_args.flags and
passes a file descriptor that refers to a version 2 cgroup
in the cl_args.cgroup field. (This file descriptor can be
obtained by opening a cgroup v2 directory file using either
the O_RDONLY or the O_PATH flag.) Note that all of the
usual restrictions (described in cgroups(7)) on placing a
process into a version 2 cgroup apply.
Spawning a process into a cgroup different from the par‐
ent's cgroup makes it possible for a service manager to
directly spawn new services into dedicated cgroups. This
eliminates the accounting jitter that would be caused if
the child process was first created in the same cgroup as
the parent and then moved into the target cgroup. The
CLONE_INTO_CGROUP flag also allows the creation of frozen
child processes by spawning them into a frozen cgroup.
(See cgroups(7) for a description of the freezer con‐
troller.) For threaded applications (or even thread imple‐
mentations which make use of cgroups to limit individual
threads), it is possible to establish a fixed cgroup layout
before spawning each thread directly into its target
cgroup.
ERRORS
EBUSY (clone3() only)
CLONE_INTO_CGROUP was specified in cl_args.flags, but the
file descriptor specified in cl_args.cgroup refers to a
version 2 cgroup in which a domain controller is enabled.
EOPNOTSUP (clone3() only)
CLONE_INTO_CGROUP was specified in cl_args.flags, but the
file descriptor specified in cl_args.cgroup refers to a
version 2 cgroup that is in the domain invalid state.
Look okay to you?
Thanks,
Michael
diff --git a/man2/clone.2 b/man2/clone.2
index 8b70b78a4..a4ce0d412 100644
--- a/man2/clone.2
+++ b/man2/clone.2
@@ -195,8 +195,12 @@ struct clone_args {
u64 stack; /* Pointer to lowest byte of stack */
u64 stack_size; /* Size of stack */
u64 tls; /* Location of new TLS */
- u64 set_tid; /* Pointer to a \fIpid_t\fP array */
- u64 set_tid_size; /* Number of elements in \fIset_tid\fP */
+ u64 set_tid; /* Pointer to a \fIpid_t\fP array
+ (since Linux 5.5) */
+ u64 set_tid_size; /* Number of elements in \fIset_tid\fP
+ (since Linux 5.5) */
+ u64 cgroup; /* File descriptor for target cgroup
+ of child (since Linux 5.7) */
};
.EE
.in
@@ -266,6 +270,7 @@ stack stack
tls tls See CLONE_SETTLS
\fP---\fP set_tid See below for details
\fP---\fP set_tid_size
+\fP---\fP cgroup See CLONE_INTO_CGROUP
.TE
.RE
.\"
@@ -448,6 +453,54 @@ Specifying this flag together with
.B CLONE_SIGHAND
is nonsensical and disallowed.
.TP
+.BR CLONE_INTO_CGROUP " (since Linux 5.7)"
+.\" commit ef2c41cf38a7559bbf91af42d5b6a4429db8fc68
+By default, a child process is placed in the same version 2
+cgroup as its parent.
+The
+.B CLONE_INTO_CGROUP
+allows the child process to be created in a different version 2 cgroup.
+(Note that
+.BR CLONE_INTO_CGROUP
+has effect only for version 2 cgroups.)
+.IP
+In order to place the child process in a different cgroup,
+the caller specifies
+.BR CLONE_INTO_CGROUP
+in
+.I cl_args.flags
+and passes a file descriptor that refers to a version 2 cgroup in the
+.I cl_args.cgroup
+field.
+(This file descriptor can be obtained by opening a cgroup v2 directory file
+using either the
+.B O_RDONLY
+or the
+.B O_PATH
+flag.)
+Note that all of the usual restrictions (described in
+.BR cgroups (7))
+on placing a process into a version 2 cgroup apply.
+.IP
+Spawning a process into a cgroup different from the parent's cgroup
+makes it possible for a service manager to directly spawn new
+services into dedicated cgroups.
+This eliminates the accounting
+jitter that would be caused if the child process was first created in the
+same cgroup as the parent and then
+moved into the target cgroup.
+The
+.BR CLONE_INTO_CGROUP
+flag also allows the creation of
+frozen child processes by spawning them into a frozen cgroup.
+(See
+.BR cgroups (7)
+for a description of the freezer controller.)
+For threaded applications (or even thread implementations which
+make use of cgroups to limit individual threads), it is possible to
+establish a fixed cgroup layout before spawning each thread
+directly into its target cgroup.
+.TP
.BR CLONE_DETACHED " (historical)"
For a while (during the Linux 2.5 development series)
.\" added in 2.5.32; removed in 2.6.0-test4
@@ -1304,6 +1357,14 @@ will be set appropriately.
Too many processes are already running; see
.BR fork (2).
.TP
+.BR EBUSY " (" clone3 "() only)"
+.B CLONE_INTO_CGROUP
+was specified in
+.IR cl_args.flags ,
+but the file descriptor specified in
+.IR cl_args.cgroup
+refers to a version 2 cgroup in which a domain controller is enabled.
+.TP
.BR EEXIST " (" clone3 "() only)"
One (or more) of the PIDs specified in
.I set_tid
@@ -1546,6 +1607,16 @@ to be exceeded.
For further details, see
.BR namespaces (7).
.TP
+.BR EOPNOTSUP " (" clone3 "() only)"
+.B CLONE_INTO_CGROUP
+was specified in
+.IR cl_args.flags ,
+but the file descriptor specified in
+.IR cl_args.cgroup
+refers to a version 2 cgroup that is in the
+.IR "domain invalid"
+state.
+.TP
.B EPERM
.BR CLONE_NEWCGROUP ,
.BR CLONE_NEWIPC ,
--
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
