LLVM API Documentation

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
llvm::StoreInst Class Reference

#include <Instructions.h>

Inheritance diagram for llvm::StoreInst:
Inheritance graph
[legend]
Collaboration diagram for llvm::StoreInst:
Collaboration graph
[legend]

Public Member Functions

void * operator new (size_t s)
 
 StoreInst (Value *Val, Value *Ptr, Instruction *InsertBefore)
 
 StoreInst (Value *Val, Value *Ptr, BasicBlock *InsertAtEnd)
 
 StoreInst (Value *Val, Value *Ptr, bool isVolatile=false, Instruction *InsertBefore=0)
 
 StoreInst (Value *Val, Value *Ptr, bool isVolatile, BasicBlock *InsertAtEnd)
 
 StoreInst (Value *Val, Value *Ptr, bool isVolatile, unsigned Align, Instruction *InsertBefore=0)
 
 StoreInst (Value *Val, Value *Ptr, bool isVolatile, unsigned Align, BasicBlock *InsertAtEnd)
 
 StoreInst (Value *Val, Value *Ptr, bool isVolatile, unsigned Align, AtomicOrdering Order, SynchronizationScope SynchScope=CrossThread, Instruction *InsertBefore=0)
 
 StoreInst (Value *Val, Value *Ptr, bool isVolatile, unsigned Align, AtomicOrdering Order, SynchronizationScope SynchScope, BasicBlock *InsertAtEnd)
 
bool isVolatile () const
 
void setVolatile (bool V)
 
 DECLARE_TRANSPARENT_OPERAND_ACCESSORS (Value)
 Transparently provide more efficient getOperand methods. More...
 
unsigned getAlignment () const
 
void setAlignment (unsigned Align)
 
AtomicOrdering getOrdering () const
 Returns the ordering effect of this store. More...
 
void setOrdering (AtomicOrdering Ordering)
 
SynchronizationScope getSynchScope () const
 
void setSynchScope (SynchronizationScope xthread)
 
bool isAtomic () const
 
void setAtomic (AtomicOrdering Ordering, SynchronizationScope SynchScope=CrossThread)
 
bool isSimple () const
 
bool isUnordered () const
 
ValuegetValueOperand ()
 
const ValuegetValueOperand () const
 
ValuegetPointerOperand ()
 
const ValuegetPointerOperand () const
 
unsigned getPointerAddressSpace () const
 Returns the address space of the pointer operand. More...
 
- Public Member Functions inherited from llvm::Instruction
 ~Instruction ()
 
Instructionuse_back ()
 
const Instructionuse_back () const
 
const BasicBlockgetParent () const
 
BasicBlockgetParent ()
 
void removeFromParent ()
 
void eraseFromParent ()
 
void insertBefore (Instruction *InsertPos)
 
void insertAfter (Instruction *InsertPos)
 
void moveBefore (Instruction *MovePos)
 
unsigned getOpcode () const
 getOpcode() returns a member of one of the enums like Instruction::Add. More...
 
const char * getOpcodeName () const
 
bool isTerminator () const
 
bool isBinaryOp () const
 
bool isShift ()
 
bool isCast () const
 
bool isLogicalShift () const
 
bool isArithmeticShift () const
 isArithmeticShift - Return true if this is an arithmetic shift right. More...
 
bool hasMetadata () const
 
bool hasMetadataOtherThanDebugLoc () const
 
MDNodegetMetadata (unsigned KindID) const
 
MDNodegetMetadata (StringRef Kind) const
 
void getAllMetadata (SmallVectorImpl< std::pair< unsigned, MDNode * > > &MDs) const
 
void getAllMetadataOtherThanDebugLoc (SmallVectorImpl< std::pair< unsigned, MDNode * > > &MDs) const
 
void setMetadata (unsigned KindID, MDNode *Node)
 
void setMetadata (StringRef Kind, MDNode *Node)
 
void setDebugLoc (const DebugLoc &Loc)
 setDebugLoc - Set the debug location information for this instruction. More...
 
const DebugLocgetDebugLoc () const
 getDebugLoc - Return the debug location for this node as a DebugLoc. More...
 
