LLVM  3.7.0
Public Member Functions | Static Public Member Functions | Friends | List of all members
llvm::GEPOperator Class Reference

#include <Operator.h>

Inheritance diagram for llvm::GEPOperator:
[legend]
Collaboration diagram for llvm::GEPOperator:
[legend]

Public Member Functions

bool isInBounds () const
 Test whether this is an inbounds GEP, as defined by LangRef.html. More...
 
op_iterator idx_begin ()
 
const_op_iterator idx_begin () const
 
op_iterator idx_end ()
 
const_op_iterator idx_end () const
 
ValuegetPointerOperand ()
 
const ValuegetPointerOperand () const
 
TypegetPointerOperandType () const
 Method to return the pointer operand as a PointerType. More...
 
TypegetSourceElementType () const
 
unsigned getPointerAddressSpace () const
 Method to return the address space of the pointer operand. More...
 
unsigned getNumIndices () const
 
bool hasIndices () const
 
bool hasAllZeroIndices () const
 Return true if all of the indices of this GEP are zeros. More...
 
bool hasAllConstantIndices () const
 Return true if all of the indices of this GEP are constant integers. More...
 
bool accumulateConstantOffset (const DataLayout &DL, APInt &Offset) const
 Accumulate the constant address offset of this GEP if possible. More...
 
- Public Member Functions inherited from llvm::Operator
unsigned getOpcode () const
 Return the opcode for this Instruction or ConstantExpr. More...
 
- Public Member Functions inherited from llvm::User
 ~User () override
 
void operator delete (void *Usr)
 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...
 
UsegetOperandList ()
 
const UsegetOperandList () const
 
ValuegetOperand (unsigned i) const
 
void setOperand (unsigned i, Value *Val)
 
const UsegetOperandUse (unsigned i) const
 
UsegetOperandUse (unsigned i)
 
unsigned getNumOperands () const
 
void setGlobalVariableNumOperands (unsigned NumOps)
 Set the number of operands on a GlobalVariable. More...
 
void setFunctionNumOperands (unsigned NumOps)
 Set the number of operands on a Function. More...
 
void setNumHungOffUseOperands (unsigned NumOps)
 Subclasses with hung off uses need to manage the operand count themselves. More...
 
op_iterator op_begin ()
 
const_op_iterator op_begin () const
 
op_iterator op_end ()
 
const_op_iterator op_end () const
 
op_range operands ()
 
const_op_range operands () const
 
value_op_iterator value_op_begin ()
 
value_op_iterator value_op_end ()
 
iterator_range< value_op_iteratoroperand_values ()
 
void dropAllReferences ()
 Drop all references to operands. More...
 
void replaceUsesOfWith (Value *From, Value *To)
 Replace uses of one Value with another. More...
 
- Public Member Functions inherited from llvm::Value
virtual ~Value ()
 
void dump () const
 Support for debugging, callable in GDB: V->dump() More...
 
TypegetType () const
 All values are typed, get the type of this value. More...
 
LLVMContextgetContext () const
 All values hold a context through their type. More...
 
bool hasName () const
 
ValueNamegetValueName () const
 
void setValueName (ValueName *VN)
 
StringRef getName () const
 Return a constant reference to the value's name. More...
 
void setName (const Twine &Name)
 Change the name of the value. More...
 
void takeName (Value *V)
 Transfer the name from V to this value. More...
 
void replaceAllUsesWith (Value *V)
 Change all uses of this to point to a new Value. More...
 
void replaceUsesOutsideBlock (Value *V, BasicBlock *BB)
 replaceUsesOutsideBlock - Go through the uses list for this definition and make each use point to "V" instead of "this" when the use is outside the block. More...
 
bool use_empty () const
 
use_iterator use_begin ()
 
const_use_iterator use_begin () const
 
use_iterator use_end ()
 
const_use_iterator use_end () const
 
iterator_range< use_iteratoruses ()
 
iterator_range
< const_use_iterator
uses () const
 
bool user_empty () const
 
user_iterator user_begin ()
 
const_user_iterator user_begin () const
 
user_iterator user_end ()
 
const_user_iterator user_end () const
 
Useruser_back ()
 
const Useruser_back () const
 
iterator_range< user_iteratorusers ()
 
iterator_range
< const_user_iterator
users () const
 
bool hasOneUse () const
 Return true if there is exactly one user of this value. More...
 
bool hasNUses (unsigned N) const
 Return true if this Value has exactly N users. More...
 
bool hasNUsesOrMore (unsigned N) const
 Return true if this value has N users or more. More...
 
bool isUsedInBasicBlock (const BasicBlock *BB) const
 Check if this value is used in the specified basic block. More...
 
unsigned getNumUses () const
 This method computes the number of uses of this Value. More...
 
void addUse (Use &U)
 This method should only be used by the Use class. More...
 
