include/llvm/CallGraphSCCPass.h

   1 //===- CallGraphSCCPass.h - Pass that operates BU on call graph -*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines the CallGraphSCCPass class, which is used for passes which
  11 // are implemented as bottom-up traversals on the call graph.  Because there may
  12 // be cycles in the call graph, passes of this type operate on the call-graph in
  13 // SCC order: that is, they process function bottom-up, except for recursive
  14 // functions, which they process all at once.
  15 //
  16 // These passes are inherently interprocedural, and are required to keep the
  17 // call graph up-to-date if they do anything which could modify it.
  18 //
  19 //===----------------------------------------------------------------------===//
  20
  21 #ifndef LLVM_CALL_GRAPH_SCC_PASS_H
  22 #define LLVM_CALL_GRAPH_SCC_PASS_H
  23
  24 #include "llvm/Pass.h"
  25
  26 namespace llvm {
  27
  28 class CallGraphNode;
  29 class CallGraph;
  30
  31 struct CallGraphSCCPass : public ModulePass {
  32
  33   /// doInitialization - This method is called before the SCC's of the program
  34   /// has been processed, allowing the pass to do initialization as necessary.
  35   virtual bool doInitialization(CallGraph &CG) {
  36     return false;
  37   }
  38
  39   /// runOnSCC - This method should be implemented by the subclass to perform
  40   /// whatever action is necessary for the specified SCC.  Note that
  41   /// non-recursive (or only self-recursive) functions will have an SCC size of
  42   /// 1, where recursive portions of the call graph will have SCC size > 1.
  43   ///
  44   virtual bool runOnSCC(const std::vector<CallGraphNode *> &SCC) = 0;
  45
  46   /// doFinalization - This method is called after the SCC's of the program has
  47   /// been processed, allowing the pass to do final cleanup as necessary.
  48   virtual bool doFinalization(CallGraph &CG) {
  49     return false;
  50   }
  51
  52   /// run - Run this pass, returning true if a modification was made to the
  53   /// module argument.  This is implemented in terms of the runOnSCC method.
  54   ///
  55   virtual bool runOnModule(Module &M);
  56
  57
  58   /// getAnalysisUsage - For this class, we declare that we require and preserve
  59   /// the call graph.  If the derived class implements this method, it should
  60   /// always explicitly call the implementation here.
  61   virtual void getAnalysisUsage(AnalysisUsage &Info) const;
  62 };
  63
  64 } // End llvm namespace
  65
  66 #endif