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

Verismith

Contents

Types
Run functions
Verilog generation functions
Extra modules

Description

Synopsis

defaultMain :: IO ()
data Opts
- = Fuzz {
  - fuzzOutput :: Text
  - fuzzConfigFile :: !(Maybe FilePath)
  - fuzzForced :: !Bool
  - fuzzKeepAll :: !Bool
  - fuzzNum :: !Int
  - fuzzNoSim :: !Bool
  - fuzzNoEquiv :: !Bool
  - fuzzNoReduction :: !Bool
  - fuzzExistingFile :: !(Maybe FilePath)
  - fuzzExistingFileTop :: !Text
  - fuzzCrossCheck :: !Bool
  - fuzzChecker :: !(Maybe Text)
  }
- | EMIOpts {
  - emiOutput :: Text
  - emiConfigFile :: !(Maybe FilePath)
  - emiForced :: !Bool
  - emiKeepAll :: !Bool
  - emiNum :: !Int
  - emiNoSim :: !Bool
  - emiNoEquiv :: !Bool
  - emiNoReduction :: !Bool
  - emiTopModule :: Text
  - emiInputFile :: FilePath
  }
- | Generate {
  - generateFilename :: !(Maybe FilePath)
  - generateConfigFile :: !(Maybe FilePath)
  - generateValidSyntax :: !Bool
  - generatePrinting :: !PrintingOpts
  }
- | Parse {
  - parseFilename :: !FilePath
  - parseOutput :: !(Maybe FilePath)
  - parseStrict :: !Bool
  - parsePrinting :: !PrintingOpts
  }
- | Reduce {
  - reduceFilename :: !FilePath
  - reduceTop :: !Text
  - reduceScript :: !(Maybe FilePath)
  - reduceSynthesiserDesc :: ![SynthDescription]
  - reduceRerun :: !Bool
  }
- | ConfigOpt {
  - configOptWriteConfig :: !(Maybe FilePath)
  - configOptConfigFile :: !(Maybe FilePath)
  - configOptDoRandomise :: !Bool
  }
- | DistanceOpt {
  - distanceOptVerilogA :: !FilePath
  - distanceOptVerilogB :: !FilePath
  }
- | ShuffleOpt {
  - shuffleOptFilename :: !FilePath
  - shuffleOptTop :: !Text
  - shuffleOptOutput :: !(Maybe FilePath)
  - shuffleOptShuffleLines :: !Bool
  - shuffleOptRenameVars :: !Bool
  - shuffleOptEquiv :: !Bool
  - shuffleOptEquivFolder :: !FilePath
  - shuffleOptChecker :: !(Maybe Text)
  }
- | Equiv {
  - equivOutput :: !FilePath
  - equivFilenameA :: !FilePath
  - equivFilenameB :: !FilePath
  - equivFileTop :: !Text
  - equivChecker :: !(Maybe Text)
  }
data SourceInfo a = SourceInfo {
- _infoTop :: !Text
- _infoSrc :: !(Verilog a)
}
runEquivalence :: Maybe Seed -> Gen (Verilog ()) -> Text -> Text -> Bool -> Int -> IO ()
runSimulation :: IO ()
runReduce :: SourceInfo () -> IO (SourceInfo ())
draw :: IO ()
procedural :: Text -> Config -> Gen (Verilog ann)
proceduralIO :: Text -> Config -> IO (Verilog a)
proceduralSrc :: Text -> Config -> Gen (SourceInfo ann)
proceduralSrcIO :: Text -> Config -> IO (SourceInfo ann)
randomMod :: MonadGen m => Int -> Int -> m (ModDecl ann)
module Verismith.Verilog
module Verismith.Config
module Verismith.Circuit
module Verismith.Tool
module Verismith.Fuzz
module Verismith.Report

Documentation

defaultMain :: IO () Source #

Types

data Opts Source #

Constructors

