All Passes that want to be registered in the PassMan must implement this interface. More...

#include <mim/pass.h>

Inheritance diagram for mim::Pass:

Public Member Functions
Construction & Destruction
	Pass (World &world, std::string name)

	Pass (World &world, flags_t annex)

virtual void	init (PassMan *)

Getters
PassMan &	man ()

const PassMan &	man () const

size_t	index () const

Rewrite Hook for the PassMan
Rewrites an immutable `def` within PassMan::curr_mut. Returns the replacement.
virtual const Def *	rewrite (const Def *def)

virtual const Def *	rewrite (const Var *var)

virtual const Def *	rewrite (const Proxy *proxy)

Analyze Hook for the PassMan
Invoked after the PassMan has finished Pass::rewriteing PassMan::curr_mut to analyze the Def. Will only be invoked if Pass::fixed_point() yields `true` - which will be the case for FPPasses. Returns mim::No_Undo or the state to roll back to.
virtual undo_t	analyze (const Def *)

virtual undo_t	analyze (const Var *)

virtual undo_t	analyze (const Proxy *)

Further Hooks for the PassMan
virtual bool	fixed_point () const

virtual bool	inspect () const =0
	Should the PassMan even consider this pass?

virtual void	enter ()
	Invoked just before Pass::rewriteing PassMan::curr_mut's body.

virtual void	prepare ()
	Invoked once before entering the main rewrite loop.

proxy
const Proxy *	proxy (const Def *type, Defs ops, u32 tag=0)

const Proxy *	isa_proxy (const Def *def, u32 tag=0)
	Check whether given `def` is a Proxy whose Proxy::pass matches this Pass's `IPass::index`.

const Proxy *	as_proxy (const Def *def, u32 tag=0)

Public Member Functions inherited from mim::Stage
World &	world ()

Driver &	driver ()

Log &	log () const

std::string_view	name () const

flags_t	annex () const

	Stage (World &world, std::string name)

	Stage (World &world, flags_t annex)

virtual	~Stage ()=default

virtual std::unique_ptr< Stage >	recreate ()
	Creates a new instance; needed by a fixed-point PhaseMan.

virtual void	apply (const App *)
	Invoked if your Stage has additional args.

virtual void	apply (Stage &)
	Dito, but invoked by Stage::recreate.

Private Member Functions
Memory Management
virtual void *	alloc ()
	Default constructor.

virtual void *	copy (const void *)
	Copy constructor.

virtual void	dealloc (void *)
	Destructor.

Friends
class	PassMan

Additional Inherited Members
static auto	create (const Flags2Stages &stages, const Def *def)

template<class A, class P>
static void	hook (Flags2Stages &stages)

Protected Attributes inherited from mim::Stage
std::string	name_

Detailed Description

All Passes that want to be registered in the PassMan must implement this interface.

Inherit from RWPass if your pass does not need state and a fixed-point iteration.
Inherit from FPPass if you do need state and a fixed-point.
If you do not rely on interaction between different Passes, consider using Phase instead.

Definition at line 83 of file pass.h.

Constructor & Destructor Documentation

◆ Pass() [1/2]

mim::Pass::Pass	(	World &	world,
		std::string	name )

inline

Definition at line 87 of file pass.h.

References mim::Stage::name(), mim::Stage::Stage(), and mim::Stage::world().

Referenced by mim::PassMan::apply(), mim::PassMan::find(), mim::PassMan::PassMan(), mim::RWPass< P, M >::RWPass(), and mim::RWPass< P, M >::RWPass().

◆ Pass() [2/2]

mim::Pass::Pass	(	World &	world,
		flags_t	annex )

inline

Definition at line 89 of file pass.h.

References mim::Stage::annex(), mim::Stage::Stage(), and mim::Stage::world().

Member Function Documentation

◆ alloc()

virtual void * mim::Pass::alloc ( )

inlineprivatevirtual

Default constructor.

Reimplemented in mim::FPPass< P, M >, mim::FPPass< BetaRed, Def >, mim::FPPass< CopyProp, Lam >, mim::FPPass< EtaExp, Lam >, mim::FPPass< EtaRed, Def >, mim::FPPass< LowerTypedClosPrep, Lam >, mim::FPPass< SSA, Lam >, and mim::FPPass< TailRecElim, Lam >.

Definition at line 158 of file pass.h.

◆ analyze() [1/3]

virtual undo_t mim::Pass::analyze ( const Def * )

inlinevirtual

