class Compiler extends Phase with Translator[AnnotationSeq, Seq[CompilerRun]]
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:
- FirrtlCircuitAnnotation(x): A(a), B
- FirrtlCircuitAnnotation(y): A(a), A(b), C
- FirrtlCircuitAnnotation(z): A(a)
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).
- Source
- Compiler.scala
- Alphabetic
- By Inheritance
- Compiler
- Translator
- Phase
- DependencyAPI
- TransformLike
- LazyLogging
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new Compiler()
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
aToB(a: AnnotationSeq): Seq[CompilerRun]
Convert an AnnotationSeq into a sequence of compiler runs.
Convert an AnnotationSeq into a sequence of compiler runs.
- returns
an object of type
B
- Attributes
- protected
- Definition Classes
- Compiler → Translator
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
bToA(b: Seq[CompilerRun]): AnnotationSeq
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).
- returns
an object of type
A
- Attributes
- protected
- Definition Classes
- Compiler → Translator
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
getLogger: Logger
- Definition Classes
- LazyLogging
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
internalTransform(b: Seq[CompilerRun]): Seq[CompilerRun]
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.
- b
an object of type
B
- returns
an object of type
B
- Attributes
- protected
- Definition Classes
- Compiler → Translator
-
def
invalidates(a: Phase): Boolean
A function that, given *another* transform (parameter
a
) will return true if this transform invalidates/undos the effects of the *other* transform (parametera
).A function that, given *another* transform (parameter
a
) will return true if this transform invalidates/undos the effects of the *other* transform (parametera
).- a
transform
- Definition Classes
- Compiler → DependencyAPI
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
val
logger: Logger
- Attributes
- protected
- Definition Classes
- LazyLogging
-
lazy val
name: String
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.- returns
this phase's name
- Definition Classes
- Phase → TransformLike
- Note
Override this with your own implementation for different naming behavior.
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
optionalPrerequisiteOf: Seq[Nothing]
A sequence of transforms to add this transform as an
optionalPrerequisite
.A sequence of transforms to add this transform as an
optionalPrerequisite
. The use ofoptionalPrerequisiteOf
enables the transform declaring them to always run before some other transforms. However, declaringoptionalPrerequisiteOf
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
- Compiler → 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.
-
def
optionalPrerequisites: Seq[Dependency[Phase]]
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
- DependencyAPI
- Note
The use of a Seq here is to preserve input order. Internally, this will be converted to a private, ordered Set.
-
def
prerequisites: Seq[Dependency[Phase { def optionalPrerequisiteOf: Seq[Nothing] }]]
All transform that must run before this transform
All transform that must run before this transform
- Definition Classes
- Compiler → DependencyAPI
- Note
The use of a Seq here is to preserve input order. Internally, this will be converted to a private, ordered Set.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
transform(a: AnnotationSeq): AnnotationSeq
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
- a
an input object
- returns
an output object of the same type
- Definition Classes
- Translator → TransformLike
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Deprecated Value Members
-
def
dependents: Seq[Dependency[Phase]]
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
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated
This is the documentation for Firrtl.