s/hadrianEvalPackages/toolEvalPackages and add comments

Author: hamishmack

ci.nix

@@ -155,7 +155,7 @@ dimension "Nixpkgs version" nixpkgsVersions (nixpkgsName: pinnedNixpkgsSrc:
             build = import ./build.nix { inherit pkgs evalPackages ifdLevel compiler-nix-name haskellNix; };
         in pkgs.recurseIntoAttrs (pkgs.lib.optionalAttrs (ifdLevel >= 1) ({
             roots = pkgs.haskell-nix.roots' { inherit compiler-nix-name evalPackages; } ifdLevel // {
-              ghc = pkgs.buildPackages.haskell-nix.compiler.${compiler-nix-name}.override { hadrianEvalPackages = evalPackages; };
+              ghc = pkgs.buildPackages.haskell-nix.compiler.${compiler-nix-name}.override { toolEvalPackages = evalPackages; };
             };
             # TODO: look into cross compiling ghc itself
             # ghc = pkgs.haskell-nix.compiler.${compiler-nix-name};

compiler/ghc/default.nix

@@ -86,7 +86,16 @@ let self =
 # extra values we want to have available as passthru values.
 , extra-passthru ? {}
 
-, hadrianEvalPackages ? buildPackages
+# For running IFDs (used to evaluate build plans of tools involved in building GHC).
+#
+# Currently used for:
+#   * hadrian
+#   * libffi-wasm
+#   * cabal (if we start using `cabal` to build GHC)
+#
+# We use this instead of `buildPackages` so that plan evaluation
+# can work on platforms other than the `buildPlatform`.
+, toolEvalPackages ? buildPackages, toolEvalPackages ? buildPackages
 }@args:
 
 assert !(enableIntegerSimple || enableNativeBignum) -> gmp != null;
@@ -104,7 +113,7 @@ let
   inherit (haskell-nix.haskellLib) isCrossTarget;
 
   ghc = if bootPkgs.ghc.isHaskellNixCompiler or false
-    then bootPkgs.ghc.override { inherit hadrianEvalPackages; }
+    then bootPkgs.ghc.override { inherit toolEvalPackages; }
     else bootPkgs.ghc;
 
   ghcHasNativeBignum = builtins.compareVersions ghc-version "9.0" >= 0;
@@ -125,7 +134,7 @@ let
       nativeBuildInputs = [
         (buildPackages.haskell-nix.tool "ghc912" "libffi-wasm" {
           src = buildPackages.haskell-nix.sources.libffi-wasm;
-          evalPackages = hadrianEvalPackages;
+          evalPackages = toolEvalPackages;
         })
         targetPackages.buildPackages.llvmPackages.clang
         targetPackages.buildPackages.llvmPackages.llvm
@@ -316,7 +325,7 @@ let
       inherit compiler-nix-name;
       name = "hadrian";
       compilerSelection = p: p.haskell.compiler;
-      evalPackages = hadrianEvalPackages;
+      evalPackages = toolEvalPackages;
       modules = [{
         reinstallableLibGhc = false;
         # Apply the patches in a way that does not require using something
@@ -887,7 +896,7 @@ haskell-nix.haskellLib.makeCompilerDeps (stdenv.mkDerivation (rec {
       disableLargeAddressSpace = true;
     });
   } // extra-passthru // {
-    buildGHC = extra-passthru.buildGHC.override { inherit hadrianEvalPackages; };
+    buildGHC = extra-passthru.buildGHC.override { inherit toolEvalPackages; };
   };
 
   meta = {

lib/call-cabal-project-to-nix.nix

@@ -14,7 +14,7 @@
 , cabalProjectLocal    ? null
 , cabalProjectFreeze   ? null
 , caller               ? "callCabalProjectToNix" # Name of the calling function for better warning messages
-, compilerSelection    ? p: builtins.mapAttrs (_: x: x.override { hadrianEvalPackages = evalPackages; }) p.haskell-nix.compiler
+, compilerSelection    ? p: builtins.mapAttrs (_: x: x.override { toolEvalPackages = evalPackages; }) p.haskell-nix.compiler
 , ghcOverride   ? null # Used when we need to set ghc explicitly during bootstrapping
 , configureArgs ? "" # Extra arguments to pass to `cabal v2-configure`.
                      # `--enable-tests --enable-benchmarks` are included by default.

modules/cabal-project.nix

@@ -22,7 +22,7 @@ in {
     };
     compilerSelection = mkOption {
       type = unspecified;
-      default = p: builtins.mapAttrs (_: x: x.override { hadrianEvalPackages = config.evalPackages; }) p.haskell-nix.compiler;
+      default = p: builtins.mapAttrs (_: x: x.override { toolEvalPackages = config.evalPackages; }) p.haskell-nix.compiler;
       description = "Use GHC from pkgs.haskell instead of pkgs.haskell-nix";
     };
     index-state = mkOption {

modules/hackage.nix

@@ -103,7 +103,7 @@ in
       (or it is not present at attribute '${config.compiler.nix-name})').
       Either switch to a version of Nixpkgs which does have this version, or use a version
       of GHC which the current version of Nixpkgs contains.
-    '')).override { hadrianEvalPackages = config.evalPackages; };
+    '')).override { toolEvalPackages = config.evalPackages; };
     defaultText = "pkgs.buildPackages.haskell-nix.compiler.\${config.compiler.nix-name}";
   };
 

overlays/haskell.nix

@@ -696,7 +696,7 @@ final: prev: {
                             then config.ghc
                           else
                             final.lib.mkDefault selectedCompiler;
-                        in if ghc.isHaskellNixCompiler or false then ghc.override { hadrianEvalPackages = evalPackages; } else ghc;
+                        in if ghc.isHaskellNixCompiler or false then ghc.override { toolEvalPackages = evalPackages; } else ghc;
                       compiler.nix-name = final.lib.mkForce config.compiler-nix-name;
                       evalPackages = final.lib.mkDefault evalPackages;
                     } ];
