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