hypervisor

May 20, 2026

Changes in this version

+ func BuildBaseCmdline(prefix, layers, cow string, networkConfigs []*types.NetworkConfig, ...) string

+ type AfterExtractFn func(ctx context.Context, vmID string, vmCfg *types.VMConfig, net types.NetSetup, ...) (*types.VM, error)

type Backend

+ Metering metering.Recorder

+ func NewBackend(typ string, conf BackendConfig, rec metering.Recorder) (*Backend, error)

+ func (b *Backend) IsAPISocketLive(ctx context.Context, rec *VMRecord) (bool, error)

+ func (b *Backend) ResolveAndLoad(ctx context.Context, ref string) (string, VMRecord, error)

+ func (b *Backend) StartSequence(ctx context.Context, id string, spec StartSpec) (bool, error)

+ func (b *Backend) StopOneSequence(ctx context.Context, id string, spec StopSpec) error

type BackendConfig

+ EnsureDirs func() error

+ IndexLock func() string

type DirectRestoreSpec

+ SourceSnapshotID string

type RestoreSpec

+ SourceSnapshotID string

+ type StartSpec struct

+ Launch func(ctx context.Context, rec *VMRecord, sockPath string) (int, error)

+ PostLaunch func(ctx context.Context, rec *VMRecord, sockPath string, pid int) error

+ RuntimeFiles []string

+ type StopSpec struct

+ RuntimeFiles []string

+ Shutdown func(ctx context.Context, rec *VMRecord, sockPath string, pid int) error

May 13, 2026

Changes in this version

type Backend

+ func (b *Backend) LogFilePath(logDir string) string

+ func (b *Backend) LogPath(ctx context.Context, ref string) (string, error)

type CreateSpec

+ Net types.NetSetup

type Hypervisor

+ LogPath func(ctx context.Context, ref string) (string, error)

May 5, 2026

Changes in this version

+ const SnapshotMetaFile

+ const VsockAgentPort

+ const VsockGuestCID

+ const VsockSockName

+ func BalloonSize(memoryBytes int64, windows bool) (int64, bool)

+ func CloneStorageConfigs(storageConfigs []*types.StorageConfig) []*types.StorageConfig

+ func IsUnderDir(path, dir string) bool

+ func PopulateFromSrc(runDir, srcDir string, clean func(string) error, ...) error

+ func PreflightRestore(srcDir, rootDir, runDir string, rec *VMRecord, ...) error

+ func ReverseLayers[T any](storageConfigs []*types.StorageConfig, ...) []T

+ func SaveSnapshotMeta(dir string, meta *SnapshotMeta) error

+ func ValidateMetaPaths(meta *SnapshotMeta, rootDir, runDir string) error

+ func VsockSockPath(runDir string) string

type Backend

+ func (b *Backend) CreateSequence(ctx context.Context, id string, spec CreateSpec) (_ *types.VM, err error)

+ func (b *Backend) DeleteAll(ctx context.Context, refs []string, force bool, ...) ([]string, error)

+ func (b *Backend) DirectRestoreSequence(ctx context.Context, vmRef string, spec DirectRestoreSpec) (*types.VM, error)

+ func (b *Backend) LaunchVMProcess(ctx context.Context, spec LaunchSpec) (pid int, err error)

+ func (b *Backend) RestoreSequence(ctx context.Context, vmRef string, spec RestoreSpec) (*types.VM, error)

+ func (b *Backend) SnapshotSequence(ctx context.Context, ref string, spec SnapshotSpec) (_ *types.SnapshotConfig, _ io.ReadCloser, err error)

+ func (b *Backend) StartAll(ctx context.Context, refs []string, ...) ([]string, error)

+ func (b *Backend) StopAll(ctx context.Context, refs []string, ...) ([]string, error)

+ func (b *Backend) WithPausedVM(ctx context.Context, rec *VMRecord, pause, resume, fn func() error) error

type BackendConfig

+ SocketWaitTimeout func() time.Duration

+ type CreateSpec struct

+ BootConfig *types.BootConfig

+ NetworkConfigs []*types.NetworkConfig

