LLVM API Documentation

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

#include <Operator.h>

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

Public Member Functions

bool isInBounds () const
 
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
 
unsigned getPointerAddressSpace () const
 
unsigned getNumIndices () const
 
bool hasIndices () const
 
bool hasAllZeroIndices () const
 
bool hasAllConstantIndices () const
 
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
 
- 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)
 

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)
 
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
 
- 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
 
- Protected Member Functions inherited from llvm::Operator
 ~Operator ()
 
- 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)
 
- 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

Definition at line 357 of file Operator.h.

Member Function Documentation

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

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 444 of file Operator.h.

References llvm::dyn_cast(), llvm::gep_type_begin(), llvm::gep_type_end(), llvm::APInt::getBitWidth(), llvm::StructLayout::getElementOffset(), 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 404 of file Operator.h.

References llvm::User::getNumOperands().

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

getPointerAddressSpace - Method to return the address space of the pointer operand.

Definition at line 400 of file Operator.h.

Referenced by DecomposeGEPExpression(), and isGEPKnownNonNull().

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

Definition at line 385 of file Operator.h.

References llvm::User::getOperand().

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

Definition at line 388 of file Operator.h.

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

getPointerOperandType - Method to return the pointer operand as a PointerType.

Definition at line 394 of file Operator.h.

References getPointerOperand().

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

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

hasAllConstantIndices - 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 428 of file Operator.h.

References I.

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

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

hasAllZeroIndices - 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 415 of file Operator.h.

References llvm::CallingConv::C, and I.

Referenced by DecomposeGEPExpression(), and shouldMergeGEPs().

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

Definition at line 408 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 378 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 380 of file Operator.h.

References llvm::User::op_end().

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

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

Definition at line 373 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 364 of file Operator.h.

friend class GetElementPtrInst
friend

Definition at line 363 of file Operator.h.


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