blob: 959047fa674d9a988b85c8a7f98a240a26182b49 [file] [log] [blame]
Devang Patel6e5a1132006-11-07 21:31:57 +00001//===- PassManager.cpp - LLVM Pass Infrastructure Implementation ----------===//
2//
3// The LLVM Compiler Infrastructure
4//
Devang Patelca58e352006-11-08 10:05:38 +00005// This file was developed by Devang Patel and is distributed under
Devang Patel6e5a1132006-11-07 21:31:57 +00006// the University of Illinois Open Source License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file implements the LLVM Pass Manager infrastructure.
11//
12//===----------------------------------------------------------------------===//
13
14
15#include "llvm/PassManager.h"
Devang Patelf1567a52006-12-13 20:03:48 +000016#include "llvm/Support/CommandLine.h"
Devang Patelb8817b92006-12-14 00:59:42 +000017#include "llvm/Support/Timer.h"
Devang Patel6e5a1132006-11-07 21:31:57 +000018#include "llvm/Module.h"
Devang Patelff631ae2006-11-15 01:27:05 +000019#include "llvm/ModuleProvider.h"
Bill Wendlingdfc91892006-11-28 02:09:03 +000020#include "llvm/Support/Streams.h"
Devang Patelb8817b92006-12-14 00:59:42 +000021#include "llvm/Support/ManagedStatic.h"
Devang Patela9844592006-11-11 01:31:05 +000022#include <vector>
Devang Patelf60b5d92006-11-14 01:59:59 +000023#include <map>
Devang Patel6e5a1132006-11-07 21:31:57 +000024using namespace llvm;
25
Devang Patel6fea2852006-12-07 18:23:30 +000026//===----------------------------------------------------------------------===//
27// Overview:
28// The Pass Manager Infrastructure manages passes. It's responsibilities are:
29//
30// o Manage optimization pass execution order
31// o Make required Analysis information available before pass P is run
32// o Release memory occupied by dead passes
33// o If Analysis information is dirtied by a pass then regenerate Analysis
34// information before it is consumed by another pass.
35//
Chris Lattnerce22ca32006-12-14 18:22:14 +000036// Pass Manager Infrastructure uses multiple pass managers. They are
37// PassManager, FunctionPassManager, ModulePassManager, BasicBlockPassManager.
38// This class hierarcy uses multiple inheritance but pass managers do not derive
39// from another pass manager.
Devang Patel6fea2852006-12-07 18:23:30 +000040//
Chris Lattnerce22ca32006-12-14 18:22:14 +000041// PassManager and FunctionPassManager are two top-level pass manager that
Devang Patel6fea2852006-12-07 18:23:30 +000042// represents the external interface of this entire pass manager infrastucture.
43//
44// Important classes :
45//
46// [o] class PMTopLevelManager;
47//
48// Two top level managers, PassManager and FunctionPassManager, derive from
49// PMTopLevelManager. PMTopLevelManager manages information used by top level
50// managers such as last user info.
51//
52// [o] class PMDataManager;
53//
54// PMDataManager manages information, e.g. list of available analysis info,
55// used by a pass manager to manage execution order of passes. It also provides
56// a place to implement common pass manager APIs. All pass managers derive from
57// PMDataManager.
58//
59// [o] class BasicBlockPassManager : public FunctionPass, public PMDataManager;
60//
61// BasicBlockPassManager manages BasicBlockPasses.
62//
63// [o] class FunctionPassManager;
64//
65// This is a external interface used by JIT to manage FunctionPasses. This
66// interface relies on FunctionPassManagerImpl to do all the tasks.
67//
68// [o] class FunctionPassManagerImpl : public ModulePass, PMDataManager,
69// public PMTopLevelManager;
70//
71// FunctionPassManagerImpl is a top level manager. It manages FunctionPasses
72// and BasicBlockPassManagers.
73//
74// [o] class ModulePassManager : public Pass, public PMDataManager;
75//
76// ModulePassManager manages ModulePasses and FunctionPassManagerImpls.
77//
78// [o] class PassManager;
79//
80// This is a external interface used by various tools to manages passes. It
81// relies on PassManagerImpl to do all the tasks.
82//
83// [o] class PassManagerImpl : public Pass, public PMDataManager,
84// public PMDTopLevelManager
85//
86// PassManagerImpl is a top level pass manager responsible for managing
87// ModulePassManagers.
88//===----------------------------------------------------------------------===//
89
Devang Patelf1567a52006-12-13 20:03:48 +000090namespace llvm {
91
92//===----------------------------------------------------------------------===//
93// Pass debugging information. Often it is useful to find out what pass is
94// running when a crash occurs in a utility. When this library is compiled with
95// debugging on, a command line option (--debug-pass) is enabled that causes the
96// pass name to be printed before it executes.
97//
98
Devang Patel03fb5872006-12-13 21:13:31 +000099// Different debug levels that can be enabled...
100enum PassDebugLevel {
101 None, Arguments, Structure, Executions, Details
102};
103
Devang Patelf1567a52006-12-13 20:03:48 +0000104static cl::opt<enum PassDebugLevel>
105PassDebugging_New("debug-pass", cl::Hidden,
106 cl::desc("Print PassManager debugging information"),
107 cl::values(
Devang Patel03fb5872006-12-13 21:13:31 +0000108 clEnumVal(None , "disable debug output"),
109 clEnumVal(Arguments , "print pass arguments to pass to 'opt'"),
110 clEnumVal(Structure , "print pass structure before run()"),
111 clEnumVal(Executions, "print pass name before it is executed"),
112 clEnumVal(Details , "print pass details when it is executed"),
Devang Patelf1567a52006-12-13 20:03:48 +0000113 clEnumValEnd));
114} // End of llvm namespace
115
Devang Patelb67904d2006-12-13 02:36:01 +0000116#ifndef USE_OLD_PASSMANAGER
Devang Patelca58e352006-11-08 10:05:38 +0000117namespace llvm {
118
Devang Patelafb1f3622006-12-12 22:35:25 +0000119class PMDataManager;
120
Devang Patelf33f3eb2006-12-07 19:21:29 +0000121//===----------------------------------------------------------------------===//
122// PMTopLevelManager
123//
124/// PMTopLevelManager manages LastUser info and collects common APIs used by
125/// top level pass managers.
126class PMTopLevelManager {
Devang Patelf33f3eb2006-12-07 19:21:29 +0000127public:
128
129 inline std::vector<Pass *>::iterator passManagersBegin() {
130 return PassManagers.begin();
131 }
132
133 inline std::vector<Pass *>::iterator passManagersEnd() {
134 return PassManagers.end();
135 }
136
137 /// Schedule pass P for execution. Make sure that passes required by
138 /// P are run before P is run. Update analysis info maintained by
139 /// the manager. Remove dead passes. This is a recursive function.
Devang Pateldf6c9ae2006-12-08 22:34:02 +0000140 void schedulePass(Pass *P);
Devang Patelf33f3eb2006-12-07 19:21:29 +0000141
142 /// This is implemented by top level pass manager and used by
143 /// schedulePass() to add analysis info passes that are not available.
144 virtual void addTopLevelPass(Pass *P) = 0;
145
146 /// Set pass P as the last user of the given analysis passes.
147 void setLastUser(std::vector<Pass *> &AnalysisPasses, Pass *P);
148
149 /// Collect passes whose last user is P
150 void collectLastUses(std::vector<Pass *> &LastUses, Pass *P);
151
Devang Patel640c5bb2006-12-08 22:30:11 +0000152 /// Find the pass that implements Analysis AID. Search immutable
153 /// passes and all pass managers. If desired pass is not found
154 /// then return NULL.
155 Pass *findAnalysisPass(AnalysisID AID);
156
Devang Patelb67904d2006-12-13 02:36:01 +0000157 inline void clearManagers() {
158 PassManagers.clear();
159 }
160
Devang Patelf33f3eb2006-12-07 19:21:29 +0000161 virtual ~PMTopLevelManager() {
Devang Patelab97cf42006-12-13 00:09:23 +0000162 for (std::vector<Pass *>::iterator I = PassManagers.begin(),
163 E = PassManagers.end(); I != E; ++I)
164 delete *I;
165
166 for (std::vector<ImmutablePass *>::iterator
167 I = ImmutablePasses.begin(), E = ImmutablePasses.end(); I != E; ++I)
168 delete *I;
169
Devang Patelf33f3eb2006-12-07 19:21:29 +0000170 PassManagers.clear();
171 }
172
Devang Patele0eb9d82006-12-07 20:51:18 +0000173 /// Add immutable pass and initialize it.
174 inline void addImmutablePass(ImmutablePass *P) {
175 P->initializePass();
176 ImmutablePasses.push_back(P);
177 }
178
179 inline std::vector<ImmutablePass *>& getImmutablePasses() {
180 return ImmutablePasses;
181 }
182
Devang Patel5bbeb492006-12-08 22:47:25 +0000183 void addPassManager(Pass *Manager) {
184 PassManagers.push_back(Manager);
185 }
186
Devang Patelaf1fca52006-12-08 23:11:43 +0000187 // Add Manager into the list of managers that are not directly
188 // maintained by this top level pass manager
Devang Patelafb1f3622006-12-12 22:35:25 +0000189 inline void addIndirectPassManager(PMDataManager *Manager) {
190 IndirectPassManagers.push_back(Manager);
Devang Patelaf1fca52006-12-08 23:11:43 +0000191 }
192
Devang Pateleda56172006-12-12 23:34:33 +0000193 // Print passes managed by this top level manager.
194 void dumpPasses();
Devang Patelcfd70c42006-12-13 22:10:00 +0000195 void dumpArguments();
Devang Pateleda56172006-12-12 23:34:33 +0000196
Devang Patelf33f3eb2006-12-07 19:21:29 +0000197private:
198
199 /// Collection of pass managers
200 std::vector<Pass *> PassManagers;
201
Devang Patelaf1fca52006-12-08 23:11:43 +0000202 /// Collection of pass managers that are not directly maintained
203 /// by this pass manager
Devang Patelafb1f3622006-12-12 22:35:25 +0000204 std::vector<PMDataManager *> IndirectPassManagers;
Devang Patelaf1fca52006-12-08 23:11:43 +0000205
Devang Patelf33f3eb2006-12-07 19:21:29 +0000206 // Map to keep track of last user of the analysis pass.
207 // LastUser->second is the last user of Lastuser->first.
208 std::map<Pass *, Pass *> LastUser;
Devang Patele0eb9d82006-12-07 20:51:18 +0000209
210 /// Immutable passes are managed by top level manager.
211 std::vector<ImmutablePass *> ImmutablePasses;
Devang Patelf33f3eb2006-12-07 19:21:29 +0000212};
213
Devang Patelf3827bc2006-12-07 19:54:15 +0000214//===----------------------------------------------------------------------===//
215// PMDataManager
Devang Patelf33f3eb2006-12-07 19:21:29 +0000216
Devang Pateldbe4a1e2006-12-07 18:36:24 +0000217/// PMDataManager provides the common place to manage the analysis data
218/// used by pass managers.
219class PMDataManager {
Devang Patela9844592006-11-11 01:31:05 +0000220public:
Devang Patel4c36e6b2006-12-07 23:24:58 +0000221 PMDataManager(int D) : TPM(NULL), Depth(D) {
Devang Patelf3827bc2006-12-07 19:54:15 +0000222 initializeAnalysisInfo();
223 }
224
Devang Patelab97cf42006-12-13 00:09:23 +0000225 virtual ~PMDataManager() {
226
227 for (std::vector<Pass *>::iterator I = PassVector.begin(),
228 E = PassVector.end(); I != E; ++I)
229 delete *I;
230
231 PassVector.clear();
232 }
233
Devang Patela9844592006-11-11 01:31:05 +0000234 /// Return true IFF pass P's required analysis set does not required new
235 /// manager.
236 bool manageablePass(Pass *P);
237
Devang Patela9844592006-11-11 01:31:05 +0000238 /// Augment AvailableAnalysis by adding analysis made available by pass P.
Devang Patele9976aa2006-12-07 19:33:53 +0000239 void recordAvailableAnalysis(Pass *P);
Devang Patela9844592006-11-11 01:31:05 +0000240
Devang Patela9844592006-11-11 01:31:05 +0000241 /// Remove Analysis that is not preserved by the pass
242 void removeNotPreservedAnalysis(Pass *P);
243
244 /// Remove dead passes
Devang Patel200d3052006-12-13 23:50:44 +0000245 void removeDeadPasses(Pass *P, std::string &Msg);
Devang Patela9844592006-11-11 01:31:05 +0000246
Devang Patel8f677ce2006-12-07 18:47:25 +0000247 /// Add pass P into the PassVector. Update
Devang Patel90b05e02006-11-11 02:04:19 +0000248 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
Chris Lattnerce22ca32006-12-14 18:22:14 +0000249 void addPassToManager(Pass *P, bool ProcessAnalysis = true);
Devang Patel8cad70d2006-11-11 01:51:02 +0000250
Devang Patel1d6267c2006-12-07 23:05:44 +0000251 /// Initialize available analysis information.
Devang Patela6b6dcb2006-12-07 18:41:09 +0000252 void initializeAnalysisInfo() {
Devang Patel832bc072006-12-15 00:08:26 +0000253 TransferLastUses.clear();
Devang Patel050ec722006-11-14 01:23:29 +0000254 AvailableAnalysis.clear();
255 }
256
Devang Patel1d6267c2006-12-07 23:05:44 +0000257 /// Populate RequiredPasses with the analysis pass that are required by
258 /// pass P.
259 void collectRequiredAnalysisPasses(std::vector<Pass *> &RequiredPasses,
260 Pass *P);
261
262 /// All Required analyses should be available to the pass as it runs! Here
263 /// we fill in the AnalysisImpls member of the pass so that it can
264 /// successfully use the getAnalysis() method to retrieve the
265 /// implementations it needs.
266 void initializeAnalysisImpl(Pass *P);
Devang Patelf60b5d92006-11-14 01:59:59 +0000267
Devang Patel640c5bb2006-12-08 22:30:11 +0000268 /// Find the pass that implements Analysis AID. If desired pass is not found
269 /// then return NULL.
270 Pass *findAnalysisPass(AnalysisID AID, bool Direction);
271
Devang Patel8cad70d2006-11-11 01:51:02 +0000272 inline std::vector<Pass *>::iterator passVectorBegin() {
273 return PassVector.begin();
274 }
275
276 inline std::vector<Pass *>::iterator passVectorEnd() {
277 return PassVector.end();
278 }
279
Devang Patelf3827bc2006-12-07 19:54:15 +0000280 // Access toplevel manager
281 PMTopLevelManager *getTopLevelManager() { return TPM; }
282 void setTopLevelManager(PMTopLevelManager *T) { TPM = T; }
283
Devang Patel4c36e6b2006-12-07 23:24:58 +0000284 unsigned getDepth() { return Depth; }
285
Devang Pateleda56172006-12-12 23:34:33 +0000286 // Print list of passes that are last used by P.
287 void dumpLastUses(Pass *P, unsigned Offset) {
288
289 std::vector<Pass *> LUses;
290
291 assert (TPM && "Top Level Manager is missing");
292 TPM->collectLastUses(LUses, P);
293
294 for (std::vector<Pass *>::iterator I = LUses.begin(),
295 E = LUses.end(); I != E; ++I) {
296 llvm::cerr << "--" << std::string(Offset*2, ' ');
297 (*I)->dumpPassStructure(0);
298 }
299 }
300
Devang Patelcfd70c42006-12-13 22:10:00 +0000301 void dumpPassArguments() {
302 for(std::vector<Pass *>::iterator I = PassVector.begin(),
303 E = PassVector.end(); I != E; ++I) {
304 if (PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I))
305 PMD->dumpPassArguments();
306 else
307 if (const PassInfo *PI = (*I)->getPassInfo())
308 if (!PI->isAnalysisGroup())
309 cerr << " -" << PI->getPassArgument();
310 }
311 }
312
Devang Patel200d3052006-12-13 23:50:44 +0000313 void dumpPassInfo(Pass *P, std::string &Msg1, std::string &Msg2) {
314 if (PassDebugging_New < Executions)
315 return;
316 cerr << (void*)this << std::string(getDepth()*2+1, ' ');
317 cerr << Msg1;
318 cerr << P->getPassName();
319 cerr << Msg2;
320 }
321
Devang Patelf6d1d212006-12-14 00:25:06 +0000322 void dumpAnalysisSetInfo(const char *Msg, Pass *P,
323 const std::vector<AnalysisID> &Set) {
324 if (PassDebugging_New >= Details && !Set.empty()) {
325 cerr << (void*)P << std::string(getDepth()*2+3, ' ') << Msg << " Analyses:";
326 for (unsigned i = 0; i != Set.size(); ++i) {
327 if (i) cerr << ",";
328 cerr << " " << Set[i]->getPassName();
329 }
330 cerr << "\n";
331 }
332 }
Devang Patel832bc072006-12-15 00:08:26 +0000333
334 std::vector<Pass *>& getTransferredLastUses() {
335 return TransferLastUses;
336 }
337
Devang Patelbc03f132006-12-07 23:55:10 +0000338protected:
339
Devang Patel832bc072006-12-15 00:08:26 +0000340 // If a FunctionPass F is the last user of ModulePass info M
Devang Patelbc03f132006-12-07 23:55:10 +0000341 // then the F's manager, not F, records itself as a last user of M.
Devang Patel832bc072006-12-15 00:08:26 +0000342 // Current pass manage is requesting parent manager to record parent
343 // manager as the last user of these TrransferLastUses passes.
344 std::vector<Pass *> TransferLastUses;
Devang Patelbc03f132006-12-07 23:55:10 +0000345
346 // Top level manager.
Devang Patelbc03f132006-12-07 23:55:10 +0000347 PMTopLevelManager *TPM;
348
Devang Patela9844592006-11-11 01:31:05 +0000349private:
Devang Pateldafa4dd2006-11-14 00:03:04 +0000350 // Set of available Analysis. This information is used while scheduling
351 // pass. If a pass requires an analysis which is not not available then
352 // equired analysis pass is scheduled to run before the pass itself is
353 // scheduled to run.
Devang Patelf60b5d92006-11-14 01:59:59 +0000354 std::map<AnalysisID, Pass*> AvailableAnalysis;
Devang Patel8cad70d2006-11-11 01:51:02 +0000355
356 // Collection of pass that are managed by this manager
357 std::vector<Pass *> PassVector;
Devang Patelf3827bc2006-12-07 19:54:15 +0000358
Devang Patel4c36e6b2006-12-07 23:24:58 +0000359 unsigned Depth;
Devang Patela9844592006-11-11 01:31:05 +0000360};
361
Devang Patel10c2ca62006-12-12 22:47:13 +0000362//===----------------------------------------------------------------------===//
Devang Patelb67904d2006-12-13 02:36:01 +0000363// BasicBlockPassManager
Devang Patel10c2ca62006-12-12 22:47:13 +0000364//
Devang Patelb67904d2006-12-13 02:36:01 +0000365/// BasicBlockPassManager manages BasicBlockPass. It batches all the
Devang Patelca58e352006-11-08 10:05:38 +0000366/// pass together and sequence them to process one basic block before
367/// processing next basic block.
Devang Patelb67904d2006-12-13 02:36:01 +0000368class BasicBlockPassManager : public PMDataManager,
Chris Lattnerce22ca32006-12-14 18:22:14 +0000369 public FunctionPass {
Devang Patelca58e352006-11-08 10:05:38 +0000370
371public:
Devang Patelb67904d2006-12-13 02:36:01 +0000372 BasicBlockPassManager(int D) : PMDataManager(D) { }
Devang Patelca58e352006-11-08 10:05:38 +0000373
374 /// Add a pass into a passmanager queue.
375 bool addPass(Pass *p);
376
377 /// Execute all of the passes scheduled for execution. Keep track of
378 /// whether any of the passes modifies the function, and if so, return true.
379 bool runOnFunction(Function &F);
380
Devang Patelf9d96b92006-12-07 19:57:52 +0000381 /// Pass Manager itself does not invalidate any analysis info.
382 void getAnalysisUsage(AnalysisUsage &Info) const {
383 Info.setPreservesAll();
384 }
385
Devang Patel475c4532006-12-08 00:59:05 +0000386 bool doInitialization(Module &M);
387 bool doInitialization(Function &F);
388 bool doFinalization(Module &M);
389 bool doFinalization(Function &F);
390
Devang Pateleda56172006-12-12 23:34:33 +0000391 // Print passes managed by this manager
392 void dumpPassStructure(unsigned Offset) {
393 llvm::cerr << std::string(Offset*2, ' ') << "BasicBLockPass Manager\n";
394 for (std::vector<Pass *>::iterator I = passVectorBegin(),
395 E = passVectorEnd(); I != E; ++I) {
396 (*I)->dumpPassStructure(Offset + 1);
397 dumpLastUses(*I, Offset+1);
398 }
399 }
Devang Patelca58e352006-11-08 10:05:38 +0000400};
401
Devang Patel10c2ca62006-12-12 22:47:13 +0000402//===----------------------------------------------------------------------===//
403// FunctionPassManagerImpl_New
404//
Chris Lattnerf0f611a2006-12-13 21:56:10 +0000405/// FunctionPassManagerImpl_New manages FunctionPasses and
406/// BasicBlockPassManagers. It batches all function passes and basic block pass
407/// managers together and sequence them to process one function at a time before
408/// processing next function.
Devang Patelabcd1d32006-12-07 21:27:23 +0000409class FunctionPassManagerImpl_New : public ModulePass,
410 public PMDataManager,
411 public PMTopLevelManager {
Devang Patelca58e352006-11-08 10:05:38 +0000412public:
Devang Patel4c36e6b2006-12-07 23:24:58 +0000413 FunctionPassManagerImpl_New(int D) : PMDataManager(D) {
Devang Patelca58e352006-11-08 10:05:38 +0000414 activeBBPassManager = NULL;
415 }
Devang Patel4e12f862006-11-08 10:44:40 +0000416 ~FunctionPassManagerImpl_New() { /* TODO */ };
Devang Patelca58e352006-11-08 10:05:38 +0000417
Devang Patelabcd1d32006-12-07 21:27:23 +0000418 inline void addTopLevelPass(Pass *P) {
Devang Pateld440cd92006-12-08 23:53:00 +0000419
Devang Patelfa971cd2006-12-08 23:57:43 +0000420 if (ImmutablePass *IP = dynamic_cast<ImmutablePass *> (P)) {
Devang Pateld440cd92006-12-08 23:53:00 +0000421
422 // P is a immutable pass then it will be managed by this
423 // top level manager. Set up analysis resolver to connect them.
424 AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
425 P->setResolver(AR);
Devang Patel95257542006-12-12 22:21:37 +0000426 initializeAnalysisImpl(P);
Devang Patelfa971cd2006-12-08 23:57:43 +0000427 addImmutablePass(IP);
Devang Patel95257542006-12-12 22:21:37 +0000428 recordAvailableAnalysis(IP);
Devang Patelfa971cd2006-12-08 23:57:43 +0000429 }
430 else
431 addPass(P);
Devang Patelabcd1d32006-12-07 21:27:23 +0000432 }
433
Devang Patelca58e352006-11-08 10:05:38 +0000434 /// add - Add a pass to the queue of passes to run. This passes
435 /// ownership of the Pass to the PassManager. When the
436 /// PassManager_X is destroyed, the pass will be destroyed as well, so
437 /// there is no need to delete the pass. (TODO delete passes.)
438 /// This implies that all passes MUST be allocated with 'new'.
Devang Patel31217af2006-12-07 21:32:57 +0000439 void add(Pass *P) {
Devang Pateldf6c9ae2006-12-08 22:34:02 +0000440 schedulePass(P);
Devang Patel31217af2006-12-07 21:32:57 +0000441 }
Devang Patelca58e352006-11-08 10:05:38 +0000442
443 /// Add pass into the pass manager queue.
444 bool addPass(Pass *P);
445
446 /// Execute all of the passes scheduled for execution. Keep
447 /// track of whether any of the passes modifies the function, and if
448 /// so, return true.
449 bool runOnModule(Module &M);
Devang Patel9f3083e2006-11-15 19:39:54 +0000450 bool runOnFunction(Function &F);
Devang Patel272908d2006-12-08 22:57:48 +0000451 bool run(Function &F);
Devang Patelca58e352006-11-08 10:05:38 +0000452
Devang Patelff631ae2006-11-15 01:27:05 +0000453 /// doInitialization - Run all of the initializers for the function passes.
454 ///
455 bool doInitialization(Module &M);
456
457 /// doFinalization - Run all of the initializers for the function passes.
458 ///
459 bool doFinalization(Module &M);
Devang Patelf9d96b92006-12-07 19:57:52 +0000460
461 /// Pass Manager itself does not invalidate any analysis info.
462 void getAnalysisUsage(AnalysisUsage &Info) const {
463 Info.setPreservesAll();
464 }
465
Devang Pateleda56172006-12-12 23:34:33 +0000466 // Print passes managed by this manager
467 void dumpPassStructure(unsigned Offset) {
468 llvm::cerr << std::string(Offset*2, ' ') << "FunctionPass Manager\n";
469 for (std::vector<Pass *>::iterator I = passVectorBegin(),
470 E = passVectorEnd(); I != E; ++I) {
471 (*I)->dumpPassStructure(Offset + 1);
472 dumpLastUses(*I, Offset+1);
473 }
474 }
475
Devang Patelca58e352006-11-08 10:05:38 +0000476private:
Devang Patelca58e352006-11-08 10:05:38 +0000477 // Active Pass Managers
Devang Patelb67904d2006-12-13 02:36:01 +0000478 BasicBlockPassManager *activeBBPassManager;
Devang Patelca58e352006-11-08 10:05:38 +0000479};
480
Devang Patel10c2ca62006-12-12 22:47:13 +0000481//===----------------------------------------------------------------------===//
Devang Patelb67904d2006-12-13 02:36:01 +0000482// ModulePassManager
Devang Patel10c2ca62006-12-12 22:47:13 +0000483//
Devang Patelb67904d2006-12-13 02:36:01 +0000484/// ModulePassManager manages ModulePasses and function pass managers.
Devang Patelca58e352006-11-08 10:05:38 +0000485/// It batches all Module passes passes and function pass managers together and
486/// sequence them to process one module.
Chris Lattnerce22ca32006-12-14 18:22:14 +0000487class ModulePassManager : public Pass, public PMDataManager {
Devang Patelca58e352006-11-08 10:05:38 +0000488
489public:
Devang Patelb67904d2006-12-13 02:36:01 +0000490 ModulePassManager(int D) : PMDataManager(D) {
Devang Patel4c36e6b2006-12-07 23:24:58 +0000491 activeFunctionPassManager = NULL;
492 }
Devang Patelca58e352006-11-08 10:05:38 +0000493
494 /// Add a pass into a passmanager queue.
495 bool addPass(Pass *p);
496
497 /// run - Execute all of the passes scheduled for execution. Keep track of
498 /// whether any of the passes modifies the module, and if so, return true.
499 bool runOnModule(Module &M);
Devang Patelebba9702006-11-13 22:40:09 +0000500
Devang Patelf9d96b92006-12-07 19:57:52 +0000501 /// Pass Manager itself does not invalidate any analysis info.
502 void getAnalysisUsage(AnalysisUsage &Info) const {
503 Info.setPreservesAll();
504 }
505
Devang Pateleda56172006-12-12 23:34:33 +0000506 // Print passes managed by this manager
507 void dumpPassStructure(unsigned Offset) {
508 llvm::cerr << std::string(Offset*2, ' ') << "ModulePass Manager\n";
509 for (std::vector<Pass *>::iterator I = passVectorBegin(),
510 E = passVectorEnd(); I != E; ++I) {
511 (*I)->dumpPassStructure(Offset + 1);
512 dumpLastUses(*I, Offset+1);
513 }
514 }
515
Devang Patelca58e352006-11-08 10:05:38 +0000516private:
Devang Patelca58e352006-11-08 10:05:38 +0000517 // Active Pass Manager
Devang Patel4e12f862006-11-08 10:44:40 +0000518 FunctionPassManagerImpl_New *activeFunctionPassManager;
Devang Patelca58e352006-11-08 10:05:38 +0000519};
520
Devang Patel10c2ca62006-12-12 22:47:13 +0000521//===----------------------------------------------------------------------===//
522// PassManagerImpl_New
523//
524/// PassManagerImpl_New manages ModulePassManagers
Devang Patel31217af2006-12-07 21:32:57 +0000525class PassManagerImpl_New : public Pass,
526 public PMDataManager,
Devang Patelabcd1d32006-12-07 21:27:23 +0000527 public PMTopLevelManager {
Devang Patel376fefa2006-11-08 10:29:57 +0000528
529public:
530
Devang Patelad6b7fe2006-12-12 22:57:43 +0000531 PassManagerImpl_New(int D) : PMDataManager(D) {
532 activeManager = NULL;
533 }
Devang Patel4c36e6b2006-12-07 23:24:58 +0000534
Devang Patel376fefa2006-11-08 10:29:57 +0000535 /// add - Add a pass to the queue of passes to run. This passes ownership of
536 /// the Pass to the PassManager. When the PassManager is destroyed, the pass
537 /// will be destroyed as well, so there is no need to delete the pass. This
538 /// implies that all passes MUST be allocated with 'new'.
Devang Patel31217af2006-12-07 21:32:57 +0000539 void add(Pass *P) {
Devang Pateldf6c9ae2006-12-08 22:34:02 +0000540 schedulePass(P);
Devang Patel31217af2006-12-07 21:32:57 +0000541 }
Devang Patel376fefa2006-11-08 10:29:57 +0000542
543 /// run - Execute all of the passes scheduled for execution. Keep track of
544 /// whether any of the passes modifies the module, and if so, return true.
545 bool run(Module &M);
546
Devang Patelf9d96b92006-12-07 19:57:52 +0000547 /// Pass Manager itself does not invalidate any analysis info.
548 void getAnalysisUsage(AnalysisUsage &Info) const {
549 Info.setPreservesAll();
550 }
551
Devang Patelabcd1d32006-12-07 21:27:23 +0000552 inline void addTopLevelPass(Pass *P) {
Devang Pateld440cd92006-12-08 23:53:00 +0000553
Devang Patelfa971cd2006-12-08 23:57:43 +0000554 if (ImmutablePass *IP = dynamic_cast<ImmutablePass *> (P)) {
Devang Pateld440cd92006-12-08 23:53:00 +0000555
556 // P is a immutable pass and it will be managed by this
557 // top level manager. Set up analysis resolver to connect them.
558 AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
559 P->setResolver(AR);
Devang Patel95257542006-12-12 22:21:37 +0000560 initializeAnalysisImpl(P);
Devang Patelfa971cd2006-12-08 23:57:43 +0000561 addImmutablePass(IP);
Devang Patel95257542006-12-12 22:21:37 +0000562 recordAvailableAnalysis(IP);
Devang Pateld440cd92006-12-08 23:53:00 +0000563 }
Devang Patelfa971cd2006-12-08 23:57:43 +0000564 else
565 addPass(P);
Devang Patelabcd1d32006-12-07 21:27:23 +0000566 }
567
Devang Patel376fefa2006-11-08 10:29:57 +0000568private:
569
Devang Patelde124182006-12-07 21:10:57 +0000570 /// Add a pass into a passmanager queue.
Devang Patel376fefa2006-11-08 10:29:57 +0000571 bool addPass(Pass *p);
572
Devang Patel376fefa2006-11-08 10:29:57 +0000573 // Active Pass Manager
Devang Patelb67904d2006-12-13 02:36:01 +0000574 ModulePassManager *activeManager;
Devang Patel376fefa2006-11-08 10:29:57 +0000575};
576
Devang Patelb8817b92006-12-14 00:59:42 +0000577//===----------------------------------------------------------------------===//
578// TimingInfo Class - This class is used to calculate information about the
579// amount of time each pass takes to execute. This only happens when
580// -time-passes is enabled on the command line.
581//
582
583class TimingInfo {
584 std::map<Pass*, Timer> TimingData;
585 TimerGroup TG;
586
587public:
588 // Use 'create' member to get this.
589 TimingInfo() : TG("... Pass execution timing report ...") {}
590
591 // TimingDtor - Print out information about timing information
592 ~TimingInfo() {
593 // Delete all of the timers...
594 TimingData.clear();
595 // TimerGroup is deleted next, printing the report.
596 }
597
598 // createTheTimeInfo - This method either initializes the TheTimeInfo pointer
599 // to a non null value (if the -time-passes option is enabled) or it leaves it
600 // null. It may be called multiple times.
601 static void createTheTimeInfo();
602
603 void passStarted(Pass *P) {
604
605 if (dynamic_cast<PMDataManager *>(P))
606 return;
607
608 std::map<Pass*, Timer>::iterator I = TimingData.find(P);
609 if (I == TimingData.end())
610 I=TimingData.insert(std::make_pair(P, Timer(P->getPassName(), TG))).first;
611 I->second.startTimer();
612 }
613 void passEnded(Pass *P) {
614
615 if (dynamic_cast<PMDataManager *>(P))
616 return;
617
618 std::map<Pass*, Timer>::iterator I = TimingData.find(P);
619 assert (I != TimingData.end() && "passStarted/passEnded not nested right!");
620 I->second.stopTimer();
621 }
622};
623
624static TimingInfo *TheTimeInfo;
625
Devang Patelca58e352006-11-08 10:05:38 +0000626} // End of llvm namespace
627
Devang Patela1514cb2006-12-07 19:39:39 +0000628//===----------------------------------------------------------------------===//
Devang Patelafb1f3622006-12-12 22:35:25 +0000629// PMTopLevelManager implementation
630
631/// Set pass P as the last user of the given analysis passes.
632void PMTopLevelManager::setLastUser(std::vector<Pass *> &AnalysisPasses,
633 Pass *P) {
634
635 for (std::vector<Pass *>::iterator I = AnalysisPasses.begin(),
636 E = AnalysisPasses.end(); I != E; ++I) {
637 Pass *AP = *I;
638 LastUser[AP] = P;
639 // If AP is the last user of other passes then make P last user of
640 // such passes.
641 for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
642 LUE = LastUser.end(); LUI != LUE; ++LUI) {
643 if (LUI->second == AP)
644 LastUser[LUI->first] = P;
645 }
646 }
Devang Patelafb1f3622006-12-12 22:35:25 +0000647}
648
649/// Collect passes whose last user is P
650void PMTopLevelManager::collectLastUses(std::vector<Pass *> &LastUses,
651 Pass *P) {
652 for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
653 LUE = LastUser.end(); LUI != LUE; ++LUI)
654 if (LUI->second == P)
655 LastUses.push_back(LUI->first);
656}
657
658/// Schedule pass P for execution. Make sure that passes required by
659/// P are run before P is run. Update analysis info maintained by
660/// the manager. Remove dead passes. This is a recursive function.
661void PMTopLevelManager::schedulePass(Pass *P) {
662
663 // TODO : Allocate function manager for this pass, other wise required set
664 // may be inserted into previous function manager
665
666 AnalysisUsage AnUsage;
667 P->getAnalysisUsage(AnUsage);
668 const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
669 for (std::vector<AnalysisID>::const_iterator I = RequiredSet.begin(),
670 E = RequiredSet.end(); I != E; ++I) {
671
672 Pass *AnalysisPass = findAnalysisPass(*I);
673 if (!AnalysisPass) {
674 // Schedule this analysis run first.
675 AnalysisPass = (*I)->createPass();
676 schedulePass(AnalysisPass);
677 }
678 }
679
680 // Now all required passes are available.
681 addTopLevelPass(P);
682}
683
684/// Find the pass that implements Analysis AID. Search immutable
685/// passes and all pass managers. If desired pass is not found
686/// then return NULL.
687Pass *PMTopLevelManager::findAnalysisPass(AnalysisID AID) {
688
689 Pass *P = NULL;
Devang Patelcd6ba152006-12-12 22:50:05 +0000690 // Check pass managers
691 for (std::vector<Pass *>::iterator I = PassManagers.begin(),
692 E = PassManagers.end(); P == NULL && I != E; ++I) {
693 PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I);
694 assert(PMD && "This is not a PassManager");
695 P = PMD->findAnalysisPass(AID, false);
696 }
697
698 // Check other pass managers
699 for (std::vector<PMDataManager *>::iterator I = IndirectPassManagers.begin(),
700 E = IndirectPassManagers.end(); P == NULL && I != E; ++I)
701 P = (*I)->findAnalysisPass(AID, false);
702
Devang Patelafb1f3622006-12-12 22:35:25 +0000703 for (std::vector<ImmutablePass *>::iterator I = ImmutablePasses.begin(),
704 E = ImmutablePasses.end(); P == NULL && I != E; ++I) {
705 const PassInfo *PI = (*I)->getPassInfo();
706 if (PI == AID)
707 P = *I;
708
709 // If Pass not found then check the interfaces implemented by Immutable Pass
710 if (!P) {
711 const std::vector<const PassInfo*> &ImmPI =
712 PI->getInterfacesImplemented();
713 for (unsigned Index = 0, End = ImmPI.size();
714 P == NULL && Index != End; ++Index)
715 if (ImmPI[Index] == AID)
716 P = *I;
717 }
718 }
719
Devang Patelafb1f3622006-12-12 22:35:25 +0000720 return P;
721}
722
Devang Pateleda56172006-12-12 23:34:33 +0000723// Print passes managed by this top level manager.
724void PMTopLevelManager::dumpPasses() {
725
726 // Print out the immutable passes
727 for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i) {
728 ImmutablePasses[i]->dumpPassStructure(0);
729 }
730
731 for (std::vector<Pass *>::iterator I = PassManagers.begin(),
732 E = PassManagers.end(); I != E; ++I)
733 (*I)->dumpPassStructure(1);
734
735}
736
Devang Patelcfd70c42006-12-13 22:10:00 +0000737void PMTopLevelManager::dumpArguments() {
738
739 if (PassDebugging_New < Arguments)
740 return;
741
742 cerr << "Pass Arguments: ";
743 for (std::vector<Pass *>::iterator I = PassManagers.begin(),
744 E = PassManagers.end(); I != E; ++I) {
745 PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I);
746 assert(PMD && "This is not a PassManager");
747 PMD->dumpPassArguments();
748 }
749 cerr << "\n";
750}
751
Devang Patelafb1f3622006-12-12 22:35:25 +0000752//===----------------------------------------------------------------------===//
Devang Pateldbe4a1e2006-12-07 18:36:24 +0000753// PMDataManager implementation
Devang Patelf68a3492006-11-07 22:35:17 +0000754
Devang Pateld65e9e92006-11-08 01:31:28 +0000755/// Return true IFF pass P's required analysis set does not required new
Devang Patelf68a3492006-11-07 22:35:17 +0000756/// manager.
Devang Pateldbe4a1e2006-12-07 18:36:24 +0000757bool PMDataManager::manageablePass(Pass *P) {
Devang Patelf68a3492006-11-07 22:35:17 +0000758
Devang Patel8f677ce2006-12-07 18:47:25 +0000759 // TODO
760 // If this pass is not preserving information that is required by a
761 // pass maintained by higher level pass manager then do not insert
762 // this pass into current manager. Use new manager. For example,
763 // For example, If FunctionPass F is not preserving ModulePass Info M1
764 // that is used by another ModulePass M2 then do not insert F in
765 // current function pass manager.
Devang Patelf68a3492006-11-07 22:35:17 +0000766 return true;
767}
768
Devang Patel643676c2006-11-11 01:10:19 +0000769/// Augement AvailableAnalysis by adding analysis made available by pass P.
Devang Patele9976aa2006-12-07 19:33:53 +0000770void PMDataManager::recordAvailableAnalysis(Pass *P) {
Devang Patelf60b5d92006-11-14 01:59:59 +0000771
Devang Patel643676c2006-11-11 01:10:19 +0000772 if (const PassInfo *PI = P->getPassInfo()) {
Devang Patelf60b5d92006-11-14 01:59:59 +0000773 AvailableAnalysis[PI] = P;
Devang Patel643676c2006-11-11 01:10:19 +0000774
Devang Patele9976aa2006-12-07 19:33:53 +0000775 //This pass is the current implementation of all of the interfaces it
776 //implements as well.
777 const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
778 for (unsigned i = 0, e = II.size(); i != e; ++i)
779 AvailableAnalysis[II[i]] = P;
Devang Patel643676c2006-11-11 01:10:19 +0000780 }
781}
782
Devang Patelf68a3492006-11-07 22:35:17 +0000783/// Remove Analyss not preserved by Pass P
Devang Pateldbe4a1e2006-12-07 18:36:24 +0000784void PMDataManager::removeNotPreservedAnalysis(Pass *P) {
Devang Patel349170f2006-11-11 01:24:55 +0000785 AnalysisUsage AnUsage;
786 P->getAnalysisUsage(AnUsage);
Devang Patelf68a3492006-11-07 22:35:17 +0000787
Devang Patel2e169c32006-12-07 20:03:49 +0000788 if (AnUsage.getPreservesAll())
789 return;
790
791 const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
Devang Patelf60b5d92006-11-14 01:59:59 +0000792 for (std::map<AnalysisID, Pass*>::iterator I = AvailableAnalysis.begin(),
Devang Patelbe6bd55e2006-12-12 23:07:44 +0000793 E = AvailableAnalysis.end(); I != E; ) {
Devang Patelf60b5d92006-11-14 01:59:59 +0000794 if (std::find(PreservedSet.begin(), PreservedSet.end(), I->first) ==
Devang Patel349170f2006-11-11 01:24:55 +0000795 PreservedSet.end()) {
796 // Remove this analysis
Devang Patelbe6bd55e2006-12-12 23:07:44 +0000797 if (!dynamic_cast<ImmutablePass*>(I->second)) {
798 std::map<AnalysisID, Pass*>::iterator J = I++;
799 AvailableAnalysis.erase(J);
800 } else
801 ++I;
802 } else
803 ++I;
Devang Patel349170f2006-11-11 01:24:55 +0000804 }
Devang Patelf68a3492006-11-07 22:35:17 +0000805}
806
Devang Patelca189262006-11-14 03:05:08 +0000807/// Remove analysis passes that are not used any longer
Devang Patel200d3052006-12-13 23:50:44 +0000808void PMDataManager::removeDeadPasses(Pass *P, std::string &Msg) {
Devang Patel17ad0962006-12-08 00:37:52 +0000809
810 std::vector<Pass *> DeadPasses;
811 TPM->collectLastUses(DeadPasses, P);
812
813 for (std::vector<Pass *>::iterator I = DeadPasses.begin(),
814 E = DeadPasses.end(); I != E; ++I) {
Devang Patel200d3052006-12-13 23:50:44 +0000815
816 std::string Msg1 = " Freeing Pass '";
817 dumpPassInfo(*I, Msg1, Msg);
818
Devang Patelb8817b92006-12-14 00:59:42 +0000819 if (TheTimeInfo) TheTimeInfo->passStarted(P);
Devang Patel17ad0962006-12-08 00:37:52 +0000820 (*I)->releaseMemory();
Devang Patelb8817b92006-12-14 00:59:42 +0000821 if (TheTimeInfo) TheTimeInfo->passEnded(P);
822
Devang Patel17ad0962006-12-08 00:37:52 +0000823 std::map<AnalysisID, Pass*>::iterator Pos =
824 AvailableAnalysis.find((*I)->getPassInfo());
825
Devang Patel475c4532006-12-08 00:59:05 +0000826 // It is possible that pass is already removed from the AvailableAnalysis
Devang Patel17ad0962006-12-08 00:37:52 +0000827 if (Pos != AvailableAnalysis.end())
828 AvailableAnalysis.erase(Pos);
829 }
Devang Patelca189262006-11-14 03:05:08 +0000830}
831
Devang Patel8f677ce2006-12-07 18:47:25 +0000832/// Add pass P into the PassVector. Update
Devang Patel90b05e02006-11-11 02:04:19 +0000833/// AvailableAnalysis appropriately if ProcessAnalysis is true.
Devang Patel2e169c32006-12-07 20:03:49 +0000834void PMDataManager::addPassToManager(Pass *P,
835 bool ProcessAnalysis) {
Devang Patel8cad70d2006-11-11 01:51:02 +0000836
Devang Pateld440cd92006-12-08 23:53:00 +0000837 // This manager is going to manage pass P. Set up analysis resolver
838 // to connect them.
839 AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
840 P->setResolver(AR);
841
Devang Patel90b05e02006-11-11 02:04:19 +0000842 if (ProcessAnalysis) {
Devang Patelbc03f132006-12-07 23:55:10 +0000843
844 // At the moment, this pass is the last user of all required passes.
845 std::vector<Pass *> LastUses;
846 std::vector<Pass *> RequiredPasses;
847 unsigned PDepth = this->getDepth();
848
849 collectRequiredAnalysisPasses(RequiredPasses, P);
850 for (std::vector<Pass *>::iterator I = RequiredPasses.begin(),
851 E = RequiredPasses.end(); I != E; ++I) {
852 Pass *PRequired = *I;
853 unsigned RDepth = 0;
Devang Patel64619be2006-12-09 00:07:38 +0000854
855 PMDataManager &DM = PRequired->getResolver()->getPMDataManager();
856 RDepth = DM.getDepth();
857
Devang Patelbc03f132006-12-07 23:55:10 +0000858 if (PDepth == RDepth)
859 LastUses.push_back(PRequired);
860 else if (PDepth > RDepth) {
861 // Let the parent claim responsibility of last use
Devang Patel832bc072006-12-15 00:08:26 +0000862 TransferLastUses.push_back(PRequired);
Devang Patelbc03f132006-12-07 23:55:10 +0000863 } else {
864 // Note : This feature is not yet implemented
865 assert (0 &&
866 "Unable to handle Pass that requires lower level Analysis pass");
867 }
868 }
869
Devang Patel832bc072006-12-15 00:08:26 +0000870 LastUses.push_back(P);
871 TPM->setLastUser(LastUses, P);
Devang Patelbc03f132006-12-07 23:55:10 +0000872
Devang Patel17bff0d2006-12-07 22:09:36 +0000873 // Take a note of analysis required and made available by this pass.
Devang Patel90b05e02006-11-11 02:04:19 +0000874 // Remove the analysis not preserved by this pass
875 removeNotPreservedAnalysis(P);
Devang Patel17bff0d2006-12-07 22:09:36 +0000876 recordAvailableAnalysis(P);
Devang Patel90b05e02006-11-11 02:04:19 +0000877 }
Devang Patel8cad70d2006-11-11 01:51:02 +0000878
879 // Add pass
880 PassVector.push_back(P);
Devang Patel8cad70d2006-11-11 01:51:02 +0000881}
882
Devang Patel1d6267c2006-12-07 23:05:44 +0000883/// Populate RequiredPasses with the analysis pass that are required by
884/// pass P.
885void PMDataManager::collectRequiredAnalysisPasses(std::vector<Pass *> &RP,
886 Pass *P) {
887 AnalysisUsage AnUsage;
888 P->getAnalysisUsage(AnUsage);
889 const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
890 for (std::vector<AnalysisID>::const_iterator
891 I = RequiredSet.begin(), E = RequiredSet.end();
892 I != E; ++I) {
Devang Patel640c5bb2006-12-08 22:30:11 +0000893 Pass *AnalysisPass = findAnalysisPass(*I, true);
Devang Patel1d6267c2006-12-07 23:05:44 +0000894 assert (AnalysisPass && "Analysis pass is not available");
895 RP.push_back(AnalysisPass);
896 }
Devang Patelf58183d2006-12-12 23:09:32 +0000897
898 const std::vector<AnalysisID> &IDs = AnUsage.getRequiredTransitiveSet();
899 for (std::vector<AnalysisID>::const_iterator I = IDs.begin(),
900 E = IDs.end(); I != E; ++I) {
901 Pass *AnalysisPass = findAnalysisPass(*I, true);
902 assert (AnalysisPass && "Analysis pass is not available");
903 RP.push_back(AnalysisPass);
904 }
Devang Patel1d6267c2006-12-07 23:05:44 +0000905}
906
Devang Patel07f4f582006-11-14 21:49:36 +0000907// All Required analyses should be available to the pass as it runs! Here
908// we fill in the AnalysisImpls member of the pass so that it can
909// successfully use the getAnalysis() method to retrieve the
910// implementations it needs.
911//
Devang Pateldbe4a1e2006-12-07 18:36:24 +0000912void PMDataManager::initializeAnalysisImpl(Pass *P) {
Devang Patelff631ae2006-11-15 01:27:05 +0000913 AnalysisUsage AnUsage;
914 P->getAnalysisUsage(AnUsage);
Devang Patel07f4f582006-11-14 21:49:36 +0000915
916 for (std::vector<const PassInfo *>::const_iterator
917 I = AnUsage.getRequiredSet().begin(),
918 E = AnUsage.getRequiredSet().end(); I != E; ++I) {
Devang Patel640c5bb2006-12-08 22:30:11 +0000919 Pass *Impl = findAnalysisPass(*I, true);
Devang Patel07f4f582006-11-14 21:49:36 +0000920 if (Impl == 0)
921 assert(0 && "Analysis used but not available!");
Devang Patel984698a2006-12-09 01:11:34 +0000922 AnalysisResolver_New *AR = P->getResolver();
923 AR->addAnalysisImplsPair(*I, Impl);
Devang Patel07f4f582006-11-14 21:49:36 +0000924 }
925}
926
Devang Patel640c5bb2006-12-08 22:30:11 +0000927/// Find the pass that implements Analysis AID. If desired pass is not found
928/// then return NULL.
929Pass *PMDataManager::findAnalysisPass(AnalysisID AID, bool SearchParent) {
930
931 // Check if AvailableAnalysis map has one entry.
932 std::map<AnalysisID, Pass*>::const_iterator I = AvailableAnalysis.find(AID);
933
934 if (I != AvailableAnalysis.end())
935 return I->second;
936
937 // Search Parents through TopLevelManager
938 if (SearchParent)
939 return TPM->findAnalysisPass(AID);
940
Devang Patel9d759b82006-12-09 00:09:12 +0000941 return NULL;
Devang Patel640c5bb2006-12-08 22:30:11 +0000942}
943
Devang Patel9bdf7d42006-12-08 23:28:54 +0000944
945//===----------------------------------------------------------------------===//
946// NOTE: Is this the right place to define this method ?
947// getAnalysisToUpdate - Return an analysis result or null if it doesn't exist
948Pass *AnalysisResolver_New::getAnalysisToUpdate(AnalysisID ID, bool dir) const {
949 return PM.findAnalysisPass(ID, dir);
950}
951
Devang Patela1514cb2006-12-07 19:39:39 +0000952//===----------------------------------------------------------------------===//
Devang Patelb67904d2006-12-13 02:36:01 +0000953// BasicBlockPassManager implementation
Devang Patel6e5a1132006-11-07 21:31:57 +0000954
Devang Pateld65e9e92006-11-08 01:31:28 +0000955/// Add pass P into PassVector and return true. If this pass is not
956/// manageable by this manager then return false.
Devang Patel6e5a1132006-11-07 21:31:57 +0000957bool
Devang Patelb67904d2006-12-13 02:36:01 +0000958BasicBlockPassManager::addPass(Pass *P) {
Devang Patel6e5a1132006-11-07 21:31:57 +0000959
960 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
961 if (!BP)
962 return false;
963
Devang Patel3c8eb622006-11-07 22:56:50 +0000964 // If this pass does not preserve anlysis that is used by other passes
965 // managed by this manager than it is not a suiable pass for this manager.
Devang Pateld65e9e92006-11-08 01:31:28 +0000966 if (!manageablePass(P))
Devang Patel3c8eb622006-11-07 22:56:50 +0000967 return false;
968
Chris Lattnerce22ca32006-12-14 18:22:14 +0000969 addPassToManager(BP);
Devang Patel349170f2006-11-11 01:24:55 +0000970
Devang Patel6e5a1132006-11-07 21:31:57 +0000971 return true;
972}
973
974/// Execute all of the passes scheduled for execution by invoking
975/// runOnBasicBlock method. Keep track of whether any of the passes modifies
976/// the function, and if so, return true.
977bool
Devang Patelb67904d2006-12-13 02:36:01 +0000978BasicBlockPassManager::runOnFunction(Function &F) {
Devang Patel6e5a1132006-11-07 21:31:57 +0000979
Devang Patel745a6962006-12-12 23:15:28 +0000980 if (F.isExternal())
981 return false;
982
Devang Patele9585592006-12-08 01:38:28 +0000983 bool Changed = doInitialization(F);
Devang Patela6b6dcb2006-12-07 18:41:09 +0000984 initializeAnalysisInfo();
Devang Patel050ec722006-11-14 01:23:29 +0000985
Devang Patel93a197c2006-12-14 00:08:04 +0000986 std::string Msg1 = "Executing Pass '";
987 std::string Msg3 = "' Made Modification '";
988
Devang Patel6e5a1132006-11-07 21:31:57 +0000989 for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
Devang Patel8cad70d2006-11-11 01:51:02 +0000990 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
991 e = passVectorEnd(); itr != e; ++itr) {
Devang Patel6e5a1132006-11-07 21:31:57 +0000992 Pass *P = *itr;
Devang Patelf6d1d212006-12-14 00:25:06 +0000993 AnalysisUsage AnUsage;
994 P->getAnalysisUsage(AnUsage);
995
Devang Patel200d3052006-12-13 23:50:44 +0000996 std::string Msg2 = "' on BasicBlock '" + (*I).getName() + "'...\n";
997 dumpPassInfo(P, Msg1, Msg2);
Devang Patelf6d1d212006-12-14 00:25:06 +0000998 dumpAnalysisSetInfo("Required", P, AnUsage.getRequiredSet());
999
Devang Patel47d7df72006-12-12 23:13:09 +00001000 initializeAnalysisImpl(P);
Devang Patel93a197c2006-12-14 00:08:04 +00001001
Devang Patel6e5a1132006-11-07 21:31:57 +00001002 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
Devang Patelb8817b92006-12-14 00:59:42 +00001003 if (TheTimeInfo) TheTimeInfo->passStarted(P);
Devang Patel6e5a1132006-11-07 21:31:57 +00001004 Changed |= BP->runOnBasicBlock(*I);
Devang Patelb8817b92006-12-14 00:59:42 +00001005 if (TheTimeInfo) TheTimeInfo->passEnded(P);
Devang Patel93a197c2006-12-14 00:08:04 +00001006
1007 if (Changed)
1008 dumpPassInfo(P, Msg3, Msg2);
Devang Patelf6d1d212006-12-14 00:25:06 +00001009 dumpAnalysisSetInfo("Preserved", P, AnUsage.getPreservedSet());
Devang Patel93a197c2006-12-14 00:08:04 +00001010
Devang Patel050ec722006-11-14 01:23:29 +00001011 removeNotPreservedAnalysis(P);
Devang Patel17bff0d2006-12-07 22:09:36 +00001012 recordAvailableAnalysis(P);
Devang Patel200d3052006-12-13 23:50:44 +00001013 removeDeadPasses(P, Msg2);
Devang Patel6e5a1132006-11-07 21:31:57 +00001014 }
Devang Patele9585592006-12-08 01:38:28 +00001015 return Changed | doFinalization(F);
Devang Patel6e5a1132006-11-07 21:31:57 +00001016}
1017
Devang Patel475c4532006-12-08 00:59:05 +00001018// Implement doInitialization and doFinalization
Devang Patelb67904d2006-12-13 02:36:01 +00001019inline bool BasicBlockPassManager::doInitialization(Module &M) {
Devang Patel475c4532006-12-08 00:59:05 +00001020 bool Changed = false;
1021
1022 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1023 e = passVectorEnd(); itr != e; ++itr) {
1024 Pass *P = *itr;
1025 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
1026 Changed |= BP->doInitialization(M);
1027 }
1028
1029 return Changed;
1030}
1031
Devang Patelb67904d2006-12-13 02:36:01 +00001032inline bool BasicBlockPassManager::doFinalization(Module &M) {
Devang Patel475c4532006-12-08 00:59:05 +00001033 bool Changed = false;
1034
1035 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1036 e = passVectorEnd(); itr != e; ++itr) {
1037 Pass *P = *itr;
1038 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
1039 Changed |= BP->doFinalization(M);
1040 }
1041
1042 return Changed;
1043}
1044
Devang Patelb67904d2006-12-13 02:36:01 +00001045inline bool BasicBlockPassManager::doInitialization(Function &F) {
Devang Patel475c4532006-12-08 00:59:05 +00001046 bool Changed = false;
1047
1048 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1049 e = passVectorEnd(); itr != e; ++itr) {
1050 Pass *P = *itr;
1051 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
1052 Changed |= BP->doInitialization(F);
1053 }
1054
1055 return Changed;
1056}
1057
Devang Patelb67904d2006-12-13 02:36:01 +00001058inline bool BasicBlockPassManager::doFinalization(Function &F) {
Devang Patel475c4532006-12-08 00:59:05 +00001059 bool Changed = false;
1060
1061 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1062 e = passVectorEnd(); itr != e; ++itr) {
1063 Pass *P = *itr;
1064 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
1065 Changed |= BP->doFinalization(F);
1066 }
1067
1068 return Changed;
1069}
1070
1071
Devang Patela1514cb2006-12-07 19:39:39 +00001072//===----------------------------------------------------------------------===//
Devang Patelb67904d2006-12-13 02:36:01 +00001073// FunctionPassManager implementation
Devang Patela1514cb2006-12-07 19:39:39 +00001074
Devang Patel4e12f862006-11-08 10:44:40 +00001075/// Create new Function pass manager
Devang Patelb67904d2006-12-13 02:36:01 +00001076FunctionPassManager::FunctionPassManager(ModuleProvider *P) {
Devang Patel1f653682006-12-08 18:57:16 +00001077 FPM = new FunctionPassManagerImpl_New(0);
Devang Patel9c6290c2006-12-12 22:02:16 +00001078 // FPM is the top level manager.
1079 FPM->setTopLevelManager(FPM);
Devang Patel1036b652006-12-12 23:27:37 +00001080
1081 PMDataManager *PMD = dynamic_cast<PMDataManager *>(FPM);
1082 AnalysisResolver_New *AR = new AnalysisResolver_New(*PMD);
1083 FPM->setResolver(AR);
1084
1085 FPM->addPassManager(FPM);
Devang Patel1f653682006-12-08 18:57:16 +00001086 MP = P;
1087}
1088
Devang Patelb67904d2006-12-13 02:36:01 +00001089FunctionPassManager::~FunctionPassManager() {
1090 // Note : FPM maintains one entry in PassManagers vector.
1091 // This one entry is FPM itself. This is not ideal. One
1092 // alternative is have one additional layer between
1093 // FunctionPassManager and FunctionPassManagerImpl.
1094 // Meanwhile, to avoid going into infinte loop, first
1095 // remove FPM from its PassMangers vector.
1096 FPM->clearManagers();
Devang Patelab97cf42006-12-13 00:09:23 +00001097 delete FPM;
1098}
1099
Devang Patel4e12f862006-11-08 10:44:40 +00001100/// add - Add a pass to the queue of passes to run. This passes
1101/// ownership of the Pass to the PassManager. When the
1102/// PassManager_X is destroyed, the pass will be destroyed as well, so
1103/// there is no need to delete the pass. (TODO delete passes.)
1104/// This implies that all passes MUST be allocated with 'new'.
Devang Patelb67904d2006-12-13 02:36:01 +00001105void FunctionPassManager::add(Pass *P) {
Devang Patel4e12f862006-11-08 10:44:40 +00001106 FPM->add(P);
1107}
1108
Devang Patel9f3083e2006-11-15 19:39:54 +00001109/// run - Execute all of the passes scheduled for execution. Keep
1110/// track of whether any of the passes modifies the function, and if
1111/// so, return true.
1112///
Devang Patelb67904d2006-12-13 02:36:01 +00001113bool FunctionPassManager::run(Function &F) {
Devang Patel9f3083e2006-11-15 19:39:54 +00001114 std::string errstr;
1115 if (MP->materializeFunction(&F, &errstr)) {
Bill Wendlingf3baad32006-12-07 01:30:32 +00001116 cerr << "Error reading bytecode file: " << errstr << "\n";
Devang Patel9f3083e2006-11-15 19:39:54 +00001117 abort();
1118 }
Devang Patel272908d2006-12-08 22:57:48 +00001119 return FPM->run(F);
Devang Patel9f3083e2006-11-15 19:39:54 +00001120}
1121
1122
Devang Patelff631ae2006-11-15 01:27:05 +00001123/// doInitialization - Run all of the initializers for the function passes.
1124///
Devang Patelb67904d2006-12-13 02:36:01 +00001125bool FunctionPassManager::doInitialization() {
Devang Patelff631ae2006-11-15 01:27:05 +00001126 return FPM->doInitialization(*MP->getModule());
1127}
1128
1129/// doFinalization - Run all of the initializers for the function passes.
1130///
Devang Patelb67904d2006-12-13 02:36:01 +00001131bool FunctionPassManager::doFinalization() {
Devang Patelff631ae2006-11-15 01:27:05 +00001132 return FPM->doFinalization(*MP->getModule());
1133}
1134
Devang Patela1514cb2006-12-07 19:39:39 +00001135//===----------------------------------------------------------------------===//
Devang Patel4e12f862006-11-08 10:44:40 +00001136// FunctionPassManagerImpl_New implementation
Devang Patel0c2012f2006-11-07 21:49:50 +00001137
Devang Patel0c2012f2006-11-07 21:49:50 +00001138/// Add pass P into the pass manager queue. If P is a BasicBlockPass then
1139/// either use it into active basic block pass manager or create new basic
1140/// block pass manager to handle pass P.
1141bool
Devang Patel4e12f862006-11-08 10:44:40 +00001142FunctionPassManagerImpl_New::addPass(Pass *P) {
Devang Patel0c2012f2006-11-07 21:49:50 +00001143
Devang Patelb67904d2006-12-13 02:36:01 +00001144 // If P is a BasicBlockPass then use BasicBlockPassManager.
Devang Patel0c2012f2006-11-07 21:49:50 +00001145 if (BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P)) {
1146
Devang Patel4949fe02006-12-07 22:34:21 +00001147 if (!activeBBPassManager || !activeBBPassManager->addPass(BP)) {
Devang Patel0c2012f2006-11-07 21:49:50 +00001148
Devang Patel4949fe02006-12-07 22:34:21 +00001149 // If active manager exists then clear its analysis info.
1150 if (activeBBPassManager)
1151 activeBBPassManager->initializeAnalysisInfo();
Devang Patel642c1432006-12-07 21:58:50 +00001152
Devang Patel4949fe02006-12-07 22:34:21 +00001153 // Create and add new manager
Devang Patel4c36e6b2006-12-07 23:24:58 +00001154 activeBBPassManager =
Devang Patelb67904d2006-12-13 02:36:01 +00001155 new BasicBlockPassManager(getDepth() + 1);
Devang Patel9c6290c2006-12-12 22:02:16 +00001156 // Inherit top level manager
1157 activeBBPassManager->setTopLevelManager(this->getTopLevelManager());
Devang Patelafb1f3622006-12-12 22:35:25 +00001158
1159 // Add new manager into current manager's list.
Devang Patel90b05e02006-11-11 02:04:19 +00001160 addPassToManager(activeBBPassManager, false);
Devang Patelafb1f3622006-12-12 22:35:25 +00001161
1162 // Add new manager into top level manager's indirect passes list
1163 PMDataManager *PMD = dynamic_cast<PMDataManager *>(activeBBPassManager);
1164 assert (PMD && "Manager is not Pass Manager");
1165 TPM->addIndirectPassManager(PMD);
Devang Patel4949fe02006-12-07 22:34:21 +00001166
1167 // Add pass into new manager. This time it must succeed.
Devang Pateld65e9e92006-11-08 01:31:28 +00001168 if (!activeBBPassManager->addPass(BP))
1169 assert(0 && "Unable to add Pass");
Devang Patel832bc072006-12-15 00:08:26 +00001170
1171 // If activeBBPassManager transfered any Last Uses then handle them here.
1172 std::vector<Pass *> &TLU = activeBBPassManager->getTransferredLastUses();
1173 if (!TLU.empty())
1174 TPM->setLastUser(TLU, this);
1175
Devang Patel0c2012f2006-11-07 21:49:50 +00001176 }
Devang Patelbc03f132006-12-07 23:55:10 +00001177
Devang Patelbc03f132006-12-07 23:55:10 +00001178
Devang Patel0c2012f2006-11-07 21:49:50 +00001179 return true;
1180 }
1181
1182 FunctionPass *FP = dynamic_cast<FunctionPass *>(P);
1183 if (!FP)
1184 return false;
1185
Devang Patel3c8eb622006-11-07 22:56:50 +00001186 // If this pass does not preserve anlysis that is used by other passes
1187 // managed by this manager than it is not a suiable pass for this manager.
Devang Pateld65e9e92006-11-08 01:31:28 +00001188 if (!manageablePass(P))
Devang Patel3c8eb622006-11-07 22:56:50 +00001189 return false;
1190
Devang Patel8cad70d2006-11-11 01:51:02 +00001191 addPassToManager (FP);
Devang Patel4949fe02006-12-07 22:34:21 +00001192
1193 // If active manager exists then clear its analysis info.
1194 if (activeBBPassManager) {
1195 activeBBPassManager->initializeAnalysisInfo();
1196 activeBBPassManager = NULL;
1197 }
1198
Devang Patel0c2012f2006-11-07 21:49:50 +00001199 return true;
1200}
1201
1202/// Execute all of the passes scheduled for execution by invoking
1203/// runOnFunction method. Keep track of whether any of the passes modifies
1204/// the function, and if so, return true.
Devang Patel9f3083e2006-11-15 19:39:54 +00001205bool FunctionPassManagerImpl_New::runOnModule(Module &M) {
Devang Patel0c2012f2006-11-07 21:49:50 +00001206
Devang Patel0e29e292006-12-08 19:04:09 +00001207 bool Changed = doInitialization(M);
Devang Patela6b6dcb2006-12-07 18:41:09 +00001208 initializeAnalysisInfo();
Devang Patel050ec722006-11-14 01:23:29 +00001209
Devang Patel0c2012f2006-11-07 21:49:50 +00001210 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
Devang Patel19290892006-12-08 19:03:05 +00001211 this->runOnFunction(*I);
1212
Devang Patel0e29e292006-12-08 19:04:09 +00001213 return Changed | doFinalization(M);
Devang Patel0c2012f2006-11-07 21:49:50 +00001214}
1215
Devang Patel9f3083e2006-11-15 19:39:54 +00001216/// Execute all of the passes scheduled for execution by invoking
1217/// runOnFunction method. Keep track of whether any of the passes modifies
1218/// the function, and if so, return true.
1219bool FunctionPassManagerImpl_New::runOnFunction(Function &F) {
1220
1221 bool Changed = false;
Devang Patel745a6962006-12-12 23:15:28 +00001222
1223 if (F.isExternal())
1224 return false;
1225
Devang Patela6b6dcb2006-12-07 18:41:09 +00001226 initializeAnalysisInfo();
Devang Patel9f3083e2006-11-15 19:39:54 +00001227
Devang Patel93a197c2006-12-14 00:08:04 +00001228 std::string Msg1 = "Executing Pass '";
1229 std::string Msg3 = "' Made Modification '";
1230
Devang Patel9f3083e2006-11-15 19:39:54 +00001231 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1232 e = passVectorEnd(); itr != e; ++itr) {
1233 Pass *P = *itr;
Devang Patelf6d1d212006-12-14 00:25:06 +00001234 AnalysisUsage AnUsage;
1235 P->getAnalysisUsage(AnUsage);
Devang Patel93a197c2006-12-14 00:08:04 +00001236
Devang Patel200d3052006-12-13 23:50:44 +00001237 std::string Msg2 = "' on Function '" + F.getName() + "'...\n";
1238 dumpPassInfo(P, Msg1, Msg2);
Devang Patelf6d1d212006-12-14 00:25:06 +00001239 dumpAnalysisSetInfo("Required", P, AnUsage.getRequiredSet());
Devang Patel93a197c2006-12-14 00:08:04 +00001240
Devang Patel47d7df72006-12-12 23:13:09 +00001241 initializeAnalysisImpl(P);
Devang Patel9f3083e2006-11-15 19:39:54 +00001242 FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
Devang Patelb8817b92006-12-14 00:59:42 +00001243
1244 if (TheTimeInfo) TheTimeInfo->passStarted(P);
Devang Patel9f3083e2006-11-15 19:39:54 +00001245 Changed |= FP->runOnFunction(F);
Devang Patelb8817b92006-12-14 00:59:42 +00001246 if (TheTimeInfo) TheTimeInfo->passEnded(P);
Devang Patel93a197c2006-12-14 00:08:04 +00001247
1248 if (Changed)
1249 dumpPassInfo(P, Msg3, Msg2);
Devang Patelf6d1d212006-12-14 00:25:06 +00001250 dumpAnalysisSetInfo("Preserved", P, AnUsage.getPreservedSet());
Devang Patel93a197c2006-12-14 00:08:04 +00001251
Devang Patel9f3083e2006-11-15 19:39:54 +00001252 removeNotPreservedAnalysis(P);
Devang Patel17bff0d2006-12-07 22:09:36 +00001253 recordAvailableAnalysis(P);
Devang Patel200d3052006-12-13 23:50:44 +00001254 removeDeadPasses(P, Msg2);
Devang Patel9f3083e2006-11-15 19:39:54 +00001255 }
1256 return Changed;
1257}
1258
1259
Devang Patelff631ae2006-11-15 01:27:05 +00001260inline bool FunctionPassManagerImpl_New::doInitialization(Module &M) {
1261 bool Changed = false;
1262
1263 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1264 e = passVectorEnd(); itr != e; ++itr) {
1265 Pass *P = *itr;
1266
1267 FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
1268 Changed |= FP->doInitialization(M);
1269 }
1270
1271 return Changed;
1272}
1273
1274inline bool FunctionPassManagerImpl_New::doFinalization(Module &M) {
1275 bool Changed = false;
1276
1277 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1278 e = passVectorEnd(); itr != e; ++itr) {
1279 Pass *P = *itr;
1280
1281 FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
1282 Changed |= FP->doFinalization(M);
1283 }
1284
Devang Patelff631ae2006-11-15 01:27:05 +00001285 return Changed;
1286}
1287
Devang Patel272908d2006-12-08 22:57:48 +00001288// Execute all the passes managed by this top level manager.
1289// Return true if any function is modified by a pass.
1290bool FunctionPassManagerImpl_New::run(Function &F) {
1291
1292 bool Changed = false;
1293 for (std::vector<Pass *>::iterator I = passManagersBegin(),
1294 E = passManagersEnd(); I != E; ++I) {
Devang Patelb67904d2006-12-13 02:36:01 +00001295 FunctionPassManagerImpl_New *FP =
1296 dynamic_cast<FunctionPassManagerImpl_New *>(*I);
Devang Patel272908d2006-12-08 22:57:48 +00001297 Changed |= FP->runOnFunction(F);
1298 }
1299 return Changed;
1300}
1301
Devang Patela1514cb2006-12-07 19:39:39 +00001302//===----------------------------------------------------------------------===//
Devang Patel05e1a972006-11-07 22:03:15 +00001303// ModulePassManager implementation
1304
1305/// Add P into pass vector if it is manageble. If P is a FunctionPass
Devang Patel4e12f862006-11-08 10:44:40 +00001306/// then use FunctionPassManagerImpl_New to manage it. Return false if P
Devang Patel05e1a972006-11-07 22:03:15 +00001307/// is not manageable by this manager.
1308bool
Devang Patelb67904d2006-12-13 02:36:01 +00001309ModulePassManager::addPass(Pass *P) {
Devang Patel05e1a972006-11-07 22:03:15 +00001310
1311 // If P is FunctionPass then use function pass maanager.
1312 if (FunctionPass *FP = dynamic_cast<FunctionPass*>(P)) {
1313
Devang Patel640c5bb2006-12-08 22:30:11 +00001314 if (!activeFunctionPassManager || !activeFunctionPassManager->addPass(P)) {
Devang Patel05e1a972006-11-07 22:03:15 +00001315
Devang Patel4949fe02006-12-07 22:34:21 +00001316 // If active manager exists then clear its analysis info.
1317 if (activeFunctionPassManager)
1318 activeFunctionPassManager->initializeAnalysisInfo();
Devang Patel642c1432006-12-07 21:58:50 +00001319
Devang Patel4949fe02006-12-07 22:34:21 +00001320 // Create and add new manager
Devang Patel4c36e6b2006-12-07 23:24:58 +00001321 activeFunctionPassManager =
1322 new FunctionPassManagerImpl_New(getDepth() + 1);
Devang Patelafb1f3622006-12-12 22:35:25 +00001323
1324 // Add new manager into current manager's list
Devang Patel90b05e02006-11-11 02:04:19 +00001325 addPassToManager(activeFunctionPassManager, false);
Devang Patelafb1f3622006-12-12 22:35:25 +00001326
Devang Patel9c6290c2006-12-12 22:02:16 +00001327 // Inherit top level manager
1328 activeFunctionPassManager->setTopLevelManager(this->getTopLevelManager());
Devang Patelafb1f3622006-12-12 22:35:25 +00001329
1330 // Add new manager into top level manager's indirect passes list
Chris Lattnerf0f611a2006-12-13 21:56:10 +00001331 PMDataManager *PMD =
1332 dynamic_cast<PMDataManager *>(activeFunctionPassManager);
1333 assert(PMD && "Manager is not Pass Manager");
Devang Patelafb1f3622006-12-12 22:35:25 +00001334 TPM->addIndirectPassManager(PMD);
Devang Patelaf1fca52006-12-08 23:11:43 +00001335
Devang Patel4949fe02006-12-07 22:34:21 +00001336 // Add pass into new manager. This time it must succeed.
Devang Pateld65e9e92006-11-08 01:31:28 +00001337 if (!activeFunctionPassManager->addPass(FP))
1338 assert(0 && "Unable to add pass");
Devang Patelbc03f132006-12-07 23:55:10 +00001339
Devang Patel832bc072006-12-15 00:08:26 +00001340 // If activeFunctionPassManager transfered any Last Uses then
1341 // handle them here.
1342 std::vector<Pass *> &TLU =
1343 activeFunctionPassManager->getTransferredLastUses();
1344 if (!TLU.empty())
1345 TPM->setLastUser(TLU, this);
1346 }
Devang Patelbc03f132006-12-07 23:55:10 +00001347
Devang Patel05e1a972006-11-07 22:03:15 +00001348 return true;
1349 }
1350
1351 ModulePass *MP = dynamic_cast<ModulePass *>(P);
1352 if (!MP)
1353 return false;
1354
Devang Patel3c8eb622006-11-07 22:56:50 +00001355 // If this pass does not preserve anlysis that is used by other passes
1356 // managed by this manager than it is not a suiable pass for this manager.
Devang Pateld65e9e92006-11-08 01:31:28 +00001357 if (!manageablePass(P))
Devang Patel3c8eb622006-11-07 22:56:50 +00001358 return false;
1359
Devang Patel8cad70d2006-11-11 01:51:02 +00001360 addPassToManager(MP);
Devang Patel4949fe02006-12-07 22:34:21 +00001361 // If active manager exists then clear its analysis info.
1362 if (activeFunctionPassManager) {
1363 activeFunctionPassManager->initializeAnalysisInfo();
1364 activeFunctionPassManager = NULL;
1365 }
1366
Devang Patel05e1a972006-11-07 22:03:15 +00001367 return true;
1368}
1369
1370
1371/// Execute all of the passes scheduled for execution by invoking
1372/// runOnModule method. Keep track of whether any of the passes modifies
1373/// the module, and if so, return true.
1374bool
Devang Patelb67904d2006-12-13 02:36:01 +00001375ModulePassManager::runOnModule(Module &M) {
Devang Patel05e1a972006-11-07 22:03:15 +00001376 bool Changed = false;
Devang Patela6b6dcb2006-12-07 18:41:09 +00001377 initializeAnalysisInfo();
Devang Patel050ec722006-11-14 01:23:29 +00001378
Devang Patel93a197c2006-12-14 00:08:04 +00001379 std::string Msg1 = "Executing Pass '";
1380 std::string Msg3 = "' Made Modification '";
1381
Devang Patel8cad70d2006-11-11 01:51:02 +00001382 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1383 e = passVectorEnd(); itr != e; ++itr) {
Devang Patel05e1a972006-11-07 22:03:15 +00001384 Pass *P = *itr;
Devang Patelf6d1d212006-12-14 00:25:06 +00001385 AnalysisUsage AnUsage;
1386 P->getAnalysisUsage(AnUsage);
Devang Patel93a197c2006-12-14 00:08:04 +00001387
Devang Patel200d3052006-12-13 23:50:44 +00001388 std::string Msg2 = "' on Module '" + M.getModuleIdentifier() + "'...\n";
1389 dumpPassInfo(P, Msg1, Msg2);
Devang Patelf6d1d212006-12-14 00:25:06 +00001390 dumpAnalysisSetInfo("Required", P, AnUsage.getRequiredSet());
Devang Patel93a197c2006-12-14 00:08:04 +00001391
Devang Patel47d7df72006-12-12 23:13:09 +00001392 initializeAnalysisImpl(P);
Devang Patel05e1a972006-11-07 22:03:15 +00001393 ModulePass *MP = dynamic_cast<ModulePass*>(P);
Devang Patelb8817b92006-12-14 00:59:42 +00001394
1395 if (TheTimeInfo) TheTimeInfo->passStarted(P);
Devang Patel05e1a972006-11-07 22:03:15 +00001396 Changed |= MP->runOnModule(M);
Devang Patelb8817b92006-12-14 00:59:42 +00001397 if (TheTimeInfo) TheTimeInfo->passEnded(P);
Devang Patel93a197c2006-12-14 00:08:04 +00001398
1399 if (Changed)
1400 dumpPassInfo(P, Msg3, Msg2);
Devang Patelf6d1d212006-12-14 00:25:06 +00001401 dumpAnalysisSetInfo("Preserved", P, AnUsage.getPreservedSet());
1402
Devang Patel050ec722006-11-14 01:23:29 +00001403 removeNotPreservedAnalysis(P);
Devang Patel17bff0d2006-12-07 22:09:36 +00001404 recordAvailableAnalysis(P);
Devang Patel200d3052006-12-13 23:50:44 +00001405 removeDeadPasses(P, Msg2);
Devang Patel05e1a972006-11-07 22:03:15 +00001406 }
1407 return Changed;
1408}
1409
Devang Patela1514cb2006-12-07 19:39:39 +00001410//===----------------------------------------------------------------------===//
1411// PassManagerImpl implementation
Devang Patelab97cf42006-12-13 00:09:23 +00001412//
Devang Patelc290c8a2006-11-07 22:23:34 +00001413/// Add P into active pass manager or use new module pass manager to
1414/// manage it.
Devang Patel1a6eaa42006-11-11 02:22:31 +00001415bool PassManagerImpl_New::addPass(Pass *P) {
Devang Patelc290c8a2006-11-07 22:23:34 +00001416
Devang Patel6c9f5482006-11-11 00:42:16 +00001417 if (!activeManager || !activeManager->addPass(P)) {
Devang Patelb67904d2006-12-13 02:36:01 +00001418 activeManager = new ModulePassManager(getDepth() + 1);
Devang Patel9c6290c2006-12-12 22:02:16 +00001419 // Inherit top level manager
1420 activeManager->setTopLevelManager(this->getTopLevelManager());
Devang Pateld440cd92006-12-08 23:53:00 +00001421
1422 // This top level manager is going to manage activeManager.
1423 // Set up analysis resolver to connect them.
1424 AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
1425 activeManager->setResolver(AR);
1426
Devang Patel5bbeb492006-12-08 22:47:25 +00001427 addPassManager(activeManager);
Devang Patel28bbcbe2006-12-07 21:44:12 +00001428 return activeManager->addPass(P);
Devang Patelc290c8a2006-11-07 22:23:34 +00001429 }
Devang Patel28bbcbe2006-12-07 21:44:12 +00001430 return true;
Devang Patelc290c8a2006-11-07 22:23:34 +00001431}
1432
1433/// run - Execute all of the passes scheduled for execution. Keep track of
1434/// whether any of the passes modifies the module, and if so, return true.
Devang Patel1a6eaa42006-11-11 02:22:31 +00001435bool PassManagerImpl_New::run(Module &M) {
Devang Patelc290c8a2006-11-07 22:23:34 +00001436
Devang Patelc290c8a2006-11-07 22:23:34 +00001437 bool Changed = false;
Devang Patelf1567a52006-12-13 20:03:48 +00001438
Devang Patelb8817b92006-12-14 00:59:42 +00001439 TimingInfo::createTheTimeInfo();
1440
Devang Patelcfd70c42006-12-13 22:10:00 +00001441 dumpArguments();
Devang Patel03fb5872006-12-13 21:13:31 +00001442 if (PassDebugging_New >= Structure)
Devang Patelf1567a52006-12-13 20:03:48 +00001443 dumpPasses();
1444
Devang Patel5bbeb492006-12-08 22:47:25 +00001445 for (std::vector<Pass *>::iterator I = passManagersBegin(),
1446 E = passManagersEnd(); I != E; ++I) {
Devang Patelb67904d2006-12-13 02:36:01 +00001447 ModulePassManager *MP = dynamic_cast<ModulePassManager *>(*I);
Devang Patel5bbeb492006-12-08 22:47:25 +00001448 Changed |= MP->runOnModule(M);
Devang Patelc290c8a2006-11-07 22:23:34 +00001449 }
1450 return Changed;
1451}
Devang Patel376fefa2006-11-08 10:29:57 +00001452
Devang Patela1514cb2006-12-07 19:39:39 +00001453//===----------------------------------------------------------------------===//
1454// PassManager implementation
1455
Devang Patel376fefa2006-11-08 10:29:57 +00001456/// Create new pass manager
Devang Patelb67904d2006-12-13 02:36:01 +00001457PassManager::PassManager() {
Devang Patel4c36e6b2006-12-07 23:24:58 +00001458 PM = new PassManagerImpl_New(0);
Devang Patel9c6290c2006-12-12 22:02:16 +00001459 // PM is the top level manager
1460 PM->setTopLevelManager(PM);
Devang Patel376fefa2006-11-08 10:29:57 +00001461}
1462
Devang Patelb67904d2006-12-13 02:36:01 +00001463PassManager::~PassManager() {
Devang Patelab97cf42006-12-13 00:09:23 +00001464 delete PM;
1465}
1466
Devang Patel376fefa2006-11-08 10:29:57 +00001467/// add - Add a pass to the queue of passes to run. This passes ownership of
1468/// the Pass to the PassManager. When the PassManager is destroyed, the pass
1469/// will be destroyed as well, so there is no need to delete the pass. This
1470/// implies that all passes MUST be allocated with 'new'.
1471void
Devang Patelb67904d2006-12-13 02:36:01 +00001472PassManager::add(Pass *P) {
Devang Patel376fefa2006-11-08 10:29:57 +00001473 PM->add(P);
1474}
1475
1476/// run - Execute all of the passes scheduled for execution. Keep track of
1477/// whether any of the passes modifies the module, and if so, return true.
1478bool
Devang Patelb67904d2006-12-13 02:36:01 +00001479PassManager::run(Module &M) {
Devang Patel376fefa2006-11-08 10:29:57 +00001480 return PM->run(M);
1481}
1482
Devang Patelb8817b92006-12-14 00:59:42 +00001483//===----------------------------------------------------------------------===//
1484// TimingInfo Class - This class is used to calculate information about the
1485// amount of time each pass takes to execute. This only happens with
1486// -time-passes is enabled on the command line.
1487//
1488bool llvm::TimePassesIsEnabled = false;
1489static cl::opt<bool,true>
1490EnableTiming("time-passes", cl::location(TimePassesIsEnabled),
1491 cl::desc("Time each pass, printing elapsed time for each on exit"));
1492
1493// createTheTimeInfo - This method either initializes the TheTimeInfo pointer to
1494// a non null value (if the -time-passes option is enabled) or it leaves it
1495// null. It may be called multiple times.
1496void TimingInfo::createTheTimeInfo() {
1497 if (!TimePassesIsEnabled || TheTimeInfo) return;
1498
1499 // Constructed the first time this is called, iff -time-passes is enabled.
1500 // This guarantees that the object will be constructed before static globals,
1501 // thus it will be destroyed before them.
1502 static ManagedStatic<TimingInfo> TTI;
1503 TheTimeInfo = &*TTI;
1504}
1505
Devang Patelb67904d2006-12-13 02:36:01 +00001506#endif