chisel/firrtl/firrtl.options/DependencyAPI

DependencyAPI

firrtl.options.DependencyAPI

trait DependencyAPI[A <: DependencyAPI[A]]

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.

Type parameters

A: some transform

Attributes

Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: Phase.scala
Graph
Supertypes: class Object

trait Matchable

class Any
Known subtypes: trait DependencyManager[A, B]

class PhaseManager

trait Phase

object Checks

class AddDefaults

class Checks

class GetIncludes

class WriteOutputAnnotations

class Stage

class ChiselStage

class AddDefaults

class Checks

class AddImplicitOutputFile

class CIRCT

class Checks

class AddDedupGroupAnnotations

class AddImplicitOutputAnnotationFile

class AddImplicitOutputFile

class AddSerializationAnnotations

class Checks

class Convert

class Elaborate

class Emitter
Show all
Self type: TransformLike[_]

Members list

Value members

Concrete methods

A function that, given another transform (parameter a) will return true if this transform invalidates/undos the effects of the other transform (parameter a).

Value parameters

a: transform

Attributes

Source: Phase.scala

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.

Attributes

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.
Source: Phase.scala

All transforms that, if a prerequisite of another transform, will run before this transform.

Attributes

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

All transform that must run before this transform

Attributes

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

In this article

Generated with