+ Prepare func(ctx context.Context, vmID string, vmCfg *types.VMConfig, ...) ([]*types.StorageConfig, error)

+ StorageConfigs []*types.StorageConfig

+ VMCfg *types.VMConfig

+ type DirectRestoreSpec struct

+ AfterExtract func(ctx context.Context, vmID string, vmCfg *types.VMConfig, rec *VMRecord) (*types.VM, error)

+ Kill func(ctx context.Context, vmID string, rec *VMRecord) error

+ OverrideCheck func(rec *VMRecord, vmCfg *types.VMConfig) error

+ Populate func(rec *VMRecord, srcDir string) error

+ Preflight func(srcDir string, rec *VMRecord) error

+ SrcDir string

+ VMCfg *types.VMConfig

+ Wrap func(rec *VMRecord, fn func() error) error

+ type LaunchSpec struct

+ Cmd *exec.Cmd

+ NetnsPath string

+ OnFail func()

+ PIDPath string

+ SockPath string

+ type RestoreSpec struct

+ AfterExtract func(ctx context.Context, vmID string, vmCfg *types.VMConfig, rec *VMRecord) (*types.VM, error)

+ BeforeMerge func(rec *VMRecord) error

+ Kill func(ctx context.Context, vmID string, rec *VMRecord) error

+ OverrideCheck func(rec *VMRecord, vmCfg *types.VMConfig) error

+ Preflight func(stagingDir string, rec *VMRecord) error

+ Snapshot io.Reader

+ VMCfg *types.VMConfig

+ Wrap func(rec *VMRecord, fn func() error) error

+ type SnapshotMeta struct

+ BootConfig *types.BootConfig

+ CPU int

+ Memory int64

+ StorageConfigs []*types.StorageConfig

+ func LoadAndValidateMeta(dir, rootDir, runDir string) (*SnapshotMeta, error)

+ func LoadSnapshotMeta(dir string) (*SnapshotMeta, error)

+ type SnapshotSpec struct

+ AfterCapture func(rec *VMRecord, tmpDir string) error

+ BuildMeta func(rec *VMRecord, tmpDir string) (*SnapshotMeta, error)

+ Capture func(rec *VMRecord, hc *http.Client, tmpDir string) error

+ Pause func(rec *VMRecord, hc *http.Client) error

+ Resume func(rec *VMRecord, hc *http.Client) error

+ Wrap func(rec *VMRecord, fn func() error) error

type VMIndex

+ func (idx *VMIndex) GetRecord(vmID string) (*VMRecord, error)

Apr 27, 2026

Changes in this version

+ const MinDataDiskSize

+ func DataDiskBaseName(serial string) string

+ func IsDataDiskFile(name string) bool

+ func PrepareDataDisks(ctx context.Context, baseDir string, specs []types.DataDiskSpec) ([]*types.StorageConfig, error)

+ func ReflinkDataDisks(dstDir string, configs []*types.StorageConfig) error

+ func ValidateRoleSequence(sidecar, rec []*types.StorageConfig) error

+ func ValidateSnapshotIntegrity(srcDir string, sidecar []*types.StorageConfig) error

type BaseConfig

+ func (c *BaseConfig) DataDiskPath(vmID, name string) string

Apr 23, 2026

Changes in this version

+ const DefaultBalloonDiv

+ const GracefulStopPollInterval

+ const MinBalloonMemory

+ func CleanSnapshotFiles(runDir string, match func(name string) bool) error

+ func CloneSnapshotFiles(dstDir, srcDir string, classify func(name string) SnapshotFileKind) error

+ func ExpandRawImage(path string, targetSize int64) error

+ func InitCOWFilesystem(ctx context.Context, path string) error

+ func PrepareOCICOW(ctx context.Context, cowPath string, storage int64, ...) ([]*types.StorageConfig, error)

+ func PrepareStagingDir(runDir string, snapshot io.Reader) (stagingDir string, cleanup func(), err error)

type Backend

+ func (b *Backend) BuildGCModule() gc.Module[VMGCSnapshot]

+ func (b *Backend) BuildSnapshotConfig(snapID string, rec *VMRecord) *types.SnapshotConfig