void setHasUnsafeAlgebra (bool B)
 
void setHasNoNaNs (bool B)
 
void setHasNoInfs (bool B)
 
void setHasNoSignedZeros (bool B)
 
void setHasAllowReciprocal (bool B)
 
void setFastMathFlags (FastMathFlags FMF)
 
bool hasUnsafeAlgebra () const
 Determine whether the unsafe-algebra flag is set. More...
 
bool hasNoNaNs () const
 Determine whether the no-NaNs flag is set. More...
 
bool hasNoInfs () const
 Determine whether the no-infs flag is set. More...
 
bool hasNoSignedZeros () const
 Determine whether the no-signed-zeros flag is set. More...
 
bool hasAllowReciprocal () const
 Determine whether the allow-reciprocal flag is set. More...
 
FastMathFlags getFastMathFlags () const
 
void copyFastMathFlags (const Instruction *I)
 Copy I's fast-math flags. More...
 
bool isAssociative () const
 
bool isCommutative () const
 
bool isIdempotent () const
 
bool isNilpotent () const
 
bool mayWriteToMemory () const
 
bool mayReadFromMemory () const
 
bool mayReadOrWriteMemory () const
 
bool mayThrow () const
 
bool mayReturn () const
 
bool mayHaveSideEffects () const
 
Instructionclone () const
 
bool isIdenticalTo (const Instruction *I) const
 
bool isIdenticalToWhenDefined (const Instruction *I) const
 
bool isSameOperationAs (const Instruction *I, unsigned flags=0) const
 Determine if one instruction is the same operation as another. More...
 
bool isUsedOutsideOfBlock (const BasicBlock *BB) const
 
- Public Member Functions inherited from llvm::User
 ~User ()
 
void operator delete (void *Usr)
 operator delete - free memory allocated for User and Use objects More...
 
void operator delete (void *, unsigned)
 placement delete - required by std, but never called. More...
 
void operator delete (void *, unsigned, bool)
 placement delete - required by std, but never called. More...
 
ValuegetOperand (unsigned i) const
 
void setOperand (unsigned i, Value *Val)
 
const UsegetOperandUse (unsigned i) const
 
UsegetOperandUse (unsigned i)
 
unsigned getNumOperands () const
 
op_iterator op_begin ()
 
const_op_iterator op_begin () const
 
op_iterator op_end ()
 
const_op_iterator op_end () const
 
value_op_iterator value_op_begin ()
 
value_op_iterator value_op_end ()
 
void dropAllReferences ()
 
void replaceUsesOfWith (Value *From, Value *To)
 
- Public Member Functions inherited from llvm::Value
virtual ~Value ()
 
void dump () const
 dump - Support for debugging, callable in GDB: V->dump() More...
 
void print (raw_ostream &O, AssemblyAnnotationWriter *AAW=0) const
 
TypegetType () const
 
LLVMContextgetContext () const
 All values hold a context through their type. More...
 
bool hasName () const
 
ValueNamegetValueName () const
 
void setValueName (ValueName *VN)
 
StringRef getName () const
 
void setName (const Twine &Name)
 
void takeName (Value *V)
 
void replaceAllUsesWith (Value *V)
 
bool use_empty () const
 
use_iterator use_begin ()
 
const_use_iterator use_begin () const
 
use_iterator use_end ()
 
const_use_iterator use_end () const
 
Useruse_back ()
 
const Useruse_back () const
 
bool hasOneUse () const
 
bool hasNUses (unsigned N) const
 
bool hasNUsesOrMore (unsigned N) const
 
bool isUsedInBasicBlock (const BasicBlock *BB) const
 
unsigned getNumUses () const
 
void addUse (Use &U)
 
unsigned getValueID () const
 
unsigned getRawSubclassOptionalData () const
 
void clearSubclassOptionalData ()
 
bool hasSameSubclassOptionalData (const Value *V) const
 
void intersectOptionalDataWith (const Value *V)
 
bool hasValueHandle () const
 
ValuestripPointerCasts ()
 Strips off any unneeded pointer casts, all-zero GEPs and aliases from the specified value, returning the original uncasted value. More...
 
const ValuestripPointerCasts () const
 
