Trait

firrtl.options

DependencyManager

Related Doc: package options

Permalink

trait DependencyManager[A, B <: TransformLike[A] with DependencyAPI[B]] extends TransformLike[A] with DependencyAPI[B]

A TransformLike that resolves a linear ordering of dependencies based on requirements.

A

the type over which this transforms

B

the type of the TransformLike

Source
DependencyManager.scala
Linear Supertypes
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DependencyManager
  2. DependencyAPI
  3. TransformLike
  4. LazyLogging
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

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

    Permalink

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

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

    Definition Classes
    DependencyAPI

Abstract Value Members

  1. abstract def copy(targets: Seq[Dependency], currentState: Seq[Dependency], knownObjects: Set[B] = classToObject.values.toSet): B

    Permalink

    A method that will create a copy of this DependencyManager, but with different requirements.

    A method that will create a copy of this DependencyManager, but with different requirements. This is used to solve sub-problems arising from invalidations.

    Attributes
    protected
  2. abstract def currentState: Seq[Dependency]

    Permalink

    A sequence of firrtl.Transforms that have been run.

    A sequence of firrtl.Transforms that have been run. Internally, this will be converted to an ordered set.

  3. abstract def knownObjects: Set[B]

    Permalink

    Existing transform objects that have already been constructed

  4. abstract def name: String

    Permalink

    An identifier of this TransformLike that can be used for logging and informational printing

    An identifier of this TransformLike that can be used for logging and informational printing

    Definition Classes
    TransformLike
  5. abstract def targets: Seq[Dependency]

    Permalink

    Requested TransformLikes that should be run.

    Requested TransformLikes that should be run. Internally, this will be converted to a set based on the ordering defined here.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. lazy val classToObject: LinkedHashMap[Dependency, B]

    Permalink

    Store of conversions between classes and objects.

    Store of conversions between classes and objects. Objects that do not exist in the map will be lazily constructed.

    Attributes
    protected
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  7. val colormap: Seq[String]

    Permalink

    This colormap uses Colorbrewer's 4-class OrRd color scheme

    This colormap uses Colorbrewer's 4-class OrRd color scheme

    Attributes
    protected
  8. def dependenciesToGraphviz: String

    Permalink

    Convert all prerequisites, dependents, and invalidates to a Graphviz representation.

  9. lazy val dependencyGraph: DiGraph[B]

    Permalink

    A directed graph consisting of all prerequisites, including prerequisites derived from dependents

  10. def dependents: Seq[Dependency]

    Permalink

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

  11. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  13. lazy val flattenedTransformOrder: Seq[B]

    Permalink

    A version of the transformOrder that flattens the transforms of any internal DependencyManagers.

  14. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  15. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  16. lazy val invalidateGraph: DiGraph[B]

    Permalink

    A directed graph consisting of invalidation edges

  17. def invalidates(a: B): Boolean

    Permalink

    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

    Definition Classes
    DependencyAPI
  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  19. val logger: Logger

    Permalink
    Definition Classes
    LazyLogging
  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  23. def prerequisites: Seq[Dependency]

    Permalink

    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.

  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  25. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  26. final def transform(annotations: A): A

    Permalink

    A mathematical transform on some type

    A mathematical transform on some type

    returns

    an output object of the same type

    Definition Classes
    DependencyManagerTransformLike
  27. lazy val transformOrder: Seq[B]

    Permalink

    An ordering of TransformLikes that causes the requested targets to be executed starting from the currentState.

    An ordering of TransformLikes that causes the requested targets to be executed starting from the currentState. This ordering respects prerequisites, dependents, and invalidates of all constituent TransformLikes. This uses an algorithm that attempts to reduce the number of re-lowerings due to invalidations. Re-lowerings are implemented as new DependencyManagers.

    Exceptions thrown

    DependencyManagerException if a cycle exists in either the dependencyGraph or the invalidateGraph.

  28. def transformOrderToGraphviz(colormap: Seq[String] = colormap): String

    Permalink
  29. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. def wrappers: Seq[(B) ⇒ B]

    Permalink

    A sequence of wrappers to apply to the resulting TransformLike sequence.

    A sequence of wrappers to apply to the resulting TransformLike sequence. This can be used to, e.g., add automated pre-processing and post-processing.

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from DependencyAPI[B]

Inherited from TransformLike[A]

Inherited from LazyLogging

Inherited from AnyRef

Inherited from Any

Ungrouped