PassManager.cpp revision 1a8038636c2998e37f2130b0ab89a3686d9c1f48
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
275e253385b108cd946b1ac150302f246d3b218be77Devang Patel  inline std::vector<Pass *>::iterator passVectorBegin() {
276e253385b108cd946b1ac150302f246d3b218be77Devang Patel    return PassVector.begin();
277e253385b108cd946b1ac150302f246d3b218be77Devang Patel  }
278e253385b108cd946b1ac150302f246d3b218be77Devang Patel
279e253385b108cd946b1ac150302f246d3b218be77Devang Patel  inline std::vector<Pass *>::iterator passVectorEnd() {
280e253385b108cd946b1ac150302f246d3b218be77Devang Patel    return PassVector.end();
281e253385b108cd946b1ac150302f246d3b218be77Devang Patel  }
282e253385b108cd946b1ac150302f246d3b218be77Devang Patel
283dc48f203cdc5a0b8f79d28bab6219161061fd73bDevang Patel  // Access toplevel manager
284dc48f203cdc5a0b8f79d28bab6219161061fd73bDevang Patel  PMTopLevelManager *getTopLevelManager() { return TPM; }
285dc48f203cdc5a0b8f79d28bab6219161061fd73bDevang Patel  void setTopLevelManager(PMTopLevelManager *T) { TPM = T; }
286dc48f203cdc5a0b8f79d28bab6219161061fd73bDevang Patel
287a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  unsigned getDepth() const { return Depth; }
2884eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel
289a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  // Print routines used by debug-pass
290a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  void dumpLastUses(Pass *P, unsigned Offset) const;
291a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  void dumpPassArguments() const;
292a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  void dumpPassInfo(Pass *P,  std::string &Msg1, std::string &Msg2) const;
293017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel  void dumpAnalysisSetInfo(const char *Msg, Pass *P,
294a52035a062edf9bfbf95c92c615219b647042c17Devang Patel                           const std::vector<AnalysisID> &Set) const;
295ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel
296ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel  std::vector<Pass *>& getTransferredLastUses() {
297ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel    return TransferLastUses;
298ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel  }
299ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel
300e16634065021e36ae31f074f623a636924d6b8d1Devang Patelprotected:
301e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
302ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel  // If a FunctionPass F is the last user of ModulePass info M
303e16634065021e36ae31f074f623a636924d6b8d1Devang Patel  // then the F's manager, not F, records itself as a last user of M.
304ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel  // Current pass manage is requesting parent manager to record parent
305ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel  // manager as the last user of these TrransferLastUses passes.
306ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel  std::vector<Pass *> TransferLastUses;
307e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
308e16634065021e36ae31f074f623a636924d6b8d1Devang Patel  // Top level manager.
309e16634065021e36ae31f074f623a636924d6b8d1Devang Patel  PMTopLevelManager *TPM;
310e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
31185d344b0c68048527f1ac46ba22bbc950870d3c5Devang Patelprivate:
3125770c7cd52d6a3dfd9a5815cc9153d94afc6dd31Devang Patel  // Set of available Analysis. This information is used while scheduling
3135770c7cd52d6a3dfd9a5815cc9153d94afc6dd31Devang Patel  // pass. If a pass requires an analysis which is not not available then
3145770c7cd52d6a3dfd9a5815cc9153d94afc6dd31Devang Patel  // equired analysis pass is scheduled to run before the pass itself is
3155770c7cd52d6a3dfd9a5815cc9153d94afc6dd31Devang Patel  // scheduled to run.
316b899eed1bc0a64f96fa7aff8d7c6f999cf85bdfeDevang Patel  std::map<AnalysisID, Pass*> AvailableAnalysis;
317e253385b108cd946b1ac150302f246d3b218be77Devang Patel
318e253385b108cd946b1ac150302f246d3b218be77Devang Patel  // Collection of pass that are managed by this manager
319e253385b108cd946b1ac150302f246d3b218be77Devang Patel  std::vector<Pass *> PassVector;
320dc48f203cdc5a0b8f79d28bab6219161061fd73bDevang Patel
321f72d29c540bf32b9c0e8914484cbbdeac70ee12aDevang Patel  unsigned Depth;
32285d344b0c68048527f1ac46ba22bbc950870d3c5Devang Patel};
32385d344b0c68048527f1ac46ba22bbc950870d3c5Devang Patel
3247e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel//===----------------------------------------------------------------------===//
3253162691f69f85f740bc28f3ddca39b166d35187cDevang Patel// BasicBlockPassManager
3267e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel//
3273162691f69f85f740bc28f3ddca39b166d35187cDevang Patel/// BasicBlockPassManager manages BasicBlockPass. It batches all the
328c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel/// pass together and sequence them to process one basic block before
329c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel/// processing next basic block.
330c2ff962bf97761a54c94d2dadb555060403d49c6Devang Patelclass VISIBILITY_HIDDEN BasicBlockPassManager : public PMDataManager,
331a84b3025ca7d437d2eab22d7c3002c8d89c31858Chris Lattner                              public FunctionPass {
332c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
333c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patelpublic:
3341a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel  BasicBlockPassManager(int Depth) : PMDataManager(Depth) { }
335c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
336c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// Add a pass into a passmanager queue.
337c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  bool addPass(Pass *p);
338c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
339c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// Execute all of the passes scheduled for execution.  Keep track of
340c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// whether any of the passes modifies the function, and if so, return true.
341c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  bool runOnFunction(Function &F);
342c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
34366d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  /// Pass Manager itself does not invalidate any analysis info.
34466d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  void getAnalysisUsage(AnalysisUsage &Info) const {
34566d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel    Info.setPreservesAll();
34666d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  }
34766d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel
348964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  bool doInitialization(Module &M);
349964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  bool doInitialization(Function &F);
350964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  bool doFinalization(Module &M);
351964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  bool doFinalization(Function &F);
352964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
353ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  // Print passes managed by this manager
354ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  void dumpPassStructure(unsigned Offset) {
355c2ff962bf97761a54c94d2dadb555060403d49c6Devang Patel    llvm::cerr << std::string(Offset*2, ' ') << "BasicBlockPass Manager\n";
356ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel    for (std::vector<Pass *>::iterator I = passVectorBegin(),
357ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel           E = passVectorEnd(); I != E; ++I)  {
358ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel      (*I)->dumpPassStructure(Offset + 1);
359ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel      dumpLastUses(*I, Offset+1);
360ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel    }
361ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  }
362c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel};
363c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
3647e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel//===----------------------------------------------------------------------===//
3657e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel// FunctionPassManagerImpl_New
3667e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel//
3676e9e5e026af9e26cdec634c79017199f4e718599Chris Lattner/// FunctionPassManagerImpl_New manages FunctionPasses and
3686e9e5e026af9e26cdec634c79017199f4e718599Chris Lattner/// BasicBlockPassManagers.  It batches all function passes and basic block pass
3696e9e5e026af9e26cdec634c79017199f4e718599Chris Lattner/// managers together and sequence them to process one function at a time before
3706e9e5e026af9e26cdec634c79017199f4e718599Chris Lattner/// processing next function.
371eb0d613ef6755f93610e08534a203c41ec14b56aDevang Patelclass FunctionPassManagerImpl_New : public ModulePass,
372eb0d613ef6755f93610e08534a203c41ec14b56aDevang Patel                                    public PMDataManager,
373eb0d613ef6755f93610e08534a203c41ec14b56aDevang Patel                                    public PMTopLevelManager {
374c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patelpublic:
3751a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel  FunctionPassManagerImpl_New(int Depth) : PMDataManager(Depth) {
376c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel    activeBBPassManager = NULL;
377c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  }
378c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel  ~FunctionPassManagerImpl_New() { /* TODO */ };
379c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
380eb0d613ef6755f93610e08534a203c41ec14b56aDevang Patel  inline void addTopLevelPass(Pass *P) {
381145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel
382c9a6293af7b433146d8f7ecf8fa494b530af9376Devang Patel    if (ImmutablePass *IP = dynamic_cast<ImmutablePass *> (P)) {
383145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel
384145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel      // P is a immutable pass then it will be managed by this
385145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel      // top level manager. Set up analysis resolver to connect them.
386145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel      AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
387145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel      P->setResolver(AR);
388689c683bccbb28b4d18a3dbe1b1c28ee6b90b17aDevang Patel      initializeAnalysisImpl(P);
389c9a6293af7b433146d8f7ecf8fa494b530af9376Devang Patel      addImmutablePass(IP);
390689c683bccbb28b4d18a3dbe1b1c28ee6b90b17aDevang Patel      recordAvailableAnalysis(IP);
391c9a6293af7b433146d8f7ecf8fa494b530af9376Devang Patel    }
392c9a6293af7b433146d8f7ecf8fa494b530af9376Devang Patel    else
393c9a6293af7b433146d8f7ecf8fa494b530af9376Devang Patel      addPass(P);
394eb0d613ef6755f93610e08534a203c41ec14b56aDevang Patel  }
395eb0d613ef6755f93610e08534a203c41ec14b56aDevang Patel
396c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// add - Add a pass to the queue of passes to run.  This passes
397c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// ownership of the Pass to the PassManager.  When the
398c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// PassManager_X is destroyed, the pass will be destroyed as well, so
399c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// there is no need to delete the pass. (TODO delete passes.)
400c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// This implies that all passes MUST be allocated with 'new'.
401877bfbb9ef75e7fe333d93abecaf0579780ccf54Devang Patel  void add(Pass *P) {
402e61b7478e53cea3183d4aee3799a4f0977b850a0Devang Patel    schedulePass(P);
403877bfbb9ef75e7fe333d93abecaf0579780ccf54Devang Patel  }
404c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
405c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// Add pass into the pass manager queue.
406c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  bool addPass(Pass *P);
407c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
408c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// Execute all of the passes scheduled for execution.  Keep
409c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// track of whether any of the passes modifies the function, and if
410c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// so, return true.
411c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  bool runOnModule(Module &M);
412214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel  bool runOnFunction(Function &F);
413c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel  bool run(Function &F);
414c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
4153799f97d539f6c288d169063e1b335917fafcffbDevang Patel  /// doInitialization - Run all of the initializers for the function passes.
4163799f97d539f6c288d169063e1b335917fafcffbDevang Patel  ///
4173799f97d539f6c288d169063e1b335917fafcffbDevang Patel  bool doInitialization(Module &M);
4183799f97d539f6c288d169063e1b335917fafcffbDevang Patel
4193799f97d539f6c288d169063e1b335917fafcffbDevang Patel  /// doFinalization - Run all of the initializers for the function passes.
4203799f97d539f6c288d169063e1b335917fafcffbDevang Patel  ///
4213799f97d539f6c288d169063e1b335917fafcffbDevang Patel  bool doFinalization(Module &M);
42266d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel
42366d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  /// Pass Manager itself does not invalidate any analysis info.
42466d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  void getAnalysisUsage(AnalysisUsage &Info) const {
42566d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel    Info.setPreservesAll();
42666d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  }
42766d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel
428ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  // Print passes managed by this manager
429ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  void dumpPassStructure(unsigned Offset) {
430ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel    llvm::cerr << std::string(Offset*2, ' ') << "FunctionPass Manager\n";
431ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel    for (std::vector<Pass *>::iterator I = passVectorBegin(),
432ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel           E = passVectorEnd(); I != E; ++I)  {
433ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel      (*I)->dumpPassStructure(Offset + 1);
434ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel      dumpLastUses(*I, Offset+1);
435ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel    }
436ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  }
437ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel
438c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patelprivate:
439c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  // Active Pass Managers
4403162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  BasicBlockPassManager *activeBBPassManager;
441c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel};
442c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
4437e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel//===----------------------------------------------------------------------===//
4443162691f69f85f740bc28f3ddca39b166d35187cDevang Patel// ModulePassManager
4457e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel//
4463162691f69f85f740bc28f3ddca39b166d35187cDevang Patel/// ModulePassManager manages ModulePasses and function pass managers.
447c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel/// It batches all Module passes  passes and function pass managers together and
448c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel/// sequence them to process one module.
449a84b3025ca7d437d2eab22d7c3002c8d89c31858Chris Lattnerclass ModulePassManager : public Pass, public PMDataManager {
450c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
451c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patelpublic:
4521a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel  ModulePassManager(int Depth) : PMDataManager(Depth) {
453f72d29c540bf32b9c0e8914484cbbdeac70ee12aDevang Patel    activeFunctionPassManager = NULL;
454f72d29c540bf32b9c0e8914484cbbdeac70ee12aDevang Patel  }
455c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
456c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// Add a pass into a passmanager queue.
457c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  bool addPass(Pass *p);
458c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
459c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// run - Execute all of the passes scheduled for execution.  Keep track of
460c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// whether any of the passes modifies the module, and if so, return true.
461c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  bool runOnModule(Module &M);
462be6d515f481756ff549f355e32be1ac398e141d5Devang Patel
46366d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  /// Pass Manager itself does not invalidate any analysis info.
46466d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  void getAnalysisUsage(AnalysisUsage &Info) const {
46566d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel    Info.setPreservesAll();
46666d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  }
46766d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel
468ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  // Print passes managed by this manager
469ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  void dumpPassStructure(unsigned Offset) {
470ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel    llvm::cerr << std::string(Offset*2, ' ') << "ModulePass Manager\n";
471ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel    for (std::vector<Pass *>::iterator I = passVectorBegin(),
472ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel           E = passVectorEnd(); I != E; ++I)  {
473ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel      (*I)->dumpPassStructure(Offset + 1);
474ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel      dumpLastUses(*I, Offset+1);
475ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel    }
476ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  }
477ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel
478c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patelprivate:
479c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  // Active Pass Manager
480c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel  FunctionPassManagerImpl_New *activeFunctionPassManager;
481c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel};
482c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
4837e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel//===----------------------------------------------------------------------===//
4847e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel// PassManagerImpl_New
4857e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel//
4867e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel/// PassManagerImpl_New manages ModulePassManagers
487877bfbb9ef75e7fe333d93abecaf0579780ccf54Devang Patelclass PassManagerImpl_New : public Pass,
488877bfbb9ef75e7fe333d93abecaf0579780ccf54Devang Patel                            public PMDataManager,
489eb0d613ef6755f93610e08534a203c41ec14b56aDevang Patel                            public PMTopLevelManager {
4905a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
4915a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patelpublic:
4925a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
4931a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel  PassManagerImpl_New(int Depth) : PMDataManager(Depth) {
494395ed739849a0507a2faae0829287c039c3589f8Devang Patel    activeManager = NULL;
495395ed739849a0507a2faae0829287c039c3589f8Devang Patel  }
496f72d29c540bf32b9c0e8914484cbbdeac70ee12aDevang Patel
4975a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  /// add - Add a pass to the queue of passes to run.  This passes ownership of
4985a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  /// the Pass to the PassManager.  When the PassManager is destroyed, the pass
4995a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  /// will be destroyed as well, so there is no need to delete the pass.  This
5005a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  /// implies that all passes MUST be allocated with 'new'.
501877bfbb9ef75e7fe333d93abecaf0579780ccf54Devang Patel  void add(Pass *P) {
502e61b7478e53cea3183d4aee3799a4f0977b850a0Devang Patel    schedulePass(P);
503877bfbb9ef75e7fe333d93abecaf0579780ccf54Devang Patel  }
5045a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
5055a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  /// run - Execute all of the passes scheduled for execution.  Keep track of
5065a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  /// whether any of the passes modifies the module, and if so, return true.
5075a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  bool run(Module &M);
5085a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
50966d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  /// Pass Manager itself does not invalidate any analysis info.
51066d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  void getAnalysisUsage(AnalysisUsage &Info) const {
51166d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel    Info.setPreservesAll();
51266d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  }
51366d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel
514eb0d613ef6755f93610e08534a203c41ec14b56aDevang Patel  inline void addTopLevelPass(Pass *P) {
515145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel
516c9a6293af7b433146d8f7ecf8fa494b530af9376Devang Patel    if (ImmutablePass *IP = dynamic_cast<ImmutablePass *> (P)) {
517145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel
518145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel      // P is a immutable pass and it will be managed by this
519145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel      // top level manager. Set up analysis resolver to connect them.
520145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel      AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
521145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel      P->setResolver(AR);
522689c683bccbb28b4d18a3dbe1b1c28ee6b90b17aDevang Patel      initializeAnalysisImpl(P);
523c9a6293af7b433146d8f7ecf8fa494b530af9376Devang Patel      addImmutablePass(IP);
524689c683bccbb28b4d18a3dbe1b1c28ee6b90b17aDevang Patel      recordAvailableAnalysis(IP);
525145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel    }
526c9a6293af7b433146d8f7ecf8fa494b530af9376Devang Patel    else
527c9a6293af7b433146d8f7ecf8fa494b530af9376Devang Patel      addPass(P);
528eb0d613ef6755f93610e08534a203c41ec14b56aDevang Patel  }
529eb0d613ef6755f93610e08534a203c41ec14b56aDevang Patel
5305a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patelprivate:
5315a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
5321209f416cf2f2ec0f335d91a7c115e3b0a37d603Devang Patel  /// Add a pass into a passmanager queue.
5335a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  bool addPass(Pass *p);
5345a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
5355a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  // Active Pass Manager
5363162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  ModulePassManager *activeManager;
5375a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel};
5385a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
539c2ff962bf97761a54c94d2dadb555060403d49c6Devang Patel} // End of llvm namespace
540c2ff962bf97761a54c94d2dadb555060403d49c6Devang Patel
541c2ff962bf97761a54c94d2dadb555060403d49c6Devang Patelnamespace {
542c2ff962bf97761a54c94d2dadb555060403d49c6Devang Patel
5438e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel//===----------------------------------------------------------------------===//
5448e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel// TimingInfo Class - This class is used to calculate information about the
5458e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel// amount of time each pass takes to execute.  This only happens when
5468e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel// -time-passes is enabled on the command line.
5478e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel//
5488e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
549c2ff962bf97761a54c94d2dadb555060403d49c6Devang Patelclass VISIBILITY_HIDDEN TimingInfo {
5508e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  std::map<Pass*, Timer> TimingData;
5518e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  TimerGroup TG;
5528e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
5538e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patelpublic:
5548e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  // Use 'create' member to get this.
5558e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  TimingInfo() : TG("... Pass execution timing report ...") {}
5568e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
5578e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  // TimingDtor - Print out information about timing information
5588e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  ~TimingInfo() {
5598e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    // Delete all of the timers...
5608e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    TimingData.clear();
5618e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    // TimerGroup is deleted next, printing the report.
5628e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  }
5638e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
5648e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  // createTheTimeInfo - This method either initializes the TheTimeInfo pointer
5658e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  // to a non null value (if the -time-passes option is enabled) or it leaves it
5668e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  // null.  It may be called multiple times.
5678e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  static void createTheTimeInfo();
5688e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
5698e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  void passStarted(Pass *P) {
5708e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
5718e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    if (dynamic_cast<PMDataManager *>(P))
5728e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel      return;
5738e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
5748e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    std::map<Pass*, Timer>::iterator I = TimingData.find(P);
5758e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    if (I == TimingData.end())
5768e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel      I=TimingData.insert(std::make_pair(P, Timer(P->getPassName(), TG))).first;
5778e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    I->second.startTimer();
5788e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  }
5798e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  void passEnded(Pass *P) {
5808e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
5818e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    if (dynamic_cast<PMDataManager *>(P))
5828e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel      return;
5838e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
5848e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    std::map<Pass*, Timer>::iterator I = TimingData.find(P);
5858e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    assert (I != TimingData.end() && "passStarted/passEnded not nested right!");
5868e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    I->second.stopTimer();
5878e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  }
5888e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel};
5898e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
5908e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patelstatic TimingInfo *TheTimeInfo;
5918e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
592c2ff962bf97761a54c94d2dadb555060403d49c6Devang Patel} // End of anon namespace
593c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
59406e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel//===----------------------------------------------------------------------===//
5951b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel// PMTopLevelManager implementation
5961b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
5971b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel/// Set pass P as the last user of the given analysis passes.
5981b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patelvoid PMTopLevelManager::setLastUser(std::vector<Pass *> &AnalysisPasses,
5991b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel                                    Pass *P) {
6001b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6011b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  for (std::vector<Pass *>::iterator I = AnalysisPasses.begin(),
6021b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel         E = AnalysisPasses.end(); I != E; ++I) {
6031b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    Pass *AP = *I;
6041b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    LastUser[AP] = P;
6051b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    // If AP is the last user of other passes then make P last user of
6061b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    // such passes.
6071b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
6081b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel           LUE = LastUser.end(); LUI != LUE; ++LUI) {
6091b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      if (LUI->second == AP)
6101b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel        LastUser[LUI->first] = P;
6111b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    }
6121b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  }
6131b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel}
6141b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6151b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel/// Collect passes whose last user is P
6161b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patelvoid PMTopLevelManager::collectLastUses(std::vector<Pass *> &LastUses,
6171b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel                                            Pass *P) {
6181b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel   for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
6191b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel          LUE = LastUser.end(); LUI != LUE; ++LUI)
6201b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      if (LUI->second == P)
6211b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel        LastUses.push_back(LUI->first);
6221b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel}
6231b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6241b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel/// Schedule pass P for execution. Make sure that passes required by
6251b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel/// P are run before P is run. Update analysis info maintained by
6261b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel/// the manager. Remove dead passes. This is a recursive function.
6271b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patelvoid PMTopLevelManager::schedulePass(Pass *P) {
6281b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6291b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  // TODO : Allocate function manager for this pass, other wise required set
6301b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  // may be inserted into previous function manager
6311b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6321b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  AnalysisUsage AnUsage;
6331b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  P->getAnalysisUsage(AnUsage);
6341b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
6351b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  for (std::vector<AnalysisID>::const_iterator I = RequiredSet.begin(),
6361b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel         E = RequiredSet.end(); I != E; ++I) {
6371b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6381b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    Pass *AnalysisPass = findAnalysisPass(*I);
6391b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    if (!AnalysisPass) {
6401b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      // Schedule this analysis run first.
6411b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      AnalysisPass = (*I)->createPass();
6421b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      schedulePass(AnalysisPass);
6431b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    }
6441b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  }
6451b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6461b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  // Now all required passes are available.
6471b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  addTopLevelPass(P);
6481b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel}
6491b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6501b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel/// Find the pass that implements Analysis AID. Search immutable
6511b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel/// passes and all pass managers. If desired pass is not found
6521b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel/// then return NULL.
6531b8d015066dca364a1b11b6dbe5b80248b111cd5Devang PatelPass *PMTopLevelManager::findAnalysisPass(AnalysisID AID) {
6541b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6551b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  Pass *P = NULL;
656d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel  // Check pass managers
657d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel  for (std::vector<Pass *>::iterator I = PassManagers.begin(),
658d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel         E = PassManagers.end(); P == NULL && I != E; ++I) {
659d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel    PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I);
660d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel    assert(PMD && "This is not a PassManager");
661d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel    P = PMD->findAnalysisPass(AID, false);
662d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel  }
663d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel
664d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel  // Check other pass managers
665d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel  for (std::vector<PMDataManager *>::iterator I = IndirectPassManagers.begin(),
666d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel         E = IndirectPassManagers.end(); P == NULL && I != E; ++I)
667d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel    P = (*I)->findAnalysisPass(AID, false);
668d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel
6691b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  for (std::vector<ImmutablePass *>::iterator I = ImmutablePasses.begin(),
6701b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel         E = ImmutablePasses.end(); P == NULL && I != E; ++I) {
6711b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    const PassInfo *PI = (*I)->getPassInfo();
6721b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    if (PI == AID)
6731b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      P = *I;
6741b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6751b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    // If Pass not found then check the interfaces implemented by Immutable Pass
6761b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    if (!P) {
6771a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel      const std::vector<const PassInfo*> &ImmPI = PI->getInterfacesImplemented();
6781a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel      if (std::find(ImmPI.begin(), ImmPI.end(), AID) != ImmPI.end())
6791a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel        P = *I;
6801b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    }
6811b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  }
6821b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6831b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  return P;
6841b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel}
6851b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
686ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel// Print passes managed by this top level manager.
687a52035a062edf9bfbf95c92c615219b647042c17Devang Patelvoid PMTopLevelManager::dumpPasses() const {
688ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel
689ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  // Print out the immutable passes
690ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i) {
691ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel    ImmutablePasses[i]->dumpPassStructure(0);
692ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  }
693ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel
694a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  for (std::vector<Pass *>::const_iterator I = PassManagers.begin(),
695ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel         E = PassManagers.end(); I != E; ++I)
696ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel    (*I)->dumpPassStructure(1);
697ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel}
698ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel
699a52035a062edf9bfbf95c92c615219b647042c17Devang Patelvoid PMTopLevelManager::dumpArguments() const {
700c32cf54101ecaf336d161fecd58667870149169cDevang Patel
701c32cf54101ecaf336d161fecd58667870149169cDevang Patel  if (PassDebugging_New < Arguments)
702c32cf54101ecaf336d161fecd58667870149169cDevang Patel    return;
703c32cf54101ecaf336d161fecd58667870149169cDevang Patel
704c32cf54101ecaf336d161fecd58667870149169cDevang Patel  cerr << "Pass Arguments: ";
705a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  for (std::vector<Pass *>::const_iterator I = PassManagers.begin(),
706c32cf54101ecaf336d161fecd58667870149169cDevang Patel         E = PassManagers.end(); I != E; ++I) {
707c32cf54101ecaf336d161fecd58667870149169cDevang Patel    PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I);
708c32cf54101ecaf336d161fecd58667870149169cDevang Patel    assert(PMD && "This is not a PassManager");
709c32cf54101ecaf336d161fecd58667870149169cDevang Patel    PMD->dumpPassArguments();
710c32cf54101ecaf336d161fecd58667870149169cDevang Patel  }
711c32cf54101ecaf336d161fecd58667870149169cDevang Patel  cerr << "\n";
712c32cf54101ecaf336d161fecd58667870149169cDevang Patel}
713c32cf54101ecaf336d161fecd58667870149169cDevang Patel
7141b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel//===----------------------------------------------------------------------===//
715419f0e95d698109541ad730cb45ba4caca78f458Devang Patel// PMDataManager implementation
716889739c4d188d28c167644bced9df0f3131317d7Devang Patel
7172c5d1851bbcb20adb79664ec16ab1f97b9142086Devang Patel/// Return true IFF pass P's required analysis set does not required new
718889739c4d188d28c167644bced9df0f3131317d7Devang Patel/// manager.
719419f0e95d698109541ad730cb45ba4caca78f458Devang Patelbool PMDataManager::manageablePass(Pass *P) {
720889739c4d188d28c167644bced9df0f3131317d7Devang Patel
7214045af1175509c81d6a4708df233f0b1abe888fcDevang Patel  // TODO
7224045af1175509c81d6a4708df233f0b1abe888fcDevang Patel  // If this pass is not preserving information that is required by a
7234045af1175509c81d6a4708df233f0b1abe888fcDevang Patel  // pass maintained by higher level pass manager then do not insert
7244045af1175509c81d6a4708df233f0b1abe888fcDevang Patel  // this pass into current manager. Use new manager. For example,
7254045af1175509c81d6a4708df233f0b1abe888fcDevang Patel  // For example, If FunctionPass F is not preserving ModulePass Info M1
7264045af1175509c81d6a4708df233f0b1abe888fcDevang Patel  // that is used by another ModulePass M2 then do not insert F in
7274045af1175509c81d6a4708df233f0b1abe888fcDevang Patel  // current function pass manager.
728889739c4d188d28c167644bced9df0f3131317d7Devang Patel  return true;
729889739c4d188d28c167644bced9df0f3131317d7Devang Patel}
730889739c4d188d28c167644bced9df0f3131317d7Devang Patel
731b8526162551a3fbcf787e01d82ef44b69f879e01Devang Patel/// Augement AvailableAnalysis by adding analysis made available by pass P.
732f32b4dd13e421b3ad4696f984cb2043ce64e19cbDevang Patelvoid PMDataManager::recordAvailableAnalysis(Pass *P) {
733b899eed1bc0a64f96fa7aff8d7c6f999cf85bdfeDevang Patel
734b8526162551a3fbcf787e01d82ef44b69f879e01Devang Patel  if (const PassInfo *PI = P->getPassInfo()) {
735b899eed1bc0a64f96fa7aff8d7c6f999cf85bdfeDevang Patel    AvailableAnalysis[PI] = P;
736b8526162551a3fbcf787e01d82ef44b69f879e01Devang Patel
737f32b4dd13e421b3ad4696f984cb2043ce64e19cbDevang Patel    //This pass is the current implementation of all of the interfaces it
738f32b4dd13e421b3ad4696f984cb2043ce64e19cbDevang Patel    //implements as well.
739f32b4dd13e421b3ad4696f984cb2043ce64e19cbDevang Patel    const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
740f32b4dd13e421b3ad4696f984cb2043ce64e19cbDevang Patel    for (unsigned i = 0, e = II.size(); i != e; ++i)
741f32b4dd13e421b3ad4696f984cb2043ce64e19cbDevang Patel      AvailableAnalysis[II[i]] = P;
742b8526162551a3fbcf787e01d82ef44b69f879e01Devang Patel  }
743b8526162551a3fbcf787e01d82ef44b69f879e01Devang Patel}
744b8526162551a3fbcf787e01d82ef44b69f879e01Devang Patel
745889739c4d188d28c167644bced9df0f3131317d7Devang Patel/// Remove Analyss not preserved by Pass P
746419f0e95d698109541ad730cb45ba4caca78f458Devang Patelvoid PMDataManager::removeNotPreservedAnalysis(Pass *P) {
74714d6581a7374bdb4a66ef6c30250efdc324f6ddeDevang Patel  AnalysisUsage AnUsage;
74814d6581a7374bdb4a66ef6c30250efdc324f6ddeDevang Patel  P->getAnalysisUsage(AnUsage);
74914d6581a7374bdb4a66ef6c30250efdc324f6ddeDevang Patel
75004b4e0595ffffab232a73a78d742e08efb6ebcfbDevang Patel  if (AnUsage.getPreservesAll())
75104b4e0595ffffab232a73a78d742e08efb6ebcfbDevang Patel    return;
75204b4e0595ffffab232a73a78d742e08efb6ebcfbDevang Patel
75304b4e0595ffffab232a73a78d742e08efb6ebcfbDevang Patel  const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
754b899eed1bc0a64f96fa7aff8d7c6f999cf85bdfeDevang Patel  for (std::map<AnalysisID, Pass*>::iterator I = AvailableAnalysis.begin(),
75554e247d2d0c07544b3e638e80b816f352ec152c1Devang Patel         E = AvailableAnalysis.end(); I != E; ) {
7561a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel    std::map<AnalysisID, Pass*>::iterator Info = I++;
7571a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel    if (std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) ==
75814d6581a7374bdb4a66ef6c30250efdc324f6ddeDevang Patel        PreservedSet.end()) {
75914d6581a7374bdb4a66ef6c30250efdc324f6ddeDevang Patel      // Remove this analysis
7601a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel      if (!dynamic_cast<ImmutablePass*>(Info->second))
7611a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel        AvailableAnalysis.erase(Info);
7621a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel    }
76314d6581a7374bdb4a66ef6c30250efdc324f6ddeDevang Patel  }
764889739c4d188d28c167644bced9df0f3131317d7Devang Patel}
765889739c4d188d28c167644bced9df0f3131317d7Devang Patel
766df1a10ece6a75f230d98c6fb001349eede90387aDevang Patel/// Remove analysis passes that are not used any longer
7674eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patelvoid PMDataManager::removeDeadPasses(Pass *P, std::string &Msg) {
768f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel
769f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel  std::vector<Pass *> DeadPasses;
770f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel  TPM->collectLastUses(DeadPasses, P);
771f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel
772f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel  for (std::vector<Pass *>::iterator I = DeadPasses.begin(),
773f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel         E = DeadPasses.end(); I != E; ++I) {
7744eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel
7754eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel    std::string Msg1 = "  Freeing Pass '";
7764eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel    dumpPassInfo(*I, Msg1, Msg);
7774eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel
7788e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    if (TheTimeInfo) TheTimeInfo->passStarted(P);
779f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel    (*I)->releaseMemory();
7808e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    if (TheTimeInfo) TheTimeInfo->passEnded(P);
7818e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
782f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel    std::map<AnalysisID, Pass*>::iterator Pos =
783f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel      AvailableAnalysis.find((*I)->getPassInfo());
784f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel
785964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel    // It is possible that pass is already removed from the AvailableAnalysis
786f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel    if (Pos != AvailableAnalysis.end())
787f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel      AvailableAnalysis.erase(Pos);
788f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel  }
789df1a10ece6a75f230d98c6fb001349eede90387aDevang Patel}
790df1a10ece6a75f230d98c6fb001349eede90387aDevang Patel
7914045af1175509c81d6a4708df233f0b1abe888fcDevang Patel/// Add pass P into the PassVector. Update
792893a5a681585cdf3b5bfff7128ea522e8a47750aDevang Patel/// AvailableAnalysis appropriately if ProcessAnalysis is true.
79304b4e0595ffffab232a73a78d742e08efb6ebcfbDevang Patelvoid PMDataManager::addPassToManager(Pass *P,
79404b4e0595ffffab232a73a78d742e08efb6ebcfbDevang Patel                                     bool ProcessAnalysis) {
795e253385b108cd946b1ac150302f246d3b218be77Devang Patel
796145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel  // This manager is going to manage pass P. Set up analysis resolver
797145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel  // to connect them.
798145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel  AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
799145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel  P->setResolver(AR);
800145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel
801893a5a681585cdf3b5bfff7128ea522e8a47750aDevang Patel  if (ProcessAnalysis) {
802e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
803e16634065021e36ae31f074f623a636924d6b8d1Devang Patel    // At the moment, this pass is the last user of all required passes.
804e16634065021e36ae31f074f623a636924d6b8d1Devang Patel    std::vector<Pass *> LastUses;
805e16634065021e36ae31f074f623a636924d6b8d1Devang Patel    std::vector<Pass *> RequiredPasses;
806e16634065021e36ae31f074f623a636924d6b8d1Devang Patel    unsigned PDepth = this->getDepth();
807e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
808e16634065021e36ae31f074f623a636924d6b8d1Devang Patel    collectRequiredAnalysisPasses(RequiredPasses, P);
809e16634065021e36ae31f074f623a636924d6b8d1Devang Patel    for (std::vector<Pass *>::iterator I = RequiredPasses.begin(),
810e16634065021e36ae31f074f623a636924d6b8d1Devang Patel           E = RequiredPasses.end(); I != E; ++I) {
811e16634065021e36ae31f074f623a636924d6b8d1Devang Patel      Pass *PRequired = *I;
812e16634065021e36ae31f074f623a636924d6b8d1Devang Patel      unsigned RDepth = 0;
813cd520b187a222bf99d4238590e6517e87666e39fDevang Patel
814cd520b187a222bf99d4238590e6517e87666e39fDevang Patel      PMDataManager &DM = PRequired->getResolver()->getPMDataManager();
815cd520b187a222bf99d4238590e6517e87666e39fDevang Patel      RDepth = DM.getDepth();
816cd520b187a222bf99d4238590e6517e87666e39fDevang Patel
817e16634065021e36ae31f074f623a636924d6b8d1Devang Patel      if (PDepth == RDepth)
818e16634065021e36ae31f074f623a636924d6b8d1Devang Patel        LastUses.push_back(PRequired);
819e16634065021e36ae31f074f623a636924d6b8d1Devang Patel      else if (PDepth >  RDepth) {
820e16634065021e36ae31f074f623a636924d6b8d1Devang Patel        // Let the parent claim responsibility of last use
821ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel        TransferLastUses.push_back(PRequired);
822e16634065021e36ae31f074f623a636924d6b8d1Devang Patel      } else {
823e16634065021e36ae31f074f623a636924d6b8d1Devang Patel        // Note : This feature is not yet implemented
824e16634065021e36ae31f074f623a636924d6b8d1Devang Patel        assert (0 &&
825e16634065021e36ae31f074f623a636924d6b8d1Devang Patel                "Unable to handle Pass that requires lower level Analysis pass");
826e16634065021e36ae31f074f623a636924d6b8d1Devang Patel      }
827e16634065021e36ae31f074f623a636924d6b8d1Devang Patel    }
828e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
829ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel    LastUses.push_back(P);
830ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel    TPM->setLastUser(LastUses, P);
831e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
8320ac961d9c1c511204abfb02f5c25c92da6b75eb6Devang Patel    // Take a note of analysis required and made available by this pass.
833893a5a681585cdf3b5bfff7128ea522e8a47750aDevang Patel    // Remove the analysis not preserved by this pass
834893a5a681585cdf3b5bfff7128ea522e8a47750aDevang Patel    removeNotPreservedAnalysis(P);
8350ac961d9c1c511204abfb02f5c25c92da6b75eb6Devang Patel    recordAvailableAnalysis(P);
836893a5a681585cdf3b5bfff7128ea522e8a47750aDevang Patel  }
837e253385b108cd946b1ac150302f246d3b218be77Devang Patel
838e253385b108cd946b1ac150302f246d3b218be77Devang Patel  // Add pass
839e253385b108cd946b1ac150302f246d3b218be77Devang Patel  PassVector.push_back(P);
840e253385b108cd946b1ac150302f246d3b218be77Devang Patel}
841e253385b108cd946b1ac150302f246d3b218be77Devang Patel
842c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel/// Populate RequiredPasses with the analysis pass that are required by
843c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel/// pass P.
844c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patelvoid PMDataManager::collectRequiredAnalysisPasses(std::vector<Pass *> &RP,
845c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel                                                  Pass *P) {
846c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel  AnalysisUsage AnUsage;
847c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel  P->getAnalysisUsage(AnUsage);
848c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel  const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
849c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel  for (std::vector<AnalysisID>::const_iterator
850c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel         I = RequiredSet.begin(), E = RequiredSet.end();
851c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel       I != E; ++I) {
85269867b511c732a7fac7301977bd6e880e46439f1Devang Patel    Pass *AnalysisPass = findAnalysisPass(*I, true);
853c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel    assert (AnalysisPass && "Analysis pass is not available");
854c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel    RP.push_back(AnalysisPass);
855c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel  }
85627aaab2bd3c220d8466b34f6b959f74e1caac69bDevang Patel
85727aaab2bd3c220d8466b34f6b959f74e1caac69bDevang Patel  const std::vector<AnalysisID> &IDs = AnUsage.getRequiredTransitiveSet();
85827aaab2bd3c220d8466b34f6b959f74e1caac69bDevang Patel  for (std::vector<AnalysisID>::const_iterator I = IDs.begin(),
85927aaab2bd3c220d8466b34f6b959f74e1caac69bDevang Patel         E = IDs.end(); I != E; ++I) {
86027aaab2bd3c220d8466b34f6b959f74e1caac69bDevang Patel    Pass *AnalysisPass = findAnalysisPass(*I, true);
86127aaab2bd3c220d8466b34f6b959f74e1caac69bDevang Patel    assert (AnalysisPass && "Analysis pass is not available");
86227aaab2bd3c220d8466b34f6b959f74e1caac69bDevang Patel    RP.push_back(AnalysisPass);
86327aaab2bd3c220d8466b34f6b959f74e1caac69bDevang Patel  }
864c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel}
865c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel
8662f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel// All Required analyses should be available to the pass as it runs!  Here
8672f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel// we fill in the AnalysisImpls member of the pass so that it can
8682f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel// successfully use the getAnalysis() method to retrieve the
8692f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel// implementations it needs.
8702f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel//
871419f0e95d698109541ad730cb45ba4caca78f458Devang Patelvoid PMDataManager::initializeAnalysisImpl(Pass *P) {
8723799f97d539f6c288d169063e1b335917fafcffbDevang Patel  AnalysisUsage AnUsage;
8733799f97d539f6c288d169063e1b335917fafcffbDevang Patel  P->getAnalysisUsage(AnUsage);
8742f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel
8752f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel  for (std::vector<const PassInfo *>::const_iterator
8762f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel         I = AnUsage.getRequiredSet().begin(),
8772f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel         E = AnUsage.getRequiredSet().end(); I != E; ++I) {
87869867b511c732a7fac7301977bd6e880e46439f1Devang Patel    Pass *Impl = findAnalysisPass(*I, true);
8792f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel    if (Impl == 0)
8802f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel      assert(0 && "Analysis used but not available!");
881298feadd7a547d50eb943c9ea15f6345a024bc9aDevang Patel    AnalysisResolver_New *AR = P->getResolver();
882298feadd7a547d50eb943c9ea15f6345a024bc9aDevang Patel    AR->addAnalysisImplsPair(*I, Impl);
8832f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel  }
8842f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel}
8852f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel
88669867b511c732a7fac7301977bd6e880e46439f1Devang Patel/// Find the pass that implements Analysis AID. If desired pass is not found
88769867b511c732a7fac7301977bd6e880e46439f1Devang Patel/// then return NULL.
88869867b511c732a7fac7301977bd6e880e46439f1Devang PatelPass *PMDataManager::findAnalysisPass(AnalysisID AID, bool SearchParent) {
88969867b511c732a7fac7301977bd6e880e46439f1Devang Patel
89069867b511c732a7fac7301977bd6e880e46439f1Devang Patel  // Check if AvailableAnalysis map has one entry.
89169867b511c732a7fac7301977bd6e880e46439f1Devang Patel  std::map<AnalysisID, Pass*>::const_iterator I =  AvailableAnalysis.find(AID);
89269867b511c732a7fac7301977bd6e880e46439f1Devang Patel
89369867b511c732a7fac7301977bd6e880e46439f1Devang Patel  if (I != AvailableAnalysis.end())
89469867b511c732a7fac7301977bd6e880e46439f1Devang Patel    return I->second;
89569867b511c732a7fac7301977bd6e880e46439f1Devang Patel
89669867b511c732a7fac7301977bd6e880e46439f1Devang Patel  // Search Parents through TopLevelManager
89769867b511c732a7fac7301977bd6e880e46439f1Devang Patel  if (SearchParent)
89869867b511c732a7fac7301977bd6e880e46439f1Devang Patel    return TPM->findAnalysisPass(AID);
89969867b511c732a7fac7301977bd6e880e46439f1Devang Patel
9005b640e7edc606059717fb9c2ebcd85302c97fc21Devang Patel  return NULL;
90169867b511c732a7fac7301977bd6e880e46439f1Devang Patel}
90269867b511c732a7fac7301977bd6e880e46439f1Devang Patel
903a52035a062edf9bfbf95c92c615219b647042c17Devang Patel// Print list of passes that are last used by P.
904a52035a062edf9bfbf95c92c615219b647042c17Devang Patelvoid PMDataManager::dumpLastUses(Pass *P, unsigned Offset) const{
905a52035a062edf9bfbf95c92c615219b647042c17Devang Patel
906a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  std::vector<Pass *> LUses;
907a52035a062edf9bfbf95c92c615219b647042c17Devang Patel
908a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  assert (TPM && "Top Level Manager is missing");
909a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  TPM->collectLastUses(LUses, P);
910a52035a062edf9bfbf95c92c615219b647042c17Devang Patel
911a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  for (std::vector<Pass *>::iterator I = LUses.begin(),
912a52035a062edf9bfbf95c92c615219b647042c17Devang Patel         E = LUses.end(); I != E; ++I) {
913a52035a062edf9bfbf95c92c615219b647042c17Devang Patel    llvm::cerr << "--" << std::string(Offset*2, ' ');
914a52035a062edf9bfbf95c92c615219b647042c17Devang Patel    (*I)->dumpPassStructure(0);
915a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  }
916a52035a062edf9bfbf95c92c615219b647042c17Devang Patel}
917a52035a062edf9bfbf95c92c615219b647042c17Devang Patel
918a52035a062edf9bfbf95c92c615219b647042c17Devang Patelvoid PMDataManager::dumpPassArguments() const {
919a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  for(std::vector<Pass *>::const_iterator I = PassVector.begin(),
920a52035a062edf9bfbf95c92c615219b647042c17Devang Patel        E = PassVector.end(); I != E; ++I) {
921a52035a062edf9bfbf95c92c615219b647042c17Devang Patel    if (PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I))
922a52035a062edf9bfbf95c92c615219b647042c17Devang Patel      PMD->dumpPassArguments();
923a52035a062edf9bfbf95c92c615219b647042c17Devang Patel    else
924a52035a062edf9bfbf95c92c615219b647042c17Devang Patel      if (const PassInfo *PI = (*I)->getPassInfo())
925a52035a062edf9bfbf95c92c615219b647042c17Devang Patel        if (!PI->isAnalysisGroup())
926a52035a062edf9bfbf95c92c615219b647042c17Devang Patel          cerr << " -" << PI->getPassArgument();
927a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  }
928a52035a062edf9bfbf95c92c615219b647042c17Devang Patel}
929a52035a062edf9bfbf95c92c615219b647042c17Devang Patel
930a52035a062edf9bfbf95c92c615219b647042c17Devang Patelvoid PMDataManager:: dumpPassInfo(Pass *P,  std::string &Msg1,
931a52035a062edf9bfbf95c92c615219b647042c17Devang Patel                                  std::string &Msg2) const {
932a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  if (PassDebugging_New < Executions)
933a52035a062edf9bfbf95c92c615219b647042c17Devang Patel    return;
934a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  cerr << (void*)this << std::string(getDepth()*2+1, ' ');
935a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  cerr << Msg1;
936a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  cerr << P->getPassName();
937a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  cerr << Msg2;
938a52035a062edf9bfbf95c92c615219b647042c17Devang Patel}
939a52035a062edf9bfbf95c92c615219b647042c17Devang Patel
940a52035a062edf9bfbf95c92c615219b647042c17Devang Patelvoid PMDataManager::dumpAnalysisSetInfo(const char *Msg, Pass *P,
941a52035a062edf9bfbf95c92c615219b647042c17Devang Patel                                        const std::vector<AnalysisID> &Set)
942a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  const {
943a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  if (PassDebugging_New >= Details && !Set.empty()) {
944a52035a062edf9bfbf95c92c615219b647042c17Devang Patel    cerr << (void*)P << std::string(getDepth()*2+3, ' ') << Msg << " Analyses:";
945a52035a062edf9bfbf95c92c615219b647042c17Devang Patel      for (unsigned i = 0; i != Set.size(); ++i) {
946a52035a062edf9bfbf95c92c615219b647042c17Devang Patel        if (i) cerr << ",";
947a52035a062edf9bfbf95c92c615219b647042c17Devang Patel        cerr << " " << Set[i]->getPassName();
948a52035a062edf9bfbf95c92c615219b647042c17Devang Patel      }
949a52035a062edf9bfbf95c92c615219b647042c17Devang Patel      cerr << "\n";
950a52035a062edf9bfbf95c92c615219b647042c17Devang Patel  }
951a52035a062edf9bfbf95c92c615219b647042c17Devang Patel}
952f3dc6d9f95d4ba7756105154df4a8075bbbcf931Devang Patel
953f3dc6d9f95d4ba7756105154df4a8075bbbcf931Devang Patel//===----------------------------------------------------------------------===//
954f3dc6d9f95d4ba7756105154df4a8075bbbcf931Devang Patel// NOTE: Is this the right place to define this method ?
955f3dc6d9f95d4ba7756105154df4a8075bbbcf931Devang Patel// getAnalysisToUpdate - Return an analysis result or null if it doesn't exist
956f3dc6d9f95d4ba7756105154df4a8075bbbcf931Devang PatelPass *AnalysisResolver_New::getAnalysisToUpdate(AnalysisID ID, bool dir) const {
957f3dc6d9f95d4ba7756105154df4a8075bbbcf931Devang Patel  return PM.findAnalysisPass(ID, dir);
958f3dc6d9f95d4ba7756105154df4a8075bbbcf931Devang Patel}
959f3dc6d9f95d4ba7756105154df4a8075bbbcf931Devang Patel
96006e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel//===----------------------------------------------------------------------===//
9613162691f69f85f740bc28f3ddca39b166d35187cDevang Patel// BasicBlockPassManager implementation
96255fd43f90913676682487f89f27c756adb827f66Devang Patel
9632c5d1851bbcb20adb79664ec16ab1f97b9142086Devang Patel/// Add pass P into PassVector and return true. If this pass is not
9642c5d1851bbcb20adb79664ec16ab1f97b9142086Devang Patel/// manageable by this manager then return false.
96555fd43f90913676682487f89f27c756adb827f66Devang Patelbool
9663162691f69f85f740bc28f3ddca39b166d35187cDevang PatelBasicBlockPassManager::addPass(Pass *P) {
96755fd43f90913676682487f89f27c756adb827f66Devang Patel
96855fd43f90913676682487f89f27c756adb827f66Devang Patel  BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
96955fd43f90913676682487f89f27c756adb827f66Devang Patel  if (!BP)
97055fd43f90913676682487f89f27c756adb827f66Devang Patel    return false;
97155fd43f90913676682487f89f27c756adb827f66Devang Patel
9721a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel  // If this pass does not preserve analysis that is used by other passes
9731a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel  // managed by this manager than it is not a suitable pass for this manager.
9742c5d1851bbcb20adb79664ec16ab1f97b9142086Devang Patel  if (!manageablePass(P))
97553596b6ba5d3199621e5a6e0cdbfcde3ee710397Devang Patel    return false;
97653596b6ba5d3199621e5a6e0cdbfcde3ee710397Devang Patel
977a84b3025ca7d437d2eab22d7c3002c8d89c31858Chris Lattner  addPassToManager(BP);
97814d6581a7374bdb4a66ef6c30250efdc324f6ddeDevang Patel
97955fd43f90913676682487f89f27c756adb827f66Devang Patel  return true;
98055fd43f90913676682487f89f27c756adb827f66Devang Patel}
98155fd43f90913676682487f89f27c756adb827f66Devang Patel
98255fd43f90913676682487f89f27c756adb827f66Devang Patel/// Execute all of the passes scheduled for execution by invoking
98355fd43f90913676682487f89f27c756adb827f66Devang Patel/// runOnBasicBlock method.  Keep track of whether any of the passes modifies
98455fd43f90913676682487f89f27c756adb827f66Devang Patel/// the function, and if so, return true.
98555fd43f90913676682487f89f27c756adb827f66Devang Patelbool
9863162691f69f85f740bc28f3ddca39b166d35187cDevang PatelBasicBlockPassManager::runOnFunction(Function &F) {
98755fd43f90913676682487f89f27c756adb827f66Devang Patel
9881fbe2c9964d57b2a58235541175f069ae491a95eDevang Patel  if (F.isExternal())
9891fbe2c9964d57b2a58235541175f069ae491a95eDevang Patel    return false;
9901fbe2c9964d57b2a58235541175f069ae491a95eDevang Patel
9913b14fbe300b96c353a9abfadf481b64324f17375Devang Patel  bool Changed = doInitialization(F);
992cbfd29d0da5810949ba66701b91c1b954122077aDevang Patel  initializeAnalysisInfo();
993c1d6e1fc9c3a47529f417026df652f466ce67851Devang Patel
994693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel  std::string Msg1 = "Executing Pass '";
995693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel  std::string Msg3 = "' Made Modification '";
996693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
99755fd43f90913676682487f89f27c756adb827f66Devang Patel  for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
998e253385b108cd946b1ac150302f246d3b218be77Devang Patel    for (std::vector<Pass *>::iterator itr = passVectorBegin(),
999e253385b108cd946b1ac150302f246d3b218be77Devang Patel           e = passVectorEnd(); itr != e; ++itr) {
100055fd43f90913676682487f89f27c756adb827f66Devang Patel      Pass *P = *itr;
1001017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel      AnalysisUsage AnUsage;
1002017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel      P->getAnalysisUsage(AnUsage);
1003017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel
10044eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel      std::string Msg2 = "' on BasicBlock '" + (*I).getName() + "'...\n";
10054eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel      dumpPassInfo(P, Msg1, Msg2);
1006017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel      dumpAnalysisSetInfo("Required", P, AnUsage.getRequiredSet());
1007017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel
100841545fd66316776e670deac302672c3d9acef2a2Devang Patel      initializeAnalysisImpl(P);
1009693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
101055fd43f90913676682487f89f27c756adb827f66Devang Patel      BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
10118e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel      if (TheTimeInfo) TheTimeInfo->passStarted(P);
101255fd43f90913676682487f89f27c756adb827f66Devang Patel      Changed |= BP->runOnBasicBlock(*I);
10138e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel      if (TheTimeInfo) TheTimeInfo->passEnded(P);
1014693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
1015693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel      if (Changed)
1016693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel        dumpPassInfo(P, Msg3, Msg2);
1017017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel      dumpAnalysisSetInfo("Preserved", P, AnUsage.getPreservedSet());
1018693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
1019c1d6e1fc9c3a47529f417026df652f466ce67851Devang Patel      removeNotPreservedAnalysis(P);
10200ac961d9c1c511204abfb02f5c25c92da6b75eb6Devang Patel      recordAvailableAnalysis(P);
10214eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel      removeDeadPasses(P, Msg2);
102255fd43f90913676682487f89f27c756adb827f66Devang Patel    }
10231a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel  return Changed |= doFinalization(F);
102455fd43f90913676682487f89f27c756adb827f66Devang Patel}
102555fd43f90913676682487f89f27c756adb827f66Devang Patel
1026964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel// Implement doInitialization and doFinalization
10273162691f69f85f740bc28f3ddca39b166d35187cDevang Patelinline bool BasicBlockPassManager::doInitialization(Module &M) {
1028964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  bool Changed = false;
1029964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
1030964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1031964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel         e = passVectorEnd(); itr != e; ++itr) {
1032964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel    Pass *P = *itr;
1033964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel    BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
1034964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel    Changed |= BP->doInitialization(M);
1035964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  }
1036964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
1037964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  return Changed;
1038964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel}
1039964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
10403162691f69f85f740bc28f3ddca39b166d35187cDevang Patelinline bool BasicBlockPassManager::doFinalization(Module &M) {
1041964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  bool Changed = false;
1042964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
1043964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1044964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel         e = passVectorEnd(); itr != e; ++itr) {
1045964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel    Pass *P = *itr;
1046964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel    BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
1047964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel    Changed |= BP->doFinalization(M);
1048964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  }
1049964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
1050964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  return Changed;
1051964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel}
1052964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
10533162691f69f85f740bc28f3ddca39b166d35187cDevang Patelinline bool BasicBlockPassManager::doInitialization(Function &F) {
1054964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  bool Changed = false;
1055964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
1056964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1057964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel         e = passVectorEnd(); itr != e; ++itr) {
1058964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel    Pass *P = *itr;
1059964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel    BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
1060964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel    Changed |= BP->doInitialization(F);
1061964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  }
1062964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
1063964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  return Changed;
1064964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel}
1065964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
10663162691f69f85f740bc28f3ddca39b166d35187cDevang Patelinline bool BasicBlockPassManager::doFinalization(Function &F) {
1067964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  bool Changed = false;
1068964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
1069964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1070964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel         e = passVectorEnd(); itr != e; ++itr) {
1071964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel    Pass *P = *itr;
1072964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel    BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
1073964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel    Changed |= BP->doFinalization(F);
1074964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  }
1075964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
1076964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  return Changed;
1077964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel}
1078964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
1079964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
108006e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel//===----------------------------------------------------------------------===//
10813162691f69f85f740bc28f3ddca39b166d35187cDevang Patel// FunctionPassManager implementation
108206e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel
1083c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel/// Create new Function pass manager
10843162691f69f85f740bc28f3ddca39b166d35187cDevang PatelFunctionPassManager::FunctionPassManager(ModuleProvider *P) {
1085cc132cd9feef765fe70284183c0f997b4faa5483Devang Patel  FPM = new FunctionPassManagerImpl_New(0);
1086dff33ef8e863241193463fd0129657c5ebce4d58Devang Patel  // FPM is the top level manager.
1087dff33ef8e863241193463fd0129657c5ebce4d58Devang Patel  FPM->setTopLevelManager(FPM);
1088b920bd85adba95553568cef6a7078ee2509ab804Devang Patel
1089b920bd85adba95553568cef6a7078ee2509ab804Devang Patel  PMDataManager *PMD = dynamic_cast<PMDataManager *>(FPM);
1090b920bd85adba95553568cef6a7078ee2509ab804Devang Patel  AnalysisResolver_New *AR = new AnalysisResolver_New(*PMD);
1091b920bd85adba95553568cef6a7078ee2509ab804Devang Patel  FPM->setResolver(AR);
1092b920bd85adba95553568cef6a7078ee2509ab804Devang Patel
1093b920bd85adba95553568cef6a7078ee2509ab804Devang Patel  FPM->addPassManager(FPM);
1094cc132cd9feef765fe70284183c0f997b4faa5483Devang Patel  MP = P;
1095cc132cd9feef765fe70284183c0f997b4faa5483Devang Patel}
1096cc132cd9feef765fe70284183c0f997b4faa5483Devang Patel
10973162691f69f85f740bc28f3ddca39b166d35187cDevang PatelFunctionPassManager::~FunctionPassManager() {
10983162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  // Note : FPM maintains one entry in PassManagers vector.
10993162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  // This one entry is FPM itself. This is not ideal. One
11003162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  // alternative is have one additional layer between
11013162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  // FunctionPassManager and FunctionPassManagerImpl.
11023162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  // Meanwhile, to avoid going into infinte loop, first
11033162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  // remove FPM from its PassMangers vector.
11043162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  FPM->clearManagers();
110537a6f7966c39f69a92419d37949a94a758c29e90Devang Patel  delete FPM;
110637a6f7966c39f69a92419d37949a94a758c29e90Devang Patel}
110737a6f7966c39f69a92419d37949a94a758c29e90Devang Patel
1108c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel/// add - Add a pass to the queue of passes to run.  This passes
1109c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel/// ownership of the Pass to the PassManager.  When the
1110c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel/// PassManager_X is destroyed, the pass will be destroyed as well, so
1111c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel/// there is no need to delete the pass. (TODO delete passes.)
1112c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel/// This implies that all passes MUST be allocated with 'new'.
11133162691f69f85f740bc28f3ddca39b166d35187cDevang Patelvoid FunctionPassManager::add(Pass *P) {
1114c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel  FPM->add(P);
1115c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel}
1116c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel
1117214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel/// run - Execute all of the passes scheduled for execution.  Keep
1118214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel/// track of whether any of the passes modifies the function, and if
1119214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel/// so, return true.
1120214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel///
11213162691f69f85f740bc28f3ddca39b166d35187cDevang Patelbool FunctionPassManager::run(Function &F) {
1122214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel  std::string errstr;
1123214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel  if (MP->materializeFunction(&F, &errstr)) {
1124e81561909d128c6e2d8033cb5465a49b2596b26aBill Wendling    cerr << "Error reading bytecode file: " << errstr << "\n";
1125214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel    abort();
1126214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel  }
1127c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel  return FPM->run(F);
1128214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel}
1129214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel
1130214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel
11313799f97d539f6c288d169063e1b335917fafcffbDevang Patel/// doInitialization - Run all of the initializers for the function passes.
11323799f97d539f6c288d169063e1b335917fafcffbDevang Patel///
11333162691f69f85f740bc28f3ddca39b166d35187cDevang Patelbool FunctionPassManager::doInitialization() {
11343799f97d539f6c288d169063e1b335917fafcffbDevang Patel  return FPM->doInitialization(*MP->getModule());
11353799f97d539f6c288d169063e1b335917fafcffbDevang Patel}
11363799f97d539f6c288d169063e1b335917fafcffbDevang Patel
11373799f97d539f6c288d169063e1b335917fafcffbDevang Patel/// doFinalization - Run all of the initializers for the function passes.
11383799f97d539f6c288d169063e1b335917fafcffbDevang Patel///
11393162691f69f85f740bc28f3ddca39b166d35187cDevang Patelbool FunctionPassManager::doFinalization() {
11403799f97d539f6c288d169063e1b335917fafcffbDevang Patel  return FPM->doFinalization(*MP->getModule());
11413799f97d539f6c288d169063e1b335917fafcffbDevang Patel}
11423799f97d539f6c288d169063e1b335917fafcffbDevang Patel
114306e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel//===----------------------------------------------------------------------===//
1144c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel// FunctionPassManagerImpl_New implementation
1145448d27cd795dc273249f123444509403f4fa4facDevang Patel
1146448d27cd795dc273249f123444509403f4fa4facDevang Patel/// Add pass P into the pass manager queue. If P is a BasicBlockPass then
1147448d27cd795dc273249f123444509403f4fa4facDevang Patel/// either use it into active basic block pass manager or create new basic
1148448d27cd795dc273249f123444509403f4fa4facDevang Patel/// block pass manager to handle pass P.
1149448d27cd795dc273249f123444509403f4fa4facDevang Patelbool
1150c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang PatelFunctionPassManagerImpl_New::addPass(Pass *P) {
1151448d27cd795dc273249f123444509403f4fa4facDevang Patel
11523162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  // If P is a BasicBlockPass then use BasicBlockPassManager.
1153448d27cd795dc273249f123444509403f4fa4facDevang Patel  if (BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P)) {
1154448d27cd795dc273249f123444509403f4fa4facDevang Patel
1155badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel    if (!activeBBPassManager || !activeBBPassManager->addPass(BP)) {
1156448d27cd795dc273249f123444509403f4fa4facDevang Patel
1157badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel      // If active manager exists then clear its analysis info.
1158badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel      if (activeBBPassManager)
1159badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel        activeBBPassManager->initializeAnalysisInfo();
1160b917e38c84fa9c7c434762a0e587af63eec939e5Devang Patel
1161badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel      // Create and add new manager
1162f72d29c540bf32b9c0e8914484cbbdeac70ee12aDevang Patel      activeBBPassManager =
11633162691f69f85f740bc28f3ddca39b166d35187cDevang Patel        new BasicBlockPassManager(getDepth() + 1);
1164dff33ef8e863241193463fd0129657c5ebce4d58Devang Patel      // Inherit top level manager
1165dff33ef8e863241193463fd0129657c5ebce4d58Devang Patel      activeBBPassManager->setTopLevelManager(this->getTopLevelManager());
11661b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
11671b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      // Add new manager into current manager's list.
1168893a5a681585cdf3b5bfff7128ea522e8a47750aDevang Patel      addPassToManager(activeBBPassManager, false);
11691b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
11701b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      // Add new manager into top level manager's indirect passes list
11711b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      PMDataManager *PMD = dynamic_cast<PMDataManager *>(activeBBPassManager);
11721b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      assert (PMD && "Manager is not Pass Manager");
11731b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      TPM->addIndirectPassManager(PMD);
1174badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel
1175badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel      // Add pass into new manager. This time it must succeed.
11762c5d1851bbcb20adb79664ec16ab1f97b9142086Devang Patel      if (!activeBBPassManager->addPass(BP))
11772c5d1851bbcb20adb79664ec16ab1f97b9142086Devang Patel        assert(0 && "Unable to add Pass");
1178ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel
1179ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel      // If activeBBPassManager transfered any Last Uses then handle them here.
1180ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel      std::vector<Pass *> &TLU = activeBBPassManager->getTransferredLastUses();
1181ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel      if (!TLU.empty())
1182ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel        TPM->setLastUser(TLU, this);
1183ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel
1184448d27cd795dc273249f123444509403f4fa4facDevang Patel    }
1185e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
1186e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
1187448d27cd795dc273249f123444509403f4fa4facDevang Patel    return true;
1188448d27cd795dc273249f123444509403f4fa4facDevang Patel  }
1189448d27cd795dc273249f123444509403f4fa4facDevang Patel
1190448d27cd795dc273249f123444509403f4fa4facDevang Patel  FunctionPass *FP = dynamic_cast<FunctionPass *>(P);
1191448d27cd795dc273249f123444509403f4fa4facDevang Patel  if (!FP)
1192448d27cd795dc273249f123444509403f4fa4facDevang Patel    return false;
1193448d27cd795dc273249f123444509403f4fa4facDevang Patel
11941a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel  // If this pass does not preserve analysis that is used by other passes
11951a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel  // managed by this manager than it is not a suitable pass for this manager.
11962c5d1851bbcb20adb79664ec16ab1f97b9142086Devang Patel  if (!manageablePass(P))
119753596b6ba5d3199621e5a6e0cdbfcde3ee710397Devang Patel    return false;
119853596b6ba5d3199621e5a6e0cdbfcde3ee710397Devang Patel
1199e253385b108cd946b1ac150302f246d3b218be77Devang Patel  addPassToManager (FP);
1200badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel
1201badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel  // If active manager exists then clear its analysis info.
1202badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel  if (activeBBPassManager) {
1203badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel    activeBBPassManager->initializeAnalysisInfo();
1204badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel    activeBBPassManager = NULL;
1205badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel  }
1206badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel
1207448d27cd795dc273249f123444509403f4fa4facDevang Patel  return true;
1208448d27cd795dc273249f123444509403f4fa4facDevang Patel}
1209448d27cd795dc273249f123444509403f4fa4facDevang Patel
1210448d27cd795dc273249f123444509403f4fa4facDevang Patel/// Execute all of the passes scheduled for execution by invoking
1211448d27cd795dc273249f123444509403f4fa4facDevang Patel/// runOnFunction method.  Keep track of whether any of the passes modifies
1212448d27cd795dc273249f123444509403f4fa4facDevang Patel/// the function, and if so, return true.
1213214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patelbool FunctionPassManagerImpl_New::runOnModule(Module &M) {
1214448d27cd795dc273249f123444509403f4fa4facDevang Patel
12154d9a186b10dacf1d702ef32c2638e9016d8f483bDevang Patel  bool Changed = doInitialization(M);
1216cbfd29d0da5810949ba66701b91c1b954122077aDevang Patel  initializeAnalysisInfo();
1217c1d6e1fc9c3a47529f417026df652f466ce67851Devang Patel
1218448d27cd795dc273249f123444509403f4fa4facDevang Patel  for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
121997856ceeab2297e09c46c2390f7b3d818df6f1f7Devang Patel    this->runOnFunction(*I);
122097856ceeab2297e09c46c2390f7b3d818df6f1f7Devang Patel
12211a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel  return Changed |= doFinalization(M);
1222448d27cd795dc273249f123444509403f4fa4facDevang Patel}
1223448d27cd795dc273249f123444509403f4fa4facDevang Patel
1224214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel/// Execute all of the passes scheduled for execution by invoking
1225214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel/// runOnFunction method.  Keep track of whether any of the passes modifies
1226214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel/// the function, and if so, return true.
1227214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patelbool FunctionPassManagerImpl_New::runOnFunction(Function &F) {
1228214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel
1229214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel  bool Changed = false;
12301fbe2c9964d57b2a58235541175f069ae491a95eDevang Patel
12311fbe2c9964d57b2a58235541175f069ae491a95eDevang Patel  if (F.isExternal())
12321fbe2c9964d57b2a58235541175f069ae491a95eDevang Patel    return false;
12331fbe2c9964d57b2a58235541175f069ae491a95eDevang Patel
1234cbfd29d0da5810949ba66701b91c1b954122077aDevang Patel  initializeAnalysisInfo();
1235214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel
1236693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel  std::string Msg1 = "Executing Pass '";
1237693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel  std::string Msg3 = "' Made Modification '";
1238693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
1239214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel  for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1240214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel         e = passVectorEnd(); itr != e; ++itr) {
1241214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel    Pass *P = *itr;
1242017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel    AnalysisUsage AnUsage;
1243017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel    P->getAnalysisUsage(AnUsage);
1244693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
12454eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel    std::string Msg2 = "' on Function '" + F.getName() + "'...\n";
12464eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel    dumpPassInfo(P, Msg1, Msg2);
1247017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel    dumpAnalysisSetInfo("Required", P, AnUsage.getRequiredSet());
1248693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
124941545fd66316776e670deac302672c3d9acef2a2Devang Patel    initializeAnalysisImpl(P);
1250214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel    FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
12518e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
12528e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    if (TheTimeInfo) TheTimeInfo->passStarted(P);
1253214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel    Changed |= FP->runOnFunction(F);
12548e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    if (TheTimeInfo) TheTimeInfo->passEnded(P);
1255693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
1256693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel    if (Changed)
1257693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel      dumpPassInfo(P, Msg3, Msg2);
1258017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel    dumpAnalysisSetInfo("Preserved", P, AnUsage.getPreservedSet());
1259693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
1260214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel    removeNotPreservedAnalysis(P);
12610ac961d9c1c511204abfb02f5c25c92da6b75eb6Devang Patel    recordAvailableAnalysis(P);
12624eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel    removeDeadPasses(P, Msg2);
1263214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel  }
1264214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel  return Changed;
1265214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel}
1266214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel
1267214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel
12683799f97d539f6c288d169063e1b335917fafcffbDevang Patelinline bool FunctionPassManagerImpl_New::doInitialization(Module &M) {
12693799f97d539f6c288d169063e1b335917fafcffbDevang Patel  bool Changed = false;
12703799f97d539f6c288d169063e1b335917fafcffbDevang Patel
12713799f97d539f6c288d169063e1b335917fafcffbDevang Patel  for (std::vector<Pass *>::iterator itr = passVectorBegin(),
12723799f97d539f6c288d169063e1b335917fafcffbDevang Patel         e = passVectorEnd(); itr != e; ++itr) {
12733799f97d539f6c288d169063e1b335917fafcffbDevang Patel    Pass *P = *itr;
12743799f97d539f6c288d169063e1b335917fafcffbDevang Patel
12753799f97d539f6c288d169063e1b335917fafcffbDevang Patel    FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
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
12853799f97d539f6c288d169063e1b335917fafcffbDevang Patel  for (std::vector<Pass *>::iterator itr = passVectorBegin(),
12863799f97d539f6c288d169063e1b335917fafcffbDevang Patel         e = passVectorEnd(); itr != e; ++itr) {
12873799f97d539f6c288d169063e1b335917fafcffbDevang Patel    Pass *P = *itr;
12883799f97d539f6c288d169063e1b335917fafcffbDevang Patel
12893799f97d539f6c288d169063e1b335917fafcffbDevang Patel    FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
12903799f97d539f6c288d169063e1b335917fafcffbDevang Patel    Changed |= FP->doFinalization(M);
12913799f97d539f6c288d169063e1b335917fafcffbDevang Patel  }
12923799f97d539f6c288d169063e1b335917fafcffbDevang Patel
12933799f97d539f6c288d169063e1b335917fafcffbDevang Patel  return Changed;
12943799f97d539f6c288d169063e1b335917fafcffbDevang Patel}
12953799f97d539f6c288d169063e1b335917fafcffbDevang Patel
1296c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel// Execute all the passes managed by this top level manager.
1297c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel// Return true if any function is modified by a pass.
1298c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patelbool FunctionPassManagerImpl_New::run(Function &F) {
1299c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel
1300c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel  bool Changed = false;
1301c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel  for (std::vector<Pass *>::iterator I = passManagersBegin(),
1302c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel         E = passManagersEnd(); I != E; ++I) {
13033162691f69f85f740bc28f3ddca39b166d35187cDevang Patel    FunctionPassManagerImpl_New *FP =
13043162691f69f85f740bc28f3ddca39b166d35187cDevang Patel      dynamic_cast<FunctionPassManagerImpl_New *>(*I);
1305c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel    Changed |= FP->runOnFunction(F);
1306c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel  }
1307c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel  return Changed;
1308c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel}
1309c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel
131006e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel//===----------------------------------------------------------------------===//
131192c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel// ModulePassManager implementation
131292c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel
131392c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel/// Add P into pass vector if it is manageble. If P is a FunctionPass
1314c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel/// then use FunctionPassManagerImpl_New to manage it. Return false if P
131592c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel/// is not manageable by this manager.
131692c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patelbool
13173162691f69f85f740bc28f3ddca39b166d35187cDevang PatelModulePassManager::addPass(Pass *P) {
131892c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel
131992c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel  // If P is FunctionPass then use function pass maanager.
132092c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel  if (FunctionPass *FP = dynamic_cast<FunctionPass*>(P)) {
132192c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel
132269867b511c732a7fac7301977bd6e880e46439f1Devang Patel    if (!activeFunctionPassManager || !activeFunctionPassManager->addPass(P)) {
132392c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel
1324badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel      // If active manager exists then clear its analysis info.
1325badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel      if (activeFunctionPassManager)
1326badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel        activeFunctionPassManager->initializeAnalysisInfo();
1327b917e38c84fa9c7c434762a0e587af63eec939e5Devang Patel
1328badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel      // Create and add new manager
1329f72d29c540bf32b9c0e8914484cbbdeac70ee12aDevang Patel      activeFunctionPassManager =
1330f72d29c540bf32b9c0e8914484cbbdeac70ee12aDevang Patel        new FunctionPassManagerImpl_New(getDepth() + 1);
13311b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
13321b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      // Add new manager into current manager's list
1333893a5a681585cdf3b5bfff7128ea522e8a47750aDevang Patel      addPassToManager(activeFunctionPassManager, false);
13341b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
1335dff33ef8e863241193463fd0129657c5ebce4d58Devang Patel      // Inherit top level manager
1336dff33ef8e863241193463fd0129657c5ebce4d58Devang Patel      activeFunctionPassManager->setTopLevelManager(this->getTopLevelManager());
13371b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
13381b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      // Add new manager into top level manager's indirect passes list
13396e9e5e026af9e26cdec634c79017199f4e718599Chris Lattner      PMDataManager *PMD =
13406e9e5e026af9e26cdec634c79017199f4e718599Chris Lattner        dynamic_cast<PMDataManager *>(activeFunctionPassManager);
13416e9e5e026af9e26cdec634c79017199f4e718599Chris Lattner      assert(PMD && "Manager is not Pass Manager");
13421b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      TPM->addIndirectPassManager(PMD);
1343591b1b7526ed9c099de23cc995853a250c20502fDevang Patel
1344badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel      // Add pass into new manager. This time it must succeed.
13452c5d1851bbcb20adb79664ec16ab1f97b9142086Devang Patel      if (!activeFunctionPassManager->addPass(FP))
13462c5d1851bbcb20adb79664ec16ab1f97b9142086Devang Patel        assert(0 && "Unable to add pass");
1347e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
1348ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel      // If activeFunctionPassManager transfered any Last Uses then
1349ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel      // handle them here.
1350ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel      std::vector<Pass *> &TLU =
1351ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel        activeFunctionPassManager->getTransferredLastUses();
1352ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel      if (!TLU.empty())
1353ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel        TPM->setLastUser(TLU, this);
1354ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel    }
1355e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
135692c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel    return true;
135792c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel  }
135892c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel
135992c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel  ModulePass *MP = dynamic_cast<ModulePass *>(P);
136092c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel  if (!MP)
136192c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel    return false;
136292c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel
13631a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel  // If this pass does not preserve analysis that is used by other passes
13641a8038636c2998e37f2130b0ab89a3686d9c1f48Devang Patel  // managed by this manager than it is not a suitable pass for this manager.
13652c5d1851bbcb20adb79664ec16ab1f97b9142086Devang Patel  if (!manageablePass(P))
136653596b6ba5d3199621e5a6e0cdbfcde3ee710397Devang Patel    return false;
136753596b6ba5d3199621e5a6e0cdbfcde3ee710397Devang Patel
1368e253385b108cd946b1ac150302f246d3b218be77Devang Patel  addPassToManager(MP);
1369badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel  // If active manager exists then clear its analysis info.
1370badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel  if (activeFunctionPassManager) {
1371badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel    activeFunctionPassManager->initializeAnalysisInfo();
1372badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel    activeFunctionPassManager = NULL;
1373badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel  }
1374badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel
137592c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel  return true;
137692c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel}
137792c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel
137892c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel
137992c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel/// Execute all of the passes scheduled for execution by invoking
138092c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel/// runOnModule method.  Keep track of whether any of the passes modifies
138192c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel/// the module, and if so, return true.
138292c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patelbool
13833162691f69f85f740bc28f3ddca39b166d35187cDevang PatelModulePassManager::runOnModule(Module &M) {
138492c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel  bool Changed = false;
1385cbfd29d0da5810949ba66701b91c1b954122077aDevang Patel  initializeAnalysisInfo();
1386c1d6e1fc9c3a47529f417026df652f466ce67851Devang Patel
1387693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel  std::string Msg1 = "Executing Pass '";
1388693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel  std::string Msg3 = "' Made Modification '";
1389693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
1390e253385b108cd946b1ac150302f246d3b218be77Devang Patel  for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1391e253385b108cd946b1ac150302f246d3b218be77Devang Patel         e = passVectorEnd(); itr != e; ++itr) {
139292c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel    Pass *P = *itr;
1393017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel    AnalysisUsage AnUsage;
1394017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel    P->getAnalysisUsage(AnUsage);
1395693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
13964eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel    std::string Msg2 = "' on Module '" + M.getModuleIdentifier() + "'...\n";
13974eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel    dumpPassInfo(P, Msg1, Msg2);
1398017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel    dumpAnalysisSetInfo("Required", P, AnUsage.getRequiredSet());
1399693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
140041545fd66316776e670deac302672c3d9acef2a2Devang Patel    initializeAnalysisImpl(P);
140192c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel    ModulePass *MP = dynamic_cast<ModulePass*>(P);
14028e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
14038e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    if (TheTimeInfo) TheTimeInfo->passStarted(P);
140492c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel    Changed |= MP->runOnModule(M);
14058e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    if (TheTimeInfo) TheTimeInfo->passEnded(P);
1406693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
1407693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel    if (Changed)
1408693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel      dumpPassInfo(P, Msg3, Msg2);
1409017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel    dumpAnalysisSetInfo("Preserved", P, AnUsage.getPreservedSet());
1410017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel
1411c1d6e1fc9c3a47529f417026df652f466ce67851Devang Patel    removeNotPreservedAnalysis(P);
14120ac961d9c1c511204abfb02f5c25c92da6b75eb6Devang Patel    recordAvailableAnalysis(P);
14134eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel    removeDeadPasses(P, Msg2);
141492c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel  }
141592c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel  return Changed;
141692c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel}
141792c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel
141806e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel//===----------------------------------------------------------------------===//
141906e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel// PassManagerImpl implementation
142037a6f7966c39f69a92419d37949a94a758c29e90Devang Patel//
1421b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel/// Add P into active pass manager or use new module pass manager to
1422b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel/// manage it.
1423f8af6f0ec15d117cfe47bf32dd4e46ab52d42254Devang Patelbool PassManagerImpl_New::addPass(Pass *P) {
1424b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel
1425a363a0bdefd2e798a83acd8998591b5b07c4256eDevang Patel  if (!activeManager || !activeManager->addPass(P)) {
14263162691f69f85f740bc28f3ddca39b166d35187cDevang Patel    activeManager = new ModulePassManager(getDepth() + 1);
1427dff33ef8e863241193463fd0129657c5ebce4d58Devang Patel    // Inherit top level manager
1428dff33ef8e863241193463fd0129657c5ebce4d58Devang Patel    activeManager->setTopLevelManager(this->getTopLevelManager());
1429145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel
1430145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel    // This top level manager is going to manage activeManager.
1431145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel    // Set up analysis resolver to connect them.
1432145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel    AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
1433145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel    activeManager->setResolver(AR);
1434145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel
1435a083e94f7971ddafb817b1bcd86992d9fc4d8f9eDevang Patel    addPassManager(activeManager);
1436502f19e0f8ba47b5916a7e9d445f4ee071cdf132Devang Patel    return activeManager->addPass(P);
1437b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel  }
1438502f19e0f8ba47b5916a7e9d445f4ee071cdf132Devang Patel  return true;
1439b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel}
1440b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel
1441b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel/// run - Execute all of the passes scheduled for execution.  Keep track of
1442b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel/// whether any of the passes modifies the module, and if so, return true.
1443f8af6f0ec15d117cfe47bf32dd4e46ab52d42254Devang Patelbool PassManagerImpl_New::run(Module &M) {
1444b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel
1445b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel  bool Changed = false;
144645dc02d6f97447785ee7ffe08c36a34bc8921b0bDevang Patel
14478e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  TimingInfo::createTheTimeInfo();
14488e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
1449c32cf54101ecaf336d161fecd58667870149169cDevang Patel  dumpArguments();
1450e8ff1ce7343c697ff90d940c8c5fa8fccc09220dDevang Patel  if (PassDebugging_New >= Structure)
145145dc02d6f97447785ee7ffe08c36a34bc8921b0bDevang Patel    dumpPasses();
145245dc02d6f97447785ee7ffe08c36a34bc8921b0bDevang Patel
1453a083e94f7971ddafb817b1bcd86992d9fc4d8f9eDevang Patel  for (std::vector<Pass *>::iterator I = passManagersBegin(),
1454a083e94f7971ddafb817b1bcd86992d9fc4d8f9eDevang Patel         E = passManagersEnd(); I != E; ++I) {
14553162691f69f85f740bc28f3ddca39b166d35187cDevang Patel    ModulePassManager *MP = dynamic_cast<ModulePassManager *>(*I);
1456a083e94f7971ddafb817b1bcd86992d9fc4d8f9eDevang Patel    Changed |= MP->runOnModule(M);
1457b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel  }
1458b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel  return Changed;
1459b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel}
14605a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
146106e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel//===----------------------------------------------------------------------===//
146206e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel// PassManager implementation
146306e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel
14645a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel/// Create new pass manager
14653162691f69f85f740bc28f3ddca39b166d35187cDevang PatelPassManager::PassManager() {
1466f72d29c540bf32b9c0e8914484cbbdeac70ee12aDevang Patel  PM = new PassManagerImpl_New(0);
1467dff33ef8e863241193463fd0129657c5ebce4d58Devang Patel  // PM is the top level manager
1468dff33ef8e863241193463fd0129657c5ebce4d58Devang Patel  PM->setTopLevelManager(PM);
14695a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel}
14705a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
14713162691f69f85f740bc28f3ddca39b166d35187cDevang PatelPassManager::~PassManager() {
147237a6f7966c39f69a92419d37949a94a758c29e90Devang Patel  delete PM;
147337a6f7966c39f69a92419d37949a94a758c29e90Devang Patel}
147437a6f7966c39f69a92419d37949a94a758c29e90Devang Patel
14755a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel/// add - Add a pass to the queue of passes to run.  This passes ownership of
14765a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel/// the Pass to the PassManager.  When the PassManager is destroyed, the pass
14775a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel/// will be destroyed as well, so there is no need to delete the pass.  This
14785a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel/// implies that all passes MUST be allocated with 'new'.
14795a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patelvoid
14803162691f69f85f740bc28f3ddca39b166d35187cDevang PatelPassManager::add(Pass *P) {
14815a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  PM->add(P);
14825a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel}
14835a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
14845a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel/// run - Execute all of the passes scheduled for execution.  Keep track of
14855a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel/// whether any of the passes modifies the module, and if so, return true.
14865a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patelbool
14873162691f69f85f740bc28f3ddca39b166d35187cDevang PatelPassManager::run(Module &M) {
14885a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  return PM->run(M);
14895a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel}
14905a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
14918e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel//===----------------------------------------------------------------------===//
14928e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel// TimingInfo Class - This class is used to calculate information about the
14938e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel// amount of time each pass takes to execute.  This only happens with
14948e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel// -time-passes is enabled on the command line.
14958e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel//
14968e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patelbool llvm::TimePassesIsEnabled = false;
14978e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patelstatic cl::opt<bool,true>
14988e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang PatelEnableTiming("time-passes", cl::location(TimePassesIsEnabled),
14998e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel            cl::desc("Time each pass, printing elapsed time for each on exit"));
15008e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
15018e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel// createTheTimeInfo - This method either initializes the TheTimeInfo pointer to
15028e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel// a non null value (if the -time-passes option is enabled) or it leaves it
15038e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel// null.  It may be called multiple times.
15048e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patelvoid TimingInfo::createTheTimeInfo() {
15058e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  if (!TimePassesIsEnabled || TheTimeInfo) return;
15068e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
15078e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  // Constructed the first time this is called, iff -time-passes is enabled.
15088e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  // This guarantees that the object will be constructed before static globals,
15098e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  // thus it will be destroyed before them.
15108e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  static ManagedStatic<TimingInfo> TTI;
15118e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  TheTimeInfo = &*TTI;
15128e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel}
15138e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
15143162691f69f85f740bc28f3ddca39b166d35187cDevang Patel#endif
1515