treadle 1.2.0 - treadle

Type Members

case class BlackBoxFactoriesAnnotation(blackBoxFactories: Seq[ScalaBlackBoxFactory]) extends NoTargetAnnotation with TreadleOption with Product with Serializable
case class ClockInfoAnnotation(clockInfoSeq: Seq[ClockInfo] = Seq(ClockInfo())) extends NoTargetAnnotation with TreadleOption with Product with Serializable

Sets one or more clocks including their frequencies and phase
abstract class Command extends AnyRef
case class DataStorePlugInAnnotation(name: String, getPlugin: (ExecutionEngine) ⇒ DataStorePlugin) extends NoTargetAnnotation with TreadleOption with Product with Serializable

Using this annotation allows external users of a TreadleTester to supply their own custom treadle.executable.DataStorePlugins.
Using this annotation allows external users of a TreadleTester to supply their own custom treadle.executable.DataStorePlugins. See that code for examples of use.
name
A unique name for this plugin
getPlugin
A function that returns a DataStorePlugin subclass

Note
this annotation cannot be generated from the command line
trait HasTreadleOptions extends AnyRef
trait HasTreadleSuite extends ExecutionOptionsManager with HasFirrtlOptions with HasTreadleOptions
case class RandomSeedAnnotation(seed: Long = 0L) extends NoTargetAnnotation with TreadleOption with Product with Serializable

Sets the seed for treadle's private random number generator
case class ResetNameAnnotation(symbolNames: String = "") extends NoTargetAnnotation with TreadleOption with Product with Serializable

used with treadle's default reset operations
case class RollBackBuffersAnnotation(rollbackBufferDepth: Int = TreadleDefaults.RollbackBuffers) extends NoTargetAnnotation with TreadleOption with Product with Serializable

Sets the number of rollback buffers in simulator, useful to see why wires have their values
trait ScalaBlackBox extends AnyRef

This is the template for writing Scala functions that implement the behaviour of a black box.
This is the template for writing Scala functions that implement the behaviour of a black box. Implementing classes should add internal variables to hold any state information.

abstract class ScalaBlackBoxFactory extends AnyRef

For each instantiation of an ExtModule the engine needs a separate instance of a BlackBoxImplementation.

For each instantiation of an ExtModule the engine needs a separate instance of a BlackBoxImplementation. This factory provides it.

Example:

class ExampleBBFactory extends BlackBoxFactory {
  override def createInstance(instanceName: String, blackBoxName: String): Option[BlackBoxImplementation] = {
    instanceName match {
      case "bb1" => Some(add(new BB1Impl))
      case "bb2" => Some(add(new BB2Impl))
      case "bb3" => Some(add(new BB3Impl))
      case _ => throw Exception(s"ExampleBBBFactory does not know how to create " + instanceName)
    }
  }
}

case class SymbolsToWatchAnnotation(symbolNames: Seq[String] = Seq.empty) extends NoTargetAnnotation with TreadleOption with Product with Serializable

Sets a list of symbols that will be rendered during execution
case class TreadleCircuitAnnotation(circuit: Circuit) extends NoTargetAnnotation with TreadleOption with Product with Serializable

The circuit used to build a TreadleTester
The circuit used to build a TreadleTester
circuit
a firrtl ast
case class TreadleCircuitStateAnnotation(state: CircuitState) extends NoTargetAnnotation with Product with Serializable

used to pass parsed firrtl to the TreadleTester
used to pass parsed firrtl to the TreadleTester
state
the state to be passed along
case class TreadleFirrtlFormHint(form: CircuitForm) extends NoTargetAnnotation with Product with Serializable

Provides an input form hint to treadle to know how to best handle the input it receives
Provides an input form hint to treadle to know how to best handle the input it receives
form
the input form
class TreadleLibrary extends RegisteredLibrary

Constructs this as a registered library that will be auto-detected by projects who have a dependency on Treadle
sealed trait TreadleOption extends Unserializable
case class TreadleOptions(writeVCD: Boolean = false, vcdShowUnderscored: Boolean = false, setVerbose: Boolean = false, setOrderedExec: Boolean = false, allowCycles: Boolean = false, randomSeed: Long = System.currentTimeMillis(), blackBoxFactories: Seq[ScalaBlackBoxFactory] = Seq.empty, maxExecutionDepth: Long = Int.MaxValue, showFirrtlAtLoad: Boolean = false, lowCompileAtLoad: Boolean = true, validIfIsRandom: Boolean = false, rollbackBuffers: Int = 0, clockInfo: Seq[ClockInfo] = Seq.empty, resetName: String = "reset", callResetAtStartUp: Boolean = false, symbolsToWatch: Seq[String] = Seq.empty) extends ComposableOptions with Product with Serializable
class TreadleOptionsManager extends ExecutionOptionsManager with HasTreadleSuite
class TreadleRepl extends AnyRef

