blob: bf92399dcf2fb175ee6308aec871de6ce548e755 [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"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000025#include "llvm/IR/DataLayout.h"
26#include "llvm/IR/Function.h"
27#include "llvm/IR/IRBuilder.h"
Meador Inge20255ef2013-03-12 00:08:29 +000028#include "llvm/IR/IntrinsicInst.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000029#include "llvm/IR/Intrinsics.h"
30#include "llvm/IR/LLVMContext.h"
31#include "llvm/IR/Module.h"
Sanjay Patelc699a612014-10-16 18:48:17 +000032#include "llvm/IR/PatternMatch.h"
Hal Finkel66cd3f12013-11-17 02:06:35 +000033#include "llvm/Support/CommandLine.h"
Craig Topperb45eabc2017-04-26 16:39:58 +000034#include "llvm/Support/KnownBits.h"
Meador Ingedf796f82012-10-13 16:45:24 +000035#include "llvm/Transforms/Utils/BuildLibCalls.h"
36
37using namespace llvm;
Sanjay Patelc699a612014-10-16 18:48:17 +000038using namespace PatternMatch;
Meador Ingedf796f82012-10-13 16:45:24 +000039
Hal Finkel66cd3f12013-11-17 02:06:35 +000040static cl::opt<bool>
Sanjay Patela92fa442014-10-22 15:29:23 +000041 EnableUnsafeFPShrink("enable-double-float-shrink", cl::Hidden,
42 cl::init(false),
43 cl::desc("Enable unsafe double to float "
44 "shrinking for math lib calls"));
45
46
Meador Ingedf796f82012-10-13 16:45:24 +000047//===----------------------------------------------------------------------===//
Meador Inged589ac62012-10-31 03:33:06 +000048// Helper Functions
49//===----------------------------------------------------------------------===//
50
David L. Jonesd21529f2017-01-23 23:16:46 +000051static bool ignoreCallingConv(LibFunc Func) {
52 return Func == LibFunc_abs || Func == LibFunc_labs ||
53 Func == LibFunc_llabs || Func == LibFunc_strlen;
Chris Bienemanad070d02014-09-17 20:55:46 +000054}
55
Sam Parker214f7bf2016-09-13 12:10:14 +000056static bool isCallingConvCCompatible(CallInst *CI) {
57 switch(CI->getCallingConv()) {
58 default:
59 return false;
60 case llvm::CallingConv::C:
61 return true;
62 case llvm::CallingConv::ARM_APCS:
63 case llvm::CallingConv::ARM_AAPCS:
64 case llvm::CallingConv::ARM_AAPCS_VFP: {
65
66 // The iOS ABI diverges from the standard in some cases, so for now don't
67 // try to simplify those calls.
68 if (Triple(CI->getModule()->getTargetTriple()).isiOS())
69 return false;
70
71 auto *FuncTy = CI->getFunctionType();
72
73 if (!FuncTy->getReturnType()->isPointerTy() &&
74 !FuncTy->getReturnType()->isIntegerTy() &&
75 !FuncTy->getReturnType()->isVoidTy())
76 return false;
77
78 for (auto Param : FuncTy->params()) {
79 if (!Param->isPointerTy() && !Param->isIntegerTy())
80 return false;
81 }
82 return true;
83 }
84 }
85 return false;
86}
87
Sanjay Pateld707db92015-12-31 16:10:49 +000088/// Return true if it is only used in equality comparisons with With.
Meador Inge56edbc92012-11-11 03:51:48 +000089static bool isOnlyUsedInEqualityComparison(Value *V, Value *With) {
Chandler Carruthcdf47882014-03-09 03:16:01 +000090 for (User *U : V->users()) {
91 if (ICmpInst *IC = dyn_cast<ICmpInst>(U))
Meador Inge56edbc92012-11-11 03:51:48 +000092 if (IC->isEquality() && IC->getOperand(1) == With)
93 continue;
94 // Unknown instruction.
95 return false;
96 }
97 return true;
98}
99
Meador Inge08ca1152012-11-26 20:37:20 +0000100static bool callHasFloatingPointArgument(const CallInst *CI) {
David Majnemer0a16c222016-08-11 21:15:00 +0000101 return any_of(CI->operands(), [](const Use &OI) {
Davide Italianoda3beeb2015-11-28 22:27:48 +0000102 return OI->getType()->isFloatingPointTy();
103 });
Meador Inge08ca1152012-11-26 20:37:20 +0000104}
105
David Bolvanskycb8ca5f32018-04-25 18:58:53 +0000106static Value *convertStrToNumber(CallInst *CI, StringRef &Str, int64_t Base) {
107 if (Base < 2 || Base > 36)
108 // handle special zero base
109 if (Base != 0)
110 return nullptr;
111
112 char *End;
113 std::string nptr = Str.str();
114 errno = 0;
115 long long int Result = strtoll(nptr.c_str(), &End, Base);
116 if (errno)
117 return nullptr;
118
119 // if we assume all possible target locales are ASCII supersets,
120 // then if strtoll successfully parses a number on the host,
121 // it will also successfully parse the same way on the target
122 if (*End != '\0')
123 return nullptr;
124
125 if (!isIntN(CI->getType()->getPrimitiveSizeInBits(), Result))
126 return nullptr;
127
128 return ConstantInt::get(CI->getType(), Result);
129}
130
David Bolvanskyca22d422018-05-16 11:39:52 +0000131static bool isLocallyOpenedFile(Value *File, CallInst *CI, IRBuilder<> &B,
132 const TargetLibraryInfo *TLI) {
133 CallInst *FOpen = dyn_cast<CallInst>(File);
134 if (!FOpen)
135 return false;
136
137 Function *InnerCallee = FOpen->getCalledFunction();
138 if (!InnerCallee)
139 return false;
140
141 LibFunc Func;
142 if (!TLI->getLibFunc(*InnerCallee, Func) || !TLI->has(Func) ||
143 Func != LibFunc_fopen)
144 return false;
145
146 inferLibFuncAttributes(*CI->getCalledFunction(), *TLI);
147 if (PointerMayBeCaptured(File, true, true))
148 return false;
149
150 return true;
151}
152
Meador Inged589ac62012-10-31 03:33:06 +0000153//===----------------------------------------------------------------------===//
Meador Inge7fb2f732012-10-13 16:45:32 +0000154// String and Memory Library Call Optimizations
155//===----------------------------------------------------------------------===//
156
Chris Bienemanad070d02014-09-17 20:55:46 +0000157Value *LibCallSimplifier::optimizeStrCat(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +0000158 // Extract some information from the instruction
159 Value *Dst = CI->getArgOperand(0);
160 Value *Src = CI->getArgOperand(1);
161
162 // See if we can get the length of the input string.
David Bolvansky1f343fa2018-05-22 20:27:36 +0000163 uint64_t Len = GetStringLength(Src);
Chris Bienemanad070d02014-09-17 20:55:46 +0000164 if (Len == 0)
165 return nullptr;
166 --Len; // Unbias length.
167
168 // Handle the simple, do-nothing case: strcat(x, "") -> x
169 if (Len == 0)
170 return Dst;
171
Chris Bienemanad070d02014-09-17 20:55:46 +0000172 return emitStrLenMemCpy(Src, Dst, Len, B);
173}
174
175Value *LibCallSimplifier::emitStrLenMemCpy(Value *Src, Value *Dst, uint64_t Len,
176 IRBuilder<> &B) {
177 // We need to find the end of the destination string. That's where the
178 // memory is to be moved to. We just generate a call to strlen.
Sanjay Pateld3112a52016-01-19 19:46:10 +0000179 Value *DstLen = emitStrLen(Dst, B, DL, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +0000180 if (!DstLen)
181 return nullptr;
182
183 // Now that we have the destination's length, we must index into the
184 // destination's pointer to get the actual memcpy destination (end of
185 // the string .. we're concatenating).
David Blaikie3909da72015-03-30 20:42:56 +0000186 Value *CpyDst = B.CreateGEP(B.getInt8Ty(), Dst, DstLen, "endptr");
Chris Bienemanad070d02014-09-17 20:55:46 +0000187
188 // We have enough information to now generate the memcpy call to do the
189 // concatenation for us. Make a memcpy to copy the nul byte with align = 1.
Daniel Neilson8acd8b02018-02-05 21:23:22 +0000190 B.CreateMemCpy(CpyDst, 1, Src, 1,
191 ConstantInt::get(DL.getIntPtrType(Src->getContext()), Len + 1));
Chris Bienemanad070d02014-09-17 20:55:46 +0000192 return Dst;
193}
194
195Value *LibCallSimplifier::optimizeStrNCat(CallInst *CI, IRBuilder<> &B) {
Sanjay Pateld707db92015-12-31 16:10:49 +0000196 // Extract some information from the instruction.
Chris Bienemanad070d02014-09-17 20:55:46 +0000197 Value *Dst = CI->getArgOperand(0);
198 Value *Src = CI->getArgOperand(1);
199 uint64_t Len;
200
Sanjay Pateld707db92015-12-31 16:10:49 +0000201 // We don't do anything if length is not constant.
Chris Bienemanad070d02014-09-17 20:55:46 +0000202 if (ConstantInt *LengthArg = dyn_cast<ConstantInt>(CI->getArgOperand(2)))
203 Len = LengthArg->getZExtValue();
204 else
205 return nullptr;
206
207 // See if we can get the length of the input string.
David Bolvansky1f343fa2018-05-22 20:27:36 +0000208 uint64_t SrcLen = GetStringLength(Src);
Chris Bienemanad070d02014-09-17 20:55:46 +0000209 if (SrcLen == 0)
210 return nullptr;
211 --SrcLen; // Unbias length.
212
213 // Handle the simple, do-nothing cases:
214 // strncat(x, "", c) -> x
215 // strncat(x, c, 0) -> x
216 if (SrcLen == 0 || Len == 0)
217 return Dst;
218
Sanjay Pateld707db92015-12-31 16:10:49 +0000219 // We don't optimize this case.
Chris Bienemanad070d02014-09-17 20:55:46 +0000220 if (Len < SrcLen)
221 return nullptr;
222
223 // strncat(x, s, c) -> strcat(x, s)
Sanjay Pateld707db92015-12-31 16:10:49 +0000224 // s is constant so the strcat can be optimized further.
Chris Bienemanad070d02014-09-17 20:55:46 +0000225 return emitStrLenMemCpy(Src, Dst, SrcLen, B);
226}
227
228Value *LibCallSimplifier::optimizeStrChr(CallInst *CI, IRBuilder<> &B) {
229 Function *Callee = CI->getCalledFunction();
Chris Bienemanad070d02014-09-17 20:55:46 +0000230 FunctionType *FT = Callee->getFunctionType();
Chris Bienemanad070d02014-09-17 20:55:46 +0000231 Value *SrcStr = CI->getArgOperand(0);
232
233 // If the second operand is non-constant, see if we can compute the length
234 // of the input string and turn this into memchr.
235 ConstantInt *CharC = dyn_cast<ConstantInt>(CI->getArgOperand(1));
236 if (!CharC) {
David Bolvansky1f343fa2018-05-22 20:27:36 +0000237 uint64_t Len = GetStringLength(SrcStr);
Chris Bienemanad070d02014-09-17 20:55:46 +0000238 if (Len == 0 || !FT->getParamType(1)->isIntegerTy(32)) // memchr needs i32.
239 return nullptr;
Meador Inge7fb2f732012-10-13 16:45:32 +0000240
Sanjay Pateld3112a52016-01-19 19:46:10 +0000241 return emitMemChr(SrcStr, CI->getArgOperand(1), // include nul.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000242 ConstantInt::get(DL.getIntPtrType(CI->getContext()), Len),
243 B, DL, TLI);
Meador Inge7fb2f732012-10-13 16:45:32 +0000244 }
245
Chris Bienemanad070d02014-09-17 20:55:46 +0000246 // Otherwise, the character is a constant, see if the first argument is
247 // a string literal. If so, we can constant fold.
248 StringRef Str;
249 if (!getConstantStringInfo(SrcStr, Str)) {
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000250 if (CharC->isZero()) // strchr(p, 0) -> p + strlen(p)
Sanjay Pateld3112a52016-01-19 19:46:10 +0000251 return B.CreateGEP(B.getInt8Ty(), SrcStr, emitStrLen(SrcStr, B, DL, TLI),
Sanjay Pateld707db92015-12-31 16:10:49 +0000252 "strchr");
Chris Bienemanad070d02014-09-17 20:55:46 +0000253 return nullptr;
254 }
255
256 // Compute the offset, make sure to handle the case when we're searching for
257 // zero (a weird way to spell strlen).
258 size_t I = (0xFF & CharC->getSExtValue()) == 0
259 ? Str.size()
260 : Str.find(CharC->getSExtValue());
261 if (I == StringRef::npos) // Didn't find the char. strchr returns null.
262 return Constant::getNullValue(CI->getType());
263
264 // strchr(s+n,c) -> gep(s+n+i,c)
David Blaikie3909da72015-03-30 20:42:56 +0000265 return B.CreateGEP(B.getInt8Ty(), SrcStr, B.getInt64(I), "strchr");
Chris Bienemanad070d02014-09-17 20:55:46 +0000266}
267
268Value *LibCallSimplifier::optimizeStrRChr(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +0000269 Value *SrcStr = CI->getArgOperand(0);
270 ConstantInt *CharC = dyn_cast<ConstantInt>(CI->getArgOperand(1));
271
272 // Cannot fold anything if we're not looking for a constant.
273 if (!CharC)
274 return nullptr;
275
276 StringRef Str;
277 if (!getConstantStringInfo(SrcStr, Str)) {
278 // strrchr(s, 0) -> strchr(s, 0)
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000279 if (CharC->isZero())
Sanjay Pateld3112a52016-01-19 19:46:10 +0000280 return emitStrChr(SrcStr, '\0', B, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +0000281 return nullptr;
282 }
283
284 // Compute the offset.
285 size_t I = (0xFF & CharC->getSExtValue()) == 0
286 ? Str.size()
287 : Str.rfind(CharC->getSExtValue());
288 if (I == StringRef::npos) // Didn't find the char. Return null.
289 return Constant::getNullValue(CI->getType());
290
291 // strrchr(s+n,c) -> gep(s+n+i,c)
David Blaikie3909da72015-03-30 20:42:56 +0000292 return B.CreateGEP(B.getInt8Ty(), SrcStr, B.getInt64(I), "strrchr");
Chris Bienemanad070d02014-09-17 20:55:46 +0000293}
294
295Value *LibCallSimplifier::optimizeStrCmp(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +0000296 Value *Str1P = CI->getArgOperand(0), *Str2P = CI->getArgOperand(1);
297 if (Str1P == Str2P) // strcmp(x,x) -> 0
298 return ConstantInt::get(CI->getType(), 0);
299
300 StringRef Str1, Str2;
301 bool HasStr1 = getConstantStringInfo(Str1P, Str1);
302 bool HasStr2 = getConstantStringInfo(Str2P, Str2);
303
304 // strcmp(x, y) -> cnst (if both x and y are constant strings)
305 if (HasStr1 && HasStr2)
306 return ConstantInt::get(CI->getType(), Str1.compare(Str2));
307
308 if (HasStr1 && Str1.empty()) // strcmp("", x) -> -*x
309 return B.CreateNeg(
310 B.CreateZExt(B.CreateLoad(Str2P, "strcmpload"), CI->getType()));
311
312 if (HasStr2 && Str2.empty()) // strcmp(x,"") -> *x
313 return B.CreateZExt(B.CreateLoad(Str1P, "strcmpload"), CI->getType());
314
315 // strcmp(P, "x") -> memcmp(P, "x", 2)
David Bolvansky1f343fa2018-05-22 20:27:36 +0000316 uint64_t Len1 = GetStringLength(Str1P);
317 uint64_t Len2 = GetStringLength(Str2P);
Chris Bienemanad070d02014-09-17 20:55:46 +0000318 if (Len1 && Len2) {
Sanjay Pateld3112a52016-01-19 19:46:10 +0000319 return emitMemCmp(Str1P, Str2P,
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000320 ConstantInt::get(DL.getIntPtrType(CI->getContext()),
Chris Bienemanad070d02014-09-17 20:55:46 +0000321 std::min(Len1, Len2)),
322 B, DL, TLI);
323 }
Meador Inge7fb2f732012-10-13 16:45:32 +0000324
Chris Bienemanad070d02014-09-17 20:55:46 +0000325 return nullptr;
326}
327
328Value *LibCallSimplifier::optimizeStrNCmp(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +0000329 Value *Str1P = CI->getArgOperand(0), *Str2P = CI->getArgOperand(1);
330 if (Str1P == Str2P) // strncmp(x,x,n) -> 0
331 return ConstantInt::get(CI->getType(), 0);
332
333 // Get the length argument if it is constant.
334 uint64_t Length;
335 if (ConstantInt *LengthArg = dyn_cast<ConstantInt>(CI->getArgOperand(2)))
336 Length = LengthArg->getZExtValue();
337 else
338 return nullptr;
339
340 if (Length == 0) // strncmp(x,y,0) -> 0
341 return ConstantInt::get(CI->getType(), 0);
342
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000343 if (Length == 1) // strncmp(x,y,1) -> memcmp(x,y,1)
Sanjay Pateld3112a52016-01-19 19:46:10 +0000344 return emitMemCmp(Str1P, Str2P, CI->getArgOperand(2), B, DL, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +0000345
346 StringRef Str1, Str2;
347 bool HasStr1 = getConstantStringInfo(Str1P, Str1);
348 bool HasStr2 = getConstantStringInfo(Str2P, Str2);
349
350 // strncmp(x, y) -> cnst (if both x and y are constant strings)
351 if (HasStr1 && HasStr2) {
352 StringRef SubStr1 = Str1.substr(0, Length);
353 StringRef SubStr2 = Str2.substr(0, Length);
354 return ConstantInt::get(CI->getType(), SubStr1.compare(SubStr2));
355 }
356
357 if (HasStr1 && Str1.empty()) // strncmp("", x, n) -> -*x
358 return B.CreateNeg(
359 B.CreateZExt(B.CreateLoad(Str2P, "strcmpload"), CI->getType()));
360
361 if (HasStr2 && Str2.empty()) // strncmp(x, "", n) -> *x
362 return B.CreateZExt(B.CreateLoad(Str1P, "strcmpload"), CI->getType());
363
364 return nullptr;
365}
366
367Value *LibCallSimplifier::optimizeStrCpy(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +0000368 Value *Dst = CI->getArgOperand(0), *Src = CI->getArgOperand(1);
369 if (Dst == Src) // strcpy(x,x) -> x
370 return Src;
371
Chris Bienemanad070d02014-09-17 20:55:46 +0000372 // See if we can get the length of the input string.
David Bolvansky1f343fa2018-05-22 20:27:36 +0000373 uint64_t Len = GetStringLength(Src);
Chris Bienemanad070d02014-09-17 20:55:46 +0000374 if (Len == 0)
375 return nullptr;
376
377 // We have enough information to now generate the memcpy call to do the
378 // copy for us. Make a memcpy to copy the nul byte with align = 1.
Daniel Neilson8acd8b02018-02-05 21:23:22 +0000379 B.CreateMemCpy(Dst, 1, Src, 1,
380 ConstantInt::get(DL.getIntPtrType(CI->getContext()), Len));
Chris Bienemanad070d02014-09-17 20:55:46 +0000381 return Dst;
382}
383
384Value *LibCallSimplifier::optimizeStpCpy(CallInst *CI, IRBuilder<> &B) {
385 Function *Callee = CI->getCalledFunction();
Chris Bienemanad070d02014-09-17 20:55:46 +0000386 Value *Dst = CI->getArgOperand(0), *Src = CI->getArgOperand(1);
387 if (Dst == Src) { // stpcpy(x,x) -> x+strlen(x)
Sanjay Pateld3112a52016-01-19 19:46:10 +0000388 Value *StrLen = emitStrLen(Src, B, DL, TLI);
David Blaikieaa41cd52015-04-03 21:33:42 +0000389 return StrLen ? B.CreateInBoundsGEP(B.getInt8Ty(), Dst, StrLen) : nullptr;
Chris Bienemanad070d02014-09-17 20:55:46 +0000390 }
391
392 // See if we can get the length of the input string.
David Bolvansky1f343fa2018-05-22 20:27:36 +0000393 uint64_t Len = GetStringLength(Src);
Chris Bienemanad070d02014-09-17 20:55:46 +0000394 if (Len == 0)
395 return nullptr;
396
Davide Italianob7487e62015-11-02 23:07:14 +0000397 Type *PT = Callee->getFunctionType()->getParamType(0);
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000398 Value *LenV = ConstantInt::get(DL.getIntPtrType(PT), Len);
Sanjay Pateld707db92015-12-31 16:10:49 +0000399 Value *DstEnd = B.CreateGEP(B.getInt8Ty(), Dst,
400 ConstantInt::get(DL.getIntPtrType(PT), Len - 1));
Chris Bienemanad070d02014-09-17 20:55:46 +0000401
402 // We have enough information to now generate the memcpy call to do the
403 // copy for us. Make a memcpy to copy the nul byte with align = 1.
Daniel Neilson8acd8b02018-02-05 21:23:22 +0000404 B.CreateMemCpy(Dst, 1, Src, 1, LenV);
Chris Bienemanad070d02014-09-17 20:55:46 +0000405 return DstEnd;
406}
407
408Value *LibCallSimplifier::optimizeStrNCpy(CallInst *CI, IRBuilder<> &B) {
409 Function *Callee = CI->getCalledFunction();
Chris Bienemanad070d02014-09-17 20:55:46 +0000410 Value *Dst = CI->getArgOperand(0);
411 Value *Src = CI->getArgOperand(1);
412 Value *LenOp = CI->getArgOperand(2);
413
414 // See if we can get the length of the input string.
David Bolvansky1f343fa2018-05-22 20:27:36 +0000415 uint64_t SrcLen = GetStringLength(Src);
Chris Bienemanad070d02014-09-17 20:55:46 +0000416 if (SrcLen == 0)
417 return nullptr;
418 --SrcLen;
419
420 if (SrcLen == 0) {
Daniel Neilson8acd8b02018-02-05 21:23:22 +0000421 // strncpy(x, "", y) -> memset(align 1 x, '\0', y)
Chris Bienemanad070d02014-09-17 20:55:46 +0000422 B.CreateMemSet(Dst, B.getInt8('\0'), LenOp, 1);
Meador Inge7fb2f732012-10-13 16:45:32 +0000423 return Dst;
424 }
Meador Inge7fb2f732012-10-13 16:45:32 +0000425
Chris Bienemanad070d02014-09-17 20:55:46 +0000426 uint64_t Len;
427 if (ConstantInt *LengthArg = dyn_cast<ConstantInt>(LenOp))
428 Len = LengthArg->getZExtValue();
429 else
430 return nullptr;
Meador Inge7fb2f732012-10-13 16:45:32 +0000431
Chris Bienemanad070d02014-09-17 20:55:46 +0000432 if (Len == 0)
433 return Dst; // strncpy(x, y, 0) -> x
Meador Inge7fb2f732012-10-13 16:45:32 +0000434
Chris Bienemanad070d02014-09-17 20:55:46 +0000435 // Let strncpy handle the zero padding
436 if (Len > SrcLen + 1)
437 return nullptr;
Meador Inge7fb2f732012-10-13 16:45:32 +0000438
Davide Italianob7487e62015-11-02 23:07:14 +0000439 Type *PT = Callee->getFunctionType()->getParamType(0);
Daniel Neilson8acd8b02018-02-05 21:23:22 +0000440 // strncpy(x, s, c) -> memcpy(align 1 x, align 1 s, c) [s and c are constant]
441 B.CreateMemCpy(Dst, 1, Src, 1, ConstantInt::get(DL.getIntPtrType(PT), Len));
Meador Inge7fb2f732012-10-13 16:45:32 +0000442
Chris Bienemanad070d02014-09-17 20:55:46 +0000443 return Dst;
444}
Meador Inge7fb2f732012-10-13 16:45:32 +0000445
Matthias Braun50ec0b52017-05-19 22:37:09 +0000446Value *LibCallSimplifier::optimizeStringLength(CallInst *CI, IRBuilder<> &B,
447 unsigned CharSize) {
Chris Bienemanad070d02014-09-17 20:55:46 +0000448 Value *Src = CI->getArgOperand(0);
449
450 // Constant folding: strlen("xyz") -> 3
David Bolvansky1f343fa2018-05-22 20:27:36 +0000451 if (uint64_t Len = GetStringLength(Src, CharSize))
Chris Bienemanad070d02014-09-17 20:55:46 +0000452 return ConstantInt::get(CI->getType(), Len - 1);
453
David L Kreitzer752c1442016-04-13 14:31:06 +0000454 // If s is a constant pointer pointing to a string literal, we can fold
Matthias Braun50ec0b52017-05-19 22:37:09 +0000455 // strlen(s + x) to strlen(s) - x, when x is known to be in the range
David L Kreitzer752c1442016-04-13 14:31:06 +0000456 // [0, strlen(s)] or the string has a single null terminator '\0' at the end.
Matthias Braun50ec0b52017-05-19 22:37:09 +0000457 // We only try to simplify strlen when the pointer s points to an array
David L Kreitzer752c1442016-04-13 14:31:06 +0000458 // of i8. Otherwise, we would need to scale the offset x before doing the
Matthias Braun50ec0b52017-05-19 22:37:09 +0000459 // subtraction. This will make the optimization more complex, and it's not
460 // very useful because calling strlen for a pointer of other types is
David L Kreitzer752c1442016-04-13 14:31:06 +0000461 // very uncommon.
462 if (GEPOperator *GEP = dyn_cast<GEPOperator>(Src)) {
Matthias Braun50ec0b52017-05-19 22:37:09 +0000463 if (!isGEPBasedOnPointerToString(GEP, CharSize))
David L Kreitzer752c1442016-04-13 14:31:06 +0000464 return nullptr;
465
Matthias Braun50ec0b52017-05-19 22:37:09 +0000466 ConstantDataArraySlice Slice;
467 if (getConstantDataArrayInfo(GEP->getOperand(0), Slice, CharSize)) {
468 uint64_t NullTermIdx;
469 if (Slice.Array == nullptr) {
470 NullTermIdx = 0;
471 } else {
472 NullTermIdx = ~((uint64_t)0);
473 for (uint64_t I = 0, E = Slice.Length; I < E; ++I) {
474 if (Slice.Array->getElementAsInteger(I + Slice.Offset) == 0) {
475 NullTermIdx = I;
476 break;
477 }
478 }
479 // If the string does not have '\0', leave it to strlen to compute
480 // its length.
481 if (NullTermIdx == ~((uint64_t)0))
482 return nullptr;
483 }
484
David L Kreitzer752c1442016-04-13 14:31:06 +0000485 Value *Offset = GEP->getOperand(2);
Craig Topper8205a1a2017-05-24 16:53:07 +0000486 KnownBits Known = computeKnownBits(Offset, DL, 0, nullptr, CI, nullptr);
Craig Topperb45eabc2017-04-26 16:39:58 +0000487 Known.Zero.flipAllBits();
Matthias Braun50ec0b52017-05-19 22:37:09 +0000488 uint64_t ArrSize =
David L Kreitzer752c1442016-04-13 14:31:06 +0000489 cast<ArrayType>(GEP->getSourceElementType())->getNumElements();
490
Matthias Braun50ec0b52017-05-19 22:37:09 +0000491 // KnownZero's bits are flipped, so zeros in KnownZero now represent
492 // bits known to be zeros in Offset, and ones in KnowZero represent
David L Kreitzer752c1442016-04-13 14:31:06 +0000493 // bits unknown in Offset. Therefore, Offset is known to be in range
Matthias Braun50ec0b52017-05-19 22:37:09 +0000494 // [0, NullTermIdx] when the flipped KnownZero is non-negative and
David L Kreitzer752c1442016-04-13 14:31:06 +0000495 // unsigned-less-than NullTermIdx.
496 //
Matthias Braun50ec0b52017-05-19 22:37:09 +0000497 // If Offset is not provably in the range [0, NullTermIdx], we can still
498 // optimize if we can prove that the program has undefined behavior when
499 // Offset is outside that range. That is the case when GEP->getOperand(0)
David L Kreitzer752c1442016-04-13 14:31:06 +0000500 // is a pointer to an object whose memory extent is NullTermIdx+1.
Matthias Braun50ec0b52017-05-19 22:37:09 +0000501 if ((Known.Zero.isNonNegative() && Known.Zero.ule(NullTermIdx)) ||
David L Kreitzer752c1442016-04-13 14:31:06 +0000502 (GEP->isInBounds() && isa<GlobalVariable>(GEP->getOperand(0)) &&
Matthias Braun50ec0b52017-05-19 22:37:09 +0000503 NullTermIdx == ArrSize - 1)) {
504 Offset = B.CreateSExtOrTrunc(Offset, CI->getType());
505 return B.CreateSub(ConstantInt::get(CI->getType(), NullTermIdx),
David L Kreitzer752c1442016-04-13 14:31:06 +0000506 Offset);
Matthias Braun50ec0b52017-05-19 22:37:09 +0000507 }
David L Kreitzer752c1442016-04-13 14:31:06 +0000508 }
509
510 return nullptr;
511 }
512
Chris Bienemanad070d02014-09-17 20:55:46 +0000513 // strlen(x?"foo":"bars") --> x ? 3 : 4
514 if (SelectInst *SI = dyn_cast<SelectInst>(Src)) {
David Bolvansky1f343fa2018-05-22 20:27:36 +0000515 uint64_t LenTrue = GetStringLength(SI->getTrueValue(), CharSize);
516 uint64_t LenFalse = GetStringLength(SI->getFalseValue(), CharSize);
Chris Bienemanad070d02014-09-17 20:55:46 +0000517 if (LenTrue && LenFalse) {
Vivek Pandya95906582017-10-11 17:12:59 +0000518 ORE.emit([&]() {
519 return OptimizationRemark("instcombine", "simplify-libcalls", CI)
520 << "folded strlen(select) to select of constants";
521 });
Chris Bienemanad070d02014-09-17 20:55:46 +0000522 return B.CreateSelect(SI->getCondition(),
523 ConstantInt::get(CI->getType(), LenTrue - 1),
524 ConstantInt::get(CI->getType(), LenFalse - 1));
525 }
Meador Inge7fb2f732012-10-13 16:45:32 +0000526 }
Meador Inge7fb2f732012-10-13 16:45:32 +0000527
Chris Bienemanad070d02014-09-17 20:55:46 +0000528 // strlen(x) != 0 --> *x != 0
529 // strlen(x) == 0 --> *x == 0
530 if (isOnlyUsedInZeroEqualityComparison(CI))
531 return B.CreateZExt(B.CreateLoad(Src, "strlenfirst"), CI->getType());
Meador Inge17418502012-10-13 16:45:37 +0000532
Chris Bienemanad070d02014-09-17 20:55:46 +0000533 return nullptr;
534}
Meador Inge17418502012-10-13 16:45:37 +0000535
Matthias Braun50ec0b52017-05-19 22:37:09 +0000536Value *LibCallSimplifier::optimizeStrLen(CallInst *CI, IRBuilder<> &B) {
537 return optimizeStringLength(CI, B, 8);
538}
539
540Value *LibCallSimplifier::optimizeWcslen(CallInst *CI, IRBuilder<> &B) {
David Bolvansky5430b7372018-05-31 16:39:27 +0000541 Module &M = *CI->getModule();
Matthias Braun50ec0b52017-05-19 22:37:09 +0000542 unsigned WCharSize = TLI->getWCharSize(M) * 8;
Matthias Brauncc603ee2017-09-26 02:36:57 +0000543 // We cannot perform this optimization without wchar_size metadata.
544 if (WCharSize == 0)
545 return nullptr;
Matthias Braun50ec0b52017-05-19 22:37:09 +0000546
547 return optimizeStringLength(CI, B, WCharSize);
548}
549
Chris Bienemanad070d02014-09-17 20:55:46 +0000550Value *LibCallSimplifier::optimizeStrPBrk(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +0000551 StringRef S1, S2;
552 bool HasS1 = getConstantStringInfo(CI->getArgOperand(0), S1);
553 bool HasS2 = getConstantStringInfo(CI->getArgOperand(1), S2);
Meador Inge17418502012-10-13 16:45:37 +0000554
Reid Kleckner971c3ea2014-11-13 22:55:19 +0000555 // strpbrk(s, "") -> nullptr
556 // strpbrk("", s) -> nullptr
Chris Bienemanad070d02014-09-17 20:55:46 +0000557 if ((HasS1 && S1.empty()) || (HasS2 && S2.empty()))
558 return Constant::getNullValue(CI->getType());
Meador Inge17418502012-10-13 16:45:37 +0000559
Chris Bienemanad070d02014-09-17 20:55:46 +0000560 // Constant folding.
561 if (HasS1 && HasS2) {
562 size_t I = S1.find_first_of(S2);
563 if (I == StringRef::npos) // No match.
Meador Inge17418502012-10-13 16:45:37 +0000564 return Constant::getNullValue(CI->getType());
565
Sanjay Pateld707db92015-12-31 16:10:49 +0000566 return B.CreateGEP(B.getInt8Ty(), CI->getArgOperand(0), B.getInt64(I),
567 "strpbrk");
Meador Inge17418502012-10-13 16:45:37 +0000568 }
Meador Inge17418502012-10-13 16:45:37 +0000569
Chris Bienemanad070d02014-09-17 20:55:46 +0000570 // strpbrk(s, "a") -> strchr(s, 'a')
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000571 if (HasS2 && S2.size() == 1)
Sanjay Pateld3112a52016-01-19 19:46:10 +0000572 return emitStrChr(CI->getArgOperand(0), S2[0], B, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +0000573
574 return nullptr;
575}
576
577Value *LibCallSimplifier::optimizeStrTo(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +0000578 Value *EndPtr = CI->getArgOperand(1);
579 if (isa<ConstantPointerNull>(EndPtr)) {
580 // With a null EndPtr, this function won't capture the main argument.
581 // It would be readonly too, except that it still may write to errno.
Reid Klecknera0b45f42017-05-03 18:17:31 +0000582 CI->addParamAttr(0, Attribute::NoCapture);
Chris Bienemanad070d02014-09-17 20:55:46 +0000583 }
584
585 return nullptr;
586}
587
588Value *LibCallSimplifier::optimizeStrSpn(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +0000589 StringRef S1, S2;
590 bool HasS1 = getConstantStringInfo(CI->getArgOperand(0), S1);
591 bool HasS2 = getConstantStringInfo(CI->getArgOperand(1), S2);
592
593 // strspn(s, "") -> 0
594 // strspn("", s) -> 0
595 if ((HasS1 && S1.empty()) || (HasS2 && S2.empty()))
596 return Constant::getNullValue(CI->getType());
597
598 // Constant folding.
599 if (HasS1 && HasS2) {
600 size_t Pos = S1.find_first_not_of(S2);
601 if (Pos == StringRef::npos)
602 Pos = S1.size();
603 return ConstantInt::get(CI->getType(), Pos);
604 }
605
606 return nullptr;
607}
608
609Value *LibCallSimplifier::optimizeStrCSpn(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);
613
614 // strcspn("", s) -> 0
615 if (HasS1 && S1.empty())
616 return Constant::getNullValue(CI->getType());
617
618 // Constant folding.
619 if (HasS1 && HasS2) {
620 size_t Pos = S1.find_first_of(S2);
621 if (Pos == StringRef::npos)
622 Pos = S1.size();
623 return ConstantInt::get(CI->getType(), Pos);
624 }
625
626 // strcspn(s, "") -> strlen(s)
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000627 if (HasS2 && S2.empty())
Sanjay Pateld3112a52016-01-19 19:46:10 +0000628 return emitStrLen(CI->getArgOperand(0), B, DL, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +0000629
630 return nullptr;
631}
632
633Value *LibCallSimplifier::optimizeStrStr(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +0000634 // fold strstr(x, x) -> x.
635 if (CI->getArgOperand(0) == CI->getArgOperand(1))
636 return B.CreateBitCast(CI->getArgOperand(0), CI->getType());
637
638 // fold strstr(a, b) == a -> strncmp(a, b, strlen(b)) == 0
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000639 if (isOnlyUsedInEqualityComparison(CI, CI->getArgOperand(0))) {
Sanjay Pateld3112a52016-01-19 19:46:10 +0000640 Value *StrLen = emitStrLen(CI->getArgOperand(1), B, DL, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +0000641 if (!StrLen)
Craig Topperf40110f2014-04-25 05:29:35 +0000642 return nullptr;
Sanjay Pateld3112a52016-01-19 19:46:10 +0000643 Value *StrNCmp = emitStrNCmp(CI->getArgOperand(0), CI->getArgOperand(1),
Chris Bienemanad070d02014-09-17 20:55:46 +0000644 StrLen, B, DL, TLI);
645 if (!StrNCmp)
Craig Topperf40110f2014-04-25 05:29:35 +0000646 return nullptr;
Chris Bienemanad070d02014-09-17 20:55:46 +0000647 for (auto UI = CI->user_begin(), UE = CI->user_end(); UI != UE;) {
648 ICmpInst *Old = cast<ICmpInst>(*UI++);
649 Value *Cmp =
650 B.CreateICmp(Old->getPredicate(), StrNCmp,
651 ConstantInt::getNullValue(StrNCmp->getType()), "cmp");
652 replaceAllUsesWith(Old, Cmp);
Meador Inge17418502012-10-13 16:45:37 +0000653 }
Chris Bienemanad070d02014-09-17 20:55:46 +0000654 return CI;
655 }
Meador Inge17418502012-10-13 16:45:37 +0000656
Chris Bienemanad070d02014-09-17 20:55:46 +0000657 // See if either input string is a constant string.
658 StringRef SearchStr, ToFindStr;
659 bool HasStr1 = getConstantStringInfo(CI->getArgOperand(0), SearchStr);
660 bool HasStr2 = getConstantStringInfo(CI->getArgOperand(1), ToFindStr);
661
662 // fold strstr(x, "") -> x.
663 if (HasStr2 && ToFindStr.empty())
664 return B.CreateBitCast(CI->getArgOperand(0), CI->getType());
665
666 // If both strings are known, constant fold it.
667 if (HasStr1 && HasStr2) {
668 size_t Offset = SearchStr.find(ToFindStr);
669
670 if (Offset == StringRef::npos) // strstr("foo", "bar") -> null
Meador Inge17418502012-10-13 16:45:37 +0000671 return Constant::getNullValue(CI->getType());
672
Chris Bienemanad070d02014-09-17 20:55:46 +0000673 // strstr("abcd", "bc") -> gep((char*)"abcd", 1)
Sanjay Pateld3112a52016-01-19 19:46:10 +0000674 Value *Result = castToCStr(CI->getArgOperand(0), B);
Chris Bienemanad070d02014-09-17 20:55:46 +0000675 Result = B.CreateConstInBoundsGEP1_64(Result, Offset, "strstr");
676 return B.CreateBitCast(Result, CI->getType());
Meador Inge17418502012-10-13 16:45:37 +0000677 }
Meador Inge17418502012-10-13 16:45:37 +0000678
Chris Bienemanad070d02014-09-17 20:55:46 +0000679 // fold strstr(x, "y") -> strchr(x, 'y').
680 if (HasStr2 && ToFindStr.size() == 1) {
Sanjay Pateld3112a52016-01-19 19:46:10 +0000681 Value *StrChr = emitStrChr(CI->getArgOperand(0), ToFindStr[0], B, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +0000682 return StrChr ? B.CreateBitCast(StrChr, CI->getType()) : nullptr;
683 }
684 return nullptr;
685}
Meador Inge40b6fac2012-10-15 03:47:37 +0000686
Benjamin Kramer691363e2015-03-21 15:36:21 +0000687Value *LibCallSimplifier::optimizeMemChr(CallInst *CI, IRBuilder<> &B) {
Benjamin Kramer691363e2015-03-21 15:36:21 +0000688 Value *SrcStr = CI->getArgOperand(0);
689 ConstantInt *CharC = dyn_cast<ConstantInt>(CI->getArgOperand(1));
690 ConstantInt *LenC = dyn_cast<ConstantInt>(CI->getArgOperand(2));
691
692 // memchr(x, y, 0) -> null
Craig Topper79ab6432017-07-06 18:39:47 +0000693 if (LenC && LenC->isZero())
Benjamin Kramer691363e2015-03-21 15:36:21 +0000694 return Constant::getNullValue(CI->getType());
695
Benjamin Kramer7857d722015-03-21 21:09:33 +0000696 // From now on we need at least constant length and string.
Benjamin Kramer691363e2015-03-21 15:36:21 +0000697 StringRef Str;
Benjamin Kramer7857d722015-03-21 21:09:33 +0000698 if (!LenC || !getConstantStringInfo(SrcStr, Str, 0, /*TrimAtNul=*/false))
Benjamin Kramer691363e2015-03-21 15:36:21 +0000699 return nullptr;
700
701 // Truncate the string to LenC. If Str is smaller than LenC we will still only
702 // scan the string, as reading past the end of it is undefined and we can just
703 // return null if we don't find the char.
704 Str = Str.substr(0, LenC->getZExtValue());
705
Benjamin Kramer7857d722015-03-21 21:09:33 +0000706 // If the char is variable but the input str and length are not we can turn
707 // this memchr call into a simple bit field test. Of course this only works
708 // when the return value is only checked against null.
709 //
710 // It would be really nice to reuse switch lowering here but we can't change
711 // the CFG at this point.
712 //
713 // memchr("\r\n", C, 2) != nullptr -> (C & ((1 << '\r') | (1 << '\n'))) != 0
714 // after bounds check.
715 if (!CharC && !Str.empty() && isOnlyUsedInZeroEqualityComparison(CI)) {
Benjamin Kramerd6aa0ec2015-03-21 22:04:26 +0000716 unsigned char Max =
717 *std::max_element(reinterpret_cast<const unsigned char *>(Str.begin()),
718 reinterpret_cast<const unsigned char *>(Str.end()));
Benjamin Kramer7857d722015-03-21 21:09:33 +0000719
720 // Make sure the bit field we're about to create fits in a register on the
721 // target.
722 // FIXME: On a 64 bit architecture this prevents us from using the
723 // interesting range of alpha ascii chars. We could do better by emitting
724 // two bitfields or shifting the range by 64 if no lower chars are used.
725 if (!DL.fitsInLegalInteger(Max + 1))
726 return nullptr;
727
728 // For the bit field use a power-of-2 type with at least 8 bits to avoid
729 // creating unnecessary illegal types.
730 unsigned char Width = NextPowerOf2(std::max((unsigned char)7, Max));
731
732 // Now build the bit field.
733 APInt Bitfield(Width, 0);
734 for (char C : Str)
735 Bitfield.setBit((unsigned char)C);
736 Value *BitfieldC = B.getInt(Bitfield);
737
738 // First check that the bit field access is within bounds.
739 Value *C = B.CreateZExtOrTrunc(CI->getArgOperand(1), BitfieldC->getType());
740 Value *Bounds = B.CreateICmp(ICmpInst::ICMP_ULT, C, B.getIntN(Width, Width),
741 "memchr.bounds");
742
743 // Create code that checks if the given bit is set in the field.
744 Value *Shl = B.CreateShl(B.getIntN(Width, 1ULL), C);
745 Value *Bits = B.CreateIsNotNull(B.CreateAnd(Shl, BitfieldC), "memchr.bits");
746
747 // Finally merge both checks and cast to pointer type. The inttoptr
748 // implicitly zexts the i1 to intptr type.
749 return B.CreateIntToPtr(B.CreateAnd(Bounds, Bits, "memchr"), CI->getType());
750 }
751
752 // Check if all arguments are constants. If so, we can constant fold.
753 if (!CharC)
754 return nullptr;
755
Benjamin Kramer691363e2015-03-21 15:36:21 +0000756 // Compute the offset.
757 size_t I = Str.find(CharC->getSExtValue() & 0xFF);
758 if (I == StringRef::npos) // Didn't find the char. memchr returns null.
759 return Constant::getNullValue(CI->getType());
760
761 // memchr(s+n,c,l) -> gep(s+n+i,c)
David Blaikie3909da72015-03-30 20:42:56 +0000762 return B.CreateGEP(B.getInt8Ty(), SrcStr, B.getInt64(I), "memchr");
Benjamin Kramer691363e2015-03-21 15:36:21 +0000763}
764
Chris Bienemanad070d02014-09-17 20:55:46 +0000765Value *LibCallSimplifier::optimizeMemCmp(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +0000766 Value *LHS = CI->getArgOperand(0), *RHS = CI->getArgOperand(1);
Meador Inge40b6fac2012-10-15 03:47:37 +0000767
Chris Bienemanad070d02014-09-17 20:55:46 +0000768 if (LHS == RHS) // memcmp(s,s,x) -> 0
769 return Constant::getNullValue(CI->getType());
Meador Inge40b6fac2012-10-15 03:47:37 +0000770
Chris Bienemanad070d02014-09-17 20:55:46 +0000771 // Make sure we have a constant length.
772 ConstantInt *LenC = dyn_cast<ConstantInt>(CI->getArgOperand(2));
773 if (!LenC)
Craig Topperf40110f2014-04-25 05:29:35 +0000774 return nullptr;
Chris Bienemanad070d02014-09-17 20:55:46 +0000775
Sanjay Patel70db4242017-06-09 14:22:03 +0000776 uint64_t Len = LenC->getZExtValue();
Chris Bienemanad070d02014-09-17 20:55:46 +0000777 if (Len == 0) // memcmp(s1,s2,0) -> 0
778 return Constant::getNullValue(CI->getType());
779
780 // memcmp(S1,S2,1) -> *(unsigned char*)LHS - *(unsigned char*)RHS
781 if (Len == 1) {
Sanjay Pateld3112a52016-01-19 19:46:10 +0000782 Value *LHSV = B.CreateZExt(B.CreateLoad(castToCStr(LHS, B), "lhsc"),
Chris Bienemanad070d02014-09-17 20:55:46 +0000783 CI->getType(), "lhsv");
Sanjay Pateld3112a52016-01-19 19:46:10 +0000784 Value *RHSV = B.CreateZExt(B.CreateLoad(castToCStr(RHS, B), "rhsc"),
Chris Bienemanad070d02014-09-17 20:55:46 +0000785 CI->getType(), "rhsv");
786 return B.CreateSub(LHSV, RHSV, "chardiff");
Meador Inge40b6fac2012-10-15 03:47:37 +0000787 }
Meador Inge40b6fac2012-10-15 03:47:37 +0000788
Chad Rosierdc655322015-08-28 18:30:18 +0000789 // memcmp(S1,S2,N/8)==0 -> (*(intN_t*)S1 != *(intN_t*)S2)==0
Sanjay Patel82ec8722017-08-21 19:13:14 +0000790 // TODO: The case where both inputs are constants does not need to be limited
791 // to legal integers or equality comparison. See block below this.
Chad Rosierdc655322015-08-28 18:30:18 +0000792 if (DL.isLegalInteger(Len * 8) && isOnlyUsedInZeroEqualityComparison(CI)) {
Chad Rosierdc655322015-08-28 18:30:18 +0000793 IntegerType *IntType = IntegerType::get(CI->getContext(), Len * 8);
794 unsigned PrefAlignment = DL.getPrefTypeAlignment(IntType);
795
Sanjay Patel82ec8722017-08-21 19:13:14 +0000796 // First, see if we can fold either argument to a constant.
797 Value *LHSV = nullptr;
798 if (auto *LHSC = dyn_cast<Constant>(LHS)) {
799 LHSC = ConstantExpr::getBitCast(LHSC, IntType->getPointerTo());
800 LHSV = ConstantFoldLoadFromConstPtr(LHSC, IntType, DL);
801 }
802 Value *RHSV = nullptr;
803 if (auto *RHSC = dyn_cast<Constant>(RHS)) {
804 RHSC = ConstantExpr::getBitCast(RHSC, IntType->getPointerTo());
805 RHSV = ConstantFoldLoadFromConstPtr(RHSC, IntType, DL);
806 }
Chad Rosierdc655322015-08-28 18:30:18 +0000807
Sanjay Patel82ec8722017-08-21 19:13:14 +0000808 // Don't generate unaligned loads. If either source is constant data,
809 // alignment doesn't matter for that source because there is no load.
810 if ((LHSV || getKnownAlignment(LHS, DL, CI) >= PrefAlignment) &&
811 (RHSV || getKnownAlignment(RHS, DL, CI) >= PrefAlignment)) {
812 if (!LHSV) {
813 Type *LHSPtrTy =
814 IntType->getPointerTo(LHS->getType()->getPointerAddressSpace());
815 LHSV = B.CreateLoad(B.CreateBitCast(LHS, LHSPtrTy), "lhsv");
816 }
817 if (!RHSV) {
818 Type *RHSPtrTy =
819 IntType->getPointerTo(RHS->getType()->getPointerAddressSpace());
820 RHSV = B.CreateLoad(B.CreateBitCast(RHS, RHSPtrTy), "rhsv");
821 }
Sanjay Patel7756edf2017-08-21 13:55:49 +0000822 return B.CreateZExt(B.CreateICmpNE(LHSV, RHSV), CI->getType(), "memcmp");
Sanjay Patel707f7862017-08-21 15:16:25 +0000823 }
Chad Rosierdc655322015-08-28 18:30:18 +0000824 }
825
Sanjay Patel82ec8722017-08-21 19:13:14 +0000826 // Constant folding: memcmp(x, y, Len) -> constant (all arguments are const).
827 // TODO: This is limited to i8 arrays.
Chris Bienemanad070d02014-09-17 20:55:46 +0000828 StringRef LHSStr, RHSStr;
829 if (getConstantStringInfo(LHS, LHSStr) &&
830 getConstantStringInfo(RHS, RHSStr)) {
831 // Make sure we're not reading out-of-bounds memory.
832 if (Len > LHSStr.size() || Len > RHSStr.size())
Craig Topperf40110f2014-04-25 05:29:35 +0000833 return nullptr;
Chris Bienemanad070d02014-09-17 20:55:46 +0000834 // Fold the memcmp and normalize the result. This way we get consistent
835 // results across multiple platforms.
836 uint64_t Ret = 0;
837 int Cmp = memcmp(LHSStr.data(), RHSStr.data(), Len);
838 if (Cmp < 0)
839 Ret = -1;
840 else if (Cmp > 0)
841 Ret = 1;
842 return ConstantInt::get(CI->getType(), Ret);
Meador Inge000dbcc2012-10-18 18:12:40 +0000843 }
Meador Inge000dbcc2012-10-18 18:12:40 +0000844
Chris Bienemanad070d02014-09-17 20:55:46 +0000845 return nullptr;
846}
Meador Inge9a6a1902012-10-31 00:20:56 +0000847
Chris Bienemanad070d02014-09-17 20:55:46 +0000848Value *LibCallSimplifier::optimizeMemCpy(CallInst *CI, IRBuilder<> &B) {
Daniel Neilson8acd8b02018-02-05 21:23:22 +0000849 // memcpy(x, y, n) -> llvm.memcpy(align 1 x, align 1 y, n)
850 B.CreateMemCpy(CI->getArgOperand(0), 1, CI->getArgOperand(1), 1,
851 CI->getArgOperand(2));
Chris Bienemanad070d02014-09-17 20:55:46 +0000852 return CI->getArgOperand(0);
853}
Meador Inge05a625a2012-10-31 14:58:26 +0000854
Chris Bienemanad070d02014-09-17 20:55:46 +0000855Value *LibCallSimplifier::optimizeMemMove(CallInst *CI, IRBuilder<> &B) {
Daniel Neilson8acd8b02018-02-05 21:23:22 +0000856 // memmove(x, y, n) -> llvm.memmove(align 1 x, align 1 y, n)
857 B.CreateMemMove(CI->getArgOperand(0), 1, CI->getArgOperand(1), 1,
858 CI->getArgOperand(2));
Chris Bienemanad070d02014-09-17 20:55:46 +0000859 return CI->getArgOperand(0);
860}
Meador Ingebcd88ef72012-11-10 15:16:48 +0000861
Sanjay Patel980b2802016-01-26 16:17:24 +0000862/// Fold memset[_chk](malloc(n), 0, n) --> calloc(1, n).
863static Value *foldMallocMemset(CallInst *Memset, IRBuilder<> &B,
864 const TargetLibraryInfo &TLI) {
865 // This has to be a memset of zeros (bzero).
866 auto *FillValue = dyn_cast<ConstantInt>(Memset->getArgOperand(1));
867 if (!FillValue || FillValue->getZExtValue() != 0)
868 return nullptr;
869
870 // TODO: We should handle the case where the malloc has more than one use.
871 // This is necessary to optimize common patterns such as when the result of
872 // the malloc is checked against null or when a memset intrinsic is used in
873 // place of a memset library call.
874 auto *Malloc = dyn_cast<CallInst>(Memset->getArgOperand(0));
875 if (!Malloc || !Malloc->hasOneUse())
876 return nullptr;
877
878 // Is the inner call really malloc()?
879 Function *InnerCallee = Malloc->getCalledFunction();
Matthias Braunc36a78c2017-04-25 19:44:25 +0000880 if (!InnerCallee)
881 return nullptr;
882
David L. Jonesd21529f2017-01-23 23:16:46 +0000883 LibFunc Func;
Ahmed Bougachad765a822016-04-27 19:04:35 +0000884 if (!TLI.getLibFunc(*InnerCallee, Func) || !TLI.has(Func) ||
David L. Jonesd21529f2017-01-23 23:16:46 +0000885 Func != LibFunc_malloc)
Sanjay Patel980b2802016-01-26 16:17:24 +0000886 return nullptr;
887
Sanjay Patel980b2802016-01-26 16:17:24 +0000888 // The memset must cover the same number of bytes that are malloc'd.
889 if (Memset->getArgOperand(2) != Malloc->getArgOperand(0))
890 return nullptr;
891
892 // Replace the malloc with a calloc. We need the data layout to know what the
Fangrui Songf78650a2018-07-30 19:41:25 +0000893 // actual size of a 'size_t' parameter is.
Sanjay Patel980b2802016-01-26 16:17:24 +0000894 B.SetInsertPoint(Malloc->getParent(), ++Malloc->getIterator());
895 const DataLayout &DL = Malloc->getModule()->getDataLayout();
896 IntegerType *SizeType = DL.getIntPtrType(B.GetInsertBlock()->getContext());
897 Value *Calloc = emitCalloc(ConstantInt::get(SizeType, 1),
898 Malloc->getArgOperand(0), Malloc->getAttributes(),
899 B, TLI);
900 if (!Calloc)
901 return nullptr;
902
903 Malloc->replaceAllUsesWith(Calloc);
904 Malloc->eraseFromParent();
905
906 return Calloc;
907}
908
Chris Bienemanad070d02014-09-17 20:55:46 +0000909Value *LibCallSimplifier::optimizeMemSet(CallInst *CI, IRBuilder<> &B) {
Sanjay Patel980b2802016-01-26 16:17:24 +0000910 if (auto *Calloc = foldMallocMemset(CI, B, *TLI))
911 return Calloc;
912
Daniel Neilson8acd8b02018-02-05 21:23:22 +0000913 // memset(p, v, n) -> llvm.memset(align 1 p, v, n)
Chris Bienemanad070d02014-09-17 20:55:46 +0000914 Value *Val = B.CreateIntCast(CI->getArgOperand(1), B.getInt8Ty(), false);
915 B.CreateMemSet(CI->getArgOperand(0), Val, CI->getArgOperand(2), 1);
916 return CI->getArgOperand(0);
917}
Meador Inged4825782012-11-11 06:49:03 +0000918
Sanjay Patelb2ab3f22018-04-18 14:21:31 +0000919Value *LibCallSimplifier::optimizeRealloc(CallInst *CI, IRBuilder<> &B) {
920 if (isa<ConstantPointerNull>(CI->getArgOperand(0)))
921 return emitMalloc(CI->getArgOperand(1), B, DL, TLI);
922
923 return nullptr;
924}
925
Meador Inge193e0352012-11-13 04:16:17 +0000926//===----------------------------------------------------------------------===//
927// Math Library Optimizations
928//===----------------------------------------------------------------------===//
929
Matthias Braund34e4d22014-12-03 21:46:33 +0000930/// Return a variant of Val with float type.
931/// Currently this works in two cases: If Val is an FPExtension of a float
932/// value to something bigger, simply return the operand.
933/// If Val is a ConstantFP but can be converted to a float ConstantFP without
934/// loss of precision do so.
935static Value *valueHasFloatPrecision(Value *Val) {
936 if (FPExtInst *Cast = dyn_cast<FPExtInst>(Val)) {
937 Value *Op = Cast->getOperand(0);
938 if (Op->getType()->isFloatTy())
939 return Op;
940 }
941 if (ConstantFP *Const = dyn_cast<ConstantFP>(Val)) {
942 APFloat F = Const->getValueAPF();
Matthias Braun395a82f2014-12-03 22:10:39 +0000943 bool losesInfo;
Stephan Bergmann17c7f702016-12-14 11:57:17 +0000944 (void)F.convert(APFloat::IEEEsingle(), APFloat::rmNearestTiesToEven,
Matthias Braun395a82f2014-12-03 22:10:39 +0000945 &losesInfo);
946 if (!losesInfo)
Matthias Braund34e4d22014-12-03 21:46:33 +0000947 return ConstantFP::get(Const->getContext(), F);
948 }
949 return nullptr;
950}
951
Sanjay Patel4e971da2016-01-21 18:01:57 +0000952/// Shrink double -> float for unary functions like 'floor'.
953static Value *optimizeUnaryDoubleFP(CallInst *CI, IRBuilder<> &B,
954 bool CheckRetType) {
Chris Bienemanad070d02014-09-17 20:55:46 +0000955 Function *Callee = CI->getCalledFunction();
Ahmed Bougachad765a822016-04-27 19:04:35 +0000956 // We know this libcall has a valid prototype, but we don't know which.
957 if (!CI->getType()->isDoubleTy())
Chris Bienemanad070d02014-09-17 20:55:46 +0000958 return nullptr;
Meador Inge193e0352012-11-13 04:16:17 +0000959
Chris Bienemanad070d02014-09-17 20:55:46 +0000960 if (CheckRetType) {
961 // Check if all the uses for function like 'sin' are converted to float.
962 for (User *U : CI->users()) {
963 FPTruncInst *Cast = dyn_cast<FPTruncInst>(U);
964 if (!Cast || !Cast->getType()->isFloatTy())
965 return nullptr;
Meador Inge193e0352012-11-13 04:16:17 +0000966 }
Meador Inge193e0352012-11-13 04:16:17 +0000967 }
Chris Bienemanad070d02014-09-17 20:55:46 +0000968
969 // If this is something like 'floor((double)floatval)', convert to floorf.
Matthias Braund34e4d22014-12-03 21:46:33 +0000970 Value *V = valueHasFloatPrecision(CI->getArgOperand(0));
971 if (V == nullptr)
Chris Bienemanad070d02014-09-17 20:55:46 +0000972 return nullptr;
Fangrui Songf78650a2018-07-30 19:41:25 +0000973
Andrew Ng1606fc02017-04-25 12:36:14 +0000974 // If call isn't an intrinsic, check that it isn't within a function with the
975 // same name as the float version of this call.
976 //
977 // e.g. inline float expf(float val) { return (float) exp((double) val); }
978 //
979 // A similar such definition exists in the MinGW-w64 math.h header file which
980 // when compiled with -O2 -ffast-math causes the generation of infinite loops
981 // where expf is called.
982 if (!Callee->isIntrinsic()) {
983 const Function *F = CI->getFunction();
984 StringRef FName = F->getName();
985 StringRef CalleeName = Callee->getName();
986 if ((FName.size() == (CalleeName.size() + 1)) &&
987 (FName.back() == 'f') &&
988 FName.startswith(CalleeName))
989 return nullptr;
990 }
991
Sanjay Patelaa231142015-12-31 21:52:31 +0000992 // Propagate fast-math flags from the existing call to the new call.
993 IRBuilder<>::FastMathFlagGuard Guard(B);
Sanjay Patela2528152016-01-12 18:03:37 +0000994 B.setFastMathFlags(CI->getFastMathFlags());
Chris Bienemanad070d02014-09-17 20:55:46 +0000995
996 // floor((double)floatval) -> (double)floorf(floatval)
Sanjay Patel848309d2014-10-23 21:52:45 +0000997 if (Callee->isIntrinsic()) {
Sanjay Patelaf674fb2015-12-14 17:24:23 +0000998 Module *M = CI->getModule();
Pete Cooper9e1d3352015-05-20 17:16:39 +0000999 Intrinsic::ID IID = Callee->getIntrinsicID();
Sanjay Patel848309d2014-10-23 21:52:45 +00001000 Function *F = Intrinsic::getDeclaration(M, IID, B.getFloatTy());
1001 V = B.CreateCall(F, V);
1002 } else {
1003 // The call is a library call rather than an intrinsic.
Sanjay Pateld3112a52016-01-19 19:46:10 +00001004 V = emitUnaryFloatFnCall(V, Callee->getName(), B, Callee->getAttributes());
Sanjay Patel848309d2014-10-23 21:52:45 +00001005 }
1006
Chris Bienemanad070d02014-09-17 20:55:46 +00001007 return B.CreateFPExt(V, B.getDoubleTy());
1008}
Meador Inge193e0352012-11-13 04:16:17 +00001009
Matt Arsenault954a6242017-01-23 23:55:08 +00001010// Replace a libcall \p CI with a call to intrinsic \p IID
1011static Value *replaceUnaryCall(CallInst *CI, IRBuilder<> &B, Intrinsic::ID IID) {
1012 // Propagate fast-math flags from the existing call to the new call.
1013 IRBuilder<>::FastMathFlagGuard Guard(B);
1014 B.setFastMathFlags(CI->getFastMathFlags());
1015
1016 Module *M = CI->getModule();
1017 Value *V = CI->getArgOperand(0);
1018 Function *F = Intrinsic::getDeclaration(M, IID, CI->getType());
1019 CallInst *NewCall = B.CreateCall(F, V);
1020 NewCall->takeName(CI);
1021 return NewCall;
1022}
1023
Sanjay Patel4e971da2016-01-21 18:01:57 +00001024/// Shrink double -> float for binary functions like 'fmin/fmax'.
1025static Value *optimizeBinaryDoubleFP(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +00001026 Function *Callee = CI->getCalledFunction();
Ahmed Bougachad765a822016-04-27 19:04:35 +00001027 // We know this libcall has a valid prototype, but we don't know which.
1028 if (!CI->getType()->isDoubleTy())
Craig Topperf40110f2014-04-25 05:29:35 +00001029 return nullptr;
Meador Inge193e0352012-11-13 04:16:17 +00001030
Chris Bienemanad070d02014-09-17 20:55:46 +00001031 // If this is something like 'fmin((double)floatval1, (double)floatval2)',
Matthias Braund34e4d22014-12-03 21:46:33 +00001032 // or fmin(1.0, (double)floatval), then we convert it to fminf.
1033 Value *V1 = valueHasFloatPrecision(CI->getArgOperand(0));
1034 if (V1 == nullptr)
1035 return nullptr;
1036 Value *V2 = valueHasFloatPrecision(CI->getArgOperand(1));
1037 if (V2 == nullptr)
Craig Topperf40110f2014-04-25 05:29:35 +00001038 return nullptr;
Chris Bienemanad070d02014-09-17 20:55:46 +00001039
Sanjay Patelbee05ca2015-12-31 23:40:59 +00001040 // Propagate fast-math flags from the existing call to the new call.
1041 IRBuilder<>::FastMathFlagGuard Guard(B);
Sanjay Patela2528152016-01-12 18:03:37 +00001042 B.setFastMathFlags(CI->getFastMathFlags());
Sanjay Patelbee05ca2015-12-31 23:40:59 +00001043
Chris Bienemanad070d02014-09-17 20:55:46 +00001044 // fmin((double)floatval1, (double)floatval2)
Matthias Braund34e4d22014-12-03 21:46:33 +00001045 // -> (double)fminf(floatval1, floatval2)
Sanjay Patel848309d2014-10-23 21:52:45 +00001046 // TODO: Handle intrinsics in the same way as in optimizeUnaryDoubleFP().
Sanjay Pateld3112a52016-01-19 19:46:10 +00001047 Value *V = emitBinaryFloatFnCall(V1, V2, Callee->getName(), B,
Matthias Braund34e4d22014-12-03 21:46:33 +00001048 Callee->getAttributes());
Chris Bienemanad070d02014-09-17 20:55:46 +00001049 return B.CreateFPExt(V, B.getDoubleTy());
1050}
1051
Hal Finkel2ff24732017-12-16 01:26:25 +00001052// cabs(z) -> sqrt((creal(z)*creal(z)) + (cimag(z)*cimag(z)))
1053Value *LibCallSimplifier::optimizeCAbs(CallInst *CI, IRBuilder<> &B) {
1054 if (!CI->isFast())
1055 return nullptr;
1056
1057 // Propagate fast-math flags from the existing call to new instructions.
1058 IRBuilder<>::FastMathFlagGuard Guard(B);
1059 B.setFastMathFlags(CI->getFastMathFlags());
1060
1061 Value *Real, *Imag;
1062 if (CI->getNumArgOperands() == 1) {
1063 Value *Op = CI->getArgOperand(0);
1064 assert(Op->getType()->isArrayTy() && "Unexpected signature for cabs!");
1065 Real = B.CreateExtractValue(Op, 0, "real");
1066 Imag = B.CreateExtractValue(Op, 1, "imag");
1067 } else {
1068 assert(CI->getNumArgOperands() == 2 && "Unexpected signature for cabs!");
1069 Real = CI->getArgOperand(0);
1070 Imag = CI->getArgOperand(1);
1071 }
1072
1073 Value *RealReal = B.CreateFMul(Real, Real);
1074 Value *ImagImag = B.CreateFMul(Imag, Imag);
1075
1076 Function *FSqrt = Intrinsic::getDeclaration(CI->getModule(), Intrinsic::sqrt,
1077 CI->getType());
1078 return B.CreateCall(FSqrt, B.CreateFAdd(RealReal, ImagImag), "cabs");
1079}
1080
Chris Bienemanad070d02014-09-17 20:55:46 +00001081Value *LibCallSimplifier::optimizeCos(CallInst *CI, IRBuilder<> &B) {
1082 Function *Callee = CI->getCalledFunction();
1083 Value *Ret = nullptr;
Davide Italianoa3458772015-11-05 19:18:23 +00001084 StringRef Name = Callee->getName();
1085 if (UnsafeFPShrink && Name == "cos" && hasFloatVersion(Name))
Chris Bienemanad070d02014-09-17 20:55:46 +00001086 Ret = optimizeUnaryDoubleFP(CI, B, true);
Bob Wilsond8d92d92013-11-03 06:48:38 +00001087
Chris Bienemanad070d02014-09-17 20:55:46 +00001088 // cos(-x) -> cos(x)
1089 Value *Op1 = CI->getArgOperand(0);
1090 if (BinaryOperator::isFNeg(Op1)) {
1091 BinaryOperator *BinExpr = cast<BinaryOperator>(Op1);
1092 return B.CreateCall(Callee, BinExpr->getOperand(1), "cos");
1093 }
1094 return Ret;
1095}
Bob Wilsond8d92d92013-11-03 06:48:38 +00001096
Weiming Zhao82130722015-12-04 22:00:47 +00001097static Value *getPow(Value *InnerChain[33], unsigned Exp, IRBuilder<> &B) {
1098 // Multiplications calculated using Addition Chains.
1099 // Refer: http://wwwhomes.uni-bielefeld.de/achim/addition_chain.html
1100
1101 assert(Exp != 0 && "Incorrect exponent 0 not handled");
1102
1103 if (InnerChain[Exp])
1104 return InnerChain[Exp];
1105
1106 static const unsigned AddChain[33][2] = {
1107 {0, 0}, // Unused.
1108 {0, 0}, // Unused (base case = pow1).
1109 {1, 1}, // Unused (pre-computed).
1110 {1, 2}, {2, 2}, {2, 3}, {3, 3}, {2, 5}, {4, 4},
1111 {1, 8}, {5, 5}, {1, 10}, {6, 6}, {4, 9}, {7, 7},
1112 {3, 12}, {8, 8}, {8, 9}, {2, 16}, {1, 18}, {10, 10},
1113 {6, 15}, {11, 11}, {3, 20}, {12, 12}, {8, 17}, {13, 13},
1114 {3, 24}, {14, 14}, {4, 25}, {15, 15}, {3, 28}, {16, 16},
1115 };
1116
1117 InnerChain[Exp] = B.CreateFMul(getPow(InnerChain, AddChain[Exp][0], B),
1118 getPow(InnerChain, AddChain[Exp][1], B));
1119 return InnerChain[Exp];
1120}
1121
Sanjay Patelfbd3e662017-11-19 16:13:14 +00001122/// Use square root in place of pow(x, +/-0.5).
1123Value *LibCallSimplifier::replacePowWithSqrt(CallInst *Pow, IRBuilder<> &B) {
1124 // TODO: There is some subset of 'fast' under which these transforms should
1125 // be allowed.
1126 if (!Pow->isFast())
1127 return nullptr;
1128
Evandro Menezesa7d48282018-07-30 16:20:04 +00001129 Value *Sqrt, *Base = Pow->getArgOperand(0), *Expo = Pow->getArgOperand(1);
Sanjay Patelfbd3e662017-11-19 16:13:14 +00001130 Type *Ty = Pow->getType();
Sanjay Patelfbd3e662017-11-19 16:13:14 +00001131
Evandro Menezesa7d48282018-07-30 16:20:04 +00001132 const APFloat *ExpoF;
1133 if (!match(Expo, m_APFloat(ExpoF)) ||
1134 (!ExpoF->isExactlyValue(0.5) && !ExpoF->isExactlyValue(-0.5)))
1135 return nullptr;
1136
1137 // If errno is never set, then use the intrinsic for sqrt().
1138 if (Pow->hasFnAttr(Attribute::ReadNone)) {
Evandro Menezesa7d48282018-07-30 16:20:04 +00001139 Function *SqrtFn = Intrinsic::getDeclaration(Pow->getModule(),
1140 Intrinsic::sqrt, Ty);
1141 Sqrt = B.CreateCall(SqrtFn, Base);
1142 }
1143 // Otherwise, use the libcall for sqrt().
Evandro Menezes61e4e402018-07-31 22:11:02 +00001144 else if (hasUnaryFloatFn(TLI, Ty, LibFunc_sqrt, LibFunc_sqrtf, LibFunc_sqrtl))
Evandro Menezesa7d48282018-07-30 16:20:04 +00001145 // TODO: We also should check that the target can in fact lower the sqrt()
1146 // libcall. We currently have no way to ask this question, so we ask if
1147 // the target has a sqrt() libcall, which is not exactly the same.
1148 Sqrt = emitUnaryFloatFnCall(Base, TLI->getName(LibFunc_sqrt), B,
1149 Pow->getCalledFunction()->getAttributes());
Evandro Menezes61e4e402018-07-31 22:11:02 +00001150 else
Evandro Menezesa7d48282018-07-30 16:20:04 +00001151 return nullptr;
1152
Evandro Menezes61e4e402018-07-31 22:11:02 +00001153 // If the exponent is negative, then get the reciprocal.
Evandro Menezesa7d48282018-07-30 16:20:04 +00001154 if (ExpoF->isNegative())
1155 Sqrt = B.CreateFDiv(ConstantFP::get(Ty, 1.0), Sqrt, "reciprocal");
Sanjay Patelfbd3e662017-11-19 16:13:14 +00001156
1157 return Sqrt;
1158}
1159
Evandro Menezesa7d48282018-07-30 16:20:04 +00001160Value *LibCallSimplifier::optimizePow(CallInst *Pow, IRBuilder<> &B) {
1161 Value *Base = Pow->getArgOperand(0), *Expo = Pow->getArgOperand(1);
1162 Function *Callee = Pow->getCalledFunction();
1163 AttributeList Attrs = Callee->getAttributes();
Davide Italianoa3458772015-11-05 19:18:23 +00001164 StringRef Name = Callee->getName();
Evandro Menezesa7d48282018-07-30 16:20:04 +00001165 Module *Module = Pow->getModule();
1166 Type *Ty = Pow->getType();
1167 Value *Shrunk = nullptr;
1168 bool Ignored;
Bob Wilsond8d92d92013-11-03 06:48:38 +00001169
Evandro Menezesa7d48282018-07-30 16:20:04 +00001170 if (UnsafeFPShrink &&
1171 Name == TLI->getName(LibFunc_pow) && hasFloatVersion(Name))
1172 Shrunk = optimizeUnaryDoubleFP(Pow, B, true);
1173
Evandro Menezes61e4e402018-07-31 22:11:02 +00001174 // Propagate the math semantics from the call to any created instructions.
Evandro Menezesa7d48282018-07-30 16:20:04 +00001175 IRBuilder<>::FastMathFlagGuard Guard(B);
1176 B.setFastMathFlags(Pow->getFastMathFlags());
1177
1178 // Evaluate special cases related to the base.
Davide Italiano27da1312016-08-07 20:27:03 +00001179
1180 // pow(1.0, x) -> 1.0
Evandro Menezes84e74362018-08-02 15:43:57 +00001181 if (match(Base, m_FPOne()))
Evandro Menezesa7d48282018-07-30 16:20:04 +00001182 return Base;
1183
1184 // pow(2.0, x) -> exp2(x)
1185 if (match(Base, m_SpecificFP(2.0))) {
1186 Value *Exp2 = Intrinsic::getDeclaration(Module, Intrinsic::exp2, Ty);
1187 return B.CreateCall(Exp2, Expo, "exp2");
Davide Italiano27da1312016-08-07 20:27:03 +00001188 }
1189
Evandro Menezes61e4e402018-07-31 22:11:02 +00001190 // pow(10.0, x) -> exp10(x)
1191 if (ConstantFP *BaseC = dyn_cast<ConstantFP>(Base))
1192 // There's no exp10 intrinsic yet, but, maybe, some day there shall be one.
Evandro Menezesa7d48282018-07-30 16:20:04 +00001193 if (BaseC->isExactlyValue(10.0) &&
1194 hasUnaryFloatFn(TLI, Ty, LibFunc_exp10, LibFunc_exp10f, LibFunc_exp10l))
1195 return emitUnaryFloatFnCall(Expo, TLI->getName(LibFunc_exp10), B, Attrs);
Bob Wilsond8d92d92013-11-03 06:48:38 +00001196
Sanjay Patel6002e782016-01-12 17:30:37 +00001197 // pow(exp(x), y) -> exp(x * y)
Davide Italianoc8a79132015-11-03 20:32:23 +00001198 // pow(exp2(x), y) -> exp2(x * y)
Sanjay Patel6002e782016-01-12 17:30:37 +00001199 // We enable these only with fast-math. Besides rounding differences, the
1200 // transformation changes overflow and underflow behavior quite dramatically.
Davide Italianoc8a79132015-11-03 20:32:23 +00001201 // Example: x = 1000, y = 0.001.
1202 // pow(exp(x), y) = pow(inf, 0.001) = inf, whereas exp(x*y) = exp(1).
Evandro Menezesa7d48282018-07-30 16:20:04 +00001203 auto *BaseFn = dyn_cast<CallInst>(Base);
1204 if (BaseFn && BaseFn->isFast() && Pow->isFast()) {
1205 LibFunc LibFn;
1206 Function *CalleeFn = BaseFn->getCalledFunction();
1207 if (CalleeFn && TLI->getLibFunc(CalleeFn->getName(), LibFn) &&
1208 (LibFn == LibFunc_exp || LibFn == LibFunc_exp2) && TLI->has(LibFn)) {
Davide Italianoc8a79132015-11-03 20:32:23 +00001209 IRBuilder<>::FastMathFlagGuard Guard(B);
Evandro Menezesa7d48282018-07-30 16:20:04 +00001210 B.setFastMathFlags(Pow->getFastMathFlags());
1211
1212 Value *FMul = B.CreateFMul(BaseFn->getArgOperand(0), Expo, "mul");
1213 return emitUnaryFloatFnCall(FMul, CalleeFn->getName(), B,
1214 CalleeFn->getAttributes());
Davide Italianoc8a79132015-11-03 20:32:23 +00001215 }
1216 }
1217
Evandro Menezesa7d48282018-07-30 16:20:04 +00001218 // Evaluate special cases related to the exponent.
1219
1220 if (Value *Sqrt = replacePowWithSqrt(Pow, B))
Sanjay Patel9771a962017-11-19 16:42:27 +00001221 return Sqrt;
1222
Evandro Menezesa7d48282018-07-30 16:20:04 +00001223 ConstantFP *ExpoC = dyn_cast<ConstantFP>(Expo);
1224 if (!ExpoC)
1225 return Shrunk;
Chris Bienemanad070d02014-09-17 20:55:46 +00001226
Evandro Menezesa7d48282018-07-30 16:20:04 +00001227 // pow(x, -1.0) -> 1.0 / x
1228 if (ExpoC->isExactlyValue(-1.0))
1229 return B.CreateFDiv(ConstantFP::get(Ty, 1.0), Base, "reciprocal");
1230
1231 // pow(x, 0.0) -> 1.0
1232 if (ExpoC->getValueAPF().isZero())
1233 return ConstantFP::get(Ty, 1.0);
1234
1235 // pow(x, 1.0) -> x
1236 if (ExpoC->isExactlyValue(1.0))
1237 return Base;
1238
1239 // pow(x, 2.0) -> x * x
1240 if (ExpoC->isExactlyValue(2.0))
1241 return B.CreateFMul(Base, Base, "square");
Chris Bienemanad070d02014-09-17 20:55:46 +00001242
Sanjay Patelfbd3e662017-11-19 16:13:14 +00001243 // FIXME: Correct the transforms and pull this into replacePowWithSqrt().
Evandro Menezesa7d48282018-07-30 16:20:04 +00001244 if (ExpoC->isExactlyValue(0.5) &&
1245 hasUnaryFloatFn(TLI, Ty, LibFunc_sqrt, LibFunc_sqrtf, LibFunc_sqrtl)) {
Chris Bienemanad070d02014-09-17 20:55:46 +00001246 // Expand pow(x, 0.5) to (x == -infinity ? +infinity : fabs(sqrt(x))).
Evandro Menezes61e4e402018-07-31 22:11:02 +00001247 // This is faster than calling pow(), and still handles -0.0 and
1248 // negative infinity correctly.
Chris Bienemanad070d02014-09-17 20:55:46 +00001249 // TODO: In finite-only mode, this could be just fabs(sqrt(x)).
Evandro Menezesa7d48282018-07-30 16:20:04 +00001250 Value *PosInf = ConstantFP::getInfinity(Ty);
1251 Value *NegInf = ConstantFP::getInfinity(Ty, true);
Justin Lebarcb9b41d2017-01-27 00:58:03 +00001252
Evandro Menezesa7d48282018-07-30 16:20:04 +00001253 // TODO: As above, we should lower to the sqrt() intrinsic if the pow() is
1254 // an intrinsic, to match errno semantics.
1255 Value *Sqrt = emitUnaryFloatFnCall(Base, TLI->getName(LibFunc_sqrt),
1256 B, Attrs);
Evandro Menezes61e4e402018-07-31 22:11:02 +00001257 Function *FAbsFn = Intrinsic::getDeclaration(Module, Intrinsic::fabs, Ty);
1258 Value *FAbs = B.CreateCall(FAbsFn, Sqrt, "abs");
Evandro Menezesa7d48282018-07-30 16:20:04 +00001259 Value *FCmp = B.CreateFCmpOEQ(Base, NegInf, "isinf");
Evandro Menezes61e4e402018-07-31 22:11:02 +00001260 Sqrt = B.CreateSelect(FCmp, PosInf, FAbs);
1261 return Sqrt;
Bob Wilsond8d92d92013-11-03 06:48:38 +00001262 }
1263
Evandro Menezesa7d48282018-07-30 16:20:04 +00001264 // pow(x, n) -> x * x * x * ....
1265 if (Pow->isFast()) {
1266 APFloat ExpoA = abs(ExpoC->getValueAPF());
1267 // We limit to a max of 7 fmul(s). Thus the maximum exponent is 32.
Weiming Zhao82130722015-12-04 22:00:47 +00001268 // This transformation applies to integer exponents only.
Evandro Menezesa7d48282018-07-30 16:20:04 +00001269 if (!ExpoA.isInteger() ||
1270 ExpoA.compare
1271 (APFloat(ExpoA.getSemantics(), 32.0)) == APFloat::cmpGreaterThan)
Weiming Zhao82130722015-12-04 22:00:47 +00001272 return nullptr;
1273
1274 // We will memoize intermediate products of the Addition Chain.
1275 Value *InnerChain[33] = {nullptr};
Evandro Menezesa7d48282018-07-30 16:20:04 +00001276 InnerChain[1] = Base;
1277 InnerChain[2] = B.CreateFMul(Base, Base, "square");
Weiming Zhao82130722015-12-04 22:00:47 +00001278
1279 // We cannot readily convert a non-double type (like float) to a double.
Evandro Menezes61e4e402018-07-31 22:11:02 +00001280 // So we first convert it to something which could be converted to double.
Evandro Menezesa7d48282018-07-30 16:20:04 +00001281 ExpoA.convert(APFloat::IEEEdouble(), APFloat::rmTowardZero, &Ignored);
Evandro Menezesa7d48282018-07-30 16:20:04 +00001282 Value *FMul = getPow(InnerChain, ExpoA.convertToDouble(), B);
Evandro Menezes61e4e402018-07-31 22:11:02 +00001283
1284 // If the exponent is negative, then get the reciprocal.
Evandro Menezesa7d48282018-07-30 16:20:04 +00001285 if (ExpoC->isNegative())
1286 FMul = B.CreateFDiv(ConstantFP::get(Ty, 1.0), FMul, "reciprocal");
Weiming Zhao82130722015-12-04 22:00:47 +00001287 return FMul;
1288 }
1289
Chris Bienemanad070d02014-09-17 20:55:46 +00001290 return nullptr;
1291}
Bob Wilsond8d92d92013-11-03 06:48:38 +00001292
Chris Bienemanad070d02014-09-17 20:55:46 +00001293Value *LibCallSimplifier::optimizeExp2(CallInst *CI, IRBuilder<> &B) {
1294 Function *Callee = CI->getCalledFunction();
Chris Bienemanad070d02014-09-17 20:55:46 +00001295 Value *Ret = nullptr;
Davide Italianoa3458772015-11-05 19:18:23 +00001296 StringRef Name = Callee->getName();
1297 if (UnsafeFPShrink && Name == "exp2" && hasFloatVersion(Name))
Chris Bienemanad070d02014-09-17 20:55:46 +00001298 Ret = optimizeUnaryDoubleFP(CI, B, true);
Bob Wilsond8d92d92013-11-03 06:48:38 +00001299
Chris Bienemanad070d02014-09-17 20:55:46 +00001300 Value *Op = CI->getArgOperand(0);
1301 // Turn exp2(sitofp(x)) -> ldexp(1.0, sext(x)) if sizeof(x) <= 32
1302 // Turn exp2(uitofp(x)) -> ldexp(1.0, zext(x)) if sizeof(x) < 32
David L. Jonesd21529f2017-01-23 23:16:46 +00001303 LibFunc LdExp = LibFunc_ldexpl;
Chris Bienemanad070d02014-09-17 20:55:46 +00001304 if (Op->getType()->isFloatTy())
David L. Jonesd21529f2017-01-23 23:16:46 +00001305 LdExp = LibFunc_ldexpf;
Chris Bienemanad070d02014-09-17 20:55:46 +00001306 else if (Op->getType()->isDoubleTy())
David L. Jonesd21529f2017-01-23 23:16:46 +00001307 LdExp = LibFunc_ldexp;
Chris Bienemanad070d02014-09-17 20:55:46 +00001308
1309 if (TLI->has(LdExp)) {
1310 Value *LdExpArg = nullptr;
1311 if (SIToFPInst *OpC = dyn_cast<SIToFPInst>(Op)) {
1312 if (OpC->getOperand(0)->getType()->getPrimitiveSizeInBits() <= 32)
1313 LdExpArg = B.CreateSExt(OpC->getOperand(0), B.getInt32Ty());
1314 } else if (UIToFPInst *OpC = dyn_cast<UIToFPInst>(Op)) {
1315 if (OpC->getOperand(0)->getType()->getPrimitiveSizeInBits() < 32)
1316 LdExpArg = B.CreateZExt(OpC->getOperand(0), B.getInt32Ty());
1317 }
1318
1319 if (LdExpArg) {
1320 Constant *One = ConstantFP::get(CI->getContext(), APFloat(1.0f));
1321 if (!Op->getType()->isFloatTy())
1322 One = ConstantExpr::getFPExtend(One, Op->getType());
1323
Sanjay Patel0e603fc2016-01-21 22:31:18 +00001324 Module *M = CI->getModule();
Mehdi Aminidb11fdf2017-04-06 20:23:57 +00001325 Value *NewCallee =
1326 M->getOrInsertFunction(TLI->getName(LdExp), Op->getType(),
Serge Guelton59a2d7b2017-04-11 15:01:18 +00001327 Op->getType(), B.getInt32Ty());
Sanjay Patel042aed902016-01-21 22:41:16 +00001328 CallInst *CI = B.CreateCall(NewCallee, {One, LdExpArg});
Chris Bienemanad070d02014-09-17 20:55:46 +00001329 if (const Function *F = dyn_cast<Function>(Callee->stripPointerCasts()))
1330 CI->setCallingConv(F->getCallingConv());
1331
1332 return CI;
1333 }
1334 }
1335 return Ret;
1336}
1337
Sanjay Patel57fd1dc2015-08-16 20:18:19 +00001338Value *LibCallSimplifier::optimizeFMinFMax(CallInst *CI, IRBuilder<> &B) {
Sanjay Patel9beec212016-01-21 22:58:01 +00001339 Function *Callee = CI->getCalledFunction();
Sanjay Patel57fd1dc2015-08-16 20:18:19 +00001340 // If we can shrink the call to a float function rather than a double
1341 // function, do that first.
Davide Italianoa3458772015-11-05 19:18:23 +00001342 StringRef Name = Callee->getName();
Sanjay Patelc7ddb7f2016-01-06 00:32:15 +00001343 if ((Name == "fmin" || Name == "fmax") && hasFloatVersion(Name))
1344 if (Value *Ret = optimizeBinaryDoubleFP(CI, B))
Sanjay Patel57fd1dc2015-08-16 20:18:19 +00001345 return Ret;
Sanjay Patel57fd1dc2015-08-16 20:18:19 +00001346
Benjamin Kramerbb70d752015-08-16 21:16:37 +00001347 IRBuilder<>::FastMathFlagGuard Guard(B);
Sanjay Patel57fd1dc2015-08-16 20:18:19 +00001348 FastMathFlags FMF;
Sanjay Patel629c4112017-11-06 16:27:15 +00001349 if (CI->isFast()) {
1350 // If the call is 'fast', then anything we create here will also be 'fast'.
1351 FMF.setFast();
Sanjay Patel57fd1dc2015-08-16 20:18:19 +00001352 } else {
1353 // At a minimum, no-nans-fp-math must be true.
Sanjay Patel29095ea2016-01-05 20:46:19 +00001354 if (!CI->hasNoNaNs())
Sanjay Patel57fd1dc2015-08-16 20:18:19 +00001355 return nullptr;
1356 // No-signed-zeros is implied by the definitions of fmax/fmin themselves:
1357 // "Ideally, fmax would be sensitive to the sign of zero, for example
NAKAMURA Takumi0d725392015-09-07 00:26:54 +00001358 // fmax(-0. 0, +0. 0) would return +0; however, implementation in software
Sanjay Patel57fd1dc2015-08-16 20:18:19 +00001359 // might be impractical."
1360 FMF.setNoSignedZeros();
1361 FMF.setNoNaNs();
1362 }
Sanjay Patela2528152016-01-12 18:03:37 +00001363 B.setFastMathFlags(FMF);
Sanjay Patel57fd1dc2015-08-16 20:18:19 +00001364
1365 // We have a relaxed floating-point environment. We can ignore NaN-handling
1366 // and transform to a compare and select. We do not have to consider errno or
1367 // exceptions, because fmin/fmax do not have those.
1368 Value *Op0 = CI->getArgOperand(0);
1369 Value *Op1 = CI->getArgOperand(1);
1370 Value *Cmp = Callee->getName().startswith("fmin") ?
1371 B.CreateFCmpOLT(Op0, Op1) : B.CreateFCmpOGT(Op0, Op1);
1372 return B.CreateSelect(Cmp, Op0, Op1);
1373}
1374
Davide Italianob8b71332015-11-29 20:58:04 +00001375Value *LibCallSimplifier::optimizeLog(CallInst *CI, IRBuilder<> &B) {
1376 Function *Callee = CI->getCalledFunction();
1377 Value *Ret = nullptr;
1378 StringRef Name = Callee->getName();
1379 if (UnsafeFPShrink && hasFloatVersion(Name))
1380 Ret = optimizeUnaryDoubleFP(CI, B, true);
Davide Italianob8b71332015-11-29 20:58:04 +00001381
Sanjay Patel629c4112017-11-06 16:27:15 +00001382 if (!CI->isFast())
Davide Italianob8b71332015-11-29 20:58:04 +00001383 return Ret;
1384 Value *Op1 = CI->getArgOperand(0);
1385 auto *OpC = dyn_cast<CallInst>(Op1);
Sanjay Patele896ede2016-01-11 23:31:48 +00001386
Sanjay Patel629c4112017-11-06 16:27:15 +00001387 // The earlier call must also be 'fast' in order to do these transforms.
1388 if (!OpC || !OpC->isFast())
Davide Italianob8b71332015-11-29 20:58:04 +00001389 return Ret;
1390
1391 // log(pow(x,y)) -> y*log(x)
1392 // This is only applicable to log, log2, log10.
1393 if (Name != "log" && Name != "log2" && Name != "log10")
1394 return Ret;
1395
1396 IRBuilder<>::FastMathFlagGuard Guard(B);
1397 FastMathFlags FMF;
Sanjay Patel629c4112017-11-06 16:27:15 +00001398 FMF.setFast();
Sanjay Patela2528152016-01-12 18:03:37 +00001399 B.setFastMathFlags(FMF);
Davide Italianob8b71332015-11-29 20:58:04 +00001400
David L. Jonesd21529f2017-01-23 23:16:46 +00001401 LibFunc Func;
Davide Italianob8b71332015-11-29 20:58:04 +00001402 Function *F = OpC->getCalledFunction();
Davide Italiano0b14f292015-11-29 21:58:56 +00001403 if (F && ((TLI->getLibFunc(F->getName(), Func) && TLI->has(Func) &&
David L. Jonesd21529f2017-01-23 23:16:46 +00001404 Func == LibFunc_pow) || F->getIntrinsicID() == Intrinsic::pow))
Davide Italianob8b71332015-11-29 20:58:04 +00001405 return B.CreateFMul(OpC->getArgOperand(1),
Sanjay Pateld3112a52016-01-19 19:46:10 +00001406 emitUnaryFloatFnCall(OpC->getOperand(0), Callee->getName(), B,
Davide Italianob8b71332015-11-29 20:58:04 +00001407 Callee->getAttributes()), "mul");
Davide Italiano1aeed6a2015-11-30 19:36:35 +00001408
1409 // log(exp2(y)) -> y*log(2)
1410 if (F && Name == "log" && TLI->getLibFunc(F->getName(), Func) &&
David L. Jonesd21529f2017-01-23 23:16:46 +00001411 TLI->has(Func) && Func == LibFunc_exp2)
Davide Italiano1aeed6a2015-11-30 19:36:35 +00001412 return B.CreateFMul(
1413 OpC->getArgOperand(0),
Sanjay Pateld3112a52016-01-19 19:46:10 +00001414 emitUnaryFloatFnCall(ConstantFP::get(CI->getType(), 2.0),
Davide Italiano1aeed6a2015-11-30 19:36:35 +00001415 Callee->getName(), B, Callee->getAttributes()),
1416 "logmul");
Davide Italianob8b71332015-11-29 20:58:04 +00001417 return Ret;
1418}
1419
Sanjay Patelc699a612014-10-16 18:48:17 +00001420Value *LibCallSimplifier::optimizeSqrt(CallInst *CI, IRBuilder<> &B) {
1421 Function *Callee = CI->getCalledFunction();
Sanjay Patelc699a612014-10-16 18:48:17 +00001422 Value *Ret = nullptr;
Justin Lebarcb9b41d2017-01-27 00:58:03 +00001423 // TODO: Once we have a way (other than checking for the existince of the
1424 // libcall) to tell whether our target can lower @llvm.sqrt, relax the
1425 // condition below.
David L. Jonesd21529f2017-01-23 23:16:46 +00001426 if (TLI->has(LibFunc_sqrtf) && (Callee->getName() == "sqrt" ||
Justin Lebarcb9b41d2017-01-27 00:58:03 +00001427 Callee->getIntrinsicID() == Intrinsic::sqrt))
Sanjay Patelc699a612014-10-16 18:48:17 +00001428 Ret = optimizeUnaryDoubleFP(CI, B, true);
Sanjay Patel683f2972016-01-11 22:34:19 +00001429
Sanjay Patel629c4112017-11-06 16:27:15 +00001430 if (!CI->isFast())
Davide Italianoa904e522015-10-29 02:58:44 +00001431 return Ret;
Sanjay Patelc699a612014-10-16 18:48:17 +00001432
Sanjay Patelc2d64612016-01-06 20:52:21 +00001433 Instruction *I = dyn_cast<Instruction>(CI->getArgOperand(0));
Sanjay Patel629c4112017-11-06 16:27:15 +00001434 if (!I || I->getOpcode() != Instruction::FMul || !I->isFast())
Sanjay Patelc2d64612016-01-06 20:52:21 +00001435 return Ret;
1436
1437 // We're looking for a repeated factor in a multiplication tree,
1438 // so we can do this fold: sqrt(x * x) -> fabs(x);
Sanjay Patel683f2972016-01-11 22:34:19 +00001439 // or this fold: sqrt((x * x) * y) -> fabs(x) * sqrt(y).
Sanjay Patelc2d64612016-01-06 20:52:21 +00001440 Value *Op0 = I->getOperand(0);
1441 Value *Op1 = I->getOperand(1);
1442 Value *RepeatOp = nullptr;
1443 Value *OtherOp = nullptr;
1444 if (Op0 == Op1) {
1445 // Simple match: the operands of the multiply are identical.
1446 RepeatOp = Op0;
1447 } else {
1448 // Look for a more complicated pattern: one of the operands is itself
1449 // a multiply, so search for a common factor in that multiply.
1450 // Note: We don't bother looking any deeper than this first level or for
1451 // variations of this pattern because instcombine's visitFMUL and/or the
1452 // reassociation pass should give us this form.
1453 Value *OtherMul0, *OtherMul1;
1454 if (match(Op0, m_FMul(m_Value(OtherMul0), m_Value(OtherMul1)))) {
1455 // Pattern: sqrt((x * y) * z)
Sanjay Patel629c4112017-11-06 16:27:15 +00001456 if (OtherMul0 == OtherMul1 && cast<Instruction>(Op0)->isFast()) {
Sanjay Patelc2d64612016-01-06 20:52:21 +00001457 // Matched: sqrt((x * x) * z)
1458 RepeatOp = OtherMul0;
1459 OtherOp = Op1;
Sanjay Patelc699a612014-10-16 18:48:17 +00001460 }
1461 }
1462 }
Sanjay Patelc2d64612016-01-06 20:52:21 +00001463 if (!RepeatOp)
1464 return Ret;
1465
1466 // Fast math flags for any created instructions should match the sqrt
1467 // and multiply.
Sanjay Patelc2d64612016-01-06 20:52:21 +00001468 IRBuilder<>::FastMathFlagGuard Guard(B);
Sanjay Patela2528152016-01-12 18:03:37 +00001469 B.setFastMathFlags(I->getFastMathFlags());
Sanjay Patel9f67dad2016-01-11 22:35:39 +00001470
Sanjay Patelc2d64612016-01-06 20:52:21 +00001471 // If we found a repeated factor, hoist it out of the square root and
1472 // replace it with the fabs of that factor.
1473 Module *M = Callee->getParent();
1474 Type *ArgType = I->getType();
1475 Value *Fabs = Intrinsic::getDeclaration(M, Intrinsic::fabs, ArgType);
1476 Value *FabsCall = B.CreateCall(Fabs, RepeatOp, "fabs");
1477 if (OtherOp) {
1478 // If we found a non-repeated factor, we still need to get its square
1479 // root. We then multiply that by the value that was simplified out
1480 // of the square root calculation.
1481 Value *Sqrt = Intrinsic::getDeclaration(M, Intrinsic::sqrt, ArgType);
1482 Value *SqrtCall = B.CreateCall(Sqrt, OtherOp, "sqrt");
1483 return B.CreateFMul(FabsCall, SqrtCall);
1484 }
1485 return FabsCall;
Sanjay Patelc699a612014-10-16 18:48:17 +00001486}
1487
Sanjay Patelcddcd722016-01-06 19:23:35 +00001488// TODO: Generalize to handle any trig function and its inverse.
Davide Italiano51507d22015-11-04 23:36:56 +00001489Value *LibCallSimplifier::optimizeTan(CallInst *CI, IRBuilder<> &B) {
1490 Function *Callee = CI->getCalledFunction();
1491 Value *Ret = nullptr;
Davide Italianoa3458772015-11-05 19:18:23 +00001492 StringRef Name = Callee->getName();
1493 if (UnsafeFPShrink && Name == "tan" && hasFloatVersion(Name))
Davide Italiano51507d22015-11-04 23:36:56 +00001494 Ret = optimizeUnaryDoubleFP(CI, B, true);
Davide Italiano51507d22015-11-04 23:36:56 +00001495
Davide Italiano51507d22015-11-04 23:36:56 +00001496 Value *Op1 = CI->getArgOperand(0);
1497 auto *OpC = dyn_cast<CallInst>(Op1);
1498 if (!OpC)
1499 return Ret;
1500
Sanjay Patel629c4112017-11-06 16:27:15 +00001501 // Both calls must be 'fast' in order to remove them.
1502 if (!CI->isFast() || !OpC->isFast())
Sanjay Patelcddcd722016-01-06 19:23:35 +00001503 return Ret;
1504
Davide Italiano51507d22015-11-04 23:36:56 +00001505 // tan(atan(x)) -> x
1506 // tanf(atanf(x)) -> x
1507 // tanl(atanl(x)) -> x
David L. Jonesd21529f2017-01-23 23:16:46 +00001508 LibFunc Func;
Davide Italiano51507d22015-11-04 23:36:56 +00001509 Function *F = OpC->getCalledFunction();
Benjamin Kramerfb419e72015-11-26 09:51:17 +00001510 if (F && TLI->getLibFunc(F->getName(), Func) && TLI->has(Func) &&
David L. Jonesd21529f2017-01-23 23:16:46 +00001511 ((Func == LibFunc_atan && Callee->getName() == "tan") ||
1512 (Func == LibFunc_atanf && Callee->getName() == "tanf") ||
1513 (Func == LibFunc_atanl && Callee->getName() == "tanl")))
Davide Italiano51507d22015-11-04 23:36:56 +00001514 Ret = OpC->getArgOperand(0);
1515 return Ret;
1516}
1517
Sanjay Patel57747212016-01-21 23:38:43 +00001518static bool isTrigLibCall(CallInst *CI) {
Sanjay Patel57747212016-01-21 23:38:43 +00001519 // We can only hope to do anything useful if we can ignore things like errno
1520 // and floating-point exceptions.
Ahmed Bougachad765a822016-04-27 19:04:35 +00001521 // We already checked the prototype.
1522 return CI->hasFnAttr(Attribute::NoUnwind) &&
1523 CI->hasFnAttr(Attribute::ReadNone);
Sanjay Patel57747212016-01-21 23:38:43 +00001524}
1525
Chris Bienemanad070d02014-09-17 20:55:46 +00001526static void insertSinCosCall(IRBuilder<> &B, Function *OrigCallee, Value *Arg,
1527 bool UseFloat, Value *&Sin, Value *&Cos,
Sanjay Patel57747212016-01-21 23:38:43 +00001528 Value *&SinCos) {
1529 Type *ArgTy = Arg->getType();
1530 Type *ResTy;
1531 StringRef Name;
1532
1533 Triple T(OrigCallee->getParent()->getTargetTriple());
1534 if (UseFloat) {
1535 Name = "__sincospif_stret";
1536
1537 assert(T.getArch() != Triple::x86 && "x86 messy and unsupported for now");
1538 // x86_64 can't use {float, float} since that would be returned in both
1539 // xmm0 and xmm1, which isn't what a real struct would do.
1540 ResTy = T.getArch() == Triple::x86_64
Serge Gueltone38003f2017-05-09 19:31:13 +00001541 ? static_cast<Type *>(VectorType::get(ArgTy, 2))
1542 : static_cast<Type *>(StructType::get(ArgTy, ArgTy));
Sanjay Patel57747212016-01-21 23:38:43 +00001543 } else {
1544 Name = "__sincospi_stret";
Serge Gueltone38003f2017-05-09 19:31:13 +00001545 ResTy = StructType::get(ArgTy, ArgTy);
Sanjay Patel57747212016-01-21 23:38:43 +00001546 }
1547
1548 Module *M = OrigCallee->getParent();
Mehdi Aminidb11fdf2017-04-06 20:23:57 +00001549 Value *Callee = M->getOrInsertFunction(Name, OrigCallee->getAttributes(),
Serge Guelton59a2d7b2017-04-11 15:01:18 +00001550 ResTy, ArgTy);
Sanjay Patel57747212016-01-21 23:38:43 +00001551
1552 if (Instruction *ArgInst = dyn_cast<Instruction>(Arg)) {
1553 // If the argument is an instruction, it must dominate all uses so put our
1554 // sincos call there.
1555 B.SetInsertPoint(ArgInst->getParent(), ++ArgInst->getIterator());
1556 } else {
1557 // Otherwise (e.g. for a constant) the beginning of the function is as
1558 // good a place as any.
1559 BasicBlock &EntryBB = B.GetInsertBlock()->getParent()->getEntryBlock();
1560 B.SetInsertPoint(&EntryBB, EntryBB.begin());
1561 }
1562
1563 SinCos = B.CreateCall(Callee, Arg, "sincospi");
1564
1565 if (SinCos->getType()->isStructTy()) {
1566 Sin = B.CreateExtractValue(SinCos, 0, "sinpi");
1567 Cos = B.CreateExtractValue(SinCos, 1, "cospi");
1568 } else {
1569 Sin = B.CreateExtractElement(SinCos, ConstantInt::get(B.getInt32Ty(), 0),
1570 "sinpi");
1571 Cos = B.CreateExtractElement(SinCos, ConstantInt::get(B.getInt32Ty(), 1),
1572 "cospi");
1573 }
1574}
Chris Bienemanad070d02014-09-17 20:55:46 +00001575
1576Value *LibCallSimplifier::optimizeSinCosPi(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +00001577 // Make sure the prototype is as expected, otherwise the rest of the
1578 // function is probably invalid and likely to abort.
1579 if (!isTrigLibCall(CI))
1580 return nullptr;
1581
1582 Value *Arg = CI->getArgOperand(0);
1583 SmallVector<CallInst *, 1> SinCalls;
1584 SmallVector<CallInst *, 1> CosCalls;
1585 SmallVector<CallInst *, 1> SinCosCalls;
1586
1587 bool IsFloat = Arg->getType()->isFloatTy();
1588
1589 // Look for all compatible sinpi, cospi and sincospi calls with the same
1590 // argument. If there are enough (in some sense) we can make the
1591 // substitution.
David Majnemerabae6b52016-03-19 04:53:02 +00001592 Function *F = CI->getFunction();
Chris Bienemanad070d02014-09-17 20:55:46 +00001593 for (User *U : Arg->users())
David Majnemerabae6b52016-03-19 04:53:02 +00001594 classifyArgUse(U, F, IsFloat, SinCalls, CosCalls, SinCosCalls);
Chris Bienemanad070d02014-09-17 20:55:46 +00001595
1596 // It's only worthwhile if both sinpi and cospi are actually used.
1597 if (SinCosCalls.empty() && (SinCalls.empty() || CosCalls.empty()))
1598 return nullptr;
1599
1600 Value *Sin, *Cos, *SinCos;
1601 insertSinCosCall(B, CI->getCalledFunction(), Arg, IsFloat, Sin, Cos, SinCos);
1602
Davide Italianof024a562016-12-16 02:28:38 +00001603 auto replaceTrigInsts = [this](SmallVectorImpl<CallInst *> &Calls,
1604 Value *Res) {
1605 for (CallInst *C : Calls)
1606 replaceAllUsesWith(C, Res);
1607 };
1608
Chris Bienemanad070d02014-09-17 20:55:46 +00001609 replaceTrigInsts(SinCalls, Sin);
1610 replaceTrigInsts(CosCalls, Cos);
1611 replaceTrigInsts(SinCosCalls, SinCos);
1612
1613 return nullptr;
1614}
1615
David Majnemerabae6b52016-03-19 04:53:02 +00001616void LibCallSimplifier::classifyArgUse(
1617 Value *Val, Function *F, bool IsFloat,
1618 SmallVectorImpl<CallInst *> &SinCalls,
1619 SmallVectorImpl<CallInst *> &CosCalls,
1620 SmallVectorImpl<CallInst *> &SinCosCalls) {
Chris Bienemanad070d02014-09-17 20:55:46 +00001621 CallInst *CI = dyn_cast<CallInst>(Val);
1622
1623 if (!CI)
1624 return;
1625
David Majnemerabae6b52016-03-19 04:53:02 +00001626 // Don't consider calls in other functions.
1627 if (CI->getFunction() != F)
1628 return;
1629
Chris Bienemanad070d02014-09-17 20:55:46 +00001630 Function *Callee = CI->getCalledFunction();
David L. Jonesd21529f2017-01-23 23:16:46 +00001631 LibFunc Func;
Ahmed Bougachad765a822016-04-27 19:04:35 +00001632 if (!Callee || !TLI->getLibFunc(*Callee, Func) || !TLI->has(Func) ||
Benjamin Kramer89766e52015-11-28 21:43:12 +00001633 !isTrigLibCall(CI))
Chris Bienemanad070d02014-09-17 20:55:46 +00001634 return;
1635
1636 if (IsFloat) {
David L. Jonesd21529f2017-01-23 23:16:46 +00001637 if (Func == LibFunc_sinpif)
Chris Bienemanad070d02014-09-17 20:55:46 +00001638 SinCalls.push_back(CI);
David L. Jonesd21529f2017-01-23 23:16:46 +00001639 else if (Func == LibFunc_cospif)
Chris Bienemanad070d02014-09-17 20:55:46 +00001640 CosCalls.push_back(CI);
David L. Jonesd21529f2017-01-23 23:16:46 +00001641 else if (Func == LibFunc_sincospif_stret)
Chris Bienemanad070d02014-09-17 20:55:46 +00001642 SinCosCalls.push_back(CI);
1643 } else {
David L. Jonesd21529f2017-01-23 23:16:46 +00001644 if (Func == LibFunc_sinpi)
Chris Bienemanad070d02014-09-17 20:55:46 +00001645 SinCalls.push_back(CI);
David L. Jonesd21529f2017-01-23 23:16:46 +00001646 else if (Func == LibFunc_cospi)
Chris Bienemanad070d02014-09-17 20:55:46 +00001647 CosCalls.push_back(CI);
David L. Jonesd21529f2017-01-23 23:16:46 +00001648 else if (Func == LibFunc_sincospi_stret)
Chris Bienemanad070d02014-09-17 20:55:46 +00001649 SinCosCalls.push_back(CI);
1650 }
1651}
1652
Meador Inge7415f842012-11-25 20:45:27 +00001653//===----------------------------------------------------------------------===//
1654// Integer Library Call Optimizations
1655//===----------------------------------------------------------------------===//
1656
Chris Bienemanad070d02014-09-17 20:55:46 +00001657Value *LibCallSimplifier::optimizeFFS(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +00001658 // ffs(x) -> x != 0 ? (i32)llvm.cttz(x)+1 : 0
Davide Italiano890e8502016-12-15 23:11:00 +00001659 Value *Op = CI->getArgOperand(0);
Chris Bienemanad070d02014-09-17 20:55:46 +00001660 Type *ArgType = Op->getType();
Davide Italiano890e8502016-12-15 23:11:00 +00001661 Value *F = Intrinsic::getDeclaration(CI->getCalledFunction()->getParent(),
1662 Intrinsic::cttz, ArgType);
Davide Italianoa1953862015-08-13 20:34:26 +00001663 Value *V = B.CreateCall(F, {Op, B.getTrue()}, "cttz");
Chris Bienemanad070d02014-09-17 20:55:46 +00001664 V = B.CreateAdd(V, ConstantInt::get(V->getType(), 1));
1665 V = B.CreateIntCast(V, B.getInt32Ty(), false);
Meador Ingea0b6d872012-11-26 00:24:07 +00001666
Chris Bienemanad070d02014-09-17 20:55:46 +00001667 Value *Cond = B.CreateICmpNE(Op, Constant::getNullValue(ArgType));
1668 return B.CreateSelect(Cond, V, B.getInt32(0));
1669}
Meador Ingea0b6d872012-11-26 00:24:07 +00001670
Davide Italiano85ad36b2016-12-15 23:45:11 +00001671Value *LibCallSimplifier::optimizeFls(CallInst *CI, IRBuilder<> &B) {
1672 // fls(x) -> (i32)(sizeInBits(x) - llvm.ctlz(x, false))
1673 Value *Op = CI->getArgOperand(0);
1674 Type *ArgType = Op->getType();
1675 Value *F = Intrinsic::getDeclaration(CI->getCalledFunction()->getParent(),
1676 Intrinsic::ctlz, ArgType);
1677 Value *V = B.CreateCall(F, {Op, B.getFalse()}, "ctlz");
1678 V = B.CreateSub(ConstantInt::get(V->getType(), ArgType->getIntegerBitWidth()),
1679 V);
1680 return B.CreateIntCast(V, CI->getType(), false);
1681}
1682
Chris Bienemanad070d02014-09-17 20:55:46 +00001683Value *LibCallSimplifier::optimizeAbs(CallInst *CI, IRBuilder<> &B) {
Sanjay Patel4b969352018-05-22 23:29:40 +00001684 // abs(x) -> x <s 0 ? -x : x
1685 // The negation has 'nsw' because abs of INT_MIN is undefined.
1686 Value *X = CI->getArgOperand(0);
1687 Value *IsNeg = B.CreateICmpSLT(X, Constant::getNullValue(X->getType()));
1688 Value *NegX = B.CreateNSWNeg(X, "neg");
1689 return B.CreateSelect(IsNeg, NegX, X);
Chris Bienemanad070d02014-09-17 20:55:46 +00001690}
Meador Inge9a59ab62012-11-26 02:31:59 +00001691
Chris Bienemanad070d02014-09-17 20:55:46 +00001692Value *LibCallSimplifier::optimizeIsDigit(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +00001693 // isdigit(c) -> (c-'0') <u 10
1694 Value *Op = CI->getArgOperand(0);
1695 Op = B.CreateSub(Op, B.getInt32('0'), "isdigittmp");
1696 Op = B.CreateICmpULT(Op, B.getInt32(10), "isdigit");
1697 return B.CreateZExt(Op, CI->getType());
1698}
Meador Ingea62a39e2012-11-26 03:10:07 +00001699
Chris Bienemanad070d02014-09-17 20:55:46 +00001700Value *LibCallSimplifier::optimizeIsAscii(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +00001701 // isascii(c) -> c <u 128
1702 Value *Op = CI->getArgOperand(0);
1703 Op = B.CreateICmpULT(Op, B.getInt32(128), "isascii");
1704 return B.CreateZExt(Op, CI->getType());
1705}
1706
1707Value *LibCallSimplifier::optimizeToAscii(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +00001708 // toascii(c) -> c & 0x7f
1709 return B.CreateAnd(CI->getArgOperand(0),
1710 ConstantInt::get(CI->getType(), 0x7F));
1711}
Meador Inge604937d2012-11-26 03:38:52 +00001712
David Bolvanskycb8ca5f32018-04-25 18:58:53 +00001713Value *LibCallSimplifier::optimizeAtoi(CallInst *CI, IRBuilder<> &B) {
1714 StringRef Str;
1715 if (!getConstantStringInfo(CI->getArgOperand(0), Str))
1716 return nullptr;
1717
1718 return convertStrToNumber(CI, Str, 10);
1719}
1720
1721Value *LibCallSimplifier::optimizeStrtol(CallInst *CI, IRBuilder<> &B) {
1722 StringRef Str;
1723 if (!getConstantStringInfo(CI->getArgOperand(0), Str))
1724 return nullptr;
1725
1726 if (!isa<ConstantPointerNull>(CI->getArgOperand(1)))
1727 return nullptr;
1728
1729 if (ConstantInt *CInt = dyn_cast<ConstantInt>(CI->getArgOperand(2))) {
1730 return convertStrToNumber(CI, Str, CInt->getSExtValue());
1731 }
1732
1733 return nullptr;
1734}
1735
Meador Inge08ca1152012-11-26 20:37:20 +00001736//===----------------------------------------------------------------------===//
1737// Formatting and IO Library Call Optimizations
1738//===----------------------------------------------------------------------===//
1739
Chris Bienemanad070d02014-09-17 20:55:46 +00001740static bool isReportingError(Function *Callee, CallInst *CI, int StreamArg);
Hal Finkel66cd3f12013-11-17 02:06:35 +00001741
Chris Bienemanad070d02014-09-17 20:55:46 +00001742Value *LibCallSimplifier::optimizeErrorReporting(CallInst *CI, IRBuilder<> &B,
1743 int StreamArg) {
Ahmed Bougachad765a822016-04-27 19:04:35 +00001744 Function *Callee = CI->getCalledFunction();
Chris Bienemanad070d02014-09-17 20:55:46 +00001745 // Error reporting calls should be cold, mark them as such.
1746 // This applies even to non-builtin calls: it is only a hint and applies to
1747 // functions that the frontend might not understand as builtins.
Hal Finkel66cd3f12013-11-17 02:06:35 +00001748
Chris Bienemanad070d02014-09-17 20:55:46 +00001749 // This heuristic was suggested in:
1750 // Improving Static Branch Prediction in a Compiler
1751 // Brian L. Deitrich, Ben-Chung Cheng, Wen-mei W. Hwu
1752 // Proceedings of PACT'98, Oct. 1998, IEEE
Chris Bienemanad070d02014-09-17 20:55:46 +00001753 if (!CI->hasFnAttr(Attribute::Cold) &&
1754 isReportingError(Callee, CI, StreamArg)) {
Reid Klecknerb5180542017-03-21 16:57:19 +00001755 CI->addAttribute(AttributeList::FunctionIndex, Attribute::Cold);
Chris Bienemanad070d02014-09-17 20:55:46 +00001756 }
Hal Finkel66cd3f12013-11-17 02:06:35 +00001757
Chris Bienemanad070d02014-09-17 20:55:46 +00001758 return nullptr;
1759}
1760
1761static bool isReportingError(Function *Callee, CallInst *CI, int StreamArg) {
Davide Italiano5b65f122017-04-25 03:48:47 +00001762 if (!Callee || !Callee->isDeclaration())
Chris Bienemanad070d02014-09-17 20:55:46 +00001763 return false;
1764
1765 if (StreamArg < 0)
1766 return true;
1767
1768 // These functions might be considered cold, but only if their stream
1769 // argument is stderr.
1770
1771 if (StreamArg >= (int)CI->getNumArgOperands())
1772 return false;
1773 LoadInst *LI = dyn_cast<LoadInst>(CI->getArgOperand(StreamArg));
1774 if (!LI)
1775 return false;
1776 GlobalVariable *GV = dyn_cast<GlobalVariable>(LI->getPointerOperand());
1777 if (!GV || !GV->isDeclaration())
1778 return false;
1779 return GV->getName() == "stderr";
1780}
1781
1782Value *LibCallSimplifier::optimizePrintFString(CallInst *CI, IRBuilder<> &B) {
1783 // Check for a fixed format string.
1784 StringRef FormatStr;
1785 if (!getConstantStringInfo(CI->getArgOperand(0), FormatStr))
Craig Topperf40110f2014-04-25 05:29:35 +00001786 return nullptr;
Hal Finkel66cd3f12013-11-17 02:06:35 +00001787
Chris Bienemanad070d02014-09-17 20:55:46 +00001788 // Empty format string -> noop.
1789 if (FormatStr.empty()) // Tolerate printf's declared void.
1790 return CI->use_empty() ? (Value *)CI : ConstantInt::get(CI->getType(), 0);
Hal Finkel66cd3f12013-11-17 02:06:35 +00001791
Chris Bienemanad070d02014-09-17 20:55:46 +00001792 // Do not do any of the following transformations if the printf return value
1793 // is used, in general the printf return value is not compatible with either
1794 // putchar() or puts().
1795 if (!CI->use_empty())
Craig Topperf40110f2014-04-25 05:29:35 +00001796 return nullptr;
Chris Bienemanad070d02014-09-17 20:55:46 +00001797
Joerg Sonnenberger8ffe7ab2016-05-09 14:36:16 +00001798 // printf("x") -> putchar('x'), even for "%" and "%%".
1799 if (FormatStr.size() == 1 || FormatStr == "%%")
Davide Italianod4f5a052016-04-03 01:46:52 +00001800 return emitPutChar(B.getInt32(FormatStr[0]), B, TLI);
Meador Inge08ca1152012-11-26 20:37:20 +00001801
Davide Italiano6db1dcb2016-03-28 15:54:01 +00001802 // printf("%s", "a") --> putchar('a')
1803 if (FormatStr == "%s" && CI->getNumArgOperands() > 1) {
1804 StringRef ChrStr;
1805 if (!getConstantStringInfo(CI->getOperand(1), ChrStr))
1806 return nullptr;
1807 if (ChrStr.size() != 1)
1808 return nullptr;
Davide Italianod4f5a052016-04-03 01:46:52 +00001809 return emitPutChar(B.getInt32(ChrStr[0]), B, TLI);
Davide Italiano6db1dcb2016-03-28 15:54:01 +00001810 }
1811
Chris Bienemanad070d02014-09-17 20:55:46 +00001812 // printf("foo\n") --> puts("foo")
1813 if (FormatStr[FormatStr.size() - 1] == '\n' &&
1814 FormatStr.find('%') == StringRef::npos) { // No format characters.
1815 // Create a string literal with no \n on it. We expect the constant merge
1816 // pass to be run after this pass, to merge duplicate strings.
1817 FormatStr = FormatStr.drop_back();
1818 Value *GV = B.CreateGlobalString(FormatStr, "str");
Davide Italianod4f5a052016-04-03 01:46:52 +00001819 return emitPutS(GV, B, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +00001820 }
Meador Inge08ca1152012-11-26 20:37:20 +00001821
Chris Bienemanad070d02014-09-17 20:55:46 +00001822 // Optimize specific format strings.
1823 // printf("%c", chr) --> putchar(chr)
1824 if (FormatStr == "%c" && CI->getNumArgOperands() > 1 &&
Davide Italianod4f5a052016-04-03 01:46:52 +00001825 CI->getArgOperand(1)->getType()->isIntegerTy())
1826 return emitPutChar(CI->getArgOperand(1), B, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +00001827
1828 // printf("%s\n", str) --> puts(str)
1829 if (FormatStr == "%s\n" && CI->getNumArgOperands() > 1 &&
Davide Italianod4f5a052016-04-03 01:46:52 +00001830 CI->getArgOperand(1)->getType()->isPointerTy())
Sanjay Pateld3112a52016-01-19 19:46:10 +00001831 return emitPutS(CI->getArgOperand(1), B, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +00001832 return nullptr;
1833}
1834
1835Value *LibCallSimplifier::optimizePrintF(CallInst *CI, IRBuilder<> &B) {
1836
1837 Function *Callee = CI->getCalledFunction();
Chris Bienemanad070d02014-09-17 20:55:46 +00001838 FunctionType *FT = Callee->getFunctionType();
Chris Bienemanad070d02014-09-17 20:55:46 +00001839 if (Value *V = optimizePrintFString(CI, B)) {
1840 return V;
1841 }
1842
1843 // printf(format, ...) -> iprintf(format, ...) if no floating point
1844 // arguments.
David L. Jonesd21529f2017-01-23 23:16:46 +00001845 if (TLI->has(LibFunc_iprintf) && !callHasFloatingPointArgument(CI)) {
Chris Bienemanad070d02014-09-17 20:55:46 +00001846 Module *M = B.GetInsertBlock()->getParent()->getParent();
1847 Constant *IPrintFFn =
Meador Inge08ca1152012-11-26 20:37:20 +00001848 M->getOrInsertFunction("iprintf", FT, Callee->getAttributes());
Chris Bienemanad070d02014-09-17 20:55:46 +00001849 CallInst *New = cast<CallInst>(CI->clone());
1850 New->setCalledFunction(IPrintFFn);
1851 B.Insert(New);
1852 return New;
Meador Inge08ca1152012-11-26 20:37:20 +00001853 }
Chris Bienemanad070d02014-09-17 20:55:46 +00001854 return nullptr;
1855}
Meador Inge08ca1152012-11-26 20:37:20 +00001856
Chris Bienemanad070d02014-09-17 20:55:46 +00001857Value *LibCallSimplifier::optimizeSPrintFString(CallInst *CI, IRBuilder<> &B) {
1858 // Check for a fixed format string.
1859 StringRef FormatStr;
1860 if (!getConstantStringInfo(CI->getArgOperand(1), FormatStr))
Craig Topperf40110f2014-04-25 05:29:35 +00001861 return nullptr;
Meador Inge25c9b3b2012-11-27 05:57:54 +00001862
Chris Bienemanad070d02014-09-17 20:55:46 +00001863 // If we just have a format string (nothing else crazy) transform it.
1864 if (CI->getNumArgOperands() == 2) {
1865 // Make sure there's no % in the constant array. We could try to handle
1866 // %% -> % in the future if we cared.
David Bolvansky5430b7372018-05-31 16:39:27 +00001867 if (FormatStr.find('%') != StringRef::npos)
1868 return nullptr; // we found a format specifier, bail out.
Hal Finkel66cd3f12013-11-17 02:06:35 +00001869
Daniel Neilson8acd8b02018-02-05 21:23:22 +00001870 // sprintf(str, fmt) -> llvm.memcpy(align 1 str, align 1 fmt, strlen(fmt)+1)
1871 B.CreateMemCpy(CI->getArgOperand(0), 1, CI->getArgOperand(1), 1,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001872 ConstantInt::get(DL.getIntPtrType(CI->getContext()),
Daniel Neilson8acd8b02018-02-05 21:23:22 +00001873 FormatStr.size() + 1)); // Copy the null byte.
Chris Bienemanad070d02014-09-17 20:55:46 +00001874 return ConstantInt::get(CI->getType(), FormatStr.size());
Meador Ingef8e72502012-11-29 15:45:43 +00001875 }
Meador Ingef8e72502012-11-29 15:45:43 +00001876
Chris Bienemanad070d02014-09-17 20:55:46 +00001877 // The remaining optimizations require the format string to be "%s" or "%c"
1878 // and have an extra operand.
1879 if (FormatStr.size() != 2 || FormatStr[0] != '%' ||
1880 CI->getNumArgOperands() < 3)
Craig Topperf40110f2014-04-25 05:29:35 +00001881 return nullptr;
Meador Inge75798bb2012-11-29 19:15:17 +00001882
Chris Bienemanad070d02014-09-17 20:55:46 +00001883 // Decode the second character of the format string.
1884 if (FormatStr[1] == 'c') {
1885 // sprintf(dst, "%c", chr) --> *(i8*)dst = chr; *((i8*)dst+1) = 0
1886 if (!CI->getArgOperand(2)->getType()->isIntegerTy())
1887 return nullptr;
1888 Value *V = B.CreateTrunc(CI->getArgOperand(2), B.getInt8Ty(), "char");
Sanjay Pateld3112a52016-01-19 19:46:10 +00001889 Value *Ptr = castToCStr(CI->getArgOperand(0), B);
Chris Bienemanad070d02014-09-17 20:55:46 +00001890 B.CreateStore(V, Ptr);
David Blaikie3909da72015-03-30 20:42:56 +00001891 Ptr = B.CreateGEP(B.getInt8Ty(), Ptr, B.getInt32(1), "nul");
Chris Bienemanad070d02014-09-17 20:55:46 +00001892 B.CreateStore(B.getInt8(0), Ptr);
Meador Ingedf796f82012-10-13 16:45:24 +00001893
Chris Bienemanad070d02014-09-17 20:55:46 +00001894 return ConstantInt::get(CI->getType(), 1);
Meador Ingedf796f82012-10-13 16:45:24 +00001895 }
1896
Chris Bienemanad070d02014-09-17 20:55:46 +00001897 if (FormatStr[1] == 's') {
Chris Bienemanad070d02014-09-17 20:55:46 +00001898 // sprintf(dest, "%s", str) -> llvm.memcpy(dest, str, strlen(str)+1, 1)
1899 if (!CI->getArgOperand(2)->getType()->isPointerTy())
1900 return nullptr;
1901
Sanjay Pateld3112a52016-01-19 19:46:10 +00001902 Value *Len = emitStrLen(CI->getArgOperand(2), B, DL, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +00001903 if (!Len)
1904 return nullptr;
David Majnemerabb9f552016-04-26 21:04:47 +00001905 Value *IncLen =
1906 B.CreateAdd(Len, ConstantInt::get(Len->getType(), 1), "leninc");
Daniel Neilson8acd8b02018-02-05 21:23:22 +00001907 B.CreateMemCpy(CI->getArgOperand(0), 1, CI->getArgOperand(2), 1, IncLen);
Chris Bienemanad070d02014-09-17 20:55:46 +00001908
1909 // The sprintf result is the unincremented number of bytes in the string.
1910 return B.CreateIntCast(Len, CI->getType(), false);
1911 }
1912 return nullptr;
1913}
1914
1915Value *LibCallSimplifier::optimizeSPrintF(CallInst *CI, IRBuilder<> &B) {
1916 Function *Callee = CI->getCalledFunction();
Chris Bienemanad070d02014-09-17 20:55:46 +00001917 FunctionType *FT = Callee->getFunctionType();
Chris Bienemanad070d02014-09-17 20:55:46 +00001918 if (Value *V = optimizeSPrintFString(CI, B)) {
1919 return V;
1920 }
1921
1922 // sprintf(str, format, ...) -> siprintf(str, format, ...) if no floating
1923 // point arguments.
David L. Jonesd21529f2017-01-23 23:16:46 +00001924 if (TLI->has(LibFunc_siprintf) && !callHasFloatingPointArgument(CI)) {
Chris Bienemanad070d02014-09-17 20:55:46 +00001925 Module *M = B.GetInsertBlock()->getParent()->getParent();
1926 Constant *SIPrintFFn =
1927 M->getOrInsertFunction("siprintf", FT, Callee->getAttributes());
1928 CallInst *New = cast<CallInst>(CI->clone());
1929 New->setCalledFunction(SIPrintFFn);
1930 B.Insert(New);
1931 return New;
1932 }
1933 return nullptr;
1934}
1935
David Bolvanskycd93c4e2018-05-11 17:50:49 +00001936Value *LibCallSimplifier::optimizeSnPrintFString(CallInst *CI, IRBuilder<> &B) {
1937 // Check for a fixed format string.
1938 StringRef FormatStr;
1939 if (!getConstantStringInfo(CI->getArgOperand(2), FormatStr))
1940 return nullptr;
1941
1942 // Check for size
1943 ConstantInt *Size = dyn_cast<ConstantInt>(CI->getArgOperand(1));
1944 if (!Size)
1945 return nullptr;
1946
1947 uint64_t N = Size->getZExtValue();
1948
1949 // If we just have a format string (nothing else crazy) transform it.
1950 if (CI->getNumArgOperands() == 3) {
1951 // Make sure there's no % in the constant array. We could try to handle
1952 // %% -> % in the future if we cared.
David Bolvansky5430b7372018-05-31 16:39:27 +00001953 if (FormatStr.find('%') != StringRef::npos)
1954 return nullptr; // we found a format specifier, bail out.
David Bolvanskycd93c4e2018-05-11 17:50:49 +00001955
1956 if (N == 0)
1957 return ConstantInt::get(CI->getType(), FormatStr.size());
1958 else if (N < FormatStr.size() + 1)
1959 return nullptr;
1960
1961 // sprintf(str, size, fmt) -> llvm.memcpy(align 1 str, align 1 fmt,
1962 // strlen(fmt)+1)
1963 B.CreateMemCpy(
1964 CI->getArgOperand(0), 1, CI->getArgOperand(2), 1,
1965 ConstantInt::get(DL.getIntPtrType(CI->getContext()),
1966 FormatStr.size() + 1)); // Copy the null byte.
1967 return ConstantInt::get(CI->getType(), FormatStr.size());
1968 }
1969
1970 // The remaining optimizations require the format string to be "%s" or "%c"
1971 // and have an extra operand.
1972 if (FormatStr.size() == 2 && FormatStr[0] == '%' &&
1973 CI->getNumArgOperands() == 4) {
1974
1975 // Decode the second character of the format string.
1976 if (FormatStr[1] == 'c') {
1977 if (N == 0)
1978 return ConstantInt::get(CI->getType(), 1);
1979 else if (N == 1)
1980 return nullptr;
1981
1982 // snprintf(dst, size, "%c", chr) --> *(i8*)dst = chr; *((i8*)dst+1) = 0
1983 if (!CI->getArgOperand(3)->getType()->isIntegerTy())
1984 return nullptr;
1985 Value *V = B.CreateTrunc(CI->getArgOperand(3), B.getInt8Ty(), "char");
1986 Value *Ptr = castToCStr(CI->getArgOperand(0), B);
1987 B.CreateStore(V, Ptr);
1988 Ptr = B.CreateGEP(B.getInt8Ty(), Ptr, B.getInt32(1), "nul");
1989 B.CreateStore(B.getInt8(0), Ptr);
1990
1991 return ConstantInt::get(CI->getType(), 1);
1992 }
1993
1994 if (FormatStr[1] == 's') {
1995 // snprintf(dest, size, "%s", str) to llvm.memcpy(dest, str, len+1, 1)
1996 StringRef Str;
1997 if (!getConstantStringInfo(CI->getArgOperand(3), Str))
1998 return nullptr;
1999
2000 if (N == 0)
2001 return ConstantInt::get(CI->getType(), Str.size());
2002 else if (N < Str.size() + 1)
2003 return nullptr;
2004
2005 B.CreateMemCpy(CI->getArgOperand(0), 1, CI->getArgOperand(3), 1,
2006 ConstantInt::get(CI->getType(), Str.size() + 1));
2007
2008 // The snprintf result is the unincremented number of bytes in the string.
2009 return ConstantInt::get(CI->getType(), Str.size());
2010 }
2011 }
2012 return nullptr;
2013}
2014
2015Value *LibCallSimplifier::optimizeSnPrintF(CallInst *CI, IRBuilder<> &B) {
2016 if (Value *V = optimizeSnPrintFString(CI, B)) {
2017 return V;
2018 }
2019
2020 return nullptr;
2021}
2022
Chris Bienemanad070d02014-09-17 20:55:46 +00002023Value *LibCallSimplifier::optimizeFPrintFString(CallInst *CI, IRBuilder<> &B) {
2024 optimizeErrorReporting(CI, B, 0);
2025
2026 // All the optimizations depend on the format string.
2027 StringRef FormatStr;
2028 if (!getConstantStringInfo(CI->getArgOperand(1), FormatStr))
2029 return nullptr;
2030
2031 // Do not do any of the following transformations if the fprintf return
2032 // value is used, in general the fprintf return value is not compatible
2033 // with fwrite(), fputc() or fputs().
2034 if (!CI->use_empty())
2035 return nullptr;
2036
2037 // fprintf(F, "foo") --> fwrite("foo", 3, 1, F)
2038 if (CI->getNumArgOperands() == 2) {
David Bolvansky5430b7372018-05-31 16:39:27 +00002039 // Could handle %% -> % if we cared.
2040 if (FormatStr.find('%') != StringRef::npos)
2041 return nullptr; // We found a format specifier.
Chris Bienemanad070d02014-09-17 20:55:46 +00002042
Sanjay Pateld3112a52016-01-19 19:46:10 +00002043 return emitFWrite(
Chris Bienemanad070d02014-09-17 20:55:46 +00002044 CI->getArgOperand(1),
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002045 ConstantInt::get(DL.getIntPtrType(CI->getContext()), FormatStr.size()),
Chris Bienemanad070d02014-09-17 20:55:46 +00002046 CI->getArgOperand(0), B, DL, TLI);
2047 }
2048
2049 // The remaining optimizations require the format string to be "%s" or "%c"
2050 // and have an extra operand.
2051 if (FormatStr.size() != 2 || FormatStr[0] != '%' ||
2052 CI->getNumArgOperands() < 3)
2053 return nullptr;
2054
2055 // Decode the second character of the format string.
2056 if (FormatStr[1] == 'c') {
2057 // fprintf(F, "%c", chr) --> fputc(chr, F)
2058 if (!CI->getArgOperand(2)->getType()->isIntegerTy())
2059 return nullptr;
Sanjay Pateld3112a52016-01-19 19:46:10 +00002060 return emitFPutC(CI->getArgOperand(2), CI->getArgOperand(0), B, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +00002061 }
2062
2063 if (FormatStr[1] == 's') {
2064 // fprintf(F, "%s", str) --> fputs(str, F)
2065 if (!CI->getArgOperand(2)->getType()->isPointerTy())
2066 return nullptr;
Sanjay Pateld3112a52016-01-19 19:46:10 +00002067 return emitFPutS(CI->getArgOperand(2), CI->getArgOperand(0), B, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +00002068 }
2069 return nullptr;
2070}
2071
2072Value *LibCallSimplifier::optimizeFPrintF(CallInst *CI, IRBuilder<> &B) {
2073 Function *Callee = CI->getCalledFunction();
Chris Bienemanad070d02014-09-17 20:55:46 +00002074 FunctionType *FT = Callee->getFunctionType();
Chris Bienemanad070d02014-09-17 20:55:46 +00002075 if (Value *V = optimizeFPrintFString(CI, B)) {
2076 return V;
2077 }
2078
2079 // fprintf(stream, format, ...) -> fiprintf(stream, format, ...) if no
2080 // floating point arguments.
David L. Jonesd21529f2017-01-23 23:16:46 +00002081 if (TLI->has(LibFunc_fiprintf) && !callHasFloatingPointArgument(CI)) {
Chris Bienemanad070d02014-09-17 20:55:46 +00002082 Module *M = B.GetInsertBlock()->getParent()->getParent();
2083 Constant *FIPrintFFn =
2084 M->getOrInsertFunction("fiprintf", FT, Callee->getAttributes());
2085 CallInst *New = cast<CallInst>(CI->clone());
2086 New->setCalledFunction(FIPrintFFn);
2087 B.Insert(New);
2088 return New;
2089 }
2090 return nullptr;
2091}
2092
2093Value *LibCallSimplifier::optimizeFWrite(CallInst *CI, IRBuilder<> &B) {
2094 optimizeErrorReporting(CI, B, 3);
2095
Chris Bienemanad070d02014-09-17 20:55:46 +00002096 // Get the element size and count.
2097 ConstantInt *SizeC = dyn_cast<ConstantInt>(CI->getArgOperand(1));
2098 ConstantInt *CountC = dyn_cast<ConstantInt>(CI->getArgOperand(2));
David Bolvanskyca22d422018-05-16 11:39:52 +00002099 if (SizeC && CountC) {
2100 uint64_t Bytes = SizeC->getZExtValue() * CountC->getZExtValue();
Chris Bienemanad070d02014-09-17 20:55:46 +00002101
David Bolvanskyca22d422018-05-16 11:39:52 +00002102 // If this is writing zero records, remove the call (it's a noop).
2103 if (Bytes == 0)
2104 return ConstantInt::get(CI->getType(), 0);
Chris Bienemanad070d02014-09-17 20:55:46 +00002105
David Bolvanskyca22d422018-05-16 11:39:52 +00002106 // If this is writing one byte, turn it into fputc.
2107 // This optimisation is only valid, if the return value is unused.
2108 if (Bytes == 1 && CI->use_empty()) { // fwrite(S,1,1,F) -> fputc(S[0],F)
2109 Value *Char = B.CreateLoad(castToCStr(CI->getArgOperand(0), B), "char");
2110 Value *NewCI = emitFPutC(Char, CI->getArgOperand(3), B, TLI);
2111 return NewCI ? ConstantInt::get(CI->getType(), 1) : nullptr;
2112 }
Chris Bienemanad070d02014-09-17 20:55:46 +00002113 }
2114
David Bolvanskyca22d422018-05-16 11:39:52 +00002115 if (isLocallyOpenedFile(CI->getArgOperand(3), CI, B, TLI))
2116 return emitFWriteUnlocked(CI->getArgOperand(0), CI->getArgOperand(1),
2117 CI->getArgOperand(2), CI->getArgOperand(3), B, DL,
2118 TLI);
2119
Chris Bienemanad070d02014-09-17 20:55:46 +00002120 return nullptr;
2121}
2122
2123Value *LibCallSimplifier::optimizeFPuts(CallInst *CI, IRBuilder<> &B) {
2124 optimizeErrorReporting(CI, B, 1);
2125
Sjoerd Meijer7435a912016-07-07 14:31:19 +00002126 // Don't rewrite fputs to fwrite when optimising for size because fwrite
2127 // requires more arguments and thus extra MOVs are required.
David Bolvansky5430b7372018-05-31 16:39:27 +00002128 if (CI->getFunction()->optForSize())
Sjoerd Meijer7435a912016-07-07 14:31:19 +00002129 return nullptr;
2130
David Bolvanskyca22d422018-05-16 11:39:52 +00002131 // Check if has any use
2132 if (!CI->use_empty()) {
2133 if (isLocallyOpenedFile(CI->getArgOperand(1), CI, B, TLI))
2134 return emitFPutSUnlocked(CI->getArgOperand(0), CI->getArgOperand(1), B,
2135 TLI);
2136 else
2137 // We can't optimize if return value is used.
2138 return nullptr;
2139 }
Chris Bienemanad070d02014-09-17 20:55:46 +00002140
2141 // fputs(s,F) --> fwrite(s,1,strlen(s),F)
David Bolvansky1f343fa2018-05-22 20:27:36 +00002142 uint64_t Len = GetStringLength(CI->getArgOperand(0));
Chris Bienemanad070d02014-09-17 20:55:46 +00002143 if (!Len)
2144 return nullptr;
2145
2146 // Known to have no uses (see above).
Sanjay Pateld3112a52016-01-19 19:46:10 +00002147 return emitFWrite(
Chris Bienemanad070d02014-09-17 20:55:46 +00002148 CI->getArgOperand(0),
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002149 ConstantInt::get(DL.getIntPtrType(CI->getContext()), Len - 1),
Chris Bienemanad070d02014-09-17 20:55:46 +00002150 CI->getArgOperand(1), B, DL, TLI);
2151}
2152
David Bolvanskyca22d422018-05-16 11:39:52 +00002153Value *LibCallSimplifier::optimizeFPutc(CallInst *CI, IRBuilder<> &B) {
2154 optimizeErrorReporting(CI, B, 1);
2155
2156 if (isLocallyOpenedFile(CI->getArgOperand(1), CI, B, TLI))
2157 return emitFPutCUnlocked(CI->getArgOperand(0), CI->getArgOperand(1), B,
2158 TLI);
2159
2160 return nullptr;
2161}
2162
2163Value *LibCallSimplifier::optimizeFGetc(CallInst *CI, IRBuilder<> &B) {
2164 if (isLocallyOpenedFile(CI->getArgOperand(0), CI, B, TLI))
2165 return emitFGetCUnlocked(CI->getArgOperand(0), B, TLI);
2166
2167 return nullptr;
2168}
2169
2170Value *LibCallSimplifier::optimizeFGets(CallInst *CI, IRBuilder<> &B) {
2171 if (isLocallyOpenedFile(CI->getArgOperand(2), CI, B, TLI))
2172 return emitFGetSUnlocked(CI->getArgOperand(0), CI->getArgOperand(1),
2173 CI->getArgOperand(2), B, TLI);
2174
2175 return nullptr;
2176}
2177
2178Value *LibCallSimplifier::optimizeFRead(CallInst *CI, IRBuilder<> &B) {
2179 if (isLocallyOpenedFile(CI->getArgOperand(3), CI, B, TLI))
2180 return emitFReadUnlocked(CI->getArgOperand(0), CI->getArgOperand(1),
2181 CI->getArgOperand(2), CI->getArgOperand(3), B, DL,
2182 TLI);
2183
2184 return nullptr;
2185}
2186
Chris Bienemanad070d02014-09-17 20:55:46 +00002187Value *LibCallSimplifier::optimizePuts(CallInst *CI, IRBuilder<> &B) {
Chris Bienemanad070d02014-09-17 20:55:46 +00002188 // Check for a constant string.
2189 StringRef Str;
2190 if (!getConstantStringInfo(CI->getArgOperand(0), Str))
2191 return nullptr;
2192
2193 if (Str.empty() && CI->use_empty()) {
2194 // puts("") -> putchar('\n')
Sanjay Pateld3112a52016-01-19 19:46:10 +00002195 Value *Res = emitPutChar(B.getInt32('\n'), B, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +00002196 if (CI->use_empty() || !Res)
2197 return Res;
2198 return B.CreateIntCast(Res, CI->getType(), true);
2199 }
2200
2201 return nullptr;
2202}
2203
2204bool LibCallSimplifier::hasFloatVersion(StringRef FuncName) {
David L. Jonesd21529f2017-01-23 23:16:46 +00002205 LibFunc Func;
Meador Inge20255ef2013-03-12 00:08:29 +00002206 SmallString<20> FloatFuncName = FuncName;
2207 FloatFuncName += 'f';
2208 if (TLI->getLibFunc(FloatFuncName, Func))
2209 return TLI->has(Func);
2210 return false;
2211}
Meador Inge7fb2f732012-10-13 16:45:32 +00002212
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002213Value *LibCallSimplifier::optimizeStringMemoryLibCall(CallInst *CI,
2214 IRBuilder<> &Builder) {
David L. Jonesd21529f2017-01-23 23:16:46 +00002215 LibFunc Func;
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002216 Function *Callee = CI->getCalledFunction();
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002217 // Check for string/memory library functions.
Ahmed Bougachad765a822016-04-27 19:04:35 +00002218 if (TLI->getLibFunc(*Callee, Func) && TLI->has(Func)) {
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002219 // Make sure we never change the calling convention.
2220 assert((ignoreCallingConv(Func) ||
Sam Parker214f7bf2016-09-13 12:10:14 +00002221 isCallingConvCCompatible(CI)) &&
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002222 "Optimizing string/memory libcall would change the calling convention");
2223 switch (Func) {
David L. Jonesd21529f2017-01-23 23:16:46 +00002224 case LibFunc_strcat:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002225 return optimizeStrCat(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002226 case LibFunc_strncat:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002227 return optimizeStrNCat(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002228 case LibFunc_strchr:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002229 return optimizeStrChr(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002230 case LibFunc_strrchr:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002231 return optimizeStrRChr(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002232 case LibFunc_strcmp:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002233 return optimizeStrCmp(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002234 case LibFunc_strncmp:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002235 return optimizeStrNCmp(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002236 case LibFunc_strcpy:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002237 return optimizeStrCpy(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002238 case LibFunc_stpcpy:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002239 return optimizeStpCpy(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002240 case LibFunc_strncpy:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002241 return optimizeStrNCpy(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002242 case LibFunc_strlen:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002243 return optimizeStrLen(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002244 case LibFunc_strpbrk:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002245 return optimizeStrPBrk(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002246 case LibFunc_strtol:
2247 case LibFunc_strtod:
2248 case LibFunc_strtof:
2249 case LibFunc_strtoul:
2250 case LibFunc_strtoll:
2251 case LibFunc_strtold:
2252 case LibFunc_strtoull:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002253 return optimizeStrTo(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002254 case LibFunc_strspn:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002255 return optimizeStrSpn(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002256 case LibFunc_strcspn:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002257 return optimizeStrCSpn(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002258 case LibFunc_strstr:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002259 return optimizeStrStr(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002260 case LibFunc_memchr:
Benjamin Kramer691363e2015-03-21 15:36:21 +00002261 return optimizeMemChr(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002262 case LibFunc_memcmp:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002263 return optimizeMemCmp(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002264 case LibFunc_memcpy:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002265 return optimizeMemCpy(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002266 case LibFunc_memmove:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002267 return optimizeMemMove(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002268 case LibFunc_memset:
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002269 return optimizeMemSet(CI, Builder);
Sanjay Patelb2ab3f22018-04-18 14:21:31 +00002270 case LibFunc_realloc:
2271 return optimizeRealloc(CI, Builder);
Matthias Braun50ec0b52017-05-19 22:37:09 +00002272 case LibFunc_wcslen:
2273 return optimizeWcslen(CI, Builder);
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002274 default:
2275 break;
2276 }
2277 }
2278 return nullptr;
2279}
2280
Andrew Kaylor53a5fbb2017-08-14 21:15:13 +00002281Value *LibCallSimplifier::optimizeFloatingPointLibCall(CallInst *CI,
2282 LibFunc Func,
2283 IRBuilder<> &Builder) {
2284 // Don't optimize calls that require strict floating point semantics.
2285 if (CI->isStrictFP())
2286 return nullptr;
2287
2288 switch (Func) {
2289 case LibFunc_cosf:
2290 case LibFunc_cos:
2291 case LibFunc_cosl:
2292 return optimizeCos(CI, Builder);
2293 case LibFunc_sinpif:
2294 case LibFunc_sinpi:
2295 case LibFunc_cospif:
2296 case LibFunc_cospi:
2297 return optimizeSinCosPi(CI, Builder);
2298 case LibFunc_powf:
2299 case LibFunc_pow:
2300 case LibFunc_powl:
2301 return optimizePow(CI, Builder);
2302 case LibFunc_exp2l:
2303 case LibFunc_exp2:
2304 case LibFunc_exp2f:
2305 return optimizeExp2(CI, Builder);
2306 case LibFunc_fabsf:
2307 case LibFunc_fabs:
2308 case LibFunc_fabsl:
2309 return replaceUnaryCall(CI, Builder, Intrinsic::fabs);
2310 case LibFunc_sqrtf:
2311 case LibFunc_sqrt:
2312 case LibFunc_sqrtl:
2313 return optimizeSqrt(CI, Builder);
2314 case LibFunc_log:
2315 case LibFunc_log10:
2316 case LibFunc_log1p:
2317 case LibFunc_log2:
2318 case LibFunc_logb:
2319 return optimizeLog(CI, Builder);
2320 case LibFunc_tan:
2321 case LibFunc_tanf:
2322 case LibFunc_tanl:
2323 return optimizeTan(CI, Builder);
2324 case LibFunc_ceil:
2325 return replaceUnaryCall(CI, Builder, Intrinsic::ceil);
2326 case LibFunc_floor:
2327 return replaceUnaryCall(CI, Builder, Intrinsic::floor);
2328 case LibFunc_round:
2329 return replaceUnaryCall(CI, Builder, Intrinsic::round);
2330 case LibFunc_nearbyint:
2331 return replaceUnaryCall(CI, Builder, Intrinsic::nearbyint);
2332 case LibFunc_rint:
2333 return replaceUnaryCall(CI, Builder, Intrinsic::rint);
2334 case LibFunc_trunc:
2335 return replaceUnaryCall(CI, Builder, Intrinsic::trunc);
2336 case LibFunc_acos:
2337 case LibFunc_acosh:
2338 case LibFunc_asin:
2339 case LibFunc_asinh:
2340 case LibFunc_atan:
2341 case LibFunc_atanh:
2342 case LibFunc_cbrt:
2343 case LibFunc_cosh:
2344 case LibFunc_exp:
2345 case LibFunc_exp10:
2346 case LibFunc_expm1:
2347 case LibFunc_sin:
2348 case LibFunc_sinh:
2349 case LibFunc_tanh:
2350 if (UnsafeFPShrink && hasFloatVersion(CI->getCalledFunction()->getName()))
2351 return optimizeUnaryDoubleFP(CI, Builder, true);
2352 return nullptr;
2353 case LibFunc_copysign:
2354 if (hasFloatVersion(CI->getCalledFunction()->getName()))
2355 return optimizeBinaryDoubleFP(CI, Builder);
2356 return nullptr;
2357 case LibFunc_fminf:
2358 case LibFunc_fmin:
2359 case LibFunc_fminl:
2360 case LibFunc_fmaxf:
2361 case LibFunc_fmax:
2362 case LibFunc_fmaxl:
2363 return optimizeFMinFMax(CI, Builder);
Hal Finkel2ff24732017-12-16 01:26:25 +00002364 case LibFunc_cabs:
2365 case LibFunc_cabsf:
2366 case LibFunc_cabsl:
2367 return optimizeCAbs(CI, Builder);
Andrew Kaylor53a5fbb2017-08-14 21:15:13 +00002368 default:
2369 return nullptr;
2370 }
2371}
2372
Chris Bienemanad070d02014-09-17 20:55:46 +00002373Value *LibCallSimplifier::optimizeCall(CallInst *CI) {
Andrew Kaylor53a5fbb2017-08-14 21:15:13 +00002374 // TODO: Split out the code below that operates on FP calls so that
2375 // we can all non-FP calls with the StrictFP attribute to be
2376 // optimized.
Chris Bienemanad070d02014-09-17 20:55:46 +00002377 if (CI->isNoBuiltin())
2378 return nullptr;
Meador Inge4d2827c2012-11-11 05:11:20 +00002379
David L. Jonesd21529f2017-01-23 23:16:46 +00002380 LibFunc Func;
Meador Inge20255ef2013-03-12 00:08:29 +00002381 Function *Callee = CI->getCalledFunction();
David Majnemerb70e23c2016-01-06 05:01:34 +00002382
2383 SmallVector<OperandBundleDef, 2> OpBundles;
2384 CI->getOperandBundlesAsDefs(OpBundles);
2385 IRBuilder<> Builder(CI, /*FPMathTag=*/nullptr, OpBundles);
Sam Parker214f7bf2016-09-13 12:10:14 +00002386 bool isCallingConvC = isCallingConvCCompatible(CI);
Meador Inge20255ef2013-03-12 00:08:29 +00002387
Sanjay Pateld1f4f032016-01-19 18:38:52 +00002388 // Command-line parameter overrides instruction attribute.
Andrew Kaylor53a5fbb2017-08-14 21:15:13 +00002389 // This can't be moved to optimizeFloatingPointLibCall() because it may be
Sanjay Patel629c4112017-11-06 16:27:15 +00002390 // used by the intrinsic optimizations.
Sanjay Patela92fa442014-10-22 15:29:23 +00002391 if (EnableUnsafeFPShrink.getNumOccurrences() > 0)
2392 UnsafeFPShrink = EnableUnsafeFPShrink;
Sanjay Patel629c4112017-11-06 16:27:15 +00002393 else if (isa<FPMathOperator>(CI) && CI->isFast())
Davide Italianoa904e522015-10-29 02:58:44 +00002394 UnsafeFPShrink = true;
Sanjay Patela92fa442014-10-22 15:29:23 +00002395
Sanjay Patel848309d2014-10-23 21:52:45 +00002396 // First, check for intrinsics.
Meador Inge20255ef2013-03-12 00:08:29 +00002397 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(CI)) {
Chris Bienemanad070d02014-09-17 20:55:46 +00002398 if (!isCallingConvC)
2399 return nullptr;
Andrew Kaylor53a5fbb2017-08-14 21:15:13 +00002400 // The FP intrinsics have corresponding constrained versions so we don't
2401 // need to check for the StrictFP attribute here.
Meador Inge20255ef2013-03-12 00:08:29 +00002402 switch (II->getIntrinsicID()) {
2403 case Intrinsic::pow:
Chris Bienemanad070d02014-09-17 20:55:46 +00002404 return optimizePow(CI, Builder);
Meador Inge20255ef2013-03-12 00:08:29 +00002405 case Intrinsic::exp2:
Chris Bienemanad070d02014-09-17 20:55:46 +00002406 return optimizeExp2(CI, Builder);
Davide Italianob8b71332015-11-29 20:58:04 +00002407 case Intrinsic::log:
2408 return optimizeLog(CI, Builder);
Sanjay Patelc699a612014-10-16 18:48:17 +00002409 case Intrinsic::sqrt:
2410 return optimizeSqrt(CI, Builder);
Sanjay Patel980b2802016-01-26 16:17:24 +00002411 // TODO: Use foldMallocMemset() with memset intrinsic.
Meador Inge20255ef2013-03-12 00:08:29 +00002412 default:
Chris Bienemanad070d02014-09-17 20:55:46 +00002413 return nullptr;
Meador Inge20255ef2013-03-12 00:08:29 +00002414 }
2415 }
2416
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002417 // Also try to simplify calls to fortified library functions.
2418 if (Value *SimplifiedFortifiedCI = FortifiedSimplifier.optimizeCall(CI)) {
2419 // Try to further simplify the result.
Ahmed Bougacha71d7b182015-01-14 00:55:05 +00002420 CallInst *SimplifiedCI = dyn_cast<CallInst>(SimplifiedFortifiedCI);
Bruno Cardoso Lopesb491a2d2015-10-01 22:43:53 +00002421 if (SimplifiedCI && SimplifiedCI->getCalledFunction()) {
2422 // Use an IR Builder from SimplifiedCI if available instead of CI
2423 // to guarantee we reach all uses we might replace later on.
2424 IRBuilder<> TmpBuilder(SimplifiedCI);
2425 if (Value *V = optimizeStringMemoryLibCall(SimplifiedCI, TmpBuilder)) {
Ahmed Bougacha1ac93562015-01-27 21:52:16 +00002426 // If we were able to further simplify, remove the now redundant call.
2427 SimplifiedCI->replaceAllUsesWith(V);
2428 SimplifiedCI->eraseFromParent();
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002429 return V;
Ahmed Bougacha1ac93562015-01-27 21:52:16 +00002430 }
Bruno Cardoso Lopesb491a2d2015-10-01 22:43:53 +00002431 }
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002432 return SimplifiedFortifiedCI;
2433 }
2434
Meador Inge20255ef2013-03-12 00:08:29 +00002435 // Then check for known library functions.
Ahmed Bougachad765a822016-04-27 19:04:35 +00002436 if (TLI->getLibFunc(*Callee, Func) && TLI->has(Func)) {
Chris Bienemanad070d02014-09-17 20:55:46 +00002437 // We never change the calling convention.
2438 if (!ignoreCallingConv(Func) && !isCallingConvC)
2439 return nullptr;
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002440 if (Value *V = optimizeStringMemoryLibCall(CI, Builder))
2441 return V;
Andrew Kaylor53a5fbb2017-08-14 21:15:13 +00002442 if (Value *V = optimizeFloatingPointLibCall(CI, Func, Builder))
2443 return V;
Meador Inge20255ef2013-03-12 00:08:29 +00002444 switch (Func) {
David L. Jonesd21529f2017-01-23 23:16:46 +00002445 case LibFunc_ffs:
2446 case LibFunc_ffsl:
2447 case LibFunc_ffsll:
Chris Bienemanad070d02014-09-17 20:55:46 +00002448 return optimizeFFS(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002449 case LibFunc_fls:
2450 case LibFunc_flsl:
2451 case LibFunc_flsll:
Davide Italiano85ad36b2016-12-15 23:45:11 +00002452 return optimizeFls(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002453 case LibFunc_abs:
2454 case LibFunc_labs:
2455 case LibFunc_llabs:
Chris Bienemanad070d02014-09-17 20:55:46 +00002456 return optimizeAbs(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002457 case LibFunc_isdigit:
Chris Bienemanad070d02014-09-17 20:55:46 +00002458 return optimizeIsDigit(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002459 case LibFunc_isascii:
Chris Bienemanad070d02014-09-17 20:55:46 +00002460 return optimizeIsAscii(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002461 case LibFunc_toascii:
Chris Bienemanad070d02014-09-17 20:55:46 +00002462 return optimizeToAscii(CI, Builder);
David Bolvanskycb8ca5f32018-04-25 18:58:53 +00002463 case LibFunc_atoi:
2464 case LibFunc_atol:
2465 case LibFunc_atoll:
2466 return optimizeAtoi(CI, Builder);
2467 case LibFunc_strtol:
2468 case LibFunc_strtoll:
2469 return optimizeStrtol(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002470 case LibFunc_printf:
Chris Bienemanad070d02014-09-17 20:55:46 +00002471 return optimizePrintF(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002472 case LibFunc_sprintf:
Chris Bienemanad070d02014-09-17 20:55:46 +00002473 return optimizeSPrintF(CI, Builder);
David Bolvanskycd93c4e2018-05-11 17:50:49 +00002474 case LibFunc_snprintf:
2475 return optimizeSnPrintF(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002476 case LibFunc_fprintf:
Chris Bienemanad070d02014-09-17 20:55:46 +00002477 return optimizeFPrintF(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002478 case LibFunc_fwrite:
Chris Bienemanad070d02014-09-17 20:55:46 +00002479 return optimizeFWrite(CI, Builder);
David Bolvanskyca22d422018-05-16 11:39:52 +00002480 case LibFunc_fread:
2481 return optimizeFRead(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002482 case LibFunc_fputs:
Chris Bienemanad070d02014-09-17 20:55:46 +00002483 return optimizeFPuts(CI, Builder);
David Bolvanskyca22d422018-05-16 11:39:52 +00002484 case LibFunc_fgets:
2485 return optimizeFGets(CI, Builder);
2486 case LibFunc_fputc:
2487 return optimizeFPutc(CI, Builder);
2488 case LibFunc_fgetc:
2489 return optimizeFGetc(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002490 case LibFunc_puts:
Chris Bienemanad070d02014-09-17 20:55:46 +00002491 return optimizePuts(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002492 case LibFunc_perror:
Chris Bienemanad070d02014-09-17 20:55:46 +00002493 return optimizeErrorReporting(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002494 case LibFunc_vfprintf:
2495 case LibFunc_fiprintf:
Chris Bienemanad070d02014-09-17 20:55:46 +00002496 return optimizeErrorReporting(CI, Builder, 0);
Chris Bienemanad070d02014-09-17 20:55:46 +00002497 default:
2498 return nullptr;
2499 }
Meador Inge20255ef2013-03-12 00:08:29 +00002500 }
Craig Topperf40110f2014-04-25 05:29:35 +00002501 return nullptr;
Meador Ingedf796f82012-10-13 16:45:24 +00002502}
2503
Chandler Carruth92803822015-01-21 02:11:59 +00002504LibCallSimplifier::LibCallSimplifier(
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002505 const DataLayout &DL, const TargetLibraryInfo *TLI,
Adam Nemetea06e6e2017-07-26 19:03:18 +00002506 OptimizationRemarkEmitter &ORE,
Chandler Carruth92803822015-01-21 02:11:59 +00002507 function_ref<void(Instruction *, Value *)> Replacer)
Adam Nemetea06e6e2017-07-26 19:03:18 +00002508 : FortifiedSimplifier(TLI), DL(DL), TLI(TLI), ORE(ORE),
2509 UnsafeFPShrink(false), Replacer(Replacer) {}
Chandler Carruth92803822015-01-21 02:11:59 +00002510
2511void LibCallSimplifier::replaceAllUsesWith(Instruction *I, Value *With) {
2512 // Indirect through the replacer used in this instance.
2513 Replacer(I, With);
Meador Ingedf796f82012-10-13 16:45:24 +00002514}
2515
Meador Ingedfb08a22013-06-20 19:48:07 +00002516// TODO:
2517// Additional cases that we need to add to this file:
2518//
2519// cbrt:
2520// * cbrt(expN(X)) -> expN(x/3)
2521// * cbrt(sqrt(x)) -> pow(x,1/6)
David Majnemer3354fe42015-08-26 18:30:16 +00002522// * cbrt(cbrt(x)) -> pow(x,1/9)
Meador Ingedfb08a22013-06-20 19:48:07 +00002523//
2524// exp, expf, expl:
2525// * exp(log(x)) -> x
2526//
2527// log, logf, logl:
2528// * log(exp(x)) -> x
Meador Ingedfb08a22013-06-20 19:48:07 +00002529// * log(exp(y)) -> y*log(e)
Meador Ingedfb08a22013-06-20 19:48:07 +00002530// * log(exp10(y)) -> y*log(10)
2531// * log(sqrt(x)) -> 0.5*log(x)
Meador Ingedfb08a22013-06-20 19:48:07 +00002532//
Meador Ingedfb08a22013-06-20 19:48:07 +00002533// pow, powf, powl:
Meador Ingedfb08a22013-06-20 19:48:07 +00002534// * pow(sqrt(x),y) -> pow(x,y*0.5)
2535// * pow(pow(x,y),z)-> pow(x,y*z)
2536//
Meador Ingedfb08a22013-06-20 19:48:07 +00002537// signbit:
2538// * signbit(cnst) -> cnst'
2539// * signbit(nncst) -> 0 (if pstv is a non-negative constant)
2540//
2541// sqrt, sqrtf, sqrtl:
2542// * sqrt(expN(x)) -> expN(x*0.5)
2543// * sqrt(Nroot(x)) -> pow(x,1/(2*N))
2544// * sqrt(pow(x,y)) -> pow(|x|,y*0.5)
2545//
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002546
2547//===----------------------------------------------------------------------===//
2548// Fortified Library Call Optimizations
2549//===----------------------------------------------------------------------===//
2550
2551bool FortifiedLibCallSimplifier::isFortifiedCallFoldable(CallInst *CI,
2552 unsigned ObjSizeOp,
2553 unsigned SizeOp,
2554 bool isString) {
2555 if (CI->getArgOperand(ObjSizeOp) == CI->getArgOperand(SizeOp))
2556 return true;
2557 if (ConstantInt *ObjSizeCI =
2558 dyn_cast<ConstantInt>(CI->getArgOperand(ObjSizeOp))) {
Craig Topper79ab6432017-07-06 18:39:47 +00002559 if (ObjSizeCI->isMinusOne())
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002560 return true;
2561 // If the object size wasn't -1 (unknown), bail out if we were asked to.
2562 if (OnlyLowerUnknownSize)
2563 return false;
2564 if (isString) {
David Bolvansky1f343fa2018-05-22 20:27:36 +00002565 uint64_t Len = GetStringLength(CI->getArgOperand(SizeOp));
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002566 // If the length is 0 we don't know how long it is and so we can't
2567 // remove the check.
2568 if (Len == 0)
2569 return false;
2570 return ObjSizeCI->getZExtValue() >= Len;
2571 }
2572 if (ConstantInt *SizeCI = dyn_cast<ConstantInt>(CI->getArgOperand(SizeOp)))
2573 return ObjSizeCI->getZExtValue() >= SizeCI->getZExtValue();
2574 }
2575 return false;
2576}
2577
Sanjay Pateld707db92015-12-31 16:10:49 +00002578Value *FortifiedLibCallSimplifier::optimizeMemCpyChk(CallInst *CI,
2579 IRBuilder<> &B) {
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002580 if (isFortifiedCallFoldable(CI, 3, 2, false)) {
Daniel Neilson8acd8b02018-02-05 21:23:22 +00002581 B.CreateMemCpy(CI->getArgOperand(0), 1, CI->getArgOperand(1), 1,
2582 CI->getArgOperand(2));
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002583 return CI->getArgOperand(0);
2584 }
2585 return nullptr;
2586}
2587
Sanjay Pateld707db92015-12-31 16:10:49 +00002588Value *FortifiedLibCallSimplifier::optimizeMemMoveChk(CallInst *CI,
2589 IRBuilder<> &B) {
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002590 if (isFortifiedCallFoldable(CI, 3, 2, false)) {
Daniel Neilson8acd8b02018-02-05 21:23:22 +00002591 B.CreateMemMove(CI->getArgOperand(0), 1, CI->getArgOperand(1), 1,
2592 CI->getArgOperand(2));
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002593 return CI->getArgOperand(0);
2594 }
2595 return nullptr;
2596}
2597
Sanjay Pateld707db92015-12-31 16:10:49 +00002598Value *FortifiedLibCallSimplifier::optimizeMemSetChk(CallInst *CI,
2599 IRBuilder<> &B) {
Sanjay Patel980b2802016-01-26 16:17:24 +00002600 // TODO: Try foldMallocMemset() here.
2601
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002602 if (isFortifiedCallFoldable(CI, 3, 2, false)) {
2603 Value *Val = B.CreateIntCast(CI->getArgOperand(1), B.getInt8Ty(), false);
2604 B.CreateMemSet(CI->getArgOperand(0), Val, CI->getArgOperand(2), 1);
2605 return CI->getArgOperand(0);
2606 }
2607 return nullptr;
2608}
2609
Ahmed Bougacha1ac93562015-01-27 21:52:16 +00002610Value *FortifiedLibCallSimplifier::optimizeStrpCpyChk(CallInst *CI,
2611 IRBuilder<> &B,
David L. Jonesd21529f2017-01-23 23:16:46 +00002612 LibFunc Func) {
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002613 Function *Callee = CI->getCalledFunction();
2614 StringRef Name = Callee->getName();
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002615 const DataLayout &DL = CI->getModule()->getDataLayout();
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002616 Value *Dst = CI->getArgOperand(0), *Src = CI->getArgOperand(1),
2617 *ObjSize = CI->getArgOperand(2);
2618
2619 // __stpcpy_chk(x,x,...) -> x+strlen(x)
David L. Jonesd21529f2017-01-23 23:16:46 +00002620 if (Func == LibFunc_stpcpy_chk && !OnlyLowerUnknownSize && Dst == Src) {
Sanjay Pateld3112a52016-01-19 19:46:10 +00002621 Value *StrLen = emitStrLen(Src, B, DL, TLI);
David Blaikieaa41cd52015-04-03 21:33:42 +00002622 return StrLen ? B.CreateInBoundsGEP(B.getInt8Ty(), Dst, StrLen) : nullptr;
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002623 }
2624
2625 // If a) we don't have any length information, or b) we know this will
2626 // fit then just lower to a plain st[rp]cpy. Otherwise we'll keep our
2627 // st[rp]cpy_chk call which may fail at runtime if the size is too long.
2628 // TODO: It might be nice to get a maximum length out of the possible
2629 // string lengths for varying.
David Blaikie65fab6d2015-04-03 21:32:06 +00002630 if (isFortifiedCallFoldable(CI, 2, 1, true))
Sanjay Pateld3112a52016-01-19 19:46:10 +00002631 return emitStrCpy(Dst, Src, B, TLI, Name.substr(2, 6));
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002632
David Blaikie65fab6d2015-04-03 21:32:06 +00002633 if (OnlyLowerUnknownSize)
2634 return nullptr;
2635
2636 // Maybe we can stil fold __st[rp]cpy_chk to __memcpy_chk.
David Bolvansky1f343fa2018-05-22 20:27:36 +00002637 uint64_t Len = GetStringLength(Src);
David Blaikie65fab6d2015-04-03 21:32:06 +00002638 if (Len == 0)
2639 return nullptr;
2640
2641 Type *SizeTTy = DL.getIntPtrType(CI->getContext());
2642 Value *LenV = ConstantInt::get(SizeTTy, Len);
Sanjay Pateld3112a52016-01-19 19:46:10 +00002643 Value *Ret = emitMemCpyChk(Dst, Src, LenV, ObjSize, B, DL, TLI);
David Blaikie65fab6d2015-04-03 21:32:06 +00002644 // If the function was an __stpcpy_chk, and we were able to fold it into
2645 // a __memcpy_chk, we still need to return the correct end pointer.
David L. Jonesd21529f2017-01-23 23:16:46 +00002646 if (Ret && Func == LibFunc_stpcpy_chk)
David Blaikie65fab6d2015-04-03 21:32:06 +00002647 return B.CreateGEP(B.getInt8Ty(), Dst, ConstantInt::get(SizeTTy, Len - 1));
2648 return Ret;
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002649}
2650
Ahmed Bougacha1ac93562015-01-27 21:52:16 +00002651Value *FortifiedLibCallSimplifier::optimizeStrpNCpyChk(CallInst *CI,
2652 IRBuilder<> &B,
David L. Jonesd21529f2017-01-23 23:16:46 +00002653 LibFunc Func) {
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002654 Function *Callee = CI->getCalledFunction();
2655 StringRef Name = Callee->getName();
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002656 if (isFortifiedCallFoldable(CI, 3, 2, false)) {
Sanjay Pateld3112a52016-01-19 19:46:10 +00002657 Value *Ret = emitStrNCpy(CI->getArgOperand(0), CI->getArgOperand(1),
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002658 CI->getArgOperand(2), B, TLI, Name.substr(2, 7));
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002659 return Ret;
2660 }
2661 return nullptr;
2662}
2663
2664Value *FortifiedLibCallSimplifier::optimizeCall(CallInst *CI) {
Ahmed Bougacha408d0102015-04-01 00:45:09 +00002665 // FIXME: We shouldn't be changing "nobuiltin" or TLI unavailable calls here.
2666 // Some clang users checked for _chk libcall availability using:
2667 // __has_builtin(__builtin___memcpy_chk)
2668 // When compiling with -fno-builtin, this is always true.
2669 // When passing -ffreestanding/-mkernel, which both imply -fno-builtin, we
2670 // end up with fortified libcalls, which isn't acceptable in a freestanding
2671 // environment which only provides their non-fortified counterparts.
2672 //
2673 // Until we change clang and/or teach external users to check for availability
2674 // differently, disregard the "nobuiltin" attribute and TLI::has.
2675 //
2676 // PR23093.
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002677
David L. Jonesd21529f2017-01-23 23:16:46 +00002678 LibFunc Func;
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002679 Function *Callee = CI->getCalledFunction();
David Majnemerb70e23c2016-01-06 05:01:34 +00002680
2681 SmallVector<OperandBundleDef, 2> OpBundles;
2682 CI->getOperandBundlesAsDefs(OpBundles);
2683 IRBuilder<> Builder(CI, /*FPMathTag=*/nullptr, OpBundles);
Sam Parker214f7bf2016-09-13 12:10:14 +00002684 bool isCallingConvC = isCallingConvCCompatible(CI);
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002685
Ahmed Bougachad765a822016-04-27 19:04:35 +00002686 // First, check that this is a known library functions and that the prototype
2687 // is correct.
2688 if (!TLI->getLibFunc(*Callee, Func))
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002689 return nullptr;
2690
2691 // We never change the calling convention.
2692 if (!ignoreCallingConv(Func) && !isCallingConvC)
2693 return nullptr;
2694
2695 switch (Func) {
David L. Jonesd21529f2017-01-23 23:16:46 +00002696 case LibFunc_memcpy_chk:
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002697 return optimizeMemCpyChk(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002698 case LibFunc_memmove_chk:
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002699 return optimizeMemMoveChk(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002700 case LibFunc_memset_chk:
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002701 return optimizeMemSetChk(CI, Builder);
David L. Jonesd21529f2017-01-23 23:16:46 +00002702 case LibFunc_stpcpy_chk:
2703 case LibFunc_strcpy_chk:
Ahmed Bougacha1ac93562015-01-27 21:52:16 +00002704 return optimizeStrpCpyChk(CI, Builder, Func);
David L. Jonesd21529f2017-01-23 23:16:46 +00002705 case LibFunc_stpncpy_chk:
2706 case LibFunc_strncpy_chk:
Ahmed Bougacha1ac93562015-01-27 21:52:16 +00002707 return optimizeStrpNCpyChk(CI, Builder, Func);
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002708 default:
2709 break;
2710 }
2711 return nullptr;
2712}
2713
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002714FortifiedLibCallSimplifier::FortifiedLibCallSimplifier(
2715 const TargetLibraryInfo *TLI, bool OnlyLowerUnknownSize)
Sanjay Patel4b969352018-05-22 23:29:40 +00002716 : TLI(TLI), OnlyLowerUnknownSize(OnlyLowerUnknownSize) {}