Class

tutorial.lesson1

AnalyzeCircuit

Related Doc: package lesson1

Permalink

class AnalyzeCircuit extends Transform

AnalyzeCircuit Transform

Walks 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:

Source
AnalyzeCircuit.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AnalyzeCircuit
  2. Transform
  3. TransformLike
  4. LazyLogging
  5. AnyRef
  6. 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
    @HotSpotIntrinsicCandidate() @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

    Called by Compiler to run your pass.

    Called by Compiler to run your pass. CircuitState contains the circuit and its form, as well as other related data.

    state

    Input Firrtl AST

    returns

    A transformed Firrtl AST

    Definition Classes
    AnalyzeCircuitTransform
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  11. def inputForm: LowForm.type

    Permalink

    Requires the Circuit form to be "low"

    Requires the Circuit form to be "low"

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

    Permalink
    Definition Classes
    Any
  13. val logger: Logger

    Permalink
    Definition Classes
    LazyLogging
  14. def name: String

    Permalink

    A convenience function useful for debugging and error messages

    A convenience function useful for debugging and error messages

    Definition Classes
    TransformTransformLike
  15. final def ne(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  18. def outputForm: LowForm.type

    Permalink

    Indicates the output Circuit form to be "low"

    Indicates the output Circuit form to be "low"

    Definition Classes
    AnalyzeCircuitTransform
  19. 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
  20. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    AnyRef → Any
  22. def transform(state: CircuitState): CircuitState

    Permalink

    A mathematical transform on some type

    A mathematical transform on some type

    returns

    an output object of the same type

    Definition Classes
    TransformTransformLike
  23. final def wait(arg0: Long, arg1: Int): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(): Unit

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

    Permalink

    Deeply visits every Expression in e.

    Deeply visits every Expression in e.

    • "post-order traversal"
    • handle e's children Expression before e
  27. def walkModule(ledger: Ledger)(m: DefModule): DefModule

    Permalink

    Deeply visits every Statement in m.

  28. def walkStatement(ledger: Ledger)(s: Statement): Statement

    Permalink

    Deeply visits every Statement and Expression in s.

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  2. 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
    Annotations
    @deprecated
    Deprecated

    (Since version 1.1) Just collect the actual Annotation types the transform wants

Inherited from Transform

Inherited from TransformLike[CircuitState]

Inherited from LazyLogging

Inherited from AnyRef

Inherited from Any

Ungrouped