Disable nvsandboxutils by default

This change disables the use of nvsandboxuitls for CDI spec
generation by default. This prevents issues with specific
(end-of-life) driver versions where consecutive calls would
cause a cgo segmentation violation that could not be recovered
from.

The EnableNvsandboxutils feature flag can be specified when generating
CDI specs (or instantiating the nvcdi API) to explicitly opt-in to
using the nvsandboxutils library.

Signed-off-by: Evan Lezar <[email protected]>

Author: elezar

pkg/nvcdi/api.go

@@ -80,9 +80,23 @@ const (
 	// FeatureEnableExplicitDriverLibraries enables the inclusion of a list of
 	// explicit driver libraries.
 	FeatureEnableExplicitDriverLibraries = FeatureFlag("enable-explicit-driver-libraries")
+
 	// FeatureDisableNvsandboxUtils disables the use of nvsandboxutils when
 	// querying devices.
+	//
+	// Deprecated: nvsandboxutils is now disabled by default. To opt-in use the
+	// FeatureEnableNvsandboxutils instead.
 	FeatureDisableNvsandboxUtils = FeatureFlag("disable-nvsandbox-utils")
+
+	// FeatureEnableNvsandboxutils explicitly enables the use of nvsandboxutils
+	// when querying devices.
+	// Specifying this overrides the FeatureDisableNvsandboxUtils feature if
+	// also specified.
+	// This is explicitly opt-in due to issue in the 565 driver.
+	// Once this driver is no longer common, the default behaviour could be
+	// changed.
+	FeatureEnableNvsandboxutils = FeatureFlag("enable-nvsandboxutils")
+
 	// FeatureEnableCoherentAnnotations enables the addition of annotations
 	// coherent or non-coherent devices.
 	FeatureEnableCoherentAnnotations = FeatureFlag("enable-coherent-annotations")

pkg/nvcdi/lib.go

@@ -239,7 +239,7 @@ func (l *nvcdilib) getNvmlLib() nvml.Interface {
 // getNvsandboxUtilsLib returns the nvsandboxutilslib to use for CDI spec
 // generation.
 func (l *nvcdilib) getNvsandboxUtilsLib() nvsandboxutils.Interface {
-	if l.featureFlags[FeatureDisableNvsandboxUtils] {
+	if !l.featureFlags[FeatureEnableNvsandboxutils] {
 		return nil
 	}
 	if l.nvsandboxutilslib != nil {

pkg/nvcdi/options.go

@@ -184,6 +184,14 @@ func WithFeatureFlags[T string | FeatureFlag](featureFlags ...T) Option {
 		}
 		for _, featureFlag := range featureFlags {
 			o.featureFlags[FeatureFlag(featureFlag)] = true
+			// If FeatureEnableNvsandboxutils is specified, we explcitly set
+			// FeatureDisableNvsandboxUtils to false so that to have consistency.
+			// Note that it is not needed to set FeatureEnableNvsandboxutils to
+			// false if FeatureDisableNvsandboxUtils is specified since this is
+			// the default behaviour -- unless a user explicitly opts-in.
+			if featureFlag == T(FeatureEnableNvsandboxutils) {
+				o.featureFlags[FeatureDisableNvsandboxUtils] = false
+			}
 		}
 	}
 }