Utility proxy to wrap the common members of LoadInst and StoreInst. More...

#include <ScopHelper.h>

Public Member Functions
	MemAccInst ()
	MemAccInst (const MemAccInst &Inst)
	MemAccInst (llvm::LoadInst &LI)
	MemAccInst (llvm::LoadInst *LI)
	MemAccInst (llvm::StoreInst &SI)
	MemAccInst (llvm::StoreInst *SI)
	MemAccInst (llvm::MemIntrinsic *MI)
	MemAccInst (llvm::CallInst *CI)
	MemAccInst (llvm::Instruction &I)
	MemAccInst (llvm::Instruction *I)
MemAccInst &	operator= (const MemAccInst &Inst)
MemAccInst &	operator= (llvm::LoadInst &LI)
MemAccInst &	operator= (llvm::LoadInst *LI)
MemAccInst &	operator= (llvm::StoreInst &SI)
MemAccInst &	operator= (llvm::StoreInst *SI)
MemAccInst &	operator= (llvm::MemIntrinsic &MI)
MemAccInst &	operator= (llvm::MemIntrinsic *MI)
MemAccInst &	operator= (llvm::CallInst &CI)
MemAccInst &	operator= (llvm::CallInst *CI)
llvm::Instruction *	get () const
	operator llvm::Instruction * () const
llvm::Instruction *	operator-> () const
	operator bool () const
bool	operator! () const
llvm::Value *	getValueOperand () const
llvm::Value *	getPointerOperand () const
bool	isVolatile () const
bool	isSimple () const
llvm::AtomicOrdering	getOrdering () const
bool	isUnordered () const
bool	isNull () const
bool	isInstruction () const
llvm::Instruction *	asInstruction () const
bool	isLoad () const
bool	isStore () const
bool	isCallInst () const
bool	isMemIntrinsic () const
bool	isMemSetInst () const
bool	isMemTransferInst () const
llvm::LoadInst *	asLoad () const
llvm::StoreInst *	asStore () const
llvm::CallInst *	asCallInst () const
llvm::MemIntrinsic *	asMemIntrinsic () const
llvm::MemSetInst *	asMemSetInst () const
llvm::MemTransferInst *	asMemTransferInst () const

Static Public Member Functions
static bool	isa (const llvm::Value &V)
static bool	isa (const llvm::Value *V)
static MemAccInst	cast (llvm::Value &V)
static MemAccInst	cast (llvm::Value *V)
static MemAccInst	cast_or_null (llvm::Value &V)
static MemAccInst	cast_or_null (llvm::Value *V)
static MemAccInst	dyn_cast (llvm::Value &V)
static MemAccInst	dyn_cast (llvm::Value *V)

Private Attributes
llvm::Instruction *	I

Detailed Description

Utility proxy to wrap the common members of LoadInst and StoreInst.

This works like the LLVM utility class CallSite, ie. it forwards all calls to either a LoadInst, StoreInst, MemIntrinsic or MemTransferInst. It is similar to LLVM's utility classes IntrinsicInst, MemIntrinsic, MemTransferInst, etc. in that it offers a common interface, but does not act as a fake base class. It is similar to StringRef and ArrayRef in that it holds a pointer to the referenced object and should be passed by-value as it is small enough.

This proxy can either represent a LoadInst instance, a StoreInst instance, a MemIntrinsic instance (memset, memmove, memcpy), a CallInst instance or a nullptr (only creatable using the default constructor); never an Instruction that is neither of the above mentioned. When representing a nullptr, only the following methods are defined: isNull(), isInstruction(), isLoad(), isStore(), ..., isMemTransferInst(), operator bool(), operator!()

The functions isa, cast, cast_or_null, dyn_cast are modeled to resemble those from llvm/Support/Casting.h. Partial template function specialization is currently not supported in C++ such that those cannot be used directly. (llvm::isa could, but then llvm:cast etc. would not have the expected behavior)

