Add support for GHC 9.12

.ci/docker/build-and-publish-docker-image.sh

@@ -14,8 +14,8 @@ elif [[ "$1" != "" ]]; then
   exit 1
 fi
 UBUNTU_VERSION=jammy-20250126
-GHC_VERSIONS=("9.10.2" "9.8.4"  "9.6.7"  "9.4.8"  "9.2.8"   "9.0.2"   "8.10.7")
-CABAL_VERSIONS=("3.14.1.1" "3.14.1.1" "3.14.1.1" "3.14.1.1" "3.14.1.1" "3.14.1.1" "3.12.1.0")
+GHC_VERSIONS=("9.12.2"  "9.10.2" "9.8.4"  "9.6.7"  "9.4.8"  "9.2.8"   "9.0.2"   "8.10.7")
+CABAL_VERSIONS=("3.14.2.0"  "3.14.1.1" "3.14.1.1" "3.14.1.1" "3.14.1.1" "3.14.1.1" "3.14.1.1" "3.12.1.0")
 
 # We want to use docker buildkit so that our layers are built in parallel. This
 # is ignored completely on versions of docker which don't support buildkit.

.ci/gitlab/benchmark.yml

@@ -1,5 +1,5 @@
 .benchmark:
-  image: ghcr.io/clash-lang/clash-ci:$GHC_VERSION-20250719
+  image: ghcr.io/clash-lang/clash-ci:$GHC_VERSION-20250928
   stage: test
   timeout: 2 hours
   variables:

.ci/gitlab/common.yml

@@ -12,8 +12,8 @@ default:
   timeout: 10 minutes
   stage: build
   variables:
-    CLASH_DOCKER_TAG: 20250719
-    CACHE_BUST_TOKEN: 3
+    CLASH_DOCKER_TAG: 20250928
+    CACHE_BUST_TOKEN: 4
     # Note that we copy+paste the image name into CACHE_FALLBACK_KEY. If we don't,
     # $GHC_VERSION gets inserted at verbatim, instead of resolving to some ghc version.
     CACHE_FALLBACK_KEY: $CI_JOB_NAME-master-ghcr.io/clash-lang/clash-ci:$GHC_VERSION-$CLASH_DOCKER_TAG-$CACHE_BUST_TOKEN-3-non_protected

.ci/stack-9.12.yaml

@@ -0,0 +1,16 @@
+resolver: nightly-2025-09-28
+
+ghc-options:
+  "$locals": -Wall -Wcompat
+
+packages:
+- clash-prelude
+- clash-prelude-hedgehog
+- clash-lib
+- clash-lib-hedgehog
+- clash-ghc
+- tests
+
+extra-deps:
+  - QuickCheck-2.15.0.1@sha256:0cfd337bb9e6fbf09255bd24bb498a156f1d9bcd465396ac8657b25034b9ee31,9046
+  - tasty-flaky-0.1.2.0@sha256:2f91ab9f55ae0c472474087f98bb54076aca18f8b058343479d24597a3aa181b,1858

.github/workflows/ci.yml

@@ -21,7 +21,7 @@ jobs:
       fail-fast: false
       matrix:
         os: ["macOS-13", "windows-latest"]
-        ghc: ["8.10", "9.0", "9.2", "9.4", "9.6", "9.8", "9.10"]
+        ghc: ["8.10", "9.0", "9.2", "9.4", "9.6", "9.8", "9.10", "9.12"]
         exclude:
           # Some tests fail with a mysterious -11 error code.
           - os: "macOS-13"
@@ -159,7 +159,7 @@ jobs:
 
     # Run steps inside the clash CI docker image
     container:
-      image: ghcr.io/clash-lang/clash-ci:${{ matrix.ghc }}-20250719
+      image: ghcr.io/clash-lang/clash-ci:${{ matrix.ghc }}-20250928
 
       env:
         THREADS: 2

.gitlab-ci.yml

