1 // Copyright 2011 The Go Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style
3 // license that can be found in the LICENSE file.
15 // Linux unshare/clone/clone2/clone3 flags, architecture-independent,
16 // copied from linux/sched.h.
18 CLONE_VM = 0x00000100 // set if VM shared between processes
19 CLONE_FS = 0x00000200 // set if fs info shared between processes
20 CLONE_FILES = 0x00000400 // set if open files shared between processes
21 CLONE_SIGHAND = 0x00000800 // set if signal handlers and blocked signals shared
22 CLONE_PIDFD = 0x00001000 // set if a pidfd should be placed in parent
23 CLONE_PTRACE = 0x00002000 // set if we want to let tracing continue on the child too
24 CLONE_VFORK = 0x00004000 // set if the parent wants the child to wake it up on mm_release
25 CLONE_PARENT = 0x00008000 // set if we want to have the same parent as the cloner
26 CLONE_THREAD = 0x00010000 // Same thread group?
27 CLONE_NEWNS = 0x00020000 // New mount namespace group
28 CLONE_SYSVSEM = 0x00040000 // share system V SEM_UNDO semantics
29 CLONE_SETTLS = 0x00080000 // create a new TLS for the child
30 CLONE_PARENT_SETTID = 0x00100000 // set the TID in the parent
31 CLONE_CHILD_CLEARTID = 0x00200000 // clear the TID in the child
32 CLONE_DETACHED = 0x00400000 // Unused, ignored
33 CLONE_UNTRACED = 0x00800000 // set if the tracing process can't force CLONE_PTRACE on this clone
34 CLONE_CHILD_SETTID = 0x01000000 // set the TID in the child
35 CLONE_NEWCGROUP = 0x02000000 // New cgroup namespace
36 CLONE_NEWUTS = 0x04000000 // New utsname namespace
37 CLONE_NEWIPC = 0x08000000 // New ipc namespace
38 CLONE_NEWUSER = 0x10000000 // New user namespace
39 CLONE_NEWPID = 0x20000000 // New pid namespace
40 CLONE_NEWNET = 0x40000000 // New network namespace
41 CLONE_IO = 0x80000000 // Clone io context
43 // Flags for the clone3() syscall.
45 CLONE_CLEAR_SIGHAND = 0x100000000 // Clear any signal handler and reset to SIG_DFL.
46 CLONE_INTO_CGROUP = 0x200000000 // Clone into a specific cgroup given the right permissions.
48 // Cloning flags intersect with CSIGNAL so can be used with unshare and clone3
51 CLONE_NEWTIME = 0x00000080 // New time namespace
54 // SysProcIDMap holds Container ID to Host ID mappings used for User Namespaces in Linux.
55 // See user_namespaces(7).
56 type SysProcIDMap struct {
57 ContainerID int // Container ID.
58 HostID int // Host ID.
62 type SysProcAttr struct {
63 Chroot string // Chroot.
64 Credential *Credential // Credential.
65 // Ptrace tells the child to call ptrace(PTRACE_TRACEME).
66 // Call runtime.LockOSThread before starting a process with this set,
67 // and don't call UnlockOSThread until done with PtraceSyscall calls.
69 Setsid bool // Create session.
70 // Setpgid sets the process group ID of the child to Pgid,
71 // or, if Pgid == 0, to the new child's process ID.
73 // Setctty sets the controlling terminal of the child to
74 // file descriptor Ctty. Ctty must be a descriptor number
75 // in the child process: an index into ProcAttr.Files.
76 // This is only meaningful if Setsid is true.
78 Noctty bool // Detach fd 0 from controlling terminal
79 Ctty int // Controlling TTY fd
80 // Foreground places the child process group in the foreground.
81 // This implies Setpgid. The Ctty field must be set to
82 // the descriptor of the controlling TTY.
83 // Unlike Setctty, in this case Ctty must be a descriptor
84 // number in the parent process.
86 Pgid int // Child's process group ID if Setpgid.
87 // Pdeathsig, if non-zero, is a signal that the kernel will send to
88 // the child process when the creating thread dies. Note that the signal
89 // is sent on thread termination, which may happen before process termination.
90 // There are more details at https://go.dev/issue/27505.
92 Cloneflags uintptr // Flags for clone calls (Linux only)
93 Unshareflags uintptr // Flags for unshare calls (Linux only)
94 UidMappings []SysProcIDMap // User ID mappings for user namespaces.
95 GidMappings []SysProcIDMap // Group ID mappings for user namespaces.
96 // GidMappingsEnableSetgroups enabling setgroups syscall.
97 // If false, then setgroups syscall will be disabled for the child process.
98 // This parameter is no-op if GidMappings == nil. Otherwise for unprivileged
99 // users this should be set to false for mappings work.
100 GidMappingsEnableSetgroups bool
101 AmbientCaps []uintptr // Ambient capabilities (Linux only)
102 UseCgroupFD bool // Whether to make use of the CgroupFD field.
103 CgroupFD int // File descriptor of a cgroup to put the new process into.
107 none = [...]byte{'n', 'o', 'n', 'e', 0}
108 slash = [...]byte{'/', 0}
111 // Implemented in runtime package.
112 func runtime_BeforeFork()
113 func runtime_AfterFork()
114 func runtime_AfterForkInChild()
116 // Fork, dup fd onto 0..len(fd), and exec(argv0, argvv, envv) in child.
117 // If a dup or exec fails, write the errno error to pipe.
118 // (Pipe is close-on-exec so if exec succeeds, it will be closed.)
119 // In the child, this function must not acquire any locks, because
120 // they might have been locked at the time of the fork. This means
121 // no rescheduling, no malloc calls, and no new stack segments.
122 // For the same reason compiler does not race instrument it.
123 // The calls to RawSyscall are okay because they are assembly
124 // functions that do not grow the stack.
127 func forkAndExecInChild(argv0 *byte, argv, envv []*byte, chroot, dir *byte, attr *ProcAttr, sys *SysProcAttr, pipe int) (pid int, err Errno) {
128 // Set up and fork. This returns immediately in the parent or
129 // if there's an error.
130 upid, err, mapPipe, locked := forkAndExecInChild1(argv0, argv, envv, chroot, dir, attr, sys, pipe)
138 // parent; return PID
141 if sys.UidMappings != nil || sys.GidMappings != nil {
144 // uid/gid mappings will be written after fork and unshare(2) for user
146 if sys.Unshareflags&CLONE_NEWUSER == 0 {
147 if err := writeUidGidMappings(pid, sys); err != nil {
151 RawSyscall(SYS_WRITE, uintptr(mapPipe[1]), uintptr(unsafe.Pointer(&err2)), unsafe.Sizeof(err2))
158 const _LINUX_CAPABILITY_VERSION_3 = 0x20080522
160 type capHeader struct {
165 type capData struct {
175 // See CAP_TO_INDEX in linux/capability.h:
176 func capToIndex(cap uintptr) uintptr { return cap >> 5 }
178 // See CAP_TO_MASK in linux/capability.h:
179 func capToMask(cap uintptr) uint32 { return 1 << uint(cap&31) }
181 // cloneArgs holds arguments for clone3 Linux syscall.
182 type cloneArgs struct {
183 flags uint64 // Flags bit mask
184 pidFD uint64 // Where to store PID file descriptor (int *)
185 childTID uint64 // Where to store child TID, in child's memory (pid_t *)
186 parentTID uint64 // Where to store child TID, in parent's memory (pid_t *)
187 exitSignal uint64 // Signal to deliver to parent on child termination
188 stack uint64 // Pointer to lowest byte of stack
189 stackSize uint64 // Size of stack
190 tls uint64 // Location of new TLS
191 setTID uint64 // Pointer to a pid_t array (since Linux 5.5)
192 setTIDSize uint64 // Number of elements in set_tid (since Linux 5.5)
193 cgroup uint64 // File descriptor for target cgroup of child (since Linux 5.7)
196 // forkAndExecInChild1 implements the body of forkAndExecInChild up to
197 // the parent's post-fork path. This is a separate function so we can
198 // separate the child's and parent's stack frames if we're using
201 // This is go:noinline because the point is to keep the stack frames
202 // of this and forkAndExecInChild separate.
207 func forkAndExecInChild1(argv0 *byte, argv, envv []*byte, chroot, dir *byte, attr *ProcAttr, sys *SysProcAttr, pipe int) (pid uintptr, err1 Errno, mapPipe [2]int, locked bool) {
208 // Defined in linux/prctl.h starting with Linux 4.3.
210 PR_CAP_AMBIENT = 0x2f
211 PR_CAP_AMBIENT_RAISE = 0x2
214 // vfork requires that the child not touch any of the parent's
215 // active stack frames. Hence, the child does all post-fork
216 // processing in this stack frame and never returns, while the
217 // parent returns immediately from this frame and does all
218 // post-fork processing in the outer frame.
220 // Declare all variables at top in case any
221 // declarations require heap allocation (e.g., err2).
222 // ":=" should not be used to declare any variable after
223 // the call to runtime_BeforeFork.
225 // NOTE(bcmills): The allocation behavior described in the above comment
226 // seems to lack a corresponding test, and it may be rendered invalid
227 // by an otherwise-correct change in the compiler.
234 puid, psetgroups, pgid []byte
235 uidmap, setgroups, gidmap []byte
240 ngroups, groups uintptr
244 rlim, rlimOK := origRlimitNofile.Load().(Rlimit)
246 if sys.UidMappings != nil {
247 puid = []byte("/proc/self/uid_map\000")
248 uidmap = formatIDMappings(sys.UidMappings)
251 if sys.GidMappings != nil {
252 psetgroups = []byte("/proc/self/setgroups\000")
253 pgid = []byte("/proc/self/gid_map\000")
255 if sys.GidMappingsEnableSetgroups {
256 setgroups = []byte("allow\000")
258 setgroups = []byte("deny\000")
260 gidmap = formatIDMappings(sys.GidMappings)
263 // Record parent PID so child can test if it has died.
264 ppid, _ := rawSyscallNoError(SYS_GETPID, 0, 0, 0)
266 // Guard against side effects of shuffling fds below.
267 // Make sure that nextfd is beyond any currently open files so
268 // that we can't run the risk of overwriting any of them.
269 fd := make([]int, len(attr.Files))
270 nextfd = len(attr.Files)
271 for i, ufd := range attr.Files {
272 if nextfd < int(ufd) {
279 // Allocate another pipe for parent to child communication for
280 // synchronizing writing of User ID/Group ID mappings.
281 if sys.UidMappings != nil || sys.GidMappings != nil {
282 if err := forkExecPipe(mapPipe[:]); err != nil {
288 flags = sys.Cloneflags
289 if sys.Cloneflags&CLONE_NEWUSER == 0 && sys.Unshareflags&CLONE_NEWUSER == 0 {
290 flags |= CLONE_VFORK | CLONE_VM
292 // Whether to use clone3.
295 flags: uint64(flags) | CLONE_INTO_CGROUP,
296 exitSignal: uint64(SIGCHLD),
297 cgroup: uint64(sys.CgroupFD),
299 } else if flags&CLONE_NEWTIME != 0 {
301 flags: uint64(flags),
302 exitSignal: uint64(SIGCHLD),
306 // About to call fork.
307 // No more allocation or calls of non-assembly functions.
311 pid, err1 = rawVforkSyscall(_SYS_clone3, uintptr(unsafe.Pointer(clone3)), unsafe.Sizeof(*clone3))
313 flags |= uintptr(SIGCHLD)
314 if runtime.GOARCH == "s390x" {
315 // On Linux/s390, the first two arguments of clone(2) are swapped.
316 pid, err1 = rawVforkSyscall(SYS_CLONE, 0, flags)
318 pid, err1 = rawVforkSyscall(SYS_CLONE, flags, 0)
321 if err1 != 0 || pid != 0 {
322 // If we're in the parent, we must return immediately
323 // so we're not in the same stack frame as the child.
324 // This can at most use the return PC, which the child
325 // will not modify, and the results of
326 // rawVforkSyscall, which must have been written after
327 // the child was replaced.
331 // Fork succeeded, now in child.
333 // Enable the "keep capabilities" flag to set ambient capabilities later.
334 if len(sys.AmbientCaps) > 0 {
335 _, _, err1 = RawSyscall6(SYS_PRCTL, PR_SET_KEEPCAPS, 1, 0, 0, 0, 0)
341 // Wait for User ID/Group ID mappings to be written.
342 if sys.UidMappings != nil || sys.GidMappings != nil {
343 if _, _, err1 = RawSyscall(SYS_CLOSE, uintptr(mapPipe[1]), 0, 0); err1 != 0 {
346 pid, _, err1 = RawSyscall(SYS_READ, uintptr(mapPipe[0]), uintptr(unsafe.Pointer(&err2)), unsafe.Sizeof(err2))
350 if pid != unsafe.Sizeof(err2) {
362 _, _, err1 = RawSyscall(SYS_SETSID, 0, 0, 0)
369 if sys.Setpgid || sys.Foreground {
370 // Place child in process group.
371 _, _, err1 = RawSyscall(SYS_SETPGID, 0, uintptr(sys.Pgid), 0)
378 pgrp = int32(sys.Pgid)
380 pid, _ = rawSyscallNoError(SYS_GETPID, 0, 0, 0)
385 // Place process group in foreground.
386 _, _, err1 = RawSyscall(SYS_IOCTL, uintptr(sys.Ctty), uintptr(TIOCSPGRP), uintptr(unsafe.Pointer(&pgrp)))
392 // Restore the signal mask. We do this after TIOCSPGRP to avoid
393 // having the kernel send a SIGTTOU signal to the process group.
394 runtime_AfterForkInChild()
397 if sys.Unshareflags != 0 {
398 _, _, err1 = RawSyscall(SYS_UNSHARE, sys.Unshareflags, 0, 0)
403 if sys.Unshareflags&CLONE_NEWUSER != 0 && sys.GidMappings != nil {
404 dirfd = int(_AT_FDCWD)
405 if fd1, _, err1 = RawSyscall6(SYS_OPENAT, uintptr(dirfd), uintptr(unsafe.Pointer(&psetgroups[0])), uintptr(O_WRONLY), 0, 0, 0); err1 != 0 {
408 pid, _, err1 = RawSyscall(SYS_WRITE, uintptr(fd1), uintptr(unsafe.Pointer(&setgroups[0])), uintptr(len(setgroups)))
412 if _, _, err1 = RawSyscall(SYS_CLOSE, uintptr(fd1), 0, 0); err1 != 0 {
416 if fd1, _, err1 = RawSyscall6(SYS_OPENAT, uintptr(dirfd), uintptr(unsafe.Pointer(&pgid[0])), uintptr(O_WRONLY), 0, 0, 0); err1 != 0 {
419 pid, _, err1 = RawSyscall(SYS_WRITE, uintptr(fd1), uintptr(unsafe.Pointer(&gidmap[0])), uintptr(len(gidmap)))
423 if _, _, err1 = RawSyscall(SYS_CLOSE, uintptr(fd1), 0, 0); err1 != 0 {
428 if sys.Unshareflags&CLONE_NEWUSER != 0 && sys.UidMappings != nil {
429 dirfd = int(_AT_FDCWD)
430 if fd1, _, err1 = RawSyscall6(SYS_OPENAT, uintptr(dirfd), uintptr(unsafe.Pointer(&puid[0])), uintptr(O_WRONLY), 0, 0, 0); err1 != 0 {
433 pid, _, err1 = RawSyscall(SYS_WRITE, uintptr(fd1), uintptr(unsafe.Pointer(&uidmap[0])), uintptr(len(uidmap)))
437 if _, _, err1 = RawSyscall(SYS_CLOSE, uintptr(fd1), 0, 0); err1 != 0 {
442 // The unshare system call in Linux doesn't unshare mount points
443 // mounted with --shared. Systemd mounts / with --shared. For a
444 // long discussion of the pros and cons of this see debian bug 739593.
445 // The Go model of unsharing is more like Plan 9, where you ask
446 // to unshare and the namespaces are unconditionally unshared.
447 // To make this model work we must further mark / as MS_PRIVATE.
448 // This is what the standard unshare command does.
449 if sys.Unshareflags&CLONE_NEWNS == CLONE_NEWNS {
450 _, _, err1 = RawSyscall6(SYS_MOUNT, uintptr(unsafe.Pointer(&none[0])), uintptr(unsafe.Pointer(&slash[0])), 0, MS_REC|MS_PRIVATE, 0, 0)
459 _, _, err1 = RawSyscall(SYS_CHROOT, uintptr(unsafe.Pointer(chroot)), 0, 0)
466 if cred = sys.Credential; cred != nil {
467 ngroups = uintptr(len(cred.Groups))
470 groups = uintptr(unsafe.Pointer(&cred.Groups[0]))
472 if !(sys.GidMappings != nil && !sys.GidMappingsEnableSetgroups && ngroups == 0) && !cred.NoSetGroups {
473 _, _, err1 = RawSyscall(_SYS_setgroups, ngroups, groups, 0)
478 _, _, err1 = RawSyscall(sys_SETGID, uintptr(cred.Gid), 0, 0)
482 _, _, err1 = RawSyscall(sys_SETUID, uintptr(cred.Uid), 0, 0)
488 if len(sys.AmbientCaps) != 0 {
489 // Ambient capabilities were added in the 4.3 kernel,
490 // so it is safe to always use _LINUX_CAPABILITY_VERSION_3.
491 caps.hdr.version = _LINUX_CAPABILITY_VERSION_3
493 if _, _, err1 = RawSyscall(SYS_CAPGET, uintptr(unsafe.Pointer(&caps.hdr)), uintptr(unsafe.Pointer(&caps.data[0])), 0); err1 != 0 {
497 for _, c = range sys.AmbientCaps {
498 // Add the c capability to the permitted and inheritable capability mask,
499 // otherwise we will not be able to add it to the ambient capability mask.
500 caps.data[capToIndex(c)].permitted |= capToMask(c)
501 caps.data[capToIndex(c)].inheritable |= capToMask(c)
504 if _, _, err1 = RawSyscall(SYS_CAPSET, uintptr(unsafe.Pointer(&caps.hdr)), uintptr(unsafe.Pointer(&caps.data[0])), 0); err1 != 0 {
508 for _, c = range sys.AmbientCaps {
509 _, _, err1 = RawSyscall6(SYS_PRCTL, PR_CAP_AMBIENT, uintptr(PR_CAP_AMBIENT_RAISE), c, 0, 0, 0)
518 _, _, err1 = RawSyscall(SYS_CHDIR, uintptr(unsafe.Pointer(dir)), 0, 0)
524 // Parent death signal
525 if sys.Pdeathsig != 0 {
526 _, _, err1 = RawSyscall6(SYS_PRCTL, PR_SET_PDEATHSIG, uintptr(sys.Pdeathsig), 0, 0, 0, 0)
531 // Signal self if parent is already dead. This might cause a
532 // duplicate signal in rare cases, but it won't matter when
534 pid, _ = rawSyscallNoError(SYS_GETPPID, 0, 0, 0)
536 pid, _ = rawSyscallNoError(SYS_GETPID, 0, 0, 0)
537 _, _, err1 = RawSyscall(SYS_KILL, pid, uintptr(sys.Pdeathsig), 0)
544 // Pass 1: look for fd[i] < i and move those up above len(fd)
545 // so that pass 2 won't stomp on an fd it needs later.
547 _, _, err1 = RawSyscall(SYS_DUP3, uintptr(pipe), uintptr(nextfd), O_CLOEXEC)
554 for i = 0; i < len(fd); i++ {
555 if fd[i] >= 0 && fd[i] < i {
556 if nextfd == pipe { // don't stomp on pipe
559 _, _, err1 = RawSyscall(SYS_DUP3, uintptr(fd[i]), uintptr(nextfd), O_CLOEXEC)
568 // Pass 2: dup fd[i] down onto i.
569 for i = 0; i < len(fd); i++ {
571 RawSyscall(SYS_CLOSE, uintptr(i), 0, 0)
575 // dup2(i, i) won't clear close-on-exec flag on Linux,
576 // probably not elsewhere either.
577 _, _, err1 = RawSyscall(fcntl64Syscall, uintptr(fd[i]), F_SETFD, 0)
583 // The new fd is created NOT close-on-exec,
584 // which is exactly what we want.
585 _, _, err1 = RawSyscall(SYS_DUP3, uintptr(fd[i]), uintptr(i), 0)
591 // By convention, we don't close-on-exec the fds we are
592 // started with, so if len(fd) < 3, close 0, 1, 2 as needed.
593 // Programs that know they inherit fds >= 3 will need
594 // to set them close-on-exec.
595 for i = len(fd); i < 3; i++ {
596 RawSyscall(SYS_CLOSE, uintptr(i), 0, 0)
599 // Detach fd 0 from tty
601 _, _, err1 = RawSyscall(SYS_IOCTL, 0, uintptr(TIOCNOTTY), 0)
607 // Set the controlling TTY to Ctty
609 _, _, err1 = RawSyscall(SYS_IOCTL, uintptr(sys.Ctty), uintptr(TIOCSCTTY), 1)
615 // Restore original rlimit.
616 if rlimOK && rlim.Cur != 0 {
617 rawSetrlimit(RLIMIT_NOFILE, &rlim)
620 // Enable tracing if requested.
621 // Do this right before exec so that we don't unnecessarily trace the runtime
622 // setting up after the fork. See issue #21428.
624 _, _, err1 = RawSyscall(SYS_PTRACE, uintptr(PTRACE_TRACEME), 0, 0)
631 _, _, err1 = RawSyscall(SYS_EXECVE,
632 uintptr(unsafe.Pointer(argv0)),
633 uintptr(unsafe.Pointer(&argv[0])),
634 uintptr(unsafe.Pointer(&envv[0])))
637 // send error code on pipe
638 RawSyscall(SYS_WRITE, uintptr(pipe), uintptr(unsafe.Pointer(&err1)), unsafe.Sizeof(err1))
640 RawSyscall(SYS_EXIT, 253, 0, 0)
644 func formatIDMappings(idMap []SysProcIDMap) []byte {
646 for _, im := range idMap {
647 data = append(data, itoa.Itoa(im.ContainerID)+" "+itoa.Itoa(im.HostID)+" "+itoa.Itoa(im.Size)+"\n"...)
652 // writeIDMappings writes the user namespace User ID or Group ID mappings to the specified path.
653 func writeIDMappings(path string, idMap []SysProcIDMap) error {
654 fd, err := Open(path, O_RDWR, 0)
659 if _, err := Write(fd, formatIDMappings(idMap)); err != nil {
664 if err := Close(fd); err != nil {
671 // writeSetgroups writes to /proc/PID/setgroups "deny" if enable is false
672 // and "allow" if enable is true.
673 // This is needed since kernel 3.19, because you can't write gid_map without
674 // disabling setgroups() system call.
675 func writeSetgroups(pid int, enable bool) error {
676 sgf := "/proc/" + itoa.Itoa(pid) + "/setgroups"
677 fd, err := Open(sgf, O_RDWR, 0)
684 data = []byte("allow")
686 data = []byte("deny")
689 if _, err := Write(fd, data); err != nil {
697 // writeUidGidMappings writes User ID and Group ID mappings for user namespaces
698 // for a process and it is called from the parent process.
699 func writeUidGidMappings(pid int, sys *SysProcAttr) error {
700 if sys.UidMappings != nil {
701 uidf := "/proc/" + itoa.Itoa(pid) + "/uid_map"
702 if err := writeIDMappings(uidf, sys.UidMappings); err != nil {
707 if sys.GidMappings != nil {
708 // If the kernel is too old to support /proc/PID/setgroups, writeSetGroups will return ENOENT; this is OK.
709 if err := writeSetgroups(pid, sys.GidMappingsEnableSetgroups); err != nil && err != ENOENT {
712 gidf := "/proc/" + itoa.Itoa(pid) + "/gid_map"
713 if err := writeIDMappings(gidf, sys.GidMappings); err != nil {