Fuzz
Fields fuzzOutput :: Text fuzzConfigFile :: !(Maybe FilePath) fuzzForced :: !Bool fuzzKeepAll :: !Bool fuzzNum :: !Int fuzzNoSim :: !Bool fuzzNoEquiv :: !Bool fuzzNoReduction :: !Bool fuzzExistingFile :: !(Maybe FilePath) fuzzExistingFileTop :: !Text fuzzCrossCheck :: !Bool fuzzChecker :: !(Maybe Text)
EMIOpts
Fields emiOutput :: Text emiConfigFile :: !(Maybe FilePath) emiForced :: !Bool emiKeepAll :: !Bool emiNum :: !Int emiNoSim :: !Bool emiNoEquiv :: !Bool emiNoReduction :: !Bool emiTopModule :: Text emiInputFile :: FilePath
Generate
Fields generateFilename :: !(Maybe FilePath) generateConfigFile :: !(Maybe FilePath) generateValidSyntax :: !Bool generatePrinting :: !PrintingOpts
Parse
Fields parseFilename :: !FilePath parseOutput :: !(Maybe FilePath) parseStrict :: !Bool parsePrinting :: !PrintingOpts
Reduce
Fields reduceFilename :: !FilePath reduceTop :: !Text reduceScript :: !(Maybe FilePath) reduceSynthesiserDesc :: ![SynthDescription] reduceRerun :: !Bool
ConfigOpt
Fields configOptWriteConfig :: !(Maybe FilePath) configOptConfigFile :: !(Maybe FilePath) configOptDoRandomise :: !Bool
DistanceOpt
Fields distanceOptVerilogA :: !FilePath distanceOptVerilogB :: !FilePath
ShuffleOpt
Fields shuffleOptFilename :: !FilePath shuffleOptTop :: !Text shuffleOptOutput :: !(Maybe FilePath) shuffleOptShuffleLines :: !Bool shuffleOptRenameVars :: !Bool shuffleOptEquiv :: !Bool shuffleOptEquivFolder :: !FilePath shuffleOptChecker :: !(Maybe Text)
Equiv
Fields equivOutput :: !FilePath equivFilenameA :: !FilePath equivFilenameB :: !FilePath equivFileTop :: !Text equivChecker :: !(Maybe Text)

data SourceInfo a Source #

Top level type which contains all the source code and associated information.

Constructors

SourceInfo
Fields _infoTop :: !Text _infoSrc :: !(Verilog a)

Instances

Instances details

Functor SourceInfo Source #

Instance details

Defined in Verismith.Verilog.AST

Methods

fmap :: (a -> b) -> SourceInfo a -> SourceInfo b #

(<$) :: a -> SourceInfo b -> SourceInfo a #

Annotations SourceInfo Source #

Instance details

Defined in Verismith.Verilog.AST

Methods

removeAnn :: SourceInfo a -> SourceInfo a Source #

clearAnn :: SourceInfo a -> SourceInfo () Source #

collectAnn :: SourceInfo a -> [a] Source #

Data a => Data (SourceInfo a) Source #

Instance details

Defined in Verismith.Verilog.AST

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SourceInfo a -> c (SourceInfo a) #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (SourceInfo a) #

toConstr :: SourceInfo a -> Constr #

dataTypeOf :: SourceInfo a -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (SourceInfo a)) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (SourceInfo a)) #

gmapT :: (forall b. Data b => b -> b) -> SourceInfo a -> SourceInfo a #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SourceInfo a -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SourceInfo a -> r #

gmapQ :: (forall d. Data d => d -> u) -> SourceInfo a -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SourceInfo a -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SourceInfo a -> m (SourceInfo a) #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SourceInfo a -> m (SourceInfo a) #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SourceInfo a -> m (SourceInfo a) #

Monoid (SourceInfo a) Source #

Instance details

Defined in Verismith.Verilog.AST

Methods

mempty :: SourceInfo a #

mappend :: SourceInfo a -> SourceInfo a -> SourceInfo a #

mconcat :: [SourceInfo a] -> SourceInfo a #

Semigroup (SourceInfo a) Source #

Instance details

Defined in Verismith.Verilog.AST

Methods

(<>) :: SourceInfo a -> SourceInfo a -> SourceInfo a #

sconcat :: NonEmpty (SourceInfo a) -> SourceInfo a #

stimes :: Integral b => b -> SourceInfo a -> SourceInfo a #

Generic (SourceInfo a) Source #

Instance details

Defined in Verismith.Verilog.AST

Associated Types

type Rep (SourceInfo a)

Instance details

Defined in Verismith.Verilog.AST

