polly::MemAccInst Class Reference

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 te 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 140 of file ScopHelper.h.

Constructor & Destructor Documentation

MemAccInst() [1/10]

polly::MemAccInst::MemAccInst ( )

inline

Definition at line 145 of file ScopHelper.h.

Referenced by cast(), cast_or_null(), and dyn_cast().

MemAccInst() [2/10]

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

inline

Definition at line 146 of file ScopHelper.h.

MemAccInst() [3/10]

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

inline

Definition at line 147 of file ScopHelper.h.

MemAccInst() [4/10]

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

inline

Definition at line 148 of file ScopHelper.h.

MemAccInst() [5/10]

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

inline

Definition at line 149 of file ScopHelper.h.

MemAccInst() [6/10]

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

inline

Definition at line 150 of file ScopHelper.h.

MemAccInst() [7/10]

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

inline

Definition at line 151 of file ScopHelper.h.

MemAccInst() [8/10]

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

inline

Definition at line 152 of file ScopHelper.h.

MemAccInst() [9/10]

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

inlineexplicit

Definition at line 153 of file ScopHelper.h.

References assert, I, and isa().

MemAccInst() [10/10]

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

inlineexplicit

Definition at line 154 of file ScopHelper.h.

References assert, I, and isa().

Member Function Documentation

asCallInst()

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

inline

Definition at line 321 of file ScopHelper.h.

References I.

asInstruction()

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

inline

Definition at line 308 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 319 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 322 of file ScopHelper.h.

References I.

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

asMemSetInst()

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

inline

Definition at line 325 of file ScopHelper.h.

References I.

asMemTransferInst()

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

inline

Definition at line 328 of file ScopHelper.h.

References I.

asStore()

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

inline

Definition at line 320 of file ScopHelper.h.

References I.

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

cast() [1/2]

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

inlinestatic

Definition at line 164 of file ScopHelper.h.

References MemAccInst().

cast() [2/2]

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

inlinestatic

Definition at line 167 of file ScopHelper.h.

References MemAccInst().

cast_or_null() [1/2]

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

inlinestatic

Definition at line 170 of file ScopHelper.h.

References MemAccInst().

cast_or_null() [2/2]

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

inlinestatic

Definition at line 173 of file ScopHelper.h.

References MemAccInst().

dyn_cast() [1/2]

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

inlinestatic

Definition at line 178 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]

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

inlinestatic

Definition at line 183 of file ScopHelper.h.

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

get()

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

inline

Definition at line 227 of file ScopHelper.h.

References assert, and I.

Referenced by operator->().

getOrdering()

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

inline

Definition at line 281 of file ScopHelper.h.

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

getPointerOperand()

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

inline

Definition at line 248 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 237 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]

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

inlinestatic

Definition at line 156 of file ScopHelper.h.

Referenced by dyn_cast(), and MemAccInst().

isa() [2/2]

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

inlinestatic

Definition at line 160 of file ScopHelper.h.

isCallInst()

bool polly::MemAccInst::isCallInst ( ) const

inline

Definition at line 312 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 306 of file ScopHelper.h.

References I.

Referenced by operator bool().

isLoad()

bool polly::MemAccInst::isLoad ( ) const

inline

Definition at line 310 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 313 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 314 of file ScopHelper.h.

References I.

isMemTransferInst()

bool polly::MemAccInst::isMemTransferInst ( ) const

inline

Definition at line 315 of file ScopHelper.h.

References I.

isNull()

bool polly::MemAccInst::isNull ( ) const

inline

Definition at line 305 of file ScopHelper.h.

References I.

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

isSimple()

bool polly::MemAccInst::isSimple ( ) const

inline

Definition at line 270 of file ScopHelper.h.

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

isStore()

bool polly::MemAccInst::isStore ( ) 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().

isUnordered()

bool polly::MemAccInst::isUnordered ( ) const

inline

Definition at line 292 of file ScopHelper.h.

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

isVolatile()

bool polly::MemAccInst::isVolatile ( ) const

inline

Definition at line 259 of file ScopHelper.h.

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

operator bool()

polly::MemAccInst::operator bool ( ) const

inlineexplicit

Definition at line 234 of file ScopHelper.h.

References isInstruction().

operator llvm::Instruction *()

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

inline

Definition at line 231 of file ScopHelper.h.

References asInstruction().

operator!()

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

inline

Definition at line 235 of file ScopHelper.h.

References isNull().

operator->()

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

inline

Definition at line 232 of file ScopHelper.h.

References get().

operator=() [1/9]

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

inline

Definition at line 190 of file ScopHelper.h.

References I.

operator=() [2/9]

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

inline

Definition at line 218 of file ScopHelper.h.

References I.

operator=() [3/9]

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

inline

Definition at line 222 of file ScopHelper.h.

References I.

operator=() [4/9]

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

inline

Definition at line 194 of file ScopHelper.h.

References I.

operator=() [5/9]

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

inline

Definition at line 198 of file ScopHelper.h.

References I.

operator=() [6/9]

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

inline

Definition at line 210 of file ScopHelper.h.

References I.

operator=() [7/9]

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

inline

Definition at line 214 of file ScopHelper.h.

References I.

operator=() [8/9]

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

inline

Definition at line 202 of file ScopHelper.h.

References I.

operator=() [9/9]

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

inline

Definition at line 206 of file ScopHelper.h.

References I.

Member Data Documentation

I

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

private

Definition at line 142 of file ScopHelper.h.

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

---

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

• ScopHelper.h