lib/VMCore/ConstantFold.cpp

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