blob: 76a28e13bafe29fcd974b2a4d3b28eb2132036f1 [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//
10// This is a utility pass used for testing the InstructionSimplify analysis.
11// The analysis is applied to every instruction, and if it simplifies then the
12// instruction is replaced by the simplification. If you are looking for a pass
13// that performs serious instruction folding, use the instcombine pass instead.
14//
15//===----------------------------------------------------------------------===//
16
17#include "llvm/Transforms/Utils/SimplifyLibCalls.h"
Meador Inge20255ef2013-03-12 00:08:29 +000018#include "llvm/ADT/SmallString.h"
Meador Ingedf796f82012-10-13 16:45:24 +000019#include "llvm/ADT/StringMap.h"
Bob Wilsond8d92d92013-11-03 06:48:38 +000020#include "llvm/ADT/Triple.h"
Meador Ingedf796f82012-10-13 16:45:24 +000021#include "llvm/Analysis/ValueTracking.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000022#include "llvm/IR/DataLayout.h"
Diego Novillo7f8af8b2014-05-22 14:19:46 +000023#include "llvm/IR/DiagnosticInfo.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000024#include "llvm/IR/Function.h"
25#include "llvm/IR/IRBuilder.h"
Meador Inge20255ef2013-03-12 00:08:29 +000026#include "llvm/IR/IntrinsicInst.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000027#include "llvm/IR/Intrinsics.h"
28#include "llvm/IR/LLVMContext.h"
29#include "llvm/IR/Module.h"
Sanjay Patelc699a612014-10-16 18:48:17 +000030#include "llvm/IR/PatternMatch.h"
Nadav Rotem464e8072013-02-27 05:53:43 +000031#include "llvm/Support/Allocator.h"
Hal Finkel66cd3f12013-11-17 02:06:35 +000032#include "llvm/Support/CommandLine.h"
Chandler Carruth62d42152015-01-15 02:16:27 +000033#include "llvm/Analysis/TargetLibraryInfo.h"
Meador Ingedf796f82012-10-13 16:45:24 +000034#include "llvm/Transforms/Utils/BuildLibCalls.h"
Chad Rosierdc655322015-08-28 18:30:18 +000035#include "llvm/Transforms/Utils/Local.h"
Meador Ingedf796f82012-10-13 16:45:24 +000036
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>
Chris Bienemanad070d02014-09-17 20:55:46 +000041 ColdErrorCalls("error-reporting-is-cold", cl::init(true), cl::Hidden,
42 cl::desc("Treat error-reporting calls as cold"));
Meador Ingedf796f82012-10-13 16:45:24 +000043
Sanjay Patela92fa442014-10-22 15:29:23 +000044static cl::opt<bool>
45 EnableUnsafeFPShrink("enable-double-float-shrink", cl::Hidden,
46 cl::init(false),
47 cl::desc("Enable unsafe double to float "
48 "shrinking for math lib calls"));
49
50
Meador Ingedf796f82012-10-13 16:45:24 +000051//===----------------------------------------------------------------------===//
Meador Inged589ac62012-10-31 03:33:06 +000052// Helper Functions
53//===----------------------------------------------------------------------===//
54
Chris Bienemanad070d02014-09-17 20:55:46 +000055static bool ignoreCallingConv(LibFunc::Func Func) {
56 switch (Func) {
57 case LibFunc::abs:
58 case LibFunc::labs:
59 case LibFunc::llabs:
60 case LibFunc::strlen:
61 return true;
62 default:
63 return false;
64 }
Chris Bienemancf93cbb2014-09-17 21:06:59 +000065 llvm_unreachable("All cases should be covered in the switch.");
Chris Bienemanad070d02014-09-17 20:55:46 +000066}
67
Meador Inged589ac62012-10-31 03:33:06 +000068/// isOnlyUsedInZeroEqualityComparison - Return true if it only matters that the
69/// value is equal or not-equal to zero.
70static bool isOnlyUsedInZeroEqualityComparison(Value *V) {
Chandler Carruthcdf47882014-03-09 03:16:01 +000071 for (User *U : V->users()) {
72 if (ICmpInst *IC = dyn_cast<ICmpInst>(U))
Meador Inged589ac62012-10-31 03:33:06 +000073 if (IC->isEquality())
74 if (Constant *C = dyn_cast<Constant>(IC->getOperand(1)))
75 if (C->isNullValue())
76 continue;
77 // Unknown instruction.
78 return false;
79 }
80 return true;
81}
82
Meador Inge56edbc92012-11-11 03:51:48 +000083/// isOnlyUsedInEqualityComparison - Return true if it is only used in equality
84/// comparisons with With.
85static bool isOnlyUsedInEqualityComparison(Value *V, Value *With) {
Chandler Carruthcdf47882014-03-09 03:16:01 +000086 for (User *U : V->users()) {
87 if (ICmpInst *IC = dyn_cast<ICmpInst>(U))
Meador Inge56edbc92012-11-11 03:51:48 +000088 if (IC->isEquality() && IC->getOperand(1) == With)
89 continue;
90 // Unknown instruction.
91 return false;
92 }
93 return true;
94}
95
Meador Inge08ca1152012-11-26 20:37:20 +000096static bool callHasFloatingPointArgument(const CallInst *CI) {
97 for (CallInst::const_op_iterator it = CI->op_begin(), e = CI->op_end();
98 it != e; ++it) {
99 if ((*it)->getType()->isFloatingPointTy())
100 return true;
101 }
102 return false;
103}
104
Benjamin Kramer2702caa2013-08-31 18:19:35 +0000105/// \brief Check whether the overloaded unary floating point function
Sanjay Patele24c60e2015-08-12 20:36:18 +0000106/// corresponding to \a Ty is available.
Benjamin Kramer2702caa2013-08-31 18:19:35 +0000107static bool hasUnaryFloatFn(const TargetLibraryInfo *TLI, Type *Ty,
108 LibFunc::Func DoubleFn, LibFunc::Func FloatFn,
109 LibFunc::Func LongDoubleFn) {
110 switch (Ty->getTypeID()) {
111 case Type::FloatTyID:
112 return TLI->has(FloatFn);
113 case Type::DoubleTyID:
114 return TLI->has(DoubleFn);
115 default:
116 return TLI->has(LongDoubleFn);
117 }
118}
119
Davide Italianoa904e522015-10-29 02:58:44 +0000120/// \brief Check whether we can use unsafe floating point math for
121/// the function passed as input.
122static bool canUseUnsafeFPMath(Function *F) {
123
124 // FIXME: For finer-grain optimization, we need intrinsics to have the same
125 // fast-math flag decorations that are applied to FP instructions. For now,
126 // we have to rely on the function-level unsafe-fp-math attribute to do this
127 // optimization because there's no other way to express that the sqrt can be
128 // reassociated.
129 if (F->hasFnAttribute("unsafe-fp-math")) {
130 Attribute Attr = F->getFnAttribute("unsafe-fp-math");
131 if (Attr.getValueAsString() == "true")
132 return true;
133 }
134 return false;
135}
136
Ahmed Bougachab7d8afb2015-01-12 17:18:19 +0000137/// \brief Returns whether \p F matches the signature expected for the
138/// string/memory copying library function \p Func.
139/// Acceptable functions are st[rp][n]?cpy, memove, memcpy, and memset.
140/// Their fortified (_chk) counterparts are also accepted.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000141static bool checkStringCopyLibFuncSignature(Function *F, LibFunc::Func Func) {
142 const DataLayout &DL = F->getParent()->getDataLayout();
Ahmed Bougachab7d8afb2015-01-12 17:18:19 +0000143 FunctionType *FT = F->getFunctionType();
144 LLVMContext &Context = F->getContext();
145 Type *PCharTy = Type::getInt8PtrTy(Context);
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000146 Type *SizeTTy = DL.getIntPtrType(Context);
Ahmed Bougachab7d8afb2015-01-12 17:18:19 +0000147 unsigned NumParams = FT->getNumParams();
148
149 // All string libfuncs return the same type as the first parameter.
150 if (FT->getReturnType() != FT->getParamType(0))
151 return false;
152
153 switch (Func) {
154 default:
155 llvm_unreachable("Can't check signature for non-string-copy libfunc.");
156 case LibFunc::stpncpy_chk:
157 case LibFunc::strncpy_chk:
158 --NumParams; // fallthrough
159 case LibFunc::stpncpy:
160 case LibFunc::strncpy: {
161 if (NumParams != 3 || FT->getParamType(0) != FT->getParamType(1) ||
162 FT->getParamType(0) != PCharTy || !FT->getParamType(2)->isIntegerTy())
163 return false;
164 break;
165 }
166 case LibFunc::strcpy_chk:
167 case LibFunc::stpcpy_chk:
168 --NumParams; // fallthrough
169 case LibFunc::stpcpy:
170 case LibFunc::strcpy: {
171 if (NumParams != 2 || FT->getParamType(0) != FT->getParamType(1) ||
172 FT->getParamType(0) != PCharTy)
173 return false;
174 break;
175 }
176 case LibFunc::memmove_chk:
177 case LibFunc::memcpy_chk:
178 --NumParams; // fallthrough
179 case LibFunc::memmove:
180 case LibFunc::memcpy: {
181 if (NumParams != 3 || !FT->getParamType(0)->isPointerTy() ||
182 !FT->getParamType(1)->isPointerTy() || FT->getParamType(2) != SizeTTy)
183 return false;
184 break;
185 }
186 case LibFunc::memset_chk:
187 --NumParams; // fallthrough
188 case LibFunc::memset: {
189 if (NumParams != 3 || !FT->getParamType(0)->isPointerTy() ||
190 !FT->getParamType(1)->isIntegerTy() || FT->getParamType(2) != SizeTTy)
191 return false;
192 break;
193 }
194 }
195 // If this is a fortified libcall, the last parameter is a size_t.
196 if (NumParams == FT->getNumParams() - 1)
197 return FT->getParamType(FT->getNumParams() - 1) == SizeTTy;
198 return true;
199}
200
Meador Inged589ac62012-10-31 03:33:06 +0000201//===----------------------------------------------------------------------===//
Meador Inge7fb2f732012-10-13 16:45:32 +0000202// String and Memory Library Call Optimizations
203//===----------------------------------------------------------------------===//
204
Chris Bienemanad070d02014-09-17 20:55:46 +0000205Value *LibCallSimplifier::optimizeStrCat(CallInst *CI, IRBuilder<> &B) {
206 Function *Callee = CI->getCalledFunction();
207 // Verify the "strcat" function prototype.
208 FunctionType *FT = Callee->getFunctionType();
209 if (FT->getNumParams() != 2||
210 FT->getReturnType() != B.getInt8PtrTy() ||
211 FT->getParamType(0) != FT->getReturnType() ||
212 FT->getParamType(1) != FT->getReturnType())
213 return nullptr;
214
215 // Extract some information from the instruction
216 Value *Dst = CI->getArgOperand(0);
217 Value *Src = CI->getArgOperand(1);
218
219 // See if we can get the length of the input string.
220 uint64_t Len = GetStringLength(Src);
221 if (Len == 0)
222 return nullptr;
223 --Len; // Unbias length.
224
225 // Handle the simple, do-nothing case: strcat(x, "") -> x
226 if (Len == 0)
227 return Dst;
228
Chris Bienemanad070d02014-09-17 20:55:46 +0000229 return emitStrLenMemCpy(Src, Dst, Len, B);
230}
231
232Value *LibCallSimplifier::emitStrLenMemCpy(Value *Src, Value *Dst, uint64_t Len,
233 IRBuilder<> &B) {
234 // We need to find the end of the destination string. That's where the
235 // memory is to be moved to. We just generate a call to strlen.
236 Value *DstLen = EmitStrLen(Dst, B, DL, TLI);
237 if (!DstLen)
238 return nullptr;
239
240 // Now that we have the destination's length, we must index into the
241 // destination's pointer to get the actual memcpy destination (end of
242 // the string .. we're concatenating).
David Blaikie3909da72015-03-30 20:42:56 +0000243 Value *CpyDst = B.CreateGEP(B.getInt8Ty(), Dst, DstLen, "endptr");
Chris Bienemanad070d02014-09-17 20:55:46 +0000244
245 // We have enough information to now generate the memcpy call to do the
246 // concatenation for us. Make a memcpy to copy the nul byte with align = 1.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000247 B.CreateMemCpy(CpyDst, Src,
248 ConstantInt::get(DL.getIntPtrType(Src->getContext()), Len + 1),
249 1);
Chris Bienemanad070d02014-09-17 20:55:46 +0000250 return Dst;
251}
252
253Value *LibCallSimplifier::optimizeStrNCat(CallInst *CI, IRBuilder<> &B) {
254 Function *Callee = CI->getCalledFunction();
255 // Verify the "strncat" function prototype.
256 FunctionType *FT = Callee->getFunctionType();
257 if (FT->getNumParams() != 3 || FT->getReturnType() != B.getInt8PtrTy() ||
258 FT->getParamType(0) != FT->getReturnType() ||
259 FT->getParamType(1) != FT->getReturnType() ||
260 !FT->getParamType(2)->isIntegerTy())
261 return nullptr;
262
263 // Extract some information from the instruction
264 Value *Dst = CI->getArgOperand(0);
265 Value *Src = CI->getArgOperand(1);
266 uint64_t Len;
267
268 // We don't do anything if length is not constant
269 if (ConstantInt *LengthArg = dyn_cast<ConstantInt>(CI->getArgOperand(2)))
270 Len = LengthArg->getZExtValue();
271 else
272 return nullptr;
273
274 // See if we can get the length of the input string.
275 uint64_t SrcLen = GetStringLength(Src);
276 if (SrcLen == 0)
277 return nullptr;
278 --SrcLen; // Unbias length.
279
280 // Handle the simple, do-nothing cases:
281 // strncat(x, "", c) -> x
282 // strncat(x, c, 0) -> x
283 if (SrcLen == 0 || Len == 0)
284 return Dst;
285
Chris Bienemanad070d02014-09-17 20:55:46 +0000286 // We don't optimize this case
287 if (Len < SrcLen)
288 return nullptr;
289
290 // strncat(x, s, c) -> strcat(x, s)
291 // s is constant so the strcat can be optimized further
292 return emitStrLenMemCpy(Src, Dst, SrcLen, B);
293}
294
295Value *LibCallSimplifier::optimizeStrChr(CallInst *CI, IRBuilder<> &B) {
296 Function *Callee = CI->getCalledFunction();
297 // Verify the "strchr" function prototype.
298 FunctionType *FT = Callee->getFunctionType();
299 if (FT->getNumParams() != 2 || FT->getReturnType() != B.getInt8PtrTy() ||
300 FT->getParamType(0) != FT->getReturnType() ||
301 !FT->getParamType(1)->isIntegerTy(32))
302 return nullptr;
303
304 Value *SrcStr = CI->getArgOperand(0);
305
306 // If the second operand is non-constant, see if we can compute the length
307 // of the input string and turn this into memchr.
308 ConstantInt *CharC = dyn_cast<ConstantInt>(CI->getArgOperand(1));
309 if (!CharC) {
Chris Bienemanad070d02014-09-17 20:55:46 +0000310 uint64_t Len = GetStringLength(SrcStr);
311 if (Len == 0 || !FT->getParamType(1)->isIntegerTy(32)) // memchr needs i32.
312 return nullptr;
Meador Inge7fb2f732012-10-13 16:45:32 +0000313
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000314 return EmitMemChr(SrcStr, CI->getArgOperand(1), // include nul.
315 ConstantInt::get(DL.getIntPtrType(CI->getContext()), Len),
316 B, DL, TLI);
Meador Inge7fb2f732012-10-13 16:45:32 +0000317 }
318
Chris Bienemanad070d02014-09-17 20:55:46 +0000319 // Otherwise, the character is a constant, see if the first argument is
320 // a string literal. If so, we can constant fold.
321 StringRef Str;
322 if (!getConstantStringInfo(SrcStr, Str)) {
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000323 if (CharC->isZero()) // strchr(p, 0) -> p + strlen(p)
David Blaikie3909da72015-03-30 20:42:56 +0000324 return B.CreateGEP(B.getInt8Ty(), SrcStr, EmitStrLen(SrcStr, B, DL, TLI), "strchr");
Chris Bienemanad070d02014-09-17 20:55:46 +0000325 return nullptr;
326 }
327
328 // Compute the offset, make sure to handle the case when we're searching for
329 // zero (a weird way to spell strlen).
330 size_t I = (0xFF & CharC->getSExtValue()) == 0
331 ? Str.size()
332 : Str.find(CharC->getSExtValue());
333 if (I == StringRef::npos) // Didn't find the char. strchr returns null.
334 return Constant::getNullValue(CI->getType());
335
336 // strchr(s+n,c) -> gep(s+n+i,c)
David Blaikie3909da72015-03-30 20:42:56 +0000337 return B.CreateGEP(B.getInt8Ty(), SrcStr, B.getInt64(I), "strchr");
Chris Bienemanad070d02014-09-17 20:55:46 +0000338}
339
340Value *LibCallSimplifier::optimizeStrRChr(CallInst *CI, IRBuilder<> &B) {
341 Function *Callee = CI->getCalledFunction();
342 // Verify the "strrchr" function prototype.
343 FunctionType *FT = Callee->getFunctionType();
344 if (FT->getNumParams() != 2 || FT->getReturnType() != B.getInt8PtrTy() ||
345 FT->getParamType(0) != FT->getReturnType() ||
346 !FT->getParamType(1)->isIntegerTy(32))
347 return nullptr;
348
349 Value *SrcStr = CI->getArgOperand(0);
350 ConstantInt *CharC = dyn_cast<ConstantInt>(CI->getArgOperand(1));
351
352 // Cannot fold anything if we're not looking for a constant.
353 if (!CharC)
354 return nullptr;
355
356 StringRef Str;
357 if (!getConstantStringInfo(SrcStr, Str)) {
358 // strrchr(s, 0) -> strchr(s, 0)
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000359 if (CharC->isZero())
360 return EmitStrChr(SrcStr, '\0', B, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +0000361 return nullptr;
362 }
363
364 // Compute the offset.
365 size_t I = (0xFF & CharC->getSExtValue()) == 0
366 ? Str.size()
367 : Str.rfind(CharC->getSExtValue());
368 if (I == StringRef::npos) // Didn't find the char. Return null.
369 return Constant::getNullValue(CI->getType());
370
371 // strrchr(s+n,c) -> gep(s+n+i,c)
David Blaikie3909da72015-03-30 20:42:56 +0000372 return B.CreateGEP(B.getInt8Ty(), SrcStr, B.getInt64(I), "strrchr");
Chris Bienemanad070d02014-09-17 20:55:46 +0000373}
374
375Value *LibCallSimplifier::optimizeStrCmp(CallInst *CI, IRBuilder<> &B) {
376 Function *Callee = CI->getCalledFunction();
377 // Verify the "strcmp" function prototype.
378 FunctionType *FT = Callee->getFunctionType();
379 if (FT->getNumParams() != 2 || !FT->getReturnType()->isIntegerTy(32) ||
380 FT->getParamType(0) != FT->getParamType(1) ||
381 FT->getParamType(0) != B.getInt8PtrTy())
382 return nullptr;
383
384 Value *Str1P = CI->getArgOperand(0), *Str2P = CI->getArgOperand(1);
385 if (Str1P == Str2P) // strcmp(x,x) -> 0
386 return ConstantInt::get(CI->getType(), 0);
387
388 StringRef Str1, Str2;
389 bool HasStr1 = getConstantStringInfo(Str1P, Str1);
390 bool HasStr2 = getConstantStringInfo(Str2P, Str2);
391
392 // strcmp(x, y) -> cnst (if both x and y are constant strings)
393 if (HasStr1 && HasStr2)
394 return ConstantInt::get(CI->getType(), Str1.compare(Str2));
395
396 if (HasStr1 && Str1.empty()) // strcmp("", x) -> -*x
397 return B.CreateNeg(
398 B.CreateZExt(B.CreateLoad(Str2P, "strcmpload"), CI->getType()));
399
400 if (HasStr2 && Str2.empty()) // strcmp(x,"") -> *x
401 return B.CreateZExt(B.CreateLoad(Str1P, "strcmpload"), CI->getType());
402
403 // strcmp(P, "x") -> memcmp(P, "x", 2)
404 uint64_t Len1 = GetStringLength(Str1P);
405 uint64_t Len2 = GetStringLength(Str2P);
406 if (Len1 && Len2) {
Chris Bienemanad070d02014-09-17 20:55:46 +0000407 return EmitMemCmp(Str1P, Str2P,
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000408 ConstantInt::get(DL.getIntPtrType(CI->getContext()),
Chris Bienemanad070d02014-09-17 20:55:46 +0000409 std::min(Len1, Len2)),
410 B, DL, TLI);
411 }
Meador Inge7fb2f732012-10-13 16:45:32 +0000412
Chris Bienemanad070d02014-09-17 20:55:46 +0000413 return nullptr;
414}
415
416Value *LibCallSimplifier::optimizeStrNCmp(CallInst *CI, IRBuilder<> &B) {
417 Function *Callee = CI->getCalledFunction();
418 // Verify the "strncmp" function prototype.
419 FunctionType *FT = Callee->getFunctionType();
420 if (FT->getNumParams() != 3 || !FT->getReturnType()->isIntegerTy(32) ||
421 FT->getParamType(0) != FT->getParamType(1) ||
422 FT->getParamType(0) != B.getInt8PtrTy() ||
423 !FT->getParamType(2)->isIntegerTy())
424 return nullptr;
425
426 Value *Str1P = CI->getArgOperand(0), *Str2P = CI->getArgOperand(1);
427 if (Str1P == Str2P) // strncmp(x,x,n) -> 0
428 return ConstantInt::get(CI->getType(), 0);
429
430 // Get the length argument if it is constant.
431 uint64_t Length;
432 if (ConstantInt *LengthArg = dyn_cast<ConstantInt>(CI->getArgOperand(2)))
433 Length = LengthArg->getZExtValue();
434 else
435 return nullptr;
436
437 if (Length == 0) // strncmp(x,y,0) -> 0
438 return ConstantInt::get(CI->getType(), 0);
439
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000440 if (Length == 1) // strncmp(x,y,1) -> memcmp(x,y,1)
Chris Bienemanad070d02014-09-17 20:55:46 +0000441 return EmitMemCmp(Str1P, Str2P, CI->getArgOperand(2), B, DL, TLI);
442
443 StringRef Str1, Str2;
444 bool HasStr1 = getConstantStringInfo(Str1P, Str1);
445 bool HasStr2 = getConstantStringInfo(Str2P, Str2);
446
447 // strncmp(x, y) -> cnst (if both x and y are constant strings)
448 if (HasStr1 && HasStr2) {
449 StringRef SubStr1 = Str1.substr(0, Length);
450 StringRef SubStr2 = Str2.substr(0, Length);
451 return ConstantInt::get(CI->getType(), SubStr1.compare(SubStr2));
452 }
453
454 if (HasStr1 && Str1.empty()) // strncmp("", x, n) -> -*x
455 return B.CreateNeg(
456 B.CreateZExt(B.CreateLoad(Str2P, "strcmpload"), CI->getType()));
457
458 if (HasStr2 && Str2.empty()) // strncmp(x, "", n) -> *x
459 return B.CreateZExt(B.CreateLoad(Str1P, "strcmpload"), CI->getType());
460
461 return nullptr;
462}
463
464Value *LibCallSimplifier::optimizeStrCpy(CallInst *CI, IRBuilder<> &B) {
465 Function *Callee = CI->getCalledFunction();
Ahmed Bougachab7d8afb2015-01-12 17:18:19 +0000466
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000467 if (!checkStringCopyLibFuncSignature(Callee, LibFunc::strcpy))
Chris Bienemanad070d02014-09-17 20:55:46 +0000468 return nullptr;
469
470 Value *Dst = CI->getArgOperand(0), *Src = CI->getArgOperand(1);
471 if (Dst == Src) // strcpy(x,x) -> x
472 return Src;
473
Chris Bienemanad070d02014-09-17 20:55:46 +0000474 // See if we can get the length of the input string.
475 uint64_t Len = GetStringLength(Src);
476 if (Len == 0)
477 return nullptr;
478
479 // We have enough information to now generate the memcpy call to do the
480 // copy for us. Make a memcpy to copy the nul byte with align = 1.
481 B.CreateMemCpy(Dst, Src,
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000482 ConstantInt::get(DL.getIntPtrType(CI->getContext()), Len), 1);
Chris Bienemanad070d02014-09-17 20:55:46 +0000483 return Dst;
484}
485
486Value *LibCallSimplifier::optimizeStpCpy(CallInst *CI, IRBuilder<> &B) {
487 Function *Callee = CI->getCalledFunction();
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000488 if (!checkStringCopyLibFuncSignature(Callee, LibFunc::stpcpy))
Chris Bienemanad070d02014-09-17 20:55:46 +0000489 return nullptr;
490
491 Value *Dst = CI->getArgOperand(0), *Src = CI->getArgOperand(1);
492 if (Dst == Src) { // stpcpy(x,x) -> x+strlen(x)
493 Value *StrLen = EmitStrLen(Src, B, DL, TLI);
David Blaikieaa41cd52015-04-03 21:33:42 +0000494 return StrLen ? B.CreateInBoundsGEP(B.getInt8Ty(), Dst, StrLen) : nullptr;
Chris Bienemanad070d02014-09-17 20:55:46 +0000495 }
496
497 // See if we can get the length of the input string.
498 uint64_t Len = GetStringLength(Src);
499 if (Len == 0)
500 return nullptr;
501
Davide Italianob7487e62015-11-02 23:07:14 +0000502 Type *PT = Callee->getFunctionType()->getParamType(0);
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000503 Value *LenV = ConstantInt::get(DL.getIntPtrType(PT), Len);
Chris Bienemanad070d02014-09-17 20:55:46 +0000504 Value *DstEnd =
David Blaikie3909da72015-03-30 20:42:56 +0000505 B.CreateGEP(B.getInt8Ty(), Dst, ConstantInt::get(DL.getIntPtrType(PT), Len - 1));
Chris Bienemanad070d02014-09-17 20:55:46 +0000506
507 // We have enough information to now generate the memcpy call to do the
508 // copy for us. Make a memcpy to copy the nul byte with align = 1.
509 B.CreateMemCpy(Dst, Src, LenV, 1);
510 return DstEnd;
511}
512
513Value *LibCallSimplifier::optimizeStrNCpy(CallInst *CI, IRBuilder<> &B) {
514 Function *Callee = CI->getCalledFunction();
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000515 if (!checkStringCopyLibFuncSignature(Callee, LibFunc::strncpy))
Chris Bienemanad070d02014-09-17 20:55:46 +0000516 return nullptr;
517
518 Value *Dst = CI->getArgOperand(0);
519 Value *Src = CI->getArgOperand(1);
520 Value *LenOp = CI->getArgOperand(2);
521
522 // See if we can get the length of the input string.
523 uint64_t SrcLen = GetStringLength(Src);
524 if (SrcLen == 0)
525 return nullptr;
526 --SrcLen;
527
528 if (SrcLen == 0) {
529 // strncpy(x, "", y) -> memset(x, '\0', y, 1)
530 B.CreateMemSet(Dst, B.getInt8('\0'), LenOp, 1);
Meador Inge7fb2f732012-10-13 16:45:32 +0000531 return Dst;
532 }
Meador Inge7fb2f732012-10-13 16:45:32 +0000533
Chris Bienemanad070d02014-09-17 20:55:46 +0000534 uint64_t Len;
535 if (ConstantInt *LengthArg = dyn_cast<ConstantInt>(LenOp))
536 Len = LengthArg->getZExtValue();
537 else
538 return nullptr;
Meador Inge7fb2f732012-10-13 16:45:32 +0000539
Chris Bienemanad070d02014-09-17 20:55:46 +0000540 if (Len == 0)
541 return Dst; // strncpy(x, y, 0) -> x
Meador Inge7fb2f732012-10-13 16:45:32 +0000542
Chris Bienemanad070d02014-09-17 20:55:46 +0000543 // Let strncpy handle the zero padding
544 if (Len > SrcLen + 1)
545 return nullptr;
Meador Inge7fb2f732012-10-13 16:45:32 +0000546
Davide Italianob7487e62015-11-02 23:07:14 +0000547 Type *PT = Callee->getFunctionType()->getParamType(0);
Chris Bienemanad070d02014-09-17 20:55:46 +0000548 // strncpy(x, s, c) -> memcpy(x, s, c, 1) [s and c are constant]
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000549 B.CreateMemCpy(Dst, Src, ConstantInt::get(DL.getIntPtrType(PT), Len), 1);
Meador Inge7fb2f732012-10-13 16:45:32 +0000550
Chris Bienemanad070d02014-09-17 20:55:46 +0000551 return Dst;
552}
Meador Inge7fb2f732012-10-13 16:45:32 +0000553
Chris Bienemanad070d02014-09-17 20:55:46 +0000554Value *LibCallSimplifier::optimizeStrLen(CallInst *CI, IRBuilder<> &B) {
555 Function *Callee = CI->getCalledFunction();
556 FunctionType *FT = Callee->getFunctionType();
557 if (FT->getNumParams() != 1 || FT->getParamType(0) != B.getInt8PtrTy() ||
558 !FT->getReturnType()->isIntegerTy())
559 return nullptr;
Meador Inge7fb2f732012-10-13 16:45:32 +0000560
Chris Bienemanad070d02014-09-17 20:55:46 +0000561 Value *Src = CI->getArgOperand(0);
562
563 // Constant folding: strlen("xyz") -> 3
564 if (uint64_t Len = GetStringLength(Src))
565 return ConstantInt::get(CI->getType(), Len - 1);
566
567 // strlen(x?"foo":"bars") --> x ? 3 : 4
568 if (SelectInst *SI = dyn_cast<SelectInst>(Src)) {
569 uint64_t LenTrue = GetStringLength(SI->getTrueValue());
570 uint64_t LenFalse = GetStringLength(SI->getFalseValue());
571 if (LenTrue && LenFalse) {
572 Function *Caller = CI->getParent()->getParent();
573 emitOptimizationRemark(CI->getContext(), "simplify-libcalls", *Caller,
574 SI->getDebugLoc(),
575 "folded strlen(select) to select of constants");
576 return B.CreateSelect(SI->getCondition(),
577 ConstantInt::get(CI->getType(), LenTrue - 1),
578 ConstantInt::get(CI->getType(), LenFalse - 1));
579 }
Meador Inge7fb2f732012-10-13 16:45:32 +0000580 }
Meador Inge7fb2f732012-10-13 16:45:32 +0000581
Chris Bienemanad070d02014-09-17 20:55:46 +0000582 // strlen(x) != 0 --> *x != 0
583 // strlen(x) == 0 --> *x == 0
584 if (isOnlyUsedInZeroEqualityComparison(CI))
585 return B.CreateZExt(B.CreateLoad(Src, "strlenfirst"), CI->getType());
Meador Inge17418502012-10-13 16:45:37 +0000586
Chris Bienemanad070d02014-09-17 20:55:46 +0000587 return nullptr;
588}
Meador Inge17418502012-10-13 16:45:37 +0000589
Chris Bienemanad070d02014-09-17 20:55:46 +0000590Value *LibCallSimplifier::optimizeStrPBrk(CallInst *CI, IRBuilder<> &B) {
591 Function *Callee = CI->getCalledFunction();
592 FunctionType *FT = Callee->getFunctionType();
593 if (FT->getNumParams() != 2 || FT->getParamType(0) != B.getInt8PtrTy() ||
594 FT->getParamType(1) != FT->getParamType(0) ||
595 FT->getReturnType() != FT->getParamType(0))
596 return nullptr;
Meador Inge17418502012-10-13 16:45:37 +0000597
Chris Bienemanad070d02014-09-17 20:55:46 +0000598 StringRef S1, S2;
599 bool HasS1 = getConstantStringInfo(CI->getArgOperand(0), S1);
600 bool HasS2 = getConstantStringInfo(CI->getArgOperand(1), S2);
Meador Inge17418502012-10-13 16:45:37 +0000601
Reid Kleckner971c3ea2014-11-13 22:55:19 +0000602 // strpbrk(s, "") -> nullptr
603 // strpbrk("", s) -> nullptr
Chris Bienemanad070d02014-09-17 20:55:46 +0000604 if ((HasS1 && S1.empty()) || (HasS2 && S2.empty()))
605 return Constant::getNullValue(CI->getType());
Meador Inge17418502012-10-13 16:45:37 +0000606
Chris Bienemanad070d02014-09-17 20:55:46 +0000607 // Constant folding.
608 if (HasS1 && HasS2) {
609 size_t I = S1.find_first_of(S2);
610 if (I == StringRef::npos) // No match.
Meador Inge17418502012-10-13 16:45:37 +0000611 return Constant::getNullValue(CI->getType());
612
David Blaikie3909da72015-03-30 20:42:56 +0000613 return B.CreateGEP(B.getInt8Ty(), CI->getArgOperand(0), B.getInt64(I), "strpbrk");
Meador Inge17418502012-10-13 16:45:37 +0000614 }
Meador Inge17418502012-10-13 16:45:37 +0000615
Chris Bienemanad070d02014-09-17 20:55:46 +0000616 // strpbrk(s, "a") -> strchr(s, 'a')
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000617 if (HasS2 && S2.size() == 1)
618 return EmitStrChr(CI->getArgOperand(0), S2[0], B, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +0000619
620 return nullptr;
621}
622
623Value *LibCallSimplifier::optimizeStrTo(CallInst *CI, IRBuilder<> &B) {
624 Function *Callee = CI->getCalledFunction();
625 FunctionType *FT = Callee->getFunctionType();
626 if ((FT->getNumParams() != 2 && FT->getNumParams() != 3) ||
627 !FT->getParamType(0)->isPointerTy() ||
628 !FT->getParamType(1)->isPointerTy())
629 return nullptr;
630
631 Value *EndPtr = CI->getArgOperand(1);
632 if (isa<ConstantPointerNull>(EndPtr)) {
633 // With a null EndPtr, this function won't capture the main argument.
634 // It would be readonly too, except that it still may write to errno.
635 CI->addAttribute(1, Attribute::NoCapture);
636 }
637
638 return nullptr;
639}
640
641Value *LibCallSimplifier::optimizeStrSpn(CallInst *CI, IRBuilder<> &B) {
642 Function *Callee = CI->getCalledFunction();
643 FunctionType *FT = Callee->getFunctionType();
644 if (FT->getNumParams() != 2 || FT->getParamType(0) != B.getInt8PtrTy() ||
645 FT->getParamType(1) != FT->getParamType(0) ||
646 !FT->getReturnType()->isIntegerTy())
647 return nullptr;
648
649 StringRef S1, S2;
650 bool HasS1 = getConstantStringInfo(CI->getArgOperand(0), S1);
651 bool HasS2 = getConstantStringInfo(CI->getArgOperand(1), S2);
652
653 // strspn(s, "") -> 0
654 // strspn("", s) -> 0
655 if ((HasS1 && S1.empty()) || (HasS2 && S2.empty()))
656 return Constant::getNullValue(CI->getType());
657
658 // Constant folding.
659 if (HasS1 && HasS2) {
660 size_t Pos = S1.find_first_not_of(S2);
661 if (Pos == StringRef::npos)
662 Pos = S1.size();
663 return ConstantInt::get(CI->getType(), Pos);
664 }
665
666 return nullptr;
667}
668
669Value *LibCallSimplifier::optimizeStrCSpn(CallInst *CI, IRBuilder<> &B) {
670 Function *Callee = CI->getCalledFunction();
671 FunctionType *FT = Callee->getFunctionType();
672 if (FT->getNumParams() != 2 || FT->getParamType(0) != B.getInt8PtrTy() ||
673 FT->getParamType(1) != FT->getParamType(0) ||
674 !FT->getReturnType()->isIntegerTy())
675 return nullptr;
676
677 StringRef S1, S2;
678 bool HasS1 = getConstantStringInfo(CI->getArgOperand(0), S1);
679 bool HasS2 = getConstantStringInfo(CI->getArgOperand(1), S2);
680
681 // strcspn("", s) -> 0
682 if (HasS1 && S1.empty())
683 return Constant::getNullValue(CI->getType());
684
685 // Constant folding.
686 if (HasS1 && HasS2) {
687 size_t Pos = S1.find_first_of(S2);
688 if (Pos == StringRef::npos)
689 Pos = S1.size();
690 return ConstantInt::get(CI->getType(), Pos);
691 }
692
693 // strcspn(s, "") -> strlen(s)
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000694 if (HasS2 && S2.empty())
Chris Bienemanad070d02014-09-17 20:55:46 +0000695 return EmitStrLen(CI->getArgOperand(0), B, DL, TLI);
696
697 return nullptr;
698}
699
700Value *LibCallSimplifier::optimizeStrStr(CallInst *CI, IRBuilder<> &B) {
701 Function *Callee = CI->getCalledFunction();
702 FunctionType *FT = Callee->getFunctionType();
703 if (FT->getNumParams() != 2 || !FT->getParamType(0)->isPointerTy() ||
704 !FT->getParamType(1)->isPointerTy() ||
705 !FT->getReturnType()->isPointerTy())
706 return nullptr;
707
708 // fold strstr(x, x) -> x.
709 if (CI->getArgOperand(0) == CI->getArgOperand(1))
710 return B.CreateBitCast(CI->getArgOperand(0), CI->getType());
711
712 // fold strstr(a, b) == a -> strncmp(a, b, strlen(b)) == 0
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000713 if (isOnlyUsedInEqualityComparison(CI, CI->getArgOperand(0))) {
Chris Bienemanad070d02014-09-17 20:55:46 +0000714 Value *StrLen = EmitStrLen(CI->getArgOperand(1), B, DL, TLI);
715 if (!StrLen)
Craig Topperf40110f2014-04-25 05:29:35 +0000716 return nullptr;
Chris Bienemanad070d02014-09-17 20:55:46 +0000717 Value *StrNCmp = EmitStrNCmp(CI->getArgOperand(0), CI->getArgOperand(1),
718 StrLen, B, DL, TLI);
719 if (!StrNCmp)
Craig Topperf40110f2014-04-25 05:29:35 +0000720 return nullptr;
Chris Bienemanad070d02014-09-17 20:55:46 +0000721 for (auto UI = CI->user_begin(), UE = CI->user_end(); UI != UE;) {
722 ICmpInst *Old = cast<ICmpInst>(*UI++);
723 Value *Cmp =
724 B.CreateICmp(Old->getPredicate(), StrNCmp,
725 ConstantInt::getNullValue(StrNCmp->getType()), "cmp");
726 replaceAllUsesWith(Old, Cmp);
Meador Inge17418502012-10-13 16:45:37 +0000727 }
Chris Bienemanad070d02014-09-17 20:55:46 +0000728 return CI;
729 }
Meador Inge17418502012-10-13 16:45:37 +0000730
Chris Bienemanad070d02014-09-17 20:55:46 +0000731 // See if either input string is a constant string.
732 StringRef SearchStr, ToFindStr;
733 bool HasStr1 = getConstantStringInfo(CI->getArgOperand(0), SearchStr);
734 bool HasStr2 = getConstantStringInfo(CI->getArgOperand(1), ToFindStr);
735
736 // fold strstr(x, "") -> x.
737 if (HasStr2 && ToFindStr.empty())
738 return B.CreateBitCast(CI->getArgOperand(0), CI->getType());
739
740 // If both strings are known, constant fold it.
741 if (HasStr1 && HasStr2) {
742 size_t Offset = SearchStr.find(ToFindStr);
743
744 if (Offset == StringRef::npos) // strstr("foo", "bar") -> null
Meador Inge17418502012-10-13 16:45:37 +0000745 return Constant::getNullValue(CI->getType());
746
Chris Bienemanad070d02014-09-17 20:55:46 +0000747 // strstr("abcd", "bc") -> gep((char*)"abcd", 1)
748 Value *Result = CastToCStr(CI->getArgOperand(0), B);
749 Result = B.CreateConstInBoundsGEP1_64(Result, Offset, "strstr");
750 return B.CreateBitCast(Result, CI->getType());
Meador Inge17418502012-10-13 16:45:37 +0000751 }
Meador Inge17418502012-10-13 16:45:37 +0000752
Chris Bienemanad070d02014-09-17 20:55:46 +0000753 // fold strstr(x, "y") -> strchr(x, 'y').
754 if (HasStr2 && ToFindStr.size() == 1) {
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000755 Value *StrChr = EmitStrChr(CI->getArgOperand(0), ToFindStr[0], B, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +0000756 return StrChr ? B.CreateBitCast(StrChr, CI->getType()) : nullptr;
757 }
758 return nullptr;
759}
Meador Inge40b6fac2012-10-15 03:47:37 +0000760
Benjamin Kramer691363e2015-03-21 15:36:21 +0000761Value *LibCallSimplifier::optimizeMemChr(CallInst *CI, IRBuilder<> &B) {
762 Function *Callee = CI->getCalledFunction();
763 FunctionType *FT = Callee->getFunctionType();
764 if (FT->getNumParams() != 3 || !FT->getParamType(0)->isPointerTy() ||
765 !FT->getParamType(1)->isIntegerTy(32) ||
766 !FT->getParamType(2)->isIntegerTy() ||
767 !FT->getReturnType()->isPointerTy())
768 return nullptr;
769
770 Value *SrcStr = CI->getArgOperand(0);
771 ConstantInt *CharC = dyn_cast<ConstantInt>(CI->getArgOperand(1));
772 ConstantInt *LenC = dyn_cast<ConstantInt>(CI->getArgOperand(2));
773
774 // memchr(x, y, 0) -> null
775 if (LenC && LenC->isNullValue())
776 return Constant::getNullValue(CI->getType());
777
Benjamin Kramer7857d722015-03-21 21:09:33 +0000778 // From now on we need at least constant length and string.
Benjamin Kramer691363e2015-03-21 15:36:21 +0000779 StringRef Str;
Benjamin Kramer7857d722015-03-21 21:09:33 +0000780 if (!LenC || !getConstantStringInfo(SrcStr, Str, 0, /*TrimAtNul=*/false))
Benjamin Kramer691363e2015-03-21 15:36:21 +0000781 return nullptr;
782
783 // Truncate the string to LenC. If Str is smaller than LenC we will still only
784 // scan the string, as reading past the end of it is undefined and we can just
785 // return null if we don't find the char.
786 Str = Str.substr(0, LenC->getZExtValue());
787
Benjamin Kramer7857d722015-03-21 21:09:33 +0000788 // If the char is variable but the input str and length are not we can turn
789 // this memchr call into a simple bit field test. Of course this only works
790 // when the return value is only checked against null.
791 //
792 // It would be really nice to reuse switch lowering here but we can't change
793 // the CFG at this point.
794 //
795 // memchr("\r\n", C, 2) != nullptr -> (C & ((1 << '\r') | (1 << '\n'))) != 0
796 // after bounds check.
797 if (!CharC && !Str.empty() && isOnlyUsedInZeroEqualityComparison(CI)) {
Benjamin Kramerd6aa0ec2015-03-21 22:04:26 +0000798 unsigned char Max =
799 *std::max_element(reinterpret_cast<const unsigned char *>(Str.begin()),
800 reinterpret_cast<const unsigned char *>(Str.end()));
Benjamin Kramer7857d722015-03-21 21:09:33 +0000801
802 // Make sure the bit field we're about to create fits in a register on the
803 // target.
804 // FIXME: On a 64 bit architecture this prevents us from using the
805 // interesting range of alpha ascii chars. We could do better by emitting
806 // two bitfields or shifting the range by 64 if no lower chars are used.
807 if (!DL.fitsInLegalInteger(Max + 1))
808 return nullptr;
809
810 // For the bit field use a power-of-2 type with at least 8 bits to avoid
811 // creating unnecessary illegal types.
812 unsigned char Width = NextPowerOf2(std::max((unsigned char)7, Max));
813
814 // Now build the bit field.
815 APInt Bitfield(Width, 0);
816 for (char C : Str)
817 Bitfield.setBit((unsigned char)C);
818 Value *BitfieldC = B.getInt(Bitfield);
819
820 // First check that the bit field access is within bounds.
821 Value *C = B.CreateZExtOrTrunc(CI->getArgOperand(1), BitfieldC->getType());
822 Value *Bounds = B.CreateICmp(ICmpInst::ICMP_ULT, C, B.getIntN(Width, Width),
823 "memchr.bounds");
824
825 // Create code that checks if the given bit is set in the field.
826 Value *Shl = B.CreateShl(B.getIntN(Width, 1ULL), C);
827 Value *Bits = B.CreateIsNotNull(B.CreateAnd(Shl, BitfieldC), "memchr.bits");
828
829 // Finally merge both checks and cast to pointer type. The inttoptr
830 // implicitly zexts the i1 to intptr type.
831 return B.CreateIntToPtr(B.CreateAnd(Bounds, Bits, "memchr"), CI->getType());
832 }
833
834 // Check if all arguments are constants. If so, we can constant fold.
835 if (!CharC)
836 return nullptr;
837
Benjamin Kramer691363e2015-03-21 15:36:21 +0000838 // Compute the offset.
839 size_t I = Str.find(CharC->getSExtValue() & 0xFF);
840 if (I == StringRef::npos) // Didn't find the char. memchr returns null.
841 return Constant::getNullValue(CI->getType());
842
843 // memchr(s+n,c,l) -> gep(s+n+i,c)
David Blaikie3909da72015-03-30 20:42:56 +0000844 return B.CreateGEP(B.getInt8Ty(), SrcStr, B.getInt64(I), "memchr");
Benjamin Kramer691363e2015-03-21 15:36:21 +0000845}
846
Chris Bienemanad070d02014-09-17 20:55:46 +0000847Value *LibCallSimplifier::optimizeMemCmp(CallInst *CI, IRBuilder<> &B) {
848 Function *Callee = CI->getCalledFunction();
849 FunctionType *FT = Callee->getFunctionType();
850 if (FT->getNumParams() != 3 || !FT->getParamType(0)->isPointerTy() ||
851 !FT->getParamType(1)->isPointerTy() ||
852 !FT->getReturnType()->isIntegerTy(32))
Craig Topperf40110f2014-04-25 05:29:35 +0000853 return nullptr;
Meador Inge40b6fac2012-10-15 03:47:37 +0000854
Chris Bienemanad070d02014-09-17 20:55:46 +0000855 Value *LHS = CI->getArgOperand(0), *RHS = CI->getArgOperand(1);
Meador Inge40b6fac2012-10-15 03:47:37 +0000856
Chris Bienemanad070d02014-09-17 20:55:46 +0000857 if (LHS == RHS) // memcmp(s,s,x) -> 0
858 return Constant::getNullValue(CI->getType());
Meador Inge40b6fac2012-10-15 03:47:37 +0000859
Chris Bienemanad070d02014-09-17 20:55:46 +0000860 // Make sure we have a constant length.
861 ConstantInt *LenC = dyn_cast<ConstantInt>(CI->getArgOperand(2));
862 if (!LenC)
Craig Topperf40110f2014-04-25 05:29:35 +0000863 return nullptr;
Chris Bienemanad070d02014-09-17 20:55:46 +0000864 uint64_t Len = LenC->getZExtValue();
865
866 if (Len == 0) // memcmp(s1,s2,0) -> 0
867 return Constant::getNullValue(CI->getType());
868
869 // memcmp(S1,S2,1) -> *(unsigned char*)LHS - *(unsigned char*)RHS
870 if (Len == 1) {
871 Value *LHSV = B.CreateZExt(B.CreateLoad(CastToCStr(LHS, B), "lhsc"),
872 CI->getType(), "lhsv");
873 Value *RHSV = B.CreateZExt(B.CreateLoad(CastToCStr(RHS, B), "rhsc"),
874 CI->getType(), "rhsv");
875 return B.CreateSub(LHSV, RHSV, "chardiff");
Meador Inge40b6fac2012-10-15 03:47:37 +0000876 }
Meador Inge40b6fac2012-10-15 03:47:37 +0000877
Chad Rosierdc655322015-08-28 18:30:18 +0000878 // memcmp(S1,S2,N/8)==0 -> (*(intN_t*)S1 != *(intN_t*)S2)==0
879 if (DL.isLegalInteger(Len * 8) && isOnlyUsedInZeroEqualityComparison(CI)) {
880
881 IntegerType *IntType = IntegerType::get(CI->getContext(), Len * 8);
882 unsigned PrefAlignment = DL.getPrefTypeAlignment(IntType);
883
884 if (getKnownAlignment(LHS, DL, CI) >= PrefAlignment &&
885 getKnownAlignment(RHS, DL, CI) >= PrefAlignment) {
886
887 Type *LHSPtrTy =
888 IntType->getPointerTo(LHS->getType()->getPointerAddressSpace());
889 Type *RHSPtrTy =
890 IntType->getPointerTo(RHS->getType()->getPointerAddressSpace());
891
892 Value *LHSV = B.CreateLoad(B.CreateBitCast(LHS, LHSPtrTy, "lhsc"), "lhsv");
893 Value *RHSV = B.CreateLoad(B.CreateBitCast(RHS, RHSPtrTy, "rhsc"), "rhsv");
894
895 return B.CreateZExt(B.CreateICmpNE(LHSV, RHSV), CI->getType(), "memcmp");
896 }
897 }
898
Chris Bienemanad070d02014-09-17 20:55:46 +0000899 // Constant folding: memcmp(x, y, l) -> cnst (all arguments are constant)
900 StringRef LHSStr, RHSStr;
901 if (getConstantStringInfo(LHS, LHSStr) &&
902 getConstantStringInfo(RHS, RHSStr)) {
903 // Make sure we're not reading out-of-bounds memory.
904 if (Len > LHSStr.size() || Len > RHSStr.size())
Craig Topperf40110f2014-04-25 05:29:35 +0000905 return nullptr;
Chris Bienemanad070d02014-09-17 20:55:46 +0000906 // Fold the memcmp and normalize the result. This way we get consistent
907 // results across multiple platforms.
908 uint64_t Ret = 0;
909 int Cmp = memcmp(LHSStr.data(), RHSStr.data(), Len);
910 if (Cmp < 0)
911 Ret = -1;
912 else if (Cmp > 0)
913 Ret = 1;
914 return ConstantInt::get(CI->getType(), Ret);
Meador Inge000dbcc2012-10-18 18:12:40 +0000915 }
Meador Inge000dbcc2012-10-18 18:12:40 +0000916
Chris Bienemanad070d02014-09-17 20:55:46 +0000917 return nullptr;
918}
Meador Inge9a6a1902012-10-31 00:20:56 +0000919
Chris Bienemanad070d02014-09-17 20:55:46 +0000920Value *LibCallSimplifier::optimizeMemCpy(CallInst *CI, IRBuilder<> &B) {
921 Function *Callee = CI->getCalledFunction();
Meador Inged589ac62012-10-31 03:33:06 +0000922
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000923 if (!checkStringCopyLibFuncSignature(Callee, LibFunc::memcpy))
Craig Topperf40110f2014-04-25 05:29:35 +0000924 return nullptr;
Meador Inge6f8e0112012-10-31 04:29:58 +0000925
Chris Bienemanad070d02014-09-17 20:55:46 +0000926 // memcpy(x, y, n) -> llvm.memcpy(x, y, n, 1)
927 B.CreateMemCpy(CI->getArgOperand(0), CI->getArgOperand(1),
928 CI->getArgOperand(2), 1);
929 return CI->getArgOperand(0);
930}
Meador Inge05a625a2012-10-31 14:58:26 +0000931
Chris Bienemanad070d02014-09-17 20:55:46 +0000932Value *LibCallSimplifier::optimizeMemMove(CallInst *CI, IRBuilder<> &B) {
933 Function *Callee = CI->getCalledFunction();
Meador Inge05a625a2012-10-31 14:58:26 +0000934
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000935 if (!checkStringCopyLibFuncSignature(Callee, LibFunc::memmove))
Craig Topperf40110f2014-04-25 05:29:35 +0000936 return nullptr;
Meador Inge489b5d62012-11-08 01:33:50 +0000937
Chris Bienemanad070d02014-09-17 20:55:46 +0000938 // memmove(x, y, n) -> llvm.memmove(x, y, n, 1)
939 B.CreateMemMove(CI->getArgOperand(0), CI->getArgOperand(1),
940 CI->getArgOperand(2), 1);
941 return CI->getArgOperand(0);
942}
Meador Ingebcd88ef72012-11-10 15:16:48 +0000943
Chris Bienemanad070d02014-09-17 20:55:46 +0000944Value *LibCallSimplifier::optimizeMemSet(CallInst *CI, IRBuilder<> &B) {
945 Function *Callee = CI->getCalledFunction();
Meador Ingebcd88ef72012-11-10 15:16:48 +0000946
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000947 if (!checkStringCopyLibFuncSignature(Callee, LibFunc::memset))
Craig Topperf40110f2014-04-25 05:29:35 +0000948 return nullptr;
Meador Inge56edbc92012-11-11 03:51:48 +0000949
Chris Bienemanad070d02014-09-17 20:55:46 +0000950 // memset(p, v, n) -> llvm.memset(p, v, n, 1)
951 Value *Val = B.CreateIntCast(CI->getArgOperand(1), B.getInt8Ty(), false);
952 B.CreateMemSet(CI->getArgOperand(0), Val, CI->getArgOperand(2), 1);
953 return CI->getArgOperand(0);
954}
Meador Inged4825782012-11-11 06:49:03 +0000955
Meador Inge193e0352012-11-13 04:16:17 +0000956//===----------------------------------------------------------------------===//
957// Math Library Optimizations
958//===----------------------------------------------------------------------===//
959
Matthias Braund34e4d22014-12-03 21:46:33 +0000960/// Return a variant of Val with float type.
961/// Currently this works in two cases: If Val is an FPExtension of a float
962/// value to something bigger, simply return the operand.
963/// If Val is a ConstantFP but can be converted to a float ConstantFP without
964/// loss of precision do so.
965static Value *valueHasFloatPrecision(Value *Val) {
966 if (FPExtInst *Cast = dyn_cast<FPExtInst>(Val)) {
967 Value *Op = Cast->getOperand(0);
968 if (Op->getType()->isFloatTy())
969 return Op;
970 }
971 if (ConstantFP *Const = dyn_cast<ConstantFP>(Val)) {
972 APFloat F = Const->getValueAPF();
Matthias Braun395a82f2014-12-03 22:10:39 +0000973 bool losesInfo;
Matthias Braund34e4d22014-12-03 21:46:33 +0000974 (void)F.convert(APFloat::IEEEsingle, APFloat::rmNearestTiesToEven,
Matthias Braun395a82f2014-12-03 22:10:39 +0000975 &losesInfo);
976 if (!losesInfo)
Matthias Braund34e4d22014-12-03 21:46:33 +0000977 return ConstantFP::get(Const->getContext(), F);
978 }
979 return nullptr;
980}
981
Meador Inge193e0352012-11-13 04:16:17 +0000982//===----------------------------------------------------------------------===//
983// Double -> Float Shrinking Optimizations for Unary Functions like 'floor'
984
Chris Bienemanad070d02014-09-17 20:55:46 +0000985Value *LibCallSimplifier::optimizeUnaryDoubleFP(CallInst *CI, IRBuilder<> &B,
986 bool CheckRetType) {
987 Function *Callee = CI->getCalledFunction();
988 FunctionType *FT = Callee->getFunctionType();
989 if (FT->getNumParams() != 1 || !FT->getReturnType()->isDoubleTy() ||
990 !FT->getParamType(0)->isDoubleTy())
991 return nullptr;
Meador Inge193e0352012-11-13 04:16:17 +0000992
Chris Bienemanad070d02014-09-17 20:55:46 +0000993 if (CheckRetType) {
994 // Check if all the uses for function like 'sin' are converted to float.
995 for (User *U : CI->users()) {
996 FPTruncInst *Cast = dyn_cast<FPTruncInst>(U);
997 if (!Cast || !Cast->getType()->isFloatTy())
998 return nullptr;
Meador Inge193e0352012-11-13 04:16:17 +0000999 }
Meador Inge193e0352012-11-13 04:16:17 +00001000 }
Chris Bienemanad070d02014-09-17 20:55:46 +00001001
1002 // If this is something like 'floor((double)floatval)', convert to floorf.
Matthias Braund34e4d22014-12-03 21:46:33 +00001003 Value *V = valueHasFloatPrecision(CI->getArgOperand(0));
1004 if (V == nullptr)
Chris Bienemanad070d02014-09-17 20:55:46 +00001005 return nullptr;
1006
1007 // floor((double)floatval) -> (double)floorf(floatval)
Sanjay Patel848309d2014-10-23 21:52:45 +00001008 if (Callee->isIntrinsic()) {
1009 Module *M = CI->getParent()->getParent()->getParent();
Pete Cooper9e1d3352015-05-20 17:16:39 +00001010 Intrinsic::ID IID = Callee->getIntrinsicID();
Sanjay Patel848309d2014-10-23 21:52:45 +00001011 Function *F = Intrinsic::getDeclaration(M, IID, B.getFloatTy());
1012 V = B.CreateCall(F, V);
1013 } else {
1014 // The call is a library call rather than an intrinsic.
1015 V = EmitUnaryFloatFnCall(V, Callee->getName(), B, Callee->getAttributes());
1016 }
1017
Chris Bienemanad070d02014-09-17 20:55:46 +00001018 return B.CreateFPExt(V, B.getDoubleTy());
1019}
Meador Inge193e0352012-11-13 04:16:17 +00001020
Yi Jiang6ab044e2013-12-16 22:42:40 +00001021// Double -> Float Shrinking Optimizations for Binary Functions like 'fmin/fmax'
Chris Bienemanad070d02014-09-17 20:55:46 +00001022Value *LibCallSimplifier::optimizeBinaryDoubleFP(CallInst *CI, IRBuilder<> &B) {
1023 Function *Callee = CI->getCalledFunction();
1024 FunctionType *FT = Callee->getFunctionType();
1025 // Just make sure this has 2 arguments of the same FP type, which match the
1026 // result type.
1027 if (FT->getNumParams() != 2 || FT->getReturnType() != FT->getParamType(0) ||
1028 FT->getParamType(0) != FT->getParamType(1) ||
1029 !FT->getParamType(0)->isFloatingPointTy())
Craig Topperf40110f2014-04-25 05:29:35 +00001030 return nullptr;
Meador Inge193e0352012-11-13 04:16:17 +00001031
Chris Bienemanad070d02014-09-17 20:55:46 +00001032 // If this is something like 'fmin((double)floatval1, (double)floatval2)',
Matthias Braund34e4d22014-12-03 21:46:33 +00001033 // or fmin(1.0, (double)floatval), then we convert it to fminf.
1034 Value *V1 = valueHasFloatPrecision(CI->getArgOperand(0));
1035 if (V1 == nullptr)
1036 return nullptr;
1037 Value *V2 = valueHasFloatPrecision(CI->getArgOperand(1));
1038 if (V2 == nullptr)
Craig Topperf40110f2014-04-25 05:29:35 +00001039 return nullptr;
Chris Bienemanad070d02014-09-17 20:55:46 +00001040
1041 // fmin((double)floatval1, (double)floatval2)
Matthias Braund34e4d22014-12-03 21:46:33 +00001042 // -> (double)fminf(floatval1, floatval2)
Sanjay Patel848309d2014-10-23 21:52:45 +00001043 // TODO: Handle intrinsics in the same way as in optimizeUnaryDoubleFP().
Matthias Braund34e4d22014-12-03 21:46:33 +00001044 Value *V = EmitBinaryFloatFnCall(V1, V2, Callee->getName(), B,
1045 Callee->getAttributes());
Chris Bienemanad070d02014-09-17 20:55:46 +00001046 return B.CreateFPExt(V, B.getDoubleTy());
1047}
1048
1049Value *LibCallSimplifier::optimizeCos(CallInst *CI, IRBuilder<> &B) {
1050 Function *Callee = CI->getCalledFunction();
1051 Value *Ret = nullptr;
Davide Italianoa3458772015-11-05 19:18:23 +00001052 StringRef Name = Callee->getName();
1053 if (UnsafeFPShrink && Name == "cos" && hasFloatVersion(Name))
Chris Bienemanad070d02014-09-17 20:55:46 +00001054 Ret = optimizeUnaryDoubleFP(CI, B, true);
Bob Wilsond8d92d92013-11-03 06:48:38 +00001055
Chris Bienemanad070d02014-09-17 20:55:46 +00001056 FunctionType *FT = Callee->getFunctionType();
1057 // Just make sure this has 1 argument of FP type, which matches the
1058 // result type.
1059 if (FT->getNumParams() != 1 || FT->getReturnType() != FT->getParamType(0) ||
1060 !FT->getParamType(0)->isFloatingPointTy())
1061 return Ret;
Bob Wilsond8d92d92013-11-03 06:48:38 +00001062
Chris Bienemanad070d02014-09-17 20:55:46 +00001063 // cos(-x) -> cos(x)
1064 Value *Op1 = CI->getArgOperand(0);
1065 if (BinaryOperator::isFNeg(Op1)) {
1066 BinaryOperator *BinExpr = cast<BinaryOperator>(Op1);
1067 return B.CreateCall(Callee, BinExpr->getOperand(1), "cos");
1068 }
1069 return Ret;
1070}
Bob Wilsond8d92d92013-11-03 06:48:38 +00001071
Chris Bienemanad070d02014-09-17 20:55:46 +00001072Value *LibCallSimplifier::optimizePow(CallInst *CI, IRBuilder<> &B) {
1073 Function *Callee = CI->getCalledFunction();
Chris Bienemanad070d02014-09-17 20:55:46 +00001074 Value *Ret = nullptr;
Davide Italianoa3458772015-11-05 19:18:23 +00001075 StringRef Name = Callee->getName();
1076 if (UnsafeFPShrink && Name == "pow" && hasFloatVersion(Name))
Chris Bienemanad070d02014-09-17 20:55:46 +00001077 Ret = optimizeUnaryDoubleFP(CI, B, true);
Bob Wilsond8d92d92013-11-03 06:48:38 +00001078
Chris Bienemanad070d02014-09-17 20:55:46 +00001079 FunctionType *FT = Callee->getFunctionType();
1080 // Just make sure this has 2 arguments of the same FP type, which match the
1081 // result type.
1082 if (FT->getNumParams() != 2 || FT->getReturnType() != FT->getParamType(0) ||
1083 FT->getParamType(0) != FT->getParamType(1) ||
1084 !FT->getParamType(0)->isFloatingPointTy())
1085 return Ret;
Bob Wilsond8d92d92013-11-03 06:48:38 +00001086
Chris Bienemanad070d02014-09-17 20:55:46 +00001087 Value *Op1 = CI->getArgOperand(0), *Op2 = CI->getArgOperand(1);
1088 if (ConstantFP *Op1C = dyn_cast<ConstantFP>(Op1)) {
1089 // pow(1.0, x) -> 1.0
1090 if (Op1C->isExactlyValue(1.0))
1091 return Op1C;
1092 // pow(2.0, x) -> exp2(x)
1093 if (Op1C->isExactlyValue(2.0) &&
1094 hasUnaryFloatFn(TLI, Op1->getType(), LibFunc::exp2, LibFunc::exp2f,
1095 LibFunc::exp2l))
1096 return EmitUnaryFloatFnCall(Op2, "exp2", B, Callee->getAttributes());
1097 // pow(10.0, x) -> exp10(x)
1098 if (Op1C->isExactlyValue(10.0) &&
1099 hasUnaryFloatFn(TLI, Op1->getType(), LibFunc::exp10, LibFunc::exp10f,
1100 LibFunc::exp10l))
1101 return EmitUnaryFloatFnCall(Op2, TLI->getName(LibFunc::exp10), B,
1102 Callee->getAttributes());
Bob Wilsond8d92d92013-11-03 06:48:38 +00001103 }
1104
Davide Italianoc8a79132015-11-03 20:32:23 +00001105 // pow(exp(x), y) -> exp(x*y)
1106 // pow(exp2(x), y) -> exp2(x * y)
1107 // We enable these only under fast-math. Besides rounding
1108 // differences the transformation changes overflow and
1109 // underflow behavior quite dramatically.
1110 // Example: x = 1000, y = 0.001.
1111 // pow(exp(x), y) = pow(inf, 0.001) = inf, whereas exp(x*y) = exp(1).
1112 if (canUseUnsafeFPMath(CI->getParent()->getParent())) {
1113 if (auto *OpC = dyn_cast<CallInst>(Op1)) {
1114 IRBuilder<>::FastMathFlagGuard Guard(B);
1115 FastMathFlags FMF;
1116 FMF.setUnsafeAlgebra();
1117 B.SetFastMathFlags(FMF);
1118
1119 LibFunc::Func Func;
1120 Function *Callee = OpC->getCalledFunction();
1121 StringRef FuncName = Callee->getName();
1122
1123 if (TLI->getLibFunc(FuncName, Func) && TLI->has(Func) &&
1124 (Func == LibFunc::exp || Func == LibFunc::exp2))
1125 return EmitUnaryFloatFnCall(
1126 B.CreateFMul(OpC->getArgOperand(0), Op2, "mul"), FuncName, B,
1127 Callee->getAttributes());
1128 }
1129 }
1130
Chris Bienemanad070d02014-09-17 20:55:46 +00001131 ConstantFP *Op2C = dyn_cast<ConstantFP>(Op2);
1132 if (!Op2C)
1133 return Ret;
1134
1135 if (Op2C->getValueAPF().isZero()) // pow(x, 0.0) -> 1.0
1136 return ConstantFP::get(CI->getType(), 1.0);
1137
1138 if (Op2C->isExactlyValue(0.5) &&
1139 hasUnaryFloatFn(TLI, Op2->getType(), LibFunc::sqrt, LibFunc::sqrtf,
1140 LibFunc::sqrtl) &&
1141 hasUnaryFloatFn(TLI, Op2->getType(), LibFunc::fabs, LibFunc::fabsf,
1142 LibFunc::fabsl)) {
1143 // Expand pow(x, 0.5) to (x == -infinity ? +infinity : fabs(sqrt(x))).
1144 // This is faster than calling pow, and still handles negative zero
1145 // and negative infinity correctly.
1146 // TODO: In fast-math mode, this could be just sqrt(x).
1147 // TODO: In finite-only mode, this could be just fabs(sqrt(x)).
1148 Value *Inf = ConstantFP::getInfinity(CI->getType());
1149 Value *NegInf = ConstantFP::getInfinity(CI->getType(), true);
1150 Value *Sqrt = EmitUnaryFloatFnCall(Op1, "sqrt", B, Callee->getAttributes());
1151 Value *FAbs =
1152 EmitUnaryFloatFnCall(Sqrt, "fabs", B, Callee->getAttributes());
1153 Value *FCmp = B.CreateFCmpOEQ(Op1, NegInf);
1154 Value *Sel = B.CreateSelect(FCmp, Inf, FAbs);
1155 return Sel;
Bob Wilsond8d92d92013-11-03 06:48:38 +00001156 }
1157
Chris Bienemanad070d02014-09-17 20:55:46 +00001158 if (Op2C->isExactlyValue(1.0)) // pow(x, 1.0) -> x
1159 return Op1;
1160 if (Op2C->isExactlyValue(2.0)) // pow(x, 2.0) -> x*x
1161 return B.CreateFMul(Op1, Op1, "pow2");
1162 if (Op2C->isExactlyValue(-1.0)) // pow(x, -1.0) -> 1.0/x
1163 return B.CreateFDiv(ConstantFP::get(CI->getType(), 1.0), Op1, "powrecip");
1164 return nullptr;
1165}
Bob Wilsond8d92d92013-11-03 06:48:38 +00001166
Chris Bienemanad070d02014-09-17 20:55:46 +00001167Value *LibCallSimplifier::optimizeExp2(CallInst *CI, IRBuilder<> &B) {
1168 Function *Callee = CI->getCalledFunction();
1169 Function *Caller = CI->getParent()->getParent();
Chris Bienemanad070d02014-09-17 20:55:46 +00001170 Value *Ret = nullptr;
Davide Italianoa3458772015-11-05 19:18:23 +00001171 StringRef Name = Callee->getName();
1172 if (UnsafeFPShrink && Name == "exp2" && hasFloatVersion(Name))
Chris Bienemanad070d02014-09-17 20:55:46 +00001173 Ret = optimizeUnaryDoubleFP(CI, B, true);
Bob Wilsond8d92d92013-11-03 06:48:38 +00001174
Chris Bienemanad070d02014-09-17 20:55:46 +00001175 FunctionType *FT = Callee->getFunctionType();
1176 // Just make sure this has 1 argument of FP type, which matches the
1177 // result type.
1178 if (FT->getNumParams() != 1 || FT->getReturnType() != FT->getParamType(0) ||
1179 !FT->getParamType(0)->isFloatingPointTy())
1180 return Ret;
1181
1182 Value *Op = CI->getArgOperand(0);
1183 // Turn exp2(sitofp(x)) -> ldexp(1.0, sext(x)) if sizeof(x) <= 32
1184 // Turn exp2(uitofp(x)) -> ldexp(1.0, zext(x)) if sizeof(x) < 32
1185 LibFunc::Func LdExp = LibFunc::ldexpl;
1186 if (Op->getType()->isFloatTy())
1187 LdExp = LibFunc::ldexpf;
1188 else if (Op->getType()->isDoubleTy())
1189 LdExp = LibFunc::ldexp;
1190
1191 if (TLI->has(LdExp)) {
1192 Value *LdExpArg = nullptr;
1193 if (SIToFPInst *OpC = dyn_cast<SIToFPInst>(Op)) {
1194 if (OpC->getOperand(0)->getType()->getPrimitiveSizeInBits() <= 32)
1195 LdExpArg = B.CreateSExt(OpC->getOperand(0), B.getInt32Ty());
1196 } else if (UIToFPInst *OpC = dyn_cast<UIToFPInst>(Op)) {
1197 if (OpC->getOperand(0)->getType()->getPrimitiveSizeInBits() < 32)
1198 LdExpArg = B.CreateZExt(OpC->getOperand(0), B.getInt32Ty());
1199 }
1200
1201 if (LdExpArg) {
1202 Constant *One = ConstantFP::get(CI->getContext(), APFloat(1.0f));
1203 if (!Op->getType()->isFloatTy())
1204 One = ConstantExpr::getFPExtend(One, Op->getType());
1205
1206 Module *M = Caller->getParent();
1207 Value *Callee =
1208 M->getOrInsertFunction(TLI->getName(LdExp), Op->getType(),
Reid Kleckner971c3ea2014-11-13 22:55:19 +00001209 Op->getType(), B.getInt32Ty(), nullptr);
David Blaikieff6409d2015-05-18 22:13:54 +00001210 CallInst *CI = B.CreateCall(Callee, {One, LdExpArg});
Chris Bienemanad070d02014-09-17 20:55:46 +00001211 if (const Function *F = dyn_cast<Function>(Callee->stripPointerCasts()))
1212 CI->setCallingConv(F->getCallingConv());
1213
1214 return CI;
1215 }
1216 }
1217 return Ret;
1218}
1219
Sanjay Patel0ca42bb2014-10-14 20:43:11 +00001220Value *LibCallSimplifier::optimizeFabs(CallInst *CI, IRBuilder<> &B) {
1221 Function *Callee = CI->getCalledFunction();
Sanjay Patel0ca42bb2014-10-14 20:43:11 +00001222 Value *Ret = nullptr;
Davide Italianoa3458772015-11-05 19:18:23 +00001223 StringRef Name = Callee->getName();
1224 if (Name == "fabs" && hasFloatVersion(Name))
Sanjay Patel0ca42bb2014-10-14 20:43:11 +00001225 Ret = optimizeUnaryDoubleFP(CI, B, false);
Sanjay Patel0ca42bb2014-10-14 20:43:11 +00001226
1227 FunctionType *FT = Callee->getFunctionType();
1228 // Make sure this has 1 argument of FP type which matches the result type.
1229 if (FT->getNumParams() != 1 || FT->getReturnType() != FT->getParamType(0) ||
1230 !FT->getParamType(0)->isFloatingPointTy())
1231 return Ret;
1232
1233 Value *Op = CI->getArgOperand(0);
1234 if (Instruction *I = dyn_cast<Instruction>(Op)) {
1235 // Fold fabs(x * x) -> x * x; any squared FP value must already be positive.
1236 if (I->getOpcode() == Instruction::FMul)
1237 if (I->getOperand(0) == I->getOperand(1))
1238 return Op;
1239 }
1240 return Ret;
1241}
1242
Sanjay Patel57fd1dc2015-08-16 20:18:19 +00001243Value *LibCallSimplifier::optimizeFMinFMax(CallInst *CI, IRBuilder<> &B) {
1244 // If we can shrink the call to a float function rather than a double
1245 // function, do that first.
1246 Function *Callee = CI->getCalledFunction();
Davide Italianoa3458772015-11-05 19:18:23 +00001247 StringRef Name = Callee->getName();
1248 if ((Name == "fmin" && hasFloatVersion(Name)) ||
1249 (Name == "fmax" && hasFloatVersion(Name))) {
Sanjay Patel57fd1dc2015-08-16 20:18:19 +00001250 Value *Ret = optimizeBinaryDoubleFP(CI, B);
1251 if (Ret)
1252 return Ret;
1253 }
1254
1255 // Make sure this has 2 arguments of FP type which match the result type.
1256 FunctionType *FT = Callee->getFunctionType();
1257 if (FT->getNumParams() != 2 || FT->getReturnType() != FT->getParamType(0) ||
1258 FT->getParamType(0) != FT->getParamType(1) ||
1259 !FT->getParamType(0)->isFloatingPointTy())
1260 return nullptr;
1261
Benjamin Kramerbb70d752015-08-16 21:16:37 +00001262 IRBuilder<>::FastMathFlagGuard Guard(B);
Sanjay Patel57fd1dc2015-08-16 20:18:19 +00001263 FastMathFlags FMF;
1264 Function *F = CI->getParent()->getParent();
Davide Italianoa904e522015-10-29 02:58:44 +00001265 if (canUseUnsafeFPMath(F)) {
Sanjay Patel57fd1dc2015-08-16 20:18:19 +00001266 // Unsafe algebra sets all fast-math-flags to true.
1267 FMF.setUnsafeAlgebra();
1268 } else {
1269 // At a minimum, no-nans-fp-math must be true.
Davide Italianoa904e522015-10-29 02:58:44 +00001270 Attribute Attr = F->getFnAttribute("no-nans-fp-math");
Sanjay Patel57fd1dc2015-08-16 20:18:19 +00001271 if (Attr.getValueAsString() != "true")
1272 return nullptr;
1273 // No-signed-zeros is implied by the definitions of fmax/fmin themselves:
1274 // "Ideally, fmax would be sensitive to the sign of zero, for example
NAKAMURA Takumi0d725392015-09-07 00:26:54 +00001275 // fmax(-0. 0, +0. 0) would return +0; however, implementation in software
Sanjay Patel57fd1dc2015-08-16 20:18:19 +00001276 // might be impractical."
1277 FMF.setNoSignedZeros();
1278 FMF.setNoNaNs();
1279 }
1280 B.SetFastMathFlags(FMF);
1281
1282 // We have a relaxed floating-point environment. We can ignore NaN-handling
1283 // and transform to a compare and select. We do not have to consider errno or
1284 // exceptions, because fmin/fmax do not have those.
1285 Value *Op0 = CI->getArgOperand(0);
1286 Value *Op1 = CI->getArgOperand(1);
1287 Value *Cmp = Callee->getName().startswith("fmin") ?
1288 B.CreateFCmpOLT(Op0, Op1) : B.CreateFCmpOGT(Op0, Op1);
1289 return B.CreateSelect(Cmp, Op0, Op1);
1290}
1291
Sanjay Patelc699a612014-10-16 18:48:17 +00001292Value *LibCallSimplifier::optimizeSqrt(CallInst *CI, IRBuilder<> &B) {
1293 Function *Callee = CI->getCalledFunction();
1294
1295 Value *Ret = nullptr;
Sanjay Patel848309d2014-10-23 21:52:45 +00001296 if (TLI->has(LibFunc::sqrtf) && (Callee->getName() == "sqrt" ||
1297 Callee->getIntrinsicID() == Intrinsic::sqrt))
Sanjay Patelc699a612014-10-16 18:48:17 +00001298 Ret = optimizeUnaryDoubleFP(CI, B, true);
Davide Italianoa904e522015-10-29 02:58:44 +00001299 if (!canUseUnsafeFPMath(CI->getParent()->getParent()))
1300 return Ret;
Sanjay Patelc699a612014-10-16 18:48:17 +00001301
Sanjay Patelc699a612014-10-16 18:48:17 +00001302 Value *Op = CI->getArgOperand(0);
1303 if (Instruction *I = dyn_cast<Instruction>(Op)) {
1304 if (I->getOpcode() == Instruction::FMul && I->hasUnsafeAlgebra()) {
1305 // We're looking for a repeated factor in a multiplication tree,
1306 // so we can do this fold: sqrt(x * x) -> fabs(x);
1307 // or this fold: sqrt(x * x * y) -> fabs(x) * sqrt(y).
1308 Value *Op0 = I->getOperand(0);
1309 Value *Op1 = I->getOperand(1);
1310 Value *RepeatOp = nullptr;
1311 Value *OtherOp = nullptr;
1312 if (Op0 == Op1) {
1313 // Simple match: the operands of the multiply are identical.
1314 RepeatOp = Op0;
1315 } else {
1316 // Look for a more complicated pattern: one of the operands is itself
1317 // a multiply, so search for a common factor in that multiply.
1318 // Note: We don't bother looking any deeper than this first level or for
1319 // variations of this pattern because instcombine's visitFMUL and/or the
1320 // reassociation pass should give us this form.
1321 Value *OtherMul0, *OtherMul1;
1322 if (match(Op0, m_FMul(m_Value(OtherMul0), m_Value(OtherMul1)))) {
1323 // Pattern: sqrt((x * y) * z)
1324 if (OtherMul0 == OtherMul1) {
1325 // Matched: sqrt((x * x) * z)
1326 RepeatOp = OtherMul0;
1327 OtherOp = Op1;
1328 }
1329 }
1330 }
1331 if (RepeatOp) {
1332 // Fast math flags for any created instructions should match the sqrt
1333 // and multiply.
1334 // FIXME: We're not checking the sqrt because it doesn't have
1335 // fast-math-flags (see earlier comment).
Benjamin Kramerbb70d752015-08-16 21:16:37 +00001336 IRBuilder<>::FastMathFlagGuard Guard(B);
Sanjay Patelc699a612014-10-16 18:48:17 +00001337 B.SetFastMathFlags(I->getFastMathFlags());
1338 // If we found a repeated factor, hoist it out of the square root and
1339 // replace it with the fabs of that factor.
1340 Module *M = Callee->getParent();
1341 Type *ArgType = Op->getType();
1342 Value *Fabs = Intrinsic::getDeclaration(M, Intrinsic::fabs, ArgType);
1343 Value *FabsCall = B.CreateCall(Fabs, RepeatOp, "fabs");
1344 if (OtherOp) {
1345 // If we found a non-repeated factor, we still need to get its square
1346 // root. We then multiply that by the value that was simplified out
1347 // of the square root calculation.
1348 Value *Sqrt = Intrinsic::getDeclaration(M, Intrinsic::sqrt, ArgType);
1349 Value *SqrtCall = B.CreateCall(Sqrt, OtherOp, "sqrt");
1350 return B.CreateFMul(FabsCall, SqrtCall);
1351 }
1352 return FabsCall;
1353 }
1354 }
1355 }
1356 return Ret;
1357}
1358
Davide Italiano51507d22015-11-04 23:36:56 +00001359Value *LibCallSimplifier::optimizeTan(CallInst *CI, IRBuilder<> &B) {
1360 Function *Callee = CI->getCalledFunction();
1361 Value *Ret = nullptr;
Davide Italianoa3458772015-11-05 19:18:23 +00001362 StringRef Name = Callee->getName();
1363 if (UnsafeFPShrink && Name == "tan" && hasFloatVersion(Name))
Davide Italiano51507d22015-11-04 23:36:56 +00001364 Ret = optimizeUnaryDoubleFP(CI, B, true);
1365 FunctionType *FT = Callee->getFunctionType();
1366
1367 // Just make sure this has 1 argument of FP type, which matches the
1368 // result type.
1369 if (FT->getNumParams() != 1 || FT->getReturnType() != FT->getParamType(0) ||
1370 !FT->getParamType(0)->isFloatingPointTy())
1371 return Ret;
1372
1373 if (!canUseUnsafeFPMath(CI->getParent()->getParent()))
1374 return Ret;
1375 Value *Op1 = CI->getArgOperand(0);
1376 auto *OpC = dyn_cast<CallInst>(Op1);
1377 if (!OpC)
1378 return Ret;
1379
1380 // tan(atan(x)) -> x
1381 // tanf(atanf(x)) -> x
1382 // tanl(atanl(x)) -> x
1383 LibFunc::Func Func;
1384 Function *F = OpC->getCalledFunction();
1385 StringRef FuncName = F->getName();
1386 if (TLI->getLibFunc(FuncName, Func) && TLI->has(Func) &&
1387 ((Func == LibFunc::atan && Callee->getName() == "tan") ||
1388 (Func == LibFunc::atanf && Callee->getName() == "tanf") ||
1389 (Func == LibFunc::atanl && Callee->getName() == "tanl")))
1390 Ret = OpC->getArgOperand(0);
1391 return Ret;
1392}
1393
Chris Bienemanad070d02014-09-17 20:55:46 +00001394static bool isTrigLibCall(CallInst *CI);
1395static void insertSinCosCall(IRBuilder<> &B, Function *OrigCallee, Value *Arg,
1396 bool UseFloat, Value *&Sin, Value *&Cos,
1397 Value *&SinCos);
1398
1399Value *LibCallSimplifier::optimizeSinCosPi(CallInst *CI, IRBuilder<> &B) {
1400
1401 // Make sure the prototype is as expected, otherwise the rest of the
1402 // function is probably invalid and likely to abort.
1403 if (!isTrigLibCall(CI))
1404 return nullptr;
1405
1406 Value *Arg = CI->getArgOperand(0);
1407 SmallVector<CallInst *, 1> SinCalls;
1408 SmallVector<CallInst *, 1> CosCalls;
1409 SmallVector<CallInst *, 1> SinCosCalls;
1410
1411 bool IsFloat = Arg->getType()->isFloatTy();
1412
1413 // Look for all compatible sinpi, cospi and sincospi calls with the same
1414 // argument. If there are enough (in some sense) we can make the
1415 // substitution.
1416 for (User *U : Arg->users())
1417 classifyArgUse(U, CI->getParent(), IsFloat, SinCalls, CosCalls,
1418 SinCosCalls);
1419
1420 // It's only worthwhile if both sinpi and cospi are actually used.
1421 if (SinCosCalls.empty() && (SinCalls.empty() || CosCalls.empty()))
1422 return nullptr;
1423
1424 Value *Sin, *Cos, *SinCos;
1425 insertSinCosCall(B, CI->getCalledFunction(), Arg, IsFloat, Sin, Cos, SinCos);
1426
1427 replaceTrigInsts(SinCalls, Sin);
1428 replaceTrigInsts(CosCalls, Cos);
1429 replaceTrigInsts(SinCosCalls, SinCos);
1430
1431 return nullptr;
1432}
1433
1434static bool isTrigLibCall(CallInst *CI) {
1435 Function *Callee = CI->getCalledFunction();
1436 FunctionType *FT = Callee->getFunctionType();
1437
1438 // We can only hope to do anything useful if we can ignore things like errno
1439 // and floating-point exceptions.
1440 bool AttributesSafe =
1441 CI->hasFnAttr(Attribute::NoUnwind) && CI->hasFnAttr(Attribute::ReadNone);
1442
1443 // Other than that we need float(float) or double(double)
1444 return AttributesSafe && FT->getNumParams() == 1 &&
1445 FT->getReturnType() == FT->getParamType(0) &&
1446 (FT->getParamType(0)->isFloatTy() ||
1447 FT->getParamType(0)->isDoubleTy());
1448}
1449
1450void
1451LibCallSimplifier::classifyArgUse(Value *Val, BasicBlock *BB, bool IsFloat,
1452 SmallVectorImpl<CallInst *> &SinCalls,
1453 SmallVectorImpl<CallInst *> &CosCalls,
1454 SmallVectorImpl<CallInst *> &SinCosCalls) {
1455 CallInst *CI = dyn_cast<CallInst>(Val);
1456
1457 if (!CI)
1458 return;
1459
1460 Function *Callee = CI->getCalledFunction();
1461 StringRef FuncName = Callee->getName();
1462 LibFunc::Func Func;
1463 if (!TLI->getLibFunc(FuncName, Func) || !TLI->has(Func) || !isTrigLibCall(CI))
1464 return;
1465
1466 if (IsFloat) {
1467 if (Func == LibFunc::sinpif)
1468 SinCalls.push_back(CI);
1469 else if (Func == LibFunc::cospif)
1470 CosCalls.push_back(CI);
1471 else if (Func == LibFunc::sincospif_stret)
1472 SinCosCalls.push_back(CI);
1473 } else {
1474 if (Func == LibFunc::sinpi)
1475 SinCalls.push_back(CI);
1476 else if (Func == LibFunc::cospi)
1477 CosCalls.push_back(CI);
1478 else if (Func == LibFunc::sincospi_stret)
1479 SinCosCalls.push_back(CI);
1480 }
1481}
1482
1483void LibCallSimplifier::replaceTrigInsts(SmallVectorImpl<CallInst *> &Calls,
1484 Value *Res) {
Davide Italianoc6926882015-10-27 04:17:51 +00001485 for (CallInst *C : Calls)
1486 replaceAllUsesWith(C, Res);
Chris Bienemanad070d02014-09-17 20:55:46 +00001487}
1488
1489void insertSinCosCall(IRBuilder<> &B, Function *OrigCallee, Value *Arg,
1490 bool UseFloat, Value *&Sin, Value *&Cos, Value *&SinCos) {
1491 Type *ArgTy = Arg->getType();
1492 Type *ResTy;
1493 StringRef Name;
1494
1495 Triple T(OrigCallee->getParent()->getTargetTriple());
1496 if (UseFloat) {
1497 Name = "__sincospif_stret";
1498
1499 assert(T.getArch() != Triple::x86 && "x86 messy and unsupported for now");
1500 // x86_64 can't use {float, float} since that would be returned in both
1501 // xmm0 and xmm1, which isn't what a real struct would do.
1502 ResTy = T.getArch() == Triple::x86_64
1503 ? static_cast<Type *>(VectorType::get(ArgTy, 2))
Reid Kleckner971c3ea2014-11-13 22:55:19 +00001504 : static_cast<Type *>(StructType::get(ArgTy, ArgTy, nullptr));
Chris Bienemanad070d02014-09-17 20:55:46 +00001505 } else {
1506 Name = "__sincospi_stret";
Reid Kleckner971c3ea2014-11-13 22:55:19 +00001507 ResTy = StructType::get(ArgTy, ArgTy, nullptr);
Chris Bienemanad070d02014-09-17 20:55:46 +00001508 }
1509
1510 Module *M = OrigCallee->getParent();
1511 Value *Callee = M->getOrInsertFunction(Name, OrigCallee->getAttributes(),
Reid Kleckner971c3ea2014-11-13 22:55:19 +00001512 ResTy, ArgTy, nullptr);
Chris Bienemanad070d02014-09-17 20:55:46 +00001513
1514 if (Instruction *ArgInst = dyn_cast<Instruction>(Arg)) {
1515 // If the argument is an instruction, it must dominate all uses so put our
1516 // sincos call there.
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00001517 B.SetInsertPoint(ArgInst->getParent(), ++ArgInst->getIterator());
Chris Bienemanad070d02014-09-17 20:55:46 +00001518 } else {
1519 // Otherwise (e.g. for a constant) the beginning of the function is as
1520 // good a place as any.
1521 BasicBlock &EntryBB = B.GetInsertBlock()->getParent()->getEntryBlock();
1522 B.SetInsertPoint(&EntryBB, EntryBB.begin());
1523 }
1524
1525 SinCos = B.CreateCall(Callee, Arg, "sincospi");
1526
1527 if (SinCos->getType()->isStructTy()) {
1528 Sin = B.CreateExtractValue(SinCos, 0, "sinpi");
1529 Cos = B.CreateExtractValue(SinCos, 1, "cospi");
1530 } else {
1531 Sin = B.CreateExtractElement(SinCos, ConstantInt::get(B.getInt32Ty(), 0),
1532 "sinpi");
1533 Cos = B.CreateExtractElement(SinCos, ConstantInt::get(B.getInt32Ty(), 1),
1534 "cospi");
1535 }
1536}
Bob Wilsond8d92d92013-11-03 06:48:38 +00001537
Meador Inge7415f842012-11-25 20:45:27 +00001538//===----------------------------------------------------------------------===//
1539// Integer Library Call Optimizations
1540//===----------------------------------------------------------------------===//
1541
Davide Italiano396f3ee2015-10-31 23:17:45 +00001542static bool checkIntUnaryReturnAndParam(Function *Callee) {
1543 FunctionType *FT = Callee->getFunctionType();
Davide Italiano5cdf9152015-11-01 00:09:16 +00001544 return FT->getNumParams() == 1 && FT->getReturnType()->isIntegerTy(32) &&
1545 FT->getParamType(0)->isIntegerTy();
Davide Italiano396f3ee2015-10-31 23:17:45 +00001546}
1547
Chris Bienemanad070d02014-09-17 20:55:46 +00001548Value *LibCallSimplifier::optimizeFFS(CallInst *CI, IRBuilder<> &B) {
1549 Function *Callee = CI->getCalledFunction();
Davide Italiano396f3ee2015-10-31 23:17:45 +00001550 if (!checkIntUnaryReturnAndParam(Callee))
Chris Bienemanad070d02014-09-17 20:55:46 +00001551 return nullptr;
Chris Bienemanad070d02014-09-17 20:55:46 +00001552 Value *Op = CI->getArgOperand(0);
Meador Inge7415f842012-11-25 20:45:27 +00001553
Chris Bienemanad070d02014-09-17 20:55:46 +00001554 // Constant fold.
1555 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op)) {
1556 if (CI->isZero()) // ffs(0) -> 0.
1557 return B.getInt32(0);
1558 // ffs(c) -> cttz(c)+1
1559 return B.getInt32(CI->getValue().countTrailingZeros() + 1);
Meador Inge7415f842012-11-25 20:45:27 +00001560 }
Meador Inge7415f842012-11-25 20:45:27 +00001561
Chris Bienemanad070d02014-09-17 20:55:46 +00001562 // ffs(x) -> x != 0 ? (i32)llvm.cttz(x)+1 : 0
1563 Type *ArgType = Op->getType();
1564 Value *F =
1565 Intrinsic::getDeclaration(Callee->getParent(), Intrinsic::cttz, ArgType);
Davide Italianoa1953862015-08-13 20:34:26 +00001566 Value *V = B.CreateCall(F, {Op, B.getTrue()}, "cttz");
Chris Bienemanad070d02014-09-17 20:55:46 +00001567 V = B.CreateAdd(V, ConstantInt::get(V->getType(), 1));
1568 V = B.CreateIntCast(V, B.getInt32Ty(), false);
Meador Ingea0b6d872012-11-26 00:24:07 +00001569
Chris Bienemanad070d02014-09-17 20:55:46 +00001570 Value *Cond = B.CreateICmpNE(Op, Constant::getNullValue(ArgType));
1571 return B.CreateSelect(Cond, V, B.getInt32(0));
1572}
Meador Ingea0b6d872012-11-26 00:24:07 +00001573
Chris Bienemanad070d02014-09-17 20:55:46 +00001574Value *LibCallSimplifier::optimizeAbs(CallInst *CI, IRBuilder<> &B) {
1575 Function *Callee = CI->getCalledFunction();
1576 FunctionType *FT = Callee->getFunctionType();
1577 // We require integer(integer) where the types agree.
1578 if (FT->getNumParams() != 1 || !FT->getReturnType()->isIntegerTy() ||
1579 FT->getParamType(0) != FT->getReturnType())
1580 return nullptr;
Meador Inge9a59ab62012-11-26 02:31:59 +00001581
Chris Bienemanad070d02014-09-17 20:55:46 +00001582 // abs(x) -> x >s -1 ? x : -x
1583 Value *Op = CI->getArgOperand(0);
1584 Value *Pos =
1585 B.CreateICmpSGT(Op, Constant::getAllOnesValue(Op->getType()), "ispos");
1586 Value *Neg = B.CreateNeg(Op, "neg");
1587 return B.CreateSelect(Pos, Op, Neg);
1588}
Meador Inge9a59ab62012-11-26 02:31:59 +00001589
Chris Bienemanad070d02014-09-17 20:55:46 +00001590Value *LibCallSimplifier::optimizeIsDigit(CallInst *CI, IRBuilder<> &B) {
Davide Italiano396f3ee2015-10-31 23:17:45 +00001591 if (!checkIntUnaryReturnAndParam(CI->getCalledFunction()))
Chris Bienemanad070d02014-09-17 20:55:46 +00001592 return nullptr;
Meador Ingea62a39e2012-11-26 03:10:07 +00001593
Chris Bienemanad070d02014-09-17 20:55:46 +00001594 // isdigit(c) -> (c-'0') <u 10
1595 Value *Op = CI->getArgOperand(0);
1596 Op = B.CreateSub(Op, B.getInt32('0'), "isdigittmp");
1597 Op = B.CreateICmpULT(Op, B.getInt32(10), "isdigit");
1598 return B.CreateZExt(Op, CI->getType());
1599}
Meador Ingea62a39e2012-11-26 03:10:07 +00001600
Chris Bienemanad070d02014-09-17 20:55:46 +00001601Value *LibCallSimplifier::optimizeIsAscii(CallInst *CI, IRBuilder<> &B) {
Davide Italiano396f3ee2015-10-31 23:17:45 +00001602 if (!checkIntUnaryReturnAndParam(CI->getCalledFunction()))
Chris Bienemanad070d02014-09-17 20:55:46 +00001603 return nullptr;
Meador Inge604937d2012-11-26 03:38:52 +00001604
Chris Bienemanad070d02014-09-17 20:55:46 +00001605 // isascii(c) -> c <u 128
1606 Value *Op = CI->getArgOperand(0);
1607 Op = B.CreateICmpULT(Op, B.getInt32(128), "isascii");
1608 return B.CreateZExt(Op, CI->getType());
1609}
1610
1611Value *LibCallSimplifier::optimizeToAscii(CallInst *CI, IRBuilder<> &B) {
Davide Italiano396f3ee2015-10-31 23:17:45 +00001612 if (!checkIntUnaryReturnAndParam(CI->getCalledFunction()))
Chris Bienemanad070d02014-09-17 20:55:46 +00001613 return nullptr;
1614
1615 // toascii(c) -> c & 0x7f
1616 return B.CreateAnd(CI->getArgOperand(0),
1617 ConstantInt::get(CI->getType(), 0x7F));
1618}
Meador Inge604937d2012-11-26 03:38:52 +00001619
Meador Inge08ca1152012-11-26 20:37:20 +00001620//===----------------------------------------------------------------------===//
1621// Formatting and IO Library Call Optimizations
1622//===----------------------------------------------------------------------===//
1623
Chris Bienemanad070d02014-09-17 20:55:46 +00001624static bool isReportingError(Function *Callee, CallInst *CI, int StreamArg);
Hal Finkel66cd3f12013-11-17 02:06:35 +00001625
Chris Bienemanad070d02014-09-17 20:55:46 +00001626Value *LibCallSimplifier::optimizeErrorReporting(CallInst *CI, IRBuilder<> &B,
1627 int StreamArg) {
1628 // Error reporting calls should be cold, mark them as such.
1629 // This applies even to non-builtin calls: it is only a hint and applies to
1630 // functions that the frontend might not understand as builtins.
Hal Finkel66cd3f12013-11-17 02:06:35 +00001631
Chris Bienemanad070d02014-09-17 20:55:46 +00001632 // This heuristic was suggested in:
1633 // Improving Static Branch Prediction in a Compiler
1634 // Brian L. Deitrich, Ben-Chung Cheng, Wen-mei W. Hwu
1635 // Proceedings of PACT'98, Oct. 1998, IEEE
1636 Function *Callee = CI->getCalledFunction();
Hal Finkel66cd3f12013-11-17 02:06:35 +00001637
Chris Bienemanad070d02014-09-17 20:55:46 +00001638 if (!CI->hasFnAttr(Attribute::Cold) &&
1639 isReportingError(Callee, CI, StreamArg)) {
1640 CI->addAttribute(AttributeSet::FunctionIndex, Attribute::Cold);
1641 }
Hal Finkel66cd3f12013-11-17 02:06:35 +00001642
Chris Bienemanad070d02014-09-17 20:55:46 +00001643 return nullptr;
1644}
1645
1646static bool isReportingError(Function *Callee, CallInst *CI, int StreamArg) {
Davide Italianoe84d4da2015-11-02 22:33:26 +00001647 if (!ColdErrorCalls || !Callee || !Callee->isDeclaration())
Chris Bienemanad070d02014-09-17 20:55:46 +00001648 return false;
1649
1650 if (StreamArg < 0)
1651 return true;
1652
1653 // These functions might be considered cold, but only if their stream
1654 // argument is stderr.
1655
1656 if (StreamArg >= (int)CI->getNumArgOperands())
1657 return false;
1658 LoadInst *LI = dyn_cast<LoadInst>(CI->getArgOperand(StreamArg));
1659 if (!LI)
1660 return false;
1661 GlobalVariable *GV = dyn_cast<GlobalVariable>(LI->getPointerOperand());
1662 if (!GV || !GV->isDeclaration())
1663 return false;
1664 return GV->getName() == "stderr";
1665}
1666
1667Value *LibCallSimplifier::optimizePrintFString(CallInst *CI, IRBuilder<> &B) {
1668 // Check for a fixed format string.
1669 StringRef FormatStr;
1670 if (!getConstantStringInfo(CI->getArgOperand(0), FormatStr))
Craig Topperf40110f2014-04-25 05:29:35 +00001671 return nullptr;
Hal Finkel66cd3f12013-11-17 02:06:35 +00001672
Chris Bienemanad070d02014-09-17 20:55:46 +00001673 // Empty format string -> noop.
1674 if (FormatStr.empty()) // Tolerate printf's declared void.
1675 return CI->use_empty() ? (Value *)CI : ConstantInt::get(CI->getType(), 0);
Hal Finkel66cd3f12013-11-17 02:06:35 +00001676
Chris Bienemanad070d02014-09-17 20:55:46 +00001677 // Do not do any of the following transformations if the printf return value
1678 // is used, in general the printf return value is not compatible with either
1679 // putchar() or puts().
1680 if (!CI->use_empty())
Craig Topperf40110f2014-04-25 05:29:35 +00001681 return nullptr;
Chris Bienemanad070d02014-09-17 20:55:46 +00001682
1683 // printf("x") -> putchar('x'), even for '%'.
1684 if (FormatStr.size() == 1) {
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001685 Value *Res = EmitPutChar(B.getInt32(FormatStr[0]), B, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +00001686 if (CI->use_empty() || !Res)
1687 return Res;
1688 return B.CreateIntCast(Res, CI->getType(), true);
Meador Inge08ca1152012-11-26 20:37:20 +00001689 }
1690
Chris Bienemanad070d02014-09-17 20:55:46 +00001691 // printf("foo\n") --> puts("foo")
1692 if (FormatStr[FormatStr.size() - 1] == '\n' &&
1693 FormatStr.find('%') == StringRef::npos) { // No format characters.
1694 // Create a string literal with no \n on it. We expect the constant merge
1695 // pass to be run after this pass, to merge duplicate strings.
1696 FormatStr = FormatStr.drop_back();
1697 Value *GV = B.CreateGlobalString(FormatStr, "str");
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001698 Value *NewCI = EmitPutS(GV, B, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +00001699 return (CI->use_empty() || !NewCI)
1700 ? NewCI
1701 : ConstantInt::get(CI->getType(), FormatStr.size() + 1);
1702 }
Meador Inge08ca1152012-11-26 20:37:20 +00001703
Chris Bienemanad070d02014-09-17 20:55:46 +00001704 // Optimize specific format strings.
1705 // printf("%c", chr) --> putchar(chr)
1706 if (FormatStr == "%c" && CI->getNumArgOperands() > 1 &&
1707 CI->getArgOperand(1)->getType()->isIntegerTy()) {
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001708 Value *Res = EmitPutChar(CI->getArgOperand(1), B, TLI);
Meador Inge08ca1152012-11-26 20:37:20 +00001709
Chris Bienemanad070d02014-09-17 20:55:46 +00001710 if (CI->use_empty() || !Res)
1711 return Res;
1712 return B.CreateIntCast(Res, CI->getType(), true);
1713 }
1714
1715 // printf("%s\n", str) --> puts(str)
1716 if (FormatStr == "%s\n" && CI->getNumArgOperands() > 1 &&
1717 CI->getArgOperand(1)->getType()->isPointerTy()) {
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001718 return EmitPutS(CI->getArgOperand(1), B, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +00001719 }
1720 return nullptr;
1721}
1722
1723Value *LibCallSimplifier::optimizePrintF(CallInst *CI, IRBuilder<> &B) {
1724
1725 Function *Callee = CI->getCalledFunction();
1726 // Require one fixed pointer argument and an integer/void result.
1727 FunctionType *FT = Callee->getFunctionType();
1728 if (FT->getNumParams() < 1 || !FT->getParamType(0)->isPointerTy() ||
1729 !(FT->getReturnType()->isIntegerTy() || FT->getReturnType()->isVoidTy()))
1730 return nullptr;
1731
1732 if (Value *V = optimizePrintFString(CI, B)) {
1733 return V;
1734 }
1735
1736 // printf(format, ...) -> iprintf(format, ...) if no floating point
1737 // arguments.
1738 if (TLI->has(LibFunc::iprintf) && !callHasFloatingPointArgument(CI)) {
1739 Module *M = B.GetInsertBlock()->getParent()->getParent();
1740 Constant *IPrintFFn =
Meador Inge08ca1152012-11-26 20:37:20 +00001741 M->getOrInsertFunction("iprintf", FT, Callee->getAttributes());
Chris Bienemanad070d02014-09-17 20:55:46 +00001742 CallInst *New = cast<CallInst>(CI->clone());
1743 New->setCalledFunction(IPrintFFn);
1744 B.Insert(New);
1745 return New;
Meador Inge08ca1152012-11-26 20:37:20 +00001746 }
Chris Bienemanad070d02014-09-17 20:55:46 +00001747 return nullptr;
1748}
Meador Inge08ca1152012-11-26 20:37:20 +00001749
Chris Bienemanad070d02014-09-17 20:55:46 +00001750Value *LibCallSimplifier::optimizeSPrintFString(CallInst *CI, IRBuilder<> &B) {
1751 // Check for a fixed format string.
1752 StringRef FormatStr;
1753 if (!getConstantStringInfo(CI->getArgOperand(1), FormatStr))
Craig Topperf40110f2014-04-25 05:29:35 +00001754 return nullptr;
Meador Inge25c9b3b2012-11-27 05:57:54 +00001755
Chris Bienemanad070d02014-09-17 20:55:46 +00001756 // If we just have a format string (nothing else crazy) transform it.
1757 if (CI->getNumArgOperands() == 2) {
1758 // Make sure there's no % in the constant array. We could try to handle
1759 // %% -> % in the future if we cared.
1760 for (unsigned i = 0, e = FormatStr.size(); i != e; ++i)
1761 if (FormatStr[i] == '%')
1762 return nullptr; // we found a format specifier, bail out.
Hal Finkel66cd3f12013-11-17 02:06:35 +00001763
Chris Bienemanad070d02014-09-17 20:55:46 +00001764 // sprintf(str, fmt) -> llvm.memcpy(str, fmt, strlen(fmt)+1, 1)
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001765 B.CreateMemCpy(CI->getArgOperand(0), CI->getArgOperand(1),
1766 ConstantInt::get(DL.getIntPtrType(CI->getContext()),
1767 FormatStr.size() + 1),
1768 1); // Copy the null byte.
Chris Bienemanad070d02014-09-17 20:55:46 +00001769 return ConstantInt::get(CI->getType(), FormatStr.size());
Meador Ingef8e72502012-11-29 15:45:43 +00001770 }
Meador Ingef8e72502012-11-29 15:45:43 +00001771
Chris Bienemanad070d02014-09-17 20:55:46 +00001772 // The remaining optimizations require the format string to be "%s" or "%c"
1773 // and have an extra operand.
1774 if (FormatStr.size() != 2 || FormatStr[0] != '%' ||
1775 CI->getNumArgOperands() < 3)
Craig Topperf40110f2014-04-25 05:29:35 +00001776 return nullptr;
Meador Inge75798bb2012-11-29 19:15:17 +00001777
Chris Bienemanad070d02014-09-17 20:55:46 +00001778 // Decode the second character of the format string.
1779 if (FormatStr[1] == 'c') {
1780 // sprintf(dst, "%c", chr) --> *(i8*)dst = chr; *((i8*)dst+1) = 0
1781 if (!CI->getArgOperand(2)->getType()->isIntegerTy())
1782 return nullptr;
1783 Value *V = B.CreateTrunc(CI->getArgOperand(2), B.getInt8Ty(), "char");
1784 Value *Ptr = CastToCStr(CI->getArgOperand(0), B);
1785 B.CreateStore(V, Ptr);
David Blaikie3909da72015-03-30 20:42:56 +00001786 Ptr = B.CreateGEP(B.getInt8Ty(), Ptr, B.getInt32(1), "nul");
Chris Bienemanad070d02014-09-17 20:55:46 +00001787 B.CreateStore(B.getInt8(0), Ptr);
Meador Ingedf796f82012-10-13 16:45:24 +00001788
Chris Bienemanad070d02014-09-17 20:55:46 +00001789 return ConstantInt::get(CI->getType(), 1);
Meador Ingedf796f82012-10-13 16:45:24 +00001790 }
1791
Chris Bienemanad070d02014-09-17 20:55:46 +00001792 if (FormatStr[1] == 's') {
Chris Bienemanad070d02014-09-17 20:55:46 +00001793 // sprintf(dest, "%s", str) -> llvm.memcpy(dest, str, strlen(str)+1, 1)
1794 if (!CI->getArgOperand(2)->getType()->isPointerTy())
1795 return nullptr;
1796
1797 Value *Len = EmitStrLen(CI->getArgOperand(2), B, DL, TLI);
1798 if (!Len)
1799 return nullptr;
1800 Value *IncLen =
1801 B.CreateAdd(Len, ConstantInt::get(Len->getType(), 1), "leninc");
1802 B.CreateMemCpy(CI->getArgOperand(0), CI->getArgOperand(2), IncLen, 1);
1803
1804 // The sprintf result is the unincremented number of bytes in the string.
1805 return B.CreateIntCast(Len, CI->getType(), false);
1806 }
1807 return nullptr;
1808}
1809
1810Value *LibCallSimplifier::optimizeSPrintF(CallInst *CI, IRBuilder<> &B) {
1811 Function *Callee = CI->getCalledFunction();
1812 // Require two fixed pointer arguments and an integer result.
1813 FunctionType *FT = Callee->getFunctionType();
1814 if (FT->getNumParams() != 2 || !FT->getParamType(0)->isPointerTy() ||
1815 !FT->getParamType(1)->isPointerTy() ||
1816 !FT->getReturnType()->isIntegerTy())
1817 return nullptr;
1818
1819 if (Value *V = optimizeSPrintFString(CI, B)) {
1820 return V;
1821 }
1822
1823 // sprintf(str, format, ...) -> siprintf(str, format, ...) if no floating
1824 // point arguments.
1825 if (TLI->has(LibFunc::siprintf) && !callHasFloatingPointArgument(CI)) {
1826 Module *M = B.GetInsertBlock()->getParent()->getParent();
1827 Constant *SIPrintFFn =
1828 M->getOrInsertFunction("siprintf", FT, Callee->getAttributes());
1829 CallInst *New = cast<CallInst>(CI->clone());
1830 New->setCalledFunction(SIPrintFFn);
1831 B.Insert(New);
1832 return New;
1833 }
1834 return nullptr;
1835}
1836
1837Value *LibCallSimplifier::optimizeFPrintFString(CallInst *CI, IRBuilder<> &B) {
1838 optimizeErrorReporting(CI, B, 0);
1839
1840 // All the optimizations depend on the format string.
1841 StringRef FormatStr;
1842 if (!getConstantStringInfo(CI->getArgOperand(1), FormatStr))
1843 return nullptr;
1844
1845 // Do not do any of the following transformations if the fprintf return
1846 // value is used, in general the fprintf return value is not compatible
1847 // with fwrite(), fputc() or fputs().
1848 if (!CI->use_empty())
1849 return nullptr;
1850
1851 // fprintf(F, "foo") --> fwrite("foo", 3, 1, F)
1852 if (CI->getNumArgOperands() == 2) {
1853 for (unsigned i = 0, e = FormatStr.size(); i != e; ++i)
1854 if (FormatStr[i] == '%') // Could handle %% -> % if we cared.
1855 return nullptr; // We found a format specifier.
1856
Chris Bienemanad070d02014-09-17 20:55:46 +00001857 return EmitFWrite(
1858 CI->getArgOperand(1),
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001859 ConstantInt::get(DL.getIntPtrType(CI->getContext()), FormatStr.size()),
Chris Bienemanad070d02014-09-17 20:55:46 +00001860 CI->getArgOperand(0), B, DL, TLI);
1861 }
1862
1863 // The remaining optimizations require the format string to be "%s" or "%c"
1864 // and have an extra operand.
1865 if (FormatStr.size() != 2 || FormatStr[0] != '%' ||
1866 CI->getNumArgOperands() < 3)
1867 return nullptr;
1868
1869 // Decode the second character of the format string.
1870 if (FormatStr[1] == 'c') {
1871 // fprintf(F, "%c", chr) --> fputc(chr, F)
1872 if (!CI->getArgOperand(2)->getType()->isIntegerTy())
1873 return nullptr;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001874 return EmitFPutC(CI->getArgOperand(2), CI->getArgOperand(0), B, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +00001875 }
1876
1877 if (FormatStr[1] == 's') {
1878 // fprintf(F, "%s", str) --> fputs(str, F)
1879 if (!CI->getArgOperand(2)->getType()->isPointerTy())
1880 return nullptr;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001881 return EmitFPutS(CI->getArgOperand(2), CI->getArgOperand(0), B, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +00001882 }
1883 return nullptr;
1884}
1885
1886Value *LibCallSimplifier::optimizeFPrintF(CallInst *CI, IRBuilder<> &B) {
1887 Function *Callee = CI->getCalledFunction();
1888 // Require two fixed paramters as pointers and integer result.
1889 FunctionType *FT = Callee->getFunctionType();
1890 if (FT->getNumParams() != 2 || !FT->getParamType(0)->isPointerTy() ||
1891 !FT->getParamType(1)->isPointerTy() ||
1892 !FT->getReturnType()->isIntegerTy())
1893 return nullptr;
1894
1895 if (Value *V = optimizeFPrintFString(CI, B)) {
1896 return V;
1897 }
1898
1899 // fprintf(stream, format, ...) -> fiprintf(stream, format, ...) if no
1900 // floating point arguments.
1901 if (TLI->has(LibFunc::fiprintf) && !callHasFloatingPointArgument(CI)) {
1902 Module *M = B.GetInsertBlock()->getParent()->getParent();
1903 Constant *FIPrintFFn =
1904 M->getOrInsertFunction("fiprintf", FT, Callee->getAttributes());
1905 CallInst *New = cast<CallInst>(CI->clone());
1906 New->setCalledFunction(FIPrintFFn);
1907 B.Insert(New);
1908 return New;
1909 }
1910 return nullptr;
1911}
1912
1913Value *LibCallSimplifier::optimizeFWrite(CallInst *CI, IRBuilder<> &B) {
1914 optimizeErrorReporting(CI, B, 3);
1915
1916 Function *Callee = CI->getCalledFunction();
1917 // Require a pointer, an integer, an integer, a pointer, returning integer.
1918 FunctionType *FT = Callee->getFunctionType();
1919 if (FT->getNumParams() != 4 || !FT->getParamType(0)->isPointerTy() ||
1920 !FT->getParamType(1)->isIntegerTy() ||
1921 !FT->getParamType(2)->isIntegerTy() ||
1922 !FT->getParamType(3)->isPointerTy() ||
1923 !FT->getReturnType()->isIntegerTy())
1924 return nullptr;
1925
1926 // Get the element size and count.
1927 ConstantInt *SizeC = dyn_cast<ConstantInt>(CI->getArgOperand(1));
1928 ConstantInt *CountC = dyn_cast<ConstantInt>(CI->getArgOperand(2));
1929 if (!SizeC || !CountC)
1930 return nullptr;
1931 uint64_t Bytes = SizeC->getZExtValue() * CountC->getZExtValue();
1932
1933 // If this is writing zero records, remove the call (it's a noop).
1934 if (Bytes == 0)
1935 return ConstantInt::get(CI->getType(), 0);
1936
1937 // If this is writing one byte, turn it into fputc.
1938 // This optimisation is only valid, if the return value is unused.
1939 if (Bytes == 1 && CI->use_empty()) { // fwrite(S,1,1,F) -> fputc(S[0],F)
1940 Value *Char = B.CreateLoad(CastToCStr(CI->getArgOperand(0), B), "char");
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001941 Value *NewCI = EmitFPutC(Char, CI->getArgOperand(3), B, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +00001942 return NewCI ? ConstantInt::get(CI->getType(), 1) : nullptr;
1943 }
1944
1945 return nullptr;
1946}
1947
1948Value *LibCallSimplifier::optimizeFPuts(CallInst *CI, IRBuilder<> &B) {
1949 optimizeErrorReporting(CI, B, 1);
1950
1951 Function *Callee = CI->getCalledFunction();
1952
Chris Bienemanad070d02014-09-17 20:55:46 +00001953 // Require two pointers. Also, we can't optimize if return value is used.
1954 FunctionType *FT = Callee->getFunctionType();
1955 if (FT->getNumParams() != 2 || !FT->getParamType(0)->isPointerTy() ||
1956 !FT->getParamType(1)->isPointerTy() || !CI->use_empty())
1957 return nullptr;
1958
1959 // fputs(s,F) --> fwrite(s,1,strlen(s),F)
1960 uint64_t Len = GetStringLength(CI->getArgOperand(0));
1961 if (!Len)
1962 return nullptr;
1963
1964 // Known to have no uses (see above).
1965 return EmitFWrite(
1966 CI->getArgOperand(0),
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001967 ConstantInt::get(DL.getIntPtrType(CI->getContext()), Len - 1),
Chris Bienemanad070d02014-09-17 20:55:46 +00001968 CI->getArgOperand(1), B, DL, TLI);
1969}
1970
1971Value *LibCallSimplifier::optimizePuts(CallInst *CI, IRBuilder<> &B) {
1972 Function *Callee = CI->getCalledFunction();
1973 // Require one fixed pointer argument and an integer/void result.
1974 FunctionType *FT = Callee->getFunctionType();
1975 if (FT->getNumParams() < 1 || !FT->getParamType(0)->isPointerTy() ||
1976 !(FT->getReturnType()->isIntegerTy() || FT->getReturnType()->isVoidTy()))
1977 return nullptr;
1978
1979 // Check for a constant string.
1980 StringRef Str;
1981 if (!getConstantStringInfo(CI->getArgOperand(0), Str))
1982 return nullptr;
1983
1984 if (Str.empty() && CI->use_empty()) {
1985 // puts("") -> putchar('\n')
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001986 Value *Res = EmitPutChar(B.getInt32('\n'), B, TLI);
Chris Bienemanad070d02014-09-17 20:55:46 +00001987 if (CI->use_empty() || !Res)
1988 return Res;
1989 return B.CreateIntCast(Res, CI->getType(), true);
1990 }
1991
1992 return nullptr;
1993}
1994
1995bool LibCallSimplifier::hasFloatVersion(StringRef FuncName) {
Meador Inge20255ef2013-03-12 00:08:29 +00001996 LibFunc::Func Func;
1997 SmallString<20> FloatFuncName = FuncName;
1998 FloatFuncName += 'f';
1999 if (TLI->getLibFunc(FloatFuncName, Func))
2000 return TLI->has(Func);
2001 return false;
2002}
Meador Inge7fb2f732012-10-13 16:45:32 +00002003
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002004Value *LibCallSimplifier::optimizeStringMemoryLibCall(CallInst *CI,
2005 IRBuilder<> &Builder) {
2006 LibFunc::Func Func;
2007 Function *Callee = CI->getCalledFunction();
2008 StringRef FuncName = Callee->getName();
2009
2010 // Check for string/memory library functions.
2011 if (TLI->getLibFunc(FuncName, Func) && TLI->has(Func)) {
2012 // Make sure we never change the calling convention.
2013 assert((ignoreCallingConv(Func) ||
2014 CI->getCallingConv() == llvm::CallingConv::C) &&
2015 "Optimizing string/memory libcall would change the calling convention");
2016 switch (Func) {
2017 case LibFunc::strcat:
2018 return optimizeStrCat(CI, Builder);
2019 case LibFunc::strncat:
2020 return optimizeStrNCat(CI, Builder);
2021 case LibFunc::strchr:
2022 return optimizeStrChr(CI, Builder);
2023 case LibFunc::strrchr:
2024 return optimizeStrRChr(CI, Builder);
2025 case LibFunc::strcmp:
2026 return optimizeStrCmp(CI, Builder);
2027 case LibFunc::strncmp:
2028 return optimizeStrNCmp(CI, Builder);
2029 case LibFunc::strcpy:
2030 return optimizeStrCpy(CI, Builder);
2031 case LibFunc::stpcpy:
2032 return optimizeStpCpy(CI, Builder);
2033 case LibFunc::strncpy:
2034 return optimizeStrNCpy(CI, Builder);
2035 case LibFunc::strlen:
2036 return optimizeStrLen(CI, Builder);
2037 case LibFunc::strpbrk:
2038 return optimizeStrPBrk(CI, Builder);
2039 case LibFunc::strtol:
2040 case LibFunc::strtod:
2041 case LibFunc::strtof:
2042 case LibFunc::strtoul:
2043 case LibFunc::strtoll:
2044 case LibFunc::strtold:
2045 case LibFunc::strtoull:
2046 return optimizeStrTo(CI, Builder);
2047 case LibFunc::strspn:
2048 return optimizeStrSpn(CI, Builder);
2049 case LibFunc::strcspn:
2050 return optimizeStrCSpn(CI, Builder);
2051 case LibFunc::strstr:
2052 return optimizeStrStr(CI, Builder);
Benjamin Kramer691363e2015-03-21 15:36:21 +00002053 case LibFunc::memchr:
2054 return optimizeMemChr(CI, Builder);
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002055 case LibFunc::memcmp:
2056 return optimizeMemCmp(CI, Builder);
2057 case LibFunc::memcpy:
2058 return optimizeMemCpy(CI, Builder);
2059 case LibFunc::memmove:
2060 return optimizeMemMove(CI, Builder);
2061 case LibFunc::memset:
2062 return optimizeMemSet(CI, Builder);
2063 default:
2064 break;
2065 }
2066 }
2067 return nullptr;
2068}
2069
Chris Bienemanad070d02014-09-17 20:55:46 +00002070Value *LibCallSimplifier::optimizeCall(CallInst *CI) {
2071 if (CI->isNoBuiltin())
2072 return nullptr;
Meador Inge4d2827c2012-11-11 05:11:20 +00002073
Meador Inge20255ef2013-03-12 00:08:29 +00002074 LibFunc::Func Func;
2075 Function *Callee = CI->getCalledFunction();
2076 StringRef FuncName = Callee->getName();
Chris Bienemanad070d02014-09-17 20:55:46 +00002077 IRBuilder<> Builder(CI);
2078 bool isCallingConvC = CI->getCallingConv() == llvm::CallingConv::C;
Meador Inge20255ef2013-03-12 00:08:29 +00002079
Sanjay Patela92fa442014-10-22 15:29:23 +00002080 // Command-line parameter overrides function attribute.
2081 if (EnableUnsafeFPShrink.getNumOccurrences() > 0)
2082 UnsafeFPShrink = EnableUnsafeFPShrink;
Davide Italianoa904e522015-10-29 02:58:44 +00002083 else if (canUseUnsafeFPMath(Callee))
2084 UnsafeFPShrink = true;
Sanjay Patela92fa442014-10-22 15:29:23 +00002085
Sanjay Patel848309d2014-10-23 21:52:45 +00002086 // First, check for intrinsics.
Meador Inge20255ef2013-03-12 00:08:29 +00002087 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(CI)) {
Chris Bienemanad070d02014-09-17 20:55:46 +00002088 if (!isCallingConvC)
2089 return nullptr;
Meador Inge20255ef2013-03-12 00:08:29 +00002090 switch (II->getIntrinsicID()) {
2091 case Intrinsic::pow:
Chris Bienemanad070d02014-09-17 20:55:46 +00002092 return optimizePow(CI, Builder);
Meador Inge20255ef2013-03-12 00:08:29 +00002093 case Intrinsic::exp2:
Chris Bienemanad070d02014-09-17 20:55:46 +00002094 return optimizeExp2(CI, Builder);
Sanjay Patel0ca42bb2014-10-14 20:43:11 +00002095 case Intrinsic::fabs:
2096 return optimizeFabs(CI, Builder);
Sanjay Patelc699a612014-10-16 18:48:17 +00002097 case Intrinsic::sqrt:
2098 return optimizeSqrt(CI, Builder);
Meador Inge20255ef2013-03-12 00:08:29 +00002099 default:
Chris Bienemanad070d02014-09-17 20:55:46 +00002100 return nullptr;
Meador Inge20255ef2013-03-12 00:08:29 +00002101 }
2102 }
2103
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002104 // Also try to simplify calls to fortified library functions.
2105 if (Value *SimplifiedFortifiedCI = FortifiedSimplifier.optimizeCall(CI)) {
2106 // Try to further simplify the result.
Ahmed Bougacha71d7b182015-01-14 00:55:05 +00002107 CallInst *SimplifiedCI = dyn_cast<CallInst>(SimplifiedFortifiedCI);
Bruno Cardoso Lopesb491a2d2015-10-01 22:43:53 +00002108 if (SimplifiedCI && SimplifiedCI->getCalledFunction()) {
2109 // Use an IR Builder from SimplifiedCI if available instead of CI
2110 // to guarantee we reach all uses we might replace later on.
2111 IRBuilder<> TmpBuilder(SimplifiedCI);
2112 if (Value *V = optimizeStringMemoryLibCall(SimplifiedCI, TmpBuilder)) {
Ahmed Bougacha1ac93562015-01-27 21:52:16 +00002113 // If we were able to further simplify, remove the now redundant call.
2114 SimplifiedCI->replaceAllUsesWith(V);
2115 SimplifiedCI->eraseFromParent();
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002116 return V;
Ahmed Bougacha1ac93562015-01-27 21:52:16 +00002117 }
Bruno Cardoso Lopesb491a2d2015-10-01 22:43:53 +00002118 }
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002119 return SimplifiedFortifiedCI;
2120 }
2121
Meador Inge20255ef2013-03-12 00:08:29 +00002122 // Then check for known library functions.
2123 if (TLI->getLibFunc(FuncName, Func) && TLI->has(Func)) {
Chris Bienemanad070d02014-09-17 20:55:46 +00002124 // We never change the calling convention.
2125 if (!ignoreCallingConv(Func) && !isCallingConvC)
2126 return nullptr;
Ahmed Bougacha6722f5e2015-01-12 17:20:06 +00002127 if (Value *V = optimizeStringMemoryLibCall(CI, Builder))
2128 return V;
Meador Inge20255ef2013-03-12 00:08:29 +00002129 switch (Func) {
Chris Bienemanad070d02014-09-17 20:55:46 +00002130 case LibFunc::cosf:
2131 case LibFunc::cos:
2132 case LibFunc::cosl:
2133 return optimizeCos(CI, Builder);
2134 case LibFunc::sinpif:
2135 case LibFunc::sinpi:
2136 case LibFunc::cospif:
2137 case LibFunc::cospi:
2138 return optimizeSinCosPi(CI, Builder);
2139 case LibFunc::powf:
2140 case LibFunc::pow:
2141 case LibFunc::powl:
2142 return optimizePow(CI, Builder);
2143 case LibFunc::exp2l:
2144 case LibFunc::exp2:
2145 case LibFunc::exp2f:
2146 return optimizeExp2(CI, Builder);
Sanjay Patel0ca42bb2014-10-14 20:43:11 +00002147 case LibFunc::fabsf:
2148 case LibFunc::fabs:
2149 case LibFunc::fabsl:
2150 return optimizeFabs(CI, Builder);
Sanjay Patelc699a612014-10-16 18:48:17 +00002151 case LibFunc::sqrtf:
2152 case LibFunc::sqrt:
2153 case LibFunc::sqrtl:
2154 return optimizeSqrt(CI, Builder);
Chris Bienemanad070d02014-09-17 20:55:46 +00002155 case LibFunc::ffs:
2156 case LibFunc::ffsl:
2157 case LibFunc::ffsll:
2158 return optimizeFFS(CI, Builder);
2159 case LibFunc::abs:
2160 case LibFunc::labs:
2161 case LibFunc::llabs:
2162 return optimizeAbs(CI, Builder);
2163 case LibFunc::isdigit:
2164 return optimizeIsDigit(CI, Builder);
2165 case LibFunc::isascii:
2166 return optimizeIsAscii(CI, Builder);
2167 case LibFunc::toascii:
2168 return optimizeToAscii(CI, Builder);
2169 case LibFunc::printf:
2170 return optimizePrintF(CI, Builder);
2171 case LibFunc::sprintf:
2172 return optimizeSPrintF(CI, Builder);
2173 case LibFunc::fprintf:
2174 return optimizeFPrintF(CI, Builder);
2175 case LibFunc::fwrite:
2176 return optimizeFWrite(CI, Builder);
2177 case LibFunc::fputs:
2178 return optimizeFPuts(CI, Builder);
2179 case LibFunc::puts:
2180 return optimizePuts(CI, Builder);
Davide Italiano51507d22015-11-04 23:36:56 +00002181 case LibFunc::tan:
2182 case LibFunc::tanf:
2183 case LibFunc::tanl:
2184 return optimizeTan(CI, Builder);
Chris Bienemanad070d02014-09-17 20:55:46 +00002185 case LibFunc::perror:
2186 return optimizeErrorReporting(CI, Builder);
2187 case LibFunc::vfprintf:
2188 case LibFunc::fiprintf:
2189 return optimizeErrorReporting(CI, Builder, 0);
2190 case LibFunc::fputc:
2191 return optimizeErrorReporting(CI, Builder, 1);
2192 case LibFunc::ceil:
Chris Bienemanad070d02014-09-17 20:55:46 +00002193 case LibFunc::floor:
2194 case LibFunc::rint:
2195 case LibFunc::round:
2196 case LibFunc::nearbyint:
2197 case LibFunc::trunc:
2198 if (hasFloatVersion(FuncName))
2199 return optimizeUnaryDoubleFP(CI, Builder, false);
2200 return nullptr;
2201 case LibFunc::acos:
2202 case LibFunc::acosh:
2203 case LibFunc::asin:
2204 case LibFunc::asinh:
2205 case LibFunc::atan:
2206 case LibFunc::atanh:
2207 case LibFunc::cbrt:
2208 case LibFunc::cosh:
2209 case LibFunc::exp:
2210 case LibFunc::exp10:
2211 case LibFunc::expm1:
2212 case LibFunc::log:
2213 case LibFunc::log10:
2214 case LibFunc::log1p:
2215 case LibFunc::log2:
2216 case LibFunc::logb:
2217 case LibFunc::sin:
2218 case LibFunc::sinh:
Chris Bienemanad070d02014-09-17 20:55:46 +00002219 case LibFunc::tanh:
2220 if (UnsafeFPShrink && hasFloatVersion(FuncName))
2221 return optimizeUnaryDoubleFP(CI, Builder, true);
2222 return nullptr;
Matthias Braun892c9232014-12-03 21:46:29 +00002223 case LibFunc::copysign:
Chris Bienemanad070d02014-09-17 20:55:46 +00002224 if (hasFloatVersion(FuncName))
2225 return optimizeBinaryDoubleFP(CI, Builder);
2226 return nullptr;
Sanjay Patel57fd1dc2015-08-16 20:18:19 +00002227 case LibFunc::fminf:
2228 case LibFunc::fmin:
2229 case LibFunc::fminl:
2230 case LibFunc::fmaxf:
2231 case LibFunc::fmax:
2232 case LibFunc::fmaxl:
2233 return optimizeFMinFMax(CI, Builder);
Chris Bienemanad070d02014-09-17 20:55:46 +00002234 default:
2235 return nullptr;
2236 }
Meador Inge20255ef2013-03-12 00:08:29 +00002237 }
Craig Topperf40110f2014-04-25 05:29:35 +00002238 return nullptr;
Meador Ingedf796f82012-10-13 16:45:24 +00002239}
2240
Chandler Carruth92803822015-01-21 02:11:59 +00002241LibCallSimplifier::LibCallSimplifier(
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002242 const DataLayout &DL, const TargetLibraryInfo *TLI,
Chandler Carruth92803822015-01-21 02:11:59 +00002243 function_ref<void(Instruction *, Value *)> Replacer)
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002244 : FortifiedSimplifier(TLI), DL(DL), TLI(TLI), UnsafeFPShrink(false),
Chandler Carruth92803822015-01-21 02:11:59 +00002245 Replacer(Replacer) {}
2246
2247void LibCallSimplifier::replaceAllUsesWith(Instruction *I, Value *With) {
2248 // Indirect through the replacer used in this instance.
2249 Replacer(I, With);
Meador Ingedf796f82012-10-13 16:45:24 +00002250}
2251
Meador Ingedfb08a22013-06-20 19:48:07 +00002252// TODO:
2253// Additional cases that we need to add to this file:
2254//
2255// cbrt:
2256// * cbrt(expN(X)) -> expN(x/3)
2257// * cbrt(sqrt(x)) -> pow(x,1/6)
David Majnemer3354fe42015-08-26 18:30:16 +00002258// * cbrt(cbrt(x)) -> pow(x,1/9)
Meador Ingedfb08a22013-06-20 19:48:07 +00002259//
2260// exp, expf, expl:
2261// * exp(log(x)) -> x
2262//
2263// log, logf, logl:
2264// * log(exp(x)) -> x
2265// * log(x**y) -> y*log(x)
2266// * log(exp(y)) -> y*log(e)
2267// * log(exp2(y)) -> y*log(2)
2268// * log(exp10(y)) -> y*log(10)
2269// * log(sqrt(x)) -> 0.5*log(x)
2270// * log(pow(x,y)) -> y*log(x)
2271//
2272// lround, lroundf, lroundl:
2273// * lround(cnst) -> cnst'
2274//
2275// pow, powf, powl:
2276// * pow(exp(x),y) -> exp(x*y)
2277// * pow(sqrt(x),y) -> pow(x,y*0.5)
2278// * pow(pow(x,y),z)-> pow(x,y*z)
2279//
2280// round, roundf, roundl:
2281// * round(cnst) -> cnst'
2282//
2283// signbit:
2284// * signbit(cnst) -> cnst'
2285// * signbit(nncst) -> 0 (if pstv is a non-negative constant)
2286//
2287// sqrt, sqrtf, sqrtl:
2288// * sqrt(expN(x)) -> expN(x*0.5)
2289// * sqrt(Nroot(x)) -> pow(x,1/(2*N))
2290// * sqrt(pow(x,y)) -> pow(|x|,y*0.5)
2291//
Meador Ingedfb08a22013-06-20 19:48:07 +00002292// tan, tanf, tanl:
2293// * tan(atan(x)) -> x
2294//
2295// trunc, truncf, truncl:
2296// * trunc(cnst) -> cnst'
2297//
2298//
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002299
2300//===----------------------------------------------------------------------===//
2301// Fortified Library Call Optimizations
2302//===----------------------------------------------------------------------===//
2303
2304bool FortifiedLibCallSimplifier::isFortifiedCallFoldable(CallInst *CI,
2305 unsigned ObjSizeOp,
2306 unsigned SizeOp,
2307 bool isString) {
2308 if (CI->getArgOperand(ObjSizeOp) == CI->getArgOperand(SizeOp))
2309 return true;
2310 if (ConstantInt *ObjSizeCI =
2311 dyn_cast<ConstantInt>(CI->getArgOperand(ObjSizeOp))) {
2312 if (ObjSizeCI->isAllOnesValue())
2313 return true;
2314 // If the object size wasn't -1 (unknown), bail out if we were asked to.
2315 if (OnlyLowerUnknownSize)
2316 return false;
2317 if (isString) {
2318 uint64_t Len = GetStringLength(CI->getArgOperand(SizeOp));
2319 // If the length is 0 we don't know how long it is and so we can't
2320 // remove the check.
2321 if (Len == 0)
2322 return false;
2323 return ObjSizeCI->getZExtValue() >= Len;
2324 }
2325 if (ConstantInt *SizeCI = dyn_cast<ConstantInt>(CI->getArgOperand(SizeOp)))
2326 return ObjSizeCI->getZExtValue() >= SizeCI->getZExtValue();
2327 }
2328 return false;
2329}
2330
2331Value *FortifiedLibCallSimplifier::optimizeMemCpyChk(CallInst *CI, IRBuilder<> &B) {
2332 Function *Callee = CI->getCalledFunction();
2333
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002334 if (!checkStringCopyLibFuncSignature(Callee, LibFunc::memcpy_chk))
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002335 return nullptr;
2336
2337 if (isFortifiedCallFoldable(CI, 3, 2, false)) {
2338 B.CreateMemCpy(CI->getArgOperand(0), CI->getArgOperand(1),
2339 CI->getArgOperand(2), 1);
2340 return CI->getArgOperand(0);
2341 }
2342 return nullptr;
2343}
2344
2345Value *FortifiedLibCallSimplifier::optimizeMemMoveChk(CallInst *CI, IRBuilder<> &B) {
2346 Function *Callee = CI->getCalledFunction();
2347
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002348 if (!checkStringCopyLibFuncSignature(Callee, LibFunc::memmove_chk))
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002349 return nullptr;
2350
2351 if (isFortifiedCallFoldable(CI, 3, 2, false)) {
2352 B.CreateMemMove(CI->getArgOperand(0), CI->getArgOperand(1),
2353 CI->getArgOperand(2), 1);
2354 return CI->getArgOperand(0);
2355 }
2356 return nullptr;
2357}
2358
2359Value *FortifiedLibCallSimplifier::optimizeMemSetChk(CallInst *CI, IRBuilder<> &B) {
2360 Function *Callee = CI->getCalledFunction();
2361
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002362 if (!checkStringCopyLibFuncSignature(Callee, LibFunc::memset_chk))
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002363 return nullptr;
2364
2365 if (isFortifiedCallFoldable(CI, 3, 2, false)) {
2366 Value *Val = B.CreateIntCast(CI->getArgOperand(1), B.getInt8Ty(), false);
2367 B.CreateMemSet(CI->getArgOperand(0), Val, CI->getArgOperand(2), 1);
2368 return CI->getArgOperand(0);
2369 }
2370 return nullptr;
2371}
2372
Ahmed Bougacha1ac93562015-01-27 21:52:16 +00002373Value *FortifiedLibCallSimplifier::optimizeStrpCpyChk(CallInst *CI,
2374 IRBuilder<> &B,
2375 LibFunc::Func Func) {
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002376 Function *Callee = CI->getCalledFunction();
2377 StringRef Name = Callee->getName();
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002378 const DataLayout &DL = CI->getModule()->getDataLayout();
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002379
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002380 if (!checkStringCopyLibFuncSignature(Callee, Func))
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002381 return nullptr;
2382
2383 Value *Dst = CI->getArgOperand(0), *Src = CI->getArgOperand(1),
2384 *ObjSize = CI->getArgOperand(2);
2385
2386 // __stpcpy_chk(x,x,...) -> x+strlen(x)
Ahmed Bougacha1ac93562015-01-27 21:52:16 +00002387 if (Func == LibFunc::stpcpy_chk && !OnlyLowerUnknownSize && Dst == Src) {
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002388 Value *StrLen = EmitStrLen(Src, B, DL, TLI);
David Blaikieaa41cd52015-04-03 21:33:42 +00002389 return StrLen ? B.CreateInBoundsGEP(B.getInt8Ty(), Dst, StrLen) : nullptr;
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002390 }
2391
2392 // If a) we don't have any length information, or b) we know this will
2393 // fit then just lower to a plain st[rp]cpy. Otherwise we'll keep our
2394 // st[rp]cpy_chk call which may fail at runtime if the size is too long.
2395 // TODO: It might be nice to get a maximum length out of the possible
2396 // string lengths for varying.
David Blaikie65fab6d2015-04-03 21:32:06 +00002397 if (isFortifiedCallFoldable(CI, 2, 1, true))
2398 return EmitStrCpy(Dst, Src, B, TLI, Name.substr(2, 6));
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002399
David Blaikie65fab6d2015-04-03 21:32:06 +00002400 if (OnlyLowerUnknownSize)
2401 return nullptr;
2402
2403 // Maybe we can stil fold __st[rp]cpy_chk to __memcpy_chk.
2404 uint64_t Len = GetStringLength(Src);
2405 if (Len == 0)
2406 return nullptr;
2407
2408 Type *SizeTTy = DL.getIntPtrType(CI->getContext());
2409 Value *LenV = ConstantInt::get(SizeTTy, Len);
2410 Value *Ret = EmitMemCpyChk(Dst, Src, LenV, ObjSize, B, DL, TLI);
2411 // If the function was an __stpcpy_chk, and we were able to fold it into
2412 // a __memcpy_chk, we still need to return the correct end pointer.
2413 if (Ret && Func == LibFunc::stpcpy_chk)
2414 return B.CreateGEP(B.getInt8Ty(), Dst, ConstantInt::get(SizeTTy, Len - 1));
2415 return Ret;
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002416}
2417
Ahmed Bougacha1ac93562015-01-27 21:52:16 +00002418Value *FortifiedLibCallSimplifier::optimizeStrpNCpyChk(CallInst *CI,
2419 IRBuilder<> &B,
2420 LibFunc::Func Func) {
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002421 Function *Callee = CI->getCalledFunction();
2422 StringRef Name = Callee->getName();
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002423
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002424 if (!checkStringCopyLibFuncSignature(Callee, Func))
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002425 return nullptr;
2426 if (isFortifiedCallFoldable(CI, 3, 2, false)) {
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002427 Value *Ret = EmitStrNCpy(CI->getArgOperand(0), CI->getArgOperand(1),
2428 CI->getArgOperand(2), B, TLI, Name.substr(2, 7));
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002429 return Ret;
2430 }
2431 return nullptr;
2432}
2433
2434Value *FortifiedLibCallSimplifier::optimizeCall(CallInst *CI) {
Ahmed Bougacha408d0102015-04-01 00:45:09 +00002435 // FIXME: We shouldn't be changing "nobuiltin" or TLI unavailable calls here.
2436 // Some clang users checked for _chk libcall availability using:
2437 // __has_builtin(__builtin___memcpy_chk)
2438 // When compiling with -fno-builtin, this is always true.
2439 // When passing -ffreestanding/-mkernel, which both imply -fno-builtin, we
2440 // end up with fortified libcalls, which isn't acceptable in a freestanding
2441 // environment which only provides their non-fortified counterparts.
2442 //
2443 // Until we change clang and/or teach external users to check for availability
2444 // differently, disregard the "nobuiltin" attribute and TLI::has.
2445 //
2446 // PR23093.
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002447
2448 LibFunc::Func Func;
2449 Function *Callee = CI->getCalledFunction();
2450 StringRef FuncName = Callee->getName();
2451 IRBuilder<> Builder(CI);
2452 bool isCallingConvC = CI->getCallingConv() == llvm::CallingConv::C;
2453
2454 // First, check that this is a known library functions.
Ahmed Bougacha408d0102015-04-01 00:45:09 +00002455 if (!TLI->getLibFunc(FuncName, Func))
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002456 return nullptr;
2457
2458 // We never change the calling convention.
2459 if (!ignoreCallingConv(Func) && !isCallingConvC)
2460 return nullptr;
2461
2462 switch (Func) {
2463 case LibFunc::memcpy_chk:
2464 return optimizeMemCpyChk(CI, Builder);
2465 case LibFunc::memmove_chk:
2466 return optimizeMemMoveChk(CI, Builder);
2467 case LibFunc::memset_chk:
2468 return optimizeMemSetChk(CI, Builder);
2469 case LibFunc::stpcpy_chk:
2470 case LibFunc::strcpy_chk:
Ahmed Bougacha1ac93562015-01-27 21:52:16 +00002471 return optimizeStrpCpyChk(CI, Builder, Func);
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002472 case LibFunc::stpncpy_chk:
2473 case LibFunc::strncpy_chk:
Ahmed Bougacha1ac93562015-01-27 21:52:16 +00002474 return optimizeStrpNCpyChk(CI, Builder, Func);
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002475 default:
2476 break;
2477 }
2478 return nullptr;
2479}
2480
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002481FortifiedLibCallSimplifier::FortifiedLibCallSimplifier(
2482 const TargetLibraryInfo *TLI, bool OnlyLowerUnknownSize)
2483 : TLI(TLI), OnlyLowerUnknownSize(OnlyLowerUnknownSize) {}