blob: 919051514a0cda159fc508b0302712fd8652d79b [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 Patelffca9102006-12-15 19:39:30 +000024
Devang Patel6e5a1132006-11-07 21:31:57 +000025using namespace llvm;
Devang Patelffca9102006-12-15 19:39:30 +000026class llvm::PMDataManager;
Devang Patel6e5a1132006-11-07 21:31:57 +000027
Devang Patel6fea2852006-12-07 18:23:30 +000028//===----------------------------------------------------------------------===//
29// Overview:
30// The Pass Manager Infrastructure manages passes. It's responsibilities are:
31//
32// o Manage optimization pass execution order
33// o Make required Analysis information available before pass P is run
34// o Release memory occupied by dead passes
35// o If Analysis information is dirtied by a pass then regenerate Analysis
36// information before it is consumed by another pass.
37//
Chris Lattnerce22ca32006-12-14 18:22:14 +000038// Pass Manager Infrastructure uses multiple pass managers. They are
39// PassManager, FunctionPassManager, ModulePassManager, BasicBlockPassManager.
40// This class hierarcy uses multiple inheritance but pass managers do not derive
41// from another pass manager.
Devang Patel6fea2852006-12-07 18:23:30 +000042//
Chris Lattnerce22ca32006-12-14 18:22:14 +000043// PassManager and FunctionPassManager are two top-level pass manager that
Devang Patel6fea2852006-12-07 18:23:30 +000044// represents the external interface of this entire pass manager infrastucture.
45//
46// Important classes :
47//
48// [o] class PMTopLevelManager;
49//
50// Two top level managers, PassManager and FunctionPassManager, derive from
51// PMTopLevelManager. PMTopLevelManager manages information used by top level
52// managers such as last user info.
53//
54// [o] class PMDataManager;
55//
56// PMDataManager manages information, e.g. list of available analysis info,
57// used by a pass manager to manage execution order of passes. It also provides
58// a place to implement common pass manager APIs. All pass managers derive from
59// PMDataManager.
60//
61// [o] class BasicBlockPassManager : public FunctionPass, public PMDataManager;
62//
63// BasicBlockPassManager manages BasicBlockPasses.
64//
65// [o] class FunctionPassManager;
66//
67// This is a external interface used by JIT to manage FunctionPasses. This
68// interface relies on FunctionPassManagerImpl to do all the tasks.
69//
70// [o] class FunctionPassManagerImpl : public ModulePass, PMDataManager,
71// public PMTopLevelManager;
72//
73// FunctionPassManagerImpl is a top level manager. It manages FunctionPasses
74// and BasicBlockPassManagers.
75//
76// [o] class ModulePassManager : public Pass, public PMDataManager;
77//
78// ModulePassManager manages ModulePasses and FunctionPassManagerImpls.
79//
80// [o] class PassManager;
81//
82// This is a external interface used by various tools to manages passes. It
83// relies on PassManagerImpl to do all the tasks.
84//
85// [o] class PassManagerImpl : public Pass, public PMDataManager,
86// public PMDTopLevelManager
87//
88// PassManagerImpl is a top level pass manager responsible for managing
89// ModulePassManagers.
90//===----------------------------------------------------------------------===//
91
Devang Patelf1567a52006-12-13 20:03:48 +000092namespace llvm {
93
94//===----------------------------------------------------------------------===//
95// Pass debugging information. Often it is useful to find out what pass is
96// running when a crash occurs in a utility. When this library is compiled with
97// debugging on, a command line option (--debug-pass) is enabled that causes the
98// pass name to be printed before it executes.
99//
100
Devang Patel03fb5872006-12-13 21:13:31 +0000101// Different debug levels that can be enabled...
102enum PassDebugLevel {
103 None, Arguments, Structure, Executions, Details
104};
105
Devang Patelf1567a52006-12-13 20:03:48 +0000106static cl::opt<enum PassDebugLevel>
107PassDebugging_New("debug-pass", cl::Hidden,
108 cl::desc("Print PassManager debugging information"),
109 cl::values(
Devang Patel03fb5872006-12-13 21:13:31 +0000110 clEnumVal(None , "disable debug output"),
111 clEnumVal(Arguments , "print pass arguments to pass to 'opt'"),
112 clEnumVal(Structure , "print pass structure before run()"),
113 clEnumVal(Executions, "print pass name before it is executed"),
114 clEnumVal(Details , "print pass details when it is executed"),
Devang Patelf1567a52006-12-13 20:03:48 +0000115 clEnumValEnd));
116} // End of llvm namespace
117
Devang Patelb67904d2006-12-13 02:36:01 +0000118#ifndef USE_OLD_PASSMANAGER
Devang Patelffca9102006-12-15 19:39:30 +0000119namespace {
Devang Patelafb1f3622006-12-12 22:35:25 +0000120
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.
Devang Patelffca9102006-12-15 19:39:30 +0000126class VISIBILITY_HIDDEN 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.
Devang Patel991aeba2006-12-15 20:13:01 +0000194 void dumpPasses() const;
195 void dumpArguments() const;
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};
Devang Patelffca9102006-12-15 19:39:30 +0000213
214} // End of anon namespace
Devang Patelf33f3eb2006-12-07 19:21:29 +0000215
Devang Patelf3827bc2006-12-07 19:54:15 +0000216//===----------------------------------------------------------------------===//
217// PMDataManager
Devang Patelf33f3eb2006-12-07 19:21:29 +0000218
Devang Patelffca9102006-12-15 19:39:30 +0000219namespace llvm {
Devang Pateldbe4a1e2006-12-07 18:36:24 +0000220/// PMDataManager provides the common place to manage the analysis data
221/// used by pass managers.
222class PMDataManager {
Devang Patela9844592006-11-11 01:31:05 +0000223public:
Devang Patel4c36e6b2006-12-07 23:24:58 +0000224 PMDataManager(int D) : TPM(NULL), Depth(D) {
Devang Patelf3827bc2006-12-07 19:54:15 +0000225 initializeAnalysisInfo();
226 }
227
Devang Patelab97cf42006-12-13 00:09:23 +0000228 virtual ~PMDataManager() {
229
230 for (std::vector<Pass *>::iterator I = PassVector.begin(),
231 E = PassVector.end(); I != E; ++I)
232 delete *I;
233
234 PassVector.clear();
235 }
236
Devang Patela9844592006-11-11 01:31:05 +0000237 /// Return true IFF pass P's required analysis set does not required new
238 /// manager.
239 bool manageablePass(Pass *P);
240
Devang Patela9844592006-11-11 01:31:05 +0000241 /// Augment AvailableAnalysis by adding analysis made available by pass P.
Devang Patele9976aa2006-12-07 19:33:53 +0000242 void recordAvailableAnalysis(Pass *P);
Devang Patela9844592006-11-11 01:31:05 +0000243
Devang Patela9844592006-11-11 01:31:05 +0000244 /// Remove Analysis that is not preserved by the pass
245 void removeNotPreservedAnalysis(Pass *P);
246
247 /// Remove dead passes
Devang Patel200d3052006-12-13 23:50:44 +0000248 void removeDeadPasses(Pass *P, std::string &Msg);
Devang Patela9844592006-11-11 01:31:05 +0000249
Devang Patel8f677ce2006-12-07 18:47:25 +0000250 /// Add pass P into the PassVector. Update
Devang Patel90b05e02006-11-11 02:04:19 +0000251 /// AvailableAnalysis appropriately if ProcessAnalysis is true.
Chris Lattnerce22ca32006-12-14 18:22:14 +0000252 void addPassToManager(Pass *P, bool ProcessAnalysis = true);
Devang Patel8cad70d2006-11-11 01:51:02 +0000253
Devang Patel1d6267c2006-12-07 23:05:44 +0000254 /// Initialize available analysis information.
Devang Patela6b6dcb2006-12-07 18:41:09 +0000255 void initializeAnalysisInfo() {
Devang Patel832bc072006-12-15 00:08:26 +0000256 TransferLastUses.clear();
Devang Patel050ec722006-11-14 01:23:29 +0000257 AvailableAnalysis.clear();
258 }
259
Devang Patel1d6267c2006-12-07 23:05:44 +0000260 /// Populate RequiredPasses with the analysis pass that are required by
261 /// pass P.
262 void collectRequiredAnalysisPasses(std::vector<Pass *> &RequiredPasses,
263 Pass *P);
264
265 /// All Required analyses should be available to the pass as it runs! Here
266 /// we fill in the AnalysisImpls member of the pass so that it can
267 /// successfully use the getAnalysis() method to retrieve the
268 /// implementations it needs.
269 void initializeAnalysisImpl(Pass *P);
Devang Patelf60b5d92006-11-14 01:59:59 +0000270
Devang Patel640c5bb2006-12-08 22:30:11 +0000271 /// Find the pass that implements Analysis AID. If desired pass is not found
272 /// then return NULL.
273 Pass *findAnalysisPass(AnalysisID AID, bool Direction);
274
Devang Patel8cad70d2006-11-11 01:51:02 +0000275 inline std::vector<Pass *>::iterator passVectorBegin() {
276 return PassVector.begin();
277 }
278
279 inline std::vector<Pass *>::iterator passVectorEnd() {
280 return PassVector.end();
281 }
282
Devang Patelf3827bc2006-12-07 19:54:15 +0000283 // Access toplevel manager
284 PMTopLevelManager *getTopLevelManager() { return TPM; }
285 void setTopLevelManager(PMTopLevelManager *T) { TPM = T; }
286
Devang Patel991aeba2006-12-15 20:13:01 +0000287 unsigned getDepth() const { return Depth; }
Devang Patel4c36e6b2006-12-07 23:24:58 +0000288
Devang Patel991aeba2006-12-15 20:13:01 +0000289 // Print routines used by debug-pass
290 void dumpLastUses(Pass *P, unsigned Offset) const;
291 void dumpPassArguments() const;
292 void dumpPassInfo(Pass *P, std::string &Msg1, std::string &Msg2) const;
Devang Patelf6d1d212006-12-14 00:25:06 +0000293 void dumpAnalysisSetInfo(const char *Msg, Pass *P,
Devang Patel991aeba2006-12-15 20:13:01 +0000294 const std::vector<AnalysisID> &Set) const;
Devang Patel832bc072006-12-15 00:08:26 +0000295
296 std::vector<Pass *>& getTransferredLastUses() {
297 return TransferLastUses;
298 }
299
Devang Patelbc03f132006-12-07 23:55:10 +0000300protected:
301
Devang Patel832bc072006-12-15 00:08:26 +0000302 // If a FunctionPass F is the last user of ModulePass info M
Devang Patelbc03f132006-12-07 23:55:10 +0000303 // then the F's manager, not F, records itself as a last user of M.
Devang Patel832bc072006-12-15 00:08:26 +0000304 // Current pass manage is requesting parent manager to record parent
305 // manager as the last user of these TrransferLastUses passes.
306 std::vector<Pass *> TransferLastUses;
Devang Patelbc03f132006-12-07 23:55:10 +0000307
308 // Top level manager.
Devang Patelbc03f132006-12-07 23:55:10 +0000309 PMTopLevelManager *TPM;
310
Devang Patela9844592006-11-11 01:31:05 +0000311private:
Devang Pateldafa4dd2006-11-14 00:03:04 +0000312 // Set of available Analysis. This information is used while scheduling
313 // pass. If a pass requires an analysis which is not not available then
314 // equired analysis pass is scheduled to run before the pass itself is
315 // scheduled to run.
Devang Patelf60b5d92006-11-14 01:59:59 +0000316 std::map<AnalysisID, Pass*> AvailableAnalysis;
Devang Patel8cad70d2006-11-11 01:51:02 +0000317
318 // Collection of pass that are managed by this manager
319 std::vector<Pass *> PassVector;
Devang Patelf3827bc2006-12-07 19:54:15 +0000320
Devang Patel4c36e6b2006-12-07 23:24:58 +0000321 unsigned Depth;
Devang Patela9844592006-11-11 01:31:05 +0000322};
323
Devang Patel10c2ca62006-12-12 22:47:13 +0000324//===----------------------------------------------------------------------===//
Devang Patelb67904d2006-12-13 02:36:01 +0000325// BasicBlockPassManager
Devang Patel10c2ca62006-12-12 22:47:13 +0000326//
Devang Patelb67904d2006-12-13 02:36:01 +0000327/// BasicBlockPassManager manages BasicBlockPass. It batches all the
Devang Patelca58e352006-11-08 10:05:38 +0000328/// pass together and sequence them to process one basic block before
329/// processing next basic block.
Devang Patelffca9102006-12-15 19:39:30 +0000330class VISIBILITY_HIDDEN BasicBlockPassManager : public PMDataManager,
Chris Lattnerce22ca32006-12-14 18:22:14 +0000331 public FunctionPass {
Devang Patelca58e352006-11-08 10:05:38 +0000332
333public:
Devang Patelb67904d2006-12-13 02:36:01 +0000334 BasicBlockPassManager(int D) : PMDataManager(D) { }
Devang Patelca58e352006-11-08 10:05:38 +0000335
336 /// Add a pass into a passmanager queue.
337 bool addPass(Pass *p);
338
339 /// Execute all of the passes scheduled for execution. Keep track of
340 /// whether any of the passes modifies the function, and if so, return true.
341 bool runOnFunction(Function &F);
342
Devang Patelf9d96b92006-12-07 19:57:52 +0000343 /// Pass Manager itself does not invalidate any analysis info.
344 void getAnalysisUsage(AnalysisUsage &Info) const {
345 Info.setPreservesAll();
346 }
347
Devang Patel475c4532006-12-08 00:59:05 +0000348 bool doInitialization(Module &M);
349 bool doInitialization(Function &F);
350 bool doFinalization(Module &M);
351 bool doFinalization(Function &F);
352
Devang Pateleda56172006-12-12 23:34:33 +0000353 // Print passes managed by this manager
354 void dumpPassStructure(unsigned Offset) {
Devang Patelffca9102006-12-15 19:39:30 +0000355 llvm::cerr << std::string(Offset*2, ' ') << "BasicBlockPass Manager\n";
Devang Pateleda56172006-12-12 23:34:33 +0000356 for (std::vector<Pass *>::iterator I = passVectorBegin(),
357 E = passVectorEnd(); I != E; ++I) {
358 (*I)->dumpPassStructure(Offset + 1);
359 dumpLastUses(*I, Offset+1);
360 }
361 }
Devang Patelca58e352006-11-08 10:05:38 +0000362};
363
Devang Patel10c2ca62006-12-12 22:47:13 +0000364//===----------------------------------------------------------------------===//
365// FunctionPassManagerImpl_New
366//
Chris Lattnerf0f611a2006-12-13 21:56:10 +0000367/// FunctionPassManagerImpl_New manages FunctionPasses and
368/// BasicBlockPassManagers. It batches all function passes and basic block pass
369/// managers together and sequence them to process one function at a time before
370/// processing next function.
Devang Patelabcd1d32006-12-07 21:27:23 +0000371class FunctionPassManagerImpl_New : public ModulePass,
372 public PMDataManager,
373 public PMTopLevelManager {
Devang Patelca58e352006-11-08 10:05:38 +0000374public:
Devang Patel4c36e6b2006-12-07 23:24:58 +0000375 FunctionPassManagerImpl_New(int D) : PMDataManager(D) {
Devang Patelca58e352006-11-08 10:05:38 +0000376 activeBBPassManager = NULL;
377 }
Devang Patel4e12f862006-11-08 10:44:40 +0000378 ~FunctionPassManagerImpl_New() { /* TODO */ };
Devang Patelca58e352006-11-08 10:05:38 +0000379
Devang Patelabcd1d32006-12-07 21:27:23 +0000380 inline void addTopLevelPass(Pass *P) {
Devang Pateld440cd92006-12-08 23:53:00 +0000381
Devang Patelfa971cd2006-12-08 23:57:43 +0000382 if (ImmutablePass *IP = dynamic_cast<ImmutablePass *> (P)) {
Devang Pateld440cd92006-12-08 23:53:00 +0000383
384 // P is a immutable pass then it will be managed by this
385 // top level manager. Set up analysis resolver to connect them.
386 AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
387 P->setResolver(AR);
Devang Patel95257542006-12-12 22:21:37 +0000388 initializeAnalysisImpl(P);
Devang Patelfa971cd2006-12-08 23:57:43 +0000389 addImmutablePass(IP);
Devang Patel95257542006-12-12 22:21:37 +0000390 recordAvailableAnalysis(IP);
Devang Patelfa971cd2006-12-08 23:57:43 +0000391 }
392 else
393 addPass(P);
Devang Patelabcd1d32006-12-07 21:27:23 +0000394 }
395
Devang Patelca58e352006-11-08 10:05:38 +0000396 /// add - Add a pass to the queue of passes to run. This passes
397 /// ownership of the Pass to the PassManager. When the
398 /// PassManager_X is destroyed, the pass will be destroyed as well, so
399 /// there is no need to delete the pass. (TODO delete passes.)
400 /// This implies that all passes MUST be allocated with 'new'.
Devang Patel31217af2006-12-07 21:32:57 +0000401 void add(Pass *P) {
Devang Pateldf6c9ae2006-12-08 22:34:02 +0000402 schedulePass(P);
Devang Patel31217af2006-12-07 21:32:57 +0000403 }
Devang Patelca58e352006-11-08 10:05:38 +0000404
405 /// Add pass into the pass manager queue.
406 bool addPass(Pass *P);
407
408 /// Execute all of the passes scheduled for execution. Keep
409 /// track of whether any of the passes modifies the function, and if
410 /// so, return true.
411 bool runOnModule(Module &M);
Devang Patel9f3083e2006-11-15 19:39:54 +0000412 bool runOnFunction(Function &F);
Devang Patel272908d2006-12-08 22:57:48 +0000413 bool run(Function &F);
Devang Patelca58e352006-11-08 10:05:38 +0000414
Devang Patelff631ae2006-11-15 01:27:05 +0000415 /// doInitialization - Run all of the initializers for the function passes.
416 ///
417 bool doInitialization(Module &M);
418
419 /// doFinalization - Run all of the initializers for the function passes.
420 ///
421 bool doFinalization(Module &M);
Devang Patelf9d96b92006-12-07 19:57:52 +0000422
423 /// Pass Manager itself does not invalidate any analysis info.
424 void getAnalysisUsage(AnalysisUsage &Info) const {
425 Info.setPreservesAll();
426 }
427
Devang Pateleda56172006-12-12 23:34:33 +0000428 // Print passes managed by this manager
429 void dumpPassStructure(unsigned Offset) {
430 llvm::cerr << std::string(Offset*2, ' ') << "FunctionPass Manager\n";
431 for (std::vector<Pass *>::iterator I = passVectorBegin(),
432 E = passVectorEnd(); I != E; ++I) {
433 (*I)->dumpPassStructure(Offset + 1);
434 dumpLastUses(*I, Offset+1);
435 }
436 }
437
Devang Patelca58e352006-11-08 10:05:38 +0000438private:
Devang Patelca58e352006-11-08 10:05:38 +0000439 // Active Pass Managers
Devang Patelb67904d2006-12-13 02:36:01 +0000440 BasicBlockPassManager *activeBBPassManager;
Devang Patelca58e352006-11-08 10:05:38 +0000441};
442
Devang Patel10c2ca62006-12-12 22:47:13 +0000443//===----------------------------------------------------------------------===//
Devang Patelb67904d2006-12-13 02:36:01 +0000444// ModulePassManager
Devang Patel10c2ca62006-12-12 22:47:13 +0000445//
Devang Patelb67904d2006-12-13 02:36:01 +0000446/// ModulePassManager manages ModulePasses and function pass managers.
Devang Patelca58e352006-11-08 10:05:38 +0000447/// It batches all Module passes passes and function pass managers together and
448/// sequence them to process one module.
Chris Lattnerce22ca32006-12-14 18:22:14 +0000449class ModulePassManager : public Pass, public PMDataManager {
Devang Patelca58e352006-11-08 10:05:38 +0000450
451public:
Devang Patelb67904d2006-12-13 02:36:01 +0000452 ModulePassManager(int D) : PMDataManager(D) {
Devang Patel4c36e6b2006-12-07 23:24:58 +0000453 activeFunctionPassManager = NULL;
454 }
Devang Patelca58e352006-11-08 10:05:38 +0000455
456 /// Add a pass into a passmanager queue.
457 bool addPass(Pass *p);
458
459 /// run - Execute all of the passes scheduled for execution. Keep track of
460 /// whether any of the passes modifies the module, and if so, return true.
461 bool runOnModule(Module &M);
Devang Patelebba9702006-11-13 22:40:09 +0000462
Devang Patelf9d96b92006-12-07 19:57:52 +0000463 /// Pass Manager itself does not invalidate any analysis info.
464 void getAnalysisUsage(AnalysisUsage &Info) const {
465 Info.setPreservesAll();
466 }
467
Devang Pateleda56172006-12-12 23:34:33 +0000468 // Print passes managed by this manager
469 void dumpPassStructure(unsigned Offset) {
470 llvm::cerr << std::string(Offset*2, ' ') << "ModulePass Manager\n";
471 for (std::vector<Pass *>::iterator I = passVectorBegin(),
472 E = passVectorEnd(); I != E; ++I) {
473 (*I)->dumpPassStructure(Offset + 1);
474 dumpLastUses(*I, Offset+1);
475 }
476 }
477
Devang Patelca58e352006-11-08 10:05:38 +0000478private:
Devang Patelca58e352006-11-08 10:05:38 +0000479 // Active Pass Manager
Devang Patel4e12f862006-11-08 10:44:40 +0000480 FunctionPassManagerImpl_New *activeFunctionPassManager;
Devang Patelca58e352006-11-08 10:05:38 +0000481};
482
Devang Patel10c2ca62006-12-12 22:47:13 +0000483//===----------------------------------------------------------------------===//
484// PassManagerImpl_New
485//
486/// PassManagerImpl_New manages ModulePassManagers
Devang Patel31217af2006-12-07 21:32:57 +0000487class PassManagerImpl_New : public Pass,
488 public PMDataManager,
Devang Patelabcd1d32006-12-07 21:27:23 +0000489 public PMTopLevelManager {
Devang Patel376fefa2006-11-08 10:29:57 +0000490
491public:
492
Devang Patelad6b7fe2006-12-12 22:57:43 +0000493 PassManagerImpl_New(int D) : PMDataManager(D) {
494 activeManager = NULL;
495 }
Devang Patel4c36e6b2006-12-07 23:24:58 +0000496
Devang Patel376fefa2006-11-08 10:29:57 +0000497 /// add - Add a pass to the queue of passes to run. This passes ownership of
498 /// the Pass to the PassManager. When the PassManager is destroyed, the pass
499 /// will be destroyed as well, so there is no need to delete the pass. This
500 /// implies that all passes MUST be allocated with 'new'.
Devang Patel31217af2006-12-07 21:32:57 +0000501 void add(Pass *P) {
Devang Pateldf6c9ae2006-12-08 22:34:02 +0000502 schedulePass(P);
Devang Patel31217af2006-12-07 21:32:57 +0000503 }
Devang Patel376fefa2006-11-08 10:29:57 +0000504
505 /// run - Execute all of the passes scheduled for execution. Keep track of
506 /// whether any of the passes modifies the module, and if so, return true.
507 bool run(Module &M);
508
Devang Patelf9d96b92006-12-07 19:57:52 +0000509 /// Pass Manager itself does not invalidate any analysis info.
510 void getAnalysisUsage(AnalysisUsage &Info) const {
511 Info.setPreservesAll();
512 }
513
Devang Patelabcd1d32006-12-07 21:27:23 +0000514 inline void addTopLevelPass(Pass *P) {
Devang Pateld440cd92006-12-08 23:53:00 +0000515
Devang Patelfa971cd2006-12-08 23:57:43 +0000516 if (ImmutablePass *IP = dynamic_cast<ImmutablePass *> (P)) {
Devang Pateld440cd92006-12-08 23:53:00 +0000517
518 // P is a immutable pass and it will be managed by this
519 // top level manager. Set up analysis resolver to connect them.
520 AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
521 P->setResolver(AR);
Devang Patel95257542006-12-12 22:21:37 +0000522 initializeAnalysisImpl(P);
Devang Patelfa971cd2006-12-08 23:57:43 +0000523 addImmutablePass(IP);
Devang Patel95257542006-12-12 22:21:37 +0000524 recordAvailableAnalysis(IP);
Devang Pateld440cd92006-12-08 23:53:00 +0000525 }
Devang Patelfa971cd2006-12-08 23:57:43 +0000526 else
527 addPass(P);
Devang Patelabcd1d32006-12-07 21:27:23 +0000528 }
529
Devang Patel376fefa2006-11-08 10:29:57 +0000530private:
531
Devang Patelde124182006-12-07 21:10:57 +0000532 /// Add a pass into a passmanager queue.
Devang Patel376fefa2006-11-08 10:29:57 +0000533 bool addPass(Pass *p);
534
Devang Patel376fefa2006-11-08 10:29:57 +0000535 // Active Pass Manager
Devang Patelb67904d2006-12-13 02:36:01 +0000536 ModulePassManager *activeManager;
Devang Patel376fefa2006-11-08 10:29:57 +0000537};
538
Devang Patelffca9102006-12-15 19:39:30 +0000539} // End of llvm namespace
540
541namespace {
542
Devang Patelb8817b92006-12-14 00:59:42 +0000543//===----------------------------------------------------------------------===//
544// TimingInfo Class - This class is used to calculate information about the
545// amount of time each pass takes to execute. This only happens when
546// -time-passes is enabled on the command line.
547//
548
Devang Patelffca9102006-12-15 19:39:30 +0000549class VISIBILITY_HIDDEN TimingInfo {
Devang Patelb8817b92006-12-14 00:59:42 +0000550 std::map<Pass*, Timer> TimingData;
551 TimerGroup TG;
552
553public:
554 // Use 'create' member to get this.
555 TimingInfo() : TG("... Pass execution timing report ...") {}
556
557 // TimingDtor - Print out information about timing information
558 ~TimingInfo() {
559 // Delete all of the timers...
560 TimingData.clear();
561 // TimerGroup is deleted next, printing the report.
562 }
563
564 // createTheTimeInfo - This method either initializes the TheTimeInfo pointer
565 // to a non null value (if the -time-passes option is enabled) or it leaves it
566 // null. It may be called multiple times.
567 static void createTheTimeInfo();
568
569 void passStarted(Pass *P) {
570
571 if (dynamic_cast<PMDataManager *>(P))
572 return;
573
574 std::map<Pass*, Timer>::iterator I = TimingData.find(P);
575 if (I == TimingData.end())
576 I=TimingData.insert(std::make_pair(P, Timer(P->getPassName(), TG))).first;
577 I->second.startTimer();
578 }
579 void passEnded(Pass *P) {
580
581 if (dynamic_cast<PMDataManager *>(P))
582 return;
583
584 std::map<Pass*, Timer>::iterator I = TimingData.find(P);
585 assert (I != TimingData.end() && "passStarted/passEnded not nested right!");
586 I->second.stopTimer();
587 }
588};
589
590static TimingInfo *TheTimeInfo;
591
Devang Patelffca9102006-12-15 19:39:30 +0000592} // End of anon namespace
Devang Patelca58e352006-11-08 10:05:38 +0000593
Devang Patela1514cb2006-12-07 19:39:39 +0000594//===----------------------------------------------------------------------===//
Devang Patelafb1f3622006-12-12 22:35:25 +0000595// PMTopLevelManager implementation
596
597/// Set pass P as the last user of the given analysis passes.
598void PMTopLevelManager::setLastUser(std::vector<Pass *> &AnalysisPasses,
599 Pass *P) {
600
601 for (std::vector<Pass *>::iterator I = AnalysisPasses.begin(),
602 E = AnalysisPasses.end(); I != E; ++I) {
603 Pass *AP = *I;
604 LastUser[AP] = P;
605 // If AP is the last user of other passes then make P last user of
606 // such passes.
607 for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
608 LUE = LastUser.end(); LUI != LUE; ++LUI) {
609 if (LUI->second == AP)
610 LastUser[LUI->first] = P;
611 }
612 }
Devang Patelafb1f3622006-12-12 22:35:25 +0000613}
614
615/// Collect passes whose last user is P
616void PMTopLevelManager::collectLastUses(std::vector<Pass *> &LastUses,
617 Pass *P) {
618 for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
619 LUE = LastUser.end(); LUI != LUE; ++LUI)
620 if (LUI->second == P)
621 LastUses.push_back(LUI->first);
622}
623
624/// Schedule pass P for execution. Make sure that passes required by
625/// P are run before P is run. Update analysis info maintained by
626/// the manager. Remove dead passes. This is a recursive function.
627void PMTopLevelManager::schedulePass(Pass *P) {
628
629 // TODO : Allocate function manager for this pass, other wise required set
630 // may be inserted into previous function manager
631
632 AnalysisUsage AnUsage;
633 P->getAnalysisUsage(AnUsage);
634 const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
635 for (std::vector<AnalysisID>::const_iterator I = RequiredSet.begin(),
636 E = RequiredSet.end(); I != E; ++I) {
637
638 Pass *AnalysisPass = findAnalysisPass(*I);
639 if (!AnalysisPass) {
640 // Schedule this analysis run first.
641 AnalysisPass = (*I)->createPass();
642 schedulePass(AnalysisPass);
643 }
644 }
645
646 // Now all required passes are available.
647 addTopLevelPass(P);
648}
649
650/// Find the pass that implements Analysis AID. Search immutable
651/// passes and all pass managers. If desired pass is not found
652/// then return NULL.
653Pass *PMTopLevelManager::findAnalysisPass(AnalysisID AID) {
654
655 Pass *P = NULL;
Devang Patelcd6ba152006-12-12 22:50:05 +0000656 // Check pass managers
657 for (std::vector<Pass *>::iterator I = PassManagers.begin(),
658 E = PassManagers.end(); P == NULL && I != E; ++I) {
659 PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I);
660 assert(PMD && "This is not a PassManager");
661 P = PMD->findAnalysisPass(AID, false);
662 }
663
664 // Check other pass managers
665 for (std::vector<PMDataManager *>::iterator I = IndirectPassManagers.begin(),
666 E = IndirectPassManagers.end(); P == NULL && I != E; ++I)
667 P = (*I)->findAnalysisPass(AID, false);
668
Devang Patelafb1f3622006-12-12 22:35:25 +0000669 for (std::vector<ImmutablePass *>::iterator I = ImmutablePasses.begin(),
670 E = ImmutablePasses.end(); P == NULL && I != E; ++I) {
671 const PassInfo *PI = (*I)->getPassInfo();
672 if (PI == AID)
673 P = *I;
674
675 // If Pass not found then check the interfaces implemented by Immutable Pass
676 if (!P) {
677 const std::vector<const PassInfo*> &ImmPI =
678 PI->getInterfacesImplemented();
679 for (unsigned Index = 0, End = ImmPI.size();
680 P == NULL && Index != End; ++Index)
681 if (ImmPI[Index] == AID)
682 P = *I;
683 }
684 }
685
Devang Patelafb1f3622006-12-12 22:35:25 +0000686 return P;
687}
688
Devang Pateleda56172006-12-12 23:34:33 +0000689// Print passes managed by this top level manager.
Devang Patel991aeba2006-12-15 20:13:01 +0000690void PMTopLevelManager::dumpPasses() const {
Devang Pateleda56172006-12-12 23:34:33 +0000691
692 // Print out the immutable passes
693 for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i) {
694 ImmutablePasses[i]->dumpPassStructure(0);
695 }
696
Devang Patel991aeba2006-12-15 20:13:01 +0000697 for (std::vector<Pass *>::const_iterator I = PassManagers.begin(),
Devang Pateleda56172006-12-12 23:34:33 +0000698 E = PassManagers.end(); I != E; ++I)
699 (*I)->dumpPassStructure(1);
Devang Pateleda56172006-12-12 23:34:33 +0000700}
701
Devang Patel991aeba2006-12-15 20:13:01 +0000702void PMTopLevelManager::dumpArguments() const {
Devang Patelcfd70c42006-12-13 22:10:00 +0000703
704 if (PassDebugging_New < Arguments)
705 return;
706
707 cerr << "Pass Arguments: ";
Devang Patel991aeba2006-12-15 20:13:01 +0000708 for (std::vector<Pass *>::const_iterator I = PassManagers.begin(),
Devang Patelcfd70c42006-12-13 22:10:00 +0000709 E = PassManagers.end(); I != E; ++I) {
710 PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I);
711 assert(PMD && "This is not a PassManager");
712 PMD->dumpPassArguments();
713 }
714 cerr << "\n";
715}
716
Devang Patelafb1f3622006-12-12 22:35:25 +0000717//===----------------------------------------------------------------------===//
Devang Pateldbe4a1e2006-12-07 18:36:24 +0000718// PMDataManager implementation
Devang Patelf68a3492006-11-07 22:35:17 +0000719
Devang Pateld65e9e92006-11-08 01:31:28 +0000720/// Return true IFF pass P's required analysis set does not required new
Devang Patelf68a3492006-11-07 22:35:17 +0000721/// manager.
Devang Pateldbe4a1e2006-12-07 18:36:24 +0000722bool PMDataManager::manageablePass(Pass *P) {
Devang Patelf68a3492006-11-07 22:35:17 +0000723
Devang Patel8f677ce2006-12-07 18:47:25 +0000724 // TODO
725 // If this pass is not preserving information that is required by a
726 // pass maintained by higher level pass manager then do not insert
727 // this pass into current manager. Use new manager. For example,
728 // For example, If FunctionPass F is not preserving ModulePass Info M1
729 // that is used by another ModulePass M2 then do not insert F in
730 // current function pass manager.
Devang Patelf68a3492006-11-07 22:35:17 +0000731 return true;
732}
733
Devang Patel643676c2006-11-11 01:10:19 +0000734/// Augement AvailableAnalysis by adding analysis made available by pass P.
Devang Patele9976aa2006-12-07 19:33:53 +0000735void PMDataManager::recordAvailableAnalysis(Pass *P) {
Devang Patelf60b5d92006-11-14 01:59:59 +0000736
Devang Patel643676c2006-11-11 01:10:19 +0000737 if (const PassInfo *PI = P->getPassInfo()) {
Devang Patelf60b5d92006-11-14 01:59:59 +0000738 AvailableAnalysis[PI] = P;
Devang Patel643676c2006-11-11 01:10:19 +0000739
Devang Patele9976aa2006-12-07 19:33:53 +0000740 //This pass is the current implementation of all of the interfaces it
741 //implements as well.
742 const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
743 for (unsigned i = 0, e = II.size(); i != e; ++i)
744 AvailableAnalysis[II[i]] = P;
Devang Patel643676c2006-11-11 01:10:19 +0000745 }
746}
747
Devang Patelf68a3492006-11-07 22:35:17 +0000748/// Remove Analyss not preserved by Pass P
Devang Pateldbe4a1e2006-12-07 18:36:24 +0000749void PMDataManager::removeNotPreservedAnalysis(Pass *P) {
Devang Patel349170f2006-11-11 01:24:55 +0000750 AnalysisUsage AnUsage;
751 P->getAnalysisUsage(AnUsage);
Devang Patelf68a3492006-11-07 22:35:17 +0000752
Devang Patel2e169c32006-12-07 20:03:49 +0000753 if (AnUsage.getPreservesAll())
754 return;
755
756 const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
Devang Patelf60b5d92006-11-14 01:59:59 +0000757 for (std::map<AnalysisID, Pass*>::iterator I = AvailableAnalysis.begin(),
Devang Patelbe6bd55e2006-12-12 23:07:44 +0000758 E = AvailableAnalysis.end(); I != E; ) {
Devang Patelf60b5d92006-11-14 01:59:59 +0000759 if (std::find(PreservedSet.begin(), PreservedSet.end(), I->first) ==
Devang Patel349170f2006-11-11 01:24:55 +0000760 PreservedSet.end()) {
761 // Remove this analysis
Devang Patelbe6bd55e2006-12-12 23:07:44 +0000762 if (!dynamic_cast<ImmutablePass*>(I->second)) {
763 std::map<AnalysisID, Pass*>::iterator J = I++;
764 AvailableAnalysis.erase(J);
765 } else
766 ++I;
767 } else
768 ++I;
Devang Patel349170f2006-11-11 01:24:55 +0000769 }
Devang Patelf68a3492006-11-07 22:35:17 +0000770}
771
Devang Patelca189262006-11-14 03:05:08 +0000772/// Remove analysis passes that are not used any longer
Devang Patel200d3052006-12-13 23:50:44 +0000773void PMDataManager::removeDeadPasses(Pass *P, std::string &Msg) {
Devang Patel17ad0962006-12-08 00:37:52 +0000774
775 std::vector<Pass *> DeadPasses;
776 TPM->collectLastUses(DeadPasses, P);
777
778 for (std::vector<Pass *>::iterator I = DeadPasses.begin(),
779 E = DeadPasses.end(); I != E; ++I) {
Devang Patel200d3052006-12-13 23:50:44 +0000780
781 std::string Msg1 = " Freeing Pass '";
782 dumpPassInfo(*I, Msg1, Msg);
783
Devang Patelb8817b92006-12-14 00:59:42 +0000784 if (TheTimeInfo) TheTimeInfo->passStarted(P);
Devang Patel17ad0962006-12-08 00:37:52 +0000785 (*I)->releaseMemory();
Devang Patelb8817b92006-12-14 00:59:42 +0000786 if (TheTimeInfo) TheTimeInfo->passEnded(P);
787
Devang Patel17ad0962006-12-08 00:37:52 +0000788 std::map<AnalysisID, Pass*>::iterator Pos =
789 AvailableAnalysis.find((*I)->getPassInfo());
790
Devang Patel475c4532006-12-08 00:59:05 +0000791 // It is possible that pass is already removed from the AvailableAnalysis
Devang Patel17ad0962006-12-08 00:37:52 +0000792 if (Pos != AvailableAnalysis.end())
793 AvailableAnalysis.erase(Pos);
794 }
Devang Patelca189262006-11-14 03:05:08 +0000795}
796
Devang Patel8f677ce2006-12-07 18:47:25 +0000797/// Add pass P into the PassVector. Update
Devang Patel90b05e02006-11-11 02:04:19 +0000798/// AvailableAnalysis appropriately if ProcessAnalysis is true.
Devang Patel2e169c32006-12-07 20:03:49 +0000799void PMDataManager::addPassToManager(Pass *P,
800 bool ProcessAnalysis) {
Devang Patel8cad70d2006-11-11 01:51:02 +0000801
Devang Pateld440cd92006-12-08 23:53:00 +0000802 // This manager is going to manage pass P. Set up analysis resolver
803 // to connect them.
804 AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
805 P->setResolver(AR);
806
Devang Patel90b05e02006-11-11 02:04:19 +0000807 if (ProcessAnalysis) {
Devang Patelbc03f132006-12-07 23:55:10 +0000808
809 // At the moment, this pass is the last user of all required passes.
810 std::vector<Pass *> LastUses;
811 std::vector<Pass *> RequiredPasses;
812 unsigned PDepth = this->getDepth();
813
814 collectRequiredAnalysisPasses(RequiredPasses, P);
815 for (std::vector<Pass *>::iterator I = RequiredPasses.begin(),
816 E = RequiredPasses.end(); I != E; ++I) {
817 Pass *PRequired = *I;
818 unsigned RDepth = 0;
Devang Patel64619be2006-12-09 00:07:38 +0000819
820 PMDataManager &DM = PRequired->getResolver()->getPMDataManager();
821 RDepth = DM.getDepth();
822
Devang Patelbc03f132006-12-07 23:55:10 +0000823 if (PDepth == RDepth)
824 LastUses.push_back(PRequired);
825 else if (PDepth > RDepth) {
826 // Let the parent claim responsibility of last use
Devang Patel832bc072006-12-15 00:08:26 +0000827 TransferLastUses.push_back(PRequired);
Devang Patelbc03f132006-12-07 23:55:10 +0000828 } else {
829 // Note : This feature is not yet implemented
830 assert (0 &&
831 "Unable to handle Pass that requires lower level Analysis pass");
832 }
833 }
834
Devang Patel832bc072006-12-15 00:08:26 +0000835 LastUses.push_back(P);
836 TPM->setLastUser(LastUses, P);
Devang Patelbc03f132006-12-07 23:55:10 +0000837
Devang Patel17bff0d2006-12-07 22:09:36 +0000838 // Take a note of analysis required and made available by this pass.
Devang Patel90b05e02006-11-11 02:04:19 +0000839 // Remove the analysis not preserved by this pass
840 removeNotPreservedAnalysis(P);
Devang Patel17bff0d2006-12-07 22:09:36 +0000841 recordAvailableAnalysis(P);
Devang Patel90b05e02006-11-11 02:04:19 +0000842 }
Devang Patel8cad70d2006-11-11 01:51:02 +0000843
844 // Add pass
845 PassVector.push_back(P);
Devang Patel8cad70d2006-11-11 01:51:02 +0000846}
847
Devang Patel1d6267c2006-12-07 23:05:44 +0000848/// Populate RequiredPasses with the analysis pass that are required by
849/// pass P.
850void PMDataManager::collectRequiredAnalysisPasses(std::vector<Pass *> &RP,
851 Pass *P) {
852 AnalysisUsage AnUsage;
853 P->getAnalysisUsage(AnUsage);
854 const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
855 for (std::vector<AnalysisID>::const_iterator
856 I = RequiredSet.begin(), E = RequiredSet.end();
857 I != E; ++I) {
Devang Patel640c5bb2006-12-08 22:30:11 +0000858 Pass *AnalysisPass = findAnalysisPass(*I, true);
Devang Patel1d6267c2006-12-07 23:05:44 +0000859 assert (AnalysisPass && "Analysis pass is not available");
860 RP.push_back(AnalysisPass);
861 }
Devang Patelf58183d2006-12-12 23:09:32 +0000862
863 const std::vector<AnalysisID> &IDs = AnUsage.getRequiredTransitiveSet();
864 for (std::vector<AnalysisID>::const_iterator I = IDs.begin(),
865 E = IDs.end(); I != E; ++I) {
866 Pass *AnalysisPass = findAnalysisPass(*I, true);
867 assert (AnalysisPass && "Analysis pass is not available");
868 RP.push_back(AnalysisPass);
869 }
Devang Patel1d6267c2006-12-07 23:05:44 +0000870}
871
Devang Patel07f4f582006-11-14 21:49:36 +0000872// All Required analyses should be available to the pass as it runs! Here
873// we fill in the AnalysisImpls member of the pass so that it can
874// successfully use the getAnalysis() method to retrieve the
875// implementations it needs.
876//
Devang Pateldbe4a1e2006-12-07 18:36:24 +0000877void PMDataManager::initializeAnalysisImpl(Pass *P) {
Devang Patelff631ae2006-11-15 01:27:05 +0000878 AnalysisUsage AnUsage;
879 P->getAnalysisUsage(AnUsage);
Devang Patel07f4f582006-11-14 21:49:36 +0000880
881 for (std::vector<const PassInfo *>::const_iterator
882 I = AnUsage.getRequiredSet().begin(),
883 E = AnUsage.getRequiredSet().end(); I != E; ++I) {
Devang Patel640c5bb2006-12-08 22:30:11 +0000884 Pass *Impl = findAnalysisPass(*I, true);
Devang Patel07f4f582006-11-14 21:49:36 +0000885 if (Impl == 0)
886 assert(0 && "Analysis used but not available!");
Devang Patel984698a2006-12-09 01:11:34 +0000887 AnalysisResolver_New *AR = P->getResolver();
888 AR->addAnalysisImplsPair(*I, Impl);
Devang Patel07f4f582006-11-14 21:49:36 +0000889 }
890}
891
Devang Patel640c5bb2006-12-08 22:30:11 +0000892/// Find the pass that implements Analysis AID. If desired pass is not found
893/// then return NULL.
894Pass *PMDataManager::findAnalysisPass(AnalysisID AID, bool SearchParent) {
895
896 // Check if AvailableAnalysis map has one entry.
897 std::map<AnalysisID, Pass*>::const_iterator I = AvailableAnalysis.find(AID);
898
899 if (I != AvailableAnalysis.end())
900 return I->second;
901
902 // Search Parents through TopLevelManager
903 if (SearchParent)
904 return TPM->findAnalysisPass(AID);
905
Devang Patel9d759b82006-12-09 00:09:12 +0000906 return NULL;
Devang Patel640c5bb2006-12-08 22:30:11 +0000907}
908
Devang Patel991aeba2006-12-15 20:13:01 +0000909// Print list of passes that are last used by P.
910void PMDataManager::dumpLastUses(Pass *P, unsigned Offset) const{
911
912 std::vector<Pass *> LUses;
913
914 assert (TPM && "Top Level Manager is missing");
915 TPM->collectLastUses(LUses, P);
916
917 for (std::vector<Pass *>::iterator I = LUses.begin(),
918 E = LUses.end(); I != E; ++I) {
919 llvm::cerr << "--" << std::string(Offset*2, ' ');
920 (*I)->dumpPassStructure(0);
921 }
922}
923
924void PMDataManager::dumpPassArguments() const {
925 for(std::vector<Pass *>::const_iterator I = PassVector.begin(),
926 E = PassVector.end(); I != E; ++I) {
927 if (PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I))
928 PMD->dumpPassArguments();
929 else
930 if (const PassInfo *PI = (*I)->getPassInfo())
931 if (!PI->isAnalysisGroup())
932 cerr << " -" << PI->getPassArgument();
933 }
934}
935
936void PMDataManager:: dumpPassInfo(Pass *P, std::string &Msg1,
937 std::string &Msg2) const {
938 if (PassDebugging_New < Executions)
939 return;
940 cerr << (void*)this << std::string(getDepth()*2+1, ' ');
941 cerr << Msg1;
942 cerr << P->getPassName();
943 cerr << Msg2;
944}
945
946void PMDataManager::dumpAnalysisSetInfo(const char *Msg, Pass *P,
947 const std::vector<AnalysisID> &Set)
948 const {
949 if (PassDebugging_New >= Details && !Set.empty()) {
950 cerr << (void*)P << std::string(getDepth()*2+3, ' ') << Msg << " Analyses:";
951 for (unsigned i = 0; i != Set.size(); ++i) {
952 if (i) cerr << ",";
953 cerr << " " << Set[i]->getPassName();
954 }
955 cerr << "\n";
956 }
957}
Devang Patel9bdf7d42006-12-08 23:28:54 +0000958
959//===----------------------------------------------------------------------===//
960// NOTE: Is this the right place to define this method ?
961// getAnalysisToUpdate - Return an analysis result or null if it doesn't exist
962Pass *AnalysisResolver_New::getAnalysisToUpdate(AnalysisID ID, bool dir) const {
963 return PM.findAnalysisPass(ID, dir);
964}
965
Devang Patela1514cb2006-12-07 19:39:39 +0000966//===----------------------------------------------------------------------===//
Devang Patelb67904d2006-12-13 02:36:01 +0000967// BasicBlockPassManager implementation
Devang Patel6e5a1132006-11-07 21:31:57 +0000968
Devang Pateld65e9e92006-11-08 01:31:28 +0000969/// Add pass P into PassVector and return true. If this pass is not
970/// manageable by this manager then return false.
Devang Patel6e5a1132006-11-07 21:31:57 +0000971bool
Devang Patelb67904d2006-12-13 02:36:01 +0000972BasicBlockPassManager::addPass(Pass *P) {
Devang Patel6e5a1132006-11-07 21:31:57 +0000973
974 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
975 if (!BP)
976 return false;
977
Devang Patel3c8eb622006-11-07 22:56:50 +0000978 // If this pass does not preserve anlysis that is used by other passes
979 // managed by this manager than it is not a suiable pass for this manager.
Devang Pateld65e9e92006-11-08 01:31:28 +0000980 if (!manageablePass(P))
Devang Patel3c8eb622006-11-07 22:56:50 +0000981 return false;
982
Chris Lattnerce22ca32006-12-14 18:22:14 +0000983 addPassToManager(BP);
Devang Patel349170f2006-11-11 01:24:55 +0000984
Devang Patel6e5a1132006-11-07 21:31:57 +0000985 return true;
986}
987
988/// Execute all of the passes scheduled for execution by invoking
989/// runOnBasicBlock method. Keep track of whether any of the passes modifies
990/// the function, and if so, return true.
991bool
Devang Patelb67904d2006-12-13 02:36:01 +0000992BasicBlockPassManager::runOnFunction(Function &F) {
Devang Patel6e5a1132006-11-07 21:31:57 +0000993
Devang Patel745a6962006-12-12 23:15:28 +0000994 if (F.isExternal())
995 return false;
996
Devang Patele9585592006-12-08 01:38:28 +0000997 bool Changed = doInitialization(F);
Devang Patela6b6dcb2006-12-07 18:41:09 +0000998 initializeAnalysisInfo();
Devang Patel050ec722006-11-14 01:23:29 +0000999
Devang Patel93a197c2006-12-14 00:08:04 +00001000 std::string Msg1 = "Executing Pass '";
1001 std::string Msg3 = "' Made Modification '";
1002
Devang Patel6e5a1132006-11-07 21:31:57 +00001003 for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
Devang Patel8cad70d2006-11-11 01:51:02 +00001004 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1005 e = passVectorEnd(); itr != e; ++itr) {
Devang Patel6e5a1132006-11-07 21:31:57 +00001006 Pass *P = *itr;
Devang Patelf6d1d212006-12-14 00:25:06 +00001007 AnalysisUsage AnUsage;
1008 P->getAnalysisUsage(AnUsage);
1009
Devang Patel200d3052006-12-13 23:50:44 +00001010 std::string Msg2 = "' on BasicBlock '" + (*I).getName() + "'...\n";
1011 dumpPassInfo(P, Msg1, Msg2);
Devang Patelf6d1d212006-12-14 00:25:06 +00001012 dumpAnalysisSetInfo("Required", P, AnUsage.getRequiredSet());
1013
Devang Patel47d7df72006-12-12 23:13:09 +00001014 initializeAnalysisImpl(P);
Devang Patel93a197c2006-12-14 00:08:04 +00001015
Devang Patel6e5a1132006-11-07 21:31:57 +00001016 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
Devang Patelb8817b92006-12-14 00:59:42 +00001017 if (TheTimeInfo) TheTimeInfo->passStarted(P);
Devang Patel6e5a1132006-11-07 21:31:57 +00001018 Changed |= BP->runOnBasicBlock(*I);
Devang Patelb8817b92006-12-14 00:59:42 +00001019 if (TheTimeInfo) TheTimeInfo->passEnded(P);
Devang Patel93a197c2006-12-14 00:08:04 +00001020
1021 if (Changed)
1022 dumpPassInfo(P, Msg3, Msg2);
Devang Patelf6d1d212006-12-14 00:25:06 +00001023 dumpAnalysisSetInfo("Preserved", P, AnUsage.getPreservedSet());
Devang Patel93a197c2006-12-14 00:08:04 +00001024
Devang Patel050ec722006-11-14 01:23:29 +00001025 removeNotPreservedAnalysis(P);
Devang Patel17bff0d2006-12-07 22:09:36 +00001026 recordAvailableAnalysis(P);
Devang Patel200d3052006-12-13 23:50:44 +00001027 removeDeadPasses(P, Msg2);
Devang Patel6e5a1132006-11-07 21:31:57 +00001028 }
Devang Patele9585592006-12-08 01:38:28 +00001029 return Changed | doFinalization(F);
Devang Patel6e5a1132006-11-07 21:31:57 +00001030}
1031
Devang Patel475c4532006-12-08 00:59:05 +00001032// Implement doInitialization and doFinalization
Devang Patelb67904d2006-12-13 02:36:01 +00001033inline bool BasicBlockPassManager::doInitialization(Module &M) {
Devang Patel475c4532006-12-08 00:59:05 +00001034 bool Changed = false;
1035
1036 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1037 e = passVectorEnd(); itr != e; ++itr) {
1038 Pass *P = *itr;
1039 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
1040 Changed |= BP->doInitialization(M);
1041 }
1042
1043 return Changed;
1044}
1045
Devang Patelb67904d2006-12-13 02:36:01 +00001046inline bool BasicBlockPassManager::doFinalization(Module &M) {
Devang Patel475c4532006-12-08 00:59:05 +00001047 bool Changed = false;
1048
1049 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1050 e = passVectorEnd(); itr != e; ++itr) {
1051 Pass *P = *itr;
1052 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
1053 Changed |= BP->doFinalization(M);
1054 }
1055
1056 return Changed;
1057}
1058
Devang Patelb67904d2006-12-13 02:36:01 +00001059inline bool BasicBlockPassManager::doInitialization(Function &F) {
Devang Patel475c4532006-12-08 00:59:05 +00001060 bool Changed = false;
1061
1062 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1063 e = passVectorEnd(); itr != e; ++itr) {
1064 Pass *P = *itr;
1065 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
1066 Changed |= BP->doInitialization(F);
1067 }
1068
1069 return Changed;
1070}
1071
Devang Patelb67904d2006-12-13 02:36:01 +00001072inline bool BasicBlockPassManager::doFinalization(Function &F) {
Devang Patel475c4532006-12-08 00:59:05 +00001073 bool Changed = false;
1074
1075 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1076 e = passVectorEnd(); itr != e; ++itr) {
1077 Pass *P = *itr;
1078 BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
1079 Changed |= BP->doFinalization(F);
1080 }
1081
1082 return Changed;
1083}
1084
1085
Devang Patela1514cb2006-12-07 19:39:39 +00001086//===----------------------------------------------------------------------===//
Devang Patelb67904d2006-12-13 02:36:01 +00001087// FunctionPassManager implementation
Devang Patela1514cb2006-12-07 19:39:39 +00001088
Devang Patel4e12f862006-11-08 10:44:40 +00001089/// Create new Function pass manager
Devang Patelb67904d2006-12-13 02:36:01 +00001090FunctionPassManager::FunctionPassManager(ModuleProvider *P) {
Devang Patel1f653682006-12-08 18:57:16 +00001091 FPM = new FunctionPassManagerImpl_New(0);
Devang Patel9c6290c2006-12-12 22:02:16 +00001092 // FPM is the top level manager.
1093 FPM->setTopLevelManager(FPM);
Devang Patel1036b652006-12-12 23:27:37 +00001094
1095 PMDataManager *PMD = dynamic_cast<PMDataManager *>(FPM);
1096 AnalysisResolver_New *AR = new AnalysisResolver_New(*PMD);
1097 FPM->setResolver(AR);
1098
1099 FPM->addPassManager(FPM);
Devang Patel1f653682006-12-08 18:57:16 +00001100 MP = P;
1101}
1102
Devang Patelb67904d2006-12-13 02:36:01 +00001103FunctionPassManager::~FunctionPassManager() {
1104 // Note : FPM maintains one entry in PassManagers vector.
1105 // This one entry is FPM itself. This is not ideal. One
1106 // alternative is have one additional layer between
1107 // FunctionPassManager and FunctionPassManagerImpl.
1108 // Meanwhile, to avoid going into infinte loop, first
1109 // remove FPM from its PassMangers vector.
1110 FPM->clearManagers();
Devang Patelab97cf42006-12-13 00:09:23 +00001111 delete FPM;
1112}
1113
Devang Patel4e12f862006-11-08 10:44:40 +00001114/// add - Add a pass to the queue of passes to run. This passes
1115/// ownership of the Pass to the PassManager. When the
1116/// PassManager_X is destroyed, the pass will be destroyed as well, so
1117/// there is no need to delete the pass. (TODO delete passes.)
1118/// This implies that all passes MUST be allocated with 'new'.
Devang Patelb67904d2006-12-13 02:36:01 +00001119void FunctionPassManager::add(Pass *P) {
Devang Patel4e12f862006-11-08 10:44:40 +00001120 FPM->add(P);
1121}
1122
Devang Patel9f3083e2006-11-15 19:39:54 +00001123/// run - Execute all of the passes scheduled for execution. Keep
1124/// track of whether any of the passes modifies the function, and if
1125/// so, return true.
1126///
Devang Patelb67904d2006-12-13 02:36:01 +00001127bool FunctionPassManager::run(Function &F) {
Devang Patel9f3083e2006-11-15 19:39:54 +00001128 std::string errstr;
1129 if (MP->materializeFunction(&F, &errstr)) {
Bill Wendlingf3baad32006-12-07 01:30:32 +00001130 cerr << "Error reading bytecode file: " << errstr << "\n";
Devang Patel9f3083e2006-11-15 19:39:54 +00001131 abort();
1132 }
Devang Patel272908d2006-12-08 22:57:48 +00001133 return FPM->run(F);
Devang Patel9f3083e2006-11-15 19:39:54 +00001134}
1135
1136
Devang Patelff631ae2006-11-15 01:27:05 +00001137/// doInitialization - Run all of the initializers for the function passes.
1138///
Devang Patelb67904d2006-12-13 02:36:01 +00001139bool FunctionPassManager::doInitialization() {
Devang Patelff631ae2006-11-15 01:27:05 +00001140 return FPM->doInitialization(*MP->getModule());
1141}
1142
1143/// doFinalization - Run all of the initializers for the function passes.
1144///
Devang Patelb67904d2006-12-13 02:36:01 +00001145bool FunctionPassManager::doFinalization() {
Devang Patelff631ae2006-11-15 01:27:05 +00001146 return FPM->doFinalization(*MP->getModule());
1147}
1148
Devang Patela1514cb2006-12-07 19:39:39 +00001149//===----------------------------------------------------------------------===//
Devang Patel4e12f862006-11-08 10:44:40 +00001150// FunctionPassManagerImpl_New implementation
Devang Patel0c2012f2006-11-07 21:49:50 +00001151
Devang Patel0c2012f2006-11-07 21:49:50 +00001152/// Add pass P into the pass manager queue. If P is a BasicBlockPass then
1153/// either use it into active basic block pass manager or create new basic
1154/// block pass manager to handle pass P.
1155bool
Devang Patel4e12f862006-11-08 10:44:40 +00001156FunctionPassManagerImpl_New::addPass(Pass *P) {
Devang Patel0c2012f2006-11-07 21:49:50 +00001157
Devang Patelb67904d2006-12-13 02:36:01 +00001158 // If P is a BasicBlockPass then use BasicBlockPassManager.
Devang Patel0c2012f2006-11-07 21:49:50 +00001159 if (BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P)) {
1160
Devang Patel4949fe02006-12-07 22:34:21 +00001161 if (!activeBBPassManager || !activeBBPassManager->addPass(BP)) {
Devang Patel0c2012f2006-11-07 21:49:50 +00001162
Devang Patel4949fe02006-12-07 22:34:21 +00001163 // If active manager exists then clear its analysis info.
1164 if (activeBBPassManager)
1165 activeBBPassManager->initializeAnalysisInfo();
Devang Patel642c1432006-12-07 21:58:50 +00001166
Devang Patel4949fe02006-12-07 22:34:21 +00001167 // Create and add new manager
Devang Patel4c36e6b2006-12-07 23:24:58 +00001168 activeBBPassManager =
Devang Patelb67904d2006-12-13 02:36:01 +00001169 new BasicBlockPassManager(getDepth() + 1);
Devang Patel9c6290c2006-12-12 22:02:16 +00001170 // Inherit top level manager
1171 activeBBPassManager->setTopLevelManager(this->getTopLevelManager());
Devang Patelafb1f3622006-12-12 22:35:25 +00001172
1173 // Add new manager into current manager's list.
Devang Patel90b05e02006-11-11 02:04:19 +00001174 addPassToManager(activeBBPassManager, false);
Devang Patelafb1f3622006-12-12 22:35:25 +00001175
1176 // Add new manager into top level manager's indirect passes list
1177 PMDataManager *PMD = dynamic_cast<PMDataManager *>(activeBBPassManager);
1178 assert (PMD && "Manager is not Pass Manager");
1179 TPM->addIndirectPassManager(PMD);
Devang Patel4949fe02006-12-07 22:34:21 +00001180
1181 // Add pass into new manager. This time it must succeed.
Devang Pateld65e9e92006-11-08 01:31:28 +00001182 if (!activeBBPassManager->addPass(BP))
1183 assert(0 && "Unable to add Pass");
Devang Patel832bc072006-12-15 00:08:26 +00001184
1185 // If activeBBPassManager transfered any Last Uses then handle them here.
1186 std::vector<Pass *> &TLU = activeBBPassManager->getTransferredLastUses();
1187 if (!TLU.empty())
1188 TPM->setLastUser(TLU, this);
1189
Devang Patel0c2012f2006-11-07 21:49:50 +00001190 }
Devang Patelbc03f132006-12-07 23:55:10 +00001191
Devang Patelbc03f132006-12-07 23:55:10 +00001192
Devang Patel0c2012f2006-11-07 21:49:50 +00001193 return true;
1194 }
1195
1196 FunctionPass *FP = dynamic_cast<FunctionPass *>(P);
1197 if (!FP)
1198 return false;
1199
Devang Patel3c8eb622006-11-07 22:56:50 +00001200 // If this pass does not preserve anlysis that is used by other passes
1201 // managed by this manager than it is not a suiable pass for this manager.
Devang Pateld65e9e92006-11-08 01:31:28 +00001202 if (!manageablePass(P))
Devang Patel3c8eb622006-11-07 22:56:50 +00001203 return false;
1204
Devang Patel8cad70d2006-11-11 01:51:02 +00001205 addPassToManager (FP);
Devang Patel4949fe02006-12-07 22:34:21 +00001206
1207 // If active manager exists then clear its analysis info.
1208 if (activeBBPassManager) {
1209 activeBBPassManager->initializeAnalysisInfo();
1210 activeBBPassManager = NULL;
1211 }
1212
Devang Patel0c2012f2006-11-07 21:49:50 +00001213 return true;
1214}
1215
1216/// 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.
Devang Patel9f3083e2006-11-15 19:39:54 +00001219bool FunctionPassManagerImpl_New::runOnModule(Module &M) {
Devang Patel0c2012f2006-11-07 21:49:50 +00001220
Devang Patel0e29e292006-12-08 19:04:09 +00001221 bool Changed = doInitialization(M);
Devang Patela6b6dcb2006-12-07 18:41:09 +00001222 initializeAnalysisInfo();
Devang Patel050ec722006-11-14 01:23:29 +00001223
Devang Patel0c2012f2006-11-07 21:49:50 +00001224 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
Devang Patel19290892006-12-08 19:03:05 +00001225 this->runOnFunction(*I);
1226
Devang Patel0e29e292006-12-08 19:04:09 +00001227 return Changed | doFinalization(M);
Devang Patel0c2012f2006-11-07 21:49:50 +00001228}
1229
Devang Patel9f3083e2006-11-15 19:39:54 +00001230/// Execute all of the passes scheduled for execution by invoking
1231/// runOnFunction method. Keep track of whether any of the passes modifies
1232/// the function, and if so, return true.
1233bool FunctionPassManagerImpl_New::runOnFunction(Function &F) {
1234
1235 bool Changed = false;
Devang Patel745a6962006-12-12 23:15:28 +00001236
1237 if (F.isExternal())
1238 return false;
1239
Devang Patela6b6dcb2006-12-07 18:41:09 +00001240 initializeAnalysisInfo();
Devang Patel9f3083e2006-11-15 19:39:54 +00001241
Devang Patel93a197c2006-12-14 00:08:04 +00001242 std::string Msg1 = "Executing Pass '";
1243 std::string Msg3 = "' Made Modification '";
1244
Devang Patel9f3083e2006-11-15 19:39:54 +00001245 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1246 e = passVectorEnd(); itr != e; ++itr) {
1247 Pass *P = *itr;
Devang Patelf6d1d212006-12-14 00:25:06 +00001248 AnalysisUsage AnUsage;
1249 P->getAnalysisUsage(AnUsage);
Devang Patel93a197c2006-12-14 00:08:04 +00001250
Devang Patel200d3052006-12-13 23:50:44 +00001251 std::string Msg2 = "' on Function '" + F.getName() + "'...\n";
1252 dumpPassInfo(P, Msg1, Msg2);
Devang Patelf6d1d212006-12-14 00:25:06 +00001253 dumpAnalysisSetInfo("Required", P, AnUsage.getRequiredSet());
Devang Patel93a197c2006-12-14 00:08:04 +00001254
Devang Patel47d7df72006-12-12 23:13:09 +00001255 initializeAnalysisImpl(P);
Devang Patel9f3083e2006-11-15 19:39:54 +00001256 FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
Devang Patelb8817b92006-12-14 00:59:42 +00001257
1258 if (TheTimeInfo) TheTimeInfo->passStarted(P);
Devang Patel9f3083e2006-11-15 19:39:54 +00001259 Changed |= FP->runOnFunction(F);
Devang Patelb8817b92006-12-14 00:59:42 +00001260 if (TheTimeInfo) TheTimeInfo->passEnded(P);
Devang Patel93a197c2006-12-14 00:08:04 +00001261
1262 if (Changed)
1263 dumpPassInfo(P, Msg3, Msg2);
Devang Patelf6d1d212006-12-14 00:25:06 +00001264 dumpAnalysisSetInfo("Preserved", P, AnUsage.getPreservedSet());
Devang Patel93a197c2006-12-14 00:08:04 +00001265
Devang Patel9f3083e2006-11-15 19:39:54 +00001266 removeNotPreservedAnalysis(P);
Devang Patel17bff0d2006-12-07 22:09:36 +00001267 recordAvailableAnalysis(P);
Devang Patel200d3052006-12-13 23:50:44 +00001268 removeDeadPasses(P, Msg2);
Devang Patel9f3083e2006-11-15 19:39:54 +00001269 }
1270 return Changed;
1271}
1272
1273
Devang Patelff631ae2006-11-15 01:27:05 +00001274inline bool FunctionPassManagerImpl_New::doInitialization(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->doInitialization(M);
1283 }
1284
1285 return Changed;
1286}
1287
1288inline bool FunctionPassManagerImpl_New::doFinalization(Module &M) {
1289 bool Changed = false;
1290
1291 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1292 e = passVectorEnd(); itr != e; ++itr) {
1293 Pass *P = *itr;
1294
1295 FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
1296 Changed |= FP->doFinalization(M);
1297 }
1298
Devang Patelff631ae2006-11-15 01:27:05 +00001299 return Changed;
1300}
1301
Devang Patel272908d2006-12-08 22:57:48 +00001302// Execute all the passes managed by this top level manager.
1303// Return true if any function is modified by a pass.
1304bool FunctionPassManagerImpl_New::run(Function &F) {
1305
1306 bool Changed = false;
1307 for (std::vector<Pass *>::iterator I = passManagersBegin(),
1308 E = passManagersEnd(); I != E; ++I) {
Devang Patelb67904d2006-12-13 02:36:01 +00001309 FunctionPassManagerImpl_New *FP =
1310 dynamic_cast<FunctionPassManagerImpl_New *>(*I);
Devang Patel272908d2006-12-08 22:57:48 +00001311 Changed |= FP->runOnFunction(F);
1312 }
1313 return Changed;
1314}
1315
Devang Patela1514cb2006-12-07 19:39:39 +00001316//===----------------------------------------------------------------------===//
Devang Patel05e1a972006-11-07 22:03:15 +00001317// ModulePassManager implementation
1318
1319/// Add P into pass vector if it is manageble. If P is a FunctionPass
Devang Patel4e12f862006-11-08 10:44:40 +00001320/// then use FunctionPassManagerImpl_New to manage it. Return false if P
Devang Patel05e1a972006-11-07 22:03:15 +00001321/// is not manageable by this manager.
1322bool
Devang Patelb67904d2006-12-13 02:36:01 +00001323ModulePassManager::addPass(Pass *P) {
Devang Patel05e1a972006-11-07 22:03:15 +00001324
1325 // If P is FunctionPass then use function pass maanager.
1326 if (FunctionPass *FP = dynamic_cast<FunctionPass*>(P)) {
1327
Devang Patel640c5bb2006-12-08 22:30:11 +00001328 if (!activeFunctionPassManager || !activeFunctionPassManager->addPass(P)) {
Devang Patel05e1a972006-11-07 22:03:15 +00001329
Devang Patel4949fe02006-12-07 22:34:21 +00001330 // If active manager exists then clear its analysis info.
1331 if (activeFunctionPassManager)
1332 activeFunctionPassManager->initializeAnalysisInfo();
Devang Patel642c1432006-12-07 21:58:50 +00001333
Devang Patel4949fe02006-12-07 22:34:21 +00001334 // Create and add new manager
Devang Patel4c36e6b2006-12-07 23:24:58 +00001335 activeFunctionPassManager =
1336 new FunctionPassManagerImpl_New(getDepth() + 1);
Devang Patelafb1f3622006-12-12 22:35:25 +00001337
1338 // Add new manager into current manager's list
Devang Patel90b05e02006-11-11 02:04:19 +00001339 addPassToManager(activeFunctionPassManager, false);
Devang Patelafb1f3622006-12-12 22:35:25 +00001340
Devang Patel9c6290c2006-12-12 22:02:16 +00001341 // Inherit top level manager
1342 activeFunctionPassManager->setTopLevelManager(this->getTopLevelManager());
Devang Patelafb1f3622006-12-12 22:35:25 +00001343
1344 // Add new manager into top level manager's indirect passes list
Chris Lattnerf0f611a2006-12-13 21:56:10 +00001345 PMDataManager *PMD =
1346 dynamic_cast<PMDataManager *>(activeFunctionPassManager);
1347 assert(PMD && "Manager is not Pass Manager");
Devang Patelafb1f3622006-12-12 22:35:25 +00001348 TPM->addIndirectPassManager(PMD);
Devang Patelaf1fca52006-12-08 23:11:43 +00001349
Devang Patel4949fe02006-12-07 22:34:21 +00001350 // Add pass into new manager. This time it must succeed.
Devang Pateld65e9e92006-11-08 01:31:28 +00001351 if (!activeFunctionPassManager->addPass(FP))
1352 assert(0 && "Unable to add pass");
Devang Patelbc03f132006-12-07 23:55:10 +00001353
Devang Patel832bc072006-12-15 00:08:26 +00001354 // If activeFunctionPassManager transfered any Last Uses then
1355 // handle them here.
1356 std::vector<Pass *> &TLU =
1357 activeFunctionPassManager->getTransferredLastUses();
1358 if (!TLU.empty())
1359 TPM->setLastUser(TLU, this);
1360 }
Devang Patelbc03f132006-12-07 23:55:10 +00001361
Devang Patel05e1a972006-11-07 22:03:15 +00001362 return true;
1363 }
1364
1365 ModulePass *MP = dynamic_cast<ModulePass *>(P);
1366 if (!MP)
1367 return false;
1368
Devang Patel3c8eb622006-11-07 22:56:50 +00001369 // If this pass does not preserve anlysis that is used by other passes
1370 // managed by this manager than it is not a suiable pass for this manager.
Devang Pateld65e9e92006-11-08 01:31:28 +00001371 if (!manageablePass(P))
Devang Patel3c8eb622006-11-07 22:56:50 +00001372 return false;
1373
Devang Patel8cad70d2006-11-11 01:51:02 +00001374 addPassToManager(MP);
Devang Patel4949fe02006-12-07 22:34:21 +00001375 // If active manager exists then clear its analysis info.
1376 if (activeFunctionPassManager) {
1377 activeFunctionPassManager->initializeAnalysisInfo();
1378 activeFunctionPassManager = NULL;
1379 }
1380
Devang Patel05e1a972006-11-07 22:03:15 +00001381 return true;
1382}
1383
1384
1385/// Execute all of the passes scheduled for execution by invoking
1386/// runOnModule method. Keep track of whether any of the passes modifies
1387/// the module, and if so, return true.
1388bool
Devang Patelb67904d2006-12-13 02:36:01 +00001389ModulePassManager::runOnModule(Module &M) {
Devang Patel05e1a972006-11-07 22:03:15 +00001390 bool Changed = false;
Devang Patela6b6dcb2006-12-07 18:41:09 +00001391 initializeAnalysisInfo();
Devang Patel050ec722006-11-14 01:23:29 +00001392
Devang Patel93a197c2006-12-14 00:08:04 +00001393 std::string Msg1 = "Executing Pass '";
1394 std::string Msg3 = "' Made Modification '";
1395
Devang Patel8cad70d2006-11-11 01:51:02 +00001396 for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1397 e = passVectorEnd(); itr != e; ++itr) {
Devang Patel05e1a972006-11-07 22:03:15 +00001398 Pass *P = *itr;
Devang Patelf6d1d212006-12-14 00:25:06 +00001399 AnalysisUsage AnUsage;
1400 P->getAnalysisUsage(AnUsage);
Devang Patel93a197c2006-12-14 00:08:04 +00001401
Devang Patel200d3052006-12-13 23:50:44 +00001402 std::string Msg2 = "' on Module '" + M.getModuleIdentifier() + "'...\n";
1403 dumpPassInfo(P, Msg1, Msg2);
Devang Patelf6d1d212006-12-14 00:25:06 +00001404 dumpAnalysisSetInfo("Required", P, AnUsage.getRequiredSet());
Devang Patel93a197c2006-12-14 00:08:04 +00001405
Devang Patel47d7df72006-12-12 23:13:09 +00001406 initializeAnalysisImpl(P);
Devang Patel05e1a972006-11-07 22:03:15 +00001407 ModulePass *MP = dynamic_cast<ModulePass*>(P);
Devang Patelb8817b92006-12-14 00:59:42 +00001408
1409 if (TheTimeInfo) TheTimeInfo->passStarted(P);
Devang Patel05e1a972006-11-07 22:03:15 +00001410 Changed |= MP->runOnModule(M);
Devang Patelb8817b92006-12-14 00:59:42 +00001411 if (TheTimeInfo) TheTimeInfo->passEnded(P);
Devang Patel93a197c2006-12-14 00:08:04 +00001412
1413 if (Changed)
1414 dumpPassInfo(P, Msg3, Msg2);
Devang Patelf6d1d212006-12-14 00:25:06 +00001415 dumpAnalysisSetInfo("Preserved", P, AnUsage.getPreservedSet());
1416
Devang Patel050ec722006-11-14 01:23:29 +00001417 removeNotPreservedAnalysis(P);
Devang Patel17bff0d2006-12-07 22:09:36 +00001418 recordAvailableAnalysis(P);
Devang Patel200d3052006-12-13 23:50:44 +00001419 removeDeadPasses(P, Msg2);
Devang Patel05e1a972006-11-07 22:03:15 +00001420 }
1421 return Changed;
1422}
1423
Devang Patela1514cb2006-12-07 19:39:39 +00001424//===----------------------------------------------------------------------===//
1425// PassManagerImpl implementation
Devang Patelab97cf42006-12-13 00:09:23 +00001426//
Devang Patelc290c8a2006-11-07 22:23:34 +00001427/// Add P into active pass manager or use new module pass manager to
1428/// manage it.
Devang Patel1a6eaa42006-11-11 02:22:31 +00001429bool PassManagerImpl_New::addPass(Pass *P) {
Devang Patelc290c8a2006-11-07 22:23:34 +00001430
Devang Patel6c9f5482006-11-11 00:42:16 +00001431 if (!activeManager || !activeManager->addPass(P)) {
Devang Patelb67904d2006-12-13 02:36:01 +00001432 activeManager = new ModulePassManager(getDepth() + 1);
Devang Patel9c6290c2006-12-12 22:02:16 +00001433 // Inherit top level manager
1434 activeManager->setTopLevelManager(this->getTopLevelManager());
Devang Pateld440cd92006-12-08 23:53:00 +00001435
1436 // This top level manager is going to manage activeManager.
1437 // Set up analysis resolver to connect them.
1438 AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
1439 activeManager->setResolver(AR);
1440
Devang Patel5bbeb492006-12-08 22:47:25 +00001441 addPassManager(activeManager);
Devang Patel28bbcbe2006-12-07 21:44:12 +00001442 return activeManager->addPass(P);
Devang Patelc290c8a2006-11-07 22:23:34 +00001443 }
Devang Patel28bbcbe2006-12-07 21:44:12 +00001444 return true;
Devang Patelc290c8a2006-11-07 22:23:34 +00001445}
1446
1447/// run - Execute all of the passes scheduled for execution. Keep track of
1448/// whether any of the passes modifies the module, and if so, return true.
Devang Patel1a6eaa42006-11-11 02:22:31 +00001449bool PassManagerImpl_New::run(Module &M) {
Devang Patelc290c8a2006-11-07 22:23:34 +00001450
Devang Patelc290c8a2006-11-07 22:23:34 +00001451 bool Changed = false;
Devang Patelf1567a52006-12-13 20:03:48 +00001452
Devang Patelb8817b92006-12-14 00:59:42 +00001453 TimingInfo::createTheTimeInfo();
1454
Devang Patelcfd70c42006-12-13 22:10:00 +00001455 dumpArguments();
Devang Patel03fb5872006-12-13 21:13:31 +00001456 if (PassDebugging_New >= Structure)
Devang Patelf1567a52006-12-13 20:03:48 +00001457 dumpPasses();
1458
Devang Patel5bbeb492006-12-08 22:47:25 +00001459 for (std::vector<Pass *>::iterator I = passManagersBegin(),
1460 E = passManagersEnd(); I != E; ++I) {
Devang Patelb67904d2006-12-13 02:36:01 +00001461 ModulePassManager *MP = dynamic_cast<ModulePassManager *>(*I);
Devang Patel5bbeb492006-12-08 22:47:25 +00001462 Changed |= MP->runOnModule(M);
Devang Patelc290c8a2006-11-07 22:23:34 +00001463 }
1464 return Changed;
1465}
Devang Patel376fefa2006-11-08 10:29:57 +00001466
Devang Patela1514cb2006-12-07 19:39:39 +00001467//===----------------------------------------------------------------------===//
1468// PassManager implementation
1469
Devang Patel376fefa2006-11-08 10:29:57 +00001470/// Create new pass manager
Devang Patelb67904d2006-12-13 02:36:01 +00001471PassManager::PassManager() {
Devang Patel4c36e6b2006-12-07 23:24:58 +00001472 PM = new PassManagerImpl_New(0);
Devang Patel9c6290c2006-12-12 22:02:16 +00001473 // PM is the top level manager
1474 PM->setTopLevelManager(PM);
Devang Patel376fefa2006-11-08 10:29:57 +00001475}
1476
Devang Patelb67904d2006-12-13 02:36:01 +00001477PassManager::~PassManager() {
Devang Patelab97cf42006-12-13 00:09:23 +00001478 delete PM;
1479}
1480
Devang Patel376fefa2006-11-08 10:29:57 +00001481/// add - Add a pass to the queue of passes to run. This passes ownership of
1482/// the Pass to the PassManager. When the PassManager is destroyed, the pass
1483/// will be destroyed as well, so there is no need to delete the pass. This
1484/// implies that all passes MUST be allocated with 'new'.
1485void
Devang Patelb67904d2006-12-13 02:36:01 +00001486PassManager::add(Pass *P) {
Devang Patel376fefa2006-11-08 10:29:57 +00001487 PM->add(P);
1488}
1489
1490/// run - Execute all of the passes scheduled for execution. Keep track of
1491/// whether any of the passes modifies the module, and if so, return true.
1492bool
Devang Patelb67904d2006-12-13 02:36:01 +00001493PassManager::run(Module &M) {
Devang Patel376fefa2006-11-08 10:29:57 +00001494 return PM->run(M);
1495}
1496
Devang Patelb8817b92006-12-14 00:59:42 +00001497//===----------------------------------------------------------------------===//
1498// TimingInfo Class - This class is used to calculate information about the
1499// amount of time each pass takes to execute. This only happens with
1500// -time-passes is enabled on the command line.
1501//
1502bool llvm::TimePassesIsEnabled = false;
1503static cl::opt<bool,true>
1504EnableTiming("time-passes", cl::location(TimePassesIsEnabled),
1505 cl::desc("Time each pass, printing elapsed time for each on exit"));
1506
1507// createTheTimeInfo - This method either initializes the TheTimeInfo pointer to
1508// a non null value (if the -time-passes option is enabled) or it leaves it
1509// null. It may be called multiple times.
1510void TimingInfo::createTheTimeInfo() {
1511 if (!TimePassesIsEnabled || TheTimeInfo) return;
1512
1513 // Constructed the first time this is called, iff -time-passes is enabled.
1514 // This guarantees that the object will be constructed before static globals,
1515 // thus it will be destroyed before them.
1516 static ManagedStatic<TimingInfo> TTI;
1517 TheTimeInfo = &*TTI;
1518}
1519
Devang Patelb67904d2006-12-13 02:36:01 +00001520#endif