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
1401   if (!CI->hasUnsafeAlgebra())
1402     return Ret;
1403
1404   Instruction *I = dyn_cast<Instruction>(CI->getArgOperand(0));
1405   if (!I || I->getOpcode() != Instruction::FMul || !I->hasUnsafeAlgebra())
1406     return Ret;
1407
1408   // We're looking for a repeated factor in a multiplication tree,
1409   // so we can do this fold: sqrt(x * x) -> fabs(x);
1410   // or this fold: sqrt((x * x) * y) -> fabs(x) * sqrt(y).
1411   Value *Op0 = I->getOperand(0);
1412   Value *Op1 = I->getOperand(1);
1413   Value *RepeatOp = nullptr;
1414   Value *OtherOp = nullptr;
1415   if (Op0 == Op1) {
1416     // Simple match: the operands of the multiply are identical.
1417     RepeatOp = Op0;
1418   } else {
1419     // Look for a more complicated pattern: one of the operands is itself
1420     // a multiply, so search for a common factor in that multiply.
1421     // Note: We don't bother looking any deeper than this first level or for
1422     // variations of this pattern because instcombine's visitFMUL and/or the
1423     // reassociation pass should give us this form.
1424     Value *OtherMul0, *OtherMul1;
1425     if (match(Op0, m_FMul(m_Value(OtherMul0), m_Value(OtherMul1)))) {
1426       // Pattern: sqrt((x * y) * z)
1427       if (OtherMul0 == OtherMul1 &&
1428           cast<Instruction>(Op0)->hasUnsafeAlgebra()) {
1429         // Matched: sqrt((x * x) * z)
1430         RepeatOp = OtherMul0;
1431         OtherOp = Op1;
1432       }
1433     }
1434   }
1435   if (!RepeatOp)
1436     return Ret;
1437
1438   // Fast math flags for any created instructions should match the sqrt
1439   // and multiply.
1440   IRBuilder<>::FastMathFlagGuard Guard(B);
1441   B.SetFastMathFlags(I->getFastMathFlags());
1442
1443   // If we found a repeated factor, hoist it out of the square root and
1444   // replace it with the fabs of that factor.
1445   Module *M = Callee->getParent();
1446   Type *ArgType = I->getType();
1447   Value *Fabs = Intrinsic::getDeclaration(M, Intrinsic::fabs, ArgType);
1448   Value *FabsCall = B.CreateCall(Fabs, RepeatOp, "fabs");
1449   if (OtherOp) {
1450     // If we found a non-repeated factor, we still need to get its square
1451     // root. We then multiply that by the value that was simplified out
1452     // of the square root calculation.
1453     Value *Sqrt = Intrinsic::getDeclaration(M, Intrinsic::sqrt, ArgType);
1454     Value *SqrtCall = B.CreateCall(Sqrt, OtherOp, "sqrt");
1455     return B.CreateFMul(FabsCall, SqrtCall);
1456   }
1457   return FabsCall;
1458 }
1459
1460 // TODO: Generalize to handle any trig function and its inverse.
1461 Value *LibCallSimplifier::optimizeTan(CallInst *CI, IRBuilder<> &B) {
1462   Function *Callee = CI->getCalledFunction();
1463   Value *Ret = nullptr;
1464   StringRef Name = Callee->getName();
1465   if (UnsafeFPShrink && Name == "tan" && hasFloatVersion(Name))
1466     Ret = optimizeUnaryDoubleFP(CI, B, true);
1467   FunctionType *FT = Callee->getFunctionType();
1468
1469   // Just make sure this has 1 argument of FP type, which matches the
1470   // result type.
1471   if (FT->getNumParams() != 1 || FT->getReturnType() != FT->getParamType(0) ||
1472       !FT->getParamType(0)->isFloatingPointTy())
1473     return Ret;
1474
1475   Value *Op1 = CI->getArgOperand(0);
1476   auto *OpC = dyn_cast<CallInst>(Op1);
1477   if (!OpC)
1478     return Ret;
1479
1480   // Both calls must allow unsafe optimizations in order to remove them.
1481   if (!CI->hasUnsafeAlgebra() || !OpC->hasUnsafeAlgebra())
1482     return Ret;
1483
1484   // tan(atan(x)) -> x
1485   // tanf(atanf(x)) -> x
1486   // tanl(atanl(x)) -> x
1487   LibFunc::Func Func;
1488   Function *F = OpC->getCalledFunction();
1489   if (F && TLI->getLibFunc(F->getName(), Func) && TLI->has(Func) &&
1490       ((Func == LibFunc::atan && Callee->getName() == "tan") ||
1491        (Func == LibFunc::atanf && Callee->getName() == "tanf") ||
1492        (Func == LibFunc::atanl && Callee->getName() == "tanl")))
1493     Ret = OpC->getArgOperand(0);
1494   return Ret;
1495 }
1496
1497 static bool isTrigLibCall(CallInst *CI);
1498 static void insertSinCosCall(IRBuilder<> &B, Function *OrigCallee, Value *Arg,
1499                              bool UseFloat, Value *&Sin, Value *&Cos,
1500                              Value *&SinCos);
1501
1502 Value *LibCallSimplifier::optimizeSinCosPi(CallInst *CI, IRBuilder<> &B) {
1503
1504   // Make sure the prototype is as expected, otherwise the rest of the
1505   // function is probably invalid and likely to abort.
1506   if (!isTrigLibCall(CI))
1507     return nullptr;
1508
1509   Value *Arg = CI->getArgOperand(0);
1510   SmallVector<CallInst *, 1> SinCalls;
1511   SmallVector<CallInst *, 1> CosCalls;
1512   SmallVector<CallInst *, 1> SinCosCalls;
1513
1514   bool IsFloat = Arg->getType()->isFloatTy();
1515
1516   // Look for all compatible sinpi, cospi and sincospi calls with the same
1517   // argument. If there are enough (in some sense) we can make the
1518   // substitution.
1519   for (User *U : Arg->users())
1520     classifyArgUse(U, CI->getParent(), IsFloat, SinCalls, CosCalls,
1521                    SinCosCalls);
1522
1523   // It's only worthwhile if both sinpi and cospi are actually used.
1524   if (SinCosCalls.empty() && (SinCalls.empty() || CosCalls.empty()))
1525     return nullptr;
1526
1527   Value *Sin, *Cos, *SinCos;
1528   insertSinCosCall(B, CI->getCalledFunction(), Arg, IsFloat, Sin, Cos, SinCos);
1529
1530   replaceTrigInsts(SinCalls, Sin);
1531   replaceTrigInsts(CosCalls, Cos);
1532   replaceTrigInsts(SinCosCalls, SinCos);
1533
1534   return nullptr;
1535 }
1536
1537 static bool isTrigLibCall(CallInst *CI) {
1538   Function *Callee = CI->getCalledFunction();
1539   FunctionType *FT = Callee->getFunctionType();
1540
1541   // We can only hope to do anything useful if we can ignore things like errno
1542   // and floating-point exceptions.
1543   bool AttributesSafe =
1544       CI->hasFnAttr(Attribute::NoUnwind) && CI->hasFnAttr(Attribute::ReadNone);
1545
1546   // Other than that we need float(float) or double(double)
1547   return AttributesSafe && FT->getNumParams() == 1 &&
1548          FT->getReturnType() == FT->getParamType(0) &&
1549          (FT->getParamType(0)->isFloatTy() ||
1550           FT->getParamType(0)->isDoubleTy());
1551 }
1552
1553 void
1554 LibCallSimplifier::classifyArgUse(Value *Val, BasicBlock *BB, bool IsFloat,
1555                                   SmallVectorImpl<CallInst *> &SinCalls,
1556                                   SmallVectorImpl<CallInst *> &CosCalls,
1557                                   SmallVectorImpl<CallInst *> &SinCosCalls) {
1558   CallInst *CI = dyn_cast<CallInst>(Val);
1559
1560   if (!CI)
1561     return;
1562
1563   Function *Callee = CI->getCalledFunction();
1564   LibFunc::Func Func;
1565   if (!Callee || !TLI->getLibFunc(Callee->getName(), Func) || !TLI->has(Func) ||
1566       !isTrigLibCall(CI))
1567     return;
1568
1569   if (IsFloat) {
1570     if (Func == LibFunc::sinpif)
1571       SinCalls.push_back(CI);
1572     else if (Func == LibFunc::cospif)
1573       CosCalls.push_back(CI);
1574     else if (Func == LibFunc::sincospif_stret)
1575       SinCosCalls.push_back(CI);
1576   } else {
1577     if (Func == LibFunc::sinpi)
1578       SinCalls.push_back(CI);
1579     else if (Func == LibFunc::cospi)
1580       CosCalls.push_back(CI);
1581     else if (Func == LibFunc::sincospi_stret)
1582       SinCosCalls.push_back(CI);
1583   }
1584 }
1585
1586 void LibCallSimplifier::replaceTrigInsts(SmallVectorImpl<CallInst *> &Calls,
1587                                          Value *Res) {
1588   for (CallInst *C : Calls)
1589     replaceAllUsesWith(C, Res);
1590 }
1591
1592 void insertSinCosCall(IRBuilder<> &B, Function *OrigCallee, Value *Arg,
1593                       bool UseFloat, Value *&Sin, Value *&Cos, Value *&SinCos) {
1594   Type *ArgTy = Arg->getType();
1595   Type *ResTy;
1596   StringRef Name;
1597
1598   Triple T(OrigCallee->getParent()->getTargetTriple());
1599   if (UseFloat) {
1600     Name = "__sincospif_stret";
1601
1602     assert(T.getArch() != Triple::x86 && "x86 messy and unsupported for now");
1603     // x86_64 can't use {float, float} since that would be returned in both
1604     // xmm0 and xmm1, which isn't what a real struct would do.
1605     ResTy = T.getArch() == Triple::x86_64
1606                 ? static_cast<Type *>(VectorType::get(ArgTy, 2))
1607                 : static_cast<Type *>(StructType::get(ArgTy, ArgTy, nullptr));
1608   } else {
1609     Name = "__sincospi_stret";
1610     ResTy = StructType::get(ArgTy, ArgTy, nullptr);
1611   }
1612
1613   Module *M = OrigCallee->getParent();
1614   Value *Callee = M->getOrInsertFunction(Name, OrigCallee->getAttributes(),
1615                                          ResTy, ArgTy, nullptr);
1616
1617   if (Instruction *ArgInst = dyn_cast<Instruction>(Arg)) {
1618     // If the argument is an instruction, it must dominate all uses so put our
1619     // sincos call there.
1620     B.SetInsertPoint(ArgInst->getParent(), ++ArgInst->getIterator());
1621   } else {
1622     // Otherwise (e.g. for a constant) the beginning of the function is as
1623     // good a place as any.
1624     BasicBlock &EntryBB = B.GetInsertBlock()->getParent()->getEntryBlock();
1625     B.SetInsertPoint(&EntryBB, EntryBB.begin());
1626   }
1627
1628   SinCos = B.CreateCall(Callee, Arg, "sincospi");
1629
1630   if (SinCos->getType()->isStructTy()) {
1631     Sin = B.CreateExtractValue(SinCos, 0, "sinpi");
1632     Cos = B.CreateExtractValue(SinCos, 1, "cospi");
1633   } else {
1634     Sin = B.CreateExtractElement(SinCos, ConstantInt::get(B.getInt32Ty(), 0),
1635                                  "sinpi");
1636     Cos = B.CreateExtractElement(SinCos, ConstantInt::get(B.getInt32Ty(), 1),
1637                                  "cospi");
1638   }
1639 }
1640
1641 //===----------------------------------------------------------------------===//
1642 // Integer Library Call Optimizations
1643 //===----------------------------------------------------------------------===//
1644
1645 static bool checkIntUnaryReturnAndParam(Function *Callee) {
1646   FunctionType *FT = Callee->getFunctionType();
1647   return FT->getNumParams() == 1 && FT->getReturnType()->isIntegerTy(32) &&
1648     FT->getParamType(0)->isIntegerTy();
1649 }
1650
1651 Value *LibCallSimplifier::optimizeFFS(CallInst *CI, IRBuilder<> &B) {
1652   Function *Callee = CI->getCalledFunction();
1653   if (!checkIntUnaryReturnAndParam(Callee))
1654     return nullptr;
1655   Value *Op = CI->getArgOperand(0);
1656
1657   // Constant fold.
1658   if (ConstantInt *CI = dyn_cast<ConstantInt>(Op)) {
1659     if (CI->isZero()) // ffs(0) -> 0.
1660       return B.getInt32(0);
1661     // ffs(c) -> cttz(c)+1
1662     return B.getInt32(CI->getValue().countTrailingZeros() + 1);
1663   }
1664
1665   // ffs(x) -> x != 0 ? (i32)llvm.cttz(x)+1 : 0
1666   Type *ArgType = Op->getType();
1667   Value *F =
1668       Intrinsic::getDeclaration(Callee->getParent(), Intrinsic::cttz, ArgType);
1669   Value *V = B.CreateCall(F, {Op, B.getTrue()}, "cttz");
1670   V = B.CreateAdd(V, ConstantInt::get(V->getType(), 1));
1671   V = B.CreateIntCast(V, B.getInt32Ty(), false);
1672
1673   Value *Cond = B.CreateICmpNE(Op, Constant::getNullValue(ArgType));
1674   return B.CreateSelect(Cond, V, B.getInt32(0));
1675 }
1676
1677 Value *LibCallSimplifier::optimizeAbs(CallInst *CI, IRBuilder<> &B) {
1678   Function *Callee = CI->getCalledFunction();
1679   FunctionType *FT = Callee->getFunctionType();
1680   // We require integer(integer) where the types agree.
1681   if (FT->getNumParams() != 1 || !FT->getReturnType()->isIntegerTy() ||
1682       FT->getParamType(0) != FT->getReturnType())
1683     return nullptr;
1684
1685   // abs(x) -> x >s -1 ? x : -x
1686   Value *Op = CI->getArgOperand(0);
1687   Value *Pos =
1688       B.CreateICmpSGT(Op, Constant::getAllOnesValue(Op->getType()), "ispos");
1689   Value *Neg = B.CreateNeg(Op, "neg");
1690   return B.CreateSelect(Pos, Op, Neg);
1691 }
1692
1693 Value *LibCallSimplifier::optimizeIsDigit(CallInst *CI, IRBuilder<> &B) {
1694   if (!checkIntUnaryReturnAndParam(CI->getCalledFunction()))
1695     return nullptr;
1696
1697   // isdigit(c) -> (c-'0') <u 10
1698   Value *Op = CI->getArgOperand(0);
1699   Op = B.CreateSub(Op, B.getInt32('0'), "isdigittmp");
1700   Op = B.CreateICmpULT(Op, B.getInt32(10), "isdigit");
1701   return B.CreateZExt(Op, CI->getType());
1702 }
1703
1704 Value *LibCallSimplifier::optimizeIsAscii(CallInst *CI, IRBuilder<> &B) {
1705   if (!checkIntUnaryReturnAndParam(CI->getCalledFunction()))
1706     return nullptr;
1707
1708   // isascii(c) -> c <u 128
1709   Value *Op = CI->getArgOperand(0);
1710   Op = B.CreateICmpULT(Op, B.getInt32(128), "isascii");
1711   return B.CreateZExt(Op, CI->getType());
1712 }
1713
1714 Value *LibCallSimplifier::optimizeToAscii(CallInst *CI, IRBuilder<> &B) {
1715   if (!checkIntUnaryReturnAndParam(CI->getCalledFunction()))
1716     return nullptr;
1717
1718   // toascii(c) -> c & 0x7f
1719   return B.CreateAnd(CI->getArgOperand(0),
1720                      ConstantInt::get(CI->getType(), 0x7F));
1721 }
1722
1723 //===----------------------------------------------------------------------===//
1724 // Formatting and IO Library Call Optimizations
1725 //===----------------------------------------------------------------------===//
1726
1727 static bool isReportingError(Function *Callee, CallInst *CI, int StreamArg);
1728
1729 Value *LibCallSimplifier::optimizeErrorReporting(CallInst *CI, IRBuilder<> &B,
1730                                                  int StreamArg) {
1731   // Error reporting calls should be cold, mark them as such.
1732   // This applies even to non-builtin calls: it is only a hint and applies to
1733   // functions that the frontend might not understand as builtins.
1734
1735   // This heuristic was suggested in:
1736   // Improving Static Branch Prediction in a Compiler
1737   // Brian L. Deitrich, Ben-Chung Cheng, Wen-mei W. Hwu
1738   // Proceedings of PACT'98, Oct. 1998, IEEE
1739   Function *Callee = CI->getCalledFunction();
1740
1741   if (!CI->hasFnAttr(Attribute::Cold) &&
1742       isReportingError(Callee, CI, StreamArg)) {
1743     CI->addAttribute(AttributeSet::FunctionIndex, Attribute::Cold);
1744   }
1745
1746   return nullptr;
1747 }
1748
1749 static bool isReportingError(Function *Callee, CallInst *CI, int StreamArg) {
1750   if (!ColdErrorCalls || !Callee || !Callee->isDeclaration())
1751     return false;
1752
1753   if (StreamArg < 0)
1754     return true;
1755
1756   // These functions might be considered cold, but only if their stream
1757   // argument is stderr.
1758
1759   if (StreamArg >= (int)CI->getNumArgOperands())
1760     return false;
1761   LoadInst *LI = dyn_cast<LoadInst>(CI->getArgOperand(StreamArg));
1762   if (!LI)
1763     return false;
1764   GlobalVariable *GV = dyn_cast<GlobalVariable>(LI->getPointerOperand());
1765   if (!GV || !GV->isDeclaration())
1766     return false;
1767   return GV->getName() == "stderr";
1768 }
1769
1770 Value *LibCallSimplifier::optimizePrintFString(CallInst *CI, IRBuilder<> &B) {
1771   // Check for a fixed format string.
1772   StringRef FormatStr;
1773   if (!getConstantStringInfo(CI->getArgOperand(0), FormatStr))
1774     return nullptr;
1775
1776   // Empty format string -> noop.
1777   if (FormatStr.empty()) // Tolerate printf's declared void.
1778     return CI->use_empty() ? (Value *)CI : ConstantInt::get(CI->getType(), 0);
1779
1780   // Do not do any of the following transformations if the printf return value
1781   // is used, in general the printf return value is not compatible with either
1782   // putchar() or puts().
1783   if (!CI->use_empty())
1784     return nullptr;
1785
1786   // printf("x") -> putchar('x'), even for '%'.
1787   if (FormatStr.size() == 1) {
1788     Value *Res = EmitPutChar(B.getInt32(FormatStr[0]), B, TLI);
1789     if (CI->use_empty() || !Res)
1790       return Res;
1791     return B.CreateIntCast(Res, CI->getType(), true);
1792   }
1793
1794   // printf("foo\n") --> puts("foo")
1795   if (FormatStr[FormatStr.size() - 1] == '\n' &&
1796       FormatStr.find('%') == StringRef::npos) { // No format characters.
1797     // Create a string literal with no \n on it.  We expect the constant merge
1798     // pass to be run after this pass, to merge duplicate strings.
1799     FormatStr = FormatStr.drop_back();
1800     Value *GV = B.CreateGlobalString(FormatStr, "str");
1801     Value *NewCI = EmitPutS(GV, B, TLI);
1802     return (CI->use_empty() || !NewCI)
1803                ? NewCI
1804                : ConstantInt::get(CI->getType(), FormatStr.size() + 1);
1805   }
1806
1807   // Optimize specific format strings.
1808   // printf("%c", chr) --> putchar(chr)
1809   if (FormatStr == "%c" && CI->getNumArgOperands() > 1 &&
1810       CI->getArgOperand(1)->getType()->isIntegerTy()) {
1811     Value *Res = EmitPutChar(CI->getArgOperand(1), B, TLI);
1812
1813     if (CI->use_empty() || !Res)
1814       return Res;
1815     return B.CreateIntCast(Res, CI->getType(), true);
1816   }
1817
1818   // printf("%s\n", str) --> puts(str)
1819   if (FormatStr == "%s\n" && CI->getNumArgOperands() > 1 &&
1820       CI->getArgOperand(1)->getType()->isPointerTy()) {
1821     return EmitPutS(CI->getArgOperand(1), B, TLI);
1822   }
1823   return nullptr;
1824 }
1825
1826 Value *LibCallSimplifier::optimizePrintF(CallInst *CI, IRBuilder<> &B) {
1827
1828   Function *Callee = CI->getCalledFunction();
1829   // Require one fixed pointer argument and an integer/void result.
1830   FunctionType *FT = Callee->getFunctionType();
1831   if (FT->getNumParams() < 1 || !FT->getParamType(0)->isPointerTy() ||
1832       !(FT->getReturnType()->isIntegerTy() || FT->getReturnType()->isVoidTy()))
1833     return nullptr;
1834
1835   if (Value *V = optimizePrintFString(CI, B)) {
1836     return V;
1837   }
1838
1839   // printf(format, ...) -> iprintf(format, ...) if no floating point
1840   // arguments.
1841   if (TLI->has(LibFunc::iprintf) && !callHasFloatingPointArgument(CI)) {
1842     Module *M = B.GetInsertBlock()->getParent()->getParent();
1843     Constant *IPrintFFn =
1844         M->getOrInsertFunction("iprintf", FT, Callee->getAttributes());
1845     CallInst *New = cast<CallInst>(CI->clone());
1846     New->setCalledFunction(IPrintFFn);
1847     B.Insert(New);
1848     return New;
1849   }
1850   return nullptr;
1851 }
1852
1853 Value *LibCallSimplifier::optimizeSPrintFString(CallInst *CI, IRBuilder<> &B) {
1854   // Check for a fixed format string.
1855   StringRef FormatStr;
1856   if (!getConstantStringInfo(CI->getArgOperand(1), FormatStr))
1857     return nullptr;
1858
1859   // If we just have a format string (nothing else crazy) transform it.
1860   if (CI->getNumArgOperands() == 2) {
1861     // Make sure there's no % in the constant array.  We could try to handle
1862     // %% -> % in the future if we cared.
1863     for (unsigned i = 0, e = FormatStr.size(); i != e; ++i)
1864       if (FormatStr[i] == '%')
1865         return nullptr; // we found a format specifier, bail out.
1866
1867     // sprintf(str, fmt) -> llvm.memcpy(str, fmt, strlen(fmt)+1, 1)
1868     B.CreateMemCpy(CI->getArgOperand(0), CI->getArgOperand(1),
1869                    ConstantInt::get(DL.getIntPtrType(CI->getContext()),
1870                                     FormatStr.size() + 1),
1871                    1); // Copy the null byte.
1872     return ConstantInt::get(CI->getType(), FormatStr.size());
1873   }
1874
1875   // The remaining optimizations require the format string to be "%s" or "%c"
1876   // and have an extra operand.
1877   if (FormatStr.size() != 2 || FormatStr[0] != '%' ||
1878       CI->getNumArgOperands() < 3)
1879     return nullptr;
1880
1881   // Decode the second character of the format string.
1882   if (FormatStr[1] == 'c') {
1883     // sprintf(dst, "%c", chr) --> *(i8*)dst = chr; *((i8*)dst+1) = 0
1884     if (!CI->getArgOperand(2)->getType()->isIntegerTy())
1885       return nullptr;
1886     Value *V = B.CreateTrunc(CI->getArgOperand(2), B.getInt8Ty(), "char");
1887     Value *Ptr = CastToCStr(CI->getArgOperand(0), B);
1888     B.CreateStore(V, Ptr);
1889     Ptr = B.CreateGEP(B.getInt8Ty(), Ptr, B.getInt32(1), "nul");
1890     B.CreateStore(B.getInt8(0), Ptr);
1891
1892     return ConstantInt::get(CI->getType(), 1);
1893   }
1894
1895   if (FormatStr[1] == 's') {
1896     // sprintf(dest, "%s", str) -> llvm.memcpy(dest, str, strlen(str)+1, 1)
1897     if (!CI->getArgOperand(2)->getType()->isPointerTy())
1898       return nullptr;
1899
1900     Value *Len = EmitStrLen(CI->getArgOperand(2), B, DL, TLI);
1901     if (!Len)
1902       return nullptr;
1903     Value *IncLen =
1904         B.CreateAdd(Len, ConstantInt::get(Len->getType(), 1), "leninc");
1905     B.CreateMemCpy(CI->getArgOperand(0), CI->getArgOperand(2), IncLen, 1);
1906
1907     // The sprintf result is the unincremented number of bytes in the string.
1908     return B.CreateIntCast(Len, CI->getType(), false);
1909   }
1910   return nullptr;
1911 }
1912
1913 Value *LibCallSimplifier::optimizeSPrintF(CallInst *CI, IRBuilder<> &B) {
1914   Function *Callee = CI->getCalledFunction();
1915   // Require two fixed pointer arguments and an integer result.
1916   FunctionType *FT = Callee->getFunctionType();
1917   if (FT->getNumParams() != 2 || !FT->getParamType(0)->isPointerTy() ||
1918       !FT->getParamType(1)->isPointerTy() ||
1919       !FT->getReturnType()->isIntegerTy())
1920     return nullptr;
1921
1922   if (Value *V = optimizeSPrintFString(CI, B)) {
1923     return V;
1924   }
1925
1926   // sprintf(str, format, ...) -> siprintf(str, format, ...) if no floating
1927   // point arguments.
1928   if (TLI->has(LibFunc::siprintf) && !callHasFloatingPointArgument(CI)) {
1929     Module *M = B.GetInsertBlock()->getParent()->getParent();
1930     Constant *SIPrintFFn =
1931         M->getOrInsertFunction("siprintf", FT, Callee->getAttributes());
1932     CallInst *New = cast<CallInst>(CI->clone());
1933     New->setCalledFunction(SIPrintFFn);
1934     B.Insert(New);
1935     return New;
1936   }
1937   return nullptr;
1938 }
1939
1940 Value *LibCallSimplifier::optimizeFPrintFString(CallInst *CI, IRBuilder<> &B) {
1941   optimizeErrorReporting(CI, B, 0);
1942
1943   // All the optimizations depend on the format string.
1944   StringRef FormatStr;
1945   if (!getConstantStringInfo(CI->getArgOperand(1), FormatStr))
1946     return nullptr;
1947
1948   // Do not do any of the following transformations if the fprintf return
1949   // value is used, in general the fprintf return value is not compatible
1950   // with fwrite(), fputc() or fputs().
1951   if (!CI->use_empty())
1952     return nullptr;
1953
1954   // fprintf(F, "foo") --> fwrite("foo", 3, 1, F)
1955   if (CI->getNumArgOperands() == 2) {
1956     for (unsigned i = 0, e = FormatStr.size(); i != e; ++i)
1957       if (FormatStr[i] == '%') // Could handle %% -> % if we cared.
1958         return nullptr;        // We found a format specifier.
1959
1960     return EmitFWrite(
1961         CI->getArgOperand(1),
1962         ConstantInt::get(DL.getIntPtrType(CI->getContext()), FormatStr.size()),
1963         CI->getArgOperand(0), B, DL, TLI);
1964   }
1965
1966   // The remaining optimizations require the format string to be "%s" or "%c"
1967   // and have an extra operand.
1968   if (FormatStr.size() != 2 || FormatStr[0] != '%' ||
1969       CI->getNumArgOperands() < 3)
1970     return nullptr;
1971
1972   // Decode the second character of the format string.
1973   if (FormatStr[1] == 'c') {
1974     // fprintf(F, "%c", chr) --> fputc(chr, F)
1975     if (!CI->getArgOperand(2)->getType()->isIntegerTy())
1976       return nullptr;
1977     return EmitFPutC(CI->getArgOperand(2), CI->getArgOperand(0), B, TLI);
1978   }
1979
1980   if (FormatStr[1] == 's') {
1981     // fprintf(F, "%s", str) --> fputs(str, F)
1982     if (!CI->getArgOperand(2)->getType()->isPointerTy())
1983       return nullptr;
1984     return EmitFPutS(CI->getArgOperand(2), CI->getArgOperand(0), B, TLI);
1985   }
1986   return nullptr;
1987 }
1988
1989 Value *LibCallSimplifier::optimizeFPrintF(CallInst *CI, IRBuilder<> &B) {
1990   Function *Callee = CI->getCalledFunction();
1991   // Require two fixed paramters as pointers and integer result.
1992   FunctionType *FT = Callee->getFunctionType();
1993   if (FT->getNumParams() != 2 || !FT->getParamType(0)->isPointerTy() ||
1994       !FT->getParamType(1)->isPointerTy() ||
1995       !FT->getReturnType()->isIntegerTy())
1996     return nullptr;
1997
1998   if (Value *V = optimizeFPrintFString(CI, B)) {
1999     return V;
2000   }
2001
2002   // fprintf(stream, format, ...) -> fiprintf(stream, format, ...) if no
2003   // floating point arguments.
2004   if (TLI->has(LibFunc::fiprintf) && !callHasFloatingPointArgument(CI)) {
2005     Module *M = B.GetInsertBlock()->getParent()->getParent();
2006     Constant *FIPrintFFn =
2007         M->getOrInsertFunction("fiprintf", FT, Callee->getAttributes());
2008     CallInst *New = cast<CallInst>(CI->clone());
2009     New->setCalledFunction(FIPrintFFn);
2010     B.Insert(New);
2011     return New;
2012   }
2013   return nullptr;
2014 }
2015
2016 Value *LibCallSimplifier::optimizeFWrite(CallInst *CI, IRBuilder<> &B) {
2017   optimizeErrorReporting(CI, B, 3);
2018
2019   Function *Callee = CI->getCalledFunction();
2020   // Require a pointer, an integer, an integer, a pointer, returning integer.
2021   FunctionType *FT = Callee->getFunctionType();
2022   if (FT->getNumParams() != 4 || !FT->getParamType(0)->isPointerTy() ||
2023       !FT->getParamType(1)->isIntegerTy() ||
2024       !FT->getParamType(2)->isIntegerTy() ||
2025       !FT->getParamType(3)->isPointerTy() ||
2026       !FT->getReturnType()->isIntegerTy())
2027     return nullptr;
2028
2029   // Get the element size and count.
2030   ConstantInt *SizeC = dyn_cast<ConstantInt>(CI->getArgOperand(1));
2031   ConstantInt *CountC = dyn_cast<ConstantInt>(CI->getArgOperand(2));
2032   if (!SizeC || !CountC)
2033     return nullptr;
2034   uint64_t Bytes = SizeC->getZExtValue() * CountC->getZExtValue();
2035
2036   // If this is writing zero records, remove the call (it's a noop).
2037   if (Bytes == 0)
2038     return ConstantInt::get(CI->getType(), 0);
2039
2040   // If this is writing one byte, turn it into fputc.
2041   // This optimisation is only valid, if the return value is unused.
2042   if (Bytes == 1 && CI->use_empty()) { // fwrite(S,1,1,F) -> fputc(S[0],F)
2043     Value *Char = B.CreateLoad(CastToCStr(CI->getArgOperand(0), B), "char");
2044     Value *NewCI = EmitFPutC(Char, CI->getArgOperand(3), B, TLI);
2045     return NewCI ? ConstantInt::get(CI->getType(), 1) : nullptr;
2046   }
2047
2048   return nullptr;
2049 }
2050
2051 Value *LibCallSimplifier::optimizeFPuts(CallInst *CI, IRBuilder<> &B) {
2052   optimizeErrorReporting(CI, B, 1);
2053
2054   Function *Callee = CI->getCalledFunction();
2055
2056   // Require two pointers.  Also, we can't optimize if return value is used.
2057   FunctionType *FT = Callee->getFunctionType();
2058   if (FT->getNumParams() != 2 || !FT->getParamType(0)->isPointerTy() ||
2059       !FT->getParamType(1)->isPointerTy() || !CI->use_empty())
2060     return nullptr;
2061
2062   // fputs(s,F) --> fwrite(s,1,strlen(s),F)
2063   uint64_t Len = GetStringLength(CI->getArgOperand(0));
2064   if (!Len)
2065     return nullptr;
2066
2067   // Known to have no uses (see above).
2068   return EmitFWrite(
2069       CI->getArgOperand(0),
2070       ConstantInt::get(DL.getIntPtrType(CI->getContext()), Len - 1),
2071       CI->getArgOperand(1), B, DL, TLI);
2072 }
2073
2074 Value *LibCallSimplifier::optimizePuts(CallInst *CI, IRBuilder<> &B) {
2075   Function *Callee = CI->getCalledFunction();
2076   // Require one fixed pointer argument and an integer/void result.
2077   FunctionType *FT = Callee->getFunctionType();
2078   if (FT->getNumParams() < 1 || !FT->getParamType(0)->isPointerTy() ||
2079       !(FT->getReturnType()->isIntegerTy() || FT->getReturnType()->isVoidTy()))
2080     return nullptr;
2081
2082   // Check for a constant string.
2083   StringRef Str;
2084   if (!getConstantStringInfo(CI->getArgOperand(0), Str))
2085     return nullptr;
2086
2087   if (Str.empty() && CI->use_empty()) {
2088     // puts("") -> putchar('\n')
2089     Value *Res = EmitPutChar(B.getInt32('\n'), B, TLI);
2090     if (CI->use_empty() || !Res)
2091       return Res;
2092     return B.CreateIntCast(Res, CI->getType(), true);
2093   }
2094
2095   return nullptr;
2096 }
2097
2098 bool LibCallSimplifier::hasFloatVersion(StringRef FuncName) {
2099   LibFunc::Func Func;
2100   SmallString<20> FloatFuncName = FuncName;
2101   FloatFuncName += 'f';
2102   if (TLI->getLibFunc(FloatFuncName, Func))
2103     return TLI->has(Func);
2104   return false;
2105 }
2106
2107 Value *LibCallSimplifier::optimizeStringMemoryLibCall(CallInst *CI,
2108                                                       IRBuilder<> &Builder) {
2109   LibFunc::Func Func;
2110   Function *Callee = CI->getCalledFunction();
2111   StringRef FuncName = Callee->getName();
2112
2113   // Check for string/memory library functions.
2114   if (TLI->getLibFunc(FuncName, Func) && TLI->has(Func)) {
2115     // Make sure we never change the calling convention.
2116     assert((ignoreCallingConv(Func) ||
2117             CI->getCallingConv() == llvm::CallingConv::C) &&
2118       "Optimizing string/memory libcall would change the calling convention");
2119     switch (Func) {
2120     case LibFunc::strcat:
2121       return optimizeStrCat(CI, Builder);
2122     case LibFunc::strncat:
2123       return optimizeStrNCat(CI, Builder);
2124     case LibFunc::strchr:
2125       return optimizeStrChr(CI, Builder);
2126     case LibFunc::strrchr:
2127       return optimizeStrRChr(CI, Builder);
2128     case LibFunc::strcmp:
2129       return optimizeStrCmp(CI, Builder);
2130     case LibFunc::strncmp:
2131       return optimizeStrNCmp(CI, Builder);
2132     case LibFunc::strcpy:
2133       return optimizeStrCpy(CI, Builder);
2134     case LibFunc::stpcpy:
2135       return optimizeStpCpy(CI, Builder);
2136     case LibFunc::strncpy:
2137       return optimizeStrNCpy(CI, Builder);
2138     case LibFunc::strlen:
2139       return optimizeStrLen(CI, Builder);
2140     case LibFunc::strpbrk:
2141       return optimizeStrPBrk(CI, Builder);
2142     case LibFunc::strtol:
2143     case LibFunc::strtod:
2144     case LibFunc::strtof:
2145     case LibFunc::strtoul:
2146     case LibFunc::strtoll:
2147     case LibFunc::strtold:
2148     case LibFunc::strtoull:
2149       return optimizeStrTo(CI, Builder);
2150     case LibFunc::strspn:
2151       return optimizeStrSpn(CI, Builder);
2152     case LibFunc::strcspn:
2153       return optimizeStrCSpn(CI, Builder);
2154     case LibFunc::strstr:
2155       return optimizeStrStr(CI, Builder);
2156     case LibFunc::memchr:
2157       return optimizeMemChr(CI, Builder);
2158     case LibFunc::memcmp:
2159       return optimizeMemCmp(CI, Builder);
2160     case LibFunc::memcpy:
2161       return optimizeMemCpy(CI, Builder);
2162     case LibFunc::memmove:
2163       return optimizeMemMove(CI, Builder);
2164     case LibFunc::memset:
2165       return optimizeMemSet(CI, Builder);
2166     default:
2167       break;
2168     }
2169   }
2170   return nullptr;
2171 }
2172
2173 Value *LibCallSimplifier::optimizeCall(CallInst *CI) {
2174   if (CI->isNoBuiltin())
2175     return nullptr;
2176
2177   LibFunc::Func Func;
2178   Function *Callee = CI->getCalledFunction();
2179   StringRef FuncName = Callee->getName();
2180
2181   SmallVector<OperandBundleDef, 2> OpBundles;
2182   CI->getOperandBundlesAsDefs(OpBundles);
2183   IRBuilder<> Builder(CI, /*FPMathTag=*/nullptr, OpBundles);
2184   bool isCallingConvC = CI->getCallingConv() == llvm::CallingConv::C;
2185
2186   // Command-line parameter overrides function attribute.
2187   if (EnableUnsafeFPShrink.getNumOccurrences() > 0)
2188     UnsafeFPShrink = EnableUnsafeFPShrink;
2189   else if (canUseUnsafeFPMath(Callee))
2190     UnsafeFPShrink = true;
2191
2192   // First, check for intrinsics.
2193   if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(CI)) {
2194     if (!isCallingConvC)
2195       return nullptr;
2196     switch (II->getIntrinsicID()) {
2197     case Intrinsic::pow:
2198       return optimizePow(CI, Builder);
2199     case Intrinsic::exp2:
2200       return optimizeExp2(CI, Builder);
2201     case Intrinsic::fabs:
2202       return optimizeFabs(CI, Builder);
2203     case Intrinsic::log:
2204       return optimizeLog(CI, Builder);
2205     case Intrinsic::sqrt:
2206       return optimizeSqrt(CI, Builder);
2207     default:
2208       return nullptr;
2209     }
2210   }
2211
2212   // Also try to simplify calls to fortified library functions.
2213   if (Value *SimplifiedFortifiedCI = FortifiedSimplifier.optimizeCall(CI)) {
2214     // Try to further simplify the result.
2215     CallInst *SimplifiedCI = dyn_cast<CallInst>(SimplifiedFortifiedCI);
2216     if (SimplifiedCI && SimplifiedCI->getCalledFunction()) {
2217       // Use an IR Builder from SimplifiedCI if available instead of CI
2218       // to guarantee we reach all uses we might replace later on.
2219       IRBuilder<> TmpBuilder(SimplifiedCI);
2220       if (Value *V = optimizeStringMemoryLibCall(SimplifiedCI, TmpBuilder)) {
2221         // If we were able to further simplify, remove the now redundant call.
2222         SimplifiedCI->replaceAllUsesWith(V);
2223         SimplifiedCI->eraseFromParent();
2224         return V;
2225       }
2226     }
2227     return SimplifiedFortifiedCI;
2228   }
2229
2230   // Then check for known library functions.
2231   if (TLI->getLibFunc(FuncName, Func) && TLI->has(Func)) {
2232     // We never change the calling convention.
2233     if (!ignoreCallingConv(Func) && !isCallingConvC)
2234       return nullptr;
2235     if (Value *V = optimizeStringMemoryLibCall(CI, Builder))
2236       return V;
2237     switch (Func) {
2238     case LibFunc::cosf:
2239     case LibFunc::cos:
2240     case LibFunc::cosl:
2241       return optimizeCos(CI, Builder);
2242     case LibFunc::sinpif:
2243     case LibFunc::sinpi:
2244     case LibFunc::cospif:
2245     case LibFunc::cospi:
2246       return optimizeSinCosPi(CI, Builder);
2247     case LibFunc::powf:
2248     case LibFunc::pow:
2249     case LibFunc::powl:
2250       return optimizePow(CI, Builder);
2251     case LibFunc::exp2l:
2252     case LibFunc::exp2:
2253     case LibFunc::exp2f:
2254       return optimizeExp2(CI, Builder);
2255     case LibFunc::fabsf:
2256     case LibFunc::fabs:
2257     case LibFunc::fabsl:
2258       return optimizeFabs(CI, Builder);
2259     case LibFunc::sqrtf:
2260     case LibFunc::sqrt:
2261     case LibFunc::sqrtl:
2262       return optimizeSqrt(CI, Builder);
2263     case LibFunc::ffs:
2264     case LibFunc::ffsl:
2265     case LibFunc::ffsll:
2266       return optimizeFFS(CI, Builder);
2267     case LibFunc::abs:
2268     case LibFunc::labs:
2269     case LibFunc::llabs:
2270       return optimizeAbs(CI, Builder);
2271     case LibFunc::isdigit:
2272       return optimizeIsDigit(CI, Builder);
2273     case LibFunc::isascii:
2274       return optimizeIsAscii(CI, Builder);
2275     case LibFunc::toascii:
2276       return optimizeToAscii(CI, Builder);
2277     case LibFunc::printf:
2278       return optimizePrintF(CI, Builder);
2279     case LibFunc::sprintf:
2280       return optimizeSPrintF(CI, Builder);
2281     case LibFunc::fprintf:
2282       return optimizeFPrintF(CI, Builder);
2283     case LibFunc::fwrite:
2284       return optimizeFWrite(CI, Builder);
2285     case LibFunc::fputs:
2286       return optimizeFPuts(CI, Builder);
2287     case LibFunc::log:
2288     case LibFunc::log10:
2289     case LibFunc::log1p:
2290     case LibFunc::log2:
2291     case LibFunc::logb:
2292       return optimizeLog(CI, Builder);
2293     case LibFunc::puts:
2294       return optimizePuts(CI, Builder);
2295     case LibFunc::tan:
2296     case LibFunc::tanf:
2297     case LibFunc::tanl:
2298       return optimizeTan(CI, Builder);
2299     case LibFunc::perror:
2300       return optimizeErrorReporting(CI, Builder);
2301     case LibFunc::vfprintf:
2302     case LibFunc::fiprintf:
2303       return optimizeErrorReporting(CI, Builder, 0);
2304     case LibFunc::fputc:
2305       return optimizeErrorReporting(CI, Builder, 1);
2306     case LibFunc::ceil:
2307     case LibFunc::floor:
2308     case LibFunc::rint:
2309     case LibFunc::round:
2310     case LibFunc::nearbyint:
2311     case LibFunc::trunc:
2312       if (hasFloatVersion(FuncName))
2313         return optimizeUnaryDoubleFP(CI, Builder, false);
2314       return nullptr;
2315     case LibFunc::acos:
2316     case LibFunc::acosh:
2317     case LibFunc::asin:
2318     case LibFunc::asinh:
2319     case LibFunc::atan:
2320     case LibFunc::atanh:
2321     case LibFunc::cbrt:
2322     case LibFunc::cosh:
2323     case LibFunc::exp:
2324     case LibFunc::exp10:
2325     case LibFunc::expm1:
2326     case LibFunc::sin:
2327     case LibFunc::sinh:
2328     case LibFunc::tanh:
2329       if (UnsafeFPShrink && hasFloatVersion(FuncName))
2330         return optimizeUnaryDoubleFP(CI, Builder, true);
2331       return nullptr;
2332     case LibFunc::copysign:
2333       if (hasFloatVersion(FuncName))
2334         return optimizeBinaryDoubleFP(CI, Builder);
2335       return nullptr;
2336     case LibFunc::fminf:
2337     case LibFunc::fmin:
2338     case LibFunc::fminl:
2339     case LibFunc::fmaxf:
2340     case LibFunc::fmax:
2341     case LibFunc::fmaxl:
2342       return optimizeFMinFMax(CI, Builder);
2343     default:
2344       return nullptr;
2345     }
2346   }
2347   return nullptr;
2348 }
2349
2350 LibCallSimplifier::LibCallSimplifier(
2351     const DataLayout &DL, const TargetLibraryInfo *TLI,
2352     function_ref<void(Instruction *, Value *)> Replacer)
2353     : FortifiedSimplifier(TLI), DL(DL), TLI(TLI), UnsafeFPShrink(false),
2354       Replacer(Replacer) {}
2355
2356 void LibCallSimplifier::replaceAllUsesWith(Instruction *I, Value *With) {
2357   // Indirect through the replacer used in this instance.
2358   Replacer(I, With);
2359 }
2360
2361 // TODO:
2362 //   Additional cases that we need to add to this file:
2363 //
2364 // cbrt:
2365 //   * cbrt(expN(X))  -> expN(x/3)
2366 //   * cbrt(sqrt(x))  -> pow(x,1/6)
2367 //   * cbrt(cbrt(x))  -> pow(x,1/9)
2368 //
2369 // exp, expf, expl:
2370 //   * exp(log(x))  -> x
2371 //
2372 // log, logf, logl:
2373 //   * log(exp(x))   -> x
2374 //   * log(exp(y))   -> y*log(e)
2375 //   * log(exp10(y)) -> y*log(10)
2376 //   * log(sqrt(x))  -> 0.5*log(x)
2377 //
2378 // lround, lroundf, lroundl:
2379 //   * lround(cnst) -> cnst'
2380 //
2381 // pow, powf, powl:
2382 //   * pow(sqrt(x),y) -> pow(x,y*0.5)
2383 //   * pow(pow(x,y),z)-> pow(x,y*z)
2384 //
2385 // round, roundf, roundl:
2386 //   * round(cnst) -> cnst'
2387 //
2388 // signbit:
2389 //   * signbit(cnst) -> cnst'
2390 //   * signbit(nncst) -> 0 (if pstv is a non-negative constant)
2391 //
2392 // sqrt, sqrtf, sqrtl:
2393 //   * sqrt(expN(x))  -> expN(x*0.5)
2394 //   * sqrt(Nroot(x)) -> pow(x,1/(2*N))
2395 //   * sqrt(pow(x,y)) -> pow(|x|,y*0.5)
2396 //
2397 // trunc, truncf, truncl:
2398 //   * trunc(cnst) -> cnst'
2399 //
2400 //
2401
2402 //===----------------------------------------------------------------------===//
2403 // Fortified Library Call Optimizations
2404 //===----------------------------------------------------------------------===//
2405
2406 bool FortifiedLibCallSimplifier::isFortifiedCallFoldable(CallInst *CI,
2407                                                          unsigned ObjSizeOp,
2408                                                          unsigned SizeOp,
2409                                                          bool isString) {
2410   if (CI->getArgOperand(ObjSizeOp) == CI->getArgOperand(SizeOp))
2411     return true;
2412   if (ConstantInt *ObjSizeCI =
2413           dyn_cast<ConstantInt>(CI->getArgOperand(ObjSizeOp))) {
2414     if (ObjSizeCI->isAllOnesValue())
2415       return true;
2416     // If the object size wasn't -1 (unknown), bail out if we were asked to.
2417     if (OnlyLowerUnknownSize)
2418       return false;
2419     if (isString) {
2420       uint64_t Len = GetStringLength(CI->getArgOperand(SizeOp));
2421       // If the length is 0 we don't know how long it is and so we can't
2422       // remove the check.
2423       if (Len == 0)
2424         return false;
2425       return ObjSizeCI->getZExtValue() >= Len;
2426     }
2427     if (ConstantInt *SizeCI = dyn_cast<ConstantInt>(CI->getArgOperand(SizeOp)))
2428       return ObjSizeCI->getZExtValue() >= SizeCI->getZExtValue();
2429   }
2430   return false;
2431 }
2432
2433 Value *FortifiedLibCallSimplifier::optimizeMemCpyChk(CallInst *CI,
2434                                                      IRBuilder<> &B) {
2435   Function *Callee = CI->getCalledFunction();
2436
2437   if (!checkStringCopyLibFuncSignature(Callee, LibFunc::memcpy_chk))
2438     return nullptr;
2439
2440   if (isFortifiedCallFoldable(CI, 3, 2, false)) {
2441     B.CreateMemCpy(CI->getArgOperand(0), CI->getArgOperand(1),
2442                    CI->getArgOperand(2), 1);
2443     return CI->getArgOperand(0);
2444   }
2445   return nullptr;
2446 }
2447
2448 Value *FortifiedLibCallSimplifier::optimizeMemMoveChk(CallInst *CI,
2449                                                       IRBuilder<> &B) {
2450   Function *Callee = CI->getCalledFunction();
2451
2452   if (!checkStringCopyLibFuncSignature(Callee, LibFunc::memmove_chk))
2453     return nullptr;
2454
2455   if (isFortifiedCallFoldable(CI, 3, 2, false)) {
2456     B.CreateMemMove(CI->getArgOperand(0), CI->getArgOperand(1),
2457                     CI->getArgOperand(2), 1);
2458     return CI->getArgOperand(0);
2459   }
2460   return nullptr;
2461 }
2462
2463 Value *FortifiedLibCallSimplifier::optimizeMemSetChk(CallInst *CI,
2464                                                      IRBuilder<> &B) {
2465   Function *Callee = CI->getCalledFunction();
2466
2467   if (!checkStringCopyLibFuncSignature(Callee, LibFunc::memset_chk))
2468     return nullptr;
2469
2470   if (isFortifiedCallFoldable(CI, 3, 2, false)) {
2471     Value *Val = B.CreateIntCast(CI->getArgOperand(1), B.getInt8Ty(), false);
2472     B.CreateMemSet(CI->getArgOperand(0), Val, CI->getArgOperand(2), 1);
2473     return CI->getArgOperand(0);
2474   }
2475   return nullptr;
2476 }
2477
2478 Value *FortifiedLibCallSimplifier::optimizeStrpCpyChk(CallInst *CI,
2479                                                       IRBuilder<> &B,
2480                                                       LibFunc::Func Func) {
2481   Function *Callee = CI->getCalledFunction();
2482   StringRef Name = Callee->getName();
2483   const DataLayout &DL = CI->getModule()->getDataLayout();
2484
2485   if (!checkStringCopyLibFuncSignature(Callee, Func))
2486     return nullptr;
2487
2488   Value *Dst = CI->getArgOperand(0), *Src = CI->getArgOperand(1),
2489         *ObjSize = CI->getArgOperand(2);
2490
2491   // __stpcpy_chk(x,x,...)  -> x+strlen(x)
2492   if (Func == LibFunc::stpcpy_chk && !OnlyLowerUnknownSize && Dst == Src) {
2493     Value *StrLen = EmitStrLen(Src, B, DL, TLI);
2494     return StrLen ? B.CreateInBoundsGEP(B.getInt8Ty(), Dst, StrLen) : nullptr;
2495   }
2496
2497   // If a) we don't have any length information, or b) we know this will
2498   // fit then just lower to a plain st[rp]cpy. Otherwise we'll keep our
2499   // st[rp]cpy_chk call which may fail at runtime if the size is too long.
2500   // TODO: It might be nice to get a maximum length out of the possible
2501   // string lengths for varying.
2502   if (isFortifiedCallFoldable(CI, 2, 1, true))
2503     return EmitStrCpy(Dst, Src, B, TLI, Name.substr(2, 6));
2504
2505   if (OnlyLowerUnknownSize)
2506     return nullptr;
2507
2508   // Maybe we can stil fold __st[rp]cpy_chk to __memcpy_chk.
2509   uint64_t Len = GetStringLength(Src);
2510   if (Len == 0)
2511     return nullptr;
2512
2513   Type *SizeTTy = DL.getIntPtrType(CI->getContext());
2514   Value *LenV = ConstantInt::get(SizeTTy, Len);
2515   Value *Ret = EmitMemCpyChk(Dst, Src, LenV, ObjSize, B, DL, TLI);
2516   // If the function was an __stpcpy_chk, and we were able to fold it into
2517   // a __memcpy_chk, we still need to return the correct end pointer.
2518   if (Ret && Func == LibFunc::stpcpy_chk)
2519     return B.CreateGEP(B.getInt8Ty(), Dst, ConstantInt::get(SizeTTy, Len - 1));
2520   return Ret;
2521 }
2522
2523 Value *FortifiedLibCallSimplifier::optimizeStrpNCpyChk(CallInst *CI,
2524                                                        IRBuilder<> &B,
2525                                                        LibFunc::Func Func) {
2526   Function *Callee = CI->getCalledFunction();
2527   StringRef Name = Callee->getName();
2528
2529   if (!checkStringCopyLibFuncSignature(Callee, Func))
2530     return nullptr;
2531   if (isFortifiedCallFoldable(CI, 3, 2, false)) {
2532     Value *Ret = EmitStrNCpy(CI->getArgOperand(0), CI->getArgOperand(1),
2533                              CI->getArgOperand(2), B, TLI, Name.substr(2, 7));
2534     return Ret;
2535   }
2536   return nullptr;
2537 }
2538
2539 Value *FortifiedLibCallSimplifier::optimizeCall(CallInst *CI) {
2540   // FIXME: We shouldn't be changing "nobuiltin" or TLI unavailable calls here.
2541   // Some clang users checked for _chk libcall availability using:
2542   //   __has_builtin(__builtin___memcpy_chk)
2543   // When compiling with -fno-builtin, this is always true.
2544   // When passing -ffreestanding/-mkernel, which both imply -fno-builtin, we
2545   // end up with fortified libcalls, which isn't acceptable in a freestanding
2546   // environment which only provides their non-fortified counterparts.
2547   //
2548   // Until we change clang and/or teach external users to check for availability
2549   // differently, disregard the "nobuiltin" attribute and TLI::has.
2550   //
2551   // PR23093.
2552
2553   LibFunc::Func Func;
2554   Function *Callee = CI->getCalledFunction();
2555   StringRef FuncName = Callee->getName();
2556
2557   SmallVector<OperandBundleDef, 2> OpBundles;
2558   CI->getOperandBundlesAsDefs(OpBundles);
2559   IRBuilder<> Builder(CI, /*FPMathTag=*/nullptr, OpBundles);
2560   bool isCallingConvC = CI->getCallingConv() == llvm::CallingConv::C;
2561
2562   // First, check that this is a known library functions.
2563   if (!TLI->getLibFunc(FuncName, Func))
2564     return nullptr;
2565
2566   // We never change the calling convention.
2567   if (!ignoreCallingConv(Func) && !isCallingConvC)
2568     return nullptr;
2569
2570   switch (Func) {
2571   case LibFunc::memcpy_chk:
2572     return optimizeMemCpyChk(CI, Builder);
2573   case LibFunc::memmove_chk:
2574     return optimizeMemMoveChk(CI, Builder);
2575   case LibFunc::memset_chk:
2576     return optimizeMemSetChk(CI, Builder);
2577   case LibFunc::stpcpy_chk:
2578   case LibFunc::strcpy_chk:
2579     return optimizeStrpCpyChk(CI, Builder, Func);
2580   case LibFunc::stpncpy_chk:
2581   case LibFunc::strncpy_chk:
2582     return optimizeStrpNCpyChk(CI, Builder, Func);
2583   default:
2584     break;
2585   }
2586   return nullptr;
2587 }
2588
2589 FortifiedLibCallSimplifier::FortifiedLibCallSimplifier(
2590     const TargetLibraryInfo *TLI, bool OnlyLowerUnknownSize)
2591     : TLI(TLI), OnlyLowerUnknownSize(OnlyLowerUnknownSize) {}