Documentation

Fields

• envOpts :: ClashOpts
   
• envTyConMap :: TyConMap
   
• envTupleTyCons :: IntMap TyConName
   
• envPrimitives :: CompiledPrimMap
   
• envCustomReprs :: CustomReprs
   
• envDomains :: DomainMap
   

Fields

• designEntities :: [TopEntityT]
   
• designBindings :: BindingMap
   

Fields

• bindingId :: Id

  The core identifier for this binding.

• bindingLoc :: SrcSpan

  The source location of this binding in the original source code.

• bindingSpec :: InlineSpec

  the inline specification for this binding, in the original source code.

• bindingIsPrim :: IsPrim

  Is the binding a core term corresponding to a primitive with a known implementation? If so, it can potentially be inlined despite being marked as NOINLINE in source.

• bindingTerm :: a

  The term representation for this binding. This is polymorphic so alternate representations can be used if more appropriate (i.e. in the evaluator this can be Value for evaluated bindings).

• bindingRecursive :: Bool

  Whether the binding is recursive.

  TODO Ideally the BindingMap would store recursive and non-recursive bindings in a way similar to Let / Letrec. GHC also does this.

Fields

• dbg_invariants :: Bool

  Check that the results of applied transformations do not violate the invariants for rewriting (e.g. no accidental shadowing, or type changes).

  Command line flag: -fclash-debug-invariants

• dbg_transformationInfo :: TransformationInfo

  The information to show when debugging a transformation. See the TransformationInfo type for different configurations.

  Command line flag: -fclash-debug-info (None|FinalTerm|AppliedName|AppliedTerm|TryName|TryTerm)

• dbg_transformations :: Set String

  List the transformations that are being debugged. When the set is empty, all transformations are debugged.

  Command line flag: -fclash-debug-transformations t1[,t2...]

• dbg_countTransformations :: Bool

  Count how many times transformations are applied and provide a summary at the end of normalization. This includes all transformations, not just those in dbg_transformations.

  Command line flag: -fclash-debug-count-transformations

• dbg_transformationsFrom :: Maybe Word

  Debug transformations applied after the nth transformation applied. This includes all transformations, not just those in dbg_transformations.

  Command line flag: -fclash-debug-transformations-from=N

• dbg_transformationsLimit :: Maybe Word

  Debug up to the nth applied transformation. If this limit is exceeded then Clash will error. This includes all transformations, not just those in dbg_transformations.

  Command line flag: -fclash-debug-transformations-limit=N

• dbg_historyFile :: Maybe FilePath

  Save information about all applied transformations to a history file for use with clash-term.

  Command line flag: -fclash-debug-history[=FILE]

Fields

• opt_werror :: Bool

  Are warnings treated as errors.

  Command line flag: -Werror

• opt_inlineLimit :: Int

  Change the number of times a function f can undergo inlining inside some other function g. This prevents the size of g growing dramatically.

  Command line flag: -fclash-inline-limit

• opt_specLimit :: Int

  Change the number of times a function can undergo specialization.

  Command line flag: -fclash-spec-limit

• opt_inlineFunctionLimit :: Word

  Set the threshold for function size. Below this threshold functions are always inlined (if it is not recursive).

  Command line flag: -fclash-inline-function-limit

• opt_inlineConstantLimit :: Word

  Set the threshold for constant size. Below this threshold constants are always inlined. A value of 0 inlines all constants.

  Command line flag: -fclash-inline-constant-limit

• opt_evaluatorFuelLimit :: Word

  Set the threshold for maximum unfolding depth in the evaluator. A value of zero means no potentially non-terminating binding is unfolded.

  Command line flag: -fclash-evaluator-fuel-limit

• opt_debug :: DebugOpts

  Options which control debugging. See DebugOpts.

• opt_cachehdl :: Bool

  Reuse previously generated output from Clash. Only caches topentities.

  Command line flag: -fclash-no-cache

• opt_clear :: Bool

  Remove HDL directories before writing to them. By default, Clash will only write to non-empty directories if it can prove all files in it are generated by a previous run. This option applies to directories of the various top entities, i.e., the subdirectories made in the directory passed in with -fclash-hdldir. Note that Clash will still use a cache if it can.

  Command line flag: -fclash-clear

• opt_primWarn :: Bool

  Disable warnings for primitives

  Command line flag: -fclash-no-prim-warn

• opt_color :: OverridingBool

  Show colors in debug output

  Command line flag: -fdiagnostics-color

• opt_intWidth :: Int

  Set the bit width for the Int/Word/Integer types. The only allowed values are 32 or 64.

• opt_hdlDir :: Maybe String

  Directory to save HDL files to

• opt_hdlSyn :: HdlSyn

  Synthesis target. See HdlSyn for available options.

• opt_errorExtra :: Bool

  Show additional information in error messages

• opt_importPaths :: [FilePath]

  Paths where Clash should look for modules

• opt_componentPrefix :: Maybe Text

  Prefix components with given string

• opt_newInlineStrat :: Bool

  Use new inline strategy. Functions marked NOINLINE will get their own HDL module.

• opt_escapedIds :: Bool

  Use escaped identifiers in HDL. See:

  • https://peterfab.com/ref/vhdl/vhdl_renerta/source/vhd00037.htm
  • https://peterfab.com/ref/verilog/verilog_renerta/source/vrg00018.htm
• opt_lowerCaseBasicIds :: PreserveCase

  Force all generated basic identifiers to lowercase. Among others, this affects module and file names.

• opt_ultra :: Bool

  Perform a high-effort compile, trading improved performance for potentially much longer compile times.

  Name inspired by Design Compiler's compile_ultra flag.

• opt_forceUndefined :: Maybe (Maybe Int)
  • Nothing: generate undefined's in the HDL
  • Just Nothing: replace undefined's by a constant in the HDL; the compiler decides what's best
  • Just (Just x): replace undefined's by x in the HDL
• opt_checkIDir :: Bool

  Check whether paths specified in opt_importPaths exists on the filesystem.

• opt_aggressiveXOpt :: Bool

  Enable aggressive X optimization, which may remove undefineds from generated HDL by replaced with defined alternatives.

• opt_aggressiveXOptBB :: Bool

  Enable aggressive X optimization, which may remove undefineds from HDL generated by blackboxes. This enables the ~ISUNDEFINED template tag.

• opt_inlineWFCacheLimit :: Word

  At what size do we cache normalized work-free top-level binders.

• opt_edalize :: Bool

  Generate an EDAM file for use with Edalize.

• opt_renderEnums :: Bool

  Render sum types with all zero-width fields as enums where supported, as opposed to rendering them as bitvectors.

• opt_timescalePrecision :: Period

  Timescale precision set in Verilog files. E.g., setting this would sets the second part of `timescale 100fs/100fs.

• opt_ignoreBrokenGhcs :: Bool

  Don't error if we see a (potentially) broken GHC / platform combination. See the project's README.md for more information.

Fields

• sdcClock :: [(Text, VDomainConfiguration)]