Merge branch 'CNT-1876/cdi-specs-from-csv' into 'main'

Add csv mode to CDI spec generation

See merge request nvidia/container-toolkit/container-toolkit!393

pkg/nvcdi/api.go

@@ -36,6 +36,9 @@ const (
 	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"
 )
 
 // Interface defines the API for the nvcdi package

pkg/nvcdi/lib-csv.go

@@ -0,0 +1,87 @@
+/**
+# Copyright (c) NVIDIA CORPORATION.  All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+**/
+
+package nvcdi
+
+import (
+	"fmt"
+
+	"github.com/NVIDIA/nvidia-container-toolkit/internal/discover"
+	"github.com/NVIDIA/nvidia-container-toolkit/internal/discover/tegra"
+	"github.com/NVIDIA/nvidia-container-toolkit/internal/edits"
+	"github.com/NVIDIA/nvidia-container-toolkit/pkg/nvcdi/spec"
+	"github.com/container-orchestrated-devices/container-device-interface/pkg/cdi"
+	"github.com/container-orchestrated-devices/container-device-interface/specs-go"
+	"gitlab.com/nvidia/cloud-native/go-nvlib/pkg/nvlib/device"
+)
+
+type csvlib nvcdilib
+
+var _ Interface = (*csvlib)(nil)
+
+// GetSpec should not be called for wsllib
+func (l *csvlib) GetSpec() (spec.Interface, error) {
+	return nil, fmt.Errorf("Unexpected call to csvlib.GetSpec()")
+}
+
+// GetAllDeviceSpecs returns the device specs for all available devices.
+func (l *csvlib) GetAllDeviceSpecs() ([]specs.Device, error) {
+	d, err := tegra.New(
+		tegra.WithLogger(l.logger),
+		tegra.WithDriverRoot(l.driverRoot),
+		tegra.WithNVIDIACTKPath(l.nvidiaCTKPath),
+		tegra.WithCSVFiles(l.csvFiles),
+	)
+	if err != nil {
+		return nil, fmt.Errorf("failed to create discoverer for CSV files: %v", err)
+	}
+	e, err := edits.FromDiscoverer(d)
+	if err != nil {
+		return nil, fmt.Errorf("failed to create container edits for CSV files: %v", err)
+	}
+
+	deviceSpec := specs.Device{
+		Name:           "all",
+		ContainerEdits: *e.ContainerEdits,
+	}
+	return []specs.Device{deviceSpec}, nil
+}
+
+// GetCommonEdits generates a CDI specification that can be used for ANY devices
+func (l *csvlib) GetCommonEdits() (*cdi.ContainerEdits, error) {
+	d := discover.None{}
+	return edits.FromDiscoverer(d)
+}
+
+// GetGPUDeviceEdits generates a CDI specification that can be used for GPU devices
+func (l *csvlib) GetGPUDeviceEdits(device.Device) (*cdi.ContainerEdits, error) {
+	return nil, fmt.Errorf("GetGPUDeviceEdits is not supported for CSV files")
+}
+
+// GetGPUDeviceSpecs returns the CDI device specs for the full GPU represented by 'device'.
+func (l *csvlib) GetGPUDeviceSpecs(i int, d device.Device) (*specs.Device, error) {
+	return nil, fmt.Errorf("GetGPUDeviceSpecs is not supported for CSV files")
+}
+
+// GetMIGDeviceEdits generates a CDI specification that can be used for MIG devices
+func (l *csvlib) GetMIGDeviceEdits(device.Device, device.MigDevice) (*cdi.ContainerEdits, error) {
+	return nil, fmt.Errorf("GetMIGDeviceEdits is not supported for CSV files")
+}
+
+// GetMIGDeviceSpecs returns the CDI device specs for the full MIG represented by 'device'.
+func (l *csvlib) GetMIGDeviceSpecs(int, device.Device, int, device.MigDevice) (*specs.Device, error) {
+	return nil, fmt.Errorf("GetMIGDeviceSpecs is not supported for CSV files")
+}

pkg/nvcdi/lib.go

