instance

type Cmd interface {
	Wait() (int, error)
	PID() int
	Signal(s unix.Signal) error
	WindowResize(fd, winchWidth, winchHeight int) error
}

type ConfigReader interface {
	Project() api.Project
	Type() instancetype.Type
	Architecture() int
	ID() int

	ExpandedConfig() map[string]string
	ExpandedDevices() deviceConfig.Devices
	LocalConfig() map[string]string
	LocalDevices() deviceConfig.Devices
}

type Container interface {
	Instance

	CurrentIdmap() (*idmap.IdmapSet, error)
	DiskIdmap() (*idmap.IdmapSet, error)
	NextIdmap() (*idmap.IdmapSet, error)
	ConsoleLog(ctx context.Context, opts liblxc.ConsoleLogOptions) (string, error)
	InsertSeccompUnixDevice(prefix string, m deviceConfig.Device, pid int) error
	DevptsFd() (*os.File, error)
	FileSFTPNoLock() (*sftp.Client, error)
	IdmappedStorage(path string, fstype string) idmap.IdmapStorageType
	StopForkFile(force bool)
	MoveMount(source string, target string, fstype string, flags int, idmapType idmap.IdmapStorageType) error
	RemoveMount(mount string) error
}

type ConversionArgs struct {
	FilesystemConn func(ctx context.Context) (io.ReadWriteCloser, error)
	Disconnect     func()
}

type ConversionReceiveArgs struct {
	ConversionArgs
	SourceDiskSize    int64 // Size of the disk in bytes.
	ConversionOptions []string
}

type CriuMigrationArgs struct {
	Cmd          uint
	StateDir     string
	Function     string
	Stop         bool
	ActionScript bool
	DumpDir      string
	PreDumpDir   string
	Features     liblxc.CriuFeatures
	Op           *operationlock.InstanceOperation
}

type Info struct {
	Name     string            // Name of an instance driver, e.g. "lxc"
	Version  string            // Version number of a loaded instance driver
	Error    error             // Whether there is an operational impediment.
	Type     instancetype.Type // Instance type that the driver provides support for.
	Features map[string]any    // Map of supported features.
}

type Instance interface {
	ConfigReader

	// Instance actions.
	Freeze(ctx context.Context) error
	Shutdown(ctx context.Context, timeout time.Duration) error
	Start(ctx context.Context, stateful bool, progressReporter ioprogress.ProgressReporter) error
	Stop(ctx context.Context, stateful bool) error
	Restart(ctx context.Context, timeout time.Duration, progressReporter ioprogress.ProgressReporter) error
	Rebuild(ctx context.Context, img *api.Image, op *operations.Operation) error
	Unfreeze(ctx context.Context) error
	RegisterDevices()

	Info() Info
	IsPrivileged() bool

	// Snapshots & migration & backups.
	Restore(ctx context.Context, source Instance, stateful bool, diskVolumesMode string, progressReporter ioprogress.ProgressReporter) error
	Snapshot(ctx context.Context, name string, expiry *time.Time, stateful bool, diskVolumesMode string, bitmap bool, progressReporter ioprogress.ProgressReporter) error
	Snapshots() ([]Instance, error)
	Backups() ([]backup.InstanceBackup, error)
	UpdateBackupFile() error

	// Config handling.
	Rename(ctx context.Context, newName string, applyTemplateTrigger bool) error
	Update(ctx context.Context, newConfig db.InstanceArgs, actionType UpdateAction) error

	Delete(ctx context.Context, force bool, diskVolumesMode string, progressReporter ioprogress.ProgressReporter) error
	Export(w io.Writer, properties map[string]string, expiration time.Time, tracker *ioprogress.ProgressTracker) (api.ImageMetadata, error)

	// Live configuration.
	CGroup() (*cgroup.CGroup, error)
	VolatileSet(changes map[string]string) error
	SetAffinity(set []string) error

	// File handling.
	FileSFTPConn() (net.Conn, error)
	FileSFTP() (*sftp.Client, error)

	// Console - Allocate and run a console tty or a spice Unix socket.
	Console(ctx context.Context, protocol string) (*os.File, chan error, error)
	Exec(ctx context.Context, req api.InstanceExecPost, stdin *os.File, stdout *os.File, stderr *os.File) (Cmd, error)

	// Status
	Render(options ...func(response any) error) (any, any, error)
	RenderFull(hostInterfaces []net.Interface, opts ...StateRenderOptions) (*api.InstanceFull, any, error)
	RenderState(hostInterfaces []net.Interface, opts ...StateRenderOptions) (*api.InstanceState, error)
	IsRunning() bool
	IsFrozen() bool
	IsEphemeral() bool
	IsSnapshot() bool
	IsStateful() bool
	LockExclusive() (*operationlock.InstanceOperation, error)

	// Hooks.
	DeviceEventHandler(*deviceConfig.RunConfig) error
	OnHook(hookName string, args map[string]string) error

	// Properties.
	Location() string
	Name() string
	CloudInitID() string
	Description() string
	CreationDate() time.Time
	LastUsedDate() time.Time

	Profiles() []api.Profile
	InitPID() int
	State() string
	ExpiryDate() time.Time
	FillNetworkDevice(name string, m deviceConfig.Device) (deviceConfig.Device, error)

	// Paths.
	Path() string
	OpenExecOutput() (*os.Root, error)
	OpenRootfs() (*os.Root, error)
	OpenTemplates() (*os.Root, error)
	OpenRoot() (*os.Root, error)
	StatePath() string
	LogFilePath() string
	ConsoleBufferLogPath() string
	LogPath() string
	DevicesPath() string

	// Storage.
	StoragePool() (string, error)

	// Migration.
	CanMigrate() (bool, bool)
	MigrateSend(ctx context.Context, args MigrateSendArgs, progressReporter ioprogress.ProgressReporter) error
	MigrateReceive(ctx context.Context, args MigrateReceiveArgs, progressReporter ioprogress.ProgressReporter) error

	// Conversion.
	ConversionReceive(args ConversionReceiveArgs, progressReporter ioprogress.ProgressReporter) error

	DeferTemplateApply(trigger TemplateTrigger) error

	Metrics(hostInterfaces []net.Interface) (*metrics.MetricSet, error)

	// OnDaemonStart finishes what the previous LXD process left undone on the instance, before
	// the daemon decides whether to start it.
	OnDaemonStart(ctx context.Context) error

	// Dirty bitmaps of the block volumes of a virtual machine.
	// Bitmaps lists them, grouped by name, for an instance or an instance snapshot.
	// DeleteBitmap removes one bitmap from every volume, DeleteDiskBitmap one bitmap from the
	// volume attached through a disk device, and DeleteVolumeBitmaps every bitmap of that volume
	// together with its volume metadata image.
	Bitmaps() ([]api.InstanceBitmap, error)
	DeleteBitmap(bitmapName string) error
	DeleteDiskBitmap(deviceName string, bitmapName string) error
	DeleteVolumeBitmaps(deviceName string) error

	// Metadata images, the qcow2 images on the config volume that store the bitmaps of the block volumes.
	// RemoveVolumeMetadataImage deletes the image and the overlay of the volume of the given UUID,
	// and RemoveAllMetadataImages deletes every image, overlay and snapshot bitmap file.
	// CommitDiskOverlays commits the overlays of the given disk devices into their volumes.
	RemoveVolumeMetadataImage(volumeUUID string) error
	RemoveAllMetadataImages() error
	CommitDiskOverlays(deviceNames []string) error

	// Snapshot with a bitmap.
	// CreateSnapshotBitmaps creates the bitmap of a snapshot on the volumes attached through the
	// given disk devices, writes their volume metadata images and the snapshot bitmap file, and
	// adds an overlay to each volume.
	// It returns the devices that got one, which CommitDiskOverlays commits after the storage snapshots.
	// RemoveSnapshotBitmapFile deletes the snapshot bitmap file of the instance snapshot of the given
	// UUID from the config volume.
	CreateSnapshotBitmaps(snapshotUUID string, deviceNames []string, bitmapName string) ([]string, error)
	RemoveSnapshotBitmapFile(snapshotUUID string) error

	// SnapshotMetadataImages returns the snapshot metadata images of the volume snapshots of an
	// instance snapshot, keyed by the disk device each volume was attached through.
	// The images are on the config volume snapshot.
	SnapshotMetadataImages() (map[string]SnapshotMetadataImage, error)
}

