LLVM 24.0.0git
SimplifyLibCalls.cpp
Go to the documentation of this file.
1//===------ SimplifyLibCalls.cpp - Library calls simplifier ---------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file implements the library calls simplifier. It does not implement
10// any pass, but can be used by other passes to do simplifications.
11//
12//===----------------------------------------------------------------------===//
13
15#include "llvm/ADT/APFloat.h"
16#include "llvm/ADT/APSInt.h"
20#include "llvm/Analysis/Loads.h"
26#include "llvm/IR/DataLayout.h"
27#include "llvm/IR/Function.h"
28#include "llvm/IR/IRBuilder.h"
30#include "llvm/IR/Intrinsics.h"
31#include "llvm/IR/Module.h"
42
43#include <cmath>
44
45using namespace llvm;
46using namespace PatternMatch;
47
48static cl::opt<bool>
49 EnableUnsafeFPShrink("enable-double-float-shrink", cl::Hidden,
50 cl::init(false),
51 cl::desc("Enable unsafe double to float "
52 "shrinking for math lib calls"));
53
54// Enable conversion of operator new calls with a MemProf hot or cold hint
55// to an operator new call that takes a hot/cold hint. Off by default since
56// not all allocators currently support this extension.
57static cl::opt<bool>
58 OptimizeHotColdNew("optimize-hot-cold-new", cl::Hidden, cl::init(false),
59 cl::desc("Enable hot/cold operator new library calls"));
61 "optimize-existing-hot-cold-new", cl::Hidden, cl::init(false),
63 "Enable optimization of existing hot/cold operator new library calls"));
65 "optimize-nobuiltin-hot-cold-new-new", cl::Hidden, cl::init(false),
66 cl::desc("Enable transformation of nobuiltin operator new library calls"));
67
68namespace {
69
70// Specialized parser to ensure the hint is an 8 bit value (we can't specify
71// uint8_t to opt<> as that is interpreted to mean that we are passing a char
72// option with a specific set of values.
73struct HotColdHintParser : public cl::parser<unsigned> {
74 HotColdHintParser(cl::Option &O) : cl::parser<unsigned>(O) {}
75
76 bool parse(cl::Option &O, StringRef ArgName, StringRef Arg, unsigned &Value) {
77 if (Arg.getAsInteger(0, Value))
78 return O.error("'" + Arg + "' value invalid for uint argument!");
79
80 if (Value > 255)
81 return O.error("'" + Arg + "' value must be in the range [0, 255]!");
82
83 return false;
84 }
85};
86
87} // end anonymous namespace
88
89// Hot/cold operator new takes an 8 bit hotness hint, where 0 is the coldest
90// and 255 is the hottest. Default to 1 value away from the coldest and hottest
91// hints, so that the compiler hinted allocations are slightly less strong than
92// manually inserted hints at the two extremes.
94 "cold-new-hint-value", cl::Hidden, cl::init(1),
95 cl::desc("Value to pass to hot/cold operator new for cold allocation"));
97 NotColdNewHintValue("notcold-new-hint-value", cl::Hidden, cl::init(128),
98 cl::desc("Value to pass to hot/cold operator new for "
99 "notcold (warm) allocation"));
101 "hot-new-hint-value", cl::Hidden, cl::init(254),
102 cl::desc("Value to pass to hot/cold operator new for hot allocation"));
104 "ambiguous-new-hint-value", cl::Hidden, cl::init(222),
105 cl::desc(
106 "Value to pass to hot/cold operator new for ambiguous allocation"));
107
108//===----------------------------------------------------------------------===//
109// Helper Functions
110//===----------------------------------------------------------------------===//
111
112static bool ignoreCallingConv(LibFunc Func) {
113 return Func == LibFunc_abs || Func == LibFunc_labs ||
114 Func == LibFunc_llabs || Func == LibFunc_strlen;
115}
116
117/// Return true if it is only used in equality comparisons with With.
119 for (User *U : V->users()) {
120 if (ICmpInst *IC = dyn_cast<ICmpInst>(U))
121 if (IC->isEquality() && IC->getOperand(1) == With)
122 continue;
123 // Unknown instruction.
124 return false;
125 }
126 return true;
127}
128
130 return any_of(CI->operands(), [](const Use &OI) {
131 return OI->getType()->isFloatingPointTy();
132 });
133}
134
135static bool callHasFP128Argument(const CallInst *CI) {
136 return any_of(CI->operands(), [](const Use &OI) {
137 return OI->getType()->isFP128Ty();
138 });
139}
140
141// Convert the entire string Str representing an integer in Base, up to
142// the terminating nul if present, to a constant according to the rules
143// of strtoul[l] or, when AsSigned is set, of strtol[l]. On success
144// return the result, otherwise null.
145// The function assumes the string is encoded in ASCII and carefully
146// avoids converting sequences (including "") that the corresponding
147// library call might fail and set errno for.
148static Value *convertStrToInt(CallInst *CI, StringRef &Str, Value *EndPtr,
149 uint64_t Base, bool AsSigned, IRBuilderBase &B) {
150 if (Base < 2 || Base > 36)
151 if (Base != 0)
152 // Fail for an invalid base (required by POSIX).
153 return nullptr;
154
155 // Current offset into the original string to reflect in EndPtr.
156 size_t Offset = 0;
157 // Strip leading whitespace.
158 for ( ; Offset != Str.size(); ++Offset)
159 if (!isSpace((unsigned char)Str[Offset])) {
160 Str = Str.substr(Offset);
161 break;
162 }
163
164 if (Str.empty())
165 // Fail for empty subject sequences (POSIX allows but doesn't require
166 // strtol[l]/strtoul[l] to fail with EINVAL).
167 return nullptr;
168
169 // Strip but remember the sign.
170 bool Negate = Str[0] == '-';
171 if (Str[0] == '-' || Str[0] == '+') {
172 Str = Str.drop_front();
173 if (Str.empty())
174 // Fail for a sign with nothing after it.
175 return nullptr;
176 ++Offset;
177 }
178
179 // Set Max to the absolute value of the minimum (for signed), or
180 // to the maximum (for unsigned) value representable in the type.
181 Type *RetTy = CI->getType();
182 unsigned NBits = RetTy->getPrimitiveSizeInBits();
183 uint64_t Max = AsSigned && Negate ? 1 : 0;
184 Max += AsSigned ? maxIntN(NBits) : maxUIntN(NBits);
185
186 // Autodetect Base if it's zero and consume the "0x" prefix.
187 if (Str.size() > 1) {
188 if (Str[0] == '0') {
189 if (toUpper((unsigned char)Str[1]) == 'X') {
190 if (Str.size() == 2 || (Base && Base != 16))
191 // Fail if Base doesn't allow the "0x" prefix or for the prefix
192 // alone that implementations like BSD set errno to EINVAL for.
193 return nullptr;
194
195 Str = Str.drop_front(2);
196 Offset += 2;
197 Base = 16;
198 }
199 else if (Base == 0)
200 Base = 8;
201 } else if (Base == 0)
202 Base = 10;
203 }
204 else if (Base == 0)
205 Base = 10;
206
207 // Convert the rest of the subject sequence, not including the sign,
208 // to its uint64_t representation (this assumes the source character
209 // set is ASCII).
210 uint64_t Result = 0;
211 for (unsigned i = 0; i != Str.size(); ++i) {
212 unsigned char DigVal = Str[i];
213 if (isDigit(DigVal))
214 DigVal = DigVal - '0';
215 else {
216 DigVal = toUpper(DigVal);
217 if (isAlpha(DigVal))
218 DigVal = DigVal - 'A' + 10;
219 else
220 return nullptr;
221 }
222
223 if (DigVal >= Base)
224 // Fail if the digit is not valid in the Base.
225 return nullptr;
226
227 // Add the digit and fail if the result is not representable in
228 // the (unsigned form of the) destination type.
229 bool VFlow;
230 Result = SaturatingMultiplyAdd(Result, Base, (uint64_t)DigVal, &VFlow);
231 if (VFlow || Result > Max)
232 return nullptr;
233 }
234
235 if (EndPtr) {
236 // Store the pointer to the end.
237 Value *Off = B.getInt64(Offset + Str.size());
238 Value *StrBeg = CI->getArgOperand(0);
239 Value *StrEnd = B.CreateInBoundsGEP(B.getInt8Ty(), StrBeg, Off, "endptr");
240 B.CreateStore(StrEnd, EndPtr);
241 }
242
243 if (Negate) {
244 // Unsigned negation doesn't overflow.
245 Result = -Result;
246 // For unsigned numbers, discard sign bits.
247 if (!AsSigned)
248 Result &= maxUIntN(NBits);
249 }
250
251 return ConstantInt::get(RetTy, Result, AsSigned);
252}
253
255 for (User *U : V->users()) {
256 if (ICmpInst *IC = dyn_cast<ICmpInst>(U))
257 if (Constant *C = dyn_cast<Constant>(IC->getOperand(1)))
258 if (C->isNullValue())
259 continue;
260 // Unknown instruction.
261 return false;
262 }
263 return true;
264}
265
266static bool canTransformToMemCmp(CallInst *CI, Value *Str, uint64_t Len,
267 const SimplifyQuery &SQ) {
269 return false;
270
271 if (!isDereferenceablePointer(Str, APInt(64, Len), SQ))
272 return false;
273
274 if (CI->getFunction()->hasFnAttribute(Attribute::SanitizeMemory))
275 return false;
276
277 return true;
278}
279
281 ArrayRef<unsigned> ArgNos,
282 uint64_t DereferenceableBytes) {
283 const Function *F = CI->getCaller();
284 if (!F)
285 return;
286 for (unsigned ArgNo : ArgNos) {
287 uint64_t DerefBytes = DereferenceableBytes;
288 unsigned AS = CI->getArgOperand(ArgNo)->getType()->getPointerAddressSpace();
289 if (!llvm::NullPointerIsDefined(F, AS) ||
290 CI->paramHasAttr(ArgNo, Attribute::NonNull))
291 DerefBytes = std::max(CI->getParamDereferenceableOrNullBytes(ArgNo),
292 DereferenceableBytes);
293
294 if (CI->getParamDereferenceableBytes(ArgNo) < DerefBytes) {
295 CI->removeParamAttr(ArgNo, Attribute::Dereferenceable);
296 if (!llvm::NullPointerIsDefined(F, AS) ||
297 CI->paramHasAttr(ArgNo, Attribute::NonNull))
298 CI->removeParamAttr(ArgNo, Attribute::DereferenceableOrNull);
300 CI->getContext(), DerefBytes));
301 }
302 }
303}
304
306 ArrayRef<unsigned> ArgNos) {
307 Function *F = CI->getCaller();
308 if (!F)
309 return;
310
311 for (unsigned ArgNo : ArgNos) {
312 if (!CI->paramHasAttr(ArgNo, Attribute::NoUndef))
313 CI->addParamAttr(ArgNo, Attribute::NoUndef);
314
315 if (!CI->paramHasAttr(ArgNo, Attribute::NonNull)) {
316 unsigned AS =
319 continue;
320 CI->addParamAttr(ArgNo, Attribute::NonNull);
321 }
322
323 annotateDereferenceableBytes(CI, ArgNo, 1);
324 }
325}
326
328 Value *Size, const DataLayout &DL) {
331 annotateDereferenceableBytes(CI, ArgNos, LenC->getZExtValue());
332 } else if (isKnownNonZero(Size, DL)) {
334 uint64_t X, Y;
335 uint64_t DerefMin = 1;
337 DerefMin = std::min(X, Y);
338 annotateDereferenceableBytes(CI, ArgNos, DerefMin);
339 }
340 }
341}
342
343// Copy CallInst "flags" like musttail, notail, and tail. Return New param for
344// easier chaining. Calls to emit* and B.createCall should probably be wrapped
345// in this function when New is created to replace Old. Callers should take
346// care to check Old.isMustTailCall() if they aren't replacing Old directly
347// with New.
348static Value *copyFlags(const CallInst &Old, Value *New) {
349 assert(!Old.isMustTailCall() && "do not copy musttail call flags");
350 assert(!Old.isNoTailCall() && "do not copy notail call flags");
351 if (auto *NewCI = dyn_cast_or_null<CallInst>(New))
352 NewCI->setTailCallKind(Old.getTailCallKind());
353 return New;
354}
355
356static Value *mergeAttributesAndFlags(CallInst *NewCI, const CallInst &Old) {
357 NewCI->setAttributes(AttributeList::get(
358 NewCI->getContext(), {NewCI->getAttributes(), Old.getAttributes()}));
359 NewCI->removeRetAttrs(AttributeFuncs::typeIncompatible(
360 NewCI->getType(), NewCI->getRetAttributes()));
361 for (unsigned I = 0; I < NewCI->arg_size(); ++I)
362 NewCI->removeParamAttrs(
363 I, AttributeFuncs::typeIncompatible(NewCI->getArgOperand(I)->getType(),
364 NewCI->getParamAttributes(I)));
365
366 return copyFlags(Old, NewCI);
367}
368
369// Helper to avoid truncating the length if size_t is 32-bits.
371 return Len >= Str.size() ? Str : Str.substr(0, Len);
372}
373
374//===----------------------------------------------------------------------===//
375// String and Memory Library Call Optimizations
376//===----------------------------------------------------------------------===//
377
378Value *LibCallSimplifier::optimizeStrCat(CallInst *CI, IRBuilderBase &B) {
379 // Extract some information from the instruction
380 Value *Dst = CI->getArgOperand(0);
381 Value *Src = CI->getArgOperand(1);
383
384 // See if we can get the length of the input string.
385 uint64_t Len = GetStringLength(Src);
386 if (Len)
388 else
389 return nullptr;
390 --Len; // Unbias length.
391
392 // Handle the simple, do-nothing case: strcat(x, "") -> x
393 if (Len == 0)
394 return Dst;
395
396 return copyFlags(*CI, emitStrLenMemCpy(Src, Dst, Len, B));
397}
398
399Value *LibCallSimplifier::emitStrLenMemCpy(Value *Src, Value *Dst, uint64_t Len,
400 IRBuilderBase &B) {
401 // We need to find the end of the destination string. That's where the
402 // memory is to be moved to. We just generate a call to strlen.
403 Value *DstLen = emitStrLen(Dst, B, DL, TLI);
404 if (!DstLen)
405 return nullptr;
406
407 // Now that we have the destination's length, we must index into the
408 // destination's pointer to get the actual memcpy destination (end of
409 // the string .. we're concatenating).
410 Value *CpyDst = B.CreateInBoundsGEP(B.getInt8Ty(), Dst, DstLen, "endptr");
411
412 // We have enough information to now generate the memcpy call to do the
413 // concatenation for us. Make a memcpy to copy the nul byte with align = 1.
414 B.CreateMemCpy(CpyDst, Align(1), Src, Align(1),
415 TLI->getAsSizeT(Len + 1, *B.GetInsertBlock()->getModule()));
416 return Dst;
417}
418
419Value *LibCallSimplifier::optimizeStrNCat(CallInst *CI, IRBuilderBase &B) {
420 // Extract some information from the instruction.
421 Value *Dst = CI->getArgOperand(0);
422 Value *Src = CI->getArgOperand(1);
423 Value *Size = CI->getArgOperand(2);
424 uint64_t Len;
426 if (isKnownNonZero(Size, DL))
428
429 // We don't do anything if length is not constant.
430 ConstantInt *LengthArg = dyn_cast<ConstantInt>(Size);
431 if (LengthArg) {
432 Len = LengthArg->getZExtValue();
433 // strncat(x, c, 0) -> x
434 if (!Len)
435 return Dst;
436 } else {
437 return nullptr;
438 }
439
440 // See if we can get the length of the input string.
441 uint64_t SrcLen = GetStringLength(Src);
442 if (SrcLen) {
443 annotateDereferenceableBytes(CI, 1, SrcLen);
444 --SrcLen; // Unbias length.
445 } else {
446 return nullptr;
447 }
448
449 // strncat(x, "", c) -> x
450 if (SrcLen == 0)
451 return Dst;
452
453 // We don't optimize this case.
454 if (Len < SrcLen)
455 return nullptr;
456
457 // strncat(x, s, c) -> strcat(x, s)
458 // s is constant so the strcat can be optimized further.
459 return copyFlags(*CI, emitStrLenMemCpy(Src, Dst, SrcLen, B));
460}
461
462// Helper to transform memchr(S, C, N) == S to N && *S == C and, when
463// NBytes is null, strchr(S, C) to *S == C. A precondition of the function
464// is that either S is dereferenceable or the value of N is nonzero.
466 IRBuilderBase &B, const DataLayout &DL)
467{
468 Value *Src = CI->getArgOperand(0);
469 Value *CharVal = CI->getArgOperand(1);
470
471 // Fold memchr(A, C, N) == A to N && *A == C.
472 Type *CharTy = B.getInt8Ty();
473 Value *Char0 = B.CreateLoad(CharTy, Src);
474 CharVal = B.CreateTrunc(CharVal, CharTy);
475 Value *Cmp = B.CreateICmpEQ(Char0, CharVal, "char0cmp");
476
477 if (NBytes) {
478 Value *Zero = ConstantInt::get(NBytes->getType(), 0);
479 Value *And = B.CreateICmpNE(NBytes, Zero);
480 Cmp = B.CreateLogicalAnd(And, Cmp);
481 }
482
483 Value *NullPtr = Constant::getNullValue(CI->getType());
484 return B.CreateSelect(Cmp, Src, NullPtr);
485}
486
487Value *LibCallSimplifier::optimizeStrChr(CallInst *CI, IRBuilderBase &B) {
488 Value *SrcStr = CI->getArgOperand(0);
489 Value *CharVal = CI->getArgOperand(1);
491
492 if (isOnlyUsedInEqualityComparison(CI, SrcStr))
493 return memChrToCharCompare(CI, nullptr, B, DL);
494
495 // If the second operand is non-constant, see if we can compute the length
496 // of the input string and turn this into memchr.
497 ConstantInt *CharC = dyn_cast<ConstantInt>(CharVal);
498 if (!CharC) {
499 uint64_t Len = GetStringLength(SrcStr);
500 if (Len)
502 else
503 return nullptr;
504
506 FunctionType *FT = Callee->getFunctionType();
507 unsigned IntBits = TLI->getIntSize();
508 if (!FT->getParamType(1)->isIntegerTy(IntBits)) // memchr needs 'int'.
509 return nullptr;
510
511 unsigned SizeTBits = TLI->getSizeTSize(*CI->getModule());
512 Type *SizeTTy = IntegerType::get(CI->getContext(), SizeTBits);
513 return copyFlags(*CI,
514 emitMemChr(SrcStr, CharVal, // include nul.
515 ConstantInt::get(SizeTTy, Len), B,
516 DL, TLI));
517 }
518
519 if (CharC->isZero()) {
520 Value *NullPtr = Constant::getNullValue(CI->getType());
521 if (isOnlyUsedInEqualityComparison(CI, NullPtr))
522 // Pre-empt the transformation to strlen below and fold
523 // strchr(A, '\0') == null to false.
524 return B.CreateIntToPtr(B.getTrue(), CI->getType());
525 }
526
527 // Otherwise, the character is a constant, see if the first argument is
528 // a string literal. If so, we can constant fold.
529 StringRef Str;
530 if (!getConstantStringInfo(SrcStr, Str)) {
531 if (CharC->isZero()) // strchr(p, 0) -> p + strlen(p)
532 if (Value *StrLen = emitStrLen(SrcStr, B, DL, TLI))
533 return B.CreateInBoundsGEP(B.getInt8Ty(), SrcStr, StrLen, "strchr");
534 return nullptr;
535 }
536
537 // Compute the offset, make sure to handle the case when we're searching for
538 // zero (a weird way to spell strlen).
539 size_t I = (0xFF & CharC->getSExtValue()) == 0
540 ? Str.size()
541 : Str.find(CharC->getSExtValue());
542 if (I == StringRef::npos) // Didn't find the char. strchr returns null.
543 return Constant::getNullValue(CI->getType());
544
545 // strchr(s+n,c) -> gep(s+n+i,c)
546 return B.CreateInBoundsGEP(B.getInt8Ty(), SrcStr, B.getInt64(I), "strchr");
547}
548
549Value *LibCallSimplifier::optimizeStrRChr(CallInst *CI, IRBuilderBase &B) {
550 Value *SrcStr = CI->getArgOperand(0);
551 Value *CharVal = CI->getArgOperand(1);
552 ConstantInt *CharC = dyn_cast<ConstantInt>(CharVal);
554
555 StringRef Str;
556 if (!getConstantStringInfo(SrcStr, Str)) {
557 // strrchr(s, 0) -> strchr(s, 0)
558 if (CharC && CharC->isZero())
559 return copyFlags(*CI, emitStrChr(SrcStr, '\0', B, TLI));
560 return nullptr;
561 }
562
563 unsigned SizeTBits = TLI->getSizeTSize(*CI->getModule());
564 Type *SizeTTy = IntegerType::get(CI->getContext(), SizeTBits);
565
566 // Try to expand strrchr to the memrchr nonstandard extension if it's
567 // available, or simply fail otherwise.
568 uint64_t NBytes = Str.size() + 1; // Include the terminating nul.
569 Value *Size = ConstantInt::get(SizeTTy, NBytes);
570 return copyFlags(*CI, emitMemRChr(SrcStr, CharVal, Size, B, DL, TLI));
571}
572
573Value *LibCallSimplifier::optimizeStrCmp(CallInst *CI, IRBuilderBase &B) {
574 Value *Str1P = CI->getArgOperand(0), *Str2P = CI->getArgOperand(1);
575 if (Str1P == Str2P) // strcmp(x,x) -> 0
576 return ConstantInt::get(CI->getType(), 0);
577
578 StringRef Str1, Str2;
579 bool HasStr1 = getConstantStringInfo(Str1P, Str1);
580 bool HasStr2 = getConstantStringInfo(Str2P, Str2);
581
582 // strcmp(x, y) -> cnst (if both x and y are constant strings)
583 if (HasStr1 && HasStr2)
584 return ConstantInt::getSigned(CI->getType(),
585 std::clamp(Str1.compare(Str2), -1, 1));
586
587 if (HasStr1 && Str1.empty()) // strcmp("", x) -> -*x
588 return B.CreateNeg(B.CreateZExt(
589 B.CreateLoad(B.getInt8Ty(), Str2P, "strcmpload"), CI->getType()));
590
591 if (HasStr2 && Str2.empty()) // strcmp(x,"") -> *x
592 return B.CreateZExt(B.CreateLoad(B.getInt8Ty(), Str1P, "strcmpload"),
593 CI->getType());
594
595 // strcmp(P, "x") -> memcmp(P, "x", 2)
596 uint64_t Len1 = GetStringLength(Str1P);
597 if (Len1)
598 annotateDereferenceableBytes(CI, 0, Len1);
599 uint64_t Len2 = GetStringLength(Str2P);
600 if (Len2)
601 annotateDereferenceableBytes(CI, 1, Len2);
602
603 if (Len1 && Len2) {
604 return copyFlags(
605 *CI, emitMemCmp(Str1P, Str2P,
606 TLI->getAsSizeT(std::min(Len1, Len2), *CI->getModule()),
607 B, DL, TLI));
608 }
609
610 // strcmp to memcmp
611 SimplifyQuery SQ(DL, TLI, DT, AC, CI);
612 if (!HasStr1 && HasStr2) {
613 if (canTransformToMemCmp(CI, Str1P, Len2, SQ))
614 return copyFlags(*CI, emitMemCmp(Str1P, Str2P,
615 TLI->getAsSizeT(Len2, *CI->getModule()),
616 B, DL, TLI));
617 } else if (HasStr1 && !HasStr2) {
618 if (canTransformToMemCmp(CI, Str2P, Len1, SQ))
619 return copyFlags(*CI, emitMemCmp(Str1P, Str2P,
620 TLI->getAsSizeT(Len1, *CI->getModule()),
621 B, DL, TLI));
622 }
623
625 return nullptr;
626}
627
628// Optimize a memcmp or, when StrNCmp is true, strncmp call CI with constant
629// arrays LHS and RHS and nonconstant Size.
631 Value *Size, bool StrNCmp,
632 IRBuilderBase &B, const DataLayout &DL);
633
634Value *LibCallSimplifier::optimizeStrNCmp(CallInst *CI, IRBuilderBase &B) {
635 Value *Str1P = CI->getArgOperand(0);
636 Value *Str2P = CI->getArgOperand(1);
637 Value *Size = CI->getArgOperand(2);
638 if (Str1P == Str2P) // strncmp(x,x,n) -> 0
639 return ConstantInt::get(CI->getType(), 0);
640
641 if (isKnownNonZero(Size, DL))
643 // Get the length argument if it is constant.
644 uint64_t Length;
645 if (ConstantInt *LengthArg = dyn_cast<ConstantInt>(Size))
646 Length = LengthArg->getZExtValue();
647 else
648 return optimizeMemCmpVarSize(CI, Str1P, Str2P, Size, true, B, DL);
649
650 if (Length == 0) // strncmp(x,y,0) -> 0
651 return ConstantInt::get(CI->getType(), 0);
652
653 if (Length == 1) // strncmp(x,y,1) -> memcmp(x,y,1)
654 return copyFlags(*CI, emitMemCmp(Str1P, Str2P, Size, B, DL, TLI));
655
656 StringRef Str1, Str2;
657 bool HasStr1 = getConstantStringInfo(Str1P, Str1);
658 bool HasStr2 = getConstantStringInfo(Str2P, Str2);
659
660 // strncmp(x, y) -> cnst (if both x and y are constant strings)
661 if (HasStr1 && HasStr2) {
662 // Avoid truncating the 64-bit Length to 32 bits in ILP32.
663 StringRef SubStr1 = substr(Str1, Length);
664 StringRef SubStr2 = substr(Str2, Length);
665 return ConstantInt::getSigned(CI->getType(),
666 std::clamp(SubStr1.compare(SubStr2), -1, 1));
667 }
668
669 if (HasStr1 && Str1.empty()) // strncmp("", x, n) -> -*x
670 return B.CreateNeg(B.CreateZExt(
671 B.CreateLoad(B.getInt8Ty(), Str2P, "strcmpload"), CI->getType()));
672
673 if (HasStr2 && Str2.empty()) // strncmp(x, "", n) -> *x
674 return B.CreateZExt(B.CreateLoad(B.getInt8Ty(), Str1P, "strcmpload"),
675 CI->getType());
676
677 uint64_t Len1 = GetStringLength(Str1P);
678 if (Len1)
679 annotateDereferenceableBytes(CI, 0, Len1);
680 uint64_t Len2 = GetStringLength(Str2P);
681 if (Len2)
682 annotateDereferenceableBytes(CI, 1, Len2);
683
684 // strncmp to memcmp
685 if (!HasStr1 && HasStr2) {
686 Len2 = std::min(Len2, Length);
687 if (canTransformToMemCmp(CI, Str1P, Len2, DL))
688 return copyFlags(*CI, emitMemCmp(Str1P, Str2P,
689 TLI->getAsSizeT(Len2, *CI->getModule()),
690 B, DL, TLI));
691 } else if (HasStr1 && !HasStr2) {
692 Len1 = std::min(Len1, Length);
693 if (canTransformToMemCmp(CI, Str2P, Len1, DL))
694 return copyFlags(*CI, emitMemCmp(Str1P, Str2P,
695 TLI->getAsSizeT(Len1, *CI->getModule()),
696 B, DL, TLI));
697 }
698
699 return nullptr;
700}
701
702Value *LibCallSimplifier::optimizeStrNDup(CallInst *CI, IRBuilderBase &B) {
703 Value *Src = CI->getArgOperand(0);
704 ConstantInt *Size = dyn_cast<ConstantInt>(CI->getArgOperand(1));
705 uint64_t SrcLen = GetStringLength(Src);
706 if (SrcLen && Size) {
707 annotateDereferenceableBytes(CI, 0, SrcLen);
708 if (SrcLen <= Size->getZExtValue() + 1)
709 return copyFlags(*CI, emitStrDup(Src, B, TLI));
710 }
711
712 return nullptr;
713}
714
715Value *LibCallSimplifier::optimizeStrCpy(CallInst *CI, IRBuilderBase &B) {
716 Value *Dst = CI->getArgOperand(0), *Src = CI->getArgOperand(1);
717 if (Dst == Src) // strcpy(x,x) -> x
718 return Src;
719
721 // See if we can get the length of the input string.
722 uint64_t Len = GetStringLength(Src);
723 if (Len)
725 else
726 return nullptr;
727
728 // We have enough information to now generate the memcpy call to do the
729 // copy for us. Make a memcpy to copy the nul byte with align = 1.
730 CallInst *NewCI = B.CreateMemCpy(Dst, Align(1), Src, Align(1),
731 TLI->getAsSizeT(Len, *CI->getModule()));
732 mergeAttributesAndFlags(NewCI, *CI);
733 return Dst;
734}
735
736Value *LibCallSimplifier::optimizeStpCpy(CallInst *CI, IRBuilderBase &B) {
737 Value *Dst = CI->getArgOperand(0), *Src = CI->getArgOperand(1);
738
739 // stpcpy(d,s) -> strcpy(d,s) if the result is not used.
740 if (CI->use_empty())
741 return copyFlags(*CI, emitStrCpy(Dst, Src, B, TLI));
742
743 if (Dst == Src) { // stpcpy(x,x) -> x+strlen(x)
744 Value *StrLen = emitStrLen(Src, B, DL, TLI);
745 return StrLen ? B.CreateInBoundsGEP(B.getInt8Ty(), Dst, StrLen) : nullptr;
746 }
747
748 // See if we can get the length of the input string.
749 uint64_t Len = GetStringLength(Src);
750 if (Len)
752 else
753 return nullptr;
754
755 Value *LenV = TLI->getAsSizeT(Len, *CI->getModule());
756 Value *DstEnd = B.CreateInBoundsGEP(
757 B.getInt8Ty(), Dst, TLI->getAsSizeT(Len - 1, *CI->getModule()));
758
759 // We have enough information to now generate the memcpy call to do the
760 // copy for us. Make a memcpy to copy the nul byte with align = 1.
761 CallInst *NewCI = B.CreateMemCpy(Dst, Align(1), Src, Align(1), LenV);
762 mergeAttributesAndFlags(NewCI, *CI);
763 return DstEnd;
764}
765
766// Optimize a call to size_t strlcpy(char*, const char*, size_t).
767
768Value *LibCallSimplifier::optimizeStrLCpy(CallInst *CI, IRBuilderBase &B) {
769 Value *Size = CI->getArgOperand(2);
770 if (isKnownNonZero(Size, DL))
771 // Like snprintf, the function stores into the destination only when
772 // the size argument is nonzero.
774 // The function reads the source argument regardless of Size (it returns
775 // its length).
777
778 uint64_t NBytes;
779 if (ConstantInt *SizeC = dyn_cast<ConstantInt>(Size))
780 NBytes = SizeC->getZExtValue();
781 else
782 return nullptr;
783
784 Value *Dst = CI->getArgOperand(0);
785 Value *Src = CI->getArgOperand(1);
786 if (NBytes <= 1) {
787 if (NBytes == 1)
788 // For a call to strlcpy(D, S, 1) first store a nul in *D.
789 B.CreateStore(B.getInt8(0), Dst);
790
791 // Transform strlcpy(D, S, 0) to a call to strlen(S).
792 return copyFlags(*CI, emitStrLen(Src, B, DL, TLI));
793 }
794
795 // Try to determine the length of the source, substituting its size
796 // when it's not nul-terminated (as it's required to be) to avoid
797 // reading past its end.
798 StringRef Str;
799 if (!getConstantStringInfo(Src, Str, /*TrimAtNul=*/false))
800 return nullptr;
801
802 uint64_t SrcLen = Str.find('\0');
803 // Set if the terminating nul should be copied by the call to memcpy
804 // below.
805 bool NulTerm = SrcLen < NBytes;
806
807 if (NulTerm)
808 // Overwrite NBytes with the number of bytes to copy, including
809 // the terminating nul.
810 NBytes = SrcLen + 1;
811 else {
812 // Set the length of the source for the function to return to its
813 // size, and cap NBytes at the same.
814 SrcLen = std::min(SrcLen, uint64_t(Str.size()));
815 NBytes = std::min(NBytes - 1, SrcLen);
816 }
817
818 if (SrcLen == 0) {
819 // Transform strlcpy(D, "", N) to (*D = '\0, 0).
820 B.CreateStore(B.getInt8(0), Dst);
821 return ConstantInt::get(CI->getType(), 0);
822 }
823
824 // Transform strlcpy(D, S, N) to memcpy(D, S, N') where N' is the lower
825 // bound on strlen(S) + 1 and N, optionally followed by a nul store to
826 // D[N' - 1] if necessary.
827 CallInst *NewCI = B.CreateMemCpy(Dst, Align(1), Src, Align(1),
828 TLI->getAsSizeT(NBytes, *CI->getModule()));
829 mergeAttributesAndFlags(NewCI, *CI);
830
831 if (!NulTerm) {
832 Value *EndOff = ConstantInt::get(CI->getType(), NBytes);
833 Value *EndPtr = B.CreateInBoundsGEP(B.getInt8Ty(), Dst, EndOff);
834 B.CreateStore(B.getInt8(0), EndPtr);
835 }
836
837 // Like snprintf, strlcpy returns the number of nonzero bytes that would
838 // have been copied if the bound had been sufficiently big (which in this
839 // case is strlen(Src)).
840 return ConstantInt::get(CI->getType(), SrcLen);
841}
842
843// Optimize a call CI to either stpncpy when RetEnd is true, or to strncpy
844// otherwise.
845Value *LibCallSimplifier::optimizeStringNCpy(CallInst *CI, bool RetEnd,
846 IRBuilderBase &B) {
847 Value *Dst = CI->getArgOperand(0);
848 Value *Src = CI->getArgOperand(1);
849 Value *Size = CI->getArgOperand(2);
850
851 if (isKnownNonZero(Size, DL)) {
852 // Both st{p,r}ncpy(D, S, N) access the source and destination arrays
853 // only when N is nonzero.
856 }
857
858 // If the "bound" argument is known set N to it. Otherwise set it to
859 // UINT64_MAX and handle it later.
860 uint64_t N = UINT64_MAX;
861 if (ConstantInt *SizeC = dyn_cast<ConstantInt>(Size))
862 N = SizeC->getZExtValue();
863
864 if (N == 0)
865 // Fold st{p,r}ncpy(D, S, 0) to D.
866 return Dst;
867
868 if (N == 1) {
869 Type *CharTy = B.getInt8Ty();
870 Value *CharVal = B.CreateLoad(CharTy, Src, "stxncpy.char0");
871 B.CreateStore(CharVal, Dst);
872 if (!RetEnd)
873 // Transform strncpy(D, S, 1) to return (*D = *S), D.
874 return Dst;
875
876 // Transform stpncpy(D, S, 1) to return (*D = *S) ? D + 1 : D.
877 Value *ZeroChar = ConstantInt::get(CharTy, 0);
878 Value *Cmp = B.CreateICmpEQ(CharVal, ZeroChar, "stpncpy.char0cmp");
879
880 Value *Off1 = B.getInt32(1);
881 Value *EndPtr = B.CreateInBoundsGEP(CharTy, Dst, Off1, "stpncpy.end");
882 return B.CreateSelect(Cmp, Dst, EndPtr, "stpncpy.sel");
883 }
884
885 // If the length of the input string is known set SrcLen to it.
886 uint64_t SrcLen = GetStringLength(Src);
887 if (SrcLen)
888 annotateDereferenceableBytes(CI, 1, SrcLen);
889 else
890 return nullptr;
891
892 --SrcLen; // Unbias length.
893
894 if (SrcLen == 0) {
895 // Transform st{p,r}ncpy(D, "", N) to memset(D, '\0', N) for any N.
896 Align MemSetAlign =
897 CI->getAttributes().getParamAttrs(0).getAlignment().valueOrOne();
898 CallInst *NewCI = B.CreateMemSet(Dst, B.getInt8('\0'), Size, MemSetAlign);
899 AttrBuilder ArgAttrs(CI->getContext(), CI->getAttributes().getParamAttrs(0));
900 NewCI->setAttributes(NewCI->getAttributes().addParamAttributes(
901 CI->getContext(), 0, ArgAttrs));
902 copyFlags(*CI, NewCI);
903 return Dst;
904 }
905
906 if (N > SrcLen + 1) {
907 if (N > 128)
908 // Bail if N is large or unknown.
909 return nullptr;
910
911 // st{p,r}ncpy(D, "a", N) -> memcpy(D, "a\0\0\0", N) for N <= 128.
912 StringRef Str;
913 if (!getConstantStringInfo(Src, Str))
914 return nullptr;
915 std::string SrcStr = Str.str();
916 // Create a bigger, nul-padded array with the same length, SrcLen,
917 // as the original string.
918 SrcStr.resize(N, '\0');
919 Src = B.CreateGlobalString(SrcStr, "str", /*AddressSpace=*/0,
920 /*M=*/nullptr, /*AddNull=*/false);
921 }
922
923 // st{p,r}ncpy(D, S, N) -> memcpy(align 1 D, align 1 S, N) when both
924 // S and N are constant.
925 CallInst *NewCI = B.CreateMemCpy(Dst, Align(1), Src, Align(1),
926 TLI->getAsSizeT(N, *CI->getModule()));
927 mergeAttributesAndFlags(NewCI, *CI);
928 if (!RetEnd)
929 return Dst;
930
931 // stpncpy(D, S, N) returns the address of the first null in D if it writes
932 // one, otherwise D + N.
933 Value *Off = B.getInt64(std::min(SrcLen, N));
934 return B.CreateInBoundsGEP(B.getInt8Ty(), Dst, Off, "endptr");
935}
936
937Value *LibCallSimplifier::optimizeStringLength(CallInst *CI, IRBuilderBase &B,
938 unsigned CharSize,
939 Value *Bound) {
940 Value *Src = CI->getArgOperand(0);
941 Type *CharTy = B.getIntNTy(CharSize);
942
944 (!Bound || isKnownNonZero(Bound, DL))) {
945 // Fold strlen:
946 // strlen(x) != 0 --> *x != 0
947 // strlen(x) == 0 --> *x == 0
948 // and likewise strnlen with constant N > 0:
949 // strnlen(x, N) != 0 --> *x != 0
950 // strnlen(x, N) == 0 --> *x == 0
951 return B.CreateZExt(B.CreateLoad(CharTy, Src, "char0"),
952 CI->getType());
953 }
954
955 if (Bound) {
956 if (ConstantInt *BoundCst = dyn_cast<ConstantInt>(Bound)) {
957 if (BoundCst->isZero())
958 // Fold strnlen(s, 0) -> 0 for any s, constant or otherwise.
959 return ConstantInt::get(CI->getType(), 0);
960
961 if (BoundCst->isOne()) {
962 // Fold strnlen(s, 1) -> *s ? 1 : 0 for any s.
963 Value *CharVal = B.CreateLoad(CharTy, Src, "strnlen.char0");
964 Value *ZeroChar = ConstantInt::get(CharTy, 0);
965 Value *Cmp = B.CreateICmpNE(CharVal, ZeroChar, "strnlen.char0cmp");
966 return B.CreateZExt(Cmp, CI->getType());
967 }
968 }
969 }
970
971 if (uint64_t Len = GetStringLength(Src, CharSize)) {
972 Value *LenC = ConstantInt::get(CI->getType(), Len - 1);
973 // Fold strlen("xyz") -> 3 and strnlen("xyz", 2) -> 2
974 // and strnlen("xyz", Bound) -> min(3, Bound) for nonconstant Bound.
975 if (Bound)
976 return B.CreateBinaryIntrinsic(Intrinsic::umin, LenC, Bound);
977 return LenC;
978 }
979
980 if (Bound)
981 // Punt for strnlen for now.
982 return nullptr;
983
984 // If s is a constant pointer pointing to a string literal, we can fold
985 // strlen(s + x) to strlen(s) - x, when x is known to be in the range
986 // [0, strlen(s)] or the string has a single null terminator '\0' at the end.
987 // We only try to simplify strlen when the pointer s points to an array
988 // of CharSize elements. Otherwise, we would need to scale the offset x before
989 // doing the subtraction. This will make the optimization more complex, and
990 // it's not very useful because calling strlen for a pointer of other types is
991 // very uncommon.
992 if (GEPOperator *GEP = dyn_cast<GEPOperator>(Src)) {
993 unsigned BW = DL.getIndexTypeSizeInBits(GEP->getType());
994 SmallMapVector<Value *, APInt, 4> VarOffsets;
995 APInt ConstOffset(BW, 0);
996 assert(CharSize % 8 == 0 && "Expected a multiple of 8 sized CharSize");
997 // Check the gep is a single variable offset.
998 if (!GEP->collectOffset(DL, BW, VarOffsets, ConstOffset) ||
999 VarOffsets.size() != 1 || ConstOffset != 0 ||
1000 VarOffsets.begin()->second != CharSize / 8)
1001 return nullptr;
1002
1003 ConstantDataArraySlice Slice;
1004 if (getConstantDataArrayInfo(GEP->getOperand(0), Slice, CharSize)) {
1005 uint64_t NullTermIdx;
1006 if (Slice.Array == nullptr) {
1007 NullTermIdx = 0;
1008 } else {
1009 NullTermIdx = ~((uint64_t)0);
1010 for (uint64_t I = 0, E = Slice.Length; I < E; ++I) {
1011 if (Slice.Array->getElementAsInteger(I + Slice.Offset) == 0) {
1012 NullTermIdx = I;
1013 break;
1014 }
1015 }
1016 // If the string does not have '\0', leave it to strlen to compute
1017 // its length.
1018 if (NullTermIdx == ~((uint64_t)0))
1019 return nullptr;
1020 }
1021
1022 Value *Offset = VarOffsets.begin()->first;
1023 KnownBits Known = computeKnownBits(Offset, DL, nullptr, CI, nullptr);
1024
1025 // If Offset is not provably in the range [0, NullTermIdx], we can still
1026 // optimize if we can prove that the program has undefined behavior when
1027 // Offset is outside that range. That is the case when GEP->getOperand(0)
1028 // is a pointer to an object whose memory extent is NullTermIdx+1.
1029 if ((Known.isNonNegative() && Known.getMaxValue().ule(NullTermIdx)) ||
1030 (isa<GlobalVariable>(GEP->getOperand(0)) &&
1031 NullTermIdx == Slice.Length - 1)) {
1032 Offset = B.CreateSExtOrTrunc(Offset, CI->getType());
1033 return B.CreateSub(ConstantInt::get(CI->getType(), NullTermIdx),
1034 Offset);
1035 }
1036 }
1037 }
1038
1039 // strlen(x?"foo":"bars") --> x ? 3 : 4
1040 if (SelectInst *SI = dyn_cast<SelectInst>(Src)) {
1041 uint64_t LenTrue = GetStringLength(SI->getTrueValue(), CharSize);
1042 uint64_t LenFalse = GetStringLength(SI->getFalseValue(), CharSize);
1043 if (LenTrue && LenFalse) {
1044 ORE.emit([&]() {
1045 return OptimizationRemark("instcombine", "simplify-libcalls", CI)
1046 << "folded strlen(select) to select of constants";
1047 });
1048 return B.CreateSelect(SI->getCondition(),
1049 ConstantInt::get(CI->getType(), LenTrue - 1),
1050 ConstantInt::get(CI->getType(), LenFalse - 1));
1051 }
1052 }
1053
1054 return nullptr;
1055}
1056
1057Value *LibCallSimplifier::optimizeStrLen(CallInst *CI, IRBuilderBase &B) {
1058 if (Value *V = optimizeStringLength(CI, B, 8))
1059 return V;
1061 return nullptr;
1062}
1063
1064Value *LibCallSimplifier::optimizeStrNLen(CallInst *CI, IRBuilderBase &B) {
1065 Value *Bound = CI->getArgOperand(1);
1066 if (Value *V = optimizeStringLength(CI, B, 8, Bound))
1067 return V;
1068
1069 if (isKnownNonZero(Bound, DL))
1071 return nullptr;
1072}
1073
1074Value *LibCallSimplifier::optimizeWcslen(CallInst *CI, IRBuilderBase &B) {
1075 Module &M = *CI->getModule();
1076 unsigned WCharSize = TLI->getWCharSize(M) * 8;
1077 // We cannot perform this optimization without wchar_size metadata.
1078 if (WCharSize == 0)
1079 return nullptr;
1080
1081 return optimizeStringLength(CI, B, WCharSize);
1082}
1083
1084Value *LibCallSimplifier::optimizeStrPBrk(CallInst *CI, IRBuilderBase &B) {
1085 StringRef S1, S2;
1086 bool HasS1 = getConstantStringInfo(CI->getArgOperand(0), S1);
1087 bool HasS2 = getConstantStringInfo(CI->getArgOperand(1), S2);
1088
1089 // strpbrk(s, "") -> nullptr
1090 // strpbrk("", s) -> nullptr
1091 if ((HasS1 && S1.empty()) || (HasS2 && S2.empty()))
1092 return Constant::getNullValue(CI->getType());
1093
1094 // Constant folding.
1095 if (HasS1 && HasS2) {
1096 size_t I = S1.find_first_of(S2);
1097 if (I == StringRef::npos) // No match.
1098 return Constant::getNullValue(CI->getType());
1099
1100 return B.CreateInBoundsGEP(B.getInt8Ty(), CI->getArgOperand(0),
1101 B.getInt64(I), "strpbrk");
1102 }
1103
1104 // strpbrk(s, "a") -> strchr(s, 'a')
1105 if (HasS2 && S2.size() == 1)
1106 return copyFlags(*CI, emitStrChr(CI->getArgOperand(0), S2[0], B, TLI));
1107
1108 return nullptr;
1109}
1110
1111Value *LibCallSimplifier::optimizeStrTo(CallInst *CI, IRBuilderBase &B) {
1112 Value *EndPtr = CI->getArgOperand(1);
1113 if (isa<ConstantPointerNull>(EndPtr)) {
1114 // With a null EndPtr, this function won't capture the main argument.
1115 // It would be readonly too, except that it still may write to errno.
1118 }
1119
1120 return nullptr;
1121}
1122
1123Value *LibCallSimplifier::optimizeStrSpn(CallInst *CI, IRBuilderBase &B) {
1124 StringRef S1, S2;
1125 bool HasS1 = getConstantStringInfo(CI->getArgOperand(0), S1);
1126 bool HasS2 = getConstantStringInfo(CI->getArgOperand(1), S2);
1127
1128 // strspn(s, "") -> 0
1129 // strspn("", s) -> 0
1130 if ((HasS1 && S1.empty()) || (HasS2 && S2.empty()))
1131 return Constant::getNullValue(CI->getType());
1132
1133 // Constant folding.
1134 if (HasS1 && HasS2) {
1135 size_t Pos = S1.find_first_not_of(S2);
1136 if (Pos == StringRef::npos)
1137 Pos = S1.size();
1138 return ConstantInt::get(CI->getType(), Pos);
1139 }
1140
1141 return nullptr;
1142}
1143
1144Value *LibCallSimplifier::optimizeStrCSpn(CallInst *CI, IRBuilderBase &B) {
1145 StringRef S1, S2;
1146 bool HasS1 = getConstantStringInfo(CI->getArgOperand(0), S1);
1147 bool HasS2 = getConstantStringInfo(CI->getArgOperand(1), S2);
1148
1149 // strcspn("", s) -> 0
1150 if (HasS1 && S1.empty())
1151 return Constant::getNullValue(CI->getType());
1152
1153 // Constant folding.
1154 if (HasS1 && HasS2) {
1155 size_t Pos = S1.find_first_of(S2);
1156 if (Pos == StringRef::npos)
1157 Pos = S1.size();
1158 return ConstantInt::get(CI->getType(), Pos);
1159 }
1160
1161 // strcspn(s, "") -> strlen(s)
1162 if (HasS2 && S2.empty())
1163 return copyFlags(*CI, emitStrLen(CI->getArgOperand(0), B, DL, TLI));
1164
1165 return nullptr;
1166}
1167
1168Value *LibCallSimplifier::optimizeStrStr(CallInst *CI, IRBuilderBase &B) {
1169 // fold strstr(x, x) -> x.
1170 if (CI->getArgOperand(0) == CI->getArgOperand(1))
1171 return CI->getArgOperand(0);
1172
1173 // fold strstr(a, b) == a -> strncmp(a, b, strlen(b)) == 0
1175 Value *StrLen = emitStrLen(CI->getArgOperand(1), B, DL, TLI);
1176 if (!StrLen)
1177 return nullptr;
1178 Value *StrNCmp = emitStrNCmp(CI->getArgOperand(0), CI->getArgOperand(1),
1179 StrLen, B, DL, TLI);
1180 if (!StrNCmp)
1181 return nullptr;
1182 for (User *U : llvm::make_early_inc_range(CI->users())) {
1183 ICmpInst *Old = cast<ICmpInst>(U);
1184 Value *Cmp =
1185 B.CreateICmp(Old->getPredicate(), StrNCmp,
1186 ConstantInt::getNullValue(StrNCmp->getType()), "cmp");
1187 replaceAllUsesWith(Old, Cmp);
1188 }
1189 return CI;
1190 }
1191
1192 // See if either input string is a constant string.
1193 StringRef SearchStr, ToFindStr;
1194 bool HasStr1 = getConstantStringInfo(CI->getArgOperand(0), SearchStr);
1195 bool HasStr2 = getConstantStringInfo(CI->getArgOperand(1), ToFindStr);
1196
1197 // fold strstr(x, "") -> x.
1198 if (HasStr2 && ToFindStr.empty())
1199 return CI->getArgOperand(0);
1200
1201 // If both strings are known, constant fold it.
1202 if (HasStr1 && HasStr2) {
1203 size_t Offset = SearchStr.find(ToFindStr);
1204
1205 if (Offset == StringRef::npos) // strstr("foo", "bar") -> null
1206 return Constant::getNullValue(CI->getType());
1207
1208 // strstr("abcd", "bc") -> gep((char*)"abcd", 1)
1209 return B.CreateConstInBoundsGEP1_64(B.getInt8Ty(), CI->getArgOperand(0),
1210 Offset, "strstr");
1211 }
1212
1213 // fold strstr(x, "y") -> strchr(x, 'y').
1214 if (HasStr2 && ToFindStr.size() == 1) {
1215 return emitStrChr(CI->getArgOperand(0), ToFindStr[0], B, TLI);
1216 }
1217
1219 return nullptr;
1220}
1221
1222Value *LibCallSimplifier::optimizeMemRChr(CallInst *CI, IRBuilderBase &B) {
1223 Value *SrcStr = CI->getArgOperand(0);
1224 Value *Size = CI->getArgOperand(2);
1226 Value *CharVal = CI->getArgOperand(1);
1227 ConstantInt *LenC = dyn_cast<ConstantInt>(Size);
1228 Value *NullPtr = Constant::getNullValue(CI->getType());
1229
1230 if (LenC) {
1231 if (LenC->isZero())
1232 // Fold memrchr(x, y, 0) --> null.
1233 return NullPtr;
1234
1235 if (LenC->isOne()) {
1236 // Fold memrchr(x, y, 1) --> *x == y ? x : null for any x and y,
1237 // constant or otherwise.
1238 Value *Val = B.CreateLoad(B.getInt8Ty(), SrcStr, "memrchr.char0");
1239 // Slice off the character's high end bits.
1240 CharVal = B.CreateTrunc(CharVal, B.getInt8Ty());
1241 Value *Cmp = B.CreateICmpEQ(Val, CharVal, "memrchr.char0cmp");
1242 return B.CreateSelect(Cmp, SrcStr, NullPtr, "memrchr.sel");
1243 }
1244 }
1245
1246 StringRef Str;
1247 if (!getConstantStringInfo(SrcStr, Str, /*TrimAtNul=*/false))
1248 return nullptr;
1249
1250 if (Str.size() == 0)
1251 // If the array is empty fold memrchr(A, C, N) to null for any value
1252 // of C and N on the basis that the only valid value of N is zero
1253 // (otherwise the call is undefined).
1254 return NullPtr;
1255
1256 uint64_t EndOff = UINT64_MAX;
1257 if (LenC) {
1258 EndOff = LenC->getZExtValue();
1259 if (Str.size() < EndOff)
1260 // Punt out-of-bounds accesses to sanitizers and/or libc.
1261 return nullptr;
1262 }
1263
1264 if (ConstantInt *CharC = dyn_cast<ConstantInt>(CharVal)) {
1265 // Fold memrchr(S, C, N) for a constant C.
1266 size_t Pos = Str.rfind(CharC->getZExtValue(), EndOff);
1267 if (Pos == StringRef::npos)
1268 // When the character is not in the source array fold the result
1269 // to null regardless of Size.
1270 return NullPtr;
1271
1272 if (LenC)
1273 // Fold memrchr(s, c, N) --> s + Pos for constant N > Pos.
1274 return B.CreateInBoundsGEP(B.getInt8Ty(), SrcStr, B.getInt64(Pos));
1275
1276 if (Str.find(Str[Pos]) == Pos) {
1277 // When there is just a single occurrence of C in S, i.e., the one
1278 // in Str[Pos], fold
1279 // memrchr(s, c, N) --> N <= Pos ? null : s + Pos
1280 // for nonconstant N.
1281 Value *Cmp = B.CreateICmpULE(Size, ConstantInt::get(Size->getType(), Pos),
1282 "memrchr.cmp");
1283 Value *SrcPlus = B.CreateInBoundsGEP(B.getInt8Ty(), SrcStr,
1284 B.getInt64(Pos), "memrchr.ptr_plus");
1285 return B.CreateSelect(Cmp, NullPtr, SrcPlus, "memrchr.sel");
1286 }
1287 }
1288
1289 // Truncate the string to search at most EndOff characters.
1290 Str = Str.substr(0, EndOff);
1291 if (Str.find_first_not_of(Str[0]) != StringRef::npos)
1292 return nullptr;
1293
1294 // If the source array consists of all equal characters, then for any
1295 // C and N (whether in bounds or not), fold memrchr(S, C, N) to
1296 // N != 0 && *S == C ? S + N - 1 : null
1297 Type *SizeTy = Size->getType();
1298 Type *Int8Ty = B.getInt8Ty();
1299 Value *NNeZ = B.CreateICmpNE(Size, ConstantInt::get(SizeTy, 0));
1300 // Slice off the sought character's high end bits.
1301 CharVal = B.CreateTrunc(CharVal, Int8Ty);
1302 Value *CEqS0 = B.CreateICmpEQ(ConstantInt::get(Int8Ty, Str[0]), CharVal);
1303 Value *And = B.CreateLogicalAnd(NNeZ, CEqS0);
1304 Value *SizeM1 = B.CreateSub(Size, ConstantInt::get(SizeTy, 1));
1305 Value *SrcPlus =
1306 B.CreateInBoundsGEP(Int8Ty, SrcStr, SizeM1, "memrchr.ptr_plus");
1307 return B.CreateSelect(And, SrcPlus, NullPtr, "memrchr.sel");
1308}
1309
1310Value *LibCallSimplifier::optimizeMemChr(CallInst *CI, IRBuilderBase &B) {
1311 Value *SrcStr = CI->getArgOperand(0);
1312 Value *Size = CI->getArgOperand(2);
1313
1314 if (isKnownNonZero(Size, DL)) {
1316 if (isOnlyUsedInEqualityComparison(CI, SrcStr))
1317 return memChrToCharCompare(CI, Size, B, DL);
1318 }
1319
1320 Value *CharVal = CI->getArgOperand(1);
1321 ConstantInt *CharC = dyn_cast<ConstantInt>(CharVal);
1322 ConstantInt *LenC = dyn_cast<ConstantInt>(Size);
1323 Value *NullPtr = Constant::getNullValue(CI->getType());
1324
1325 // memchr(x, y, 0) -> null
1326 if (LenC) {
1327 if (LenC->isZero())
1328 return NullPtr;
1329
1330 if (LenC->isOne()) {
1331 // Fold memchr(x, y, 1) --> *x == y ? x : null for any x and y,
1332 // constant or otherwise.
1333 Value *Val = B.CreateLoad(B.getInt8Ty(), SrcStr, "memchr.char0");
1334 // Slice off the character's high end bits.
1335 CharVal = B.CreateTrunc(CharVal, B.getInt8Ty());
1336 Value *Cmp = B.CreateICmpEQ(Val, CharVal, "memchr.char0cmp");
1337 return B.CreateSelect(Cmp, SrcStr, NullPtr, "memchr.sel");
1338 }
1339 }
1340
1341 StringRef Str;
1342 if (!getConstantStringInfo(SrcStr, Str, /*TrimAtNul=*/false))
1343 return nullptr;
1344
1345 if (CharC) {
1346 size_t Pos = Str.find(CharC->getZExtValue());
1347 if (Pos == StringRef::npos)
1348 // When the character is not in the source array fold the result
1349 // to null regardless of Size.
1350 return NullPtr;
1351
1352 // Fold memchr(s, c, n) -> n <= Pos ? null : s + Pos
1353 // When the constant Size is less than or equal to the character
1354 // position also fold the result to null.
1355 Value *Cmp = B.CreateICmpULE(Size, ConstantInt::get(Size->getType(), Pos),
1356 "memchr.cmp");
1357 Value *SrcPlus = B.CreateInBoundsGEP(B.getInt8Ty(), SrcStr, B.getInt64(Pos),
1358 "memchr.ptr");
1359 return B.CreateSelect(Cmp, NullPtr, SrcPlus);
1360 }
1361
1362 if (Str.size() == 0)
1363 // If the array is empty fold memchr(A, C, N) to null for any value
1364 // of C and N on the basis that the only valid value of N is zero
1365 // (otherwise the call is undefined).
1366 return NullPtr;
1367
1368 if (LenC)
1369 Str = substr(Str, LenC->getZExtValue());
1370
1371 size_t Pos = Str.find_first_not_of(Str[0]);
1372 if (Pos == StringRef::npos
1373 || Str.find_first_not_of(Str[Pos], Pos) == StringRef::npos) {
1374 // If the source array consists of at most two consecutive sequences
1375 // of the same characters, then for any C and N (whether in bounds or
1376 // not), fold memchr(S, C, N) to
1377 // N != 0 && *S == C ? S : null
1378 // or for the two sequences to:
1379 // N != 0 && *S == C ? S : (N > Pos && S[Pos] == C ? S + Pos : null)
1380 // ^Sel2 ^Sel1 are denoted above.
1381 // The latter makes it also possible to fold strchr() calls with strings
1382 // of the same characters.
1383 Type *SizeTy = Size->getType();
1384 Type *Int8Ty = B.getInt8Ty();
1385
1386 // Slice off the sought character's high end bits.
1387 CharVal = B.CreateTrunc(CharVal, Int8Ty);
1388
1389 Value *Sel1 = NullPtr;
1390 if (Pos != StringRef::npos) {
1391 // Handle two consecutive sequences of the same characters.
1392 Value *PosVal = ConstantInt::get(SizeTy, Pos);
1393 Value *StrPos = ConstantInt::get(Int8Ty, Str[Pos]);
1394 Value *CEqSPos = B.CreateICmpEQ(CharVal, StrPos);
1395 Value *NGtPos = B.CreateICmp(ICmpInst::ICMP_UGT, Size, PosVal);
1396 Value *And = B.CreateAnd(CEqSPos, NGtPos);
1397 Value *SrcPlus = B.CreateInBoundsGEP(B.getInt8Ty(), SrcStr, PosVal);
1398 Sel1 = B.CreateSelect(And, SrcPlus, NullPtr, "memchr.sel1");
1399 }
1400
1401 Value *Str0 = ConstantInt::get(Int8Ty, Str[0]);
1402 Value *CEqS0 = B.CreateICmpEQ(Str0, CharVal);
1403 Value *NNeZ = B.CreateICmpNE(Size, ConstantInt::get(SizeTy, 0));
1404 Value *And = B.CreateAnd(NNeZ, CEqS0);
1405 return B.CreateSelect(And, SrcStr, Sel1, "memchr.sel2");
1406 }
1407
1408 if (!LenC) {
1409 if (isOnlyUsedInEqualityComparison(CI, SrcStr))
1410 // S is dereferenceable so it's safe to load from it and fold
1411 // memchr(S, C, N) == S to N && *S == C for any C and N.
1412 // TODO: This is safe even for nonconstant S.
1413 return memChrToCharCompare(CI, Size, B, DL);
1414
1415 // From now on we need a constant length and constant array.
1416 return nullptr;
1417 }
1418
1419 bool OptForSize = llvm::shouldOptimizeForSize(CI->getParent(), PSI, BFI,
1421
1422 // If the char is variable but the input str and length are not we can turn
1423 // this memchr call into a simple bit field test. Of course this only works
1424 // when the return value is only checked against null.
1425 //
1426 // It would be really nice to reuse switch lowering here but we can't change
1427 // the CFG at this point.
1428 //
1429 // memchr("\r\n", C, 2) != nullptr -> (1 << C & ((1 << '\r') | (1 << '\n')))
1430 // != 0
1431 // after bounds check.
1432 if (OptForSize || Str.empty() || !isOnlyUsedInZeroEqualityComparison(CI))
1433 return nullptr;
1434
1435 unsigned char Max =
1436 *std::max_element(reinterpret_cast<const unsigned char *>(Str.begin()),
1437 reinterpret_cast<const unsigned char *>(Str.end()));
1438
1439 // Make sure the bit field we're about to create fits in a register on the
1440 // target.
1441 // FIXME: On a 64 bit architecture this prevents us from using the
1442 // interesting range of alpha ascii chars. We could do better by emitting
1443 // two bitfields or shifting the range by 64 if no lower chars are used.
1444 if (!DL.fitsInLegalInteger(Max + 1)) {
1445 // Build chain of ORs
1446 // Transform:
1447 // memchr("abcd", C, 4) != nullptr
1448 // to:
1449 // (C == 'a' || C == 'b' || C == 'c' || C == 'd') != 0
1450 std::string SortedStr = Str.str();
1451 llvm::sort(SortedStr);
1452 // Compute the number of of non-contiguous ranges.
1453 unsigned NonContRanges = 1;
1454 for (size_t i = 1; i < SortedStr.size(); ++i) {
1455 if (SortedStr[i] > SortedStr[i - 1] + 1) {
1456 NonContRanges++;
1457 }
1458 }
1459
1460 // Restrict this optimization to profitable cases with one or two range
1461 // checks.
1462 if (NonContRanges > 2)
1463 return nullptr;
1464
1465 // Slice off the character's high end bits.
1466 CharVal = B.CreateTrunc(CharVal, B.getInt8Ty());
1467
1468 SmallVector<Value *> CharCompares;
1469 for (unsigned char C : SortedStr)
1470 CharCompares.push_back(B.CreateICmpEQ(CharVal, B.getInt8(C)));
1471
1472 return B.CreateIntToPtr(B.CreateOr(CharCompares), CI->getType());
1473 }
1474
1475 // For the bit field use a power-of-2 type with at least 8 bits to avoid
1476 // creating unnecessary illegal types.
1477 unsigned char Width = NextPowerOf2(std::max((unsigned char)7, Max));
1478
1479 // Now build the bit field.
1480 APInt Bitfield(Width, 0);
1481 for (char C : Str)
1482 Bitfield.setBit((unsigned char)C);
1483 Value *BitfieldC = B.getInt(Bitfield);
1484
1485 // Adjust width of "C" to the bitfield width, then mask off the high bits.
1486 Value *C = B.CreateZExtOrTrunc(CharVal, BitfieldC->getType());
1487 C = B.CreateAnd(C, B.getIntN(Width, 0xFF));
1488
1489 // First check that the bit field access is within bounds.
1490 Value *Bounds = B.CreateICmp(ICmpInst::ICMP_ULT, C, B.getIntN(Width, Width),
1491 "memchr.bounds");
1492
1493 // Create code that checks if the given bit is set in the field.
1494 Value *Shl = B.CreateShl(B.getIntN(Width, 1ULL), C);
1495 Value *Bits = B.CreateIsNotNull(B.CreateAnd(Shl, BitfieldC), "memchr.bits");
1496
1497 // Finally merge both checks and cast to pointer type. The inttoptr
1498 // implicitly zexts the i1 to intptr type.
1499 return B.CreateIntToPtr(B.CreateLogicalAnd(Bounds, Bits, "memchr"),
1500 CI->getType());
1501}
1502
1503// Optimize a memcmp or, when StrNCmp is true, strncmp call CI with constant
1504// arrays LHS and RHS and nonconstant Size.
1506 Value *Size, bool StrNCmp,
1507 IRBuilderBase &B, const DataLayout &DL) {
1508 if (LHS == RHS) // memcmp(s,s,x) -> 0
1509 return Constant::getNullValue(CI->getType());
1510
1511 StringRef LStr, RStr;
1512 if (!getConstantStringInfo(LHS, LStr, /*TrimAtNul=*/false) ||
1513 !getConstantStringInfo(RHS, RStr, /*TrimAtNul=*/false))
1514 return nullptr;
1515
1516 // If the contents of both constant arrays are known, fold a call to
1517 // memcmp(A, B, N) to
1518 // N <= Pos ? 0 : (A < B ? -1 : B < A ? +1 : 0)
1519 // where Pos is the first mismatch between A and B, determined below.
1520
1521 uint64_t Pos = 0;
1522 Value *Zero = ConstantInt::get(CI->getType(), 0);
1523 for (uint64_t MinSize = std::min(LStr.size(), RStr.size()); ; ++Pos) {
1524 if (Pos == MinSize ||
1525 (StrNCmp && (LStr[Pos] == '\0' && RStr[Pos] == '\0'))) {
1526 // One array is a leading part of the other of equal or greater
1527 // size, or for strncmp, the arrays are equal strings.
1528 // Fold the result to zero. Size is assumed to be in bounds, since
1529 // otherwise the call would be undefined.
1530 return Zero;
1531 }
1532
1533 if (LStr[Pos] != RStr[Pos])
1534 break;
1535 }
1536
1537 // Normalize the result.
1538 typedef unsigned char UChar;
1539 int IRes = UChar(LStr[Pos]) < UChar(RStr[Pos]) ? -1 : 1;
1540 Value *MaxSize = ConstantInt::get(Size->getType(), Pos);
1541 Value *Cmp = B.CreateICmp(ICmpInst::ICMP_ULE, Size, MaxSize);
1542 Value *Res = ConstantInt::getSigned(CI->getType(), IRes);
1543 return B.CreateSelect(Cmp, Zero, Res);
1544}
1545
1546// Optimize a memcmp call CI with constant size Len.
1548 uint64_t Len, IRBuilderBase &B,
1549 const DataLayout &DL) {
1550 if (Len == 0) // memcmp(s1,s2,0) -> 0
1551 return Constant::getNullValue(CI->getType());
1552
1553 // memcmp(S1,S2,1) -> *(unsigned char*)LHS - *(unsigned char*)RHS
1554 if (Len == 1) {
1555 Value *LHSV = B.CreateZExt(B.CreateLoad(B.getInt8Ty(), LHS, "lhsc"),
1556 CI->getType(), "lhsv");
1557 Value *RHSV = B.CreateZExt(B.CreateLoad(B.getInt8Ty(), RHS, "rhsc"),
1558 CI->getType(), "rhsv");
1559 return B.CreateSub(LHSV, RHSV, "chardiff");
1560 }
1561
1562 // memcmp(S1,S2,N/8)==0 -> (*(intN_t*)S1 != *(intN_t*)S2)==0
1563 // TODO: The case where both inputs are constants does not need to be limited
1564 // to legal integers or equality comparison. See block below this.
1565 if (DL.isLegalInteger(Len * 8) && isOnlyUsedInZeroEqualityComparison(CI)) {
1566 IntegerType *IntType = IntegerType::get(CI->getContext(), Len * 8);
1567 Align PrefAlignment = DL.getPrefTypeAlign(IntType);
1568
1569 // First, see if we can fold either argument to a constant.
1570 Value *LHSV = nullptr;
1571 if (auto *LHSC = dyn_cast<Constant>(LHS))
1572 LHSV = ConstantFoldLoadFromConstPtr(LHSC, IntType, DL);
1573
1574 Value *RHSV = nullptr;
1575 if (auto *RHSC = dyn_cast<Constant>(RHS))
1576 RHSV = ConstantFoldLoadFromConstPtr(RHSC, IntType, DL);
1577
1578 // Don't generate unaligned loads. If either source is constant data,
1579 // alignment doesn't matter for that source because there is no load.
1580 if ((LHSV || getKnownAlignment(LHS, DL, CI) >= PrefAlignment) &&
1581 (RHSV || getKnownAlignment(RHS, DL, CI) >= PrefAlignment)) {
1582 if (!LHSV)
1583 LHSV = B.CreateLoad(IntType, LHS, "lhsv");
1584 if (!RHSV)
1585 RHSV = B.CreateLoad(IntType, RHS, "rhsv");
1586 return B.CreateZExt(B.CreateICmpNE(LHSV, RHSV), CI->getType(), "memcmp");
1587 }
1588 }
1589
1590 return nullptr;
1591}
1592
1593// Most simplifications for memcmp also apply to bcmp.
1594Value *LibCallSimplifier::optimizeMemCmpBCmpCommon(CallInst *CI,
1595 IRBuilderBase &B) {
1596 Value *LHS = CI->getArgOperand(0), *RHS = CI->getArgOperand(1);
1597 Value *Size = CI->getArgOperand(2);
1598
1599 annotateNonNullAndDereferenceable(CI, {0, 1}, Size, DL);
1600
1601 if (Value *Res = optimizeMemCmpVarSize(CI, LHS, RHS, Size, false, B, DL))
1602 return Res;
1603
1604 // Handle constant Size.
1605 ConstantInt *LenC = dyn_cast<ConstantInt>(Size);
1606 if (!LenC)
1607 return nullptr;
1608
1609 return optimizeMemCmpConstantSize(CI, LHS, RHS, LenC->getZExtValue(), B, DL);
1610}
1611
1612Value *LibCallSimplifier::optimizeMemCmp(CallInst *CI, IRBuilderBase &B) {
1613 Module *M = CI->getModule();
1614 if (Value *V = optimizeMemCmpBCmpCommon(CI, B))
1615 return V;
1616
1617 // memcmp(x, y, Len) == 0 -> bcmp(x, y, Len) == 0
1618 // bcmp can be more efficient than memcmp because it only has to know that
1619 // there is a difference, not how different one is to the other.
1620 if (isLibFuncEmittable(M, TLI, LibFunc_bcmp) &&
1622 Value *LHS = CI->getArgOperand(0);
1623 Value *RHS = CI->getArgOperand(1);
1624 Value *Size = CI->getArgOperand(2);
1625 return copyFlags(*CI, emitBCmp(LHS, RHS, Size, B, DL, TLI));
1626 }
1627
1628 return nullptr;
1629}
1630
1631Value *LibCallSimplifier::optimizeBCmp(CallInst *CI, IRBuilderBase &B) {
1632 return optimizeMemCmpBCmpCommon(CI, B);
1633}
1634
1635Value *LibCallSimplifier::optimizeMemCpy(CallInst *CI, IRBuilderBase &B) {
1636 Value *Size = CI->getArgOperand(2);
1637 annotateNonNullAndDereferenceable(CI, {0, 1}, Size, DL);
1638 if (isa<IntrinsicInst>(CI))
1639 return nullptr;
1640
1641 // memcpy(x, y, n) -> llvm.memcpy(align 1 x, align 1 y, n)
1642 CallInst *NewCI = B.CreateMemCpy(CI->getArgOperand(0), Align(1),
1643 CI->getArgOperand(1), Align(1), Size);
1644 mergeAttributesAndFlags(NewCI, *CI);
1645 return CI->getArgOperand(0);
1646}
1647
1648Value *LibCallSimplifier::optimizeMemCCpy(CallInst *CI, IRBuilderBase &B) {
1649 Value *Dst = CI->getArgOperand(0);
1650 Value *Src = CI->getArgOperand(1);
1651 ConstantInt *StopChar = dyn_cast<ConstantInt>(CI->getArgOperand(2));
1652 ConstantInt *N = dyn_cast<ConstantInt>(CI->getArgOperand(3));
1653 StringRef SrcStr;
1654 if (CI->use_empty() && Dst == Src)
1655 return Dst;
1656 // memccpy(d, s, c, 0) -> nullptr
1657 if (N) {
1658 if (N->isNullValue())
1659 return Constant::getNullValue(CI->getType());
1660 if (!getConstantStringInfo(Src, SrcStr, /*TrimAtNul=*/false) ||
1661 // TODO: Handle zeroinitializer.
1662 !StopChar)
1663 return nullptr;
1664 } else {
1665 return nullptr;
1666 }
1667
1668 // Wrap arg 'c' of type int to char
1669 size_t Pos = SrcStr.find(StopChar->getSExtValue() & 0xFF);
1670 if (Pos == StringRef::npos) {
1671 if (N->getZExtValue() <= SrcStr.size()) {
1672 copyFlags(*CI, B.CreateMemCpy(Dst, Align(1), Src, Align(1),
1673 CI->getArgOperand(3)));
1674 return Constant::getNullValue(CI->getType());
1675 }
1676 return nullptr;
1677 }
1678
1679 Value *NewN =
1680 ConstantInt::get(N->getType(), std::min(uint64_t(Pos + 1), N->getZExtValue()));
1681 // memccpy -> llvm.memcpy
1682 copyFlags(*CI, B.CreateMemCpy(Dst, Align(1), Src, Align(1), NewN));
1683 return Pos + 1 <= N->getZExtValue()
1684 ? B.CreateInBoundsGEP(B.getInt8Ty(), Dst, NewN)
1686}
1687
1688Value *LibCallSimplifier::optimizeMemPCpy(CallInst *CI, IRBuilderBase &B) {
1689 Value *Dst = CI->getArgOperand(0);
1690 Value *N = CI->getArgOperand(2);
1691 // mempcpy(x, y, n) -> llvm.memcpy(align 1 x, align 1 y, n), x + n
1692 CallInst *NewCI =
1693 B.CreateMemCpy(Dst, Align(1), CI->getArgOperand(1), Align(1), N);
1694 // Propagate attributes, but memcpy has no return value, so make sure that
1695 // any return attributes are compliant.
1696 // TODO: Attach return value attributes to the 1st operand to preserve them?
1697 mergeAttributesAndFlags(NewCI, *CI);
1698 return B.CreateInBoundsGEP(B.getInt8Ty(), Dst, N);
1699}
1700
1701Value *LibCallSimplifier::optimizeMemMove(CallInst *CI, IRBuilderBase &B) {
1702 Value *Size = CI->getArgOperand(2);
1703 annotateNonNullAndDereferenceable(CI, {0, 1}, Size, DL);
1704 if (isa<IntrinsicInst>(CI))
1705 return nullptr;
1706
1707 // memmove(x, y, n) -> llvm.memmove(align 1 x, align 1 y, n)
1708 CallInst *NewCI = B.CreateMemMove(CI->getArgOperand(0), Align(1),
1709 CI->getArgOperand(1), Align(1), Size);
1710 mergeAttributesAndFlags(NewCI, *CI);
1711 return CI->getArgOperand(0);
1712}
1713
1714Value *LibCallSimplifier::optimizeMemSet(CallInst *CI, IRBuilderBase &B) {
1715 Value *Size = CI->getArgOperand(2);
1717 if (isa<IntrinsicInst>(CI))
1718 return nullptr;
1719
1720 // memset(p, v, n) -> llvm.memset(align 1 p, v, n)
1721 Value *Val = B.CreateIntCast(CI->getArgOperand(1), B.getInt8Ty(), false);
1722 CallInst *NewCI = B.CreateMemSet(CI->getArgOperand(0), Val, Size, Align(1));
1723 mergeAttributesAndFlags(NewCI, *CI);
1724 return CI->getArgOperand(0);
1725}
1726
1727Value *LibCallSimplifier::optimizeRealloc(CallInst *CI, IRBuilderBase &B) {
1729 Value *Malloc = emitMalloc(CI->getArgOperand(1), B, DL, TLI);
1730 if (auto *MallocCI = dyn_cast_or_null<CallInst>(Malloc))
1731 if (MDNode *MD = CI->getMetadata(LLVMContext::MD_alloc_token))
1732 MallocCI->setMetadata(LLVMContext::MD_alloc_token, MD);
1733 return copyFlags(*CI, Malloc);
1734 }
1735
1736 return nullptr;
1737}
1738
1739// Optionally allow optimization of nobuiltin calls to operator new and its
1740// variants.
1741Value *LibCallSimplifier::maybeOptimizeNoBuiltinOperatorNew(CallInst *CI,
1742 IRBuilderBase &B) {
1743 if (!OptimizeHotColdNew)
1744 return nullptr;
1746 if (!Callee)
1747 return nullptr;
1748 LibFunc Func;
1749 if (!TLI->getLibFunc(*Callee, Func))
1750 return nullptr;
1751 switch (Func) {
1752 case LibFunc_Znwm:
1753 case LibFunc_ZnwmRKSt9nothrow_t:
1754 case LibFunc_ZnwmSt11align_val_t:
1755 case LibFunc_ZnwmSt11align_val_tRKSt9nothrow_t:
1756 case LibFunc_Znam:
1757 case LibFunc_ZnamRKSt9nothrow_t:
1758 case LibFunc_ZnamSt11align_val_t:
1759 case LibFunc_ZnamSt11align_val_tRKSt9nothrow_t:
1760 case LibFunc_size_returning_new:
1761 case LibFunc_size_returning_new_aligned:
1762 // By default normal operator new calls (not already passing a hot_cold_t
1763 // parameter) are not mutated if the call is not marked builtin. Optionally
1764 // enable that in cases where it is known to be safe.
1766 return nullptr;
1767 break;
1768 case LibFunc_Znwm12__hot_cold_t:
1769 case LibFunc_ZnwmRKSt9nothrow_t12__hot_cold_t:
1770 case LibFunc_ZnwmSt11align_val_t12__hot_cold_t:
1771 case LibFunc_ZnwmSt11align_val_tRKSt9nothrow_t12__hot_cold_t:
1772 case LibFunc_Znam12__hot_cold_t:
1773 case LibFunc_ZnamRKSt9nothrow_t12__hot_cold_t:
1774 case LibFunc_ZnamSt11align_val_t12__hot_cold_t:
1775 case LibFunc_ZnamSt11align_val_tRKSt9nothrow_t12__hot_cold_t:
1776 case LibFunc_size_returning_new_hot_cold:
1777 case LibFunc_size_returning_new_aligned_hot_cold:
1778 // If the nobuiltin call already passes a hot_cold_t parameter, allow update
1779 // of that parameter when enabled.
1781 return nullptr;
1782 break;
1783 default:
1784 return nullptr;
1785 }
1786 return optimizeNew(CI, B, Func);
1787}
1788
1789// When enabled, replace operator new() calls marked with a hot or cold memprof
1790// attribute with an operator new() call that takes a __hot_cold_t parameter.
1791// Currently this is supported by the open source version of tcmalloc, see:
1792// https://github.com/google/tcmalloc/blob/master/tcmalloc/new_extension.h
1793Value *LibCallSimplifier::optimizeNew(CallInst *CI, IRBuilderBase &B,
1794 LibFunc &Func) {
1795 if (!OptimizeHotColdNew)
1796 return nullptr;
1797
1798 uint8_t HotCold;
1799 if (CI->getAttributes().getFnAttr("memprof").getValueAsString() == "cold")
1800 HotCold = ColdNewHintValue;
1801 else if (CI->getAttributes().getFnAttr("memprof").getValueAsString() ==
1802 "notcold")
1803 HotCold = NotColdNewHintValue;
1804 else if (CI->getAttributes().getFnAttr("memprof").getValueAsString() == "hot")
1805 HotCold = HotNewHintValue;
1806 else if (CI->getAttributes().getFnAttr("memprof").getValueAsString() ==
1807 "ambiguous")
1808 HotCold = AmbiguousNewHintValue;
1809 else
1810 return nullptr;
1811
1812 // For calls that already pass a hot/cold hint, only update the hint if
1813 // directed by OptimizeExistingHotColdNew. For other calls to new, add a hint
1814 // if cold or hot, and leave as-is for default handling if "notcold" aka warm.
1815 // Note that in cases where we decide it is "notcold", it might be slightly
1816 // better to replace the hinted call with a non hinted call, to avoid the
1817 // extra parameter and the if condition check of the hint value in the
1818 // allocator. This can be considered in the future.
1819 Value *NewCall = nullptr;
1820 switch (Func) {
1821 case LibFunc_Znwm12__hot_cold_t:
1823 NewCall = emitHotColdNew(CI->getArgOperand(0), B, TLI,
1824 LibFunc_Znwm12__hot_cold_t, HotCold);
1825 break;
1826 case LibFunc_Znwm:
1827 NewCall = emitHotColdNew(CI->getArgOperand(0), B, TLI,
1828 LibFunc_Znwm12__hot_cold_t, HotCold);
1829 break;
1830 case LibFunc_Znam12__hot_cold_t:
1832 NewCall = emitHotColdNew(CI->getArgOperand(0), B, TLI,
1833 LibFunc_Znam12__hot_cold_t, HotCold);
1834 break;
1835 case LibFunc_Znam:
1836 NewCall = emitHotColdNew(CI->getArgOperand(0), B, TLI,
1837 LibFunc_Znam12__hot_cold_t, HotCold);
1838 break;
1839 case LibFunc_ZnwmRKSt9nothrow_t12__hot_cold_t:
1841 NewCall = emitHotColdNewNoThrow(
1842 CI->getArgOperand(0), CI->getArgOperand(1), B, TLI,
1843 LibFunc_ZnwmRKSt9nothrow_t12__hot_cold_t, HotCold);
1844 break;
1845 case LibFunc_ZnwmRKSt9nothrow_t:
1846 NewCall = emitHotColdNewNoThrow(
1847 CI->getArgOperand(0), CI->getArgOperand(1), B, TLI,
1848 LibFunc_ZnwmRKSt9nothrow_t12__hot_cold_t, HotCold);
1849 break;
1850 case LibFunc_ZnamRKSt9nothrow_t12__hot_cold_t:
1852 NewCall = emitHotColdNewNoThrow(
1853 CI->getArgOperand(0), CI->getArgOperand(1), B, TLI,
1854 LibFunc_ZnamRKSt9nothrow_t12__hot_cold_t, HotCold);
1855 break;
1856 case LibFunc_ZnamRKSt9nothrow_t:
1857 NewCall = emitHotColdNewNoThrow(
1858 CI->getArgOperand(0), CI->getArgOperand(1), B, TLI,
1859 LibFunc_ZnamRKSt9nothrow_t12__hot_cold_t, HotCold);
1860 break;
1861 case LibFunc_ZnwmSt11align_val_t12__hot_cold_t:
1863 NewCall = emitHotColdNewAligned(
1864 CI->getArgOperand(0), CI->getArgOperand(1), B, TLI,
1865 LibFunc_ZnwmSt11align_val_t12__hot_cold_t, HotCold);
1866 break;
1867 case LibFunc_ZnwmSt11align_val_t:
1868 NewCall = emitHotColdNewAligned(
1869 CI->getArgOperand(0), CI->getArgOperand(1), B, TLI,
1870 LibFunc_ZnwmSt11align_val_t12__hot_cold_t, HotCold);
1871 break;
1872 case LibFunc_ZnamSt11align_val_t12__hot_cold_t:
1874 NewCall = emitHotColdNewAligned(
1875 CI->getArgOperand(0), CI->getArgOperand(1), B, TLI,
1876 LibFunc_ZnamSt11align_val_t12__hot_cold_t, HotCold);
1877 break;
1878 case LibFunc_ZnamSt11align_val_t:
1879 NewCall = emitHotColdNewAligned(
1880 CI->getArgOperand(0), CI->getArgOperand(1), B, TLI,
1881 LibFunc_ZnamSt11align_val_t12__hot_cold_t, HotCold);
1882 break;
1883 case LibFunc_ZnwmSt11align_val_tRKSt9nothrow_t12__hot_cold_t:
1886 CI->getArgOperand(0), CI->getArgOperand(1), CI->getArgOperand(2), B,
1887 TLI, LibFunc_ZnwmSt11align_val_tRKSt9nothrow_t12__hot_cold_t,
1888 HotCold);
1889 break;
1890 case LibFunc_ZnwmSt11align_val_tRKSt9nothrow_t:
1892 CI->getArgOperand(0), CI->getArgOperand(1), CI->getArgOperand(2), B,
1893 TLI, LibFunc_ZnwmSt11align_val_tRKSt9nothrow_t12__hot_cold_t, HotCold);
1894 break;
1895 case LibFunc_ZnamSt11align_val_tRKSt9nothrow_t12__hot_cold_t:
1898 CI->getArgOperand(0), CI->getArgOperand(1), CI->getArgOperand(2), B,
1899 TLI, LibFunc_ZnamSt11align_val_tRKSt9nothrow_t12__hot_cold_t,
1900 HotCold);
1901 break;
1902 case LibFunc_ZnamSt11align_val_tRKSt9nothrow_t:
1904 CI->getArgOperand(0), CI->getArgOperand(1), CI->getArgOperand(2), B,
1905 TLI, LibFunc_ZnamSt11align_val_tRKSt9nothrow_t12__hot_cold_t, HotCold);
1906 break;
1907 case LibFunc_size_returning_new:
1908 NewCall = emitHotColdSizeReturningNew(CI->getArgOperand(0), B, TLI,
1909 LibFunc_size_returning_new_hot_cold,
1910 HotCold);
1911 break;
1912 case LibFunc_size_returning_new_hot_cold:
1914 NewCall = emitHotColdSizeReturningNew(CI->getArgOperand(0), B, TLI,
1915 LibFunc_size_returning_new_hot_cold,
1916 HotCold);
1917 break;
1918 case LibFunc_size_returning_new_aligned:
1920 CI->getArgOperand(0), CI->getArgOperand(1), B, TLI,
1921 LibFunc_size_returning_new_aligned_hot_cold, HotCold);
1922 break;
1923 case LibFunc_size_returning_new_aligned_hot_cold:
1926 CI->getArgOperand(0), CI->getArgOperand(1), B, TLI,
1927 LibFunc_size_returning_new_aligned_hot_cold, HotCold);
1928 break;
1929 default:
1930 return nullptr;
1931 }
1932
1933 if (auto *NewCI = dyn_cast_or_null<Instruction>(NewCall))
1934 NewCI->copyMetadata(*CI);
1935
1936 return NewCall;
1937}
1938
1939//===----------------------------------------------------------------------===//
1940// Math Library Optimizations
1941//===----------------------------------------------------------------------===//
1942
1943// Replace a libcall \p CI with a call to intrinsic \p IID
1945 Intrinsic::ID IID) {
1946 Value *NewCall = B.CreateUnaryIntrinsic(IID, CI->getArgOperand(0), CI);
1947 NewCall->takeName(CI);
1948 return copyFlags(*CI, NewCall);
1949}
1950
1952 Intrinsic::ID IID) {
1953 Value *NewCall = B.CreateBinaryIntrinsic(IID, CI->getArgOperand(0),
1954 CI->getArgOperand(1), CI);
1955 NewCall->takeName(CI);
1956 return copyFlags(*CI, NewCall);
1957}
1958
1959/// Return a variant of Val with float type.
1960/// Currently this works in two cases: If Val is an FPExtension of a float
1961/// value to something bigger, simply return the operand.
1962/// If Val is a ConstantFP but can be converted to a float ConstantFP without
1963/// loss of precision do so.
1965 if (FPExtInst *Cast = dyn_cast<FPExtInst>(Val)) {
1966 Value *Op = Cast->getOperand(0);
1967 if (Op->getType()->isFloatTy())
1968 return Op;
1969 }
1970 if (ConstantFP *Const = dyn_cast<ConstantFP>(Val)) {
1971 APFloat F = Const->getValueAPF();
1972 bool losesInfo;
1974 &losesInfo);
1975 if (!losesInfo)
1976 return ConstantFP::get(Const->getContext(), F);
1977 }
1978 return nullptr;
1979}
1980
1981/// Shrink double -> float functions.
1983 bool isBinary, const TargetLibraryInfo *TLI,
1984 bool isPrecise = false) {
1985 Function *CalleeFn = CI->getCalledFunction();
1986 if (!CI->getType()->isDoubleTy() || !CalleeFn)
1987 return nullptr;
1988
1989 // If not all the uses of the function are converted to float, then bail out.
1990 // This matters if the precision of the result is more important than the
1991 // precision of the arguments.
1992 if (isPrecise)
1993 for (User *U : CI->users()) {
1995 if (!Cast || !Cast->getType()->isFloatTy())
1996 return nullptr;
1997 }
1998
1999 // If this is something like 'g((double) float)', convert to 'gf(float)'.
2000 Value *V[2];
2002 V[1] = isBinary ? valueHasFloatPrecision(CI->getArgOperand(1)) : nullptr;
2003 if (!V[0] || (isBinary && !V[1]))
2004 return nullptr;
2005
2006 // If call isn't an intrinsic, check that it isn't within a function with the
2007 // same name as the float version of this call, otherwise the result is an
2008 // infinite loop. For example, from MinGW-w64:
2009 //
2010 // float expf(float val) { return (float) exp((double) val); }
2011 StringRef CalleeName = CalleeFn->getName();
2012 bool IsIntrinsic = CalleeFn->isIntrinsic();
2013 if (!IsIntrinsic) {
2014 StringRef CallerName = CI->getFunction()->getName();
2015 if (CallerName.ends_with('f') &&
2016 CallerName.size() == (CalleeName.size() + 1) &&
2017 CallerName.starts_with(CalleeName))
2018 return nullptr;
2019 }
2020
2021 // Propagate the math semantics from the current function to the new function.
2023 B.setFastMathFlags(CI->getFastMathFlags());
2024
2025 // g((double) float) -> (double) gf(float)
2026 Value *R;
2027 if (IsIntrinsic) {
2028 Intrinsic::ID IID = CalleeFn->getIntrinsicID();
2029 R = isBinary ? B.CreateIntrinsic(IID, B.getFloatTy(), V)
2030 : B.CreateIntrinsic(IID, B.getFloatTy(), V[0]);
2031 } else {
2032 AttributeList CallsiteAttrs = CI->getAttributes();
2033 R = isBinary
2034 ? emitBinaryFloatFnCall(V[0], V[1], TLI, CalleeName, B,
2035 CallsiteAttrs)
2036 : emitUnaryFloatFnCall(V[0], TLI, CalleeName, B, CallsiteAttrs);
2037 }
2038 return B.CreateFPExt(R, B.getDoubleTy());
2039}
2040
2041/// Shrink double -> float for unary functions.
2043 const TargetLibraryInfo *TLI,
2044 bool isPrecise = false) {
2045 return optimizeDoubleFP(CI, B, false, TLI, isPrecise);
2046}
2047
2048/// Shrink double -> float for binary functions.
2050 const TargetLibraryInfo *TLI,
2051 bool isPrecise = false) {
2052 return optimizeDoubleFP(CI, B, true, TLI, isPrecise);
2053}
2054
2055/// Shrink double -> float for llvm.sincos.
2057 auto *RetTy = dyn_cast<StructType>(CI->getType());
2058 if (!RetTy || RetTy->getNumElements() != 2 ||
2059 !RetTy->getElementType(0)->getScalarType()->isDoubleTy())
2060 return nullptr;
2061
2063 if (!X)
2064 if (auto *Ext = dyn_cast<FPExtInst>(CI->getArgOperand(0)))
2065 if (Ext->getOperand(0)->getType()->getScalarType()->isFloatTy())
2066 X = Ext->getOperand(0);
2067 if (!X)
2068 return nullptr;
2069
2070 for (User *U : CI->users()) {
2071 auto *EV = dyn_cast<ExtractValueInst>(U);
2072 if (!EV)
2073 return nullptr;
2074 for (User *EVU : EV->users()) {
2075 auto *Cast = dyn_cast<FPTruncInst>(EVU);
2076 if (!Cast || !Cast->getType()->getScalarType()->isFloatTy())
2077 return nullptr;
2078 }
2079 }
2080
2082 B.setFastMathFlags(CI->getFastMathFlags());
2083
2084 Value *NewCall = B.CreateIntrinsic(Intrinsic::sincos, X->getType(), X);
2085 cast<Instruction>(NewCall)->setMetadata(
2086 LLVMContext::MD_fpmath, CI->getMetadata(LLVMContext::MD_fpmath));
2087 Value *Res = PoisonValue::get(RetTy);
2088 for (unsigned I = 0; I != 2; ++I) {
2089 Value *Ext = B.CreateFPExt(B.CreateExtractValue(NewCall, I),
2090 RetTy->getElementType(I));
2091 Res = B.CreateInsertValue(Res, Ext, I);
2092 }
2093 return Res;
2094}
2095
2096// cabs(z) -> sqrt((creal(z)*creal(z)) + (cimag(z)*cimag(z)))
2097Value *LibCallSimplifier::optimizeCAbs(CallInst *CI, IRBuilderBase &B) {
2098 Value *Real, *Imag;
2099
2100 if (CI->arg_size() == 1) {
2101
2102 if (!CI->isFast())
2103 return nullptr;
2104
2105 Value *Op = CI->getArgOperand(0);
2106 assert(Op->getType()->isArrayTy() && "Unexpected signature for cabs!");
2107
2108 Real = B.CreateExtractValue(Op, 0, "real");
2109 Imag = B.CreateExtractValue(Op, 1, "imag");
2110
2111 } else {
2112 assert(CI->arg_size() == 2 && "Unexpected signature for cabs!");
2113
2114 Real = CI->getArgOperand(0);
2115 Imag = CI->getArgOperand(1);
2116
2117 // if real or imaginary part is zero, simplify to abs(cimag(z))
2118 // or abs(creal(z))
2119 Value *AbsOp = nullptr;
2120 if (ConstantFP *ConstReal = dyn_cast<ConstantFP>(Real)) {
2121 if (ConstReal->isZero())
2122 AbsOp = Imag;
2123
2124 } else if (ConstantFP *ConstImag = dyn_cast<ConstantFP>(Imag)) {
2125 if (ConstImag->isZero())
2126 AbsOp = Real;
2127 }
2128
2129 if (AbsOp)
2130 return copyFlags(*CI, B.CreateFAbs(AbsOp, CI, "cabs"));
2131
2132 if (!CI->isFast())
2133 return nullptr;
2134 }
2135
2136 // Propagate fast-math flags from the existing call to new instructions.
2137 Value *RealReal = B.CreateFMulFMF(Real, Real, CI);
2138 Value *ImagImag = B.CreateFMulFMF(Imag, Imag, CI);
2139 return copyFlags(
2140 *CI, B.CreateUnaryIntrinsic(Intrinsic::sqrt,
2141 B.CreateFAddFMF(RealReal, ImagImag, CI), CI,
2142 "cabs"));
2143}
2144
2145// Return a properly extended integer (DstWidth bits wide) if the operation is
2146// an itofp.
2147static Value *getIntToFPVal(Value *I2F, IRBuilderBase &B, unsigned DstWidth) {
2148 if (isa<SIToFPInst>(I2F) || isa<UIToFPInst>(I2F)) {
2149 Value *Op = cast<Instruction>(I2F)->getOperand(0);
2150 // Make sure that the exponent fits inside an "int" of size DstWidth,
2151 // thus avoiding any range issues that FP has not.
2152 unsigned BitWidth = Op->getType()->getScalarSizeInBits();
2153 if (BitWidth < DstWidth || (BitWidth == DstWidth && isa<SIToFPInst>(I2F))) {
2154 Type *IntTy = Op->getType()->getWithNewBitWidth(DstWidth);
2155 return isa<SIToFPInst>(I2F) ? B.CreateSExt(Op, IntTy)
2156 : B.CreateZExt(Op, IntTy);
2157 }
2158 }
2159
2160 return nullptr;
2161}
2162
2163/// Use exp{,2}(x * y) for pow(exp{,2}(x), y);
2164/// ldexp(1.0, x) for pow(2.0, itofp(x)); exp2(n * x) for pow(2.0 ** n, x);
2165/// exp10(x) for pow(10.0, x); exp2(log2(n) * x) for pow(n, x).
2166Value *LibCallSimplifier::replacePowWithExp(CallInst *Pow, IRBuilderBase &B) {
2167 Module *M = Pow->getModule();
2168 Value *Base = Pow->getArgOperand(0), *Expo = Pow->getArgOperand(1);
2169 Type *Ty = Pow->getType();
2170 bool Ignored;
2171
2172 // Evaluate special cases related to a nested function as the base.
2173
2174 // pow(exp(x), y) -> exp(x * y)
2175 // pow(exp2(x), y) -> exp2(x * y)
2176 // If exp{,2}() is used only once, it is better to fold two transcendental
2177 // math functions into one. If used again, exp{,2}() would still have to be
2178 // called with the original argument, then keep both original transcendental
2179 // functions. However, this transformation is only safe with fully relaxed
2180 // math semantics, since, besides rounding differences, it changes overflow
2181 // and underflow behavior quite dramatically. For example:
2182 // pow(exp(1000), 0.001) = pow(inf, 0.001) = inf
2183 // Whereas:
2184 // exp(1000 * 0.001) = exp(1)
2185 // TODO: Loosen the requirement for fully relaxed math semantics.
2186 // TODO: Handle exp10() when more targets have it available.
2187 CallInst *BaseFn = dyn_cast<CallInst>(Base);
2188 if (BaseFn && BaseFn->hasOneUse() && BaseFn->isFast() && Pow->isFast()) {
2189 LibFunc LibFn;
2190
2191 Function *CalleeFn = BaseFn->getCalledFunction();
2192 if (CalleeFn && TLI->getLibFunc(CalleeFn->getName(), LibFn) &&
2193 isLibFuncEmittable(M, TLI, LibFn)) {
2194 StringRef ExpName;
2196 Value *ExpFn;
2197 LibFunc LibFnFloat, LibFnDouble, LibFnLongDouble;
2198
2199 switch (LibFn) {
2200 default:
2201 return nullptr;
2202 case LibFunc_expf:
2203 case LibFunc_exp:
2204 case LibFunc_expl:
2205 ExpName = TLI->getName(LibFunc_exp);
2206 ID = Intrinsic::exp;
2207 LibFnFloat = LibFunc_expf;
2208 LibFnDouble = LibFunc_exp;
2209 LibFnLongDouble = LibFunc_expl;
2210 break;
2211 case LibFunc_exp2f:
2212 case LibFunc_exp2:
2213 case LibFunc_exp2l:
2214 ExpName = TLI->getName(LibFunc_exp2);
2215 ID = Intrinsic::exp2;
2216 LibFnFloat = LibFunc_exp2f;
2217 LibFnDouble = LibFunc_exp2;
2218 LibFnLongDouble = LibFunc_exp2l;
2219 break;
2220 }
2221
2222 // Create new exp{,2}() with the product as its argument.
2223 Value *FMul = B.CreateFMul(BaseFn->getArgOperand(0), Expo, "mul");
2224 ExpFn = BaseFn->doesNotAccessMemory()
2225 ? B.CreateUnaryIntrinsic(ID, FMul, nullptr, ExpName)
2226 : emitUnaryFloatFnCall(FMul, TLI, LibFnDouble, LibFnFloat,
2227 LibFnLongDouble, B,
2228 BaseFn->getAttributes());
2229
2230 // Since the new exp{,2}() is different from the original one, dead code
2231 // elimination cannot be trusted to remove it, since it may have side
2232 // effects (e.g., errno). When the only consumer for the original
2233 // exp{,2}() is pow(), then it has to be explicitly erased.
2234 substituteInParent(BaseFn, ExpFn);
2235 return ExpFn;
2236 }
2237 }
2238
2239 // Evaluate special cases related to a constant base.
2240
2241 const APFloat *BaseF;
2242 if (!match(Base, m_APFloat(BaseF)))
2243 return nullptr;
2244
2245 AttributeList NoAttrs; // Attributes are only meaningful on the original call
2246
2247 const bool UseIntrinsic = Pow->doesNotAccessMemory();
2248
2249 // pow(2.0, itofp(x)) -> ldexp(1.0, x)
2250 if ((UseIntrinsic || !Ty->isVectorTy()) && BaseF->isExactlyValue(2.0) &&
2251 (isa<SIToFPInst>(Expo) || isa<UIToFPInst>(Expo)) &&
2252 (UseIntrinsic ||
2253 hasFloatFn(M, TLI, Ty, LibFunc_ldexp, LibFunc_ldexpf, LibFunc_ldexpl))) {
2254
2255 // TODO: Shouldn't really need to depend on getIntToFPVal for intrinsic. Can
2256 // just directly use the original integer type.
2257 if (Value *ExpoI = getIntToFPVal(Expo, B, TLI->getIntSize())) {
2258 Constant *One = ConstantFP::get(Ty, 1.0);
2259
2260 if (UseIntrinsic) {
2261 return copyFlags(*Pow, B.CreateIntrinsic(Intrinsic::ldexp,
2262 {Ty, ExpoI->getType()},
2263 {One, ExpoI}, Pow, "exp2"));
2264 }
2265
2267 One, ExpoI, TLI, LibFunc_ldexp, LibFunc_ldexpf,
2268 LibFunc_ldexpl, B, NoAttrs));
2269 }
2270 }
2271
2272 // pow(2.0 ** n, x) -> exp2(n * x)
2273 if (hasFloatFn(M, TLI, Ty, LibFunc_exp2, LibFunc_exp2f, LibFunc_exp2l)) {
2274 APFloat BaseR = APFloat(1.0);
2275 BaseR.convert(BaseF->getSemantics(), APFloat::rmTowardZero, &Ignored);
2276 BaseR = BaseR / *BaseF;
2277 bool IsInteger = BaseF->isInteger(), IsReciprocal = BaseR.isInteger();
2278 const APFloat *NF = IsReciprocal ? &BaseR : BaseF;
2279 APSInt NI(64, false);
2280 if ((IsInteger || IsReciprocal) &&
2281 NF->convertToInteger(NI, APFloat::rmTowardZero, &Ignored) ==
2282 APFloat::opOK &&
2283 NI > 1 && NI.isPowerOf2()) {
2284 double N = NI.logBase2() * (IsReciprocal ? -1.0 : 1.0);
2285 Value *FMul = B.CreateFMul(Expo, ConstantFP::get(Ty, N), "mul");
2286 if (Pow->doesNotAccessMemory())
2287 return copyFlags(*Pow, B.CreateUnaryIntrinsic(Intrinsic::exp2, FMul,
2288 nullptr, "exp2"));
2289 else
2290 return copyFlags(*Pow, emitUnaryFloatFnCall(FMul, TLI, LibFunc_exp2,
2291 LibFunc_exp2f,
2292 LibFunc_exp2l, B, NoAttrs));
2293 }
2294 }
2295
2296 // pow(10.0, x) -> exp10(x)
2297 if (BaseF->isExactlyValue(10.0) &&
2298 hasFloatFn(M, TLI, Ty, LibFunc_exp10, LibFunc_exp10f, LibFunc_exp10l)) {
2299
2300 if (Pow->doesNotAccessMemory()) {
2301 return B.CreateIntrinsic(Intrinsic::exp10, {Ty}, {Expo}, Pow, "exp10", {},
2302 [Pow](CallInst *CI) { CI->copyIRFlags(Pow); });
2303 }
2304
2305 return copyFlags(*Pow, emitUnaryFloatFnCall(Expo, TLI, LibFunc_exp10,
2306 LibFunc_exp10f, LibFunc_exp10l,
2307 B, NoAttrs));
2308 }
2309
2310 // pow(x, y) -> exp2(log2(x) * y)
2311 if (Pow->hasApproxFunc() && Pow->hasNoNaNs() && BaseF->isFiniteNonZero() &&
2312 !BaseF->isNegative()) {
2313 // pow(1, inf) is defined to be 1 but exp2(log2(1) * inf) evaluates to NaN.
2314 // Luckily optimizePow has already handled the x == 1 case.
2315 assert(!match(Base, m_FPOne()) &&
2316 "pow(1.0, y) should have been simplified earlier!");
2317
2318 Value *Log = nullptr;
2319 if (Ty->isFloatTy())
2320 Log = ConstantFP::get(Ty, std::log2(BaseF->convertToFloat()));
2321 else if (Ty->isDoubleTy())
2322 Log = ConstantFP::get(Ty, std::log2(BaseF->convertToDouble()));
2323
2324 if (Log) {
2325 Value *FMul = B.CreateFMul(Log, Expo, "mul");
2326 if (Pow->doesNotAccessMemory())
2327 return copyFlags(*Pow, B.CreateUnaryIntrinsic(Intrinsic::exp2, FMul,
2328 nullptr, "exp2"));
2329 else if (hasFloatFn(M, TLI, Ty, LibFunc_exp2, LibFunc_exp2f,
2330 LibFunc_exp2l))
2331 return copyFlags(*Pow, emitUnaryFloatFnCall(FMul, TLI, LibFunc_exp2,
2332 LibFunc_exp2f,
2333 LibFunc_exp2l, B, NoAttrs));
2334 }
2335 }
2336
2337 return nullptr;
2338}
2339
2340static Value *getSqrtCall(Value *V, AttributeList Attrs, bool NoErrno,
2341 Module *M, IRBuilderBase &B,
2342 const TargetLibraryInfo *TLI) {
2343 // If errno is never set, then use the intrinsic for sqrt().
2344 if (NoErrno)
2345 return B.CreateUnaryIntrinsic(Intrinsic::sqrt, V, nullptr, "sqrt");
2346
2347 // Otherwise, use the libcall for sqrt().
2348 if (hasFloatFn(M, TLI, V->getType(), LibFunc_sqrt, LibFunc_sqrtf,
2349 LibFunc_sqrtl))
2350 // TODO: We also should check that the target can in fact lower the sqrt()
2351 // libcall. We currently have no way to ask this question, so we ask if
2352 // the target has a sqrt() libcall, which is not exactly the same.
2353 return emitUnaryFloatFnCall(V, TLI, LibFunc_sqrt, LibFunc_sqrtf,
2354 LibFunc_sqrtl, B, Attrs);
2355
2356 return nullptr;
2357}
2358
2359/// Use square root in place of pow(x, +/-0.5).
2360Value *LibCallSimplifier::replacePowWithSqrt(CallInst *Pow, IRBuilderBase &B) {
2361 Value *Sqrt, *Base = Pow->getArgOperand(0), *Expo = Pow->getArgOperand(1);
2362 Module *Mod = Pow->getModule();
2363 Type *Ty = Pow->getType();
2364
2365 const APFloat *ExpoF;
2366 if (!match(Expo, m_APFloat(ExpoF)) ||
2367 (!ExpoF->isExactlyValue(0.5) && !ExpoF->isExactlyValue(-0.5)))
2368 return nullptr;
2369
2370 // Converting pow(X, -0.5) to 1/sqrt(X) may introduce an extra rounding step,
2371 // so that requires fast-math-flags (afn or reassoc).
2372 if (ExpoF->isNegative() && (!Pow->hasApproxFunc() && !Pow->hasAllowReassoc()))
2373 return nullptr;
2374
2375 // If we have a pow() library call (accesses memory) and we can't guarantee
2376 // that the base is not an infinity, give up:
2377 // pow(-Inf, 0.5) is optionally required to have a result of +Inf (not setting
2378 // errno), but sqrt(-Inf) is required by various standards to set errno.
2379 if (!Pow->doesNotAccessMemory() && !Pow->hasNoInfs() &&
2381 Base, SimplifyQuery(DL, TLI, DT, AC, Pow, true, true, DC)))
2382 return nullptr;
2383
2384 Sqrt = getSqrtCall(Base, AttributeList(), Pow->doesNotAccessMemory(), Mod, B,
2385 TLI);
2386 if (!Sqrt)
2387 return nullptr;
2388
2389 // Handle signed zero base by expanding to fabs(sqrt(x)).
2390 if (!Pow->hasNoSignedZeros())
2391 Sqrt = B.CreateFAbs(Sqrt, nullptr, "abs");
2392
2393 Sqrt = copyFlags(*Pow, Sqrt);
2394
2395 // Handle non finite base by expanding to
2396 // (x == -infinity ? +infinity : sqrt(x)).
2397 if (!Pow->hasNoInfs()) {
2398 Value *PosInf = ConstantFP::getInfinity(Ty),
2399 *NegInf = ConstantFP::getInfinity(Ty, true);
2400 Value *FCmp = B.CreateFCmpOEQ(Base, NegInf, "isinf");
2401 Sqrt = B.CreateSelect(FCmp, PosInf, Sqrt);
2402 }
2403
2404 // If the exponent is negative, then get the reciprocal.
2405 if (ExpoF->isNegative())
2406 Sqrt = B.CreateFDiv(ConstantFP::get(Ty, 1.0), Sqrt, "reciprocal");
2407
2408 return Sqrt;
2409}
2410
2412 IRBuilderBase &B) {
2413 Value *Args[] = {Base, Expo};
2414 Type *Types[] = {Base->getType(), Expo->getType()};
2415 return B.CreateIntrinsic(Intrinsic::powi, Types, Args);
2416}
2417
2418Value *LibCallSimplifier::optimizePow(CallInst *Pow, IRBuilderBase &B) {
2419 Value *Base = Pow->getArgOperand(0);
2420 Value *Expo = Pow->getArgOperand(1);
2421 Function *Callee = Pow->getCalledFunction();
2422 StringRef Name = Callee->getName();
2423 Type *Ty = Pow->getType();
2424 Module *M = Pow->getModule();
2425 bool AllowApprox = Pow->hasApproxFunc();
2426 bool Ignored;
2427
2428 // Propagate the math semantics from the call to any created instructions.
2429 IRBuilderBase::FastMathFlagGuard Guard(B);
2430 B.setFastMathFlags(Pow->getFastMathFlags());
2431 // Evaluate special cases related to the base.
2432
2433 // pow(1.0, x) -> 1.0
2434 if (match(Base, m_FPOne()))
2435 return Base;
2436
2437 if (Value *Exp = replacePowWithExp(Pow, B))
2438 return Exp;
2439
2440 // Evaluate special cases related to the exponent.
2441
2442 // pow(x, -1.0) -> 1.0 / x
2443 if (match(Expo, m_SpecificFP(-1.0)))
2444 return B.CreateFDiv(ConstantFP::get(Ty, 1.0), Base, "reciprocal");
2445
2446 // pow(x, +/-0.0) -> 1.0
2447 if (match(Expo, m_AnyZeroFP()))
2448 return ConstantFP::get(Ty, 1.0);
2449
2450 // pow(x, 1.0) -> x
2451 if (match(Expo, m_FPOne()))
2452 return Base;
2453
2454 // pow(x, 2.0) -> x * x
2455 if (match(Expo, m_SpecificFP(2.0)) && Pow->doesNotAccessMemory())
2456 return B.CreateFMul(Base, Base, "square");
2457
2458 if (Value *Sqrt = replacePowWithSqrt(Pow, B))
2459 return Sqrt;
2460
2461 // If we can approximate pow:
2462 // pow(x, n) -> powi(x, n) * sqrt(x) if n has exactly a 0.5 fraction
2463 // pow(x, n) -> powi(x, n) if n is a constant signed integer value
2464 const APFloat *ExpoF;
2465 if (AllowApprox && match(Expo, m_APFloat(ExpoF)) &&
2466 !ExpoF->isExactlyValue(0.5) && !ExpoF->isExactlyValue(-0.5)) {
2467 APFloat ExpoA(abs(*ExpoF));
2468 APFloat ExpoI(*ExpoF);
2469 Value *Sqrt = nullptr;
2470 if (!ExpoA.isInteger()) {
2471 APFloat Expo2 = ExpoA;
2472 // To check if ExpoA is an integer + 0.5, we add it to itself. If there
2473 // is no floating point exception and the result is an integer, then
2474 // ExpoA == integer + 0.5
2475 if (Expo2.add(ExpoA, APFloat::rmNearestTiesToEven) != APFloat::opOK)
2476 return nullptr;
2477
2478 if (!Expo2.isInteger())
2479 return nullptr;
2480
2481 if (ExpoI.roundToIntegral(APFloat::rmTowardNegative) !=
2483 return nullptr;
2484 if (!ExpoI.isInteger())
2485 return nullptr;
2486 ExpoF = &ExpoI;
2487
2488 Sqrt = getSqrtCall(Base, AttributeList(), Pow->doesNotAccessMemory(), M,
2489 B, TLI);
2490 if (!Sqrt)
2491 return nullptr;
2492 }
2493
2494 // 0.5 fraction is now optionally handled.
2495 // Do pow -> powi for remaining integer exponent
2496 APSInt IntExpo(TLI->getIntSize(), /*isUnsigned=*/false);
2497 if (ExpoF->isInteger() &&
2498 ExpoF->convertToInteger(IntExpo, APFloat::rmTowardZero, &Ignored) ==
2499 APFloat::opOK) {
2500 Value *PowI = copyFlags(
2501 *Pow,
2503 Base, ConstantInt::get(B.getIntNTy(TLI->getIntSize()), IntExpo),
2504 M, B));
2505
2506 if (PowI && Sqrt)
2507 return B.CreateFMul(PowI, Sqrt);
2508
2509 return PowI;
2510 }
2511 }
2512
2513 // powf(x, itofp(y)) -> powi(x, y)
2514 if (AllowApprox && (isa<SIToFPInst>(Expo) || isa<UIToFPInst>(Expo))) {
2515 if (Value *ExpoI = getIntToFPVal(Expo, B, TLI->getIntSize()))
2516 return copyFlags(*Pow, createPowWithIntegerExponent(Base, ExpoI, M, B));
2517 }
2518
2519 // Shrink pow() to powf() if the arguments are single precision,
2520 // unless the result is expected to be double precision.
2521 if (UnsafeFPShrink && Name == TLI->getName(LibFunc_pow) &&
2522 hasFloatVersion(M, Name)) {
2523 if (Value *Shrunk = optimizeBinaryDoubleFP(Pow, B, TLI, true))
2524 return Shrunk;
2525 }
2526
2527 return nullptr;
2528}
2529
2530Value *LibCallSimplifier::optimizeExp2(CallInst *CI, IRBuilderBase &B) {
2531 Module *M = CI->getModule();
2533 StringRef Name = Callee->getName();
2534 Value *Ret = nullptr;
2535 if (UnsafeFPShrink && Name == TLI->getName(LibFunc_exp2) &&
2536 hasFloatVersion(M, Name))
2537 Ret = optimizeUnaryDoubleFP(CI, B, TLI, true);
2538
2539 // If we have an llvm.exp2 intrinsic, emit the llvm.ldexp intrinsic. If we
2540 // have the libcall, emit the libcall.
2541 //
2542 // TODO: In principle we should be able to just always use the intrinsic for
2543 // any doesNotAccessMemory callsite.
2544
2545 const bool UseIntrinsic = Callee->isIntrinsic();
2546 // Bail out for vectors because the code below only expects scalars.
2547 Type *Ty = CI->getType();
2548 if (!UseIntrinsic && Ty->isVectorTy())
2549 return Ret;
2550
2551 // exp2(sitofp(x)) -> ldexp(1.0, sext(x)) if sizeof(x) <= IntSize
2552 // exp2(uitofp(x)) -> ldexp(1.0, zext(x)) if sizeof(x) < IntSize
2553 Value *Op = CI->getArgOperand(0);
2554 if ((isa<SIToFPInst>(Op) || isa<UIToFPInst>(Op)) &&
2555 (UseIntrinsic ||
2556 hasFloatFn(M, TLI, Ty, LibFunc_ldexp, LibFunc_ldexpf, LibFunc_ldexpl))) {
2557 if (Value *Exp = getIntToFPVal(Op, B, TLI->getIntSize())) {
2558 Constant *One = ConstantFP::get(Ty, 1.0);
2559
2560 if (UseIntrinsic) {
2561 return copyFlags(*CI, B.CreateIntrinsic(Intrinsic::ldexp,
2562 {Ty, Exp->getType()},
2563 {One, Exp}, CI));
2564 }
2565
2566 IRBuilderBase::FastMathFlagGuard Guard(B);
2567 B.setFastMathFlags(CI->getFastMathFlags());
2568 return copyFlags(*CI, emitBinaryFloatFnCall(
2569 One, Exp, TLI, LibFunc_ldexp, LibFunc_ldexpf,
2570 LibFunc_ldexpl, B, AttributeList()));
2571 }
2572 }
2573
2574 return Ret;
2575}
2576
2577Value *LibCallSimplifier::optimizeFMinFMax(CallInst *CI, IRBuilderBase &B,
2578 Intrinsic::ID IID) {
2579 // The LLVM intrinsics minnum/maxnum correspond to fmin/fmax. Canonicalize to
2580 // the intrinsics for improved optimization (for example, vectorization).
2581 // No-signed-zeros is implied by the definitions of fmax/fmin themselves.
2582 // From the C standard draft WG14/N1256:
2583 // "Ideally, fmax would be sensitive to the sign of zero, for example
2584 // fmax(-0.0, +0.0) would return +0; however, implementation in software
2585 // might be impractical."
2586 FastMathFlags FMF = CI->getFastMathFlags();
2587 FMF.setNoSignedZeros();
2588 return copyFlags(*CI, B.CreateBinaryIntrinsic(IID, CI->getArgOperand(0),
2589 CI->getArgOperand(1), FMF));
2590}
2591
2592Value *LibCallSimplifier::optimizeLog(CallInst *Log, IRBuilderBase &B) {
2593 Function *LogFn = Log->getCalledFunction();
2594 StringRef LogNm = LogFn->getName();
2595 Intrinsic::ID LogID = LogFn->getIntrinsicID();
2596 Module *Mod = Log->getModule();
2597 Type *Ty = Log->getType();
2598
2599 if (UnsafeFPShrink && hasFloatVersion(Mod, LogNm))
2600 if (Value *Ret = optimizeUnaryDoubleFP(Log, B, TLI, true))
2601 return Ret;
2602
2603 LibFunc LogLb, ExpLb, Exp2Lb, Exp10Lb, PowLb;
2604
2605 // This is only applicable to log(), log2(), log10().
2606 if (TLI->getLibFunc(LogNm, LogLb)) {
2607 switch (LogLb) {
2608 case LibFunc_logf:
2609 LogID = Intrinsic::log;
2610 ExpLb = LibFunc_expf;
2611 Exp2Lb = LibFunc_exp2f;
2612 Exp10Lb = LibFunc_exp10f;
2613 PowLb = LibFunc_powf;
2614 break;
2615 case LibFunc_log:
2616 LogID = Intrinsic::log;
2617 ExpLb = LibFunc_exp;
2618 Exp2Lb = LibFunc_exp2;
2619 Exp10Lb = LibFunc_exp10;
2620 PowLb = LibFunc_pow;
2621 break;
2622 case LibFunc_logl:
2623 LogID = Intrinsic::log;
2624 ExpLb = LibFunc_expl;
2625 Exp2Lb = LibFunc_exp2l;
2626 Exp10Lb = LibFunc_exp10l;
2627 PowLb = LibFunc_powl;
2628 break;
2629 case LibFunc_log2f:
2630 LogID = Intrinsic::log2;
2631 ExpLb = LibFunc_expf;
2632 Exp2Lb = LibFunc_exp2f;
2633 Exp10Lb = LibFunc_exp10f;
2634 PowLb = LibFunc_powf;
2635 break;
2636 case LibFunc_log2:
2637 LogID = Intrinsic::log2;
2638 ExpLb = LibFunc_exp;
2639 Exp2Lb = LibFunc_exp2;
2640 Exp10Lb = LibFunc_exp10;
2641 PowLb = LibFunc_pow;
2642 break;
2643 case LibFunc_log2l:
2644 LogID = Intrinsic::log2;
2645 ExpLb = LibFunc_expl;
2646 Exp2Lb = LibFunc_exp2l;
2647 Exp10Lb = LibFunc_exp10l;
2648 PowLb = LibFunc_powl;
2649 break;
2650 case LibFunc_log10f:
2651 LogID = Intrinsic::log10;
2652 ExpLb = LibFunc_expf;
2653 Exp2Lb = LibFunc_exp2f;
2654 Exp10Lb = LibFunc_exp10f;
2655 PowLb = LibFunc_powf;
2656 break;
2657 case LibFunc_log10:
2658 LogID = Intrinsic::log10;
2659 ExpLb = LibFunc_exp;
2660 Exp2Lb = LibFunc_exp2;
2661 Exp10Lb = LibFunc_exp10;
2662 PowLb = LibFunc_pow;
2663 break;
2664 case LibFunc_log10l:
2665 LogID = Intrinsic::log10;
2666 ExpLb = LibFunc_expl;
2667 Exp2Lb = LibFunc_exp2l;
2668 Exp10Lb = LibFunc_exp10l;
2669 PowLb = LibFunc_powl;
2670 break;
2671 default:
2672 return nullptr;
2673 }
2674
2675 // Convert libcall to intrinsic if the value is known > 0.
2676 bool IsKnownNoErrno = Log->hasNoNaNs() && Log->hasNoInfs();
2677 if (!IsKnownNoErrno) {
2678 SimplifyQuery SQ(DL, TLI, DT, AC, Log, true, true, DC);
2679 KnownFPClass Known = computeKnownFPClass(
2680 Log->getOperand(0),
2682 Function *F = Log->getParent()->getParent();
2683 const fltSemantics &FltSem = Ty->getScalarType()->getFltSemantics();
2684 IsKnownNoErrno =
2685 Known.cannotBeOrderedLessThanZero() &&
2686 Known.isKnownNeverLogicalZero(F->getDenormalMode(FltSem));
2687 }
2688 if (IsKnownNoErrno) {
2689 Value *NewLog = B.CreateUnaryIntrinsic(LogID, Log->getArgOperand(0), Log);
2690 if (auto *I = dyn_cast<Instruction>(NewLog)) {
2691 I->copyMetadata(*Log);
2692 return copyFlags(*Log, I);
2693 }
2694 return NewLog;
2695 }
2696 } else if (LogID == Intrinsic::log || LogID == Intrinsic::log2 ||
2697 LogID == Intrinsic::log10) {
2698 if (Ty->getScalarType()->isFloatTy()) {
2699 ExpLb = LibFunc_expf;
2700 Exp2Lb = LibFunc_exp2f;
2701 Exp10Lb = LibFunc_exp10f;
2702 PowLb = LibFunc_powf;
2703 } else if (Ty->getScalarType()->isDoubleTy()) {
2704 ExpLb = LibFunc_exp;
2705 Exp2Lb = LibFunc_exp2;
2706 Exp10Lb = LibFunc_exp10;
2707 PowLb = LibFunc_pow;
2708 } else
2709 return nullptr;
2710 } else
2711 return nullptr;
2712
2713 // The earlier call must also be 'fast' in order to do these transforms.
2714 CallInst *Arg = dyn_cast<CallInst>(Log->getArgOperand(0));
2715 if (!Log->isFast() || !Arg || !Arg->isFast() || !Arg->hasOneUse())
2716 return nullptr;
2717
2718 IRBuilderBase::FastMathFlagGuard Guard(B);
2719 B.setFastMathFlags(FastMathFlags::getFast());
2720
2721 Intrinsic::ID ArgID = Arg->getIntrinsicID();
2722 LibFunc ArgLb = NotLibFunc;
2723 TLI->getLibFunc(*Arg, ArgLb);
2724
2725 // log(pow(x,y)) -> y*log(x)
2726 AttributeList NoAttrs;
2727 if (ArgLb == PowLb || ArgID == Intrinsic::pow || ArgID == Intrinsic::powi) {
2728 Value *LogX =
2729 Log->doesNotAccessMemory()
2730 ? B.CreateUnaryIntrinsic(LogID, Arg->getOperand(0), nullptr, "log")
2731 : emitUnaryFloatFnCall(Arg->getOperand(0), TLI, LogNm, B, NoAttrs);
2732 Value *Y = Arg->getArgOperand(1);
2733 // Cast exponent to FP if integer.
2734 if (ArgID == Intrinsic::powi)
2735 Y = B.CreateSIToFP(Y, Ty, "cast");
2736 Value *MulY = B.CreateFMul(Y, LogX, "mul");
2737 // Since pow() may have side effects, e.g. errno,
2738 // dead code elimination may not be trusted to remove it.
2739 substituteInParent(Arg, MulY);
2740 return MulY;
2741 }
2742
2743 // log(exp{,2,10}(y)) -> y*log({e,2,10})
2744 // TODO: There is no exp10() intrinsic yet.
2745 if (ArgLb == ExpLb || ArgLb == Exp2Lb || ArgLb == Exp10Lb ||
2746 ArgID == Intrinsic::exp || ArgID == Intrinsic::exp2) {
2747 Constant *Eul;
2748 if (ArgLb == ExpLb || ArgID == Intrinsic::exp)
2749 // FIXME: Add more precise value of e for long double.
2750 Eul = ConstantFP::get(Log->getType(), numbers::e);
2751 else if (ArgLb == Exp2Lb || ArgID == Intrinsic::exp2)
2752 Eul = ConstantFP::get(Log->getType(), 2.0);
2753 else
2754 Eul = ConstantFP::get(Log->getType(), 10.0);
2755 Value *LogE = Log->doesNotAccessMemory()
2756 ? B.CreateUnaryIntrinsic(LogID, Eul, nullptr, "log")
2757 : emitUnaryFloatFnCall(Eul, TLI, LogNm, B, NoAttrs);
2758 Value *MulY = B.CreateFMul(Arg->getArgOperand(0), LogE, "mul");
2759 // Since exp() may have side effects, e.g. errno,
2760 // dead code elimination may not be trusted to remove it.
2761 substituteInParent(Arg, MulY);
2762 return MulY;
2763 }
2764
2765 return nullptr;
2766}
2767
2768// sqrt(exp(X)) -> exp(X * 0.5)
2769Value *LibCallSimplifier::mergeSqrtToExp(CallInst *CI, IRBuilderBase &B) {
2770 if (!CI->hasAllowReassoc())
2771 return nullptr;
2772
2773 Function *SqrtFn = CI->getCalledFunction();
2774 CallInst *Arg = dyn_cast<CallInst>(CI->getArgOperand(0));
2775 if (!Arg || !Arg->hasAllowReassoc() || !Arg->hasOneUse())
2776 return nullptr;
2777 Intrinsic::ID ArgID = Arg->getIntrinsicID();
2778 LibFunc ArgLb = NotLibFunc;
2779 TLI->getLibFunc(*Arg, ArgLb);
2780
2781 LibFunc SqrtLb, ExpLb, Exp2Lb, Exp10Lb;
2782
2783 if (TLI->getLibFunc(SqrtFn->getName(), SqrtLb))
2784 switch (SqrtLb) {
2785 case LibFunc_sqrtf:
2786 ExpLb = LibFunc_expf;
2787 Exp2Lb = LibFunc_exp2f;
2788 Exp10Lb = LibFunc_exp10f;
2789 break;
2790 case LibFunc_sqrt:
2791 ExpLb = LibFunc_exp;
2792 Exp2Lb = LibFunc_exp2;
2793 Exp10Lb = LibFunc_exp10;
2794 break;
2795 case LibFunc_sqrtl:
2796 ExpLb = LibFunc_expl;
2797 Exp2Lb = LibFunc_exp2l;
2798 Exp10Lb = LibFunc_exp10l;
2799 break;
2800 default:
2801 return nullptr;
2802 }
2803 else if (SqrtFn->getIntrinsicID() == Intrinsic::sqrt) {
2804 if (CI->getType()->getScalarType()->isFloatTy()) {
2805 ExpLb = LibFunc_expf;
2806 Exp2Lb = LibFunc_exp2f;
2807 Exp10Lb = LibFunc_exp10f;
2808 } else if (CI->getType()->getScalarType()->isDoubleTy()) {
2809 ExpLb = LibFunc_exp;
2810 Exp2Lb = LibFunc_exp2;
2811 Exp10Lb = LibFunc_exp10;
2812 } else
2813 return nullptr;
2814 } else
2815 return nullptr;
2816
2817 if (ArgLb != ExpLb && ArgLb != Exp2Lb && ArgLb != Exp10Lb &&
2818 ArgID != Intrinsic::exp && ArgID != Intrinsic::exp2)
2819 return nullptr;
2820
2821 IRBuilderBase::InsertPointGuard Guard(B);
2822 B.SetInsertPoint(Arg);
2823 auto *ExpOperand = Arg->getOperand(0);
2824 auto *FMul =
2825 B.CreateFMulFMF(ExpOperand, ConstantFP::get(ExpOperand->getType(), 0.5),
2826 CI, "merged.sqrt");
2827
2828 Arg->setOperand(0, FMul);
2829 return Arg;
2830}
2831
2832Value *LibCallSimplifier::optimizeSqrt(CallInst *CI, IRBuilderBase &B) {
2833 Module *M = CI->getModule();
2835 Value *Ret = nullptr;
2836 // TODO: Once we have a way (other than checking for the existince of the
2837 // libcall) to tell whether our target can lower @llvm.sqrt, relax the
2838 // condition below.
2839 if (isLibFuncEmittable(M, TLI, LibFunc_sqrtf) &&
2840 (Callee->getName() == "sqrt" ||
2841 Callee->getIntrinsicID() == Intrinsic::sqrt))
2842 Ret = optimizeUnaryDoubleFP(CI, B, TLI, true);
2843
2844 if (Value *Opt = mergeSqrtToExp(CI, B))
2845 return Opt;
2846
2847 if (!CI->isFast())
2848 return Ret;
2849
2851 if (!I || I->getOpcode() != Instruction::FMul || !I->isFast())
2852 return Ret;
2853
2854 // We're looking for a repeated factor in a multiplication tree,
2855 // so we can do this fold: sqrt(x * x) -> fabs(x);
2856 // or this fold: sqrt((x * x) * y) -> fabs(x) * sqrt(y).
2857 Value *Op0 = I->getOperand(0);
2858 Value *Op1 = I->getOperand(1);
2859 Value *RepeatOp = nullptr;
2860 Value *OtherOp = nullptr;
2861 if (Op0 == Op1) {
2862 // Simple match: the operands of the multiply are identical.
2863 RepeatOp = Op0;
2864 } else {
2865 // Look for a more complicated pattern: one of the operands is itself
2866 // a multiply, so search for a common factor in that multiply.
2867 // Note: We don't bother looking any deeper than this first level or for
2868 // variations of this pattern because instcombine's visitFMUL and/or the
2869 // reassociation pass should give us this form.
2870 Value *MulOp;
2871 if (match(Op0, m_FMul(m_Value(MulOp), m_Deferred(MulOp))) &&
2872 cast<Instruction>(Op0)->isFast()) {
2873 // Pattern: sqrt((x * x) * z)
2874 RepeatOp = MulOp;
2875 OtherOp = Op1;
2876 } else if (match(Op1, m_FMul(m_Value(MulOp), m_Deferred(MulOp))) &&
2877 cast<Instruction>(Op1)->isFast()) {
2878 // Pattern: sqrt(z * (x * x))
2879 RepeatOp = MulOp;
2880 OtherOp = Op0;
2881 }
2882 }
2883 if (!RepeatOp)
2884 return Ret;
2885
2886 // Fast math flags for any created instructions should match the sqrt
2887 // and multiply.
2888
2889 // If we found a repeated factor, hoist it out of the square root and
2890 // replace it with the fabs of that factor.
2891 Value *FabsCall = B.CreateFAbs(RepeatOp, I, "fabs");
2892 if (OtherOp) {
2893 // If we found a non-repeated factor, we still need to get its square
2894 // root. We then multiply that by the value that was simplified out
2895 // of the square root calculation.
2896 Value *SqrtCall =
2897 B.CreateUnaryIntrinsic(Intrinsic::sqrt, OtherOp, I, "sqrt");
2898 return copyFlags(*CI, B.CreateFMulFMF(FabsCall, SqrtCall, I));
2899 }
2900 return copyFlags(*CI, FabsCall);
2901}
2902
2903Value *LibCallSimplifier::optimizeFMod(CallInst *CI, IRBuilderBase &B) {
2904
2905 // fmod(x,y) sets errno if y == 0 or x == +/-inf. frem does not set errno,
2906 // so the fold is valid only when we can prove fmod wouldn't either.
2907 bool IsNoErrno = CI->hasNoNaNs();
2908 if (!IsNoErrno) {
2909 SimplifyQuery SQ(DL, TLI, DT, AC, CI, true, true, DC);
2910 KnownFPClass Known0 = computeKnownFPClass(CI->getOperand(0), fcInf, SQ);
2911 if (Known0.isKnownNeverInfinity()) {
2912 KnownFPClass Known1 =
2914 Function *F = CI->getParent()->getParent();
2915 const fltSemantics &FltSem =
2917 IsNoErrno = Known1.isKnownNeverLogicalZero(F->getDenormalMode(FltSem));
2918 }
2919 }
2920
2921 if (IsNoErrno)
2922 return B.CreateFRemFMF(CI->getOperand(0), CI->getOperand(1), CI);
2923 return nullptr;
2924}
2925
2926Value *LibCallSimplifier::optimizeTrigInversionPairs(CallInst *CI,
2927 IRBuilderBase &B) {
2928 Module *M = CI->getModule();
2930 Value *Ret = nullptr;
2931 StringRef Name = Callee->getName();
2932 if (UnsafeFPShrink &&
2933 (Name == "tan" || Name == "atanh" || Name == "sinh" || Name == "cosh" ||
2934 Name == "asinh") &&
2935 hasFloatVersion(M, Name))
2936 Ret = optimizeUnaryDoubleFP(CI, B, TLI, true);
2937
2938 Value *Op1 = CI->getArgOperand(0);
2939 auto *OpC = dyn_cast<CallInst>(Op1);
2940 if (!OpC)
2941 return Ret;
2942
2943 // Both calls must be 'fast' in order to remove them.
2944 if (!CI->isFast() || !OpC->isFast())
2945 return Ret;
2946
2947 // tan(atan(x)) -> x
2948 // atanh(tanh(x)) -> x
2949 // sinh(asinh(x)) -> x
2950 // asinh(sinh(x)) -> x
2951 // cosh(acosh(x)) -> x
2952 LibFunc Func;
2953 Function *F = OpC->getCalledFunction();
2954 if (F && TLI->getLibFunc(F->getName(), Func) &&
2955 isLibFuncEmittable(M, TLI, Func)) {
2956 LibFunc inverseFunc = llvm::StringSwitch<LibFunc>(Callee->getName())
2957 .Case("tan", LibFunc_atan)
2958 .Case("atanh", LibFunc_tanh)
2959 .Case("sinh", LibFunc_asinh)
2960 .Case("cosh", LibFunc_acosh)
2961 .Case("tanf", LibFunc_atanf)
2962 .Case("atanhf", LibFunc_tanhf)
2963 .Case("sinhf", LibFunc_asinhf)
2964 .Case("coshf", LibFunc_acoshf)
2965 .Case("tanl", LibFunc_atanl)
2966 .Case("atanhl", LibFunc_tanhl)
2967 .Case("sinhl", LibFunc_asinhl)
2968 .Case("coshl", LibFunc_acoshl)
2969 .Case("asinh", LibFunc_sinh)
2970 .Case("asinhf", LibFunc_sinhf)
2971 .Case("asinhl", LibFunc_sinhl)
2972 .Default(NotLibFunc); // Used as error value
2973 if (Func == inverseFunc)
2974 Ret = OpC->getArgOperand(0);
2975 }
2976 return Ret;
2977}
2978
2979static bool isTrigLibCall(CallInst *CI) {
2980 // We can only hope to do anything useful if we can ignore things like errno
2981 // and floating-point exceptions.
2982 // We already checked the prototype.
2983 return CI->doesNotThrow() && CI->doesNotAccessMemory();
2984}
2985
2986static bool insertSinCosCall(IRBuilderBase &B, Function *OrigCallee, Value *Arg,
2987 bool UseFloat, Value *&Sin, Value *&Cos,
2988 Value *&SinCos, const TargetLibraryInfo *TLI) {
2989 Module *M = OrigCallee->getParent();
2990 Type *ArgTy = Arg->getType();
2991 Type *ResTy;
2992 StringRef Name;
2993
2994 Triple T(OrigCallee->getParent()->getTargetTriple());
2995 if (UseFloat) {
2996 Name = "__sincospif_stret";
2997
2998 assert(T.getArch() != Triple::x86 && "x86 messy and unsupported for now");
2999 // x86_64 can't use {float, float} since that would be returned in both
3000 // xmm0 and xmm1, which isn't what a real struct would do.
3001 ResTy = T.getArch() == Triple::x86_64
3002 ? static_cast<Type *>(FixedVectorType::get(ArgTy, 2))
3003 : static_cast<Type *>(StructType::get(ArgTy, ArgTy));
3004 } else {
3005 Name = "__sincospi_stret";
3006 ResTy = StructType::get(ArgTy, ArgTy);
3007 }
3008
3009 if (!isLibFuncEmittable(M, TLI, Name))
3010 return false;
3011 LibFunc TheLibFunc;
3012 TLI->getLibFunc(Name, TheLibFunc);
3014 M, *TLI, TheLibFunc, OrigCallee->getAttributes(), ResTy, ArgTy);
3015
3016 if (Instruction *ArgInst = dyn_cast<Instruction>(Arg)) {
3017 // If the argument is an instruction, it must dominate all uses so put our
3018 // sincos call there.
3019 B.SetInsertPoint(ArgInst->getParent(), ++ArgInst->getIterator());
3020 } else {
3021 // Otherwise (e.g. for a constant) the beginning of the function is as
3022 // good a place as any.
3023 BasicBlock &EntryBB = B.GetInsertBlock()->getParent()->getEntryBlock();
3024 B.SetInsertPoint(&EntryBB, EntryBB.begin());
3025 }
3026
3027 SinCos = B.CreateCall(Callee, Arg, "sincospi");
3028
3029 if (SinCos->getType()->isStructTy()) {
3030 Sin = B.CreateExtractValue(SinCos, 0, "sinpi");
3031 Cos = B.CreateExtractValue(SinCos, 1, "cospi");
3032 } else {
3033 Sin = B.CreateExtractElement(SinCos, uint64_t{0}, "sinpi");
3034 Cos = B.CreateExtractElement(SinCos, uint64_t{1}, "cospi");
3035 }
3036
3037 return true;
3038}
3039
3040static Value *optimizeSymmetricCall(CallInst *CI, bool IsEven,
3041 IRBuilderBase &B) {
3042 Value *X;
3043 Value *Src = CI->getArgOperand(0);
3044
3045 if (match(Src, m_OneUse(m_FNeg(m_Value(X))))) {
3046 auto *Call = B.CreateCall(CI->getCalledFunction(), {X}, /*FMFSource=*/CI);
3047 auto *CallInst = copyFlags(*CI, Call);
3048 if (IsEven) {
3049 // Even function: f(-x) = f(x)
3050 return CallInst;
3051 }
3052 // Odd function: f(-x) = -f(x)
3053 return B.CreateFNegFMF(CallInst, CI);
3054 }
3055
3056 // Even function: f(abs(x)) = f(x), f(copysign(x, y)) = f(x)
3057 if (IsEven && (match(Src, m_FAbs(m_Value(X))) ||
3058 match(Src, m_CopySign(m_Value(X), m_Value())))) {
3059 auto *Call = B.CreateCall(CI->getCalledFunction(), {X}, /*FMFSource=*/CI);
3060 return copyFlags(*CI, Call);
3061 }
3062
3063 return nullptr;
3064}
3065
3066Value *LibCallSimplifier::optimizeSymmetric(CallInst *CI, LibFunc Func,
3067 IRBuilderBase &B) {
3068 switch (Func) {
3069 case LibFunc_cos:
3070 case LibFunc_cosf:
3071 case LibFunc_cosl:
3072
3073 case LibFunc_cosh:
3074 case LibFunc_coshf:
3075 case LibFunc_coshl:
3076 return optimizeSymmetricCall(CI, /*IsEven*/ true, B);
3077
3078 case LibFunc_sin:
3079 case LibFunc_sinf:
3080 case LibFunc_sinl:
3081
3082 case LibFunc_sinh:
3083 case LibFunc_sinhf:
3084 case LibFunc_sinhl:
3085
3086 case LibFunc_tan:
3087 case LibFunc_tanf:
3088 case LibFunc_tanl:
3089
3090 case LibFunc_tanh:
3091 case LibFunc_tanhf:
3092 case LibFunc_tanhl:
3093
3094 case LibFunc_erf:
3095 case LibFunc_erff:
3096 case LibFunc_erfl:
3097 return optimizeSymmetricCall(CI, /*IsEven*/ false, B);
3098
3099 default:
3100 return nullptr;
3101 }
3102}
3103
3104Value *LibCallSimplifier::optimizeSinCosPi(CallInst *CI, bool IsSin, IRBuilderBase &B) {
3105 // Make sure the prototype is as expected, otherwise the rest of the
3106 // function is probably invalid and likely to abort.
3107 if (!isTrigLibCall(CI))
3108 return nullptr;
3109
3110 Value *Arg = CI->getArgOperand(0);
3111 if (isa<ConstantData>(Arg))
3112 return nullptr;
3113
3116 SmallVector<CallInst *, 1> SinCosCalls;
3117
3118 bool IsFloat = Arg->getType()->isFloatTy();
3119
3120 // Look for all compatible sinpi, cospi and sincospi calls with the same
3121 // argument. If there are enough (in some sense) we can make the
3122 // substitution.
3123 Function *F = CI->getFunction();
3124 for (User *U : Arg->users())
3125 classifyArgUse(U, F, IsFloat, SinCalls, CosCalls, SinCosCalls);
3126
3127 // It's only worthwhile if both sinpi and cospi are actually used.
3128 if (SinCalls.empty() || CosCalls.empty())
3129 return nullptr;
3130
3131 Value *Sin, *Cos, *SinCos;
3132 if (!insertSinCosCall(B, CI->getCalledFunction(), Arg, IsFloat, Sin, Cos,
3133 SinCos, TLI))
3134 return nullptr;
3135
3136 auto replaceTrigInsts = [this](SmallVectorImpl<CallInst *> &Calls,
3137 Value *Res) {
3138 for (CallInst *C : Calls)
3139 replaceAllUsesWith(C, Res);
3140 };
3141
3142 replaceTrigInsts(SinCalls, Sin);
3143 replaceTrigInsts(CosCalls, Cos);
3144 replaceTrigInsts(SinCosCalls, SinCos);
3145
3146 return IsSin ? Sin : Cos;
3147}
3148
3149void LibCallSimplifier::classifyArgUse(
3150 Value *Val, Function *F, bool IsFloat,
3153 SmallVectorImpl<CallInst *> &SinCosCalls) {
3154 auto *CI = dyn_cast<CallInst>(Val);
3155 if (!CI || CI->use_empty())
3156 return;
3157
3158 // Don't consider calls in other functions.
3159 if (CI->getFunction() != F)
3160 return;
3161
3162 Module *M = CI->getModule();
3164 LibFunc Func;
3165 if (!Callee || !TLI->getLibFunc(*Callee, Func) ||
3166 !isLibFuncEmittable(M, TLI, Func) ||
3167 !isTrigLibCall(CI))
3168 return;
3169
3170 if (IsFloat) {
3171 if (Func == LibFunc_sinpif)
3172 SinCalls.push_back(CI);
3173 else if (Func == LibFunc_cospif)
3174 CosCalls.push_back(CI);
3175 else if (Func == LibFunc_sincospif_stret)
3176 SinCosCalls.push_back(CI);
3177 } else {
3178 if (Func == LibFunc_sinpi)
3179 SinCalls.push_back(CI);
3180 else if (Func == LibFunc_cospi)
3181 CosCalls.push_back(CI);
3182 else if (Func == LibFunc_sincospi_stret)
3183 SinCosCalls.push_back(CI);
3184 }
3185}
3186
3187/// Constant folds remquo
3188Value *LibCallSimplifier::optimizeRemquo(CallInst *CI, IRBuilderBase &B) {
3189 const APFloat *X, *Y;
3190 if (!match(CI->getArgOperand(0), m_APFloat(X)) ||
3191 !match(CI->getArgOperand(1), m_APFloat(Y)))
3192 return nullptr;
3193
3194 APFloat::opStatus Status;
3195 APFloat Quot = *X;
3196 Status = Quot.divide(*Y, APFloat::rmNearestTiesToEven);
3197 if (Status != APFloat::opOK && Status != APFloat::opInexact)
3198 return nullptr;
3199 APFloat Rem = *X;
3200 if (Rem.remainder(*Y) != APFloat::opOK)
3201 return nullptr;
3202
3203 // TODO: We can only keep at least the three of the last bits of x/y
3204 unsigned IntBW = TLI->getIntSize();
3205 APSInt QuotInt(IntBW, /*isUnsigned=*/false);
3206 bool IsExact;
3207 Status =
3208 Quot.convertToInteger(QuotInt, APFloat::rmNearestTiesToEven, &IsExact);
3209 if (Status != APFloat::opOK && Status != APFloat::opInexact)
3210 return nullptr;
3211
3212 B.CreateAlignedStore(
3213 ConstantInt::getSigned(B.getIntNTy(IntBW), QuotInt.getExtValue()),
3214 CI->getArgOperand(2), CI->getParamAlign(2));
3215 return ConstantFP::get(CI->getType(), Rem);
3216}
3217
3218/// Constant folds fdim
3219Value *LibCallSimplifier::optimizeFdim(CallInst *CI, IRBuilderBase &B) {
3220 // Cannot perform the fold unless the call has attribute memory(none)
3221 if (!CI->doesNotAccessMemory())
3222 return nullptr;
3223
3224 // TODO : Handle undef values
3225 // Propagate poison if any
3226 if (isa<PoisonValue>(CI->getArgOperand(0)))
3227 return CI->getArgOperand(0);
3228 if (isa<PoisonValue>(CI->getArgOperand(1)))
3229 return CI->getArgOperand(1);
3230
3231 const APFloat *X, *Y;
3232 // Check if both values are constants
3233 if (!match(CI->getArgOperand(0), m_APFloat(X)) ||
3234 !match(CI->getArgOperand(1), m_APFloat(Y)))
3235 return nullptr;
3236
3237 // C99 fdim(x, y) = (x > y) ? x - y : +0.
3238 if (X->compare(*Y) != APFloat::cmpGreaterThan && !X->isNaN() && !Y->isNaN())
3239 return ConstantFP::getZero(CI->getType());
3240 APFloat Difference = *X;
3242 return ConstantFP::get(CI->getType(), Difference);
3243}
3244
3245//===----------------------------------------------------------------------===//
3246// Integer Library Call Optimizations
3247//===----------------------------------------------------------------------===//
3248
3249Value *LibCallSimplifier::optimizeFFS(CallInst *CI, IRBuilderBase &B) {
3250 // All variants of ffs return int which need not be 32 bits wide.
3251 // ffs{,l,ll}(x) -> x != 0 ? (int)llvm.cttz(x)+1 : 0
3252 Type *RetType = CI->getType();
3253 Value *Op = CI->getArgOperand(0);
3254 Type *ArgType = Op->getType();
3255 Value *V = B.CreateIntrinsic(Intrinsic::cttz, {ArgType}, {Op, B.getTrue()},
3256 nullptr, "cttz");
3257 V = B.CreateAdd(V, ConstantInt::get(V->getType(), 1));
3258 V = B.CreateIntCast(V, RetType, false);
3259
3260 Value *Cond = B.CreateICmpNE(Op, Constant::getNullValue(ArgType));
3261 return B.CreateSelect(Cond, V, ConstantInt::get(RetType, 0));
3262}
3263
3264Value *LibCallSimplifier::optimizeFls(CallInst *CI, IRBuilderBase &B) {
3265 // All variants of fls return int which need not be 32 bits wide.
3266 // fls{,l,ll}(x) -> (int)(sizeInBits(x) - llvm.ctlz(x, false))
3267 Value *Op = CI->getArgOperand(0);
3268 Type *ArgType = Op->getType();
3269 Value *V = B.CreateIntrinsic(Intrinsic::ctlz, {ArgType}, {Op, B.getFalse()},
3270 nullptr, "ctlz");
3271 V = B.CreateSub(ConstantInt::get(V->getType(), ArgType->getIntegerBitWidth()),
3272 V);
3273 return B.CreateIntCast(V, CI->getType(), false);
3274}
3275
3276Value *LibCallSimplifier::optimizeAbs(CallInst *CI, IRBuilderBase &B) {
3277 // abs(x) -> x <s 0 ? -x : x
3278 // The negation has 'nsw' because abs of INT_MIN is undefined.
3279 Value *X = CI->getArgOperand(0);
3280 Value *IsNeg = B.CreateIsNeg(X);
3281 Value *NegX = B.CreateNSWNeg(X, "neg");
3282 return B.CreateSelect(IsNeg, NegX, X);
3283}
3284
3285Value *LibCallSimplifier::optimizeIsDigit(CallInst *CI, IRBuilderBase &B) {
3286 // isdigit(c) -> (c-'0') <u 10
3287 Value *Op = CI->getArgOperand(0);
3288 Type *ArgType = Op->getType();
3289 Op = B.CreateSub(Op, ConstantInt::get(ArgType, '0'), "isdigittmp");
3290 Op = B.CreateICmpULT(Op, ConstantInt::get(ArgType, 10), "isdigit");
3291 return B.CreateZExt(Op, CI->getType());
3292}
3293
3294Value *LibCallSimplifier::optimizeIsAscii(CallInst *CI, IRBuilderBase &B) {
3295 // isascii(c) -> c <u 128
3296 Value *Op = CI->getArgOperand(0);
3297 Type *ArgType = Op->getType();
3298 Op = B.CreateICmpULT(Op, ConstantInt::get(ArgType, 128), "isascii");
3299 return B.CreateZExt(Op, CI->getType());
3300}
3301
3302Value *LibCallSimplifier::optimizeToAscii(CallInst *CI, IRBuilderBase &B) {
3303 // toascii(c) -> c & 0x7f
3304 return B.CreateAnd(CI->getArgOperand(0),
3305 ConstantInt::get(CI->getType(), 0x7F));
3306}
3307
3308// Fold calls to atoi, atol, and atoll.
3309Value *LibCallSimplifier::optimizeAtoi(CallInst *CI, IRBuilderBase &B) {
3310 StringRef Str;
3311 if (!getConstantStringInfo(CI->getArgOperand(0), Str))
3312 return nullptr;
3313
3314 return convertStrToInt(CI, Str, nullptr, 10, /*AsSigned=*/true, B);
3315}
3316
3317// Fold calls to strtol, strtoll, strtoul, and strtoull.
3318Value *LibCallSimplifier::optimizeStrToInt(CallInst *CI, IRBuilderBase &B,
3319 bool AsSigned) {
3320 Value *EndPtr = CI->getArgOperand(1);
3321 if (isa<ConstantPointerNull>(EndPtr)) {
3322 // With a null EndPtr, this function won't capture the main argument.
3323 // It would be readonly too, except that it still may write to errno.
3326 EndPtr = nullptr;
3327 } else if (!isKnownNonZero(EndPtr, DL))
3328 return nullptr;
3329
3330 StringRef Str;
3331 if (!getConstantStringInfo(CI->getArgOperand(0), Str))
3332 return nullptr;
3333
3334 if (ConstantInt *CInt = dyn_cast<ConstantInt>(CI->getArgOperand(2))) {
3335 return convertStrToInt(CI, Str, EndPtr, CInt->getSExtValue(), AsSigned, B);
3336 }
3337
3338 return nullptr;
3339}
3340
3341//===----------------------------------------------------------------------===//
3342// Formatting and IO Library Call Optimizations
3343//===----------------------------------------------------------------------===//
3344
3345static bool isReportingError(Function *Callee, CallInst *CI, int StreamArg);
3346
3347Value *LibCallSimplifier::optimizeErrorReporting(CallInst *CI, IRBuilderBase &B,
3348 int StreamArg) {
3350 // Error reporting calls should be cold, mark them as such.
3351 // This applies even to non-builtin calls: it is only a hint and applies to
3352 // functions that the frontend might not understand as builtins.
3353
3354 // This heuristic was suggested in:
3355 // Improving Static Branch Prediction in a Compiler
3356 // Brian L. Deitrich, Ben-Chung Cheng, Wen-mei W. Hwu
3357 // Proceedings of PACT'98, Oct. 1998, IEEE
3358 if (!CI->hasFnAttr(Attribute::Cold) &&
3359 isReportingError(Callee, CI, StreamArg)) {
3360 CI->addFnAttr(Attribute::Cold);
3361 }
3362
3363 return nullptr;
3364}
3365
3366static bool isReportingError(Function *Callee, CallInst *CI, int StreamArg) {
3367 if (!Callee || !Callee->isDeclaration())
3368 return false;
3369
3370 if (StreamArg < 0)
3371 return true;
3372
3373 // These functions might be considered cold, but only if their stream
3374 // argument is stderr.
3375
3376 if (StreamArg >= (int)CI->arg_size())
3377 return false;
3378 LoadInst *LI = dyn_cast<LoadInst>(CI->getArgOperand(StreamArg));
3379 if (!LI)
3380 return false;
3382 if (!GV || !GV->isDeclaration())
3383 return false;
3384 return GV->getName() == "stderr";
3385}
3386
3387Value *LibCallSimplifier::optimizePrintFString(CallInst *CI, IRBuilderBase &B) {
3388 // Check for a fixed format string.
3389 StringRef FormatStr;
3390 if (!getConstantStringInfo(CI->getArgOperand(0), FormatStr))
3391 return nullptr;
3392
3393 // Empty format string -> noop.
3394 if (FormatStr.empty()) // Tolerate printf's declared void.
3395 return CI->use_empty() ? (Value *)CI : ConstantInt::get(CI->getType(), 0);
3396
3397 // Do not do any of the following transformations if the printf return value
3398 // is used, in general the printf return value is not compatible with either
3399 // putchar() or puts().
3400 if (!CI->use_empty())
3401 return nullptr;
3402
3403 Type *IntTy = CI->getType();
3404 // printf("x") -> putchar('x'), even for "%" and "%%".
3405 if (FormatStr.size() == 1 || FormatStr == "%%") {
3406 // Convert the character to unsigned char before passing it to putchar
3407 // to avoid host-specific sign extension in the IR. Putchar converts
3408 // it to unsigned char regardless.
3409 Value *IntChar = ConstantInt::get(IntTy, (unsigned char)FormatStr[0]);
3410 return copyFlags(*CI, emitPutChar(IntChar, B, TLI));
3411 }
3412
3413 // Try to remove call or emit putchar/puts.
3414 if (FormatStr == "%s" && CI->arg_size() > 1) {
3415 StringRef OperandStr;
3416 if (!getConstantStringInfo(CI->getOperand(1), OperandStr))
3417 return nullptr;
3418 // printf("%s", "") --> NOP
3419 if (OperandStr.empty())
3420 return (Value *)CI;
3421 // printf("%s", "a") --> putchar('a')
3422 if (OperandStr.size() == 1) {
3423 // Convert the character to unsigned char before passing it to putchar
3424 // to avoid host-specific sign extension in the IR. Putchar converts
3425 // it to unsigned char regardless.
3426 Value *IntChar = ConstantInt::get(IntTy, (unsigned char)OperandStr[0]);
3427 return copyFlags(*CI, emitPutChar(IntChar, B, TLI));
3428 }
3429 // printf("%s", str"\n") --> puts(str)
3430 if (OperandStr.back() == '\n') {
3431 if (!isLibFuncEmittable(CI->getModule(), TLI, LibFunc_puts))
3432 return nullptr;
3433 OperandStr = OperandStr.drop_back();
3434 Value *GV = B.CreateGlobalString(OperandStr, "str");
3435 return copyFlags(*CI, emitPutS(GV, B, TLI));
3436 }
3437 return nullptr;
3438 }
3439
3440 // printf("foo\n") --> puts("foo")
3441 if (FormatStr.back() == '\n' &&
3442 !FormatStr.contains('%')) { // No format characters.
3443 if (!isLibFuncEmittable(CI->getModule(), TLI, LibFunc_puts))
3444 return nullptr;
3445 // Create a string literal with no \n on it. We expect the constant merge
3446 // pass to be run after this pass, to merge duplicate strings.
3447 FormatStr = FormatStr.drop_back();
3448 Value *GV = B.CreateGlobalString(FormatStr, "str");
3449 return copyFlags(*CI, emitPutS(GV, B, TLI));
3450 }
3451
3452 // Optimize specific format strings.
3453 // printf("%c", chr) --> putchar(chr)
3454 if (FormatStr == "%c" && CI->arg_size() > 1 &&
3455 CI->getArgOperand(1)->getType()->isIntegerTy()) {
3456 // Convert the argument to the type expected by putchar, i.e., int, which
3457 // need not be 32 bits wide but which is the same as printf's return type.
3458 Value *IntChar = B.CreateIntCast(CI->getArgOperand(1), IntTy, false);
3459 return copyFlags(*CI, emitPutChar(IntChar, B, TLI));
3460 }
3461
3462 // printf("%s\n", str) --> puts(str)
3463 if (FormatStr == "%s\n" && CI->arg_size() > 1 &&
3464 CI->getArgOperand(1)->getType()->isPointerTy())
3465 return copyFlags(*CI, emitPutS(CI->getArgOperand(1), B, TLI));
3466 return nullptr;
3467}
3468
3469Value *LibCallSimplifier::optimizePrintF(CallInst *CI, IRBuilderBase &B) {
3470
3471 Module *M = CI->getModule();
3473 FunctionType *FT = Callee->getFunctionType();
3474 if (Value *V = optimizePrintFString(CI, B)) {
3475 return V;
3476 }
3477
3479
3480 // printf(format, ...) -> iprintf(format, ...) if no floating point
3481 // arguments.
3482 if (isLibFuncEmittable(M, TLI, LibFunc_iprintf) &&
3484 FunctionCallee IPrintFFn = getOrInsertLibFunc(M, *TLI, LibFunc_iprintf, FT,
3485 Callee->getAttributes());
3486 CallInst *New = cast<CallInst>(CI->clone());
3487 New->setCalledFunction(IPrintFFn);
3488 B.Insert(New);
3489 return New;
3490 }
3491
3492 // printf(format, ...) -> __small_printf(format, ...) if no 128-bit floating point
3493 // arguments.
3494 if (isLibFuncEmittable(M, TLI, LibFunc_small_printf) &&
3495 !callHasFP128Argument(CI)) {
3496 auto SmallPrintFFn = getOrInsertLibFunc(M, *TLI, LibFunc_small_printf, FT,
3497 Callee->getAttributes());
3498 CallInst *New = cast<CallInst>(CI->clone());
3499 New->setCalledFunction(SmallPrintFFn);
3500 B.Insert(New);
3501 return New;
3502 }
3503
3504 return nullptr;
3505}
3506
3507Value *LibCallSimplifier::optimizeSPrintFString(CallInst *CI,
3508 IRBuilderBase &B) {
3509 // Check for a fixed format string.
3510 StringRef FormatStr;
3511 if (!getConstantStringInfo(CI->getArgOperand(1), FormatStr))
3512 return nullptr;
3513
3514 // If we just have a format string (nothing else crazy) transform it.
3515 Value *Dest = CI->getArgOperand(0);
3516 if (CI->arg_size() == 2) {
3517 // Make sure there's no % in the constant array. We could try to handle
3518 // %% -> % in the future if we cared.
3519 if (FormatStr.contains('%'))
3520 return nullptr; // we found a format specifier, bail out.
3521
3522 // sprintf(str, fmt) -> llvm.memcpy(align 1 str, align 1 fmt, strlen(fmt)+1)
3523 B.CreateMemCpy(Dest, Align(1), CI->getArgOperand(1), Align(1),
3524 // Copy the null byte.
3525 TLI->getAsSizeT(FormatStr.size() + 1, *CI->getModule()));
3526 return ConstantInt::get(CI->getType(), FormatStr.size());
3527 }
3528
3529 // The remaining optimizations require the format string to be "%s" or "%c"
3530 // and have an extra operand.
3531 if (FormatStr.size() != 2 || FormatStr[0] != '%' || CI->arg_size() < 3)
3532 return nullptr;
3533
3534 // Decode the second character of the format string.
3535 if (FormatStr[1] == 'c') {
3536 // sprintf(dst, "%c", chr) --> *(i8*)dst = chr; *((i8*)dst+1) = 0
3537 if (!CI->getArgOperand(2)->getType()->isIntegerTy())
3538 return nullptr;
3539 Value *V = B.CreateTrunc(CI->getArgOperand(2), B.getInt8Ty(), "char");
3540 Value *Ptr = Dest;
3541 B.CreateStore(V, Ptr);
3542 Ptr = B.CreateInBoundsGEP(B.getInt8Ty(), Ptr, B.getInt32(1), "nul");
3543 B.CreateStore(B.getInt8(0), Ptr);
3544
3545 return ConstantInt::get(CI->getType(), 1);
3546 }
3547
3548 if (FormatStr[1] == 's') {
3549 // sprintf(dest, "%s", str) -> llvm.memcpy(align 1 dest, align 1 str,
3550 // strlen(str)+1)
3551 if (!CI->getArgOperand(2)->getType()->isPointerTy())
3552 return nullptr;
3553
3554 if (CI->use_empty())
3555 // sprintf(dest, "%s", str) -> strcpy(dest, str)
3556 return copyFlags(*CI, emitStrCpy(Dest, CI->getArgOperand(2), B, TLI));
3557
3558 uint64_t SrcLen = GetStringLength(CI->getArgOperand(2));
3559 if (SrcLen) {
3560 B.CreateMemCpy(Dest, Align(1), CI->getArgOperand(2), Align(1),
3561 TLI->getAsSizeT(SrcLen, *CI->getModule()));
3562 // Returns total number of characters written without null-character.
3563 return ConstantInt::get(CI->getType(), SrcLen - 1);
3564 } else if (Value *V = emitStpCpy(Dest, CI->getArgOperand(2), B, TLI)) {
3565 // sprintf(dest, "%s", str) -> stpcpy(dest, str) - dest
3566 Value *PtrDiff = B.CreatePtrDiff(V, Dest);
3567 return B.CreateIntCast(PtrDiff, CI->getType(), false);
3568 }
3569
3570 if (llvm::shouldOptimizeForSize(CI->getParent(), PSI, BFI,
3572 return nullptr;
3573
3574 Value *Len = emitStrLen(CI->getArgOperand(2), B, DL, TLI);
3575 if (!Len)
3576 return nullptr;
3577 Value *IncLen =
3578 B.CreateAdd(Len, ConstantInt::get(Len->getType(), 1), "leninc");
3579 B.CreateMemCpy(Dest, Align(1), CI->getArgOperand(2), Align(1), IncLen);
3580
3581 // The sprintf result is the unincremented number of bytes in the string.
3582 return B.CreateIntCast(Len, CI->getType(), false);
3583 }
3584 return nullptr;
3585}
3586
3587Value *LibCallSimplifier::optimizeSPrintF(CallInst *CI, IRBuilderBase &B) {
3588 Module *M = CI->getModule();
3590 FunctionType *FT = Callee->getFunctionType();
3591 if (Value *V = optimizeSPrintFString(CI, B)) {
3592 return V;
3593 }
3594
3596
3597 // sprintf(str, format, ...) -> siprintf(str, format, ...) if no floating
3598 // point arguments.
3599 if (isLibFuncEmittable(M, TLI, LibFunc_siprintf) &&
3601 FunctionCallee SIPrintFFn = getOrInsertLibFunc(M, *TLI, LibFunc_siprintf,
3602 FT, Callee->getAttributes());
3603 CallInst *New = cast<CallInst>(CI->clone());
3604 New->setCalledFunction(SIPrintFFn);
3605 B.Insert(New);
3606 return New;
3607 }
3608
3609 // sprintf(str, format, ...) -> __small_sprintf(str, format, ...) if no 128-bit
3610 // floating point arguments.
3611 if (isLibFuncEmittable(M, TLI, LibFunc_small_sprintf) &&
3612 !callHasFP128Argument(CI)) {
3613 auto SmallSPrintFFn = getOrInsertLibFunc(M, *TLI, LibFunc_small_sprintf, FT,
3614 Callee->getAttributes());
3615 CallInst *New = cast<CallInst>(CI->clone());
3616 New->setCalledFunction(SmallSPrintFFn);
3617 B.Insert(New);
3618 return New;
3619 }
3620
3621 return nullptr;
3622}
3623
3624// Transform an snprintf call CI with the bound N to format the string Str
3625// either to a call to memcpy, or to single character a store, or to nothing,
3626// and fold the result to a constant. A nonnull StrArg refers to the string
3627// argument being formatted. Otherwise the call is one with N < 2 and
3628// the "%c" directive to format a single character.
3629Value *LibCallSimplifier::emitSnPrintfMemCpy(CallInst *CI, Value *StrArg,
3630 StringRef Str, uint64_t N,
3631 IRBuilderBase &B) {
3632 assert(StrArg || (N < 2 && Str.size() == 1));
3633
3634 unsigned IntBits = TLI->getIntSize();
3635 uint64_t IntMax = maxIntN(IntBits);
3636 if (Str.size() > IntMax)
3637 // Bail if the string is longer than INT_MAX. POSIX requires
3638 // implementations to set errno to EOVERFLOW in this case, in
3639 // addition to when N is larger than that (checked by the caller).
3640 return nullptr;
3641
3642 Value *StrLen = ConstantInt::get(CI->getType(), Str.size());
3643 if (N == 0)
3644 return StrLen;
3645
3646 // Set to the number of bytes to copy fron StrArg which is also
3647 // the offset of the terinating nul.
3648 uint64_t NCopy;
3649 if (N > Str.size())
3650 // Copy the full string, including the terminating nul (which must
3651 // be present regardless of the bound).
3652 NCopy = Str.size() + 1;
3653 else
3654 NCopy = N - 1;
3655
3656 Value *DstArg = CI->getArgOperand(0);
3657 if (NCopy && StrArg)
3658 // Transform the call to lvm.memcpy(dst, fmt, N).
3659 copyFlags(*CI, B.CreateMemCpy(DstArg, Align(1), StrArg, Align(1),
3660 TLI->getAsSizeT(NCopy, *CI->getModule())));
3661
3662 if (N > Str.size())
3663 // Return early when the whole format string, including the final nul,
3664 // has been copied.
3665 return StrLen;
3666
3667 // Otherwise, when truncating the string append a terminating nul.
3668 Type *Int8Ty = B.getInt8Ty();
3669 Value *NulOff = B.getIntN(IntBits, NCopy);
3670 Value *DstEnd = B.CreateInBoundsGEP(Int8Ty, DstArg, NulOff, "endptr");
3671 B.CreateStore(ConstantInt::get(Int8Ty, 0), DstEnd);
3672 return StrLen;
3673}
3674
3675Value *LibCallSimplifier::optimizeSnPrintFString(CallInst *CI,
3676 IRBuilderBase &B) {
3677 // Check for size
3678 ConstantInt *Size = dyn_cast<ConstantInt>(CI->getArgOperand(1));
3679 if (!Size)
3680 return nullptr;
3681
3682 uint64_t N = Size->getZExtValue();
3683 uint64_t IntMax = maxIntN(TLI->getIntSize());
3684 if (N > IntMax)
3685 // Bail if the bound exceeds INT_MAX. POSIX requires implementations
3686 // to set errno to EOVERFLOW in this case.
3687 return nullptr;
3688
3689 Value *DstArg = CI->getArgOperand(0);
3690 Value *FmtArg = CI->getArgOperand(2);
3691
3692 // Check for a fixed format string.
3693 StringRef FormatStr;
3694 if (!getConstantStringInfo(FmtArg, FormatStr))
3695 return nullptr;
3696
3697 // If we just have a format string (nothing else crazy) transform it.
3698 if (CI->arg_size() == 3) {
3699 if (FormatStr.contains('%'))
3700 // Bail if the format string contains a directive and there are
3701 // no arguments. We could handle "%%" in the future.
3702 return nullptr;
3703
3704 return emitSnPrintfMemCpy(CI, FmtArg, FormatStr, N, B);
3705 }
3706
3707 // The remaining optimizations require the format string to be "%s" or "%c"
3708 // and have an extra operand.
3709 if (FormatStr.size() != 2 || FormatStr[0] != '%' || CI->arg_size() != 4)
3710 return nullptr;
3711
3712 // Decode the second character of the format string.
3713 if (FormatStr[1] == 'c') {
3714 if (N <= 1) {
3715 // Use an arbitary string of length 1 to transform the call into
3716 // either a nul store (N == 1) or a no-op (N == 0) and fold it
3717 // to one.
3718 StringRef CharStr("*");
3719 return emitSnPrintfMemCpy(CI, nullptr, CharStr, N, B);
3720 }
3721
3722 // snprintf(dst, size, "%c", chr) --> *(i8*)dst = chr; *((i8*)dst+1) = 0
3723 if (!CI->getArgOperand(3)->getType()->isIntegerTy())
3724 return nullptr;
3725 Value *V = B.CreateTrunc(CI->getArgOperand(3), B.getInt8Ty(), "char");
3726 Value *Ptr = DstArg;
3727 B.CreateStore(V, Ptr);
3728 Ptr = B.CreateInBoundsGEP(B.getInt8Ty(), Ptr, B.getInt32(1), "nul");
3729 B.CreateStore(B.getInt8(0), Ptr);
3730 return ConstantInt::get(CI->getType(), 1);
3731 }
3732
3733 if (FormatStr[1] != 's')
3734 return nullptr;
3735
3736 Value *StrArg = CI->getArgOperand(3);
3737 // snprintf(dest, size, "%s", str) to llvm.memcpy(dest, str, len+1, 1)
3738 StringRef Str;
3739 if (!getConstantStringInfo(StrArg, Str))
3740 return nullptr;
3741
3742 return emitSnPrintfMemCpy(CI, StrArg, Str, N, B);
3743}
3744
3745Value *LibCallSimplifier::optimizeSnPrintF(CallInst *CI, IRBuilderBase &B) {
3746 if (Value *V = optimizeSnPrintFString(CI, B)) {
3747 return V;
3748 }
3749
3750 if (isKnownNonZero(CI->getOperand(1), DL))
3752 return nullptr;
3753}
3754
3755Value *LibCallSimplifier::optimizeFPrintFString(CallInst *CI,
3756 IRBuilderBase &B) {
3757 optimizeErrorReporting(CI, B, 0);
3758
3759 // All the optimizations depend on the format string.
3760 StringRef FormatStr;
3761 if (!getConstantStringInfo(CI->getArgOperand(1), FormatStr))
3762 return nullptr;
3763
3764 // Do not do any of the following transformations if the fprintf return
3765 // value is used, in general the fprintf return value is not compatible
3766 // with fwrite(), fputc() or fputs().
3767 if (!CI->use_empty())
3768 return nullptr;
3769
3770 // fprintf(F, "foo") --> fwrite("foo", 3, 1, F)
3771 if (CI->arg_size() == 2) {
3772 // Could handle %% -> % if we cared.
3773 if (FormatStr.contains('%'))
3774 return nullptr; // We found a format specifier.
3775
3776 return copyFlags(
3777 *CI, emitFWrite(CI->getArgOperand(1),
3778 TLI->getAsSizeT(FormatStr.size(), *CI->getModule()),
3779 CI->getArgOperand(0), B, DL, TLI));
3780 }
3781
3782 // The remaining optimizations require the format string to be "%s" or "%c"
3783 // and have an extra operand.
3784 if (FormatStr.size() != 2 || FormatStr[0] != '%' || CI->arg_size() < 3)
3785 return nullptr;
3786
3787 // Decode the second character of the format string.
3788 if (FormatStr[1] == 'c') {
3789 // fprintf(F, "%c", chr) --> fputc((int)chr, F)
3790 if (!CI->getArgOperand(2)->getType()->isIntegerTy())
3791 return nullptr;
3792 Type *IntTy = B.getIntNTy(TLI->getIntSize());
3793 Value *V = B.CreateIntCast(CI->getArgOperand(2), IntTy, /*isSigned*/ true,
3794 "chari");
3795 return copyFlags(*CI, emitFPutC(V, CI->getArgOperand(0), B, TLI));
3796 }
3797
3798 if (FormatStr[1] == 's') {
3799 // fprintf(F, "%s", str) --> fputs(str, F)
3800 if (!CI->getArgOperand(2)->getType()->isPointerTy())
3801 return nullptr;
3802 return copyFlags(
3803 *CI, emitFPutS(CI->getArgOperand(2), CI->getArgOperand(0), B, TLI));
3804 }
3805 return nullptr;
3806}
3807
3808Value *LibCallSimplifier::optimizeFPrintF(CallInst *CI, IRBuilderBase &B) {
3809 Module *M = CI->getModule();
3811 FunctionType *FT = Callee->getFunctionType();
3812 if (Value *V = optimizeFPrintFString(CI, B)) {
3813 return V;
3814 }
3815
3816 // fprintf(stream, format, ...) -> fiprintf(stream, format, ...) if no
3817 // floating point arguments.
3818 if (isLibFuncEmittable(M, TLI, LibFunc_fiprintf) &&
3820 FunctionCallee FIPrintFFn = getOrInsertLibFunc(M, *TLI, LibFunc_fiprintf,
3821 FT, Callee->getAttributes());
3822 CallInst *New = cast<CallInst>(CI->clone());
3823 New->setCalledFunction(FIPrintFFn);
3824 B.Insert(New);
3825 return New;
3826 }
3827
3828 // fprintf(stream, format, ...) -> __small_fprintf(stream, format, ...) if no
3829 // 128-bit floating point arguments.
3830 if (isLibFuncEmittable(M, TLI, LibFunc_small_fprintf) &&
3831 !callHasFP128Argument(CI)) {
3832 auto SmallFPrintFFn =
3833 getOrInsertLibFunc(M, *TLI, LibFunc_small_fprintf, FT,
3834 Callee->getAttributes());
3835 CallInst *New = cast<CallInst>(CI->clone());
3836 New->setCalledFunction(SmallFPrintFFn);
3837 B.Insert(New);
3838 return New;
3839 }
3840
3841 return nullptr;
3842}
3843
3844Value *LibCallSimplifier::optimizeFWrite(CallInst *CI, IRBuilderBase &B) {
3845 optimizeErrorReporting(CI, B, 3);
3846
3847 // Get the element size and count.
3848 ConstantInt *SizeC = dyn_cast<ConstantInt>(CI->getArgOperand(1));
3849 ConstantInt *CountC = dyn_cast<ConstantInt>(CI->getArgOperand(2));
3850 if (SizeC && CountC) {
3851 uint64_t Bytes = SizeC->getZExtValue() * CountC->getZExtValue();
3852
3853 // If this is writing zero records, remove the call (it's a noop).
3854 if (Bytes == 0)
3855 return ConstantInt::get(CI->getType(), 0);
3856
3857 // If this is writing one byte, turn it into fputc.
3858 // This optimisation is only valid, if the return value is unused.
3859 if (Bytes == 1 && CI->use_empty()) { // fwrite(S,1,1,F) -> fputc(S[0],F)
3860 Value *Char = B.CreateLoad(B.getInt8Ty(), CI->getArgOperand(0), "char");
3861 Type *IntTy = B.getIntNTy(TLI->getIntSize());
3862 Value *Cast = B.CreateIntCast(Char, IntTy, /*isSigned*/ true, "chari");
3863 Value *NewCI = emitFPutC(Cast, CI->getArgOperand(3), B, TLI);
3864 return NewCI ? ConstantInt::get(CI->getType(), 1) : nullptr;
3865 }
3866 }
3867
3868 return nullptr;
3869}
3870
3871Value *LibCallSimplifier::optimizeFPuts(CallInst *CI, IRBuilderBase &B) {
3872 optimizeErrorReporting(CI, B, 1);
3873
3874 // Don't rewrite fputs to fwrite when optimising for size because fwrite
3875 // requires more arguments and thus extra MOVs are required.
3876 if (llvm::shouldOptimizeForSize(CI->getParent(), PSI, BFI,
3878 return nullptr;
3879
3880 // We can't optimize if return value is used.
3881 if (!CI->use_empty())
3882 return nullptr;
3883
3884 // fputs(s,F) --> fwrite(s,strlen(s),1,F)
3885 uint64_t Len = GetStringLength(CI->getArgOperand(0));
3886 if (!Len)
3887 return nullptr;
3888
3889 // Known to have no uses (see above).
3890 unsigned SizeTBits = TLI->getSizeTSize(*CI->getModule());
3891 Type *SizeTTy = IntegerType::get(CI->getContext(), SizeTBits);
3892 return copyFlags(
3893 *CI,
3895 ConstantInt::get(SizeTTy, Len - 1),
3896 CI->getArgOperand(1), B, DL, TLI));
3897}
3898
3899Value *LibCallSimplifier::optimizePuts(CallInst *CI, IRBuilderBase &B) {
3901 if (!CI->use_empty())
3902 return nullptr;
3903
3904 // Check for a constant string.
3905 // puts("") -> putchar('\n')
3906 StringRef Str;
3907 if (getConstantStringInfo(CI->getArgOperand(0), Str) && Str.empty()) {
3908 // putchar takes an argument of the same type as puts returns, i.e.,
3909 // int, which need not be 32 bits wide.
3910 Type *IntTy = CI->getType();
3911 return copyFlags(*CI, emitPutChar(ConstantInt::get(IntTy, '\n'), B, TLI));
3912 }
3913
3914 return nullptr;
3915}
3916
3917Value *LibCallSimplifier::optimizeExit(CallInst *CI) {
3918
3919 // Mark 'exit' as cold if its not exit(0) (success).
3920 const APInt *C;
3921 if (!CI->hasFnAttr(Attribute::Cold) &&
3922 match(CI->getArgOperand(0), m_APInt(C)) && !C->isZero()) {
3923 CI->addFnAttr(Attribute::Cold);
3924 }
3925 return nullptr;
3926}
3927
3928Value *LibCallSimplifier::optimizeBCopy(CallInst *CI, IRBuilderBase &B) {
3929 // bcopy(src, dst, n) -> llvm.memmove(dst, src, n)
3930 return copyFlags(*CI, B.CreateMemMove(CI->getArgOperand(1), Align(1),
3931 CI->getArgOperand(0), Align(1),
3932 CI->getArgOperand(2)));
3933}
3934
3935bool LibCallSimplifier::hasFloatVersion(const Module *M, StringRef FuncName) {
3936 SmallString<20> FloatFuncName = FuncName;
3937 FloatFuncName += 'f';
3938 return isLibFuncEmittable(M, TLI, FloatFuncName);
3939}
3940
3941Value *LibCallSimplifier::optimizeStringMemoryLibCall(CallInst *CI,
3942 IRBuilderBase &Builder) {
3943 Module *M = CI->getModule();
3944 LibFunc Func;
3946
3947 // Check for string/memory library functions.
3948 if (TLI->getLibFunc(*Callee, Func) && isLibFuncEmittable(M, TLI, Func)) {
3949 // Make sure we never change the calling convention.
3950 assert(
3951 (ignoreCallingConv(Func) ||
3953 "Optimizing string/memory libcall would change the calling convention");
3954 switch (Func) {
3955 case LibFunc_strcat:
3956 return optimizeStrCat(CI, Builder);
3957 case LibFunc_strncat:
3958 return optimizeStrNCat(CI, Builder);
3959 case LibFunc_strchr:
3960 return optimizeStrChr(CI, Builder);
3961 case LibFunc_strrchr:
3962 return optimizeStrRChr(CI, Builder);
3963 case LibFunc_strcmp:
3964 return optimizeStrCmp(CI, Builder);
3965 case LibFunc_strncmp:
3966 return optimizeStrNCmp(CI, Builder);
3967 case LibFunc_strcpy:
3968 return optimizeStrCpy(CI, Builder);
3969 case LibFunc_stpcpy:
3970 return optimizeStpCpy(CI, Builder);
3971 case LibFunc_strlcpy:
3972 return optimizeStrLCpy(CI, Builder);
3973 case LibFunc_stpncpy:
3974 return optimizeStringNCpy(CI, /*RetEnd=*/true, Builder);
3975 case LibFunc_strncpy:
3976 return optimizeStringNCpy(CI, /*RetEnd=*/false, Builder);
3977 case LibFunc_strlen:
3978 return optimizeStrLen(CI, Builder);
3979 case LibFunc_strnlen:
3980 return optimizeStrNLen(CI, Builder);
3981 case LibFunc_strpbrk:
3982 return optimizeStrPBrk(CI, Builder);
3983 case LibFunc_strndup:
3984 return optimizeStrNDup(CI, Builder);
3985 case LibFunc_strtol:
3986 case LibFunc_strtod:
3987 case LibFunc_strtof:
3988 case LibFunc_strtoul:
3989 case LibFunc_strtoll:
3990 case LibFunc_strtold:
3991 case LibFunc_strtoull:
3992 return optimizeStrTo(CI, Builder);
3993 case LibFunc_strspn:
3994 return optimizeStrSpn(CI, Builder);
3995 case LibFunc_strcspn:
3996 return optimizeStrCSpn(CI, Builder);
3997 case LibFunc_strstr:
3998 return optimizeStrStr(CI, Builder);
3999 case LibFunc_memchr:
4000 return optimizeMemChr(CI, Builder);
4001 case LibFunc_memrchr:
4002 return optimizeMemRChr(CI, Builder);
4003 case LibFunc_bcmp:
4004 return optimizeBCmp(CI, Builder);
4005 case LibFunc_memcmp:
4006 return optimizeMemCmp(CI, Builder);
4007 case LibFunc_memcpy:
4008 return optimizeMemCpy(CI, Builder);
4009 case LibFunc_memccpy:
4010 return optimizeMemCCpy(CI, Builder);
4011 case LibFunc_mempcpy:
4012 return optimizeMemPCpy(CI, Builder);
4013 case LibFunc_memmove:
4014 return optimizeMemMove(CI, Builder);
4015 case LibFunc_memset:
4016 return optimizeMemSet(CI, Builder);
4017 case LibFunc_realloc:
4018 return optimizeRealloc(CI, Builder);
4019 case LibFunc_wcslen:
4020 return optimizeWcslen(CI, Builder);
4021 case LibFunc_bcopy:
4022 return optimizeBCopy(CI, Builder);
4023 case LibFunc_Znwm:
4024 case LibFunc_ZnwmRKSt9nothrow_t:
4025 case LibFunc_ZnwmSt11align_val_t:
4026 case LibFunc_ZnwmSt11align_val_tRKSt9nothrow_t:
4027 case LibFunc_Znam:
4028 case LibFunc_ZnamRKSt9nothrow_t:
4029 case LibFunc_ZnamSt11align_val_t:
4030 case LibFunc_ZnamSt11align_val_tRKSt9nothrow_t:
4031 case LibFunc_Znwm12__hot_cold_t:
4032 case LibFunc_ZnwmRKSt9nothrow_t12__hot_cold_t:
4033 case LibFunc_ZnwmSt11align_val_t12__hot_cold_t:
4034 case LibFunc_ZnwmSt11align_val_tRKSt9nothrow_t12__hot_cold_t:
4035 case LibFunc_Znam12__hot_cold_t:
4036 case LibFunc_ZnamRKSt9nothrow_t12__hot_cold_t:
4037 case LibFunc_ZnamSt11align_val_t12__hot_cold_t:
4038 case LibFunc_ZnamSt11align_val_tRKSt9nothrow_t12__hot_cold_t:
4039 case LibFunc_size_returning_new:
4040 case LibFunc_size_returning_new_hot_cold:
4041 case LibFunc_size_returning_new_aligned:
4042 case LibFunc_size_returning_new_aligned_hot_cold:
4043 return optimizeNew(CI, Builder, Func);
4044 default:
4045 break;
4046 }
4047 }
4048 return nullptr;
4049}
4050
4051/// Constant folding nan/nanf/nanl.
4053 StringRef CharSeq;
4054 if (!getConstantStringInfo(CI->getArgOperand(0), CharSeq))
4055 return nullptr;
4056
4057 APInt Fill;
4058 // Treat empty strings as if they were zero.
4059 if (CharSeq.empty())
4060 Fill = APInt(32, 0);
4061 else if (CharSeq.getAsInteger(0, Fill))
4062 return nullptr;
4063
4064 return ConstantFP::getQNaN(CI->getType(), /*Negative=*/false, &Fill);
4065}
4066
4067Value *LibCallSimplifier::optimizeFloatingPointLibCall(CallInst *CI,
4068 LibFunc Func,
4069 IRBuilderBase &Builder) {
4070 const Module *M = CI->getModule();
4071
4072 // Don't optimize calls that require strict floating point semantics.
4073 if (CI->isStrictFP())
4074 return nullptr;
4075
4076 if (Value *V = optimizeSymmetric(CI, Func, Builder))
4077 return V;
4078
4079 switch (Func) {
4080 case LibFunc_sinpif:
4081 case LibFunc_sinpi:
4082 return optimizeSinCosPi(CI, /*IsSin*/true, Builder);
4083 case LibFunc_cospif:
4084 case LibFunc_cospi:
4085 return optimizeSinCosPi(CI, /*IsSin*/false, Builder);
4086 case LibFunc_sinf:
4087 case LibFunc_sinl:
4088 if (CI->doesNotAccessMemory())
4089 return replaceUnaryCall(CI, Builder, Intrinsic::sin);
4090 return nullptr;
4091 case LibFunc_cosf:
4092 case LibFunc_cosl:
4093 if (CI->doesNotAccessMemory())
4094 return replaceUnaryCall(CI, Builder, Intrinsic::cos);
4095 return nullptr;
4096 case LibFunc_powf:
4097 case LibFunc_pow:
4098 case LibFunc_powl:
4099 return optimizePow(CI, Builder);
4100 case LibFunc_exp2l:
4101 case LibFunc_exp2:
4102 case LibFunc_exp2f:
4103 return optimizeExp2(CI, Builder);
4104 case LibFunc_fabsf:
4105 case LibFunc_fabs:
4106 case LibFunc_fabsl:
4107 return replaceUnaryCall(CI, Builder, Intrinsic::fabs);
4108 case LibFunc_sqrtf:
4109 case LibFunc_sqrt:
4110 case LibFunc_sqrtl:
4111 return optimizeSqrt(CI, Builder);
4112 case LibFunc_fmod:
4113 case LibFunc_fmodf:
4114 case LibFunc_fmodl:
4115 return optimizeFMod(CI, Builder);
4116 case LibFunc_logf:
4117 case LibFunc_log:
4118 case LibFunc_logl:
4119 case LibFunc_log10f:
4120 case LibFunc_log10:
4121 case LibFunc_log10l:
4122 case LibFunc_log1pf:
4123 case LibFunc_log1p:
4124 case LibFunc_log1pl:
4125 case LibFunc_log2f:
4126 case LibFunc_log2:
4127 case LibFunc_log2l:
4128 case LibFunc_logbf:
4129 case LibFunc_logb:
4130 case LibFunc_logbl:
4131 return optimizeLog(CI, Builder);
4132 case LibFunc_tan:
4133 case LibFunc_tanf:
4134 case LibFunc_tanl:
4135 case LibFunc_sinh:
4136 case LibFunc_sinhf:
4137 case LibFunc_sinhl:
4138 case LibFunc_asinh:
4139 case LibFunc_asinhf:
4140 case LibFunc_asinhl:
4141 case LibFunc_cosh:
4142 case LibFunc_coshf:
4143 case LibFunc_coshl:
4144 case LibFunc_atanh:
4145 case LibFunc_atanhf:
4146 case LibFunc_atanhl:
4147 return optimizeTrigInversionPairs(CI, Builder);
4148 case LibFunc_ceil:
4149 return replaceUnaryCall(CI, Builder, Intrinsic::ceil);
4150 case LibFunc_floor:
4151 return replaceUnaryCall(CI, Builder, Intrinsic::floor);
4152 case LibFunc_round:
4153 return replaceUnaryCall(CI, Builder, Intrinsic::round);
4154 case LibFunc_roundeven:
4155 return replaceUnaryCall(CI, Builder, Intrinsic::roundeven);
4156 case LibFunc_nearbyint:
4157 return replaceUnaryCall(CI, Builder, Intrinsic::nearbyint);
4158 case LibFunc_rint:
4159 return replaceUnaryCall(CI, Builder, Intrinsic::rint);
4160 case LibFunc_trunc:
4161 return replaceUnaryCall(CI, Builder, Intrinsic::trunc);
4162 case LibFunc_sin:
4163 case LibFunc_cos:
4164 if (UnsafeFPShrink &&
4165 hasFloatVersion(M, CI->getCalledFunction()->getName()))
4166 if (Value *V = optimizeUnaryDoubleFP(CI, Builder, TLI, true))
4167 return V;
4168 if (CI->doesNotAccessMemory())
4169 return replaceUnaryCall(
4170 CI, Builder, Func == LibFunc_sin ? Intrinsic::sin : Intrinsic::cos);
4171 return nullptr;
4172 case LibFunc_acos:
4173 case LibFunc_acosh:
4174 case LibFunc_asin:
4175 case LibFunc_atan:
4176 case LibFunc_cbrt:
4177 case LibFunc_exp:
4178 case LibFunc_exp10:
4179 case LibFunc_expm1:
4180 case LibFunc_tanh:
4181 if (UnsafeFPShrink && hasFloatVersion(M, CI->getCalledFunction()->getName()))
4182 return optimizeUnaryDoubleFP(CI, Builder, TLI, true);
4183 return nullptr;
4184 case LibFunc_copysign:
4185 if (hasFloatVersion(M, CI->getCalledFunction()->getName()))
4186 return optimizeBinaryDoubleFP(CI, Builder, TLI);
4187 return nullptr;
4188 case LibFunc_fdim:
4189 case LibFunc_fdimf:
4190 case LibFunc_fdiml:
4191 return optimizeFdim(CI, Builder);
4192 case LibFunc_fminf:
4193 case LibFunc_fmin:
4194 case LibFunc_fminl:
4195 return optimizeFMinFMax(CI, Builder, Intrinsic::minnum);
4196 case LibFunc_fmaxf:
4197 case LibFunc_fmax:
4198 case LibFunc_fmaxl:
4199 return optimizeFMinFMax(CI, Builder, Intrinsic::maxnum);
4200 case LibFunc_fminimum_numf:
4201 case LibFunc_fminimum_num:
4202 case LibFunc_fminimum_numl:
4203 return replaceBinaryCall(CI, Builder, Intrinsic::minimumnum);
4204 case LibFunc_fmaximum_numf:
4205 case LibFunc_fmaximum_num:
4206 case LibFunc_fmaximum_numl:
4207 return replaceBinaryCall(CI, Builder, Intrinsic::maximumnum);
4208 case LibFunc_cabs:
4209 case LibFunc_cabsf:
4210 case LibFunc_cabsl:
4211 return optimizeCAbs(CI, Builder);
4212 case LibFunc_remquo:
4213 case LibFunc_remquof:
4214 case LibFunc_remquol:
4215 return optimizeRemquo(CI, Builder);
4216 case LibFunc_nan:
4217 case LibFunc_nanf:
4218 case LibFunc_nanl:
4219 return optimizeNaN(CI);
4220 default:
4221 return nullptr;
4222 }
4223}
4224
4226 Module *M = CI->getModule();
4227 assert(!CI->isMustTailCall() && "These transforms aren't musttail safe.");
4228
4229 // TODO: Split out the code below that operates on FP calls so that
4230 // we can all non-FP calls with the StrictFP attribute to be
4231 // optimized.
4232 if (CI->isNoBuiltin()) {
4233 // Optionally update operator new calls.
4234 return maybeOptimizeNoBuiltinOperatorNew(CI, Builder);
4235 }
4236
4237 LibFunc Func;
4238 Function *Callee = CI->getCalledFunction();
4239 bool IsCallingConvC = TargetLibraryInfoImpl::isCallingConvCCompatible(CI);
4240
4242 CI->getOperandBundlesAsDefs(OpBundles);
4243
4245 Builder.setDefaultOperandBundles(OpBundles);
4246
4247 // Command-line parameter overrides instruction attribute.
4248 // This can't be moved to optimizeFloatingPointLibCall() because it may be
4249 // used by the intrinsic optimizations.
4250 if (EnableUnsafeFPShrink.getNumOccurrences() > 0)
4251 UnsafeFPShrink = EnableUnsafeFPShrink;
4252 else if (isa<FPMathOperator>(CI) && CI->isFast())
4253 UnsafeFPShrink = true;
4254
4255 // First, check for intrinsics.
4257 if (!IsCallingConvC)
4258 return nullptr;
4259 // The FP intrinsics have corresponding constrained versions so we don't
4260 // need to check for the StrictFP attribute here.
4261 switch (II->getIntrinsicID()) {
4262 case Intrinsic::pow:
4263 return optimizePow(CI, Builder);
4264 case Intrinsic::exp2:
4265 return optimizeExp2(CI, Builder);
4266 case Intrinsic::log:
4267 case Intrinsic::log2:
4268 case Intrinsic::log10:
4269 return optimizeLog(CI, Builder);
4270 case Intrinsic::sqrt:
4271 return optimizeSqrt(CI, Builder);
4272 case Intrinsic::memset:
4273 return optimizeMemSet(CI, Builder);
4274 case Intrinsic::memcpy:
4275 return optimizeMemCpy(CI, Builder);
4276 case Intrinsic::memmove:
4277 return optimizeMemMove(CI, Builder);
4278 case Intrinsic::sin:
4279 case Intrinsic::cos:
4280 if (UnsafeFPShrink)
4281 return optimizeUnaryDoubleFP(CI, Builder, TLI, /*isPrecise=*/true);
4282 return nullptr;
4283 case Intrinsic::sincos:
4284 if (UnsafeFPShrink)
4285 return optimizeSinCosDoubleFP(CI, Builder);
4286 return nullptr;
4287 default:
4288 return nullptr;
4289 }
4290 }
4291
4292 // Also try to simplify calls to fortified library functions.
4293 if (Value *SimplifiedFortifiedCI =
4294 FortifiedSimplifier.optimizeCall(CI, Builder))
4295 return SimplifiedFortifiedCI;
4296
4297 // Then check for known library functions.
4298 if (TLI->getLibFunc(*Callee, Func) && isLibFuncEmittable(M, TLI, Func)) {
4299 // We never change the calling convention.
4300 if (!ignoreCallingConv(Func) && !IsCallingConvC)
4301 return nullptr;
4302 if (Value *V = optimizeStringMemoryLibCall(CI, Builder))
4303 return V;
4304 if (Value *V = optimizeFloatingPointLibCall(CI, Func, Builder))
4305 return V;
4306 switch (Func) {
4307 case LibFunc_ffs:
4308 case LibFunc_ffsl:
4309 case LibFunc_ffsll:
4310 return optimizeFFS(CI, Builder);
4311 case LibFunc_fls:
4312 case LibFunc_flsl:
4313 case LibFunc_flsll:
4314 return optimizeFls(CI, Builder);
4315 case LibFunc_abs:
4316 case LibFunc_labs:
4317 case LibFunc_llabs:
4318 return optimizeAbs(CI, Builder);
4319 case LibFunc_isdigit:
4320 return optimizeIsDigit(CI, Builder);
4321 case LibFunc_isascii:
4322 return optimizeIsAscii(CI, Builder);
4323 case LibFunc_toascii:
4324 return optimizeToAscii(CI, Builder);
4325 case LibFunc_atoi:
4326 case LibFunc_atol:
4327 case LibFunc_atoll:
4328 return optimizeAtoi(CI, Builder);
4329 case LibFunc_strtol:
4330 case LibFunc_strtoll:
4331 return optimizeStrToInt(CI, Builder, /*AsSigned=*/true);
4332 case LibFunc_strtoul:
4333 case LibFunc_strtoull:
4334 return optimizeStrToInt(CI, Builder, /*AsSigned=*/false);
4335 case LibFunc_printf:
4336 return optimizePrintF(CI, Builder);
4337 case LibFunc_sprintf:
4338 return optimizeSPrintF(CI, Builder);
4339 case LibFunc_snprintf:
4340 return optimizeSnPrintF(CI, Builder);
4341 case LibFunc_fprintf:
4342 return optimizeFPrintF(CI, Builder);
4343 case LibFunc_fwrite:
4344 return optimizeFWrite(CI, Builder);
4345 case LibFunc_fputs:
4346 return optimizeFPuts(CI, Builder);
4347 case LibFunc_puts:
4348 return optimizePuts(CI, Builder);
4349 case LibFunc_perror:
4350 return optimizeErrorReporting(CI, Builder);
4351 case LibFunc_vfprintf:
4352 case LibFunc_fiprintf:
4353 return optimizeErrorReporting(CI, Builder, 0);
4354 case LibFunc_exit:
4355 case LibFunc_Exit:
4356 return optimizeExit(CI);
4357 default:
4358 return nullptr;
4359 }
4360 }
4361 return nullptr;
4362}
4363
4365 const DataLayout &DL, const TargetLibraryInfo *TLI, DominatorTree *DT,
4368 function_ref<void(Instruction *, Value *)> Replacer,
4369 function_ref<void(Instruction *)> Eraser)
4370 : FortifiedSimplifier(TLI), DL(DL), TLI(TLI), DT(DT), DC(DC), AC(AC),
4371 ORE(ORE), BFI(BFI), PSI(PSI), Replacer(Replacer), Eraser(Eraser) {}
4372
4373void LibCallSimplifier::replaceAllUsesWith(Instruction *I, Value *With) {
4374 // Indirect through the replacer used in this instance.
4375 Replacer(I, With);
4376}
4377
4378void LibCallSimplifier::eraseFromParent(Instruction *I) {
4379 Eraser(I);
4380}
4381
4382// TODO:
4383// Additional cases that we need to add to this file:
4384//
4385// cbrt:
4386// * cbrt(expN(X)) -> expN(x/3)
4387// * cbrt(sqrt(x)) -> pow(x,1/6)
4388// * cbrt(cbrt(x)) -> pow(x,1/9)
4389//
4390// exp, expf, expl:
4391// * exp(log(x)) -> x
4392//
4393// log, logf, logl:
4394// * log(exp(x)) -> x
4395// * log(exp(y)) -> y*log(e)
4396// * log(exp10(y)) -> y*log(10)
4397// * log(sqrt(x)) -> 0.5*log(x)
4398//
4399// pow, powf, powl:
4400// * pow(sqrt(x),y) -> pow(x,y*0.5)
4401// * pow(pow(x,y),z)-> pow(x,y*z)
4402//
4403// signbit:
4404// * signbit(cnst) -> cnst'
4405// * signbit(nncst) -> 0 (if pstv is a non-negative constant)
4406//
4407// sqrt, sqrtf, sqrtl:
4408// * sqrt(expN(x)) -> expN(x*0.5)
4409// * sqrt(Nroot(x)) -> pow(x,1/(2*N))
4410// * sqrt(pow(x,y)) -> pow(|x|,y*0.5)
4411//
4412
4413//===----------------------------------------------------------------------===//
4414// Fortified Library Call Optimizations
4415//===----------------------------------------------------------------------===//
4416
4417bool FortifiedLibCallSimplifier::isFortifiedCallFoldable(
4418 CallInst *CI, unsigned ObjSizeOp, std::optional<unsigned> SizeOp,
4419 std::optional<unsigned> StrOp, std::optional<unsigned> FlagOp) {
4420 // If this function takes a flag argument, the implementation may use it to
4421 // perform extra checks. Don't fold into the non-checking variant.
4422 if (FlagOp) {
4423 ConstantInt *Flag = dyn_cast<ConstantInt>(CI->getArgOperand(*FlagOp));
4424 if (!Flag || !Flag->isZero())
4425 return false;
4426 }
4427
4428 if (SizeOp && CI->getArgOperand(ObjSizeOp) == CI->getArgOperand(*SizeOp))
4429 return true;
4430
4431 if (ConstantInt *ObjSizeCI =
4432 dyn_cast<ConstantInt>(CI->getArgOperand(ObjSizeOp))) {
4433 if (ObjSizeCI->isMinusOne())
4434 return true;
4435 // If the object size wasn't -1 (unknown), bail out if we were asked to.
4436 if (OnlyLowerUnknownSize)
4437 return false;
4438 if (StrOp) {
4439 uint64_t Len = GetStringLength(CI->getArgOperand(*StrOp));
4440 // If the length is 0 we don't know how long it is and so we can't
4441 // remove the check.
4442 if (Len)
4443 annotateDereferenceableBytes(CI, *StrOp, Len);
4444 else
4445 return false;
4446 return ObjSizeCI->getZExtValue() >= Len;
4447 }
4448
4449 if (SizeOp) {
4450 if (ConstantInt *SizeCI =
4452 return ObjSizeCI->getZExtValue() >= SizeCI->getZExtValue();
4453 }
4454 }
4455 return false;
4456}
4457
4458Value *FortifiedLibCallSimplifier::optimizeMemCpyChk(CallInst *CI,
4459 IRBuilderBase &B) {
4460 if (isFortifiedCallFoldable(CI, 3, 2)) {
4461 CallInst *NewCI =
4462 B.CreateMemCpy(CI->getArgOperand(0), Align(1), CI->getArgOperand(1),
4463 Align(1), CI->getArgOperand(2));
4464 mergeAttributesAndFlags(NewCI, *CI);
4465 return CI->getArgOperand(0);
4466 }
4467 return nullptr;
4468}
4469
4470Value *FortifiedLibCallSimplifier::optimizeMemMoveChk(CallInst *CI,
4471 IRBuilderBase &B) {
4472 if (isFortifiedCallFoldable(CI, 3, 2)) {
4473 CallInst *NewCI =
4474 B.CreateMemMove(CI->getArgOperand(0), Align(1), CI->getArgOperand(1),
4475 Align(1), CI->getArgOperand(2));
4476 mergeAttributesAndFlags(NewCI, *CI);
4477 return CI->getArgOperand(0);
4478 }
4479 return nullptr;
4480}
4481
4482Value *FortifiedLibCallSimplifier::optimizeMemSetChk(CallInst *CI,
4483 IRBuilderBase &B) {
4484 if (isFortifiedCallFoldable(CI, 3, 2)) {
4485 Value *Val = B.CreateIntCast(CI->getArgOperand(1), B.getInt8Ty(), false);
4486 CallInst *NewCI = B.CreateMemSet(CI->getArgOperand(0), Val,
4487 CI->getArgOperand(2), Align(1));
4488 mergeAttributesAndFlags(NewCI, *CI);
4489 return CI->getArgOperand(0);
4490 }
4491 return nullptr;
4492}
4493
4494Value *FortifiedLibCallSimplifier::optimizeMemPCpyChk(CallInst *CI,
4495 IRBuilderBase &B) {
4496 const DataLayout &DL = CI->getDataLayout();
4497 if (isFortifiedCallFoldable(CI, 3, 2))
4498 if (Value *Call = emitMemPCpy(CI->getArgOperand(0), CI->getArgOperand(1),
4499 CI->getArgOperand(2), B, DL, TLI)) {
4501 }
4502 return nullptr;
4503}
4504
4505Value *FortifiedLibCallSimplifier::optimizeStrpCpyChk(CallInst *CI,
4507 LibFunc Func) {
4508 const DataLayout &DL = CI->getDataLayout();
4509 Value *Dst = CI->getArgOperand(0), *Src = CI->getArgOperand(1),
4510 *ObjSize = CI->getArgOperand(2);
4511
4512 // __stpcpy_chk(x,x,...) -> x+strlen(x)
4513 if (Func == LibFunc_stpcpy_chk && !OnlyLowerUnknownSize && Dst == Src) {
4514 Value *StrLen = emitStrLen(Src, B, DL, TLI);
4515 return StrLen ? B.CreateInBoundsGEP(B.getInt8Ty(), Dst, StrLen) : nullptr;
4516 }
4517
4518 // If a) we don't have any length information, or b) we know this will
4519 // fit then just lower to a plain st[rp]cpy. Otherwise we'll keep our
4520 // st[rp]cpy_chk call which may fail at runtime if the size is too long.
4521 // TODO: It might be nice to get a maximum length out of the possible
4522 // string lengths for varying.
4523 if (isFortifiedCallFoldable(CI, 2, std::nullopt, 1)) {
4524 if (Func == LibFunc_strcpy_chk)
4525 return copyFlags(*CI, emitStrCpy(Dst, Src, B, TLI));
4526 else
4527 return copyFlags(*CI, emitStpCpy(Dst, Src, B, TLI));
4528 }
4529
4530 if (OnlyLowerUnknownSize)
4531 return nullptr;
4532
4533 // Maybe we can stil fold __st[rp]cpy_chk to __memcpy_chk.
4534 uint64_t Len = GetStringLength(Src);
4535 if (Len)
4536 annotateDereferenceableBytes(CI, 1, Len);
4537 else
4538 return nullptr;
4539
4540 unsigned SizeTBits = TLI->getSizeTSize(*CI->getModule());
4541 Type *SizeTTy = IntegerType::get(CI->getContext(), SizeTBits);
4542 Value *LenV = ConstantInt::get(SizeTTy, Len);
4543 Value *Ret = emitMemCpyChk(Dst, Src, LenV, ObjSize, B, DL, TLI);
4544 // If the function was an __stpcpy_chk, and we were able to fold it into
4545 // a __memcpy_chk, we still need to return the correct end pointer.
4546 if (Ret && Func == LibFunc_stpcpy_chk)
4547 return B.CreateInBoundsGEP(B.getInt8Ty(), Dst,
4548 ConstantInt::get(SizeTTy, Len - 1));
4549 return copyFlags(*CI, cast<CallInst>(Ret));
4550}
4551
4552Value *FortifiedLibCallSimplifier::optimizeStrLenChk(CallInst *CI,
4553 IRBuilderBase &B) {
4554 if (isFortifiedCallFoldable(CI, 1, std::nullopt, 0))
4555 return copyFlags(*CI, emitStrLen(CI->getArgOperand(0), B,
4556 CI->getDataLayout(), TLI));
4557 return nullptr;
4558}
4559
4560Value *FortifiedLibCallSimplifier::optimizeStrpNCpyChk(CallInst *CI,
4562 LibFunc Func) {
4563 if (isFortifiedCallFoldable(CI, 3, 2)) {
4564 if (Func == LibFunc_strncpy_chk)
4565 return copyFlags(*CI,
4567 CI->getArgOperand(2), B, TLI));
4568 else
4569 return copyFlags(*CI,
4571 CI->getArgOperand(2), B, TLI));
4572 }
4573
4574 return nullptr;
4575}
4576
4577Value *FortifiedLibCallSimplifier::optimizeMemCCpyChk(CallInst *CI,
4578 IRBuilderBase &B) {
4579 if (isFortifiedCallFoldable(CI, 4, 3))
4580 return copyFlags(
4581 *CI, emitMemCCpy(CI->getArgOperand(0), CI->getArgOperand(1),
4582 CI->getArgOperand(2), CI->getArgOperand(3), B, TLI));
4583
4584 return nullptr;
4585}
4586
4587Value *FortifiedLibCallSimplifier::optimizeSNPrintfChk(CallInst *CI,
4588 IRBuilderBase &B) {
4589 if (isFortifiedCallFoldable(CI, 3, 1, std::nullopt, 2)) {
4590 SmallVector<Value *, 8> VariadicArgs(drop_begin(CI->args(), 5));
4591 return copyFlags(*CI,
4593 CI->getArgOperand(4), VariadicArgs, B, TLI));
4594 }
4595
4596 return nullptr;
4597}
4598
4599Value *FortifiedLibCallSimplifier::optimizeSPrintfChk(CallInst *CI,
4600 IRBuilderBase &B) {
4601 if (isFortifiedCallFoldable(CI, 2, std::nullopt, std::nullopt, 1)) {
4602 SmallVector<Value *, 8> VariadicArgs(drop_begin(CI->args(), 4));
4603 return copyFlags(*CI,
4605 VariadicArgs, B, TLI));
4606 }
4607
4608 return nullptr;
4609}
4610
4611Value *FortifiedLibCallSimplifier::optimizeStrCatChk(CallInst *CI,
4612 IRBuilderBase &B) {
4613 if (isFortifiedCallFoldable(CI, 2))
4614 return copyFlags(
4615 *CI, emitStrCat(CI->getArgOperand(0), CI->getArgOperand(1), B, TLI));
4616
4617 return nullptr;
4618}
4619
4620Value *FortifiedLibCallSimplifier::optimizeStrLCat(CallInst *CI,
4621 IRBuilderBase &B) {
4622 if (isFortifiedCallFoldable(CI, 3))
4623 return copyFlags(*CI,
4625 CI->getArgOperand(2), B, TLI));
4626
4627 return nullptr;
4628}
4629
4630Value *FortifiedLibCallSimplifier::optimizeStrNCatChk(CallInst *CI,
4631 IRBuilderBase &B) {
4632 if (isFortifiedCallFoldable(CI, 3))
4633 return copyFlags(*CI,
4635 CI->getArgOperand(2), B, TLI));
4636
4637 return nullptr;
4638}
4639
4640Value *FortifiedLibCallSimplifier::optimizeStrLCpyChk(CallInst *CI,
4641 IRBuilderBase &B) {
4642 if (isFortifiedCallFoldable(CI, 3))
4643 return copyFlags(*CI,
4645 CI->getArgOperand(2), B, TLI));
4646
4647 return nullptr;
4648}
4649
4650Value *FortifiedLibCallSimplifier::optimizeVSNPrintfChk(CallInst *CI,
4651 IRBuilderBase &B) {
4652 if (isFortifiedCallFoldable(CI, 3, 1, std::nullopt, 2))
4653 return copyFlags(
4654 *CI, emitVSNPrintf(CI->getArgOperand(0), CI->getArgOperand(1),
4655 CI->getArgOperand(4), CI->getArgOperand(5), B, TLI));
4656
4657 return nullptr;
4658}
4659
4660Value *FortifiedLibCallSimplifier::optimizeVSPrintfChk(CallInst *CI,
4661 IRBuilderBase &B) {
4662 if (isFortifiedCallFoldable(CI, 2, std::nullopt, std::nullopt, 1))
4663 return copyFlags(*CI,
4665 CI->getArgOperand(4), B, TLI));
4666
4667 return nullptr;
4668}
4669
4671 IRBuilderBase &Builder) {
4672 // FIXME: We shouldn't be changing "nobuiltin" or TLI unavailable calls here.
4673 // Some clang users checked for _chk libcall availability using:
4674 // __has_builtin(__builtin___memcpy_chk)
4675 // When compiling with -fno-builtin, this is always true.
4676 // When passing -ffreestanding/-mkernel, which both imply -fno-builtin, we
4677 // end up with fortified libcalls, which isn't acceptable in a freestanding
4678 // environment which only provides their non-fortified counterparts.
4679 //
4680 // Until we change clang and/or teach external users to check for availability
4681 // differently, disregard the "nobuiltin" attribute and TLI::has.
4682 //
4683 // PR23093.
4684
4685 LibFunc Func;
4686 Function *Callee = CI->getCalledFunction();
4687 bool IsCallingConvC = TargetLibraryInfoImpl::isCallingConvCCompatible(CI);
4688
4690 CI->getOperandBundlesAsDefs(OpBundles);
4691
4693 Builder.setDefaultOperandBundles(OpBundles);
4694
4695 // First, check that this is a known library functions and that the prototype
4696 // is correct.
4697 if (!TLI->getLibFunc(*Callee, Func))
4698 return nullptr;
4699
4700 // We never change the calling convention.
4701 if (!ignoreCallingConv(Func) && !IsCallingConvC)
4702 return nullptr;
4703
4704 switch (Func) {
4705 case LibFunc_memcpy_chk:
4706 return optimizeMemCpyChk(CI, Builder);
4707 case LibFunc_mempcpy_chk:
4708 return optimizeMemPCpyChk(CI, Builder);
4709 case LibFunc_memmove_chk:
4710 return optimizeMemMoveChk(CI, Builder);
4711 case LibFunc_memset_chk:
4712 return optimizeMemSetChk(CI, Builder);
4713 case LibFunc_stpcpy_chk:
4714 case LibFunc_strcpy_chk:
4715 return optimizeStrpCpyChk(CI, Builder, Func);
4716 case LibFunc_strlen_chk:
4717 return optimizeStrLenChk(CI, Builder);
4718 case LibFunc_stpncpy_chk:
4719 case LibFunc_strncpy_chk:
4720 return optimizeStrpNCpyChk(CI, Builder, Func);
4721 case LibFunc_memccpy_chk:
4722 return optimizeMemCCpyChk(CI, Builder);
4723 case LibFunc_snprintf_chk:
4724 return optimizeSNPrintfChk(CI, Builder);
4725 case LibFunc_sprintf_chk:
4726 return optimizeSPrintfChk(CI, Builder);
4727 case LibFunc_strcat_chk:
4728 return optimizeStrCatChk(CI, Builder);
4729 case LibFunc_strlcat_chk:
4730 return optimizeStrLCat(CI, Builder);
4731 case LibFunc_strncat_chk:
4732 return optimizeStrNCatChk(CI, Builder);
4733 case LibFunc_strlcpy_chk:
4734 return optimizeStrLCpyChk(CI, Builder);
4735 case LibFunc_vsnprintf_chk:
4736 return optimizeVSNPrintfChk(CI, Builder);
4737 case LibFunc_vsprintf_chk:
4738 return optimizeVSPrintfChk(CI, Builder);
4739 default:
4740 break;
4741 }
4742 return nullptr;
4743}
4744
4746 const TargetLibraryInfo *TLI, bool OnlyLowerUnknownSize)
4747 : TLI(TLI), OnlyLowerUnknownSize(OnlyLowerUnknownSize) {}
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
constexpr LLT S1
This file declares a class to represent arbitrary precision floating point values and provide a varie...
This file implements the APSInt class, which is a simple class that represents an arbitrary sized int...
MachineBasicBlock MachineBasicBlock::iterator DebugLoc DL
#define X(NUM, ENUM, NAME)
Definition ELF.h:856
static GCRegistry::Add< ShadowStackGC > C("shadow-stack", "Very portable GC for uncooperative code generators")
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
Hexagon Common GEP
Module.h This file contains the declarations for the Module class.
static llvm::Error parse(GsymDataExtractor &Data, uint64_t BaseAddr, LineEntryCallback const &Callback)
Definition LineTable.cpp:54
#define F(x, y, z)
Definition MD5.cpp:54
#define I(x, y, z)
Definition MD5.cpp:57
#define T
uint64_t IntrinsicInst * II
static bool isBinary(MachineInstr &MI)
if(PassOpts->AAPipeline)
const SmallVectorImpl< MachineOperand > & Cond
static bool isOnlyUsedInEqualityComparison(Value *V, Value *With)
Return true if it is only used in equality comparisons with With.
static Value * optimizeSinCosDoubleFP(CallInst *CI, IRBuilderBase &B)
Shrink double -> float for llvm.sincos.
static void annotateNonNullAndDereferenceable(CallInst *CI, ArrayRef< unsigned > ArgNos, Value *Size, const DataLayout &DL)
static cl::opt< unsigned, false, HotColdHintParser > ColdNewHintValue("cold-new-hint-value", cl::Hidden, cl::init(1), cl::desc("Value to pass to hot/cold operator new for cold allocation"))
static bool insertSinCosCall(IRBuilderBase &B, Function *OrigCallee, Value *Arg, bool UseFloat, Value *&Sin, Value *&Cos, Value *&SinCos, const TargetLibraryInfo *TLI)
static Value * mergeAttributesAndFlags(CallInst *NewCI, const CallInst &Old)
static cl::opt< bool > OptimizeHotColdNew("optimize-hot-cold-new", cl::Hidden, cl::init(false), cl::desc("Enable hot/cold operator new library calls"))
static Value * optimizeBinaryDoubleFP(CallInst *CI, IRBuilderBase &B, const TargetLibraryInfo *TLI, bool isPrecise=false)
Shrink double -> float for binary functions.
static bool ignoreCallingConv(LibFunc Func)
static cl::opt< bool > OptimizeExistingHotColdNew("optimize-existing-hot-cold-new", cl::Hidden, cl::init(false), cl::desc("Enable optimization of existing hot/cold operator new library calls"))
static void annotateDereferenceableBytes(CallInst *CI, ArrayRef< unsigned > ArgNos, uint64_t DereferenceableBytes)
static bool isReportingError(Function *Callee, CallInst *CI, int StreamArg)
static Value * optimizeDoubleFP(CallInst *CI, IRBuilderBase &B, bool isBinary, const TargetLibraryInfo *TLI, bool isPrecise=false)
Shrink double -> float functions.
static Value * optimizeSymmetricCall(CallInst *CI, bool IsEven, IRBuilderBase &B)
static Value * getSqrtCall(Value *V, AttributeList Attrs, bool NoErrno, Module *M, IRBuilderBase &B, const TargetLibraryInfo *TLI)
static Value * replaceBinaryCall(CallInst *CI, IRBuilderBase &B, Intrinsic::ID IID)
static Value * valueHasFloatPrecision(Value *Val)
Return a variant of Val with float type.
static Value * optimizeMemCmpConstantSize(CallInst *CI, Value *LHS, Value *RHS, uint64_t Len, IRBuilderBase &B, const DataLayout &DL)
static Value * createPowWithIntegerExponent(Value *Base, Value *Expo, Module *M, IRBuilderBase &B)
static Value * convertStrToInt(CallInst *CI, StringRef &Str, Value *EndPtr, uint64_t Base, bool AsSigned, IRBuilderBase &B)
static Value * memChrToCharCompare(CallInst *CI, Value *NBytes, IRBuilderBase &B, const DataLayout &DL)
static Value * copyFlags(const CallInst &Old, Value *New)
static bool canTransformToMemCmp(CallInst *CI, Value *Str, uint64_t Len, const SimplifyQuery &SQ)
static StringRef substr(StringRef Str, uint64_t Len)
static cl::opt< unsigned, false, HotColdHintParser > HotNewHintValue("hot-new-hint-value", cl::Hidden, cl::init(254), cl::desc("Value to pass to hot/cold operator new for hot allocation"))
static bool isTrigLibCall(CallInst *CI)
static Value * optimizeNaN(CallInst *CI)
Constant folding nan/nanf/nanl.
static bool isOnlyUsedInComparisonWithZero(Value *V)
static Value * replaceUnaryCall(CallInst *CI, IRBuilderBase &B, Intrinsic::ID IID)
static bool callHasFloatingPointArgument(const CallInst *CI)
static Value * optimizeUnaryDoubleFP(CallInst *CI, IRBuilderBase &B, const TargetLibraryInfo *TLI, bool isPrecise=false)
Shrink double -> float for unary functions.
static bool callHasFP128Argument(const CallInst *CI)
static cl::opt< bool > OptimizeNoBuiltinHotColdNew("optimize-nobuiltin-hot-cold-new-new", cl::Hidden, cl::init(false), cl::desc("Enable transformation of nobuiltin operator new library calls"))
static cl::opt< unsigned, false, HotColdHintParser > AmbiguousNewHintValue("ambiguous-new-hint-value", cl::Hidden, cl::init(222), cl::desc("Value to pass to hot/cold operator new for ambiguous allocation"))
static void annotateNonNullNoUndefBasedOnAccess(CallInst *CI, ArrayRef< unsigned > ArgNos)
static Value * optimizeMemCmpVarSize(CallInst *CI, Value *LHS, Value *RHS, Value *Size, bool StrNCmp, IRBuilderBase &B, const DataLayout &DL)
static Value * getIntToFPVal(Value *I2F, IRBuilderBase &B, unsigned DstWidth)
static cl::opt< bool > EnableUnsafeFPShrink("enable-double-float-shrink", cl::Hidden, cl::init(false), cl::desc("Enable unsafe double to float " "shrinking for math lib calls"))
static cl::opt< unsigned, false, HotColdHintParser > NotColdNewHintValue("notcold-new-hint-value", cl::Hidden, cl::init(128), cl::desc("Value to pass to hot/cold operator new for " "notcold (warm) allocation"))
This file defines the SmallString class.
This file contains some functions that are useful when dealing with strings.
static TableGen::Emitter::Opt Y("gen-skeleton-entry", EmitSkeleton, "Generate example skeleton entry")
static SymbolRef::Type getType(const Symbol *Sym)
Definition TapiFile.cpp:39
Value * RHS
Value * LHS
static const fltSemantics & IEEEsingle()
Definition APFloat.h:304
static constexpr roundingMode rmTowardZero
Definition APFloat.h:357
static constexpr roundingMode rmTowardNegative
Definition APFloat.h:356
static constexpr roundingMode rmNearestTiesToEven
Definition APFloat.h:353
opStatus
IEEE-754R 7: Default exception handling.
Definition APFloat.h:369
opStatus divide(const APFloat &RHS, roundingMode RM)
Definition APFloat.h:1304
bool isFiniteNonZero() const
Definition APFloat.h:1585
LLVM_ABI opStatus convert(const fltSemantics &ToSemantics, roundingMode RM, bool *losesInfo)
Definition APFloat.cpp:5934
opStatus subtract(const APFloat &RHS, roundingMode RM)
Definition APFloat.h:1286
bool isNegative() const
Definition APFloat.h:1575
LLVM_ABI double convertToDouble() const
Converts this APFloat to host double value.
Definition APFloat.cpp:5993
bool isExactlyValue(double V) const
We don't rely on operator== working on double values, as it returns true for things that are clearly ...
Definition APFloat.h:1558
opStatus add(const APFloat &RHS, roundingMode RM)
Definition APFloat.h:1277
const fltSemantics & getSemantics() const
Definition APFloat.h:1583
LLVM_ABI float convertToFloat() const
Converts this APFloat to host float value.
Definition APFloat.cpp:6021
opStatus remainder(const APFloat &RHS)
Definition APFloat.h:1313
opStatus convertToInteger(MutableArrayRef< integerPart > Input, unsigned int Width, bool IsSigned, roundingMode RM, bool *IsExact) const
Definition APFloat.h:1428
bool isInteger() const
Definition APFloat.h:1592
Class for arbitrary precision integers.
Definition APInt.h:78
Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition ArrayRef.h:40
A cache of @llvm.assume calls within a function.
static LLVM_ABI Attribute getWithDereferenceableBytes(LLVMContext &Context, uint64_t Bytes)
static LLVM_ABI Attribute getWithCaptureInfo(LLVMContext &Context, CaptureInfo CI)
LLVM Basic Block Representation.
Definition BasicBlock.h:62
iterator begin()
Instruction iterator methods.
Definition BasicBlock.h:446
BlockFrequencyInfo pass uses BlockFrequencyInfoImpl implementation to estimate IR basic block frequen...
void addFnAttr(Attribute::AttrKind Kind)
Adds the attribute to the function.
void removeParamAttrs(unsigned ArgNo, const AttributeMask &AttrsToRemove)
Removes the attributes from the given argument.
LLVM_ABI void getOperandBundlesAsDefs(SmallVectorImpl< OperandBundleDef > &Defs) const
Return the list of operand bundles attached to this instruction as a vector of OperandBundleDefs.
bool isNoBuiltin() const
Return true if the call should not be treated as a call to a builtin.
void removeParamAttr(unsigned ArgNo, Attribute::AttrKind Kind)
Removes the attribute from the given argument.
Function * getCalledFunction() const
Returns the function called, or null if this is an indirect function invocation or the function signa...
bool doesNotAccessMemory(unsigned OpNo) const
void removeRetAttrs(const AttributeMask &AttrsToRemove)
Removes the attributes from the return value.
bool hasFnAttr(Attribute::AttrKind Kind) const
Determine whether this call has the given attribute.
bool isStrictFP() const
Determine if the call requires strict floating point semantics.
AttributeSet getParamAttributes(unsigned ArgNo) const
Return the param attributes for this call.
uint64_t getParamDereferenceableBytes(unsigned i) const
Extract the number of dereferenceable bytes for a call or parameter (0=unknown).
LLVM_ABI bool paramHasAttr(unsigned ArgNo, Attribute::AttrKind Kind) const
Determine whether the argument or parameter has the given attribute.
MaybeAlign getParamAlign(unsigned ArgNo) const
Extract the alignment for a call or parameter (0=unknown).
AttributeSet getRetAttributes() const
Return the return attributes for this call.
void setAttributes(AttributeList A)
Set the attributes for this call.
bool doesNotThrow() const
Determine if the call cannot unwind.
Value * getArgOperand(unsigned i) const
uint64_t getParamDereferenceableOrNullBytes(unsigned i) const
Extract the number of dereferenceable_or_null bytes for a parameter (0=unknown).
LLVM_ABI Intrinsic::ID getIntrinsicID() const
Returns the intrinsic ID of the intrinsic called or Intrinsic::not_intrinsic if the called function i...
iterator_range< User::op_iterator > args()
Iteration adapter for range-for loops.
unsigned arg_size() const
AttributeList getAttributes() const
Return the attributes for this call.
void addParamAttr(unsigned ArgNo, Attribute::AttrKind Kind)
Adds the attribute to the indicated argument.
LLVM_ABI Function * getCaller()
Helper to get the caller (the parent function).
This class represents a function call, abstracting a target machine's calling convention.
bool isNoTailCall() const
TailCallKind getTailCallKind() const
bool isMustTailCall() const
static CaptureInfo none()
Create CaptureInfo that does not capture any components of the pointer.
Definition ModRef.h:427
@ ICMP_UGT
unsigned greater than
Definition InstrTypes.h:763
@ ICMP_ULT
unsigned less than
Definition InstrTypes.h:765
@ ICMP_ULE
unsigned less or equal
Definition InstrTypes.h:766
Predicate getPredicate() const
Return the predicate for this instruction.
Definition InstrTypes.h:828
LLVM_ABI uint64_t getElementAsInteger(uint64_t i) const
If this is a sequential container of integers (of any size), return the specified element in the low ...
ConstantFP - Floating Point Values [float, double].
Definition Constants.h:420
static LLVM_ABI ConstantFP * getZero(Type *Ty, bool Negative=false)
static LLVM_ABI ConstantFP * getQNaN(Type *Ty, bool Negative=false, APInt *Payload=nullptr)
static LLVM_ABI ConstantFP * getInfinity(Type *Ty, bool Negative=false)
This is the shared class of boolean and integer constants.
Definition Constants.h:87
bool isOne() const
This is just a convenience method to make client code smaller for a common case.
Definition Constants.h:225
static ConstantInt * getSigned(IntegerType *Ty, int64_t V, bool ImplicitTrunc=false)
Return a ConstantInt with the specified value for the specified type.
Definition Constants.h:135
bool isZero() const
This is just a convenience method to make client code smaller for a common code.
Definition Constants.h:219
int64_t getSExtValue() const
Return the constant as a 64-bit integer value after it has been sign extended as appropriate for the ...
Definition Constants.h:174
uint64_t getZExtValue() const
Return the constant as a 64-bit unsigned integer value after it has been zero extended as appropriate...
Definition Constants.h:168
This is an important base class in LLVM.
Definition Constant.h:43
static LLVM_ABI Constant * getNullValue(Type *Ty)
Constructor to create a '0' constant of arbitrary type.
A parsed version of the target data layout string in and methods for querying it.
Definition DataLayout.h:64
Concrete subclass of DominatorTreeBase that is used to compute a normal dominator tree.
Definition Dominators.h:122
This class represents an extension of floating point types.
This class represents a truncation of floating point types.
void setNoSignedZeros(bool B=true)
Definition FMF.h:84
static FastMathFlags getFast()
Definition FMF.h:50
static LLVM_ABI FixedVectorType * get(Type *ElementType, unsigned NumElts)
Definition Type.cpp:867
LLVM_ABI FortifiedLibCallSimplifier(const TargetLibraryInfo *TLI, bool OnlyLowerUnknownSize=false)
LLVM_ABI Value * optimizeCall(CallInst *CI, IRBuilderBase &B)
Take the given call instruction and return a more optimal value to replace the instruction with or 0 ...
A handy container for a FunctionType+Callee-pointer pair, which can be passed around as a single enti...
Intrinsic::ID getIntrinsicID() const LLVM_READONLY
getIntrinsicID - This method returns the ID number of the specified function, or Intrinsic::not_intri...
Definition Function.h:246
AttributeList getAttributes() const
Return the attribute list for this Function.
Definition Function.h:328
bool isIntrinsic() const
isIntrinsic - Returns true if the function's name starts with "llvm.".
Definition Function.h:251
bool hasFnAttribute(Attribute::AttrKind Kind) const
Return true if the function has the attribute.
Definition Function.cpp:727
LLVM_ABI bool isDeclaration() const
Return true if the primary definition of this global value is outside of the current translation unit...
Definition Globals.cpp:408
Module * getParent()
Get the module that this global value is contained inside of...
This instruction compares its operands according to the predicate given to the constructor.
Common base class shared among various IRBuilders.
Definition IRBuilder.h:114
LLVM_ABI Instruction * clone() const
Create a copy of 'this' instruction that is identical in all ways except the following:
LLVM_ABI bool hasNoNaNs() const LLVM_READONLY
Determine whether the no-NaNs flag is set.
LLVM_ABI void copyIRFlags(const Value *V, bool IncludeWrapFlags=true)
Convenience method to copy supported exact, fast-math, and (optionally) wrapping flags from V to this...
LLVM_ABI const Module * getModule() const
Return the module owning the function this instruction belongs to or nullptr it the function does not...
LLVM_ABI bool isFast() const LLVM_READONLY
Determine whether all fast-math-flags are set.
LLVM_ABI const Function * getFunction() const
Return the function this instruction belongs to.
MDNode * getMetadata(unsigned KindID) const
Get the metadata of given kind attached to this Instruction.
LLVM_ABI FastMathFlags getFastMathFlags() const LLVM_READONLY
Convenience function for getting all the fast-math flags, which must be an operator which supports th...
LLVM_ABI void copyMetadata(const Instruction &SrcInst, ArrayRef< unsigned > WL=ArrayRef< unsigned >())
Copy metadata from SrcInst to this instruction.
LLVM_ABI bool hasAllowReassoc() const LLVM_READONLY
Determine whether the allow-reassociation flag is set.
LLVM_ABI const DataLayout & getDataLayout() const
Get the data layout of the module this instruction belongs to.
Class to represent integer types.
static LLVM_ABI IntegerType * get(LLVMContext &C, unsigned NumBits)
This static method is the primary way of constructing an IntegerType.
Definition Type.cpp:348
A wrapper class for inspecting calls to intrinsic functions.
LLVM_ABI LibCallSimplifier(const DataLayout &DL, const TargetLibraryInfo *TLI, DominatorTree *DT, DomConditionCache *DC, AssumptionCache *AC, OptimizationRemarkEmitter &ORE, BlockFrequencyInfo *BFI, ProfileSummaryInfo *PSI, function_ref< void(Instruction *, Value *)> Replacer=&replaceAllUsesWithDefault, function_ref< void(Instruction *)> Eraser=&eraseFromParentDefault)
LLVM_ABI Value * optimizeCall(CallInst *CI, IRBuilderBase &B)
optimizeCall - Take the given call instruction and return a more optimal value to replace the instruc...
An instruction for reading from memory.
Value * getPointerOperand()
iterator begin()
Definition MapVector.h:67
size_type size() const
Definition MapVector.h:58
A Module instance is used to store all the information related to an LLVM module.
Definition Module.h:67
const Triple & getTargetTriple() const
Get the target triple which is a string describing the target host.
Definition Module.h:323
The optimization diagnostic interface.
static LLVM_ABI PoisonValue * get(Type *T)
Static factory methods - Return an 'poison' object of the specified type.
Analysis providing profile information.
This class consists of common code factored out of the SmallVector class to reduce code duplication b...
void push_back(const T &Elt)
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
Represent a constant reference to a string, i.e.
Definition StringRef.h:56
static constexpr size_t npos
Definition StringRef.h:58
bool getAsInteger(unsigned Radix, T &Result) const
Parse the current string as an integer of the specified radix.
Definition StringRef.h:490
bool starts_with(StringRef Prefix) const
Check if this string starts with the given Prefix.
Definition StringRef.h:258
constexpr bool empty() const
Check if the string is empty.
Definition StringRef.h:141
char back() const
Get the last character in the string.
Definition StringRef.h:153
constexpr size_t size() const
Get the string size.
Definition StringRef.h:144
bool contains(StringRef Other) const
Return true if the given string is a substring of *this, and false otherwise.
Definition StringRef.h:446
size_t find(char C, size_t From=0) const
Search for the first character C in the string.
Definition StringRef.h:290
bool ends_with(StringRef Suffix) const
Check if this string ends with the given Suffix.
Definition StringRef.h:270
int compare(StringRef RHS) const
Compare two strings; the result is negative, zero, or positive if this string is lexicographically le...
Definition StringRef.h:177
static LLVM_ABI StructType * get(LLVMContext &Context, ArrayRef< Type * > Elements, bool isPacked=false)
This static method is the primary way to create a literal StructType.
Definition Type.cpp:477
static LLVM_ABI bool isCallingConvCCompatible(CallBase *CI)
Returns true if call site / callee has cdecl-compatible calling conventions.
Provides information about what library functions are available for the current target.
bool getLibFunc(StringRef funcName, LibFunc &F) const
Searches for a particular function name.
Triple - Helper class for working with autoconf configuration names.
Definition Triple.h:48
The instances of the Type class are immutable: once they are created, they are never changed.
Definition Type.h:46
LLVM_ABI unsigned getIntegerBitWidth() const
bool isVectorTy() const
True if this is an instance of VectorType.
Definition Type.h:288
bool isPointerTy() const
True if this is an instance of PointerType.
Definition Type.h:282
bool isFloatTy() const
Return true if this is 'float', a 32-bit IEEE fp type.
Definition Type.h:155
LLVM_ABI unsigned getPointerAddressSpace() const
Get the address space of this pointer or pointer vector type.
static LLVM_ABI IntegerType * getInt8Ty(LLVMContext &C)
Definition Type.cpp:307
Type * getScalarType() const
If this is a vector type, return the element type, otherwise return 'this'.
Definition Type.h:368
bool isStructTy() const
True if this is an instance of StructType.
Definition Type.h:276
LLVM_ABI TypeSize getPrimitiveSizeInBits() const LLVM_READONLY
Return the basic size of this type if it is a primitive type.
Definition Type.cpp:197
bool isDoubleTy() const
Return true if this is 'double', a 64-bit IEEE fp type.
Definition Type.h:158
bool isIntegerTy() const
True if this is an instance of IntegerType.
Definition Type.h:257
static LLVM_ABI IntegerType * getIntNTy(LLVMContext &C, unsigned N)
Definition Type.cpp:313
LLVM_ABI const fltSemantics & getFltSemantics() const
Definition Type.cpp:106
A Use represents the edge between a Value definition and its users.
Definition Use.h:35
op_range operands()
Definition User.h:267
void setOperand(unsigned i, Value *Val)
Definition User.h:212
Value * getOperand(unsigned i) const
Definition User.h:207
LLVM Value Representation.
Definition Value.h:75
Type * getType() const
All values are typed, get the type of this value.
Definition Value.h:255
bool hasOneUse() const
Return true if there is exactly one use of this value.
Definition Value.h:439
LLVMContext & getContext() const
All values hold a context through their type.
Definition Value.h:258
iterator_range< user_iterator > users()
Definition Value.h:426
bool use_empty() const
Definition Value.h:346
LLVM_ABI StringRef getName() const
Return a constant reference to the value's name.
Definition Value.cpp:319
LLVM_ABI void takeName(Value *V)
Transfer the name from V to this value.
Definition Value.cpp:400
An efficient, type-erasing, non-owning reference to a callable.
const ParentTy * getParent() const
Definition ilist_node.h:34
CallInst * Call
#define UINT64_MAX
Definition DataTypes.h:77
constexpr char Align[]
Key for Kernel::Arg::Metadata::mAlign.
Flag
These should be considered private to the implementation of the MCInstrDesc class.
OneUse_match< SubPat > m_OneUse(const SubPat &SP)
ap_match< APInt > m_APInt(const APInt *&Res)
Match a ConstantInt or splatted ConstantVector, binding the specified pointer to the contained APInt.
BinaryOp_match< LHS, RHS, Instruction::FMul > m_FMul(const LHS &L, const RHS &R)
bool match(Val *V, const Pattern &P)
match_deferred< Value > m_Deferred(Value *const &V)
Like m_Specific(), but works if the specific value to match is determined as part of the same match()...
cstfp_pred_ty< is_any_zero_fp > m_AnyZeroFP()
Match a floating-point negative zero or positive zero.
ap_match< APFloat > m_APFloat(const APFloat *&Res)
Match a ConstantFP or splatted ConstantVector, binding the specified pointer to the contained APFloat...
ThreeOps_match< Cond, LHS, RHS, Instruction::Select > m_Select(const Cond &C, const LHS &L, const RHS &R)
Matches SelectInst.
specific_fpval m_SpecificFP(double V)
Match a specific floating point value or vector with all elements equal to the value.
auto m_CopySign(const Opnd0 &Op0, const Opnd1 &Op1)
auto m_Value()
Match an arbitrary value and ignore it.
specific_fpval m_FPOne()
Match a float 1.0 or vector with all elements equal to 1.0.
auto m_FAbs(const Opnd0 &Op0)
FNeg_match< OpTy > m_FNeg(const OpTy &X)
Match 'fneg X' as 'fsub -0.0, X'.
auto m_ConstantInt()
Match an arbitrary ConstantInt and ignore it.
This namespace contains all of the command line option processing machinery.
Definition MCSchedule.h:35
initializer< Ty > init(const Ty &Val)
constexpr double e
NodeAddr< FuncNode * > Func
Definition RDFGraph.h:393
friend class Instruction
Iterator for Instructions in a `BasicBlock.
Definition BasicBlock.h:73
This is an optimization pass for GlobalISel generic memory operations.
auto drop_begin(T &&RangeOrContainer, size_t N=1)
Return a range covering RangeOrContainer with the first N elements excluded.
Definition STLExtras.h:315
@ Offset
Definition DWP.cpp:578
@ Length
Definition DWP.cpp:578
LLVM_ABI Value * emitUnaryFloatFnCall(Value *Op, const TargetLibraryInfo *TLI, StringRef Name, IRBuilderBase &B, const AttributeList &Attrs)
Emit a call to the unary function named 'Name' (e.g.
LLVM_ABI KnownFPClass computeKnownFPClass(const Value *V, const APInt &DemandedElts, FPClassTest InterestedClasses, const SimplifyQuery &SQ, unsigned Depth=0)
Determine which floating-point classes are valid for V, and return them in KnownFPClass bit sets.
LLVM_ABI Value * emitStrChr(Value *Ptr, char C, IRBuilderBase &B, const TargetLibraryInfo *TLI)
Emit a call to the strchr function to the builder, for the specified pointer and character.
constexpr uint64_t maxUIntN(uint64_t N)
Gets the maximum value for a N-bit unsigned integer.
Definition MathExtras.h:208
LLVM_ABI Value * emitPutChar(Value *Char, IRBuilderBase &B, const TargetLibraryInfo *TLI)
Emit a call to the putchar function. This assumes that Char is an 'int'.
LLVM_ABI Value * emitMemCpyChk(Value *Dst, Value *Src, Value *Len, Value *ObjSize, IRBuilderBase &B, const DataLayout &DL, const TargetLibraryInfo *TLI)
Emit a call to the __memcpy_chk function to the builder.
LLVM_ABI Value * emitStrNCpy(Value *Dst, Value *Src, Value *Len, IRBuilderBase &B, const TargetLibraryInfo *TLI)
Emit a call to the strncpy function to the builder, for the specified pointer arguments and length.
LLVM_ABI bool isKnownNeverInfinity(const Value *V, const SimplifyQuery &SQ, unsigned Depth=0)
Return true if the floating-point scalar value is not an infinity or if the floating-point vector val...
LLVM_ABI bool isOnlyUsedInZeroEqualityComparison(const Instruction *CxtI)
@ Known
Known to have no common set bits.
LLVM_ABI Value * emitHotColdNewAlignedNoThrow(Value *Num, Value *Align, Value *NoThrow, IRBuilderBase &B, const TargetLibraryInfo *TLI, LibFunc NewFunc, uint8_t HotCold)
decltype(auto) dyn_cast(const From &Val)
dyn_cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:643
APFloat abs(APFloat X)
Returns the absolute value of the argument.
Definition APFloat.h:1713
LLVM_ABI bool getConstantStringInfo(const Value *V, StringRef &Str, bool TrimAtNul=true)
This function computes the length of a null-terminated C string pointed to by V.
LLVM_ABI Value * emitSPrintf(Value *Dest, Value *Fmt, ArrayRef< Value * > VariadicArgs, IRBuilderBase &B, const TargetLibraryInfo *TLI)
Emit a call to the sprintf function.
LLVM_ABI bool getConstantDataArrayInfo(const Value *V, ConstantDataArraySlice &Slice, unsigned ElementSize, uint64_t Offset=0)
Returns true if the value V is a pointer into a ConstantDataArray.
LLVM_ABI Value * emitMemRChr(Value *Ptr, Value *Val, Value *Len, IRBuilderBase &B, const DataLayout &DL, const TargetLibraryInfo *TLI)
Emit a call to the memrchr function, analogously to emitMemChr.
LLVM_ABI Value * emitStrLCat(Value *Dest, Value *Src, Value *Size, IRBuilderBase &B, const TargetLibraryInfo *TLI)
Emit a call to the strlcat function.
LLVM_ABI bool shouldOptimizeForSize(const MachineFunction *MF, ProfileSummaryInfo *PSI, const MachineBlockFrequencyInfo *BFI, PGSOQueryType QueryType=PGSOQueryType::Other)
Returns true if machine function MF is suggested to be size-optimized based on the profile.
iterator_range< early_inc_iterator_impl< detail::IterOfRange< RangeT > > > make_early_inc_range(RangeT &&Range)
Make a range that does early increment to allow mutation of the underlying range without disrupting i...
Definition STLExtras.h:633
LLVM_ABI bool hasFloatFn(const Module *M, const TargetLibraryInfo *TLI, Type *Ty, LibFunc DoubleFn, LibFunc FloatFn, LibFunc LongDoubleFn)
Check whether the overloaded floating point function corresponding to Ty is available.
RelativeUniformCounterPtr ValuesPtrExpr VTableAddr Value
Definition InstrProf.h:143
LLVM_ABI Value * emitStrNCat(Value *Dest, Value *Src, Value *Size, IRBuilderBase &B, const TargetLibraryInfo *TLI)
Emit a call to the strncat function.
LLVM_ABI bool isLibFuncEmittable(const Module *M, const TargetLibraryInfo *TLI, LibFunc TheLibFunc)
Check whether the library function is available on target and also that it in the current Module is a...
LLVM_ABI Value * emitVSNPrintf(Value *Dest, Value *Size, Value *Fmt, Value *VAList, IRBuilderBase &B, const TargetLibraryInfo *TLI)
Emit a call to the vsnprintf function.
auto dyn_cast_or_null(const Y &Val)
Definition Casting.h:753
Align getKnownAlignment(Value *V, const DataLayout &DL, const Instruction *CxtI=nullptr, AssumptionCache *AC=nullptr, const DominatorTree *DT=nullptr)
Try to infer an alignment for the specified pointer.
Definition Local.h:254
bool any_of(R &&range, UnaryPredicate P)
Provide wrappers to std::any_of which take ranges instead of having to pass begin/end explicitly.
Definition STLExtras.h:1746
LLVM_ABI Value * emitStrNCmp(Value *Ptr1, Value *Ptr2, Value *Len, IRBuilderBase &B, const DataLayout &DL, const TargetLibraryInfo *TLI)
Emit a call to the strncmp function to the builder.
LLVM_ABI Value * emitMemCmp(Value *Ptr1, Value *Ptr2, Value *Len, IRBuilderBase &B, const DataLayout &DL, const TargetLibraryInfo *TLI)
Emit a call to the memcmp function.
LLVM_ABI Value * emitBinaryFloatFnCall(Value *Op1, Value *Op2, const TargetLibraryInfo *TLI, StringRef Name, IRBuilderBase &B, const AttributeList &Attrs)
Emit a call to the binary function named 'Name' (e.g.
bool isAlpha(char C)
Checks if character C is a valid letter as classified by "C" locale.
LLVM_ABI Value * emitFPutS(Value *Str, Value *File, IRBuilderBase &B, const TargetLibraryInfo *TLI)
Emit a call to the fputs function.
LLVM_ABI Value * emitStrDup(Value *Ptr, IRBuilderBase &B, const TargetLibraryInfo *TLI)
Emit a call to the strdup function to the builder, for the specified pointer.
decltype(auto) get(const PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info > &Pair)
void sort(IteratorTy Start, IteratorTy End)
Definition STLExtras.h:1636
LLVM_ABI void computeKnownBits(const Value *V, KnownBits &Known, const DataLayout &DL, AssumptionCache *AC=nullptr, const Instruction *CxtI=nullptr, const DominatorTree *DT=nullptr, bool UseInstrInfo=true, unsigned Depth=0)
Determine which bits of V are known to be either zero or one and return them in the KnownZero/KnownOn...
LLVM_ABI bool NullPointerIsDefined(const Function *F, unsigned AS=0)
Check whether null pointer dereferencing is considered undefined behavior for a given function or an ...
LLVM_ABI Value * emitBCmp(Value *Ptr1, Value *Ptr2, Value *Len, IRBuilderBase &B, const DataLayout &DL, const TargetLibraryInfo *TLI)
Emit a call to the bcmp function.
bool isDigit(char C)
Checks if character C is one of the 10 decimal digits.
std::enable_if_t< std::is_unsigned_v< T >, T > SaturatingMultiplyAdd(T X, T Y, T A, bool *ResultOverflowed=nullptr)
Multiply two unsigned integers, X and Y, and add the unsigned integer, A to the product.
Definition MathExtras.h:685
LLVM_ABI uint64_t GetStringLength(const Value *V, unsigned CharSize=8)
If we can compute the length of the string pointed to by the specified pointer, return 'len+1'.
LLVM_ABI FunctionCallee getOrInsertLibFunc(Module *M, const TargetLibraryInfo &TLI, LibFunc TheLibFunc, FunctionType *T, AttributeList AttributeList)
Calls getOrInsertFunction() and then makes sure to add mandatory argument attributes.
LLVM_ABI Value * emitStrLen(Value *Ptr, IRBuilderBase &B, const DataLayout &DL, const TargetLibraryInfo *TLI)
Emit a call to the strlen function to the builder, for the specified pointer.
LLVM_ABI Value * emitFPutC(Value *Char, Value *File, IRBuilderBase &B, const TargetLibraryInfo *TLI)
Emit a call to the fputc function.
LLVM_ABI Value * emitStpNCpy(Value *Dst, Value *Src, Value *Len, IRBuilderBase &B, const TargetLibraryInfo *TLI)
Emit a call to the stpncpy function to the builder, for the specified pointer arguments and length.
LLVM_ABI Value * emitStrCat(Value *Dest, Value *Src, IRBuilderBase &B, const TargetLibraryInfo *TLI)
Emit a call to the strcat function.
class LLVM_GSL_OWNER SmallVector
Forward declaration of SmallVector so that calculateSmallVectorDefaultInlinedElements can reference s...
bool isa(const From &Val)
isa<X> - Return true if the parameter to the template is an instance of one of the template type argu...
Definition Casting.h:547
LLVM_ABI Value * emitVSPrintf(Value *Dest, Value *Fmt, Value *VAList, IRBuilderBase &B, const TargetLibraryInfo *TLI)
Emit a call to the vsprintf function.
LLVM_ABI bool isKnownNonZero(const Value *V, const SimplifyQuery &Q, unsigned Depth=0)
Return true if the given value is known to be non-zero when defined.
LLVM_ABI Value * emitFWrite(Value *Ptr, Value *Size, Value *File, IRBuilderBase &B, const DataLayout &DL, const TargetLibraryInfo *TLI)
Emit a call to the fwrite function.
LLVM_ABI Value * emitSNPrintf(Value *Dest, Value *Size, Value *Fmt, ArrayRef< Value * > Args, IRBuilderBase &B, const TargetLibraryInfo *TLI)
Emit a call to the snprintf function.
@ Mod
The access may modify the value stored in memory.
Definition ModRef.h:34
LLVM_ABI Value * emitStpCpy(Value *Dst, Value *Src, IRBuilderBase &B, const TargetLibraryInfo *TLI)
Emit a call to the stpcpy function to the builder, for the specified pointer arguments.
@ FMul
Product of floats.
@ And
Bitwise or logical AND of integers.
char toUpper(char x)
Returns the corresponding uppercase character if x is lowercase.
DWARFExpression::Operation Op
@ NearestTiesToEven
roundTiesToEven.
constexpr int64_t maxIntN(int64_t N)
Gets the maximum value for a N-bit signed integer.
Definition MathExtras.h:233
constexpr unsigned BitWidth
decltype(auto) cast(const From &Val)
cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:559
LLVM_ABI Value * emitHotColdNewNoThrow(Value *Num, Value *NoThrow, IRBuilderBase &B, const TargetLibraryInfo *TLI, LibFunc NewFunc, uint8_t HotCold)
LLVM_ABI Value * emitMalloc(Value *Num, IRBuilderBase &B, const DataLayout &DL, const TargetLibraryInfo *TLI)
Emit a call to the malloc function.
LLVM_ABI Value * emitMemChr(Value *Ptr, Value *Val, Value *Len, IRBuilderBase &B, const DataLayout &DL, const TargetLibraryInfo *TLI)
Emit a call to the memchr function.
LLVM_ABI Value * emitHotColdNewAligned(Value *Num, Value *Align, IRBuilderBase &B, const TargetLibraryInfo *TLI, LibFunc NewFunc, uint8_t HotCold)
bool isSpace(char C)
Checks whether character C is whitespace in the "C" locale.
LLVM_ABI Value * emitPutS(Value *Str, IRBuilderBase &B, const TargetLibraryInfo *TLI)
Emit a call to the puts function. This assumes that Str is some pointer.
LLVM_ABI Value * emitMemCCpy(Value *Ptr1, Value *Ptr2, Value *Val, Value *Len, IRBuilderBase &B, const TargetLibraryInfo *TLI)
Emit a call to the memccpy function.
LLVM_ABI Value * emitHotColdSizeReturningNew(Value *Num, IRBuilderBase &B, const TargetLibraryInfo *TLI, LibFunc NewFunc, uint8_t HotCold)
LLVM_ABI Value * emitHotColdNew(Value *Num, IRBuilderBase &B, const TargetLibraryInfo *TLI, LibFunc NewFunc, uint8_t HotCold)
Emit a call to the hot/cold operator new function.
LLVM_ABI Constant * ConstantFoldLoadFromConstPtr(Constant *C, Type *Ty, APInt Offset, const DataLayout &DL)
Return the value that a load from C with offset Offset would produce if it is constant and determinab...
LLVM_ABI bool isDereferenceablePointer(const Value *V, Type *Ty, const SimplifyQuery &Q, bool IgnoreFree=false)
Equivalent to isDereferenceableAndAlignedPointer with an alignment of 1.
Definition Loads.cpp:264
LLVM_ABI Value * emitStrLCpy(Value *Dest, Value *Src, Value *Size, IRBuilderBase &B, const TargetLibraryInfo *TLI)
Emit a call to the strlcpy function.
LLVM_ABI Value * emitHotColdSizeReturningNewAligned(Value *Num, Value *Align, IRBuilderBase &B, const TargetLibraryInfo *TLI, LibFunc NewFunc, uint8_t HotCold)
LLVM_ABI Value * emitStrCpy(Value *Dst, Value *Src, IRBuilderBase &B, const TargetLibraryInfo *TLI)
Emit a call to the strcpy function to the builder, for the specified pointer arguments.
LLVM_ABI Value * emitMemPCpy(Value *Dst, Value *Src, Value *Len, IRBuilderBase &B, const DataLayout &DL, const TargetLibraryInfo *TLI)
Emit a call to the mempcpy function.
constexpr uint64_t NextPowerOf2(uint64_t A)
Returns the next power of two (in 64-bits) that is strictly greater than A.
Definition MathExtras.h:374
#define N
This struct is a compact representation of a valid (non-zero power of two) alignment.
Definition Alignment.h:39
uint64_t Length
Length of the slice.
uint64_t Offset
Slice starts at this Offset.
const ConstantDataArray * Array
ConstantDataArray pointer.
bool isKnownNeverInfinity() const
Return true if it's known this can never be an infinity.
static constexpr FPClassTest OrderedLessThanZeroMask
LLVM_ABI bool isKnownNeverLogicalZero(DenormalMode Mode) const
Return true if it's known this can never be interpreted as a zero.
Matching combinators.