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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
|
{-|
Module : VeriFuzz.Fuzz
Description : Environment to run the simulator and synthesisers in a matrix.
Copyright : (c) 2019, Yann Herklotz
License : GPL-3
Maintainer : ymherklotz [at] gmail [dot] com
Stability : experimental
Portability : POSIX
Environment to run the simulator and synthesisers in a matrix.
-}
{-# LANGUAGE ConstraintKinds #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE TemplateHaskell #-}
module VeriFuzz.Fuzz
( SynthTool(..)
, SimTool(..)
, FuzzResult(..)
, synthResults
, simResults
, synthStatus
, Fuzz
, fuzz
, fuzzInDir
, fuzzMultiple
, runFuzz
, defaultIcarusSim
, defaultVivadoSynth
, defaultYosysSynth
, defaultXSTSynth
, defaultQuartusSynth
)
where
import Control.Exception.Lifted (finally)
import Control.Lens
import Control.Monad (forM, void)
import Control.Monad.IO.Class
import Control.Monad.Trans.Class (lift)
import Control.Monad.Trans.Control (MonadBaseControl)
import Control.Monad.Trans.Reader hiding (local)
import Control.Monad.Trans.State.Strict
import Data.ByteString (ByteString)
import Data.List (nubBy)
import Data.Text (Text)
import Data.Time
import Hedgehog (Gen)
import qualified Hedgehog.Gen as Hog
import Prelude hiding (FilePath)
import Shelly hiding (get)
import Shelly.Lifted (MonadSh, liftSh)
import VeriFuzz.Internal
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
import VeriFuzz.Verilog.AST
import VeriFuzz.Verilog.CodeGen
type MonadFuzz m = (MonadBaseControl IO m, MonadIO m, MonadSh m)
-- | 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
data FuzzEnv = FuzzEnv { getSynthesisers :: ![SynthTool]
, getSimulators :: ![SimTool]
, yosysInstance :: {-# UNPACK #-} !Yosys
}
deriving (Eq, Show)
-- | 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 FuzzResult = FuzzResult { _synthResults :: ![SynthResult]
, _simResults :: ![SimResult]
, _synthStatus :: ![SynthStatus]
}
deriving (Eq, Show)
$(makeLenses ''FuzzResult)
instance Semigroup FuzzResult where
FuzzResult a1 b1 c1 <> FuzzResult a2 b2 c2 = FuzzResult (a1 <> a2) (b1 <> b2) (c1 <> c2)
instance Monoid FuzzResult where
mempty = FuzzResult [] [] []
-- | The main type for the fuzzing, which contains an environment that can be
-- read from and the current state of all the results.
type Fuzz m = StateT FuzzResult (ReaderT FuzzEnv m)
runFuzz
:: MonadIO m =>
[SynthTool] -> [SimTool] -> Yosys -> Fuzz Sh a -> m a
runFuzz synth sim yos m = shelly $ runFuzz' synth sim yos m
runFuzz' :: Monad m => [SynthTool] -> [SimTool] -> Yosys -> Fuzz m b -> m b
runFuzz' synth sim yos m =
runReaderT (evalStateT m (FuzzResult [] [] [])) (FuzzEnv synth sim yos)
synthesisers :: Monad m => Fuzz m [SynthTool]
synthesisers = lift $ asks getSynthesisers
--simulators :: (Monad m) => Fuzz () m [SimTool]
--simulators = lift $ asks getSimulators
combinations :: [a] -> [b] -> [(a, b)]
combinations l1 l2 = [ (x, y) | x <- l1, y <- l2 ]
logT :: MonadSh m => Text -> m ()
logT = liftSh . echoP
timeit :: (MonadIO m, MonadSh m) => m a -> m (NominalDiffTime, a)
timeit a = do
start <- liftIO getCurrentTime
result <- a
end <- liftIO getCurrentTime
return (diffUTCTime end start, result)
synthesis :: (MonadBaseControl IO m, MonadSh m) => SourceInfo -> Fuzz m ()
synthesis src = do
synth <- synthesisers
results <- liftSh $ mapM exec synth
synthStatus .= zipWith SynthStatus synth results
liftSh $ inspect results
where
exec a = runResultT $ do
liftSh . mkdir_p . fromText $ toText a
pop (fromText $ toText a) $ runSynth a src
generateSample :: (MonadIO m, MonadSh m) => Gen SourceInfo -> Fuzz m SourceInfo
generateSample gen = do
logT "Sampling Verilog from generator"
(t, src) <- timeit $ Hog.sample gen
logT $ "Generated Verilog (" <> showT t <> ")"
return src
passedSynthesis :: MonadSh m => Fuzz m [SynthTool]
passedSynthesis = fmap toSynth . filter passed . _synthStatus <$> get
where
passed (SynthStatus _ (Pass _)) = True
passed _ = False
toSynth (SynthStatus s _) = s
make :: MonadSh m => FilePath -> m ()
make f = liftSh $ do
mkdir_p f
cp_r "data" $ f </> fromText "data"
pop :: (MonadBaseControl IO m, MonadSh m) => FilePath -> m a -> m a
pop f a = do
dir <- liftSh pwd
finally (liftSh (cd f) >> a) . liftSh $ cd dir
equivalence :: (MonadBaseControl IO m, MonadSh m) => SourceInfo -> Fuzz m ()
equivalence src = do
yos <- lift $ asks yosysInstance
synth <- passedSynthesis
let synthComb =
nubBy tupEq . filter (uncurry (/=)) $ combinations synth synth
results <- liftSh $ mapM (uncurry $ equiv yos) synthComb
liftSh $ inspect results
where
tupEq (a, b) (a', b') = (a == a' && b == b') || (a == b' && b == a')
equiv yos a b = runResultT $ do
make dir
pop dir $ do
liftSh $ do
cp (fromText ".." </> fromText (toText a) </> synthOutput a) $ synthOutput a
cp (fromText ".." </> fromText (toText b) </> synthOutput b) $ synthOutput b
writefile "rtl.v" $ genSource src
runEquiv yos a (Just b) src
where
dir = fromText $ "equiv_" <> toText a <> "_" <> toText b
fuzz :: MonadFuzz m => Gen SourceInfo -> Fuzz m FuzzResult
fuzz gen = do
src <- generateSample gen
synthesis src
equivalence src
return mempty
fuzzInDir :: MonadFuzz m => FilePath -> Gen SourceInfo -> Fuzz m FuzzResult
fuzzInDir fp src = do
make fp
pop fp $ fuzz src
fuzzMultiple :: MonadFuzz m => Int -> FilePath -> Gen SourceInfo -> Fuzz m FuzzResult
fuzzMultiple n fp src = do
make fp
void . pop fp $ forM [1..n] fuzzDir
return mempty
where
fuzzDir n' = fuzzInDir (fromText $ "fuzz_" <> showT n') src
|