Clash.Driver.Manifest

Functions to read, write, and handle manifest files.

Documentation

data PortDirection

Constructors

In

Out

InOut

Instances

Eq PortDirection

Defined in Clash.Driver.Manifest

Methods

(==) :: PortDirection -> PortDirection -> Bool

(/=) :: PortDirection -> PortDirection -> Bool

Read PortDirection

Defined in Clash.Driver.Manifest

Methods

readsPrec :: Int -> ReadS PortDirection

readList :: ReadS [PortDirection]

readPrec :: ReadPrec PortDirection

readListPrec :: ReadPrec [PortDirection]

Show PortDirection

Defined in Clash.Driver.Manifest

Methods

showsPrec :: Int -> PortDirection -> ShowS

show :: PortDirection -> String

showList :: [PortDirection] -> ShowS

Generic PortDirection

Defined in Clash.Driver.Manifest

Associated Types

type Rep PortDirection :: Type -> Type

Methods

from :: PortDirection -> Rep PortDirection x

to :: Rep PortDirection x -> PortDirection

ToJSON PortDirection

Defined in Clash.Driver.Manifest

Methods

toJSON :: PortDirection -> Value

toEncoding :: PortDirection -> Encoding

toJSONList :: [PortDirection] -> Value

toEncodingList :: [PortDirection] -> Encoding

FromJSON PortDirection

Defined in Clash.Driver.Manifest

Methods

parseJSON :: Value -> Parser PortDirection

parseJSONList :: Value -> Parser [PortDirection]

type Rep PortDirection

Defined in Clash.Driver.Manifest

