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