1 //===- InlineAlways.cpp - Code to inline always_inline functions ----------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements a custom inliner that handles only functions that
11 // are marked as "always inline".
13 //===----------------------------------------------------------------------===//
15 #define DEBUG_TYPE "inline"
16 #include "llvm/Transforms/IPO.h"
17 #include "llvm/ADT/SmallPtrSet.h"
18 #include "llvm/Analysis/CallGraph.h"
19 #include "llvm/Analysis/InlineCost.h"
20 #include "llvm/IR/CallingConv.h"
21 #include "llvm/IR/DataLayout.h"
22 #include "llvm/IR/Instructions.h"
23 #include "llvm/IR/IntrinsicInst.h"
24 #include "llvm/IR/Module.h"
25 #include "llvm/IR/Type.h"
26 #include "llvm/Support/CallSite.h"
27 #include "llvm/Transforms/IPO/InlinerPass.h"
33 // AlwaysInliner only inlines functions that are mark as "always inline".
34 class AlwaysInliner : public Inliner {
35 InlineCostAnalyzer CA;
37 // Use extremely low threshold.
38 AlwaysInliner() : Inliner(ID, -2000000000, /*InsertLifetime*/true) {
39 initializeAlwaysInlinerPass(*PassRegistry::getPassRegistry());
41 AlwaysInliner(bool InsertLifetime) : Inliner(ID, -2000000000,
43 initializeAlwaysInlinerPass(*PassRegistry::getPassRegistry());
45 static char ID; // Pass identification, replacement for typeid
46 virtual InlineCost getInlineCost(CallSite CS);
48 using llvm::Pass::doInitialization;
49 using llvm::Pass::doFinalization;
51 virtual bool doFinalization(CallGraph &CG) {
52 return removeDeadFunctions(CG, /*AlwaysInlineOnly=*/true);
54 virtual bool doInitialization(CallGraph &CG);
58 char AlwaysInliner::ID = 0;
59 INITIALIZE_PASS_BEGIN(AlwaysInliner, "always-inline",
60 "Inliner for always_inline functions", false, false)
61 INITIALIZE_AG_DEPENDENCY(CallGraph)
62 INITIALIZE_PASS_END(AlwaysInliner, "always-inline",
63 "Inliner for always_inline functions", false, false)
65 Pass *llvm::createAlwaysInlinerPass() { return new AlwaysInliner(); }
67 Pass *llvm::createAlwaysInlinerPass(bool InsertLifetime) {
68 return new AlwaysInliner(InsertLifetime);
71 /// \brief Get the inline cost for the always-inliner.
73 /// The always inliner *only* handles functions which are marked with the
74 /// attribute to force inlining. As such, it is dramatically simpler and avoids
75 /// using the powerful (but expensive) inline cost analysis. Instead it uses
76 /// a very simple and boring direct walk of the instructions looking for
77 /// impossible-to-inline constructs.
79 /// Note, it would be possible to go to some lengths to cache the information
80 /// computed here, but as we only expect to do this for relatively few and
81 /// small functions which have the explicit attribute to force inlining, it is
82 /// likely not worth it in practice.
83 InlineCost AlwaysInliner::getInlineCost(CallSite CS) {
84 Function *Callee = CS.getCalledFunction();
86 // Only inline direct calls to functions with always-inline attributes
87 // that are viable for inlining. FIXME: We shouldn't even get here for
89 if (Callee && !Callee->isDeclaration() &&
90 Callee->getAttributes().hasAttribute(AttributeSet::FunctionIndex,
91 Attribute::AlwaysInline) &&
92 CA.isInlineViable(*Callee))
93 return InlineCost::getAlways();
95 return InlineCost::getNever();
98 // doInitialization - Initializes the vector of functions that have not
99 // been annotated with the "always inline" attribute.
100 bool AlwaysInliner::doInitialization(CallGraph &CG) {
101 CA.setDataLayout(getAnalysisIfAvailable<DataLayout>());