Cloudpods/backend/pkg/hostman/container/volume_mount/disk/post_overlay.go

// Copyright 2019 Yunion
//
// 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 disk

import (
	"math"
	"path/filepath"
	"sort"
	"strings"

	"yunion.io/x/jsonutils"
	"yunion.io/x/log"
	"yunion.io/x/pkg/errors"

	"yunion.io/x/onecloud/pkg/apis"
	hostapi "yunion.io/x/onecloud/pkg/apis/host"
	"yunion.io/x/onecloud/pkg/hostman/container/volume_mount"
)

const (
	POST_OVERLAY_PREFIX_LOWER_DIR  = "_post_overlay_lower_"
	POST_OVERLAY_PREFIX_WORK_DIR   = "_post_overlay_work_"
	POST_OVERLAY_PREFIX_UPPER_DIR  = "_post_overlay_upper_"
	POST_OVERLAY_PREFIX_MERGED_DIR = "_post_overlay_merged_"
)

func (d disk) MountPostOverlays(pod volume_mount.IPodInfo, ctrId string, vm *hostapi.ContainerVolumeMount, ovs []*apis.ContainerVolumeMountDiskPostOverlay) error {
	return d.newPostOverlay().mountPostOverlays(pod, ctrId, vm, ovs)
}

func (d disk) UnmountPostOverlays(pod volume_mount.IPodInfo, ctrId string, vm *hostapi.ContainerVolumeMount, ovs []*apis.ContainerVolumeMountDiskPostOverlay, useLazy bool, clearLayers bool) error {
	return d.newPostOverlay().unmountPostOverlays(pod, ctrId, vm, ovs, useLazy, clearLayers)
}

func (d disk) getPostOverlayRootPrefixDir(prefixDir string, pod volume_mount.IPodInfo, vm *hostapi.ContainerVolumeMount, ctrId string) (string, error) {
	hostPath, err := d.GetHostDiskRootPath(pod, vm)
	if err != nil {
		return "", errors.Wrap(err, "get host disk root path")
	}
	uniqDir := ctrId
	if vm.UniqueName != "" {
		uniqDir = vm.UniqueName
	}
	return filepath.Join(hostPath, prefixDir, uniqDir), nil
}

func (d disk) GetPostOverlayRootWorkDir(pod volume_mount.IPodInfo, vm *hostapi.ContainerVolumeMount, ctrId string) (string, error) {
	return d.getPostOverlayRootPrefixDir(POST_OVERLAY_PREFIX_WORK_DIR, pod, vm, ctrId)
}

func (d disk) GetPostOverlayRootUpperDir(pod volume_mount.IPodInfo, vm *hostapi.ContainerVolumeMount, ctrId string, pov *apis.ContainerVolumeMountDiskPostOverlay) (string, error) {
	if pov.Image != nil && pov.Image.UpperConfig != nil {
		config := pov.Image.UpperConfig
		if config.Disk.SubPath == "" {
			return "", errors.Errorf("sub_path of upper config is empty")
		}
		hostPath, err := d.GetHostDiskRootPath(pod, vm)
		if err != nil {
			return "", errors.Wrap(err, "get host disk root path")
		}
		upperDir := filepath.Join(hostPath, vm.Disk.SubDirectory, config.Disk.SubPath)
		return upperDir, nil
	}
	return d.getPostOverlayRootPrefixDir(POST_OVERLAY_PREFIX_UPPER_DIR, pod, vm, ctrId)
}

type iDiskPostOverlay interface {
	mountPostOverlays(pod volume_mount.IPodInfo, ctrId string, vm *hostapi.ContainerVolumeMount, ovs []*apis.ContainerVolumeMountDiskPostOverlay) error
	unmountPostOverlays(pod volume_mount.IPodInfo, ctrId string, vm *hostapi.ContainerVolumeMount, ovs []*apis.ContainerVolumeMountDiskPostOverlay, useLazy bool, clearLayers bool) error
}

