Threads the mem.M memory monad through the world: mem-extends continuations and rewires every memory operand to the current memory at that program point. More...

#include <mim/plug/mem/phase/add_mem.h>

Inheritance diagram for mim::plug::mem::phase::AddMem:

[legend]

Public Member Functions
	RWPhase (World &world, std::string name, Analysis *analysis=nullptr)
	RWPhase (World &world, flags_t annex, Analysis *analysis=nullptr)
Public Member Functions inherited from mim::RWPhase
	RWPhase (World &world, std::string name, Analysis *analysis=nullptr)
	RWPhase (World &world, flags_t annex, Analysis *analysis=nullptr)
Analysis *	analysis ()
const Analysis *	analysis () const
const Def *	lattice (const Def *old_def) const
	Returns the abstract value computed by the associated Analysis for the given old-world Def, or nullptr if no value is available.
const Def *	abstracted (const Def *old_def) const
	Returns lattice(`old_def`) if it differs from `old_def` (i.e. we learned something), otherwise nullptr.
bool	is_top (const Def *old_def) const
virtual void	rewrite_external (Def *)
const Def *	lookup (const Def *) override
	Lookup old_def by searching in reverse through the stack of maps.
World &	world ()=delete
	Hides both and forbids direct access.
World &	old_world ()
	Get old Defs from here.
World &	new_world ()
	Create new Defs into this.
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 (World &world)
virtual	~Rewriter ()
void	reset ()
World &	world ()
void	push (Vars old_vars={}, Vars new_vars={})
void	pop ()
void	bind_old (const Var *var)
	Adds the old `var` - if any - to the innermost scope.
void	bind_new (const Var *var)
	Adds the new `var` - if any - to the innermost scope.
void	bind (const Var old_var, const Var new_var)
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 *	rewrite_imm (const Def *)
virtual const Def *	rewrite_mut (Def *)
const Def *	rewrite_stub (Def old_mut, Def new_mut, fe::View< size_t > new2old)
	Like above, but `new_mut` may have a different number of ops than `old_mut:` new_mut->op(i) is rewritten from old_mut->op(new2old[i]).
virtual DefVec	rewrite (Defs)
virtual const Def *	rewrite_imm_Lit (const Lit *)
virtual const Def *	rewrite_imm_Axm (const Axm *)
virtual const Def *	rewrite_imm_Var (const Var *)
virtual const Def *	rewrite_imm_Proxy (const Proxy *)
virtual const Def *	rewrite_imm_Type (const Type *)
virtual const Def *	rewrite_imm_Level (const Level *)
virtual const Def *	rewrite_imm_LMax (const LMax *)
virtual const Def *	rewrite_imm_LSucc (const LSucc *)
virtual const Def *	rewrite_imm_Lam (const Lam *)
virtual const Def *	rewrite_imm_Sigma (const Sigma *)
virtual const Def *	rewrite_imm_Extract (const Extract *)
virtual const Def *	rewrite_imm_Insert (const Insert *)
virtual const Def *	rewrite_imm_Arr (const Arr *)
virtual const Def *	rewrite_imm_Pack (const Pack *)
virtual const Def *	rewrite_imm_Join (const Join *)
virtual const Def *	rewrite_imm_Inj (const Inj *)
virtual const Def *	rewrite_imm_Match (const Match *)
virtual const Def *	rewrite_imm_Variant (const Variant *)
virtual const Def *	rewrite_imm_Top (const Top *)
virtual const Def *	rewrite_imm_Bot (const Bot *)
virtual const Def *	rewrite_imm_Reform (const Reform *)
virtual const Def *	rewrite_imm_Rule (const Rule *)
virtual const Def *	rewrite_imm_Single (const Single *)
virtual const Def *	rewrite_imm_Wrap (const Wrap *)
virtual const Def *	rewrite_imm_Nat (const Nat *)
virtual const Def *	rewrite_imm_Idx (const Idx *)
virtual const Def *	rewrite_imm_Nom (const Nom *)
virtual const Def *	rewrite_imm_Name (const Name *)
virtual const Def *	rewrite_imm_Struc (const Struc *)
virtual const Def *	rewrite_mut_Hole (Hole *)
virtual const Def *	rewrite_mut_Pi (Pi *)
virtual const Def *	rewrite_mut_Sigma (Sigma *)
virtual const Def *	rewrite_mut_Arr (Arr *)
virtual const Def *	rewrite_mut_Pack (Pack *)
virtual const Def *	rewrite_mut_Variant (Variant *)
virtual const Def *	rewrite_mut_Rule (Rule *)
virtual const Def *	rewrite_imm_Seq (const Seq *seq)
virtual const Def *	rewrite_mut_Seq (Seq *seq)

Private Member Functions
bool	analyze () final
	Runs the optional pre-analysis on old_world(), typically to a fixed point, before rewriting begins.
const Def *	rewrite (const Def *) override
const Def *	rewrite_mut_Lam (Lam *) override
const Def *	rewrite_imm_App (const App *) override
const Def *	rewrite_imm_Tuple (const Tuple *) override
const Def *	rewrite_imm_Pi (const Pi *) 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::RWPhase
void	start () override
	Actual entry.
virtual void	finalize ()
	Run after all roots have been walked but still before the two worlds are swapped.
const Def *	rewrite_imm_App (const App *) override
const Def *	rewrite_imm_Tuple (const Tuple *) override
const Def *	rewrite_stub (Def , Def ) override
const Def *	coerce (const Def new_type, const Def new_val)
	Converts the new `new_val` into a value of the new `new_type`, where a checking position demands it.
const Def *	rewrite_stub (Def old_mut, Def new_mut, fe::View< size_t > new2old)
	Like above, but `new_mut` may have a different number of ops than `old_mut:` new_mut->op(i) is rewritten from old_mut->op(new2old[i]).
Protected Member Functions inherited from mim::Rewriter
Def2Def &	old2new ()
	The map of the innermost push() scope.
bool	has_intersection (const Def *old_def)
	Does `old_def` depend on the old Vars of any scope?
auto	enter (Def *new_mut)
	Updates curr_mut() to `new_mut` and restores it at the end of the scope.
const Def *	seal (Def old_mut, Def new_mut)
	The tail of rewrite_stub: immutabilizes `new_mut` in hindsight, as rewriting may have made it vacuous.
static bool	splittable (const Def *type)
	Does coerce() explode and reassemble values of `type`?
Protected Attributes inherited from mim::Phase
std::string	name_
Protected Attributes inherited from mim::Rewriter
fe::Vector< Scope >	scopes_

Detailed Description

Threads the mem.M memory monad through the world: mem-extends continuations and rewires every memory operand to the current memory at that program point.

It's primarily to be used as preparation for other phases that rely on all continuations having a mem. It also splices the ⊥ : mem.M 0 memory placeholders of freshly emitted memory operations into the global memory chain and resolves mem.fresh (a, k) requests by jumping to k with the current memory (see mim::plug::tensor::phase::LowerToMem, which emits both and schedules this phase right behind itself).

The rewrite is a plain RWPhase. Memory is a linear resource, so at any program point exactly one memory token is live - the current memory. We track it in AddMem::curr_mem_ while rewriting a continuation's body:

it starts out as the continuation's (leading or grouped) mem parameter,
a rewritten memory operation advances it to the operation's result mem, and
every memory-typed operand is rewritten to the current memory.

Because the Rewriter visits operands before their users, the current memory naturally threads through the data-dependency order - no separate schedule is required. Independent ⊥/⊤ placeholder chains are thereby linearized into one chain in encounter order.

Three rules keep the rewrite type-correct in the presence of axiom-pinned ABIs:

Only continuations (Pi::isa_cn) are mem-extended; direct-style functions (e.g. the affine index mappings passed to btensor.map_reduce_post) keep their signature.
A pi whose leading parameter carries the memory grouped (the Fn [mem.M 0, To, ins] → … shape of a mem-threaded combiner) counts as already mem-threaded.
Lams reachable from axm-app arguments are preserved untouched: axioms pin their arguments' ABI (e.g. the combiner slot of btensor.map_reduce_post), so mem-extending them would be ill-typed.

Definition at line 32 of file add_mem.h.