Considered by many to be the world's best Treadle Repl
class TreadleTester extends AnyRef

Works a lot like the chisel classic tester compiles a firrtl input string and allows poke, peek, expect and step
Works a lot like the chisel classic tester compiles a firrtl input string and allows poke, peek, expect and step
pokes invalidate the underlying circuit peek, expect and step, recompute (re-validate) the circuit before executing
Important note: port names in LoFirrtl have replaced dot notation with underscore notation so that io.a.b must be referenced as io_a_b
case class TreadleTesterAnnotation(tester: TreadleTester) extends NoTargetAnnotation with TreadleOption with Product with Serializable

Used to pass a tester on to a test harness
Used to pass a tester on to a test harness
tester
The TreadleTester to be passed on
case class VcdReplayEventsToRun(count: Int) extends NoTargetAnnotation with VcdReplayTesterOptions with Product with Serializable
case class VcdReplaySkipEvents(count: Int) extends NoTargetAnnotation with VcdReplayTesterOptions with Product with Serializable
class VcdReplayTester extends LazyLogging

This tester runs a VCD file against a circuit expressed in a firrtl file.
This tester runs a VCD file against a circuit expressed in a firrtl file. The VCD file should have been produced by running a test harness against the circuit. This test can be used to generate circuit behavior while running symbolic or concolic testing. It can also be used to determine if later changes to a circuit have changed since some original correct **golden** run of the circuit For example use the main below to run the VcdAdder files contained in the src/test/resources directory
```
sbt 'runMain treadle.VcdReplayTester -fs src/test/resources/VcdAdder.fir -vcd src/test/resources/VcdAdder.vcd'
```
trait VcdReplayTesterCli extends AnyRef
sealed trait VcdReplayTesterOptions extends Unserializable
class VcdReplayTesterStage extends Stage
case class VcdReplayVcdFile(fileName: String) extends NoTargetAnnotation with VcdReplayTesterOptions with Product with Serializable

Value Members

object AllowCyclesAnnotation extends NoTargetAnnotation with TreadleOption with HasShellOptions with Product with Serializable

Tells treadle to allow cycles
val Big0: BigInt
val Big1: BigInt
val BitsRequiredOverflowSizeBigInt: BigInt
object CallResetAtStartupAnnotation extends NoTargetAnnotation with TreadleOption with HasShellOptions with Product with Serializable

Tells treadle to present random value when validIf's condition is off
object ClockInfoAnnotation extends HasShellOptions with Product with Serializable
val DangerShiftSize: Int
object DontRunLoweringCompilerLoadAnnotation extends NoTargetAnnotation with TreadleOption with HasShellOptions with Product with Serializable

Tells treadle to not run its own lowering pass on firrtl input (not recommended)
object Driver
object MemoryUsageRegression

This regression demonstrates that a bad initial setting has been fixed the default rollback buffer of 10 meant that large memories caused considerable slowing as buffers were copied.
object PrefixPrintfWithWallTime extends NoTargetAnnotation with TreadleOption with HasShellOptions with Product with Serializable

Tells treadle to prefix printf strings with a wall time
object RandomSeedAnnotation extends HasShellOptions with Serializable
object Regression
object ResetNameAnnotation extends HasShellOptions with Product with Serializable
object RollBackBuffersAnnotation extends HasShellOptions with Product with Serializable
object ShowFirrtlAtLoadAnnotation extends NoTargetAnnotation with TreadleOption with HasShellOptions with Product with Serializable

Tells treadle to show the low firrtl it is starting out with
object SymbolsToWatchAnnotation extends HasShellOptions with Product with Serializable
object TreadleDefaults
object TreadleFirrtlFile extends HasShellOptions

Factory for FirrtlFileAnnotation annotation, this is an alias for Firrtl Cli
object TreadleFirrtlFormHint extends HasShellOptions with Serializable
object TreadleFirrtlString extends HasShellOptions

Factory for FirrtlSourceAnnotation, this is an alias for FirrtlCli
object TreadleRepl
object TreadleTester
object ValidIfIsRandomAnnotation extends NoTargetAnnotation with TreadleOption with HasShellOptions with Product with Serializable

