Use CLASH_OPAQUE through libraries

clash-lang · Jul 3, 2023 · 4a322a1 · 4a322a1
1 parent 5af775f
commit 4a322a1
Show file tree

Hide file tree

Showing 291 changed files with 1,952 additions and 773 deletions.
diff --git a/benchmark/tests/ManyEntitiesEqual.hs b/benchmark/tests/ManyEntitiesEqual.hs
@@ -1,3 +1,4 @@
+{-# LANGUAGE CPP #-}
 {-# LANGUAGE RankNTypes #-}
 
 module ManyEntitiesEqual where
@@ -34,42 +35,50 @@ type Top n =
     => Signal System (Unsigned n)
     -> Signal System (Unsigned n)
 
-{-# NOINLINE top0 #-}
+-- See: https://github.com/clash-lang/clash-compiler/pull/2511
+{-# CLASH_OPAQUE top0 #-}
 {-# ANN top0 (defSyn "top_0") #-}
 top0 :: Top 64
 top0 = entity (SNat @64)
 
-{-# NOINLINE top1 #-}
+-- See: https://github.com/clash-lang/clash-compiler/pull/2511
+{-# CLASH_OPAQUE top1 #-}
 {-# ANN top1 (defSyn "top_1") #-}
 top1 :: Top 64
 top1 = entity (SNat @64)
 
-{-# NOINLINE top2 #-}
+-- See: https://github.com/clash-lang/clash-compiler/pull/2511
+{-# CLASH_OPAQUE top2 #-}
 {-# ANN top2 (defSyn "top_2") #-}
 top2 :: Top 64
 top2 = entity (SNat @64)
 
-{-# NOINLINE top3 #-}
+-- See: https://github.com/clash-lang/clash-compiler/pull/2511
+{-# CLASH_OPAQUE top3 #-}
 {-# ANN top3 (defSyn "top_3") #-}
 top3 :: Top 64
 top3 = entity (SNat @64)
 
-{-# NOINLINE top4 #-}
+-- See: https://github.com/clash-lang/clash-compiler/pull/2511
+{-# CLASH_OPAQUE top4 #-}
 {-# ANN top4 (defSyn "top_4") #-}
 top4 :: Top 64
 top4 = entity (SNat @64)
 
-{-# NOINLINE top5 #-}
+-- See: https://github.com/clash-lang/clash-compiler/pull/2511
+{-# CLASH_OPAQUE top5 #-}
 {-# ANN top5 (defSyn "top_5") #-}
 top5 :: Top 64
 top5 = entity (SNat @64)
 
-{-# NOINLINE top6 #-}
+-- See: https://github.com/clash-lang/clash-compiler/pull/2511
+{-# CLASH_OPAQUE top6 #-}
 {-# ANN top6 (defSyn "top_6") #-}
 top6 :: Top 64
 top6 = entity (SNat @64)
 
-{-# NOINLINE top7 #-}
+-- See: https://github.com/clash-lang/clash-compiler/pull/2511
+{-# CLASH_OPAQUE top7 #-}
 {-# ANN top7 (defSyn "top_7") #-}
 top7 :: Top 64
 top7 = entity (SNat @64)
diff --git a/benchmark/tests/ManyEntitiesVaried.hs b/benchmark/tests/ManyEntitiesVaried.hs
@@ -1,3 +1,4 @@
+{-# LANGUAGE CPP #-}
 {-# LANGUAGE RankNTypes #-}
 
 module ManyEntitiesVaried where
@@ -34,27 +35,32 @@ type Top n =
     => Signal System (Unsigned n)
     -> Signal System (Unsigned n)
 
-{-# NOINLINE top0 #-}
+-- See: https://github.com/clash-lang/clash-compiler/pull/2511
+{-# CLASH_OPAQUE top0 #-}
 {-# ANN top0 (defSyn "top_0") #-}
 top0 :: Top 24
 top0 = entity (SNat @24)
 
-{-# NOINLINE top1 #-}
+-- See: https://github.com/clash-lang/clash-compiler/pull/2511
+{-# CLASH_OPAQUE top1 #-}
 {-# ANN top1 (defSyn "top_1") #-}
 top1 :: Top 32
 top1 = entity (SNat @32)
 
-{-# NOINLINE top2 #-}
+-- See: https://github.com/clash-lang/clash-compiler/pull/2511
+{-# CLASH_OPAQUE top2 #-}
 {-# ANN top2 (defSyn "top_2") #-}
 top2 :: Top 48
 top2 = entity (SNat @48)
 
-{-# NOINLINE top3 #-}
+-- See: https://github.com/clash-lang/clash-compiler/pull/2511
+{-# CLASH_OPAQUE top3 #-}
 {-# ANN top3 (defSyn "top_3") #-}
 top3 :: Top 64
 top3 = entity (SNat @64)
 
-{-# NOINLINE top4 #-}
+-- See: https://github.com/clash-lang/clash-compiler/pull/2511
+{-# CLASH_OPAQUE top4 #-}
 {-# ANN top4 (defSyn "top_4") #-}
 top4 :: Top 96
 top4 = entity (SNat @96)

diff --git a/clash-cores/src/Clash/Cores/LatticeSemi/ECP5/IO.hs b/clash-cores/src/Clash/Cores/LatticeSemi/ECP5/IO.hs
@@ -7,8 +7,9 @@
   LATTICE ECP5 IO primitives. Implementations are documented in the
   <http://www.latticesemi.com/-/media/LatticeSemi/Documents/ApplicationNotes/EH/FPGA-TN-02032-1-2-ECP5-ECP5G-sysIO-Usage-Guide.ashx?document_id=50464>.
 -}
-{-# LANGUAGE QuasiQuotes #-}
 {-# LANGUAGE BangPatterns #-}
+{-# LANGUAGE CPP #-}
+{-# LANGUAGE QuasiQuotes #-}
 
 {-# LANGUAGE ViewPatterns #-}
 {-# LANGUAGE GADTs #-}
@@ -74,7 +75,8 @@ bbECP5 _intrinsicName pkgPinIn output notOutputEnable
      toMaybe :: Bool -> a -> Maybe a
      toMaybe True a  = Just a
      toMaybe False _ = Nothing
-{-# NOINLINE bbECP5 #-}
+-- See: https://github.com/clash-lang/clash-compiler/pull/2511
+{-# CLASH_OPAQUE bbECP5 #-}
 {-# ANN bbECP5 hasBlackBox #-}
 {-# ANN bbECP5 (InlineYamlPrimitive [VHDL,Verilog,SystemVerilog] [__i|
   BlackBox:

diff --git a/clash-cores/src/Clash/Cores/LatticeSemi/ICE40/IO.hs b/clash-cores/src/Clash/Cores/LatticeSemi/ICE40/IO.hs
@@ -8,11 +8,12 @@
   <http://www.latticesemi.com/~/media/LatticeSemi/Documents/TechnicalBriefs/SBTICETechnologyLibrary201504.pdf LATTICE ICE Technology Library>,
   referred to as LITL.
 -}
-{-# LANGUAGE ViewPatterns #-}
 {-# LANGUAGE BangPatterns #-}
+{-# LANGUAGE CPP #-}
 {-# LANGUAGE GADTs #-}
 {-# LANGUAGE LambdaCase #-}
 {-# LANGUAGE QuasiQuotes #-}
+{-# LANGUAGE ViewPatterns #-}
 
 module Clash.Cores.LatticeSemi.ICE40.IO
   ( sbio
@@ -230,7 +231,8 @@ sbio pinConf pkgPinIn latchInput dOut_0 _dOut_1 outputEnable0 =
     writeToBiSignal
       pkgPinIn
       (toMaybe <$> outputEnable1 <*> pkgPinWriteInput)
-{-# NOINLINE sbio #-}
+-- See: https://github.com/clash-lang/clash-compiler/pull/2511
+{-# CLASH_OPAQUE sbio #-}
 {-# ANN sbio hasBlackBox #-}
 {-# ANN sbio (InlineYamlPrimitive [VHDL,Verilog,SystemVerilog] [__i|
    BlackBox:

diff --git a/clash-cores/src/Clash/Cores/Xilinx/BlockRam.hs b/clash-cores/src/Clash/Cores/Xilinx/BlockRam.hs
@@ -6,6 +6,8 @@
   Xilinx block RAM primitives
 -}
 
+{-# LANGUAGE CPP #-}
+
 -- See [Note: eta port names for tdpbram]
 {-# OPTIONS_GHC -fno-do-lambda-eta-expansion #-}
 
@@ -76,4 +78,5 @@ tdpbram clkA enA addrA byteEnaA datA clkB enB addrB byteEnaB datB =
       clashCompileError "tdpbram: domain A needs a rising active edge"
     (_, SFalling) ->
       clashCompileError "tdpbram: domain B needs a rising active edge"
-{-# NOINLINE tdpbram #-}
+-- See: https://github.com/clash-lang/clash-compiler/pull/2511
+{-# CLASH_OPAQUE tdpbram #-}
diff --git a/clash-cores/src/Clash/Cores/Xilinx/BlockRam/Internal.hs b/clash-cores/src/Clash/Cores/Xilinx/BlockRam/Internal.hs
@@ -7,6 +7,7 @@
 -}
 
 {-# LANGUAGE BangPatterns #-}
+{-# LANGUAGE CPP #-}
 {-# LANGUAGE LambdaCase #-}
 {-# LANGUAGE QuasiQuotes #-}
 {-# LANGUAGE RecordWildCards #-}
@@ -157,7 +158,8 @@ updateRam addr (IsDefined byteEna) dat mem
   isDefinedMaxBound _        = False
 
 {-# ANN tdpbram# hasBlackBox #-}
-{-# NOINLINE tdpbram# #-}
+-- See: https://github.com/clash-lang/clash-compiler/pull/2511
+{-# CLASH_OPAQUE tdpbram# #-}
 {-# ANN tdpbram# (
    let
      primName = 'tdpbram#

diff --git a/clash-cores/src/Clash/Cores/Xilinx/DcFifo.hs b/clash-cores/src/Clash/Cores/Xilinx/DcFifo.hs
@@ -45,6 +45,7 @@ acknowledge, valid, or programmable full\/empty flags)
 Vivado 2022.1.)
 -}
 
+{-# LANGUAGE CPP #-}
 {-# LANGUAGE NamedFieldPuns #-}
 {-# LANGUAGE QuasiQuotes #-}
 {-# LANGUAGE RecordWildCards #-}
@@ -253,7 +254,8 @@ dcFifo DcConfig{..} wClk wRst rClk rRst writeData rEnable =
             Seq.EmptyR -> (q, deepErrorX "FIFO empty", True :- preUnder)
             qData Seq.:> qDatum -> (qData, qDatum, False :- preUnder)
         else (q, deepErrorX "Enable off", False :- preUnder)
-{-# NOINLINE dcFifo #-}
+-- See: https://github.com/clash-lang/clash-compiler/pull/2511
+{-# CLASH_OPAQUE dcFifo #-}
 {-# ANN dcFifo (
    let primName = 'dcFifo
        tfName = 'dcFifoBBF

diff --git a/clash-cores/src/Clash/Cores/Xilinx/Floating/Explicit.hs b/clash-cores/src/Clash/Cores/Xilinx/Floating/Explicit.hs
@@ -43,6 +43,7 @@ type variable for delay annotation in circuits.
 -}
 
 {-# LANGUAGE BangPatterns #-}
+{-# LANGUAGE CPP #-}
 {-# LANGUAGE ViewPatterns #-}
 
 {-# OPTIONS_HADDOCK hide #-}
@@ -107,7 +108,8 @@ addWith !_ clk en (conditionFloatF -> x) (conditionFloatF -> y) =
   delayI und en clk . conditionFloatF $ x + y
  where
   und = withFrozenCallStack $ deepErrorX "Initial values of add undefined"
-{-# NOINLINE addWith #-}
+-- See: https://github.com/clash-lang/clash-compiler/pull/2511
+{-# CLASH_OPAQUE addWith #-}
 {-# ANN addWith (vhdlBinaryPrim 'addWith 'addTclTF "add") #-}
 {-# ANN addWith (veriBinaryPrim 'addWith 'addTclTF "add") #-}
 
@@ -145,7 +147,8 @@ subWith !_ clk en (conditionFloatF -> x) (conditionFloatF -> y) =
   delayI und en clk . conditionFloatF $ x - y
  where
   und = withFrozenCallStack $ deepErrorX "Initial values of sub undefined"
-{-# NOINLINE subWith #-}
+-- See: https://github.com/clash-lang/clash-compiler/pull/2511
+{-# CLASH_OPAQUE subWith #-}
 {-# ANN subWith (vhdlBinaryPrim 'subWith 'subTclTF "sub") #-}
 {-# ANN subWith (veriBinaryPrim 'subWith 'subTclTF "sub") #-}
 
@@ -184,7 +187,8 @@ mulWith !_ clk en (conditionFloatF -> x) (conditionFloatF -> y) =
   delayI und en clk . conditionFloatF $ x * y
  where
   und = withFrozenCallStack $ deepErrorX "Initial values of mul undefined"
-{-# NOINLINE mulWith #-}
+-- See: https://github.com/clash-lang/clash-compiler/pull/2511
+{-# CLASH_OPAQUE mulWith #-}
 {-# ANN mulWith (vhdlBinaryPrim 'mulWith 'mulTclTF "mul") #-}
 {-# ANN mulWith (veriBinaryPrim 'mulWith 'mulTclTF "mul") #-}
 
@@ -223,7 +227,8 @@ divWith !_ clk en (conditionFloatF -> x) (conditionFloatF -> y) =
   delayI und en clk . conditionFloatF $ x / y
  where
   und = withFrozenCallStack $ deepErrorX "Initial values of div undefined"
-{-# NOINLINE divWith #-}
+-- See: https://github.com/clash-lang/clash-compiler/pull/2511
+{-# CLASH_OPAQUE divWith #-}
 {-# ANN divWith (vhdlBinaryPrim 'divWith 'divTclTF "div") #-}
 {-# ANN divWith (veriBinaryPrim 'divWith 'divTclTF "div") #-}
 
@@ -261,7 +266,8 @@ fromU32With
 fromU32With clk en = delayI und en clk . fmap fromIntegral
  where
   und = withFrozenCallStack $ errorX "Initial values of fromU32 undefined"
-{-# NOINLINE fromU32With #-}
+-- See: https://github.com/clash-lang/clash-compiler/pull/2511
+{-# CLASH_OPAQUE fromU32With #-}
 {-# ANN fromU32With (vhdlFromUPrim 'fromU32With "fromU32") #-}
 {-# ANN fromU32With (veriFromUPrim 'fromU32With "fromU32") #-}
 
@@ -298,7 +304,8 @@ fromS32With
 fromS32With clk en = delayI und en clk . fmap fromIntegral
  where
   und = withFrozenCallStack $ errorX "Initial values of fromS32 undefined"
-{-# NOINLINE fromS32With #-}
+-- See: https://github.com/clash-lang/clash-compiler/pull/2511
+{-# CLASH_OPAQUE fromS32With #-}
 {-# ANN fromS32With (vhdlFromSPrim 'fromS32With "fromS32") #-}
 {-# ANN fromS32With (veriFromSPrim 'fromS32With "fromS32") #-}
 
@@ -339,7 +346,8 @@ compareWith
 compareWith clk ena a b = delayI und ena clk (xilinxCompare <$> a <*> b)
  where
   und = withFrozenCallStack $ errorX "Initial values of compare undefined"
-{-# NOINLINE compareWith #-}
+-- See: https://github.com/clash-lang/clash-compiler/pull/2511
+{-# CLASH_OPAQUE compareWith #-}
 {-# ANN compareWith (vhdlComparePrim 'compareWith 'compareTclTF "compare") #-}
 {-# ANN compareWith (veriComparePrim 'compareWith 'compareTclTF "compare") #-}
 

diff --git a/clash-cores/src/Clash/Cores/Xilinx/VIO.hs b/clash-cores/src/Clash/Cores/Xilinx/VIO.hs
@@ -28,11 +28,12 @@ JTAG clock speed:
 
 -}
 
+{-# LANGUAGE AllowAmbiguousTypes #-}
 {-# LANGUAGE BangPatterns #-}
-{-# LANGUAGE QuasiQuotes #-}
+{-# LANGUAGE CPP #-}
 {-# LANGUAGE FlexibleInstances #-}
 {-# LANGUAGE FunctionalDependencies #-}
-{-# LANGUAGE AllowAmbiguousTypes #-}
+{-# LANGUAGE QuasiQuotes #-}
 {-# LANGUAGE UndecidableInstances #-}
 
 module Clash.Cores.Xilinx.VIO
@@ -104,7 +105,8 @@ vioProbe ::
   Clock dom ->
   a
 vioProbe !_inputNames !_outputNames !_initialOutputProbeValues !_clk = vioX @dom @a @o
-{-# NOINLINE vioProbe #-}
+-- See: https://github.com/clash-lang/clash-compiler/pull/2511
+{-# CLASH_OPAQUE vioProbe #-}
 {-# ANN vioProbe (
     let primName = 'vioProbe
         tfName = 'vioProbeBBF

diff --git a/clash-cores/src/Clash/Cores/Xilinx/Xpm/Cdc/ArraySingle/Internal.hs b/clash-cores/src/Clash/Cores/Xilinx/Xpm/Cdc/ArraySingle/Internal.hs
@@ -3,6 +3,7 @@
   License     :  BSD2 (see the file LICENSE)
   Maintainer  :  QBayLogic B.V. <[email protected]>
 -}
+{-# LANGUAGE CPP #-}
 {-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE QuasiQuotes #-}
 {-# LANGUAGE ViewPatterns #-}
@@ -127,7 +128,8 @@ xpmCdcArraySingleTF# bbCtx
 
 xpmCdcArraySingleTF# bbCtx = error (ppShow bbCtx)
 
-{-# NOINLINE xpmCdcArraySingle# #-}
+-- See: https://github.com/clash-lang/clash-compiler/pull/2511
+{-# CLASH_OPAQUE xpmCdcArraySingle# #-}
 {-# ANN xpmCdcArraySingle# hasBlackBox #-}
 {-# ANN xpmCdcArraySingle#
   let

diff --git a/clash-cores/src/Clash/Cores/Xilinx/Xpm/Cdc/Gray/Internal.hs b/clash-cores/src/Clash/Cores/Xilinx/Xpm/Cdc/Gray/Internal.hs
@@ -3,6 +3,7 @@
   License     :  BSD2 (see the file LICENSE)
   Maintainer  :  QBayLogic B.V. <[email protected]>
 -}
+{-# LANGUAGE CPP #-}
 {-# LANGUAGE LambdaCase #-}
 {-# LANGUAGE NumericUnderscores #-}
 {-# LANGUAGE OverloadedStrings #-}
@@ -126,7 +127,8 @@ xpmCdcGrayTF# bbCtx
 
 xpmCdcGrayTF# bbCtx = error (ppShow bbCtx)
 
-{-# NOINLINE xpmCdcGray# #-}
+-- See: https://github.com/clash-lang/clash-compiler/pull/2511
+{-# CLASH_OPAQUE xpmCdcGray# #-}
 {-# ANN xpmCdcGray# hasBlackBox #-}
 {-# ANN xpmCdcGray#
   let

diff --git a/clash-cores/src/Clash/Cores/Xilinx/Xpm/Cdc/Single/Internal.hs b/clash-cores/src/Clash/Cores/Xilinx/Xpm/Cdc/Single/Internal.hs
@@ -3,6 +3,7 @@
   License     :  BSD2 (see the file LICENSE)
   Maintainer  :  QBayLogic B.V. <[email protected]>
 -}
+{-# LANGUAGE CPP #-}
 {-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE QuasiQuotes #-}
 {-# LANGUAGE ViewPatterns #-}
@@ -120,7 +121,8 @@ xpmCdcSingleTF# bbCtx
 
 xpmCdcSingleTF# bbCtx = error (ppShow bbCtx)
 
-{-# NOINLINE xpmCdcSingle# #-}
+-- See: https://github.com/clash-lang/clash-compiler/pull/2511
+{-# CLASH_OPAQUE xpmCdcSingle# #-}
 {-# ANN xpmCdcSingle# hasBlackBox #-}
 {-# ANN xpmCdcSingle#
   let

diff --git a/clash-cosim/src/Clash/CoSim/CodeGeneration.hs b/clash-cosim/src/Clash/CoSim/CodeGeneration.hs
@@ -79,8 +79,13 @@ coSimGen' clks args = do
     -- Function declaration and body
     let coSim = FunD coSimName [Clause [] (NormalB $ VarE $ mkName "coSimN") []]
 
+#if __GLASGOW_HASKELL__ >= 904
+    -- OPAQUE pragma
+    let inline = PragmaD $ OpaqueP coSimName
+#else
     -- NOINLINE pragma
     let inline = PragmaD $ InlineP coSimName NoInline FunLike AllPhases
+#endif
 
     -- Clash blackbox pragma
     primDir        <- runIO $ getDataFileName "src/prims/verilog"

diff --git a/clash-ghc/src-ghc/Clash/GHC/GenerateBindings.hs b/clash-ghc/src-ghc/Clash/GHC/GenerateBindings.hs
@@ -211,7 +211,7 @@ setNoInlineTopEntities bm tes =
   go b@Binding{bindingId}
     | bindingId `elemVarSet` ids
 #if MIN_VERSION_ghc(9,4,0)
-    = b { bindingSpec = GHC.NoInline GHC.NoSourceText }
+    = b { bindingSpec = GHC.Opaque GHC.NoSourceText }
 #else
     = b { bindingSpec = GHC.NoInline }
 #endif

diff --git a/clash-prelude/src/Clash/Annotations/BitRepresentation/Deriving.hs b/clash-prelude/src/Clash/Annotations/BitRepresentation/Deriving.hs
@@ -924,7 +924,8 @@ buildPack dataRepr@(DataReprAnn _name _size constrs) = do
 -- This is used in the generated pack/unpack to not do anything in HDL.
 dontApplyInHDL :: (a -> b) -> a -> b
 dontApplyInHDL f a = f a
-{-# NOINLINE dontApplyInHDL #-}
+-- See: https://github.com/clash-lang/clash-compiler/pull/2511
+{-# CLASH_OPAQUE dontApplyInHDL #-}
 {-# ANN dontApplyInHDL hasBlackBox #-}
 
 buildUnpackField