+ func (b *Backend) CloneFromStream(ctx context.Context, vmID string, vmCfg *types.VMConfig, ...) (_ *types.VM, err error)

+ func (b *Backend) DirectCloneBase(ctx context.Context, vmID string, vmCfg *types.VMConfig, ...) (_ *types.VM, err error)

+ func (b *Backend) FinalizeClone(ctx context.Context, vmID string, info *types.VM, bootCfg *types.BootConfig, ...) error

+ func (b *Backend) FinalizeCreate(ctx context.Context, id string, info *types.VM, bootCfg *types.BootConfig, ...) error

+ func (b *Backend) FinalizeRestore(ctx context.Context, vmID string, vmCfg *types.VMConfig, rec *VMRecord, ...) (*types.VM, error)

+ func (b *Backend) GracefulStop(ctx context.Context, vmID string, pid int, timeout time.Duration, ...) error

+ func (b *Backend) HandleStopResult(ctx context.Context, id, runDir string, runtimeFiles []string, ...) error

+ func (b *Backend) KillForRestore(ctx context.Context, vmID string, rec *VMRecord, terminate func(pid int) error, ...) error

+ func (b *Backend) PrepareStart(ctx context.Context, id string, runtimeFiles []string) (*VMRecord, error)

+ func (b *Backend) RecordSnapshot(ctx context.Context, vmID, tmpDir string) (snapID string, err error)

+ func (b *Backend) RegisterGC(orch *gc.Orchestrator)

+ func (b *Backend) ResolveForRestore(ctx context.Context, vmRef string) (string, *VMRecord, error)

+ func (b *Backend) WatchPath() string

type BackendConfig

+ IndexFile func() string

+ LogDir func() string

+ RunDir func() string

+ type SnapshotFileKind int

+ const SnapshotFileCOW

+ const SnapshotFileMemory

+ const SnapshotFileMeta

+ const SnapshotFileSkip

+ type VMGCSnapshot struct

+ func (s VMGCSnapshot) ActiveVMIDs() map[string]struct{}

+ func (s VMGCSnapshot) UsedBlobIDs() map[string]struct{}

Apr 13, 2026

Changes in this version

+ const VMMemTransferTimeout

+ var ErrAmbiguous = errors.New("VM ref resolves to multiple backends")

+ func MergeDirInto(src, dst string) error

+ func ValidateHostCPU(cpu int) error

type Backend

+ func (b *Backend) CloneSetup(ctx context.Context, vmID string, vmCfg *types.VMConfig, ...) (runDir, logDir string, now time.Time, cleanup func(), err error)

+ type BaseConfig struct

+ func NewBaseConfig(conf *config.Config, name string) BaseConfig

+ func (c *BaseConfig) EnsureDirs() error

+ func (c *BaseConfig) IndexFile() string

+ func (c *BaseConfig) IndexLock() string

+ func (c *BaseConfig) LogDir() string

+ func (c *BaseConfig) RunDir() string

+ func (c *BaseConfig) SocketWaitTimeout() time.Duration

+ func (c *BaseConfig) TerminateGracePeriod() time.Duration

+ func (c *BaseConfig) VMLogDir(vmID string) string

+ func (c *BaseConfig) VMRunDir(vmID string) string

Apr 8, 2026

Changes in this version

+ const APISocketName

+ const ConsoleSockName

+ const CowSerial

+ const CreatingStateGCGrace

+ func BlobHexFromPath(path string) string

+ func BuildIPParams(networkConfigs []*types.NetworkConfig, vmName string, dnsServers []string) string

+ func CleanupRuntimeFiles(ctx context.Context, runDir string, files []string)

+ func ConsoleSockPath(runDir string) string

+ func CopyFile(dst, src string) (err error)

+ func EnterNetns(nsPath string) (restore func(), err error)

+ func ExtractBlobIDs(storageConfigs []*types.StorageConfig, boot *types.BootConfig) map[string]struct

+ func PrefixToNetmask(prefix int) string

+ func RemoveVMDirs(runDir, logDir string) error

+ func SocketPath(runDir string) string

+ func VerifyBaseFiles(storageConfigs []*types.StorageConfig, boot *types.BootConfig) error

