lib/Transforms/IPO/Inliner.h

   1 //===- InlineCommon.h - Code common to all inliners -------------*- 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 a simple policy-based bottom-up inliner.  This file
  11 // implements all of the boring mechanics of the bottom-up inlining, while the
  12 // subclass determines WHAT to inline, which is the much more interesting
  13 // component.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #ifndef INLINER_H
  18 #define INLINER_H
  19
  20 #define DEBUG_TYPE "inline"
  21 #include "llvm/CallGraphSCCPass.h"
  22 #include <set>
  23 class CallSite;
  24
  25 /// Inliner - This class contains all of the helper code which is used to
  26 /// perform the inlining operations that does not depend on the policy.
  27 ///
  28 struct Inliner : public CallGraphSCCPass {
  29   Inliner();
  30
  31   // Main run interface method, this implements the interface required by the
  32   // Pass class.
  33   virtual bool runOnSCC(const std::vector<CallGraphNode *> &SCC);
  34
  35   /// This method returns the value specified by the -inline-threshold value,
  36   /// specified on the command line.  This is typically not directly needed.
  37   ///
  38   unsigned getInlineThreshold() const { return InlineThreshold; }
  39
  40   /// getInlineCost - This method must be implemented by the subclass to
  41   /// determine the cost of inlining the specified call site.  If the cost
  42   /// returned is greater than the current inline threshold, the call site is
  43   /// not inlined.
  44   ///
  45   virtual int getInlineCost(CallSite CS) = 0;
  46
  47   /// getRecursiveInlineCost - This method can be implemented by subclasses if
  48   /// it wants to treat calls to functions within the current SCC specially.  If
  49   /// this method is not overloaded, it just chains to getInlineCost().
  50   ///
  51   virtual int getRecursiveInlineCost(CallSite CS);
  52
  53 private:
  54   unsigned InlineThreshold;
  55   bool performInlining(CallSite CS, std::set<Function*> &SCC);
  56 };
  57
  58
  59 #endif