|
| 1 | +package main |
| 2 | + |
| 3 | +import ( |
| 4 | + "encoding/json" |
| 5 | + "fmt" |
| 6 | + "os" |
| 7 | + "path" |
| 8 | + "slices" |
| 9 | + "strings" |
| 10 | + |
| 11 | + log "github.com/sirupsen/logrus" |
| 12 | + "github.com/urfave/cli/v2" |
| 13 | +) |
| 14 | + |
| 15 | +const ( |
| 16 | + // LogFile is the path for logging |
| 17 | + LogFile = "/var/log/gpu-driver-util.log" |
| 18 | + // PCIDevicesRoot represents base path for all pci devices under sysfs |
| 19 | + PCIDevicesRoot = "/sys/bus/pci/devices" |
| 20 | + // NVIDIAVendorID represents the NVIDIA PCI vendor id |
| 21 | + NVIDIAVendorID = "0x10de" |
| 22 | + // PCIDeviceClassVGA represents the pci device class code for VGA devices |
| 23 | + PCIDeviceClassVGA = "0x030000" |
| 24 | + // PCIDeviceClassGPU represents the pci device class code for GPU devices |
| 25 | + PCIDeviceClassGPU = "0x030200" |
| 26 | + // DefaultSupportedGpusJsonPath represents the default install location of the supported-gpus.json file |
| 27 | + DefaultSupportedGpusJsonPath = "/usr/share/nvidia-driver-assistant/supported-gpus/supported-gpus.json" |
| 28 | + |
| 29 | + // DriverHintUnknown is used when the gpu device is not found in supported-gpus.json |
| 30 | + DriverHintUnknown = "unknown" |
| 31 | + // DriverHintOpenRequired is used when the gpu device compulsorily needs the OpenRM kernel modules |
| 32 | + DriverHintOpenRequired = "open-required" |
| 33 | + // DriverHintProprietaryRequired is used when the gpu device compulsorily needs the proprietary kernel modules |
| 34 | + DriverHintProprietaryRequired = "proprietary-required" |
| 35 | + // DriverHintAny is used when the gpu device can support either kernel module types |
| 36 | + DriverHintAny = "any-supported" |
| 37 | + |
| 38 | + // DriverFeatureKernelOpen indicates that the gpu device supports OpenRM |
| 39 | + DriverFeatureKernelOpen = "kernelopen" |
| 40 | + // DriverFeatureKernelGSPProprietary indicates that the gpu device has GSP RM and supports proprietary modules |
| 41 | + DriverFeatureKernelGSPProprietary = "gsp_proprietary_supported" |
| 42 | + |
| 43 | + // KernelModuleTypeOpen indicates the OpenRM Kernel Modules of the NVIDIA CUDA driver |
| 44 | + KernelModuleTypeOpen = "kernel-open" |
| 45 | + // KernelModuleTypeProprietary indicates the Closed/Proprietary Kernel Modules of the NVIDIA CUDA driver |
| 46 | + KernelModuleTypeProprietary = "kernel" |
| 47 | +) |
| 48 | + |
| 49 | +var ( |
| 50 | + supportedGpusJsonPath string |
| 51 | + driverBranch int |
| 52 | +) |
| 53 | + |
| 54 | +type GPUDevice struct { |
| 55 | + ID string `json:"devid"` |
| 56 | + Name string `json:"name"` |
| 57 | + LegacyBranch string `json:"legacybranch"` |
| 58 | + Features []string `json:"features"` |
| 59 | +} |
| 60 | + |
| 61 | +type GPUData struct { |
| 62 | + Chips []GPUDevice `json:"chips"` |
| 63 | +} |
| 64 | + |
| 65 | +func main() { |
| 66 | + logFile, err := initializeLogger() |
| 67 | + if err != nil { |
| 68 | + log.Fatal(err.Error()) |
| 69 | + } |
| 70 | + defer logFile.Close() |
| 71 | + |
| 72 | + // Create the top-level CLI app |
| 73 | + c := cli.NewApp() |
| 74 | + c.Name = "gpu-driver-util" |
| 75 | + c.Usage = "NVIDIA GPU Driver Utility Application" |
| 76 | + c.Version = "0.1.0" |
| 77 | + |
| 78 | + getKernelModule := cli.Command{} |
| 79 | + getKernelModule.Name = "get-kernel-module-type" |
| 80 | + getKernelModule.Usage = "Automatically determine the kernel module type based on the GPUs detected." |
| 81 | + getKernelModule.Action = func(c *cli.Context) error { |
| 82 | + return GetKernelModule(c) |
| 83 | + } |
| 84 | + |
| 85 | + getKernelModuleFlags := []cli.Flag{ |
| 86 | + &cli.StringFlag{ |
| 87 | + Name: "supported-gpus-file", |
| 88 | + Aliases: []string{"f"}, |
| 89 | + Usage: "Specify location of the supported-gpus.json file", |
| 90 | + Value: DefaultSupportedGpusJsonPath, |
| 91 | + Destination: &supportedGpusJsonPath, |
| 92 | + Required: false, |
| 93 | + }, |
| 94 | + &cli.IntFlag{ |
| 95 | + Name: "driver-branch", |
| 96 | + Aliases: []string{"b"}, |
| 97 | + Usage: "Specify driver branch", |
| 98 | + EnvVars: []string{"DRIVER_BRANCH"}, |
| 99 | + Destination: &driverBranch, |
| 100 | + Required: true, |
| 101 | + }, |
| 102 | + } |
| 103 | + |
| 104 | + c.Commands = []*cli.Command{ |
| 105 | + &getKernelModule, |
| 106 | + } |
| 107 | + |
| 108 | + getKernelModule.Flags = append([]cli.Flag{}, getKernelModuleFlags...) |
| 109 | + |
| 110 | + // Run the top-level CLI |
| 111 | + if err := c.Run(os.Args); err != nil { |
| 112 | + log.Fatal(fmt.Errorf("error running gpu-driver-util: %w", err)) |
| 113 | + } |
| 114 | + |
| 115 | +} |
| 116 | + |
| 117 | +func initializeLogger() (*os.File, error) { |
| 118 | + logFile, err := os.OpenFile(LogFile, os.O_APPEND|os.O_CREATE|os.O_RDWR, 0666) |
| 119 | + if err != nil { |
| 120 | + return nil, fmt.Errorf("error opening file %s: %w", LogFile, err) |
| 121 | + } |
| 122 | + // Log as JSON instead of the default ASCII formatter. |
| 123 | + log.SetFormatter(&log.JSONFormatter{}) |
| 124 | + // Output to file instead of stdout |
| 125 | + log.SetOutput(logFile) |
| 126 | + |
| 127 | + // Only log the warning severity or above. |
| 128 | + log.SetLevel(log.DebugLevel) |
| 129 | + return logFile, nil |
| 130 | +} |
| 131 | + |
| 132 | +func GetKernelModule(c *cli.Context) error { |
| 133 | + log.Infof("Starting the 'get-kernel-module' command of %s", c.App.Name) |
| 134 | + gpuDevices, err := getNvidiaGPUs() |
| 135 | + if err != nil { |
| 136 | + return err |
| 137 | + } |
| 138 | + |
| 139 | + var gpuData GPUData |
| 140 | + gpuJSONString, err := os.ReadFile(supportedGpusJsonPath) |
| 141 | + if err != nil { |
| 142 | + log.Errorf("error opening the supported gpus file %s: %v", supportedGpusJsonPath, err) |
| 143 | + return err |
| 144 | + } |
| 145 | + |
| 146 | + err = json.Unmarshal(gpuJSONString, &gpuData) |
| 147 | + if err != nil { |
| 148 | + return err |
| 149 | + } |
| 150 | + |
| 151 | + searchMap := buildGPUSearchMap(gpuData) |
| 152 | + |
| 153 | + if len(gpuDevices) > 0 { |
| 154 | + kernelModuleType, err := resolveKernelModuleType(gpuDevices, searchMap) |
| 155 | + if err != nil { |
| 156 | + log.Errorf("error resolving kernel module type: %v", err) |
| 157 | + return err |
| 158 | + } |
| 159 | + fmt.Println(kernelModuleType) |
| 160 | + } |
| 161 | + return nil |
| 162 | +} |
| 163 | + |
| 164 | +func resolveKernelModuleType(gpuDevices []string, searchMap map[string]GPUDevice) (string, error) { |
| 165 | + |
| 166 | + driverHints := getDriverHints(gpuDevices, searchMap) |
| 167 | + log.Debugf("driverHints: %v", driverHints) |
| 168 | + |
| 169 | + // NOTE: driver hint "unknown" is assigned to a device that does not have an entry in supported-gpus.json. |
| 170 | + // In these cases, we assume that the gpu device is new and unreleased, and we default to OpenRM |
| 171 | + requiresOpenRM := slices.Contains(driverHints, DriverHintOpenRequired) || slices.Contains(driverHints, DriverHintUnknown) |
| 172 | + requiresProprietary := slices.Contains(driverHints, DriverHintProprietaryRequired) |
| 173 | + |
| 174 | + if requiresOpenRM && requiresProprietary { |
| 175 | + return "", fmt.Errorf("unsupported GPU topology") |
| 176 | + } else if requiresOpenRM { |
| 177 | + return KernelModuleTypeOpen, nil |
| 178 | + } else if requiresProprietary { |
| 179 | + return KernelModuleTypeProprietary, nil |
| 180 | + } else { |
| 181 | + return getDriverBranchDefault(driverBranch), nil |
| 182 | + } |
| 183 | +} |
| 184 | + |
| 185 | +func getDriverHints(gpuDevices []string, searchMap map[string]GPUDevice) []string { |
| 186 | + var driverHints []string |
| 187 | + |
| 188 | + for _, gpuDevice := range gpuDevices { |
| 189 | + if val, ok := searchMap[gpuDevice]; ok { |
| 190 | + gpuFeatures := val.Features |
| 191 | + if slices.Contains(gpuFeatures, DriverFeatureKernelGSPProprietary) && |
| 192 | + slices.Contains(gpuFeatures, DriverFeatureKernelOpen) { |
| 193 | + driverHints = append(driverHints, DriverHintAny) |
| 194 | + } else if slices.Contains(gpuFeatures, DriverFeatureKernelOpen) { |
| 195 | + driverHints = append(driverHints, DriverHintOpenRequired) |
| 196 | + } else { |
| 197 | + driverHints = append(driverHints, DriverHintProprietaryRequired) |
| 198 | + } |
| 199 | + } else { |
| 200 | + driverHints = append(driverHints, DriverHintUnknown) |
| 201 | + } |
| 202 | + } |
| 203 | + return driverHints |
| 204 | +} |
| 205 | + |
| 206 | +func getDriverBranchDefault(driverBranch int) string { |
| 207 | + if driverBranch >= 560 { |
| 208 | + return KernelModuleTypeOpen |
| 209 | + } |
| 210 | + return KernelModuleTypeProprietary |
| 211 | +} |
| 212 | + |
| 213 | +func buildGPUSearchMap(data GPUData) map[string]GPUDevice { |
| 214 | + var gpuMap = make(map[string]GPUDevice) |
| 215 | + for _, gpuDevice := range data.Chips { |
| 216 | + gpuMap[gpuDevice.ID] = gpuDevice |
| 217 | + } |
| 218 | + return gpuMap |
| 219 | +} |
| 220 | + |
| 221 | +func getNvidiaGPUs() ([]string, error) { |
| 222 | + var nvDevices []string |
| 223 | + deviceDirs, err := os.ReadDir(PCIDevicesRoot) |
| 224 | + if err != nil { |
| 225 | + return nil, err |
| 226 | + } |
| 227 | + |
| 228 | + for _, device := range deviceDirs { |
| 229 | + vendor, err := os.ReadFile(path.Join(PCIDevicesRoot, device.Name(), "vendor")) |
| 230 | + if err != nil { |
| 231 | + return nil, fmt.Errorf("failed to read pci device vendor name for %s: %w", device.Name(), err) |
| 232 | + } |
| 233 | + if strings.TrimSpace(string(vendor)) != NVIDIAVendorID { |
| 234 | + log.Debugf("Skipping device %s as it's not from the NVIDIA vendor", device.Name()) |
| 235 | + continue |
| 236 | + } |
| 237 | + class, err := os.ReadFile(path.Join(PCIDevicesRoot, device.Name(), "class")) |
| 238 | + if err != nil { |
| 239 | + return nil, fmt.Errorf("failed to read pci device class name for %s: %w", device.Name(), err) |
| 240 | + } |
| 241 | + if strings.TrimSpace(string(class)) != PCIDeviceClassVGA && strings.TrimSpace(string(class)) != PCIDeviceClassGPU { |
| 242 | + log.Debugf("Skipping NVIDIA device %s as it's not of VGA/GPU device class", device.Name()) |
| 243 | + continue |
| 244 | + } |
| 245 | + deviceID, err := os.ReadFile(path.Join(PCIDevicesRoot, device.Name(), "device")) |
| 246 | + if err != nil { |
| 247 | + return nil, fmt.Errorf("failed to read pci device id for %s: %w", device.Name(), err) |
| 248 | + } |
| 249 | + nvDevices = append(nvDevices, strings.TrimSpace(string(deviceID))) |
| 250 | + } |
| 251 | + return nvDevices, nil |
| 252 | +} |
0 commit comments