Definition at line 141 of file ScopHelper.h.

Constructor & Destructor Documentation

◆ MemAccInst() [1/10]

polly::MemAccInst::MemAccInst ( )

inline

Definition at line 146 of file ScopHelper.h.

References I.

Referenced by cast(), cast(), cast_or_null(), cast_or_null(), dyn_cast(), dyn_cast(), MemAccInst(), operator=(), operator=(), operator=(), operator=(), operator=(), operator=(), operator=(), operator=(), and operator=().

◆ MemAccInst() [2/10]

polly::MemAccInst::MemAccInst ( const MemAccInst & Inst )

inline

Definition at line 147 of file ScopHelper.h.

References I, and MemAccInst().

◆ MemAccInst() [3/10]

polly::MemAccInst::MemAccInst ( llvm::LoadInst & LI )

inline

Definition at line 148 of file ScopHelper.h.

References I.

◆ MemAccInst() [4/10]

polly::MemAccInst::MemAccInst ( llvm::LoadInst * LI )

inline

Definition at line 149 of file ScopHelper.h.

References I.

◆ MemAccInst() [5/10]

polly::MemAccInst::MemAccInst ( llvm::StoreInst & SI )

inline

Definition at line 150 of file ScopHelper.h.

References I.

◆ MemAccInst() [6/10]

polly::MemAccInst::MemAccInst ( llvm::StoreInst * SI )

inline

Definition at line 151 of file ScopHelper.h.

References I.

◆ MemAccInst() [7/10]

polly::MemAccInst::MemAccInst ( llvm::MemIntrinsic * MI )

inline

Definition at line 152 of file ScopHelper.h.

References I.

◆ MemAccInst() [8/10]

polly::MemAccInst::MemAccInst ( llvm::CallInst * CI )

inline

Definition at line 153 of file ScopHelper.h.

References I.

◆ MemAccInst() [9/10]

polly::MemAccInst::MemAccInst ( llvm::Instruction & I )

inlineexplicit

Definition at line 154 of file ScopHelper.h.

References assert, I, and isa().

◆ MemAccInst() [10/10]

polly::MemAccInst::MemAccInst ( llvm::Instruction * I )

inlineexplicit

Definition at line 155 of file ScopHelper.h.

References assert, I, and isa().

Member Function Documentation

◆ asCallInst()

llvm::CallInst * polly::MemAccInst::asCallInst ( ) const

inline

Definition at line 322 of file ScopHelper.h.

References I.

◆ asInstruction()

llvm::Instruction * polly::MemAccInst::asInstruction ( ) const

inline

Definition at line 309 of file ScopHelper.h.

References I.

Referenced by llvm::simplify_type< polly::MemAccInst >::getSimplifiedValue(), and operator llvm::Instruction *().

◆ asLoad()

llvm::LoadInst * polly::MemAccInst::asLoad ( ) const

inline

Definition at line 320 of file ScopHelper.h.

References I.

Referenced by getOrdering(), getPointerOperand(), getValueOperand(), isSimple(), isUnordered(), and isVolatile().

◆ asMemIntrinsic()

llvm::MemIntrinsic * polly::MemAccInst::asMemIntrinsic ( ) const

inline

Definition at line 323 of file ScopHelper.h.

References I.

Referenced by getPointerOperand(), isSimple(), isUnordered(), and isVolatile().

◆ asMemSetInst()

llvm::MemSetInst * polly::MemAccInst::asMemSetInst ( ) const

inline

Definition at line 326 of file ScopHelper.h.

References I.

◆ asMemTransferInst()

llvm::MemTransferInst * polly::MemAccInst::asMemTransferInst ( ) const

inline

Definition at line 329 of file ScopHelper.h.

References I.

◆ asStore()

llvm::StoreInst * polly::MemAccInst::asStore ( ) const

inline

Definition at line 321 of file ScopHelper.h.

References I.

Referenced by getOrdering(), getPointerOperand(), getValueOperand(), isSimple(), isUnordered(), and isVolatile().

