nvcdi

Documentation

Index

• Constants
• func NewDriverBinariesDiscoverer(logger logger.Interface, driverRoot string) discover.Discover
• func NewDriverDiscoverer(logger logger.Interface, driver *root.Driver, nvidiaCDIHookPath string, ...) (discover.Discover, error)
• func NewDriverFirmwareDiscoverer(logger logger.Interface, driverRoot string, version string) (discover.Discover, error)
• func NewDriverLibraryDiscoverer(logger logger.Interface, driver *root.Driver, ...) (discover.Discover, error)
• type DeviceNamer
  • func NewDeviceNamer(strategy string) (DeviceNamer, error)
• type DeviceNamers
  • func (l DeviceNamers) GetDeviceNames(i int, d UUIDer) ([]string, error)
  • func (l DeviceNamers) GetMigDeviceNames(i int, d UUIDer, j int, mig UUIDer) ([]string, error)
• type Interface
  • func New(opts ...Option) (Interface, error)
• type Option
  • func WithCSVFiles(csvFiles []string) Option
  • func WithCSVIgnorePatterns(csvIgnorePatterns []string) Option
  • func WithClass(class string) Option
  • func WithConfigSearchPaths(paths []string) Option
  • func WithDevRoot(root string) Option
  • func WithDeviceLib(devicelib device.Interface) Option
  • func WithDeviceNamers(namers ...DeviceNamer) Option
  • func WithDriverRoot(root string) Option
  • func WithInfoLib(infolib info.Interface) Option
  • func WithLdconfigPath(path string) Option
  • func WithLibrarySearchPaths(paths []string) Option
  • func WithLogger(logger logger.Interface) Option
  • func WithMergedDeviceOptions(opts ...transform.MergedDeviceOption) Option
  • func WithMode(mode string) Option
  • func WithNVIDIACDIHookPath(path string) Option
  • func WithNVIDIACTKPath(path string) Option
  • func WithNvmlLib(nvmllib nvml.Interface) Option
  • func WithVendor(vendor string) Option
• type UUIDer

Constants

const (
	// ModeAuto configures the CDI spec generator to automatically detect the system configuration
	ModeAuto = "auto"
	// ModeNvml configures the CDI spec generator to use the NVML library.
	ModeNvml = "nvml"
	// ModeWsl configures the CDI spec generator to generate a WSL spec.
	ModeWsl = "wsl"
	// ModeManagement configures the CDI spec generator to generate a management spec.
	ModeManagement = "management"
	// ModeGds configures the CDI spec generator to generate a GDS spec.
	ModeGds = "gds"
	// ModeMofed configures the CDI spec generator to generate a MOFED spec.
	ModeMofed = "mofed"
	// ModeCSV configures the CDI spec generator to generate a spec based on the contents of CSV
	// mountspec files.
	ModeCSV = "csv"
)

const (
	// DeviceNameStrategyIndex generates devices names such as 0 or 1:0
	DeviceNameStrategyIndex = "index"
	// DeviceNameStrategyTypeIndex generates devices names such as gpu0 or mig1:0
	DeviceNameStrategyTypeIndex = "type-index"
	// DeviceNameStrategyUUID uses the device UUID as the name
	DeviceNameStrategyUUID = "uuid"
)

Supported device naming strategies

Functions

func NewDriverBinariesDiscoverer

func NewDriverBinariesDiscoverer(logger logger.Interface, driverRoot string) discover.Discover

NewDriverBinariesDiscoverer creates a discoverer for GSP firmware associated with the GPU driver.

func NewDriverDiscoverer

func NewDriverDiscoverer(logger logger.Interface, driver *root.Driver, nvidiaCDIHookPath string, ldconfigPath string, nvmllib nvml.Interface) (discover.Discover, error)

NewDriverDiscoverer creates a discoverer for the libraries and binaries associated with a driver installation. The supplied NVML Library is used to query the expected driver version.

func NewDriverFirmwareDiscoverer

func NewDriverFirmwareDiscoverer(logger logger.Interface, driverRoot string, version string) (discover.Discover, error)

NewDriverFirmwareDiscoverer creates a discoverer for GSP firmware associated with the specified driver version.

func NewDriverLibraryDiscoverer

func NewDriverLibraryDiscoverer(logger logger.Interface, driver *root.Driver, nvidiaCDIHookPath, ldconfigPath, version string) (discover.Discover, error)

NewDriverLibraryDiscoverer creates a discoverer for the libraries associated with the specified driver version.

Types

