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