vmmanager

type LifetimeManager interface {
	// ID will return a string identifier for the Utility VM.
	ID() string

	// RuntimeID will return the Hyper-V VM GUID for the Utility VM.
	//
	// Only valid after the utility VM has been created.
	RuntimeID() guid.GUID

	// Start will power on the Utility VM and put it into a running state. This will boot the guest OS and start all of the
	// devices configured on the machine.
	Start(ctx context.Context) error

	// Terminate will forcefully power off the Utility VM.
	// It waits for the UVM to exit and returns any encountered errors.
	Terminate(ctx context.Context) error

	// Close terminates and releases resources associated with the utility VM.
	Close(ctx context.Context) error

	// Pause will place the Utility VM into a paused state. The guest OS will be halted and any devices will have be in a
	// a suspended state. Save can be used to snapshot the current state of the virtual machine, and Resume can be used to
	// place the virtual machine back into a running state.
	Pause(ctx context.Context) error

	// Resume will put a previously paused Utility VM back into a running state. The guest OS will resume operation from the point
	// in time it was paused and all devices should be un-suspended.
	Resume(ctx context.Context) error

	// Save will snapshot the state of the Utility VM at the point in time when the VM was paused.
	Save(ctx context.Context, options hcsschema.SaveOptions) error

	// Wait synchronously waits for the Utility VM to terminate.
	Wait(ctx context.Context) error

	// PropertiesV2 returns the properties of the Utility VM.
	PropertiesV2(ctx context.Context, types ...hcsschema.PropertyType) (*hcsschema.Properties, error)

	// StartedTime returns the time when the Utility VM entered the running state.
	StartedTime() time.Time

	// StoppedTime returns the time when the Utility VM entered the stopped state.
	StoppedTime() time.Time

	// ExitError will return any error if the Utility VM exited unexpectedly, or if the Utility VM experienced an
	// error after Wait returned, it will return the wait error.
	ExitError() error
}

type NetworkManager interface {
	// AddNIC adds a network adapter to the Utility VM. `nicID` should be a string representation of a
	// Windows GUID.
	AddNIC(ctx context.Context, nicID string, settings *hcsschema.NetworkAdapter) error

	// RemoveNIC removes a network adapter from the Utility VM. `nicID` should be a string representation of a
	// Windows GUID.
	RemoveNIC(ctx context.Context, nicID string, settings *hcsschema.NetworkAdapter) error

	// UpdateNIC updates the configuration of a network adapter on the Utility VM.
	UpdateNIC(ctx context.Context, nicID string, settings *hcsschema.NetworkAdapter) error
}

type PCIManager interface {
	// AddDevice adds a pci device identified by `vmbusGUID` to the Utility VM with the provided settings.
	AddDevice(ctx context.Context, vmbusGUID string, settings hcsschema.VirtualPciDevice) error

	// RemoveDevice removes the pci device identified by `vmbusGUID` from the Utility VM.
	RemoveDevice(ctx context.Context, vmbusGUID string) error
}

type PipeManager interface {
	// AddPipe adds a named pipe to the Utility VM.
	AddPipe(ctx context.Context, hostPath string) error

	// RemovePipe removes a named pipe from the Utility VM.
	RemovePipe(ctx context.Context, hostPath string) error
}

type Plan9Manager interface {
	// AddPlan9 adds a plan 9 share to a running Utility VM.
	AddPlan9(ctx context.Context, settings hcsschema.Plan9Share) error

	// RemovePlan9 removes a plan 9 share from a running Utility VM.
	RemovePlan9(ctx context.Context, settings hcsschema.Plan9Share) error
}

type ResourceManager interface {
	// SetCPUGroup assigns the Utility VM to a cpu group.
	SetCPUGroup(ctx context.Context, settings *hcsschema.CpuGroup) error

	// UpdateCPULimits updates the CPU limits for the Utility VM.
	// `limit` is the percentage of CPU cycles that the Utility VM is allowed to use.
	// `weight` is the relative weight of the Utility VM compared to other VMs when CPU cycles are contended.
	// `reservation` is the percentage of CPU cycles that are reserved for the Utility VM.
	// `maximumFrequencyMHz` is the maximum frequency in MHz that the Utility VM can use.
	UpdateCPULimits(ctx context.Context, settings *hcsschema.ProcessorLimits) error

	// UpdateMemory makes a call to the VM's orchestrator to update the VM's size in MB
	UpdateMemory(ctx context.Context, memory uint64) error
}

type UtilityVM struct {
	// contains filtered or unexported fields
}

type VMSocketManager interface {
	// UpdateHvSocketService will update the configuration for the HvSocket service with the specified `serviceID`.
	UpdateHvSocketService(ctx context.Context, serviceID string, config *hcsschema.HvSocketServiceConfig) error

	// RemoveHvSocketService will remove the HvSocket service with the specified `serviceID` from the Utility VM.
	RemoveHvSocketService(ctx context.Context, serviceID string) error
}

type VSMBManager interface {
	// AddVSMB adds a virtual smb share to a running Utility VM.
	AddVSMB(ctx context.Context, settings hcsschema.VirtualSmbShare) error

	// RemoveVSMB removes a virtual smb share from a running Utility VM.
	RemoveVSMB(ctx context.Context, settings hcsschema.VirtualSmbShare) error
}