1 //===-- ConstantFolding.cpp - Fold instructions into constants ------------===//
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 defines routines for folding instructions into constants.
10 //
11 // Also, to supplement the basic IR ConstantExpr simplifications,
12 // this file defines some additional folding routines that can make use of
13 // DataLayout information. These functions cannot go in IR due to library
14 // dependency issues.
15 //
16 //===----------------------------------------------------------------------===//
17 
18 #include "llvm/Analysis/ConstantFolding.h"
19 #include "llvm/ADT/APFloat.h"
20 #include "llvm/ADT/APInt.h"
21 #include "llvm/ADT/APSInt.h"
22 #include "llvm/ADT/ArrayRef.h"
23 #include "llvm/ADT/DenseMap.h"
24 #include "llvm/ADT/STLExtras.h"
25 #include "llvm/ADT/SmallVector.h"
26 #include "llvm/ADT/StringRef.h"
27 #include "llvm/Analysis/TargetFolder.h"
28 #include "llvm/Analysis/TargetLibraryInfo.h"
29 #include "llvm/Analysis/ValueTracking.h"
30 #include "llvm/Analysis/VectorUtils.h"
31 #include "llvm/Config/config.h"
32 #include "llvm/IR/Constant.h"
33 #include "llvm/IR/Constants.h"
34 #include "llvm/IR/DataLayout.h"
35 #include "llvm/IR/DerivedTypes.h"
36 #include "llvm/IR/Function.h"
37 #include "llvm/IR/GlobalValue.h"
38 #include "llvm/IR/GlobalVariable.h"
39 #include "llvm/IR/InstrTypes.h"
40 #include "llvm/IR/Instruction.h"
41 #include "llvm/IR/Instructions.h"
42 #include "llvm/IR/IntrinsicInst.h"
43 #include "llvm/IR/Intrinsics.h"
44 #include "llvm/IR/IntrinsicsAArch64.h"
45 #include "llvm/IR/IntrinsicsAMDGPU.h"
46 #include "llvm/IR/IntrinsicsARM.h"
47 #include "llvm/IR/IntrinsicsWebAssembly.h"
48 #include "llvm/IR/IntrinsicsX86.h"
49 #include "llvm/IR/Operator.h"
50 #include "llvm/IR/Type.h"
51 #include "llvm/IR/Value.h"
52 #include "llvm/Support/Casting.h"
53 #include "llvm/Support/ErrorHandling.h"
54 #include "llvm/Support/KnownBits.h"
55 #include "llvm/Support/MathExtras.h"
56 #include <cassert>
57 #include <cerrno>
58 #include <cfenv>
59 #include <cmath>
60 #include <cstddef>
61 #include <cstdint>
62 
63 using namespace llvm;
64 
65 namespace {
66 Constant *SymbolicallyEvaluateGEP(const GEPOperator *GEP,
67                                   ArrayRef<Constant *> Ops,
68                                   const DataLayout &DL,
69                                   const TargetLibraryInfo *TLI,
70                                   bool ForLoadOperand);
71 
72 //===----------------------------------------------------------------------===//
73 // Constant Folding internal helper functions
74 //===----------------------------------------------------------------------===//
75 
76 static Constant *foldConstVectorToAPInt(APInt &Result, Type *DestTy,
77                                         Constant *C, Type *SrcEltTy,
78                                         unsigned NumSrcElts,
79                                         const DataLayout &DL) {
80   // Now that we know that the input value is a vector of integers, just shift
81   // and insert them into our result.
82   unsigned BitShift = DL.getTypeSizeInBits(SrcEltTy);
83   for (unsigned i = 0; i != NumSrcElts; ++i) {
84     Constant *Element;
85     if (DL.isLittleEndian())
86       Element = C->getAggregateElement(NumSrcElts - i - 1);
87     else
88       Element = C->getAggregateElement(i);
89 
90     if (Element && isa<UndefValue>(Element)) {
91       Result <<= BitShift;
92       continue;
93     }
94 
95     auto *ElementCI = dyn_cast_or_null<ConstantInt>(Element);
96     if (!ElementCI)
97       return ConstantExpr::getBitCast(C, DestTy);
98 
99     Result <<= BitShift;
100     Result |= ElementCI->getValue().zextOrSelf(Result.getBitWidth());
101   }
102 
103   return nullptr;
104 }
105 
106 /// Constant fold bitcast, symbolically evaluating it with DataLayout.
107 /// This always returns a non-null constant, but it may be a
108 /// ConstantExpr if unfoldable.
109 Constant *FoldBitCast(Constant *C, Type *DestTy, const DataLayout &DL) {
110   assert(CastInst::castIsValid(Instruction::BitCast, C, DestTy) &&
111          "Invalid constantexpr bitcast!");
112 
113   // Catch the obvious splat cases.
114   if (C->isNullValue() && !DestTy->isX86_MMXTy() && !DestTy->isX86_AMXTy())
115     return Constant::getNullValue(DestTy);
116   if (C->isAllOnesValue() && !DestTy->isX86_MMXTy() && !DestTy->isX86_AMXTy() &&
117       !DestTy->isPtrOrPtrVectorTy()) // Don't get ones for ptr types!
118     return Constant::getAllOnesValue(DestTy);
119 
120   if (auto *VTy = dyn_cast<VectorType>(C->getType())) {
121     // Handle a vector->scalar integer/fp cast.
122     if (isa<IntegerType>(DestTy) || DestTy->isFloatingPointTy()) {
123       unsigned NumSrcElts = cast<FixedVectorType>(VTy)->getNumElements();
124       Type *SrcEltTy = VTy->getElementType();
125 
126       // If the vector is a vector of floating point, convert it to vector of int
127       // to simplify things.
128       if (SrcEltTy->isFloatingPointTy()) {
129         unsigned FPWidth = SrcEltTy->getPrimitiveSizeInBits();
130         auto *SrcIVTy = FixedVectorType::get(
131             IntegerType::get(C->getContext(), FPWidth), NumSrcElts);
132         // Ask IR to do the conversion now that #elts line up.
133         C = ConstantExpr::getBitCast(C, SrcIVTy);
134       }
135 
136       APInt Result(DL.getTypeSizeInBits(DestTy), 0);
137       if (Constant *CE = foldConstVectorToAPInt(Result, DestTy, C,
138                                                 SrcEltTy, NumSrcElts, DL))
139         return CE;
140 
141       if (isa<IntegerType>(DestTy))
142         return ConstantInt::get(DestTy, Result);
143 
144       APFloat FP(DestTy->getFltSemantics(), Result);
145       return ConstantFP::get(DestTy->getContext(), FP);
146     }
147   }
148 
149   // The code below only handles casts to vectors currently.
150   auto *DestVTy = dyn_cast<VectorType>(DestTy);
151   if (!DestVTy)
152     return ConstantExpr::getBitCast(C, DestTy);
153 
154   // If this is a scalar -> vector cast, convert the input into a <1 x scalar>
155   // vector so the code below can handle it uniformly.
156   if (isa<ConstantFP>(C) || isa<ConstantInt>(C)) {
157     Constant *Ops = C; // don't take the address of C!
158     return FoldBitCast(ConstantVector::get(Ops), DestTy, DL);
159   }
160 
161   // If this is a bitcast from constant vector -> vector, fold it.
162   if (!isa<ConstantDataVector>(C) && !isa<ConstantVector>(C))
163     return ConstantExpr::getBitCast(C, DestTy);
164 
165   // If the element types match, IR can fold it.
166   unsigned NumDstElt = cast<FixedVectorType>(DestVTy)->getNumElements();
167   unsigned NumSrcElt = cast<FixedVectorType>(C->getType())->getNumElements();
168   if (NumDstElt == NumSrcElt)
169     return ConstantExpr::getBitCast(C, DestTy);
170 
171   Type *SrcEltTy = cast<VectorType>(C->getType())->getElementType();
172   Type *DstEltTy = DestVTy->getElementType();
173 
174   // Otherwise, we're changing the number of elements in a vector, which
175   // requires endianness information to do the right thing.  For example,
176   //    bitcast (<2 x i64> <i64 0, i64 1> to <4 x i32>)
177   // folds to (little endian):
178   //    <4 x i32> <i32 0, i32 0, i32 1, i32 0>
179   // and to (big endian):
180   //    <4 x i32> <i32 0, i32 0, i32 0, i32 1>
181 
182   // First thing is first.  We only want to think about integer here, so if
183   // we have something in FP form, recast it as integer.
184   if (DstEltTy->isFloatingPointTy()) {
185     // Fold to an vector of integers with same size as our FP type.
186     unsigned FPWidth = DstEltTy->getPrimitiveSizeInBits();
187     auto *DestIVTy = FixedVectorType::get(
188         IntegerType::get(C->getContext(), FPWidth), NumDstElt);
189     // Recursively handle this integer conversion, if possible.
190     C = FoldBitCast(C, DestIVTy, DL);
191 
192     // Finally, IR can handle this now that #elts line up.
193     return ConstantExpr::getBitCast(C, DestTy);
194   }
195 
196   // Okay, we know the destination is integer, if the input is FP, convert
197   // it to integer first.
198   if (SrcEltTy->isFloatingPointTy()) {
199     unsigned FPWidth = SrcEltTy->getPrimitiveSizeInBits();
200     auto *SrcIVTy = FixedVectorType::get(
201         IntegerType::get(C->getContext(), FPWidth), NumSrcElt);
202     // Ask IR to do the conversion now that #elts line up.
203     C = ConstantExpr::getBitCast(C, SrcIVTy);
204     // If IR wasn't able to fold it, bail out.
205     if (!isa<ConstantVector>(C) &&  // FIXME: Remove ConstantVector.
206         !isa<ConstantDataVector>(C))
207       return C;
208   }
209 
210   // Now we know that the input and output vectors are both integer vectors
211   // of the same size, and that their #elements is not the same.  Do the
212   // conversion here, which depends on whether the input or output has
213   // more elements.
214   bool isLittleEndian = DL.isLittleEndian();
215 
216   SmallVector<Constant*, 32> Result;
217   if (NumDstElt < NumSrcElt) {
218     // Handle: bitcast (<4 x i32> <i32 0, i32 1, i32 2, i32 3> to <2 x i64>)
219     Constant *Zero = Constant::getNullValue(DstEltTy);
220     unsigned Ratio = NumSrcElt/NumDstElt;
221     unsigned SrcBitSize = SrcEltTy->getPrimitiveSizeInBits();
222     unsigned SrcElt = 0;
223     for (unsigned i = 0; i != NumDstElt; ++i) {
224       // Build each element of the result.
225       Constant *Elt = Zero;
226       unsigned ShiftAmt = isLittleEndian ? 0 : SrcBitSize*(Ratio-1);
227       for (unsigned j = 0; j != Ratio; ++j) {
228         Constant *Src = C->getAggregateElement(SrcElt++);
229         if (Src && isa<UndefValue>(Src))
230           Src = Constant::getNullValue(
231               cast<VectorType>(C->getType())->getElementType());
232         else
233           Src = dyn_cast_or_null<ConstantInt>(Src);
234         if (!Src)  // Reject constantexpr elements.
235           return ConstantExpr::getBitCast(C, DestTy);
236 
237         // Zero extend the element to the right size.
238         Src = ConstantExpr::getZExt(Src, Elt->getType());
239 
240         // Shift it to the right place, depending on endianness.
241         Src = ConstantExpr::getShl(Src,
242                                    ConstantInt::get(Src->getType(), ShiftAmt));
243         ShiftAmt += isLittleEndian ? SrcBitSize : -SrcBitSize;
244 
245         // Mix it in.
246         Elt = ConstantExpr::getOr(Elt, Src);
247       }
248       Result.push_back(Elt);
249     }
250     return ConstantVector::get(Result);
251   }
252 
253   // Handle: bitcast (<2 x i64> <i64 0, i64 1> to <4 x i32>)
254   unsigned Ratio = NumDstElt/NumSrcElt;
255   unsigned DstBitSize = DL.getTypeSizeInBits(DstEltTy);
256 
257   // Loop over each source value, expanding into multiple results.
258   for (unsigned i = 0; i != NumSrcElt; ++i) {
259     auto *Element = C->getAggregateElement(i);
260 
261     if (!Element) // Reject constantexpr elements.
262       return ConstantExpr::getBitCast(C, DestTy);
263 
264     if (isa<UndefValue>(Element)) {
265       // Correctly Propagate undef values.
266       Result.append(Ratio, UndefValue::get(DstEltTy));
267       continue;
268     }
269 
270     auto *Src = dyn_cast<ConstantInt>(Element);
271     if (!Src)
272       return ConstantExpr::getBitCast(C, DestTy);
273 
274     unsigned ShiftAmt = isLittleEndian ? 0 : DstBitSize*(Ratio-1);
275     for (unsigned j = 0; j != Ratio; ++j) {
276       // Shift the piece of the value into the right place, depending on
277       // endianness.
278       Constant *Elt = ConstantExpr::getLShr(Src,
279                                   ConstantInt::get(Src->getType(), ShiftAmt));
280       ShiftAmt += isLittleEndian ? DstBitSize : -DstBitSize;
281 
282       // Truncate the element to an integer with the same pointer size and
283       // convert the element back to a pointer using a inttoptr.
284       if (DstEltTy->isPointerTy()) {
285         IntegerType *DstIntTy = Type::getIntNTy(C->getContext(), DstBitSize);
286         Constant *CE = ConstantExpr::getTrunc(Elt, DstIntTy);
287         Result.push_back(ConstantExpr::getIntToPtr(CE, DstEltTy));
288         continue;
289       }
290 
291       // Truncate and remember this piece.
292       Result.push_back(ConstantExpr::getTrunc(Elt, DstEltTy));
293     }
294   }
295 
296   return ConstantVector::get(Result);
297 }
298 
299 } // end anonymous namespace
300 
301 /// If this constant is a constant offset from a global, return the global and
302 /// the constant. Because of constantexprs, this function is recursive.
303 bool llvm::IsConstantOffsetFromGlobal(Constant *C, GlobalValue *&GV,
304                                       APInt &Offset, const DataLayout &DL,
305                                       DSOLocalEquivalent **DSOEquiv) {
306   if (DSOEquiv)
307     *DSOEquiv = nullptr;
308 
309   // Trivial case, constant is the global.
310   if ((GV = dyn_cast<GlobalValue>(C))) {
311     unsigned BitWidth = DL.getIndexTypeSizeInBits(GV->getType());
312     Offset = APInt(BitWidth, 0);
313     return true;
314   }
315 
316   if (auto *FoundDSOEquiv = dyn_cast<DSOLocalEquivalent>(C)) {
317     if (DSOEquiv)
318       *DSOEquiv = FoundDSOEquiv;
319     GV = FoundDSOEquiv->getGlobalValue();
320     unsigned BitWidth = DL.getIndexTypeSizeInBits(GV->getType());
321     Offset = APInt(BitWidth, 0);
322     return true;
323   }
324 
325   // Otherwise, if this isn't a constant expr, bail out.
326   auto *CE = dyn_cast<ConstantExpr>(C);
327   if (!CE) return false;
328 
329   // Look through ptr->int and ptr->ptr casts.
330   if (CE->getOpcode() == Instruction::PtrToInt ||
331       CE->getOpcode() == Instruction::BitCast)
332     return IsConstantOffsetFromGlobal(CE->getOperand(0), GV, Offset, DL,
333                                       DSOEquiv);
334 
335   // i32* getelementptr ([5 x i32]* @a, i32 0, i32 5)
336   auto *GEP = dyn_cast<GEPOperator>(CE);
337   if (!GEP)
338     return false;
339 
340   unsigned BitWidth = DL.getIndexTypeSizeInBits(GEP->getType());
341   APInt TmpOffset(BitWidth, 0);
342 
343   // If the base isn't a global+constant, we aren't either.
344   if (!IsConstantOffsetFromGlobal(CE->getOperand(0), GV, TmpOffset, DL,
345                                   DSOEquiv))
346     return false;
347 
348   // Otherwise, add any offset that our operands provide.
349   if (!GEP->accumulateConstantOffset(DL, TmpOffset))
350     return false;
351 
352   Offset = TmpOffset;
353   return true;
354 }
355 
356 Constant *llvm::ConstantFoldLoadThroughBitcast(Constant *C, Type *DestTy,
357                                          const DataLayout &DL) {
358   do {
359     Type *SrcTy = C->getType();
360     uint64_t DestSize = DL.getTypeSizeInBits(DestTy);
361     uint64_t SrcSize = DL.getTypeSizeInBits(SrcTy);
362     if (SrcSize < DestSize)
363       return nullptr;
364 
365     // Catch the obvious splat cases (since all-zeros can coerce non-integral
366     // pointers legally).
367     if (C->isNullValue() && !DestTy->isX86_MMXTy() && !DestTy->isX86_AMXTy())
368       return Constant::getNullValue(DestTy);
369     if (C->isAllOnesValue() &&
370         (DestTy->isIntegerTy() || DestTy->isFloatingPointTy() ||
371          DestTy->isVectorTy()) &&
372         !DestTy->isX86_AMXTy() && !DestTy->isX86_MMXTy() &&
373         !DestTy->isPtrOrPtrVectorTy())
374       // Get ones when the input is trivial, but
375       // only for supported types inside getAllOnesValue.
376       return Constant::getAllOnesValue(DestTy);
377 
378     // If the type sizes are the same and a cast is legal, just directly
379     // cast the constant.
380     // But be careful not to coerce non-integral pointers illegally.
381     if (SrcSize == DestSize &&
382         DL.isNonIntegralPointerType(SrcTy->getScalarType()) ==
383             DL.isNonIntegralPointerType(DestTy->getScalarType())) {
384       Instruction::CastOps Cast = Instruction::BitCast;
385       // If we are going from a pointer to int or vice versa, we spell the cast
386       // differently.
387       if (SrcTy->isIntegerTy() && DestTy->isPointerTy())
388         Cast = Instruction::IntToPtr;
389       else if (SrcTy->isPointerTy() && DestTy->isIntegerTy())
390         Cast = Instruction::PtrToInt;
391 
392       if (CastInst::castIsValid(Cast, C, DestTy))
393         return ConstantExpr::getCast(Cast, C, DestTy);
394     }
395 
396     // If this isn't an aggregate type, there is nothing we can do to drill down
397     // and find a bitcastable constant.
398     if (!SrcTy->isAggregateType() && !SrcTy->isVectorTy())
399       return nullptr;
400 
401     // We're simulating a load through a pointer that was bitcast to point to
402     // a different type, so we can try to walk down through the initial
403     // elements of an aggregate to see if some part of the aggregate is
404     // castable to implement the "load" semantic model.
405     if (SrcTy->isStructTy()) {
406       // Struct types might have leading zero-length elements like [0 x i32],
407       // which are certainly not what we are looking for, so skip them.
408       unsigned Elem = 0;
409       Constant *ElemC;
410       do {
411         ElemC = C->getAggregateElement(Elem++);
412       } while (ElemC && DL.getTypeSizeInBits(ElemC->getType()).isZero());
413       C = ElemC;
414     } else {
415       C = C->getAggregateElement(0u);
416     }
417   } while (C);
418 
419   return nullptr;
420 }
421 
422 namespace {
423 
424 /// Recursive helper to read bits out of global. C is the constant being copied
425 /// out of. ByteOffset is an offset into C. CurPtr is the pointer to copy
426 /// results into and BytesLeft is the number of bytes left in
427 /// the CurPtr buffer. DL is the DataLayout.
428 bool ReadDataFromGlobal(Constant *C, uint64_t ByteOffset, unsigned char *CurPtr,
429                         unsigned BytesLeft, const DataLayout &DL) {
430   assert(ByteOffset <= DL.getTypeAllocSize(C->getType()) &&
431          "Out of range access");
432 
433   // If this element is zero or undefined, we can just return since *CurPtr is
434   // zero initialized.
435   if (isa<ConstantAggregateZero>(C) || isa<UndefValue>(C))
436     return true;
437 
438   if (auto *CI = dyn_cast<ConstantInt>(C)) {
439     if (CI->getBitWidth() > 64 ||
440         (CI->getBitWidth() & 7) != 0)
441       return false;
442 
443     uint64_t Val = CI->getZExtValue();
444     unsigned IntBytes = unsigned(CI->getBitWidth()/8);
445 
446     for (unsigned i = 0; i != BytesLeft && ByteOffset != IntBytes; ++i) {
447       int n = ByteOffset;
448       if (!DL.isLittleEndian())
449         n = IntBytes - n - 1;
450       CurPtr[i] = (unsigned char)(Val >> (n * 8));
451       ++ByteOffset;
452     }
453     return true;
454   }
455 
456   if (auto *CFP = dyn_cast<ConstantFP>(C)) {
457     if (CFP->getType()->isDoubleTy()) {
458       C = FoldBitCast(C, Type::getInt64Ty(C->getContext()), DL);
459       return ReadDataFromGlobal(C, ByteOffset, CurPtr, BytesLeft, DL);
460     }
461     if (CFP->getType()->isFloatTy()){
462       C = FoldBitCast(C, Type::getInt32Ty(C->getContext()), DL);
463       return ReadDataFromGlobal(C, ByteOffset, CurPtr, BytesLeft, DL);
464     }
465     if (CFP->getType()->isHalfTy()){
466       C = FoldBitCast(C, Type::getInt16Ty(C->getContext()), DL);
467       return ReadDataFromGlobal(C, ByteOffset, CurPtr, BytesLeft, DL);
468     }
469     return false;
470   }
471 
472   if (auto *CS = dyn_cast<ConstantStruct>(C)) {
473     const StructLayout *SL = DL.getStructLayout(CS->getType());
474     unsigned Index = SL->getElementContainingOffset(ByteOffset);
475     uint64_t CurEltOffset = SL->getElementOffset(Index);
476     ByteOffset -= CurEltOffset;
477 
478     while (true) {
479       // If the element access is to the element itself and not to tail padding,
480       // read the bytes from the element.
481       uint64_t EltSize = DL.getTypeAllocSize(CS->getOperand(Index)->getType());
482 
483       if (ByteOffset < EltSize &&
484           !ReadDataFromGlobal(CS->getOperand(Index), ByteOffset, CurPtr,
485                               BytesLeft, DL))
486         return false;
487 
488       ++Index;
489 
490       // Check to see if we read from the last struct element, if so we're done.
491       if (Index == CS->getType()->getNumElements())
492         return true;
493 
494       // If we read all of the bytes we needed from this element we're done.
495       uint64_t NextEltOffset = SL->getElementOffset(Index);
496 
497       if (BytesLeft <= NextEltOffset - CurEltOffset - ByteOffset)
498         return true;
499 
500       // Move to the next element of the struct.
501       CurPtr += NextEltOffset - CurEltOffset - ByteOffset;
502       BytesLeft -= NextEltOffset - CurEltOffset - ByteOffset;
503       ByteOffset = 0;
504       CurEltOffset = NextEltOffset;
505     }
506     // not reached.
507   }
508 
509   if (isa<ConstantArray>(C) || isa<ConstantVector>(C) ||
510       isa<ConstantDataSequential>(C)) {
511     uint64_t NumElts;
512     Type *EltTy;
513     if (auto *AT = dyn_cast<ArrayType>(C->getType())) {
514       NumElts = AT->getNumElements();
515       EltTy = AT->getElementType();
516     } else {
517       NumElts = cast<FixedVectorType>(C->getType())->getNumElements();
518       EltTy = cast<FixedVectorType>(C->getType())->getElementType();
519     }
520     uint64_t EltSize = DL.getTypeAllocSize(EltTy);
521     uint64_t Index = ByteOffset / EltSize;
522     uint64_t Offset = ByteOffset - Index * EltSize;
523 
524     for (; Index != NumElts; ++Index) {
525       if (!ReadDataFromGlobal(C->getAggregateElement(Index), Offset, CurPtr,
526                               BytesLeft, DL))
527         return false;
528 
529       uint64_t BytesWritten = EltSize - Offset;
530       assert(BytesWritten <= EltSize && "Not indexing into this element?");
531       if (BytesWritten >= BytesLeft)
532         return true;
533 
534       Offset = 0;
535       BytesLeft -= BytesWritten;
536       CurPtr += BytesWritten;
537     }
538     return true;
539   }
540 
541   if (auto *CE = dyn_cast<ConstantExpr>(C)) {
542     if (CE->getOpcode() == Instruction::IntToPtr &&
543         CE->getOperand(0)->getType() == DL.getIntPtrType(CE->getType())) {
544       return ReadDataFromGlobal(CE->getOperand(0), ByteOffset, CurPtr,
545                                 BytesLeft, DL);
546     }
547   }
548 
549   // Otherwise, unknown initializer type.
550   return false;
551 }
552 
553 Constant *FoldReinterpretLoadFromConstPtr(Constant *C, Type *LoadTy,
554                                           const DataLayout &DL) {
555   // Bail out early. Not expect to load from scalable global variable.
556   if (isa<ScalableVectorType>(LoadTy))
557     return nullptr;
558 
559   auto *PTy = cast<PointerType>(C->getType());
560   auto *IntType = dyn_cast<IntegerType>(LoadTy);
561 
562   // If this isn't an integer load we can't fold it directly.
563   if (!IntType) {
564     unsigned AS = PTy->getAddressSpace();
565 
566     // If this is a float/double load, we can try folding it as an int32/64 load
567     // and then bitcast the result.  This can be useful for union cases.  Note
568     // that address spaces don't matter here since we're not going to result in
569     // an actual new load.
570     Type *MapTy;
571     if (LoadTy->isHalfTy())
572       MapTy = Type::getInt16Ty(C->getContext());
573     else if (LoadTy->isFloatTy())
574       MapTy = Type::getInt32Ty(C->getContext());
575     else if (LoadTy->isDoubleTy())
576       MapTy = Type::getInt64Ty(C->getContext());
577     else if (LoadTy->isVectorTy()) {
578       MapTy = PointerType::getIntNTy(
579           C->getContext(), DL.getTypeSizeInBits(LoadTy).getFixedSize());
580     } else
581       return nullptr;
582 
583     C = FoldBitCast(C, MapTy->getPointerTo(AS), DL);
584     if (Constant *Res = FoldReinterpretLoadFromConstPtr(C, MapTy, DL)) {
585       if (Res->isNullValue() && !LoadTy->isX86_MMXTy() &&
586           !LoadTy->isX86_AMXTy())
587         // Materializing a zero can be done trivially without a bitcast
588         return Constant::getNullValue(LoadTy);
589       Type *CastTy = LoadTy->isPtrOrPtrVectorTy() ? DL.getIntPtrType(LoadTy) : LoadTy;
590       Res = FoldBitCast(Res, CastTy, DL);
591       if (LoadTy->isPtrOrPtrVectorTy()) {
592         // For vector of pointer, we needed to first convert to a vector of integer, then do vector inttoptr
593         if (Res->isNullValue() && !LoadTy->isX86_MMXTy() &&
594             !LoadTy->isX86_AMXTy())
595           return Constant::getNullValue(LoadTy);
596         if (DL.isNonIntegralPointerType(LoadTy->getScalarType()))
597           // Be careful not to replace a load of an addrspace value with an inttoptr here
598           return nullptr;
599         Res = ConstantExpr::getCast(Instruction::IntToPtr, Res, LoadTy);
600       }
601       return Res;
602     }
603     return nullptr;
604   }
605 
606   unsigned BytesLoaded = (IntType->getBitWidth() + 7) / 8;
607   if (BytesLoaded > 32 || BytesLoaded == 0)
608     return nullptr;
609 
610   GlobalValue *GVal;
611   APInt OffsetAI;
612   if (!IsConstantOffsetFromGlobal(C, GVal, OffsetAI, DL))
613     return nullptr;
614 
615   auto *GV = dyn_cast<GlobalVariable>(GVal);
616   if (!GV || !GV->isConstant() || !GV->hasDefinitiveInitializer() ||
617       !GV->getInitializer()->getType()->isSized())
618     return nullptr;
619 
620   int64_t Offset = OffsetAI.getSExtValue();
621   int64_t InitializerSize =
622       DL.getTypeAllocSize(GV->getInitializer()->getType()).getFixedSize();
623 
624   // If we're not accessing anything in this constant, the result is undefined.
625   if (Offset <= -1 * static_cast<int64_t>(BytesLoaded))
626     return UndefValue::get(IntType);
627 
628   // If we're not accessing anything in this constant, the result is undefined.
629   if (Offset >= InitializerSize)
630     return UndefValue::get(IntType);
631 
632   unsigned char RawBytes[32] = {0};
633   unsigned char *CurPtr = RawBytes;
634   unsigned BytesLeft = BytesLoaded;
635 
636   // If we're loading off the beginning of the global, some bytes may be valid.
637   if (Offset < 0) {
638     CurPtr += -Offset;
639     BytesLeft += Offset;
640     Offset = 0;
641   }
642 
643   if (!ReadDataFromGlobal(GV->getInitializer(), Offset, CurPtr, BytesLeft, DL))
644     return nullptr;
645 
646   APInt ResultVal = APInt(IntType->getBitWidth(), 0);
647   if (DL.isLittleEndian()) {
648     ResultVal = RawBytes[BytesLoaded - 1];
649     for (unsigned i = 1; i != BytesLoaded; ++i) {
650       ResultVal <<= 8;
651       ResultVal |= RawBytes[BytesLoaded - 1 - i];
652     }
653   } else {
654     ResultVal = RawBytes[0];
655     for (unsigned i = 1; i != BytesLoaded; ++i) {
656       ResultVal <<= 8;
657       ResultVal |= RawBytes[i];
658     }
659   }
660 
661   return ConstantInt::get(IntType->getContext(), ResultVal);
662 }
663 
664 Constant *ConstantFoldLoadThroughBitcastExpr(ConstantExpr *CE, Type *DestTy,
665                                              const DataLayout &DL) {
666   auto *SrcPtr = CE->getOperand(0);
667   if (!SrcPtr->getType()->isPointerTy())
668     return nullptr;
669 
670   return ConstantFoldLoadFromConstPtr(SrcPtr, DestTy, DL);
671 }
672 
673 } // end anonymous namespace
674 
675 Constant *llvm::ConstantFoldLoadFromConstPtr(Constant *C, Type *Ty,
676                                              const DataLayout &DL) {
677   // First, try the easy cases:
678   if (auto *GV = dyn_cast<GlobalVariable>(C))
679     if (GV->isConstant() && GV->hasDefinitiveInitializer())
680       return ConstantFoldLoadThroughBitcast(GV->getInitializer(), Ty, DL);
681 
682   if (auto *GA = dyn_cast<GlobalAlias>(C))
683     if (GA->getAliasee() && !GA->isInterposable())
684       return ConstantFoldLoadFromConstPtr(GA->getAliasee(), Ty, DL);
685 
686   // If the loaded value isn't a constant expr, we can't handle it.
687   auto *CE = dyn_cast<ConstantExpr>(C);
688   if (!CE)
689     return nullptr;
690 
691   if (CE->getOpcode() == Instruction::GetElementPtr) {
692     if (auto *GV = dyn_cast<GlobalVariable>(CE->getOperand(0))) {
693       if (GV->isConstant() && GV->hasDefinitiveInitializer()) {
694         if (Constant *V = ConstantFoldLoadThroughGEPConstantExpr(
695                 GV->getInitializer(), CE, Ty, DL))
696           return V;
697       }
698     } else {
699       // Try to simplify GEP if the pointer operand wasn't a GlobalVariable.
700       // SymbolicallyEvaluateGEP() with `ForLoadOperand = true` can potentially
701       // simplify the GEP more than it normally would have been, but should only
702       // be used for const folding loads.
703       SmallVector<Constant *> Ops;
704       for (unsigned I = 0, E = CE->getNumOperands(); I != E; ++I)
705         Ops.push_back(cast<Constant>(CE->getOperand(I)));
706       if (auto *Simplified = dyn_cast_or_null<ConstantExpr>(
707               SymbolicallyEvaluateGEP(cast<GEPOperator>(CE), Ops, DL, nullptr,
708                                       /*ForLoadOperand*/ true))) {
709         // If the symbolically evaluated GEP is another GEP, we can only const
710         // fold it if the resulting pointer operand is a GlobalValue. Otherwise
711         // there is nothing else to simplify since the GEP is already in the
712         // most simplified form.
713         if (isa<GEPOperator>(Simplified)) {
714           if (auto *GV = dyn_cast<GlobalVariable>(Simplified->getOperand(0))) {
715             if (GV->isConstant() && GV->hasDefinitiveInitializer()) {
716               if (Constant *V = ConstantFoldLoadThroughGEPConstantExpr(
717                       GV->getInitializer(), Simplified, Ty, DL))
718                 return V;
719             }
720           }
721         } else {
722           return ConstantFoldLoadFromConstPtr(Simplified, Ty, DL);
723         }
724       }
725     }
726   }
727 
728   if (CE->getOpcode() == Instruction::BitCast)
729     if (Constant *LoadedC = ConstantFoldLoadThroughBitcastExpr(CE, Ty, DL))
730       return LoadedC;
731 
732   // Instead of loading constant c string, use corresponding integer value
733   // directly if string length is small enough.
734   StringRef Str;
735   if (getConstantStringInfo(CE, Str) && !Str.empty()) {
736     size_t StrLen = Str.size();
737     unsigned NumBits = Ty->getPrimitiveSizeInBits();
738     // Replace load with immediate integer if the result is an integer or fp
739     // value.
740     if ((NumBits >> 3) == StrLen + 1 && (NumBits & 7) == 0 &&
741         (isa<IntegerType>(Ty) || Ty->isFloatingPointTy())) {
742       APInt StrVal(NumBits, 0);
743       APInt SingleChar(NumBits, 0);
744       if (DL.isLittleEndian()) {
745         for (unsigned char C : reverse(Str.bytes())) {
746           SingleChar = static_cast<uint64_t>(C);
747           StrVal = (StrVal << 8) | SingleChar;
748         }
749       } else {
750         for (unsigned char C : Str.bytes()) {
751           SingleChar = static_cast<uint64_t>(C);
752           StrVal = (StrVal << 8) | SingleChar;
753         }
754         // Append NULL at the end.
755         SingleChar = 0;
756         StrVal = (StrVal << 8) | SingleChar;
757       }
758 
759       Constant *Res = ConstantInt::get(CE->getContext(), StrVal);
760       if (Ty->isFloatingPointTy())
761         Res = ConstantExpr::getBitCast(Res, Ty);
762       return Res;
763     }
764   }
765 
766   // If this load comes from anywhere in a constant global, and if the global
767   // is all undef or zero, we know what it loads.
768   if (auto *GV = dyn_cast<GlobalVariable>(getUnderlyingObject(CE))) {
769     if (GV->isConstant() && GV->hasDefinitiveInitializer()) {
770       if (GV->getInitializer()->isNullValue())
771         return Constant::getNullValue(Ty);
772       if (isa<UndefValue>(GV->getInitializer()))
773         return UndefValue::get(Ty);
774     }
775   }
776 
777   // Try hard to fold loads from bitcasted strange and non-type-safe things.
778   return FoldReinterpretLoadFromConstPtr(CE, Ty, DL);
779 }
780 
781 namespace {
782 
783 /// One of Op0/Op1 is a constant expression.
784 /// Attempt to symbolically evaluate the result of a binary operator merging
785 /// these together.  If target data info is available, it is provided as DL,
786 /// otherwise DL is null.
787 Constant *SymbolicallyEvaluateBinop(unsigned Opc, Constant *Op0, Constant *Op1,
788                                     const DataLayout &DL) {
789   // SROA
790 
791   // Fold (and 0xffffffff00000000, (shl x, 32)) -> shl.
792   // Fold (lshr (or X, Y), 32) -> (lshr [X/Y], 32) if one doesn't contribute
793   // bits.
794 
795   if (Opc == Instruction::And) {
796     KnownBits Known0 = computeKnownBits(Op0, DL);
797     KnownBits Known1 = computeKnownBits(Op1, DL);
798     if ((Known1.One | Known0.Zero).isAllOnesValue()) {
799       // All the bits of Op0 that the 'and' could be masking are already zero.
800       return Op0;
801     }
802     if ((Known0.One | Known1.Zero).isAllOnesValue()) {
803       // All the bits of Op1 that the 'and' could be masking are already zero.
804       return Op1;
805     }
806 
807     Known0 &= Known1;
808     if (Known0.isConstant())
809       return ConstantInt::get(Op0->getType(), Known0.getConstant());
810   }
811 
812   // If the constant expr is something like &A[123] - &A[4].f, fold this into a
813   // constant.  This happens frequently when iterating over a global array.
814   if (Opc == Instruction::Sub) {
815     GlobalValue *GV1, *GV2;
816     APInt Offs1, Offs2;
817 
818     if (IsConstantOffsetFromGlobal(Op0, GV1, Offs1, DL))
819       if (IsConstantOffsetFromGlobal(Op1, GV2, Offs2, DL) && GV1 == GV2) {
820         unsigned OpSize = DL.getTypeSizeInBits(Op0->getType());
821 
822         // (&GV+C1) - (&GV+C2) -> C1-C2, pointer arithmetic cannot overflow.
823         // PtrToInt may change the bitwidth so we have convert to the right size
824         // first.
825         return ConstantInt::get(Op0->getType(), Offs1.zextOrTrunc(OpSize) -
826                                                 Offs2.zextOrTrunc(OpSize));
827       }
828   }
829 
830   return nullptr;
831 }
832 
833 /// If array indices are not pointer-sized integers, explicitly cast them so
834 /// that they aren't implicitly casted by the getelementptr.
835 Constant *CastGEPIndices(Type *SrcElemTy, ArrayRef<Constant *> Ops,
836                          Type *ResultTy, Optional<unsigned> InRangeIndex,
837                          const DataLayout &DL, const TargetLibraryInfo *TLI) {
838   Type *IntIdxTy = DL.getIndexType(ResultTy);
839   Type *IntIdxScalarTy = IntIdxTy->getScalarType();
840 
841   bool Any = false;
842   SmallVector<Constant*, 32> NewIdxs;
843   for (unsigned i = 1, e = Ops.size(); i != e; ++i) {
844     if ((i == 1 ||
845          !isa<StructType>(GetElementPtrInst::getIndexedType(
846              SrcElemTy, Ops.slice(1, i - 1)))) &&
847         Ops[i]->getType()->getScalarType() != IntIdxScalarTy) {
848       Any = true;
849       Type *NewType = Ops[i]->getType()->isVectorTy()
850                           ? IntIdxTy
851                           : IntIdxScalarTy;
852       NewIdxs.push_back(ConstantExpr::getCast(CastInst::getCastOpcode(Ops[i],
853                                                                       true,
854                                                                       NewType,
855                                                                       true),
856                                               Ops[i], NewType));
857     } else
858       NewIdxs.push_back(Ops[i]);
859   }
860 
861   if (!Any)
862     return nullptr;
863 
864   Constant *C = ConstantExpr::getGetElementPtr(
865       SrcElemTy, Ops[0], NewIdxs, /*InBounds=*/false, InRangeIndex);
866   return ConstantFoldConstant(C, DL, TLI);
867 }
868 
869 /// Strip the pointer casts, but preserve the address space information.
870 Constant *StripPtrCastKeepAS(Constant *Ptr, bool ForLoadOperand) {
871   assert(Ptr->getType()->isPointerTy() && "Not a pointer type");
872   auto *OldPtrTy = cast<PointerType>(Ptr->getType());
873   Ptr = cast<Constant>(Ptr->stripPointerCasts());
874   if (ForLoadOperand) {
875     while (isa<GlobalAlias>(Ptr) && !cast<GlobalAlias>(Ptr)->isInterposable() &&
876            !cast<GlobalAlias>(Ptr)->getBaseObject()->isInterposable()) {
877       Ptr = cast<GlobalAlias>(Ptr)->getAliasee();
878     }
879   }
880 
881   auto *NewPtrTy = cast<PointerType>(Ptr->getType());
882 
883   // Preserve the address space number of the pointer.
884   if (NewPtrTy->getAddressSpace() != OldPtrTy->getAddressSpace()) {
885     Ptr = ConstantExpr::getPointerCast(
886         Ptr, PointerType::getWithSamePointeeType(NewPtrTy,
887                                                  OldPtrTy->getAddressSpace()));
888   }
889   return Ptr;
890 }
891 
892 /// If we can symbolically evaluate the GEP constant expression, do so.
893 Constant *SymbolicallyEvaluateGEP(const GEPOperator *GEP,
894                                   ArrayRef<Constant *> Ops,
895                                   const DataLayout &DL,
896                                   const TargetLibraryInfo *TLI,
897                                   bool ForLoadOperand) {
898   const GEPOperator *InnermostGEP = GEP;
899   bool InBounds = GEP->isInBounds();
900 
901   Type *SrcElemTy = GEP->getSourceElementType();
902   Type *ResElemTy = GEP->getResultElementType();
903   Type *ResTy = GEP->getType();
904   if (!SrcElemTy->isSized() || isa<ScalableVectorType>(SrcElemTy))
905     return nullptr;
906 
907   if (Constant *C = CastGEPIndices(SrcElemTy, Ops, ResTy,
908                                    GEP->getInRangeIndex(), DL, TLI))
909     return C;
910 
911   Constant *Ptr = Ops[0];
912   if (!Ptr->getType()->isPointerTy())
913     return nullptr;
914 
915   Type *IntIdxTy = DL.getIndexType(Ptr->getType());
916 
917   // If this is "gep i8* Ptr, (sub 0, V)", fold this as:
918   // "inttoptr (sub (ptrtoint Ptr), V)"
919   if (Ops.size() == 2 && ResElemTy->isIntegerTy(8)) {
920     auto *CE = dyn_cast<ConstantExpr>(Ops[1]);
921     assert((!CE || CE->getType() == IntIdxTy) &&
922            "CastGEPIndices didn't canonicalize index types!");
923     if (CE && CE->getOpcode() == Instruction::Sub &&
924         CE->getOperand(0)->isNullValue()) {
925       Constant *Res = ConstantExpr::getPtrToInt(Ptr, CE->getType());
926       Res = ConstantExpr::getSub(Res, CE->getOperand(1));
927       Res = ConstantExpr::getIntToPtr(Res, ResTy);
928       return ConstantFoldConstant(Res, DL, TLI);
929     }
930   }
931 
932   for (unsigned i = 1, e = Ops.size(); i != e; ++i)
933     if (!isa<ConstantInt>(Ops[i]))
934       return nullptr;
935 
936   unsigned BitWidth = DL.getTypeSizeInBits(IntIdxTy);
937   APInt Offset =
938       APInt(BitWidth,
939             DL.getIndexedOffsetInType(
940                 SrcElemTy,
941                 makeArrayRef((Value * const *)Ops.data() + 1, Ops.size() - 1)));
942   Ptr = StripPtrCastKeepAS(Ptr, ForLoadOperand);
943 
944   // If this is a GEP of a GEP, fold it all into a single GEP.
945   while (auto *GEP = dyn_cast<GEPOperator>(Ptr)) {
946     InnermostGEP = GEP;
947     InBounds &= GEP->isInBounds();
948 
949     SmallVector<Value *, 4> NestedOps(GEP->op_begin() + 1, GEP->op_end());
950 
951     // Do not try the incorporate the sub-GEP if some index is not a number.
952     bool AllConstantInt = true;
953     for (Value *NestedOp : NestedOps)
954       if (!isa<ConstantInt>(NestedOp)) {
955         AllConstantInt = false;
956         break;
957       }
958     if (!AllConstantInt)
959       break;
960 
961     Ptr = cast<Constant>(GEP->getOperand(0));
962     SrcElemTy = GEP->getSourceElementType();
963     Offset += APInt(BitWidth, DL.getIndexedOffsetInType(SrcElemTy, NestedOps));
964     Ptr = StripPtrCastKeepAS(Ptr, ForLoadOperand);
965   }
966 
967   // If the base value for this address is a literal integer value, fold the
968   // getelementptr to the resulting integer value casted to the pointer type.
969   APInt BasePtr(BitWidth, 0);
970   if (auto *CE = dyn_cast<ConstantExpr>(Ptr)) {
971     if (CE->getOpcode() == Instruction::IntToPtr) {
972       if (auto *Base = dyn_cast<ConstantInt>(CE->getOperand(0)))
973         BasePtr = Base->getValue().zextOrTrunc(BitWidth);
974     }
975   }
976 
977   auto *PTy = cast<PointerType>(Ptr->getType());
978   if ((Ptr->isNullValue() || BasePtr != 0) &&
979       !DL.isNonIntegralPointerType(PTy)) {
980     Constant *C = ConstantInt::get(Ptr->getContext(), Offset + BasePtr);
981     return ConstantExpr::getIntToPtr(C, ResTy);
982   }
983 
984   // Otherwise form a regular getelementptr. Recompute the indices so that
985   // we eliminate over-indexing of the notional static type array bounds.
986   // This makes it easy to determine if the getelementptr is "inbounds".
987   // Also, this helps GlobalOpt do SROA on GlobalVariables.
988   SmallVector<Constant *, 32> NewIdxs;
989   Type *Ty = PTy;
990   SrcElemTy = PTy->getElementType();
991 
992   do {
993     if (!Ty->isStructTy()) {
994       if (Ty->isPointerTy()) {
995         // The only pointer indexing we'll do is on the first index of the GEP.
996         if (!NewIdxs.empty())
997           break;
998 
999         Ty = SrcElemTy;
1000 
1001         // Only handle pointers to sized types, not pointers to functions.
1002         if (!Ty->isSized())
1003           return nullptr;
1004       } else {
1005         Type *NextTy = GetElementPtrInst::getTypeAtIndex(Ty, (uint64_t)0);
1006         if (!NextTy)
1007           break;
1008         Ty = NextTy;
1009       }
1010 
1011       // Determine which element of the array the offset points into.
1012       APInt ElemSize(BitWidth, DL.getTypeAllocSize(Ty));
1013       if (ElemSize == 0) {
1014         // The element size is 0. This may be [0 x Ty]*, so just use a zero
1015         // index for this level and proceed to the next level to see if it can
1016         // accommodate the offset.
1017         NewIdxs.push_back(ConstantInt::get(IntIdxTy, 0));
1018       } else {
1019         // The element size is non-zero divide the offset by the element
1020         // size (rounding down), to compute the index at this level.
1021         bool Overflow;
1022         APInt NewIdx = Offset.sdiv_ov(ElemSize, Overflow);
1023         if (Overflow)
1024           break;
1025         Offset -= NewIdx * ElemSize;
1026         NewIdxs.push_back(ConstantInt::get(IntIdxTy, NewIdx));
1027       }
1028     } else {
1029       auto *STy = cast<StructType>(Ty);
1030       // If we end up with an offset that isn't valid for this struct type, we
1031       // can't re-form this GEP in a regular form, so bail out. The pointer
1032       // operand likely went through casts that are necessary to make the GEP
1033       // sensible.
1034       const StructLayout &SL = *DL.getStructLayout(STy);
1035       if (Offset.isNegative() || Offset.uge(SL.getSizeInBytes()))
1036         break;
1037 
1038       // Determine which field of the struct the offset points into. The
1039       // getZExtValue is fine as we've already ensured that the offset is
1040       // within the range representable by the StructLayout API.
1041       unsigned ElIdx = SL.getElementContainingOffset(Offset.getZExtValue());
1042       NewIdxs.push_back(ConstantInt::get(Type::getInt32Ty(Ty->getContext()),
1043                                          ElIdx));
1044       Offset -= APInt(BitWidth, SL.getElementOffset(ElIdx));
1045       Ty = STy->getTypeAtIndex(ElIdx);
1046     }
1047   } while (Ty != ResElemTy);
1048 
1049   // If we haven't used up the entire offset by descending the static
1050   // type, then the offset is pointing into the middle of an indivisible
1051   // member, so we can't simplify it.
1052   if (Offset != 0)
1053     return nullptr;
1054 
1055   // Preserve the inrange index from the innermost GEP if possible. We must
1056   // have calculated the same indices up to and including the inrange index.
1057   Optional<unsigned> InRangeIndex;
1058   if (Optional<unsigned> LastIRIndex = InnermostGEP->getInRangeIndex())
1059     if (SrcElemTy == InnermostGEP->getSourceElementType() &&
1060         NewIdxs.size() > *LastIRIndex) {
1061       InRangeIndex = LastIRIndex;
1062       for (unsigned I = 0; I <= *LastIRIndex; ++I)
1063         if (NewIdxs[I] != InnermostGEP->getOperand(I + 1))
1064           return nullptr;
1065     }
1066 
1067   // Create a GEP.
1068   Constant *C = ConstantExpr::getGetElementPtr(SrcElemTy, Ptr, NewIdxs,
1069                                                InBounds, InRangeIndex);
1070   assert(C->getType()->getPointerElementType() == Ty &&
1071          "Computed GetElementPtr has unexpected type!");
1072 
1073   // If we ended up indexing a member with a type that doesn't match
1074   // the type of what the original indices indexed, add a cast.
1075   if (C->getType() != ResTy)
1076     C = FoldBitCast(C, ResTy, DL);
1077 
1078   return C;
1079 }
1080 
1081 /// Attempt to constant fold an instruction with the
1082 /// specified opcode and operands.  If successful, the constant result is
1083 /// returned, if not, null is returned.  Note that this function can fail when
1084 /// attempting to fold instructions like loads and stores, which have no
1085 /// constant expression form.
1086 Constant *ConstantFoldInstOperandsImpl(const Value *InstOrCE, unsigned Opcode,
1087                                        ArrayRef<Constant *> Ops,
1088                                        const DataLayout &DL,
1089                                        const TargetLibraryInfo *TLI) {
1090   Type *DestTy = InstOrCE->getType();
1091 
1092   if (Instruction::isUnaryOp(Opcode))
1093     return ConstantFoldUnaryOpOperand(Opcode, Ops[0], DL);
1094 
1095   if (Instruction::isBinaryOp(Opcode))
1096     return ConstantFoldBinaryOpOperands(Opcode, Ops[0], Ops[1], DL);
1097 
1098   if (Instruction::isCast(Opcode))
1099     return ConstantFoldCastOperand(Opcode, Ops[0], DestTy, DL);
1100 
1101   if (auto *GEP = dyn_cast<GEPOperator>(InstOrCE)) {
1102     if (Constant *C = SymbolicallyEvaluateGEP(GEP, Ops, DL, TLI,
1103                                               /*ForLoadOperand*/ false))
1104       return C;
1105 
1106     return ConstantExpr::getGetElementPtr(GEP->getSourceElementType(), Ops[0],
1107                                           Ops.slice(1), GEP->isInBounds(),
1108                                           GEP->getInRangeIndex());
1109   }
1110 
1111   if (auto *CE = dyn_cast<ConstantExpr>(InstOrCE))
1112     return CE->getWithOperands(Ops);
1113 
1114   switch (Opcode) {
1115   default: return nullptr;
1116   case Instruction::ICmp:
1117   case Instruction::FCmp: llvm_unreachable("Invalid for compares");
1118   case Instruction::Freeze:
1119     return isGuaranteedNotToBeUndefOrPoison(Ops[0]) ? Ops[0] : nullptr;
1120   case Instruction::Call:
1121     if (auto *F = dyn_cast<Function>(Ops.back())) {
1122       const auto *Call = cast<CallBase>(InstOrCE);
1123       if (canConstantFoldCallTo(Call, F))
1124         return ConstantFoldCall(Call, F, Ops.slice(0, Ops.size() - 1), TLI);
1125     }
1126     return nullptr;
1127   case Instruction::Select:
1128     return ConstantExpr::getSelect(Ops[0], Ops[1], Ops[2]);
1129   case Instruction::ExtractElement:
1130     return ConstantExpr::getExtractElement(Ops[0], Ops[1]);
1131   case Instruction::ExtractValue:
1132     return ConstantExpr::getExtractValue(
1133         Ops[0], cast<ExtractValueInst>(InstOrCE)->getIndices());
1134   case Instruction::InsertElement:
1135     return ConstantExpr::getInsertElement(Ops[0], Ops[1], Ops[2]);
1136   case Instruction::ShuffleVector:
1137     return ConstantExpr::getShuffleVector(
1138         Ops[0], Ops[1], cast<ShuffleVectorInst>(InstOrCE)->getShuffleMask());
1139   }
1140 }
1141 
1142 } // end anonymous namespace
1143 
1144 //===----------------------------------------------------------------------===//
1145 // Constant Folding public APIs
1146 //===----------------------------------------------------------------------===//
1147 
1148 namespace {
1149 
1150 Constant *
1151 ConstantFoldConstantImpl(const Constant *C, const DataLayout &DL,
1152                          const TargetLibraryInfo *TLI,
1153                          SmallDenseMap<Constant *, Constant *> &FoldedOps) {
1154   if (!isa<ConstantVector>(C) && !isa<ConstantExpr>(C))
1155     return const_cast<Constant *>(C);
1156 
1157   SmallVector<Constant *, 8> Ops;
1158   for (const Use &OldU : C->operands()) {
1159     Constant *OldC = cast<Constant>(&OldU);
1160     Constant *NewC = OldC;
1161     // Recursively fold the ConstantExpr's operands. If we have already folded
1162     // a ConstantExpr, we don't have to process it again.
1163     if (isa<ConstantVector>(OldC) || isa<ConstantExpr>(OldC)) {
1164       auto It = FoldedOps.find(OldC);
1165       if (It == FoldedOps.end()) {
1166         NewC = ConstantFoldConstantImpl(OldC, DL, TLI, FoldedOps);
1167         FoldedOps.insert({OldC, NewC});
1168       } else {
1169         NewC = It->second;
1170       }
1171     }
1172     Ops.push_back(NewC);
1173   }
1174 
1175   if (auto *CE = dyn_cast<ConstantExpr>(C)) {
1176     if (CE->isCompare())
1177       return ConstantFoldCompareInstOperands(CE->getPredicate(), Ops[0], Ops[1],
1178                                              DL, TLI);
1179 
1180     return ConstantFoldInstOperandsImpl(CE, CE->getOpcode(), Ops, DL, TLI);
1181   }
1182 
1183   assert(isa<ConstantVector>(C));
1184   return ConstantVector::get(Ops);
1185 }
1186 
1187 } // end anonymous namespace
1188 
1189 Constant *llvm::ConstantFoldInstruction(Instruction *I, const DataLayout &DL,
1190                                         const TargetLibraryInfo *TLI) {
1191   // Handle PHI nodes quickly here...
1192   if (auto *PN = dyn_cast<PHINode>(I)) {
1193     Constant *CommonValue = nullptr;
1194 
1195     SmallDenseMap<Constant *, Constant *> FoldedOps;
1196     for (Value *Incoming : PN->incoming_values()) {
1197       // If the incoming value is undef then skip it.  Note that while we could
1198       // skip the value if it is equal to the phi node itself we choose not to
1199       // because that would break the rule that constant folding only applies if
1200       // all operands are constants.
1201       if (isa<UndefValue>(Incoming))
1202         continue;
1203       // If the incoming value is not a constant, then give up.
1204       auto *C = dyn_cast<Constant>(Incoming);
1205       if (!C)
1206         return nullptr;
1207       // Fold the PHI's operands.
1208       C = ConstantFoldConstantImpl(C, DL, TLI, FoldedOps);
1209       // If the incoming value is a different constant to
1210       // the one we saw previously, then give up.
1211       if (CommonValue && C != CommonValue)
1212         return nullptr;
1213       CommonValue = C;
1214     }
1215 
1216     // If we reach here, all incoming values are the same constant or undef.
1217     return CommonValue ? CommonValue : UndefValue::get(PN->getType());
1218   }
1219 
1220   // Scan the operand list, checking to see if they are all constants, if so,
1221   // hand off to ConstantFoldInstOperandsImpl.
1222   if (!all_of(I->operands(), [](Use &U) { return isa<Constant>(U); }))
1223     return nullptr;
1224 
1225   SmallDenseMap<Constant *, Constant *> FoldedOps;
1226   SmallVector<Constant *, 8> Ops;
1227   for (const Use &OpU : I->operands()) {
1228     auto *Op = cast<Constant>(&OpU);
1229     // Fold the Instruction's operands.
1230     Op = ConstantFoldConstantImpl(Op, DL, TLI, FoldedOps);
1231     Ops.push_back(Op);
1232   }
1233 
1234   if (const auto *CI = dyn_cast<CmpInst>(I))
1235     return ConstantFoldCompareInstOperands(CI->getPredicate(), Ops[0], Ops[1],
1236                                            DL, TLI);
1237 
1238   if (const auto *LI = dyn_cast<LoadInst>(I)) {
1239     if (LI->isVolatile())
1240       return nullptr;
1241     return ConstantFoldLoadFromConstPtr(Ops[0], LI->getType(), DL);
1242   }
1243 
1244   if (auto *IVI = dyn_cast<InsertValueInst>(I))
1245     return ConstantExpr::getInsertValue(Ops[0], Ops[1], IVI->getIndices());
1246 
1247   if (auto *EVI = dyn_cast<ExtractValueInst>(I))
1248     return ConstantExpr::getExtractValue(Ops[0], EVI->getIndices());
1249 
1250   return ConstantFoldInstOperands(I, Ops, DL, TLI);
1251 }
1252 
1253 Constant *llvm::ConstantFoldConstant(const Constant *C, const DataLayout &DL,
1254                                      const TargetLibraryInfo *TLI) {
1255   SmallDenseMap<Constant *, Constant *> FoldedOps;
1256   return ConstantFoldConstantImpl(C, DL, TLI, FoldedOps);
1257 }
1258 
1259 Constant *llvm::ConstantFoldInstOperands(Instruction *I,
1260                                          ArrayRef<Constant *> Ops,
1261                                          const DataLayout &DL,
1262                                          const TargetLibraryInfo *TLI) {
1263   return ConstantFoldInstOperandsImpl(I, I->getOpcode(), Ops, DL, TLI);
1264 }
1265 
1266 Constant *llvm::ConstantFoldCompareInstOperands(unsigned Predicate,
1267                                                 Constant *Ops0, Constant *Ops1,
1268                                                 const DataLayout &DL,
1269                                                 const TargetLibraryInfo *TLI) {
1270   // fold: icmp (inttoptr x), null         -> icmp x, 0
1271   // fold: icmp null, (inttoptr x)         -> icmp 0, x
1272   // fold: icmp (ptrtoint x), 0            -> icmp x, null
1273   // fold: icmp 0, (ptrtoint x)            -> icmp null, x
1274   // fold: icmp (inttoptr x), (inttoptr y) -> icmp trunc/zext x, trunc/zext y
1275   // fold: icmp (ptrtoint x), (ptrtoint y) -> icmp x, y
1276   //
1277   // FIXME: The following comment is out of data and the DataLayout is here now.
1278   // ConstantExpr::getCompare cannot do this, because it doesn't have DL
1279   // around to know if bit truncation is happening.
1280   if (auto *CE0 = dyn_cast<ConstantExpr>(Ops0)) {
1281     if (Ops1->isNullValue()) {
1282       if (CE0->getOpcode() == Instruction::IntToPtr) {
1283         Type *IntPtrTy = DL.getIntPtrType(CE0->getType());
1284         // Convert the integer value to the right size to ensure we get the
1285         // proper extension or truncation.
1286         Constant *C = ConstantExpr::getIntegerCast(CE0->getOperand(0),
1287                                                    IntPtrTy, false);
1288         Constant *Null = Constant::getNullValue(C->getType());
1289         return ConstantFoldCompareInstOperands(Predicate, C, Null, DL, TLI);
1290       }
1291 
1292       // Only do this transformation if the int is intptrty in size, otherwise
1293       // there is a truncation or extension that we aren't modeling.
1294       if (CE0->getOpcode() == Instruction::PtrToInt) {
1295         Type *IntPtrTy = DL.getIntPtrType(CE0->getOperand(0)->getType());
1296         if (CE0->getType() == IntPtrTy) {
1297           Constant *C = CE0->getOperand(0);
1298           Constant *Null = Constant::getNullValue(C->getType());
1299           return ConstantFoldCompareInstOperands(Predicate, C, Null, DL, TLI);
1300         }
1301       }
1302     }
1303 
1304     if (auto *CE1 = dyn_cast<ConstantExpr>(Ops1)) {
1305       if (CE0->getOpcode() == CE1->getOpcode()) {
1306         if (CE0->getOpcode() == Instruction::IntToPtr) {
1307           Type *IntPtrTy = DL.getIntPtrType(CE0->getType());
1308 
1309           // Convert the integer value to the right size to ensure we get the
1310           // proper extension or truncation.
1311           Constant *C0 = ConstantExpr::getIntegerCast(CE0->getOperand(0),
1312                                                       IntPtrTy, false);
1313           Constant *C1 = ConstantExpr::getIntegerCast(CE1->getOperand(0),
1314                                                       IntPtrTy, false);
1315           return ConstantFoldCompareInstOperands(Predicate, C0, C1, DL, TLI);
1316         }
1317 
1318         // Only do this transformation if the int is intptrty in size, otherwise
1319         // there is a truncation or extension that we aren't modeling.
1320         if (CE0->getOpcode() == Instruction::PtrToInt) {
1321           Type *IntPtrTy = DL.getIntPtrType(CE0->getOperand(0)->getType());
1322           if (CE0->getType() == IntPtrTy &&
1323               CE0->getOperand(0)->getType() == CE1->getOperand(0)->getType()) {
1324             return ConstantFoldCompareInstOperands(
1325                 Predicate, CE0->getOperand(0), CE1->getOperand(0), DL, TLI);
1326           }
1327         }
1328       }
1329     }
1330 
1331     // icmp eq (or x, y), 0 -> (icmp eq x, 0) & (icmp eq y, 0)
1332     // icmp ne (or x, y), 0 -> (icmp ne x, 0) | (icmp ne y, 0)
1333     if ((Predicate == ICmpInst::ICMP_EQ || Predicate == ICmpInst::ICMP_NE) &&
1334         CE0->getOpcode() == Instruction::Or && Ops1->isNullValue()) {
1335       Constant *LHS = ConstantFoldCompareInstOperands(
1336           Predicate, CE0->getOperand(0), Ops1, DL, TLI);
1337       Constant *RHS = ConstantFoldCompareInstOperands(
1338           Predicate, CE0->getOperand(1), Ops1, DL, TLI);
1339       unsigned OpC =
1340         Predicate == ICmpInst::ICMP_EQ ? Instruction::And : Instruction::Or;
1341       return ConstantFoldBinaryOpOperands(OpC, LHS, RHS, DL);
1342     }
1343   } else if (isa<ConstantExpr>(Ops1)) {
1344     // If RHS is a constant expression, but the left side isn't, swap the
1345     // operands and try again.
1346     Predicate = ICmpInst::getSwappedPredicate((ICmpInst::Predicate)Predicate);
1347     return ConstantFoldCompareInstOperands(Predicate, Ops1, Ops0, DL, TLI);
1348   }
1349 
1350   return ConstantExpr::getCompare(Predicate, Ops0, Ops1);
1351 }
1352 
1353 Constant *llvm::ConstantFoldUnaryOpOperand(unsigned Opcode, Constant *Op,
1354                                            const DataLayout &DL) {
1355   assert(Instruction::isUnaryOp(Opcode));
1356 
1357   return ConstantExpr::get(Opcode, Op);
1358 }
1359 
1360 Constant *llvm::ConstantFoldBinaryOpOperands(unsigned Opcode, Constant *LHS,
1361                                              Constant *RHS,
1362                                              const DataLayout &DL) {
1363   assert(Instruction::isBinaryOp(Opcode));
1364   if (isa<ConstantExpr>(LHS) || isa<ConstantExpr>(RHS))
1365     if (Constant *C = SymbolicallyEvaluateBinop(Opcode, LHS, RHS, DL))
1366       return C;
1367 
1368   return ConstantExpr::get(Opcode, LHS, RHS);
1369 }
1370 
1371 Constant *llvm::ConstantFoldCastOperand(unsigned Opcode, Constant *C,
1372                                         Type *DestTy, const DataLayout &DL) {
1373   assert(Instruction::isCast(Opcode));
1374   switch (Opcode) {
1375   default:
1376     llvm_unreachable("Missing case");
1377   case Instruction::PtrToInt:
1378     // If the input is a inttoptr, eliminate the pair.  This requires knowing
1379     // the width of a pointer, so it can't be done in ConstantExpr::getCast.
1380     if (auto *CE = dyn_cast<ConstantExpr>(C)) {
1381       if (CE->getOpcode() == Instruction::IntToPtr) {
1382         Constant *Input = CE->getOperand(0);
1383         unsigned InWidth = Input->getType()->getScalarSizeInBits();
1384         unsigned PtrWidth = DL.getPointerTypeSizeInBits(CE->getType());
1385         if (PtrWidth < InWidth) {
1386           Constant *Mask =
1387             ConstantInt::get(CE->getContext(),
1388                              APInt::getLowBitsSet(InWidth, PtrWidth));
1389           Input = ConstantExpr::getAnd(Input, Mask);
1390         }
1391         // Do a zext or trunc to get to the dest size.
1392         return ConstantExpr::getIntegerCast(Input, DestTy, false);
1393       }
1394     }
1395     return ConstantExpr::getCast(Opcode, C, DestTy);
1396   case Instruction::IntToPtr:
1397     // If the input is a ptrtoint, turn the pair into a ptr to ptr bitcast if
1398     // the int size is >= the ptr size and the address spaces are the same.
1399     // This requires knowing the width of a pointer, so it can't be done in
1400     // ConstantExpr::getCast.
1401     if (auto *CE = dyn_cast<ConstantExpr>(C)) {
1402       if (CE->getOpcode() == Instruction::PtrToInt) {
1403         Constant *SrcPtr = CE->getOperand(0);
1404         unsigned SrcPtrSize = DL.getPointerTypeSizeInBits(SrcPtr->getType());
1405         unsigned MidIntSize = CE->getType()->getScalarSizeInBits();
1406 
1407         if (MidIntSize >= SrcPtrSize) {
1408           unsigned SrcAS = SrcPtr->getType()->getPointerAddressSpace();
1409           if (SrcAS == DestTy->getPointerAddressSpace())
1410             return FoldBitCast(CE->getOperand(0), DestTy, DL);
1411         }
1412       }
1413     }
1414 
1415     return ConstantExpr::getCast(Opcode, C, DestTy);
1416   case Instruction::Trunc:
1417   case Instruction::ZExt:
1418   case Instruction::SExt:
1419   case Instruction::FPTrunc:
1420   case Instruction::FPExt:
1421   case Instruction::UIToFP:
1422   case Instruction::SIToFP:
1423   case Instruction::FPToUI:
1424   case Instruction::FPToSI:
1425   case Instruction::AddrSpaceCast:
1426       return ConstantExpr::getCast(Opcode, C, DestTy);
1427   case Instruction::BitCast:
1428     return FoldBitCast(C, DestTy, DL);
1429   }
1430 }
1431 
1432 Constant *llvm::ConstantFoldLoadThroughGEPConstantExpr(Constant *C,
1433                                                        ConstantExpr *CE,
1434                                                        Type *Ty,
1435                                                        const DataLayout &DL) {
1436   if (!CE->getOperand(1)->isNullValue())
1437     return nullptr;  // Do not allow stepping over the value!
1438 
1439   // Loop over all of the operands, tracking down which value we are
1440   // addressing.
1441   for (unsigned i = 2, e = CE->getNumOperands(); i != e; ++i) {
1442     C = C->getAggregateElement(CE->getOperand(i));
1443     if (!C)
1444       return nullptr;
1445   }
1446   return ConstantFoldLoadThroughBitcast(C, Ty, DL);
1447 }
1448 
1449 Constant *
1450 llvm::ConstantFoldLoadThroughGEPIndices(Constant *C,
1451                                         ArrayRef<Constant *> Indices) {
1452   // Loop over all of the operands, tracking down which value we are
1453   // addressing.
1454   for (Constant *Index : Indices) {
1455     C = C->getAggregateElement(Index);
1456     if (!C)
1457       return nullptr;
1458   }
1459   return C;
1460 }
1461 
1462 //===----------------------------------------------------------------------===//
1463 //  Constant Folding for Calls
1464 //
1465 
1466 bool llvm::canConstantFoldCallTo(const CallBase *Call, const Function *F) {
1467   if (Call->isNoBuiltin())
1468     return false;
1469   switch (F->getIntrinsicID()) {
1470   // Operations that do not operate floating-point numbers and do not depend on
1471   // FP environment can be folded even in strictfp functions.
1472   case Intrinsic::bswap:
1473   case Intrinsic::ctpop:
1474   case Intrinsic::ctlz:
1475   case Intrinsic::cttz:
1476   case Intrinsic::fshl:
1477   case Intrinsic::fshr:
1478   case Intrinsic::launder_invariant_group:
1479   case Intrinsic::strip_invariant_group:
1480   case Intrinsic::masked_load:
1481   case Intrinsic::get_active_lane_mask:
1482   case Intrinsic::abs:
1483   case Intrinsic::smax:
1484   case Intrinsic::smin:
1485   case Intrinsic::umax:
1486   case Intrinsic::umin:
1487   case Intrinsic::sadd_with_overflow:
1488   case Intrinsic::uadd_with_overflow:
1489   case Intrinsic::ssub_with_overflow:
1490   case Intrinsic::usub_with_overflow:
1491   case Intrinsic::smul_with_overflow:
1492   case Intrinsic::umul_with_overflow:
1493   case Intrinsic::sadd_sat:
1494   case Intrinsic::uadd_sat:
1495   case Intrinsic::ssub_sat:
1496   case Intrinsic::usub_sat:
1497   case Intrinsic::smul_fix:
1498   case Intrinsic::smul_fix_sat:
1499   case Intrinsic::bitreverse:
1500   case Intrinsic::is_constant:
1501   case Intrinsic::vector_reduce_add:
1502   case Intrinsic::vector_reduce_mul:
1503   case Intrinsic::vector_reduce_and:
1504   case Intrinsic::vector_reduce_or:
1505   case Intrinsic::vector_reduce_xor:
1506   case Intrinsic::vector_reduce_smin:
1507   case Intrinsic::vector_reduce_smax:
1508   case Intrinsic::vector_reduce_umin:
1509   case Intrinsic::vector_reduce_umax:
1510   // Target intrinsics
1511   case Intrinsic::amdgcn_perm:
1512   case Intrinsic::arm_mve_vctp8:
1513   case Intrinsic::arm_mve_vctp16:
1514   case Intrinsic::arm_mve_vctp32:
1515   case Intrinsic::arm_mve_vctp64:
1516   case Intrinsic::aarch64_sve_convert_from_svbool:
1517   // WebAssembly float semantics are always known
1518   case Intrinsic::wasm_trunc_signed:
1519   case Intrinsic::wasm_trunc_unsigned:
1520     return true;
1521 
1522   // Floating point operations cannot be folded in strictfp functions in
1523   // general case. They can be folded if FP environment is known to compiler.
1524   case Intrinsic::minnum:
1525   case Intrinsic::maxnum:
1526   case Intrinsic::minimum:
1527   case Intrinsic::maximum:
1528   case Intrinsic::log:
1529   case Intrinsic::log2:
1530   case Intrinsic::log10:
1531   case Intrinsic::exp:
1532   case Intrinsic::exp2:
1533   case Intrinsic::sqrt:
1534   case Intrinsic::sin:
1535   case Intrinsic::cos:
1536   case Intrinsic::pow:
1537   case Intrinsic::powi:
1538   case Intrinsic::fma:
1539   case Intrinsic::fmuladd:
1540   case Intrinsic::fptoui_sat:
1541   case Intrinsic::fptosi_sat:
1542   case Intrinsic::convert_from_fp16:
1543   case Intrinsic::convert_to_fp16:
1544   case Intrinsic::amdgcn_cos:
1545   case Intrinsic::amdgcn_cubeid:
1546   case Intrinsic::amdgcn_cubema:
1547   case Intrinsic::amdgcn_cubesc:
1548   case Intrinsic::amdgcn_cubetc:
1549   case Intrinsic::amdgcn_fmul_legacy:
1550   case Intrinsic::amdgcn_fma_legacy:
1551   case Intrinsic::amdgcn_fract:
1552   case Intrinsic::amdgcn_ldexp:
1553   case Intrinsic::amdgcn_sin:
1554   // The intrinsics below depend on rounding mode in MXCSR.
1555   case Intrinsic::x86_sse_cvtss2si:
1556   case Intrinsic::x86_sse_cvtss2si64:
1557   case Intrinsic::x86_sse_cvttss2si:
1558   case Intrinsic::x86_sse_cvttss2si64:
1559   case Intrinsic::x86_sse2_cvtsd2si:
1560   case Intrinsic::x86_sse2_cvtsd2si64:
1561   case Intrinsic::x86_sse2_cvttsd2si:
1562   case Intrinsic::x86_sse2_cvttsd2si64:
1563   case Intrinsic::x86_avx512_vcvtss2si32:
1564   case Intrinsic::x86_avx512_vcvtss2si64:
1565   case Intrinsic::x86_avx512_cvttss2si:
1566   case Intrinsic::x86_avx512_cvttss2si64:
1567   case Intrinsic::x86_avx512_vcvtsd2si32:
1568   case Intrinsic::x86_avx512_vcvtsd2si64:
1569   case Intrinsic::x86_avx512_cvttsd2si:
1570   case Intrinsic::x86_avx512_cvttsd2si64:
1571   case Intrinsic::x86_avx512_vcvtss2usi32:
1572   case Intrinsic::x86_avx512_vcvtss2usi64:
1573   case Intrinsic::x86_avx512_cvttss2usi:
1574   case Intrinsic::x86_avx512_cvttss2usi64:
1575   case Intrinsic::x86_avx512_vcvtsd2usi32:
1576   case Intrinsic::x86_avx512_vcvtsd2usi64:
1577   case Intrinsic::x86_avx512_cvttsd2usi:
1578   case Intrinsic::x86_avx512_cvttsd2usi64:
1579     return !Call->isStrictFP();
1580 
1581   // Sign operations are actually bitwise operations, they do not raise
1582   // exceptions even for SNANs.
1583   case Intrinsic::fabs:
1584   case Intrinsic::copysign:
1585   // Non-constrained variants of rounding operations means default FP
1586   // environment, they can be folded in any case.
1587   case Intrinsic::ceil:
1588   case Intrinsic::floor:
1589   case Intrinsic::round:
1590   case Intrinsic::roundeven:
1591   case Intrinsic::trunc:
1592   case Intrinsic::nearbyint:
1593   case Intrinsic::rint:
1594   // Constrained intrinsics can be folded if FP environment is known
1595   // to compiler.
1596   case Intrinsic::experimental_constrained_ceil:
1597   case Intrinsic::experimental_constrained_floor:
1598   case Intrinsic::experimental_constrained_round:
1599   case Intrinsic::experimental_constrained_roundeven:
1600   case Intrinsic::experimental_constrained_trunc:
1601   case Intrinsic::experimental_constrained_nearbyint:
1602   case Intrinsic::experimental_constrained_rint:
1603     return true;
1604   default:
1605     return false;
1606   case Intrinsic::not_intrinsic: break;
1607   }
1608 
1609   if (!F->hasName() || Call->isStrictFP())
1610     return false;
1611 
1612   // In these cases, the check of the length is required.  We don't want to
1613   // return true for a name like "cos\0blah" which strcmp would return equal to
1614   // "cos", but has length 8.
1615   StringRef Name = F->getName();
1616   switch (Name[0]) {
1617   default:
1618     return false;
1619   case 'a':
1620     return Name == "acos" || Name == "acosf" ||
1621            Name == "asin" || Name == "asinf" ||
1622            Name == "atan" || Name == "atanf" ||
1623            Name == "atan2" || Name == "atan2f";
1624   case 'c':
1625     return Name == "ceil" || Name == "ceilf" ||
1626            Name == "cos" || Name == "cosf" ||
1627            Name == "cosh" || Name == "coshf";
1628   case 'e':
1629     return Name == "exp" || Name == "expf" ||
1630            Name == "exp2" || Name == "exp2f";
1631   case 'f':
1632     return Name == "fabs" || Name == "fabsf" ||
1633            Name == "floor" || Name == "floorf" ||
1634            Name == "fmod" || Name == "fmodf";
1635   case 'l':
1636     return Name == "log" || Name == "logf" ||
1637            Name == "log2" || Name == "log2f" ||
1638            Name == "log10" || Name == "log10f";
1639   case 'n':
1640     return Name == "nearbyint" || Name == "nearbyintf";
1641   case 'p':
1642     return Name == "pow" || Name == "powf";
1643   case 'r':
1644     return Name == "remainder" || Name == "remainderf" ||
1645            Name == "rint" || Name == "rintf" ||
1646            Name == "round" || Name == "roundf";
1647   case 's':
1648     return Name == "sin" || Name == "sinf" ||
1649            Name == "sinh" || Name == "sinhf" ||
1650            Name == "sqrt" || Name == "sqrtf";
1651   case 't':
1652     return Name == "tan" || Name == "tanf" ||
1653            Name == "tanh" || Name == "tanhf" ||
1654            Name == "trunc" || Name == "truncf";
1655   case '_':
1656     // Check for various function names that get used for the math functions
1657     // when the header files are preprocessed with the macro
1658     // __FINITE_MATH_ONLY__ enabled.
1659     // The '12' here is the length of the shortest name that can match.
1660     // We need to check the size before looking at Name[1] and Name[2]
1661     // so we may as well check a limit that will eliminate mismatches.
1662     if (Name.size() < 12 || Name[1] != '_')
1663       return false;
1664     switch (Name[2]) {
1665     default:
1666       return false;
1667     case 'a':
1668       return Name == "__acos_finite" || Name == "__acosf_finite" ||
1669              Name == "__asin_finite" || Name == "__asinf_finite" ||
1670              Name == "__atan2_finite" || Name == "__atan2f_finite";
1671     case 'c':
1672       return Name == "__cosh_finite" || Name == "__coshf_finite";
1673     case 'e':
1674       return Name == "__exp_finite" || Name == "__expf_finite" ||
1675              Name == "__exp2_finite" || Name == "__exp2f_finite";
1676     case 'l':
1677       return Name == "__log_finite" || Name == "__logf_finite" ||
1678              Name == "__log10_finite" || Name == "__log10f_finite";
1679     case 'p':
1680       return Name == "__pow_finite" || Name == "__powf_finite";
1681     case 's':
1682       return Name == "__sinh_finite" || Name == "__sinhf_finite";
1683     }
1684   }
1685 }
1686 
1687 namespace {
1688 
1689 Constant *GetConstantFoldFPValue(double V, Type *Ty) {
1690   if (Ty->isHalfTy() || Ty->isFloatTy()) {
1691     APFloat APF(V);
1692     bool unused;
1693     APF.convert(Ty->getFltSemantics(), APFloat::rmNearestTiesToEven, &unused);
1694     return ConstantFP::get(Ty->getContext(), APF);
1695   }
1696   if (Ty->isDoubleTy())
1697     return ConstantFP::get(Ty->getContext(), APFloat(V));
1698   llvm_unreachable("Can only constant fold half/float/double");
1699 }
1700 
1701 /// Clear the floating-point exception state.
1702 inline void llvm_fenv_clearexcept() {
1703 #if defined(HAVE_FENV_H) && HAVE_DECL_FE_ALL_EXCEPT
1704   feclearexcept(FE_ALL_EXCEPT);
1705 #endif
1706   errno = 0;
1707 }
1708 
1709 /// Test if a floating-point exception was raised.
1710 inline bool llvm_fenv_testexcept() {
1711   int errno_val = errno;
1712   if (errno_val == ERANGE || errno_val == EDOM)
1713     return true;
1714 #if defined(HAVE_FENV_H) && HAVE_DECL_FE_ALL_EXCEPT && HAVE_DECL_FE_INEXACT
1715   if (fetestexcept(FE_ALL_EXCEPT & ~FE_INEXACT))
1716     return true;
1717 #endif
1718   return false;
1719 }
1720 
1721 Constant *ConstantFoldFP(double (*NativeFP)(double), const APFloat &V,
1722                          Type *Ty) {
1723   llvm_fenv_clearexcept();
1724   double Result = NativeFP(V.convertToDouble());
1725   if (llvm_fenv_testexcept()) {
1726     llvm_fenv_clearexcept();
1727     return nullptr;
1728   }
1729 
1730   return GetConstantFoldFPValue(Result, Ty);
1731 }
1732 
1733 Constant *ConstantFoldBinaryFP(double (*NativeFP)(double, double),
1734                                const APFloat &V, const APFloat &W, Type *Ty) {
1735   llvm_fenv_clearexcept();
1736   double Result = NativeFP(V.convertToDouble(), W.convertToDouble());
1737   if (llvm_fenv_testexcept()) {
1738     llvm_fenv_clearexcept();
1739     return nullptr;
1740   }
1741 
1742   return GetConstantFoldFPValue(Result, Ty);
1743 }
1744 
1745 Constant *constantFoldVectorReduce(Intrinsic::ID IID, Constant *Op) {
1746   FixedVectorType *VT = dyn_cast<FixedVectorType>(Op->getType());
1747   if (!VT)
1748     return nullptr;
1749 
1750   // This isn't strictly necessary, but handle the special/common case of zero:
1751   // all integer reductions of a zero input produce zero.
1752   if (isa<ConstantAggregateZero>(Op))
1753     return ConstantInt::get(VT->getElementType(), 0);
1754 
1755   // This is the same as the underlying binops - poison propagates.
1756   if (isa<PoisonValue>(Op) || Op->containsPoisonElement())
1757     return PoisonValue::get(VT->getElementType());
1758 
1759   // TODO: Handle undef.
1760   if (!isa<ConstantVector>(Op) && !isa<ConstantDataVector>(Op))
1761     return nullptr;
1762 
1763   auto *EltC = dyn_cast<ConstantInt>(Op->getAggregateElement(0U));
1764   if (!EltC)
1765     return nullptr;
1766 
1767   APInt Acc = EltC->getValue();
1768   for (unsigned I = 1, E = VT->getNumElements(); I != E; I++) {
1769     if (!(EltC = dyn_cast<ConstantInt>(Op->getAggregateElement(I))))
1770       return nullptr;
1771     const APInt &X = EltC->getValue();
1772     switch (IID) {
1773     case Intrinsic::vector_reduce_add:
1774       Acc = Acc + X;
1775       break;
1776     case Intrinsic::vector_reduce_mul:
1777       Acc = Acc * X;
1778       break;
1779     case Intrinsic::vector_reduce_and:
1780       Acc = Acc & X;
1781       break;
1782     case Intrinsic::vector_reduce_or:
1783       Acc = Acc | X;
1784       break;
1785     case Intrinsic::vector_reduce_xor:
1786       Acc = Acc ^ X;
1787       break;
1788     case Intrinsic::vector_reduce_smin:
1789       Acc = APIntOps::smin(Acc, X);
1790       break;
1791     case Intrinsic::vector_reduce_smax:
1792       Acc = APIntOps::smax(Acc, X);
1793       break;
1794     case Intrinsic::vector_reduce_umin:
1795       Acc = APIntOps::umin(Acc, X);
1796       break;
1797     case Intrinsic::vector_reduce_umax:
1798       Acc = APIntOps::umax(Acc, X);
1799       break;
1800     }
1801   }
1802 
1803   return ConstantInt::get(Op->getContext(), Acc);
1804 }
1805 
1806 /// Attempt to fold an SSE floating point to integer conversion of a constant
1807 /// floating point. If roundTowardZero is false, the default IEEE rounding is
1808 /// used (toward nearest, ties to even). This matches the behavior of the
1809 /// non-truncating SSE instructions in the default rounding mode. The desired
1810 /// integer type Ty is used to select how many bits are available for the
1811 /// result. Returns null if the conversion cannot be performed, otherwise
1812 /// returns the Constant value resulting from the conversion.
1813 Constant *ConstantFoldSSEConvertToInt(const APFloat &Val, bool roundTowardZero,
1814                                       Type *Ty, bool IsSigned) {
1815   // All of these conversion intrinsics form an integer of at most 64bits.
1816   unsigned ResultWidth = Ty->getIntegerBitWidth();
1817   assert(ResultWidth <= 64 &&
1818          "Can only constant fold conversions to 64 and 32 bit ints");
1819 
1820   uint64_t UIntVal;
1821   bool isExact = false;
1822   APFloat::roundingMode mode = roundTowardZero? APFloat::rmTowardZero
1823                                               : APFloat::rmNearestTiesToEven;
1824   APFloat::opStatus status =
1825       Val.convertToInteger(makeMutableArrayRef(UIntVal), ResultWidth,
1826                            IsSigned, mode, &isExact);
1827   if (status != APFloat::opOK &&
1828       (!roundTowardZero || status != APFloat::opInexact))
1829     return nullptr;
1830   return ConstantInt::get(Ty, UIntVal, IsSigned);
1831 }
1832 
1833 double getValueAsDouble(ConstantFP *Op) {
1834   Type *Ty = Op->getType();
1835 
1836   if (Ty->isBFloatTy() || Ty->isHalfTy() || Ty->isFloatTy() || Ty->isDoubleTy())
1837     return Op->getValueAPF().convertToDouble();
1838 
1839   bool unused;
1840   APFloat APF = Op->getValueAPF();
1841   APF.convert(APFloat::IEEEdouble(), APFloat::rmNearestTiesToEven, &unused);
1842   return APF.convertToDouble();
1843 }
1844 
1845 static bool getConstIntOrUndef(Value *Op, const APInt *&C) {
1846   if (auto *CI = dyn_cast<ConstantInt>(Op)) {
1847     C = &CI->getValue();
1848     return true;
1849   }
1850   if (isa<UndefValue>(Op)) {
1851     C = nullptr;
1852     return true;
1853   }
1854   return false;
1855 }
1856 
1857 static Constant *ConstantFoldScalarCall1(StringRef Name,
1858                                          Intrinsic::ID IntrinsicID,
1859                                          Type *Ty,
1860                                          ArrayRef<Constant *> Operands,
1861                                          const TargetLibraryInfo *TLI,
1862                                          const CallBase *Call) {
1863   assert(Operands.size() == 1 && "Wrong number of operands.");
1864 
1865   if (IntrinsicID == Intrinsic::is_constant) {
1866     // We know we have a "Constant" argument. But we want to only
1867     // return true for manifest constants, not those that depend on
1868     // constants with unknowable values, e.g. GlobalValue or BlockAddress.
1869     if (Operands[0]->isManifestConstant())
1870       return ConstantInt::getTrue(Ty->getContext());
1871     return nullptr;
1872   }
1873   if (isa<UndefValue>(Operands[0])) {
1874     // cosine(arg) is between -1 and 1. cosine(invalid arg) is NaN.
1875     // ctpop() is between 0 and bitwidth, pick 0 for undef.
1876     // fptoui.sat and fptosi.sat can always fold to zero (for a zero input).
1877     if (IntrinsicID == Intrinsic::cos ||
1878         IntrinsicID == Intrinsic::ctpop ||
1879         IntrinsicID == Intrinsic::fptoui_sat ||
1880         IntrinsicID == Intrinsic::fptosi_sat)
1881       return Constant::getNullValue(Ty);
1882     if (IntrinsicID == Intrinsic::bswap ||
1883         IntrinsicID == Intrinsic::bitreverse ||
1884         IntrinsicID == Intrinsic::launder_invariant_group ||
1885         IntrinsicID == Intrinsic::strip_invariant_group)
1886       return Operands[0];
1887   }
1888 
1889   if (isa<ConstantPointerNull>(Operands[0])) {
1890     // launder(null) == null == strip(null) iff in addrspace 0
1891     if (IntrinsicID == Intrinsic::launder_invariant_group ||
1892         IntrinsicID == Intrinsic::strip_invariant_group) {
1893       // If instruction is not yet put in a basic block (e.g. when cloning
1894       // a function during inlining), Call's caller may not be available.
1895       // So check Call's BB first before querying Call->getCaller.
1896       const Function *Caller =
1897           Call->getParent() ? Call->getCaller() : nullptr;
1898       if (Caller &&
1899           !NullPointerIsDefined(
1900               Caller, Operands[0]->getType()->getPointerAddressSpace())) {
1901         return Operands[0];
1902       }
1903       return nullptr;
1904     }
1905   }
1906 
1907   if (auto *Op = dyn_cast<ConstantFP>(Operands[0])) {
1908     if (IntrinsicID == Intrinsic::convert_to_fp16) {
1909       APFloat Val(Op->getValueAPF());
1910 
1911       bool lost = false;
1912       Val.convert(APFloat::IEEEhalf(), APFloat::rmNearestTiesToEven, &lost);
1913 
1914       return ConstantInt::get(Ty->getContext(), Val.bitcastToAPInt());
1915     }
1916 
1917     APFloat U = Op->getValueAPF();
1918 
1919     if (IntrinsicID == Intrinsic::wasm_trunc_signed ||
1920         IntrinsicID == Intrinsic::wasm_trunc_unsigned) {
1921       bool Signed = IntrinsicID == Intrinsic::wasm_trunc_signed;
1922 
1923       if (U.isNaN())
1924         return nullptr;
1925 
1926       unsigned Width = Ty->getIntegerBitWidth();
1927       APSInt Int(Width, !Signed);
1928       bool IsExact = false;
1929       APFloat::opStatus Status =
1930           U.convertToInteger(Int, APFloat::rmTowardZero, &IsExact);
1931 
1932       if (Status == APFloat::opOK || Status == APFloat::opInexact)
1933         return ConstantInt::get(Ty, Int);
1934 
1935       return nullptr;
1936     }
1937 
1938     if (IntrinsicID == Intrinsic::fptoui_sat ||
1939         IntrinsicID == Intrinsic::fptosi_sat) {
1940       // convertToInteger() already has the desired saturation semantics.
1941       APSInt Int(Ty->getIntegerBitWidth(),
1942                  IntrinsicID == Intrinsic::fptoui_sat);
1943       bool IsExact;
1944       U.convertToInteger(Int, APFloat::rmTowardZero, &IsExact);
1945       return ConstantInt::get(Ty, Int);
1946     }
1947 
1948     if (!Ty->isHalfTy() && !Ty->isFloatTy() && !Ty->isDoubleTy())
1949       return nullptr;
1950 
1951     // Use internal versions of these intrinsics.
1952 
1953     if (IntrinsicID == Intrinsic::nearbyint || IntrinsicID == Intrinsic::rint) {
1954       U.roundToIntegral(APFloat::rmNearestTiesToEven);
1955       return ConstantFP::get(Ty->getContext(), U);
1956     }
1957 
1958     if (IntrinsicID == Intrinsic::round) {
1959       U.roundToIntegral(APFloat::rmNearestTiesToAway);
1960       return ConstantFP::get(Ty->getContext(), U);
1961     }
1962 
1963     if (IntrinsicID == Intrinsic::roundeven) {
1964       U.roundToIntegral(APFloat::rmNearestTiesToEven);
1965       return ConstantFP::get(Ty->getContext(), U);
1966     }
1967 
1968     if (IntrinsicID == Intrinsic::ceil) {
1969       U.roundToIntegral(APFloat::rmTowardPositive);
1970       return ConstantFP::get(Ty->getContext(), U);
1971     }
1972 
1973     if (IntrinsicID == Intrinsic::floor) {
1974       U.roundToIntegral(APFloat::rmTowardNegative);
1975       return ConstantFP::get(Ty->getContext(), U);
1976     }
1977 
1978     if (IntrinsicID == Intrinsic::trunc) {
1979       U.roundToIntegral(APFloat::rmTowardZero);
1980       return ConstantFP::get(Ty->getContext(), U);
1981     }
1982 
1983     if (IntrinsicID == Intrinsic::fabs) {
1984       U.clearSign();
1985       return ConstantFP::get(Ty->getContext(), U);
1986     }
1987 
1988     if (IntrinsicID == Intrinsic::amdgcn_fract) {
1989       // The v_fract instruction behaves like the OpenCL spec, which defines
1990       // fract(x) as fmin(x - floor(x), 0x1.fffffep-1f): "The min() operator is
1991       //   there to prevent fract(-small) from returning 1.0. It returns the
1992       //   largest positive floating-point number less than 1.0."
1993       APFloat FloorU(U);
1994       FloorU.roundToIntegral(APFloat::rmTowardNegative);
1995       APFloat FractU(U - FloorU);
1996       APFloat AlmostOne(U.getSemantics(), 1);
1997       AlmostOne.next(/*nextDown*/ true);
1998       return ConstantFP::get(Ty->getContext(), minimum(FractU, AlmostOne));
1999     }
2000 
2001     // Rounding operations (floor, trunc, ceil, round and nearbyint) do not
2002     // raise FP exceptions, unless the argument is signaling NaN.
2003 
2004     Optional<APFloat::roundingMode> RM;
2005     switch (IntrinsicID) {
2006     default:
2007       break;
2008     case Intrinsic::experimental_constrained_nearbyint:
2009     case Intrinsic::experimental_constrained_rint: {
2010       auto CI = cast<ConstrainedFPIntrinsic>(Call);
2011       RM = CI->getRoundingMode();
2012       if (!RM || RM.getValue() == RoundingMode::Dynamic)
2013         return nullptr;
2014       break;
2015     }
2016     case Intrinsic::experimental_constrained_round:
2017       RM = APFloat::rmNearestTiesToAway;
2018       break;
2019     case Intrinsic::experimental_constrained_ceil:
2020       RM = APFloat::rmTowardPositive;
2021       break;
2022     case Intrinsic::experimental_constrained_floor:
2023       RM = APFloat::rmTowardNegative;
2024       break;
2025     case Intrinsic::experimental_constrained_trunc:
2026       RM = APFloat::rmTowardZero;
2027       break;
2028     }
2029     if (RM) {
2030       auto CI = cast<ConstrainedFPIntrinsic>(Call);
2031       if (U.isFinite()) {
2032         APFloat::opStatus St = U.roundToIntegral(*RM);
2033         if (IntrinsicID == Intrinsic::experimental_constrained_rint &&
2034             St == APFloat::opInexact) {
2035           Optional<fp::ExceptionBehavior> EB = CI->getExceptionBehavior();
2036           if (EB && *EB == fp::ebStrict)
2037             return nullptr;
2038         }
2039       } else if (U.isSignaling()) {
2040         Optional<fp::ExceptionBehavior> EB = CI->getExceptionBehavior();
2041         if (EB && *EB != fp::ebIgnore)
2042           return nullptr;
2043         U = APFloat::getQNaN(U.getSemantics());
2044       }
2045       return ConstantFP::get(Ty->getContext(), U);
2046     }
2047 
2048     /// We only fold functions with finite arguments. Folding NaN and inf is
2049     /// likely to be aborted with an exception anyway, and some host libms
2050     /// have known errors raising exceptions.
2051     if (!U.isFinite())
2052       return nullptr;
2053 
2054     /// Currently APFloat versions of these functions do not exist, so we use
2055     /// the host native double versions.  Float versions are not called
2056     /// directly but for all these it is true (float)(f((double)arg)) ==
2057     /// f(arg).  Long double not supported yet.
2058     APFloat APF = Op->getValueAPF();
2059 
2060     switch (IntrinsicID) {
2061       default: break;
2062       case Intrinsic::log:
2063         return ConstantFoldFP(log, APF, Ty);
2064       case Intrinsic::log2:
2065         // TODO: What about hosts that lack a C99 library?
2066         return ConstantFoldFP(Log2, APF, Ty);
2067       case Intrinsic::log10:
2068         // TODO: What about hosts that lack a C99 library?
2069         return ConstantFoldFP(log10, APF, Ty);
2070       case Intrinsic::exp:
2071         return ConstantFoldFP(exp, APF, Ty);
2072       case Intrinsic::exp2:
2073         // Fold exp2(x) as pow(2, x), in case the host lacks a C99 library.
2074         return ConstantFoldBinaryFP(pow, APFloat(2.0), APF, Ty);
2075       case Intrinsic::sin:
2076         return ConstantFoldFP(sin, APF, Ty);
2077       case Intrinsic::cos:
2078         return ConstantFoldFP(cos, APF, Ty);
2079       case Intrinsic::sqrt:
2080         return ConstantFoldFP(sqrt, APF, Ty);
2081       case Intrinsic::amdgcn_cos:
2082       case Intrinsic::amdgcn_sin: {
2083         double V = getValueAsDouble(Op);
2084         if (V < -256.0 || V > 256.0)
2085           // The gfx8 and gfx9 architectures handle arguments outside the range
2086           // [-256, 256] differently. This should be a rare case so bail out
2087           // rather than trying to handle the difference.
2088           return nullptr;
2089         bool IsCos = IntrinsicID == Intrinsic::amdgcn_cos;
2090         double V4 = V * 4.0;
2091         if (V4 == floor(V4)) {
2092           // Force exact results for quarter-integer inputs.
2093           const double SinVals[4] = { 0.0, 1.0, 0.0, -1.0 };
2094           V = SinVals[((int)V4 + (IsCos ? 1 : 0)) & 3];
2095         } else {
2096           if (IsCos)
2097             V = cos(V * 2.0 * numbers::pi);
2098           else
2099             V = sin(V * 2.0 * numbers::pi);
2100         }
2101         return GetConstantFoldFPValue(V, Ty);
2102       }
2103     }
2104 
2105     if (!TLI)
2106       return nullptr;
2107 
2108     LibFunc Func = NotLibFunc;
2109     TLI->getLibFunc(Name, Func);
2110     switch (Func) {
2111     default:
2112       break;
2113     case LibFunc_acos:
2114     case LibFunc_acosf:
2115     case LibFunc_acos_finite:
2116     case LibFunc_acosf_finite:
2117       if (TLI->has(Func))
2118         return ConstantFoldFP(acos, APF, Ty);
2119       break;
2120     case LibFunc_asin:
2121     case LibFunc_asinf:
2122     case LibFunc_asin_finite:
2123     case LibFunc_asinf_finite:
2124       if (TLI->has(Func))
2125         return ConstantFoldFP(asin, APF, Ty);
2126       break;
2127     case LibFunc_atan:
2128     case LibFunc_atanf:
2129       if (TLI->has(Func))
2130         return ConstantFoldFP(atan, APF, Ty);
2131       break;
2132     case LibFunc_ceil:
2133     case LibFunc_ceilf:
2134       if (TLI->has(Func)) {
2135         U.roundToIntegral(APFloat::rmTowardPositive);
2136         return ConstantFP::get(Ty->getContext(), U);
2137       }
2138       break;
2139     case LibFunc_cos:
2140     case LibFunc_cosf:
2141       if (TLI->has(Func))
2142         return ConstantFoldFP(cos, APF, Ty);
2143       break;
2144     case LibFunc_cosh:
2145     case LibFunc_coshf:
2146     case LibFunc_cosh_finite:
2147     case LibFunc_coshf_finite:
2148       if (TLI->has(Func))
2149         return ConstantFoldFP(cosh, APF, Ty);
2150       break;
2151     case LibFunc_exp:
2152     case LibFunc_expf:
2153     case LibFunc_exp_finite:
2154     case LibFunc_expf_finite:
2155       if (TLI->has(Func))
2156         return ConstantFoldFP(exp, APF, Ty);
2157       break;
2158     case LibFunc_exp2:
2159     case LibFunc_exp2f:
2160     case LibFunc_exp2_finite:
2161     case LibFunc_exp2f_finite:
2162       if (TLI->has(Func))
2163         // Fold exp2(x) as pow(2, x), in case the host lacks a C99 library.
2164         return ConstantFoldBinaryFP(pow, APFloat(2.0), APF, Ty);
2165       break;
2166     case LibFunc_fabs:
2167     case LibFunc_fabsf:
2168       if (TLI->has(Func)) {
2169         U.clearSign();
2170         return ConstantFP::get(Ty->getContext(), U);
2171       }
2172       break;
2173     case LibFunc_floor:
2174     case LibFunc_floorf:
2175       if (TLI->has(Func)) {
2176         U.roundToIntegral(APFloat::rmTowardNegative);
2177         return ConstantFP::get(Ty->getContext(), U);
2178       }
2179       break;
2180     case LibFunc_log:
2181     case LibFunc_logf:
2182     case LibFunc_log_finite:
2183     case LibFunc_logf_finite:
2184       if (!APF.isNegative() && !APF.isZero() && TLI->has(Func))
2185         return ConstantFoldFP(log, APF, Ty);
2186       break;
2187     case LibFunc_log2:
2188     case LibFunc_log2f:
2189     case LibFunc_log2_finite:
2190     case LibFunc_log2f_finite:
2191       if (!APF.isNegative() && !APF.isZero() && TLI->has(Func))
2192         // TODO: What about hosts that lack a C99 library?
2193         return ConstantFoldFP(Log2, APF, Ty);
2194       break;
2195     case LibFunc_log10:
2196     case LibFunc_log10f:
2197     case LibFunc_log10_finite:
2198     case LibFunc_log10f_finite:
2199       if (!APF.isNegative() && !APF.isZero() && TLI->has(Func))
2200         // TODO: What about hosts that lack a C99 library?
2201         return ConstantFoldFP(log10, APF, Ty);
2202       break;
2203     case LibFunc_nearbyint:
2204     case LibFunc_nearbyintf:
2205     case LibFunc_rint:
2206     case LibFunc_rintf:
2207       if (TLI->has(Func)) {
2208         U.roundToIntegral(APFloat::rmNearestTiesToEven);
2209         return ConstantFP::get(Ty->getContext(), U);
2210       }
2211       break;
2212     case LibFunc_round:
2213     case LibFunc_roundf:
2214       if (TLI->has(Func)) {
2215         U.roundToIntegral(APFloat::rmNearestTiesToAway);
2216         return ConstantFP::get(Ty->getContext(), U);
2217       }
2218       break;
2219     case LibFunc_sin:
2220     case LibFunc_sinf:
2221       if (TLI->has(Func))
2222         return ConstantFoldFP(sin, APF, Ty);
2223       break;
2224     case LibFunc_sinh:
2225     case LibFunc_sinhf:
2226     case LibFunc_sinh_finite:
2227     case LibFunc_sinhf_finite:
2228       if (TLI->has(Func))
2229         return ConstantFoldFP(sinh, APF, Ty);
2230       break;
2231     case LibFunc_sqrt:
2232     case LibFunc_sqrtf:
2233       if (!APF.isNegative() && TLI->has(Func))
2234         return ConstantFoldFP(sqrt, APF, Ty);
2235       break;
2236     case LibFunc_tan:
2237     case LibFunc_tanf:
2238       if (TLI->has(Func))
2239         return ConstantFoldFP(tan, APF, Ty);
2240       break;
2241     case LibFunc_tanh:
2242     case LibFunc_tanhf:
2243       if (TLI->has(Func))
2244         return ConstantFoldFP(tanh, APF, Ty);
2245       break;
2246     case LibFunc_trunc:
2247     case LibFunc_truncf:
2248       if (TLI->has(Func)) {
2249         U.roundToIntegral(APFloat::rmTowardZero);
2250         return ConstantFP::get(Ty->getContext(), U);
2251       }
2252       break;
2253     }
2254     return nullptr;
2255   }
2256 
2257   if (auto *Op = dyn_cast<ConstantInt>(Operands[0])) {
2258     switch (IntrinsicID) {
2259     case Intrinsic::bswap:
2260       return ConstantInt::get(Ty->getContext(), Op->getValue().byteSwap());
2261     case Intrinsic::ctpop:
2262       return ConstantInt::get(Ty, Op->getValue().countPopulation());
2263     case Intrinsic::bitreverse:
2264       return ConstantInt::get(Ty->getContext(), Op->getValue().reverseBits());
2265     case Intrinsic::convert_from_fp16: {
2266       APFloat Val(APFloat::IEEEhalf(), Op->getValue());
2267 
2268       bool lost = false;
2269       APFloat::opStatus status = Val.convert(
2270           Ty->getFltSemantics(), APFloat::rmNearestTiesToEven, &lost);
2271 
2272       // Conversion is always precise.
2273       (void)status;
2274       assert(status == APFloat::opOK && !lost &&
2275              "Precision lost during fp16 constfolding");
2276 
2277       return ConstantFP::get(Ty->getContext(), Val);
2278     }
2279     default:
2280       return nullptr;
2281     }
2282   }
2283 
2284   switch (IntrinsicID) {
2285   default: break;
2286   case Intrinsic::vector_reduce_add:
2287   case Intrinsic::vector_reduce_mul:
2288   case Intrinsic::vector_reduce_and:
2289   case Intrinsic::vector_reduce_or:
2290   case Intrinsic::vector_reduce_xor:
2291   case Intrinsic::vector_reduce_smin:
2292   case Intrinsic::vector_reduce_smax:
2293   case Intrinsic::vector_reduce_umin:
2294   case Intrinsic::vector_reduce_umax:
2295     if (Constant *C = constantFoldVectorReduce(IntrinsicID, Operands[0]))
2296       return C;
2297     break;
2298   }
2299 
2300   // Support ConstantVector in case we have an Undef in the top.
2301   if (isa<ConstantVector>(Operands[0]) ||
2302       isa<ConstantDataVector>(Operands[0])) {
2303     auto *Op = cast<Constant>(Operands[0]);
2304     switch (IntrinsicID) {
2305     default: break;
2306     case Intrinsic::x86_sse_cvtss2si:
2307     case Intrinsic::x86_sse_cvtss2si64:
2308     case Intrinsic::x86_sse2_cvtsd2si:
2309     case Intrinsic::x86_sse2_cvtsd2si64:
2310       if (ConstantFP *FPOp =
2311               dyn_cast_or_null<ConstantFP>(Op->getAggregateElement(0U)))
2312         return ConstantFoldSSEConvertToInt(FPOp->getValueAPF(),
2313                                            /*roundTowardZero=*/false, Ty,
2314                                            /*IsSigned*/true);
2315       break;
2316     case Intrinsic::x86_sse_cvttss2si:
2317     case Intrinsic::x86_sse_cvttss2si64:
2318     case Intrinsic::x86_sse2_cvttsd2si:
2319     case Intrinsic::x86_sse2_cvttsd2si64:
2320       if (ConstantFP *FPOp =
2321               dyn_cast_or_null<ConstantFP>(Op->getAggregateElement(0U)))
2322         return ConstantFoldSSEConvertToInt(FPOp->getValueAPF(),
2323                                            /*roundTowardZero=*/true, Ty,
2324                                            /*IsSigned*/true);
2325       break;
2326     }
2327   }
2328 
2329   return nullptr;
2330 }
2331 
2332 static Constant *ConstantFoldScalarCall2(StringRef Name,
2333                                          Intrinsic::ID IntrinsicID,
2334                                          Type *Ty,
2335                                          ArrayRef<Constant *> Operands,
2336                                          const TargetLibraryInfo *TLI,
2337                                          const CallBase *Call) {
2338   assert(Operands.size() == 2 && "Wrong number of operands.");
2339 
2340   if (Ty->isFloatingPointTy()) {
2341     // TODO: We should have undef handling for all of the FP intrinsics that
2342     //       are attempted to be folded in this function.
2343     bool IsOp0Undef = isa<UndefValue>(Operands[0]);
2344     bool IsOp1Undef = isa<UndefValue>(Operands[1]);
2345     switch (IntrinsicID) {
2346     case Intrinsic::maxnum:
2347     case Intrinsic::minnum:
2348     case Intrinsic::maximum:
2349     case Intrinsic::minimum:
2350       // If one argument is undef, return the other argument.
2351       if (IsOp0Undef)
2352         return Operands[1];
2353       if (IsOp1Undef)
2354         return Operands[0];
2355       break;
2356     }
2357   }
2358 
2359   if (auto *Op1 = dyn_cast<ConstantFP>(Operands[0])) {
2360     if (!Ty->isFloatingPointTy())
2361       return nullptr;
2362     APFloat Op1V = Op1->getValueAPF();
2363 
2364     if (auto *Op2 = dyn_cast<ConstantFP>(Operands[1])) {
2365       if (Op2->getType() != Op1->getType())
2366         return nullptr;
2367       APFloat Op2V = Op2->getValueAPF();
2368 
2369       switch (IntrinsicID) {
2370       default:
2371         break;
2372       case Intrinsic::copysign:
2373         return ConstantFP::get(Ty->getContext(), APFloat::copySign(Op1V, Op2V));
2374       case Intrinsic::minnum:
2375         return ConstantFP::get(Ty->getContext(), minnum(Op1V, Op2V));
2376       case Intrinsic::maxnum:
2377         return ConstantFP::get(Ty->getContext(), maxnum(Op1V, Op2V));
2378       case Intrinsic::minimum:
2379         return ConstantFP::get(Ty->getContext(), minimum(Op1V, Op2V));
2380       case Intrinsic::maximum:
2381         return ConstantFP::get(Ty->getContext(), maximum(Op1V, Op2V));
2382       }
2383 
2384       if (!Ty->isHalfTy() && !Ty->isFloatTy() && !Ty->isDoubleTy())
2385         return nullptr;
2386 
2387       switch (IntrinsicID) {
2388       default:
2389         break;
2390       case Intrinsic::pow:
2391         return ConstantFoldBinaryFP(pow, Op1V, Op2V, Ty);
2392       case Intrinsic::amdgcn_fmul_legacy:
2393         // The legacy behaviour is that multiplying +/- 0.0 by anything, even
2394         // NaN or infinity, gives +0.0.
2395         if (Op1V.isZero() || Op2V.isZero())
2396           return ConstantFP::getNullValue(Ty);
2397         return ConstantFP::get(Ty->getContext(), Op1V * Op2V);
2398       }
2399 
2400       if (!TLI)
2401         return nullptr;
2402 
2403       LibFunc Func = NotLibFunc;
2404       TLI->getLibFunc(Name, Func);
2405       switch (Func) {
2406       default:
2407         break;
2408       case LibFunc_pow:
2409       case LibFunc_powf:
2410       case LibFunc_pow_finite:
2411       case LibFunc_powf_finite:
2412         if (TLI->has(Func))
2413           return ConstantFoldBinaryFP(pow, Op1V, Op2V, Ty);
2414         break;
2415       case LibFunc_fmod:
2416       case LibFunc_fmodf:
2417         if (TLI->has(Func)) {
2418           APFloat V = Op1->getValueAPF();
2419           if (APFloat::opStatus::opOK == V.mod(Op2->getValueAPF()))
2420             return ConstantFP::get(Ty->getContext(), V);
2421         }
2422         break;
2423       case LibFunc_remainder:
2424       case LibFunc_remainderf:
2425         if (TLI->has(Func)) {
2426           APFloat V = Op1->getValueAPF();
2427           if (APFloat::opStatus::opOK == V.remainder(Op2->getValueAPF()))
2428             return ConstantFP::get(Ty->getContext(), V);
2429         }
2430         break;
2431       case LibFunc_atan2:
2432       case LibFunc_atan2f:
2433       case LibFunc_atan2_finite:
2434       case LibFunc_atan2f_finite:
2435         if (TLI->has(Func))
2436           return ConstantFoldBinaryFP(atan2, Op1V, Op2V, Ty);
2437         break;
2438       }
2439     } else if (auto *Op2C = dyn_cast<ConstantInt>(Operands[1])) {
2440       if (IntrinsicID == Intrinsic::powi && Ty->isHalfTy())
2441         return ConstantFP::get(
2442             Ty->getContext(),
2443             APFloat((float)std::pow((float)Op1V.convertToDouble(),
2444                                     (int)Op2C->getZExtValue())));
2445       if (IntrinsicID == Intrinsic::powi && Ty->isFloatTy())
2446         return ConstantFP::get(
2447             Ty->getContext(),
2448             APFloat((float)std::pow((float)Op1V.convertToDouble(),
2449                                     (int)Op2C->getZExtValue())));
2450       if (IntrinsicID == Intrinsic::powi && Ty->isDoubleTy())
2451         return ConstantFP::get(
2452             Ty->getContext(),
2453             APFloat((double)std::pow(Op1V.convertToDouble(),
2454                                      (int)Op2C->getZExtValue())));
2455 
2456       if (IntrinsicID == Intrinsic::amdgcn_ldexp) {
2457         // FIXME: Should flush denorms depending on FP mode, but that's ignored
2458         // everywhere else.
2459 
2460         // scalbn is equivalent to ldexp with float radix 2
2461         APFloat Result = scalbn(Op1->getValueAPF(), Op2C->getSExtValue(),
2462                                 APFloat::rmNearestTiesToEven);
2463         return ConstantFP::get(Ty->getContext(), Result);
2464       }
2465     }
2466     return nullptr;
2467   }
2468 
2469   if (Operands[0]->getType()->isIntegerTy() &&
2470       Operands[1]->getType()->isIntegerTy()) {
2471     const APInt *C0, *C1;
2472     if (!getConstIntOrUndef(Operands[0], C0) ||
2473         !getConstIntOrUndef(Operands[1], C1))
2474       return nullptr;
2475 
2476     unsigned BitWidth = Ty->getScalarSizeInBits();
2477     switch (IntrinsicID) {
2478     default: break;
2479     case Intrinsic::smax:
2480       if (!C0 && !C1)
2481         return UndefValue::get(Ty);
2482       if (!C0 || !C1)
2483         return ConstantInt::get(Ty, APInt::getSignedMaxValue(BitWidth));
2484       return ConstantInt::get(Ty, C0->sgt(*C1) ? *C0 : *C1);
2485 
2486     case Intrinsic::smin:
2487       if (!C0 && !C1)
2488         return UndefValue::get(Ty);
2489       if (!C0 || !C1)
2490         return ConstantInt::get(Ty, APInt::getSignedMinValue(BitWidth));
2491       return ConstantInt::get(Ty, C0->slt(*C1) ? *C0 : *C1);
2492 
2493     case Intrinsic::umax:
2494       if (!C0 && !C1)
2495         return UndefValue::get(Ty);
2496       if (!C0 || !C1)
2497         return ConstantInt::get(Ty, APInt::getMaxValue(BitWidth));
2498       return ConstantInt::get(Ty, C0->ugt(*C1) ? *C0 : *C1);
2499 
2500     case Intrinsic::umin:
2501       if (!C0 && !C1)
2502         return UndefValue::get(Ty);
2503       if (!C0 || !C1)
2504         return ConstantInt::get(Ty, APInt::getMinValue(BitWidth));
2505       return ConstantInt::get(Ty, C0->ult(*C1) ? *C0 : *C1);
2506 
2507     case Intrinsic::usub_with_overflow:
2508     case Intrinsic::ssub_with_overflow:
2509       // X - undef -> { 0, false }
2510       // undef - X -> { 0, false }
2511       if (!C0 || !C1)
2512         return Constant::getNullValue(Ty);
2513       LLVM_FALLTHROUGH;
2514     case Intrinsic::uadd_with_overflow:
2515     case Intrinsic::sadd_with_overflow:
2516       // X + undef -> { -1, false }
2517       // undef + x -> { -1, false }
2518       if (!C0 || !C1) {
2519         return ConstantStruct::get(
2520             cast<StructType>(Ty),
2521             {Constant::getAllOnesValue(Ty->getStructElementType(0)),
2522              Constant::getNullValue(Ty->getStructElementType(1))});
2523       }
2524       LLVM_FALLTHROUGH;
2525     case Intrinsic::smul_with_overflow:
2526     case Intrinsic::umul_with_overflow: {
2527       // undef * X -> { 0, false }
2528       // X * undef -> { 0, false }
2529       if (!C0 || !C1)
2530         return Constant::getNullValue(Ty);
2531 
2532       APInt Res;
2533       bool Overflow;
2534       switch (IntrinsicID) {
2535       default: llvm_unreachable("Invalid case");
2536       case Intrinsic::sadd_with_overflow:
2537         Res = C0->sadd_ov(*C1, Overflow);
2538         break;
2539       case Intrinsic::uadd_with_overflow:
2540         Res = C0->uadd_ov(*C1, Overflow);
2541         break;
2542       case Intrinsic::ssub_with_overflow:
2543         Res = C0->ssub_ov(*C1, Overflow);
2544         break;
2545       case Intrinsic::usub_with_overflow:
2546         Res = C0->usub_ov(*C1, Overflow);
2547         break;
2548       case Intrinsic::smul_with_overflow:
2549         Res = C0->smul_ov(*C1, Overflow);
2550         break;
2551       case Intrinsic::umul_with_overflow:
2552         Res = C0->umul_ov(*C1, Overflow);
2553         break;
2554       }
2555       Constant *Ops[] = {
2556         ConstantInt::get(Ty->getContext(), Res),
2557         ConstantInt::get(Type::getInt1Ty(Ty->getContext()), Overflow)
2558       };
2559       return ConstantStruct::get(cast<StructType>(Ty), Ops);
2560     }
2561     case Intrinsic::uadd_sat:
2562     case Intrinsic::sadd_sat:
2563       if (!C0 && !C1)
2564         return UndefValue::get(Ty);
2565       if (!C0 || !C1)
2566         return Constant::getAllOnesValue(Ty);
2567       if (IntrinsicID == Intrinsic::uadd_sat)
2568         return ConstantInt::get(Ty, C0->uadd_sat(*C1));
2569       else
2570         return ConstantInt::get(Ty, C0->sadd_sat(*C1));
2571     case Intrinsic::usub_sat:
2572     case Intrinsic::ssub_sat:
2573       if (!C0 && !C1)
2574         return UndefValue::get(Ty);
2575       if (!C0 || !C1)
2576         return Constant::getNullValue(Ty);
2577       if (IntrinsicID == Intrinsic::usub_sat)
2578         return ConstantInt::get(Ty, C0->usub_sat(*C1));
2579       else
2580         return ConstantInt::get(Ty, C0->ssub_sat(*C1));
2581     case Intrinsic::cttz:
2582     case Intrinsic::ctlz:
2583       assert(C1 && "Must be constant int");
2584 
2585       // cttz(0, 1) and ctlz(0, 1) are undef.
2586       if (C1->isOneValue() && (!C0 || C0->isNullValue()))
2587         return UndefValue::get(Ty);
2588       if (!C0)
2589         return Constant::getNullValue(Ty);
2590       if (IntrinsicID == Intrinsic::cttz)
2591         return ConstantInt::get(Ty, C0->countTrailingZeros());
2592       else
2593         return ConstantInt::get(Ty, C0->countLeadingZeros());
2594 
2595     case Intrinsic::abs:
2596       // Undef or minimum val operand with poison min --> undef
2597       assert(C1 && "Must be constant int");
2598       if (C1->isOneValue() && (!C0 || C0->isMinSignedValue()))
2599         return UndefValue::get(Ty);
2600 
2601       // Undef operand with no poison min --> 0 (sign bit must be clear)
2602       if (C1->isNullValue() && !C0)
2603         return Constant::getNullValue(Ty);
2604 
2605       return ConstantInt::get(Ty, C0->abs());
2606     }
2607 
2608     return nullptr;
2609   }
2610 
2611   // Support ConstantVector in case we have an Undef in the top.
2612   if ((isa<ConstantVector>(Operands[0]) ||
2613        isa<ConstantDataVector>(Operands[0])) &&
2614       // Check for default rounding mode.
2615       // FIXME: Support other rounding modes?
2616       isa<ConstantInt>(Operands[1]) &&
2617       cast<ConstantInt>(Operands[1])->getValue() == 4) {
2618     auto *Op = cast<Constant>(Operands[0]);
2619     switch (IntrinsicID) {
2620     default: break;
2621     case Intrinsic::x86_avx512_vcvtss2si32:
2622     case Intrinsic::x86_avx512_vcvtss2si64:
2623     case Intrinsic::x86_avx512_vcvtsd2si32:
2624     case Intrinsic::x86_avx512_vcvtsd2si64:
2625       if (ConstantFP *FPOp =
2626               dyn_cast_or_null<ConstantFP>(Op->getAggregateElement(0U)))
2627         return ConstantFoldSSEConvertToInt(FPOp->getValueAPF(),
2628                                            /*roundTowardZero=*/false, Ty,
2629                                            /*IsSigned*/true);
2630       break;
2631     case Intrinsic::x86_avx512_vcvtss2usi32:
2632     case Intrinsic::x86_avx512_vcvtss2usi64:
2633     case Intrinsic::x86_avx512_vcvtsd2usi32:
2634     case Intrinsic::x86_avx512_vcvtsd2usi64:
2635       if (ConstantFP *FPOp =
2636               dyn_cast_or_null<ConstantFP>(Op->getAggregateElement(0U)))
2637         return ConstantFoldSSEConvertToInt(FPOp->getValueAPF(),
2638                                            /*roundTowardZero=*/false, Ty,
2639                                            /*IsSigned*/false);
2640       break;
2641     case Intrinsic::x86_avx512_cvttss2si:
2642     case Intrinsic::x86_avx512_cvttss2si64:
2643     case Intrinsic::x86_avx512_cvttsd2si:
2644     case Intrinsic::x86_avx512_cvttsd2si64:
2645       if (ConstantFP *FPOp =
2646               dyn_cast_or_null<ConstantFP>(Op->getAggregateElement(0U)))
2647         return ConstantFoldSSEConvertToInt(FPOp->getValueAPF(),
2648                                            /*roundTowardZero=*/true, Ty,
2649                                            /*IsSigned*/true);
2650       break;
2651     case Intrinsic::x86_avx512_cvttss2usi:
2652     case Intrinsic::x86_avx512_cvttss2usi64:
2653     case Intrinsic::x86_avx512_cvttsd2usi:
2654     case Intrinsic::x86_avx512_cvttsd2usi64:
2655       if (ConstantFP *FPOp =
2656               dyn_cast_or_null<ConstantFP>(Op->getAggregateElement(0U)))
2657         return ConstantFoldSSEConvertToInt(FPOp->getValueAPF(),
2658                                            /*roundTowardZero=*/true, Ty,
2659                                            /*IsSigned*/false);
2660       break;
2661     }
2662   }
2663   return nullptr;
2664 }
2665 
2666 static APFloat ConstantFoldAMDGCNCubeIntrinsic(Intrinsic::ID IntrinsicID,
2667                                                const APFloat &S0,
2668                                                const APFloat &S1,
2669                                                const APFloat &S2) {
2670   unsigned ID;
2671   const fltSemantics &Sem = S0.getSemantics();
2672   APFloat MA(Sem), SC(Sem), TC(Sem);
2673   if (abs(S2) >= abs(S0) && abs(S2) >= abs(S1)) {
2674     if (S2.isNegative() && S2.isNonZero() && !S2.isNaN()) {
2675       // S2 < 0
2676       ID = 5;
2677       SC = -S0;
2678     } else {
2679       ID = 4;
2680       SC = S0;
2681     }
2682     MA = S2;
2683     TC = -S1;
2684   } else if (abs(S1) >= abs(S0)) {
2685     if (S1.isNegative() && S1.isNonZero() && !S1.isNaN()) {
2686       // S1 < 0
2687       ID = 3;
2688       TC = -S2;
2689     } else {
2690       ID = 2;
2691       TC = S2;
2692     }
2693     MA = S1;
2694     SC = S0;
2695   } else {
2696     if (S0.isNegative() && S0.isNonZero() && !S0.isNaN()) {
2697       // S0 < 0
2698       ID = 1;
2699       SC = S2;
2700     } else {
2701       ID = 0;
2702       SC = -S2;
2703     }
2704     MA = S0;
2705     TC = -S1;
2706   }
2707   switch (IntrinsicID) {
2708   default:
2709     llvm_unreachable("unhandled amdgcn cube intrinsic");
2710   case Intrinsic::amdgcn_cubeid:
2711     return APFloat(Sem, ID);
2712   case Intrinsic::amdgcn_cubema:
2713     return MA + MA;
2714   case Intrinsic::amdgcn_cubesc:
2715     return SC;
2716   case Intrinsic::amdgcn_cubetc:
2717     return TC;
2718   }
2719 }
2720 
2721 static Constant *ConstantFoldAMDGCNPermIntrinsic(ArrayRef<Constant *> Operands,
2722                                                  Type *Ty) {
2723   const APInt *C0, *C1, *C2;
2724   if (!getConstIntOrUndef(Operands[0], C0) ||
2725       !getConstIntOrUndef(Operands[1], C1) ||
2726       !getConstIntOrUndef(Operands[2], C2))
2727     return nullptr;
2728 
2729   if (!C2)
2730     return UndefValue::get(Ty);
2731 
2732   APInt Val(32, 0);
2733   unsigned NumUndefBytes = 0;
2734   for (unsigned I = 0; I < 32; I += 8) {
2735     unsigned Sel = C2->extractBitsAsZExtValue(8, I);
2736     unsigned B = 0;
2737 
2738     if (Sel >= 13)
2739       B = 0xff;
2740     else if (Sel == 12)
2741       B = 0x00;
2742     else {
2743       const APInt *Src = ((Sel & 10) == 10 || (Sel & 12) == 4) ? C0 : C1;
2744       if (!Src)
2745         ++NumUndefBytes;
2746       else if (Sel < 8)
2747         B = Src->extractBitsAsZExtValue(8, (Sel & 3) * 8);
2748       else
2749         B = Src->extractBitsAsZExtValue(1, (Sel & 1) ? 31 : 15) * 0xff;
2750     }
2751 
2752     Val.insertBits(B, I, 8);
2753   }
2754 
2755   if (NumUndefBytes == 4)
2756     return UndefValue::get(Ty);
2757 
2758   return ConstantInt::get(Ty, Val);
2759 }
2760 
2761 static Constant *ConstantFoldScalarCall3(StringRef Name,
2762                                          Intrinsic::ID IntrinsicID,
2763                                          Type *Ty,
2764                                          ArrayRef<Constant *> Operands,
2765                                          const TargetLibraryInfo *TLI,
2766                                          const CallBase *Call) {
2767   assert(Operands.size() == 3 && "Wrong number of operands.");
2768 
2769   if (const auto *Op1 = dyn_cast<ConstantFP>(Operands[0])) {
2770     if (const auto *Op2 = dyn_cast<ConstantFP>(Operands[1])) {
2771       if (const auto *Op3 = dyn_cast<ConstantFP>(Operands[2])) {
2772         const APFloat &C1 = Op1->getValueAPF();
2773         const APFloat &C2 = Op2->getValueAPF();
2774         const APFloat &C3 = Op3->getValueAPF();
2775         switch (IntrinsicID) {
2776         default: break;
2777         case Intrinsic::amdgcn_fma_legacy: {
2778           // The legacy behaviour is that multiplying +/- 0.0 by anything, even
2779           // NaN or infinity, gives +0.0.
2780           if (C1.isZero() || C2.isZero()) {
2781             // It's tempting to just return C3 here, but that would give the
2782             // wrong result if C3 was -0.0.
2783             return ConstantFP::get(Ty->getContext(), APFloat(0.0f) + C3);
2784           }
2785           LLVM_FALLTHROUGH;
2786         }
2787         case Intrinsic::fma:
2788         case Intrinsic::fmuladd: {
2789           APFloat V = C1;
2790           V.fusedMultiplyAdd(C2, C3, APFloat::rmNearestTiesToEven);
2791           return ConstantFP::get(Ty->getContext(), V);
2792         }
2793         case Intrinsic::amdgcn_cubeid:
2794         case Intrinsic::amdgcn_cubema:
2795         case Intrinsic::amdgcn_cubesc:
2796         case Intrinsic::amdgcn_cubetc: {
2797           APFloat V = ConstantFoldAMDGCNCubeIntrinsic(IntrinsicID, C1, C2, C3);
2798           return ConstantFP::get(Ty->getContext(), V);
2799         }
2800         }
2801       }
2802     }
2803   }
2804 
2805   if (IntrinsicID == Intrinsic::smul_fix ||
2806       IntrinsicID == Intrinsic::smul_fix_sat) {
2807     // poison * C -> poison
2808     // C * poison -> poison
2809     if (isa<PoisonValue>(Operands[0]) || isa<PoisonValue>(Operands[1]))
2810       return PoisonValue::get(Ty);
2811 
2812     const APInt *C0, *C1;
2813     if (!getConstIntOrUndef(Operands[0], C0) ||
2814         !getConstIntOrUndef(Operands[1], C1))
2815       return nullptr;
2816 
2817     // undef * C -> 0
2818     // C * undef -> 0
2819     if (!C0 || !C1)
2820       return Constant::getNullValue(Ty);
2821 
2822     // This code performs rounding towards negative infinity in case the result
2823     // cannot be represented exactly for the given scale. Targets that do care
2824     // about rounding should use a target hook for specifying how rounding
2825     // should be done, and provide their own folding to be consistent with
2826     // rounding. This is the same approach as used by
2827     // DAGTypeLegalizer::ExpandIntRes_MULFIX.
2828     unsigned Scale = cast<ConstantInt>(Operands[2])->getZExtValue();
2829     unsigned Width = C0->getBitWidth();
2830     assert(Scale < Width && "Illegal scale.");
2831     unsigned ExtendedWidth = Width * 2;
2832     APInt Product = (C0->sextOrSelf(ExtendedWidth) *
2833                      C1->sextOrSelf(ExtendedWidth)).ashr(Scale);
2834     if (IntrinsicID == Intrinsic::smul_fix_sat) {
2835       APInt Max = APInt::getSignedMaxValue(Width).sextOrSelf(ExtendedWidth);
2836       APInt Min = APInt::getSignedMinValue(Width).sextOrSelf(ExtendedWidth);
2837       Product = APIntOps::smin(Product, Max);
2838       Product = APIntOps::smax(Product, Min);
2839     }
2840     return ConstantInt::get(Ty->getContext(), Product.sextOrTrunc(Width));
2841   }
2842 
2843   if (IntrinsicID == Intrinsic::fshl || IntrinsicID == Intrinsic::fshr) {
2844     const APInt *C0, *C1, *C2;
2845     if (!getConstIntOrUndef(Operands[0], C0) ||
2846         !getConstIntOrUndef(Operands[1], C1) ||
2847         !getConstIntOrUndef(Operands[2], C2))
2848       return nullptr;
2849 
2850     bool IsRight = IntrinsicID == Intrinsic::fshr;
2851     if (!C2)
2852       return Operands[IsRight ? 1 : 0];
2853     if (!C0 && !C1)
2854       return UndefValue::get(Ty);
2855 
2856     // The shift amount is interpreted as modulo the bitwidth. If the shift
2857     // amount is effectively 0, avoid UB due to oversized inverse shift below.
2858     unsigned BitWidth = C2->getBitWidth();
2859     unsigned ShAmt = C2->urem(BitWidth);
2860     if (!ShAmt)
2861       return Operands[IsRight ? 1 : 0];
2862 
2863     // (C0 << ShlAmt) | (C1 >> LshrAmt)
2864     unsigned LshrAmt = IsRight ? ShAmt : BitWidth - ShAmt;
2865     unsigned ShlAmt = !IsRight ? ShAmt : BitWidth - ShAmt;
2866     if (!C0)
2867       return ConstantInt::get(Ty, C1->lshr(LshrAmt));
2868     if (!C1)
2869       return ConstantInt::get(Ty, C0->shl(ShlAmt));
2870     return ConstantInt::get(Ty, C0->shl(ShlAmt) | C1->lshr(LshrAmt));
2871   }
2872 
2873   if (IntrinsicID == Intrinsic::amdgcn_perm)
2874     return ConstantFoldAMDGCNPermIntrinsic(Operands, Ty);
2875 
2876   return nullptr;
2877 }
2878 
2879 static Constant *ConstantFoldScalarCall(StringRef Name,
2880                                         Intrinsic::ID IntrinsicID,
2881                                         Type *Ty,
2882                                         ArrayRef<Constant *> Operands,
2883                                         const TargetLibraryInfo *TLI,
2884                                         const CallBase *Call) {
2885   if (Operands.size() == 1)
2886     return ConstantFoldScalarCall1(Name, IntrinsicID, Ty, Operands, TLI, Call);
2887 
2888   if (Operands.size() == 2)
2889     return ConstantFoldScalarCall2(Name, IntrinsicID, Ty, Operands, TLI, Call);
2890 
2891   if (Operands.size() == 3)
2892     return ConstantFoldScalarCall3(Name, IntrinsicID, Ty, Operands, TLI, Call);
2893 
2894   return nullptr;
2895 }
2896 
2897 static Constant *ConstantFoldFixedVectorCall(
2898     StringRef Name, Intrinsic::ID IntrinsicID, FixedVectorType *FVTy,
2899     ArrayRef<Constant *> Operands, const DataLayout &DL,
2900     const TargetLibraryInfo *TLI, const CallBase *Call) {
2901   SmallVector<Constant *, 4> Result(FVTy->getNumElements());
2902   SmallVector<Constant *, 4> Lane(Operands.size());
2903   Type *Ty = FVTy->getElementType();
2904 
2905   switch (IntrinsicID) {
2906   case Intrinsic::masked_load: {
2907     auto *SrcPtr = Operands[0];
2908     auto *Mask = Operands[2];
2909     auto *Passthru = Operands[3];
2910 
2911     Constant *VecData = ConstantFoldLoadFromConstPtr(SrcPtr, FVTy, DL);
2912 
2913     SmallVector<Constant *, 32> NewElements;
2914     for (unsigned I = 0, E = FVTy->getNumElements(); I != E; ++I) {
2915       auto *MaskElt = Mask->getAggregateElement(I);
2916       if (!MaskElt)
2917         break;
2918       auto *PassthruElt = Passthru->getAggregateElement(I);
2919       auto *VecElt = VecData ? VecData->getAggregateElement(I) : nullptr;
2920       if (isa<UndefValue>(MaskElt)) {
2921         if (PassthruElt)
2922           NewElements.push_back(PassthruElt);
2923         else if (VecElt)
2924           NewElements.push_back(VecElt);
2925         else
2926           return nullptr;
2927       }
2928       if (MaskElt->isNullValue()) {
2929         if (!PassthruElt)
2930           return nullptr;
2931         NewElements.push_back(PassthruElt);
2932       } else if (MaskElt->isOneValue()) {
2933         if (!VecElt)
2934           return nullptr;
2935         NewElements.push_back(VecElt);
2936       } else {
2937         return nullptr;
2938       }
2939     }
2940     if (NewElements.size() != FVTy->getNumElements())
2941       return nullptr;
2942     return ConstantVector::get(NewElements);
2943   }
2944   case Intrinsic::arm_mve_vctp8:
2945   case Intrinsic::arm_mve_vctp16:
2946   case Intrinsic::arm_mve_vctp32:
2947   case Intrinsic::arm_mve_vctp64: {
2948     if (auto *Op = dyn_cast<ConstantInt>(Operands[0])) {
2949       unsigned Lanes = FVTy->getNumElements();
2950       uint64_t Limit = Op->getZExtValue();
2951       // vctp64 are currently modelled as returning a v4i1, not a v2i1. Make
2952       // sure we get the limit right in that case and set all relevant lanes.
2953       if (IntrinsicID == Intrinsic::arm_mve_vctp64)
2954         Limit *= 2;
2955 
2956       SmallVector<Constant *, 16> NCs;
2957       for (unsigned i = 0; i < Lanes; i++) {
2958         if (i < Limit)
2959           NCs.push_back(ConstantInt::getTrue(Ty));
2960         else
2961           NCs.push_back(ConstantInt::getFalse(Ty));
2962       }
2963       return ConstantVector::get(NCs);
2964     }
2965     break;
2966   }
2967   case Intrinsic::get_active_lane_mask: {
2968     auto *Op0 = dyn_cast<ConstantInt>(Operands[0]);
2969     auto *Op1 = dyn_cast<ConstantInt>(Operands[1]);
2970     if (Op0 && Op1) {
2971       unsigned Lanes = FVTy->getNumElements();
2972       uint64_t Base = Op0->getZExtValue();
2973       uint64_t Limit = Op1->getZExtValue();
2974 
2975       SmallVector<Constant *, 16> NCs;
2976       for (unsigned i = 0; i < Lanes; i++) {
2977         if (Base + i < Limit)
2978           NCs.push_back(ConstantInt::getTrue(Ty));
2979         else
2980           NCs.push_back(ConstantInt::getFalse(Ty));
2981       }
2982       return ConstantVector::get(NCs);
2983     }
2984     break;
2985   }
2986   default:
2987     break;
2988   }
2989 
2990   for (unsigned I = 0, E = FVTy->getNumElements(); I != E; ++I) {
2991     // Gather a column of constants.
2992     for (unsigned J = 0, JE = Operands.size(); J != JE; ++J) {
2993       // Some intrinsics use a scalar type for certain arguments.
2994       if (hasVectorInstrinsicScalarOpd(IntrinsicID, J)) {
2995         Lane[J] = Operands[J];
2996         continue;
2997       }
2998 
2999       Constant *Agg = Operands[J]->getAggregateElement(I);
3000       if (!Agg)
3001         return nullptr;
3002 
3003       Lane[J] = Agg;
3004     }
3005 
3006     // Use the regular scalar folding to simplify this column.
3007     Constant *Folded =
3008         ConstantFoldScalarCall(Name, IntrinsicID, Ty, Lane, TLI, Call);
3009     if (!Folded)
3010       return nullptr;
3011     Result[I] = Folded;
3012   }
3013 
3014   return ConstantVector::get(Result);
3015 }
3016 
3017 static Constant *ConstantFoldScalableVectorCall(
3018     StringRef Name, Intrinsic::ID IntrinsicID, ScalableVectorType *SVTy,
3019     ArrayRef<Constant *> Operands, const DataLayout &DL,
3020     const TargetLibraryInfo *TLI, const CallBase *Call) {
3021   switch (IntrinsicID) {
3022   case Intrinsic::aarch64_sve_convert_from_svbool: {
3023     auto *Src = dyn_cast<Constant>(Operands[0]);
3024     if (!Src || !Src->isNullValue())
3025       break;
3026 
3027     return ConstantInt::getFalse(SVTy);
3028   }
3029   default:
3030     break;
3031   }
3032   return nullptr;
3033 }
3034 
3035 } // end anonymous namespace
3036 
3037 Constant *llvm::ConstantFoldCall(const CallBase *Call, Function *F,
3038                                  ArrayRef<Constant *> Operands,
3039                                  const TargetLibraryInfo *TLI) {
3040   if (Call->isNoBuiltin())
3041     return nullptr;
3042   if (!F->hasName())
3043     return nullptr;
3044   StringRef Name = F->getName();
3045 
3046   Type *Ty = F->getReturnType();
3047 
3048   if (auto *FVTy = dyn_cast<FixedVectorType>(Ty))
3049     return ConstantFoldFixedVectorCall(
3050         Name, F->getIntrinsicID(), FVTy, Operands,
3051         F->getParent()->getDataLayout(), TLI, Call);
3052 
3053   if (auto *SVTy = dyn_cast<ScalableVectorType>(Ty))
3054     return ConstantFoldScalableVectorCall(
3055         Name, F->getIntrinsicID(), SVTy, Operands,
3056         F->getParent()->getDataLayout(), TLI, Call);
3057 
3058   return ConstantFoldScalarCall(Name, F->getIntrinsicID(), Ty, Operands, TLI,
3059                                 Call);
3060 }
3061 
3062 bool llvm::isMathLibCallNoop(const CallBase *Call,
3063                              const TargetLibraryInfo *TLI) {
3064   // FIXME: Refactor this code; this duplicates logic in LibCallsShrinkWrap
3065   // (and to some extent ConstantFoldScalarCall).
3066   if (Call->isNoBuiltin() || Call->isStrictFP())
3067     return false;
3068   Function *F = Call->getCalledFunction();
3069   if (!F)
3070     return false;
3071 
3072   LibFunc Func;
3073   if (!TLI || !TLI->getLibFunc(*F, Func))
3074     return false;
3075 
3076   if (Call->getNumArgOperands() == 1) {
3077     if (ConstantFP *OpC = dyn_cast<ConstantFP>(Call->getArgOperand(0))) {
3078       const APFloat &Op = OpC->getValueAPF();
3079       switch (Func) {
3080       case LibFunc_logl:
3081       case LibFunc_log:
3082       case LibFunc_logf:
3083       case LibFunc_log2l:
3084       case LibFunc_log2:
3085       case LibFunc_log2f:
3086       case LibFunc_log10l:
3087       case LibFunc_log10:
3088       case LibFunc_log10f:
3089         return Op.isNaN() || (!Op.isZero() && !Op.isNegative());
3090 
3091       case LibFunc_expl:
3092       case LibFunc_exp:
3093       case LibFunc_expf:
3094         // FIXME: These boundaries are slightly conservative.
3095         if (OpC->getType()->isDoubleTy())
3096           return !(Op < APFloat(-745.0) || Op > APFloat(709.0));
3097         if (OpC->getType()->isFloatTy())
3098           return !(Op < APFloat(-103.0f) || Op > APFloat(88.0f));
3099         break;
3100 
3101       case LibFunc_exp2l:
3102       case LibFunc_exp2:
3103       case LibFunc_exp2f:
3104         // FIXME: These boundaries are slightly conservative.
3105         if (OpC->getType()->isDoubleTy())
3106           return !(Op < APFloat(-1074.0) || Op > APFloat(1023.0));
3107         if (OpC->getType()->isFloatTy())
3108           return !(Op < APFloat(-149.0f) || Op > APFloat(127.0f));
3109         break;
3110 
3111       case LibFunc_sinl:
3112       case LibFunc_sin:
3113       case LibFunc_sinf:
3114       case LibFunc_cosl:
3115       case LibFunc_cos:
3116       case LibFunc_cosf:
3117         return !Op.isInfinity();
3118 
3119       case LibFunc_tanl:
3120       case LibFunc_tan:
3121       case LibFunc_tanf: {
3122         // FIXME: Stop using the host math library.
3123         // FIXME: The computation isn't done in the right precision.
3124         Type *Ty = OpC->getType();
3125         if (Ty->isDoubleTy() || Ty->isFloatTy() || Ty->isHalfTy())
3126           return ConstantFoldFP(tan, OpC->getValueAPF(), Ty) != nullptr;
3127         break;
3128       }
3129 
3130       case LibFunc_asinl:
3131       case LibFunc_asin:
3132       case LibFunc_asinf:
3133       case LibFunc_acosl:
3134       case LibFunc_acos:
3135       case LibFunc_acosf:
3136         return !(Op < APFloat(Op.getSemantics(), "-1") ||
3137                  Op > APFloat(Op.getSemantics(), "1"));
3138 
3139       case LibFunc_sinh:
3140       case LibFunc_cosh:
3141       case LibFunc_sinhf:
3142       case LibFunc_coshf:
3143       case LibFunc_sinhl:
3144       case LibFunc_coshl:
3145         // FIXME: These boundaries are slightly conservative.
3146         if (OpC->getType()->isDoubleTy())
3147           return !(Op < APFloat(-710.0) || Op > APFloat(710.0));
3148         if (OpC->getType()->isFloatTy())
3149           return !(Op < APFloat(-89.0f) || Op > APFloat(89.0f));
3150         break;
3151 
3152       case LibFunc_sqrtl:
3153       case LibFunc_sqrt:
3154       case LibFunc_sqrtf:
3155         return Op.isNaN() || Op.isZero() || !Op.isNegative();
3156 
3157       // FIXME: Add more functions: sqrt_finite, atanh, expm1, log1p,
3158       // maybe others?
3159       default:
3160         break;
3161       }
3162     }
3163   }
3164 
3165   if (Call->getNumArgOperands() == 2) {
3166     ConstantFP *Op0C = dyn_cast<ConstantFP>(Call->getArgOperand(0));
3167     ConstantFP *Op1C = dyn_cast<ConstantFP>(Call->getArgOperand(1));
3168     if (Op0C && Op1C) {
3169       const APFloat &Op0 = Op0C->getValueAPF();
3170       const APFloat &Op1 = Op1C->getValueAPF();
3171 
3172       switch (Func) {
3173       case LibFunc_powl:
3174       case LibFunc_pow:
3175       case LibFunc_powf: {
3176         // FIXME: Stop using the host math library.
3177         // FIXME: The computation isn't done in the right precision.
3178         Type *Ty = Op0C->getType();
3179         if (Ty->isDoubleTy() || Ty->isFloatTy() || Ty->isHalfTy()) {
3180           if (Ty == Op1C->getType())
3181             return ConstantFoldBinaryFP(pow, Op0, Op1, Ty) != nullptr;
3182         }
3183         break;
3184       }
3185 
3186       case LibFunc_fmodl:
3187       case LibFunc_fmod:
3188       case LibFunc_fmodf:
3189       case LibFunc_remainderl:
3190       case LibFunc_remainder:
3191       case LibFunc_remainderf:
3192         return Op0.isNaN() || Op1.isNaN() ||
3193                (!Op0.isInfinity() && !Op1.isZero());
3194 
3195       default:
3196         break;
3197       }
3198     }
3199   }
3200 
3201   return false;
3202 }
3203 
3204 void TargetFolder::anchor() {}
3205