@@ -34,15 +34,21 @@ tests:
     CI_PARENT_PIPELINE_SOURCE: $CI_PIPELINE_SOURCE
   parallel:
     matrix:
+      - GHC_VERSION: 9.12.2
+        RUN_TESTS: "always"
+        # TODO: remove this when https://gitlab.haskell.org/ghc/ghc/-/merge_requests/12264#note_602406
+        # has landed in stable release
+        SKIP_CLASH_FFI_EXAMPLE: "yes"
+
       - GHC_VERSION: 9.10.2
         # TODO: remove this when https://gitlab.haskell.org/ghc/ghc/-/merge_requests/12264#note_602406
         # is fixed
         SKIP_CLASH_FFI_EXAMPLE: "yes"
-        RUN_TESTS: "always"
+        RUN_TESTS: "nightly"
 
       - GHC_VERSION: 9.8.4
         # TODO: remove this when https://gitlab.haskell.org/ghc/ghc/-/merge_requests/12264#note_602406
-        # is fixed
+        # has landed in stable release
         SKIP_CLASH_FFI_EXAMPLE: "yes"
         RUN_TESTS: "always"
 

README.md

@@ -77,6 +77,7 @@ Note that release branches might contain non-released patches.
 | 9.6  | &#x2714;&#xfe0f;<sup>3</sup>    | &#x2714;&#xfe0f;<sup>3,4</sup>  | &#x2714;&#xfe0f;<sup>3</sup>    | 1.8              | &#x2714;&#xfe0f;
 | 9.8  | &#x2714;&#xfe0f;                | &#x2714;&#xfe0f;<sup>4</sup>    | &#x2714;&#xfe0f;                | 1.8              | ️&#x2714;&#xfe0f;
 | 9.10 | &#x2714;&#xfe0f;                | &#x2714;&#xfe0f;<sup>4</sup>    | &#x2714;&#xfe0f;                | 1.8              | ️&#x2714;&#xfe0f;
+| 9.12 | &#x2714;&#xfe0f;                | &#x2714;&#xfe0f;<sup>4</sup>    | &#x2714;&#xfe0f;                | 1.8              | ️&#x2714;&#xfe0f;
 
 
 <sup>1</sup> GHC 9.2 contains a regression, rendering Clash error messages indecipherable. This change was reverted in 9.4.
@@ -85,7 +86,7 @@ Note that release branches might contain non-released patches.
 
 <sup>3</sup> Clash starts extremely slowly when compiled with 9.4.8 up to and including 9.6.2. Consider downgrading to 9.4.7 or upgrading to 9.6.3 and up.
 
