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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
|
{-|
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(..)
, SynthResult(..)
, SimTool(..)
, FuzzReport(..)
, printResultReport
, synthResults
, simResults
, synthStatus
, defaultIcarusSim
, defaultVivadoSynth
, defaultYosysSynth
, defaultXSTSynth
, defaultQuartusSynth
, defaultIdentitySynth
, descriptionToSim
, descriptionToSynth
)
where
import Control.DeepSeq (NFData, rnf)
import Control.Lens hiding (Identity)
import Data.ByteString (ByteString)
import Data.Maybe (fromMaybe)
import Data.Text (Text)
import Data.Text.Lazy (toStrict)
import Prelude hiding (FilePath)
import Shelly (fromText)
import Text.Blaze.Html (Html)
import Text.Blaze.Html.Renderer.Text (renderHtml)
import qualified Text.Blaze.Html5 as H
import VeriFuzz.Config
import VeriFuzz.Result
import VeriFuzz.Sim
import VeriFuzz.Sim.Internal
-- | 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 {-# UNPACK #-} !Quartus
| IdentitySynth {-# UNPACK #-} !Identity
deriving (Eq)
instance NFData SynthTool where
rnf (XSTSynth a) = rnf a
rnf (VivadoSynth a) = rnf a
rnf (YosysSynth a) = rnf a
rnf (QuartusSynth a) = rnf a
rnf (IdentitySynth a) = rnf a
instance Show SynthTool where
show (XSTSynth xst) = show xst
show (VivadoSynth vivado) = show vivado
show (YosysSynth yosys) = show yosys
show (QuartusSynth quartus) = show quartus
show (IdentitySynth identity) = show identity
instance Tool SynthTool where
toText (XSTSynth xst) = toText xst
toText (VivadoSynth vivado) = toText vivado
toText (YosysSynth yosys) = toText yosys
toText (QuartusSynth quartus) = toText quartus
toText (IdentitySynth identity) = toText identity
instance Synthesiser SynthTool where
runSynth (XSTSynth xst) = runSynth xst
runSynth (VivadoSynth vivado) = runSynth vivado
runSynth (YosysSynth yosys) = runSynth yosys
runSynth (QuartusSynth quartus) = runSynth quartus
runSynth (IdentitySynth identity) = runSynth identity
synthOutput (XSTSynth xst) = synthOutput xst
synthOutput (VivadoSynth vivado) = synthOutput vivado
synthOutput (YosysSynth yosys) = synthOutput yosys
synthOutput (QuartusSynth quartus) = synthOutput quartus
synthOutput (IdentitySynth identity) = synthOutput identity
setSynthOutput (YosysSynth yosys) = YosysSynth . setSynthOutput yosys
setSynthOutput (XSTSynth xst) = XSTSynth . setSynthOutput xst
setSynthOutput (VivadoSynth vivado) = VivadoSynth . setSynthOutput vivado
setSynthOutput (QuartusSynth quartus) = QuartusSynth . setSynthOutput quartus
setSynthOutput (IdentitySynth identity) = IdentitySynth . setSynthOutput identity
defaultYosysSynth :: SynthTool
defaultYosysSynth = YosysSynth defaultYosys
defaultQuartusSynth :: SynthTool
defaultQuartusSynth = QuartusSynth defaultQuartus
defaultVivadoSynth :: SynthTool
defaultVivadoSynth = VivadoSynth defaultVivado
defaultXSTSynth :: SynthTool
defaultXSTSynth = XSTSynth defaultXST
defaultIdentitySynth :: SynthTool
defaultIdentitySynth = IdentitySynth defaultIdentity
newtype SimTool = IcarusSim Icarus
deriving (Eq)
instance NFData SimTool where
rnf (IcarusSim a) = rnf a
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 <> "'"
-- | Convert a description to a synthesiser.
descriptionToSynth :: SynthDescription -> SynthTool
descriptionToSynth (SynthDescription "yosys" bin desc out) =
YosysSynth
. Yosys (fromText <$> bin) (fromMaybe (yosysDesc defaultYosys) desc)
$ maybe (yosysOutput defaultYosys) fromText out
descriptionToSynth (SynthDescription "vivado" bin desc out) =
VivadoSynth
. Vivado (fromText <$> bin) (fromMaybe (vivadoDesc defaultVivado) desc)
$ maybe (vivadoOutput defaultVivado) fromText out
descriptionToSynth (SynthDescription "xst" bin desc out) =
XSTSynth
. XST (fromText <$> bin) (fromMaybe (xstDesc defaultXST) desc)
$ maybe (xstOutput defaultXST) fromText out
descriptionToSynth (SynthDescription "quartus" bin desc out) =
QuartusSynth
. Quartus (fromText <$> bin)
(fromMaybe (quartusDesc defaultQuartus) $ desc)
$ maybe (quartusOutput defaultQuartus) fromText out
descriptionToSynth (SynthDescription "identity" _ desc out) =
IdentitySynth
. Identity (fromMaybe (identityDesc defaultIdentity) $ desc)
$ maybe (identityOutput defaultIdentity) fromText out
descriptionToSynth s =
error $ "Could not find implementation for synthesiser '" <> show s <> "'"
status :: Result Failed () -> Html
status (Pass _ ) = "Passed"
status (Fail EmptyFail ) = "Failed"
status (Fail EquivFail ) = "Equivalence failed"
status (Fail SimFail ) = "Simulation failed"
status (Fail SynthFail ) = "Synthesis failed"
status (Fail EquivError ) = "Equivalence error"
status (Fail TimeoutError) = "Time out"
synthStatusHtml :: SynthStatus -> Html
synthStatusHtml (SynthStatus synth res) = H.tr $ do
H.td . H.toHtml $ toText synth
H.td $ status res
synthResultHtml :: SynthResult -> Html
synthResultHtml (SynthResult synth1 synth2 res) = H.tr $ do
H.td . H.toHtml $ toText synth1
H.td . H.toHtml $ toText synth2
H.td $ status res
resultReport :: Text -> FuzzReport -> Html
resultReport name (FuzzReport synth _ stat) = H.docTypeHtml $ do
H.head . H.title $ "Fuzz Report - " <> H.toHtml name
H.body $ do
H.h1 $ "Fuzz Report - " <> H.toHtml name
H.h2 "Synthesis Failure"
H.table
. H.toHtml
$ ( H.tr
. H.toHtml
$ [H.th "Synthesis tool", H.th "Synthesis Status"]
)
: fmap synthStatusHtml stat
H.h2 "Equivalence Check Status"
H.table
. H.toHtml
$ ( H.tr
. H.toHtml
$ [ H.th "First tool"
, H.th "Second tool"
, H.th "Equivalence Status"
]
)
: fmap synthResultHtml synth
printResultReport :: Text -> FuzzReport -> Text
printResultReport t f = toStrict . renderHtml $ resultReport t f
|