Copyright	(c) 2019 Yann Herklotz Grave
License	GPL-3
Maintainer	yann [at] yannherklotz [dot] com
Stability	experimental
Portability	POSIX
Safe Haskell	None
Language	Haskell2010

Verismith.Report

Description

Generate a report from a fuzz run.

Synopsis

data SynthTool
- = XSTSynth !XST
- | VivadoSynth !Vivado
- | YosysSynth !Yosys
- | QuartusSynth !Quartus
- | QuartusLightSynth !QuartusLight
- | IdentitySynth !Identity
data SynthStatus = SynthStatus !SynthTool !UResult !NominalDiffTime
data SynthResult = SynthResult !SynthTool !SynthTool !UResult !NominalDiffTime
data SimResult = SimResult !SynthTool !SimTool ![ByteString] !BResult !NominalDiffTime
newtype SimTool = IcarusSim Icarus
data FuzzReport = FuzzReport {
- _fuzzDir :: !FilePath
- _synthResults :: ![SynthResult]
- _simResults :: ![SimResult]
- _synthStatus :: ![SynthStatus]
- _fileLines :: !Int
- _synthTime :: !NominalDiffTime
- _equivTime :: !NominalDiffTime
- _reducTime :: !NominalDiffTime
}
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

Documentation

data SynthTool Source #

Constructors

XSTSynth !XST
VivadoSynth !Vivado
YosysSynth !Yosys
QuartusSynth !Quartus
QuartusLightSynth !QuartusLight
IdentitySynth !Identity

Instances

Instances details

Show SynthTool Source #
Instance details Defined in Verismith.Report Methods showsPrec :: Int -> SynthTool -> ShowS # show :: SynthTool -> String # showList :: [SynthTool] -> ShowS #
NFData SynthTool Source #
Instance details Defined in Verismith.Report Methods rnf :: SynthTool -> () #
Eq SynthTool Source #
Instance details Defined in Verismith.Report Methods (==) :: SynthTool -> SynthTool -> Bool # (/=) :: SynthTool -> SynthTool -> Bool #
Synthesiser SynthTool Source #
Instance details Defined in Verismith.Report Methods runSynth :: Show ann => SynthTool -> SourceInfo ann -> ResultSh () Source # synthOutput :: SynthTool -> FilePath Source # setSynthOutput :: SynthTool -> FilePath -> SynthTool Source #
Tool SynthTool Source #
Instance details Defined in Verismith.Report Methods toText :: SynthTool -> Text Source #

data SynthStatus Source #

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

Instances details

Show SynthStatus Source #
Instance details Defined in Verismith.Report Methods showsPrec :: Int -> SynthStatus -> ShowS # show :: SynthStatus -> String # showList :: [SynthStatus] -> ShowS #
Eq SynthStatus Source #
Instance details Defined in Verismith.Report Methods (==) :: SynthStatus -> SynthStatus -> Bool # (/=) :: SynthStatus -> SynthStatus -> Bool #

data SynthResult Source #

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

Instances details

Show SynthResult Source #
Instance details Defined in Verismith.Report Methods showsPrec :: Int -> SynthResult -> ShowS # show :: SynthResult -> String # showList :: [SynthResult] -> ShowS #
Eq SynthResult Source #
Instance details Defined in Verismith.Report Methods (==) :: SynthResult -> SynthResult -> Bool # (/=) :: SynthResult -> SynthResult -> Bool #

data SimResult Source #

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

Instances details

Show SimResult Source #
Instance details Defined in Verismith.Report Methods showsPrec :: Int -> SimResult -> ShowS # show :: SimResult -> String # showList :: [SimResult] -> ShowS #
Eq SimResult Source #
Instance details Defined in Verismith.Report Methods (==) :: SimResult -> SimResult -> Bool # (/=) :: SimResult -> SimResult -> Bool #

newtype SimTool Source #

Constructors

IcarusSim Icarus

Instances

Instances details

Show SimTool Source #
Instance details Defined in Verismith.Report Methods showsPrec :: Int -> SimTool -> ShowS # show :: SimTool -> String # showList :: [SimTool] -> ShowS #
NFData SimTool Source #
Instance details Defined in Verismith.Report Methods rnf :: SimTool -> () #
Eq SimTool Source #
Instance details Defined in Verismith.Report Methods (==) :: SimTool -> SimTool -> Bool # (/=) :: SimTool -> SimTool -> Bool #
Simulator SimTool Source #
Instance details Defined in Verismith.Report Methods runSim :: Show ann => SimTool -> SourceInfo ann -> [ByteString] -> ResultSh ByteString Source # runSimWithFile :: SimTool -> FilePath -> [ByteString] -> ResultSh ByteString Source #
Tool SimTool Source #
Instance details Defined in Verismith.Report Methods toText :: SimTool -> Text Source #

data FuzzReport Source #

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

Instances details

Show FuzzReport Source #
Instance details Defined in Verismith.Report Methods showsPrec :: Int -> FuzzReport -> ShowS # show :: FuzzReport -> String # showList :: [FuzzReport] -> ShowS #
Eq FuzzReport Source #
Instance details Defined in Verismith.Report Methods (==) :: FuzzReport -> FuzzReport -> Bool # (/=) :: FuzzReport -> FuzzReport -> Bool #