type DeviceNamer

type DeviceNamer interface {
	GetDeviceName(int, UUIDer) (string, error)
	GetMigDeviceName(int, UUIDer, int, UUIDer) (string, error)
}

DeviceNamer is an interface for getting device names

func NewDeviceNamer

func NewDeviceNamer(strategy string) (DeviceNamer, error)

NewDeviceNamer creates a Device Namer based on the supplied strategy. This namer can be used to construct the names for MIG and GPU devices when generating the CDI spec.

type DeviceNamers

type DeviceNamers []DeviceNamer

DeviceNamers represents a list of device namers

func (DeviceNamers) GetDeviceNames

func (l DeviceNamers) GetDeviceNames(i int, d UUIDer) ([]string, error)

func (DeviceNamers) GetMigDeviceNames

func (l DeviceNamers) GetMigDeviceNames(i int, d UUIDer, j int, mig UUIDer) ([]string, error)

type Interface

type Interface interface {
	GetSpec() (spec.Interface, error)
	GetCommonEdits() (*cdi.ContainerEdits, error)
	GetAllDeviceSpecs() ([]specs.Device, error)
	GetGPUDeviceEdits(device.Device) (*cdi.ContainerEdits, error)
	GetGPUDeviceSpecs(int, device.Device) ([]specs.Device, error)
	GetMIGDeviceEdits(device.Device, device.MigDevice) (*cdi.ContainerEdits, error)
	GetMIGDeviceSpecs(int, device.Device, int, device.MigDevice) ([]specs.Device, error)
	GetDeviceSpecsByID(...string) ([]specs.Device, error)
}

Interface defines the API for the nvcdi package

func New

func New(opts ...Option) (Interface, error)

New creates a new nvcdi library

type Option

type Option func(*nvcdilib)

Option is a function that configures the nvcdilib

func WithCSVFiles

func WithCSVFiles(csvFiles []string) Option

WithCSVFiles sets the CSV files for the library

func WithCSVIgnorePatterns

func WithCSVIgnorePatterns(csvIgnorePatterns []string) Option

WithCSVIgnorePatterns sets the ignore patterns for entries in the CSV files.

func WithClass

func WithClass(class string) Option

WithClass sets the class for the library

func WithConfigSearchPaths

func WithConfigSearchPaths(paths []string) Option

WithConfigSearchPaths sets the search paths for config files.

func WithDevRoot

func WithDevRoot(root string) Option

WithDevRoot sets the root where /dev is located.

func WithDeviceLib

func WithDeviceLib(devicelib device.Interface) Option

WithDeviceLib sets the device library for the library

func WithDeviceNamers

func WithDeviceNamers(namers ...DeviceNamer) Option

WithDeviceNamers sets the device namer for the library

func WithDriverRoot

func WithDriverRoot(root string) Option

WithDriverRoot sets the driver root for the library

func WithInfoLib

func WithInfoLib(infolib info.Interface) Option

WithInfoLib sets the info library for CDI spec generation.

func WithLdconfigPath

func WithLdconfigPath(path string) Option

WithLdconfigPath sets the path to the ldconfig program

func WithLibrarySearchPaths

func WithLibrarySearchPaths(paths []string) Option

WithLibrarySearchPaths sets the library search paths. This is currently only used for CSV-mode.

func WithLogger

func WithLogger(logger logger.Interface) Option

WithLogger sets the logger for the library

func WithMergedDeviceOptions

func WithMergedDeviceOptions(opts ...transform.MergedDeviceOption) Option

WithMergedDeviceOptions sets the merged device options for the library If these are not set, no merged device will be generated.

func WithMode

func WithMode(mode string) Option

WithMode sets the discovery mode for the library

func WithNVIDIACDIHookPath

func WithNVIDIACDIHookPath(path string) Option

WithNVIDIACDIHookPath sets the path to the NVIDIA Container Toolkit CLI path for the library

func WithNVIDIACTKPath

func WithNVIDIACTKPath(path string) Option

WithNVIDIACTKPath sets the path to the NVIDIA Container Toolkit CLI path for the library

Deprecated: Use WithNVIDIACDIHookPath instead.

func WithNvmlLib

func WithNvmlLib(nvmllib nvml.Interface) Option

WithNvmlLib sets the nvml library for the library

func WithVendor

func WithVendor(vendor string) Option

WithVendor sets the vendor for the library

type UUIDer

type UUIDer interface {
	GetUUID() (string, error)
}

UUIDer is an interface for getting UUIDs.