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

removeForAll :: TopEntityT -> TopEntityT

Remove constraints such as 'a ~ 3'.

selectTopEntities :: [TopEntityT] -> Maybe (TopEntityT, [TopEntityT]) -> [TopEntityT]

Given a list of all found top entities and _maybe_ a top entity (+dependencies) passed in by '-main-is', return the list of top entities Clash needs to compile.

getClashModificationDate :: IO UTCTime

Get modification data of current clash binary.

hdlFromBackend :: forall backend. Backend backend => Proxy backend -> HDL

replaceChar :: Char -> Char -> String -> String

removeHistoryFile :: Maybe FilePath -> IO ()

prefixModuleName :: HDL -> Maybe Text -> Maybe TopEntity -> String -> (String, Maybe String)

generateHDL

Arguments

:: forall backend. Backend backend

=> ClashEnv

-> ClashDesign

-> Maybe backend

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

Hardcoded Type -> HWType translator

-> Evaluator

Hardcoded evaluator for partial evaluation

-> Evaluator

Hardcoded evaluator for WHNF (old evaluator)

-> Maybe (TopEntityT, [TopEntityT])

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

-> 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 (NonEmpty 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.

newtype HintError

Constructors

HintError String

Instances

Show HintError

Defined in Clash.Driver

Methods

showsPrec :: Int -> HintError -> ShowS

show :: HintError -> String

showList :: [HintError] -> ShowS

Exception HintError

Defined in Clash.Driver

Methods

toException :: HintError -> SomeException

fromException :: SomeException -> Maybe HintError

displayException :: HintError -> String

processHintErrors

Arguments

:: (MonadThrow m, Monad m)

=> String

Function to interpret

-> Text

BlackBox function name

-> Either (NonEmpty InterpreterError) t

Hint result

-> m t

createHDL

Arguments

:: Backend backend

=> backend

Backend

-> ClashOpts

Global Clash options

-> IdentifierText

Module hierarchy root

-> IdentifierSet

Component names

-> ComponentMap

List of components

-> HashMap Text VDomainConfiguration

Known domains to configurations

-> Component

Top component

-> IdentifierText

Name of the manifest file

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

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

Pretty print Components to HDL Documents

writeVerilatorShim :: FilePath -> Identifier -> [(FilePath, ByteString)] -> IO [(FilePath, ByteString)]

pprVerilatorShim :: Identifier -> Doc

Create a shim for using verilator, which loads the entity and steps through simulation until finished.

writeEdam :: FilePath -> (Identifier, Unique) -> HashMap Unique [Unique] -> HashMap Unique [EdamFile] -> [(FilePath, ByteString)] -> IO (HashMap Unique [EdamFile], [(FilePath, ByteString)])

createEDAM

Arguments

:: (Identifier, Unique)

-> HashMap Unique [Unique]

Top entity dependency map

-> HashMap Unique [EdamFile]

Edam files of each top entity

-> [FilePath]

Files to include in Edam file

-> (HashMap Unique [EdamFile], Edam)

(updated map, edam)

Create an Edalize metadata file for using Edalize to build the project.

TODO: Handle libraries. Also see: https://github.com/olofk/edalize/issues/220

asEdamFile :: Identifier -> FilePath -> EdamFile

prepareDir

Arguments

:: FilePath

HDL directory to prepare

-> ClashOpts

Relevant options: -fclash-no-clean

-> Maybe [UnexpectedModification]

Did directory contain unexpected modifications? See readFreshManifest

-> IO ()

Prepares directory for writing HDL files.

writeAndHash :: FilePath -> ByteString -> IO ByteString

Write a file to disk in chunks. Returns SHA256 sum of file contents.

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

Writes a HDL file to the given directory. Returns SHA256 hash of written file.

writeMemoryDataFiles

Arguments

:: FilePath

Directory to copy files to

-> [(FilePath, String)]

(filename, content)

-> IO [ByteString]

Copy given files

copyDataFiles

Arguments

:: [FilePath]

Import directories passed in with -i

-> FilePath

Directory to copy to

-> [(FilePath, FilePath)]

(name of newly made file in HDL output dir, file to copy)

-> IO [ByteString]

SHA256 hashes of written files

Copy data files added with ~FILE

normalizeEntity

Arguments

:: ClashEnv

-> BindingMap

All bindings

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

Hardcoded Type -> HWType translator

-> Evaluator

Hardcoded evaluator for partial evaluation

-> Evaluator

Hardcoded evaluator for WHNF (old evaluator)

-> [Id]

TopEntities

-> Supply

Unique supply

-> Id

root of the hierarchy

-> IO BindingMap

Normalize a complete hierarchy

sortTop :: BindingMap -> [TopEntityT] -> ([TopEntityT], HashMap Unique [Unique])

Reverse topologically sort given top entities. Also returns a mapping that maps a top entity to its reverse topologically sorted transitive dependencies.