LLVM 23.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 return copyFlags(*CI, emitMalloc(CI->getArgOperand(1), B, DL, TLI));
1730
1731 return nullptr;
1732}
1733
1734// Optionally allow optimization of nobuiltin calls to operator new and its
1735// variants.
1736Value *LibCallSimplifier::maybeOptimizeNoBuiltinOperatorNew(CallInst *CI,
1737 IRBuilderBase &B) {
1738 if (!OptimizeHotColdNew)
1739 return nullptr;
1741 if (!Callee)
1742 return nullptr;
1743 LibFunc Func;
1744 if (!TLI->getLibFunc(*Callee, Func))
1745 return nullptr;
1746 switch (Func) {
1747 case LibFunc_Znwm:
1748 case LibFunc_ZnwmRKSt9nothrow_t:
1749 case LibFunc_ZnwmSt11align_val_t:
1750 case LibFunc_ZnwmSt11align_val_tRKSt9nothrow_t:
1751 case LibFunc_Znam:
1752 case LibFunc_ZnamRKSt9nothrow_t:
1753 case LibFunc_ZnamSt11align_val_t:
1754 case LibFunc_ZnamSt11align_val_tRKSt9nothrow_t:
1755 case LibFunc_size_returning_new:
1756 case LibFunc_size_returning_new_aligned:
1757 // By default normal operator new calls (not already passing a hot_cold_t
1758 // parameter) are not mutated if the call is not marked builtin. Optionally
1759 // enable that in cases where it is known to be safe.
1761 return nullptr;
1762 break;
1763 case LibFunc_Znwm12__hot_cold_t:
1764 case LibFunc_ZnwmRKSt9nothrow_t12__hot_cold_t:
1765 case LibFunc_ZnwmSt11align_val_t12__hot_cold_t:
1766 case LibFunc_ZnwmSt11align_val_tRKSt9nothrow_t12__hot_cold_t:
1767 case LibFunc_Znam12__hot_cold_t:
1768 case LibFunc_ZnamRKSt9nothrow_t12__hot_cold_t:
1769 case LibFunc_ZnamSt11align_val_t12__hot_cold_t:
1770 case LibFunc_ZnamSt11align_val_tRKSt9nothrow_t12__hot_cold_t:
1771 case LibFunc_size_returning_new_hot_cold:
1772 case LibFunc_size_returning_new_aligned_hot_cold:
1773 // If the nobuiltin call already passes a hot_cold_t parameter, allow update
1774 // of that parameter when enabled.
1776 return nullptr;
1777 break;
1778 default:
1779 return nullptr;
1780 }
1781 return optimizeNew(CI, B, Func);
1782}
1783
1784// When enabled, replace operator new() calls marked with a hot or cold memprof
1785// attribute with an operator new() call that takes a __hot_cold_t parameter.
1786// Currently this is supported by the open source version of tcmalloc, see:
1787// https://github.com/google/tcmalloc/blob/master/tcmalloc/new_extension.h
1788Value *LibCallSimplifier::optimizeNew(CallInst *CI, IRBuilderBase &B,
1789 LibFunc &Func) {
1790 if (!OptimizeHotColdNew)
1791 return nullptr;
1792
1793 uint8_t HotCold;
1794 if (CI->getAttributes().getFnAttr("memprof").getValueAsString() == "cold")
1795 HotCold = ColdNewHintValue;
1796 else if (CI->getAttributes().getFnAttr("memprof").getValueAsString() ==
1797 "notcold")
1798 HotCold = NotColdNewHintValue;
1799 else if (CI->getAttributes().getFnAttr("memprof").getValueAsString() == "hot")
1800 HotCold = HotNewHintValue;
1801 else if (CI->getAttributes().getFnAttr("memprof").getValueAsString() ==
1802 "ambiguous")
1803 HotCold = AmbiguousNewHintValue;
1804 else
1805 return nullptr;
1806
1807 // For calls that already pass a hot/cold hint, only update the hint if
1808 // directed by OptimizeExistingHotColdNew. For other calls to new, add a hint
1809 // if cold or hot, and leave as-is for default handling if "notcold" aka warm.
1810 // Note that in cases where we decide it is "notcold", it might be slightly
1811 // better to replace the hinted call with a non hinted call, to avoid the
1812 // extra parameter and the if condition check of the hint value in the
1813 // allocator. This can be considered in the future.
1814 Value *NewCall = nullptr;
1815 switch (Func) {
1816 case LibFunc_Znwm12__hot_cold_t:
1818 NewCall = emitHotColdNew(CI->getArgOperand(0), B, TLI,
1819 LibFunc_Znwm12__hot_cold_t, HotCold);
1820 break;
1821 case LibFunc_Znwm:
1822 NewCall = emitHotColdNew(CI->getArgOperand(0), B, TLI,
1823 LibFunc_Znwm12__hot_cold_t, HotCold);
1824 break;
1825 case LibFunc_Znam12__hot_cold_t:
1827 NewCall = emitHotColdNew(CI->getArgOperand(0), B, TLI,
1828 LibFunc_Znam12__hot_cold_t, HotCold);
1829 break;
1830 case LibFunc_Znam:
1831 NewCall = emitHotColdNew(CI->getArgOperand(0), B, TLI,
1832 LibFunc_Znam12__hot_cold_t, HotCold);
1833 break;
1834 case LibFunc_ZnwmRKSt9nothrow_t12__hot_cold_t:
1836 NewCall = emitHotColdNewNoThrow(
1837 CI->getArgOperand(0), CI->getArgOperand(1), B, TLI,
1838 LibFunc_ZnwmRKSt9nothrow_t12__hot_cold_t, HotCold);
1839 break;
1840 case LibFunc_ZnwmRKSt9nothrow_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_ZnamRKSt9nothrow_t12__hot_cold_t:
1847 NewCall = emitHotColdNewNoThrow(
1848 CI->getArgOperand(0), CI->getArgOperand(1), B, TLI,
1849 LibFunc_ZnamRKSt9nothrow_t12__hot_cold_t, HotCold);
1850 break;
1851 case LibFunc_ZnamRKSt9nothrow_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_ZnwmSt11align_val_t12__hot_cold_t:
1858 NewCall = emitHotColdNewAligned(
1859 CI->getArgOperand(0), CI->getArgOperand(1), B, TLI,
1860 LibFunc_ZnwmSt11align_val_t12__hot_cold_t, HotCold);
1861 break;
1862 case LibFunc_ZnwmSt11align_val_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_ZnamSt11align_val_t12__hot_cold_t:
1869 NewCall = emitHotColdNewAligned(
1870 CI->getArgOperand(0), CI->getArgOperand(1), B, TLI,
1871 LibFunc_ZnamSt11align_val_t12__hot_cold_t, HotCold);
1872 break;
1873 case LibFunc_ZnamSt11align_val_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_ZnwmSt11align_val_tRKSt9nothrow_t12__hot_cold_t:
1881 CI->getArgOperand(0), CI->getArgOperand(1), CI->getArgOperand(2), B,
1882 TLI, LibFunc_ZnwmSt11align_val_tRKSt9nothrow_t12__hot_cold_t,
1883 HotCold);
1884 break;
1885 case LibFunc_ZnwmSt11align_val_tRKSt9nothrow_t:
1887 CI->getArgOperand(0), CI->getArgOperand(1), CI->getArgOperand(2), B,
1888 TLI, LibFunc_ZnwmSt11align_val_tRKSt9nothrow_t12__hot_cold_t, HotCold);
1889 break;
1890 case LibFunc_ZnamSt11align_val_tRKSt9nothrow_t12__hot_cold_t:
1893 CI->getArgOperand(0), CI->getArgOperand(1), CI->getArgOperand(2), B,
1894 TLI, LibFunc_ZnamSt11align_val_tRKSt9nothrow_t12__hot_cold_t,
1895 HotCold);
1896 break;
1897 case LibFunc_ZnamSt11align_val_tRKSt9nothrow_t:
1899 CI->getArgOperand(0), CI->getArgOperand(1), CI->getArgOperand(2), B,
1900 TLI, LibFunc_ZnamSt11align_val_tRKSt9nothrow_t12__hot_cold_t, HotCold);
1901 break;
1902 case LibFunc_size_returning_new:
1903 NewCall = emitHotColdSizeReturningNew(CI->getArgOperand(0), B, TLI,
1904 LibFunc_size_returning_new_hot_cold,
1905 HotCold);
1906 break;
1907 case LibFunc_size_returning_new_hot_cold:
1909 NewCall = emitHotColdSizeReturningNew(CI->getArgOperand(0), B, TLI,
1910 LibFunc_size_returning_new_hot_cold,
1911 HotCold);
1912 break;
1913 case LibFunc_size_returning_new_aligned:
1915 CI->getArgOperand(0), CI->getArgOperand(1), B, TLI,
1916 LibFunc_size_returning_new_aligned_hot_cold, HotCold);
1917 break;
1918 case LibFunc_size_returning_new_aligned_hot_cold:
1921 CI->getArgOperand(0), CI->getArgOperand(1), B, TLI,
1922 LibFunc_size_returning_new_aligned_hot_cold, HotCold);
1923 break;
1924 default:
1925 return nullptr;
1926 }
1927
1928 if (auto *NewCI = dyn_cast_or_null<Instruction>(NewCall))
1929 NewCI->copyMetadata(*CI);
1930
1931 return NewCall;
1932}
1933
1934//===----------------------------------------------------------------------===//
1935// Math Library Optimizations
1936//===----------------------------------------------------------------------===//
1937
1938// Replace a libcall \p CI with a call to intrinsic \p IID
1940 Intrinsic::ID IID) {
1941 Value *NewCall = B.CreateUnaryIntrinsic(IID, CI->getArgOperand(0), CI);
1942 NewCall->takeName(CI);
1943 return copyFlags(*CI, NewCall);
1944}
1945
1947 Intrinsic::ID IID) {
1948 Value *NewCall = B.CreateBinaryIntrinsic(IID, CI->getArgOperand(0),
1949 CI->getArgOperand(1), CI);
1950 NewCall->takeName(CI);
1951 return copyFlags(*CI, NewCall);
1952}
1953
1954/// Return a variant of Val with float type.
1955/// Currently this works in two cases: If Val is an FPExtension of a float
1956/// value to something bigger, simply return the operand.
1957/// If Val is a ConstantFP but can be converted to a float ConstantFP without
1958/// loss of precision do so.
1960 if (FPExtInst *Cast = dyn_cast<FPExtInst>(Val)) {
1961 Value *Op = Cast->getOperand(0);
1962 if (Op->getType()->isFloatTy())
1963 return Op;
1964 }
1965 if (ConstantFP *Const = dyn_cast<ConstantFP>(Val)) {
1966 APFloat F = Const->getValueAPF();
1967 bool losesInfo;
1969 &losesInfo);
1970 if (!losesInfo)
1971 return ConstantFP::get(Const->getContext(), F);
1972 }
1973 return nullptr;
1974}
1975
1976/// Shrink double -> float functions.
1978 bool isBinary, const TargetLibraryInfo *TLI,
1979 bool isPrecise = false) {
1980 Function *CalleeFn = CI->getCalledFunction();
1981 if (!CI->getType()->isDoubleTy() || !CalleeFn)
1982 return nullptr;
1983
1984 // If not all the uses of the function are converted to float, then bail out.
1985 // This matters if the precision of the result is more important than the
1986 // precision of the arguments.
1987 if (isPrecise)
1988 for (User *U : CI->users()) {
1990 if (!Cast || !Cast->getType()->isFloatTy())
1991 return nullptr;
1992 }
1993
1994 // If this is something like 'g((double) float)', convert to 'gf(float)'.
1995 Value *V[2];
1997 V[1] = isBinary ? valueHasFloatPrecision(CI->getArgOperand(1)) : nullptr;
1998 if (!V[0] || (isBinary && !V[1]))
1999 return nullptr;
2000
2001 // If call isn't an intrinsic, check that it isn't within a function with the
2002 // same name as the float version of this call, otherwise the result is an
2003 // infinite loop. For example, from MinGW-w64:
2004 //
2005 // float expf(float val) { return (float) exp((double) val); }
2006 StringRef CalleeName = CalleeFn->getName();
2007 bool IsIntrinsic = CalleeFn->isIntrinsic();
2008 if (!IsIntrinsic) {
2009 StringRef CallerName = CI->getFunction()->getName();
2010 if (CallerName.ends_with('f') &&
2011 CallerName.size() == (CalleeName.size() + 1) &&
2012 CallerName.starts_with(CalleeName))
2013 return nullptr;
2014 }
2015
2016 // Propagate the math semantics from the current function to the new function.
2018 B.setFastMathFlags(CI->getFastMathFlags());
2019
2020 // g((double) float) -> (double) gf(float)
2021 Value *R;
2022 if (IsIntrinsic) {
2023 Intrinsic::ID IID = CalleeFn->getIntrinsicID();
2024 R = isBinary ? B.CreateIntrinsic(IID, B.getFloatTy(), V)
2025 : B.CreateIntrinsic(IID, B.getFloatTy(), V[0]);
2026 } else {
2027 AttributeList CallsiteAttrs = CI->getAttributes();
2028 R = isBinary
2029 ? emitBinaryFloatFnCall(V[0], V[1], TLI, CalleeName, B,
2030 CallsiteAttrs)
2031 : emitUnaryFloatFnCall(V[0], TLI, CalleeName, B, CallsiteAttrs);
2032 }
2033 return B.CreateFPExt(R, B.getDoubleTy());
2034}
2035
2036/// Shrink double -> float for unary functions.
2038 const TargetLibraryInfo *TLI,
2039 bool isPrecise = false) {
2040 return optimizeDoubleFP(CI, B, false, TLI, isPrecise);
2041}
2042
2043/// Shrink double -> float for binary functions.
2045 const TargetLibraryInfo *TLI,
2046 bool isPrecise = false) {
2047 return optimizeDoubleFP(CI, B, true, TLI, isPrecise);
2048}
2049
2050// cabs(z) -> sqrt((creal(z)*creal(z)) + (cimag(z)*cimag(z)))
2051Value *LibCallSimplifier::optimizeCAbs(CallInst *CI, IRBuilderBase &B) {
2052 Value *Real, *Imag;
2053
2054 if (CI->arg_size() == 1) {
2055
2056 if (!CI->isFast())
2057 return nullptr;
2058
2059 Value *Op = CI->getArgOperand(0);
2060 assert(Op->getType()->isArrayTy() && "Unexpected signature for cabs!");
2061
2062 Real = B.CreateExtractValue(Op, 0, "real");
2063 Imag = B.CreateExtractValue(Op, 1, "imag");
2064
2065 } else {
2066 assert(CI->arg_size() == 2 && "Unexpected signature for cabs!");
2067
2068 Real = CI->getArgOperand(0);
2069 Imag = CI->getArgOperand(1);
2070
2071 // if real or imaginary part is zero, simplify to abs(cimag(z))
2072 // or abs(creal(z))
2073 Value *AbsOp = nullptr;
2074 if (ConstantFP *ConstReal = dyn_cast<ConstantFP>(Real)) {
2075 if (ConstReal->isZero())
2076 AbsOp = Imag;
2077
2078 } else if (ConstantFP *ConstImag = dyn_cast<ConstantFP>(Imag)) {
2079 if (ConstImag->isZero())
2080 AbsOp = Real;
2081 }
2082
2083 if (AbsOp)
2084 return copyFlags(*CI, B.CreateFAbs(AbsOp, CI, "cabs"));
2085
2086 if (!CI->isFast())
2087 return nullptr;
2088 }
2089
2090 // Propagate fast-math flags from the existing call to new instructions.
2091 Value *RealReal = B.CreateFMulFMF(Real, Real, CI);
2092 Value *ImagImag = B.CreateFMulFMF(Imag, Imag, CI);
2093 return copyFlags(
2094 *CI, B.CreateUnaryIntrinsic(Intrinsic::sqrt,
2095 B.CreateFAddFMF(RealReal, ImagImag, CI), CI,
2096 "cabs"));
2097}
2098
2099// Return a properly extended integer (DstWidth bits wide) if the operation is
2100// an itofp.
2101static Value *getIntToFPVal(Value *I2F, IRBuilderBase &B, unsigned DstWidth) {
2102 if (isa<SIToFPInst>(I2F) || isa<UIToFPInst>(I2F)) {
2103 Value *Op = cast<Instruction>(I2F)->getOperand(0);
2104 // Make sure that the exponent fits inside an "int" of size DstWidth,
2105 // thus avoiding any range issues that FP has not.
2106 unsigned BitWidth = Op->getType()->getScalarSizeInBits();
2107 if (BitWidth < DstWidth || (BitWidth == DstWidth && isa<SIToFPInst>(I2F))) {
2108 Type *IntTy = Op->getType()->getWithNewBitWidth(DstWidth);
2109 return isa<SIToFPInst>(I2F) ? B.CreateSExt(Op, IntTy)
2110 : B.CreateZExt(Op, IntTy);
2111 }
2112 }
2113
2114 return nullptr;
2115}
2116
2117/// Use exp{,2}(x * y) for pow(exp{,2}(x), y);
2118/// ldexp(1.0, x) for pow(2.0, itofp(x)); exp2(n * x) for pow(2.0 ** n, x);
2119/// exp10(x) for pow(10.0, x); exp2(log2(n) * x) for pow(n, x).
2120Value *LibCallSimplifier::replacePowWithExp(CallInst *Pow, IRBuilderBase &B) {
2121 Module *M = Pow->getModule();
2122 Value *Base = Pow->getArgOperand(0), *Expo = Pow->getArgOperand(1);
2123 Type *Ty = Pow->getType();
2124 bool Ignored;
2125
2126 // Evaluate special cases related to a nested function as the base.
2127
2128 // pow(exp(x), y) -> exp(x * y)
2129 // pow(exp2(x), y) -> exp2(x * y)
2130 // If exp{,2}() is used only once, it is better to fold two transcendental
2131 // math functions into one. If used again, exp{,2}() would still have to be
2132 // called with the original argument, then keep both original transcendental
2133 // functions. However, this transformation is only safe with fully relaxed
2134 // math semantics, since, besides rounding differences, it changes overflow
2135 // and underflow behavior quite dramatically. For example:
2136 // pow(exp(1000), 0.001) = pow(inf, 0.001) = inf
2137 // Whereas:
2138 // exp(1000 * 0.001) = exp(1)
2139 // TODO: Loosen the requirement for fully relaxed math semantics.
2140 // TODO: Handle exp10() when more targets have it available.
2141 CallInst *BaseFn = dyn_cast<CallInst>(Base);
2142 if (BaseFn && BaseFn->hasOneUse() && BaseFn->isFast() && Pow->isFast()) {
2143 LibFunc LibFn;
2144
2145 Function *CalleeFn = BaseFn->getCalledFunction();
2146 if (CalleeFn && TLI->getLibFunc(CalleeFn->getName(), LibFn) &&
2147 isLibFuncEmittable(M, TLI, LibFn)) {
2148 StringRef ExpName;
2150 Value *ExpFn;
2151 LibFunc LibFnFloat, LibFnDouble, LibFnLongDouble;
2152
2153 switch (LibFn) {
2154 default:
2155 return nullptr;
2156 case LibFunc_expf:
2157 case LibFunc_exp:
2158 case LibFunc_expl:
2159 ExpName = TLI->getName(LibFunc_exp);
2160 ID = Intrinsic::exp;
2161 LibFnFloat = LibFunc_expf;
2162 LibFnDouble = LibFunc_exp;
2163 LibFnLongDouble = LibFunc_expl;
2164 break;
2165 case LibFunc_exp2f:
2166 case LibFunc_exp2:
2167 case LibFunc_exp2l:
2168 ExpName = TLI->getName(LibFunc_exp2);
2169 ID = Intrinsic::exp2;
2170 LibFnFloat = LibFunc_exp2f;
2171 LibFnDouble = LibFunc_exp2;
2172 LibFnLongDouble = LibFunc_exp2l;
2173 break;
2174 }
2175
2176 // Create new exp{,2}() with the product as its argument.
2177 Value *FMul = B.CreateFMul(BaseFn->getArgOperand(0), Expo, "mul");
2178 ExpFn = BaseFn->doesNotAccessMemory()
2179 ? B.CreateUnaryIntrinsic(ID, FMul, nullptr, ExpName)
2180 : emitUnaryFloatFnCall(FMul, TLI, LibFnDouble, LibFnFloat,
2181 LibFnLongDouble, B,
2182 BaseFn->getAttributes());
2183
2184 // Since the new exp{,2}() is different from the original one, dead code
2185 // elimination cannot be trusted to remove it, since it may have side
2186 // effects (e.g., errno). When the only consumer for the original
2187 // exp{,2}() is pow(), then it has to be explicitly erased.
2188 substituteInParent(BaseFn, ExpFn);
2189 return ExpFn;
2190 }
2191 }
2192
2193 // Evaluate special cases related to a constant base.
2194
2195 const APFloat *BaseF;
2196 if (!match(Base, m_APFloat(BaseF)))
2197 return nullptr;
2198
2199 AttributeList NoAttrs; // Attributes are only meaningful on the original call
2200
2201 const bool UseIntrinsic = Pow->doesNotAccessMemory();
2202
2203 // pow(2.0, itofp(x)) -> ldexp(1.0, x)
2204 if ((UseIntrinsic || !Ty->isVectorTy()) && BaseF->isExactlyValue(2.0) &&
2205 (isa<SIToFPInst>(Expo) || isa<UIToFPInst>(Expo)) &&
2206 (UseIntrinsic ||
2207 hasFloatFn(M, TLI, Ty, LibFunc_ldexp, LibFunc_ldexpf, LibFunc_ldexpl))) {
2208
2209 // TODO: Shouldn't really need to depend on getIntToFPVal for intrinsic. Can
2210 // just directly use the original integer type.
2211 if (Value *ExpoI = getIntToFPVal(Expo, B, TLI->getIntSize())) {
2212 Constant *One = ConstantFP::get(Ty, 1.0);
2213
2214 if (UseIntrinsic) {
2215 return copyFlags(*Pow, B.CreateIntrinsic(Intrinsic::ldexp,
2216 {Ty, ExpoI->getType()},
2217 {One, ExpoI}, Pow, "exp2"));
2218 }
2219
2221 One, ExpoI, TLI, LibFunc_ldexp, LibFunc_ldexpf,
2222 LibFunc_ldexpl, B, NoAttrs));
2223 }
2224 }
2225
2226 // pow(2.0 ** n, x) -> exp2(n * x)
2227 if (hasFloatFn(M, TLI, Ty, LibFunc_exp2, LibFunc_exp2f, LibFunc_exp2l)) {
2228 APFloat BaseR = APFloat(1.0);
2229 BaseR.convert(BaseF->getSemantics(), APFloat::rmTowardZero, &Ignored);
2230 BaseR = BaseR / *BaseF;
2231 bool IsInteger = BaseF->isInteger(), IsReciprocal = BaseR.isInteger();
2232 const APFloat *NF = IsReciprocal ? &BaseR : BaseF;
2233 APSInt NI(64, false);
2234 if ((IsInteger || IsReciprocal) &&
2235 NF->convertToInteger(NI, APFloat::rmTowardZero, &Ignored) ==
2236 APFloat::opOK &&
2237 NI > 1 && NI.isPowerOf2()) {
2238 double N = NI.logBase2() * (IsReciprocal ? -1.0 : 1.0);
2239 Value *FMul = B.CreateFMul(Expo, ConstantFP::get(Ty, N), "mul");
2240 if (Pow->doesNotAccessMemory())
2241 return copyFlags(*Pow, B.CreateUnaryIntrinsic(Intrinsic::exp2, FMul,
2242 nullptr, "exp2"));
2243 else
2244 return copyFlags(*Pow, emitUnaryFloatFnCall(FMul, TLI, LibFunc_exp2,
2245 LibFunc_exp2f,
2246 LibFunc_exp2l, B, NoAttrs));
2247 }
2248 }
2249
2250 // pow(10.0, x) -> exp10(x)
2251 if (BaseF->isExactlyValue(10.0) &&
2252 hasFloatFn(M, TLI, Ty, LibFunc_exp10, LibFunc_exp10f, LibFunc_exp10l)) {
2253
2254 if (Pow->doesNotAccessMemory()) {
2255 return B.CreateIntrinsic(Intrinsic::exp10, {Ty}, {Expo}, Pow, "exp10", {},
2256 [Pow](CallInst *CI) { CI->copyIRFlags(Pow); });
2257 }
2258
2259 return copyFlags(*Pow, emitUnaryFloatFnCall(Expo, TLI, LibFunc_exp10,
2260 LibFunc_exp10f, LibFunc_exp10l,
2261 B, NoAttrs));
2262 }
2263
2264 // pow(x, y) -> exp2(log2(x) * y)
2265 if (Pow->hasApproxFunc() && Pow->hasNoNaNs() && BaseF->isFiniteNonZero() &&
2266 !BaseF->isNegative()) {
2267 // pow(1, inf) is defined to be 1 but exp2(log2(1) * inf) evaluates to NaN.
2268 // Luckily optimizePow has already handled the x == 1 case.
2269 assert(!match(Base, m_FPOne()) &&
2270 "pow(1.0, y) should have been simplified earlier!");
2271
2272 Value *Log = nullptr;
2273 if (Ty->isFloatTy())
2274 Log = ConstantFP::get(Ty, std::log2(BaseF->convertToFloat()));
2275 else if (Ty->isDoubleTy())
2276 Log = ConstantFP::get(Ty, std::log2(BaseF->convertToDouble()));
2277
2278 if (Log) {
2279 Value *FMul = B.CreateFMul(Log, Expo, "mul");
2280 if (Pow->doesNotAccessMemory())
2281 return copyFlags(*Pow, B.CreateUnaryIntrinsic(Intrinsic::exp2, FMul,
2282 nullptr, "exp2"));
2283 else if (hasFloatFn(M, TLI, Ty, LibFunc_exp2, LibFunc_exp2f,
2284 LibFunc_exp2l))
2285 return copyFlags(*Pow, emitUnaryFloatFnCall(FMul, TLI, LibFunc_exp2,
2286 LibFunc_exp2f,
2287 LibFunc_exp2l, B, NoAttrs));
2288 }
2289 }
2290
2291 return nullptr;
2292}
2293
2294static Value *getSqrtCall(Value *V, AttributeList Attrs, bool NoErrno,
2295 Module *M, IRBuilderBase &B,
2296 const TargetLibraryInfo *TLI) {
2297 // If errno is never set, then use the intrinsic for sqrt().
2298 if (NoErrno)
2299 return B.CreateUnaryIntrinsic(Intrinsic::sqrt, V, nullptr, "sqrt");
2300
2301 // Otherwise, use the libcall for sqrt().
2302 if (hasFloatFn(M, TLI, V->getType(), LibFunc_sqrt, LibFunc_sqrtf,
2303 LibFunc_sqrtl))
2304 // TODO: We also should check that the target can in fact lower the sqrt()
2305 // libcall. We currently have no way to ask this question, so we ask if
2306 // the target has a sqrt() libcall, which is not exactly the same.
2307 return emitUnaryFloatFnCall(V, TLI, LibFunc_sqrt, LibFunc_sqrtf,
2308 LibFunc_sqrtl, B, Attrs);
2309
2310 return nullptr;
2311}
2312
2313/// Use square root in place of pow(x, +/-0.5).
2314Value *LibCallSimplifier::replacePowWithSqrt(CallInst *Pow, IRBuilderBase &B) {
2315 Value *Sqrt, *Base = Pow->getArgOperand(0), *Expo = Pow->getArgOperand(1);
2316 Module *Mod = Pow->getModule();
2317 Type *Ty = Pow->getType();
2318
2319 const APFloat *ExpoF;
2320 if (!match(Expo, m_APFloat(ExpoF)) ||
2321 (!ExpoF->isExactlyValue(0.5) && !ExpoF->isExactlyValue(-0.5)))
2322 return nullptr;
2323
2324 // Converting pow(X, -0.5) to 1/sqrt(X) may introduce an extra rounding step,
2325 // so that requires fast-math-flags (afn or reassoc).
2326 if (ExpoF->isNegative() && (!Pow->hasApproxFunc() && !Pow->hasAllowReassoc()))
2327 return nullptr;
2328
2329 // If we have a pow() library call (accesses memory) and we can't guarantee
2330 // that the base is not an infinity, give up:
2331 // pow(-Inf, 0.5) is optionally required to have a result of +Inf (not setting
2332 // errno), but sqrt(-Inf) is required by various standards to set errno.
2333 if (!Pow->doesNotAccessMemory() && !Pow->hasNoInfs() &&
2335 Base, SimplifyQuery(DL, TLI, DT, AC, Pow, true, true, DC)))
2336 return nullptr;
2337
2338 Sqrt = getSqrtCall(Base, AttributeList(), Pow->doesNotAccessMemory(), Mod, B,
2339 TLI);
2340 if (!Sqrt)
2341 return nullptr;
2342
2343 // Handle signed zero base by expanding to fabs(sqrt(x)).
2344 if (!Pow->hasNoSignedZeros())
2345 Sqrt = B.CreateFAbs(Sqrt, nullptr, "abs");
2346
2347 Sqrt = copyFlags(*Pow, Sqrt);
2348
2349 // Handle non finite base by expanding to
2350 // (x == -infinity ? +infinity : sqrt(x)).
2351 if (!Pow->hasNoInfs()) {
2352 Value *PosInf = ConstantFP::getInfinity(Ty),
2353 *NegInf = ConstantFP::getInfinity(Ty, true);
2354 Value *FCmp = B.CreateFCmpOEQ(Base, NegInf, "isinf");
2355 Sqrt = B.CreateSelect(FCmp, PosInf, Sqrt);
2356 }
2357
2358 // If the exponent is negative, then get the reciprocal.
2359 if (ExpoF->isNegative())
2360 Sqrt = B.CreateFDiv(ConstantFP::get(Ty, 1.0), Sqrt, "reciprocal");
2361
2362 return Sqrt;
2363}
2364
2366 IRBuilderBase &B) {
2367 Value *Args[] = {Base, Expo};
2368 Type *Types[] = {Base->getType(), Expo->getType()};
2369 return B.CreateIntrinsic(Intrinsic::powi, Types, Args);
2370}
2371
2372Value *LibCallSimplifier::optimizePow(CallInst *Pow, IRBuilderBase &B) {
2373 Value *Base = Pow->getArgOperand(0);
2374 Value *Expo = Pow->getArgOperand(1);
2375 Function *Callee = Pow->getCalledFunction();
2376 StringRef Name = Callee->getName();
2377 Type *Ty = Pow->getType();
2378 Module *M = Pow->getModule();
2379 bool AllowApprox = Pow->hasApproxFunc();
2380 bool Ignored;
2381
2382 // Propagate the math semantics from the call to any created instructions.
2383 IRBuilderBase::FastMathFlagGuard Guard(B);
2384 B.setFastMathFlags(Pow->getFastMathFlags());
2385 // Evaluate special cases related to the base.
2386
2387 // pow(1.0, x) -> 1.0
2388 if (match(Base, m_FPOne()))
2389 return Base;
2390
2391 if (Value *Exp = replacePowWithExp(Pow, B))
2392 return Exp;
2393
2394 // Evaluate special cases related to the exponent.
2395
2396 // pow(x, -1.0) -> 1.0 / x
2397 if (match(Expo, m_SpecificFP(-1.0)))
2398 return B.CreateFDiv(ConstantFP::get(Ty, 1.0), Base, "reciprocal");
2399
2400 // pow(x, +/-0.0) -> 1.0
2401 if (match(Expo, m_AnyZeroFP()))
2402 return ConstantFP::get(Ty, 1.0);
2403
2404 // pow(x, 1.0) -> x
2405 if (match(Expo, m_FPOne()))
2406 return Base;
2407
2408 // pow(x, 2.0) -> x * x
2409 if (match(Expo, m_SpecificFP(2.0)) && Pow->doesNotAccessMemory())
2410 return B.CreateFMul(Base, Base, "square");
2411
2412 if (Value *Sqrt = replacePowWithSqrt(Pow, B))
2413 return Sqrt;
2414
2415 // If we can approximate pow:
2416 // pow(x, n) -> powi(x, n) * sqrt(x) if n has exactly a 0.5 fraction
2417 // pow(x, n) -> powi(x, n) if n is a constant signed integer value
2418 const APFloat *ExpoF;
2419 if (AllowApprox && match(Expo, m_APFloat(ExpoF)) &&
2420 !ExpoF->isExactlyValue(0.5) && !ExpoF->isExactlyValue(-0.5)) {
2421 APFloat ExpoA(abs(*ExpoF));
2422 APFloat ExpoI(*ExpoF);
2423 Value *Sqrt = nullptr;
2424 if (!ExpoA.isInteger()) {
2425 APFloat Expo2 = ExpoA;
2426 // To check if ExpoA is an integer + 0.5, we add it to itself. If there
2427 // is no floating point exception and the result is an integer, then
2428 // ExpoA == integer + 0.5
2429 if (Expo2.add(ExpoA, APFloat::rmNearestTiesToEven) != APFloat::opOK)
2430 return nullptr;
2431
2432 if (!Expo2.isInteger())
2433 return nullptr;
2434
2435 if (ExpoI.roundToIntegral(APFloat::rmTowardNegative) !=
2437 return nullptr;
2438 if (!ExpoI.isInteger())
2439 return nullptr;
2440 ExpoF = &ExpoI;
2441
2442 Sqrt = getSqrtCall(Base, AttributeList(), Pow->doesNotAccessMemory(), M,
2443 B, TLI);
2444 if (!Sqrt)
2445 return nullptr;
2446 }
2447
2448 // 0.5 fraction is now optionally handled.
2449 // Do pow -> powi for remaining integer exponent
2450 APSInt IntExpo(TLI->getIntSize(), /*isUnsigned=*/false);
2451 if (ExpoF->isInteger() &&
2452 ExpoF->convertToInteger(IntExpo, APFloat::rmTowardZero, &Ignored) ==
2453 APFloat::opOK) {
2454 Value *PowI = copyFlags(
2455 *Pow,
2457 Base, ConstantInt::get(B.getIntNTy(TLI->getIntSize()), IntExpo),
2458 M, B));
2459
2460 if (PowI && Sqrt)
2461 return B.CreateFMul(PowI, Sqrt);
2462
2463 return PowI;
2464 }
2465 }
2466
2467 // powf(x, itofp(y)) -> powi(x, y)
2468 if (AllowApprox && (isa<SIToFPInst>(Expo) || isa<UIToFPInst>(Expo))) {
2469 if (Value *ExpoI = getIntToFPVal(Expo, B, TLI->getIntSize()))
2470 return copyFlags(*Pow, createPowWithIntegerExponent(Base, ExpoI, M, B));
2471 }
2472
2473 // Shrink pow() to powf() if the arguments are single precision,
2474 // unless the result is expected to be double precision.
2475 if (UnsafeFPShrink && Name == TLI->getName(LibFunc_pow) &&
2476 hasFloatVersion(M, Name)) {
2477 if (Value *Shrunk = optimizeBinaryDoubleFP(Pow, B, TLI, true))
2478 return Shrunk;
2479 }
2480
2481 return nullptr;
2482}
2483
2484Value *LibCallSimplifier::optimizeExp2(CallInst *CI, IRBuilderBase &B) {
2485 Module *M = CI->getModule();
2487 StringRef Name = Callee->getName();
2488 Value *Ret = nullptr;
2489 if (UnsafeFPShrink && Name == TLI->getName(LibFunc_exp2) &&
2490 hasFloatVersion(M, Name))
2491 Ret = optimizeUnaryDoubleFP(CI, B, TLI, true);
2492
2493 // If we have an llvm.exp2 intrinsic, emit the llvm.ldexp intrinsic. If we
2494 // have the libcall, emit the libcall.
2495 //
2496 // TODO: In principle we should be able to just always use the intrinsic for
2497 // any doesNotAccessMemory callsite.
2498
2499 const bool UseIntrinsic = Callee->isIntrinsic();
2500 // Bail out for vectors because the code below only expects scalars.
2501 Type *Ty = CI->getType();
2502 if (!UseIntrinsic && Ty->isVectorTy())
2503 return Ret;
2504
2505 // exp2(sitofp(x)) -> ldexp(1.0, sext(x)) if sizeof(x) <= IntSize
2506 // exp2(uitofp(x)) -> ldexp(1.0, zext(x)) if sizeof(x) < IntSize
2507 Value *Op = CI->getArgOperand(0);
2508 if ((isa<SIToFPInst>(Op) || isa<UIToFPInst>(Op)) &&
2509 (UseIntrinsic ||
2510 hasFloatFn(M, TLI, Ty, LibFunc_ldexp, LibFunc_ldexpf, LibFunc_ldexpl))) {
2511 if (Value *Exp = getIntToFPVal(Op, B, TLI->getIntSize())) {
2512 Constant *One = ConstantFP::get(Ty, 1.0);
2513
2514 if (UseIntrinsic) {
2515 return copyFlags(*CI, B.CreateIntrinsic(Intrinsic::ldexp,
2516 {Ty, Exp->getType()},
2517 {One, Exp}, CI));
2518 }
2519
2520 IRBuilderBase::FastMathFlagGuard Guard(B);
2521 B.setFastMathFlags(CI->getFastMathFlags());
2522 return copyFlags(*CI, emitBinaryFloatFnCall(
2523 One, Exp, TLI, LibFunc_ldexp, LibFunc_ldexpf,
2524 LibFunc_ldexpl, B, AttributeList()));
2525 }
2526 }
2527
2528 return Ret;
2529}
2530
2531Value *LibCallSimplifier::optimizeFMinFMax(CallInst *CI, IRBuilderBase &B,
2532 Intrinsic::ID IID) {
2533 // The LLVM intrinsics minnum/maxnum correspond to fmin/fmax. Canonicalize to
2534 // the intrinsics for improved optimization (for example, vectorization).
2535 // No-signed-zeros is implied by the definitions of fmax/fmin themselves.
2536 // From the C standard draft WG14/N1256:
2537 // "Ideally, fmax would be sensitive to the sign of zero, for example
2538 // fmax(-0.0, +0.0) would return +0; however, implementation in software
2539 // might be impractical."
2540 FastMathFlags FMF = CI->getFastMathFlags();
2541 FMF.setNoSignedZeros();
2542 return copyFlags(*CI, B.CreateBinaryIntrinsic(IID, CI->getArgOperand(0),
2543 CI->getArgOperand(1), FMF));
2544}
2545
2546Value *LibCallSimplifier::optimizeLog(CallInst *Log, IRBuilderBase &B) {
2547 Function *LogFn = Log->getCalledFunction();
2548 StringRef LogNm = LogFn->getName();
2549 Intrinsic::ID LogID = LogFn->getIntrinsicID();
2550 Module *Mod = Log->getModule();
2551 Type *Ty = Log->getType();
2552
2553 if (UnsafeFPShrink && hasFloatVersion(Mod, LogNm))
2554 if (Value *Ret = optimizeUnaryDoubleFP(Log, B, TLI, true))
2555 return Ret;
2556
2557 LibFunc LogLb, ExpLb, Exp2Lb, Exp10Lb, PowLb;
2558
2559 // This is only applicable to log(), log2(), log10().
2560 if (TLI->getLibFunc(LogNm, LogLb)) {
2561 switch (LogLb) {
2562 case LibFunc_logf:
2563 LogID = Intrinsic::log;
2564 ExpLb = LibFunc_expf;
2565 Exp2Lb = LibFunc_exp2f;
2566 Exp10Lb = LibFunc_exp10f;
2567 PowLb = LibFunc_powf;
2568 break;
2569 case LibFunc_log:
2570 LogID = Intrinsic::log;
2571 ExpLb = LibFunc_exp;
2572 Exp2Lb = LibFunc_exp2;
2573 Exp10Lb = LibFunc_exp10;
2574 PowLb = LibFunc_pow;
2575 break;
2576 case LibFunc_logl:
2577 LogID = Intrinsic::log;
2578 ExpLb = LibFunc_expl;
2579 Exp2Lb = LibFunc_exp2l;
2580 Exp10Lb = LibFunc_exp10l;
2581 PowLb = LibFunc_powl;
2582 break;
2583 case LibFunc_log2f:
2584 LogID = Intrinsic::log2;
2585 ExpLb = LibFunc_expf;
2586 Exp2Lb = LibFunc_exp2f;
2587 Exp10Lb = LibFunc_exp10f;
2588 PowLb = LibFunc_powf;
2589 break;
2590 case LibFunc_log2:
2591 LogID = Intrinsic::log2;
2592 ExpLb = LibFunc_exp;
2593 Exp2Lb = LibFunc_exp2;
2594 Exp10Lb = LibFunc_exp10;
2595 PowLb = LibFunc_pow;
2596 break;
2597 case LibFunc_log2l:
2598 LogID = Intrinsic::log2;
2599 ExpLb = LibFunc_expl;
2600 Exp2Lb = LibFunc_exp2l;
2601 Exp10Lb = LibFunc_exp10l;
2602 PowLb = LibFunc_powl;
2603 break;
2604 case LibFunc_log10f:
2605 LogID = Intrinsic::log10;
2606 ExpLb = LibFunc_expf;
2607 Exp2Lb = LibFunc_exp2f;
2608 Exp10Lb = LibFunc_exp10f;
2609 PowLb = LibFunc_powf;
2610 break;
2611 case LibFunc_log10:
2612 LogID = Intrinsic::log10;
2613 ExpLb = LibFunc_exp;
2614 Exp2Lb = LibFunc_exp2;
2615 Exp10Lb = LibFunc_exp10;
2616 PowLb = LibFunc_pow;
2617 break;
2618 case LibFunc_log10l:
2619 LogID = Intrinsic::log10;
2620 ExpLb = LibFunc_expl;
2621 Exp2Lb = LibFunc_exp2l;
2622 Exp10Lb = LibFunc_exp10l;
2623 PowLb = LibFunc_powl;
2624 break;
2625 default:
2626 return nullptr;
2627 }
2628
2629 // Convert libcall to intrinsic if the value is known > 0.
2630 bool IsKnownNoErrno = Log->hasNoNaNs() && Log->hasNoInfs();
2631 if (!IsKnownNoErrno) {
2632 SimplifyQuery SQ(DL, TLI, DT, AC, Log, true, true, DC);
2633 KnownFPClass Known = computeKnownFPClass(
2634 Log->getOperand(0),
2636 Function *F = Log->getParent()->getParent();
2637 const fltSemantics &FltSem = Ty->getScalarType()->getFltSemantics();
2638 IsKnownNoErrno =
2639 Known.cannotBeOrderedLessThanZero() &&
2640 Known.isKnownNeverLogicalZero(F->getDenormalMode(FltSem));
2641 }
2642 if (IsKnownNoErrno) {
2643 Value *NewLog = B.CreateUnaryIntrinsic(LogID, Log->getArgOperand(0), Log);
2644 if (auto *I = dyn_cast<Instruction>(NewLog)) {
2645 I->copyMetadata(*Log);
2646 return copyFlags(*Log, I);
2647 }
2648 return NewLog;
2649 }
2650 } else if (LogID == Intrinsic::log || LogID == Intrinsic::log2 ||
2651 LogID == Intrinsic::log10) {
2652 if (Ty->getScalarType()->isFloatTy()) {
2653 ExpLb = LibFunc_expf;
2654 Exp2Lb = LibFunc_exp2f;
2655 Exp10Lb = LibFunc_exp10f;
2656 PowLb = LibFunc_powf;
2657 } else if (Ty->getScalarType()->isDoubleTy()) {
2658 ExpLb = LibFunc_exp;
2659 Exp2Lb = LibFunc_exp2;
2660 Exp10Lb = LibFunc_exp10;
2661 PowLb = LibFunc_pow;
2662 } else
2663 return nullptr;
2664 } else
2665 return nullptr;
2666
2667 // The earlier call must also be 'fast' in order to do these transforms.
2668 CallInst *Arg = dyn_cast<CallInst>(Log->getArgOperand(0));
2669 if (!Log->isFast() || !Arg || !Arg->isFast() || !Arg->hasOneUse())
2670 return nullptr;
2671
2672 IRBuilderBase::FastMathFlagGuard Guard(B);
2673 B.setFastMathFlags(FastMathFlags::getFast());
2674
2675 Intrinsic::ID ArgID = Arg->getIntrinsicID();
2676 LibFunc ArgLb = NotLibFunc;
2677 TLI->getLibFunc(*Arg, ArgLb);
2678
2679 // log(pow(x,y)) -> y*log(x)
2680 AttributeList NoAttrs;
2681 if (ArgLb == PowLb || ArgID == Intrinsic::pow || ArgID == Intrinsic::powi) {
2682 Value *LogX =
2683 Log->doesNotAccessMemory()
2684 ? B.CreateUnaryIntrinsic(LogID, Arg->getOperand(0), nullptr, "log")
2685 : emitUnaryFloatFnCall(Arg->getOperand(0), TLI, LogNm, B, NoAttrs);
2686 Value *Y = Arg->getArgOperand(1);
2687 // Cast exponent to FP if integer.
2688 if (ArgID == Intrinsic::powi)
2689 Y = B.CreateSIToFP(Y, Ty, "cast");
2690 Value *MulY = B.CreateFMul(Y, LogX, "mul");
2691 // Since pow() may have side effects, e.g. errno,
2692 // dead code elimination may not be trusted to remove it.
2693 substituteInParent(Arg, MulY);
2694 return MulY;
2695 }
2696
2697 // log(exp{,2,10}(y)) -> y*log({e,2,10})
2698 // TODO: There is no exp10() intrinsic yet.
2699 if (ArgLb == ExpLb || ArgLb == Exp2Lb || ArgLb == Exp10Lb ||
2700 ArgID == Intrinsic::exp || ArgID == Intrinsic::exp2) {
2701 Constant *Eul;
2702 if (ArgLb == ExpLb || ArgID == Intrinsic::exp)
2703 // FIXME: Add more precise value of e for long double.
2704 Eul = ConstantFP::get(Log->getType(), numbers::e);
2705 else if (ArgLb == Exp2Lb || ArgID == Intrinsic::exp2)
2706 Eul = ConstantFP::get(Log->getType(), 2.0);
2707 else
2708 Eul = ConstantFP::get(Log->getType(), 10.0);
2709 Value *LogE = Log->doesNotAccessMemory()
2710 ? B.CreateUnaryIntrinsic(LogID, Eul, nullptr, "log")
2711 : emitUnaryFloatFnCall(Eul, TLI, LogNm, B, NoAttrs);
2712 Value *MulY = B.CreateFMul(Arg->getArgOperand(0), LogE, "mul");
2713 // Since exp() may have side effects, e.g. errno,
2714 // dead code elimination may not be trusted to remove it.
2715 substituteInParent(Arg, MulY);
2716 return MulY;
2717 }
2718
2719 return nullptr;
2720}
2721
2722// sqrt(exp(X)) -> exp(X * 0.5)
2723Value *LibCallSimplifier::mergeSqrtToExp(CallInst *CI, IRBuilderBase &B) {
2724 if (!CI->hasAllowReassoc())
2725 return nullptr;
2726
2727 Function *SqrtFn = CI->getCalledFunction();
2728 CallInst *Arg = dyn_cast<CallInst>(CI->getArgOperand(0));
2729 if (!Arg || !Arg->hasAllowReassoc() || !Arg->hasOneUse())
2730 return nullptr;
2731 Intrinsic::ID ArgID = Arg->getIntrinsicID();
2732 LibFunc ArgLb = NotLibFunc;
2733 TLI->getLibFunc(*Arg, ArgLb);
2734
2735 LibFunc SqrtLb, ExpLb, Exp2Lb, Exp10Lb;
2736
2737 if (TLI->getLibFunc(SqrtFn->getName(), SqrtLb))
2738 switch (SqrtLb) {
2739 case LibFunc_sqrtf:
2740 ExpLb = LibFunc_expf;
2741 Exp2Lb = LibFunc_exp2f;
2742 Exp10Lb = LibFunc_exp10f;
2743 break;
2744 case LibFunc_sqrt:
2745 ExpLb = LibFunc_exp;
2746 Exp2Lb = LibFunc_exp2;
2747 Exp10Lb = LibFunc_exp10;
2748 break;
2749 case LibFunc_sqrtl:
2750 ExpLb = LibFunc_expl;
2751 Exp2Lb = LibFunc_exp2l;
2752 Exp10Lb = LibFunc_exp10l;
2753 break;
2754 default:
2755 return nullptr;
2756 }
2757 else if (SqrtFn->getIntrinsicID() == Intrinsic::sqrt) {
2758 if (CI->getType()->getScalarType()->isFloatTy()) {
2759 ExpLb = LibFunc_expf;
2760 Exp2Lb = LibFunc_exp2f;
2761 Exp10Lb = LibFunc_exp10f;
2762 } else if (CI->getType()->getScalarType()->isDoubleTy()) {
2763 ExpLb = LibFunc_exp;
2764 Exp2Lb = LibFunc_exp2;
2765 Exp10Lb = LibFunc_exp10;
2766 } else
2767 return nullptr;
2768 } else
2769 return nullptr;
2770
2771 if (ArgLb != ExpLb && ArgLb != Exp2Lb && ArgLb != Exp10Lb &&
2772 ArgID != Intrinsic::exp && ArgID != Intrinsic::exp2)
2773 return nullptr;
2774
2775 IRBuilderBase::InsertPointGuard Guard(B);
2776 B.SetInsertPoint(Arg);
2777 auto *ExpOperand = Arg->getOperand(0);
2778 auto *FMul =
2779 B.CreateFMulFMF(ExpOperand, ConstantFP::get(ExpOperand->getType(), 0.5),
2780 CI, "merged.sqrt");
2781
2782 Arg->setOperand(0, FMul);
2783 return Arg;
2784}
2785
2786Value *LibCallSimplifier::optimizeSqrt(CallInst *CI, IRBuilderBase &B) {
2787 Module *M = CI->getModule();
2789 Value *Ret = nullptr;
2790 // TODO: Once we have a way (other than checking for the existince of the
2791 // libcall) to tell whether our target can lower @llvm.sqrt, relax the
2792 // condition below.
2793 if (isLibFuncEmittable(M, TLI, LibFunc_sqrtf) &&
2794 (Callee->getName() == "sqrt" ||
2795 Callee->getIntrinsicID() == Intrinsic::sqrt))
2796 Ret = optimizeUnaryDoubleFP(CI, B, TLI, true);
2797
2798 if (Value *Opt = mergeSqrtToExp(CI, B))
2799 return Opt;
2800
2801 if (!CI->isFast())
2802 return Ret;
2803
2805 if (!I || I->getOpcode() != Instruction::FMul || !I->isFast())
2806 return Ret;
2807
2808 // We're looking for a repeated factor in a multiplication tree,
2809 // so we can do this fold: sqrt(x * x) -> fabs(x);
2810 // or this fold: sqrt((x * x) * y) -> fabs(x) * sqrt(y).
2811 Value *Op0 = I->getOperand(0);
2812 Value *Op1 = I->getOperand(1);
2813 Value *RepeatOp = nullptr;
2814 Value *OtherOp = nullptr;
2815 if (Op0 == Op1) {
2816 // Simple match: the operands of the multiply are identical.
2817 RepeatOp = Op0;
2818 } else {
2819 // Look for a more complicated pattern: one of the operands is itself
2820 // a multiply, so search for a common factor in that multiply.
2821 // Note: We don't bother looking any deeper than this first level or for
2822 // variations of this pattern because instcombine's visitFMUL and/or the
2823 // reassociation pass should give us this form.
2824 Value *MulOp;
2825 if (match(Op0, m_FMul(m_Value(MulOp), m_Deferred(MulOp))) &&
2826 cast<Instruction>(Op0)->isFast()) {
2827 // Pattern: sqrt((x * x) * z)
2828 RepeatOp = MulOp;
2829 OtherOp = Op1;
2830 } else if (match(Op1, m_FMul(m_Value(MulOp), m_Deferred(MulOp))) &&
2831 cast<Instruction>(Op1)->isFast()) {
2832 // Pattern: sqrt(z * (x * x))
2833 RepeatOp = MulOp;
2834 OtherOp = Op0;
2835 }
2836 }
2837 if (!RepeatOp)
2838 return Ret;
2839
2840 // Fast math flags for any created instructions should match the sqrt
2841 // and multiply.
2842
2843 // If we found a repeated factor, hoist it out of the square root and
2844 // replace it with the fabs of that factor.
2845 Value *FabsCall = B.CreateFAbs(RepeatOp, I, "fabs");
2846 if (OtherOp) {
2847 // If we found a non-repeated factor, we still need to get its square
2848 // root. We then multiply that by the value that was simplified out
2849 // of the square root calculation.
2850 Value *SqrtCall =
2851 B.CreateUnaryIntrinsic(Intrinsic::sqrt, OtherOp, I, "sqrt");
2852 return copyFlags(*CI, B.CreateFMulFMF(FabsCall, SqrtCall, I));
2853 }
2854 return copyFlags(*CI, FabsCall);
2855}
2856
2857Value *LibCallSimplifier::optimizeFMod(CallInst *CI, IRBuilderBase &B) {
2858
2859 // fmod(x,y) sets errno if y == 0 or x == +/-inf. frem does not set errno,
2860 // so the fold is valid only when we can prove fmod wouldn't either.
2861 bool IsNoErrno = CI->hasNoNaNs();
2862 if (!IsNoErrno) {
2863 SimplifyQuery SQ(DL, TLI, DT, AC, CI, true, true, DC);
2864 KnownFPClass Known0 = computeKnownFPClass(CI->getOperand(0), fcInf, SQ);
2865 if (Known0.isKnownNeverInfinity()) {
2866 KnownFPClass Known1 =
2868 Function *F = CI->getParent()->getParent();
2869 const fltSemantics &FltSem =
2871 IsNoErrno = Known1.isKnownNeverLogicalZero(F->getDenormalMode(FltSem));
2872 }
2873 }
2874
2875 if (IsNoErrno)
2876 return B.CreateFRemFMF(CI->getOperand(0), CI->getOperand(1), CI);
2877 return nullptr;
2878}
2879
2880Value *LibCallSimplifier::optimizeTrigInversionPairs(CallInst *CI,
2881 IRBuilderBase &B) {
2882 Module *M = CI->getModule();
2884 Value *Ret = nullptr;
2885 StringRef Name = Callee->getName();
2886 if (UnsafeFPShrink &&
2887 (Name == "tan" || Name == "atanh" || Name == "sinh" || Name == "cosh" ||
2888 Name == "asinh") &&
2889 hasFloatVersion(M, Name))
2890 Ret = optimizeUnaryDoubleFP(CI, B, TLI, true);
2891
2892 Value *Op1 = CI->getArgOperand(0);
2893 auto *OpC = dyn_cast<CallInst>(Op1);
2894 if (!OpC)
2895 return Ret;
2896
2897 // Both calls must be 'fast' in order to remove them.
2898 if (!CI->isFast() || !OpC->isFast())
2899 return Ret;
2900
2901 // tan(atan(x)) -> x
2902 // atanh(tanh(x)) -> x
2903 // sinh(asinh(x)) -> x
2904 // asinh(sinh(x)) -> x
2905 // cosh(acosh(x)) -> x
2906 LibFunc Func;
2907 Function *F = OpC->getCalledFunction();
2908 if (F && TLI->getLibFunc(F->getName(), Func) &&
2909 isLibFuncEmittable(M, TLI, Func)) {
2910 LibFunc inverseFunc = llvm::StringSwitch<LibFunc>(Callee->getName())
2911 .Case("tan", LibFunc_atan)
2912 .Case("atanh", LibFunc_tanh)
2913 .Case("sinh", LibFunc_asinh)
2914 .Case("cosh", LibFunc_acosh)
2915 .Case("tanf", LibFunc_atanf)
2916 .Case("atanhf", LibFunc_tanhf)
2917 .Case("sinhf", LibFunc_asinhf)
2918 .Case("coshf", LibFunc_acoshf)
2919 .Case("tanl", LibFunc_atanl)
2920 .Case("atanhl", LibFunc_tanhl)
2921 .Case("sinhl", LibFunc_asinhl)
2922 .Case("coshl", LibFunc_acoshl)
2923 .Case("asinh", LibFunc_sinh)
2924 .Case("asinhf", LibFunc_sinhf)
2925 .Case("asinhl", LibFunc_sinhl)
2926 .Default(NotLibFunc); // Used as error value
2927 if (Func == inverseFunc)
2928 Ret = OpC->getArgOperand(0);
2929 }
2930 return Ret;
2931}
2932
2933static bool isTrigLibCall(CallInst *CI) {
2934 // We can only hope to do anything useful if we can ignore things like errno
2935 // and floating-point exceptions.
2936 // We already checked the prototype.
2937 return CI->doesNotThrow() && CI->doesNotAccessMemory();
2938}
2939
2940static bool insertSinCosCall(IRBuilderBase &B, Function *OrigCallee, Value *Arg,
2941 bool UseFloat, Value *&Sin, Value *&Cos,
2942 Value *&SinCos, const TargetLibraryInfo *TLI) {
2943 Module *M = OrigCallee->getParent();
2944 Type *ArgTy = Arg->getType();
2945 Type *ResTy;
2946 StringRef Name;
2947
2948 Triple T(OrigCallee->getParent()->getTargetTriple());
2949 if (UseFloat) {
2950 Name = "__sincospif_stret";
2951
2952 assert(T.getArch() != Triple::x86 && "x86 messy and unsupported for now");
2953 // x86_64 can't use {float, float} since that would be returned in both
2954 // xmm0 and xmm1, which isn't what a real struct would do.
2955 ResTy = T.getArch() == Triple::x86_64
2956 ? static_cast<Type *>(FixedVectorType::get(ArgTy, 2))
2957 : static_cast<Type *>(StructType::get(ArgTy, ArgTy));
2958 } else {
2959 Name = "__sincospi_stret";
2960 ResTy = StructType::get(ArgTy, ArgTy);
2961 }
2962
2963 if (!isLibFuncEmittable(M, TLI, Name))
2964 return false;
2965 LibFunc TheLibFunc;
2966 TLI->getLibFunc(Name, TheLibFunc);
2968 M, *TLI, TheLibFunc, OrigCallee->getAttributes(), ResTy, ArgTy);
2969
2970 if (Instruction *ArgInst = dyn_cast<Instruction>(Arg)) {
2971 // If the argument is an instruction, it must dominate all uses so put our
2972 // sincos call there.
2973 B.SetInsertPoint(ArgInst->getParent(), ++ArgInst->getIterator());
2974 } else {
2975 // Otherwise (e.g. for a constant) the beginning of the function is as
2976 // good a place as any.
2977 BasicBlock &EntryBB = B.GetInsertBlock()->getParent()->getEntryBlock();
2978 B.SetInsertPoint(&EntryBB, EntryBB.begin());
2979 }
2980
2981 SinCos = B.CreateCall(Callee, Arg, "sincospi");
2982
2983 if (SinCos->getType()->isStructTy()) {
2984 Sin = B.CreateExtractValue(SinCos, 0, "sinpi");
2985 Cos = B.CreateExtractValue(SinCos, 1, "cospi");
2986 } else {
2987 Sin = B.CreateExtractElement(SinCos, uint64_t{0}, "sinpi");
2988 Cos = B.CreateExtractElement(SinCos, uint64_t{1}, "cospi");
2989 }
2990
2991 return true;
2992}
2993
2994static Value *optimizeSymmetricCall(CallInst *CI, bool IsEven,
2995 IRBuilderBase &B) {
2996 Value *X;
2997 Value *Src = CI->getArgOperand(0);
2998
2999 if (match(Src, m_OneUse(m_FNeg(m_Value(X))))) {
3000 auto *Call = B.CreateCall(CI->getCalledFunction(), {X}, /*FMFSource=*/CI);
3001 auto *CallInst = copyFlags(*CI, Call);
3002 if (IsEven) {
3003 // Even function: f(-x) = f(x)
3004 return CallInst;
3005 }
3006 // Odd function: f(-x) = -f(x)
3007 return B.CreateFNegFMF(CallInst, CI);
3008 }
3009
3010 // Even function: f(abs(x)) = f(x), f(copysign(x, y)) = f(x)
3011 if (IsEven && (match(Src, m_FAbs(m_Value(X))) ||
3012 match(Src, m_CopySign(m_Value(X), m_Value())))) {
3013 auto *Call = B.CreateCall(CI->getCalledFunction(), {X}, /*FMFSource=*/CI);
3014 return copyFlags(*CI, Call);
3015 }
3016
3017 return nullptr;
3018}
3019
3020Value *LibCallSimplifier::optimizeSymmetric(CallInst *CI, LibFunc Func,
3021 IRBuilderBase &B) {
3022 switch (Func) {
3023 case LibFunc_cos:
3024 case LibFunc_cosf:
3025 case LibFunc_cosl:
3026
3027 case LibFunc_cosh:
3028 case LibFunc_coshf:
3029 case LibFunc_coshl:
3030 return optimizeSymmetricCall(CI, /*IsEven*/ true, B);
3031
3032 case LibFunc_sin:
3033 case LibFunc_sinf:
3034 case LibFunc_sinl:
3035
3036 case LibFunc_sinh:
3037 case LibFunc_sinhf:
3038 case LibFunc_sinhl:
3039
3040 case LibFunc_tan:
3041 case LibFunc_tanf:
3042 case LibFunc_tanl:
3043
3044 case LibFunc_tanh:
3045 case LibFunc_tanhf:
3046 case LibFunc_tanhl:
3047
3048 case LibFunc_erf:
3049 case LibFunc_erff:
3050 case LibFunc_erfl:
3051 return optimizeSymmetricCall(CI, /*IsEven*/ false, B);
3052
3053 default:
3054 return nullptr;
3055 }
3056}
3057
3058Value *LibCallSimplifier::optimizeSinCosPi(CallInst *CI, bool IsSin, IRBuilderBase &B) {
3059 // Make sure the prototype is as expected, otherwise the rest of the
3060 // function is probably invalid and likely to abort.
3061 if (!isTrigLibCall(CI))
3062 return nullptr;
3063
3064 Value *Arg = CI->getArgOperand(0);
3065 if (isa<ConstantData>(Arg))
3066 return nullptr;
3067
3070 SmallVector<CallInst *, 1> SinCosCalls;
3071
3072 bool IsFloat = Arg->getType()->isFloatTy();
3073
3074 // Look for all compatible sinpi, cospi and sincospi calls with the same
3075 // argument. If there are enough (in some sense) we can make the
3076 // substitution.
3077 Function *F = CI->getFunction();
3078 for (User *U : Arg->users())
3079 classifyArgUse(U, F, IsFloat, SinCalls, CosCalls, SinCosCalls);
3080
3081 // It's only worthwhile if both sinpi and cospi are actually used.
3082 if (SinCalls.empty() || CosCalls.empty())
3083 return nullptr;
3084
3085 Value *Sin, *Cos, *SinCos;
3086 if (!insertSinCosCall(B, CI->getCalledFunction(), Arg, IsFloat, Sin, Cos,
3087 SinCos, TLI))
3088 return nullptr;
3089
3090 auto replaceTrigInsts = [this](SmallVectorImpl<CallInst *> &Calls,
3091 Value *Res) {
3092 for (CallInst *C : Calls)
3093 replaceAllUsesWith(C, Res);
3094 };
3095
3096 replaceTrigInsts(SinCalls, Sin);
3097 replaceTrigInsts(CosCalls, Cos);
3098 replaceTrigInsts(SinCosCalls, SinCos);
3099
3100 return IsSin ? Sin : Cos;
3101}
3102
3103void LibCallSimplifier::classifyArgUse(
3104 Value *Val, Function *F, bool IsFloat,
3107 SmallVectorImpl<CallInst *> &SinCosCalls) {
3108 auto *CI = dyn_cast<CallInst>(Val);
3109 if (!CI || CI->use_empty())
3110 return;
3111
3112 // Don't consider calls in other functions.
3113 if (CI->getFunction() != F)
3114 return;
3115
3116 Module *M = CI->getModule();
3118 LibFunc Func;
3119 if (!Callee || !TLI->getLibFunc(*Callee, Func) ||
3120 !isLibFuncEmittable(M, TLI, Func) ||
3121 !isTrigLibCall(CI))
3122 return;
3123
3124 if (IsFloat) {
3125 if (Func == LibFunc_sinpif)
3126 SinCalls.push_back(CI);
3127 else if (Func == LibFunc_cospif)
3128 CosCalls.push_back(CI);
3129 else if (Func == LibFunc_sincospif_stret)
3130 SinCosCalls.push_back(CI);
3131 } else {
3132 if (Func == LibFunc_sinpi)
3133 SinCalls.push_back(CI);
3134 else if (Func == LibFunc_cospi)
3135 CosCalls.push_back(CI);
3136 else if (Func == LibFunc_sincospi_stret)
3137 SinCosCalls.push_back(CI);
3138 }
3139}
3140
3141/// Constant folds remquo
3142Value *LibCallSimplifier::optimizeRemquo(CallInst *CI, IRBuilderBase &B) {
3143 const APFloat *X, *Y;
3144 if (!match(CI->getArgOperand(0), m_APFloat(X)) ||
3145 !match(CI->getArgOperand(1), m_APFloat(Y)))
3146 return nullptr;
3147
3148 APFloat::opStatus Status;
3149 APFloat Quot = *X;
3150 Status = Quot.divide(*Y, APFloat::rmNearestTiesToEven);
3151 if (Status != APFloat::opOK && Status != APFloat::opInexact)
3152 return nullptr;
3153 APFloat Rem = *X;
3154 if (Rem.remainder(*Y) != APFloat::opOK)
3155 return nullptr;
3156
3157 // TODO: We can only keep at least the three of the last bits of x/y
3158 unsigned IntBW = TLI->getIntSize();
3159 APSInt QuotInt(IntBW, /*isUnsigned=*/false);
3160 bool IsExact;
3161 Status =
3162 Quot.convertToInteger(QuotInt, APFloat::rmNearestTiesToEven, &IsExact);
3163 if (Status != APFloat::opOK && Status != APFloat::opInexact)
3164 return nullptr;
3165
3166 B.CreateAlignedStore(
3167 ConstantInt::getSigned(B.getIntNTy(IntBW), QuotInt.getExtValue()),
3168 CI->getArgOperand(2), CI->getParamAlign(2));
3169 return ConstantFP::get(CI->getType(), Rem);
3170}
3171
3172/// Constant folds fdim
3173Value *LibCallSimplifier::optimizeFdim(CallInst *CI, IRBuilderBase &B) {
3174 // Cannot perform the fold unless the call has attribute memory(none)
3175 if (!CI->doesNotAccessMemory())
3176 return nullptr;
3177
3178 // TODO : Handle undef values
3179 // Propagate poison if any
3180 if (isa<PoisonValue>(CI->getArgOperand(0)))
3181 return CI->getArgOperand(0);
3182 if (isa<PoisonValue>(CI->getArgOperand(1)))
3183 return CI->getArgOperand(1);
3184
3185 const APFloat *X, *Y;
3186 // Check if both values are constants
3187 if (!match(CI->getArgOperand(0), m_APFloat(X)) ||
3188 !match(CI->getArgOperand(1), m_APFloat(Y)))
3189 return nullptr;
3190
3191 // C99 fdim(x, y) = (x > y) ? x - y : +0.
3192 if (X->compare(*Y) != APFloat::cmpGreaterThan && !X->isNaN() && !Y->isNaN())
3193 return ConstantFP::getZero(CI->getType());
3194 APFloat Difference = *X;
3196 return ConstantFP::get(CI->getType(), Difference);
3197}
3198
3199//===----------------------------------------------------------------------===//
3200// Integer Library Call Optimizations
3201//===----------------------------------------------------------------------===//
3202
3203Value *LibCallSimplifier::optimizeFFS(CallInst *CI, IRBuilderBase &B) {
3204 // All variants of ffs return int which need not be 32 bits wide.
3205 // ffs{,l,ll}(x) -> x != 0 ? (int)llvm.cttz(x)+1 : 0
3206 Type *RetType = CI->getType();
3207 Value *Op = CI->getArgOperand(0);
3208 Type *ArgType = Op->getType();
3209 Value *V = B.CreateIntrinsic(Intrinsic::cttz, {ArgType}, {Op, B.getTrue()},
3210 nullptr, "cttz");
3211 V = B.CreateAdd(V, ConstantInt::get(V->getType(), 1));
3212 V = B.CreateIntCast(V, RetType, false);
3213
3214 Value *Cond = B.CreateICmpNE(Op, Constant::getNullValue(ArgType));
3215 return B.CreateSelect(Cond, V, ConstantInt::get(RetType, 0));
3216}
3217
3218Value *LibCallSimplifier::optimizeFls(CallInst *CI, IRBuilderBase &B) {
3219 // All variants of fls return int which need not be 32 bits wide.
3220 // fls{,l,ll}(x) -> (int)(sizeInBits(x) - llvm.ctlz(x, false))
3221 Value *Op = CI->getArgOperand(0);
3222 Type *ArgType = Op->getType();
3223 Value *V = B.CreateIntrinsic(Intrinsic::ctlz, {ArgType}, {Op, B.getFalse()},
3224 nullptr, "ctlz");
3225 V = B.CreateSub(ConstantInt::get(V->getType(), ArgType->getIntegerBitWidth()),
3226 V);
3227 return B.CreateIntCast(V, CI->getType(), false);
3228}
3229
3230Value *LibCallSimplifier::optimizeAbs(CallInst *CI, IRBuilderBase &B) {
3231 // abs(x) -> x <s 0 ? -x : x
3232 // The negation has 'nsw' because abs of INT_MIN is undefined.
3233 Value *X = CI->getArgOperand(0);
3234 Value *IsNeg = B.CreateIsNeg(X);
3235 Value *NegX = B.CreateNSWNeg(X, "neg");
3236 return B.CreateSelect(IsNeg, NegX, X);
3237}
3238
3239Value *LibCallSimplifier::optimizeIsDigit(CallInst *CI, IRBuilderBase &B) {
3240 // isdigit(c) -> (c-'0') <u 10
3241 Value *Op = CI->getArgOperand(0);
3242 Type *ArgType = Op->getType();
3243 Op = B.CreateSub(Op, ConstantInt::get(ArgType, '0'), "isdigittmp");
3244 Op = B.CreateICmpULT(Op, ConstantInt::get(ArgType, 10), "isdigit");
3245 return B.CreateZExt(Op, CI->getType());
3246}
3247
3248Value *LibCallSimplifier::optimizeIsAscii(CallInst *CI, IRBuilderBase &B) {
3249 // isascii(c) -> c <u 128
3250 Value *Op = CI->getArgOperand(0);
3251 Type *ArgType = Op->getType();
3252 Op = B.CreateICmpULT(Op, ConstantInt::get(ArgType, 128), "isascii");
3253 return B.CreateZExt(Op, CI->getType());
3254}
3255
3256Value *LibCallSimplifier::optimizeToAscii(CallInst *CI, IRBuilderBase &B) {
3257 // toascii(c) -> c & 0x7f
3258 return B.CreateAnd(CI->getArgOperand(0),
3259 ConstantInt::get(CI->getType(), 0x7F));
3260}
3261
3262// Fold calls to atoi, atol, and atoll.
3263Value *LibCallSimplifier::optimizeAtoi(CallInst *CI, IRBuilderBase &B) {
3264 StringRef Str;
3265 if (!getConstantStringInfo(CI->getArgOperand(0), Str))
3266 return nullptr;
3267
3268 return convertStrToInt(CI, Str, nullptr, 10, /*AsSigned=*/true, B);
3269}
3270
3271// Fold calls to strtol, strtoll, strtoul, and strtoull.
3272Value *LibCallSimplifier::optimizeStrToInt(CallInst *CI, IRBuilderBase &B,
3273 bool AsSigned) {
3274 Value *EndPtr = CI->getArgOperand(1);
3275 if (isa<ConstantPointerNull>(EndPtr)) {
3276 // With a null EndPtr, this function won't capture the main argument.
3277 // It would be readonly too, except that it still may write to errno.
3280 EndPtr = nullptr;
3281 } else if (!isKnownNonZero(EndPtr, DL))
3282 return nullptr;
3283
3284 StringRef Str;
3285 if (!getConstantStringInfo(CI->getArgOperand(0), Str))
3286 return nullptr;
3287
3288 if (ConstantInt *CInt = dyn_cast<ConstantInt>(CI->getArgOperand(2))) {
3289 return convertStrToInt(CI, Str, EndPtr, CInt->getSExtValue(), AsSigned, B);
3290 }
3291
3292 return nullptr;
3293}
3294
3295//===----------------------------------------------------------------------===//
3296// Formatting and IO Library Call Optimizations
3297//===----------------------------------------------------------------------===//
3298
3299static bool isReportingError(Function *Callee, CallInst *CI, int StreamArg);
3300
3301Value *LibCallSimplifier::optimizeErrorReporting(CallInst *CI, IRBuilderBase &B,
3302 int StreamArg) {
3304 // Error reporting calls should be cold, mark them as such.
3305 // This applies even to non-builtin calls: it is only a hint and applies to
3306 // functions that the frontend might not understand as builtins.
3307
3308 // This heuristic was suggested in:
3309 // Improving Static Branch Prediction in a Compiler
3310 // Brian L. Deitrich, Ben-Chung Cheng, Wen-mei W. Hwu
3311 // Proceedings of PACT'98, Oct. 1998, IEEE
3312 if (!CI->hasFnAttr(Attribute::Cold) &&
3313 isReportingError(Callee, CI, StreamArg)) {
3314 CI->addFnAttr(Attribute::Cold);
3315 }
3316
3317 return nullptr;
3318}
3319
3320static bool isReportingError(Function *Callee, CallInst *CI, int StreamArg) {
3321 if (!Callee || !Callee->isDeclaration())
3322 return false;
3323
3324 if (StreamArg < 0)
3325 return true;
3326
3327 // These functions might be considered cold, but only if their stream
3328 // argument is stderr.
3329
3330 if (StreamArg >= (int)CI->arg_size())
3331 return false;
3332 LoadInst *LI = dyn_cast<LoadInst>(CI->getArgOperand(StreamArg));
3333 if (!LI)
3334 return false;
3336 if (!GV || !GV->isDeclaration())
3337 return false;
3338 return GV->getName() == "stderr";
3339}
3340
3341Value *LibCallSimplifier::optimizePrintFString(CallInst *CI, IRBuilderBase &B) {
3342 // Check for a fixed format string.
3343 StringRef FormatStr;
3344 if (!getConstantStringInfo(CI->getArgOperand(0), FormatStr))
3345 return nullptr;
3346
3347 // Empty format string -> noop.
3348 if (FormatStr.empty()) // Tolerate printf's declared void.
3349 return CI->use_empty() ? (Value *)CI : ConstantInt::get(CI->getType(), 0);
3350
3351 // Do not do any of the following transformations if the printf return value
3352 // is used, in general the printf return value is not compatible with either
3353 // putchar() or puts().
3354 if (!CI->use_empty())
3355 return nullptr;
3356
3357 Type *IntTy = CI->getType();
3358 // printf("x") -> putchar('x'), even for "%" and "%%".
3359 if (FormatStr.size() == 1 || FormatStr == "%%") {
3360 // Convert the character to unsigned char before passing it to putchar
3361 // to avoid host-specific sign extension in the IR. Putchar converts
3362 // it to unsigned char regardless.
3363 Value *IntChar = ConstantInt::get(IntTy, (unsigned char)FormatStr[0]);
3364 return copyFlags(*CI, emitPutChar(IntChar, B, TLI));
3365 }
3366
3367 // Try to remove call or emit putchar/puts.
3368 if (FormatStr == "%s" && CI->arg_size() > 1) {
3369 StringRef OperandStr;
3370 if (!getConstantStringInfo(CI->getOperand(1), OperandStr))
3371 return nullptr;
3372 // printf("%s", "") --> NOP
3373 if (OperandStr.empty())
3374 return (Value *)CI;
3375 // printf("%s", "a") --> putchar('a')
3376 if (OperandStr.size() == 1) {
3377 // Convert the character to unsigned char before passing it to putchar
3378 // to avoid host-specific sign extension in the IR. Putchar converts
3379 // it to unsigned char regardless.
3380 Value *IntChar = ConstantInt::get(IntTy, (unsigned char)OperandStr[0]);
3381 return copyFlags(*CI, emitPutChar(IntChar, B, TLI));
3382 }
3383 // printf("%s", str"\n") --> puts(str)
3384 if (OperandStr.back() == '\n') {
3385 if (!isLibFuncEmittable(CI->getModule(), TLI, LibFunc_puts))
3386 return nullptr;
3387 OperandStr = OperandStr.drop_back();
3388 Value *GV = B.CreateGlobalString(OperandStr, "str");
3389 return copyFlags(*CI, emitPutS(GV, B, TLI));
3390 }
3391 return nullptr;
3392 }
3393
3394 // printf("foo\n") --> puts("foo")
3395 if (FormatStr.back() == '\n' &&
3396 !FormatStr.contains('%')) { // No format characters.
3397 if (!isLibFuncEmittable(CI->getModule(), TLI, LibFunc_puts))
3398 return nullptr;
3399 // Create a string literal with no \n on it. We expect the constant merge
3400 // pass to be run after this pass, to merge duplicate strings.
3401 FormatStr = FormatStr.drop_back();
3402 Value *GV = B.CreateGlobalString(FormatStr, "str");
3403 return copyFlags(*CI, emitPutS(GV, B, TLI));
3404 }
3405
3406 // Optimize specific format strings.
3407 // printf("%c", chr) --> putchar(chr)
3408 if (FormatStr == "%c" && CI->arg_size() > 1 &&
3409 CI->getArgOperand(1)->getType()->isIntegerTy()) {
3410 // Convert the argument to the type expected by putchar, i.e., int, which
3411 // need not be 32 bits wide but which is the same as printf's return type.
3412 Value *IntChar = B.CreateIntCast(CI->getArgOperand(1), IntTy, false);
3413 return copyFlags(*CI, emitPutChar(IntChar, B, TLI));
3414 }
3415
3416 // printf("%s\n", str) --> puts(str)
3417 if (FormatStr == "%s\n" && CI->arg_size() > 1 &&
3418 CI->getArgOperand(1)->getType()->isPointerTy())
3419 return copyFlags(*CI, emitPutS(CI->getArgOperand(1), B, TLI));
3420 return nullptr;
3421}
3422
3423Value *LibCallSimplifier::optimizePrintF(CallInst *CI, IRBuilderBase &B) {
3424
3425 Module *M = CI->getModule();
3427 FunctionType *FT = Callee->getFunctionType();
3428 if (Value *V = optimizePrintFString(CI, B)) {
3429 return V;
3430 }
3431
3433
3434 // printf(format, ...) -> iprintf(format, ...) if no floating point
3435 // arguments.
3436 if (isLibFuncEmittable(M, TLI, LibFunc_iprintf) &&
3438 FunctionCallee IPrintFFn = getOrInsertLibFunc(M, *TLI, LibFunc_iprintf, FT,
3439 Callee->getAttributes());
3440 CallInst *New = cast<CallInst>(CI->clone());
3441 New->setCalledFunction(IPrintFFn);
3442 B.Insert(New);
3443 return New;
3444 }
3445
3446 // printf(format, ...) -> __small_printf(format, ...) if no 128-bit floating point
3447 // arguments.
3448 if (isLibFuncEmittable(M, TLI, LibFunc_small_printf) &&
3449 !callHasFP128Argument(CI)) {
3450 auto SmallPrintFFn = getOrInsertLibFunc(M, *TLI, LibFunc_small_printf, FT,
3451 Callee->getAttributes());
3452 CallInst *New = cast<CallInst>(CI->clone());
3453 New->setCalledFunction(SmallPrintFFn);
3454 B.Insert(New);
3455 return New;
3456 }
3457
3458 return nullptr;
3459}
3460
3461Value *LibCallSimplifier::optimizeSPrintFString(CallInst *CI,
3462 IRBuilderBase &B) {
3463 // Check for a fixed format string.
3464 StringRef FormatStr;
3465 if (!getConstantStringInfo(CI->getArgOperand(1), FormatStr))
3466 return nullptr;
3467
3468 // If we just have a format string (nothing else crazy) transform it.
3469 Value *Dest = CI->getArgOperand(0);
3470 if (CI->arg_size() == 2) {
3471 // Make sure there's no % in the constant array. We could try to handle
3472 // %% -> % in the future if we cared.
3473 if (FormatStr.contains('%'))
3474 return nullptr; // we found a format specifier, bail out.
3475
3476 // sprintf(str, fmt) -> llvm.memcpy(align 1 str, align 1 fmt, strlen(fmt)+1)
3477 B.CreateMemCpy(Dest, Align(1), CI->getArgOperand(1), Align(1),
3478 // Copy the null byte.
3479 TLI->getAsSizeT(FormatStr.size() + 1, *CI->getModule()));
3480 return ConstantInt::get(CI->getType(), FormatStr.size());
3481 }
3482
3483 // The remaining optimizations require the format string to be "%s" or "%c"
3484 // and have an extra operand.
3485 if (FormatStr.size() != 2 || FormatStr[0] != '%' || CI->arg_size() < 3)
3486 return nullptr;
3487
3488 // Decode the second character of the format string.
3489 if (FormatStr[1] == 'c') {
3490 // sprintf(dst, "%c", chr) --> *(i8*)dst = chr; *((i8*)dst+1) = 0
3491 if (!CI->getArgOperand(2)->getType()->isIntegerTy())
3492 return nullptr;
3493 Value *V = B.CreateTrunc(CI->getArgOperand(2), B.getInt8Ty(), "char");
3494 Value *Ptr = Dest;
3495 B.CreateStore(V, Ptr);
3496 Ptr = B.CreateInBoundsGEP(B.getInt8Ty(), Ptr, B.getInt32(1), "nul");
3497 B.CreateStore(B.getInt8(0), Ptr);
3498
3499 return ConstantInt::get(CI->getType(), 1);
3500 }
3501
3502 if (FormatStr[1] == 's') {
3503 // sprintf(dest, "%s", str) -> llvm.memcpy(align 1 dest, align 1 str,
3504 // strlen(str)+1)
3505 if (!CI->getArgOperand(2)->getType()->isPointerTy())
3506 return nullptr;
3507
3508 if (CI->use_empty())
3509 // sprintf(dest, "%s", str) -> strcpy(dest, str)
3510 return copyFlags(*CI, emitStrCpy(Dest, CI->getArgOperand(2), B, TLI));
3511
3512 uint64_t SrcLen = GetStringLength(CI->getArgOperand(2));
3513 if (SrcLen) {
3514 B.CreateMemCpy(Dest, Align(1), CI->getArgOperand(2), Align(1),
3515 TLI->getAsSizeT(SrcLen, *CI->getModule()));
3516 // Returns total number of characters written without null-character.
3517 return ConstantInt::get(CI->getType(), SrcLen - 1);
3518 } else if (Value *V = emitStpCpy(Dest, CI->getArgOperand(2), B, TLI)) {
3519 // sprintf(dest, "%s", str) -> stpcpy(dest, str) - dest
3520 Value *PtrDiff = B.CreatePtrDiff(V, Dest);
3521 return B.CreateIntCast(PtrDiff, CI->getType(), false);
3522 }
3523
3524 if (llvm::shouldOptimizeForSize(CI->getParent(), PSI, BFI,
3526 return nullptr;
3527
3528 Value *Len = emitStrLen(CI->getArgOperand(2), B, DL, TLI);
3529 if (!Len)
3530 return nullptr;
3531 Value *IncLen =
3532 B.CreateAdd(Len, ConstantInt::get(Len->getType(), 1), "leninc");
3533 B.CreateMemCpy(Dest, Align(1), CI->getArgOperand(2), Align(1), IncLen);
3534
3535 // The sprintf result is the unincremented number of bytes in the string.
3536 return B.CreateIntCast(Len, CI->getType(), false);
3537 }
3538 return nullptr;
3539}
3540
3541Value *LibCallSimplifier::optimizeSPrintF(CallInst *CI, IRBuilderBase &B) {
3542 Module *M = CI->getModule();
3544 FunctionType *FT = Callee->getFunctionType();
3545 if (Value *V = optimizeSPrintFString(CI, B)) {
3546 return V;
3547 }
3548
3550
3551 // sprintf(str, format, ...) -> siprintf(str, format, ...) if no floating
3552 // point arguments.
3553 if (isLibFuncEmittable(M, TLI, LibFunc_siprintf) &&
3555 FunctionCallee SIPrintFFn = getOrInsertLibFunc(M, *TLI, LibFunc_siprintf,
3556 FT, Callee->getAttributes());
3557 CallInst *New = cast<CallInst>(CI->clone());
3558 New->setCalledFunction(SIPrintFFn);
3559 B.Insert(New);
3560 return New;
3561 }
3562
3563 // sprintf(str, format, ...) -> __small_sprintf(str, format, ...) if no 128-bit
3564 // floating point arguments.
3565 if (isLibFuncEmittable(M, TLI, LibFunc_small_sprintf) &&
3566 !callHasFP128Argument(CI)) {
3567 auto SmallSPrintFFn = getOrInsertLibFunc(M, *TLI, LibFunc_small_sprintf, FT,
3568 Callee->getAttributes());
3569 CallInst *New = cast<CallInst>(CI->clone());
3570 New->setCalledFunction(SmallSPrintFFn);
3571 B.Insert(New);
3572 return New;
3573 }
3574
3575 return nullptr;
3576}
3577
3578// Transform an snprintf call CI with the bound N to format the string Str
3579// either to a call to memcpy, or to single character a store, or to nothing,
3580// and fold the result to a constant. A nonnull StrArg refers to the string
3581// argument being formatted. Otherwise the call is one with N < 2 and
3582// the "%c" directive to format a single character.
3583Value *LibCallSimplifier::emitSnPrintfMemCpy(CallInst *CI, Value *StrArg,
3584 StringRef Str, uint64_t N,
3585 IRBuilderBase &B) {
3586 assert(StrArg || (N < 2 && Str.size() == 1));
3587
3588 unsigned IntBits = TLI->getIntSize();
3589 uint64_t IntMax = maxIntN(IntBits);
3590 if (Str.size() > IntMax)
3591 // Bail if the string is longer than INT_MAX. POSIX requires
3592 // implementations to set errno to EOVERFLOW in this case, in
3593 // addition to when N is larger than that (checked by the caller).
3594 return nullptr;
3595
3596 Value *StrLen = ConstantInt::get(CI->getType(), Str.size());
3597 if (N == 0)
3598 return StrLen;
3599
3600 // Set to the number of bytes to copy fron StrArg which is also
3601 // the offset of the terinating nul.
3602 uint64_t NCopy;
3603 if (N > Str.size())
3604 // Copy the full string, including the terminating nul (which must
3605 // be present regardless of the bound).
3606 NCopy = Str.size() + 1;
3607 else
3608 NCopy = N - 1;
3609
3610 Value *DstArg = CI->getArgOperand(0);
3611 if (NCopy && StrArg)
3612 // Transform the call to lvm.memcpy(dst, fmt, N).
3613 copyFlags(*CI, B.CreateMemCpy(DstArg, Align(1), StrArg, Align(1),
3614 TLI->getAsSizeT(NCopy, *CI->getModule())));
3615
3616 if (N > Str.size())
3617 // Return early when the whole format string, including the final nul,
3618 // has been copied.
3619 return StrLen;
3620
3621 // Otherwise, when truncating the string append a terminating nul.
3622 Type *Int8Ty = B.getInt8Ty();
3623 Value *NulOff = B.getIntN(IntBits, NCopy);
3624 Value *DstEnd = B.CreateInBoundsGEP(Int8Ty, DstArg, NulOff, "endptr");
3625 B.CreateStore(ConstantInt::get(Int8Ty, 0), DstEnd);
3626 return StrLen;
3627}
3628
3629Value *LibCallSimplifier::optimizeSnPrintFString(CallInst *CI,
3630 IRBuilderBase &B) {
3631 // Check for size
3632 ConstantInt *Size = dyn_cast<ConstantInt>(CI->getArgOperand(1));
3633 if (!Size)
3634 return nullptr;
3635
3636 uint64_t N = Size->getZExtValue();
3637 uint64_t IntMax = maxIntN(TLI->getIntSize());
3638 if (N > IntMax)
3639 // Bail if the bound exceeds INT_MAX. POSIX requires implementations
3640 // to set errno to EOVERFLOW in this case.
3641 return nullptr;
3642
3643 Value *DstArg = CI->getArgOperand(0);
3644 Value *FmtArg = CI->getArgOperand(2);
3645
3646 // Check for a fixed format string.
3647 StringRef FormatStr;
3648 if (!getConstantStringInfo(FmtArg, FormatStr))
3649 return nullptr;
3650
3651 // If we just have a format string (nothing else crazy) transform it.
3652 if (CI->arg_size() == 3) {
3653 if (FormatStr.contains('%'))
3654 // Bail if the format string contains a directive and there are
3655 // no arguments. We could handle "%%" in the future.
3656 return nullptr;
3657
3658 return emitSnPrintfMemCpy(CI, FmtArg, FormatStr, N, B);
3659 }
3660
3661 // The remaining optimizations require the format string to be "%s" or "%c"
3662 // and have an extra operand.
3663 if (FormatStr.size() != 2 || FormatStr[0] != '%' || CI->arg_size() != 4)
3664 return nullptr;
3665
3666 // Decode the second character of the format string.
3667 if (FormatStr[1] == 'c') {
3668 if (N <= 1) {
3669 // Use an arbitary string of length 1 to transform the call into
3670 // either a nul store (N == 1) or a no-op (N == 0) and fold it
3671 // to one.
3672 StringRef CharStr("*");
3673 return emitSnPrintfMemCpy(CI, nullptr, CharStr, N, B);
3674 }
3675
3676 // snprintf(dst, size, "%c", chr) --> *(i8*)dst = chr; *((i8*)dst+1) = 0
3677 if (!CI->getArgOperand(3)->getType()->isIntegerTy())
3678 return nullptr;
3679 Value *V = B.CreateTrunc(CI->getArgOperand(3), B.getInt8Ty(), "char");
3680 Value *Ptr = DstArg;
3681 B.CreateStore(V, Ptr);
3682 Ptr = B.CreateInBoundsGEP(B.getInt8Ty(), Ptr, B.getInt32(1), "nul");
3683 B.CreateStore(B.getInt8(0), Ptr);
3684 return ConstantInt::get(CI->getType(), 1);
3685 }
3686
3687 if (FormatStr[1] != 's')
3688 return nullptr;
3689
3690 Value *StrArg = CI->getArgOperand(3);
3691 // snprintf(dest, size, "%s", str) to llvm.memcpy(dest, str, len+1, 1)
3692 StringRef Str;
3693 if (!getConstantStringInfo(StrArg, Str))
3694 return nullptr;
3695
3696 return emitSnPrintfMemCpy(CI, StrArg, Str, N, B);
3697}
3698
3699Value *LibCallSimplifier::optimizeSnPrintF(CallInst *CI, IRBuilderBase &B) {
3700 if (Value *V = optimizeSnPrintFString(CI, B)) {
3701 return V;
3702 }
3703
3704 if (isKnownNonZero(CI->getOperand(1), DL))
3706 return nullptr;
3707}
3708
3709Value *LibCallSimplifier::optimizeFPrintFString(CallInst *CI,
3710 IRBuilderBase &B) {
3711 optimizeErrorReporting(CI, B, 0);
3712
3713 // All the optimizations depend on the format string.
3714 StringRef FormatStr;
3715 if (!getConstantStringInfo(CI->getArgOperand(1), FormatStr))
3716 return nullptr;
3717
3718 // Do not do any of the following transformations if the fprintf return
3719 // value is used, in general the fprintf return value is not compatible
3720 // with fwrite(), fputc() or fputs().
3721 if (!CI->use_empty())
3722 return nullptr;
3723
3724 // fprintf(F, "foo") --> fwrite("foo", 3, 1, F)
3725 if (CI->arg_size() == 2) {
3726 // Could handle %% -> % if we cared.
3727 if (FormatStr.contains('%'))
3728 return nullptr; // We found a format specifier.
3729
3730 return copyFlags(
3731 *CI, emitFWrite(CI->getArgOperand(1),
3732 TLI->getAsSizeT(FormatStr.size(), *CI->getModule()),
3733 CI->getArgOperand(0), B, DL, TLI));
3734 }
3735
3736 // The remaining optimizations require the format string to be "%s" or "%c"
3737 // and have an extra operand.
3738 if (FormatStr.size() != 2 || FormatStr[0] != '%' || CI->arg_size() < 3)
3739 return nullptr;
3740
3741 // Decode the second character of the format string.
3742 if (FormatStr[1] == 'c') {
3743 // fprintf(F, "%c", chr) --> fputc((int)chr, F)
3744 if (!CI->getArgOperand(2)->getType()->isIntegerTy())
3745 return nullptr;
3746 Type *IntTy = B.getIntNTy(TLI->getIntSize());
3747 Value *V = B.CreateIntCast(CI->getArgOperand(2), IntTy, /*isSigned*/ true,
3748 "chari");
3749 return copyFlags(*CI, emitFPutC(V, CI->getArgOperand(0), B, TLI));
3750 }
3751
3752 if (FormatStr[1] == 's') {
3753 // fprintf(F, "%s", str) --> fputs(str, F)
3754 if (!CI->getArgOperand(2)->getType()->isPointerTy())
3755 return nullptr;
3756 return copyFlags(
3757 *CI, emitFPutS(CI->getArgOperand(2), CI->getArgOperand(0), B, TLI));
3758 }
3759 return nullptr;
3760}
3761
3762Value *LibCallSimplifier::optimizeFPrintF(CallInst *CI, IRBuilderBase &B) {
3763 Module *M = CI->getModule();
3765 FunctionType *FT = Callee->getFunctionType();
3766 if (Value *V = optimizeFPrintFString(CI, B)) {
3767 return V;
3768 }
3769
3770 // fprintf(stream, format, ...) -> fiprintf(stream, format, ...) if no
3771 // floating point arguments.
3772 if (isLibFuncEmittable(M, TLI, LibFunc_fiprintf) &&
3774 FunctionCallee FIPrintFFn = getOrInsertLibFunc(M, *TLI, LibFunc_fiprintf,
3775 FT, Callee->getAttributes());
3776 CallInst *New = cast<CallInst>(CI->clone());
3777 New->setCalledFunction(FIPrintFFn);
3778 B.Insert(New);
3779 return New;
3780 }
3781
3782 // fprintf(stream, format, ...) -> __small_fprintf(stream, format, ...) if no
3783 // 128-bit floating point arguments.
3784 if (isLibFuncEmittable(M, TLI, LibFunc_small_fprintf) &&
3785 !callHasFP128Argument(CI)) {
3786 auto SmallFPrintFFn =
3787 getOrInsertLibFunc(M, *TLI, LibFunc_small_fprintf, FT,
3788 Callee->getAttributes());
3789 CallInst *New = cast<CallInst>(CI->clone());
3790 New->setCalledFunction(SmallFPrintFFn);
3791 B.Insert(New);
3792 return New;
3793 }
3794
3795 return nullptr;
3796}
3797
3798Value *LibCallSimplifier::optimizeFWrite(CallInst *CI, IRBuilderBase &B) {
3799 optimizeErrorReporting(CI, B, 3);
3800
3801 // Get the element size and count.
3802 ConstantInt *SizeC = dyn_cast<ConstantInt>(CI->getArgOperand(1));
3803 ConstantInt *CountC = dyn_cast<ConstantInt>(CI->getArgOperand(2));
3804 if (SizeC && CountC) {
3805 uint64_t Bytes = SizeC->getZExtValue() * CountC->getZExtValue();
3806
3807 // If this is writing zero records, remove the call (it's a noop).
3808 if (Bytes == 0)
3809 return ConstantInt::get(CI->getType(), 0);
3810
3811 // If this is writing one byte, turn it into fputc.
3812 // This optimisation is only valid, if the return value is unused.
3813 if (Bytes == 1 && CI->use_empty()) { // fwrite(S,1,1,F) -> fputc(S[0],F)
3814 Value *Char = B.CreateLoad(B.getInt8Ty(), CI->getArgOperand(0), "char");
3815 Type *IntTy = B.getIntNTy(TLI->getIntSize());
3816 Value *Cast = B.CreateIntCast(Char, IntTy, /*isSigned*/ true, "chari");
3817 Value *NewCI = emitFPutC(Cast, CI->getArgOperand(3), B, TLI);
3818 return NewCI ? ConstantInt::get(CI->getType(), 1) : nullptr;
3819 }
3820 }
3821
3822 return nullptr;
3823}
3824
3825Value *LibCallSimplifier::optimizeFPuts(CallInst *CI, IRBuilderBase &B) {
3826 optimizeErrorReporting(CI, B, 1);
3827
3828 // Don't rewrite fputs to fwrite when optimising for size because fwrite
3829 // requires more arguments and thus extra MOVs are required.
3830 if (llvm::shouldOptimizeForSize(CI->getParent(), PSI, BFI,
3832 return nullptr;
3833
3834 // We can't optimize if return value is used.
3835 if (!CI->use_empty())
3836 return nullptr;
3837
3838 // fputs(s,F) --> fwrite(s,strlen(s),1,F)
3839 uint64_t Len = GetStringLength(CI->getArgOperand(0));
3840 if (!Len)
3841 return nullptr;
3842
3843 // Known to have no uses (see above).
3844 unsigned SizeTBits = TLI->getSizeTSize(*CI->getModule());
3845 Type *SizeTTy = IntegerType::get(CI->getContext(), SizeTBits);
3846 return copyFlags(
3847 *CI,
3849 ConstantInt::get(SizeTTy, Len - 1),
3850 CI->getArgOperand(1), B, DL, TLI));
3851}
3852
3853Value *LibCallSimplifier::optimizePuts(CallInst *CI, IRBuilderBase &B) {
3855 if (!CI->use_empty())
3856 return nullptr;
3857
3858 // Check for a constant string.
3859 // puts("") -> putchar('\n')
3860 StringRef Str;
3861 if (getConstantStringInfo(CI->getArgOperand(0), Str) && Str.empty()) {
3862 // putchar takes an argument of the same type as puts returns, i.e.,
3863 // int, which need not be 32 bits wide.
3864 Type *IntTy = CI->getType();
3865 return copyFlags(*CI, emitPutChar(ConstantInt::get(IntTy, '\n'), B, TLI));
3866 }
3867
3868 return nullptr;
3869}
3870
3871Value *LibCallSimplifier::optimizeExit(CallInst *CI) {
3872
3873 // Mark 'exit' as cold if its not exit(0) (success).
3874 const APInt *C;
3875 if (!CI->hasFnAttr(Attribute::Cold) &&
3876 match(CI->getArgOperand(0), m_APInt(C)) && !C->isZero()) {
3877 CI->addFnAttr(Attribute::Cold);
3878 }
3879 return nullptr;
3880}
3881
3882Value *LibCallSimplifier::optimizeBCopy(CallInst *CI, IRBuilderBase &B) {
3883 // bcopy(src, dst, n) -> llvm.memmove(dst, src, n)
3884 return copyFlags(*CI, B.CreateMemMove(CI->getArgOperand(1), Align(1),
3885 CI->getArgOperand(0), Align(1),
3886 CI->getArgOperand(2)));
3887}
3888
3889bool LibCallSimplifier::hasFloatVersion(const Module *M, StringRef FuncName) {
3890 SmallString<20> FloatFuncName = FuncName;
3891 FloatFuncName += 'f';
3892 return isLibFuncEmittable(M, TLI, FloatFuncName);
3893}
3894
3895Value *LibCallSimplifier::optimizeStringMemoryLibCall(CallInst *CI,
3896 IRBuilderBase &Builder) {
3897 Module *M = CI->getModule();
3898 LibFunc Func;
3900
3901 // Check for string/memory library functions.
3902 if (TLI->getLibFunc(*Callee, Func) && isLibFuncEmittable(M, TLI, Func)) {
3903 // Make sure we never change the calling convention.
3904 assert(
3905 (ignoreCallingConv(Func) ||
3907 "Optimizing string/memory libcall would change the calling convention");
3908 switch (Func) {
3909 case LibFunc_strcat:
3910 return optimizeStrCat(CI, Builder);
3911 case LibFunc_strncat:
3912 return optimizeStrNCat(CI, Builder);
3913 case LibFunc_strchr:
3914 return optimizeStrChr(CI, Builder);
3915 case LibFunc_strrchr:
3916 return optimizeStrRChr(CI, Builder);
3917 case LibFunc_strcmp:
3918 return optimizeStrCmp(CI, Builder);
3919 case LibFunc_strncmp:
3920 return optimizeStrNCmp(CI, Builder);
3921 case LibFunc_strcpy:
3922 return optimizeStrCpy(CI, Builder);
3923 case LibFunc_stpcpy:
3924 return optimizeStpCpy(CI, Builder);
3925 case LibFunc_strlcpy:
3926 return optimizeStrLCpy(CI, Builder);
3927 case LibFunc_stpncpy:
3928 return optimizeStringNCpy(CI, /*RetEnd=*/true, Builder);
3929 case LibFunc_strncpy:
3930 return optimizeStringNCpy(CI, /*RetEnd=*/false, Builder);
3931 case LibFunc_strlen:
3932 return optimizeStrLen(CI, Builder);
3933 case LibFunc_strnlen:
3934 return optimizeStrNLen(CI, Builder);
3935 case LibFunc_strpbrk:
3936 return optimizeStrPBrk(CI, Builder);
3937 case LibFunc_strndup:
3938 return optimizeStrNDup(CI, Builder);
3939 case LibFunc_strtol:
3940 case LibFunc_strtod:
3941 case LibFunc_strtof:
3942 case LibFunc_strtoul:
3943 case LibFunc_strtoll:
3944 case LibFunc_strtold:
3945 case LibFunc_strtoull:
3946 return optimizeStrTo(CI, Builder);
3947 case LibFunc_strspn:
3948 return optimizeStrSpn(CI, Builder);
3949 case LibFunc_strcspn:
3950 return optimizeStrCSpn(CI, Builder);
3951 case LibFunc_strstr:
3952 return optimizeStrStr(CI, Builder);
3953 case LibFunc_memchr:
3954 return optimizeMemChr(CI, Builder);
3955 case LibFunc_memrchr:
3956 return optimizeMemRChr(CI, Builder);
3957 case LibFunc_bcmp:
3958 return optimizeBCmp(CI, Builder);
3959 case LibFunc_memcmp:
3960 return optimizeMemCmp(CI, Builder);
3961 case LibFunc_memcpy:
3962 return optimizeMemCpy(CI, Builder);
3963 case LibFunc_memccpy:
3964 return optimizeMemCCpy(CI, Builder);
3965 case LibFunc_mempcpy:
3966 return optimizeMemPCpy(CI, Builder);
3967 case LibFunc_memmove:
3968 return optimizeMemMove(CI, Builder);
3969 case LibFunc_memset:
3970 return optimizeMemSet(CI, Builder);
3971 case LibFunc_realloc:
3972 return optimizeRealloc(CI, Builder);
3973 case LibFunc_wcslen:
3974 return optimizeWcslen(CI, Builder);
3975 case LibFunc_bcopy:
3976 return optimizeBCopy(CI, Builder);
3977 case LibFunc_Znwm:
3978 case LibFunc_ZnwmRKSt9nothrow_t:
3979 case LibFunc_ZnwmSt11align_val_t:
3980 case LibFunc_ZnwmSt11align_val_tRKSt9nothrow_t:
3981 case LibFunc_Znam:
3982 case LibFunc_ZnamRKSt9nothrow_t:
3983 case LibFunc_ZnamSt11align_val_t:
3984 case LibFunc_ZnamSt11align_val_tRKSt9nothrow_t:
3985 case LibFunc_Znwm12__hot_cold_t:
3986 case LibFunc_ZnwmRKSt9nothrow_t12__hot_cold_t:
3987 case LibFunc_ZnwmSt11align_val_t12__hot_cold_t:
3988 case LibFunc_ZnwmSt11align_val_tRKSt9nothrow_t12__hot_cold_t:
3989 case LibFunc_Znam12__hot_cold_t:
3990 case LibFunc_ZnamRKSt9nothrow_t12__hot_cold_t:
3991 case LibFunc_ZnamSt11align_val_t12__hot_cold_t:
3992 case LibFunc_ZnamSt11align_val_tRKSt9nothrow_t12__hot_cold_t:
3993 case LibFunc_size_returning_new:
3994 case LibFunc_size_returning_new_hot_cold:
3995 case LibFunc_size_returning_new_aligned:
3996 case LibFunc_size_returning_new_aligned_hot_cold:
3997 return optimizeNew(CI, Builder, Func);
3998 default:
3999 break;
4000 }
4001 }
4002 return nullptr;
4003}
4004
4005/// Constant folding nan/nanf/nanl.
4007 StringRef CharSeq;
4008 if (!getConstantStringInfo(CI->getArgOperand(0), CharSeq))
4009 return nullptr;
4010
4011 APInt Fill;
4012 // Treat empty strings as if they were zero.
4013 if (CharSeq.empty())
4014 Fill = APInt(32, 0);
4015 else if (CharSeq.getAsInteger(0, Fill))
4016 return nullptr;
4017
4018 return ConstantFP::getQNaN(CI->getType(), /*Negative=*/false, &Fill);
4019}
4020
4021Value *LibCallSimplifier::optimizeFloatingPointLibCall(CallInst *CI,
4022 LibFunc Func,
4023 IRBuilderBase &Builder) {
4024 const Module *M = CI->getModule();
4025
4026 // Don't optimize calls that require strict floating point semantics.
4027 if (CI->isStrictFP())
4028 return nullptr;
4029
4030 if (Value *V = optimizeSymmetric(CI, Func, Builder))
4031 return V;
4032
4033 switch (Func) {
4034 case LibFunc_sinpif:
4035 case LibFunc_sinpi:
4036 return optimizeSinCosPi(CI, /*IsSin*/true, Builder);
4037 case LibFunc_cospif:
4038 case LibFunc_cospi:
4039 return optimizeSinCosPi(CI, /*IsSin*/false, Builder);
4040 case LibFunc_powf:
4041 case LibFunc_pow:
4042 case LibFunc_powl:
4043 return optimizePow(CI, Builder);
4044 case LibFunc_exp2l:
4045 case LibFunc_exp2:
4046 case LibFunc_exp2f:
4047 return optimizeExp2(CI, Builder);
4048 case LibFunc_fabsf:
4049 case LibFunc_fabs:
4050 case LibFunc_fabsl:
4051 return replaceUnaryCall(CI, Builder, Intrinsic::fabs);
4052 case LibFunc_sqrtf:
4053 case LibFunc_sqrt:
4054 case LibFunc_sqrtl:
4055 return optimizeSqrt(CI, Builder);
4056 case LibFunc_fmod:
4057 case LibFunc_fmodf:
4058 case LibFunc_fmodl:
4059 return optimizeFMod(CI, Builder);
4060 case LibFunc_logf:
4061 case LibFunc_log:
4062 case LibFunc_logl:
4063 case LibFunc_log10f:
4064 case LibFunc_log10:
4065 case LibFunc_log10l:
4066 case LibFunc_log1pf:
4067 case LibFunc_log1p:
4068 case LibFunc_log1pl:
4069 case LibFunc_log2f:
4070 case LibFunc_log2:
4071 case LibFunc_log2l:
4072 case LibFunc_logbf:
4073 case LibFunc_logb:
4074 case LibFunc_logbl:
4075 return optimizeLog(CI, Builder);
4076 case LibFunc_tan:
4077 case LibFunc_tanf:
4078 case LibFunc_tanl:
4079 case LibFunc_sinh:
4080 case LibFunc_sinhf:
4081 case LibFunc_sinhl:
4082 case LibFunc_asinh:
4083 case LibFunc_asinhf:
4084 case LibFunc_asinhl:
4085 case LibFunc_cosh:
4086 case LibFunc_coshf:
4087 case LibFunc_coshl:
4088 case LibFunc_atanh:
4089 case LibFunc_atanhf:
4090 case LibFunc_atanhl:
4091 return optimizeTrigInversionPairs(CI, Builder);
4092 case LibFunc_ceil:
4093 return replaceUnaryCall(CI, Builder, Intrinsic::ceil);
4094 case LibFunc_floor:
4095 return replaceUnaryCall(CI, Builder, Intrinsic::floor);
4096 case LibFunc_round:
4097 return replaceUnaryCall(CI, Builder, Intrinsic::round);
4098 case LibFunc_roundeven:
4099 return replaceUnaryCall(CI, Builder, Intrinsic::roundeven);
4100 case LibFunc_nearbyint:
4101 return replaceUnaryCall(CI, Builder, Intrinsic::nearbyint);
4102 case LibFunc_rint:
4103 return replaceUnaryCall(CI, Builder, Intrinsic::rint);
4104 case LibFunc_trunc:
4105 return replaceUnaryCall(CI, Builder, Intrinsic::trunc);
4106 case LibFunc_acos:
4107 case LibFunc_acosh:
4108 case LibFunc_asin:
4109 case LibFunc_atan:
4110 case LibFunc_cbrt:
4111 case LibFunc_exp:
4112 case LibFunc_exp10:
4113 case LibFunc_expm1:
4114 case LibFunc_cos:
4115 case LibFunc_sin:
4116 case LibFunc_tanh:
4117 if (UnsafeFPShrink && hasFloatVersion(M, CI->getCalledFunction()->getName()))
4118 return optimizeUnaryDoubleFP(CI, Builder, TLI, true);
4119 return nullptr;
4120 case LibFunc_copysign:
4121 if (hasFloatVersion(M, CI->getCalledFunction()->getName()))
4122 return optimizeBinaryDoubleFP(CI, Builder, TLI);
4123 return nullptr;
4124 case LibFunc_fdim:
4125 case LibFunc_fdimf:
4126 case LibFunc_fdiml:
4127 return optimizeFdim(CI, Builder);
4128 case LibFunc_fminf:
4129 case LibFunc_fmin:
4130 case LibFunc_fminl:
4131 return optimizeFMinFMax(CI, Builder, Intrinsic::minnum);
4132 case LibFunc_fmaxf:
4133 case LibFunc_fmax:
4134 case LibFunc_fmaxl:
4135 return optimizeFMinFMax(CI, Builder, Intrinsic::maxnum);
4136 case LibFunc_fminimum_numf:
4137 case LibFunc_fminimum_num:
4138 case LibFunc_fminimum_numl:
4139 return replaceBinaryCall(CI, Builder, Intrinsic::minimumnum);
4140 case LibFunc_fmaximum_numf:
4141 case LibFunc_fmaximum_num:
4142 case LibFunc_fmaximum_numl:
4143 return replaceBinaryCall(CI, Builder, Intrinsic::maximumnum);
4144 case LibFunc_cabs:
4145 case LibFunc_cabsf:
4146 case LibFunc_cabsl:
4147 return optimizeCAbs(CI, Builder);
4148 case LibFunc_remquo:
4149 case LibFunc_remquof:
4150 case LibFunc_remquol:
4151 return optimizeRemquo(CI, Builder);
4152 case LibFunc_nan:
4153 case LibFunc_nanf:
4154 case LibFunc_nanl:
4155 return optimizeNaN(CI);
4156 default:
4157 return nullptr;
4158 }
4159}
4160
4162 Module *M = CI->getModule();
4163 assert(!CI->isMustTailCall() && "These transforms aren't musttail safe.");
4164
4165 // TODO: Split out the code below that operates on FP calls so that
4166 // we can all non-FP calls with the StrictFP attribute to be
4167 // optimized.
4168 if (CI->isNoBuiltin()) {
4169 // Optionally update operator new calls.
4170 return maybeOptimizeNoBuiltinOperatorNew(CI, Builder);
4171 }
4172
4173 LibFunc Func;
4174 Function *Callee = CI->getCalledFunction();
4175 bool IsCallingConvC = TargetLibraryInfoImpl::isCallingConvCCompatible(CI);
4176
4178 CI->getOperandBundlesAsDefs(OpBundles);
4179
4181 Builder.setDefaultOperandBundles(OpBundles);
4182
4183 // Command-line parameter overrides instruction attribute.
4184 // This can't be moved to optimizeFloatingPointLibCall() because it may be
4185 // used by the intrinsic optimizations.
4186 if (EnableUnsafeFPShrink.getNumOccurrences() > 0)
4187 UnsafeFPShrink = EnableUnsafeFPShrink;
4188 else if (isa<FPMathOperator>(CI) && CI->isFast())
4189 UnsafeFPShrink = true;
4190
4191 // First, check for intrinsics.
4193 if (!IsCallingConvC)
4194 return nullptr;
4195 // The FP intrinsics have corresponding constrained versions so we don't
4196 // need to check for the StrictFP attribute here.
4197 switch (II->getIntrinsicID()) {
4198 case Intrinsic::pow:
4199 return optimizePow(CI, Builder);
4200 case Intrinsic::exp2:
4201 return optimizeExp2(CI, Builder);
4202 case Intrinsic::log:
4203 case Intrinsic::log2:
4204 case Intrinsic::log10:
4205 return optimizeLog(CI, Builder);
4206 case Intrinsic::sqrt:
4207 return optimizeSqrt(CI, Builder);
4208 case Intrinsic::memset:
4209 return optimizeMemSet(CI, Builder);
4210 case Intrinsic::memcpy:
4211 return optimizeMemCpy(CI, Builder);
4212 case Intrinsic::memmove:
4213 return optimizeMemMove(CI, Builder);
4214 case Intrinsic::sin:
4215 case Intrinsic::cos:
4216 if (UnsafeFPShrink)
4217 return optimizeUnaryDoubleFP(CI, Builder, TLI, /*isPrecise=*/true);
4218 return nullptr;
4219 default:
4220 return nullptr;
4221 }
4222 }
4223
4224 // Also try to simplify calls to fortified library functions.
4225 if (Value *SimplifiedFortifiedCI =
4226 FortifiedSimplifier.optimizeCall(CI, Builder))
4227 return SimplifiedFortifiedCI;
4228
4229 // Then check for known library functions.
4230 if (TLI->getLibFunc(*Callee, Func) && isLibFuncEmittable(M, TLI, Func)) {
4231 // We never change the calling convention.
4232 if (!ignoreCallingConv(Func) && !IsCallingConvC)
4233 return nullptr;
4234 if (Value *V = optimizeStringMemoryLibCall(CI, Builder))
4235 return V;
4236 if (Value *V = optimizeFloatingPointLibCall(CI, Func, Builder))
4237 return V;
4238 switch (Func) {
4239 case LibFunc_ffs:
4240 case LibFunc_ffsl:
4241 case LibFunc_ffsll:
4242 return optimizeFFS(CI, Builder);
4243 case LibFunc_fls:
4244 case LibFunc_flsl:
4245 case LibFunc_flsll:
4246 return optimizeFls(CI, Builder);
4247 case LibFunc_abs:
4248 case LibFunc_labs:
4249 case LibFunc_llabs:
4250 return optimizeAbs(CI, Builder);
4251 case LibFunc_isdigit:
4252 return optimizeIsDigit(CI, Builder);
4253 case LibFunc_isascii:
4254 return optimizeIsAscii(CI, Builder);
4255 case LibFunc_toascii:
4256 return optimizeToAscii(CI, Builder);
4257 case LibFunc_atoi:
4258 case LibFunc_atol:
4259 case LibFunc_atoll:
4260 return optimizeAtoi(CI, Builder);
4261 case LibFunc_strtol:
4262 case LibFunc_strtoll:
4263 return optimizeStrToInt(CI, Builder, /*AsSigned=*/true);
4264 case LibFunc_strtoul:
4265 case LibFunc_strtoull:
4266 return optimizeStrToInt(CI, Builder, /*AsSigned=*/false);
4267 case LibFunc_printf:
4268 return optimizePrintF(CI, Builder);
4269 case LibFunc_sprintf:
4270 return optimizeSPrintF(CI, Builder);
4271 case LibFunc_snprintf:
4272 return optimizeSnPrintF(CI, Builder);
4273 case LibFunc_fprintf:
4274 return optimizeFPrintF(CI, Builder);
4275 case LibFunc_fwrite:
4276 return optimizeFWrite(CI, Builder);
4277 case LibFunc_fputs:
4278 return optimizeFPuts(CI, Builder);
4279 case LibFunc_puts:
4280 return optimizePuts(CI, Builder);
4281 case LibFunc_perror:
4282 return optimizeErrorReporting(CI, Builder);
4283 case LibFunc_vfprintf:
4284 case LibFunc_fiprintf:
4285 return optimizeErrorReporting(CI, Builder, 0);
4286 case LibFunc_exit:
4287 case LibFunc_Exit:
4288 return optimizeExit(CI);
4289 default:
4290 return nullptr;
4291 }
4292 }
4293 return nullptr;
4294}
4295
4297 const DataLayout &DL, const TargetLibraryInfo *TLI, DominatorTree *DT,
4300 function_ref<void(Instruction *, Value *)> Replacer,
4301 function_ref<void(Instruction *)> Eraser)
4302 : FortifiedSimplifier(TLI), DL(DL), TLI(TLI), DT(DT), DC(DC), AC(AC),
4303 ORE(ORE), BFI(BFI), PSI(PSI), Replacer(Replacer), Eraser(Eraser) {}
4304
4305void LibCallSimplifier::replaceAllUsesWith(Instruction *I, Value *With) {
4306 // Indirect through the replacer used in this instance.
4307 Replacer(I, With);
4308}
4309
4310void LibCallSimplifier::eraseFromParent(Instruction *I) {
4311 Eraser(I);
4312}
4313
4314// TODO:
4315// Additional cases that we need to add to this file:
4316//
4317// cbrt:
4318// * cbrt(expN(X)) -> expN(x/3)
4319// * cbrt(sqrt(x)) -> pow(x,1/6)
4320// * cbrt(cbrt(x)) -> pow(x,1/9)
4321//
4322// exp, expf, expl:
4323// * exp(log(x)) -> x
4324//
4325// log, logf, logl:
4326// * log(exp(x)) -> x
4327// * log(exp(y)) -> y*log(e)
4328// * log(exp10(y)) -> y*log(10)
4329// * log(sqrt(x)) -> 0.5*log(x)
4330//
4331// pow, powf, powl:
4332// * pow(sqrt(x),y) -> pow(x,y*0.5)
4333// * pow(pow(x,y),z)-> pow(x,y*z)
4334//
4335// signbit:
4336// * signbit(cnst) -> cnst'
4337// * signbit(nncst) -> 0 (if pstv is a non-negative constant)
4338//
4339// sqrt, sqrtf, sqrtl:
4340// * sqrt(expN(x)) -> expN(x*0.5)
4341// * sqrt(Nroot(x)) -> pow(x,1/(2*N))
4342// * sqrt(pow(x,y)) -> pow(|x|,y*0.5)
4343//
4344
4345//===----------------------------------------------------------------------===//
4346// Fortified Library Call Optimizations
4347//===----------------------------------------------------------------------===//
4348
4349bool FortifiedLibCallSimplifier::isFortifiedCallFoldable(
4350 CallInst *CI, unsigned ObjSizeOp, std::optional<unsigned> SizeOp,
4351 std::optional<unsigned> StrOp, std::optional<unsigned> FlagOp) {
4352 // If this function takes a flag argument, the implementation may use it to
4353 // perform extra checks. Don't fold into the non-checking variant.
4354 if (FlagOp) {
4355 ConstantInt *Flag = dyn_cast<ConstantInt>(CI->getArgOperand(*FlagOp));
4356 if (!Flag || !Flag->isZero())
4357 return false;
4358 }
4359
4360 if (SizeOp && CI->getArgOperand(ObjSizeOp) == CI->getArgOperand(*SizeOp))
4361 return true;
4362
4363 if (ConstantInt *ObjSizeCI =
4364 dyn_cast<ConstantInt>(CI->getArgOperand(ObjSizeOp))) {
4365 if (ObjSizeCI->isMinusOne())
4366 return true;
4367 // If the object size wasn't -1 (unknown), bail out if we were asked to.
4368 if (OnlyLowerUnknownSize)
4369 return false;
4370 if (StrOp) {
4371 uint64_t Len = GetStringLength(CI->getArgOperand(*StrOp));
4372 // If the length is 0 we don't know how long it is and so we can't
4373 // remove the check.
4374 if (Len)
4375 annotateDereferenceableBytes(CI, *StrOp, Len);
4376 else
4377 return false;
4378 return ObjSizeCI->getZExtValue() >= Len;
4379 }
4380
4381 if (SizeOp) {
4382 if (ConstantInt *SizeCI =
4384 return ObjSizeCI->getZExtValue() >= SizeCI->getZExtValue();
4385 }
4386 }
4387 return false;
4388}
4389
4390Value *FortifiedLibCallSimplifier::optimizeMemCpyChk(CallInst *CI,
4391 IRBuilderBase &B) {
4392 if (isFortifiedCallFoldable(CI, 3, 2)) {
4393 CallInst *NewCI =
4394 B.CreateMemCpy(CI->getArgOperand(0), Align(1), CI->getArgOperand(1),
4395 Align(1), CI->getArgOperand(2));
4396 mergeAttributesAndFlags(NewCI, *CI);
4397 return CI->getArgOperand(0);
4398 }
4399 return nullptr;
4400}
4401
4402Value *FortifiedLibCallSimplifier::optimizeMemMoveChk(CallInst *CI,
4403 IRBuilderBase &B) {
4404 if (isFortifiedCallFoldable(CI, 3, 2)) {
4405 CallInst *NewCI =
4406 B.CreateMemMove(CI->getArgOperand(0), Align(1), CI->getArgOperand(1),
4407 Align(1), CI->getArgOperand(2));
4408 mergeAttributesAndFlags(NewCI, *CI);
4409 return CI->getArgOperand(0);
4410 }
4411 return nullptr;
4412}
4413
4414Value *FortifiedLibCallSimplifier::optimizeMemSetChk(CallInst *CI,
4415 IRBuilderBase &B) {
4416 if (isFortifiedCallFoldable(CI, 3, 2)) {
4417 Value *Val = B.CreateIntCast(CI->getArgOperand(1), B.getInt8Ty(), false);
4418 CallInst *NewCI = B.CreateMemSet(CI->getArgOperand(0), Val,
4419 CI->getArgOperand(2), Align(1));
4420 mergeAttributesAndFlags(NewCI, *CI);
4421 return CI->getArgOperand(0);
4422 }
4423 return nullptr;
4424}
4425
4426Value *FortifiedLibCallSimplifier::optimizeMemPCpyChk(CallInst *CI,
4427 IRBuilderBase &B) {
4428 const DataLayout &DL = CI->getDataLayout();
4429 if (isFortifiedCallFoldable(CI, 3, 2))
4430 if (Value *Call = emitMemPCpy(CI->getArgOperand(0), CI->getArgOperand(1),
4431 CI->getArgOperand(2), B, DL, TLI)) {
4433 }
4434 return nullptr;
4435}
4436
4437Value *FortifiedLibCallSimplifier::optimizeStrpCpyChk(CallInst *CI,
4439 LibFunc Func) {
4440 const DataLayout &DL = CI->getDataLayout();
4441 Value *Dst = CI->getArgOperand(0), *Src = CI->getArgOperand(1),
4442 *ObjSize = CI->getArgOperand(2);
4443
4444 // __stpcpy_chk(x,x,...) -> x+strlen(x)
4445 if (Func == LibFunc_stpcpy_chk && !OnlyLowerUnknownSize && Dst == Src) {
4446 Value *StrLen = emitStrLen(Src, B, DL, TLI);
4447 return StrLen ? B.CreateInBoundsGEP(B.getInt8Ty(), Dst, StrLen) : nullptr;
4448 }
4449
4450 // If a) we don't have any length information, or b) we know this will
4451 // fit then just lower to a plain st[rp]cpy. Otherwise we'll keep our
4452 // st[rp]cpy_chk call which may fail at runtime if the size is too long.
4453 // TODO: It might be nice to get a maximum length out of the possible
4454 // string lengths for varying.
4455 if (isFortifiedCallFoldable(CI, 2, std::nullopt, 1)) {
4456 if (Func == LibFunc_strcpy_chk)
4457 return copyFlags(*CI, emitStrCpy(Dst, Src, B, TLI));
4458 else
4459 return copyFlags(*CI, emitStpCpy(Dst, Src, B, TLI));
4460 }
4461
4462 if (OnlyLowerUnknownSize)
4463 return nullptr;
4464
4465 // Maybe we can stil fold __st[rp]cpy_chk to __memcpy_chk.
4466 uint64_t Len = GetStringLength(Src);
4467 if (Len)
4468 annotateDereferenceableBytes(CI, 1, Len);
4469 else
4470 return nullptr;
4471
4472 unsigned SizeTBits = TLI->getSizeTSize(*CI->getModule());
4473 Type *SizeTTy = IntegerType::get(CI->getContext(), SizeTBits);
4474 Value *LenV = ConstantInt::get(SizeTTy, Len);
4475 Value *Ret = emitMemCpyChk(Dst, Src, LenV, ObjSize, B, DL, TLI);
4476 // If the function was an __stpcpy_chk, and we were able to fold it into
4477 // a __memcpy_chk, we still need to return the correct end pointer.
4478 if (Ret && Func == LibFunc_stpcpy_chk)
4479 return B.CreateInBoundsGEP(B.getInt8Ty(), Dst,
4480 ConstantInt::get(SizeTTy, Len - 1));
4481 return copyFlags(*CI, cast<CallInst>(Ret));
4482}
4483
4484Value *FortifiedLibCallSimplifier::optimizeStrLenChk(CallInst *CI,
4485 IRBuilderBase &B) {
4486 if (isFortifiedCallFoldable(CI, 1, std::nullopt, 0))
4487 return copyFlags(*CI, emitStrLen(CI->getArgOperand(0), B,
4488 CI->getDataLayout(), TLI));
4489 return nullptr;
4490}
4491
4492Value *FortifiedLibCallSimplifier::optimizeStrpNCpyChk(CallInst *CI,
4494 LibFunc Func) {
4495 if (isFortifiedCallFoldable(CI, 3, 2)) {
4496 if (Func == LibFunc_strncpy_chk)
4497 return copyFlags(*CI,
4499 CI->getArgOperand(2), B, TLI));
4500 else
4501 return copyFlags(*CI,
4503 CI->getArgOperand(2), B, TLI));
4504 }
4505
4506 return nullptr;
4507}
4508
4509Value *FortifiedLibCallSimplifier::optimizeMemCCpyChk(CallInst *CI,
4510 IRBuilderBase &B) {
4511 if (isFortifiedCallFoldable(CI, 4, 3))
4512 return copyFlags(
4513 *CI, emitMemCCpy(CI->getArgOperand(0), CI->getArgOperand(1),
4514 CI->getArgOperand(2), CI->getArgOperand(3), B, TLI));
4515
4516 return nullptr;
4517}
4518
4519Value *FortifiedLibCallSimplifier::optimizeSNPrintfChk(CallInst *CI,
4520 IRBuilderBase &B) {
4521 if (isFortifiedCallFoldable(CI, 3, 1, std::nullopt, 2)) {
4522 SmallVector<Value *, 8> VariadicArgs(drop_begin(CI->args(), 5));
4523 return copyFlags(*CI,
4525 CI->getArgOperand(4), VariadicArgs, B, TLI));
4526 }
4527
4528 return nullptr;
4529}
4530
4531Value *FortifiedLibCallSimplifier::optimizeSPrintfChk(CallInst *CI,
4532 IRBuilderBase &B) {
4533 if (isFortifiedCallFoldable(CI, 2, std::nullopt, std::nullopt, 1)) {
4534 SmallVector<Value *, 8> VariadicArgs(drop_begin(CI->args(), 4));
4535 return copyFlags(*CI,
4537 VariadicArgs, B, TLI));
4538 }
4539
4540 return nullptr;
4541}
4542
4543Value *FortifiedLibCallSimplifier::optimizeStrCatChk(CallInst *CI,
4544 IRBuilderBase &B) {
4545 if (isFortifiedCallFoldable(CI, 2))
4546 return copyFlags(
4547 *CI, emitStrCat(CI->getArgOperand(0), CI->getArgOperand(1), B, TLI));
4548
4549 return nullptr;
4550}
4551
4552Value *FortifiedLibCallSimplifier::optimizeStrLCat(CallInst *CI,
4553 IRBuilderBase &B) {
4554 if (isFortifiedCallFoldable(CI, 3))
4555 return copyFlags(*CI,
4557 CI->getArgOperand(2), B, TLI));
4558
4559 return nullptr;
4560}
4561
4562Value *FortifiedLibCallSimplifier::optimizeStrNCatChk(CallInst *CI,
4563 IRBuilderBase &B) {
4564 if (isFortifiedCallFoldable(CI, 3))
4565 return copyFlags(*CI,
4567 CI->getArgOperand(2), B, TLI));
4568
4569 return nullptr;
4570}
4571
4572Value *FortifiedLibCallSimplifier::optimizeStrLCpyChk(CallInst *CI,
4573 IRBuilderBase &B) {
4574 if (isFortifiedCallFoldable(CI, 3))
4575 return copyFlags(*CI,
4577 CI->getArgOperand(2), B, TLI));
4578
4579 return nullptr;
4580}
4581
4582Value *FortifiedLibCallSimplifier::optimizeVSNPrintfChk(CallInst *CI,
4583 IRBuilderBase &B) {
4584 if (isFortifiedCallFoldable(CI, 3, 1, std::nullopt, 2))
4585 return copyFlags(
4586 *CI, emitVSNPrintf(CI->getArgOperand(0), CI->getArgOperand(1),
4587 CI->getArgOperand(4), CI->getArgOperand(5), B, TLI));
4588
4589 return nullptr;
4590}
4591
4592Value *FortifiedLibCallSimplifier::optimizeVSPrintfChk(CallInst *CI,
4593 IRBuilderBase &B) {
4594 if (isFortifiedCallFoldable(CI, 2, std::nullopt, std::nullopt, 1))
4595 return copyFlags(*CI,
4597 CI->getArgOperand(4), B, TLI));
4598
4599 return nullptr;
4600}
4601
4603 IRBuilderBase &Builder) {
4604 // FIXME: We shouldn't be changing "nobuiltin" or TLI unavailable calls here.
4605 // Some clang users checked for _chk libcall availability using:
4606 // __has_builtin(__builtin___memcpy_chk)
4607 // When compiling with -fno-builtin, this is always true.
4608 // When passing -ffreestanding/-mkernel, which both imply -fno-builtin, we
4609 // end up with fortified libcalls, which isn't acceptable in a freestanding
4610 // environment which only provides their non-fortified counterparts.
4611 //
4612 // Until we change clang and/or teach external users to check for availability
4613 // differently, disregard the "nobuiltin" attribute and TLI::has.
4614 //
4615 // PR23093.
4616
4617 LibFunc Func;
4618 Function *Callee = CI->getCalledFunction();
4619 bool IsCallingConvC = TargetLibraryInfoImpl::isCallingConvCCompatible(CI);
4620
4622 CI->getOperandBundlesAsDefs(OpBundles);
4623
4625 Builder.setDefaultOperandBundles(OpBundles);
4626
4627 // First, check that this is a known library functions and that the prototype
4628 // is correct.
4629 if (!TLI->getLibFunc(*Callee, Func))
4630 return nullptr;
4631
4632 // We never change the calling convention.
4633 if (!ignoreCallingConv(Func) && !IsCallingConvC)
4634 return nullptr;
4635
4636 switch (Func) {
4637 case LibFunc_memcpy_chk:
4638 return optimizeMemCpyChk(CI, Builder);
4639 case LibFunc_mempcpy_chk:
4640 return optimizeMemPCpyChk(CI, Builder);
4641 case LibFunc_memmove_chk:
4642 return optimizeMemMoveChk(CI, Builder);
4643 case LibFunc_memset_chk:
4644 return optimizeMemSetChk(CI, Builder);
4645 case LibFunc_stpcpy_chk:
4646 case LibFunc_strcpy_chk:
4647 return optimizeStrpCpyChk(CI, Builder, Func);
4648 case LibFunc_strlen_chk:
4649 return optimizeStrLenChk(CI, Builder);
4650 case LibFunc_stpncpy_chk:
4651 case LibFunc_strncpy_chk:
4652 return optimizeStrpNCpyChk(CI, Builder, Func);
4653 case LibFunc_memccpy_chk:
4654 return optimizeMemCCpyChk(CI, Builder);
4655 case LibFunc_snprintf_chk:
4656 return optimizeSNPrintfChk(CI, Builder);
4657 case LibFunc_sprintf_chk:
4658 return optimizeSPrintfChk(CI, Builder);
4659 case LibFunc_strcat_chk:
4660 return optimizeStrCatChk(CI, Builder);
4661 case LibFunc_strlcat_chk:
4662 return optimizeStrLCat(CI, Builder);
4663 case LibFunc_strncat_chk:
4664 return optimizeStrNCatChk(CI, Builder);
4665 case LibFunc_strlcpy_chk:
4666 return optimizeStrLCpyChk(CI, Builder);
4667 case LibFunc_vsnprintf_chk:
4668 return optimizeVSNPrintfChk(CI, Builder);
4669 case LibFunc_vsprintf_chk:
4670 return optimizeVSPrintfChk(CI, Builder);
4671 default:
4672 break;
4673 }
4674 return nullptr;
4675}
4676
4678 const TargetLibraryInfo *TLI, bool OnlyLowerUnknownSize)
4679 : 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< 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
Machine Check Debug Module
#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 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:297
static constexpr roundingMode rmTowardZero
Definition APFloat.h:349
static constexpr roundingMode rmTowardNegative
Definition APFloat.h:348
static constexpr roundingMode rmNearestTiesToEven
Definition APFloat.h:345
opStatus
IEEE-754R 7: Default exception handling.
Definition APFloat.h:361
opStatus divide(const APFloat &RHS, roundingMode RM)
Definition APFloat.h:1294
bool isFiniteNonZero() const
Definition APFloat.h:1575
LLVM_ABI opStatus convert(const fltSemantics &ToSemantics, roundingMode RM, bool *losesInfo)
Definition APFloat.cpp:5920
opStatus subtract(const APFloat &RHS, roundingMode RM)
Definition APFloat.h:1276
bool isNegative() const
Definition APFloat.h:1565
LLVM_ABI double convertToDouble() const
Converts this APFloat to host double value.
Definition APFloat.cpp:5979
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:1548
opStatus add(const APFloat &RHS, roundingMode RM)
Definition APFloat.h:1267
const fltSemantics & getSemantics() const
Definition APFloat.h:1573
LLVM_ABI float convertToFloat() const
Converts this APFloat to host float value.
Definition APFloat.cpp:6007
opStatus remainder(const APFloat &RHS)
Definition APFloat.h:1303
opStatus convertToInteger(MutableArrayRef< integerPart > Input, unsigned int Width, bool IsSigned, roundingMode RM, bool *IsExact) const
Definition APFloat.h:1418
bool isInteger() const
Definition APFloat.h:1582
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:461
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:151
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:723
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.
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.
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:47
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.
unsigned ID
LLVM IR allows to use arbitrary numbers as calling convention identifiers.
Definition CallingConv.h:24
@ C
The default llvm calling convention, compatible with C.
Definition CallingConv.h:34
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:395
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:573
@ Length
Definition DWP.cpp:573
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:207
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:1703
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:684
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:232
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:373
#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.