ValuestripPointerCastsNoFollowAliases ()
 Strips off any unneeded pointer casts and all-zero GEPs from the specified value, returning the original uncasted value. More...
 
const ValuestripPointerCastsNoFollowAliases () const
 
ValuestripInBoundsConstantOffsets ()
 Strips off unneeded pointer casts and all-constant GEPs from the specified value, returning the original pointer value. More...
 
const ValuestripInBoundsConstantOffsets () const
 
ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset)
 Strips like stripInBoundsConstantOffsets but also accumulates the constant offset stripped. More...
 
const ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const
 
ValuestripInBoundsOffsets ()
 Strips off unneeded pointer casts and any in-bounds offsets from the specified value, returning the original pointer value. More...
 
const ValuestripInBoundsOffsets () const
 
bool isDereferenceablePointer () const
 
ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB)
 
const ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB) const
 
void mutateType (Type *Ty)
 
- Public Member Functions inherited from llvm::ilist_node< Instruction >
InstructiongetPrevNode ()
 Get the previous node, or 0 for the list head. More...
 
const InstructiongetPrevNode () const
 Get the previous node, or 0 for the list head. More...
 
InstructiongetNextNode ()
 Get the next node, or 0 for the list tail. More...
 
const InstructiongetNextNode () const
 Get the next node, or 0 for the list tail. More...
 

Static Public Member Functions

static unsigned getPointerOperandIndex ()
 
static bool classof (const Instruction *I)
 
static bool classof (const Value *V)
 
- Static Public Member Functions inherited from llvm::Instruction
static const char * getOpcodeName (unsigned OpCode)
 
static bool isTerminator (unsigned OpCode)
 
static bool isBinaryOp (unsigned Opcode)
 
static bool isShift (unsigned Opcode)
 Determine if the Opcode is one of the shift instructions. More...
 
static bool isCast (unsigned OpCode)
 Determine if the OpCode is one of the CastInst instructions. More...
 
static bool isAssociative (unsigned op)
 
static bool isCommutative (unsigned op)
 
static bool isIdempotent (unsigned op)
 
static bool isNilpotent (unsigned op)
 
static bool classof (const Value *V)
 Methods for support type inquiry through isa, cast, and dyn_cast: More...
 
- Static Public Member Functions inherited from llvm::User
static bool classof (const Value *V)
 

Protected Member Functions

virtual StoreInstclone_impl () const
 
- Protected Member Functions inherited from llvm::Instruction
void setInstructionSubclassData (unsigned short D)
 
unsigned getSubclassDataFromInstruction () const
 
 Instruction (Type *Ty, unsigned iType, Use *Ops, unsigned NumOps, Instruction *InsertBefore=0)
 
 Instruction (Type *Ty, unsigned iType, Use *Ops, unsigned NumOps, BasicBlock *InsertAtEnd)
 
- Protected Member Functions inherited from llvm::User
void * operator new (size_t s, unsigned Us)
 
 User (Type *ty, unsigned vty, Use *OpList, unsigned NumOps)
 
UseallocHungoffUses (unsigned) const
 
void dropHungoffUses ()
 
template<int Idx>
UseOp ()
 
template<int Idx>
const UseOp () const
 
- Protected Member Functions inherited from llvm::Value
virtual void printCustom (raw_ostream &O) const
 
 Value (Type *Ty, unsigned scid)
 
unsigned short getSubclassDataFromValue () const
 
void setValueSubclassData (unsigned short D)
 
- Protected Member Functions inherited from llvm::ilist_node< Instruction >
 ilist_node ()
 

Additional Inherited Members

- Public Types inherited from llvm::Instruction
enum  OperationEquivalenceFlags { CompareIgnoringAlignment = 1<<0, CompareUsingScalarTypes = 1<<1 }
 
enum  TermOps
 
enum  BinaryOps
 
enum  MemoryOps
 
enum  CastOps
 
enum  OtherOps
 
- Public Types inherited from llvm::User
typedef Useop_iterator
 
typedef const Useconst_op_iterator
 