◆ cast() [1/2]

MemAccInst polly::MemAccInst::cast ( llvm::Value & V )

inlinestatic

Definition at line 165 of file ScopHelper.h.

References MemAccInst().

◆ cast() [2/2]

MemAccInst polly::MemAccInst::cast ( llvm::Value * V )

inlinestatic

Definition at line 168 of file ScopHelper.h.

References MemAccInst().

◆ cast_or_null() [1/2]

MemAccInst polly::MemAccInst::cast_or_null ( llvm::Value & V )

inlinestatic

Definition at line 171 of file ScopHelper.h.

References MemAccInst().

◆ cast_or_null() [2/2]

MemAccInst polly::MemAccInst::cast_or_null ( llvm::Value * V )

inlinestatic

Definition at line 174 of file ScopHelper.h.

References MemAccInst().

◆ dyn_cast() [1/2]

MemAccInst polly::MemAccInst::dyn_cast ( llvm::Value & V )

inlinestatic

Definition at line 179 of file ScopHelper.h.

References isa(), and MemAccInst().

Referenced by polly::ScopBuilder::buildAccessFunctions(), getMemAccInstPointerOperand(), polly::ScopDetection::isValidInstruction(), and polly::IslNodeBuilder::materializeValue().

◆ dyn_cast() [2/2]

MemAccInst polly::MemAccInst::dyn_cast ( llvm::Value * V )

inlinestatic

Definition at line 184 of file ScopHelper.h.

References assert, isa(), and MemAccInst().

◆ get()

llvm::Instruction * polly::MemAccInst::get ( ) const

inline

Definition at line 228 of file ScopHelper.h.

References assert, and I.

Referenced by operator->().

◆ getOrdering()

llvm::AtomicOrdering polly::MemAccInst::getOrdering ( ) const

inline

Definition at line 282 of file ScopHelper.h.

References asLoad(), asStore(), isCallInst(), isLoad(), isMemIntrinsic(), and isStore().

◆ getPointerOperand()

llvm::Value * polly::MemAccInst::getPointerOperand ( ) const

inline

Definition at line 249 of file ScopHelper.h.

References asLoad(), asMemIntrinsic(), asStore(), isCallInst(), isLoad(), isMemIntrinsic(), and isStore().

Referenced by polly::ScopBuilder::buildAccessMultiDimFixed(), polly::ScopBuilder::buildAccessMultiDimParam(), polly::ScopBuilder::buildAccessSingleDim(), polly::ScopBuilder::buildAliasGroupsForAccesses(), polly::BlockGenerator::generateLocationAccessed(), and polly::ScopDetection::isValidMemoryAccess().

◆ getValueOperand()

llvm::Value * polly::MemAccInst::getValueOperand ( ) const

inline

Definition at line 238 of file ScopHelper.h.

References asLoad(), asStore(), isCallInst(), isLoad(), isMemIntrinsic(), and isStore().

Referenced by polly::ScopBuilder::buildAccessMemIntrinsic(), polly::ScopBuilder::buildAccessMultiDimFixed(), polly::ScopBuilder::buildAccessMultiDimParam(), and polly::ScopBuilder::buildAccessSingleDim().

◆ isa() [1/2]

bool polly::MemAccInst::isa ( const llvm::Value & V )

inlinestatic

Definition at line 157 of file ScopHelper.h.

Referenced by dyn_cast(), dyn_cast(), MemAccInst(), and MemAccInst().

◆ isa() [2/2]

bool polly::MemAccInst::isa ( const llvm::Value * V )

inlinestatic

Definition at line 161 of file ScopHelper.h.

◆ isCallInst()

bool polly::MemAccInst::isCallInst ( ) const

inline

Definition at line 313 of file ScopHelper.h.

References I.

Referenced by getOrdering(), getPointerOperand(), getValueOperand(), isSimple(), isUnordered(), and isVolatile().