@@ -947,7 +947,7 @@ final: prev: {
                   modules = [ { _module.args.buildModules = final.lib.mkForce buildProject.pkg-set; }
                       (mkCacheModule cache) ]
                     ++ (config.modules or [])
-                    ++ final.lib.optional (config.ghc != null) { ghc.package = config.ghc.override { hadrianEvalPackages = evalPackages; }; }
+                    ++ final.lib.optional (config.ghc != null) { ghc.package = config.ghc.override { toolEvalPackages = evalPackages; }; }
                     ++ final.lib.optional (config.compiler-nix-name != null)
                         { compiler.nix-name = final.lib.mkForce config.compiler-nix-name; }
                     ++ [ { evalPackages = final.lib.mkDefault evalPackages; } ];
@@ -1151,7 +1151,7 @@ final: prev: {
 
         roots' = { compiler-nix-name, evalPackages ? final.pkgsBuildBuild }: ifdLevel:
           let
-            ghc = final.buildPackages.haskell-nix.compiler.${compiler-nix-name}.override { hadrianEvalPackages = evalPackages; };
+            ghc = final.buildPackages.haskell-nix.compiler.${compiler-nix-name}.override { toolEvalPackages = evalPackages; };
           in
             final.recurseIntoAttrs ({
             # Things that require no IFD to build

test/supported-langauges/default.nix

@@ -1,7 +1,7 @@
 { stdenv, pkgs, lib, recurseIntoAttrs, testSrc, compiler-nix-name, evalPackages, buildPackages }:
 
 let
-  ghc = buildPackages.haskell-nix.compiler.${compiler-nix-name}.override { hadrianEvalPackages = evalPackages; };
+  ghc = buildPackages.haskell-nix.compiler.${compiler-nix-name}.override { toolEvalPackages = evalPackages; };
 
   supported-langauges = import ../../lib/supported-languages.nix {
     inherit pkgs evalPackages ghc;