1 //===-- ConstantFolding.cpp - Fold instructions into constants ------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines routines for folding instructions into constants.
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
17 //===----------------------------------------------------------------------===//
19 #include "llvm/Analysis/ConstantFolding.h"
20 #include "llvm/ADT/SmallVector.h"
21 #include "llvm/ADT/StringMap.h"
22 #include "llvm/Analysis/ValueTracking.h"
23 #include "llvm/IR/Constants.h"
24 #include "llvm/IR/DataLayout.h"
25 #include "llvm/IR/DerivedTypes.h"
26 #include "llvm/IR/Function.h"
27 #include "llvm/IR/GlobalVariable.h"
28 #include "llvm/IR/Instructions.h"
29 #include "llvm/IR/Intrinsics.h"
30 #include "llvm/IR/Operator.h"
31 #include "llvm/Support/ErrorHandling.h"
32 #include "llvm/Support/FEnv.h"
33 #include "llvm/Support/GetElementPtrTypeIterator.h"
34 #include "llvm/Support/MathExtras.h"
35 #include "llvm/Target/TargetLibraryInfo.h"
40 //===----------------------------------------------------------------------===//
41 // Constant Folding internal helper functions
42 //===----------------------------------------------------------------------===//
44 /// FoldBitCast - Constant fold bitcast, symbolically evaluating it with
45 /// DataLayout. This always returns a non-null constant, but it may be a
46 /// ConstantExpr if unfoldable.
47 static Constant *FoldBitCast(Constant *C, Type *DestTy,
48 const DataLayout &TD) {
49 // Catch the obvious splat cases.
50 if (C->isNullValue() && !DestTy->isX86_MMXTy())
51 return Constant::getNullValue(DestTy);
52 if (C->isAllOnesValue() && !DestTy->isX86_MMXTy())
53 return Constant::getAllOnesValue(DestTy);
55 // Handle a vector->integer cast.
56 if (IntegerType *IT = dyn_cast<IntegerType>(DestTy)) {
57 ConstantDataVector *CDV = dyn_cast<ConstantDataVector>(C);
59 return ConstantExpr::getBitCast(C, DestTy);
61 unsigned NumSrcElts = CDV->getType()->getNumElements();
63 Type *SrcEltTy = CDV->getType()->getElementType();
65 // If the vector is a vector of floating point, convert it to vector of int
66 // to simplify things.
67 if (SrcEltTy->isFloatingPointTy()) {
68 unsigned FPWidth = SrcEltTy->getPrimitiveSizeInBits();
70 VectorType::get(IntegerType::get(C->getContext(), FPWidth), NumSrcElts);
71 // Ask IR to do the conversion now that #elts line up.
72 C = ConstantExpr::getBitCast(C, SrcIVTy);
73 CDV = cast<ConstantDataVector>(C);
76 // Now that we know that the input value is a vector of integers, just shift
77 // and insert them into our result.
78 unsigned BitShift = TD.getTypeAllocSizeInBits(SrcEltTy);
79 APInt Result(IT->getBitWidth(), 0);
80 for (unsigned i = 0; i != NumSrcElts; ++i) {
82 if (TD.isLittleEndian())
83 Result |= CDV->getElementAsInteger(NumSrcElts-i-1);
85 Result |= CDV->getElementAsInteger(i);
88 return ConstantInt::get(IT, Result);
91 // The code below only handles casts to vectors currently.
92 VectorType *DestVTy = dyn_cast<VectorType>(DestTy);
94 return ConstantExpr::getBitCast(C, DestTy);
96 // If this is a scalar -> vector cast, convert the input into a <1 x scalar>
97 // vector so the code below can handle it uniformly.
98 if (isa<ConstantFP>(C) || isa<ConstantInt>(C)) {
99 Constant *Ops = C; // don't take the address of C!
100 return FoldBitCast(ConstantVector::get(Ops), DestTy, TD);
103 // If this is a bitcast from constant vector -> vector, fold it.
104 if (!isa<ConstantDataVector>(C) && !isa<ConstantVector>(C))
105 return ConstantExpr::getBitCast(C, DestTy);
107 // If the element types match, IR can fold it.
108 unsigned NumDstElt = DestVTy->getNumElements();
109 unsigned NumSrcElt = C->getType()->getVectorNumElements();
110 if (NumDstElt == NumSrcElt)
111 return ConstantExpr::getBitCast(C, DestTy);
113 Type *SrcEltTy = C->getType()->getVectorElementType();
114 Type *DstEltTy = DestVTy->getElementType();
116 // Otherwise, we're changing the number of elements in a vector, which
117 // requires endianness information to do the right thing. For example,
118 // bitcast (<2 x i64> <i64 0, i64 1> to <4 x i32>)
119 // folds to (little endian):
120 // <4 x i32> <i32 0, i32 0, i32 1, i32 0>
121 // and to (big endian):
122 // <4 x i32> <i32 0, i32 0, i32 0, i32 1>
124 // First thing is first. We only want to think about integer here, so if
125 // we have something in FP form, recast it as integer.
126 if (DstEltTy->isFloatingPointTy()) {
127 // Fold to an vector of integers with same size as our FP type.
128 unsigned FPWidth = DstEltTy->getPrimitiveSizeInBits();
130 VectorType::get(IntegerType::get(C->getContext(), FPWidth), NumDstElt);
131 // Recursively handle this integer conversion, if possible.
132 C = FoldBitCast(C, DestIVTy, TD);
134 // Finally, IR can handle this now that #elts line up.
135 return ConstantExpr::getBitCast(C, DestTy);
138 // Okay, we know the destination is integer, if the input is FP, convert
139 // it to integer first.
140 if (SrcEltTy->isFloatingPointTy()) {
141 unsigned FPWidth = SrcEltTy->getPrimitiveSizeInBits();
143 VectorType::get(IntegerType::get(C->getContext(), FPWidth), NumSrcElt);
144 // Ask IR to do the conversion now that #elts line up.
145 C = ConstantExpr::getBitCast(C, SrcIVTy);
146 // If IR wasn't able to fold it, bail out.
147 if (!isa<ConstantVector>(C) && // FIXME: Remove ConstantVector.
148 !isa<ConstantDataVector>(C))
152 // Now we know that the input and output vectors are both integer vectors
153 // of the same size, and that their #elements is not the same. Do the
154 // conversion here, which depends on whether the input or output has
156 bool isLittleEndian = TD.isLittleEndian();
158 SmallVector<Constant*, 32> Result;
159 if (NumDstElt < NumSrcElt) {
160 // Handle: bitcast (<4 x i32> <i32 0, i32 1, i32 2, i32 3> to <2 x i64>)
161 Constant *Zero = Constant::getNullValue(DstEltTy);
162 unsigned Ratio = NumSrcElt/NumDstElt;
163 unsigned SrcBitSize = SrcEltTy->getPrimitiveSizeInBits();
165 for (unsigned i = 0; i != NumDstElt; ++i) {
166 // Build each element of the result.
167 Constant *Elt = Zero;
168 unsigned ShiftAmt = isLittleEndian ? 0 : SrcBitSize*(Ratio-1);
169 for (unsigned j = 0; j != Ratio; ++j) {
170 Constant *Src =dyn_cast<ConstantInt>(C->getAggregateElement(SrcElt++));
171 if (!Src) // Reject constantexpr elements.
172 return ConstantExpr::getBitCast(C, DestTy);
174 // Zero extend the element to the right size.
175 Src = ConstantExpr::getZExt(Src, Elt->getType());
177 // Shift it to the right place, depending on endianness.
178 Src = ConstantExpr::getShl(Src,
179 ConstantInt::get(Src->getType(), ShiftAmt));
180 ShiftAmt += isLittleEndian ? SrcBitSize : -SrcBitSize;
183 Elt = ConstantExpr::getOr(Elt, Src);
185 Result.push_back(Elt);
187 return ConstantVector::get(Result);
190 // Handle: bitcast (<2 x i64> <i64 0, i64 1> to <4 x i32>)
191 unsigned Ratio = NumDstElt/NumSrcElt;
192 unsigned DstBitSize = DstEltTy->getPrimitiveSizeInBits();
194 // Loop over each source value, expanding into multiple results.
195 for (unsigned i = 0; i != NumSrcElt; ++i) {
196 Constant *Src = dyn_cast<ConstantInt>(C->getAggregateElement(i));
197 if (!Src) // Reject constantexpr elements.
198 return ConstantExpr::getBitCast(C, DestTy);
200 unsigned ShiftAmt = isLittleEndian ? 0 : DstBitSize*(Ratio-1);
201 for (unsigned j = 0; j != Ratio; ++j) {
202 // Shift the piece of the value into the right place, depending on
204 Constant *Elt = ConstantExpr::getLShr(Src,
205 ConstantInt::get(Src->getType(), ShiftAmt));
206 ShiftAmt += isLittleEndian ? DstBitSize : -DstBitSize;
208 // Truncate and remember this piece.
209 Result.push_back(ConstantExpr::getTrunc(Elt, DstEltTy));
213 return ConstantVector::get(Result);
217 /// IsConstantOffsetFromGlobal - If this constant is actually a constant offset
218 /// from a global, return the global and the constant. Because of
219 /// constantexprs, this function is recursive.
220 static bool IsConstantOffsetFromGlobal(Constant *C, GlobalValue *&GV,
221 APInt &Offset, const DataLayout &TD) {
222 // Trivial case, constant is the global.
223 if ((GV = dyn_cast<GlobalValue>(C))) {
224 Offset.clearAllBits();
228 // Otherwise, if this isn't a constant expr, bail out.
229 ConstantExpr *CE = dyn_cast<ConstantExpr>(C);
230 if (!CE) return false;
232 // Look through ptr->int and ptr->ptr casts.
233 if (CE->getOpcode() == Instruction::PtrToInt ||
234 CE->getOpcode() == Instruction::BitCast)
235 return IsConstantOffsetFromGlobal(CE->getOperand(0), GV, Offset, TD);
237 // i32* getelementptr ([5 x i32]* @a, i32 0, i32 5)
238 if (GEPOperator *GEP = dyn_cast<GEPOperator>(CE)) {
239 // If the base isn't a global+constant, we aren't either.
240 if (!IsConstantOffsetFromGlobal(CE->getOperand(0), GV, Offset, TD))
243 // Otherwise, add any offset that our operands provide.
244 return GEP->accumulateConstantOffset(TD, Offset);
250 /// ReadDataFromGlobal - Recursive helper to read bits out of global. C is the
251 /// constant being copied out of. ByteOffset is an offset into C. CurPtr is the
252 /// pointer to copy results into and BytesLeft is the number of bytes left in
253 /// the CurPtr buffer. TD is the target data.
254 static bool ReadDataFromGlobal(Constant *C, uint64_t ByteOffset,
255 unsigned char *CurPtr, unsigned BytesLeft,
256 const DataLayout &TD) {
257 assert(ByteOffset <= TD.getTypeAllocSize(C->getType()) &&
258 "Out of range access");
260 // If this element is zero or undefined, we can just return since *CurPtr is
262 if (isa<ConstantAggregateZero>(C) || isa<UndefValue>(C))
265 if (ConstantInt *CI = dyn_cast<ConstantInt>(C)) {
266 if (CI->getBitWidth() > 64 ||
267 (CI->getBitWidth() & 7) != 0)
270 uint64_t Val = CI->getZExtValue();
271 unsigned IntBytes = unsigned(CI->getBitWidth()/8);
273 for (unsigned i = 0; i != BytesLeft && ByteOffset != IntBytes; ++i) {
275 if (!TD.isLittleEndian())
276 n = IntBytes - n - 1;
277 CurPtr[i] = (unsigned char)(Val >> (n * 8));
283 if (ConstantFP *CFP = dyn_cast<ConstantFP>(C)) {
284 if (CFP->getType()->isDoubleTy()) {
285 C = FoldBitCast(C, Type::getInt64Ty(C->getContext()), TD);
286 return ReadDataFromGlobal(C, ByteOffset, CurPtr, BytesLeft, TD);
288 if (CFP->getType()->isFloatTy()){
289 C = FoldBitCast(C, Type::getInt32Ty(C->getContext()), TD);
290 return ReadDataFromGlobal(C, ByteOffset, CurPtr, BytesLeft, TD);
295 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(C)) {
296 const StructLayout *SL = TD.getStructLayout(CS->getType());
297 unsigned Index = SL->getElementContainingOffset(ByteOffset);
298 uint64_t CurEltOffset = SL->getElementOffset(Index);
299 ByteOffset -= CurEltOffset;
302 // If the element access is to the element itself and not to tail padding,
303 // read the bytes from the element.
304 uint64_t EltSize = TD.getTypeAllocSize(CS->getOperand(Index)->getType());
306 if (ByteOffset < EltSize &&
307 !ReadDataFromGlobal(CS->getOperand(Index), ByteOffset, CurPtr,
313 // Check to see if we read from the last struct element, if so we're done.
314 if (Index == CS->getType()->getNumElements())
317 // If we read all of the bytes we needed from this element we're done.
318 uint64_t NextEltOffset = SL->getElementOffset(Index);
320 if (BytesLeft <= NextEltOffset-CurEltOffset-ByteOffset)
323 // Move to the next element of the struct.
324 CurPtr += NextEltOffset-CurEltOffset-ByteOffset;
325 BytesLeft -= NextEltOffset-CurEltOffset-ByteOffset;
327 CurEltOffset = NextEltOffset;
332 if (isa<ConstantArray>(C) || isa<ConstantVector>(C) ||
333 isa<ConstantDataSequential>(C)) {
334 Type *EltTy = cast<SequentialType>(C->getType())->getElementType();
335 uint64_t EltSize = TD.getTypeAllocSize(EltTy);
336 uint64_t Index = ByteOffset / EltSize;
337 uint64_t Offset = ByteOffset - Index * EltSize;
339 if (ArrayType *AT = dyn_cast<ArrayType>(C->getType()))
340 NumElts = AT->getNumElements();
342 NumElts = cast<VectorType>(C->getType())->getNumElements();
344 for (; Index != NumElts; ++Index) {
345 if (!ReadDataFromGlobal(C->getAggregateElement(Index), Offset, CurPtr,
349 uint64_t BytesWritten = EltSize - Offset;
350 assert(BytesWritten <= EltSize && "Not indexing into this element?");
351 if (BytesWritten >= BytesLeft)
355 BytesLeft -= BytesWritten;
356 CurPtr += BytesWritten;
361 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
362 if (CE->getOpcode() == Instruction::IntToPtr &&
363 CE->getOperand(0)->getType() == TD.getIntPtrType(CE->getContext()))
364 return ReadDataFromGlobal(CE->getOperand(0), ByteOffset, CurPtr,
368 // Otherwise, unknown initializer type.
372 static Constant *FoldReinterpretLoadFromConstPtr(Constant *C,
373 const DataLayout &TD) {
374 Type *LoadTy = cast<PointerType>(C->getType())->getElementType();
375 IntegerType *IntType = dyn_cast<IntegerType>(LoadTy);
377 // If this isn't an integer load we can't fold it directly.
379 // If this is a float/double load, we can try folding it as an int32/64 load
380 // and then bitcast the result. This can be useful for union cases. Note
381 // that address spaces don't matter here since we're not going to result in
382 // an actual new load.
384 if (LoadTy->isFloatTy())
385 MapTy = Type::getInt32PtrTy(C->getContext());
386 else if (LoadTy->isDoubleTy())
387 MapTy = Type::getInt64PtrTy(C->getContext());
388 else if (LoadTy->isVectorTy()) {
389 MapTy = IntegerType::get(C->getContext(),
390 TD.getTypeAllocSizeInBits(LoadTy));
391 MapTy = PointerType::getUnqual(MapTy);
395 C = FoldBitCast(C, MapTy, TD);
396 if (Constant *Res = FoldReinterpretLoadFromConstPtr(C, TD))
397 return FoldBitCast(Res, LoadTy, TD);
401 unsigned BytesLoaded = (IntType->getBitWidth() + 7) / 8;
402 if (BytesLoaded > 32 || BytesLoaded == 0) return 0;
405 APInt Offset(TD.getPointerSizeInBits(), 0);
406 if (!IsConstantOffsetFromGlobal(C, GVal, Offset, TD))
409 GlobalVariable *GV = dyn_cast<GlobalVariable>(GVal);
410 if (!GV || !GV->isConstant() || !GV->hasDefinitiveInitializer() ||
411 !GV->getInitializer()->getType()->isSized())
414 // If we're loading off the beginning of the global, some bytes may be valid,
415 // but we don't try to handle this.
416 if (Offset.isNegative()) return 0;
418 // If we're not accessing anything in this constant, the result is undefined.
419 if (Offset.getZExtValue() >=
420 TD.getTypeAllocSize(GV->getInitializer()->getType()))
421 return UndefValue::get(IntType);
423 unsigned char RawBytes[32] = {0};
424 if (!ReadDataFromGlobal(GV->getInitializer(), Offset.getZExtValue(), RawBytes,
428 APInt ResultVal = APInt(IntType->getBitWidth(), 0);
429 if (TD.isLittleEndian()) {
430 ResultVal = RawBytes[BytesLoaded - 1];
431 for (unsigned i = 1; i != BytesLoaded; ++i) {
433 ResultVal |= RawBytes[BytesLoaded-1-i];
436 ResultVal = RawBytes[0];
437 for (unsigned i = 1; i != BytesLoaded; ++i) {
439 ResultVal |= RawBytes[i];
443 return ConstantInt::get(IntType->getContext(), ResultVal);
446 /// ConstantFoldLoadFromConstPtr - Return the value that a load from C would
447 /// produce if it is constant and determinable. If this is not determinable,
449 Constant *llvm::ConstantFoldLoadFromConstPtr(Constant *C,
450 const DataLayout *TD) {
451 // First, try the easy cases:
452 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(C))
453 if (GV->isConstant() && GV->hasDefinitiveInitializer())
454 return GV->getInitializer();
456 // If the loaded value isn't a constant expr, we can't handle it.
457 ConstantExpr *CE = dyn_cast<ConstantExpr>(C);
460 if (CE->getOpcode() == Instruction::GetElementPtr) {
461 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(CE->getOperand(0)))
462 if (GV->isConstant() && GV->hasDefinitiveInitializer())
464 ConstantFoldLoadThroughGEPConstantExpr(GV->getInitializer(), CE))
468 // Instead of loading constant c string, use corresponding integer value
469 // directly if string length is small enough.
471 if (TD && getConstantStringInfo(CE, Str) && !Str.empty()) {
472 unsigned StrLen = Str.size();
473 Type *Ty = cast<PointerType>(CE->getType())->getElementType();
474 unsigned NumBits = Ty->getPrimitiveSizeInBits();
475 // Replace load with immediate integer if the result is an integer or fp
477 if ((NumBits >> 3) == StrLen + 1 && (NumBits & 7) == 0 &&
478 (isa<IntegerType>(Ty) || Ty->isFloatingPointTy())) {
479 APInt StrVal(NumBits, 0);
480 APInt SingleChar(NumBits, 0);
481 if (TD->isLittleEndian()) {
482 for (signed i = StrLen-1; i >= 0; i--) {
483 SingleChar = (uint64_t) Str[i] & UCHAR_MAX;
484 StrVal = (StrVal << 8) | SingleChar;
487 for (unsigned i = 0; i < StrLen; i++) {
488 SingleChar = (uint64_t) Str[i] & UCHAR_MAX;
489 StrVal = (StrVal << 8) | SingleChar;
491 // Append NULL at the end.
493 StrVal = (StrVal << 8) | SingleChar;
496 Constant *Res = ConstantInt::get(CE->getContext(), StrVal);
497 if (Ty->isFloatingPointTy())
498 Res = ConstantExpr::getBitCast(Res, Ty);
503 // If this load comes from anywhere in a constant global, and if the global
504 // is all undef or zero, we know what it loads.
505 if (GlobalVariable *GV =
506 dyn_cast<GlobalVariable>(GetUnderlyingObject(CE, TD))) {
507 if (GV->isConstant() && GV->hasDefinitiveInitializer()) {
508 Type *ResTy = cast<PointerType>(C->getType())->getElementType();
509 if (GV->getInitializer()->isNullValue())
510 return Constant::getNullValue(ResTy);
511 if (isa<UndefValue>(GV->getInitializer()))
512 return UndefValue::get(ResTy);
516 // Try hard to fold loads from bitcasted strange and non-type-safe things.
518 return FoldReinterpretLoadFromConstPtr(CE, *TD);
522 static Constant *ConstantFoldLoadInst(const LoadInst *LI, const DataLayout *TD){
523 if (LI->isVolatile()) return 0;
525 if (Constant *C = dyn_cast<Constant>(LI->getOperand(0)))
526 return ConstantFoldLoadFromConstPtr(C, TD);
531 /// SymbolicallyEvaluateBinop - One of Op0/Op1 is a constant expression.
532 /// Attempt to symbolically evaluate the result of a binary operator merging
533 /// these together. If target data info is available, it is provided as TD,
534 /// otherwise TD is null.
535 static Constant *SymbolicallyEvaluateBinop(unsigned Opc, Constant *Op0,
536 Constant *Op1, const DataLayout *TD){
539 // Fold (and 0xffffffff00000000, (shl x, 32)) -> shl.
540 // Fold (lshr (or X, Y), 32) -> (lshr [X/Y], 32) if one doesn't contribute
544 // If the constant expr is something like &A[123] - &A[4].f, fold this into a
545 // constant. This happens frequently when iterating over a global array.
546 if (Opc == Instruction::Sub && TD) {
547 GlobalValue *GV1, *GV2;
548 unsigned PtrSize = TD->getPointerSizeInBits();
549 unsigned OpSize = TD->getTypeSizeInBits(Op0->getType());
550 APInt Offs1(PtrSize, 0), Offs2(PtrSize, 0);
552 if (IsConstantOffsetFromGlobal(Op0, GV1, Offs1, *TD))
553 if (IsConstantOffsetFromGlobal(Op1, GV2, Offs2, *TD) &&
555 // (&GV+C1) - (&GV+C2) -> C1-C2, pointer arithmetic cannot overflow.
556 // PtrToInt may change the bitwidth so we have convert to the right size
558 return ConstantInt::get(Op0->getType(), Offs1.zextOrTrunc(OpSize) -
559 Offs2.zextOrTrunc(OpSize));
566 /// CastGEPIndices - If array indices are not pointer-sized integers,
567 /// explicitly cast them so that they aren't implicitly casted by the
569 static Constant *CastGEPIndices(ArrayRef<Constant *> Ops,
570 Type *ResultTy, const DataLayout *TD,
571 const TargetLibraryInfo *TLI) {
573 Type *IntPtrTy = TD->getIntPtrType(ResultTy->getContext());
576 SmallVector<Constant*, 32> NewIdxs;
577 for (unsigned i = 1, e = Ops.size(); i != e; ++i) {
579 !isa<StructType>(GetElementPtrInst::getIndexedType(Ops[0]->getType(),
580 Ops.slice(1, i-1)))) &&
581 Ops[i]->getType() != IntPtrTy) {
583 NewIdxs.push_back(ConstantExpr::getCast(CastInst::getCastOpcode(Ops[i],
589 NewIdxs.push_back(Ops[i]);
594 ConstantExpr::getGetElementPtr(Ops[0], NewIdxs);
595 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
596 if (Constant *Folded = ConstantFoldConstantExpression(CE, TD, TLI))
601 /// Strip the pointer casts, but preserve the address space information.
602 static Constant* StripPtrCastKeepAS(Constant* Ptr) {
603 assert(Ptr->getType()->isPointerTy() && "Not a pointer type");
604 PointerType *OldPtrTy = cast<PointerType>(Ptr->getType());
605 Ptr = cast<Constant>(Ptr->stripPointerCasts());
606 PointerType *NewPtrTy = cast<PointerType>(Ptr->getType());
608 // Preserve the address space number of the pointer.
609 if (NewPtrTy->getAddressSpace() != OldPtrTy->getAddressSpace()) {
610 NewPtrTy = NewPtrTy->getElementType()->getPointerTo(
611 OldPtrTy->getAddressSpace());
612 Ptr = ConstantExpr::getBitCast(Ptr, NewPtrTy);
617 /// SymbolicallyEvaluateGEP - If we can symbolically evaluate the specified GEP
618 /// constant expression, do so.
619 static Constant *SymbolicallyEvaluateGEP(ArrayRef<Constant *> Ops,
620 Type *ResultTy, const DataLayout *TD,
621 const TargetLibraryInfo *TLI) {
622 Constant *Ptr = Ops[0];
623 if (!TD || !cast<PointerType>(Ptr->getType())->getElementType()->isSized() ||
624 !Ptr->getType()->isPointerTy())
627 Type *IntPtrTy = TD->getIntPtrType(Ptr->getContext());
629 // If this is a constant expr gep that is effectively computing an
630 // "offsetof", fold it into 'cast int Size to T*' instead of 'gep 0, 0, 12'
631 for (unsigned i = 1, e = Ops.size(); i != e; ++i)
632 if (!isa<ConstantInt>(Ops[i])) {
634 // If this is "gep i8* Ptr, (sub 0, V)", fold this as:
635 // "inttoptr (sub (ptrtoint Ptr), V)"
636 if (Ops.size() == 2 &&
637 cast<PointerType>(ResultTy)->getElementType()->isIntegerTy(8)) {
638 ConstantExpr *CE = dyn_cast<ConstantExpr>(Ops[1]);
639 assert((CE == 0 || CE->getType() == IntPtrTy) &&
640 "CastGEPIndices didn't canonicalize index types!");
641 if (CE && CE->getOpcode() == Instruction::Sub &&
642 CE->getOperand(0)->isNullValue()) {
643 Constant *Res = ConstantExpr::getPtrToInt(Ptr, CE->getType());
644 Res = ConstantExpr::getSub(Res, CE->getOperand(1));
645 Res = ConstantExpr::getIntToPtr(Res, ResultTy);
646 if (ConstantExpr *ResCE = dyn_cast<ConstantExpr>(Res))
647 Res = ConstantFoldConstantExpression(ResCE, TD, TLI);
654 unsigned BitWidth = TD->getTypeSizeInBits(IntPtrTy);
656 APInt(BitWidth, TD->getIndexedOffset(Ptr->getType(),
657 makeArrayRef((Value *const*)
660 Ptr = StripPtrCastKeepAS(Ptr);
662 // If this is a GEP of a GEP, fold it all into a single GEP.
663 while (GEPOperator *GEP = dyn_cast<GEPOperator>(Ptr)) {
664 SmallVector<Value *, 4> NestedOps(GEP->op_begin()+1, GEP->op_end());
666 // Do not try the incorporate the sub-GEP if some index is not a number.
667 bool AllConstantInt = true;
668 for (unsigned i = 0, e = NestedOps.size(); i != e; ++i)
669 if (!isa<ConstantInt>(NestedOps[i])) {
670 AllConstantInt = false;
676 Ptr = cast<Constant>(GEP->getOperand(0));
677 Offset += APInt(BitWidth,
678 TD->getIndexedOffset(Ptr->getType(), NestedOps));
679 Ptr = StripPtrCastKeepAS(Ptr);
682 // If the base value for this address is a literal integer value, fold the
683 // getelementptr to the resulting integer value casted to the pointer type.
684 APInt BasePtr(BitWidth, 0);
685 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ptr))
686 if (CE->getOpcode() == Instruction::IntToPtr)
687 if (ConstantInt *Base = dyn_cast<ConstantInt>(CE->getOperand(0)))
688 BasePtr = Base->getValue().zextOrTrunc(BitWidth);
689 if (Ptr->isNullValue() || BasePtr != 0) {
690 Constant *C = ConstantInt::get(Ptr->getContext(), Offset+BasePtr);
691 return ConstantExpr::getIntToPtr(C, ResultTy);
694 // Otherwise form a regular getelementptr. Recompute the indices so that
695 // we eliminate over-indexing of the notional static type array bounds.
696 // This makes it easy to determine if the getelementptr is "inbounds".
697 // Also, this helps GlobalOpt do SROA on GlobalVariables.
698 Type *Ty = Ptr->getType();
699 assert(Ty->isPointerTy() && "Forming regular GEP of non-pointer type");
700 SmallVector<Constant*, 32> NewIdxs;
702 if (SequentialType *ATy = dyn_cast<SequentialType>(Ty)) {
703 if (ATy->isPointerTy()) {
704 // The only pointer indexing we'll do is on the first index of the GEP.
705 if (!NewIdxs.empty())
708 // Only handle pointers to sized types, not pointers to functions.
709 if (!ATy->getElementType()->isSized())
713 // Determine which element of the array the offset points into.
714 APInt ElemSize(BitWidth, TD->getTypeAllocSize(ATy->getElementType()));
715 IntegerType *IntPtrTy = TD->getIntPtrType(Ty->getContext());
717 // The element size is 0. This may be [0 x Ty]*, so just use a zero
718 // index for this level and proceed to the next level to see if it can
719 // accommodate the offset.
720 NewIdxs.push_back(ConstantInt::get(IntPtrTy, 0));
722 // The element size is non-zero divide the offset by the element
723 // size (rounding down), to compute the index at this level.
724 APInt NewIdx = Offset.udiv(ElemSize);
725 Offset -= NewIdx * ElemSize;
726 NewIdxs.push_back(ConstantInt::get(IntPtrTy, NewIdx));
728 Ty = ATy->getElementType();
729 } else if (StructType *STy = dyn_cast<StructType>(Ty)) {
730 // If we end up with an offset that isn't valid for this struct type, we
731 // can't re-form this GEP in a regular form, so bail out. The pointer
732 // operand likely went through casts that are necessary to make the GEP
734 const StructLayout &SL = *TD->getStructLayout(STy);
735 if (Offset.uge(SL.getSizeInBytes()))
738 // Determine which field of the struct the offset points into. The
739 // getZExtValue is fine as we've already ensured that the offset is
740 // within the range representable by the StructLayout API.
741 unsigned ElIdx = SL.getElementContainingOffset(Offset.getZExtValue());
742 NewIdxs.push_back(ConstantInt::get(Type::getInt32Ty(Ty->getContext()),
744 Offset -= APInt(BitWidth, SL.getElementOffset(ElIdx));
745 Ty = STy->getTypeAtIndex(ElIdx);
747 // We've reached some non-indexable type.
750 } while (Ty != cast<PointerType>(ResultTy)->getElementType());
752 // If we haven't used up the entire offset by descending the static
753 // type, then the offset is pointing into the middle of an indivisible
754 // member, so we can't simplify it.
760 ConstantExpr::getGetElementPtr(Ptr, NewIdxs);
761 assert(cast<PointerType>(C->getType())->getElementType() == Ty &&
762 "Computed GetElementPtr has unexpected type!");
764 // If we ended up indexing a member with a type that doesn't match
765 // the type of what the original indices indexed, add a cast.
766 if (Ty != cast<PointerType>(ResultTy)->getElementType())
767 C = FoldBitCast(C, ResultTy, *TD);
774 //===----------------------------------------------------------------------===//
775 // Constant Folding public APIs
776 //===----------------------------------------------------------------------===//
778 /// ConstantFoldInstruction - Try to constant fold the specified instruction.
779 /// If successful, the constant result is returned, if not, null is returned.
780 /// Note that this fails if not all of the operands are constant. Otherwise,
781 /// this function can only fail when attempting to fold instructions like loads
782 /// and stores, which have no constant expression form.
783 Constant *llvm::ConstantFoldInstruction(Instruction *I,
784 const DataLayout *TD,
785 const TargetLibraryInfo *TLI) {
786 // Handle PHI nodes quickly here...
787 if (PHINode *PN = dyn_cast<PHINode>(I)) {
788 Constant *CommonValue = 0;
790 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
791 Value *Incoming = PN->getIncomingValue(i);
792 // If the incoming value is undef then skip it. Note that while we could
793 // skip the value if it is equal to the phi node itself we choose not to
794 // because that would break the rule that constant folding only applies if
795 // all operands are constants.
796 if (isa<UndefValue>(Incoming))
798 // If the incoming value is not a constant, then give up.
799 Constant *C = dyn_cast<Constant>(Incoming);
802 // Fold the PHI's operands.
803 if (ConstantExpr *NewC = dyn_cast<ConstantExpr>(C))
804 C = ConstantFoldConstantExpression(NewC, TD, TLI);
805 // If the incoming value is a different constant to
806 // the one we saw previously, then give up.
807 if (CommonValue && C != CommonValue)
813 // If we reach here, all incoming values are the same constant or undef.
814 return CommonValue ? CommonValue : UndefValue::get(PN->getType());
817 // Scan the operand list, checking to see if they are all constants, if so,
818 // hand off to ConstantFoldInstOperands.
819 SmallVector<Constant*, 8> Ops;
820 for (User::op_iterator i = I->op_begin(), e = I->op_end(); i != e; ++i) {
821 Constant *Op = dyn_cast<Constant>(*i);
823 return 0; // All operands not constant!
825 // Fold the Instruction's operands.
826 if (ConstantExpr *NewCE = dyn_cast<ConstantExpr>(Op))
827 Op = ConstantFoldConstantExpression(NewCE, TD, TLI);
832 if (const CmpInst *CI = dyn_cast<CmpInst>(I))
833 return ConstantFoldCompareInstOperands(CI->getPredicate(), Ops[0], Ops[1],
836 if (const LoadInst *LI = dyn_cast<LoadInst>(I))
837 return ConstantFoldLoadInst(LI, TD);
839 if (InsertValueInst *IVI = dyn_cast<InsertValueInst>(I))
840 return ConstantExpr::getInsertValue(
841 cast<Constant>(IVI->getAggregateOperand()),
842 cast<Constant>(IVI->getInsertedValueOperand()),
845 if (ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(I))
846 return ConstantExpr::getExtractValue(
847 cast<Constant>(EVI->getAggregateOperand()),
850 return ConstantFoldInstOperands(I->getOpcode(), I->getType(), Ops, TD, TLI);
853 /// ConstantFoldConstantExpression - Attempt to fold the constant expression
854 /// using the specified DataLayout. If successful, the constant result is
855 /// result is returned, if not, null is returned.
856 Constant *llvm::ConstantFoldConstantExpression(const ConstantExpr *CE,
857 const DataLayout *TD,
858 const TargetLibraryInfo *TLI) {
859 SmallVector<Constant*, 8> Ops;
860 for (User::const_op_iterator i = CE->op_begin(), e = CE->op_end();
862 Constant *NewC = cast<Constant>(*i);
863 // Recursively fold the ConstantExpr's operands.
864 if (ConstantExpr *NewCE = dyn_cast<ConstantExpr>(NewC))
865 NewC = ConstantFoldConstantExpression(NewCE, TD, TLI);
870 return ConstantFoldCompareInstOperands(CE->getPredicate(), Ops[0], Ops[1],
872 return ConstantFoldInstOperands(CE->getOpcode(), CE->getType(), Ops, TD, TLI);
875 /// ConstantFoldInstOperands - Attempt to constant fold an instruction with the
876 /// specified opcode and operands. If successful, the constant result is
877 /// returned, if not, null is returned. Note that this function can fail when
878 /// attempting to fold instructions like loads and stores, which have no
879 /// constant expression form.
881 /// TODO: This function neither utilizes nor preserves nsw/nuw/inbounds/etc
882 /// information, due to only being passed an opcode and operands. Constant
883 /// folding using this function strips this information.
885 Constant *llvm::ConstantFoldInstOperands(unsigned Opcode, Type *DestTy,
886 ArrayRef<Constant *> Ops,
887 const DataLayout *TD,
888 const TargetLibraryInfo *TLI) {
889 // Handle easy binops first.
890 if (Instruction::isBinaryOp(Opcode)) {
891 if (isa<ConstantExpr>(Ops[0]) || isa<ConstantExpr>(Ops[1]))
892 if (Constant *C = SymbolicallyEvaluateBinop(Opcode, Ops[0], Ops[1], TD))
895 return ConstantExpr::get(Opcode, Ops[0], Ops[1]);
900 case Instruction::ICmp:
901 case Instruction::FCmp: llvm_unreachable("Invalid for compares");
902 case Instruction::Call:
903 if (Function *F = dyn_cast<Function>(Ops.back()))
904 if (canConstantFoldCallTo(F))
905 return ConstantFoldCall(F, Ops.slice(0, Ops.size() - 1), TLI);
907 case Instruction::PtrToInt:
908 // If the input is a inttoptr, eliminate the pair. This requires knowing
909 // the width of a pointer, so it can't be done in ConstantExpr::getCast.
910 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ops[0])) {
911 if (TD && CE->getOpcode() == Instruction::IntToPtr) {
912 Constant *Input = CE->getOperand(0);
913 unsigned InWidth = Input->getType()->getScalarSizeInBits();
914 if (TD->getPointerSizeInBits() < InWidth) {
916 ConstantInt::get(CE->getContext(), APInt::getLowBitsSet(InWidth,
917 TD->getPointerSizeInBits()));
918 Input = ConstantExpr::getAnd(Input, Mask);
920 // Do a zext or trunc to get to the dest size.
921 return ConstantExpr::getIntegerCast(Input, DestTy, false);
924 return ConstantExpr::getCast(Opcode, Ops[0], DestTy);
925 case Instruction::IntToPtr:
926 // If the input is a ptrtoint, turn the pair into a ptr to ptr bitcast if
927 // the int size is >= the ptr size. This requires knowing the width of a
928 // pointer, so it can't be done in ConstantExpr::getCast.
929 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ops[0]))
931 TD->getPointerSizeInBits() <= CE->getType()->getScalarSizeInBits() &&
932 CE->getOpcode() == Instruction::PtrToInt)
933 return FoldBitCast(CE->getOperand(0), DestTy, *TD);
935 return ConstantExpr::getCast(Opcode, Ops[0], DestTy);
936 case Instruction::Trunc:
937 case Instruction::ZExt:
938 case Instruction::SExt:
939 case Instruction::FPTrunc:
940 case Instruction::FPExt:
941 case Instruction::UIToFP:
942 case Instruction::SIToFP:
943 case Instruction::FPToUI:
944 case Instruction::FPToSI:
945 return ConstantExpr::getCast(Opcode, Ops[0], DestTy);
946 case Instruction::BitCast:
948 return FoldBitCast(Ops[0], DestTy, *TD);
949 return ConstantExpr::getBitCast(Ops[0], DestTy);
950 case Instruction::Select:
951 return ConstantExpr::getSelect(Ops[0], Ops[1], Ops[2]);
952 case Instruction::ExtractElement:
953 return ConstantExpr::getExtractElement(Ops[0], Ops[1]);
954 case Instruction::InsertElement:
955 return ConstantExpr::getInsertElement(Ops[0], Ops[1], Ops[2]);
956 case Instruction::ShuffleVector:
957 return ConstantExpr::getShuffleVector(Ops[0], Ops[1], Ops[2]);
958 case Instruction::GetElementPtr:
959 if (Constant *C = CastGEPIndices(Ops, DestTy, TD, TLI))
961 if (Constant *C = SymbolicallyEvaluateGEP(Ops, DestTy, TD, TLI))
964 return ConstantExpr::getGetElementPtr(Ops[0], Ops.slice(1));
968 /// ConstantFoldCompareInstOperands - Attempt to constant fold a compare
969 /// instruction (icmp/fcmp) with the specified operands. If it fails, it
970 /// returns a constant expression of the specified operands.
972 Constant *llvm::ConstantFoldCompareInstOperands(unsigned Predicate,
973 Constant *Ops0, Constant *Ops1,
974 const DataLayout *TD,
975 const TargetLibraryInfo *TLI) {
976 // fold: icmp (inttoptr x), null -> icmp x, 0
977 // fold: icmp (ptrtoint x), 0 -> icmp x, null
978 // fold: icmp (inttoptr x), (inttoptr y) -> icmp trunc/zext x, trunc/zext y
979 // fold: icmp (ptrtoint x), (ptrtoint y) -> icmp x, y
981 // ConstantExpr::getCompare cannot do this, because it doesn't have TD
982 // around to know if bit truncation is happening.
983 if (ConstantExpr *CE0 = dyn_cast<ConstantExpr>(Ops0)) {
984 if (TD && Ops1->isNullValue()) {
985 Type *IntPtrTy = TD->getIntPtrType(CE0->getContext());
986 if (CE0->getOpcode() == Instruction::IntToPtr) {
987 // Convert the integer value to the right size to ensure we get the
988 // proper extension or truncation.
989 Constant *C = ConstantExpr::getIntegerCast(CE0->getOperand(0),
991 Constant *Null = Constant::getNullValue(C->getType());
992 return ConstantFoldCompareInstOperands(Predicate, C, Null, TD, TLI);
995 // Only do this transformation if the int is intptrty in size, otherwise
996 // there is a truncation or extension that we aren't modeling.
997 if (CE0->getOpcode() == Instruction::PtrToInt &&
998 CE0->getType() == IntPtrTy) {
999 Constant *C = CE0->getOperand(0);
1000 Constant *Null = Constant::getNullValue(C->getType());
1001 return ConstantFoldCompareInstOperands(Predicate, C, Null, TD, TLI);
1005 if (ConstantExpr *CE1 = dyn_cast<ConstantExpr>(Ops1)) {
1006 if (TD && CE0->getOpcode() == CE1->getOpcode()) {
1007 Type *IntPtrTy = TD->getIntPtrType(CE0->getContext());
1009 if (CE0->getOpcode() == Instruction::IntToPtr) {
1010 // Convert the integer value to the right size to ensure we get the
1011 // proper extension or truncation.
1012 Constant *C0 = ConstantExpr::getIntegerCast(CE0->getOperand(0),
1014 Constant *C1 = ConstantExpr::getIntegerCast(CE1->getOperand(0),
1016 return ConstantFoldCompareInstOperands(Predicate, C0, C1, TD, TLI);
1019 // Only do this transformation if the int is intptrty in size, otherwise
1020 // there is a truncation or extension that we aren't modeling.
1021 if ((CE0->getOpcode() == Instruction::PtrToInt &&
1022 CE0->getType() == IntPtrTy &&
1023 CE0->getOperand(0)->getType() == CE1->getOperand(0)->getType()))
1024 return ConstantFoldCompareInstOperands(Predicate, CE0->getOperand(0),
1025 CE1->getOperand(0), TD, TLI);
1029 // icmp eq (or x, y), 0 -> (icmp eq x, 0) & (icmp eq y, 0)
1030 // icmp ne (or x, y), 0 -> (icmp ne x, 0) | (icmp ne y, 0)
1031 if ((Predicate == ICmpInst::ICMP_EQ || Predicate == ICmpInst::ICMP_NE) &&
1032 CE0->getOpcode() == Instruction::Or && Ops1->isNullValue()) {
1034 ConstantFoldCompareInstOperands(Predicate, CE0->getOperand(0), Ops1,
1037 ConstantFoldCompareInstOperands(Predicate, CE0->getOperand(1), Ops1,
1040 Predicate == ICmpInst::ICMP_EQ ? Instruction::And : Instruction::Or;
1041 Constant *Ops[] = { LHS, RHS };
1042 return ConstantFoldInstOperands(OpC, LHS->getType(), Ops, TD, TLI);
1046 return ConstantExpr::getCompare(Predicate, Ops0, Ops1);
1050 /// ConstantFoldLoadThroughGEPConstantExpr - Given a constant and a
1051 /// getelementptr constantexpr, return the constant value being addressed by the
1052 /// constant expression, or null if something is funny and we can't decide.
1053 Constant *llvm::ConstantFoldLoadThroughGEPConstantExpr(Constant *C,
1055 if (!CE->getOperand(1)->isNullValue())
1056 return 0; // Do not allow stepping over the value!
1058 // Loop over all of the operands, tracking down which value we are
1060 for (unsigned i = 2, e = CE->getNumOperands(); i != e; ++i) {
1061 C = C->getAggregateElement(CE->getOperand(i));
1062 if (C == 0) return 0;
1067 /// ConstantFoldLoadThroughGEPIndices - Given a constant and getelementptr
1068 /// indices (with an *implied* zero pointer index that is not in the list),
1069 /// return the constant value being addressed by a virtual load, or null if
1070 /// something is funny and we can't decide.
1071 Constant *llvm::ConstantFoldLoadThroughGEPIndices(Constant *C,
1072 ArrayRef<Constant*> Indices) {
1073 // Loop over all of the operands, tracking down which value we are
1075 for (unsigned i = 0, e = Indices.size(); i != e; ++i) {
1076 C = C->getAggregateElement(Indices[i]);
1077 if (C == 0) return 0;
1083 //===----------------------------------------------------------------------===//
1084 // Constant Folding for Calls
1087 /// canConstantFoldCallTo - Return true if its even possible to fold a call to
1088 /// the specified function.
1090 llvm::canConstantFoldCallTo(const Function *F) {
1091 switch (F->getIntrinsicID()) {
1092 case Intrinsic::sqrt:
1093 case Intrinsic::pow:
1094 case Intrinsic::powi:
1095 case Intrinsic::bswap:
1096 case Intrinsic::ctpop:
1097 case Intrinsic::ctlz:
1098 case Intrinsic::cttz:
1099 case Intrinsic::sadd_with_overflow:
1100 case Intrinsic::uadd_with_overflow:
1101 case Intrinsic::ssub_with_overflow:
1102 case Intrinsic::usub_with_overflow:
1103 case Intrinsic::smul_with_overflow:
1104 case Intrinsic::umul_with_overflow:
1105 case Intrinsic::convert_from_fp16:
1106 case Intrinsic::convert_to_fp16:
1107 case Intrinsic::x86_sse_cvtss2si:
1108 case Intrinsic::x86_sse_cvtss2si64:
1109 case Intrinsic::x86_sse_cvttss2si:
1110 case Intrinsic::x86_sse_cvttss2si64:
1111 case Intrinsic::x86_sse2_cvtsd2si:
1112 case Intrinsic::x86_sse2_cvtsd2si64:
1113 case Intrinsic::x86_sse2_cvttsd2si:
1114 case Intrinsic::x86_sse2_cvttsd2si64:
1121 if (!F->hasName()) return false;
1122 StringRef Name = F->getName();
1124 // In these cases, the check of the length is required. We don't want to
1125 // return true for a name like "cos\0blah" which strcmp would return equal to
1126 // "cos", but has length 8.
1128 default: return false;
1130 return Name == "acos" || Name == "asin" ||
1131 Name == "atan" || Name == "atan2";
1133 return Name == "cos" || Name == "ceil" || Name == "cosf" || Name == "cosh";
1135 return Name == "exp" || Name == "exp2";
1137 return Name == "fabs" || Name == "fmod" || Name == "floor";
1139 return Name == "log" || Name == "log10";
1141 return Name == "pow";
1143 return Name == "sin" || Name == "sinh" || Name == "sqrt" ||
1144 Name == "sinf" || Name == "sqrtf";
1146 return Name == "tan" || Name == "tanh";
1150 static Constant *ConstantFoldFP(double (*NativeFP)(double), double V,
1152 sys::llvm_fenv_clearexcept();
1154 if (sys::llvm_fenv_testexcept()) {
1155 sys::llvm_fenv_clearexcept();
1159 if (Ty->isFloatTy())
1160 return ConstantFP::get(Ty->getContext(), APFloat((float)V));
1161 if (Ty->isDoubleTy())
1162 return ConstantFP::get(Ty->getContext(), APFloat(V));
1163 llvm_unreachable("Can only constant fold float/double");
1166 static Constant *ConstantFoldBinaryFP(double (*NativeFP)(double, double),
1167 double V, double W, Type *Ty) {
1168 sys::llvm_fenv_clearexcept();
1170 if (sys::llvm_fenv_testexcept()) {
1171 sys::llvm_fenv_clearexcept();
1175 if (Ty->isFloatTy())
1176 return ConstantFP::get(Ty->getContext(), APFloat((float)V));
1177 if (Ty->isDoubleTy())
1178 return ConstantFP::get(Ty->getContext(), APFloat(V));
1179 llvm_unreachable("Can only constant fold float/double");
1182 /// ConstantFoldConvertToInt - Attempt to an SSE floating point to integer
1183 /// conversion of a constant floating point. If roundTowardZero is false, the
1184 /// default IEEE rounding is used (toward nearest, ties to even). This matches
1185 /// the behavior of the non-truncating SSE instructions in the default rounding
1186 /// mode. The desired integer type Ty is used to select how many bits are
1187 /// available for the result. Returns null if the conversion cannot be
1188 /// performed, otherwise returns the Constant value resulting from the
1190 static Constant *ConstantFoldConvertToInt(const APFloat &Val,
1191 bool roundTowardZero, Type *Ty) {
1192 // All of these conversion intrinsics form an integer of at most 64bits.
1193 unsigned ResultWidth = cast<IntegerType>(Ty)->getBitWidth();
1194 assert(ResultWidth <= 64 &&
1195 "Can only constant fold conversions to 64 and 32 bit ints");
1198 bool isExact = false;
1199 APFloat::roundingMode mode = roundTowardZero? APFloat::rmTowardZero
1200 : APFloat::rmNearestTiesToEven;
1201 APFloat::opStatus status = Val.convertToInteger(&UIntVal, ResultWidth,
1202 /*isSigned=*/true, mode,
1204 if (status != APFloat::opOK && status != APFloat::opInexact)
1206 return ConstantInt::get(Ty, UIntVal, /*isSigned=*/true);
1209 /// ConstantFoldCall - Attempt to constant fold a call to the specified function
1210 /// with the specified arguments, returning null if unsuccessful.
1212 llvm::ConstantFoldCall(Function *F, ArrayRef<Constant *> Operands,
1213 const TargetLibraryInfo *TLI) {
1214 if (!F->hasName()) return 0;
1215 StringRef Name = F->getName();
1217 Type *Ty = F->getReturnType();
1218 if (Operands.size() == 1) {
1219 if (ConstantFP *Op = dyn_cast<ConstantFP>(Operands[0])) {
1220 if (F->getIntrinsicID() == Intrinsic::convert_to_fp16) {
1221 APFloat Val(Op->getValueAPF());
1224 Val.convert(APFloat::IEEEhalf, APFloat::rmNearestTiesToEven, &lost);
1226 return ConstantInt::get(F->getContext(), Val.bitcastToAPInt());
1231 if (!Ty->isFloatTy() && !Ty->isDoubleTy())
1234 /// We only fold functions with finite arguments. Folding NaN and inf is
1235 /// likely to be aborted with an exception anyway, and some host libms
1236 /// have known errors raising exceptions.
1237 if (Op->getValueAPF().isNaN() || Op->getValueAPF().isInfinity())
1240 /// Currently APFloat versions of these functions do not exist, so we use
1241 /// the host native double versions. Float versions are not called
1242 /// directly but for all these it is true (float)(f((double)arg)) ==
1243 /// f(arg). Long double not supported yet.
1244 double V = Ty->isFloatTy() ? (double)Op->getValueAPF().convertToFloat() :
1245 Op->getValueAPF().convertToDouble();
1248 if (Name == "acos" && TLI->has(LibFunc::acos))
1249 return ConstantFoldFP(acos, V, Ty);
1250 else if (Name == "asin" && TLI->has(LibFunc::asin))
1251 return ConstantFoldFP(asin, V, Ty);
1252 else if (Name == "atan" && TLI->has(LibFunc::atan))
1253 return ConstantFoldFP(atan, V, Ty);
1256 if (Name == "ceil" && TLI->has(LibFunc::ceil))
1257 return ConstantFoldFP(ceil, V, Ty);
1258 else if (Name == "cos" && TLI->has(LibFunc::cos))
1259 return ConstantFoldFP(cos, V, Ty);
1260 else if (Name == "cosh" && TLI->has(LibFunc::cosh))
1261 return ConstantFoldFP(cosh, V, Ty);
1262 else if (Name == "cosf" && TLI->has(LibFunc::cosf))
1263 return ConstantFoldFP(cos, V, Ty);
1266 if (Name == "exp" && TLI->has(LibFunc::exp))
1267 return ConstantFoldFP(exp, V, Ty);
1269 if (Name == "exp2" && TLI->has(LibFunc::exp2)) {
1270 // Constant fold exp2(x) as pow(2,x) in case the host doesn't have a
1272 return ConstantFoldBinaryFP(pow, 2.0, V, Ty);
1276 if (Name == "fabs" && TLI->has(LibFunc::fabs))
1277 return ConstantFoldFP(fabs, V, Ty);
1278 else if (Name == "floor" && TLI->has(LibFunc::floor))
1279 return ConstantFoldFP(floor, V, Ty);
1282 if (Name == "log" && V > 0 && TLI->has(LibFunc::log))
1283 return ConstantFoldFP(log, V, Ty);
1284 else if (Name == "log10" && V > 0 && TLI->has(LibFunc::log10))
1285 return ConstantFoldFP(log10, V, Ty);
1286 else if (F->getIntrinsicID() == Intrinsic::sqrt &&
1287 (Ty->isFloatTy() || Ty->isDoubleTy())) {
1289 return ConstantFoldFP(sqrt, V, Ty);
1291 return Constant::getNullValue(Ty);
1295 if (Name == "sin" && TLI->has(LibFunc::sin))
1296 return ConstantFoldFP(sin, V, Ty);
1297 else if (Name == "sinh" && TLI->has(LibFunc::sinh))
1298 return ConstantFoldFP(sinh, V, Ty);
1299 else if (Name == "sqrt" && V >= 0 && TLI->has(LibFunc::sqrt))
1300 return ConstantFoldFP(sqrt, V, Ty);
1301 else if (Name == "sqrtf" && V >= 0 && TLI->has(LibFunc::sqrtf))
1302 return ConstantFoldFP(sqrt, V, Ty);
1303 else if (Name == "sinf" && TLI->has(LibFunc::sinf))
1304 return ConstantFoldFP(sin, V, Ty);
1307 if (Name == "tan" && TLI->has(LibFunc::tan))
1308 return ConstantFoldFP(tan, V, Ty);
1309 else if (Name == "tanh" && TLI->has(LibFunc::tanh))
1310 return ConstantFoldFP(tanh, V, Ty);
1318 if (ConstantInt *Op = dyn_cast<ConstantInt>(Operands[0])) {
1319 switch (F->getIntrinsicID()) {
1320 case Intrinsic::bswap:
1321 return ConstantInt::get(F->getContext(), Op->getValue().byteSwap());
1322 case Intrinsic::ctpop:
1323 return ConstantInt::get(Ty, Op->getValue().countPopulation());
1324 case Intrinsic::convert_from_fp16: {
1325 APFloat Val(APFloat::IEEEhalf, Op->getValue());
1328 APFloat::opStatus status =
1329 Val.convert(APFloat::IEEEsingle, APFloat::rmNearestTiesToEven, &lost);
1331 // Conversion is always precise.
1333 assert(status == APFloat::opOK && !lost &&
1334 "Precision lost during fp16 constfolding");
1336 return ConstantFP::get(F->getContext(), Val);
1343 // Support ConstantVector in case we have an Undef in the top.
1344 if (isa<ConstantVector>(Operands[0]) ||
1345 isa<ConstantDataVector>(Operands[0])) {
1346 Constant *Op = cast<Constant>(Operands[0]);
1347 switch (F->getIntrinsicID()) {
1349 case Intrinsic::x86_sse_cvtss2si:
1350 case Intrinsic::x86_sse_cvtss2si64:
1351 case Intrinsic::x86_sse2_cvtsd2si:
1352 case Intrinsic::x86_sse2_cvtsd2si64:
1353 if (ConstantFP *FPOp =
1354 dyn_cast_or_null<ConstantFP>(Op->getAggregateElement(0U)))
1355 return ConstantFoldConvertToInt(FPOp->getValueAPF(),
1356 /*roundTowardZero=*/false, Ty);
1357 case Intrinsic::x86_sse_cvttss2si:
1358 case Intrinsic::x86_sse_cvttss2si64:
1359 case Intrinsic::x86_sse2_cvttsd2si:
1360 case Intrinsic::x86_sse2_cvttsd2si64:
1361 if (ConstantFP *FPOp =
1362 dyn_cast_or_null<ConstantFP>(Op->getAggregateElement(0U)))
1363 return ConstantFoldConvertToInt(FPOp->getValueAPF(),
1364 /*roundTowardZero=*/true, Ty);
1368 if (isa<UndefValue>(Operands[0])) {
1369 if (F->getIntrinsicID() == Intrinsic::bswap)
1377 if (Operands.size() == 2) {
1378 if (ConstantFP *Op1 = dyn_cast<ConstantFP>(Operands[0])) {
1379 if (!Ty->isFloatTy() && !Ty->isDoubleTy())
1381 double Op1V = Ty->isFloatTy() ?
1382 (double)Op1->getValueAPF().convertToFloat() :
1383 Op1->getValueAPF().convertToDouble();
1384 if (ConstantFP *Op2 = dyn_cast<ConstantFP>(Operands[1])) {
1385 if (Op2->getType() != Op1->getType())
1388 double Op2V = Ty->isFloatTy() ?
1389 (double)Op2->getValueAPF().convertToFloat():
1390 Op2->getValueAPF().convertToDouble();
1392 if (F->getIntrinsicID() == Intrinsic::pow) {
1393 return ConstantFoldBinaryFP(pow, Op1V, Op2V, Ty);
1397 if (Name == "pow" && TLI->has(LibFunc::pow))
1398 return ConstantFoldBinaryFP(pow, Op1V, Op2V, Ty);
1399 if (Name == "fmod" && TLI->has(LibFunc::fmod))
1400 return ConstantFoldBinaryFP(fmod, Op1V, Op2V, Ty);
1401 if (Name == "atan2" && TLI->has(LibFunc::atan2))
1402 return ConstantFoldBinaryFP(atan2, Op1V, Op2V, Ty);
1403 } else if (ConstantInt *Op2C = dyn_cast<ConstantInt>(Operands[1])) {
1404 if (F->getIntrinsicID() == Intrinsic::powi && Ty->isFloatTy())
1405 return ConstantFP::get(F->getContext(),
1406 APFloat((float)std::pow((float)Op1V,
1407 (int)Op2C->getZExtValue())));
1408 if (F->getIntrinsicID() == Intrinsic::powi && Ty->isDoubleTy())
1409 return ConstantFP::get(F->getContext(),
1410 APFloat((double)std::pow((double)Op1V,
1411 (int)Op2C->getZExtValue())));
1416 if (ConstantInt *Op1 = dyn_cast<ConstantInt>(Operands[0])) {
1417 if (ConstantInt *Op2 = dyn_cast<ConstantInt>(Operands[1])) {
1418 switch (F->getIntrinsicID()) {
1420 case Intrinsic::sadd_with_overflow:
1421 case Intrinsic::uadd_with_overflow:
1422 case Intrinsic::ssub_with_overflow:
1423 case Intrinsic::usub_with_overflow:
1424 case Intrinsic::smul_with_overflow:
1425 case Intrinsic::umul_with_overflow: {
1428 switch (F->getIntrinsicID()) {
1429 default: llvm_unreachable("Invalid case");
1430 case Intrinsic::sadd_with_overflow:
1431 Res = Op1->getValue().sadd_ov(Op2->getValue(), Overflow);
1433 case Intrinsic::uadd_with_overflow:
1434 Res = Op1->getValue().uadd_ov(Op2->getValue(), Overflow);
1436 case Intrinsic::ssub_with_overflow:
1437 Res = Op1->getValue().ssub_ov(Op2->getValue(), Overflow);
1439 case Intrinsic::usub_with_overflow:
1440 Res = Op1->getValue().usub_ov(Op2->getValue(), Overflow);
1442 case Intrinsic::smul_with_overflow:
1443 Res = Op1->getValue().smul_ov(Op2->getValue(), Overflow);
1445 case Intrinsic::umul_with_overflow:
1446 Res = Op1->getValue().umul_ov(Op2->getValue(), Overflow);
1450 ConstantInt::get(F->getContext(), Res),
1451 ConstantInt::get(Type::getInt1Ty(F->getContext()), Overflow)
1453 return ConstantStruct::get(cast<StructType>(F->getReturnType()), Ops);
1455 case Intrinsic::cttz:
1456 if (Op2->isOne() && Op1->isZero()) // cttz(0, 1) is undef.
1457 return UndefValue::get(Ty);
1458 return ConstantInt::get(Ty, Op1->getValue().countTrailingZeros());
1459 case Intrinsic::ctlz:
1460 if (Op2->isOne() && Op1->isZero()) // ctlz(0, 1) is undef.
1461 return UndefValue::get(Ty);
1462 return ConstantInt::get(Ty, Op1->getValue().countLeadingZeros());