type diskPostOverlay struct {
	disk disk
}

func newDiskPostOverlay(d disk) iDiskPostOverlay {
	return &diskPostOverlay{
		disk: d,
	}
}

var (
	postOverlayDrivers = make(map[apis.ContainerVolumeMountDiskPostOverlayType]iDiskPostOverlayDriver)
)

func registerPostOverlayDriver(drv iDiskPostOverlayDriver) {
	postOverlayDrivers[drv.GetType()] = drv
}

func getPostOverlayDriver(typ apis.ContainerVolumeMountDiskPostOverlayType) iDiskPostOverlayDriver {
	return postOverlayDrivers[typ]
}

type iDiskPostOverlayDriver interface {
	GetType() apis.ContainerVolumeMountDiskPostOverlayType
	Mount(d diskPostOverlay, pod volume_mount.IPodInfo, ctrId string, vm *hostapi.ContainerVolumeMount, ov *apis.ContainerVolumeMountDiskPostOverlay) error
	Unmount(d diskPostOverlay, pod volume_mount.IPodInfo, ctrId string, vm *hostapi.ContainerVolumeMount, ov *apis.ContainerVolumeMountDiskPostOverlay, useLazy bool, clearLayers bool) error
}

func (d diskPostOverlay) getDriver(ov *apis.ContainerVolumeMountDiskPostOverlay) iDiskPostOverlayDriver {
	return getPostOverlayDriver(ov.GetType())
}

// getMinPathMapKeyLength 获取 PathMap 中最短 key 的长度
// 如果 Image 为 nil 或 PathMap 为空，返回一个很大的值，确保排在后面
func getMinPathMapKeyLength(ov *apis.ContainerVolumeMountDiskPostOverlay) int {
	if ov.Image == nil || len(ov.Image.PathMap) == 0 {
		return math.MaxInt // 返回一个很大的值，确保没有 PathMap 的排在后面
	}
	minLen := math.MaxInt
	for key := range ov.Image.PathMap {
		if len(key) < minLen {
			minLen = len(key)
		}
	}
	return minLen
}

func sortPostOverlayByPathMapLength(ovs []*apis.ContainerVolumeMountDiskPostOverlay) {
	sort.Slice(ovs, func(i, j int) bool {
		lenI := getMinPathMapKeyLength(ovs[i])
		lenJ := getMinPathMapKeyLength(ovs[j])
		return lenI < lenJ
	})
}

func (d diskPostOverlay) mountPostOverlays(pod volume_mount.IPodInfo, ctrId string, vm *hostapi.ContainerVolumeMount, ovs []*apis.ContainerVolumeMountDiskPostOverlay) error {
	// 根据 PathMap 中最短路径长度排序，路径短的排在前面
	sortPostOverlayByPathMapLength(ovs)
	for _, ov := range ovs {
		log.Debugf("mount container %s post overlay dir: %s", ctrId, jsonutils.Marshal(ov).PrettyString())
		if err := d.getDriver(ov).Mount(d, pod, ctrId, vm, ov); err != nil {
			return errors.Wrapf(err, "mount container %s post overlay dir: %#v", ctrId, ov)
		}
	}
	return nil
}

func (d diskPostOverlay) unmountPostOverlays(pod volume_mount.IPodInfo, ctrId string, vm *hostapi.ContainerVolumeMount, ovs []*apis.ContainerVolumeMountDiskPostOverlay, useLazy bool, clearLayers bool) error {
	//（与 mount 顺序相反）
	sortPostOverlayByPathMapLength(ovs)
	for i := len(ovs) - 1; i >= 0; i-- {
		ov := ovs[i]
		log.Debugf("-- unmount container %s post overlay dir: %s", ctrId, jsonutils.Marshal(ov).PrettyString())
		if err := d.getDriver(ov).Unmount(d, pod, ctrId, vm, ov, useLazy, clearLayers); err != nil {
			return errors.Wrapf(err, "unmount container %s post overlay dir: %#v", ctrId, ov)
		}
	}
	return nil
}

