package libcontainer import ( "encoding/json" "errors" "fmt" "os" "regexp" "runtime/debug" "strconv" securejoin "github.com/cyphar/filepath-securejoin" "golang.org/x/sys/unix" //nolint:revive // Enable cgroup manager to manage devices _ "github.com/opencontainers/runc/libcontainer/cgroups/devices" "github.com/opencontainers/runc/libcontainer/cgroups/manager" "github.com/opencontainers/runc/libcontainer/configs" "github.com/opencontainers/runc/libcontainer/configs/validate" "github.com/opencontainers/runc/libcontainer/intelrdt" "github.com/opencontainers/runc/libcontainer/utils" "github.com/sirupsen/logrus" ) const ( stateFilename = "state.json" execFifoFilename = "exec.fifo" ) var idRegex = regexp.MustCompile(`^[\w+-\.]+$`) // Create creates a new container with the given id inside a given state // directory (root), and returns a Container object. // // The root is a state directory which many containers can share. It can be // used later to get the list of containers, or to get information about a // particular container (see Load). // // The id must not be empty and consist of only the following characters: // ASCII letters, digits, underscore, plus, minus, period. The id must be // unique and non-existent for the given root path. func Create(root, id string, config *configs.Config) (*Container, error) { if root == "" { return nil, errors.New("root not set") } if err := validateID(id); err != nil { return nil, err } if err := validate.Validate(config); err != nil { return nil, err } if err := os.MkdirAll(root, 0o700); err != nil { return nil, err } containerRoot, err := securejoin.SecureJoin(root, id) if err != nil { return nil, err } if _, err := os.Stat(containerRoot); err == nil { return nil, ErrExist } else if !os.IsNotExist(err) { return nil, err } cm, err := manager.New(config.Cgroups) if err != nil { return nil, err } // Check that cgroup does not exist or empty (no processes). // Note for cgroup v1 this check is not thorough, as there are multiple // separate hierarchies, while both Exists() and GetAllPids() only use // one for "devices" controller (assuming others are the same, which is // probably true in almost all scenarios). Checking all the hierarchies // would be too expensive. if cm.Exists() { pids, err := cm.GetAllPids() // Reading PIDs can race with cgroups removal, so ignore ENOENT and ENODEV. if err != nil && !errors.Is(err, os.ErrNotExist) && !errors.Is(err, unix.ENODEV) { return nil, fmt.Errorf("unable to get cgroup PIDs: %w", err) } if len(pids) != 0 { // TODO: return an error. logrus.Warnf("container's cgroup is not empty: %d process(es) found", len(pids)) logrus.Warn("DEPRECATED: running container in a non-empty cgroup won't be supported in runc 1.2; https://github.com/opencontainers/runc/issues/3132") } } // Check that cgroup is not frozen. Do not use Exists() here // since in cgroup v1 it only checks "devices" controller. st, err := cm.GetFreezerState() if err != nil { return nil, fmt.Errorf("unable to get cgroup freezer state: %w", err) } if st == configs.Frozen { return nil, errors.New("container's cgroup unexpectedly frozen") } // Parent directory is already created above, so Mkdir is enough. if err := os.Mkdir(containerRoot, 0o711); err != nil { return nil, err } c := &Container{ id: id, root: containerRoot, config: config, cgroupManager: cm, intelRdtManager: intelrdt.NewManager(config, id, ""), } c.state = &stoppedState{c: c} return c, nil } // Load takes a path to the state directory (root) and an id of an existing // container, and returns a Container object reconstructed from the saved // state. This presents a read only view of the container. func Load(root, id string) (*Container, error) { if root == "" { return nil, errors.New("root not set") } // when load, we need to check id is valid or not. if err := validateID(id); err != nil { return nil, err } containerRoot, err := securejoin.SecureJoin(root, id) if err != nil { return nil, err } state, err := loadState(containerRoot) if err != nil { return nil, err } r := &nonChildProcess{ processPid: state.InitProcessPid, processStartTime: state.InitProcessStartTime, fds: state.ExternalDescriptors, } cm, err := manager.NewWithPaths(state.Config.Cgroups, state.CgroupPaths) if err != nil { return nil, err } c := &Container{ initProcess: r, initProcessStartTime: state.InitProcessStartTime, id: id, config: &state.Config, cgroupManager: cm, intelRdtManager: intelrdt.NewManager(&state.Config, id, state.IntelRdtPath), root: containerRoot, created: state.Created, } c.state = &loadedState{c: c} if err := c.refreshState(); err != nil { return nil, err } return c, nil } // StartInitialization loads a container by opening the pipe fd from the parent // to read the configuration and state. This is a low level implementation // detail of the reexec and should not be consumed externally. func StartInitialization() (err error) { // Get the INITPIPE. envInitPipe := os.Getenv("_LIBCONTAINER_INITPIPE") pipefd, err := strconv.Atoi(envInitPipe) if err != nil { err = fmt.Errorf("unable to convert _LIBCONTAINER_INITPIPE: %w", err) logrus.Error(err) return err } pipe := os.NewFile(uintptr(pipefd), "pipe") defer pipe.Close() defer func() { // We have an error during the initialization of the container's init, // send it back to the parent process in the form of an initError. if werr := writeSync(pipe, procError); werr != nil { fmt.Fprintln(os.Stderr, err) return } if werr := utils.WriteJSON(pipe, &initError{Message: err.Error()}); werr != nil { fmt.Fprintln(os.Stderr, err) return } }() // Only init processes have FIFOFD. fifofd := -1 envInitType := os.Getenv("_LIBCONTAINER_INITTYPE") it := initType(envInitType) if it == initStandard { envFifoFd := os.Getenv("_LIBCONTAINER_FIFOFD") if fifofd, err = strconv.Atoi(envFifoFd); err != nil { return fmt.Errorf("unable to convert _LIBCONTAINER_FIFOFD: %w", err) } } var consoleSocket *os.File if envConsole := os.Getenv("_LIBCONTAINER_CONSOLE"); envConsole != "" { console, err := strconv.Atoi(envConsole) if err != nil { return fmt.Errorf("unable to convert _LIBCONTAINER_CONSOLE: %w", err) } consoleSocket = os.NewFile(uintptr(console), "console-socket") defer consoleSocket.Close() } logPipeFdStr := os.Getenv("_LIBCONTAINER_LOGPIPE") logPipeFd, err := strconv.Atoi(logPipeFdStr) if err != nil { return fmt.Errorf("unable to convert _LIBCONTAINER_LOGPIPE: %w", err) } // Get mount files (O_PATH). mountFds, err := parseMountFds() if err != nil { return err } // clear the current process's environment to clean any libcontainer // specific env vars. os.Clearenv() defer func() { if e := recover(); e != nil { if e, ok := e.(error); ok { err = fmt.Errorf("panic from initialization: %w, %s", e, debug.Stack()) } else { //nolint:errorlint // here e is not of error type err = fmt.Errorf("panic from initialization: %v, %s", e, debug.Stack()) } } }() i, err := newContainerInit(it, pipe, consoleSocket, fifofd, logPipeFd, mountFds) if err != nil { return err } // If Init succeeds, syscall.Exec will not return, hence none of the defers will be called. return i.Init() } func loadState(root string) (*State, error) { stateFilePath, err := securejoin.SecureJoin(root, stateFilename) if err != nil { return nil, err } f, err := os.Open(stateFilePath) if err != nil { if os.IsNotExist(err) { return nil, ErrNotExist } return nil, err } defer f.Close() var state *State if err := json.NewDecoder(f).Decode(&state); err != nil { return nil, err } return state, nil } func validateID(id string) error { if !idRegex.MatchString(id) || string(os.PathSeparator)+id != utils.CleanPath(string(os.PathSeparator)+id) { return ErrInvalidID } return nil } func parseMountFds() ([]int, error) { fdsJSON := os.Getenv("_LIBCONTAINER_MOUNT_FDS") if fdsJSON == "" { // Always return the nil slice if no fd is present. return nil, nil } var mountFds []int if err := json.Unmarshal([]byte(fdsJSON), &mountFds); err != nil { return nil, fmt.Errorf("Error unmarshalling _LIBCONTAINER_MOUNT_FDS: %w", err) } return mountFds, nil }