Verismith.Report

Generate a report from a fuzz run.

Documentation

data SynthTool

Constructors

XSTSynth !XST

VivadoSynth !Vivado

YosysSynth !Yosys

QuartusSynth !Quartus

QuartusLightSynth !QuartusLight

IdentitySynth !Identity

Instances

Eq SynthTool

Defined in Verismith.Report

Methods

(==) :: SynthTool -> SynthTool -> Bool

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

Show SynthTool

Defined in Verismith.Report

Methods

showsPrec :: Int -> SynthTool -> ShowS

show :: SynthTool -> String

showList :: [SynthTool] -> ShowS

NFData SynthTool

Defined in Verismith.Report

Methods

rnf :: SynthTool -> ()

Synthesiser SynthTool

Defined in Verismith.Report

Methods

runSynth :: SynthTool -> SourceInfo -> ResultSh ()

synthOutput :: SynthTool -> FilePath

setSynthOutput :: SynthTool -> FilePath -> SynthTool

Tool SynthTool

Defined in Verismith.Report

Methods

toText :: SynthTool -> Text

data SynthStatus

The status of the synthesis using a simulator. This will be checked before attempting to run the equivalence checks on the simulator, as that would be unnecessary otherwise.

Constructors

SynthStatus !SynthTool !UResult !NominalDiffTime

Instances

Eq SynthStatus

Defined in Verismith.Report

Methods

(==) :: SynthStatus -> SynthStatus -> Bool

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

Show SynthStatus

Defined in Verismith.Report

Methods

showsPrec :: Int -> SynthStatus -> ShowS

show :: SynthStatus -> String

showList :: [SynthStatus] -> ShowS

data SynthResult

The results of comparing the synthesised outputs of two files using a formal equivalence checker. This will either return a failure or an output which is most likely '()'.

Constructors

SynthResult !SynthTool !SynthTool !UResult !NominalDiffTime

Instances

Eq SynthResult

Defined in Verismith.Report

Methods

(==) :: SynthResult -> SynthResult -> Bool

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

Show SynthResult

Defined in Verismith.Report

Methods

showsPrec :: Int -> SynthResult -> ShowS

show :: SynthResult -> String

showList :: [SynthResult] -> ShowS

data SimResult

The results from running a tool through a simulator. It can either fail or return a result, which is most likely a ByteString.

Constructors

SimResult !SynthTool !SimTool ![ByteString] !BResult !NominalDiffTime

Instances

Eq SimResult

Defined in Verismith.Report

Methods

(==) :: SimResult -> SimResult -> Bool

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

Show SimResult

Defined in Verismith.Report

Methods

showsPrec :: Int -> SimResult -> ShowS

show :: SimResult -> String

showList :: [SimResult] -> ShowS

newtype SimTool

Constructors

IcarusSim Icarus

Instances

Eq SimTool

Defined in Verismith.Report

Methods

(==) :: SimTool -> SimTool -> Bool

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

Show SimTool

Defined in Verismith.Report

Methods

showsPrec :: Int -> SimTool -> ShowS

show :: SimTool -> String

showList :: [SimTool] -> ShowS

NFData SimTool

Defined in Verismith.Report

Methods

rnf :: SimTool -> ()

Simulator SimTool

Defined in Verismith.Report

Methods

runSim :: SimTool -> SourceInfo -> [ByteString] -> ResultSh ByteString

runSimWithFile :: SimTool -> FilePath -> [ByteString] -> ResultSh ByteString

Tool SimTool

Defined in Verismith.Report

Methods

toText :: SimTool -> Text

data FuzzReport

The complete state that will be used during fuzzing, which contains the results from all the operations.

Constructors

FuzzReport

Fields

• _fuzzDir :: !FilePath
• _synthResults :: ![SynthResult]

  Results of the equivalence check.

• _simResults :: ![SimResult]

  Results of the simulation.

• _synthStatus :: ![SynthStatus]

  Results of the synthesis step.

• _fileLines :: !Int
• _synthTime :: !NominalDiffTime
• _equivTime :: !NominalDiffTime
• _reducTime :: !NominalDiffTime

Instances

Eq FuzzReport

Defined in Verismith.Report

Methods

(==) :: FuzzReport -> FuzzReport -> Bool

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

Show FuzzReport

Defined in Verismith.Report

Methods

showsPrec :: Int -> FuzzReport -> ShowS

show :: FuzzReport -> String

showList :: [FuzzReport] -> ShowS

printResultReport :: Text -> FuzzReport -> Text

printSummary :: Text -> [FuzzReport] -> Text

synthResults :: Lens' FuzzReport [SynthResult]

simResults :: Lens' FuzzReport [SimResult]

synthStatus :: Lens' FuzzReport [SynthStatus]

equivTime :: Lens' FuzzReport NominalDiffTime

fuzzDir :: Lens' FuzzReport FilePath

fileLines :: Lens' FuzzReport Int

reducTime :: Lens' FuzzReport NominalDiffTime

synthTime :: Lens' FuzzReport NominalDiffTime

defaultIcarusSim :: SimTool

defaultVivadoSynth :: SynthTool

defaultYosysSynth :: SynthTool

defaultXSTSynth :: SynthTool

defaultQuartusSynth :: SynthTool

defaultQuartusLightSynth :: SynthTool

defaultIdentitySynth :: SynthTool

descriptionToSim :: SimDescription -> SimTool

descriptionToSynth :: SynthDescription -> SynthTool

Convert a description to a synthesiser.