1 //===-- ConstantFolding.cpp - Fold instructions into constants ------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file defines routines for folding instructions into constants.
11 //
12 // Also, to supplement the basic IR ConstantExpr simplifications,
13 // this file defines some additional folding routines that can make use of
14 // DataLayout information. These functions cannot go in IR due to library
15 // dependency issues.
16 //
17 //===----------------------------------------------------------------------===//
18 
19 #include "llvm/Analysis/ConstantFolding.h"
20 #include "llvm/ADT/APFloat.h"
21 #include "llvm/ADT/APInt.h"
22 #include "llvm/ADT/ArrayRef.h"
23 #include "llvm/ADT/DenseMap.h"
24 #include "llvm/ADT/STLExtras.h"
25 #include "llvm/ADT/StringRef.h"
26 #include "llvm/ADT/SmallVector.h"
27 #include "llvm/Analysis/TargetLibraryInfo.h"
28 #include "llvm/Analysis/ValueTracking.h"
29 #include "llvm/Config/config.h"
30 #include "llvm/IR/Constant.h"
31 #include "llvm/IR/Constants.h"
32 #include "llvm/IR/DataLayout.h"
33 #include "llvm/IR/DerivedTypes.h"
34 #include "llvm/IR/Function.h"
35 #include "llvm/IR/GlobalValue.h"
36 #include "llvm/IR/GlobalVariable.h"
37 #include "llvm/IR/InstrTypes.h"
38 #include "llvm/IR/Instruction.h"
39 #include "llvm/IR/Instructions.h"
40 #include "llvm/IR/Operator.h"
41 #include "llvm/IR/Type.h"
42 #include "llvm/IR/Value.h"
43 #include "llvm/Support/Casting.h"
44 #include "llvm/Support/ErrorHandling.h"
45 #include "llvm/Support/MathExtras.h"
46 #include <cassert>
47 #include <cerrno>
48 #include <cfenv>
49 #include <cmath>
50 #include <cstddef>
51 #include <cstdint>
52 
53 using namespace llvm;
54 
55 namespace {
56 
57 //===----------------------------------------------------------------------===//
58 // Constant Folding internal helper functions
59 //===----------------------------------------------------------------------===//
60 
61 static Constant *foldConstVectorToAPInt(APInt &Result, Type *DestTy,
62                                         Constant *C, Type *SrcEltTy,
63                                         unsigned NumSrcElts,
64                                         const DataLayout &DL) {
65   // Now that we know that the input value is a vector of integers, just shift
66   // and insert them into our result.
67   unsigned BitShift = DL.getTypeSizeInBits(SrcEltTy);
68   for (unsigned i = 0; i != NumSrcElts; ++i) {
69     Constant *Element;
70     if (DL.isLittleEndian())
71       Element = C->getAggregateElement(NumSrcElts - i - 1);
72     else
73       Element = C->getAggregateElement(i);
74 
75     if (Element && isa<UndefValue>(Element)) {
76       Result <<= BitShift;
77       continue;
78     }
79 
80     auto *ElementCI = dyn_cast_or_null<ConstantInt>(Element);
81     if (!ElementCI)
82       return ConstantExpr::getBitCast(C, DestTy);
83 
84     Result <<= BitShift;
85     Result |= ElementCI->getValue().zextOrSelf(Result.getBitWidth());
86   }
87 
88   return nullptr;
89 }
90 
91 /// Constant fold bitcast, symbolically evaluating it with DataLayout.
92 /// This always returns a non-null constant, but it may be a
93 /// ConstantExpr if unfoldable.
94 Constant *FoldBitCast(Constant *C, Type *DestTy, const DataLayout &DL) {
95   // Catch the obvious splat cases.
96   if (C->isNullValue() && !DestTy->isX86_MMXTy())
97     return Constant::getNullValue(DestTy);
98   if (C->isAllOnesValue() && !DestTy->isX86_MMXTy() &&
99       !DestTy->isPtrOrPtrVectorTy()) // Don't get ones for ptr types!
100     return Constant::getAllOnesValue(DestTy);
101 
102   if (auto *VTy = dyn_cast<VectorType>(C->getType())) {
103     // Handle a vector->scalar integer/fp cast.
104     if (isa<IntegerType>(DestTy) || DestTy->isFloatingPointTy()) {
105       unsigned NumSrcElts = VTy->getNumElements();
106       Type *SrcEltTy = VTy->getElementType();
107 
108       // If the vector is a vector of floating point, convert it to vector of int
109       // to simplify things.
110       if (SrcEltTy->isFloatingPointTy()) {
111         unsigned FPWidth = SrcEltTy->getPrimitiveSizeInBits();
112         Type *SrcIVTy =
113           VectorType::get(IntegerType::get(C->getContext(), FPWidth), NumSrcElts);
114         // Ask IR to do the conversion now that #elts line up.
115         C = ConstantExpr::getBitCast(C, SrcIVTy);
116       }
117 
118       APInt Result(DL.getTypeSizeInBits(DestTy), 0);
119       if (Constant *CE = foldConstVectorToAPInt(Result, DestTy, C,
120                                                 SrcEltTy, NumSrcElts, DL))
121         return CE;
122 
123       if (isa<IntegerType>(DestTy))
124         return ConstantInt::get(DestTy, Result);
125 
126       APFloat FP(DestTy->getFltSemantics(), Result);
127       return ConstantFP::get(DestTy->getContext(), FP);
128     }
129   }
130 
131   // The code below only handles casts to vectors currently.
132   auto *DestVTy = dyn_cast<VectorType>(DestTy);
133   if (!DestVTy)
134     return ConstantExpr::getBitCast(C, DestTy);
135 
136   // If this is a scalar -> vector cast, convert the input into a <1 x scalar>
137   // vector so the code below can handle it uniformly.
138   if (isa<ConstantFP>(C) || isa<ConstantInt>(C)) {
139     Constant *Ops = C; // don't take the address of C!
140     return FoldBitCast(ConstantVector::get(Ops), DestTy, DL);
141   }
142 
143   // If this is a bitcast from constant vector -> vector, fold it.
144   if (!isa<ConstantDataVector>(C) && !isa<ConstantVector>(C))
145     return ConstantExpr::getBitCast(C, DestTy);
146 
147   // If the element types match, IR can fold it.
148   unsigned NumDstElt = DestVTy->getNumElements();
149   unsigned NumSrcElt = C->getType()->getVectorNumElements();
150   if (NumDstElt == NumSrcElt)
151     return ConstantExpr::getBitCast(C, DestTy);
152 
153   Type *SrcEltTy = C->getType()->getVectorElementType();
154   Type *DstEltTy = DestVTy->getElementType();
155 
156   // Otherwise, we're changing the number of elements in a vector, which
157   // requires endianness information to do the right thing.  For example,
158   //    bitcast (<2 x i64> <i64 0, i64 1> to <4 x i32>)
159   // folds to (little endian):
160   //    <4 x i32> <i32 0, i32 0, i32 1, i32 0>
161   // and to (big endian):
162   //    <4 x i32> <i32 0, i32 0, i32 0, i32 1>
163 
164   // First thing is first.  We only want to think about integer here, so if
165   // we have something in FP form, recast it as integer.
166   if (DstEltTy->isFloatingPointTy()) {
167     // Fold to an vector of integers with same size as our FP type.
168     unsigned FPWidth = DstEltTy->getPrimitiveSizeInBits();
169     Type *DestIVTy =
170       VectorType::get(IntegerType::get(C->getContext(), FPWidth), NumDstElt);
171     // Recursively handle this integer conversion, if possible.
172     C = FoldBitCast(C, DestIVTy, DL);
173 
174     // Finally, IR can handle this now that #elts line up.
175     return ConstantExpr::getBitCast(C, DestTy);
176   }
177 
178   // Okay, we know the destination is integer, if the input is FP, convert
179   // it to integer first.
180   if (SrcEltTy->isFloatingPointTy()) {
181     unsigned FPWidth = SrcEltTy->getPrimitiveSizeInBits();
182     Type *SrcIVTy =
183       VectorType::get(IntegerType::get(C->getContext(), FPWidth), NumSrcElt);
184     // Ask IR to do the conversion now that #elts line up.
185     C = ConstantExpr::getBitCast(C, SrcIVTy);
186     // If IR wasn't able to fold it, bail out.
187     if (!isa<ConstantVector>(C) &&  // FIXME: Remove ConstantVector.
188         !isa<ConstantDataVector>(C))
189       return C;
190   }
191 
192   // Now we know that the input and output vectors are both integer vectors
193   // of the same size, and that their #elements is not the same.  Do the
194   // conversion here, which depends on whether the input or output has
195   // more elements.
196   bool isLittleEndian = DL.isLittleEndian();
197 
198   SmallVector<Constant*, 32> Result;
199   if (NumDstElt < NumSrcElt) {
200     // Handle: bitcast (<4 x i32> <i32 0, i32 1, i32 2, i32 3> to <2 x i64>)
201     Constant *Zero = Constant::getNullValue(DstEltTy);
202     unsigned Ratio = NumSrcElt/NumDstElt;
203     unsigned SrcBitSize = SrcEltTy->getPrimitiveSizeInBits();
204     unsigned SrcElt = 0;
205     for (unsigned i = 0; i != NumDstElt; ++i) {
206       // Build each element of the result.
207       Constant *Elt = Zero;
208       unsigned ShiftAmt = isLittleEndian ? 0 : SrcBitSize*(Ratio-1);
209       for (unsigned j = 0; j != Ratio; ++j) {
210         Constant *Src = C->getAggregateElement(SrcElt++);
211         if (Src && isa<UndefValue>(Src))
212           Src = Constant::getNullValue(C->getType()->getVectorElementType());
213         else
214           Src = dyn_cast_or_null<ConstantInt>(Src);
215         if (!Src)  // Reject constantexpr elements.
216           return ConstantExpr::getBitCast(C, DestTy);
217 
218         // Zero extend the element to the right size.
219         Src = ConstantExpr::getZExt(Src, Elt->getType());
220 
221         // Shift it to the right place, depending on endianness.
222         Src = ConstantExpr::getShl(Src,
223                                    ConstantInt::get(Src->getType(), ShiftAmt));
224         ShiftAmt += isLittleEndian ? SrcBitSize : -SrcBitSize;
225 
226         // Mix it in.
227         Elt = ConstantExpr::getOr(Elt, Src);
228       }
229       Result.push_back(Elt);
230     }
231     return ConstantVector::get(Result);
232   }
233 
234   // Handle: bitcast (<2 x i64> <i64 0, i64 1> to <4 x i32>)
235   unsigned Ratio = NumDstElt/NumSrcElt;
236   unsigned DstBitSize = DL.getTypeSizeInBits(DstEltTy);
237 
238   // Loop over each source value, expanding into multiple results.
239   for (unsigned i = 0; i != NumSrcElt; ++i) {
240     auto *Element = C->getAggregateElement(i);
241 
242     if (!Element) // Reject constantexpr elements.
243       return ConstantExpr::getBitCast(C, DestTy);
244 
245     if (isa<UndefValue>(Element)) {
246       // Correctly Propagate undef values.
247       Result.append(Ratio, UndefValue::get(DstEltTy));
248       continue;
249     }
250 
251     auto *Src = dyn_cast<ConstantInt>(Element);
252     if (!Src)
253       return ConstantExpr::getBitCast(C, DestTy);
254 
255     unsigned ShiftAmt = isLittleEndian ? 0 : DstBitSize*(Ratio-1);
256     for (unsigned j = 0; j != Ratio; ++j) {
257       // Shift the piece of the value into the right place, depending on
258       // endianness.
259       Constant *Elt = ConstantExpr::getLShr(Src,
260                                   ConstantInt::get(Src->getType(), ShiftAmt));
261       ShiftAmt += isLittleEndian ? DstBitSize : -DstBitSize;
262 
263       // Truncate the element to an integer with the same pointer size and
264       // convert the element back to a pointer using a inttoptr.
265       if (DstEltTy->isPointerTy()) {
266         IntegerType *DstIntTy = Type::getIntNTy(C->getContext(), DstBitSize);
267         Constant *CE = ConstantExpr::getTrunc(Elt, DstIntTy);
268         Result.push_back(ConstantExpr::getIntToPtr(CE, DstEltTy));
269         continue;
270       }
271 
272       // Truncate and remember this piece.
273       Result.push_back(ConstantExpr::getTrunc(Elt, DstEltTy));
274     }
275   }
276 
277   return ConstantVector::get(Result);
278 }
279 
280 } // end anonymous namespace
281 
282 /// If this constant is a constant offset from a global, return the global and
283 /// the constant. Because of constantexprs, this function is recursive.
284 bool llvm::IsConstantOffsetFromGlobal(Constant *C, GlobalValue *&GV,
285                                       APInt &Offset, const DataLayout &DL) {
286   // Trivial case, constant is the global.
287   if ((GV = dyn_cast<GlobalValue>(C))) {
288     unsigned BitWidth = DL.getPointerTypeSizeInBits(GV->getType());
289     Offset = APInt(BitWidth, 0);
290     return true;
291   }
292 
293   // Otherwise, if this isn't a constant expr, bail out.
294   auto *CE = dyn_cast<ConstantExpr>(C);
295   if (!CE) return false;
296 
297   // Look through ptr->int and ptr->ptr casts.
298   if (CE->getOpcode() == Instruction::PtrToInt ||
299       CE->getOpcode() == Instruction::BitCast)
300     return IsConstantOffsetFromGlobal(CE->getOperand(0), GV, Offset, DL);
301 
302   // i32* getelementptr ([5 x i32]* @a, i32 0, i32 5)
303   auto *GEP = dyn_cast<GEPOperator>(CE);
304   if (!GEP)
305     return false;
306 
307   unsigned BitWidth = DL.getPointerTypeSizeInBits(GEP->getType());
308   APInt TmpOffset(BitWidth, 0);
309 
310   // If the base isn't a global+constant, we aren't either.
311   if (!IsConstantOffsetFromGlobal(CE->getOperand(0), GV, TmpOffset, DL))
312     return false;
313 
314   // Otherwise, add any offset that our operands provide.
315   if (!GEP->accumulateConstantOffset(DL, TmpOffset))
316     return false;
317 
318   Offset = TmpOffset;
319   return true;
320 }
321 
322 namespace {
323 
324 /// Recursive helper to read bits out of global. C is the constant being copied
325 /// out of. ByteOffset is an offset into C. CurPtr is the pointer to copy
326 /// results into and BytesLeft is the number of bytes left in
327 /// the CurPtr buffer. DL is the DataLayout.
328 bool ReadDataFromGlobal(Constant *C, uint64_t ByteOffset, unsigned char *CurPtr,
329                         unsigned BytesLeft, const DataLayout &DL) {
330   assert(ByteOffset <= DL.getTypeAllocSize(C->getType()) &&
331          "Out of range access");
332 
333   // If this element is zero or undefined, we can just return since *CurPtr is
334   // zero initialized.
335   if (isa<ConstantAggregateZero>(C) || isa<UndefValue>(C))
336     return true;
337 
338   if (auto *CI = dyn_cast<ConstantInt>(C)) {
339     if (CI->getBitWidth() > 64 ||
340         (CI->getBitWidth() & 7) != 0)
341       return false;
342 
343     uint64_t Val = CI->getZExtValue();
344     unsigned IntBytes = unsigned(CI->getBitWidth()/8);
345 
346     for (unsigned i = 0; i != BytesLeft && ByteOffset != IntBytes; ++i) {
347       int n = ByteOffset;
348       if (!DL.isLittleEndian())
349         n = IntBytes - n - 1;
350       CurPtr[i] = (unsigned char)(Val >> (n * 8));
351       ++ByteOffset;
352     }
353     return true;
354   }
355 
356   if (auto *CFP = dyn_cast<ConstantFP>(C)) {
357     if (CFP->getType()->isDoubleTy()) {
358       C = FoldBitCast(C, Type::getInt64Ty(C->getContext()), DL);
359       return ReadDataFromGlobal(C, ByteOffset, CurPtr, BytesLeft, DL);
360     }
361     if (CFP->getType()->isFloatTy()){
362       C = FoldBitCast(C, Type::getInt32Ty(C->getContext()), DL);
363       return ReadDataFromGlobal(C, ByteOffset, CurPtr, BytesLeft, DL);
364     }
365     if (CFP->getType()->isHalfTy()){
366       C = FoldBitCast(C, Type::getInt16Ty(C->getContext()), DL);
367       return ReadDataFromGlobal(C, ByteOffset, CurPtr, BytesLeft, DL);
368     }
369     return false;
370   }
371 
372   if (auto *CS = dyn_cast<ConstantStruct>(C)) {
373     const StructLayout *SL = DL.getStructLayout(CS->getType());
374     unsigned Index = SL->getElementContainingOffset(ByteOffset);
375     uint64_t CurEltOffset = SL->getElementOffset(Index);
376     ByteOffset -= CurEltOffset;
377 
378     while (true) {
379       // If the element access is to the element itself and not to tail padding,
380       // read the bytes from the element.
381       uint64_t EltSize = DL.getTypeAllocSize(CS->getOperand(Index)->getType());
382 
383       if (ByteOffset < EltSize &&
384           !ReadDataFromGlobal(CS->getOperand(Index), ByteOffset, CurPtr,
385                               BytesLeft, DL))
386         return false;
387 
388       ++Index;
389 
390       // Check to see if we read from the last struct element, if so we're done.
391       if (Index == CS->getType()->getNumElements())
392         return true;
393 
394       // If we read all of the bytes we needed from this element we're done.
395       uint64_t NextEltOffset = SL->getElementOffset(Index);
396 
397       if (BytesLeft <= NextEltOffset - CurEltOffset - ByteOffset)
398         return true;
399 
400       // Move to the next element of the struct.
401       CurPtr += NextEltOffset - CurEltOffset - ByteOffset;
402       BytesLeft -= NextEltOffset - CurEltOffset - ByteOffset;
403       ByteOffset = 0;
404       CurEltOffset = NextEltOffset;
405     }
406     // not reached.
407   }
408 
409   if (isa<ConstantArray>(C) || isa<ConstantVector>(C) ||
410       isa<ConstantDataSequential>(C)) {
411     Type *EltTy = C->getType()->getSequentialElementType();
412     uint64_t EltSize = DL.getTypeAllocSize(EltTy);
413     uint64_t Index = ByteOffset / EltSize;
414     uint64_t Offset = ByteOffset - Index * EltSize;
415     uint64_t NumElts;
416     if (auto *AT = dyn_cast<ArrayType>(C->getType()))
417       NumElts = AT->getNumElements();
418     else
419       NumElts = C->getType()->getVectorNumElements();
420 
421     for (; Index != NumElts; ++Index) {
422       if (!ReadDataFromGlobal(C->getAggregateElement(Index), Offset, CurPtr,
423                               BytesLeft, DL))
424         return false;
425 
426       uint64_t BytesWritten = EltSize - Offset;
427       assert(BytesWritten <= EltSize && "Not indexing into this element?");
428       if (BytesWritten >= BytesLeft)
429         return true;
430 
431       Offset = 0;
432       BytesLeft -= BytesWritten;
433       CurPtr += BytesWritten;
434     }
435     return true;
436   }
437 
438   if (auto *CE = dyn_cast<ConstantExpr>(C)) {
439     if (CE->getOpcode() == Instruction::IntToPtr &&
440         CE->getOperand(0)->getType() == DL.getIntPtrType(CE->getType())) {
441       return ReadDataFromGlobal(CE->getOperand(0), ByteOffset, CurPtr,
442                                 BytesLeft, DL);
443     }
444   }
445 
446   // Otherwise, unknown initializer type.
447   return false;
448 }
449 
450 Constant *FoldReinterpretLoadFromConstPtr(Constant *C, Type *LoadTy,
451                                           const DataLayout &DL) {
452   auto *PTy = cast<PointerType>(C->getType());
453   auto *IntType = dyn_cast<IntegerType>(LoadTy);
454 
455   // If this isn't an integer load we can't fold it directly.
456   if (!IntType) {
457     unsigned AS = PTy->getAddressSpace();
458 
459     // If this is a float/double load, we can try folding it as an int32/64 load
460     // and then bitcast the result.  This can be useful for union cases.  Note
461     // that address spaces don't matter here since we're not going to result in
462     // an actual new load.
463     Type *MapTy;
464     if (LoadTy->isHalfTy())
465       MapTy = Type::getInt16Ty(C->getContext());
466     else if (LoadTy->isFloatTy())
467       MapTy = Type::getInt32Ty(C->getContext());
468     else if (LoadTy->isDoubleTy())
469       MapTy = Type::getInt64Ty(C->getContext());
470     else if (LoadTy->isVectorTy()) {
471       MapTy = PointerType::getIntNTy(C->getContext(),
472                                      DL.getTypeAllocSizeInBits(LoadTy));
473     } else
474       return nullptr;
475 
476     C = FoldBitCast(C, MapTy->getPointerTo(AS), DL);
477     if (Constant *Res = FoldReinterpretLoadFromConstPtr(C, MapTy, DL))
478       return FoldBitCast(Res, LoadTy, DL);
479     return nullptr;
480   }
481 
482   unsigned BytesLoaded = (IntType->getBitWidth() + 7) / 8;
483   if (BytesLoaded > 32 || BytesLoaded == 0)
484     return nullptr;
485 
486   GlobalValue *GVal;
487   APInt OffsetAI;
488   if (!IsConstantOffsetFromGlobal(C, GVal, OffsetAI, DL))
489     return nullptr;
490 
491   auto *GV = dyn_cast<GlobalVariable>(GVal);
492   if (!GV || !GV->isConstant() || !GV->hasDefinitiveInitializer() ||
493       !GV->getInitializer()->getType()->isSized())
494     return nullptr;
495 
496   int64_t Offset = OffsetAI.getSExtValue();
497   int64_t InitializerSize = DL.getTypeAllocSize(GV->getInitializer()->getType());
498 
499   // If we're not accessing anything in this constant, the result is undefined.
500   if (Offset + BytesLoaded <= 0)
501     return UndefValue::get(IntType);
502 
503   // If we're not accessing anything in this constant, the result is undefined.
504   if (Offset >= InitializerSize)
505     return UndefValue::get(IntType);
506 
507   unsigned char RawBytes[32] = {0};
508   unsigned char *CurPtr = RawBytes;
509   unsigned BytesLeft = BytesLoaded;
510 
511   // If we're loading off the beginning of the global, some bytes may be valid.
512   if (Offset < 0) {
513     CurPtr += -Offset;
514     BytesLeft += Offset;
515     Offset = 0;
516   }
517 
518   if (!ReadDataFromGlobal(GV->getInitializer(), Offset, CurPtr, BytesLeft, DL))
519     return nullptr;
520 
521   APInt ResultVal = APInt(IntType->getBitWidth(), 0);
522   if (DL.isLittleEndian()) {
523     ResultVal = RawBytes[BytesLoaded - 1];
524     for (unsigned i = 1; i != BytesLoaded; ++i) {
525       ResultVal <<= 8;
526       ResultVal |= RawBytes[BytesLoaded - 1 - i];
527     }
528   } else {
529     ResultVal = RawBytes[0];
530     for (unsigned i = 1; i != BytesLoaded; ++i) {
531       ResultVal <<= 8;
532       ResultVal |= RawBytes[i];
533     }
534   }
535 
536   return ConstantInt::get(IntType->getContext(), ResultVal);
537 }
538 
539 Constant *ConstantFoldLoadThroughBitcast(ConstantExpr *CE, Type *DestTy,
540                                          const DataLayout &DL) {
541   auto *SrcPtr = CE->getOperand(0);
542   auto *SrcPtrTy = dyn_cast<PointerType>(SrcPtr->getType());
543   if (!SrcPtrTy)
544     return nullptr;
545   Type *SrcTy = SrcPtrTy->getPointerElementType();
546 
547   Constant *C = ConstantFoldLoadFromConstPtr(SrcPtr, SrcTy, DL);
548   if (!C)
549     return nullptr;
550 
551   do {
552     Type *SrcTy = C->getType();
553 
554     // If the type sizes are the same and a cast is legal, just directly
555     // cast the constant.
556     if (DL.getTypeSizeInBits(DestTy) == DL.getTypeSizeInBits(SrcTy)) {
557       Instruction::CastOps Cast = Instruction::BitCast;
558       // If we are going from a pointer to int or vice versa, we spell the cast
559       // differently.
560       if (SrcTy->isIntegerTy() && DestTy->isPointerTy())
561         Cast = Instruction::IntToPtr;
562       else if (SrcTy->isPointerTy() && DestTy->isIntegerTy())
563         Cast = Instruction::PtrToInt;
564 
565       if (CastInst::castIsValid(Cast, C, DestTy))
566         return ConstantExpr::getCast(Cast, C, DestTy);
567     }
568 
569     // If this isn't an aggregate type, there is nothing we can do to drill down
570     // and find a bitcastable constant.
571     if (!SrcTy->isAggregateType())
572       return nullptr;
573 
574     // We're simulating a load through a pointer that was bitcast to point to
575     // a different type, so we can try to walk down through the initial
576     // elements of an aggregate to see if some part of th e aggregate is
577     // castable to implement the "load" semantic model.
578     C = C->getAggregateElement(0u);
579   } while (C);
580 
581   return nullptr;
582 }
583 
584 } // end anonymous namespace
585 
586 Constant *llvm::ConstantFoldLoadFromConstPtr(Constant *C, Type *Ty,
587                                              const DataLayout &DL) {
588   // First, try the easy cases:
589   if (auto *GV = dyn_cast<GlobalVariable>(C))
590     if (GV->isConstant() && GV->hasDefinitiveInitializer())
591       return GV->getInitializer();
592 
593   if (auto *GA = dyn_cast<GlobalAlias>(C))
594     if (GA->getAliasee() && !GA->isInterposable())
595       return ConstantFoldLoadFromConstPtr(GA->getAliasee(), Ty, DL);
596 
597   // If the loaded value isn't a constant expr, we can't handle it.
598   auto *CE = dyn_cast<ConstantExpr>(C);
599   if (!CE)
600     return nullptr;
601 
602   if (CE->getOpcode() == Instruction::GetElementPtr) {
603     if (auto *GV = dyn_cast<GlobalVariable>(CE->getOperand(0))) {
604       if (GV->isConstant() && GV->hasDefinitiveInitializer()) {
605         if (Constant *V =
606              ConstantFoldLoadThroughGEPConstantExpr(GV->getInitializer(), CE))
607           return V;
608       }
609     }
610   }
611 
612   if (CE->getOpcode() == Instruction::BitCast)
613     if (Constant *LoadedC = ConstantFoldLoadThroughBitcast(CE, Ty, DL))
614       return LoadedC;
615 
616   // Instead of loading constant c string, use corresponding integer value
617   // directly if string length is small enough.
618   StringRef Str;
619   if (getConstantStringInfo(CE, Str) && !Str.empty()) {
620     size_t StrLen = Str.size();
621     unsigned NumBits = Ty->getPrimitiveSizeInBits();
622     // Replace load with immediate integer if the result is an integer or fp
623     // value.
624     if ((NumBits >> 3) == StrLen + 1 && (NumBits & 7) == 0 &&
625         (isa<IntegerType>(Ty) || Ty->isFloatingPointTy())) {
626       APInt StrVal(NumBits, 0);
627       APInt SingleChar(NumBits, 0);
628       if (DL.isLittleEndian()) {
629         for (unsigned char C : reverse(Str.bytes())) {
630           SingleChar = static_cast<uint64_t>(C);
631           StrVal = (StrVal << 8) | SingleChar;
632         }
633       } else {
634         for (unsigned char C : Str.bytes()) {
635           SingleChar = static_cast<uint64_t>(C);
636           StrVal = (StrVal << 8) | SingleChar;
637         }
638         // Append NULL at the end.
639         SingleChar = 0;
640         StrVal = (StrVal << 8) | SingleChar;
641       }
642 
643       Constant *Res = ConstantInt::get(CE->getContext(), StrVal);
644       if (Ty->isFloatingPointTy())
645         Res = ConstantExpr::getBitCast(Res, Ty);
646       return Res;
647     }
648   }
649 
650   // If this load comes from anywhere in a constant global, and if the global
651   // is all undef or zero, we know what it loads.
652   if (auto *GV = dyn_cast<GlobalVariable>(GetUnderlyingObject(CE, DL))) {
653     if (GV->isConstant() && GV->hasDefinitiveInitializer()) {
654       if (GV->getInitializer()->isNullValue())
655         return Constant::getNullValue(Ty);
656       if (isa<UndefValue>(GV->getInitializer()))
657         return UndefValue::get(Ty);
658     }
659   }
660 
661   // Try hard to fold loads from bitcasted strange and non-type-safe things.
662   return FoldReinterpretLoadFromConstPtr(CE, Ty, DL);
663 }
664 
665 namespace {
666 
667 Constant *ConstantFoldLoadInst(const LoadInst *LI, const DataLayout &DL) {
668   if (LI->isVolatile()) return nullptr;
669 
670   if (auto *C = dyn_cast<Constant>(LI->getOperand(0)))
671     return ConstantFoldLoadFromConstPtr(C, LI->getType(), DL);
672 
673   return nullptr;
674 }
675 
676 /// One of Op0/Op1 is a constant expression.
677 /// Attempt to symbolically evaluate the result of a binary operator merging
678 /// these together.  If target data info is available, it is provided as DL,
679 /// otherwise DL is null.
680 Constant *SymbolicallyEvaluateBinop(unsigned Opc, Constant *Op0, Constant *Op1,
681                                     const DataLayout &DL) {
682   // SROA
683 
684   // Fold (and 0xffffffff00000000, (shl x, 32)) -> shl.
685   // Fold (lshr (or X, Y), 32) -> (lshr [X/Y], 32) if one doesn't contribute
686   // bits.
687 
688   if (Opc == Instruction::And) {
689     unsigned BitWidth = DL.getTypeSizeInBits(Op0->getType()->getScalarType());
690     APInt KnownZero0(BitWidth, 0), KnownOne0(BitWidth, 0);
691     APInt KnownZero1(BitWidth, 0), KnownOne1(BitWidth, 0);
692     computeKnownBits(Op0, KnownZero0, KnownOne0, DL);
693     computeKnownBits(Op1, KnownZero1, KnownOne1, DL);
694     if ((KnownOne1 | KnownZero0).isAllOnesValue()) {
695       // All the bits of Op0 that the 'and' could be masking are already zero.
696       return Op0;
697     }
698     if ((KnownOne0 | KnownZero1).isAllOnesValue()) {
699       // All the bits of Op1 that the 'and' could be masking are already zero.
700       return Op1;
701     }
702 
703     APInt KnownZero = KnownZero0 | KnownZero1;
704     APInt KnownOne = KnownOne0 & KnownOne1;
705     if ((KnownZero | KnownOne).isAllOnesValue()) {
706       return ConstantInt::get(Op0->getType(), KnownOne);
707     }
708   }
709 
710   // If the constant expr is something like &A[123] - &A[4].f, fold this into a
711   // constant.  This happens frequently when iterating over a global array.
712   if (Opc == Instruction::Sub) {
713     GlobalValue *GV1, *GV2;
714     APInt Offs1, Offs2;
715 
716     if (IsConstantOffsetFromGlobal(Op0, GV1, Offs1, DL))
717       if (IsConstantOffsetFromGlobal(Op1, GV2, Offs2, DL) && GV1 == GV2) {
718         unsigned OpSize = DL.getTypeSizeInBits(Op0->getType());
719 
720         // (&GV+C1) - (&GV+C2) -> C1-C2, pointer arithmetic cannot overflow.
721         // PtrToInt may change the bitwidth so we have convert to the right size
722         // first.
723         return ConstantInt::get(Op0->getType(), Offs1.zextOrTrunc(OpSize) -
724                                                 Offs2.zextOrTrunc(OpSize));
725       }
726   }
727 
728   return nullptr;
729 }
730 
731 /// If array indices are not pointer-sized integers, explicitly cast them so
732 /// that they aren't implicitly casted by the getelementptr.
733 Constant *CastGEPIndices(Type *SrcElemTy, ArrayRef<Constant *> Ops,
734                          Type *ResultTy, Optional<unsigned> InRangeIndex,
735                          const DataLayout &DL, const TargetLibraryInfo *TLI) {
736   Type *IntPtrTy = DL.getIntPtrType(ResultTy);
737   Type *IntPtrScalarTy = IntPtrTy->getScalarType();
738 
739   bool Any = false;
740   SmallVector<Constant*, 32> NewIdxs;
741   for (unsigned i = 1, e = Ops.size(); i != e; ++i) {
742     if ((i == 1 ||
743          !isa<StructType>(GetElementPtrInst::getIndexedType(
744              SrcElemTy, Ops.slice(1, i - 1)))) &&
745         Ops[i]->getType() != (i == 1 ? IntPtrTy : IntPtrScalarTy)) {
746       Any = true;
747       NewIdxs.push_back(ConstantExpr::getCast(CastInst::getCastOpcode(Ops[i],
748                                                                       true,
749                                                                       IntPtrTy,
750                                                                       true),
751                                               Ops[i], IntPtrTy));
752     } else
753       NewIdxs.push_back(Ops[i]);
754   }
755 
756   if (!Any)
757     return nullptr;
758 
759   Constant *C = ConstantExpr::getGetElementPtr(
760       SrcElemTy, Ops[0], NewIdxs, /*InBounds=*/false, InRangeIndex);
761   if (Constant *Folded = ConstantFoldConstant(C, DL, TLI))
762     C = Folded;
763 
764   return C;
765 }
766 
767 /// Strip the pointer casts, but preserve the address space information.
768 Constant* StripPtrCastKeepAS(Constant* Ptr, Type *&ElemTy) {
769   assert(Ptr->getType()->isPointerTy() && "Not a pointer type");
770   auto *OldPtrTy = cast<PointerType>(Ptr->getType());
771   Ptr = Ptr->stripPointerCasts();
772   auto *NewPtrTy = cast<PointerType>(Ptr->getType());
773 
774   ElemTy = NewPtrTy->getPointerElementType();
775 
776   // Preserve the address space number of the pointer.
777   if (NewPtrTy->getAddressSpace() != OldPtrTy->getAddressSpace()) {
778     NewPtrTy = ElemTy->getPointerTo(OldPtrTy->getAddressSpace());
779     Ptr = ConstantExpr::getPointerCast(Ptr, NewPtrTy);
780   }
781   return Ptr;
782 }
783 
784 /// If we can symbolically evaluate the GEP constant expression, do so.
785 Constant *SymbolicallyEvaluateGEP(const GEPOperator *GEP,
786                                   ArrayRef<Constant *> Ops,
787                                   const DataLayout &DL,
788                                   const TargetLibraryInfo *TLI) {
789   const GEPOperator *InnermostGEP = GEP;
790   bool InBounds = GEP->isInBounds();
791 
792   Type *SrcElemTy = GEP->getSourceElementType();
793   Type *ResElemTy = GEP->getResultElementType();
794   Type *ResTy = GEP->getType();
795   if (!SrcElemTy->isSized())
796     return nullptr;
797 
798   if (Constant *C = CastGEPIndices(SrcElemTy, Ops, ResTy,
799                                    GEP->getInRangeIndex(), DL, TLI))
800     return C;
801 
802   Constant *Ptr = Ops[0];
803   if (!Ptr->getType()->isPointerTy())
804     return nullptr;
805 
806   Type *IntPtrTy = DL.getIntPtrType(Ptr->getType());
807 
808   // If this is a constant expr gep that is effectively computing an
809   // "offsetof", fold it into 'cast int Size to T*' instead of 'gep 0, 0, 12'
810   for (unsigned i = 1, e = Ops.size(); i != e; ++i)
811     if (!isa<ConstantInt>(Ops[i])) {
812 
813       // If this is "gep i8* Ptr, (sub 0, V)", fold this as:
814       // "inttoptr (sub (ptrtoint Ptr), V)"
815       if (Ops.size() == 2 && ResElemTy->isIntegerTy(8)) {
816         auto *CE = dyn_cast<ConstantExpr>(Ops[1]);
817         assert((!CE || CE->getType() == IntPtrTy) &&
818                "CastGEPIndices didn't canonicalize index types!");
819         if (CE && CE->getOpcode() == Instruction::Sub &&
820             CE->getOperand(0)->isNullValue()) {
821           Constant *Res = ConstantExpr::getPtrToInt(Ptr, CE->getType());
822           Res = ConstantExpr::getSub(Res, CE->getOperand(1));
823           Res = ConstantExpr::getIntToPtr(Res, ResTy);
824           if (auto *FoldedRes = ConstantFoldConstant(Res, DL, TLI))
825             Res = FoldedRes;
826           return Res;
827         }
828       }
829       return nullptr;
830     }
831 
832   unsigned BitWidth = DL.getTypeSizeInBits(IntPtrTy);
833   APInt Offset =
834       APInt(BitWidth,
835             DL.getIndexedOffsetInType(
836                 SrcElemTy,
837                 makeArrayRef((Value * const *)Ops.data() + 1, Ops.size() - 1)));
838   Ptr = StripPtrCastKeepAS(Ptr, SrcElemTy);
839 
840   // If this is a GEP of a GEP, fold it all into a single GEP.
841   while (auto *GEP = dyn_cast<GEPOperator>(Ptr)) {
842     InnermostGEP = GEP;
843     InBounds &= GEP->isInBounds();
844 
845     SmallVector<Value *, 4> NestedOps(GEP->op_begin() + 1, GEP->op_end());
846 
847     // Do not try the incorporate the sub-GEP if some index is not a number.
848     bool AllConstantInt = true;
849     for (Value *NestedOp : NestedOps)
850       if (!isa<ConstantInt>(NestedOp)) {
851         AllConstantInt = false;
852         break;
853       }
854     if (!AllConstantInt)
855       break;
856 
857     Ptr = cast<Constant>(GEP->getOperand(0));
858     SrcElemTy = GEP->getSourceElementType();
859     Offset += APInt(BitWidth, DL.getIndexedOffsetInType(SrcElemTy, NestedOps));
860     Ptr = StripPtrCastKeepAS(Ptr, SrcElemTy);
861   }
862 
863   // If the base value for this address is a literal integer value, fold the
864   // getelementptr to the resulting integer value casted to the pointer type.
865   APInt BasePtr(BitWidth, 0);
866   if (auto *CE = dyn_cast<ConstantExpr>(Ptr)) {
867     if (CE->getOpcode() == Instruction::IntToPtr) {
868       if (auto *Base = dyn_cast<ConstantInt>(CE->getOperand(0)))
869         BasePtr = Base->getValue().zextOrTrunc(BitWidth);
870     }
871   }
872 
873   auto *PTy = cast<PointerType>(Ptr->getType());
874   if ((Ptr->isNullValue() || BasePtr != 0) &&
875       !DL.isNonIntegralPointerType(PTy)) {
876     Constant *C = ConstantInt::get(Ptr->getContext(), Offset + BasePtr);
877     return ConstantExpr::getIntToPtr(C, ResTy);
878   }
879 
880   // Otherwise form a regular getelementptr. Recompute the indices so that
881   // we eliminate over-indexing of the notional static type array bounds.
882   // This makes it easy to determine if the getelementptr is "inbounds".
883   // Also, this helps GlobalOpt do SROA on GlobalVariables.
884   Type *Ty = PTy;
885   SmallVector<Constant *, 32> NewIdxs;
886 
887   do {
888     if (!Ty->isStructTy()) {
889       if (Ty->isPointerTy()) {
890         // The only pointer indexing we'll do is on the first index of the GEP.
891         if (!NewIdxs.empty())
892           break;
893 
894         Ty = SrcElemTy;
895 
896         // Only handle pointers to sized types, not pointers to functions.
897         if (!Ty->isSized())
898           return nullptr;
899       } else if (auto *ATy = dyn_cast<SequentialType>(Ty)) {
900         Ty = ATy->getElementType();
901       } else {
902         // We've reached some non-indexable type.
903         break;
904       }
905 
906       // Determine which element of the array the offset points into.
907       APInt ElemSize(BitWidth, DL.getTypeAllocSize(Ty));
908       if (ElemSize == 0) {
909         // The element size is 0. This may be [0 x Ty]*, so just use a zero
910         // index for this level and proceed to the next level to see if it can
911         // accommodate the offset.
912         NewIdxs.push_back(ConstantInt::get(IntPtrTy, 0));
913       } else {
914         // The element size is non-zero divide the offset by the element
915         // size (rounding down), to compute the index at this level.
916         bool Overflow;
917         APInt NewIdx = Offset.sdiv_ov(ElemSize, Overflow);
918         if (Overflow)
919           break;
920         Offset -= NewIdx * ElemSize;
921         NewIdxs.push_back(ConstantInt::get(IntPtrTy, NewIdx));
922       }
923     } else {
924       auto *STy = cast<StructType>(Ty);
925       // If we end up with an offset that isn't valid for this struct type, we
926       // can't re-form this GEP in a regular form, so bail out. The pointer
927       // operand likely went through casts that are necessary to make the GEP
928       // sensible.
929       const StructLayout &SL = *DL.getStructLayout(STy);
930       if (Offset.isNegative() || Offset.uge(SL.getSizeInBytes()))
931         break;
932 
933       // Determine which field of the struct the offset points into. The
934       // getZExtValue is fine as we've already ensured that the offset is
935       // within the range representable by the StructLayout API.
936       unsigned ElIdx = SL.getElementContainingOffset(Offset.getZExtValue());
937       NewIdxs.push_back(ConstantInt::get(Type::getInt32Ty(Ty->getContext()),
938                                          ElIdx));
939       Offset -= APInt(BitWidth, SL.getElementOffset(ElIdx));
940       Ty = STy->getTypeAtIndex(ElIdx);
941     }
942   } while (Ty != ResElemTy);
943 
944   // If we haven't used up the entire offset by descending the static
945   // type, then the offset is pointing into the middle of an indivisible
946   // member, so we can't simplify it.
947   if (Offset != 0)
948     return nullptr;
949 
950   // Preserve the inrange index from the innermost GEP if possible. We must
951   // have calculated the same indices up to and including the inrange index.
952   Optional<unsigned> InRangeIndex;
953   if (Optional<unsigned> LastIRIndex = InnermostGEP->getInRangeIndex())
954     if (SrcElemTy == InnermostGEP->getSourceElementType() &&
955         NewIdxs.size() > *LastIRIndex) {
956       InRangeIndex = LastIRIndex;
957       for (unsigned I = 0; I <= *LastIRIndex; ++I)
958         if (NewIdxs[I] != InnermostGEP->getOperand(I + 1)) {
959           InRangeIndex = None;
960           break;
961         }
962     }
963 
964   // Create a GEP.
965   Constant *C = ConstantExpr::getGetElementPtr(SrcElemTy, Ptr, NewIdxs,
966                                                InBounds, InRangeIndex);
967   assert(C->getType()->getPointerElementType() == Ty &&
968          "Computed GetElementPtr has unexpected type!");
969 
970   // If we ended up indexing a member with a type that doesn't match
971   // the type of what the original indices indexed, add a cast.
972   if (Ty != ResElemTy)
973     C = FoldBitCast(C, ResTy, DL);
974 
975   return C;
976 }
977 
978 /// Attempt to constant fold an instruction with the
979 /// specified opcode and operands.  If successful, the constant result is
980 /// returned, if not, null is returned.  Note that this function can fail when
981 /// attempting to fold instructions like loads and stores, which have no
982 /// constant expression form.
983 ///
984 /// TODO: This function neither utilizes nor preserves nsw/nuw/inbounds/inrange
985 /// etc information, due to only being passed an opcode and operands. Constant
986 /// folding using this function strips this information.
987 ///
988 Constant *ConstantFoldInstOperandsImpl(const Value *InstOrCE, unsigned Opcode,
989                                        ArrayRef<Constant *> Ops,
990                                        const DataLayout &DL,
991                                        const TargetLibraryInfo *TLI) {
992   Type *DestTy = InstOrCE->getType();
993 
994   // Handle easy binops first.
995   if (Instruction::isBinaryOp(Opcode))
996     return ConstantFoldBinaryOpOperands(Opcode, Ops[0], Ops[1], DL);
997 
998   if (Instruction::isCast(Opcode))
999     return ConstantFoldCastOperand(Opcode, Ops[0], DestTy, DL);
1000 
1001   if (auto *GEP = dyn_cast<GEPOperator>(InstOrCE)) {
1002     if (Constant *C = SymbolicallyEvaluateGEP(GEP, Ops, DL, TLI))
1003       return C;
1004 
1005     return ConstantExpr::getGetElementPtr(GEP->getSourceElementType(), Ops[0],
1006                                           Ops.slice(1), GEP->isInBounds(),
1007                                           GEP->getInRangeIndex());
1008   }
1009 
1010   if (auto *CE = dyn_cast<ConstantExpr>(InstOrCE))
1011     return CE->getWithOperands(Ops);
1012 
1013   switch (Opcode) {
1014   default: return nullptr;
1015   case Instruction::ICmp:
1016   case Instruction::FCmp: llvm_unreachable("Invalid for compares");
1017   case Instruction::Call:
1018     if (auto *F = dyn_cast<Function>(Ops.back()))
1019       if (canConstantFoldCallTo(F))
1020         return ConstantFoldCall(F, Ops.slice(0, Ops.size() - 1), TLI);
1021     return nullptr;
1022   case Instruction::Select:
1023     return ConstantExpr::getSelect(Ops[0], Ops[1], Ops[2]);
1024   case Instruction::ExtractElement:
1025     return ConstantExpr::getExtractElement(Ops[0], Ops[1]);
1026   case Instruction::InsertElement:
1027     return ConstantExpr::getInsertElement(Ops[0], Ops[1], Ops[2]);
1028   case Instruction::ShuffleVector:
1029     return ConstantExpr::getShuffleVector(Ops[0], Ops[1], Ops[2]);
1030   }
1031 }
1032 
1033 } // end anonymous namespace
1034 
1035 //===----------------------------------------------------------------------===//
1036 // Constant Folding public APIs
1037 //===----------------------------------------------------------------------===//
1038 
1039 namespace {
1040 
1041 Constant *
1042 ConstantFoldConstantImpl(const Constant *C, const DataLayout &DL,
1043                          const TargetLibraryInfo *TLI,
1044                          SmallDenseMap<Constant *, Constant *> &FoldedOps) {
1045   if (!isa<ConstantVector>(C) && !isa<ConstantExpr>(C))
1046     return nullptr;
1047 
1048   SmallVector<Constant *, 8> Ops;
1049   for (const Use &NewU : C->operands()) {
1050     auto *NewC = cast<Constant>(&NewU);
1051     // Recursively fold the ConstantExpr's operands. If we have already folded
1052     // a ConstantExpr, we don't have to process it again.
1053     if (isa<ConstantVector>(NewC) || isa<ConstantExpr>(NewC)) {
1054       auto It = FoldedOps.find(NewC);
1055       if (It == FoldedOps.end()) {
1056         if (auto *FoldedC =
1057                 ConstantFoldConstantImpl(NewC, DL, TLI, FoldedOps)) {
1058           NewC = FoldedC;
1059           FoldedOps.insert({NewC, FoldedC});
1060         } else {
1061           FoldedOps.insert({NewC, NewC});
1062         }
1063       } else {
1064         NewC = It->second;
1065       }
1066     }
1067     Ops.push_back(NewC);
1068   }
1069 
1070   if (auto *CE = dyn_cast<ConstantExpr>(C)) {
1071     if (CE->isCompare())
1072       return ConstantFoldCompareInstOperands(CE->getPredicate(), Ops[0], Ops[1],
1073                                              DL, TLI);
1074 
1075     return ConstantFoldInstOperandsImpl(CE, CE->getOpcode(), Ops, DL, TLI);
1076   }
1077 
1078   assert(isa<ConstantVector>(C));
1079   return ConstantVector::get(Ops);
1080 }
1081 
1082 } // end anonymous namespace
1083 
1084 Constant *llvm::ConstantFoldInstruction(Instruction *I, const DataLayout &DL,
1085                                         const TargetLibraryInfo *TLI) {
1086   // Handle PHI nodes quickly here...
1087   if (auto *PN = dyn_cast<PHINode>(I)) {
1088     Constant *CommonValue = nullptr;
1089 
1090     SmallDenseMap<Constant *, Constant *> FoldedOps;
1091     for (Value *Incoming : PN->incoming_values()) {
1092       // If the incoming value is undef then skip it.  Note that while we could
1093       // skip the value if it is equal to the phi node itself we choose not to
1094       // because that would break the rule that constant folding only applies if
1095       // all operands are constants.
1096       if (isa<UndefValue>(Incoming))
1097         continue;
1098       // If the incoming value is not a constant, then give up.
1099       auto *C = dyn_cast<Constant>(Incoming);
1100       if (!C)
1101         return nullptr;
1102       // Fold the PHI's operands.
1103       if (auto *FoldedC = ConstantFoldConstantImpl(C, DL, TLI, FoldedOps))
1104         C = FoldedC;
1105       // If the incoming value is a different constant to
1106       // the one we saw previously, then give up.
1107       if (CommonValue && C != CommonValue)
1108         return nullptr;
1109       CommonValue = C;
1110     }
1111 
1112     // If we reach here, all incoming values are the same constant or undef.
1113     return CommonValue ? CommonValue : UndefValue::get(PN->getType());
1114   }
1115 
1116   // Scan the operand list, checking to see if they are all constants, if so,
1117   // hand off to ConstantFoldInstOperandsImpl.
1118   if (!all_of(I->operands(), [](Use &U) { return isa<Constant>(U); }))
1119     return nullptr;
1120 
1121   SmallDenseMap<Constant *, Constant *> FoldedOps;
1122   SmallVector<Constant *, 8> Ops;
1123   for (const Use &OpU : I->operands()) {
1124     auto *Op = cast<Constant>(&OpU);
1125     // Fold the Instruction's operands.
1126     if (auto *FoldedOp = ConstantFoldConstantImpl(Op, DL, TLI, FoldedOps))
1127       Op = FoldedOp;
1128 
1129     Ops.push_back(Op);
1130   }
1131 
1132   if (const auto *CI = dyn_cast<CmpInst>(I))
1133     return ConstantFoldCompareInstOperands(CI->getPredicate(), Ops[0], Ops[1],
1134                                            DL, TLI);
1135 
1136   if (const auto *LI = dyn_cast<LoadInst>(I))
1137     return ConstantFoldLoadInst(LI, DL);
1138 
1139   if (auto *IVI = dyn_cast<InsertValueInst>(I)) {
1140     return ConstantExpr::getInsertValue(
1141                                 cast<Constant>(IVI->getAggregateOperand()),
1142                                 cast<Constant>(IVI->getInsertedValueOperand()),
1143                                 IVI->getIndices());
1144   }
1145 
1146   if (auto *EVI = dyn_cast<ExtractValueInst>(I)) {
1147     return ConstantExpr::getExtractValue(
1148                                     cast<Constant>(EVI->getAggregateOperand()),
1149                                     EVI->getIndices());
1150   }
1151 
1152   return ConstantFoldInstOperands(I, Ops, DL, TLI);
1153 }
1154 
1155 Constant *llvm::ConstantFoldConstant(const Constant *C, const DataLayout &DL,
1156                                      const TargetLibraryInfo *TLI) {
1157   SmallDenseMap<Constant *, Constant *> FoldedOps;
1158   return ConstantFoldConstantImpl(C, DL, TLI, FoldedOps);
1159 }
1160 
1161 Constant *llvm::ConstantFoldInstOperands(Instruction *I,
1162                                          ArrayRef<Constant *> Ops,
1163                                          const DataLayout &DL,
1164                                          const TargetLibraryInfo *TLI) {
1165   return ConstantFoldInstOperandsImpl(I, I->getOpcode(), Ops, DL, TLI);
1166 }
1167 
1168 Constant *llvm::ConstantFoldCompareInstOperands(unsigned Predicate,
1169                                                 Constant *Ops0, Constant *Ops1,
1170                                                 const DataLayout &DL,
1171                                                 const TargetLibraryInfo *TLI) {
1172   // fold: icmp (inttoptr x), null         -> icmp x, 0
1173   // fold: icmp (ptrtoint x), 0            -> icmp x, null
1174   // fold: icmp (inttoptr x), (inttoptr y) -> icmp trunc/zext x, trunc/zext y
1175   // fold: icmp (ptrtoint x), (ptrtoint y) -> icmp x, y
1176   //
1177   // FIXME: The following comment is out of data and the DataLayout is here now.
1178   // ConstantExpr::getCompare cannot do this, because it doesn't have DL
1179   // around to know if bit truncation is happening.
1180   if (auto *CE0 = dyn_cast<ConstantExpr>(Ops0)) {
1181     if (Ops1->isNullValue()) {
1182       if (CE0->getOpcode() == Instruction::IntToPtr) {
1183         Type *IntPtrTy = DL.getIntPtrType(CE0->getType());
1184         // Convert the integer value to the right size to ensure we get the
1185         // proper extension or truncation.
1186         Constant *C = ConstantExpr::getIntegerCast(CE0->getOperand(0),
1187                                                    IntPtrTy, false);
1188         Constant *Null = Constant::getNullValue(C->getType());
1189         return ConstantFoldCompareInstOperands(Predicate, C, Null, DL, TLI);
1190       }
1191 
1192       // Only do this transformation if the int is intptrty in size, otherwise
1193       // there is a truncation or extension that we aren't modeling.
1194       if (CE0->getOpcode() == Instruction::PtrToInt) {
1195         Type *IntPtrTy = DL.getIntPtrType(CE0->getOperand(0)->getType());
1196         if (CE0->getType() == IntPtrTy) {
1197           Constant *C = CE0->getOperand(0);
1198           Constant *Null = Constant::getNullValue(C->getType());
1199           return ConstantFoldCompareInstOperands(Predicate, C, Null, DL, TLI);
1200         }
1201       }
1202     }
1203 
1204     if (auto *CE1 = dyn_cast<ConstantExpr>(Ops1)) {
1205       if (CE0->getOpcode() == CE1->getOpcode()) {
1206         if (CE0->getOpcode() == Instruction::IntToPtr) {
1207           Type *IntPtrTy = DL.getIntPtrType(CE0->getType());
1208 
1209           // Convert the integer value to the right size to ensure we get the
1210           // proper extension or truncation.
1211           Constant *C0 = ConstantExpr::getIntegerCast(CE0->getOperand(0),
1212                                                       IntPtrTy, false);
1213           Constant *C1 = ConstantExpr::getIntegerCast(CE1->getOperand(0),
1214                                                       IntPtrTy, false);
1215           return ConstantFoldCompareInstOperands(Predicate, C0, C1, DL, TLI);
1216         }
1217 
1218         // Only do this transformation if the int is intptrty in size, otherwise
1219         // there is a truncation or extension that we aren't modeling.
1220         if (CE0->getOpcode() == Instruction::PtrToInt) {
1221           Type *IntPtrTy = DL.getIntPtrType(CE0->getOperand(0)->getType());
1222           if (CE0->getType() == IntPtrTy &&
1223               CE0->getOperand(0)->getType() == CE1->getOperand(0)->getType()) {
1224             return ConstantFoldCompareInstOperands(
1225                 Predicate, CE0->getOperand(0), CE1->getOperand(0), DL, TLI);
1226           }
1227         }
1228       }
1229     }
1230 
1231     // icmp eq (or x, y), 0 -> (icmp eq x, 0) & (icmp eq y, 0)
1232     // icmp ne (or x, y), 0 -> (icmp ne x, 0) | (icmp ne y, 0)
1233     if ((Predicate == ICmpInst::ICMP_EQ || Predicate == ICmpInst::ICMP_NE) &&
1234         CE0->getOpcode() == Instruction::Or && Ops1->isNullValue()) {
1235       Constant *LHS = ConstantFoldCompareInstOperands(
1236           Predicate, CE0->getOperand(0), Ops1, DL, TLI);
1237       Constant *RHS = ConstantFoldCompareInstOperands(
1238           Predicate, CE0->getOperand(1), Ops1, DL, TLI);
1239       unsigned OpC =
1240         Predicate == ICmpInst::ICMP_EQ ? Instruction::And : Instruction::Or;
1241       return ConstantFoldBinaryOpOperands(OpC, LHS, RHS, DL);
1242     }
1243   }
1244 
1245   return ConstantExpr::getCompare(Predicate, Ops0, Ops1);
1246 }
1247 
1248 Constant *llvm::ConstantFoldBinaryOpOperands(unsigned Opcode, Constant *LHS,
1249                                              Constant *RHS,
1250                                              const DataLayout &DL) {
1251   assert(Instruction::isBinaryOp(Opcode));
1252   if (isa<ConstantExpr>(LHS) || isa<ConstantExpr>(RHS))
1253     if (Constant *C = SymbolicallyEvaluateBinop(Opcode, LHS, RHS, DL))
1254       return C;
1255 
1256   return ConstantExpr::get(Opcode, LHS, RHS);
1257 }
1258 
1259 Constant *llvm::ConstantFoldCastOperand(unsigned Opcode, Constant *C,
1260                                         Type *DestTy, const DataLayout &DL) {
1261   assert(Instruction::isCast(Opcode));
1262   switch (Opcode) {
1263   default:
1264     llvm_unreachable("Missing case");
1265   case Instruction::PtrToInt:
1266     // If the input is a inttoptr, eliminate the pair.  This requires knowing
1267     // the width of a pointer, so it can't be done in ConstantExpr::getCast.
1268     if (auto *CE = dyn_cast<ConstantExpr>(C)) {
1269       if (CE->getOpcode() == Instruction::IntToPtr) {
1270         Constant *Input = CE->getOperand(0);
1271         unsigned InWidth = Input->getType()->getScalarSizeInBits();
1272         unsigned PtrWidth = DL.getPointerTypeSizeInBits(CE->getType());
1273         if (PtrWidth < InWidth) {
1274           Constant *Mask =
1275             ConstantInt::get(CE->getContext(),
1276                              APInt::getLowBitsSet(InWidth, PtrWidth));
1277           Input = ConstantExpr::getAnd(Input, Mask);
1278         }
1279         // Do a zext or trunc to get to the dest size.
1280         return ConstantExpr::getIntegerCast(Input, DestTy, false);
1281       }
1282     }
1283     return ConstantExpr::getCast(Opcode, C, DestTy);
1284   case Instruction::IntToPtr:
1285     // If the input is a ptrtoint, turn the pair into a ptr to ptr bitcast if
1286     // the int size is >= the ptr size and the address spaces are the same.
1287     // This requires knowing the width of a pointer, so it can't be done in
1288     // ConstantExpr::getCast.
1289     if (auto *CE = dyn_cast<ConstantExpr>(C)) {
1290       if (CE->getOpcode() == Instruction::PtrToInt) {
1291         Constant *SrcPtr = CE->getOperand(0);
1292         unsigned SrcPtrSize = DL.getPointerTypeSizeInBits(SrcPtr->getType());
1293         unsigned MidIntSize = CE->getType()->getScalarSizeInBits();
1294 
1295         if (MidIntSize >= SrcPtrSize) {
1296           unsigned SrcAS = SrcPtr->getType()->getPointerAddressSpace();
1297           if (SrcAS == DestTy->getPointerAddressSpace())
1298             return FoldBitCast(CE->getOperand(0), DestTy, DL);
1299         }
1300       }
1301     }
1302 
1303     return ConstantExpr::getCast(Opcode, C, DestTy);
1304   case Instruction::Trunc:
1305   case Instruction::ZExt:
1306   case Instruction::SExt:
1307   case Instruction::FPTrunc:
1308   case Instruction::FPExt:
1309   case Instruction::UIToFP:
1310   case Instruction::SIToFP:
1311   case Instruction::FPToUI:
1312   case Instruction::FPToSI:
1313   case Instruction::AddrSpaceCast:
1314       return ConstantExpr::getCast(Opcode, C, DestTy);
1315   case Instruction::BitCast:
1316     return FoldBitCast(C, DestTy, DL);
1317   }
1318 }
1319 
1320 Constant *llvm::ConstantFoldLoadThroughGEPConstantExpr(Constant *C,
1321                                                        ConstantExpr *CE) {
1322   if (!CE->getOperand(1)->isNullValue())
1323     return nullptr;  // Do not allow stepping over the value!
1324 
1325   // Loop over all of the operands, tracking down which value we are
1326   // addressing.
1327   for (unsigned i = 2, e = CE->getNumOperands(); i != e; ++i) {
1328     C = C->getAggregateElement(CE->getOperand(i));
1329     if (!C)
1330       return nullptr;
1331   }
1332   return C;
1333 }
1334 
1335 Constant *
1336 llvm::ConstantFoldLoadThroughGEPIndices(Constant *C,
1337                                         ArrayRef<Constant *> Indices) {
1338   // Loop over all of the operands, tracking down which value we are
1339   // addressing.
1340   for (Constant *Index : Indices) {
1341     C = C->getAggregateElement(Index);
1342     if (!C)
1343       return nullptr;
1344   }
1345   return C;
1346 }
1347 
1348 //===----------------------------------------------------------------------===//
1349 //  Constant Folding for Calls
1350 //
1351 
1352 bool llvm::canConstantFoldCallTo(const Function *F) {
1353   switch (F->getIntrinsicID()) {
1354   case Intrinsic::fabs:
1355   case Intrinsic::minnum:
1356   case Intrinsic::maxnum:
1357   case Intrinsic::log:
1358   case Intrinsic::log2:
1359   case Intrinsic::log10:
1360   case Intrinsic::exp:
1361   case Intrinsic::exp2:
1362   case Intrinsic::floor:
1363   case Intrinsic::ceil:
1364   case Intrinsic::sqrt:
1365   case Intrinsic::sin:
1366   case Intrinsic::cos:
1367   case Intrinsic::trunc:
1368   case Intrinsic::rint:
1369   case Intrinsic::nearbyint:
1370   case Intrinsic::pow:
1371   case Intrinsic::powi:
1372   case Intrinsic::bswap:
1373   case Intrinsic::ctpop:
1374   case Intrinsic::ctlz:
1375   case Intrinsic::cttz:
1376   case Intrinsic::fma:
1377   case Intrinsic::fmuladd:
1378   case Intrinsic::copysign:
1379   case Intrinsic::round:
1380   case Intrinsic::masked_load:
1381   case Intrinsic::sadd_with_overflow:
1382   case Intrinsic::uadd_with_overflow:
1383   case Intrinsic::ssub_with_overflow:
1384   case Intrinsic::usub_with_overflow:
1385   case Intrinsic::smul_with_overflow:
1386   case Intrinsic::umul_with_overflow:
1387   case Intrinsic::convert_from_fp16:
1388   case Intrinsic::convert_to_fp16:
1389   case Intrinsic::bitreverse:
1390   case Intrinsic::x86_sse_cvtss2si:
1391   case Intrinsic::x86_sse_cvtss2si64:
1392   case Intrinsic::x86_sse_cvttss2si:
1393   case Intrinsic::x86_sse_cvttss2si64:
1394   case Intrinsic::x86_sse2_cvtsd2si:
1395   case Intrinsic::x86_sse2_cvtsd2si64:
1396   case Intrinsic::x86_sse2_cvttsd2si:
1397   case Intrinsic::x86_sse2_cvttsd2si64:
1398     return true;
1399   default:
1400     return false;
1401   case 0: break;
1402   }
1403 
1404   if (!F->hasName())
1405     return false;
1406   StringRef Name = F->getName();
1407 
1408   // In these cases, the check of the length is required.  We don't want to
1409   // return true for a name like "cos\0blah" which strcmp would return equal to
1410   // "cos", but has length 8.
1411   switch (Name[0]) {
1412   default:
1413     return false;
1414   case 'a':
1415     return Name == "acos" || Name == "asin" || Name == "atan" ||
1416            Name == "atan2" || Name == "acosf" || Name == "asinf" ||
1417            Name == "atanf" || Name == "atan2f";
1418   case 'c':
1419     return Name == "ceil" || Name == "cos" || Name == "cosh" ||
1420            Name == "ceilf" || Name == "cosf" || Name == "coshf";
1421   case 'e':
1422     return Name == "exp" || Name == "exp2" || Name == "expf" || Name == "exp2f";
1423   case 'f':
1424     return Name == "fabs" || Name == "floor" || Name == "fmod" ||
1425            Name == "fabsf" || Name == "floorf" || Name == "fmodf";
1426   case 'l':
1427     return Name == "log" || Name == "log10" || Name == "logf" ||
1428            Name == "log10f";
1429   case 'p':
1430     return Name == "pow" || Name == "powf";
1431   case 's':
1432     return Name == "sin" || Name == "sinh" || Name == "sqrt" ||
1433            Name == "sinf" || Name == "sinhf" || Name == "sqrtf";
1434   case 't':
1435     return Name == "tan" || Name == "tanh" || Name == "tanf" || Name == "tanhf";
1436   }
1437 }
1438 
1439 namespace {
1440 
1441 Constant *GetConstantFoldFPValue(double V, Type *Ty) {
1442   if (Ty->isHalfTy()) {
1443     APFloat APF(V);
1444     bool unused;
1445     APF.convert(APFloat::IEEEhalf, APFloat::rmNearestTiesToEven, &unused);
1446     return ConstantFP::get(Ty->getContext(), APF);
1447   }
1448   if (Ty->isFloatTy())
1449     return ConstantFP::get(Ty->getContext(), APFloat((float)V));
1450   if (Ty->isDoubleTy())
1451     return ConstantFP::get(Ty->getContext(), APFloat(V));
1452   llvm_unreachable("Can only constant fold half/float/double");
1453 }
1454 
1455 /// Clear the floating-point exception state.
1456 inline void llvm_fenv_clearexcept() {
1457 #if defined(HAVE_FENV_H) && HAVE_DECL_FE_ALL_EXCEPT
1458   feclearexcept(FE_ALL_EXCEPT);
1459 #endif
1460   errno = 0;
1461 }
1462 
1463 /// Test if a floating-point exception was raised.
1464 inline bool llvm_fenv_testexcept() {
1465   int errno_val = errno;
1466   if (errno_val == ERANGE || errno_val == EDOM)
1467     return true;
1468 #if defined(HAVE_FENV_H) && HAVE_DECL_FE_ALL_EXCEPT && HAVE_DECL_FE_INEXACT
1469   if (fetestexcept(FE_ALL_EXCEPT & ~FE_INEXACT))
1470     return true;
1471 #endif
1472   return false;
1473 }
1474 
1475 Constant *ConstantFoldFP(double (*NativeFP)(double), double V, Type *Ty) {
1476   llvm_fenv_clearexcept();
1477   V = NativeFP(V);
1478   if (llvm_fenv_testexcept()) {
1479     llvm_fenv_clearexcept();
1480     return nullptr;
1481   }
1482 
1483   return GetConstantFoldFPValue(V, Ty);
1484 }
1485 
1486 Constant *ConstantFoldBinaryFP(double (*NativeFP)(double, double), double V,
1487                                double W, Type *Ty) {
1488   llvm_fenv_clearexcept();
1489   V = NativeFP(V, W);
1490   if (llvm_fenv_testexcept()) {
1491     llvm_fenv_clearexcept();
1492     return nullptr;
1493   }
1494 
1495   return GetConstantFoldFPValue(V, Ty);
1496 }
1497 
1498 /// Attempt to fold an SSE floating point to integer conversion of a constant
1499 /// floating point. If roundTowardZero is false, the default IEEE rounding is
1500 /// used (toward nearest, ties to even). This matches the behavior of the
1501 /// non-truncating SSE instructions in the default rounding mode. The desired
1502 /// integer type Ty is used to select how many bits are available for the
1503 /// result. Returns null if the conversion cannot be performed, otherwise
1504 /// returns the Constant value resulting from the conversion.
1505 Constant *ConstantFoldSSEConvertToInt(const APFloat &Val, bool roundTowardZero,
1506                                       Type *Ty) {
1507   // All of these conversion intrinsics form an integer of at most 64bits.
1508   unsigned ResultWidth = Ty->getIntegerBitWidth();
1509   assert(ResultWidth <= 64 &&
1510          "Can only constant fold conversions to 64 and 32 bit ints");
1511 
1512   uint64_t UIntVal;
1513   bool isExact = false;
1514   APFloat::roundingMode mode = roundTowardZero? APFloat::rmTowardZero
1515                                               : APFloat::rmNearestTiesToEven;
1516   APFloat::opStatus status = Val.convertToInteger(&UIntVal, ResultWidth,
1517                                                   /*isSigned=*/true, mode,
1518                                                   &isExact);
1519   if (status != APFloat::opOK &&
1520       (!roundTowardZero || status != APFloat::opInexact))
1521     return nullptr;
1522   return ConstantInt::get(Ty, UIntVal, /*isSigned=*/true);
1523 }
1524 
1525 double getValueAsDouble(ConstantFP *Op) {
1526   Type *Ty = Op->getType();
1527 
1528   if (Ty->isFloatTy())
1529     return Op->getValueAPF().convertToFloat();
1530 
1531   if (Ty->isDoubleTy())
1532     return Op->getValueAPF().convertToDouble();
1533 
1534   bool unused;
1535   APFloat APF = Op->getValueAPF();
1536   APF.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven, &unused);
1537   return APF.convertToDouble();
1538 }
1539 
1540 Constant *ConstantFoldScalarCall(StringRef Name, unsigned IntrinsicID, Type *Ty,
1541                                  ArrayRef<Constant *> Operands,
1542                                  const TargetLibraryInfo *TLI) {
1543   if (Operands.size() == 1) {
1544     if (isa<UndefValue>(Operands[0])) {
1545       // cosine(arg) is between -1 and 1. cosine(invalid arg) is NaN
1546       if (IntrinsicID == Intrinsic::cos)
1547         return Constant::getNullValue(Ty);
1548     }
1549     if (auto *Op = dyn_cast<ConstantFP>(Operands[0])) {
1550       if (IntrinsicID == Intrinsic::convert_to_fp16) {
1551         APFloat Val(Op->getValueAPF());
1552 
1553         bool lost = false;
1554         Val.convert(APFloat::IEEEhalf, APFloat::rmNearestTiesToEven, &lost);
1555 
1556         return ConstantInt::get(Ty->getContext(), Val.bitcastToAPInt());
1557       }
1558 
1559       if (!Ty->isHalfTy() && !Ty->isFloatTy() && !Ty->isDoubleTy())
1560         return nullptr;
1561 
1562       if (IntrinsicID == Intrinsic::round) {
1563         APFloat V = Op->getValueAPF();
1564         V.roundToIntegral(APFloat::rmNearestTiesToAway);
1565         return ConstantFP::get(Ty->getContext(), V);
1566       }
1567 
1568       if (IntrinsicID == Intrinsic::floor) {
1569         APFloat V = Op->getValueAPF();
1570         V.roundToIntegral(APFloat::rmTowardNegative);
1571         return ConstantFP::get(Ty->getContext(), V);
1572       }
1573 
1574       if (IntrinsicID == Intrinsic::ceil) {
1575         APFloat V = Op->getValueAPF();
1576         V.roundToIntegral(APFloat::rmTowardPositive);
1577         return ConstantFP::get(Ty->getContext(), V);
1578       }
1579 
1580       if (IntrinsicID == Intrinsic::trunc) {
1581         APFloat V = Op->getValueAPF();
1582         V.roundToIntegral(APFloat::rmTowardZero);
1583         return ConstantFP::get(Ty->getContext(), V);
1584       }
1585 
1586       if (IntrinsicID == Intrinsic::rint) {
1587         APFloat V = Op->getValueAPF();
1588         V.roundToIntegral(APFloat::rmNearestTiesToEven);
1589         return ConstantFP::get(Ty->getContext(), V);
1590       }
1591 
1592       if (IntrinsicID == Intrinsic::nearbyint) {
1593         APFloat V = Op->getValueAPF();
1594         V.roundToIntegral(APFloat::rmNearestTiesToEven);
1595         return ConstantFP::get(Ty->getContext(), V);
1596       }
1597 
1598       /// We only fold functions with finite arguments. Folding NaN and inf is
1599       /// likely to be aborted with an exception anyway, and some host libms
1600       /// have known errors raising exceptions.
1601       if (Op->getValueAPF().isNaN() || Op->getValueAPF().isInfinity())
1602         return nullptr;
1603 
1604       /// Currently APFloat versions of these functions do not exist, so we use
1605       /// the host native double versions.  Float versions are not called
1606       /// directly but for all these it is true (float)(f((double)arg)) ==
1607       /// f(arg).  Long double not supported yet.
1608       double V = getValueAsDouble(Op);
1609 
1610       switch (IntrinsicID) {
1611         default: break;
1612         case Intrinsic::fabs:
1613           return ConstantFoldFP(fabs, V, Ty);
1614         case Intrinsic::log2:
1615           return ConstantFoldFP(Log2, V, Ty);
1616         case Intrinsic::log:
1617           return ConstantFoldFP(log, V, Ty);
1618         case Intrinsic::log10:
1619           return ConstantFoldFP(log10, V, Ty);
1620         case Intrinsic::exp:
1621           return ConstantFoldFP(exp, V, Ty);
1622         case Intrinsic::exp2:
1623           return ConstantFoldFP(exp2, V, Ty);
1624         case Intrinsic::sin:
1625           return ConstantFoldFP(sin, V, Ty);
1626         case Intrinsic::cos:
1627           return ConstantFoldFP(cos, V, Ty);
1628       }
1629 
1630       if (!TLI)
1631         return nullptr;
1632 
1633       switch (Name[0]) {
1634       case 'a':
1635         if ((Name == "acos" && TLI->has(LibFunc::acos)) ||
1636             (Name == "acosf" && TLI->has(LibFunc::acosf)))
1637           return ConstantFoldFP(acos, V, Ty);
1638         else if ((Name == "asin" && TLI->has(LibFunc::asin)) ||
1639                  (Name == "asinf" && TLI->has(LibFunc::asinf)))
1640           return ConstantFoldFP(asin, V, Ty);
1641         else if ((Name == "atan" && TLI->has(LibFunc::atan)) ||
1642                  (Name == "atanf" && TLI->has(LibFunc::atanf)))
1643           return ConstantFoldFP(atan, V, Ty);
1644         break;
1645       case 'c':
1646         if ((Name == "ceil" && TLI->has(LibFunc::ceil)) ||
1647             (Name == "ceilf" && TLI->has(LibFunc::ceilf)))
1648           return ConstantFoldFP(ceil, V, Ty);
1649         else if ((Name == "cos" && TLI->has(LibFunc::cos)) ||
1650                  (Name == "cosf" && TLI->has(LibFunc::cosf)))
1651           return ConstantFoldFP(cos, V, Ty);
1652         else if ((Name == "cosh" && TLI->has(LibFunc::cosh)) ||
1653                  (Name == "coshf" && TLI->has(LibFunc::coshf)))
1654           return ConstantFoldFP(cosh, V, Ty);
1655         break;
1656       case 'e':
1657         if ((Name == "exp" && TLI->has(LibFunc::exp)) ||
1658             (Name == "expf" && TLI->has(LibFunc::expf)))
1659           return ConstantFoldFP(exp, V, Ty);
1660         if ((Name == "exp2" && TLI->has(LibFunc::exp2)) ||
1661             (Name == "exp2f" && TLI->has(LibFunc::exp2f)))
1662           // Constant fold exp2(x) as pow(2,x) in case the host doesn't have a
1663           // C99 library.
1664           return ConstantFoldBinaryFP(pow, 2.0, V, Ty);
1665         break;
1666       case 'f':
1667         if ((Name == "fabs" && TLI->has(LibFunc::fabs)) ||
1668             (Name == "fabsf" && TLI->has(LibFunc::fabsf)))
1669           return ConstantFoldFP(fabs, V, Ty);
1670         else if ((Name == "floor" && TLI->has(LibFunc::floor)) ||
1671                  (Name == "floorf" && TLI->has(LibFunc::floorf)))
1672           return ConstantFoldFP(floor, V, Ty);
1673         break;
1674       case 'l':
1675         if ((Name == "log" && V > 0 && TLI->has(LibFunc::log)) ||
1676             (Name == "logf" && V > 0 && TLI->has(LibFunc::logf)))
1677           return ConstantFoldFP(log, V, Ty);
1678         else if ((Name == "log10" && V > 0 && TLI->has(LibFunc::log10)) ||
1679                  (Name == "log10f" && V > 0 && TLI->has(LibFunc::log10f)))
1680           return ConstantFoldFP(log10, V, Ty);
1681         else if (IntrinsicID == Intrinsic::sqrt &&
1682                  (Ty->isHalfTy() || Ty->isFloatTy() || Ty->isDoubleTy())) {
1683           if (V >= -0.0)
1684             return ConstantFoldFP(sqrt, V, Ty);
1685           else {
1686             // Unlike the sqrt definitions in C/C++, POSIX, and IEEE-754 - which
1687             // all guarantee or favor returning NaN - the square root of a
1688             // negative number is not defined for the LLVM sqrt intrinsic.
1689             // This is because the intrinsic should only be emitted in place of
1690             // libm's sqrt function when using "no-nans-fp-math".
1691             return UndefValue::get(Ty);
1692           }
1693         }
1694         break;
1695       case 's':
1696         if ((Name == "sin" && TLI->has(LibFunc::sin)) ||
1697             (Name == "sinf" && TLI->has(LibFunc::sinf)))
1698           return ConstantFoldFP(sin, V, Ty);
1699         else if ((Name == "sinh" && TLI->has(LibFunc::sinh)) ||
1700                  (Name == "sinhf" && TLI->has(LibFunc::sinhf)))
1701           return ConstantFoldFP(sinh, V, Ty);
1702         else if ((Name == "sqrt" && V >= 0 && TLI->has(LibFunc::sqrt)) ||
1703                  (Name == "sqrtf" && V >= 0 && TLI->has(LibFunc::sqrtf)))
1704           return ConstantFoldFP(sqrt, V, Ty);
1705         break;
1706       case 't':
1707         if ((Name == "tan" && TLI->has(LibFunc::tan)) ||
1708             (Name == "tanf" && TLI->has(LibFunc::tanf)))
1709           return ConstantFoldFP(tan, V, Ty);
1710         else if ((Name == "tanh" && TLI->has(LibFunc::tanh)) ||
1711                  (Name == "tanhf" && TLI->has(LibFunc::tanhf)))
1712           return ConstantFoldFP(tanh, V, Ty);
1713         break;
1714       default:
1715         break;
1716       }
1717       return nullptr;
1718     }
1719 
1720     if (auto *Op = dyn_cast<ConstantInt>(Operands[0])) {
1721       switch (IntrinsicID) {
1722       case Intrinsic::bswap:
1723         return ConstantInt::get(Ty->getContext(), Op->getValue().byteSwap());
1724       case Intrinsic::ctpop:
1725         return ConstantInt::get(Ty, Op->getValue().countPopulation());
1726       case Intrinsic::bitreverse:
1727         return ConstantInt::get(Ty->getContext(), Op->getValue().reverseBits());
1728       case Intrinsic::convert_from_fp16: {
1729         APFloat Val(APFloat::IEEEhalf, Op->getValue());
1730 
1731         bool lost = false;
1732         APFloat::opStatus status = Val.convert(
1733             Ty->getFltSemantics(), APFloat::rmNearestTiesToEven, &lost);
1734 
1735         // Conversion is always precise.
1736         (void)status;
1737         assert(status == APFloat::opOK && !lost &&
1738                "Precision lost during fp16 constfolding");
1739 
1740         return ConstantFP::get(Ty->getContext(), Val);
1741       }
1742       default:
1743         return nullptr;
1744       }
1745     }
1746 
1747     // Support ConstantVector in case we have an Undef in the top.
1748     if (isa<ConstantVector>(Operands[0]) ||
1749         isa<ConstantDataVector>(Operands[0])) {
1750       auto *Op = cast<Constant>(Operands[0]);
1751       switch (IntrinsicID) {
1752       default: break;
1753       case Intrinsic::x86_sse_cvtss2si:
1754       case Intrinsic::x86_sse_cvtss2si64:
1755       case Intrinsic::x86_sse2_cvtsd2si:
1756       case Intrinsic::x86_sse2_cvtsd2si64:
1757         if (ConstantFP *FPOp =
1758                 dyn_cast_or_null<ConstantFP>(Op->getAggregateElement(0U)))
1759           return ConstantFoldSSEConvertToInt(FPOp->getValueAPF(),
1760                                              /*roundTowardZero=*/false, Ty);
1761       case Intrinsic::x86_sse_cvttss2si:
1762       case Intrinsic::x86_sse_cvttss2si64:
1763       case Intrinsic::x86_sse2_cvttsd2si:
1764       case Intrinsic::x86_sse2_cvttsd2si64:
1765         if (ConstantFP *FPOp =
1766                 dyn_cast_or_null<ConstantFP>(Op->getAggregateElement(0U)))
1767           return ConstantFoldSSEConvertToInt(FPOp->getValueAPF(),
1768                                              /*roundTowardZero=*/true, Ty);
1769       }
1770     }
1771 
1772     if (isa<UndefValue>(Operands[0])) {
1773       if (IntrinsicID == Intrinsic::bswap)
1774         return Operands[0];
1775       return nullptr;
1776     }
1777 
1778     return nullptr;
1779   }
1780 
1781   if (Operands.size() == 2) {
1782     if (auto *Op1 = dyn_cast<ConstantFP>(Operands[0])) {
1783       if (!Ty->isHalfTy() && !Ty->isFloatTy() && !Ty->isDoubleTy())
1784         return nullptr;
1785       double Op1V = getValueAsDouble(Op1);
1786 
1787       if (auto *Op2 = dyn_cast<ConstantFP>(Operands[1])) {
1788         if (Op2->getType() != Op1->getType())
1789           return nullptr;
1790 
1791         double Op2V = getValueAsDouble(Op2);
1792         if (IntrinsicID == Intrinsic::pow) {
1793           return ConstantFoldBinaryFP(pow, Op1V, Op2V, Ty);
1794         }
1795         if (IntrinsicID == Intrinsic::copysign) {
1796           APFloat V1 = Op1->getValueAPF();
1797           const APFloat &V2 = Op2->getValueAPF();
1798           V1.copySign(V2);
1799           return ConstantFP::get(Ty->getContext(), V1);
1800         }
1801 
1802         if (IntrinsicID == Intrinsic::minnum) {
1803           const APFloat &C1 = Op1->getValueAPF();
1804           const APFloat &C2 = Op2->getValueAPF();
1805           return ConstantFP::get(Ty->getContext(), minnum(C1, C2));
1806         }
1807 
1808         if (IntrinsicID == Intrinsic::maxnum) {
1809           const APFloat &C1 = Op1->getValueAPF();
1810           const APFloat &C2 = Op2->getValueAPF();
1811           return ConstantFP::get(Ty->getContext(), maxnum(C1, C2));
1812         }
1813 
1814         if (!TLI)
1815           return nullptr;
1816         if ((Name == "pow" && TLI->has(LibFunc::pow)) ||
1817             (Name == "powf" && TLI->has(LibFunc::powf)))
1818           return ConstantFoldBinaryFP(pow, Op1V, Op2V, Ty);
1819         if ((Name == "fmod" && TLI->has(LibFunc::fmod)) ||
1820             (Name == "fmodf" && TLI->has(LibFunc::fmodf)))
1821           return ConstantFoldBinaryFP(fmod, Op1V, Op2V, Ty);
1822         if ((Name == "atan2" && TLI->has(LibFunc::atan2)) ||
1823             (Name == "atan2f" && TLI->has(LibFunc::atan2f)))
1824           return ConstantFoldBinaryFP(atan2, Op1V, Op2V, Ty);
1825       } else if (auto *Op2C = dyn_cast<ConstantInt>(Operands[1])) {
1826         if (IntrinsicID == Intrinsic::powi && Ty->isHalfTy())
1827           return ConstantFP::get(Ty->getContext(),
1828                                  APFloat((float)std::pow((float)Op1V,
1829                                                  (int)Op2C->getZExtValue())));
1830         if (IntrinsicID == Intrinsic::powi && Ty->isFloatTy())
1831           return ConstantFP::get(Ty->getContext(),
1832                                  APFloat((float)std::pow((float)Op1V,
1833                                                  (int)Op2C->getZExtValue())));
1834         if (IntrinsicID == Intrinsic::powi && Ty->isDoubleTy())
1835           return ConstantFP::get(Ty->getContext(),
1836                                  APFloat((double)std::pow((double)Op1V,
1837                                                    (int)Op2C->getZExtValue())));
1838       }
1839       return nullptr;
1840     }
1841 
1842     if (auto *Op1 = dyn_cast<ConstantInt>(Operands[0])) {
1843       if (auto *Op2 = dyn_cast<ConstantInt>(Operands[1])) {
1844         switch (IntrinsicID) {
1845         default: break;
1846         case Intrinsic::sadd_with_overflow:
1847         case Intrinsic::uadd_with_overflow:
1848         case Intrinsic::ssub_with_overflow:
1849         case Intrinsic::usub_with_overflow:
1850         case Intrinsic::smul_with_overflow:
1851         case Intrinsic::umul_with_overflow: {
1852           APInt Res;
1853           bool Overflow;
1854           switch (IntrinsicID) {
1855           default: llvm_unreachable("Invalid case");
1856           case Intrinsic::sadd_with_overflow:
1857             Res = Op1->getValue().sadd_ov(Op2->getValue(), Overflow);
1858             break;
1859           case Intrinsic::uadd_with_overflow:
1860             Res = Op1->getValue().uadd_ov(Op2->getValue(), Overflow);
1861             break;
1862           case Intrinsic::ssub_with_overflow:
1863             Res = Op1->getValue().ssub_ov(Op2->getValue(), Overflow);
1864             break;
1865           case Intrinsic::usub_with_overflow:
1866             Res = Op1->getValue().usub_ov(Op2->getValue(), Overflow);
1867             break;
1868           case Intrinsic::smul_with_overflow:
1869             Res = Op1->getValue().smul_ov(Op2->getValue(), Overflow);
1870             break;
1871           case Intrinsic::umul_with_overflow:
1872             Res = Op1->getValue().umul_ov(Op2->getValue(), Overflow);
1873             break;
1874           }
1875           Constant *Ops[] = {
1876             ConstantInt::get(Ty->getContext(), Res),
1877             ConstantInt::get(Type::getInt1Ty(Ty->getContext()), Overflow)
1878           };
1879           return ConstantStruct::get(cast<StructType>(Ty), Ops);
1880         }
1881         case Intrinsic::cttz:
1882           if (Op2->isOne() && Op1->isZero()) // cttz(0, 1) is undef.
1883             return UndefValue::get(Ty);
1884           return ConstantInt::get(Ty, Op1->getValue().countTrailingZeros());
1885         case Intrinsic::ctlz:
1886           if (Op2->isOne() && Op1->isZero()) // ctlz(0, 1) is undef.
1887             return UndefValue::get(Ty);
1888           return ConstantInt::get(Ty, Op1->getValue().countLeadingZeros());
1889         }
1890       }
1891 
1892       return nullptr;
1893     }
1894     return nullptr;
1895   }
1896 
1897   if (Operands.size() != 3)
1898     return nullptr;
1899 
1900   if (const auto *Op1 = dyn_cast<ConstantFP>(Operands[0])) {
1901     if (const auto *Op2 = dyn_cast<ConstantFP>(Operands[1])) {
1902       if (const auto *Op3 = dyn_cast<ConstantFP>(Operands[2])) {
1903         switch (IntrinsicID) {
1904         default: break;
1905         case Intrinsic::fma:
1906         case Intrinsic::fmuladd: {
1907           APFloat V = Op1->getValueAPF();
1908           APFloat::opStatus s = V.fusedMultiplyAdd(Op2->getValueAPF(),
1909                                                    Op3->getValueAPF(),
1910                                                    APFloat::rmNearestTiesToEven);
1911           if (s != APFloat::opInvalidOp)
1912             return ConstantFP::get(Ty->getContext(), V);
1913 
1914           return nullptr;
1915         }
1916         }
1917       }
1918     }
1919   }
1920 
1921   return nullptr;
1922 }
1923 
1924 Constant *ConstantFoldVectorCall(StringRef Name, unsigned IntrinsicID,
1925                                  VectorType *VTy, ArrayRef<Constant *> Operands,
1926                                  const DataLayout &DL,
1927                                  const TargetLibraryInfo *TLI) {
1928   SmallVector<Constant *, 4> Result(VTy->getNumElements());
1929   SmallVector<Constant *, 4> Lane(Operands.size());
1930   Type *Ty = VTy->getElementType();
1931 
1932   if (IntrinsicID == Intrinsic::masked_load) {
1933     auto *SrcPtr = Operands[0];
1934     auto *Mask = Operands[2];
1935     auto *Passthru = Operands[3];
1936 
1937     Constant *VecData = ConstantFoldLoadFromConstPtr(SrcPtr, VTy, DL);
1938 
1939     SmallVector<Constant *, 32> NewElements;
1940     for (unsigned I = 0, E = VTy->getNumElements(); I != E; ++I) {
1941       auto *MaskElt = Mask->getAggregateElement(I);
1942       if (!MaskElt)
1943         break;
1944       auto *PassthruElt = Passthru->getAggregateElement(I);
1945       auto *VecElt = VecData ? VecData->getAggregateElement(I) : nullptr;
1946       if (isa<UndefValue>(MaskElt)) {
1947         if (PassthruElt)
1948           NewElements.push_back(PassthruElt);
1949         else if (VecElt)
1950           NewElements.push_back(VecElt);
1951         else
1952           return nullptr;
1953       }
1954       if (MaskElt->isNullValue()) {
1955         if (!PassthruElt)
1956           return nullptr;
1957         NewElements.push_back(PassthruElt);
1958       } else if (MaskElt->isOneValue()) {
1959         if (!VecElt)
1960           return nullptr;
1961         NewElements.push_back(VecElt);
1962       } else {
1963         return nullptr;
1964       }
1965     }
1966     if (NewElements.size() != VTy->getNumElements())
1967       return nullptr;
1968     return ConstantVector::get(NewElements);
1969   }
1970 
1971   for (unsigned I = 0, E = VTy->getNumElements(); I != E; ++I) {
1972     // Gather a column of constants.
1973     for (unsigned J = 0, JE = Operands.size(); J != JE; ++J) {
1974       Constant *Agg = Operands[J]->getAggregateElement(I);
1975       if (!Agg)
1976         return nullptr;
1977 
1978       Lane[J] = Agg;
1979     }
1980 
1981     // Use the regular scalar folding to simplify this column.
1982     Constant *Folded = ConstantFoldScalarCall(Name, IntrinsicID, Ty, Lane, TLI);
1983     if (!Folded)
1984       return nullptr;
1985     Result[I] = Folded;
1986   }
1987 
1988   return ConstantVector::get(Result);
1989 }
1990 
1991 } // end anonymous namespace
1992 
1993 Constant *
1994 llvm::ConstantFoldCall(Function *F, ArrayRef<Constant *> Operands,
1995                        const TargetLibraryInfo *TLI) {
1996   if (!F->hasName())
1997     return nullptr;
1998   StringRef Name = F->getName();
1999 
2000   Type *Ty = F->getReturnType();
2001 
2002   if (auto *VTy = dyn_cast<VectorType>(Ty))
2003     return ConstantFoldVectorCall(Name, F->getIntrinsicID(), VTy, Operands,
2004                                   F->getParent()->getDataLayout(), TLI);
2005 
2006   return ConstantFoldScalarCall(Name, F->getIntrinsicID(), Ty, Operands, TLI);
2007 }
2008 
2009 bool llvm::isMathLibCallNoop(CallSite CS, const TargetLibraryInfo *TLI) {
2010   // FIXME: Refactor this code; this duplicates logic in LibCallsShrinkWrap
2011   // (and to some extent ConstantFoldScalarCall).
2012   Function *F = CS.getCalledFunction();
2013   if (!F)
2014     return false;
2015 
2016   LibFunc::Func Func;
2017   if (!TLI || !TLI->getLibFunc(*F, Func))
2018     return false;
2019 
2020   if (CS.getNumArgOperands() == 1) {
2021     if (ConstantFP *OpC = dyn_cast<ConstantFP>(CS.getArgOperand(0))) {
2022       const APFloat &Op = OpC->getValueAPF();
2023       switch (Func) {
2024       case LibFunc::logl:
2025       case LibFunc::log:
2026       case LibFunc::logf:
2027       case LibFunc::log2l:
2028       case LibFunc::log2:
2029       case LibFunc::log2f:
2030       case LibFunc::log10l:
2031       case LibFunc::log10:
2032       case LibFunc::log10f:
2033         return Op.isNaN() || (!Op.isZero() && !Op.isNegative());
2034 
2035       case LibFunc::expl:
2036       case LibFunc::exp:
2037       case LibFunc::expf:
2038         // FIXME: These boundaries are slightly conservative.
2039         if (OpC->getType()->isDoubleTy())
2040           return Op.compare(APFloat(-745.0)) != APFloat::cmpLessThan &&
2041                  Op.compare(APFloat(709.0)) != APFloat::cmpGreaterThan;
2042         if (OpC->getType()->isFloatTy())
2043           return Op.compare(APFloat(-103.0f)) != APFloat::cmpLessThan &&
2044                  Op.compare(APFloat(88.0f)) != APFloat::cmpGreaterThan;
2045         break;
2046 
2047       case LibFunc::exp2l:
2048       case LibFunc::exp2:
2049       case LibFunc::exp2f:
2050         // FIXME: These boundaries are slightly conservative.
2051         if (OpC->getType()->isDoubleTy())
2052           return Op.compare(APFloat(-1074.0)) != APFloat::cmpLessThan &&
2053                  Op.compare(APFloat(1023.0)) != APFloat::cmpGreaterThan;
2054         if (OpC->getType()->isFloatTy())
2055           return Op.compare(APFloat(-149.0f)) != APFloat::cmpLessThan &&
2056                  Op.compare(APFloat(127.0f)) != APFloat::cmpGreaterThan;
2057         break;
2058 
2059       case LibFunc::sinl:
2060       case LibFunc::sin:
2061       case LibFunc::sinf:
2062       case LibFunc::cosl:
2063       case LibFunc::cos:
2064       case LibFunc::cosf:
2065         return !Op.isInfinity();
2066 
2067       case LibFunc::tanl:
2068       case LibFunc::tan:
2069       case LibFunc::tanf: {
2070         // FIXME: Stop using the host math library.
2071         // FIXME: The computation isn't done in the right precision.
2072         Type *Ty = OpC->getType();
2073         if (Ty->isDoubleTy() || Ty->isFloatTy() || Ty->isHalfTy()) {
2074           double OpV = getValueAsDouble(OpC);
2075           return ConstantFoldFP(tan, OpV, Ty) != nullptr;
2076         }
2077         break;
2078       }
2079 
2080       case LibFunc::asinl:
2081       case LibFunc::asin:
2082       case LibFunc::asinf:
2083       case LibFunc::acosl:
2084       case LibFunc::acos:
2085       case LibFunc::acosf:
2086         return Op.compare(APFloat(Op.getSemantics(), "-1")) !=
2087                    APFloat::cmpLessThan &&
2088                Op.compare(APFloat(Op.getSemantics(), "1")) !=
2089                    APFloat::cmpGreaterThan;
2090 
2091       case LibFunc::sinh:
2092       case LibFunc::cosh:
2093       case LibFunc::sinhf:
2094       case LibFunc::coshf:
2095       case LibFunc::sinhl:
2096       case LibFunc::coshl:
2097         // FIXME: These boundaries are slightly conservative.
2098         if (OpC->getType()->isDoubleTy())
2099           return Op.compare(APFloat(-710.0)) != APFloat::cmpLessThan &&
2100                  Op.compare(APFloat(710.0)) != APFloat::cmpGreaterThan;
2101         if (OpC->getType()->isFloatTy())
2102           return Op.compare(APFloat(-89.0f)) != APFloat::cmpLessThan &&
2103                  Op.compare(APFloat(89.0f)) != APFloat::cmpGreaterThan;
2104         break;
2105 
2106       case LibFunc::sqrtl:
2107       case LibFunc::sqrt:
2108       case LibFunc::sqrtf:
2109         return Op.isNaN() || Op.isZero() || !Op.isNegative();
2110 
2111       // FIXME: Add more functions: sqrt_finite, atanh, expm1, log1p,
2112       // maybe others?
2113       default:
2114         break;
2115       }
2116     }
2117   }
2118 
2119   if (CS.getNumArgOperands() == 2) {
2120     ConstantFP *Op0C = dyn_cast<ConstantFP>(CS.getArgOperand(0));
2121     ConstantFP *Op1C = dyn_cast<ConstantFP>(CS.getArgOperand(1));
2122     if (Op0C && Op1C) {
2123       const APFloat &Op0 = Op0C->getValueAPF();
2124       const APFloat &Op1 = Op1C->getValueAPF();
2125 
2126       switch (Func) {
2127       case LibFunc::powl:
2128       case LibFunc::pow:
2129       case LibFunc::powf: {
2130         // FIXME: Stop using the host math library.
2131         // FIXME: The computation isn't done in the right precision.
2132         Type *Ty = Op0C->getType();
2133         if (Ty->isDoubleTy() || Ty->isFloatTy() || Ty->isHalfTy()) {
2134           if (Ty == Op1C->getType()) {
2135             double Op0V = getValueAsDouble(Op0C);
2136             double Op1V = getValueAsDouble(Op1C);
2137             return ConstantFoldBinaryFP(pow, Op0V, Op1V, Ty) != nullptr;
2138           }
2139         }
2140         break;
2141       }
2142 
2143       case LibFunc::fmodl:
2144       case LibFunc::fmod:
2145       case LibFunc::fmodf:
2146         return Op0.isNaN() || Op1.isNaN() ||
2147                (!Op0.isInfinity() && !Op1.isZero());
2148 
2149       default:
2150         break;
2151       }
2152     }
2153   }
2154 
2155   return false;
2156 }
2157