Clash.Driver

Module that connects all the parts of the Clash compiler library

Documentation

splitTopAnn

Arguments

:: TyConMap

-> SrcSpan

Source location of top entity (for error reporting)

-> Type

Top entity body

-> TopEntity

Port annotations for top entity

-> TopEntity

New top entity with split ports (or the old one if not applicable)

Worker function of splitTopEntityT

splitTopEntityT :: HasCallStack => TyConMap -> BindingMap -> TopEntityT -> TopEntityT

getClashModificationDate :: IO UTCTime

Get modification data of current clash binary.

generateHDL

Arguments

:: forall backend. Backend backend

=> CustomReprs

-> BindingMap

Set of functions

-> Maybe backend

-> CompiledPrimMap

Primitive / BlackBox Definitions

-> TyConMap

TyCon cache

-> IntMap TyConName

Tuple TyCon cache

-> (CustomReprs -> TyConMap -> Type -> State HWMap (Maybe (Either String FilteredHWType)))

Hardcoded Type -> HWType translator

-> (PrimStep, PrimUnwind)

Hardcoded evaluator (delta-reduction)

-> [TopEntityT]

All topentities and associated testbench

-> Maybe (TopEntityT, [TopEntityT])

Main top entity to compile. If Nothing, all top entities in previous argument will be compiled.

-> ClashOpts

Debug information level for the normalization process

-> (UTCTime, UTCTime)

-> IO ()

Create a set of target HDL files for a set of functions

loadImportAndInterpret

Arguments

:: (MonadIO m, MonadMask m)

=> [String]

Extra search path (usually passed as -i)

-> [String]

Interpreter args

-> String

The folder in which the GHC bootstrap libraries (base, containers, etc.) can be found

-> ModuleName

Module function lives in

-> String

Function name

-> String

Type name (BlackBoxFunction or TemplateFunction)

-> m (Either InterpreterError a)

Interpret a specific function from a specific module. This action tries two things:

1. Interpret without explicitly loading the module. This will succeed if the module was already loaded through a package database (set using interpreterArgs).
2. If (1) fails, it does try to load it explicitly. If this also fails, an error is returned.

knownBlackBoxFunctions :: HashMap String BlackBoxFunction

List of known BlackBoxFunctions used to prevent Hint from firing. This improves Clash startup times.

knownTemplateFunctions :: HashMap String TemplateFunction

List of known TemplateFunctions used to prevent Hint from firing. This improves Clash startup times.

compilePrimitive

Arguments

:: [FilePath]

Import directories (-i flag)

-> [FilePath]

Package databases

-> FilePath

The folder in which the GHC bootstrap libraries (base, containers, etc.) can be found

-> ResolvedPrimitive

Primitive to compile

-> IO CompiledPrimitive

Compiles blackbox functions and parses blackbox templates.

processHintError :: Monad m => String -> Text -> (t -> r) -> Either InterpreterError t -> m r

createHDL

Arguments

:: Backend backend

=> backend

Backend

-> Identifier

Module hierarchy root

-> HashMap Identifier Word

Component names

-> VarEnv ([Bool], SrcSpan, HashMap Identifier Word, Component)

List of components

-> Component

Top component

-> (Identifier, Either Manifest Manifest)

Name of the manifest file + Either: * Left manifest: Only write/update the hashes of the manifest * Right manifest: Update all fields of the manifest

-> ([(String, Doc)], Manifest, [(String, FilePath)], [(String, String)])

The pretty-printed HDL documents + The update manifest file + The data files that need to be copied

Pretty print Components to HDL Documents

prepareDir

Arguments

:: Bool

Remove existing HDL files

-> String

File extension of the HDL files.

-> String

-> IO ()

Prepares the directory for writing HDL files. This means creating the dir if it does not exist and removing all existing .hdl files from it.

writeHDL :: FilePath -> (String, Doc) -> IO ()

Writes a HDL file to the given directory

writeMemoryDataFiles

Arguments

:: FilePath

Directory to copy files to

-> [(String, String)]

(filename, content)

-> IO ()

Copy given files

copyDataFiles :: [FilePath] -> FilePath -> [(String, FilePath)] -> IO ()

callGraphBindings

Arguments

:: BindingMap

All bindings

-> Id

Root of the call graph

-> [Term]

Get all the terms corresponding to a call graph

normalizeEntity

Arguments

:: CustomReprs

-> BindingMap

All bindings

-> CompiledPrimMap

BlackBox HDL templates

-> TyConMap

TyCon cache

-> IntMap TyConName

Tuple TyCon cache

-> (CustomReprs -> TyConMap -> Type -> State HWMap (Maybe (Either String FilteredHWType)))

Hardcoded Type -> HWType translator

-> (PrimStep, PrimUnwind)

Hardcoded evaluator (delta-reduction)

-> [Id]

TopEntities

-> ClashOpts

Debug information level for the normalization process

-> Supply

Unique supply

-> Id

root of the hierarchy

-> BindingMap

Normalize a complete hierarchy

sortTop :: BindingMap -> [TopEntityT] -> [TopEntityT]

topologically sort the top entities