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
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
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
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.
Input Firrtl AST
A transformed Firrtl AST
(Since version ) see corresponding Javadoc for more information.
Appends delim to prefix until no collisions of prefix + elts in names We don't add an _ in the collision check because elts could be Seq("") In this case, we're just really checking if prefix itself collides
Appends delim to prefix until no collisions of prefix + elts in names We don't add an _ in the collision check because elts could be Seq("") In this case, we're just really checking if prefix itself collides
(Since version FIRRTL 1.4.0) Use firrtl.Namespace.findValidPrefix
(Since version FIRRTL 1.3) Use Dependency API methods for equivalent functionality. See: https://bit.ly/2Voppre
(Since version FIRRTL 1.3) Use Dependency API methods for equivalent functionality. See: https://bit.ly/2Voppre
Creates a Bundle Type from a Stmt
Creates a Bundle Type from a Stmt
(Since version FIRRTL 1.4.0) Use firrtl.Utils.stmtToType
Resolve name collisions that would occur in the old LowerTypes pass
(Since version FIRRTL 1.4.0) Uniquify is now part of LowerTypes
wire a = { b, c }[2] wire a_0
This lowers to:
There wouldn't be a collision even if we didn't map a -> a_, but there WOULD be collisions in references a[0] and a_0 so we still have to rename a
Must be run after InferTypes because ir.DefNodes need type