device

Documentation

Index

• Constants
• Variables
• func BlockFsDetect(dev string) (string, error)
• func DiskMount(srcPath string, dstPath string, readonly bool, recursive bool, ...) error
• func InotifyHandler(s *state.State)
• func InotifyInit(s *state.State) (int, error)
• func IsBlockdev(path string) bool
• func NetworkGetDevMAC(devName string) (string, error)
• func NetworkRemoveInterface(nic string) error
• func NetworkSetDevMAC(devName string, mac string) error
• func NetworkSetDevMTU(devName string, mtu uint64) error
• func NetworkValidAddress(value string) error
• func NetworkValidAddressV4(value string) error
• func NetworkValidAddressV4List(value string) error
• func NetworkValidAddressV6(value string) error
• func NetworkValidAddressV6List(value string) error
• func NetworkValidGateway(value string) error
• func NetworkValidNetworkV4(value string) error
• func NetworkValidNetworkV4List(value string) error
• func NetworkValidNetworkV6(value string) error
• func NetworkValidNetworkV6List(value string) error
• func ProxyParseAddr(addr string) (*deviceConfig.ProxyAddress, error)
• func USBRunHandlers(state *state.State, event *USBEvent)
• func UnixDeviceExists(devicesPath string, prefix string, path string) bool
• func UnixHotplugRunHandlers(state *state.State, event *UnixHotplugEvent)
• func Validate(instConfig instance.ConfigReader, state *state.State, name string, ...) error
• type Device
  • func New(inst instance.Instance, state *state.State, name string, ...) (Device, error)
• type USBEvent
  • func USBNewEvent(action string, vendor string, product string, major string, minor string, ...) (USBEvent, error)
• type UnixDevice
  • func UnixDeviceCreate(s *state.State, idmapSet *idmap.IdmapSet, devicesPath string, prefix string, ...) (*UnixDevice, error)
• type UnixEvent
• type UnixHotplugEvent
  • func UnixHotplugNewEvent(action string, vendor string, product string, major string, minor string, ...) (UnixHotplugEvent, error)
• type UnixSubscription
• type VirtFuncInfo
• type VolatileGetter
• type VolatileSetter

Constants

const IBDevPrefix = "infiniband.unix"

IBDevPrefix Infiniband devices prefix.

Variables

var ErrUnsupportedDevType = fmt.Errorf("Unsupported device type")

ErrUnsupportedDevType is the error that occurs when an unsupported device type is created.

Functions

func BlockFsDetect

func BlockFsDetect(dev string) (string, error)

BlockFsDetect detects the type of block device.

func DiskMount

func DiskMount(srcPath string, dstPath string, readonly bool, recursive bool, propagation string, rawMountOptions string, fsName string) error

DiskMount mounts a disk device.

func InotifyHandler

func InotifyHandler(s *state.State)

InotifyHandler starts watching for inotify events.

func InotifyInit

func InotifyInit(s *state.State) (int, error)

InotifyInit initialises the inotify internal structures.

func IsBlockdev

func IsBlockdev(path string) bool

IsBlockdev returns boolean indicating whether device is block type.

func NetworkGetDevMAC

func NetworkGetDevMAC(devName string) (string, error)

NetworkGetDevMAC retrieves the current MAC setting for a named network device.

func NetworkRemoveInterface

func NetworkRemoveInterface(nic string) error

NetworkRemoveInterface removes a network interface by name.

func NetworkSetDevMAC

func NetworkSetDevMAC(devName string, mac string) error

NetworkSetDevMAC sets the MAC setting for a named network device if different from current.

func NetworkSetDevMTU

func NetworkSetDevMTU(devName string, mtu uint64) error

NetworkSetDevMTU sets the MTU setting for a named network device if different from current.

func NetworkValidAddress

func NetworkValidAddress(value string) error

NetworkValidAddress validates an IP address string. If string is empty, returns valid.

func NetworkValidAddressV4

func NetworkValidAddressV4(value string) error

