PassManager.cpp revision 1554c8545651350569f08dc7370189da1a7e5814
155fd43f90913676682487f89f27c756adb827f66Devang Patel//===- PassManager.cpp - LLVM Pass Infrastructure Implementation ----------===//
255fd43f90913676682487f89f27c756adb827f66Devang Patel//
355fd43f90913676682487f89f27c756adb827f66Devang Patel//                     The LLVM Compiler Infrastructure
455fd43f90913676682487f89f27c756adb827f66Devang Patel//
5c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel// This file was developed by Devang Patel and is distributed under
655fd43f90913676682487f89f27c756adb827f66Devang Patel// the University of Illinois Open Source License. See LICENSE.TXT for details.
755fd43f90913676682487f89f27c756adb827f66Devang Patel//
855fd43f90913676682487f89f27c756adb827f66Devang Patel//===----------------------------------------------------------------------===//
955fd43f90913676682487f89f27c756adb827f66Devang Patel//
1055fd43f90913676682487f89f27c756adb827f66Devang Patel// This file implements the LLVM Pass Manager infrastructure.
1155fd43f90913676682487f89f27c756adb827f66Devang Patel//
1255fd43f90913676682487f89f27c756adb827f66Devang Patel//===----------------------------------------------------------------------===//
1355fd43f90913676682487f89f27c756adb827f66Devang Patel
1455fd43f90913676682487f89f27c756adb827f66Devang Patel
1555fd43f90913676682487f89f27c756adb827f66Devang Patel#include "llvm/PassManager.h"
1645dc02d6f97447785ee7ffe08c36a34bc8921b0bDevang Patel#include "llvm/Support/CommandLine.h"
178e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel#include "llvm/Support/Timer.h"
1855fd43f90913676682487f89f27c756adb827f66Devang Patel#include "llvm/Module.h"
193799f97d539f6c288d169063e1b335917fafcffbDevang Patel#include "llvm/ModuleProvider.h"
208f487662869d10c866b9ebdccb8f6a7509d3ab56Bill Wendling#include "llvm/Support/Streams.h"
218e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel#include "llvm/Support/ManagedStatic.h"
2285d344b0c68048527f1ac46ba22bbc950870d3c5Devang Patel#include <vector>
23b899eed1bc0a64f96fa7aff8d7c6f999cf85bdfeDevang Patel#include <map>
24c2ff962bf97761a54c94d2dadb555060403d49c6Devang Patel
2555fd43f90913676682487f89f27c756adb827f66Devang Patelusing namespace llvm;
26c2ff962bf97761a54c94d2dadb555060403d49c6Devang Patelclass llvm::PMDataManager;
2755fd43f90913676682487f89f27c756adb827f66Devang Patel
28e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel//===----------------------------------------------------------------------===//
29e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel// Overview:
30e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel// The Pass Manager Infrastructure manages passes. It's responsibilities are:
31e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel//
32e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel//   o Manage optimization pass execution order
33e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel//   o Make required Analysis information available before pass P is run
34e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel//   o Release memory occupied by dead passes
35e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel//   o If Analysis information is dirtied by a pass then regenerate Analysis
36e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel//     information before it is consumed by another pass.
37e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel//
38a84b3025ca7d437d2eab22d7c3002c8d89c31858Chris Lattner// Pass Manager Infrastructure uses multiple pass managers.  They are
39a84b3025ca7d437d2eab22d7c3002c8d89c31858Chris Lattner// PassManager, FunctionPassManager, ModulePassManager, BasicBlockPassManager.
40a84b3025ca7d437d2eab22d7c3002c8d89c31858Chris Lattner// This class hierarcy uses multiple inheritance but pass managers do not derive
41a84b3025ca7d437d2eab22d7c3002c8d89c31858Chris Lattner// from another pass manager.
42e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel//
43a84b3025ca7d437d2eab22d7c3002c8d89c31858Chris Lattner// PassManager and FunctionPassManager are two top-level pass manager that
44e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel// represents the external interface of this entire pass manager infrastucture.
45e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel//
46e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel// Important classes :
47e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel//
48e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel// [o] class PMTopLevelManager;
49e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel//
50e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel// Two top level managers, PassManager and FunctionPassManager, derive from
51e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel// PMTopLevelManager. PMTopLevelManager manages information used by top level
52e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel// managers such as last user info.
53e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel//
54e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel// [o] class PMDataManager;
55e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel//
56e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel// PMDataManager manages information, e.g. list of available analysis info,
57e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel// used by a pass manager to manage execution order of passes. It also provides
58e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel// a place to implement common pass manager APIs. All pass managers derive from
59e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel// PMDataManager.
60e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel//
61e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel// [o] class BasicBlockPassManager : public FunctionPass, public PMDataManager;
62e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel//
63e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel// BasicBlockPassManager manages BasicBlockPasses.
64e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel//
65e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel// [o] class FunctionPassManager;
66e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel//
67e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel// This is a external interface used by JIT to manage FunctionPasses. This
68e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel// interface relies on FunctionPassManagerImpl to do all the tasks.
69e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel//
70e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel// [o] class FunctionPassManagerImpl : public ModulePass, PMDataManager,
71e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel//                                     public PMTopLevelManager;
72e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel//
73e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel// FunctionPassManagerImpl is a top level manager. It manages FunctionPasses
74e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel// and BasicBlockPassManagers.
75e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel//
76e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel// [o] class ModulePassManager : public Pass, public PMDataManager;
77e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel//
78e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel// ModulePassManager manages ModulePasses and FunctionPassManagerImpls.
79e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel//
80e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel// [o] class PassManager;
81e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel//
82e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel// This is a external interface used by various tools to manages passes. It
83e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel// relies on PassManagerImpl to do all the tasks.
84e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel//
85e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel// [o] class PassManagerImpl : public Pass, public PMDataManager,
86e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel//                             public PMDTopLevelManager
87e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel//
88e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel// PassManagerImpl is a top level pass manager responsible for managing
89e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel// ModulePassManagers.
90e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel//===----------------------------------------------------------------------===//
91e77242c3d5843a5a6484794254623c8552dc6a4fDevang Patel
9245dc02d6f97447785ee7ffe08c36a34bc8921b0bDevang Patelnamespace llvm {
9345dc02d6f97447785ee7ffe08c36a34bc8921b0bDevang Patel
9445dc02d6f97447785ee7ffe08c36a34bc8921b0bDevang Patel//===----------------------------------------------------------------------===//
9545dc02d6f97447785ee7ffe08c36a34bc8921b0bDevang Patel// Pass debugging information.  Often it is useful to find out what pass is
9645dc02d6f97447785ee7ffe08c36a34bc8921b0bDevang Patel// running when a crash occurs in a utility.  When this library is compiled with
9745dc02d6f97447785ee7ffe08c36a34bc8921b0bDevang Patel// debugging on, a command line option (--debug-pass) is enabled that causes the
9845dc02d6f97447785ee7ffe08c36a34bc8921b0bDevang Patel// pass name to be printed before it executes.
9945dc02d6f97447785ee7ffe08c36a34bc8921b0bDevang Patel//
10045dc02d6f97447785ee7ffe08c36a34bc8921b0bDevang Patel
101e8ff1ce7343c697ff90d940c8c5fa8fccc09220dDevang Patel// Different debug levels that can be enabled...
102e8ff1ce7343c697ff90d940c8c5fa8fccc09220dDevang Patelenum PassDebugLevel {
103e8ff1ce7343c697ff90d940c8c5fa8fccc09220dDevang Patel  None, Arguments, Structure, Executions, Details
104e8ff1ce7343c697ff90d940c8c5fa8fccc09220dDevang Patel};
105e8ff1ce7343c697ff90d940c8c5fa8fccc09220dDevang Patel
10645dc02d6f97447785ee7ffe08c36a34bc8921b0bDevang Patelstatic cl::opt<enum PassDebugLevel>
10745dc02d6f97447785ee7ffe08c36a34bc8921b0bDevang PatelPassDebugging_New("debug-pass", cl::Hidden,
10845dc02d6f97447785ee7ffe08c36a34bc8921b0bDevang Patel                  cl::desc("Print PassManager debugging information"),
10945dc02d6f97447785ee7ffe08c36a34bc8921b0bDevang Patel                  cl::values(
110e8ff1ce7343c697ff90d940c8c5fa8fccc09220dDevang Patel  clEnumVal(None      , "disable debug output"),
111e8ff1ce7343c697ff90d940c8c5fa8fccc09220dDevang Patel  clEnumVal(Arguments , "print pass arguments to pass to 'opt'"),
112e8ff1ce7343c697ff90d940c8c5fa8fccc09220dDevang Patel  clEnumVal(Structure , "print pass structure before run()"),
113e8ff1ce7343c697ff90d940c8c5fa8fccc09220dDevang Patel  clEnumVal(Executions, "print pass name before it is executed"),
114e8ff1ce7343c697ff90d940c8c5fa8fccc09220dDevang Patel  clEnumVal(Details   , "print pass details when it is executed"),
11545dc02d6f97447785ee7ffe08c36a34bc8921b0bDevang Patel                             clEnumValEnd));
11645dc02d6f97447785ee7ffe08c36a34bc8921b0bDevang Patel} // End of llvm namespace
11745dc02d6f97447785ee7ffe08c36a34bc8921b0bDevang Patel
1183162691f69f85f740bc28f3ddca39b166d35187cDevang Patel#ifndef USE_OLD_PASSMANAGER
119c2ff962bf97761a54c94d2dadb555060403d49c6Devang Patelnamespace {
1201b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
1213f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel//===----------------------------------------------------------------------===//
1223f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel// PMTopLevelManager
1233f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel//
1243f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel/// PMTopLevelManager manages LastUser info and collects common APIs used by
1253f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel/// top level pass managers.
126c2ff962bf97761a54c94d2dadb555060403d49c6Devang Patelclass VISIBILITY_HIDDEN PMTopLevelManager {
1273f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patelpublic:
1283f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel
1293f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel  inline std::vector<Pass *>::iterator passManagersBegin() {
1303f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel    return PassManagers.begin();
1313f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel  }
1323f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel
1333f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel  inline std::vector<Pass *>::iterator passManagersEnd() {
1343f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel    return PassManagers.end();
1353f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel  }
1363f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel
1373f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel  /// Schedule pass P for execution. Make sure that passes required by
1383f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel  /// P are run before P is run. Update analysis info maintained by
1393f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel  /// the manager. Remove dead passes. This is a recursive function.
140e61b7478e53cea3183d4aee3799a4f0977b850a0Devang Patel  void schedulePass(Pass *P);
1413f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel
1423f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel  /// This is implemented by top level pass manager and used by
1433f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel  /// schedulePass() to add analysis info passes that are not available.
1443f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel  virtual void addTopLevelPass(Pass  *P) = 0;
1453f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel
1463f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel  /// Set pass P as the last user of the given analysis passes.
1473f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel  void setLastUser(std::vector<Pass *> &AnalysisPasses, Pass *P);
1483f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel
1493f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel  /// Collect passes whose last user is P
1503f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel  void collectLastUses(std::vector<Pass *> &LastUses, Pass *P);
1513f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel
15269867b511c732a7fac7301977bd6e880e46439f1Devang Patel  /// Find the pass that implements Analysis AID. Search immutable
15369867b511c732a7fac7301977bd6e880e46439f1Devang Patel  /// passes and all pass managers. If desired pass is not found
15469867b511c732a7fac7301977bd6e880e46439f1Devang Patel  /// then return NULL.
15569867b511c732a7fac7301977bd6e880e46439f1Devang Patel  Pass *findAnalysisPass(AnalysisID AID);
15669867b511c732a7fac7301977bd6e880e46439f1Devang Patel
1573162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  inline void clearManagers() {
1583162691f69f85f740bc28f3ddca39b166d35187cDevang Patel    PassManagers.clear();
1593162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  }
1603162691f69f85f740bc28f3ddca39b166d35187cDevang Patel
1613f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel  virtual ~PMTopLevelManager() {
16237a6f7966c39f69a92419d37949a94a758c29e90Devang Patel    for (std::vector<Pass *>::iterator I = PassManagers.begin(),
16337a6f7966c39f69a92419d37949a94a758c29e90Devang Patel           E = PassManagers.end(); I != E; ++I)
16437a6f7966c39f69a92419d37949a94a758c29e90Devang Patel      delete *I;
16537a6f7966c39f69a92419d37949a94a758c29e90Devang Patel
16637a6f7966c39f69a92419d37949a94a758c29e90Devang Patel    for (std::vector<ImmutablePass *>::iterator
16737a6f7966c39f69a92419d37949a94a758c29e90Devang Patel           I = ImmutablePasses.begin(), E = ImmutablePasses.end(); I != E; ++I)
16837a6f7966c39f69a92419d37949a94a758c29e90Devang Patel      delete *I;
16937a6f7966c39f69a92419d37949a94a758c29e90Devang Patel
1703f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel    PassManagers.clear();
1713f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel  }
1723f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel
1733e44559d0137f2c3e3bf7a0c1e0004e0a5c81137Devang Patel  /// Add immutable pass and initialize it.
1743e44559d0137f2c3e3bf7a0c1e0004e0a5c81137Devang Patel  inline void addImmutablePass(ImmutablePass *P) {
1753e44559d0137f2c3e3bf7a0c1e0004e0a5c81137Devang Patel    P->initializePass();
1763e44559d0137f2c3e3bf7a0c1e0004e0a5c81137Devang Patel    ImmutablePasses.push_back(P);
1773e44559d0137f2c3e3bf7a0c1e0004e0a5c81137Devang Patel  }
1783e44559d0137f2c3e3bf7a0c1e0004e0a5c81137Devang Patel
1793e44559d0137f2c3e3bf7a0c1e0004e0a5c81137Devang Patel  inline std::vector<ImmutablePass *>& getImmutablePasses() {
1803e44559d0137f2c3e3bf7a0c1e0004e0a5c81137Devang Patel    return ImmutablePasses;
1813e44559d0137f2c3e3bf7a0c1e0004e0a5c81137Devang Patel  }
1823e44559d0137f2c3e3bf7a0c1e0004e0a5c81137Devang Patel
183a083e94f7971ddafb817b1bcd86992d9fc4d8f9eDevang Patel  void addPassManager(Pass *Manager) {
184a083e94f7971ddafb817b1bcd86992d9fc4d8f9eDevang Patel    PassManagers.push_back(Manager);
185a083e94f7971ddafb817b1bcd86992d9fc4d8f9eDevang Patel  }
186a083e94f7971ddafb817b1bcd86992d9fc4d8f9eDevang Patel
187591b1b7526ed9c099de23cc995853a250c20502fDevang Patel  // Add Manager into the list of managers that are not directly
188591b1b7526ed9c099de23cc995853a250c20502fDevang Patel  // maintained by this top level pass manager
1891b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  inline void addIndirectPassManager(PMDataManager *Manager) {
1901b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    IndirectPassManagers.push_back(Manager);
191591b1b7526ed9c099de23cc995853a250c20502fDevang Patel  }
192591b1b7526ed9c099de23cc995853a250c20502fDevang Patel
193ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  // Print passes managed by this top level manager.
194a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  void dumpPasses() const;
195a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  void dumpArguments() const;
196ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel
1973f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patelprivate:
1983f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel
1993f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel  /// Collection of pass managers
2003f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel  std::vector<Pass *> PassManagers;
2013f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel
202591b1b7526ed9c099de23cc995853a250c20502fDevang Patel  /// Collection of pass managers that are not directly maintained
203591b1b7526ed9c099de23cc995853a250c20502fDevang Patel  /// by this pass manager
2041b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  std::vector<PMDataManager *> IndirectPassManagers;
205591b1b7526ed9c099de23cc995853a250c20502fDevang Patel
2063f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel  // Map to keep track of last user of the analysis pass.
2073f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel  // LastUser->second is the last user of Lastuser->first.
2083f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel  std::map<Pass *, Pass *> LastUser;
2093e44559d0137f2c3e3bf7a0c1e0004e0a5c81137Devang Patel
2103e44559d0137f2c3e3bf7a0c1e0004e0a5c81137Devang Patel  /// Immutable passes are managed by top level manager.
2113e44559d0137f2c3e3bf7a0c1e0004e0a5c81137Devang Patel  std::vector<ImmutablePass *> ImmutablePasses;
2123f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel};
213c2ff962bf97761a54c94d2dadb555060403d49c6Devang Patel
214c2ff962bf97761a54c94d2dadb555060403d49c6Devang Patel} // End of anon namespace
2153f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel
216dc48f203cdc5a0b8f79d28bab6219161061fd73bDevang Patel//===----------------------------------------------------------------------===//
217dc48f203cdc5a0b8f79d28bab6219161061fd73bDevang Patel// PMDataManager
2183f5d2b58b84cb12a9520dd33921ca556d539eb4dDevang Patel
219c2ff962bf97761a54c94d2dadb555060403d49c6Devang Patelnamespace llvm {
220419f0e95d698109541ad730cb45ba4caca78f458Devang Patel/// PMDataManager provides the common place to manage the analysis data
221419f0e95d698109541ad730cb45ba4caca78f458Devang Patel/// used by pass managers.
222419f0e95d698109541ad730cb45ba4caca78f458Devang Patelclass PMDataManager {
22385d344b0c68048527f1ac46ba22bbc950870d3c5Devang Patelpublic:
2241a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel  PMDataManager(int Depth) : TPM(NULL), Depth(Depth) {
225dc48f203cdc5a0b8f79d28bab6219161061fd73bDevang Patel    initializeAnalysisInfo();
226dc48f203cdc5a0b8f79d28bab6219161061fd73bDevang Patel  }
227dc48f203cdc5a0b8f79d28bab6219161061fd73bDevang Patel
22837a6f7966c39f69a92419d37949a94a758c29e90Devang Patel  virtual ~PMDataManager() {
22937a6f7966c39f69a92419d37949a94a758c29e90Devang Patel
23037a6f7966c39f69a92419d37949a94a758c29e90Devang Patel    for (std::vector<Pass *>::iterator I = PassVector.begin(),
23137a6f7966c39f69a92419d37949a94a758c29e90Devang Patel           E = PassVector.end(); I != E; ++I)
23237a6f7966c39f69a92419d37949a94a758c29e90Devang Patel      delete *I;
23337a6f7966c39f69a92419d37949a94a758c29e90Devang Patel
23437a6f7966c39f69a92419d37949a94a758c29e90Devang Patel    PassVector.clear();
23537a6f7966c39f69a92419d37949a94a758c29e90Devang Patel  }
23637a6f7966c39f69a92419d37949a94a758c29e90Devang Patel
23785d344b0c68048527f1ac46ba22bbc950870d3c5Devang Patel  /// Return true IFF pass P's required analysis set does not required new
23885d344b0c68048527f1ac46ba22bbc950870d3c5Devang Patel  /// manager.
23985d344b0c68048527f1ac46ba22bbc950870d3c5Devang Patel  bool manageablePass(Pass *P);
24085d344b0c68048527f1ac46ba22bbc950870d3c5Devang Patel
24185d344b0c68048527f1ac46ba22bbc950870d3c5Devang Patel  /// Augment AvailableAnalysis by adding analysis made available by pass P.
242f32b4dd13e421b3ad4696f984cb2043ce64e19cbDevang Patel  void recordAvailableAnalysis(Pass *P);
24385d344b0c68048527f1ac46ba22bbc950870d3c5Devang Patel
24485d344b0c68048527f1ac46ba22bbc950870d3c5Devang Patel  /// Remove Analysis that is not preserved by the pass
24585d344b0c68048527f1ac46ba22bbc950870d3c5Devang Patel  void removeNotPreservedAnalysis(Pass *P);
24685d344b0c68048527f1ac46ba22bbc950870d3c5Devang Patel
24785d344b0c68048527f1ac46ba22bbc950870d3c5Devang Patel  /// Remove dead passes
2484eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel  void removeDeadPasses(Pass *P, std::string &Msg);
24985d344b0c68048527f1ac46ba22bbc950870d3c5Devang Patel
2504045af1175509c81d6a4708df233f0b1abe888fcDevang Patel  /// Add pass P into the PassVector. Update
251893a5a681585cdf3b5bfff7128ea522e8a47750aDevang Patel  /// AvailableAnalysis appropriately if ProcessAnalysis is true.
252a84b3025ca7d437d2eab22d7c3002c8d89c31858Chris Lattner  void addPassToManager(Pass *P, bool ProcessAnalysis = true);
253e253385b108cd946b1ac150302f246d3b218be77Devang Patel
254c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel  /// Initialize available analysis information.
255cbfd29d0da5810949ba66701b91c1b954122077aDevang Patel  void initializeAnalysisInfo() {
256ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel    TransferLastUses.clear();
257c1d6e1fc9c3a47529f417026df652f466ce67851Devang Patel    AvailableAnalysis.clear();
258c1d6e1fc9c3a47529f417026df652f466ce67851Devang Patel  }
259c1d6e1fc9c3a47529f417026df652f466ce67851Devang Patel
260c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel  /// Populate RequiredPasses with the analysis pass that are required by
261c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel  /// pass P.
262c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel  void collectRequiredAnalysisPasses(std::vector<Pass *> &RequiredPasses,
263c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel                                     Pass *P);
264c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel
265c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel  /// All Required analyses should be available to the pass as it runs!  Here
266c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel  /// we fill in the AnalysisImpls member of the pass so that it can
267c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel  /// successfully use the getAnalysis() method to retrieve the
268c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel  /// implementations it needs.
269c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel  void initializeAnalysisImpl(Pass *P);
270b899eed1bc0a64f96fa7aff8d7c6f999cf85bdfeDevang Patel
27169867b511c732a7fac7301977bd6e880e46439f1Devang Patel  /// Find the pass that implements Analysis AID. If desired pass is not found
27269867b511c732a7fac7301977bd6e880e46439f1Devang Patel  /// then return NULL.
27369867b511c732a7fac7301977bd6e880e46439f1Devang Patel  Pass *findAnalysisPass(AnalysisID AID, bool Direction);
27469867b511c732a7fac7301977bd6e880e46439f1Devang Patel
275dc48f203cdc5a0b8f79d28bab6219161061fd73bDevang Patel  // Access toplevel manager
276dc48f203cdc5a0b8f79d28bab6219161061fd73bDevang Patel  PMTopLevelManager *getTopLevelManager() { return TPM; }
277dc48f203cdc5a0b8f79d28bab6219161061fd73bDevang Patel  void setTopLevelManager(PMTopLevelManager *T) { TPM = T; }
278dc48f203cdc5a0b8f79d28bab6219161061fd73bDevang Patel
279a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  unsigned getDepth() const { return Depth; }
2804eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel
281a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  // Print routines used by debug-pass
282a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  void dumpLastUses(Pass *P, unsigned Offset) const;
283a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  void dumpPassArguments() const;
284a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  void dumpPassInfo(Pass *P,  std::string &Msg1, std::string &Msg2) const;
285017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel  void dumpAnalysisSetInfo(const char *Msg, Pass *P,
286a52035a062edf9bfbf95c92c615219b647042c17Devang Patel                           const std::vector<AnalysisID> &Set) const;
287ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel
288ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel  std::vector<Pass *>& getTransferredLastUses() {
289ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel    return TransferLastUses;
290ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel  }
291ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel
2921554c8545651350569f08dc7370189da1a7e5814Devang Patel  virtual unsigned getNumContainedPasses() {
2931554c8545651350569f08dc7370189da1a7e5814Devang Patel    return PassVector.size();
2941554c8545651350569f08dc7370189da1a7e5814Devang Patel  }
2951554c8545651350569f08dc7370189da1a7e5814Devang Patel
296e16634065021e36ae31f074f623a636924d6b8d1Devang Patelprotected:
297e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
298ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel  // If a FunctionPass F is the last user of ModulePass info M
299e16634065021e36ae31f074f623a636924d6b8d1Devang Patel  // then the F's manager, not F, records itself as a last user of M.
300ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel  // Current pass manage is requesting parent manager to record parent
301ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel  // manager as the last user of these TrransferLastUses passes.
302ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel  std::vector<Pass *> TransferLastUses;
303e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
304e16634065021e36ae31f074f623a636924d6b8d1Devang Patel  // Top level manager.
305e16634065021e36ae31f074f623a636924d6b8d1Devang Patel  PMTopLevelManager *TPM;
306e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
3071554c8545651350569f08dc7370189da1a7e5814Devang Patel  // Collection of pass that are managed by this manager
3081554c8545651350569f08dc7370189da1a7e5814Devang Patel  std::vector<Pass *> PassVector;
3091554c8545651350569f08dc7370189da1a7e5814Devang Patel
31085d344b0c68048527f1ac46ba22bbc950870d3c5Devang Patelprivate:
3115770c7cd52d6a3dfd9a5815cc9153d94afc6dd31Devang Patel  // Set of available Analysis. This information is used while scheduling
3125770c7cd52d6a3dfd9a5815cc9153d94afc6dd31Devang Patel  // pass. If a pass requires an analysis which is not not available then
3135770c7cd52d6a3dfd9a5815cc9153d94afc6dd31Devang Patel  // equired analysis pass is scheduled to run before the pass itself is
3145770c7cd52d6a3dfd9a5815cc9153d94afc6dd31Devang Patel  // scheduled to run.
315b899eed1bc0a64f96fa7aff8d7c6f999cf85bdfeDevang Patel  std::map<AnalysisID, Pass*> AvailableAnalysis;
316e253385b108cd946b1ac150302f246d3b218be77Devang Patel
317f72d29c540bf32b9c0e8914484cbbdeac70ee12aDevang Patel  unsigned Depth;
31885d344b0c68048527f1ac46ba22bbc950870d3c5Devang Patel};
31985d344b0c68048527f1ac46ba22bbc950870d3c5Devang Patel
3207e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel//===----------------------------------------------------------------------===//
3213162691f69f85f740bc28f3ddca39b166d35187cDevang Patel// BasicBlockPassManager
3227e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel//
3233162691f69f85f740bc28f3ddca39b166d35187cDevang Patel/// BasicBlockPassManager manages BasicBlockPass. It batches all the
324c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel/// pass together and sequence them to process one basic block before
325c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel/// processing next basic block.
326c2ff962bf97761a54c94d2dadb555060403d49c6Devang Patelclass VISIBILITY_HIDDEN BasicBlockPassManager : public PMDataManager,
327a84b3025ca7d437d2eab22d7c3002c8d89c31858Chris Lattner                              public FunctionPass {
328c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
329c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patelpublic:
3301a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel  BasicBlockPassManager(int Depth) : PMDataManager(Depth) { }
331c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
332c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// Add a pass into a passmanager queue.
333c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  bool addPass(Pass *p);
334c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
335c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// Execute all of the passes scheduled for execution.  Keep track of
336c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// whether any of the passes modifies the function, and if so, return true.
337c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  bool runOnFunction(Function &F);
338c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
33966d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  /// Pass Manager itself does not invalidate any analysis info.
34066d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  void getAnalysisUsage(AnalysisUsage &Info) const {
34166d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel    Info.setPreservesAll();
34266d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  }
34366d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel
344964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  bool doInitialization(Module &M);
345964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  bool doInitialization(Function &F);
346964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  bool doFinalization(Module &M);
347964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  bool doFinalization(Function &F);
348964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
349ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  // Print passes managed by this manager
350ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  void dumpPassStructure(unsigned Offset) {
351c2ff962bf97761a54c94d2dadb555060403d49c6Devang Patel    llvm::cerr << std::string(Offset*2, ' ') << "BasicBlockPass Manager\n";
3521554c8545651350569f08dc7370189da1a7e5814Devang Patel    for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
3531554c8545651350569f08dc7370189da1a7e5814Devang Patel      BasicBlockPass *BP = getContainedPass(Index);
3541554c8545651350569f08dc7370189da1a7e5814Devang Patel      BP->dumpPassStructure(Offset + 1);
3551554c8545651350569f08dc7370189da1a7e5814Devang Patel      dumpLastUses(BP, Offset+1);
356ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel    }
357ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  }
3581554c8545651350569f08dc7370189da1a7e5814Devang Patel
3591554c8545651350569f08dc7370189da1a7e5814Devang Patel  BasicBlockPass *getContainedPass(unsigned N) {
3601554c8545651350569f08dc7370189da1a7e5814Devang Patel    assert ( N < PassVector.size() && "Pass number out of range!");
3611554c8545651350569f08dc7370189da1a7e5814Devang Patel    BasicBlockPass *BP = static_cast<BasicBlockPass *>(PassVector[N]);
3621554c8545651350569f08dc7370189da1a7e5814Devang Patel    return BP;
3631554c8545651350569f08dc7370189da1a7e5814Devang Patel  }
364c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel};
365c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
3667e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel//===----------------------------------------------------------------------===//
3677e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel// FunctionPassManagerImpl_New
3687e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel//
3696e9e5e026af9e26cdec634c79017199f4e718599Chris Lattner/// FunctionPassManagerImpl_New manages FunctionPasses and
3706e9e5e026af9e26cdec634c79017199f4e718599Chris Lattner/// BasicBlockPassManagers.  It batches all function passes and basic block pass
3716e9e5e026af9e26cdec634c79017199f4e718599Chris Lattner/// managers together and sequence them to process one function at a time before
3726e9e5e026af9e26cdec634c79017199f4e718599Chris Lattner/// processing next function.
373eb0d613ef6755f93610e08534a203c41ec14b56aDevang Patelclass FunctionPassManagerImpl_New : public ModulePass,
374eb0d613ef6755f93610e08534a203c41ec14b56aDevang Patel                                    public PMDataManager,
375eb0d613ef6755f93610e08534a203c41ec14b56aDevang Patel                                    public PMTopLevelManager {
376c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patelpublic:
3771a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel  FunctionPassManagerImpl_New(int Depth) : PMDataManager(Depth) {
378c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel    activeBBPassManager = NULL;
379c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  }
380c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel  ~FunctionPassManagerImpl_New() { /* TODO */ };
381c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
382eb0d613ef6755f93610e08534a203c41ec14b56aDevang Patel  inline void addTopLevelPass(Pass *P) {
383145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel
384c9a6293af7b433146d8f7ecf8fa494b530af9376Devang Patel    if (ImmutablePass *IP = dynamic_cast<ImmutablePass *> (P)) {
385145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel
386145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel      // P is a immutable pass then it will be managed by this
387145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel      // top level manager. Set up analysis resolver to connect them.
388145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel      AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
389145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel      P->setResolver(AR);
390689c683bccbb28b4d18a3dbe1b1c28ee6b90b17aDevang Patel      initializeAnalysisImpl(P);
391c9a6293af7b433146d8f7ecf8fa494b530af9376Devang Patel      addImmutablePass(IP);
392689c683bccbb28b4d18a3dbe1b1c28ee6b90b17aDevang Patel      recordAvailableAnalysis(IP);
393c9a6293af7b433146d8f7ecf8fa494b530af9376Devang Patel    }
394c9a6293af7b433146d8f7ecf8fa494b530af9376Devang Patel    else
395c9a6293af7b433146d8f7ecf8fa494b530af9376Devang Patel      addPass(P);
396eb0d613ef6755f93610e08534a203c41ec14b56aDevang Patel  }
397eb0d613ef6755f93610e08534a203c41ec14b56aDevang Patel
398c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// add - Add a pass to the queue of passes to run.  This passes
399c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// ownership of the Pass to the PassManager.  When the
400c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// PassManager_X is destroyed, the pass will be destroyed as well, so
401c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// there is no need to delete the pass. (TODO delete passes.)
402c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// This implies that all passes MUST be allocated with 'new'.
403877bfbb9ef75e7fe333d93abecaf0579780ccf54Devang Patel  void add(Pass *P) {
404e61b7478e53cea3183d4aee3799a4f0977b850a0Devang Patel    schedulePass(P);
405877bfbb9ef75e7fe333d93abecaf0579780ccf54Devang Patel  }
406c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
407c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// Add pass into the pass manager queue.
408c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  bool addPass(Pass *P);
409c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
410c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// Execute all of the passes scheduled for execution.  Keep
411c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// track of whether any of the passes modifies the function, and if
412c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// so, return true.
413c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  bool runOnModule(Module &M);
414214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel  bool runOnFunction(Function &F);
415c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel  bool run(Function &F);
416c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
4173799f97d539f6c288d169063e1b335917fafcffbDevang Patel  /// doInitialization - Run all of the initializers for the function passes.
4183799f97d539f6c288d169063e1b335917fafcffbDevang Patel  ///
4193799f97d539f6c288d169063e1b335917fafcffbDevang Patel  bool doInitialization(Module &M);
4203799f97d539f6c288d169063e1b335917fafcffbDevang Patel
4213799f97d539f6c288d169063e1b335917fafcffbDevang Patel  /// doFinalization - Run all of the initializers for the function passes.
4223799f97d539f6c288d169063e1b335917fafcffbDevang Patel  ///
4233799f97d539f6c288d169063e1b335917fafcffbDevang Patel  bool doFinalization(Module &M);
42466d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel
42566d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  /// Pass Manager itself does not invalidate any analysis info.
42666d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  void getAnalysisUsage(AnalysisUsage &Info) const {
42766d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel    Info.setPreservesAll();
42866d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  }
42966d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel
430ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  // Print passes managed by this manager
431ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  void dumpPassStructure(unsigned Offset) {
4321554c8545651350569f08dc7370189da1a7e5814Devang Patel    llvm::cerr << std::string(Offset*2, ' ') << "FunctionPass Manager 42\n";
4331554c8545651350569f08dc7370189da1a7e5814Devang Patel    for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
4341554c8545651350569f08dc7370189da1a7e5814Devang Patel      FunctionPass *FP = getContainedPass(Index);
4351554c8545651350569f08dc7370189da1a7e5814Devang Patel      FP->dumpPassStructure(Offset + 1);
4361554c8545651350569f08dc7370189da1a7e5814Devang Patel      dumpLastUses(FP, Offset+1);
437ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel    }
438ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  }
439ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel
4401554c8545651350569f08dc7370189da1a7e5814Devang Patel  FunctionPass *getContainedPass(unsigned N) {
4411554c8545651350569f08dc7370189da1a7e5814Devang Patel    assert ( N < PassVector.size() && "Pass number out of range!");
4421554c8545651350569f08dc7370189da1a7e5814Devang Patel    FunctionPass *FP = static_cast<FunctionPass *>(PassVector[N]);
4431554c8545651350569f08dc7370189da1a7e5814Devang Patel    return FP;
4441554c8545651350569f08dc7370189da1a7e5814Devang Patel  }
4451554c8545651350569f08dc7370189da1a7e5814Devang Patel
446c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patelprivate:
447c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  // Active Pass Managers
4483162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  BasicBlockPassManager *activeBBPassManager;
449c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel};
450c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
4517e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel//===----------------------------------------------------------------------===//
4523162691f69f85f740bc28f3ddca39b166d35187cDevang Patel// ModulePassManager
4537e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel//
4543162691f69f85f740bc28f3ddca39b166d35187cDevang Patel/// ModulePassManager manages ModulePasses and function pass managers.
455c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel/// It batches all Module passes  passes and function pass managers together and
456c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel/// sequence them to process one module.
457a84b3025ca7d437d2eab22d7c3002c8d89c31858Chris Lattnerclass ModulePassManager : public Pass, public PMDataManager {
458c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
459c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patelpublic:
4601a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel  ModulePassManager(int Depth) : PMDataManager(Depth) {
461f72d29c540bf32b9c0e8914484cbbdeac70ee12aDevang Patel    activeFunctionPassManager = NULL;
462f72d29c540bf32b9c0e8914484cbbdeac70ee12aDevang Patel  }
463c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
464c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// Add a pass into a passmanager queue.
465c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  bool addPass(Pass *p);
466c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
467c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// run - Execute all of the passes scheduled for execution.  Keep track of
468c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// whether any of the passes modifies the module, and if so, return true.
469c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  bool runOnModule(Module &M);
470be6d515f481756ff549f355e32be1ac398e141d5Devang Patel
47166d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  /// Pass Manager itself does not invalidate any analysis info.
47266d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  void getAnalysisUsage(AnalysisUsage &Info) const {
47366d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel    Info.setPreservesAll();
47466d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  }
47566d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel
476ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  // Print passes managed by this manager
477ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  void dumpPassStructure(unsigned Offset) {
478ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel    llvm::cerr << std::string(Offset*2, ' ') << "ModulePass Manager\n";
4791554c8545651350569f08dc7370189da1a7e5814Devang Patel    for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
4801554c8545651350569f08dc7370189da1a7e5814Devang Patel      ModulePass *MP = getContainedPass(Index);
4811554c8545651350569f08dc7370189da1a7e5814Devang Patel      MP->dumpPassStructure(Offset + 1);
4821554c8545651350569f08dc7370189da1a7e5814Devang Patel      dumpLastUses(MP, Offset+1);
483ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel    }
484ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  }
485ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel
4861554c8545651350569f08dc7370189da1a7e5814Devang Patel  ModulePass *getContainedPass(unsigned N) {
4871554c8545651350569f08dc7370189da1a7e5814Devang Patel    assert ( N < PassVector.size() && "Pass number out of range!");
4881554c8545651350569f08dc7370189da1a7e5814Devang Patel    ModulePass *MP = static_cast<ModulePass *>(PassVector[N]);
4891554c8545651350569f08dc7370189da1a7e5814Devang Patel    return MP;
4901554c8545651350569f08dc7370189da1a7e5814Devang Patel  }
4911554c8545651350569f08dc7370189da1a7e5814Devang Patel
492c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patelprivate:
493c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  // Active Pass Manager
494c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel  FunctionPassManagerImpl_New *activeFunctionPassManager;
495c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel};
496c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
4977e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel//===----------------------------------------------------------------------===//
4987e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel// PassManagerImpl_New
4997e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel//
5007e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel/// PassManagerImpl_New manages ModulePassManagers
501877bfbb9ef75e7fe333d93abecaf0579780ccf54Devang Patelclass PassManagerImpl_New : public Pass,
502877bfbb9ef75e7fe333d93abecaf0579780ccf54Devang Patel                            public PMDataManager,
503eb0d613ef6755f93610e08534a203c41ec14b56aDevang Patel                            public PMTopLevelManager {
5045a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
5055a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patelpublic:
5065a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
5071a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel  PassManagerImpl_New(int Depth) : PMDataManager(Depth) {
508395ed739849a0507a2faae0829287c039c3589f8Devang Patel    activeManager = NULL;
509395ed739849a0507a2faae0829287c039c3589f8Devang Patel  }
510f72d29c540bf32b9c0e8914484cbbdeac70ee12aDevang Patel
5115a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  /// add - Add a pass to the queue of passes to run.  This passes ownership of
5125a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  /// the Pass to the PassManager.  When the PassManager is destroyed, the pass
5135a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  /// will be destroyed as well, so there is no need to delete the pass.  This
5145a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  /// implies that all passes MUST be allocated with 'new'.
515877bfbb9ef75e7fe333d93abecaf0579780ccf54Devang Patel  void add(Pass *P) {
516e61b7478e53cea3183d4aee3799a4f0977b850a0Devang Patel    schedulePass(P);
517877bfbb9ef75e7fe333d93abecaf0579780ccf54Devang Patel  }
5185a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
5195a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  /// run - Execute all of the passes scheduled for execution.  Keep track of
5205a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  /// whether any of the passes modifies the module, and if so, return true.
5215a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  bool run(Module &M);
5225a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
52366d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  /// Pass Manager itself does not invalidate any analysis info.
52466d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  void getAnalysisUsage(AnalysisUsage &Info) const {
52566d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel    Info.setPreservesAll();
52666d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  }
52766d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel
528eb0d613ef6755f93610e08534a203c41ec14b56aDevang Patel  inline void addTopLevelPass(Pass *P) {
529145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel
530c9a6293af7b433146d8f7ecf8fa494b530af9376Devang Patel    if (ImmutablePass *IP = dynamic_cast<ImmutablePass *> (P)) {
531145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel
532145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel      // P is a immutable pass and it will be managed by this
533145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel      // top level manager. Set up analysis resolver to connect them.
534145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel      AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
535145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel      P->setResolver(AR);
536689c683bccbb28b4d18a3dbe1b1c28ee6b90b17aDevang Patel      initializeAnalysisImpl(P);
537c9a6293af7b433146d8f7ecf8fa494b530af9376Devang Patel      addImmutablePass(IP);
538689c683bccbb28b4d18a3dbe1b1c28ee6b90b17aDevang Patel      recordAvailableAnalysis(IP);
539145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel    }
540c9a6293af7b433146d8f7ecf8fa494b530af9376Devang Patel    else
541c9a6293af7b433146d8f7ecf8fa494b530af9376Devang Patel      addPass(P);
542eb0d613ef6755f93610e08534a203c41ec14b56aDevang Patel  }
543eb0d613ef6755f93610e08534a203c41ec14b56aDevang Patel
5445a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patelprivate:
5455a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
5461209f416cf2f2ec0f335d91a7c115e3b0a37d603Devang Patel  /// Add a pass into a passmanager queue.
5475a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  bool addPass(Pass *p);
5485a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
5495a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  // Active Pass Manager
5503162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  ModulePassManager *activeManager;
5515a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel};
5525a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
553c2ff962bf97761a54c94d2dadb555060403d49c6Devang Patel} // End of llvm namespace
554c2ff962bf97761a54c94d2dadb555060403d49c6Devang Patel
555c2ff962bf97761a54c94d2dadb555060403d49c6Devang Patelnamespace {
556c2ff962bf97761a54c94d2dadb555060403d49c6Devang Patel
5578e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel//===----------------------------------------------------------------------===//
5588e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel// TimingInfo Class - This class is used to calculate information about the
5598e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel// amount of time each pass takes to execute.  This only happens when
5608e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel// -time-passes is enabled on the command line.
5618e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel//
5628e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
563c2ff962bf97761a54c94d2dadb555060403d49c6Devang Patelclass VISIBILITY_HIDDEN TimingInfo {
5648e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  std::map<Pass*, Timer> TimingData;
5658e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  TimerGroup TG;
5668e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
5678e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patelpublic:
5688e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  // Use 'create' member to get this.
5698e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  TimingInfo() : TG("... Pass execution timing report ...") {}
5708e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
5718e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  // TimingDtor - Print out information about timing information
5728e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  ~TimingInfo() {
5738e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    // Delete all of the timers...
5748e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    TimingData.clear();
5758e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    // TimerGroup is deleted next, printing the report.
5768e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  }
5778e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
5788e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  // createTheTimeInfo - This method either initializes the TheTimeInfo pointer
5798e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  // to a non null value (if the -time-passes option is enabled) or it leaves it
5808e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  // null.  It may be called multiple times.
5818e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  static void createTheTimeInfo();
5828e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
5838e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  void passStarted(Pass *P) {
5848e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
5858e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    if (dynamic_cast<PMDataManager *>(P))
5868e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel      return;
5878e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
5888e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    std::map<Pass*, Timer>::iterator I = TimingData.find(P);
5898e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    if (I == TimingData.end())
5908e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel      I=TimingData.insert(std::make_pair(P, Timer(P->getPassName(), TG))).first;
5918e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    I->second.startTimer();
5928e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  }
5938e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  void passEnded(Pass *P) {
5948e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
5958e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    if (dynamic_cast<PMDataManager *>(P))
5968e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel      return;
5978e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
5988e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    std::map<Pass*, Timer>::iterator I = TimingData.find(P);
5998e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    assert (I != TimingData.end() && "passStarted/passEnded not nested right!");
6008e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    I->second.stopTimer();
6018e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  }
6028e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel};
6038e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
6048e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patelstatic TimingInfo *TheTimeInfo;
6058e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
606c2ff962bf97761a54c94d2dadb555060403d49c6Devang Patel} // End of anon namespace
607c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
60806e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel//===----------------------------------------------------------------------===//
6091b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel// PMTopLevelManager implementation
6101b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6111b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel/// Set pass P as the last user of the given analysis passes.
6121b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patelvoid PMTopLevelManager::setLastUser(std::vector<Pass *> &AnalysisPasses,
6131b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel                                    Pass *P) {
6141b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6151b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  for (std::vector<Pass *>::iterator I = AnalysisPasses.begin(),
6161b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel         E = AnalysisPasses.end(); I != E; ++I) {
6171b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    Pass *AP = *I;
6181b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    LastUser[AP] = P;
6191b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    // If AP is the last user of other passes then make P last user of
6201b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    // such passes.
6211b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
6221b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel           LUE = LastUser.end(); LUI != LUE; ++LUI) {
6231b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      if (LUI->second == AP)
6241b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel        LastUser[LUI->first] = P;
6251b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    }
6261b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  }
6271b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel}
6281b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6291b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel/// Collect passes whose last user is P
6301b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patelvoid PMTopLevelManager::collectLastUses(std::vector<Pass *> &LastUses,
6311b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel                                            Pass *P) {
6321b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel   for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
6331b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel          LUE = LastUser.end(); LUI != LUE; ++LUI)
6341b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      if (LUI->second == P)
6351b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel        LastUses.push_back(LUI->first);
6361b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel}
6371b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6381b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel/// Schedule pass P for execution. Make sure that passes required by
6391b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel/// P are run before P is run. Update analysis info maintained by
6401b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel/// the manager. Remove dead passes. This is a recursive function.
6411b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patelvoid PMTopLevelManager::schedulePass(Pass *P) {
6421b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6431b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  // TODO : Allocate function manager for this pass, other wise required set
6441b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  // may be inserted into previous function manager
6451b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6461b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  AnalysisUsage AnUsage;
6471b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  P->getAnalysisUsage(AnUsage);
6481b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
6491b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  for (std::vector<AnalysisID>::const_iterator I = RequiredSet.begin(),
6501b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel         E = RequiredSet.end(); I != E; ++I) {
6511b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6521b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    Pass *AnalysisPass = findAnalysisPass(*I);
6531b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    if (!AnalysisPass) {
6541b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      // Schedule this analysis run first.
6551b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      AnalysisPass = (*I)->createPass();
6561b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      schedulePass(AnalysisPass);
6571b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    }
6581b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  }
6591b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6601b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  // Now all required passes are available.
6611b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  addTopLevelPass(P);
6621b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel}
6631b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6641b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel/// Find the pass that implements Analysis AID. Search immutable
6651b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel/// passes and all pass managers. If desired pass is not found
6661b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel/// then return NULL.
6671b8d015066dca364a1b11b6dbe5b80248b111cd5Devang PatelPass *PMTopLevelManager::findAnalysisPass(AnalysisID AID) {
6681b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6691b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  Pass *P = NULL;
670d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel  // Check pass managers
671d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel  for (std::vector<Pass *>::iterator I = PassManagers.begin(),
672d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel         E = PassManagers.end(); P == NULL && I != E; ++I) {
673d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel    PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I);
674d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel    assert(PMD && "This is not a PassManager");
675d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel    P = PMD->findAnalysisPass(AID, false);
676d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel  }
677d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel
678d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel  // Check other pass managers
679d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel  for (std::vector<PMDataManager *>::iterator I = IndirectPassManagers.begin(),
680d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel         E = IndirectPassManagers.end(); P == NULL && I != E; ++I)
681d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel    P = (*I)->findAnalysisPass(AID, false);
682d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel
6831b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  for (std::vector<ImmutablePass *>::iterator I = ImmutablePasses.begin(),
6841b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel         E = ImmutablePasses.end(); P == NULL && I != E; ++I) {
6851b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    const PassInfo *PI = (*I)->getPassInfo();
6861b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    if (PI == AID)
6871b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      P = *I;
6881b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6891b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    // If Pass not found then check the interfaces implemented by Immutable Pass
6901b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    if (!P) {
6911a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel      const std::vector<const PassInfo*> &ImmPI = PI->getInterfacesImplemented();
6921a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel      if (std::find(ImmPI.begin(), ImmPI.end(), AID) != ImmPI.end())
6931a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel        P = *I;
6941b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    }
6951b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  }
6961b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6971b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  return P;
6981b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel}
6991b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
700ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel// Print passes managed by this top level manager.
701a52035a062edf9bfbf95c92c615219b647042c17Devang Patelvoid PMTopLevelManager::dumpPasses() const {
702ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel
703ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  // Print out the immutable passes
704ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i) {
705ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel    ImmutablePasses[i]->dumpPassStructure(0);
706ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  }
707ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel
708a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  for (std::vector<Pass *>::const_iterator I = PassManagers.begin(),
709ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel         E = PassManagers.end(); I != E; ++I)
710ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel    (*I)->dumpPassStructure(1);
711ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel}
712ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel
713a52035a062edf9bfbf95c92c615219b647042c17Devang Patelvoid PMTopLevelManager::dumpArguments() const {
714c32cf54101ecaf336d161fecd58667870149169cDevang Patel
715c32cf54101ecaf336d161fecd58667870149169cDevang Patel  if (PassDebugging_New < Arguments)
716c32cf54101ecaf336d161fecd58667870149169cDevang Patel    return;
717c32cf54101ecaf336d161fecd58667870149169cDevang Patel
718c32cf54101ecaf336d161fecd58667870149169cDevang Patel  cerr << "Pass Arguments: ";
719a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  for (std::vector<Pass *>::const_iterator I = PassManagers.begin(),
720c32cf54101ecaf336d161fecd58667870149169cDevang Patel         E = PassManagers.end(); I != E; ++I) {
721c32cf54101ecaf336d161fecd58667870149169cDevang Patel    PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I);
722c32cf54101ecaf336d161fecd58667870149169cDevang Patel    assert(PMD && "This is not a PassManager");
723c32cf54101ecaf336d161fecd58667870149169cDevang Patel    PMD->dumpPassArguments();
724c32cf54101ecaf336d161fecd58667870149169cDevang Patel  }
725c32cf54101ecaf336d161fecd58667870149169cDevang Patel  cerr << "\n";
726c32cf54101ecaf336d161fecd58667870149169cDevang Patel}
727c32cf54101ecaf336d161fecd58667870149169cDevang Patel
7281b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel//===----------------------------------------------------------------------===//
729419f0e95d698109541ad730cb45ba4caca78f458Devang Patel// PMDataManager implementation
730889739c4d188d28c167644bced9df0f3131317d7Devang Patel
7312c5d1851bbcb20adb79664ec16ab1f97b9142086Devang Patel/// Return true IFF pass P's required analysis set does not required new
732889739c4d188d28c167644bced9df0f3131317d7Devang Patel/// manager.
733419f0e95d698109541ad730cb45ba4caca78f458Devang Patelbool PMDataManager::manageablePass(Pass *P) {
734889739c4d188d28c167644bced9df0f3131317d7Devang Patel
7354045af1175509c81d6a4708df233f0b1abe888fcDevang Patel  // TODO
7364045af1175509c81d6a4708df233f0b1abe888fcDevang Patel  // If this pass is not preserving information that is required by a
7374045af1175509c81d6a4708df233f0b1abe888fcDevang Patel  // pass maintained by higher level pass manager then do not insert
7384045af1175509c81d6a4708df233f0b1abe888fcDevang Patel  // this pass into current manager. Use new manager. For example,
7394045af1175509c81d6a4708df233f0b1abe888fcDevang Patel  // For example, If FunctionPass F is not preserving ModulePass Info M1
7404045af1175509c81d6a4708df233f0b1abe888fcDevang Patel  // that is used by another ModulePass M2 then do not insert F in
7414045af1175509c81d6a4708df233f0b1abe888fcDevang Patel  // current function pass manager.
742889739c4d188d28c167644bced9df0f3131317d7Devang Patel  return true;
743889739c4d188d28c167644bced9df0f3131317d7Devang Patel}
744889739c4d188d28c167644bced9df0f3131317d7Devang Patel
745b8526162551a3fbcf787e01d82ef44b69f879e01Devang Patel/// Augement AvailableAnalysis by adding analysis made available by pass P.
746f32b4dd13e421b3ad4696f984cb2043ce64e19cbDevang Patelvoid PMDataManager::recordAvailableAnalysis(Pass *P) {
747b899eed1bc0a64f96fa7aff8d7c6f999cf85bdfeDevang Patel
748b8526162551a3fbcf787e01d82ef44b69f879e01Devang Patel  if (const PassInfo *PI = P->getPassInfo()) {
749b899eed1bc0a64f96fa7aff8d7c6f999cf85bdfeDevang Patel    AvailableAnalysis[PI] = P;
750b8526162551a3fbcf787e01d82ef44b69f879e01Devang Patel
751f32b4dd13e421b3ad4696f984cb2043ce64e19cbDevang Patel    //This pass is the current implementation of all of the interfaces it
752f32b4dd13e421b3ad4696f984cb2043ce64e19cbDevang Patel    //implements as well.
753f32b4dd13e421b3ad4696f984cb2043ce64e19cbDevang Patel    const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
754f32b4dd13e421b3ad4696f984cb2043ce64e19cbDevang Patel    for (unsigned i = 0, e = II.size(); i != e; ++i)
755f32b4dd13e421b3ad4696f984cb2043ce64e19cbDevang Patel      AvailableAnalysis[II[i]] = P;
756b8526162551a3fbcf787e01d82ef44b69f879e01Devang Patel  }
757b8526162551a3fbcf787e01d82ef44b69f879e01Devang Patel}
758b8526162551a3fbcf787e01d82ef44b69f879e01Devang Patel
759889739c4d188d28c167644bced9df0f3131317d7Devang Patel/// Remove Analyss not preserved by Pass P
760419f0e95d698109541ad730cb45ba4caca78f458Devang Patelvoid PMDataManager::removeNotPreservedAnalysis(Pass *P) {
76114d6581a7374bdb4a66ef6c30250efdc324f6ddeDevang Patel  AnalysisUsage AnUsage;
76214d6581a7374bdb4a66ef6c30250efdc324f6ddeDevang Patel  P->getAnalysisUsage(AnUsage);
76314d6581a7374bdb4a66ef6c30250efdc324f6ddeDevang Patel
76404b4e0595ffffab232a73a78d742e08efb6ebcfbDevang Patel  if (AnUsage.getPreservesAll())
76504b4e0595ffffab232a73a78d742e08efb6ebcfbDevang Patel    return;
76604b4e0595ffffab232a73a78d742e08efb6ebcfbDevang Patel
76704b4e0595ffffab232a73a78d742e08efb6ebcfbDevang Patel  const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
768b899eed1bc0a64f96fa7aff8d7c6f999cf85bdfeDevang Patel  for (std::map<AnalysisID, Pass*>::iterator I = AvailableAnalysis.begin(),
76954e247d2d0c07544b3e638e80b816f352ec152c1Devang Patel         E = AvailableAnalysis.end(); I != E; ) {
7701a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel    std::map<AnalysisID, Pass*>::iterator Info = I++;
7711a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel    if (std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) ==
77214d6581a7374bdb4a66ef6c30250efdc324f6ddeDevang Patel        PreservedSet.end()) {
77314d6581a7374bdb4a66ef6c30250efdc324f6ddeDevang Patel      // Remove this analysis
7741a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel      if (!dynamic_cast<ImmutablePass*>(Info->second))
7751a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel        AvailableAnalysis.erase(Info);
7761a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel    }
77714d6581a7374bdb4a66ef6c30250efdc324f6ddeDevang Patel  }
778889739c4d188d28c167644bced9df0f3131317d7Devang Patel}
779889739c4d188d28c167644bced9df0f3131317d7Devang Patel
780df1a10ece6a75f230d98c6fb001349eede90387aDevang Patel/// Remove analysis passes that are not used any longer
7814eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patelvoid PMDataManager::removeDeadPasses(Pass *P, std::string &Msg) {
782f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel
783f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel  std::vector<Pass *> DeadPasses;
784f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel  TPM->collectLastUses(DeadPasses, P);
785f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel
786f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel  for (std::vector<Pass *>::iterator I = DeadPasses.begin(),
787f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel         E = DeadPasses.end(); I != E; ++I) {
7884eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel
7894eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel    std::string Msg1 = "  Freeing Pass '";
7904eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel    dumpPassInfo(*I, Msg1, Msg);
7914eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel
7928e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    if (TheTimeInfo) TheTimeInfo->passStarted(P);
793f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel    (*I)->releaseMemory();
7948e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    if (TheTimeInfo) TheTimeInfo->passEnded(P);
7958e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
796f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel    std::map<AnalysisID, Pass*>::iterator Pos =
797f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel      AvailableAnalysis.find((*I)->getPassInfo());
798f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel
799964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel    // It is possible that pass is already removed from the AvailableAnalysis
800f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel    if (Pos != AvailableAnalysis.end())
801f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel      AvailableAnalysis.erase(Pos);
802f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel  }
803df1a10ece6a75f230d98c6fb001349eede90387aDevang Patel}
804df1a10ece6a75f230d98c6fb001349eede90387aDevang Patel
8054045af1175509c81d6a4708df233f0b1abe888fcDevang Patel/// Add pass P into the PassVector. Update
806893a5a681585cdf3b5bfff7128ea522e8a47750aDevang Patel/// AvailableAnalysis appropriately if ProcessAnalysis is true.
80704b4e0595ffffab232a73a78d742e08efb6ebcfbDevang Patelvoid PMDataManager::addPassToManager(Pass *P,
80804b4e0595ffffab232a73a78d742e08efb6ebcfbDevang Patel                                     bool ProcessAnalysis) {
809e253385b108cd946b1ac150302f246d3b218be77Devang Patel
810145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel  // This manager is going to manage pass P. Set up analysis resolver
811145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel  // to connect them.
812145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel  AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
813145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel  P->setResolver(AR);
814145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel
815893a5a681585cdf3b5bfff7128ea522e8a47750aDevang Patel  if (ProcessAnalysis) {
816e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
817e16634065021e36ae31f074f623a636924d6b8d1Devang Patel    // At the moment, this pass is the last user of all required passes.
818e16634065021e36ae31f074f623a636924d6b8d1Devang Patel    std::vector<Pass *> LastUses;
819e16634065021e36ae31f074f623a636924d6b8d1Devang Patel    std::vector<Pass *> RequiredPasses;
820e16634065021e36ae31f074f623a636924d6b8d1Devang Patel    unsigned PDepth = this->getDepth();
821e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
822e16634065021e36ae31f074f623a636924d6b8d1Devang Patel    collectRequiredAnalysisPasses(RequiredPasses, P);
823e16634065021e36ae31f074f623a636924d6b8d1Devang Patel    for (std::vector<Pass *>::iterator I = RequiredPasses.begin(),
824e16634065021e36ae31f074f623a636924d6b8d1Devang Patel           E = RequiredPasses.end(); I != E; ++I) {
825e16634065021e36ae31f074f623a636924d6b8d1Devang Patel      Pass *PRequired = *I;
826e16634065021e36ae31f074f623a636924d6b8d1Devang Patel      unsigned RDepth = 0;
827cd520b187a222bf99d4238590e6517e87666e39fDevang Patel
828cd520b187a222bf99d4238590e6517e87666e39fDevang Patel      PMDataManager &DM = PRequired->getResolver()->getPMDataManager();
829cd520b187a222bf99d4238590e6517e87666e39fDevang Patel      RDepth = DM.getDepth();
830cd520b187a222bf99d4238590e6517e87666e39fDevang Patel
831e16634065021e36ae31f074f623a636924d6b8d1Devang Patel      if (PDepth == RDepth)
832e16634065021e36ae31f074f623a636924d6b8d1Devang Patel        LastUses.push_back(PRequired);
833e16634065021e36ae31f074f623a636924d6b8d1Devang Patel      else if (PDepth >  RDepth) {
834e16634065021e36ae31f074f623a636924d6b8d1Devang Patel        // Let the parent claim responsibility of last use
835ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel        TransferLastUses.push_back(PRequired);
836e16634065021e36ae31f074f623a636924d6b8d1Devang Patel      } else {
837e16634065021e36ae31f074f623a636924d6b8d1Devang Patel        // Note : This feature is not yet implemented
838e16634065021e36ae31f074f623a636924d6b8d1Devang Patel        assert (0 &&
839e16634065021e36ae31f074f623a636924d6b8d1Devang Patel                "Unable to handle Pass that requires lower level Analysis pass");
840e16634065021e36ae31f074f623a636924d6b8d1Devang Patel      }
841e16634065021e36ae31f074f623a636924d6b8d1Devang Patel    }
842e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
843ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel    LastUses.push_back(P);
844ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel    TPM->setLastUser(LastUses, P);
845e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
8460ac961d9c1c511204abfb02f5c25c92da6b75eb6Devang Patel    // Take a note of analysis required and made available by this pass.
847893a5a681585cdf3b5bfff7128ea522e8a47750aDevang Patel    // Remove the analysis not preserved by this pass
848893a5a681585cdf3b5bfff7128ea522e8a47750aDevang Patel    removeNotPreservedAnalysis(P);
8490ac961d9c1c511204abfb02f5c25c92da6b75eb6Devang Patel    recordAvailableAnalysis(P);
850893a5a681585cdf3b5bfff7128ea522e8a47750aDevang Patel  }
851e253385b108cd946b1ac150302f246d3b218be77Devang Patel
852e253385b108cd946b1ac150302f246d3b218be77Devang Patel  // Add pass
853e253385b108cd946b1ac150302f246d3b218be77Devang Patel  PassVector.push_back(P);
854e253385b108cd946b1ac150302f246d3b218be77Devang Patel}
855e253385b108cd946b1ac150302f246d3b218be77Devang Patel
856c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel/// Populate RequiredPasses with the analysis pass that are required by
857c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel/// pass P.
858c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patelvoid PMDataManager::collectRequiredAnalysisPasses(std::vector<Pass *> &RP,
859c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel                                                  Pass *P) {
860c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel  AnalysisUsage AnUsage;
861c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel  P->getAnalysisUsage(AnUsage);
862c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel  const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
863c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel  for (std::vector<AnalysisID>::const_iterator
864c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel         I = RequiredSet.begin(), E = RequiredSet.end();
865c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel       I != E; ++I) {
86669867b511c732a7fac7301977bd6e880e46439f1Devang Patel    Pass *AnalysisPass = findAnalysisPass(*I, true);
867c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel    assert (AnalysisPass && "Analysis pass is not available");
868c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel    RP.push_back(AnalysisPass);
869c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel  }
87027aaab2bd3c220d8466b34f6b959f74e1caac69bDevang Patel
87127aaab2bd3c220d8466b34f6b959f74e1caac69bDevang Patel  const std::vector<AnalysisID> &IDs = AnUsage.getRequiredTransitiveSet();
87227aaab2bd3c220d8466b34f6b959f74e1caac69bDevang Patel  for (std::vector<AnalysisID>::const_iterator I = IDs.begin(),
87327aaab2bd3c220d8466b34f6b959f74e1caac69bDevang Patel         E = IDs.end(); I != E; ++I) {
87427aaab2bd3c220d8466b34f6b959f74e1caac69bDevang Patel    Pass *AnalysisPass = findAnalysisPass(*I, true);
87527aaab2bd3c220d8466b34f6b959f74e1caac69bDevang Patel    assert (AnalysisPass && "Analysis pass is not available");
87627aaab2bd3c220d8466b34f6b959f74e1caac69bDevang Patel    RP.push_back(AnalysisPass);
87727aaab2bd3c220d8466b34f6b959f74e1caac69bDevang Patel  }
878c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel}
879c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel
8802f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel// All Required analyses should be available to the pass as it runs!  Here
8812f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel// we fill in the AnalysisImpls member of the pass so that it can
8822f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel// successfully use the getAnalysis() method to retrieve the
8832f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel// implementations it needs.
8842f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel//
885419f0e95d698109541ad730cb45ba4caca78f458Devang Patelvoid PMDataManager::initializeAnalysisImpl(Pass *P) {
8863799f97d539f6c288d169063e1b335917fafcffbDevang Patel  AnalysisUsage AnUsage;
8873799f97d539f6c288d169063e1b335917fafcffbDevang Patel  P->getAnalysisUsage(AnUsage);
8882f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel
8892f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel  for (std::vector<const PassInfo *>::const_iterator
8902f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel         I = AnUsage.getRequiredSet().begin(),
8912f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel         E = AnUsage.getRequiredSet().end(); I != E; ++I) {
89269867b511c732a7fac7301977bd6e880e46439f1Devang Patel    Pass *Impl = findAnalysisPass(*I, true);
8932f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel    if (Impl == 0)
8942f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel      assert(0 && "Analysis used but not available!");
895298feadd7a547d50eb943c9ea15f6345a024bc9aDevang Patel    AnalysisResolver_New *AR = P->getResolver();
896298feadd7a547d50eb943c9ea15f6345a024bc9aDevang Patel    AR->addAnalysisImplsPair(*I, Impl);
8972f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel  }
8982f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel}
8992f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel
90069867b511c732a7fac7301977bd6e880e46439f1Devang Patel/// Find the pass that implements Analysis AID. If desired pass is not found
90169867b511c732a7fac7301977bd6e880e46439f1Devang Patel/// then return NULL.
90269867b511c732a7fac7301977bd6e880e46439f1Devang PatelPass *PMDataManager::findAnalysisPass(AnalysisID AID, bool SearchParent) {
90369867b511c732a7fac7301977bd6e880e46439f1Devang Patel
90469867b511c732a7fac7301977bd6e880e46439f1Devang Patel  // Check if AvailableAnalysis map has one entry.
90569867b511c732a7fac7301977bd6e880e46439f1Devang Patel  std::map<AnalysisID, Pass*>::const_iterator I =  AvailableAnalysis.find(AID);
90669867b511c732a7fac7301977bd6e880e46439f1Devang Patel
90769867b511c732a7fac7301977bd6e880e46439f1Devang Patel  if (I != AvailableAnalysis.end())
90869867b511c732a7fac7301977bd6e880e46439f1Devang Patel    return I->second;
90969867b511c732a7fac7301977bd6e880e46439f1Devang Patel
91069867b511c732a7fac7301977bd6e880e46439f1Devang Patel  // Search Parents through TopLevelManager
91169867b511c732a7fac7301977bd6e880e46439f1Devang Patel  if (SearchParent)
91269867b511c732a7fac7301977bd6e880e46439f1Devang Patel    return TPM->findAnalysisPass(AID);
91369867b511c732a7fac7301977bd6e880e46439f1Devang Patel
9145b640e7edc606059717fb9c2ebcd85302c97fc21Devang Patel  return NULL;
91569867b511c732a7fac7301977bd6e880e46439f1Devang Patel}
91669867b511c732a7fac7301977bd6e880e46439f1Devang Patel
917a52035a062edf9bfbf95c92c615219b647042c17Devang Patel// Print list of passes that are last used by P.
918a52035a062edf9bfbf95c92c615219b647042c17Devang Patelvoid PMDataManager::dumpLastUses(Pass *P, unsigned Offset) const{
919a52035a062edf9bfbf95c92c615219b647042c17Devang Patel
920a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  std::vector<Pass *> LUses;
921a52035a062edf9bfbf95c92c615219b647042c17Devang Patel
922a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  assert (TPM && "Top Level Manager is missing");
923a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  TPM->collectLastUses(LUses, P);
924a52035a062edf9bfbf95c92c615219b647042c17Devang Patel
925a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  for (std::vector<Pass *>::iterator I = LUses.begin(),
926a52035a062edf9bfbf95c92c615219b647042c17Devang Patel         E = LUses.end(); I != E; ++I) {
927a52035a062edf9bfbf95c92c615219b647042c17Devang Patel    llvm::cerr << "--" << std::string(Offset*2, ' ');
928a52035a062edf9bfbf95c92c615219b647042c17Devang Patel    (*I)->dumpPassStructure(0);
929a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  }
930a52035a062edf9bfbf95c92c615219b647042c17Devang Patel}
931a52035a062edf9bfbf95c92c615219b647042c17Devang Patel
932a52035a062edf9bfbf95c92c615219b647042c17Devang Patelvoid PMDataManager::dumpPassArguments() const {
933a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  for(std::vector<Pass *>::const_iterator I = PassVector.begin(),
934a52035a062edf9bfbf95c92c615219b647042c17Devang Patel        E = PassVector.end(); I != E; ++I) {
935a52035a062edf9bfbf95c92c615219b647042c17Devang Patel    if (PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I))
936a52035a062edf9bfbf95c92c615219b647042c17Devang Patel      PMD->dumpPassArguments();
937a52035a062edf9bfbf95c92c615219b647042c17Devang Patel    else
938a52035a062edf9bfbf95c92c615219b647042c17Devang Patel      if (const PassInfo *PI = (*I)->getPassInfo())
939a52035a062edf9bfbf95c92c615219b647042c17Devang Patel        if (!PI->isAnalysisGroup())
940a52035a062edf9bfbf95c92c615219b647042c17Devang Patel          cerr << " -" << PI->getPassArgument();
941a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  }
942a52035a062edf9bfbf95c92c615219b647042c17Devang Patel}
943a52035a062edf9bfbf95c92c615219b647042c17Devang Patel
944a52035a062edf9bfbf95c92c615219b647042c17Devang Patelvoid PMDataManager:: dumpPassInfo(Pass *P,  std::string &Msg1,
945a52035a062edf9bfbf95c92c615219b647042c17Devang Patel                                  std::string &Msg2) const {
946a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  if (PassDebugging_New < Executions)
947a52035a062edf9bfbf95c92c615219b647042c17Devang Patel    return;
948a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  cerr << (void*)this << std::string(getDepth()*2+1, ' ');
949a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  cerr << Msg1;
950a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  cerr << P->getPassName();
951a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  cerr << Msg2;
952a52035a062edf9bfbf95c92c615219b647042c17Devang Patel}
953a52035a062edf9bfbf95c92c615219b647042c17Devang Patel
954a52035a062edf9bfbf95c92c615219b647042c17Devang Patelvoid PMDataManager::dumpAnalysisSetInfo(const char *Msg, Pass *P,
955a52035a062edf9bfbf95c92c615219b647042c17Devang Patel                                        const std::vector<AnalysisID> &Set)
956a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  const {
957a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  if (PassDebugging_New >= Details && !Set.empty()) {
958a52035a062edf9bfbf95c92c615219b647042c17Devang Patel    cerr << (void*)P << std::string(getDepth()*2+3, ' ') << Msg << " Analyses:";
959a52035a062edf9bfbf95c92c615219b647042c17Devang Patel      for (unsigned i = 0; i != Set.size(); ++i) {
960a52035a062edf9bfbf95c92c615219b647042c17Devang Patel        if (i) cerr << ",";
961a52035a062edf9bfbf95c92c615219b647042c17Devang Patel        cerr << " " << Set[i]->getPassName();
962a52035a062edf9bfbf95c92c615219b647042c17Devang Patel      }
963a52035a062edf9bfbf95c92c615219b647042c17Devang Patel      cerr << "\n";
964a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  }
965a52035a062edf9bfbf95c92c615219b647042c17Devang Patel}
966f3dc6d9f95d4ba7756105154df4a8075bbbcf931Devang Patel
967f3dc6d9f95d4ba7756105154df4a8075bbbcf931Devang Patel//===----------------------------------------------------------------------===//
968f3dc6d9f95d4ba7756105154df4a8075bbbcf931Devang Patel// NOTE: Is this the right place to define this method ?
969f3dc6d9f95d4ba7756105154df4a8075bbbcf931Devang Patel// getAnalysisToUpdate - Return an analysis result or null if it doesn't exist
970f3dc6d9f95d4ba7756105154df4a8075bbbcf931Devang PatelPass *AnalysisResolver_New::getAnalysisToUpdate(AnalysisID ID, bool dir) const {
971f3dc6d9f95d4ba7756105154df4a8075bbbcf931Devang Patel  return PM.findAnalysisPass(ID, dir);
972f3dc6d9f95d4ba7756105154df4a8075bbbcf931Devang Patel}
973f3dc6d9f95d4ba7756105154df4a8075bbbcf931Devang Patel
97406e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel//===----------------------------------------------------------------------===//
9753162691f69f85f740bc28f3ddca39b166d35187cDevang Patel// BasicBlockPassManager implementation
97655fd43f90913676682487f89f27c756adb827f66Devang Patel
9772c5d1851bbcb20adb79664ec16ab1f97b9142086Devang Patel/// Add pass P into PassVector and return true. If this pass is not
9782c5d1851bbcb20adb79664ec16ab1f97b9142086Devang Patel/// manageable by this manager then return false.
97955fd43f90913676682487f89f27c756adb827f66Devang Patelbool
9803162691f69f85f740bc28f3ddca39b166d35187cDevang PatelBasicBlockPassManager::addPass(Pass *P) {
98155fd43f90913676682487f89f27c756adb827f66Devang Patel
98255fd43f90913676682487f89f27c756adb827f66Devang Patel  BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
98355fd43f90913676682487f89f27c756adb827f66Devang Patel  if (!BP)
98455fd43f90913676682487f89f27c756adb827f66Devang Patel    return false;
98555fd43f90913676682487f89f27c756adb827f66Devang Patel
9861a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel  // If this pass does not preserve analysis that is used by other passes
9871a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel  // managed by this manager than it is not a suitable pass for this manager.
9882c5d1851bbcb20adb79664ec16ab1f97b9142086Devang Patel  if (!manageablePass(P))
98953596b6ba5d3199621e5a6e0cdbfcde3ee710397Devang Patel    return false;
99053596b6ba5d3199621e5a6e0cdbfcde3ee710397Devang Patel
991a84b3025ca7d437d2eab22d7c3002c8d89c31858Chris Lattner  addPassToManager(BP);
99214d6581a7374bdb4a66ef6c30250efdc324f6ddeDevang Patel
99355fd43f90913676682487f89f27c756adb827f66Devang Patel  return true;
99455fd43f90913676682487f89f27c756adb827f66Devang Patel}
99555fd43f90913676682487f89f27c756adb827f66Devang Patel
99655fd43f90913676682487f89f27c756adb827f66Devang Patel/// Execute all of the passes scheduled for execution by invoking
99755fd43f90913676682487f89f27c756adb827f66Devang Patel/// runOnBasicBlock method.  Keep track of whether any of the passes modifies
99855fd43f90913676682487f89f27c756adb827f66Devang Patel/// the function, and if so, return true.
99955fd43f90913676682487f89f27c756adb827f66Devang Patelbool
10003162691f69f85f740bc28f3ddca39b166d35187cDevang PatelBasicBlockPassManager::runOnFunction(Function &F) {
100155fd43f90913676682487f89f27c756adb827f66Devang Patel
10021fbe2c9964d57b2a58235541175f069ae491a95eDevang Patel  if (F.isExternal())
10031fbe2c9964d57b2a58235541175f069ae491a95eDevang Patel    return false;
10041fbe2c9964d57b2a58235541175f069ae491a95eDevang Patel
10053b14fbe300b96c353a9abfadf481b64324f17375Devang Patel  bool Changed = doInitialization(F);
1006cbfd29d0da5810949ba66701b91c1b954122077aDevang Patel  initializeAnalysisInfo();
1007c1d6e1fc9c3a47529f417026df652f466ce67851Devang Patel
1008693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel  std::string Msg1 = "Executing Pass '";
1009693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel  std::string Msg3 = "' Made Modification '";
1010693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
101155fd43f90913676682487f89f27c756adb827f66Devang Patel  for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
10121554c8545651350569f08dc7370189da1a7e5814Devang Patel    for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
10131554c8545651350569f08dc7370189da1a7e5814Devang Patel      BasicBlockPass *BP = getContainedPass(Index);
1014017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel      AnalysisUsage AnUsage;
10151554c8545651350569f08dc7370189da1a7e5814Devang Patel      BP->getAnalysisUsage(AnUsage);
1016017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel
10174eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel      std::string Msg2 = "' on BasicBlock '" + (*I).getName() + "'...\n";
10181554c8545651350569f08dc7370189da1a7e5814Devang Patel      dumpPassInfo(BP, Msg1, Msg2);
10191554c8545651350569f08dc7370189da1a7e5814Devang Patel      dumpAnalysisSetInfo("Required", BP, AnUsage.getRequiredSet());
1020017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel
10211554c8545651350569f08dc7370189da1a7e5814Devang Patel      initializeAnalysisImpl(BP);
1022693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
10231554c8545651350569f08dc7370189da1a7e5814Devang Patel      if (TheTimeInfo) TheTimeInfo->passStarted(BP);
102455fd43f90913676682487f89f27c756adb827f66Devang Patel      Changed |= BP->runOnBasicBlock(*I);
10251554c8545651350569f08dc7370189da1a7e5814Devang Patel      if (TheTimeInfo) TheTimeInfo->passEnded(BP);
1026693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
1027693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel      if (Changed)
10281554c8545651350569f08dc7370189da1a7e5814Devang Patel        dumpPassInfo(BP, Msg3, Msg2);
10291554c8545651350569f08dc7370189da1a7e5814Devang Patel      dumpAnalysisSetInfo("Preserved", BP, AnUsage.getPreservedSet());
1030693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
10311554c8545651350569f08dc7370189da1a7e5814Devang Patel      removeNotPreservedAnalysis(BP);
10321554c8545651350569f08dc7370189da1a7e5814Devang Patel      recordAvailableAnalysis(BP);
10331554c8545651350569f08dc7370189da1a7e5814Devang Patel      removeDeadPasses(BP, Msg2);
103455fd43f90913676682487f89f27c756adb827f66Devang Patel    }
10351a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel  return Changed |= doFinalization(F);
103655fd43f90913676682487f89f27c756adb827f66Devang Patel}
103755fd43f90913676682487f89f27c756adb827f66Devang Patel
1038964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel// Implement doInitialization and doFinalization
10393162691f69f85f740bc28f3ddca39b166d35187cDevang Patelinline bool BasicBlockPassManager::doInitialization(Module &M) {
1040964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  bool Changed = false;
1041964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
10421554c8545651350569f08dc7370189da1a7e5814Devang Patel  for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
10431554c8545651350569f08dc7370189da1a7e5814Devang Patel    BasicBlockPass *BP = getContainedPass(Index);
1044964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel    Changed |= BP->doInitialization(M);
1045964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  }
1046964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
1047964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  return Changed;
1048964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel}
1049964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
10503162691f69f85f740bc28f3ddca39b166d35187cDevang Patelinline bool BasicBlockPassManager::doFinalization(Module &M) {
1051964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  bool Changed = false;
1052964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
10531554c8545651350569f08dc7370189da1a7e5814Devang Patel  for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
10541554c8545651350569f08dc7370189da1a7e5814Devang Patel    BasicBlockPass *BP = getContainedPass(Index);
1055964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel    Changed |= BP->doFinalization(M);
1056964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  }
1057964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
1058964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  return Changed;
1059964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel}
1060964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
10613162691f69f85f740bc28f3ddca39b166d35187cDevang Patelinline bool BasicBlockPassManager::doInitialization(Function &F) {
1062964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  bool Changed = false;
1063964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
10641554c8545651350569f08dc7370189da1a7e5814Devang Patel  for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
10651554c8545651350569f08dc7370189da1a7e5814Devang Patel    BasicBlockPass *BP = getContainedPass(Index);
1066964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel    Changed |= BP->doInitialization(F);
1067964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  }
1068964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
1069964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  return Changed;
1070964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel}
1071964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
10723162691f69f85f740bc28f3ddca39b166d35187cDevang Patelinline bool BasicBlockPassManager::doFinalization(Function &F) {
1073964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  bool Changed = false;
1074964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
10751554c8545651350569f08dc7370189da1a7e5814Devang Patel  for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
10761554c8545651350569f08dc7370189da1a7e5814Devang Patel    BasicBlockPass *BP = getContainedPass(Index);
1077964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel    Changed |= BP->doFinalization(F);
1078964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  }
1079964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
1080964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  return Changed;
1081964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel}
1082964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
1083964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
108406e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel//===----------------------------------------------------------------------===//
10853162691f69f85f740bc28f3ddca39b166d35187cDevang Patel// FunctionPassManager implementation
108606e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel
1087c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel/// Create new Function pass manager
10883162691f69f85f740bc28f3ddca39b166d35187cDevang PatelFunctionPassManager::FunctionPassManager(ModuleProvider *P) {
1089cc132cd9feef765fe70284183c0f997b4faa5483Devang Patel  FPM = new FunctionPassManagerImpl_New(0);
1090dff33ef8e863241193463fd0129657c5ebce4d58Devang Patel  // FPM is the top level manager.
1091dff33ef8e863241193463fd0129657c5ebce4d58Devang Patel  FPM->setTopLevelManager(FPM);
1092b920bd85adba95553568cef6a7078ee2509ab804Devang Patel
1093b920bd85adba95553568cef6a7078ee2509ab804Devang Patel  PMDataManager *PMD = dynamic_cast<PMDataManager *>(FPM);
1094b920bd85adba95553568cef6a7078ee2509ab804Devang Patel  AnalysisResolver_New *AR = new AnalysisResolver_New(*PMD);
1095b920bd85adba95553568cef6a7078ee2509ab804Devang Patel  FPM->setResolver(AR);
1096b920bd85adba95553568cef6a7078ee2509ab804Devang Patel
1097b920bd85adba95553568cef6a7078ee2509ab804Devang Patel  FPM->addPassManager(FPM);
1098cc132cd9feef765fe70284183c0f997b4faa5483Devang Patel  MP = P;
1099cc132cd9feef765fe70284183c0f997b4faa5483Devang Patel}
1100cc132cd9feef765fe70284183c0f997b4faa5483Devang Patel
11013162691f69f85f740bc28f3ddca39b166d35187cDevang PatelFunctionPassManager::~FunctionPassManager() {
11023162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  // Note : FPM maintains one entry in PassManagers vector.
11033162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  // This one entry is FPM itself. This is not ideal. One
11043162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  // alternative is have one additional layer between
11053162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  // FunctionPassManager and FunctionPassManagerImpl.
11063162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  // Meanwhile, to avoid going into infinte loop, first
11073162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  // remove FPM from its PassMangers vector.
11083162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  FPM->clearManagers();
110937a6f7966c39f69a92419d37949a94a758c29e90Devang Patel  delete FPM;
111037a6f7966c39f69a92419d37949a94a758c29e90Devang Patel}
111137a6f7966c39f69a92419d37949a94a758c29e90Devang Patel
1112c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel/// add - Add a pass to the queue of passes to run.  This passes
1113c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel/// ownership of the Pass to the PassManager.  When the
1114c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel/// PassManager_X is destroyed, the pass will be destroyed as well, so
1115c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel/// there is no need to delete the pass. (TODO delete passes.)
1116c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel/// This implies that all passes MUST be allocated with 'new'.
11173162691f69f85f740bc28f3ddca39b166d35187cDevang Patelvoid FunctionPassManager::add(Pass *P) {
1118c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel  FPM->add(P);
1119c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel}
1120c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel
1121214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel/// run - Execute all of the passes scheduled for execution.  Keep
1122214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel/// track of whether any of the passes modifies the function, and if
1123214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel/// so, return true.
1124214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel///
11253162691f69f85f740bc28f3ddca39b166d35187cDevang Patelbool FunctionPassManager::run(Function &F) {
1126214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel  std::string errstr;
1127214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel  if (MP->materializeFunction(&F, &errstr)) {
1128e81561909d128c6e2d8033cb5465a49b2596b26aBill Wendling    cerr << "Error reading bytecode file: " << errstr << "\n";
1129214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel    abort();
1130214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel  }
1131c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel  return FPM->run(F);
1132214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel}
1133214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel
1134214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel
11353799f97d539f6c288d169063e1b335917fafcffbDevang Patel/// doInitialization - Run all of the initializers for the function passes.
11363799f97d539f6c288d169063e1b335917fafcffbDevang Patel///
11373162691f69f85f740bc28f3ddca39b166d35187cDevang Patelbool FunctionPassManager::doInitialization() {
11383799f97d539f6c288d169063e1b335917fafcffbDevang Patel  return FPM->doInitialization(*MP->getModule());
11393799f97d539f6c288d169063e1b335917fafcffbDevang Patel}
11403799f97d539f6c288d169063e1b335917fafcffbDevang Patel
11413799f97d539f6c288d169063e1b335917fafcffbDevang Patel/// doFinalization - Run all of the initializers for the function passes.
11423799f97d539f6c288d169063e1b335917fafcffbDevang Patel///
11433162691f69f85f740bc28f3ddca39b166d35187cDevang Patelbool FunctionPassManager::doFinalization() {
11443799f97d539f6c288d169063e1b335917fafcffbDevang Patel  return FPM->doFinalization(*MP->getModule());
11453799f97d539f6c288d169063e1b335917fafcffbDevang Patel}
11463799f97d539f6c288d169063e1b335917fafcffbDevang Patel
114706e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel//===----------------------------------------------------------------------===//
1148c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel// FunctionPassManagerImpl_New implementation
1149448d27cd795dc273249f123444509403f4fa4facDevang Patel
1150448d27cd795dc273249f123444509403f4fa4facDevang Patel/// Add pass P into the pass manager queue. If P is a BasicBlockPass then
1151448d27cd795dc273249f123444509403f4fa4facDevang Patel/// either use it into active basic block pass manager or create new basic
1152448d27cd795dc273249f123444509403f4fa4facDevang Patel/// block pass manager to handle pass P.
1153448d27cd795dc273249f123444509403f4fa4facDevang Patelbool
1154c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang PatelFunctionPassManagerImpl_New::addPass(Pass *P) {
1155448d27cd795dc273249f123444509403f4fa4facDevang Patel
11563162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  // If P is a BasicBlockPass then use BasicBlockPassManager.
1157448d27cd795dc273249f123444509403f4fa4facDevang Patel  if (BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P)) {
1158448d27cd795dc273249f123444509403f4fa4facDevang Patel
1159badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel    if (!activeBBPassManager || !activeBBPassManager->addPass(BP)) {
1160448d27cd795dc273249f123444509403f4fa4facDevang Patel
1161badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel      // If active manager exists then clear its analysis info.
1162badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel      if (activeBBPassManager)
1163badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel        activeBBPassManager->initializeAnalysisInfo();
1164b917e38c84fa9c7c434762a0e587af63eec939e5Devang Patel
1165badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel      // Create and add new manager
1166f72d29c540bf32b9c0e8914484cbbdeac70ee12aDevang Patel      activeBBPassManager =
11673162691f69f85f740bc28f3ddca39b166d35187cDevang Patel        new BasicBlockPassManager(getDepth() + 1);
1168dff33ef8e863241193463fd0129657c5ebce4d58Devang Patel      // Inherit top level manager
1169dff33ef8e863241193463fd0129657c5ebce4d58Devang Patel      activeBBPassManager->setTopLevelManager(this->getTopLevelManager());
11701b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
11711b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      // Add new manager into current manager's list.
1172893a5a681585cdf3b5bfff7128ea522e8a47750aDevang Patel      addPassToManager(activeBBPassManager, false);
11731b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
11741b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      // Add new manager into top level manager's indirect passes list
11751b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      PMDataManager *PMD = dynamic_cast<PMDataManager *>(activeBBPassManager);
11761b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      assert (PMD && "Manager is not Pass Manager");
11771b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      TPM->addIndirectPassManager(PMD);
1178badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel
1179badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel      // Add pass into new manager. This time it must succeed.
11802c5d1851bbcb20adb79664ec16ab1f97b9142086Devang Patel      if (!activeBBPassManager->addPass(BP))
11812c5d1851bbcb20adb79664ec16ab1f97b9142086Devang Patel        assert(0 && "Unable to add Pass");
1182ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel
1183ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel      // If activeBBPassManager transfered any Last Uses then handle them here.
1184ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel      std::vector<Pass *> &TLU = activeBBPassManager->getTransferredLastUses();
1185ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel      if (!TLU.empty())
1186ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel        TPM->setLastUser(TLU, this);
1187ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel
1188448d27cd795dc273249f123444509403f4fa4facDevang Patel    }
1189e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
1190e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
1191448d27cd795dc273249f123444509403f4fa4facDevang Patel    return true;
1192448d27cd795dc273249f123444509403f4fa4facDevang Patel  }
1193448d27cd795dc273249f123444509403f4fa4facDevang Patel
1194448d27cd795dc273249f123444509403f4fa4facDevang Patel  FunctionPass *FP = dynamic_cast<FunctionPass *>(P);
1195448d27cd795dc273249f123444509403f4fa4facDevang Patel  if (!FP)
1196448d27cd795dc273249f123444509403f4fa4facDevang Patel    return false;
1197448d27cd795dc273249f123444509403f4fa4facDevang Patel
11981a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel  // If this pass does not preserve analysis that is used by other passes
11991a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel  // managed by this manager than it is not a suitable pass for this manager.
12002c5d1851bbcb20adb79664ec16ab1f97b9142086Devang Patel  if (!manageablePass(P))
120153596b6ba5d3199621e5a6e0cdbfcde3ee710397Devang Patel    return false;
120253596b6ba5d3199621e5a6e0cdbfcde3ee710397Devang Patel
1203e253385b108cd946b1ac150302f246d3b218be77Devang Patel  addPassToManager (FP);
1204badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel
1205badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel  // If active manager exists then clear its analysis info.
1206badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel  if (activeBBPassManager) {
1207badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel    activeBBPassManager->initializeAnalysisInfo();
1208badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel    activeBBPassManager = NULL;
1209badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel  }
1210badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel
1211448d27cd795dc273249f123444509403f4fa4facDevang Patel  return true;
1212448d27cd795dc273249f123444509403f4fa4facDevang Patel}
1213448d27cd795dc273249f123444509403f4fa4facDevang Patel
1214448d27cd795dc273249f123444509403f4fa4facDevang Patel/// Execute all of the passes scheduled for execution by invoking
1215448d27cd795dc273249f123444509403f4fa4facDevang Patel/// runOnFunction method.  Keep track of whether any of the passes modifies
1216448d27cd795dc273249f123444509403f4fa4facDevang Patel/// the function, and if so, return true.
1217214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patelbool FunctionPassManagerImpl_New::runOnModule(Module &M) {
1218448d27cd795dc273249f123444509403f4fa4facDevang Patel
12194d9a186b10dacf1d702ef32c2638e9016d8f483bDevang Patel  bool Changed = doInitialization(M);
1220cbfd29d0da5810949ba66701b91c1b954122077aDevang Patel  initializeAnalysisInfo();
1221c1d6e1fc9c3a47529f417026df652f466ce67851Devang Patel
1222448d27cd795dc273249f123444509403f4fa4facDevang Patel  for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
122397856ceeab2297e09c46c2390f7b3d818df6f1f7Devang Patel    this->runOnFunction(*I);
122497856ceeab2297e09c46c2390f7b3d818df6f1f7Devang Patel
12251a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel  return Changed |= doFinalization(M);
1226448d27cd795dc273249f123444509403f4fa4facDevang Patel}
1227448d27cd795dc273249f123444509403f4fa4facDevang Patel
1228214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel/// Execute all of the passes scheduled for execution by invoking
1229214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel/// runOnFunction method.  Keep track of whether any of the passes modifies
1230214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel/// the function, and if so, return true.
1231214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patelbool FunctionPassManagerImpl_New::runOnFunction(Function &F) {
1232214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel
1233214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel  bool Changed = false;
12341fbe2c9964d57b2a58235541175f069ae491a95eDevang Patel
12351fbe2c9964d57b2a58235541175f069ae491a95eDevang Patel  if (F.isExternal())
12361fbe2c9964d57b2a58235541175f069ae491a95eDevang Patel    return false;
12371fbe2c9964d57b2a58235541175f069ae491a95eDevang Patel
1238cbfd29d0da5810949ba66701b91c1b954122077aDevang Patel  initializeAnalysisInfo();
1239214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel
1240693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel  std::string Msg1 = "Executing Pass '";
1241693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel  std::string Msg3 = "' Made Modification '";
1242693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
12431554c8545651350569f08dc7370189da1a7e5814Devang Patel  for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
12441554c8545651350569f08dc7370189da1a7e5814Devang Patel    FunctionPass *FP = getContainedPass(Index);
12451554c8545651350569f08dc7370189da1a7e5814Devang Patel
1246017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel    AnalysisUsage AnUsage;
12471554c8545651350569f08dc7370189da1a7e5814Devang Patel    FP->getAnalysisUsage(AnUsage);
1248693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
12494eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel    std::string Msg2 = "' on Function '" + F.getName() + "'...\n";
12501554c8545651350569f08dc7370189da1a7e5814Devang Patel    dumpPassInfo(FP, Msg1, Msg2);
12511554c8545651350569f08dc7370189da1a7e5814Devang Patel    dumpAnalysisSetInfo("Required", FP, AnUsage.getRequiredSet());
1252693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
12531554c8545651350569f08dc7370189da1a7e5814Devang Patel    initializeAnalysisImpl(FP);
12548e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
12551554c8545651350569f08dc7370189da1a7e5814Devang Patel    if (TheTimeInfo) TheTimeInfo->passStarted(FP);
1256214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel    Changed |= FP->runOnFunction(F);
12571554c8545651350569f08dc7370189da1a7e5814Devang Patel    if (TheTimeInfo) TheTimeInfo->passEnded(FP);
1258693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
1259693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel    if (Changed)
12601554c8545651350569f08dc7370189da1a7e5814Devang Patel      dumpPassInfo(FP, Msg3, Msg2);
12611554c8545651350569f08dc7370189da1a7e5814Devang Patel    dumpAnalysisSetInfo("Preserved", FP, AnUsage.getPreservedSet());
1262693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
12631554c8545651350569f08dc7370189da1a7e5814Devang Patel    removeNotPreservedAnalysis(FP);
12641554c8545651350569f08dc7370189da1a7e5814Devang Patel    recordAvailableAnalysis(FP);
12651554c8545651350569f08dc7370189da1a7e5814Devang Patel    removeDeadPasses(FP, Msg2);
1266214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel  }
1267214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel  return Changed;
1268214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel}
1269214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel
1270214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel
12713799f97d539f6c288d169063e1b335917fafcffbDevang Patelinline bool FunctionPassManagerImpl_New::doInitialization(Module &M) {
12723799f97d539f6c288d169063e1b335917fafcffbDevang Patel  bool Changed = false;
12733799f97d539f6c288d169063e1b335917fafcffbDevang Patel
12741554c8545651350569f08dc7370189da1a7e5814Devang Patel  for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
12751554c8545651350569f08dc7370189da1a7e5814Devang Patel    FunctionPass *FP = getContainedPass(Index);
12763799f97d539f6c288d169063e1b335917fafcffbDevang Patel    Changed |= FP->doInitialization(M);
12773799f97d539f6c288d169063e1b335917fafcffbDevang Patel  }
12783799f97d539f6c288d169063e1b335917fafcffbDevang Patel
12793799f97d539f6c288d169063e1b335917fafcffbDevang Patel  return Changed;
12803799f97d539f6c288d169063e1b335917fafcffbDevang Patel}
12813799f97d539f6c288d169063e1b335917fafcffbDevang Patel
12823799f97d539f6c288d169063e1b335917fafcffbDevang Patelinline bool FunctionPassManagerImpl_New::doFinalization(Module &M) {
12833799f97d539f6c288d169063e1b335917fafcffbDevang Patel  bool Changed = false;
12843799f97d539f6c288d169063e1b335917fafcffbDevang Patel
12851554c8545651350569f08dc7370189da1a7e5814Devang Patel  for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
12861554c8545651350569f08dc7370189da1a7e5814Devang Patel    FunctionPass *FP = getContainedPass(Index);
12873799f97d539f6c288d169063e1b335917fafcffbDevang Patel    Changed |= FP->doFinalization(M);
12883799f97d539f6c288d169063e1b335917fafcffbDevang Patel  }
12893799f97d539f6c288d169063e1b335917fafcffbDevang Patel
12903799f97d539f6c288d169063e1b335917fafcffbDevang Patel  return Changed;
12913799f97d539f6c288d169063e1b335917fafcffbDevang Patel}
12923799f97d539f6c288d169063e1b335917fafcffbDevang Patel
1293c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel// Execute all the passes managed by this top level manager.
1294c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel// Return true if any function is modified by a pass.
1295c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patelbool FunctionPassManagerImpl_New::run(Function &F) {
1296c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel
1297c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel  bool Changed = false;
1298c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel  for (std::vector<Pass *>::iterator I = passManagersBegin(),
1299c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel         E = passManagersEnd(); I != E; ++I) {
13003162691f69f85f740bc28f3ddca39b166d35187cDevang Patel    FunctionPassManagerImpl_New *FP =
13013162691f69f85f740bc28f3ddca39b166d35187cDevang Patel      dynamic_cast<FunctionPassManagerImpl_New *>(*I);
1302c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel    Changed |= FP->runOnFunction(F);
1303c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel  }
1304c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel  return Changed;
1305c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel}
1306c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel
130706e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel//===----------------------------------------------------------------------===//
130892c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel// ModulePassManager implementation
130992c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel
131092c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel/// Add P into pass vector if it is manageble. If P is a FunctionPass
1311c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel/// then use FunctionPassManagerImpl_New to manage it. Return false if P
131292c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel/// is not manageable by this manager.
131392c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patelbool
13143162691f69f85f740bc28f3ddca39b166d35187cDevang PatelModulePassManager::addPass(Pass *P) {
131592c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel
131692c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel  // If P is FunctionPass then use function pass maanager.
131792c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel  if (FunctionPass *FP = dynamic_cast<FunctionPass*>(P)) {
131892c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel
131969867b511c732a7fac7301977bd6e880e46439f1Devang Patel    if (!activeFunctionPassManager || !activeFunctionPassManager->addPass(P)) {
132092c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel
1321badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel      // If active manager exists then clear its analysis info.
1322badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel      if (activeFunctionPassManager)
1323badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel        activeFunctionPassManager->initializeAnalysisInfo();
1324b917e38c84fa9c7c434762a0e587af63eec939e5Devang Patel
1325badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel      // Create and add new manager
1326f72d29c540bf32b9c0e8914484cbbdeac70ee12aDevang Patel      activeFunctionPassManager =
1327f72d29c540bf32b9c0e8914484cbbdeac70ee12aDevang Patel        new FunctionPassManagerImpl_New(getDepth() + 1);
13281b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
13291b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      // Add new manager into current manager's list
1330893a5a681585cdf3b5bfff7128ea522e8a47750aDevang Patel      addPassToManager(activeFunctionPassManager, false);
13311b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
1332dff33ef8e863241193463fd0129657c5ebce4d58Devang Patel      // Inherit top level manager
1333dff33ef8e863241193463fd0129657c5ebce4d58Devang Patel      activeFunctionPassManager->setTopLevelManager(this->getTopLevelManager());
13341b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
13351b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      // Add new manager into top level manager's indirect passes list
13366e9e5e026af9e26cdec634c79017199f4e718599Chris Lattner      PMDataManager *PMD =
13376e9e5e026af9e26cdec634c79017199f4e718599Chris Lattner        dynamic_cast<PMDataManager *>(activeFunctionPassManager);
13386e9e5e026af9e26cdec634c79017199f4e718599Chris Lattner      assert(PMD && "Manager is not Pass Manager");
13391b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      TPM->addIndirectPassManager(PMD);
1340591b1b7526ed9c099de23cc995853a250c20502fDevang Patel
1341badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel      // Add pass into new manager. This time it must succeed.
13422c5d1851bbcb20adb79664ec16ab1f97b9142086Devang Patel      if (!activeFunctionPassManager->addPass(FP))
13432c5d1851bbcb20adb79664ec16ab1f97b9142086Devang Patel        assert(0 && "Unable to add pass");
1344e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
1345ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel      // If activeFunctionPassManager transfered any Last Uses then
1346ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel      // handle them here.
1347ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel      std::vector<Pass *> &TLU =
1348ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel        activeFunctionPassManager->getTransferredLastUses();
1349ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel      if (!TLU.empty())
1350ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel        TPM->setLastUser(TLU, this);
1351ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel    }
1352e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
135392c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel    return true;
135492c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel  }
135592c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel
135692c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel  ModulePass *MP = dynamic_cast<ModulePass *>(P);
135792c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel  if (!MP)
135892c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel    return false;
135992c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel
13601a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel  // If this pass does not preserve analysis that is used by other passes
13611a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel  // managed by this manager than it is not a suitable pass for this manager.
13622c5d1851bbcb20adb79664ec16ab1f97b9142086Devang Patel  if (!manageablePass(P))
136353596b6ba5d3199621e5a6e0cdbfcde3ee710397Devang Patel    return false;
136453596b6ba5d3199621e5a6e0cdbfcde3ee710397Devang Patel
1365e253385b108cd946b1ac150302f246d3b218be77Devang Patel  addPassToManager(MP);
1366badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel  // If active manager exists then clear its analysis info.
1367badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel  if (activeFunctionPassManager) {
1368badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel    activeFunctionPassManager->initializeAnalysisInfo();
1369badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel    activeFunctionPassManager = NULL;
1370badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel  }
1371badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel
137292c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel  return true;
137392c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel}
137492c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel
137592c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel
137692c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel/// Execute all of the passes scheduled for execution by invoking
137792c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel/// runOnModule method.  Keep track of whether any of the passes modifies
137892c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel/// the module, and if so, return true.
137992c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patelbool
13803162691f69f85f740bc28f3ddca39b166d35187cDevang PatelModulePassManager::runOnModule(Module &M) {
138192c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel  bool Changed = false;
1382cbfd29d0da5810949ba66701b91c1b954122077aDevang Patel  initializeAnalysisInfo();
1383c1d6e1fc9c3a47529f417026df652f466ce67851Devang Patel
1384693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel  std::string Msg1 = "Executing Pass '";
1385693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel  std::string Msg3 = "' Made Modification '";
1386693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
13871554c8545651350569f08dc7370189da1a7e5814Devang Patel  for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
13881554c8545651350569f08dc7370189da1a7e5814Devang Patel    ModulePass *MP = getContainedPass(Index);
13891554c8545651350569f08dc7370189da1a7e5814Devang Patel
1390017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel    AnalysisUsage AnUsage;
13911554c8545651350569f08dc7370189da1a7e5814Devang Patel    MP->getAnalysisUsage(AnUsage);
1392693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
13934eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel    std::string Msg2 = "' on Module '" + M.getModuleIdentifier() + "'...\n";
13941554c8545651350569f08dc7370189da1a7e5814Devang Patel    dumpPassInfo(MP, Msg1, Msg2);
13951554c8545651350569f08dc7370189da1a7e5814Devang Patel    dumpAnalysisSetInfo("Required", MP, AnUsage.getRequiredSet());
1396693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
13971554c8545651350569f08dc7370189da1a7e5814Devang Patel    initializeAnalysisImpl(MP);
13988e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
13991554c8545651350569f08dc7370189da1a7e5814Devang Patel    if (TheTimeInfo) TheTimeInfo->passStarted(MP);
140092c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel    Changed |= MP->runOnModule(M);
14011554c8545651350569f08dc7370189da1a7e5814Devang Patel    if (TheTimeInfo) TheTimeInfo->passEnded(MP);
1402693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
1403693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel    if (Changed)
14041554c8545651350569f08dc7370189da1a7e5814Devang Patel      dumpPassInfo(MP, Msg3, Msg2);
14051554c8545651350569f08dc7370189da1a7e5814Devang Patel    dumpAnalysisSetInfo("Preserved", MP, AnUsage.getPreservedSet());
1406017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel
14071554c8545651350569f08dc7370189da1a7e5814Devang Patel    removeNotPreservedAnalysis(MP);
14081554c8545651350569f08dc7370189da1a7e5814Devang Patel    recordAvailableAnalysis(MP);
14091554c8545651350569f08dc7370189da1a7e5814Devang Patel    removeDeadPasses(MP, Msg2);
141092c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel  }
141192c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel  return Changed;
141292c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel}
141392c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel
141406e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel//===----------------------------------------------------------------------===//
141506e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel// PassManagerImpl implementation
141637a6f7966c39f69a92419d37949a94a758c29e90Devang Patel//
1417b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel/// Add P into active pass manager or use new module pass manager to
1418b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel/// manage it.
1419f8af6f0ec15d117cfe47bf32dd4e46ab52d42254Devang Patelbool PassManagerImpl_New::addPass(Pass *P) {
1420b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel
1421a363a0bdefd2e798a83acd8998591b5b07c4256eDevang Patel  if (!activeManager || !activeManager->addPass(P)) {
14223162691f69f85f740bc28f3ddca39b166d35187cDevang Patel    activeManager = new ModulePassManager(getDepth() + 1);
1423dff33ef8e863241193463fd0129657c5ebce4d58Devang Patel    // Inherit top level manager
1424dff33ef8e863241193463fd0129657c5ebce4d58Devang Patel    activeManager->setTopLevelManager(this->getTopLevelManager());
1425145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel
1426145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel    // This top level manager is going to manage activeManager.
1427145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel    // Set up analysis resolver to connect them.
1428145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel    AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
1429145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel    activeManager->setResolver(AR);
1430145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel
1431a083e94f7971ddafb817b1bcd86992d9fc4d8f9eDevang Patel    addPassManager(activeManager);
1432502f19e0f8ba47b5916a7e9d445f4ee071cdf132Devang Patel    return activeManager->addPass(P);
1433b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel  }
1434502f19e0f8ba47b5916a7e9d445f4ee071cdf132Devang Patel  return true;
1435b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel}
1436b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel
1437b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel/// run - Execute all of the passes scheduled for execution.  Keep track of
1438b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel/// whether any of the passes modifies the module, and if so, return true.
1439f8af6f0ec15d117cfe47bf32dd4e46ab52d42254Devang Patelbool PassManagerImpl_New::run(Module &M) {
1440b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel
1441b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel  bool Changed = false;
144245dc02d6f97447785ee7ffe08c36a34bc8921b0bDevang Patel
14438e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  TimingInfo::createTheTimeInfo();
14448e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
1445c32cf54101ecaf336d161fecd58667870149169cDevang Patel  dumpArguments();
1446e8ff1ce7343c697ff90d940c8c5fa8fccc09220dDevang Patel  if (PassDebugging_New >= Structure)
144745dc02d6f97447785ee7ffe08c36a34bc8921b0bDevang Patel    dumpPasses();
144845dc02d6f97447785ee7ffe08c36a34bc8921b0bDevang Patel
1449a083e94f7971ddafb817b1bcd86992d9fc4d8f9eDevang Patel  for (std::vector<Pass *>::iterator I = passManagersBegin(),
1450a083e94f7971ddafb817b1bcd86992d9fc4d8f9eDevang Patel         E = passManagersEnd(); I != E; ++I) {
14513162691f69f85f740bc28f3ddca39b166d35187cDevang Patel    ModulePassManager *MP = dynamic_cast<ModulePassManager *>(*I);
1452a083e94f7971ddafb817b1bcd86992d9fc4d8f9eDevang Patel    Changed |= MP->runOnModule(M);
1453b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel  }
1454b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel  return Changed;
1455b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel}
14565a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
145706e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel//===----------------------------------------------------------------------===//
145806e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel// PassManager implementation
145906e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel
14605a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel/// Create new pass manager
14613162691f69f85f740bc28f3ddca39b166d35187cDevang PatelPassManager::PassManager() {
1462f72d29c540bf32b9c0e8914484cbbdeac70ee12aDevang Patel  PM = new PassManagerImpl_New(0);
1463dff33ef8e863241193463fd0129657c5ebce4d58Devang Patel  // PM is the top level manager
1464dff33ef8e863241193463fd0129657c5ebce4d58Devang Patel  PM->setTopLevelManager(PM);
14655a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel}
14665a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
14673162691f69f85f740bc28f3ddca39b166d35187cDevang PatelPassManager::~PassManager() {
146837a6f7966c39f69a92419d37949a94a758c29e90Devang Patel  delete PM;
146937a6f7966c39f69a92419d37949a94a758c29e90Devang Patel}
147037a6f7966c39f69a92419d37949a94a758c29e90Devang Patel
14715a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel/// add - Add a pass to the queue of passes to run.  This passes ownership of
14725a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel/// the Pass to the PassManager.  When the PassManager is destroyed, the pass
14735a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel/// will be destroyed as well, so there is no need to delete the pass.  This
14745a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel/// implies that all passes MUST be allocated with 'new'.
14755a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patelvoid
14763162691f69f85f740bc28f3ddca39b166d35187cDevang PatelPassManager::add(Pass *P) {
14775a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  PM->add(P);
14785a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel}
14795a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
14805a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel/// run - Execute all of the passes scheduled for execution.  Keep track of
14815a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel/// whether any of the passes modifies the module, and if so, return true.
14825a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patelbool
14833162691f69f85f740bc28f3ddca39b166d35187cDevang PatelPassManager::run(Module &M) {
14845a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  return PM->run(M);
14855a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel}
14865a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
14878e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel//===----------------------------------------------------------------------===//
14888e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel// TimingInfo Class - This class is used to calculate information about the
14898e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel// amount of time each pass takes to execute.  This only happens with
14908e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel// -time-passes is enabled on the command line.
14918e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel//
14928e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patelbool llvm::TimePassesIsEnabled = false;
14938e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patelstatic cl::opt<bool,true>
14948e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang PatelEnableTiming("time-passes", cl::location(TimePassesIsEnabled),
14958e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel            cl::desc("Time each pass, printing elapsed time for each on exit"));
14968e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
14978e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel// createTheTimeInfo - This method either initializes the TheTimeInfo pointer to
14988e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel// a non null value (if the -time-passes option is enabled) or it leaves it
14998e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel// null.  It may be called multiple times.
15008e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patelvoid TimingInfo::createTheTimeInfo() {
15018e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  if (!TimePassesIsEnabled || TheTimeInfo) return;
15028e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
15038e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  // Constructed the first time this is called, iff -time-passes is enabled.
15048e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  // This guarantees that the object will be constructed before static globals,
15058e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  // thus it will be destroyed before them.
15068e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  static ManagedStatic<TimingInfo> TTI;
15078e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  TheTimeInfo = &*TTI;
15088e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel}
15098e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
15103162691f69f85f740bc28f3ddca39b166d35187cDevang Patel#endif
1511