Rewrites the current World in place - unlike an RWPhase, which rebuilds a new World. More...

#include <mim/phase.h>

Inheritance diagram for mim::InplaceRWPhase:

Public Member Functions
Construction
	InplaceRWPhase (World &world, std::string name, Analysis *analysis=nullptr)
	InplaceRWPhase (World &world, flags_t annex, Analysis *analysis=nullptr)
Getters
World &	world ()
Public Member Functions inherited from mim::RWBase
Analysis *	analysis ()
const Analysis *	analysis () const
const Def *	lattice (const Def *def) const
	Returns the abstract value computed by the associated Analysis for `def`, or nullptr if no value is available.
const Def *	abstracted (const Def *def) const
	Returns lattice(`def`) if it differs from `def` (i.e. we learned something), otherwise nullptr.
virtual bool	analyze ()
	Runs the optional pre-analysis on Phase::world, typically to a fixed point, before rewriting begins.
bool	is_bootstrapping () const
	Returns whether we are currently bootstrapping (rewriting annexes).
Public Member Functions inherited from mim::Phase
	Phase (World &world, std::string name)
	Phase (World &world, flags_t annex)
virtual	~Phase ()=default
virtual std::unique_ptr< Phase >	recreate ()
	Creates a new instance; needed by a fixed-point PhaseMan.
virtual void	apply (const App *)
	Invoked if your Phase has additional args.
virtual void	apply (Phase &)
	Dito, but invoked by Phase::recreate.
virtual bool	redirects () const
	If true, Phase::create uses take_resolved().
virtual std::unique_ptr< Phase >	take_resolved ()
	The Phase to use instead; nullptr means elide.
World &	world ()
Driver &	driver ()
const fe::Log &	log () const
std::string_view	name () const
flags_t	annex () const
const fe::Vector< std::string > &	args ()
	Command-line arguments passed to this Phase's plugin via -X <plugin>:<arg>.
bool	todo () const
void	invalidate (bool todo=true)
	Signals that another round of fixed-point iteration is required, either as part of.
virtual void	run ()
	Entry point and generates some debug output; invokes Phase::start.
void	profile_count (std::string_view key, uint64_t n=1)
	Adds `n` to the custom fe::Profiler counter `key` of the current run; no-op unless profiling is enabled.
Public Member Functions inherited from mim::Rewriter
template<class D = Def>
D *	curr_mut () const
	Rewriter (std::unique_ptr< World > &&ptr)
	Rewriter (World &world)
virtual	~Rewriter ()
void	reset (std::unique_ptr< World > &&ptr)
void	reset ()
World &	world ()
virtual void	push ()
virtual void	pop ()
virtual const Def *	map (const Def old_def, const Def new_def)
const Def *	map_root (const Def old_def, const Def new_def)
	Like map() but records into the root map, so the entry outlives the current push()/pop() scope.
const Def *	map (const Def *old_def, Defs new_defs)
const Def *	map (Defs old_defs, const Def *new_def)
const Def *	map (Defs old_defs, Defs new_defs)
virtual const Def *	lookup (const Def *old_def)
	Lookup old_def by searching in reverse through the stack of maps.
virtual const Def *	rewrite (const Def *)
virtual const Def *	rewrite_imm (const Def *)
virtual const Def *	rewrite_stub (Def , Def )
virtual DefVec	rewrite (Defs)
virtual const Def *	rewrite_imm_Seq (const Seq *seq)
virtual const Def *	rewrite_mut_Seq (Seq *seq)

Rewrite
bool	rewrite_annexes () const override
void	rewrite_annex (flags_t, Sym, const Def *) override
void	rewrite_external (Def *) override
const Def *	rewrite_mut (Def *mut) override

Additional Inherited Members
Static Public Member Functions inherited from mim::Phase
static std::unique_ptr< Phase >	create (const Flags2Phases &phases, const Def *def)
template<class A, class P>
static void	hook (Flags2Phases &phases)
template<class P, class... Args>
static void	run (Args &&... args)
	Runs a single Phase.
Protected Member Functions inherited from mim::RWBase
void	start () override
	Actual entry.
virtual const Def *	rewrite_root (const Def *def)
	Rewrites a root - i.e. an annex or an external.
virtual void	finalize ()
	Run after all roots have been walked - but for an RWPhase still before the two worlds are swapped.
	RWBase (World &world, std::string name, Analysis *analysis)
	RWBase (World &world, flags_t annex, Analysis *analysis)
	RWBase (World &world, std::string name, Analysis *analysis, std::unique_ptr< World > &&new_world)
	Rewrite the World of Phase::world into `new_world`.
	RWBase (World &world, flags_t annex, Analysis *analysis, std::unique_ptr< World > &&new_world)
Protected Member Functions inherited from mim::Rewriter
auto	enter (Def *new_mut)
	Updates curr_mut() to `new_mut` and restores it at the end of the scope.
