Home | History | Annotate | Download | only in llvm
      1 //===- llvm/PassManagers.h - Pass Infrastructure classes  -------*- C++ -*-===//
      2 //
      3 //                     The LLVM Compiler Infrastructure
      4 //
      5 // This file is distributed under the University of Illinois Open Source
      6 // License. See LICENSE.TXT for details.
      7 //
      8 //===----------------------------------------------------------------------===//
      9 //
     10 // This file declares the LLVM Pass Manager infrastructure.
     11 //
     12 //===----------------------------------------------------------------------===//
     13 
     14 #ifndef LLVM_PASSMANAGERS_H
     15 #define LLVM_PASSMANAGERS_H
     16 
     17 #include "llvm/Pass.h"
     18 #include "llvm/ADT/SmallVector.h"
     19 #include "llvm/ADT/SmallPtrSet.h"
     20 #include "llvm/ADT/DenseMap.h"
     21 #include <vector>
     22 #include <map>
     23 
     24 //===----------------------------------------------------------------------===//
     25 // Overview:
     26 // The Pass Manager Infrastructure manages passes. It's responsibilities are:
     27 //
     28 //   o Manage optimization pass execution order
     29 //   o Make required Analysis information available before pass P is run
     30 //   o Release memory occupied by dead passes
     31 //   o If Analysis information is dirtied by a pass then regenerate Analysis
     32 //     information before it is consumed by another pass.
     33 //
     34 // Pass Manager Infrastructure uses multiple pass managers.  They are
     35 // PassManager, FunctionPassManager, MPPassManager, FPPassManager, BBPassManager.
     36 // This class hierarchy uses multiple inheritance but pass managers do not
     37 // derive from another pass manager.
     38 //
     39 // PassManager and FunctionPassManager are two top-level pass manager that
     40 // represents the external interface of this entire pass manager infrastucture.
     41 //
     42 // Important classes :
     43 //
     44 // [o] class PMTopLevelManager;
     45 //
     46 // Two top level managers, PassManager and FunctionPassManager, derive from
     47 // PMTopLevelManager. PMTopLevelManager manages information used by top level
     48 // managers such as last user info.
     49 //
     50 // [o] class PMDataManager;
     51 //
     52 // PMDataManager manages information, e.g. list of available analysis info,
     53 // used by a pass manager to manage execution order of passes. It also provides
     54 // a place to implement common pass manager APIs. All pass managers derive from
     55 // PMDataManager.
     56 //
     57 // [o] class BBPassManager : public FunctionPass, public PMDataManager;
     58 //
     59 // BBPassManager manages BasicBlockPasses.
     60 //
     61 // [o] class FunctionPassManager;
     62 //
     63 // This is a external interface used by JIT to manage FunctionPasses. This
     64 // interface relies on FunctionPassManagerImpl to do all the tasks.
     65 //
     66 // [o] class FunctionPassManagerImpl : public ModulePass, PMDataManager,
     67 //                                     public PMTopLevelManager;
     68 //
     69 // FunctionPassManagerImpl is a top level manager. It manages FPPassManagers
     70 //
     71 // [o] class FPPassManager : public ModulePass, public PMDataManager;
     72 //
     73 // FPPassManager manages FunctionPasses and BBPassManagers
     74 //
     75 // [o] class MPPassManager : public Pass, public PMDataManager;
     76 //
     77 // MPPassManager manages ModulePasses and FPPassManagers
     78 //
     79 // [o] class PassManager;
     80 //
     81 // This is a external interface used by various tools to manages passes. It
     82 // relies on PassManagerImpl to do all the tasks.
     83 //
     84 // [o] class PassManagerImpl : public Pass, public PMDataManager,
     85 //                             public PMTopLevelManager
     86 //
     87 // PassManagerImpl is a top level pass manager responsible for managing
     88 // MPPassManagers.
     89 //===----------------------------------------------------------------------===//
     90 
     91 #include "llvm/Support/PrettyStackTrace.h"
     92 
     93 namespace llvm {
     94   class Module;
     95   class Pass;
     96   class StringRef;
     97   class Value;
     98   class Timer;
     99   class PMDataManager;
    100 
    101 // enums for debugging strings
    102 enum PassDebuggingString {
    103   EXECUTION_MSG, // "Executing Pass '"
    104   MODIFICATION_MSG, // "' Made Modification '"
    105   FREEING_MSG, // " Freeing Pass '"
    106   ON_BASICBLOCK_MSG, // "'  on BasicBlock '" + PassName + "'...\n"
    107   ON_FUNCTION_MSG, // "' on Function '" + FunctionName + "'...\n"
    108   ON_MODULE_MSG, // "' on Module '" + ModuleName + "'...\n"
    109   ON_REGION_MSG, // " 'on Region ...\n'"
    110   ON_LOOP_MSG, // " 'on Loop ...\n'"
    111   ON_CG_MSG // "' on Call Graph ...\n'"
    112 };
    113 
    114 /// PassManagerPrettyStackEntry - This is used to print informative information
    115 /// about what pass is running when/if a stack trace is generated.
    116 class PassManagerPrettyStackEntry : public PrettyStackTraceEntry {
    117   Pass *P;
    118   Value *V;
    119   Module *M;
    120 public:
    121   explicit PassManagerPrettyStackEntry(Pass *p)
    122     : P(p), V(0), M(0) {}  // When P is releaseMemory'd.
    123   PassManagerPrettyStackEntry(Pass *p, Value &v)
    124     : P(p), V(&v), M(0) {} // When P is run on V
    125   PassManagerPrettyStackEntry(Pass *p, Module &m)
    126     : P(p), V(0), M(&m) {} // When P is run on M
    127 
    128   /// print - Emit information about this stack frame to OS.
    129   virtual void print(raw_ostream &OS) const;
    130 };
    131 
    132 
    133 //===----------------------------------------------------------------------===//
    134 // PMStack
    135 //
    136 /// PMStack - This class implements a stack data structure of PMDataManager
    137 /// pointers.
    138 ///
    139 /// Top level pass managers (see PassManager.cpp) maintain active Pass Managers
    140 /// using PMStack. Each Pass implements assignPassManager() to connect itself
    141 /// with appropriate manager. assignPassManager() walks PMStack to find
    142 /// suitable manager.
    143 class PMStack {
    144 public:
    145   typedef std::vector<PMDataManager *>::const_reverse_iterator iterator;
    146   iterator begin() const { return S.rbegin(); }
    147   iterator end() const { return S.rend(); }
    148 
    149   void pop();
    150   PMDataManager *top() const { return S.back(); }
    151   void push(PMDataManager *PM);
    152   bool empty() const { return S.empty(); }
    153 
    154   void dump() const;
    155 
    156 private:
    157   std::vector<PMDataManager *> S;
    158 };
    159 
    160 
    161 //===----------------------------------------------------------------------===//
    162 // PMTopLevelManager
    163 //
    164 /// PMTopLevelManager manages LastUser info and collects common APIs used by
    165 /// top level pass managers.
    166 class PMTopLevelManager {
    167 protected:
    168   explicit PMTopLevelManager(PMDataManager *PMDM);
    169 
    170   virtual unsigned getNumContainedManagers() const {
    171     return (unsigned)PassManagers.size();
    172   }
    173 
    174   void initializeAllAnalysisInfo();
    175 
    176 private:
    177   virtual PMDataManager *getAsPMDataManager() = 0;
    178   virtual PassManagerType getTopLevelPassManagerType() = 0;
    179 
    180 public:
    181   /// Schedule pass P for execution. Make sure that passes required by
    182   /// P are run before P is run. Update analysis info maintained by
    183   /// the manager. Remove dead passes. This is a recursive function.
    184   void schedulePass(Pass *P);
    185 
    186   /// Set pass P as the last user of the given analysis passes.
    187   void setLastUser(const SmallVectorImpl<Pass *> &AnalysisPasses, Pass *P);
    188 
    189   /// Collect passes whose last user is P
    190   void collectLastUses(SmallVectorImpl<Pass *> &LastUses, Pass *P);
    191 
    192   /// Find the pass that implements Analysis AID. Search immutable
    193   /// passes and all pass managers. If desired pass is not found
    194   /// then return NULL.
    195   Pass *findAnalysisPass(AnalysisID AID);
    196 
    197   /// Find analysis usage information for the pass P.
    198   AnalysisUsage *findAnalysisUsage(Pass *P);
    199 
    200   virtual ~PMTopLevelManager();
    201 
    202   /// Add immutable pass and initialize it.
    203   inline void addImmutablePass(ImmutablePass *P) {
    204     P->initializePass();
    205     ImmutablePasses.push_back(P);
    206   }
    207 
    208   inline SmallVectorImpl<ImmutablePass *>& getImmutablePasses() {
    209     return ImmutablePasses;
    210   }
    211 
    212   void addPassManager(PMDataManager *Manager) {
    213     PassManagers.push_back(Manager);
    214   }
    215 
    216   // Add Manager into the list of managers that are not directly
    217   // maintained by this top level pass manager
    218   inline void addIndirectPassManager(PMDataManager *Manager) {
    219     IndirectPassManagers.push_back(Manager);
    220   }
    221 
    222   // Print passes managed by this top level manager.
    223   void dumpPasses() const;
    224   void dumpArguments() const;
    225 
    226   // Active Pass Managers
    227   PMStack activeStack;
    228 
    229 protected:
    230 
    231   /// Collection of pass managers
    232   SmallVector<PMDataManager *, 8> PassManagers;
    233 
    234 private:
    235 
    236   /// Collection of pass managers that are not directly maintained
    237   /// by this pass manager
    238   SmallVector<PMDataManager *, 8> IndirectPassManagers;
    239 
    240   // Map to keep track of last user of the analysis pass.
    241   // LastUser->second is the last user of Lastuser->first.
    242   DenseMap<Pass *, Pass *> LastUser;
    243 
    244   // Map to keep track of passes that are last used by a pass.
    245   // This inverse map is initialized at PM->run() based on
    246   // LastUser map.
    247   DenseMap<Pass *, SmallPtrSet<Pass *, 8> > InversedLastUser;
    248 
    249   /// Immutable passes are managed by top level manager.
    250   SmallVector<ImmutablePass *, 8> ImmutablePasses;
    251 
    252   DenseMap<Pass *, AnalysisUsage *> AnUsageMap;
    253 };
    254 
    255 
    256 
    257 //===----------------------------------------------------------------------===//
    258 // PMDataManager
    259 
    260 /// PMDataManager provides the common place to manage the analysis data
    261 /// used by pass managers.
    262 class PMDataManager {
    263 public:
    264 
    265   explicit PMDataManager() : TPM(NULL), Depth(0) {
    266     initializeAnalysisInfo();
    267   }
    268 
    269   virtual ~PMDataManager();
    270 
    271   virtual Pass *getAsPass() = 0;
    272 
    273   /// Augment AvailableAnalysis by adding analysis made available by pass P.
    274   void recordAvailableAnalysis(Pass *P);
    275 
    276   /// verifyPreservedAnalysis -- Verify analysis presreved by pass P.
    277   void verifyPreservedAnalysis(Pass *P);
    278 
    279   /// Remove Analysis that is not preserved by the pass
    280   void removeNotPreservedAnalysis(Pass *P);
    281 
    282   /// Remove dead passes used by P.
    283   void removeDeadPasses(Pass *P, StringRef Msg,
    284                         enum PassDebuggingString);
    285 
    286   /// Remove P.
    287   void freePass(Pass *P, StringRef Msg,
    288                 enum PassDebuggingString);
    289 
    290   /// Add pass P into the PassVector. Update
    291   /// AvailableAnalysis appropriately if ProcessAnalysis is true.
    292   void add(Pass *P, bool ProcessAnalysis = true);
    293 
    294   /// Add RequiredPass into list of lower level passes required by pass P.
    295   /// RequiredPass is run on the fly by Pass Manager when P requests it
    296   /// through getAnalysis interface.
    297   virtual void addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass);
    298 
    299   virtual Pass *getOnTheFlyPass(Pass *P, AnalysisID PI, Function &F);
    300 
    301   /// Initialize available analysis information.
    302   void initializeAnalysisInfo() {
    303     AvailableAnalysis.clear();
    304     for (unsigned i = 0; i < PMT_Last; ++i)
    305       InheritedAnalysis[i] = NULL;
    306   }
    307 
    308   // Return true if P preserves high level analysis used by other
    309   // passes that are managed by this manager.
    310   bool preserveHigherLevelAnalysis(Pass *P);
    311 
    312 
    313   /// Populate RequiredPasses with analysis pass that are required by
    314   /// pass P and are available. Populate ReqPassNotAvailable with analysis
    315   /// pass that are required by pass P but are not available.
    316   void collectRequiredAnalysis(SmallVectorImpl<Pass *> &RequiredPasses,
    317                                SmallVectorImpl<AnalysisID> &ReqPassNotAvailable,
    318                                Pass *P);
    319 
    320   /// All Required analyses should be available to the pass as it runs!  Here
    321   /// we fill in the AnalysisImpls member of the pass so that it can
    322   /// successfully use the getAnalysis() method to retrieve the
    323   /// implementations it needs.
    324   void initializeAnalysisImpl(Pass *P);
    325 
    326   /// Find the pass that implements Analysis AID. If desired pass is not found
    327   /// then return NULL.
    328   Pass *findAnalysisPass(AnalysisID AID, bool Direction);
    329 
    330   // Access toplevel manager
    331   PMTopLevelManager *getTopLevelManager() { return TPM; }
    332   void setTopLevelManager(PMTopLevelManager *T) { TPM = T; }
    333 
    334   unsigned getDepth() const { return Depth; }
    335   void setDepth(unsigned newDepth) { Depth = newDepth; }
    336 
    337   // Print routines used by debug-pass
    338   void dumpLastUses(Pass *P, unsigned Offset) const;
    339   void dumpPassArguments() const;
    340   void dumpPassInfo(Pass *P, enum PassDebuggingString S1,
    341                     enum PassDebuggingString S2, StringRef Msg);
    342   void dumpRequiredSet(const Pass *P) const;
    343   void dumpPreservedSet(const Pass *P) const;
    344 
    345   virtual unsigned getNumContainedPasses() const {
    346     return (unsigned)PassVector.size();
    347   }
    348 
    349   virtual PassManagerType getPassManagerType() const {
    350     assert ( 0 && "Invalid use of getPassManagerType");
    351     return PMT_Unknown;
    352   }
    353 
    354   std::map<AnalysisID, Pass*> *getAvailableAnalysis() {
    355     return &AvailableAnalysis;
    356   }
    357 
    358   // Collect AvailableAnalysis from all the active Pass Managers.
    359   void populateInheritedAnalysis(PMStack &PMS) {
    360     unsigned Index = 0;
    361     for (PMStack::iterator I = PMS.begin(), E = PMS.end();
    362          I != E; ++I)
    363       InheritedAnalysis[Index++] = (*I)->getAvailableAnalysis();
    364   }
    365 
    366 protected:
    367 
    368   // Top level manager.
    369   PMTopLevelManager *TPM;
    370 
    371   // Collection of pass that are managed by this manager
    372   SmallVector<Pass *, 16> PassVector;
    373 
    374   // Collection of Analysis provided by Parent pass manager and
    375   // used by current pass manager. At at time there can not be more
    376   // then PMT_Last active pass mangers.
    377   std::map<AnalysisID, Pass *> *InheritedAnalysis[PMT_Last];
    378 
    379 
    380   /// isPassDebuggingExecutionsOrMore - Return true if -debug-pass=Executions
    381   /// or higher is specified.
    382   bool isPassDebuggingExecutionsOrMore() const;
    383 
    384 private:
    385   void dumpAnalysisUsage(StringRef Msg, const Pass *P,
    386                          const AnalysisUsage::VectorType &Set) const;
    387 
    388   // Set of available Analysis. This information is used while scheduling
    389   // pass. If a pass requires an analysis which is not available then
    390   // the required analysis pass is scheduled to run before the pass itself is
    391   // scheduled to run.
    392   std::map<AnalysisID, Pass*> AvailableAnalysis;
    393 
    394   // Collection of higher level analysis used by the pass managed by
    395   // this manager.
    396   SmallVector<Pass *, 8> HigherLevelAnalysis;
    397 
    398   unsigned Depth;
    399 };
    400 
    401 //===----------------------------------------------------------------------===//
    402 // FPPassManager
    403 //
    404 /// FPPassManager manages BBPassManagers and FunctionPasses.
    405 /// It batches all function passes and basic block pass managers together and
    406 /// sequence them to process one function at a time before processing next
    407 /// function.
    408 class FPPassManager : public ModulePass, public PMDataManager {
    409 public:
    410   static char ID;
    411   explicit FPPassManager()
    412   : ModulePass(ID), PMDataManager() { }
    413 
    414   /// run - Execute all of the passes scheduled for execution.  Keep track of
    415   /// whether any of the passes modifies the module, and if so, return true.
    416   bool runOnFunction(Function &F);
    417   bool runOnModule(Module &M);
    418 
    419   /// cleanup - After running all passes, clean up pass manager cache.
    420   void cleanup();
    421 
    422   /// doInitialization - Run all of the initializers for the function passes.
    423   ///
    424   bool doInitialization(Module &M);
    425 
    426   /// doFinalization - Run all of the finalizers for the function passes.
    427   ///
    428   bool doFinalization(Module &M);
    429 
    430   virtual PMDataManager *getAsPMDataManager() { return this; }
    431   virtual Pass *getAsPass() { return this; }
    432 
    433   /// Pass Manager itself does not invalidate any analysis info.
    434   void getAnalysisUsage(AnalysisUsage &Info) const {
    435     Info.setPreservesAll();
    436   }
    437 
    438   // Print passes managed by this manager
    439   void dumpPassStructure(unsigned Offset);
    440 
    441   virtual const char *getPassName() const {
    442     return "Function Pass Manager";
    443   }
    444 
    445   FunctionPass *getContainedPass(unsigned N) {
    446     assert ( N < PassVector.size() && "Pass number out of range!");
    447     FunctionPass *FP = static_cast<FunctionPass *>(PassVector[N]);
    448     return FP;
    449   }
    450 
    451   virtual PassManagerType getPassManagerType() const {
    452     return PMT_FunctionPassManager;
    453   }
    454 };
    455 
    456 Timer *getPassTimer(Pass *);
    457 
    458 }
    459 
    460 #endif
    461