Merge pull request #25717 from jankaluza/cdi-spec-dir

openshift-merge-bot[bot] · web-flow · commit 490eb476a82e · 2025-03-28T13:52:20.000Z
Add cdi-spec-dir option to top level options
diff --git a/cmd/podman/root.go b/cmd/podman/root.go
@@ -247,6 +247,9 @@ func persistentPreRunE(cmd *cobra.Command, args []string) error {
 		if cmd.Flag("hooks-dir").Changed {
 			podmanConfig.ContainersConf.Engine.HooksDir.Set(podmanConfig.HooksDir)
 		}
+		if cmd.Flag("cdi-spec-dir").Changed {
+			podmanConfig.ContainersConf.Engine.CdiSpecDirs.Set(podmanConfig.CdiSpecDirs)
+		}
 
 		// Currently it is only possible to restore a container with the same runtime
 		// as used for checkpointing. It should be possible to make crun and runc
@@ -566,6 +569,10 @@ func rootFlags(cmd *cobra.Command, podmanConfig *entities.PodmanConfig) {
 		pFlags.StringArrayVar(&podmanConfig.HooksDir, hooksDirFlagName, podmanConfig.ContainersConfDefaultsRO.Engine.HooksDir.Get(), "Set the OCI hooks directory path (may be set multiple times)")
 		_ = cmd.RegisterFlagCompletionFunc(hooksDirFlagName, completion.AutocompleteDefault)
 
+		cdiSpecDirFlagName := "cdi-spec-dir"
+		pFlags.StringArrayVar(&podmanConfig.CdiSpecDirs, cdiSpecDirFlagName, podmanConfig.ContainersConfDefaultsRO.Engine.CdiSpecDirs.Get(), "Set the CDI spec directory path (may be set multiple times)")
+		_ = cmd.RegisterFlagCompletionFunc(cdiSpecDirFlagName, completion.AutocompleteDefault)
+
 		pFlags.IntVar(&podmanConfig.MaxWorks, "max-workers", (runtime.NumCPU()*3)+1, "The maximum number of workers for parallel operations")
 
 		namespaceFlagName := "namespace"
diff --git a/docs/source/markdown/podman.1.md b/docs/source/markdown/podman.1.md
@@ -25,6 +25,10 @@ man pages.
 
 ## GLOBAL OPTIONS
 
+#### **--cdi-spec-dir**=*path*
+
+The CDI spec directory path (may be set multiple times). Default path is `/etc/cdi`.
+
 #### **--cgroup-manager**=*manager*
 
 The CGroup manager to use for container cgroups. Supported values are __cgroupfs__ or __systemd__. Default is _systemd_ unless overridden in the containers.conf file.
diff --git a/libpod/container_internal_common.go b/libpod/container_internal_common.go
@@ -639,6 +639,7 @@ func (c *Container) generateSpec(ctx context.Context) (s *spec.Spec, cleanupFunc
 	// Warning: CDI may alter g.Config in place.
 	if len(c.config.CDIDevices) > 0 {
 		registry, err := cdi.NewCache(
+			cdi.WithSpecDirs(c.runtime.config.Engine.CdiSpecDirs.Get()...),
 			cdi.WithAutoRefresh(false),
 		)
 		if err != nil {
diff --git a/libpod/options.go b/libpod/options.go
@@ -328,6 +328,17 @@ func WithCDI(devices []string) CtrCreateOption {
 	}
 }
 
+func WithCDISpecDirs(cdiSpecDirs []string) RuntimeOption {
+	return func(rt *Runtime) error {
+		if rt.valid {
+			return define.ErrRuntimeFinalized
+		}
+
+		rt.config.Engine.CdiSpecDirs.Set(cdiSpecDirs)
+		return nil
+	}
+}
+
 // WithStorageOpts sets the devices to check for CDI configuration.
 func WithStorageOpts(storageOpts map[string]string) CtrCreateOption {
 	return func(ctr *Container) error {
diff --git a/pkg/domain/entities/engine.go b/pkg/domain/entities/engine.go
@@ -35,6 +35,7 @@ type PodmanConfig struct {
 	CPUProfile               string         // Hidden: Should CPU profile be taken
 	EngineMode               EngineMode     // ABI or Tunneling mode
 	HooksDir                 []string
+	CdiSpecDirs              []string
 	Identity                 string   // ssh identity for connecting to server
 	IsRenumber               bool     // Is this a system renumber command? If so, a number of checks will be relaxed
 	IsReset                  bool     // Is this a system reset command? If so, a number of checks will be skipped/omitted
diff --git a/pkg/domain/infra/runtime_libpod.go b/pkg/domain/infra/runtime_libpod.go
@@ -212,6 +212,10 @@ func getRuntime(ctx context.Context, fs *flag.FlagSet, opts *engineOpts) (*libpo
 		options = append(options, libpod.WithDatabaseBackend(cfg.ContainersConf.Engine.DBBackend))
 	}
 
+	if cfg.CdiSpecDirs != nil {
+		options = append(options, libpod.WithCDISpecDirs(cfg.CdiSpecDirs))
+	}
+
 	if cfg.Syslog {
 		options = append(options, libpod.WithSyslog())
 	}
diff --git a/pkg/specgen/generate/config_freebsd.go b/pkg/specgen/generate/config_freebsd.go
@@ -9,16 +9,18 @@ import (
 	"path/filepath"
 	"strings"
 
+	"github.com/containers/common/pkg/config"
 	"github.com/opencontainers/runtime-tools/generate"
 	"github.com/sirupsen/logrus"
 	"golang.org/x/sys/unix"
 	"tags.cncf.io/container-device-interface/pkg/cdi"
 )
 
 // DevicesFromPath computes a list of devices
-func DevicesFromPath(g *generate.Generator, devicePath string) error {
+func DevicesFromPath(g *generate.Generator, devicePath string, config *config.Config) error {
 	if isCDIDevice(devicePath) {
 		registry, err := cdi.NewCache(
+			cdi.WithSpecDirs(config.Engine.CdiSpecDirs.Get()...),
 			cdi.WithAutoRefresh(false),
 		)
 		if err != nil {
diff --git a/pkg/specgen/generate/config_linux.go b/pkg/specgen/generate/config_linux.go
@@ -24,9 +24,10 @@ import (
 )
 
 // DevicesFromPath computes a list of devices
-func DevicesFromPath(g *generate.Generator, devicePath string) error {
+func DevicesFromPath(g *generate.Generator, devicePath string, config *config.Config) error {
 	if isCDIDevice(devicePath) {
 		registry, err := cdi.NewCache(
+			cdi.WithSpecDirs(config.Engine.CdiSpecDirs.Get()...),
 			cdi.WithAutoRefresh(false),
 		)
 		if err != nil {
diff --git a/pkg/specgen/generate/oci_freebsd.go b/pkg/specgen/generate/oci_freebsd.go
@@ -56,7 +56,7 @@ func SpecGenToOCI(ctx context.Context, s *specgen.SpecGenerator, rt *libpod.Runt
 	if !s.IsPrivileged() {
 		// add default devices from containers.conf
 		for _, device := range rtc.Containers.Devices.Get() {
-			if err = DevicesFromPath(&g, device); err != nil {
+			if err = DevicesFromPath(&g, device, rtc); err != nil {
 				return nil, err
 			}
 		}
@@ -67,7 +67,7 @@ func SpecGenToOCI(ctx context.Context, s *specgen.SpecGenerator, rt *libpod.Runt
 		}
 		// add default devices specified by caller
 		for _, device := range userDevices {
-			if err = DevicesFromPath(&g, device.Path); err != nil {
+			if err = DevicesFromPath(&g, device.Path, rtc); err != nil {
 				return nil, err
 			}
 		}
diff --git a/pkg/specgen/generate/oci_linux.go b/pkg/specgen/generate/oci_linux.go
@@ -256,7 +256,7 @@ func SpecGenToOCI(ctx context.Context, s *specgen.SpecGenerator, rt *libpod.Runt
 	var userDevices []spec.LinuxDevice
 	// add default devices from containers.conf
 	for _, device := range rtc.Containers.Devices.Get() {
-		if err = DevicesFromPath(&g, device); err != nil {
+		if err = DevicesFromPath(&g, device, rtc); err != nil {
 			return nil, err
 		}
 	}
@@ -267,7 +267,7 @@ func SpecGenToOCI(ctx context.Context, s *specgen.SpecGenerator, rt *libpod.Runt
 	}
 	// add default devices specified by caller
 	for _, device := range userDevices {
-		if err = DevicesFromPath(&g, device.Path); err != nil {
+		if err = DevicesFromPath(&g, device.Path, rtc); err != nil {
 			return nil, err
 		}
 	}
diff --git a/test/e2e/run_device_test.go b/test/e2e/run_device_test.go
@@ -3,19 +3,29 @@
 package integration
 
 import (
+	"errors"
 	"fmt"
+	"io/fs"
 	"os"
 	"os/exec"
 	"path/filepath"
+	"strings"
 
 	. "github.com/containers/podman/v5/test/utils"
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 )
 
-func createContainersConfFileWithDevices(pTest *PodmanTestIntegration, devices string) {
+func createContainersConfFileWithDevices(pTest *PodmanTestIntegration, devices string, cdiSpecDirs []string) {
 	configPath := filepath.Join(pTest.TempDir, "containers.conf")
 	containersConf := []byte(fmt.Sprintf("[containers]\ndevices = [%s]\n", devices))
+	if len(cdiSpecDirs) > 0 {
+		quoted := make([]string, len(cdiSpecDirs))
+		for i, dir := range cdiSpecDirs {
+			quoted[i] = fmt.Sprintf("%q", dir)
+		}
+		containersConf = append(containersConf, []byte(fmt.Sprintf("[engine]\ncdi_spec_dirs = [%s]\n", strings.Join(quoted, ", ")))...)
+	}
 	err := os.WriteFile(configPath, containersConf, os.ModePerm)
 	Expect(err).ToNot(HaveOccurred())
 
@@ -103,7 +113,7 @@ var _ = Describe("Podman run device", func() {
 	It("podman run CDI device test", func() {
 		SkipIfRootless("Rootless will not be able to create files/folders in /etc")
 		cdiDir := "/etc/cdi"
-		if _, err := os.Stat(cdiDir); os.IsNotExist(err) {
+		if _, err := os.Stat(cdiDir); errors.Is(err, fs.ErrNotExist) {
 			Expect(os.MkdirAll(cdiDir, os.ModePerm)).To(Succeed())
 		}
 		defer os.RemoveAll(cdiDir)
@@ -116,7 +126,26 @@ var _ = Describe("Podman run device", func() {
 		session.WaitWithDefaultTimeout()
 		Expect(session).Should(ExitCleanly())
 
-		createContainersConfFileWithDevices(podmanTest, "\"vendor.com/device=myKmsg\"")
+		createContainersConfFileWithDevices(podmanTest, "\"vendor.com/device=myKmsg\"", []string{})
+		session = podmanTest.Podman([]string{"run", "-q", "--security-opt", "label=disable", ALPINE, "test", "-c", "/dev/kmsg1"})
+		session.WaitWithDefaultTimeout()
+		Expect(session).Should(ExitCleanly())
+	})
+
+	It("podman run CDI device test with --cdi-spec-dir", func() {
+		SkipIfRemote("The --cdi-spec-dir only works locally.")
+		cdiDir := podmanTest.TempDir + "/cdi"
+		Expect(os.MkdirAll(cdiDir, os.ModePerm)).To(Succeed())
+
+		cmd := exec.Command("cp", "cdi/device.json", cdiDir)
+		err = cmd.Run()
+		Expect(err).ToNot(HaveOccurred())
+
+		session := podmanTest.Podman([]string{"run", "--cdi-spec-dir", cdiDir, "-q", "--security-opt", "label=disable", "--device", "vendor.com/device=myKmsg", ALPINE, "test", "-c", "/dev/kmsg1"})
+		session.WaitWithDefaultTimeout()
+		Expect(session).Should(ExitCleanly())
+
+		createContainersConfFileWithDevices(podmanTest, "\"vendor.com/device=myKmsg\"", []string{cdiDir})
 		session = podmanTest.Podman([]string{"run", "-q", "--security-opt", "label=disable", ALPINE, "test", "-c", "/dev/kmsg1"})
 		session.WaitWithDefaultTimeout()
 		Expect(session).Should(ExitCleanly())

Original file line number	Diff line number	Diff line change
`@@ -639,6 +639,7 @@ func (c Container) generateSpec(ctx context.Context) (s spec.Spec, cleanupFunc`
`639`	`639`	`// Warning: CDI may alter g.Config in place.`
`640`	`640`	`if len(c.config.CDIDevices) > 0 {`
`641`	`641`	`registry, err := cdi.NewCache(`
	`642`	`+ cdi.WithSpecDirs(c.runtime.config.Engine.CdiSpecDirs.Get()...),`
`642`	`643`	`cdi.WithAutoRefresh(false),`
`643`	`644`	`)`
`644`	`645`	`if err != nil {`
Original file line number	Diff line number	Diff line change
`@@ -212,6 +212,10 @@ func getRuntime(ctx context.Context, fs flag.FlagSet, opts engineOpts) (*libpo`
`212`	`212`	`options = append(options, libpod.WithDatabaseBackend(cfg.ContainersConf.Engine.DBBackend))`
`213`	`213`	`}`
`214`	`214`
	`215`	`+ if cfg.CdiSpecDirs != nil {`
	`216`	`+ options = append(options, libpod.WithCDISpecDirs(cfg.CdiSpecDirs))`
	`217`	`+ }`
	`218`	`+`
`215`	`219`	`if cfg.Syslog {`
`216`	`220`	`options = append(options, libpod.WithSyslog())`
`217`	`221`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,9 +24,10 @@ import (`
`24`	`24`	`)`
`25`	`25`
`26`	`26`	`// DevicesFromPath computes a list of devices`
`27`		`-func DevicesFromPath(g *generate.Generator, devicePath string) error {`
	`27`	`+func DevicesFromPath(g generate.Generator, devicePath string, config config.Config) error {`
`28`	`28`	`if isCDIDevice(devicePath) {`
`29`	`29`	`registry, err := cdi.NewCache(`
	`30`	`+ cdi.WithSpecDirs(config.Engine.CdiSpecDirs.Get()...),`
`30`	`31`	`cdi.WithAutoRefresh(false),`
`31`	`32`	`)`
`32`	`33`	`if err != nil {`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ func SpecGenToOCI(ctx context.Context, s specgen.SpecGenerator, rt libpod.Runt`
`56`	`56`	`if !s.IsPrivileged() {`
`57`	`57`	`// add default devices from containers.conf`
`58`	`58`	`for _, device := range rtc.Containers.Devices.Get() {`
`59`		`- if err = DevicesFromPath(&g, device); err != nil {`
	`59`	`+ if err = DevicesFromPath(&g, device, rtc); err != nil {`
`60`	`60`	`return nil, err`
`61`	`61`	`}`
`62`	`62`	`}`
`@@ -67,7 +67,7 @@ func SpecGenToOCI(ctx context.Context, s specgen.SpecGenerator, rt libpod.Runt`
`67`	`67`	`}`
`68`	`68`	`// add default devices specified by caller`
`69`	`69`	`for _, device := range userDevices {`
`70`		`- if err = DevicesFromPath(&g, device.Path); err != nil {`
	`70`	`+ if err = DevicesFromPath(&g, device.Path, rtc); err != nil {`
`71`	`71`	`return nil, err`
`72`	`72`	`}`
`73`	`73`	`}`
Original file line number	Diff line number	Diff line change
`@@ -256,7 +256,7 @@ func SpecGenToOCI(ctx context.Context, s specgen.SpecGenerator, rt libpod.Runt`
`256`	`256`	`var userDevices []spec.LinuxDevice`
`257`	`257`	`// add default devices from containers.conf`
`258`	`258`	`for _, device := range rtc.Containers.Devices.Get() {`
`259`		`- if err = DevicesFromPath(&g, device); err != nil {`
	`259`	`+ if err = DevicesFromPath(&g, device, rtc); err != nil {`
`260`	`260`	`return nil, err`
`261`	`261`	`}`
`262`	`262`	`}`
`@@ -267,7 +267,7 @@ func SpecGenToOCI(ctx context.Context, s specgen.SpecGenerator, rt libpod.Runt`
`267`	`267`	`}`
`268`	`268`	`// add default devices specified by caller`
`269`	`269`	`for _, device := range userDevices {`
`270`		`- if err = DevicesFromPath(&g, device.Path); err != nil {`
	`270`	`+ if err = DevicesFromPath(&g, device.Path, rtc); err != nil {`
`271`	`271`	`return nil, err`
`272`	`272`	`}`
`273`	`273`	`}`