discover

Documentation

Index

• type Device
• type Discover
  • func CreateCreateSymlinkHook(nvidiaCDIHookPath string, links []string) Discover
  • func FirstValid(discoverers ...Discover) Discover
  • func Merge(d ...Discover) Discover
  • func NewCharDeviceDiscoverer(logger logger.Interface, devRoot string, devices []string) Discover
  • func NewDRMNodesDiscoverer(logger logger.Interface, devices image.VisibleDevices, devRoot string, ...) (Discover, error)
  • func NewGDRCopyDiscoverer(logger logger.Interface, devRoot string) (Discover, error)
  • func NewGDSDiscoverer(logger logger.Interface, driverRoot string, devRoot string) (Discover, error)
  • func NewGraphicsMountsDiscoverer(logger logger.Interface, driver *root.Driver, nvidiaCDIHookPath string) (Discover, error)
  • func NewIPCDiscoverer(logger logger.Interface, driverRoot string) (Discover, error)
  • func NewLDCacheUpdateHook(logger logger.Interface, mounts Discover, ...) (Discover, error)
  • func NewMOFEDDiscoverer(logger logger.Interface, devRoot string) (Discover, error)
  • func NewMounts(logger logger.Interface, lookup lookup.Locator, root string, required []string) Discover
  • func NewNvSwitchDiscoverer(logger logger.Interface, devRoot string) (Discover, error)
  • func WithCache(d Discover) Discover
  • func WithDriverDotSoSymlinks(mounts Discover, version string, nvidiaCDIHookPath string) Discover
• type DiscoverMock
  • func (mock *DiscoverMock) Devices() ([]Device, error)
  • func (mock *DiscoverMock) DevicesCalls() []struct{}
  • func (mock *DiscoverMock) Hooks() ([]Hook, error)
  • func (mock *DiscoverMock) HooksCalls() []struct{}
  • func (mock *DiscoverMock) Mounts() ([]Mount, error)
  • func (mock *DiscoverMock) MountsCalls() []struct{}
• type Filter
• type Hook
  • func CreateLDCacheUpdateHook(executable string, ldconfig string, libraries []string) Hook
  • func CreateNvidiaCDIHook(nvidiaCDIHookPath string, hookName string, additionalArgs ...string) Hook
  • func (h Hook) Devices() ([]Device, error)
  • func (h Hook) Hooks() ([]Hook, error)
  • func (h Hook) Mounts() ([]Mount, error)
• type Mount
• type None
  • func (e None) Devices() ([]Device, error)
  • func (e None) Hooks() ([]Hook, error)
  • func (e None) Mounts() ([]Mount, error)

Types

type Device

type Device struct {
	HostPath string
	Path     string
}

Device represents a discovered character device.

type Discover

type Discover interface {
	Devices() ([]Device, error)
	Mounts() ([]Mount, error)
	Hooks() ([]Hook, error)
}

Discover defines an interface for discovering the devices, mounts, and hooks available on a system

func CreateCreateSymlinkHook

func CreateCreateSymlinkHook(nvidiaCDIHookPath string, links []string) Discover

CreateCreateSymlinkHook creates a hook which creates a symlink from link -> target.

func FirstValid

func FirstValid(discoverers ...Discover) Discover

FirstValid returns a discoverer that returns the first non-error result from a list of discoverers.

func Merge

func Merge(d ...Discover) Discover

Merge creates a discoverer that is the composite of a list of discoverers.

func NewCharDeviceDiscoverer

func NewCharDeviceDiscoverer(logger logger.Interface, devRoot string, devices []string) Discover

NewCharDeviceDiscoverer creates a discoverer which locates the specified set of device nodes.

func NewDRMNodesDiscoverer

func NewDRMNodesDiscoverer(logger logger.Interface, devices image.VisibleDevices, devRoot string, nvidiaCDIHookPath string) (Discover, error)

NewDRMNodesDiscoverer returns a discoverer for the DRM device nodes associated with the specified visible devices.

TODO: The logic for creating DRM devices should be consolidated between this and the logic for generating CDI specs for a single device. This is only used when applying OCI spec modifications to an incoming spec in "legacy" mode.

func NewGDRCopyDiscoverer

func NewGDRCopyDiscoverer(logger logger.Interface, devRoot string) (Discover, error)

func NewGDSDiscoverer

func NewGDSDiscoverer(logger logger.Interface, driverRoot string, devRoot string) (Discover, error)

NewGDSDiscoverer creates a discoverer for GPUDirect Storage devices and mounts.

func NewGraphicsMountsDiscoverer

func NewGraphicsMountsDiscoverer(logger logger.Interface, driver *root.Driver, nvidiaCDIHookPath string) (Discover, error)

NewGraphicsMountsDiscoverer creates a discoverer for the mounts required by graphics tools such as vulkan.

func NewIPCDiscoverer

func NewIPCDiscoverer(logger logger.Interface, driverRoot string) (Discover, error)

NewIPCDiscoverer creats a discoverer for NVIDIA IPC sockets.

func NewLDCacheUpdateHook

