clone(2)
๐ธ clone(2) โ System Calls Manual ๐ธ
okay so bestie, we're deep in the clone(2) manual page โ yes, the System Calls Manual one โ and it's a whole journey. Buckle up. ๐
๐ NAME ๐
clone, clone3 โ create a child process ๐ผ
๐ LIBRARY ๐
Standard C library (libc, -lc)
โจ SYNOPSIS โจ
/* Prototype for the glibc wrapper function */
#define _GNU_SOURCE
#include <sched.h>
int clone(typeof(int (void *_Nullable)) *fn,
void *stack,
int flags,
void *_Nullable arg, ...
/* pid_t *_Nullable parent_tid,
void *_Nullable tls,
pid_t *_Nullable child_tid */ );
/* For the prototype of the raw clone() system call, see VERSIONS. */
#include <linux/sched.h> /* Definition of struct clone_args */
#include <sched.h> /* Definition of CLONE_* constants */
#include <sys/syscall.h> /* Definition of SYS_* constants */
#include <unistd.h>
long syscall(SYS_clone3, struct clone_args *cl_args, size_t size);
๐ Note: glibc provides no wrapper forclone3(), necessitating the use ofsyscall(2).
๐ DESCRIPTION ๐
These system calls create a new ("child") process, in a manner similar to fork(2).
By contrast with fork(2), these system calls provide more precise control over what pieces of execution context are shared between the calling process and the child process. For example, using these system calls, the caller can control whether or not the two processes share the virtual address space, the table of file descriptors, and the table of signal handlers. These system calls also allow the new child process to be placed in separate namespaces(7).
Note that in this manual page, "calling process" normally corresponds to "parent process". But see the descriptions of CLONE_PARENT and CLONE_THREAD below.
This page describes the following interfaces:
- The glibc
clone()wrapper function and the underlying system call on which it is based. The main text describes the wrapper function; the differences for the raw system call are described toward the end of this page. - The newer
clone3()system call.
In the remainder of this page, the terminology "the clone call" is used when noting details that apply to all of these interfaces.
๐ The clone() wrapper function ๐
When the child process is created with the clone() wrapper function, it commences execution by calling the function pointed to by the argument fn. (This differs from fork(2), where execution continues in the child from the point of the fork(2) call.) The arg argument is passed as the argument of the function fn.
When the fn(arg) function returns, the child process terminates. The integer returned by fn is the exit status for the child process. The child process may also terminate explicitly by calling _exit(3) or after receiving a fatal signal.
The stack argument specifies the location of the stack used by the child process. Since the child and calling process may share memory, it is not possible for the child process to execute in the same stack as the calling process. The calling process must therefore set up memory space for the child stack and pass a pointer to this space to clone(). Stacks grow downward on all processors that run Linux (except the HP PA processors), so stack usually points to the topmost address of the memory space set up for the child stack. Note that clone() does not provide a means whereby the caller can inform the kernel of the size of the stack area.
The remaining arguments to clone() are discussed below.
๐ฆ clone3() ๐ฆ
The clone3() system call provides a superset of the functionality of the older clone() interface. It also provides a number of API improvements, including: space for additional flags bits; cleaner separation in the use of various arguments; and the ability to specify the size of the child's stack area.
As with fork(2), clone3() returns in both the parent and the child. It returns 0 in the child process and returns the PID of the child in the parent.
The cl_args argument of clone3() is a structure of the following form:
struct clone_args {
u64 flags; /* Flags bit mask */
u64 pidfd; /* Where to store PID file descriptor
(int *) */
u64 child_tid; /* Where to store child TID,
in child's memory (pid_t *) */
u64 parent_tid; /* Where to store child TID,
in parent's memory (pid_t *) */
u64 exit_signal; /* Signal to deliver to parent on
child termination */
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 pid_t array
(since Linux 5.5) */
u64 set_tid_size; /* Number of elements in set_tid
(since Linux 5.5) */
u64 cgroup; /* File descriptor for target cgroup
of child (since Linux 5.7) */
};
The size argument that is supplied to clone3() should be initialized to the size of this structure. (The existence of the size argument permits future extensions to the clone_args structure.)
The stack for the child process is specified via cl_args.stack, which points to the lowest byte of the stack area, and cl_args.stack_size, which specifies the size of the stack in bytes. In the case where the CLONE_VM flag (see below) is specified, a stack must be explicitly allocated and specified. Otherwise, these two fields can be specified as NULL and 0, which causes the child to use the same stack area as the parent (in the child's own virtual address space).
The remaining fields in the cl_args argument are discussed below.
๐ Equivalence between clone() and clone3() arguments ๐
Unlike the older clone() interface, where arguments are passed individually, in the newer clone3() interface the arguments are packaged into the clone_args structure shown above. This structure allows for a superset of the information passed via the clone() arguments.
The following table shows the equivalence between the arguments of clone() and the fields in the clone_args argument supplied to clone3():
clone()argument โclone3()cl_argsfield โ Notesflags & ~0xffโflagsโ For most flags; details belowparent_tidโpidfdโ SeeCLONE_PIDFDchild_tidโchild_tidโ SeeCLONE_CHILD_SETTIDparent_tidโparent_tidโ SeeCLONE_PARENT_SETTIDflags & 0xffโexit_signalโ (no extra note)stackโstackโ (no extra note)---โstack_sizeโ (no extra note)tlsโtlsโ SeeCLONE_SETTLS---โset_tidโ See below for details---โset_tid_sizeโ (no extra note)---โcgroupโ SeeCLONE_INTO_CGROUP
๐ผ The child termination signal ๐ผ
When the child process terminates, a signal may be sent to the parent. The termination signal is specified in the low byte of flags (clone()) or in cl_args.exit_signal (clone3()). If this signal is specified as anything other than SIGCHLD, then the parent process must specify the __WALL or __WCLONE options when waiting for the child with wait(2). If no signal (i.e., zero) is specified, then the parent process is not signaled when the child terminates.
๐ง The set_tid array ๐ง
By default, the kernel chooses the next sequential PID for the new process in each of the PID namespaces where it is present. When creating a process with clone3(), the set_tid array (available since Linux 5.5) can be used to select specific PIDs for the process in some or all of the PID namespaces where it is present. If the PID of the newly created process should be set only for the current PID namespace or in the newly created PID namespace (if flags contains CLONE_NEWPID) then the first element in the set_tid array has to be the desired PID and set_tid_size needs to be 1.
If the PID of the newly created process should have a certain value in multiple PID namespaces, then the set_tid array can have multiple entries. The first entry defines the PID in the most deeply nested PID namespace and each of the following entries contains the PID in the corresponding ancestor PID namespace. The number of PID namespaces in which a PID should be set is defined by set_tid_size which cannot be larger than the number of currently nested PID namespaces.
To create a process with the following PIDs in a PID namespace hierarchy:
- PID NS level
0โ Requested PID31496โ Outermost PID namespace - PID NS level
1โ Requested PID42โ (no note) - PID NS level
2โ Requested PID7โ Innermost PID namespace
Set the array to:
set_tid[0] = 7;
set_tid[1] = 42;
set_tid[2] = 31496;
set_tid_size = 3;
If only the PIDs in the two innermost PID namespaces need to be specified, set the array to:
set_tid[0] = 7;
set_tid[1] = 42;
set_tid_size = 2;
The PID in the PID namespaces outside the two innermost PID namespaces is selected the same way as any other PID is selected.
The set_tid feature requires CAP_SYS_ADMIN or (since Linux 5.9) CAP_CHECKPOINT_RESTORE in all owning user namespaces of the target PID namespaces.
Callers may only choose a PID greater than 1 in a given PID namespace if an init process (i.e., a process with PID 1) already exists in that namespace. Otherwise the PID entry for this PID namespace must be 1.
๐ The flags mask ๐
Both clone() and clone3() allow a flags bit mask that modifies their behavior and allows the caller to specify what is shared between the calling process and the child process. This bit maskโthe flags argument of clone() or the cl_args.flags field passed to clone3()โis referred to as the flags mask in the remainder of this page.
The flags mask is specified as a bitwise OR of zero or more of the constants listed below. Except as noted below, these flags are available (and have the same effect) in both clone() and clone3().
CLONE_CHILD_CLEARTID(since Linux 2.5.49) โ Clear (zero) the child thread ID at the location pointed to bychild_tid(clone()) orcl_args.child_tid(clone3()) in child memory when the child exits, and do a wakeup on the futex at that address. The address involved may be changed by theset_tid_address(2)system call. This is used by threading libraries.
CLONE_CHILD_SETTID (since Linux 2.5.49)
okay so this one stores the child thread ID at the location pointed to by child_tid (clone()) or cl_args.child_tid (clone3()) โ in the child's memory ๐พ.
The store operation completes before the clone call returns control to user space in the child process. But โ and this is the tea โ โ note that the store operation may not have completed before the clone call returns in the parent process. That lil' detail matters a whole lot if the CLONE_VM flag is also in the mix.
CLONE_CLEAR_SIGHAND (since Linux 5.5)
By default, signal dispositions in the child thread are literally identical to the parent's. If you set this flag, then every signal that's being handled in the parent (and isn't set to SIG_IGN) gets reset to its default disposition, SIG_DFL, in the child ๐.
Specifying this flag together with CLONE_SIGHAND is nonsensical and disallowed. don't do it bestie, the kernel will simply say no ๐
โโ๏ธ
CLONE_DETACHED (historical)
so for a while โ during the Linux 2.5 development era โ there was a CLONE_DETACHED flag that made the parent not receive a signal when the child terminated. Eventually that whole vibe got subsumed into the CLONE_THREAD flag, and by the time Linux 2.6.0 dropped, this flag had no effect at all ๐. And since Linux 2.6.2, you don't even need to pass it alongside CLONE_THREAD anymore.
The flag is still defined, but it's usually ignored when you call clone(). However โ peep the description of CLONE_PIDFD, there are a couple exceptions ๐.
CLONE_FILES (since Linux 2.0)
Set CLONE_FILES and the calling process and the child share the same file descriptor table ๐๏ธ. Any file descriptor created by either one becomes valid in the other too. Same energy in reverse: if one of them closes a file descriptor, or changes its associated flags (via the fcntl(2) F_SETFD operation), the other process is affected as well.
Plot twist though: if a process sharing a file descriptor table calls execve(2), its file descriptor table gets duplicated (unshared).
If CLONE_FILES is not set, the child inherits a copy of all file descriptors that were open in the calling process at the moment of the clone call. After that, any operations that open or close file descriptors, or change file descriptor flags, performed by either process โ they don't affect the other one. But note ๐ the duplicated file descriptors in the child still refer to the same open file descriptions as the corresponding descriptors in the calling process, so they share file offsets and file status flags. See open(2) for the deets.
CLONE_FS (since Linux 2.0)
With CLONE_FS set, the caller and the child share the same filesystem information โ that's the root of the filesystem, the current working directory, and the umask ๐ณ. So any call to chroot(2), chdir(2), or umask(2) made by either process affects the other one too.
If CLONE_FS is not set, the child operates on a copy of the filesystem info as it was at the time of the clone call. Later chroot(2), chdir(2), or umask(2) calls by one process don't touch the other. clean separation, we love to see it โจ
CLONE_INTO_CGROUP (since Linux 5.7)
By default a child process lands in the same version 2 cgroup as its parent. CLONE_INTO_CGROUP lets the child be created in a different version 2 cgroup instead ๐ฏ. (Heads up: this flag only has an effect for version 2 cgroups.)
To drop the child somewhere else, 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. You can get that file descriptor by opening a cgroup v2 directory using either the O_RDONLY or the O_PATH flag. And reminder: all the usual restrictions on placing a process into a version 2 cgroup apply, and they live in cgroups(7).
Some possible use cases for CLONE_INTO_CGROUP, because you know I'm gonna list them all ๐
:
- Spawning a process into a cgroup that's different from the parent's means a service manager can directly spawn new services into dedicated cgroups ๐ง. This kills the accounting jitter you'd get if the child was first created in the parent's cgroup and then moved into the target one. Bonus: spawning the child straight into the target cgroup is also significantly cheaper than moving it after creation.
- This flag also lets you create frozen child processes by spawning them into a frozen cgroup ๐ง. (See
cgroups(7)for the freezer controller.) - For threaded applications โ or even thread implementations that use cgroups to limit individual threads โ you can establish a fixed cgroup layout before spawning each thread directly into its target cgroup. immaculate architecture honestly.
CLONE_IO (since Linux 2.6.25)
Set CLONE_IO and the new process shares an I/O context with the calling process ๐ฝ. If it's not set, then (just like fork(2)) the new process gets its own I/O context.
So what even is the I/O context? It's the I/O scope of the disk scheduler โ like, what the I/O scheduler uses to model the scheduling of a process's I/O. If processes share the same I/O context, the scheduler treats them as one, which means they get to share disk time together ๐ซถ. For some I/O schedulers, two processes sharing an I/O context are allowed to interleave their disk access. And if several threads are doing I/O on behalf of the same process (think aio_read(3)), they should employ CLONE_IO for better I/O performance. slay.
One catch: if the kernel isn't configured with the CONFIG_BLOCK option, this flag is a total no-op ๐.
CLONE_NEWCGROUP (since Linux 4.6)
Creates the process in a new cgroup namespace ๐ช. If this flag isn't set, then (as with fork(2)) the process is created in the same cgroup namespace as the calling process.
More info on cgroup namespaces lives in cgroup_namespaces(7).
Only a privileged process (CAP_SYS_ADMIN) can employCLONE_NEWCGROUP. ๐
CLONE_NEWIPC (since Linux 2.6.19)
Set CLONE_NEWIPC and the process is created in a new IPC namespace ๐ฌ. Not set? Then (as with fork(2)) it's created in the same IPC namespace as the calling process.
More on IPC namespaces: ipc_namespaces(7).
Only a privileged process (CAP_SYS_ADMIN) can employCLONE_NEWIPC๐ . And this flag can't be specified in conjunction withCLONE_SYSVSEM.
CLONE_NEWNET (since Linux 2.6.24)
(fun fact: the implementation of this flag wasn't actually finished until around Linux 2.6.29 ๐)
Set CLONE_NEWNET and the process is created in a new network namespace ๐. If it's not set, then (as with fork(2)) the process is created in the same network namespace as the calling process.
Further reading: network_namespaces(7).
Only a privileged process (CAP_SYS_ADMIN) can employCLONE_NEWNET. no cap, you need the cap ๐
CLONE_NEWNS (since Linux 2.4.19)
Set CLONE_NEWNS and the cloned child starts in a new mount namespace, initialized with a copy of the parent's namespace ๐๏ธ. If CLONE_NEWNS isn't set, the child lives in the same mount namespace as the parent.
More on mount namespaces: namespaces(7) and mount_namespaces(7).
Only a privileged process (CAP_SYS_ADMIN) can employCLONE_NEWNS. And it is not permitted to specify bothCLONE_NEWNSandCLONE_FSin the sameclonecall โ pick a lane bestie ๐ซ
CLONE_NEWPID (since Linux 2.6.24)
Set CLONE_NEWPID and the process is created in a new PID namespace ๐ข. If it's not set, then (as with fork(2)) the process is created in the same PID namespace as the calling process.
Further info on PID namespaces: namespaces(7) and pid_namespaces(7).
Only a privileged process (CAP_SYS_ADMIN) can employCLONE_NEWPID. And this flag can't be specified in conjunction withCLONE_THREAD.
CLONE_NEWUSER
(This flag first became meaningful for clone() in Linux 2.6.23, the current clone() semantics were merged in Linux 3.5, and the final pieces that made user namespaces completely usable were merged in Linux 3.8. a whole saga honestly ๐ซ )
If CLONE_NEWUSER is set, the process is created in a new user namespace ๐งโ๐คโ๐ง. If it's not set, then (as with fork(2)) the process is created in the same user namespace as the calling process.
More on user namespaces: namespaces(7) and user_namespaces(7).
Before Linux 3.8, using CLONE_NEWUSER required the caller to hold three capabilities: CAP_SYS_ADMIN, CAP_SETUID, and CAP_SETGID. Starting with Linux 3.8, no privileges are needed to create a user namespace ๐
This flag can't be specified in conjunction withCLONE_THREADorCLONE_PARENT. And for security reasons,CLONE_NEWUSERcannot be specified in conjunction withCLONE_FS. that's a hard no for safety fr fr
CLONE_NEWUTS (since Linux 2.6.19)
Set CLONE_NEWUTS and the process is created in a new UTS namespace, whose identifiers are initialized by duplicating the identifiers from the calling process's UTS namespace ๐ท๏ธ. If this flag isn't set, then (as with fork(2)) the process is created in the same UTS namespace as the calling process.
More on UTS namespaces: uts_namespaces(7).
Only a privileged process (CAP_SYS_ADMIN) can employCLONE_NEWUTS๐.
CLONE_PARENT (since Linux 2.3.12)
If CLONE_PARENT is set, then the parent of the new child โ the one getppid(2) returns โ will be the same as that of the calling process ๐ซ.
If CLONE_PARENT is not set, then (as with fork(2)) the child's parent is the calling process.
lowkey important: the process that gets the signal when the child dies is whoevergetppid(2)says is the parent. So if you setCLONE_PARENT, the signal goes to the calling process's parent, not the calling process itself. Plot twist! ๐
And here's the tea: nobody can use CLONE_PARENT in a clone call if they're the global init process (PID 1 in the initial PID namespace) or an init process in any other PID namespace. The kernel says nope because it's blocking two cursed outcomes: multi-rooted process trees (iykyk, nightmare fuel) and unreapable zombies chillin' in the initial PID namespace. Not today, bestie. ๐ง
CLONE_PARENT_SETTID(since Linux 2.5.49) โ drop the child thread ID right at the address thatparent_tidpoints to (clone()) orcl_args.parent_tidpoints to (clone3()), and it lands in the parent's memory, not the kid's. Fun lil lore drop: back in Linux 2.5.32โ2.5.48 there was a flag calledCLONE_SETTIDthat did this exact job. The store finishes before the clone call gives control back to user space, so you can actually trust it. โจCLONE_PID(Linux 2.0 to Linux 2.5.15) โ set this and the child gets created with the same process ID as the calling process. It's "good for hacking the system" (iconic phrasing, honestly) but otherwise not much use. From Linux 2.3.21 onward only the system boot process (PID 0) was even allowed to pass it. Then it vanished completely from the kernel sources in Linux 2.5.16. After that the kernel just silently ignored the bit if you put it in the flags mask. Much later, the same bit got recycled forCLONE_PIDFD. Recycling era ๐CLONE_PIDFD(since Linux 5.2) โ specify this and a PID file descriptor that refers to the child process gets allocated and placed at a specified location in the parent's memory. The close-on-exec flag is set on this shiny new file descriptor. What are PID file descriptors even for? That'spidfd_open(2)territory, go look.- With
clone3(), the PID file descriptor goes to the location thatcl_args.pidfdpoints to. - With
clone(), the PID file descriptor goes to the location thatparent_tidpoints to. And sinceparent_tidis busy returning the PID file descriptor,CLONE_PIDFDcannot be used withCLONE_PARENT_SETTIDwhen you're callingclone(). They're fighting over the same parking spot, fr fr. ๐๐ฅ - If
CLONE_PIDFDis specified together withCLONE_THREAD, the PID file descriptor you get refers to a specific thread, instead of a thread-group leader like whenCLONE_THREADisn't specified. This one's available since Linux 6.9. ๐ - If the obsolete
CLONE_DETACHEDflag is specified alongsideCLONE_PIDFDwhen callingclone(), you get an error. You also get an error ifCLONE_DETACHEDis specified when callingclone3(). Why so strict? So that the bit corresponding toCLONE_DETACHEDstays free and reusable for future PID file descriptor features. Strategic bit hoarding, honestly. ๐ฅ
- With
CLONE_PTRACE(since Linux 2.2) โ if this is set and the calling process is being traced, then the child gets traced too (peepptrace(2)). Like matching friendship bracelets but for debuggers. ๐ซถCLONE_SETTLS(since Linux 2.5.32) โ the TLS (Thread Local Storage) descriptor gets set totls. Howtlsgets interpreted and what it actually does depends on the architecture, no cap:- On x86,
tlsis interpreted as astruct user_desc *(seeset_thread_area(2)). - On x86-64 it's the new value to be set for the
%fsbase register (see theARCH_SET_FSargument toarch_prctl(2)). - On architectures with a dedicated TLS register, it's the new value of that register.
- On x86,
โ ๏ธ Using this flag requires detailed knowledge and generally it should not be used except in libraries implementing threading. If that's not you, step away. ๐ญ
CLONE_SIGHAND(since Linux 2.0) โ set this and the calling process and the child share the same table of signal handlers. If either one callssigaction(2)to change the behavior tied to a signal, the behavior changes in the other one too. But โ and this is the part people forget โ the calling process and the child processes still have distinct signal masks and distinct sets of pending signals. So one of them can block or unblock signals withsigprocmask(2)without touching the other. Sharing the vibes, not the boundaries. ๐ IfCLONE_SIGHANDis not set, the child inherits a copy of the calling process's signal handlers as they were at the moment of the clone call. Latersigaction(2)calls made by one process have zero effect on the other. Independent queens. ๐ Since Linux 2.6.0, the flags mask must also includeCLONE_VMifCLONE_SIGHANDis specified. Package deal.CLONE_STOPPED(since Linux 2.6.0) โ set this and the child starts out stopped (like someone sent it aSIGSTOP), and it has to be resumed by sending it aSIGCONT. Deprecated from Linux 2.6.25 onward, and removed altogether in Linux 2.6.38. Since the removal, the kernel silently ignores it, no error, no drama. Starting with Linux 4.6 the same bit got reused for theCLONE_NEWCGROUPflag. Bits never truly die, they just get a rebrand. ๐CLONE_SYSVSEM(since Linux 2.5.10) โ set this and the child and the calling process share one single list of System V semaphore adjustment (semadj) values (seesemop(2)). When they share, that shared list accumulatessemadjvalues across every process sharing it, and the semaphore adjustments only actually happen when the last process sharing the list terminates (or stops sharing it viaunshare(2)). If this flag is not set, the child gets its own separatesemadjlist that starts out empty. Fresh start energy. โจCLONE_THREAD(since Linux 2.4.0) โ set this and the child is placed in the same thread group as the calling process. Quick vocab check so the rest makes sense: from here on, "thread" means a process within a thread group. ๐งต Thread groups were added in Linux 2.4 to support the POSIX threads notion of a set of threads sharing a single PID. Internally, that shared PID is the so-called thread group identifier (TGID) for the thread group. Since Linux 2.4, calls togetpid(2)return the TGID of the caller. Wild, right? Threads in a group are told apart by their (system-wide) unique thread IDs (TID). A new thread's TID is handed to you as the function result, and a thread can grab its own TID withgettid(2). Make a clone call withoutCLONE_THREADand the resulting thread lands in a new thread group whose TGID equals that thread's TID โ congrats, it's the leader of the new thread group. ๐ A new thread created withCLONE_THREADhas the same parent process as the process that made the clone call (just likeCLONE_PARENT), sogetppid(2)returns the same value for every thread in the group. When aCLONE_THREADthread terminates, the thread that created it is not sent aSIGCHLD(or any other termination) signal, and you can't get its status withwait(2)either. It's called detached, and it's giving ghosting, honestly. ๐ป After all the threads in a thread group terminate, the parent process of the thread group gets sent aSIGCHLD(or other termination) signal. If any thread in a group callsexecve(2), then all threads other than the thread group leader are terminated, and the new program runs in the thread group leader. Main character survives, everyone else exits stage left. ๐ญ If one thread in a group creates a child withfork(2), then any thread in the group canwait(2)for that child. Group effort. Since Linux 2.5.35, the flags mask must also includeCLONE_SIGHANDifCLONE_THREADis specified โ and heads up, since Linux 2.6.0CLONE_SIGHANDalso requiresCLONE_VMto be included. The dependency chain is real. ๐ Signal dispositions and actions are process-wide: if an unhandled signal gets delivered to a thread, it will affect (terminate, stop, continue, or be ignored in) all members of the thread group. Each thread does have its own signal mask, though, as set bysigprocmask(2). A signal can be process-directed or thread-directed. A process-directed signal is targeted at a thread group (i.e., a TGID) and gets delivered to an arbitrarily selected thread among those not blocking it. A signal may be process-directed because the kernel generated it for reasons other than a hardware exception, or because it was sent usingkill(2)orsigqueue(3). A thread-directed signal is targeted at (delivered to) one specific thread โ it may be thread-directed because it was sent usingtgkill(2)orpthread_sigqueue(3), or because the thread executed a machine language instruction that triggered a hardware exception (e.g., an invalid memory access triggeringSIGSEGV, or a floating-point exception triggeringSIGFPE). A call tosigpending(2)returns a signal set that is the union of the pending process-directed signals and the signals pending for the calling thread. Two streams, one answer. ๐ซ If a process-directed signal is delivered to a thread group and the group has installed a handler for it, then the handler is invoked in exactly one, arbitrarily selected member of the group that has not blocked the signal. And if multiple threads in a group are waiting to accept the same signal withsigwaitinfo(2), the kernel arbitrarily picks one of them to receive it. Lotto energy, but make it signals. ๐ฐCLONE_UNTRACED(since Linux 2.5.46) โ specify this and a tracing process cannot forceCLONE_PTRACEon this child process. Not on my watch. ๐CLONE_VFORK(since Linux 2.2) โ set this and the calling process's execution is suspended until the child releases its virtual memory resources via a call toexecve(2)or_exit(3)(as withvfork(2)). Basically the parent is sitting there refreshing the page waiting for the kid to finish. ๐ญ IfCLONE_VFORKis not set, then both the calling process and the child are schedulable right after the call, and an application should not rely on execution happening in any particular order. No assumptions bestie, the scheduler does what it wants. ๐ธ
CLONE_VM (since Linux 2.0)
okay so bestie, if CLONE_VM is set, the calling process and the child process are literally running in the same memory space ๐ซ not metaphorically, not "spiritually", fr fr. Memory writes done by the caller show up in the child and vice versa. And any memory mapping or unmapping done with mmap(2) or munmap(2) by the child or by the calling process also affects the other one. Same brain, no secrets ๐ง
If CLONE_VM is not set, the child runs in a separate copy of the caller's memory space, taken at the moment of the clone call. Memory writes, file mappings and unmappings done by one of them don't touch the other โ exactly like fork(2) ๐ธ
๐ heads up though: if theCLONE_VMflag is specified and theCLONE_VFORKflag is not, then any alternate signal stack that was established bysigaltstack(2)gets cleared in the child process. so like. know that.
โจ RETURN VALUE โจ
On success, the thread ID of the child process is returned in the caller's thread of execution. cute, right? ๐
On failure, -1 is returned in the caller's context, no child process is created, and errno is set to say what went wrong ๐ญ
๐จ ERRORS ๐จ
bestie this list is LONG and I'm not skipping a single one, that's the whole vibe:
E2BIG(clone3() only) โ the kernel doesn't support some functionality requested in thisclone3()call: the size argument is larger than what the kernel supports, and there are non-zero values in the struct after the kernel-supported size.E2BIG(clone3() only) โ the size argument is larger than the page size.EACCES(clone3() only) โCLONE_INTO_CGROUPwas specified incl_args.flags, but the restrictions (described incgroups(7)) on placing the child process into the version 2 cgroup referred to bycl_args.cgroupare not met. nope. ๐ซEAGAINโ too many processes are already running; seefork(2).EBUSY(clone3() only) โCLONE_INTO_CGROUPwas specified incl_args.flags, but the file descriptor specified incl_args.cgrouprefers to a version 2 cgroup in which a domain controller is enabled.EEXIST(clone3() only) โ one (or more) of the PIDs specified inset_tidalready exists in the corresponding PID namespace.EINVALโ bothCLONE_SIGHANDandCLONE_CLEAR_SIGHANDwere specified in the flags mask. pick ONE, bestie ๐EINVALโCLONE_SIGHANDwas specified in the flags mask, butCLONE_VMwas not. (Since Linux 2.6.0.)EINVALโCLONE_THREADwas specified in the flags mask, butCLONE_SIGHANDwas not. (Since Linux 2.5.35.)EINVALโCLONE_THREADwas specified in the flags mask, but the current process previously calledunshare(2)with theCLONE_NEWPIDflag, or usedsetns(2)to reassociate itself with a PID namespace.EINVALโ bothCLONE_FSandCLONE_NEWNSwere specified in the flags mask.EINVAL(since Linux 3.9) โ bothCLONE_NEWUSERandCLONE_FSwere specified in the flags mask.EINVALโ bothCLONE_NEWIPCandCLONE_SYSVSEMwere specified in the flags mask.EINVALโCLONE_NEWPIDand one (or both) ofCLONE_THREADorCLONE_PARENTwere specified in the flags mask.EINVALโCLONE_NEWUSERandCLONE_THREADwere specified in the flags mask.EINVAL(since Linux 2.6.32) โCLONE_PARENTwas specified, and the caller is an init process.EINVALโ returned by the glibcclone()wrapper function when fn or stack is specified asNULL.EINVALโCLONE_NEWIPCwas specified in the flags mask, but the kernel was not configured with theCONFIG_SYSVIPCandCONFIG_IPC_NSoptions.EINVALโCLONE_NEWNETwas specified in the flags mask, but the kernel was not configured with theCONFIG_NET_NSoption.EINVALโCLONE_NEWPIDwas specified in the flags mask, but the kernel was not configured with theCONFIG_PID_NSoption.EINVALโCLONE_NEWUSERwas specified in the flags mask, but the kernel was not configured with theCONFIG_USER_NSoption.EINVALโCLONE_NEWUTSwas specified in the flags mask, but the kernel was not configured with theCONFIG_UTS_NSoption.EINVALโ stack is not aligned to a suitable boundary for this architecture. for example, on aarch64, stack must be a multiple of16๐EINVAL(clone3() only) โCLONE_DETACHEDwas specified in the flags mask.EINVAL(clone() only) โCLONE_PIDFDwas specified together withCLONE_DETACHEDin the flags mask.EINVAL(before Linux 6.9) โCLONE_PIDFDwas specified together withCLONE_THREADin the flags mask.EINVAL(clone() only) โCLONE_PIDFDwas specified together withCLONE_PARENT_SETTIDin the flags mask.EINVAL(clone3() only) โset_tid_sizeis greater than the number of nested PID namespaces.EINVAL(clone3() only) โ one of the PIDs specified inset_tidwas an invalid.EINVAL(clone3() only) โCLONE_THREADorCLONE_PARENTwas specified in the flags mask, but a signal was specified inexit_signal.EINVAL(AArch64 only, Linux 4.6 and earlier) โ stack was not aligned to a 128-bit boundary.ENOMEMโ cannot allocate sufficient memory to allocate a task structure for the child, or to copy those parts of the caller's context that need to be copied. the memory said no ๐ฅฒENOSPC(since Linux 3.7) โCLONE_NEWPIDwas specified in the flags mask, but the limit on the nesting depth of PID namespaces would have been exceeded; seepid_namespaces(7).ENOSPC(since Linux 4.9; beforehandEUSERS) โCLONE_NEWUSERwas specified in the flags mask, and the call would cause the limit on the number of nested user namespaces to be exceeded. seeuser_namespaces(7).
From Linux 3.11 to Linux 4.8, the error diagnosed in this case was EUSERS.
ENOSPC(since Linux 4.9) โ one of the values in the flags mask specified the creation of a new user namespace, but doing so would have caused the limit defined by the corresponding file in/proc/sys/userto be exceeded. for further details, seenamespaces(7).EOPNOTSUPP(clone3() only) โCLONE_INTO_CGROUPwas specified incl_args.flags, but the file descriptor specified incl_args.cgrouprefers to a version 2 cgroup that is in the domain invalid state.EPERMโCLONE_NEWCGROUP,CLONE_NEWIPC,CLONE_NEWNET,CLONE_NEWNS,CLONE_NEWPID, orCLONE_NEWUTSwas specified by an unprivileged process (process withoutCAP_SYS_ADMIN). permission said absolutely not ๐ซEPERMโCLONE_PIDwas specified by a process other than process0. (This error occurs only on Linux 2.5.15 and earlier.)EPERMโCLONE_NEWUSERwas specified in the flags mask, but either the effective user ID or the effective group ID of the caller does not have a mapping in the parent namespace (seeuser_namespaces(7)).EPERM(since Linux 3.9) โCLONE_NEWUSERwas specified in the flags mask and the caller is in a chroot environment (i.e., the caller's root directory does not match the root directory of the mount namespace in which it resides).EPERM(clone3() only) โset_tid_sizewas greater than zero, and the caller lacks theCAP_SYS_ADMINcapability in one or more of the user namespaces that own the corresponding PID namespaces.ERESTARTNOINTR(since Linux 2.6.17) โ system call was interrupted by a signal and will be restarted. (This can be seen only during a trace.) ๐EUSERS(Linux 3.11 to Linux 4.8) โCLONE_NEWUSERwas specified in the flags mask, and the limit on the number of nested user namespaces would be exceeded. see the discussion of theENOSPCerror above.
๐ VERSIONS ๐
The glibc clone() wrapper function makes some changes in the memory pointed to by stack (changes required to set the stack up correctly for the child) before invoking the clone() system call. so like, if you're using clone() to recursively create children, do not use the buffer you used for the parent's stack as the stack of the child. seriously. that's not a vibe, that's a bug ๐ซ
On i386, clone() should not be called through vsyscall, but directly through int $0x80.
๐ง C library/kernel differences
The raw clone() system call corresponds more closely to fork(2) in that execution in the child continues from the point of the call. as such, the fn and arg arguments of the clone() wrapper function are omitted. different energy entirely.
In contrast to the glibc wrapper, the raw clone() system call accepts NULL as a stack argument (and clone3() likewise allows cl_args.stack to be NULL). In this case, the child uses a duplicate of the parent's stack. (Copy-on-write semantics ensure that the child gets separate copies of stack pages when either process modifies the stack.) In this case, for correct operation, the CLONE_VM option should not be specified. (If the child shares the parent's memory because of the use of the CLONE_VM flag, then no copy-on-write duplication occurs and chaos is likely to result ๐ no cap.)
The order of the arguments also differs in the raw system call, and there are variations in the arguments across architectures, as detailed in the following paragraphs.
The raw system call interface on x86-64 and some other architectures (including sh, tile, and alpha) is:
long clone(unsigned long flags, void *stack,
int *parent_tid, int *child_tid,
unsigned long tls);
On x86-32, and several other common architectures (including score, ARM, ARM 64, PA-RISC, arc, Power PC, xtensa, and MIPS), the order of the last two arguments is reversed:
long clone(unsigned long flags, void *stack,
int *parent_tid, unsigned long tls,
int *child_tid);
On the cris and s390 architectures, the order of the first two arguments is reversed:
long clone(void *stack, unsigned long flags,
int *parent_tid, int *child_tid,
unsigned long tls);
On the microblaze architecture, an additional argument is supplied:
long clone(unsigned long flags, void *stack,
int stack_size, /* Size of stack */
int *parent_tid, int *child_tid,
unsigned long tls);
๐พ blackfin, m68k, and sparc
The argument-passing conventions on blackfin, m68k, and sparc are different from the descriptions above. For details, see the kernel (and glibc) source. iykyk ๐
๐ STANDARDS ๐
Linux. periodt.
๐ HISTORY (the lore bestie, the backstory) ๐
clone3() ๐ฃ
Linux 5.3. fresh out the oven, a whole new baby.
๐ฟ Linux 2.4 and earlier ๐ฟ (yes we're going that far back)
- Back in the Linux 2.4.x era,
CLONE_THREADgenerally did not make the parent of the new thread the same as the parent of the calling process. it's giving "we didn't know what we wanted yet" energy fr. - BUT. plot twist. from Linux 2.4.7 to Linux 2.4.18, the
CLONE_THREADflag implied theCLONE_PARENTflag โ exactly like it does in Linux 2.6.0 and later. so there was a little window where it was doing the modern thing early. evolved, then un-evolved, then evolved again. character development ๐ - And in Linux 2.4 and earlier,
clone()does not take the argumentsparent_tid,tls, andchild_tid. they literally weren't invited to the function signature. no cap.
๐๏ธ ia64 ๐๏ธ
On ia64, a different interface was used: __clone2(2). different era, different syscall, same dreams โจ
๐ NOTES (the lil side quests) ๐
One use of these system calls is to implement threads: multiple flows of control in a program that run concurrently in a shared address space. that's the whole point bestie, that's the assignment. ๐
The kcmp(2) system call can be used to test whether two processes share various resources such as a file descriptor table, System V semaphore undo operations, or a virtual address space. lil detective behavior ๐
Handlers registered using pthread_atfork(3) are not executed during a clone call. so if you were relying on thoseโฆ yeah. not happening. ๐ซ
๐ BUGS (the tea, and it's messy) ๐
GNU C library versions 2.3.4 up to and including 2.24 contained a wrapper function for getpid(2) that performed caching of PIDs. This caching relied on support in the glibc wrapper for clone(), but limitations in the implementation meant that the cache was not up to date in some circumstances. ๐ญ
In particular, if a signal was delivered to the child immediately after the clone() call, then a call to getpid(2) in a handler for the signal could return the PID of the calling process ("the parent"), if the clone wrapper had not yet had a chance to update the PID cache in the child. imagine being a whole new process and getting handed your mom's ID. embarrassing. ๐
(This discussion ignores the case where the child was created usingCLONE_THREAD, whengetpid(2)should return the same value in the child and in the process that calledclone(), since the caller and the child are in the same thread group. The stale-cache problem also does not occur if theflagsargument includesCLONE_VM.) โ okay so those two cases are exempt, noted, moving on ๐ซก
To get the truth, it was sometimes necessary to use code such as the following:
#include <syscall.h>
pid_t mypid;
mypid = syscall(SYS_getpid);
Because of the stale-cache problem, as well as other problems noted in getpid(2), the PID caching feature was removed in glibc 2.25. bye bestie, you will not be missed ๐
โจ EXAMPLES โจ (demo time, we're doing a whole build) โจ
The following program demonstrates the use of clone() to create a child process that executes in a separate UTS namespace. The child changes the hostname in its UTS namespace. Both parent and child then display the system hostname, making it possible to see that the hostname differs in the UTS namespaces of the parent and child. For an example of the use of this program, see setns(2). ๐ง
Within the sample program, we allocate the memory that is to be used for the child's stack using mmap(2) rather than malloc(3) for the following reasons:
mmap(2)allocates a block of memory that starts on a page boundary and is a multiple of the page size. This is useful if we want to establish a guard page (a page with protectionPROT_NONE) at the end of the stack usingmprotect(2). fancy, protective, iconic. ๐ก๏ธ- We can specify the
MAP_STACKflag to request a mapping that is suitable for a stack. For the moment, this flag is a no-op on Linux, but it exists and has effect on some other systems, so we should include it for portability. iykyk โ future-proofing is self care ๐
๐ Program source ๐
#define _GNU_SOURCE
#include <err.h>
#include <sched.h>
#include <signal.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/mman.h>
#include <sys/types.h>
#include <sys/utsname.h>
#include <sys/wait.h>
#include <unistd.h>
static int /* Start function for cloned child */
childFunc(void *arg)
{
struct utsname uts;
/* Change hostname in UTS namespace of child. */
if (sethostname(arg, strlen(arg)) == -1)
err(EXIT_FAILURE, "sethostname");
/* Retrieve and display hostname. */
if (uname(&uts) == -1)
err(EXIT_FAILURE, "uname");
printf("uts.nodename in child: %s\n", uts.nodename);
/* Keep the namespace open for a while, by sleeping.
This allows some experimentation--for example, another
process might join the namespace. */
sleep(200);
return 0; /* Child terminates now */
}
#define STACK_SIZE (1024 * 1024) /* Stack size for cloned child */
int
main(int argc, char *argv[])
{
char *stack; /* Start of stack buffer */
char *stackTop; /* End of stack buffer */
pid_t pid;
struct utsname uts;
if (argc < 2) {
fprintf(stderr, "Usage: %s <child-hostname>\n", argv[0]);
exit(EXIT_SUCCESS);
}
/* Allocate memory to be used for the stack of the child. */
stack = mmap(NULL, STACK_SIZE, PROT_READ | PROT_WRITE,
MAP_PRIVATE | MAP_ANONYMOUS | MAP_STACK, -1, 0);
if (stack == MAP_FAILED)
err(EXIT_FAILURE, "mmap");
stackTop = stack + STACK_SIZE; /* Assume stack grows downward */
/* Create child that has its own UTS namespace;
child commences execution in childFunc(). */
pid = clone(childFunc, stackTop, CLONE_NEWUTS | SIGCHLD, argv[1]);
if (pid == -1)
err(EXIT_FAILURE, "clone");
if (munmap(stack, STACK_SIZE))
err(EXIT_FAILURE, "munmap");
printf("clone() returned %jd\n", (intmax_t) pid);
/* Parent falls through to here */
sleep(1); /* Give child time to change its hostname */
/* Display hostname in parent's UTS namespace. This will be
different from hostname in child's UTS namespace. */
if (uname(&uts) == -1)
err(EXIT_FAILURE, "uname");
printf("uts.nodename in parent: %s\n", uts.nodename);
if (waitpid(pid, NULL, 0) == -1) /* Wait for child */
err(EXIT_FAILURE, "waitpid");
printf("child has terminated\n");
exit(EXIT_SUCCESS);
}
๐ SEE ALSO (the mutuals, go follow them) ๐
fork(2), futex(2), getpid(2), gettid(2), kcmp(2), mmap(2), pidfd_open(2), set_thread_area(2), set_tid_address(2), setns(2), tkill(2), unshare(2), wait(2), capabilities(7), namespaces(7), pthreads(7)
and that's the whole page bestie!! you made it to the end, which is genuinely iconic of you ๐
โจ fin โจ
this lil masterpiece is from Linux man-pages 6.20, dated 2026-06-06, and it's the clone(2) page. go forth and fork responsibly ๐๐ฆ๐ธ
๐ฆ where this page comes from
- arch rolling: man-pages 6.20-1 ยท BSD-2-Clause AND BSD-3-Clause AND BSD-4.3TAHOE AND BSD-4-Clause-UC AND GPL-1.0-or-later AND GPL-2.0-only AND GPL-2.0-or-later AND GPL-3.0-or-later AND LGPL-3.0-linking-exception AND LGPL-3.0-or-later AND LicenseRef-Public-Domain AND LicenseRef-UltraPermissive AND Linux-man-pages-1-para AND Linux-man-pages-copyleft AND Linux-man-pages-copyleft-2-para AND Linux-man-pages-copyleft-var AND MIT AND Spencer-94
- nixpkgs unstable: man-pages 6.20
- ๐ the page's license: GPL-1.0-or-later
- Copyright 1992, Drew Eckhardt <drew@cs.colorado.edu>
- Copyright 2001-2019, Michael Kerrisk <mtk.manpages@gmail.com>
- ๐ girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms