1//===- GenericDomTreeUpdaterImpl.h ------------------------------*- C++ -*-===// 3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4// See https://llvm.org/LICENSE.txt for license information. 5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 7//===----------------------------------------------------------------------===// 9// This file implements the GenericDomTreeUpdater class. This file should only 10// be included by files that implement a specialization of the relevant 11// templates. Currently these are: 12// - llvm/lib/Analysis/DomTreeUpdater.cpp 13// - llvm/lib/CodeGen/MachineDomTreeUpdater.cpp 15//===----------------------------------------------------------------------===// 16#ifndef LLVM_ANALYSIS_GENERICDOMTREEUPDATERIMPL_H 17#define LLVM_ANALYSIS_GENERICDOMTREEUPDATERIMPL_H 26template <
typename DerivedT,
typename DomTreeT,
typename PostDomTreeT>
27template <
typename FuncT>
30if (Strategy == UpdateStrategy::Eager) {
38// There is little performance gain if we pend the recalculation under 39// Lazy UpdateStrategy so we recalculate available trees immediately. 41// Prevent forceFlushDeletedBB() from erasing DomTree or PostDomTree nodes. 42 IsRecalculatingDomTree = IsRecalculatingPostDomTree =
true;
44// Because all trees are going to be up-to-date after recalculation, 45// flush awaiting deleted BasicBlocks. 46 derived().forceFlushDeletedBB();
52// Resume forceFlushDeletedBB() to erase DomTree or PostDomTree nodes. 53 IsRecalculatingDomTree = IsRecalculatingPostDomTree =
false;
54 PendDTUpdateIndex = PendPDTUpdateIndex = PendUpdates.size();
55 dropOutOfDateUpdates();
58template <
typename DerivedT,
typename DomTreeT,
typename PostDomTreeT>
64if (Strategy == UpdateStrategy::Lazy) {
65 PendUpdates.reserve(PendUpdates.size() + Updates.
size());
66for (
constauto &U : Updates)
67if (!isSelfDominance(U))
68 PendUpdates.push_back(U);
76 PDT->applyUpdates(Updates);
79template <
typename DerivedT,
typename DomTreeT,
typename PostDomTreeT>
87for (
constauto &U : Updates) {
88auto Edge = std::make_pair(U.getFrom(), U.getTo());
89// Because it is illegal to submit updates that have already been applied 90// and updates to an edge need to be strictly ordered, 91// it is safe to infer the existence of an edge from the first update 93// If the first update to an edge is "Delete", it means that the edge 94// existed before. If the first update to an edge is "Insert", it means 95// that the edge didn't exist before. 97// For example, if the user submits {{Delete, A, B}, {Insert, A, B}}, 99// 1. it is illegal to submit updates that have already been applied, 100// i.e., user cannot delete an nonexistent edge, 101// 2. updates to an edge need to be strictly ordered, 102// So, initially edge A -> B existed. 103// We can then safely ignore future updates to this edge and directly 104// inspect the current CFG: 105// a. If the edge still exists, because the user cannot insert an existent 106// edge, so both {Delete, A, B}, {Insert, A, B} actually happened and 107// resulted in a no-op. DTU won't submit any update in this case. 108// b. If the edge doesn't exist, we can then infer that {Delete, A, B} 109// actually happened but {Insert, A, B} was an invalid update which never 110// happened. DTU will submit {Delete, A, B} in this case. 111if (!isSelfDominance(U) && Seen.
insert(Edge).second) {
112// If the update doesn't appear in the CFG, it means that 113// either the change isn't made or relevant operations 115if (isUpdateValid(U)) {
117 PendUpdates.push_back(U);
124if (Strategy == UpdateStrategy::Lazy)
130 PDT->applyUpdates(DeduplicatedUpdates);
133template <
typename DerivedT,
typename DomTreeT,
typename PostDomTreeT>
140if (Strategy == UpdateStrategy::Lazy) {
141 PendUpdates.push_back(
E);
146 splitDTCriticalEdges(
E);
148 splitPDTCriticalEdges(
E);
151template <
typename DerivedT,
typename DomTreeT,
typename PostDomTreeT>
154assert(DT &&
"Invalid acquisition of a null DomTree");
155 applyDomTreeUpdates();
156 dropOutOfDateUpdates();
160template <
typename DerivedT,
typename DomTreeT,
typename PostDomTreeT>
163assert(PDT &&
"Invalid acquisition of a null PostDomTree");
164 applyPostDomTreeUpdates();
165 dropOutOfDateUpdates();
169template <
typename DerivedT,
typename DomTreeT,
typename PostDomTreeT>
172#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP) 175OS <<
"Available Trees: ";
185OS <<
"UpdateStrategy: ";
186if (Strategy == UpdateStrategy::Eager) {
195auto S = BB->getName();
198OS << S <<
"(" << BB <<
")" << Ending;
200OS <<
"(badref)" << Ending;
210for (
auto It = begin, ItEnd = end; It != ItEnd; ++It) {
211if (!It->IsCriticalEdgeSplit) {
215if (U.getKind() == DomTreeT::Insert)
219 printBlockInfo(U.getFrom(),
", ");
220 printBlockInfo(U.getTo(),
"\n");
222constauto &Edge = It->EdgeSplit;
223OS <<
" " <<
Index++ <<
" : Split critical edge, ";
224 printBlockInfo(Edge.FromBB,
", ");
225 printBlockInfo(Edge.ToBB,
", ");
226 printBlockInfo(Edge.NewBB,
"\n");
232constautoI = PendUpdates.begin() + PendDTUpdateIndex;
233assert(PendUpdates.begin() <=
I &&
I <= PendUpdates.end() &&
234"Iterator out of range.");
235OS <<
"Applied but not cleared DomTreeUpdates:\n";
236 printUpdates(PendUpdates.begin(),
I);
237OS <<
"Pending DomTreeUpdates:\n";
238 printUpdates(
I, PendUpdates.end());
242constautoI = PendUpdates.begin() + PendPDTUpdateIndex;
243assert(PendUpdates.begin() <=
I &&
I <= PendUpdates.end() &&
244"Iterator out of range.");
245OS <<
"Applied but not cleared PostDomTreeUpdates:\n";
246 printUpdates(PendUpdates.begin(),
I);
247OS <<
"Pending PostDomTreeUpdates:\n";
248 printUpdates(
I, PendUpdates.end());
251OS <<
"Pending DeletedBBs:\n";
253for (
constauto *BB : DeletedBBs) {
257OS << BB->getName() <<
"(";
265template <
typename DerivedT,
typename DomTreeT,
typename PostDomTreeT>
266template <
bool IsForward>
268 PostDomTreeT>::applyUpdatesImpl() {
269auto *DomTree = [&]() {
270ifconstexpr (IsForward)
275// No pending DomTreeUpdates. 276if (Strategy != UpdateStrategy::Lazy || !DomTree)
278size_t &PendUpdateIndex = IsForward ? PendDTUpdateIndex : PendPDTUpdateIndex;
280// Only apply updates not are applied by (Post)DomTree. 281while (IsForward ? hasPendingDomTreeUpdates()
282 : hasPendingPostDomTreeUpdates()) {
283autoI = PendUpdates.begin() + PendUpdateIndex;
284constautoE = PendUpdates.end();
285assert(
I <
E &&
"Iterator range invalid; there should be DomTree updates.");
286if (!
I->IsCriticalEdgeSplit) {
288for (;
I !=
E && !
I->IsCriticalEdgeSplit; ++
I)
290 DomTree->applyUpdates(NormalUpdates);
291 PendUpdateIndex += NormalUpdates.
size();
293 SmallVector<CriticalEdge> CriticalEdges;
294for (;
I !=
E &&
I->IsCriticalEdgeSplit; ++
I)
295 CriticalEdges.push_back(
I->EdgeSplit);
296 IsForward ? splitDTCriticalEdges(CriticalEdges)
297 : splitPDTCriticalEdges(CriticalEdges);
298 PendUpdateIndex += CriticalEdges.size();
303template <
typename DerivedT,
typename DomTreeT,
typename PostDomTreeT>
306constauto *
From = Update.getFrom();
307constauto *To = Update.getTo();
308constauto Kind = Update.getKind();
310// Discard updates by inspecting the current state of successors of From. 311// Since isUpdateValid() must be called *after* the Terminator of From is 312// altered we can determine if the update is unnecessary for batch updates 313// or invalid for a single update. 316// If the IR does not match the update, 317// 1. In batch updates, this update is unnecessary. 318// 2. When called by insertEdge*()/deleteEdge*(), this update is invalid. 319// Edge does not exist in IR. 320if (Kind == DomTreeT::Insert && !HasEdge)
324if (Kind == DomTreeT::Delete && HasEdge)
330template <
typename DerivedT,
typename DomTreeT,
typename PostDomTreeT>
333if (DT && !IsRecalculatingDomTree)
337if (PDT && !IsRecalculatingPostDomTree)
338if (PDT->getNode(DelBB))
339 PDT->eraseNode(DelBB);
342template <
typename DerivedT,
typename DomTreeT,
typename PostDomTreeT>
344 PostDomTreeT>::tryFlushDeletedBB() {
345if (!hasPendingUpdates())
346 derived().forceFlushDeletedBB();
349template <
typename DerivedT,
typename DomTreeT,
typename PostDomTreeT>
351 PostDomTreeT>::dropOutOfDateUpdates() {
352if (Strategy == UpdateStrategy::Eager)
357// Drop all updates applied by both trees. 359 PendDTUpdateIndex = PendUpdates.size();
361 PendPDTUpdateIndex = PendUpdates.size();
363constsize_t dropIndex = std::min(PendDTUpdateIndex, PendPDTUpdateIndex);
364constautoB = PendUpdates.begin();
365constautoE = PendUpdates.begin() + dropIndex;
366assert(
B <=
E &&
"Iterator out of range.");
367 PendUpdates.erase(
B,
E);
368// Calculate current index. 369 PendDTUpdateIndex -= dropIndex;
370 PendPDTUpdateIndex -= dropIndex;
373template <
typename DerivedT,
typename DomTreeT,
typename PostDomTreeT>
376// Bail out early if there is nothing to do. 377if (!DT || Edges.
empty())
380// Remember all the basic blocks that are inserted during 382// Invariant: NewBBs == all the basic blocks contained in the NewBB 383// field of all the elements of Edges. 384// I.e., forall elt in Edges, it exists BB in NewBBs 385// such as BB == elt.NewBB. 387for (
auto &Edge : Edges)
388 NewBBs.
insert(Edge.NewBB);
389// For each element in Edges, remember whether or not element 390// is the new immediate domminator of its successor. The mapping is done by 391// index, i.e., the information for the ith element of Edges is 392// the ith element of IsNewIDom. 395// Collect all the dominance properties info, before invalidating 398// Update dominator information. 399 BasicBlockT *Succ = Edge.ToBB;
400auto *SuccDTNode = DT->
getNode(Succ);
403if (PredBB == Edge.NewBB)
405// If we are in this situation: 410// ... Split1 Split2 ... 415// Instead of checking the domiance property with Split2, we check it 416// with FromBB2 since Split2 is still unknown of the underlying DT 420"critical edge split has more " 421"than one predecessor!");
425 IsNewIDom[
Idx] =
false;
431// Now, update DT with the collected dominance properties info. 433// We know FromBB dominates NewBB. 434auto *NewDTNode = DT->
addNewBlock(Edge.NewBB, Edge.FromBB);
436// If all the other predecessors of "Succ" are dominated by "Succ" itself 437// then the new block is the new immediate dominator of "Succ". Otherwise, 438// the new block doesn't dominate anything. 444// Post dominator tree is different, the new basic block in critical edge 445// may become the new root. 446template <
typename DerivedT,
typename DomTreeT,
typename PostDomTreeT>
447void GenericDomTreeUpdater<DerivedT, DomTreeT, PostDomTreeT>::
448 splitPDTCriticalEdges(ArrayRef<CriticalEdge> Edges) {
449// Bail out early if there is nothing to do. 450if (!PDT || Edges.empty())
453 std::vector<UpdateT> Updates;
454for (
constauto &Edge : Edges) {
455 Updates.push_back({PostDomTreeT::Insert, Edge.FromBB, Edge.NewBB});
456 Updates.push_back({PostDomTreeT::Insert, Edge.NewBB, Edge.ToBB});
458 Updates.push_back({PostDomTreeT::Delete, Edge.FromBB, Edge.ToBB});
460 PDT->applyUpdates(Updates);
465#endif// LLVM_ANALYSIS_GENERICDOMTREEUPDATERIMPL_H BlockVerifier::State From
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
#define LLVM_DUMP_METHOD
Mark debug helper function definitions like dump() that should not be stripped from debug builds.
Returns the sub type a function will return at a given Idx Should correspond to the result type of an ExtractValue instruction executed with just that one unsigned Idx
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
This file implements the SmallBitVector class.
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
const_pointer const_iterator
size_t size() const
size - Get the array size.
bool empty() const
empty - Check if the array is empty.
void changeImmediateDominator(DomTreeNodeBase< NodeT > *N, DomTreeNodeBase< NodeT > *NewIDom)
changeImmediateDominator - This method is used to update the dominator tree information when a node's...
DomTreeNodeBase< NodeT > * addNewBlock(NodeT *BB, NodeT *DomBB)
Add a new node to the dominator tree information.
void applyUpdates(ArrayRef< UpdateType > Updates)
Inform the dominator tree about a sequence of CFG edge insertions and deletions and perform a batch u...
void recalculate(ParentType &Func)
recalculate - compute a dominator tree for the given function
void eraseNode(NodeT *BB)
eraseNode - Removes a node from the dominator tree.
DomTreeNodeBase< NodeT > * getNode(const NodeT *BB) const
getNode - return the (Post)DominatorTree node for the specified basic block.
bool dominates(const BasicBlock *BB, const Use &U) const
Return true if the (end of the) basic block BB dominates the use U.
DomTreeT & getDomTree()
Flush DomTree updates and return DomTree.
PostDomTreeT & getPostDomTree()
Flush PostDomTree updates and return PostDomTree.
void applyUpdatesPermissive(ArrayRef< UpdateT > Updates)
Submit updates to all available trees.
void applyUpdates(ArrayRef< UpdateT > Updates)
Submit updates to all available trees.
void eraseDelBBNode(BasicBlockT *DelBB)
Erase Basic Block node before it is unlinked from Function in the DomTree and PostDomTree.
typename DomTreeT::UpdateType UpdateT
typename DomTreeT::NodeType BasicBlockT
void recalculate(FuncT &F)
Notify DTU that the entry block was replaced.
void splitCriticalEdge(BasicBlockT *FromBB, BasicBlockT *ToBB, BasicBlockT *NewBB)
Apply updates that the critical edge (FromBB, ToBB) has been split with NewBB.
bool isUpdateValid(UpdateT Update) const
Returns true if the update appears in the LLVM IR.
LLVM_DUMP_METHOD void dump() const
Debug method to help view the internal state of this class.
This is a 'bitvector' (really, a variable-sized bit array), optimized for the case when the array is ...
SmallSet - This maintains a set of unique values, optimizing for the case when the set is small (less...
bool contains(const T &V) const
Check if the SmallSet contains the given element.
std::pair< const_iterator, bool > insert(const T &V)
insert - Insert an element into the set if it isn't already there.
void push_back(const T &Elt)
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
StringRef - Represent a constant reference to a string, i.e.
This class implements an extremely fast bulk output stream that can only output to a stream.
const_iterator begin(StringRef path LLVM_LIFETIME_BOUND, Style style=Style::native)
Get begin iterator over path.
const_iterator end(StringRef path LLVM_LIFETIME_BOUND)
Get end iterator over path.
This is an optimization pass for GlobalISel generic memory operations.
auto enumerate(FirstRange &&First, RestRanges &&...Rest)
Given two or more input ranges, returns a new range whose values are tuples (A, B,...
auto successors(const MachineBasicBlock *BB)
auto pred_size(const MachineBasicBlock *BB)
raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
auto pred_begin(const MachineBasicBlock *BB)
auto predecessors(const MachineBasicBlock *BB)
bool is_contained(R &&Range, const E &Element)
Returns true if Element is found in Range.
Helper structure used to hold all the basic blocks involved in the split of a critical edge.