lib/VMCore/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 // template-based folder for simple primitive constants like ConstantInt, and
  16 // the special case hackery that we use to symbolically evaluate expressions
  17 // that use ConstantExprs.
  18 //
  19 //===----------------------------------------------------------------------===//
  20
  21 #include "ConstantFold.h"
  22 #include "llvm/Constants.h"
  23 #include "llvm/Instructions.h"
  24 #include "llvm/DerivedTypes.h"
  25 #include "llvm/Function.h"
  26 #include "llvm/GlobalAlias.h"
  27 #include "llvm/ADT/SmallVector.h"
  28 #include "llvm/Support/Compiler.h"
  29 #include "llvm/Support/GetElementPtrTypeIterator.h"
  30 #include "llvm/Support/ManagedStatic.h"
  31 #include "llvm/Support/MathExtras.h"
  32 #include <limits>
  33 using namespace llvm;
  34
  35 //===----------------------------------------------------------------------===//
  36 //                ConstantFold*Instruction Implementations
  37 //===----------------------------------------------------------------------===//
  38
  39 /// BitCastConstantVector - Convert the specified ConstantVector node to the
  40 /// specified vector type.  At this point, we know that the elements of the
  41 /// input vector constant are all simple integer or FP values.
  42 static Constant *BitCastConstantVector(ConstantVector *CV,
  43                                        const VectorType *DstTy) {
  44   // If this cast changes element count then we can't handle it here:
  45   // doing so requires endianness information.  This should be handled by
  46   // Analysis/ConstantFolding.cpp
  47   unsigned NumElts = DstTy->getNumElements();
  48   if (NumElts != CV->getNumOperands())
  49     return 0;
  50
  51   // Check to verify that all elements of the input are simple.
  52   for (unsigned i = 0; i != NumElts; ++i) {
  53     if (!isa<ConstantInt>(CV->getOperand(i)) &&
  54         !isa<ConstantFP>(CV->getOperand(i)))
  55       return 0;
  56   }
  57
  58   // Bitcast each element now.
  59   std::vector<Constant*> Result;
  60   const Type *DstEltTy = DstTy->getElementType();
  61   for (unsigned i = 0; i != NumElts; ++i)
  62     Result.push_back(ConstantExpr::getBitCast(CV->getOperand(i), DstEltTy));
  63   return ConstantVector::get(Result);
  64 }
  65
  66 /// This function determines which opcode to use to fold two constant cast
  67 /// expressions together. It uses CastInst::isEliminableCastPair to determine
  68 /// the opcode. Consequently its just a wrapper around that function.
  69 /// @brief Determine if it is valid to fold a cast of a cast
  70 static unsigned
  71 foldConstantCastPair(
  72   unsigned opc,          ///< opcode of the second cast constant expression
  73   const ConstantExpr*Op, ///< the first cast constant expression
  74   const Type *DstTy      ///< desintation type of the first cast
  75 ) {
  76   assert(Op && Op->isCast() && "Can't fold cast of cast without a cast!");
  77   assert(DstTy && DstTy->isFirstClassType() && "Invalid cast destination type");
  78   assert(CastInst::isCast(opc) && "Invalid cast opcode");
  79
  80   // The the types and opcodes for the two Cast constant expressions
  81   const Type *SrcTy = Op->getOperand(0)->getType();
  82   const Type *MidTy = Op->getType();
  83   Instruction::CastOps firstOp = Instruction::CastOps(Op->getOpcode());
  84   Instruction::CastOps secondOp = Instruction::CastOps(opc);
  85
  86   // Let CastInst::isEliminableCastPair do the heavy lifting.
  87   return CastInst::isEliminableCastPair(firstOp, secondOp, SrcTy, MidTy, DstTy,
  88                                         Type::Int64Ty);
  89 }
  90
  91 static Constant *FoldBitCast(Constant *V, const Type *DestTy) {
  92   const Type *SrcTy = V->getType();
  93   if (SrcTy == DestTy)
  94     return V; // no-op cast
  95
  96   // Check to see if we are casting a pointer to an aggregate to a pointer to
  97   // the first element.  If so, return the appropriate GEP instruction.
  98   if (const PointerType *PTy = dyn_cast<PointerType>(V->getType()))
  99     if (const PointerType *DPTy = dyn_cast<PointerType>(DestTy))
 100       if (PTy->getAddressSpace() == DPTy->getAddressSpace()) {
 101         SmallVector<Value*, 8> IdxList;
 102         IdxList.push_back(Constant::getNullValue(Type::Int32Ty));
 103         const Type *ElTy = PTy->getElementType();
 104         while (ElTy != DPTy->getElementType()) {
 105           if (const StructType *STy = dyn_cast<StructType>(ElTy)) {
 106             if (STy->getNumElements() == 0) break;
 107             ElTy = STy->getElementType(0);
 108             IdxList.push_back(Constant::getNullValue(Type::Int32Ty));
 109           } else if (const SequentialType *STy =
 110                      dyn_cast<SequentialType>(ElTy)) {
 111             if (isa<PointerType>(ElTy)) break;  // Can't index into pointers!
 112             ElTy = STy->getElementType();
 113             IdxList.push_back(IdxList[0]);
 114           } else {
 115             break;
 116           }
 117         }
 118
 119         if (ElTy == DPTy->getElementType())
 120           return ConstantExpr::getGetElementPtr(V, &IdxList[0], IdxList.size());
 121       }
 122
 123   // Handle casts from one vector constant to another.  We know that the src
 124   // and dest type have the same size (otherwise its an illegal cast).
 125   if (const VectorType *DestPTy = dyn_cast<VectorType>(DestTy)) {
 126     if (const VectorType *SrcTy = dyn_cast<VectorType>(V->getType())) {
 127       assert(DestPTy->getBitWidth() == SrcTy->getBitWidth() &&
 128              "Not cast between same sized vectors!");
 129       SrcTy = NULL;
 130       // First, check for null.  Undef is already handled.
 131       if (isa<ConstantAggregateZero>(V))
 132         return Constant::getNullValue(DestTy);
 133
 134       if (ConstantVector *CV = dyn_cast<ConstantVector>(V))
 135         return BitCastConstantVector(CV, DestPTy);
 136     }
 137
 138     // Canonicalize scalar-to-vector bitcasts into vector-to-vector bitcasts
 139     // This allows for other simplifications (although some of them
 140     // can only be handled by Analysis/ConstantFolding.cpp).
 141     if (isa<ConstantInt>(V) || isa<ConstantFP>(V))
 142       return ConstantExpr::getBitCast(ConstantVector::get(&V, 1), DestPTy);
 143   }
 144
 145   // Finally, implement bitcast folding now.   The code below doesn't handle
 146   // bitcast right.
 147   if (isa<ConstantPointerNull>(V))  // ptr->ptr cast.
 148     return ConstantPointerNull::get(cast<PointerType>(DestTy));
 149
 150   // Handle integral constant input.
 151   if (const ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
 152     if (DestTy->isInteger())
 153       // Integral -> Integral. This is a no-op because the bit widths must
 154       // be the same. Consequently, we just fold to V.
 155       return V;
 156
 157     if (DestTy->isFloatingPoint()) {
 158       assert((DestTy == Type::DoubleTy || DestTy == Type::FloatTy) &&
 159              "Unknown FP type!");
 160       return ConstantFP::get(APFloat(CI->getValue()));
 161     }
 162     // Otherwise, can't fold this (vector?)
 163     return 0;
 164   }
 165
 166   // Handle ConstantFP input.
 167   if (const ConstantFP *FP = dyn_cast<ConstantFP>(V)) {
 168     // FP -> Integral.
 169     if (DestTy == Type::Int32Ty) {
 170       return ConstantInt::get(FP->getValueAPF().bitcastToAPInt());
 171     } else {
 172       assert(DestTy == Type::Int64Ty && "only support f32/f64 for now!");
 173       return ConstantInt::get(FP->getValueAPF().bitcastToAPInt());
 174     }
 175   }
 176   return 0;
 177 }
 178
 179
 180 Constant *llvm::ConstantFoldCastInstruction(unsigned opc, const Constant *V,
 181                                             const Type *DestTy) {
 182   if (isa<UndefValue>(V)) {
 183     // zext(undef) = 0, because the top bits will be zero.
 184     // sext(undef) = 0, because the top bits will all be the same.
 185     // [us]itofp(undef) = 0, because the result value is bounded.
 186     if (opc == Instruction::ZExt || opc == Instruction::SExt ||
 187         opc == Instruction::UIToFP || opc == Instruction::SIToFP)
 188       return Constant::getNullValue(DestTy);
 189     return UndefValue::get(DestTy);
 190   }
 191   // No compile-time operations on this type yet.
 192   if (V->getType() == Type::PPC_FP128Ty || DestTy == Type::PPC_FP128Ty)
 193     return 0;
 194
 195   // If the cast operand is a constant expression, there's a few things we can
 196   // do to try to simplify it.
 197   if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
 198     if (CE->isCast()) {
 199       // Try hard to fold cast of cast because they are often eliminable.
 200       if (unsigned newOpc = foldConstantCastPair(opc, CE, DestTy))
 201         return ConstantExpr::getCast(newOpc, CE->getOperand(0), DestTy);
 202     } else if (CE->getOpcode() == Instruction::GetElementPtr) {
 203       // If all of the indexes in the GEP are null values, there is no pointer
 204       // adjustment going on.  We might as well cast the source pointer.
 205       bool isAllNull = true;
 206       for (unsigned i = 1, e = CE->getNumOperands(); i != e; ++i)
 207         if (!CE->getOperand(i)->isNullValue()) {
 208           isAllNull = false;
 209           break;
 210         }
 211       if (isAllNull)
 212         // This is casting one pointer type to another, always BitCast
 213         return ConstantExpr::getPointerCast(CE->getOperand(0), DestTy);
 214     }
 215   }
 216
 217   // We actually have to do a cast now. Perform the cast according to the
 218   // opcode specified.
 219   switch (opc) {
 220   case Instruction::FPTrunc:
 221   case Instruction::FPExt:
 222     if (const ConstantFP *FPC = dyn_cast<ConstantFP>(V)) {
 223       bool ignored;
 224       APFloat Val = FPC->getValueAPF();
 225       Val.convert(DestTy == Type::FloatTy ? APFloat::IEEEsingle :
 226                   DestTy == Type::DoubleTy ? APFloat::IEEEdouble :
 227                   DestTy == Type::X86_FP80Ty ? APFloat::x87DoubleExtended :
 228                   DestTy == Type::FP128Ty ? APFloat::IEEEquad :
 229                   APFloat::Bogus,
 230                   APFloat::rmNearestTiesToEven, &ignored);
 231       return ConstantFP::get(Val);
 232     }
 233     return 0; // Can't fold.
 234   case Instruction::FPToUI:
 235   case Instruction::FPToSI:
 236     if (const ConstantFP *FPC = dyn_cast<ConstantFP>(V)) {
 237       const APFloat &V = FPC->getValueAPF();
 238       bool ignored;
 239       uint64_t x[2];
 240       uint32_t DestBitWidth = cast<IntegerType>(DestTy)->getBitWidth();
 241       (void) V.convertToInteger(x, DestBitWidth, opc==Instruction::FPToSI,
 242                                 APFloat::rmTowardZero, &ignored);
 243       APInt Val(DestBitWidth, 2, x);
 244       return ConstantInt::get(Val);
 245     }
 246     if (const ConstantVector *CV = dyn_cast<ConstantVector>(V)) {
 247       std::vector<Constant*> res;
 248       const VectorType *DestVecTy = cast<VectorType>(DestTy);
 249       const Type *DstEltTy = DestVecTy->getElementType();
 250       for (unsigned i = 0, e = CV->getType()->getNumElements(); i != e; ++i)
 251         res.push_back(ConstantExpr::getCast(opc, CV->getOperand(i), DstEltTy));
 252       return ConstantVector::get(DestVecTy, res);
 253     }
 254     return 0; // Can't fold.
 255   case Instruction::IntToPtr:   //always treated as unsigned
 256     if (V->isNullValue())       // Is it an integral null value?
 257       return ConstantPointerNull::get(cast<PointerType>(DestTy));
 258     return 0;                   // Other pointer types cannot be casted
 259   case Instruction::PtrToInt:   // always treated as unsigned
 260     if (V->isNullValue())       // is it a null pointer value?
 261       return ConstantInt::get(DestTy, 0);
 262     return 0;                   // Other pointer types cannot be casted
 263   case Instruction::UIToFP:
 264   case Instruction::SIToFP:
 265     if (const ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
 266       APInt api = CI->getValue();
 267       const uint64_t zero[] = {0, 0};
 268       APFloat apf = APFloat(APInt(DestTy->getPrimitiveSizeInBits(),
 269                                   2, zero));
 270       (void)apf.convertFromAPInt(api,
 271                                  opc==Instruction::SIToFP,
 272                                  APFloat::rmNearestTiesToEven);
 273       return ConstantFP::get(apf);
 274     }
 275     if (const ConstantVector *CV = dyn_cast<ConstantVector>(V)) {
 276       std::vector<Constant*> res;
 277       const VectorType *DestVecTy = cast<VectorType>(DestTy);
 278       const Type *DstEltTy = DestVecTy->getElementType();
 279       for (unsigned i = 0, e = CV->getType()->getNumElements(); i != e; ++i)
 280         res.push_back(ConstantExpr::getCast(opc, CV->getOperand(i), DstEltTy));
 281       return ConstantVector::get(DestVecTy, res);
 282     }
 283     return 0;
 284   case Instruction::ZExt:
 285     if (const ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
 286       uint32_t BitWidth = cast<IntegerType>(DestTy)->getBitWidth();
 287       APInt Result(CI->getValue());
 288       Result.zext(BitWidth);
 289       return ConstantInt::get(Result);
 290     }
 291     return 0;
 292   case Instruction::SExt:
 293     if (const ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
 294       uint32_t BitWidth = cast<IntegerType>(DestTy)->getBitWidth();
 295       APInt Result(CI->getValue());
 296       Result.sext(BitWidth);
 297       return ConstantInt::get(Result);
 298     }
 299     return 0;
 300   case Instruction::Trunc:
 301     if (const ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
 302       uint32_t BitWidth = cast<IntegerType>(DestTy)->getBitWidth();
 303       APInt Result(CI->getValue());
 304       Result.trunc(BitWidth);
 305       return ConstantInt::get(Result);
 306     }
 307     return 0;
 308   case Instruction::BitCast:
 309     return FoldBitCast(const_cast<Constant*>(V), DestTy);
 310   default:
 311     assert(!"Invalid CE CastInst opcode");
 312     break;
 313   }
 314
 315   assert(0 && "Failed to cast constant expression");
 316   return 0;
 317 }
 318
 319 Constant *llvm::ConstantFoldSelectInstruction(const Constant *Cond,
 320                                               const Constant *V1,
 321                                               const Constant *V2) {
 322   if (const ConstantInt *CB = dyn_cast<ConstantInt>(Cond))
 323     return const_cast<Constant*>(CB->getZExtValue() ? V1 : V2);
 324
 325   if (isa<UndefValue>(V1)) return const_cast<Constant*>(V2);
 326   if (isa<UndefValue>(V2)) return const_cast<Constant*>(V1);
 327   if (isa<UndefValue>(Cond)) return const_cast<Constant*>(V1);
 328   if (V1 == V2) return const_cast<Constant*>(V1);
 329   return 0;
 330 }
 331
 332 Constant *llvm::ConstantFoldExtractElementInstruction(const Constant *Val,
 333                                                       const Constant *Idx) {
 334   if (isa<UndefValue>(Val))  // ee(undef, x) -> undef
 335     return UndefValue::get(cast<VectorType>(Val->getType())->getElementType());
 336   if (Val->isNullValue())  // ee(zero, x) -> zero
 337     return Constant::getNullValue(
 338                           cast<VectorType>(Val->getType())->getElementType());
 339
 340   if (const ConstantVector *CVal = dyn_cast<ConstantVector>(Val)) {
 341     if (const ConstantInt *CIdx = dyn_cast<ConstantInt>(Idx)) {
 342       return CVal->getOperand(CIdx->getZExtValue());
 343     } else if (isa<UndefValue>(Idx)) {
 344       // ee({w,x,y,z}, undef) -> w (an arbitrary value).
 345       return CVal->getOperand(0);
 346     }
 347   }
 348   return 0;
 349 }
 350
 351 Constant *llvm::ConstantFoldInsertElementInstruction(const Constant *Val,
 352                                                      const Constant *Elt,
 353                                                      const Constant *Idx) {
 354   const ConstantInt *CIdx = dyn_cast<ConstantInt>(Idx);
 355   if (!CIdx) return 0;
 356   APInt idxVal = CIdx->getValue();
 357   if (isa<UndefValue>(Val)) {
 358     // Insertion of scalar constant into vector undef
 359     // Optimize away insertion of undef
 360     if (isa<UndefValue>(Elt))
 361       return const_cast<Constant*>(Val);
 362     // Otherwise break the aggregate undef into multiple undefs and do
 363     // the insertion
 364     unsigned numOps =
 365       cast<VectorType>(Val->getType())->getNumElements();
 366     std::vector<Constant*> Ops;
 367     Ops.reserve(numOps);
 368     for (unsigned i = 0; i < numOps; ++i) {
 369       const Constant *Op =
 370         (idxVal == i) ? Elt : UndefValue::get(Elt->getType());
 371       Ops.push_back(const_cast<Constant*>(Op));
 372     }
 373     return ConstantVector::get(Ops);
 374   }
 375   if (isa<ConstantAggregateZero>(Val)) {
 376     // Insertion of scalar constant into vector aggregate zero
 377     // Optimize away insertion of zero
 378     if (Elt->isNullValue())
 379       return const_cast<Constant*>(Val);
 380     // Otherwise break the aggregate zero into multiple zeros and do
 381     // the insertion
 382     unsigned numOps =
 383       cast<VectorType>(Val->getType())->getNumElements();
 384     std::vector<Constant*> Ops;
 385     Ops.reserve(numOps);
 386     for (unsigned i = 0; i < numOps; ++i) {
 387       const Constant *Op =
 388         (idxVal == i) ? Elt : Constant::getNullValue(Elt->getType());
 389       Ops.push_back(const_cast<Constant*>(Op));
 390     }
 391     return ConstantVector::get(Ops);
 392   }
 393   if (const ConstantVector *CVal = dyn_cast<ConstantVector>(Val)) {
 394     // Insertion of scalar constant into vector constant
 395     std::vector<Constant*> Ops;
 396     Ops.reserve(CVal->getNumOperands());
 397     for (unsigned i = 0; i < CVal->getNumOperands(); ++i) {
 398       const Constant *Op =
 399         (idxVal == i) ? Elt : cast<Constant>(CVal->getOperand(i));
 400       Ops.push_back(const_cast<Constant*>(Op));
 401     }
 402     return ConstantVector::get(Ops);
 403   }
 404
 405   return 0;
 406 }
 407
 408 /// GetVectorElement - If C is a ConstantVector, ConstantAggregateZero or Undef
 409 /// return the specified element value.  Otherwise return null.
 410 static Constant *GetVectorElement(const Constant *C, unsigned EltNo) {
 411   if (const ConstantVector *CV = dyn_cast<ConstantVector>(C))
 412     return CV->getOperand(EltNo);
 413
 414   const Type *EltTy = cast<VectorType>(C->getType())->getElementType();
 415   if (isa<ConstantAggregateZero>(C))
 416     return Constant::getNullValue(EltTy);
 417   if (isa<UndefValue>(C))
 418     return UndefValue::get(EltTy);
 419   return 0;
 420 }
 421
 422 Constant *llvm::ConstantFoldShuffleVectorInstruction(const Constant *V1,
 423                                                      const Constant *V2,
 424                                                      const Constant *Mask) {
 425   // Undefined shuffle mask -> undefined value.
 426   if (isa<UndefValue>(Mask)) return UndefValue::get(V1->getType());
 427
 428   unsigned MaskNumElts = cast<VectorType>(Mask->getType())->getNumElements();
 429   unsigned SrcNumElts = cast<VectorType>(V1->getType())->getNumElements();
 430   const Type *EltTy = cast<VectorType>(V1->getType())->getElementType();
 431
 432   // Loop over the shuffle mask, evaluating each element.
 433   SmallVector<Constant*, 32> Result;
 434   for (unsigned i = 0; i != MaskNumElts; ++i) {
 435     Constant *InElt = GetVectorElement(Mask, i);
 436     if (InElt == 0) return 0;
 437
 438     if (isa<UndefValue>(InElt))
 439       InElt = UndefValue::get(EltTy);
 440     else if (ConstantInt *CI = dyn_cast<ConstantInt>(InElt)) {
 441       unsigned Elt = CI->getZExtValue();
 442       if (Elt >= SrcNumElts*2)
 443         InElt = UndefValue::get(EltTy);
 444       else if (Elt >= SrcNumElts)
 445         InElt = GetVectorElement(V2, Elt - SrcNumElts);
 446       else
 447         InElt = GetVectorElement(V1, Elt);
 448       if (InElt == 0) return 0;
 449     } else {
 450       // Unknown value.
 451       return 0;
 452     }
 453     Result.push_back(InElt);
 454   }
 455
 456   return ConstantVector::get(&Result[0], Result.size());
 457 }
 458
 459 Constant *llvm::ConstantFoldExtractValueInstruction(const Constant *Agg,
 460                                                     const unsigned *Idxs,
 461                                                     unsigned NumIdx) {
 462   // Base case: no indices, so return the entire value.
 463   if (NumIdx == 0)
 464     return const_cast<Constant *>(Agg);
 465
 466   if (isa<UndefValue>(Agg))  // ev(undef, x) -> undef
 467     return UndefValue::get(ExtractValueInst::getIndexedType(Agg->getType(),
 468                                                             Idxs,
 469                                                             Idxs + NumIdx));
 470
 471   if (isa<ConstantAggregateZero>(Agg))  // ev(0, x) -> 0
 472     return
 473       Constant::getNullValue(ExtractValueInst::getIndexedType(Agg->getType(),
 474                                                               Idxs,
 475                                                               Idxs + NumIdx));
 476
 477   // Otherwise recurse.
 478   return ConstantFoldExtractValueInstruction(Agg->getOperand(*Idxs),
 479                                              Idxs+1, NumIdx-1);
 480 }
 481
 482 Constant *llvm::ConstantFoldInsertValueInstruction(const Constant *Agg,
 483                                                    const Constant *Val,
 484                                                    const unsigned *Idxs,
 485                                                    unsigned NumIdx) {
 486   // Base case: no indices, so replace the entire value.
 487   if (NumIdx == 0)
 488     return const_cast<Constant *>(Val);
 489
 490   if (isa<UndefValue>(Agg)) {
 491     // Insertion of constant into aggregate undef
 492     // Optimize away insertion of undef
 493     if (isa<UndefValue>(Val))
 494       return const_cast<Constant*>(Agg);
 495     // Otherwise break the aggregate undef into multiple undefs and do
 496     // the insertion
 497     const CompositeType *AggTy = cast<CompositeType>(Agg->getType());
 498     unsigned numOps;
 499     if (const ArrayType *AR = dyn_cast<ArrayType>(AggTy))
 500       numOps = AR->getNumElements();
 501     else
 502       numOps = cast<StructType>(AggTy)->getNumElements();
 503     std::vector<Constant*> Ops(numOps);
 504     for (unsigned i = 0; i < numOps; ++i) {
 505       const Type *MemberTy = AggTy->getTypeAtIndex(i);
 506       const Constant *Op =
 507         (*Idxs == i) ?
 508         ConstantFoldInsertValueInstruction(UndefValue::get(MemberTy),
 509                                            Val, Idxs+1, NumIdx-1) :
 510         UndefValue::get(MemberTy);
 511       Ops[i] = const_cast<Constant*>(Op);
 512     }
 513     if (isa<StructType>(AggTy))
 514       return ConstantStruct::get(Ops);
 515     else
 516       return ConstantArray::get(cast<ArrayType>(AggTy), Ops);
 517   }
 518   if (isa<ConstantAggregateZero>(Agg)) {
 519     // Insertion of constant into aggregate zero
 520     // Optimize away insertion of zero
 521     if (Val->isNullValue())
 522       return const_cast<Constant*>(Agg);
 523     // Otherwise break the aggregate zero into multiple zeros and do
 524     // the insertion
 525     const CompositeType *AggTy = cast<CompositeType>(Agg->getType());
 526     unsigned numOps;
 527     if (const ArrayType *AR = dyn_cast<ArrayType>(AggTy))
 528       numOps = AR->getNumElements();
 529     else
 530       numOps = cast<StructType>(AggTy)->getNumElements();
 531     std::vector<Constant*> Ops(numOps);
 532     for (unsigned i = 0; i < numOps; ++i) {
 533       const Type *MemberTy = AggTy->getTypeAtIndex(i);
 534       const Constant *Op =
 535         (*Idxs == i) ?
 536         ConstantFoldInsertValueInstruction(Constant::getNullValue(MemberTy),
 537                                            Val, Idxs+1, NumIdx-1) :
 538         Constant::getNullValue(MemberTy);
 539       Ops[i] = const_cast<Constant*>(Op);
 540     }
 541     if (isa<StructType>(AggTy))
 542       return ConstantStruct::get(Ops);
 543     else
 544       return ConstantArray::get(cast<ArrayType>(AggTy), Ops);
 545   }
 546   if (isa<ConstantStruct>(Agg) || isa<ConstantArray>(Agg)) {
 547     // Insertion of constant into aggregate constant
 548     std::vector<Constant*> Ops(Agg->getNumOperands());
 549     for (unsigned i = 0; i < Agg->getNumOperands(); ++i) {
 550       const Constant *Op =
 551         (*Idxs == i) ?
 552         ConstantFoldInsertValueInstruction(Agg->getOperand(i),
 553                                            Val, Idxs+1, NumIdx-1) :
 554         Agg->getOperand(i);
 555       Ops[i] = const_cast<Constant*>(Op);
 556     }
 557     Constant *C;
 558     if (isa<StructType>(Agg->getType()))
 559       C = ConstantStruct::get(Ops);
 560     else
 561       C = ConstantArray::get(cast<ArrayType>(Agg->getType()), Ops);
 562     return C;
 563   }
 564
 565   return 0;
 566 }
 567
 568 /// EvalVectorOp - Given two vector constants and a function pointer, apply the
 569 /// function pointer to each element pair, producing a new ConstantVector
 570 /// constant. Either or both of V1 and V2 may be NULL, meaning a
 571 /// ConstantAggregateZero operand.
 572 static Constant *EvalVectorOp(const ConstantVector *V1,
 573                               const ConstantVector *V2,
 574                               const VectorType *VTy,
 575                               Constant *(*FP)(Constant*, Constant*)) {
 576   std::vector<Constant*> Res;
 577   const Type *EltTy = VTy->getElementType();
 578   for (unsigned i = 0, e = VTy->getNumElements(); i != e; ++i) {
 579     const Constant *C1 = V1 ? V1->getOperand(i) : Constant::getNullValue(EltTy);
 580     const Constant *C2 = V2 ? V2->getOperand(i) : Constant::getNullValue(EltTy);
 581     Res.push_back(FP(const_cast<Constant*>(C1),
 582                      const_cast<Constant*>(C2)));
 583   }
 584   return ConstantVector::get(Res);
 585 }
 586
 587 Constant *llvm::ConstantFoldBinaryInstruction(unsigned Opcode,
 588                                               const Constant *C1,
 589                                               const Constant *C2) {
 590   // No compile-time operations on this type yet.
 591   if (C1->getType() == Type::PPC_FP128Ty)
 592     return 0;
 593
 594   // Handle UndefValue up front
 595   if (isa<UndefValue>(C1) || isa<UndefValue>(C2)) {
 596     switch (Opcode) {
 597     case Instruction::Xor:
 598       if (isa<UndefValue>(C1) && isa<UndefValue>(C2))
 599         // Handle undef ^ undef -> 0 special case. This is a common
 600         // idiom (misuse).
 601         return Constant::getNullValue(C1->getType());
 602       // Fallthrough
 603     case Instruction::Add:
 604     case Instruction::Sub:
 605       return UndefValue::get(C1->getType());
 606     case Instruction::Mul:
 607     case Instruction::And:
 608       return Constant::getNullValue(C1->getType());
 609     case Instruction::UDiv:
 610     case Instruction::SDiv:
 611     case Instruction::FDiv:
 612     case Instruction::URem:
 613     case Instruction::SRem:
 614     case Instruction::FRem:
 615       if (!isa<UndefValue>(C2))                    // undef / X -> 0
 616         return Constant::getNullValue(C1->getType());
 617       return const_cast<Constant*>(C2);            // X / undef -> undef
 618     case Instruction::Or:                          // X | undef -> -1
 619       if (const VectorType *PTy = dyn_cast<VectorType>(C1->getType()))
 620         return ConstantVector::getAllOnesValue(PTy);
 621       return ConstantInt::getAllOnesValue(C1->getType());
 622     case Instruction::LShr:
 623       if (isa<UndefValue>(C2) && isa<UndefValue>(C1))
 624         return const_cast<Constant*>(C1);           // undef lshr undef -> undef
 625       return Constant::getNullValue(C1->getType()); // X lshr undef -> 0
 626                                                     // undef lshr X -> 0
 627     case Instruction::AShr:
 628       if (!isa<UndefValue>(C2))
 629         return const_cast<Constant*>(C1);           // undef ashr X --> undef
 630       else if (isa<UndefValue>(C1))
 631         return const_cast<Constant*>(C1);           // undef ashr undef -> undef
 632       else
 633         return const_cast<Constant*>(C1);           // X ashr undef --> X
 634     case Instruction::Shl:
 635       // undef << X -> 0   or   X << undef -> 0
 636       return Constant::getNullValue(C1->getType());
 637     }
 638   }
 639
 640   // Handle simplifications of the RHS when a constant int.
 641   if (const ConstantInt *CI2 = dyn_cast<ConstantInt>(C2)) {
 642     switch (Opcode) {
 643     case Instruction::Add:
 644       if (CI2->equalsInt(0)) return const_cast<Constant*>(C1);  // X + 0 == X
 645       break;
 646     case Instruction::Sub:
 647       if (CI2->equalsInt(0)) return const_cast<Constant*>(C1);  // X - 0 == X
 648       break;
 649     case Instruction::Mul:
 650       if (CI2->equalsInt(0)) return const_cast<Constant*>(C2);  // X * 0 == 0
 651       if (CI2->equalsInt(1))
 652         return const_cast<Constant*>(C1);                       // X * 1 == X
 653       break;
 654     case Instruction::UDiv:
 655     case Instruction::SDiv:
 656       if (CI2->equalsInt(1))
 657         return const_cast<Constant*>(C1);                     // X / 1 == X
 658       break;
 659     case Instruction::URem:
 660     case Instruction::SRem:
 661       if (CI2->equalsInt(1))
 662         return Constant::getNullValue(CI2->getType());        // X % 1 == 0
 663       break;
 664     case Instruction::And:
 665       if (CI2->isZero()) return const_cast<Constant*>(C2);    // X & 0 == 0
 666       if (CI2->isAllOnesValue())
 667         return const_cast<Constant*>(C1);                     // X & -1 == X
 668
 669       if (const ConstantExpr *CE1 = dyn_cast<ConstantExpr>(C1)) {
 670         // (zext i32 to i64) & 4294967295 -> (zext i32 to i64)
 671         if (CE1->getOpcode() == Instruction::ZExt) {
 672           unsigned DstWidth = CI2->getType()->getBitWidth();
 673           unsigned SrcWidth =
 674             CE1->getOperand(0)->getType()->getPrimitiveSizeInBits();
 675           APInt PossiblySetBits(APInt::getLowBitsSet(DstWidth, SrcWidth));
 676           if ((PossiblySetBits & CI2->getValue()) == PossiblySetBits)
 677             return const_cast<Constant*>(C1);
 678         }
 679
 680         // If and'ing the address of a global with a constant, fold it.
 681         if (CE1->getOpcode() == Instruction::PtrToInt &&
 682             isa<GlobalValue>(CE1->getOperand(0))) {
 683           GlobalValue *GV = cast<GlobalValue>(CE1->getOperand(0));
 684
 685           // Functions are at least 4-byte aligned.
 686           unsigned GVAlign = GV->getAlignment();
 687           if (isa<Function>(GV))
 688             GVAlign = std::max(GVAlign, 4U);
 689
 690           if (GVAlign > 1) {
 691             unsigned DstWidth = CI2->getType()->getBitWidth();
 692             unsigned SrcWidth = std::min(DstWidth, Log2_32(GVAlign));
 693             APInt BitsNotSet(APInt::getLowBitsSet(DstWidth, SrcWidth));
 694
 695             // If checking bits we know are clear, return zero.
 696             if ((CI2->getValue() & BitsNotSet) == CI2->getValue())
 697               return Constant::getNullValue(CI2->getType());
 698           }
 699         }
 700       }
 701       break;
 702     case Instruction::Or:
 703       if (CI2->equalsInt(0)) return const_cast<Constant*>(C1);  // X | 0 == X
 704       if (CI2->isAllOnesValue())
 705         return const_cast<Constant*>(C2);  // X | -1 == -1
 706       break;
 707     case Instruction::Xor:
 708       if (CI2->equalsInt(0)) return const_cast<Constant*>(C1);  // X ^ 0 == X
 709       break;
 710     case Instruction::AShr:
 711       // ashr (zext C to Ty), C2 -> lshr (zext C, CSA), C2
 712       if (const ConstantExpr *CE1 = dyn_cast<ConstantExpr>(C1))
 713         if (CE1->getOpcode() == Instruction::ZExt)  // Top bits known zero.
 714           return ConstantExpr::getLShr(const_cast<Constant*>(C1),
 715                                        const_cast<Constant*>(C2));
 716       break;
 717     }
 718   }
 719
 720   // At this point we know neither constant is an UndefValue.
 721   if (const ConstantInt *CI1 = dyn_cast<ConstantInt>(C1)) {
 722     if (const ConstantInt *CI2 = dyn_cast<ConstantInt>(C2)) {
 723       using namespace APIntOps;
 724       const APInt &C1V = CI1->getValue();
 725       const APInt &C2V = CI2->getValue();
 726       switch (Opcode) {
 727       default:
 728         break;
 729       case Instruction::Add:
 730         return ConstantInt::get(C1V + C2V);
 731       case Instruction::Sub:
 732         return ConstantInt::get(C1V - C2V);
 733       case Instruction::Mul:
 734         return ConstantInt::get(C1V * C2V);
 735       case Instruction::UDiv:
 736         if (CI2->isNullValue())
 737           return 0;        // X / 0 -> can't fold
 738         return ConstantInt::get(C1V.udiv(C2V));
 739       case Instruction::SDiv:
 740         if (CI2->isNullValue())
 741           return 0;        // X / 0 -> can't fold
 742         if (C2V.isAllOnesValue() && C1V.isMinSignedValue())
 743           return 0;        // MIN_INT / -1 -> overflow
 744         return ConstantInt::get(C1V.sdiv(C2V));
 745       case Instruction::URem:
 746         if (C2->isNullValue())
 747           return 0;        // X / 0 -> can't fold
 748         return ConstantInt::get(C1V.urem(C2V));
 749       case Instruction::SRem:
 750         if (CI2->isNullValue())
 751           return 0;        // X % 0 -> can't fold
 752         if (C2V.isAllOnesValue() && C1V.isMinSignedValue())
 753           return 0;        // MIN_INT % -1 -> overflow
 754         return ConstantInt::get(C1V.srem(C2V));
 755       case Instruction::And:
 756         return ConstantInt::get(C1V & C2V);
 757       case Instruction::Or:
 758         return ConstantInt::get(C1V | C2V);
 759       case Instruction::Xor:
 760         return ConstantInt::get(C1V ^ C2V);
 761       case Instruction::Shl: {
 762         uint32_t shiftAmt = C2V.getZExtValue();
 763         if (shiftAmt < C1V.getBitWidth())
 764           return ConstantInt::get(C1V.shl(shiftAmt));
 765         else
 766           return UndefValue::get(C1->getType()); // too big shift is undef
 767       }
 768       case Instruction::LShr: {
 769         uint32_t shiftAmt = C2V.getZExtValue();
 770         if (shiftAmt < C1V.getBitWidth())
 771           return ConstantInt::get(C1V.lshr(shiftAmt));
 772         else
 773           return UndefValue::get(C1->getType()); // too big shift is undef
 774       }
 775       case Instruction::AShr: {
 776         uint32_t shiftAmt = C2V.getZExtValue();
 777         if (shiftAmt < C1V.getBitWidth())
 778           return ConstantInt::get(C1V.ashr(shiftAmt));
 779         else
 780           return UndefValue::get(C1->getType()); // too big shift is undef
 781       }
 782       }
 783     }
 784   } else if (const ConstantFP *CFP1 = dyn_cast<ConstantFP>(C1)) {
 785     if (const ConstantFP *CFP2 = dyn_cast<ConstantFP>(C2)) {
 786       APFloat C1V = CFP1->getValueAPF();
 787       APFloat C2V = CFP2->getValueAPF();
 788       APFloat C3V = C1V;  // copy for modification
 789       switch (Opcode) {
 790       default:
 791         break;
 792       case Instruction::Add:
 793         (void)C3V.add(C2V, APFloat::rmNearestTiesToEven);
 794         return ConstantFP::get(C3V);
 795       case Instruction::Sub:
 796         (void)C3V.subtract(C2V, APFloat::rmNearestTiesToEven);
 797         return ConstantFP::get(C3V);
 798       case Instruction::Mul:
 799         (void)C3V.multiply(C2V, APFloat::rmNearestTiesToEven);
 800         return ConstantFP::get(C3V);
 801       case Instruction::FDiv:
 802         (void)C3V.divide(C2V, APFloat::rmNearestTiesToEven);
 803         return ConstantFP::get(C3V);
 804       case Instruction::FRem:
 805         if (C2V.isZero()) {
 806           // IEEE 754, Section 7.1, #5
 807           if (CFP1->getType() == Type::DoubleTy)
 808             return ConstantFP::get(APFloat(std::numeric_limits<double>::
 809                                            quiet_NaN()));
 810           if (CFP1->getType() == Type::FloatTy)
 811             return ConstantFP::get(APFloat(std::numeric_limits<float>::
 812                                            quiet_NaN()));
 813           break;
 814         }
 815         (void)C3V.mod(C2V, APFloat::rmNearestTiesToEven);
 816         return ConstantFP::get(C3V);
 817       }
 818     }
 819   } else if (const VectorType *VTy = dyn_cast<VectorType>(C1->getType())) {
 820     const ConstantVector *CP1 = dyn_cast<ConstantVector>(C1);
 821     const ConstantVector *CP2 = dyn_cast<ConstantVector>(C2);
 822     if ((CP1 != NULL || isa<ConstantAggregateZero>(C1)) &&
 823         (CP2 != NULL || isa<ConstantAggregateZero>(C2))) {
 824       switch (Opcode) {
 825       default:
 826         break;
 827       case Instruction::Add:
 828         return EvalVectorOp(CP1, CP2, VTy, ConstantExpr::getAdd);
 829       case Instruction::Sub:
 830         return EvalVectorOp(CP1, CP2, VTy, ConstantExpr::getSub);
 831       case Instruction::Mul:
 832         return EvalVectorOp(CP1, CP2, VTy, ConstantExpr::getMul);
 833       case Instruction::UDiv:
 834         return EvalVectorOp(CP1, CP2, VTy, ConstantExpr::getUDiv);
 835       case Instruction::SDiv:
 836         return EvalVectorOp(CP1, CP2, VTy, ConstantExpr::getSDiv);
 837       case Instruction::FDiv:
 838         return EvalVectorOp(CP1, CP2, VTy, ConstantExpr::getFDiv);
 839       case Instruction::URem:
 840         return EvalVectorOp(CP1, CP2, VTy, ConstantExpr::getURem);
 841       case Instruction::SRem:
 842         return EvalVectorOp(CP1, CP2, VTy, ConstantExpr::getSRem);
 843       case Instruction::FRem:
 844         return EvalVectorOp(CP1, CP2, VTy, ConstantExpr::getFRem);
 845       case Instruction::And:
 846         return EvalVectorOp(CP1, CP2, VTy, ConstantExpr::getAnd);
 847       case Instruction::Or:
 848         return EvalVectorOp(CP1, CP2, VTy, ConstantExpr::getOr);
 849       case Instruction::Xor:
 850         return EvalVectorOp(CP1, CP2, VTy, ConstantExpr::getXor);
 851       }
 852     }
 853   }
 854
 855   if (isa<ConstantExpr>(C1)) {
 856     // There are many possible foldings we could do here.  We should probably
 857     // at least fold add of a pointer with an integer into the appropriate
 858     // getelementptr.  This will improve alias analysis a bit.
 859   } else if (isa<ConstantExpr>(C2)) {
 860     // If C2 is a constant expr and C1 isn't, flop them around and fold the
 861     // other way if possible.
 862     switch (Opcode) {
 863     case Instruction::Add:
 864     case Instruction::Mul:
 865     case Instruction::And:
 866     case Instruction::Or:
 867     case Instruction::Xor:
 868       // No change of opcode required.
 869       return ConstantFoldBinaryInstruction(Opcode, C2, C1);
 870
 871     case Instruction::Shl:
 872     case Instruction::LShr:
 873     case Instruction::AShr:
 874     case Instruction::Sub:
 875     case Instruction::SDiv:
 876     case Instruction::UDiv:
 877     case Instruction::FDiv:
 878     case Instruction::URem:
 879     case Instruction::SRem:
 880     case Instruction::FRem:
 881     default:  // These instructions cannot be flopped around.
 882       break;
 883     }
 884   }
 885
 886   // We don't know how to fold this.
 887   return 0;
 888 }
 889
 890 /// isZeroSizedType - This type is zero sized if its an array or structure of
 891 /// zero sized types.  The only leaf zero sized type is an empty structure.
 892 static bool isMaybeZeroSizedType(const Type *Ty) {
 893   if (isa<OpaqueType>(Ty)) return true;  // Can't say.
 894   if (const StructType *STy = dyn_cast<StructType>(Ty)) {
 895
 896     // If all of elements have zero size, this does too.
 897     for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
 898       if (!isMaybeZeroSizedType(STy->getElementType(i))) return false;
 899     return true;
 900
 901   } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
 902     return isMaybeZeroSizedType(ATy->getElementType());
 903   }
 904   return false;
 905 }
 906
 907 /// IdxCompare - Compare the two constants as though they were getelementptr
 908 /// indices.  This allows coersion of the types to be the same thing.
 909 ///
 910 /// If the two constants are the "same" (after coersion), return 0.  If the
 911 /// first is less than the second, return -1, if the second is less than the
 912 /// first, return 1.  If the constants are not integral, return -2.
 913 ///
 914 static int IdxCompare(Constant *C1, Constant *C2, const Type *ElTy) {
 915   if (C1 == C2) return 0;
 916
 917   // Ok, we found a different index.  If they are not ConstantInt, we can't do
 918   // anything with them.
 919   if (!isa<ConstantInt>(C1) || !isa<ConstantInt>(C2))
 920     return -2; // don't know!
 921
 922   // Ok, we have two differing integer indices.  Sign extend them to be the same
 923   // type.  Long is always big enough, so we use it.
 924   if (C1->getType() != Type::Int64Ty)
 925     C1 = ConstantExpr::getSExt(C1, Type::Int64Ty);
 926
 927   if (C2->getType() != Type::Int64Ty)
 928     C2 = ConstantExpr::getSExt(C2, Type::Int64Ty);
 929
 930   if (C1 == C2) return 0;  // They are equal
 931
 932   // If the type being indexed over is really just a zero sized type, there is
 933   // no pointer difference being made here.
 934   if (isMaybeZeroSizedType(ElTy))
 935     return -2; // dunno.
 936
 937   // If they are really different, now that they are the same type, then we
 938   // found a difference!
 939   if (cast<ConstantInt>(C1)->getSExtValue() <
 940       cast<ConstantInt>(C2)->getSExtValue())
 941     return -1;
 942   else
 943     return 1;
 944 }
 945
 946 /// evaluateFCmpRelation - This function determines if there is anything we can
 947 /// decide about the two constants provided.  This doesn't need to handle simple
 948 /// things like ConstantFP comparisons, but should instead handle ConstantExprs.
 949 /// If we can determine that the two constants have a particular relation to
 950 /// each other, we should return the corresponding FCmpInst predicate,
 951 /// otherwise return FCmpInst::BAD_FCMP_PREDICATE. This is used below in
 952 /// ConstantFoldCompareInstruction.
 953 ///
 954 /// To simplify this code we canonicalize the relation so that the first
 955 /// operand is always the most "complex" of the two.  We consider ConstantFP
 956 /// to be the simplest, and ConstantExprs to be the most complex.
 957 static FCmpInst::Predicate evaluateFCmpRelation(const Constant *V1,
 958                                                 const Constant *V2) {
 959   assert(V1->getType() == V2->getType() &&
 960          "Cannot compare values of different types!");
 961
 962   // No compile-time operations on this type yet.
 963   if (V1->getType() == Type::PPC_FP128Ty)
 964     return FCmpInst::BAD_FCMP_PREDICATE;
 965
 966   // Handle degenerate case quickly
 967   if (V1 == V2) return FCmpInst::FCMP_OEQ;
 968
 969   if (!isa<ConstantExpr>(V1)) {
 970     if (!isa<ConstantExpr>(V2)) {
 971       // We distilled thisUse the standard constant folder for a few cases
 972       ConstantInt *R = 0;
 973       Constant *C1 = const_cast<Constant*>(V1);
 974       Constant *C2 = const_cast<Constant*>(V2);
 975       R = dyn_cast<ConstantInt>(
 976                              ConstantExpr::getFCmp(FCmpInst::FCMP_OEQ, C1, C2));
 977       if (R && !R->isZero())
 978         return FCmpInst::FCMP_OEQ;
 979       R = dyn_cast<ConstantInt>(
 980                              ConstantExpr::getFCmp(FCmpInst::FCMP_OLT, C1, C2));
 981       if (R && !R->isZero())
 982         return FCmpInst::FCMP_OLT;
 983       R = dyn_cast<ConstantInt>(
 984                              ConstantExpr::getFCmp(FCmpInst::FCMP_OGT, C1, C2));
 985       if (R && !R->isZero())
 986         return FCmpInst::FCMP_OGT;
 987
 988       // Nothing more we can do
 989       return FCmpInst::BAD_FCMP_PREDICATE;
 990     }
 991
 992     // If the first operand is simple and second is ConstantExpr, swap operands.
 993     FCmpInst::Predicate SwappedRelation = evaluateFCmpRelation(V2, V1);
 994     if (SwappedRelation != FCmpInst::BAD_FCMP_PREDICATE)
 995       return FCmpInst::getSwappedPredicate(SwappedRelation);
 996   } else {
 997     // Ok, the LHS is known to be a constantexpr.  The RHS can be any of a
 998     // constantexpr or a simple constant.
 999     const ConstantExpr *CE1 = cast<ConstantExpr>(V1);
1000     switch (CE1->getOpcode()) {
1001     case Instruction::FPTrunc:
1002     case Instruction::FPExt:
1003     case Instruction::UIToFP:
1004     case Instruction::SIToFP:
1005       // We might be able to do something with these but we don't right now.
1006       break;
1007     default:
1008       break;
1009     }
1010   }
1011   // There are MANY other foldings that we could perform here.  They will
1012   // probably be added on demand, as they seem needed.
1013   return FCmpInst::BAD_FCMP_PREDICATE;
1014 }
1015
1016 /// evaluateICmpRelation - This function determines if there is anything we can
1017 /// decide about the two constants provided.  This doesn't need to handle simple
1018 /// things like integer comparisons, but should instead handle ConstantExprs
1019 /// and GlobalValues.  If we can determine that the two constants have a
1020 /// particular relation to each other, we should return the corresponding ICmp
1021 /// predicate, otherwise return ICmpInst::BAD_ICMP_PREDICATE.
1022 ///
1023 /// To simplify this code we canonicalize the relation so that the first
1024 /// operand is always the most "complex" of the two.  We consider simple
1025 /// constants (like ConstantInt) to be the simplest, followed by
1026 /// GlobalValues, followed by ConstantExpr's (the most complex).
1027 ///
1028 static ICmpInst::Predicate evaluateICmpRelation(const Constant *V1,
1029                                                 const Constant *V2,
1030                                                 bool isSigned) {
1031   assert(V1->getType() == V2->getType() &&
1032          "Cannot compare different types of values!");
1033   if (V1 == V2) return ICmpInst::ICMP_EQ;
1034
1035   if (!isa<ConstantExpr>(V1) && !isa<GlobalValue>(V1)) {
1036     if (!isa<GlobalValue>(V2) && !isa<ConstantExpr>(V2)) {
1037       // We distilled this down to a simple case, use the standard constant
1038       // folder.
1039       ConstantInt *R = 0;
1040       Constant *C1 = const_cast<Constant*>(V1);
1041       Constant *C2 = const_cast<Constant*>(V2);
1042       ICmpInst::Predicate pred = ICmpInst::ICMP_EQ;
1043       R = dyn_cast<ConstantInt>(ConstantExpr::getICmp(pred, C1, C2));
1044       if (R && !R->isZero())
1045         return pred;
1046       pred = isSigned ? ICmpInst::ICMP_SLT : ICmpInst::ICMP_ULT;
1047       R = dyn_cast<ConstantInt>(ConstantExpr::getICmp(pred, C1, C2));
1048       if (R && !R->isZero())
1049         return pred;
1050       pred = isSigned ?  ICmpInst::ICMP_SGT : ICmpInst::ICMP_UGT;
1051       R = dyn_cast<ConstantInt>(ConstantExpr::getICmp(pred, C1, C2));
1052       if (R && !R->isZero())
1053         return pred;
1054
1055       // If we couldn't figure it out, bail.
1056       return ICmpInst::BAD_ICMP_PREDICATE;
1057     }
1058
1059     // If the first operand is simple, swap operands.
1060     ICmpInst::Predicate SwappedRelation =
1061       evaluateICmpRelation(V2, V1, isSigned);
1062     if (SwappedRelation != ICmpInst::BAD_ICMP_PREDICATE)
1063       return ICmpInst::getSwappedPredicate(SwappedRelation);
1064
1065   } else if (const GlobalValue *CPR1 = dyn_cast<GlobalValue>(V1)) {
1066     if (isa<ConstantExpr>(V2)) {  // Swap as necessary.
1067       ICmpInst::Predicate SwappedRelation =
1068         evaluateICmpRelation(V2, V1, isSigned);
1069       if (SwappedRelation != ICmpInst::BAD_ICMP_PREDICATE)
1070         return ICmpInst::getSwappedPredicate(SwappedRelation);
1071       else
1072         return ICmpInst::BAD_ICMP_PREDICATE;
1073     }
1074
1075     // Now we know that the RHS is a GlobalValue or simple constant,
1076     // which (since the types must match) means that it's a ConstantPointerNull.
1077     if (const GlobalValue *CPR2 = dyn_cast<GlobalValue>(V2)) {
1078       // Don't try to decide equality of aliases.
1079       if (!isa<GlobalAlias>(CPR1) && !isa<GlobalAlias>(CPR2))
1080         if (!CPR1->hasExternalWeakLinkage() || !CPR2->hasExternalWeakLinkage())
1081           return ICmpInst::ICMP_NE;
1082     } else {
1083       assert(isa<ConstantPointerNull>(V2) && "Canonicalization guarantee!");
1084       // GlobalVals can never be null.  Don't try to evaluate aliases.
1085       if (!CPR1->hasExternalWeakLinkage() && !isa<GlobalAlias>(CPR1))
1086         return ICmpInst::ICMP_NE;
1087     }
1088   } else {
1089     // Ok, the LHS is known to be a constantexpr.  The RHS can be any of a
1090     // constantexpr, a CPR, or a simple constant.
1091     const ConstantExpr *CE1 = cast<ConstantExpr>(V1);
1092     const Constant *CE1Op0 = CE1->getOperand(0);
1093
1094     switch (CE1->getOpcode()) {
1095     case Instruction::Trunc:
1096     case Instruction::FPTrunc:
1097     case Instruction::FPExt:
1098     case Instruction::FPToUI:
1099     case Instruction::FPToSI:
1100       break; // We can't evaluate floating point casts or truncations.
1101
1102     case Instruction::UIToFP:
1103     case Instruction::SIToFP:
1104     case Instruction::BitCast:
1105     case Instruction::ZExt:
1106     case Instruction::SExt:
1107       // If the cast is not actually changing bits, and the second operand is a
1108       // null pointer, do the comparison with the pre-casted value.
1109       if (V2->isNullValue() &&
1110           (isa<PointerType>(CE1->getType()) || CE1->getType()->isInteger())) {
1111         bool sgnd = isSigned;
1112         if (CE1->getOpcode() == Instruction::ZExt) isSigned = false;
1113         if (CE1->getOpcode() == Instruction::SExt) isSigned = true;
1114         return evaluateICmpRelation(CE1Op0,
1115                                     Constant::getNullValue(CE1Op0->getType()),
1116                                     sgnd);
1117       }
1118
1119       // If the dest type is a pointer type, and the RHS is a constantexpr cast
1120       // from the same type as the src of the LHS, evaluate the inputs.  This is
1121       // important for things like "icmp eq (cast 4 to int*), (cast 5 to int*)",
1122       // which happens a lot in compilers with tagged integers.
1123       if (const ConstantExpr *CE2 = dyn_cast<ConstantExpr>(V2))
1124         if (CE2->isCast() && isa<PointerType>(CE1->getType()) &&
1125             CE1->getOperand(0)->getType() == CE2->getOperand(0)->getType() &&
1126             CE1->getOperand(0)->getType()->isInteger()) {
1127           bool sgnd = isSigned;
1128           if (CE1->getOpcode() == Instruction::ZExt) isSigned = false;
1129           if (CE1->getOpcode() == Instruction::SExt) isSigned = true;
1130           return evaluateICmpRelation(CE1->getOperand(0), CE2->getOperand(0),
1131                                       sgnd);
1132         }
1133       break;
1134
1135     case Instruction::GetElementPtr:
1136       // Ok, since this is a getelementptr, we know that the constant has a
1137       // pointer type.  Check the various cases.
1138       if (isa<ConstantPointerNull>(V2)) {
1139         // If we are comparing a GEP to a null pointer, check to see if the base
1140         // of the GEP equals the null pointer.
1141         if (const GlobalValue *GV = dyn_cast<GlobalValue>(CE1Op0)) {
1142           if (GV->hasExternalWeakLinkage())
1143             // Weak linkage GVals could be zero or not. We're comparing that
1144             // to null pointer so its greater-or-equal
1145             return isSigned ? ICmpInst::ICMP_SGE : ICmpInst::ICMP_UGE;
1146           else
1147             // If its not weak linkage, the GVal must have a non-zero address
1148             // so the result is greater-than
1149             return isSigned ? ICmpInst::ICMP_SGT :  ICmpInst::ICMP_UGT;
1150         } else if (isa<ConstantPointerNull>(CE1Op0)) {
1151           // If we are indexing from a null pointer, check to see if we have any
1152           // non-zero indices.
1153           for (unsigned i = 1, e = CE1->getNumOperands(); i != e; ++i)
1154             if (!CE1->getOperand(i)->isNullValue())
1155               // Offsetting from null, must not be equal.
1156               return isSigned ? ICmpInst::ICMP_SGT : ICmpInst::ICMP_UGT;
1157           // Only zero indexes from null, must still be zero.
1158           return ICmpInst::ICMP_EQ;
1159         }
1160         // Otherwise, we can't really say if the first operand is null or not.
1161       } else if (const GlobalValue *CPR2 = dyn_cast<GlobalValue>(V2)) {
1162         if (isa<ConstantPointerNull>(CE1Op0)) {
1163           if (CPR2->hasExternalWeakLinkage())
1164             // Weak linkage GVals could be zero or not. We're comparing it to
1165             // a null pointer, so its less-or-equal
1166             return isSigned ? ICmpInst::ICMP_SLE : ICmpInst::ICMP_ULE;
1167           else
1168             // If its not weak linkage, the GVal must have a non-zero address
1169             // so the result is less-than
1170             return isSigned ? ICmpInst::ICMP_SLT : ICmpInst::ICMP_ULT;
1171         } else if (const GlobalValue *CPR1 = dyn_cast<GlobalValue>(CE1Op0)) {
1172           if (CPR1 == CPR2) {
1173             // If this is a getelementptr of the same global, then it must be
1174             // different.  Because the types must match, the getelementptr could
1175             // only have at most one index, and because we fold getelementptr's
1176             // with a single zero index, it must be nonzero.
1177             assert(CE1->getNumOperands() == 2 &&
1178                    !CE1->getOperand(1)->isNullValue() &&
1179                    "Suprising getelementptr!");
1180             return isSigned ? ICmpInst::ICMP_SGT : ICmpInst::ICMP_UGT;
1181           } else {
1182             // If they are different globals, we don't know what the value is,
1183             // but they can't be equal.
1184             return ICmpInst::ICMP_NE;
1185           }
1186         }
1187       } else {
1188         const ConstantExpr *CE2 = cast<ConstantExpr>(V2);
1189         const Constant *CE2Op0 = CE2->getOperand(0);
1190
1191         // There are MANY other foldings that we could perform here.  They will
1192         // probably be added on demand, as they seem needed.
1193         switch (CE2->getOpcode()) {
1194         default: break;
1195         case Instruction::GetElementPtr:
1196           // By far the most common case to handle is when the base pointers are
1197           // obviously to the same or different globals.
1198           if (isa<GlobalValue>(CE1Op0) && isa<GlobalValue>(CE2Op0)) {
1199             if (CE1Op0 != CE2Op0) // Don't know relative ordering, but not equal
1200               return ICmpInst::ICMP_NE;
1201             // Ok, we know that both getelementptr instructions are based on the
1202             // same global.  From this, we can precisely determine the relative
1203             // ordering of the resultant pointers.
1204             unsigned i = 1;
1205
1206             // Compare all of the operands the GEP's have in common.
1207             gep_type_iterator GTI = gep_type_begin(CE1);
1208             for (;i != CE1->getNumOperands() && i != CE2->getNumOperands();
1209                  ++i, ++GTI)
1210               switch (IdxCompare(CE1->getOperand(i), CE2->getOperand(i),
1211                                  GTI.getIndexedType())) {
1212               case -1: return isSigned ? ICmpInst::ICMP_SLT:ICmpInst::ICMP_ULT;
1213               case 1:  return isSigned ? ICmpInst::ICMP_SGT:ICmpInst::ICMP_UGT;
1214               case -2: return ICmpInst::BAD_ICMP_PREDICATE;
1215               }
1216
1217             // Ok, we ran out of things they have in common.  If any leftovers
1218             // are non-zero then we have a difference, otherwise we are equal.
1219             for (; i < CE1->getNumOperands(); ++i)
1220               if (!CE1->getOperand(i)->isNullValue()) {
1221                 if (isa<ConstantInt>(CE1->getOperand(i)))
1222                   return isSigned ? ICmpInst::ICMP_SGT : ICmpInst::ICMP_UGT;
1223                 else
1224                   return ICmpInst::BAD_ICMP_PREDICATE; // Might be equal.
1225               }
1226
1227             for (; i < CE2->getNumOperands(); ++i)
1228               if (!CE2->getOperand(i)->isNullValue()) {
1229                 if (isa<ConstantInt>(CE2->getOperand(i)))
1230                   return isSigned ? ICmpInst::ICMP_SLT : ICmpInst::ICMP_ULT;
1231                 else
1232                   return ICmpInst::BAD_ICMP_PREDICATE; // Might be equal.
1233               }
1234             return ICmpInst::ICMP_EQ;
1235           }
1236         }
1237       }
1238     default:
1239       break;
1240     }
1241   }
1242
1243   return ICmpInst::BAD_ICMP_PREDICATE;
1244 }
1245
1246 Constant *llvm::ConstantFoldCompareInstruction(unsigned short pred,
1247                                                const Constant *C1,
1248                                                const Constant *C2) {
1249   // Fold FCMP_FALSE/FCMP_TRUE unconditionally.
1250   if (pred == FCmpInst::FCMP_FALSE) {
1251     if (const VectorType *VT = dyn_cast<VectorType>(C1->getType()))
1252       return Constant::getNullValue(VectorType::getInteger(VT));
1253     else
1254       return ConstantInt::getFalse();
1255   }
1256
1257   if (pred == FCmpInst::FCMP_TRUE) {
1258     if (const VectorType *VT = dyn_cast<VectorType>(C1->getType()))
1259       return Constant::getAllOnesValue(VectorType::getInteger(VT));
1260     else
1261       return ConstantInt::getTrue();
1262   }
1263
1264   // Handle some degenerate cases first
1265   if (isa<UndefValue>(C1) || isa<UndefValue>(C2)) {
1266     // vicmp/vfcmp -> [vector] undef
1267     if (const VectorType *VTy = dyn_cast<VectorType>(C1->getType()))
1268       return UndefValue::get(VectorType::getInteger(VTy));
1269
1270     // icmp/fcmp -> i1 undef
1271     return UndefValue::get(Type::Int1Ty);
1272   }
1273
1274   // No compile-time operations on this type yet.
1275   if (C1->getType() == Type::PPC_FP128Ty)
1276     return 0;
1277
1278   // icmp eq/ne(null,GV) -> false/true
1279   if (C1->isNullValue()) {
1280     if (const GlobalValue *GV = dyn_cast<GlobalValue>(C2))
1281       // Don't try to evaluate aliases.  External weak GV can be null.
1282       if (!isa<GlobalAlias>(GV) && !GV->hasExternalWeakLinkage()) {
1283         if (pred == ICmpInst::ICMP_EQ)
1284           return ConstantInt::getFalse();
1285         else if (pred == ICmpInst::ICMP_NE)
1286           return ConstantInt::getTrue();
1287       }
1288   // icmp eq/ne(GV,null) -> false/true
1289   } else if (C2->isNullValue()) {
1290     if (const GlobalValue *GV = dyn_cast<GlobalValue>(C1))
1291       // Don't try to evaluate aliases.  External weak GV can be null.
1292       if (!isa<GlobalAlias>(GV) && !GV->hasExternalWeakLinkage()) {
1293         if (pred == ICmpInst::ICMP_EQ)
1294           return ConstantInt::getFalse();
1295         else if (pred == ICmpInst::ICMP_NE)
1296           return ConstantInt::getTrue();
1297       }
1298   }
1299
1300   if (isa<ConstantInt>(C1) && isa<ConstantInt>(C2)) {
1301     APInt V1 = cast<ConstantInt>(C1)->getValue();
1302     APInt V2 = cast<ConstantInt>(C2)->getValue();
1303     switch (pred) {
1304     default: assert(0 && "Invalid ICmp Predicate"); return 0;
1305     case ICmpInst::ICMP_EQ: return ConstantInt::get(Type::Int1Ty, V1 == V2);
1306     case ICmpInst::ICMP_NE: return ConstantInt::get(Type::Int1Ty, V1 != V2);
1307     case ICmpInst::ICMP_SLT:return ConstantInt::get(Type::Int1Ty, V1.slt(V2));
1308     case ICmpInst::ICMP_SGT:return ConstantInt::get(Type::Int1Ty, V1.sgt(V2));
1309     case ICmpInst::ICMP_SLE:return ConstantInt::get(Type::Int1Ty, V1.sle(V2));
1310     case ICmpInst::ICMP_SGE:return ConstantInt::get(Type::Int1Ty, V1.sge(V2));
1311     case ICmpInst::ICMP_ULT:return ConstantInt::get(Type::Int1Ty, V1.ult(V2));
1312     case ICmpInst::ICMP_UGT:return ConstantInt::get(Type::Int1Ty, V1.ugt(V2));
1313     case ICmpInst::ICMP_ULE:return ConstantInt::get(Type::Int1Ty, V1.ule(V2));
1314     case ICmpInst::ICMP_UGE:return ConstantInt::get(Type::Int1Ty, V1.uge(V2));
1315     }
1316   } else if (isa<ConstantFP>(C1) && isa<ConstantFP>(C2)) {
1317     APFloat C1V = cast<ConstantFP>(C1)->getValueAPF();
1318     APFloat C2V = cast<ConstantFP>(C2)->getValueAPF();
1319     APFloat::cmpResult R = C1V.compare(C2V);
1320     switch (pred) {
1321     default: assert(0 && "Invalid FCmp Predicate"); return 0;
1322     case FCmpInst::FCMP_FALSE: return ConstantInt::getFalse();
1323     case FCmpInst::FCMP_TRUE:  return ConstantInt::getTrue();
1324     case FCmpInst::FCMP_UNO:
1325       return ConstantInt::get(Type::Int1Ty, R==APFloat::cmpUnordered);
1326     case FCmpInst::FCMP_ORD:
1327       return ConstantInt::get(Type::Int1Ty, R!=APFloat::cmpUnordered);
1328     case FCmpInst::FCMP_UEQ:
1329       return ConstantInt::get(Type::Int1Ty, R==APFloat::cmpUnordered ||
1330                                             R==APFloat::cmpEqual);
1331     case FCmpInst::FCMP_OEQ:
1332       return ConstantInt::get(Type::Int1Ty, R==APFloat::cmpEqual);
1333     case FCmpInst::FCMP_UNE:
1334       return ConstantInt::get(Type::Int1Ty, R!=APFloat::cmpEqual);
1335     case FCmpInst::FCMP_ONE:
1336       return ConstantInt::get(Type::Int1Ty, R==APFloat::cmpLessThan ||
1337                                             R==APFloat::cmpGreaterThan);
1338     case FCmpInst::FCMP_ULT:
1339       return ConstantInt::get(Type::Int1Ty, R==APFloat::cmpUnordered ||
1340                                             R==APFloat::cmpLessThan);
1341     case FCmpInst::FCMP_OLT:
1342       return ConstantInt::get(Type::Int1Ty, R==APFloat::cmpLessThan);
1343     case FCmpInst::FCMP_UGT:
1344       return ConstantInt::get(Type::Int1Ty, R==APFloat::cmpUnordered ||
1345                                             R==APFloat::cmpGreaterThan);
1346     case FCmpInst::FCMP_OGT:
1347       return ConstantInt::get(Type::Int1Ty, R==APFloat::cmpGreaterThan);
1348     case FCmpInst::FCMP_ULE:
1349       return ConstantInt::get(Type::Int1Ty, R!=APFloat::cmpGreaterThan);
1350     case FCmpInst::FCMP_OLE:
1351       return ConstantInt::get(Type::Int1Ty, R==APFloat::cmpLessThan ||
1352                                             R==APFloat::cmpEqual);
1353     case FCmpInst::FCMP_UGE:
1354       return ConstantInt::get(Type::Int1Ty, R!=APFloat::cmpLessThan);
1355     case FCmpInst::FCMP_OGE:
1356       return ConstantInt::get(Type::Int1Ty, R==APFloat::cmpGreaterThan ||
1357                                             R==APFloat::cmpEqual);
1358     }
1359   } else if (isa<VectorType>(C1->getType())) {
1360     SmallVector<Constant*, 16> C1Elts, C2Elts;
1361     C1->getVectorElements(C1Elts);
1362     C2->getVectorElements(C2Elts);
1363
1364     // If we can constant fold the comparison of each element, constant fold
1365     // the whole vector comparison.
1366     SmallVector<Constant*, 4> ResElts;
1367     const Type *InEltTy = C1Elts[0]->getType();
1368     bool isFP = InEltTy->isFloatingPoint();
1369     const Type *ResEltTy = InEltTy;
1370     if (isFP)
1371       ResEltTy = IntegerType::get(InEltTy->getPrimitiveSizeInBits());
1372
1373     for (unsigned i = 0, e = C1Elts.size(); i != e; ++i) {
1374       // Compare the elements, producing an i1 result or constant expr.
1375       Constant *C;
1376       if (isFP)
1377         C = ConstantExpr::getFCmp(pred, C1Elts[i], C2Elts[i]);
1378       else
1379         C = ConstantExpr::getICmp(pred, C1Elts[i], C2Elts[i]);
1380
1381       // If it is a bool or undef result, convert to the dest type.
1382       if (ConstantInt *CI = dyn_cast<ConstantInt>(C)) {
1383         if (CI->isZero())
1384           ResElts.push_back(Constant::getNullValue(ResEltTy));
1385         else
1386           ResElts.push_back(Constant::getAllOnesValue(ResEltTy));
1387       } else if (isa<UndefValue>(C)) {
1388         ResElts.push_back(UndefValue::get(ResEltTy));
1389       } else {
1390         break;
1391       }
1392     }
1393
1394     if (ResElts.size() == C1Elts.size())
1395       return ConstantVector::get(&ResElts[0], ResElts.size());
1396   }
1397
1398   if (C1->getType()->isFloatingPoint()) {
1399     int Result = -1;  // -1 = unknown, 0 = known false, 1 = known true.
1400     switch (evaluateFCmpRelation(C1, C2)) {
1401     default: assert(0 && "Unknown relation!");
1402     case FCmpInst::FCMP_UNO:
1403     case FCmpInst::FCMP_ORD:
1404     case FCmpInst::FCMP_UEQ:
1405     case FCmpInst::FCMP_UNE:
1406     case FCmpInst::FCMP_ULT:
1407     case FCmpInst::FCMP_UGT:
1408     case FCmpInst::FCMP_ULE:
1409     case FCmpInst::FCMP_UGE:
1410     case FCmpInst::FCMP_TRUE:
1411     case FCmpInst::FCMP_FALSE:
1412     case FCmpInst::BAD_FCMP_PREDICATE:
1413       break; // Couldn't determine anything about these constants.
1414     case FCmpInst::FCMP_OEQ: // We know that C1 == C2
1415       Result = (pred == FCmpInst::FCMP_UEQ || pred == FCmpInst::FCMP_OEQ ||
1416                 pred == FCmpInst::FCMP_ULE || pred == FCmpInst::FCMP_OLE ||
1417                 pred == FCmpInst::FCMP_UGE || pred == FCmpInst::FCMP_OGE);
1418       break;
1419     case FCmpInst::FCMP_OLT: // We know that C1 < C2
1420       Result = (pred == FCmpInst::FCMP_UNE || pred == FCmpInst::FCMP_ONE ||
1421                 pred == FCmpInst::FCMP_ULT || pred == FCmpInst::FCMP_OLT ||
1422                 pred == FCmpInst::FCMP_ULE || pred == FCmpInst::FCMP_OLE);
1423       break;
1424     case FCmpInst::FCMP_OGT: // We know that C1 > C2
1425       Result = (pred == FCmpInst::FCMP_UNE || pred == FCmpInst::FCMP_ONE ||
1426                 pred == FCmpInst::FCMP_UGT || pred == FCmpInst::FCMP_OGT ||
1427                 pred == FCmpInst::FCMP_UGE || pred == FCmpInst::FCMP_OGE);
1428       break;
1429     case FCmpInst::FCMP_OLE: // We know that C1 <= C2
1430       // We can only partially decide this relation.
1431       if (pred == FCmpInst::FCMP_UGT || pred == FCmpInst::FCMP_OGT)
1432         Result = 0;
1433       else if (pred == FCmpInst::FCMP_ULT || pred == FCmpInst::FCMP_OLT)
1434         Result = 1;
1435       break;
1436     case FCmpInst::FCMP_OGE: // We known that C1 >= C2
1437       // We can only partially decide this relation.
1438       if (pred == FCmpInst::FCMP_ULT || pred == FCmpInst::FCMP_OLT)
1439         Result = 0;
1440       else if (pred == FCmpInst::FCMP_UGT || pred == FCmpInst::FCMP_OGT)
1441         Result = 1;
1442       break;
1443     case ICmpInst::ICMP_NE: // We know that C1 != C2
1444       // We can only partially decide this relation.
1445       if (pred == FCmpInst::FCMP_OEQ || pred == FCmpInst::FCMP_UEQ)
1446         Result = 0;
1447       else if (pred == FCmpInst::FCMP_ONE || pred == FCmpInst::FCMP_UNE)
1448         Result = 1;
1449       break;
1450     }
1451
1452     // If we evaluated the result, return it now.
1453     if (Result != -1) {
1454       if (const VectorType *VT = dyn_cast<VectorType>(C1->getType())) {
1455         if (Result == 0)
1456           return Constant::getNullValue(VectorType::getInteger(VT));
1457         else
1458           return Constant::getAllOnesValue(VectorType::getInteger(VT));
1459       }
1460       return ConstantInt::get(Type::Int1Ty, Result);
1461     }
1462
1463   } else {
1464     // Evaluate the relation between the two constants, per the predicate.
1465     int Result = -1;  // -1 = unknown, 0 = known false, 1 = known true.
1466     switch (evaluateICmpRelation(C1, C2, CmpInst::isSigned(pred))) {
1467     default: assert(0 && "Unknown relational!");
1468     case ICmpInst::BAD_ICMP_PREDICATE:
1469       break;  // Couldn't determine anything about these constants.
1470     case ICmpInst::ICMP_EQ:   // We know the constants are equal!
1471       // If we know the constants are equal, we can decide the result of this
1472       // computation precisely.
1473       Result = (pred == ICmpInst::ICMP_EQ  ||
1474                 pred == ICmpInst::ICMP_ULE ||
1475                 pred == ICmpInst::ICMP_SLE ||
1476                 pred == ICmpInst::ICMP_UGE ||
1477                 pred == ICmpInst::ICMP_SGE);
1478       break;
1479     case ICmpInst::ICMP_ULT:
1480       // If we know that C1 < C2, we can decide the result of this computation
1481       // precisely.
1482       Result = (pred == ICmpInst::ICMP_ULT ||
1483                 pred == ICmpInst::ICMP_NE  ||
1484                 pred == ICmpInst::ICMP_ULE);
1485       break;
1486     case ICmpInst::ICMP_SLT:
1487       // If we know that C1 < C2, we can decide the result of this computation
1488       // precisely.
1489       Result = (pred == ICmpInst::ICMP_SLT ||
1490                 pred == ICmpInst::ICMP_NE  ||
1491                 pred == ICmpInst::ICMP_SLE);
1492       break;
1493     case ICmpInst::ICMP_UGT:
1494       // If we know that C1 > C2, we can decide the result of this computation
1495       // precisely.
1496       Result = (pred == ICmpInst::ICMP_UGT ||
1497                 pred == ICmpInst::ICMP_NE  ||
1498                 pred == ICmpInst::ICMP_UGE);
1499       break;
1500     case ICmpInst::ICMP_SGT:
1501       // If we know that C1 > C2, we can decide the result of this computation
1502       // precisely.
1503       Result = (pred == ICmpInst::ICMP_SGT ||
1504                 pred == ICmpInst::ICMP_NE  ||
1505                 pred == ICmpInst::ICMP_SGE);
1506       break;
1507     case ICmpInst::ICMP_ULE:
1508       // If we know that C1 <= C2, we can only partially decide this relation.
1509       if (pred == ICmpInst::ICMP_UGT) Result = 0;
1510       if (pred == ICmpInst::ICMP_ULT) Result = 1;
1511       break;
1512     case ICmpInst::ICMP_SLE:
1513       // If we know that C1 <= C2, we can only partially decide this relation.
1514       if (pred == ICmpInst::ICMP_SGT) Result = 0;
1515       if (pred == ICmpInst::ICMP_SLT) Result = 1;
1516       break;
1517
1518     case ICmpInst::ICMP_UGE:
1519       // If we know that C1 >= C2, we can only partially decide this relation.
1520       if (pred == ICmpInst::ICMP_ULT) Result = 0;
1521       if (pred == ICmpInst::ICMP_UGT) Result = 1;
1522       break;
1523     case ICmpInst::ICMP_SGE:
1524       // If we know that C1 >= C2, we can only partially decide this relation.
1525       if (pred == ICmpInst::ICMP_SLT) Result = 0;
1526       if (pred == ICmpInst::ICMP_SGT) Result = 1;
1527       break;
1528
1529     case ICmpInst::ICMP_NE:
1530       // If we know that C1 != C2, we can only partially decide this relation.
1531       if (pred == ICmpInst::ICMP_EQ) Result = 0;
1532       if (pred == ICmpInst::ICMP_NE) Result = 1;
1533       break;
1534     }
1535
1536     // If we evaluated the result, return it now.
1537     if (Result != -1) {
1538       if (const VectorType *VT = dyn_cast<VectorType>(C1->getType())) {
1539         if (Result == 0)
1540           return Constant::getNullValue(VT);
1541         else
1542           return Constant::getAllOnesValue(VT);
1543       }
1544       return ConstantInt::get(Type::Int1Ty, Result);
1545     }
1546
1547     if (!isa<ConstantExpr>(C1) && isa<ConstantExpr>(C2)) {
1548       // If C2 is a constant expr and C1 isn't, flop them around and fold the
1549       // other way if possible.
1550       switch (pred) {
1551       case ICmpInst::ICMP_EQ:
1552       case ICmpInst::ICMP_NE:
1553         // No change of predicate required.
1554         return ConstantFoldCompareInstruction(pred, C2, C1);
1555
1556       case ICmpInst::ICMP_ULT:
1557       case ICmpInst::ICMP_SLT:
1558       case ICmpInst::ICMP_UGT:
1559       case ICmpInst::ICMP_SGT:
1560       case ICmpInst::ICMP_ULE:
1561       case ICmpInst::ICMP_SLE:
1562       case ICmpInst::ICMP_UGE:
1563       case ICmpInst::ICMP_SGE:
1564         // Change the predicate as necessary to swap the operands.
1565         pred = ICmpInst::getSwappedPredicate((ICmpInst::Predicate)pred);
1566         return ConstantFoldCompareInstruction(pred, C2, C1);
1567
1568       default:  // These predicates cannot be flopped around.
1569         break;
1570       }
1571     }
1572   }
1573   return 0;
1574 }
1575
1576 Constant *llvm::ConstantFoldGetElementPtr(const Constant *C,
1577                                           Constant* const *Idxs,
1578                                           unsigned NumIdx) {
1579   if (NumIdx == 0 ||
1580       (NumIdx == 1 && Idxs[0]->isNullValue()))
1581     return const_cast<Constant*>(C);
1582
1583   if (isa<UndefValue>(C)) {
1584     const PointerType *Ptr = cast<PointerType>(C->getType());
1585     const Type *Ty = GetElementPtrInst::getIndexedType(Ptr,
1586                                                        (Value **)Idxs,
1587                                                        (Value **)Idxs+NumIdx);
1588     assert(Ty != 0 && "Invalid indices for GEP!");
1589     return UndefValue::get(PointerType::get(Ty, Ptr->getAddressSpace()));
1590   }
1591
1592   Constant *Idx0 = Idxs[0];
1593   if (C->isNullValue()) {
1594     bool isNull = true;
1595     for (unsigned i = 0, e = NumIdx; i != e; ++i)
1596       if (!Idxs[i]->isNullValue()) {
1597         isNull = false;
1598         break;
1599       }
1600     if (isNull) {
1601       const PointerType *Ptr = cast<PointerType>(C->getType());
1602       const Type *Ty = GetElementPtrInst::getIndexedType(Ptr,
1603                                                          (Value**)Idxs,
1604                                                          (Value**)Idxs+NumIdx);
1605       assert(Ty != 0 && "Invalid indices for GEP!");
1606       return
1607         ConstantPointerNull::get(PointerType::get(Ty,Ptr->getAddressSpace()));
1608     }
1609   }
1610
1611   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(const_cast<Constant*>(C))) {
1612     // Combine Indices - If the source pointer to this getelementptr instruction
1613     // is a getelementptr instruction, combine the indices of the two
1614     // getelementptr instructions into a single instruction.
1615     //
1616     if (CE->getOpcode() == Instruction::GetElementPtr) {
1617       const Type *LastTy = 0;
1618       for (gep_type_iterator I = gep_type_begin(CE), E = gep_type_end(CE);
1619            I != E; ++I)
1620         LastTy = *I;
1621
1622       if ((LastTy && isa<ArrayType>(LastTy)) || Idx0->isNullValue()) {
1623         SmallVector<Value*, 16> NewIndices;
1624         NewIndices.reserve(NumIdx + CE->getNumOperands());
1625         for (unsigned i = 1, e = CE->getNumOperands()-1; i != e; ++i)
1626           NewIndices.push_back(CE->getOperand(i));
1627
1628         // Add the last index of the source with the first index of the new GEP.
1629         // Make sure to handle the case when they are actually different types.
1630         Constant *Combined = CE->getOperand(CE->getNumOperands()-1);
1631         // Otherwise it must be an array.
1632         if (!Idx0->isNullValue()) {
1633           const Type *IdxTy = Combined->getType();
1634           if (IdxTy != Idx0->getType()) {
1635             Constant *C1 = ConstantExpr::getSExtOrBitCast(Idx0, Type::Int64Ty);
1636             Constant *C2 = ConstantExpr::getSExtOrBitCast(Combined,
1637                                                           Type::Int64Ty);
1638             Combined = ConstantExpr::get(Instruction::Add, C1, C2);
1639           } else {
1640             Combined =
1641               ConstantExpr::get(Instruction::Add, Idx0, Combined);
1642           }
1643         }
1644
1645         NewIndices.push_back(Combined);
1646         NewIndices.insert(NewIndices.end(), Idxs+1, Idxs+NumIdx);
1647         return ConstantExpr::getGetElementPtr(CE->getOperand(0), &NewIndices[0],
1648                                               NewIndices.size());
1649       }
1650     }
1651
1652     // Implement folding of:
1653     //    int* getelementptr ([2 x int]* cast ([3 x int]* %X to [2 x int]*),
1654     //                        long 0, long 0)
1655     // To: int* getelementptr ([3 x int]* %X, long 0, long 0)
1656     //
1657     if (CE->isCast() && NumIdx > 1 && Idx0->isNullValue()) {
1658       if (const PointerType *SPT =
1659           dyn_cast<PointerType>(CE->getOperand(0)->getType()))
1660         if (const ArrayType *SAT = dyn_cast<ArrayType>(SPT->getElementType()))
1661           if (const ArrayType *CAT =
1662         dyn_cast<ArrayType>(cast<PointerType>(C->getType())->getElementType()))
1663             if (CAT->getElementType() == SAT->getElementType())
1664               return ConstantExpr::getGetElementPtr(
1665                       (Constant*)CE->getOperand(0), Idxs, NumIdx);
1666     }
1667
1668     // Fold: getelementptr (i8* inttoptr (i64 1 to i8*), i32 -1)
1669     // Into: inttoptr (i64 0 to i8*)
1670     // This happens with pointers to member functions in C++.
1671     if (CE->getOpcode() == Instruction::IntToPtr && NumIdx == 1 &&
1672         isa<ConstantInt>(CE->getOperand(0)) && isa<ConstantInt>(Idxs[0]) &&
1673         cast<PointerType>(CE->getType())->getElementType() == Type::Int8Ty) {
1674       Constant *Base = CE->getOperand(0);
1675       Constant *Offset = Idxs[0];
1676
1677       // Convert the smaller integer to the larger type.
1678       if (Offset->getType()->getPrimitiveSizeInBits() <
1679           Base->getType()->getPrimitiveSizeInBits())
1680         Offset = ConstantExpr::getSExt(Offset, Base->getType());
1681       else if (Base->getType()->getPrimitiveSizeInBits() <
1682                Offset->getType()->getPrimitiveSizeInBits())
1683         Base = ConstantExpr::getZExt(Base, Base->getType());
1684
1685       Base = ConstantExpr::getAdd(Base, Offset);
1686       return ConstantExpr::getIntToPtr(Base, CE->getType());
1687     }
1688   }
1689   return 0;
1690 }
1691