Reimplemented in mim::BetaRed, mim::EtaExp, mim::plug::clos::LowerTypedClosPrep, mim::plug::mem::pass::SSA, and mim::TailRecElim.

Definition at line 116 of file pass.h.

References mim::No_Undo.

◆ analyze() [2/3]

virtual undo_t mim::Pass::analyze ( const Proxy * )

inlinevirtual

Reimplemented in mim::BetaRed, mim::EtaExp, mim::plug::mem::pass::CopyProp, and mim::plug::mem::pass::SSA.

Definition at line 118 of file pass.h.

References mim::No_Undo.

◆ analyze() [3/3]

virtual undo_t mim::Pass::analyze ( const Var * )

inlinevirtual

Reimplemented in mim::EtaRed.

Definition at line 117 of file pass.h.

References mim::No_Undo.

◆ as_proxy()

const Proxy * mim::Pass::as_proxy	(	const Def *	def,
		u32	tag = 0 )

inline

Definition at line 148 of file pass.h.

References index(), and proxy().

Referenced by mim::plug::mem::pass::SSA::rewrite().

◆ copy()

virtual void * mim::Pass::copy ( const void * )

inlineprivatevirtual

Copy constructor.

Reimplemented in mim::FPPass< P, M >, mim::FPPass< BetaRed, Def >, mim::FPPass< CopyProp, Lam >, mim::FPPass< EtaExp, Lam >, mim::FPPass< EtaRed, Def >, mim::FPPass< LowerTypedClosPrep, Lam >, mim::FPPass< SSA, Lam >, and mim::FPPass< TailRecElim, Lam >.

Definition at line 159 of file pass.h.

◆ dealloc()

virtual void mim::Pass::dealloc ( void * )

inlineprivatevirtual

Destructor.

Reimplemented in mim::FPPass< P, M >, mim::FPPass< BetaRed, Def >, mim::FPPass< CopyProp, Lam >, mim::FPPass< EtaExp, Lam >, mim::FPPass< EtaRed, Def >, mim::FPPass< LowerTypedClosPrep, Lam >, mim::FPPass< SSA, Lam >, and mim::FPPass< TailRecElim, Lam >.

Definition at line 160 of file pass.h.

◆ enter()

virtual void mim::Pass::enter ( )

inlinevirtual

Invoked just before Pass::rewriteing PassMan::curr_mut's body.

Note: This is invoked when seeing the inside of a mutable the first time. This is often too late, as you usually want to do something when you see a mutable the first time from the outside. This means that this PassMan::curr_mut has already been encountered elsewhere. Otherwise, we wouldn't have seen PassMan::curr_mut to begin with (unless it is Def::is_external).

Reimplemented in mim::plug::clos::Clos2SJLJ, mim::plug::clos::ClosConvPrep, mim::plug::direct::CPS2DS, mim::plug::mem::pass::Reshape, and mim::plug::mem::pass::SSA.

Definition at line 133 of file pass.h.

◆ fixed_point()

virtual bool mim::Pass::fixed_point ( ) const

inlinevirtual

Reimplemented in mim::FPPass< P, M >, mim::FPPass< BetaRed, Def >, mim::FPPass< CopyProp, Lam >, mim::FPPass< EtaExp, Lam >, mim::FPPass< EtaRed, Def >, mim::FPPass< LowerTypedClosPrep, Lam >, mim::FPPass< SSA, Lam >, mim::FPPass< TailRecElim, Lam >, and mim::PassMan.

Definition at line 123 of file pass.h.

◆ index()

size_t mim::Pass::index ( ) const

inline

Definition at line 99 of file pass.h.

Referenced by as_proxy(), mim::plug::autodiff::Eval::augment_(), mim::plug::autodiff::Eval::augment_extract(), mim::FPPass< P, M >::data(), isa_proxy(), proxy(), and mim::plug::clos::BranchClosElim::rewrite().

◆ init()

void mim::Pass::init ( PassMan * man )

virtual

Reimplemented in mim::EtaExp, mim::PassMan, mim::plug::clos::ClosConvPrep, mim::plug::mem::pass::CopyProp, mim::plug::mem::pass::SSA, mim::Scalarize, and mim::TailRecElim.

Definition at line 30 of file pass.cpp.

References man(), and PassMan.

Referenced by mim::EtaExp::init(), mim::plug::clos::ClosConvPrep::init(), mim::plug::mem::pass::CopyProp::init(), mim::plug::mem::pass::SSA::init(), mim::Scalarize::init(), and mim::TailRecElim::init().

◆ inspect()

