nvcdi

package
v1.15.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 15, 2024 License: Apache-2.0 Imports: 26 Imported by: 1

Documentation

Index

Constants

View Source
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"
)
View Source
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

Variables

This section is empty.

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, nvidiaCTKPath 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, nvidiaCTKPath, 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 added in v1.15.0

type DeviceNamers []DeviceNamer

DeviceNamers represents a list of device namers

func (DeviceNamers) GetDeviceNames added in v1.15.0

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

func (DeviceNamers) GetMigDeviceNames added in v1.15.0

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 added in v1.14.0

func WithCSVFiles(csvFiles []string) Option

WithCSVFiles sets the CSV files for the library

func WithCSVIgnorePatterns added in v1.14.2

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 added in v1.15.0

func WithConfigSearchPaths(paths []string) Option

WithConfigSearchPaths sets the search paths for config files.

func WithDevRoot added in v1.15.0

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 added in v1.15.0

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 WithLdconfigPath added in v1.15.0

func WithLdconfigPath(path string) Option

WithLdconfigPath sets the path to the ldconfig program

func WithLibrarySearchPaths added in v1.14.0

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 added in v1.14.0

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 WithNVIDIACTKPath

func WithNVIDIACTKPath(path string) Option

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

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 added in v1.14.0

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

UUIDer is an interface for getting UUIDs.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL