30#define DEBUG_TYPE "ir"
31STATISTIC(NumInstrRenumberings,
"Number of renumberings across all blocks");
35 cl::desc(
"Enable communicating debuginfo positions "
36 "through iterators, eliminating intrinsics"),
41 "write-experimental-debuginfo-iterators-to-bitcode",
cl::Hidden,
46 "Tried to create a marker in a non new debug-info block!");
51 I->DbgMarker = Marker;
57 "Tried to create a marker in a non new debug-info block!");
76 assert(!
I.DbgMarker &&
"DbgMarker already set on old-format instrs?");
81 DVI->eraseFromParent();
87 DLI->eraseFromParent();
112 for (
auto &Inst : *
this) {
118 InstList.
insert(Inst.getIterator(),
119 DR.createDebugIntrinsic(
getModule(),
nullptr));
132 for (
auto &Inst : *
this) {
136 dbgs() <<
"@ " << Inst.DbgMarker <<
" ";
137 Inst.DbgMarker->dump();
151 return F->getValueSymbolTable();
171 IsNewDbgInfoFormat(
false), Parent(nullptr) {
174 insertInto(NewParent, InsertBefore);
177 "Cannot insert block before another block with no function!");
185 assert(NewParent &&
"Expected a parent");
186 assert(!Parent &&
"Already has a parent");
191 NewParent->
insert(NewParent->
end(),
this);
217 assert(
getParent() ==
nullptr &&
"BasicBlock still linked into the program!");
219 for (
auto &Inst : *
this) {
222 Inst.DbgMarker->eraseFromParent();
227void BasicBlock::setParent(
Function *parent) {
229 InstList.setSymTabObject(&Parent, parent);
236 return !isa<DbgInfoIntrinsic>(
I) &&
237 !(SkipPseudoOp && isa<PseudoProbeInst>(
I));
246 return !isa<DbgInfoIntrinsic>(
I) &&
247 !(SkipPseudoOp && isa<PseudoProbeInst>(
I));
281 if (InstList.empty())
283 const ReturnInst *RI = dyn_cast<ReturnInst>(&InstList.back());
284 if (!RI || RI == &InstList.front())
296 if (
auto *BI = dyn_cast<BitCastInst>(Prev)) {
299 if (!Prev || RV != Prev)
304 if (
auto *CI = dyn_cast<CallInst>(Prev)) {
305 if (CI->isMustTailCall())
312 if (InstList.empty())
314 auto *RI = dyn_cast<ReturnInst>(&InstList.back());
315 if (!RI || RI == &InstList.front())
318 if (
auto *CI = dyn_cast_or_null<CallInst>(RI->getPrevNode()))
319 if (
Function *
F = CI->getCalledFunction())
320 if (
F->getIntrinsicID() == Intrinsic::experimental_deoptimize)
331 if (!Visited.
insert(Succ).second)
339 if (InstList.empty())
342 if (isa<LoadInst>(
I) || isa<StoreInst>(
I) || isa<CallBase>(
I))
349 if (!isa<PHINode>(
I))
368 if (isa<PHINode>(
I) || isa<DbgInfoIntrinsic>(
I))
371 if (SkipPseudoOp && isa<PseudoProbeInst>(
I))
382 if (isa<PHINode>(
I) || isa<DbgInfoIntrinsic>(
I))
385 if (
I.isLifetimeStartOrEnd())
388 if (SkipPseudoOp && isa<PseudoProbeInst>(
I))
402 if (InsertPt->isEHPad()) ++InsertPt;
406 InsertPt.setHeadBit(
true);
416 if (InsertPt->isEHPad())
421 while (InsertPt !=
End &&
422 (isa<AllocaInst>(*InsertPt) || isa<DbgInfoIntrinsic>(*InsertPt) ||
423 isa<PseudoProbeInst>(*InsertPt))) {
424 if (
const AllocaInst *AI = dyn_cast<AllocaInst>(&*InsertPt)) {
425 if (!AI->isStaticAlloca())
436 I.dropAllReferences();
441 if (PI ==
E)
return nullptr;
444 return (PI ==
E) ? ThePred :
nullptr ;
449 if (PI ==
E)
return nullptr;
452 for (;PI !=
E; ++PI) {
471 if (SI ==
E)
return nullptr;
474 return (SI ==
E) ? TheSucc :
nullptr ;
479 if (SI ==
E)
return nullptr;
482 for (;SI !=
E; ++SI) {
493 return make_range<phi_iterator>(
P,
nullptr);
497 bool KeepOneInputPHIs) {
500 "Pred is not a predecessor!");
506 unsigned NumPreds = cast<PHINode>(
front()).getNumIncomingValues();
508 Phi.removeIncomingValue(Pred, !KeepOneInputPHIs);
509 if (KeepOneInputPHIs)
518 if (
Value *PhiConstant = Phi.hasConstantValue()) {
519 Phi.replaceAllUsesWith(PhiConstant);
520 Phi.eraseFromParent();
527 if (isa<LandingPadInst>(FirstNonPHI))
544 assert(Term->getNumSuccessors() > 0);
548 return !Term->isSpecialTerminator();
553 assert(
F &&
"Block must have a parent function to use this API");
554 return this == &
F->getEntryBlock();
564 "Trying to get me to create degenerate basic block!");
573 New->splice(New->end(),
this,
I,
end());
584 New->replaceSuccessorsPhiUsesWith(
this, New);
590 "Can't use splitBasicBlockBefore on degenerate BB!");
592 "Trying to get me to create degenerate basic block!");
595 "cannot split on multi incoming phis");
602 New->splice(New->end(),
this,
begin(),
I);
637 PHINode *PN = dyn_cast<PHINode>(&
I);
652 Succ->replacePhiUsesWith(Old, New);
669 if (
MDNode *MDIrrLoopHeader =
671 MDString *MDName = cast<MDString>(MDIrrLoopHeader->getOperand(0));
673 auto *CI = mdconst::extract<ConstantInt>(MDIrrLoopHeader->getOperand(1));
674 return std::optional<uint64_t>(CI->getValue().getZExtValue());
681 while (isa<DbgInfoIntrinsic>(It))
692 BasicBlockBits Bits = getBasicBlockBits();
693 Bits.InstrOrderValid =
true;
694 setBasicBlockBits(Bits);
696 NumInstrRenumberings++;
720 if (!TrailingDbgRecords)
725 Term->DbgMarker->absorbDebugValues(*TrailingDbgRecords,
false);
754 bool InsertAtHead = Dest.getHeadBit();
755 bool ReadFromHead =
First.getHeadBit();
762 DPMarker *SrcTrailingDbgRecords = Src->getTrailingDbgRecords();
763 if (!SrcTrailingDbgRecords)
766 Dest->adoptDbgRecords(Src, Src->end(), InsertAtHead);
768 assert(!Src->getTrailingDbgRecords());
775 if (Src->empty() ||
First != Src->begin() || !ReadFromHead)
779 if (!
First->hasDbgRecords())
824 DPMarker *MoreDanglingDbgRecords =
nullptr;
826 if (Dest ==
end() && !Dest.getHeadBit() && OurTrailingDbgRecords) {
829 if (!
First.getHeadBit() &&
First->hasDbgRecords()) {
830 MoreDanglingDbgRecords = Src->getMarker(
First);
834 if (
First->hasDbgRecords()) {
842 First->adoptDbgRecords(
this,
end(),
true);
851 First.setHeadBit(
true);
855 spliceDebugInfoImpl(Dest, Src,
First,
Last);
859 if (!MoreDanglingDbgRecords)
875 bool InsertAtHead = Dest.getHeadBit();
876 bool ReadFromHead =
First.getHeadBit();
879 bool ReadFromTail = !
Last.getTailBit();
880 bool LastIsEnd = (
Last == Src->end());
953 if (ReadFromTail && Src->getMarker(
Last)) {
956 Dest->adoptDbgRecords(Src,
Last,
true);
958 assert(!Src->getTrailingDbgRecords());
969 if (!ReadFromHead &&
First->hasDbgRecords()) {
970 if (
Last != Src->end()) {
994 }
else if (Dest ==
end() && !InsertAtHead) {
1001 if (TrailingDbgRecords) {
1013#ifdef EXPENSIVE_CHECKS
1015 auto FromBBEnd = Src->end();
1017 assert(It != FromBBEnd &&
"FromBeginIt not before FromEndIt!");
1023 spliceDebugInfoEmptyBlock(Dest, Src,
First,
Last);
1029 spliceDebugInfo(Dest, Src,
First,
Last);
1039 assert(
I->getParent() ==
this);
1041 iterator NextIt = std::next(
I->getIterator());
1048 assert(Where ==
end() || Where->getParent() ==
this);
1049 bool InsertAtHead = Where.getHeadBit();
1051 M->insertDbgRecord(DPV, InsertAtHead);
1055 return getMarker(std::next(
I->getIterator()));
1063 return It->DbgMarker;
1067 Instruction *
I, std::optional<DbgRecord::self_iterator> Pos) {
1109 DPMarker *DPM = (*Pos)->getMarker();
1111 if (Range.begin() == Range.end())
1129 "cached instruction ordering is incorrect");
cl::opt< bool, true > WriteNewDbgInfoFormatToBitcode2("write-experimental-debuginfo-iterators-to-bitcode", cl::Hidden, cl::location(WriteNewDbgInfoFormatToBitcode), cl::init(true))
cl::opt< bool > UseNewDbgInfoFormat("experimental-debuginfo-iterators", cl::desc("Enable communicating debuginfo positions " "through iterators, eliminating intrinsics"), cl::init(true))
bool WriteNewDbgInfoFormatToBitcode
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
This file contains the declarations for the subclasses of Constant, which represent the different fla...
This file provides various utilities for inspecting and working with the control flow graph in LLVM I...
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
This file defines the 'Statistic' class, which is designed to be an easy way to expose various metric...
#define STATISTIC(VARNAME, DESC)
an instruction to allocate memory on the stack
LLVM Basic Block Representation.
BasicBlock::iterator erase(BasicBlock::iterator FromIt, BasicBlock::iterator ToIt)
Erases a range of instructions from FromIt to (not including) ToIt.
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 bl...
DPMarker * getMarker(InstListType::iterator It)
Return the DPMarker for the position given by It, so that DbgRecords can be inserted there.
iterator begin()
Instruction iterator methods.
void deleteTrailingDbgRecords()
Delete any trailing DbgRecords at the end of this block, see setTrailingDbgRecords.
iterator_range< const_phi_iterator > phis() const
Returns a range that iterates over the phis in the basic block.
const LandingPadInst * getLandingPadInst() const
Return the landingpad instruction associated with the landing pad.
const_iterator getFirstInsertionPt() const
Returns an iterator to the first instruction in this block that is suitable for inserting a non-PHI i...
void renumberInstructions()
Renumber instructions and mark the ordering as valid.
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.
BasicBlock * splitBasicBlockBefore(iterator I, const Twine &BBName="")
Split the basic block into two basic blocks at the specified instruction and insert the new basic blo...
bool hasAddressTaken() const
Returns true if there are any uses of this basic block other than direct branches,...
InstListType::const_iterator getFirstNonPHIIt() const
Iterator returning form of getFirstNonPHI.
void invalidateOrders()
Mark instruction ordering invalid. Done on every instruction insert.
friend void Instruction::removeFromParent()
void convertToNewDbgValues()
Convert variable location debugging information stored in dbg.value intrinsics into DPMarkers / DbgRe...
InstListType::const_iterator const_iterator
void setIsNewDbgInfoFormat(bool NewFlag)
Ensure the block is in "old" dbg.value format (NewFlag == false) or in the new format (NewFlag == tru...
const Instruction * getFirstNonPHI() const
Returns a pointer to the first instruction in this block that is not a PHINode instruction.
const Instruction & front() const
static BasicBlock * Create(LLVMContext &Context, const Twine &Name="", Function *Parent=nullptr, BasicBlock *InsertBefore=nullptr)
Creates a new BasicBlock.
friend BasicBlock::iterator Instruction::eraseFromParent()
bool isEntryBlock() const
Return true if this is the entry block of the containing function.
ValueSymbolTable * getValueSymbolTable()
Returns a pointer to the symbol table if one exists.
void moveAfter(BasicBlock *MovePos)
Unlink this basic block from its current function and insert it right after MovePos in the function M...
bool hasNPredecessors(unsigned N) const
Return true if this block has exactly N predecessors.
BasicBlock * splitBasicBlock(iterator I, const Twine &BBName="", bool Before=false)
Split the basic block into two basic blocks at the specified instruction.
void convertFromNewDbgValues()
Convert variable location debugging information stored in DPMarkers and DbgRecords into the dbg....
const BasicBlock * getUniqueSuccessor() const
Return the successor of this block if it has a unique successor.
const BasicBlock * getSinglePredecessor() const
Return the predecessor of this block if it has a single predecessor block.
DPMarker * createMarker(Instruction *I)
Attach a DPMarker to the given instruction.
std::optional< uint64_t > getIrrLoopHeaderWeight() const
void insertDbgRecordAfter(DbgRecord *DPV, Instruction *I)
Insert a DbgRecord into a block at the position given by I.
void dumpDbgValues() const
const CallInst * getTerminatingDeoptimizeCall() const
Returns the call instruction calling @llvm.experimental.deoptimize prior to the terminating return in...
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.
const Instruction * getFirstNonPHIOrDbgOrLifetime(bool SkipPseudoOp=true) const
Returns a pointer to the first instruction in this block that is not a PHINode, a debug intrinsic,...
const BasicBlock * getUniquePredecessor() const
Return the predecessor of this block if it has a unique predecessor block.
const BasicBlock * getSingleSuccessor() const
Return the successor of this block if it has a single successor.
void flushTerminatorDbgRecords()
Eject any debug-info trailing at the end of a block.
const Function * getParent() const
Return the enclosing method, or null if none.
void validateInstrOrdering() const
Asserts that instruction order numbers are marked invalid, or that they are in ascending order.
const Instruction * getFirstNonPHIOrDbg(bool SkipPseudoOp=true) const
Returns a pointer to the first instruction in this block that is not a PHINode or a debug intrinsic,...
filter_iterator< BasicBlock::const_iterator, std::function< bool(constInstruction &)> >::difference_type sizeWithoutDebug() const
Return the size of the basic block ignoring debug instructions.
InstListType::iterator iterator
Instruction iterators...
LLVMContext & getContext() const
Get the context in which this basic block lives.
void insertDbgRecordBefore(DbgRecord *DPV, InstListType::iterator Here)
Insert a DbgRecord into a block at the position given by Here.
const_iterator getFirstNonPHIOrDbgOrAlloca() const
Returns an iterator to the first instruction in this block that is not a PHINode, a debug intrinsic,...
bool IsNewDbgInfoFormat
Flag recording whether or not this block stores debug-info in the form of intrinsic instructions (fal...
void dropAllReferences()
Cause all subinstructions to "let go" of all the references that said subinstructions are maintaining...
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 ...
void moveBefore(BasicBlock *MovePos)
Unlink this basic block from its current function and insert it into the function that MovePos lives ...
bool isLandingPad() const
Return true if this basic block is a landing pad.
const Instruction * getTerminator() const LLVM_READONLY
Returns the terminator instruction if the block is well formed or null if the block is not well forme...
bool canSplitPredecessors() const
void setTrailingDbgRecords(DPMarker *M)
Record that the collection of DbgRecords in M "trails" after the last instruction of this block.
const CallInst * getTerminatingMustTailCall() const
Returns the call instruction marked 'musttail' prior to the terminating return instruction of this ba...
friend BasicBlock::iterator Instruction::insertInto(BasicBlock *BB, BasicBlock::iterator It)
bool isLegalToHoistInto() const
Return true if it is legal to hoist instructions into this block.
DPMarker * getNextMarker(Instruction *I)
Return the DPMarker for the position that comes after I.
bool hasNPredecessorsOrMore(unsigned N) const
Return true if this block has N predecessors or more.
bool isInstrOrderValid() const
Returns true if the Order field of child Instructions is valid.
const CallInst * getPostdominatingDeoptimizeCall() const
Returns the call instruction calling @llvm.experimental.deoptimize that is present either in current ...
const Instruction * getFirstMayFaultInst() const
Returns the first potential AsynchEH faulty instruction currently it checks for loads/stores (which m...
void splice(BasicBlock::iterator ToIt, BasicBlock *FromBB)
Transfer all instructions from FromBB to this basic block at ToIt.
DPMarker * getTrailingDbgRecords()
Fetch the collection of DbgRecords that "trail" after the last instruction of this block,...
const Module * getModule() const
Return the module owning the function this basic block belongs to, or nullptr if the function does no...
void removePredecessor(BasicBlock *Pred, bool KeepOneInputPHIs=false)
Update PHI nodes in this BasicBlock before removal of predecessor Pred.
The address of a basic block.
Conditional or Unconditional Branch instruction.
static BranchInst * Create(BasicBlock *IfTrue, BasicBlock::iterator InsertBefore)
This class represents a function call, abstracting a target machine's calling convention.
static Constant * getIntToPtr(Constant *C, Type *Ty, bool OnlyIfReduced=false)
This is an important base class in LLVM.
void destroyConstant()
Called if some element of this constant is no longer valid.
Records a position in IR for a source label (DILabel).
Per-instruction record of debug-info.
void insertDbgRecord(DbgRecord *New, bool InsertAtHead)
Insert a DbgRecord into this DPMarker, at the end of the list.
iterator_range< simple_ilist< DbgRecord >::iterator > getDbgRecordRange()
Produce a range over all the DbgRecords in this Marker.
Instruction * MarkedInstr
Link back to the Instruction that owns this marker.
void absorbDebugValues(DPMarker &Src, bool InsertAtHead)
Transfer any DbgRecords from Src into this DPMarker.
simple_ilist< DbgRecord > StoredDbgRecords
List of DbgRecords, the non-instruction equivalent of llvm.dbg.
Record of a variable value-assignment, aka a non instruction representation of the dbg....
This represents the llvm.dbg.label instruction.
Base class for non-instruction debug metadata records that have positions within IR.
This is the common base class for debug info intrinsics for variables.
void splice(Function::iterator ToIt, Function *FromF)
Transfer all blocks from FromF to this function at ToIt.
bool IsNewDbgInfoFormat
Is this function using intrinsics to record the position of debugging information,...
Function::iterator insert(Function::iterator Position, BasicBlock *BB)
Insert BB in the basic block list at Position.
Module * getParent()
Get the module that this global value is contained inside of...
bool isEHPad() const
Return true if the instruction is a variety of EH-block.
void replaceSuccessorWith(BasicBlock *OldBB, BasicBlock *NewBB)
Replace specified successor OldBB to point at the provided block.
MDNode * getMetadata(unsigned KindID) const
Get the metadata of given kind attached to this Instruction.
bool comesBefore(const Instruction *Other) const
Given an instruction Other in the same basic block as this instruction, return true if this instructi...
void setDebugLoc(DebugLoc Loc)
Set the debug location information for this instruction.
DPMarker * getTrailingDbgRecords(BasicBlock *B)
void deleteTrailingDbgRecords(BasicBlock *B)
void setTrailingDbgRecords(BasicBlock *B, DPMarker *M)
This is an important class for using LLVM in a threaded context.
LLVMContextImpl *const pImpl
The landingpad instruction holds all of the information necessary to generate correct exception handl...
StringRef getString() const
A Module instance is used to store all the information related to an LLVM module.
void replaceIncomingBlockWith(const BasicBlock *Old, BasicBlock *New)
Replace every incoming basic block Old to basic block New.
Return a value (possibly void), from a function.
Value * getReturnValue() const
Convenience accessor. Returns null if there is no return value.
std::pair< iterator, bool > insert(PtrType Ptr)
Inserts Ptr if and only if there is no element in the container equal to Ptr.
SmallPtrSet - This class implements a set which is optimized for holding SmallSize or less elements.
void push_back(const T &Elt)
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
bool equals(StringRef RHS) const
equals - Check for string equality, this is more efficient than compare() when the relative ordering ...
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
The instances of the Type class are immutable: once they are created, they are never changed.
LLVMContext & getContext() const
Return the LLVMContext in which this type was uniqued.
static IntegerType * getInt32Ty(LLVMContext &C)
Value * getOperand(unsigned i) const
This class provides a symbol table of name/value pairs.
LLVM Value Representation.
Type * getType() const
All values are typed, get the type of this value.
void replaceAllUsesWith(Value *V)
Change all uses of this to point to a new Value.
bool hasNUsesOrMore(unsigned N) const
Return true if this value has N uses or more.
Specialization of filter_iterator_base for forward iteration only.
self_iterator getIterator()
BasicBlock * getNextNode()
Get the next node, or nullptr for the list tail.
void splice(iterator where, iplist_impl &L2)
base_list_type::iterator iterator
iterator erase(iterator where)
pointer remove(iterator &IT)
iterator insert(iterator where, pointer New)
A range adaptor for a pair of iterators.
@ C
The default llvm calling convention, compatible with C.
initializer< Ty > init(const Ty &Val)
LocationClass< Ty > location(Ty &L)
This is an optimization pass for GlobalISel generic memory operations.
Interval::succ_iterator succ_end(Interval *I)
auto successors(const MachineBasicBlock *BB)
iterator_range< T > make_range(T x, T y)
Convenience function for iterating over sub-ranges.
Interval::succ_iterator succ_begin(Interval *I)
succ_begin/succ_end - define methods so that Intervals may be used just like BasicBlocks can with the...
iterator_range< early_inc_iterator_impl< detail::IterOfRange< RangeT > > > make_early_inc_range(RangeT &&Range)
Make a range that does early increment to allow mutation of the underlying range without disrupting i...
bool hasNItemsOrMore(IterTy &&Begin, IterTy &&End, unsigned N, Pred &&ShouldBeCounted=[](const decltype(*std::declval< IterTy >()) &) { return true;}, std::enable_if_t< !std::is_base_of< std::random_access_iterator_tag, typename std::iterator_traits< std::remove_reference_t< decltype(Begin)> >::iterator_category >::value, void > *=nullptr)
Return true if the sequence [Begin, End) has N or more items.
Interval::pred_iterator pred_end(Interval *I)
BasicBlock::iterator skipDebugIntrinsics(BasicBlock::iterator It)
Advance It while it points to a debug instruction and return the result.
bool hasNItems(IterTy &&Begin, IterTy &&End, unsigned N, Pred &&ShouldBeCounted=[](const decltype(*std::declval< IterTy >()) &) { return true;}, std::enable_if_t< !std::is_base_of< std::random_access_iterator_tag, typename std::iterator_traits< std::remove_reference_t< decltype(Begin)> >::iterator_category >::value, void > *=nullptr)
Return true if the sequence [Begin, End) has exactly N items.
raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
Interval::pred_iterator pred_begin(Interval *I)
pred_begin/pred_end - define methods so that Intervals may be used just like BasicBlocks can with the...
iterator_range< filter_iterator< detail::IterOfRange< RangeT >, PredicateT > > make_filter_range(RangeT &&Range, PredicateT Pred)
Convenience function that takes a range of elements and a predicate, and return a new filter_iterator...
@ First
Helpers to iterate all locations in the MemoryEffectsBase class.
void invalidateParentIListOrdering(ParentClass *Parent)
Notify basic blocks when an instruction is inserted.
auto predecessors(const MachineBasicBlock *BB)
bool is_contained(R &&Range, const E &Element)
Returns true if Element is found in Range.
Option to add extra bits to the ilist_iterator.