◆ isInstruction()

bool polly::MemAccInst::isInstruction ( ) const

inline

Definition at line 307 of file ScopHelper.h.

References I.

Referenced by operator bool().

◆ isLoad()

bool polly::MemAccInst::isLoad ( ) const

inline

Definition at line 311 of file ScopHelper.h.

References I.

Referenced by polly::ScopBuilder::buildAccessMultiDimFixed(), polly::ScopBuilder::buildAccessMultiDimParam(), polly::ScopBuilder::buildAccessSingleDim(), getOrdering(), getPointerOperand(), getValueOperand(), isSimple(), isUnordered(), and isVolatile().

◆ isMemIntrinsic()

bool polly::MemAccInst::isMemIntrinsic ( ) const

inline

Definition at line 314 of file ScopHelper.h.

References I.

Referenced by getOrdering(), getPointerOperand(), getValueOperand(), isSimple(), isUnordered(), and isVolatile().

◆ isMemSetInst()

bool polly::MemAccInst::isMemSetInst ( ) const

inline

Definition at line 315 of file ScopHelper.h.

References I.

◆ isMemTransferInst()

bool polly::MemAccInst::isMemTransferInst ( ) const

inline

Definition at line 316 of file ScopHelper.h.

References I.

◆ isNull()

bool polly::MemAccInst::isNull ( ) const

inline

Definition at line 306 of file ScopHelper.h.

References I.

Referenced by polly::BlockGenerator::generateLocationAccessed(), and operator!().

◆ isSimple()

bool polly::MemAccInst::isSimple ( ) const

inline

Definition at line 271 of file ScopHelper.h.

References asLoad(), asMemIntrinsic(), asStore(), isCallInst(), isLoad(), isMemIntrinsic(), and isStore().

◆ isStore()

bool polly::MemAccInst::isStore ( ) const

inline

Definition at line 312 of file ScopHelper.h.

References I.

Referenced by polly::ScopBuilder::buildAccessMultiDimFixed(), polly::ScopBuilder::buildAccessMultiDimParam(), polly::ScopBuilder::buildAccessSingleDim(), getOrdering(), getPointerOperand(), getValueOperand(), isSimple(), isUnordered(), and isVolatile().

◆ isUnordered()

bool polly::MemAccInst::isUnordered ( ) const

inline

Definition at line 293 of file ScopHelper.h.

References asLoad(), asMemIntrinsic(), asStore(), isCallInst(), isLoad(), isMemIntrinsic(), and isStore().

◆ isVolatile()

bool polly::MemAccInst::isVolatile ( ) const

inline

Definition at line 260 of file ScopHelper.h.

References asLoad(), asMemIntrinsic(), asStore(), isCallInst(), isLoad(), isMemIntrinsic(), and isStore().

◆ operator bool()

polly::MemAccInst::operator bool ( ) const

inlineexplicit

Definition at line 235 of file ScopHelper.h.

References isInstruction().

◆ operator llvm::Instruction *()

polly::MemAccInst::operator llvm::Instruction * ( ) const

inline

Definition at line 232 of file ScopHelper.h.

References asInstruction().

◆ operator!()

bool polly::MemAccInst::operator! ( ) const

inline

Definition at line 236 of file ScopHelper.h.

References isNull().

◆ operator->()

llvm::Instruction * polly::MemAccInst::operator-> ( ) const

inline

Definition at line 233 of file ScopHelper.h.

References get().

◆ operator=() [1/9]

MemAccInst & polly::MemAccInst::operator= ( const MemAccInst & Inst )

inline

Definition at line 191 of file ScopHelper.h.

References I, and MemAccInst().

◆ operator=() [2/9]

MemAccInst & polly::MemAccInst::operator= ( llvm::CallInst & CI )

inline

Definition at line 219 of file ScopHelper.h.

References I, and MemAccInst().

◆ operator=() [3/9]

MemAccInst & polly::MemAccInst::operator= ( llvm::CallInst * CI )