Member Function Documentation

◆ analyze()

bool mim::plug::mem::phase::AddMem::analyze ( )

finalprivatevirtual

Runs the optional pre-analysis on old_world(), typically to a fixed point, before rewriting begins.

If analysis() is set, this is the natural place to iterate until Phase::todo() becomes false. If no Analysis is needed, simply return false.

Reimplemented from mim::RWPhase.

Definition at line 11 of file add_mem.cpp.

References mim::App::axm(), mim::Axm::isa(), and mim::RWPhase::old_world().

◆ rewrite()

const Def * mim::plug::mem::phase::AddMem::rewrite ( const Def * old_def )

overrideprivatevirtual

Reimplemented from mim::Rewriter.

Definition at line 43 of file add_mem.cpp.

References mim::Def::isa_imm(), mim::plug::mem::isa_mem(), mim::Def::isa_mut(), mim::Rewriter::rewrite(), rewrite_imm_Pi(), mim::Rewriter::rewrite_imm_Seq(), mim::Rewriter::rewrite_imm_Sigma(), rewrite_imm_Tuple(), and mim::Def::type().

Referenced by rewrite_imm_App(), rewrite_imm_Tuple(), and rewrite_mut_Lam().

◆ rewrite_imm_App()

const Def * mim::plug::mem::phase::AddMem::rewrite_imm_App ( const App * app )

overrideprivatevirtual

Reimplemented from mim::Rewriter.

Definition at line 134 of file add_mem.cpp.

References mim::App::arg(), mim::App::args(), mim::App::callee(), mim::Def::cat(), mim::Axm::isa(), mim::RWPhase::new_world(), mim::Pi::num_doms(), rewrite(), mim::Rewriter::rewrite_imm_App(), and mim::Def::type().

◆ rewrite_imm_Pi()

const Def * mim::plug::mem::phase::AddMem::rewrite_imm_Pi ( const Pi * pi )

overrideprivatevirtual

Reimplemented from mim::Rewriter.

Definition at line 69 of file add_mem.cpp.

References mim::Def::cat(), mim::plug::mem::has_leading_mem(), mim::Pi::isa_cn(), mim::RWPhase::new_world(), mim::Rewriter::rewrite_imm_Pi(), and mim::VarRewriter::VarRewriter().

Referenced by rewrite().

◆ rewrite_imm_Tuple()

const Def * mim::plug::mem::phase::AddMem::rewrite_imm_Tuple ( const Tuple * tuple )

overrideprivatevirtual

Reimplemented from mim::Rewriter.

Definition at line 165 of file add_mem.cpp.

References mim::Pi::isa_cn(), mim::plug::mem::isa_mem(), mim::RWPhase::new_world(), rewrite(), and mim::Rewriter::rewrite_imm_Tuple().

Referenced by rewrite().

◆ rewrite_mut_Lam()

const Def * mim::plug::mem::phase::AddMem::rewrite_mut_Lam ( Lam * old_lam )

overrideprivatevirtual

Reimplemented from mim::Rewriter.

Definition at line 102 of file add_mem.cpp.

References mim::Lam::body(), mim::Def::dbg_key(), mim::Lam::filter(), mim::Def::is_set(), mim::Rewriter::map(), mim::plug::mem::mem_var(), mim::World::mut_lam(), mim::RWPhase::new_world(), mim::Lam::num_doms(), mim::Def::num_vars(), rewrite(), mim::Rewriter::rewrite_mut_Lam(), mim::Def::set(), mim::Lam::set(), mim::Lam::type(), and mim::Def::var().

◆ RWPhase() [1/2]

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

inline

Definition at line 336 of file phase.h.

◆ RWPhase() [2/2]

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

inline

Definition at line 334 of file phase.h.

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

include/mim/plug/mem/phase/add_mem.h
src/mim/plug/mem/phase/add_mem.cpp

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ analyze()

◆ rewrite()

◆ rewrite_imm_App()

◆ rewrite_imm_Pi()

◆ rewrite_imm_Tuple()

◆ rewrite_mut_Lam()

◆ RWPhase() [1/2]

◆ RWPhase() [2/2]