Traverses the current World using Rewriter infrastructure while staying in the same world. More...

#include <mim/phase.h>

Inheritance diagram for mim::Analysis:

Classes
class	Enter
	Helps to keep track of curr_mut(). More...

Public Member Functions
Construction & Destruction
	Analysis (World &world, std::string name)
	Analysis (World &world, flags_t annex)
virtual void	reset ()
	Clears the rewriter map and resets Phase::todo() for the next fixed-point iteration.
Getters
World &	world ()
Def *	curr_mut () const
bool	is_bootstrapping () const
lattice
auto &	lattice ()
const auto &	lattice () const
void	set (const Def concr, const Def abstr)
	Records the abstract value `abstr` for `concr` in both lattice() (the analysis result) and map() (so the rewriter short-circuits future rewrites of `concr` to `abstr`).
Public Member Functions inherited from mim::Phase
	Phase (World &world, std::string name)
	Phase (World &world, flags_t annex)
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.
Public Member Functions inherited from mim::Stage
	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.
virtual bool	redirects () const
	If true, Stage::create uses take_resolved().
virtual std::unique_ptr< Stage >	take_resolved ()
	The Stage to use instead; nullptr means elide.
World &	world ()
Driver &	driver ()
Log &	log () const
std::string_view	name () const
flags_t	annex () const
Public Member Functions inherited from mim::Rewriter
	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 (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)

Protected Member Functions
Rewrite
void	start () override
	Actual entry.
Enter	enter (Def *new_mut)
virtual void	rewrite_annex (flags_t, Sym, const Def *)
virtual void	rewrite_external (Def *)
virtual Def *	rewrite_deps (Def *)
	Walks `mut's` dependencies under its curr_mut() scope.
Def *	rewrite_mut (Def *) override
	Default "visit a mutable" entry point: maps mut -> mut, seeds Lam binder vars to top (v -> v) in the lattice, and delegates to rewrite_deps() for the recursive traversal.

Protected Attributes
Def2Def	lattice_
Protected Attributes inherited from mim::Stage
std::string	name_
Protected Attributes inherited from mim::Rewriter
std::deque< Def2Def >	old2news_

Friends
class	Enter

Additional Inherited Members
template<class P, class... Args>
static void	run (Args &&... args)
	Runs a single Phase.
Static Public Member Functions inherited from mim::Stage
static std::unique_ptr< Stage >	create (const Flags2Stages &stages, const Def *def)
template<class A, class P>
static void	hook (Flags2Stages &stages)

Detailed Description

Traverses the current World using Rewriter infrastructure while staying in the same world.

It recursively rewrites

all World::annexes() (during which Analysis::is_bootstrapping() is true), and then
all World::externals() (during which it is false).

Analysis provides a reusable lattice() mapping old Defs to abstract values, represented as ordinary MimIR Defs.

Note

You can override

See also: Analysis

Definition at line 82 of file phase.h.

Constructor & Destructor Documentation

◆ Analysis() [1/2]

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

inline

Definition at line 86 of file phase.h.

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

Referenced by mim::Analysis::Enter::Enter().

◆ Analysis() [2/2]

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

inline

Definition at line 89 of file phase.h.

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

Member Function Documentation

◆ curr_mut()

Def * mim::Analysis::curr_mut ( ) const

inline

Definition at line 103 of file phase.h.

Referenced by mim::Analysis::Enter::Enter().

◆ enter()

Enter mim::Analysis::enter ( Def * new_mut )

inlineprotected

Definition at line 140 of file phase.h.

Referenced by rewrite_deps().

◆ is_bootstrapping()

bool mim::Analysis::is_bootstrapping ( ) const

inline

Definition at line 104 of file phase.h.

◆ lattice() [1/2]

auto & mim::Analysis::lattice ( )

inline

Definition at line 109 of file phase.h.

References lattice_.

◆ lattice() [2/2]

const auto & mim::Analysis::lattice ( ) const

inline

Definition at line 110 of file phase.h.

References lattice_.

◆ reset()

void mim::Analysis::reset ( )

virtual

Clears the rewriter map and resets Phase::todo() for the next fixed-point iteration.

lattice() is preserved across iterations so that abstract values accumulated in earlier rounds remain available - this is what makes fixed-point convergence possible.

See also: RWPhase::analyze

Definition at line 23 of file phase.cpp.

References mim::Rewriter::old2news_, and mim::Rewriter::push().

◆ rewrite_annex()

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

protectedvirtual

Definition at line 39 of file phase.cpp.

References mim::Rewriter::rewrite().

Referenced by start().

◆ rewrite_deps()

Def * mim::Analysis::rewrite_deps ( Def * mut )

protectedvirtual

Walks mut's dependencies under its curr_mut() scope.

Unlike rewrite_mut(), does not record mut -> mut and does not seed any binder-related lattice state.

Use this when you have already populated custom lattice entries for mut's binder (typically inside a rewrite_imm_App override that propagates abstract values from call arguments into the callee's tvars) and need to traverse the body without rewrite_mut() clobbering that state.

Definition at line 42 of file phase.cpp.

References mim::Def::deps(), enter(), and mim::Rewriter::rewrite().

Referenced by rewrite_mut().

◆ rewrite_external()

void mim::Analysis::rewrite_external ( Def * mut )

protectedvirtual

Definition at line 40 of file phase.cpp.

References mim::Rewriter::rewrite().

Referenced by start().

◆ rewrite_mut()

Def * mim::Analysis::rewrite_mut ( Def * mut )

overrideprotectedvirtual

Default "visit a mutable" entry point: maps mut -> mut, seeds Lam binder vars to top (v -> v) in the lattice, and delegates to rewrite_deps() for the recursive traversal.

If a binder var already carried a non-top lattice value, it is reset to top and invalidate() is called: reaching a Lam through this default path means it has been used as a value (not as an App callee) and has therefore escaped, so any prior propagation for it is unsound and must be retracted.

Reimplemented from mim::Rewriter.

Definition at line 51 of file phase.cpp.

References mim::Phase::invalidate(), mim::Def::isa_binder(), lattice_, mim::Rewriter::map(), and rewrite_deps().

◆ set()

void mim::Analysis::set	(	const Def *	concr,
		const Def *	abstr )

inline

Records the abstract value abstr for concr in both lattice() (the analysis result) and map() (so the rewriter short-circuits future rewrites of concr to abstr).

Definition at line 114 of file phase.h.

References lattice_, and mim::Rewriter::map().

◆ start()

void mim::Analysis::start ( )

overrideprotectedvirtual

Actual entry.

Implements mim::Phase.

Definition at line 29 of file phase.cpp.

References rewrite_annex(), rewrite_external(), and world().

◆ world()

World & mim::Analysis::world ( )

inline

Definition at line 102 of file phase.h.

References mim::Stage::world().

Referenced by Analysis(), Analysis(), and start().

◆ Enter

friend class Enter

friend

Definition at line 171 of file phase.h.

Member Data Documentation

◆ lattice_

Def2Def mim::Analysis::lattice_

protected

Definition at line 165 of file phase.h.

Referenced by lattice(), lattice(), rewrite_mut(), and set().

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

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

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Analysis() [1/2]

◆ Analysis() [2/2]

Member Function Documentation

◆ curr_mut()

◆ enter()

◆ is_bootstrapping()

◆ lattice() [1/2]

◆ lattice() [2/2]

◆ reset()

◆ rewrite_annex()

◆ rewrite_deps()

◆ rewrite_external()

◆ rewrite_mut()

◆ set()

◆ start()

◆ world()

Friends And Related Symbol Documentation

◆ Enter

Member Data Documentation

◆ lattice_