abstract class Stage extends Phase
A Stage represents one stage in the FIRRTL hardware compiler framework. A Stage is, conceptually, a Phase that includes a command line interface.
The FIRRTL compiler is a stage as well as any frontend or backend that runs before/after FIRRTL. Concretely, Chisel is a Stage as is FIRRTL's Verilog emitter. Each stage performs a mathematical transformation on an AnnotationSeq where some input annotations are processed to produce different annotations. Command line options may be pulled in if available.
- Source
- Stage.scala
- Alphabetic
- By Inheritance
- Stage
- Phase
- DependencyAPI
- TransformLike
- LazyLogging
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Stage()
Abstract Value Members
- abstract def run(annotations: AnnotationSeq): AnnotationSeq
Run this stage on some input annotations
Run this stage on some input annotations
- annotations
input annotations
- returns
output annotations
- Attributes
- protected
- abstract val shell: Shell
A utility that helps convert command line options to annotations
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Stage, B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def ensuring(cond: (Stage) => Boolean, msg: => Any): Stage
- def ensuring(cond: (Stage) => Boolean): Stage
- def ensuring(cond: Boolean, msg: => Any): Stage
- def ensuring(cond: Boolean): Stage
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def execute(args: Array[String], annotations: AnnotationSeq): AnnotationSeq
Run this stage on on a mix of arguments and annotations
Run this stage on on a mix of arguments and annotations
- args
command line arguments
- returns
output annotations
- Exceptions thrown
firrtl.options.OptionsExceptionif command line or annotation validation fails
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getLogger: Logger
- Definition Classes
- LazyLogging
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- 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
- 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
simpleNameof 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()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def optionalPrerequisiteOf: Seq[Dependency[Phase]]
A sequence of transforms to add this transform as an
optionalPrerequisite.A sequence of transforms to add this transform as an
optionalPrerequisite. The use ofoptionalPrerequisiteOfenables the transform declaring them to always run before some other transforms. However, declaringoptionalPrerequisiteOfwill 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
- 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
DependencyManagerwith 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]]
All transform that must run before this transform
All transform that must 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.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def transform(annotations: AnnotationSeq): AnnotationSeq
Execute this stage on some input annotations.
Execute this stage on some input annotations. Annotations will be read from any input annotation files.
- annotations
input annotations
- returns
output annotations
- Definition Classes
- Stage → TransformLike
- Exceptions thrown
firrtl.options.OptionsExceptionif command line or annotation validation fails
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from Stage toStringFormat[Stage] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (Stage, B)
- Implicit
- This member is added by an implicit conversion from Stage toArrowAssoc[Stage] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.