Tells treadle to present random value when validIf's condition is off
object VcdReplayEventsToRun extends HasShellOptions with Product with Serializable
object VcdReplayFirrtlSource extends NoTargetAnnotation with VcdReplayTesterOptions with HasShellOptions with Product with Serializable

makes a more convenient way of specifying firrtl source
object VcdReplaySkipEvents extends HasShellOptions with Product with Serializable
object VcdReplayTestAliasedWires extends NoTargetAnnotation with VcdReplayTesterOptions with HasShellOptions with Product with Serializable
object VcdReplayTester extends StageMain
object VcdReplayVcdFile extends HasShellOptions with Product with Serializable
object VcdShowUnderScoredAnnotation extends NoTargetAnnotation with TreadleOption with HasShellOptions with Product with Serializable

Tells treadle to include _T_* and _GEN_* wires in VCD output
object VerboseAnnotation extends NoTargetAnnotation with TreadleOption with HasShellOptions with Product with Serializable

Tells treadle to execute verbosely
object WriteVcdAnnotation extends NoTargetAnnotation with TreadleOption with HasShellOptions with Product with Serializable

Tells treadle to write a vcd file during simulation
def bigIntBitsToDouble(bigInt: BigInt): Double
def boolToBigInt(condition: Boolean): BigInt
def boolToInt(condition: Boolean): Int
def ceilingLog2(x: Int): Int
package chronometry
def computeBits(n: BigInt): Int

Utility function that computes bits required for a number
Utility function that computes bits required for a number
n
number of interest
def doubleToBigIntBits(double: Double): BigInt
package executable
def extremaOfSIntOfWidth(width: Int): (BigInt, BigInt)

computes the smallest and largest values that will fit in an SInt
computes the smallest and largest values that will fit in an SInt
width
width of SInt
returns
tuple(minVale, maxValue)
def extremaOfUIntOfWidth(width: Int): (BigInt, BigInt)

computes the smallest and largest values that will fit in a UInt
computes the smallest and largest values that will fit in a UInt
width
width of SInt
returns
tuple(minVale, maxValue)
def makeRandom(tpe: Type): BigInt
val random: Random
def randomBigInt(width: Int): BigInt
package repl
def requiredBitsForSInt(num: BigInt): Int

return the smallest number of bits required to hold the given number in an SInt Note: positive numbers will get one minimum width one higher than would be required for a UInt
return the smallest number of bits required to hold the given number in an SInt Note: positive numbers will get one minimum width one higher than would be required for a UInt
num
number to find width for
returns
minimum required bits for an SInt
def requiredBitsForUInt(num: BigInt): Int

return the smallest number of bits required to hold the given number in an UInt
return the smallest number of bits required to hold the given number in an UInt
num
number to find width for
returns
minimum required bits for an SInt
package stage
def typeToWidth(tpe: Type): Int
package utils
package vcd
def widthToInt(width: Width): Int

treadle

package treadle

Type Members

case class BlackBoxFactoriesAnnotation(blackBoxFactories: Seq[ScalaBlackBoxFactory]) extends NoTargetAnnotation with TreadleOption with Product with Serializable

case class ClockInfoAnnotation(clockInfoSeq: Seq[ClockInfo] = Seq(ClockInfo())) extends NoTargetAnnotation with TreadleOption with Product with Serializable

abstract class Command extends AnyRef

case class DataStorePlugInAnnotation(name: String, getPlugin: (ExecutionEngine) ⇒ DataStorePlugin) extends NoTargetAnnotation with TreadleOption with Product with Serializable

trait HasTreadleOptions extends AnyRef

trait HasTreadleSuite extends ExecutionOptionsManager with HasFirrtlOptions with HasTreadleOptions

case class RandomSeedAnnotation(seed: Long = 0L) extends NoTargetAnnotation with TreadleOption with Product with Serializable

case class ResetNameAnnotation(symbolNames: String = "") extends NoTargetAnnotation with TreadleOption with Product with Serializable

case class RollBackBuffersAnnotation(rollbackBufferDepth: Int = TreadleDefaults.RollbackBuffers) extends NoTargetAnnotation with TreadleOption with Product with Serializable

trait ScalaBlackBox extends AnyRef

abstract class ScalaBlackBoxFactory extends AnyRef

case class SymbolsToWatchAnnotation(symbolNames: Seq[String] = Seq.empty) extends NoTargetAnnotation with TreadleOption with Product with Serializable

case class TreadleCircuitAnnotation(circuit: Circuit) extends NoTargetAnnotation with TreadleOption with Product with Serializable

