LLVM 19.0.0git
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
llvm::BasicBlock Class Referencefinal

LLVM Basic Block Representation. More...

#include "llvm/IR/BasicBlock.h"

Inheritance diagram for llvm::BasicBlock:
Inheritance graph
[legend]

Classes

class  phi_iterator_impl
 Iterator to walk just the phi nodes in the basic block. More...
 

Public Types

using InstListType = SymbolTableList< Instruction, ilist_iterator_bits< true >, ilist_parent< BasicBlock > >
 
using iterator = InstListType::iterator
 Instruction iterators...
 
using const_iterator = InstListType::const_iterator
 
using reverse_iterator = InstListType::reverse_iterator
 
using const_reverse_iterator = InstListType::const_reverse_iterator
 
using phi_iterator = phi_iterator_impl<>
 
using const_phi_iterator = phi_iterator_impl< const PHINode, BasicBlock::const_iterator >
 
- Public Types inherited from llvm::Value
enum  ValueTy
 Concrete subclass of this. More...
 
using use_iterator = use_iterator_impl< Use >
 
using const_use_iterator = use_iterator_impl< const Use >
 
using user_iterator = user_iterator_impl< User >
 
using const_user_iterator = user_iterator_impl< const User >
 

Public Member Functions

DbgMarkercreateMarker (Instruction *I)
 Attach a DbgMarker to the given instruction.
 
DbgMarkercreateMarker (InstListType::iterator It)
 
void convertToNewDbgValues ()
 Convert variable location debugging information stored in dbg.value intrinsics into DbgMarkers / DbgRecords.
 
void convertFromNewDbgValues ()
 Convert variable location debugging information stored in DbgMarkers and DbgRecords into the dbg.value intrinsic representation.
 
void setIsNewDbgInfoFormat (bool NewFlag)
 Ensure the block is in "old" dbg.value format (NewFlag == false) or in the new format (NewFlag == true), converting to the desired format if necessary.
 
void setNewDbgInfoFormatFlag (bool NewFlag)
 
void setTrailingDbgRecords (DbgMarker *M)
 Record that the collection of DbgRecords in M "trails" after the last instruction of this block.
 
DbgMarkergetTrailingDbgRecords ()
 Fetch the collection of DbgRecords that "trail" after the last instruction of this block, see setTrailingDbgRecords.
 
void deleteTrailingDbgRecords ()
 Delete any trailing DbgRecords at the end of this block, see setTrailingDbgRecords.
 
void dumpDbgValues () const
 
DbgMarkergetMarker (InstListType::iterator It)
 Return the DbgMarker for the position given by It, so that DbgRecords can be inserted there.
 
DbgMarkergetNextMarker (Instruction *I)
 Return the DbgMarker for the position that comes after I.
 
void insertDbgRecordAfter (DbgRecord *DR, Instruction *I)
 Insert a DbgRecord into a block at the position given by I.
 
void insertDbgRecordBefore (DbgRecord *DR, InstListType::iterator Here)
 Insert a DbgRecord into a block at the position given by Here.
 
void flushTerminatorDbgRecords ()
 Eject any debug-info trailing at the end of a block.
 
void reinsertInstInDbgRecords (Instruction *I, std::optional< DbgRecord::self_iterator > Pos)
 In rare circumstances instructions can be speculatively removed from blocks, and then be re-inserted back into that position later.
 
 BasicBlock (const BasicBlock &)=delete
 
BasicBlockoperator= (const BasicBlock &)=delete
 
 ~BasicBlock ()
 
LLVMContextgetContext () const
 Get the context in which this basic block lives.
 
const FunctiongetParent () const
 Return the enclosing method, or null if none.
 
FunctiongetParent ()
 
const ModulegetModule () const
 Return the module owning the function this basic block belongs to, or nullptr if the function does not have a module.
 
ModulegetModule ()
 
const InstructiongetTerminator () const LLVM_READONLY
 Returns the terminator instruction if the block is well formed or null if the block is not well formed.
 
InstructiongetTerminator ()
 
const CallInstgetTerminatingDeoptimizeCall () const
 Returns the call instruction calling @llvm.experimental.deoptimize prior to the terminating return instruction of this basic block, if such a call is present.
 
CallInstgetTerminatingDeoptimizeCall ()
 
const CallInstgetPostdominatingDeoptimizeCall () const
 Returns the call instruction calling @llvm.experimental.deoptimize that is present either in current basic block or in block that is a unique successor to current block, if such call is present.
 
CallInstgetPostdominatingDeoptimizeCall ()
 
const CallInstgetTerminatingMustTailCall () const
 Returns the call instruction marked 'musttail' prior to the terminating return instruction of this basic block, if such a call is present.
 
CallInstgetTerminatingMustTailCall ()
 
const InstructiongetFirstNonPHI () const
 Returns a pointer to the first instruction in this block that is not a PHINode instruction.
 
InstructiongetFirstNonPHI ()
 
InstListType::const_iterator getFirstNonPHIIt () const
 Iterator returning form of getFirstNonPHI.
 
InstListType::iterator getFirstNonPHIIt ()
 
const InstructiongetFirstNonPHIOrDbg (bool SkipPseudoOp=true) const
 Returns a pointer to the first instruction in this block that is not a PHINode or a debug intrinsic, or any pseudo operation if SkipPseudoOp is true.
 
InstructiongetFirstNonPHIOrDbg (bool SkipPseudoOp=true)
 
const InstructiongetFirstNonPHIOrDbgOrLifetime (bool SkipPseudoOp=true) const
 Returns a pointer to the first instruction in this block that is not a PHINode, a debug intrinsic, or a lifetime intrinsic, or any pseudo operation if SkipPseudoOp is true.
 
InstructiongetFirstNonPHIOrDbgOrLifetime (bool SkipPseudoOp=true)
 
const_iterator getFirstInsertionPt () const
 Returns an iterator to the first instruction in this block that is suitable for inserting a non-PHI instruction.
 
iterator getFirstInsertionPt ()
 
const_iterator getFirstNonPHIOrDbgOrAlloca () const
 Returns an iterator to the first instruction in this block that is not a PHINode, a debug intrinsic, a static alloca or any pseudo operation.
 
iterator getFirstNonPHIOrDbgOrAlloca ()
 
const InstructiongetFirstMayFaultInst () const
 Returns the first potential AsynchEH faulty instruction currently it checks for loads/stores (which may dereference a null pointer) and calls/invokes (which may propagate exceptions)
 
InstructiongetFirstMayFaultInst ()
 
iterator_range< filter_iterator< BasicBlock::const_iterator, std::function< bool(const Instruction &)> > > instructionsWithoutDebug (bool SkipPseudoOp=true) const
 Return a const iterator range over the instructions in the block, skipping any debug instructions.
 
iterator_range< filter_iterator< BasicBlock::iterator, std::function< bool(Instruction &)> > > instructionsWithoutDebug (bool SkipPseudoOp=true)
 Return an iterator range over the instructions in the block, skipping any debug instructions.
 
filter_iterator< BasicBlock::const_iterator, std::function< bool(constInstruction &)> >::difference_type sizeWithoutDebug () const
 Return the size of the basic block ignoring debug instructions.
 
void removeFromParent ()
 Unlink 'this' from the containing function, but do not delete it.
 
SymbolTableList< BasicBlock >::iterator eraseFromParent ()
 Unlink 'this' from the containing function and delete it.
 
void moveBefore (BasicBlock *MovePos)
 Unlink this basic block from its current function and insert it into the function that MovePos lives in, right before MovePos.
 
void moveBefore (SymbolTableList< BasicBlock >::iterator MovePos)
 
void moveAfter (BasicBlock *MovePos)
 Unlink this basic block from its current function and insert it right after MovePos in the function MovePos lives in.
 
void insertInto (Function *Parent, BasicBlock *InsertBefore=nullptr)
 Insert unlinked basic block into a function.
 
const BasicBlockgetSinglePredecessor () const
 Return the predecessor of this block if it has a single predecessor block.
 
BasicBlockgetSinglePredecessor ()
 
const BasicBlockgetUniquePredecessor () const
 Return the predecessor of this block if it has a unique predecessor block.
 
BasicBlockgetUniquePredecessor ()
 
bool hasNPredecessors (unsigned N) const
 Return true if this block has exactly N predecessors.
 
bool hasNPredecessorsOrMore (unsigned N) const
 Return true if this block has N predecessors or more.
 
const BasicBlockgetSingleSuccessor () const
 Return the successor of this block if it has a single successor.
 
BasicBlockgetSingleSuccessor ()
 
const BasicBlockgetUniqueSuccessor () const
 Return the successor of this block if it has a unique successor.
 
BasicBlockgetUniqueSuccessor ()
 
void print (raw_ostream &OS, AssemblyAnnotationWriter *AAW=nullptr, bool ShouldPreserveUseListOrder=false, bool IsForDebug=false) const
 Print the basic block to an output stream with an optional AssemblyAnnotationWriter.
 
iterator begin ()
 Instruction iterator methods.
 
const_iterator begin () const
 
iterator end ()
 
const_iterator end () const
 
reverse_iterator rbegin ()
 
const_reverse_iterator rbegin () const
 
reverse_iterator rend ()
 
const_reverse_iterator rend () const
 
size_t size () const
 
bool empty () const
 
const Instructionfront () const
 
Instructionfront ()
 
const Instructionback () const
 
Instructionback ()
 
iterator_range< const_phi_iteratorphis () const
 Returns a range that iterates over the phis in the basic block.
 
iterator_range< phi_iteratorphis ()
 
ValueSymbolTablegetValueSymbolTable ()
 Returns a pointer to the symbol table if one exists.
 
void dropAllReferences ()
 Cause all subinstructions to "let go" of all the references that said subinstructions are maintaining.
 
void removePredecessor (BasicBlock *Pred, bool KeepOneInputPHIs=false)
 Update PHI nodes in this BasicBlock before removal of predecessor Pred.
 
bool canSplitPredecessors () const
 
BasicBlocksplitBasicBlock (iterator I, const Twine &BBName="", bool Before=false)
 Split the basic block into two basic blocks at the specified instruction.
 
BasicBlocksplitBasicBlock (Instruction *I, const Twine &BBName="", bool Before=false)
 
BasicBlocksplitBasicBlockBefore (iterator I, const Twine &BBName="")
 Split the basic block into two basic blocks at the specified instruction and insert the new basic blocks as the predecessor of the current block.
 
BasicBlocksplitBasicBlockBefore (Instruction *I, const Twine &BBName="")
 
void splice (BasicBlock::iterator ToIt, BasicBlock *FromBB)
 Transfer all instructions from FromBB to this basic block at ToIt.
 
void splice (BasicBlock::iterator ToIt, BasicBlock *FromBB, BasicBlock::iterator FromIt)
 Transfer one instruction from FromBB at FromIt to this basic block at ToIt.
 
void splice (BasicBlock::iterator ToIt, BasicBlock *FromBB, BasicBlock::iterator FromBeginIt, BasicBlock::iterator FromEndIt)
 Transfer a range of instructions that belong to FromBB from FromBeginIt to FromEndIt, to this basic block at ToIt.
 
BasicBlock::iterator erase (BasicBlock::iterator FromIt, BasicBlock::iterator ToIt)
 Erases a range of instructions from FromIt to (not including) ToIt.
 
bool hasAddressTaken () const
 Returns true if there are any uses of this basic block other than direct branches, switches, etc.
 
void replacePhiUsesWith (BasicBlock *Old, BasicBlock *New)
 Update all phi nodes in this basic block to refer to basic block New instead of basic block Old.
 
void replaceSuccessorsPhiUsesWith (BasicBlock *Old, BasicBlock *New)
 Update all phi nodes in this basic block's successors to refer to basic block New instead of basic block Old.
 
void replaceSuccessorsPhiUsesWith (BasicBlock *New)
 Update all phi nodes in this basic block's successors to refer to basic block New instead of to it.
 
bool isEHPad () const
 Return true if this basic block is an exception handling block.
 
bool isLandingPad () const
 Return true if this basic block is a landing pad.
 
const LandingPadInstgetLandingPadInst () const
 Return the landingpad instruction associated with the landing pad.
 
LandingPadInstgetLandingPadInst ()
 
bool isLegalToHoistInto () const
 Return true if it is legal to hoist instructions into this block.
 
bool isEntryBlock () const
 Return true if this is the entry block of the containing function.
 
std::optional< uint64_tgetIrrLoopHeaderWeight () const
 
bool isInstrOrderValid () const
 Returns true if the Order field of child Instructions is valid.
 
void invalidateOrders ()
 Mark instruction ordering invalid. Done on every instruction insert.
 
void renumberInstructions ()
 Renumber instructions and mark the ordering as valid.
 
void validateInstrOrdering () const
 Asserts that instruction order numbers are marked invalid, or that they are in ascending order.
 
- Public Member Functions inherited from llvm::Value
 Value (const Value &)=delete
 
Valueoperator= (const Value &)=delete
 
void deleteValue ()
 Delete a pointer to a generic Value.
 
void dump () const
 Support for debugging, callable in GDB: V->dump()
 
TypegetType () const
 All values are typed, get the type of this value.
 
LLVMContextgetContext () const
 All values hold a context through their type.
 
bool hasName () const
 
ValueNamegetValueName () const
 
void setValueName (ValueName *VN)
 
StringRef getName () const
 Return a constant reference to the value's name.
 
void setName (const Twine &Name)
 Change the name of the value.
 
void takeName (Value *V)
 Transfer the name from V to this value.
 
std::string getNameOrAsOperand () const
 
void replaceAllUsesWith (Value *V)
 Change all uses of this to point to a new Value.
 
void replaceNonMetadataUsesWith (Value *V)
 Change non-metadata uses of this to point to a new Value.
 
void replaceUsesWithIf (Value *New, llvm::function_ref< bool(Use &U)> ShouldReplace)
 Go through the uses list for this definition and make each use point to "V" if the callback ShouldReplace returns true for the given Use.
 
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.
 
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_iteratormaterialized_uses ()
 
iterator_range< const_use_iteratormaterialized_uses () const
 
iterator_range< use_iteratoruses ()
 
iterator_range< const_use_iteratoruses () 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
 
Useruser_back ()
 
