mirror of
https://github.com/NVIDIA/nvidia-container-toolkit
synced 2024-11-22 08:18:32 +00:00
Merge branch 'CNT-3937/add-target-driver-root' into 'main'
Add a driver root transformer to nvcdi See merge request nvidia/container-toolkit/container-toolkit!300
This commit is contained in:
Christopher Desiniotis
commit
1e9b7883cf
24
pkg/nvcdi/transform/api.go
Normal file
24
pkg/nvcdi/transform/api.go
Normal file
@ -0,0 +1,24 @@
|
||||
/**
|
||||
# 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 transform
|
||||
|
||||
import "github.com/container-orchestrated-devices/container-device-interface/specs-go"
|
||||
|
||||
// Transformer defines the API for applying arbitrary transforms to a spec in-place
|
||||
type Transformer interface {
|
||||
Transform(*specs.Spec) error
|
||||
}
|
||||
35
pkg/nvcdi/transform/no-op.go
Normal file
35
pkg/nvcdi/transform/no-op.go
Normal file
@ -0,0 +1,35 @@
|
||||
/**
|
||||
# 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 transform
|
||||
|
||||
import (
|
||||
"github.com/container-orchestrated-devices/container-device-interface/specs-go"
|
||||
)
|
||||
|
||||
type noop struct{}
|
||||
|
||||
var _ Transformer = (*noop)(nil)
|
||||
|
||||
// NewNoopTransformer returns a no-op transformer
|
||||
func NewNoopTransformer() Transformer {
|
||||
return noop{}
|
||||
}
|
||||
|
||||
// Transform is a no-op
|
||||
func (n noop) Transform(spec *specs.Spec) error {
|
||||
return nil
|
||||
}
|
||||
113
pkg/nvcdi/transform/root.go
Normal file
113
pkg/nvcdi/transform/root.go
Normal file
@ -0,0 +1,113 @@
|
||||
/**
|
||||
# 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 transform
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
|
||||
"github.com/container-orchestrated-devices/container-device-interface/specs-go"
|
||||
)
|
||||
|
||||
type rootTransformer struct {
|
||||
root string
|
||||
targetRoot string
|
||||
}
|
||||
|
||||
var _ Transformer = (*rootTransformer)(nil)
|
||||
|
||||
// NewRootTransformer creates a new transformer for modifying
|
||||
// the root for paths in a CDI spec. If both roots are identical,
|
||||
// this tranformer is a no-op.
|
||||
func NewRootTransformer(root string, targetRoot string) Transformer {
|
||||
if root == targetRoot {
|
||||
return NewNoopTransformer()
|
||||
}
|
||||
|
||||
t := rootTransformer{
|
||||
root: root,
|
||||
targetRoot: targetRoot,
|
||||
}
|
||||
return t
|
||||
}
|
||||
|
||||
// Transform replaces the root in a spec with a new root.
|
||||
// It walks the spec and replaces all host paths that start with root with the target root.
|
||||
func (t rootTransformer) Transform(spec *specs.Spec) error {
|
||||
if spec == nil {
|
||||
return nil
|
||||
}
|
||||
|
||||
for _, d := range spec.Devices {
|
||||
if err := t.applyToEdits(&d.ContainerEdits); err != nil {
|
||||
return fmt.Errorf("failed to apply root transform to device %s: %w", d.Name, err)
|
||||
}
|
||||
}
|
||||
|
||||
if err := t.applyToEdits(&spec.ContainerEdits); err != nil {
|
||||
return fmt.Errorf("failed to apply root transform to spec: %w", err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (t rootTransformer) applyToEdits(edits *specs.ContainerEdits) error {
|
||||
for i, dn := range edits.DeviceNodes {
|
||||
dn.HostPath = t.transformPath(dn.HostPath)
|
||||
edits.DeviceNodes[i] = dn
|
||||
}
|
||||
|
||||
for i, hook := range edits.Hooks {
|
||||
hook.Path = t.transformPath(hook.Path)
|
||||
|
||||
var args []string
|
||||
for _, arg := range hook.Args {
|
||||
if !strings.Contains(arg, "::") {
|
||||
args = append(args, t.transformPath(arg))
|
||||
continue
|
||||
}
|
||||
|
||||
// For the 'create-symlinks' hook, special care is taken for the
|
||||
// '--link' flag argument which takes the form <target>::<link>.
|
||||
// Both paths, the target and link paths, are transformed.
|
||||
split := strings.Split(arg, "::")
|
||||
if len(split) != 2 {
|
||||
return fmt.Errorf("unexpected number of '::' separators in hook argument")
|
||||
}
|
||||
split[0] = t.transformPath(split[0])
|
||||
split[1] = t.transformPath(split[1])
|
||||
args = append(args, strings.Join(split, "::"))
|
||||
}
|
||||
hook.Args = args
|
||||
edits.Hooks[i] = hook
|
||||
}
|
||||
|
||||
for i, mount := range edits.Mounts {
|
||||
mount.HostPath = t.transformPath(mount.HostPath)
|
||||
edits.Mounts[i] = mount
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (t rootTransformer) transformPath(path string) string {
|
||||
if !strings.HasPrefix(path, t.root) {
|
||||
return path
|
||||
}
|
||||
|
||||
return filepath.Join(t.targetRoot, strings.TrimPrefix(path, t.root))
|
||||
}
|
||||
162
pkg/nvcdi/transform/root_test.go
Normal file
162
pkg/nvcdi/transform/root_test.go
Normal file
@ -0,0 +1,162 @@
|
||||
/**
|
||||
# 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 transform
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/container-orchestrated-devices/container-device-interface/specs-go"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
func TestRootTransformer(t *testing.T) {
|
||||
testCases := []struct {
|
||||
description string
|
||||
root string
|
||||
targetRoot string
|
||||
spec *specs.Spec
|
||||
expectedSpec *specs.Spec
|
||||
}{
|
||||
{
|
||||
description: "nil spec",
|
||||
root: "/root",
|
||||
targetRoot: "/target-root",
|
||||
spec: nil,
|
||||
expectedSpec: nil,
|
||||
},
|
||||
{
|
||||
description: "empty spec",
|
||||
root: "/root",
|
||||
targetRoot: "/target-root",
|
||||
spec: &specs.Spec{},
|
||||
expectedSpec: &specs.Spec{},
|
||||
},
|
||||
{
|
||||
description: "device nodes",
|
||||
root: "/root",
|
||||
targetRoot: "/target-root",
|
||||
spec: &specs.Spec{
|
||||
ContainerEdits: specs.ContainerEdits{
|
||||
DeviceNodes: []*specs.DeviceNode{
|
||||
{HostPath: "/root/dev/nvidia0", Path: "/root/dev/nvidia0"},
|
||||
{HostPath: "/target-root/dev/nvidia1", Path: "/target-root/dev/nvidia1"},
|
||||
{HostPath: "/different-root/dev/nvidia2", Path: "/different-root/dev/nvidia2"},
|
||||
},
|
||||
},
|
||||
},
|
||||
expectedSpec: &specs.Spec{
|
||||
ContainerEdits: specs.ContainerEdits{
|
||||
DeviceNodes: []*specs.DeviceNode{
|
||||
{HostPath: "/target-root/dev/nvidia0", Path: "/root/dev/nvidia0"},
|
||||
{HostPath: "/target-root/dev/nvidia1", Path: "/target-root/dev/nvidia1"},
|
||||
{HostPath: "/different-root/dev/nvidia2", Path: "/different-root/dev/nvidia2"},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
description: "mounts",
|
||||
root: "/root",
|
||||
targetRoot: "/target-root",
|
||||
spec: &specs.Spec{
|
||||
ContainerEdits: specs.ContainerEdits{
|
||||
Mounts: []*specs.Mount{
|
||||
{HostPath: "/root/lib/lib1.so", ContainerPath: "/root/lib/lib1.so"},
|
||||
{HostPath: "/target-root/lib/lib2.so", ContainerPath: "/target-root/lib/lib2.so"},
|
||||
{HostPath: "/different-root/lib/lib3.so", ContainerPath: "/different-root/lib/lib3.so"},
|
||||
},
|
||||
},
|
||||
},
|
||||
expectedSpec: &specs.Spec{
|
||||
ContainerEdits: specs.ContainerEdits{
|
||||
Mounts: []*specs.Mount{
|
||||
{HostPath: "/target-root/lib/lib1.so", ContainerPath: "/root/lib/lib1.so"},
|
||||
{HostPath: "/target-root/lib/lib2.so", ContainerPath: "/target-root/lib/lib2.so"},
|
||||
{HostPath: "/different-root/lib/lib3.so", ContainerPath: "/different-root/lib/lib3.so"},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
description: "hooks",
|
||||
root: "/root",
|
||||
targetRoot: "/target-root",
|
||||
spec: &specs.Spec{
|
||||
ContainerEdits: specs.ContainerEdits{
|
||||
Hooks: []*specs.Hook{
|
||||
{
|
||||
Path: "/root/usr/bin/nvidia-ctk",
|
||||
Args: []string{
|
||||
"--link",
|
||||
"/root/path/to/target::/root/path/to/link",
|
||||
},
|
||||
},
|
||||
{
|
||||
Path: "/target-root/usr/bin/nvidia-ctk",
|
||||
Args: []string{
|
||||
"--link",
|
||||
"/target-root/path/to/target::/target-root/path/to/link",
|
||||
},
|
||||
},
|
||||
{
|
||||
Path: "/different-root/usr/bin/nvidia-ctk",
|
||||
Args: []string{
|
||||
"--link",
|
||||
"/different-root/path/to/target::/different-root/path/to/link",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
expectedSpec: &specs.Spec{
|
||||
ContainerEdits: specs.ContainerEdits{
|
||||
Hooks: []*specs.Hook{
|
||||
{
|
||||
Path: "/target-root/usr/bin/nvidia-ctk",
|
||||
Args: []string{
|
||||
"--link",
|
||||
"/target-root/path/to/target::/target-root/path/to/link",
|
||||
},
|
||||
},
|
||||
{
|
||||
Path: "/target-root/usr/bin/nvidia-ctk",
|
||||
Args: []string{
|
||||
"--link",
|
||||
"/target-root/path/to/target::/target-root/path/to/link",
|
||||
},
|
||||
},
|
||||
{
|
||||
Path: "/different-root/usr/bin/nvidia-ctk",
|
||||
Args: []string{
|
||||
"--link",
|
||||
"/different-root/path/to/target::/different-root/path/to/link",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tc := range testCases {
|
||||
t.Run(tc.description, func(t *testing.T) {
|
||||
err := NewRootTransformer(tc.root, tc.targetRoot).Transform(tc.spec)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, tc.spec, tc.expectedSpec)
|
||||
})
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user