The type used to express dependencies: a class which itself has dependencies.
The type used to express dependencies: a class which itself has dependencies.
Convert an AnnotationSeq into a sequence of compiler runs.
Convert an AnnotationSeq into a sequence of compiler runs.
an object of type B
Expand compiler output back into an AnnotationSeq.
Expand compiler output back into an AnnotationSeq. Annotations used in the construction of the compiler run are removed (CompilerAnnotations and RunFirrtlTransformAnnotations).
an object of type A
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.
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
Run the FIRRTL compiler some number of times.
Run the FIRRTL compiler some number of times. If more than one run is specified, a parallel collection will be used.
an object of type B
an object of type B
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
The name of this Phase.
The name of this Phase. This will be used to generate debug/error messages or when deleting
annotations. This will default to the simpleName
of the class.
this phase's name
Override this with your own implementation for different naming behavior.
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.
Convert the input object to the internal type, transform the internal type, and convert back to the original type
Convert the input object to the internal type, transform the internal type, and convert back to the original type
an input object
an output object of the same type
Runs the FIRRTL compilers on an AnnotationSeq. If the input AnnotationSeq contains more than one circuit (i.e., more than one FirrtlCircuitAnnotation), then annotations will be broken up and each run will be executed in parallel.
The AnnotationSeq will be chunked up into compiler runs using the following algorithm. All annotations that occur before the first FirrtlCircuitAnnotation are treated as global annotations that apply to all circuits. Annotations after a circuit are only associated with their closest preceeding circuit. E.g., for the following annotations (where A, B, and C are some annotations):
A(a), FirrtlCircuitAnnotation(x), B, FirrtlCircuitAnnotation(y), A(b), C, FirrtlCircuitAnnotation(z)
Then this will result in three compiler runs:
A(a) is a default, global annotation. B binds to FirrtlCircuitAnnotation(x). A(a), A(b), and C bind to FirrtlCircuitAnnotation(y). Note: A(b) may overwrite A(a) if this is a CompilerAnnotation. FirrtlCircuitAnnotation(z) has no annotations, so it only gets the default A(a).