Files
visor/runsc/boot/loader.go
T
2026-08-20 19:33:48 -07:00

2470 lines
81 KiB
Go

// Copyright 2018 The gVisor Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Package boot loads the kernel and runs a container.
package boot
import (
"errors"
"fmt"
"os"
"runtime"
"strconv"
"strings"
gtime "time"
"github.com/moby/sys/capability"
specs "github.com/opencontainers/runtime-spec/specs-go"
"golang.org/x/sys/unix"
"gvisor.dev/gvisor/pkg/abi/linux"
"gvisor.dev/gvisor/pkg/cleanup"
"gvisor.dev/gvisor/pkg/context"
"gvisor.dev/gvisor/pkg/coverage"
"gvisor.dev/gvisor/pkg/cpuid"
"gvisor.dev/gvisor/pkg/fd"
"gvisor.dev/gvisor/pkg/gomaxprocs"
"gvisor.dev/gvisor/pkg/log"
"gvisor.dev/gvisor/pkg/memutil"
"gvisor.dev/gvisor/pkg/metric"
"gvisor.dev/gvisor/pkg/rand"
"gvisor.dev/gvisor/pkg/rdma"
"gvisor.dev/gvisor/pkg/refs"
"gvisor.dev/gvisor/pkg/sentry/control"
"gvisor.dev/gvisor/pkg/sentry/devices/nvproxy"
"gvisor.dev/gvisor/pkg/sentry/devices/nvproxy/nvconf"
"gvisor.dev/gvisor/pkg/sentry/devices/rdmaproxy/cxproxy"
"gvisor.dev/gvisor/pkg/sentry/devices/rdmaproxy/genericproxy"
"gvisor.dev/gvisor/pkg/sentry/fdimport"
cgroup2fs "gvisor.dev/gvisor/pkg/sentry/fsimpl/cgroup2fs"
"gvisor.dev/gvisor/pkg/sentry/fsimpl/host"
"gvisor.dev/gvisor/pkg/sentry/fsimpl/tmpfs"
"gvisor.dev/gvisor/pkg/sentry/fsimpl/user"
"gvisor.dev/gvisor/pkg/sentry/inet"
"gvisor.dev/gvisor/pkg/sentry/kernel"
"gvisor.dev/gvisor/pkg/sentry/kernel/auth"
"gvisor.dev/gvisor/pkg/sentry/loader"
"gvisor.dev/gvisor/pkg/sentry/pgalloc"
"gvisor.dev/gvisor/pkg/sentry/platform"
_ "gvisor.dev/gvisor/pkg/sentry/platform/platforms" // register all platforms.
"gvisor.dev/gvisor/pkg/sentry/seccheck"
pb "gvisor.dev/gvisor/pkg/sentry/seccheck/points/points_go_proto"
"gvisor.dev/gvisor/pkg/sentry/socket/netfilter"
"gvisor.dev/gvisor/pkg/sentry/socket/plugin"
"gvisor.dev/gvisor/pkg/sentry/time"
"gvisor.dev/gvisor/pkg/sentry/uniqueid"
"gvisor.dev/gvisor/pkg/sentry/usage"
"gvisor.dev/gvisor/pkg/sentry/vfs"
"gvisor.dev/gvisor/pkg/sentry/watchdog"
"gvisor.dev/gvisor/pkg/sighandling"
"gvisor.dev/gvisor/pkg/sync"
"gvisor.dev/gvisor/pkg/tcpip"
"gvisor.dev/gvisor/pkg/tcpip/link/ethernet"
"gvisor.dev/gvisor/pkg/tcpip/link/loopback"
"gvisor.dev/gvisor/pkg/tcpip/link/sniffer"
"gvisor.dev/gvisor/pkg/tcpip/network/arp"
"gvisor.dev/gvisor/pkg/tcpip/network/ipv4"
"gvisor.dev/gvisor/pkg/tcpip/network/ipv6"
"gvisor.dev/gvisor/pkg/tcpip/nftables"
"gvisor.dev/gvisor/pkg/tcpip/stack"
"gvisor.dev/gvisor/pkg/tcpip/transport/icmp"
"gvisor.dev/gvisor/pkg/tcpip/transport/raw"
"gvisor.dev/gvisor/pkg/tcpip/transport/tcp"
"gvisor.dev/gvisor/pkg/tcpip/transport/udp"
"gvisor.dev/gvisor/pkg/timing"
"gvisor.dev/gvisor/runsc/boot/filter"
pf "gvisor.dev/gvisor/runsc/boot/portforward"
"gvisor.dev/gvisor/runsc/boot/pprof"
"gvisor.dev/gvisor/runsc/config"
"gvisor.dev/gvisor/runsc/profile"
"gvisor.dev/gvisor/runsc/specutils"
// Top-level inet providers.
"gvisor.dev/gvisor/pkg/sentry/socket/hostinet"
"gvisor.dev/gvisor/pkg/sentry/socket/netstack"
// Include other supported socket providers.
_ "gvisor.dev/gvisor/pkg/sentry/socket/netlink"
_ "gvisor.dev/gvisor/pkg/sentry/socket/netlink/netfilter"
rdmanetlink "gvisor.dev/gvisor/pkg/sentry/socket/netlink/rdma"
_ "gvisor.dev/gvisor/pkg/sentry/socket/netlink/route"
_ "gvisor.dev/gvisor/pkg/sentry/socket/netlink/uevent"
_ "gvisor.dev/gvisor/pkg/sentry/socket/unix"
)
// ContainerRuntimeState is the runtime state of a container.
type ContainerRuntimeState int
const (
// RuntimeStateInvalid used just in case of error.
RuntimeStateInvalid ContainerRuntimeState = iota
// RuntimeStateCreating indicates that the container is being
// created, but has not started running yet.
RuntimeStateCreating
// RuntimeStateRunning indicates that the container is running.
RuntimeStateRunning
// RuntimeStateStopped indicates that the container has stopped.
RuntimeStateStopped
)
type containerInfo struct {
cid string
containerName string
conf *config.Config
// spec is the base configuration for the root container.
spec *specs.Spec
// procArgs refers to the container's init task.
procArgs kernel.CreateProcessArgs
// stdioFDs contains stdin, stdout, and stderr.
stdioFDs []*fd.FD
// passFDs are mappings of user-supplied host to guest file descriptors.
passFDs []fdMapping
// execFD is the host file descriptor used for program execution.
execFD *fd.FD
// goferFDs are the FDs that attach the sandbox to the gofers.
goferFDs []*fd.FD
// devGoferFD is the FD to attach the sandbox to the dev gofer.
devGoferFD *fd.FD
// goferFilestoreFDs are FDs to the regular files that will back the tmpfs or
// overlayfs mount for certain gofer mounts.
goferFilestoreFDs []*fd.FD
// goferMountConfs contains information about how the gofer mounts have been
// configured. The first entry is for rootfs and the following entries are
// for bind mounts in Spec.Mounts (in the same order).
goferMountConfs []specutils.GoferMountConf
// nvidiaHostSettings holds information on the Nvidia GPU driver.
nvidiaHostSettings *nvconf.HostSettings
// nvproxyDevInfo holds information on nvproxy devices.
nvproxyDevInfo *nvproxy.DeviceInfo
// applicationCores is the number of CPU cores gVisor reports to user
// applications.
applicationCores int
// rootfsUpperTarFD is the file descriptor to the tar file containing the rootfs
// upper layer changes.
rootfsUpperTarFD *fd.FD
// useCPUNums indicates whether to use platform assigned CPU numbers as CPU numbers in the sentry.
useCPUNums bool
}
type loaderState int
const (
// created indicates that the Loader has been created, but not started yet.
created loaderState = iota
// started indicates that the Loader has been started. This means that the
// root container is running. Subsequent containers may still be unstarted.
started
// restoringUnstarted indicates that the Loader has been created and is
// restoring containers, but not started yet.
restoringUnstarted
// restoringStarted indicates that the Loader has been created and started
// along with all containers, while restore continues in the background.
restoringStarted
// restoreFailed indicates that the Loader has failed to restore.
restoreFailed
// restored indicates that the Loader has been fully restored.
restored
)
// String returns a string representation of the loader state.
func (s loaderState) String() string {
switch s {
case created:
return "created"
case started:
return "started"
case restoringUnstarted:
return "restoringUnstarted"
case restoringStarted:
return "restoringStarted"
case restoreFailed:
return "restoreFailed"
case restored:
return "restored"
default:
return fmt.Sprintf("unknown(%d)", s)
}
}
// Loader keeps state needed to start the kernel and run the container.
type Loader struct {
// k is the kernel.
k *kernel.Kernel
// ctrl is the control server.
ctrl *controller
// root contains information about the root container in the sandbox.
root containerInfo
watchdog *watchdog.Watchdog
// stopSignalForwarding disables forwarding of signals to the sandboxed
// container. It should be called when a sandbox is destroyed.
stopSignalForwarding func()
// stopProfiling stops profiling started at container creation. It
// should be called when a sandbox is destroyed.
stopProfiling func()
// startupTimertracks overall sandbox startup.
// It is *not* owned by the Loader. See `Args.StartupTimer`.
startupTimer *timing.Timer
// PreSeccompCallback is called right before installing seccomp filters.
PreSeccompCallback func()
// restoreDone is used to wait for restore to complete. Note that this may be
// much after the sandbox has started because under some configurations, the
// restore is allowed to proceed in the background while the sandbox runs.
restoreDone *sync.Cond
// sandboxID is the ID for the whole sandbox.
sandboxID string
// mountHints provides extra information about mounts for containers that
// apply to the entire pod.
mountHints *PodMountHints
// productName is the value to show in
// /sys/devices/virtual/dmi/id/product_name.
productName string
// rdmaSysfs is the host sysfs snapshot for RDMA device topology, or
// nil when disabled.
rdmaSysfs *rdma.Snapshot
// cpuQuota and cpuPeriod are the raw host CFS settings that should be
// exposed through sandbox cgroupfs.
cpuQuota int64
cpuPeriod int64
hostTHP HostTHP
// mu guards the fields below.
mu sync.Mutex
// +checklocks:mu
state loaderState
// sharedMounts holds VFS mounts that may be shared between containers within
// the same pod. It is mapped by mount source.
//
// +checklocks:mu
sharedMounts map[string]*vfs.Mount
// cgroup2Mount is an internal mount of the cgroup2fs singleton used to
// manage per-container cgroups. It is only set when MountCgroupV2 is
// enabled.
//
// +checklocks:mu
cgroup2Mount *vfs.Mount
// processes maps containers init process and invocation of exec. Root
// processes are keyed with container ID and pid=0, while exec invocations
// have the corresponding pid set.
//
// +checklocks:mu
processes map[execID]*execProcess
// containerIDs store container names and IDs to assist with restore and container
// naming when user didn't provide one.
//
// Mapping: name -> cid.
// +checklocks:mu
containerIDs map[string]string
// containerSpecs stores container specs for each container in sandbox.
//
// Mapping: name -> spec.
// +checklocks:mu
containerSpecs map[string]*specs.Spec
// failedToStart is a set of container IDs that failed to start.
//
// +checklocks:mu
failedToStart map[string]struct{}
// portForwardProxies is a list of active port forwarding connections.
//
// +checklocks:mu
portForwardProxies []*pf.Proxy
// +checklocks:mu
saveFDs []*fd.FD
// saveCheckpointGofer is true if saveFDs contains only one FD, which
// is a socket connected to a checkpoint gofer.
saveCheckpointGofer bool
// restoreErr is the error that occurred during restore.
//
// +checklocks:mu
restoreErr error
// savings contains the restore savings (eg CPU and wall time saved).
//
// +checklocks:mu
savings Savings
fsRestore *fsRestore
// networkArgs contains the routes and links which were scraped from the
// host network namespace during sandbox creation.
networkArgs *CreateLinksAndRoutesArgs
// fsSaveFDs are FDs used for user-triggered filesystem checkpoint saving.
fsSaveFDs []*fd.FD
// fsSaveCheckpointGofer is true if fsSaveFDs contains only one FD, which
// is a socket connected to a checkpoint gofer.
fsSaveCheckpointGofer bool
// hostinetNetDevFile is the pre-opened /proc/net/dev file for hostinet restore.
hostinetNetDevFile *os.File
// hostinetNetSNMPFile is the pre-opened /proc/net/snmp file for hostinet restore.
hostinetNetSNMPFile *os.File
}
// execID uniquely identifies a sentry process that is executed in a container.
type execID struct {
cid string
pid kernel.ThreadID
}
// execProcess contains the thread group and host TTY of a sentry process.
type execProcess struct {
// tg will be nil for containers that haven't started yet.
tg *kernel.ThreadGroup
// tty will be nil if the process is not attached to a terminal.
tty *host.TTYFileDescription
// pidnsPath is the pid namespace path in spec
pidnsPath string
// cgroupnsPath is the cgroup namespace path in spec
cgroupnsPath string
// hostTTY is present when creating a sub-container with terminal enabled.
// TTY file is passed during container create and must be saved until
// container start.
hostTTY *fd.FD
}
// fdMapping maps guest to host file descriptors. Guest file descriptors are
// exposed to the application inside the sandbox through the FD table.
type fdMapping struct {
guest int
host *fd.FD
}
// FDMapping is a helper type to represent a mapping from guest to host file
// descriptors. In contrast to the unexported fdMapping type, it does not imply
// file ownership.
type FDMapping struct {
Guest int
Host int
}
// Args are the arguments for New().
type Args struct {
// Id is the sandbox ID.
ID string
// Spec is the sandbox specification.
Spec *specs.Spec
// Conf is the system configuration.
Conf *config.Config
// ControllerFD is the FD to the URPC controller. The Loader takes ownership
// of this FD and may close it at any time.
ControllerFD int
// Device is an optional argument that is passed to the platform. The Loader
// takes ownership of this file and may close it at any time.
Device *fd.FD
// GoferFDs is an array of FDs used to connect with the Gofer. The Loader
// takes ownership of these FDs and may close them at any time.
GoferFDs []int
// DevGoferFD is the FD for the dev gofer connection. The Loader takes
// ownership of this FD and may close it at any time.
DevGoferFD int
// StdioFDs is the stdio for the application. The Loader takes ownership of
// these FDs and may close them at any time.
StdioFDs []int
// PassFDs are user-supplied FD mappings from host to guest descriptors.
// The Loader takes ownership of these FDs and may close them at any time.
PassFDs []FDMapping
// ExecFD is the host file descriptor used for program execution.
ExecFD int
// GoferFilestoreFDs are FDs to the regular files that will back the tmpfs or
// overlayfs mount for certain gofer mounts.
GoferFilestoreFDs []int
// GoferMountConfs contains information about how the gofer mounts have been
// configured. The first entry is for rootfs and the following entries are
// for bind mounts in Spec.Mounts (in the same order).
GoferMountConfs []specutils.GoferMountConf
// NumCPU is the number of CPUs to create inside the sandbox.
NumCPU int
// CPUQuota and CPUPeriod are the raw host CFS settings that should be
// reflected by sandbox cgroupfs.
CPUQuota int64
CPUPeriod int64
// TotalMem is the initial amount of total memory to report back to the
// container.
TotalMem uint64
// TotalHostMem is the total memory reported by host /proc/meminfo.
TotalHostMem uint64
// UserLogFD is the file descriptor to write user logs to.
UserLogFD int
// ProductName is the value to show in
// /sys/devices/virtual/dmi/id/product_name.
ProductName string
// RDMASysfs is the host sysfs snapshot for RDMA device topology, or
// nil when disabled.
RDMASysfs *rdma.Snapshot
// PodInitConfigFD is the file descriptor to a file passed in the
// --pod-init-config flag
PodInitConfigFD int
// SinkFDs is an ordered array of file descriptors to be used by seccheck
// sinks configured from the --pod-init-config file.
SinkFDs []int
// ProfileOpts contains the set of profiles to enable and the
// corresponding FDs where profile data will be written.
ProfileOpts profile.Opts
// NvidiaDriverVersion is the NVIDIA driver ABI version to use for
// communicating with NVIDIA devices on the host.
NvidiaDriverVersion nvconf.DriverVersion
NvidiaHostSettings *nvconf.HostSettings
// HostTHP contains host transparent hugepage settings.
HostTHP HostTHP
// SaveFDs are FDs used for user-triggered checkpoint saving.
SaveFDs []*fd.FD
// If SaveCheckpointGofer is true, Args.SaveFDs contains only one FD, which
// is a socket connected to a checkpoint gofer.
SaveCheckpointGofer bool
// FSRestoreFDs are FDs used for filesystem checkpoint restore.
FSRestoreFDs []*fd.FD
// If FSRestoreCheckpointGofer is true, Args.FSRestoreFDs contains only one
// FD, which is a socket connected to a checkpoint gofer.
FSRestoreCheckpointGofer bool
// FSSaveFDs are FDs used for user-triggered filesystem checkpoint saving.
FSSaveFDs []*fd.FD
// If FSSaveCheckpointGofer is true, Args.FSSaveFDs contains only one FD,
// which is a socket connected to a checkpoint gofer.
FSSaveCheckpointGofer bool
// RootfsUpperTarFD is the file descriptor to the tar file containing the rootfs
// upper layer changes.
RootfsUpperTarFD int
// StartupTimer tracks overall sandbox startup.
// The `Loader` records midpoints on it as it goes through loader creation
// and sandbox startup. The `Loader` does not take ownership of it.
StartupTimer *timing.Timer
}
// HostTHP holds host transparent hugepage settings.
type HostTHP struct {
// ShmemEnabled is the selected option in
// /sys/kernel/mm/transparent_hugepage/shmem_enabled.
ShmemEnabled string
// Defrag is the selected option in
// /sys/kernel/mm/transparent_hugepage/defrag.
Defrag string
}
const (
// startingStdioFD is the starting stdioFD number used during sandbox
// start and restore. This makes sure the stdioFDs are always the same
// on initial start and on restore.
// It must be above the highest FD number that donation can assign at boot
// (donated FDs are numbered densely from 3, and should ideally be such
// that adding 2 to it (i.e. index stderr gets) does *not* cross a
// power of 2. See `//runsc/prewarmer/prewarmer.c` for some fun Linux
// kernel lore that explains why.
// LINT.IfChange
startingStdioFD = 253
// LINT.ThenChange(../prewarmer/prewarmer.c)
// containerSpecsKey is the key used to add and pop the container specs to the
// kernel during save/restore.
containerSpecsKey = "container_specs"
)
func getRootCredentials(spec *specs.Spec, conf *config.Config, userNs *auth.UserNamespace) *auth.Credentials {
// Create capabilities.
caps, err := specutils.Capabilities(conf.EnableRaw, spec.Process.Capabilities)
if err != nil {
return nil
}
// Convert the spec's additional GIDs to KGIDs.
extraKGIDs := make([]auth.KGID, 0, len(spec.Process.User.AdditionalGids))
for _, GID := range spec.Process.User.AdditionalGids {
extraKGIDs = append(extraKGIDs, auth.KGID(GID))
}
if userNs == nil {
userNs = auth.NewRootUserNamespace()
}
// Create credentials.
creds := auth.NewUserCredentials(
auth.KUID(spec.Process.User.UID),
auth.KGID(spec.Process.User.GID),
extraKGIDs,
caps,
userNs)
return creds
}
// shouldEnableClockMonotonicRaw reports whether CLOCK_MONOTONIC_RAW should be
// exposed as a distinct clock tracking the host's CLOCK_MONOTONIC_RAW, rather
// than aliasing CLOCK_MONOTONIC as it does by default.
//
// This exists for GPU profiling: profilers such as Nsight Systems/CUPTI anchor
// the GPU timeline in the host's CLOCK_MONOTONIC_RAW domain, which drifts from
// CLOCK_MONOTONIC by NTP frequency adjustment. When nvproxy grants
// CapProfiling, the sandbox must therefore serve a CLOCK_MONOTONIC_RAW in that
// same (absolute, unadjusted) domain. It is enabled only in that case.
func shouldEnableClockMonotonicRaw(spec *specs.Spec, conf *config.Config) bool {
if !specutils.NVProxyEnabled(spec, conf) {
return false
}
caps, err := specutils.NVProxyDriverCapsAllowed(conf)
return err == nil && caps&nvconf.CapProfiling != 0
}
// New initializes a new kernel loader configured by spec.
// New also handles setting up a kernel for restoring a container.
func New(args Args) (*Loader, error) {
stopProfilingRuntime := profile.Start(args.ProfileOpts)
stopProfiling := func() {
stopProfilingRuntime()
metric.StopProfilingMetrics()
}
// Initialize seccheck points.
seccheck.Initialize()
args.StartupTimer.Reached("seccheck initialized")
// We initialize the rand package now to make sure /dev/urandom is pre-opened
// on kernels that do not support getrandom(2).
if err := rand.Init(); err != nil {
return nil, fmt.Errorf("setting up rand: %w", err)
}
args.StartupTimer.Reached("RNG initialized")
if err := usage.Init(); err != nil {
return nil, fmt.Errorf("setting up memory usage: %w", err)
}
args.StartupTimer.Reached("memory usage initialized")
if specutils.NVProxyEnabled(args.Spec, args.Conf) {
nvproxy.Init()
args.StartupTimer.Reached("nvproxy initialized")
}
if specutils.RDMAEnabled(args.Spec, args.Conf) {
cxproxy.Init()
genericproxy.Init()
args.StartupTimer.Reached("RDMA proxy initialized")
}
// Publish the RDMA sysfs snapshot to the NETLINK_RDMA nldev shim before
// any application socket can exist. rdma-core discovers devices and binds
// userspace providers through nldev (RDMA_NLDEV_ATTR_UVERBS_DRIVER_ID);
// providers without a PCI-ID match table (e.g. libirdma) are unusable
// without it. A nil snapshot leaves the protocol unregistered-equivalent:
// socket(AF_NETLINK, ..., NETLINK_RDMA) fails as on a host without RDMA.
if args.RDMASysfs != nil {
rdmanetlink.Init(args.RDMASysfs)
}
eid := execID{cid: args.ID}
l := &Loader{
sandboxID: args.ID,
processes: map[execID]*execProcess{eid: {}},
sharedMounts: make(map[string]*vfs.Mount),
stopProfiling: stopProfiling,
startupTimer: args.StartupTimer,
productName: args.ProductName,
rdmaSysfs: args.RDMASysfs,
cpuQuota: args.CPUQuota,
cpuPeriod: args.CPUPeriod,
hostTHP: args.HostTHP,
containerIDs: make(map[string]string),
containerSpecs: make(map[string]*specs.Spec),
failedToStart: make(map[string]struct{}),
saveFDs: args.SaveFDs,
saveCheckpointGofer: args.SaveCheckpointGofer,
fsSaveFDs: args.FSSaveFDs,
fsSaveCheckpointGofer: args.FSSaveCheckpointGofer,
}
if args.NumCPU == 0 {
args.NumCPU = runtime.NumCPU()
}
log.Infof("CPUs: %d", args.NumCPU)
gomaxprocs.SetBase(args.NumCPU)
args.StartupTimer.Reached("GOMAXPROCS set")
// Start filesystem checkpoint restore as soon as possible to maximize
// parallel loading.
if len(args.FSRestoreFDs) != 0 {
fsrOpts, err := makeFSRestoreOpts(&args)
if err != nil {
return nil, fmt.Errorf("failed to set up filesystem checkpoint restore: %w", err)
}
fsr, err := startFSRestore(&fsrOpts)
if err != nil {
return nil, fmt.Errorf("failed to start filesystem checkpoint restore: %w", err)
}
l.fsRestore = fsr
}
containerName := l.registerContainer(args.Spec, args.ID)
l.root = containerInfo{
cid: args.ID,
containerName: containerName,
conf: args.Conf,
spec: args.Spec,
goferMountConfs: args.GoferMountConfs,
nvidiaHostSettings: args.NvidiaHostSettings,
applicationCores: args.NumCPU,
}
// Make host FDs stable between invocations. Host FDs must map to the exact
// same number when the sandbox is restored. Otherwise the wrong FD will be
// used.
newfd := startingStdioFD
remapStart := gtime.Now()
for _, stdioFD := range args.StdioFDs {
// Check that newfd is unused to avoid clobbering over it.
if _, err := unix.FcntlInt(uintptr(newfd), unix.F_GETFD, 0); !errors.Is(err, unix.EBADF) {
if err != nil {
return nil, fmt.Errorf("error checking for FD (%d) conflict: %w", newfd, err)
}
return nil, fmt.Errorf("unable to remap stdios, FD %d is already in use", newfd)
}
err := unix.Dup3(stdioFD, newfd, unix.O_CLOEXEC)
if err != nil {
return nil, fmt.Errorf("dup3 of stdios failed: %w", err)
}
l.root.stdioFDs = append(l.root.stdioFDs, fd.New(newfd))
_ = unix.Close(stdioFD)
newfd++
}
log.Infof("Remapped stdio FDs to [%d, %d] in %v", startingStdioFD, newfd-1, gtime.Since(remapStart)) // Load-bearing log message! See `//runsc/prewarmer/prewarmer_speedup_test.go` which parses this log line.
for _, goferFD := range args.GoferFDs {
l.root.goferFDs = append(l.root.goferFDs, fd.New(goferFD))
}
for _, filestoreFD := range args.GoferFilestoreFDs {
l.root.goferFilestoreFDs = append(l.root.goferFilestoreFDs, fd.New(filestoreFD))
}
if args.DevGoferFD >= 0 {
l.root.devGoferFD = fd.New(args.DevGoferFD)
}
if args.ExecFD >= 0 {
l.root.execFD = fd.New(args.ExecFD)
}
for _, customFD := range args.PassFDs {
l.root.passFDs = append(l.root.passFDs, fdMapping{
host: fd.New(customFD.Host),
guest: customFD.Guest,
})
}
args.StartupTimer.Reached("donated FDs ingested")
if args.RootfsUpperTarFD >= 0 {
if l.fsRestore != nil {
return nil, fmt.Errorf("rootfs upper tar file is mutually exclusive with filesystem checkpoint restore")
}
l.root.rootfsUpperTarFD = fd.New(args.RootfsUpperTarFD)
}
// Create kernel and platform.
p, err := createPlatform(args.Conf, args.NumCPU, args.Device, args.ID, args.StartupTimer)
if err != nil {
return nil, fmt.Errorf("creating platform: %w", err)
}
args.StartupTimer.Reached("platform created")
if args.Conf.Platform == "kvm" && specutils.NVProxyEnabled(args.Spec, args.Conf) {
if caps, err := specutils.NVProxyDriverCapsAllowed(args.Conf); err == nil && caps&nvconf.CapCompute != 0 {
log.Warningf("Application cudaMallocManaged() is flaky on -platform=kvm, see gvisor.dev/docs/user_guide/gpu/#platforms")
}
}
l.k = &kernel.Kernel{
Platform: p,
NvidiaDriverVersion: args.NvidiaDriverVersion,
AllowSUID: args.Conf.AllowSUID,
IOUringEnabled: args.Conf.IOUring,
}
// Create memory file.
mf, err := createMemoryFile(args.Conf.AppHugePages, args.HostTHP)
if err != nil {
return nil, fmt.Errorf("creating memory file: %w", err)
}
l.k.SetMemoryFile(mf)
args.StartupTimer.Reached("memory file created")
// Create VDSO.
//
// Pass k as the platform since it is savable, unlike the actual platform.
vdso, err := loader.PrepareVDSO(l.k.MemoryFile())
if err != nil {
return nil, fmt.Errorf("creating vdso: %w", err)
}
args.StartupTimer.Reached("VDSO prepared")
// Create timekeeper.
tk := kernel.NewTimekeeper()
params := kernel.NewVDSOParamPage(l.k.MemoryFile(), vdso.ParamPage.FileRange())
tk.SetClocks(time.NewCalibratedClocks(shouldEnableClockMonotonicRaw(args.Spec, args.Conf)), params)
args.StartupTimer.Reached("timekeeper configured")
if err := enableStrace(args.Conf); err != nil {
return nil, fmt.Errorf("enabling strace: %w", err)
}
creds := getRootCredentials(args.Spec, args.Conf, nil /* UserNamespace */)
if creds == nil {
return nil, fmt.Errorf("getting root credentials")
}
// Create root network namespace/stack.
netns, err := newRootNetworkNamespace(args.Conf, tk, creds.UserNamespace, l.k)
if err != nil {
return nil, fmt.Errorf("creating network: %w", err)
}
args.StartupTimer.Reached("network stack created")
if args.TotalHostMem > 0 {
// tmpfs needs to know the amount of total physical RAM to calculate size limits.
tmpfs.SetTotalHostMem(args.TotalHostMem)
}
if args.TotalMem > 0 {
// Adjust the total memory returned by the Sentry so that applications that
// use /proc/meminfo can make allocations based on this limit.
usage.MinimumTotalMemoryBytes = args.TotalMem
usage.MaximumTotalMemoryBytes = args.TotalMem
log.Infof("Setting total memory to %.2f GB", float64(args.TotalMem)/(1<<30))
}
cpufs := cpuid.HostFeatureSet()
if value, ok := args.Spec.Annotations[specutils.AnnotationCPUFeatures]; ok {
allowedFeatures := make(map[cpuid.Feature]struct{})
for str := range strings.SplitSeq(value, ",") {
if str == "" {
continue // ignore empty feature name rather than return error
}
f, ok := cpuid.FeatureFromString(str)
if !ok {
return nil, fmt.Errorf("annotation %s contains unknown feature %s", specutils.AnnotationCPUFeatures, str)
}
allowedFeatures[f] = struct{}{}
}
afs, err := cpufs.Intersect(allowedFeatures) // err only needed for now because this isn't implemented on ARM64 yet
if err != nil {
return nil, err
}
cpufs = afs
}
maxFDLimit := kernel.MaxFdLimit
if args.Spec.Linux != nil && args.Spec.Linux.Sysctl != nil {
if val, ok := args.Spec.Linux.Sysctl["fs.nr_open"]; ok {
nrOpen, err := strconv.Atoi(val)
if err != nil {
return nil, fmt.Errorf("setting fs.nr_open=%s: %w", val, err)
}
if nrOpen <= 0 || nrOpen > int(kernel.MaxFdLimit) {
return nil, fmt.Errorf("setting fs.nr_open=%s", val)
}
maxFDLimit = int32(nrOpen)
}
}
// Initiate the Kernel object, which is required by the Context passed
// to createVFS in order to mount (among other things) procfs.
if err = l.k.Init(kernel.InitKernelArgs{
FeatureSet: cpufs.Fixed(),
Timekeeper: tk,
RootUserNamespace: creds.UserNamespace,
RootNetworkNamespace: netns,
ApplicationCores: uint(args.NumCPU),
Vdso: vdso,
VdsoParams: params,
RootUTSNamespace: kernel.NewUTSNamespace(args.Spec.Hostname, args.Spec.Domainname, creds.UserNamespace),
RootIPCNamespace: kernel.NewIPCNamespace(creds.UserNamespace),
RootPIDNamespace: kernel.NewRootPIDNamespace(creds.UserNamespace),
MaxFDLimit: maxFDLimit,
Cgroup2FSInit: cgroup2fs.NewFilesystem,
}); err != nil {
return nil, fmt.Errorf("initializing kernel: %w", err)
}
args.StartupTimer.Reached("kernel initialized")
if err := registerFilesystems(l.k, &l.root, l.rdmaSysfs); err != nil {
return nil, fmt.Errorf("registering filesystems: %w", err)
}
args.StartupTimer.Reached("filesystems registered")
// Turn on packet logging if enabled.
if args.Conf.LogPackets {
log.Infof("Packet logging enabled")
sniffer.LogPackets.Store(1)
} else {
log.Infof("Packet logging disabled")
sniffer.LogPackets.Store(0)
}
// Create a watchdog.
dogOpts := watchdog.DefaultOpts
if err := dogOpts.TaskTimeoutAction.Set(args.Conf.WatchdogAction); err != nil {
return nil, fmt.Errorf("setting watchdog action: %w", err)
}
l.watchdog = watchdog.New(l.k, dogOpts)
procArgs, err := createProcessArgs(args.ID, args.Spec, args.Conf, creds, l.k, l.k.RootPIDNamespace())
if err != nil {
return nil, fmt.Errorf("creating init process for root container: %w", err)
}
l.root.procArgs = procArgs
args.StartupTimer.Reached("process args created")
if err := initCompatLogs(args.UserLogFD); err != nil {
return nil, fmt.Errorf("initializing compat logs: %w", err)
}
args.StartupTimer.Reached("compat logs initialized")
l.mountHints, err = NewPodMountHints(args.Spec)
if err != nil {
return nil, fmt.Errorf("creating pod mount hints: %w", err)
}
args.StartupTimer.Reached("mount hints parsed")
// Set up host mount that will be used for imported fds.
hostFilesystem, err := host.NewFilesystem(l.k.VFS())
if err != nil {
return nil, fmt.Errorf("failed to create hostfs filesystem: %w", err)
}
defer hostFilesystem.DecRef(l.k.SupervisorContext())
l.k.SetHostMount(l.k.VFS().NewDisconnectedMount(hostFilesystem, nil, &vfs.MountOptions{}))
args.StartupTimer.Reached("host FS mount created")
if args.PodInitConfigFD >= 0 {
if err := setupSeccheck(args.PodInitConfigFD, args.SinkFDs); err != nil {
log.Warningf("unable to configure event session: %v", err)
}
}
l.k.RegisterContainerName(args.ID, l.root.containerName)
l.k.SetSaver(l)
// We don't care about child signals; some platforms can generate a
// tremendous number of useless ones (I'm looking at you, ptrace).
if err := sighandling.IgnoreChildStop(); err != nil {
return nil, fmt.Errorf("ignore child stop signals failed: %w", err)
}
if len(args.Conf.TestOnlyAutosaveImagePath) != 0 {
enableAutosave(l, args.Conf.TestOnlyAutosaveResume, l.saveFDs)
}
metric.SentryEntryPointMetric.Increment(&metric.EntryPointTypeRunsc)
// Create the control server using the provided FD.
//
// This must be done *after* we have initialized the kernel since the
// controller is used to configure the kernel's network stack.
ctrl, err := newController(args.ControllerFD, l)
if err != nil {
return nil, fmt.Errorf("creating control server: %w", err)
}
l.ctrl = ctrl
// Only start serving after Loader is set to controller and controller is set
// to Loader, because they are both used in the urpc methods.
if err := ctrl.srv.StartServing(); err != nil {
return nil, fmt.Errorf("starting control server: %w", err)
}
args.StartupTimer.Reached("control server started")
return l, nil
}
// ConfigureNetwork implements inet.NetworkArgs.ConfigureNetwork.
func (l *Loader) ConfigureNetwork(s inet.Stack) error {
if h, ok := s.(*hostinet.Stack); ok {
h.SetFiles(l.hostinetNetDevFile, l.hostinetNetSNMPFile)
l.hostinetNetDevFile = nil
l.hostinetNetSNMPFile = nil
return nil
}
if l.networkArgs == nil {
return nil
}
networkArgs := l.networkArgs
// Close the FDs after they are used to configure the stack.
defer func() {
for _, f := range networkArgs.FilePayload.Files {
f.Close()
}
networkArgs.FilePayload.Files = nil
}()
eps, ok := s.(*netstack.Stack)
if !ok {
return nil
}
if eps.Stack.IPTables() == nil {
eps.Stack.SetIPTables(netfilter.DefaultLinuxTables(eps.Stack.Clock(), eps.Stack.InsecureRNG()))
}
if nftables.IsNFTablesEnabled() && eps.Stack.NFTables() == nil {
eps.Stack.SetNFTables(nftables.NewNFTables(eps.Stack, eps.Stack.Clock(), eps.Stack.SecureRNG()))
}
n := &Network{
Stack: eps.Stack,
Kernel: l.k,
}
if err := n.CreateLinksAndRoutes(networkArgs, nil); err != nil {
return err
}
return nil
}
// createProcessArgs creates args that can be used with kernel.CreateProcess.
func createProcessArgs(id string, spec *specs.Spec, conf *config.Config, creds *auth.Credentials, k *kernel.Kernel, pidns *kernel.PIDNamespace) (kernel.CreateProcessArgs, error) {
// Create initial limits.
ls, err := createLimitSet(spec, specutils.TPUProxyEnabled(spec, conf))
if err != nil {
return kernel.CreateProcessArgs{}, fmt.Errorf("creating limits: %w", err)
}
env, err := specutils.ResolveEnvs(spec.Process.Env)
if err != nil {
return kernel.CreateProcessArgs{}, fmt.Errorf("resolving env: %w", err)
}
wd := spec.Process.Cwd
if wd == "" {
wd = "/"
}
umask := uint(0022)
if spec.Process.User.Umask != nil {
umask = uint(*spec.Process.User.Umask) & 0777
}
// Create the process arguments.
procArgs := kernel.CreateProcessArgs{
Argv: spec.Process.Args,
Envv: env,
WorkingDirectory: wd,
Credentials: creds,
NoNewPrivs: spec.Process.NoNewPrivileges,
Umask: umask,
Limits: ls,
MaxSymlinkTraversals: linux.MaxSymlinkTraversals,
UTSNamespace: k.RootUTSNamespace(),
IPCNamespace: k.RootIPCNamespace(),
ContainerID: id,
PIDNamespace: pidns,
}
return procArgs, nil
}
// Destroy cleans up all resources used by the loader.
//
// Note that this will block until all open control server connections have
// been closed. For that reason, this should NOT be called in a defer, because
// a panic in a control server rpc would then hang forever.
func (l *Loader) Destroy() {
if l.stopSignalForwarding != nil {
l.stopSignalForwarding()
}
l.watchdog.Stop()
ctx := l.k.SupervisorContext()
l.mu.Lock()
for _, m := range l.sharedMounts {
m.DecRef(ctx)
}
if l.cgroup2Mount != nil {
l.cgroup2Mount.DecRef(ctx)
l.cgroup2Mount = nil
}
l.mu.Unlock()
// Wake up all checkpoint waiters. This must be done before the controller
// is stopped, since its stop sequence requires all pending RPCs to complete.
l.k.SignalAllCheckpointWaiters(fmt.Errorf("Loader destroyed"))
l.k.SignalAllFSSaveWaiters(fmt.Errorf("Loader destroyed"))
// Stop the control server. This will indirectly stop any
// long-running control operations that are in flight, e.g.
// profiling operations.
l.ctrl.stop()
// Release all kernel resources. This is only safe after we can no longer
// save/restore.
l.k.Release()
// Release any dangling tcp connections.
tcpip.ReleaseDanglingEndpoints()
// In the success case, all FDs in l.root will only contain released/closed
// FDs whose ownership has been passed over to host FDs and gofer sessions.
// Close them here in case of failure.
for _, f := range l.root.stdioFDs {
_ = f.Close()
}
for _, f := range l.root.passFDs {
_ = f.host.Close()
}
for _, f := range l.root.goferFDs {
_ = f.Close()
}
for _, f := range l.root.goferFilestoreFDs {
_ = f.Close()
}
if l.root.devGoferFD != nil {
_ = l.root.devGoferFD.Close()
}
l.stopProfiling()
// Check all references.
refs.OnExit()
}
func createPlatform(conf *config.Config, numCPU int, deviceFile *fd.FD, sandboxID string, startupTimer *timing.Timer) (platform.Platform, error) {
platformName := conf.Platform
p, err := platform.Lookup(conf.Platform)
if err != nil {
panic(fmt.Sprintf("invalid platform %s: %s", conf.Platform, err))
}
log.Infof("Platform: %s", platformName)
return p.New(platform.Options{
DeviceFile: deviceFile,
DisableSyscallPatching: platformName == "systrap" && conf.SystrapDisableSyscallPatching,
DisableFastPath: platformName == "systrap" && conf.SystrapDisableFastPath,
ApplicationCores: numCPU,
UseCPUNums: platformName == "kvm" && conf.UseCPUNums,
SandboxID: sandboxID,
StartupTimer: startupTimer,
})
}
func createMemoryFile(appHugePages bool, hostTHP HostTHP) (*pgalloc.MemoryFile, error) {
const memfileName = "runsc-memory"
memfd, err := memutil.CreateMemFD(memfileName, 0)
if err != nil {
return nil, fmt.Errorf("error creating memfd: %w", err)
}
memfile := os.NewFile(uintptr(memfd), memfileName)
mfopts := pgalloc.MemoryFileOpts{
// We can't enable pgalloc.MemoryFileOpts.UseHostMemcgPressure even if
// there are memory cgroups specified, because at this point we're already
// in a mount namespace in which the relevant cgroupfs is not visible.
}
if appHugePages {
switch hostTHP.ShmemEnabled {
case "":
log.Infof("Disabling application huge pages: host shmem_enabled is unknown")
case "never", "deny":
log.Infof("Disabling application huge pages: host shmem_enabled is %q", hostTHP.ShmemEnabled)
case "advise":
switch hostTHP.Defrag {
case "":
log.Infof("Disabling application huge pages: host shmem_enabled is %q, host defrag is unknown", hostTHP.ShmemEnabled)
case "always", "defer", "never":
// Allocations on MADV_HUGEPAGE pages will invoke direct
// compaction ("always"), wake kcompactd ("defer"), or do
// neither ("never"), consistent with host private anonymous
// memory mappings, so using MADV_HUGEPAGE shouldn't cause a
// regression vs. running natively.
log.Infof("Enabling application huge pages: host shmem_enabled is %q, host defrag is %q", hostTHP.ShmemEnabled, hostTHP.Defrag)
mfopts.ExpectHugepages = true
mfopts.AdviseHugepage = true
case "defer+madvise", "madvise":
// Allocations on MADV_HUGEPAGE pages may invoke direct
// compaction whereas allocations on host private anonymous
// memory mappings will not, so using MADV_HUGEPAGE may degrade
// performance.
log.Infof("Disabling application huge pages: host shmem_enabled is %q, host defrag is %q", hostTHP.ShmemEnabled, hostTHP.Defrag)
default:
log.Warningf("Disabling application huge pages: host shmem_enabled is %q, host defrag is unknown value %q", hostTHP.ShmemEnabled, hostTHP.Defrag)
}
case "always", "within_size":
log.Infof("Enabling application huge pages: host shmem_enabled is %q", hostTHP.ShmemEnabled)
// In these cases, memfds will default to using huge pages, and we have to
// explicitly ask for small pages.
mfopts.ExpectHugepages = true
mfopts.AdviseNoHugepage = true
case "force":
log.Infof("Enabling application huge pages: host shmem_enabled is %q", hostTHP.ShmemEnabled)
// The kernel will ignore MADV_NOHUGEPAGE, so don't bother.
mfopts.ExpectHugepages = true
default:
log.Warningf("Disabling application huge pages: host shmem_enabled is unknown value %q", hostTHP.ShmemEnabled)
}
}
mf, err := pgalloc.NewMemoryFile(memfile, mfopts)
if err != nil {
_ = memfile.Close()
return nil, fmt.Errorf("error creating pgalloc.MemoryFile: %w", err)
}
return mf, nil
}
// installSeccompFilters installs sandbox seccomp filters with the host.
func (l *Loader) installSeccompFilters() error {
if l.PreSeccompCallback != nil {
l.PreSeccompCallback()
l.startupTimer.Reached("pre-seccomp callback done")
}
if l.root.conf.DisableSeccomp {
log.Warningf("*** SECCOMP WARNING: syscall filter is DISABLED. Running in less secure mode.")
} else {
hostnet := l.root.conf.Network == config.NetworkHost
var nvproxyCaps nvconf.DriverCaps
nvproxyEnabled := specutils.NVProxyEnabled(l.root.spec, l.root.conf)
if nvproxyEnabled {
var err error
// We use the set of allowed capabilities here, not the subset of them
// that the root container requests. This is because we need to support
// subsequent containers being able to execute with a wider set than the
// set that the root container requests. Seccomp filters are only
// applied once at sandbox startup, so they need to be as wide as the
// set of capabilities that may ever be requested.
if nvproxyCaps, err = specutils.NVProxyDriverCapsAllowed(l.root.conf); err != nil {
return fmt.Errorf("NVIDIA capabilities: %w", err)
}
}
opts := filter.Options{
Platform: l.k.Platform.SeccompInfo(),
HostNetwork: hostnet,
HostNetworkRawSockets: hostnet && l.root.conf.EnableRaw,
HostFilesystem: l.root.conf.DirectFS,
ProfileEnable: l.root.conf.ProfileEnable,
NVProxy: nvproxyEnabled,
NVProxyCaps: nvproxyCaps,
TPUProxy: specutils.TPUProxyEnabled(l.root.spec, l.root.conf),
RDMAProxy: specutils.RDMAEnabled(l.root.spec, l.root.conf),
ControllerFD: uint32(l.ctrl.srv.FD()),
CgoEnabled: config.CgoEnabled,
PluginNetwork: l.root.conf.Network == config.NetworkPlugin,
}
if err := filter.Install(opts, l.startupTimer); err != nil {
return fmt.Errorf("installing seccomp filters: %w", err)
}
}
return nil
}
// Run runs the root container.
func (l *Loader) Run() error {
err := l.run()
l.ctrl.manager.startResultChan <- err
if err != nil {
// Give the controller some time to send the error to the
// runtime. If we return too quickly here the process will exit
// and the control connection will be closed before the error
// is returned.
gtime.Sleep(2 * gtime.Second)
return err
}
return nil
}
func (l *Loader) run() error {
if l.root.conf.Network == config.NetworkHost {
// Delay host network configuration to this point because network namespace
// is configured after the loader is created and before Run() is called.
log.Debugf("Configuring host network")
s := l.k.RootNetworkNamespace().Stack().(*hostinet.Stack)
if err := s.Configure(l.root.conf.EnableRaw); err != nil {
return err
}
l.startupTimer.Reached("host network configured")
}
l.mu.Lock()
defer l.mu.Unlock()
eid := execID{cid: l.sandboxID}
ep, ok := l.processes[eid]
if !ok {
return fmt.Errorf("trying to start deleted container %q", l.sandboxID)
}
switch l.state {
case created:
if l.root.conf.ProfileEnable {
pprof.Initialize()
}
if l.networkArgs != nil {
if err := l.ConfigureNetwork(l.k.RootNetworkNamespace().Stack()); err != nil {
return err
}
l.startupTimer.Reached("network configured")
}
// Finally done with all configuration. Setup filters before user code
// is loaded.
if err := l.installSeccompFilters(); err != nil {
return err
}
l.startupTimer.Reached("seccomp filters installed")
// Create the root container init task. It will begin running
// when the kernel is started.
l.root.procArgs.StartupTimeline = l.startupTimer.Fork("root container")
var (
tg *kernel.ThreadGroup
err error
)
tg, ep.tty, err = l.createContainerProcess(&l.root)
if err != nil {
return err
}
l.startupTimer.Reached("root container created")
if seccheck.Global.Enabled(seccheck.PointContainerStart) {
evt := pb.Start{
Id: l.sandboxID,
Cwd: l.root.spec.Process.Cwd,
Args: l.root.spec.Process.Args,
Terminal: l.root.spec.Process.Terminal,
}
fields := seccheck.Global.GetFieldSet(seccheck.PointContainerStart)
if fields.Local.Contains(seccheck.FieldContainerStartEnv) {
evt.Env = l.root.spec.Process.Env
}
if !fields.Context.Empty() {
evt.ContextData = &pb.ContextData{}
kernel.LoadSeccheckData(tg.Leader(), fields.Context, evt.ContextData)
}
_ = seccheck.Global.SentToSinks(func(c seccheck.Sink) error {
return c.ContainerStart(context.Background(), fields, &evt)
})
}
case restoringUnstarted:
// If we are restoring, we do not want to create a process.
default:
return fmt.Errorf("Loader.Run() called in unexpected state=%s", l.state)
}
ep.tg = l.k.GlobalInit()
if ns, ok := specutils.GetNS(specs.PIDNamespace, l.root.spec); ok {
ep.pidnsPath = ns.Path
}
// Handle signals by forwarding them to the root container process
// (except for panic signal, which should cause a panic).
l.stopSignalForwarding = sighandling.StartSignalForwarding(func(sig linux.Signal) {
// Panic signal should cause a panic.
if l.root.conf.PanicSignal != -1 && sig == linux.Signal(l.root.conf.PanicSignal) {
panic("Signal-induced panic")
}
// Otherwise forward to root container.
deliveryMode := DeliverToProcess
if l.root.spec.Process.Terminal {
// Since we are running with a console, we should forward the signal to
// the foreground process group so that job control signals like ^C can
// be handled properly.
deliveryMode = DeliverToForegroundProcessGroup
}
log.Infof("Received external signal %d, mode: %s", sig, deliveryMode)
if err := l.signal(l.sandboxID, 0, int32(sig), deliveryMode); err != nil {
log.Warningf("error sending signal %d to container %q: %s", sig, l.sandboxID, err)
}
})
l.startupTimer.Reached("signal forwarding started")
log.Infof("Process should have started...")
l.watchdog.Start()
if err := l.k.Start(); err != nil {
return err
}
l.startupTimer.Reached("kernel started")
l.root.procArgs.StartupTimeline.End()
l.root.procArgs.StartupTimeline = nil
switch l.state {
case created:
l.state = started
case restoringUnstarted:
l.state = restoringStarted
default:
panic(fmt.Sprintf("state=%s in Loader.run() should be impossible", l.state))
}
return nil
}
// createSubcontainer creates a new container inside the sandbox.
func (l *Loader) createSubcontainer(cid string, tty *fd.FD) error {
l.mu.Lock()
defer l.mu.Unlock()
eid := execID{cid: cid}
if _, ok := l.processes[eid]; ok {
return fmt.Errorf("container %q already exists", cid)
}
l.processes[eid] = &execProcess{hostTTY: tty}
return nil
}
// startSubcontainer starts a child container. It returns the thread group ID of
// the newly created process. Used FDs are either closed or released. It's safe
// for the caller to close any remaining files upon return.
func (l *Loader) startSubcontainer(spec *specs.Spec, conf *config.Config, cid string, stdioFDs, goferFDs, goferFilestoreFDs []*fd.FD, devGoferFD *fd.FD, goferMountConfs []specutils.GoferMountConf, rootfsUpperTarFD *fd.FD) error {
l.mu.Lock()
defer l.mu.Unlock()
cu := cleanup.Make(func() {
l.failedToStart[cid] = struct{}{} // +checklocksignore: l.mu is locked above
})
defer cu.Clean()
ep := l.processes[execID{cid: cid}]
if ep == nil {
return fmt.Errorf("trying to start a deleted container %q", cid)
}
// Create credentials. We reuse the root user namespace because the
// sentry currently supports only 1 mount namespace, which is tied to a
// single user namespace. Thus we must run in the same user namespace
// to access mounts.
creds := getRootCredentials(spec, conf, l.k.RootUserNamespace())
if creds == nil {
return fmt.Errorf("getting root credentials")
}
var pidns *kernel.PIDNamespace
if ns, ok := specutils.GetNS(specs.PIDNamespace, spec); ok {
if ns.Path != "" {
for _, p := range l.processes {
if ns.Path == p.pidnsPath {
log.Debugf("Joining PID namespace named %q", ns.Path)
pidns = p.tg.PIDNamespace()
break
}
}
}
if pidns == nil {
log.Warningf("PID namespace %q not found, running in new PID namespace", ns.Path)
pidns = l.k.RootPIDNamespace().NewChild(l.k.SupervisorContext(), l.k, l.k.RootUserNamespace())
}
ep.pidnsPath = ns.Path
} else {
pidns = l.k.RootPIDNamespace()
}
containerName := l.registerContainerLocked(spec, cid)
l.k.RegisterContainerName(cid, containerName)
info := &containerInfo{
cid: cid,
containerName: containerName,
conf: conf,
spec: spec,
goferFDs: goferFDs,
devGoferFD: devGoferFD,
goferFilestoreFDs: goferFilestoreFDs,
goferMountConfs: goferMountConfs,
nvidiaHostSettings: l.root.nvidiaHostSettings,
nvproxyDevInfo: l.root.nvproxyDevInfo,
rootfsUpperTarFD: rootfsUpperTarFD,
}
var err error
info.procArgs, err = createProcessArgs(cid, spec, conf, creds, l.k, pidns)
if err != nil {
return fmt.Errorf("creating new process: %w", err)
}
// Use stdios or TTY depending on the spec configuration.
if spec.Process.Terminal {
if l := len(stdioFDs); l != 0 {
return fmt.Errorf("using TTY, stdios not expected: %d", l)
}
if ep.hostTTY == nil {
return fmt.Errorf("terminal enabled but no TTY provided. Did you set --console-socket on create?")
}
info.stdioFDs = []*fd.FD{ep.hostTTY, ep.hostTTY, ep.hostTTY}
ep.hostTTY = nil
} else {
info.stdioFDs = stdioFDs
}
if devGoferFD != nil {
cu.Add(func() {
// createContainerProcess() will consume devGoferFD and initialize a gofer
// connection. This connection is owned by l.k. In case of failure, we want
// to clean up this gofer connection so that the gofer process can exit.
l.k.RemoveDevGofer(containerName)
})
}
ep.tg, ep.tty, err = l.createContainerProcess(info)
if err != nil {
return err
}
if seccheck.Global.Enabled(seccheck.PointContainerStart) {
evt := pb.Start{
Id: cid,
Cwd: spec.Process.Cwd,
Args: spec.Process.Args,
Terminal: spec.Process.Terminal,
}
fields := seccheck.Global.GetFieldSet(seccheck.PointContainerStart)
if fields.Local.Contains(seccheck.FieldContainerStartEnv) {
evt.Env = spec.Process.Env
}
if !fields.Context.Empty() {
evt.ContextData = &pb.ContextData{}
kernel.LoadSeccheckData(ep.tg.Leader(), fields.Context, evt.ContextData)
}
_ = seccheck.Global.SentToSinks(func(c seccheck.Sink) error {
return c.ContainerStart(context.Background(), fields, &evt)
})
}
l.k.StartProcess(ep.tg)
// No more failures from this point on.
cu.Release()
return nil
}
// +checklocks:l.mu
func (l *Loader) createContainerProcess(info *containerInfo) (*kernel.ThreadGroup, *host.TTYFileDescription, error) {
// Create the FD map, which will set stdin, stdout, and stderr.
ctx := info.procArgs.NewContext(l.k)
fdTable, ttyFile, err := createFDTable(ctx, info.spec.Process.Terminal, info.stdioFDs, info.passFDs, info.spec.Process.User, info.containerName)
if err != nil {
return nil, nil, fmt.Errorf("importing fds: %w", err)
}
info.procArgs.StartupTimeline.Reached("FD table created")
// CreateProcess takes a reference on fdTable if successful. We won't need
// ours either way.
info.procArgs.FDTable = fdTable
if ttyFile != nil {
info.procArgs.TTY = ttyFile.TTY()
}
if info.execFD != nil {
if info.procArgs.Filename != "" {
return nil, nil, fmt.Errorf("process must either be started from a file or a filename, not both")
}
file, err := host.NewFD(ctx, l.k.HostMount(), info.execFD.FD(), &host.NewFDOptions{
Readonly: true,
Savable: true,
VirtualOwner: true,
UID: auth.KUID(info.spec.Process.User.UID),
GID: auth.KGID(info.spec.Process.User.GID),
})
if err != nil {
return nil, nil, err
}
defer file.DecRef(ctx)
info.execFD.Release()
info.procArgs.File = file
}
// Gofer FDs must be ordered and the first FD is always the rootfs.
if len(info.goferFDs) < 1 {
return nil, nil, fmt.Errorf("rootfs gofer FD not found")
}
l.startGoferMonitor(info)
if l.root.cid == l.sandboxID {
if l.root.conf.MountCgroupV2 {
if err := l.setupCgroup2(); err != nil {
return nil, nil, err
}
} else {
// Mounts cgroups for all the controllers.
if err := l.mountCgroupMounts(info.conf, info.procArgs.Credentials); err != nil {
return nil, nil, err
}
}
}
if l.root.conf.MountCgroupV2 {
// Create the container's cgroup and resolve its cgroup namespace
// before the container's mounts are set up, so that its
// /sys/fs/cgroup mount is rooted per the namespace.
cgCleanup, err := l.setupContainerCgroup2(info)
if err != nil {
return nil, nil, err
}
defer cgCleanup()
}
info.procArgs.StartupTimeline.Reached("cgroups mounted")
// We can share l.sharedMounts with containerMounter since l.mu is locked.
// Hence, mntr must only be used within this function (while l.mu is locked).
mntr := l.newContainerMounter(info)
if err := setupContainerVFS(ctx, info, mntr, &info.procArgs); err != nil {
return nil, nil, err
}
defer func() {
for cg := range info.procArgs.InitialCgroups {
cg.Dentry.DecRef(ctx)
}
}()
// Add the HOME environment variable if it is not already set.
info.procArgs.Envv, err = user.MaybeAddExecUserHome(ctx, info.procArgs.MountNamespace,
info.procArgs.Credentials.RealKUID, info.procArgs.Envv)
if err != nil {
return nil, nil, err
}
info.procArgs.StartupTimeline.Reached("exec user home resolved")
// Create and start the new process.
tg, _, err := l.k.CreateProcess(info.procArgs)
if err != nil {
return nil, nil, fmt.Errorf("creating process: %w", err)
}
// CreateProcess takes a reference on FDTable if successful.
info.procArgs.FDTable.DecRef(ctx)
// Install seccomp filters with the new task if there are any.
program, err := buildOCISeccompProgram(info.conf, info.spec)
if err != nil {
return nil, nil, err
}
if program != nil {
task := tg.Leader()
// NOTE: It seems Flags are ignored by runc so we ignore them too.
if err := task.AppendSyscallFilter(*program, true); err != nil {
return nil, nil, fmt.Errorf("appending seccomp filters: %w", err)
}
info.procArgs.StartupTimeline.Reached("OCI seccomp filters applied")
}
return tg, ttyFile, nil
}
// startGoferMonitor runs a goroutine to monitor gofer's health. It polls on
// the gofer FD looking for disconnects, and kills the container processes if
// the gofer connection disconnects.
func (l *Loader) startGoferMonitor(info *containerInfo) {
// We need to pick a suitable gofer connection that is expected to be alive
// for the entire container lifecycle. Only the following can be used:
// 1. Rootfs gofer connection
// 2. Device gofer connection
//
// Note that other gofer mounts are allowed to be unmounted and disconnected.
goferFD := -1
if info.goferMountConfs[0].ShouldUseLisafs() {
goferFD = info.goferFDs[0].FD()
} else if info.devGoferFD != nil {
goferFD = info.devGoferFD.FD()
}
if goferFD < 0 {
log.Warningf("could not find a suitable gofer FD to monitor")
return
}
go func() {
log.Debugf("Monitoring gofer health for container %q", info.cid)
events := []unix.PollFd{
{
Fd: int32(goferFD),
Events: unix.POLLHUP | unix.POLLRDHUP,
},
}
_, _, err := specutils.RetryEintr(func() (uintptr, uintptr, error) {
// Use ppoll instead of poll because it's already allowed in seccomp.
n, err := unix.Ppoll(events, nil, nil)
return uintptr(n), 0, err
})
if err != nil {
panic(fmt.Sprintf("Error monitoring gofer FDs: %s", err))
}
l.mu.Lock()
defer l.mu.Unlock()
// The gofer could have been stopped due to a normal container shutdown.
// Check if the container has not stopped yet.
if tg, _ := l.tryThreadGroupFromIDLocked(execID{cid: info.cid}); tg != nil {
log.Infof("Gofer socket disconnected, killing container %q", info.cid)
if err := l.signalAllProcesses(info.cid, int32(linux.SIGKILL)); err != nil {
log.Warningf("Error killing container %q after gofer stopped: %s", info.cid, err)
}
}
}()
}
// destroySubcontainer stops a container if it is still running and cleans up
// its filesystem.
func (l *Loader) destroySubcontainer(cid string) error {
l.mu.Lock()
defer l.mu.Unlock()
tg, err := l.tryThreadGroupFromIDLocked(execID{cid: cid})
if err != nil {
// Container doesn't exist.
return err
}
// The container exists, but has it been started?
if tg != nil {
if err := l.signalAllProcesses(cid, int32(linux.SIGKILL)); err != nil {
return fmt.Errorf("sending SIGKILL to all container processes: %w", err)
}
// Wait for all processes that belong to the container to exit (including
// exec'd processes).
for _, t := range l.k.TaskSet().Root.Tasks() {
if t.ContainerID() == cid {
t.ThreadGroup().WaitExited()
}
}
}
// No more failure from this point on.
// Remove all container thread groups from the map.
for key := range l.processes {
if key.cid == cid {
delete(l.processes, key)
}
}
// Cleanup the device gofer.
l.k.RemoveDevGofer(l.k.ContainerName(cid))
if l.root.conf.MountCgroupV2 {
l.removeContainerCgroup2(cid)
}
log.Debugf("Container destroyed, cid: %s", cid)
return nil
}
func (l *Loader) executeAsync(args *control.ExecArgs) (kernel.ThreadID, error) {
// Hold the lock for the entire operation to ensure that exec'd process is
// added to 'processes' in case it races with destroyContainer().
l.mu.Lock()
defer l.mu.Unlock()
tg, err := l.tryThreadGroupFromIDLocked(execID{cid: args.ContainerID})
if err != nil {
return 0, err
}
if tg == nil {
return 0, fmt.Errorf("container %q not started", args.ContainerID)
}
// Get the container MountNamespace from the Task. Try to acquire ref may fail
// in case it raced with task exit.
// task.MountNamespace() does not take a ref, so we must do so ourselves.
args.MountNamespace = tg.Leader().MountNamespace()
if args.MountNamespace == nil || !args.MountNamespace.TryIncRef() {
return 0, fmt.Errorf("container %q has stopped", args.ContainerID)
}
sctx := l.k.SupervisorContext()
root := args.MountNamespace.Root(sctx)
defer root.DecRef(sctx)
ctx := vfs.WithRoot(sctx, root)
defer args.MountNamespace.DecRef(ctx)
args.Envv, err = specutils.ResolveEnvs(args.Envv)
if err != nil {
return 0, fmt.Errorf("resolving env: %w", err)
}
// Add the HOME environment variable if it is not already set.
args.Envv, err = user.MaybeAddExecUserHome(ctx, args.MountNamespace, args.KUID, args.Envv)
if err != nil {
return 0, err
}
args.PIDNamespace = tg.PIDNamespace()
if l.root.conf.MountCgroupV2 {
// Join the container's cgroup and cgroup namespace, like Linux's
// runc exec does.
leader := tg.Leader()
args.InitialCgroupV2 = leader.Cgroup2()
if cgroupns := leader.GetCgroupNamespace(); cgroupns != nil {
args.CgroupNamespace = cgroupns
defer cgroupns.DecRef(sctx)
}
}
args.Limits, err = createLimitSet(l.root.spec, specutils.TPUProxyEnabled(l.root.spec, l.root.conf))
if err != nil {
return 0, fmt.Errorf("creating limits: %w", err)
}
containerName := l.k.ContainerName(args.ContainerID)
spec := l.containerSpecs[containerName]
if spec != nil {
seccompProgram, err := buildOCISeccompProgram(l.root.conf, spec)
if err != nil {
return 0, err
}
args.SeccompProgram = seccompProgram
}
// Start the process.
proc := control.Proc{Kernel: l.k}
newTG, tgid, ttyFile, err := control.ExecAsync(&proc, args)
if err != nil {
return 0, err
}
eid := execID{cid: args.ContainerID, pid: tgid}
l.processes[eid] = &execProcess{
tg: newTG,
tty: ttyFile,
}
log.Debugf("updated processes: %v", l.processes)
return tgid, nil
}
// waitContainer waits for the init process of a container to exit.
func (l *Loader) waitContainer(cid string, waitStatus *uint32) error {
l.mu.Lock()
state := l.state
if state == restoringUnstarted {
log.Infof("Waiting for the container to restore, CID: %q", cid)
l.restoreDone.Wait()
l.mu.Unlock()
log.Infof("Restore is completed, trying to wait for container %q again.", cid)
return l.waitContainer(cid, waitStatus)
}
tg, err := l.tryThreadGroupFromIDLocked(execID{cid: cid})
l.mu.Unlock()
if err != nil {
// The container does not exist.
return err
}
if tg == nil {
// The container has not been started.
switch state {
case created, started:
// Note that state=started means the root container has been started,
// but other containers may not have started yet.
return fmt.Errorf("container %q not started", cid)
case restoringStarted, restored:
// The container has restored, we *should* have found the init process...
return fmt.Errorf("could not find init process of restored container %q in state %q", cid, state)
case restoreFailed:
// If restore failed, we should return the a non-zero exit status here to
// indicate that the container failed and transition to "stopped" state.
log.Warningf("Restore failed, returning from waitContainer with non-zero exit status")
*waitStatus = 1
return nil
case restoringUnstarted:
panic("impossible")
default:
panic(fmt.Sprintf("Invalid state: %s", state))
}
}
// If the thread either has already exited or exits during waiting,
// consider the container exited.
ws := l.wait(tg)
*waitStatus = ws
// Check for leaks and write coverage report after the root container has
// exited. This guarantees that the report is written in cases where the
// sandbox is killed by a signal after the ContMgrWait request is completed.
if l.root.procArgs.ContainerID == cid {
// All sentry-created resources should have been released at this point.
_ = coverage.Report()
}
return nil
}
func (l *Loader) waitRestore() error {
l.mu.Lock()
defer l.mu.Unlock()
if l.state == restored || l.state == restoreFailed {
return l.restoreErr
}
if l.state != restoringUnstarted && l.state != restoringStarted {
return fmt.Errorf("sandbox is not being restored, cannot wait for restore: state=%s", l.state)
}
log.Infof("Waiting for the sandbox to restore")
l.restoreDone.Wait()
return l.restoreErr
}
func (l *Loader) waitPID(tgid kernel.ThreadID, cid string, waitStatus *uint32) error {
if tgid <= 0 {
return fmt.Errorf("PID (%d) must be positive", tgid)
}
// Try to find a process that was exec'd
eid := execID{cid: cid, pid: tgid}
execTG, err := l.threadGroupFromID(eid)
if err == nil {
ws := l.wait(execTG)
*waitStatus = ws
l.mu.Lock()
delete(l.processes, eid)
log.Debugf("updated processes (removal): %v", l.processes)
l.mu.Unlock()
return nil
}
// The caller may be waiting on a process not started directly via exec.
// In this case, find the process in the container's PID namespace.
initTG, err := l.threadGroupFromID(execID{cid: cid})
if err != nil {
return fmt.Errorf("waiting for PID %d: %w", tgid, err)
}
tg := initTG.PIDNamespace().ThreadGroupWithID(tgid)
if tg == nil {
return fmt.Errorf("waiting for PID %d: no such process", tgid)
}
if tg.Leader().ContainerID() != cid {
return fmt.Errorf("process %d is part of a different container: %q", tgid, tg.Leader().ContainerID())
}
ws := l.wait(tg)
*waitStatus = ws
return nil
}
// wait waits for the process with TGID 'tgid' in a container's PID namespace
// to exit.
func (l *Loader) wait(tg *kernel.ThreadGroup) uint32 {
tg.WaitExited()
return uint32(tg.ExitStatus())
}
// WaitForStartSignal waits for a start signal from the control server.
func (l *Loader) WaitForStartSignal() {
<-l.ctrl.manager.startChan
}
// WaitExit waits for the root container to exit, and returns its exit status.
func (l *Loader) WaitExit() linux.WaitStatus {
// Wait for container.
l.k.WaitExited()
return l.k.GlobalInit().ExitStatus()
}
func newRootNetworkNamespace(conf *config.Config, clock tcpip.Clock, userns *auth.UserNamespace, uid uniqueid.Provider) (*inet.Namespace, error) {
// Create an empty network stack because the network namespace may be empty at
// this point. Netns is configured before Run() is called. Netstack is
// configured using a control uRPC message. Host network is configured inside
// Run().
switch conf.Network {
case config.NetworkHost:
// If configured for raw socket support with host network
// stack, make sure that we have CAP_NET_RAW the host,
// otherwise we can't make raw sockets.
if conf.EnableRaw && !specutils.HasCapabilities(capability.CAP_NET_RAW) {
return nil, fmt.Errorf("configuring network=host with raw sockets requires CAP_NET_RAW capability")
}
// No network namespacing support for hostinet yet, hence creator is nil.
return inet.NewRootNamespace(hostinet.NewStack(), nil, userns), nil
case config.NetworkNone, config.NetworkSandbox:
creator := &sandboxNetstackCreator{
clock: clock,
allowPacketEndpointWrite: conf.AllowPacketEndpointWrite,
allowLiveTCPMigration: conf.AllowLiveTCPMigration,
uid: uid,
}
s, err := creator.newEmptySandboxNetworkStack()
if err != nil {
return nil, err
}
return inet.NewRootNamespace(s, creator, userns), nil
case config.NetworkPlugin:
return inet.NewRootNamespace(plugin.GetPluginStack(), nil, userns), nil
default:
panic(fmt.Sprintf("invalid network configuration: %v", conf.Network))
}
}
func (c *sandboxNetstackCreator) newEmptySandboxNetworkStack() (*netstack.Stack, error) {
netProtos := []stack.NetworkProtocolFactory{ipv4.NewProtocol, ipv6.NewProtocol, arp.NewProtocol}
transProtos := []stack.TransportProtocolFactory{
tcp.NewProtocol,
udp.NewProtocol,
icmp.NewProtocol4,
icmp.NewProtocol6,
}
s := netstack.NewStack(stack.New(stack.Options{
NetworkProtocols: netProtos,
TransportProtocols: transProtos,
Clock: c.clock,
Stats: netstack.Metrics,
HandleLocal: true,
// Enable raw sockets for users with sufficient
// privileges.
RawFactory: raw.EndpointFactory{},
AllowPacketEndpointWrite: c.allowPacketEndpointWrite,
AllowLiveTCPMigration: c.allowLiveTCPMigration,
DefaultIPTables: netfilter.DefaultLinuxTables,
}), c.uid.UniqueID())
if nftables.IsNFTablesEnabled() {
s.Stack.SetNFTables(nftables.NewNFTables(s.Stack, c.clock, s.Stack.SecureRNG()))
}
// Enable SACK Recovery.
{
opt := tcpip.TCPSACKEnabled(true)
if err := s.Stack.SetTransportProtocolOption(tcp.ProtocolNumber, &opt); err != nil {
return nil, fmt.Errorf("SetTransportProtocolOption(%d, &%T(%t)): %s", tcp.ProtocolNumber, opt, opt, err)
}
}
// Set default TTLs as required by socket/netstack.
{
opt := tcpip.DefaultTTLOption(netstack.DefaultTTL)
if err := s.Stack.SetNetworkProtocolOption(ipv4.ProtocolNumber, &opt); err != nil {
return nil, fmt.Errorf("SetNetworkProtocolOption(%d, &%T(%d)): %s", ipv4.ProtocolNumber, opt, opt, err)
}
if err := s.Stack.SetNetworkProtocolOption(ipv6.ProtocolNumber, &opt); err != nil {
return nil, fmt.Errorf("SetNetworkProtocolOption(%d, &%T(%d)): %s", ipv6.ProtocolNumber, opt, opt, err)
}
}
// Enable Receive Buffer Auto-Tuning.
{
opt := tcpip.TCPModerateReceiveBufferOption(true)
if err := s.Stack.SetTransportProtocolOption(tcp.ProtocolNumber, &opt); err != nil {
return nil, fmt.Errorf("SetTransportProtocolOption(%d, &%T(%t)): %s", tcp.ProtocolNumber, opt, opt, err)
}
}
return s, nil
}
// sandboxNetstackCreator implements kernel.NetworkStackCreator.
//
// +stateify savable
type sandboxNetstackCreator struct {
clock tcpip.Clock
allowPacketEndpointWrite bool
allowLiveTCPMigration bool
uid uniqueid.Provider
}
// CreateStack implements kernel.NetworkStackCreator.CreateStack.
func (c *sandboxNetstackCreator) CreateStack() (inet.Stack, error) {
s, err := c.newEmptySandboxNetworkStack()
if err != nil {
return nil, err
}
// Setup loopback.
n := &Network{Stack: s.Stack}
nicID := s.Stack.NextNICID()
if nicID != linux.LOOPBACK_IFINDEX {
return nil, fmt.Errorf("loopback device should always have index %d, got %d", linux.LOOPBACK_IFINDEX, nicID)
}
link := DefaultLoopbackLink
linkEP := ethernet.New(loopback.New())
opts := stack.NICOptions{
Name: link.Name,
DeliverLinkPackets: true,
}
if err := n.createNICWithAddrs(nicID, linkEP, opts, link.Addresses); err != nil {
return nil, err
}
return s, nil
}
// signal sends a signal to one or more processes in a container. If PID is 0,
// then the container init process is used. Depending on the SignalDeliveryMode
// option, the signal may be sent directly to the indicated process, to all
// processes in the container, or to the foreground process group. pid is
// relative to the root PID namespace, not the container's.
func (l *Loader) signal(cid string, pid, signo int32, mode SignalDeliveryMode) error {
if pid < 0 {
return fmt.Errorf("PID (%d) must be positive", pid)
}
switch mode {
case DeliverToProcess:
if err := l.signalProcess(cid, kernel.ThreadID(pid), signo); err != nil {
return fmt.Errorf("signaling process in container %q PID %d: %w", cid, pid, err)
}
return nil
case DeliverToForegroundProcessGroup:
if err := l.signalForegrondProcessGroup(cid, kernel.ThreadID(pid), signo); err != nil {
return fmt.Errorf("signaling foreground process group in container %q PID %d: %w", cid, pid, err)
}
return nil
case DeliverToAllProcesses:
if pid != 0 {
return fmt.Errorf("PID (%d) cannot be set when signaling all processes", pid)
}
// Check that the container has actually started before signaling it.
if _, err := l.threadGroupFromID(execID{cid: cid}); err != nil {
return err
}
if err := l.signalAllProcesses(cid, signo); err != nil {
return fmt.Errorf("signaling all processes in container %q: %w", cid, err)
}
return nil
case DeliverToProcessGroup:
if pid == 0 {
return fmt.Errorf("PGID must be set when signaling a process group")
}
if err := l.signalProcessGroup(cid, kernel.ProcessGroupID(pid), signo); err != nil {
return fmt.Errorf("signaling process group %d: %w", pid, err)
}
return nil
default:
panic(fmt.Sprintf("unknown signal delivery mode %v", mode))
}
}
// signalProcess sends signal to process in the given container. tgid is
// relative to the root PID namespace, not the container's.
func (l *Loader) signalProcess(cid string, tgid kernel.ThreadID, signo int32) error {
execTG, err := l.threadGroupFromID(execID{cid: cid, pid: tgid})
if err == nil {
// Send signal directly to the identified process.
return l.k.SendExternalSignalThreadGroup(execTG, &linux.SignalInfo{Signo: signo})
}
// The caller may be signaling a process not started directly via exec.
// In this case, find the process and check that the process belongs to the
// container in question.
tg := l.k.RootPIDNamespace().ThreadGroupWithID(tgid)
if tg == nil {
return fmt.Errorf("no such process with PID %d", tgid)
}
if tg.Leader().ContainerID() != cid {
return fmt.Errorf("process %d belongs to a different container: %q", tgid, tg.Leader().ContainerID())
}
return l.k.SendExternalSignalThreadGroup(tg, &linux.SignalInfo{Signo: signo})
}
// signalForegrondProcessGroup looks up foreground process group from the TTY
// for the given "tgid" inside container "cid", and send the signal to it.
func (l *Loader) signalForegrondProcessGroup(cid string, tgid kernel.ThreadID, signo int32) error {
l.mu.Lock()
tg, err := l.tryThreadGroupFromIDLocked(execID{cid: cid, pid: tgid})
if err != nil {
l.mu.Unlock()
return fmt.Errorf("no thread group found: %w", err)
}
if tg == nil {
l.mu.Unlock()
return fmt.Errorf("container %q not started", cid)
}
tty, err := l.ttyFromIDLocked(execID{cid: cid, pid: tgid})
l.mu.Unlock()
if err != nil {
return fmt.Errorf("no thread group found: %w", err)
}
if tty == nil {
return fmt.Errorf("no TTY attached")
}
si := &linux.SignalInfo{Signo: signo}
ttyTg := tty.ThreadGroup()
if ttyTg == nil {
// No thread group has been set. Signal the original thread
// group.
log.Warningf("No thread group for container %q and PID %d. Sending signal directly to PID %d.", cid, tgid, tgid)
return l.k.SendExternalSignalThreadGroup(tg, si)
}
pg, _ := ttyTg.ForegroundProcessGroup(tty.TTY())
if pg == nil {
// No foreground process group has been set. Signal the
// original thread group.
log.Warningf("No foreground process group for container %q and PID %d. Sending signal directly to PID %d.", cid, tgid, tgid)
return l.k.SendExternalSignalThreadGroup(tg, si)
}
// Send the signal to all processes in the process group.
return l.k.SendExternalSignalProcessGroup(pg, si)
}
// signalAllProcesses that belong to specified container. It's a noop if the
// container hasn't started or has exited.
func (l *Loader) signalAllProcesses(cid string, signo int32) error {
// Pause the kernel to prevent new processes from being created while
// the signal is delivered. This prevents process leaks when SIGKILL is
// sent to the entire container.
l.k.Pause()
defer l.k.Unpause()
return l.k.SendContainerSignal(cid, &linux.SignalInfo{Signo: signo})
}
// signalProcessGroup sends the signal to all processes in the process group
// identified by pgid. pgid is relative to the root PID namespace. It verifies
// that the process group exists in the container with the given ID.
func (l *Loader) signalProcessGroup(cid string, pgid kernel.ProcessGroupID, signo int32) error {
pg := l.k.RootPIDNamespace().ProcessGroupWithID(pgid)
if pg == nil {
return fmt.Errorf("no such process group with PGID %d", pgid)
}
// Verify that the process group exists in correct container.
found := false
for _, tg := range l.k.TaskSet().Root.ThreadGroups() {
if tg.ProcessGroup() == pg && tg.Leader().ContainerID() == cid {
found = true
break
}
}
if !found {
return fmt.Errorf("process group %d does not belong to container %q", pgid, cid)
}
return l.k.SendExternalSignalProcessGroup(pg, &linux.SignalInfo{Signo: signo})
}
// threadGroupFromID is similar to tryThreadGroupFromIDLocked except that it
// acquires mutex before calling it and fails in case container hasn't started
// yet.
func (l *Loader) threadGroupFromID(key execID) (*kernel.ThreadGroup, error) {
l.mu.Lock()
defer l.mu.Unlock()
tg, err := l.tryThreadGroupFromIDLocked(key)
if err != nil {
return nil, err
}
if tg == nil {
return nil, fmt.Errorf("container %q not started", key.cid)
}
return tg, nil
}
// tryThreadGroupFromIDLocked returns the thread group for the given execution
// ID. It may return nil in case the container has not started yet. Returns
// error if execution ID is invalid or if the container cannot be found (maybe
// it has been deleted).
// +checklocks:l.mu
func (l *Loader) tryThreadGroupFromIDLocked(key execID) (*kernel.ThreadGroup, error) {
ep, err := l.findProcessLocked(key)
if err != nil {
return nil, err
}
return ep.tg, nil
}
// ttyFromIDLocked returns the TTY files for the given execution ID. It may
// return nil in case the container has not started yet. Returns error if
// execution ID is invalid or if the container cannot be found (maybe it has
// been deleted).
// +checklocks:l.mu
func (l *Loader) ttyFromIDLocked(key execID) (*host.TTYFileDescription, error) {
ep, err := l.findProcessLocked(key)
if err != nil {
return nil, err
}
return ep.tty, nil
}
func createFDTable(ctx context.Context, console bool, stdioFDs []*fd.FD, passFDs []fdMapping, user specs.User, containerName string) (*kernel.FDTable, *host.TTYFileDescription, error) {
if len(stdioFDs) != 3 {
return nil, nil, fmt.Errorf("stdioFDs should contain exactly 3 FDs (stdin, stdout, and stderr), but %d FDs received", len(stdioFDs))
}
fdMap := map[int]*fd.FD{
0: stdioFDs[0],
1: stdioFDs[1],
2: stdioFDs[2],
}
// Create the entries for the host files that were passed to our app.
for _, customFD := range passFDs {
if customFD.guest < 0 {
return nil, nil, fmt.Errorf("guest file descriptors must be 0 or greater")
}
fdMap[customFD.guest] = customFD.host
}
k := kernel.KernelFromContext(ctx)
fdTable := k.NewFDTable()
opts := fdimport.ImportOptions{
Console: console,
Restorable: true,
UID: auth.KUID(user.UID),
GID: auth.KGID(user.GID),
ContainerName: containerName,
SupportTTYs: true,
}
ttyFile, err := fdimport.Import(ctx, fdTable, fdMap, opts)
if err != nil {
fdTable.DecRef(ctx)
return nil, nil, err
}
return fdTable, ttyFile, nil
}
// portForward implements initiating a portForward connection in the sandbox. portForwardProxies
// represent a two connections each copying to each other (read ends to write ends) in goroutines.
// The proxies are stored and can be cleaned up, or clean up after themselves if the connection
// is broken.
func (l *Loader) portForward(opts *PortForwardOpts) error {
// Validate that we have a stream FD to write to. If this happens then
// it means there is a misbehaved urpc client or a bug has occurred.
if len(opts.Files) != 1 {
return fmt.Errorf("stream FD is required for port forward")
}
l.mu.Lock()
defer l.mu.Unlock()
cid := opts.ContainerID
tg, err := l.tryThreadGroupFromIDLocked(execID{cid: cid})
if err != nil {
return fmt.Errorf("failed to get threadgroup from %q: %w", cid, err)
}
if tg == nil {
return fmt.Errorf("container %q not started", cid)
}
// Import the fd for the UDS.
ctx := l.k.SupervisorContext()
fd, err := l.importFD(ctx, opts.Files[0])
if err != nil {
return fmt.Errorf("importing stream fd: %w", err)
}
cu := cleanup.Make(func() { fd.DecRef(ctx) })
defer cu.Clean()
fdConn := pf.NewFileDescriptionConn(fd)
// Create a proxy to forward data between the fdConn and the sandboxed application.
pair := pf.ProxyPair{To: fdConn}
switch l.root.conf.Network {
case config.NetworkSandbox:
stack := l.k.RootNetworkNamespace().Stack().(*netstack.Stack).Stack
nsConn, err := pf.NewNetstackConn(stack, opts.Port)
if err != nil {
return fmt.Errorf("creating netstack port forward connection: %w", err)
}
pair.From = nsConn
case config.NetworkHost:
hConn, err := pf.NewHostInetConn(opts.Port)
if err != nil {
return fmt.Errorf("creating hostinet port forward connection: %w", err)
}
pair.From = hConn
default:
return fmt.Errorf("unsupported network type %q for container %q", l.root.conf.Network, cid)
}
cu.Release()
proxy := pf.NewProxy(pair, opts.ContainerID)
// Add to the list of port forward connections and remove when the
// connection closes.
l.portForwardProxies = append(l.portForwardProxies, proxy)
proxy.AddCleanup(func() {
l.mu.Lock()
defer l.mu.Unlock()
for i := range l.portForwardProxies {
if l.portForwardProxies[i] == proxy {
l.portForwardProxies = append(l.portForwardProxies[:i], l.portForwardProxies[i+1:]...)
break
}
}
})
// Start forwarding on the connection.
proxy.Start(ctx)
return nil
}
// importFD generically imports a host file descriptor without adding it to any
// fd table.
func (l *Loader) importFD(ctx context.Context, f *os.File) (*vfs.FileDescription, error) {
hostFD, err := fd.NewFromFile(f)
if err != nil {
return nil, err
}
defer hostFD.Close()
fd, err := host.NewFD(ctx, l.k.HostMount(), hostFD.FD(), &host.NewFDOptions{
Savable: false, // We disconnect and close on save.
IsTTY: false,
VirtualOwner: false, // FD not visible to the sandboxed app so user can't be changed.
})
if err != nil {
return nil, err
}
hostFD.Release()
return fd, nil
}
func (l *Loader) containerCount() int {
l.mu.Lock()
defer l.mu.Unlock()
containers := 0
for id := range l.processes {
if id.pid == 0 {
// pid==0 represents the init process of a container. There is
// only one of such process per container.
containers++
}
}
return containers
}
func (l *Loader) pidsCount(cid string) (int, error) {
l.mu.Lock()
defer l.mu.Unlock()
if _, err := l.tryThreadGroupFromIDLocked(execID{cid: cid}); err != nil {
// Container doesn't exist.
return 0, err
}
return l.k.TaskSet().Root.NumTasksPerContainer(cid), nil
}
func (l *Loader) networkStats() ([]*NetworkInterface, error) {
var stats []*NetworkInterface
stack := l.k.RootNetworkNamespace().Stack()
for _, i := range stack.Interfaces() {
var stat inet.StatDev
if err := stack.Statistics(&stat, i.Name); err != nil {
return nil, err
}
stats = append(stats, &NetworkInterface{
Name: i.Name,
RxBytes: stat[0],
RxPackets: stat[1],
RxErrors: stat[2],
RxDropped: stat[3],
TxBytes: stat[8],
TxPackets: stat[9],
TxErrors: stat[10],
TxDropped: stat[11],
})
}
return stats, nil
}
// +checklocks:l.mu
func (l *Loader) findProcessLocked(key execID) (*execProcess, error) {
ep := l.processes[key]
if ep == nil {
return nil, fmt.Errorf("container %q not found", key.cid)
}
return ep, nil
}
func (l *Loader) registerContainer(spec *specs.Spec, cid string) string {
l.mu.Lock()
defer l.mu.Unlock()
return l.registerContainerLocked(spec, cid)
}
// +checklocks:l.mu
func (l *Loader) registerContainerLocked(spec *specs.Spec, cid string) string {
containerName := specutils.ContainerName(spec)
if len(containerName) == 0 {
// If no name was provided, require containers to be restored in the same order
// they were created.
containerName = "__no_name_" + strconv.Itoa(len(l.containerIDs))
}
l.containerIDs[containerName] = cid
l.containerSpecs[containerName] = spec
return containerName
}
func (l *Loader) getContainerSpec(containerName string) *specs.Spec {
l.mu.Lock()
defer l.mu.Unlock()
return l.containerSpecs[containerName]
}
// SpecEnviron returns the environment variables for the given container from
// the container spec it was created with.
func (l *Loader) SpecEnviron(containerName string) []string {
spec := l.getContainerSpec(containerName)
if spec == nil {
log.Warningf("Container spec not found for container %q", containerName)
return nil
}
return spec.Process.Env
}
func (l *Loader) containerRuntimeState(cid string) ContainerRuntimeState {
l.mu.Lock()
defer l.mu.Unlock()
exec, ok := l.processes[execID{cid: cid}]
if !ok {
// Can't distinguish between invalid CID and stopped container, assume that
// CID is valid.
return RuntimeStateStopped
}
if exec.tg == nil {
if l.state == restoreFailed {
return RuntimeStateStopped
}
if _, ok := l.failedToStart[cid]; ok {
return RuntimeStateStopped
}
// Container has no thread group assigned, so it has not started yet.
return RuntimeStateCreating
}
if exec.tg.Leader().ExitState() == kernel.TaskExitNone {
// Init process is still running.
return RuntimeStateRunning
}
// Init process has stopped, but no one has called wait on it yet.
return RuntimeStateStopped
}
// GetContainerSpecs returns the container specs map.
func (l *Loader) GetContainerSpecs() map[string]*specs.Spec {
l.mu.Lock()
defer l.mu.Unlock()
return l.containerSpecs
}