Class

tutorial.lesson1

AnalyzeCircuit

Related Doc: package lesson1

Permalink

class AnalyzeCircuit extends Transform

AnalyzeCircuit Transform

Walks firrtl.ir.Circuit, and records the number of muxes it finds, per module.

While some compiler frameworks operate on graphs, we represent a Firrtl circuit using a tree representation:

To visit all Firrtl IR nodes in a circuit, we write functions that recursively walk down this tree. To record statistics, we will pass along the Ledger class and use it when we come across a Mux.

See the following links for more detailed explanations: Firrtl's IR:

Linear Supertypes
Transform, LazyLogging, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AnalyzeCircuit
  2. Transform
  3. LazyLogging
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AnalyzeCircuit()

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def execute(state: CircuitState): CircuitState

    Permalink

    Perform the transform, encode renaming with RenameMap, and can delete annotations Called by runTransform.

    Perform the transform, encode renaming with RenameMap, and can delete annotations Called by runTransform.

    state

    Input Firrtl AST

    returns

    A transformed Firrtl AST

    Definition Classes
    AnalyzeCircuitTransform
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def getMyAnnotations(state: CircuitState): Seq[Annotation]

    Permalink

    Convenience method to get annotations relevant to this Transform

    Convenience method to get annotations relevant to this Transform

    state

    The CircuitState form which to extract annotations

    returns

    A collection of annotations

    Definition Classes
    Transform
  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  13. def inputForm: LowForm.type

    Permalink

    The firrtl.CircuitForm that this transform requires to operate on

    The firrtl.CircuitForm that this transform requires to operate on

    Definition Classes
    AnalyzeCircuitTransform
  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. val logger: Logger

    Permalink
    Definition Classes
    LazyLogging
  16. def name: String

    Permalink

    A convenience function useful for debugging and error messages

    A convenience function useful for debugging and error messages

    Definition Classes
    Transform
  17. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. def outputForm: LowForm.type

    Permalink

    The firrtl.CircuitForm that this transform outputs

    The firrtl.CircuitForm that this transform outputs

    Definition Classes
    AnalyzeCircuitTransform
  21. final def runTransform(state: CircuitState): CircuitState

    Permalink

    Perform the transform and update annotations.

    Perform the transform and update annotations.

    state

    Input Firrtl AST

    returns

    A transformed Firrtl AST

    Definition Classes
    Transform
  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. def walkExpression(ledger: Ledger)(e: Expression): Expression

    Permalink
  28. def walkModule(ledger: Ledger)(m: DefModule): DefModule

    Permalink
  29. def walkStatement(ledger: Ledger)(s: Statement): Statement

    Permalink

Inherited from Transform

Inherited from LazyLogging

Inherited from AnyRef

Inherited from Any

Ungrouped