PassManager.cpp revision c2ff962bf97761a54c94d2dadb555060403d49c6
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.
194ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  void dumpPasses();
195c32cf54101ecaf336d161fecd58667870149169cDevang Patel  void dumpArguments();
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:
224f72d29c540bf32b9c0e8914484cbbdeac70ee12aDevang Patel  PMDataManager(int D) : TPM(NULL), Depth(D) {
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
287f72d29c540bf32b9c0e8914484cbbdeac70ee12aDevang Patel  unsigned getDepth() { return Depth; }
288f72d29c540bf32b9c0e8914484cbbdeac70ee12aDevang Patel
289ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  // Print list of passes that are last used by P.
290ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  void dumpLastUses(Pass *P, unsigned Offset) {
291ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel
292ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel    std::vector<Pass *> LUses;
293ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel
294ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel    assert (TPM && "Top Level Manager is missing");
295ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel    TPM->collectLastUses(LUses, P);
296ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel
297ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel    for (std::vector<Pass *>::iterator I = LUses.begin(),
298ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel           E = LUses.end(); I != E; ++I) {
299ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel      llvm::cerr << "--" << std::string(Offset*2, ' ');
300ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel      (*I)->dumpPassStructure(0);
301ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel    }
302ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  }
303ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel
304c32cf54101ecaf336d161fecd58667870149169cDevang Patel  void dumpPassArguments() {
305c32cf54101ecaf336d161fecd58667870149169cDevang Patel    for(std::vector<Pass *>::iterator I = PassVector.begin(),
306c32cf54101ecaf336d161fecd58667870149169cDevang Patel          E = PassVector.end(); I != E; ++I) {
307c32cf54101ecaf336d161fecd58667870149169cDevang Patel      if (PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I))
308c32cf54101ecaf336d161fecd58667870149169cDevang Patel        PMD->dumpPassArguments();
309c32cf54101ecaf336d161fecd58667870149169cDevang Patel      else
310c32cf54101ecaf336d161fecd58667870149169cDevang Patel        if (const PassInfo *PI = (*I)->getPassInfo())
311c32cf54101ecaf336d161fecd58667870149169cDevang Patel          if (!PI->isAnalysisGroup())
312c32cf54101ecaf336d161fecd58667870149169cDevang Patel            cerr << " -" << PI->getPassArgument();
313c32cf54101ecaf336d161fecd58667870149169cDevang Patel    }
314c32cf54101ecaf336d161fecd58667870149169cDevang Patel  }
315c32cf54101ecaf336d161fecd58667870149169cDevang Patel
3164eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel  void dumpPassInfo(Pass *P,  std::string &Msg1, std::string &Msg2) {
3174eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel    if (PassDebugging_New < Executions)
3184eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel      return;
3194eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel    cerr << (void*)this << std::string(getDepth()*2+1, ' ');
3204eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel    cerr << Msg1;
3214eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel    cerr << P->getPassName();
3224eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel    cerr << Msg2;
3234eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel  }
3244eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel
325017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel  void dumpAnalysisSetInfo(const char *Msg, Pass *P,
326017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel                           const std::vector<AnalysisID> &Set) {
327017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel    if (PassDebugging_New >= Details && !Set.empty()) {
328017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel      cerr << (void*)P << std::string(getDepth()*2+3, ' ') << Msg << " Analyses:";
329017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel      for (unsigned i = 0; i != Set.size(); ++i) {
330017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel        if (i) cerr << ",";
331017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel        cerr << " " << Set[i]->getPassName();
332017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel      }
333017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel      cerr << "\n";
334017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel    }
335017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel  }
336ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel
337ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel  std::vector<Pass *>& getTransferredLastUses() {
338ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel    return TransferLastUses;
339ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel  }
340ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel
341e16634065021e36ae31f074f623a636924d6b8d1Devang Patelprotected:
342e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
343ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel  // If a FunctionPass F is the last user of ModulePass info M
344e16634065021e36ae31f074f623a636924d6b8d1Devang Patel  // then the F's manager, not F, records itself as a last user of M.
345ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel  // Current pass manage is requesting parent manager to record parent
346ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel  // manager as the last user of these TrransferLastUses passes.
347ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel  std::vector<Pass *> TransferLastUses;
348e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
349e16634065021e36ae31f074f623a636924d6b8d1Devang Patel  // Top level manager.
350e16634065021e36ae31f074f623a636924d6b8d1Devang Patel  PMTopLevelManager *TPM;
351e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
35285d344b0c68048527f1ac46ba22bbc950870d3c5Devang Patelprivate:
3535770c7cd52d6a3dfd9a5815cc9153d94afc6dd31Devang Patel  // Set of available Analysis. This information is used while scheduling
3545770c7cd52d6a3dfd9a5815cc9153d94afc6dd31Devang Patel  // pass. If a pass requires an analysis which is not not available then
3555770c7cd52d6a3dfd9a5815cc9153d94afc6dd31Devang Patel  // equired analysis pass is scheduled to run before the pass itself is
3565770c7cd52d6a3dfd9a5815cc9153d94afc6dd31Devang Patel  // scheduled to run.
357b899eed1bc0a64f96fa7aff8d7c6f999cf85bdfeDevang Patel  std::map<AnalysisID, Pass*> AvailableAnalysis;
358e253385b108cd946b1ac150302f246d3b218be77Devang Patel
359e253385b108cd946b1ac150302f246d3b218be77Devang Patel  // Collection of pass that are managed by this manager
360e253385b108cd946b1ac150302f246d3b218be77Devang Patel  std::vector<Pass *> PassVector;
361dc48f203cdc5a0b8f79d28bab6219161061fd73bDevang Patel
362f72d29c540bf32b9c0e8914484cbbdeac70ee12aDevang Patel  unsigned Depth;
36385d344b0c68048527f1ac46ba22bbc950870d3c5Devang Patel};
36485d344b0c68048527f1ac46ba22bbc950870d3c5Devang Patel
3657e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel//===----------------------------------------------------------------------===//
3663162691f69f85f740bc28f3ddca39b166d35187cDevang Patel// BasicBlockPassManager
3677e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel//
3683162691f69f85f740bc28f3ddca39b166d35187cDevang Patel/// BasicBlockPassManager manages BasicBlockPass. It batches all the
369c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel/// pass together and sequence them to process one basic block before
370c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel/// processing next basic block.
371c2ff962bf97761a54c94d2dadb555060403d49c6Devang Patelclass VISIBILITY_HIDDEN BasicBlockPassManager : public PMDataManager,
372a84b3025ca7d437d2eab22d7c3002c8d89c31858Chris Lattner                              public FunctionPass {
373c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
374c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patelpublic:
3753162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  BasicBlockPassManager(int D) : PMDataManager(D) { }
376c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
377c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// Add a pass into a passmanager queue.
378c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  bool addPass(Pass *p);
379c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
380c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// Execute all of the passes scheduled for execution.  Keep track of
381c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// whether any of the passes modifies the function, and if so, return true.
382c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  bool runOnFunction(Function &F);
383c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
38466d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  /// Pass Manager itself does not invalidate any analysis info.
38566d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  void getAnalysisUsage(AnalysisUsage &Info) const {
38666d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel    Info.setPreservesAll();
38766d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  }
38866d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel
389964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  bool doInitialization(Module &M);
390964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  bool doInitialization(Function &F);
391964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  bool doFinalization(Module &M);
392964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  bool doFinalization(Function &F);
393964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
394ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  // Print passes managed by this manager
395ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  void dumpPassStructure(unsigned Offset) {
396c2ff962bf97761a54c94d2dadb555060403d49c6Devang Patel    llvm::cerr << std::string(Offset*2, ' ') << "BasicBlockPass Manager\n";
397ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel    for (std::vector<Pass *>::iterator I = passVectorBegin(),
398ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel           E = passVectorEnd(); I != E; ++I)  {
399ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel      (*I)->dumpPassStructure(Offset + 1);
400ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel      dumpLastUses(*I, Offset+1);
401ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel    }
402ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  }
403c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel};
404c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
4057e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel//===----------------------------------------------------------------------===//
4067e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel// FunctionPassManagerImpl_New
4077e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel//
4086e9e5e026af9e26cdec634c79017199f4e718599Chris Lattner/// FunctionPassManagerImpl_New manages FunctionPasses and
4096e9e5e026af9e26cdec634c79017199f4e718599Chris Lattner/// BasicBlockPassManagers.  It batches all function passes and basic block pass
4106e9e5e026af9e26cdec634c79017199f4e718599Chris Lattner/// managers together and sequence them to process one function at a time before
4116e9e5e026af9e26cdec634c79017199f4e718599Chris Lattner/// processing next function.
412eb0d613ef6755f93610e08534a203c41ec14b56aDevang Patelclass FunctionPassManagerImpl_New : public ModulePass,
413eb0d613ef6755f93610e08534a203c41ec14b56aDevang Patel                                    public PMDataManager,
414eb0d613ef6755f93610e08534a203c41ec14b56aDevang Patel                                    public PMTopLevelManager {
415c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patelpublic:
416f72d29c540bf32b9c0e8914484cbbdeac70ee12aDevang Patel  FunctionPassManagerImpl_New(int D) : PMDataManager(D) {
417c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel    activeBBPassManager = NULL;
418c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  }
419c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel  ~FunctionPassManagerImpl_New() { /* TODO */ };
420c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
421eb0d613ef6755f93610e08534a203c41ec14b56aDevang Patel  inline void addTopLevelPass(Pass *P) {
422145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel
423c9a6293af7b433146d8f7ecf8fa494b530af9376Devang Patel    if (ImmutablePass *IP = dynamic_cast<ImmutablePass *> (P)) {
424145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel
425145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel      // P is a immutable pass then it will be managed by this
426145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel      // top level manager. Set up analysis resolver to connect them.
427145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel      AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
428145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel      P->setResolver(AR);
429689c683bccbb28b4d18a3dbe1b1c28ee6b90b17aDevang Patel      initializeAnalysisImpl(P);
430c9a6293af7b433146d8f7ecf8fa494b530af9376Devang Patel      addImmutablePass(IP);
431689c683bccbb28b4d18a3dbe1b1c28ee6b90b17aDevang Patel      recordAvailableAnalysis(IP);
432c9a6293af7b433146d8f7ecf8fa494b530af9376Devang Patel    }
433c9a6293af7b433146d8f7ecf8fa494b530af9376Devang Patel    else
434c9a6293af7b433146d8f7ecf8fa494b530af9376Devang Patel      addPass(P);
435eb0d613ef6755f93610e08534a203c41ec14b56aDevang Patel  }
436eb0d613ef6755f93610e08534a203c41ec14b56aDevang Patel
437c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// add - Add a pass to the queue of passes to run.  This passes
438c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// ownership of the Pass to the PassManager.  When the
439c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// PassManager_X is destroyed, the pass will be destroyed as well, so
440c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// there is no need to delete the pass. (TODO delete passes.)
441c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// This implies that all passes MUST be allocated with 'new'.
442877bfbb9ef75e7fe333d93abecaf0579780ccf54Devang Patel  void add(Pass *P) {
443e61b7478e53cea3183d4aee3799a4f0977b850a0Devang Patel    schedulePass(P);
444877bfbb9ef75e7fe333d93abecaf0579780ccf54Devang Patel  }
445c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
446c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// Add pass into the pass manager queue.
447c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  bool addPass(Pass *P);
448c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
449c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// Execute all of the passes scheduled for execution.  Keep
450c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// track of whether any of the passes modifies the function, and if
451c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// so, return true.
452c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  bool runOnModule(Module &M);
453214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel  bool runOnFunction(Function &F);
454c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel  bool run(Function &F);
455c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
4563799f97d539f6c288d169063e1b335917fafcffbDevang Patel  /// doInitialization - Run all of the initializers for the function passes.
4573799f97d539f6c288d169063e1b335917fafcffbDevang Patel  ///
4583799f97d539f6c288d169063e1b335917fafcffbDevang Patel  bool doInitialization(Module &M);
4593799f97d539f6c288d169063e1b335917fafcffbDevang Patel
4603799f97d539f6c288d169063e1b335917fafcffbDevang Patel  /// doFinalization - Run all of the initializers for the function passes.
4613799f97d539f6c288d169063e1b335917fafcffbDevang Patel  ///
4623799f97d539f6c288d169063e1b335917fafcffbDevang Patel  bool doFinalization(Module &M);
46366d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel
46466d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  /// Pass Manager itself does not invalidate any analysis info.
46566d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  void getAnalysisUsage(AnalysisUsage &Info) const {
46666d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel    Info.setPreservesAll();
46766d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  }
46866d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel
469ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  // Print passes managed by this manager
470ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  void dumpPassStructure(unsigned Offset) {
471ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel    llvm::cerr << std::string(Offset*2, ' ') << "FunctionPass Manager\n";
472ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel    for (std::vector<Pass *>::iterator I = passVectorBegin(),
473ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel           E = passVectorEnd(); I != E; ++I)  {
474ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel      (*I)->dumpPassStructure(Offset + 1);
475ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel      dumpLastUses(*I, Offset+1);
476ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel    }
477ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  }
478ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel
479c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patelprivate:
480c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  // Active Pass Managers
4813162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  BasicBlockPassManager *activeBBPassManager;
482c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel};
483c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
4847e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel//===----------------------------------------------------------------------===//
4853162691f69f85f740bc28f3ddca39b166d35187cDevang Patel// ModulePassManager
4867e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel//
4873162691f69f85f740bc28f3ddca39b166d35187cDevang Patel/// ModulePassManager manages ModulePasses and function pass managers.
488c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel/// It batches all Module passes  passes and function pass managers together and
489c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel/// sequence them to process one module.
490a84b3025ca7d437d2eab22d7c3002c8d89c31858Chris Lattnerclass ModulePassManager : public Pass, public PMDataManager {
491c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
492c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patelpublic:
4933162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  ModulePassManager(int D) : PMDataManager(D) {
494f72d29c540bf32b9c0e8914484cbbdeac70ee12aDevang Patel    activeFunctionPassManager = NULL;
495f72d29c540bf32b9c0e8914484cbbdeac70ee12aDevang Patel  }
496c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
497c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// Add a pass into a passmanager queue.
498c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  bool addPass(Pass *p);
499c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
500c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// run - Execute all of the passes scheduled for execution.  Keep track of
501c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  /// whether any of the passes modifies the module, and if so, return true.
502c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  bool runOnModule(Module &M);
503be6d515f481756ff549f355e32be1ac398e141d5Devang Patel
50466d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  /// Pass Manager itself does not invalidate any analysis info.
50566d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  void getAnalysisUsage(AnalysisUsage &Info) const {
50666d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel    Info.setPreservesAll();
50766d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  }
50866d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel
509ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  // Print passes managed by this manager
510ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  void dumpPassStructure(unsigned Offset) {
511ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel    llvm::cerr << std::string(Offset*2, ' ') << "ModulePass Manager\n";
512ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel    for (std::vector<Pass *>::iterator I = passVectorBegin(),
513ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel           E = passVectorEnd(); I != E; ++I)  {
514ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel      (*I)->dumpPassStructure(Offset + 1);
515ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel      dumpLastUses(*I, Offset+1);
516ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel    }
517ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  }
518ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel
519c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patelprivate:
520c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel  // Active Pass Manager
521c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel  FunctionPassManagerImpl_New *activeFunctionPassManager;
522c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel};
523c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
5247e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel//===----------------------------------------------------------------------===//
5257e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel// PassManagerImpl_New
5267e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel//
5277e601a70fcaf0a3090368425bbb339aab038d3e3Devang Patel/// PassManagerImpl_New manages ModulePassManagers
528877bfbb9ef75e7fe333d93abecaf0579780ccf54Devang Patelclass PassManagerImpl_New : public Pass,
529877bfbb9ef75e7fe333d93abecaf0579780ccf54Devang Patel                            public PMDataManager,
530eb0d613ef6755f93610e08534a203c41ec14b56aDevang Patel                            public PMTopLevelManager {
5315a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
5325a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patelpublic:
5335a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
534395ed739849a0507a2faae0829287c039c3589f8Devang Patel  PassManagerImpl_New(int D) : PMDataManager(D) {
535395ed739849a0507a2faae0829287c039c3589f8Devang Patel    activeManager = NULL;
536395ed739849a0507a2faae0829287c039c3589f8Devang Patel  }
537f72d29c540bf32b9c0e8914484cbbdeac70ee12aDevang Patel
5385a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  /// add - Add a pass to the queue of passes to run.  This passes ownership of
5395a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  /// the Pass to the PassManager.  When the PassManager is destroyed, the pass
5405a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  /// will be destroyed as well, so there is no need to delete the pass.  This
5415a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  /// implies that all passes MUST be allocated with 'new'.
542877bfbb9ef75e7fe333d93abecaf0579780ccf54Devang Patel  void add(Pass *P) {
543e61b7478e53cea3183d4aee3799a4f0977b850a0Devang Patel    schedulePass(P);
544877bfbb9ef75e7fe333d93abecaf0579780ccf54Devang Patel  }
5455a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
5465a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  /// run - Execute all of the passes scheduled for execution.  Keep track of
5475a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  /// whether any of the passes modifies the module, and if so, return true.
5485a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  bool run(Module &M);
5495a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
55066d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  /// Pass Manager itself does not invalidate any analysis info.
55166d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  void getAnalysisUsage(AnalysisUsage &Info) const {
55266d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel    Info.setPreservesAll();
55366d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel  }
55466d72e140bf7bdfe03383bfb4d3fe53a420d147bDevang Patel
555eb0d613ef6755f93610e08534a203c41ec14b56aDevang Patel  inline void addTopLevelPass(Pass *P) {
556145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel
557c9a6293af7b433146d8f7ecf8fa494b530af9376Devang Patel    if (ImmutablePass *IP = dynamic_cast<ImmutablePass *> (P)) {
558145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel
559145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel      // P is a immutable pass and it will be managed by this
560145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel      // top level manager. Set up analysis resolver to connect them.
561145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel      AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
562145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel      P->setResolver(AR);
563689c683bccbb28b4d18a3dbe1b1c28ee6b90b17aDevang Patel      initializeAnalysisImpl(P);
564c9a6293af7b433146d8f7ecf8fa494b530af9376Devang Patel      addImmutablePass(IP);
565689c683bccbb28b4d18a3dbe1b1c28ee6b90b17aDevang Patel      recordAvailableAnalysis(IP);
566145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel    }
567c9a6293af7b433146d8f7ecf8fa494b530af9376Devang Patel    else
568c9a6293af7b433146d8f7ecf8fa494b530af9376Devang Patel      addPass(P);
569eb0d613ef6755f93610e08534a203c41ec14b56aDevang Patel  }
570eb0d613ef6755f93610e08534a203c41ec14b56aDevang Patel
5715a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patelprivate:
5725a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
5731209f416cf2f2ec0f335d91a7c115e3b0a37d603Devang Patel  /// Add a pass into a passmanager queue.
5745a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  bool addPass(Pass *p);
5755a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
5765a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  // Active Pass Manager
5773162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  ModulePassManager *activeManager;
5785a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel};
5795a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
580c2ff962bf97761a54c94d2dadb555060403d49c6Devang Patel} // End of llvm namespace
581c2ff962bf97761a54c94d2dadb555060403d49c6Devang Patel
582c2ff962bf97761a54c94d2dadb555060403d49c6Devang Patelnamespace {
583c2ff962bf97761a54c94d2dadb555060403d49c6Devang Patel
5848e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel//===----------------------------------------------------------------------===//
5858e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel// TimingInfo Class - This class is used to calculate information about the
5868e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel// amount of time each pass takes to execute.  This only happens when
5878e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel// -time-passes is enabled on the command line.
5888e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel//
5898e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
590c2ff962bf97761a54c94d2dadb555060403d49c6Devang Patelclass VISIBILITY_HIDDEN TimingInfo {
5918e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  std::map<Pass*, Timer> TimingData;
5928e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  TimerGroup TG;
5938e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
5948e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patelpublic:
5958e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  // Use 'create' member to get this.
5968e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  TimingInfo() : TG("... Pass execution timing report ...") {}
5978e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
5988e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  // TimingDtor - Print out information about timing information
5998e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  ~TimingInfo() {
6008e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    // Delete all of the timers...
6018e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    TimingData.clear();
6028e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    // TimerGroup is deleted next, printing the report.
6038e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  }
6048e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
6058e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  // createTheTimeInfo - This method either initializes the TheTimeInfo pointer
6068e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  // to a non null value (if the -time-passes option is enabled) or it leaves it
6078e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  // null.  It may be called multiple times.
6088e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  static void createTheTimeInfo();
6098e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
6108e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  void passStarted(Pass *P) {
6118e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
6128e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    if (dynamic_cast<PMDataManager *>(P))
6138e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel      return;
6148e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
6158e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    std::map<Pass*, Timer>::iterator I = TimingData.find(P);
6168e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    if (I == TimingData.end())
6178e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel      I=TimingData.insert(std::make_pair(P, Timer(P->getPassName(), TG))).first;
6188e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    I->second.startTimer();
6198e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  }
6208e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  void passEnded(Pass *P) {
6218e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
6228e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    if (dynamic_cast<PMDataManager *>(P))
6238e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel      return;
6248e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
6258e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    std::map<Pass*, Timer>::iterator I = TimingData.find(P);
6268e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    assert (I != TimingData.end() && "passStarted/passEnded not nested right!");
6278e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    I->second.stopTimer();
6288e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  }
6298e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel};
6308e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
6318e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patelstatic TimingInfo *TheTimeInfo;
6328e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
633c2ff962bf97761a54c94d2dadb555060403d49c6Devang Patel} // End of anon namespace
634c67c938de2097f26dba71d9436e4707dd8a5012dDevang Patel
63506e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel//===----------------------------------------------------------------------===//
6361b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel// PMTopLevelManager implementation
6371b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6381b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel/// Set pass P as the last user of the given analysis passes.
6391b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patelvoid PMTopLevelManager::setLastUser(std::vector<Pass *> &AnalysisPasses,
6401b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel                                    Pass *P) {
6411b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6421b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  for (std::vector<Pass *>::iterator I = AnalysisPasses.begin(),
6431b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel         E = AnalysisPasses.end(); I != E; ++I) {
6441b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    Pass *AP = *I;
6451b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    LastUser[AP] = P;
6461b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    // If AP is the last user of other passes then make P last user of
6471b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    // such passes.
6481b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
6491b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel           LUE = LastUser.end(); LUI != LUE; ++LUI) {
6501b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      if (LUI->second == AP)
6511b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel        LastUser[LUI->first] = P;
6521b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    }
6531b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  }
6541b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel}
6551b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6561b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel/// Collect passes whose last user is P
6571b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patelvoid PMTopLevelManager::collectLastUses(std::vector<Pass *> &LastUses,
6581b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel                                            Pass *P) {
6591b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel   for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
6601b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel          LUE = LastUser.end(); LUI != LUE; ++LUI)
6611b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      if (LUI->second == P)
6621b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel        LastUses.push_back(LUI->first);
6631b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel}
6641b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6651b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel/// Schedule pass P for execution. Make sure that passes required by
6661b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel/// P are run before P is run. Update analysis info maintained by
6671b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel/// the manager. Remove dead passes. This is a recursive function.
6681b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patelvoid PMTopLevelManager::schedulePass(Pass *P) {
6691b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6701b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  // TODO : Allocate function manager for this pass, other wise required set
6711b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  // may be inserted into previous function manager
6721b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6731b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  AnalysisUsage AnUsage;
6741b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  P->getAnalysisUsage(AnUsage);
6751b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
6761b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  for (std::vector<AnalysisID>::const_iterator I = RequiredSet.begin(),
6771b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel         E = RequiredSet.end(); I != E; ++I) {
6781b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6791b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    Pass *AnalysisPass = findAnalysisPass(*I);
6801b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    if (!AnalysisPass) {
6811b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      // Schedule this analysis run first.
6821b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      AnalysisPass = (*I)->createPass();
6831b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      schedulePass(AnalysisPass);
6841b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    }
6851b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  }
6861b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6871b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  // Now all required passes are available.
6881b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  addTopLevelPass(P);
6891b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel}
6901b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6911b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel/// Find the pass that implements Analysis AID. Search immutable
6921b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel/// passes and all pass managers. If desired pass is not found
6931b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel/// then return NULL.
6941b8d015066dca364a1b11b6dbe5b80248b111cd5Devang PatelPass *PMTopLevelManager::findAnalysisPass(AnalysisID AID) {
6951b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
6961b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  Pass *P = NULL;
697d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel  // Check pass managers
698d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel  for (std::vector<Pass *>::iterator I = PassManagers.begin(),
699d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel         E = PassManagers.end(); P == NULL && I != E; ++I) {
700d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel    PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I);
701d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel    assert(PMD && "This is not a PassManager");
702d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel    P = PMD->findAnalysisPass(AID, false);
703d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel  }
704d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel
705d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel  // Check other pass managers
706d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel  for (std::vector<PMDataManager *>::iterator I = IndirectPassManagers.begin(),
707d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel         E = IndirectPassManagers.end(); P == NULL && I != E; ++I)
708d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel    P = (*I)->findAnalysisPass(AID, false);
709d0fa16c33615bb6f21685c4e4e3d948ac6780160Devang Patel
7101b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  for (std::vector<ImmutablePass *>::iterator I = ImmutablePasses.begin(),
7111b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel         E = ImmutablePasses.end(); P == NULL && I != E; ++I) {
7121b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    const PassInfo *PI = (*I)->getPassInfo();
7131b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    if (PI == AID)
7141b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      P = *I;
7151b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
7161b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    // If Pass not found then check the interfaces implemented by Immutable Pass
7171b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    if (!P) {
7181b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      const std::vector<const PassInfo*> &ImmPI =
7191b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel        PI->getInterfacesImplemented();
7201b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      for (unsigned Index = 0, End = ImmPI.size();
7211b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel           P == NULL && Index != End; ++Index)
7221b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel        if (ImmPI[Index] == AID)
7231b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel          P = *I;
7241b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel    }
7251b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  }
7261b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
7271b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel  return P;
7281b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel}
7291b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
730ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel// Print passes managed by this top level manager.
731ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patelvoid PMTopLevelManager::dumpPasses() {
732ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel
733ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  // Print out the immutable passes
734ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i) {
735ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel    ImmutablePasses[i]->dumpPassStructure(0);
736ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  }
737ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel
738ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel  for (std::vector<Pass *>::iterator I = PassManagers.begin(),
739ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel         E = PassManagers.end(); I != E; ++I)
740ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel    (*I)->dumpPassStructure(1);
741ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel
742ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel}
743ebc0922eeb5b728d33a68d4bea8128413f62e369Devang Patel
744c32cf54101ecaf336d161fecd58667870149169cDevang Patelvoid PMTopLevelManager::dumpArguments() {
745c32cf54101ecaf336d161fecd58667870149169cDevang Patel
746c32cf54101ecaf336d161fecd58667870149169cDevang Patel  if (PassDebugging_New < Arguments)
747c32cf54101ecaf336d161fecd58667870149169cDevang Patel    return;
748c32cf54101ecaf336d161fecd58667870149169cDevang Patel
749c32cf54101ecaf336d161fecd58667870149169cDevang Patel  cerr << "Pass Arguments: ";
750c32cf54101ecaf336d161fecd58667870149169cDevang Patel  for (std::vector<Pass *>::iterator I = PassManagers.begin(),
751c32cf54101ecaf336d161fecd58667870149169cDevang Patel         E = PassManagers.end(); I != E; ++I) {
752c32cf54101ecaf336d161fecd58667870149169cDevang Patel    PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I);
753c32cf54101ecaf336d161fecd58667870149169cDevang Patel    assert(PMD && "This is not a PassManager");
754c32cf54101ecaf336d161fecd58667870149169cDevang Patel    PMD->dumpPassArguments();
755c32cf54101ecaf336d161fecd58667870149169cDevang Patel  }
756c32cf54101ecaf336d161fecd58667870149169cDevang Patel  cerr << "\n";
757c32cf54101ecaf336d161fecd58667870149169cDevang Patel}
758c32cf54101ecaf336d161fecd58667870149169cDevang Patel
7591b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel//===----------------------------------------------------------------------===//
760419f0e95d698109541ad730cb45ba4caca78f458Devang Patel// PMDataManager implementation
761889739c4d188d28c167644bced9df0f3131317d7Devang Patel
7622c5d1851bbcb20adb79664ec16ab1f97b9142086Devang Patel/// Return true IFF pass P's required analysis set does not required new
763889739c4d188d28c167644bced9df0f3131317d7Devang Patel/// manager.
764419f0e95d698109541ad730cb45ba4caca78f458Devang Patelbool PMDataManager::manageablePass(Pass *P) {
765889739c4d188d28c167644bced9df0f3131317d7Devang Patel
7664045af1175509c81d6a4708df233f0b1abe888fcDevang Patel  // TODO
7674045af1175509c81d6a4708df233f0b1abe888fcDevang Patel  // If this pass is not preserving information that is required by a
7684045af1175509c81d6a4708df233f0b1abe888fcDevang Patel  // pass maintained by higher level pass manager then do not insert
7694045af1175509c81d6a4708df233f0b1abe888fcDevang Patel  // this pass into current manager. Use new manager. For example,
7704045af1175509c81d6a4708df233f0b1abe888fcDevang Patel  // For example, If FunctionPass F is not preserving ModulePass Info M1
7714045af1175509c81d6a4708df233f0b1abe888fcDevang Patel  // that is used by another ModulePass M2 then do not insert F in
7724045af1175509c81d6a4708df233f0b1abe888fcDevang Patel  // current function pass manager.
773889739c4d188d28c167644bced9df0f3131317d7Devang Patel  return true;
774889739c4d188d28c167644bced9df0f3131317d7Devang Patel}
775889739c4d188d28c167644bced9df0f3131317d7Devang Patel
776b8526162551a3fbcf787e01d82ef44b69f879e01Devang Patel/// Augement AvailableAnalysis by adding analysis made available by pass P.
777f32b4dd13e421b3ad4696f984cb2043ce64e19cbDevang Patelvoid PMDataManager::recordAvailableAnalysis(Pass *P) {
778b899eed1bc0a64f96fa7aff8d7c6f999cf85bdfeDevang Patel
779b8526162551a3fbcf787e01d82ef44b69f879e01Devang Patel  if (const PassInfo *PI = P->getPassInfo()) {
780b899eed1bc0a64f96fa7aff8d7c6f999cf85bdfeDevang Patel    AvailableAnalysis[PI] = P;
781b8526162551a3fbcf787e01d82ef44b69f879e01Devang Patel
782f32b4dd13e421b3ad4696f984cb2043ce64e19cbDevang Patel    //This pass is the current implementation of all of the interfaces it
783f32b4dd13e421b3ad4696f984cb2043ce64e19cbDevang Patel    //implements as well.
784f32b4dd13e421b3ad4696f984cb2043ce64e19cbDevang Patel    const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
785f32b4dd13e421b3ad4696f984cb2043ce64e19cbDevang Patel    for (unsigned i = 0, e = II.size(); i != e; ++i)
786f32b4dd13e421b3ad4696f984cb2043ce64e19cbDevang Patel      AvailableAnalysis[II[i]] = P;
787b8526162551a3fbcf787e01d82ef44b69f879e01Devang Patel  }
788b8526162551a3fbcf787e01d82ef44b69f879e01Devang Patel}
789b8526162551a3fbcf787e01d82ef44b69f879e01Devang Patel
790889739c4d188d28c167644bced9df0f3131317d7Devang Patel/// Remove Analyss not preserved by Pass P
791419f0e95d698109541ad730cb45ba4caca78f458Devang Patelvoid PMDataManager::removeNotPreservedAnalysis(Pass *P) {
79214d6581a7374bdb4a66ef6c30250efdc324f6ddeDevang Patel  AnalysisUsage AnUsage;
79314d6581a7374bdb4a66ef6c30250efdc324f6ddeDevang Patel  P->getAnalysisUsage(AnUsage);
79414d6581a7374bdb4a66ef6c30250efdc324f6ddeDevang Patel
79504b4e0595ffffab232a73a78d742e08efb6ebcfbDevang Patel  if (AnUsage.getPreservesAll())
79604b4e0595ffffab232a73a78d742e08efb6ebcfbDevang Patel    return;
79704b4e0595ffffab232a73a78d742e08efb6ebcfbDevang Patel
79804b4e0595ffffab232a73a78d742e08efb6ebcfbDevang Patel  const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
799b899eed1bc0a64f96fa7aff8d7c6f999cf85bdfeDevang Patel  for (std::map<AnalysisID, Pass*>::iterator I = AvailableAnalysis.begin(),
80054e247d2d0c07544b3e638e80b816f352ec152c1Devang Patel         E = AvailableAnalysis.end(); I != E; ) {
801b899eed1bc0a64f96fa7aff8d7c6f999cf85bdfeDevang Patel    if (std::find(PreservedSet.begin(), PreservedSet.end(), I->first) ==
80214d6581a7374bdb4a66ef6c30250efdc324f6ddeDevang Patel        PreservedSet.end()) {
80314d6581a7374bdb4a66ef6c30250efdc324f6ddeDevang Patel      // Remove this analysis
80454e247d2d0c07544b3e638e80b816f352ec152c1Devang Patel      if (!dynamic_cast<ImmutablePass*>(I->second)) {
80554e247d2d0c07544b3e638e80b816f352ec152c1Devang Patel        std::map<AnalysisID, Pass*>::iterator J = I++;
80654e247d2d0c07544b3e638e80b816f352ec152c1Devang Patel        AvailableAnalysis.erase(J);
80754e247d2d0c07544b3e638e80b816f352ec152c1Devang Patel      } else
80854e247d2d0c07544b3e638e80b816f352ec152c1Devang Patel        ++I;
80954e247d2d0c07544b3e638e80b816f352ec152c1Devang Patel    } else
81054e247d2d0c07544b3e638e80b816f352ec152c1Devang Patel      ++I;
81114d6581a7374bdb4a66ef6c30250efdc324f6ddeDevang Patel  }
812889739c4d188d28c167644bced9df0f3131317d7Devang Patel}
813889739c4d188d28c167644bced9df0f3131317d7Devang Patel
814df1a10ece6a75f230d98c6fb001349eede90387aDevang Patel/// Remove analysis passes that are not used any longer
8154eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patelvoid PMDataManager::removeDeadPasses(Pass *P, std::string &Msg) {
816f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel
817f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel  std::vector<Pass *> DeadPasses;
818f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel  TPM->collectLastUses(DeadPasses, P);
819f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel
820f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel  for (std::vector<Pass *>::iterator I = DeadPasses.begin(),
821f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel         E = DeadPasses.end(); I != E; ++I) {
8224eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel
8234eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel    std::string Msg1 = "  Freeing Pass '";
8244eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel    dumpPassInfo(*I, Msg1, Msg);
8254eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel
8268e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    if (TheTimeInfo) TheTimeInfo->passStarted(P);
827f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel    (*I)->releaseMemory();
8288e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    if (TheTimeInfo) TheTimeInfo->passEnded(P);
8298e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
830f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel    std::map<AnalysisID, Pass*>::iterator Pos =
831f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel      AvailableAnalysis.find((*I)->getPassInfo());
832f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel
833964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel    // It is possible that pass is already removed from the AvailableAnalysis
834f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel    if (Pos != AvailableAnalysis.end())
835f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel      AvailableAnalysis.erase(Pos);
836f9a60ae75d6fdc74160085323c14e92e7d3517d3Devang Patel  }
837df1a10ece6a75f230d98c6fb001349eede90387aDevang Patel}
838df1a10ece6a75f230d98c6fb001349eede90387aDevang Patel
8394045af1175509c81d6a4708df233f0b1abe888fcDevang Patel/// Add pass P into the PassVector. Update
840893a5a681585cdf3b5bfff7128ea522e8a47750aDevang Patel/// AvailableAnalysis appropriately if ProcessAnalysis is true.
84104b4e0595ffffab232a73a78d742e08efb6ebcfbDevang Patelvoid PMDataManager::addPassToManager(Pass *P,
84204b4e0595ffffab232a73a78d742e08efb6ebcfbDevang Patel                                     bool ProcessAnalysis) {
843e253385b108cd946b1ac150302f246d3b218be77Devang Patel
844145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel  // This manager is going to manage pass P. Set up analysis resolver
845145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel  // to connect them.
846145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel  AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
847145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel  P->setResolver(AR);
848145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel
849893a5a681585cdf3b5bfff7128ea522e8a47750aDevang Patel  if (ProcessAnalysis) {
850e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
851e16634065021e36ae31f074f623a636924d6b8d1Devang Patel    // At the moment, this pass is the last user of all required passes.
852e16634065021e36ae31f074f623a636924d6b8d1Devang Patel    std::vector<Pass *> LastUses;
853e16634065021e36ae31f074f623a636924d6b8d1Devang Patel    std::vector<Pass *> RequiredPasses;
854e16634065021e36ae31f074f623a636924d6b8d1Devang Patel    unsigned PDepth = this->getDepth();
855e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
856e16634065021e36ae31f074f623a636924d6b8d1Devang Patel    collectRequiredAnalysisPasses(RequiredPasses, P);
857e16634065021e36ae31f074f623a636924d6b8d1Devang Patel    for (std::vector<Pass *>::iterator I = RequiredPasses.begin(),
858e16634065021e36ae31f074f623a636924d6b8d1Devang Patel           E = RequiredPasses.end(); I != E; ++I) {
859e16634065021e36ae31f074f623a636924d6b8d1Devang Patel      Pass *PRequired = *I;
860e16634065021e36ae31f074f623a636924d6b8d1Devang Patel      unsigned RDepth = 0;
861cd520b187a222bf99d4238590e6517e87666e39fDevang Patel
862cd520b187a222bf99d4238590e6517e87666e39fDevang Patel      PMDataManager &DM = PRequired->getResolver()->getPMDataManager();
863cd520b187a222bf99d4238590e6517e87666e39fDevang Patel      RDepth = DM.getDepth();
864cd520b187a222bf99d4238590e6517e87666e39fDevang Patel
865e16634065021e36ae31f074f623a636924d6b8d1Devang Patel      if (PDepth == RDepth)
866e16634065021e36ae31f074f623a636924d6b8d1Devang Patel        LastUses.push_back(PRequired);
867e16634065021e36ae31f074f623a636924d6b8d1Devang Patel      else if (PDepth >  RDepth) {
868e16634065021e36ae31f074f623a636924d6b8d1Devang Patel        // Let the parent claim responsibility of last use
869ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel        TransferLastUses.push_back(PRequired);
870e16634065021e36ae31f074f623a636924d6b8d1Devang Patel      } else {
871e16634065021e36ae31f074f623a636924d6b8d1Devang Patel        // Note : This feature is not yet implemented
872e16634065021e36ae31f074f623a636924d6b8d1Devang Patel        assert (0 &&
873e16634065021e36ae31f074f623a636924d6b8d1Devang Patel                "Unable to handle Pass that requires lower level Analysis pass");
874e16634065021e36ae31f074f623a636924d6b8d1Devang Patel      }
875e16634065021e36ae31f074f623a636924d6b8d1Devang Patel    }
876e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
877ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel    LastUses.push_back(P);
878ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel    TPM->setLastUser(LastUses, P);
879e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
8800ac961d9c1c511204abfb02f5c25c92da6b75eb6Devang Patel    // Take a note of analysis required and made available by this pass.
881893a5a681585cdf3b5bfff7128ea522e8a47750aDevang Patel    // Remove the analysis not preserved by this pass
882893a5a681585cdf3b5bfff7128ea522e8a47750aDevang Patel    removeNotPreservedAnalysis(P);
8830ac961d9c1c511204abfb02f5c25c92da6b75eb6Devang Patel    recordAvailableAnalysis(P);
884893a5a681585cdf3b5bfff7128ea522e8a47750aDevang Patel  }
885e253385b108cd946b1ac150302f246d3b218be77Devang Patel
886e253385b108cd946b1ac150302f246d3b218be77Devang Patel  // Add pass
887e253385b108cd946b1ac150302f246d3b218be77Devang Patel  PassVector.push_back(P);
888e253385b108cd946b1ac150302f246d3b218be77Devang Patel}
889e253385b108cd946b1ac150302f246d3b218be77Devang Patel
890c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel/// Populate RequiredPasses with the analysis pass that are required by
891c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel/// pass P.
892c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patelvoid PMDataManager::collectRequiredAnalysisPasses(std::vector<Pass *> &RP,
893c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel                                                  Pass *P) {
894c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel  AnalysisUsage AnUsage;
895c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel  P->getAnalysisUsage(AnUsage);
896c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel  const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
897c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel  for (std::vector<AnalysisID>::const_iterator
898c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel         I = RequiredSet.begin(), E = RequiredSet.end();
899c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel       I != E; ++I) {
90069867b511c732a7fac7301977bd6e880e46439f1Devang Patel    Pass *AnalysisPass = findAnalysisPass(*I, true);
901c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel    assert (AnalysisPass && "Analysis pass is not available");
902c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel    RP.push_back(AnalysisPass);
903c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel  }
90427aaab2bd3c220d8466b34f6b959f74e1caac69bDevang Patel
90527aaab2bd3c220d8466b34f6b959f74e1caac69bDevang Patel  const std::vector<AnalysisID> &IDs = AnUsage.getRequiredTransitiveSet();
90627aaab2bd3c220d8466b34f6b959f74e1caac69bDevang Patel  for (std::vector<AnalysisID>::const_iterator I = IDs.begin(),
90727aaab2bd3c220d8466b34f6b959f74e1caac69bDevang Patel         E = IDs.end(); I != E; ++I) {
90827aaab2bd3c220d8466b34f6b959f74e1caac69bDevang Patel    Pass *AnalysisPass = findAnalysisPass(*I, true);
90927aaab2bd3c220d8466b34f6b959f74e1caac69bDevang Patel    assert (AnalysisPass && "Analysis pass is not available");
91027aaab2bd3c220d8466b34f6b959f74e1caac69bDevang Patel    RP.push_back(AnalysisPass);
91127aaab2bd3c220d8466b34f6b959f74e1caac69bDevang Patel  }
912c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel}
913c17bbb6da7e17c06c1f0ae7baa2f151db0e966d9Devang Patel
9142f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel// All Required analyses should be available to the pass as it runs!  Here
9152f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel// we fill in the AnalysisImpls member of the pass so that it can
9162f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel// successfully use the getAnalysis() method to retrieve the
9172f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel// implementations it needs.
9182f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel//
919419f0e95d698109541ad730cb45ba4caca78f458Devang Patelvoid PMDataManager::initializeAnalysisImpl(Pass *P) {
9203799f97d539f6c288d169063e1b335917fafcffbDevang Patel  AnalysisUsage AnUsage;
9213799f97d539f6c288d169063e1b335917fafcffbDevang Patel  P->getAnalysisUsage(AnUsage);
9222f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel
9232f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel  for (std::vector<const PassInfo *>::const_iterator
9242f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel         I = AnUsage.getRequiredSet().begin(),
9252f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel         E = AnUsage.getRequiredSet().end(); I != E; ++I) {
92669867b511c732a7fac7301977bd6e880e46439f1Devang Patel    Pass *Impl = findAnalysisPass(*I, true);
9272f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel    if (Impl == 0)
9282f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel      assert(0 && "Analysis used but not available!");
929298feadd7a547d50eb943c9ea15f6345a024bc9aDevang Patel    AnalysisResolver_New *AR = P->getResolver();
930298feadd7a547d50eb943c9ea15f6345a024bc9aDevang Patel    AR->addAnalysisImplsPair(*I, Impl);
9312f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel  }
9322f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel}
9332f42ed6b0b5161296cdd7e573b49fe631599fc97Devang Patel
93469867b511c732a7fac7301977bd6e880e46439f1Devang Patel/// Find the pass that implements Analysis AID. If desired pass is not found
93569867b511c732a7fac7301977bd6e880e46439f1Devang Patel/// then return NULL.
93669867b511c732a7fac7301977bd6e880e46439f1Devang PatelPass *PMDataManager::findAnalysisPass(AnalysisID AID, bool SearchParent) {
93769867b511c732a7fac7301977bd6e880e46439f1Devang Patel
93869867b511c732a7fac7301977bd6e880e46439f1Devang Patel  // Check if AvailableAnalysis map has one entry.
93969867b511c732a7fac7301977bd6e880e46439f1Devang Patel  std::map<AnalysisID, Pass*>::const_iterator I =  AvailableAnalysis.find(AID);
94069867b511c732a7fac7301977bd6e880e46439f1Devang Patel
94169867b511c732a7fac7301977bd6e880e46439f1Devang Patel  if (I != AvailableAnalysis.end())
94269867b511c732a7fac7301977bd6e880e46439f1Devang Patel    return I->second;
94369867b511c732a7fac7301977bd6e880e46439f1Devang Patel
94469867b511c732a7fac7301977bd6e880e46439f1Devang Patel  // Search Parents through TopLevelManager
94569867b511c732a7fac7301977bd6e880e46439f1Devang Patel  if (SearchParent)
94669867b511c732a7fac7301977bd6e880e46439f1Devang Patel    return TPM->findAnalysisPass(AID);
94769867b511c732a7fac7301977bd6e880e46439f1Devang Patel
9485b640e7edc606059717fb9c2ebcd85302c97fc21Devang Patel  return NULL;
94969867b511c732a7fac7301977bd6e880e46439f1Devang Patel}
95069867b511c732a7fac7301977bd6e880e46439f1Devang Patel
951f3dc6d9f95d4ba7756105154df4a8075bbbcf931Devang Patel
952f3dc6d9f95d4ba7756105154df4a8075bbbcf931Devang Patel//===----------------------------------------------------------------------===//
953f3dc6d9f95d4ba7756105154df4a8075bbbcf931Devang Patel// NOTE: Is this the right place to define this method ?
954f3dc6d9f95d4ba7756105154df4a8075bbbcf931Devang Patel// getAnalysisToUpdate - Return an analysis result or null if it doesn't exist
955f3dc6d9f95d4ba7756105154df4a8075bbbcf931Devang PatelPass *AnalysisResolver_New::getAnalysisToUpdate(AnalysisID ID, bool dir) const {
956f3dc6d9f95d4ba7756105154df4a8075bbbcf931Devang Patel  return PM.findAnalysisPass(ID, dir);
957f3dc6d9f95d4ba7756105154df4a8075bbbcf931Devang Patel}
958f3dc6d9f95d4ba7756105154df4a8075bbbcf931Devang Patel
95906e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel//===----------------------------------------------------------------------===//
9603162691f69f85f740bc28f3ddca39b166d35187cDevang Patel// BasicBlockPassManager implementation
96155fd43f90913676682487f89f27c756adb827f66Devang Patel
9622c5d1851bbcb20adb79664ec16ab1f97b9142086Devang Patel/// Add pass P into PassVector and return true. If this pass is not
9632c5d1851bbcb20adb79664ec16ab1f97b9142086Devang Patel/// manageable by this manager then return false.
96455fd43f90913676682487f89f27c756adb827f66Devang Patelbool
9653162691f69f85f740bc28f3ddca39b166d35187cDevang PatelBasicBlockPassManager::addPass(Pass *P) {
96655fd43f90913676682487f89f27c756adb827f66Devang Patel
96755fd43f90913676682487f89f27c756adb827f66Devang Patel  BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
96855fd43f90913676682487f89f27c756adb827f66Devang Patel  if (!BP)
96955fd43f90913676682487f89f27c756adb827f66Devang Patel    return false;
97055fd43f90913676682487f89f27c756adb827f66Devang Patel
97153596b6ba5d3199621e5a6e0cdbfcde3ee710397Devang Patel  // If this pass does not preserve anlysis that is used by other passes
97253596b6ba5d3199621e5a6e0cdbfcde3ee710397Devang Patel  // managed by this manager than it is not a suiable pass for this manager.
9732c5d1851bbcb20adb79664ec16ab1f97b9142086Devang Patel  if (!manageablePass(P))
97453596b6ba5d3199621e5a6e0cdbfcde3ee710397Devang Patel    return false;
97553596b6ba5d3199621e5a6e0cdbfcde3ee710397Devang Patel
976a84b3025ca7d437d2eab22d7c3002c8d89c31858Chris Lattner  addPassToManager(BP);
97714d6581a7374bdb4a66ef6c30250efdc324f6ddeDevang Patel
97855fd43f90913676682487f89f27c756adb827f66Devang Patel  return true;
97955fd43f90913676682487f89f27c756adb827f66Devang Patel}
98055fd43f90913676682487f89f27c756adb827f66Devang Patel
98155fd43f90913676682487f89f27c756adb827f66Devang Patel/// Execute all of the passes scheduled for execution by invoking
98255fd43f90913676682487f89f27c756adb827f66Devang Patel/// runOnBasicBlock method.  Keep track of whether any of the passes modifies
98355fd43f90913676682487f89f27c756adb827f66Devang Patel/// the function, and if so, return true.
98455fd43f90913676682487f89f27c756adb827f66Devang Patelbool
9853162691f69f85f740bc28f3ddca39b166d35187cDevang PatelBasicBlockPassManager::runOnFunction(Function &F) {
98655fd43f90913676682487f89f27c756adb827f66Devang Patel
9871fbe2c9964d57b2a58235541175f069ae491a95eDevang Patel  if (F.isExternal())
9881fbe2c9964d57b2a58235541175f069ae491a95eDevang Patel    return false;
9891fbe2c9964d57b2a58235541175f069ae491a95eDevang Patel
9903b14fbe300b96c353a9abfadf481b64324f17375Devang Patel  bool Changed = doInitialization(F);
991cbfd29d0da5810949ba66701b91c1b954122077aDevang Patel  initializeAnalysisInfo();
992c1d6e1fc9c3a47529f417026df652f466ce67851Devang Patel
993693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel  std::string Msg1 = "Executing Pass '";
994693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel  std::string Msg3 = "' Made Modification '";
995693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
99655fd43f90913676682487f89f27c756adb827f66Devang Patel  for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
997e253385b108cd946b1ac150302f246d3b218be77Devang Patel    for (std::vector<Pass *>::iterator itr = passVectorBegin(),
998e253385b108cd946b1ac150302f246d3b218be77Devang Patel           e = passVectorEnd(); itr != e; ++itr) {
99955fd43f90913676682487f89f27c756adb827f66Devang Patel      Pass *P = *itr;
1000017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel      AnalysisUsage AnUsage;
1001017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel      P->getAnalysisUsage(AnUsage);
1002017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel
10034eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel      std::string Msg2 = "' on BasicBlock '" + (*I).getName() + "'...\n";
10044eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel      dumpPassInfo(P, Msg1, Msg2);
1005017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel      dumpAnalysisSetInfo("Required", P, AnUsage.getRequiredSet());
1006017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel
100741545fd66316776e670deac302672c3d9acef2a2Devang Patel      initializeAnalysisImpl(P);
1008693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
100955fd43f90913676682487f89f27c756adb827f66Devang Patel      BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
10108e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel      if (TheTimeInfo) TheTimeInfo->passStarted(P);
101155fd43f90913676682487f89f27c756adb827f66Devang Patel      Changed |= BP->runOnBasicBlock(*I);
10128e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel      if (TheTimeInfo) TheTimeInfo->passEnded(P);
1013693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
1014693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel      if (Changed)
1015693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel        dumpPassInfo(P, Msg3, Msg2);
1016017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel      dumpAnalysisSetInfo("Preserved", P, AnUsage.getPreservedSet());
1017693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
1018c1d6e1fc9c3a47529f417026df652f466ce67851Devang Patel      removeNotPreservedAnalysis(P);
10190ac961d9c1c511204abfb02f5c25c92da6b75eb6Devang Patel      recordAvailableAnalysis(P);
10204eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel      removeDeadPasses(P, Msg2);
102155fd43f90913676682487f89f27c756adb827f66Devang Patel    }
10223b14fbe300b96c353a9abfadf481b64324f17375Devang Patel  return Changed | doFinalization(F);
102355fd43f90913676682487f89f27c756adb827f66Devang Patel}
102455fd43f90913676682487f89f27c756adb827f66Devang Patel
1025964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel// Implement doInitialization and doFinalization
10263162691f69f85f740bc28f3ddca39b166d35187cDevang Patelinline bool BasicBlockPassManager::doInitialization(Module &M) {
1027964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  bool Changed = false;
1028964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
1029964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1030964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel         e = passVectorEnd(); itr != e; ++itr) {
1031964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel    Pass *P = *itr;
1032964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel    BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
1033964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel    Changed |= BP->doInitialization(M);
1034964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  }
1035964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
1036964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  return Changed;
1037964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel}
1038964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
10393162691f69f85f740bc28f3ddca39b166d35187cDevang Patelinline bool BasicBlockPassManager::doFinalization(Module &M) {
1040964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  bool Changed = false;
1041964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
1042964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1043964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel         e = passVectorEnd(); itr != e; ++itr) {
1044964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel    Pass *P = *itr;
1045964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel    BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
1046964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel    Changed |= BP->doFinalization(M);
1047964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  }
1048964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
1049964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  return Changed;
1050964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel}
1051964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
10523162691f69f85f740bc28f3ddca39b166d35187cDevang Patelinline bool BasicBlockPassManager::doInitialization(Function &F) {
1053964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  bool Changed = false;
1054964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
1055964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1056964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel         e = passVectorEnd(); itr != e; ++itr) {
1057964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel    Pass *P = *itr;
1058964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel    BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
1059964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel    Changed |= BP->doInitialization(F);
1060964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  }
1061964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
1062964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  return Changed;
1063964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel}
1064964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
10653162691f69f85f740bc28f3ddca39b166d35187cDevang Patelinline bool BasicBlockPassManager::doFinalization(Function &F) {
1066964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  bool Changed = false;
1067964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
1068964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1069964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel         e = passVectorEnd(); itr != e; ++itr) {
1070964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel    Pass *P = *itr;
1071964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel    BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
1072964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel    Changed |= BP->doFinalization(F);
1073964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  }
1074964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
1075964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel  return Changed;
1076964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel}
1077964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
1078964e45e60769ccdb4ee0230a179f84f37f6c371aDevang Patel
107906e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel//===----------------------------------------------------------------------===//
10803162691f69f85f740bc28f3ddca39b166d35187cDevang Patel// FunctionPassManager implementation
108106e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel
1082c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel/// Create new Function pass manager
10833162691f69f85f740bc28f3ddca39b166d35187cDevang PatelFunctionPassManager::FunctionPassManager(ModuleProvider *P) {
1084cc132cd9feef765fe70284183c0f997b4faa5483Devang Patel  FPM = new FunctionPassManagerImpl_New(0);
1085dff33ef8e863241193463fd0129657c5ebce4d58Devang Patel  // FPM is the top level manager.
1086dff33ef8e863241193463fd0129657c5ebce4d58Devang Patel  FPM->setTopLevelManager(FPM);
1087b920bd85adba95553568cef6a7078ee2509ab804Devang Patel
1088b920bd85adba95553568cef6a7078ee2509ab804Devang Patel  PMDataManager *PMD = dynamic_cast<PMDataManager *>(FPM);
1089b920bd85adba95553568cef6a7078ee2509ab804Devang Patel  AnalysisResolver_New *AR = new AnalysisResolver_New(*PMD);
1090b920bd85adba95553568cef6a7078ee2509ab804Devang Patel  FPM->setResolver(AR);
1091b920bd85adba95553568cef6a7078ee2509ab804Devang Patel
1092b920bd85adba95553568cef6a7078ee2509ab804Devang Patel  FPM->addPassManager(FPM);
1093cc132cd9feef765fe70284183c0f997b4faa5483Devang Patel  MP = P;
1094cc132cd9feef765fe70284183c0f997b4faa5483Devang Patel}
1095cc132cd9feef765fe70284183c0f997b4faa5483Devang Patel
10963162691f69f85f740bc28f3ddca39b166d35187cDevang PatelFunctionPassManager::~FunctionPassManager() {
10973162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  // Note : FPM maintains one entry in PassManagers vector.
10983162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  // This one entry is FPM itself. This is not ideal. One
10993162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  // alternative is have one additional layer between
11003162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  // FunctionPassManager and FunctionPassManagerImpl.
11013162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  // Meanwhile, to avoid going into infinte loop, first
11023162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  // remove FPM from its PassMangers vector.
11033162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  FPM->clearManagers();
110437a6f7966c39f69a92419d37949a94a758c29e90Devang Patel  delete FPM;
110537a6f7966c39f69a92419d37949a94a758c29e90Devang Patel}
110637a6f7966c39f69a92419d37949a94a758c29e90Devang Patel
1107c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel/// add - Add a pass to the queue of passes to run.  This passes
1108c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel/// ownership of the Pass to the PassManager.  When the
1109c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel/// PassManager_X is destroyed, the pass will be destroyed as well, so
1110c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel/// there is no need to delete the pass. (TODO delete passes.)
1111c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel/// This implies that all passes MUST be allocated with 'new'.
11123162691f69f85f740bc28f3ddca39b166d35187cDevang Patelvoid FunctionPassManager::add(Pass *P) {
1113c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel  FPM->add(P);
1114c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel}
1115c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel
1116214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel/// run - Execute all of the passes scheduled for execution.  Keep
1117214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel/// track of whether any of the passes modifies the function, and if
1118214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel/// so, return true.
1119214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel///
11203162691f69f85f740bc28f3ddca39b166d35187cDevang Patelbool FunctionPassManager::run(Function &F) {
1121214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel  std::string errstr;
1122214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel  if (MP->materializeFunction(&F, &errstr)) {
1123e81561909d128c6e2d8033cb5465a49b2596b26aBill Wendling    cerr << "Error reading bytecode file: " << errstr << "\n";
1124214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel    abort();
1125214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel  }
1126c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel  return FPM->run(F);
1127214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel}
1128214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel
1129214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel
11303799f97d539f6c288d169063e1b335917fafcffbDevang Patel/// doInitialization - Run all of the initializers for the function passes.
11313799f97d539f6c288d169063e1b335917fafcffbDevang Patel///
11323162691f69f85f740bc28f3ddca39b166d35187cDevang Patelbool FunctionPassManager::doInitialization() {
11333799f97d539f6c288d169063e1b335917fafcffbDevang Patel  return FPM->doInitialization(*MP->getModule());
11343799f97d539f6c288d169063e1b335917fafcffbDevang Patel}
11353799f97d539f6c288d169063e1b335917fafcffbDevang Patel
11363799f97d539f6c288d169063e1b335917fafcffbDevang Patel/// doFinalization - Run all of the initializers for the function passes.
11373799f97d539f6c288d169063e1b335917fafcffbDevang Patel///
11383162691f69f85f740bc28f3ddca39b166d35187cDevang Patelbool FunctionPassManager::doFinalization() {
11393799f97d539f6c288d169063e1b335917fafcffbDevang Patel  return FPM->doFinalization(*MP->getModule());
11403799f97d539f6c288d169063e1b335917fafcffbDevang Patel}
11413799f97d539f6c288d169063e1b335917fafcffbDevang Patel
114206e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel//===----------------------------------------------------------------------===//
1143c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel// FunctionPassManagerImpl_New implementation
1144448d27cd795dc273249f123444509403f4fa4facDevang Patel
1145448d27cd795dc273249f123444509403f4fa4facDevang Patel/// Add pass P into the pass manager queue. If P is a BasicBlockPass then
1146448d27cd795dc273249f123444509403f4fa4facDevang Patel/// either use it into active basic block pass manager or create new basic
1147448d27cd795dc273249f123444509403f4fa4facDevang Patel/// block pass manager to handle pass P.
1148448d27cd795dc273249f123444509403f4fa4facDevang Patelbool
1149c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang PatelFunctionPassManagerImpl_New::addPass(Pass *P) {
1150448d27cd795dc273249f123444509403f4fa4facDevang Patel
11513162691f69f85f740bc28f3ddca39b166d35187cDevang Patel  // If P is a BasicBlockPass then use BasicBlockPassManager.
1152448d27cd795dc273249f123444509403f4fa4facDevang Patel  if (BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P)) {
1153448d27cd795dc273249f123444509403f4fa4facDevang Patel
1154badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel    if (!activeBBPassManager || !activeBBPassManager->addPass(BP)) {
1155448d27cd795dc273249f123444509403f4fa4facDevang Patel
1156badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel      // If active manager exists then clear its analysis info.
1157badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel      if (activeBBPassManager)
1158badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel        activeBBPassManager->initializeAnalysisInfo();
1159b917e38c84fa9c7c434762a0e587af63eec939e5Devang Patel
1160badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel      // Create and add new manager
1161f72d29c540bf32b9c0e8914484cbbdeac70ee12aDevang Patel      activeBBPassManager =
11623162691f69f85f740bc28f3ddca39b166d35187cDevang Patel        new BasicBlockPassManager(getDepth() + 1);
1163dff33ef8e863241193463fd0129657c5ebce4d58Devang Patel      // Inherit top level manager
1164dff33ef8e863241193463fd0129657c5ebce4d58Devang Patel      activeBBPassManager->setTopLevelManager(this->getTopLevelManager());
11651b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
11661b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      // Add new manager into current manager's list.
1167893a5a681585cdf3b5bfff7128ea522e8a47750aDevang Patel      addPassToManager(activeBBPassManager, false);
11681b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
11691b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      // Add new manager into top level manager's indirect passes list
11701b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      PMDataManager *PMD = dynamic_cast<PMDataManager *>(activeBBPassManager);
11711b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      assert (PMD && "Manager is not Pass Manager");
11721b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      TPM->addIndirectPassManager(PMD);
1173badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel
1174badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel      // Add pass into new manager. This time it must succeed.
11752c5d1851bbcb20adb79664ec16ab1f97b9142086Devang Patel      if (!activeBBPassManager->addPass(BP))
11762c5d1851bbcb20adb79664ec16ab1f97b9142086Devang Patel        assert(0 && "Unable to add Pass");
1177ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel
1178ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel      // If activeBBPassManager transfered any Last Uses then handle them here.
1179ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel      std::vector<Pass *> &TLU = activeBBPassManager->getTransferredLastUses();
1180ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel      if (!TLU.empty())
1181ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel        TPM->setLastUser(TLU, this);
1182ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel
1183448d27cd795dc273249f123444509403f4fa4facDevang Patel    }
1184e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
1185e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
1186448d27cd795dc273249f123444509403f4fa4facDevang Patel    return true;
1187448d27cd795dc273249f123444509403f4fa4facDevang Patel  }
1188448d27cd795dc273249f123444509403f4fa4facDevang Patel
1189448d27cd795dc273249f123444509403f4fa4facDevang Patel  FunctionPass *FP = dynamic_cast<FunctionPass *>(P);
1190448d27cd795dc273249f123444509403f4fa4facDevang Patel  if (!FP)
1191448d27cd795dc273249f123444509403f4fa4facDevang Patel    return false;
1192448d27cd795dc273249f123444509403f4fa4facDevang Patel
119353596b6ba5d3199621e5a6e0cdbfcde3ee710397Devang Patel  // If this pass does not preserve anlysis that is used by other passes
119453596b6ba5d3199621e5a6e0cdbfcde3ee710397Devang Patel  // managed by this manager than it is not a suiable pass for this manager.
11952c5d1851bbcb20adb79664ec16ab1f97b9142086Devang Patel  if (!manageablePass(P))
119653596b6ba5d3199621e5a6e0cdbfcde3ee710397Devang Patel    return false;
119753596b6ba5d3199621e5a6e0cdbfcde3ee710397Devang Patel
1198e253385b108cd946b1ac150302f246d3b218be77Devang Patel  addPassToManager (FP);
1199badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel
1200badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel  // If active manager exists then clear its analysis info.
1201badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel  if (activeBBPassManager) {
1202badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel    activeBBPassManager->initializeAnalysisInfo();
1203badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel    activeBBPassManager = NULL;
1204badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel  }
1205badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel
1206448d27cd795dc273249f123444509403f4fa4facDevang Patel  return true;
1207448d27cd795dc273249f123444509403f4fa4facDevang Patel}
1208448d27cd795dc273249f123444509403f4fa4facDevang Patel
1209448d27cd795dc273249f123444509403f4fa4facDevang Patel/// Execute all of the passes scheduled for execution by invoking
1210448d27cd795dc273249f123444509403f4fa4facDevang Patel/// runOnFunction method.  Keep track of whether any of the passes modifies
1211448d27cd795dc273249f123444509403f4fa4facDevang Patel/// the function, and if so, return true.
1212214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patelbool FunctionPassManagerImpl_New::runOnModule(Module &M) {
1213448d27cd795dc273249f123444509403f4fa4facDevang Patel
12144d9a186b10dacf1d702ef32c2638e9016d8f483bDevang Patel  bool Changed = doInitialization(M);
1215cbfd29d0da5810949ba66701b91c1b954122077aDevang Patel  initializeAnalysisInfo();
1216c1d6e1fc9c3a47529f417026df652f466ce67851Devang Patel
1217448d27cd795dc273249f123444509403f4fa4facDevang Patel  for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
121897856ceeab2297e09c46c2390f7b3d818df6f1f7Devang Patel    this->runOnFunction(*I);
121997856ceeab2297e09c46c2390f7b3d818df6f1f7Devang Patel
12204d9a186b10dacf1d702ef32c2638e9016d8f483bDevang Patel  return Changed | doFinalization(M);
1221448d27cd795dc273249f123444509403f4fa4facDevang Patel}
1222448d27cd795dc273249f123444509403f4fa4facDevang Patel
1223214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel/// Execute all of the passes scheduled for execution by invoking
1224214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel/// runOnFunction method.  Keep track of whether any of the passes modifies
1225214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel/// the function, and if so, return true.
1226214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patelbool FunctionPassManagerImpl_New::runOnFunction(Function &F) {
1227214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel
1228214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel  bool Changed = false;
12291fbe2c9964d57b2a58235541175f069ae491a95eDevang Patel
12301fbe2c9964d57b2a58235541175f069ae491a95eDevang Patel  if (F.isExternal())
12311fbe2c9964d57b2a58235541175f069ae491a95eDevang Patel    return false;
12321fbe2c9964d57b2a58235541175f069ae491a95eDevang Patel
1233cbfd29d0da5810949ba66701b91c1b954122077aDevang Patel  initializeAnalysisInfo();
1234214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel
1235693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel  std::string Msg1 = "Executing Pass '";
1236693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel  std::string Msg3 = "' Made Modification '";
1237693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
1238214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel  for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1239214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel         e = passVectorEnd(); itr != e; ++itr) {
1240214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel    Pass *P = *itr;
1241017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel    AnalysisUsage AnUsage;
1242017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel    P->getAnalysisUsage(AnUsage);
1243693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
12444eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel    std::string Msg2 = "' on Function '" + F.getName() + "'...\n";
12454eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel    dumpPassInfo(P, Msg1, Msg2);
1246017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel    dumpAnalysisSetInfo("Required", P, AnUsage.getRequiredSet());
1247693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
124841545fd66316776e670deac302672c3d9acef2a2Devang Patel    initializeAnalysisImpl(P);
1249214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel    FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
12508e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
12518e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    if (TheTimeInfo) TheTimeInfo->passStarted(P);
1252214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel    Changed |= FP->runOnFunction(F);
12538e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    if (TheTimeInfo) TheTimeInfo->passEnded(P);
1254693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
1255693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel    if (Changed)
1256693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel      dumpPassInfo(P, Msg3, Msg2);
1257017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel    dumpAnalysisSetInfo("Preserved", P, AnUsage.getPreservedSet());
1258693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
1259214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel    removeNotPreservedAnalysis(P);
12600ac961d9c1c511204abfb02f5c25c92da6b75eb6Devang Patel    recordAvailableAnalysis(P);
12614eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel    removeDeadPasses(P, Msg2);
1262214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel  }
1263214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel  return Changed;
1264214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel}
1265214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel
1266214ca23aef8bd408c4ee4ce28ba93d57d2416587Devang Patel
12673799f97d539f6c288d169063e1b335917fafcffbDevang Patelinline bool FunctionPassManagerImpl_New::doInitialization(Module &M) {
12683799f97d539f6c288d169063e1b335917fafcffbDevang Patel  bool Changed = false;
12693799f97d539f6c288d169063e1b335917fafcffbDevang Patel
12703799f97d539f6c288d169063e1b335917fafcffbDevang Patel  for (std::vector<Pass *>::iterator itr = passVectorBegin(),
12713799f97d539f6c288d169063e1b335917fafcffbDevang Patel         e = passVectorEnd(); itr != e; ++itr) {
12723799f97d539f6c288d169063e1b335917fafcffbDevang Patel    Pass *P = *itr;
12733799f97d539f6c288d169063e1b335917fafcffbDevang Patel
12743799f97d539f6c288d169063e1b335917fafcffbDevang Patel    FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
12753799f97d539f6c288d169063e1b335917fafcffbDevang Patel    Changed |= FP->doInitialization(M);
12763799f97d539f6c288d169063e1b335917fafcffbDevang Patel  }
12773799f97d539f6c288d169063e1b335917fafcffbDevang Patel
12783799f97d539f6c288d169063e1b335917fafcffbDevang Patel  return Changed;
12793799f97d539f6c288d169063e1b335917fafcffbDevang Patel}
12803799f97d539f6c288d169063e1b335917fafcffbDevang Patel
12813799f97d539f6c288d169063e1b335917fafcffbDevang Patelinline bool FunctionPassManagerImpl_New::doFinalization(Module &M) {
12823799f97d539f6c288d169063e1b335917fafcffbDevang Patel  bool Changed = false;
12833799f97d539f6c288d169063e1b335917fafcffbDevang Patel
12843799f97d539f6c288d169063e1b335917fafcffbDevang Patel  for (std::vector<Pass *>::iterator itr = passVectorBegin(),
12853799f97d539f6c288d169063e1b335917fafcffbDevang Patel         e = passVectorEnd(); itr != e; ++itr) {
12863799f97d539f6c288d169063e1b335917fafcffbDevang Patel    Pass *P = *itr;
12873799f97d539f6c288d169063e1b335917fafcffbDevang Patel
12883799f97d539f6c288d169063e1b335917fafcffbDevang Patel    FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
12893799f97d539f6c288d169063e1b335917fafcffbDevang Patel    Changed |= FP->doFinalization(M);
12903799f97d539f6c288d169063e1b335917fafcffbDevang Patel  }
12913799f97d539f6c288d169063e1b335917fafcffbDevang Patel
12923799f97d539f6c288d169063e1b335917fafcffbDevang Patel  return Changed;
12933799f97d539f6c288d169063e1b335917fafcffbDevang Patel}
12943799f97d539f6c288d169063e1b335917fafcffbDevang Patel
1295c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel// Execute all the passes managed by this top level manager.
1296c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel// Return true if any function is modified by a pass.
1297c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patelbool FunctionPassManagerImpl_New::run(Function &F) {
1298c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel
1299c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel  bool Changed = false;
1300c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel  for (std::vector<Pass *>::iterator I = passManagersBegin(),
1301c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel         E = passManagersEnd(); I != E; ++I) {
13023162691f69f85f740bc28f3ddca39b166d35187cDevang Patel    FunctionPassManagerImpl_New *FP =
13033162691f69f85f740bc28f3ddca39b166d35187cDevang Patel      dynamic_cast<FunctionPassManagerImpl_New *>(*I);
1304c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel    Changed |= FP->runOnFunction(F);
1305c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel  }
1306c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel  return Changed;
1307c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel}
1308c475692c5ee2f9c0c6988b7ec28768ef6690bfb0Devang Patel
130906e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel//===----------------------------------------------------------------------===//
131092c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel// ModulePassManager implementation
131192c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel
131292c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel/// Add P into pass vector if it is manageble. If P is a FunctionPass
1313c63592b19ecd54a1318a19d87b5c0bd85f172a4fDevang Patel/// then use FunctionPassManagerImpl_New to manage it. Return false if P
131492c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel/// is not manageable by this manager.
131592c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patelbool
13163162691f69f85f740bc28f3ddca39b166d35187cDevang PatelModulePassManager::addPass(Pass *P) {
131792c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel
131892c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel  // If P is FunctionPass then use function pass maanager.
131992c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel  if (FunctionPass *FP = dynamic_cast<FunctionPass*>(P)) {
132092c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel
132169867b511c732a7fac7301977bd6e880e46439f1Devang Patel    if (!activeFunctionPassManager || !activeFunctionPassManager->addPass(P)) {
132292c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel
1323badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel      // If active manager exists then clear its analysis info.
1324badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel      if (activeFunctionPassManager)
1325badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel        activeFunctionPassManager->initializeAnalysisInfo();
1326b917e38c84fa9c7c434762a0e587af63eec939e5Devang Patel
1327badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel      // Create and add new manager
1328f72d29c540bf32b9c0e8914484cbbdeac70ee12aDevang Patel      activeFunctionPassManager =
1329f72d29c540bf32b9c0e8914484cbbdeac70ee12aDevang Patel        new FunctionPassManagerImpl_New(getDepth() + 1);
13301b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
13311b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      // Add new manager into current manager's list
1332893a5a681585cdf3b5bfff7128ea522e8a47750aDevang Patel      addPassToManager(activeFunctionPassManager, false);
13331b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
1334dff33ef8e863241193463fd0129657c5ebce4d58Devang Patel      // Inherit top level manager
1335dff33ef8e863241193463fd0129657c5ebce4d58Devang Patel      activeFunctionPassManager->setTopLevelManager(this->getTopLevelManager());
13361b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel
13371b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      // Add new manager into top level manager's indirect passes list
13386e9e5e026af9e26cdec634c79017199f4e718599Chris Lattner      PMDataManager *PMD =
13396e9e5e026af9e26cdec634c79017199f4e718599Chris Lattner        dynamic_cast<PMDataManager *>(activeFunctionPassManager);
13406e9e5e026af9e26cdec634c79017199f4e718599Chris Lattner      assert(PMD && "Manager is not Pass Manager");
13411b8d015066dca364a1b11b6dbe5b80248b111cd5Devang Patel      TPM->addIndirectPassManager(PMD);
1342591b1b7526ed9c099de23cc995853a250c20502fDevang Patel
1343badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel      // Add pass into new manager. This time it must succeed.
13442c5d1851bbcb20adb79664ec16ab1f97b9142086Devang Patel      if (!activeFunctionPassManager->addPass(FP))
13452c5d1851bbcb20adb79664ec16ab1f97b9142086Devang Patel        assert(0 && "Unable to add pass");
1346e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
1347ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel      // If activeFunctionPassManager transfered any Last Uses then
1348ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel      // handle them here.
1349ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel      std::vector<Pass *> &TLU =
1350ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel        activeFunctionPassManager->getTransferredLastUses();
1351ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel      if (!TLU.empty())
1352ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel        TPM->setLastUser(TLU, this);
1353ef89c5594aaa5b97f303ba0de99940b79f2c0e0eDevang Patel    }
1354e16634065021e36ae31f074f623a636924d6b8d1Devang Patel
135592c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel    return true;
135692c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel  }
135792c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel
135892c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel  ModulePass *MP = dynamic_cast<ModulePass *>(P);
135992c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel  if (!MP)
136092c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel    return false;
136192c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel
136253596b6ba5d3199621e5a6e0cdbfcde3ee710397Devang Patel  // If this pass does not preserve anlysis that is used by other passes
136353596b6ba5d3199621e5a6e0cdbfcde3ee710397Devang Patel  // managed by this manager than it is not a suiable pass for this manager.
13642c5d1851bbcb20adb79664ec16ab1f97b9142086Devang Patel  if (!manageablePass(P))
136553596b6ba5d3199621e5a6e0cdbfcde3ee710397Devang Patel    return false;
136653596b6ba5d3199621e5a6e0cdbfcde3ee710397Devang Patel
1367e253385b108cd946b1ac150302f246d3b218be77Devang Patel  addPassToManager(MP);
1368badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel  // If active manager exists then clear its analysis info.
1369badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel  if (activeFunctionPassManager) {
1370badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel    activeFunctionPassManager->initializeAnalysisInfo();
1371badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel    activeFunctionPassManager = NULL;
1372badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel  }
1373badc4fae531cc0fdaa8e58f481c3b1d23ea7dd56Devang Patel
137492c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel  return true;
137592c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel}
137692c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel
137792c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel
137892c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel/// Execute all of the passes scheduled for execution by invoking
137992c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel/// runOnModule method.  Keep track of whether any of the passes modifies
138092c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel/// the module, and if so, return true.
138192c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patelbool
13823162691f69f85f740bc28f3ddca39b166d35187cDevang PatelModulePassManager::runOnModule(Module &M) {
138392c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel  bool Changed = false;
1384cbfd29d0da5810949ba66701b91c1b954122077aDevang Patel  initializeAnalysisInfo();
1385c1d6e1fc9c3a47529f417026df652f466ce67851Devang Patel
1386693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel  std::string Msg1 = "Executing Pass '";
1387693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel  std::string Msg3 = "' Made Modification '";
1388693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
1389e253385b108cd946b1ac150302f246d3b218be77Devang Patel  for (std::vector<Pass *>::iterator itr = passVectorBegin(),
1390e253385b108cd946b1ac150302f246d3b218be77Devang Patel         e = passVectorEnd(); itr != e; ++itr) {
139192c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel    Pass *P = *itr;
1392017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel    AnalysisUsage AnUsage;
1393017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel    P->getAnalysisUsage(AnUsage);
1394693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
13954eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel    std::string Msg2 = "' on Module '" + M.getModuleIdentifier() + "'...\n";
13964eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel    dumpPassInfo(P, Msg1, Msg2);
1397017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel    dumpAnalysisSetInfo("Required", P, AnUsage.getRequiredSet());
1398693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
139941545fd66316776e670deac302672c3d9acef2a2Devang Patel    initializeAnalysisImpl(P);
140092c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel    ModulePass *MP = dynamic_cast<ModulePass*>(P);
14018e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
14028e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    if (TheTimeInfo) TheTimeInfo->passStarted(P);
140392c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel    Changed |= MP->runOnModule(M);
14048e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel    if (TheTimeInfo) TheTimeInfo->passEnded(P);
1405693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel
1406693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel    if (Changed)
1407693a74e4ee34e2058dab7121c17c98ec59258a8aDevang Patel      dumpPassInfo(P, Msg3, Msg2);
1408017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel    dumpAnalysisSetInfo("Preserved", P, AnUsage.getPreservedSet());
1409017b5d969b12119a88463fe2451f20ca9214c4ffDevang Patel
1410c1d6e1fc9c3a47529f417026df652f466ce67851Devang Patel    removeNotPreservedAnalysis(P);
14110ac961d9c1c511204abfb02f5c25c92da6b75eb6Devang Patel    recordAvailableAnalysis(P);
14124eeea774ce1b24fa55c06aac31e02016d5dd77d6Devang Patel    removeDeadPasses(P, Msg2);
141392c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel  }
141492c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel  return Changed;
141592c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel}
141692c45eebf77de5d6ee84a3f18f560b83cb68e720Devang Patel
141706e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel//===----------------------------------------------------------------------===//
141806e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel// PassManagerImpl implementation
141937a6f7966c39f69a92419d37949a94a758c29e90Devang Patel//
1420b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel/// Add P into active pass manager or use new module pass manager to
1421b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel/// manage it.
1422f8af6f0ec15d117cfe47bf32dd4e46ab52d42254Devang Patelbool PassManagerImpl_New::addPass(Pass *P) {
1423b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel
1424a363a0bdefd2e798a83acd8998591b5b07c4256eDevang Patel  if (!activeManager || !activeManager->addPass(P)) {
14253162691f69f85f740bc28f3ddca39b166d35187cDevang Patel    activeManager = new ModulePassManager(getDepth() + 1);
1426dff33ef8e863241193463fd0129657c5ebce4d58Devang Patel    // Inherit top level manager
1427dff33ef8e863241193463fd0129657c5ebce4d58Devang Patel    activeManager->setTopLevelManager(this->getTopLevelManager());
1428145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel
1429145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel    // This top level manager is going to manage activeManager.
1430145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel    // Set up analysis resolver to connect them.
1431145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel    AnalysisResolver_New *AR = new AnalysisResolver_New(*this);
1432145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel    activeManager->setResolver(AR);
1433145e83dc12a3f962b999f348474ebb07a36a7b81Devang Patel
1434a083e94f7971ddafb817b1bcd86992d9fc4d8f9eDevang Patel    addPassManager(activeManager);
1435502f19e0f8ba47b5916a7e9d445f4ee071cdf132Devang Patel    return activeManager->addPass(P);
1436b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel  }
1437502f19e0f8ba47b5916a7e9d445f4ee071cdf132Devang Patel  return true;
1438b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel}
1439b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel
1440b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel/// run - Execute all of the passes scheduled for execution.  Keep track of
1441b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel/// whether any of the passes modifies the module, and if so, return true.
1442f8af6f0ec15d117cfe47bf32dd4e46ab52d42254Devang Patelbool PassManagerImpl_New::run(Module &M) {
1443b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel
1444b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel  bool Changed = false;
144545dc02d6f97447785ee7ffe08c36a34bc8921b0bDevang Patel
14468e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  TimingInfo::createTheTimeInfo();
14478e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
1448c32cf54101ecaf336d161fecd58667870149169cDevang Patel  dumpArguments();
1449e8ff1ce7343c697ff90d940c8c5fa8fccc09220dDevang Patel  if (PassDebugging_New >= Structure)
145045dc02d6f97447785ee7ffe08c36a34bc8921b0bDevang Patel    dumpPasses();
145145dc02d6f97447785ee7ffe08c36a34bc8921b0bDevang Patel
1452a083e94f7971ddafb817b1bcd86992d9fc4d8f9eDevang Patel  for (std::vector<Pass *>::iterator I = passManagersBegin(),
1453a083e94f7971ddafb817b1bcd86992d9fc4d8f9eDevang Patel         E = passManagersEnd(); I != E; ++I) {
14543162691f69f85f740bc28f3ddca39b166d35187cDevang Patel    ModulePassManager *MP = dynamic_cast<ModulePassManager *>(*I);
1455a083e94f7971ddafb817b1bcd86992d9fc4d8f9eDevang Patel    Changed |= MP->runOnModule(M);
1456b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel  }
1457b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel  return Changed;
1458b30803bc17a5be655b7c4ef356e75ae5524b0931Devang Patel}
14595a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
146006e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel//===----------------------------------------------------------------------===//
146106e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel// PassManager implementation
146206e86561a5261a59f5c391d5cc5cb4aa38dca83cDevang Patel
14635a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel/// Create new pass manager
14643162691f69f85f740bc28f3ddca39b166d35187cDevang PatelPassManager::PassManager() {
1465f72d29c540bf32b9c0e8914484cbbdeac70ee12aDevang Patel  PM = new PassManagerImpl_New(0);
1466dff33ef8e863241193463fd0129657c5ebce4d58Devang Patel  // PM is the top level manager
1467dff33ef8e863241193463fd0129657c5ebce4d58Devang Patel  PM->setTopLevelManager(PM);
14685a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel}
14695a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
14703162691f69f85f740bc28f3ddca39b166d35187cDevang PatelPassManager::~PassManager() {
147137a6f7966c39f69a92419d37949a94a758c29e90Devang Patel  delete PM;
147237a6f7966c39f69a92419d37949a94a758c29e90Devang Patel}
147337a6f7966c39f69a92419d37949a94a758c29e90Devang Patel
14745a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel/// add - Add a pass to the queue of passes to run.  This passes ownership of
14755a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel/// the Pass to the PassManager.  When the PassManager is destroyed, the pass
14765a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel/// will be destroyed as well, so there is no need to delete the pass.  This
14775a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel/// implies that all passes MUST be allocated with 'new'.
14785a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patelvoid
14793162691f69f85f740bc28f3ddca39b166d35187cDevang PatelPassManager::add(Pass *P) {
14805a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  PM->add(P);
14815a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel}
14825a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
14835a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel/// run - Execute all of the passes scheduled for execution.  Keep track of
14845a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel/// whether any of the passes modifies the module, and if so, return true.
14855a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patelbool
14863162691f69f85f740bc28f3ddca39b166d35187cDevang PatelPassManager::run(Module &M) {
14875a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel  return PM->run(M);
14885a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel}
14895a39b2e8067450839a1a041a26e2f9d8dd07f40aDevang Patel
14908e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel//===----------------------------------------------------------------------===//
14918e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel// TimingInfo Class - This class is used to calculate information about the
14928e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel// amount of time each pass takes to execute.  This only happens with
14938e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel// -time-passes is enabled on the command line.
14948e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel//
14958e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patelbool llvm::TimePassesIsEnabled = false;
14968e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patelstatic cl::opt<bool,true>
14978e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang PatelEnableTiming("time-passes", cl::location(TimePassesIsEnabled),
14988e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel            cl::desc("Time each pass, printing elapsed time for each on exit"));
14998e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
15008e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel// createTheTimeInfo - This method either initializes the TheTimeInfo pointer to
15018e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel// a non null value (if the -time-passes option is enabled) or it leaves it
15028e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel// null.  It may be called multiple times.
15038e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patelvoid TimingInfo::createTheTimeInfo() {
15048e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  if (!TimePassesIsEnabled || TheTimeInfo) return;
15058e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
15068e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  // Constructed the first time this is called, iff -time-passes is enabled.
15078e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  // This guarantees that the object will be constructed before static globals,
15088e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  // thus it will be destroyed before them.
15098e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  static ManagedStatic<TimingInfo> TTI;
15108e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel  TheTimeInfo = &*TTI;
15118e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel}
15128e58a1b17bb57e6ffa187a0ec758f9a1bed7685bDevang Patel
15133162691f69f85f740bc28f3ddca39b166d35187cDevang Patel#endif
1514