unsigned getValueID () const
 Return an ID for the concrete type of this object. More...
 
unsigned getRawSubclassOptionalData () const
 Return the raw optional flags value contained in this value. More...
 
void clearSubclassOptionalData ()
 Clear the optional flags contained in this value. More...
 
bool hasSameSubclassOptionalData (const Value *V) const
 Check the optional flags for equality. More...
 
void intersectOptionalDataWith (const Value *V)
 Clear any optional flags not set in the given Value. More...
 
bool hasValueHandle () const
 Return true if there is a value handle associated with this value. More...
 
bool isUsedByMetadata () const
 Return true if there is metadata referencing this value. More...
 
ValuestripPointerCasts ()
 Strip off pointer casts, all-zero GEPs, and aliases. More...
 
const ValuestripPointerCasts () const
 
ValuestripPointerCastsNoFollowAliases ()
 Strip off pointer casts and all-zero GEPs. More...
 
const ValuestripPointerCastsNoFollowAliases () const
 
ValuestripInBoundsConstantOffsets ()
 Strip off pointer casts and all-constant inbounds GEPs. More...
 
const ValuestripInBoundsConstantOffsets () const
 
ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset)
 Accumulate offsets from stripInBoundsConstantOffsets(). More...
 
const ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const
 
ValuestripInBoundsOffsets ()
 Strip off pointer casts and inbounds GEPs. More...
 
const ValuestripInBoundsOffsets () const
 
ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB)
 Translate PHI node to its predecessor from the given basic block. More...
 
const ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB) const
 
void mutateType (Type *Ty)
 Mutate the type of this Value to be of the specified type. More...
 
template<class Compare >
void sortUseList (Compare Cmp)
 Sort the use-list. More...
 
void reverseUseList ()
 Reverse the use-list. More...
 
void print (raw_ostream &O) const
 Implement operator<< on Value. More...
 
void print (raw_ostream &O, ModuleSlotTracker &MST) const
 
void printAsOperand (raw_ostream &O, bool PrintType=true, const Module *M=nullptr) const
 Print the name of this Value out to the specified raw_ostream. More...
 
void printAsOperand (raw_ostream &O, bool PrintType, ModuleSlotTracker &MST) const
 

Static Public Member Functions

static unsigned getPointerOperandIndex ()
 
- Static Public Member Functions inherited from llvm::ConcreteOperator< Operator, Instruction::GetElementPtr >
static bool classof (const Instruction *I)
 
static bool classof (const ConstantExpr *CE)
 
static bool classof (const Value *V)
 
- Static Public Member Functions inherited from llvm::Operator
static unsigned getOpcode (const Value *V)
 If V is an Instruction or ConstantExpr, return its opcode. More...
 
static bool classof (const Instruction *)
 
static bool classof (const ConstantExpr *)
 
static bool classof (const Value *V)
 
- Static Public Member Functions inherited from llvm::User
static bool classof (const Value *V)
 

Friends

class GetElementPtrInst
 
class ConstantExpr
 

Additional Inherited Members

- Public Types inherited from llvm::User
typedef Useop_iterator
 
typedef const Useconst_op_iterator
 
typedef iterator_range
< op_iterator
op_range
 
typedef iterator_range
< const_op_iterator
const_op_range
 
- Public Types inherited from llvm::Value
enum  ValueTy
 Concrete subclass of this. More...
 
typedef use_iterator_impl< Useuse_iterator
 
typedef use_iterator_impl
< const Use
const_use_iterator
 
typedef user_iterator_impl< Useruser_iterator
 
typedef user_iterator_impl
< const User
const_user_iterator
 
- Static Public Attributes inherited from llvm::Value
static const unsigned MaxAlignmentExponent = 29
 The maximum alignment for instructions. More...
 
static const unsigned MaximumAlignment = 1u << MaxAlignmentExponent
 
- Protected Types inherited from llvm::Value
enum  : unsigned { NumUserOperandsBits = 29 }
 The number of operands in the subclass. More...
 
- Protected Member Functions inherited from llvm::Operator
 ~Operator () override
 
- Protected Member Functions inherited from llvm::User
void * operator new (size_t Size)
 Allocate a User with an operand pointer co-allocated. More...
 
void * operator new (size_t Size, unsigned Us)
 Allocate a User with the operands co-allocated. More...
 
 User (Type *ty, unsigned vty, Use *OpList, unsigned NumOps)
 
void allocHungoffUses (unsigned N, bool IsPhi=false)
 Allocate the array of Uses, followed by a pointer (with bottom bit set) to the User. More...
 
void growHungoffUses (unsigned N, bool IsPhi=false)
 Grow the number of hung off uses. More...
 
template<int Idx>
UseOp ()
 
template<int Idx>
const UseOp () const
 
