lib/IR/ConstantFold.cpp

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