1 //===- LoopExtractor.cpp - Extract each loop into a new function ----------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // A pass wrapper around the ExtractLoop() scalar transformation to extract each
11 // top-level loop into its own new function. If the loop is the ONLY loop in a
12 // given function, it is not touched. This is a pass most useful for debugging
15 //===----------------------------------------------------------------------===//
17 #define DEBUG_TYPE "loop-extract"
18 #include "llvm/Transforms/IPO.h"
19 #include "llvm/Instructions.h"
20 #include "llvm/Module.h"
21 #include "llvm/Pass.h"
22 #include "llvm/Analysis/Dominators.h"
23 #include "llvm/Analysis/LoopPass.h"
24 #include "llvm/Support/CommandLine.h"
25 #include "llvm/Transforms/Scalar.h"
26 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
27 #include "llvm/Transforms/Utils/FunctionUtils.h"
28 #include "llvm/ADT/Statistic.h"
33 STATISTIC(NumExtracted, "Number of loops extracted");
36 struct LoopExtractor : public LoopPass {
37 static char ID; // Pass identification, replacement for typeid
40 explicit LoopExtractor(unsigned numLoops = ~0)
41 : LoopPass(ID), NumLoops(numLoops) {
42 initializeLoopExtractorPass(*PassRegistry::getPassRegistry());
45 virtual bool runOnLoop(Loop *L, LPPassManager &LPM);
47 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
48 AU.addRequiredID(BreakCriticalEdgesID);
49 AU.addRequiredID(LoopSimplifyID);
50 AU.addRequired<DominatorTree>();
55 char LoopExtractor::ID = 0;
56 INITIALIZE_PASS_BEGIN(LoopExtractor, "loop-extract",
57 "Extract loops into new functions", false, false)
58 INITIALIZE_PASS_DEPENDENCY(BreakCriticalEdges)
59 INITIALIZE_PASS_DEPENDENCY(LoopSimplify)
60 INITIALIZE_PASS_DEPENDENCY(DominatorTree)
61 INITIALIZE_PASS_END(LoopExtractor, "loop-extract",
62 "Extract loops into new functions", false, false)
65 /// SingleLoopExtractor - For bugpoint.
66 struct SingleLoopExtractor : public LoopExtractor {
67 static char ID; // Pass identification, replacement for typeid
68 SingleLoopExtractor() : LoopExtractor(1) {}
70 } // End anonymous namespace
72 char SingleLoopExtractor::ID = 0;
73 INITIALIZE_PASS(SingleLoopExtractor, "loop-extract-single",
74 "Extract at most one loop into a new function", false, false)
76 // createLoopExtractorPass - This pass extracts all natural loops from the
77 // program into a function if it can.
79 Pass *llvm::createLoopExtractorPass() { return new LoopExtractor(); }
81 bool LoopExtractor::runOnLoop(Loop *L, LPPassManager &LPM) {
82 // Only visit top-level loops.
83 if (L->getParentLoop())
86 // If LoopSimplify form is not available, stay out of trouble.
87 if (!L->isLoopSimplifyForm())
90 DominatorTree &DT = getAnalysis<DominatorTree>();
93 // If there is more than one top-level loop in this function, extract all of
94 // the loops. Otherwise there is exactly one top-level loop; in this case if
95 // this function is more than a minimal wrapper around the loop, extract
97 bool ShouldExtractLoop = false;
99 // Extract the loop if the entry block doesn't branch to the loop header.
100 TerminatorInst *EntryTI =
101 L->getHeader()->getParent()->getEntryBlock().getTerminator();
102 if (!isa<BranchInst>(EntryTI) ||
103 !cast<BranchInst>(EntryTI)->isUnconditional() ||
104 EntryTI->getSuccessor(0) != L->getHeader())
105 ShouldExtractLoop = true;
107 // Check to see if any exits from the loop are more than just return
109 SmallVector<BasicBlock*, 8> ExitBlocks;
110 L->getExitBlocks(ExitBlocks);
111 for (unsigned i = 0, e = ExitBlocks.size(); i != e; ++i)
112 if (!isa<ReturnInst>(ExitBlocks[i]->getTerminator())) {
113 ShouldExtractLoop = true;
117 if (ShouldExtractLoop) {
118 if (NumLoops == 0) return Changed;
120 if (ExtractLoop(DT, L) != 0) {
122 // After extraction, the loop is replaced by a function call, so
123 // we shouldn't try to run any more loop passes on it.
124 LPM.deleteLoopFromQueue(L);
132 // createSingleLoopExtractorPass - This pass extracts one natural loop from the
133 // program into a function if it can. This is used by bugpoint.
135 Pass *llvm::createSingleLoopExtractorPass() {
136 return new SingleLoopExtractor();
140 // BlockFile - A file which contains a list of blocks that should not be
142 static cl::opt<std::string>
143 BlockFile("extract-blocks-file", cl::value_desc("filename"),
144 cl::desc("A file containing list of basic blocks to not extract"),
148 /// BlockExtractorPass - This pass is used by bugpoint to extract all blocks
149 /// from the module into their own functions except for those specified by the
150 /// BlocksToNotExtract list.
151 class BlockExtractorPass : public ModulePass {
152 void LoadFile(const char *Filename);
153 void SplitLandingPadPreds(Function *F);
155 std::vector<BasicBlock*> BlocksToNotExtract;
156 std::vector<std::pair<std::string, std::string> > BlocksToNotExtractByName;
158 static char ID; // Pass identification, replacement for typeid
159 BlockExtractorPass() : ModulePass(ID) {
160 if (!BlockFile.empty())
161 LoadFile(BlockFile.c_str());
164 bool runOnModule(Module &M);
168 char BlockExtractorPass::ID = 0;
169 INITIALIZE_PASS(BlockExtractorPass, "extract-blocks",
170 "Extract Basic Blocks From Module (for bugpoint use)",
173 // createBlockExtractorPass - This pass extracts all blocks (except those
174 // specified in the argument list) from the functions in the module.
176 ModulePass *llvm::createBlockExtractorPass() {
177 return new BlockExtractorPass();
180 void BlockExtractorPass::LoadFile(const char *Filename) {
181 // Load the BlockFile...
182 std::ifstream In(Filename);
184 errs() << "WARNING: BlockExtractor couldn't load file '" << Filename
189 std::string FunctionName, BlockName;
192 if (!BlockName.empty())
193 BlocksToNotExtractByName.push_back(
194 std::make_pair(FunctionName, BlockName));
198 /// SplitLandingPadPreds - The landing pad needs to be extracted with the invoke
199 /// instruction. The critical edge breaker will refuse to break critical edges
200 /// to a landing pad. So do them here. After this method runs, all landing pads
201 /// should have only one predecessor.
202 void BlockExtractorPass::SplitLandingPadPreds(Function *F) {
203 for (Function::iterator I = F->begin(), E = F->end(); I != E; ++I) {
204 InvokeInst *II = dyn_cast<InvokeInst>(I);
206 BasicBlock *Parent = II->getParent();
207 BasicBlock *LPad = II->getUnwindDest();
209 // Look through the landing pad's predecessors. If one of them ends in an
210 // 'invoke', then we want to split the landing pad.
213 PI = pred_begin(LPad), PE = pred_end(LPad); PI != PE; ++PI) {
214 BasicBlock *BB = *PI;
215 if (BB->isLandingPad() && BB != Parent &&
216 isa<InvokeInst>(Parent->getTerminator())) {
222 if (!Split) continue;
224 SmallVector<BasicBlock*, 2> NewBBs;
225 SplitLandingPadPredecessors(LPad, Parent, ".1", ".2", 0, NewBBs);
229 bool BlockExtractorPass::runOnModule(Module &M) {
230 std::set<BasicBlock*> TranslatedBlocksToNotExtract;
231 for (unsigned i = 0, e = BlocksToNotExtract.size(); i != e; ++i) {
232 BasicBlock *BB = BlocksToNotExtract[i];
233 Function *F = BB->getParent();
235 // Map the corresponding function in this module.
236 Function *MF = M.getFunction(F->getName());
237 assert(MF->getFunctionType() == F->getFunctionType() && "Wrong function?");
239 // Figure out which index the basic block is in its function.
240 Function::iterator BBI = MF->begin();
241 std::advance(BBI, std::distance(F->begin(), Function::iterator(BB)));
242 TranslatedBlocksToNotExtract.insert(BBI);
245 while (!BlocksToNotExtractByName.empty()) {
246 // There's no way to find BBs by name without looking at every BB inside
247 // every Function. Fortunately, this is always empty except when used by
248 // bugpoint in which case correctness is more important than performance.
250 std::string &FuncName = BlocksToNotExtractByName.back().first;
251 std::string &BlockName = BlocksToNotExtractByName.back().second;
253 for (Module::iterator FI = M.begin(), FE = M.end(); FI != FE; ++FI) {
255 if (F.getName() != FuncName) continue;
257 for (Function::iterator BI = F.begin(), BE = F.end(); BI != BE; ++BI) {
258 BasicBlock &BB = *BI;
259 if (BB.getName() != BlockName) continue;
261 TranslatedBlocksToNotExtract.insert(BI);
265 BlocksToNotExtractByName.pop_back();
268 // Now that we know which blocks to not extract, figure out which ones we WANT
270 std::vector<BasicBlock*> BlocksToExtract;
271 for (Module::iterator F = M.begin(), E = M.end(); F != E; ++F) {
272 SplitLandingPadPreds(&*F);
273 for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
274 if (!TranslatedBlocksToNotExtract.count(BB))
275 BlocksToExtract.push_back(BB);
278 for (unsigned i = 0, e = BlocksToExtract.size(); i != e; ++i) {
279 SmallVector<BasicBlock*, 2> BlocksToExtractVec;
280 BlocksToExtractVec.push_back(BlocksToExtract[i]);
281 if (const InvokeInst *II = dyn_cast<InvokeInst>(BlocksToExtract[i]))
282 BlocksToExtractVec.push_back(II->getUnwindDest());
283 ExtractBasicBlock(BlocksToExtractVec);
286 return !BlocksToExtract.empty();