blob: 6636f71a6d42f836cf92c3d9fe45f928628c83a9 [file] [log] [blame]
Meador Ingedf796f82012-10-13 16:45:24 +00001//===------ 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//
Craig Topper2915bc02018-03-01 20:05:09 +000010// This file implements the library calls simplifier. It does not implement
11// any pass, but can't be used by other passes to do simplifications.
Meador Ingedf796f82012-10-13 16:45:24 +000012//
13//===----------------------------------------------------------------------===//
14
15#include "llvm/Transforms/Utils/SimplifyLibCalls.h"
Meador Inge20255ef2013-03-12 00:08:29 +000016#include "llvm/ADT/SmallString.h"
Meador Ingedf796f82012-10-13 16:45:24 +000017#include "llvm/ADT/StringMap.h"
Bob Wilsond8d92d92013-11-03 06:48:38 +000018#include "llvm/ADT/Triple.h"
Sanjay Patel82ec8722017-08-21 19:13:14 +000019#include "llvm/Analysis/ConstantFolding.h"
Adam Nemet0965da22017-10-09 23:19:02 +000020#include "llvm/Analysis/OptimizationRemarkEmitter.h"
Weiming Zhao45d4cb92015-11-24 18:57:06 +000021#include "llvm/Analysis/TargetLibraryInfo.h"
David Blaikie31b98d22018-06-04 21:23:21 +000022#include "llvm/Transforms/Utils/Local.h"
Meador Ingedf796f82012-10-13 16:45:24 +000023#include "llvm/Analysis/ValueTracking.h"
David Bolvanskyca22d422018-05-16 11:39:52 +000024#include "llvm/Analysis/CaptureTracking.h"
David Bolvansky909889b2018-08-10 04:32:54 +000025#include "llvm/Analysis/Loads.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000026#include "llvm/IR/DataLayout.h"
27#include "llvm/IR/Function.h"
28#include "llvm/IR/IRBuilder.h"
Meador Inge20255ef2013-03-12 00:08:29 +000029#include "llvm/IR/IntrinsicInst.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000030#include "llvm/IR/Intrinsics.h"
31#include "llvm/IR/LLVMContext.h"
32#include "llvm/IR/Module.h"
Sanjay Patelc699a612014-10-16 18:48:17 +000033#include "llvm/IR/PatternMatch.h"
Hal Finkel66cd3f12013-11-17 02:06:35 +000034#include "llvm/Support/CommandLine.h"
Craig Topperb45eabc2017-04-26 16:39:58 +000035#include "llvm/Support/KnownBits.h"
Meador Ingedf796f82012-10-13 16:45:24 +000036#include "llvm/Transforms/Utils/BuildLibCalls.h"
37
38using namespace llvm;
Sanjay Patelc699a612014-10-16 18:48:17 +000039using namespace PatternMatch;
Meador Ingedf796f82012-10-13 16:45:24 +000040
Hal Finkel66cd3f12013-11-17 02:06:35 +000041static cl::opt<bool>
Sanjay Patela92fa442014-10-22 15:29:23 +000042 EnableUnsafeFPShrink("enable-double-float-shrink", cl::Hidden,
43 cl::init(false),
44 cl::desc("Enable unsafe double to float "
45 "shrinking for math lib calls"));
46
47
Meador Ingedf796f82012-10-13 16:45:24 +000048//===----------------------------------------------------------------------===//
Meador Inged589ac62012-10-31 03:33:06 +000049// Helper Functions
50//===----------------------------------------------------------------------===//
51
David L. Jonesd21529f2017-01-23 23:16:46 +000052static bool ignoreCallingConv(LibFunc Func) {
53 return Func == LibFunc_abs || Func == LibFunc_labs ||
54 Func == LibFunc_llabs || Func == LibFunc_strlen;
Chris Bienemanad070d02014-09-17 20:55:46 +000055}
56
Sam Parker214f7bf2016-09-13 12:10:14 +000057static bool isCallingConvCCompatible(CallInst *CI) {
58 switch(CI->getCallingConv()) {
59 default:
60 return false;
61 case llvm::CallingConv::C:
62 return true;
63 case llvm::CallingConv::ARM_APCS:
64 case llvm::CallingConv::ARM_AAPCS:
65 case llvm::CallingConv::ARM_AAPCS_VFP: {
66
67 // The iOS ABI diverges from the standard in some cases, so for now don't
68 // try to simplify those calls.
69 if (Triple(CI->getModule()->getTargetTriple()).isiOS())
70 return false;
71
72 auto *FuncTy = CI->getFunctionType();
73
74 if (!FuncTy->getReturnType()->isPointerTy() &&
75 !FuncTy->getReturnType()->isIntegerTy() &&
76 !FuncTy->getReturnType()->isVoidTy())
77 return false;
78
79 for (auto Param : FuncTy->params()) {
80 if (!Param->isPointerTy() && !Param->isIntegerTy())
81 return false;
82 }
83 return true;
84 }
85 }
86 return false;
87}
88
Sanjay Pateld707db92015-12-31 16:10:49 +000089/// Return true if it is only used in equality comparisons with With.
Meador Inge56edbc92012-11-11 03:51:48 +000090static bool isOnlyUsedInEqualityComparison(Value *V, Value *With) {
Chandler Carruthcdf47882014-03-09 03:16:01 +000091 for (User *U : V->users()) {
92 if (ICmpInst *IC = dyn_cast<ICmpInst>(U))
Meador Inge56edbc92012-11-11 03:51:48 +000093 if (IC->isEquality() && IC->getOperand(1) == With)
94 continue;
95 // Unknown instruction.
96 return false;
97 }
98 return true;
99}
100
Meador Inge08ca1152012-11-26 20:37:20 +0000101static bool callHasFloatingPointArgument(const CallInst *CI) {
David Majnemer0a16c222016-08-11 21:15:00 +0000102 return any_of(CI->operands(), [](const Use &OI) {
Davide Italianoda3beeb2015-11-28 22:27:48 +0000103 return OI->getType()->isFloatingPointTy();
104 });
Meador Inge08ca1152012-11-26 20:37:20 +0000105}
106
David Bolvanskycb8ca5f32018-04-25 18:58:53 +0000107static Value *convertStrToNumber(CallInst *CI, StringRef &Str, int64_t Base) {
108 if (Base < 2 || Base > 36)
109 // handle special zero base
110 if (Base != 0)
111 return nullptr;
112
113 char *End;
114 std::string nptr = Str.str();
115 errno = 0;
116 long long int Result = strtoll(nptr.c_str(), &End, Base);
117 if (errno)
118 return nullptr;
119
120 // if we assume all possible target locales are ASCII supersets,
121 // then if strtoll successfully parses a number on the host,
122 // it will also successfully parse the same way on the target
123 if (*End != '\0')
124 return nullptr;
125
126 if (!isIntN(CI->getType()->getPrimitiveSizeInBits(), Result))
127 return nullptr;
128
129 return ConstantInt::get(CI->getType(), Result);
130}
131
David Bolvanskyca22d422018-05-16 11:39:52 +0000132static bool isLocallyOpenedFile(Value *File, CallInst *CI, IRBuilder<> &B,
133 const TargetLibraryInfo *TLI) {
134 CallInst *FOpen = dyn_cast<CallInst>(File);
135 if (!FOpen)
136 return false;
137
138 Function *InnerCallee = FOpen->getCalledFunction();
139 if (!InnerCallee)
140 return false;
141
142 LibFunc Func;
143 if (!TLI->getLibFunc(*InnerCallee, Func) || !TLI->has(Func) ||
144 Func != LibFunc_fopen)
145 return false;
146
147 inferLibFuncAttributes(*CI->getCalledFunction(), *TLI);
148 if (PointerMayBeCaptured(File, true, true))
149 return false;
150
151 return true;
152}
153
David Bolvansky909889b2018-08-10 04:32:54 +0000154static bool isOnlyUsedInComparisonWithZero(Value *V) {
155 for (User *U : V->users()) {
156 if (ICmpInst *IC = dyn_cast<ICmpInst>(U))
157 if (Constant *C = dyn_cast<Constant>(IC->getOperand(1)))
158 if (C->isNullValue())
159 continue;
160 // Unknown instruction.
161 return false;
162 }
163 return true;
164}
165
166static bool canTransformToMemCmp(CallInst *CI, Value *Str, uint64_t Len,
167 const DataLayout &DL) {
168 if (!isOnlyUsedInComparisonWithZero(CI))
169 return false;
170
171 if (!isDereferenceableAndAlignedPointer(Str, 1, APInt(64, Len), DL))
172 return false;
173
174 return true;
175}
176
Meador Inged589ac62012-10-31 03:33:06 +0000177//===----------------------------------------------------------------------===//
Meador Inge7fb2f732012-10-13 16:45:32 +0000178// String and Memory Library Call Optimizations
179//===----------------------------------------------------------------------===//
180
Chris Bienemanad070d02014-09-17 20:55:46 +0000181Value *LibCallSimplifier::optimizeStrCat(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +0000182 // Extract some information from the instruction
183 Value *Dst = CI->getArgOperand(0);
184 Value *Src = CI->getArgOperand(1);
185
186 // See if we can get the length of the input string.
David Bolvansky1f343fa2018-05-22 20:27:36 +0000187 uint64_t Len = GetStringLength(Src);
Chris Bienemanad070d02014-09-17 20:55:46 +0000188 if (Len == 0)
189 return nullptr;
190 --Len; // Unbias length.
191
192 // Handle the simple, do-nothing case: strcat(x, "") -> x
193 if (Len == 0)
194 return Dst;
195
Chris Bienemanad070d02014-09-17 20:55:46 +0000196 return emitStrLenMemCpy(Src, Dst, Len, B);
197}
198
199Value *LibCallSimplifier::emitStrLenMemCpy(Value *Src, Value *Dst, uint64_t Len,
200 IRBuilder<> &B) {
201 // We need to find the end of the destination string. That's where the
202 // memory is to be moved to. We just generate a call to strlen.
Sanjay Pateld3112a52016-01-19 19:46:10 +0000203 Value *DstLen = emitStrLen(Dst, B, DL, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +0000204 if (!DstLen)
205 return nullptr;
206
207 // Now that we have the destination's length, we must index into the
208 // destination's pointer to get the actual memcpy destination (end of
209 // the string .. we're concatenating).
David Blaikie3909da72015-03-30 20:42:56 +0000210 Value *CpyDst = B.CreateGEP(B.getInt8Ty(), Dst, DstLen, "endptr");
Chris Bienemanad070d02014-09-17 20:55:46 +0000211
212 // We have enough information to now generate the memcpy call to do the
213 // concatenation for us. Make a memcpy to copy the nul byte with align = 1.
Daniel Neilson8acd8b02018-02-05 21:23:22 +0000214 B.CreateMemCpy(CpyDst, 1, Src, 1,
215 ConstantInt::get(DL.getIntPtrType(Src->getContext()), Len + 1));
Chris Bienemanad070d02014-09-17 20:55:46 +0000216 return Dst;
217}
218
219Value *LibCallSimplifier::optimizeStrNCat(CallInst *CI, IRBuilder<> &B) {
Sanjay Pateld707db92015-12-31 16:10:49 +0000220 // Extract some information from the instruction.
Chris Bienemanad070d02014-09-17 20:55:46 +0000221 Value *Dst = CI->getArgOperand(0);
222 Value *Src = CI->getArgOperand(1);
223 uint64_t Len;
224
Sanjay Pateld707db92015-12-31 16:10:49 +0000225 // We don't do anything if length is not constant.
Chris Bienemanad070d02014-09-17 20:55:46 +0000226 if (ConstantInt *LengthArg = dyn_cast<ConstantInt>(CI->getArgOperand(2)))
227 Len = LengthArg->getZExtValue();
228 else
229 return nullptr;
230
231 // See if we can get the length of the input string.
David Bolvansky1f343fa2018-05-22 20:27:36 +0000232 uint64_t SrcLen = GetStringLength(Src);
Chris Bienemanad070d02014-09-17 20:55:46 +0000233 if (SrcLen == 0)
234 return nullptr;
235 --SrcLen; // Unbias length.
236
237 // Handle the simple, do-nothing cases:
238 // strncat(x, "", c) -> x
239 // strncat(x, c, 0) -> x
240 if (SrcLen == 0 || Len == 0)
241 return Dst;
242
Sanjay Pateld707db92015-12-31 16:10:49 +0000243 // We don't optimize this case.
Chris Bienemanad070d02014-09-17 20:55:46 +0000244 if (Len < SrcLen)
245 return nullptr;
246
247 // strncat(x, s, c) -> strcat(x, s)
Sanjay Pateld707db92015-12-31 16:10:49 +0000248 // s is constant so the strcat can be optimized further.
Chris Bienemanad070d02014-09-17 20:55:46 +0000249 return emitStrLenMemCpy(Src, Dst, SrcLen, B);
250}
251
252Value *LibCallSimplifier::optimizeStrChr(CallInst *CI, IRBuilder<> &B) {
253 Function *Callee = CI->getCalledFunction();
Chris Bienemanad070d02014-09-17 20:55:46 +0000254 FunctionType *FT = Callee->getFunctionType();
Chris Bienemanad070d02014-09-17 20:55:46 +0000255 Value *SrcStr = CI->getArgOperand(0);
256
257 // If the second operand is non-constant, see if we can compute the length
258 // of the input string and turn this into memchr.
259 ConstantInt *CharC = dyn_cast<ConstantInt>(CI->getArgOperand(1));
260 if (!CharC) {
David Bolvansky1f343fa2018-05-22 20:27:36 +0000261 uint64_t Len = GetStringLength(SrcStr);
Chris Bienemanad070d02014-09-17 20:55:46 +0000262 if (Len == 0 || !FT->getParamType(1)->isIntegerTy(32)) // memchr needs i32.
263 return nullptr;
Meador Inge7fb2f732012-10-13 16:45:32 +0000264
Sanjay Pateld3112a52016-01-19 19:46:10 +0000265 return emitMemChr(SrcStr, CI->getArgOperand(1), // include nul.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000266 ConstantInt::get(DL.getIntPtrType(CI->getContext()), Len),
267 B, DL, TLI);
Meador Inge7fb2f732012-10-13 16:45:32 +0000268 }
269
Chris Bienemanad070d02014-09-17 20:55:46 +0000270 // Otherwise, the character is a constant, see if the first argument is
271 // a string literal. If so, we can constant fold.
272 StringRef Str;
273 if (!getConstantStringInfo(SrcStr, Str)) {
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000274 if (CharC->isZero()) // strchr(p, 0) -> p + strlen(p)
Sanjay Pateld3112a52016-01-19 19:46:10 +0000275 return B.CreateGEP(B.getInt8Ty(), SrcStr, emitStrLen(SrcStr, B, DL, TLI),
Sanjay Pateld707db92015-12-31 16:10:49 +0000276 "strchr");
Chris Bienemanad070d02014-09-17 20:55:46 +0000277 return nullptr;
278 }
279
280 // Compute the offset, make sure to handle the case when we're searching for
281 // zero (a weird way to spell strlen).
282 size_t I = (0xFF & CharC->getSExtValue()) == 0
283 ? Str.size()
284 : Str.find(CharC->getSExtValue());
285 if (I == StringRef::npos) // Didn't find the char. strchr returns null.
286 return Constant::getNullValue(CI->getType());
287
288 // strchr(s+n,c) -> gep(s+n+i,c)
David Blaikie3909da72015-03-30 20:42:56 +0000289 return B.CreateGEP(B.getInt8Ty(), SrcStr, B.getInt64(I), "strchr");
Chris Bienemanad070d02014-09-17 20:55:46 +0000290}
291
292Value *LibCallSimplifier::optimizeStrRChr(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +0000293 Value *SrcStr = CI->getArgOperand(0);
294 ConstantInt *CharC = dyn_cast<ConstantInt>(CI->getArgOperand(1));
295
296 // Cannot fold anything if we're not looking for a constant.
297 if (!CharC)
298 return nullptr;
299
300 StringRef Str;
301 if (!getConstantStringInfo(SrcStr, Str)) {
302 // strrchr(s, 0) -> strchr(s, 0)
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000303 if (CharC->isZero())
Sanjay Pateld3112a52016-01-19 19:46:10 +0000304 return emitStrChr(SrcStr, '\0', B, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +0000305 return nullptr;
306 }
307
308 // Compute the offset.
309 size_t I = (0xFF & CharC->getSExtValue()) == 0
310 ? Str.size()
311 : Str.rfind(CharC->getSExtValue());
312 if (I == StringRef::npos) // Didn't find the char. Return null.
313 return Constant::getNullValue(CI->getType());
314
315 // strrchr(s+n,c) -> gep(s+n+i,c)
David Blaikie3909da72015-03-30 20:42:56 +0000316 return B.CreateGEP(B.getInt8Ty(), SrcStr, B.getInt64(I), "strrchr");
Chris Bienemanad070d02014-09-17 20:55:46 +0000317}
318
319Value *LibCallSimplifier::optimizeStrCmp(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +0000320 Value *Str1P = CI->getArgOperand(0), *Str2P = CI->getArgOperand(1);
321 if (Str1P == Str2P) // strcmp(x,x) -> 0
322 return ConstantInt::get(CI->getType(), 0);
323
324 StringRef Str1, Str2;
325 bool HasStr1 = getConstantStringInfo(Str1P, Str1);
326 bool HasStr2 = getConstantStringInfo(Str2P, Str2);
327
328 // strcmp(x, y) -> cnst (if both x and y are constant strings)
329 if (HasStr1 && HasStr2)
330 return ConstantInt::get(CI->getType(), Str1.compare(Str2));
331
332 if (HasStr1 && Str1.empty()) // strcmp("", x) -> -*x
333 return B.CreateNeg(
334 B.CreateZExt(B.CreateLoad(Str2P, "strcmpload"), CI->getType()));
335
336 if (HasStr2 && Str2.empty()) // strcmp(x,"") -> *x
337 return B.CreateZExt(B.CreateLoad(Str1P, "strcmpload"), CI->getType());
338
339 // strcmp(P, "x") -> memcmp(P, "x", 2)
David Bolvansky1f343fa2018-05-22 20:27:36 +0000340 uint64_t Len1 = GetStringLength(Str1P);
341 uint64_t Len2 = GetStringLength(Str2P);
Chris Bienemanad070d02014-09-17 20:55:46 +0000342 if (Len1 && Len2) {
Sanjay Pateld3112a52016-01-19 19:46:10 +0000343 return emitMemCmp(Str1P, Str2P,
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000344 ConstantInt::get(DL.getIntPtrType(CI->getContext()),
Chris Bienemanad070d02014-09-17 20:55:46 +0000345 std::min(Len1, Len2)),
346 B, DL, TLI);
347 }
Meador Inge7fb2f732012-10-13 16:45:32 +0000348
David Bolvansky909889b2018-08-10 04:32:54 +0000349 // strcmp to memcmp
350 if (!HasStr1 && HasStr2) {
351 if (canTransformToMemCmp(CI, Str1P, Len2, DL))
352 return emitMemCmp(
353 Str1P, Str2P,
354 ConstantInt::get(DL.getIntPtrType(CI->getContext()), Len2), B, DL,
355 TLI);
356 } else if (HasStr1 && !HasStr2) {
357 if (canTransformToMemCmp(CI, Str2P, Len1, DL))
358 return emitMemCmp(
359 Str1P, Str2P,
360 ConstantInt::get(DL.getIntPtrType(CI->getContext()), Len1), B, DL,
361 TLI);
362 }
363
Chris Bienemanad070d02014-09-17 20:55:46 +0000364 return nullptr;
365}
366
367Value *LibCallSimplifier::optimizeStrNCmp(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +0000368 Value *Str1P = CI->getArgOperand(0), *Str2P = CI->getArgOperand(1);
369 if (Str1P == Str2P) // strncmp(x,x,n) -> 0
370 return ConstantInt::get(CI->getType(), 0);
371
372 // Get the length argument if it is constant.
373 uint64_t Length;
374 if (ConstantInt *LengthArg = dyn_cast<ConstantInt>(CI->getArgOperand(2)))
375 Length = LengthArg->getZExtValue();
376 else
377 return nullptr;
378
379 if (Length == 0) // strncmp(x,y,0) -> 0
380 return ConstantInt::get(CI->getType(), 0);
381
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000382 if (Length == 1) // strncmp(x,y,1) -> memcmp(x,y,1)
Sanjay Pateld3112a52016-01-19 19:46:10 +0000383 return emitMemCmp(Str1P, Str2P, CI->getArgOperand(2), B, DL, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +0000384
385 StringRef Str1, Str2;
386 bool HasStr1 = getConstantStringInfo(Str1P, Str1);
387 bool HasStr2 = getConstantStringInfo(Str2P, Str2);
388
389 // strncmp(x, y) -> cnst (if both x and y are constant strings)
390 if (HasStr1 && HasStr2) {
391 StringRef SubStr1 = Str1.substr(0, Length);
392 StringRef SubStr2 = Str2.substr(0, Length);
393 return ConstantInt::get(CI->getType(), SubStr1.compare(SubStr2));
394 }
395
396 if (HasStr1 && Str1.empty()) // strncmp("", x, n) -> -*x
397 return B.CreateNeg(
398 B.CreateZExt(B.CreateLoad(Str2P, "strcmpload"), CI->getType()));
399
400 if (HasStr2 && Str2.empty()) // strncmp(x, "", n) -> *x
401 return B.CreateZExt(B.CreateLoad(Str1P, "strcmpload"), CI->getType());
402
David Bolvansky909889b2018-08-10 04:32:54 +0000403 uint64_t Len1 = GetStringLength(Str1P);
404 uint64_t Len2 = GetStringLength(Str2P);
405
406 // strncmp to memcmp
407 if (!HasStr1 && HasStr2) {
408 Len2 = std::min(Len2, Length);
409 if (canTransformToMemCmp(CI, Str1P, Len2, DL))
410 return emitMemCmp(
411 Str1P, Str2P,
412 ConstantInt::get(DL.getIntPtrType(CI->getContext()), Len2), B, DL,
413 TLI);
414 } else if (HasStr1 && !HasStr2) {
415 Len1 = std::min(Len1, Length);
416 if (canTransformToMemCmp(CI, Str2P, Len1, DL))
417 return emitMemCmp(
418 Str1P, Str2P,
419 ConstantInt::get(DL.getIntPtrType(CI->getContext()), Len1), B, DL,
420 TLI);
421 }
422
Chris Bienemanad070d02014-09-17 20:55:46 +0000423 return nullptr;
424}
425
426Value *LibCallSimplifier::optimizeStrCpy(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +0000427 Value *Dst = CI->getArgOperand(0), *Src = CI->getArgOperand(1);
428 if (Dst == Src) // strcpy(x,x) -> x
429 return Src;
430
Chris Bienemanad070d02014-09-17 20:55:46 +0000431 // See if we can get the length of the input string.
David Bolvansky1f343fa2018-05-22 20:27:36 +0000432 uint64_t Len = GetStringLength(Src);
Chris Bienemanad070d02014-09-17 20:55:46 +0000433 if (Len == 0)
434 return nullptr;
435
436 // We have enough information to now generate the memcpy call to do the
437 // copy for us. Make a memcpy to copy the nul byte with align = 1.
Daniel Neilson8acd8b02018-02-05 21:23:22 +0000438 B.CreateMemCpy(Dst, 1, Src, 1,
439 ConstantInt::get(DL.getIntPtrType(CI->getContext()), Len));
Chris Bienemanad070d02014-09-17 20:55:46 +0000440 return Dst;
441}
442
443Value *LibCallSimplifier::optimizeStpCpy(CallInst *CI, IRBuilder<> &B) {
444 Function *Callee = CI->getCalledFunction();
Chris Bienemanad070d02014-09-17 20:55:46 +0000445 Value *Dst = CI->getArgOperand(0), *Src = CI->getArgOperand(1);
446 if (Dst == Src) { // stpcpy(x,x) -> x+strlen(x)
Sanjay Pateld3112a52016-01-19 19:46:10 +0000447 Value *StrLen = emitStrLen(Src, B, DL, TLI);
David Blaikieaa41cd52015-04-03 21:33:42 +0000448 return StrLen ? B.CreateInBoundsGEP(B.getInt8Ty(), Dst, StrLen) : nullptr;
Chris Bienemanad070d02014-09-17 20:55:46 +0000449 }
450
451 // See if we can get the length of the input string.
David Bolvansky1f343fa2018-05-22 20:27:36 +0000452 uint64_t Len = GetStringLength(Src);
Chris Bienemanad070d02014-09-17 20:55:46 +0000453 if (Len == 0)
454 return nullptr;
455
Davide Italianob7487e62015-11-02 23:07:14 +0000456 Type *PT = Callee->getFunctionType()->getParamType(0);
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000457 Value *LenV = ConstantInt::get(DL.getIntPtrType(PT), Len);
Sanjay Pateld707db92015-12-31 16:10:49 +0000458 Value *DstEnd = B.CreateGEP(B.getInt8Ty(), Dst,
459 ConstantInt::get(DL.getIntPtrType(PT), Len - 1));
Chris Bienemanad070d02014-09-17 20:55:46 +0000460
461 // We have enough information to now generate the memcpy call to do the
462 // copy for us. Make a memcpy to copy the nul byte with align = 1.
Daniel Neilson8acd8b02018-02-05 21:23:22 +0000463 B.CreateMemCpy(Dst, 1, Src, 1, LenV);
Chris Bienemanad070d02014-09-17 20:55:46 +0000464 return DstEnd;
465}
466
467Value *LibCallSimplifier::optimizeStrNCpy(CallInst *CI, IRBuilder<> &B) {
468 Function *Callee = CI->getCalledFunction();
Chris Bienemanad070d02014-09-17 20:55:46 +0000469 Value *Dst = CI->getArgOperand(0);
470 Value *Src = CI->getArgOperand(1);
471 Value *LenOp = CI->getArgOperand(2);
472
473 // See if we can get the length of the input string.
David Bolvansky1f343fa2018-05-22 20:27:36 +0000474 uint64_t SrcLen = GetStringLength(Src);
Chris Bienemanad070d02014-09-17 20:55:46 +0000475 if (SrcLen == 0)
476 return nullptr;
477 --SrcLen;
478
479 if (SrcLen == 0) {
Daniel Neilson8acd8b02018-02-05 21:23:22 +0000480 // strncpy(x, "", y) -> memset(align 1 x, '\0', y)
Chris Bienemanad070d02014-09-17 20:55:46 +0000481 B.CreateMemSet(Dst, B.getInt8('\0'), LenOp, 1);
Meador Inge7fb2f732012-10-13 16:45:32 +0000482 return Dst;
483 }
Meador Inge7fb2f732012-10-13 16:45:32 +0000484
Chris Bienemanad070d02014-09-17 20:55:46 +0000485 uint64_t Len;
486 if (ConstantInt *LengthArg = dyn_cast<ConstantInt>(LenOp))
487 Len = LengthArg->getZExtValue();
488 else
489 return nullptr;
Meador Inge7fb2f732012-10-13 16:45:32 +0000490
Chris Bienemanad070d02014-09-17 20:55:46 +0000491 if (Len == 0)
492 return Dst; // strncpy(x, y, 0) -> x
Meador Inge7fb2f732012-10-13 16:45:32 +0000493
Chris Bienemanad070d02014-09-17 20:55:46 +0000494 // Let strncpy handle the zero padding
495 if (Len > SrcLen + 1)
496 return nullptr;
Meador Inge7fb2f732012-10-13 16:45:32 +0000497
Davide Italianob7487e62015-11-02 23:07:14 +0000498 Type *PT = Callee->getFunctionType()->getParamType(0);
Daniel Neilson8acd8b02018-02-05 21:23:22 +0000499 // strncpy(x, s, c) -> memcpy(align 1 x, align 1 s, c) [s and c are constant]
500 B.CreateMemCpy(Dst, 1, Src, 1, ConstantInt::get(DL.getIntPtrType(PT), Len));
Meador Inge7fb2f732012-10-13 16:45:32 +0000501
Chris Bienemanad070d02014-09-17 20:55:46 +0000502 return Dst;
503}
Meador Inge7fb2f732012-10-13 16:45:32 +0000504
Matthias Braun50ec0b52017-05-19 22:37:09 +0000505Value *LibCallSimplifier::optimizeStringLength(CallInst *CI, IRBuilder<> &B,
506 unsigned CharSize) {
Chris Bienemanad070d02014-09-17 20:55:46 +0000507 Value *Src = CI->getArgOperand(0);
508
509 // Constant folding: strlen("xyz") -> 3
David Bolvansky1f343fa2018-05-22 20:27:36 +0000510 if (uint64_t Len = GetStringLength(Src, CharSize))
Chris Bienemanad070d02014-09-17 20:55:46 +0000511 return ConstantInt::get(CI->getType(), Len - 1);
512
David L Kreitzer752c1442016-04-13 14:31:06 +0000513 // If s is a constant pointer pointing to a string literal, we can fold
Matthias Braun50ec0b52017-05-19 22:37:09 +0000514 // strlen(s + x) to strlen(s) - x, when x is known to be in the range
David L Kreitzer752c1442016-04-13 14:31:06 +0000515 // [0, strlen(s)] or the string has a single null terminator '\0' at the end.
Matthias Braun50ec0b52017-05-19 22:37:09 +0000516 // We only try to simplify strlen when the pointer s points to an array
David L Kreitzer752c1442016-04-13 14:31:06 +0000517 // of i8. Otherwise, we would need to scale the offset x before doing the
Matthias Braun50ec0b52017-05-19 22:37:09 +0000518 // subtraction. This will make the optimization more complex, and it's not
519 // very useful because calling strlen for a pointer of other types is
David L Kreitzer752c1442016-04-13 14:31:06 +0000520 // very uncommon.
521 if (GEPOperator *GEP = dyn_cast<GEPOperator>(Src)) {
Matthias Braun50ec0b52017-05-19 22:37:09 +0000522 if (!isGEPBasedOnPointerToString(GEP, CharSize))
David L Kreitzer752c1442016-04-13 14:31:06 +0000523 return nullptr;
524
Matthias Braun50ec0b52017-05-19 22:37:09 +0000525 ConstantDataArraySlice Slice;
526 if (getConstantDataArrayInfo(GEP->getOperand(0), Slice, CharSize)) {
527 uint64_t NullTermIdx;
528 if (Slice.Array == nullptr) {
529 NullTermIdx = 0;
530 } else {
531 NullTermIdx = ~((uint64_t)0);
532 for (uint64_t I = 0, E = Slice.Length; I < E; ++I) {
533 if (Slice.Array->getElementAsInteger(I + Slice.Offset) == 0) {
534 NullTermIdx = I;
535 break;
536 }
537 }
538 // If the string does not have '\0', leave it to strlen to compute
539 // its length.
540 if (NullTermIdx == ~((uint64_t)0))
541 return nullptr;
542 }
543
David L Kreitzer752c1442016-04-13 14:31:06 +0000544 Value *Offset = GEP->getOperand(2);
Craig Topper8205a1a2017-05-24 16:53:07 +0000545 KnownBits Known = computeKnownBits(Offset, DL, 0, nullptr, CI, nullptr);
Craig Topperb45eabc2017-04-26 16:39:58 +0000546 Known.Zero.flipAllBits();
Matthias Braun50ec0b52017-05-19 22:37:09 +0000547 uint64_t ArrSize =
David L Kreitzer752c1442016-04-13 14:31:06 +0000548 cast<ArrayType>(GEP->getSourceElementType())->getNumElements();
549
Matthias Braun50ec0b52017-05-19 22:37:09 +0000550 // KnownZero's bits are flipped, so zeros in KnownZero now represent
551 // bits known to be zeros in Offset, and ones in KnowZero represent
David L Kreitzer752c1442016-04-13 14:31:06 +0000552 // bits unknown in Offset. Therefore, Offset is known to be in range
Matthias Braun50ec0b52017-05-19 22:37:09 +0000553 // [0, NullTermIdx] when the flipped KnownZero is non-negative and
David L Kreitzer752c1442016-04-13 14:31:06 +0000554 // unsigned-less-than NullTermIdx.
555 //
Matthias Braun50ec0b52017-05-19 22:37:09 +0000556 // If Offset is not provably in the range [0, NullTermIdx], we can still
557 // optimize if we can prove that the program has undefined behavior when
558 // Offset is outside that range. That is the case when GEP->getOperand(0)
David L Kreitzer752c1442016-04-13 14:31:06 +0000559 // is a pointer to an object whose memory extent is NullTermIdx+1.
Matthias Braun50ec0b52017-05-19 22:37:09 +0000560 if ((Known.Zero.isNonNegative() && Known.Zero.ule(NullTermIdx)) ||
David L Kreitzer752c1442016-04-13 14:31:06 +0000561 (GEP->isInBounds() && isa<GlobalVariable>(GEP->getOperand(0)) &&
Matthias Braun50ec0b52017-05-19 22:37:09 +0000562 NullTermIdx == ArrSize - 1)) {
563 Offset = B.CreateSExtOrTrunc(Offset, CI->getType());
564 return B.CreateSub(ConstantInt::get(CI->getType(), NullTermIdx),
David L Kreitzer752c1442016-04-13 14:31:06 +0000565 Offset);
Matthias Braun50ec0b52017-05-19 22:37:09 +0000566 }
David L Kreitzer752c1442016-04-13 14:31:06 +0000567 }
568
569 return nullptr;
570 }
571
Chris Bienemanad070d02014-09-17 20:55:46 +0000572 // strlen(x?"foo":"bars") --> x ? 3 : 4
573 if (SelectInst *SI = dyn_cast<SelectInst>(Src)) {
David Bolvansky1f343fa2018-05-22 20:27:36 +0000574 uint64_t LenTrue = GetStringLength(SI->getTrueValue(), CharSize);
575 uint64_t LenFalse = GetStringLength(SI->getFalseValue(), CharSize);
Chris Bienemanad070d02014-09-17 20:55:46 +0000576 if (LenTrue && LenFalse) {
Vivek Pandya95906582017-10-11 17:12:59 +0000577 ORE.emit([&]() {
578 return OptimizationRemark("instcombine", "simplify-libcalls", CI)
579 << "folded strlen(select) to select of constants";
580 });
Chris Bienemanad070d02014-09-17 20:55:46 +0000581 return B.CreateSelect(SI->getCondition(),
582 ConstantInt::get(CI->getType(), LenTrue - 1),
583 ConstantInt::get(CI->getType(), LenFalse - 1));
584 }
Meador Inge7fb2f732012-10-13 16:45:32 +0000585 }
Meador Inge7fb2f732012-10-13 16:45:32 +0000586
Chris Bienemanad070d02014-09-17 20:55:46 +0000587 // strlen(x) != 0 --> *x != 0
588 // strlen(x) == 0 --> *x == 0
589 if (isOnlyUsedInZeroEqualityComparison(CI))
590 return B.CreateZExt(B.CreateLoad(Src, "strlenfirst"), CI->getType());
Meador Inge17418502012-10-13 16:45:37 +0000591
Chris Bienemanad070d02014-09-17 20:55:46 +0000592 return nullptr;
593}
Meador Inge17418502012-10-13 16:45:37 +0000594
Matthias Braun50ec0b52017-05-19 22:37:09 +0000595Value *LibCallSimplifier::optimizeStrLen(CallInst *CI, IRBuilder<> &B) {
596 return optimizeStringLength(CI, B, 8);
597}
598
599Value *LibCallSimplifier::optimizeWcslen(CallInst *CI, IRBuilder<> &B) {
David Bolvansky5430b7372018-05-31 16:39:27 +0000600 Module &M = *CI->getModule();
Matthias Braun50ec0b52017-05-19 22:37:09 +0000601 unsigned WCharSize = TLI->getWCharSize(M) * 8;
Matthias Brauncc603ee2017-09-26 02:36:57 +0000602 // We cannot perform this optimization without wchar_size metadata.
603 if (WCharSize == 0)
604 return nullptr;
Matthias Braun50ec0b52017-05-19 22:37:09 +0000605
606 return optimizeStringLength(CI, B, WCharSize);
607}
608
Chris Bienemanad070d02014-09-17 20:55:46 +0000609Value *LibCallSimplifier::optimizeStrPBrk(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +0000610 StringRef S1, S2;
611 bool HasS1 = getConstantStringInfo(CI->getArgOperand(0), S1);
612 bool HasS2 = getConstantStringInfo(CI->getArgOperand(1), S2);
Meador Inge17418502012-10-13 16:45:37 +0000613
Reid Kleckner971c3ea2014-11-13 22:55:19 +0000614 // strpbrk(s, "") -> nullptr
615 // strpbrk("", s) -> nullptr
Chris Bienemanad070d02014-09-17 20:55:46 +0000616 if ((HasS1 && S1.empty()) || (HasS2 && S2.empty()))
617 return Constant::getNullValue(CI->getType());
Meador Inge17418502012-10-13 16:45:37 +0000618
Chris Bienemanad070d02014-09-17 20:55:46 +0000619 // Constant folding.
620 if (HasS1 && HasS2) {
621 size_t I = S1.find_first_of(S2);
622 if (I == StringRef::npos) // No match.
Meador Inge17418502012-10-13 16:45:37 +0000623 return Constant::getNullValue(CI->getType());
624
Sanjay Pateld707db92015-12-31 16:10:49 +0000625 return B.CreateGEP(B.getInt8Ty(), CI->getArgOperand(0), B.getInt64(I),
626 "strpbrk");
Meador Inge17418502012-10-13 16:45:37 +0000627 }
Meador Inge17418502012-10-13 16:45:37 +0000628
Chris Bienemanad070d02014-09-17 20:55:46 +0000629 // strpbrk(s, "a") -> strchr(s, 'a')
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000630 if (HasS2 && S2.size() == 1)
Sanjay Pateld3112a52016-01-19 19:46:10 +0000631 return emitStrChr(CI->getArgOperand(0), S2[0], B, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +0000632
633 return nullptr;
634}
635
636Value *LibCallSimplifier::optimizeStrTo(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +0000637 Value *EndPtr = CI->getArgOperand(1);
638 if (isa<ConstantPointerNull>(EndPtr)) {
639 // With a null EndPtr, this function won't capture the main argument.
640 // It would be readonly too, except that it still may write to errno.
Reid Klecknera0b45f42017-05-03 18:17:31 +0000641 CI->addParamAttr(0, Attribute::NoCapture);
Chris Bienemanad070d02014-09-17 20:55:46 +0000642 }
643
644 return nullptr;
645}
646
647Value *LibCallSimplifier::optimizeStrSpn(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +0000648 StringRef S1, S2;
649 bool HasS1 = getConstantStringInfo(CI->getArgOperand(0), S1);
650 bool HasS2 = getConstantStringInfo(CI->getArgOperand(1), S2);
651
652 // strspn(s, "") -> 0
653 // strspn("", s) -> 0
654 if ((HasS1 && S1.empty()) || (HasS2 && S2.empty()))
655 return Constant::getNullValue(CI->getType());
656
657 // Constant folding.
658 if (HasS1 && HasS2) {
659 size_t Pos = S1.find_first_not_of(S2);
660 if (Pos == StringRef::npos)
661 Pos = S1.size();
662 return ConstantInt::get(CI->getType(), Pos);
663 }
664
665 return nullptr;
666}
667
668Value *LibCallSimplifier::optimizeStrCSpn(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +0000669 StringRef S1, S2;
670 bool HasS1 = getConstantStringInfo(CI->getArgOperand(0), S1);
671 bool HasS2 = getConstantStringInfo(CI->getArgOperand(1), S2);
672
673 // strcspn("", s) -> 0
674 if (HasS1 && S1.empty())
675 return Constant::getNullValue(CI->getType());
676
677 // Constant folding.
678 if (HasS1 && HasS2) {
679 size_t Pos = S1.find_first_of(S2);
680 if (Pos == StringRef::npos)
681 Pos = S1.size();
682 return ConstantInt::get(CI->getType(), Pos);
683 }
684
685 // strcspn(s, "") -> strlen(s)
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000686 if (HasS2 && S2.empty())
Sanjay Pateld3112a52016-01-19 19:46:10 +0000687 return emitStrLen(CI->getArgOperand(0), B, DL, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +0000688
689 return nullptr;
690}
691
692Value *LibCallSimplifier::optimizeStrStr(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +0000693 // fold strstr(x, x) -> x.
694 if (CI->getArgOperand(0) == CI->getArgOperand(1))
695 return B.CreateBitCast(CI->getArgOperand(0), CI->getType());
696
697 // fold strstr(a, b) == a -> strncmp(a, b, strlen(b)) == 0
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000698 if (isOnlyUsedInEqualityComparison(CI, CI->getArgOperand(0))) {
Sanjay Pateld3112a52016-01-19 19:46:10 +0000699 Value *StrLen = emitStrLen(CI->getArgOperand(1), B, DL, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +0000700 if (!StrLen)
Craig Topperf40110f2014-04-25 05:29:35 +0000701 return nullptr;
Sanjay Pateld3112a52016-01-19 19:46:10 +0000702 Value *StrNCmp = emitStrNCmp(CI->getArgOperand(0), CI->getArgOperand(1),
Chris Bienemanad070d02014-09-17 20:55:46 +0000703 StrLen, B, DL, TLI);
704 if (!StrNCmp)
Craig Topperf40110f2014-04-25 05:29:35 +0000705 return nullptr;
Chris Bienemanad070d02014-09-17 20:55:46 +0000706 for (auto UI = CI->user_begin(), UE = CI->user_end(); UI != UE;) {
707 ICmpInst *Old = cast<ICmpInst>(*UI++);
708 Value *Cmp =
709 B.CreateICmp(Old->getPredicate(), StrNCmp,
710 ConstantInt::getNullValue(StrNCmp->getType()), "cmp");
711 replaceAllUsesWith(Old, Cmp);
Meador Inge17418502012-10-13 16:45:37 +0000712 }
Chris Bienemanad070d02014-09-17 20:55:46 +0000713 return CI;
714 }
Meador Inge17418502012-10-13 16:45:37 +0000715
Chris Bienemanad070d02014-09-17 20:55:46 +0000716 // See if either input string is a constant string.
717 StringRef SearchStr, ToFindStr;
718 bool HasStr1 = getConstantStringInfo(CI->getArgOperand(0), SearchStr);
719 bool HasStr2 = getConstantStringInfo(CI->getArgOperand(1), ToFindStr);
720
721 // fold strstr(x, "") -> x.
722 if (HasStr2 && ToFindStr.empty())
723 return B.CreateBitCast(CI->getArgOperand(0), CI->getType());
724
725 // If both strings are known, constant fold it.
726 if (HasStr1 && HasStr2) {
727 size_t Offset = SearchStr.find(ToFindStr);
728
729 if (Offset == StringRef::npos) // strstr("foo", "bar") -> null
Meador Inge17418502012-10-13 16:45:37 +0000730 return Constant::getNullValue(CI->getType());
731
Chris Bienemanad070d02014-09-17 20:55:46 +0000732 // strstr("abcd", "bc") -> gep((char*)"abcd", 1)
Sanjay Pateld3112a52016-01-19 19:46:10 +0000733 Value *Result = castToCStr(CI->getArgOperand(0), B);
Chris Bienemanad070d02014-09-17 20:55:46 +0000734 Result = B.CreateConstInBoundsGEP1_64(Result, Offset, "strstr");
735 return B.CreateBitCast(Result, CI->getType());
Meador Inge17418502012-10-13 16:45:37 +0000736 }
Meador Inge17418502012-10-13 16:45:37 +0000737
Chris Bienemanad070d02014-09-17 20:55:46 +0000738 // fold strstr(x, "y") -> strchr(x, 'y').
739 if (HasStr2 && ToFindStr.size() == 1) {
Sanjay Pateld3112a52016-01-19 19:46:10 +0000740 Value *StrChr = emitStrChr(CI->getArgOperand(0), ToFindStr[0], B, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +0000741 return StrChr ? B.CreateBitCast(StrChr, CI->getType()) : nullptr;
742 }
743 return nullptr;
744}
Meador Inge40b6fac2012-10-15 03:47:37 +0000745
Benjamin Kramer691363e2015-03-21 15:36:21 +0000746Value *LibCallSimplifier::optimizeMemChr(CallInst *CI, IRBuilder<> &B) {
Benjamin Kramer691363e2015-03-21 15:36:21 +0000747 Value *SrcStr = CI->getArgOperand(0);
748 ConstantInt *CharC = dyn_cast<ConstantInt>(CI->getArgOperand(1));
749 ConstantInt *LenC = dyn_cast<ConstantInt>(CI->getArgOperand(2));
750
751 // memchr(x, y, 0) -> null
Craig Topper79ab6432017-07-06 18:39:47 +0000752 if (LenC && LenC->isZero())
Benjamin Kramer691363e2015-03-21 15:36:21 +0000753 return Constant::getNullValue(CI->getType());
754
Benjamin Kramer7857d722015-03-21 21:09:33 +0000755 // From now on we need at least constant length and string.
Benjamin Kramer691363e2015-03-21 15:36:21 +0000756 StringRef Str;
Benjamin Kramer7857d722015-03-21 21:09:33 +0000757 if (!LenC || !getConstantStringInfo(SrcStr, Str, 0, /*TrimAtNul=*/false))
Benjamin Kramer691363e2015-03-21 15:36:21 +0000758 return nullptr;
759
760 // Truncate the string to LenC. If Str is smaller than LenC we will still only
761 // scan the string, as reading past the end of it is undefined and we can just
762 // return null if we don't find the char.
763 Str = Str.substr(0, LenC->getZExtValue());
764
Benjamin Kramer7857d722015-03-21 21:09:33 +0000765 // If the char is variable but the input str and length are not we can turn
766 // this memchr call into a simple bit field test. Of course this only works
767 // when the return value is only checked against null.
768 //
769 // It would be really nice to reuse switch lowering here but we can't change
770 // the CFG at this point.
771 //
772 // memchr("\r\n", C, 2) != nullptr -> (C & ((1 << '\r') | (1 << '\n'))) != 0
773 // after bounds check.
774 if (!CharC && !Str.empty() && isOnlyUsedInZeroEqualityComparison(CI)) {
Benjamin Kramerd6aa0ec2015-03-21 22:04:26 +0000775 unsigned char Max =
776 *std::max_element(reinterpret_cast<const unsigned char *>(Str.begin()),
777 reinterpret_cast<const unsigned char *>(Str.end()));
Benjamin Kramer7857d722015-03-21 21:09:33 +0000778
779 // Make sure the bit field we're about to create fits in a register on the
780 // target.
781 // FIXME: On a 64 bit architecture this prevents us from using the
782 // interesting range of alpha ascii chars. We could do better by emitting
783 // two bitfields or shifting the range by 64 if no lower chars are used.
784 if (!DL.fitsInLegalInteger(Max + 1))
785 return nullptr;
786
787 // For the bit field use a power-of-2 type with at least 8 bits to avoid
788 // creating unnecessary illegal types.
789 unsigned char Width = NextPowerOf2(std::max((unsigned char)7, Max));
790
791 // Now build the bit field.
792 APInt Bitfield(Width, 0);
793 for (char C : Str)
794 Bitfield.setBit((unsigned char)C);
795 Value *BitfieldC = B.getInt(Bitfield);
796
797 // First check that the bit field access is within bounds.
798 Value *C = B.CreateZExtOrTrunc(CI->getArgOperand(1), BitfieldC->getType());
799 Value *Bounds = B.CreateICmp(ICmpInst::ICMP_ULT, C, B.getIntN(Width, Width),
800 "memchr.bounds");
801
802 // Create code that checks if the given bit is set in the field.
803 Value *Shl = B.CreateShl(B.getIntN(Width, 1ULL), C);
804 Value *Bits = B.CreateIsNotNull(B.CreateAnd(Shl, BitfieldC), "memchr.bits");
805
806 // Finally merge both checks and cast to pointer type. The inttoptr
807 // implicitly zexts the i1 to intptr type.
808 return B.CreateIntToPtr(B.CreateAnd(Bounds, Bits, "memchr"), CI->getType());
809 }
810
811 // Check if all arguments are constants. If so, we can constant fold.
812 if (!CharC)
813 return nullptr;
814
Benjamin Kramer691363e2015-03-21 15:36:21 +0000815 // Compute the offset.
816 size_t I = Str.find(CharC->getSExtValue() & 0xFF);
817 if (I == StringRef::npos) // Didn't find the char. memchr returns null.
818 return Constant::getNullValue(CI->getType());
819
820 // memchr(s+n,c,l) -> gep(s+n+i,c)
David Blaikie3909da72015-03-30 20:42:56 +0000821 return B.CreateGEP(B.getInt8Ty(), SrcStr, B.getInt64(I), "memchr");
Benjamin Kramer691363e2015-03-21 15:36:21 +0000822}
823
Chris Bienemanad070d02014-09-17 20:55:46 +0000824Value *LibCallSimplifier::optimizeMemCmp(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +0000825 Value *LHS = CI->getArgOperand(0), *RHS = CI->getArgOperand(1);
Meador Inge40b6fac2012-10-15 03:47:37 +0000826
Chris Bienemanad070d02014-09-17 20:55:46 +0000827 if (LHS == RHS) // memcmp(s,s,x) -> 0
828 return Constant::getNullValue(CI->getType());
Meador Inge40b6fac2012-10-15 03:47:37 +0000829
Chris Bienemanad070d02014-09-17 20:55:46 +0000830 // Make sure we have a constant length.
831 ConstantInt *LenC = dyn_cast<ConstantInt>(CI->getArgOperand(2));
832 if (!LenC)
Craig Topperf40110f2014-04-25 05:29:35 +0000833 return nullptr;
Chris Bienemanad070d02014-09-17 20:55:46 +0000834
Sanjay Patel70db4242017-06-09 14:22:03 +0000835 uint64_t Len = LenC->getZExtValue();
Chris Bienemanad070d02014-09-17 20:55:46 +0000836 if (Len == 0) // memcmp(s1,s2,0) -> 0
837 return Constant::getNullValue(CI->getType());
838
839 // memcmp(S1,S2,1) -> *(unsigned char*)LHS - *(unsigned char*)RHS
840 if (Len == 1) {
Sanjay Pateld3112a52016-01-19 19:46:10 +0000841 Value *LHSV = B.CreateZExt(B.CreateLoad(castToCStr(LHS, B), "lhsc"),
Chris Bienemanad070d02014-09-17 20:55:46 +0000842 CI->getType(), "lhsv");
Sanjay Pateld3112a52016-01-19 19:46:10 +0000843 Value *RHSV = B.CreateZExt(B.CreateLoad(castToCStr(RHS, B), "rhsc"),
Chris Bienemanad070d02014-09-17 20:55:46 +0000844 CI->getType(), "rhsv");
845 return B.CreateSub(LHSV, RHSV, "chardiff");
Meador Inge40b6fac2012-10-15 03:47:37 +0000846 }
Meador Inge40b6fac2012-10-15 03:47:37 +0000847
Chad Rosierdc655322015-08-28 18:30:18 +0000848 // memcmp(S1,S2,N/8)==0 -> (*(intN_t*)S1 != *(intN_t*)S2)==0
Sanjay Patel82ec8722017-08-21 19:13:14 +0000849 // TODO: The case where both inputs are constants does not need to be limited
850 // to legal integers or equality comparison. See block below this.
Chad Rosierdc655322015-08-28 18:30:18 +0000851 if (DL.isLegalInteger(Len * 8) && isOnlyUsedInZeroEqualityComparison(CI)) {
Chad Rosierdc655322015-08-28 18:30:18 +0000852 IntegerType *IntType = IntegerType::get(CI->getContext(), Len * 8);
853 unsigned PrefAlignment = DL.getPrefTypeAlignment(IntType);
854
Sanjay Patel82ec8722017-08-21 19:13:14 +0000855 // First, see if we can fold either argument to a constant.
856 Value *LHSV = nullptr;
857 if (auto *LHSC = dyn_cast<Constant>(LHS)) {
858 LHSC = ConstantExpr::getBitCast(LHSC, IntType->getPointerTo());
859 LHSV = ConstantFoldLoadFromConstPtr(LHSC, IntType, DL);
860 }
861 Value *RHSV = nullptr;
862 if (auto *RHSC = dyn_cast<Constant>(RHS)) {
863 RHSC = ConstantExpr::getBitCast(RHSC, IntType->getPointerTo());
864 RHSV = ConstantFoldLoadFromConstPtr(RHSC, IntType, DL);
865 }
Chad Rosierdc655322015-08-28 18:30:18 +0000866
Sanjay Patel82ec8722017-08-21 19:13:14 +0000867 // Don't generate unaligned loads. If either source is constant data,
868 // alignment doesn't matter for that source because there is no load.
869 if ((LHSV || getKnownAlignment(LHS, DL, CI) >= PrefAlignment) &&
870 (RHSV || getKnownAlignment(RHS, DL, CI) >= PrefAlignment)) {
871 if (!LHSV) {
872 Type *LHSPtrTy =
873 IntType->getPointerTo(LHS->getType()->getPointerAddressSpace());
874 LHSV = B.CreateLoad(B.CreateBitCast(LHS, LHSPtrTy), "lhsv");
875 }
876 if (!RHSV) {
877 Type *RHSPtrTy =
878 IntType->getPointerTo(RHS->getType()->getPointerAddressSpace());
879 RHSV = B.CreateLoad(B.CreateBitCast(RHS, RHSPtrTy), "rhsv");
880 }
Sanjay Patel7756edf2017-08-21 13:55:49 +0000881 return B.CreateZExt(B.CreateICmpNE(LHSV, RHSV), CI->getType(), "memcmp");
Sanjay Patel707f7862017-08-21 15:16:25 +0000882 }
Chad Rosierdc655322015-08-28 18:30:18 +0000883 }
884
Sanjay Patel82ec8722017-08-21 19:13:14 +0000885 // Constant folding: memcmp(x, y, Len) -> constant (all arguments are const).
886 // TODO: This is limited to i8 arrays.
Chris Bienemanad070d02014-09-17 20:55:46 +0000887 StringRef LHSStr, RHSStr;
888 if (getConstantStringInfo(LHS, LHSStr) &&
889 getConstantStringInfo(RHS, RHSStr)) {
890 // Make sure we're not reading out-of-bounds memory.
891 if (Len > LHSStr.size() || Len > RHSStr.size())
Craig Topperf40110f2014-04-25 05:29:35 +0000892 return nullptr;
Chris Bienemanad070d02014-09-17 20:55:46 +0000893 // Fold the memcmp and normalize the result. This way we get consistent
894 // results across multiple platforms.
895 uint64_t Ret = 0;
896 int Cmp = memcmp(LHSStr.data(), RHSStr.data(), Len);
897 if (Cmp < 0)
898 Ret = -1;
899 else if (Cmp > 0)
900 Ret = 1;
901 return ConstantInt::get(CI->getType(), Ret);
Meador Inge000dbcc2012-10-18 18:12:40 +0000902 }
Meador Inge000dbcc2012-10-18 18:12:40 +0000903
Chris Bienemanad070d02014-09-17 20:55:46 +0000904 return nullptr;
905}
Meador Inge9a6a1902012-10-31 00:20:56 +0000906
Chris Bienemanad070d02014-09-17 20:55:46 +0000907Value *LibCallSimplifier::optimizeMemCpy(CallInst *CI, IRBuilder<> &B) {
Daniel Neilson8acd8b02018-02-05 21:23:22 +0000908 // memcpy(x, y, n) -> llvm.memcpy(align 1 x, align 1 y, n)
909 B.CreateMemCpy(CI->getArgOperand(0), 1, CI->getArgOperand(1), 1,
910 CI->getArgOperand(2));
Chris Bienemanad070d02014-09-17 20:55:46 +0000911 return CI->getArgOperand(0);
912}
Meador Inge05a625a2012-10-31 14:58:26 +0000913
Chris Bienemanad070d02014-09-17 20:55:46 +0000914Value *LibCallSimplifier::optimizeMemMove(CallInst *CI, IRBuilder<> &B) {
Daniel Neilson8acd8b02018-02-05 21:23:22 +0000915 // memmove(x, y, n) -> llvm.memmove(align 1 x, align 1 y, n)
916 B.CreateMemMove(CI->getArgOperand(0), 1, CI->getArgOperand(1), 1,
917 CI->getArgOperand(2));
Chris Bienemanad070d02014-09-17 20:55:46 +0000918 return CI->getArgOperand(0);
919}
Meador Ingebcd88ef72012-11-10 15:16:48 +0000920
Sanjay Patel980b2802016-01-26 16:17:24 +0000921/// Fold memset[_chk](malloc(n), 0, n) --> calloc(1, n).
922static Value *foldMallocMemset(CallInst *Memset, IRBuilder<> &B,
923 const TargetLibraryInfo &TLI) {
924 // This has to be a memset of zeros (bzero).
925 auto *FillValue = dyn_cast<ConstantInt>(Memset->getArgOperand(1));
926 if (!FillValue || FillValue->getZExtValue() != 0)
927 return nullptr;
928
929 // TODO: We should handle the case where the malloc has more than one use.
930 // This is necessary to optimize common patterns such as when the result of
931 // the malloc is checked against null or when a memset intrinsic is used in
932 // place of a memset library call.
933 auto *Malloc = dyn_cast<CallInst>(Memset->getArgOperand(0));
934 if (!Malloc || !Malloc->hasOneUse())
935 return nullptr;
936
937 // Is the inner call really malloc()?
938 Function *InnerCallee = Malloc->getCalledFunction();
Matthias Braunc36a78c2017-04-25 19:44:25 +0000939 if (!InnerCallee)
940 return nullptr;
941
David L. Jonesd21529f2017-01-23 23:16:46 +0000942 LibFunc Func;
Ahmed Bougachad765a822016-04-27 19:04:35 +0000943 if (!TLI.getLibFunc(*InnerCallee, Func) || !TLI.has(Func) ||
David L. Jonesd21529f2017-01-23 23:16:46 +0000944 Func != LibFunc_malloc)
Sanjay Patel980b2802016-01-26 16:17:24 +0000945 return nullptr;
946
Sanjay Patel980b2802016-01-26 16:17:24 +0000947 // The memset must cover the same number of bytes that are malloc'd.
948 if (Memset->getArgOperand(2) != Malloc->getArgOperand(0))
949 return nullptr;
950
951 // Replace the malloc with a calloc. We need the data layout to know what the
Fangrui Songf78650a2018-07-30 19:41:25 +0000952 // actual size of a 'size_t' parameter is.
Sanjay Patel980b2802016-01-26 16:17:24 +0000953 B.SetInsertPoint(Malloc->getParent(), ++Malloc->getIterator());
954 const DataLayout &DL = Malloc->getModule()->getDataLayout();
955 IntegerType *SizeType = DL.getIntPtrType(B.GetInsertBlock()->getContext());
956 Value *Calloc = emitCalloc(ConstantInt::get(SizeType, 1),
957 Malloc->getArgOperand(0), Malloc->getAttributes(),
958 B, TLI);
959 if (!Calloc)
960 return nullptr;
961
962 Malloc->replaceAllUsesWith(Calloc);
963 Malloc->eraseFromParent();
964
965 return Calloc;
966}
967
Chris Bienemanad070d02014-09-17 20:55:46 +0000968Value *LibCallSimplifier::optimizeMemSet(CallInst *CI, IRBuilder<> &B) {
Sanjay Patel980b2802016-01-26 16:17:24 +0000969 if (auto *Calloc = foldMallocMemset(CI, B, *TLI))
970 return Calloc;
971
Daniel Neilson8acd8b02018-02-05 21:23:22 +0000972 // memset(p, v, n) -> llvm.memset(align 1 p, v, n)
Chris Bienemanad070d02014-09-17 20:55:46 +0000973 Value *Val = B.CreateIntCast(CI->getArgOperand(1), B.getInt8Ty(), false);
974 B.CreateMemSet(CI->getArgOperand(0), Val, CI->getArgOperand(2), 1);
975 return CI->getArgOperand(0);
976}
Meador Inged4825782012-11-11 06:49:03 +0000977
Sanjay Patelb2ab3f22018-04-18 14:21:31 +0000978Value *LibCallSimplifier::optimizeRealloc(CallInst *CI, IRBuilder<> &B) {
979 if (isa<ConstantPointerNull>(CI->getArgOperand(0)))
980 return emitMalloc(CI->getArgOperand(1), B, DL, TLI);
981
982 return nullptr;
983}
984
Meador Inge193e0352012-11-13 04:16:17 +0000985//===----------------------------------------------------------------------===//
986// Math Library Optimizations
987//===----------------------------------------------------------------------===//
988
Evandro Menezes5aa217a2018-08-03 17:50:16 +0000989// Replace a libcall \p CI with a call to intrinsic \p IID
990static Value *replaceUnaryCall(CallInst *CI, IRBuilder<> &B, Intrinsic::ID IID) {
991 // Propagate fast-math flags from the existing call to the new call.
992 IRBuilder<>::FastMathFlagGuard Guard(B);
993 B.setFastMathFlags(CI->getFastMathFlags());
994
995 Module *M = CI->getModule();
996 Value *V = CI->getArgOperand(0);
997 Function *F = Intrinsic::getDeclaration(M, IID, CI->getType());
998 CallInst *NewCall = B.CreateCall(F, V);
999 NewCall->takeName(CI);
1000 return NewCall;
1001}
1002
Matthias Braund34e4d22014-12-03 21:46:33 +00001003/// Return a variant of Val with float type.
1004/// Currently this works in two cases: If Val is an FPExtension of a float
1005/// value to something bigger, simply return the operand.
1006/// If Val is a ConstantFP but can be converted to a float ConstantFP without
1007/// loss of precision do so.
1008static Value *valueHasFloatPrecision(Value *Val) {
1009 if (FPExtInst *Cast = dyn_cast<FPExtInst>(Val)) {
1010 Value *Op = Cast->getOperand(0);
1011 if (Op->getType()->isFloatTy())
1012 return Op;
1013 }
1014 if (ConstantFP *Const = dyn_cast<ConstantFP>(Val)) {
1015 APFloat F = Const->getValueAPF();
Matthias Braun395a82f2014-12-03 22:10:39 +00001016 bool losesInfo;
Stephan Bergmann17c7f702016-12-14 11:57:17 +00001017 (void)F.convert(APFloat::IEEEsingle(), APFloat::rmNearestTiesToEven,
Matthias Braun395a82f2014-12-03 22:10:39 +00001018 &losesInfo);
1019 if (!losesInfo)
Matthias Braund34e4d22014-12-03 21:46:33 +00001020 return ConstantFP::get(Const->getContext(), F);
1021 }
1022 return nullptr;
1023}
1024
Evandro Menezes5aa217a2018-08-03 17:50:16 +00001025/// Shrink double -> float functions.
1026static Value *optimizeDoubleFP(CallInst *CI, IRBuilder<> &B,
Evandro Menezes6e137cb2018-08-06 19:40:17 +00001027 bool isBinary, bool isPrecise = false) {
Ahmed Bougachad765a822016-04-27 19:04:35 +00001028 if (!CI->getType()->isDoubleTy())
Chris Bienemanad070d02014-09-17 20:55:46 +00001029 return nullptr;
Meador Inge193e0352012-11-13 04:16:17 +00001030
Evandro Menezes6e137cb2018-08-06 19:40:17 +00001031 // If not all the uses of the function are converted to float, then bail out.
1032 // This matters if the precision of the result is more important than the
1033 // precision of the arguments.
1034 if (isPrecise)
Chris Bienemanad070d02014-09-17 20:55:46 +00001035 for (User *U : CI->users()) {
1036 FPTruncInst *Cast = dyn_cast<FPTruncInst>(U);
1037 if (!Cast || !Cast->getType()->isFloatTy())
1038 return nullptr;
Meador Inge193e0352012-11-13 04:16:17 +00001039 }
Chris Bienemanad070d02014-09-17 20:55:46 +00001040
Evandro Menezes5aa217a2018-08-03 17:50:16 +00001041 // If this is something like 'g((double) float)', convert to 'gf(float)'.
1042 Value *V[2];
1043 V[0] = valueHasFloatPrecision(CI->getArgOperand(0));
1044 V[1] = isBinary ? valueHasFloatPrecision(CI->getArgOperand(1)) : nullptr;
1045 if (!V[0] || (isBinary && !V[1]))
Chris Bienemanad070d02014-09-17 20:55:46 +00001046 return nullptr;
Fangrui Songf78650a2018-07-30 19:41:25 +00001047
Andrew Ng1606fc02017-04-25 12:36:14 +00001048 // If call isn't an intrinsic, check that it isn't within a function with the
Evandro Menezes5aa217a2018-08-03 17:50:16 +00001049 // same name as the float version of this call, otherwise the result is an
1050 // infinite loop. For example, from MinGW-w64:
Andrew Ng1606fc02017-04-25 12:36:14 +00001051 //
Evandro Menezes5aa217a2018-08-03 17:50:16 +00001052 // float expf(float val) { return (float) exp((double) val); }
1053 Function *CalleeFn = CI->getCalledFunction();
1054 StringRef CalleeNm = CalleeFn->getName();
1055 AttributeList CalleeAt = CalleeFn->getAttributes();
1056 if (CalleeFn && !CalleeFn->isIntrinsic()) {
1057 const Function *Fn = CI->getFunction();
1058 StringRef FnName = Fn->getName();
1059 if (FnName.back() == 'f' &&
1060 FnName.size() == (CalleeNm.size() + 1) &&
1061 FnName.startswith(CalleeNm))
Andrew Ng1606fc02017-04-25 12:36:14 +00001062 return nullptr;
1063 }
1064
Evandro Menezes5aa217a2018-08-03 17:50:16 +00001065 // Propagate the math semantics from the current function to the new function.
Sanjay Patelaa231142015-12-31 21:52:31 +00001066 IRBuilder<>::FastMathFlagGuard Guard(B);
Sanjay Patela2528152016-01-12 18:03:37 +00001067 B.setFastMathFlags(CI->getFastMathFlags());
Chris Bienemanad070d02014-09-17 20:55:46 +00001068
Evandro Menezes5aa217a2018-08-03 17:50:16 +00001069 // g((double) float) -> (double) gf(float)
1070 Value *R;
1071 if (CalleeFn->isIntrinsic()) {
Sanjay Patelaf674fb2015-12-14 17:24:23 +00001072 Module *M = CI->getModule();
Evandro Menezes5aa217a2018-08-03 17:50:16 +00001073 Intrinsic::ID IID = CalleeFn->getIntrinsicID();
1074 Function *Fn = Intrinsic::getDeclaration(M, IID, B.getFloatTy());
1075 R = isBinary ? B.CreateCall(Fn, V) : B.CreateCall(Fn, V[0]);
Sanjay Patel848309d2014-10-23 21:52:45 +00001076 }
Evandro Menezes5aa217a2018-08-03 17:50:16 +00001077 else
1078 R = isBinary ? emitBinaryFloatFnCall(V[0], V[1], CalleeNm, B, CalleeAt)
1079 : emitUnaryFloatFnCall(V[0], CalleeNm, B, CalleeAt);
Sanjay Patel848309d2014-10-23 21:52:45 +00001080
Evandro Menezes5aa217a2018-08-03 17:50:16 +00001081 return B.CreateFPExt(R, B.getDoubleTy());
Chris Bienemanad070d02014-09-17 20:55:46 +00001082}
Meador Inge193e0352012-11-13 04:16:17 +00001083
Evandro Menezes5aa217a2018-08-03 17:50:16 +00001084/// Shrink double -> float for unary functions.
1085static Value *optimizeUnaryDoubleFP(CallInst *CI, IRBuilder<> &B,
Evandro Menezes6e137cb2018-08-06 19:40:17 +00001086 bool isPrecise = false) {
1087 return optimizeDoubleFP(CI, B, false, isPrecise);
Matt Arsenault954a6242017-01-23 23:55:08 +00001088}
1089
Evandro Menezes5aa217a2018-08-03 17:50:16 +00001090/// Shrink double -> float for binary functions.
1091static Value *optimizeBinaryDoubleFP(CallInst *CI, IRBuilder<> &B,
Evandro Menezes6e137cb2018-08-06 19:40:17 +00001092 bool isPrecise = false) {
1093 return optimizeDoubleFP(CI, B, true, isPrecise);
Chris Bienemanad070d02014-09-17 20:55:46 +00001094}
1095
Hal Finkel2ff24732017-12-16 01:26:25 +00001096// cabs(z) -> sqrt((creal(z)*creal(z)) + (cimag(z)*cimag(z)))
1097Value *LibCallSimplifier::optimizeCAbs(CallInst *CI, IRBuilder<> &B) {
1098 if (!CI->isFast())
1099 return nullptr;
1100
1101 // Propagate fast-math flags from the existing call to new instructions.
1102 IRBuilder<>::FastMathFlagGuard Guard(B);
1103 B.setFastMathFlags(CI->getFastMathFlags());
1104
1105 Value *Real, *Imag;
1106 if (CI->getNumArgOperands() == 1) {
1107 Value *Op = CI->getArgOperand(0);
1108 assert(Op->getType()->isArrayTy() && "Unexpected signature for cabs!");
1109 Real = B.CreateExtractValue(Op, 0, "real");
1110 Imag = B.CreateExtractValue(Op, 1, "imag");
1111 } else {
1112 assert(CI->getNumArgOperands() == 2 && "Unexpected signature for cabs!");
1113 Real = CI->getArgOperand(0);
1114 Imag = CI->getArgOperand(1);
1115 }
1116
1117 Value *RealReal = B.CreateFMul(Real, Real);
1118 Value *ImagImag = B.CreateFMul(Imag, Imag);
1119
1120 Function *FSqrt = Intrinsic::getDeclaration(CI->getModule(), Intrinsic::sqrt,
1121 CI->getType());
1122 return B.CreateCall(FSqrt, B.CreateFAdd(RealReal, ImagImag), "cabs");
1123}
1124
Chris Bienemanad070d02014-09-17 20:55:46 +00001125Value *LibCallSimplifier::optimizeCos(CallInst *CI, IRBuilder<> &B) {
1126 Function *Callee = CI->getCalledFunction();
Davide Italianoa3458772015-11-05 19:18:23 +00001127 StringRef Name = Callee->getName();
1128 if (UnsafeFPShrink && Name == "cos" && hasFloatVersion(Name))
Sanjay Patelce4ddbe2018-08-13 17:40:49 +00001129 if (Value *V = optimizeUnaryDoubleFP(CI, B, true))
1130 return V;
Bob Wilsond8d92d92013-11-03 06:48:38 +00001131
Sanjay Patelce4ddbe2018-08-13 17:40:49 +00001132 // cos(-X) -> cos(X)
1133 Value *X;
1134 if (match(CI->getArgOperand(0), m_FNeg(m_Value(X))))
1135 return B.CreateCall(Callee, X, "cos");
1136
1137 return nullptr;
Chris Bienemanad070d02014-09-17 20:55:46 +00001138}
Bob Wilsond8d92d92013-11-03 06:48:38 +00001139
Weiming Zhao82130722015-12-04 22:00:47 +00001140static Value *getPow(Value *InnerChain[33], unsigned Exp, IRBuilder<> &B) {
1141 // Multiplications calculated using Addition Chains.
1142 // Refer: http://wwwhomes.uni-bielefeld.de/achim/addition_chain.html
1143
1144 assert(Exp != 0 && "Incorrect exponent 0 not handled");
1145
1146 if (InnerChain[Exp])
1147 return InnerChain[Exp];
1148
1149 static const unsigned AddChain[33][2] = {
1150 {0, 0}, // Unused.
1151 {0, 0}, // Unused (base case = pow1).
1152 {1, 1}, // Unused (pre-computed).
1153 {1, 2}, {2, 2}, {2, 3}, {3, 3}, {2, 5}, {4, 4},
1154 {1, 8}, {5, 5}, {1, 10}, {6, 6}, {4, 9}, {7, 7},
1155 {3, 12}, {8, 8}, {8, 9}, {2, 16}, {1, 18}, {10, 10},
1156 {6, 15}, {11, 11}, {3, 20}, {12, 12}, {8, 17}, {13, 13},
1157 {3, 24}, {14, 14}, {4, 25}, {15, 15}, {3, 28}, {16, 16},
1158 };
1159
1160 InnerChain[Exp] = B.CreateFMul(getPow(InnerChain, AddChain[Exp][0], B),
1161 getPow(InnerChain, AddChain[Exp][1], B));
1162 return InnerChain[Exp];
1163}
1164
Sanjay Patelfbd3e662017-11-19 16:13:14 +00001165/// Use square root in place of pow(x, +/-0.5).
1166Value *LibCallSimplifier::replacePowWithSqrt(CallInst *Pow, IRBuilder<> &B) {
1167 // TODO: There is some subset of 'fast' under which these transforms should
1168 // be allowed.
1169 if (!Pow->isFast())
1170 return nullptr;
1171
Evandro Menezesa7d48282018-07-30 16:20:04 +00001172 Value *Sqrt, *Base = Pow->getArgOperand(0), *Expo = Pow->getArgOperand(1);
Sanjay Patelfbd3e662017-11-19 16:13:14 +00001173 Type *Ty = Pow->getType();
Sanjay Patelfbd3e662017-11-19 16:13:14 +00001174
Evandro Menezesa7d48282018-07-30 16:20:04 +00001175 const APFloat *ExpoF;
1176 if (!match(Expo, m_APFloat(ExpoF)) ||
1177 (!ExpoF->isExactlyValue(0.5) && !ExpoF->isExactlyValue(-0.5)))
1178 return nullptr;
1179
1180 // If errno is never set, then use the intrinsic for sqrt().
1181 if (Pow->hasFnAttr(Attribute::ReadNone)) {
Evandro Menezesa7d48282018-07-30 16:20:04 +00001182 Function *SqrtFn = Intrinsic::getDeclaration(Pow->getModule(),
1183 Intrinsic::sqrt, Ty);
1184 Sqrt = B.CreateCall(SqrtFn, Base);
1185 }
1186 // Otherwise, use the libcall for sqrt().
Evandro Menezes61e4e402018-07-31 22:11:02 +00001187 else if (hasUnaryFloatFn(TLI, Ty, LibFunc_sqrt, LibFunc_sqrtf, LibFunc_sqrtl))
Evandro Menezesa7d48282018-07-30 16:20:04 +00001188 // TODO: We also should check that the target can in fact lower the sqrt()
1189 // libcall. We currently have no way to ask this question, so we ask if
1190 // the target has a sqrt() libcall, which is not exactly the same.
1191 Sqrt = emitUnaryFloatFnCall(Base, TLI->getName(LibFunc_sqrt), B,
1192 Pow->getCalledFunction()->getAttributes());
Evandro Menezes61e4e402018-07-31 22:11:02 +00001193 else
Evandro Menezesa7d48282018-07-30 16:20:04 +00001194 return nullptr;
1195
Evandro Menezes61e4e402018-07-31 22:11:02 +00001196 // If the exponent is negative, then get the reciprocal.
Evandro Menezesa7d48282018-07-30 16:20:04 +00001197 if (ExpoF->isNegative())
1198 Sqrt = B.CreateFDiv(ConstantFP::get(Ty, 1.0), Sqrt, "reciprocal");
Sanjay Patelfbd3e662017-11-19 16:13:14 +00001199
1200 return Sqrt;
1201}
1202
Evandro Menezesa7d48282018-07-30 16:20:04 +00001203Value *LibCallSimplifier::optimizePow(CallInst *Pow, IRBuilder<> &B) {
1204 Value *Base = Pow->getArgOperand(0), *Expo = Pow->getArgOperand(1);
1205 Function *Callee = Pow->getCalledFunction();
1206 AttributeList Attrs = Callee->getAttributes();
Davide Italianoa3458772015-11-05 19:18:23 +00001207 StringRef Name = Callee->getName();
Evandro Menezesa7d48282018-07-30 16:20:04 +00001208 Module *Module = Pow->getModule();
1209 Type *Ty = Pow->getType();
1210 Value *Shrunk = nullptr;
1211 bool Ignored;
Bob Wilsond8d92d92013-11-03 06:48:38 +00001212
Evandro Menezes5ecd6c12018-08-13 16:12:37 +00001213 // Bail out if simplifying libcalls to pow() is disabled.
1214 if (!hasUnaryFloatFn(TLI, Ty, LibFunc_pow, LibFunc_powf, LibFunc_powl))
1215 return nullptr;
1216
Evandro Menezes61e4e402018-07-31 22:11:02 +00001217 // Propagate the math semantics from the call to any created instructions.
Evandro Menezesa7d48282018-07-30 16:20:04 +00001218 IRBuilder<>::FastMathFlagGuard Guard(B);
1219 B.setFastMathFlags(Pow->getFastMathFlags());
1220
Evandro Menezes6e137cb2018-08-06 19:40:17 +00001221 // Shrink pow() to powf() if the arguments are single precision,
1222 // unless the result is expected to be double precision.
1223 if (UnsafeFPShrink &&
1224 Name == TLI->getName(LibFunc_pow) && hasFloatVersion(Name))
1225 Shrunk = optimizeBinaryDoubleFP(Pow, B, true);
1226
Evandro Menezesa7d48282018-07-30 16:20:04 +00001227 // Evaluate special cases related to the base.
Davide Italiano27da1312016-08-07 20:27:03 +00001228
1229 // pow(1.0, x) -> 1.0
Evandro Menezes84e74362018-08-02 15:43:57 +00001230 if (match(Base, m_FPOne()))
Evandro Menezesa7d48282018-07-30 16:20:04 +00001231 return Base;
1232
1233 // pow(2.0, x) -> exp2(x)
1234 if (match(Base, m_SpecificFP(2.0))) {
1235 Value *Exp2 = Intrinsic::getDeclaration(Module, Intrinsic::exp2, Ty);
1236 return B.CreateCall(Exp2, Expo, "exp2");
Davide Italiano27da1312016-08-07 20:27:03 +00001237 }
1238
Evandro Menezes61e4e402018-07-31 22:11:02 +00001239 // pow(10.0, x) -> exp10(x)
1240 if (ConstantFP *BaseC = dyn_cast<ConstantFP>(Base))
1241 // There's no exp10 intrinsic yet, but, maybe, some day there shall be one.
Evandro Menezesa7d48282018-07-30 16:20:04 +00001242 if (BaseC->isExactlyValue(10.0) &&
1243 hasUnaryFloatFn(TLI, Ty, LibFunc_exp10, LibFunc_exp10f, LibFunc_exp10l))
1244 return emitUnaryFloatFnCall(Expo, TLI->getName(LibFunc_exp10), B, Attrs);
Bob Wilsond8d92d92013-11-03 06:48:38 +00001245
Sanjay Patel6002e782016-01-12 17:30:37 +00001246 // pow(exp(x), y) -> exp(x * y)
Davide Italianoc8a79132015-11-03 20:32:23 +00001247 // pow(exp2(x), y) -> exp2(x * y)
Sanjay Patel6002e782016-01-12 17:30:37 +00001248 // We enable these only with fast-math. Besides rounding differences, the
1249 // transformation changes overflow and underflow behavior quite dramatically.
Davide Italianoc8a79132015-11-03 20:32:23 +00001250 // Example: x = 1000, y = 0.001.
1251 // pow(exp(x), y) = pow(inf, 0.001) = inf, whereas exp(x*y) = exp(1).
Evandro Menezesa7d48282018-07-30 16:20:04 +00001252 auto *BaseFn = dyn_cast<CallInst>(Base);
1253 if (BaseFn && BaseFn->isFast() && Pow->isFast()) {
1254 LibFunc LibFn;
1255 Function *CalleeFn = BaseFn->getCalledFunction();
1256 if (CalleeFn && TLI->getLibFunc(CalleeFn->getName(), LibFn) &&
1257 (LibFn == LibFunc_exp || LibFn == LibFunc_exp2) && TLI->has(LibFn)) {
Evandro Menezesa7d48282018-07-30 16:20:04 +00001258 Value *FMul = B.CreateFMul(BaseFn->getArgOperand(0), Expo, "mul");
1259 return emitUnaryFloatFnCall(FMul, CalleeFn->getName(), B,
1260 CalleeFn->getAttributes());
Davide Italianoc8a79132015-11-03 20:32:23 +00001261 }
1262 }
1263
Evandro Menezesa7d48282018-07-30 16:20:04 +00001264 // Evaluate special cases related to the exponent.
1265
Evandro Menezesa7d48282018-07-30 16:20:04 +00001266 // pow(x, -1.0) -> 1.0 / x
Evandro Menezes5ecd6c12018-08-13 16:12:37 +00001267 if (match(Expo, m_SpecificFP(-1.0)))
Evandro Menezesa7d48282018-07-30 16:20:04 +00001268 return B.CreateFDiv(ConstantFP::get(Ty, 1.0), Base, "reciprocal");
1269
1270 // pow(x, 0.0) -> 1.0
Evandro Menezes5ecd6c12018-08-13 16:12:37 +00001271 if (match(Expo, m_SpecificFP(0.0)))
1272 return ConstantFP::get(Ty, 1.0);
Evandro Menezesa7d48282018-07-30 16:20:04 +00001273
1274 // pow(x, 1.0) -> x
Evandro Menezes5ecd6c12018-08-13 16:12:37 +00001275 if (match(Expo, m_FPOne()))
Evandro Menezesa7d48282018-07-30 16:20:04 +00001276 return Base;
1277
1278 // pow(x, 2.0) -> x * x
Evandro Menezes5ecd6c12018-08-13 16:12:37 +00001279 if (match(Expo, m_SpecificFP(2.0)))
Evandro Menezesa7d48282018-07-30 16:20:04 +00001280 return B.CreateFMul(Base, Base, "square");
Chris Bienemanad070d02014-09-17 20:55:46 +00001281
Evandro Menezes5ecd6c12018-08-13 16:12:37 +00001282 if (Value *Sqrt = replacePowWithSqrt(Pow, B))
1283 return Sqrt;
1284
Sanjay Patelfbd3e662017-11-19 16:13:14 +00001285 // FIXME: Correct the transforms and pull this into replacePowWithSqrt().
Evandro Menezes5ecd6c12018-08-13 16:12:37 +00001286 ConstantFP *ExpoC = dyn_cast<ConstantFP>(Expo);
1287 if (ExpoC && ExpoC->isExactlyValue(0.5) &&
Evandro Menezesa7d48282018-07-30 16:20:04 +00001288 hasUnaryFloatFn(TLI, Ty, LibFunc_sqrt, LibFunc_sqrtf, LibFunc_sqrtl)) {
Chris Bienemanad070d02014-09-17 20:55:46 +00001289 // Expand pow(x, 0.5) to (x == -infinity ? +infinity : fabs(sqrt(x))).
Evandro Menezes61e4e402018-07-31 22:11:02 +00001290 // This is faster than calling pow(), and still handles -0.0 and
1291 // negative infinity correctly.
Chris Bienemanad070d02014-09-17 20:55:46 +00001292 // TODO: In finite-only mode, this could be just fabs(sqrt(x)).
Evandro Menezesa7d48282018-07-30 16:20:04 +00001293 Value *PosInf = ConstantFP::getInfinity(Ty);
1294 Value *NegInf = ConstantFP::getInfinity(Ty, true);
Justin Lebarcb9b41d2017-01-27 00:58:03 +00001295
Evandro Menezesa7d48282018-07-30 16:20:04 +00001296 // TODO: As above, we should lower to the sqrt() intrinsic if the pow() is
1297 // an intrinsic, to match errno semantics.
1298 Value *Sqrt = emitUnaryFloatFnCall(Base, TLI->getName(LibFunc_sqrt),
1299 B, Attrs);
Evandro Menezes61e4e402018-07-31 22:11:02 +00001300 Function *FAbsFn = Intrinsic::getDeclaration(Module, Intrinsic::fabs, Ty);
1301 Value *FAbs = B.CreateCall(FAbsFn, Sqrt, "abs");
Evandro Menezesa7d48282018-07-30 16:20:04 +00001302 Value *FCmp = B.CreateFCmpOEQ(Base, NegInf, "isinf");
Evandro Menezes61e4e402018-07-31 22:11:02 +00001303 Sqrt = B.CreateSelect(FCmp, PosInf, FAbs);
1304 return Sqrt;
Bob Wilsond8d92d92013-11-03 06:48:38 +00001305 }
1306
Evandro Menezes5ecd6c12018-08-13 16:12:37 +00001307 // pow(x, n) -> x * x * x * ...
1308 const APFloat *ExpoF;
1309 if (Pow->isFast() && match(Expo, m_APFloat(ExpoF))) {
1310 // We limit to a max of 7 multiplications, thus the maximum exponent is 32.
1311 APFloat LimF(ExpoF->getSemantics(), 33.0),
1312 ExpoA(abs(*ExpoF));
1313 if (ExpoA.isInteger() && ExpoA.compare(LimF) == APFloat::cmpLessThan) {
1314 // We will memoize intermediate products of the Addition Chain.
1315 Value *InnerChain[33] = {nullptr};
1316 InnerChain[1] = Base;
1317 InnerChain[2] = B.CreateFMul(Base, Base, "square");
Weiming Zhao82130722015-12-04 22:00:47 +00001318
Evandro Menezes5ecd6c12018-08-13 16:12:37 +00001319 // We cannot readily convert a non-double type (like float) to a double.
1320 // So we first convert it to something which could be converted to double.
1321 ExpoA.convert(APFloat::IEEEdouble(), APFloat::rmTowardZero, &Ignored);
1322 Value *FMul = getPow(InnerChain, ExpoA.convertToDouble(), B);
Weiming Zhao82130722015-12-04 22:00:47 +00001323
Evandro Menezes5ecd6c12018-08-13 16:12:37 +00001324 // If the exponent is negative, then get the reciprocal.
1325 if (ExpoF->isNegative())
1326 FMul = B.CreateFDiv(ConstantFP::get(Ty, 1.0), FMul, "reciprocal");
Evandro Menezes61e4e402018-07-31 22:11:02 +00001327
Evandro Menezes5ecd6c12018-08-13 16:12:37 +00001328 return FMul;
1329 }
Weiming Zhao82130722015-12-04 22:00:47 +00001330 }
1331
Evandro Menezes6e137cb2018-08-06 19:40:17 +00001332 return Shrunk;
Chris Bienemanad070d02014-09-17 20:55:46 +00001333}
Bob Wilsond8d92d92013-11-03 06:48:38 +00001334
Chris Bienemanad070d02014-09-17 20:55:46 +00001335Value *LibCallSimplifier::optimizeExp2(CallInst *CI, IRBuilder<> &B) {
1336 Function *Callee = CI->getCalledFunction();
Chris Bienemanad070d02014-09-17 20:55:46 +00001337 Value *Ret = nullptr;
Davide Italianoa3458772015-11-05 19:18:23 +00001338 StringRef Name = Callee->getName();
1339 if (UnsafeFPShrink && Name == "exp2" && hasFloatVersion(Name))
Chris Bienemanad070d02014-09-17 20:55:46 +00001340 Ret = optimizeUnaryDoubleFP(CI, B, true);
Bob Wilsond8d92d92013-11-03 06:48:38 +00001341
Chris Bienemanad070d02014-09-17 20:55:46 +00001342 Value *Op = CI->getArgOperand(0);
1343 // Turn exp2(sitofp(x)) -> ldexp(1.0, sext(x)) if sizeof(x) <= 32
1344 // Turn exp2(uitofp(x)) -> ldexp(1.0, zext(x)) if sizeof(x) < 32
David L. Jonesd21529f2017-01-23 23:16:46 +00001345 LibFunc LdExp = LibFunc_ldexpl;
Chris Bienemanad070d02014-09-17 20:55:46 +00001346 if (Op->getType()->isFloatTy())
David L. Jonesd21529f2017-01-23 23:16:46 +00001347 LdExp = LibFunc_ldexpf;
Chris Bienemanad070d02014-09-17 20:55:46 +00001348 else if (Op->getType()->isDoubleTy())
David L. Jonesd21529f2017-01-23 23:16:46 +00001349 LdExp = LibFunc_ldexp;
Chris Bienemanad070d02014-09-17 20:55:46 +00001350
1351 if (TLI->has(LdExp)) {
1352 Value *LdExpArg = nullptr;
1353 if (SIToFPInst *OpC = dyn_cast<SIToFPInst>(Op)) {
1354 if (OpC->getOperand(0)->getType()->getPrimitiveSizeInBits() <= 32)
1355 LdExpArg = B.CreateSExt(OpC->getOperand(0), B.getInt32Ty());
1356 } else if (UIToFPInst *OpC = dyn_cast<UIToFPInst>(Op)) {
1357 if (OpC->getOperand(0)->getType()->getPrimitiveSizeInBits() < 32)
1358 LdExpArg = B.CreateZExt(OpC->getOperand(0), B.getInt32Ty());
1359 }
1360
1361 if (LdExpArg) {
1362 Constant *One = ConstantFP::get(CI->getContext(), APFloat(1.0f));
1363 if (!Op->getType()->isFloatTy())
1364 One = ConstantExpr::getFPExtend(One, Op->getType());
1365
Sanjay Patel0e603fc2016-01-21 22:31:18 +00001366 Module *M = CI->getModule();
Mehdi Aminidb11fdf2017-04-06 20:23:57 +00001367 Value *NewCallee =
1368 M->getOrInsertFunction(TLI->getName(LdExp), Op->getType(),
Serge Guelton59a2d7b2017-04-11 15:01:18 +00001369 Op->getType(), B.getInt32Ty());
Sanjay Patel042aed902016-01-21 22:41:16 +00001370 CallInst *CI = B.CreateCall(NewCallee, {One, LdExpArg});
Chris Bienemanad070d02014-09-17 20:55:46 +00001371 if (const Function *F = dyn_cast<Function>(Callee->stripPointerCasts()))
1372 CI->setCallingConv(F->getCallingConv());
1373
1374 return CI;
1375 }
1376 }
1377 return Ret;
1378}
1379
Sanjay Patel57fd1dc2015-08-16 20:18:19 +00001380Value *LibCallSimplifier::optimizeFMinFMax(CallInst *CI, IRBuilder<> &B) {
Sanjay Patel9beec212016-01-21 22:58:01 +00001381 Function *Callee = CI->getCalledFunction();
Sanjay Patel57fd1dc2015-08-16 20:18:19 +00001382 // If we can shrink the call to a float function rather than a double
1383 // function, do that first.
Davide Italianoa3458772015-11-05 19:18:23 +00001384 StringRef Name = Callee->getName();
Sanjay Patelc7ddb7f2016-01-06 00:32:15 +00001385 if ((Name == "fmin" || Name == "fmax") && hasFloatVersion(Name))
1386 if (Value *Ret = optimizeBinaryDoubleFP(CI, B))
Sanjay Patel57fd1dc2015-08-16 20:18:19 +00001387 return Ret;
Sanjay Patel57fd1dc2015-08-16 20:18:19 +00001388
Benjamin Kramerbb70d752015-08-16 21:16:37 +00001389 IRBuilder<>::FastMathFlagGuard Guard(B);
Sanjay Patel57fd1dc2015-08-16 20:18:19 +00001390 FastMathFlags FMF;
Sanjay Patel629c4112017-11-06 16:27:15 +00001391 if (CI->isFast()) {
1392 // If the call is 'fast', then anything we create here will also be 'fast'.
1393 FMF.setFast();
Sanjay Patel57fd1dc2015-08-16 20:18:19 +00001394 } else {
1395 // At a minimum, no-nans-fp-math must be true.
Sanjay Patel29095ea2016-01-05 20:46:19 +00001396 if (!CI->hasNoNaNs())
Sanjay Patel57fd1dc2015-08-16 20:18:19 +00001397 return nullptr;
1398 // No-signed-zeros is implied by the definitions of fmax/fmin themselves:
1399 // "Ideally, fmax would be sensitive to the sign of zero, for example
NAKAMURA Takumi0d725392015-09-07 00:26:54 +00001400 // fmax(-0. 0, +0. 0) would return +0; however, implementation in software
Sanjay Patel57fd1dc2015-08-16 20:18:19 +00001401 // might be impractical."
1402 FMF.setNoSignedZeros();
1403 FMF.setNoNaNs();
1404 }
Sanjay Patela2528152016-01-12 18:03:37 +00001405 B.setFastMathFlags(FMF);
Sanjay Patel57fd1dc2015-08-16 20:18:19 +00001406
1407 // We have a relaxed floating-point environment. We can ignore NaN-handling
1408 // and transform to a compare and select. We do not have to consider errno or
1409 // exceptions, because fmin/fmax do not have those.
1410 Value *Op0 = CI->getArgOperand(0);
1411 Value *Op1 = CI->getArgOperand(1);
1412 Value *Cmp = Callee->getName().startswith("fmin") ?
1413 B.CreateFCmpOLT(Op0, Op1) : B.CreateFCmpOGT(Op0, Op1);
1414 return B.CreateSelect(Cmp, Op0, Op1);
1415}
1416
Davide Italianob8b71332015-11-29 20:58:04 +00001417Value *LibCallSimplifier::optimizeLog(CallInst *CI, IRBuilder<> &B) {
1418 Function *Callee = CI->getCalledFunction();
1419 Value *Ret = nullptr;
1420 StringRef Name = Callee->getName();
1421 if (UnsafeFPShrink && hasFloatVersion(Name))
1422 Ret = optimizeUnaryDoubleFP(CI, B, true);
Davide Italianob8b71332015-11-29 20:58:04 +00001423
Sanjay Patel629c4112017-11-06 16:27:15 +00001424 if (!CI->isFast())
Davide Italianob8b71332015-11-29 20:58:04 +00001425 return Ret;
1426 Value *Op1 = CI->getArgOperand(0);
1427 auto *OpC = dyn_cast<CallInst>(Op1);
Sanjay Patele896ede2016-01-11 23:31:48 +00001428
Sanjay Patel629c4112017-11-06 16:27:15 +00001429 // The earlier call must also be 'fast' in order to do these transforms.
1430 if (!OpC || !OpC->isFast())
Davide Italianob8b71332015-11-29 20:58:04 +00001431 return Ret;
1432
1433 // log(pow(x,y)) -> y*log(x)
1434 // This is only applicable to log, log2, log10.
1435 if (Name != "log" && Name != "log2" && Name != "log10")
1436 return Ret;
1437
1438 IRBuilder<>::FastMathFlagGuard Guard(B);
1439 FastMathFlags FMF;
Sanjay Patel629c4112017-11-06 16:27:15 +00001440 FMF.setFast();
Sanjay Patela2528152016-01-12 18:03:37 +00001441 B.setFastMathFlags(FMF);
Davide Italianob8b71332015-11-29 20:58:04 +00001442
David L. Jonesd21529f2017-01-23 23:16:46 +00001443 LibFunc Func;
Davide Italianob8b71332015-11-29 20:58:04 +00001444 Function *F = OpC->getCalledFunction();
Davide Italiano0b14f292015-11-29 21:58:56 +00001445 if (F && ((TLI->getLibFunc(F->getName(), Func) && TLI->has(Func) &&
David L. Jonesd21529f2017-01-23 23:16:46 +00001446 Func == LibFunc_pow) || F->getIntrinsicID() == Intrinsic::pow))
Davide Italianob8b71332015-11-29 20:58:04 +00001447 return B.CreateFMul(OpC->getArgOperand(1),
Sanjay Pateld3112a52016-01-19 19:46:10 +00001448 emitUnaryFloatFnCall(OpC->getOperand(0), Callee->getName(), B,
Davide Italianob8b71332015-11-29 20:58:04 +00001449 Callee->getAttributes()), "mul");
Davide Italiano1aeed6a2015-11-30 19:36:35 +00001450
1451 // log(exp2(y)) -> y*log(2)
1452 if (F && Name == "log" && TLI->getLibFunc(F->getName(), Func) &&
David L. Jonesd21529f2017-01-23 23:16:46 +00001453 TLI->has(Func) && Func == LibFunc_exp2)
Davide Italiano1aeed6a2015-11-30 19:36:35 +00001454 return B.CreateFMul(
1455 OpC->getArgOperand(0),
Sanjay Pateld3112a52016-01-19 19:46:10 +00001456 emitUnaryFloatFnCall(ConstantFP::get(CI->getType(), 2.0),
Davide Italiano1aeed6a2015-11-30 19:36:35 +00001457 Callee->getName(), B, Callee->getAttributes()),
1458 "logmul");
Davide Italianob8b71332015-11-29 20:58:04 +00001459 return Ret;
1460}
1461
Sanjay Patelc699a612014-10-16 18:48:17 +00001462Value *LibCallSimplifier::optimizeSqrt(CallInst *CI, IRBuilder<> &B) {
1463 Function *Callee = CI->getCalledFunction();
Sanjay Patelc699a612014-10-16 18:48:17 +00001464 Value *Ret = nullptr;
Justin Lebarcb9b41d2017-01-27 00:58:03 +00001465 // TODO: Once we have a way (other than checking for the existince of the
1466 // libcall) to tell whether our target can lower @llvm.sqrt, relax the
1467 // condition below.
David L. Jonesd21529f2017-01-23 23:16:46 +00001468 if (TLI->has(LibFunc_sqrtf) && (Callee->getName() == "sqrt" ||
Justin Lebarcb9b41d2017-01-27 00:58:03 +00001469 Callee->getIntrinsicID() == Intrinsic::sqrt))
Sanjay Patelc699a612014-10-16 18:48:17 +00001470 Ret = optimizeUnaryDoubleFP(CI, B, true);
Sanjay Patel683f2972016-01-11 22:34:19 +00001471
Sanjay Patel629c4112017-11-06 16:27:15 +00001472 if (!CI->isFast())
Davide Italianoa904e522015-10-29 02:58:44 +00001473 return Ret;
Sanjay Patelc699a612014-10-16 18:48:17 +00001474
Sanjay Patelc2d64612016-01-06 20:52:21 +00001475 Instruction *I = dyn_cast<Instruction>(CI->getArgOperand(0));
Sanjay Patel629c4112017-11-06 16:27:15 +00001476 if (!I || I->getOpcode() != Instruction::FMul || !I->isFast())
Sanjay Patelc2d64612016-01-06 20:52:21 +00001477 return Ret;
1478
1479 // We're looking for a repeated factor in a multiplication tree,
1480 // so we can do this fold: sqrt(x * x) -> fabs(x);
Sanjay Patel683f2972016-01-11 22:34:19 +00001481 // or this fold: sqrt((x * x) * y) -> fabs(x) * sqrt(y).
Sanjay Patelc2d64612016-01-06 20:52:21 +00001482 Value *Op0 = I->getOperand(0);
1483 Value *Op1 = I->getOperand(1);
1484 Value *RepeatOp = nullptr;
1485 Value *OtherOp = nullptr;
1486 if (Op0 == Op1) {
1487 // Simple match: the operands of the multiply are identical.
1488 RepeatOp = Op0;
1489 } else {
1490 // Look for a more complicated pattern: one of the operands is itself
1491 // a multiply, so search for a common factor in that multiply.
1492 // Note: We don't bother looking any deeper than this first level or for
1493 // variations of this pattern because instcombine's visitFMUL and/or the
1494 // reassociation pass should give us this form.
1495 Value *OtherMul0, *OtherMul1;
1496 if (match(Op0, m_FMul(m_Value(OtherMul0), m_Value(OtherMul1)))) {
1497 // Pattern: sqrt((x * y) * z)
Sanjay Patel629c4112017-11-06 16:27:15 +00001498 if (OtherMul0 == OtherMul1 && cast<Instruction>(Op0)->isFast()) {
Sanjay Patelc2d64612016-01-06 20:52:21 +00001499 // Matched: sqrt((x * x) * z)
1500 RepeatOp = OtherMul0;
1501 OtherOp = Op1;
Sanjay Patelc699a612014-10-16 18:48:17 +00001502 }
1503 }
1504 }
Sanjay Patelc2d64612016-01-06 20:52:21 +00001505 if (!RepeatOp)
1506 return Ret;
1507
1508 // Fast math flags for any created instructions should match the sqrt
1509 // and multiply.
Sanjay Patelc2d64612016-01-06 20:52:21 +00001510 IRBuilder<>::FastMathFlagGuard Guard(B);
Sanjay Patela2528152016-01-12 18:03:37 +00001511 B.setFastMathFlags(I->getFastMathFlags());
Sanjay Patel9f67dad2016-01-11 22:35:39 +00001512
Sanjay Patelc2d64612016-01-06 20:52:21 +00001513 // If we found a repeated factor, hoist it out of the square root and
1514 // replace it with the fabs of that factor.
1515 Module *M = Callee->getParent();
1516 Type *ArgType = I->getType();
1517 Value *Fabs = Intrinsic::getDeclaration(M, Intrinsic::fabs, ArgType);
1518 Value *FabsCall = B.CreateCall(Fabs, RepeatOp, "fabs");
1519 if (OtherOp) {
1520 // If we found a non-repeated factor, we still need to get its square
1521 // root. We then multiply that by the value that was simplified out
1522 // of the square root calculation.
1523 Value *Sqrt = Intrinsic::getDeclaration(M, Intrinsic::sqrt, ArgType);
1524 Value *SqrtCall = B.CreateCall(Sqrt, OtherOp, "sqrt");
1525 return B.CreateFMul(FabsCall, SqrtCall);
1526 }
1527 return FabsCall;
Sanjay Patelc699a612014-10-16 18:48:17 +00001528}
1529
Sanjay Patelcddcd722016-01-06 19:23:35 +00001530// TODO: Generalize to handle any trig function and its inverse.
Davide Italiano51507d22015-11-04 23:36:56 +00001531Value *LibCallSimplifier::optimizeTan(CallInst *CI, IRBuilder<> &B) {
1532 Function *Callee = CI->getCalledFunction();
1533 Value *Ret = nullptr;
Davide Italianoa3458772015-11-05 19:18:23 +00001534 StringRef Name = Callee->getName();
1535 if (UnsafeFPShrink && Name == "tan" && hasFloatVersion(Name))
Davide Italiano51507d22015-11-04 23:36:56 +00001536 Ret = optimizeUnaryDoubleFP(CI, B, true);
Davide Italiano51507d22015-11-04 23:36:56 +00001537
Davide Italiano51507d22015-11-04 23:36:56 +00001538 Value *Op1 = CI->getArgOperand(0);
1539 auto *OpC = dyn_cast<CallInst>(Op1);
1540 if (!OpC)
1541 return Ret;
1542
Sanjay Patel629c4112017-11-06 16:27:15 +00001543 // Both calls must be 'fast' in order to remove them.
1544 if (!CI->isFast() || !OpC->isFast())
Sanjay Patelcddcd722016-01-06 19:23:35 +00001545 return Ret;
1546
Davide Italiano51507d22015-11-04 23:36:56 +00001547 // tan(atan(x)) -> x
1548 // tanf(atanf(x)) -> x
1549 // tanl(atanl(x)) -> x
David L. Jonesd21529f2017-01-23 23:16:46 +00001550 LibFunc Func;
Davide Italiano51507d22015-11-04 23:36:56 +00001551 Function *F = OpC->getCalledFunction();
Benjamin Kramerfb419e72015-11-26 09:51:17 +00001552 if (F && TLI->getLibFunc(F->getName(), Func) && TLI->has(Func) &&
David L. Jonesd21529f2017-01-23 23:16:46 +00001553 ((Func == LibFunc_atan && Callee->getName() == "tan") ||
1554 (Func == LibFunc_atanf && Callee->getName() == "tanf") ||
1555 (Func == LibFunc_atanl && Callee->getName() == "tanl")))
Davide Italiano51507d22015-11-04 23:36:56 +00001556 Ret = OpC->getArgOperand(0);
1557 return Ret;
1558}
1559
Sanjay Patel57747212016-01-21 23:38:43 +00001560static bool isTrigLibCall(CallInst *CI) {
Sanjay Patel57747212016-01-21 23:38:43 +00001561 // We can only hope to do anything useful if we can ignore things like errno
1562 // and floating-point exceptions.
Ahmed Bougachad765a822016-04-27 19:04:35 +00001563 // We already checked the prototype.
1564 return CI->hasFnAttr(Attribute::NoUnwind) &&
1565 CI->hasFnAttr(Attribute::ReadNone);
Sanjay Patel57747212016-01-21 23:38:43 +00001566}
1567
Chris Bienemanad070d02014-09-17 20:55:46 +00001568static void insertSinCosCall(IRBuilder<> &B, Function *OrigCallee, Value *Arg,
1569 bool UseFloat, Value *&Sin, Value *&Cos,
Sanjay Patel57747212016-01-21 23:38:43 +00001570 Value *&SinCos) {
1571 Type *ArgTy = Arg->getType();
1572 Type *ResTy;
1573 StringRef Name;
1574
1575 Triple T(OrigCallee->getParent()->getTargetTriple());
1576 if (UseFloat) {
1577 Name = "__sincospif_stret";
1578
1579 assert(T.getArch() != Triple::x86 && "x86 messy and unsupported for now");
1580 // x86_64 can't use {float, float} since that would be returned in both
1581 // xmm0 and xmm1, which isn't what a real struct would do.
1582 ResTy = T.getArch() == Triple::x86_64
Serge Gueltone38003f2017-05-09 19:31:13 +00001583 ? static_cast<Type *>(VectorType::get(ArgTy, 2))
1584 : static_cast<Type *>(StructType::get(ArgTy, ArgTy));
Sanjay Patel57747212016-01-21 23:38:43 +00001585 } else {
1586 Name = "__sincospi_stret";
Serge Gueltone38003f2017-05-09 19:31:13 +00001587 ResTy = StructType::get(ArgTy, ArgTy);
Sanjay Patel57747212016-01-21 23:38:43 +00001588 }
1589
1590 Module *M = OrigCallee->getParent();
Mehdi Aminidb11fdf2017-04-06 20:23:57 +00001591 Value *Callee = M->getOrInsertFunction(Name, OrigCallee->getAttributes(),
Serge Guelton59a2d7b2017-04-11 15:01:18 +00001592 ResTy, ArgTy);
Sanjay Patel57747212016-01-21 23:38:43 +00001593
1594 if (Instruction *ArgInst = dyn_cast<Instruction>(Arg)) {
1595 // If the argument is an instruction, it must dominate all uses so put our
1596 // sincos call there.
1597 B.SetInsertPoint(ArgInst->getParent(), ++ArgInst->getIterator());
1598 } else {
1599 // Otherwise (e.g. for a constant) the beginning of the function is as
1600 // good a place as any.
1601 BasicBlock &EntryBB = B.GetInsertBlock()->getParent()->getEntryBlock();
1602 B.SetInsertPoint(&EntryBB, EntryBB.begin());
1603 }
1604
1605 SinCos = B.CreateCall(Callee, Arg, "sincospi");
1606
1607 if (SinCos->getType()->isStructTy()) {
1608 Sin = B.CreateExtractValue(SinCos, 0, "sinpi");
1609 Cos = B.CreateExtractValue(SinCos, 1, "cospi");
1610 } else {
1611 Sin = B.CreateExtractElement(SinCos, ConstantInt::get(B.getInt32Ty(), 0),
1612 "sinpi");
1613 Cos = B.CreateExtractElement(SinCos, ConstantInt::get(B.getInt32Ty(), 1),
1614 "cospi");
1615 }
1616}
Chris Bienemanad070d02014-09-17 20:55:46 +00001617
1618Value *LibCallSimplifier::optimizeSinCosPi(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +00001619 // Make sure the prototype is as expected, otherwise the rest of the
1620 // function is probably invalid and likely to abort.
1621 if (!isTrigLibCall(CI))
1622 return nullptr;
1623
1624 Value *Arg = CI->getArgOperand(0);
1625 SmallVector<CallInst *, 1> SinCalls;
1626 SmallVector<CallInst *, 1> CosCalls;
1627 SmallVector<CallInst *, 1> SinCosCalls;
1628
1629 bool IsFloat = Arg->getType()->isFloatTy();
1630
1631 // Look for all compatible sinpi, cospi and sincospi calls with the same
1632 // argument. If there are enough (in some sense) we can make the
1633 // substitution.
David Majnemerabae6b52016-03-19 04:53:02 +00001634 Function *F = CI->getFunction();
Chris Bienemanad070d02014-09-17 20:55:46 +00001635 for (User *U : Arg->users())
David Majnemerabae6b52016-03-19 04:53:02 +00001636 classifyArgUse(U, F, IsFloat, SinCalls, CosCalls, SinCosCalls);
Chris Bienemanad070d02014-09-17 20:55:46 +00001637
1638 // It's only worthwhile if both sinpi and cospi are actually used.
1639 if (SinCosCalls.empty() && (SinCalls.empty() || CosCalls.empty()))
1640 return nullptr;
1641
1642 Value *Sin, *Cos, *SinCos;
1643 insertSinCosCall(B, CI->getCalledFunction(), Arg, IsFloat, Sin, Cos, SinCos);
1644
Davide Italianof024a562016-12-16 02:28:38 +00001645 auto replaceTrigInsts = [this](SmallVectorImpl<CallInst *> &Calls,
1646 Value *Res) {
1647 for (CallInst *C : Calls)
1648 replaceAllUsesWith(C, Res);
1649 };
1650
Chris Bienemanad070d02014-09-17 20:55:46 +00001651 replaceTrigInsts(SinCalls, Sin);
1652 replaceTrigInsts(CosCalls, Cos);
1653 replaceTrigInsts(SinCosCalls, SinCos);
1654
1655 return nullptr;
1656}
1657
David Majnemerabae6b52016-03-19 04:53:02 +00001658void LibCallSimplifier::classifyArgUse(
1659 Value *Val, Function *F, bool IsFloat,
1660 SmallVectorImpl<CallInst *> &SinCalls,
1661 SmallVectorImpl<CallInst *> &CosCalls,
1662 SmallVectorImpl<CallInst *> &SinCosCalls) {
Chris Bienemanad070d02014-09-17 20:55:46 +00001663 CallInst *CI = dyn_cast<CallInst>(Val);
1664
1665 if (!CI)
1666 return;
1667
David Majnemerabae6b52016-03-19 04:53:02 +00001668 // Don't consider calls in other functions.
1669 if (CI->getFunction() != F)
1670 return;
1671
Chris Bienemanad070d02014-09-17 20:55:46 +00001672 Function *Callee = CI->getCalledFunction();
David L. Jonesd21529f2017-01-23 23:16:46 +00001673 LibFunc Func;
Ahmed Bougachad765a822016-04-27 19:04:35 +00001674 if (!Callee || !TLI->getLibFunc(*Callee, Func) || !TLI->has(Func) ||
Benjamin Kramer89766e52015-11-28 21:43:12 +00001675 !isTrigLibCall(CI))
Chris Bienemanad070d02014-09-17 20:55:46 +00001676 return;
1677
1678 if (IsFloat) {
David L. Jonesd21529f2017-01-23 23:16:46 +00001679 if (Func == LibFunc_sinpif)
Chris Bienemanad070d02014-09-17 20:55:46 +00001680 SinCalls.push_back(CI);
David L. Jonesd21529f2017-01-23 23:16:46 +00001681 else if (Func == LibFunc_cospif)
Chris Bienemanad070d02014-09-17 20:55:46 +00001682 CosCalls.push_back(CI);
David L. Jonesd21529f2017-01-23 23:16:46 +00001683 else if (Func == LibFunc_sincospif_stret)
Chris Bienemanad070d02014-09-17 20:55:46 +00001684 SinCosCalls.push_back(CI);
1685 } else {
David L. Jonesd21529f2017-01-23 23:16:46 +00001686 if (Func == LibFunc_sinpi)
Chris Bienemanad070d02014-09-17 20:55:46 +00001687 SinCalls.push_back(CI);
David L. Jonesd21529f2017-01-23 23:16:46 +00001688 else if (Func == LibFunc_cospi)
Chris Bienemanad070d02014-09-17 20:55:46 +00001689 CosCalls.push_back(CI);
David L. Jonesd21529f2017-01-23 23:16:46 +00001690 else if (Func == LibFunc_sincospi_stret)
Chris Bienemanad070d02014-09-17 20:55:46 +00001691 SinCosCalls.push_back(CI);
1692 }
1693}
1694
Meador Inge7415f842012-11-25 20:45:27 +00001695//===----------------------------------------------------------------------===//
1696// Integer Library Call Optimizations
1697//===----------------------------------------------------------------------===//
1698
Chris Bienemanad070d02014-09-17 20:55:46 +00001699Value *LibCallSimplifier::optimizeFFS(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +00001700 // ffs(x) -> x != 0 ? (i32)llvm.cttz(x)+1 : 0
Davide Italiano890e8502016-12-15 23:11:00 +00001701 Value *Op = CI->getArgOperand(0);
Chris Bienemanad070d02014-09-17 20:55:46 +00001702 Type *ArgType = Op->getType();
Davide Italiano890e8502016-12-15 23:11:00 +00001703 Value *F = Intrinsic::getDeclaration(CI->getCalledFunction()->getParent(),
1704 Intrinsic::cttz, ArgType);
Davide Italianoa1953862015-08-13 20:34:26 +00001705 Value *V = B.CreateCall(F, {Op, B.getTrue()}, "cttz");
Chris Bienemanad070d02014-09-17 20:55:46 +00001706 V = B.CreateAdd(V, ConstantInt::get(V->getType(), 1));
1707 V = B.CreateIntCast(V, B.getInt32Ty(), false);
Meador Ingea0b6d872012-11-26 00:24:07 +00001708
Chris Bienemanad070d02014-09-17 20:55:46 +00001709 Value *Cond = B.CreateICmpNE(Op, Constant::getNullValue(ArgType));
1710 return B.CreateSelect(Cond, V, B.getInt32(0));
1711}
Meador Ingea0b6d872012-11-26 00:24:07 +00001712
Davide Italiano85ad36b2016-12-15 23:45:11 +00001713Value *LibCallSimplifier::optimizeFls(CallInst *CI, IRBuilder<> &B) {
1714 // fls(x) -> (i32)(sizeInBits(x) - llvm.ctlz(x, false))
1715 Value *Op = CI->getArgOperand(0);
1716 Type *ArgType = Op->getType();
1717 Value *F = Intrinsic::getDeclaration(CI->getCalledFunction()->getParent(),
1718 Intrinsic::ctlz, ArgType);
1719 Value *V = B.CreateCall(F, {Op, B.getFalse()}, "ctlz");
1720 V = B.CreateSub(ConstantInt::get(V->getType(), ArgType->getIntegerBitWidth()),
1721 V);
1722 return B.CreateIntCast(V, CI->getType(), false);
1723}
1724
Chris Bienemanad070d02014-09-17 20:55:46 +00001725Value *LibCallSimplifier::optimizeAbs(CallInst *CI, IRBuilder<> &B) {
Sanjay Patel4b969352018-05-22 23:29:40 +00001726 // abs(x) -> x <s 0 ? -x : x
1727 // The negation has 'nsw' because abs of INT_MIN is undefined.
1728 Value *X = CI->getArgOperand(0);
1729 Value *IsNeg = B.CreateICmpSLT(X, Constant::getNullValue(X->getType()));
1730 Value *NegX = B.CreateNSWNeg(X, "neg");
1731 return B.CreateSelect(IsNeg, NegX, X);
Chris Bienemanad070d02014-09-17 20:55:46 +00001732}
Meador Inge9a59ab62012-11-26 02:31:59 +00001733
Chris Bienemanad070d02014-09-17 20:55:46 +00001734Value *LibCallSimplifier::optimizeIsDigit(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +00001735 // isdigit(c) -> (c-'0') <u 10
1736 Value *Op = CI->getArgOperand(0);
1737 Op = B.CreateSub(Op, B.getInt32('0'), "isdigittmp");
1738 Op = B.CreateICmpULT(Op, B.getInt32(10), "isdigit");
1739 return B.CreateZExt(Op, CI->getType());
1740}
Meador Ingea62a39e2012-11-26 03:10:07 +00001741
Chris Bienemanad070d02014-09-17 20:55:46 +00001742Value *LibCallSimplifier::optimizeIsAscii(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +00001743 // isascii(c) -> c <u 128
1744 Value *Op = CI->getArgOperand(0);
1745 Op = B.CreateICmpULT(Op, B.getInt32(128), "isascii");
1746 return B.CreateZExt(Op, CI->getType());
1747}
1748
1749Value *LibCallSimplifier::optimizeToAscii(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +00001750 // toascii(c) -> c & 0x7f
1751 return B.CreateAnd(CI->getArgOperand(0),
1752 ConstantInt::get(CI->getType(), 0x7F));
1753}
Meador Inge604937d2012-11-26 03:38:52 +00001754
David Bolvanskycb8ca5f32018-04-25 18:58:53 +00001755Value *LibCallSimplifier::optimizeAtoi(CallInst *CI, IRBuilder<> &B) {
1756 StringRef Str;
1757 if (!getConstantStringInfo(CI->getArgOperand(0), Str))
1758 return nullptr;
1759
1760 return convertStrToNumber(CI, Str, 10);
1761}
1762
1763Value *LibCallSimplifier::optimizeStrtol(CallInst *CI, IRBuilder<> &B) {
1764 StringRef Str;
1765 if (!getConstantStringInfo(CI->getArgOperand(0), Str))
1766 return nullptr;
1767
1768 if (!isa<ConstantPointerNull>(CI->getArgOperand(1)))
1769 return nullptr;
1770
1771 if (ConstantInt *CInt = dyn_cast<ConstantInt>(CI->getArgOperand(2))) {
1772 return convertStrToNumber(CI, Str, CInt->getSExtValue());
1773 }
1774
1775 return nullptr;
1776}
1777
Meador Inge08ca1152012-11-26 20:37:20 +00001778//===----------------------------------------------------------------------===//
1779// Formatting and IO Library Call Optimizations
1780//===----------------------------------------------------------------------===//
1781
Chris Bienemanad070d02014-09-17 20:55:46 +00001782static bool isReportingError(Function *Callee, CallInst *CI, int StreamArg);
Hal Finkel66cd3f12013-11-17 02:06:35 +00001783
Chris Bienemanad070d02014-09-17 20:55:46 +00001784Value *LibCallSimplifier::optimizeErrorReporting(CallInst *CI, IRBuilder<> &B,
1785 int StreamArg) {
Ahmed Bougachad765a822016-04-27 19:04:35 +00001786 Function *Callee = CI->getCalledFunction();
Chris Bienemanad070d02014-09-17 20:55:46 +00001787 // Error reporting calls should be cold, mark them as such.
1788 // This applies even to non-builtin calls: it is only a hint and applies to
1789 // functions that the frontend might not understand as builtins.
Hal Finkel66cd3f12013-11-17 02:06:35 +00001790
Chris Bienemanad070d02014-09-17 20:55:46 +00001791 // This heuristic was suggested in:
1792 // Improving Static Branch Prediction in a Compiler
1793 // Brian L. Deitrich, Ben-Chung Cheng, Wen-mei W. Hwu
1794 // Proceedings of PACT'98, Oct. 1998, IEEE
Chris Bienemanad070d02014-09-17 20:55:46 +00001795 if (!CI->hasFnAttr(Attribute::Cold) &&
1796 isReportingError(Callee, CI, StreamArg)) {
Reid Klecknerb5180542017-03-21 16:57:19 +00001797 CI->addAttribute(AttributeList::FunctionIndex, Attribute::Cold);
Chris Bienemanad070d02014-09-17 20:55:46 +00001798 }
Hal Finkel66cd3f12013-11-17 02:06:35 +00001799
Chris Bienemanad070d02014-09-17 20:55:46 +00001800 return nullptr;
1801}
1802
1803static bool isReportingError(Function *Callee, CallInst *CI, int StreamArg) {
Davide Italiano5b65f122017-04-25 03:48:47 +00001804 if (!Callee || !Callee->isDeclaration())
Chris Bienemanad070d02014-09-17 20:55:46 +00001805 return false;
1806
1807 if (StreamArg < 0)
1808 return true;
1809
1810 // These functions might be considered cold, but only if their stream
1811 // argument is stderr.
1812
1813 if (StreamArg >= (int)CI->getNumArgOperands())
1814 return false;
1815 LoadInst *LI = dyn_cast<LoadInst>(CI->getArgOperand(StreamArg));
1816 if (!LI)
1817 return false;
1818 GlobalVariable *GV = dyn_cast<GlobalVariable>(LI->getPointerOperand());
1819 if (!GV || !GV->isDeclaration())
1820 return false;
1821 return GV->getName() == "stderr";
1822}
1823
1824Value *LibCallSimplifier::optimizePrintFString(CallInst *CI, IRBuilder<> &B) {
1825 // Check for a fixed format string.
1826 StringRef FormatStr;
1827 if (!getConstantStringInfo(CI->getArgOperand(0), FormatStr))
Craig Topperf40110f2014-04-25 05:29:35 +00001828 return nullptr;
Hal Finkel66cd3f12013-11-17 02:06:35 +00001829
Chris Bienemanad070d02014-09-17 20:55:46 +00001830 // Empty format string -> noop.
1831 if (FormatStr.empty()) // Tolerate printf's declared void.
1832 return CI->use_empty() ? (Value *)CI : ConstantInt::get(CI->getType(), 0);
Hal Finkel66cd3f12013-11-17 02:06:35 +00001833
Chris Bienemanad070d02014-09-17 20:55:46 +00001834 // Do not do any of the following transformations if the printf return value
1835 // is used, in general the printf return value is not compatible with either
1836 // putchar() or puts().
1837 if (!CI->use_empty())
Craig Topperf40110f2014-04-25 05:29:35 +00001838 return nullptr;
Chris Bienemanad070d02014-09-17 20:55:46 +00001839
Joerg Sonnenberger8ffe7ab2016-05-09 14:36:16 +00001840 // printf("x") -> putchar('x'), even for "%" and "%%".
1841 if (FormatStr.size() == 1 || FormatStr == "%%")
Davide Italianod4f5a052016-04-03 01:46:52 +00001842 return emitPutChar(B.getInt32(FormatStr[0]), B, TLI);
Meador Inge08ca1152012-11-26 20:37:20 +00001843
Davide Italiano6db1dcb2016-03-28 15:54:01 +00001844 // printf("%s", "a") --> putchar('a')
1845 if (FormatStr == "%s" && CI->getNumArgOperands() > 1) {
1846 StringRef ChrStr;
1847 if (!getConstantStringInfo(CI->getOperand(1), ChrStr))
1848 return nullptr;
1849 if (ChrStr.size() != 1)
1850 return nullptr;
Davide Italianod4f5a052016-04-03 01:46:52 +00001851 return emitPutChar(B.getInt32(ChrStr[0]), B, TLI);
Davide Italiano6db1dcb2016-03-28 15:54:01 +00001852 }
1853
Chris Bienemanad070d02014-09-17 20:55:46 +00001854 // printf("foo\n") --> puts("foo")
1855 if (FormatStr[FormatStr.size() - 1] == '\n' &&
1856 FormatStr.find('%') == StringRef::npos) { // No format characters.
1857 // Create a string literal with no \n on it. We expect the constant merge
1858 // pass to be run after this pass, to merge duplicate strings.
1859 FormatStr = FormatStr.drop_back();
1860 Value *GV = B.CreateGlobalString(FormatStr, "str");
Davide Italianod4f5a052016-04-03 01:46:52 +00001861 return emitPutS(GV, B, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +00001862 }
Meador Inge08ca1152012-11-26 20:37:20 +00001863
Chris Bienemanad070d02014-09-17 20:55:46 +00001864 // Optimize specific format strings.
1865 // printf("%c", chr) --> putchar(chr)
1866 if (FormatStr == "%c" && CI->getNumArgOperands() > 1 &&
Davide Italianod4f5a052016-04-03 01:46:52 +00001867 CI->getArgOperand(1)->getType()->isIntegerTy())
1868 return emitPutChar(CI->getArgOperand(1), B, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +00001869
1870 // printf("%s\n", str) --> puts(str)
1871 if (FormatStr == "%s\n" && CI->getNumArgOperands() > 1 &&
Davide Italianod4f5a052016-04-03 01:46:52 +00001872 CI->getArgOperand(1)->getType()->isPointerTy())
Sanjay Pateld3112a52016-01-19 19:46:10 +00001873 return emitPutS(CI->getArgOperand(1), B, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +00001874 return nullptr;
1875}
1876
1877Value *LibCallSimplifier::optimizePrintF(CallInst *CI, IRBuilder<> &B) {
1878
1879 Function *Callee = CI->getCalledFunction();
Chris Bienemanad070d02014-09-17 20:55:46 +00001880 FunctionType *FT = Callee->getFunctionType();
Chris Bienemanad070d02014-09-17 20:55:46 +00001881 if (Value *V = optimizePrintFString(CI, B)) {
1882 return V;
1883 }
1884
1885 // printf(format, ...) -> iprintf(format, ...) if no floating point
1886 // arguments.
David L. Jonesd21529f2017-01-23 23:16:46 +00001887 if (TLI->has(LibFunc_iprintf) && !callHasFloatingPointArgument(CI)) {
Chris Bienemanad070d02014-09-17 20:55:46 +00001888 Module *M = B.GetInsertBlock()->getParent()->getParent();
1889 Constant *IPrintFFn =
Meador Inge08ca1152012-11-26 20:37:20 +00001890 M->getOrInsertFunction("iprintf", FT, Callee->getAttributes());
Chris Bienemanad070d02014-09-17 20:55:46 +00001891 CallInst *New = cast<CallInst>(CI->clone());
1892 New->setCalledFunction(IPrintFFn);
1893 B.Insert(New);
1894 return New;
Meador Inge08ca1152012-11-26 20:37:20 +00001895 }
Chris Bienemanad070d02014-09-17 20:55:46 +00001896 return nullptr;
1897}
Meador Inge08ca1152012-11-26 20:37:20 +00001898
Chris Bienemanad070d02014-09-17 20:55:46 +00001899Value *LibCallSimplifier::optimizeSPrintFString(CallInst *CI, IRBuilder<> &B) {
1900 // Check for a fixed format string.
1901 StringRef FormatStr;
1902 if (!getConstantStringInfo(CI->getArgOperand(1), FormatStr))
Craig Topperf40110f2014-04-25 05:29:35 +00001903 return nullptr;
Meador Inge25c9b3b2012-11-27 05:57:54 +00001904
Chris Bienemanad070d02014-09-17 20:55:46 +00001905 // If we just have a format string (nothing else crazy) transform it.
1906 if (CI->getNumArgOperands() == 2) {
1907 // Make sure there's no % in the constant array. We could try to handle
1908 // %% -> % in the future if we cared.
David Bolvansky5430b7372018-05-31 16:39:27 +00001909 if (FormatStr.find('%') != StringRef::npos)
1910 return nullptr; // we found a format specifier, bail out.
Hal Finkel66cd3f12013-11-17 02:06:35 +00001911
Daniel Neilson8acd8b02018-02-05 21:23:22 +00001912 // sprintf(str, fmt) -> llvm.memcpy(align 1 str, align 1 fmt, strlen(fmt)+1)
1913 B.CreateMemCpy(CI->getArgOperand(0), 1, CI->getArgOperand(1), 1,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001914 ConstantInt::get(DL.getIntPtrType(CI->getContext()),
Daniel Neilson8acd8b02018-02-05 21:23:22 +00001915 FormatStr.size() + 1)); // Copy the null byte.
Chris Bienemanad070d02014-09-17 20:55:46 +00001916 return ConstantInt::get(CI->getType(), FormatStr.size());
Meador Ingef8e72502012-11-29 15:45:43 +00001917 }
Meador Ingef8e72502012-11-29 15:45:43 +00001918
Chris Bienemanad070d02014-09-17 20:55:46 +00001919 // The remaining optimizations require the format string to be "%s" or "%c"
1920 // and have an extra operand.
1921 if (FormatStr.size() != 2 || FormatStr[0] != '%' ||
1922 CI->getNumArgOperands() < 3)
Craig Topperf40110f2014-04-25 05:29:35 +00001923 return nullptr;
Meador Inge75798bb2012-11-29 19:15:17 +00001924
Chris Bienemanad070d02014-09-17 20:55:46 +00001925 // Decode the second character of the format string.
1926 if (FormatStr[1] == 'c') {
1927 // sprintf(dst, "%c", chr) --> *(i8*)dst = chr; *((i8*)dst+1) = 0
1928 if (!CI->getArgOperand(2)->getType()->isIntegerTy())
1929 return nullptr;
1930 Value *V = B.CreateTrunc(CI->getArgOperand(2), B.getInt8Ty(), "char");
Sanjay Pateld3112a52016-01-19 19:46:10 +00001931 Value *Ptr = castToCStr(CI->getArgOperand(0), B);
Chris Bienemanad070d02014-09-17 20:55:46 +00001932 B.CreateStore(V, Ptr);
David Blaikie3909da72015-03-30 20:42:56 +00001933 Ptr = B.CreateGEP(B.getInt8Ty(), Ptr, B.getInt32(1), "nul");
Chris Bienemanad070d02014-09-17 20:55:46 +00001934 B.CreateStore(B.getInt8(0), Ptr);
Meador Ingedf796f82012-10-13 16:45:24 +00001935
Chris Bienemanad070d02014-09-17 20:55:46 +00001936 return ConstantInt::get(CI->getType(), 1);
Meador Ingedf796f82012-10-13 16:45:24 +00001937 }
1938
Chris Bienemanad070d02014-09-17 20:55:46 +00001939 if (FormatStr[1] == 's') {
Chris Bienemanad070d02014-09-17 20:55:46 +00001940 // sprintf(dest, "%s", str) -> llvm.memcpy(dest, str, strlen(str)+1, 1)
1941 if (!CI->getArgOperand(2)->getType()->isPointerTy())
1942 return nullptr;
1943
Sanjay Pateld3112a52016-01-19 19:46:10 +00001944 Value *Len = emitStrLen(CI->getArgOperand(2), B, DL, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +00001945 if (!Len)
1946 return nullptr;
David Majnemerabb9f552016-04-26 21:04:47 +00001947 Value *IncLen =
1948 B.CreateAdd(Len, ConstantInt::get(Len->getType(), 1), "leninc");
Daniel Neilson8acd8b02018-02-05 21:23:22 +00001949 B.CreateMemCpy(CI->getArgOperand(0), 1, CI->getArgOperand(2), 1, IncLen);
Chris Bienemanad070d02014-09-17 20:55:46 +00001950
1951 // The sprintf result is the unincremented number of bytes in the string.
1952 return B.CreateIntCast(Len, CI->getType(), false);
1953 }
1954 return nullptr;
1955}
1956
1957Value *LibCallSimplifier::optimizeSPrintF(CallInst *CI, IRBuilder<> &B) {
1958 Function *Callee = CI->getCalledFunction();
Chris Bienemanad070d02014-09-17 20:55:46 +00001959 FunctionType *FT = Callee->getFunctionType();
Chris Bienemanad070d02014-09-17 20:55:46 +00001960 if (Value *V = optimizeSPrintFString(CI, B)) {
1961 return V;
1962 }
1963
1964 // sprintf(str, format, ...) -> siprintf(str, format, ...) if no floating
1965 // point arguments.
David L. Jonesd21529f2017-01-23 23:16:46 +00001966 if (TLI->has(LibFunc_siprintf) && !callHasFloatingPointArgument(CI)) {
Chris Bienemanad070d02014-09-17 20:55:46 +00001967 Module *M = B.GetInsertBlock()->getParent()->getParent();
1968 Constant *SIPrintFFn =
1969 M->getOrInsertFunction("siprintf", FT, Callee->getAttributes());
1970 CallInst *New = cast<CallInst>(CI->clone());
1971 New->setCalledFunction(SIPrintFFn);
1972 B.Insert(New);
1973 return New;
1974 }
1975 return nullptr;
1976}
1977
David Bolvanskycd93c4e2018-05-11 17:50:49 +00001978Value *LibCallSimplifier::optimizeSnPrintFString(CallInst *CI, IRBuilder<> &B) {
1979 // Check for a fixed format string.
1980 StringRef FormatStr;
1981 if (!getConstantStringInfo(CI->getArgOperand(2), FormatStr))
1982 return nullptr;
1983
1984 // Check for size
1985 ConstantInt *Size = dyn_cast<ConstantInt>(CI->getArgOperand(1));
1986 if (!Size)
1987 return nullptr;
1988
1989 uint64_t N = Size->getZExtValue();
1990
1991 // If we just have a format string (nothing else crazy) transform it.
1992 if (CI->getNumArgOperands() == 3) {
1993 // Make sure there's no % in the constant array. We could try to handle
1994 // %% -> % in the future if we cared.
David Bolvansky5430b7372018-05-31 16:39:27 +00001995 if (FormatStr.find('%') != StringRef::npos)
1996 return nullptr; // we found a format specifier, bail out.
David Bolvanskycd93c4e2018-05-11 17:50:49 +00001997
1998 if (N == 0)
1999 return ConstantInt::get(CI->getType(), FormatStr.size());
2000 else if (N < FormatStr.size() + 1)
2001 return nullptr;
2002
2003 // sprintf(str, size, fmt) -> llvm.memcpy(align 1 str, align 1 fmt,
2004 // strlen(fmt)+1)
2005 B.CreateMemCpy(
2006 CI->getArgOperand(0), 1, CI->getArgOperand(2), 1,
2007 ConstantInt::get(DL.getIntPtrType(CI->getContext()),
2008 FormatStr.size() + 1)); // Copy the null byte.
2009 return ConstantInt::get(CI->getType(), FormatStr.size());
2010 }
2011
2012 // The remaining optimizations require the format string to be "%s" or "%c"
2013 // and have an extra operand.
2014 if (FormatStr.size() == 2 && FormatStr[0] == '%' &&
2015 CI->getNumArgOperands() == 4) {
2016
2017 // Decode the second character of the format string.
2018 if (FormatStr[1] == 'c') {
2019 if (N == 0)
2020 return ConstantInt::get(CI->getType(), 1);
2021 else if (N == 1)
2022 return nullptr;
2023
2024 // snprintf(dst, size, "%c", chr) --> *(i8*)dst = chr; *((i8*)dst+1) = 0
2025 if (!CI->getArgOperand(3)->getType()->isIntegerTy())
2026 return nullptr;
2027 Value *V = B.CreateTrunc(CI->getArgOperand(3), B.getInt8Ty(), "char");
2028 Value *Ptr = castToCStr(CI->getArgOperand(0), B);
2029 B.CreateStore(V, Ptr);
2030 Ptr = B.CreateGEP(B.getInt8Ty(), Ptr, B.getInt32(1), "nul");
2031 B.CreateStore(B.getInt8(0), Ptr);
2032
2033 return ConstantInt::get(CI->getType(), 1);
2034 }
2035
2036 if (FormatStr[1] == 's') {
2037 // snprintf(dest, size, "%s", str) to llvm.memcpy(dest, str, len+1, 1)
2038 StringRef Str;
2039 if (!getConstantStringInfo(CI->getArgOperand(3), Str))
2040 return nullptr;
2041
2042 if (N == 0)
2043 return ConstantInt::get(CI->getType(), Str.size());
2044 else if (N < Str.size() + 1)
2045 return nullptr;
2046
2047 B.CreateMemCpy(CI->getArgOperand(0), 1, CI->getArgOperand(3), 1,
2048 ConstantInt::get(CI->getType(), Str.size() + 1));
2049
2050 // The snprintf result is the unincremented number of bytes in the string.
2051 return ConstantInt::get(CI->getType(), Str.size());
2052 }
2053 }
2054 return nullptr;
2055}
2056
2057Value *LibCallSimplifier::optimizeSnPrintF(CallInst *CI, IRBuilder<> &B) {
2058 if (Value *V = optimizeSnPrintFString(CI, B)) {
2059 return V;
2060 }
2061
2062 return nullptr;
2063}
2064
Chris Bienemanad070d02014-09-17 20:55:46 +00002065Value *LibCallSimplifier::optimizeFPrintFString(CallInst *CI, IRBuilder<> &B) {
2066 optimizeErrorReporting(CI, B, 0);
2067
2068 // All the optimizations depend on the format string.
2069 StringRef FormatStr;
2070 if (!getConstantStringInfo(CI->getArgOperand(1), FormatStr))
2071 return nullptr;
2072
2073 // Do not do any of the following transformations if the fprintf return
2074 // value is used, in general the fprintf return value is not compatible
2075 // with fwrite(), fputc() or fputs().
2076 if (!CI->use_empty())
2077 return nullptr;
2078
2079 // fprintf(F, "foo") --> fwrite("foo", 3, 1, F)
2080 if (CI->getNumArgOperands() == 2) {
David Bolvansky5430b7372018-05-31 16:39:27 +00002081 // Could handle %% -> % if we cared.
2082 if (FormatStr.find('%') != StringRef::npos)
2083 return nullptr; // We found a format specifier.
Chris Bienemanad070d02014-09-17 20:55:46 +00002084
Sanjay Pateld3112a52016-01-19 19:46:10 +00002085 return emitFWrite(
Chris Bienemanad070d02014-09-17 20:55:46 +00002086 CI->getArgOperand(1),
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002087 ConstantInt::get(DL.getIntPtrType(CI->getContext()), FormatStr.size()),
Chris Bienemanad070d02014-09-17 20:55:46 +00002088 CI->getArgOperand(0), B, DL, TLI);
2089 }
2090
2091 // The remaining optimizations require the format string to be "%s" or "%c"
2092 // and have an extra operand.
2093 if (FormatStr.size() != 2 || FormatStr[0] != '%' ||
2094 CI->getNumArgOperands() < 3)
2095 return nullptr;
2096
2097 // Decode the second character of the format string.
2098 if (FormatStr[1] == 'c') {
2099 // fprintf(F, "%c", chr) --> fputc(chr, F)
2100 if (!CI->getArgOperand(2)->getType()->isIntegerTy())
2101 return nullptr;
Sanjay Pateld3112a52016-01-19 19:46:10 +00002102 return emitFPutC(CI->getArgOperand(2), CI->getArgOperand(0), B, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +00002103 }
2104
2105 if (FormatStr[1] == 's') {
2106 // fprintf(F, "%s", str) --> fputs(str, F)
2107 if (!CI->getArgOperand(2)->getType()->isPointerTy())
2108 return nullptr;
Sanjay Pateld3112a52016-01-19 19:46:10 +00002109 return emitFPutS(CI->getArgOperand(2), CI->getArgOperand(0), B, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +00002110 }
2111 return nullptr;
2112}
2113
2114Value *LibCallSimplifier::optimizeFPrintF(CallInst *CI, IRBuilder<> &B) {
2115 Function *Callee = CI->getCalledFunction();
Chris Bienemanad070d02014-09-17 20:55:46 +00002116 FunctionType *FT = Callee->getFunctionType();
Chris Bienemanad070d02014-09-17 20:55:46 +00002117 if (Value *V = optimizeFPrintFString(CI, B)) {
2118 return V;
2119 }
2120
2121 // fprintf(stream, format, ...) -> fiprintf(stream, format, ...) if no
2122 // floating point arguments.
David L. Jonesd21529f2017-01-23 23:16:46 +00002123 if (TLI->has(LibFunc_fiprintf) && !callHasFloatingPointArgument(CI)) {
Chris Bienemanad070d02014-09-17 20:55:46 +00002124 Module *M = B.GetInsertBlock()->getParent()->getParent();
2125 Constant *FIPrintFFn =
2126 M->getOrInsertFunction("fiprintf", FT, Callee->getAttributes());
2127 CallInst *New = cast<CallInst>(CI->clone());
2128 New->setCalledFunction(FIPrintFFn);
2129 B.Insert(New);
2130 return New;
2131 }
2132 return nullptr;
2133}
2134
2135Value *LibCallSimplifier::optimizeFWrite(CallInst *CI, IRBuilder<> &B) {
2136 optimizeErrorReporting(CI, B, 3);
2137
Chris Bienemanad070d02014-09-17 20:55:46 +00002138 // Get the element size and count.
2139 ConstantInt *SizeC = dyn_cast<ConstantInt>(CI->getArgOperand(1));
2140 ConstantInt *CountC = dyn_cast<ConstantInt>(CI->getArgOperand(2));
David Bolvanskyca22d422018-05-16 11:39:52 +00002141 if (SizeC && CountC) {
2142 uint64_t Bytes = SizeC->getZExtValue() * CountC->getZExtValue();
Chris Bienemanad070d02014-09-17 20:55:46 +00002143
David Bolvanskyca22d422018-05-16 11:39:52 +00002144 // If this is writing zero records, remove the call (it's a noop).
2145 if (Bytes == 0)
2146 return ConstantInt::get(CI->getType(), 0);
Chris Bienemanad070d02014-09-17 20:55:46 +00002147
David Bolvanskyca22d422018-05-16 11:39:52 +00002148 // If this is writing one byte, turn it into fputc.
2149 // This optimisation is only valid, if the return value is unused.
2150 if (Bytes == 1 && CI->use_empty()) { // fwrite(S,1,1,F) -> fputc(S[0],F)
2151 Value *Char = B.CreateLoad(castToCStr(CI->getArgOperand(0), B), "char");
2152 Value *NewCI = emitFPutC(Char, CI->getArgOperand(3), B, TLI);
2153 return NewCI ? ConstantInt::get(CI->getType(), 1) : nullptr;
2154 }
Chris Bienemanad070d02014-09-17 20:55:46 +00002155 }
2156
David Bolvanskyca22d422018-05-16 11:39:52 +00002157 if (isLocallyOpenedFile(CI->getArgOperand(3), CI, B, TLI))
2158 return emitFWriteUnlocked(CI->getArgOperand(0), CI->getArgOperand(1),
2159 CI->getArgOperand(2), CI->getArgOperand(3), B, DL,
2160 TLI);
2161
Chris Bienemanad070d02014-09-17 20:55:46 +00002162 return nullptr;
2163}
2164
2165Value *LibCallSimplifier::optimizeFPuts(CallInst *CI, IRBuilder<> &B) {
2166 optimizeErrorReporting(CI, B, 1);
2167
Sjoerd Meijer7435a912016-07-07 14:31:19 +00002168 // Don't rewrite fputs to fwrite when optimising for size because fwrite
2169 // requires more arguments and thus extra MOVs are required.
David Bolvansky5430b7372018-05-31 16:39:27 +00002170 if (CI->getFunction()->optForSize())
Sjoerd Meijer7435a912016-07-07 14:31:19 +00002171 return nullptr;
2172
David Bolvanskyca22d422018-05-16 11:39:52 +00002173 // Check if has any use
2174 if (!CI->use_empty()) {
2175 if (isLocallyOpenedFile(CI->getArgOperand(1), CI, B, TLI))
2176 return emitFPutSUnlocked(CI->getArgOperand(0), CI->getArgOperand(1), B,
2177 TLI);
2178 else
2179 // We can't optimize if return value is used.
2180 return nullptr;
2181 }
Chris Bienemanad070d02014-09-17 20:55:46 +00002182
2183 // fputs(s,F) --> fwrite(s,1,strlen(s),F)
David Bolvansky1f343fa2018-05-22 20:27:36 +00002184 uint64_t Len = GetStringLength(CI->getArgOperand(0));
Chris Bienemanad070d02014-09-17 20:55:46 +00002185 if (!Len)
2186 return nullptr;
2187
2188 // Known to have no uses (see above).
Sanjay Pateld3112a52016-01-19 19:46:10 +00002189 return emitFWrite(
Chris Bienemanad070d02014-09-17 20:55:46 +00002190 CI->getArgOperand(0),
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002191 ConstantInt::get(DL.getIntPtrType(CI->getContext()), Len - 1),
Chris Bienemanad070d02014-09-17 20:55:46 +00002192 CI->getArgOperand(1), B, DL, TLI);
2193}
2194
David Bolvanskyca22d422018-05-16 11:39:52 +00002195Value *LibCallSimplifier::optimizeFPutc(CallInst *CI, IRBuilder<> &B) {
2196 optimizeErrorReporting(CI, B, 1);
2197
2198 if (isLocallyOpenedFile(CI->getArgOperand(1), CI, B, TLI))
2199 return emitFPutCUnlocked(CI->getArgOperand(0), CI->getArgOperand(1), B,
2200 TLI);
2201
2202 return nullptr;
2203}
2204
2205Value *LibCallSimplifier::optimizeFGetc(CallInst *CI, IRBuilder<> &B) {
2206 if (isLocallyOpenedFile(CI->getArgOperand(0), CI, B, TLI))
2207 return emitFGetCUnlocked(CI->getArgOperand(0), B, TLI);
2208
2209 return nullptr;
2210}
2211
2212Value *LibCallSimplifier::optimizeFGets(CallInst *CI, IRBuilder<> &B) {
2213 if (isLocallyOpenedFile(CI->getArgOperand(2), CI, B, TLI))
2214 return emitFGetSUnlocked(CI->getArgOperand(0), CI->getArgOperand(1),
2215 CI->getArgOperand(2), B, TLI);
2216
2217 return nullptr;
2218}
2219
2220Value *LibCallSimplifier::optimizeFRead(CallInst *CI, IRBuilder<> &B) {
2221 if (isLocallyOpenedFile(CI->getArgOperand(3), CI, B, TLI))
2222 return emitFReadUnlocked(CI->getArgOperand(0), CI->getArgOperand(1),
2223 CI->getArgOperand(2), CI->getArgOperand(3), B, DL,
2224 TLI);
2225
2226 return nullptr;
2227}
2228
Chris Bienemanad070d02014-09-17 20:55:46 +00002229Value *LibCallSimplifier::optimizePuts(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +00002230 // Check for a constant string.
2231 StringRef Str;
2232 if (!getConstantStringInfo(CI->getArgOperand(0), Str))
2233 return nullptr;
2234
2235 if (Str.empty() && CI->use_empty()) {
2236 // puts("") -> putchar('\n')
Sanjay Pateld3112a52016-01-19 19:46:10 +00002237 Value *Res = emitPutChar(B.getInt32('\n'), B, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +00002238 if (CI->use_empty() || !Res)
2239 return Res;
2240 return B.CreateIntCast(Res, CI->getType(), true);
2241 }
2242
2243 return nullptr;
2244}
2245
2246bool LibCallSimplifier::hasFloatVersion(StringRef FuncName) {
David L. Jonesd21529f2017-01-23 23:16:46 +00002247 LibFunc Func;
Meador Inge20255ef2013-03-12 00:08:29 +00002248 SmallString<20> FloatFuncName = FuncName;
2249 FloatFuncName += 'f';
2250 if (TLI->getLibFunc(FloatFuncName, Func))
2251 return TLI->has(Func);
2252 return false;
2253}
Meador Inge7fb2f732012-10-13 16:45:32 +00002254
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002255Value *LibCallSimplifier::optimizeStringMemoryLibCall(CallInst *CI,
2256 IRBuilder<> &Builder) {
David L. Jonesd21529f2017-01-23 23:16:46 +00002257 LibFunc Func;
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002258 Function *Callee = CI->getCalledFunction();
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002259 // Check for string/memory library functions.
Ahmed Bougachad765a822016-04-27 19:04:35 +00002260 if (TLI->getLibFunc(*Callee, Func) && TLI->has(Func)) {
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002261 // Make sure we never change the calling convention.
2262 assert((ignoreCallingConv(Func) ||
Sam Parker214f7bf2016-09-13 12:10:14 +00002263 isCallingConvCCompatible(CI)) &&
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002264 "Optimizing string/memory libcall would change the calling convention");
2265 switch (Func) {
David L. Jonesd21529f2017-01-23 23:16:46 +00002266 case LibFunc_strcat:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002267 return optimizeStrCat(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002268 case LibFunc_strncat:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002269 return optimizeStrNCat(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002270 case LibFunc_strchr:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002271 return optimizeStrChr(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002272 case LibFunc_strrchr:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002273 return optimizeStrRChr(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002274 case LibFunc_strcmp:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002275 return optimizeStrCmp(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002276 case LibFunc_strncmp:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002277 return optimizeStrNCmp(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002278 case LibFunc_strcpy:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002279 return optimizeStrCpy(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002280 case LibFunc_stpcpy:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002281 return optimizeStpCpy(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002282 case LibFunc_strncpy:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002283 return optimizeStrNCpy(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002284 case LibFunc_strlen:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002285 return optimizeStrLen(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002286 case LibFunc_strpbrk:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002287 return optimizeStrPBrk(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002288 case LibFunc_strtol:
2289 case LibFunc_strtod:
2290 case LibFunc_strtof:
2291 case LibFunc_strtoul:
2292 case LibFunc_strtoll:
2293 case LibFunc_strtold:
2294 case LibFunc_strtoull:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002295 return optimizeStrTo(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002296 case LibFunc_strspn:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002297 return optimizeStrSpn(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002298 case LibFunc_strcspn:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002299 return optimizeStrCSpn(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002300 case LibFunc_strstr:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002301 return optimizeStrStr(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002302 case LibFunc_memchr:
Benjamin Kramer691363e2015-03-21 15:36:21 +00002303 return optimizeMemChr(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002304 case LibFunc_memcmp:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002305 return optimizeMemCmp(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002306 case LibFunc_memcpy:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002307 return optimizeMemCpy(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002308 case LibFunc_memmove:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002309 return optimizeMemMove(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002310 case LibFunc_memset:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002311 return optimizeMemSet(CI, Builder);
Sanjay Patelb2ab3f22018-04-18 14:21:31 +00002312 case LibFunc_realloc:
2313 return optimizeRealloc(CI, Builder);
Matthias Braun50ec0b52017-05-19 22:37:09 +00002314 case LibFunc_wcslen:
2315 return optimizeWcslen(CI, Builder);
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002316 default:
2317 break;
2318 }
2319 }
2320 return nullptr;
2321}
2322
Andrew Kaylor53a5fbb2017-08-14 21:15:13 +00002323Value *LibCallSimplifier::optimizeFloatingPointLibCall(CallInst *CI,
2324 LibFunc Func,
2325 IRBuilder<> &Builder) {
2326 // Don't optimize calls that require strict floating point semantics.
2327 if (CI->isStrictFP())
2328 return nullptr;
2329
2330 switch (Func) {
2331 case LibFunc_cosf:
2332 case LibFunc_cos:
2333 case LibFunc_cosl:
2334 return optimizeCos(CI, Builder);
2335 case LibFunc_sinpif:
2336 case LibFunc_sinpi:
2337 case LibFunc_cospif:
2338 case LibFunc_cospi:
2339 return optimizeSinCosPi(CI, Builder);
2340 case LibFunc_powf:
2341 case LibFunc_pow:
2342 case LibFunc_powl:
2343 return optimizePow(CI, Builder);
2344 case LibFunc_exp2l:
2345 case LibFunc_exp2:
2346 case LibFunc_exp2f:
2347 return optimizeExp2(CI, Builder);
2348 case LibFunc_fabsf:
2349 case LibFunc_fabs:
2350 case LibFunc_fabsl:
2351 return replaceUnaryCall(CI, Builder, Intrinsic::fabs);
2352 case LibFunc_sqrtf:
2353 case LibFunc_sqrt:
2354 case LibFunc_sqrtl:
2355 return optimizeSqrt(CI, Builder);
2356 case LibFunc_log:
2357 case LibFunc_log10:
2358 case LibFunc_log1p:
2359 case LibFunc_log2:
2360 case LibFunc_logb:
2361 return optimizeLog(CI, Builder);
2362 case LibFunc_tan:
2363 case LibFunc_tanf:
2364 case LibFunc_tanl:
2365 return optimizeTan(CI, Builder);
2366 case LibFunc_ceil:
2367 return replaceUnaryCall(CI, Builder, Intrinsic::ceil);
2368 case LibFunc_floor:
2369 return replaceUnaryCall(CI, Builder, Intrinsic::floor);
2370 case LibFunc_round:
2371 return replaceUnaryCall(CI, Builder, Intrinsic::round);
2372 case LibFunc_nearbyint:
2373 return replaceUnaryCall(CI, Builder, Intrinsic::nearbyint);
2374 case LibFunc_rint:
2375 return replaceUnaryCall(CI, Builder, Intrinsic::rint);
2376 case LibFunc_trunc:
2377 return replaceUnaryCall(CI, Builder, Intrinsic::trunc);
2378 case LibFunc_acos:
2379 case LibFunc_acosh:
2380 case LibFunc_asin:
2381 case LibFunc_asinh:
2382 case LibFunc_atan:
2383 case LibFunc_atanh:
2384 case LibFunc_cbrt:
2385 case LibFunc_cosh:
2386 case LibFunc_exp:
2387 case LibFunc_exp10:
2388 case LibFunc_expm1:
2389 case LibFunc_sin:
2390 case LibFunc_sinh:
2391 case LibFunc_tanh:
2392 if (UnsafeFPShrink && hasFloatVersion(CI->getCalledFunction()->getName()))
2393 return optimizeUnaryDoubleFP(CI, Builder, true);
2394 return nullptr;
2395 case LibFunc_copysign:
2396 if (hasFloatVersion(CI->getCalledFunction()->getName()))
2397 return optimizeBinaryDoubleFP(CI, Builder);
2398 return nullptr;
2399 case LibFunc_fminf:
2400 case LibFunc_fmin:
2401 case LibFunc_fminl:
2402 case LibFunc_fmaxf:
2403 case LibFunc_fmax:
2404 case LibFunc_fmaxl:
2405 return optimizeFMinFMax(CI, Builder);
Hal Finkel2ff24732017-12-16 01:26:25 +00002406 case LibFunc_cabs:
2407 case LibFunc_cabsf:
2408 case LibFunc_cabsl:
2409 return optimizeCAbs(CI, Builder);
Andrew Kaylor53a5fbb2017-08-14 21:15:13 +00002410 default:
2411 return nullptr;
2412 }
2413}
2414
Chris Bienemanad070d02014-09-17 20:55:46 +00002415Value *LibCallSimplifier::optimizeCall(CallInst *CI) {
Andrew Kaylor53a5fbb2017-08-14 21:15:13 +00002416 // TODO: Split out the code below that operates on FP calls so that
2417 // we can all non-FP calls with the StrictFP attribute to be
2418 // optimized.
Chris Bienemanad070d02014-09-17 20:55:46 +00002419 if (CI->isNoBuiltin())
2420 return nullptr;
Meador Inge4d2827c2012-11-11 05:11:20 +00002421
David L. Jonesd21529f2017-01-23 23:16:46 +00002422 LibFunc Func;
Meador Inge20255ef2013-03-12 00:08:29 +00002423 Function *Callee = CI->getCalledFunction();
David Majnemerb70e23c2016-01-06 05:01:34 +00002424
2425 SmallVector<OperandBundleDef, 2> OpBundles;
2426 CI->getOperandBundlesAsDefs(OpBundles);
2427 IRBuilder<> Builder(CI, /*FPMathTag=*/nullptr, OpBundles);
Sam Parker214f7bf2016-09-13 12:10:14 +00002428 bool isCallingConvC = isCallingConvCCompatible(CI);
Meador Inge20255ef2013-03-12 00:08:29 +00002429
Sanjay Pateld1f4f032016-01-19 18:38:52 +00002430 // Command-line parameter overrides instruction attribute.
Andrew Kaylor53a5fbb2017-08-14 21:15:13 +00002431 // This can't be moved to optimizeFloatingPointLibCall() because it may be
Sanjay Patel629c4112017-11-06 16:27:15 +00002432 // used by the intrinsic optimizations.
Sanjay Patela92fa442014-10-22 15:29:23 +00002433 if (EnableUnsafeFPShrink.getNumOccurrences() > 0)
2434 UnsafeFPShrink = EnableUnsafeFPShrink;
Sanjay Patel629c4112017-11-06 16:27:15 +00002435 else if (isa<FPMathOperator>(CI) && CI->isFast())
Davide Italianoa904e522015-10-29 02:58:44 +00002436 UnsafeFPShrink = true;
Sanjay Patela92fa442014-10-22 15:29:23 +00002437
Sanjay Patel848309d2014-10-23 21:52:45 +00002438 // First, check for intrinsics.
Meador Inge20255ef2013-03-12 00:08:29 +00002439 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(CI)) {
Chris Bienemanad070d02014-09-17 20:55:46 +00002440 if (!isCallingConvC)
2441 return nullptr;
Andrew Kaylor53a5fbb2017-08-14 21:15:13 +00002442 // The FP intrinsics have corresponding constrained versions so we don't
2443 // need to check for the StrictFP attribute here.
Meador Inge20255ef2013-03-12 00:08:29 +00002444 switch (II->getIntrinsicID()) {
2445 case Intrinsic::pow:
Chris Bienemanad070d02014-09-17 20:55:46 +00002446 return optimizePow(CI, Builder);
Meador Inge20255ef2013-03-12 00:08:29 +00002447 case Intrinsic::exp2:
Chris Bienemanad070d02014-09-17 20:55:46 +00002448 return optimizeExp2(CI, Builder);
Davide Italianob8b71332015-11-29 20:58:04 +00002449 case Intrinsic::log:
2450 return optimizeLog(CI, Builder);
Sanjay Patelc699a612014-10-16 18:48:17 +00002451 case Intrinsic::sqrt:
2452 return optimizeSqrt(CI, Builder);
Sanjay Patel980b2802016-01-26 16:17:24 +00002453 // TODO: Use foldMallocMemset() with memset intrinsic.
Meador Inge20255ef2013-03-12 00:08:29 +00002454 default:
Chris Bienemanad070d02014-09-17 20:55:46 +00002455 return nullptr;
Meador Inge20255ef2013-03-12 00:08:29 +00002456 }
2457 }
2458
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002459 // Also try to simplify calls to fortified library functions.
2460 if (Value *SimplifiedFortifiedCI = FortifiedSimplifier.optimizeCall(CI)) {
2461 // Try to further simplify the result.
Ahmed Bougacha71d7b182015-01-14 00:55:05 +00002462 CallInst *SimplifiedCI = dyn_cast<CallInst>(SimplifiedFortifiedCI);
Bruno Cardoso Lopesb491a2d2015-10-01 22:43:53 +00002463 if (SimplifiedCI && SimplifiedCI->getCalledFunction()) {
2464 // Use an IR Builder from SimplifiedCI if available instead of CI
2465 // to guarantee we reach all uses we might replace later on.
2466 IRBuilder<> TmpBuilder(SimplifiedCI);
2467 if (Value *V = optimizeStringMemoryLibCall(SimplifiedCI, TmpBuilder)) {
Ahmed Bougacha1ac93562015-01-27 21:52:16 +00002468 // If we were able to further simplify, remove the now redundant call.
2469 SimplifiedCI->replaceAllUsesWith(V);
2470 SimplifiedCI->eraseFromParent();
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002471 return V;
Ahmed Bougacha1ac93562015-01-27 21:52:16 +00002472 }
Bruno Cardoso Lopesb491a2d2015-10-01 22:43:53 +00002473 }
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002474 return SimplifiedFortifiedCI;
2475 }
2476
Meador Inge20255ef2013-03-12 00:08:29 +00002477 // Then check for known library functions.
Ahmed Bougachad765a822016-04-27 19:04:35 +00002478 if (TLI->getLibFunc(*Callee, Func) && TLI->has(Func)) {
Chris Bienemanad070d02014-09-17 20:55:46 +00002479 // We never change the calling convention.
2480 if (!ignoreCallingConv(Func) && !isCallingConvC)
2481 return nullptr;
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002482 if (Value *V = optimizeStringMemoryLibCall(CI, Builder))
2483 return V;
Andrew Kaylor53a5fbb2017-08-14 21:15:13 +00002484 if (Value *V = optimizeFloatingPointLibCall(CI, Func, Builder))
2485 return V;
Meador Inge20255ef2013-03-12 00:08:29 +00002486 switch (Func) {
David L. Jonesd21529f2017-01-23 23:16:46 +00002487 case LibFunc_ffs:
2488 case LibFunc_ffsl:
2489 case LibFunc_ffsll:
Chris Bienemanad070d02014-09-17 20:55:46 +00002490 return optimizeFFS(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002491 case LibFunc_fls:
2492 case LibFunc_flsl:
2493 case LibFunc_flsll:
Davide Italiano85ad36b2016-12-15 23:45:11 +00002494 return optimizeFls(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002495 case LibFunc_abs:
2496 case LibFunc_labs:
2497 case LibFunc_llabs:
Chris Bienemanad070d02014-09-17 20:55:46 +00002498 return optimizeAbs(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002499 case LibFunc_isdigit:
Chris Bienemanad070d02014-09-17 20:55:46 +00002500 return optimizeIsDigit(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002501 case LibFunc_isascii:
Chris Bienemanad070d02014-09-17 20:55:46 +00002502 return optimizeIsAscii(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002503 case LibFunc_toascii:
Chris Bienemanad070d02014-09-17 20:55:46 +00002504 return optimizeToAscii(CI, Builder);
David Bolvanskycb8ca5f32018-04-25 18:58:53 +00002505 case LibFunc_atoi:
2506 case LibFunc_atol:
2507 case LibFunc_atoll:
2508 return optimizeAtoi(CI, Builder);
2509 case LibFunc_strtol:
2510 case LibFunc_strtoll:
2511 return optimizeStrtol(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002512 case LibFunc_printf:
Chris Bienemanad070d02014-09-17 20:55:46 +00002513 return optimizePrintF(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002514 case LibFunc_sprintf:
Chris Bienemanad070d02014-09-17 20:55:46 +00002515 return optimizeSPrintF(CI, Builder);
David Bolvanskycd93c4e2018-05-11 17:50:49 +00002516 case LibFunc_snprintf:
2517 return optimizeSnPrintF(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002518 case LibFunc_fprintf:
Chris Bienemanad070d02014-09-17 20:55:46 +00002519 return optimizeFPrintF(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002520 case LibFunc_fwrite:
Chris Bienemanad070d02014-09-17 20:55:46 +00002521 return optimizeFWrite(CI, Builder);
David Bolvanskyca22d422018-05-16 11:39:52 +00002522 case LibFunc_fread:
2523 return optimizeFRead(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002524 case LibFunc_fputs:
Chris Bienemanad070d02014-09-17 20:55:46 +00002525 return optimizeFPuts(CI, Builder);
David Bolvanskyca22d422018-05-16 11:39:52 +00002526 case LibFunc_fgets:
2527 return optimizeFGets(CI, Builder);
2528 case LibFunc_fputc:
2529 return optimizeFPutc(CI, Builder);
2530 case LibFunc_fgetc:
2531 return optimizeFGetc(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002532 case LibFunc_puts:
Chris Bienemanad070d02014-09-17 20:55:46 +00002533 return optimizePuts(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002534 case LibFunc_perror:
Chris Bienemanad070d02014-09-17 20:55:46 +00002535 return optimizeErrorReporting(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002536 case LibFunc_vfprintf:
2537 case LibFunc_fiprintf:
Chris Bienemanad070d02014-09-17 20:55:46 +00002538 return optimizeErrorReporting(CI, Builder, 0);
Chris Bienemanad070d02014-09-17 20:55:46 +00002539 default:
2540 return nullptr;
2541 }
Meador Inge20255ef2013-03-12 00:08:29 +00002542 }
Craig Topperf40110f2014-04-25 05:29:35 +00002543 return nullptr;
Meador Ingedf796f82012-10-13 16:45:24 +00002544}
2545
Chandler Carruth92803822015-01-21 02:11:59 +00002546LibCallSimplifier::LibCallSimplifier(
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002547 const DataLayout &DL, const TargetLibraryInfo *TLI,
Adam Nemetea06e6e2017-07-26 19:03:18 +00002548 OptimizationRemarkEmitter &ORE,
Chandler Carruth92803822015-01-21 02:11:59 +00002549 function_ref<void(Instruction *, Value *)> Replacer)
Adam Nemetea06e6e2017-07-26 19:03:18 +00002550 : FortifiedSimplifier(TLI), DL(DL), TLI(TLI), ORE(ORE),
2551 UnsafeFPShrink(false), Replacer(Replacer) {}
Chandler Carruth92803822015-01-21 02:11:59 +00002552
2553void LibCallSimplifier::replaceAllUsesWith(Instruction *I, Value *With) {
2554 // Indirect through the replacer used in this instance.
2555 Replacer(I, With);
Meador Ingedf796f82012-10-13 16:45:24 +00002556}
2557
Meador Ingedfb08a22013-06-20 19:48:07 +00002558// TODO:
2559// Additional cases that we need to add to this file:
2560//
2561// cbrt:
2562// * cbrt(expN(X)) -> expN(x/3)
2563// * cbrt(sqrt(x)) -> pow(x,1/6)
David Majnemer3354fe42015-08-26 18:30:16 +00002564// * cbrt(cbrt(x)) -> pow(x,1/9)
Meador Ingedfb08a22013-06-20 19:48:07 +00002565//
2566// exp, expf, expl:
2567// * exp(log(x)) -> x
2568//
2569// log, logf, logl:
2570// * log(exp(x)) -> x
Meador Ingedfb08a22013-06-20 19:48:07 +00002571// * log(exp(y)) -> y*log(e)
Meador Ingedfb08a22013-06-20 19:48:07 +00002572// * log(exp10(y)) -> y*log(10)
2573// * log(sqrt(x)) -> 0.5*log(x)
Meador Ingedfb08a22013-06-20 19:48:07 +00002574//
Meador Ingedfb08a22013-06-20 19:48:07 +00002575// pow, powf, powl:
Meador Ingedfb08a22013-06-20 19:48:07 +00002576// * pow(sqrt(x),y) -> pow(x,y*0.5)
2577// * pow(pow(x,y),z)-> pow(x,y*z)
2578//
Meador Ingedfb08a22013-06-20 19:48:07 +00002579// signbit:
2580// * signbit(cnst) -> cnst'
2581// * signbit(nncst) -> 0 (if pstv is a non-negative constant)
2582//
2583// sqrt, sqrtf, sqrtl:
2584// * sqrt(expN(x)) -> expN(x*0.5)
2585// * sqrt(Nroot(x)) -> pow(x,1/(2*N))
2586// * sqrt(pow(x,y)) -> pow(|x|,y*0.5)
2587//
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002588
2589//===----------------------------------------------------------------------===//
2590// Fortified Library Call Optimizations
2591//===----------------------------------------------------------------------===//
2592
2593bool FortifiedLibCallSimplifier::isFortifiedCallFoldable(CallInst *CI,
2594 unsigned ObjSizeOp,
2595 unsigned SizeOp,
2596 bool isString) {
2597 if (CI->getArgOperand(ObjSizeOp) == CI->getArgOperand(SizeOp))
2598 return true;
2599 if (ConstantInt *ObjSizeCI =
2600 dyn_cast<ConstantInt>(CI->getArgOperand(ObjSizeOp))) {
Craig Topper79ab6432017-07-06 18:39:47 +00002601 if (ObjSizeCI->isMinusOne())
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002602 return true;
2603 // If the object size wasn't -1 (unknown), bail out if we were asked to.
2604 if (OnlyLowerUnknownSize)
2605 return false;
2606 if (isString) {
David Bolvansky1f343fa2018-05-22 20:27:36 +00002607 uint64_t Len = GetStringLength(CI->getArgOperand(SizeOp));
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002608 // If the length is 0 we don't know how long it is and so we can't
2609 // remove the check.
2610 if (Len == 0)
2611 return false;
2612 return ObjSizeCI->getZExtValue() >= Len;
2613 }
2614 if (ConstantInt *SizeCI = dyn_cast<ConstantInt>(CI->getArgOperand(SizeOp)))
2615 return ObjSizeCI->getZExtValue() >= SizeCI->getZExtValue();
2616 }
2617 return false;
2618}
2619
Sanjay Pateld707db92015-12-31 16:10:49 +00002620Value *FortifiedLibCallSimplifier::optimizeMemCpyChk(CallInst *CI,
2621 IRBuilder<> &B) {
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002622 if (isFortifiedCallFoldable(CI, 3, 2, false)) {
Daniel Neilson8acd8b02018-02-05 21:23:22 +00002623 B.CreateMemCpy(CI->getArgOperand(0), 1, CI->getArgOperand(1), 1,
2624 CI->getArgOperand(2));
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002625 return CI->getArgOperand(0);
2626 }
2627 return nullptr;
2628}
2629
Sanjay Pateld707db92015-12-31 16:10:49 +00002630Value *FortifiedLibCallSimplifier::optimizeMemMoveChk(CallInst *CI,
2631 IRBuilder<> &B) {
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002632 if (isFortifiedCallFoldable(CI, 3, 2, false)) {
Daniel Neilson8acd8b02018-02-05 21:23:22 +00002633 B.CreateMemMove(CI->getArgOperand(0), 1, CI->getArgOperand(1), 1,
2634 CI->getArgOperand(2));
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002635 return CI->getArgOperand(0);
2636 }
2637 return nullptr;
2638}
2639
Sanjay Pateld707db92015-12-31 16:10:49 +00002640Value *FortifiedLibCallSimplifier::optimizeMemSetChk(CallInst *CI,
2641 IRBuilder<> &B) {
Sanjay Patel980b2802016-01-26 16:17:24 +00002642 // TODO: Try foldMallocMemset() here.
2643
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002644 if (isFortifiedCallFoldable(CI, 3, 2, false)) {
2645 Value *Val = B.CreateIntCast(CI->getArgOperand(1), B.getInt8Ty(), false);
2646 B.CreateMemSet(CI->getArgOperand(0), Val, CI->getArgOperand(2), 1);
2647 return CI->getArgOperand(0);
2648 }
2649 return nullptr;
2650}
2651
Ahmed Bougacha1ac93562015-01-27 21:52:16 +00002652Value *FortifiedLibCallSimplifier::optimizeStrpCpyChk(CallInst *CI,
2653 IRBuilder<> &B,
David L. Jonesd21529f2017-01-23 23:16:46 +00002654 LibFunc Func) {
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002655 Function *Callee = CI->getCalledFunction();
2656 StringRef Name = Callee->getName();
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002657 const DataLayout &DL = CI->getModule()->getDataLayout();
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002658 Value *Dst = CI->getArgOperand(0), *Src = CI->getArgOperand(1),
2659 *ObjSize = CI->getArgOperand(2);
2660
2661 // __stpcpy_chk(x,x,...) -> x+strlen(x)
David L. Jonesd21529f2017-01-23 23:16:46 +00002662 if (Func == LibFunc_stpcpy_chk && !OnlyLowerUnknownSize && Dst == Src) {
Sanjay Pateld3112a52016-01-19 19:46:10 +00002663 Value *StrLen = emitStrLen(Src, B, DL, TLI);
David Blaikieaa41cd52015-04-03 21:33:42 +00002664 return StrLen ? B.CreateInBoundsGEP(B.getInt8Ty(), Dst, StrLen) : nullptr;
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002665 }
2666
2667 // If a) we don't have any length information, or b) we know this will
2668 // fit then just lower to a plain st[rp]cpy. Otherwise we'll keep our
2669 // st[rp]cpy_chk call which may fail at runtime if the size is too long.
2670 // TODO: It might be nice to get a maximum length out of the possible
2671 // string lengths for varying.
David Blaikie65fab6d2015-04-03 21:32:06 +00002672 if (isFortifiedCallFoldable(CI, 2, 1, true))
Sanjay Pateld3112a52016-01-19 19:46:10 +00002673 return emitStrCpy(Dst, Src, B, TLI, Name.substr(2, 6));
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002674
David Blaikie65fab6d2015-04-03 21:32:06 +00002675 if (OnlyLowerUnknownSize)
2676 return nullptr;
2677
2678 // Maybe we can stil fold __st[rp]cpy_chk to __memcpy_chk.
David Bolvansky1f343fa2018-05-22 20:27:36 +00002679 uint64_t Len = GetStringLength(Src);
David Blaikie65fab6d2015-04-03 21:32:06 +00002680 if (Len == 0)
2681 return nullptr;
2682
2683 Type *SizeTTy = DL.getIntPtrType(CI->getContext());
2684 Value *LenV = ConstantInt::get(SizeTTy, Len);
Sanjay Pateld3112a52016-01-19 19:46:10 +00002685 Value *Ret = emitMemCpyChk(Dst, Src, LenV, ObjSize, B, DL, TLI);
David Blaikie65fab6d2015-04-03 21:32:06 +00002686 // If the function was an __stpcpy_chk, and we were able to fold it into
2687 // a __memcpy_chk, we still need to return the correct end pointer.
David L. Jonesd21529f2017-01-23 23:16:46 +00002688 if (Ret && Func == LibFunc_stpcpy_chk)
David Blaikie65fab6d2015-04-03 21:32:06 +00002689 return B.CreateGEP(B.getInt8Ty(), Dst, ConstantInt::get(SizeTTy, Len - 1));
2690 return Ret;
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002691}
2692
Ahmed Bougacha1ac93562015-01-27 21:52:16 +00002693Value *FortifiedLibCallSimplifier::optimizeStrpNCpyChk(CallInst *CI,
2694 IRBuilder<> &B,
David L. Jonesd21529f2017-01-23 23:16:46 +00002695 LibFunc Func) {
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002696 Function *Callee = CI->getCalledFunction();
2697 StringRef Name = Callee->getName();
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002698 if (isFortifiedCallFoldable(CI, 3, 2, false)) {
Sanjay Pateld3112a52016-01-19 19:46:10 +00002699 Value *Ret = emitStrNCpy(CI->getArgOperand(0), CI->getArgOperand(1),
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002700 CI->getArgOperand(2), B, TLI, Name.substr(2, 7));
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002701 return Ret;
2702 }
2703 return nullptr;
2704}
2705
2706Value *FortifiedLibCallSimplifier::optimizeCall(CallInst *CI) {
Ahmed Bougacha408d0102015-04-01 00:45:09 +00002707 // FIXME: We shouldn't be changing "nobuiltin" or TLI unavailable calls here.
2708 // Some clang users checked for _chk libcall availability using:
2709 // __has_builtin(__builtin___memcpy_chk)
2710 // When compiling with -fno-builtin, this is always true.
2711 // When passing -ffreestanding/-mkernel, which both imply -fno-builtin, we
2712 // end up with fortified libcalls, which isn't acceptable in a freestanding
2713 // environment which only provides their non-fortified counterparts.
2714 //
2715 // Until we change clang and/or teach external users to check for availability
2716 // differently, disregard the "nobuiltin" attribute and TLI::has.
2717 //
2718 // PR23093.
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002719
David L. Jonesd21529f2017-01-23 23:16:46 +00002720 LibFunc Func;
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002721 Function *Callee = CI->getCalledFunction();
David Majnemerb70e23c2016-01-06 05:01:34 +00002722
2723 SmallVector<OperandBundleDef, 2> OpBundles;
2724 CI->getOperandBundlesAsDefs(OpBundles);
2725 IRBuilder<> Builder(CI, /*FPMathTag=*/nullptr, OpBundles);
Sam Parker214f7bf2016-09-13 12:10:14 +00002726 bool isCallingConvC = isCallingConvCCompatible(CI);
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002727
Ahmed Bougachad765a822016-04-27 19:04:35 +00002728 // First, check that this is a known library functions and that the prototype
2729 // is correct.
2730 if (!TLI->getLibFunc(*Callee, Func))
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002731 return nullptr;
2732
2733 // We never change the calling convention.
2734 if (!ignoreCallingConv(Func) && !isCallingConvC)
2735 return nullptr;
2736
2737 switch (Func) {
David L. Jonesd21529f2017-01-23 23:16:46 +00002738 case LibFunc_memcpy_chk:
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002739 return optimizeMemCpyChk(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002740 case LibFunc_memmove_chk:
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002741 return optimizeMemMoveChk(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002742 case LibFunc_memset_chk:
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002743 return optimizeMemSetChk(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002744 case LibFunc_stpcpy_chk:
2745 case LibFunc_strcpy_chk:
Ahmed Bougacha1ac93562015-01-27 21:52:16 +00002746 return optimizeStrpCpyChk(CI, Builder, Func);
David L. Jonesd21529f2017-01-23 23:16:46 +00002747 case LibFunc_stpncpy_chk:
2748 case LibFunc_strncpy_chk:
Ahmed Bougacha1ac93562015-01-27 21:52:16 +00002749 return optimizeStrpNCpyChk(CI, Builder, Func);
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002750 default:
2751 break;
2752 }
2753 return nullptr;
2754}
2755
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002756FortifiedLibCallSimplifier::FortifiedLibCallSimplifier(
2757 const TargetLibraryInfo *TLI, bool OnlyLowerUnknownSize)
Sanjay Patel4b969352018-05-22 23:29:40 +00002758 : TLI(TLI), OnlyLowerUnknownSize(OnlyLowerUnknownSize) {}