lib/VMCore/ConstantFold.cpp

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