InlinerPass.h revision 7ed47a13356daed2a34cd2209a31f92552e3bdd8 
1//===- InlinerPass.h - Code common to all inliners --------------*- 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 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#include "llvm/CallGraphSCCPass.h"
21
22namespace llvm {
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///
28struct Inliner : public CallGraphSCCPass {
29  explicit Inliner(const void *ID);
30
31  /// getAnalysisUsage - For this class, we declare that we require and preserve
32  /// the call graph.  If the derived class implements this method, it should
33  /// always explicitly call the implementation here.
34  virtual void getAnalysisUsage(AnalysisUsage &Info) const;
35
36  // Main run interface method, this implements the interface required by the
37  // Pass class.
38  virtual bool runOnSCC(const std::vector<CallGraphNode *> &SCC);
39
40  // doFinalization - Remove now-dead linkonce functions at the end of
41  // processing to avoid breaking the SCC traversal.
42  virtual bool doFinalization(CallGraph &CG);
43
44
45  /// This method returns the value specified by the -inline-threshold value,
46  /// specified on the command line.  This is typically not directly needed.
47  ///
48  unsigned getInlineThreshold() const { return InlineThreshold; }
49
50  /// getInlineCost - This method must be implemented by the subclass to
51  /// determine the cost of inlining the specified call site.  If the cost
52  /// returned is greater than the current inline threshold, the call site is
53  /// not inlined.
54  ///
55  virtual int getInlineCost(CallSite CS) = 0;
56
57private:
58  // InlineThreshold - Cache the value here for easy access.
59  unsigned InlineThreshold;
60};
61
62} // End llvm namespace
63
64#endif
65