generic-linux-gpu: add module

2025-12-09 10:31:06 +01:00 · 2025-10-22 19:01:48 +02:00 · 2025-10-22 19:01:48 +02:00 · 193e44d316
commit 193e44d316
parent 066874efb5
10 changed files with 332 additions and 1 deletions
--- a/modules/targets/generic-linux/gpu/default.nix
+++ b/modules/targets/generic-linux/gpu/default.nix
@ -0,0 +1,155 @@
+{
+  config,
+  lib,
+  pkgs,
+  ...
+}:
+
+{
+  options.targets.genericLinux.gpu =
+    let
+      inherit (lib)
+        mkOption
+        mkEnableOption
+        types
+        literalExpression
+        ;
+    in
+    {
+      enable = mkOption {
+        type = types.bool;
+        default = config.targets.genericLinux.enable && config.targets.genericLinux.nixGL.packages == null;
+        defaultText = literalExpression "config.targets.genericLinux.enable && config.targets.genericLinux.nixGL.packages == null";
+        example = true;
+        description = "Whether to enable GPU driver integration for non-NixOS systems.";
+      };
+
+      packages = mkOption {
+        type = types.attrs;
+        default = pkgs;
+        defaultText = literalExpression "pkgs";
+        description = "The Nixpkgs package set where drivers are taken from.";
+      };
+
+      nvidia = {
+        enable = mkEnableOption "proprietary Nvidia drivers";
+
+        version = mkOption {
+          type = types.nullOr (types.strMatching "[0-9]{3}\\.[0-9]{2,3}\\.[0-9]{2}");
+          default = null;
+          example = literalExpression "550.163.01";
+          description = ''
+            The exact version of Nvidia drivers to use. This version **must**
+            match the version of the driver used by the host OS.
+          '';
+        };
+
+        sha256 = mkOption {
+          type = types.nullOr (types.strMatching "sha256-.*=");
+          default = null;
+          example = literalExpression "sha256-hfK1D5EiYcGRegss9+H5dDr/0Aj9wPIJ9NVWP3dNUC0=";
+          description = ''
+            The hash of the downloaded driver file. It can be obtained by
+            running, for example,
+
+            ```sh
+            nix store prefetch-file https://download.nvidia.com/XFree86/Linux-x86_64/@VERSION@/NVIDIA-Linux-x86_64-@VERSION@.run
+            ```
+
+            where `@VERSION@` is replaced with the exact driver version.
+            If you are on ARM, replace Linux-x86_64 with Linux-aarch64.
+          '';
+        };
+      };
+
+      nixStateDirectory = mkOption {
+        type = types.path;
+        default = "/nix/var/nix";
+        example = "/var/lib/nix";
+        description = ''
+          The path to the Nix state directory. This only needs to be changed
+          from default if the path was overridden, e.g., by setting the
+          `NIX_STATE_DIR` environment variable.
+        '';
+      };
+    };
+
+  config =
+    let
+      cfg = config.targets.genericLinux.gpu;
+
+      # This builds the driver archive downloaded from download.nvidia.com
+      nvidia =
+        (cfg.packages.linuxPackages.nvidiaPackages.mkDriver {
+          version = cfg.nvidia.version;
+          sha256_64bit = cfg.nvidia.sha256;
+          sha256_aarch64 = cfg.nvidia.sha256;
+          useSettings = false;
+          usePersistenced = false;
+        }).override
+          {
+            libsOnly = true;
+            kernel = null;
+          };
+
+      drivers = cfg.packages.callPackage ./gpu-libs-env.nix {
+        addNvidia = cfg.nvidia.enable;
+        nvidia_x11 = nvidia; # Only used if addNvidia is enabled
+      };
+
+      setupPackage = cfg.packages.callPackage ./setup {
+        inherit (cfg) nixStateDirectory;
+        nonNixosGpuEnv = drivers;
+      };
+
+    in
+    lib.mkIf cfg.enable {
+      assertions = lib.optionals cfg.nvidia.enable [
+        {
+          assertion = !isNull cfg.nvidia.version;
+          message = ''
+            Nvidia proprietary driver is enabled, version must be given.
+            Please set targets.genericLinux.gpu.nvidia.version.
+          '';
+        }
+        {
+          assertion = !isNull cfg.nvidia.sha256;
+          message = ''
+            Nvidia proprietary driver is enabled, driver hash must be given.
+            Please set targets.genericLinux.gpu.nvidia.sha256.
+          '';
+        }
+      ];
+
+      warnings = lib.optional (config.targets.genericLinux.nixGL.packages != null) ''
+        Both targets.genericLinux.gpu and targets.genericLinux.nixGL are enabled.
+        This is an unsupported configuration. Only mix the two if you know what
+        you are doing!
+      '';
+
+      home.packages = [ setupPackage ];
+
+      home.activation.checkExistingGpuDrivers =
+        let
+          # Absolute path is needed for use with sudo which doesn't have the user's
+          # home environment.
+          setupPath = "${lib.getExe setupPackage}";
+        in
+        lib.hm.dag.entryAnywhere ''
+          existing=$(readlink /run/opengl-driver || true)
+          new=${drivers}
+          verboseEcho Existing drivers: ''${existing}
+          verboseEcho New drivers: ''${new}
+          if [[ -z "''${existing}" ]] ; then
+            warnEcho "This non-NixOS system is not yet set up to use the GPU"
+            warnEcho "with Nix packages. To set up GPU drivers, run"
+            warnEcho "  sudo ${setupPath}"
+          elif [[ "''${existing}" != "''${new}" ]] ; then
+            warnEcho "GPU drivers require an update, run"
+            warnEcho "  sudo ${setupPath}"
+          fi
+        '';
+    };
+
+  meta.maintainers = with lib.hm.maintainers; [ exzombie ];
+}