lib/Analysis/ConstantFolding.cpp

   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/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"
  36 #include <cerrno>
  37 #include <cmath>
  38 using namespace llvm;
  39
  40 //===----------------------------------------------------------------------===//
  41 // Constant Folding internal helper functions
  42 //===----------------------------------------------------------------------===//
  43
  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);
  54
  55   // Handle a vector->integer cast.
  56   if (IntegerType *IT = dyn_cast<IntegerType>(DestTy)) {
  57     ConstantDataVector *CDV = dyn_cast<ConstantDataVector>(C);
  58     if (CDV == 0)
  59       return ConstantExpr::getBitCast(C, DestTy);
  60
  61     unsigned NumSrcElts = CDV->getType()->getNumElements();
  62
  63     Type *SrcEltTy = CDV->getType()->getElementType();
  64
  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();
  69       Type *SrcIVTy =
  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);
  74     }
  75
  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) {
  81       Result <<= BitShift;
  82       if (TD.isLittleEndian())
  83         Result |= CDV->getElementAsInteger(NumSrcElts-i-1);
  84       else
  85         Result |= CDV->getElementAsInteger(i);
  86     }
  87
  88     return ConstantInt::get(IT, Result);
  89   }
  90
  91   // The code below only handles casts to vectors currently.
  92   VectorType *DestVTy = dyn_cast<VectorType>(DestTy);
  93   if (DestVTy == 0)
  94     return ConstantExpr::getBitCast(C, DestTy);
  95
  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);
 101   }
 102
 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);
 106
 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);
 112
 113   Type *SrcEltTy = C->getType()->getVectorElementType();
 114   Type *DstEltTy = DestVTy->getElementType();
 115
 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>
 123
 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();
 129     Type *DestIVTy =
 130       VectorType::get(IntegerType::get(C->getContext(), FPWidth), NumDstElt);
 131     // Recursively handle this integer conversion, if possible.
 132     C = FoldBitCast(C, DestIVTy, TD);
 133
 134     // Finally, IR can handle this now that #elts line up.
 135     return ConstantExpr::getBitCast(C, DestTy);
 136   }
 137
 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();
 142     Type *SrcIVTy =
 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))
 149       return C;
 150   }
 151
 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
 155   // more elements.
 156   bool isLittleEndian = TD.isLittleEndian();
 157
 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();
 164     unsigned SrcElt = 0;
 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);
 173
 174         // Zero extend the element to the right size.
 175         Src = ConstantExpr::getZExt(Src, Elt->getType());
 176
 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;
 181
 182         // Mix it in.
 183         Elt = ConstantExpr::getOr(Elt, Src);
 184       }
 185       Result.push_back(Elt);
 186     }
 187     return ConstantVector::get(Result);
 188   }
 189
 190   // Handle: bitcast (<2 x i64> <i64 0, i64 1> to <4 x i32>)
 191   unsigned Ratio = NumDstElt/NumSrcElt;
 192   unsigned DstBitSize = DstEltTy->getPrimitiveSizeInBits();
 193
 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);
 199
 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
 203       // endianness.
 204       Constant *Elt = ConstantExpr::getLShr(Src,
 205                                   ConstantInt::get(Src->getType(), ShiftAmt));
 206       ShiftAmt += isLittleEndian ? DstBitSize : -DstBitSize;
 207
 208       // Truncate and remember this piece.
 209       Result.push_back(ConstantExpr::getTrunc(Elt, DstEltTy));
 210     }
 211   }
 212
 213   return ConstantVector::get(Result);
 214 }
 215
 216
 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                                        int64_t &Offset, const DataLayout &TD) {
 222   // Trivial case, constant is the global.
 223   if ((GV = dyn_cast<GlobalValue>(C))) {
 224     Offset = 0;
 225     return true;
 226   }
 227
 228   // Otherwise, if this isn't a constant expr, bail out.
 229   ConstantExpr *CE = dyn_cast<ConstantExpr>(C);
 230   if (!CE) return false;
 231
 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);
 236
 237   // i32* getelementptr ([5 x i32]* @a, i32 0, i32 5)
 238   if (CE->getOpcode() == Instruction::GetElementPtr) {
 239     // Cannot compute this if the element type of the pointer is missing size
 240     // info.
 241     if (!cast<PointerType>(CE->getOperand(0)->getType())
 242                  ->getElementType()->isSized())
 243       return false;
 244
 245     // If the base isn't a global+constant, we aren't either.
 246     if (!IsConstantOffsetFromGlobal(CE->getOperand(0), GV, Offset, TD))
 247       return false;
 248
 249     // Otherwise, add any offset that our operands provide.
 250     gep_type_iterator GTI = gep_type_begin(CE);
 251     for (User::const_op_iterator i = CE->op_begin() + 1, e = CE->op_end();
 252          i != e; ++i, ++GTI) {
 253       ConstantInt *CI = dyn_cast<ConstantInt>(*i);
 254       if (!CI) return false;  // Index isn't a simple constant?
 255       if (CI->isZero()) continue;  // Not adding anything.
 256
 257       // Evaluate offsets in the index type.
 258       APInt APOffset(CI->getBitWidth(), Offset);
 259
 260       if (StructType *ST = dyn_cast<StructType>(*GTI)) {
 261         // N = N + Offset
 262         APOffset +=
 263           APInt(CI->getBitWidth(),
 264                 TD.getStructLayout(ST)->getElementOffset(CI->getZExtValue()));
 265       } else {
 266         SequentialType *SQT = cast<SequentialType>(*GTI);
 267         APOffset +=
 268           APInt(CI->getBitWidth(),
 269                 TD.getTypeAllocSize(SQT->getElementType())*CI->getSExtValue());
 270       }
 271
 272       Offset = APOffset.getSExtValue();
 273     }
 274     return true;
 275   }
 276
 277   return false;
 278 }
 279
 280 /// ReadDataFromGlobal - Recursive helper to read bits out of global.  C is the
 281 /// constant being copied out of. ByteOffset is an offset into C.  CurPtr is the
 282 /// pointer to copy results into and BytesLeft is the number of bytes left in
 283 /// the CurPtr buffer.  TD is the target data.
 284 static bool ReadDataFromGlobal(Constant *C, uint64_t ByteOffset,
 285                                unsigned char *CurPtr, unsigned BytesLeft,
 286                                const DataLayout &TD) {
 287   assert(ByteOffset <= TD.getTypeAllocSize(C->getType()) &&
 288          "Out of range access");
 289
 290   // If this element is zero or undefined, we can just return since *CurPtr is
 291   // zero initialized.
 292   if (isa<ConstantAggregateZero>(C) || isa<UndefValue>(C))
 293     return true;
 294
 295   if (ConstantInt *CI = dyn_cast<ConstantInt>(C)) {
 296     if (CI->getBitWidth() > 64 ||
 297         (CI->getBitWidth() & 7) != 0)
 298       return false;
 299
 300     uint64_t Val = CI->getZExtValue();
 301     unsigned IntBytes = unsigned(CI->getBitWidth()/8);
 302
 303     for (unsigned i = 0; i != BytesLeft && ByteOffset != IntBytes; ++i) {
 304       int n = ByteOffset;
 305       if (!TD.isLittleEndian())
 306         n = IntBytes - n - 1;
 307       CurPtr[i] = (unsigned char)(Val >> (n * 8));
 308       ++ByteOffset;
 309     }
 310     return true;
 311   }
 312
 313   if (ConstantFP *CFP = dyn_cast<ConstantFP>(C)) {
 314     if (CFP->getType()->isDoubleTy()) {
 315       C = FoldBitCast(C, Type::getInt64Ty(C->getContext()), TD);
 316       return ReadDataFromGlobal(C, ByteOffset, CurPtr, BytesLeft, TD);
 317     }
 318     if (CFP->getType()->isFloatTy()){
 319       C = FoldBitCast(C, Type::getInt32Ty(C->getContext()), TD);
 320       return ReadDataFromGlobal(C, ByteOffset, CurPtr, BytesLeft, TD);
 321     }
 322     return false;
 323   }
 324
 325   if (ConstantStruct *CS = dyn_cast<ConstantStruct>(C)) {
 326     const StructLayout *SL = TD.getStructLayout(CS->getType());
 327     unsigned Index = SL->getElementContainingOffset(ByteOffset);
 328     uint64_t CurEltOffset = SL->getElementOffset(Index);
 329     ByteOffset -= CurEltOffset;
 330
 331     while (1) {
 332       // If the element access is to the element itself and not to tail padding,
 333       // read the bytes from the element.
 334       uint64_t EltSize = TD.getTypeAllocSize(CS->getOperand(Index)->getType());
 335
 336       if (ByteOffset < EltSize &&
 337           !ReadDataFromGlobal(CS->getOperand(Index), ByteOffset, CurPtr,
 338                               BytesLeft, TD))
 339         return false;
 340
 341       ++Index;
 342
 343       // Check to see if we read from the last struct element, if so we're done.
 344       if (Index == CS->getType()->getNumElements())
 345         return true;
 346
 347       // If we read all of the bytes we needed from this element we're done.
 348       uint64_t NextEltOffset = SL->getElementOffset(Index);
 349
 350       if (BytesLeft <= NextEltOffset-CurEltOffset-ByteOffset)
 351         return true;
 352
 353       // Move to the next element of the struct.
 354       CurPtr += NextEltOffset-CurEltOffset-ByteOffset;
 355       BytesLeft -= NextEltOffset-CurEltOffset-ByteOffset;
 356       ByteOffset = 0;
 357       CurEltOffset = NextEltOffset;
 358     }
 359     // not reached.
 360   }
 361
 362   if (isa<ConstantArray>(C) || isa<ConstantVector>(C) ||
 363       isa<ConstantDataSequential>(C)) {
 364     Type *EltTy = cast<SequentialType>(C->getType())->getElementType();
 365     uint64_t EltSize = TD.getTypeAllocSize(EltTy);
 366     uint64_t Index = ByteOffset / EltSize;
 367     uint64_t Offset = ByteOffset - Index * EltSize;
 368     uint64_t NumElts;
 369     if (ArrayType *AT = dyn_cast<ArrayType>(C->getType()))
 370       NumElts = AT->getNumElements();
 371     else
 372       NumElts = cast<VectorType>(C->getType())->getNumElements();
 373
 374     for (; Index != NumElts; ++Index) {
 375       if (!ReadDataFromGlobal(C->getAggregateElement(Index), Offset, CurPtr,
 376                               BytesLeft, TD))
 377         return false;
 378
 379       uint64_t BytesWritten = EltSize - Offset;
 380       assert(BytesWritten <= EltSize && "Not indexing into this element?");
 381       if (BytesWritten >= BytesLeft)
 382         return true;
 383
 384       Offset = 0;
 385       BytesLeft -= BytesWritten;
 386       CurPtr += BytesWritten;
 387     }
 388     return true;
 389   }
 390
 391   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
 392     if (CE->getOpcode() == Instruction::IntToPtr &&
 393         CE->getOperand(0)->getType() == TD.getIntPtrType(CE->getContext()))
 394       return ReadDataFromGlobal(CE->getOperand(0), ByteOffset, CurPtr,
 395                                 BytesLeft, TD);
 396   }
 397
 398   // Otherwise, unknown initializer type.
 399   return false;
 400 }
 401
 402 static Constant *FoldReinterpretLoadFromConstPtr(Constant *C,
 403                                                  const DataLayout &TD) {
 404   Type *LoadTy = cast<PointerType>(C->getType())->getElementType();
 405   IntegerType *IntType = dyn_cast<IntegerType>(LoadTy);
 406
 407   // If this isn't an integer load we can't fold it directly.
 408   if (!IntType) {
 409     // If this is a float/double load, we can try folding it as an int32/64 load
 410     // and then bitcast the result.  This can be useful for union cases.  Note
 411     // that address spaces don't matter here since we're not going to result in
 412     // an actual new load.
 413     Type *MapTy;
 414     if (LoadTy->isFloatTy())
 415       MapTy = Type::getInt32PtrTy(C->getContext());
 416     else if (LoadTy->isDoubleTy())
 417       MapTy = Type::getInt64PtrTy(C->getContext());
 418     else if (LoadTy->isVectorTy()) {
 419       MapTy = IntegerType::get(C->getContext(),
 420                                TD.getTypeAllocSizeInBits(LoadTy));
 421       MapTy = PointerType::getUnqual(MapTy);
 422     } else
 423       return 0;
 424
 425     C = FoldBitCast(C, MapTy, TD);
 426     if (Constant *Res = FoldReinterpretLoadFromConstPtr(C, TD))
 427       return FoldBitCast(Res, LoadTy, TD);
 428     return 0;
 429   }
 430
 431   unsigned BytesLoaded = (IntType->getBitWidth() + 7) / 8;
 432   if (BytesLoaded > 32 || BytesLoaded == 0) return 0;
 433
 434   GlobalValue *GVal;
 435   int64_t Offset;
 436   if (!IsConstantOffsetFromGlobal(C, GVal, Offset, TD))
 437     return 0;
 438
 439   GlobalVariable *GV = dyn_cast<GlobalVariable>(GVal);
 440   if (!GV || !GV->isConstant() || !GV->hasDefinitiveInitializer() ||
 441       !GV->getInitializer()->getType()->isSized())
 442     return 0;
 443
 444   // If we're loading off the beginning of the global, some bytes may be valid,
 445   // but we don't try to handle this.
 446   if (Offset < 0) return 0;
 447
 448   // If we're not accessing anything in this constant, the result is undefined.
 449   if (uint64_t(Offset) >= TD.getTypeAllocSize(GV->getInitializer()->getType()))
 450     return UndefValue::get(IntType);
 451
 452   unsigned char RawBytes[32] = {0};
 453   if (!ReadDataFromGlobal(GV->getInitializer(), Offset, RawBytes,
 454                           BytesLoaded, TD))
 455     return 0;
 456
 457   APInt ResultVal = APInt(IntType->getBitWidth(), 0);
 458   if (TD.isLittleEndian()) {
 459     ResultVal = RawBytes[BytesLoaded - 1];
 460     for (unsigned i = 1; i != BytesLoaded; ++i) {
 461       ResultVal <<= 8;
 462       ResultVal |= RawBytes[BytesLoaded-1-i];
 463     }
 464   } else {
 465     ResultVal = RawBytes[0];
 466     for (unsigned i = 1; i != BytesLoaded; ++i) {
 467       ResultVal <<= 8;
 468       ResultVal |= RawBytes[i];
 469     }
 470   }
 471
 472   return ConstantInt::get(IntType->getContext(), ResultVal);
 473 }
 474
 475 /// ConstantFoldLoadFromConstPtr - Return the value that a load from C would
 476 /// produce if it is constant and determinable.  If this is not determinable,
 477 /// return null.
 478 Constant *llvm::ConstantFoldLoadFromConstPtr(Constant *C,
 479                                              const DataLayout *TD) {
 480   // First, try the easy cases:
 481   if (GlobalVariable *GV = dyn_cast<GlobalVariable>(C))
 482     if (GV->isConstant() && GV->hasDefinitiveInitializer())
 483       return GV->getInitializer();
 484
 485   // If the loaded value isn't a constant expr, we can't handle it.
 486   ConstantExpr *CE = dyn_cast<ConstantExpr>(C);
 487   if (!CE) return 0;
 488
 489   if (CE->getOpcode() == Instruction::GetElementPtr) {
 490     if (GlobalVariable *GV = dyn_cast<GlobalVariable>(CE->getOperand(0)))
 491       if (GV->isConstant() && GV->hasDefinitiveInitializer())
 492         if (Constant *V =
 493              ConstantFoldLoadThroughGEPConstantExpr(GV->getInitializer(), CE))
 494           return V;
 495   }
 496
 497   // Instead of loading constant c string, use corresponding integer value
 498   // directly if string length is small enough.
 499   StringRef Str;
 500   if (TD && getConstantStringInfo(CE, Str) && !Str.empty()) {
 501     unsigned StrLen = Str.size();
 502     Type *Ty = cast<PointerType>(CE->getType())->getElementType();
 503     unsigned NumBits = Ty->getPrimitiveSizeInBits();
 504     // Replace load with immediate integer if the result is an integer or fp
 505     // value.
 506     if ((NumBits >> 3) == StrLen + 1 && (NumBits & 7) == 0 &&
 507         (isa<IntegerType>(Ty) || Ty->isFloatingPointTy())) {
 508       APInt StrVal(NumBits, 0);
 509       APInt SingleChar(NumBits, 0);
 510       if (TD->isLittleEndian()) {
 511         for (signed i = StrLen-1; i >= 0; i--) {
 512           SingleChar = (uint64_t) Str[i] & UCHAR_MAX;
 513           StrVal = (StrVal << 8) | SingleChar;
 514         }
 515       } else {
 516         for (unsigned i = 0; i < StrLen; i++) {
 517           SingleChar = (uint64_t) Str[i] & UCHAR_MAX;
 518           StrVal = (StrVal << 8) | SingleChar;
 519         }
 520         // Append NULL at the end.
 521         SingleChar = 0;
 522         StrVal = (StrVal << 8) | SingleChar;
 523       }
 524
 525       Constant *Res = ConstantInt::get(CE->getContext(), StrVal);
 526       if (Ty->isFloatingPointTy())
 527         Res = ConstantExpr::getBitCast(Res, Ty);
 528       return Res;
 529     }
 530   }
 531
 532   // If this load comes from anywhere in a constant global, and if the global
 533   // is all undef or zero, we know what it loads.
 534   if (GlobalVariable *GV =
 535         dyn_cast<GlobalVariable>(GetUnderlyingObject(CE, TD))) {
 536     if (GV->isConstant() && GV->hasDefinitiveInitializer()) {
 537       Type *ResTy = cast<PointerType>(C->getType())->getElementType();
 538       if (GV->getInitializer()->isNullValue())
 539         return Constant::getNullValue(ResTy);
 540       if (isa<UndefValue>(GV->getInitializer()))
 541         return UndefValue::get(ResTy);
 542     }
 543   }
 544
 545   // Try hard to fold loads from bitcasted strange and non-type-safe things.
 546   if (TD)
 547     return FoldReinterpretLoadFromConstPtr(CE, *TD);
 548   return 0;
 549 }
 550
 551 static Constant *ConstantFoldLoadInst(const LoadInst *LI, const DataLayout *TD){
 552   if (LI->isVolatile()) return 0;
 553
 554   if (Constant *C = dyn_cast<Constant>(LI->getOperand(0)))
 555     return ConstantFoldLoadFromConstPtr(C, TD);
 556
 557   return 0;
 558 }
 559
 560 /// SymbolicallyEvaluateBinop - One of Op0/Op1 is a constant expression.
 561 /// Attempt to symbolically evaluate the result of a binary operator merging
 562 /// these together.  If target data info is available, it is provided as TD,
 563 /// otherwise TD is null.
 564 static Constant *SymbolicallyEvaluateBinop(unsigned Opc, Constant *Op0,
 565                                            Constant *Op1, const DataLayout *TD){
 566   // SROA
 567
 568   // Fold (and 0xffffffff00000000, (shl x, 32)) -> shl.
 569   // Fold (lshr (or X, Y), 32) -> (lshr [X/Y], 32) if one doesn't contribute
 570   // bits.
 571
 572
 573   // If the constant expr is something like &A[123] - &A[4].f, fold this into a
 574   // constant.  This happens frequently when iterating over a global array.
 575   if (Opc == Instruction::Sub && TD) {
 576     GlobalValue *GV1, *GV2;
 577     int64_t Offs1, Offs2;
 578
 579     if (IsConstantOffsetFromGlobal(Op0, GV1, Offs1, *TD))
 580       if (IsConstantOffsetFromGlobal(Op1, GV2, Offs2, *TD) &&
 581           GV1 == GV2) {
 582         // (&GV+C1) - (&GV+C2) -> C1-C2, pointer arithmetic cannot overflow.
 583         return ConstantInt::get(Op0->getType(), Offs1-Offs2);
 584       }
 585   }
 586
 587   return 0;
 588 }
 589
 590 /// CastGEPIndices - If array indices are not pointer-sized integers,
 591 /// explicitly cast them so that they aren't implicitly casted by the
 592 /// getelementptr.
 593 static Constant *CastGEPIndices(ArrayRef<Constant *> Ops,
 594                                 Type *ResultTy, const DataLayout *TD,
 595                                 const TargetLibraryInfo *TLI) {
 596   if (!TD) return 0;
 597   Type *IntPtrTy = TD->getIntPtrType(ResultTy->getContext());
 598
 599   bool Any = false;
 600   SmallVector<Constant*, 32> NewIdxs;
 601   for (unsigned i = 1, e = Ops.size(); i != e; ++i) {
 602     if ((i == 1 ||
 603          !isa<StructType>(GetElementPtrInst::getIndexedType(Ops[0]->getType(),
 604                                                         Ops.slice(1, i-1)))) &&
 605         Ops[i]->getType() != IntPtrTy) {
 606       Any = true;
 607       NewIdxs.push_back(ConstantExpr::getCast(CastInst::getCastOpcode(Ops[i],
 608                                                                       true,
 609                                                                       IntPtrTy,
 610                                                                       true),
 611                                               Ops[i], IntPtrTy));
 612     } else
 613       NewIdxs.push_back(Ops[i]);
 614   }
 615   if (!Any) return 0;
 616
 617   Constant *C =
 618     ConstantExpr::getGetElementPtr(Ops[0], NewIdxs);
 619   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
 620     if (Constant *Folded = ConstantFoldConstantExpression(CE, TD, TLI))
 621       C = Folded;
 622   return C;
 623 }
 624
 625 /// Strip the pointer casts, but preserve the address space information.
 626 static Constant* StripPtrCastKeepAS(Constant* Ptr) {
 627   assert(Ptr->getType()->isPointerTy() && "Not a pointer type");
 628   PointerType *OldPtrTy = cast<PointerType>(Ptr->getType());
 629   Ptr = cast<Constant>(Ptr->stripPointerCasts());
 630   PointerType *NewPtrTy = cast<PointerType>(Ptr->getType());
 631
 632   // Preserve the address space number of the pointer.
 633   if (NewPtrTy->getAddressSpace() != OldPtrTy->getAddressSpace()) {
 634     NewPtrTy = NewPtrTy->getElementType()->getPointerTo(
 635       OldPtrTy->getAddressSpace());
 636     Ptr = ConstantExpr::getBitCast(Ptr, NewPtrTy);
 637   }
 638   return Ptr;
 639 }
 640
 641 /// SymbolicallyEvaluateGEP - If we can symbolically evaluate the specified GEP
 642 /// constant expression, do so.
 643 static Constant *SymbolicallyEvaluateGEP(ArrayRef<Constant *> Ops,
 644                                          Type *ResultTy, const DataLayout *TD,
 645                                          const TargetLibraryInfo *TLI) {
 646   Constant *Ptr = Ops[0];
 647   if (!TD || !cast<PointerType>(Ptr->getType())->getElementType()->isSized() ||
 648       !Ptr->getType()->isPointerTy())
 649     return 0;
 650
 651   Type *IntPtrTy = TD->getIntPtrType(Ptr->getContext());
 652
 653   // If this is a constant expr gep that is effectively computing an
 654   // "offsetof", fold it into 'cast int Size to T*' instead of 'gep 0, 0, 12'
 655   for (unsigned i = 1, e = Ops.size(); i != e; ++i)
 656     if (!isa<ConstantInt>(Ops[i])) {
 657
 658       // If this is "gep i8* Ptr, (sub 0, V)", fold this as:
 659       // "inttoptr (sub (ptrtoint Ptr), V)"
 660       if (Ops.size() == 2 &&
 661           cast<PointerType>(ResultTy)->getElementType()->isIntegerTy(8)) {
 662         ConstantExpr *CE = dyn_cast<ConstantExpr>(Ops[1]);
 663         assert((CE == 0 || CE->getType() == IntPtrTy) &&
 664                "CastGEPIndices didn't canonicalize index types!");
 665         if (CE && CE->getOpcode() == Instruction::Sub &&
 666             CE->getOperand(0)->isNullValue()) {
 667           Constant *Res = ConstantExpr::getPtrToInt(Ptr, CE->getType());
 668           Res = ConstantExpr::getSub(Res, CE->getOperand(1));
 669           Res = ConstantExpr::getIntToPtr(Res, ResultTy);
 670           if (ConstantExpr *ResCE = dyn_cast<ConstantExpr>(Res))
 671             Res = ConstantFoldConstantExpression(ResCE, TD, TLI);
 672           return Res;
 673         }
 674       }
 675       return 0;
 676     }
 677
 678   unsigned BitWidth = TD->getTypeSizeInBits(IntPtrTy);
 679   APInt Offset =
 680     APInt(BitWidth, TD->getIndexedOffset(Ptr->getType(),
 681                                          makeArrayRef((Value *const*)
 682                                                         Ops.data() + 1,
 683                                                       Ops.size() - 1)));
 684   Ptr = StripPtrCastKeepAS(Ptr);
 685
 686   // If this is a GEP of a GEP, fold it all into a single GEP.
 687   while (GEPOperator *GEP = dyn_cast<GEPOperator>(Ptr)) {
 688     SmallVector<Value *, 4> NestedOps(GEP->op_begin()+1, GEP->op_end());
 689
 690     // Do not try the incorporate the sub-GEP if some index is not a number.
 691     bool AllConstantInt = true;
 692     for (unsigned i = 0, e = NestedOps.size(); i != e; ++i)
 693       if (!isa<ConstantInt>(NestedOps[i])) {
 694         AllConstantInt = false;
 695         break;
 696       }
 697     if (!AllConstantInt)
 698       break;
 699
 700     Ptr = cast<Constant>(GEP->getOperand(0));
 701     Offset += APInt(BitWidth,
 702                     TD->getIndexedOffset(Ptr->getType(), NestedOps));
 703     Ptr = StripPtrCastKeepAS(Ptr);
 704   }
 705
 706   // If the base value for this address is a literal integer value, fold the
 707   // getelementptr to the resulting integer value casted to the pointer type.
 708   APInt BasePtr(BitWidth, 0);
 709   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ptr))
 710     if (CE->getOpcode() == Instruction::IntToPtr)
 711       if (ConstantInt *Base = dyn_cast<ConstantInt>(CE->getOperand(0)))
 712         BasePtr = Base->getValue().zextOrTrunc(BitWidth);
 713   if (Ptr->isNullValue() || BasePtr != 0) {
 714     Constant *C = ConstantInt::get(Ptr->getContext(), Offset+BasePtr);
 715     return ConstantExpr::getIntToPtr(C, ResultTy);
 716   }
 717
 718   // Otherwise form a regular getelementptr. Recompute the indices so that
 719   // we eliminate over-indexing of the notional static type array bounds.
 720   // This makes it easy to determine if the getelementptr is "inbounds".
 721   // Also, this helps GlobalOpt do SROA on GlobalVariables.
 722   Type *Ty = Ptr->getType();
 723   assert(Ty->isPointerTy() && "Forming regular GEP of non-pointer type");
 724   SmallVector<Constant*, 32> NewIdxs;
 725   do {
 726     if (SequentialType *ATy = dyn_cast<SequentialType>(Ty)) {
 727       if (ATy->isPointerTy()) {
 728         // The only pointer indexing we'll do is on the first index of the GEP.
 729         if (!NewIdxs.empty())
 730           break;
 731
 732         // Only handle pointers to sized types, not pointers to functions.
 733         if (!ATy->getElementType()->isSized())
 734           return 0;
 735       }
 736
 737       // Determine which element of the array the offset points into.
 738       APInt ElemSize(BitWidth, TD->getTypeAllocSize(ATy->getElementType()));
 739       IntegerType *IntPtrTy = TD->getIntPtrType(Ty->getContext());
 740       if (ElemSize == 0)
 741         // The element size is 0. This may be [0 x Ty]*, so just use a zero
 742         // index for this level and proceed to the next level to see if it can
 743         // accommodate the offset.
 744         NewIdxs.push_back(ConstantInt::get(IntPtrTy, 0));
 745       else {
 746         // The element size is non-zero divide the offset by the element
 747         // size (rounding down), to compute the index at this level.
 748         APInt NewIdx = Offset.udiv(ElemSize);
 749         Offset -= NewIdx * ElemSize;
 750         NewIdxs.push_back(ConstantInt::get(IntPtrTy, NewIdx));
 751       }
 752       Ty = ATy->getElementType();
 753     } else if (StructType *STy = dyn_cast<StructType>(Ty)) {
 754       // If we end up with an offset that isn't valid for this struct type, we
 755       // can't re-form this GEP in a regular form, so bail out. The pointer
 756       // operand likely went through casts that are necessary to make the GEP
 757       // sensible.
 758       const StructLayout &SL = *TD->getStructLayout(STy);
 759       if (Offset.uge(SL.getSizeInBytes()))
 760         break;
 761
 762       // Determine which field of the struct the offset points into. The
 763       // getZExtValue is fine as we've already ensured that the offset is
 764       // within the range representable by the StructLayout API.
 765       unsigned ElIdx = SL.getElementContainingOffset(Offset.getZExtValue());
 766       NewIdxs.push_back(ConstantInt::get(Type::getInt32Ty(Ty->getContext()),
 767                                          ElIdx));
 768       Offset -= APInt(BitWidth, SL.getElementOffset(ElIdx));
 769       Ty = STy->getTypeAtIndex(ElIdx);
 770     } else {
 771       // We've reached some non-indexable type.
 772       break;
 773     }
 774   } while (Ty != cast<PointerType>(ResultTy)->getElementType());
 775
 776   // If we haven't used up the entire offset by descending the static
 777   // type, then the offset is pointing into the middle of an indivisible
 778   // member, so we can't simplify it.
 779   if (Offset != 0)
 780     return 0;
 781
 782   // Create a GEP.
 783   Constant *C =
 784     ConstantExpr::getGetElementPtr(Ptr, NewIdxs);
 785   assert(cast<PointerType>(C->getType())->getElementType() == Ty &&
 786          "Computed GetElementPtr has unexpected type!");
 787
 788   // If we ended up indexing a member with a type that doesn't match
 789   // the type of what the original indices indexed, add a cast.
 790   if (Ty != cast<PointerType>(ResultTy)->getElementType())
 791     C = FoldBitCast(C, ResultTy, *TD);
 792
 793   return C;
 794 }
 795
 796
 797
 798 //===----------------------------------------------------------------------===//
 799 // Constant Folding public APIs
 800 //===----------------------------------------------------------------------===//
 801
 802 /// ConstantFoldInstruction - Try to constant fold the specified instruction.
 803 /// If successful, the constant result is returned, if not, null is returned.
 804 /// Note that this fails if not all of the operands are constant.  Otherwise,
 805 /// this function can only fail when attempting to fold instructions like loads
 806 /// and stores, which have no constant expression form.
 807 Constant *llvm::ConstantFoldInstruction(Instruction *I,
 808                                         const DataLayout *TD,
 809                                         const TargetLibraryInfo *TLI) {
 810   // Handle PHI nodes quickly here...
 811   if (PHINode *PN = dyn_cast<PHINode>(I)) {
 812     Constant *CommonValue = 0;
 813
 814     for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
 815       Value *Incoming = PN->getIncomingValue(i);
 816       // If the incoming value is undef then skip it.  Note that while we could
 817       // skip the value if it is equal to the phi node itself we choose not to
 818       // because that would break the rule that constant folding only applies if
 819       // all operands are constants.
 820       if (isa<UndefValue>(Incoming))
 821         continue;
 822       // If the incoming value is not a constant, then give up.
 823       Constant *C = dyn_cast<Constant>(Incoming);
 824       if (!C)
 825         return 0;
 826       // Fold the PHI's operands.
 827       if (ConstantExpr *NewC = dyn_cast<ConstantExpr>(C))
 828         C = ConstantFoldConstantExpression(NewC, TD, TLI);
 829       // If the incoming value is a different constant to
 830       // the one we saw previously, then give up.
 831       if (CommonValue && C != CommonValue)
 832         return 0;
 833       CommonValue = C;
 834     }
 835
 836
 837     // If we reach here, all incoming values are the same constant or undef.
 838     return CommonValue ? CommonValue : UndefValue::get(PN->getType());
 839   }
 840
 841   // Scan the operand list, checking to see if they are all constants, if so,
 842   // hand off to ConstantFoldInstOperands.
 843   SmallVector<Constant*, 8> Ops;
 844   for (User::op_iterator i = I->op_begin(), e = I->op_end(); i != e; ++i) {
 845     Constant *Op = dyn_cast<Constant>(*i);
 846     if (!Op)
 847       return 0;  // All operands not constant!
 848
 849     // Fold the Instruction's operands.
 850     if (ConstantExpr *NewCE = dyn_cast<ConstantExpr>(Op))
 851       Op = ConstantFoldConstantExpression(NewCE, TD, TLI);
 852
 853     Ops.push_back(Op);
 854   }
 855
 856   if (const CmpInst *CI = dyn_cast<CmpInst>(I))
 857     return ConstantFoldCompareInstOperands(CI->getPredicate(), Ops[0], Ops[1],
 858                                            TD, TLI);
 859
 860   if (const LoadInst *LI = dyn_cast<LoadInst>(I))
 861     return ConstantFoldLoadInst(LI, TD);
 862
 863   if (InsertValueInst *IVI = dyn_cast<InsertValueInst>(I))
 864     return ConstantExpr::getInsertValue(
 865                                 cast<Constant>(IVI->getAggregateOperand()),
 866                                 cast<Constant>(IVI->getInsertedValueOperand()),
 867                                 IVI->getIndices());
 868
 869   if (ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(I))
 870     return ConstantExpr::getExtractValue(
 871                                     cast<Constant>(EVI->getAggregateOperand()),
 872                                     EVI->getIndices());
 873
 874   return ConstantFoldInstOperands(I->getOpcode(), I->getType(), Ops, TD, TLI);
 875 }
 876
 877 /// ConstantFoldConstantExpression - Attempt to fold the constant expression
 878 /// using the specified DataLayout.  If successful, the constant result is
 879 /// result is returned, if not, null is returned.
 880 Constant *llvm::ConstantFoldConstantExpression(const ConstantExpr *CE,
 881                                                const DataLayout *TD,
 882                                                const TargetLibraryInfo *TLI) {
 883   SmallVector<Constant*, 8> Ops;
 884   for (User::const_op_iterator i = CE->op_begin(), e = CE->op_end();
 885        i != e; ++i) {
 886     Constant *NewC = cast<Constant>(*i);
 887     // Recursively fold the ConstantExpr's operands.
 888     if (ConstantExpr *NewCE = dyn_cast<ConstantExpr>(NewC))
 889       NewC = ConstantFoldConstantExpression(NewCE, TD, TLI);
 890     Ops.push_back(NewC);
 891   }
 892
 893   if (CE->isCompare())
 894     return ConstantFoldCompareInstOperands(CE->getPredicate(), Ops[0], Ops[1],
 895                                            TD, TLI);
 896   return ConstantFoldInstOperands(CE->getOpcode(), CE->getType(), Ops, TD, TLI);
 897 }
 898
 899 /// ConstantFoldInstOperands - Attempt to constant fold an instruction with the
 900 /// specified opcode and operands.  If successful, the constant result is
 901 /// returned, if not, null is returned.  Note that this function can fail when
 902 /// attempting to fold instructions like loads and stores, which have no
 903 /// constant expression form.
 904 ///
 905 /// TODO: This function neither utilizes nor preserves nsw/nuw/inbounds/etc
 906 /// information, due to only being passed an opcode and operands. Constant
 907 /// folding using this function strips this information.
 908 ///
 909 Constant *llvm::ConstantFoldInstOperands(unsigned Opcode, Type *DestTy,
 910                                          ArrayRef<Constant *> Ops,
 911                                          const DataLayout *TD,
 912                                          const TargetLibraryInfo *TLI) {
 913   // Handle easy binops first.
 914   if (Instruction::isBinaryOp(Opcode)) {
 915     if (isa<ConstantExpr>(Ops[0]) || isa<ConstantExpr>(Ops[1]))
 916       if (Constant *C = SymbolicallyEvaluateBinop(Opcode, Ops[0], Ops[1], TD))
 917         return C;
 918
 919     return ConstantExpr::get(Opcode, Ops[0], Ops[1]);
 920   }
 921
 922   switch (Opcode) {
 923   default: return 0;
 924   case Instruction::ICmp:
 925   case Instruction::FCmp: llvm_unreachable("Invalid for compares");
 926   case Instruction::Call:
 927     if (Function *F = dyn_cast<Function>(Ops.back()))
 928       if (canConstantFoldCallTo(F))
 929         return ConstantFoldCall(F, Ops.slice(0, Ops.size() - 1), TLI);
 930     return 0;
 931   case Instruction::PtrToInt:
 932     // If the input is a inttoptr, eliminate the pair.  This requires knowing
 933     // the width of a pointer, so it can't be done in ConstantExpr::getCast.
 934     if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ops[0])) {
 935       if (TD && CE->getOpcode() == Instruction::IntToPtr) {
 936         Constant *Input = CE->getOperand(0);
 937         unsigned InWidth = Input->getType()->getScalarSizeInBits();
 938         if (TD->getPointerSizeInBits() < InWidth) {
 939           Constant *Mask =
 940             ConstantInt::get(CE->getContext(), APInt::getLowBitsSet(InWidth,
 941                                                   TD->getPointerSizeInBits()));
 942           Input = ConstantExpr::getAnd(Input, Mask);
 943         }
 944         // Do a zext or trunc to get to the dest size.
 945         return ConstantExpr::getIntegerCast(Input, DestTy, false);
 946       }
 947     }
 948     return ConstantExpr::getCast(Opcode, Ops[0], DestTy);
 949   case Instruction::IntToPtr:
 950     // If the input is a ptrtoint, turn the pair into a ptr to ptr bitcast if
 951     // the int size is >= the ptr size.  This requires knowing the width of a
 952     // pointer, so it can't be done in ConstantExpr::getCast.
 953     if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ops[0]))
 954       if (TD &&
 955           TD->getPointerSizeInBits() <= CE->getType()->getScalarSizeInBits() &&
 956           CE->getOpcode() == Instruction::PtrToInt)
 957         return FoldBitCast(CE->getOperand(0), DestTy, *TD);
 958
 959     return ConstantExpr::getCast(Opcode, Ops[0], DestTy);
 960   case Instruction::Trunc:
 961   case Instruction::ZExt:
 962   case Instruction::SExt:
 963   case Instruction::FPTrunc:
 964   case Instruction::FPExt:
 965   case Instruction::UIToFP:
 966   case Instruction::SIToFP:
 967   case Instruction::FPToUI:
 968   case Instruction::FPToSI:
 969       return ConstantExpr::getCast(Opcode, Ops[0], DestTy);
 970   case Instruction::BitCast:
 971     if (TD)
 972       return FoldBitCast(Ops[0], DestTy, *TD);
 973     return ConstantExpr::getBitCast(Ops[0], DestTy);
 974   case Instruction::Select:
 975     return ConstantExpr::getSelect(Ops[0], Ops[1], Ops[2]);
 976   case Instruction::ExtractElement:
 977     return ConstantExpr::getExtractElement(Ops[0], Ops[1]);
 978   case Instruction::InsertElement:
 979     return ConstantExpr::getInsertElement(Ops[0], Ops[1], Ops[2]);
 980   case Instruction::ShuffleVector:
 981     return ConstantExpr::getShuffleVector(Ops[0], Ops[1], Ops[2]);
 982   case Instruction::GetElementPtr:
 983     if (Constant *C = CastGEPIndices(Ops, DestTy, TD, TLI))
 984       return C;
 985     if (Constant *C = SymbolicallyEvaluateGEP(Ops, DestTy, TD, TLI))
 986       return C;
 987
 988     return ConstantExpr::getGetElementPtr(Ops[0], Ops.slice(1));
 989   }
 990 }
 991
 992 /// ConstantFoldCompareInstOperands - Attempt to constant fold a compare
 993 /// instruction (icmp/fcmp) with the specified operands.  If it fails, it
 994 /// returns a constant expression of the specified operands.
 995 ///
 996 Constant *llvm::ConstantFoldCompareInstOperands(unsigned Predicate,
 997                                                 Constant *Ops0, Constant *Ops1,
 998                                                 const DataLayout *TD,
 999                                                 const TargetLibraryInfo *TLI) {
1000   // fold: icmp (inttoptr x), null         -> icmp x, 0
1001   // fold: icmp (ptrtoint x), 0            -> icmp x, null
1002   // fold: icmp (inttoptr x), (inttoptr y) -> icmp trunc/zext x, trunc/zext y
1003   // fold: icmp (ptrtoint x), (ptrtoint y) -> icmp x, y
1004   //
1005   // ConstantExpr::getCompare cannot do this, because it doesn't have TD
1006   // around to know if bit truncation is happening.
1007   if (ConstantExpr *CE0 = dyn_cast<ConstantExpr>(Ops0)) {
1008     if (TD && Ops1->isNullValue()) {
1009       Type *IntPtrTy = TD->getIntPtrType(CE0->getContext());
1010       if (CE0->getOpcode() == Instruction::IntToPtr) {
1011         // Convert the integer value to the right size to ensure we get the
1012         // proper extension or truncation.
1013         Constant *C = ConstantExpr::getIntegerCast(CE0->getOperand(0),
1014                                                    IntPtrTy, false);
1015         Constant *Null = Constant::getNullValue(C->getType());
1016         return ConstantFoldCompareInstOperands(Predicate, C, Null, TD, TLI);
1017       }
1018
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         Constant *C = CE0->getOperand(0);
1024         Constant *Null = Constant::getNullValue(C->getType());
1025         return ConstantFoldCompareInstOperands(Predicate, C, Null, TD, TLI);
1026       }
1027     }
1028
1029     if (ConstantExpr *CE1 = dyn_cast<ConstantExpr>(Ops1)) {
1030       if (TD && CE0->getOpcode() == CE1->getOpcode()) {
1031         Type *IntPtrTy = TD->getIntPtrType(CE0->getContext());
1032
1033         if (CE0->getOpcode() == Instruction::IntToPtr) {
1034           // Convert the integer value to the right size to ensure we get the
1035           // proper extension or truncation.
1036           Constant *C0 = ConstantExpr::getIntegerCast(CE0->getOperand(0),
1037                                                       IntPtrTy, false);
1038           Constant *C1 = ConstantExpr::getIntegerCast(CE1->getOperand(0),
1039                                                       IntPtrTy, false);
1040           return ConstantFoldCompareInstOperands(Predicate, C0, C1, TD, TLI);
1041         }
1042
1043         // Only do this transformation if the int is intptrty in size, otherwise
1044         // there is a truncation or extension that we aren't modeling.
1045         if ((CE0->getOpcode() == Instruction::PtrToInt &&
1046              CE0->getType() == IntPtrTy &&
1047              CE0->getOperand(0)->getType() == CE1->getOperand(0)->getType()))
1048           return ConstantFoldCompareInstOperands(Predicate, CE0->getOperand(0),
1049                                                  CE1->getOperand(0), TD, TLI);
1050       }
1051     }
1052
1053     // icmp eq (or x, y), 0 -> (icmp eq x, 0) & (icmp eq y, 0)
1054     // icmp ne (or x, y), 0 -> (icmp ne x, 0) | (icmp ne y, 0)
1055     if ((Predicate == ICmpInst::ICMP_EQ || Predicate == ICmpInst::ICMP_NE) &&
1056         CE0->getOpcode() == Instruction::Or && Ops1->isNullValue()) {
1057       Constant *LHS =
1058         ConstantFoldCompareInstOperands(Predicate, CE0->getOperand(0), Ops1,
1059                                         TD, TLI);
1060       Constant *RHS =
1061         ConstantFoldCompareInstOperands(Predicate, CE0->getOperand(1), Ops1,
1062                                         TD, TLI);
1063       unsigned OpC =
1064         Predicate == ICmpInst::ICMP_EQ ? Instruction::And : Instruction::Or;
1065       Constant *Ops[] = { LHS, RHS };
1066       return ConstantFoldInstOperands(OpC, LHS->getType(), Ops, TD, TLI);
1067     }
1068   }
1069
1070   return ConstantExpr::getCompare(Predicate, Ops0, Ops1);
1071 }
1072
1073
1074 /// ConstantFoldLoadThroughGEPConstantExpr - Given a constant and a
1075 /// getelementptr constantexpr, return the constant value being addressed by the
1076 /// constant expression, or null if something is funny and we can't decide.
1077 Constant *llvm::ConstantFoldLoadThroughGEPConstantExpr(Constant *C,
1078                                                        ConstantExpr *CE) {
1079   if (!CE->getOperand(1)->isNullValue())
1080     return 0;  // Do not allow stepping over the value!
1081
1082   // Loop over all of the operands, tracking down which value we are
1083   // addressing.
1084   for (unsigned i = 2, e = CE->getNumOperands(); i != e; ++i) {
1085     C = C->getAggregateElement(CE->getOperand(i));
1086     if (C == 0) return 0;
1087   }
1088   return C;
1089 }
1090
1091 /// ConstantFoldLoadThroughGEPIndices - Given a constant and getelementptr
1092 /// indices (with an *implied* zero pointer index that is not in the list),
1093 /// return the constant value being addressed by a virtual load, or null if
1094 /// something is funny and we can't decide.
1095 Constant *llvm::ConstantFoldLoadThroughGEPIndices(Constant *C,
1096                                                   ArrayRef<Constant*> Indices) {
1097   // Loop over all of the operands, tracking down which value we are
1098   // addressing.
1099   for (unsigned i = 0, e = Indices.size(); i != e; ++i) {
1100     C = C->getAggregateElement(Indices[i]);
1101     if (C == 0) return 0;
1102   }
1103   return C;
1104 }
1105
1106
1107 //===----------------------------------------------------------------------===//
1108 //  Constant Folding for Calls
1109 //
1110
1111 /// canConstantFoldCallTo - Return true if its even possible to fold a call to
1112 /// the specified function.
1113 bool
1114 llvm::canConstantFoldCallTo(const Function *F) {
1115   switch (F->getIntrinsicID()) {
1116   case Intrinsic::sqrt:
1117   case Intrinsic::pow:
1118   case Intrinsic::powi:
1119   case Intrinsic::bswap:
1120   case Intrinsic::ctpop:
1121   case Intrinsic::ctlz:
1122   case Intrinsic::cttz:
1123   case Intrinsic::sadd_with_overflow:
1124   case Intrinsic::uadd_with_overflow:
1125   case Intrinsic::ssub_with_overflow:
1126   case Intrinsic::usub_with_overflow:
1127   case Intrinsic::smul_with_overflow:
1128   case Intrinsic::umul_with_overflow:
1129   case Intrinsic::convert_from_fp16:
1130   case Intrinsic::convert_to_fp16:
1131   case Intrinsic::x86_sse_cvtss2si:
1132   case Intrinsic::x86_sse_cvtss2si64:
1133   case Intrinsic::x86_sse_cvttss2si:
1134   case Intrinsic::x86_sse_cvttss2si64:
1135   case Intrinsic::x86_sse2_cvtsd2si:
1136   case Intrinsic::x86_sse2_cvtsd2si64:
1137   case Intrinsic::x86_sse2_cvttsd2si:
1138   case Intrinsic::x86_sse2_cvttsd2si64:
1139     return true;
1140   default:
1141     return false;
1142   case 0: break;
1143   }
1144
1145   if (!F->hasName()) return false;
1146   StringRef Name = F->getName();
1147
1148   // In these cases, the check of the length is required.  We don't want to
1149   // return true for a name like "cos\0blah" which strcmp would return equal to
1150   // "cos", but has length 8.
1151   switch (Name[0]) {
1152   default: return false;
1153   case 'a':
1154     return Name == "acos" || Name == "asin" ||
1155       Name == "atan" || Name == "atan2";
1156   case 'c':
1157     return Name == "cos" || Name == "ceil" || Name == "cosf" || Name == "cosh";
1158   case 'e':
1159     return Name == "exp" || Name == "exp2";
1160   case 'f':
1161     return Name == "fabs" || Name == "fmod" || Name == "floor";
1162   case 'l':
1163     return Name == "log" || Name == "log10";
1164   case 'p':
1165     return Name == "pow";
1166   case 's':
1167     return Name == "sin" || Name == "sinh" || Name == "sqrt" ||
1168       Name == "sinf" || Name == "sqrtf";
1169   case 't':
1170     return Name == "tan" || Name == "tanh";
1171   }
1172 }
1173
1174 static Constant *ConstantFoldFP(double (*NativeFP)(double), double V,
1175                                 Type *Ty) {
1176   sys::llvm_fenv_clearexcept();
1177   V = NativeFP(V);
1178   if (sys::llvm_fenv_testexcept()) {
1179     sys::llvm_fenv_clearexcept();
1180     return 0;
1181   }
1182
1183   if (Ty->isFloatTy())
1184     return ConstantFP::get(Ty->getContext(), APFloat((float)V));
1185   if (Ty->isDoubleTy())
1186     return ConstantFP::get(Ty->getContext(), APFloat(V));
1187   llvm_unreachable("Can only constant fold float/double");
1188 }
1189
1190 static Constant *ConstantFoldBinaryFP(double (*NativeFP)(double, double),
1191                                       double V, double W, Type *Ty) {
1192   sys::llvm_fenv_clearexcept();
1193   V = NativeFP(V, W);
1194   if (sys::llvm_fenv_testexcept()) {
1195     sys::llvm_fenv_clearexcept();
1196     return 0;
1197   }
1198
1199   if (Ty->isFloatTy())
1200     return ConstantFP::get(Ty->getContext(), APFloat((float)V));
1201   if (Ty->isDoubleTy())
1202     return ConstantFP::get(Ty->getContext(), APFloat(V));
1203   llvm_unreachable("Can only constant fold float/double");
1204 }
1205
1206 /// ConstantFoldConvertToInt - Attempt to an SSE floating point to integer
1207 /// conversion of a constant floating point. If roundTowardZero is false, the
1208 /// default IEEE rounding is used (toward nearest, ties to even). This matches
1209 /// the behavior of the non-truncating SSE instructions in the default rounding
1210 /// mode. The desired integer type Ty is used to select how many bits are
1211 /// available for the result. Returns null if the conversion cannot be
1212 /// performed, otherwise returns the Constant value resulting from the
1213 /// conversion.
1214 static Constant *ConstantFoldConvertToInt(const APFloat &Val,
1215                                           bool roundTowardZero, Type *Ty) {
1216   // All of these conversion intrinsics form an integer of at most 64bits.
1217   unsigned ResultWidth = cast<IntegerType>(Ty)->getBitWidth();
1218   assert(ResultWidth <= 64 &&
1219          "Can only constant fold conversions to 64 and 32 bit ints");
1220
1221   uint64_t UIntVal;
1222   bool isExact = false;
1223   APFloat::roundingMode mode = roundTowardZero? APFloat::rmTowardZero
1224                                               : APFloat::rmNearestTiesToEven;
1225   APFloat::opStatus status = Val.convertToInteger(&UIntVal, ResultWidth,
1226                                                   /*isSigned=*/true, mode,
1227                                                   &isExact);
1228   if (status != APFloat::opOK && status != APFloat::opInexact)
1229     return 0;
1230   return ConstantInt::get(Ty, UIntVal, /*isSigned=*/true);
1231 }
1232
1233 /// ConstantFoldCall - Attempt to constant fold a call to the specified function
1234 /// with the specified arguments, returning null if unsuccessful.
1235 Constant *
1236 llvm::ConstantFoldCall(Function *F, ArrayRef<Constant *> Operands,
1237                        const TargetLibraryInfo *TLI) {
1238   if (!F->hasName()) return 0;
1239   StringRef Name = F->getName();
1240
1241   Type *Ty = F->getReturnType();
1242   if (Operands.size() == 1) {
1243     if (ConstantFP *Op = dyn_cast<ConstantFP>(Operands[0])) {
1244       if (F->getIntrinsicID() == Intrinsic::convert_to_fp16) {
1245         APFloat Val(Op->getValueAPF());
1246
1247         bool lost = false;
1248         Val.convert(APFloat::IEEEhalf, APFloat::rmNearestTiesToEven, &lost);
1249
1250         return ConstantInt::get(F->getContext(), Val.bitcastToAPInt());
1251       }
1252       if (!TLI)
1253         return 0;
1254
1255       if (!Ty->isFloatTy() && !Ty->isDoubleTy())
1256         return 0;
1257
1258       /// We only fold functions with finite arguments. Folding NaN and inf is
1259       /// likely to be aborted with an exception anyway, and some host libms
1260       /// have known errors raising exceptions.
1261       if (Op->getValueAPF().isNaN() || Op->getValueAPF().isInfinity())
1262         return 0;
1263
1264       /// Currently APFloat versions of these functions do not exist, so we use
1265       /// the host native double versions.  Float versions are not called
1266       /// directly but for all these it is true (float)(f((double)arg)) ==
1267       /// f(arg).  Long double not supported yet.
1268       double V = Ty->isFloatTy() ? (double)Op->getValueAPF().convertToFloat() :
1269                                      Op->getValueAPF().convertToDouble();
1270       switch (Name[0]) {
1271       case 'a':
1272         if (Name == "acos" && TLI->has(LibFunc::acos))
1273           return ConstantFoldFP(acos, V, Ty);
1274         else if (Name == "asin" && TLI->has(LibFunc::asin))
1275           return ConstantFoldFP(asin, V, Ty);
1276         else if (Name == "atan" && TLI->has(LibFunc::atan))
1277           return ConstantFoldFP(atan, V, Ty);
1278         break;
1279       case 'c':
1280         if (Name == "ceil" && TLI->has(LibFunc::ceil))
1281           return ConstantFoldFP(ceil, V, Ty);
1282         else if (Name == "cos" && TLI->has(LibFunc::cos))
1283           return ConstantFoldFP(cos, V, Ty);
1284         else if (Name == "cosh" && TLI->has(LibFunc::cosh))
1285           return ConstantFoldFP(cosh, V, Ty);
1286         else if (Name == "cosf" && TLI->has(LibFunc::cosf))
1287           return ConstantFoldFP(cos, V, Ty);
1288         break;
1289       case 'e':
1290         if (Name == "exp" && TLI->has(LibFunc::exp))
1291           return ConstantFoldFP(exp, V, Ty);
1292
1293         if (Name == "exp2" && TLI->has(LibFunc::exp2)) {
1294           // Constant fold exp2(x) as pow(2,x) in case the host doesn't have a
1295           // C99 library.
1296           return ConstantFoldBinaryFP(pow, 2.0, V, Ty);
1297         }
1298         break;
1299       case 'f':
1300         if (Name == "fabs" && TLI->has(LibFunc::fabs))
1301           return ConstantFoldFP(fabs, V, Ty);
1302         else if (Name == "floor" && TLI->has(LibFunc::floor))
1303           return ConstantFoldFP(floor, V, Ty);
1304         break;
1305       case 'l':
1306         if (Name == "log" && V > 0 && TLI->has(LibFunc::log))
1307           return ConstantFoldFP(log, V, Ty);
1308         else if (Name == "log10" && V > 0 && TLI->has(LibFunc::log10))
1309           return ConstantFoldFP(log10, V, Ty);
1310         else if (F->getIntrinsicID() == Intrinsic::sqrt &&
1311                  (Ty->isFloatTy() || Ty->isDoubleTy())) {
1312           if (V >= -0.0)
1313             return ConstantFoldFP(sqrt, V, Ty);
1314           else // Undefined
1315             return Constant::getNullValue(Ty);
1316         }
1317         break;
1318       case 's':
1319         if (Name == "sin" && TLI->has(LibFunc::sin))
1320           return ConstantFoldFP(sin, V, Ty);
1321         else if (Name == "sinh" && TLI->has(LibFunc::sinh))
1322           return ConstantFoldFP(sinh, V, Ty);
1323         else if (Name == "sqrt" && V >= 0 && TLI->has(LibFunc::sqrt))
1324           return ConstantFoldFP(sqrt, V, Ty);
1325         else if (Name == "sqrtf" && V >= 0 && TLI->has(LibFunc::sqrtf))
1326           return ConstantFoldFP(sqrt, V, Ty);
1327         else if (Name == "sinf" && TLI->has(LibFunc::sinf))
1328           return ConstantFoldFP(sin, V, Ty);
1329         break;
1330       case 't':
1331         if (Name == "tan" && TLI->has(LibFunc::tan))
1332           return ConstantFoldFP(tan, V, Ty);
1333         else if (Name == "tanh" && TLI->has(LibFunc::tanh))
1334           return ConstantFoldFP(tanh, V, Ty);
1335         break;
1336       default:
1337         break;
1338       }
1339       return 0;
1340     }
1341
1342     if (ConstantInt *Op = dyn_cast<ConstantInt>(Operands[0])) {
1343       switch (F->getIntrinsicID()) {
1344       case Intrinsic::bswap:
1345         return ConstantInt::get(F->getContext(), Op->getValue().byteSwap());
1346       case Intrinsic::ctpop:
1347         return ConstantInt::get(Ty, Op->getValue().countPopulation());
1348       case Intrinsic::convert_from_fp16: {
1349         APFloat Val(APFloat::IEEEhalf, Op->getValue());
1350
1351         bool lost = false;
1352         APFloat::opStatus status =
1353           Val.convert(APFloat::IEEEsingle, APFloat::rmNearestTiesToEven, &lost);
1354
1355         // Conversion is always precise.
1356         (void)status;
1357         assert(status == APFloat::opOK && !lost &&
1358                "Precision lost during fp16 constfolding");
1359
1360         return ConstantFP::get(F->getContext(), Val);
1361       }
1362       default:
1363         return 0;
1364       }
1365     }
1366
1367     // Support ConstantVector in case we have an Undef in the top.
1368     if (isa<ConstantVector>(Operands[0]) ||
1369         isa<ConstantDataVector>(Operands[0])) {
1370       Constant *Op = cast<Constant>(Operands[0]);
1371       switch (F->getIntrinsicID()) {
1372       default: break;
1373       case Intrinsic::x86_sse_cvtss2si:
1374       case Intrinsic::x86_sse_cvtss2si64:
1375       case Intrinsic::x86_sse2_cvtsd2si:
1376       case Intrinsic::x86_sse2_cvtsd2si64:
1377         if (ConstantFP *FPOp =
1378               dyn_cast_or_null<ConstantFP>(Op->getAggregateElement(0U)))
1379           return ConstantFoldConvertToInt(FPOp->getValueAPF(),
1380                                           /*roundTowardZero=*/false, Ty);
1381       case Intrinsic::x86_sse_cvttss2si:
1382       case Intrinsic::x86_sse_cvttss2si64:
1383       case Intrinsic::x86_sse2_cvttsd2si:
1384       case Intrinsic::x86_sse2_cvttsd2si64:
1385         if (ConstantFP *FPOp =
1386               dyn_cast_or_null<ConstantFP>(Op->getAggregateElement(0U)))
1387           return ConstantFoldConvertToInt(FPOp->getValueAPF(),
1388                                           /*roundTowardZero=*/true, Ty);
1389       }
1390     }
1391
1392     if (isa<UndefValue>(Operands[0])) {
1393       if (F->getIntrinsicID() == Intrinsic::bswap)
1394         return Operands[0];
1395       return 0;
1396     }
1397
1398     return 0;
1399   }
1400
1401   if (Operands.size() == 2) {
1402     if (ConstantFP *Op1 = dyn_cast<ConstantFP>(Operands[0])) {
1403       if (!Ty->isFloatTy() && !Ty->isDoubleTy())
1404         return 0;
1405       double Op1V = Ty->isFloatTy() ?
1406                       (double)Op1->getValueAPF().convertToFloat() :
1407                       Op1->getValueAPF().convertToDouble();
1408       if (ConstantFP *Op2 = dyn_cast<ConstantFP>(Operands[1])) {
1409         if (Op2->getType() != Op1->getType())
1410           return 0;
1411
1412         double Op2V = Ty->isFloatTy() ?
1413                       (double)Op2->getValueAPF().convertToFloat():
1414                       Op2->getValueAPF().convertToDouble();
1415
1416         if (F->getIntrinsicID() == Intrinsic::pow) {
1417           return ConstantFoldBinaryFP(pow, Op1V, Op2V, Ty);
1418         }
1419         if (!TLI)
1420           return 0;
1421         if (Name == "pow" && TLI->has(LibFunc::pow))
1422           return ConstantFoldBinaryFP(pow, Op1V, Op2V, Ty);
1423         if (Name == "fmod" && TLI->has(LibFunc::fmod))
1424           return ConstantFoldBinaryFP(fmod, Op1V, Op2V, Ty);
1425         if (Name == "atan2" && TLI->has(LibFunc::atan2))
1426           return ConstantFoldBinaryFP(atan2, Op1V, Op2V, Ty);
1427       } else if (ConstantInt *Op2C = dyn_cast<ConstantInt>(Operands[1])) {
1428         if (F->getIntrinsicID() == Intrinsic::powi && Ty->isFloatTy())
1429           return ConstantFP::get(F->getContext(),
1430                                  APFloat((float)std::pow((float)Op1V,
1431                                                  (int)Op2C->getZExtValue())));
1432         if (F->getIntrinsicID() == Intrinsic::powi && Ty->isDoubleTy())
1433           return ConstantFP::get(F->getContext(),
1434                                  APFloat((double)std::pow((double)Op1V,
1435                                                    (int)Op2C->getZExtValue())));
1436       }
1437       return 0;
1438     }
1439
1440     if (ConstantInt *Op1 = dyn_cast<ConstantInt>(Operands[0])) {
1441       if (ConstantInt *Op2 = dyn_cast<ConstantInt>(Operands[1])) {
1442         switch (F->getIntrinsicID()) {
1443         default: break;
1444         case Intrinsic::sadd_with_overflow:
1445         case Intrinsic::uadd_with_overflow:
1446         case Intrinsic::ssub_with_overflow:
1447         case Intrinsic::usub_with_overflow:
1448         case Intrinsic::smul_with_overflow:
1449         case Intrinsic::umul_with_overflow: {
1450           APInt Res;
1451           bool Overflow;
1452           switch (F->getIntrinsicID()) {
1453           default: llvm_unreachable("Invalid case");
1454           case Intrinsic::sadd_with_overflow:
1455             Res = Op1->getValue().sadd_ov(Op2->getValue(), Overflow);
1456             break;
1457           case Intrinsic::uadd_with_overflow:
1458             Res = Op1->getValue().uadd_ov(Op2->getValue(), Overflow);
1459             break;
1460           case Intrinsic::ssub_with_overflow:
1461             Res = Op1->getValue().ssub_ov(Op2->getValue(), Overflow);
1462             break;
1463           case Intrinsic::usub_with_overflow:
1464             Res = Op1->getValue().usub_ov(Op2->getValue(), Overflow);
1465             break;
1466           case Intrinsic::smul_with_overflow:
1467             Res = Op1->getValue().smul_ov(Op2->getValue(), Overflow);
1468             break;
1469           case Intrinsic::umul_with_overflow:
1470             Res = Op1->getValue().umul_ov(Op2->getValue(), Overflow);
1471             break;
1472           }
1473           Constant *Ops[] = {
1474             ConstantInt::get(F->getContext(), Res),
1475             ConstantInt::get(Type::getInt1Ty(F->getContext()), Overflow)
1476           };
1477           return ConstantStruct::get(cast<StructType>(F->getReturnType()), Ops);
1478         }
1479         case Intrinsic::cttz:
1480           // FIXME: This should check for Op2 == 1, and become unreachable if
1481           // Op1 == 0.
1482           return ConstantInt::get(Ty, Op1->getValue().countTrailingZeros());
1483         case Intrinsic::ctlz:
1484           // FIXME: This should check for Op2 == 1, and become unreachable if
1485           // Op1 == 0.
1486           return ConstantInt::get(Ty, Op1->getValue().countLeadingZeros());
1487         }
1488       }
1489
1490       return 0;
1491     }
1492     return 0;
1493   }
1494   return 0;
1495 }