type MigrateArgs struct {
	ControlSend           func(m proto.Message) error
	ControlReceive        func(m proto.Message) error
	StateConn             func(ctx context.Context) (io.ReadWriteCloser, error)
	FilesystemConn        func(ctx context.Context) (io.ReadWriteCloser, error)
	Snapshots             bool
	Live                  bool
	Disconnect            func()
	ClusterMoveSourceName string // Will be empty if not a cluster move, otherwise indicates the source instance.
}

type MigrateReceiveArgs struct {
	MigrateArgs

	InstanceOperation *operationlock.InstanceOperation
	Refresh           bool

	// AttachedVolumes holds "pool/name" for every custom volume the instance's devices refer to. A
	// migration only ever creates or refreshes volumes from this set.
	AttachedVolumes map[string]struct{}

	// DeferredVolumes holds "pool/name" for the attached custom volumes whose device was masked because
	// the volume is missing on the target. The source's index header must list each of them.
	DeferredVolumes map[string]struct{}

	// BeforeTransferStart is called once, right before the data transfer starts, when nothing has been
	// written to the instance's disks yet. Returning an error aborts the receive. Optional.
	BeforeTransferStart func() error
}

type MigrateSendArgs struct {
	MigrateArgs

	AllowInconsistent bool

	// DiskVolumesMode selects which disk volumes travel with the instance. Only all-exclusive sends the
	// custom volumes attached to the instance alone; any other value sends the root disk only.
	DiskVolumesMode string
}

type SnapshotMetadataImage struct {
	// Path of the image relative to the mounted config volume snapshot, to open through OpenRoot.
	Path string

	// UUID of the volume.
	VolumeUUID string

	// UUID of the volume snapshot.
	SnapshotUUID string

	// Pool of the custom volume snapshot, empty for the root volume snapshot.
	Pool string

	// Name of the custom volume snapshot, empty for the root volume snapshot.
	VolumeSnapshot string
}

type StateField string

type StateRenderOptions struct {
	IncludeDisk    bool
	IncludeNetwork bool
}

type TemplateTrigger string

type UpdateAction int

type VM interface {
	Instance

	AgentCertificate() *x509.Certificate

	FirmwarePath() string

	// UEFI vars handling.
	UEFIVars() (*api.InstanceUEFIVars, error)
	UEFIVarsUpdate(newUEFIVarsSet api.InstanceUEFIVars) error
}