const Useruser_back () const
 
iterator_range< user_iteratormaterialized_users ()
 
iterator_range< const_user_iteratormaterialized_users () const
 
iterator_range< user_iteratorusers ()
 
iterator_range< const_user_iteratorusers () const
 
bool hasOneUse () const
 Return true if there is exactly one use of this value.
 
bool hasNUses (unsigned N) const
 Return true if this Value has exactly N uses.
 
bool hasNUsesOrMore (unsigned N) const
 Return true if this value has N uses or more.
 
bool hasOneUser () const
 Return true if there is exactly one user of this value.
 
UsegetSingleUndroppableUse ()
 Return true if there is exactly one use of this value that cannot be dropped.
 
const UsegetSingleUndroppableUse () const
 
UsergetUniqueUndroppableUser ()
 Return true if there is exactly one unique user of this value that cannot be dropped (that user can have multiple uses of this value).
 
const UsergetUniqueUndroppableUser () const
 
bool hasNUndroppableUses (unsigned N) const
 Return true if there this value.
 
bool hasNUndroppableUsesOrMore (unsigned N) const
 Return true if this value has N uses or more.
 
void dropDroppableUses (llvm::function_ref< bool(const Use *)> ShouldDrop=[](const Use *) { return true;})
 Remove every uses that can safely be removed.
 
void dropDroppableUsesIn (User &Usr)
 Remove every use of this value in User that can safely be removed.
 
bool isUsedInBasicBlock (const BasicBlock *BB) const
 Check if this value is used in the specified basic block.
 
unsigned getNumUses () const
 This method computes the number of uses of this Value.
 
void addUse (Use &U)
 This method should only be used by the Use class.
 
unsigned getValueID () const
 Return an ID for the concrete type of this object.
 
unsigned getRawSubclassOptionalData () const
 Return the raw optional flags value contained in this value.
 
void clearSubclassOptionalData ()
 Clear the optional flags contained in this value.
 
bool hasSameSubclassOptionalData (const Value *V) const
 Check the optional flags for equality.
 
bool hasValueHandle () const
 Return true if there is a value handle associated with this value.
 
bool isUsedByMetadata () const
 Return true if there is metadata referencing this value.
 
bool isSwiftError () const
 Return true if this value is a swifterror value.
 
const ValuestripPointerCasts () const
 Strip off pointer casts, all-zero GEPs and address space casts.
 
ValuestripPointerCasts ()
 
const ValuestripPointerCastsAndAliases () const
 Strip off pointer casts, all-zero GEPs, address space casts, and aliases.
 
ValuestripPointerCastsAndAliases ()
 
const ValuestripPointerCastsSameRepresentation () const
 Strip off pointer casts, all-zero GEPs and address space casts but ensures the representation of the result stays the same.
 
ValuestripPointerCastsSameRepresentation ()
 
const ValuestripPointerCastsForAliasAnalysis () const
 Strip off pointer casts, all-zero GEPs, single-argument phi nodes and invariant group info.
 
ValuestripPointerCastsForAliasAnalysis ()
 
const ValuestripInBoundsConstantOffsets () const
 Strip off pointer casts and all-constant inbounds GEPs.
 
ValuestripInBoundsConstantOffsets ()
 
const ValuestripAndAccumulateConstantOffsets (const DataLayout &DL, APInt &Offset, bool AllowNonInbounds, bool AllowInvariantGroup=false, function_ref< bool(Value &Value, APInt &Offset)> ExternalAnalysis=nullptr) const
 Accumulate the constant offset this value has compared to a base pointer.
 
ValuestripAndAccumulateConstantOffsets (const DataLayout &DL, APInt &Offset, bool AllowNonInbounds, bool AllowInvariantGroup=false)
 
const ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const
 This is a wrapper around stripAndAccumulateConstantOffsets with the in-bounds requirement set to false.
 
ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset)
 
const ValuestripInBoundsOffsets (function_ref< void(const Value *)> Func=[](const Value *) {}) const
 Strip off pointer casts and inbounds GEPs.
 
ValuestripInBoundsOffsets (function_ref< void(const Value *)> Func=[](const Value *) {})
 
std::optional< int64_t > getPointerOffsetFrom (const Value *Other, const DataLayout &DL) const
 If this ptr is provably equal to Other plus a constant offset, return that offset in bytes.
 
bool canBeFreed () const
 Return true if the memory object referred to by V can by freed in the scope for which the SSA value defining the allocation is statically defined.
 
uint64_t getPointerDereferenceableBytes (const DataLayout &DL, bool &CanBeNull, bool &CanBeFreed) const
 Returns the number of bytes known to be dereferenceable for the pointer value.
 
Align getPointerAlignment (const DataLayout &DL) const
 Returns an alignment of the pointer value.
 
const ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB) const
 Translate PHI node to its predecessor from the given basic block.
 
ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB)
 
void mutateType (Type *Ty)
 Mutate the type of this Value to be of the specified type.
 
template<class Compare >
void sortUseList (Compare Cmp)
 Sort the use-list.
 
void reverseUseList ()
 Reverse the use-list.
 
void print (raw_ostream &O, bool IsForDebug=false) const
 Implement operator<< on Value.
 
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.
 
void printAsOperand (raw_ostream &O, bool PrintType, ModuleSlotTracker &MST) const
 
- Public Member Functions inherited from llvm::ilist_node_with_parent< BasicBlock, Function >
BasicBlockgetPrevNode ()
 
const BasicBlockgetPrevNode () const
 Get the previous node, or nullptr for the list head.
 
BasicBlockgetNextNode ()
 Get the next node, or nullptr for the list tail.
 
const BasicBlockgetNextNode () const
 Get the next node, or nullptr for the list tail.
 
- Public Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< T, 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.
 
- Public Member Functions inherited from llvm::ilist_detail::node_parent_access< NodeTy, ParentTy >
const ParentTy * getParent () const
 
ParentTy * getParent ()
 
void setParent (ParentTy *Parent)
 

Static Public Member Functions

static BasicBlockCreate (LLVMContext &Context, const Twine &Name="", Function *Parent=nullptr, BasicBlock *InsertBefore=nullptr)
 Creates a new BasicBlock.
 
static bool classof (const Value *V)
 Methods for support type inquiry through isa, cast, and dyn_cast.
 
- Static Public Member Functions inherited from llvm::Value
static void dropDroppableUse (Use &U)
 Remove the droppable use U.
 

Public Attributes

bool IsNewDbgInfoFormat
 Flag recording whether or not this block stores debug-info in the form of intrinsic instructions (false) or non-instruction records (true).
 

Friends

class BlockAddress
 
class SymbolTableListTraits< BasicBlock >
 
class llvm::SymbolTableListTraits< llvm::Instruction, ilist_iterator_bits< true >, ilist_parent< BasicBlock > >
 
class llvm::ilist_node_with_parent< llvm::Instruction, llvm::BasicBlock, ilist_iterator_bits< true >, ilist_parent< BasicBlock > >
 
void Instruction::removeFromParent ()
 
BasicBlock::iterator Instruction::eraseFromParent ()
 
BasicBlock::iterator Instruction::insertInto (BasicBlock *BB, BasicBlock::iterator It)
 
void Instruction::insertBefore (BasicBlock::iterator InsertPos)
 
void Instruction::insertAfter (Instruction *InsertPos)
 
void Instruction::insertBefore (BasicBlock &BB, InstListType::iterator InsertPos)
 
void Instruction::moveBeforeImpl (BasicBlock &BB, InstListType::iterator I, bool Preserve)
 
iterator_range< DbgRecord::self_iteratorInstruction::cloneDebugInfoFrom (const Instruction *From, std::optional< DbgRecord::self_iterator > FromHere, bool InsertAtHead)
 

Additional Inherited Members

- Static Public Attributes inherited from llvm::Value
static constexpr unsigned MaxAlignmentExponent = 32
 The maximum alignment for instructions.
 
static constexpr uint64_t MaximumAlignment = 1ULL << MaxAlignmentExponent
 
- Protected Types inherited from llvm::Value
enum  : unsigned { NumUserOperandsBits = 27 }
 The number of operands in the subclass. More...
 
- Protected Types inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< T, Options... >::type >
using self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, ilist_detail::compute_node_options< T, Options... >::type, false, false >::type
 
using const_self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, ilist_detail::compute_node_options< T, Options... >::type, false, true >::type
 
using reverse_self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, ilist_detail::compute_node_options< T, Options... >::type, true, false >::type
 
using const_reverse_self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, ilist_detail::compute_node_options< T, Options... >::type, true, true >::type
 
- 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.
 
void getAllMetadata (SmallVectorImpl< std::pair< unsigned, MDNode * > > &MDs) const
 Appends all metadata attached to this value to MDs, sorting by KindID.
 
bool hasMetadata () const
 Return true if this value has any metadata attached to it.
 
bool eraseMetadata (unsigned KindID)
 Erase all metadata attachments with the given kind.
 
void eraseMetadataIf (function_ref< bool(unsigned, MDNode *)> Pred)
 Erase all metadata attachments matching the given predicate.
 
void clearMetadata ()
 Erase all metadata attached to this Value.
 
MDNodegetMetadataImpl (unsigned KindID) const
 Get metadata for the given kind, if any.
 
unsigned short getSubclassDataFromValue () const
 
void setValueSubclassData (unsigned short D)
 
MDNodegetMetadata (unsigned KindID) const
 Get the current metadata attachments for the given kind, if any.
 
MDNodegetMetadata (StringRef Kind) const
 
void getMetadata (unsigned KindID, SmallVectorImpl< MDNode * > &MDs) const
 Appends all attachments with the given ID to MDs in insertion order.
 
void getMetadata (StringRef Kind, SmallVectorImpl< MDNode * > &MDs) const
 
bool hasMetadata (unsigned KindID) const
 Return true if this value has the given type of metadata attached.
 
bool hasMetadata (StringRef Kind) const
 
void setMetadata (unsigned KindID, MDNode *Node)
 Set a particular kind of metadata attachment.
 
void setMetadata (StringRef Kind, MDNode *Node)
 
void addMetadata (unsigned KindID, MDNode &MD)
 Add a metadata attachment.
 
void addMetadata (StringRef Kind, MDNode &MD)
 
- Protected Member Functions inherited from llvm::ilist_node_with_parent< BasicBlock, Function >
 ilist_node_with_parent ()=default
 
- Protected Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< T, Options... >::type >
 ilist_node_impl ()=default
 
- Protected Attributes inherited from llvm::Value
unsigned char SubclassOptionalData: 7
 Hold subclass data that can be dropped.
 
unsigned NumUserOperands: NumUserOperandsBits
 
unsigned IsUsedByMD: 1
 
unsigned HasName: 1
 
unsigned HasMetadata: 1
 
unsigned HasHungOffUses: 1
 
unsigned HasDescriptor: 1
 

Detailed Description

LLVM Basic Block Representation.

This represents a single basic block in LLVM. A basic block is simply a container of instructions that execute sequentially. Basic blocks are Values because they are referenced by instructions such as branches and switch tables. The type of a BasicBlock is "Type::LabelTy" because the basic block represents a label to which a branch can jump.

A well formed basic block is formed of a list of non-terminating instructions followed by a single terminator instruction. Terminator instructions may not occur in the middle of basic blocks, and must terminate the blocks. The BasicBlock class allows malformed basic blocks to occur because it may be useful in the intermediate stage of constructing or modifying a program. However, the verifier will ensure that basic blocks are "well formed".

Definition at line 59 of file BasicBlock.h.

Member Typedef Documentation

◆ const_iterator

Definition at line 167 of file BasicBlock.h.

◆ const_phi_iterator

Definition at line 495 of file BasicBlock.h.

◆ const_reverse_iterator

Definition at line 169 of file BasicBlock.h.

◆ InstListType

Definition at line 62 of file BasicBlock.h.

◆ iterator

Instruction iterators...

Definition at line 166 of file BasicBlock.h.

◆ phi_iterator

Definition at line 494 of file BasicBlock.h.

◆ reverse_iterator

Definition at line 168 of file BasicBlock.h.

Constructor & Destructor Documentation

◆ BasicBlock()

llvm::BasicBlock::BasicBlock ( const BasicBlock )
delete

◆ ~BasicBlock()

BasicBlock::~BasicBlock ( )

Member Function Documentation

◆ back() [1/2]

Instruction & llvm::BasicBlock::back ( )
inline

Definition at line 458 of file BasicBlock.h.

◆ back() [2/2]

const Instruction & llvm::BasicBlock::back ( ) const
inline

◆ begin() [1/2]

iterator llvm::BasicBlock::begin ( )
inline

Instruction iterator methods.

Definition at line 432 of file BasicBlock.h.

Referenced by llvm::calculateWasmEHInfo(), llvm::Interpreter::callFunction(), canLoopBeDeleted(), CanPropagatePredecessorsForPHIs(), canSplitCallSite(), llvm::CloneAndPruneIntoFromInst(), cloneInstructionInExitBlock(), llvm::FunctionComparator::cmpBasicBlocks(), llvm::IRSimilarity::IRInstructionMapper::convertToUnsignedVec(), llvm::SSAUpdaterTraits< SSAUpdater >::CreateEmptyPHI(), llvm::EpilogueVectorizerEpilogueLoop::createEpilogueVectorizedLoopSkeleton(), llvm::OpenMPIRBuilder::createParallel(), llvm::createPHIsForSplitLoopExit(), createRetBitCast(), createRetPHINode(), llvm::OpenMPIRBuilder::createSections(), llvm::OpenMPIRBuilder::createTask(), llvm::OpenMPIRBuilder::createTeams(), llvm::TileInfo::CreateTiledLoops(), despeculateCountZeros(), llvm::PostDominatorTree::dominates(), llvm::JumpThreadingPass::duplicateCondBranchOnPHIIntoPred(), llvm::DuplicateInstructionsInSplitBetween(), EliminateDuplicatePHINodesNaiveImpl(), EliminateDuplicatePHINodesSetBasedImpl(), llvm::OpenMPIRBuilder::emitCancelationCheckImpl(), ensureValueAvailableInSuccessor(), llvm::Evaluator::EvaluateFunction(), llvm::CodeExtractor::extractCodeRegion(), llvm::findAvailablePtrLoadStore(), findDependencies(), findDuplicateOutputBlock(), llvm::CodeExtractor::findOrCreateBlockForHoisting(), findOrCreatePHIInBlock(), llvm::SSAUpdaterTraits< SSAUpdater >::FindPredecessorBlocks(), llvm::InnerLoopVectorizer::fixFixedOrderRecurrence(), FoldCondBranchOnValueKnownInPredecessorImpl(), llvm::FoldSingleEntryPHINodes(), FoldTwoEntryPHINode(), llvm::formLCSSAForInstructions(), llvm::ScalarEvolution::getAddExpr(), llvm::CanonicalLoopInfo::getBodyIP(), llvm::MemoryDependenceResults::getDependency(), llvm::GetIfCondition(), llvm::MemoryDependenceResults::getNonLocalCallDependency(), llvm::MemoryDependenceResults::getSimplePointerDependencyFrom(), getStrlenWithNull(), llvm::SSAUpdater::GetValueInMiddleOfBlock(), HandleByValArgumentInit(), HandleInlinedEHPad(), llvm::hoistAllInstructionsInto(), llvm::InlineFunction(), InsertSafepointPoll(), insertSinCosCall(), insertSpills(), insertTrivialPHIs(), llvm::instrs(), isBlockValidForExtraction(), llvm::Value::isUsedInBasicBlock(), makeStatepointExplicitImpl(), llvm::MergeBasicBlockIntoOnlyPred(), llvm::MergeBlockIntoPredecessor(), llvm::InstCombinerImpl::mergeStoreIntoSuccessor(), moveBBContents(), movePHIValuesToInsertedBlock(), optimizeBlock(), optimizeSQRT(), phis(), ProcessBlock(), programUndefinedIfUndefOrPoison(), promoteMemoryToRegister(), reconnectPhis(), removePredecessor(), rewritePHINodesForExitAndUnswitchedBlocks(), RewriteUsesOfClonedInstructions(), runPass(), scalarizeMaskedCompressStore(), scalarizeMaskedExpandLoad(), scalarizeMaskedGather(), scalarizeMaskedLoad(), scalarizeMaskedScatter(), scalarizeMaskedStore(), scalarizeMaskedVectorHistogram(), scanInlinedCode(), SimplifyCondBranchToCondBranch(), llvm::SimplifyInstructionsInBlock(), llvm::JumpThreadingPass::simplifyPartiallyRedundantLoad(), llvm::sinkRegion(), sizeWithoutDebug(), splice(), splitBasicBlockBefore(), SplitBlockPredecessorsImpl(), splitCallSite(), llvm::OutlinableRegion::splitCandidate(), llvm::SplitIndirectBrCriticalEdges(), llvm::SplitKnownCriticalEdge(), llvm::splitLoopBound(), llvm::JumpThreadingPass::threadEdge(), llvm::JumpThreadingPass::threadGuard(), llvm::JumpThreadingPass::threadThroughTwoBasicBlocks(), TryToMergeLandingPad(), llvm::TryToSimplifyUncondBranchFromEmptyBlock(), llvm::JumpThreadingPass::tryToUnfoldSelectInCurrBB(), llvm::JumpThreadingPass::unfoldSelectInstr(), llvm::UnrollLoop(), unswitchTrivialSwitch(), UpdatePHINodes(), llvm::InstVisitor< SubClass, RetTy >::visit(), llvm::Interpreter::visitIntrinsicInst(), and workshareLoopTargetCallback().

◆ begin() [2/2]

const_iterator llvm::BasicBlock::begin ( ) const
inline

Definition at line 440 of file BasicBlock.h.

◆ canSplitPredecessors()

bool BasicBlock::canSplitPredecessors ( ) const

◆ classof()

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

Methods for support type inquiry through isa, cast, and dyn_cast.

Definition at line 543 of file BasicBlock.h.

◆ convertFromNewDbgValues()

void BasicBlock::convertFromNewDbgValues ( )

Convert variable location debugging information stored in DbgMarkers and DbgRecords into the dbg.value intrinsic representation.

Sets IsNewDbgInfoFormat = false.

Definition at line 115 of file BasicBlock.cpp.

References assert(), llvm::DbgMarker::eraseFromParent(), llvm::DbgMarker::getDbgRecordRange(), getModule(), getTrailingDbgRecords(), llvm::iplist_impl< IntrusiveListT, TraitsT >::insert(), invalidateOrders(), and IsNewDbgInfoFormat.

Referenced by setIsNewDbgInfoFormat().

◆ convertToNewDbgValues()

void BasicBlock::convertToNewDbgValues ( )

Convert variable location debugging information stored in dbg.value intrinsics into DbgMarkers / DbgRecords.

Deletes all dbg.values in the process and sets IsNewDbgInfoFormat = true. Only takes effect if the UseNewDbgInfoFormat LLVM command line option is given.

Definition at line 76 of file BasicBlock.cpp.

References assert(), createMarker(), llvm::SmallVectorBase< Size_T >::empty(), I, llvm::DbgMarker::insertDbgRecord(), IsNewDbgInfoFormat, llvm::make_early_inc_range(), and llvm::SmallVectorTemplateBase< T, bool >::push_back().

Referenced by setIsNewDbgInfoFormat().

◆ Create()

static BasicBlock * llvm::BasicBlock::Create ( LLVMContext Context,
const Twine Name = "",
Function Parent = nullptr,
BasicBlock InsertBefore = nullptr 
)
inlinestatic

Creates a new BasicBlock.

If the Parent parameter is specified, the basic block is automatically inserted at either the end of the function (if InsertBefore is 0), or before the specified basic block.

Definition at line 201 of file BasicBlock.h.

References Name.

Referenced by addBoundsChecking(), assureFPCallStub(), buildUMulWithOverflowFunc(), llvm::CloneBasicBlock(), convertToGuardPredicates(), createAndInsertBasicBlocks(), llvm::OpenMPIRBuilder::createCopyinClauseBlocks(), llvm::MIRParserImpl::createDummyFunction(), CreateFailBB(), createFPFnStub(), createFrameHelperMachineFunction(), llvm::RandomIRBuilder::createFunctionDefinition(), llvm::OpenMPIRBuilder::createLoopSkeleton(), llvm::createMemCpyLoopKnownSize(), createMemMoveLoop(), createMemSetLoop(), createOutlinedFunction(), llvm::OpenMPIRBuilder::createReductions(), llvm::createSanitizerCtor(), llvm::createSanitizerCtorAndInitFunctions(), llvm::OpenMPIRBuilder::createSections(), llvm::Attributor::createShallowWrapper(), llvm::OpenMPIRBuilder::createTargetInit(), llvm::ThunkInserter< Derived, InsertedThunksTy >::createThunkFunction(), createUnreachableSwitchDefault(), createWrapper(), llvm::ehAwareSplitEdge(), llvm::orc::IRSpeculationLayer::emit(), llvm::emitAMDGPUPrintfCall(), llvm::OpenMPIRBuilder::emitCancelationCheckImpl(), llvm::SITargetLowering::emitExpandAtomicRMW(), llvm::OpenMPIRBuilder::emitIfClause(), llvm::OpenMPIRBuilder::emitKernelLaunch(), expandFPToI(), expandIToFP(), expandToSwitch(), llvm::CodeExtractor::extractCodeRegion(), findOrCreatePHIBlock(), llvm::SanitizerStatReport::finish(), generateReproducer(), generateUnsignedDivisionCode(), getStrlenWithNull(), injectPendingInvariantConditions(), insertUniqueBackedgeBlock(), LLVMAppendBasicBlockInContext(), LLVMCreateBasicBlockInContext(), LLVMInsertBasicBlockInContext(), lowerFunnelShifts(), llvm::lowerGlobalIFuncUsersAsGlobalCtor(), lowerIntrinsicToFunction(), makeFunctionBodyUnreachable(), llvm::orc::makeStub(), markAliveBlocks(), MergeCompatibleInvokesImpl(), llvm::InsertCFGStrategy::mutate(), llvm::EscapeEnumerator::Next(), performBlockTailMerging(), processSwitch(), llvm::SCCPSolver::removeNonFeasibleEdges(), removeUndefIntroducingPredecessor(), rewritePHIsForCleanupPad(), runImpl(), llvm::SPIRVMergeRegionExitTargets::runOnConvergenceRegionNoRecurse(), SimplifyCondBranchToCondBranch(), splitAsyncCoroutine(), splitBasicBlock(), splitBasicBlockBefore(), llvm::splitBB(), llvm::SplitBlockAndInsertIfThenElse(), SplitBlockPredecessorsImpl(), llvm::SplitKnownCriticalEdge(), SplitLandingPadPredecessorsImpl(), splitRetconCoroutine(), SwitchToLookupTable(), llvm::JumpThreadingPass::threadEdge(), llvm::JumpThreadingPass::threadThroughTwoBasicBlocks(), and llvm::JumpThreadingPass::unfoldSelectInstr().

◆ createMarker() [1/2]

DbgMarker * BasicBlock::createMarker ( InstListType::iterator  It)

◆ createMarker() [2/2]

DbgMarker * BasicBlock::createMarker ( Instruction I)

Attach a DbgMarker to the given instruction.

Enables the storage of any debug-info at this position in the program.

Definition at line 52 of file BasicBlock.cpp.

References assert(), I, IsNewDbgInfoFormat, and llvm::DbgMarker::MarkedInstr.

Referenced by llvm::JumpThreadingPass::cloneInstructions(), convertToNewDbgValues(), createMarker(), flushTerminatorDbgRecords(), insertDbgRecordAfter(), insertDbgRecordBefore(), and reinsertInstInDbgRecords().

◆ deleteTrailingDbgRecords()

void BasicBlock::deleteTrailingDbgRecords ( )

Delete any trailing DbgRecords at the end of this block, see setTrailingDbgRecords.

Definition at line 1157 of file BasicBlock.cpp.

References llvm::LLVMContextImpl::deleteTrailingDbgRecords(), getContext(), and llvm::LLVMContext::pImpl.

Referenced by llvm::Instruction::adoptDbgRecords(), and flushTerminatorDbgRecords().

◆ dropAllReferences()

void BasicBlock::dropAllReferences ( )

Cause all subinstructions to "let go" of all the references that said subinstructions are maintaining.

This allows one to 'delete' a whole class at a time, even though there may be circular references... first all references are dropped, and all use counts go to zero. Then everything is delete'd for real. Note that no operations are valid on an object that has "dropped all references", except operator delete.

Definition at line 448 of file BasicBlock.cpp.

References I.

Referenced by ~BasicBlock().

◆ dumpDbgValues()

void BasicBlock::dumpDbgValues ( ) const

Definition at line 141 of file BasicBlock.cpp.

References llvm::dbgs().

◆ empty()

bool llvm::BasicBlock::empty ( ) const
inline

Definition at line 454 of file BasicBlock.h.

Referenced by llvm::OpenMPIRBuilder::finalize(), phis(), and removePredecessor().

◆ end() [1/2]

iterator llvm::BasicBlock::end ( )
inline

Definition at line 445 of file BasicBlock.h.

Referenced by llvm::Instruction::adoptDbgRecords(), buildPartialInvariantUnswitchConditionalBranch(), llvm::MemorySSAUpdater::changeToUnreachable(), llvm::changeToUnreachable(), llvm::CloneBasicBlock(), llvm::JumpThreadingPass::cloneInstructions(), llvm::FunctionComparator::cmpBasicBlocks(), llvm::ConvertDebugDeclareToDebugValue(), llvm::IRSimilarity::IRInstructionMapper::convertToUnsignedVec(), llvm::convertUsersOfConstantsToInstructions(), createMarker(), llvm::OpenMPIRBuilder::createReductions(), createSwitchStatement(), createTargetLoopWorkshareCall(), createWrapper(), detectPopcountIdiom(), detectShiftUntilZeroIdiom(), llvm::JumpThreadingPass::duplicateCondBranchOnPHIIntoPred(), llvm::OpenMPIRBuilder::emitCancelationCheckImpl(), llvm::SITargetLowering::emitExpandAtomicRMW(), llvm::CodeExtractor::extractCodeRegion(), findDependencies(), llvm::CodeExtractor::findOrCreateBlockForHoisting(), llvm::InstCombinerImpl::foldIntegerTypedPHI(), llvm::FoldReturnIntoUncondBranch(), getFirstInsertionPt(), getFirstNonPHIIt(), getFirstNonPHIOrDbgOrAlloca(), llvm::Instruction::getInsertionPointAfterDef(), getInsertionRange(), getInsertPt(), getInstrBB(), getMarker(), llvm::MemoryDependenceResults::getNonLocalCallDependency(), llvm::CanonicalLoopInfo::getPreheaderIP(), llvm::objcarc::BottomUpPtrState::HandlePotentialUse(), llvm::hoistAllInstructionsInto(), llvm::DIBuilder::insertDbgAssign(), insertDbgRecordBefore(), insertDbgVariableRecordsForPHIs(), llvm::insertDebugValuesForPHIs(), llvm::Instruction::insertInto(), InsertSafepointPoll(), llvm::instrs(), instrumentOneFunc(), llvm::SampleProfileProber::instrumentOneFunc(), isBlockValidForExtraction(), llvm::isInTailCallPosition(), llvm::Value::isUsedInBasicBlock(), llvm::MergeBlockIntoPredecessor(), MergeCompatibleInvokesImpl(), moveBBContents(), llvm::RandomIRBuilder::newSource(), optimizeBlock(), OptimizeExtractBits(), performBlockTailMerging(), llvm::PrepareToSplitEntryBlock(), ProcessBlock(), programUndefinedIfUndefOrPoison(), promoteMemoryToRegister(), reconnectPhis(), replaceArgumentUses(), RewriteUsesOfClonedInstructions(), llvm::IRBuilderBase::SetInsertPoint(), shouldInstrumentBlock(), llvm::SimplifyInstructionsInBlock(), llvm::JumpThreadingPass::simplifyPartiallyRedundantLoad(), simplifyUsingControlFlow(), SinkCast(), sinkCmpExpression(), llvm::sinkRegion(), SinkShiftAndTruncate(), sizeWithoutDebug(), splice(), llvm::spliceBB(), llvm::VPBasicBlock::splitAt(), splitBasicBlock(), llvm::JumpThreadingPass::threadEdge(), llvm::JumpThreadingPass::threadGuard(), llvm::JumpThreadingPass::threadThroughTwoBasicBlocks(), llvm::JumpThreadingPass::unfoldSelectInstr(), unswitchTrivialBranch(), llvm::slpvectorizer::BoUpSLP::vectorizeTree(), llvm::InstVisitor< SubClass, RetTy >::visit(), and workshareLoopTargetCallback().