Protected Attributes inherited from mim::Phase
std::string	name_
Protected Attributes inherited from mim::Rewriter
std::deque< Def2Def >	old2news_

Detailed Description

Rewrites the current World in place - unlike an RWPhase, which rebuilds a new World.

A mutable keeps its identity: only its ops() are Def::set anew, and only if the rewrite actually changed them. So hash-consing makes every unaffected Def free instead of a per-run rebuild tax. A mutable whose type changes is the one exception - identity is tied to the type - and falls back to an RWPhase-style stub rebuild in this same World. This matters most for the annex graph: it is proportional to the loaded plugins - not to the program - and a local rewrite never touches it, yet an RWPhase re-creates all of it on every run.

Prune subtrees that provably cannot change - e.g. with Def::is_ground - to turn the traversal from "hash-cons every node" into "touch only what matters".

Since a change is only ever committed if it really is one, Phase::todo() is exact: a quiet run costs a pruned traversal and nothing else.

Warning

An InplaceRWPhase

cannot immutabilize a mutable that the rewrite made vacuous (unless it takes the type-change fallback),
must not hand out a fresh identity for something already in its target shape - that would never converge, and
leaves what it replaced behind as garbage until the next Cleanup.

Use an RWPhase for anything else.

See also: InplaceRWPhase

Definition at line 485 of file phase.h.

Constructor & Destructor Documentation

◆ InplaceRWPhase() [1/2]

mim::InplaceRWPhase::InplaceRWPhase	(	World &	world,
		std::string	name,
		Analysis *	analysis = nullptr )

inline

Definition at line 489 of file phase.h.

References mim::RWBase::analysis(), mim::Phase::name(), mim::RWBase::RWBase(), and world().

Referenced by mim::BetaRed::BetaRed(), mim::BetaRed::BetaRed(), mim::EtaConv::EtaConv(), and mim::EtaConv::EtaConv().

◆ InplaceRWPhase() [2/2]

mim::InplaceRWPhase::InplaceRWPhase	(	World &	world,
		flags_t	annex,
		Analysis *	analysis = nullptr )

inline

Definition at line 491 of file phase.h.

References mim::RWBase::analysis(), mim::Phase::annex(), mim::RWBase::RWBase(), and world().

Member Function Documentation

◆ rewrite_annex()

void mim::InplaceRWPhase::rewrite_annex	(	flags_t	flags,
		Sym	,
		const Def *	def )

overridevirtual

Implements mim::RWBase.

Definition at line 211 of file phase.cpp.

References mim::World::annexes(), mim::Phase::invalidate(), mim::World::Annexes::reattach(), mim::RWBase::rewrite_root(), and world().

◆ rewrite_annexes()

bool mim::InplaceRWPhase::rewrite_annexes ( ) const

inlineoverridevirtual

An RWPhase has to walk the annexes; an InplaceRWPhase finds that table already correct, so the annex graph - which is proportional to the loaded plugins, not to the program - is pure extra coverage here, and a local rewrite gains nothing from it: whatever the program actually uses is reached through the externals anyway. Hence this defaults to false; say true if your rewrite must also see unused annexes.

Implements mim::RWBase.

Definition at line 506 of file phase.h.

◆ rewrite_external()

void mim::InplaceRWPhase::rewrite_external ( Def * old_mut )

overridevirtual

Implements mim::RWBase.

Definition at line 218 of file phase.cpp.

References mim::Def::internalize(), mim::Phase::invalidate(), and mim::RWBase::rewrite_root().

◆ rewrite_mut()

const Def * mim::InplaceRWPhase::rewrite_mut ( Def * mut )

overrideprotectedvirtual

Keeps mut's identity and Def::sets its ops anew iff rewriting them changed anything.

Reimplemented from mim::Rewriter.

Definition at line 228 of file phase.cpp.

References mim::Rewriter::enter(), mim::Phase::invalidate(), mim::Def::is_set(), mim::Rewriter::map(), mim::Def::ops(), mim::Phase::profile_count(), mim::Rewriter::rewrite(), mim::Rewriter::rewrite_mut(), mim::Def::set(), mim::Def::type(), and mim::Def::unset().

◆ world()

World & mim::Phase::world ( )

inline

Definition at line 77 of file phase.h.

Referenced by mim::BetaRed::analyze(), mim::EtaConv::analyze(), mim::BetaRed::BetaRed(), mim::BetaRed::BetaRed(), mim::EtaConv::EtaConv(), mim::EtaConv::EtaConv(), InplaceRWPhase(), InplaceRWPhase(), rewrite_annex(), mim::EtaConv::rewrite_imm_App(), and mim::EtaConv::rewrite_imm_Var().

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

include/mim/phase.h
src/mim/phase.cpp

Public Member Functions

Rewrite

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ InplaceRWPhase() [1/2]

◆ InplaceRWPhase() [2/2]

Member Function Documentation

◆ rewrite_annex()

◆ rewrite_annexes()

◆ rewrite_external()

◆ rewrite_mut()

◆ world()