Merge pull request #2746 from clash-lang/mergify/copy/1.8/pr-2737

Make sure clashSimulation is False in HDL even with -O2 (copy #2737)

clash-prelude/src/Clash/Magic.hs

@@ -44,6 +44,7 @@ module Clash.Magic
   ) where
 
 import Data.String.Interpolate     (__i)
+import GHC.Magic                   (noinline)
 import GHC.Stack                   (HasCallStack, withFrozenCallStack)
 import Clash.NamedTypes            ((:::))
 import GHC.TypeLits                (Nat,Symbol)
@@ -259,7 +260,8 @@ noDeDup = id
 
 -- | 'True' in Haskell/Clash simulation. Replaced by 'False' when generating HDL.
 clashSimulation :: Bool
-clashSimulation = True
+clashSimulation = noinline True
+-- The 'noinline' is here to prevent SpecConstr from poking through the OPAQUE, see #2736
 -- See: https://github.com/clash-lang/clash-compiler/pull/2511
 {-# CLASH_OPAQUE clashSimulation #-}
 

tests/Main.hs

@@ -385,7 +385,7 @@ runClashTest = defaultMain $ clashTestRoot
         , runTest "NameInstance" def{hdlSim=[]}
         , outputTest "NameInstance" def
         , outputTest "SetName" def{hdlTargets=[VHDL]}
-        , outputTest "SimulationMagic" def{hdlTargets=[VHDL]}
+        , outputTest "SimulationMagic2736" def{hdlTargets=[VHDL]}
         , runTest "PatError" def{hdlSim=[]}
         , runTest "ByteSwap32" def
         , runTest "CharTest" def

tests/clash-testsuite.cabal

@@ -102,7 +102,8 @@ library
     -- Behaviour when loading modules can differ if the module is loaded from
     -- an external interface file. See
     -- https://github.com/clash-lang/clash-compiler/issues/1796 for an example.
-    shouldwork/LoadModules
+    shouldwork/LoadModules/precompiled
+    shouldwork/Basic/precompiled
 
   exposed-modules:
     Test.Tasty.Common
@@ -118,8 +119,11 @@ library
     Test.Tasty.Vivado
     Test.Tasty.Clash.CollectSimResults
 
-    -- From tests/shouldwork/LoadModules
-    T1796
+    -- From tests/shouldwork/LoadModules/precompiled
+    T1796a
+
+    -- From tests/shouldwork/Basic/precompiled
+    SimulationMagic2736a
 
   other-modules:
     Paths_clash_testsuite

tests/shouldwork/Basic/SimulationMagic.hs → tests/shouldwork/Basic/SimulationMagic2736.hs

@@ -1,16 +1,17 @@
-module SimulationMagic where
+{-# LANGUAGE TemplateHaskellQuotes #-}
+{-# OPTIONS_GHC -O2 -fspec-constr #-}
+module SimulationMagic2736 where
 
 import Prelude as P
 import Data.List (isInfixOf)
 import System.Environment (getArgs)
 import System.FilePath ((</>))
 
 import Clash.Prelude
-import Clash.Magic (clashSimulation)
+import SimulationMagic2736a
 
 f :: Int
-f | clashSimulation = 123
-  | otherwise       = 456
+f = f0
 {-# ANN f (defSyn "f") #-}
 
 assertNotIn :: String -> String -> IO ()

tests/shouldwork/Basic/precompiled/SimulationMagic2736a.hs

@@ -0,0 +1,8 @@
+{-# OPTIONS_GHC -O2 -fspec-constr #-}
+module SimulationMagic2736a where
+
+import Clash.Prelude
+
+f0 :: Int
+f0 | clashSimulation = 123
+   | otherwise       = 456

tests/shouldwork/LoadModules/T1796.hs

@@ -4,29 +4,6 @@
 
 module T1796 where
 
-import Clash.Prelude
+import T1796a
 
-import Clash.Explicit.Testbench
-
-topEntity
-  :: Signal System Bool
-  -> Signal System Bool
-topEntity = id
--- See: https://github.com/clash-lang/clash-compiler/pull/2511
-{-# CLASH_OPAQUE topEntity #-}
-
-tb
-  :: Signal System Bool
-tb = done
-  where
-    testInput = stimuliGenerator clk rst (singleton True)
-    expectOutput = outputVerifier' clk rst (singleton True)
-    done = expectOutput $ topEntity testInput
-    clk = tbClockGen @System (not <$> done)
-    rst = resetGen @System
-{-# INLINE tb #-}
-
-testBench :: Signal System Bool
-testBench = tb
--- See: https://github.com/clash-lang/clash-compiler/pull/2511
-{-# CLASH_OPAQUE testBench #-}
+topEntity = tb

tests/shouldwork/LoadModules/precompiled/T1796a.hs

@@ -0,0 +1,15 @@
+{-# LANGUAGE CPP #-}
+{-# LANGUAGE NoImplicitPrelude #-}
+{-# LANGUAGE TypeApplications #-}
+
+module T1796a where
+
+import Clash.Explicit.Prelude
+import Clash.Explicit.Testbench
+
+tb :: Signal System Bool
+tb = done
+  where
+    done = register clk rst enableGen False $ id (pure True)
+    clk = tbClockGen @System (not <$> done)
+    rst = resetGen @System