an instruction for type-safe pointer arithmetic to access elements of arrays and structs More...
#include "llvm/IR/Instructions.h"
Public Member Functions | |
| DECLARE_TRANSPARENT_OPERAND_ACCESSORS (Value) | |
| Transparently provide more efficient getOperand methods. More... | |
| Type * | getSourceElementType () const |
| void | setSourceElementType (Type *Ty) |
| void | setResultElementType (Type *Ty) |
| Type * | getResultElementType () const |
| unsigned | getAddressSpace () const |
| Returns the address space of this instruction's pointer type. More... | |
| op_iterator | idx_begin () |
| const_op_iterator | idx_begin () const |
| op_iterator | idx_end () |
| const_op_iterator | idx_end () const |
| iterator_range< op_iterator > | indices () |
| iterator_range< const_op_iterator > | indices () const |
| Value * | getPointerOperand () |
| const Value * | getPointerOperand () const |
| Type * | getPointerOperandType () const |
| Method to return the pointer operand as a PointerType. More... | |
| unsigned | getPointerAddressSpace () const |
| Returns 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... | |
| void | setIsInBounds (bool b=true) |
| Set or clear the inbounds flag on this GEP instruction. More... | |
| bool | isInBounds () const |
| Determine whether the GEP has the inbounds flag. 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::Instruction | |
| Instruction (const Instruction &)=delete | |
| Instruction & | operator= (const Instruction &)=delete |
| Instruction * | user_back () |
| Specialize the methods defined in Value, as we know that an instruction can only be used by other instructions. More... | |
| const Instruction * | user_back () const |
| const BasicBlock * | getParent () const |
| BasicBlock * | getParent () |
| const Module * | getModule () const |
| Return the module owning the function this instruction belongs to or nullptr it the function does not have a module. More... | |
| Module * | getModule () |
| const Function * | getFunction () const |
| Return the function this instruction belongs to. More... | |
| Function * | getFunction () |
| void | removeFromParent () |
| This method unlinks 'this' from the containing basic block, but does not delete it. More... | |
| SymbolTableList< Instruction >::iterator | eraseFromParent () |
| This method unlinks 'this' from the containing basic block and deletes it. More... | |
| void | insertBefore (Instruction *InsertPos) |
| Insert an unlinked instruction into a basic block immediately before the specified instruction. More... | |
| void | insertAfter (Instruction *InsertPos) |
| Insert an unlinked instruction into a basic block immediately after the specified instruction. More... | |
| void | moveBefore (Instruction *MovePos) |
| Unlink this instruction from its current basic block and insert it into the basic block that MovePos lives in, right before MovePos. More... | |
| void | moveBefore (BasicBlock &BB, SymbolTableList< Instruction >::iterator I) |
| Unlink this instruction and insert into BB before I. More... | |
| void | moveAfter (Instruction *MovePos) |
| Unlink this instruction from its current basic block and insert it into the basic block that MovePos lives in, right after MovePos. More... | |
| unsigned | getOpcode () const |
| Returns a member of one of the enums like Instruction::Add. More... | |
| const char * | getOpcodeName () const |
| bool | isTerminator () const |
| bool | isUnaryOp () const |
| bool | isBinaryOp () const |
| bool | isIntDivRem () const |
| bool | isShift () |
| bool | isCast () const |
| bool | isFuncletPad () const |
| bool | isExceptionalTerminator () const |
| bool | isLogicalShift () const |
| Return true if this is a logical shift left or a logical shift right. More... | |
| bool | isArithmeticShift () const |
| Return true if this is an arithmetic shift right. More... | |
| bool | isBitwiseLogicOp () const |
| Return true if this is and/or/xor. More... | |
| bool | hasMetadata () const |
| Return true if this instruction has any metadata attached to it. More... | |
| bool | hasMetadataOtherThanDebugLoc () const |
| Return true if this instruction has metadata attached to it other than a debug location. More... | |
| MDNode * | getMetadata (unsigned KindID) const |
| Get the metadata of given kind attached to this Instruction. More... | |
| MDNode * | getMetadata (StringRef Kind) const |
| Get the metadata of given kind attached to this Instruction. More... | |
| void | getAllMetadata (SmallVectorImpl< std::pair< unsigned, MDNode *>> &MDs) const |
| Get all metadata attached to this Instruction. More... | |
| void | getAllMetadataOtherThanDebugLoc (SmallVectorImpl< std::pair< unsigned, MDNode *>> &MDs) const |
| This does the same thing as getAllMetadata, except that it filters out the debug location. More... | |
| void | getAAMetadata (AAMDNodes &N, bool Merge=false) const |
| Fills the AAMDNodes structure with AA metadata from this instruction. More... | |
| void | setMetadata (unsigned KindID, MDNode *Node) |
| Set the metadata of the specified kind to the specified node. More... | |
| void | setMetadata (StringRef Kind, MDNode *Node) |
| void | copyMetadata (const Instruction &SrcInst, ArrayRef< unsigned > WL=ArrayRef< unsigned >()) |
Copy metadata from SrcInst to this instruction. More... | |
| void | swapProfMetadata () |
| If the instruction has "branch_weights" MD_prof metadata and the MDNode has three operands (including name string), swap the order of the metadata. More... | |
| void | setAAMetadata (const AAMDNodes &N) |
| Sets the metadata on this instruction from the AAMDNodes structure. More... | |
| bool | extractProfMetadata (uint64_t &TrueVal, uint64_t &FalseVal) const |
| Retrieve the raw weight values of a conditional branch or select. More... | |
| bool | extractProfTotalWeight (uint64_t &TotalVal) const |
| Retrieve total raw weight values of a branch. More... | |
| void | updateProfWeight (uint64_t S, uint64_t T) |
Updates branch_weights metadata by scaling it by S / T. More... | |
| void | setProfWeight (uint64_t W) |
Sets the branch_weights metadata to W for CallInst. More... | |
| void | setDebugLoc (DebugLoc Loc) |
| Set the debug location information for this instruction. More... | |
| const DebugLoc & | getDebugLoc () const |
| Return the debug location for this node as a DebugLoc. More... | |
| void | setHasNoUnsignedWrap (bool b=true) |
| Set or clear the nuw flag on this instruction, which must be an operator which supports this flag. More... | |
| void | setHasNoSignedWrap (bool b=true) |
| Set or clear the nsw flag on this instruction, which must be an operator which supports this flag. More... | |
| void | setIsExact (bool b=true) |
| Set or clear the exact flag on this instruction, which must be an operator which supports this flag. More... | |
| bool | hasNoUnsignedWrap () const |
| Determine whether the no unsigned wrap flag is set. More... | |
| bool | hasNoSignedWrap () const |
| Determine whether the no signed wrap flag is set. More... | |
| void | dropPoisonGeneratingFlags () |
| Drops flags that may cause this instruction to evaluate to poison despite having non-poison inputs. More... | |
| bool | isExact () const |
| Determine whether the exact flag is set. More... | |
| void | setFast (bool B) |
| Set or clear all fast-math-flags on this instruction, which must be an operator which supports this flag. More... | |
| void | setHasAllowReassoc (bool B) |
| Set or clear the reassociation flag on this instruction, which must be an operator which supports this flag. More... | |
| void | setHasNoNaNs (bool B) |
| Set or clear the no-nans flag on this instruction, which must be an operator which supports this flag. More... | |
| void | setHasNoInfs (bool B) |
| Set or clear the no-infs flag on this instruction, which must be an operator which supports this flag. More... | |
| void | setHasNoSignedZeros (bool B) |
| Set or clear the no-signed-zeros flag on this instruction, which must be an operator which supports this flag. More... | |
| void | setHasAllowReciprocal (bool B) |
| Set or clear the allow-reciprocal flag on this instruction, which must be an operator which supports this flag. More... | |
| void | setHasApproxFunc (bool B) |
| Set or clear the approximate-math-functions flag on this instruction, which must be an operator which supports this flag. More... | |
| void | setFastMathFlags (FastMathFlags FMF) |
| Convenience function for setting multiple fast-math flags on this instruction, which must be an operator which supports these flags. More... | |
| void | copyFastMathFlags (FastMathFlags FMF) |
| Convenience function for transferring all fast-math flag values to this instruction, which must be an operator which supports these flags. More... | |
| bool | isFast () const |
| Determine whether all fast-math-flags are set. More... | |
| bool | hasAllowReassoc () const |
| Determine whether the allow-reassociation 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... | |
| bool | hasAllowContract () const |
| Determine whether the allow-contract flag is set. More... | |
| bool | hasApproxFunc () const |
| Determine whether the approximate-math-functions flag is set. More... | |
| FastMathFlags | getFastMathFlags () const |
| Convenience function for getting all the fast-math flags, which must be an operator which supports these flags. More... | |
| void | copyFastMathFlags (const Instruction *I) |
| Copy I's fast-math flags. More... | |
| void | copyIRFlags (const Value *V, bool IncludeWrapFlags=true) |
| Convenience method to copy supported exact, fast-math, and (optionally) wrapping flags from V to this instruction. More... | |
| void | andIRFlags (const Value *V) |
| Logical 'and' of any supported wrapping, exact, and fast-math flags of V and this instruction. More... | |
| void | applyMergedLocation (const DILocation *LocA, const DILocation *LocB) |
| Merge 2 debug locations and apply it to the Instruction. More... | |
| bool | isAssociative () const LLVM_READONLY |
| Return true if the instruction is associative: More... | |
| bool | isCommutative () const |
| Return true if the instruction is commutative: More... | |
| bool | isIdempotent () const |
| Return true if the instruction is idempotent: More... | |
| bool | isNilpotent () const |
| Return true if the instruction is nilpotent: More... | |
| bool | mayWriteToMemory () const |
| Return true if this instruction may modify memory. More... | |
| bool | mayReadFromMemory () const |
| Return true if this instruction may read memory. More... | |
| bool | mayReadOrWriteMemory () const |
| Return true if this instruction may read or write memory. More... | |
| bool | isAtomic () const |
| Return true if this instruction has an AtomicOrdering of unordered or higher. More... | |
| bool | hasAtomicLoad () const |
| Return true if this atomic instruction loads from memory. More... | |
| bool | hasAtomicStore () const |
| Return true if this atomic instruction stores to memory. More... | |
| bool | mayThrow () const |
| Return true if this instruction may throw an exception. More... | |
| bool | isFenceLike () const |
| Return true if this instruction behaves like a memory fence: it can load or store to memory location without being given a memory location. More... | |
| bool | mayHaveSideEffects () const |
| Return true if the instruction may have side effects. More... | |
| bool | isSafeToRemove () const |
| Return true if the instruction can be removed if the result is unused. More... | |
| bool | isEHPad () const |
| Return true if the instruction is a variety of EH-block. More... | |
| bool | isLifetimeStartOrEnd () const |
| Return true if the instruction is a llvm.lifetime.start or llvm.lifetime.end marker. More... | |
| const Instruction * | getNextNonDebugInstruction () const |
| Return a pointer to the next non-debug instruction in the same basic block as 'this', or nullptr if no such instruction exists. More... | |
| Instruction * | getNextNonDebugInstruction () |
| const Instruction * | getPrevNonDebugInstruction () const |
| Return a pointer to the previous non-debug instruction in the same basic block as 'this', or nullptr if no such instruction exists. More... | |
| Instruction * | getPrevNonDebugInstruction () |
| Instruction * | clone () const |
| Create a copy of 'this' instruction that is identical in all ways except the following: More... | |
| bool | isIdenticalTo (const Instruction *I) const |
| Return true if the specified instruction is exactly identical to the current one. More... | |
| bool | isIdenticalToWhenDefined (const Instruction *I) const |
| This is like isIdenticalTo, except that it ignores the SubclassOptionalData flags, which may specify conditions under which the instruction's result is undefined. More... | |
| bool | isSameOperationAs (const Instruction *I, unsigned flags=0) const |
| This function determines if the specified instruction executes the same operation as the current one. More... | |
| bool | isUsedOutsideOfBlock (const BasicBlock *BB) const |
| Return true if there are any uses of this instruction in blocks other than the specified block. More... | |
| unsigned | getNumSuccessors () const |
| Return the number of successors that this instruction has. More... | |
| BasicBlock * | getSuccessor (unsigned Idx) const |
| Return the specified successor. This instruction must be a terminator. More... | |
| void | setSuccessor (unsigned Idx, BasicBlock *BB) |
| Update the specified successor to point at the provided block. More... | |
| void | dropUnknownNonDebugMetadata (ArrayRef< unsigned > KnownIDs) |
| Drop all unknown metadata except for debug locations. More... | |
| void | dropUnknownNonDebugMetadata () |
| void | dropUnknownNonDebugMetadata (unsigned ID1) |
| void | dropUnknownNonDebugMetadata (unsigned ID1, unsigned ID2) |
| Public Member Functions inherited from llvm::User | |
| User (const User &)=delete | |
| void | operator delete (void *Usr) |
| Free memory allocated for User and Use objects. More... | |
| void | operator delete (void *Usr, unsigned) |
| Placement delete - required by std, called if the ctor throws. More... | |
| void | operator delete (void *Usr, unsigned, bool) |
| Placement delete - required by std, called if the ctor throws. More... | |
| const Use * | getOperandList () const |
| Use * | getOperandList () |
| Value * | getOperand (unsigned i) const |
| void | setOperand (unsigned i, Value *Val) |
| const Use & | getOperandUse (unsigned i) const |
| Use & | getOperandUse (unsigned i) |
| unsigned | getNumOperands () const |
| ArrayRef< const uint8_t > | getDescriptor () const |
| Returns the descriptor co-allocated with this User instance. More... | |
| MutableArrayRef< uint8_t > | getDescriptor () |
| Returns the descriptor co-allocated with this User instance. More... | |
| void | setGlobalVariableNumOperands (unsigned NumOps) |
| Set the number of operands on a GlobalVariable. 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_iterator > | operand_values () |
| const_value_op_iterator | value_op_begin () const |
| const_value_op_iterator | value_op_end () const |
| iterator_range< const_value_op_iterator > | operand_values () const |
| 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 | |
| Value (const Value &)=delete | |
| Value & | operator= (const Value &)=delete |
| void | deleteValue () |
| Delete a pointer to a generic Value. More... | |
| void | dump () const |
| Support for debugging, callable in GDB: V->dump() More... | |
| Type * | getType () const |
| All values are typed, get the type of this value. More... | |
| LLVMContext & | getContext () const |
| All values hold a context through their type. More... | |
| bool | hasName () const |
| ValueName * | getValueName () 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 | replaceNonMetadataUsesWith (Value *V) |
| Change non-metadata 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... | |
| void | assertModuleIsMaterializedImpl () const |
| void | assertModuleIsMaterialized () const |
| bool | use_empty () const |
| bool | materialized_use_empty () const |
| use_iterator | materialized_use_begin () |
| const_use_iterator | materialized_use_begin () const |
| use_iterator | use_begin () |
| const_use_iterator | use_begin () const |
| use_iterator | use_end () |
| const_use_iterator | use_end () const |
| iterator_range< use_iterator > | materialized_uses () |
| iterator_range< const_use_iterator > | materialized_uses () const |
| iterator_range< use_iterator > | uses () |
| iterator_range< const_use_iterator > | uses () const |
| bool | user_empty () const |
| user_iterator | materialized_user_begin () |
| const_user_iterator | materialized_user_begin () const |
| user_iterator | user_begin () |
| const_user_iterator | user_begin () const |
| user_iterator | user_end () |
| const_user_iterator | user_end () const |
| User * | user_back () |
| const User * | user_back () const |
| iterator_range< user_iterator > | materialized_users () |
| iterator_range< const_user_iterator > | materialized_users () const |
| iterator_range< user_iterator > | users () |
| 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... | |
| 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... | |
| bool | isSwiftError () const |
| Return true if this value is a swifterror value. More... | |
| const Value * | stripPointerCasts () const |
| Strip off pointer casts, all-zero GEPs, and aliases. More... | |
| Value * | stripPointerCasts () |
| const Value * | stripPointerCastsAndInvariantGroups () const |
| Strip off pointer casts, all-zero GEPs, aliases and invariant group info. More... | |
| Value * | stripPointerCastsAndInvariantGroups () |
| const Value * | stripPointerCastsNoFollowAliases () const |
| Strip off pointer casts and all-zero GEPs. More... | |
| Value * | stripPointerCastsNoFollowAliases () |
| const Value * | stripInBoundsConstantOffsets () const |
| Strip off pointer casts and all-constant inbounds GEPs. More... | |
| Value * | stripInBoundsConstantOffsets () |
| const Value * | stripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const |
| Accumulate offsets from stripInBoundsConstantOffsets(). More... | |
| Value * | stripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) |
| const Value * | stripInBoundsOffsets () const |
| Strip off pointer casts and inbounds GEPs. More... | |
| Value * | stripInBoundsOffsets () |
| uint64_t | getPointerDereferenceableBytes (const DataLayout &DL, bool &CanBeNull) const |
| Returns the number of bytes known to be dereferenceable for the pointer value. More... | |
| unsigned | getPointerAlignment (const DataLayout &DL) const |
| Returns an alignment of the pointer value. More... | |
| const Value * | DoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB) const |
| Translate PHI node to its predecessor from the given basic block. More... | |
| Value * | DoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB) |
| 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, bool IsForDebug=false) const |
| Implement operator<< on Value. More... | |
| void | print (raw_ostream &O, ModuleSlotTracker &MST, bool IsForDebug=false) 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 |
| Public Member Functions inherited from llvm::ilist_node_with_parent< Instruction, BasicBlock > | |
| Instruction * | getPrevNode () |
| const Instruction * | getPrevNode () const |
Get the previous node, or nullptr for the list head. More... | |
| Instruction * | getNextNode () |
Get the next node, or nullptr for the list tail. More... | |
| const Instruction * | getNextNode () const |
Get the next node, or nullptr for the list tail. More... | |
| Public Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< Instruction, Options... >::type > | |
| self_iterator | getIterator () |
| const_self_iterator | getIterator () const |
| reverse_self_iterator | getReverseIterator () |
| const_reverse_self_iterator | getReverseIterator () const |
| bool | isSentinel () const |
| Check whether this is the sentinel node. More... | |
Static Public Member Functions | |
| static GetElementPtrInst * | Create (Type *PointeeType, Value *Ptr, ArrayRef< Value *> IdxList, const Twine &NameStr="", Instruction *InsertBefore=nullptr) |
| static GetElementPtrInst * | Create (Type *PointeeType, Value *Ptr, ArrayRef< Value *> IdxList, const Twine &NameStr, BasicBlock *InsertAtEnd) |
| static GetElementPtrInst * | CreateInBounds (Value *Ptr, ArrayRef< Value *> IdxList, const Twine &NameStr="", Instruction *InsertBefore=nullptr) |
| Create an "inbounds" getelementptr. More... | |
| static GetElementPtrInst * | CreateInBounds (Type *PointeeType, Value *Ptr, ArrayRef< Value *> IdxList, const Twine &NameStr="", Instruction *InsertBefore=nullptr) |
| static GetElementPtrInst * | CreateInBounds (Value *Ptr, ArrayRef< Value *> IdxList, const Twine &NameStr, BasicBlock *InsertAtEnd) |
| static GetElementPtrInst * | CreateInBounds (Type *PointeeType, Value *Ptr, ArrayRef< Value *> IdxList, const Twine &NameStr, BasicBlock *InsertAtEnd) |
| static Type * | getIndexedType (Type *Ty, ArrayRef< Value *> IdxList) |
| Returns the type of the element that would be loaded with a load instruction with the specified parameters. More... | |
| static Type * | getIndexedType (Type *Ty, ArrayRef< Constant *> IdxList) |
| static Type * | getIndexedType (Type *Ty, ArrayRef< uint64_t > IdxList) |
| static unsigned | getPointerOperandIndex () |
| static Type * | getGEPReturnType (Value *Ptr, ArrayRef< Value *> IdxList) |
| Returns the pointer type returned by the GEP instruction, which may be a vector of pointers. More... | |
| static Type * | getGEPReturnType (Type *ElTy, Value *Ptr, ArrayRef< Value *> IdxList) |
| 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 | isUnaryOp (unsigned Opcode) |
| static bool | isBinaryOp (unsigned Opcode) |
| static bool | isIntDivRem (unsigned Opcode) |
| static bool | isShift (unsigned Opcode) |
| Determine if the Opcode is one of the shift instructions. More... | |
| static bool | isBitwiseLogicOp (unsigned Opcode) |
| Determine if the Opcode is and/or/xor. More... | |
| static bool | isCast (unsigned OpCode) |
| Determine if the OpCode is one of the CastInst instructions. More... | |
| static bool | isFuncletPad (unsigned OpCode) |
| Determine if the OpCode is one of the FuncletPadInst instructions. More... | |
| static bool | isExceptionalTerminator (unsigned OpCode) |
| Returns true if the OpCode is a terminator related to exception handling. More... | |
| static bool | isAssociative (unsigned Opcode) |
| static bool | isCommutative (unsigned Opcode) |
| static bool | isIdempotent (unsigned Opcode) |
| static bool | isNilpotent (unsigned Opcode) |
| 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 | |
| GetElementPtrInst * | cloneImpl () const |
| Protected Member Functions inherited from llvm::Instruction | |
| ~Instruction () | |
| void | setInstructionSubclassData (unsigned short D) |
| unsigned | getSubclassDataFromInstruction () const |
| Instruction (Type *Ty, unsigned iType, Use *Ops, unsigned NumOps, Instruction *InsertBefore=nullptr) | |
| Instruction (Type *Ty, unsigned iType, Use *Ops, unsigned NumOps, BasicBlock *InsertAtEnd) | |
| 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... | |
| void * | operator new (size_t Size, unsigned Us, unsigned DescBytes) |
| Allocate a User with the operands co-allocated. More... | |
| User (Type *ty, unsigned vty, Use *, 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... | |
| ~User ()=default | |
| template<int Idx> | |
| Use & | Op () |
| template<int Idx> | |
| const Use & | Op () const |
| Protected Member Functions inherited from llvm::Value | |
| Value (Type *Ty, unsigned scid) | |
| ~Value () | |
| Value's destructor should be virtual by design, but that would require that Value and all of its subclasses have a vtable that effectively duplicates the information in the value ID. More... | |
| unsigned short | getSubclassDataFromValue () const |
| void | setValueSubclassData (unsigned short D) |
| Protected Member Functions inherited from llvm::ilist_node_with_parent< Instruction, BasicBlock > | |
| ilist_node_with_parent ()=default | |
| Protected Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< Instruction, Options... >::type > | |
| ilist_node_impl ()=default | |
Friends | |
| class | Instruction |
Detailed Description
an instruction for type-safe pointer arithmetic to access elements of arrays and structs
Definition at line 854 of file Instructions.h.
Member Function Documentation
◆ accumulateConstantOffset()
| bool GetElementPtrInst::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 least as wide as the IntPtr type for the address space of the base GEP pointer.
Definition at line 1539 of file Instructions.cpp.
References assert(), llvm::Value::getType(), llvm::FenceInst::Instruction, and llvm::Value::setName().
Referenced by llvm::detail::PtrUseVisitorBase::adjustOffsetForGEP(), and llvm::InstCombiner::visitGetElementPtrInst().
◆ classof() [1/2]
|
inlinestatic |
Definition at line 1074 of file Instructions.h.
References llvm::Instruction::getOpcode().
◆ classof() [2/2]
Definition at line 1077 of file Instructions.h.
References llvm::AllocaInst::classof().
◆ cloneImpl()
|
protected |
Definition at line 3803 of file Instructions.cpp.
References llvm::User::getNumOperands().
◆ Create() [1/2]
|
inlinestatic |
Definition at line 880 of file Instructions.h.
References assert(), llvm::Type::getScalarType(), llvm::Value::getType(), and llvm::ArrayRef< T >::size().
Referenced by buildNew(), cloneInstructionWithNewAddressSpace(), llvm::IRBuilder< TargetFolder >::CreateConstGEP1_32(), llvm::IRBuilder< TargetFolder >::CreateConstGEP1_64(), llvm::IRBuilder< TargetFolder >::CreateConstGEP2_32(), llvm::IRBuilder< TargetFolder >::CreateConstGEP2_64(), llvm::IRBuilder< TargetFolder >::CreateGEP(), llvm::NoFolder::CreateGetElementPtr(), llvm::createSeparateConstOffsetFromGEPPass(), doPromotion(), llvm::CodeExtractor::findInputsOutputs(), FunctionNumber(), llvm::fuzzerop::gepDescriptor(), llvm::ConstantExpr::getAsInstruction(), GetPointerOperand(), getSelectFoldableConstant(), llvm::PHITransAddr::PHITranslateWithInsertion(), RewriteHeapSROALoadUser(), simplifyAllocaArraySize(), SRAGlobal(), updateOperand(), and llvm::InstCombiner::visitGetElementPtrInst().
◆ Create() [2/2]
|
inlinestatic |
Definition at line 896 of file Instructions.h.
References assert(), llvm::Type::getScalarType(), llvm::Value::getType(), and llvm::ArrayRef< T >::size().
◆ CreateInBounds() [1/4]
|
inlinestatic |
Create an "inbounds" getelementptr.
See the documentation for the "inbounds" flag in LangRef.html for details.
Definition at line 914 of file Instructions.h.
Referenced by llvm::IRBuilder< TargetFolder >::CreateConstInBoundsGEP1_32(), llvm::IRBuilder< TargetFolder >::CreateConstInBoundsGEP1_64(), llvm::IRBuilder< TargetFolder >::CreateConstInBoundsGEP2_32(), llvm::IRBuilder< TargetFolder >::CreateConstInBoundsGEP2_64(), llvm::IRBuilder< TargetFolder >::CreateInBoundsGEP(), llvm::NoFolder::CreateInBoundsGetElementPtr(), llvm::ConstantExpr::getAsInstruction(), getSelectFoldableConstant(), simplifyAllocaArraySize(), tryToShorten(), llvm::InstCombiner::visitBitCast(), and llvm::InstCombiner::visitGetElementPtrInst().
◆ CreateInBounds() [2/4]
|
inlinestatic |
Definition at line 922 of file Instructions.h.
References GEP, and setIsInBounds().
◆ CreateInBounds() [3/4]
|
inlinestatic |
Definition at line 931 of file Instructions.h.
◆ CreateInBounds() [4/4]
|
inlinestatic |
Definition at line 938 of file Instructions.h.
References llvm::UnaryInstruction::DECLARE_TRANSPARENT_OPERAND_ACCESSORS(), GEP, and setIsInBounds().
◆ DECLARE_TRANSPARENT_OPERAND_ACCESSORS()
| llvm::GetElementPtrInst::DECLARE_TRANSPARENT_OPERAND_ACCESSORS | ( | Value | ) |
Transparently provide more efficient getOperand methods.
◆ getAddressSpace()
|
inline |
Returns the address space of this instruction's pointer type.
Definition at line 963 of file Instructions.h.
Referenced by llvm::AMDGPUTTIImpl::getUnrollingPreferences(), hasSameExtUse(), matchesOr(), and llvm::InstCombiner::visitGetElementPtrInst().
◆ getGEPReturnType() [1/2]
|
inlinestatic |
Returns the pointer type returned by the GEP instruction, which may be a vector of pointers.
Definition at line 1015 of file Instructions.h.
References llvm::Type::getScalarType(), and llvm::Value::getType().
Referenced by llvm::ConstantFoldGetElementPtr().
◆ getGEPReturnType() [2/2]
|
inlinestatic |
Definition at line 1020 of file Instructions.h.
References llvm::checkGEPType(), llvm::VectorType::get(), llvm::PointerType::get(), llvm::Type::getPointerAddressSpace(), llvm::Value::getType(), llvm::Type::getVectorNumElements(), and llvm::Type::isVectorTy().
◆ getIndexedType() [1/3]
Returns the type of the element that would be loaded with a load instruction with the specified parameters.
Null is returned if the indices are invalid for the specified pointer type.
Definition at line 1493 of file Instructions.cpp.
References getIndexedTypeInternal().
Referenced by aliasSameBasePointerGEPs(), canReplaceGEPIdxWithZero(), llvm::ConstantFoldGetElementPtr(), llvm::ConstantFoldLoadFromConstPtr(), llvm::createEfficiencySanitizerPass(), doPromotion(), FunctionNumber(), llvm::ConstantExpr::getGetElementPtr(), llvm::ConstantExpr::getOpcodeName(), getParameterABIAttributes(), and SimplifyGEPInst().
◆ getIndexedType() [2/3]
Definition at line 1497 of file Instructions.cpp.
References getIndexedTypeInternal().
◆ getIndexedType() [3/3]
Definition at line 1502 of file Instructions.cpp.
References getIndexedTypeInternal().
◆ getNumIndices()
|
inline |
Definition at line 1038 of file Instructions.h.
References llvm::User::getNumOperands().
Referenced by llvm::createEfficiencySanitizerPass(), doPromotion(), getAsConstantIndexedAddress(), getScalarIntrinsicDeclaration(), and llvm::InstCombiner::visitGetElementPtrInst().
◆ getPointerAddressSpace()
|
inline |
Returns the address space of the pointer operand.
Definition at line 1009 of file Instructions.h.
Referenced by llvm::createSeparateConstOffsetFromGEPPass(), and llvm::InstCombiner::visitGetElementPtrInst().
◆ getPointerOperand() [1/2]
|
inline |
Definition at line 992 of file Instructions.h.
References llvm::User::getOperand().
Referenced by llvm::FunctionComparator::cmpOperations(), llvm::AMDGPUTTIImpl::getUnrollingPreferences(), llvm::X86TTIImpl::getUserCost(), isGEPFoldable(), IsNonLocalValue(), operator new(), and llvm::Interpreter::visitGetElementPtrInst().
◆ getPointerOperand() [2/2]
Definition at line 995 of file Instructions.h.
References llvm::User::getOperand().
◆ getPointerOperandIndex()
|
inlinestatic |
Definition at line 998 of file Instructions.h.
◆ getPointerOperandType()
|
inline |
Method to return the pointer operand as a PointerType.
Definition at line 1004 of file Instructions.h.
References llvm::getPointerOperand(), and llvm::Value::getType().
Referenced by getParameterABIAttributes(), and llvm::InstCombiner::visitGetElementPtrInst().
◆ getResultElementType()
|
inline |
Definition at line 956 of file Instructions.h.
References assert(), and llvm::AllocaInst::getType().
Referenced by llvm::createSeparateConstOffsetFromGEPPass(), llvm::getGEPInductionOperand(), getParameterABIAttributes(), hasSameExtUse(), and isGEPFoldable().
◆ getSourceElementType()
|
inline |
Definition at line 951 of file Instructions.h.
Referenced by canReplaceGEPIdxWithZero(), cloneInstructionWithNewAddressSpace(), llvm::createEfficiencySanitizerPass(), getParameterABIAttributes(), getScalarIntrinsicDeclaration(), isGEPFoldable(), and llvm::InstCombiner::visitGetElementPtrInst().
◆ hasAllConstantIndices()
| bool GetElementPtrInst::hasAllConstantIndices | ( | ) | const |
Return true if all of the indices of this GEP are constant integers.
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 1523 of file Instructions.cpp.
References llvm::User::getNumOperands(), and llvm::User::getOperand().
Referenced by llvm::createSeparateConstOffsetFromGEPPass(), getAsConstantIndexedAddress(), and isSafeAndProfitableToSinkLoad().
◆ hasAllZeroIndices()
| bool GetElementPtrInst::hasAllZeroIndices | ( | ) | const |
Return true if all of the indices of this GEP are zeros.
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 1509 of file Instructions.cpp.
References llvm::User::getNumOperands(), and llvm::User::getOperand().
◆ hasIndices()
|
inline |
Definition at line 1042 of file Instructions.h.
References llvm::User::getNumOperands().
◆ idx_begin() [1/2]
|
inline |
Definition at line 979 of file Instructions.h.
References llvm::User::op_begin().
Referenced by canReplaceGEPIdxWithZero(), cloneInstructionWithNewAddressSpace(), llvm::createEfficiencySanitizerPass(), doPromotion(), getParameterABIAttributes(), hasOnlyOneNonZeroIndex(), isGEPFoldable(), matchesOr(), operator new(), and llvm::InstCombiner::visitGetElementPtrInst().
◆ idx_begin() [2/2]
|
inline |
Definition at line 980 of file Instructions.h.
References llvm::User::op_begin().
◆ idx_end() [1/2]
|
inline |
Definition at line 981 of file Instructions.h.
References llvm::User::op_end().
Referenced by cloneInstructionWithNewAddressSpace(), doPromotion(), getParameterABIAttributes(), hasOnlyOneNonZeroIndex(), isGEPFoldable(), matchesOr(), operator new(), and llvm::InstCombiner::visitGetElementPtrInst().
◆ idx_end() [2/2]
|
inline |
Definition at line 982 of file Instructions.h.
References llvm::User::op_end().
◆ indices() [1/2]
|
inline |
Definition at line 984 of file Instructions.h.
References llvm::make_range().
◆ indices() [2/2]
|
inline |
Definition at line 988 of file Instructions.h.
References llvm::make_range().
◆ isInBounds()
| bool GetElementPtrInst::isInBounds | ( | ) | const |
Determine whether the GEP has the inbounds flag.
Definition at line 1535 of file Instructions.cpp.
Referenced by canReplaceGEPIdxWithZero(), cloneInstructionWithNewAddressSpace(), computeUnsignedMinMaxValuesFromKnownBits(), llvm::createSeparateConstOffsetFromGEPPass(), getAsConstantIndexedAddress(), getScalarIntrinsicDeclaration(), isGEPFoldable(), operator new(), AllocaSlices::SliceBuilder::SliceBuilder(), tryUnmergingGEPsAcrossIndirectBr(), and llvm::InstCombiner::visitGetElementPtrInst().
◆ setIsInBounds()
Set or clear the inbounds flag on this GEP instruction.
See LangRef.html for the meaning of inbounds on a getelementptr.
Definition at line 1531 of file Instructions.cpp.
Referenced by buildNew(), CreateInBounds(), llvm::createSeparateConstOffsetFromGEPPass(), GetPointerOperand(), isGEPFoldable(), llvm::PHITransAddr::PHITranslateWithInsertion(), llvm::InnerLoopVectorizer::vectorizeMemoryInstruction(), and llvm::InstCombiner::visitGetElementPtrInst().
◆ setResultElementType()
|
inline |
Definition at line 954 of file Instructions.h.
◆ setSourceElementType()
|
inline |
Definition at line 953 of file Instructions.h.
Referenced by llvm::InstCombiner::visitGetElementPtrInst().
Friends And Related Function Documentation
◆ Instruction
|
friend |
Definition at line 875 of file Instructions.h.
The documentation for this class was generated from the following files:
- include/llvm/IR/Instructions.h
- lib/IR/Instructions.cpp