◆ end() [2/2]

const_iterator llvm::BasicBlock::end ( ) const
inline

Definition at line 446 of file BasicBlock.h.

◆ erase()

BasicBlock::iterator BasicBlock::erase ( BasicBlock::iterator  FromIt,
BasicBlock::iterator  ToIt 
)

Erases a range of instructions from FromIt to (not including) ToIt.

\Returns ToIt.

Definition at line 640 of file BasicBlock.cpp.

References I, llvm::make_early_inc_range(), and llvm::make_range().

◆ eraseFromParent()

◆ flushTerminatorDbgRecords()

void BasicBlock::flushTerminatorDbgRecords ( )

Eject any debug-info trailing at the end of a block.

DbgRecords can transiently be located "off the end" of a block if the blocks terminator is temporarily removed. Once a terminator is re-inserted this method will move such DbgRecords back to the right place (ahead of the terminator).

Definition at line 713 of file BasicBlock.cpp.

References createMarker(), deleteTrailingDbgRecords(), llvm::DbgMarker::eraseFromParent(), getTerminator(), getTrailingDbgRecords(), and IsNewDbgInfoFormat.

Referenced by llvm::changeToUnreachable(), and splice().

◆ front() [1/2]

Instruction & llvm::BasicBlock::front ( )
inline

Definition at line 456 of file BasicBlock.h.

◆ front() [2/2]

const Instruction & llvm::BasicBlock::front ( ) const
inline

◆ getContext()

LLVMContext & BasicBlock::getContext ( ) const

Get the context in which this basic block lives.

Definition at line 168 of file BasicBlock.cpp.

References llvm::Type::getContext(), and llvm::Value::getType().

Referenced by addBasicBlockMetadata(), llvm::addStringMetadataToLoop(), llvm::LoopVersioning::annotateInstWithNoAlias(), llvm::CloneBasicBlock(), llvm::JumpThreadingPass::cloneInstructions(), llvm::ConstantFoldTerminator(), llvm::createMemCpyLoopKnownSize(), createStringMetadata(), llvm::OpenMPIRBuilder::createTargetInit(), createUnreachableSwitchDefault(), deleteTrailingDbgRecords(), llvm::ehAwareSplitEdge(), llvm::OpenMPIRBuilder::emitCancelationCheckImpl(), llvm::LoopVectorizationPlanner::executePlan(), llvm::CodeExtractor::extractCodeRegion(), findOrCreatePHIBlock(), llvm::DbgRecord::getContext(), getTrailingDbgRecords(), llvm::HardwareLoopInfo::HardwareLoopInfo(), llvm::BPFCoreSharedInfo::insertPassThrough(), LLVMGetCurrentDebugLocation(), LLVMGetMDNodeOperands(), LLVMGetNamedMetadataOperands(), llvm::MergeBasicBlockIntoOnlyPred(), llvm::MergeBlockIntoPredecessor(), llvm::parseWidenableBranch(), llvm::LoopVersioning::prepareNoAliasMetadata(), llvm::JumpThreadingPass::processBranchOnXOR(), processSwitch(), llvm::SCCPSolver::removeNonFeasibleEdges(), removeUndefIntroducingPredecessor(), rewritePHIsForCleanupPad(), llvm::LoopVectorizeHints::setAlreadyVectorized(), llvm::Loop::setLoopAlreadyUnrolled(), llvm::Loop::setLoopMustProgress(), setTrailingDbgRecords(), SimplifyCondBranchToCondBranch(), splitBasicBlock(), splitBasicBlockBefore(), llvm::splitBB(), llvm::SplitBlockAndInsertIfThenElse(), SplitBlockPredecessorsImpl(), SplitLandingPadPredecessorsImpl(), llvm::splitLoopBound(), llvm::JumpThreadingPass::threadEdge(), llvm::JumpThreadingPass::threadThroughTwoBasicBlocks(), llvm::TryToSimplifyUncondBranchFromEmptyBlock(), llvm::JumpThreadingPass::unfoldSelectInstr(), llvm::LoopVersioning::versionLoop(), and ~BasicBlock().

◆ getFirstInsertionPt() [1/2]

iterator llvm::BasicBlock::getFirstInsertionPt ( )
inline

Definition at line 308 of file BasicBlock.h.

References getFirstInsertionPt().

◆ getFirstInsertionPt() [2/2]

BasicBlock::const_iterator BasicBlock::getFirstInsertionPt ( ) const

Returns an iterator to the first instruction in this block that is suitable for inserting a non-PHI instruction.

In particular, it skips all PHIs and LandingPad instructions.

Definition at line 410 of file BasicBlock.cpp.

References end(), getFirstNonPHI(), and llvm::ilist_node_impl< OptionsT >::getIterator().

Referenced by cloneInstructionInExitBlock(), llvm::ConvertDebugDeclareToDebugValue(), llvm::convertUsersOfConstantsToInstructions(), llvm::OpenMPIRBuilder::createParallel(), llvm::RandomIRBuilder::createStackMemory(), llvm::OpenMPIRBuilder::createTargetInit(), DbgInserterHelper(), llvm::VPWidenIntOrFpInductionRecipe::execute(), llvm::VPFirstOrderRecurrencePHIRecipe::execute(), llvm::VPReductionPHIRecipe::execute(), llvm::VPCanonicalIVPHIRecipe::execute(), llvm::CodeExtractor::extractCodeRegion(), llvm::RandomIRBuilder::findOrCreateSource(), foldDependentIVs(), foldGuardedFunnelShift(), llvm::InstCombinerImpl::foldIntegerTypedPHI(), getFirstInsertionPt(), llvm::Instruction::getInsertionPointAfterDef(), getInsertionRange(), getInsertPt(), getInstrBB(), llvm::objcarc::BottomUpPtrState::HandlePotentialUse(), llvm::objcarc::BundledRetainClaimRVs::insertAfterInvokes(), insertDbgVariableRecordsForPHIs(), llvm::insertDebugValuesForPHIs(), insertSpills(), instrumentOneFunc(), llvm::SampleProfileProber::instrumentOneFunc(), llvm::invertCondition(), makeStatepointExplicitImpl(), mergeConditionalStoreToAddress(), llvm::InstCombinerImpl::mergeStoreIntoSuccessor(), llvm::ShuffleBlockStrategy::mutate(), llvm::InstDeleterIRStrategy::mutate(), llvm::RandomIRBuilder::newSource(), OptimizeExtractBits(), llvm::InstCombinerImpl::run(), setInsertionPoint(), shouldInstrumentBlock(), simplifyUsingControlFlow(), SinkCast(), sinkCmpExpression(), SinkInstruction(), sinkInstruction(), SinkShiftAndTruncate(), llvm::OutlinableRegion::splitCandidate(), llvm::SplitIndirectBrCriticalEdges(), SplitLandingPadPredecessorsImpl(), targetParallelCallback(), llvm::JumpThreadingPass::threadGuard(), llvm::InstCombinerImpl::tryToSinkInstruction(), and llvm::ObjectSizeOffsetEvaluator::visitPHINode().

◆ getFirstMayFaultInst() [1/2]

Instruction * llvm::BasicBlock::getFirstMayFaultInst ( )
inline

Definition at line 326 of file BasicBlock.h.

References getFirstMayFaultInst().

◆ getFirstMayFaultInst() [2/2]

const Instruction * BasicBlock::getFirstMayFaultInst ( ) const

Returns the first potential AsynchEH faulty instruction currently it checks for loads/stores (which may dereference a null pointer) and calls/invokes (which may propagate exceptions)

Definition at line 352 of file BasicBlock.cpp.

References I.

Referenced by getFirstMayFaultInst().

◆ getFirstNonPHI() [1/2]

Instruction * llvm::BasicBlock::getFirstNonPHI ( )
inline

Definition at line 267 of file BasicBlock.h.

References getFirstNonPHI().

◆ getFirstNonPHI() [2/2]

const Instruction * BasicBlock::getFirstNonPHI ( ) const

Returns a pointer to the first instruction in this block that is not a PHINode instruction.

When adding instructions to the beginning of the basic block, they should be added before the returned value, not before the first instruction, which might be PHI. Returns 0 is there's no non-PHI instruction.

Definition at line 361 of file BasicBlock.cpp.

References I.

Referenced by llvm::MachineFunction::addLandingPad(), llvm::calculateClrEHStateNumbers(), llvm::calculateCXXStateForAsynchEH(), llvm::calculateSEHStateForAsynchEH(), calculateStateNumbersForInvokes(), llvm::calculateWasmEHInfo(), canSplitPredecessors(), canSplitPredecessors(), cloneInstructionInExitBlock(), llvm::colorEHFunclets(), llvm::EpilogueVectorizerEpilogueLoop::createEpilogueVectorizedLoopSkeleton(), llvm::InnerLoopVectorizer::createInductionResumeValue(), llvm::createMemCpyLoopKnownSize(), createOutlinedFunction(), llvm::createPHIsForSplitLoopExit(), detectPopcountIdiom(), detectShiftUntilZeroIdiom(), llvm::ehAwareSplitEdge(), llvm::CodeExtractor::findOrCreateBlockForHoisting(), findUnwindDestinations(), findWasmUnwindDestinations(), getFirstInsertionPt(), getFirstNonPHI(), getFirstNonPHIIt(), getFirstNonPHIOrDbgOrAlloca(), getLandingPadInst(), getSuccPad(), getUnwindDestTokenHelper(), llvm::SSAUpdater::GetValueInMiddleOfBlock(), HandleInlinedEHPad(), hasCallsInBlocksBetween(), llvm::InlineFunction(), insertDbgVariableRecordsForPHIs(), llvm::insertDebugValuesForPHIs(), isEHPad(), isLandingPad(), markAliveBlocks(), llvm::Instruction::mayThrow(), moveLCSSAPhis(), programUndefinedIfUndefOrPoison(), raiseUserConstantDataAllocasToEntryBlock(), relocationViaAlloca(), removeEmptyCleanup(), rewritePHIs(), runMoveAutoInit(), llvm::SplitBlockAndInsertSimpleForLoop(), and SplitLandingPadPredecessorsImpl().

◆ getFirstNonPHIIt() [1/2]

InstListType::iterator llvm::BasicBlock::getFirstNonPHIIt ( )
inline

Definition at line 275 of file BasicBlock.h.

References getFirstNonPHIIt().

◆ getFirstNonPHIIt() [2/2]

BasicBlock::const_iterator BasicBlock::getFirstNonPHIIt ( ) const

Iterator returning form of getFirstNonPHI.

Installed as a placeholder for the RemoveDIs project that will eventually remove debug intrinsics.

Definition at line 368 of file BasicBlock.cpp.

References end(), getFirstNonPHI(), and I.

Referenced by CloneLoopBlocks(), ConnectEpilog(), ConnectProlog(), llvm::EpilogueVectorizerEpilogueLoop::createEpilogueVectorizedLoopSkeleton(), llvm::InnerLoopVectorizer::fixVectorizedLoop(), getFirstNonPHIIt(), hoist(), llvm::InstCombinerImpl::run(), and llvm::TryToSimplifyUncondBranchFromEmptyBlock().

◆ getFirstNonPHIOrDbg() [1/2]

Instruction * llvm::BasicBlock::getFirstNonPHIOrDbg ( bool  SkipPseudoOp = true)
inline

Definition at line 286 of file BasicBlock.h.

References getFirstNonPHIOrDbg().

◆ getFirstNonPHIOrDbg() [2/2]

const Instruction * BasicBlock::getFirstNonPHIOrDbg ( bool  SkipPseudoOp = true) const

◆ getFirstNonPHIOrDbgOrAlloca() [1/2]

iterator llvm::BasicBlock::getFirstNonPHIOrDbgOrAlloca ( )
inline

Definition at line 316 of file BasicBlock.h.

References getFirstNonPHIOrDbgOrAlloca().

◆ getFirstNonPHIOrDbgOrAlloca() [2/2]

BasicBlock::const_iterator BasicBlock::getFirstNonPHIOrDbgOrAlloca ( ) const

Returns an iterator to the first instruction in this block that is not a PHINode, a debug intrinsic, a static alloca or any pseudo operation.

Definition at line 424 of file BasicBlock.cpp.

References end(), End, getFirstNonPHI(), llvm::ilist_node_impl< OptionsT >::getIterator(), and isEntryBlock().

Referenced by llvm::InstCombinerImpl::freezeOtherUses(), getFirstNonPHIOrDbgOrAlloca(), getFreezeInsertPt(), and llvm::IRBuilderBase::SetInsertPointPastAllocas().

◆ getFirstNonPHIOrDbgOrLifetime() [1/2]

Instruction * llvm::BasicBlock::getFirstNonPHIOrDbgOrLifetime ( bool  SkipPseudoOp = true)
inline

Definition at line 297 of file BasicBlock.h.

References getFirstNonPHIOrDbgOrLifetime().

◆ getFirstNonPHIOrDbgOrLifetime() [2/2]

const Instruction * BasicBlock::getFirstNonPHIOrDbgOrLifetime ( bool  SkipPseudoOp = true) const

Returns a pointer to the first instruction in this block that is not a PHINode, a debug intrinsic, or a lifetime intrinsic, or any pseudo operation if SkipPseudoOp is true.

Definition at line 394 of file BasicBlock.cpp.

References I.

Referenced by getFirstNonPHIOrDbgOrLifetime(), shouldInstrumentBlock(), and llvm::SplitKnownCriticalEdge().

◆ getIrrLoopHeaderWeight()

std::optional< uint64_t > BasicBlock::getIrrLoopHeaderWeight ( ) const

◆ getLandingPadInst() [1/2]

LandingPadInst * llvm::BasicBlock::getLandingPadInst ( )
inline

Definition at line 669 of file BasicBlock.h.

References getLandingPadInst().

◆ getLandingPadInst() [2/2]

const LandingPadInst * BasicBlock::getLandingPadInst ( ) const

Return the landingpad instruction associated with the landing pad.

Definition at line 677 of file BasicBlock.cpp.

References getFirstNonPHI().

Referenced by getLandingPadInst(), makeStatepointExplicitImpl(), and SplitLandingPadPredecessorsImpl().

◆ getMarker()

DbgMarker * BasicBlock::getMarker ( InstListType::iterator  It)

Return the DbgMarker for the position given by It, so that DbgRecords can be inserted there.

This will either be nullptr if not present, a DbgMarker, or TrailingDbgRecords if It is end().

Definition at line 1072 of file BasicBlock.cpp.

References DM, end(), and getTrailingDbgRecords().

Referenced by llvm::Instruction::adoptDbgRecords(), llvm::JumpThreadingPass::cloneInstructions(), llvm::formLCSSAForInstructions(), getNextMarker(), llvm::Instruction::insertBefore(), and RewriteUsesOfClonedInstructions().

◆ getModule() [1/2]

Module * llvm::BasicBlock::getModule ( )
inline

Definition at line 216 of file BasicBlock.h.

References getModule().

◆ getModule() [2/2]

const Module * BasicBlock::getModule ( ) const

Return the module owning the function this basic block belongs to, or nullptr if the function does not have a module.

Note: this is undefined behavior if the block does not have a parent.

Definition at line 290 of file BasicBlock.cpp.

References llvm::GlobalValue::getParent(), and getParent().

Referenced by callAppendArgs(), callAppendStringN(), callBufferedPrintfArgPush(), callBufferedPrintfStart(), callPrintfBegin(), CanProveNotTakenFirstIteration(), computeAllocaDefaultAlign(), computeLoadStoreDefaultAlign(), computeUnlikelySuccessors(), llvm::JumpThreadingPass::computeValueKnownInPredecessorsImpl(), convertFromNewDbgValues(), llvm::IRBuilderBase::CreateAlignedLoad(), llvm::IRBuilderBase::CreateAlignedStore(), llvm::IRBuilderBase::CreateAlloca(), createAllocaInstAtEntry(), llvm::IRBuilderBase::CreateAtomicCmpXchg(), llvm::IRBuilderBase::CreateAtomicRMW(), llvm::IRBuilderBase::CreateBinaryIntrinsic(), llvm::IRBuilderBase::CreateIntrinsic(), llvm::IRBuilderBase::CreateNoAliasScopeDeclaration(), createOutlinedFunction(), llvm::IRBuilderBase::CreateStackSave(), llvm::IRBuilderBase::CreateUnaryIntrinsic(), createWrapper(), llvm::JumpThreadingPass::duplicateCondBranchOnPHIIntoPred(), llvm::emitAMDGPUPrintfCall(), llvm::VPWidenCallRecipe::execute(), llvm::VPVectorPointerRecipe::execute(), llvm::VPExpandSCEVRecipe::execute(), llvm::findAvailablePtrLoadStore(), getAllocaPos(), llvm::LazyValueInfo::getConstant(), llvm::LazyValueInfo::getConstantOnEdge(), llvm::LazyValueInfo::getConstantRange(), llvm::LazyValueInfo::getConstantRangeOnEdge(), getModule(), llvm::VectorBuilder::getModule(), llvm::MemoryDependenceResults::getNonLocalPointerDependency(), llvm::LazyValueInfo::getPredicateOnEdge(), llvm::getPtrStride(), llvm::MemoryDependenceResults::getSimplePointerDependencyFrom(), getStartAndEndForAccess(), llvm::SSAUpdater::GetValueInMiddleOfBlock(), llvm::JumpThreadingPass::maybethreadThroughTwoBasicBlocks(), llvm::LoopStructure::parseLoopStructure(), performBranchToCommonDestFolding(), print(), llvm::JumpThreadingPass::processBlock(), llvm::JumpThreadingPass::processImpliedCondition(), processNonStringArg(), llvm::promoteLoopAccessesToScalars(), reuseTableCompare(), llvm::simplifyCFG(), llvm::SimplifyInstructionsInBlock(), llvm::JumpThreadingPass::threadGuard(), and llvm::LoopVersioning::versionLoop().

◆ getNextMarker()

DbgMarker * BasicBlock::getNextMarker ( Instruction I)

Return the DbgMarker for the position that comes after I.

See also
BasicBlock::getMarker, this can be nullptr, a DbgMarker, or TrailingDbgRecords if there is no next instruction.

Definition at line 1068 of file BasicBlock.cpp.

References getMarker(), and I.

Referenced by reinsertInstInDbgRecords().

◆ getParent() [1/2]

Function * llvm::BasicBlock::getParent ( )
inline

Definition at line 209 of file BasicBlock.h.

◆ getParent() [2/2]

const Function * llvm::BasicBlock::getParent ( ) const
inline

Return the enclosing method, or null if none.

Definition at line 208 of file BasicBlock.h.

Referenced by addReplicateRegions(), llvm::CodeMetrics::analyzeBasicBlock(), calculateCXXStateNumbers(), calculateSEHStateNumbers(), callIntrinsic(), canProveExitOnFirstIteration(), llvm::JumpThreadingPass::cloneInstructions(), llvm::cloneLoopWithPreheader(), llvm::OpenMPIRBuilder::collapseLoops(), llvm::colorEHFunclets(), CompareValueComplexity(), computeAllocaDefaultAlign(), llvm::LoopSafetyInfo::computeBlockColors(), computeLoadStoreDefaultAlign(), llvm::RandomIRBuilder::connectToSink(), convertToRelLookupTable(), copyMustTailReturn(), createAllocaInstAtEntry(), llvm::IRBuilderBase::CreateAssumption(), llvm::OpenMPIRBuilder::createCanonicalLoop(), llvm::IRSimilarity::IRSimilarityCandidate::createCanonicalRelationFrom(), llvm::OpenMPIRBuilder::createCopyinClauseBlocks(), llvm::IRBuilderBase::CreateElementUnorderedAtomicMemCpy(), llvm::IRBuilderBase::CreateElementUnorderedAtomicMemMove(), llvm::IRBuilderBase::CreateElementUnorderedAtomicMemSet(), llvm::IRBuilderBase::CreateFAddReduce(), createFFSIntrinsic(), llvm::IRBuilderBase::CreateFMulReduce(), llvm::IRBuilderBase::CreateFree(), llvm::IRBuilderBase::CreateGCGetPointerBase(), llvm::IRBuilderBase::CreateGCGetPointerOffset(), llvm::IRBuilderBase::CreateGCRelocate(), llvm::IRBuilderBase::CreateGCResult(), CreateGCStatepointCallCommon(), CreateGCStatepointInvokeCommon(), llvm::IRBuilderBase::CreateGlobalString(), llvm::IRBuilderBase::CreateInvariantStart(), llvm::IRBuilderBase::createIsFPClass(), llvm::IRBuilderBase::CreateLaunderInvariantGroup(), llvm::IRBuilderBase::CreateLifetimeEnd(), llvm::IRBuilderBase::CreateLifetimeStart(), llvm::IRBuilderBase::CreateMalloc(), llvm::createMemCpyLoopKnownSize(), createMemMoveLoop(), llvm::IRBuilderBase::CreateMemSet(), llvm::IRBuilderBase::CreateMemSetInline(), createMemSetLoop(), llvm::IRBuilderBase::CreateMemTransferInst(), llvm::OpenMPIRBuilder::createParallel(), createPopcntIntrinsic(), llvm::IRBuilderBase::CreatePreserveArrayAccessIndex(), llvm::IRBuilderBase::CreatePreserveStructAccessIndex(), llvm::IRBuilderBase::CreatePreserveUnionAccessIndex(), llvm::OpenMPIRBuilder::createReductions(), llvm::IRBuilderBase::CreateStripInvariantGroup(), llvm::OpenMPIRBuilder::createTargetDeinit(), llvm::OpenMPIRBuilder::createTargetInit(), llvm::OpenMPIRBuilder::createTask(), llvm::OpenMPIRBuilder::createTeams(), createUnreachableSwitchDefault(), llvm::IRBuilderBase::CreateVectorReverse(), llvm::IRBuilderBase::CreateVectorSplice(), llvm::IRBuilderBase::CreateVScale(), llvm::ehAwareSplitEdge(), llvm::orc::IRSpeculationLayer::emit(), llvm::emitAMDGPUPrintfCall(), llvm::AArch64TargetLowering::emitAtomicCmpXchgNoStoreLLBalance(), llvm::ARMTargetLowering::emitAtomicCmpXchgNoStoreLLBalance(), llvm::OpenMPIRBuilder::emitBlock(), llvm::OpenMPIRBuilder::emitCancelationCheckImpl(), llvm::SITargetLowering::emitExpandAtomicRMW(), llvm::OpenMPIRBuilder::emitIfClause(), llvm::OpenMPIRBuilder::emitKernelLaunch(), llvm::AArch64TargetLowering::emitLoadLinked(), llvm::ARMTargetLowering::emitLoadLinked(), llvm::HexagonTargetLowering::emitLoadLinked(), llvm::PPCTargetLowering::emitMaskedAtomicCmpXchgIntrinsic(), llvm::PPCTargetLowering::emitMaskedAtomicRMWIntrinsic(), llvm::InnerLoopVectorizer::emitMemRuntimeChecks(), llvm::InnerLoopVectorizer::emitSCEVChecks(), llvm::AArch64TargetLowering::emitStoreConditional(), llvm::ARMTargetLowering::emitStoreConditional(), llvm::HexagonTargetLowering::emitStoreConditional(), llvm::PPCTargetLowering::emitTrailingFence(), eraseFromParent(), expandToSwitch(), llvm::CodeExtractor::extractCodeRegion(), llvm::CodeExtractor::findAllocas(), llvm::MustBeExecutedContextExplorer::findBackwardJoinPoint(), llvm::OutlinableRegion::findCorrespondingBlockIn(), llvm::MustBeExecutedContextExplorer::findForwardJoinPoint(), findOrCreatePHIBlock(), llvm::RandomIRBuilder::findOrCreateSource(), llvm::InstCombinerImpl::foldAggregateConstructionIntoAggregateReuse(), llvm::FoldBranchToCommonDest(), llvm::InstCombinerImpl::foldIntegerTypedPHI(), llvm::formLCSSAForInstructions(), generateUnsignedDivisionCode(), llvm::BlockAddress::get(), llvm::AddrLabelMap::getAddrLabelSymbolToEmit(), getAllocaPos(), llvm::memtag::getAndroidSlotPtr(), llvm::IRBuilderBase::getCurrentFunctionReturnType(), llvm::TargetLoweringBase::getDefaultSafeStackPointerLocation(), llvm::BlockCoverageInference::getDependencies(), llvm::MemoryDependenceResults::getDependency(), getDominatees(), getDominators(), llvm::memtag::getFP(), llvm::IRSimilarity::IRSimilarityCandidate::getFunction(), llvm::DbgRecord::getFunction(), llvm::Trace::getFunction(), llvm::OpenMPIRBuilder::OutlineInfo::getFunction(), llvm::ValueEnumerator::getGlobalBasicBlockID(), llvm::Instruction::getInsertionPointAfterDef(), llvm::TargetLoweringBase::getIRStackGuard(), llvm::X86TargetLowering::getIRStackGuard(), getModule(), getModuleFromDPI(), llvm::MemoryDependenceResults::getNonLocalCallDependency(), llvm::OpenMPIRBuilder::getOrCreateSrcLocStr(), llvm::memtag::getPC(), llvm::getPtrStride(), llvm::TargetLoweringBase::getSafeStackPointerLocation(), llvm::MemoryDependenceResults::getSimplePointerDependencyFrom(), llvm::GCProjectionInst::getStatepoint(), getValueSymbolTable(), HandleByValArgumentInit(), HandleInlinedEHPad(), HandleInlinedLandingPad(), hostParallelCallback(), llvm::InlineFunction(), insertBoundsCheck(), InsertSafepointPoll(), insertSpills(), llvm::invertCondition(), llvm::Attributor::isAssumedDead(), llvm::ScalarEvolution::isBasicBlockEntryGuardedByCond(), llvm::LoopVectorizationLegality::isConsecutivePtr(), isEntryBlock(), isExplicitVecOuterLoop(), llvm::isInTailCallPosition(), llvm::EarliestEscapeInfo::isNotCapturedBefore(), llvm::isPresplitCoroSuspendExitEdge(), LLVMBuildLandingPad(), LLVMInsertBasicBlockInContext(), LLVMInsertExistingBasicBlockAfterInsertBlock(), llvm::BlockAddress::lookup(), llvm::ARMTargetLowering::makeDMB(), memoryIsNotModifiedBetween(), llvm::MergeBasicBlockIntoOnlyPred(), MergeCompatibleInvokesImpl(), moveAfter(), moveBefore(), moveLCSSAPhis(), llvm::InsertFunctionStrategy::mutate(), llvm::InsertCFGStrategy::mutate(), llvm::InsertPHIStrategy::mutate(), llvm::RandomIRBuilder::newSink(), llvm::RandomIRBuilder::newSource(), nullifySetjmp(), placeSplitBlockCarefully(), llvm::PrepareToSplitEntryBlock(), llvm::MemorySSA::print(), print(), llvm::DbgLabelRecord::print(), llvm::DbgVariableRecord::print(), printBBName(), llvm::EpilogueVectorizerMainLoop::printDebugTracesAtEnd(), llvm::EpilogueVectorizerEpilogueLoop::printDebugTracesAtEnd(), printIRBlockReference(), llvm::JumpThreadingPass::processBlock(), processSwitch(), programUndefinedIfUndefOrPoison(), llvm::memtag::readRegister(), removeFromParent(), llvm::SCCPSolver::removeNonFeasibleEdges(), llvm::RemoveRedundantDbgInstrs(), removeUndefIntroducingPredecessor(), replaceConstantExprOp(), replaceExtractElements(), llvm::SSAUpdaterBulk::RewriteAllUses(), rewritePHIsForCleanupPad(), llvm::SPIRVMergeRegionExitTargets::runOnConvergenceRegionNoRecurse(), scanOneBB(), llvm::LoopVectorizationPlanner::selectEpilogueVectorizationFactor(), llvm::IRBuilderBase::setConstrainedFPFunctionAttr(), llvm::VPTransformState::setDebugLocFrom(), llvm::IRBuilderBase::SetInsertPoint(), llvm::BlockCoverageInference::shouldInstrumentBlock(), SimplifyCondBranchToCondBranch(), sinkLifetimeStartMarkers(), sinkLoopInvariantInstructions(), splitBasicBlock(), splitBasicBlockBefore(), llvm::splitBB(), llvm::SplitBlockAndInsertIfThenElse(), SplitBlockPredecessorsImpl(), llvm::SplitKnownCriticalEdge(), SplitLandingPadPredecessorsImpl(), SwitchToLookupTable(), targetParallelCallback(), llvm::JumpThreadingPass::threadEdge(), llvm::JumpThreadingPass::threadThroughTwoBasicBlocks(), llvm::OpenMPIRBuilder::tileLoops(), llvm::TryToSimplifyUncondBranchFromEmptyBlock(), llvm::JumpThreadingPass::tryToUnfoldSelectInCurrBB(), llvm::JumpThreadingPass::unfoldSelectInstr(), UpdateAnalysisInformation(), llvm::AddrLabelMap::UpdateForDeletedBlock(), useFuncSeen(), UseTlsOffset(), useTpOffset(), validateAndCostRequiredSelects(), llvm::InstCombinerImpl::visitAnd(), llvm::InstCombinerImpl::visitOr(), llvm::InstCombinerImpl::visitXor(), and ~BasicBlock().

