mirror of
https://github.com/aljazceru/kata-containers.git
synced 2025-12-30 20:44:26 +01:00
768db1bdc4
Update persist FS API and interface to support rootless and mock filesystem implementations. `RunStoragePath` and `RunVMStoragePath` are part of FS object and may change their path depending on the driver (rootless/mock/fs) Signed-off-by: Julio Montes <julio.montes@intel.com>
37 lines
1.5 KiB
Go
37 lines
1.5 KiB
Go
// Copyright (c) 2019 Huawei Corporation
|
|
//
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
//
|
|
|
|
package persistapi
|
|
|
|
// PersistDriver is interface describing operations to save/restore persist data
|
|
type PersistDriver interface {
|
|
// ToDisk flushes data to disk(or other storage media such as a remote db)
|
|
ToDisk(SandboxState, map[string]ContainerState) error
|
|
// FromDisk will restore all data for sandbox with `sid` from storage.
|
|
// We only support get data for one whole sandbox
|
|
FromDisk(sid string) (SandboxState, map[string]ContainerState, error)
|
|
// Destroy will remove everything from storage
|
|
Destroy(sid string) error
|
|
// Lock locks the persist driver, "exclusive" decides whether the lock is exclusive or shared.
|
|
// It returns Unlock Function and errors
|
|
Lock(sid string, exclusive bool) (func() error, error)
|
|
|
|
// GlobalWrite writes "data" to "StorageRootPath"/"relativePath";
|
|
// GlobalRead reads "data" from "StorageRootPath"/"relativePath";
|
|
// these functions are used for writing/reading some global data,
|
|
// they are specially designed for ACRN so far.
|
|
// Don't use them too much unless you have no other choice! @weizhang555
|
|
GlobalWrite(relativePath string, data []byte) error
|
|
GlobalRead(relativePath string) ([]byte, error)
|
|
|
|
// RunStoragePath is the sandbox runtime directory.
|
|
// It will contain one state.json and one lock file for each created sandbox.
|
|
RunStoragePath() string
|
|
|
|
// RunVMStoragePath is the vm directory.
|
|
// It will contain all guest vm sockets and shared mountpoints.
|
|
RunVMStoragePath() string
|
|
}
|