include/llvm/PassAnalysisSupport.h

   1 //===- llvm/PassAnalysisSupport.h - Analysis Pass Support code ---*- C++ -*-==//
   2 //
   3 // This file defines stuff that is used to define and "use" Analysis Passes.
   4 // This file is automatically #included by Pass.h, so:
   5 //
   6 //           NO .CPP FILES SHOULD INCLUDE THIS FILE DIRECTLY
   7 //
   8 // Instead, #include Pass.h
   9 //
  10 //===----------------------------------------------------------------------===//
  11
  12 #ifndef LLVM_PASS_ANALYSIS_SUPPORT_H
  13 #define LLVM_PASS_ANALYSIS_SUPPORT_H
  14
  15 // No need to include Pass.h, we are being included by it!
  16
  17
  18
  19 //===----------------------------------------------------------------------===//
  20 // AnalysisUsage - Represent the analysis usage information of a pass.  This
  21 // tracks analyses that the pass REQUIRES (must available when the pass runs),
  22 // and analyses that the pass PRESERVES (the pass does not invalidate the
  23 // results of these analyses).  This information is provided by a pass to the
  24 // Pass infrastructure through the getAnalysisUsage virtual function.
  25 //
  26 class AnalysisUsage {
  27   // Sets of analyses required and preserved by a pass
  28   std::vector<AnalysisID> Required, Preserved;
  29   bool PreservesAll;
  30 public:
  31   AnalysisUsage() : PreservesAll(false) {}
  32
  33   // addRequired - Add the specified ID to the required set of the usage info
  34   // for a pass.
  35   //
  36   AnalysisUsage &addRequiredID(AnalysisID ID) {
  37     Required.push_back(ID);
  38     return *this;
  39   }
  40   template<class PassClass>
  41   AnalysisUsage &addRequired() {
  42     Required.push_back(PassClass::ID);
  43     return *this;
  44   }
  45
  46   // addPreserved - Add the specified ID to the set of analyses preserved by
  47   // this pass
  48   //
  49   AnalysisUsage &addPreservedID(AnalysisID ID) {
  50     Preserved.push_back(ID);
  51     return *this;
  52   }
  53
  54   template<class PassClass>
  55   AnalysisUsage &addPreserved() {
  56     Preserved.push_back(PassClass::ID);
  57     return *this;
  58   }
  59
  60   // setPreservesAll - Set by analyses that do not transform their input at all
  61   void setPreservesAll() { PreservesAll = true; }
  62   bool preservesAll() const { return PreservesAll; }
  63
  64   // preservesCFG - This function should be called by the pass, iff they do not:
  65   //
  66   //  1. Add or remove basic blocks from the function
  67   //  2. Modify terminator instructions in any way.
  68   //
  69   // This function annotates the AnalysisUsage info object to say that analyses
  70   // that only depend on the CFG are preserved by this pass.
  71   //
  72   void preservesCFG();
  73
  74   const std::vector<AnalysisID> &getRequiredSet() const { return Required; }
  75   const std::vector<AnalysisID> &getPreservedSet() const { return Preserved; }
  76 };
  77
  78
  79
  80 //===----------------------------------------------------------------------===//
  81 // AnalysisResolver - Simple interface implemented by PassManager objects that
  82 // is used to pull analysis information out of them.
  83 //
  84 struct AnalysisResolver {
  85   virtual Pass *getAnalysisOrNullUp(AnalysisID ID) const = 0;
  86   virtual Pass *getAnalysisOrNullDown(AnalysisID ID) const = 0;
  87   Pass *getAnalysis(AnalysisID ID) {
  88     Pass *Result = getAnalysisOrNullUp(ID);
  89     assert(Result && "Pass has an incorrect analysis uses set!");
  90     return Result;
  91   }
  92
  93   // getAnalysisToUpdate - Return an analysis result or null if it doesn't exist
  94   Pass *getAnalysisToUpdate(AnalysisID ID) {
  95     return getAnalysisOrNullUp(ID);
  96   }
  97
  98   // Methods for introspecting into pass manager objects...
  99   virtual unsigned getDepth() const = 0;
 100   virtual unsigned getNumContainedPasses() const = 0;
 101   virtual const Pass *getContainedPass(unsigned N) const = 0;
 102
 103   virtual void markPassUsed(AnalysisID P, Pass *User) = 0;
 104
 105   void startPass(Pass *P) {}
 106   void endPass(Pass *P) {}
 107 protected:
 108   void setAnalysisResolver(Pass *P, AnalysisResolver *AR);
 109 };
 110
 111 #endif