◆ getPostdominatingDeoptimizeCall() [1/2]

CallInst * llvm::BasicBlock::getPostdominatingDeoptimizeCall ( )
inline

Definition at line 246 of file BasicBlock.h.

References getPostdominatingDeoptimizeCall().

◆ getPostdominatingDeoptimizeCall() [2/2]

const CallInst * BasicBlock::getPostdominatingDeoptimizeCall ( ) const

Returns the call instruction calling @llvm.experimental.deoptimize that is present either in current basic block or in block that is a unique successor to current block, if such call is present.

Otherwise, returns null.

Definition at line 340 of file BasicBlock.cpp.

References getTerminatingDeoptimizeCall(), getUniqueSuccessor(), and llvm::SmallPtrSetImpl< PtrType >::insert().

Referenced by canRotateDeoptimizingLatchExit(), and getPostdominatingDeoptimizeCall().

◆ getSinglePredecessor() [1/2]

BasicBlock * llvm::BasicBlock::getSinglePredecessor ( )
inline

Definition at line 380 of file BasicBlock.h.

References getSinglePredecessor().

◆ getSinglePredecessor() [2/2]

const BasicBlock * BasicBlock::getSinglePredecessor ( ) const

Return the predecessor of this block if it has a single predecessor block.

Otherwise return a null pointer.

Definition at line 453 of file BasicBlock.cpp.

References llvm::pred_begin(), and llvm::pred_end().

Referenced by addUsersInExitBlock(), llvm::CanonicalLoopInfo::assertOK(), CanGenerateTest(), CanPropagatePredecessorsForPHIs(), CanProveNotTakenFirstIteration(), llvm::CloneAndPruneIntoFromInst(), llvm::EpilogueVectorizerEpilogueLoop::createEpilogueVectorizedLoopSkeleton(), llvm::OpenMPIRBuilder::createSection(), llvm::TileInfo::CreateTiledLoops(), llvm::JumpThreadingPass::evaluateOnPredecessorEdge(), llvm::VPPredInstPHIRecipe::execute(), findDominatingValue(), FindPHIForConditionForwarding(), FindWidenableTerminatorAboveLoop(), foldICmpWithDominatingICmp(), getDomPredecessorCondition(), llvm::GetIfCondition(), getSinglePredecessor(), handlePhiDef(), llvm::objcarc::BundledRetainClaimRVs::insertAfterInvokes(), llvm::ScalarEvolution::isBasicBlockEntryGuardedByCond(), llvm::ScalarEvolution::isLoopBackedgeGuardedByCond(), isOnlyReachableViaThisEdge(), loadCSE(), llvm::JumpThreadingPass::maybeMergeBasicBlockIntoOnlyPred(), llvm::JumpThreadingPass::maybethreadThroughTwoBasicBlocks(), llvm::MergeBasicBlockIntoOnlyPred(), mergeBlocksIntoPredecessors(), mergeCleanupPad(), mergeConditionalStores(), mergeConditionalStoreToAddress(), llvm::JumpThreadingPass::processGuards(), llvm::JumpThreadingPass::processImpliedCondition(), llvm::OutlinableRegion::reattachCandidate(), llvm::InstCombinerImpl::replacedSelectWithOperand(), shouldInstrumentBlock(), SimplifyCondBranchToCondBranch(), simplifyOneLoop(), llvm::JumpThreadingPass::simplifyPartiallyRedundantLoad(), splitBasicBlockBefore(), splitBlockIfNotFirst(), llvm::SplitEdge(), tryToMoveFreeBeforeNullTest(), and llvm::TryToSimplifyUncondBranchFromEmptyBlock().

◆ getSingleSuccessor() [1/2]

BasicBlock * llvm::BasicBlock::getSingleSuccessor ( )
inline

Definition at line 408 of file BasicBlock.h.

References getSingleSuccessor().

◆ getSingleSuccessor() [2/2]

const BasicBlock * BasicBlock::getSingleSuccessor ( ) const

◆ getTerminatingDeoptimizeCall() [1/2]

CallInst * llvm::BasicBlock::getTerminatingDeoptimizeCall ( )
inline

Definition at line 237 of file BasicBlock.h.

References getTerminatingDeoptimizeCall().

◆ getTerminatingDeoptimizeCall() [2/2]

const CallInst * BasicBlock::getTerminatingDeoptimizeCall ( ) const

Returns the call instruction calling @llvm.experimental.deoptimize prior to the terminating return instruction of this basic block, if such a call is present.

Otherwise, returns null.

Definition at line 325 of file BasicBlock.cpp.

References F.

Referenced by getPostdominatingDeoptimizeCall(), getTerminatingDeoptimizeCall(), llvm::IsBlockFollowedByDeoptOrUnreachable(), tryWidenCondBranchToCondBranch(), and violatesLegacyMultiExitLoopCheck().

◆ getTerminatingMustTailCall() [1/2]

CallInst * llvm::BasicBlock::getTerminatingMustTailCall ( )
inline

Definition at line 255 of file BasicBlock.h.

References getTerminatingMustTailCall().

◆ getTerminatingMustTailCall() [2/2]

const CallInst * BasicBlock::getTerminatingMustTailCall ( ) const

Returns the call instruction marked 'musttail' prior to the terminating return instruction of this basic block, if such a call is present.

Otherwise, returns null.

Definition at line 294 of file BasicBlock.cpp.

References llvm::User::getOperand(), llvm::ilist_node_with_parent< NodeTy, ParentTy, Options >::getPrevNode(), and llvm::ReturnInst::getReturnValue().

Referenced by getInsertionRange(), getTerminatingMustTailCall(), and llvm::EscapeEnumerator::Next().

◆ getTerminator() [1/2]

Instruction * llvm::BasicBlock::getTerminator ( )
inline

Definition at line 228 of file BasicBlock.h.

References getTerminator().

◆ getTerminator() [2/2]

const Instruction * llvm::BasicBlock::getTerminator ( ) const
inline

Returns the terminator instruction if the block is well formed or null if the block is not well formed.

Definition at line 223 of file BasicBlock.h.

Referenced by addBasicBlockMetadata(), Prefetch::addInstruction(), addNoUndefAttrs(), llvm::CodeMetrics::analyzeBasicBlock(), analyzeLoopUnrollCost(), llvm::OpenMPIRBuilder::applySimd(), llvm::CanonicalLoopInfo::assertOK(), basicBlockCanReturn(), llvm::PredicateInfoBuilder::buildPredicateInfo(), llvm::BranchProbabilityInfo::calculate(), llvm::calculateCXXStateForAsynchEH(), llvm::calculateSEHStateForAsynchEH(), canFoldTermCondOfLoop(), CanGenerateTest(), canRotateDeoptimizingLatchExit(), llvm::canSplitLoopBound(), checkBasicSSA(), llvm::CloneAndPruneIntoFromInst(), llvm::CloneFunctionInto(), CloneInstructionsIntoPredecessorBlockAndUpdateSSAUses(), cloneLoopBlocks(), CloneLoopBlocks(), llvm::colorEHFunclets(), llvm::FunctionComparator::compare(), llvm::InnerLoopVectorizer::completeLoopSkeleton(), ComputeNumSignBitsImpl(), ComputePostOrders(), computeUnlikelySuccessors(), ConnectEpilog(), ConnectProlog(), llvm::ConstantFoldTerminator(), copyMustTailReturn(), createAndCollectMergePhiForReduction(), llvm::OpenMPIRBuilder::createAtomicCompare(), llvm::OpenMPIRBuilder::createCopyinClauseBlocks(), llvm::EpilogueVectorizerEpilogueLoop::createEpilogueVectorizedLoopSkeleton(), llvm::SPIRVMergeRegionExitTargets::createExitVariable(), createFoldedExitCond(), llvm::InnerLoopVectorizer::createInductionResumeValue(), createInvariantCond(), llvm::createMemCpyLoopKnownSize(), createMemMoveLoop(), createMemSetLoop(), llvm::OpenMPIRBuilder::createParallel(), llvm::createPHIsForSplitLoopExit(), llvm::OpenMPIRBuilder::createReductions(), createReplacement(), llvm::createSanitizerCtorAndInitFunctions(), llvm::OpenMPIRBuilder::createSection(), createSwitchStatement(), llvm::OpenMPIRBuilder::createTargetInit(), llvm::InnerLoopVectorizer::createVectorLoopSkeleton(), despeculateCountZeros(), detectPopcountIdiom(), detectShiftUntilBitTestIdiom(), detectShiftUntilZeroIdiom(), DoFlattenLoopPair(), dominatesMergePoint(), llvm::JumpThreadingPass::duplicateCondBranchOnPHIIntoPred(), llvm::DuplicateInstructionsInSplitBetween(), llvm::ehAwareSplitEdge(), llvm::OpenMPIRBuilder::emitBranch(), llvm::OpenMPIRBuilder::emitCancelationCheckImpl(), llvm::InnerLoopVectorizer::emitIterationCountCheck(), llvm::EpilogueVectorizerMainLoop::emitIterationCountCheck(), llvm::EpilogueVectorizerEpilogueLoop::emitMinimumVectorEpilogueIterCountCheck(), llvm::Evaluator::EvaluateFunction(), llvm::VPWidenIntOrFpInductionRecipe::execute(), llvm::VPFirstOrderRecurrencePHIRecipe::execute(), llvm::VPReductionPHIRecipe::execute(), llvm::VPBranchOnMaskRecipe::execute(), llvm::VPWidenCanonicalIVRecipe::execute(), llvm::VPlan::execute(), llvm::VPIRBasicBlock::execute(), llvm::LoopVectorizationPlanner::executePlan(), expandToSwitch(), findBasePointer(), llvm::orc::SpeculateQuery::findCalles(), findDominatingValue(), findLoopComponents(), FindLoopCounter(), llvm::DominatorTree::findNearestCommonDominator(), llvm::CodeExtractor::findOrCreateBlockForHoisting(), llvm::RandomIRBuilder::findOrCreateSource(), FindPHIForConditionForwarding(), llvm::InnerLoopVectorizer::fixupIVUsers(), FlattenLoopPair(), flushTerminatorDbgRecords(), llvm::InstCombinerImpl::foldBinopWithPhiOperands(), FoldCondBranchOnValueKnownInPredecessorImpl(), foldExit(), llvm::InstCombinerImpl::foldFreezeIntoRecurrence(), foldGuardedFunnelShift(), foldICmpWithDominatingICmp(), llvm::InstCombinerImpl::foldOpIntoPhi(), llvm::FoldReturnIntoUncondBranch(), llvm::SPIRVMergeRegionExitTargets::gatherSuccessors(), generateUnsignedDivisionCode(), genLoopLimit(), llvm::VPTransformState::get(), getBestDestForJumpOnUndef(), getBranchHint(), getBranchInsertPoint(), llvm::Loop::LoopBounds::getCanonicalPredicate(), getDomPredecessorCondition(), getEHPadFromPredecessor(), getExpectedExitLoopLatchBranch(), llvm::GetIfCondition(), getInsertPointForUses(), getInstrBB(), getIrrLoopHeaderWeight(), getJumpThreadDuplicationCost(), llvm::Loop::getLoopGuardBranch(), llvm::MachineLoop::getLoopID(), llvm::RegionTraits< Function >::getNumSuccessors(), getOnlyLiveSuccessor(), llvm::InnerLoopVectorizer::getOrCreateVectorTripCount(), getOuterLoopLatchCmp(), getOutliningBenefit(), getOutliningPenalty(), VectorSlice::getSlicedVal(), llvm::GCProjectionInst::getStatepoint(), getStrlenWithNull(), llvm::GetSuccessorNumber(), getSuccState(), getTerminator(), handlePhiDef(), llvm::InstCombinerImpl::handleUnreachableFrom(), hasProfileData(), hasSideeffectFreeStaticResolution(), hoist(), hoistAdd(), llvm::hoistAllInstructionsInto(), hoistGEP(), hoistMinMax(), hoistMulAddAssociation(), llvm::hoistRegion(), hoistSub(), injectPendingInvariantConditions(), llvm::InlineFunction(), insertBoundsCheck(), llvm::DIBuilder::insertDeclare(), insertSpills(), insertUniqueBackedgeBlock(), llvm::SampleProfileProber::instrumentOneFunc(), llvm::Attributor::isAssumedDead(), llvm::IsBlockFollowedByDeoptOrUnreachable(), isChainSelectCmpBranch(), llvm::isInlineViable(), llvm::isInTailCallPosition(), isLegalToHoistInto(), llvm::ScalarEvolution::isLoopBackedgeGuardedByCond(), isLoopDead(), isLoopExitTestBasedOn(), isNotUsedOrFoldableInLoop(), isPowerOfTwoRecurrence(), isSafePHIToSpeculate(), llvm::isSafeToMoveBefore(), llvm::isUniformLoop(), isUniformlyReached(), llvm::Loop::makeLoopInvariant(), llvm::gvn::AvailableValueInBlock::MaterializeAdjustedValue(), llvm::JumpThreadingPass::maybeMergeBasicBlockIntoOnlyPred(), llvm::JumpThreadingPass::maybethreadThroughTwoBasicBlocks(), llvm::MergeBasicBlockIntoOnlyPred(), llvm::MergeBlockIntoPredecessor(), mergeConditionalStoreToAddress(), llvm::InstCombinerImpl::mergeStoreIntoSuccessor(), moveBBContents(), llvm::moveInstructionsToTheEnd(), llvm::MemorySSAUpdater::moveToPlace(), llvm::ShuffleBlockStrategy::mutate(), needsLFTR(), llvm::RandomIRBuilder::newSource(), llvm::EscapeEnumerator::Next(), optimizeDivRem(), llvm::slpvectorizer::BoUpSLP::optimizeGatherSequence(), optimizeSQRT(), llvm::LoopStructure::parseLoopStructure(), llvm::peelLoop(), peelToTurnInvariantLoadsDerefencebale(), performBranchToCommonDestFolding(), llvm::VPlan::prepareToExecute(), llvm::InstCombinerImpl::prepareWorklist(), llvm::JumpThreadingPass::processBlock(), llvm::JumpThreadingPass::processBranchOnPHI(), llvm::JumpThreadingPass::processBranchOnXOR(), llvm::JumpThreadingPass::processImpliedCondition(), llvm::JumpThreadingPass::processThreadableEdges(), llvm::promoteLoopAccessesToScalars(), llvm::OutlinableRegion::reattachCandidate(), redirectToHub(), ReduceLoopStrength(), llvm::removeAllNonTerminatorAndEHPadInstructions(), llvm::MemorySSAUpdater::removeBlocks(), llvm::SCCPSolver::removeNonFeasibleEdges(), removeUndefIntroducingPredecessor(), llvm::removeUnwindEdge(), llvm::SPIRVMergeRegionExitTargets::replaceBranchTargets(), replaceConstantExprOp(), replaceSuccessorsPhiUsesWith(), rewriteMaterializableInstructions(), rewriteMemOpOfSelect(), rewritePHIs(), llvm::LoopConstrainer::run(), llvm::InstCombinerImpl::run(), llvm::PlaceSafepointsPass::runImpl(), scalarizeMaskedCompressStore(), scalarizeMaskedExpandLoad(), scalarizeMaskedGather(), scalarizeMaskedLoad(), scalarizeMaskedScatter(), scalarizeMaskedStore(), scalarizeMaskedVectorHistogram(), separateNestedLoop(), llvm::SSPLayoutInfo::shouldEmitSDCheck(), simplifyInstructionWithPHI(), simplifyOneLoop(), llvm::JumpThreadingPass::simplifyPartiallyRedundantLoad(), SinkCast(), sinkLastInstruction(), llvm::InstCombinerImpl::SliceUpIllegalIntegerPHI(), speculatePHINodeLoads(), llvm::spliceBB(), splitBasicBlock(), splitBasicBlockBefore(), llvm::splitBB(), splitBeforeCatchSwitch(), llvm::SplitBlockAndInsertIfElse(), llvm::SplitBlockAndInsertIfThen(), llvm::SplitBlockAndInsertIfThenElse(), llvm::SplitBlockAndInsertSimpleForLoop(), SplitBlockPredecessorsImpl(), splitCallSite(), llvm::OutlinableRegion::splitCandidate(), llvm::SplitEdge(), llvm::SplitKnownCriticalEdge(), SplitLandingPadPredecessorsImpl(), llvm::splitLoopBound(), llvm::succ_begin(), llvm::succ_end(), swapBBContents(), threadBinOpOverPHI(), threadCmpOverPHI(), llvm::JumpThreadingPass::threadEdge(), llvm::JumpThreadingPass::threadThroughTwoBasicBlocks(), llvm::OpenMPIRBuilder::tileLoops(), llvm::JumpThreadingPass::tryThreadEdge(), TryToMergeLandingPad(), tryToMoveFreeBeforeNullTest(), llvm::TryToSimplifyUncondBranchFromEmptyBlock(), llvm::InstCombinerImpl::tryToSinkInstruction(), llvm::JumpThreadingPass::tryToUnfoldSelect(), llvm::JumpThreadingPass::tryToUnfoldSelectInCurrBB(), tryUnmergingGEPsAcrossIndirectBr(), turnGuardIntoBranch(), turnSelectIntoBranch(), turnToExplicitForm(), llvm::JumpThreadingPass::unfoldSelectInstr(), llvm::UnrollAndJamLoop(), llvm::UnrollLoop(), llvm::UnrollRuntimeLoopRemainder(), unswitchAllTrivialConditions(), unswitchTrivialBranch(), unswitchTrivialSwitch(), updatePredecessorProfileMetadata(), llvm::LoopVersioning::versionLoop(), violatesLegacyMultiExitLoopCheck(), llvm::InstCombinerImpl::visitPHINode(), and workshareLoopTargetCallback().