NetworkValidAddressV4 validates an IPv4 addresss string. If string is empty, returns valid.

func NetworkValidAddressV4List

func NetworkValidAddressV4List(value string) error

NetworkValidAddressV4List validates a comma delimited list of IPv4 addresses.

func NetworkValidAddressV6

func NetworkValidAddressV6(value string) error

NetworkValidAddressV6 validates an IPv6 addresss string. If string is empty, returns valid.

func NetworkValidAddressV6List

func NetworkValidAddressV6List(value string) error

NetworkValidAddressV6List validates a comma delimited list of IPv6 addresses.

func NetworkValidGateway

func NetworkValidGateway(value string) error

NetworkValidGateway validates the gateway value.

func NetworkValidNetworkV4

func NetworkValidNetworkV4(value string) error

NetworkValidNetworkV4 validates an IPv4 CIDR string. If string is empty, returns valid.

func NetworkValidNetworkV4List

func NetworkValidNetworkV4List(value string) error

NetworkValidNetworkV4List validates a comma delimited list of IPv4 CIDR strings.

func NetworkValidNetworkV6

func NetworkValidNetworkV6(value string) error

NetworkValidNetworkV6 validates an IPv6 CIDR string. If string is empty, returns valid.

func NetworkValidNetworkV6List

func NetworkValidNetworkV6List(value string) error

NetworkValidNetworkV6List validates a comma delimited list of IPv6 CIDR strings.

func ProxyParseAddr

func ProxyParseAddr(addr string) (*deviceConfig.ProxyAddress, error)

ProxyParseAddr validates a proxy address and parses it into its constituent parts.

func USBRunHandlers

func USBRunHandlers(state *state.State, event *USBEvent)

USBRunHandlers executes any handlers registered for USB events.

func UnixDeviceExists

func UnixDeviceExists(devicesPath string, prefix string, path string) bool

UnixDeviceExists checks if the unix device already exists in devices path.

func UnixHotplugRunHandlers

func UnixHotplugRunHandlers(state *state.State, event *UnixHotplugEvent)

UnixHotplugRunHandlers executes any handlers registered for Unix hotplug events.

func Validate

func Validate(instConfig instance.ConfigReader, state *state.State, name string, conf deviceConfig.Device) error

Validate checks a device's config is valid. This only requires an instance.ConfigReader rather than an full blown instance to allow profile devices to be validated too.

Types

type Device

type Device interface {
	// CanHotPlug returns true if device can be managed whilst instance is running.
	// It also returns a slice of config fields that can be live updated. If only fields in this
	// list have changed then Update() is called rather than triggering a device remove & add.
	CanHotPlug() (bool, []string)

	// Add performs any host-side setup when a device is added to an instance.
	// It is called irrespective of whether the instance is running or not.
	Add() error

	// Start peforms any host-side configuration required to start the device for the instance.
	// This can be when a device is plugged into a running instance or the instance is starting.
	// Returns run-time configuration needed for configuring the instance with the new device.
	Start() (*deviceConfig.RunConfig, error)

	// Register provides the ability for a device to subcribe to events that LXD can generate.
	// It is called after a device is started (after Start()) or when LXD starts.
	Register() error

	// Update performs host-side modifications for a device based on the difference between the
	// current config and previous devices config supplied as an argument. This called if the
	// only config fields that have changed are supplied in the list returned from CanHotPlug().
	// The function also accepts a boolean indicating whether the instance is running or not.
	Update(oldDevices deviceConfig.Devices, running bool) error

	// Stop performs any host-side cleanup required when a device is removed from an instance,
	// either due to unplugging it from a running instance or instance is being shutdown.
	// Returns run-time configuration needed for detaching the device from the instance.
	Stop() (*deviceConfig.RunConfig, error)

	// Remove performs any host-side cleanup when an instance is removed from an instance.
	Remove() error
}

Device represents a device that can be added to an instance.

func New

