From 20ba2edc7daff7ee0d13874f1b2a2b373e899461 Mon Sep 17 00:00:00 2001 From: Aleksa Sarai Date: Thu, 2 Apr 2026 11:25:43 +1100 Subject: [PATCH] libct/devices: deprecate in favour of moby/sys/devices This package has been migrated to moby/sys/devices (as it was never used by runc internally) and so we can now deprecate it. Signed-off-by: Aleksa Sarai --- CHANGELOG.md | 3 + go.mod | 1 + go.sum | 2 + libcontainer/devices/device_unix.go | 106 ++------- libcontainer/devices/device_unix_test.go | 97 --------- libcontainer/devices/doc.go | 3 + vendor/github.com/moby/sys/devices/LICENSE | 202 ++++++++++++++++++ .../moby/sys/devices/device_unix.go | 133 ++++++++++++ vendor/github.com/moby/sys/devices/doc.go | 4 + vendor/modules.txt | 3 + 10 files changed, 368 insertions(+), 186 deletions(-) delete mode 100644 libcontainer/devices/device_unix_test.go create mode 100644 vendor/github.com/moby/sys/devices/LICENSE create mode 100644 vendor/github.com/moby/sys/devices/device_unix.go create mode 100644 vendor/github.com/moby/sys/devices/doc.go diff --git a/CHANGELOG.md b/CHANGELOG.md index 48b1eb9ea4b..f350f74a5ba 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,6 +15,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Deprecated ### - `EXTRA_BUILDTAGS` make variable is deprecated in favor of `RUNC_BUILDTAGS` and will be removed in runc 1.6. (#5171) +- `libcontainer/devices` has been deprecated in favour of + `github.com/moby/sys/devices` (which is a carbon copy of the package). It + will be removed in runc 1.7. ## [1.5.0-rc.1] - 2026-03-12 diff --git a/go.mod b/go.mod index 60fea199e16..92e3a02ef66 100644 --- a/go.mod +++ b/go.mod @@ -10,6 +10,7 @@ require ( github.com/docker/go-units v0.5.0 github.com/godbus/dbus/v5 v5.2.2 github.com/moby/sys/capability v0.4.0 + github.com/moby/sys/devices v0.1.0 github.com/moby/sys/mountinfo v0.7.2 github.com/moby/sys/user v0.4.0 github.com/moby/sys/userns v0.1.0 diff --git a/go.sum b/go.sum index 64f54fa1262..aa7fee04bab 100644 --- a/go.sum +++ b/go.sum @@ -38,6 +38,8 @@ github.com/mdlayher/socket v0.4.1 h1:eM9y2/jlbs1M615oshPQOHZzj6R6wMT7bX5NPiQvn2U github.com/mdlayher/socket v0.4.1/go.mod h1:cAqeGjoufqdxWkD7DkpyS+wcefOtmu5OQ8KuoJGIReA= github.com/moby/sys/capability v0.4.0 h1:4D4mI6KlNtWMCM1Z/K0i7RV1FkX+DBDHKVJpCndZoHk= github.com/moby/sys/capability v0.4.0/go.mod h1:4g9IK291rVkms3LKCDOoYlnV8xKwoDTpIrNEE35Wq0I= +github.com/moby/sys/devices v0.1.0 h1:uaMrDm1U3h0AwUDNWeT5lBV40v0eayt+VuukRbYn5K4= +github.com/moby/sys/devices v0.1.0/go.mod h1:nIV6AO7t0DY2ObAm1GfL4AX9mBRqzxzHwGfvNCR9lfI= github.com/moby/sys/mountinfo v0.7.2 h1:1shs6aH5s4o5H2zQLn796ADW1wMrIwHsyJ2v9KouLrg= github.com/moby/sys/mountinfo v0.7.2/go.mod h1:1YOa8w8Ih7uW0wALDUgT1dTTSBrZ+HiBLGws92L2RU4= github.com/moby/sys/user v0.4.0 h1:jhcMKit7SA80hivmFJcbB1vqmw//wU61Zdui2eQXuMs= diff --git a/libcontainer/devices/device_unix.go b/libcontainer/devices/device_unix.go index 4489663b29f..beb48b14f54 100644 --- a/libcontainer/devices/device_unix.go +++ b/libcontainer/devices/device_unix.go @@ -3,111 +3,39 @@ package devices import ( - "errors" - "os" - "path/filepath" - + "github.com/moby/sys/devices" "github.com/opencontainers/cgroups/devices/config" - "golang.org/x/sys/unix" ) // ErrNotADevice denotes that a file is not a valid linux device. -var ErrNotADevice = errors.New("not a device node") - -// Testing dependencies -var ( - unixLstat = unix.Lstat - osReadDir = os.ReadDir -) +// +// Deprecated: This package will be removed in runc 1.7, use +// [devices.ErrNotADevice] instead. +var ErrNotADevice = devices.ErrNotADevice // DeviceFromPath takes the path to a device and its cgroup_permissions (which // cannot be easily queried) to look up the information about a linux device // and returns that information as a Device struct. +// +// Deprecated: This package will be removed in runc 1.7, use +// [devices.DeviceFromPath] instead. func DeviceFromPath(path, permissions string) (*config.Device, error) { - var stat unix.Stat_t - err := unixLstat(path, &stat) - if err != nil { - return nil, err - } - - var ( - devType config.Type - mode = stat.Mode - devNumber = uint64(stat.Rdev) //nolint:unconvert // Rdev is uint32 on e.g. MIPS. - major = unix.Major(devNumber) - minor = unix.Minor(devNumber) - ) - switch mode & unix.S_IFMT { - case unix.S_IFBLK: - devType = config.BlockDevice - case unix.S_IFCHR: - devType = config.CharDevice - case unix.S_IFIFO: - devType = config.FifoDevice - default: - return nil, ErrNotADevice - } - return &config.Device{ - Rule: config.Rule{ - Type: devType, - Major: int64(major), - Minor: int64(minor), - Permissions: config.Permissions(permissions), - }, - Path: path, - FileMode: os.FileMode(mode &^ unix.S_IFMT), - Uid: stat.Uid, - Gid: stat.Gid, - }, nil + return devices.DeviceFromPath(path, permissions) } // HostDevices returns all devices that can be found under /dev directory. +// +// Deprecated: This package will be removed in runc 1.7, use +// [devices.HostDevices] instead. func HostDevices() ([]*config.Device, error) { - return GetDevices("/dev") + return devices.HostDevices() } // GetDevices recursively traverses a directory specified by path // and returns all devices found there. +// +// Deprecated: This package will be removed in runc 1.7, use +// [devices.GetDevices] instead. func GetDevices(path string) ([]*config.Device, error) { - files, err := osReadDir(path) - if err != nil { - return nil, err - } - var out []*config.Device - for _, f := range files { - switch { - case f.IsDir(): - switch f.Name() { - // ".lxc" & ".lxd-mounts" added to address https://github.com/lxc/lxd/issues/2825 - // ".udev" added to address https://github.com/opencontainers/runc/issues/2093 - case "pts", "shm", "fd", "mqueue", ".lxc", ".lxd-mounts", ".udev": - continue - default: - sub, err := GetDevices(filepath.Join(path, f.Name())) - if err != nil { - return nil, err - } - - out = append(out, sub...) - continue - } - case f.Name() == "console": - continue - } - device, err := DeviceFromPath(filepath.Join(path, f.Name()), "rwm") - if err != nil { - if errors.Is(err, ErrNotADevice) { - continue - } - if errors.Is(err, os.ErrNotExist) { - continue - } - return nil, err - } - if device.Type == config.FifoDevice { - continue - } - out = append(out, device) - } - return out, nil + return devices.GetDevices(path) } diff --git a/libcontainer/devices/device_unix_test.go b/libcontainer/devices/device_unix_test.go deleted file mode 100644 index 2b58605329d..00000000000 --- a/libcontainer/devices/device_unix_test.go +++ /dev/null @@ -1,97 +0,0 @@ -//go:build !windows - -package devices - -import ( - "errors" - "io/fs" - "os" - "testing" - - "github.com/opencontainers/cgroups/devices/config" - "golang.org/x/sys/unix" -) - -func cleanupTest() { - unixLstat = unix.Lstat - osReadDir = os.ReadDir -} - -func TestDeviceFromPathLstatFailure(t *testing.T) { - testError := errors.New("test error") - - // Override unix.Lstat to inject error. - unixLstat = func(path string, stat *unix.Stat_t) error { - return testError - } - defer cleanupTest() - - _, err := DeviceFromPath("", "") - if !errors.Is(err, testError) { - t.Fatalf("Unexpected error %v, expected %v", err, testError) - } -} - -func TestHostDevicesIoutilReadDirFailure(t *testing.T) { - testError := errors.New("test error") - - // Override os.ReadDir to inject error. - osReadDir = func(dirname string) ([]fs.DirEntry, error) { - return nil, testError - } - defer cleanupTest() - - _, err := HostDevices() - if !errors.Is(err, testError) { - t.Fatalf("Unexpected error %v, expected %v", err, testError) - } -} - -func TestHostDevicesIoutilReadDirDeepFailure(t *testing.T) { - testError := errors.New("test error") - called := false - - // Override os.ReadDir to inject error after the first call. - osReadDir = func(dirname string) ([]fs.DirEntry, error) { - if called { - return nil, testError - } - called = true - - // Provoke a second call. - fi, err := os.Lstat("/tmp") - if err != nil { - t.Fatalf("Unexpected error %v", err) - } - - return []fs.DirEntry{fs.FileInfoToDirEntry(fi)}, nil - } - defer cleanupTest() - - _, err := HostDevices() - if !errors.Is(err, testError) { - t.Fatalf("Unexpected error %v, expected %v", err, testError) - } -} - -func TestHostDevicesAllValid(t *testing.T) { - devices, err := HostDevices() - if err != nil { - t.Fatalf("failed to get host devices: %v", err) - } - - for _, device := range devices { - // Devices can't have major number 0. - if device.Major == 0 { - t.Errorf("device entry %+v has zero major number", device) - } - switch device.Type { - case config.BlockDevice, config.CharDevice: - case config.FifoDevice: - t.Logf("fifo devices shouldn't show up from HostDevices") - fallthrough - default: - t.Errorf("device entry %+v has unexpected type %v", device, device.Type) - } - } -} diff --git a/libcontainer/devices/doc.go b/libcontainer/devices/doc.go index a590f4495a2..42848b2b3e2 100644 --- a/libcontainer/devices/doc.go +++ b/libcontainer/devices/doc.go @@ -1,4 +1,7 @@ // Package devices provides some helper functions for constructing device // configurations for runc. These are exclusively used by higher-level runtimes // that need to configure runc's device list based on existing devices. +// +// Deprecated: This package will be removed in runc 1.7, please migrate to +// github.com/moby/sys/devices. package devices diff --git a/vendor/github.com/moby/sys/devices/LICENSE b/vendor/github.com/moby/sys/devices/LICENSE new file mode 100644 index 00000000000..d6456956733 --- /dev/null +++ b/vendor/github.com/moby/sys/devices/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/vendor/github.com/moby/sys/devices/device_unix.go b/vendor/github.com/moby/sys/devices/device_unix.go new file mode 100644 index 00000000000..bd401d3b752 --- /dev/null +++ b/vendor/github.com/moby/sys/devices/device_unix.go @@ -0,0 +1,133 @@ +//go:build !windows + +// SPDX-License-Identifier: Apache-2.0 +/* + * Copyright (C) 2015-2026 Open Containers Initiative Contributors + * + * 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. + */ + +// This code originally comes from runc and was taken from this tree: +// . + +package devices + +import ( + "errors" + "os" + "path/filepath" + + "github.com/opencontainers/cgroups/devices/config" + "golang.org/x/sys/unix" +) + +// ErrNotADevice denotes that a file is not a valid linux device. +var ErrNotADevice = errors.New("not a device node") + +// Testing dependencies +var ( + unixLstat = unix.Lstat + osReadDir = os.ReadDir +) + +// DeviceFromPath takes the path to a device and its cgroup_permissions (which +// cannot be easily queried) to look up the information about a linux device +// and returns that information as a Device struct. +func DeviceFromPath(path, permissions string) (*config.Device, error) { + var stat unix.Stat_t + err := unixLstat(path, &stat) + if err != nil { + return nil, err + } + + var ( + devType config.Type + mode = stat.Mode + devNumber = uint64(stat.Rdev) //nolint:unconvert // Rdev is uint32 on e.g. MIPS. + major = unix.Major(devNumber) + minor = unix.Minor(devNumber) + ) + switch mode & unix.S_IFMT { + case unix.S_IFBLK: + devType = config.BlockDevice + case unix.S_IFCHR: + devType = config.CharDevice + case unix.S_IFIFO: + devType = config.FifoDevice + default: + return nil, ErrNotADevice + } + return &config.Device{ + Rule: config.Rule{ + Type: devType, + Major: int64(major), + Minor: int64(minor), + Permissions: config.Permissions(permissions), + }, + Path: path, + FileMode: os.FileMode(mode &^ unix.S_IFMT), + Uid: stat.Uid, + Gid: stat.Gid, + }, nil +} + +// HostDevices returns all devices that can be found under /dev directory. +func HostDevices() ([]*config.Device, error) { + return GetDevices("/dev") +} + +// GetDevices recursively traverses a directory specified by path +// and returns all devices found there. +func GetDevices(path string) ([]*config.Device, error) { + files, err := osReadDir(path) + if err != nil { + return nil, err + } + var out []*config.Device + for _, f := range files { + switch { + case f.IsDir(): + switch f.Name() { + // ".lxc" & ".lxd-mounts" added to address https://github.com/lxc/lxd/issues/2825 + // ".udev" added to address https://github.com/opencontainers/runc/issues/2093 + case "pts", "shm", "fd", "mqueue", ".lxc", ".lxd-mounts", ".udev": + continue + default: + sub, err := GetDevices(filepath.Join(path, f.Name())) + if err != nil { + return nil, err + } + + out = append(out, sub...) + continue + } + case f.Name() == "console": + continue + } + device, err := DeviceFromPath(filepath.Join(path, f.Name()), "rwm") + if err != nil { + if errors.Is(err, ErrNotADevice) { + continue + } + if errors.Is(err, os.ErrNotExist) { + continue + } + return nil, err + } + if device.Type == config.FifoDevice { + continue + } + out = append(out, device) + } + return out, nil +} diff --git a/vendor/github.com/moby/sys/devices/doc.go b/vendor/github.com/moby/sys/devices/doc.go new file mode 100644 index 00000000000..a590f4495a2 --- /dev/null +++ b/vendor/github.com/moby/sys/devices/doc.go @@ -0,0 +1,4 @@ +// Package devices provides some helper functions for constructing device +// configurations for runc. These are exclusively used by higher-level runtimes +// that need to configure runc's device list based on existing devices. +package devices diff --git a/vendor/modules.txt b/vendor/modules.txt index 0b99ea298d7..40397344178 100644 --- a/vendor/modules.txt +++ b/vendor/modules.txt @@ -55,6 +55,9 @@ github.com/godbus/dbus/v5 # github.com/moby/sys/capability v0.4.0 ## explicit; go 1.21 github.com/moby/sys/capability +# github.com/moby/sys/devices v0.1.0 +## explicit; go 1.24 +github.com/moby/sys/devices # github.com/moby/sys/mountinfo v0.7.2 ## explicit; go 1.17 github.com/moby/sys/mountinfo