◆ getTrailingDbgRecords()

DbgMarker * BasicBlock::getTrailingDbgRecords ( )

Fetch the collection of DbgRecords that "trail" after the last instruction of this block, see setTrailingDbgRecords.

If there are none, returns nullptr.

Definition at line 1153 of file BasicBlock.cpp.

References getContext(), llvm::LLVMContextImpl::getTrailingDbgRecords(), and llvm::LLVMContext::pImpl.

Referenced by convertFromNewDbgValues(), createMarker(), flushTerminatorDbgRecords(), and getMarker().

◆ getUniquePredecessor() [1/2]

BasicBlock * llvm::BasicBlock::getUniquePredecessor ( )
inline

Definition at line 392 of file BasicBlock.h.

References getUniquePredecessor().

◆ getUniquePredecessor() [2/2]

const BasicBlock * BasicBlock::getUniquePredecessor ( ) const

Return the predecessor of this block if it has a unique predecessor block.

Otherwise return a null pointer.

Note that unique predecessor doesn't mean single edge, there can be multiple edges from the unique predecessor to this block (for example a switch statement with multiple cases having the same destination).

Definition at line 461 of file BasicBlock.cpp.

References llvm::pred_begin(), and llvm::pred_end().

Referenced by areInnerLoopLatchPHIsSupported(), areOuterLoopExitPHIsSupported(), llvm::MustBeExecutedContextExplorer::findBackwardJoinPoint(), findLocationForEntrySafepoint(), llvm::Loop::getLoopGuardBranch(), getUniquePredecessor(), IsAcceptableTarget(), makeStatepointExplicitImpl(), llvm::MergeBlockIntoPredecessor(), llvm::MergeBlockSuccessorsIntoGivenBlocks(), normalizeForInvokeSafepoint(), optimizeDivRem(), reuseTableCompare(), llvm::InstCombinerImpl::run(), runMoveAutoInit(), llvm::LoopNest::skipEmptyBlockUntil(), llvm::InstCombinerImpl::tryToSinkInstruction(), and llvm::UnrollLoop().

◆ getUniqueSuccessor() [1/2]

BasicBlock * llvm::BasicBlock::getUniqueSuccessor ( )
inline

Definition at line 418 of file BasicBlock.h.

References getUniqueSuccessor().

◆ getUniqueSuccessor() [2/2]

const BasicBlock * BasicBlock::getUniqueSuccessor ( ) const

◆ getValueSymbolTable()

ValueSymbolTable * BasicBlock::getValueSymbolTable ( )

Returns a pointer to the symbol table if one exists.

Definition at line 162 of file BasicBlock.cpp.

References F, and getParent().

◆ hasAddressTaken()

bool llvm::BasicBlock::hasAddressTaken ( ) const
inline

◆ hasNPredecessors()

bool BasicBlock::hasNPredecessors ( unsigned  N) const

◆ hasNPredecessorsOrMore()

bool BasicBlock::hasNPredecessorsOrMore ( unsigned  N) const

Return true if this block has N predecessors or more.

Definition at line 479 of file BasicBlock.cpp.

References llvm::hasNItemsOrMore(), N, llvm::pred_begin(), and llvm::pred_end().

Referenced by CanRedirectPredsOfEmptyBBToSucc(), and llvm::OutlinableRegion::reattachCandidate().

◆ insertDbgRecordAfter()

void BasicBlock::insertDbgRecordAfter ( DbgRecord DR,
Instruction I 
)

Insert a DbgRecord into a block at the position given by I.

Definition at line 1051 of file BasicBlock.cpp.

References assert(), createMarker(), I, llvm::DbgMarker::insertDbgRecord(), and IsNewDbgInfoFormat.

Referenced by DbgInserterHelper().

◆ insertDbgRecordBefore()

void BasicBlock::insertDbgRecordBefore ( DbgRecord DR,
InstListType::iterator  Here 
)

Insert a DbgRecord into a block at the position given by Here.

Definition at line 1060 of file BasicBlock.cpp.

References assert(), createMarker(), and end().

Referenced by DbgInserterHelper(), and insertDbgVariableRecordsForPHIs().

◆ insertInto()

void BasicBlock::insertInto ( Function Parent,
BasicBlock InsertBefore = nullptr 
)

Insert unlinked basic block into a function.

Inserts an unlinked basic block into Parent. If InsertBefore is provided, inserts before that basic block, otherwise inserts at the end.

Precondition
getParent() is nullptr.

Definition at line 198 of file BasicBlock.cpp.

References assert(), llvm::Function::end(), llvm::ilist_node_impl< OptionsT >::getIterator(), llvm::Function::insert(), llvm::Function::IsNewDbgInfoFormat, and setIsNewDbgInfoFormat().

Referenced by moveFunctionAdaptingType().

◆ instructionsWithoutDebug() [1/2]

iterator_range< filter_iterator< BasicBlock::iterator, std::function< bool(Instruction &)> > > BasicBlock::instructionsWithoutDebug ( bool  SkipPseudoOp = true)

Return an iterator range over the instructions in the block, skipping any debug instructions.

Skip and any pseudo operations as well if SkipPseudoOp is true.

Definition at line 258 of file BasicBlock.cpp.

References I, and llvm::make_filter_range().

◆ instructionsWithoutDebug() [2/2]

iterator_range< filter_iterator< BasicBlock::const_iterator, std::function< bool(const Instruction &)> > > BasicBlock::instructionsWithoutDebug ( bool  SkipPseudoOp = true) const

Return a const iterator range over the instructions in the block, skipping any debug instructions.

Skip any pseudo operations as well if SkipPseudoOp is true.

Definition at line 248 of file BasicBlock.cpp.

References I, and llvm::make_filter_range().

Referenced by BlockIsSimpleEnoughToThreadThrough(), llvm::orc::SpeculateQuery::findCalles(), getCaseResults(), getOutliningBenefit(), isSafeToSpeculateStore(), mergeConditionalStoreToAddress(), SimplifyCondBranchToCondBranch(), simplifyOneLoop(), sizeWithoutDebug(), and tryToMoveFreeBeforeNullTest().

◆ invalidateOrders()

void llvm::BasicBlock::invalidateOrders ( )
inline

Mark instruction ordering invalid. Done on every instruction insert.

Definition at line 689 of file BasicBlock.h.

References validateInstrOrdering().

Referenced by convertFromNewDbgValues(), and llvm::invalidateParentIListOrdering().

◆ isEHPad()

bool llvm::BasicBlock::isEHPad ( ) const
inline

◆ isEntryBlock()

bool BasicBlock::isEntryBlock ( ) const

◆ isInstrOrderValid()

bool llvm::BasicBlock::isInstrOrderValid ( ) const
inline

Returns true if the Order field of child Instructions is valid.

Definition at line 684 of file BasicBlock.h.

Referenced by validateInstrOrdering().

◆ isLandingPad()

bool BasicBlock::isLandingPad ( ) const

Return true if this basic block is a landing pad.

