blob: df54b06331ff1d3960f3a6f202a36f4815c4775b [file] [log] [blame]
Chris Lattnerd0e9bd12002-04-28 20:42:50 +00001//===- PassManagerT.h - Container for Passes ---------------------*- C++ -*--=//
Chris Lattner67d25652002-01-30 23:20:39 +00002//
Chris Lattnerd0e9bd12002-04-28 20:42:50 +00003// This file defines the PassManagerT class. This class is used to hold,
Chris Lattner67d25652002-01-30 23:20:39 +00004// maintain, and optimize execution of Pass's. The PassManager class ensures
5// that analysis results are available before a pass runs, and that Pass's are
6// destroyed when the PassManager is destroyed.
7//
Chris Lattnerd0e9bd12002-04-28 20:42:50 +00008// The PassManagerT template is instantiated three times to do its job. The
9// public PassManager class is a Pimpl around the PassManagerT<Module> interface
10// to avoid having all of the PassManager clients being exposed to the
11// implementation details herein.
Chris Lattner67d25652002-01-30 23:20:39 +000012//
13//===----------------------------------------------------------------------===//
14
Chris Lattnerd0e9bd12002-04-28 20:42:50 +000015#ifndef LLVM_PASSMANAGER_T_H
16#define LLVM_PASSMANAGER_T_H
Chris Lattner67d25652002-01-30 23:20:39 +000017
18#include "llvm/Pass.h"
Chris Lattner198cf422002-07-30 16:27:02 +000019#include "Support/CommandLine.h"
Chris Lattnered6504b2002-09-08 19:00:07 +000020#include "Support/LeakDetector.h"
Chris Lattnerc8e66542002-04-27 06:56:12 +000021#include <algorithm>
Chris Lattner395c27a2002-07-31 18:04:17 +000022#include <iostream>
Chris Lattnera454b5b2002-04-28 05:14:06 +000023class Annotable;
Chris Lattner67d25652002-01-30 23:20:39 +000024
Chris Lattner67d25652002-01-30 23:20:39 +000025//===----------------------------------------------------------------------===//
Chris Lattner198cf422002-07-30 16:27:02 +000026// Pass debugging information. Often it is useful to find out what pass is
27// running when a crash occurs in a utility. When this library is compiled with
28// debugging on, a command line option (--debug-pass) is enabled that causes the
29// pass name to be printed before it executes.
30//
31
32// Different debug levels that can be enabled...
33enum PassDebugLevel {
Chris Lattner1e4867f2002-07-30 19:51:02 +000034 None, Arguments, Structure, Executions, Details
Chris Lattner198cf422002-07-30 16:27:02 +000035};
36
37static cl::opt<enum PassDebugLevel>
38PassDebugging("debug-pass", cl::Hidden,
39 cl::desc("Print PassManager debugging information"),
40 cl::values(
41 clEnumVal(None , "disable debug output"),
Chris Lattner1e4867f2002-07-30 19:51:02 +000042 clEnumVal(Arguments , "print pass arguments to pass to 'opt'"),
Chris Lattner198cf422002-07-30 16:27:02 +000043 clEnumVal(Structure , "print pass structure before run()"),
44 clEnumVal(Executions, "print pass name before it is executed"),
45 clEnumVal(Details , "print pass details when it is executed"),
46 0));
47
48//===----------------------------------------------------------------------===//
Chris Lattner57d2ba32002-04-04 19:35:24 +000049// PMDebug class - a set of debugging functions, that are not to be
50// instantiated by the template.
Chris Lattner67d25652002-01-30 23:20:39 +000051//
52struct PMDebug {
Chris Lattner1e4867f2002-07-30 19:51:02 +000053 static void PerformPassStartupStuff(Pass *P) {
54 // If debugging is enabled, print out argument information...
55 if (PassDebugging >= Arguments) {
56 std::cerr << "Pass Arguments: ";
57 PrintArgumentInformation(P);
58 std::cerr << "\n";
59
60 // Print the pass execution structure
61 if (PassDebugging >= Structure)
62 P->dumpPassStructure();
63 }
Chris Lattner198cf422002-07-30 16:27:02 +000064 }
Chris Lattner1e4867f2002-07-30 19:51:02 +000065
66 static void PrintArgumentInformation(const Pass *P);
Chris Lattnera454b5b2002-04-28 05:14:06 +000067 static void PrintPassInformation(unsigned,const char*,Pass *, Annotable *);
Chris Lattnerac3e0602002-01-31 18:32:27 +000068 static void PrintAnalysisSetInfo(unsigned,const char*,Pass *P,
Chris Lattnerc8e66542002-04-27 06:56:12 +000069 const std::vector<AnalysisID> &);
Chris Lattner67d25652002-01-30 23:20:39 +000070};
71
72
Chris Lattnere2eb99e2002-04-29 04:04:29 +000073//===----------------------------------------------------------------------===//
74// TimingInfo Class - This class is used to calculate information about the
75// amount of time each pass takes to execute. This only happens when
76// -time-passes is enabled on the command line.
77//
Chris Lattner6a33d6f2002-08-01 19:33:09 +000078struct TimeRecord { // TimeRecord - Data we collect and print for each pass
79 double Elapsed; // Wall clock time elapsed in seconds
80 double UserTime; // User time elapsed
81 double SystemTime; // System time elapsed
82 unsigned long MaxRSS; // Maximum resident set size (in bytes)
83 unsigned long RSSTemp; // Temp for calculating maxrss
84
85 TimeRecord() : Elapsed(0), UserTime(0), SystemTime(0), MaxRSS(0) {}
86 void passStart(const TimeRecord &T);
87 void passEnd(const TimeRecord &T);
88 void sum(const TimeRecord &TR);
Chris Lattnere821d782002-08-20 18:47:53 +000089 bool operator<(const TimeRecord &TR) const;
Chris Lattner6a33d6f2002-08-01 19:33:09 +000090
91 void print(const char *PassName, const TimeRecord &TotalTime) const;
92};
93
Chris Lattnere2eb99e2002-04-29 04:04:29 +000094class TimingInfo {
Chris Lattner6a33d6f2002-08-01 19:33:09 +000095 std::map<Pass*, TimeRecord> TimingData;
Chris Lattnere2eb99e2002-04-29 04:04:29 +000096 TimingInfo() {} // Private ctor, must use create member
97public:
98 // Create method. If Timing is enabled, this creates and returns a new timing
99 // object, otherwise it returns null.
100 //
101 static TimingInfo *create();
102
103 // TimingDtor - Print out information about timing information
104 ~TimingInfo();
105
106 void passStarted(Pass *P);
107 void passEnded(Pass *P);
108};
109
Chris Lattner6e041bd2002-08-21 22:17:09 +0000110//===----------------------------------------------------------------------===//
Chris Lattner67d25652002-01-30 23:20:39 +0000111// Declare the PassManagerTraits which will be specialized...
112//
113template<class UnitType> class PassManagerTraits; // Do not define.
114
115
116//===----------------------------------------------------------------------===//
117// PassManagerT - Container object for passes. The PassManagerT destructor
118// deletes all passes contained inside of the PassManagerT, so you shouldn't
119// delete passes manually, and all passes should be dynamically allocated.
120//
121template<typename UnitType>
122class PassManagerT : public PassManagerTraits<UnitType>,public AnalysisResolver{
Chris Lattnere2eb99e2002-04-29 04:04:29 +0000123 typedef PassManagerTraits<UnitType> Traits;
124 typedef typename Traits::PassClass PassClass;
125 typedef typename Traits::SubPassClass SubPassClass;
126 typedef typename Traits::BatcherClass BatcherClass;
127 typedef typename Traits::ParentClass ParentClass;
Chris Lattner67d25652002-01-30 23:20:39 +0000128
Chris Lattnere2eb99e2002-04-29 04:04:29 +0000129 friend typename Traits::PassClass;
130 friend typename Traits::SubPassClass;
131 friend class Traits;
Chris Lattneree0788d2002-09-25 21:59:11 +0000132 friend class ImmutablePass;
Chris Lattner67d25652002-01-30 23:20:39 +0000133
Chris Lattner73503172002-07-29 21:03:38 +0000134 std::vector<PassClass*> Passes; // List of passes to run
Chris Lattneree0788d2002-09-25 21:59:11 +0000135 std::vector<ImmutablePass*> ImmutablePasses; // List of immutable passes
Chris Lattner67d25652002-01-30 23:20:39 +0000136
137 // The parent of this pass manager...
Chris Lattnerac3e0602002-01-31 18:32:27 +0000138 ParentClass * const Parent;
Chris Lattner67d25652002-01-30 23:20:39 +0000139
140 // The current batcher if one is in use, or null
141 BatcherClass *Batcher;
142
143 // CurrentAnalyses - As the passes are being run, this map contains the
144 // analyses that are available to the current pass for use. This is accessed
145 // through the getAnalysis() function in this class and in Pass.
146 //
147 std::map<AnalysisID, Pass*> CurrentAnalyses;
148
Chris Lattnerac3e0602002-01-31 18:32:27 +0000149 // LastUseOf - This map keeps track of the last usage in our pipeline of a
150 // particular pass. When executing passes, the memory for .first is free'd
151 // after .second is run.
152 //
153 std::map<Pass*, Pass*> LastUseOf;
154
Chris Lattner67d25652002-01-30 23:20:39 +0000155public:
156 PassManagerT(ParentClass *Par = 0) : Parent(Par), Batcher(0) {}
157 ~PassManagerT() {
158 // Delete all of the contained passes...
Chris Lattnera82ee2d2002-07-24 22:08:53 +0000159 for (typename std::vector<PassClass*>::iterator
160 I = Passes.begin(), E = Passes.end(); I != E; ++I)
Chris Lattner67d25652002-01-30 23:20:39 +0000161 delete *I;
Chris Lattneree0788d2002-09-25 21:59:11 +0000162
163 for (std::vector<ImmutablePass*>::iterator
164 I = ImmutablePasses.begin(), E = ImmutablePasses.end(); I != E; ++I)
165 delete *I;
Chris Lattner67d25652002-01-30 23:20:39 +0000166 }
167
168 // run - Run all of the queued passes on the specified module in an optimal
169 // way.
170 virtual bool runOnUnit(UnitType *M) {
171 bool MadeChanges = false;
172 closeBatcher();
173 CurrentAnalyses.clear();
174
Chris Lattneree0788d2002-09-25 21:59:11 +0000175 // Add any immutable passes to the CurrentAnalyses set...
176 for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i)
177 if (const PassInfo *PI = ImmutablePasses[i]->getPassInfo()) {
178 CurrentAnalyses[PI] = ImmutablePasses[i];
179
180 const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
181 for (unsigned i = 0, e = II.size(); i != e; ++i)
182 CurrentAnalyses[II[i]] = ImmutablePasses[i];
183 }
184
185
Chris Lattnerac3e0602002-01-31 18:32:27 +0000186 // LastUserOf - This contains the inverted LastUseOfMap...
187 std::map<Pass *, std::vector<Pass*> > LastUserOf;
188 for (std::map<Pass*, Pass*>::iterator I = LastUseOf.begin(),
189 E = LastUseOf.end(); I != E; ++I)
190 LastUserOf[I->second].push_back(I->first);
191
192
Chris Lattner67d25652002-01-30 23:20:39 +0000193 // Output debug information...
Chris Lattner1e4867f2002-07-30 19:51:02 +0000194 if (Parent == 0) PMDebug::PerformPassStartupStuff(this);
Chris Lattner67d25652002-01-30 23:20:39 +0000195
196 // Run all of the passes
197 for (unsigned i = 0, e = Passes.size(); i < e; ++i) {
198 PassClass *P = Passes[i];
199
Chris Lattnera454b5b2002-04-28 05:14:06 +0000200 PMDebug::PrintPassInformation(getDepth(), "Executing Pass", P,
201 (Annotable*)M);
Chris Lattner67d25652002-01-30 23:20:39 +0000202
203 // Get information about what analyses the pass uses...
Chris Lattnerc8e66542002-04-27 06:56:12 +0000204 AnalysisUsage AnUsage;
205 P->getAnalysisUsage(AnUsage);
206 PMDebug::PrintAnalysisSetInfo(getDepth(), "Required", P,
207 AnUsage.getRequiredSet());
Chris Lattner67d25652002-01-30 23:20:39 +0000208
Chris Lattner216edd42002-08-30 20:25:01 +0000209 // All Required analyses should be available to the pass as it runs! Here
210 // we fill in the AnalysisImpls member of the pass so that it can
211 // successfully use the getAnalysis() method to retrieve the
212 // implementations it needs.
213 //
214 P->AnalysisImpls.clear();
215 P->AnalysisImpls.reserve(AnUsage.getRequiredSet().size());
216 for (std::vector<const PassInfo *>::const_iterator
Chris Lattnerc8e66542002-04-27 06:56:12 +0000217 I = AnUsage.getRequiredSet().begin(),
218 E = AnUsage.getRequiredSet().end(); I != E; ++I) {
Chris Lattner216edd42002-08-30 20:25:01 +0000219 Pass *Impl = getAnalysisOrNullUp(*I);
220 if (Impl == 0) {
221 std::cerr << "Analysis '" << (*I)->getPassName()
222 << "' used but not available!";
223 assert(0 && "Analysis used but not available!");
224 } else if (PassDebugging == Details) {
225 if ((*I)->getPassName() != std::string(Impl->getPassName()))
226 std::cerr << " Interface '" << (*I)->getPassName()
227 << "' implemented by '" << Impl->getPassName() << "'\n";
228 }
229 P->AnalysisImpls.push_back(std::make_pair(*I, Impl));
Chris Lattner67d25652002-01-30 23:20:39 +0000230 }
Chris Lattner67d25652002-01-30 23:20:39 +0000231
232 // Run the sub pass!
Chris Lattnere2eb99e2002-04-29 04:04:29 +0000233 startPass(P);
234 bool Changed = runPass(P, M);
235 endPass(P);
Chris Lattnerf2f31bd2002-02-01 04:53:36 +0000236 MadeChanges |= Changed;
Chris Lattner67d25652002-01-30 23:20:39 +0000237
Chris Lattnered6504b2002-09-08 19:00:07 +0000238 // Check for memory leaks by the pass...
239 LeakDetector::checkForGarbage(std::string("after running pass '") +
240 P->getPassName() + "'");
241
Chris Lattnerf2f31bd2002-02-01 04:53:36 +0000242 if (Changed)
243 PMDebug::PrintPassInformation(getDepth()+1, "Made Modification", P,
Chris Lattnera454b5b2002-04-28 05:14:06 +0000244 (Annotable*)M);
Chris Lattnerc8e66542002-04-27 06:56:12 +0000245 PMDebug::PrintAnalysisSetInfo(getDepth(), "Preserved", P,
246 AnUsage.getPreservedSet());
Chris Lattner67d25652002-01-30 23:20:39 +0000247
Chris Lattnerc8e66542002-04-27 06:56:12 +0000248
249 // Erase all analyses not in the preserved set...
250 if (!AnUsage.preservesAll()) {
251 const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
252 for (std::map<AnalysisID, Pass*>::iterator I = CurrentAnalyses.begin(),
253 E = CurrentAnalyses.end(); I != E; )
254 if (std::find(PreservedSet.begin(), PreservedSet.end(), I->first) !=
255 PreservedSet.end())
256 ++I; // This analysis is preserved, leave it in the available set...
257 else {
Chris Lattneree0788d2002-09-25 21:59:11 +0000258 if (!dynamic_cast<ImmutablePass*>(I->second)) {
Chris Lattnerc8e66542002-04-27 06:56:12 +0000259#if MAP_DOESNT_HAVE_BROKEN_ERASE_MEMBER
Chris Lattneree0788d2002-09-25 21:59:11 +0000260 I = CurrentAnalyses.erase(I); // Analysis not preserved!
Chris Lattnerc8e66542002-04-27 06:56:12 +0000261#else
Chris Lattneree0788d2002-09-25 21:59:11 +0000262 // GCC 2.95.3 STL doesn't have correct erase member!
263 CurrentAnalyses.erase(I);
264 I = CurrentAnalyses.begin();
Chris Lattnerc8e66542002-04-27 06:56:12 +0000265#endif
Chris Lattneree0788d2002-09-25 21:59:11 +0000266 } else {
267 ++I;
268 }
Chris Lattnerc8e66542002-04-27 06:56:12 +0000269 }
270 }
271
Chris Lattner73503172002-07-29 21:03:38 +0000272 // Add the current pass to the set of passes that have been run, and are
273 // thus available to users.
274 //
Chris Lattner216edd42002-08-30 20:25:01 +0000275 if (const PassInfo *PI = P->getPassInfo()) {
Chris Lattner73503172002-07-29 21:03:38 +0000276 CurrentAnalyses[PI] = P;
Chris Lattnerac3e0602002-01-31 18:32:27 +0000277
Chris Lattner216edd42002-08-30 20:25:01 +0000278 // This pass is the current implementation of all of the interfaces it
279 // implements as well.
280 //
281 const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
282 for (unsigned i = 0, e = II.size(); i != e; ++i)
283 CurrentAnalyses[II[i]] = P;
284 }
285
Chris Lattnerac3e0602002-01-31 18:32:27 +0000286 // Free memory for any passes that we are the last use of...
287 std::vector<Pass*> &DeadPass = LastUserOf[P];
288 for (std::vector<Pass*>::iterator I = DeadPass.begin(),E = DeadPass.end();
289 I != E; ++I) {
290 PMDebug::PrintPassInformation(getDepth()+1, "Freeing Pass", *I,
Chris Lattnera454b5b2002-04-28 05:14:06 +0000291 (Annotable*)M);
Chris Lattnerac3e0602002-01-31 18:32:27 +0000292 (*I)->releaseMemory();
293 }
Chris Lattner67d25652002-01-30 23:20:39 +0000294 }
295 return MadeChanges;
296 }
297
Chris Lattnerac3e0602002-01-31 18:32:27 +0000298 // dumpPassStructure - Implement the -debug-passes=PassStructure option
299 virtual void dumpPassStructure(unsigned Offset = 0) {
300 std::cerr << std::string(Offset*2, ' ') << Traits::getPMName()
301 << " Pass Manager\n";
Chris Lattnera82ee2d2002-07-24 22:08:53 +0000302 for (typename std::vector<PassClass*>::iterator
303 I = Passes.begin(), E = Passes.end(); I != E; ++I) {
Chris Lattnerac3e0602002-01-31 18:32:27 +0000304 PassClass *P = *I;
305 P->dumpPassStructure(Offset+1);
306
307 // Loop through and see which classes are destroyed after this one...
308 for (std::map<Pass*, Pass*>::iterator I = LastUseOf.begin(),
309 E = LastUseOf.end(); I != E; ++I) {
310 if (P == I->second) {
Chris Lattner73503172002-07-29 21:03:38 +0000311 std::cerr << "--" << std::string(Offset*2, ' ');
Chris Lattnerac3e0602002-01-31 18:32:27 +0000312 I->first->dumpPassStructure(0);
313 }
314 }
315 }
316 }
Chris Lattnerac3e0602002-01-31 18:32:27 +0000317
Chris Lattner6e041bd2002-08-21 22:17:09 +0000318 Pass *getAnalysisOrNullDown(const PassInfo *ID) const {
Chris Lattner216edd42002-08-30 20:25:01 +0000319 std::map<AnalysisID, Pass*>::const_iterator I = CurrentAnalyses.find(ID);
Chris Lattner6e041bd2002-08-21 22:17:09 +0000320
321 if (I != CurrentAnalyses.end())
322 return I->second; // Found it.
323
324 if (Batcher)
325 return ((AnalysisResolver*)Batcher)->getAnalysisOrNullDown(ID);
326 return 0;
Chris Lattnerac3e0602002-01-31 18:32:27 +0000327 }
328
Chris Lattner6e041bd2002-08-21 22:17:09 +0000329 Pass *getAnalysisOrNullUp(const PassInfo *ID) const {
Chris Lattner216edd42002-08-30 20:25:01 +0000330 std::map<AnalysisID, Pass*>::const_iterator I = CurrentAnalyses.find(ID);
Chris Lattner6e041bd2002-08-21 22:17:09 +0000331 if (I != CurrentAnalyses.end())
332 return I->second; // Found it.
333
334 if (Parent) // Try scanning...
335 return Parent->getAnalysisOrNullUp(ID);
336 return 0;
Chris Lattnerac3e0602002-01-31 18:32:27 +0000337 }
338
Chris Lattnere2eb99e2002-04-29 04:04:29 +0000339 // {start/end}Pass - Called when a pass is started, it just propogates
340 // information up to the top level PassManagerT object to tell it that a pass
341 // has started or ended. This is used to gather timing information about
342 // passes.
343 //
344 void startPass(Pass *P) {
345 if (Parent) Parent->startPass(P);
346 else PassStarted(P);
347 }
348 void endPass(Pass *P) {
349 if (Parent) Parent->endPass(P);
350 else PassEnded(P);
351 }
352
Chris Lattnerac3e0602002-01-31 18:32:27 +0000353 // markPassUsed - Inform higher level pass managers (and ourselves)
354 // that these analyses are being used by this pass. This is used to
355 // make sure that analyses are not free'd before we have to use
356 // them...
357 //
Chris Lattner6e041bd2002-08-21 22:17:09 +0000358 void markPassUsed(const PassInfo *P, Pass *User) {
Chris Lattner216edd42002-08-30 20:25:01 +0000359 std::map<AnalysisID, Pass*>::const_iterator I = CurrentAnalyses.find(P);
Chris Lattner6e041bd2002-08-21 22:17:09 +0000360
Chris Lattnerac3e0602002-01-31 18:32:27 +0000361 if (I != CurrentAnalyses.end()) {
362 LastUseOf[I->second] = User; // Local pass, extend the lifetime
363 } else {
364 // Pass not in current available set, must be a higher level pass
365 // available to us, propogate to parent pass manager... We tell the
366 // parent that we (the passmanager) are using the analysis so that it
367 // frees the analysis AFTER this pass manager runs.
368 //
Chris Lattneree0788d2002-09-25 21:59:11 +0000369 if (Parent) {
370 Parent->markPassUsed(P, this);
371 } else {
372 assert(0 && "Pass available but not found! "
373 "Perhaps this is a module pass requiring a function pass?");
374 }
Chris Lattnerac3e0602002-01-31 18:32:27 +0000375 }
376 }
Chris Lattneree0788d2002-09-25 21:59:11 +0000377
Chris Lattnerac3e0602002-01-31 18:32:27 +0000378 // Return the number of parent PassManagers that exist
379 virtual unsigned getDepth() const {
380 if (Parent == 0) return 0;
381 return 1 + Parent->getDepth();
382 }
383
Chris Lattner1e4867f2002-07-30 19:51:02 +0000384 virtual unsigned getNumContainedPasses() const { return Passes.size(); }
385 virtual const Pass *getContainedPass(unsigned N) const {
386 assert(N < Passes.size() && "Pass number out of range!");
387 return Passes[N];
388 }
389
Chris Lattner6e041bd2002-08-21 22:17:09 +0000390 // add - Add a pass to the queue of passes to run. This gives ownership of
Chris Lattner67d25652002-01-30 23:20:39 +0000391 // the Pass to the PassManager. When the PassManager is destroyed, the pass
Chris Lattnerac3e0602002-01-31 18:32:27 +0000392 // will be destroyed as well, so there is no need to delete the pass. This
393 // implies that all passes MUST be new'd.
Chris Lattner67d25652002-01-30 23:20:39 +0000394 //
395 void add(PassClass *P) {
396 // Get information about what analyses the pass uses...
Chris Lattnerc8e66542002-04-27 06:56:12 +0000397 AnalysisUsage AnUsage;
398 P->getAnalysisUsage(AnUsage);
399 const std::vector<AnalysisID> &Required = AnUsage.getRequiredSet();
Chris Lattner67d25652002-01-30 23:20:39 +0000400
401 // Loop over all of the analyses used by this pass,
Chris Lattnerc8e66542002-04-27 06:56:12 +0000402 for (std::vector<AnalysisID>::const_iterator I = Required.begin(),
403 E = Required.end(); I != E; ++I) {
Chris Lattner67d25652002-01-30 23:20:39 +0000404 if (getAnalysisOrNullDown(*I) == 0)
Chris Lattner26750072002-07-27 01:12:17 +0000405 add((PassClass*)(*I)->createPass());
Chris Lattner67d25652002-01-30 23:20:39 +0000406 }
407
408 // Tell the pass to add itself to this PassManager... the way it does so
409 // depends on the class of the pass, and is critical to laying out passes in
410 // an optimal order..
411 //
Chris Lattnerc8e66542002-04-27 06:56:12 +0000412 P->addToPassManager(this, AnUsage);
Chris Lattner67d25652002-01-30 23:20:39 +0000413 }
414
415private:
416
417 // addPass - These functions are used to implement the subclass specific
418 // behaviors present in PassManager. Basically the add(Pass*) method ends up
419 // reflecting its behavior into a Pass::addToPassManager call. Subclasses of
420 // Pass override it specifically so that they can reflect the type
421 // information inherent in "this" back to the PassManager.
422 //
423 // For generic Pass subclasses (which are interprocedural passes), we simply
424 // add the pass to the end of the pass list and terminate any accumulation of
Chris Lattnerc8e66542002-04-27 06:56:12 +0000425 // FunctionPass's that are present.
Chris Lattner67d25652002-01-30 23:20:39 +0000426 //
Chris Lattnerc8e66542002-04-27 06:56:12 +0000427 void addPass(PassClass *P, AnalysisUsage &AnUsage) {
428 const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
Chris Lattnerc8e66542002-04-27 06:56:12 +0000429
Chris Lattner73503172002-07-29 21:03:38 +0000430 // FIXME: If this pass being added isn't killed by any of the passes in the
431 // batcher class then we can reorder to pass to execute before the batcher
432 // does, which will potentially allow us to batch more passes!
Chris Lattner67d25652002-01-30 23:20:39 +0000433 //
Chris Lattner73503172002-07-29 21:03:38 +0000434 //const std::vector<AnalysisID> &ProvidedSet = AnUsage.getProvidedSet();
435 if (Batcher /*&& ProvidedSet.empty()*/)
Chris Lattner67d25652002-01-30 23:20:39 +0000436 closeBatcher(); // This pass cannot be batched!
437
438 // Set the Resolver instance variable in the Pass so that it knows where to
439 // find this object...
440 //
441 setAnalysisResolver(P, this);
442 Passes.push_back(P);
443
Chris Lattnerac3e0602002-01-31 18:32:27 +0000444 // Inform higher level pass managers (and ourselves) that these analyses are
445 // being used by this pass. This is used to make sure that analyses are not
446 // free'd before we have to use them...
447 //
Chris Lattnerc8e66542002-04-27 06:56:12 +0000448 for (std::vector<AnalysisID>::const_iterator I = RequiredSet.begin(),
449 E = RequiredSet.end(); I != E; ++I)
Chris Lattnerac3e0602002-01-31 18:32:27 +0000450 markPassUsed(*I, P); // Mark *I as used by P
451
Chris Lattnerc8e66542002-04-27 06:56:12 +0000452 // Erase all analyses not in the preserved set...
453 if (!AnUsage.preservesAll()) {
454 const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
455 for (std::map<AnalysisID, Pass*>::iterator I = CurrentAnalyses.begin(),
Chris Lattneree0788d2002-09-25 21:59:11 +0000456 E = CurrentAnalyses.end(); I != E; ) {
457 if (std::find(PreservedSet.begin(), PreservedSet.end(), I->first) ==
458 PreservedSet.end()) { // Analysis not preserved!
459 CurrentAnalyses.erase(I); // Remove from available analyses
Chris Lattnerc8e66542002-04-27 06:56:12 +0000460 I = CurrentAnalyses.begin();
Chris Lattneree0788d2002-09-25 21:59:11 +0000461 } else {
462 ++I;
Chris Lattnerc8e66542002-04-27 06:56:12 +0000463 }
Chris Lattneree0788d2002-09-25 21:59:11 +0000464 }
Chris Lattnerc8e66542002-04-27 06:56:12 +0000465 }
Chris Lattner67d25652002-01-30 23:20:39 +0000466
Chris Lattner73503172002-07-29 21:03:38 +0000467 // Add this pass to the currently available set...
Chris Lattner216edd42002-08-30 20:25:01 +0000468 if (const PassInfo *PI = P->getPassInfo()) {
Chris Lattner73503172002-07-29 21:03:38 +0000469 CurrentAnalyses[PI] = P;
Chris Lattnerac3e0602002-01-31 18:32:27 +0000470
Chris Lattner216edd42002-08-30 20:25:01 +0000471 // This pass is the current implementation of all of the interfaces it
472 // implements as well.
473 //
474 const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
475 for (unsigned i = 0, e = II.size(); i != e; ++i)
476 CurrentAnalyses[II[i]] = P;
477 }
478
Chris Lattnerac3e0602002-01-31 18:32:27 +0000479 // For now assume that our results are never used...
480 LastUseOf[P] = P;
Chris Lattner67d25652002-01-30 23:20:39 +0000481 }
482
Chris Lattnerc8e66542002-04-27 06:56:12 +0000483 // For FunctionPass subclasses, we must be sure to batch the FunctionPass's
484 // together in a BatcherClass object so that all of the analyses are run
485 // together a function at a time.
Chris Lattner67d25652002-01-30 23:20:39 +0000486 //
Chris Lattnerc8e66542002-04-27 06:56:12 +0000487 void addPass(SubPassClass *MP, AnalysisUsage &AnUsage) {
Chris Lattner67d25652002-01-30 23:20:39 +0000488 if (Batcher == 0) // If we don't have a batcher yet, make one now.
489 Batcher = new BatcherClass(this);
Chris Lattner73503172002-07-29 21:03:38 +0000490 // The Batcher will queue the passes up
Chris Lattnerc8e66542002-04-27 06:56:12 +0000491 MP->addToPassManager(Batcher, AnUsage);
Chris Lattner67d25652002-01-30 23:20:39 +0000492 }
493
494 // closeBatcher - Terminate the batcher that is being worked on.
495 void closeBatcher() {
496 if (Batcher) {
497 Passes.push_back(Batcher);
498 Batcher = 0;
499 }
500 }
Chris Lattneree0788d2002-09-25 21:59:11 +0000501
502public:
503 // When an ImmutablePass is added, it gets added to the top level pass
504 // manager.
505 void addPass(ImmutablePass *IP, AnalysisUsage &AU) {
506 if (Parent) { // Make sure this request goes to the top level passmanager...
507 Parent->addPass(IP, AU);
508 return;
509 }
510
511 // Set the Resolver instance variable in the Pass so that it knows where to
512 // find this object...
513 //
514 setAnalysisResolver(IP, this);
515 ImmutablePasses.push_back(IP);
516
517 // Add this pass to the currently available set...
518 if (const PassInfo *PI = IP->getPassInfo()) {
519 CurrentAnalyses[PI] = IP;
520
521 // This pass is the current implementation of all of the interfaces it
522 // implements as well.
523 //
524 const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
525 for (unsigned i = 0, e = II.size(); i != e; ++i)
526 CurrentAnalyses[II[i]] = IP;
527 }
528 }
Chris Lattner67d25652002-01-30 23:20:39 +0000529};
530
531
532
533//===----------------------------------------------------------------------===//
534// PassManagerTraits<BasicBlock> Specialization
535//
536// This pass manager is used to group together all of the BasicBlockPass's
537// into a single unit.
538//
539template<> struct PassManagerTraits<BasicBlock> : public BasicBlockPass {
540 // PassClass - The type of passes tracked by this PassManager
541 typedef BasicBlockPass PassClass;
542
543 // SubPassClass - The types of classes that should be collated together
544 // This is impossible to match, so BasicBlock instantiations of PassManagerT
545 // do not collate.
546 //
547 typedef PassManagerT<Module> SubPassClass;
548
549 // BatcherClass - The type to use for collation of subtypes... This class is
550 // never instantiated for the PassManager<BasicBlock>, but it must be an
551 // instance of PassClass to typecheck.
552 //
553 typedef PassClass BatcherClass;
554
555 // ParentClass - The type of the parent PassManager...
Chris Lattner4e8c4872002-03-23 22:51:58 +0000556 typedef PassManagerT<Function> ParentClass;
Chris Lattner67d25652002-01-30 23:20:39 +0000557
Chris Lattner2eaac392002-01-31 00:40:44 +0000558 // PMType - The type of the passmanager that subclasses this class
559 typedef PassManagerT<BasicBlock> PMType;
560
Chris Lattner67d25652002-01-30 23:20:39 +0000561 // runPass - Specify how the pass should be run on the UnitType
562 static bool runPass(PassClass *P, BasicBlock *M) {
563 // todo, init and finalize
Chris Lattner113f4f42002-06-25 16:13:24 +0000564 return P->runOnBasicBlock(*M);
Chris Lattner67d25652002-01-30 23:20:39 +0000565 }
566
Chris Lattnere2eb99e2002-04-29 04:04:29 +0000567 // Dummy implementation of PassStarted/PassEnded
568 static void PassStarted(Pass *P) {}
569 static void PassEnded(Pass *P) {}
570
Chris Lattnerac3e0602002-01-31 18:32:27 +0000571 // getPMName() - Return the name of the unit the PassManager operates on for
572 // debugging.
573 const char *getPMName() const { return "BasicBlock"; }
Chris Lattner37104aa2002-04-29 14:57:45 +0000574 virtual const char *getPassName() const { return "BasicBlock Pass Manager"; }
Chris Lattnerac3e0602002-01-31 18:32:27 +0000575
Chris Lattner2eaac392002-01-31 00:40:44 +0000576 // Implement the BasicBlockPass interface...
Chris Lattner113f4f42002-06-25 16:13:24 +0000577 virtual bool doInitialization(Module &M);
Chris Lattnerbae3c672002-09-12 17:06:40 +0000578 virtual bool doInitialization(Function &F);
Chris Lattner113f4f42002-06-25 16:13:24 +0000579 virtual bool runOnBasicBlock(BasicBlock &BB);
Chris Lattnerbae3c672002-09-12 17:06:40 +0000580 virtual bool doFinalization(Function &F);
Chris Lattner113f4f42002-06-25 16:13:24 +0000581 virtual bool doFinalization(Module &M);
Chris Lattnercb429062002-04-30 18:50:17 +0000582
583 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
584 AU.setPreservesAll();
585 }
Chris Lattner67d25652002-01-30 23:20:39 +0000586};
587
588
589
590//===----------------------------------------------------------------------===//
Chris Lattner4e8c4872002-03-23 22:51:58 +0000591// PassManagerTraits<Function> Specialization
Chris Lattner67d25652002-01-30 23:20:39 +0000592//
Chris Lattnerc8e66542002-04-27 06:56:12 +0000593// This pass manager is used to group together all of the FunctionPass's
Chris Lattner67d25652002-01-30 23:20:39 +0000594// into a single unit.
595//
Chris Lattnerc8e66542002-04-27 06:56:12 +0000596template<> struct PassManagerTraits<Function> : public FunctionPass {
Chris Lattner67d25652002-01-30 23:20:39 +0000597 // PassClass - The type of passes tracked by this PassManager
Chris Lattnerc8e66542002-04-27 06:56:12 +0000598 typedef FunctionPass PassClass;
Chris Lattner67d25652002-01-30 23:20:39 +0000599
600 // SubPassClass - The types of classes that should be collated together
601 typedef BasicBlockPass SubPassClass;
602
603 // BatcherClass - The type to use for collation of subtypes...
604 typedef PassManagerT<BasicBlock> BatcherClass;
605
606 // ParentClass - The type of the parent PassManager...
607 typedef PassManagerT<Module> ParentClass;
608
609 // PMType - The type of the passmanager that subclasses this class
Chris Lattner4e8c4872002-03-23 22:51:58 +0000610 typedef PassManagerT<Function> PMType;
Chris Lattner67d25652002-01-30 23:20:39 +0000611
612 // runPass - Specify how the pass should be run on the UnitType
Chris Lattnerc8e66542002-04-27 06:56:12 +0000613 static bool runPass(PassClass *P, Function *F) {
Chris Lattner113f4f42002-06-25 16:13:24 +0000614 return P->runOnFunction(*F);
Chris Lattner67d25652002-01-30 23:20:39 +0000615 }
616
Chris Lattnere2eb99e2002-04-29 04:04:29 +0000617 // Dummy implementation of PassStarted/PassEnded
618 static void PassStarted(Pass *P) {}
619 static void PassEnded(Pass *P) {}
620
Chris Lattnerac3e0602002-01-31 18:32:27 +0000621 // getPMName() - Return the name of the unit the PassManager operates on for
622 // debugging.
Chris Lattner4e8c4872002-03-23 22:51:58 +0000623 const char *getPMName() const { return "Function"; }
Chris Lattner37104aa2002-04-29 14:57:45 +0000624 virtual const char *getPassName() const { return "Function Pass Manager"; }
Chris Lattnerac3e0602002-01-31 18:32:27 +0000625
Chris Lattnerc8e66542002-04-27 06:56:12 +0000626 // Implement the FunctionPass interface...
Chris Lattner113f4f42002-06-25 16:13:24 +0000627 virtual bool doInitialization(Module &M);
628 virtual bool runOnFunction(Function &F);
629 virtual bool doFinalization(Module &M);
Chris Lattnercb429062002-04-30 18:50:17 +0000630
631 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
632 AU.setPreservesAll();
633 }
Chris Lattner67d25652002-01-30 23:20:39 +0000634};
635
636
637
638//===----------------------------------------------------------------------===//
639// PassManagerTraits<Module> Specialization
640//
641// This is the top level PassManager implementation that holds generic passes.
642//
643template<> struct PassManagerTraits<Module> : public Pass {
644 // PassClass - The type of passes tracked by this PassManager
645 typedef Pass PassClass;
646
647 // SubPassClass - The types of classes that should be collated together
Chris Lattnerc8e66542002-04-27 06:56:12 +0000648 typedef FunctionPass SubPassClass;
Chris Lattner67d25652002-01-30 23:20:39 +0000649
650 // BatcherClass - The type to use for collation of subtypes...
Chris Lattner4e8c4872002-03-23 22:51:58 +0000651 typedef PassManagerT<Function> BatcherClass;
Chris Lattner67d25652002-01-30 23:20:39 +0000652
653 // ParentClass - The type of the parent PassManager...
Chris Lattnerac3e0602002-01-31 18:32:27 +0000654 typedef AnalysisResolver ParentClass;
Chris Lattner67d25652002-01-30 23:20:39 +0000655
656 // runPass - Specify how the pass should be run on the UnitType
Chris Lattner113f4f42002-06-25 16:13:24 +0000657 static bool runPass(PassClass *P, Module *M) { return P->run(*M); }
Chris Lattner67d25652002-01-30 23:20:39 +0000658
Chris Lattnerac3e0602002-01-31 18:32:27 +0000659 // getPMName() - Return the name of the unit the PassManager operates on for
660 // debugging.
661 const char *getPMName() const { return "Module"; }
Chris Lattner37104aa2002-04-29 14:57:45 +0000662 virtual const char *getPassName() const { return "Module Pass Manager"; }
Chris Lattnerac3e0602002-01-31 18:32:27 +0000663
Chris Lattnere2eb99e2002-04-29 04:04:29 +0000664 // TimingInformation - This data member maintains timing information for each
665 // of the passes that is executed.
666 //
667 TimingInfo *TimeInfo;
668
669 // PassStarted/Ended - This callback is notified any time a pass is started
670 // or stops. This is used to collect timing information about the different
671 // passes being executed.
672 //
673 void PassStarted(Pass *P) {
674 if (TimeInfo) TimeInfo->passStarted(P);
Chris Lattner67d25652002-01-30 23:20:39 +0000675 }
Chris Lattnere2eb99e2002-04-29 04:04:29 +0000676 void PassEnded(Pass *P) {
677 if (TimeInfo) TimeInfo->passEnded(P);
678 }
679
680 // run - Implement the PassManager interface...
Chris Lattner113f4f42002-06-25 16:13:24 +0000681 bool run(Module &M) {
Chris Lattnere2eb99e2002-04-29 04:04:29 +0000682 TimeInfo = TimingInfo::create();
Chris Lattner113f4f42002-06-25 16:13:24 +0000683 bool Result = ((PassManagerT<Module>*)this)->runOnUnit(&M);
Chris Lattnere2eb99e2002-04-29 04:04:29 +0000684 if (TimeInfo) {
685 delete TimeInfo;
686 TimeInfo = 0;
687 }
688 return Result;
689 }
690
691 // PassManagerTraits constructor - Create a timing info object if the user
692 // specified timing info should be collected on the command line.
693 //
694 PassManagerTraits() : TimeInfo(0) {}
Chris Lattner67d25652002-01-30 23:20:39 +0000695};
696
697
698
699//===----------------------------------------------------------------------===//
700// PassManagerTraits Method Implementations
701//
702
703// PassManagerTraits<BasicBlock> Implementations
704//
Chris Lattner113f4f42002-06-25 16:13:24 +0000705inline bool PassManagerTraits<BasicBlock>::doInitialization(Module &M) {
Chris Lattner2eaac392002-01-31 00:40:44 +0000706 bool Changed = false;
707 for (unsigned i = 0, e = ((PMType*)this)->Passes.size(); i != e; ++i)
708 ((PMType*)this)->Passes[i]->doInitialization(M);
709 return Changed;
710}
711
Chris Lattnerbae3c672002-09-12 17:06:40 +0000712inline bool PassManagerTraits<BasicBlock>::doInitialization(Function &F) {
713 bool Changed = false;
714 for (unsigned i = 0, e = ((PMType*)this)->Passes.size(); i != e; ++i)
715 ((PMType*)this)->Passes[i]->doInitialization(F);
716 return Changed;
717}
718
Chris Lattner113f4f42002-06-25 16:13:24 +0000719inline bool PassManagerTraits<BasicBlock>::runOnBasicBlock(BasicBlock &BB) {
720 return ((PMType*)this)->runOnUnit(&BB);
Chris Lattner2eaac392002-01-31 00:40:44 +0000721}
722
Chris Lattnerbae3c672002-09-12 17:06:40 +0000723inline bool PassManagerTraits<BasicBlock>::doFinalization(Function &F) {
724 bool Changed = false;
725 for (unsigned i = 0, e = ((PMType*)this)->Passes.size(); i != e; ++i)
726 ((PMType*)this)->Passes[i]->doFinalization(F);
727 return Changed;
728}
729
Chris Lattner113f4f42002-06-25 16:13:24 +0000730inline bool PassManagerTraits<BasicBlock>::doFinalization(Module &M) {
Chris Lattner2eaac392002-01-31 00:40:44 +0000731 bool Changed = false;
732 for (unsigned i = 0, e = ((PMType*)this)->Passes.size(); i != e; ++i)
733 ((PMType*)this)->Passes[i]->doFinalization(M);
734 return Changed;
Chris Lattner67d25652002-01-30 23:20:39 +0000735}
736
737
Chris Lattner4e8c4872002-03-23 22:51:58 +0000738// PassManagerTraits<Function> Implementations
Chris Lattner67d25652002-01-30 23:20:39 +0000739//
Chris Lattner113f4f42002-06-25 16:13:24 +0000740inline bool PassManagerTraits<Function>::doInitialization(Module &M) {
Chris Lattner67d25652002-01-30 23:20:39 +0000741 bool Changed = false;
742 for (unsigned i = 0, e = ((PMType*)this)->Passes.size(); i != e; ++i)
743 ((PMType*)this)->Passes[i]->doInitialization(M);
744 return Changed;
745}
746
Chris Lattner113f4f42002-06-25 16:13:24 +0000747inline bool PassManagerTraits<Function>::runOnFunction(Function &F) {
748 return ((PMType*)this)->runOnUnit(&F);
Chris Lattner67d25652002-01-30 23:20:39 +0000749}
750
Chris Lattner113f4f42002-06-25 16:13:24 +0000751inline bool PassManagerTraits<Function>::doFinalization(Module &M) {
Chris Lattner67d25652002-01-30 23:20:39 +0000752 bool Changed = false;
753 for (unsigned i = 0, e = ((PMType*)this)->Passes.size(); i != e; ++i)
754 ((PMType*)this)->Passes[i]->doFinalization(M);
755 return Changed;
756}
757
758#endif