AnalyzeCircuit
Related Doc:
package lesson1
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.
Input Firrtl AST
A transformed Firrtl AST
Requires the Circuit form to be "low"
Requires the Circuit form to be "low"
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).
transform
A convenience function useful for debugging and error messages
A convenience function useful for debugging and error messages
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.
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.
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.
The use of a Seq here is to preserve input order. Internally, this will be converted to a private, ordered Set.
Indicates the output Circuit form to be "low"
Indicates the output Circuit form to be "low"
All transform that must run before this transform
All transform that must run before this transform
The use of a Seq here is to preserve input order. Internally, this will be converted to a private, ordered Set.
Perform the transform and update annotations.
Perform the transform and update annotations.
Input Firrtl AST
A transformed Firrtl AST
A mathematical transform on some type
A mathematical transform on some type
an output object of the same type
Deeply visits every Expression in e.
Deeply visits every Expression in e.
Deeply visits every Statement in m.
Deeply visits every Statement and Expression in s.
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.
(Since version FIRRTL 1.3) Due to confusion, 'dependents' is being renamed to 'optionalPrerequisiteOf'. Override the latter instead.
The use of a Seq here is to preserve input order. Internally, this will be converted to a private, ordered Set.
firrtl.passes.CheckTypes for an example of an optional checking firrtl.Transform
(Since version ) see corresponding Javadoc for more information.
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: