A "must be executed context" for a given program point PP is the set of instructions, potentially before and after PP, that are executed always when PP is reached. More...

#include "llvm/Analysis/MustExecute.h"

Public Types
using	iterator = MustBeExecutedIterator
	Iterator-based interface.
using	const_iterator = const MustBeExecutedIterator

Public Member Functions
	MustBeExecutedContextExplorer (bool ExploreInterBlock, bool ExploreCFGForward, bool ExploreCFGBackward, GetterTy< const LoopInfo > LIGetter=[](const Function &) { return nullptr;}, GetterTy< const DominatorTree > DTGetter=[](const Function &) { return nullptr;}, GetterTy< const PostDominatorTree > PDTGetter=[](const Function &) { return nullptr;})
	In the description of the parameters we use PP to denote a program point for which the must be executed context is explored, or put differently, for which the MustBeExecutedIterator is created.
iterator &	begin (const Instruction *PP)
	Return an iterator to explore the context around `PP`.
const_iterator &	begin (const Instruction *PP) const
	Return an iterator to explore the cached context around `PP`.
iterator &	end ()
	Return an universal end iterator.
iterator &	end (const Instruction *)
const_iterator &	end () const
const_iterator &	end (const Instruction *) const
llvm::iterator_range< iterator >	range (const Instruction *PP)
	}
llvm::iterator_range< const_iterator >	range (const Instruction *PP) const
	Return an iterator range to explore the cached context around `PP`.
bool	checkForAllContext (const Instruction PP, function_ref< bool(const Instruction )> Pred)
	}
bool	findInContextOf (const Instruction I, const Instruction PP)
	Helper to look for `I` in the context of `PP`.
bool	findInContextOf (const Instruction *I, iterator &EIt, iterator &EEnd)
	Helper to look for `I` in the context defined by `EIt` and `EEnd`.
LLVM_ABI const Instruction *	getMustBeExecutedNextInstruction (MustBeExecutedIterator &It, const Instruction *PP)
	Return the next instruction that is guaranteed to be executed after `PP`.
LLVM_ABI const Instruction *	getMustBeExecutedPrevInstruction (MustBeExecutedIterator &It, const Instruction *PP)
	Return the previous instr.
LLVM_ABI const BasicBlock *	findForwardJoinPoint (const BasicBlock *InitBB)
	Find the next join point from `InitBB` in forward direction.
LLVM_ABI const BasicBlock *	findBackwardJoinPoint (const BasicBlock *InitBB)
	Find the next join point from `InitBB` in backward direction.

Public Attributes
const bool	ExploreInterBlock
	Parameter that limit the performed exploration.
const bool	ExploreCFGForward
const bool	ExploreCFGBackward

Detailed Description

A "must be executed context" for a given program point PP is the set of instructions, potentially before and after PP, that are executed always when PP is reached.

The MustBeExecutedContextExplorer an interface to explore "must be executed contexts" in a module through the use of MustBeExecutedIterator.

The explorer exposes "must be executed iterators" that traverse the must be executed context. There is little information sharing between iterators as the expected use case involves few iterators for "far apart" instructions. If that changes, we should consider caching more intermediate results.

Definition at line 388 of file MustExecute.h.

Member Typedef Documentation

◆ const_iterator

using llvm::MustBeExecutedContextExplorer::const_iterator = const MustBeExecutedIterator

Definition at line 419 of file MustExecute.h.

◆ iterator

using llvm::MustBeExecutedContextExplorer::iterator = MustBeExecutedIterator

Iterator-based interface.

See also: MustBeExecutedIterator. {

Definition at line 418 of file MustExecute.h.

Constructor & Destructor Documentation

◆ MustBeExecutedContextExplorer()

llvm::MustBeExecutedContextExplorer::MustBeExecutedContextExplorer	(	bool	ExploreInterBlock,
		bool	ExploreCFGForward,
		bool	ExploreCFGBackward,
		GetterTy< const LoopInfo >	LIGetter = [](const Function &) { return nullptr; },
		GetterTy< const DominatorTree >	DTGetter = [](const Function &) { return nullptr; },
		GetterTy< const PostDominatorTree >	PDTGetter = [](const Function &) { return nullptr; } )

inline

In the description of the parameters we use PP to denote a program point for which the must be executed context is explored, or put differently, for which the MustBeExecutedIterator is created.

Parameters

ExploreInterBlock	Flag to indicate if instructions in blocks other than the parent of PP should be explored.
ExploreCFGForward	Flag to indicate if instructions located after PP in the CFG, e.g., post-dominating PP, should be explored.
ExploreCFGBackward	Flag to indicate if instructions located before PP in the CFG, e.g., dominating PP, should be explored.

Definition at line 403 of file MustExecute.h.

References ExploreCFGBackward, ExploreCFGForward, and ExploreInterBlock.

Member Function Documentation

◆ begin() [1/2]

iterator & llvm::MustBeExecutedContextExplorer::begin ( const Instruction * PP )

inline

Return an iterator to explore the context around PP.

Definition at line 422 of file MustExecute.h.

Referenced by checkForAllContext(), findInContextOf(), llvm::Attributor::getAttrsFromAssumes(), range(), and range().

◆ begin() [2/2]

const_iterator & llvm::MustBeExecutedContextExplorer::begin ( const Instruction * PP ) const

inline

Return an iterator to explore the cached context around PP.

Definition at line 430 of file MustExecute.h.

◆ checkForAllContext()

bool llvm::MustBeExecutedContextExplorer::checkForAllContext	(	const Instruction *	PP,
		function_ref< bool(const Instruction *)>	Pred )

inline

}

Check Pred on all instructions in the context.

This method will evaluate Pred and return true if Pred holds in every instruction.

Definition at line 458 of file MustExecute.h.

References begin(), and end().

◆ end() [1/4]

iterator & llvm::MustBeExecutedContextExplorer::end ( )

inline

Return an universal end iterator.

{

Definition at line 436 of file MustExecute.h.

Referenced by checkForAllContext(), findInContextOf(), llvm::Attributor::getAttrsFromAssumes(), range(), and range().

◆ end() [2/4]

const_iterator & llvm::MustBeExecutedContextExplorer::end ( ) const

inline

Definition at line 439 of file MustExecute.h.

◆ end() [3/4]

iterator & llvm::MustBeExecutedContextExplorer::end ( const Instruction * )

inline

Definition at line 437 of file MustExecute.h.

◆ end() [4/4]

const_iterator & llvm::MustBeExecutedContextExplorer::end ( const Instruction * ) const

inline

Definition at line 440 of file MustExecute.h.

◆ findBackwardJoinPoint()

const BasicBlock * MustBeExecutedContextExplorer::findBackwardJoinPoint ( const BasicBlock * InitBB )

Find the next join point from InitBB in backward direction.

Definition at line 549 of file MustExecute.cpp.

References llvm::dbgs(), llvm::SmallVectorTemplateCommon< T, typename >::empty(), llvm::LoopInfoBase< BlockT, LoopT >::getLoopFor(), llvm::Value::getName(), llvm::DominatorTreeBase< NodeT, IsPostDom >::getNode(), llvm::BasicBlock::getParent(), llvm::BasicBlock::getUniquePredecessor(), LLVM_DEBUG, llvm::predecessors(), llvm::SmallVectorTemplateBase< T, bool >::push_back(), and llvm::SmallVectorTemplateCommon< T, typename >::size().

Referenced by getMustBeExecutedPrevInstruction().

◆ findForwardJoinPoint()

const BasicBlock * MustBeExecutedContextExplorer::findForwardJoinPoint ( const BasicBlock * InitBB )

Find the next join point from InitBB in forward direction.

Definition at line 413 of file MustExecute.cpp.

References llvm::append_range(), llvm::dbgs(), llvm::SmallVectorTemplateCommon< T, typename >::empty(), F, llvm::LoopInfoBase< BlockT, LoopT >::getLoopFor(), llvm::Value::getName(), llvm::DominatorTreeBase< NodeT, IsPostDom >::getNode(), getOrCreateCachedOptional(), llvm::BasicBlock::getParent(), llvm::BasicBlock::getUniqueSuccessor(), llvm::SmallPtrSetImpl< PtrType >::insert(), llvm::isGuaranteedToTransferExecutionToSuccessor(), LLVM_DEBUG, maybeEndlessLoop(), llvm::mayContainIrreducibleControl(), llvm::SmallVectorImpl< T >::pop_back_val(), llvm::SmallVectorTemplateBase< T, bool >::push_back(), llvm::SmallVectorTemplateCommon< T, typename >::size(), and llvm::successors().

Referenced by getMustBeExecutedNextInstruction().

◆ findInContextOf() [1/2]

bool llvm::MustBeExecutedContextExplorer::findInContextOf	(	const Instruction *	I,
		const Instruction *	PP )

inline

Helper to look for I in the context of PP.

The context is expanded until I was found or no more expansion is possible.

Returns: True, iff I was found.

Definition at line 472 of file MustExecute.h.

References begin(), end(), findInContextOf(), and I.

Referenced by findInContextOf(), and llvm::Attributor::getAttrsFromAssumes().

◆ findInContextOf() [2/2]

bool llvm::MustBeExecutedContextExplorer::findInContextOf	(	const Instruction *	I,
		iterator &	EIt,
		iterator &	EEnd )

inline

Helper to look for I in the context defined by EIt and EEnd.

The context is expanded until I was found or no more expansion is possible.

Returns: True, iff I was found.

Definition at line 483 of file MustExecute.h.

References llvm::MustBeExecutedIterator::count(), and I.

◆ getMustBeExecutedNextInstruction()

const Instruction * MustBeExecutedContextExplorer::getMustBeExecutedNextInstruction	(	MustBeExecutedIterator &	It,
		const Instruction *	PP )

Return the next instruction that is guaranteed to be executed after PP.

Parameters

It	The iterator that is used to traverse the must be executed context.
PP	The program point for which the next instruction that is guaranteed to execute is determined.

Definition at line 616 of file MustExecute.cpp.

References assert(), llvm::dbgs(), ExploreInterBlock, findForwardJoinPoint(), llvm::BasicBlock::front(), llvm::ilist_node_with_parent< NodeTy, ParentTy, Options >::getNextNode(), llvm::Instruction::getNumSuccessors(), llvm::ilist_detail::node_parent_access< NodeTy, ParentTy >::getParent(), llvm::Instruction::getSuccessor(), llvm::isGuaranteedToTransferExecutionToSuccessor(), llvm::Instruction::isTerminator(), and LLVM_DEBUG.

◆ getMustBeExecutedPrevInstruction()

const Instruction * MustBeExecutedContextExplorer::getMustBeExecutedPrevInstruction	(	MustBeExecutedIterator &	It,
		const Instruction *	PP )

Return the previous instr.

that is guaranteed to be executed before PP.

Parameters

It	The iterator that is used to traverse the must be executed context.
PP	The program point for which the previous instr. that is guaranteed to execute is determined.

Definition at line 673 of file MustExecute.cpp.

References llvm::dbgs(), ExploreInterBlock, findBackwardJoinPoint(), llvm::ilist_detail::node_parent_access< NodeTy, ParentTy >::getParent(), llvm::ilist_node_with_parent< NodeTy, ParentTy, Options >::getPrevNode(), and LLVM_DEBUG.

◆ range() [1/2]

llvm::iterator_range< iterator > llvm::MustBeExecutedContextExplorer::range ( const Instruction * PP )

inline

}

Return an iterator range to explore the context around PP.

Definition at line 444 of file MustExecute.h.

References begin(), end(), and llvm::make_range().

Referenced by llvm::MustBeExecutedContextPrinterPass::run().

◆ range() [2/2]

llvm::iterator_range< const_iterator > llvm::MustBeExecutedContextExplorer::range ( const Instruction * PP ) const

inline

Return an iterator range to explore the cached context around PP.

Definition at line 449 of file MustExecute.h.

References begin(), end(), and llvm::make_range().

Member Data Documentation

◆ ExploreCFGBackward

const bool llvm::MustBeExecutedContextExplorer::ExploreCFGBackward

Definition at line 520 of file MustExecute.h.

Referenced by MustBeExecutedContextExplorer().

◆ ExploreCFGForward

const bool llvm::MustBeExecutedContextExplorer::ExploreCFGForward

Definition at line 519 of file MustExecute.h.

Referenced by MustBeExecutedContextExplorer().

◆ ExploreInterBlock

const bool llvm::MustBeExecutedContextExplorer::ExploreInterBlock

Parameter that limit the performed exploration.

See the constructor for their meaning. {

Definition at line 518 of file MustExecute.h.

Referenced by getMustBeExecutedNextInstruction(), getMustBeExecutedPrevInstruction(), and MustBeExecutedContextExplorer().

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

include/llvm/Analysis/MustExecute.h
lib/Analysis/MustExecute.cpp

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ iterator

Constructor & Destructor Documentation

◆ MustBeExecutedContextExplorer()

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ checkForAllContext()

◆ end() [1/4]

◆ end() [2/4]

◆ end() [3/4]

◆ end() [4/4]

◆ findBackwardJoinPoint()

◆ findForwardJoinPoint()

◆ findInContextOf() [1/2]

◆ findInContextOf() [2/2]

◆ getMustBeExecutedNextInstruction()

◆ getMustBeExecutedPrevInstruction()

◆ range() [1/2]

◆ range() [2/2]

Member Data Documentation

◆ ExploreCFGBackward

◆ ExploreCFGForward

◆ ExploreInterBlock