type Rep (SourceInfo a) = D1 ('MetaData "SourceInfo" "Verismith.Verilog.AST" "verismith-1.1.0-FUTsgQc3KWmLTdTSx0Se1T" 'False) (C1 ('MetaCons "SourceInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "_infoTop") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "_infoSrc") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Verilog a))))

Methods

from :: SourceInfo a -> Rep (SourceInfo a) x #

to :: Rep (SourceInfo a) x -> SourceInfo a #

Show a => Show (SourceInfo a) Source #

Instance details

Defined in Verismith.Verilog.AST

Methods

showsPrec :: Int -> SourceInfo a -> ShowS #

show :: SourceInfo a -> String #

showList :: [SourceInfo a] -> ShowS #

NFData a => NFData (SourceInfo a) Source #

Instance details

Defined in Verismith.Verilog.AST

Methods

rnf :: SourceInfo a -> () #

Eq a => Eq (SourceInfo a) Source #

Instance details

Defined in Verismith.Verilog.AST

Methods

(==) :: SourceInfo a -> SourceInfo a -> Bool #

(/=) :: SourceInfo a -> SourceInfo a -> Bool #

Ord a => Ord (SourceInfo a) Source #

Instance details

Defined in Verismith.Verilog.AST

Methods

compare :: SourceInfo a -> SourceInfo a -> Ordering #

(<) :: SourceInfo a -> SourceInfo a -> Bool #

(<=) :: SourceInfo a -> SourceInfo a -> Bool #

(>) :: SourceInfo a -> SourceInfo a -> Bool #

(>=) :: SourceInfo a -> SourceInfo a -> Bool #

max :: SourceInfo a -> SourceInfo a -> SourceInfo a #

min :: SourceInfo a -> SourceInfo a -> SourceInfo a #

Show ann => Source (SourceInfo ann) Source #

Instance details

Defined in Verismith.Verilog.CodeGen

Methods

genSource :: SourceInfo ann -> Text Source #

Distance (SourceInfo a) Source #

Instance details

Defined in Verismith.Verilog.Distance

Methods

distance :: SourceInfo a -> SourceInfo a -> Int Source #

udistance :: SourceInfo a -> SourceInfo a -> Int Source #

dempty :: SourceInfo a -> Int Source #

Mutate (SourceInfo ann) Source #

Instance details

Defined in Verismith.Verilog.Mutate

Methods

mutExpr :: (Expr -> Expr) -> SourceInfo ann -> SourceInfo ann Source #

type Rep (SourceInfo a) Source #

Instance details

Defined in Verismith.Verilog.AST

type Rep (SourceInfo a) = D1 ('MetaData "SourceInfo" "Verismith.Verilog.AST" "verismith-1.1.0-FUTsgQc3KWmLTdTSx0Se1T" 'False) (C1 ('MetaCons "SourceInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "_infoTop") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "_infoSrc") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Verilog a))))

Run functions

runEquivalence Source #

Arguments

:: Maybe Seed
-> Gen (Verilog ())	Generator for the Verilog file.
-> Text	Name of the folder on each thread.
-> Text	Name of the general folder being used.
-> Bool	Keep flag.
-> Int	Used to track the recursion.
-> IO ()

Run a fuzz run and check if all of the simulators passed by checking if the generated Verilog files are equivalent.

runSimulation :: IO () Source #

Run a simulation on a random DAG or a random module.

runReduce :: SourceInfo () -> IO (SourceInfo ()) Source #

draw :: IO () Source #

Draw a randomly generated DAG to a dot file and compile it to a png so it can be seen.

Verilog generation functions

procedural :: Text -> Config -> Gen (Verilog ann) Source #

Procedural generation method for random Verilog. Uses internal Reader and State to keep track of the current Verilog code structure.

proceduralIO :: Text -> Config -> IO (Verilog a) Source #

Samples the Gen directly to generate random Verilog using the Text as the name of the main module and the configuration Config to influence the generation.

proceduralSrc :: Text -> Config -> Gen (SourceInfo ann) Source #

Given a Text and a Config will generate a '(SourceInfo ann)' which has the top module set to the right name.

proceduralSrcIO :: Text -> Config -> IO (SourceInfo ann) Source #

Sampled and wrapped into a '(SourceInfo ann)' with the given top module name.

randomMod :: MonadGen m => Int -> Int -> m (ModDecl ann) Source #

Extra modules

module Verismith.Verilog

module Verismith.Config

module Verismith.Circuit

module Verismith.Tool

module Verismith.Fuzz

module Verismith.Report