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