- Protected Member Functions inherited from llvm::Value
 Value (Type *Ty, unsigned scid)
 
unsigned short getSubclassDataFromValue () const
 
void setValueSubclassData (unsigned short D)
 
- Static Protected Member Functions inherited from llvm::User
template<int Idx, typename U >
static UseOpFrom (const U *that)
 
- Protected Attributes inherited from llvm::Value
unsigned char SubclassOptionalData: 7
 Hold subclass data that can be dropped. More...
 
unsigned NumUserOperands: NumUserOperandsBits
 
bool IsUsedByMD: 1
 
bool HasName: 1
 
bool HasHungOffUses: 1
 

Detailed Description

Definition at line 364 of file Operator.h.

Member Function Documentation

bool llvm::GEPOperator::accumulateConstantOffset ( const DataLayout DL,
APInt Offset 
) const

Accumulate the constant address offset of this GEP if possible.

This routine accepts an APInt into which it will accumulate the constant offset of this GEP if the GEP is in fact constant. If the GEP is not all-constant, it returns false and the value of the offset APInt is undefined (it is not preserved!). The APInt passed into this routine must be at exactly as wide as the IntPtr type for the address space of the base GEP pointer.

Definition at line 15 of file Operator.cpp.

References llvm::dyn_cast(), llvm::gep_type_begin(), llvm::gep_type_end(), llvm::APInt::getBitWidth(), llvm::StructLayout::getElementOffset(), getPointerAddressSpace(), llvm::DataLayout::getPointerSizeInBits(), llvm::DataLayout::getStructLayout(), llvm::DataLayout::getTypeAllocSize(), llvm::ConstantInt::getValue(), llvm::ConstantInt::getZExtValue(), llvm::ConstantInt::isZero(), and llvm::APInt::sextOrTrunc().

Referenced by IsConstantOffsetFromGlobal(), and llvm::ObjectSizeOffsetVisitor::visitGEPOperator().

unsigned llvm::GEPOperator::getNumIndices ( ) const
inline

Definition at line 410 of file Operator.h.

References llvm::User::getNumOperands().

Referenced by aliasSameBasePointerGEPs().

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

Method to return the address space of the pointer operand.

Definition at line 406 of file Operator.h.

Referenced by accumulateConstantOffset(), DecomposeGEPExpression(), and isGEPKnownNonNull().

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

Definition at line 391 of file Operator.h.

References llvm::User::getOperand().

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

Definition at line 394 of file Operator.h.

Type* llvm::GEPOperator::getPointerOperandType ( ) const
inline

Method to return the pointer operand as a PointerType.

Definition at line 399 of file Operator.h.

References getPointerOperand().

Referenced by llvm::DependenceAnalysis::depends(), and llvm::DependenceAnalysis::getSplitIteration().

Type * llvm::GEPOperator::getSourceElementType ( ) const

Definition at line 9 of file Operator.cpp.

References I.

Referenced by aliasSameBasePointerGEPs(), and llvm::ConstantFoldCastInstruction().

bool llvm::GEPOperator::hasAllConstantIndices ( ) const
inline

Return true if all of the indices of this GEP are constant integers.

If so, the result pointer and the first operand have a constant offset between them.

Definition at line 434 of file Operator.h.

References I.

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

bool llvm::GEPOperator::hasAllZeroIndices ( ) const
inline

Return true if all of the indices of this GEP are zeros.

If so, the result pointer and the first operand have the same value, just potentially different types.

Definition at line 421 of file Operator.h.

References llvm::C, and I.

Referenced by evaluateICmpRelation(), llvm::InstCombiner::FoldGEPICmp(), and shouldMergeGEPs().

bool llvm::GEPOperator::hasIndices ( ) const
inline

Definition at line 414 of file Operator.h.

References llvm::User::getNumOperands().

op_iterator llvm::GEPOperator::idx_begin ( )
inline
const_op_iterator llvm::GEPOperator::idx_begin ( ) const
inline

Definition at line 384 of file Operator.h.

References llvm::User::op_begin().

op_iterator llvm::GEPOperator::idx_end ( )
inline
const_op_iterator llvm::GEPOperator::idx_end ( ) const
inline

Definition at line 386 of file Operator.h.

References llvm::User::op_end().

bool llvm::GEPOperator::isInBounds ( ) const
inline

Test whether this is an inbounds GEP, as defined by LangRef.html.

Definition at line 379 of file Operator.h.

References llvm::Value::SubclassOptionalData.

Referenced by llvm::EmitGEPOffset(), llvm::InstCombiner::FoldGEPICmp(), and isGEPKnownNonNull().

Friends And Related Function Documentation

friend class ConstantExpr
friend

Definition at line 371 of file Operator.h.

friend class GetElementPtrInst
friend

Definition at line 370 of file Operator.h.


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