@@ -19,6 +19,7 @@ package nvcdi
 import (
 	"fmt"
 
+	"github.com/NVIDIA/nvidia-container-toolkit/internal/discover/csv"
 	"github.com/NVIDIA/nvidia-container-toolkit/pkg/nvcdi/spec"
 	"github.com/NVIDIA/nvidia-container-toolkit/pkg/nvcdi/transform"
 	"github.com/sirupsen/logrus"
@@ -45,6 +46,8 @@ type nvcdilib struct {
 	driverRoot    string
 	nvidiaCTKPath string
 
+	csvFiles []string
+
 	vendor string
 	class  string
 
@@ -80,6 +83,11 @@ func New(opts ...Option) (Interface, error) {
 
 	var lib Interface
 	switch l.resolveMode() {
+	case ModeCSV:
+		if len(l.csvFiles) == 0 {
+			l.csvFiles = csv.DefaultFileList()
+		}
+		lib = (*csvlib)(l)
 	case ModeManagement:
 		if l.vendor == "" {
 			l.vendor = "management.nvidia.com"
@@ -156,6 +164,16 @@ func (l *nvcdilib) resolveMode() (rmode string) {
 		return ModeWsl
 	}
 
+	isNvml, reason := l.infolib.HasNvml()
+	l.logger.Debugf("Is NVML-based system? %v: %v", isNvml, reason)
+
+	isTegra, reason := l.infolib.IsTegraSystem()
+	l.logger.Debugf("Is Tegra-based system? %v: %v", isTegra, reason)
+
+	if isTegra && !isNvml {
+		return ModeCSV
+	}
+
 	return ModeNvml
 }
 

pkg/nvcdi/lib_test.go

@@ -28,9 +28,10 @@ func TestResolveMode(t *testing.T) {
 	logger, _ := testlog.NewNullLogger()
 
 	testCases := []struct {
-		mode string
-		// TODO: This should be a proper mock
+		mode      string
+		isTegra   bool
 		hasDXCore bool
+		hasNVML   bool
 		expected  string
 	}{
 		{
@@ -41,11 +42,34 @@ func TestResolveMode(t *testing.T) {
 		{
 			mode:      "auto",
 			hasDXCore: false,
+			isTegra:   true,
+			hasNVML:   false,
+			expected:  "csv",
+		},
+		{
+			mode:      "auto",
+			hasDXCore: false,
+			isTegra:   false,
+			hasNVML:   false,
+			expected:  "nvml",
+		},
+		{
+			mode:      "auto",
+			hasDXCore: false,
+			isTegra:   true,
+			hasNVML:   true,
+			expected:  "nvml",
+		},
+		{
+			mode:      "auto",
+			hasDXCore: false,
+			isTegra:   false,
 			expected:  "nvml",
 		},
 		{
 			mode:      "nvml",
 			hasDXCore: true,
+			isTegra:   true,
 			expected:  "nvml",
 		},
 		{
@@ -65,7 +89,7 @@ func TestResolveMode(t *testing.T) {
 			l := nvcdilib{
 				logger:  logger,
 				mode:    tc.mode,
-				infolib: infoMock(tc.hasDXCore),
+				infolib: infoMock{hasDXCore: tc.hasDXCore, isTegra: tc.isTegra, hasNVML: tc.hasNVML},
 			}
 
 			require.Equal(t, tc.expected, l.resolveMode())
@@ -73,16 +97,20 @@ func TestResolveMode(t *testing.T) {
 	}
 }
 
-type infoMock bool
+type infoMock struct {
+	hasDXCore bool
+	isTegra   bool
+	hasNVML   bool
+}
 
 func (i infoMock) HasDXCore() (bool, string) {
-	return bool(i), ""
+	return bool(i.hasDXCore), ""
 }
 
 func (i infoMock) HasNvml() (bool, string) {
-	panic("should not be called")
+	return bool(i.hasNVML), ""
 }
 
 func (i infoMock) IsTegraSystem() (bool, string) {
-	panic("should not be called")
+	return bool(i.isTegra), ""
 }

pkg/nvcdi/options.go

@@ -96,3 +96,10 @@ func WithMergedDeviceOptions(opts ...transform.MergedDeviceOption) Option {
 		o.mergedDeviceOptions = opts
 	}
 }
+
+// WithCSVFiles sets the CSV files for the library
+func WithCSVFiles(csvFiles []string) Option {
+	return func(o *nvcdilib) {
+		o.csvFiles = csvFiles
+	}
+}