lib/IR/ConstantFold.cpp

   1 //===- ConstantFold.cpp - LLVM constant folder ----------------------------===//
   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 implements folding of constants for LLVM.  This implements the
  11 // (internal) ConstantFold.h interface, which is used by the
  12 // ConstantExpr::get* methods to automatically fold constants when possible.
  13 //
  14 // The current constant folding implementation is implemented in two pieces: the
  15 // pieces that don't need DataLayout, and the pieces that do. This is to avoid
  16 // a dependence in IR on Target.
  17 //
  18 //===----------------------------------------------------------------------===//
  19
  20 #include "ConstantFold.h"
  21 #include "llvm/ADT/SmallVector.h"
  22 #include "llvm/IR/Constants.h"
  23 #include "llvm/IR/DerivedTypes.h"
  24 #include "llvm/IR/Function.h"
  25 #include "llvm/IR/GetElementPtrTypeIterator.h"
  26 #include "llvm/IR/GlobalAlias.h"
  27 #include "llvm/IR/GlobalVariable.h"
  28 #include "llvm/IR/Instructions.h"
  29 #include "llvm/IR/Operator.h"
  30 #include "llvm/IR/PatternMatch.h"
  31 #include "llvm/Support/Compiler.h"
  32 #include "llvm/Support/ErrorHandling.h"
  33 #include "llvm/Support/ManagedStatic.h"
  34 #include "llvm/Support/MathExtras.h"
  35 #include <limits>
  36 using namespace llvm;
  37 using namespace llvm::PatternMatch;
  38
  39 //===----------------------------------------------------------------------===//
  40 //                ConstantFold*Instruction Implementations
  41 //===----------------------------------------------------------------------===//
  42
  43 /// BitCastConstantVector - Convert the specified vector Constant node to the
  44 /// specified vector type.  At this point, we know that the elements of the
  45 /// input vector constant are all simple integer or FP values.
  46 static Constant *BitCastConstantVector(Constant *CV, VectorType *DstTy) {
  47
  48   if (CV->isAllOnesValue()) return Constant::getAllOnesValue(DstTy);
  49   if (CV->isNullValue()) return Constant::getNullValue(DstTy);
  50
  51   // If this cast changes element count then we can't handle it here:
  52   // doing so requires endianness information.  This should be handled by
  53   // Analysis/ConstantFolding.cpp
  54   unsigned NumElts = DstTy->getNumElements();
  55   if (NumElts != CV->getType()->getVectorNumElements())
  56     return nullptr;
  57
  58   Type *DstEltTy = DstTy->getElementType();
  59
  60   SmallVector<Constant*, 16> Result;
  61   Type *Ty = IntegerType::get(CV->getContext(), 32);
  62   for (unsigned i = 0; i != NumElts; ++i) {
  63     Constant *C =
  64       ConstantExpr::getExtractElement(CV, ConstantInt::get(Ty, i));
  65     C = ConstantExpr::getBitCast(C, DstEltTy);
  66     Result.push_back(C);
  67   }
  68
  69   return ConstantVector::get(Result);
  70 }
  71
  72 /// This function determines which opcode to use to fold two constant cast
  73 /// expressions together. It uses CastInst::isEliminableCastPair to determine
  74 /// the opcode. Consequently its just a wrapper around that function.
  75 /// @brief Determine if it is valid to fold a cast of a cast
  76 static unsigned
  77 foldConstantCastPair(
  78   unsigned opc,          ///< opcode of the second cast constant expression
  79   ConstantExpr *Op,      ///< the first cast constant expression
  80   Type *DstTy            ///< destination type of the first cast
  81 ) {
  82   assert(Op && Op->isCast() && "Can't fold cast of cast without a cast!");
  83   assert(DstTy && DstTy->isFirstClassType() && "Invalid cast destination type");
  84   assert(CastInst::isCast(opc) && "Invalid cast opcode");
  85
  86   // The the types and opcodes for the two Cast constant expressions
  87   Type *SrcTy = Op->getOperand(0)->getType();
  88   Type *MidTy = Op->getType();
  89   Instruction::CastOps firstOp = Instruction::CastOps(Op->getOpcode());
  90   Instruction::CastOps secondOp = Instruction::CastOps(opc);
  91
  92   // Assume that pointers are never more than 64 bits wide, and only use this
  93   // for the middle type. Otherwise we could end up folding away illegal
  94   // bitcasts between address spaces with different sizes.
  95   IntegerType *FakeIntPtrTy = Type::getInt64Ty(DstTy->getContext());
  96
  97   // Let CastInst::isEliminableCastPair do the heavy lifting.
  98   return CastInst::isEliminableCastPair(firstOp, secondOp, SrcTy, MidTy, DstTy,
  99                                         nullptr, FakeIntPtrTy, nullptr);
 100 }
 101
 102 static Constant *FoldBitCast(Constant *V, Type *DestTy) {
 103   Type *SrcTy = V->getType();
 104   if (SrcTy == DestTy)
 105     return V; // no-op cast
 106
 107   // Check to see if we are casting a pointer to an aggregate to a pointer to
 108   // the first element.  If so, return the appropriate GEP instruction.
 109   if (PointerType *PTy = dyn_cast<PointerType>(V->getType()))
 110     if (PointerType *DPTy = dyn_cast<PointerType>(DestTy))
 111       if (PTy->getAddressSpace() == DPTy->getAddressSpace()
 112           && DPTy->getElementType()->isSized()) {
 113         SmallVector<Value*, 8> IdxList;
 114         Value *Zero =
 115           Constant::getNullValue(Type::getInt32Ty(DPTy->getContext()));
 116         IdxList.push_back(Zero);
 117         Type *ElTy = PTy->getElementType();
 118         while (ElTy != DPTy->getElementType()) {
 119           if (StructType *STy = dyn_cast<StructType>(ElTy)) {
 120             if (STy->getNumElements() == 0) break;
 121             ElTy = STy->getElementType(0);
 122             IdxList.push_back(Zero);
 123           } else if (SequentialType *STy =
 124                      dyn_cast<SequentialType>(ElTy)) {
 125             if (ElTy->isPointerTy()) break;  // Can't index into pointers!
 126             ElTy = STy->getElementType();
 127             IdxList.push_back(Zero);
 128           } else {
 129             break;
 130           }
 131         }
 132
 133         if (ElTy == DPTy->getElementType())
 134           // This GEP is inbounds because all indices are zero.
 135           return ConstantExpr::getInBoundsGetElementPtr(V, IdxList);
 136       }
 137
 138   // Handle casts from one vector constant to another.  We know that the src
 139   // and dest type have the same size (otherwise its an illegal cast).
 140   if (VectorType *DestPTy = dyn_cast<VectorType>(DestTy)) {
 141     if (VectorType *SrcTy = dyn_cast<VectorType>(V->getType())) {
 142       assert(DestPTy->getBitWidth() == SrcTy->getBitWidth() &&
 143              "Not cast between same sized vectors!");
 144       SrcTy = nullptr;
 145       // First, check for null.  Undef is already handled.
 146       if (isa<ConstantAggregateZero>(V))
 147         return Constant::getNullValue(DestTy);
 148
 149       // Handle ConstantVector and ConstantAggregateVector.
 150       return BitCastConstantVector(V, DestPTy);
 151     }
 152
 153     // Canonicalize scalar-to-vector bitcasts into vector-to-vector bitcasts
 154     // This allows for other simplifications (although some of them
 155     // can only be handled by Analysis/ConstantFolding.cpp).
 156     if (isa<ConstantInt>(V) || isa<ConstantFP>(V))
 157       return ConstantExpr::getBitCast(ConstantVector::get(V), DestPTy);
 158   }
 159
 160   // Finally, implement bitcast folding now.   The code below doesn't handle
 161   // bitcast right.
 162   if (isa<ConstantPointerNull>(V))  // ptr->ptr cast.
 163     return ConstantPointerNull::get(cast<PointerType>(DestTy));
 164
 165   // Handle integral constant input.
 166   if (ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
 167     if (DestTy->isIntegerTy())
 168       // Integral -> Integral. This is a no-op because the bit widths must
 169       // be the same. Consequently, we just fold to V.
 170       return V;
 171
 172     if (DestTy->isFloatingPointTy())
 173       return ConstantFP::get(DestTy->getContext(),
 174                              APFloat(DestTy->getFltSemantics(),
 175                                      CI->getValue()));
 176
 177     // Otherwise, can't fold this (vector?)
 178     return nullptr;
 179   }
 180
 181   // Handle ConstantFP input: FP -> Integral.
 182   if (ConstantFP *FP = dyn_cast<ConstantFP>(V))
 183     return ConstantInt::get(FP->getContext(),
 184                             FP->getValueAPF().bitcastToAPInt());
 185
 186   return nullptr;
 187 }
 188
 189
 190 /// ExtractConstantBytes - V is an integer constant which only has a subset of
 191 /// its bytes used.  The bytes used are indicated by ByteStart (which is the
 192 /// first byte used, counting from the least significant byte) and ByteSize,
 193 /// which is the number of bytes used.
 194 ///
 195 /// This function analyzes the specified constant to see if the specified byte
 196 /// range can be returned as a simplified constant.  If so, the constant is
 197 /// returned, otherwise null is returned.
 198 ///
 199 static Constant *ExtractConstantBytes(Constant *C, unsigned ByteStart,
 200                                       unsigned ByteSize) {
 201   assert(C->getType()->isIntegerTy() &&
 202          (cast<IntegerType>(C->getType())->getBitWidth() & 7) == 0 &&
 203          "Non-byte sized integer input");
 204   unsigned CSize = cast<IntegerType>(C->getType())->getBitWidth()/8;
 205   assert(ByteSize && "Must be accessing some piece");
 206   assert(ByteStart+ByteSize <= CSize && "Extracting invalid piece from input");
 207   assert(ByteSize != CSize && "Should not extract everything");
 208
 209   // Constant Integers are simple.
 210   if (ConstantInt *CI = dyn_cast<ConstantInt>(C)) {
 211     APInt V = CI->getValue();
 212     if (ByteStart)
 213       V = V.lshr(ByteStart*8);
 214     V = V.trunc(ByteSize*8);
 215     return ConstantInt::get(CI->getContext(), V);
 216   }
 217
 218   // In the input is a constant expr, we might be able to recursively simplify.
 219   // If not, we definitely can't do anything.
 220   ConstantExpr *CE = dyn_cast<ConstantExpr>(C);
 221   if (!CE) return nullptr;
 222
 223   switch (CE->getOpcode()) {
 224   default: return nullptr;
 225   case Instruction::Or: {
 226     Constant *RHS = ExtractConstantBytes(CE->getOperand(1), ByteStart,ByteSize);
 227     if (!RHS)
 228       return nullptr;
 229
 230     // X | -1 -> -1.
 231     if (ConstantInt *RHSC = dyn_cast<ConstantInt>(RHS))
 232       if (RHSC->isAllOnesValue())
 233         return RHSC;
 234
 235     Constant *LHS = ExtractConstantBytes(CE->getOperand(0), ByteStart,ByteSize);
 236     if (!LHS)
 237       return nullptr;
 238     return ConstantExpr::getOr(LHS, RHS);
 239   }
 240   case Instruction::And: {
 241     Constant *RHS = ExtractConstantBytes(CE->getOperand(1), ByteStart,ByteSize);
 242     if (!RHS)
 243       return nullptr;
 244
 245     // X & 0 -> 0.
 246     if (RHS->isNullValue())
 247       return RHS;
 248
 249     Constant *LHS = ExtractConstantBytes(CE->getOperand(0), ByteStart,ByteSize);
 250     if (!LHS)
 251       return nullptr;
 252     return ConstantExpr::getAnd(LHS, RHS);
 253   }
 254   case Instruction::LShr: {
 255     ConstantInt *Amt = dyn_cast<ConstantInt>(CE->getOperand(1));
 256     if (!Amt)
 257       return nullptr;
 258     unsigned ShAmt = Amt->getZExtValue();
 259     // Cannot analyze non-byte shifts.
 260     if ((ShAmt & 7) != 0)
 261       return nullptr;
 262     ShAmt >>= 3;
 263
 264     // If the extract is known to be all zeros, return zero.
 265     if (ByteStart >= CSize-ShAmt)
 266       return Constant::getNullValue(IntegerType::get(CE->getContext(),
 267                                                      ByteSize*8));
 268     // If the extract is known to be fully in the input, extract it.
 269     if (ByteStart+ByteSize+ShAmt <= CSize)
 270       return ExtractConstantBytes(CE->getOperand(0), ByteStart+ShAmt, ByteSize);
 271
 272     // TODO: Handle the 'partially zero' case.
 273     return nullptr;
 274   }
 275
 276   case Instruction::Shl: {
 277     ConstantInt *Amt = dyn_cast<ConstantInt>(CE->getOperand(1));
 278     if (!Amt)
 279       return nullptr;
 280     unsigned ShAmt = Amt->getZExtValue();
 281     // Cannot analyze non-byte shifts.
 282     if ((ShAmt & 7) != 0)
 283       return nullptr;
 284     ShAmt >>= 3;
 285
 286     // If the extract is known to be all zeros, return zero.
 287     if (ByteStart+ByteSize <= ShAmt)
 288       return Constant::getNullValue(IntegerType::get(CE->getContext(),
 289                                                      ByteSize*8));
 290     // If the extract is known to be fully in the input, extract it.
 291     if (ByteStart >= ShAmt)
 292       return ExtractConstantBytes(CE->getOperand(0), ByteStart-ShAmt, ByteSize);
 293
 294     // TODO: Handle the 'partially zero' case.
 295     return nullptr;
 296   }
 297
 298   case Instruction::ZExt: {
 299     unsigned SrcBitSize =
 300       cast<IntegerType>(CE->getOperand(0)->getType())->getBitWidth();
 301
 302     // If extracting something that is completely zero, return 0.
 303     if (ByteStart*8 >= SrcBitSize)
 304       return Constant::getNullValue(IntegerType::get(CE->getContext(),
 305                                                      ByteSize*8));
 306
 307     // If exactly extracting the input, return it.
 308     if (ByteStart == 0 && ByteSize*8 == SrcBitSize)
 309       return CE->getOperand(0);
 310
 311     // If extracting something completely in the input, if if the input is a
 312     // multiple of 8 bits, recurse.
 313     if ((SrcBitSize&7) == 0 && (ByteStart+ByteSize)*8 <= SrcBitSize)
 314       return ExtractConstantBytes(CE->getOperand(0), ByteStart, ByteSize);
 315
 316     // Otherwise, if extracting a subset of the input, which is not multiple of
 317     // 8 bits, do a shift and trunc to get the bits.
 318     if ((ByteStart+ByteSize)*8 < SrcBitSize) {
 319       assert((SrcBitSize&7) && "Shouldn't get byte sized case here");
 320       Constant *Res = CE->getOperand(0);
 321       if (ByteStart)
 322         Res = ConstantExpr::getLShr(Res,
 323                                  ConstantInt::get(Res->getType(), ByteStart*8));
 324       return ConstantExpr::getTrunc(Res, IntegerType::get(C->getContext(),
 325                                                           ByteSize*8));
 326     }
 327
 328     // TODO: Handle the 'partially zero' case.
 329     return nullptr;
 330   }
 331   }
 332 }
 333
 334 /// getFoldedSizeOf - Return a ConstantExpr with type DestTy for sizeof
 335 /// on Ty, with any known factors factored out. If Folded is false,
 336 /// return null if no factoring was possible, to avoid endlessly
 337 /// bouncing an unfoldable expression back into the top-level folder.
 338 ///
 339 static Constant *getFoldedSizeOf(Type *Ty, Type *DestTy,
 340                                  bool Folded) {
 341   if (ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
 342     Constant *N = ConstantInt::get(DestTy, ATy->getNumElements());
 343     Constant *E = getFoldedSizeOf(ATy->getElementType(), DestTy, true);
 344     return ConstantExpr::getNUWMul(E, N);
 345   }
 346
 347   if (StructType *STy = dyn_cast<StructType>(Ty))
 348     if (!STy->isPacked()) {
 349       unsigned NumElems = STy->getNumElements();
 350       // An empty struct has size zero.
 351       if (NumElems == 0)
 352         return ConstantExpr::getNullValue(DestTy);
 353       // Check for a struct with all members having the same size.
 354       Constant *MemberSize =
 355         getFoldedSizeOf(STy->getElementType(0), DestTy, true);
 356       bool AllSame = true;
 357       for (unsigned i = 1; i != NumElems; ++i)
 358         if (MemberSize !=
 359             getFoldedSizeOf(STy->getElementType(i), DestTy, true)) {
 360           AllSame = false;
 361           break;
 362         }
 363       if (AllSame) {
 364         Constant *N = ConstantInt::get(DestTy, NumElems);
 365         return ConstantExpr::getNUWMul(MemberSize, N);
 366       }
 367     }
 368
 369   // Pointer size doesn't depend on the pointee type, so canonicalize them
 370   // to an arbitrary pointee.
 371   if (PointerType *PTy = dyn_cast<PointerType>(Ty))
 372     if (!PTy->getElementType()->isIntegerTy(1))
 373       return
 374         getFoldedSizeOf(PointerType::get(IntegerType::get(PTy->getContext(), 1),
 375                                          PTy->getAddressSpace()),
 376                         DestTy, true);
 377
 378   // If there's no interesting folding happening, bail so that we don't create
 379   // a constant that looks like it needs folding but really doesn't.
 380   if (!Folded)
 381     return nullptr;
 382
 383   // Base case: Get a regular sizeof expression.
 384   Constant *C = ConstantExpr::getSizeOf(Ty);
 385   C = ConstantExpr::getCast(CastInst::getCastOpcode(C, false,
 386                                                     DestTy, false),
 387                             C, DestTy);
 388   return C;
 389 }
 390
 391 /// getFoldedAlignOf - Return a ConstantExpr with type DestTy for alignof
 392 /// on Ty, with any known factors factored out. If Folded is false,
 393 /// return null if no factoring was possible, to avoid endlessly
 394 /// bouncing an unfoldable expression back into the top-level folder.
 395 ///
 396 static Constant *getFoldedAlignOf(Type *Ty, Type *DestTy,
 397                                   bool Folded) {
 398   // The alignment of an array is equal to the alignment of the
 399   // array element. Note that this is not always true for vectors.
 400   if (ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
 401     Constant *C = ConstantExpr::getAlignOf(ATy->getElementType());
 402     C = ConstantExpr::getCast(CastInst::getCastOpcode(C, false,
 403                                                       DestTy,
 404                                                       false),
 405                               C, DestTy);
 406     return C;
 407   }
 408
 409   if (StructType *STy = dyn_cast<StructType>(Ty)) {
 410     // Packed structs always have an alignment of 1.
 411     if (STy->isPacked())
 412       return ConstantInt::get(DestTy, 1);
 413
 414     // Otherwise, struct alignment is the maximum alignment of any member.
 415     // Without target data, we can't compare much, but we can check to see
 416     // if all the members have the same alignment.
 417     unsigned NumElems = STy->getNumElements();
 418     // An empty struct has minimal alignment.
 419     if (NumElems == 0)
 420       return ConstantInt::get(DestTy, 1);
 421     // Check for a struct with all members having the same alignment.
 422     Constant *MemberAlign =
 423       getFoldedAlignOf(STy->getElementType(0), DestTy, true);
 424     bool AllSame = true;
 425     for (unsigned i = 1; i != NumElems; ++i)
 426       if (MemberAlign != getFoldedAlignOf(STy->getElementType(i), DestTy, true)) {
 427         AllSame = false;
 428         break;
 429       }
 430     if (AllSame)
 431       return MemberAlign;
 432   }
 433
 434   // Pointer alignment doesn't depend on the pointee type, so canonicalize them
 435   // to an arbitrary pointee.
 436   if (PointerType *PTy = dyn_cast<PointerType>(Ty))
 437     if (!PTy->getElementType()->isIntegerTy(1))
 438       return
 439         getFoldedAlignOf(PointerType::get(IntegerType::get(PTy->getContext(),
 440                                                            1),
 441                                           PTy->getAddressSpace()),
 442                          DestTy, true);
 443
 444   // If there's no interesting folding happening, bail so that we don't create
 445   // a constant that looks like it needs folding but really doesn't.
 446   if (!Folded)
 447     return nullptr;
 448
 449   // Base case: Get a regular alignof expression.
 450   Constant *C = ConstantExpr::getAlignOf(Ty);
 451   C = ConstantExpr::getCast(CastInst::getCastOpcode(C, false,
 452                                                     DestTy, false),
 453                             C, DestTy);
 454   return C;
 455 }
 456
 457 /// getFoldedOffsetOf - Return a ConstantExpr with type DestTy for offsetof
 458 /// on Ty and FieldNo, with any known factors factored out. If Folded is false,
 459 /// return null if no factoring was possible, to avoid endlessly
 460 /// bouncing an unfoldable expression back into the top-level folder.
 461 ///
 462 static Constant *getFoldedOffsetOf(Type *Ty, Constant *FieldNo,
 463                                    Type *DestTy,
 464                                    bool Folded) {
 465   if (ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
 466     Constant *N = ConstantExpr::getCast(CastInst::getCastOpcode(FieldNo, false,
 467                                                                 DestTy, false),
 468                                         FieldNo, DestTy);
 469     Constant *E = getFoldedSizeOf(ATy->getElementType(), DestTy, true);
 470     return ConstantExpr::getNUWMul(E, N);
 471   }
 472
 473   if (StructType *STy = dyn_cast<StructType>(Ty))
 474     if (!STy->isPacked()) {
 475       unsigned NumElems = STy->getNumElements();
 476       // An empty struct has no members.
 477       if (NumElems == 0)
 478         return nullptr;
 479       // Check for a struct with all members having the same size.
 480       Constant *MemberSize =
 481         getFoldedSizeOf(STy->getElementType(0), DestTy, true);
 482       bool AllSame = true;
 483       for (unsigned i = 1; i != NumElems; ++i)
 484         if (MemberSize !=
 485             getFoldedSizeOf(STy->getElementType(i), DestTy, true)) {
 486           AllSame = false;
 487           break;
 488         }
 489       if (AllSame) {
 490         Constant *N = ConstantExpr::getCast(CastInst::getCastOpcode(FieldNo,
 491                                                                     false,
 492                                                                     DestTy,
 493                                                                     false),
 494                                             FieldNo, DestTy);
 495         return ConstantExpr::getNUWMul(MemberSize, N);
 496       }
 497     }
 498
 499   // If there's no interesting folding happening, bail so that we don't create
 500   // a constant that looks like it needs folding but really doesn't.
 501   if (!Folded)
 502     return nullptr;
 503
 504   // Base case: Get a regular offsetof expression.
 505   Constant *C = ConstantExpr::getOffsetOf(Ty, FieldNo);
 506   C = ConstantExpr::getCast(CastInst::getCastOpcode(C, false,
 507                                                     DestTy, false),
 508                             C, DestTy);
 509   return C;
 510 }
 511
 512 Constant *llvm::ConstantFoldCastInstruction(unsigned opc, Constant *V,
 513                                             Type *DestTy) {
 514   if (isa<UndefValue>(V)) {
 515     // zext(undef) = 0, because the top bits will be zero.
 516     // sext(undef) = 0, because the top bits will all be the same.
 517     // [us]itofp(undef) = 0, because the result value is bounded.
 518     if (opc == Instruction::ZExt || opc == Instruction::SExt ||
 519         opc == Instruction::UIToFP || opc == Instruction::SIToFP)
 520       return Constant::getNullValue(DestTy);
 521     return UndefValue::get(DestTy);
 522   }
 523
 524   if (V->isNullValue() && !DestTy->isX86_MMXTy())
 525     return Constant::getNullValue(DestTy);
 526
 527   // If the cast operand is a constant expression, there's a few things we can
 528   // do to try to simplify it.
 529   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
 530     if (CE->isCast()) {
 531       // Try hard to fold cast of cast because they are often eliminable.
 532       if (unsigned newOpc = foldConstantCastPair(opc, CE, DestTy))
 533         return ConstantExpr::getCast(newOpc, CE->getOperand(0), DestTy);
 534     } else if (CE->getOpcode() == Instruction::GetElementPtr &&
 535                // Do not fold addrspacecast (gep 0, .., 0). It might make the
 536                // addrspacecast uncanonicalized.
 537                opc != Instruction::AddrSpaceCast) {
 538       // If all of the indexes in the GEP are null values, there is no pointer
 539       // adjustment going on.  We might as well cast the source pointer.
 540       bool isAllNull = true;
 541       for (unsigned i = 1, e = CE->getNumOperands(); i != e; ++i)
 542         if (!CE->getOperand(i)->isNullValue()) {
 543           isAllNull = false;
 544           break;
 545         }
 546       if (isAllNull)
 547         // This is casting one pointer type to another, always BitCast
 548         return ConstantExpr::getPointerCast(CE->getOperand(0), DestTy);
 549     }
 550   }
 551
 552   // If the cast operand is a constant vector, perform the cast by
 553   // operating on each element. In the cast of bitcasts, the element
 554   // count may be mismatched; don't attempt to handle that here.
 555   if ((isa<ConstantVector>(V) || isa<ConstantDataVector>(V)) &&
 556       DestTy->isVectorTy() &&
 557       DestTy->getVectorNumElements() == V->getType()->getVectorNumElements()) {
 558     SmallVector<Constant*, 16> res;
 559     VectorType *DestVecTy = cast<VectorType>(DestTy);
 560     Type *DstEltTy = DestVecTy->getElementType();
 561     Type *Ty = IntegerType::get(V->getContext(), 32);
 562     for (unsigned i = 0, e = V->getType()->getVectorNumElements(); i != e; ++i) {
 563       Constant *C =
 564         ConstantExpr::getExtractElement(V, ConstantInt::get(Ty, i));
 565       res.push_back(ConstantExpr::getCast(opc, C, DstEltTy));
 566     }
 567     return ConstantVector::get(res);
 568   }
 569
 570   // We actually have to do a cast now. Perform the cast according to the
 571   // opcode specified.
 572   switch (opc) {
 573   default:
 574     llvm_unreachable("Failed to cast constant expression");
 575   case Instruction::FPTrunc:
 576   case Instruction::FPExt:
 577     if (ConstantFP *FPC = dyn_cast<ConstantFP>(V)) {
 578       bool ignored;
 579       APFloat Val = FPC->getValueAPF();
 580       Val.convert(DestTy->isHalfTy() ? APFloat::IEEEhalf :
 581                   DestTy->isFloatTy() ? APFloat::IEEEsingle :
 582                   DestTy->isDoubleTy() ? APFloat::IEEEdouble :
 583                   DestTy->isX86_FP80Ty() ? APFloat::x87DoubleExtended :
 584                   DestTy->isFP128Ty() ? APFloat::IEEEquad :
 585                   DestTy->isPPC_FP128Ty() ? APFloat::PPCDoubleDouble :
 586                   APFloat::Bogus,
 587                   APFloat::rmNearestTiesToEven, &ignored);
 588       return ConstantFP::get(V->getContext(), Val);
 589     }
 590     return nullptr; // Can't fold.
 591   case Instruction::FPToUI:
 592   case Instruction::FPToSI:
 593     if (ConstantFP *FPC = dyn_cast<ConstantFP>(V)) {
 594       const APFloat &V = FPC->getValueAPF();
 595       bool ignored;
 596       uint64_t x[2];
 597       uint32_t DestBitWidth = cast<IntegerType>(DestTy)->getBitWidth();
 598       if (APFloat::opInvalidOp ==
 599           V.convertToInteger(x, DestBitWidth, opc==Instruction::FPToSI,
 600                              APFloat::rmTowardZero, &ignored)) {
 601         // Undefined behavior invoked - the destination type can't represent
 602         // the input constant.
 603         return UndefValue::get(DestTy);
 604       }
 605       APInt Val(DestBitWidth, x);
 606       return ConstantInt::get(FPC->getContext(), Val);
 607     }
 608     return nullptr; // Can't fold.
 609   case Instruction::IntToPtr:   //always treated as unsigned
 610     if (V->isNullValue())       // Is it an integral null value?
 611       return ConstantPointerNull::get(cast<PointerType>(DestTy));
 612     return nullptr;                   // Other pointer types cannot be casted
 613   case Instruction::PtrToInt:   // always treated as unsigned
 614     // Is it a null pointer value?
 615     if (V->isNullValue())
 616       return ConstantInt::get(DestTy, 0);
 617     // If this is a sizeof-like expression, pull out multiplications by
 618     // known factors to expose them to subsequent folding. If it's an
 619     // alignof-like expression, factor out known factors.
 620     if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
 621       if (CE->getOpcode() == Instruction::GetElementPtr &&
 622           CE->getOperand(0)->isNullValue()) {
 623         Type *Ty =
 624           cast<PointerType>(CE->getOperand(0)->getType())->getElementType();
 625         if (CE->getNumOperands() == 2) {
 626           // Handle a sizeof-like expression.
 627           Constant *Idx = CE->getOperand(1);
 628           bool isOne = isa<ConstantInt>(Idx) && cast<ConstantInt>(Idx)->isOne();
 629           if (Constant *C = getFoldedSizeOf(Ty, DestTy, !isOne)) {
 630             Idx = ConstantExpr::getCast(CastInst::getCastOpcode(Idx, true,
 631                                                                 DestTy, false),
 632                                         Idx, DestTy);
 633             return ConstantExpr::getMul(C, Idx);
 634           }
 635         } else if (CE->getNumOperands() == 3 &&
 636                    CE->getOperand(1)->isNullValue()) {
 637           // Handle an alignof-like expression.
 638           if (StructType *STy = dyn_cast<StructType>(Ty))
 639             if (!STy->isPacked()) {
 640               ConstantInt *CI = cast<ConstantInt>(CE->getOperand(2));
 641               if (CI->isOne() &&
 642                   STy->getNumElements() == 2 &&
 643                   STy->getElementType(0)->isIntegerTy(1)) {
 644                 return getFoldedAlignOf(STy->getElementType(1), DestTy, false);
 645               }
 646             }
 647           // Handle an offsetof-like expression.
 648           if (Ty->isStructTy() || Ty->isArrayTy()) {
 649             if (Constant *C = getFoldedOffsetOf(Ty, CE->getOperand(2),
 650                                                 DestTy, false))
 651               return C;
 652           }
 653         }
 654       }
 655     // Other pointer types cannot be casted
 656     return nullptr;
 657   case Instruction::UIToFP:
 658   case Instruction::SIToFP:
 659     if (ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
 660       APInt api = CI->getValue();
 661       APFloat apf(DestTy->getFltSemantics(),
 662                   APInt::getNullValue(DestTy->getPrimitiveSizeInBits()));
 663       if (APFloat::opOverflow &
 664           apf.convertFromAPInt(api, opc==Instruction::SIToFP,
 665                               APFloat::rmNearestTiesToEven)) {
 666         // Undefined behavior invoked - the destination type can't represent
 667         // the input constant.
 668         return UndefValue::get(DestTy);
 669       }
 670       return ConstantFP::get(V->getContext(), apf);
 671     }
 672     return nullptr;
 673   case Instruction::ZExt:
 674     if (ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
 675       uint32_t BitWidth = cast<IntegerType>(DestTy)->getBitWidth();
 676       return ConstantInt::get(V->getContext(),
 677                               CI->getValue().zext(BitWidth));
 678     }
 679     return nullptr;
 680   case Instruction::SExt:
 681     if (ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
 682       uint32_t BitWidth = cast<IntegerType>(DestTy)->getBitWidth();
 683       return ConstantInt::get(V->getContext(),
 684                               CI->getValue().sext(BitWidth));
 685     }
 686     return nullptr;
 687   case Instruction::Trunc: {
 688     if (V->getType()->isVectorTy())
 689       return nullptr;
 690
 691     uint32_t DestBitWidth = cast<IntegerType>(DestTy)->getBitWidth();
 692     if (ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
 693       return ConstantInt::get(V->getContext(),
 694                               CI->getValue().trunc(DestBitWidth));
 695     }
 696
 697     // The input must be a constantexpr.  See if we can simplify this based on
 698     // the bytes we are demanding.  Only do this if the source and dest are an
 699     // even multiple of a byte.
 700     if ((DestBitWidth & 7) == 0 &&
 701         (cast<IntegerType>(V->getType())->getBitWidth() & 7) == 0)
 702       if (Constant *Res = ExtractConstantBytes(V, 0, DestBitWidth / 8))
 703         return Res;
 704
 705     return nullptr;
 706   }
 707   case Instruction::BitCast:
 708     return FoldBitCast(V, DestTy);
 709   case Instruction::AddrSpaceCast:
 710     return nullptr;
 711   }
 712 }
 713
 714 Constant *llvm::ConstantFoldSelectInstruction(Constant *Cond,
 715                                               Constant *V1, Constant *V2) {
 716   // Check for i1 and vector true/false conditions.
 717   if (Cond->isNullValue()) return V2;
 718   if (Cond->isAllOnesValue()) return V1;
 719
 720   // If the condition is a vector constant, fold the result elementwise.
 721   if (ConstantVector *CondV = dyn_cast<ConstantVector>(Cond)) {
 722     SmallVector<Constant*, 16> Result;
 723     Type *Ty = IntegerType::get(CondV->getContext(), 32);
 724     for (unsigned i = 0, e = V1->getType()->getVectorNumElements(); i != e;++i){
 725       Constant *V;
 726       Constant *V1Element = ConstantExpr::getExtractElement(V1,
 727                                                     ConstantInt::get(Ty, i));
 728       Constant *V2Element = ConstantExpr::getExtractElement(V2,
 729                                                     ConstantInt::get(Ty, i));
 730       Constant *Cond = dyn_cast<Constant>(CondV->getOperand(i));
 731       if (V1Element == V2Element) {
 732         V = V1Element;
 733       } else if (isa<UndefValue>(Cond)) {
 734         V = isa<UndefValue>(V1Element) ? V1Element : V2Element;
 735       } else {
 736         if (!isa<ConstantInt>(Cond)) break;
 737         V = Cond->isNullValue() ? V2Element : V1Element;
 738       }
 739       Result.push_back(V);
 740     }
 741
 742     // If we were able to build the vector, return it.
 743     if (Result.size() == V1->getType()->getVectorNumElements())
 744       return ConstantVector::get(Result);
 745   }
 746
 747   if (isa<UndefValue>(Cond)) {
 748     if (isa<UndefValue>(V1)) return V1;
 749     return V2;
 750   }
 751   if (isa<UndefValue>(V1)) return V2;
 752   if (isa<UndefValue>(V2)) return V1;
 753   if (V1 == V2) return V1;
 754
 755   if (ConstantExpr *TrueVal = dyn_cast<ConstantExpr>(V1)) {
 756     if (TrueVal->getOpcode() == Instruction::Select)
 757       if (TrueVal->getOperand(0) == Cond)
 758         return ConstantExpr::getSelect(Cond, TrueVal->getOperand(1), V2);
 759   }
 760   if (ConstantExpr *FalseVal = dyn_cast<ConstantExpr>(V2)) {
 761     if (FalseVal->getOpcode() == Instruction::Select)
 762       if (FalseVal->getOperand(0) == Cond)
 763         return ConstantExpr::getSelect(Cond, V1, FalseVal->getOperand(2));
 764   }
 765
 766   return nullptr;
 767 }
 768
 769 Constant *llvm::ConstantFoldExtractElementInstruction(Constant *Val,
 770                                                       Constant *Idx) {
 771   if (isa<UndefValue>(Val))  // ee(undef, x) -> undef
 772     return UndefValue::get(Val->getType()->getVectorElementType());
 773   if (Val->isNullValue())  // ee(zero, x) -> zero
 774     return Constant::getNullValue(Val->getType()->getVectorElementType());
 775   // ee({w,x,y,z}, undef) -> undef
 776   if (isa<UndefValue>(Idx))
 777     return UndefValue::get(Val->getType()->getVectorElementType());
 778
 779   if (ConstantInt *CIdx = dyn_cast<ConstantInt>(Idx)) {
 780     uint64_t Index = CIdx->getZExtValue();
 781     // ee({w,x,y,z}, wrong_value) -> undef
 782     if (Index >= Val->getType()->getVectorNumElements())
 783       return UndefValue::get(Val->getType()->getVectorElementType());
 784     return Val->getAggregateElement(Index);
 785   }
 786   return nullptr;
 787 }
 788
 789 Constant *llvm::ConstantFoldInsertElementInstruction(Constant *Val,
 790                                                      Constant *Elt,
 791                                                      Constant *Idx) {
 792   ConstantInt *CIdx = dyn_cast<ConstantInt>(Idx);
 793   if (!CIdx) return nullptr;
 794   const APInt &IdxVal = CIdx->getValue();
 795
 796   SmallVector<Constant*, 16> Result;
 797   Type *Ty = IntegerType::get(Val->getContext(), 32);
 798   for (unsigned i = 0, e = Val->getType()->getVectorNumElements(); i != e; ++i){
 799     if (i == IdxVal) {
 800       Result.push_back(Elt);
 801       continue;
 802     }
 803
 804     Constant *C =
 805       ConstantExpr::getExtractElement(Val, ConstantInt::get(Ty, i));
 806     Result.push_back(C);
 807   }
 808
 809   return ConstantVector::get(Result);
 810 }
 811
 812 Constant *llvm::ConstantFoldShuffleVectorInstruction(Constant *V1,
 813                                                      Constant *V2,
 814                                                      Constant *Mask) {
 815   unsigned MaskNumElts = Mask->getType()->getVectorNumElements();
 816   Type *EltTy = V1->getType()->getVectorElementType();
 817
 818   // Undefined shuffle mask -> undefined value.
 819   if (isa<UndefValue>(Mask))
 820     return UndefValue::get(VectorType::get(EltTy, MaskNumElts));
 821
 822   // Don't break the bitcode reader hack.
 823   if (isa<ConstantExpr>(Mask)) return nullptr;
 824
 825   unsigned SrcNumElts = V1->getType()->getVectorNumElements();
 826
 827   // Loop over the shuffle mask, evaluating each element.
 828   SmallVector<Constant*, 32> Result;
 829   for (unsigned i = 0; i != MaskNumElts; ++i) {
 830     int Elt = ShuffleVectorInst::getMaskValue(Mask, i);
 831     if (Elt == -1) {
 832       Result.push_back(UndefValue::get(EltTy));
 833       continue;
 834     }
 835     Constant *InElt;
 836     if (unsigned(Elt) >= SrcNumElts*2)
 837       InElt = UndefValue::get(EltTy);
 838     else if (unsigned(Elt) >= SrcNumElts) {
 839       Type *Ty = IntegerType::get(V2->getContext(), 32);
 840       InElt =
 841         ConstantExpr::getExtractElement(V2,
 842                                         ConstantInt::get(Ty, Elt - SrcNumElts));
 843     } else {
 844       Type *Ty = IntegerType::get(V1->getContext(), 32);
 845       InElt = ConstantExpr::getExtractElement(V1, ConstantInt::get(Ty, Elt));
 846     }
 847     Result.push_back(InElt);
 848   }
 849
 850   return ConstantVector::get(Result);
 851 }
 852
 853 Constant *llvm::ConstantFoldExtractValueInstruction(Constant *Agg,
 854                                                     ArrayRef<unsigned> Idxs) {
 855   // Base case: no indices, so return the entire value.
 856   if (Idxs.empty())
 857     return Agg;
 858
 859   if (Constant *C = Agg->getAggregateElement(Idxs[0]))
 860     return ConstantFoldExtractValueInstruction(C, Idxs.slice(1));
 861
 862   return nullptr;
 863 }
 864
 865 Constant *llvm::ConstantFoldInsertValueInstruction(Constant *Agg,
 866                                                    Constant *Val,
 867                                                    ArrayRef<unsigned> Idxs) {
 868   // Base case: no indices, so replace the entire value.
 869   if (Idxs.empty())
 870     return Val;
 871
 872   unsigned NumElts;
 873   if (StructType *ST = dyn_cast<StructType>(Agg->getType()))
 874     NumElts = ST->getNumElements();
 875   else if (ArrayType *AT = dyn_cast<ArrayType>(Agg->getType()))
 876     NumElts = AT->getNumElements();
 877   else
 878     NumElts = Agg->getType()->getVectorNumElements();
 879
 880   SmallVector<Constant*, 32> Result;
 881   for (unsigned i = 0; i != NumElts; ++i) {
 882     Constant *C = Agg->getAggregateElement(i);
 883     if (!C) return nullptr;
 884
 885     if (Idxs[0] == i)
 886       C = ConstantFoldInsertValueInstruction(C, Val, Idxs.slice(1));
 887
 888     Result.push_back(C);
 889   }
 890
 891   if (StructType *ST = dyn_cast<StructType>(Agg->getType()))
 892     return ConstantStruct::get(ST, Result);
 893   if (ArrayType *AT = dyn_cast<ArrayType>(Agg->getType()))
 894     return ConstantArray::get(AT, Result);
 895   return ConstantVector::get(Result);
 896 }
 897
 898
 899 Constant *llvm::ConstantFoldBinaryInstruction(unsigned Opcode,
 900                                               Constant *C1, Constant *C2) {
 901   // Handle UndefValue up front.
 902   if (isa<UndefValue>(C1) || isa<UndefValue>(C2)) {
 903     switch (Opcode) {
 904     case Instruction::Xor:
 905       if (isa<UndefValue>(C1) && isa<UndefValue>(C2))
 906         // Handle undef ^ undef -> 0 special case. This is a common
 907         // idiom (misuse).
 908         return Constant::getNullValue(C1->getType());
 909       // Fallthrough
 910     case Instruction::Add:
 911     case Instruction::Sub:
 912       return UndefValue::get(C1->getType());
 913     case Instruction::And:
 914       if (isa<UndefValue>(C1) && isa<UndefValue>(C2)) // undef & undef -> undef
 915         return C1;
 916       return Constant::getNullValue(C1->getType());   // undef & X -> 0
 917     case Instruction::Mul: {
 918       // undef * undef -> undef
 919       if (isa<UndefValue>(C1) && isa<UndefValue>(C2))
 920         return C1;
 921       const APInt *CV;
 922       // X * undef -> undef   if X is odd
 923       if (match(C1, m_APInt(CV)) || match(C2, m_APInt(CV)))
 924         if ((*CV)[0])
 925           return UndefValue::get(C1->getType());
 926
 927       // X * undef -> 0       otherwise
 928       return Constant::getNullValue(C1->getType());
 929     }
 930     case Instruction::SDiv:
 931     case Instruction::UDiv:
 932       // X / undef -> undef
 933       if (match(C1, m_Zero()))
 934         return C2;
 935       // undef / 0 -> undef
 936       // undef / 1 -> undef
 937       if (match(C2, m_Zero()) || match(C2, m_One()))
 938         return C1;
 939       // undef / X -> 0       otherwise
 940       return Constant::getNullValue(C1->getType());
 941     case Instruction::URem:
 942     case Instruction::SRem:
 943       // X % undef -> undef
 944       if (match(C2, m_Undef()))
 945         return C2;
 946       // undef % 0 -> undef
 947       if (match(C2, m_Zero()))
 948         return C1;
 949       // undef % X -> 0       otherwise
 950       return Constant::getNullValue(C1->getType());
 951     case Instruction::Or:                          // X | undef -> -1
 952       if (isa<UndefValue>(C1) && isa<UndefValue>(C2)) // undef | undef -> undef
 953         return C1;
 954       return Constant::getAllOnesValue(C1->getType()); // undef | X -> ~0
 955     case Instruction::LShr:
 956       // X >>l undef -> undef
 957       if (isa<UndefValue>(C2))
 958         return C2;
 959       // undef >>l 0 -> undef
 960       if (match(C2, m_Zero()))
 961         return C1;
 962       // undef >>l X -> 0
 963       return Constant::getNullValue(C1->getType());
 964     case Instruction::AShr:
 965       // X >>a undef -> undef
 966       if (isa<UndefValue>(C2))
 967         return C2;
 968       // undef >>a 0 -> undef
 969       if (match(C2, m_Zero()))
 970         return C1;
 971       // TODO: undef >>a X -> undef if the shift is exact
 972       // undef >>a X -> 0
 973       return Constant::getNullValue(C1->getType());
 974     case Instruction::Shl:
 975       // X << undef -> undef
 976       if (isa<UndefValue>(C2))
 977         return C2;
 978       // undef << 0 -> undef
 979       if (match(C2, m_Zero()))
 980         return C1;
 981       // undef << X -> 0
 982       return Constant::getNullValue(C1->getType());
 983     }
 984   }
 985
 986   // Handle simplifications when the RHS is a constant int.
 987   if (ConstantInt *CI2 = dyn_cast<ConstantInt>(C2)) {
 988     switch (Opcode) {
 989     case Instruction::Add:
 990       if (CI2->equalsInt(0)) return C1;                         // X + 0 == X
 991       break;
 992     case Instruction::Sub:
 993       if (CI2->equalsInt(0)) return C1;                         // X - 0 == X
 994       break;
 995     case Instruction::Mul:
 996       if (CI2->equalsInt(0)) return C2;                         // X * 0 == 0
 997       if (CI2->equalsInt(1))
 998         return C1;                                              // X * 1 == X
 999       break;
1000     case Instruction::UDiv:
1001     case Instruction::SDiv:
1002       if (CI2->equalsInt(1))
1003         return C1;                                            // X / 1 == X
1004       if (CI2->equalsInt(0))
1005         return UndefValue::get(CI2->getType());               // X / 0 == undef
1006       break;
1007     case Instruction::URem:
1008     case Instruction::SRem:
1009       if (CI2->equalsInt(1))
1010         return Constant::getNullValue(CI2->getType());        // X % 1 == 0
1011       if (CI2->equalsInt(0))
1012         return UndefValue::get(CI2->getType());               // X % 0 == undef
1013       break;
1014     case Instruction::And:
1015       if (CI2->isZero()) return C2;                           // X & 0 == 0
1016       if (CI2->isAllOnesValue())
1017         return C1;                                            // X & -1 == X
1018
1019       if (ConstantExpr *CE1 = dyn_cast<ConstantExpr>(C1)) {
1020         // (zext i32 to i64) & 4294967295 -> (zext i32 to i64)
1021         if (CE1->getOpcode() == Instruction::ZExt) {
1022           unsigned DstWidth = CI2->getType()->getBitWidth();
1023           unsigned SrcWidth =
1024             CE1->getOperand(0)->getType()->getPrimitiveSizeInBits();
1025           APInt PossiblySetBits(APInt::getLowBitsSet(DstWidth, SrcWidth));
1026           if ((PossiblySetBits & CI2->getValue()) == PossiblySetBits)
1027             return C1;
1028         }
1029
1030         // If and'ing the address of a global with a constant, fold it.
1031         if (CE1->getOpcode() == Instruction::PtrToInt &&
1032             isa<GlobalValue>(CE1->getOperand(0))) {
1033           GlobalValue *GV = cast<GlobalValue>(CE1->getOperand(0));
1034
1035           // Functions are at least 4-byte aligned.
1036           unsigned GVAlign = GV->getAlignment();
1037           if (isa<Function>(GV))
1038             GVAlign = std::max(GVAlign, 4U);
1039
1040           if (GVAlign > 1) {
1041             unsigned DstWidth = CI2->getType()->getBitWidth();
1042             unsigned SrcWidth = std::min(DstWidth, Log2_32(GVAlign));
1043             APInt BitsNotSet(APInt::getLowBitsSet(DstWidth, SrcWidth));
1044
1045             // If checking bits we know are clear, return zero.
1046             if ((CI2->getValue() & BitsNotSet) == CI2->getValue())
1047               return Constant::getNullValue(CI2->getType());
1048           }
1049         }
1050       }
1051       break;
1052     case Instruction::Or:
1053       if (CI2->equalsInt(0)) return C1;    // X | 0 == X
1054       if (CI2->isAllOnesValue())
1055         return C2;                         // X | -1 == -1
1056       break;
1057     case Instruction::Xor:
1058       if (CI2->equalsInt(0)) return C1;    // X ^ 0 == X
1059
1060       if (ConstantExpr *CE1 = dyn_cast<ConstantExpr>(C1)) {
1061         switch (CE1->getOpcode()) {
1062         default: break;
1063         case Instruction::ICmp:
1064         case Instruction::FCmp:
1065           // cmp pred ^ true -> cmp !pred
1066           assert(CI2->equalsInt(1));
1067           CmpInst::Predicate pred = (CmpInst::Predicate)CE1->getPredicate();
1068           pred = CmpInst::getInversePredicate(pred);
1069           return ConstantExpr::getCompare(pred, CE1->getOperand(0),
1070                                           CE1->getOperand(1));
1071         }
1072       }
1073       break;
1074     case Instruction::AShr:
1075       // ashr (zext C to Ty), C2 -> lshr (zext C, CSA), C2
1076       if (ConstantExpr *CE1 = dyn_cast<ConstantExpr>(C1))
1077         if (CE1->getOpcode() == Instruction::ZExt)  // Top bits known zero.
1078           return ConstantExpr::getLShr(C1, C2);
1079       break;
1080     }
1081   } else if (isa<ConstantInt>(C1)) {
1082     // If C1 is a ConstantInt and C2 is not, swap the operands.
1083     if (Instruction::isCommutative(Opcode))
1084       return ConstantExpr::get(Opcode, C2, C1);
1085   }
1086
1087   // At this point we know neither constant is an UndefValue.
1088   if (ConstantInt *CI1 = dyn_cast<ConstantInt>(C1)) {
1089     if (ConstantInt *CI2 = dyn_cast<ConstantInt>(C2)) {
1090       const APInt &C1V = CI1->getValue();
1091       const APInt &C2V = CI2->getValue();
1092       switch (Opcode) {
1093       default:
1094         break;
1095       case Instruction::Add:
1096         return ConstantInt::get(CI1->getContext(), C1V + C2V);
1097       case Instruction::Sub:
1098         return ConstantInt::get(CI1->getContext(), C1V - C2V);
1099       case Instruction::Mul:
1100         return ConstantInt::get(CI1->getContext(), C1V * C2V);
1101       case Instruction::UDiv:
1102         assert(!CI2->isNullValue() && "Div by zero handled above");
1103         return ConstantInt::get(CI1->getContext(), C1V.udiv(C2V));
1104       case Instruction::SDiv:
1105         assert(!CI2->isNullValue() && "Div by zero handled above");
1106         if (C2V.isAllOnesValue() && C1V.isMinSignedValue())
1107           return UndefValue::get(CI1->getType());   // MIN_INT / -1 -> undef
1108         return ConstantInt::get(CI1->getContext(), C1V.sdiv(C2V));
1109       case Instruction::URem:
1110         assert(!CI2->isNullValue() && "Div by zero handled above");
1111         return ConstantInt::get(CI1->getContext(), C1V.urem(C2V));
1112       case Instruction::SRem:
1113         assert(!CI2->isNullValue() && "Div by zero handled above");
1114         if (C2V.isAllOnesValue() && C1V.isMinSignedValue())
1115           return UndefValue::get(CI1->getType());   // MIN_INT % -1 -> undef
1116         return ConstantInt::get(CI1->getContext(), C1V.srem(C2V));
1117       case Instruction::And:
1118         return ConstantInt::get(CI1->getContext(), C1V & C2V);
1119       case Instruction::Or:
1120         return ConstantInt::get(CI1->getContext(), C1V | C2V);
1121       case Instruction::Xor:
1122         return ConstantInt::get(CI1->getContext(), C1V ^ C2V);
1123       case Instruction::Shl:
1124         if (C2V.ult(C1V.getBitWidth()))
1125           return ConstantInt::get(CI1->getContext(), C1V.shl(C2V));
1126         return UndefValue::get(C1->getType()); // too big shift is undef
1127       case Instruction::LShr:
1128         if (C2V.ult(C1V.getBitWidth()))
1129           return ConstantInt::get(CI1->getContext(), C1V.lshr(C2V));
1130         return UndefValue::get(C1->getType()); // too big shift is undef
1131       case Instruction::AShr:
1132         if (C2V.ult(C1V.getBitWidth()))
1133           return ConstantInt::get(CI1->getContext(), C1V.ashr(C2V));
1134         return UndefValue::get(C1->getType()); // too big shift is undef
1135       }
1136     }
1137
1138     switch (Opcode) {
1139     case Instruction::SDiv:
1140     case Instruction::UDiv:
1141     case Instruction::URem:
1142     case Instruction::SRem:
1143     case Instruction::LShr:
1144     case Instruction::AShr:
1145     case Instruction::Shl:
1146       if (CI1->equalsInt(0)) return C1;
1147       break;
1148     default:
1149       break;
1150     }
1151   } else if (ConstantFP *CFP1 = dyn_cast<ConstantFP>(C1)) {
1152     if (ConstantFP *CFP2 = dyn_cast<ConstantFP>(C2)) {
1153       APFloat C1V = CFP1->getValueAPF();
1154       APFloat C2V = CFP2->getValueAPF();
1155       APFloat C3V = C1V;  // copy for modification
1156       switch (Opcode) {
1157       default:
1158         break;
1159       case Instruction::FAdd:
1160         (void)C3V.add(C2V, APFloat::rmNearestTiesToEven);
1161         return ConstantFP::get(C1->getContext(), C3V);
1162       case Instruction::FSub:
1163         (void)C3V.subtract(C2V, APFloat::rmNearestTiesToEven);
1164         return ConstantFP::get(C1->getContext(), C3V);
1165       case Instruction::FMul:
1166         (void)C3V.multiply(C2V, APFloat::rmNearestTiesToEven);
1167         return ConstantFP::get(C1->getContext(), C3V);
1168       case Instruction::FDiv:
1169         (void)C3V.divide(C2V, APFloat::rmNearestTiesToEven);
1170         return ConstantFP::get(C1->getContext(), C3V);
1171       case Instruction::FRem:
1172         (void)C3V.mod(C2V, APFloat::rmNearestTiesToEven);
1173         return ConstantFP::get(C1->getContext(), C3V);
1174       }
1175     }
1176   } else if (VectorType *VTy = dyn_cast<VectorType>(C1->getType())) {
1177     // Perform elementwise folding.
1178     SmallVector<Constant*, 16> Result;
1179     Type *Ty = IntegerType::get(VTy->getContext(), 32);
1180     for (unsigned i = 0, e = VTy->getNumElements(); i != e; ++i) {
1181       Constant *LHS =
1182         ConstantExpr::getExtractElement(C1, ConstantInt::get(Ty, i));
1183       Constant *RHS =
1184         ConstantExpr::getExtractElement(C2, ConstantInt::get(Ty, i));
1185
1186       Result.push_back(ConstantExpr::get(Opcode, LHS, RHS));
1187     }
1188
1189     return ConstantVector::get(Result);
1190   }
1191
1192   if (ConstantExpr *CE1 = dyn_cast<ConstantExpr>(C1)) {
1193     // There are many possible foldings we could do here.  We should probably
1194     // at least fold add of a pointer with an integer into the appropriate
1195     // getelementptr.  This will improve alias analysis a bit.
1196
1197     // Given ((a + b) + c), if (b + c) folds to something interesting, return
1198     // (a + (b + c)).
1199     if (Instruction::isAssociative(Opcode) && CE1->getOpcode() == Opcode) {
1200       Constant *T = ConstantExpr::get(Opcode, CE1->getOperand(1), C2);
1201       if (!isa<ConstantExpr>(T) || cast<ConstantExpr>(T)->getOpcode() != Opcode)
1202         return ConstantExpr::get(Opcode, CE1->getOperand(0), T);
1203     }
1204   } else if (isa<ConstantExpr>(C2)) {
1205     // If C2 is a constant expr and C1 isn't, flop them around and fold the
1206     // other way if possible.
1207     if (Instruction::isCommutative(Opcode))
1208       return ConstantFoldBinaryInstruction(Opcode, C2, C1);
1209   }
1210
1211   // i1 can be simplified in many cases.
1212   if (C1->getType()->isIntegerTy(1)) {
1213     switch (Opcode) {
1214     case Instruction::Add:
1215     case Instruction::Sub:
1216       return ConstantExpr::getXor(C1, C2);
1217     case Instruction::Mul:
1218       return ConstantExpr::getAnd(C1, C2);
1219     case Instruction::Shl:
1220     case Instruction::LShr:
1221     case Instruction::AShr:
1222       // We can assume that C2 == 0.  If it were one the result would be
1223       // undefined because the shift value is as large as the bitwidth.
1224       return C1;
1225     case Instruction::SDiv:
1226     case Instruction::UDiv:
1227       // We can assume that C2 == 1.  If it were zero the result would be
1228       // undefined through division by zero.
1229       return C1;
1230     case Instruction::URem:
1231     case Instruction::SRem:
1232       // We can assume that C2 == 1.  If it were zero the result would be
1233       // undefined through division by zero.
1234       return ConstantInt::getFalse(C1->getContext());
1235     default:
1236       break;
1237     }
1238   }
1239
1240   // We don't know how to fold this.
1241   return nullptr;
1242 }
1243
1244 /// isZeroSizedType - This type is zero sized if its an array or structure of
1245 /// zero sized types.  The only leaf zero sized type is an empty structure.
1246 static bool isMaybeZeroSizedType(Type *Ty) {
1247   if (StructType *STy = dyn_cast<StructType>(Ty)) {
1248     if (STy->isOpaque()) return true;  // Can't say.
1249
1250     // If all of elements have zero size, this does too.
1251     for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
1252       if (!isMaybeZeroSizedType(STy->getElementType(i))) return false;
1253     return true;
1254
1255   } else if (ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
1256     return isMaybeZeroSizedType(ATy->getElementType());
1257   }
1258   return false;
1259 }
1260
1261 /// IdxCompare - Compare the two constants as though they were getelementptr
1262 /// indices.  This allows coersion of the types to be the same thing.
1263 ///
1264 /// If the two constants are the "same" (after coersion), return 0.  If the
1265 /// first is less than the second, return -1, if the second is less than the
1266 /// first, return 1.  If the constants are not integral, return -2.
1267 ///
1268 static int IdxCompare(Constant *C1, Constant *C2, Type *ElTy) {
1269   if (C1 == C2) return 0;
1270
1271   // Ok, we found a different index.  If they are not ConstantInt, we can't do
1272   // anything with them.
1273   if (!isa<ConstantInt>(C1) || !isa<ConstantInt>(C2))
1274     return -2; // don't know!
1275
1276   // We cannot compare the indices if they don't fit in an int64_t.
1277   if (cast<ConstantInt>(C1)->getValue().getActiveBits() > 64 ||
1278       cast<ConstantInt>(C2)->getValue().getActiveBits() > 64)
1279     return -2; // don't know!
1280
1281   // Ok, we have two differing integer indices.  Sign extend them to be the same
1282   // type.
1283   int64_t C1Val = cast<ConstantInt>(C1)->getSExtValue();
1284   int64_t C2Val = cast<ConstantInt>(C2)->getSExtValue();
1285
1286   if (C1Val == C2Val) return 0;  // They are equal
1287
1288   // If the type being indexed over is really just a zero sized type, there is
1289   // no pointer difference being made here.
1290   if (isMaybeZeroSizedType(ElTy))
1291     return -2; // dunno.
1292
1293   // If they are really different, now that they are the same type, then we
1294   // found a difference!
1295   if (C1Val < C2Val)
1296     return -1;
1297   else
1298     return 1;
1299 }
1300
1301 /// evaluateFCmpRelation - This function determines if there is anything we can
1302 /// decide about the two constants provided.  This doesn't need to handle simple
1303 /// things like ConstantFP comparisons, but should instead handle ConstantExprs.
1304 /// If we can determine that the two constants have a particular relation to
1305 /// each other, we should return the corresponding FCmpInst predicate,
1306 /// otherwise return FCmpInst::BAD_FCMP_PREDICATE. This is used below in
1307 /// ConstantFoldCompareInstruction.
1308 ///
1309 /// To simplify this code we canonicalize the relation so that the first
1310 /// operand is always the most "complex" of the two.  We consider ConstantFP
1311 /// to be the simplest, and ConstantExprs to be the most complex.
1312 static FCmpInst::Predicate evaluateFCmpRelation(Constant *V1, Constant *V2) {
1313   assert(V1->getType() == V2->getType() &&
1314          "Cannot compare values of different types!");
1315
1316   // Handle degenerate case quickly
1317   if (V1 == V2) return FCmpInst::FCMP_OEQ;
1318
1319   if (!isa<ConstantExpr>(V1)) {
1320     if (!isa<ConstantExpr>(V2)) {
1321       // Simple case, use the standard constant folder.
1322       ConstantInt *R = nullptr;
1323       R = dyn_cast<ConstantInt>(
1324                       ConstantExpr::getFCmp(FCmpInst::FCMP_OEQ, V1, V2));
1325       if (R && !R->isZero())
1326         return FCmpInst::FCMP_OEQ;
1327       R = dyn_cast<ConstantInt>(
1328                       ConstantExpr::getFCmp(FCmpInst::FCMP_OLT, V1, V2));
1329       if (R && !R->isZero())
1330         return FCmpInst::FCMP_OLT;
1331       R = dyn_cast<ConstantInt>(
1332                       ConstantExpr::getFCmp(FCmpInst::FCMP_OGT, V1, V2));
1333       if (R && !R->isZero())
1334         return FCmpInst::FCMP_OGT;
1335
1336       // Nothing more we can do
1337       return FCmpInst::BAD_FCMP_PREDICATE;
1338     }
1339
1340     // If the first operand is simple and second is ConstantExpr, swap operands.
1341     FCmpInst::Predicate SwappedRelation = evaluateFCmpRelation(V2, V1);
1342     if (SwappedRelation != FCmpInst::BAD_FCMP_PREDICATE)
1343       return FCmpInst::getSwappedPredicate(SwappedRelation);
1344   } else {
1345     // Ok, the LHS is known to be a constantexpr.  The RHS can be any of a
1346     // constantexpr or a simple constant.
1347     ConstantExpr *CE1 = cast<ConstantExpr>(V1);
1348     switch (CE1->getOpcode()) {
1349     case Instruction::FPTrunc:
1350     case Instruction::FPExt:
1351     case Instruction::UIToFP:
1352     case Instruction::SIToFP:
1353       // We might be able to do something with these but we don't right now.
1354       break;
1355     default:
1356       break;
1357     }
1358   }
1359   // There are MANY other foldings that we could perform here.  They will
1360   // probably be added on demand, as they seem needed.
1361   return FCmpInst::BAD_FCMP_PREDICATE;
1362 }
1363
1364 static ICmpInst::Predicate areGlobalsPotentiallyEqual(const GlobalValue *GV1,
1365                                                       const GlobalValue *GV2) {
1366   auto isGlobalUnsafeForEquality = [](const GlobalValue *GV) {
1367     if (GV->hasExternalWeakLinkage() || GV->hasWeakAnyLinkage())
1368       return true;
1369     if (const auto *GVar = dyn_cast<GlobalVariable>(GV)) {
1370       Type *Ty = GVar->getType()->getPointerElementType();
1371       // A global with opaque type might end up being zero sized.
1372       if (!Ty->isSized())
1373         return true;
1374       // A global with an empty type might lie at the address of any other
1375       // global.
1376       if (Ty->isEmptyTy())
1377         return true;
1378     }
1379     return false;
1380   };
1381   // Don't try to decide equality of aliases.
1382   if (!isa<GlobalAlias>(GV1) && !isa<GlobalAlias>(GV2))
1383     if (!isGlobalUnsafeForEquality(GV1) && !isGlobalUnsafeForEquality(GV2))
1384       return ICmpInst::ICMP_NE;
1385   return ICmpInst::BAD_ICMP_PREDICATE;
1386 }
1387
1388 /// evaluateICmpRelation - This function determines if there is anything we can
1389 /// decide about the two constants provided.  This doesn't need to handle simple
1390 /// things like integer comparisons, but should instead handle ConstantExprs
1391 /// and GlobalValues.  If we can determine that the two constants have a
1392 /// particular relation to each other, we should return the corresponding ICmp
1393 /// predicate, otherwise return ICmpInst::BAD_ICMP_PREDICATE.
1394 ///
1395 /// To simplify this code we canonicalize the relation so that the first
1396 /// operand is always the most "complex" of the two.  We consider simple
1397 /// constants (like ConstantInt) to be the simplest, followed by
1398 /// GlobalValues, followed by ConstantExpr's (the most complex).
1399 ///
1400 static ICmpInst::Predicate evaluateICmpRelation(Constant *V1, Constant *V2,
1401                                                 bool isSigned) {
1402   assert(V1->getType() == V2->getType() &&
1403          "Cannot compare different types of values!");
1404   if (V1 == V2) return ICmpInst::ICMP_EQ;
1405
1406   if (!isa<ConstantExpr>(V1) && !isa<GlobalValue>(V1) &&
1407       !isa<BlockAddress>(V1)) {
1408     if (!isa<GlobalValue>(V2) && !isa<ConstantExpr>(V2) &&
1409         !isa<BlockAddress>(V2)) {
1410       // We distilled this down to a simple case, use the standard constant
1411       // folder.
1412       ConstantInt *R = nullptr;
1413       ICmpInst::Predicate pred = ICmpInst::ICMP_EQ;
1414       R = dyn_cast<ConstantInt>(ConstantExpr::getICmp(pred, V1, V2));
1415       if (R && !R->isZero())
1416         return pred;
1417       pred = isSigned ? ICmpInst::ICMP_SLT : ICmpInst::ICMP_ULT;
1418       R = dyn_cast<ConstantInt>(ConstantExpr::getICmp(pred, V1, V2));
1419       if (R && !R->isZero())
1420         return pred;
1421       pred = isSigned ? ICmpInst::ICMP_SGT : ICmpInst::ICMP_UGT;
1422       R = dyn_cast<ConstantInt>(ConstantExpr::getICmp(pred, V1, V2));
1423       if (R && !R->isZero())
1424         return pred;
1425
1426       // If we couldn't figure it out, bail.
1427       return ICmpInst::BAD_ICMP_PREDICATE;
1428     }
1429
1430     // If the first operand is simple, swap operands.
1431     ICmpInst::Predicate SwappedRelation =
1432       evaluateICmpRelation(V2, V1, isSigned);
1433     if (SwappedRelation != ICmpInst::BAD_ICMP_PREDICATE)
1434       return ICmpInst::getSwappedPredicate(SwappedRelation);
1435
1436   } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(V1)) {
1437     if (isa<ConstantExpr>(V2)) {  // Swap as necessary.
1438       ICmpInst::Predicate SwappedRelation =
1439         evaluateICmpRelation(V2, V1, isSigned);
1440       if (SwappedRelation != ICmpInst::BAD_ICMP_PREDICATE)
1441         return ICmpInst::getSwappedPredicate(SwappedRelation);
1442       return ICmpInst::BAD_ICMP_PREDICATE;
1443     }
1444
1445     // Now we know that the RHS is a GlobalValue, BlockAddress or simple
1446     // constant (which, since the types must match, means that it's a
1447     // ConstantPointerNull).
1448     if (const GlobalValue *GV2 = dyn_cast<GlobalValue>(V2)) {
1449       return areGlobalsPotentiallyEqual(GV, GV2);
1450     } else if (isa<BlockAddress>(V2)) {
1451       return ICmpInst::ICMP_NE; // Globals never equal labels.
1452     } else {
1453       assert(isa<ConstantPointerNull>(V2) && "Canonicalization guarantee!");
1454       // GlobalVals can never be null unless they have external weak linkage.
1455       // We don't try to evaluate aliases here.
1456       if (!GV->hasExternalWeakLinkage() && !isa<GlobalAlias>(GV))
1457         return ICmpInst::ICMP_NE;
1458     }
1459   } else if (const BlockAddress *BA = dyn_cast<BlockAddress>(V1)) {
1460     if (isa<ConstantExpr>(V2)) {  // Swap as necessary.
1461       ICmpInst::Predicate SwappedRelation =
1462         evaluateICmpRelation(V2, V1, isSigned);
1463       if (SwappedRelation != ICmpInst::BAD_ICMP_PREDICATE)
1464         return ICmpInst::getSwappedPredicate(SwappedRelation);
1465       return ICmpInst::BAD_ICMP_PREDICATE;
1466     }
1467
1468     // Now we know that the RHS is a GlobalValue, BlockAddress or simple
1469     // constant (which, since the types must match, means that it is a
1470     // ConstantPointerNull).
1471     if (const BlockAddress *BA2 = dyn_cast<BlockAddress>(V2)) {
1472       // Block address in another function can't equal this one, but block
1473       // addresses in the current function might be the same if blocks are
1474       // empty.
1475       if (BA2->getFunction() != BA->getFunction())
1476         return ICmpInst::ICMP_NE;
1477     } else {
1478       // Block addresses aren't null, don't equal the address of globals.
1479       assert((isa<ConstantPointerNull>(V2) || isa<GlobalValue>(V2)) &&
1480              "Canonicalization guarantee!");
1481       return ICmpInst::ICMP_NE;
1482     }
1483   } else {
1484     // Ok, the LHS is known to be a constantexpr.  The RHS can be any of a
1485     // constantexpr, a global, block address, or a simple constant.
1486     ConstantExpr *CE1 = cast<ConstantExpr>(V1);
1487     Constant *CE1Op0 = CE1->getOperand(0);
1488
1489     switch (CE1->getOpcode()) {
1490     case Instruction::Trunc:
1491     case Instruction::FPTrunc:
1492     case Instruction::FPExt:
1493     case Instruction::FPToUI:
1494     case Instruction::FPToSI:
1495       break; // We can't evaluate floating point casts or truncations.
1496
1497     case Instruction::UIToFP:
1498     case Instruction::SIToFP:
1499     case Instruction::BitCast:
1500     case Instruction::ZExt:
1501     case Instruction::SExt:
1502       // If the cast is not actually changing bits, and the second operand is a
1503       // null pointer, do the comparison with the pre-casted value.
1504       if (V2->isNullValue() &&
1505           (CE1->getType()->isPointerTy() || CE1->getType()->isIntegerTy())) {
1506         if (CE1->getOpcode() == Instruction::ZExt) isSigned = false;
1507         if (CE1->getOpcode() == Instruction::SExt) isSigned = true;
1508         return evaluateICmpRelation(CE1Op0,
1509                                     Constant::getNullValue(CE1Op0->getType()),
1510                                     isSigned);
1511       }
1512       break;
1513
1514     case Instruction::GetElementPtr: {
1515       GEPOperator *CE1GEP = cast<GEPOperator>(CE1);
1516       // Ok, since this is a getelementptr, we know that the constant has a
1517       // pointer type.  Check the various cases.
1518       if (isa<ConstantPointerNull>(V2)) {
1519         // If we are comparing a GEP to a null pointer, check to see if the base
1520         // of the GEP equals the null pointer.
1521         if (const GlobalValue *GV = dyn_cast<GlobalValue>(CE1Op0)) {
1522           if (GV->hasExternalWeakLinkage())
1523             // Weak linkage GVals could be zero or not. We're comparing that
1524             // to null pointer so its greater-or-equal
1525             return isSigned ? ICmpInst::ICMP_SGE : ICmpInst::ICMP_UGE;
1526           else
1527             // If its not weak linkage, the GVal must have a non-zero address
1528             // so the result is greater-than
1529             return isSigned ? ICmpInst::ICMP_SGT : ICmpInst::ICMP_UGT;
1530         } else if (isa<ConstantPointerNull>(CE1Op0)) {
1531           // If we are indexing from a null pointer, check to see if we have any
1532           // non-zero indices.
1533           for (unsigned i = 1, e = CE1->getNumOperands(); i != e; ++i)
1534             if (!CE1->getOperand(i)->isNullValue())
1535               // Offsetting from null, must not be equal.
1536               return isSigned ? ICmpInst::ICMP_SGT : ICmpInst::ICMP_UGT;
1537           // Only zero indexes from null, must still be zero.
1538           return ICmpInst::ICMP_EQ;
1539         }
1540         // Otherwise, we can't really say if the first operand is null or not.
1541       } else if (const GlobalValue *GV2 = dyn_cast<GlobalValue>(V2)) {
1542         if (isa<ConstantPointerNull>(CE1Op0)) {
1543           if (GV2->hasExternalWeakLinkage())
1544             // Weak linkage GVals could be zero or not. We're comparing it to
1545             // a null pointer, so its less-or-equal
1546             return isSigned ? ICmpInst::ICMP_SLE : ICmpInst::ICMP_ULE;
1547           else
1548             // If its not weak linkage, the GVal must have a non-zero address
1549             // so the result is less-than
1550             return isSigned ? ICmpInst::ICMP_SLT : ICmpInst::ICMP_ULT;
1551         } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(CE1Op0)) {
1552           if (GV == GV2) {
1553             // If this is a getelementptr of the same global, then it must be
1554             // different.  Because the types must match, the getelementptr could
1555             // only have at most one index, and because we fold getelementptr's
1556             // with a single zero index, it must be nonzero.
1557             assert(CE1->getNumOperands() == 2 &&
1558                    !CE1->getOperand(1)->isNullValue() &&
1559                    "Surprising getelementptr!");
1560             return isSigned ? ICmpInst::ICMP_SGT : ICmpInst::ICMP_UGT;
1561           } else {
1562             if (CE1GEP->hasAllZeroIndices())
1563               return areGlobalsPotentiallyEqual(GV, GV2);
1564             return ICmpInst::BAD_ICMP_PREDICATE;
1565           }
1566         }
1567       } else {
1568         ConstantExpr *CE2 = cast<ConstantExpr>(V2);
1569         Constant *CE2Op0 = CE2->getOperand(0);
1570
1571         // There are MANY other foldings that we could perform here.  They will
1572         // probably be added on demand, as they seem needed.
1573         switch (CE2->getOpcode()) {
1574         default: break;
1575         case Instruction::GetElementPtr:
1576           // By far the most common case to handle is when the base pointers are
1577           // obviously to the same global.
1578           if (isa<GlobalValue>(CE1Op0) && isa<GlobalValue>(CE2Op0)) {
1579             // Don't know relative ordering, but check for inequality.
1580             if (CE1Op0 != CE2Op0) {
1581               GEPOperator *CE2GEP = cast<GEPOperator>(CE2);
1582               if (CE1GEP->hasAllZeroIndices() && CE2GEP->hasAllZeroIndices())
1583                 return areGlobalsPotentiallyEqual(cast<GlobalValue>(CE1Op0),
1584                                                   cast<GlobalValue>(CE2Op0));
1585               return ICmpInst::BAD_ICMP_PREDICATE;
1586             }
1587             // Ok, we know that both getelementptr instructions are based on the
1588             // same global.  From this, we can precisely determine the relative
1589             // ordering of the resultant pointers.
1590             unsigned i = 1;
1591
1592             // The logic below assumes that the result of the comparison
1593             // can be determined by finding the first index that differs.
1594             // This doesn't work if there is over-indexing in any
1595             // subsequent indices, so check for that case first.
1596             if (!CE1->isGEPWithNoNotionalOverIndexing() ||
1597                 !CE2->isGEPWithNoNotionalOverIndexing())
1598                return ICmpInst::BAD_ICMP_PREDICATE; // Might be equal.
1599
1600             // Compare all of the operands the GEP's have in common.
1601             gep_type_iterator GTI = gep_type_begin(CE1);
1602             for (;i != CE1->getNumOperands() && i != CE2->getNumOperands();
1603                  ++i, ++GTI)
1604               switch (IdxCompare(CE1->getOperand(i),
1605                                  CE2->getOperand(i), GTI.getIndexedType())) {
1606               case -1: return isSigned ? ICmpInst::ICMP_SLT:ICmpInst::ICMP_ULT;
1607               case 1:  return isSigned ? ICmpInst::ICMP_SGT:ICmpInst::ICMP_UGT;
1608               case -2: return ICmpInst::BAD_ICMP_PREDICATE;
1609               }
1610
1611             // Ok, we ran out of things they have in common.  If any leftovers
1612             // are non-zero then we have a difference, otherwise we are equal.
1613             for (; i < CE1->getNumOperands(); ++i)
1614               if (!CE1->getOperand(i)->isNullValue()) {
1615                 if (isa<ConstantInt>(CE1->getOperand(i)))
1616                   return isSigned ? ICmpInst::ICMP_SGT : ICmpInst::ICMP_UGT;
1617                 else
1618                   return ICmpInst::BAD_ICMP_PREDICATE; // Might be equal.
1619               }
1620
1621             for (; i < CE2->getNumOperands(); ++i)
1622               if (!CE2->getOperand(i)->isNullValue()) {
1623                 if (isa<ConstantInt>(CE2->getOperand(i)))
1624                   return isSigned ? ICmpInst::ICMP_SLT : ICmpInst::ICMP_ULT;
1625                 else
1626                   return ICmpInst::BAD_ICMP_PREDICATE; // Might be equal.
1627               }
1628             return ICmpInst::ICMP_EQ;
1629           }
1630         }
1631       }
1632     }
1633     default:
1634       break;
1635     }
1636   }
1637
1638   return ICmpInst::BAD_ICMP_PREDICATE;
1639 }
1640
1641 Constant *llvm::ConstantFoldCompareInstruction(unsigned short pred,
1642                                                Constant *C1, Constant *C2) {
1643   Type *ResultTy;
1644   if (VectorType *VT = dyn_cast<VectorType>(C1->getType()))
1645     ResultTy = VectorType::get(Type::getInt1Ty(C1->getContext()),
1646                                VT->getNumElements());
1647   else
1648     ResultTy = Type::getInt1Ty(C1->getContext());
1649
1650   // Fold FCMP_FALSE/FCMP_TRUE unconditionally.
1651   if (pred == FCmpInst::FCMP_FALSE)
1652     return Constant::getNullValue(ResultTy);
1653
1654   if (pred == FCmpInst::FCMP_TRUE)
1655     return Constant::getAllOnesValue(ResultTy);
1656
1657   // Handle some degenerate cases first
1658   if (isa<UndefValue>(C1) || isa<UndefValue>(C2)) {
1659     CmpInst::Predicate Predicate = CmpInst::Predicate(pred);
1660     bool isIntegerPredicate = ICmpInst::isIntPredicate(Predicate);
1661     // For EQ and NE, we can always pick a value for the undef to make the
1662     // predicate pass or fail, so we can return undef.
1663     // Also, if both operands are undef, we can return undef for int comparison.
1664     if (ICmpInst::isEquality(Predicate) || (isIntegerPredicate && C1 == C2))
1665       return UndefValue::get(ResultTy);
1666
1667     // Otherwise, for integer compare, pick the same value as the non-undef
1668     // operand, and fold it to true or false.
1669     if (isIntegerPredicate)
1670       return ConstantInt::get(ResultTy, CmpInst::isTrueWhenEqual(pred));
1671
1672     // Choosing NaN for the undef will always make unordered comparison succeed
1673     // and ordered comparison fails.
1674     return ConstantInt::get(ResultTy, CmpInst::isUnordered(Predicate));
1675   }
1676
1677   // icmp eq/ne(null,GV) -> false/true
1678   if (C1->isNullValue()) {
1679     if (const GlobalValue *GV = dyn_cast<GlobalValue>(C2))
1680       // Don't try to evaluate aliases.  External weak GV can be null.
1681       if (!isa<GlobalAlias>(GV) && !GV->hasExternalWeakLinkage()) {
1682         if (pred == ICmpInst::ICMP_EQ)
1683           return ConstantInt::getFalse(C1->getContext());
1684         else if (pred == ICmpInst::ICMP_NE)
1685           return ConstantInt::getTrue(C1->getContext());
1686       }
1687   // icmp eq/ne(GV,null) -> false/true
1688   } else if (C2->isNullValue()) {
1689     if (const GlobalValue *GV = dyn_cast<GlobalValue>(C1))
1690       // Don't try to evaluate aliases.  External weak GV can be null.
1691       if (!isa<GlobalAlias>(GV) && !GV->hasExternalWeakLinkage()) {
1692         if (pred == ICmpInst::ICMP_EQ)
1693           return ConstantInt::getFalse(C1->getContext());
1694         else if (pred == ICmpInst::ICMP_NE)
1695           return ConstantInt::getTrue(C1->getContext());
1696       }
1697   }
1698
1699   // If the comparison is a comparison between two i1's, simplify it.
1700   if (C1->getType()->isIntegerTy(1)) {
1701     switch(pred) {
1702     case ICmpInst::ICMP_EQ:
1703       if (isa<ConstantInt>(C2))
1704         return ConstantExpr::getXor(C1, ConstantExpr::getNot(C2));
1705       return ConstantExpr::getXor(ConstantExpr::getNot(C1), C2);
1706     case ICmpInst::ICMP_NE:
1707       return ConstantExpr::getXor(C1, C2);
1708     default:
1709       break;
1710     }
1711   }
1712
1713   if (isa<ConstantInt>(C1) && isa<ConstantInt>(C2)) {
1714     APInt V1 = cast<ConstantInt>(C1)->getValue();
1715     APInt V2 = cast<ConstantInt>(C2)->getValue();
1716     switch (pred) {
1717     default: llvm_unreachable("Invalid ICmp Predicate");
1718     case ICmpInst::ICMP_EQ:  return ConstantInt::get(ResultTy, V1 == V2);
1719     case ICmpInst::ICMP_NE:  return ConstantInt::get(ResultTy, V1 != V2);
1720     case ICmpInst::ICMP_SLT: return ConstantInt::get(ResultTy, V1.slt(V2));
1721     case ICmpInst::ICMP_SGT: return ConstantInt::get(ResultTy, V1.sgt(V2));
1722     case ICmpInst::ICMP_SLE: return ConstantInt::get(ResultTy, V1.sle(V2));
1723     case ICmpInst::ICMP_SGE: return ConstantInt::get(ResultTy, V1.sge(V2));
1724     case ICmpInst::ICMP_ULT: return ConstantInt::get(ResultTy, V1.ult(V2));
1725     case ICmpInst::ICMP_UGT: return ConstantInt::get(ResultTy, V1.ugt(V2));
1726     case ICmpInst::ICMP_ULE: return ConstantInt::get(ResultTy, V1.ule(V2));
1727     case ICmpInst::ICMP_UGE: return ConstantInt::get(ResultTy, V1.uge(V2));
1728     }
1729   } else if (isa<ConstantFP>(C1) && isa<ConstantFP>(C2)) {
1730     APFloat C1V = cast<ConstantFP>(C1)->getValueAPF();
1731     APFloat C2V = cast<ConstantFP>(C2)->getValueAPF();
1732     APFloat::cmpResult R = C1V.compare(C2V);
1733     switch (pred) {
1734     default: llvm_unreachable("Invalid FCmp Predicate");
1735     case FCmpInst::FCMP_FALSE: return Constant::getNullValue(ResultTy);
1736     case FCmpInst::FCMP_TRUE:  return Constant::getAllOnesValue(ResultTy);
1737     case FCmpInst::FCMP_UNO:
1738       return ConstantInt::get(ResultTy, R==APFloat::cmpUnordered);
1739     case FCmpInst::FCMP_ORD:
1740       return ConstantInt::get(ResultTy, R!=APFloat::cmpUnordered);
1741     case FCmpInst::FCMP_UEQ:
1742       return ConstantInt::get(ResultTy, R==APFloat::cmpUnordered ||
1743                                         R==APFloat::cmpEqual);
1744     case FCmpInst::FCMP_OEQ:
1745       return ConstantInt::get(ResultTy, R==APFloat::cmpEqual);
1746     case FCmpInst::FCMP_UNE:
1747       return ConstantInt::get(ResultTy, R!=APFloat::cmpEqual);
1748     case FCmpInst::FCMP_ONE:
1749       return ConstantInt::get(ResultTy, R==APFloat::cmpLessThan ||
1750                                         R==APFloat::cmpGreaterThan);
1751     case FCmpInst::FCMP_ULT:
1752       return ConstantInt::get(ResultTy, R==APFloat::cmpUnordered ||
1753                                         R==APFloat::cmpLessThan);
1754     case FCmpInst::FCMP_OLT:
1755       return ConstantInt::get(ResultTy, R==APFloat::cmpLessThan);
1756     case FCmpInst::FCMP_UGT:
1757       return ConstantInt::get(ResultTy, R==APFloat::cmpUnordered ||
1758                                         R==APFloat::cmpGreaterThan);
1759     case FCmpInst::FCMP_OGT:
1760       return ConstantInt::get(ResultTy, R==APFloat::cmpGreaterThan);
1761     case FCmpInst::FCMP_ULE:
1762       return ConstantInt::get(ResultTy, R!=APFloat::cmpGreaterThan);
1763     case FCmpInst::FCMP_OLE:
1764       return ConstantInt::get(ResultTy, R==APFloat::cmpLessThan ||
1765                                         R==APFloat::cmpEqual);
1766     case FCmpInst::FCMP_UGE:
1767       return ConstantInt::get(ResultTy, R!=APFloat::cmpLessThan);
1768     case FCmpInst::FCMP_OGE:
1769       return ConstantInt::get(ResultTy, R==APFloat::cmpGreaterThan ||
1770                                         R==APFloat::cmpEqual);
1771     }
1772   } else if (C1->getType()->isVectorTy()) {
1773     // If we can constant fold the comparison of each element, constant fold
1774     // the whole vector comparison.
1775     SmallVector<Constant*, 4> ResElts;
1776     Type *Ty = IntegerType::get(C1->getContext(), 32);
1777     // Compare the elements, producing an i1 result or constant expr.
1778     for (unsigned i = 0, e = C1->getType()->getVectorNumElements(); i != e;++i){
1779       Constant *C1E =
1780         ConstantExpr::getExtractElement(C1, ConstantInt::get(Ty, i));
1781       Constant *C2E =
1782         ConstantExpr::getExtractElement(C2, ConstantInt::get(Ty, i));
1783
1784       ResElts.push_back(ConstantExpr::getCompare(pred, C1E, C2E));
1785     }
1786
1787     return ConstantVector::get(ResElts);
1788   }
1789
1790   if (C1->getType()->isFloatingPointTy() &&
1791       // Only call evaluateFCmpRelation if we have a constant expr to avoid
1792       // infinite recursive loop
1793       (isa<ConstantExpr>(C1) || isa<ConstantExpr>(C2))) {
1794     int Result = -1;  // -1 = unknown, 0 = known false, 1 = known true.
1795     switch (evaluateFCmpRelation(C1, C2)) {
1796     default: llvm_unreachable("Unknown relation!");
1797     case FCmpInst::FCMP_UNO:
1798     case FCmpInst::FCMP_ORD:
1799     case FCmpInst::FCMP_UEQ:
1800     case FCmpInst::FCMP_UNE:
1801     case FCmpInst::FCMP_ULT:
1802     case FCmpInst::FCMP_UGT:
1803     case FCmpInst::FCMP_ULE:
1804     case FCmpInst::FCMP_UGE:
1805     case FCmpInst::FCMP_TRUE:
1806     case FCmpInst::FCMP_FALSE:
1807     case FCmpInst::BAD_FCMP_PREDICATE:
1808       break; // Couldn't determine anything about these constants.
1809     case FCmpInst::FCMP_OEQ: // We know that C1 == C2
1810       Result = (pred == FCmpInst::FCMP_UEQ || pred == FCmpInst::FCMP_OEQ ||
1811                 pred == FCmpInst::FCMP_ULE || pred == FCmpInst::FCMP_OLE ||
1812                 pred == FCmpInst::FCMP_UGE || pred == FCmpInst::FCMP_OGE);
1813       break;
1814     case FCmpInst::FCMP_OLT: // We know that C1 < C2
1815       Result = (pred == FCmpInst::FCMP_UNE || pred == FCmpInst::FCMP_ONE ||
1816                 pred == FCmpInst::FCMP_ULT || pred == FCmpInst::FCMP_OLT ||
1817                 pred == FCmpInst::FCMP_ULE || pred == FCmpInst::FCMP_OLE);
1818       break;
1819     case FCmpInst::FCMP_OGT: // We know that C1 > C2
1820       Result = (pred == FCmpInst::FCMP_UNE || pred == FCmpInst::FCMP_ONE ||
1821                 pred == FCmpInst::FCMP_UGT || pred == FCmpInst::FCMP_OGT ||
1822                 pred == FCmpInst::FCMP_UGE || pred == FCmpInst::FCMP_OGE);
1823       break;
1824     case FCmpInst::FCMP_OLE: // We know that C1 <= C2
1825       // We can only partially decide this relation.
1826       if (pred == FCmpInst::FCMP_UGT || pred == FCmpInst::FCMP_OGT)
1827         Result = 0;
1828       else if (pred == FCmpInst::FCMP_ULT || pred == FCmpInst::FCMP_OLT)
1829         Result = 1;
1830       break;
1831     case FCmpInst::FCMP_OGE: // We known that C1 >= C2
1832       // We can only partially decide this relation.
1833       if (pred == FCmpInst::FCMP_ULT || pred == FCmpInst::FCMP_OLT)
1834         Result = 0;
1835       else if (pred == FCmpInst::FCMP_UGT || pred == FCmpInst::FCMP_OGT)
1836         Result = 1;
1837       break;
1838     case FCmpInst::FCMP_ONE: // We know that C1 != C2
1839       // We can only partially decide this relation.
1840       if (pred == FCmpInst::FCMP_OEQ || pred == FCmpInst::FCMP_UEQ)
1841         Result = 0;
1842       else if (pred == FCmpInst::FCMP_ONE || pred == FCmpInst::FCMP_UNE)
1843         Result = 1;
1844       break;
1845     }
1846
1847     // If we evaluated the result, return it now.
1848     if (Result != -1)
1849       return ConstantInt::get(ResultTy, Result);
1850
1851   } else {
1852     // Evaluate the relation between the two constants, per the predicate.
1853     int Result = -1;  // -1 = unknown, 0 = known false, 1 = known true.
1854     switch (evaluateICmpRelation(C1, C2, CmpInst::isSigned(pred))) {
1855     default: llvm_unreachable("Unknown relational!");
1856     case ICmpInst::BAD_ICMP_PREDICATE:
1857       break;  // Couldn't determine anything about these constants.
1858     case ICmpInst::ICMP_EQ:   // We know the constants are equal!
1859       // If we know the constants are equal, we can decide the result of this
1860       // computation precisely.
1861       Result = ICmpInst::isTrueWhenEqual((ICmpInst::Predicate)pred);
1862       break;
1863     case ICmpInst::ICMP_ULT:
1864       switch (pred) {
1865       case ICmpInst::ICMP_ULT: case ICmpInst::ICMP_NE: case ICmpInst::ICMP_ULE:
1866         Result = 1; break;
1867       case ICmpInst::ICMP_UGT: case ICmpInst::ICMP_EQ: case ICmpInst::ICMP_UGE:
1868         Result = 0; break;
1869       }
1870       break;
1871     case ICmpInst::ICMP_SLT:
1872       switch (pred) {
1873       case ICmpInst::ICMP_SLT: case ICmpInst::ICMP_NE: case ICmpInst::ICMP_SLE:
1874         Result = 1; break;
1875       case ICmpInst::ICMP_SGT: case ICmpInst::ICMP_EQ: case ICmpInst::ICMP_SGE:
1876         Result = 0; break;
1877       }
1878       break;
1879     case ICmpInst::ICMP_UGT:
1880       switch (pred) {
1881       case ICmpInst::ICMP_UGT: case ICmpInst::ICMP_NE: case ICmpInst::ICMP_UGE:
1882         Result = 1; break;
1883       case ICmpInst::ICMP_ULT: case ICmpInst::ICMP_EQ: case ICmpInst::ICMP_ULE:
1884         Result = 0; break;
1885       }
1886       break;
1887     case ICmpInst::ICMP_SGT:
1888       switch (pred) {
1889       case ICmpInst::ICMP_SGT: case ICmpInst::ICMP_NE: case ICmpInst::ICMP_SGE:
1890         Result = 1; break;
1891       case ICmpInst::ICMP_SLT: case ICmpInst::ICMP_EQ: case ICmpInst::ICMP_SLE:
1892         Result = 0; break;
1893       }
1894       break;
1895     case ICmpInst::ICMP_ULE:
1896       if (pred == ICmpInst::ICMP_UGT) Result = 0;
1897       if (pred == ICmpInst::ICMP_ULT || pred == ICmpInst::ICMP_ULE) Result = 1;
1898       break;
1899     case ICmpInst::ICMP_SLE:
1900       if (pred == ICmpInst::ICMP_SGT) Result = 0;
1901       if (pred == ICmpInst::ICMP_SLT || pred == ICmpInst::ICMP_SLE) Result = 1;
1902       break;
1903     case ICmpInst::ICMP_UGE:
1904       if (pred == ICmpInst::ICMP_ULT) Result = 0;
1905       if (pred == ICmpInst::ICMP_UGT || pred == ICmpInst::ICMP_UGE) Result = 1;
1906       break;
1907     case ICmpInst::ICMP_SGE:
1908       if (pred == ICmpInst::ICMP_SLT) Result = 0;
1909       if (pred == ICmpInst::ICMP_SGT || pred == ICmpInst::ICMP_SGE) Result = 1;
1910       break;
1911     case ICmpInst::ICMP_NE:
1912       if (pred == ICmpInst::ICMP_EQ) Result = 0;
1913       if (pred == ICmpInst::ICMP_NE) Result = 1;
1914       break;
1915     }
1916
1917     // If we evaluated the result, return it now.
1918     if (Result != -1)
1919       return ConstantInt::get(ResultTy, Result);
1920
1921     // If the right hand side is a bitcast, try using its inverse to simplify
1922     // it by moving it to the left hand side.  We can't do this if it would turn
1923     // a vector compare into a scalar compare or visa versa.
1924     if (ConstantExpr *CE2 = dyn_cast<ConstantExpr>(C2)) {
1925       Constant *CE2Op0 = CE2->getOperand(0);
1926       if (CE2->getOpcode() == Instruction::BitCast &&
1927           CE2->getType()->isVectorTy() == CE2Op0->getType()->isVectorTy()) {
1928         Constant *Inverse = ConstantExpr::getBitCast(C1, CE2Op0->getType());
1929         return ConstantExpr::getICmp(pred, Inverse, CE2Op0);
1930       }
1931     }
1932
1933     // If the left hand side is an extension, try eliminating it.
1934     if (ConstantExpr *CE1 = dyn_cast<ConstantExpr>(C1)) {
1935       if ((CE1->getOpcode() == Instruction::SExt && ICmpInst::isSigned(pred)) ||
1936           (CE1->getOpcode() == Instruction::ZExt && !ICmpInst::isSigned(pred))){
1937         Constant *CE1Op0 = CE1->getOperand(0);
1938         Constant *CE1Inverse = ConstantExpr::getTrunc(CE1, CE1Op0->getType());
1939         if (CE1Inverse == CE1Op0) {
1940           // Check whether we can safely truncate the right hand side.
1941           Constant *C2Inverse = ConstantExpr::getTrunc(C2, CE1Op0->getType());
1942           if (ConstantExpr::getCast(CE1->getOpcode(), C2Inverse,
1943                                     C2->getType()) == C2)
1944             return ConstantExpr::getICmp(pred, CE1Inverse, C2Inverse);
1945         }
1946       }
1947     }
1948
1949     if ((!isa<ConstantExpr>(C1) && isa<ConstantExpr>(C2)) ||
1950         (C1->isNullValue() && !C2->isNullValue())) {
1951       // If C2 is a constant expr and C1 isn't, flip them around and fold the
1952       // other way if possible.
1953       // Also, if C1 is null and C2 isn't, flip them around.
1954       pred = ICmpInst::getSwappedPredicate((ICmpInst::Predicate)pred);
1955       return ConstantExpr::getICmp(pred, C2, C1);
1956     }
1957   }
1958   return nullptr;
1959 }
1960
1961 /// isInBoundsIndices - Test whether the given sequence of *normalized* indices
1962 /// is "inbounds".
1963 template<typename IndexTy>
1964 static bool isInBoundsIndices(ArrayRef<IndexTy> Idxs) {
1965   // No indices means nothing that could be out of bounds.
1966   if (Idxs.empty()) return true;
1967
1968   // If the first index is zero, it's in bounds.
1969   if (cast<Constant>(Idxs[0])->isNullValue()) return true;
1970
1971   // If the first index is one and all the rest are zero, it's in bounds,
1972   // by the one-past-the-end rule.
1973   if (!cast<ConstantInt>(Idxs[0])->isOne())
1974     return false;
1975   for (unsigned i = 1, e = Idxs.size(); i != e; ++i)
1976     if (!cast<Constant>(Idxs[i])->isNullValue())
1977       return false;
1978   return true;
1979 }
1980
1981 /// \brief Test whether a given ConstantInt is in-range for a SequentialType.
1982 static bool isIndexInRangeOfSequentialType(const SequentialType *STy,
1983                                            const ConstantInt *CI) {
1984   if (const PointerType *PTy = dyn_cast<PointerType>(STy))
1985     // Only handle pointers to sized types, not pointers to functions.
1986     return PTy->getElementType()->isSized();
1987
1988   uint64_t NumElements = 0;
1989   // Determine the number of elements in our sequential type.
1990   if (const ArrayType *ATy = dyn_cast<ArrayType>(STy))
1991     NumElements = ATy->getNumElements();
1992   else if (const VectorType *VTy = dyn_cast<VectorType>(STy))
1993     NumElements = VTy->getNumElements();
1994
1995   assert((isa<ArrayType>(STy) || NumElements > 0) &&
1996          "didn't expect non-array type to have zero elements!");
1997
1998   // We cannot bounds check the index if it doesn't fit in an int64_t.
1999   if (CI->getValue().getActiveBits() > 64)
2000     return false;
2001
2002   // A negative index or an index past the end of our sequential type is
2003   // considered out-of-range.
2004   int64_t IndexVal = CI->getSExtValue();
2005   if (IndexVal < 0 || (NumElements > 0 && (uint64_t)IndexVal >= NumElements))
2006     return false;
2007
2008   // Otherwise, it is in-range.
2009   return true;
2010 }
2011
2012 template<typename IndexTy>
2013 static Constant *ConstantFoldGetElementPtrImpl(Constant *C,
2014                                                bool inBounds,
2015                                                ArrayRef<IndexTy> Idxs) {
2016   if (Idxs.empty()) return C;
2017   Constant *Idx0 = cast<Constant>(Idxs[0]);
2018   if ((Idxs.size() == 1 && Idx0->isNullValue()))
2019     return C;
2020
2021   if (isa<UndefValue>(C)) {
2022     PointerType *Ptr = cast<PointerType>(C->getType());
2023     Type *Ty = GetElementPtrInst::getIndexedType(Ptr, Idxs);
2024     assert(Ty && "Invalid indices for GEP!");
2025     return UndefValue::get(PointerType::get(Ty, Ptr->getAddressSpace()));
2026   }
2027
2028   if (C->isNullValue()) {
2029     bool isNull = true;
2030     for (unsigned i = 0, e = Idxs.size(); i != e; ++i)
2031       if (!cast<Constant>(Idxs[i])->isNullValue()) {
2032         isNull = false;
2033         break;
2034       }
2035     if (isNull) {
2036       PointerType *Ptr = cast<PointerType>(C->getType());
2037       Type *Ty = GetElementPtrInst::getIndexedType(Ptr, Idxs);
2038       assert(Ty && "Invalid indices for GEP!");
2039       return ConstantPointerNull::get(PointerType::get(Ty,
2040                                                        Ptr->getAddressSpace()));
2041     }
2042   }
2043
2044   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
2045     // Combine Indices - If the source pointer to this getelementptr instruction
2046     // is a getelementptr instruction, combine the indices of the two
2047     // getelementptr instructions into a single instruction.
2048     //
2049     if (CE->getOpcode() == Instruction::GetElementPtr) {
2050       Type *LastTy = nullptr;
2051       for (gep_type_iterator I = gep_type_begin(CE), E = gep_type_end(CE);
2052            I != E; ++I)
2053         LastTy = *I;
2054
2055       // We cannot combine indices if doing so would take us outside of an
2056       // array or vector.  Doing otherwise could trick us if we evaluated such a
2057       // GEP as part of a load.
2058       //
2059       // e.g. Consider if the original GEP was:
2060       // i8* getelementptr ({ [2 x i8], i32, i8, [3 x i8] }* @main.c,
2061       //                    i32 0, i32 0, i64 0)
2062       //
2063       // If we then tried to offset it by '8' to get to the third element,
2064       // an i8, we should *not* get:
2065       // i8* getelementptr ({ [2 x i8], i32, i8, [3 x i8] }* @main.c,
2066       //                    i32 0, i32 0, i64 8)
2067       //
2068       // This GEP tries to index array element '8  which runs out-of-bounds.
2069       // Subsequent evaluation would get confused and produce erroneous results.
2070       //
2071       // The following prohibits such a GEP from being formed by checking to see
2072       // if the index is in-range with respect to an array or vector.
2073       bool PerformFold = false;
2074       if (Idx0->isNullValue())
2075         PerformFold = true;
2076       else if (SequentialType *STy = dyn_cast_or_null<SequentialType>(LastTy))
2077         if (ConstantInt *CI = dyn_cast<ConstantInt>(Idx0))
2078           PerformFold = isIndexInRangeOfSequentialType(STy, CI);
2079
2080       if (PerformFold) {
2081         SmallVector<Value*, 16> NewIndices;
2082         NewIndices.reserve(Idxs.size() + CE->getNumOperands());
2083         NewIndices.append(CE->op_begin() + 1, CE->op_end() - 1);
2084
2085         // Add the last index of the source with the first index of the new GEP.
2086         // Make sure to handle the case when they are actually different types.
2087         Constant *Combined = CE->getOperand(CE->getNumOperands()-1);
2088         // Otherwise it must be an array.
2089         if (!Idx0->isNullValue()) {
2090           Type *IdxTy = Combined->getType();
2091           if (IdxTy != Idx0->getType()) {
2092             unsigned CommonExtendedWidth =
2093                 std::max(IdxTy->getIntegerBitWidth(),
2094                          Idx0->getType()->getIntegerBitWidth());
2095             CommonExtendedWidth = std::max(CommonExtendedWidth, 64U);
2096
2097             Type *CommonTy =
2098                 Type::getIntNTy(IdxTy->getContext(), CommonExtendedWidth);
2099             Constant *C1 = ConstantExpr::getSExtOrBitCast(Idx0, CommonTy);
2100             Constant *C2 = ConstantExpr::getSExtOrBitCast(Combined, CommonTy);
2101             Combined = ConstantExpr::get(Instruction::Add, C1, C2);
2102           } else {
2103             Combined =
2104               ConstantExpr::get(Instruction::Add, Idx0, Combined);
2105           }
2106         }
2107
2108         NewIndices.push_back(Combined);
2109         NewIndices.append(Idxs.begin() + 1, Idxs.end());
2110         return
2111           ConstantExpr::getGetElementPtr(CE->getOperand(0), NewIndices,
2112                                          inBounds &&
2113                                            cast<GEPOperator>(CE)->isInBounds());
2114       }
2115     }
2116
2117     // Attempt to fold casts to the same type away.  For example, folding:
2118     //
2119     //   i32* getelementptr ([2 x i32]* bitcast ([3 x i32]* %X to [2 x i32]*),
2120     //                       i64 0, i64 0)
2121     // into:
2122     //
2123     //   i32* getelementptr ([3 x i32]* %X, i64 0, i64 0)
2124     //
2125     // Don't fold if the cast is changing address spaces.
2126     if (CE->isCast() && Idxs.size() > 1 && Idx0->isNullValue()) {
2127       PointerType *SrcPtrTy =
2128         dyn_cast<PointerType>(CE->getOperand(0)->getType());
2129       PointerType *DstPtrTy = dyn_cast<PointerType>(CE->getType());
2130       if (SrcPtrTy && DstPtrTy) {
2131         ArrayType *SrcArrayTy =
2132           dyn_cast<ArrayType>(SrcPtrTy->getElementType());
2133         ArrayType *DstArrayTy =
2134           dyn_cast<ArrayType>(DstPtrTy->getElementType());
2135         if (SrcArrayTy && DstArrayTy
2136             && SrcArrayTy->getElementType() == DstArrayTy->getElementType()
2137             && SrcPtrTy->getAddressSpace() == DstPtrTy->getAddressSpace())
2138           return ConstantExpr::getGetElementPtr((Constant*)CE->getOperand(0),
2139                                                 Idxs, inBounds);
2140       }
2141     }
2142   }
2143
2144   // Check to see if any array indices are not within the corresponding
2145   // notional array or vector bounds. If so, try to determine if they can be
2146   // factored out into preceding dimensions.
2147   bool Unknown = false;
2148   SmallVector<Constant *, 8> NewIdxs;
2149   Type *Ty = C->getType();
2150   Type *Prev = nullptr;
2151   for (unsigned i = 0, e = Idxs.size(); i != e;
2152        Prev = Ty, Ty = cast<CompositeType>(Ty)->getTypeAtIndex(Idxs[i]), ++i) {
2153     if (ConstantInt *CI = dyn_cast<ConstantInt>(Idxs[i])) {
2154       if (isa<ArrayType>(Ty) || isa<VectorType>(Ty))
2155         if (CI->getSExtValue() > 0 &&
2156             !isIndexInRangeOfSequentialType(cast<SequentialType>(Ty), CI)) {
2157           if (isa<SequentialType>(Prev)) {
2158             // It's out of range, but we can factor it into the prior
2159             // dimension.
2160             NewIdxs.resize(Idxs.size());
2161             uint64_t NumElements = 0;
2162             if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty))
2163               NumElements = ATy->getNumElements();
2164             else
2165               NumElements = cast<VectorType>(Ty)->getNumElements();
2166
2167             ConstantInt *Factor = ConstantInt::get(CI->getType(), NumElements);
2168             NewIdxs[i] = ConstantExpr::getSRem(CI, Factor);
2169
2170             Constant *PrevIdx = cast<Constant>(Idxs[i-1]);
2171             Constant *Div = ConstantExpr::getSDiv(CI, Factor);
2172
2173             unsigned CommonExtendedWidth =
2174                 std::max(PrevIdx->getType()->getIntegerBitWidth(),
2175                          Div->getType()->getIntegerBitWidth());
2176             CommonExtendedWidth = std::max(CommonExtendedWidth, 64U);
2177
2178             // Before adding, extend both operands to i64 to avoid
2179             // overflow trouble.
2180             if (!PrevIdx->getType()->isIntegerTy(CommonExtendedWidth))
2181               PrevIdx = ConstantExpr::getSExt(
2182                   PrevIdx,
2183                   Type::getIntNTy(Div->getContext(), CommonExtendedWidth));
2184             if (!Div->getType()->isIntegerTy(CommonExtendedWidth))
2185               Div = ConstantExpr::getSExt(
2186                   Div, Type::getIntNTy(Div->getContext(), CommonExtendedWidth));
2187
2188             NewIdxs[i-1] = ConstantExpr::getAdd(PrevIdx, Div);
2189           } else {
2190             // It's out of range, but the prior dimension is a struct
2191             // so we can't do anything about it.
2192             Unknown = true;
2193           }
2194         }
2195     } else {
2196       // We don't know if it's in range or not.
2197       Unknown = true;
2198     }
2199   }
2200
2201   // If we did any factoring, start over with the adjusted indices.
2202   if (!NewIdxs.empty()) {
2203     for (unsigned i = 0, e = Idxs.size(); i != e; ++i)
2204       if (!NewIdxs[i]) NewIdxs[i] = cast<Constant>(Idxs[i]);
2205     return ConstantExpr::getGetElementPtr(C, NewIdxs, inBounds);
2206   }
2207
2208   // If all indices are known integers and normalized, we can do a simple
2209   // check for the "inbounds" property.
2210   if (!Unknown && !inBounds)
2211     if (auto *GV = dyn_cast<GlobalVariable>(C))
2212       if (!GV->hasExternalWeakLinkage() && isInBoundsIndices(Idxs))
2213         return ConstantExpr::getInBoundsGetElementPtr(C, Idxs);
2214
2215   return nullptr;
2216 }
2217
2218 Constant *llvm::ConstantFoldGetElementPtr(Constant *C,
2219                                           bool inBounds,
2220                                           ArrayRef<Constant *> Idxs) {
2221   return ConstantFoldGetElementPtrImpl(C, inBounds, Idxs);
2222 }
2223
2224 Constant *llvm::ConstantFoldGetElementPtr(Constant *C,
2225                                           bool inBounds,
2226                                           ArrayRef<Value *> Idxs) {
2227   return ConstantFoldGetElementPtrImpl(C, inBounds, Idxs);
2228 }