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
|
{-|
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.
-}
module VeriFuzz.Fuzz
( SynthTool(..)
, SimTool(..)
, FuzzResult(..)
, Fuzz
, fuzz
, runFuzz
, defaultIcarusSim
, defaultVivadoSynth
, defaultYosysSynth
, defaultXSTSynth
, defaultQuartusSynth
)
where
import Control.Monad.IO.Class
import Control.Monad.Trans.Class (lift)
import Control.Monad.Trans.Reader hiding (local)
import Control.Monad.Trans.State.Strict
import Data.List (nubBy)
import Data.Text (Text)
import qualified Data.Text as T
import Data.Time
import Hedgehog (Gen)
import qualified Hedgehog.Gen as Hog
import Prelude hiding (FilePath)
import Shelly
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
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
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)
data SimResult a = SimResult !SynthTool !SimTool !(Result Failed a)
deriving (Eq, Show)
data SynthResult a = SynthResult !SynthTool !SynthTool !(Result Failed a)
deriving (Eq, Show)
data FuzzResult a = FuzzResult { getSynthResults :: ![SynthResult a]
, getSimResults :: ![SimResult a]
}
deriving (Eq, Show)
instance Semigroup (FuzzResult a) where
FuzzResult a1 b1 <> FuzzResult a2 b2 = FuzzResult (a1 <> a2) (b1 <> b2)
instance Monoid (FuzzResult a) where
mempty = FuzzResult [] []
type Fuzz a m = StateT (FuzzResult a) (ReaderT FuzzEnv m)
runFuzz :: (Monad m) => [SynthTool] -> [SimTool] -> Yosys -> Fuzz a 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 ]
runInTmp :: (MonadSh m) => m a -> m a
runInTmp a = liftSh (withTmpDir $ (\dir -> cd dir)) >> a
mkAndRun :: (MonadSh m) => FilePath -> Sh a -> m a
mkAndRun a = liftSh . chdir_p a
liftWith'
:: (MonadIO m)
=> (Sh (Result a b) -> Sh (Result a b))
-> ResultT a Sh b
-> m (Result a b)
liftWith' a = liftIO . shellyFailDir . a . runResultT
lift' :: (MonadIO m) => ResultT a Sh b -> m (Result a b)
lift' = liftWith' id
logT :: (MonadIO m) => Text -> m ()
logT = liftIO . shelly . echoP
synthesis :: (MonadIO m) => SourceInfo -> Fuzz () m (FuzzResult ())
synthesis src = do
synth <- synthesisers
results <- mapM
(\a -> liftWith' (mkAndRun . fromText $ showT a)
$ runSynth a src (fromText $ "syn_" <> showT a <> ".v")
)
synth
liftIO $ print results
return mempty
timeit :: (MonadIO m) => m a -> m (NominalDiffTime, a)
timeit a = do
start <- liftIO getCurrentTime
result <- a
end <- liftIO getCurrentTime
return (diffUTCTime end start, result)
fuzz :: (MonadIO m) => Gen SourceInfo -> Fuzz () m (FuzzResult ())
fuzz gen = do
synth <- synthesisers
logT "Sampling Verilog from generator"
(t, src) <- timeit $ Hog.sample gen
logT $ "Generated Verilog (" <> showT t <> ")"
yos <- lift $ asks yosysInstance
_ <- synthesis src
let synthComb =
nubBy tupEq . filter (uncurry (/=)) $ combinations synth synth
--let simComb = combinations synth sim
--results <- mapM (uncurry $ equivalence yos src) synthComb
--liftIO $ print results
return mempty
where
tupEq (a, b) (a', b') = (a == a' && b == b') || (a == b' && b == a')
equivalence yos src a b =
liftIO . shellyFailDir . runInTmp . runResultT $ runEquiv yos
a
(Just b)
src
|
