LoopPass.h revision 0b8c9a80f20772c3793201ab5b251d3520b9cea3
1e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver//===- LoopPass.h - LoopPass class ----------------------------------------===// 2e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver// 3e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver// The LLVM Compiler Infrastructure 4e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver// 5e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver// This file is distributed under the University of Illinois Open Source 6e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver// License. See LICENSE.TXT for details. 7e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver// 8e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver//===----------------------------------------------------------------------===// 9e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver// 10e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver// This file defines LoopPass class. All loop optimization 11e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver// and transformation passes are derived from LoopPass. 12e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver// 13e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver//===----------------------------------------------------------------------===// 14e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver 15e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver#ifndef LLVM_LOOP_PASS_H 16e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver#define LLVM_LOOP_PASS_H 17e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver 18e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver#include "llvm/Analysis/LoopInfo.h" 19e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver#include "llvm/IR/Function.h" 20e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver#include "llvm/Pass.h" 21e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver#include "llvm/PassManagers.h" 22e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver#include <deque> 23e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver 24e88723c666db87d414e126ac6d94d683d86ad28dBen Gruvernamespace llvm { 25e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver 26e88723c666db87d414e126ac6d94d683d86ad28dBen Gruverclass LPPassManager; 27e88723c666db87d414e126ac6d94d683d86ad28dBen Gruverclass Function; 28e88723c666db87d414e126ac6d94d683d86ad28dBen Gruverclass PMStack; 29e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver 30e88723c666db87d414e126ac6d94d683d86ad28dBen Gruverclass LoopPass : public Pass { 31e88723c666db87d414e126ac6d94d683d86ad28dBen Gruverpublic: 32e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver explicit LoopPass(char &pid) : Pass(PT_Loop, pid) {} 33e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver 34e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver /// getPrinterPass - Get a pass to print the function corresponding 35e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver /// to a Loop. 36e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver Pass *createPrinterPass(raw_ostream &O, const std::string &Banner) const; 37 38 // runOnLoop - This method should be implemented by the subclass to perform 39 // whatever action is necessary for the specified Loop. 40 virtual bool runOnLoop(Loop *L, LPPassManager &LPM) = 0; 41 42 using llvm::Pass::doInitialization; 43 using llvm::Pass::doFinalization; 44 45 // Initialization and finalization hooks. 46 virtual bool doInitialization(Loop *L, LPPassManager &LPM) { 47 return false; 48 } 49 50 // Finalization hook does not supply Loop because at this time 51 // loop nest is completely different. 52 virtual bool doFinalization() { return false; } 53 54 // Check if this pass is suitable for the current LPPassManager, if 55 // available. This pass P is not suitable for a LPPassManager if P 56 // is not preserving higher level analysis info used by other 57 // LPPassManager passes. In such case, pop LPPassManager from the 58 // stack. This will force assignPassManager() to create new 59 // LPPassManger as expected. 60 void preparePassManager(PMStack &PMS); 61 62 /// Assign pass manager to manage this pass 63 virtual void assignPassManager(PMStack &PMS, 64 PassManagerType PMT); 65 66 /// Return what kind of Pass Manager can manage this pass. 67 virtual PassManagerType getPotentialPassManagerType() const { 68 return PMT_LoopPassManager; 69 } 70 71 //===--------------------------------------------------------------------===// 72 /// SimpleAnalysis - Provides simple interface to update analysis info 73 /// maintained by various passes. Note, if required this interface can 74 /// be extracted into a separate abstract class but it would require 75 /// additional use of multiple inheritance in Pass class hierarchy, something 76 /// we are trying to avoid. 77 78 /// Each loop pass can override these simple analysis hooks to update 79 /// desired analysis information. 80 /// cloneBasicBlockAnalysis - Clone analysis info associated with basic block. 81 virtual void cloneBasicBlockAnalysis(BasicBlock *F, BasicBlock *T, Loop *L) {} 82 83 /// deleteAnalysisValue - Delete analysis info associated with value V. 84 virtual void deleteAnalysisValue(Value *V, Loop *L) {} 85}; 86 87class LPPassManager : public FunctionPass, public PMDataManager { 88public: 89 static char ID; 90 explicit LPPassManager(); 91 92 /// run - Execute all of the passes scheduled for execution. Keep track of 93 /// whether any of the passes modifies the module, and if so, return true. 94 bool runOnFunction(Function &F); 95 96 /// Pass Manager itself does not invalidate any analysis info. 97 // LPPassManager needs LoopInfo. 98 void getAnalysisUsage(AnalysisUsage &Info) const; 99 100 virtual const char *getPassName() const { 101 return "Loop Pass Manager"; 102 } 103 104 virtual PMDataManager *getAsPMDataManager() { return this; } 105 virtual Pass *getAsPass() { return this; } 106 107 /// Print passes managed by this manager 108 void dumpPassStructure(unsigned Offset); 109 110 LoopPass *getContainedPass(unsigned N) { 111 assert(N < PassVector.size() && "Pass number out of range!"); 112 LoopPass *LP = static_cast<LoopPass *>(PassVector[N]); 113 return LP; 114 } 115 116 virtual PassManagerType getPassManagerType() const { 117 return PMT_LoopPassManager; 118 } 119 120public: 121 // Delete loop from the loop queue and loop nest (LoopInfo). 122 void deleteLoopFromQueue(Loop *L); 123 124 // Insert loop into the loop queue and add it as a child of the 125 // given parent. 126 void insertLoop(Loop *L, Loop *ParentLoop); 127 128 // Insert a loop into the loop queue. 129 void insertLoopIntoQueue(Loop *L); 130 131 // Reoptimize this loop. LPPassManager will re-insert this loop into the 132 // queue. This allows LoopPass to change loop nest for the loop. This 133 // utility may send LPPassManager into infinite loops so use caution. 134 void redoLoop(Loop *L); 135 136 //===--------------------------------------------------------------------===// 137 /// SimpleAnalysis - Provides simple interface to update analysis info 138 /// maintained by various passes. Note, if required this interface can 139 /// be extracted into a separate abstract class but it would require 140 /// additional use of multiple inheritance in Pass class hierarchy, something 141 /// we are trying to avoid. 142 143 /// cloneBasicBlockSimpleAnalysis - Invoke cloneBasicBlockAnalysis hook for 144 /// all passes that implement simple analysis interface. 145 void cloneBasicBlockSimpleAnalysis(BasicBlock *From, BasicBlock *To, Loop *L); 146 147 /// deleteSimpleAnalysisValue - Invoke deleteAnalysisValue hook for all passes 148 /// that implement simple analysis interface. 149 void deleteSimpleAnalysisValue(Value *V, Loop *L); 150 151private: 152 std::deque<Loop *> LQ; 153 bool skipThisLoop; 154 bool redoThisLoop; 155 LoopInfo *LI; 156 Loop *CurrentLoop; 157}; 158 159} // End llvm namespace 160 161#endif 162