aboutsummaryrefslogtreecommitdiffstats
path: root/lib/Target/Mips/MipsOptimizeMathLibCalls.cpp
blob: de3f09c3b543bc95825bcf0c8d34e23c26749c0e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
//===---- MipsOptimizeMathLibCalls.cpp - Optimize math lib calls.      ----===//
//
//                     The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// This pass does an IR transformation which enables the backend to emit native
// math instructions.
//
//===----------------------------------------------------------------------===//

#include "MipsTargetMachine.h"
#include "llvm/IR/IRBuilder.h"
#include "llvm/IR/Intrinsics.h"
#include "llvm/Pass.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Target/TargetLibraryInfo.h"
#include "llvm/Transforms/Utils/BasicBlockUtils.h"

using namespace llvm;

static cl::opt<bool> DisableOpt("disable-mips-math-optimization",
                                cl::init(false),
                                cl::desc("MIPS: Disable math lib call "
                                         "optimization."), cl::Hidden);

namespace {
  class MipsOptimizeMathLibCalls : public FunctionPass {
  public:
    static char ID;

    MipsOptimizeMathLibCalls(MipsTargetMachine &TM_) :
      FunctionPass(ID), TM(TM_) {}

    virtual const char *getPassName() const {
      return "MIPS: Optimize calls to math library functions.";
    }

    virtual void getAnalysisUsage(AnalysisUsage &AU) const;

    virtual bool runOnFunction(Function &F);

  private:
    /// Optimize calls to sqrt.
    bool optimizeSQRT(CallInst *Call, Function *CalledFunc,
                      BasicBlock &CurrBB,
                      Function::iterator &BB);

    const TargetMachine &TM;
  };

  char MipsOptimizeMathLibCalls::ID = 0;
}

FunctionPass *llvm::createMipsOptimizeMathLibCalls(MipsTargetMachine &TM) {
  return new MipsOptimizeMathLibCalls(TM);
}

void MipsOptimizeMathLibCalls::getAnalysisUsage(AnalysisUsage &AU) const {
  AU.addRequired<TargetLibraryInfo>();
  FunctionPass::getAnalysisUsage(AU);
}

bool MipsOptimizeMathLibCalls::runOnFunction(Function &F) {
  if (DisableOpt)
    return false;

  const MipsSubtarget &Subtarget = TM.getSubtarget<MipsSubtarget>();

  if (Subtarget.inMips16Mode())
    return false;

  bool Changed = false;
  Function::iterator CurrBB;
  const TargetLibraryInfo *LibInfo = &getAnalysis<TargetLibraryInfo>();

  for (Function::iterator BB = F.begin(), BE = F.end(); BB != BE;) {
    CurrBB = BB++;

    for (BasicBlock::iterator II = CurrBB->begin(), IE = CurrBB->end();
         II != IE; ++II) {
      CallInst *Call = dyn_cast<CallInst>(&*II);
      Function *CalledFunc;

      if (!Call || !(CalledFunc = Call->getCalledFunction()))
        continue;

      LibFunc::Func LibFunc;
      Attribute A = CalledFunc->getAttributes()
        .getAttribute(AttributeSet::FunctionIndex, "use-soft-float");

      // Skip if function has "use-soft-float" attribute.
      if ((A.isStringAttribute() && (A.getValueAsString() == "true")) ||
          TM.Options.UseSoftFloat)
        continue;

      // Skip if function either has local linkage or is not a known library
      // function.
      if (CalledFunc->hasLocalLinkage() || !CalledFunc->hasName() ||
          !LibInfo->getLibFunc(CalledFunc->getName(), LibFunc))
        continue;

      switch (LibFunc) {
      case LibFunc::sqrtf:
      case LibFunc::sqrt:
        if (optimizeSQRT(Call, CalledFunc, *CurrBB, BB))
          break;
        continue;
      default:
        continue;
      }

      Changed = true;
      break;
    }
  }

  return Changed;
}

bool MipsOptimizeMathLibCalls::optimizeSQRT(CallInst *Call,
                                            Function *CalledFunc,
                                            BasicBlock &CurrBB,
                                            Function::iterator &BB) {
  // There is no need to change the IR, since backend will emit sqrt
  // instruction if the call has already been marked read-only.
  if (Call->onlyReadsMemory())
    return false;

  // Do the following transformation:
  //
  // (before)
  // dst = sqrt(src)
  //
  // (after)
  // v0 = sqrt_noreadmem(src) # native sqrt instruction.
  // if (v0 is a NaN)
  //   v1 = sqrt(src)         # library call.
  // dst = phi(v0, v1)
  //

  // Move all instructions following Call to newly created block JoinBB.
  // Create phi and replace all uses.
  BasicBlock *JoinBB = llvm::SplitBlock(&CurrBB, Call->getNextNode(), this);
  IRBuilder<> Builder(JoinBB, JoinBB->begin());
  PHINode *Phi = Builder.CreatePHI(Call->getType(), 2);
  Call->replaceAllUsesWith(Phi);

  // Create basic block LibCallBB and insert a call to library function sqrt.
  BasicBlock *LibCallBB = BasicBlock::Create(CurrBB.getContext(), "call.sqrt",
                                             CurrBB.getParent(), JoinBB);
  Builder.SetInsertPoint(LibCallBB);
  Instruction *LibCall = Call->clone();
  Builder.Insert(LibCall);
  Builder.CreateBr(JoinBB);

  // Add attribute "readnone" so that backend can use a native sqrt instruction
  // for this call. Insert a FP compare instruction and a conditional branch
  // at the end of CurrBB.
  Call->addAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone);
  CurrBB.getTerminator()->eraseFromParent();
  Builder.SetInsertPoint(&CurrBB);
  Value *FCmp = Builder.CreateFCmpOEQ(Call, Call);
  Builder.CreateCondBr(FCmp, JoinBB, LibCallBB);

  // Add phi operands.
  Phi->addIncoming(Call, &CurrBB);
  Phi->addIncoming(LibCall, LibCallBB);

  BB = JoinBB;
  return true;
}