case class TreadleCircuitStateAnnotation(state: CircuitState) extends NoTargetAnnotation with Product with Serializable

case class TreadleFirrtlFormHint(form: CircuitForm) extends NoTargetAnnotation with Product with Serializable

class TreadleLibrary extends RegisteredLibrary

sealed trait TreadleOption extends Unserializable

class TreadleOptionsManager extends ExecutionOptionsManager with HasTreadleSuite

class TreadleRepl extends AnyRef

class TreadleTester extends AnyRef

case class TreadleTesterAnnotation(tester: TreadleTester) extends NoTargetAnnotation with TreadleOption with Product with Serializable

case class VcdReplayEventsToRun(count: Int) extends NoTargetAnnotation with VcdReplayTesterOptions with Product with Serializable

case class VcdReplaySkipEvents(count: Int) extends NoTargetAnnotation with VcdReplayTesterOptions with Product with Serializable

class VcdReplayTester extends LazyLogging

trait VcdReplayTesterCli extends AnyRef

sealed trait VcdReplayTesterOptions extends Unserializable

class VcdReplayTesterStage extends Stage

case class VcdReplayVcdFile(fileName: String) extends NoTargetAnnotation with VcdReplayTesterOptions with Product with Serializable

Value Members

object AllowCyclesAnnotation extends NoTargetAnnotation with TreadleOption with HasShellOptions with Product with Serializable

val Big0: BigInt

val Big1: BigInt

val BitsRequiredOverflowSizeBigInt: BigInt

object CallResetAtStartupAnnotation extends NoTargetAnnotation with TreadleOption with HasShellOptions with Product with Serializable

object ClockInfoAnnotation extends HasShellOptions with Product with Serializable

val DangerShiftSize: Int

object DontRunLoweringCompilerLoadAnnotation extends NoTargetAnnotation with TreadleOption with HasShellOptions with Product with Serializable

object Driver

object MemoryUsageRegression

object PrefixPrintfWithWallTime extends NoTargetAnnotation with TreadleOption with HasShellOptions with Product with Serializable

object RandomSeedAnnotation extends HasShellOptions with Serializable

object Regression

object ResetNameAnnotation extends HasShellOptions with Product with Serializable

object RollBackBuffersAnnotation extends HasShellOptions with Product with Serializable

object ShowFirrtlAtLoadAnnotation extends NoTargetAnnotation with TreadleOption with HasShellOptions with Product with Serializable

object SymbolsToWatchAnnotation extends HasShellOptions with Product with Serializable

object TreadleDefaults

object TreadleFirrtlFile extends HasShellOptions

object TreadleFirrtlFormHint extends HasShellOptions with Serializable

object TreadleFirrtlString extends HasShellOptions

object TreadleRepl

object TreadleTester

object ValidIfIsRandomAnnotation extends NoTargetAnnotation with TreadleOption with HasShellOptions with Product with Serializable

object VcdReplayEventsToRun extends HasShellOptions with Product with Serializable

object VcdReplayFirrtlSource extends NoTargetAnnotation with VcdReplayTesterOptions with HasShellOptions with Product with Serializable

object VcdReplaySkipEvents extends HasShellOptions with Product with Serializable

object VcdReplayTestAliasedWires extends NoTargetAnnotation with VcdReplayTesterOptions with HasShellOptions with Product with Serializable

object VcdReplayTester extends StageMain

object VcdReplayVcdFile extends HasShellOptions with Product with Serializable

object VcdShowUnderScoredAnnotation extends NoTargetAnnotation with TreadleOption with HasShellOptions with Product with Serializable

object VerboseAnnotation extends NoTargetAnnotation with TreadleOption with HasShellOptions with Product with Serializable

object WriteVcdAnnotation extends NoTargetAnnotation with TreadleOption with HasShellOptions with Product with Serializable

def bigIntBitsToDouble(bigInt: BigInt): Double

def boolToBigInt(condition: Boolean): BigInt

def boolToInt(condition: Boolean): Int

def ceilingLog2(x: Int): Int

package chronometry

def computeBits(n: BigInt): Int

def doubleToBigIntBits(double: Double): BigInt

package executable

def extremaOfSIntOfWidth(width: Int): (BigInt, BigInt)

def extremaOfUIntOfWidth(width: Int): (BigInt, BigInt)

def makeRandom(tpe: Type): BigInt

val random: Random

def randomBigInt(width: Int): BigInt

package repl

def requiredBitsForSInt(num: BigInt): Int