diff --git a/CHANGELOG.md b/CHANGELOG.md --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,105 @@ # Changelog for the Clash project +## 1.10.0 *Apr 23rd, 2026* + +Release highlight: +* `Clash.Class.NumConvert`: Utilities for safely converting between various Clash number types [#2915](https://github.com/clash-lang/clash-compiler/pull/2915) + +Added: +* Added GHC 9.12 support +* `Clash.Class.NumConvert`: Utilities for safely converting between various Clash number types [#2915](https://github.com/clash-lang/clash-compiler/pull/2915) +* Add `Clash.XException.ShowX` instance for `Foreign.C.Types.CUShort`. [#2397](https://github.com/clash-lang/clash-compiler/pull/2397) +* Introduced various new types to `Clash.Signal` to more easily represent time and its relation to your clock domain. New types: `Seconds`, `Milliseconds`, `Microseconds`, `Nanoseconds`, `Picoseconds`, `DomainToHz`, `HzToPeriod`, `PeriodToHz`, `PeriodToCycles`, `ClockDivider`. [#2734](https://github.com/clash-lang/clash-compiler/pull/2734) +* `Distributive` and `Representable` instances for `Vec` +* Resize functions `maybeResize` and `maybeTruncateB` to `Clash.Class.Resize`. Can be used to resize without loss of information. [#2779](https://github.com/clash-lang/clash-compiler/issues/2779) +* Alongside the existing Eq-like and Ord-like signal operators like `.==.` and `.<=.` etc., there are now new functions for comparing with constants: `.==`, `==.`, `./=`, `/=.`, `.<=`, `<=.`, `.>=`, `>=.`, `.>`, `>.`, `.<`, `<.`, `.&&`, `&&.`, `.||`, `||.`. These are useful for comparing signals with constants in a more readable way. For example, `a .==. pure True` can now be replaced with `a .== True`. [#2545](https://github.com/clash-lang/clash-compiler/pull/2545) +* instance `HasField f (Signal dom r) (Signal dom a)`. This means record dot accesses will be passed to the underlying type. For example, this will work: + + ```haskell + data MyRecord = MyRecord { myField :: Int } + + a :: Signal dom MyRecord + a = pure (MyRecord 3) + + b :: Signal dom Int + b = a.myField + ``` +* `BitPack` instance for `Data.Proxy.Proxy` +* `apEn`, which is a `mux` that optionally applies an update function to a value. [#3029](https://github.com/clash-lang/clash-compiler/pull/3029) +* `regEnN`, which is a chain of `regEn`s. [#3029](https://github.com/clash-lang/clash-compiler/pull/3029) +* `Index 0` instances for `BitPack`, `Bits`, `Counter`, `FiniteBits`, `Parity`, and `SaturatingNum`. [#2784](https://github.com/clash-lang/clash-compiler/pull/2784) +* Zero-sized block RAM implementations for `blockRam1` and `blockRamU`. [#2784](https://github.com/clash-lang/clash-compiler/pull/2784) +* `Counter a => Counter (Vec 0 a)` instance. [#2784](https://github.com/clash-lang/clash-compiler/pull/2784) +* `SaturatingNum` and `Bounded` instances for `Signal dom a`. The `sat` family (`satAdd`, `satSucc`, ...) can now be used on `Signal`s and `{min,max}Bound` can be used to construct them [#2931](https://github.com/clash-lang/clash-compiler/issues/2931) +* `-fclash-no-concurrent-topentity-compilation` flag to disable concurrent compilation of top entities. This is mostly useful to get a consistent debug output. +* `SomeBoundedSNat` and Hedgehog generators [#3183](https://github.com/clash-lang/clash-compiler/pull/3183) +* `Eq`, `NFData`, `ShowX` and `BitPack` instances for `RamOp`. +* `smapWithBounds` extending `smap` via offering a proof witness for the upper bound of the vector size to the mapping function. [#2686](https://github.com/clash-lang/clash-compiler/pull/2686) +* The function `Clash.Explicit.DDR.ddrForwardClock`, which uses a DDR output primitive to forward a clock signal to a DDR-capable output pin. [#2876](https://github.com/clash-lang/clash-compiler/pull/2876) + +Removed: +* Support for GHC versions 9.4 and older +* Newer Verilators (> v5) can deal with delay statements, hence removing the need for Clash specific workarounds. If you relied on Clash-generated Verilator shims, consider using `verilator --build --binary` instead. +* Experimental feature "multiple hidden domains" [#2750](https://github.com/clash-lang/clash-compiler/pull/2750) +* The deprecated module `Clash.Prelude.DataFlow` was removed. The `clash-protocols` package provides dataflow-based protocols and circuits. [#3181](https://github.com/clash-lang/clash-compiler/pull/3181) +* The deprecated functions `altpll` and `alteraPll` were removed from the `Clash.Intel.ClockGen` module. Clash 1.8 introduced the new functions `altpllSync`, `alteraPllSync`, `unsafeAltpll` and `unsafeAlteraPll`. A name for the IP instantiation, handled by the _name_ argument to `altpll` and `alteraPll`, can be provided with the `Clash.Magic.setName` function. [#3181](https://github.com/clash-lang/clash-compiler/pull/3181) + +Changed: +* `dfold` now offers a proof witness for the upper bound of the vector size to the folding function. Note that this change may require additional type annotations, as solutions working in the past may complain with an untouchable type error now. [#2686](https://github.com/clash-lang/clash-compiler/pull/2686) +* You can now only create an `SDomainConfiguration` when the `period` of the domain is at least `1`. Pattern matching on an `SDomainConfiguration` bring the `1 <= period` into scope. This in turns enables the following code to typecheck: + ``` + import Clash.Prelude + import Data.Proxy + + f :: + forall dom . + KnownDomain dom => + Proxy dom -> + SNat (PeriodToCycles dom (Milliseconds 1)) + f Proxy = case knownDomain @dom of + SDomainConfiguration {} -> SNat + ``` + where the `DivRU` in + ``` + type PeriodToCycles (dom :: Domain) (period :: Nat) = period `DivRU` DomainPeriod dom + ``` + requires that the `DomainPeriod dom` is at least `1`. [#2740](https://github.com/clash-lang/clash-compiler/pull/2740) +* `select` and `selectI` now use `<=` constraints instead of `CmpNat`. [#2873](https://github.com/clash-lang/clash-compiler/pull/2873) +* `ResetStrategy` now contains the reset function, to avoid dummy arguments on `NoClearOnReset` [#2849](https://github.com/clash-lang/clash-compiler/pull/2849) +* `Clash.Explicit.DDR`, `Clash.Intel.DDR` and `Clash.Xilinx.DDR`: [#2833](https://github.com/clash-lang/clash-compiler/pull/2833) + - The constraints for the functions have been rewritten to use `DomainPeriod`, which makes them more readable and relaxes unnecessary constraints on the virtual DDR domain. The type-level variables for the domains have been renamed. `dom` is a real domain, `domDDR` is the virtual DDR domain. + - The Xilinx and Intel primitives only support domains where the rising edge is the active edge. This is now enforced at the type level by adding a constraint. + - The Xilinx and Intel primitives now directly support any data type that has a `BitPack` instance. +* Order of type arguments for functions in `clash-prelude-hedgehog` now follows _size_, _domain_, _monad_. [#2880](https://github.com/clash-lang/clash-compiler/pull/2880) +* The Clash Prelude now exports the `Default` class from the package `data-default` instead of from the now superseded `data-default-class`. If you import the `Default` class name or the `def` function from the `data-default-class` package _older than version 0.2_, or one of your dependencies does, you might get a bewildering error message. You might get the error "No instance for (Default T)" even though there appears to be such an instance. The best solution is to make sure all your packages and dependencies use the `data-default` package and not the `data-default-class` package. The next most obvious solution is to make sure `data-default-class` is of version 0.2 or higher, for instance by depending on it in your own package. If this creates a dependency conflict, another solution is to import the correct module. `Default` and `def` from `Clash.Prelude` or `Data.Default` are for the new `data-default` package. `Data.Default.Class` is for the `data-default-class` package. There are situations where this will still not be enough, but luckily the `Default` class is not used all that much. [#2891](https://github.com/clash-lang/clash-compiler/pull/2891) +* Changed implementation of `(+>>)` to no longer require `KnownNat` +* The `clash-prelude` package now uses `PolyKinds` by default, meaning all its type class instances are now more general than before. As an example, without `PolyKinds`, `BitPack (Proxy a)` would only be defined when `a :: Type`, with the extension it would be defined for any `a :: k`. After this change, some instances in user code might now overlap. [#2994](https://github.com/clash-lang/clash-compiler/pull/2994) +* When generating (System)Verilog, Clash now resets the default net type from none to the verilog default after the generated module. [#3005](https://github.com/clash-lang/clash-compiler/pull/3005) +* The content from the `Clash.Tutorial` module and from https://clash-lang.readthedocs.io/ has been split and moved to two new locations. + 1. The actual tutorial parts has been moved to: https://docs.clash-lang.org/tutorial/ + 2. Parts that fit better in the clash compiler user guide have been moved to: https://docs.clash-lang.org/compiler-user-guide/ + + Moving the documentation to these locations makes it easier to update their content as it is no longer needed to release a new version of the `clash-prelude` package for the publication of this content. +* Vector functions in Verilog now have indices consistent with the Vec inputs/outputs (before they were reversed). This is convenient when writing design constraints, which can now be referenced consistently like `imap[0],imap[1],..`. See [#3088](https://github.com/clash-lang/clash-compiler/issues/3088). + +Fixed: +* Clash no longer gives `Dubious primitive instantiation warning` when using `unpack` [#2386](https://github.com/clash-lang/clash-compiler/issues/2386). +* Clash now generates more intuitive names for specialized binders. See [#2508](https://github.com/clash-lang/clash-compiler/issues/2508). +* `foldl` on `Vec` is now strict. See [this GitHub discussion](https://github.com/hasura/graphql-engine/pull/2933#discussion_r328821960) and [this blog post](https://well-typed.com/blog/90/) for more information. [#2482](https://github.com/clash-lang/clash-compiler/issues/2482) +* Type families that appear in GHC core types are now normalized before being translated into their Clash core equivalent. See [#3063](https://github.com/clash-lang/clash-compiler/issues/3063). +* Added an evaluator rule for `bigNatEq#` with compile-time constant arguments [#3084](https://github.com/clash-lang/clash-compiler/issues/3084) +* Reduce constants to NF before specialization [#3129](https://github.com/clash-lang/clash-compiler/issues/3129) +* `rotateL` and `rotateR` no longer error when used on `BitVector 0` [#2980](https://github.com/clash-lang/clash-compiler/issues/2980) +* Behavior of `shiftR` is now documented for `Unsigned`, `BitVector`, `Index`, and `Signed` [#2959](https://github.com/clash-lang/clash-compiler/issues/2959) +* Clash will no longer error if it finds the same data file more than once due to duplicate `-i` flags [#3141](https://github.com/clash-lang/clash-compiler/issues/3141) +* Higher order blackboxes not propagating usage metadata for generated results [#3147](https://github.com/clash-lang/clash-compiler/issues/3147) +* Run `caseCon` after post-normalization `inlineCleanup` [#3159](https://github.com/clash-lang/clash-compiler/issues/3159) +* Failure to generate binder assignments in very specific cases [#3185](https://github.com/clash-lang/clash-compiler/issues/3185) +* Clash won't create (invalid) netlist cases on Integer and Natural constructors anymore [#3157](https://github.com/clash-lang/clash-compiler/issues/3157) +* Post-normalization flattening could leave a `Just` constructor as the scrutinee of a `case` after simplifying tuple projections [#3204](https://github.com/clash-lang/clash-compiler/issues/3204) +* Clash no longer crashes on false positive free variable introduction in `reduceConst` and `constantSpec`. Fixes [#3206](https://github.com/clash-lang/clash-compiler/issues/3206). +* `negate` for `Num Bit` is now defined as the additive inverse, i.e., `negate = id`. [#2999](https://github.com/clash-lang/clash-compiler/issues/2999) + ## 1.8.5 *Mar 24th, 2026* Added: @@ -358,7 +458,7 @@ * Don't overflow the range of VHDL's natural type in shift/rotate, leading to simulation issues. Shift now saturates to a 31-bit shift amount. For rotate, in simulation only, the rotate amount is modulo the word width of the rotated value [#1874](https://github.com/clash-lang/clash-compiler/pull/1874) * `shiftL` for Clash datatypes does not cause a crash anymore when running Clash code with a really large shift amount [#1874](https://github.com/clash-lang/clash-compiler/pull/1874) * VHDL generated for `Signed.fromInteger` now truncates, like the Clash simulation, when the result is smaller than the argument [#1874](https://github.com/clash-lang/clash-compiler/pull/1874) - * Clash now preserves boolean combinatorial logic better when generating HDL [#1881](https://github.com/clash-lang/clash-compiler/issues/1881) + * Clash now preserves boolean combinational logic better when generating HDL [#1881](https://github.com/clash-lang/clash-compiler/issues/1881) * `valid` field of `TemplateFunction` is now checked for includes [#1945](https://github.com/clash-lang/clash-compiler/issues/1945) * Clash now generates clock generators that ensure that the amount of time between simulation start and the first active edge of the clock is equal to (/or longer than/) the period of the clock. The first active edges of the clocks do still occur simultaneously. [#2001](https://github.com/clash-lang/clash-compiler/issues/2001) * Expected values in assert become undefined when using `-fclash-compile-ultra` [#2040](https://github.com/clash-lang/clash-compiler/issues/2040) diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -34,6 +34,6 @@ - [Discourse: long form discussions and questions](https://clash-lang.discourse.group/) - [Discord: short form discussions and community chat room](https://discord.gg/rebGq25FB4) -- [Slack: short form discussions and questions](https://functionalprogramming.slack.com/archives/CPGMJFF50) - (Invite yourself at [fpslack.com](https://fpslack.com)) +- [Fosstodon: microblogging and community chat room](https://fosstodon.org/@ClashHDL) +- [Bluesky: microblogging and community chat room](https://bsky.app/profile/clash-lang.bsky.social) - [Github: issue tracker](https://github.com/clash-lang/clash-compiler/issues) diff --git a/clash-ghc.cabal b/clash-ghc.cabal --- a/clash-ghc.cabal +++ b/clash-ghc.cabal @@ -1,6 +1,6 @@ Cabal-version: 2.2 Name: clash-ghc -Version: 1.8.5 +Version: 1.10.0 Synopsis: Clash: a functional hardware description language - GHC frontend Description: Clash is a functional hardware description language that borrows both its @@ -42,6 +42,10 @@ 2017-2019, QBayLogic B.V., Google Inc. Category: Hardware Build-type: Simple +tested-with: GHC == 9.6.7, + GHC == 9.8.4, + GHC == 9.10.3, + GHC == 9.12.4 Extra-source-files: README.md, CHANGELOG.md, @@ -121,7 +125,9 @@ 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 @@ -129,24 +135,9 @@ HS-Source-Dirs: src-bin-9.8 elif impl(ghc >= 9.6.0) HS-Source-Dirs: src-bin-9.6 - elif impl(ghc >= 9.4.0) - HS-Source-Dirs: src-bin-9.4 - elif impl(ghc >= 9.2.0) - HS-Source-Dirs: src-bin-9.2 - elif impl(ghc >= 9.0.0) - HS-Source-Dirs: src-bin-9.0 - elif impl(ghc >= 8.10.0) - HS-Source-Dirs: src-bin-8.10 - elif impl(ghc >= 8.8.0) - HS-Source-Dirs: src-bin-881 - elif impl(ghc >= 8.6.0) - HS-Source-Dirs: src-bin-861 GHC-Options: -Wall -Wcompat - if impl(ghc >= 8.10.0) - CPP-Options: -DHAVE_INTERNAL_INTERPRETER - else - CPP-Options: -DGHCI + CPP-Options: -DHAVE_INTERNAL_INTERPRETER other-extensions: FlexibleContexts OverloadedStrings @@ -154,10 +145,10 @@ TemplateHaskell Build-Depends: array >= 0.4 && < 0.6, - base >= 4.11 && < 5, + base >= 4.18 && < 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, @@ -171,42 +162,26 @@ text >= 1.2.2 && < 2.2, transformers >= 0.5.2.0 && < 0.7, unordered-containers >= 0.2.1.0 && < 0.3, - - clash-lib == 1.8.5, - clash-prelude == 1.8.5, - ghc-typelits-extra >= 0.4 && < 0.6, - ghc-typelits-knownnat >= 0.7.2 && < 0.9, - ghc-typelits-natnormalise >= 0.7.2 && < 0.10, + clash-lib == 1.10.0, + clash-prelude == 1.10.0, + ghc-typelits-extra, + ghc-typelits-knownnat, + ghc-typelits-natnormalise, deepseq >= 1.3.0.2 && < 1.6, time >= 1.4.0.1 && < 1.15, - ghc-boot >= 8.6.0 && < 9.11, - ghc-prim >= 0.3.1.0 && < 0.13, - ghci >= 8.6.0 && < 9.11, + ghc >= 9.6.0 && < 9.13, + ghc-bignum >= 1.0 && < 1.4, + ghc-boot >= 9.6.0 && < 9.13, + ghc-prim >= 0.10 && < 0.14, + ghci >= 9.6.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(windows) - -- 8.8 is broken on Windows - it randomly segfaults - 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.11 - else - -- Unix - Build-Depends: ghc >= 8.6.0 && < 9.11 - - if impl(ghc >= 8.10.0) - Build-Depends: exceptions >= 0.10.4 && < 0.11, - - if impl(ghc >= 9.0.0) - Build-Depends: ghc-bignum >= 1.0 && < 1.4 - else - Build-Depends: integer-gmp >= 1.0.1.0 && < 2.0 + vector >= 0.11 && < 1.0, + exceptions >= 0.10.4 && < 0.11, if flag(use-ghc-paths) Build-Depends: ghc-paths @@ -247,10 +222,9 @@ Clash.GHC.GHC2Core Clash.GHC.LoadInterfaceFiles Clash.GHC.Util + Clash.GHCi.Util Data.Text.Extra Paths_clash_ghc - if impl(ghc >= 8.8.0) - Other-Modules: Clash.GHCi.Util if impl(ghc >= 9.8.0) Other-Modules: Clash.GHCi.UI.Exception diff --git a/src-bin-8.10/Clash/GHCi/Leak.hs b/src-bin-8.10/Clash/GHCi/Leak.hs deleted file mode 100644 --- a/src-bin-8.10/Clash/GHCi/Leak.hs +++ /dev/null @@ -1,74 +0,0 @@ -{-# 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 HscTypes -import Outputable -import GHC.Platform (target32Bit) -import Prelude -import System.Mem -import System.Mem.Weak -import UniqDFM - --- 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 HscEnv{..} = - fmap LeakIndicators $ - forM (eltsUDFM hsc_HPT) $ \hmi@HomeModInfo{..} -> do - leakMod <- mkWeakPtr hmi Nothing - leakIface <- mkWeakPtr hm_iface Nothing - leakDetails <- mkWeakPtr hm_details Nothing - leakLinkable <- mapM (`mkWeakPtr` Nothing) hm_linkable - return $ LeakModIndicators{..} - --- | 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 >>= report "ModIface" - deRefWeak leakDetails >>= report "ModDetails" - forM_ leakLinkable $ \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)) diff --git a/src-bin-8.10/Clash/GHCi/UI.hs b/src-bin-8.10/Clash/GHCi/UI.hs deleted file mode 100644 --- a/src-bin-8.10/Clash/GHCi/UI.hs +++ /dev/null @@ -1,4286 +0,0 @@ -{-# OPTIONS_GHC -Wno-name-shadowing #-} -{-# LANGUAGE BangPatterns #-} -{-# LANGUAGE CPP #-} -{-# LANGUAGE LambdaCase #-} -{-# LANGUAGE MagicHash #-} -{-# LANGUAGE MultiWayIf #-} -{-# LANGUAGE NondecreasingIndentation #-} -{-# LANGUAGE OverloadedStrings #-} -{-# LANGUAGE RecordWildCards #-} -{-# LANGUAGE ScopedTypeVariables #-} -{-# LANGUAGE TupleSections #-} -{-# LANGUAGE ViewPatterns #-} - ------------------------------------------------------------------------------ --- --- GHC Interactive User Interface --- --- (c) The GHC Team 2005-2006 --- ------------------------------------------------------------------------------ - -module Clash.GHCi.UI ( - interactiveUI, - GhciSettings(..), - defaultGhciSettings, - ghciCommands, - ghciWelcomeMsg, - makeHDL - ) where - -#include "HsVersions.h" - --- GHCi -import qualified Clash.GHCi.UI.Monad as GhciMonad ( args, runStmt, runDecls' ) -import Clash.GHCi.UI.Monad hiding ( args, runStmt ) -import Clash.GHCi.UI.Tags -import Clash.GHCi.UI.Info -import Debugger - --- The GHC interface -import GHCi -import GHCi.RemoteTypes -import GHCi.BreakArray -import DynFlags -import ErrUtils hiding (traceCmd) -import Finder -import GhcMonad ( modifySession ) -import qualified GHC -import GHC ( LoadHowMuch(..), Target(..), TargetId(..), InteractiveImport(..), - TyThing(..), Phase, BreakIndex, Resume, SingleStep, Ghc, - GetDocsFailure(..), - getModuleGraph, handleSourceError ) -import HscMain (hscParseDeclsWithLocation, hscParseStmtWithLocation) -import GHC.Hs.ImpExp -import GHC.Hs -import HscTypes ( tyThingParent_maybe, handleFlagWarnings, getSafeMode, hsc_IC, - setInteractivePrintName, hsc_dflags, msObjFilePath, runInteractiveHsc, - hsc_dynLinker ) -import Module -import Name -import Packages ( trusted, getPackageDetails, getInstalledPackageDetails, - listVisibleModuleNames, pprFlag ) -import IfaceSyn ( showToHeader ) -import PprTyThing -import PrelNames -import RdrName ( getGRE_NameQualifier_maybes, getRdrName ) -import SrcLoc -import qualified Lexer - -import StringBuffer -import Outputable hiding ( printForUser, printForUserPartWay ) - -import DynamicLoading ( initializePlugins ) - --- Other random utilities -import BasicTypes hiding ( isTopLevel ) -import Digraph -import Encoding -import FastString -import Linker -import Maybes ( orElse, expectJust ) -import NameSet -import Panic hiding ( showException ) -import Util -import qualified GHC.LanguageExtensions as LangExt -import Bag (unitBag) - --- Haskell Libraries -import System.Console.Haskeline as Haskeline - -import Control.Applicative hiding (empty) -import Control.DeepSeq (deepseq) -import Control.Monad as Monad -import Control.Monad.IO.Class -import Control.Monad.Trans.Class -import Control.Monad.Trans.Except - -import Data.Array -import qualified Data.ByteString.Char8 as BS -import Data.Char -import Data.Function -import Data.IORef ( IORef, modifyIORef, newIORef, readIORef, writeIORef ) -import Data.List ( find, group, intercalate, intersperse, isPrefixOf, - isSuffixOf, nub, partition, sort, sortBy, (\\) ) -import Data.Proxy -import qualified Data.Set as S -import Data.Maybe -import Data.Map (Map) -import qualified Data.Map as M -import qualified Data.IntMap.Strict as IntMap -import Data.Time.LocalTime ( getZonedTime ) -import Data.Time.Format ( formatTime, defaultTimeLocale ) -import Data.Version ( showVersion ) -import Prelude hiding ((<>)) - -import Exception hiding (catch) -import Foreign hiding (void) -import GHC.Stack hiding (SrcLoc(..)) - -import System.Directory -import System.Environment -import System.Exit ( exitWith, ExitCode(..) ) -import System.FilePath -import System.Info -import System.IO -import System.IO.Error -import System.IO.Unsafe ( unsafePerformIO ) -import System.Process -import Text.Printf -import Text.Read ( readMaybe ) -import Text.Read.Lex (isSymbolChar) - -import Unsafe.Coerce - -#if !defined(mingw32_HOST_OS) -import System.Posix hiding ( getEnv ) -#else -import qualified System.Win32 -#endif - -import GHC.IO.Exception ( IOErrorType(InvalidArgument) ) -import GHC.IO.Handle ( hFlushAll ) -import GHC.TopHandler ( topHandler ) - -import Clash.GHCi.Leak - --- clash additions -import Clash.Backend (Backend(initBackend, hdlKind, primDirs)) -import Clash.Backend.SystemVerilog (SystemVerilogState) -import Clash.Backend.VHDL (VHDLState) -import Clash.Backend.Verilog (VerilogState) -import qualified Clash.Driver -import Clash.Driver.Bool (fromGhcOverridingBool) -import Clash.Driver.Types (ClashOpts(..), ClashEnv(..), ClashDesign(..)) - -import Clash.GHC.PartialEval -import Clash.GHC.Evaluator -import Clash.GHC.GenerateBindings -import Clash.GHC.NetlistTypes -import Clash.GHCi.Common -import Clash.Util (clashLibVersion, reportTimeDiff) -import qualified Data.Time.Clock as Clock -import qualified Paths_clash_ghc - ------------------------------------------------------------------------------ - -data GhciSettings = GhciSettings { - availableCommands :: [Command], - shortHelpText :: String, - fullHelpText :: String, - defPrompt :: PromptFunction, - defPromptCont :: PromptFunction - } - -defaultGhciSettings :: IORef ClashOpts -> GhciSettings -defaultGhciSettings opts = - GhciSettings { - availableCommands = ghciCommands opts, - shortHelpText = defShortHelpText, - defPrompt = default_prompt, - defPromptCont = default_prompt_cont, - fullHelpText = defFullHelpText - } - -ghciWelcomeMsg :: String -ghciWelcomeMsg = "Clashi, version " ++ Data.Version.showVersion Paths_clash_ghc.version ++ - " (using clash-lib, version " ++ Data.Version.showVersion clashLibVersion ++ - "):\nhttps://clash-lang.org/ :? for help" - -ghciCommands :: IORef ClashOpts -> [Command] -ghciCommands opts = map mkCmd [ - -- Hugs users are accustomed to :e, so make sure it doesn't overlap - ("?", keepGoing help, noCompletion), - ("add", keepGoingPaths addModule, completeFilename), - ("abandon", keepGoing abandonCmd, noCompletion), - ("break", keepGoing breakCmd, completeIdentifier), - ("back", keepGoing backCmd, noCompletion), - ("browse", keepGoing' (browseCmd False), completeModule), - ("browse!", keepGoing' (browseCmd True), completeModule), - ("cd", keepGoing' changeDirectory, completeFilename), - ("check", keepGoing' checkModule, completeHomeModule), - ("continue", keepGoing continueCmd, noCompletion), - ("cmd", keepGoing cmdCmd, completeExpression), - ("ctags", keepGoing createCTagsWithLineNumbersCmd, completeFilename), - ("ctags!", keepGoing createCTagsWithRegExesCmd, completeFilename), - ("def", keepGoing (defineMacro False), completeExpression), - ("def!", keepGoing (defineMacro True), completeExpression), - ("delete", keepGoing deleteCmd, noCompletion), - ("disable", keepGoing disableCmd, noCompletion), - ("doc", keepGoing' docCmd, completeIdentifier), - ("edit", keepGoing' editFile, completeFilename), - ("enable", keepGoing enableCmd, noCompletion), - ("etags", keepGoing createETagsFileCmd, completeFilename), - ("force", keepGoing forceCmd, completeExpression), - ("forward", keepGoing forwardCmd, noCompletion), - ("help", keepGoing help, noCompletion), - ("history", keepGoing historyCmd, noCompletion), - ("info", keepGoing' (info False), completeIdentifier), - ("info!", keepGoing' (info True), completeIdentifier), - ("issafe", keepGoing' isSafeCmd, completeModule), - ("kind", keepGoing' (kindOfType False), completeIdentifier), - ("kind!", keepGoing' (kindOfType True), completeIdentifier), - ("load", keepGoingPaths loadModule_, completeHomeModuleOrFile), - ("load!", keepGoingPaths loadModuleDefer, completeHomeModuleOrFile), - ("list", keepGoing' listCmd, noCompletion), - ("module", keepGoing moduleCmd, completeSetModule), - ("main", keepGoing runMain, completeFilename), - ("print", keepGoing printCmd, completeExpression), - ("quit", quit, noCompletion), - ("reload", keepGoing' reloadModule, noCompletion), - ("reload!", keepGoing' reloadModuleDefer, noCompletion), - ("run", keepGoing runRun, completeFilename), - ("script", keepGoing' scriptCmd, completeFilename), - ("set", keepGoing setCmd, completeSetOptions), - ("seti", keepGoing setiCmd, completeSeti), - ("show", keepGoing showCmd, completeShowOptions), - ("showi", keepGoing showiCmd, completeShowiOptions), - ("sprint", keepGoing sprintCmd, completeExpression), - ("step", keepGoing stepCmd, completeIdentifier), - ("steplocal", keepGoing stepLocalCmd, completeIdentifier), - ("stepmodule",keepGoing stepModuleCmd, completeIdentifier), - ("type", keepGoing' typeOfExpr, completeExpression), - ("trace", keepGoing traceCmd, completeExpression), - ("unadd", keepGoingPaths unAddModule, completeFilename), - ("undef", keepGoing undefineMacro, completeMacro), - ("unset", keepGoing unsetOptions, completeSetOptions), - ("where", keepGoing whereCmd, noCompletion), - ("vhdl", keepGoingPaths (makeVHDL opts), completeHomeModuleOrFile), - ("verilog", keepGoingPaths (makeVerilog opts), completeHomeModuleOrFile), - ("systemverilog", keepGoingPaths (makeSystemVerilog opts), completeHomeModuleOrFile), - ("instances", keepGoing' instancesCmd, completeExpression) - ] ++ map mkCmdHidden [ -- hidden commands - ("all-types", keepGoing' allTypesCmd), - ("complete", keepGoing completeCmd), - ("loc-at", keepGoing' locAtCmd), - ("type-at", keepGoing' typeAtCmd), - ("uses", keepGoing' usesCmd) - ] - where - mkCmd (n,a,c) = Command { cmdName = n - , cmdAction = a - , cmdHidden = False - , cmdCompletionFunc = c - } - - mkCmdHidden (n,a) = Command { cmdName = n - , cmdAction = a - , cmdHidden = True - , cmdCompletionFunc = noCompletion - } - --- We initialize readline (in the interactiveUI function) to use --- word_break_chars as the default set of completion word break characters. --- This can be overridden for a particular command (for example, filename --- expansion shouldn't consider '/' to be a word break) by setting the third --- entry in the Command tuple above. --- --- NOTE: in order for us to override the default correctly, any custom entry --- must be a SUBSET of word_break_chars. -word_break_chars :: String -word_break_chars = spaces ++ specials ++ symbols - -symbols, specials, spaces :: String -symbols = "!#$%&*+/<=>?@\\^|-~" -specials = "(),;[]`{}" -spaces = " \t\n" - -flagWordBreakChars :: String -flagWordBreakChars = " \t\n" - - -keepGoing :: (String -> GHCi ()) -> (String -> InputT GHCi Bool) -keepGoing a str = keepGoing' (lift . a) str - -keepGoing' :: Monad m => (String -> m ()) -> String -> m Bool -keepGoing' a str = a str >> return False - -keepGoingPaths :: ([FilePath] -> InputT GHCi ()) -> (String -> InputT GHCi Bool) -keepGoingPaths a str - = do case toArgs str of - Left err -> liftIO $ hPutStrLn stderr err - Right args -> a args - return False - -defShortHelpText :: String -defShortHelpText = "use :? for help.\n" - -defFullHelpText :: String -defFullHelpText = - " Commands available from the prompt:\n" ++ - "\n" ++ - " evaluate/run \n" ++ - " : repeat last command\n" ++ - " :{\\n ..lines.. \\n:}\\n multiline command\n" ++ - " :add [*] ... add module(s) to the current target set\n" ++ - " :browse[!] [[*]] display the names defined by module \n" ++ - " (!: more details; *: all top-level names)\n" ++ - " :cd change directory to \n" ++ - " :cmd run the commands returned by ::IO String\n" ++ - " :complete [] list completions for partial input string\n" ++ - " :ctags[!] [] create tags file for Vi (default: \"tags\")\n" ++ - " (!: use regex instead of line number)\n" ++ - " :def[!] define command : (later defined command has\n" ++ - " precedence, :: is always a builtin command)\n" ++ - " (!: redefine an existing command name)\n" ++ - " :doc display docs for the given name (experimental)\n" ++ - " :edit edit file\n" ++ - " :edit edit last module\n" ++ - " :etags [] create tags file for Emacs (default: \"TAGS\")\n" ++ - " :help, :? display this list of commands\n" ++ - " :info[!] [ ...] display information about the given names\n" ++ - " (!: do not filter instances)\n" ++ - " :instances display the class instances available for \n" ++ - " :issafe [] display safe haskell information of module \n" ++ - " :kind[!] show the kind of \n" ++ - " (!: also print the normalised type)\n" ++ - " :load[!] [*] ... load module(s) and their dependents\n" ++ - " (!: defer type errors)\n" ++ - " :main [ ...] run the main function with the given arguments\n" ++ - " :module [+/-] [*] ... set the context for expression evaluation\n" ++ - " :quit exit GHCi\n" ++ - " :reload[!] reload the current module set\n" ++ - " (!: defer type errors)\n" ++ - " :run function [ ...] run the function with the given arguments\n" ++ - " :script run the script \n" ++ - " :type show the type of \n" ++ - " :type +d show the type of , defaulting type variables\n" ++ - " :type +v show the type of , with its specified tyvars\n" ++ - " :unadd ... remove module(s) from the current target set\n" ++ - " :undef undefine user-defined command :\n" ++ - " :: run the builtin command\n" ++ - " :! run the shell command \n" ++ - " :vhdl synthesize currently loaded module to vhdl\n" ++ - " :vhdl [] synthesize specified modules/files to vhdl\n" ++ - " :verilog synthesize currently loaded module to verilog\n" ++ - " :verilog [] synthesize specified modules/files to verilog\n" ++ - " :systemverilog synthesize currently loaded module to systemverilog\n" ++ - " :systemverilog [] synthesize specified modules/files to systemverilog\n" ++ - "\n" ++ - " -- Commands for debugging:\n" ++ - "\n" ++ - " :abandon at a breakpoint, abandon current computation\n" ++ - " :back [] go back in the history N steps (after :trace)\n" ++ - " :break [] [] set a breakpoint at the specified location\n" ++ - " :break set a breakpoint on the specified function\n" ++ - " :continue resume after a breakpoint\n" ++ - " :delete ... delete the specified breakpoints\n" ++ - " :delete * delete all breakpoints\n" ++ - " :disable ... disable the specified breakpoints\n" ++ - " :disable * disable all breakpoints\n" ++ - " :enable ... enable the specified breakpoints\n" ++ - " :enable * enable all breakpoints\n" ++ - " :force print , forcing unevaluated parts\n" ++ - " :forward [] go forward in the history N step s(after :back)\n" ++ - " :history [] after :trace, show the execution history\n" ++ - " :list show the source code around current breakpoint\n" ++ - " :list show the source code for \n" ++ - " :list [] show the source code around line number \n" ++ - " :print [ ...] show a value without forcing its computation\n" ++ - " :sprint [ ...] simplified version of :print\n" ++ - " :step single-step after stopping at a breakpoint\n"++ - " :step single-step into \n"++ - " :steplocal single-step within the current top-level binding\n"++ - " :stepmodule single-step restricted to the current module\n"++ - " :trace trace after stopping at a breakpoint\n"++ - " :trace evaluate with tracing on (see :history)\n"++ - - "\n" ++ - " -- Commands for changing settings:\n" ++ - "\n" ++ - " :set