From 9ae791ca88125681ce8ecff320b4b97a558521f3 Mon Sep 17 00:00:00 2001 From: jaschutte <34577095+jaschutte@users.noreply.github.com> Date: Mon, 28 Jul 2025 13:01:40 +0200 Subject: [PATCH 1/2] Pin Nix GHC minor version Pins down the GHC version down to the minor version. As discussed in a PR in clash-cores (https://github.com/clash-lang/clash-cores/pull/44#discussion_r2230178489). Each supported GHC version is now postfixed with a minor version number. However the overlays are not. The last digit of the version number gets stripped when Nix imports an overlay. This way we can have one set of GHC version numbers pin down the right GHC version *and* import the right overlay. I `nix build .#clash-ghc` with all three versions succesfully. --- README.md | 2 +- flake.nix | 4 ++-- nix/overlay.nix | 4 +++- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8553482fe3..8478ea75b0 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,7 @@ Or [use Nix](https://nixos.org/nix/download.html) to get a shell with the `clash nix develop . # Start a dev shell with a specific GHC version -nix develop .#ghc961 +nix develop .#ghc9101 ``` You will need a modern version of nix with support for the new-style `nix` diff --git a/flake.nix b/flake.nix index 5bc52cb39c..c6f6284112 100644 --- a/flake.nix +++ b/flake.nix @@ -36,12 +36,12 @@ # The versions of GHC that we want to be able to build / develop against # within the nix environment. Since nix is lazy, only derivations for # versions of GHC which are used are actually evaluated. - ghcVersions = [ "ghc902" "ghc962" ]; + ghcVersions = [ "ghc964" "ghc982" "ghc9101" ]; # We pick a single version of GHC to use by default within nix. This is # probably cleaner than always having N copies of each package / app and # being forced to refer to them by their GHC version. - defaultGhcVersion = "ghc962"; + defaultGhcVersion = "ghc9101"; # Overlays are not per-system, so let's only compute them once. # For each version of GHC we produce a `pkgs.clashPackages-ghcVER`, e.g. diff --git a/nix/overlay.nix b/nix/overlay.nix index 40274a9f60..b7e92e453f 100644 --- a/nix/overlay.nix +++ b/nix/overlay.nix @@ -15,7 +15,9 @@ compilerVersion: final: prev: let # An overlay with the things we need to change for the specified GHC version. - ghcOverlay = import (./. + "/overlay-${compilerVersion}.nix") { + # The overlays are named without the GHC minor version, so we need to strip the last character from the version + strippedMinorVersion = builtins.substring 0 (builtins.stringLength compilerVersion - 1) compilerVersion; + ghcOverlay = import (./. + "/overlay-${strippedMinorVersion}.nix") { pkgs = prev; }; From dd48692cf72d1611067aa21bf4ad1e1fe9bca272 Mon Sep 17 00:00:00 2001 From: jaschutte <34577095+jaschutte@users.noreply.github.com> Date: Fri, 24 Oct 2025 13:05:35 +0200 Subject: [PATCH 2/2] Port overlays from master The overlay files themselves have changed a lot in master, from being renamed to having bugs in them be solved. --- nix/overlay-ghc902.nix | 33 --------- nix/overlay-ghc910.nix | 71 +++++++++++++++++++ nix/{overlay-ghc962.nix => overlay-ghc96.nix} | 34 +++++---- nix/overlay-ghc98.nix | 43 +++++++++++ nix/overlay.nix | 7 +- 5 files changed, 135 insertions(+), 53 deletions(-) delete mode 100644 nix/overlay-ghc902.nix create mode 100644 nix/overlay-ghc910.nix rename nix/{overlay-ghc962.nix => overlay-ghc96.nix} (64%) create mode 100644 nix/overlay-ghc98.nix diff --git a/nix/overlay-ghc902.nix b/nix/overlay-ghc902.nix deleted file mode 100644 index d64138de2b..0000000000 --- a/nix/overlay-ghc902.nix +++ /dev/null @@ -1,33 +0,0 @@ -{ pkgs }: -final: prev: -let - inherit (pkgs.haskell.lib) doJailbreak dontCheck markUnbroken; -in -{ - # Use an older version than the default in nixpkgs. Since rewrite-inspector - # is basically abandonware it catches fire with brick 1.0+. - brick = doJailbreak prev.brick_0_70_1; - - # Marked as broken in nixpkgs for this version of GHC. - docopt = markUnbroken prev.docopt; - - # Marked as broken in nixpkgs, since it specifies much older dependencies - # than the defaults in nixpkgs. - rewrite-inspector = doJailbreak (markUnbroken prev.rewrite-inspector); - - singletons = prev.callHackage "singletons" "3.0" { }; - - # Lower the version to match `singletons-th`. - singletons-base = prev.callHackage "singletons-base" "3.0" { }; - - # The versions on nixpkgs are too new for GHC 9.0.2, which doesn't have - # type level `Char` literals. - singletons-th = prev.callHackage "singletons-th" "3.0" { - inherit (final) th-desugar; - }; - - # We can't use newer than 1.12 here: we need singletons 3.x (due to the cabal - # file of `clash-testsuite`) but the changed `DConP` constructor in 1.13 - # stops `singletons-th` from building. - th-desugar = prev.callHackage "th-desugar" "1.12" { }; -} diff --git a/nix/overlay-ghc910.nix b/nix/overlay-ghc910.nix new file mode 100644 index 0000000000..19815b2674 --- /dev/null +++ b/nix/overlay-ghc910.nix @@ -0,0 +1,71 @@ +{ pkgs }: +final: prev: +let + inherit (pkgs.haskell.lib) dontCheck doJailbreak markUnbroken; +in +{ + # Use an older version than the default in nixpkgs. Since rewrite-inspector + # is basically abandonware it catches fire with brick 1.0+. + brick = doJailbreak prev.brick_0_70_1; + + # brick 0.70.1 requires vty < 6.0. + vty = doJailbreak (prev.callHackage "vty" "5.39" { }); + + # Relies on older versions of some libraries. + hint = doJailbreak prev.hint; + + # Marked as broken in nixpkgs, since it specifies much older dependencies + # than the defaults in nixpkgs. + rewrite-inspector = doJailbreak (markUnbroken prev.rewrite-inspector); + + # Requires some old versions of libraries, but still works. + derive-storable-plugin = doJailbreak prev.derive-storable-plugin; + + # Marken as broken, but compiles anyway. + hedgehog-fakedata = doJailbreak (markUnbroken prev.hedgehog-fakedata); + + # Fails on GHC 9.10 with: + # library/Text/Regex/PCRE/Heavy.hs:123: failure in expression `head $ scan [re|\s*entry (\d+) (\w+)\s*&?|] (" entry 1 hello &entry 2 hi" :: String)' + # expected: (" entry 1 hello &",["1","hello"]) + # but got: :55:1: warning: [GHC-63394] [-Wx-partial] + # ^ + # In the use of ‘head’ + # (imported from Prelude.Compat, but defined in GHC.Internal.List): + # "This is a partial function, it throws an error on empty lists. Use pattern matching, 'Data.List.uncons' or 'Data.Maybe.listToMaybe' instead. Consider refactoring to use "Data.List.NonEmpty"." + # (" entry 1 hello &",["1","hello"]) + + pcre-heavy = dontCheck prev.pcre-heavy; + + # Relies on older versions of text. + string-random = doJailbreak prev.string-random; + + # We need the newest version from nixpkgs for these packages. + singletons-base = prev.singletons-base_3_4; + + microstache = prev.microstache_1_0_3; + + th-desugar = prev.th-desugar_1_17; + + # We need a new tasty-flaky. The one from Hackage doesn't build for some weird + # reason.. + tasty-flaky = prev.callCabal2nix "tasty-flaky" (pkgs.fetchFromGitHub { + owner = "LaurentRDC"; + repo = "tasty-flaky"; + rev = "fc31a9d622c1eb60030a50152258a9bef785e365"; + sha256 = "sha256-irLM3aVMxpBgsM72ArulMXcoLY2glalVkG//Lrj2JBI="; + }) {}; + + tasty = prev.tasty_1_5; + + singletons-th = prev.singletons-th_3_4; + + # nixplgs doesn't include revision 1, changing dependency on template-haskell. + string-interpolate = pkgs.haskell.lib.compose.overrideCabal (drv: { + revision = "1"; + editedCabalFile = "sha256-oh0tR+LDFcVzQnm4kSrmhAU+P7wdai536d72Cvhzipg="; + }) (prev.callHackageDirect { + pkg = "string-interpolate"; + ver = "0.3.4.0"; + sha256 = "sha256-KA8P6cc6N7pZ9/ay3edcEGx4vpKtp+EY7tn8U1NrbG8="; + } { }); +} diff --git a/nix/overlay-ghc962.nix b/nix/overlay-ghc96.nix similarity index 64% rename from nix/overlay-ghc962.nix rename to nix/overlay-ghc96.nix index 9eb95a2b5e..a518da71fd 100644 --- a/nix/overlay-ghc962.nix +++ b/nix/overlay-ghc96.nix @@ -1,13 +1,18 @@ { pkgs }: final: prev: let - inherit (pkgs.haskell.lib) doJailbreak dontCheck markUnbroken; + inherit (pkgs.haskell.lib) doJailbreak markUnbroken dontCheck; in { # Use an older version than the default in nixpkgs. Since rewrite-inspector # is basically abandonware it catches fire with brick 1.0+. brick = doJailbreak prev.brick_0_70_1; + vty = prev.callHackage "vty" "5.39" { }; + + # Marked as broken in nixpkgs, since it needs on a newer hashable than the + # .cabal file currently uploaded to hackage. + concurrent-supply = doJailbreak (markUnbroken prev.concurrent-supply); # Use a branch with changes to support GHC 9.6.1. hint = @@ -25,28 +30,18 @@ in # than the defaults in nixpkgs. rewrite-inspector = doJailbreak (markUnbroken prev.rewrite-inspector); - # We want a version that matches with singletons-th, but the tests in here - # are also a bit flaky since GHC 9.6 isn't officially supported. - singletons-base = dontCheck prev.singletons-base_3_2; - - # Use a newer version than the default in nixpkgs. - singletons-th = prev.singletons-th_3_2; - # Needs a newer text than the .cabal file currently uploaded to hackage. string-qq = doJailbreak prev.string-qq; - # Needs a newer version than the default in nixpkgs. - th-desugar = prev.th-desugar_1_15; - # Needs a newer base than the .cabal file currently uploaded to hackage. vector-binary-instances = doJailbreak prev.vector-binary-instances; - # Use an older version than the default in nixpkgs. - th-abstraction = prev.th-abstraction_0_5_0_0; - # type-errors 0.2.0.2 is bounded on doctest >=0.16.0.1 && <0.22 doctest = prev.callHackage "doctest" "0.21.1" { }; + # Marken as broken, but compiles anyway. + hedgehog-fakedata = doJailbreak (markUnbroken prev.hedgehog-fakedata); + # We need a new tasty-flaky. The one from Hackage doesn't build for some weird # reason.. tasty-flaky = prev.callCabal2nix "tasty-flaky" (pkgs.fetchFromGitHub { @@ -55,4 +50,15 @@ in rev = "fc31a9d622c1eb60030a50152258a9bef785e365"; sha256 = "sha256-irLM3aVMxpBgsM72ArulMXcoLY2glalVkG//Lrj2JBI="; }) {}; + + # This version of tasty isn't available in the nix ghc96 package set + tasty = prev.callHackageDirect { + pkg = "tasty"; + ver = "1.5.3"; + sha256 = "sha256-Ogd8J4aHNeL+xmcRWuJeGBNaePyLs5yo1IoMzvWrVPY="; + } {}; + + # The tests (not the package itself!) require a tasty <1.5, which won't work as we pull in + # tasty 1.5.3. Solution: don't test! + time-compat = dontCheck prev.time-compat; } diff --git a/nix/overlay-ghc98.nix b/nix/overlay-ghc98.nix new file mode 100644 index 0000000000..6565462473 --- /dev/null +++ b/nix/overlay-ghc98.nix @@ -0,0 +1,43 @@ +{ pkgs }: +final: prev: +let + inherit (pkgs.haskell.lib) doJailbreak markUnbroken dontCheck; +in +{ + # Use an older version than the default in nixpkgs. Since rewrite-inspector + # is basically abandonware it catches fire with brick 1.0+. + brick = doJailbreak prev.brick_0_70_1; + + # brick 0.70.1 requires vty < 6.0. + vty = doJailbreak (prev.callHackage "vty" "5.39" { }); + + # Marked as broken in nixpkgs, since it specifies much older dependencies + # than the defaults in nixpkgs. + rewrite-inspector = doJailbreak (markUnbroken prev.rewrite-inspector); + + # Requires some old versions of libraries, but still works. + derive-storable-plugin = doJailbreak prev.derive-storable-plugin; + + # Marken as broken, but compiles anyway. + hedgehog-fakedata = doJailbreak (markUnbroken prev.hedgehog-fakedata); + + # We need a new tasty-flaky. The one from Hackage doesn't build for some weird + # reason.. + tasty-flaky = prev.callCabal2nix "tasty-flaky" (pkgs.fetchFromGitHub { + owner = "LaurentRDC"; + repo = "tasty-flaky"; + rev = "fc31a9d622c1eb60030a50152258a9bef785e365"; + sha256 = "sha256-irLM3aVMxpBgsM72ArulMXcoLY2glalVkG//Lrj2JBI="; + }) {}; + + # This version of tasty isn't available in the nix ghc96 package set + tasty = prev.callHackageDirect { + pkg = "tasty"; + ver = "1.5.3"; + sha256 = "sha256-Ogd8J4aHNeL+xmcRWuJeGBNaePyLs5yo1IoMzvWrVPY="; + } {}; + + # The tests (not the package itself!) require a tasty <1.5, which won't work as we pull in + # tasty 1.5.3. Solution: don't test! + time-compat = dontCheck prev.time-compat; +} diff --git a/nix/overlay.nix b/nix/overlay.nix index b7e92e453f..42b770fb10 100644 --- a/nix/overlay.nix +++ b/nix/overlay.nix @@ -77,11 +77,6 @@ let ''; }); - clash-cores = - hprev.callCabal2nixWithOptions "clash-cores" ../clash-cores "--flag nix" { - inherit (hfinal) clash-prelude; - }; - clash-cosim = let unmodified = @@ -194,7 +189,7 @@ let "clash-testsuite" ../tests "--flag workaround-ghc-mmap-crash" { - inherit (hfinal) clash-cores clash-ghc clash-lib clash-prelude; + inherit (hfinal) clash-ghc clash-lib clash-prelude; }; in unmodified.overrideAttrs (old: {