hypervisor

package

Go to main page

Versions in this module

v0

v0.2.0

Jul 8, 2026

Changes in this version

type Capabilities

+ UsesDetachableSnapshotMemoryPager bool

v0.1.1

Jun 12, 2026

Changes in this version

type VMConfig

+ EnableRosetta bool

v0.1.0

Jun 4, 2026

Changes in this version

+ func FinishTraceSpan(span trace.Span, err error)

+ func LockSnapshotSourceAliasMutation() func()

+ func LockSnapshotSourceAliasReaders() func()

+ func RegisterCapabilities(t Type, caps Capabilities)

+ func ResolveProcessPID(socketPath string) (int, error)

+ func ShouldTraceHypervisorHTTPSpan(method, path string) bool

+ func SocketCacheKey(socketPath string) string

+ func StartDetachedTraceSpan(ctx context.Context, tracer trace.Tracer, name string, ...) (context.Context, trace.Span)

+ func StartImplementationSpan(ctx context.Context, hvType Type, name string, attrs ...attribute.KeyValue) (context.Context, trace.Span)

+ func StartProcessSpan(ctx context.Context, hvType Type) (context.Context, trace.Span)

+ func TraceAttributesFromContext(ctx context.Context) []attribute.KeyValue

+ func WithTraceAttributes(ctx context.Context, attrs ...attribute.KeyValue) context.Context

+ type BalloonTargetCache struct

+ func (c *BalloonTargetCache) Delete(socketPath string)

+ func (c *BalloonTargetCache) Load(socketPath string) (int64, bool)

+ func (c *BalloonTargetCache) Store(socketPath string, bytes int64)

type Capabilities

+ SupportsBalloonControl bool

+ SupportsConcurrentForkPrepare bool

+ SupportsDiskResize bool

+ SupportsGracefulVMMShutdown bool

+ SupportsSnapshotBaseReuse bool

+ func CapabilitiesForType(t Type) (Capabilities, bool)

type ForkPrepareResult

+ RequiresSnapshotSourceAlias bool

+ type GuestMemoryConfig struct

+ DeflateOnOOM bool

+ EnableBalloon bool

+ FreePageHinting bool

+ FreePageReporting bool

+ RequireBalloon bool

type Hypervisor

+ func WrapHypervisor(hvType Type, hv Hypervisor) Hypervisor

+ GetTargetGuestMemoryBytes func(ctx context.Context) (int64, error)

+ SetTargetGuestMemoryBytes func(ctx context.Context, bytes int64) error

+ type RestoreOptions struct

+ SnapshotMemoryBackend SnapshotMemoryBackend

+ SnapshotMemoryBackingPath string

+ SnapshotMemoryCacheKey string

+ SnapshotMemorySessionID string

+ type SnapshotMemoryBackend string

+ const SnapshotMemoryBackendFile

+ const SnapshotMemoryBackendUFFD

+ type SnapshotOptions struct

+ DeferredMemoryBackingPath string

type VMConfig

+ GuestMemory GuestMemoryConfig

type VMStarter

+ func WrapVMStarter(hvType Type, starter VMStarter) VMStarter

v0.0.7

Mar 3, 2026

Changes in this version

+ func RegisterVsockSocketName(t Type, name string)

+ func VsockSocketNameForType(t Type) string

+ type ForkNetworkConfig struct

+ IP string

+ MAC string

+ Netmask string

+ TAPDevice string

+ type ForkPrepareRequest struct

+ Network *ForkNetworkConfig

+ SerialLogPath string

+ SnapshotConfigPath string

+ SourceDataDir string

+ TargetDataDir string

+ VsockCID int64

+ VsockSocket string

+ type ForkPrepareResult struct

+ VsockCIDUpdated bool

type NetworkConfig

+ DownloadBps int64

+ UploadBps int64

type Type

+ const TypeFirecracker

type VMStarter

+ PrepareFork func(ctx context.Context, req ForkPrepareRequest) (ForkPrepareResult, error)

v0.0.6

Feb 16, 2026

Changes in this version

+ var ErrHypervisorNotRunning = errors.New("hypervisor is not running")

+ var ErrNotSupported = errors.New("operation not supported by this hypervisor")

+ func RegisterClientFactory(t Type, factory ClientFactory)

+ type ClientFactory func(socketPath string) (Hypervisor, error)

type Hypervisor

+ func NewClient(hvType Type, socketPath string) (Hypervisor, error)

type Type

+ const TypeVZ

v0.0.5

Jan 16, 2026

v0.0.4

Jan 12, 2026

Changes in this version

+ func RegisterSocketName(t Type, name string)

+ func RegisterVsockDialerFactory(t Type, factory VsockDialerFactory)

+ func SocketNameForType(t Type) string

+ type CPUTopology struct

+ CoresPerDie int

+ DiesPerPackage int

+ Packages int

+ ThreadsPerCore int

+ type Capabilities struct

+ SupportsDiskIOLimit bool

+ SupportsGPUPassthrough bool

+ SupportsHotplugMemory bool

+ SupportsPause bool

+ SupportsSnapshot bool

+ SupportsVsock bool

+ type DiskConfig struct

+ IOBps int64

+ IOBurstBps int64

+ Path string

+ Readonly bool

+ type Hypervisor interface

+ Capabilities func() Capabilities

+ DeleteVM func(ctx context.Context) error

+ GetVMInfo func(ctx context.Context) (*VMInfo, error)

+ Pause func(ctx context.Context) error

+ ResizeMemory func(ctx context.Context, bytes int64) error

+ ResizeMemoryAndWait func(ctx context.Context, bytes int64, timeout time.Duration) error

+ Resume func(ctx context.Context) error

+ Shutdown func(ctx context.Context) error

+ Snapshot func(ctx context.Context, destPath string) error

+ type NetworkConfig struct

+ IP string

+ MAC string

+ Netmask string

+ TAPDevice string

+ type Type string

+ const TypeCloudHypervisor

+ const TypeQEMU

+ type VMConfig struct

+ Disks []DiskConfig

+ HotplugBytes int64

+ InitrdPath string

+ KernelArgs string

+ KernelPath string

+ MemoryBytes int64

+ Networks []NetworkConfig

+ PCIDevices []string

+ SerialLogPath string

+ Topology *CPUTopology

+ VCPUs int

+ VsockCID int64

+ VsockSocket string

+ type VMInfo struct

+ MemoryActualSize *int64

+ State VMState

+ type VMStarter interface

+ GetBinaryPath func(p *paths.Paths, version string) (string, error)

+ GetVersion func(p *paths.Paths) (string, error)

+ RestoreVM func(ctx context.Context, p *paths.Paths, version string, socketPath string, ...) (pid int, hv Hypervisor, err error)

+ SocketName func() string

+ StartVM func(ctx context.Context, p *paths.Paths, version string, socketPath string, ...) (pid int, hv Hypervisor, err error)

+ type VMState string

+ const StateCreated

+ const StatePaused

+ const StateRunning

+ const StateShutdown

+ type VsockDialer interface

+ DialVsock func(ctx context.Context, port int) (net.Conn, error)

+ Key func() string

+ func NewVsockDialer(hvType Type, vsockSocket string, vsockCID int64) (VsockDialer, error)

+ type VsockDialerFactory func(vsockSocket string, vsockCID int64) VsockDialer

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL