LLVM 19.0.0git
DominanceFrontier.h
Go to the documentation of this file.
1//===- llvm/Analysis/DominanceFrontier.h - Dominator Frontiers --*- C++ -*-===//
2//
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
6//
7//===----------------------------------------------------------------------===//
8//
9// This file defines the DominanceFrontier class, which calculate and holds the
10// dominance frontier for a function.
11//
12// This should be considered deprecated, don't add any more uses of this data
13// structure.
14//
15//===----------------------------------------------------------------------===//
16
17#ifndef LLVM_ANALYSIS_DOMINANCEFRONTIER_H
18#define LLVM_ANALYSIS_DOMINANCEFRONTIER_H
19
20#include "llvm/ADT/DenseMap.h"
22#include "llvm/ADT/SetVector.h"
23#include "llvm/Config/llvm-config.h"
24#include "llvm/IR/PassManager.h"
25#include "llvm/Pass.h"
27#include <cassert>
28#include <utility>
29
30namespace llvm {
31
32class Function;
33class raw_ostream;
34
35//===----------------------------------------------------------------------===//
36/// DominanceFrontierBase - Common base class for computing forward and inverse
37/// dominance frontiers for a function.
38///
39template <class BlockT, bool IsPostDom>
41public:
42 // Dom set for a bb. Use SetVector to make iterating dom frontiers of a bb
43 // deterministic.
46
47protected:
49
51 // Postdominators can have multiple roots.
53 static constexpr bool IsPostDominators = IsPostDom;
54
55public:
57
58 /// getRoots - Return the root blocks of the current CFG. This may include
59 /// multiple blocks if we are computing post dominators. For forward
60 /// dominators, this will always be a single block (the entry node).
61 const SmallVectorImpl<BlockT *> &getRoots() const { return Roots; }
62
63 BlockT *getRoot() const {
64 assert(Roots.size() == 1 && "Should always have entry node!");
65 return Roots[0];
66 }
67
68 /// isPostDominator - Returns true if analysis based of postdoms
69 bool isPostDominator() const {
70 return IsPostDominators;
71 }
72
75 }
76
77 // Accessor interface:
80
81 iterator begin() { return Frontiers.begin(); }
82 const_iterator begin() const { return Frontiers.begin(); }
83 iterator end() { return Frontiers.end(); }
84 const_iterator end() const { return Frontiers.end(); }
85 iterator find(BlockT *B) { return Frontiers.find(B); }
86 const_iterator find(BlockT *B) const { return Frontiers.find(B); }
87
88 iterator addBasicBlock(BlockT *BB, const DomSetType &frontier) {
89 assert(find(BB) == end() && "Block already in DominanceFrontier!");
90 return Frontiers.insert(std::make_pair(BB, frontier)).first;
91 }
92
93 /// removeBlock - Remove basic block BB's frontier.
94 void removeBlock(BlockT *BB);
95
96 void addToFrontier(iterator I, BlockT *Node);
97
98 void removeFromFrontier(iterator I, BlockT *Node);
99
100 /// compareDomSet - Return false if two domsets match. Otherwise
101 /// return true;
102 bool compareDomSet(DomSetType &DS1, const DomSetType &DS2) const;
103
104 /// compare - Return true if the other dominance frontier base matches
105 /// this dominance frontier base. Otherwise return false.
107
108 /// print - Convert to human readable form
109 ///
110 void print(raw_ostream &OS) const;
111
112 /// dump - Dump the dominance frontier to dbgs().
113#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
114 void dump() const;
115#endif
116};
117
118//===-------------------------------------
119/// DominanceFrontier Class - Concrete subclass of DominanceFrontierBase that is
120/// used to compute a forward dominator frontiers.
121///
122template <class BlockT>
124 : public DominanceFrontierBase<BlockT, false> {
125private:
127
128public:
132
133 void analyze(DomTreeT &DT) {
134 assert(DT.root_size() == 1 &&
135 "Only one entry block for forward domfronts!");
136 this->Roots = {DT.getRoot()};
137 calculate(DT, DT[this->Roots[0]]);
138 }
139
140 const DomSetType &calculate(const DomTreeT &DT, const DomTreeNodeT *Node);
141};
142
144public:
151
152 /// Handle invalidation explicitly.
153 bool invalidate(Function &F, const PreservedAnalyses &PA,
155};
156
159
160public:
161 static char ID; // Pass ID, replacement for typeid
162
164
166 const DominanceFrontier &getDominanceFrontier() const { return DF; }
167
168 void releaseMemory() override;
169
170 bool runOnFunction(Function &) override;
171
172 void getAnalysisUsage(AnalysisUsage &AU) const override;
173
174 void print(raw_ostream &OS, const Module * = nullptr) const override;
175
176 void dump() const;
177};
178
179extern template class DominanceFrontierBase<BasicBlock, false>;
180extern template class DominanceFrontierBase<BasicBlock, true>;
181extern template class ForwardDominanceFrontierBase<BasicBlock>;
182
183/// Analysis pass which computes a \c DominanceFrontier.
187
188 static AnalysisKey Key;
189
190public:
191 /// Provide the result type for this analysis pass.
193
194 /// Run the analysis pass over a function and produce a dominator tree.
196};
197
198/// Printer pass for the \c DominanceFrontier.
202
203public:
205
207
208 static bool isRequired() { return true; }
209};
210
211} // end namespace llvm
212
213#endif // LLVM_ANALYSIS_DOMINANCEFRONTIER_H
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
This file defines the DenseMap class.
This file defines a set of templates that efficiently compute a dominator tree over a generic graph.
This file defines the little GraphTraits<X> template class that should be specialized by classes that...
#define F(x, y, z)
Definition: MD5.cpp:55
#define I(x, y, z)
Definition: MD5.cpp:58
This header defines various interfaces for pass management in LLVM.
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
raw_pwrite_stream & OS
This file implements a set that has insertion order iteration characteristics.
API to communicate dependencies between analyses during invalidation.
Definition: PassManager.h:387
A container for analyses that lazily runs them and caches their results.
Definition: PassManager.h:348
Represent the analysis usage information of a pass.
iterator find(const_arg_type_t< KeyT > Val)
Definition: DenseMap.h:155
DenseMapIterator< KeyT, ValueT, KeyInfoT, BucketT > iterator
Definition: DenseMap.h:71
iterator begin()
Definition: DenseMap.h:75
iterator end()
Definition: DenseMap.h:84
DenseMapIterator< KeyT, ValueT, KeyInfoT, BucketT, true > const_iterator
Definition: DenseMap.h:73
std::pair< iterator, bool > insert(const std::pair< KeyT, ValueT > &KV)
Definition: DenseMap.h:220
Base class for the actual dominator tree node.
Analysis pass which computes a DominanceFrontier.
DominanceFrontierBase - Common base class for computing forward and inverse dominance frontiers for a...
bool compare(DominanceFrontierBase &Other) const
compare - Return true if the other dominance frontier base matches this dominance frontier base.
void print(raw_ostream &OS) const
print - Convert to human readable form
iterator addBasicBlock(BlockT *BB, const DomSetType &frontier)
const_iterator find(BlockT *B) const
typename DomSetMapType::iterator iterator
bool compareDomSet(DomSetType &DS1, const DomSetType &DS2) const
compareDomSet - Return false if two domsets match.
SmallVector< BlockT *, IsPostDom ? 4 :1 > Roots
const_iterator end() const
const SmallVectorImpl< BlockT * > & getRoots() const
getRoots - Return the root blocks of the current CFG.
void removeFromFrontier(iterator I, BlockT *Node)
static constexpr bool IsPostDominators
void dump() const
dump - Dump the dominance frontier to dbgs().
bool isPostDominator() const
isPostDominator - Returns true if analysis based of postdoms
SetVector< BlockT * > DomSetType
typename DomSetMapType::const_iterator const_iterator
void addToFrontier(iterator I, BlockT *Node)
const_iterator begin() const
void removeBlock(BlockT *BB)
removeBlock - Remove basic block BB's frontier.
Printer pass for the DominanceFrontier.
const DominanceFrontier & getDominanceFrontier() const
bool runOnFunction(Function &) override
runOnFunction - Virtual method overriden by subclasses to do the per-function processing of the pass.
void print(raw_ostream &OS, const Module *=nullptr) const override
print - Print out the internal state of the pass.
void releaseMemory() override
releaseMemory() - This member can be implemented by a pass if it wants to be able to release its memo...
void getAnalysisUsage(AnalysisUsage &AU) const override
getAnalysisUsage - This function should be overriden by passes that need analysis information to do t...
DominanceFrontier & getDominanceFrontier()
bool invalidate(Function &F, const PreservedAnalyses &PA, FunctionAnalysisManager::Invalidator &)
Handle invalidation explicitly.
DominanceFrontierBase< BasicBlock, false >::iterator iterator
DominanceFrontierBase< BasicBlock, false >::DomSetType DomSetType
DominanceFrontierBase< BasicBlock, false >::const_iterator const_iterator
Core dominator tree base class.
size_t root_size() const
NodeT * getRoot() const
DominanceFrontier Class - Concrete subclass of DominanceFrontierBase that is used to compute a forwar...
const DomSetType & calculate(const DomTreeT &DT, const DomTreeNodeT *Node)
typename DominanceFrontierBase< BlockT, false >::DomSetType DomSetType
DomTreeNodeBase< BlockT > DomTreeNodeT
FunctionPass class - This class is used to implement most global optimizations.
Definition: Pass.h:311
A Module instance is used to store all the information related to an LLVM module.
Definition: Module.h:65
A set of analyses that are preserved following a run of a transformation pass.
Definition: Analysis.h:109
A vector that has set insertion semantics.
Definition: SetVector.h:57
size_t size() const
Definition: SmallVector.h:91
This class consists of common code factored out of the SmallVector class to reduce code duplication b...
Definition: SmallVector.h:586
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
Definition: SmallVector.h:1209
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition: raw_ostream.h:52
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
@ Other
Any other memory.
A CRTP mix-in that provides informational APIs needed for analysis passes.
Definition: PassManager.h:114
A special type used by analysis passes to provide an address that identifies that particular analysis...
Definition: Analysis.h:26
A CRTP mix-in to automatically provide informational APIs needed for passes.
Definition: PassManager.h:91