inline

Definition at line 223 of file ScopHelper.h.

References I, and MemAccInst().

◆ operator=() [4/9]

MemAccInst & polly::MemAccInst::operator= ( llvm::LoadInst & LI )

inline

Definition at line 195 of file ScopHelper.h.

References I, and MemAccInst().

◆ operator=() [5/9]

MemAccInst & polly::MemAccInst::operator= ( llvm::LoadInst * LI )

inline

Definition at line 199 of file ScopHelper.h.

References I, and MemAccInst().

◆ operator=() [6/9]

MemAccInst & polly::MemAccInst::operator= ( llvm::MemIntrinsic & MI )

inline

Definition at line 211 of file ScopHelper.h.

References I, and MemAccInst().

◆ operator=() [7/9]

MemAccInst & polly::MemAccInst::operator= ( llvm::MemIntrinsic * MI )

inline

Definition at line 215 of file ScopHelper.h.

References I, and MemAccInst().

◆ operator=() [8/9]

MemAccInst & polly::MemAccInst::operator= ( llvm::StoreInst & SI )

inline

Definition at line 203 of file ScopHelper.h.

References I, and MemAccInst().

◆ operator=() [9/9]

MemAccInst & polly::MemAccInst::operator= ( llvm::StoreInst * SI )

inline

Definition at line 207 of file ScopHelper.h.

References I, and MemAccInst().

Member Data Documentation

◆ I

llvm::Instruction* polly::MemAccInst::I

private

Definition at line 143 of file ScopHelper.h.

Referenced by asCallInst(), asInstruction(), asLoad(), asMemIntrinsic(), asMemSetInst(), asMemTransferInst(), asStore(), get(), isCallInst(), isInstruction(), isLoad(), isMemIntrinsic(), isMemSetInst(), isMemTransferInst(), isNull(), isStore(), MemAccInst(), MemAccInst(), MemAccInst(), MemAccInst(), MemAccInst(), MemAccInst(), MemAccInst(), MemAccInst(), MemAccInst(), MemAccInst(), operator=(), operator=(), operator=(), operator=(), operator=(), operator=(), operator=(), operator=(), and operator=().

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

ScopHelper.h

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MemAccInst() [1/10]

◆ MemAccInst() [2/10]

◆ MemAccInst() [3/10]

◆ MemAccInst() [4/10]

◆ MemAccInst() [5/10]

◆ MemAccInst() [6/10]

◆ MemAccInst() [7/10]

◆ MemAccInst() [8/10]

◆ MemAccInst() [9/10]

◆ MemAccInst() [10/10]

Member Function Documentation

◆ asCallInst()

◆ asInstruction()

◆ asLoad()

◆ asMemIntrinsic()

◆ asMemSetInst()

◆ asMemTransferInst()

◆ asStore()

◆ cast() [1/2]

◆ cast() [2/2]

◆ cast_or_null() [1/2]

◆ cast_or_null() [2/2]

◆ dyn_cast() [1/2]

◆ dyn_cast() [2/2]

◆ get()

◆ getOrdering()

◆ getPointerOperand()

◆ getValueOperand()

◆ isa() [1/2]

◆ isa() [2/2]

◆ isCallInst()

◆ isInstruction()

◆ isLoad()

◆ isMemIntrinsic()

◆ isMemSetInst()

◆ isMemTransferInst()

◆ isNull()

◆ isSimple()

◆ isStore()

◆ isUnordered()

◆ isVolatile()

◆ operator bool()

◆ operator llvm::Instruction *()

◆ operator!()

◆ operator->()

◆ operator=() [1/9]

◆ operator=() [2/9]

◆ operator=() [3/9]

◆ operator=() [4/9]

◆ operator=() [5/9]

◆ operator=() [6/9]

◆ operator=() [7/9]

◆ operator=() [8/9]

◆ operator=() [9/9]

Member Data Documentation

◆ I