virtual bool mim::Pass::inspect ( ) const

pure virtual

◆ isa_proxy()

const Proxy * mim::Pass::isa_proxy	(	const Def *	def,
		u32	tag = 0 )

inline

Check whether given def is a Proxy whose Proxy::pass matches this Pass's IPass::index.

Definition at line 143 of file pass.h.

References index(), and proxy().

Referenced by mim::plug::mem::pass::SSA::rewrite().

◆ man() [1/2]

PassMan & mim::Pass::man ( )

inline

Definition at line 97 of file pass.h.

References PassMan.

Referenced by mim::PassMan::apply(), mim::RWPass< P, M >::curr_mut(), mim::FPPass< P, M >::curr_undo(), mim::EtaExp::init(), init(), mim::plug::clos::ClosConvPrep::init(), mim::plug::mem::pass::CopyProp::init(), mim::plug::mem::pass::SSA::init(), mim::Scalarize::init(), mim::TailRecElim::init(), mim::RWPass< P, M >::inspect(), mim::FPPass< P, M >::states(), mim::FPPass< P, M >::states(), and mim::FPPass< P, M >::undo_visit().

◆ man() [2/2]

const PassMan & mim::Pass::man ( ) const

inline

Definition at line 98 of file pass.h.

References PassMan.

◆ prepare()

virtual void mim::Pass::prepare ( )

inlinevirtual

Invoked once before entering the main rewrite loop.

Definition at line 136 of file pass.h.

◆ proxy()

const Proxy * mim::Pass::proxy	(	const Def *	type,
		Defs	ops,
		u32	tag = 0 )

inline

Definition at line 141 of file pass.h.

References index(), mim::World::proxy(), and mim::Stage::world().

Referenced by mim::BetaRed::analyze(), mim::plug::mem::pass::CopyProp::analyze(), mim::plug::mem::pass::SSA::analyze(), as_proxy(), isa_proxy(), mim::EtaExp::proxy(), mim::BetaRed::rewrite(), rewrite(), mim::plug::mem::pass::CopyProp::rewrite(), mim::plug::mem::pass::SSA::rewrite(), and mim::plug::mem::pass::SSA::rewrite().

◆ rewrite() [1/3]

virtual const Def * mim::Pass::rewrite ( const Def * def )

inlinevirtual

Reimplemented in mim::BetaRed, mim::EtaExp, mim::EtaRed, mim::LamSpec, mim::plug::autodiff::Eval, mim::plug::clos::BranchClosElim, mim::plug::clos::Clos2SJLJ, mim::plug::clos::ClosConvPrep, mim::plug::clos::LowerTypedClosPrep, mim::plug::direct::DS2CPS, mim::plug::matrix::LowerMatrixHighLevelMapRed, mim::plug::matrix::LowerMatrixMediumLevel, mim::plug::mem::pass::CopyProp, mim::plug::mem::pass::SSA, mim::plug::regex::LowerRegex, mim::Scalarize, and mim::TailRecElim.

Definition at line 106 of file pass.h.

◆ rewrite() [2/3]

virtual const Def * mim::Pass::rewrite ( const Proxy * proxy )

inlinevirtual

Reimplemented in mim::plug::mem::pass::SSA.

Definition at line 108 of file pass.h.

References proxy().

◆ rewrite() [3/3]

virtual const Def * mim::Pass::rewrite ( const Var * var )

inlinevirtual

Definition at line 107 of file pass.h.

Friends And Related Symbol Documentation

◆ PassMan

friend class PassMan

friend

Definition at line 166 of file pass.h.

References PassMan.

Referenced by init(), mim::plug::clos::ClosConvPrep::init(), mim::plug::mem::pass::CopyProp::init(), mim::plug::mem::pass::SSA::init(), man(), man(), and PassMan.

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

include/mim/pass.h
src/mim/pass.cpp

Public Member Functions

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Pass() [1/2]

◆ Pass() [2/2]

Member Function Documentation

◆ alloc()

◆ analyze() [1/3]

◆ analyze() [2/3]

◆ analyze() [3/3]

◆ as_proxy()

◆ copy()

◆ dealloc()

◆ enter()

◆ fixed_point()

◆ index()

◆ init()

◆ inspect()

◆ isa_proxy()

◆ man() [1/2]

◆ man() [2/2]

◆ prepare()

◆ proxy()

◆ rewrite() [1/3]

◆ rewrite() [2/3]

◆ rewrite() [3/3]

Friends And Related Symbol Documentation

◆ PassMan