-<sup>4</sup> Clash starts extremely slowly on Windows with GHC 9.6 through 9.10, consider downgrading to 9.4.7
+<sup>4</sup> Clash starts extremely slowly on Windows with GHC 9.6 through 9.12, consider downgrading to 9.4.7
 
 ## Cabal
 To use Cabal you need both Cabal and GHC installed on your system. We recommend using [ghcup](https://www.haskell.org/ghcup/). For more information, see [https://www.haskell.org/downloads/](https://www.haskell.org/downloads/).

changelog/2025-04-20T23_25_06+02_00_add_ghc912_support

@@ -0,0 +1 @@
+ADD: Added GHC 9.12 support

clash-cosim/src/Clash/CoSim/Types.hs

@@ -1,5 +1,7 @@
+{-# LANGUAGE CPP #-}
 {-# LANGUAGE ConstraintKinds #-}
 {-# LANGUAGE DeriveDataTypeable #-}
+{-# LANGUAGE DerivingStrategies #-}
 {-# LANGUAGE FlexibleContexts #-}
 
 {-|
@@ -11,7 +13,10 @@ be housed in Simulator.hs, but FFI code crashes Template Haskell.
 -}
 module Clash.CoSim.Types where
 
-import Data.Data (Data, Typeable)
+import Data.Data (Data)
+#if __GLASGOW_HASKELL__ <= 910
+import Data.Data (Typeable)
+#endif
 
 import Clash.Prelude (BitPack, BitSize, KnownNat)
 import Clash.XException (NFDataX)
@@ -28,7 +33,10 @@ data CoSimSettings = CoSimSettings
     -- ^ Include files while running simulator
     , enableStdout :: Bool
     -- ^ Print verbose output to stdout
-    } deriving (Show, Typeable, Data)
+    } deriving (Show, Data)
+#if __GLASGOW_HASKELL__ <= 910
+      deriving Typeable
+#endif
 
 -- | Default simulator settings use Icarus, have a period of 20 and all other
 -- options disabled.
@@ -53,4 +61,7 @@ data CoSimulator = Icarus
                 -- ^ https://github.com/steveicarus/iverilog
                  | ModelSim
                 -- ^ https://www.mentor.com/products/fv/modelsim/
-                   deriving (Show, Eq, Typeable, Data)
+                   deriving (Show, Eq, Data)
+#if __GLASGOW_HASKELL__ <= 910
+                   deriving Typeable
+#endif

clash-ghc/clash-ghc.cabal

@@ -121,7 +121,9 @@ common common-options
 library
   import:             common-options
   HS-Source-Dirs:     src-ghc, src-bin-common
-  if impl(ghc >= 9.10.2)
+  if impl(ghc >= 9.12.0)
+    HS-Source-Dirs: src-bin-9.12
+  elif impl(ghc >= 9.10.2)
     HS-Source-Dirs: src-bin-9.10.2
   elif impl(ghc >= 9.10.0)
     HS-Source-Dirs: src-bin-9.10.1
@@ -153,7 +155,7 @@ library
                       base                      >= 4.11     && < 5,
                       bytestring                >= 0.9      && < 0.13,
                       Cabal,
-                      containers                >= 0.5.4.0  && < 0.8,
+                      containers                >= 0.5.4.0  && < 0.9,
                       data-binary-ieee754       >= 0.4.4    && < 0.6,
                       directory                 >= 1.2      && < 1.4,
                       extra                     >= 1.6      && < 1.9,
@@ -175,23 +177,23 @@ library
                       ghc-typelits-natnormalise >= 0.6      && < 0.8,
                       deepseq                   >= 1.3.0.2  && < 1.6,
                       time                      >= 1.4.0.1  && < 1.15,
-                      ghc-boot                  >= 8.10.0   && < 9.11,
-                      ghc-prim                  >= 0.3.1.0  && < 0.13,
-                      ghci                      >= 8.10.0   && < 9.11,
+                      ghc-boot                  >= 8.10.0   && < 9.13,
+                      ghc-prim                  >= 0.3.1.0  && < 0.14,
+                      ghci                      >= 8.10.0   && < 9.13,
                       uniplate                  >= 1.6.12   && < 1.8,
                       reflection                >= 2.1.2    && < 3.0,
                       primitive                 >= 0.5.0.1  && < 1.0,
                       string-interpolate        ^>= 0.3,
-                      template-haskell          >= 2.8.0.0  && < 2.23,
+                      template-haskell          >= 2.8.0.0  && < 2.24,
                       utf8-string               >= 1.0.0.0  && < 1.1.0.0,
                       vector                    >= 0.11     && < 1.0
 
   if os(darwin)
     -- 8.10 is broken on macOS - it exits tests with status code -11
-    Build-Depends: ghc >= 9.0.0 && < 9.11
+    Build-Depends: ghc >= 9.0.0 && < 9.13
   else
     -- Unix
-    Build-Depends: ghc >= 8.10.0 && < 9.11
+    Build-Depends: ghc >= 8.10.0 && < 9.13
 
   if impl(ghc >= 8.10.0)
     Build-Depends:    exceptions                >= 0.10.4   && < 0.11,

clash-ghc/src-bin-9.12/Clash/GHCi/Leak.hs

@@ -0,0 +1,85 @@
+{-# LANGUAGE RecordWildCards, LambdaCase #-}
+module Clash.GHCi.Leak
+  ( LeakIndicators
+  , getLeakIndicators
+  , checkLeakIndicators
+  ) where
+
+import Clash.GHCi.Util
+import Control.Monad
+import Data.Bits
+import Foreign.Ptr (ptrToIntPtr, intPtrToPtr)
+import GHC
+import GHC.Ptr (Ptr (..))
+import GHC.Driver.Env
+import GHC.Driver.Ppr
+import GHC.Utils.Outputable
+import GHC.Unit.Module.ModDetails
+import GHC.Unit.Home.ModInfo
+import GHC.Platform (target32Bit)
+import GHC.Linker.Types
+import Prelude
+import System.Mem
+import System.Mem.Weak
+import GHC.Types.Unique.DFM
+import Control.Exception
+
+-- Checking for space leaks in GHCi. See #15111, and the
+-- -fghci-leak-check flag.
+
+data LeakIndicators = LeakIndicators [LeakModIndicators]
+
+data LeakModIndicators = LeakModIndicators
+  { leakMod :: Weak HomeModInfo
+  , leakIface :: Weak ModIface
+  , leakDetails :: Weak ModDetails
+  , leakLinkable :: [Maybe (Weak Linkable)]
+  }
+
+-- | Grab weak references to some of the data structures representing
+-- the currently loaded modules.
+getLeakIndicators :: HscEnv -> IO LeakIndicators
+getLeakIndicators hsc_env =
+  fmap LeakIndicators $
+    forM (eltsUDFM (hsc_HPT hsc_env)) $ \hmi@HomeModInfo{..} -> do
+      leakMod <- mkWeakPtr hmi Nothing
+      leakIface <- mkWeakPtr hm_iface Nothing
+      leakDetails <- mkWeakPtr hm_details Nothing
+      leakLinkable <-  mkWeakLinkables hm_linkable
+      return $ LeakModIndicators{..}
+  where
+    mkWeakLinkables :: HomeModLinkable -> IO [Maybe (Weak Linkable)]
+    mkWeakLinkables (HomeModLinkable mbc mo) =
+      mapM (\ln -> traverse (flip mkWeakPtr Nothing <=< evaluate) ln) [mbc, mo]
+
+-- | Look at the LeakIndicators collected by an earlier call to
+-- `getLeakIndicators`, and print messasges if any of them are still
+-- alive.
+checkLeakIndicators :: DynFlags -> LeakIndicators -> IO ()
+checkLeakIndicators dflags (LeakIndicators leakmods)  = do
+  performGC
+  forM_ leakmods $ \LeakModIndicators{..} -> do
+    deRefWeak leakMod >>= \case
+      Nothing -> return ()
+      Just hmi ->
+        report ("HomeModInfo for " ++
+          showSDoc dflags (ppr (mi_module (hm_iface hmi)))) (Just hmi)
+    deRefWeak leakIface >>= \case
+      Nothing -> return ()
+      Just miface -> report ("ModIface:" ++ moduleNameString (moduleName (mi_module miface))) (Just miface)
+    deRefWeak leakDetails >>= report "ModDetails"
+    forM_ leakLinkable $ \l -> forM_ l $ \l' -> deRefWeak l' >>= report "Linkable"
+ where
+  report :: String -> Maybe a -> IO ()
+  report _ Nothing = return ()
+  report msg (Just a) = do
+    addr <- anyToPtr a
+    putStrLn ("-fghci-leak-check: " ++ msg ++ " is still alive at " ++
+              show (maskTagBits addr))
+
+  tagBits
+    | target32Bit (targetPlatform dflags) = 2
+    | otherwise = 3
+
+  maskTagBits :: Ptr a -> Ptr a
+  maskTagBits p = intPtrToPtr (ptrToIntPtr p .&. complement (shiftL 1 tagBits - 1))