Being a `‘landing pad’' means that the basic block is the destination of the 'unwind' edge of an invoke instruction.

Definition at line 673 of file BasicBlock.cpp.

References getFirstNonPHI().

Referenced by llvm::createPHIsForSplitLoopExit(), MergeCompatibleInvokes(), SplitBlockPredecessorsImpl(), and SplitLandingPadPredecessorsImpl().

◆ isLegalToHoistInto()

bool BasicBlock::isLegalToHoistInto ( ) const

Return true if it is legal to hoist instructions into this block.

Definition at line 551 of file BasicBlock.cpp.

References assert(), and getTerminator().

◆ moveAfter()

void BasicBlock::moveAfter ( BasicBlock MovePos)

◆ moveBefore() [1/2]

void llvm::BasicBlock::moveBefore ( BasicBlock MovePos)
inline

Unlink this basic block from its current function and insert it into the function that MovePos lives in, right before MovePos.

Definition at line 360 of file BasicBlock.h.

References llvm::ilist_node_impl< OptionsT >::getIterator(), and moveBefore().

Referenced by buildClonedLoopBlocks(), llvm::CloneAndPruneIntoFromInst(), LLVMMoveBasicBlockBefore(), and moveBefore().

◆ moveBefore() [2/2]

void BasicBlock::moveBefore ( SymbolTableList< BasicBlock >::iterator  MovePos)

◆ operator=()

BasicBlock & llvm::BasicBlock::operator= ( const BasicBlock )
delete

◆ phis() [1/2]

iterator_range< BasicBlock::phi_iterator > BasicBlock::phis ( )

Definition at line 505 of file BasicBlock.cpp.

References begin(), empty(), and P.

◆ phis() [2/2]

iterator_range< const_phi_iterator > llvm::BasicBlock::phis ( ) const
inline

Returns a range that iterates over the phis in the basic block.

Note that this cannot be used with basic blocks that have no terminator.

Definition at line 501 of file BasicBlock.h.

References phis().

Referenced by llvm::InstCombinerImpl::addDeadEdge(), addPHINodeEntriesForMappedBlock(), AddPredecessorToBlock(), addUsersInExitBlock(), analyzeExitPHIsForOutputUses(), areInnerLoopExitPHIsSupported(), areInnerLoopLatchPHIsSupported(), areOuterLoopExitPHIsSupported(), CanRedirectPredsOfEmptyBBToSucc(), cleanupSinglePredPHIs(), ConnectEpilog(), llvm::EpilogueVectorizerEpilogueLoop::createEpilogueVectorizedLoopSkeleton(), llvm::createPHIsForSplitLoopExit(), llvm::DeleteDeadPHIs(), deleteLoopIfDead(), llvm::EliminateDuplicatePHINodes(), findOrCreatePHIInBlock(), FindPHIForConditionForwarding(), fixupPHINodeForNormalDest(), fixupPHINodeForUnwindDest(), ForwardSwitchConditionToPHI(), llvm::SSAUpdater::GetValueInMiddleOfBlock(), HandleInlinedEHPad(), IncomingValuesAreCompatible(), isExistingPhi(), isLoopDead(), isPredicatedOnPHI(), isSafeToHoistInvoke(), llvm::MergeBlockIntoPredecessor(), moveLCSSAPhis(), phis(), removeEmptyCleanup(), removePredecessor(), removeUndefIntroducingPredecessor(), replaceTargetsFromPHINode(), rewritePHINodesForExitAndUnswitchedBlocks(), rewritePHINodesForUnswitchedExitBlock(), SimplifyCondBranchToCondBranch(), SinkCommonCodeFromPredecessors(), splitCallSite(), llvm::splitLoopBound(), tryWidenCondBranchToCondBranch(), llvm::updatePhiNodes(), and validateAndCostRequiredSelects().

◆ print()

void BasicBlock::print ( raw_ostream OS,
AssemblyAnnotationWriter AAW = nullptr,
bool  ShouldPreserveUseListOrder = false,
bool  IsForDebug = false 
) const

◆ rbegin() [1/2]

reverse_iterator llvm::BasicBlock::rbegin ( )
inline

Definition at line 448 of file BasicBlock.h.

Referenced by llvm::OpenMPIRBuilder::finalize(), and findLiveSetAtInst().

◆ rbegin() [2/2]

const_reverse_iterator llvm::BasicBlock::rbegin ( ) const
inline

Definition at line 449 of file BasicBlock.h.

◆ reinsertInstInDbgRecords()

void BasicBlock::reinsertInstInDbgRecords ( Instruction I,
std::optional< DbgRecord::self_iterator Pos 
)

In rare circumstances instructions can be speculatively removed from blocks, and then be re-inserted back into that position later.

When this happens in RemoveDIs debug-info mode, some special patching-up needs to occur: inserting into the middle of a sequence of dbg.value intrinsics does not have an equivalent with DbgRecords.

Definition at line 1080 of file BasicBlock.cpp.

References llvm::DbgMarker::absorbDebugValues(), assert(), createMarker(), DM, getNextMarker(), I, llvm::make_range(), Range, and llvm::DbgMarker::StoredDbgRecords.

◆ removeFromParent()

◆ removePredecessor()

void BasicBlock::removePredecessor ( BasicBlock Pred,
bool  KeepOneInputPHIs = false 
)

◆ rend() [1/2]

reverse_iterator llvm::BasicBlock::rend ( )
inline

◆ rend() [2/2]

const_reverse_iterator llvm::BasicBlock::rend ( ) const
inline

Definition at line 451 of file BasicBlock.h.

◆ renumberInstructions()

void BasicBlock::renumberInstructions ( )

Renumber instructions and mark the ordering as valid.

Definition at line 700 of file BasicBlock.cpp.

References I.

◆ replacePhiUsesWith()

void BasicBlock::replacePhiUsesWith ( BasicBlock Old,
BasicBlock New 
)

Update all phi nodes in this basic block to refer to basic block New instead of basic block Old.

Definition at line 647 of file BasicBlock.cpp.

References I, and llvm::PHINode::replaceIncomingBlockWith().

Referenced by moveLCSSAPhis(), and splitBasicBlockBefore().

◆ replaceSuccessorsPhiUsesWith() [1/2]

void BasicBlock::replaceSuccessorsPhiUsesWith ( BasicBlock New)

Update all phi nodes in this basic block's successors to refer to basic block New instead of to it.

Definition at line 669 of file BasicBlock.cpp.

References replaceSuccessorsPhiUsesWith().

◆ replaceSuccessorsPhiUsesWith() [2/2]

void BasicBlock::replaceSuccessorsPhiUsesWith ( BasicBlock Old,
BasicBlock New 
)

Update all phi nodes in this basic block's successors to refer to basic block New instead of basic block Old.

Definition at line 658 of file BasicBlock.cpp.

References getTerminator(), and llvm::successors().

Referenced by llvm::OutlinableRegion::reattachCandidate(), replaceSuccessorsPhiUsesWith(), and llvm::OutlinableRegion::splitCandidate().

◆ setIsNewDbgInfoFormat()

void BasicBlock::setIsNewDbgInfoFormat ( bool  NewFlag)

Ensure the block is in "old" dbg.value format (NewFlag == false) or in the new format (NewFlag == true), converting to the desired format if necessary.

Definition at line 152 of file BasicBlock.cpp.

References convertFromNewDbgValues(), convertToNewDbgValues(), and IsNewDbgInfoFormat.

Referenced by llvm::Function::insert(), insertInto(), and LLVMSetIsNewDbgInfoFormat().

◆ setNewDbgInfoFormatFlag()

void BasicBlock::setNewDbgInfoFormatFlag ( bool  NewFlag)

Definition at line 158 of file BasicBlock.cpp.

References IsNewDbgInfoFormat.

◆ setTrailingDbgRecords()

void BasicBlock::setTrailingDbgRecords ( DbgMarker M)

Record that the collection of DbgRecords in M "trails" after the last instruction of this block.

These are equivalent to dbg.value intrinsics that exist at the end of a basic block with no terminator (a transient state that occurs regularly).

Definition at line 1149 of file BasicBlock.cpp.

References getContext(), llvm::LLVMContext::pImpl, and llvm::LLVMContextImpl::setTrailingDbgRecords().

Referenced by createMarker(), and llvm::DbgMarker::removeMarker().

◆ size()

size_t llvm::BasicBlock::size ( ) const
inline

◆ sizeWithoutDebug()

filter_iterator< BasicBlock::const_iterator, std::function< bool(constInstruction &)> >::difference_type BasicBlock::sizeWithoutDebug ( ) const

Return the size of the basic block ignoring debug instructions.

Definition at line 268 of file BasicBlock.cpp.

References begin(), end(), and instructionsWithoutDebug().

Referenced by llvm::FastISel::fastEmitBranch().

◆ splice() [1/3]

void llvm::BasicBlock::splice ( BasicBlock::iterator  ToIt,
BasicBlock FromBB 
)
inline

◆ splice() [2/3]

void BasicBlock::splice ( BasicBlock::iterator  ToIt,
BasicBlock FromBB,
BasicBlock::iterator  FromBeginIt,
BasicBlock::iterator  FromEndIt 
)

Transfer a range of instructions that belong to FromBB from FromBeginIt to FromEndIt, to this basic block at ToIt.

Definition at line 1023 of file BasicBlock.cpp.

References assert(), llvm::First, flushTerminatorDbgRecords(), IsNewDbgInfoFormat, llvm::Last, and llvm::iplist_impl< IntrusiveListT, TraitsT >::splice().

◆ splice() [3/3]

void llvm::BasicBlock::splice ( BasicBlock::iterator  ToIt,
BasicBlock FromBB,
BasicBlock::iterator  FromIt 
)
inline

Transfer one instruction from FromBB at FromIt to this basic block at ToIt.

Definition at line 621 of file BasicBlock.h.

References splice().

◆ splitBasicBlock() [1/2]

BasicBlock * llvm::BasicBlock::splitBasicBlock ( Instruction I,
const Twine BBName = "",
bool  Before = false 
)
inline

Definition at line 587 of file BasicBlock.h.

References Before, I, and splitBasicBlock().

◆ splitBasicBlock() [2/2]

BasicBlock * BasicBlock::splitBasicBlock ( iterator  I,
const Twine BBName = "",
bool  Before = false 
)

Split the basic block into two basic blocks at the specified instruction.

If Before is true, splitBasicBlockBefore handles the block splitting. Otherwise, execution proceeds as described below.

Note that all instructions BEFORE the specified iterator stay as part of the original basic block, an unconditional branch is added to the original BB, and the rest of the instructions in the BB are moved to the new BB, including the old terminator. The newly formed basic block is returned. This function invalidates the specified iterator.

Note that this only works on well formed basic blocks (must have a terminator), and 'I' must not be the end of instruction list (which would cause a degenerate basic block to be formed, having a terminator inside of the basic block).

Also note that this doesn't preserve any passes. To split blocks while keeping loop information consistent, use the SplitBlock utility function.

Definition at line 571 of file BasicBlock.cpp.

References assert(), Before, llvm::BranchInst::Create(), Create(), end(), getContext(), llvm::ilist_node_with_parent< BasicBlock, Function >::getNextNode(), getParent(), getTerminator(), I, llvm::Instruction::setDebugLoc(), and splitBasicBlockBefore().

Referenced by llvm::OpenMPIRBuilder::createAtomicCompare(), llvm::OpenMPIRBuilder::createCopyinClauseBlocks(), llvm::createMemCpyLoopKnownSize(), createMemSetLoop(), llvm::OpenMPIRBuilder::createParallel(), llvm::OpenMPIRBuilder::createReductions(), llvm::OpenMPIRBuilder::createTargetInit(), despeculateCountZeros(), llvm::SITargetLowering::emitExpandAtomicRMW(), llvm::CodeExtractor::findOrCreateBlockForHoisting(), generateUnsignedDivisionCode(), getStrlenWithNull(), llvm::InlineFunction(), insertBoundsCheck(), insertSpills(), splitBasicBlock(), splitBeforeCatchSwitch(), llvm::SplitBlockAndInsertIfThenElse(), llvm::splitBlockBefore(), splitBlockIfNotFirst(), SplitBlockImpl(), and llvm::OutlinableRegion::splitCandidate().

◆ splitBasicBlockBefore() [1/2]

BasicBlock * llvm::BasicBlock::splitBasicBlockBefore ( Instruction I,
const Twine BBName = "" 
)
inline

Definition at line 610 of file BasicBlock.h.

References I, and splitBasicBlockBefore().

◆ splitBasicBlockBefore() [2/2]

BasicBlock * BasicBlock::splitBasicBlockBefore ( iterator  I,
const Twine BBName = "" 
)

Split the basic block into two basic blocks at the specified instruction and insert the new basic blocks as the predecessor of the current block.

This function ensures all instructions AFTER and including the specified iterator I are part of the original basic block. All Instructions BEFORE the iterator I are moved to the new BB and an unconditional branch is added to the new BB. The new basic block is returned.

Note that this only works on well formed basic blocks (must have a terminator), and 'I' must not be the end of instruction list (which would cause a degenerate basic block to be formed, having a terminator inside of the basic block). 'I' cannot be a iterator for a PHINode with multiple incoming blocks.

Also note that this doesn't preserve any passes. To split blocks while keeping loop information consistent, use the SplitBlockBefore utility function.

Definition at line 602 of file BasicBlock.cpp.

References assert(), begin(), llvm::BranchInst::Create(), Create(), getContext(), getParent(), getSinglePredecessor(), getTerminator(), I, llvm::predecessors(), llvm::SmallVectorTemplateBase< T, bool >::push_back(), replacePhiUsesWith(), llvm::Instruction::replaceSuccessorWith(), and llvm::Instruction::setDebugLoc().

Referenced by splitBasicBlock(), and splitBasicBlockBefore().

◆ validateInstrOrdering()

void BasicBlock::validateInstrOrdering ( ) const

Asserts that instruction order numbers are marked invalid, or that they are in ascending order.

In asserts builds, this checks the numbering.

This is constant time if the ordering is invalid, and linear in the number of instructions if the ordering is valid. Callers should be careful not to call this in ways that make common operations O(n^2). For example, it takes O(n) time to assign order numbers to instructions, so the order should be validated no more than once after each ordering to ensure that transforms have the same algorithmic complexity when asserts are enabled as when they are disabled.

In non-asserts builds, it is defined as a no-op inline function in BasicBlock.h.

Definition at line 1137 of file BasicBlock.cpp.

References assert(), llvm::Instruction::comesBefore(), I, and isInstrOrderValid().

Referenced by invalidateOrders(), and ~BasicBlock().

Friends And Related Function Documentation

◆ BlockAddress

friend class BlockAddress
friend

Definition at line 69 of file BasicBlock.h.

◆ Instruction::cloneDebugInfoFrom

iterator_range< DbgRecord::self_iterator > Instruction::cloneDebugInfoFrom ( const Instruction From,
std::optional< DbgRecord::self_iterator FromHere,
bool  InsertAtHead 
)
friend

◆ Instruction::eraseFromParent

◆ Instruction::insertAfter

void Instruction::insertAfter ( Instruction InsertPos)
friend

◆ Instruction::insertBefore [1/2]

void Instruction::insertBefore ( BasicBlock BB,
InstListType::iterator  InsertPos 
)
friend

◆ Instruction::insertBefore [2/2]

void Instruction::insertBefore ( BasicBlock::iterator  InsertPos)
friend

◆ Instruction::insertInto

◆ Instruction::moveBeforeImpl

void Instruction::moveBeforeImpl ( BasicBlock BB,
InstListType::iterator  I,
bool  Preserve 
)
friend

◆ Instruction::removeFromParent

◆ llvm::ilist_node_with_parent< llvm::Instruction, llvm::BasicBlock, ilist_iterator_bits< true >, ilist_parent< BasicBlock > >

Definition at line 174 of file BasicBlock.h.

◆ llvm::SymbolTableListTraits< llvm::Instruction, ilist_iterator_bits< true >, ilist_parent< BasicBlock > >

Definition at line 174 of file BasicBlock.h.

◆ SymbolTableListTraits< BasicBlock >

friend class SymbolTableListTraits< BasicBlock >
friend

Definition at line 69 of file BasicBlock.h.

Member Data Documentation

◆ IsNewDbgInfoFormat

bool llvm::BasicBlock::IsNewDbgInfoFormat

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