func New(inst instance.Instance, state *state.State, name string, conf deviceConfig.Device, volatileGet VolatileGetter, volatileSet VolatileSetter) (Device, error)

New instantiates a new device struct, validates the supplied config and sets it into the device. If the device type is valid, but the other config validation fails then an instantiated device is still returned with the validation error. If an unknown device is requested or the device is not compatible with the instance type then an ErrUnsupportedDevType error is returned.

type USBEvent

type USBEvent struct {
	Action string

	Vendor  string
	Product string

	Path        string
	Major       uint32
	Minor       uint32
	UeventParts []string
	UeventLen   int
}

USBEvent represents the properties of a USB device uevent.

func USBNewEvent

func USBNewEvent(action string, vendor string, product string, major string, minor string, busnum string, devnum string, devname string, ueventParts []string, ueventLen int) (USBEvent, error)

USBNewEvent instantiates a new USBEvent struct.

type UnixDevice

type UnixDevice struct {
	HostPath     string      // Absolute path to the device on the host.
	RelativePath string      // Relative path where the device will be mounted inside instance.
	Type         string      // Type of device; c (for char) or b for (block).
	Major        uint32      // Major number.
	Minor        uint32      // Minor number.
	Mode         os.FileMode // File mode.
	UID          int         // Owner UID.
	GID          int         // Owner GID.
}

UnixDevice contains information about a created UNIX device.

func UnixDeviceCreate

func UnixDeviceCreate(s *state.State, idmapSet *idmap.IdmapSet, devicesPath string, prefix string, m deviceConfig.Device, defaultMode bool) (*UnixDevice, error)

UnixDeviceCreate creates a UNIX device (either block or char). If the supplied device config map contains a major and minor number for the device, then a stat is avoided, otherwise this info retrieved from the origin device. Similarly, if a mode is supplied in the device config map or defaultMode is set as true, then the device is created with the supplied or default mode (0660) respectively, otherwise the origin device's mode is used. If the device config doesn't contain a type field then it defaults to created a unix-char device. The ownership of the created device defaults to root (0) but can be specified with the uid and gid fields in the device config map. It returns a UnixDevice containing information about the device created.

type UnixEvent

type UnixEvent struct {
	Action string // The type of event, either add or remove.
	Path   string // The absolute source path on the host.
}

UnixEvent represents the properties of a Unix device inotify event.

type UnixHotplugEvent

type UnixHotplugEvent struct {
	Action string

	Vendor  string
	Product string

	Path        string
	Major       uint32
	Minor       uint32
	Subsystem   string
	UeventParts []string
	UeventLen   int
}

UnixHotplugEvent represents the properties of a Unix hotplug device uevent.

func UnixHotplugNewEvent

func UnixHotplugNewEvent(action string, vendor string, product string, major string, minor string, subsystem string, devname string, ueventParts []string, ueventLen int) (UnixHotplugEvent, error)

UnixHotplugNewEvent instantiates a new UnixHotplugEvent struct.

type UnixSubscription

type UnixSubscription struct {
	Path    string                                           // The absolute source path on the host.
	Handler func(UnixEvent) (*deviceConfig.RunConfig, error) // The function to run when an event occurs.
}

UnixSubscription used to subcribe to specific events.

type VirtFuncInfo

type VirtFuncInfo struct {
	VF         int              `json:"vf"`
	Address    string           `json:"address"`
	MAC        string           `json:"mac"` // Deprecated
	VLANs      []map[string]int `json:"vlan_list"`
	SpoofCheck bool             `json:"spoofchk"`
}

VirtFuncInfo holds information about SR-IOV virtual functions.

type VolatileGetter

type VolatileGetter func() map[string]string

VolatileGetter is a function that retrieves any key/value string that exists in the LXD database config for this instance. It should only return keys that match the volatile device name prefix, and should remove the prefix before being returned.

type VolatileSetter

type VolatileSetter func(map[string]string) error

VolatileSetter is a function that accepts one or more key/value strings to save into the LXD config for this instance. It should add the volatile device name prefix to each key when saving.