- Public Types inherited from llvm::Value
enum  ValueTy {
  ArgumentVal, BasicBlockVal, FunctionVal, GlobalAliasVal,
  GlobalVariableVal, UndefValueVal, BlockAddressVal, ConstantExprVal,
  ConstantAggregateZeroVal, ConstantDataArrayVal, ConstantDataVectorVal, ConstantIntVal,
  ConstantFPVal, ConstantArrayVal, ConstantStructVal, ConstantVectorVal,
  ConstantPointerNullVal, MDNodeVal, MDStringVal, InlineAsmVal,
  PseudoSourceValueVal, FixedStackPseudoSourceValueVal, InstructionVal, ConstantFirstVal = FunctionVal,
  ConstantLastVal = ConstantPointerNullVal
}
 
typedef value_use_iterator< Useruse_iterator
 
typedef value_use_iterator
< const User
const_use_iterator
 
- Static Public Attributes inherited from llvm::Value
static const unsigned MaximumAlignment = 1u << 29
 
- Static Protected Member Functions inherited from llvm::User
template<int Idx, typename U >
static UseOpFrom (const U *that)
 
- Protected Attributes inherited from llvm::User
UseOperandList
 
unsigned NumOperands
 
- Protected Attributes inherited from llvm::Value
unsigned char SubclassOptionalData: 7
 

Detailed Description

StoreInst - an instruction for storing to memory

Definition at line 255 of file Instructions.h.

Constructor & Destructor Documentation

StoreInst::StoreInst ( Value Val,
Value Ptr,
Instruction InsertBefore 
)

Definition at line 1090 of file Instructions.cpp.

References llvm::NotAtomic, setAlignment(), setAtomic(), and setVolatile().

Referenced by clone_impl().

StoreInst::StoreInst ( Value Val,
Value Ptr,
BasicBlock InsertAtEnd 
)

Definition at line 1103 of file Instructions.cpp.

References llvm::NotAtomic, setAlignment(), setAtomic(), and setVolatile().

StoreInst::StoreInst ( Value Val,
Value Ptr,
bool  isVolatile = false,
Instruction InsertBefore = 0 
)

Definition at line 1116 of file Instructions.cpp.

References llvm::NotAtomic, setAlignment(), setAtomic(), and setVolatile().

StoreInst::StoreInst ( Value Val,
Value Ptr,
bool  isVolatile,
BasicBlock InsertAtEnd 
)

Definition at line 1160 of file Instructions.cpp.

References llvm::NotAtomic, setAlignment(), setAtomic(), and setVolatile().

StoreInst::StoreInst ( Value Val,
Value Ptr,
bool  isVolatile,
unsigned  Align,
Instruction InsertBefore = 0 
)

Definition at line 1130 of file Instructions.cpp.

References llvm::NotAtomic, setAlignment(), setAtomic(), and setVolatile().

StoreInst::StoreInst ( Value Val,
Value Ptr,
bool  isVolatile,
unsigned  Align,
BasicBlock InsertAtEnd 
)

Definition at line 1174 of file Instructions.cpp.

References llvm::NotAtomic, setAlignment(), setAtomic(), and setVolatile().

StoreInst::StoreInst ( Value Val,
Value Ptr,
bool  isVolatile,
unsigned  Align,
AtomicOrdering  Order,
SynchronizationScope  SynchScope = CrossThread,
Instruction InsertBefore = 0 
)

Definition at line 1144 of file Instructions.cpp.

References setAlignment(), setAtomic(), and setVolatile().

StoreInst::StoreInst ( Value Val,
Value Ptr,
bool  isVolatile,
unsigned  Align,
AtomicOrdering  Order,
SynchronizationScope  SynchScope,
BasicBlock InsertAtEnd 
)

Definition at line 1188 of file Instructions.cpp.

References setAlignment(), setAtomic(), and setVolatile().

Member Function Documentation

static bool llvm::StoreInst::classof ( const Instruction I)
inlinestatic

Definition at line 356 of file Instructions.h.

References llvm::Instruction::getOpcode(), and llvm::SPII::Store.

Referenced by classof().

static bool llvm::StoreInst::classof ( const Value V)
inlinestatic

Definition at line 359 of file Instructions.h.

References classof().

