Cloudpods/backend/pkg/hostman/storageman/imagecachemanager_base.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 storageman

import (
	"context"
	"sync"

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

	api "yunion.io/x/onecloud/pkg/apis/compute"
)

type IImageCacheMangerFactory interface {
	NewImageCacheManager(manager *SStorageManager, cachePath string, storage IStorage, storagecacheId string) IImageCacheManger
	StorageType() string
}

var (
	imageCacheManagerFactories = make(map[string]IImageCacheMangerFactory)
)

func registerimageCacheManagerFactory(factory IImageCacheMangerFactory) {
	imageCacheManagerFactories[factory.StorageType()] = factory
}

func NewImageCacheManager(manager *SStorageManager, cachePath string, storage IStorage, storagecacheId string, storageType string) IImageCacheManger {
	if factory, ok := imageCacheManagerFactories[storageType]; ok {
		return factory.NewImageCacheManager(manager, cachePath, storage, storagecacheId)
	}
	log.Errorf("no image cache manager driver for %s found", storageType)
	return nil
}

type IImageCacheManger interface {
	GetId() string
	GetPath() string
	SetStoragecacheId(string)
	Lvmlockd() bool

	IsLocal() bool
	GetStorageType() string

	// for diskhandler
	PrefetchImageCache(ctx context.Context, data interface{}) (jsonutils.JSONObject, error)
	DeleteImageCache(ctx context.Context, data interface{}) (jsonutils.JSONObject, error)

	RemoveImage(ctx context.Context, imageId string) error

	AcquireImage(ctx context.Context, input api.CacheImageInput, callback func(progress, progressMbps float64, totalSizeMb int64)) (IImageCache, error)
	ReleaseImage(ctx context.Context, imageId string)
	LoadImageCache(imageId string)

	CleanImageCachefiles(ctx context.Context)
}

// IImageCacheManagerGetter is used to get image cache from image cache manager
type IImageCacheManagerGetter interface {
	IImageCacheManger
	// Try to use AcquireImage first, only using GetImage for readonly operations
	GetImage(imageId string) IImageCache
}

type SBaseImageCacheManager struct {
	storageManager  IStorageManager
	storagecacaheId string
	cachePath       string
	cachedImages    *sync.Map // map[string]IImageCache
}

func (c *SBaseImageCacheManager) GetPath() string {
	return c.cachePath
}

func (c *SBaseImageCacheManager) GetId() string {
	return c.storagecacaheId
}

func (c *SBaseImageCacheManager) SetStoragecacheId(scid string) {
	c.storagecacaheId = scid
}

func (c *SBaseImageCacheManager) GetStorageManager() IStorageManager {
	return c.storageManager
}

func (c *SBaseImageCacheManager) Lvmlockd() bool {
	return false
}