1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
{-|
Module : VeriFuzz.Report
Description : Generate a report from a fuzz run.
Copyright : (c) 2019, Yann Herklotz Grave
License : GPL-3
Maintainer : ymherklotz [at] gmail [dot] com
Stability : experimental
Portability : POSIX
Generate a report from a fuzz run.
-}
{-# LANGUAGE TemplateHaskell #-}
module VeriFuzz.Report
( SynthTool(..)
, SynthStatus(..)
, SimTool(..)
, FuzzReport(..)
, synthResults
, simResults
, synthStatus
, defaultIcarusSim
, defaultVivadoSynth
, defaultYosysSynth
, defaultXSTSynth
, defaultQuartusSynth
, descriptionToSim
, descriptionToSynth
)
where
import Control.Lens
import Data.ByteString (ByteString)
import Data.Maybe (fromMaybe)
import Prelude hiding (FilePath)
import Shelly (fromText)
import VeriFuzz.Config
import VeriFuzz.Result
import VeriFuzz.Sim.Icarus
import VeriFuzz.Sim.Internal
import VeriFuzz.Sim.Quartus
import VeriFuzz.Sim.Vivado
import VeriFuzz.Sim.XST
import VeriFuzz.Sim.Yosys
-- | Common type alias for synthesis results
type UResult = Result Failed ()
-- | Commont type alias for simulation results
type BResult = Result Failed ByteString
data SynthTool = XSTSynth {-# UNPACK #-} !XST
| VivadoSynth {-# UNPACK #-} !Vivado
| YosysSynth {-# UNPACK #-} !Yosys
| QuartusSynth !Quartus
deriving (Eq)
instance Show SynthTool where
show (XSTSynth xst) = show xst
show (VivadoSynth vivado) = show vivado
show (YosysSynth yosys) = show yosys
show (QuartusSynth quartus) = show quartus
instance Tool SynthTool where
toText (XSTSynth xst) = toText xst
toText (VivadoSynth vivado) = toText vivado
toText (YosysSynth yosys) = toText yosys
toText (QuartusSynth quartus) = toText quartus
instance Synthesiser SynthTool where
runSynth (XSTSynth xst) = runSynth xst
runSynth (VivadoSynth vivado) = runSynth vivado
runSynth (YosysSynth yosys) = runSynth yosys
runSynth (QuartusSynth quartus) = runSynth quartus
synthOutput (XSTSynth xst) = synthOutput xst
synthOutput (VivadoSynth vivado) = synthOutput vivado
synthOutput (YosysSynth yosys) = synthOutput yosys
synthOutput (QuartusSynth quartus) = synthOutput quartus
setSynthOutput (YosysSynth yosys) = YosysSynth . setSynthOutput yosys
setSynthOutput (XSTSynth xst) = XSTSynth . setSynthOutput xst
setSynthOutput (VivadoSynth vivado) = VivadoSynth . setSynthOutput vivado
setSynthOutput (QuartusSynth quartus) = QuartusSynth . setSynthOutput quartus
defaultYosysSynth :: SynthTool
defaultYosysSynth = YosysSynth defaultYosys
defaultQuartusSynth :: SynthTool
defaultQuartusSynth = QuartusSynth defaultQuartus
defaultVivadoSynth :: SynthTool
defaultVivadoSynth = VivadoSynth defaultVivado
defaultXSTSynth :: SynthTool
defaultXSTSynth = XSTSynth defaultXST
newtype SimTool = IcarusSim Icarus
deriving (Eq)
instance Tool SimTool where
toText (IcarusSim icarus) = toText icarus
instance Simulator SimTool where
runSim (IcarusSim icarus) = runSim icarus
runSimWithFile (IcarusSim icarus) = runSimWithFile icarus
instance Show SimTool where
show (IcarusSim icarus) = show icarus
defaultIcarusSim :: SimTool
defaultIcarusSim = IcarusSim defaultIcarus
-- | The results from running a tool through a simulator. It can either fail or
-- return a result, which is most likely a 'ByteString'.
data SimResult = SimResult !SynthTool !SimTool !(BResult)
deriving (Eq)
instance Show SimResult where
show (SimResult synth sim r) = show synth <> ", " <> show sim <> ": " <> show r
-- | 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 '()'.
data SynthResult = SynthResult !SynthTool !SynthTool !(UResult)
deriving (Eq)
instance Show SynthResult where
show (SynthResult synth synth2 r) = show synth <> ", " <> show synth2 <> ": " <> show r
-- | 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.
data SynthStatus = SynthStatus !SynthTool !(UResult)
deriving (Eq)
instance Show SynthStatus where
show (SynthStatus synth r) = "synthesis " <> show synth <> ": " <> show r
-- | The complete state that will be used during fuzzing, which contains the
-- results from all the operations.
data FuzzReport = FuzzReport { _synthResults :: ![SynthResult]
, _simResults :: ![SimResult]
, _synthStatus :: ![SynthStatus]
}
deriving (Eq, Show)
$(makeLenses ''FuzzReport)
instance Semigroup FuzzReport where
FuzzReport a1 b1 c1 <> FuzzReport a2 b2 c2 = FuzzReport (a1 <> a2) (b1 <> b2) (c1 <> c2)
instance Monoid FuzzReport where
mempty = FuzzReport [] [] []
descriptionToSim :: SimDescription -> SimTool
descriptionToSim (SimDescription "icarus") = defaultIcarusSim
descriptionToSim s =
error $ "Could not find implementation for simulator '" <> show s <> "'"
descriptionToSynth :: SynthDescription -> SynthTool
descriptionToSynth s@(SynthDescription "yosys" _ _ _ _ _ _ _ _ _ _ _ _) =
YosysSynth
. Yosys (fromText <$> synthYosysBin s) (fromMaybe (yosysDesc defaultYosys) $ synthYosysDesc s)
. maybe (yosysOutput defaultYosys) fromText
$ synthYosysOutput s
descriptionToSynth s@(SynthDescription "vivado" _ _ _ _ _ _ _ _ _ _ _ _) =
VivadoSynth
. Vivado (fromText <$> synthVivadoBin s) (fromMaybe (vivadoDesc defaultVivado) $ synthVivadoDesc s)
. maybe (vivadoOutput defaultVivado) fromText
$ synthVivadoOutput s
descriptionToSynth s@(SynthDescription "xst" _ _ _ _ _ _ _ _ _ _ _ _) =
XSTSynth
. XST (fromText <$> synthXstBin s) (fromMaybe (xstDesc defaultXST) $ synthXstDesc s)
. maybe (xstOutput defaultXST) fromText
$ synthXstOutput s
descriptionToSynth s@(SynthDescription "quartus" _ _ _ _ _ _ _ _ _ _ _ _) =
QuartusSynth
. Quartus (fromText <$> synthQuartusBin s) (fromMaybe (quartusDesc defaultQuartus) $ synthQuartusDesc s)
. maybe (quartusOutput defaultQuartus) fromText
$ synthQuartusOutput s
descriptionToSynth s =
error $ "Could not find implementation for synthesiser '" <> show s <> "'"
|
