t

firrtl.options

DependencyAPI

trait DependencyAPI[A <: DependencyAPI[A]] extends AnyRef

Mixin that defines dependencies between TransformLikes (hereafter referred to as "transforms")

This trait forms the basis of the Dependency API of the Chisel/FIRRTL Hardware Compiler Framework. Dependencies are defined in terms of prerequisistes, dependents, and invalidates. A prerequisite is a transform that must run before this transform. A dependent is a transform that must run after this transform. (This can be viewed as a means of injecting a prerequisite into some other transform.) Finally, invalidates define the set of transforms whose effects this transform undos/invalidates. (Invalidation then implies that a transform that is invalidated by this transform and needed by another transform will need to be re-run.)

This Dependency API only defines dependencies. A concrete DependencyManager is expected to be used to statically resolve a linear ordering of transforms that satisfies dependency requirements.

A

some transform

Self Type
DependencyAPI[A] with TransformLike[_]
Source
Phase.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
DependencyManager, Phase, PhaseManager, Stage, AddDefaults, Checks, ConvertLegacyAnnotations, DeletedWrapper, GetIncludes, WriteOutputAnnotations, FirrtlStage, AddCircuit, AddDefaults, AddImplicitEmitter, AddImplicitOutputFile, Checks, Compiler, AddImplicitAnnotationFile, AddImplicitFirrtlFile, WriteEmitted, Checks, AddImplicitEmitter, AddImplicitOutputFile
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DependencyAPI
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Dependency = Class[_ <: A]

    The type used to express dependencies: a class which itself has dependencies.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. def dependents: Seq[(DependencyAPI.this)#Dependency]

    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.

    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

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def invalidates(a: A): Boolean

    A function that, given a transform will return true if this transform invalidates/undos the effects of the input transform

    A function that, given a transform will return true if this transform invalidates/undos the effects of the input transform

    Note

    Can a Phase ever invalidate itself?

  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. def prerequisites: Seq[(DependencyAPI.this)#Dependency]

    All transform that must run before this transform

    All transform that must run before this transform

    Note

    The use of a Seq here is to preserve input order. Internally, this will be converted to a private, ordered Set.

  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped