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, optional prerequisites, optional prerequisites of, and invalidates. A prerequisite is a transform that must run before this transform. An optional prerequisites is transform that should run before this transform if the other transform is a target (or the prerequisite of a target). An optional prerequisite of is an optional prerequisite injected into another 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
InjectingPhase, AddDedupGroupAnnotations, AddImplicitOutputAnnotationFile, AddImplicitOutputFile, AddSerializationAnnotations, AspectPhase, Checks, Convert, Elaborate, Emitter, MaybeAspectPhase, MaybeInjectingPhase, AddImplicitTesterDirectory, ChiselStage, AddImplicitOutputFile, CIRCT, Checks, DependencyManager, Phase, PhaseManager, Stage, AddDefaults, Checks, GetIncludes, WriteOutputAnnotations, AddDefaults, Checks, Checks
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DependencyAPI
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from DependencyAPI[A] toany2stringadd[DependencyAPI[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (DependencyAPI[A], B)
    Implicit
    This member is added by an implicit conversion from DependencyAPI[A] toArrowAssoc[DependencyAPI[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def ensuring(cond: (DependencyAPI[A]) => Boolean, msg: => Any): DependencyAPI[A]
    Implicit
    This member is added by an implicit conversion from DependencyAPI[A] toEnsuring[DependencyAPI[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (DependencyAPI[A]) => Boolean): DependencyAPI[A]
    Implicit
    This member is added by an implicit conversion from DependencyAPI[A] toEnsuring[DependencyAPI[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): DependencyAPI[A]
    Implicit
    This member is added by an implicit conversion from DependencyAPI[A] toEnsuring[DependencyAPI[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): DependencyAPI[A]
    Implicit
    This member is added by an implicit conversion from DependencyAPI[A] toEnsuring[DependencyAPI[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def invalidates(a: A): Boolean

    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).

    a

    transform

  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. def optionalPrerequisiteOf: Seq[Dependency[A]]

    A sequence of transforms to add this transform as an optionalPrerequisite.

    A sequence of transforms to add this transform as an optionalPrerequisite. The use of optionalPrerequisiteOf enables the transform declaring them to always run before some other transforms. However, declaring optionalPrerequisiteOf 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.

    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.

  23. def optionalPrerequisites: Seq[Dependency[A]]

    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.

    Note

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

  24. def prerequisites: Seq[Dependency[A]]

    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.

  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from DependencyAPI[A] toStringFormat[DependencyAPI[A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def →[B](y: B): (DependencyAPI[A], B)
    Implicit
    This member is added by an implicit conversion from DependencyAPI[A] toArrowAssoc[DependencyAPI[A]] 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.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromDependencyAPI[A] to any2stringadd[DependencyAPI[A]]

Inherited by implicit conversion StringFormat fromDependencyAPI[A] to StringFormat[DependencyAPI[A]]

Inherited by implicit conversion Ensuring fromDependencyAPI[A] to Ensuring[DependencyAPI[A]]

Inherited by implicit conversion ArrowAssoc fromDependencyAPI[A] to ArrowAssoc[DependencyAPI[A]]

Ungrouped