StoreInst * StoreInst::clone_impl ( ) const
protectedvirtual
llvm::StoreInst::DECLARE_TRANSPARENT_OPERAND_ACCESSORS ( Value  )

Transparently provide more efficient getOperand methods.

unsigned llvm::StoreInst::getAlignment ( ) const
inline

getAlignment - Return the alignment of the access that is being performed

Definition at line 301 of file Instructions.h.

References llvm::Instruction::getSubclassDataFromInstruction().

Referenced by clone_impl(), setAlignment(), and llvm::InstCombiner::visitStoreInst().

AtomicOrdering llvm::StoreInst::getOrdering ( ) const
inline

Returns the ordering effect of this store.

Definition at line 308 of file Instructions.h.

References llvm::Instruction::getSubclassDataFromInstruction().

Referenced by llvm::AliasSetTracker::add(), clone_impl(), isAtomic(), and isUnordered().

unsigned llvm::StoreInst::getPointerAddressSpace ( ) const
inline

Returns the address space of the pointer operand.

Definition at line 351 of file Instructions.h.

References llvm::Type::getPointerAddressSpace(), getPointerOperand(), and llvm::Value::getType().

Referenced by llvm::InstCombiner::visitStoreInst().

Value* llvm::StoreInst::getPointerOperand ( )
inline
const Value* llvm::StoreInst::getPointerOperand ( ) const
inline

Definition at line 347 of file Instructions.h.

References llvm::User::getOperand().

static unsigned llvm::StoreInst::getPointerOperandIndex ( )
inlinestatic

Definition at line 348 of file Instructions.h.

SynchronizationScope llvm::StoreInst::getSynchScope ( ) const
inline

Definition at line 319 of file Instructions.h.

References llvm::Instruction::getSubclassDataFromInstruction().

Referenced by clone_impl().

Value* llvm::StoreInst::getValueOperand ( )
inline
const Value* llvm::StoreInst::getValueOperand ( ) const
inline

Definition at line 344 of file Instructions.h.

References llvm::User::getOperand().

bool llvm::StoreInst::isAtomic ( ) const
inline

Definition at line 331 of file Instructions.h.

References getOrdering(), and llvm::NotAtomic.

Referenced by isSimple().

bool llvm::StoreInst::isSimple ( ) const
inline

Definition at line 338 of file Instructions.h.

References isAtomic(), and isVolatile().

Referenced by isSafeToSpeculateStore(), and llvm::InstCombiner::visitStoreInst().

bool llvm::StoreInst::isUnordered ( ) const
inline

Definition at line 339 of file Instructions.h.

References getOrdering(), isVolatile(), and llvm::Unordered.

Referenced by llvm::AliasAnalysis::getModRefInfo().

bool llvm::StoreInst::isVolatile ( ) const
inline
void* llvm::StoreInst::operator new ( size_t  s)
inline

Definition at line 262 of file Instructions.h.

void StoreInst::setAlignment ( unsigned  Align)
void llvm::StoreInst::setAtomic ( AtomicOrdering  Ordering,
SynchronizationScope  SynchScope = CrossThread 
)
inline

Definition at line 332 of file Instructions.h.

References setOrdering(), and setSynchScope().

Referenced by LowerStoreInst(), and StoreInst().

void llvm::StoreInst::setOrdering ( AtomicOrdering  Ordering)
inline

Set the ordering constraint on this store. May not be Acquire or AcquireRelease.

Definition at line 314 of file Instructions.h.

References llvm::Instruction::getSubclassDataFromInstruction().

Referenced by setAtomic().

void llvm::StoreInst::setSynchScope ( SynchronizationScope  xthread)
inline

Specify whether this store instruction is ordered with respect to all concurrently executing threads, or only with respect to signal handlers executing in the same thread.

Definition at line 326 of file Instructions.h.

References llvm::Instruction::getSubclassDataFromInstruction().

Referenced by setAtomic().

void llvm::StoreInst::setVolatile ( bool  V)
inline

setVolatile - Specify whether this is a volatile store or not.

Definition at line 291 of file Instructions.h.

References llvm::Instruction::getSubclassDataFromInstruction().

Referenced by StoreInst().


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