[SimplifyLibCalls] Teach SimplifyLibCalls about operand bundles
[oota-llvm.git] / lib / Transforms / Utils / SimplifyLibCalls.cpp
1 //===------ SimplifyLibCalls.cpp - Library calls simplifier ---------------===//
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 is a utility pass used for testing the InstructionSimplify analysis.
11 // The analysis is applied to every instruction, and if it simplifies then the
12 // instruction is replaced by the simplification.  If you are looking for a pass
13 // that performs serious instruction folding, use the instcombine pass instead.
14 //
15 //===----------------------------------------------------------------------===//
16
17 #include "llvm/Transforms/Utils/SimplifyLibCalls.h"
18 #include "llvm/ADT/SmallString.h"
19 #include "llvm/ADT/StringMap.h"
20 #include "llvm/ADT/Triple.h"
21 #include "llvm/Analysis/TargetLibraryInfo.h"
22 #include "llvm/Analysis/ValueTracking.h"
23 #include "llvm/IR/DataLayout.h"
24 #include "llvm/IR/DiagnosticInfo.h"
25 #include "llvm/IR/Function.h"
26 #include "llvm/IR/IRBuilder.h"
27 #include "llvm/IR/IntrinsicInst.h"
28 #include "llvm/IR/Intrinsics.h"
29 #include "llvm/IR/LLVMContext.h"
30 #include "llvm/IR/Module.h"
31 #include "llvm/IR/PatternMatch.h"
32 #include "llvm/Support/Allocator.h"
33 #include "llvm/Support/CommandLine.h"
34 #include "llvm/Transforms/Utils/BuildLibCalls.h"
35 #include "llvm/Transforms/Utils/Local.h"
36
37 using namespace llvm;
38 using namespace PatternMatch;
39
40 static cl::opt<bool>
41     ColdErrorCalls("error-reporting-is-cold", cl::init(true), cl::Hidden,
42                    cl::desc("Treat error-reporting calls as cold"));
43
44 static cl::opt<bool>
45     EnableUnsafeFPShrink("enable-double-float-shrink", cl::Hidden,
46                          cl::init(false),
47                          cl::desc("Enable unsafe double to float "
48                                   "shrinking for math lib calls"));
49
50
51 //===----------------------------------------------------------------------===//
52 // Helper Functions
53 //===----------------------------------------------------------------------===//
54
55 static bool ignoreCallingConv(LibFunc::Func Func) {
56   return Func == LibFunc::abs || Func == LibFunc::labs ||
57          Func == LibFunc::llabs || Func == LibFunc::strlen;
58 }
59
60 /// Return true if it only matters that the value is equal or not-equal to zero.
61 static bool isOnlyUsedInZeroEqualityComparison(Value *V) {
62   for (User *U : V->users()) {
63     if (ICmpInst *IC = dyn_cast<ICmpInst>(U))
64       if (IC->isEquality())
65         if (Constant *C = dyn_cast<Constant>(IC->getOperand(1)))
66           if (C->isNullValue())
67             continue;
68     // Unknown instruction.
69     return false;
70   }
71   return true;
72 }
73
74 /// Return true if it is only used in equality comparisons with With.
75 static bool isOnlyUsedInEqualityComparison(Value *V, Value *With) {
76   for (User *U : V->users()) {
77     if (ICmpInst *IC = dyn_cast<ICmpInst>(U))
78       if (IC->isEquality() && IC->getOperand(1) == With)
79         continue;
80     // Unknown instruction.
81     return false;
82   }
83   return true;
84 }
85
86 static bool callHasFloatingPointArgument(const CallInst *CI) {
87   return std::any_of(CI->op_begin(), CI->op_end(), [](const Use &OI) {
88     return OI->getType()->isFloatingPointTy();
89   });
90 }
91
92 /// \brief Check whether the overloaded unary floating point function
93 /// corresponding to \a Ty is available.
94 static bool hasUnaryFloatFn(const TargetLibraryInfo *TLI, Type *Ty,
95                             LibFunc::Func DoubleFn, LibFunc::Func FloatFn,
96                             LibFunc::Func LongDoubleFn) {
97   switch (Ty->getTypeID()) {
98   case Type::FloatTyID:
99     return TLI->has(FloatFn);
100   case Type::DoubleTyID:
101     return TLI->has(DoubleFn);
102   default:
103     return TLI->has(LongDoubleFn);
104   }
105 }
106
107 /// \brief Check whether we can use unsafe floating point math for
108 /// the function passed as input.
109 static bool canUseUnsafeFPMath(Function *F) {
110
111   // FIXME: For finer-grain optimization, we need intrinsics to have the same
112   // fast-math flag decorations that are applied to FP instructions. For now,
113   // we have to rely on the function-level unsafe-fp-math attribute to do this
114   // optimization because there's no other way to express that the call can be
115   // relaxed.
116   if (F->hasFnAttribute("unsafe-fp-math")) {
117     Attribute Attr = F->getFnAttribute("unsafe-fp-math");
118     if (Attr.getValueAsString() == "true")
119       return true;
120   }
121   return false;
122 }
123
124 /// \brief Returns whether \p F matches the signature expected for the
125 /// string/memory copying library function \p Func.
126 /// Acceptable functions are st[rp][n]?cpy, memove, memcpy, and memset.
127 /// Their fortified (_chk) counterparts are also accepted.
128 static bool checkStringCopyLibFuncSignature(Function *F, LibFunc::Func Func) {
129   const DataLayout &DL = F->getParent()->getDataLayout();
130   FunctionType *FT = F->getFunctionType();
131   LLVMContext &Context = F->getContext();
132   Type *PCharTy = Type::getInt8PtrTy(Context);
133   Type *SizeTTy = DL.getIntPtrType(Context);
134   unsigned NumParams = FT->getNumParams();
135
136   // All string libfuncs return the same type as the first parameter.
137   if (FT->getReturnType() != FT->getParamType(0))
138     return false;
139
140   switch (Func) {
141   default:
142     llvm_unreachable("Can't check signature for non-string-copy libfunc.");
143   case LibFunc::stpncpy_chk:
144   case LibFunc::strncpy_chk:
145     --NumParams; // fallthrough
146   case LibFunc::stpncpy:
147   case LibFunc::strncpy: {
148     if (NumParams != 3 || FT->getParamType(0) != FT->getParamType(1) ||
149         FT->getParamType(0) != PCharTy || !FT->getParamType(2)->isIntegerTy())
150       return false;
151     break;
152   }
153   case LibFunc::strcpy_chk:
154   case LibFunc::stpcpy_chk:
155     --NumParams; // fallthrough
156   case LibFunc::stpcpy:
157   case LibFunc::strcpy: {
158     if (NumParams != 2 || FT->getParamType(0) != FT->getParamType(1) ||
159         FT->getParamType(0) != PCharTy)
160       return false;
161     break;
162   }
163   case LibFunc::memmove_chk:
164   case LibFunc::memcpy_chk:
165     --NumParams; // fallthrough
166   case LibFunc::memmove:
167   case LibFunc::memcpy: {
168     if (NumParams != 3 || !FT->getParamType(0)->isPointerTy() ||
169         !FT->getParamType(1)->isPointerTy() || FT->getParamType(2) != SizeTTy)
170       return false;
171     break;
172   }
173   case LibFunc::memset_chk:
174     --NumParams; // fallthrough
175   case LibFunc::memset: {
176     if (NumParams != 3 || !FT->getParamType(0)->isPointerTy() ||
177         !FT->getParamType(1)->isIntegerTy() || FT->getParamType(2) != SizeTTy)
178       return false;
179     break;
180   }
181   }
182   // If this is a fortified libcall, the last parameter is a size_t.
183   if (NumParams == FT->getNumParams() - 1)
184     return FT->getParamType(FT->getNumParams() - 1) == SizeTTy;
185   return true;
186 }
187
188 //===----------------------------------------------------------------------===//
189 // String and Memory Library Call Optimizations
190 //===----------------------------------------------------------------------===//
191
192 Value *LibCallSimplifier::optimizeStrCat(CallInst *CI, IRBuilder<> &B) {
193   Function *Callee = CI->getCalledFunction();
194   // Verify the "strcat" function prototype.
195   FunctionType *FT = Callee->getFunctionType();
196   if (FT->getNumParams() != 2||
197       FT->getReturnType() != B.getInt8PtrTy() ||
198       FT->getParamType(0) != FT->getReturnType() ||
199       FT->getParamType(1) != FT->getReturnType())
200     return nullptr;
201
202   // Extract some information from the instruction
203   Value *Dst = CI->getArgOperand(0);
204   Value *Src = CI->getArgOperand(1);
205
206   // See if we can get the length of the input string.
207   uint64_t Len = GetStringLength(Src);
208   if (Len == 0)
209     return nullptr;
210   --Len; // Unbias length.
211
212   // Handle the simple, do-nothing case: strcat(x, "") -> x
213   if (Len == 0)
214     return Dst;
215
216   return emitStrLenMemCpy(Src, Dst, Len, B);
217 }
218
219 Value *LibCallSimplifier::emitStrLenMemCpy(Value *Src, Value *Dst, uint64_t Len,
220                                            IRBuilder<> &B) {
221   // We need to find the end of the destination string.  That's where the
222   // memory is to be moved to. We just generate a call to strlen.
223   Value *DstLen = EmitStrLen(Dst, B, DL, TLI);
224   if (!DstLen)
225     return nullptr;
226
227   // Now that we have the destination's length, we must index into the
228   // destination's pointer to get the actual memcpy destination (end of
229   // the string .. we're concatenating).
230   Value *CpyDst = B.CreateGEP(B.getInt8Ty(), Dst, DstLen, "endptr");
231
232   // We have enough information to now generate the memcpy call to do the
233   // concatenation for us.  Make a memcpy to copy the nul byte with align = 1.
234   B.CreateMemCpy(CpyDst, Src,
235                  ConstantInt::get(DL.getIntPtrType(Src->getContext()), Len + 1),
236                  1);
237   return Dst;
238 }
239
240 Value *LibCallSimplifier::optimizeStrNCat(CallInst *CI, IRBuilder<> &B) {
241   Function *Callee = CI->getCalledFunction();
242   // Verify the "strncat" function prototype.
243   FunctionType *FT = Callee->getFunctionType();
244   if (FT->getNumParams() != 3 || FT->getReturnType() != B.getInt8PtrTy() ||
245       FT->getParamType(0) != FT->getReturnType() ||
246       FT->getParamType(1) != FT->getReturnType() ||
247       !FT->getParamType(2)->isIntegerTy())
248     return nullptr;
249
250   // Extract some information from the instruction.
251   Value *Dst = CI->getArgOperand(0);
252   Value *Src = CI->getArgOperand(1);
253   uint64_t Len;
254
255   // We don't do anything if length is not constant.
256   if (ConstantInt *LengthArg = dyn_cast<ConstantInt>(CI->getArgOperand(2)))
257     Len = LengthArg->getZExtValue();
258   else
259     return nullptr;
260
261   // See if we can get the length of the input string.
262   uint64_t SrcLen = GetStringLength(Src);
263   if (SrcLen == 0)
264     return nullptr;
265   --SrcLen; // Unbias length.
266
267   // Handle the simple, do-nothing cases:
268   // strncat(x, "", c) -> x
269   // strncat(x,  c, 0) -> x
270   if (SrcLen == 0 || Len == 0)
271     return Dst;
272
273   // We don't optimize this case.
274   if (Len < SrcLen)
275     return nullptr;
276
277   // strncat(x, s, c) -> strcat(x, s)
278   // s is constant so the strcat can be optimized further.
279   return emitStrLenMemCpy(Src, Dst, SrcLen, B);
280 }
281
282 Value *LibCallSimplifier::optimizeStrChr(CallInst *CI, IRBuilder<> &B) {
283   Function *Callee = CI->getCalledFunction();
284   // Verify the "strchr" function prototype.
285   FunctionType *FT = Callee->getFunctionType();
286   if (FT->getNumParams() != 2 || FT->getReturnType() != B.getInt8PtrTy() ||
287       FT->getParamType(0) != FT->getReturnType() ||
288       !FT->getParamType(1)->isIntegerTy(32))
289     return nullptr;
290
291   Value *SrcStr = CI->getArgOperand(0);
292
293   // If the second operand is non-constant, see if we can compute the length
294   // of the input string and turn this into memchr.
295   ConstantInt *CharC = dyn_cast<ConstantInt>(CI->getArgOperand(1));
296   if (!CharC) {
297     uint64_t Len = GetStringLength(SrcStr);
298     if (Len == 0 || !FT->getParamType(1)->isIntegerTy(32)) // memchr needs i32.
299       return nullptr;
300
301     return EmitMemChr(SrcStr, CI->getArgOperand(1), // include nul.
302                       ConstantInt::get(DL.getIntPtrType(CI->getContext()), Len),
303                       B, DL, TLI);
304   }
305
306   // Otherwise, the character is a constant, see if the first argument is
307   // a string literal.  If so, we can constant fold.
308   StringRef Str;
309   if (!getConstantStringInfo(SrcStr, Str)) {
310     if (CharC->isZero()) // strchr(p, 0) -> p + strlen(p)
311       return B.CreateGEP(B.getInt8Ty(), SrcStr, EmitStrLen(SrcStr, B, DL, TLI),
312                          "strchr");
313     return nullptr;
314   }
315
316   // Compute the offset, make sure to handle the case when we're searching for
317   // zero (a weird way to spell strlen).
318   size_t I = (0xFF & CharC->getSExtValue()) == 0
319                  ? Str.size()
320                  : Str.find(CharC->getSExtValue());
321   if (I == StringRef::npos) // Didn't find the char.  strchr returns null.
322     return Constant::getNullValue(CI->getType());
323
324   // strchr(s+n,c)  -> gep(s+n+i,c)
325   return B.CreateGEP(B.getInt8Ty(), SrcStr, B.getInt64(I), "strchr");
326 }
327
328 Value *LibCallSimplifier::optimizeStrRChr(CallInst *CI, IRBuilder<> &B) {
329   Function *Callee = CI->getCalledFunction();
330   // Verify the "strrchr" function prototype.
331   FunctionType *FT = Callee->getFunctionType();
332   if (FT->getNumParams() != 2 || FT->getReturnType() != B.getInt8PtrTy() ||
333       FT->getParamType(0) != FT->getReturnType() ||
334       !FT->getParamType(1)->isIntegerTy(32))
335     return nullptr;
336
337   Value *SrcStr = CI->getArgOperand(0);
338   ConstantInt *CharC = dyn_cast<ConstantInt>(CI->getArgOperand(1));
339
340   // Cannot fold anything if we're not looking for a constant.
341   if (!CharC)
342     return nullptr;
343
344   StringRef Str;
345   if (!getConstantStringInfo(SrcStr, Str)) {
346     // strrchr(s, 0) -> strchr(s, 0)
347     if (CharC->isZero())
348       return EmitStrChr(SrcStr, '\0', B, TLI);
349     return nullptr;
350   }
351
352   // Compute the offset.
353   size_t I = (0xFF & CharC->getSExtValue()) == 0
354                  ? Str.size()
355                  : Str.rfind(CharC->getSExtValue());
356   if (I == StringRef::npos) // Didn't find the char. Return null.
357     return Constant::getNullValue(CI->getType());
358
359   // strrchr(s+n,c) -> gep(s+n+i,c)
360   return B.CreateGEP(B.getInt8Ty(), SrcStr, B.getInt64(I), "strrchr");
361 }
362
363 Value *LibCallSimplifier::optimizeStrCmp(CallInst *CI, IRBuilder<> &B) {
364   Function *Callee = CI->getCalledFunction();
365   // Verify the "strcmp" function prototype.
366   FunctionType *FT = Callee->getFunctionType();
367   if (FT->getNumParams() != 2 || !FT->getReturnType()->isIntegerTy(32) ||
368       FT->getParamType(0) != FT->getParamType(1) ||
369       FT->getParamType(0) != B.getInt8PtrTy())
370     return nullptr;
371
372   Value *Str1P = CI->getArgOperand(0), *Str2P = CI->getArgOperand(1);
373   if (Str1P == Str2P) // strcmp(x,x)  -> 0
374     return ConstantInt::get(CI->getType(), 0);
375
376   StringRef Str1, Str2;
377   bool HasStr1 = getConstantStringInfo(Str1P, Str1);
378   bool HasStr2 = getConstantStringInfo(Str2P, Str2);
379
380   // strcmp(x, y)  -> cnst  (if both x and y are constant strings)
381   if (HasStr1 && HasStr2)
382     return ConstantInt::get(CI->getType(), Str1.compare(Str2));
383
384   if (HasStr1 && Str1.empty()) // strcmp("", x) -> -*x
385     return B.CreateNeg(
386         B.CreateZExt(B.CreateLoad(Str2P, "strcmpload"), CI->getType()));
387
388   if (HasStr2 && Str2.empty()) // strcmp(x,"") -> *x
389     return B.CreateZExt(B.CreateLoad(Str1P, "strcmpload"), CI->getType());
390
391   // strcmp(P, "x") -> memcmp(P, "x", 2)
392   uint64_t Len1 = GetStringLength(Str1P);
393   uint64_t Len2 = GetStringLength(Str2P);
394   if (Len1 && Len2) {
395     return EmitMemCmp(Str1P, Str2P,
396                       ConstantInt::get(DL.getIntPtrType(CI->getContext()),
397                                        std::min(Len1, Len2)),
398                       B, DL, TLI);
399   }
400
401   return nullptr;
402 }
403
404 Value *LibCallSimplifier::optimizeStrNCmp(CallInst *CI, IRBuilder<> &B) {
405   Function *Callee = CI->getCalledFunction();
406   // Verify the "strncmp" function prototype.
407   FunctionType *FT = Callee->getFunctionType();
408   if (FT->getNumParams() != 3 || !FT->getReturnType()->isIntegerTy(32) ||
409       FT->getParamType(0) != FT->getParamType(1) ||
410       FT->getParamType(0) != B.getInt8PtrTy() ||
411       !FT->getParamType(2)->isIntegerTy())
412     return nullptr;
413
414   Value *Str1P = CI->getArgOperand(0), *Str2P = CI->getArgOperand(1);
415   if (Str1P == Str2P) // strncmp(x,x,n)  -> 0
416     return ConstantInt::get(CI->getType(), 0);
417
418   // Get the length argument if it is constant.
419   uint64_t Length;
420   if (ConstantInt *LengthArg = dyn_cast<ConstantInt>(CI->getArgOperand(2)))
421     Length = LengthArg->getZExtValue();
422   else
423     return nullptr;
424
425   if (Length == 0) // strncmp(x,y,0)   -> 0
426     return ConstantInt::get(CI->getType(), 0);
427
428   if (Length == 1) // strncmp(x,y,1) -> memcmp(x,y,1)
429     return EmitMemCmp(Str1P, Str2P, CI->getArgOperand(2), B, DL, TLI);
430
431   StringRef Str1, Str2;
432   bool HasStr1 = getConstantStringInfo(Str1P, Str1);
433   bool HasStr2 = getConstantStringInfo(Str2P, Str2);
434
435   // strncmp(x, y)  -> cnst  (if both x and y are constant strings)
436   if (HasStr1 && HasStr2) {
437     StringRef SubStr1 = Str1.substr(0, Length);
438     StringRef SubStr2 = Str2.substr(0, Length);
439     return ConstantInt::get(CI->getType(), SubStr1.compare(SubStr2));
440   }
441
442   if (HasStr1 && Str1.empty()) // strncmp("", x, n) -> -*x
443     return B.CreateNeg(
444         B.CreateZExt(B.CreateLoad(Str2P, "strcmpload"), CI->getType()));
445
446   if (HasStr2 && Str2.empty()) // strncmp(x, "", n) -> *x
447     return B.CreateZExt(B.CreateLoad(Str1P, "strcmpload"), CI->getType());
448
449   return nullptr;
450 }
451
452 Value *LibCallSimplifier::optimizeStrCpy(CallInst *CI, IRBuilder<> &B) {
453   Function *Callee = CI->getCalledFunction();
454
455   if (!checkStringCopyLibFuncSignature(Callee, LibFunc::strcpy))
456     return nullptr;
457
458   Value *Dst = CI->getArgOperand(0), *Src = CI->getArgOperand(1);
459   if (Dst == Src) // strcpy(x,x)  -> x
460     return Src;
461
462   // See if we can get the length of the input string.
463   uint64_t Len = GetStringLength(Src);
464   if (Len == 0)
465     return nullptr;
466
467   // We have enough information to now generate the memcpy call to do the
468   // copy for us.  Make a memcpy to copy the nul byte with align = 1.
469   B.CreateMemCpy(Dst, Src,
470                  ConstantInt::get(DL.getIntPtrType(CI->getContext()), Len), 1);
471   return Dst;
472 }
473
474 Value *LibCallSimplifier::optimizeStpCpy(CallInst *CI, IRBuilder<> &B) {
475   Function *Callee = CI->getCalledFunction();
476   if (!checkStringCopyLibFuncSignature(Callee, LibFunc::stpcpy))
477     return nullptr;
478
479   Value *Dst = CI->getArgOperand(0), *Src = CI->getArgOperand(1);
480   if (Dst == Src) { // stpcpy(x,x)  -> x+strlen(x)
481     Value *StrLen = EmitStrLen(Src, B, DL, TLI);
482     return StrLen ? B.CreateInBoundsGEP(B.getInt8Ty(), Dst, StrLen) : nullptr;
483   }
484
485   // See if we can get the length of the input string.
486   uint64_t Len = GetStringLength(Src);
487   if (Len == 0)
488     return nullptr;
489
490   Type *PT = Callee->getFunctionType()->getParamType(0);
491   Value *LenV = ConstantInt::get(DL.getIntPtrType(PT), Len);
492   Value *DstEnd = B.CreateGEP(B.getInt8Ty(), Dst,
493                               ConstantInt::get(DL.getIntPtrType(PT), Len - 1));
494
495   // We have enough information to now generate the memcpy call to do the
496   // copy for us.  Make a memcpy to copy the nul byte with align = 1.
497   B.CreateMemCpy(Dst, Src, LenV, 1);
498   return DstEnd;
499 }
500
501 Value *LibCallSimplifier::optimizeStrNCpy(CallInst *CI, IRBuilder<> &B) {
502   Function *Callee = CI->getCalledFunction();
503   if (!checkStringCopyLibFuncSignature(Callee, LibFunc::strncpy))
504     return nullptr;
505
506   Value *Dst = CI->getArgOperand(0);
507   Value *Src = CI->getArgOperand(1);
508   Value *LenOp = CI->getArgOperand(2);
509
510   // See if we can get the length of the input string.
511   uint64_t SrcLen = GetStringLength(Src);
512   if (SrcLen == 0)
513     return nullptr;
514   --SrcLen;
515
516   if (SrcLen == 0) {
517     // strncpy(x, "", y) -> memset(x, '\0', y, 1)
518     B.CreateMemSet(Dst, B.getInt8('\0'), LenOp, 1);
519     return Dst;
520   }
521
522   uint64_t Len;
523   if (ConstantInt *LengthArg = dyn_cast<ConstantInt>(LenOp))
524     Len = LengthArg->getZExtValue();
525   else
526     return nullptr;
527
528   if (Len == 0)
529     return Dst; // strncpy(x, y, 0) -> x
530
531   // Let strncpy handle the zero padding
532   if (Len > SrcLen + 1)
533     return nullptr;
534
535   Type *PT = Callee->getFunctionType()->getParamType(0);
536   // strncpy(x, s, c) -> memcpy(x, s, c, 1) [s and c are constant]
537   B.CreateMemCpy(Dst, Src, ConstantInt::get(DL.getIntPtrType(PT), Len), 1);
538
539   return Dst;
540 }
541
542 Value *LibCallSimplifier::optimizeStrLen(CallInst *CI, IRBuilder<> &B) {
543   Function *Callee = CI->getCalledFunction();
544   FunctionType *FT = Callee->getFunctionType();
545   if (FT->getNumParams() != 1 || FT->getParamType(0) != B.getInt8PtrTy() ||
546       !FT->getReturnType()->isIntegerTy())
547     return nullptr;
548
549   Value *Src = CI->getArgOperand(0);
550
551   // Constant folding: strlen("xyz") -> 3
552   if (uint64_t Len = GetStringLength(Src))
553     return ConstantInt::get(CI->getType(), Len - 1);
554
555   // strlen(x?"foo":"bars") --> x ? 3 : 4
556   if (SelectInst *SI = dyn_cast<SelectInst>(Src)) {
557     uint64_t LenTrue = GetStringLength(SI->getTrueValue());
558     uint64_t LenFalse = GetStringLength(SI->getFalseValue());
559     if (LenTrue && LenFalse) {
560       Function *Caller = CI->getParent()->getParent();
561       emitOptimizationRemark(CI->getContext(), "simplify-libcalls", *Caller,
562                              SI->getDebugLoc(),
563                              "folded strlen(select) to select of constants");
564       return B.CreateSelect(SI->getCondition(),
565                             ConstantInt::get(CI->getType(), LenTrue - 1),
566                             ConstantInt::get(CI->getType(), LenFalse - 1));
567     }
568   }
569
570   // strlen(x) != 0 --> *x != 0
571   // strlen(x) == 0 --> *x == 0
572   if (isOnlyUsedInZeroEqualityComparison(CI))
573     return B.CreateZExt(B.CreateLoad(Src, "strlenfirst"), CI->getType());
574
575   return nullptr;
576 }
577
578 Value *LibCallSimplifier::optimizeStrPBrk(CallInst *CI, IRBuilder<> &B) {
579   Function *Callee = CI->getCalledFunction();
580   FunctionType *FT = Callee->getFunctionType();
581   if (FT->getNumParams() != 2 || FT->getParamType(0) != B.getInt8PtrTy() ||
582       FT->getParamType(1) != FT->getParamType(0) ||
583       FT->getReturnType() != FT->getParamType(0))
584     return nullptr;
585
586   StringRef S1, S2;
587   bool HasS1 = getConstantStringInfo(CI->getArgOperand(0), S1);
588   bool HasS2 = getConstantStringInfo(CI->getArgOperand(1), S2);
589
590   // strpbrk(s, "") -> nullptr
591   // strpbrk("", s) -> nullptr
592   if ((HasS1 && S1.empty()) || (HasS2 && S2.empty()))
593     return Constant::getNullValue(CI->getType());
594
595   // Constant folding.
596   if (HasS1 && HasS2) {
597     size_t I = S1.find_first_of(S2);
598     if (I == StringRef::npos) // No match.
599       return Constant::getNullValue(CI->getType());
600
601     return B.CreateGEP(B.getInt8Ty(), CI->getArgOperand(0), B.getInt64(I),
602                        "strpbrk");
603   }
604
605   // strpbrk(s, "a") -> strchr(s, 'a')
606   if (HasS2 && S2.size() == 1)
607     return EmitStrChr(CI->getArgOperand(0), S2[0], B, TLI);
608
609   return nullptr;
610 }
611
612 Value *LibCallSimplifier::optimizeStrTo(CallInst *CI, IRBuilder<> &B) {
613   Function *Callee = CI->getCalledFunction();
614   FunctionType *FT = Callee->getFunctionType();
615   if ((FT->getNumParams() != 2 && FT->getNumParams() != 3) ||
616       !FT->getParamType(0)->isPointerTy() ||
617       !FT->getParamType(1)->isPointerTy())
618     return nullptr;
619
620   Value *EndPtr = CI->getArgOperand(1);
621   if (isa<ConstantPointerNull>(EndPtr)) {
622     // With a null EndPtr, this function won't capture the main argument.
623     // It would be readonly too, except that it still may write to errno.
624     CI->addAttribute(1, Attribute::NoCapture);
625   }
626
627   return nullptr;
628 }
629
630 Value *LibCallSimplifier::optimizeStrSpn(CallInst *CI, IRBuilder<> &B) {
631   Function *Callee = CI->getCalledFunction();
632   FunctionType *FT = Callee->getFunctionType();
633   if (FT->getNumParams() != 2 || FT->getParamType(0) != B.getInt8PtrTy() ||
634       FT->getParamType(1) != FT->getParamType(0) ||
635       !FT->getReturnType()->isIntegerTy())
636     return nullptr;
637
638   StringRef S1, S2;
639   bool HasS1 = getConstantStringInfo(CI->getArgOperand(0), S1);
640   bool HasS2 = getConstantStringInfo(CI->getArgOperand(1), S2);
641
642   // strspn(s, "") -> 0
643   // strspn("", s) -> 0
644   if ((HasS1 && S1.empty()) || (HasS2 && S2.empty()))
645     return Constant::getNullValue(CI->getType());
646
647   // Constant folding.
648   if (HasS1 && HasS2) {
649     size_t Pos = S1.find_first_not_of(S2);
650     if (Pos == StringRef::npos)
651       Pos = S1.size();
652     return ConstantInt::get(CI->getType(), Pos);
653   }
654
655   return nullptr;
656 }
657
658 Value *LibCallSimplifier::optimizeStrCSpn(CallInst *CI, IRBuilder<> &B) {
659   Function *Callee = CI->getCalledFunction();
660   FunctionType *FT = Callee->getFunctionType();
661   if (FT->getNumParams() != 2 || FT->getParamType(0) != B.getInt8PtrTy() ||
662       FT->getParamType(1) != FT->getParamType(0) ||
663       !FT->getReturnType()->isIntegerTy())
664     return nullptr;
665
666   StringRef S1, S2;
667   bool HasS1 = getConstantStringInfo(CI->getArgOperand(0), S1);
668   bool HasS2 = getConstantStringInfo(CI->getArgOperand(1), S2);
669
670   // strcspn("", s) -> 0
671   if (HasS1 && S1.empty())
672     return Constant::getNullValue(CI->getType());
673
674   // Constant folding.
675   if (HasS1 && HasS2) {
676     size_t Pos = S1.find_first_of(S2);
677     if (Pos == StringRef::npos)
678       Pos = S1.size();
679     return ConstantInt::get(CI->getType(), Pos);
680   }
681
682   // strcspn(s, "") -> strlen(s)
683   if (HasS2 && S2.empty())
684     return EmitStrLen(CI->getArgOperand(0), B, DL, TLI);
685
686   return nullptr;
687 }
688
689 Value *LibCallSimplifier::optimizeStrStr(CallInst *CI, IRBuilder<> &B) {
690   Function *Callee = CI->getCalledFunction();
691   FunctionType *FT = Callee->getFunctionType();
692   if (FT->getNumParams() != 2 || !FT->getParamType(0)->isPointerTy() ||
693       !FT->getParamType(1)->isPointerTy() ||
694       !FT->getReturnType()->isPointerTy())
695     return nullptr;
696
697   // fold strstr(x, x) -> x.
698   if (CI->getArgOperand(0) == CI->getArgOperand(1))
699     return B.CreateBitCast(CI->getArgOperand(0), CI->getType());
700
701   // fold strstr(a, b) == a -> strncmp(a, b, strlen(b)) == 0
702   if (isOnlyUsedInEqualityComparison(CI, CI->getArgOperand(0))) {
703     Value *StrLen = EmitStrLen(CI->getArgOperand(1), B, DL, TLI);
704     if (!StrLen)
705       return nullptr;
706     Value *StrNCmp = EmitStrNCmp(CI->getArgOperand(0), CI->getArgOperand(1),
707                                  StrLen, B, DL, TLI);
708     if (!StrNCmp)
709       return nullptr;
710     for (auto UI = CI->user_begin(), UE = CI->user_end(); UI != UE;) {
711       ICmpInst *Old = cast<ICmpInst>(*UI++);
712       Value *Cmp =
713           B.CreateICmp(Old->getPredicate(), StrNCmp,
714                        ConstantInt::getNullValue(StrNCmp->getType()), "cmp");
715       replaceAllUsesWith(Old, Cmp);
716     }
717     return CI;
718   }
719
720   // See if either input string is a constant string.
721   StringRef SearchStr, ToFindStr;
722   bool HasStr1 = getConstantStringInfo(CI->getArgOperand(0), SearchStr);
723   bool HasStr2 = getConstantStringInfo(CI->getArgOperand(1), ToFindStr);
724
725   // fold strstr(x, "") -> x.
726   if (HasStr2 && ToFindStr.empty())
727     return B.CreateBitCast(CI->getArgOperand(0), CI->getType());
728
729   // If both strings are known, constant fold it.
730   if (HasStr1 && HasStr2) {
731     size_t Offset = SearchStr.find(ToFindStr);
732
733     if (Offset == StringRef::npos) // strstr("foo", "bar") -> null
734       return Constant::getNullValue(CI->getType());
735
736     // strstr("abcd", "bc") -> gep((char*)"abcd", 1)
737     Value *Result = CastToCStr(CI->getArgOperand(0), B);
738     Result = B.CreateConstInBoundsGEP1_64(Result, Offset, "strstr");
739     return B.CreateBitCast(Result, CI->getType());
740   }
741
742   // fold strstr(x, "y") -> strchr(x, 'y').
743   if (HasStr2 && ToFindStr.size() == 1) {
744     Value *StrChr = EmitStrChr(CI->getArgOperand(0), ToFindStr[0], B, TLI);
745     return StrChr ? B.CreateBitCast(StrChr, CI->getType()) : nullptr;
746   }
747   return nullptr;
748 }
749
750 Value *LibCallSimplifier::optimizeMemChr(CallInst *CI, IRBuilder<> &B) {
751   Function *Callee = CI->getCalledFunction();
752   FunctionType *FT = Callee->getFunctionType();
753   if (FT->getNumParams() != 3 || !FT->getParamType(0)->isPointerTy() ||
754       !FT->getParamType(1)->isIntegerTy(32) ||
755       !FT->getParamType(2)->isIntegerTy() ||
756       !FT->getReturnType()->isPointerTy())
757     return nullptr;
758
759   Value *SrcStr = CI->getArgOperand(0);
760   ConstantInt *CharC = dyn_cast<ConstantInt>(CI->getArgOperand(1));
761   ConstantInt *LenC = dyn_cast<ConstantInt>(CI->getArgOperand(2));
762
763   // memchr(x, y, 0) -> null
764   if (LenC && LenC->isNullValue())
765     return Constant::getNullValue(CI->getType());
766
767   // From now on we need at least constant length and string.
768   StringRef Str;
769   if (!LenC || !getConstantStringInfo(SrcStr, Str, 0, /*TrimAtNul=*/false))
770     return nullptr;
771
772   // Truncate the string to LenC. If Str is smaller than LenC we will still only
773   // scan the string, as reading past the end of it is undefined and we can just
774   // return null if we don't find the char.
775   Str = Str.substr(0, LenC->getZExtValue());
776
777   // If the char is variable but the input str and length are not we can turn
778   // this memchr call into a simple bit field test. Of course this only works
779   // when the return value is only checked against null.
780   //
781   // It would be really nice to reuse switch lowering here but we can't change
782   // the CFG at this point.
783   //
784   // memchr("\r\n", C, 2) != nullptr -> (C & ((1 << '\r') | (1 << '\n'))) != 0
785   //   after bounds check.
786   if (!CharC && !Str.empty() && isOnlyUsedInZeroEqualityComparison(CI)) {
787     unsigned char Max =
788         *std::max_element(reinterpret_cast<const unsigned char *>(Str.begin()),
789                           reinterpret_cast<const unsigned char *>(Str.end()));
790
791     // Make sure the bit field we're about to create fits in a register on the
792     // target.
793     // FIXME: On a 64 bit architecture this prevents us from using the
794     // interesting range of alpha ascii chars. We could do better by emitting
795     // two bitfields or shifting the range by 64 if no lower chars are used.
796     if (!DL.fitsInLegalInteger(Max + 1))
797       return nullptr;
798
799     // For the bit field use a power-of-2 type with at least 8 bits to avoid
800     // creating unnecessary illegal types.
801     unsigned char Width = NextPowerOf2(std::max((unsigned char)7, Max));
802
803     // Now build the bit field.
804     APInt Bitfield(Width, 0);
805     for (char C : Str)
806       Bitfield.setBit((unsigned char)C);
807     Value *BitfieldC = B.getInt(Bitfield);
808
809     // First check that the bit field access is within bounds.
810     Value *C = B.CreateZExtOrTrunc(CI->getArgOperand(1), BitfieldC->getType());
811     Value *Bounds = B.CreateICmp(ICmpInst::ICMP_ULT, C, B.getIntN(Width, Width),
812                                  "memchr.bounds");
813
814     // Create code that checks if the given bit is set in the field.
815     Value *Shl = B.CreateShl(B.getIntN(Width, 1ULL), C);
816     Value *Bits = B.CreateIsNotNull(B.CreateAnd(Shl, BitfieldC), "memchr.bits");
817
818     // Finally merge both checks and cast to pointer type. The inttoptr
819     // implicitly zexts the i1 to intptr type.
820     return B.CreateIntToPtr(B.CreateAnd(Bounds, Bits, "memchr"), CI->getType());
821   }
822
823   // Check if all arguments are constants.  If so, we can constant fold.
824   if (!CharC)
825     return nullptr;
826
827   // Compute the offset.
828   size_t I = Str.find(CharC->getSExtValue() & 0xFF);
829   if (I == StringRef::npos) // Didn't find the char.  memchr returns null.
830     return Constant::getNullValue(CI->getType());
831
832   // memchr(s+n,c,l) -> gep(s+n+i,c)
833   return B.CreateGEP(B.getInt8Ty(), SrcStr, B.getInt64(I), "memchr");
834 }
835
836 Value *LibCallSimplifier::optimizeMemCmp(CallInst *CI, IRBuilder<> &B) {
837   Function *Callee = CI->getCalledFunction();
838   FunctionType *FT = Callee->getFunctionType();
839   if (FT->getNumParams() != 3 || !FT->getParamType(0)->isPointerTy() ||
840       !FT->getParamType(1)->isPointerTy() ||
841       !FT->getReturnType()->isIntegerTy(32))
842     return nullptr;
843
844   Value *LHS = CI->getArgOperand(0), *RHS = CI->getArgOperand(1);
845
846   if (LHS == RHS) // memcmp(s,s,x) -> 0
847     return Constant::getNullValue(CI->getType());
848
849   // Make sure we have a constant length.
850   ConstantInt *LenC = dyn_cast<ConstantInt>(CI->getArgOperand(2));
851   if (!LenC)
852     return nullptr;
853   uint64_t Len = LenC->getZExtValue();
854
855   if (Len == 0) // memcmp(s1,s2,0) -> 0
856     return Constant::getNullValue(CI->getType());
857
858   // memcmp(S1,S2,1) -> *(unsigned char*)LHS - *(unsigned char*)RHS
859   if (Len == 1) {
860     Value *LHSV = B.CreateZExt(B.CreateLoad(CastToCStr(LHS, B), "lhsc"),
861                                CI->getType(), "lhsv");
862     Value *RHSV = B.CreateZExt(B.CreateLoad(CastToCStr(RHS, B), "rhsc"),
863                                CI->getType(), "rhsv");
864     return B.CreateSub(LHSV, RHSV, "chardiff");
865   }
866
867   // memcmp(S1,S2,N/8)==0 -> (*(intN_t*)S1 != *(intN_t*)S2)==0
868   if (DL.isLegalInteger(Len * 8) && isOnlyUsedInZeroEqualityComparison(CI)) {
869
870     IntegerType *IntType = IntegerType::get(CI->getContext(), Len * 8);
871     unsigned PrefAlignment = DL.getPrefTypeAlignment(IntType);
872
873     if (getKnownAlignment(LHS, DL, CI) >= PrefAlignment &&
874         getKnownAlignment(RHS, DL, CI) >= PrefAlignment) {
875
876       Type *LHSPtrTy =
877           IntType->getPointerTo(LHS->getType()->getPointerAddressSpace());
878       Type *RHSPtrTy =
879           IntType->getPointerTo(RHS->getType()->getPointerAddressSpace());
880
881       Value *LHSV =
882           B.CreateLoad(B.CreateBitCast(LHS, LHSPtrTy, "lhsc"), "lhsv");
883       Value *RHSV =
884           B.CreateLoad(B.CreateBitCast(RHS, RHSPtrTy, "rhsc"), "rhsv");
885
886       return B.CreateZExt(B.CreateICmpNE(LHSV, RHSV), CI->getType(), "memcmp");
887     }
888   }
889
890   // Constant folding: memcmp(x, y, l) -> cnst (all arguments are constant)
891   StringRef LHSStr, RHSStr;
892   if (getConstantStringInfo(LHS, LHSStr) &&
893       getConstantStringInfo(RHS, RHSStr)) {
894     // Make sure we're not reading out-of-bounds memory.
895     if (Len > LHSStr.size() || Len > RHSStr.size())
896       return nullptr;
897     // Fold the memcmp and normalize the result.  This way we get consistent
898     // results across multiple platforms.
899     uint64_t Ret = 0;
900     int Cmp = memcmp(LHSStr.data(), RHSStr.data(), Len);
901     if (Cmp < 0)
902       Ret = -1;
903     else if (Cmp > 0)
904       Ret = 1;
905     return ConstantInt::get(CI->getType(), Ret);
906   }
907
908   return nullptr;
909 }
910
911 Value *LibCallSimplifier::optimizeMemCpy(CallInst *CI, IRBuilder<> &B) {
912   Function *Callee = CI->getCalledFunction();
913
914   if (!checkStringCopyLibFuncSignature(Callee, LibFunc::memcpy))
915     return nullptr;
916
917   // memcpy(x, y, n) -> llvm.memcpy(x, y, n, 1)
918   B.CreateMemCpy(CI->getArgOperand(0), CI->getArgOperand(1),
919                  CI->getArgOperand(2), 1);
920   return CI->getArgOperand(0);
921 }
922
923 Value *LibCallSimplifier::optimizeMemMove(CallInst *CI, IRBuilder<> &B) {
924   Function *Callee = CI->getCalledFunction();
925
926   if (!checkStringCopyLibFuncSignature(Callee, LibFunc::memmove))
927     return nullptr;
928
929   // memmove(x, y, n) -> llvm.memmove(x, y, n, 1)
930   B.CreateMemMove(CI->getArgOperand(0), CI->getArgOperand(1),
931                   CI->getArgOperand(2), 1);
932   return CI->getArgOperand(0);
933 }
934
935 Value *LibCallSimplifier::optimizeMemSet(CallInst *CI, IRBuilder<> &B) {
936   Function *Callee = CI->getCalledFunction();
937
938   if (!checkStringCopyLibFuncSignature(Callee, LibFunc::memset))
939     return nullptr;
940
941   // memset(p, v, n) -> llvm.memset(p, v, n, 1)
942   Value *Val = B.CreateIntCast(CI->getArgOperand(1), B.getInt8Ty(), false);
943   B.CreateMemSet(CI->getArgOperand(0), Val, CI->getArgOperand(2), 1);
944   return CI->getArgOperand(0);
945 }
946
947 //===----------------------------------------------------------------------===//
948 // Math Library Optimizations
949 //===----------------------------------------------------------------------===//
950
951 /// Return a variant of Val with float type.
952 /// Currently this works in two cases: If Val is an FPExtension of a float
953 /// value to something bigger, simply return the operand.
954 /// If Val is a ConstantFP but can be converted to a float ConstantFP without
955 /// loss of precision do so.
956 static Value *valueHasFloatPrecision(Value *Val) {
957   if (FPExtInst *Cast = dyn_cast<FPExtInst>(Val)) {
958     Value *Op = Cast->getOperand(0);
959     if (Op->getType()->isFloatTy())
960       return Op;
961   }
962   if (ConstantFP *Const = dyn_cast<ConstantFP>(Val)) {
963     APFloat F = Const->getValueAPF();
964     bool losesInfo;
965     (void)F.convert(APFloat::IEEEsingle, APFloat::rmNearestTiesToEven,
966                     &losesInfo);
967     if (!losesInfo)
968       return ConstantFP::get(Const->getContext(), F);
969   }
970   return nullptr;
971 }
972
973 //===----------------------------------------------------------------------===//
974 // Double -> Float Shrinking Optimizations for Unary Functions like 'floor'
975
976 Value *LibCallSimplifier::optimizeUnaryDoubleFP(CallInst *CI, IRBuilder<> &B,
977                                                 bool CheckRetType) {
978   Function *Callee = CI->getCalledFunction();
979   FunctionType *FT = Callee->getFunctionType();
980   if (FT->getNumParams() != 1 || !FT->getReturnType()->isDoubleTy() ||
981       !FT->getParamType(0)->isDoubleTy())
982     return nullptr;
983
984   if (CheckRetType) {
985     // Check if all the uses for function like 'sin' are converted to float.
986     for (User *U : CI->users()) {
987       FPTruncInst *Cast = dyn_cast<FPTruncInst>(U);
988       if (!Cast || !Cast->getType()->isFloatTy())
989         return nullptr;
990     }
991   }
992
993   // If this is something like 'floor((double)floatval)', convert to floorf.
994   Value *V = valueHasFloatPrecision(CI->getArgOperand(0));
995   if (V == nullptr)
996     return nullptr;
997   
998   // Propagate fast-math flags from the existing call to the new call.
999   IRBuilder<>::FastMathFlagGuard Guard(B);
1000   B.SetFastMathFlags(CI->getFastMathFlags());
1001
1002   // floor((double)floatval) -> (double)floorf(floatval)
1003   if (Callee->isIntrinsic()) {
1004     Module *M = CI->getModule();
1005     Intrinsic::ID IID = Callee->getIntrinsicID();
1006     Function *F = Intrinsic::getDeclaration(M, IID, B.getFloatTy());
1007     V = B.CreateCall(F, V);
1008   } else {
1009     // The call is a library call rather than an intrinsic.
1010     V = EmitUnaryFloatFnCall(V, Callee->getName(), B, Callee->getAttributes());
1011   }
1012
1013   return B.CreateFPExt(V, B.getDoubleTy());
1014 }
1015
1016 // Double -> Float Shrinking Optimizations for Binary Functions like 'fmin/fmax'
1017 Value *LibCallSimplifier::optimizeBinaryDoubleFP(CallInst *CI, IRBuilder<> &B) {
1018   Function *Callee = CI->getCalledFunction();
1019   FunctionType *FT = Callee->getFunctionType();
1020   // Just make sure this has 2 arguments of the same FP type, which match the
1021   // result type.
1022   if (FT->getNumParams() != 2 || FT->getReturnType() != FT->getParamType(0) ||
1023       FT->getParamType(0) != FT->getParamType(1) ||
1024       !FT->getParamType(0)->isFloatingPointTy())
1025     return nullptr;
1026
1027   // If this is something like 'fmin((double)floatval1, (double)floatval2)',
1028   // or fmin(1.0, (double)floatval), then we convert it to fminf.
1029   Value *V1 = valueHasFloatPrecision(CI->getArgOperand(0));
1030   if (V1 == nullptr)
1031     return nullptr;
1032   Value *V2 = valueHasFloatPrecision(CI->getArgOperand(1));
1033   if (V2 == nullptr)
1034     return nullptr;
1035
1036   // Propagate fast-math flags from the existing call to the new call.
1037   IRBuilder<>::FastMathFlagGuard Guard(B);
1038   B.SetFastMathFlags(CI->getFastMathFlags());
1039
1040   // fmin((double)floatval1, (double)floatval2)
1041   //                      -> (double)fminf(floatval1, floatval2)
1042   // TODO: Handle intrinsics in the same way as in optimizeUnaryDoubleFP().
1043   Value *V = EmitBinaryFloatFnCall(V1, V2, Callee->getName(), B,
1044                                    Callee->getAttributes());
1045   return B.CreateFPExt(V, B.getDoubleTy());
1046 }
1047
1048 Value *LibCallSimplifier::optimizeCos(CallInst *CI, IRBuilder<> &B) {
1049   Function *Callee = CI->getCalledFunction();
1050   Value *Ret = nullptr;
1051   StringRef Name = Callee->getName();
1052   if (UnsafeFPShrink && Name == "cos" && hasFloatVersion(Name))
1053     Ret = optimizeUnaryDoubleFP(CI, B, true);
1054
1055   FunctionType *FT = Callee->getFunctionType();
1056   // Just make sure this has 1 argument of FP type, which matches the
1057   // result type.
1058   if (FT->getNumParams() != 1 || FT->getReturnType() != FT->getParamType(0) ||
1059       !FT->getParamType(0)->isFloatingPointTy())
1060     return Ret;
1061
1062   // cos(-x) -> cos(x)
1063   Value *Op1 = CI->getArgOperand(0);
1064   if (BinaryOperator::isFNeg(Op1)) {
1065     BinaryOperator *BinExpr = cast<BinaryOperator>(Op1);
1066     return B.CreateCall(Callee, BinExpr->getOperand(1), "cos");
1067   }
1068   return Ret;
1069 }
1070
1071 static Value *getPow(Value *InnerChain[33], unsigned Exp, IRBuilder<> &B) {
1072   // Multiplications calculated using Addition Chains.
1073   // Refer: http://wwwhomes.uni-bielefeld.de/achim/addition_chain.html
1074
1075   assert(Exp != 0 && "Incorrect exponent 0 not handled");
1076
1077   if (InnerChain[Exp])
1078     return InnerChain[Exp];
1079
1080   static const unsigned AddChain[33][2] = {
1081       {0, 0}, // Unused.
1082       {0, 0}, // Unused (base case = pow1).
1083       {1, 1}, // Unused (pre-computed).
1084       {1, 2},  {2, 2},   {2, 3},  {3, 3},   {2, 5},  {4, 4},
1085       {1, 8},  {5, 5},   {1, 10}, {6, 6},   {4, 9},  {7, 7},
1086       {3, 12}, {8, 8},   {8, 9},  {2, 16},  {1, 18}, {10, 10},
1087       {6, 15}, {11, 11}, {3, 20}, {12, 12}, {8, 17}, {13, 13},
1088       {3, 24}, {14, 14}, {4, 25}, {15, 15}, {3, 28}, {16, 16},
1089   };
1090
1091   InnerChain[Exp] = B.CreateFMul(getPow(InnerChain, AddChain[Exp][0], B),
1092                                  getPow(InnerChain, AddChain[Exp][1], B));
1093   return InnerChain[Exp];
1094 }
1095
1096 Value *LibCallSimplifier::optimizePow(CallInst *CI, IRBuilder<> &B) {
1097   Function *Callee = CI->getCalledFunction();
1098   Value *Ret = nullptr;
1099   StringRef Name = Callee->getName();
1100   if (UnsafeFPShrink && Name == "pow" && hasFloatVersion(Name))
1101     Ret = optimizeUnaryDoubleFP(CI, B, true);
1102
1103   FunctionType *FT = Callee->getFunctionType();
1104   // Just make sure this has 2 arguments of the same FP type, which match the
1105   // result type.
1106   if (FT->getNumParams() != 2 || FT->getReturnType() != FT->getParamType(0) ||
1107       FT->getParamType(0) != FT->getParamType(1) ||
1108       !FT->getParamType(0)->isFloatingPointTy())
1109     return Ret;
1110
1111   Value *Op1 = CI->getArgOperand(0), *Op2 = CI->getArgOperand(1);
1112   if (ConstantFP *Op1C = dyn_cast<ConstantFP>(Op1)) {
1113     // pow(1.0, x) -> 1.0
1114     if (Op1C->isExactlyValue(1.0))
1115       return Op1C;
1116     // pow(2.0, x) -> exp2(x)
1117     if (Op1C->isExactlyValue(2.0) &&
1118         hasUnaryFloatFn(TLI, Op1->getType(), LibFunc::exp2, LibFunc::exp2f,
1119                         LibFunc::exp2l))
1120       return EmitUnaryFloatFnCall(Op2, TLI->getName(LibFunc::exp2), B,
1121                                   Callee->getAttributes());
1122     // pow(10.0, x) -> exp10(x)
1123     if (Op1C->isExactlyValue(10.0) &&
1124         hasUnaryFloatFn(TLI, Op1->getType(), LibFunc::exp10, LibFunc::exp10f,
1125                         LibFunc::exp10l))
1126       return EmitUnaryFloatFnCall(Op2, TLI->getName(LibFunc::exp10), B,
1127                                   Callee->getAttributes());
1128   }
1129
1130   bool UnsafeFPMath = canUseUnsafeFPMath(CI->getParent()->getParent());
1131
1132   // pow(exp(x), y) -> exp(x*y)
1133   // pow(exp2(x), y) -> exp2(x * y)
1134   // We enable these only under fast-math. Besides rounding
1135   // differences the transformation changes overflow and
1136   // underflow behavior quite dramatically.
1137   // Example: x = 1000, y = 0.001.
1138   // pow(exp(x), y) = pow(inf, 0.001) = inf, whereas exp(x*y) = exp(1).
1139   if (UnsafeFPMath) {
1140     if (auto *OpC = dyn_cast<CallInst>(Op1)) {
1141       IRBuilder<>::FastMathFlagGuard Guard(B);
1142       FastMathFlags FMF;
1143       FMF.setUnsafeAlgebra();
1144       B.SetFastMathFlags(FMF);
1145
1146       LibFunc::Func Func;
1147       Function *OpCCallee = OpC->getCalledFunction();
1148       if (OpCCallee && TLI->getLibFunc(OpCCallee->getName(), Func) &&
1149           TLI->has(Func) && (Func == LibFunc::exp || Func == LibFunc::exp2))
1150         return EmitUnaryFloatFnCall(
1151             B.CreateFMul(OpC->getArgOperand(0), Op2, "mul"),
1152             OpCCallee->getName(), B, OpCCallee->getAttributes());
1153     }
1154   }
1155
1156   ConstantFP *Op2C = dyn_cast<ConstantFP>(Op2);
1157   if (!Op2C)
1158     return Ret;
1159
1160   if (Op2C->getValueAPF().isZero()) // pow(x, 0.0) -> 1.0
1161     return ConstantFP::get(CI->getType(), 1.0);
1162
1163   if (Op2C->isExactlyValue(0.5) &&
1164       hasUnaryFloatFn(TLI, Op2->getType(), LibFunc::sqrt, LibFunc::sqrtf,
1165                       LibFunc::sqrtl) &&
1166       hasUnaryFloatFn(TLI, Op2->getType(), LibFunc::fabs, LibFunc::fabsf,
1167                       LibFunc::fabsl)) {
1168
1169     // In -ffast-math, pow(x, 0.5) -> sqrt(x).
1170     if (UnsafeFPMath)
1171       return EmitUnaryFloatFnCall(Op1, TLI->getName(LibFunc::sqrt), B,
1172                                   Callee->getAttributes());
1173
1174     // Expand pow(x, 0.5) to (x == -infinity ? +infinity : fabs(sqrt(x))).
1175     // This is faster than calling pow, and still handles negative zero
1176     // and negative infinity correctly.
1177     // TODO: In finite-only mode, this could be just fabs(sqrt(x)).
1178     Value *Inf = ConstantFP::getInfinity(CI->getType());
1179     Value *NegInf = ConstantFP::getInfinity(CI->getType(), true);
1180     Value *Sqrt = EmitUnaryFloatFnCall(Op1, "sqrt", B, Callee->getAttributes());
1181     Value *FAbs =
1182         EmitUnaryFloatFnCall(Sqrt, "fabs", B, Callee->getAttributes());
1183     Value *FCmp = B.CreateFCmpOEQ(Op1, NegInf);
1184     Value *Sel = B.CreateSelect(FCmp, Inf, FAbs);
1185     return Sel;
1186   }
1187
1188   if (Op2C->isExactlyValue(1.0)) // pow(x, 1.0) -> x
1189     return Op1;
1190   if (Op2C->isExactlyValue(2.0)) // pow(x, 2.0) -> x*x
1191     return B.CreateFMul(Op1, Op1, "pow2");
1192   if (Op2C->isExactlyValue(-1.0)) // pow(x, -1.0) -> 1.0/x
1193     return B.CreateFDiv(ConstantFP::get(CI->getType(), 1.0), Op1, "powrecip");
1194
1195   // In -ffast-math, generate repeated fmul instead of generating pow(x, n).
1196   if (UnsafeFPMath) {
1197     APFloat V = abs(Op2C->getValueAPF());
1198     // We limit to a max of 7 fmul(s). Thus max exponent is 32.
1199     // This transformation applies to integer exponents only.
1200     if (V.compare(APFloat(V.getSemantics(), 32.0)) == APFloat::cmpGreaterThan ||
1201         !V.isInteger())
1202       return nullptr;
1203
1204     // We will memoize intermediate products of the Addition Chain.
1205     Value *InnerChain[33] = {nullptr};
1206     InnerChain[1] = Op1;
1207     InnerChain[2] = B.CreateFMul(Op1, Op1);
1208
1209     // We cannot readily convert a non-double type (like float) to a double.
1210     // So we first convert V to something which could be converted to double.
1211     bool ignored;
1212     V.convert(APFloat::IEEEdouble, APFloat::rmTowardZero, &ignored);
1213     Value *FMul = getPow(InnerChain, V.convertToDouble(), B);
1214     // For negative exponents simply compute the reciprocal.
1215     if (Op2C->isNegative())
1216       FMul = B.CreateFDiv(ConstantFP::get(CI->getType(), 1.0), FMul);
1217     return FMul;
1218   }
1219
1220   return nullptr;
1221 }
1222
1223 Value *LibCallSimplifier::optimizeExp2(CallInst *CI, IRBuilder<> &B) {
1224   Function *Callee = CI->getCalledFunction();
1225   Function *Caller = CI->getParent()->getParent();
1226   Value *Ret = nullptr;
1227   StringRef Name = Callee->getName();
1228   if (UnsafeFPShrink && Name == "exp2" && hasFloatVersion(Name))
1229     Ret = optimizeUnaryDoubleFP(CI, B, true);
1230
1231   FunctionType *FT = Callee->getFunctionType();
1232   // Just make sure this has 1 argument of FP type, which matches the
1233   // result type.
1234   if (FT->getNumParams() != 1 || FT->getReturnType() != FT->getParamType(0) ||
1235       !FT->getParamType(0)->isFloatingPointTy())
1236     return Ret;
1237
1238   Value *Op = CI->getArgOperand(0);
1239   // Turn exp2(sitofp(x)) -> ldexp(1.0, sext(x))  if sizeof(x) <= 32
1240   // Turn exp2(uitofp(x)) -> ldexp(1.0, zext(x))  if sizeof(x) < 32
1241   LibFunc::Func LdExp = LibFunc::ldexpl;
1242   if (Op->getType()->isFloatTy())
1243     LdExp = LibFunc::ldexpf;
1244   else if (Op->getType()->isDoubleTy())
1245     LdExp = LibFunc::ldexp;
1246
1247   if (TLI->has(LdExp)) {
1248     Value *LdExpArg = nullptr;
1249     if (SIToFPInst *OpC = dyn_cast<SIToFPInst>(Op)) {
1250       if (OpC->getOperand(0)->getType()->getPrimitiveSizeInBits() <= 32)
1251         LdExpArg = B.CreateSExt(OpC->getOperand(0), B.getInt32Ty());
1252     } else if (UIToFPInst *OpC = dyn_cast<UIToFPInst>(Op)) {
1253       if (OpC->getOperand(0)->getType()->getPrimitiveSizeInBits() < 32)
1254         LdExpArg = B.CreateZExt(OpC->getOperand(0), B.getInt32Ty());
1255     }
1256
1257     if (LdExpArg) {
1258       Constant *One = ConstantFP::get(CI->getContext(), APFloat(1.0f));
1259       if (!Op->getType()->isFloatTy())
1260         One = ConstantExpr::getFPExtend(One, Op->getType());
1261
1262       Module *M = Caller->getParent();
1263       Value *Callee =
1264           M->getOrInsertFunction(TLI->getName(LdExp), Op->getType(),
1265                                  Op->getType(), B.getInt32Ty(), nullptr);
1266       CallInst *CI = B.CreateCall(Callee, {One, LdExpArg});
1267       if (const Function *F = dyn_cast<Function>(Callee->stripPointerCasts()))
1268         CI->setCallingConv(F->getCallingConv());
1269
1270       return CI;
1271     }
1272   }
1273   return Ret;
1274 }
1275
1276 Value *LibCallSimplifier::optimizeFabs(CallInst *CI, IRBuilder<> &B) {
1277   Function *Callee = CI->getCalledFunction();
1278   Value *Ret = nullptr;
1279   StringRef Name = Callee->getName();
1280   if (Name == "fabs" && hasFloatVersion(Name))
1281     Ret = optimizeUnaryDoubleFP(CI, B, false);
1282
1283   FunctionType *FT = Callee->getFunctionType();
1284   // Make sure this has 1 argument of FP type which matches the result type.
1285   if (FT->getNumParams() != 1 || FT->getReturnType() != FT->getParamType(0) ||
1286       !FT->getParamType(0)->isFloatingPointTy())
1287     return Ret;
1288
1289   Value *Op = CI->getArgOperand(0);
1290   if (Instruction *I = dyn_cast<Instruction>(Op)) {
1291     // Fold fabs(x * x) -> x * x; any squared FP value must already be positive.
1292     if (I->getOpcode() == Instruction::FMul)
1293       if (I->getOperand(0) == I->getOperand(1))
1294         return Op;
1295   }
1296   return Ret;
1297 }
1298
1299 Value *LibCallSimplifier::optimizeFMinFMax(CallInst *CI, IRBuilder<> &B) {
1300   // If we can shrink the call to a float function rather than a double
1301   // function, do that first.
1302   Function *Callee = CI->getCalledFunction();
1303   StringRef Name = Callee->getName();
1304   if ((Name == "fmin" || Name == "fmax") && hasFloatVersion(Name))
1305     if (Value *Ret = optimizeBinaryDoubleFP(CI, B))
1306       return Ret;
1307
1308   // Make sure this has 2 arguments of FP type which match the result type.
1309   FunctionType *FT = Callee->getFunctionType();
1310   if (FT->getNumParams() != 2 || FT->getReturnType() != FT->getParamType(0) ||
1311       FT->getParamType(0) != FT->getParamType(1) ||
1312       !FT->getParamType(0)->isFloatingPointTy())
1313     return nullptr;
1314
1315   IRBuilder<>::FastMathFlagGuard Guard(B);
1316   FastMathFlags FMF;
1317   if (CI->hasUnsafeAlgebra()) {
1318     // Unsafe algebra sets all fast-math-flags to true.
1319     FMF.setUnsafeAlgebra();
1320   } else {
1321     // At a minimum, no-nans-fp-math must be true.
1322     if (!CI->hasNoNaNs())
1323       return nullptr;
1324     // No-signed-zeros is implied by the definitions of fmax/fmin themselves:
1325     // "Ideally, fmax would be sensitive to the sign of zero, for example
1326     // fmax(-0. 0, +0. 0) would return +0; however, implementation in software
1327     // might be impractical."
1328     FMF.setNoSignedZeros();
1329     FMF.setNoNaNs();
1330   }
1331   B.SetFastMathFlags(FMF);
1332
1333   // We have a relaxed floating-point environment. We can ignore NaN-handling
1334   // and transform to a compare and select. We do not have to consider errno or
1335   // exceptions, because fmin/fmax do not have those.
1336   Value *Op0 = CI->getArgOperand(0);
1337   Value *Op1 = CI->getArgOperand(1);
1338   Value *Cmp = Callee->getName().startswith("fmin") ?
1339     B.CreateFCmpOLT(Op0, Op1) : B.CreateFCmpOGT(Op0, Op1);
1340   return B.CreateSelect(Cmp, Op0, Op1);
1341 }
1342
1343 Value *LibCallSimplifier::optimizeLog(CallInst *CI, IRBuilder<> &B) {
1344   Function *Callee = CI->getCalledFunction();
1345   Value *Ret = nullptr;
1346   StringRef Name = Callee->getName();
1347   if (UnsafeFPShrink && hasFloatVersion(Name))
1348     Ret = optimizeUnaryDoubleFP(CI, B, true);
1349   FunctionType *FT = Callee->getFunctionType();
1350
1351   // Just make sure this has 1 argument of FP type, which matches the
1352   // result type.
1353   if (FT->getNumParams() != 1 || FT->getReturnType() != FT->getParamType(0) ||
1354       !FT->getParamType(0)->isFloatingPointTy())
1355     return Ret;
1356
1357   if (!canUseUnsafeFPMath(CI->getParent()->getParent()))
1358     return Ret;
1359   Value *Op1 = CI->getArgOperand(0);
1360   auto *OpC = dyn_cast<CallInst>(Op1);
1361   if (!OpC)
1362     return Ret;
1363
1364   // log(pow(x,y)) -> y*log(x)
1365   // This is only applicable to log, log2, log10.
1366   if (Name != "log" && Name != "log2" && Name != "log10")
1367     return Ret;
1368
1369   IRBuilder<>::FastMathFlagGuard Guard(B);
1370   FastMathFlags FMF;
1371   FMF.setUnsafeAlgebra();
1372   B.SetFastMathFlags(FMF);
1373
1374   LibFunc::Func Func;
1375   Function *F = OpC->getCalledFunction();
1376   if (F && ((TLI->getLibFunc(F->getName(), Func) && TLI->has(Func) &&
1377       Func == LibFunc::pow) || F->getIntrinsicID() == Intrinsic::pow))
1378     return B.CreateFMul(OpC->getArgOperand(1),
1379       EmitUnaryFloatFnCall(OpC->getOperand(0), Callee->getName(), B,
1380                            Callee->getAttributes()), "mul");
1381
1382   // log(exp2(y)) -> y*log(2)
1383   if (F && Name == "log" && TLI->getLibFunc(F->getName(), Func) &&
1384       TLI->has(Func) && Func == LibFunc::exp2)
1385     return B.CreateFMul(
1386         OpC->getArgOperand(0),
1387         EmitUnaryFloatFnCall(ConstantFP::get(CI->getType(), 2.0),
1388                              Callee->getName(), B, Callee->getAttributes()),
1389         "logmul");
1390   return Ret;
1391 }
1392
1393 Value *LibCallSimplifier::optimizeSqrt(CallInst *CI, IRBuilder<> &B) {
1394   Function *Callee = CI->getCalledFunction();
1395   
1396   Value *Ret = nullptr;
1397   if (TLI->has(LibFunc::sqrtf) && (Callee->getName() == "sqrt" ||
1398                                    Callee->getIntrinsicID() == Intrinsic::sqrt))
1399     Ret = optimizeUnaryDoubleFP(CI, B, true);
1400   if (!canUseUnsafeFPMath(CI->getParent()->getParent()))
1401     return Ret;
1402
1403   Value *Op = CI->getArgOperand(0);
1404   if (Instruction *I = dyn_cast<Instruction>(Op)) {
1405     if (I->getOpcode() == Instruction::FMul && I->hasUnsafeAlgebra()) {
1406       // We're looking for a repeated factor in a multiplication tree,
1407       // so we can do this fold: sqrt(x * x) -> fabs(x);
1408       // or this fold: sqrt(x * x * y) -> fabs(x) * sqrt(y).
1409       Value *Op0 = I->getOperand(0);
1410       Value *Op1 = I->getOperand(1);
1411       Value *RepeatOp = nullptr;
1412       Value *OtherOp = nullptr;
1413       if (Op0 == Op1) {
1414         // Simple match: the operands of the multiply are identical.
1415         RepeatOp = Op0;
1416       } else {
1417         // Look for a more complicated pattern: one of the operands is itself
1418         // a multiply, so search for a common factor in that multiply.
1419         // Note: We don't bother looking any deeper than this first level or for
1420         // variations of this pattern because instcombine's visitFMUL and/or the
1421         // reassociation pass should give us this form.
1422         Value *OtherMul0, *OtherMul1;
1423         if (match(Op0, m_FMul(m_Value(OtherMul0), m_Value(OtherMul1)))) {
1424           // Pattern: sqrt((x * y) * z)
1425           if (OtherMul0 == OtherMul1) {
1426             // Matched: sqrt((x * x) * z)
1427             RepeatOp = OtherMul0;
1428             OtherOp = Op1;
1429           }
1430         }
1431       }
1432       if (RepeatOp) {
1433         // Fast math flags for any created instructions should match the sqrt
1434         // and multiply.
1435         // FIXME: We're not checking the sqrt because it doesn't have
1436         // fast-math-flags (see earlier comment).
1437         IRBuilder<>::FastMathFlagGuard Guard(B);
1438         B.SetFastMathFlags(I->getFastMathFlags());
1439         // If we found a repeated factor, hoist it out of the square root and
1440         // replace it with the fabs of that factor.
1441         Module *M = Callee->getParent();
1442         Type *ArgType = Op->getType();
1443         Value *Fabs = Intrinsic::getDeclaration(M, Intrinsic::fabs, ArgType);
1444         Value *FabsCall = B.CreateCall(Fabs, RepeatOp, "fabs");
1445         if (OtherOp) {
1446           // If we found a non-repeated factor, we still need to get its square
1447           // root. We then multiply that by the value that was simplified out
1448           // of the square root calculation.
1449           Value *Sqrt = Intrinsic::getDeclaration(M, Intrinsic::sqrt, ArgType);
1450           Value *SqrtCall = B.CreateCall(Sqrt, OtherOp, "sqrt");
1451           return B.CreateFMul(FabsCall, SqrtCall);
1452         }
1453         return FabsCall;
1454       }
1455     }
1456   }
1457   return Ret;
1458 }
1459
1460 Value *LibCallSimplifier::optimizeTan(CallInst *CI, IRBuilder<> &B) {
1461   Function *Callee = CI->getCalledFunction();
1462   Value *Ret = nullptr;
1463   StringRef Name = Callee->getName();
1464   if (UnsafeFPShrink && Name == "tan" && hasFloatVersion(Name))
1465     Ret = optimizeUnaryDoubleFP(CI, B, true);
1466   FunctionType *FT = Callee->getFunctionType();
1467
1468   // Just make sure this has 1 argument of FP type, which matches the
1469   // result type.
1470   if (FT->getNumParams() != 1 || FT->getReturnType() != FT->getParamType(0) ||
1471       !FT->getParamType(0)->isFloatingPointTy())
1472     return Ret;
1473
1474   if (!canUseUnsafeFPMath(CI->getParent()->getParent()))
1475     return Ret;
1476   Value *Op1 = CI->getArgOperand(0);
1477   auto *OpC = dyn_cast<CallInst>(Op1);
1478   if (!OpC)
1479     return Ret;
1480
1481   // tan(atan(x)) -> x
1482   // tanf(atanf(x)) -> x
1483   // tanl(atanl(x)) -> x
1484   LibFunc::Func Func;
1485   Function *F = OpC->getCalledFunction();
1486   if (F && TLI->getLibFunc(F->getName(), Func) && TLI->has(Func) &&
1487       ((Func == LibFunc::atan && Callee->getName() == "tan") ||
1488        (Func == LibFunc::atanf && Callee->getName() == "tanf") ||
1489        (Func == LibFunc::atanl && Callee->getName() == "tanl")))
1490     Ret = OpC->getArgOperand(0);
1491   return Ret;
1492 }
1493
1494 static bool isTrigLibCall(CallInst *CI);
1495 static void insertSinCosCall(IRBuilder<> &B, Function *OrigCallee, Value *Arg,
1496                              bool UseFloat, Value *&Sin, Value *&Cos,
1497                              Value *&SinCos);
1498
1499 Value *LibCallSimplifier::optimizeSinCosPi(CallInst *CI, IRBuilder<> &B) {
1500
1501   // Make sure the prototype is as expected, otherwise the rest of the
1502   // function is probably invalid and likely to abort.
1503   if (!isTrigLibCall(CI))
1504     return nullptr;
1505
1506   Value *Arg = CI->getArgOperand(0);
1507   SmallVector<CallInst *, 1> SinCalls;
1508   SmallVector<CallInst *, 1> CosCalls;
1509   SmallVector<CallInst *, 1> SinCosCalls;
1510
1511   bool IsFloat = Arg->getType()->isFloatTy();
1512
1513   // Look for all compatible sinpi, cospi and sincospi calls with the same
1514   // argument. If there are enough (in some sense) we can make the
1515   // substitution.
1516   for (User *U : Arg->users())
1517     classifyArgUse(U, CI->getParent(), IsFloat, SinCalls, CosCalls,
1518                    SinCosCalls);
1519
1520   // It's only worthwhile if both sinpi and cospi are actually used.
1521   if (SinCosCalls.empty() && (SinCalls.empty() || CosCalls.empty()))
1522     return nullptr;
1523
1524   Value *Sin, *Cos, *SinCos;
1525   insertSinCosCall(B, CI->getCalledFunction(), Arg, IsFloat, Sin, Cos, SinCos);
1526
1527   replaceTrigInsts(SinCalls, Sin);
1528   replaceTrigInsts(CosCalls, Cos);
1529   replaceTrigInsts(SinCosCalls, SinCos);
1530
1531   return nullptr;
1532 }
1533
1534 static bool isTrigLibCall(CallInst *CI) {
1535   Function *Callee = CI->getCalledFunction();
1536   FunctionType *FT = Callee->getFunctionType();
1537
1538   // We can only hope to do anything useful if we can ignore things like errno
1539   // and floating-point exceptions.
1540   bool AttributesSafe =
1541       CI->hasFnAttr(Attribute::NoUnwind) && CI->hasFnAttr(Attribute::ReadNone);
1542
1543   // Other than that we need float(float) or double(double)
1544   return AttributesSafe && FT->getNumParams() == 1 &&
1545          FT->getReturnType() == FT->getParamType(0) &&
1546          (FT->getParamType(0)->isFloatTy() ||
1547           FT->getParamType(0)->isDoubleTy());
1548 }
1549
1550 void
1551 LibCallSimplifier::classifyArgUse(Value *Val, BasicBlock *BB, bool IsFloat,
1552                                   SmallVectorImpl<CallInst *> &SinCalls,
1553                                   SmallVectorImpl<CallInst *> &CosCalls,
1554                                   SmallVectorImpl<CallInst *> &SinCosCalls) {
1555   CallInst *CI = dyn_cast<CallInst>(Val);
1556
1557   if (!CI)
1558     return;
1559
1560   Function *Callee = CI->getCalledFunction();
1561   LibFunc::Func Func;
1562   if (!Callee || !TLI->getLibFunc(Callee->getName(), Func) || !TLI->has(Func) ||
1563       !isTrigLibCall(CI))
1564     return;
1565
1566   if (IsFloat) {
1567     if (Func == LibFunc::sinpif)
1568       SinCalls.push_back(CI);
1569     else if (Func == LibFunc::cospif)
1570       CosCalls.push_back(CI);
1571     else if (Func == LibFunc::sincospif_stret)
1572       SinCosCalls.push_back(CI);
1573   } else {
1574     if (Func == LibFunc::sinpi)
1575       SinCalls.push_back(CI);
1576     else if (Func == LibFunc::cospi)
1577       CosCalls.push_back(CI);
1578     else if (Func == LibFunc::sincospi_stret)
1579       SinCosCalls.push_back(CI);
1580   }
1581 }
1582
1583 void LibCallSimplifier::replaceTrigInsts(SmallVectorImpl<CallInst *> &Calls,
1584                                          Value *Res) {
1585   for (CallInst *C : Calls)
1586     replaceAllUsesWith(C, Res);
1587 }
1588
1589 void insertSinCosCall(IRBuilder<> &B, Function *OrigCallee, Value *Arg,
1590                       bool UseFloat, Value *&Sin, Value *&Cos, Value *&SinCos) {
1591   Type *ArgTy = Arg->getType();
1592   Type *ResTy;
1593   StringRef Name;
1594
1595   Triple T(OrigCallee->getParent()->getTargetTriple());
1596   if (UseFloat) {
1597     Name = "__sincospif_stret";
1598
1599     assert(T.getArch() != Triple::x86 && "x86 messy and unsupported for now");
1600     // x86_64 can't use {float, float} since that would be returned in both
1601     // xmm0 and xmm1, which isn't what a real struct would do.
1602     ResTy = T.getArch() == Triple::x86_64
1603                 ? static_cast<Type *>(VectorType::get(ArgTy, 2))
1604                 : static_cast<Type *>(StructType::get(ArgTy, ArgTy, nullptr));
1605   } else {
1606     Name = "__sincospi_stret";
1607     ResTy = StructType::get(ArgTy, ArgTy, nullptr);
1608   }
1609
1610   Module *M = OrigCallee->getParent();
1611   Value *Callee = M->getOrInsertFunction(Name, OrigCallee->getAttributes(),
1612                                          ResTy, ArgTy, nullptr);
1613
1614   if (Instruction *ArgInst = dyn_cast<Instruction>(Arg)) {
1615     // If the argument is an instruction, it must dominate all uses so put our
1616     // sincos call there.
1617     B.SetInsertPoint(ArgInst->getParent(), ++ArgInst->getIterator());
1618   } else {
1619     // Otherwise (e.g. for a constant) the beginning of the function is as
1620     // good a place as any.
1621     BasicBlock &EntryBB = B.GetInsertBlock()->getParent()->getEntryBlock();
1622     B.SetInsertPoint(&EntryBB, EntryBB.begin());
1623   }
1624
1625   SinCos = B.CreateCall(Callee, Arg, "sincospi");
1626
1627   if (SinCos->getType()->isStructTy()) {
1628     Sin = B.CreateExtractValue(SinCos, 0, "sinpi");
1629     Cos = B.CreateExtractValue(SinCos, 1, "cospi");
1630   } else {
1631     Sin = B.CreateExtractElement(SinCos, ConstantInt::get(B.getInt32Ty(), 0),
1632                                  "sinpi");
1633     Cos = B.CreateExtractElement(SinCos, ConstantInt::get(B.getInt32Ty(), 1),
1634                                  "cospi");
1635   }
1636 }
1637
1638 //===----------------------------------------------------------------------===//
1639 // Integer Library Call Optimizations
1640 //===----------------------------------------------------------------------===//
1641
1642 static bool checkIntUnaryReturnAndParam(Function *Callee) {
1643   FunctionType *FT = Callee->getFunctionType();
1644   return FT->getNumParams() == 1 && FT->getReturnType()->isIntegerTy(32) &&
1645     FT->getParamType(0)->isIntegerTy();
1646 }
1647
1648 Value *LibCallSimplifier::optimizeFFS(CallInst *CI, IRBuilder<> &B) {
1649   Function *Callee = CI->getCalledFunction();
1650   if (!checkIntUnaryReturnAndParam(Callee))
1651     return nullptr;
1652   Value *Op = CI->getArgOperand(0);
1653
1654   // Constant fold.
1655   if (ConstantInt *CI = dyn_cast<ConstantInt>(Op)) {
1656     if (CI->isZero()) // ffs(0) -> 0.
1657       return B.getInt32(0);
1658     // ffs(c) -> cttz(c)+1
1659     return B.getInt32(CI->getValue().countTrailingZeros() + 1);
1660   }
1661
1662   // ffs(x) -> x != 0 ? (i32)llvm.cttz(x)+1 : 0
1663   Type *ArgType = Op->getType();
1664   Value *F =
1665       Intrinsic::getDeclaration(Callee->getParent(), Intrinsic::cttz, ArgType);
1666   Value *V = B.CreateCall(F, {Op, B.getTrue()}, "cttz");
1667   V = B.CreateAdd(V, ConstantInt::get(V->getType(), 1));
1668   V = B.CreateIntCast(V, B.getInt32Ty(), false);
1669
1670   Value *Cond = B.CreateICmpNE(Op, Constant::getNullValue(ArgType));
1671   return B.CreateSelect(Cond, V, B.getInt32(0));
1672 }
1673
1674 Value *LibCallSimplifier::optimizeAbs(CallInst *CI, IRBuilder<> &B) {
1675   Function *Callee = CI->getCalledFunction();
1676   FunctionType *FT = Callee->getFunctionType();
1677   // We require integer(integer) where the types agree.
1678   if (FT->getNumParams() != 1 || !FT->getReturnType()->isIntegerTy() ||
1679       FT->getParamType(0) != FT->getReturnType())
1680     return nullptr;
1681
1682   // abs(x) -> x >s -1 ? x : -x
1683   Value *Op = CI->getArgOperand(0);
1684   Value *Pos =
1685       B.CreateICmpSGT(Op, Constant::getAllOnesValue(Op->getType()), "ispos");
1686   Value *Neg = B.CreateNeg(Op, "neg");
1687   return B.CreateSelect(Pos, Op, Neg);
1688 }
1689
1690 Value *LibCallSimplifier::optimizeIsDigit(CallInst *CI, IRBuilder<> &B) {
1691   if (!checkIntUnaryReturnAndParam(CI->getCalledFunction()))
1692     return nullptr;
1693
1694   // isdigit(c) -> (c-'0') <u 10
1695   Value *Op = CI->getArgOperand(0);
1696   Op = B.CreateSub(Op, B.getInt32('0'), "isdigittmp");
1697   Op = B.CreateICmpULT(Op, B.getInt32(10), "isdigit");
1698   return B.CreateZExt(Op, CI->getType());
1699 }
1700
1701 Value *LibCallSimplifier::optimizeIsAscii(CallInst *CI, IRBuilder<> &B) {
1702   if (!checkIntUnaryReturnAndParam(CI->getCalledFunction()))
1703     return nullptr;
1704
1705   // isascii(c) -> c <u 128
1706   Value *Op = CI->getArgOperand(0);
1707   Op = B.CreateICmpULT(Op, B.getInt32(128), "isascii");
1708   return B.CreateZExt(Op, CI->getType());
1709 }
1710
1711 Value *LibCallSimplifier::optimizeToAscii(CallInst *CI, IRBuilder<> &B) {
1712   if (!checkIntUnaryReturnAndParam(CI->getCalledFunction()))
1713     return nullptr;
1714
1715   // toascii(c) -> c & 0x7f
1716   return B.CreateAnd(CI->getArgOperand(0),
1717                      ConstantInt::get(CI->getType(), 0x7F));
1718 }
1719
1720 //===----------------------------------------------------------------------===//
1721 // Formatting and IO Library Call Optimizations
1722 //===----------------------------------------------------------------------===//
1723
1724 static bool isReportingError(Function *Callee, CallInst *CI, int StreamArg);
1725
1726 Value *LibCallSimplifier::optimizeErrorReporting(CallInst *CI, IRBuilder<> &B,
1727                                                  int StreamArg) {
1728   // Error reporting calls should be cold, mark them as such.
1729   // This applies even to non-builtin calls: it is only a hint and applies to
1730   // functions that the frontend might not understand as builtins.
1731
1732   // This heuristic was suggested in:
1733   // Improving Static Branch Prediction in a Compiler
1734   // Brian L. Deitrich, Ben-Chung Cheng, Wen-mei W. Hwu
1735   // Proceedings of PACT'98, Oct. 1998, IEEE
1736   Function *Callee = CI->getCalledFunction();
1737
1738   if (!CI->hasFnAttr(Attribute::Cold) &&
1739       isReportingError(Callee, CI, StreamArg)) {
1740     CI->addAttribute(AttributeSet::FunctionIndex, Attribute::Cold);
1741   }
1742
1743   return nullptr;
1744 }
1745
1746 static bool isReportingError(Function *Callee, CallInst *CI, int StreamArg) {
1747   if (!ColdErrorCalls || !Callee || !Callee->isDeclaration())
1748     return false;
1749
1750   if (StreamArg < 0)
1751     return true;
1752
1753   // These functions might be considered cold, but only if their stream
1754   // argument is stderr.
1755
1756   if (StreamArg >= (int)CI->getNumArgOperands())
1757     return false;
1758   LoadInst *LI = dyn_cast<LoadInst>(CI->getArgOperand(StreamArg));
1759   if (!LI)
1760     return false;
1761   GlobalVariable *GV = dyn_cast<GlobalVariable>(LI->getPointerOperand());
1762   if (!GV || !GV->isDeclaration())
1763     return false;
1764   return GV->getName() == "stderr";
1765 }
1766
1767 Value *LibCallSimplifier::optimizePrintFString(CallInst *CI, IRBuilder<> &B) {
1768   // Check for a fixed format string.
1769   StringRef FormatStr;
1770   if (!getConstantStringInfo(CI->getArgOperand(0), FormatStr))
1771     return nullptr;
1772
1773   // Empty format string -> noop.
1774   if (FormatStr.empty()) // Tolerate printf's declared void.
1775     return CI->use_empty() ? (Value *)CI : ConstantInt::get(CI->getType(), 0);
1776
1777   // Do not do any of the following transformations if the printf return value
1778   // is used, in general the printf return value is not compatible with either
1779   // putchar() or puts().
1780   if (!CI->use_empty())
1781     return nullptr;
1782
1783   // printf("x") -> putchar('x'), even for '%'.
1784   if (FormatStr.size() == 1) {
1785     Value *Res = EmitPutChar(B.getInt32(FormatStr[0]), B, TLI);
1786     if (CI->use_empty() || !Res)
1787       return Res;
1788     return B.CreateIntCast(Res, CI->getType(), true);
1789   }
1790
1791   // printf("foo\n") --> puts("foo")
1792   if (FormatStr[FormatStr.size() - 1] == '\n' &&
1793       FormatStr.find('%') == StringRef::npos) { // No format characters.
1794     // Create a string literal with no \n on it.  We expect the constant merge
1795     // pass to be run after this pass, to merge duplicate strings.
1796     FormatStr = FormatStr.drop_back();
1797     Value *GV = B.CreateGlobalString(FormatStr, "str");
1798     Value *NewCI = EmitPutS(GV, B, TLI);
1799     return (CI->use_empty() || !NewCI)
1800                ? NewCI
1801                : ConstantInt::get(CI->getType(), FormatStr.size() + 1);
1802   }
1803
1804   // Optimize specific format strings.
1805   // printf("%c", chr) --> putchar(chr)
1806   if (FormatStr == "%c" && CI->getNumArgOperands() > 1 &&
1807       CI->getArgOperand(1)->getType()->isIntegerTy()) {
1808     Value *Res = EmitPutChar(CI->getArgOperand(1), B, TLI);
1809
1810     if (CI->use_empty() || !Res)
1811       return Res;
1812     return B.CreateIntCast(Res, CI->getType(), true);
1813   }
1814
1815   // printf("%s\n", str) --> puts(str)
1816   if (FormatStr == "%s\n" && CI->getNumArgOperands() > 1 &&
1817       CI->getArgOperand(1)->getType()->isPointerTy()) {
1818     return EmitPutS(CI->getArgOperand(1), B, TLI);
1819   }
1820   return nullptr;
1821 }
1822
1823 Value *LibCallSimplifier::optimizePrintF(CallInst *CI, IRBuilder<> &B) {
1824
1825   Function *Callee = CI->getCalledFunction();
1826   // Require one fixed pointer argument and an integer/void result.
1827   FunctionType *FT = Callee->getFunctionType();
1828   if (FT->getNumParams() < 1 || !FT->getParamType(0)->isPointerTy() ||
1829       !(FT->getReturnType()->isIntegerTy() || FT->getReturnType()->isVoidTy()))
1830     return nullptr;
1831
1832   if (Value *V = optimizePrintFString(CI, B)) {
1833     return V;
1834   }
1835
1836   // printf(format, ...) -> iprintf(format, ...) if no floating point
1837   // arguments.
1838   if (TLI->has(LibFunc::iprintf) && !callHasFloatingPointArgument(CI)) {
1839     Module *M = B.GetInsertBlock()->getParent()->getParent();
1840     Constant *IPrintFFn =
1841         M->getOrInsertFunction("iprintf", FT, Callee->getAttributes());
1842     CallInst *New = cast<CallInst>(CI->clone());
1843     New->setCalledFunction(IPrintFFn);
1844     B.Insert(New);
1845     return New;
1846   }
1847   return nullptr;
1848 }
1849
1850 Value *LibCallSimplifier::optimizeSPrintFString(CallInst *CI, IRBuilder<> &B) {
1851   // Check for a fixed format string.
1852   StringRef FormatStr;
1853   if (!getConstantStringInfo(CI->getArgOperand(1), FormatStr))
1854     return nullptr;
1855
1856   // If we just have a format string (nothing else crazy) transform it.
1857   if (CI->getNumArgOperands() == 2) {
1858     // Make sure there's no % in the constant array.  We could try to handle
1859     // %% -> % in the future if we cared.
1860     for (unsigned i = 0, e = FormatStr.size(); i != e; ++i)
1861       if (FormatStr[i] == '%')
1862         return nullptr; // we found a format specifier, bail out.
1863
1864     // sprintf(str, fmt) -> llvm.memcpy(str, fmt, strlen(fmt)+1, 1)
1865     B.CreateMemCpy(CI->getArgOperand(0), CI->getArgOperand(1),
1866                    ConstantInt::get(DL.getIntPtrType(CI->getContext()),
1867                                     FormatStr.size() + 1),
1868                    1); // Copy the null byte.
1869     return ConstantInt::get(CI->getType(), FormatStr.size());
1870   }
1871
1872   // The remaining optimizations require the format string to be "%s" or "%c"
1873   // and have an extra operand.
1874   if (FormatStr.size() != 2 || FormatStr[0] != '%' ||
1875       CI->getNumArgOperands() < 3)
1876     return nullptr;
1877
1878   // Decode the second character of the format string.
1879   if (FormatStr[1] == 'c') {
1880     // sprintf(dst, "%c", chr) --> *(i8*)dst = chr; *((i8*)dst+1) = 0
1881     if (!CI->getArgOperand(2)->getType()->isIntegerTy())
1882       return nullptr;
1883     Value *V = B.CreateTrunc(CI->getArgOperand(2), B.getInt8Ty(), "char");
1884     Value *Ptr = CastToCStr(CI->getArgOperand(0), B);
1885     B.CreateStore(V, Ptr);
1886     Ptr = B.CreateGEP(B.getInt8Ty(), Ptr, B.getInt32(1), "nul");
1887     B.CreateStore(B.getInt8(0), Ptr);
1888
1889     return ConstantInt::get(CI->getType(), 1);
1890   }
1891
1892   if (FormatStr[1] == 's') {
1893     // sprintf(dest, "%s", str) -> llvm.memcpy(dest, str, strlen(str)+1, 1)
1894     if (!CI->getArgOperand(2)->getType()->isPointerTy())
1895       return nullptr;
1896
1897     Value *Len = EmitStrLen(CI->getArgOperand(2), B, DL, TLI);
1898     if (!Len)
1899       return nullptr;
1900     Value *IncLen =
1901         B.CreateAdd(Len, ConstantInt::get(Len->getType(), 1), "leninc");
1902     B.CreateMemCpy(CI->getArgOperand(0), CI->getArgOperand(2), IncLen, 1);
1903
1904     // The sprintf result is the unincremented number of bytes in the string.
1905     return B.CreateIntCast(Len, CI->getType(), false);
1906   }
1907   return nullptr;
1908 }
1909
1910 Value *LibCallSimplifier::optimizeSPrintF(CallInst *CI, IRBuilder<> &B) {
1911   Function *Callee = CI->getCalledFunction();
1912   // Require two fixed pointer arguments and an integer result.
1913   FunctionType *FT = Callee->getFunctionType();
1914   if (FT->getNumParams() != 2 || !FT->getParamType(0)->isPointerTy() ||
1915       !FT->getParamType(1)->isPointerTy() ||
1916       !FT->getReturnType()->isIntegerTy())
1917     return nullptr;
1918
1919   if (Value *V = optimizeSPrintFString(CI, B)) {
1920     return V;
1921   }
1922
1923   // sprintf(str, format, ...) -> siprintf(str, format, ...) if no floating
1924   // point arguments.
1925   if (TLI->has(LibFunc::siprintf) && !callHasFloatingPointArgument(CI)) {
1926     Module *M = B.GetInsertBlock()->getParent()->getParent();
1927     Constant *SIPrintFFn =
1928         M->getOrInsertFunction("siprintf", FT, Callee->getAttributes());
1929     CallInst *New = cast<CallInst>(CI->clone());
1930     New->setCalledFunction(SIPrintFFn);
1931     B.Insert(New);
1932     return New;
1933   }
1934   return nullptr;
1935 }
1936
1937 Value *LibCallSimplifier::optimizeFPrintFString(CallInst *CI, IRBuilder<> &B) {
1938   optimizeErrorReporting(CI, B, 0);
1939
1940   // All the optimizations depend on the format string.
1941   StringRef FormatStr;
1942   if (!getConstantStringInfo(CI->getArgOperand(1), FormatStr))
1943     return nullptr;
1944
1945   // Do not do any of the following transformations if the fprintf return
1946   // value is used, in general the fprintf return value is not compatible
1947   // with fwrite(), fputc() or fputs().
1948   if (!CI->use_empty())
1949     return nullptr;
1950
1951   // fprintf(F, "foo") --> fwrite("foo", 3, 1, F)
1952   if (CI->getNumArgOperands() == 2) {
1953     for (unsigned i = 0, e = FormatStr.size(); i != e; ++i)
1954       if (FormatStr[i] == '%') // Could handle %% -> % if we cared.
1955         return nullptr;        // We found a format specifier.
1956
1957     return EmitFWrite(
1958         CI->getArgOperand(1),
1959         ConstantInt::get(DL.getIntPtrType(CI->getContext()), FormatStr.size()),
1960         CI->getArgOperand(0), B, DL, TLI);
1961   }
1962
1963   // The remaining optimizations require the format string to be "%s" or "%c"
1964   // and have an extra operand.
1965   if (FormatStr.size() != 2 || FormatStr[0] != '%' ||
1966       CI->getNumArgOperands() < 3)
1967     return nullptr;
1968
1969   // Decode the second character of the format string.
1970   if (FormatStr[1] == 'c') {
1971     // fprintf(F, "%c", chr) --> fputc(chr, F)
1972     if (!CI->getArgOperand(2)->getType()->isIntegerTy())
1973       return nullptr;
1974     return EmitFPutC(CI->getArgOperand(2), CI->getArgOperand(0), B, TLI);
1975   }
1976
1977   if (FormatStr[1] == 's') {
1978     // fprintf(F, "%s", str) --> fputs(str, F)
1979     if (!CI->getArgOperand(2)->getType()->isPointerTy())
1980       return nullptr;
1981     return EmitFPutS(CI->getArgOperand(2), CI->getArgOperand(0), B, TLI);
1982   }
1983   return nullptr;
1984 }
1985
1986 Value *LibCallSimplifier::optimizeFPrintF(CallInst *CI, IRBuilder<> &B) {
1987   Function *Callee = CI->getCalledFunction();
1988   // Require two fixed paramters as pointers and integer result.
1989   FunctionType *FT = Callee->getFunctionType();
1990   if (FT->getNumParams() != 2 || !FT->getParamType(0)->isPointerTy() ||
1991       !FT->getParamType(1)->isPointerTy() ||
1992       !FT->getReturnType()->isIntegerTy())
1993     return nullptr;
1994
1995   if (Value *V = optimizeFPrintFString(CI, B)) {
1996     return V;
1997   }
1998
1999   // fprintf(stream, format, ...) -> fiprintf(stream, format, ...) if no
2000   // floating point arguments.
2001   if (TLI->has(LibFunc::fiprintf) && !callHasFloatingPointArgument(CI)) {
2002     Module *M = B.GetInsertBlock()->getParent()->getParent();
2003     Constant *FIPrintFFn =
2004         M->getOrInsertFunction("fiprintf", FT, Callee->getAttributes());
2005     CallInst *New = cast<CallInst>(CI->clone());
2006     New->setCalledFunction(FIPrintFFn);
2007     B.Insert(New);
2008     return New;
2009   }
2010   return nullptr;
2011 }
2012
2013 Value *LibCallSimplifier::optimizeFWrite(CallInst *CI, IRBuilder<> &B) {
2014   optimizeErrorReporting(CI, B, 3);
2015
2016   Function *Callee = CI->getCalledFunction();
2017   // Require a pointer, an integer, an integer, a pointer, returning integer.
2018   FunctionType *FT = Callee->getFunctionType();
2019   if (FT->getNumParams() != 4 || !FT->getParamType(0)->isPointerTy() ||
2020       !FT->getParamType(1)->isIntegerTy() ||
2021       !FT->getParamType(2)->isIntegerTy() ||
2022       !FT->getParamType(3)->isPointerTy() ||
2023       !FT->getReturnType()->isIntegerTy())
2024     return nullptr;
2025
2026   // Get the element size and count.
2027   ConstantInt *SizeC = dyn_cast<ConstantInt>(CI->getArgOperand(1));
2028   ConstantInt *CountC = dyn_cast<ConstantInt>(CI->getArgOperand(2));
2029   if (!SizeC || !CountC)
2030     return nullptr;
2031   uint64_t Bytes = SizeC->getZExtValue() * CountC->getZExtValue();
2032
2033   // If this is writing zero records, remove the call (it's a noop).
2034   if (Bytes == 0)
2035     return ConstantInt::get(CI->getType(), 0);
2036
2037   // If this is writing one byte, turn it into fputc.
2038   // This optimisation is only valid, if the return value is unused.
2039   if (Bytes == 1 && CI->use_empty()) { // fwrite(S,1,1,F) -> fputc(S[0],F)
2040     Value *Char = B.CreateLoad(CastToCStr(CI->getArgOperand(0), B), "char");
2041     Value *NewCI = EmitFPutC(Char, CI->getArgOperand(3), B, TLI);
2042     return NewCI ? ConstantInt::get(CI->getType(), 1) : nullptr;
2043   }
2044
2045   return nullptr;
2046 }
2047
2048 Value *LibCallSimplifier::optimizeFPuts(CallInst *CI, IRBuilder<> &B) {
2049   optimizeErrorReporting(CI, B, 1);
2050
2051   Function *Callee = CI->getCalledFunction();
2052
2053   // Require two pointers.  Also, we can't optimize if return value is used.
2054   FunctionType *FT = Callee->getFunctionType();
2055   if (FT->getNumParams() != 2 || !FT->getParamType(0)->isPointerTy() ||
2056       !FT->getParamType(1)->isPointerTy() || !CI->use_empty())
2057     return nullptr;
2058
2059   // fputs(s,F) --> fwrite(s,1,strlen(s),F)
2060   uint64_t Len = GetStringLength(CI->getArgOperand(0));
2061   if (!Len)
2062     return nullptr;
2063
2064   // Known to have no uses (see above).
2065   return EmitFWrite(
2066       CI->getArgOperand(0),
2067       ConstantInt::get(DL.getIntPtrType(CI->getContext()), Len - 1),
2068       CI->getArgOperand(1), B, DL, TLI);
2069 }
2070
2071 Value *LibCallSimplifier::optimizePuts(CallInst *CI, IRBuilder<> &B) {
2072   Function *Callee = CI->getCalledFunction();
2073   // Require one fixed pointer argument and an integer/void result.
2074   FunctionType *FT = Callee->getFunctionType();
2075   if (FT->getNumParams() < 1 || !FT->getParamType(0)->isPointerTy() ||
2076       !(FT->getReturnType()->isIntegerTy() || FT->getReturnType()->isVoidTy()))
2077     return nullptr;
2078
2079   // Check for a constant string.
2080   StringRef Str;
2081   if (!getConstantStringInfo(CI->getArgOperand(0), Str))
2082     return nullptr;
2083
2084   if (Str.empty() && CI->use_empty()) {
2085     // puts("") -> putchar('\n')
2086     Value *Res = EmitPutChar(B.getInt32('\n'), B, TLI);
2087     if (CI->use_empty() || !Res)
2088       return Res;
2089     return B.CreateIntCast(Res, CI->getType(), true);
2090   }
2091
2092   return nullptr;
2093 }
2094
2095 bool LibCallSimplifier::hasFloatVersion(StringRef FuncName) {
2096   LibFunc::Func Func;
2097   SmallString<20> FloatFuncName = FuncName;
2098   FloatFuncName += 'f';
2099   if (TLI->getLibFunc(FloatFuncName, Func))
2100     return TLI->has(Func);
2101   return false;
2102 }
2103
2104 Value *LibCallSimplifier::optimizeStringMemoryLibCall(CallInst *CI,
2105                                                       IRBuilder<> &Builder) {
2106   LibFunc::Func Func;
2107   Function *Callee = CI->getCalledFunction();
2108   StringRef FuncName = Callee->getName();
2109
2110   // Check for string/memory library functions.
2111   if (TLI->getLibFunc(FuncName, Func) && TLI->has(Func)) {
2112     // Make sure we never change the calling convention.
2113     assert((ignoreCallingConv(Func) ||
2114             CI->getCallingConv() == llvm::CallingConv::C) &&
2115       "Optimizing string/memory libcall would change the calling convention");
2116     switch (Func) {
2117     case LibFunc::strcat:
2118       return optimizeStrCat(CI, Builder);
2119     case LibFunc::strncat:
2120       return optimizeStrNCat(CI, Builder);
2121     case LibFunc::strchr:
2122       return optimizeStrChr(CI, Builder);
2123     case LibFunc::strrchr:
2124       return optimizeStrRChr(CI, Builder);
2125     case LibFunc::strcmp:
2126       return optimizeStrCmp(CI, Builder);
2127     case LibFunc::strncmp:
2128       return optimizeStrNCmp(CI, Builder);
2129     case LibFunc::strcpy:
2130       return optimizeStrCpy(CI, Builder);
2131     case LibFunc::stpcpy:
2132       return optimizeStpCpy(CI, Builder);
2133     case LibFunc::strncpy:
2134       return optimizeStrNCpy(CI, Builder);
2135     case LibFunc::strlen:
2136       return optimizeStrLen(CI, Builder);
2137     case LibFunc::strpbrk:
2138       return optimizeStrPBrk(CI, Builder);
2139     case LibFunc::strtol:
2140     case LibFunc::strtod:
2141     case LibFunc::strtof:
2142     case LibFunc::strtoul:
2143     case LibFunc::strtoll:
2144     case LibFunc::strtold:
2145     case LibFunc::strtoull:
2146       return optimizeStrTo(CI, Builder);
2147     case LibFunc::strspn:
2148       return optimizeStrSpn(CI, Builder);
2149     case LibFunc::strcspn:
2150       return optimizeStrCSpn(CI, Builder);
2151     case LibFunc::strstr:
2152       return optimizeStrStr(CI, Builder);
2153     case LibFunc::memchr:
2154       return optimizeMemChr(CI, Builder);
2155     case LibFunc::memcmp:
2156       return optimizeMemCmp(CI, Builder);
2157     case LibFunc::memcpy:
2158       return optimizeMemCpy(CI, Builder);
2159     case LibFunc::memmove:
2160       return optimizeMemMove(CI, Builder);
2161     case LibFunc::memset:
2162       return optimizeMemSet(CI, Builder);
2163     default:
2164       break;
2165     }
2166   }
2167   return nullptr;
2168 }
2169
2170 Value *LibCallSimplifier::optimizeCall(CallInst *CI) {
2171   if (CI->isNoBuiltin())
2172     return nullptr;
2173
2174   LibFunc::Func Func;
2175   Function *Callee = CI->getCalledFunction();
2176   StringRef FuncName = Callee->getName();
2177
2178   SmallVector<OperandBundleDef, 2> OpBundles;
2179   CI->getOperandBundlesAsDefs(OpBundles);
2180   IRBuilder<> Builder(CI, /*FPMathTag=*/nullptr, OpBundles);
2181   bool isCallingConvC = CI->getCallingConv() == llvm::CallingConv::C;
2182
2183   // Command-line parameter overrides function attribute.
2184   if (EnableUnsafeFPShrink.getNumOccurrences() > 0)
2185     UnsafeFPShrink = EnableUnsafeFPShrink;
2186   else if (canUseUnsafeFPMath(Callee))
2187     UnsafeFPShrink = true;
2188
2189   // First, check for intrinsics.
2190   if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(CI)) {
2191     if (!isCallingConvC)
2192       return nullptr;
2193     switch (II->getIntrinsicID()) {
2194     case Intrinsic::pow:
2195       return optimizePow(CI, Builder);
2196     case Intrinsic::exp2:
2197       return optimizeExp2(CI, Builder);
2198     case Intrinsic::fabs:
2199       return optimizeFabs(CI, Builder);
2200     case Intrinsic::log:
2201       return optimizeLog(CI, Builder);
2202     case Intrinsic::sqrt:
2203       return optimizeSqrt(CI, Builder);
2204     default:
2205       return nullptr;
2206     }
2207   }
2208
2209   // Also try to simplify calls to fortified library functions.
2210   if (Value *SimplifiedFortifiedCI = FortifiedSimplifier.optimizeCall(CI)) {
2211     // Try to further simplify the result.
2212     CallInst *SimplifiedCI = dyn_cast<CallInst>(SimplifiedFortifiedCI);
2213     if (SimplifiedCI && SimplifiedCI->getCalledFunction()) {
2214       // Use an IR Builder from SimplifiedCI if available instead of CI
2215       // to guarantee we reach all uses we might replace later on.
2216       IRBuilder<> TmpBuilder(SimplifiedCI);
2217       if (Value *V = optimizeStringMemoryLibCall(SimplifiedCI, TmpBuilder)) {
2218         // If we were able to further simplify, remove the now redundant call.
2219         SimplifiedCI->replaceAllUsesWith(V);
2220         SimplifiedCI->eraseFromParent();
2221         return V;
2222       }
2223     }
2224     return SimplifiedFortifiedCI;
2225   }
2226
2227   // Then check for known library functions.
2228   if (TLI->getLibFunc(FuncName, Func) && TLI->has(Func)) {
2229     // We never change the calling convention.
2230     if (!ignoreCallingConv(Func) && !isCallingConvC)
2231       return nullptr;
2232     if (Value *V = optimizeStringMemoryLibCall(CI, Builder))
2233       return V;
2234     switch (Func) {
2235     case LibFunc::cosf:
2236     case LibFunc::cos:
2237     case LibFunc::cosl:
2238       return optimizeCos(CI, Builder);
2239     case LibFunc::sinpif:
2240     case LibFunc::sinpi:
2241     case LibFunc::cospif:
2242     case LibFunc::cospi:
2243       return optimizeSinCosPi(CI, Builder);
2244     case LibFunc::powf:
2245     case LibFunc::pow:
2246     case LibFunc::powl:
2247       return optimizePow(CI, Builder);
2248     case LibFunc::exp2l:
2249     case LibFunc::exp2:
2250     case LibFunc::exp2f:
2251       return optimizeExp2(CI, Builder);
2252     case LibFunc::fabsf:
2253     case LibFunc::fabs:
2254     case LibFunc::fabsl:
2255       return optimizeFabs(CI, Builder);
2256     case LibFunc::sqrtf:
2257     case LibFunc::sqrt:
2258     case LibFunc::sqrtl:
2259       return optimizeSqrt(CI, Builder);
2260     case LibFunc::ffs:
2261     case LibFunc::ffsl:
2262     case LibFunc::ffsll:
2263       return optimizeFFS(CI, Builder);
2264     case LibFunc::abs:
2265     case LibFunc::labs:
2266     case LibFunc::llabs:
2267       return optimizeAbs(CI, Builder);
2268     case LibFunc::isdigit:
2269       return optimizeIsDigit(CI, Builder);
2270     case LibFunc::isascii:
2271       return optimizeIsAscii(CI, Builder);
2272     case LibFunc::toascii:
2273       return optimizeToAscii(CI, Builder);
2274     case LibFunc::printf:
2275       return optimizePrintF(CI, Builder);
2276     case LibFunc::sprintf:
2277       return optimizeSPrintF(CI, Builder);
2278     case LibFunc::fprintf:
2279       return optimizeFPrintF(CI, Builder);
2280     case LibFunc::fwrite:
2281       return optimizeFWrite(CI, Builder);
2282     case LibFunc::fputs:
2283       return optimizeFPuts(CI, Builder);
2284     case LibFunc::log:
2285     case LibFunc::log10:
2286     case LibFunc::log1p:
2287     case LibFunc::log2:
2288     case LibFunc::logb:
2289       return optimizeLog(CI, Builder);
2290     case LibFunc::puts:
2291       return optimizePuts(CI, Builder);
2292     case LibFunc::tan:
2293     case LibFunc::tanf:
2294     case LibFunc::tanl:
2295       return optimizeTan(CI, Builder);
2296     case LibFunc::perror:
2297       return optimizeErrorReporting(CI, Builder);
2298     case LibFunc::vfprintf:
2299     case LibFunc::fiprintf:
2300       return optimizeErrorReporting(CI, Builder, 0);
2301     case LibFunc::fputc:
2302       return optimizeErrorReporting(CI, Builder, 1);
2303     case LibFunc::ceil:
2304     case LibFunc::floor:
2305     case LibFunc::rint:
2306     case LibFunc::round:
2307     case LibFunc::nearbyint:
2308     case LibFunc::trunc:
2309       if (hasFloatVersion(FuncName))
2310         return optimizeUnaryDoubleFP(CI, Builder, false);
2311       return nullptr;
2312     case LibFunc::acos:
2313     case LibFunc::acosh:
2314     case LibFunc::asin:
2315     case LibFunc::asinh:
2316     case LibFunc::atan:
2317     case LibFunc::atanh:
2318     case LibFunc::cbrt:
2319     case LibFunc::cosh:
2320     case LibFunc::exp:
2321     case LibFunc::exp10:
2322     case LibFunc::expm1:
2323     case LibFunc::sin:
2324     case LibFunc::sinh:
2325     case LibFunc::tanh:
2326       if (UnsafeFPShrink && hasFloatVersion(FuncName))
2327         return optimizeUnaryDoubleFP(CI, Builder, true);
2328       return nullptr;
2329     case LibFunc::copysign:
2330       if (hasFloatVersion(FuncName))
2331         return optimizeBinaryDoubleFP(CI, Builder);
2332       return nullptr;
2333     case LibFunc::fminf:
2334     case LibFunc::fmin:
2335     case LibFunc::fminl:
2336     case LibFunc::fmaxf:
2337     case LibFunc::fmax:
2338     case LibFunc::fmaxl:
2339       return optimizeFMinFMax(CI, Builder);
2340     default:
2341       return nullptr;
2342     }
2343   }
2344   return nullptr;
2345 }
2346
2347 LibCallSimplifier::LibCallSimplifier(
2348     const DataLayout &DL, const TargetLibraryInfo *TLI,
2349     function_ref<void(Instruction *, Value *)> Replacer)
2350     : FortifiedSimplifier(TLI), DL(DL), TLI(TLI), UnsafeFPShrink(false),
2351       Replacer(Replacer) {}
2352
2353 void LibCallSimplifier::replaceAllUsesWith(Instruction *I, Value *With) {
2354   // Indirect through the replacer used in this instance.
2355   Replacer(I, With);
2356 }
2357
2358 // TODO:
2359 //   Additional cases that we need to add to this file:
2360 //
2361 // cbrt:
2362 //   * cbrt(expN(X))  -> expN(x/3)
2363 //   * cbrt(sqrt(x))  -> pow(x,1/6)
2364 //   * cbrt(cbrt(x))  -> pow(x,1/9)
2365 //
2366 // exp, expf, expl:
2367 //   * exp(log(x))  -> x
2368 //
2369 // log, logf, logl:
2370 //   * log(exp(x))   -> x
2371 //   * log(exp(y))   -> y*log(e)
2372 //   * log(exp10(y)) -> y*log(10)
2373 //   * log(sqrt(x))  -> 0.5*log(x)
2374 //
2375 // lround, lroundf, lroundl:
2376 //   * lround(cnst) -> cnst'
2377 //
2378 // pow, powf, powl:
2379 //   * pow(sqrt(x),y) -> pow(x,y*0.5)
2380 //   * pow(pow(x,y),z)-> pow(x,y*z)
2381 //
2382 // round, roundf, roundl:
2383 //   * round(cnst) -> cnst'
2384 //
2385 // signbit:
2386 //   * signbit(cnst) -> cnst'
2387 //   * signbit(nncst) -> 0 (if pstv is a non-negative constant)
2388 //
2389 // sqrt, sqrtf, sqrtl:
2390 //   * sqrt(expN(x))  -> expN(x*0.5)
2391 //   * sqrt(Nroot(x)) -> pow(x,1/(2*N))
2392 //   * sqrt(pow(x,y)) -> pow(|x|,y*0.5)
2393 //
2394 // trunc, truncf, truncl:
2395 //   * trunc(cnst) -> cnst'
2396 //
2397 //
2398
2399 //===----------------------------------------------------------------------===//
2400 // Fortified Library Call Optimizations
2401 //===----------------------------------------------------------------------===//
2402
2403 bool FortifiedLibCallSimplifier::isFortifiedCallFoldable(CallInst *CI,
2404                                                          unsigned ObjSizeOp,
2405                                                          unsigned SizeOp,
2406                                                          bool isString) {
2407   if (CI->getArgOperand(ObjSizeOp) == CI->getArgOperand(SizeOp))
2408     return true;
2409   if (ConstantInt *ObjSizeCI =
2410           dyn_cast<ConstantInt>(CI->getArgOperand(ObjSizeOp))) {
2411     if (ObjSizeCI->isAllOnesValue())
2412       return true;
2413     // If the object size wasn't -1 (unknown), bail out if we were asked to.
2414     if (OnlyLowerUnknownSize)
2415       return false;
2416     if (isString) {
2417       uint64_t Len = GetStringLength(CI->getArgOperand(SizeOp));
2418       // If the length is 0 we don't know how long it is and so we can't
2419       // remove the check.
2420       if (Len == 0)
2421         return false;
2422       return ObjSizeCI->getZExtValue() >= Len;
2423     }
2424     if (ConstantInt *SizeCI = dyn_cast<ConstantInt>(CI->getArgOperand(SizeOp)))
2425       return ObjSizeCI->getZExtValue() >= SizeCI->getZExtValue();
2426   }
2427   return false;
2428 }
2429
2430 Value *FortifiedLibCallSimplifier::optimizeMemCpyChk(CallInst *CI,
2431                                                      IRBuilder<> &B) {
2432   Function *Callee = CI->getCalledFunction();
2433
2434   if (!checkStringCopyLibFuncSignature(Callee, LibFunc::memcpy_chk))
2435     return nullptr;
2436
2437   if (isFortifiedCallFoldable(CI, 3, 2, false)) {
2438     B.CreateMemCpy(CI->getArgOperand(0), CI->getArgOperand(1),
2439                    CI->getArgOperand(2), 1);
2440     return CI->getArgOperand(0);
2441   }
2442   return nullptr;
2443 }
2444
2445 Value *FortifiedLibCallSimplifier::optimizeMemMoveChk(CallInst *CI,
2446                                                       IRBuilder<> &B) {
2447   Function *Callee = CI->getCalledFunction();
2448
2449   if (!checkStringCopyLibFuncSignature(Callee, LibFunc::memmove_chk))
2450     return nullptr;
2451
2452   if (isFortifiedCallFoldable(CI, 3, 2, false)) {
2453     B.CreateMemMove(CI->getArgOperand(0), CI->getArgOperand(1),
2454                     CI->getArgOperand(2), 1);
2455     return CI->getArgOperand(0);
2456   }
2457   return nullptr;
2458 }
2459
2460 Value *FortifiedLibCallSimplifier::optimizeMemSetChk(CallInst *CI,
2461                                                      IRBuilder<> &B) {
2462   Function *Callee = CI->getCalledFunction();
2463
2464   if (!checkStringCopyLibFuncSignature(Callee, LibFunc::memset_chk))
2465     return nullptr;
2466
2467   if (isFortifiedCallFoldable(CI, 3, 2, false)) {
2468     Value *Val = B.CreateIntCast(CI->getArgOperand(1), B.getInt8Ty(), false);
2469     B.CreateMemSet(CI->getArgOperand(0), Val, CI->getArgOperand(2), 1);
2470     return CI->getArgOperand(0);
2471   }
2472   return nullptr;
2473 }
2474
2475 Value *FortifiedLibCallSimplifier::optimizeStrpCpyChk(CallInst *CI,
2476                                                       IRBuilder<> &B,
2477                                                       LibFunc::Func Func) {
2478   Function *Callee = CI->getCalledFunction();
2479   StringRef Name = Callee->getName();
2480   const DataLayout &DL = CI->getModule()->getDataLayout();
2481
2482   if (!checkStringCopyLibFuncSignature(Callee, Func))
2483     return nullptr;
2484
2485   Value *Dst = CI->getArgOperand(0), *Src = CI->getArgOperand(1),
2486         *ObjSize = CI->getArgOperand(2);
2487
2488   // __stpcpy_chk(x,x,...)  -> x+strlen(x)
2489   if (Func == LibFunc::stpcpy_chk && !OnlyLowerUnknownSize && Dst == Src) {
2490     Value *StrLen = EmitStrLen(Src, B, DL, TLI);
2491     return StrLen ? B.CreateInBoundsGEP(B.getInt8Ty(), Dst, StrLen) : nullptr;
2492   }
2493
2494   // If a) we don't have any length information, or b) we know this will
2495   // fit then just lower to a plain st[rp]cpy. Otherwise we'll keep our
2496   // st[rp]cpy_chk call which may fail at runtime if the size is too long.
2497   // TODO: It might be nice to get a maximum length out of the possible
2498   // string lengths for varying.
2499   if (isFortifiedCallFoldable(CI, 2, 1, true))
2500     return EmitStrCpy(Dst, Src, B, TLI, Name.substr(2, 6));
2501
2502   if (OnlyLowerUnknownSize)
2503     return nullptr;
2504
2505   // Maybe we can stil fold __st[rp]cpy_chk to __memcpy_chk.
2506   uint64_t Len = GetStringLength(Src);
2507   if (Len == 0)
2508     return nullptr;
2509
2510   Type *SizeTTy = DL.getIntPtrType(CI->getContext());
2511   Value *LenV = ConstantInt::get(SizeTTy, Len);
2512   Value *Ret = EmitMemCpyChk(Dst, Src, LenV, ObjSize, B, DL, TLI);
2513   // If the function was an __stpcpy_chk, and we were able to fold it into
2514   // a __memcpy_chk, we still need to return the correct end pointer.
2515   if (Ret && Func == LibFunc::stpcpy_chk)
2516     return B.CreateGEP(B.getInt8Ty(), Dst, ConstantInt::get(SizeTTy, Len - 1));
2517   return Ret;
2518 }
2519
2520 Value *FortifiedLibCallSimplifier::optimizeStrpNCpyChk(CallInst *CI,
2521                                                        IRBuilder<> &B,
2522                                                        LibFunc::Func Func) {
2523   Function *Callee = CI->getCalledFunction();
2524   StringRef Name = Callee->getName();
2525
2526   if (!checkStringCopyLibFuncSignature(Callee, Func))
2527     return nullptr;
2528   if (isFortifiedCallFoldable(CI, 3, 2, false)) {
2529     Value *Ret = EmitStrNCpy(CI->getArgOperand(0), CI->getArgOperand(1),
2530                              CI->getArgOperand(2), B, TLI, Name.substr(2, 7));
2531     return Ret;
2532   }
2533   return nullptr;
2534 }
2535
2536 Value *FortifiedLibCallSimplifier::optimizeCall(CallInst *CI) {
2537   // FIXME: We shouldn't be changing "nobuiltin" or TLI unavailable calls here.
2538   // Some clang users checked for _chk libcall availability using:
2539   //   __has_builtin(__builtin___memcpy_chk)
2540   // When compiling with -fno-builtin, this is always true.
2541   // When passing -ffreestanding/-mkernel, which both imply -fno-builtin, we
2542   // end up with fortified libcalls, which isn't acceptable in a freestanding
2543   // environment which only provides their non-fortified counterparts.
2544   //
2545   // Until we change clang and/or teach external users to check for availability
2546   // differently, disregard the "nobuiltin" attribute and TLI::has.
2547   //
2548   // PR23093.
2549
2550   LibFunc::Func Func;
2551   Function *Callee = CI->getCalledFunction();
2552   StringRef FuncName = Callee->getName();
2553
2554   SmallVector<OperandBundleDef, 2> OpBundles;
2555   CI->getOperandBundlesAsDefs(OpBundles);
2556   IRBuilder<> Builder(CI, /*FPMathTag=*/nullptr, OpBundles);
2557   bool isCallingConvC = CI->getCallingConv() == llvm::CallingConv::C;
2558
2559   // First, check that this is a known library functions.
2560   if (!TLI->getLibFunc(FuncName, Func))
2561     return nullptr;
2562
2563   // We never change the calling convention.
2564   if (!ignoreCallingConv(Func) && !isCallingConvC)
2565     return nullptr;
2566
2567   switch (Func) {
2568   case LibFunc::memcpy_chk:
2569     return optimizeMemCpyChk(CI, Builder);
2570   case LibFunc::memmove_chk:
2571     return optimizeMemMoveChk(CI, Builder);
2572   case LibFunc::memset_chk:
2573     return optimizeMemSetChk(CI, Builder);
2574   case LibFunc::stpcpy_chk:
2575   case LibFunc::strcpy_chk:
2576     return optimizeStrpCpyChk(CI, Builder, Func);
2577   case LibFunc::stpncpy_chk:
2578   case LibFunc::strncpy_chk:
2579     return optimizeStrpNCpyChk(CI, Builder, Func);
2580   default:
2581     break;
2582   }
2583   return nullptr;
2584 }
2585
2586 FortifiedLibCallSimplifier::FortifiedLibCallSimplifier(
2587     const TargetLibraryInfo *TLI, bool OnlyLowerUnknownSize)
2588     : TLI(TLI), OnlyLowerUnknownSize(OnlyLowerUnknownSize) {}