Skip to main content

Module capability

Module capability 

Source
Expand description

What a handle may be able to do, one small trait per capability.

A handle exposes each of these through an Option<&dyn Cap> accessor (VmHandle::vsock, VmHandle::checkpoint, …). None is the answer for “this driver cannot” and for “this VM was not built with the device”; a method on one of these traits never returns an “unsupported” error as its normal answer. crate::DriverCapabilities says which accessors a driver’s handles can ever return Some for.

Structs§

BalloonStats
The balloon’s target and, when the guest reports it, its actual size.
CheckpointFormat
A checkpoint’s on-disk format, e.g. firecracker/v1.
CheckpointImage
A checkpoint on disk: where it is and who can read it.
CheckpointOptions
How to take a checkpoint.

Enums§

AfterCheckpoint
What the guest does once a checkpoint is captured.
CheckpointKind
Full or incremental capture.
DiskSource
What a disk being staged is — which decides what the VM gets, and what happens to the caller’s own copy.

Traits§

Adopt
Find a VM that outlived the process which booted it — or clear away what it left when it did not.
Balloon
The guest memory balloon.
Checkpoint
Capture the VM’s state to disk.
Console
The guest console’s output.
DebugSnapshot
A point-in-time view of the VM’s internals for diagnostics.
Detach
Give up ownership of a running VM without stopping it.
Prepare
Spawn the VMM before there is a guest to boot.
PreparedVm
A spawned VMM waiting for a spec.
Staging
Bring the files a VM boots from into the private area its VMM can reach.
Vsock
Dial a vsock port inside the guest.
VsockListen
Accept vsock connections the guest initiates (the READY dial-out).
VsockListener
A bound vsock listener; one guest connection per accept.