+ func WaitForSocket(ctx context.Context, socketPath string, pid int, timeout time.Duration, ...) error

+ type Backend struct

+ Conf BackendConfig

+ DB storage.Store[VMIndex]

+ Locker lock.Locker

+ Typ string

+ func (b *Backend) AbortLaunch(ctx context.Context, pid int, sockPath, runDir string, runtimeFiles []string)

+ func (b *Backend) BatchMarkStarted(ctx context.Context, ids []string) error

+ func (b *Backend) CleanStalePlaceholders(_ context.Context, ids []string) error

+ func (b *Backend) ForEachVM(ctx context.Context, ids []string, op string, ...) ([]string, error)

+ func (b *Backend) GCCollect(ctx context.Context, ids []string) error

+ func (b *Backend) Inspect(ctx context.Context, ref string) (*types.VM, error)

+ func (b *Backend) List(ctx context.Context) ([]*types.VM, error)

+ func (b *Backend) LoadRecord(ctx context.Context, id string) (VMRecord, error)

+ func (b *Backend) MarkError(ctx context.Context, id string)

+ func (b *Backend) PIDFilePath(runDir string) string

+ func (b *Backend) ReserveVM(ctx context.Context, id string, vmCfg *types.VMConfig, ...) error

+ func (b *Backend) ResolveRef(ctx context.Context, ref string) (string, error)

+ func (b *Backend) ResolveRefs(ctx context.Context, refs []string) ([]string, error)

+ func (b *Backend) RollbackCreate(ctx context.Context, id, name string)

+ func (b *Backend) ToVM(rec *VMRecord) *types.VM

+ func (b *Backend) Type() string

+ func (b *Backend) UpdateStates(ctx context.Context, ids []string, state types.VMState) error

+ func (b *Backend) WithRunningVM(ctx context.Context, rec *VMRecord, fn func(pid int) error) error

+ type BackendConfig interface

+ BinaryName func() string

+ EffectivePoolSize func() int

+ PIDFileName func() string

+ TerminateGracePeriod func() time.Duration

+ VMLogDir func(id string) string

+ VMRunDir func(id string) string

Apr 2, 2026

Changes in this version

+ type Watchable interface

+ WatchPath func() string

Apr 1, 2026

Changes in this version

+ var ErrNotFound = errors.New("VM not found")

+ var ErrNotRunning = errors.New("VM not running")

+ type Direct interface

+ DirectClone func(ctx context.Context, vmID string, vmCfg *types.VMConfig, ...) (*types.VM, error)

+ DirectRestore func(ctx context.Context, vmRef string, vmCfg *types.VMConfig, srcDir string) (*types.VM, error)

+ type Hypervisor interface

+ Clone func(ctx context.Context, vmID string, vmCfg *types.VMConfig, ...) (*types.VM, error)

+ Console func(ctx context.Context, ref string) (io.ReadWriteCloser, error)

+ Create func(ctx context.Context, vmID string, vmCfg *types.VMConfig, ...) (*types.VM, error)

+ Delete func(ctx context.Context, refs []string, force bool) ([]string, error)

+ Inspect func(ctx context.Context, ref string) (*types.VM, error)

+ List func(context.Context) ([]*types.VM, error)

+ RegisterGC func(*gc.Orchestrator)

+ Restore func(ctx context.Context, vmRef string, vmCfg *types.VMConfig, snapshot io.Reader) (*types.VM, error)

+ Snapshot func(ctx context.Context, ref string) (*types.SnapshotConfig, io.ReadCloser, error)

+ Start func(ctx context.Context, refs []string) ([]string, error)

+ Stop func(ctx context.Context, refs []string) ([]string, error)

+ Type func() string

+ type VMIndex struct

+ Names map[string]string

+ VMs map[string]*VMRecord

+ func (idx *VMIndex) Init()

+ func (idx *VMIndex) Resolve(ref string) (string, error)

+ func (idx *VMIndex) ResolveMany(refs []string) ([]string, error)

+ type VMRecord struct

+ BootConfig *types.BootConfig

+ ImageBlobIDs map[string]struct{}

+ LogDir string

+ RunDir string