func (d diskPostOverlay) getPostOverlayDirWithPrefix(
	prefixDir string,
	pod volume_mount.IPodInfo, ctrId string,
	vm *hostapi.ContainerVolumeMount,
	ov *apis.ContainerVolumeMountDiskPostOverlay,
	ensure bool,
) (string, error) {
	rootPath, err := d.disk.getPostOverlayRootPrefixDir(prefixDir, pod, vm, ctrId)
	if err != nil {
		return "", errors.Wrap(err, "get post overlay root path")
	}

	workDir := filepath.Join(rootPath, ov.ContainerTargetDir)
	if ov.FlattenLayers {
		workDir = filepath.Join(rootPath, strings.ReplaceAll(ov.ContainerTargetDir, "/", "_"))
	}
	if ensure {
		if err := volume_mount.EnsureDir(workDir); err != nil {
			return "", errors.Wrapf(err, "makeDir %s", workDir)
		}
	}
	return workDir, nil
}

func (d diskPostOverlay) getPostOverlayWorkDir(
	pod volume_mount.IPodInfo, ctrId string,
	vm *hostapi.ContainerVolumeMount,
	ov *apis.ContainerVolumeMountDiskPostOverlay,
	ensure bool,
) (string, error) {
	return d.getPostOverlayDirWithPrefix(POST_OVERLAY_PREFIX_WORK_DIR, pod, ctrId, vm, ov, ensure)
}

func (d diskPostOverlay) getPostOverlayUpperDir(
	pod volume_mount.IPodInfo, ctrId string,
	vm *hostapi.ContainerVolumeMount,
	ov *apis.ContainerVolumeMountDiskPostOverlay,
	ensure bool,
) (string, error) {
	if ov.HostUpperDir != "" {
		return ov.HostUpperDir, nil
	}
	return d.getPostOverlayDirWithPrefix(POST_OVERLAY_PREFIX_UPPER_DIR, pod, ctrId, vm, ov, ensure)
}

func (d diskPostOverlay) getPostOverlayLowerDir(
	pod volume_mount.IPodInfo, ctrId string,
	vm *hostapi.ContainerVolumeMount,
	ov *apis.ContainerVolumeMountDiskPostOverlay,
	ensure bool,
) (string, error) {
	return d.getPostOverlayDirWithPrefix(POST_OVERLAY_PREFIX_LOWER_DIR, pod, ctrId, vm, ov, ensure)
}

func (d diskPostOverlay) getPostOverlayMergedDir(pod volume_mount.IPodInfo, ctrId string, vm *hostapi.ContainerVolumeMount, ov *apis.ContainerVolumeMountDiskPostOverlay, ensure bool) (string, error) {
	return d.getPostOverlayDirWithPrefix(POST_OVERLAY_PREFIX_MERGED_DIR, pod, ctrId, vm, ov, ensure)
}

func (d diskPostOverlay) getPostOverlayMountpoint(pod volume_mount.IPodInfo, ctrId string, vm *hostapi.ContainerVolumeMount, ov *apis.ContainerVolumeMountDiskPostOverlay, ensure bool) (string, error) {
	ctrMountHostPath, err := d.disk.GetRuntimeMountHostPath(pod, ctrId, vm)
	if err != nil {
		return "", errors.Wrap(err, "get runtime mount host_path")
	}
	// remove hostPath sub_directory path
	ctrMountHostPath = strings.TrimSuffix(ctrMountHostPath, vm.Disk.SubDirectory)
	mergedDir := filepath.Join(ctrMountHostPath, ov.ContainerTargetDir)
	if ensure {
		if err := volume_mount.EnsureDir(mergedDir); err != nil {
			return "", errors.Wrap(err, "make merged mountpoint dir")
		}
	}
	return mergedDir, nil
}