Packages

c

tutorial.lesson1

AnalyzeCircuit

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:

  • https://github.com/ucb-bar/firrtl/wiki/Understanding-Firrtl-Intermediate-Representation Traversing a circuit:
  • https://github.com/ucb-bar/firrtl/wiki/traversing-a-circuit for more Common Pass Idioms:
  • https://github.com/ucb-bar/firrtl/wiki/Common-Pass-Idioms
Source
AnalyzeCircuit.scala
Linear Supertypes
Transform, DependencyAPI[Transform], TransformLike[CircuitState], LazyLogging, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AnalyzeCircuit
  2. Transform
  3. DependencyAPI
  4. TransformLike
  5. LazyLogging
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AnalyzeCircuit()

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def execute(state: CircuitState): CircuitState

    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
    AnalyzeCircuit → Transform
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. def inputForm: LowForm.type

    Requires the Circuit form to be "low"

    Requires the Circuit form to be "low"

    Definition Classes
    AnalyzeCircuit → Transform
  12. def invalidates(a: Transform): Boolean

    A function that, given *another* transform (parameter a) will return true if this transform invalidates/undos the effects of the *other* transform (parameter a).

    A function that, given *another* transform (parameter a) will return true if this transform invalidates/undos the effects of the *other* transform (parameter a).

    a

    transform

    Definition Classes
    Transform → DependencyAPI
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. val logger: Logger
    Attributes
    protected
    Definition Classes
    LazyLogging
  15. def name: String

    A convenience function useful for debugging and error messages

    A convenience function useful for debugging and error messages

    Definition Classes
    Transform → TransformLike
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. def optionalPrerequisiteOf: Seq[Dependency[Transform]]

    A sequence of transforms to add this transform as an optionalPrerequisite.

    A sequence of transforms to add this transform as an optionalPrerequisite. The use of optionalPrerequisiteOf enables the transform declaring them to always run before some other transforms. However, declaring optionalPrerequisiteOf will not result in the sequence of transforms executing.

    This is useful for providing an ordering constraint to guarantee that other transforms (e.g., emitters) will not be scheduled before you.

    Definition Classes
    Transform → DependencyAPI
    Note

    This method **will not** result in the listed transforms running. If you want to add multiple transforms at once, you should use a DependencyManager with multiple targets.

  20. def optionalPrerequisites: Seq[Dependency[Transform]]

    All transforms that, if a prerequisite of *another* transform, will run before this transform.

    All transforms that, if a prerequisite of *another* transform, will run before this transform.

    Definition Classes
    Transform → DependencyAPI
    Note

    The use of a Seq here is to preserve input order. Internally, this will be converted to a private, ordered Set.

  21. def outputForm: LowForm.type

    Indicates the output Circuit form to be "low"

    Indicates the output Circuit form to be "low"

    Definition Classes
    AnalyzeCircuit → Transform
  22. def prerequisites: Seq[Dependency[Transform]]

    All transform that must run before this transform

    All transform that must run before this transform

    Definition Classes
    Transform → DependencyAPI
    Note

    The use of a Seq here is to preserve input order. Internally, this will be converted to a private, ordered Set.

  23. final def runTransform(state: CircuitState): CircuitState

    Perform the transform and update annotations.

    Perform the transform and update annotations.

    state

    Input Firrtl AST

    returns

    A transformed Firrtl AST

    Definition Classes
    Transform
  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. def transform(state: CircuitState): CircuitState

    A mathematical transform on some type

    A mathematical transform on some type

    returns

    an output object of the same type

    Definition Classes
    Transform → TransformLike
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. def walkExpression(ledger: Ledger)(e: Expression): Expression

    Deeply visits every Expression in e.

    Deeply visits every Expression in e.

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

    Deeply visits every Statement in m.

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

    Deeply visits every Statement and Expression in s.

Deprecated Value Members

  1. def dependents: Seq[Dependency[Transform]]

    All transforms that must run after this transform

    All transforms that must run after this transform

    This is a means of prerequisite injection into some other transform. Normally a transform will define its own prerequisites. Dependents exist for two main situations:

    First, they improve the composition of optional transforms. If some first transform is optional (e.g., an expensive validation check), you would like to be able to conditionally cause it to run. If it is listed as a prerequisite on some other, second transform then it must always run before that second transform. There's no way to turn it off. However, by listing the second transform as a dependent of the first transform, the first transform will only run (and be treated as a prerequisite of the second transform) if included in a list of target transforms that should be run.

    Second, an external library would like to inject some first transform before a second transform inside FIRRTL. In this situation, the second transform cannot have any knowledge of external libraries. The use of a dependent here allows for prerequisite injection into FIRRTL proper.

    Definition Classes
    DependencyAPI
    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.3) Due to confusion, 'dependents' is being renamed to 'optionalPrerequisiteOf'. Override the latter instead.

    Note

    The use of a Seq here is to preserve input order. Internally, this will be converted to a private, ordered Set.

    See also

    firrtl.passes.CheckTypes for an example of an optional checking firrtl.Transform

  2. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  3. final def getMyAnnotations(state: CircuitState): Seq[Annotation]

    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 DependencyAPI[Transform]

Inherited from TransformLike[CircuitState]

Inherited from LazyLogging

Inherited from AnyRef

Inherited from Any

Ungrouped