|
| 1 | +/** |
| 2 | +# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved. |
| 3 | +# |
| 4 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | +# you may not use this file except in compliance with the License. |
| 6 | +# You may obtain a copy of the License at |
| 7 | +# |
| 8 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | +# |
| 10 | +# Unless required by applicable law or agreed to in writing, software |
| 11 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | +# See the License for the specific language governing permissions and |
| 14 | +# limitations under the License. |
| 15 | +**/ |
| 16 | + |
| 17 | +package modifier |
| 18 | + |
| 19 | +import ( |
| 20 | + "fmt" |
| 21 | + "strconv" |
| 22 | + "strings" |
| 23 | + |
| 24 | + "github.com/NVIDIA/go-nvml/pkg/nvml" |
| 25 | + "golang.org/x/mod/semver" |
| 26 | + |
| 27 | + "github.com/NVIDIA/nvidia-container-toolkit/internal/config/image" |
| 28 | + "github.com/NVIDIA/nvidia-container-toolkit/internal/cuda" |
| 29 | + "github.com/NVIDIA/nvidia-container-toolkit/internal/logger" |
| 30 | + "github.com/NVIDIA/nvidia-container-toolkit/internal/lookup/root" |
| 31 | + "github.com/NVIDIA/nvidia-container-toolkit/internal/requirements" |
| 32 | +) |
| 33 | + |
| 34 | +// checkRequirements evaluates NVIDIA_REQUIRE_* constraints using the host |
| 35 | +// CUDA driver API version from libcuda, the NVIDIA display driver version from |
| 36 | +// the driver root (libcuda / libnvidia-ml soname), the compute capability of |
| 37 | +// CUDA device 0, and (when requirements reference brand) the GPU product brand |
| 38 | +// from NVML. It is used for CSV and CDI / JIT-CDI modes. |
| 39 | +func checkRequirements(logger logger.Interface, image *image.CUDA, driver *root.Driver) error { |
| 40 | + if image == nil || image.HasDisableRequire() { |
| 41 | + logger.Debugf("NVIDIA_DISABLE_REQUIRE=%v; skipping requirement checks", true) |
| 42 | + return nil |
| 43 | + } |
| 44 | + |
| 45 | + imageRequirements, err := image.GetRequirements() |
| 46 | + if err != nil { |
| 47 | + return fmt.Errorf("failed to get image requirements: %v", err) |
| 48 | + } |
| 49 | + if len(imageRequirements) == 0 { |
| 50 | + return nil |
| 51 | + } |
| 52 | + |
| 53 | + r := requirements.New(logger, imageRequirements) |
| 54 | + |
| 55 | + cudaVersion, err := cuda.Version() |
| 56 | + if err != nil { |
| 57 | + logger.Warningf("Failed to get CUDA version: %v", err) |
| 58 | + } else { |
| 59 | + r.AddVersionProperty(requirements.CUDA, cudaVersion) |
| 60 | + } |
| 61 | + |
| 62 | + compteCapability, err := cuda.ComputeCapability(0) |
| 63 | + if err != nil { |
| 64 | + logger.Warningf("Failed to get CUDA Compute Capability: %v", err) |
| 65 | + } else { |
| 66 | + r.AddVersionProperty(requirements.ARCH, compteCapability) |
| 67 | + } |
| 68 | + |
| 69 | + driverVersion, err := driver.Version() |
| 70 | + if err != nil { |
| 71 | + logger.Warningf("Failed to get NVIDIA driver version: %v", err) |
| 72 | + } else { |
| 73 | + normalized, normErr := normalizeDriverVersionForSemver(driverVersion) |
| 74 | + if normErr != nil { |
| 75 | + logger.Warningf("NVIDIA driver version %q is not semver-normalizable: %v", driverVersion, normErr) |
| 76 | + } else { |
| 77 | + r.AddVersionProperty(requirements.DRIVER, normalized) |
| 78 | + } |
| 79 | + } |
| 80 | + |
| 81 | + brand, err := getBrandFromNVML(driver) |
| 82 | + if err != nil { |
| 83 | + logger.Warningf("Failed to get GPU brand from NVML: %v", err) |
| 84 | + } else { |
| 85 | + r.AddStringProperty(requirements.BRAND, brand) |
| 86 | + } |
| 87 | + |
| 88 | + return r.Assert() |
| 89 | +} |
| 90 | + |
| 91 | +// normalizeDriverVersionForSemver converts a driver version taken from a |
| 92 | +// libcuda / libnvidia-ml soname suffix into a form accepted by |
| 93 | +// golang.org/x/mod/semver (no leading zeros in numeric segments) |
| 94 | +func normalizeDriverVersionForSemver(raw string) (string, error) { |
| 95 | + raw = strings.TrimSpace(raw) |
| 96 | + if raw == "" { |
| 97 | + return "", fmt.Errorf("empty driver version") |
| 98 | + } |
| 99 | + parts := strings.Split(raw, ".") |
| 100 | + out := make([]string, 0, len(parts)) |
| 101 | + for _, p := range parts { |
| 102 | + if p == "" { |
| 103 | + return "", fmt.Errorf("empty version segment in %q", raw) |
| 104 | + } |
| 105 | + if strings.TrimLeft(p, "0123456789") != "" { |
| 106 | + return "", fmt.Errorf("non-numeric version segment %q in %q", p, raw) |
| 107 | + } |
| 108 | + n, err := strconv.ParseUint(p, 10, 64) |
| 109 | + if err != nil { |
| 110 | + return "", fmt.Errorf("invalid version segment %q in %q: %w", p, raw, err) |
| 111 | + } |
| 112 | + out = append(out, strconv.FormatUint(n, 10)) |
| 113 | + } |
| 114 | + normalized := strings.Join(out, ".") |
| 115 | + if !semver.IsValid("v" + normalized) { |
| 116 | + return "", fmt.Errorf("normalized driver version %q is not valid semver", normalized) |
| 117 | + } |
| 118 | + return normalized, nil |
| 119 | +} |
| 120 | + |
| 121 | +// getBrandFromNVML returns a lowercase brand token for the first visible GPU |
| 122 | +// (index 0), using NVML. When driver is non-nil, NVML is loaded from the |
| 123 | +// versioned libnvidia-ml under the driver root when possible. |
| 124 | +func getBrandFromNVML(driver *root.Driver) (string, error) { |
| 125 | + var lib nvml.Interface |
| 126 | + var opts []nvml.LibraryOption |
| 127 | + v, err := driver.Version() |
| 128 | + if err == nil && v != "" && v != "*.*" { |
| 129 | + paths, err := driver.Libraries().Locate("libnvidia-ml.so." + v) |
| 130 | + if err == nil && len(paths) > 0 { |
| 131 | + opts = append(opts, nvml.WithLibraryPath(paths[0])) |
| 132 | + } |
| 133 | + } |
| 134 | + |
| 135 | + lib = nvml.New(opts...) |
| 136 | + if ret := lib.Init(); ret != nvml.SUCCESS { |
| 137 | + return "", fmt.Errorf("nvml.Init: %s", lib.ErrorString(ret)) |
| 138 | + } |
| 139 | + defer func() { |
| 140 | + _ = lib.Shutdown() |
| 141 | + }() |
| 142 | + |
| 143 | + device, ret := lib.DeviceGetHandleByIndex(0) |
| 144 | + if ret != nvml.SUCCESS { |
| 145 | + return "", fmt.Errorf("nvml.DeviceGetHandleByIndex(0): %s", lib.ErrorString(ret)) |
| 146 | + } |
| 147 | + |
| 148 | + brandType, ret := lib.DeviceGetBrand(device) |
| 149 | + if ret != nvml.SUCCESS { |
| 150 | + return "", fmt.Errorf("nvml.DeviceGetBrand: %s", lib.ErrorString(ret)) |
| 151 | + } |
| 152 | + brand, ok := brandTypeToRequirementString(brandType) |
| 153 | + if !ok { |
| 154 | + return "", fmt.Errorf("unknown NVML brand type %v", brandType) |
| 155 | + } |
| 156 | + return brand, nil |
| 157 | +} |
| 158 | + |
| 159 | +// brandTypeToRequirementString maps NVML brand enums to lowercase tokens |
| 160 | +// consistent with typical NVIDIA_REQUIRE_* image constraints. |
| 161 | +func brandTypeToRequirementString(b nvml.BrandType) (string, bool) { |
| 162 | + switch b { |
| 163 | + case nvml.BRAND_UNKNOWN: |
| 164 | + return "", false |
| 165 | + case nvml.BRAND_QUADRO: |
| 166 | + return "quadro", true |
| 167 | + case nvml.BRAND_TESLA: |
| 168 | + return "tesla", true |
| 169 | + case nvml.BRAND_NVS: |
| 170 | + return "nvs", true |
| 171 | + case nvml.BRAND_GRID: |
| 172 | + return "grid", true |
| 173 | + case nvml.BRAND_GEFORCE: |
| 174 | + return "geforce", true |
| 175 | + case nvml.BRAND_TITAN: |
| 176 | + return "titan", true |
| 177 | + case nvml.BRAND_NVIDIA_VAPPS: |
| 178 | + return "nvidiavapps", true |
| 179 | + case nvml.BRAND_NVIDIA_VPC: |
| 180 | + return "nvidiavpc", true |
| 181 | + case nvml.BRAND_NVIDIA_VCS: |
| 182 | + return "nvidiavcs", true |
| 183 | + case nvml.BRAND_NVIDIA_VWS: |
| 184 | + return "nvidiavws", true |
| 185 | + case nvml.BRAND_NVIDIA_CLOUD_GAMING: |
| 186 | + return "nvidiacloudgaming", true |
| 187 | + case nvml.BRAND_QUADRO_RTX: |
| 188 | + return "quadrortx", true |
| 189 | + case nvml.BRAND_NVIDIA_RTX: |
| 190 | + return "nvidiartx", true |
| 191 | + case nvml.BRAND_NVIDIA: |
| 192 | + return "nvidia", true |
| 193 | + case nvml.BRAND_GEFORCE_RTX: |
| 194 | + return "geforcertx", true |
| 195 | + case nvml.BRAND_TITAN_RTX: |
| 196 | + return "titanrtx", true |
| 197 | + default: |
| 198 | + return "", false |
| 199 | + } |
| 200 | +} |
0 commit comments