utils::Pass Class Reference

Inheritance diagram for utils::Pass:

Public Member Functions
virtual void	Init ()
	Function to override when you want to acquire resources.
virtual void	Run ()=0
	Function to override to run the pass.
virtual std::string_view	Name () const
	Function to override to get the name (id) of the pass.
virtual std::string_view	Desc () const =0
	Function to override to get the description of the pass.
void	Preserve ()
	Preserve the analysis results of this pass.
bool	ShouldPreserve () const
	Should this pass be preserved?

Protected Member Functions
auto &	PM ()
	Gets the pass manager that owns the pass.
template<typename T >
requires PassType< T > T &	GetPass ()
	Gets a single pass of type T. Throws if no pass is found. Also throws if multiple passes of type T are found. More...
Pass &	GetPass (std::string_view name)
	Gets a single pass by name. Throws if no pass is found.
template<typename T >
requires PassType< T > Generator< T * >	GetPasses ()
	Gets all passes of type T. Throws if no pass is found. More...
void	ComputeDependency (Pass &pass)
	Computes a dependency between this and another pass. More...
CustomBufferResource *	NewHeap ()
	Requests a new heap from the pass manager. More...
virtual void	computeDependencies ()=0
	Overload to state the dependencies of this pass.
	Pass (PassManager &pm) noexcept
	Constructor for the pass. More...

Friends
class	PassManager

Detailed Description

Definition at line 111 of file PassManager.h.

Constructor & Destructor Documentation

Pass()

utils::Pass::Pass ( PassManager &  pm )

inlineexplicitprotectednoexcept

Constructor for the pass.

Parameters

pm	The pass manager that owns the pass

Definition at line 170 of file PassManager.h.

: pm_(pm) {}

Member Function Documentation

ComputeDependency()

void utils::Pass::ComputeDependency ( Pass &  pass )

protected

Computes a dependency between this and another pass.

Parameters

pass	The pass to add as a dependency

Definition at line 25 of file PassManager.cc.

                                       {
   // This function serves a many purposes depending on the state
   // 1. PropagateEnabled: Recursively propagate the enabled state
   // 2. AcquireResources: We acquire any heap resources
   // 3. RegisterDependencies: Register the dep with PM to build the depgraph
   // 4. Cleanup: We only free the heap resources
 
   if(state == PropagateEnabled) {
      // If we're disabled, then we don't need to do anything
      if(PM().PO().IsPassDisabled(this)) return;
      // Otherwise, we propagate the enabled state
      PM().PO().setPassEnabled(&pass, true);
      pass.state = PropagateEnabled;
      pass.computeDependencies();
      return;
   }
 
   for(auto& heap : PM().heaps_) {
      if(heap.owner != &pass) continue;
      if(state == AcquireResources) {
         heap.refCount++;
      } else if(state == Cleanup) {
         PM().freeHeap(heap);
      }
   }
 
   if(state == RegisterDependencies) {
      PM().addDependency(*this, pass);
   }
}

GetPass()

template<typename T >

requires PassType< T > T & utils::Pass::GetPass

protected

Gets a single pass of type T. Throws if no pass is found. Also throws if multiple passes of type T are found.

Template Parameters

T	The type of the pass

Returns

T& The pass of type T

Definition at line 350 of file PassManager.h.

                 {
   return PM().getPass<T>(*this);
}

GetPasses()

template<typename T >

requires PassType< T > Generator< T * > utils::Pass::GetPasses

protected

Gets all passes of type T. Throws if no pass is found.

Template Parameters

T	The type of the pass

Returns

A generator that yields all passes of type T

Definition at line 356 of file PassManager.h.

                              {
   return PM().getPasses<T>(*this);
}

NewHeap()

CustomBufferResource * utils::Pass::NewHeap ( )

protected

Requests a new heap from the pass manager.

Returns

CustomBufferResource* The new heap

Definition at line 56 of file PassManager.cc.

{ return PM().newHeap(*this); }

---

The documentation for this class was generated from the following files:

• include/utils/PassManager.h
• lib/utils/PassManager.cc