type Rep PortDirection = D1 ('MetaData "PortDirection" "Clash.Driver.Manifest" "clash-lib-1.6.4-inplace" 'False) (C1 ('MetaCons "In" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Out" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "InOut" 'PrefixI 'False) (U1 :: Type -> Type)))

data ManifestPort

Constructors

ManifestPort

Fields

• mpName :: Text

  Port name (as rendered in HDL)

• mpTypeName :: Text

  Type name (as rendered in HDL)

• mpDirection :: PortDirection

  Port direction (in out inout)

• mpWidth :: Int

  Port width in bits

• mpIsClock :: Bool

  Is this port a clock?

• mpDomain :: Maybe Text

  Domain this port belongs to. This is currently only included for clock, reset, and enable ports. TODO: add to all ports originally defined as a Signal too.

Instances

Eq ManifestPort

Defined in Clash.Driver.Manifest

Methods

(==) :: ManifestPort -> ManifestPort -> Bool

(/=) :: ManifestPort -> ManifestPort -> Bool

Read ManifestPort

Defined in Clash.Driver.Manifest

Methods

readsPrec :: Int -> ReadS ManifestPort

readList :: ReadS [ManifestPort]

readPrec :: ReadPrec ManifestPort

readListPrec :: ReadPrec [ManifestPort]

Show ManifestPort

Defined in Clash.Driver.Manifest

Methods

showsPrec :: Int -> ManifestPort -> ShowS

show :: ManifestPort -> String

showList :: [ManifestPort] -> ShowS

ToJSON ManifestPort

Defined in Clash.Driver.Manifest

Methods

toJSON :: ManifestPort -> Value

toEncoding :: ManifestPort -> Encoding

toJSONList :: [ManifestPort] -> Value

toEncodingList :: [ManifestPort] -> Encoding

FromJSON ManifestPort

Defined in Clash.Driver.Manifest

Methods

parseJSON :: Value -> Parser ManifestPort

parseJSONList :: Value -> Parser [ManifestPort]

newtype FilesManifest

Just the fileNames part of Manifest

Constructors

FilesManifest [(FilePath, ByteString)]

Instances

FromJSON FilesManifest

Defined in Clash.Driver.Manifest

Methods

parseJSON :: Value -> Parser FilesManifest

parseJSONList :: Value -> Parser [FilesManifest]

data Manifest

Information about the generated HDL between (sub)runs of the compiler

Constructors

Manifest

Fields

• manifestHash :: ByteString

  Hash digest of the TopEntity and all its dependencies.

• successFlags :: (Int, Int)

  Compiler flags used to achieve successful compilation:

  • opt_inlineLimit
  • opt_specLimit
• ports :: [ManifestPort]

  Ports in the generated TopEntity.

• componentNames :: [Text]

  Names of all the generated components for the TopEntity (does not include the names of the components of the TestBench accompanying the TopEntity).

  This list is reverse topologically sorted. I.e., a component might depend on any component listed before it, but not after it.

• topComponent :: Text

  Design entry point. This is usually the component annotated with a TopEntity annotation.

• fileNames :: [(FilePath, ByteString)]

  Names and hashes of all the generated files for the TopEntity. Hashes are SHA256.

  This list is reverse topologically sorted. I.e., a component might depend on any component listed before it, but not after it.

• domains :: HashMap Text VDomainConfiguration

  Domains encountered in design

• transitiveDependencies :: [Text]

  Dependencies of this design (fully qualified binder names). Is a transitive closure of all dependencies.

  This list is topologically sorted. I.e., a dependency might depend on any dependency listed after it, but not before it.

  TODO: this ordered differs from fileNames and componentNames. Fix?

Instances

Eq Manifest

Defined in Clash.Driver.Manifest

Methods

(==) :: Manifest -> Manifest -> Bool

(/=) :: Manifest -> Manifest -> Bool

Read Manifest

Defined in Clash.Driver.Manifest

Methods

readsPrec :: Int -> ReadS Manifest

readList :: ReadS [Manifest]

readPrec :: ReadPrec Manifest

readListPrec :: ReadPrec [Manifest]

Show Manifest

Defined in Clash.Driver.Manifest

Methods

showsPrec :: Int -> Manifest -> ShowS

show :: Manifest -> String

showList :: [Manifest] -> ShowS

ToJSON Manifest

Defined in Clash.Driver.Manifest

Methods

toJSON :: Manifest -> Value

toEncoding :: Manifest -> Encoding

toJSONList :: [Manifest] -> Value

toEncodingList :: [Manifest] -> Encoding

FromJSON Manifest

Defined in Clash.Driver.Manifest

Methods

parseJSON :: Value -> Parser Manifest

parseJSONList :: Value -> Parser [Manifest]

unsafeFromHexDigest :: Text -> ByteString

Decode a hex digest to a ByteString. Returns a broken digest if the decode fails - hence it being marked as unsafe.

toHexDigest :: ByteString -> Text

Encode a ByteString to a hex digest.

parseFiles :: Object -> Parser [(FilePath, ByteString)]

Parse files part of a Manifest file

data UnexpectedModification

Constructors

Modified FilePath

Clash generated file was modified

Added FilePath

Non-clash generated file was added

Removed FilePath

Clash generated file was removed

Instances

Show UnexpectedModification

Defined in Clash.Driver.Manifest

Methods

showsPrec :: Int -> UnexpectedModification -> ShowS

show :: UnexpectedModification -> String

showList :: [UnexpectedModification] -> ShowS

mkManifestPort

Arguments

:: Backend backend

=> backend

Backend used to lookup port type names

-> Identifier

Port name

-> HWType

Port type

-> PortDirection

-> ManifestPort

manifestFilename :: IsString a => a

Filename manifest file should be written to and read from

mkManifest

Arguments

:: Backend backend

=> backend

Backend used to lookup port type names

-> HashMap Text VDomainConfiguration

Domains encountered in design

-> ClashOpts

Options Clash was run with

-> Component

Component of top entity

-> [Component]

All other entities

-> [Id]

Names of dependencies (transitive closure)

-> [(FilePath, ByteString)]

Files and their hashes

-> ByteString

Hash returned by readFreshManifest

-> Manifest

New manifest

pprintUnexpectedModification :: UnexpectedModification -> String

Pretty print an unexpected modification as a list item.

pprintUnexpectedModifications :: Int -> [UnexpectedModification] -> String

Pretty print a list of unexpected modifications. Print a maximum of n modifications.

readFreshManifest

Arguments

:: [TopEntityT]

This top entity plus all that depend on it.

-> (BindingMap, Id)

Core expressions and entry point. Any changes in the call graph will trigger a recompile.

-> CompiledPrimMap

Any changes in any primitive will trigger a recompile.

-> ClashOpts

Certain options will trigger recompiles if changed

-> UTCTime

Clash modification date

-> FilePath

Path to manifest file.

-> IO (Maybe [UnexpectedModification], Maybe Manifest, ByteString)

( Nothing if no manifest file was found , Nothing on stale cache, disabled cache, or not manifest file found )

Reads a manifest file. Does not return manifest file if:

• Caching is disabled through -fclash-no-cache.
• Manifest could not be found.
• Cache is stale. This could be triggered by any of the given arguments.

Raises an exception if the manifest file or any of the files it is referring to was inaccessible.

isUserModified :: FilePath -> FilesManifest -> IO [UnexpectedModification]

Determines whether the HDL directory the given LocatedManifest was found in contains any user made modifications. This is used by Clash to protect the user against lost work.

readManifest :: FromJSON a => FilePath -> IO (Maybe a)

Read a manifest file from disk. Returns Nothing if file does not exist. Any other IO exception is re-raised.

writeManifest :: FilePath -> Manifest -> IO ()

Write manifest file to disk

serializeManifest :: Manifest -> Text

Serialize a manifest.

TODO: This should really yield a ByteString.