LLVM  6.0.0svn
LoopPass.cpp
Go to the documentation of this file.
1 //===- LoopPass.cpp - Loop Pass and Loop Pass Manager ---------------------===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file implements LoopPass and LPPassManager. All loop optimization
11 // and transformation passes are derived from LoopPass. LPPassManager is
12 // responsible for managing LoopPasses.
13 //
14 //===----------------------------------------------------------------------===//
15 
16 #include "llvm/Analysis/LoopPass.h"
18 #include "llvm/IR/Dominators.h"
20 #include "llvm/IR/LLVMContext.h"
21 #include "llvm/IR/OptBisect.h"
22 #include "llvm/IR/PassManager.h"
23 #include "llvm/Support/Debug.h"
24 #include "llvm/Support/Timer.h"
26 using namespace llvm;
27 
28 #define DEBUG_TYPE "loop-pass-manager"
29 
30 namespace {
31 
32 /// PrintLoopPass - Print a Function corresponding to a Loop.
33 ///
34 class PrintLoopPassWrapper : public LoopPass {
35  raw_ostream &OS;
36  std::string Banner;
37 
38 public:
39  static char ID;
40  PrintLoopPassWrapper() : LoopPass(ID), OS(dbgs()) {}
41  PrintLoopPassWrapper(raw_ostream &OS, const std::string &Banner)
42  : LoopPass(ID), OS(OS), Banner(Banner) {}
43 
44  void getAnalysisUsage(AnalysisUsage &AU) const override {
45  AU.setPreservesAll();
46  }
47 
48  bool runOnLoop(Loop *L, LPPassManager &) override {
49  auto BBI = find_if(L->blocks().begin(), L->blocks().end(),
50  [](BasicBlock *BB) { return BB; });
51  if (BBI != L->blocks().end() &&
52  isFunctionInPrintList((*BBI)->getParent()->getName())) {
53  printLoop(*L, OS, Banner);
54  }
55  return false;
56  }
57 
58  StringRef getPassName() const override { return "Print Loop IR"; }
59 };
60 
62 }
63 
64 //===----------------------------------------------------------------------===//
65 // LPPassManager
66 //
67 
68 char LPPassManager::ID = 0;
69 
72  LI = nullptr;
73  CurrentLoop = nullptr;
74 }
75 
76 // Insert loop into loop nest (LoopInfo) and loop queue (LQ).
78  if (!L.getParentLoop()) {
79  // This is the top level loop.
80  LQ.push_front(&L);
81  return;
82  }
83 
84  // Insert L into the loop queue after the parent loop.
85  for (auto I = LQ.begin(), E = LQ.end(); I != E; ++I) {
86  if (*I == L.getParentLoop()) {
87  // deque does not support insert after.
88  ++I;
89  LQ.insert(I, 1, &L);
90  return;
91  }
92  }
93 }
94 
95 /// cloneBasicBlockSimpleAnalysis - Invoke cloneBasicBlockAnalysis hook for
96 /// all loop passes.
98  BasicBlock *To, Loop *L) {
99  for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
100  LoopPass *LP = getContainedPass(Index);
101  LP->cloneBasicBlockAnalysis(From, To, L);
102  }
103 }
104 
105 /// deleteSimpleAnalysisValue - Invoke deleteAnalysisValue hook for all passes.
107  if (BasicBlock *BB = dyn_cast<BasicBlock>(V)) {
108  for (Instruction &I : *BB) {
110  }
111  }
112  for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
113  LoopPass *LP = getContainedPass(Index);
114  LP->deleteAnalysisValue(V, L);
115  }
116 }
117 
118 /// Invoke deleteAnalysisLoop hook for all passes.
120  for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
121  LoopPass *LP = getContainedPass(Index);
122  LP->deleteAnalysisLoop(L);
123  }
124 }
125 
126 
127 // Recurse through all subloops and all loops into LQ.
128 static void addLoopIntoQueue(Loop *L, std::deque<Loop *> &LQ) {
129  LQ.push_back(L);
130  for (Loop *I : reverse(*L))
131  addLoopIntoQueue(I, LQ);
132 }
133 
134 /// Pass Manager itself does not invalidate any analysis info.
136  // LPPassManager needs LoopInfo. In the long term LoopInfo class will
137  // become part of LPPassManager.
140  Info.setPreservesAll();
141 }
142 
143 /// run - Execute all of the passes scheduled for execution. Keep track of
144 /// whether any of the passes modifies the function, and if so, return true.
146  auto &LIWP = getAnalysis<LoopInfoWrapperPass>();
147  LI = &LIWP.getLoopInfo();
148  DominatorTree *DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree();
149  bool Changed = false;
150 
151  // Collect inherited analysis from Module level pass manager.
153 
154  // Populate the loop queue in reverse program order. There is no clear need to
155  // process sibling loops in either forward or reverse order. There may be some
156  // advantage in deleting uses in a later loop before optimizing the
157  // definitions in an earlier loop. If we find a clear reason to process in
158  // forward order, then a forward variant of LoopPassManager should be created.
159  //
160  // Note that LoopInfo::iterator visits loops in reverse program
161  // order. Here, reverse_iterator gives us a forward order, and the LoopQueue
162  // reverses the order a third time by popping from the back.
163  for (Loop *L : reverse(*LI))
164  addLoopIntoQueue(L, LQ);
165 
166  if (LQ.empty()) // No loops, skip calling finalizers
167  return false;
168 
169  // Initialization
170  for (Loop *L : LQ) {
171  for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
172  LoopPass *P = getContainedPass(Index);
173  Changed |= P->doInitialization(L, *this);
174  }
175  }
176 
177  // Walk Loops
178  while (!LQ.empty()) {
179  bool LoopWasDeleted = false;
180  CurrentLoop = LQ.back();
181 
182  // Run all passes on the current Loop.
183  for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
184  LoopPass *P = getContainedPass(Index);
185 
187  CurrentLoop->getHeader()->getName());
188  dumpRequiredSet(P);
189 
191 
192  {
193  PassManagerPrettyStackEntry X(P, *CurrentLoop->getHeader());
194  TimeRegion PassTimer(getPassTimer(P));
195 
196  Changed |= P->runOnLoop(CurrentLoop, *this);
197  }
198  LoopWasDeleted = CurrentLoop->isInvalid();
199 
200  if (Changed)
202  LoopWasDeleted ? "<deleted>"
203  : CurrentLoop->getHeader()->getName());
204  dumpPreservedSet(P);
205 
206  if (LoopWasDeleted) {
207  // Notify passes that the loop is being deleted.
208  deleteSimpleAnalysisLoop(CurrentLoop);
209  } else {
210  // Manually check that this loop is still healthy. This is done
211  // instead of relying on LoopInfo::verifyLoop since LoopInfo
212  // is a function pass and it's really expensive to verify every
213  // loop in the function every time. That level of checking can be
214  // enabled with the -verify-loop-info option.
215  {
216  TimeRegion PassTimer(getPassTimer(&LIWP));
217  CurrentLoop->verifyLoop();
218  }
219  // Here we apply same reasoning as in the above case. Only difference
220  // is that LPPassManager might run passes which do not require LCSSA
221  // form (LoopPassPrinter for example). We should skip verification for
222  // such passes.
224  CurrentLoop->isRecursivelyLCSSAForm(*DT, *LI);
225 
226  // Then call the regular verifyAnalysis functions.
228 
229  F.getContext().yield();
230  }
231 
234  removeDeadPasses(P, LoopWasDeleted ? "<deleted>"
235  : CurrentLoop->getHeader()->getName(),
236  ON_LOOP_MSG);
237 
238  if (LoopWasDeleted)
239  // Do not run other passes on this loop.
240  break;
241  }
242 
243  // If the loop was deleted, release all the loop passes. This frees up
244  // some memory, and avoids trouble with the pass manager trying to call
245  // verifyAnalysis on them.
246  if (LoopWasDeleted) {
247  for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
248  Pass *P = getContainedPass(Index);
249  freePass(P, "<deleted>", ON_LOOP_MSG);
250  }
251  }
252 
253  // Pop the loop from queue after running all passes.
254  LQ.pop_back();
255  }
256 
257  // Finalization
258  for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
259  LoopPass *P = getContainedPass(Index);
260  Changed |= P->doFinalization();
261  }
262 
263  return Changed;
264 }
265 
266 /// Print passes managed by this manager
268  errs().indent(Offset*2) << "Loop Pass Manager\n";
269  for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
270  Pass *P = getContainedPass(Index);
271  P->dumpPassStructure(Offset + 1);
272  dumpLastUses(P, Offset+1);
273  }
274 }
275 
276 
277 //===----------------------------------------------------------------------===//
278 // LoopPass
279 
281  const std::string &Banner) const {
282  return new PrintLoopPassWrapper(O, Banner);
283 }
284 
285 // Check if this pass is suitable for the current LPPassManager, if
286 // available. This pass P is not suitable for a LPPassManager if P
287 // is not preserving higher level analysis info used by other
288 // LPPassManager passes. In such case, pop LPPassManager from the
289 // stack. This will force assignPassManager() to create new
290 // LPPassManger as expected.
292 
293  // Find LPPassManager
294  while (!PMS.empty() &&
296  PMS.pop();
297 
298  // If this pass is destroying high level information that is used
299  // by other passes that are managed by LPM then do not insert
300  // this pass in current LPM. Use new LPPassManager.
301  if (PMS.top()->getPassManagerType() == PMT_LoopPassManager &&
302  !PMS.top()->preserveHigherLevelAnalysis(this))
303  PMS.pop();
304 }
305 
306 /// Assign pass manager to manage this pass.
308  PassManagerType PreferredType) {
309  // Find LPPassManager
310  while (!PMS.empty() &&
312  PMS.pop();
313 
314  LPPassManager *LPPM;
316  LPPM = (LPPassManager*)PMS.top();
317  else {
318  // Create new Loop Pass Manager if it does not exist.
319  assert (!PMS.empty() && "Unable to create Loop Pass Manager");
320  PMDataManager *PMD = PMS.top();
321 
322  // [1] Create new Loop Pass Manager
323  LPPM = new LPPassManager();
324  LPPM->populateInheritedAnalysis(PMS);
325 
326  // [2] Set up new manager's top level manager
327  PMTopLevelManager *TPM = PMD->getTopLevelManager();
328  TPM->addIndirectPassManager(LPPM);
329 
330  // [3] Assign manager to manage this new manager. This may create
331  // and push new managers into PMS
332  Pass *P = LPPM->getAsPass();
333  TPM->schedulePass(P);
334 
335  // [4] Push new manager into PMS
336  PMS.push(LPPM);
337  }
338 
339  LPPM->add(this);
340 }
341 
342 bool LoopPass::skipLoop(const Loop *L) const {
343  const Function *F = L->getHeader()->getParent();
344  if (!F)
345  return false;
346  // Check the opt bisect limit.
348  if (!Context.getOptBisect().shouldRunPass(this, *L))
349  return true;
350  // Check for the OptimizeNone attribute.
351  if (F->hasFnAttribute(Attribute::OptimizeNone)) {
352  // FIXME: Report this to dbgs() only once per function.
353  DEBUG(dbgs() << "Skipping pass '" << getPassName()
354  << "' in function " << F->getName() << "\n");
355  // FIXME: Delete loop from pass manager's queue?
356  return true;
357  }
358  return false;
359 }
360 
362 INITIALIZE_PASS(LCSSAVerificationPass, "lcssa-verification", "LCSSA Verifier",
363  false, false)
364 
PMTopLevelManager * TPM
Pass interface - Implemented by all &#39;passes&#39;.
Definition: Pass.h:81
bool preserveHigherLevelAnalysis(Pass *P)
PassManagerType
Different types of internal pass managers.
Definition: Pass.h:54
bool shouldRunPass(const Pass *P, const UnitT &U)
Checks the bisect limit to determine if the specified pass should run.
Definition: OptBisect.cpp:97
static GCMetadataPrinterRegistry::Add< ErlangGCPrinter > X("erlang", "erlang-compatible garbage collector")
raw_ostream & errs()
This returns a reference to a raw_ostream for standard error.
LLVMContext & Context
Compute iterated dominance frontiers using a linear time algorithm.
Definition: AllocatorList.h:24
virtual void dumpPassStructure(unsigned Offset=0)
Definition: Pass.cpp:59
void dumpLastUses(Pass *P, unsigned Offset) const
bool isRecursivelyLCSSAForm(DominatorTree &DT, const LoopInfo &LI) const
Return true if this Loop and all inner subloops are in LCSSA form.
Definition: LoopInfo.cpp:181
virtual void deleteAnalysisLoop(Loop *L)
Delete analysis info associated with Loop L.
Definition: LoopPass.h:88
raw_ostream & indent(unsigned NumSpaces)
indent - Insert &#39;NumSpaces&#39; spaces.
StringRef getPassName() const override
getPassName - Return a nice clean name for a pass.
Definition: LoopPass.h:110
bool hasFnAttribute(Attribute::AttrKind Kind) const
Return true if the function has the attribute.
Definition: Function.h:254
void assignPassManager(PMStack &PMS, PassManagerType PMT) override
Assign pass manager to manage this pass.
Definition: LoopPass.cpp:307
void yield()
Calls the yield callback (if applicable).
void dumpPassInfo(Pass *P, enum PassDebuggingString S1, enum PassDebuggingString S2, StringRef Msg)
bool mustPreserveAnalysisID(char &AID) const
mustPreserveAnalysisID - This method serves the same function as getAnalysisIfAvailable, but works if you just have an AnalysisID.
Definition: Pass.cpp:54
PMTopLevelManager manages LastUser info and collects common APIs used by top level pass managers...
Timer * getPassTimer(Pass *)
If TimingInfo is enabled then start pass timer.
static void addLoopIntoQueue(Loop *L, std::deque< Loop *> &LQ)
Definition: LoopPass.cpp:128
The TimeRegion class is used as a helper class to call the startTimer() and stopTimer() methods of th...
Definition: Timer.h:140
void schedulePass(Pass *P)
Schedule pass P for execution.
AnalysisUsage & addRequired()
void freePass(Pass *P, StringRef Msg, enum PassDebuggingString)
Remove P.
void deleteSimpleAnalysisLoop(Loop *L)
Invoke deleteAnalysisLoop hook for all passes that implement simple analysis interface.
Definition: LoopPass.cpp:119
void verifyPreservedAnalysis(Pass *P)
verifyPreservedAnalysis – Verify analysis presreved by pass P.
void populateInheritedAnalysis(PMStack &PMS)
PMStack - This class implements a stack data structure of PMDataManager pointers. ...
void initializeAnalysisImpl(Pass *P)
All Required analyses should be available to the pass as it runs! Here we fill in the AnalysisImpls m...
PassManagerPrettyStackEntry - This is used to print informative information about what pass is runnin...
BlockT * getHeader() const
Definition: LoopInfo.h:103
auto reverse(ContainerTy &&C, typename std::enable_if< has_rbegin< ContainerTy >::value >::type *=nullptr) -> decltype(make_range(C.rbegin(), C.rend()))
Definition: STLExtras.h:250
Pass * createPrinterPass(raw_ostream &O, const std::string &Banner) const override
getPrinterPass - Get a pass to print the function corresponding to a Loop.
Definition: LoopPass.cpp:280
bool isInvalid()
Return true if this loop is no longer valid.
Definition: LoopInfo.h:157
#define F(x, y, z)
Definition: MD5.cpp:55
void add(Pass *P, bool ProcessAnalysis=true)
Add pass P into the PassVector.
This header provides classes for managing per-loop analyses.
Concrete subclass of DominatorTreeBase that is used to compute a normal dominator tree...
Definition: Dominators.h:134
virtual bool doInitialization(Loop *L, LPPassManager &LPM)
Definition: LoopPass.h:46
#define P(N)
LLVM Basic Block Representation.
Definition: BasicBlock.h:59
This is an important class for using LLVM in a threaded context.
Definition: LLVMContext.h:68
virtual bool doFinalization()
Definition: LoopPass.h:52
void addIndirectPassManager(PMDataManager *Manager)
virtual PassManagerType getPassManagerType() const
void getAnalysisUsage(AnalysisUsage &Info) const override
Pass Manager itself does not invalidate any analysis info.
Definition: LoopPass.cpp:135
Represent the analysis usage information of a pass.
FunctionPass class - This class is used to implement most global optimizations.
Definition: Pass.h:298
LLVMContext & getContext() const
getContext - Return a reference to the LLVMContext associated with this function. ...
Definition: Function.cpp:194
static char ID
Definition: LoopPass.h:99
#define INITIALIZE_PASS(passName, arg, name, cfg, analysis)
Definition: PassSupport.h:34
bool skipLoop(const Loop *L) const
Optional passes call this function to check whether the pass should be skipped.
Definition: LoopPass.cpp:342
void deleteSimpleAnalysisValue(Value *V, Loop *L)
deleteSimpleAnalysisValue - Invoke deleteAnalysisValue hook for all passes that implement simple anal...
Definition: LoopPass.cpp:106
LPPassManager.
Definition: Pass.h:59
#define E
Definition: LargeTest.cpp:27
void recordAvailableAnalysis(Pass *P)
Augment AvailableAnalysis by adding analysis made available by pass P.
void dumpRequiredSet(const Pass *P) const
void removeNotPreservedAnalysis(Pass *P)
Remove Analysis that is not preserved by the pass.
void removeDeadPasses(Pass *P, StringRef Msg, enum PassDebuggingString)
Remove dead passes used by P.
This file declares the interface for bisecting optimizations.
bool isFunctionInPrintList(StringRef FunctionName)
isFunctionInPrintList - returns true if a function should be printed via
raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
Definition: Debug.cpp:132
void setPreservesAll()
Set by analyses that do not transform their input at all.
void dumpPassStructure(unsigned Offset) override
Print passes managed by this manager.
Definition: LoopPass.cpp:267
void preparePassManager(PMStack &PMS) override
Check if available pass managers are suitable for this pass or not.
Definition: LoopPass.cpp:291
virtual bool runOnLoop(Loop *L, LPPassManager &LPM)=0
LoopT * getParentLoop() const
Definition: LoopInfo.h:104
void cloneBasicBlockSimpleAnalysis(BasicBlock *From, BasicBlock *To, Loop *L)
SimpleAnalysis - Provides simple interface to update analysis info maintained by various passes...
Definition: LoopPass.cpp:97
Represents a single loop in the control flow graph.
Definition: LoopInfo.h:360
OptBisect & getOptBisect()
Access the object which manages optimization bisection for failure analysis.
StringRef getName() const
Return a constant reference to the value&#39;s name.
Definition: Value.cpp:218
const Function * getParent() const
Return the enclosing method, or null if none.
Definition: BasicBlock.h:108
#define I(x, y, z)
Definition: MD5.cpp:58
void addLoop(Loop &L)
Definition: LoopPass.cpp:77
LoopPass * getContainedPass(unsigned N)
Definition: LoopPass.h:118
void push(PMDataManager *PM)
PMDataManager provides the common place to manage the analysis data used by pass managers.
This file defines passes to print out IR in various granularities.
virtual void cloneBasicBlockAnalysis(BasicBlock *F, BasicBlock *T, Loop *L)
SimpleAnalysis - Provides simple interface to update analysis info maintained by various passes...
Definition: LoopPass.h:80
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
PMDataManager * top() const
LLVM Value Representation.
Definition: Value.h:73
virtual void deleteAnalysisValue(Value *V, Loop *L)
deleteAnalysisValue - Delete analysis info associated with value V.
Definition: LoopPass.h:83
bool runOnFunction(Function &F) override
run - Execute all of the passes scheduled for execution.
Definition: LoopPass.cpp:145
unsigned getNumContainedPasses() const
bool empty() const
This class implements an extremely fast bulk output stream that can only output to a stream...
Definition: raw_ostream.h:44
#define DEBUG(X)
Definition: Debug.h:118
The legacy pass manager&#39;s analysis pass to compute loop information.
Definition: LoopInfo.h:845
void verifyLoop() const
Verify loop structure.
Definition: LoopInfoImpl.h:215
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:49
Pass * getAsPass() override
Definition: LoopPass.h:113
Legacy analysis pass which computes a DominatorTree.
Definition: Dominators.h:261
This header defines various interfaces for pass management in LLVM.
auto find_if(R &&Range, UnaryPredicate P) -> decltype(std::begin(Range))
Provide wrappers to std::find_if which take ranges instead of having to pass begin/end explicitly...
Definition: STLExtras.h:846
iterator_range< block_iterator > blocks() const
Definition: LoopInfo.h:144
void printLoop(Loop &L, raw_ostream &OS, const std::string &Banner="")
Function to print a loop&#39;s contents as LLVM&#39;s text IR assembly.
Definition: LoopInfo.cpp:704
void dumpPreservedSet(const Pass *P) const