func NewLDCacheUpdateHook(logger logger.Interface, mounts Discover, nvidiaCDIHookPath, ldconfigPath string) (Discover, error)

NewLDCacheUpdateHook creates a discoverer that updates the ldcache for the specified mounts. A logger can also be specified

func NewMOFEDDiscoverer

func NewMOFEDDiscoverer(logger logger.Interface, devRoot string) (Discover, error)

NewMOFEDDiscoverer creates a discoverer for MOFED devices.

func NewMounts

func NewMounts(logger logger.Interface, lookup lookup.Locator, root string, required []string) Discover

NewMounts creates a discoverer for the required mounts using the specified locator.

func NewNvSwitchDiscoverer

func NewNvSwitchDiscoverer(logger logger.Interface, devRoot string) (Discover, error)

NewNvSwitchDiscoverer creates a discoverer for NVSWITCH devices.

func WithCache

func WithCache(d Discover) Discover

WithCache decorates the specified disoverer with a cache.

func WithDriverDotSoSymlinks

func WithDriverDotSoSymlinks(mounts Discover, version string, nvidiaCDIHookPath string) Discover

WithDriverDotSoSymlinks decorates the provided discoverer. A hook is added that checks for specific driver symlinks that need to be created.

type DiscoverMock

type DiscoverMock struct {
	// DevicesFunc mocks the Devices method.
	DevicesFunc func() ([]Device, error)

	// HooksFunc mocks the Hooks method.
	HooksFunc func() ([]Hook, error)

	// MountsFunc mocks the Mounts method.
	MountsFunc func() ([]Mount, error)
	// contains filtered or unexported fields
}

DiscoverMock is a mock implementation of Discover.

func TestSomethingThatUsesDiscover(t *testing.T) {

	// make and configure a mocked Discover
	mockedDiscover := &DiscoverMock{
		DevicesFunc: func() ([]Device, error) {
			panic("mock out the Devices method")
		},
		HooksFunc: func() ([]Hook, error) {
			panic("mock out the Hooks method")
		},
		MountsFunc: func() ([]Mount, error) {
			panic("mock out the Mounts method")
		},
	}

	// use mockedDiscover in code that requires Discover
	// and then make assertions.

}

func (*DiscoverMock) Devices

func (mock *DiscoverMock) Devices() ([]Device, error)

Devices calls DevicesFunc.

func (*DiscoverMock) DevicesCalls

func (mock *DiscoverMock) DevicesCalls() []struct {
}

DevicesCalls gets all the calls that were made to Devices. Check the length with:

len(mockedDiscover.DevicesCalls())

func (*DiscoverMock) Hooks

func (mock *DiscoverMock) Hooks() ([]Hook, error)

Hooks calls HooksFunc.

func (*DiscoverMock) HooksCalls

func (mock *DiscoverMock) HooksCalls() []struct {
}

HooksCalls gets all the calls that were made to Hooks. Check the length with:

len(mockedDiscover.HooksCalls())

func (*DiscoverMock) Mounts

func (mock *DiscoverMock) Mounts() ([]Mount, error)

Mounts calls MountsFunc.

func (*DiscoverMock) MountsCalls

func (mock *DiscoverMock) MountsCalls() []struct {
}

MountsCalls gets all the calls that were made to Mounts. Check the length with:

len(mockedDiscover.MountsCalls())

type Filter

type Filter interface {
	DeviceIsSelected(device Device) bool
}

Filter defines an interface for filtering discovered entities

type Hook

type Hook struct {
	Lifecycle string
	Path      string
	Args      []string
}

Hook represents a discovered hook.

func CreateLDCacheUpdateHook

func CreateLDCacheUpdateHook(executable string, ldconfig string, libraries []string) Hook

CreateLDCacheUpdateHook locates the NVIDIA Container Toolkit CLI and creates a hook for updating the LD Cache

func CreateNvidiaCDIHook

func CreateNvidiaCDIHook(nvidiaCDIHookPath string, hookName string, additionalArgs ...string) Hook

CreateNvidiaCDIHook creates a hook which invokes the NVIDIA Container CLI hook subcommand.

func (Hook) Devices

func (h Hook) Devices() ([]Device, error)

Devices returns an empty list of devices for a Hook discoverer.

func (Hook) Hooks

func (h Hook) Hooks() ([]Hook, error)

Hooks allows the Hook type to also implement the Discoverer interface. It returns a single hook

func (Hook) Mounts

func (h Hook) Mounts() ([]Mount, error)

Mounts returns an empty list of mounts for a Hook discoverer.

type Mount

type Mount struct {
	HostPath string
	Path     string
	Options  []string
}

Mount represents a discovered mount.

type None

type None struct{}

None is a null discoverer that returns an empty list of devices and mounts.

func (None) Devices

func (e None) Devices() ([]Device, error)

Devices returns an empty list of devices

func (None) Hooks

func (e None) Hooks() ([]Hook, error)

Hooks returns an empty list of hooks

func (None) Mounts

func (e None) Mounts() ([]Mount, error)

Mounts returns an empty list of mounts