Enable building Clash against GHC 9.10 (copy #2758)

.gitlab-ci.yml

@@ -39,6 +39,9 @@ tests:
     CI_PARENT_PIPELINE_SOURCE: $CI_PIPELINE_SOURCE
   parallel:
     matrix:
+      - GHC_VERSION: 9.10.1
+        RUN_TESTS: "always"
+
       - GHC_VERSION: 9.8.2
         RUN_TESTS: "always"
 

cabal.project

@@ -16,7 +16,7 @@ write-ghc-environment-files: always
 -- index state, to go along with the cabal.project.freeze file. update the index
 -- state by running `cabal update` twice and looking at the index state it
 -- displays to you (as the second update will be a no-op)
-index-state: 2024-07-06T09:03:11Z
+index-state: 2024-07-18T12:39:16Z
 
 -- For some reason the `clash-testsuite` executable fails to run without
 -- this, as it cannot find the related library...
@@ -72,7 +72,12 @@ allow-newer:
   rewrite-inspector:containers,
   vty:deepseq,
   derive-storable-plugin:ghc,
-  derive-storable-plugin:ghci
+  derive-storable-plugin:ghci,
+  string-random:text,
+  string-random:containers,
+  string-interpolate:template-haskell,
+  string-interpolate:text,
+  hint:ghc
 
 -- Works around: https://github.com/recursion-schemes/recursion-schemes/issues/128. This
 -- shouldn't harm (runtime) performance of Clash, as we only use recursion-schemes with

changelog/2024-07-26T07_36_58+02_00_ghc_910_upgrade

@@ -0,0 +1,4 @@
+ADDED: Support for GHC 9.10.
+A word of caution: When the Clash compiler is compiled against GHC 9.10, it will
+currently only work reliably on 64-bit platforms. Compile the Clash compiler with
+GHC 9.8 or older if you are on a 32-bit platform.

clash-ffi/clash-ffi.cabal

@@ -20,7 +20,7 @@ common common-options
   ghc-options:
     -Wall -Wcompat
   build-depends:
-    base                    >= 4.11 && < 4.20,
+    base                    >= 4.11 && < 4.21,
     bytestring              >= 0.10 && < 0.13,
     clash-prelude           >= 1.2  && < 1.10,
     deepseq                 >= 1.4  && < 1.6,

clash-ffi/example/cabal.project

@@ -5,4 +5,7 @@ write-ghc-environment-files: always
 allow-newer:
   hashable,
   derive-storable-plugin:ghc,
-  derive-storable-plugin:ghci
+  derive-storable-plugin:ghci,
+  string-interpolate:template-haskell,
+  string-interpolate:text,
+  hint:ghc

clash-ffi/example/clash-ffi-example.cabal

@@ -14,7 +14,7 @@ category:           Hardware
 custom-setup
   setup-depends:
     base        >= 4.11  && < 5,
-    Cabal       >= 2.4   && < 3.12,
+    Cabal       >= 2.4   && < 3.14,
     directory   >= 1.3.6 && < 1.4,
     filepath    >= 1.4.2 && < 1.5,
 

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.8.0)
+  if impl(ghc >= 9.10.0)
+    HS-Source-Dirs: src-bin-9.10
+  elif impl(ghc >= 9.8.0)
     HS-Source-Dirs: src-bin-9.8
   elif impl(ghc >= 9.6.0)
     HS-Source-Dirs: src-bin-9.6
@@ -176,26 +178,26 @@ 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.6.0    && < 9.9,
+                      ghc-boot                  >= 8.6.0    && < 9.11,
                       ghc-prim                  >= 0.3.1.0  && < 0.12,
-                      ghci                      >= 8.6.0    && < 9.9,
+                      ghci                      >= 8.6.0    && < 9.11,
                       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.22,
+                      template-haskell          >= 2.8.0.0  && < 2.23,
                       utf8-string               >= 1.0.0.0  && < 1.1.0.0,
                       vector                    >= 0.11     && < 1.0
 
   if os(windows)
     -- 8.8 is broken on Windows - it randomly segfaults
-    Build-Depends: ghc >= 8.6.0 && < 8.8.0 || >= 8.10.0 && < 9.9
+    Build-Depends: ghc >= 8.6.0 && < 8.8.0 || >= 8.10.0 && < 9.11
   elif os(darwin)
     -- 8.10 is broken on macOS - it exits tests with status code -11
-    Build-Depends: ghc >= 8.6.0 && < 8.10.0 || >= 9.0.0 && < 9.9
+    Build-Depends: ghc >= 8.6.0 && < 8.10.0 || >= 9.0.0 && < 9.11
   else
     -- Unix
-    Build-Depends: ghc >= 8.6.0 && < 9.9
+    Build-Depends: ghc >= 8.6.0 && < 9.11
 
   if impl(ghc >= 8.10.0)
     Build-Depends:    exceptions                >= 0.10.4   && < 0.11,

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

@@ -0,0 +1,85 @@
+{-# LANGUAGE RecordWildCards, LambdaCase #-}
+module Clash.GHCi.Leak
+  ( LeakIndicators
+  , getLeakIndicators
+  , checkLeakIndicators
+  ) where
+
+import Control.Monad
+import Data.Bits
+import Foreign.Ptr (ptrToIntPtr, intPtrToPtr)
+import GHC
+import GHC.Ptr (Ptr (..))
+import Clash.GHCi.Util
+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))