nvidia-container-toolkit/internal/discover/hooks.go

/**
# 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 discover

import (
	"fmt"
	"path/filepath"

	"tags.cncf.io/container-device-interface/pkg/cdi"
)

// A HookName represents a supported CDI hooks.
type HookName string

const (
	// AllHooks is a special hook name that allows all hooks to be matched.
	AllHooks = HookName("all")

	// A ChmodHook is used to set the file mode of the specified paths.
	// Deprecated: The chmod hook is deprecated and will be removed in a future release.
	ChmodHook = HookName("chmod")
	// A CreateSymlinksHook is used to create symlinks in the container.
	CreateSymlinksHook = HookName("create-symlinks")
	// An EnableCudaCompatHook is used to enabled CUDA Forward Compatibility.
	// Added in v1.17.5
	EnableCudaCompatHook = HookName("enable-cuda-compat")
	// An UpdateLDCacheHook is the hook used to update the ldcache in the
	// container. This allows injected libraries to be discoverable.
	UpdateLDCacheHook = HookName("update-ldcache")

	defaultNvidiaCDIHookPath = "/usr/bin/nvidia-cdi-hook"
)

var _ Discover = (*Hook)(nil)

// Devices returns an empty list of devices for a Hook discoverer.
func (h *Hook) Devices() ([]Device, error) {
	return nil, nil
}

// Mounts returns an empty list of mounts for a Hook discoverer.
func (h *Hook) Mounts() ([]Mount, error) {
	return nil, nil
}

// Hooks allows the Hook type to also implement the Discoverer interface.
// It returns a single hook
func (h *Hook) Hooks() ([]Hook, error) {
	if h == nil {
		return nil, nil
	}

	return []Hook{*h}, nil
}

type Option func(*cdiHookCreator)

type cdiHookCreator struct {
	nvidiaCDIHookPath string
	disabledHooks     map[HookName]bool

	fixedArgs    []string
	debugLogging bool
}

// An allDisabledHookCreator is a HookCreator that does not create any hooks.
type allDisabledHookCreator struct{}

// Create returns nil for all hooks for an allDisabledHookCreator.
func (a *allDisabledHookCreator) Create(name HookName, args ...string) *Hook {
	return nil
}

// A HookCreator defines an interface for creating discover hooks.
type HookCreator interface {
	Create(HookName, ...string) *Hook
}

// WithDisabledHooks sets the set of hooks that are disabled for the CDI hook creator.
// This can be specified multiple times.
func WithDisabledHooks(hooks ...HookName) Option {
	return func(c *cdiHookCreator) {
		for _, hook := range hooks {
			c.disabledHooks[hook] = true
		}
	}
}

// WithNVIDIACDIHookPath sets the path to the nvidia-cdi-hook binary.
func WithNVIDIACDIHookPath(nvidiaCDIHookPath string) Option {
	return func(c *cdiHookCreator) {
		c.nvidiaCDIHookPath = nvidiaCDIHookPath
	}
}

func NewHookCreator(opts ...Option) HookCreator {
	cdiHookCreator := &cdiHookCreator{
		nvidiaCDIHookPath: defaultNvidiaCDIHookPath,
		disabledHooks:     make(map[HookName]bool),
	}
	for _, opt := range opts {
		opt(cdiHookCreator)
	}

	if cdiHookCreator.disabledHooks[AllHooks] {
		return &allDisabledHookCreator{}
	}

	cdiHookCreator.fixedArgs = getFixedArgsForCDIHookCLI(cdiHookCreator.nvidiaCDIHookPath)

	return cdiHookCreator
}

// Create creates a new hook with the given name and arguments.
// If a hook is disabled, a nil hook is returned.
func (c cdiHookCreator) Create(name HookName, args ...string) *Hook {
	if c.isDisabled(name, args...) {
		return nil
	}

	return &Hook{
		Lifecycle: cdi.CreateContainerHook,
		Path:      c.nvidiaCDIHookPath,
		Args:      append(c.requiredArgs(name), c.transformArgs(name, args...)...),
		Env:       []string{fmt.Sprintf("NVIDIA_CTK_DEBUG=%v", c.debugLogging)},
	}
}

// isDisabled checks if the specified hook name is disabled.
func (c cdiHookCreator) isDisabled(name HookName, args ...string) bool {
	if c.disabledHooks[name] {
		return true
	}

	switch name {
	case CreateSymlinksHook:
		if len(args) == 0 {
			return true
		}
	case ChmodHook:
		if len(args) == 0 {
			return true
		}
	}
	return false
}

func (c cdiHookCreator) requiredArgs(name HookName) []string {
	return append(c.fixedArgs, string(name))
}

func (c cdiHookCreator) transformArgs(name HookName, args ...string) []string {
	switch name {
	case CreateSymlinksHook:
		var transformedArgs []string
		for _, arg := range args {
			transformedArgs = append(transformedArgs, "--link", arg)
		}
		return transformedArgs
	case ChmodHook:
		var transformedArgs = []string{"--mode", "755"}
		for _, arg := range args {
			transformedArgs = append(transformedArgs, "--path", arg)
		}
		return transformedArgs
	default:
		return args
	}
}

// getFixedArgsForCDIHookCLI returns the fixed arguments for the hook CLI.
// If the nvidia-ctk binary is used, hooks are implemented under the hook
// subcommand.
// For the nvidia-cdi-hook binary, the hooks are implemented as subcommands of
// the top-level CLI.
func getFixedArgsForCDIHookCLI(nvidiaCDIHookPath string) []string {
	base := filepath.Base(nvidiaCDIHookPath)
	if base == "nvidia-ctk" {
		return []string{base, "hook"}
	}
	return []string{base}
}