containerd/pkg/opts/container.go

/*
Copyright 2017 The Kubernetes 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 opts

import (
	"context"
	"io/ioutil"
	"os"
	"path/filepath"

	"github.com/containerd/containerd"
	"github.com/containerd/containerd/containers"
	"github.com/containerd/containerd/errdefs"
	"github.com/docker/docker/pkg/chrootarchive"
	"github.com/docker/docker/pkg/system"
	"github.com/opencontainers/image-spec/identity"
	"github.com/pkg/errors"
	"golang.org/x/sys/unix"
)

// WithImageUnpack guarantees that the image used by the container is unpacked.
func WithImageUnpack(i containerd.Image) containerd.NewContainerOpts {
	return func(ctx context.Context, client *containerd.Client, c *containers.Container) error {
		if c.Snapshotter == "" {
			return errors.New("no snapshotter set for container")
		}
		snapshotter := client.SnapshotService(c.Snapshotter)
		diffIDs, err := i.RootFS(ctx)
		if err != nil {
			return errors.Wrap(err, "get image diff IDs")
		}
		chainID := identity.ChainID(diffIDs)
		_, err = snapshotter.Stat(ctx, chainID.String())
		if err == nil {
			return nil
		}
		if !errdefs.IsNotFound(err) {
			return errors.Wrap(err, "stat snapshot")
		}
		// Unpack the snapshot.
		if err := i.Unpack(ctx, c.Snapshotter); err != nil {
			return errors.Wrap(err, "unpack snapshot")
		}
		return nil
	}
}

// WithVolumes copies ownership of volume in rootfs to its corresponding host path.
// It doesn't update runtime spec.
// The passed in map is a host path to container path map for all volumes.
// TODO(random-liu): Figure out whether we need to copy volume content.
func WithVolumes(volumeMounts map[string]string) containerd.NewContainerOpts {
	return func(ctx context.Context, client *containerd.Client, c *containers.Container) error {
		if c.Snapshotter == "" {
			return errors.New("no snapshotter set for container")
		}
		if c.SnapshotKey == "" {
			return errors.New("rootfs not created for container")
		}
		snapshotter := client.SnapshotService(c.Snapshotter)
		mounts, err := snapshotter.Mounts(ctx, c.SnapshotKey)
		if err != nil {
			return err
		}
		root, err := ioutil.TempDir("", "ctd-volume")
		if err != nil {
			return err
		}
		defer os.RemoveAll(root) // nolint: errcheck
		for _, m := range mounts {
			if err := m.Mount(root); err != nil {
				return err
			}
		}
		defer unix.Unmount(root, 0) // nolint: errcheck

		for host, volume := range volumeMounts {
			src := filepath.Join(root, volume)
			if _, err := os.Stat(src); err != nil {
				if os.IsNotExist(err) {
					// Skip copying directory if it does not exist.
					continue
				}
				return errors.Wrap(err, "stat volume in rootfs")
			}
			if err := copyExistingContents(src, host); err != nil {
				return errors.Wrap(err, "taking runtime copy of volume")
			}
		}
		return nil
	}
}

// copyExistingContents copies from the source to the destination and
// ensures the ownership is appropriately set.
func copyExistingContents(source, destination string) error {
	srcList, err := ioutil.ReadDir(source)
	if err != nil {
		return err
	}
	if len(srcList) > 0 {
		dstList, err := ioutil.ReadDir(destination)
		if err != nil {
			return err
		}
		if len(dstList) != 0 {
			return errors.Errorf("volume at %q is not initially empty", destination)
		}

		if err := chrootarchive.NewArchiver(nil).CopyWithTar(source, destination); err != nil {
			return err
		}
	}
	return copyOwnership(source, destination)
}

// copyOwnership copies the permissions and uid:gid of the src file
// to the dst file
func copyOwnership(src, dst string) error {
	stat, err := system.Stat(src)
	if err != nil {
		return err
	}

	dstStat, err := system.Stat(dst)
	if err != nil {
		return err
	}

	// In some cases, even though UID/GID match and it would effectively be a no-op,
	// this can return a permission denied error... for example if this is an NFS
	// mount.
	// Since it's not really an error that we can't chown to the same UID/GID, don't
	// even bother trying in such cases.
	if stat.UID() != dstStat.UID() || stat.GID() != dstStat.GID() {
		if err := os.Chown(dst, int(stat.UID()), int(stat.GID())); err != nil {
			return err
		}
	}

	if stat.Mode() != dstStat.Mode() {
		return os.Chmod(dst, os.FileMode(stat.Mode()))
	}
	return nil
}