lib/VMCore/Constants.cpp

   1 //===-- Constants.cpp - Implement Constant nodes --------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the Constant* classes...
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/Constants.h"
  15 #include "ConstantFold.h"
  16 #include "llvm/DerivedTypes.h"
  17 #include "llvm/GlobalValue.h"
  18 #include "llvm/Instructions.h"
  19 #include "llvm/MDNode.h"
  20 #include "llvm/Module.h"
  21 #include "llvm/ADT/FoldingSet.h"
  22 #include "llvm/ADT/StringExtras.h"
  23 #include "llvm/ADT/StringMap.h"
  24 #include "llvm/Support/Compiler.h"
  25 #include "llvm/Support/Debug.h"
  26 #include "llvm/Support/ManagedStatic.h"
  27 #include "llvm/Support/MathExtras.h"
  28 #include "llvm/System/RWMutex.h"
  29 #include "llvm/System/Threading.h"
  30 #include "llvm/ADT/DenseMap.h"
  31 #include "llvm/ADT/SmallVector.h"
  32 #include <algorithm>
  33 #include <map>
  34 using namespace llvm;
  35
  36 //===----------------------------------------------------------------------===//
  37 //                              Constant Class
  38 //===----------------------------------------------------------------------===//
  39
  40 // Becomes a no-op when multithreading is disabled.
  41 ManagedStatic<sys::SmartRWMutex<true> > ConstantsLock;
  42
  43 void Constant::destroyConstantImpl() {
  44   // When a Constant is destroyed, there may be lingering
  45   // references to the constant by other constants in the constant pool.  These
  46   // constants are implicitly dependent on the module that is being deleted,
  47   // but they don't know that.  Because we only find out when the CPV is
  48   // deleted, we must now notify all of our users (that should only be
  49   // Constants) that they are, in fact, invalid now and should be deleted.
  50   //
  51   while (!use_empty()) {
  52     Value *V = use_back();
  53 #ifndef NDEBUG      // Only in -g mode...
  54     if (!isa<Constant>(V))
  55       DOUT << "While deleting: " << *this
  56            << "\n\nUse still stuck around after Def is destroyed: "
  57            << *V << "\n\n";
  58 #endif
  59     assert(isa<Constant>(V) && "References remain to Constant being destroyed");
  60     Constant *CV = cast<Constant>(V);
  61     CV->destroyConstant();
  62
  63     // The constant should remove itself from our use list...
  64     assert((use_empty() || use_back() != V) && "Constant not removed!");
  65   }
  66
  67   // Value has no outstanding references it is safe to delete it now...
  68   delete this;
  69 }
  70
  71 /// canTrap - Return true if evaluation of this constant could trap.  This is
  72 /// true for things like constant expressions that could divide by zero.
  73 bool Constant::canTrap() const {
  74   assert(getType()->isFirstClassType() && "Cannot evaluate aggregate vals!");
  75   // The only thing that could possibly trap are constant exprs.
  76   const ConstantExpr *CE = dyn_cast<ConstantExpr>(this);
  77   if (!CE) return false;
  78
  79   // ConstantExpr traps if any operands can trap.
  80   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
  81     if (getOperand(i)->canTrap())
  82       return true;
  83
  84   // Otherwise, only specific operations can trap.
  85   switch (CE->getOpcode()) {
  86   default:
  87     return false;
  88   case Instruction::UDiv:
  89   case Instruction::SDiv:
  90   case Instruction::FDiv:
  91   case Instruction::URem:
  92   case Instruction::SRem:
  93   case Instruction::FRem:
  94     // Div and rem can trap if the RHS is not known to be non-zero.
  95     if (!isa<ConstantInt>(getOperand(1)) || getOperand(1)->isNullValue())
  96       return true;
  97     return false;
  98   }
  99 }
 100
 101 /// ContainsRelocations - Return true if the constant value contains relocations
 102 /// which cannot be resolved at compile time. Kind argument is used to filter
 103 /// only 'interesting' sorts of relocations.
 104 bool Constant::ContainsRelocations(unsigned Kind) const {
 105   if (const GlobalValue* GV = dyn_cast<GlobalValue>(this)) {
 106     bool isLocal = GV->hasLocalLinkage();
 107     if ((Kind & Reloc::Local) && isLocal) {
 108       // Global has local linkage and 'local' kind of relocations are
 109       // requested
 110       return true;
 111     }
 112
 113     if ((Kind & Reloc::Global) && !isLocal) {
 114       // Global has non-local linkage and 'global' kind of relocations are
 115       // requested
 116       return true;
 117     }
 118
 119     return false;
 120   }
 121
 122   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
 123     if (getOperand(i)->ContainsRelocations(Kind))
 124       return true;
 125
 126   return false;
 127 }
 128
 129 // Static constructor to create a '0' constant of arbitrary type...
 130 Constant *Constant::getNullValue(const Type *Ty) {
 131   static uint64_t zero[2] = {0, 0};
 132   switch (Ty->getTypeID()) {
 133   case Type::IntegerTyID:
 134     return ConstantInt::get(Ty, 0);
 135   case Type::FloatTyID:
 136     return ConstantFP::get(APFloat(APInt(32, 0)));
 137   case Type::DoubleTyID:
 138     return ConstantFP::get(APFloat(APInt(64, 0)));
 139   case Type::X86_FP80TyID:
 140     return ConstantFP::get(APFloat(APInt(80, 2, zero)));
 141   case Type::FP128TyID:
 142     return ConstantFP::get(APFloat(APInt(128, 2, zero), true));
 143   case Type::PPC_FP128TyID:
 144     return ConstantFP::get(APFloat(APInt(128, 2, zero)));
 145   case Type::PointerTyID:
 146     return ConstantPointerNull::get(cast<PointerType>(Ty));
 147   case Type::StructTyID:
 148   case Type::ArrayTyID:
 149   case Type::VectorTyID:
 150     return ConstantAggregateZero::get(Ty);
 151   default:
 152     // Function, Label, or Opaque type?
 153     assert(!"Cannot create a null constant of that type!");
 154     return 0;
 155   }
 156 }
 157
 158 Constant *Constant::getAllOnesValue(const Type *Ty) {
 159   if (const IntegerType* ITy = dyn_cast<IntegerType>(Ty))
 160     return ConstantInt::get(APInt::getAllOnesValue(ITy->getBitWidth()));
 161   return ConstantVector::getAllOnesValue(cast<VectorType>(Ty));
 162 }
 163
 164 // Static constructor to create an integral constant with all bits set
 165 ConstantInt *ConstantInt::getAllOnesValue(const Type *Ty) {
 166   if (const IntegerType* ITy = dyn_cast<IntegerType>(Ty))
 167     return ConstantInt::get(APInt::getAllOnesValue(ITy->getBitWidth()));
 168   return 0;
 169 }
 170
 171 /// @returns the value for a vector integer constant of the given type that
 172 /// has all its bits set to true.
 173 /// @brief Get the all ones value
 174 ConstantVector *ConstantVector::getAllOnesValue(const VectorType *Ty) {
 175   std::vector<Constant*> Elts;
 176   Elts.resize(Ty->getNumElements(),
 177               ConstantInt::getAllOnesValue(Ty->getElementType()));
 178   assert(Elts[0] && "Not a vector integer type!");
 179   return cast<ConstantVector>(ConstantVector::get(Elts));
 180 }
 181
 182
 183 /// getVectorElements - This method, which is only valid on constant of vector
 184 /// type, returns the elements of the vector in the specified smallvector.
 185 /// This handles breaking down a vector undef into undef elements, etc.  For
 186 /// constant exprs and other cases we can't handle, we return an empty vector.
 187 void Constant::getVectorElements(SmallVectorImpl<Constant*> &Elts) const {
 188   assert(isa<VectorType>(getType()) && "Not a vector constant!");
 189
 190   if (const ConstantVector *CV = dyn_cast<ConstantVector>(this)) {
 191     for (unsigned i = 0, e = CV->getNumOperands(); i != e; ++i)
 192       Elts.push_back(CV->getOperand(i));
 193     return;
 194   }
 195
 196   const VectorType *VT = cast<VectorType>(getType());
 197   if (isa<ConstantAggregateZero>(this)) {
 198     Elts.assign(VT->getNumElements(),
 199                 Constant::getNullValue(VT->getElementType()));
 200     return;
 201   }
 202
 203   if (isa<UndefValue>(this)) {
 204     Elts.assign(VT->getNumElements(), UndefValue::get(VT->getElementType()));
 205     return;
 206   }
 207
 208   // Unknown type, must be constant expr etc.
 209 }
 210
 211
 212
 213 //===----------------------------------------------------------------------===//
 214 //                                ConstantInt
 215 //===----------------------------------------------------------------------===//
 216
 217 ConstantInt::ConstantInt(const IntegerType *Ty, const APInt& V)
 218   : Constant(Ty, ConstantIntVal, 0, 0), Val(V) {
 219   assert(V.getBitWidth() == Ty->getBitWidth() && "Invalid constant for type");
 220 }
 221
 222 ConstantInt *ConstantInt::TheTrueVal = 0;
 223 ConstantInt *ConstantInt::TheFalseVal = 0;
 224
 225 namespace llvm {
 226   void CleanupTrueFalse(void *) {
 227     ConstantInt::ResetTrueFalse();
 228   }
 229 }
 230
 231 static ManagedCleanup<llvm::CleanupTrueFalse> TrueFalseCleanup;
 232
 233 ConstantInt *ConstantInt::CreateTrueFalseVals(bool WhichOne) {
 234   assert(TheTrueVal == 0 && TheFalseVal == 0);
 235   TheTrueVal  = get(Type::Int1Ty, 1);
 236   TheFalseVal = get(Type::Int1Ty, 0);
 237
 238   // Ensure that llvm_shutdown nulls out TheTrueVal/TheFalseVal.
 239   TrueFalseCleanup.Register();
 240
 241   return WhichOne ? TheTrueVal : TheFalseVal;
 242 }
 243
 244
 245 namespace {
 246   struct DenseMapAPIntKeyInfo {
 247     struct KeyTy {
 248       APInt val;
 249       const Type* type;
 250       KeyTy(const APInt& V, const Type* Ty) : val(V), type(Ty) {}
 251       KeyTy(const KeyTy& that) : val(that.val), type(that.type) {}
 252       bool operator==(const KeyTy& that) const {
 253         return type == that.type && this->val == that.val;
 254       }
 255       bool operator!=(const KeyTy& that) const {
 256         return !this->operator==(that);
 257       }
 258     };
 259     static inline KeyTy getEmptyKey() { return KeyTy(APInt(1,0), 0); }
 260     static inline KeyTy getTombstoneKey() { return KeyTy(APInt(1,1), 0); }
 261     static unsigned getHashValue(const KeyTy &Key) {
 262       return DenseMapInfo<void*>::getHashValue(Key.type) ^
 263         Key.val.getHashValue();
 264     }
 265     static bool isEqual(const KeyTy &LHS, const KeyTy &RHS) {
 266       return LHS == RHS;
 267     }
 268     static bool isPod() { return false; }
 269   };
 270 }
 271
 272
 273 typedef DenseMap<DenseMapAPIntKeyInfo::KeyTy, ConstantInt*,
 274                  DenseMapAPIntKeyInfo> IntMapTy;
 275 static ManagedStatic<IntMapTy> IntConstants;
 276
 277 ConstantInt *ConstantInt::get(const IntegerType *Ty,
 278                               uint64_t V, bool isSigned) {
 279   return get(APInt(Ty->getBitWidth(), V, isSigned));
 280 }
 281
 282 Constant *ConstantInt::get(const Type *Ty, uint64_t V, bool isSigned) {
 283   Constant *C = get(cast<IntegerType>(Ty->getScalarType()), V, isSigned);
 284
 285   // For vectors, broadcast the value.
 286   if (const VectorType *VTy = dyn_cast<VectorType>(Ty))
 287     return
 288       ConstantVector::get(std::vector<Constant *>(VTy->getNumElements(), C));
 289
 290   return C;
 291 }
 292
 293 // Get a ConstantInt from an APInt. Note that the value stored in the DenseMap
 294 // as the key, is a DenseMapAPIntKeyInfo::KeyTy which has provided the
 295 // operator== and operator!= to ensure that the DenseMap doesn't attempt to
 296 // compare APInt's of different widths, which would violate an APInt class
 297 // invariant which generates an assertion.
 298 ConstantInt *ConstantInt::get(const APInt& V) {
 299   // Get the corresponding integer type for the bit width of the value.
 300   const IntegerType *ITy = IntegerType::get(V.getBitWidth());
 301   // get an existing value or the insertion position
 302   DenseMapAPIntKeyInfo::KeyTy Key(V, ITy);
 303
 304   ConstantsLock->reader_acquire();
 305   ConstantInt *&Slot = (*IntConstants)[Key];
 306   ConstantsLock->reader_release();
 307
 308   if (!Slot) {
 309     sys::SmartScopedWriter<true> Writer(&*ConstantsLock);
 310     ConstantInt *&NewSlot = (*IntConstants)[Key];
 311     if (!Slot) {
 312       NewSlot = new ConstantInt(ITy, V);
 313     }
 314
 315     return NewSlot;
 316   } else {
 317     return Slot;
 318   }
 319 }
 320
 321 Constant *ConstantInt::get(const Type *Ty, const APInt &V) {
 322   ConstantInt *C = ConstantInt::get(V);
 323   assert(C->getType() == Ty->getScalarType() &&
 324          "ConstantInt type doesn't match the type implied by its value!");
 325
 326   // For vectors, broadcast the value.
 327   if (const VectorType *VTy = dyn_cast<VectorType>(Ty))
 328     return
 329       ConstantVector::get(std::vector<Constant *>(VTy->getNumElements(), C));
 330
 331   return C;
 332 }
 333
 334 //===----------------------------------------------------------------------===//
 335 //                                ConstantFP
 336 //===----------------------------------------------------------------------===//
 337
 338 static const fltSemantics *TypeToFloatSemantics(const Type *Ty) {
 339   if (Ty == Type::FloatTy)
 340     return &APFloat::IEEEsingle;
 341   if (Ty == Type::DoubleTy)
 342     return &APFloat::IEEEdouble;
 343   if (Ty == Type::X86_FP80Ty)
 344     return &APFloat::x87DoubleExtended;
 345   else if (Ty == Type::FP128Ty)
 346     return &APFloat::IEEEquad;
 347
 348   assert(Ty == Type::PPC_FP128Ty && "Unknown FP format");
 349   return &APFloat::PPCDoubleDouble;
 350 }
 351
 352 ConstantFP::ConstantFP(const Type *Ty, const APFloat& V)
 353   : Constant(Ty, ConstantFPVal, 0, 0), Val(V) {
 354   assert(&V.getSemantics() == TypeToFloatSemantics(Ty) &&
 355          "FP type Mismatch");
 356 }
 357
 358 bool ConstantFP::isNullValue() const {
 359   return Val.isZero() && !Val.isNegative();
 360 }
 361
 362 ConstantFP *ConstantFP::getNegativeZero(const Type *Ty) {
 363   APFloat apf = cast <ConstantFP>(Constant::getNullValue(Ty))->getValueAPF();
 364   apf.changeSign();
 365   return ConstantFP::get(apf);
 366 }
 367
 368 bool ConstantFP::isExactlyValue(const APFloat& V) const {
 369   return Val.bitwiseIsEqual(V);
 370 }
 371
 372 namespace {
 373   struct DenseMapAPFloatKeyInfo {
 374     struct KeyTy {
 375       APFloat val;
 376       KeyTy(const APFloat& V) : val(V){}
 377       KeyTy(const KeyTy& that) : val(that.val) {}
 378       bool operator==(const KeyTy& that) const {
 379         return this->val.bitwiseIsEqual(that.val);
 380       }
 381       bool operator!=(const KeyTy& that) const {
 382         return !this->operator==(that);
 383       }
 384     };
 385     static inline KeyTy getEmptyKey() {
 386       return KeyTy(APFloat(APFloat::Bogus,1));
 387     }
 388     static inline KeyTy getTombstoneKey() {
 389       return KeyTy(APFloat(APFloat::Bogus,2));
 390     }
 391     static unsigned getHashValue(const KeyTy &Key) {
 392       return Key.val.getHashValue();
 393     }
 394     static bool isEqual(const KeyTy &LHS, const KeyTy &RHS) {
 395       return LHS == RHS;
 396     }
 397     static bool isPod() { return false; }
 398   };
 399 }
 400
 401 //---- ConstantFP::get() implementation...
 402 //
 403 typedef DenseMap<DenseMapAPFloatKeyInfo::KeyTy, ConstantFP*,
 404                  DenseMapAPFloatKeyInfo> FPMapTy;
 405
 406 static ManagedStatic<FPMapTy> FPConstants;
 407
 408 ConstantFP *ConstantFP::get(const APFloat &V) {
 409   DenseMapAPFloatKeyInfo::KeyTy Key(V);
 410
 411   ConstantsLock->reader_acquire();
 412   ConstantFP *&Slot = (*FPConstants)[Key];
 413   ConstantsLock->reader_release();
 414
 415   if (!Slot) {
 416     sys::SmartScopedWriter<true> Writer(&*ConstantsLock);
 417     ConstantFP *&NewSlot = (*FPConstants)[Key];
 418     if (!NewSlot) {
 419       const Type *Ty;
 420       if (&V.getSemantics() == &APFloat::IEEEsingle)
 421         Ty = Type::FloatTy;
 422       else if (&V.getSemantics() == &APFloat::IEEEdouble)
 423         Ty = Type::DoubleTy;
 424       else if (&V.getSemantics() == &APFloat::x87DoubleExtended)
 425         Ty = Type::X86_FP80Ty;
 426       else if (&V.getSemantics() == &APFloat::IEEEquad)
 427         Ty = Type::FP128Ty;
 428       else {
 429         assert(&V.getSemantics() == &APFloat::PPCDoubleDouble &&
 430                "Unknown FP format");
 431         Ty = Type::PPC_FP128Ty;
 432       }
 433       NewSlot = new ConstantFP(Ty, V);
 434     }
 435
 436     return NewSlot;
 437   }
 438
 439   return Slot;
 440 }
 441
 442 /// get() - This returns a constant fp for the specified value in the
 443 /// specified type.  This should only be used for simple constant values like
 444 /// 2.0/1.0 etc, that are known-valid both as double and as the target format.
 445 Constant *ConstantFP::get(const Type *Ty, double V) {
 446   APFloat FV(V);
 447   bool ignored;
 448   FV.convert(*TypeToFloatSemantics(Ty->getScalarType()),
 449              APFloat::rmNearestTiesToEven, &ignored);
 450   Constant *C = get(FV);
 451
 452   // For vectors, broadcast the value.
 453   if (const VectorType *VTy = dyn_cast<VectorType>(Ty))
 454     return
 455       ConstantVector::get(std::vector<Constant *>(VTy->getNumElements(), C));
 456
 457   return C;
 458 }
 459
 460 //===----------------------------------------------------------------------===//
 461 //                            ConstantXXX Classes
 462 //===----------------------------------------------------------------------===//
 463
 464
 465 ConstantArray::ConstantArray(const ArrayType *T,
 466                              const std::vector<Constant*> &V)
 467   : Constant(T, ConstantArrayVal,
 468              OperandTraits<ConstantArray>::op_end(this) - V.size(),
 469              V.size()) {
 470   assert(V.size() == T->getNumElements() &&
 471          "Invalid initializer vector for constant array");
 472   Use *OL = OperandList;
 473   for (std::vector<Constant*>::const_iterator I = V.begin(), E = V.end();
 474        I != E; ++I, ++OL) {
 475     Constant *C = *I;
 476     assert((C->getType() == T->getElementType() ||
 477             (T->isAbstract() &&
 478              C->getType()->getTypeID() == T->getElementType()->getTypeID())) &&
 479            "Initializer for array element doesn't match array element type!");
 480     *OL = C;
 481   }
 482 }
 483
 484
 485 ConstantStruct::ConstantStruct(const StructType *T,
 486                                const std::vector<Constant*> &V)
 487   : Constant(T, ConstantStructVal,
 488              OperandTraits<ConstantStruct>::op_end(this) - V.size(),
 489              V.size()) {
 490   assert(V.size() == T->getNumElements() &&
 491          "Invalid initializer vector for constant structure");
 492   Use *OL = OperandList;
 493   for (std::vector<Constant*>::const_iterator I = V.begin(), E = V.end();
 494        I != E; ++I, ++OL) {
 495     Constant *C = *I;
 496     assert((C->getType() == T->getElementType(I-V.begin()) ||
 497             ((T->getElementType(I-V.begin())->isAbstract() ||
 498               C->getType()->isAbstract()) &&
 499              T->getElementType(I-V.begin())->getTypeID() ==
 500                    C->getType()->getTypeID())) &&
 501            "Initializer for struct element doesn't match struct element type!");
 502     *OL = C;
 503   }
 504 }
 505
 506
 507 ConstantVector::ConstantVector(const VectorType *T,
 508                                const std::vector<Constant*> &V)
 509   : Constant(T, ConstantVectorVal,
 510              OperandTraits<ConstantVector>::op_end(this) - V.size(),
 511              V.size()) {
 512   Use *OL = OperandList;
 513     for (std::vector<Constant*>::const_iterator I = V.begin(), E = V.end();
 514          I != E; ++I, ++OL) {
 515       Constant *C = *I;
 516       assert((C->getType() == T->getElementType() ||
 517             (T->isAbstract() &&
 518              C->getType()->getTypeID() == T->getElementType()->getTypeID())) &&
 519            "Initializer for vector element doesn't match vector element type!");
 520     *OL = C;
 521   }
 522 }
 523
 524
 525 namespace llvm {
 526 // We declare several classes private to this file, so use an anonymous
 527 // namespace
 528 namespace {
 529
 530 /// UnaryConstantExpr - This class is private to Constants.cpp, and is used
 531 /// behind the scenes to implement unary constant exprs.
 532 class VISIBILITY_HIDDEN UnaryConstantExpr : public ConstantExpr {
 533   void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
 534 public:
 535   // allocate space for exactly one operand
 536   void *operator new(size_t s) {
 537     return User::operator new(s, 1);
 538   }
 539   UnaryConstantExpr(unsigned Opcode, Constant *C, const Type *Ty)
 540     : ConstantExpr(Ty, Opcode, &Op<0>(), 1) {
 541     Op<0>() = C;
 542   }
 543   /// Transparently provide more efficient getOperand methods.
 544   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
 545 };
 546
 547 /// BinaryConstantExpr - This class is private to Constants.cpp, and is used
 548 /// behind the scenes to implement binary constant exprs.
 549 class VISIBILITY_HIDDEN BinaryConstantExpr : public ConstantExpr {
 550   void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
 551 public:
 552   // allocate space for exactly two operands
 553   void *operator new(size_t s) {
 554     return User::operator new(s, 2);
 555   }
 556   BinaryConstantExpr(unsigned Opcode, Constant *C1, Constant *C2)
 557     : ConstantExpr(C1->getType(), Opcode, &Op<0>(), 2) {
 558     Op<0>() = C1;
 559     Op<1>() = C2;
 560   }
 561   /// Transparently provide more efficient getOperand methods.
 562   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
 563 };
 564
 565 /// SelectConstantExpr - This class is private to Constants.cpp, and is used
 566 /// behind the scenes to implement select constant exprs.
 567 class VISIBILITY_HIDDEN SelectConstantExpr : public ConstantExpr {
 568   void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
 569 public:
 570   // allocate space for exactly three operands
 571   void *operator new(size_t s) {
 572     return User::operator new(s, 3);
 573   }
 574   SelectConstantExpr(Constant *C1, Constant *C2, Constant *C3)
 575     : ConstantExpr(C2->getType(), Instruction::Select, &Op<0>(), 3) {
 576     Op<0>() = C1;
 577     Op<1>() = C2;
 578     Op<2>() = C3;
 579   }
 580   /// Transparently provide more efficient getOperand methods.
 581   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
 582 };
 583
 584 /// ExtractElementConstantExpr - This class is private to
 585 /// Constants.cpp, and is used behind the scenes to implement
 586 /// extractelement constant exprs.
 587 class VISIBILITY_HIDDEN ExtractElementConstantExpr : public ConstantExpr {
 588   void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
 589 public:
 590   // allocate space for exactly two operands
 591   void *operator new(size_t s) {
 592     return User::operator new(s, 2);
 593   }
 594   ExtractElementConstantExpr(Constant *C1, Constant *C2)
 595     : ConstantExpr(cast<VectorType>(C1->getType())->getElementType(),
 596                    Instruction::ExtractElement, &Op<0>(), 2) {
 597     Op<0>() = C1;
 598     Op<1>() = C2;
 599   }
 600   /// Transparently provide more efficient getOperand methods.
 601   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
 602 };
 603
 604 /// InsertElementConstantExpr - This class is private to
 605 /// Constants.cpp, and is used behind the scenes to implement
 606 /// insertelement constant exprs.
 607 class VISIBILITY_HIDDEN InsertElementConstantExpr : public ConstantExpr {
 608   void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
 609 public:
 610   // allocate space for exactly three operands
 611   void *operator new(size_t s) {
 612     return User::operator new(s, 3);
 613   }
 614   InsertElementConstantExpr(Constant *C1, Constant *C2, Constant *C3)
 615     : ConstantExpr(C1->getType(), Instruction::InsertElement,
 616                    &Op<0>(), 3) {
 617     Op<0>() = C1;
 618     Op<1>() = C2;
 619     Op<2>() = C3;
 620   }
 621   /// Transparently provide more efficient getOperand methods.
 622   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
 623 };
 624
 625 /// ShuffleVectorConstantExpr - This class is private to
 626 /// Constants.cpp, and is used behind the scenes to implement
 627 /// shufflevector constant exprs.
 628 class VISIBILITY_HIDDEN ShuffleVectorConstantExpr : public ConstantExpr {
 629   void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
 630 public:
 631   // allocate space for exactly three operands
 632   void *operator new(size_t s) {
 633     return User::operator new(s, 3);
 634   }
 635   ShuffleVectorConstantExpr(Constant *C1, Constant *C2, Constant *C3)
 636   : ConstantExpr(VectorType::get(
 637                    cast<VectorType>(C1->getType())->getElementType(),
 638                    cast<VectorType>(C3->getType())->getNumElements()),
 639                  Instruction::ShuffleVector,
 640                  &Op<0>(), 3) {
 641     Op<0>() = C1;
 642     Op<1>() = C2;
 643     Op<2>() = C3;
 644   }
 645   /// Transparently provide more efficient getOperand methods.
 646   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
 647 };
 648
 649 /// ExtractValueConstantExpr - This class is private to
 650 /// Constants.cpp, and is used behind the scenes to implement
 651 /// extractvalue constant exprs.
 652 class VISIBILITY_HIDDEN ExtractValueConstantExpr : public ConstantExpr {
 653   void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
 654 public:
 655   // allocate space for exactly one operand
 656   void *operator new(size_t s) {
 657     return User::operator new(s, 1);
 658   }
 659   ExtractValueConstantExpr(Constant *Agg,
 660                            const SmallVector<unsigned, 4> &IdxList,
 661                            const Type *DestTy)
 662     : ConstantExpr(DestTy, Instruction::ExtractValue, &Op<0>(), 1),
 663       Indices(IdxList) {
 664     Op<0>() = Agg;
 665   }
 666
 667   /// Indices - These identify which value to extract.
 668   const SmallVector<unsigned, 4> Indices;
 669
 670   /// Transparently provide more efficient getOperand methods.
 671   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
 672 };
 673
 674 /// InsertValueConstantExpr - This class is private to
 675 /// Constants.cpp, and is used behind the scenes to implement
 676 /// insertvalue constant exprs.
 677 class VISIBILITY_HIDDEN InsertValueConstantExpr : public ConstantExpr {
 678   void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
 679 public:
 680   // allocate space for exactly one operand
 681   void *operator new(size_t s) {
 682     return User::operator new(s, 2);
 683   }
 684   InsertValueConstantExpr(Constant *Agg, Constant *Val,
 685                           const SmallVector<unsigned, 4> &IdxList,
 686                           const Type *DestTy)
 687     : ConstantExpr(DestTy, Instruction::InsertValue, &Op<0>(), 2),
 688       Indices(IdxList) {
 689     Op<0>() = Agg;
 690     Op<1>() = Val;
 691   }
 692
 693   /// Indices - These identify the position for the insertion.
 694   const SmallVector<unsigned, 4> Indices;
 695
 696   /// Transparently provide more efficient getOperand methods.
 697   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
 698 };
 699
 700
 701 /// GetElementPtrConstantExpr - This class is private to Constants.cpp, and is
 702 /// used behind the scenes to implement getelementpr constant exprs.
 703 class VISIBILITY_HIDDEN GetElementPtrConstantExpr : public ConstantExpr {
 704   GetElementPtrConstantExpr(Constant *C, const std::vector<Constant*> &IdxList,
 705                             const Type *DestTy);
 706 public:
 707   static GetElementPtrConstantExpr *Create(Constant *C,
 708                                            const std::vector<Constant*>&IdxList,
 709                                            const Type *DestTy) {
 710     return new(IdxList.size() + 1)
 711       GetElementPtrConstantExpr(C, IdxList, DestTy);
 712   }
 713   /// Transparently provide more efficient getOperand methods.
 714   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
 715 };
 716
 717 // CompareConstantExpr - This class is private to Constants.cpp, and is used
 718 // behind the scenes to implement ICmp and FCmp constant expressions. This is
 719 // needed in order to store the predicate value for these instructions.
 720 struct VISIBILITY_HIDDEN CompareConstantExpr : public ConstantExpr {
 721   void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
 722   // allocate space for exactly two operands
 723   void *operator new(size_t s) {
 724     return User::operator new(s, 2);
 725   }
 726   unsigned short predicate;
 727   CompareConstantExpr(const Type *ty, Instruction::OtherOps opc,
 728                       unsigned short pred,  Constant* LHS, Constant* RHS)
 729     : ConstantExpr(ty, opc, &Op<0>(), 2), predicate(pred) {
 730     Op<0>() = LHS;
 731     Op<1>() = RHS;
 732   }
 733   /// Transparently provide more efficient getOperand methods.
 734   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
 735 };
 736
 737 } // end anonymous namespace
 738
 739 template <>
 740 struct OperandTraits<UnaryConstantExpr> : FixedNumOperandTraits<1> {
 741 };
 742 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(UnaryConstantExpr, Value)
 743
 744 template <>
 745 struct OperandTraits<BinaryConstantExpr> : FixedNumOperandTraits<2> {
 746 };
 747 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(BinaryConstantExpr, Value)
 748
 749 template <>
 750 struct OperandTraits<SelectConstantExpr> : FixedNumOperandTraits<3> {
 751 };
 752 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SelectConstantExpr, Value)
 753
 754 template <>
 755 struct OperandTraits<ExtractElementConstantExpr> : FixedNumOperandTraits<2> {
 756 };
 757 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ExtractElementConstantExpr, Value)
 758
 759 template <>
 760 struct OperandTraits<InsertElementConstantExpr> : FixedNumOperandTraits<3> {
 761 };
 762 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertElementConstantExpr, Value)
 763
 764 template <>
 765 struct OperandTraits<ShuffleVectorConstantExpr> : FixedNumOperandTraits<3> {
 766 };
 767 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ShuffleVectorConstantExpr, Value)
 768
 769 template <>
 770 struct OperandTraits<ExtractValueConstantExpr> : FixedNumOperandTraits<1> {
 771 };
 772 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ExtractValueConstantExpr, Value)
 773
 774 template <>
 775 struct OperandTraits<InsertValueConstantExpr> : FixedNumOperandTraits<2> {
 776 };
 777 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertValueConstantExpr, Value)
 778
 779 template <>
 780 struct OperandTraits<GetElementPtrConstantExpr> : VariadicOperandTraits<1> {
 781 };
 782
 783 GetElementPtrConstantExpr::GetElementPtrConstantExpr
 784   (Constant *C,
 785    const std::vector<Constant*> &IdxList,
 786    const Type *DestTy)
 787     : ConstantExpr(DestTy, Instruction::GetElementPtr,
 788                    OperandTraits<GetElementPtrConstantExpr>::op_end(this)
 789                    - (IdxList.size()+1),
 790                    IdxList.size()+1) {
 791   OperandList[0] = C;
 792   for (unsigned i = 0, E = IdxList.size(); i != E; ++i)
 793     OperandList[i+1] = IdxList[i];
 794 }
 795
 796 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(GetElementPtrConstantExpr, Value)
 797
 798
 799 template <>
 800 struct OperandTraits<CompareConstantExpr> : FixedNumOperandTraits<2> {
 801 };
 802 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CompareConstantExpr, Value)
 803
 804
 805 } // End llvm namespace
 806
 807
 808 // Utility function for determining if a ConstantExpr is a CastOp or not. This
 809 // can't be inline because we don't want to #include Instruction.h into
 810 // Constant.h
 811 bool ConstantExpr::isCast() const {
 812   return Instruction::isCast(getOpcode());
 813 }
 814
 815 bool ConstantExpr::isCompare() const {
 816   return getOpcode() == Instruction::ICmp || getOpcode() == Instruction::FCmp ||
 817          getOpcode() == Instruction::VICmp || getOpcode() == Instruction::VFCmp;
 818 }
 819
 820 bool ConstantExpr::hasIndices() const {
 821   return getOpcode() == Instruction::ExtractValue ||
 822          getOpcode() == Instruction::InsertValue;
 823 }
 824
 825 const SmallVector<unsigned, 4> &ConstantExpr::getIndices() const {
 826   if (const ExtractValueConstantExpr *EVCE =
 827         dyn_cast<ExtractValueConstantExpr>(this))
 828     return EVCE->Indices;
 829
 830   return cast<InsertValueConstantExpr>(this)->Indices;
 831 }
 832
 833 /// ConstantExpr::get* - Return some common constants without having to
 834 /// specify the full Instruction::OPCODE identifier.
 835 ///
 836 Constant *ConstantExpr::getNeg(Constant *C) {
 837   // API compatibility: Adjust integer opcodes to floating-point opcodes.
 838   if (C->getType()->isFPOrFPVector())
 839     return getFNeg(C);
 840   assert(C->getType()->isIntOrIntVector() &&
 841          "Cannot NEG a nonintegral value!");
 842   return get(Instruction::Sub,
 843              ConstantExpr::getZeroValueForNegationExpr(C->getType()),
 844              C);
 845 }
 846 Constant *ConstantExpr::getFNeg(Constant *C) {
 847   assert(C->getType()->isFPOrFPVector() &&
 848          "Cannot FNEG a non-floating-point value!");
 849   return get(Instruction::FSub,
 850              ConstantExpr::getZeroValueForNegationExpr(C->getType()),
 851              C);
 852 }
 853 Constant *ConstantExpr::getNot(Constant *C) {
 854   assert(C->getType()->isIntOrIntVector() &&
 855          "Cannot NOT a nonintegral value!");
 856   return get(Instruction::Xor, C,
 857              Constant::getAllOnesValue(C->getType()));
 858 }
 859 Constant *ConstantExpr::getAdd(Constant *C1, Constant *C2) {
 860   return get(Instruction::Add, C1, C2);
 861 }
 862 Constant *ConstantExpr::getFAdd(Constant *C1, Constant *C2) {
 863   return get(Instruction::FAdd, C1, C2);
 864 }
 865 Constant *ConstantExpr::getSub(Constant *C1, Constant *C2) {
 866   return get(Instruction::Sub, C1, C2);
 867 }
 868 Constant *ConstantExpr::getFSub(Constant *C1, Constant *C2) {
 869   return get(Instruction::FSub, C1, C2);
 870 }
 871 Constant *ConstantExpr::getMul(Constant *C1, Constant *C2) {
 872   return get(Instruction::Mul, C1, C2);
 873 }
 874 Constant *ConstantExpr::getFMul(Constant *C1, Constant *C2) {
 875   return get(Instruction::FMul, C1, C2);
 876 }
 877 Constant *ConstantExpr::getUDiv(Constant *C1, Constant *C2) {
 878   return get(Instruction::UDiv, C1, C2);
 879 }
 880 Constant *ConstantExpr::getSDiv(Constant *C1, Constant *C2) {
 881   return get(Instruction::SDiv, C1, C2);
 882 }
 883 Constant *ConstantExpr::getFDiv(Constant *C1, Constant *C2) {
 884   return get(Instruction::FDiv, C1, C2);
 885 }
 886 Constant *ConstantExpr::getURem(Constant *C1, Constant *C2) {
 887   return get(Instruction::URem, C1, C2);
 888 }
 889 Constant *ConstantExpr::getSRem(Constant *C1, Constant *C2) {
 890   return get(Instruction::SRem, C1, C2);
 891 }
 892 Constant *ConstantExpr::getFRem(Constant *C1, Constant *C2) {
 893   return get(Instruction::FRem, C1, C2);
 894 }
 895 Constant *ConstantExpr::getAnd(Constant *C1, Constant *C2) {
 896   return get(Instruction::And, C1, C2);
 897 }
 898 Constant *ConstantExpr::getOr(Constant *C1, Constant *C2) {
 899   return get(Instruction::Or, C1, C2);
 900 }
 901 Constant *ConstantExpr::getXor(Constant *C1, Constant *C2) {
 902   return get(Instruction::Xor, C1, C2);
 903 }
 904 unsigned ConstantExpr::getPredicate() const {
 905   assert(getOpcode() == Instruction::FCmp ||
 906          getOpcode() == Instruction::ICmp ||
 907          getOpcode() == Instruction::VFCmp ||
 908          getOpcode() == Instruction::VICmp);
 909   return ((const CompareConstantExpr*)this)->predicate;
 910 }
 911 Constant *ConstantExpr::getShl(Constant *C1, Constant *C2) {
 912   return get(Instruction::Shl, C1, C2);
 913 }
 914 Constant *ConstantExpr::getLShr(Constant *C1, Constant *C2) {
 915   return get(Instruction::LShr, C1, C2);
 916 }
 917 Constant *ConstantExpr::getAShr(Constant *C1, Constant *C2) {
 918   return get(Instruction::AShr, C1, C2);
 919 }
 920
 921 /// getWithOperandReplaced - Return a constant expression identical to this
 922 /// one, but with the specified operand set to the specified value.
 923 Constant *
 924 ConstantExpr::getWithOperandReplaced(unsigned OpNo, Constant *Op) const {
 925   assert(OpNo < getNumOperands() && "Operand num is out of range!");
 926   assert(Op->getType() == getOperand(OpNo)->getType() &&
 927          "Replacing operand with value of different type!");
 928   if (getOperand(OpNo) == Op)
 929     return const_cast<ConstantExpr*>(this);
 930
 931   Constant *Op0, *Op1, *Op2;
 932   switch (getOpcode()) {
 933   case Instruction::Trunc:
 934   case Instruction::ZExt:
 935   case Instruction::SExt:
 936   case Instruction::FPTrunc:
 937   case Instruction::FPExt:
 938   case Instruction::UIToFP:
 939   case Instruction::SIToFP:
 940   case Instruction::FPToUI:
 941   case Instruction::FPToSI:
 942   case Instruction::PtrToInt:
 943   case Instruction::IntToPtr:
 944   case Instruction::BitCast:
 945     return ConstantExpr::getCast(getOpcode(), Op, getType());
 946   case Instruction::Select:
 947     Op0 = (OpNo == 0) ? Op : getOperand(0);
 948     Op1 = (OpNo == 1) ? Op : getOperand(1);
 949     Op2 = (OpNo == 2) ? Op : getOperand(2);
 950     return ConstantExpr::getSelect(Op0, Op1, Op2);
 951   case Instruction::InsertElement:
 952     Op0 = (OpNo == 0) ? Op : getOperand(0);
 953     Op1 = (OpNo == 1) ? Op : getOperand(1);
 954     Op2 = (OpNo == 2) ? Op : getOperand(2);
 955     return ConstantExpr::getInsertElement(Op0, Op1, Op2);
 956   case Instruction::ExtractElement:
 957     Op0 = (OpNo == 0) ? Op : getOperand(0);
 958     Op1 = (OpNo == 1) ? Op : getOperand(1);
 959     return ConstantExpr::getExtractElement(Op0, Op1);
 960   case Instruction::ShuffleVector:
 961     Op0 = (OpNo == 0) ? Op : getOperand(0);
 962     Op1 = (OpNo == 1) ? Op : getOperand(1);
 963     Op2 = (OpNo == 2) ? Op : getOperand(2);
 964     return ConstantExpr::getShuffleVector(Op0, Op1, Op2);
 965   case Instruction::GetElementPtr: {
 966     SmallVector<Constant*, 8> Ops;
 967     Ops.resize(getNumOperands()-1);
 968     for (unsigned i = 1, e = getNumOperands(); i != e; ++i)
 969       Ops[i-1] = getOperand(i);
 970     if (OpNo == 0)
 971       return ConstantExpr::getGetElementPtr(Op, &Ops[0], Ops.size());
 972     Ops[OpNo-1] = Op;
 973     return ConstantExpr::getGetElementPtr(getOperand(0), &Ops[0], Ops.size());
 974   }
 975   default:
 976     assert(getNumOperands() == 2 && "Must be binary operator?");
 977     Op0 = (OpNo == 0) ? Op : getOperand(0);
 978     Op1 = (OpNo == 1) ? Op : getOperand(1);
 979     return ConstantExpr::get(getOpcode(), Op0, Op1);
 980   }
 981 }
 982
 983 /// getWithOperands - This returns the current constant expression with the
 984 /// operands replaced with the specified values.  The specified operands must
 985 /// match count and type with the existing ones.
 986 Constant *ConstantExpr::
 987 getWithOperands(Constant* const *Ops, unsigned NumOps) const {
 988   assert(NumOps == getNumOperands() && "Operand count mismatch!");
 989   bool AnyChange = false;
 990   for (unsigned i = 0; i != NumOps; ++i) {
 991     assert(Ops[i]->getType() == getOperand(i)->getType() &&
 992            "Operand type mismatch!");
 993     AnyChange |= Ops[i] != getOperand(i);
 994   }
 995   if (!AnyChange)  // No operands changed, return self.
 996     return const_cast<ConstantExpr*>(this);
 997
 998   switch (getOpcode()) {
 999   case Instruction::Trunc:
1000   case Instruction::ZExt:
1001   case Instruction::SExt:
1002   case Instruction::FPTrunc:
1003   case Instruction::FPExt:
1004   case Instruction::UIToFP:
1005   case Instruction::SIToFP:
1006   case Instruction::FPToUI:
1007   case Instruction::FPToSI:
1008   case Instruction::PtrToInt:
1009   case Instruction::IntToPtr:
1010   case Instruction::BitCast:
1011     return ConstantExpr::getCast(getOpcode(), Ops[0], getType());
1012   case Instruction::Select:
1013     return ConstantExpr::getSelect(Ops[0], Ops[1], Ops[2]);
1014   case Instruction::InsertElement:
1015     return ConstantExpr::getInsertElement(Ops[0], Ops[1], Ops[2]);
1016   case Instruction::ExtractElement:
1017     return ConstantExpr::getExtractElement(Ops[0], Ops[1]);
1018   case Instruction::ShuffleVector:
1019     return ConstantExpr::getShuffleVector(Ops[0], Ops[1], Ops[2]);
1020   case Instruction::GetElementPtr:
1021     return ConstantExpr::getGetElementPtr(Ops[0], &Ops[1], NumOps-1);
1022   case Instruction::ICmp:
1023   case Instruction::FCmp:
1024   case Instruction::VICmp:
1025   case Instruction::VFCmp:
1026     return ConstantExpr::getCompare(getPredicate(), Ops[0], Ops[1]);
1027   default:
1028     assert(getNumOperands() == 2 && "Must be binary operator?");
1029     return ConstantExpr::get(getOpcode(), Ops[0], Ops[1]);
1030   }
1031 }
1032
1033
1034 //===----------------------------------------------------------------------===//
1035 //                      isValueValidForType implementations
1036
1037 bool ConstantInt::isValueValidForType(const Type *Ty, uint64_t Val) {
1038   unsigned NumBits = cast<IntegerType>(Ty)->getBitWidth(); // assert okay
1039   if (Ty == Type::Int1Ty)
1040     return Val == 0 || Val == 1;
1041   if (NumBits >= 64)
1042     return true; // always true, has to fit in largest type
1043   uint64_t Max = (1ll << NumBits) - 1;
1044   return Val <= Max;
1045 }
1046
1047 bool ConstantInt::isValueValidForType(const Type *Ty, int64_t Val) {
1048   unsigned NumBits = cast<IntegerType>(Ty)->getBitWidth(); // assert okay
1049   if (Ty == Type::Int1Ty)
1050     return Val == 0 || Val == 1 || Val == -1;
1051   if (NumBits >= 64)
1052     return true; // always true, has to fit in largest type
1053   int64_t Min = -(1ll << (NumBits-1));
1054   int64_t Max = (1ll << (NumBits-1)) - 1;
1055   return (Val >= Min && Val <= Max);
1056 }
1057
1058 bool ConstantFP::isValueValidForType(const Type *Ty, const APFloat& Val) {
1059   // convert modifies in place, so make a copy.
1060   APFloat Val2 = APFloat(Val);
1061   bool losesInfo;
1062   switch (Ty->getTypeID()) {
1063   default:
1064     return false;         // These can't be represented as floating point!
1065
1066   // FIXME rounding mode needs to be more flexible
1067   case Type::FloatTyID: {
1068     if (&Val2.getSemantics() == &APFloat::IEEEsingle)
1069       return true;
1070     Val2.convert(APFloat::IEEEsingle, APFloat::rmNearestTiesToEven, &losesInfo);
1071     return !losesInfo;
1072   }
1073   case Type::DoubleTyID: {
1074     if (&Val2.getSemantics() == &APFloat::IEEEsingle ||
1075         &Val2.getSemantics() == &APFloat::IEEEdouble)
1076       return true;
1077     Val2.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven, &losesInfo);
1078     return !losesInfo;
1079   }
1080   case Type::X86_FP80TyID:
1081     return &Val2.getSemantics() == &APFloat::IEEEsingle ||
1082            &Val2.getSemantics() == &APFloat::IEEEdouble ||
1083            &Val2.getSemantics() == &APFloat::x87DoubleExtended;
1084   case Type::FP128TyID:
1085     return &Val2.getSemantics() == &APFloat::IEEEsingle ||
1086            &Val2.getSemantics() == &APFloat::IEEEdouble ||
1087            &Val2.getSemantics() == &APFloat::IEEEquad;
1088   case Type::PPC_FP128TyID:
1089     return &Val2.getSemantics() == &APFloat::IEEEsingle ||
1090            &Val2.getSemantics() == &APFloat::IEEEdouble ||
1091            &Val2.getSemantics() == &APFloat::PPCDoubleDouble;
1092   }
1093 }
1094
1095 //===----------------------------------------------------------------------===//
1096 //                      Factory Function Implementation
1097
1098
1099 // The number of operands for each ConstantCreator::create method is
1100 // determined by the ConstantTraits template.
1101 // ConstantCreator - A class that is used to create constants by
1102 // ValueMap*.  This class should be partially specialized if there is
1103 // something strange that needs to be done to interface to the ctor for the
1104 // constant.
1105 //
1106 namespace llvm {
1107   template<class ValType>
1108   struct ConstantTraits;
1109
1110   template<typename T, typename Alloc>
1111   struct VISIBILITY_HIDDEN ConstantTraits< std::vector<T, Alloc> > {
1112     static unsigned uses(const std::vector<T, Alloc>& v) {
1113       return v.size();
1114     }
1115   };
1116
1117   template<class ConstantClass, class TypeClass, class ValType>
1118   struct VISIBILITY_HIDDEN ConstantCreator {
1119     static ConstantClass *create(const TypeClass *Ty, const ValType &V) {
1120       return new(ConstantTraits<ValType>::uses(V)) ConstantClass(Ty, V);
1121     }
1122   };
1123
1124   template<class ConstantClass, class TypeClass>
1125   struct VISIBILITY_HIDDEN ConvertConstantType {
1126     static void convert(ConstantClass *OldC, const TypeClass *NewTy) {
1127       assert(0 && "This type cannot be converted!\n");
1128       abort();
1129     }
1130   };
1131
1132   template<class ValType, class TypeClass, class ConstantClass,
1133            bool HasLargeKey = false  /*true for arrays and structs*/ >
1134   class VISIBILITY_HIDDEN ValueMap : public AbstractTypeUser {
1135   public:
1136     typedef std::pair<const Type*, ValType> MapKey;
1137     typedef std::map<MapKey, Constant *> MapTy;
1138     typedef std::map<Constant*, typename MapTy::iterator> InverseMapTy;
1139     typedef std::map<const Type*, typename MapTy::iterator> AbstractTypeMapTy;
1140   private:
1141     /// Map - This is the main map from the element descriptor to the Constants.
1142     /// This is the primary way we avoid creating two of the same shape
1143     /// constant.
1144     MapTy Map;
1145
1146     /// InverseMap - If "HasLargeKey" is true, this contains an inverse mapping
1147     /// from the constants to their element in Map.  This is important for
1148     /// removal of constants from the array, which would otherwise have to scan
1149     /// through the map with very large keys.
1150     InverseMapTy InverseMap;
1151
1152     /// AbstractTypeMap - Map for abstract type constants.
1153     ///
1154     AbstractTypeMapTy AbstractTypeMap;
1155
1156   public:
1157     // NOTE: This function is not locked.  It is the caller's responsibility
1158     // to enforce proper synchronization.
1159     typename MapTy::iterator map_end() { return Map.end(); }
1160
1161     /// InsertOrGetItem - Return an iterator for the specified element.
1162     /// If the element exists in the map, the returned iterator points to the
1163     /// entry and Exists=true.  If not, the iterator points to the newly
1164     /// inserted entry and returns Exists=false.  Newly inserted entries have
1165     /// I->second == 0, and should be filled in.
1166     /// NOTE: This function is not locked.  It is the caller's responsibility
1167     // to enforce proper synchronization.
1168     typename MapTy::iterator InsertOrGetItem(std::pair<MapKey, Constant *>
1169                                    &InsertVal,
1170                                    bool &Exists) {
1171       std::pair<typename MapTy::iterator, bool> IP = Map.insert(InsertVal);
1172       Exists = !IP.second;
1173       return IP.first;
1174     }
1175
1176 private:
1177     typename MapTy::iterator FindExistingElement(ConstantClass *CP) {
1178       if (HasLargeKey) {
1179         typename InverseMapTy::iterator IMI = InverseMap.find(CP);
1180         assert(IMI != InverseMap.end() && IMI->second != Map.end() &&
1181                IMI->second->second == CP &&
1182                "InverseMap corrupt!");
1183         return IMI->second;
1184       }
1185
1186       typename MapTy::iterator I =
1187         Map.find(MapKey(static_cast<const TypeClass*>(CP->getRawType()),
1188                         getValType(CP)));
1189       if (I == Map.end() || I->second != CP) {
1190         // FIXME: This should not use a linear scan.  If this gets to be a
1191         // performance problem, someone should look at this.
1192         for (I = Map.begin(); I != Map.end() && I->second != CP; ++I)
1193           /* empty */;
1194       }
1195       return I;
1196     }
1197
1198     ConstantClass* Create(const TypeClass *Ty, const ValType &V,
1199                           typename MapTy::iterator I) {
1200       ConstantClass* Result =
1201         ConstantCreator<ConstantClass,TypeClass,ValType>::create(Ty, V);
1202
1203       assert(Result->getType() == Ty && "Type specified is not correct!");
1204       I = Map.insert(I, std::make_pair(MapKey(Ty, V), Result));
1205
1206       if (HasLargeKey)  // Remember the reverse mapping if needed.
1207         InverseMap.insert(std::make_pair(Result, I));
1208
1209       // If the type of the constant is abstract, make sure that an entry
1210       // exists for it in the AbstractTypeMap.
1211       if (Ty->isAbstract()) {
1212         typename AbstractTypeMapTy::iterator TI =
1213                                                  AbstractTypeMap.find(Ty);
1214
1215         if (TI == AbstractTypeMap.end()) {
1216           // Add ourselves to the ATU list of the type.
1217           cast<DerivedType>(Ty)->addAbstractTypeUser(this);
1218
1219           AbstractTypeMap.insert(TI, std::make_pair(Ty, I));
1220         }
1221       }
1222
1223       return Result;
1224     }
1225 public:
1226
1227     /// getOrCreate - Return the specified constant from the map, creating it if
1228     /// necessary.
1229     ConstantClass *getOrCreate(const TypeClass *Ty, const ValType &V) {
1230       MapKey Lookup(Ty, V);
1231       ConstantClass* Result = 0;
1232
1233       ConstantsLock->reader_acquire();
1234       typename MapTy::iterator I = Map.find(Lookup);
1235       // Is it in the map?
1236       if (I != Map.end())
1237         Result = static_cast<ConstantClass *>(I->second);
1238       ConstantsLock->reader_release();
1239
1240       if (!Result) {
1241         sys::SmartScopedWriter<true> Writer(&*ConstantsLock);
1242         I = Map.find(Lookup);
1243         // Is it in the map?
1244         if (I != Map.end())
1245           Result = static_cast<ConstantClass *>(I->second);
1246         if (!Result) {
1247           // If no preexisting value, create one now...
1248           Result = Create(Ty, V, I);
1249         }
1250       }
1251
1252       return Result;
1253     }
1254
1255     void remove(ConstantClass *CP) {
1256       ConstantsLock->writer_acquire();
1257       typename MapTy::iterator I = FindExistingElement(CP);
1258       assert(I != Map.end() && "Constant not found in constant table!");
1259       assert(I->second == CP && "Didn't find correct element?");
1260
1261       if (HasLargeKey)  // Remember the reverse mapping if needed.
1262         InverseMap.erase(CP);
1263
1264       // Now that we found the entry, make sure this isn't the entry that
1265       // the AbstractTypeMap points to.
1266       const TypeClass *Ty = static_cast<const TypeClass *>(I->first.first);
1267       if (Ty->isAbstract()) {
1268         assert(AbstractTypeMap.count(Ty) &&
1269                "Abstract type not in AbstractTypeMap?");
1270         typename MapTy::iterator &ATMEntryIt = AbstractTypeMap[Ty];
1271         if (ATMEntryIt == I) {
1272           // Yes, we are removing the representative entry for this type.
1273           // See if there are any other entries of the same type.
1274           typename MapTy::iterator TmpIt = ATMEntryIt;
1275
1276           // First check the entry before this one...
1277           if (TmpIt != Map.begin()) {
1278             --TmpIt;
1279             if (TmpIt->first.first != Ty) // Not the same type, move back...
1280               ++TmpIt;
1281           }
1282
1283           // If we didn't find the same type, try to move forward...
1284           if (TmpIt == ATMEntryIt) {
1285             ++TmpIt;
1286             if (TmpIt == Map.end() || TmpIt->first.first != Ty)
1287               --TmpIt;   // No entry afterwards with the same type
1288           }
1289
1290           // If there is another entry in the map of the same abstract type,
1291           // update the AbstractTypeMap entry now.
1292           if (TmpIt != ATMEntryIt) {
1293             ATMEntryIt = TmpIt;
1294           } else {
1295             // Otherwise, we are removing the last instance of this type
1296             // from the table.  Remove from the ATM, and from user list.
1297             cast<DerivedType>(Ty)->removeAbstractTypeUser(this);
1298             AbstractTypeMap.erase(Ty);
1299           }
1300         }
1301       }
1302
1303       Map.erase(I);
1304
1305       ConstantsLock->writer_release();
1306     }
1307
1308
1309     /// MoveConstantToNewSlot - If we are about to change C to be the element
1310     /// specified by I, update our internal data structures to reflect this
1311     /// fact.
1312     /// NOTE: This function is not locked. It is the responsibility of the
1313     /// caller to enforce proper synchronization if using this method.
1314     void MoveConstantToNewSlot(ConstantClass *C, typename MapTy::iterator I) {
1315       // First, remove the old location of the specified constant in the map.
1316       typename MapTy::iterator OldI = FindExistingElement(C);
1317       assert(OldI != Map.end() && "Constant not found in constant table!");
1318       assert(OldI->second == C && "Didn't find correct element?");
1319
1320       // If this constant is the representative element for its abstract type,
1321       // update the AbstractTypeMap so that the representative element is I.
1322       if (C->getType()->isAbstract()) {
1323         typename AbstractTypeMapTy::iterator ATI =
1324             AbstractTypeMap.find(C->getType());
1325         assert(ATI != AbstractTypeMap.end() &&
1326                "Abstract type not in AbstractTypeMap?");
1327         if (ATI->second == OldI)
1328           ATI->second = I;
1329       }
1330
1331       // Remove the old entry from the map.
1332       Map.erase(OldI);
1333
1334       // Update the inverse map so that we know that this constant is now
1335       // located at descriptor I.
1336       if (HasLargeKey) {
1337         assert(I->second == C && "Bad inversemap entry!");
1338         InverseMap[C] = I;
1339       }
1340     }
1341
1342     void refineAbstractType(const DerivedType *OldTy, const Type *NewTy) {
1343       ConstantsLock->writer_acquire();
1344       typename AbstractTypeMapTy::iterator I =
1345         AbstractTypeMap.find(cast<Type>(OldTy));
1346
1347       assert(I != AbstractTypeMap.end() &&
1348              "Abstract type not in AbstractTypeMap?");
1349
1350       // Convert a constant at a time until the last one is gone.  The last one
1351       // leaving will remove() itself, causing the AbstractTypeMapEntry to be
1352       // eliminated eventually.
1353       do {
1354         ConvertConstantType<ConstantClass,
1355                             TypeClass>::convert(
1356                                 static_cast<ConstantClass *>(I->second->second),
1357                                                 cast<TypeClass>(NewTy));
1358
1359         I = AbstractTypeMap.find(cast<Type>(OldTy));
1360       } while (I != AbstractTypeMap.end());
1361
1362       ConstantsLock->writer_release();
1363     }
1364
1365     // If the type became concrete without being refined to any other existing
1366     // type, we just remove ourselves from the ATU list.
1367     void typeBecameConcrete(const DerivedType *AbsTy) {
1368       sys::SmartScopedWriter<true> Writer(&*ConstantsLock);
1369       AbsTy->removeAbstractTypeUser(this);
1370     }
1371
1372     void dump() const {
1373       DOUT << "Constant.cpp: ValueMap\n";
1374     }
1375   };
1376 }
1377
1378
1379
1380 //---- ConstantAggregateZero::get() implementation...
1381 //
1382 namespace llvm {
1383   // ConstantAggregateZero does not take extra "value" argument...
1384   template<class ValType>
1385   struct ConstantCreator<ConstantAggregateZero, Type, ValType> {
1386     static ConstantAggregateZero *create(const Type *Ty, const ValType &V){
1387       return new ConstantAggregateZero(Ty);
1388     }
1389   };
1390
1391   template<>
1392   struct ConvertConstantType<ConstantAggregateZero, Type> {
1393     static void convert(ConstantAggregateZero *OldC, const Type *NewTy) {
1394       // Make everyone now use a constant of the new type...
1395       Constant *New = ConstantAggregateZero::get(NewTy);
1396       assert(New != OldC && "Didn't replace constant??");
1397       OldC->uncheckedReplaceAllUsesWith(New);
1398       OldC->destroyConstant();     // This constant is now dead, destroy it.
1399     }
1400   };
1401 }
1402
1403 static ManagedStatic<ValueMap<char, Type,
1404                               ConstantAggregateZero> > AggZeroConstants;
1405
1406 static char getValType(ConstantAggregateZero *CPZ) { return 0; }
1407
1408 ConstantAggregateZero *ConstantAggregateZero::get(const Type *Ty) {
1409   assert((isa<StructType>(Ty) || isa<ArrayType>(Ty) || isa<VectorType>(Ty)) &&
1410          "Cannot create an aggregate zero of non-aggregate type!");
1411
1412   // Implicitly locked.
1413   return AggZeroConstants->getOrCreate(Ty, 0);
1414 }
1415
1416 /// destroyConstant - Remove the constant from the constant table...
1417 ///
1418 void ConstantAggregateZero::destroyConstant() {
1419   // Implicitly locked.
1420   AggZeroConstants->remove(this);
1421   destroyConstantImpl();
1422 }
1423
1424 //---- ConstantArray::get() implementation...
1425 //
1426 namespace llvm {
1427   template<>
1428   struct ConvertConstantType<ConstantArray, ArrayType> {
1429     static void convert(ConstantArray *OldC, const ArrayType *NewTy) {
1430       // Make everyone now use a constant of the new type...
1431       std::vector<Constant*> C;
1432       for (unsigned i = 0, e = OldC->getNumOperands(); i != e; ++i)
1433         C.push_back(cast<Constant>(OldC->getOperand(i)));
1434       Constant *New = ConstantArray::get(NewTy, C);
1435       assert(New != OldC && "Didn't replace constant??");
1436       OldC->uncheckedReplaceAllUsesWith(New);
1437       OldC->destroyConstant();    // This constant is now dead, destroy it.
1438     }
1439   };
1440 }
1441
1442 static std::vector<Constant*> getValType(ConstantArray *CA) {
1443   std::vector<Constant*> Elements;
1444   Elements.reserve(CA->getNumOperands());
1445   for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
1446     Elements.push_back(cast<Constant>(CA->getOperand(i)));
1447   return Elements;
1448 }
1449
1450 typedef ValueMap<std::vector<Constant*>, ArrayType,
1451                  ConstantArray, true /*largekey*/> ArrayConstantsTy;
1452 static ManagedStatic<ArrayConstantsTy> ArrayConstants;
1453
1454 Constant *ConstantArray::get(const ArrayType *Ty,
1455                              const std::vector<Constant*> &V) {
1456   // If this is an all-zero array, return a ConstantAggregateZero object
1457   if (!V.empty()) {
1458     Constant *C = V[0];
1459     if (!C->isNullValue()) {
1460       // Implicitly locked.
1461       return ArrayConstants->getOrCreate(Ty, V);
1462     }
1463     for (unsigned i = 1, e = V.size(); i != e; ++i)
1464       if (V[i] != C) {
1465         // Implicitly locked.
1466         return ArrayConstants->getOrCreate(Ty, V);
1467       }
1468   }
1469
1470   return ConstantAggregateZero::get(Ty);
1471 }
1472
1473 /// destroyConstant - Remove the constant from the constant table...
1474 ///
1475 void ConstantArray::destroyConstant() {
1476   ArrayConstants->remove(this);
1477   destroyConstantImpl();
1478 }
1479
1480 /// ConstantArray::get(const string&) - Return an array that is initialized to
1481 /// contain the specified string.  If length is zero then a null terminator is
1482 /// added to the specified string so that it may be used in a natural way.
1483 /// Otherwise, the length parameter specifies how much of the string to use
1484 /// and it won't be null terminated.
1485 ///
1486 Constant *ConstantArray::get(const std::string &Str, bool AddNull) {
1487   std::vector<Constant*> ElementVals;
1488   for (unsigned i = 0; i < Str.length(); ++i)
1489     ElementVals.push_back(ConstantInt::get(Type::Int8Ty, Str[i]));
1490
1491   // Add a null terminator to the string...
1492   if (AddNull) {
1493     ElementVals.push_back(ConstantInt::get(Type::Int8Ty, 0));
1494   }
1495
1496   ArrayType *ATy = ArrayType::get(Type::Int8Ty, ElementVals.size());
1497   return ConstantArray::get(ATy, ElementVals);
1498 }
1499
1500 /// isString - This method returns true if the array is an array of i8, and
1501 /// if the elements of the array are all ConstantInt's.
1502 bool ConstantArray::isString() const {
1503   // Check the element type for i8...
1504   if (getType()->getElementType() != Type::Int8Ty)
1505     return false;
1506   // Check the elements to make sure they are all integers, not constant
1507   // expressions.
1508   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
1509     if (!isa<ConstantInt>(getOperand(i)))
1510       return false;
1511   return true;
1512 }
1513
1514 /// isCString - This method returns true if the array is a string (see
1515 /// isString) and it ends in a null byte \\0 and does not contains any other
1516 /// null bytes except its terminator.
1517 bool ConstantArray::isCString() const {
1518   // Check the element type for i8...
1519   if (getType()->getElementType() != Type::Int8Ty)
1520     return false;
1521   Constant *Zero = Constant::getNullValue(getOperand(0)->getType());
1522   // Last element must be a null.
1523   if (getOperand(getNumOperands()-1) != Zero)
1524     return false;
1525   // Other elements must be non-null integers.
1526   for (unsigned i = 0, e = getNumOperands()-1; i != e; ++i) {
1527     if (!isa<ConstantInt>(getOperand(i)))
1528       return false;
1529     if (getOperand(i) == Zero)
1530       return false;
1531   }
1532   return true;
1533 }
1534
1535
1536 /// getAsString - If the sub-element type of this array is i8
1537 /// then this method converts the array to an std::string and returns it.
1538 /// Otherwise, it asserts out.
1539 ///
1540 std::string ConstantArray::getAsString() const {
1541   assert(isString() && "Not a string!");
1542   std::string Result;
1543   Result.reserve(getNumOperands());
1544   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
1545     Result.push_back((char)cast<ConstantInt>(getOperand(i))->getZExtValue());
1546   return Result;
1547 }
1548
1549
1550 //---- ConstantStruct::get() implementation...
1551 //
1552
1553 namespace llvm {
1554   template<>
1555   struct ConvertConstantType<ConstantStruct, StructType> {
1556     static void convert(ConstantStruct *OldC, const StructType *NewTy) {
1557       // Make everyone now use a constant of the new type...
1558       std::vector<Constant*> C;
1559       for (unsigned i = 0, e = OldC->getNumOperands(); i != e; ++i)
1560         C.push_back(cast<Constant>(OldC->getOperand(i)));
1561       Constant *New = ConstantStruct::get(NewTy, C);
1562       assert(New != OldC && "Didn't replace constant??");
1563
1564       OldC->uncheckedReplaceAllUsesWith(New);
1565       OldC->destroyConstant();    // This constant is now dead, destroy it.
1566     }
1567   };
1568 }
1569
1570 typedef ValueMap<std::vector<Constant*>, StructType,
1571                  ConstantStruct, true /*largekey*/> StructConstantsTy;
1572 static ManagedStatic<StructConstantsTy> StructConstants;
1573
1574 static std::vector<Constant*> getValType(ConstantStruct *CS) {
1575   std::vector<Constant*> Elements;
1576   Elements.reserve(CS->getNumOperands());
1577   for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i)
1578     Elements.push_back(cast<Constant>(CS->getOperand(i)));
1579   return Elements;
1580 }
1581
1582 Constant *ConstantStruct::get(const StructType *Ty,
1583                               const std::vector<Constant*> &V) {
1584   // Create a ConstantAggregateZero value if all elements are zeros...
1585   for (unsigned i = 0, e = V.size(); i != e; ++i)
1586     if (!V[i]->isNullValue())
1587       // Implicitly locked.
1588       return StructConstants->getOrCreate(Ty, V);
1589
1590   return ConstantAggregateZero::get(Ty);
1591 }
1592
1593 Constant *ConstantStruct::get(const std::vector<Constant*> &V, bool packed) {
1594   std::vector<const Type*> StructEls;
1595   StructEls.reserve(V.size());
1596   for (unsigned i = 0, e = V.size(); i != e; ++i)
1597     StructEls.push_back(V[i]->getType());
1598   return get(StructType::get(StructEls, packed), V);
1599 }
1600
1601 // destroyConstant - Remove the constant from the constant table...
1602 //
1603 void ConstantStruct::destroyConstant() {
1604   StructConstants->remove(this);
1605   destroyConstantImpl();
1606 }
1607
1608 //---- ConstantVector::get() implementation...
1609 //
1610 namespace llvm {
1611   template<>
1612   struct ConvertConstantType<ConstantVector, VectorType> {
1613     static void convert(ConstantVector *OldC, const VectorType *NewTy) {
1614       // Make everyone now use a constant of the new type...
1615       std::vector<Constant*> C;
1616       for (unsigned i = 0, e = OldC->getNumOperands(); i != e; ++i)
1617         C.push_back(cast<Constant>(OldC->getOperand(i)));
1618       Constant *New = ConstantVector::get(NewTy, C);
1619       assert(New != OldC && "Didn't replace constant??");
1620       OldC->uncheckedReplaceAllUsesWith(New);
1621       OldC->destroyConstant();    // This constant is now dead, destroy it.
1622     }
1623   };
1624 }
1625
1626 static std::vector<Constant*> getValType(ConstantVector *CP) {
1627   std::vector<Constant*> Elements;
1628   Elements.reserve(CP->getNumOperands());
1629   for (unsigned i = 0, e = CP->getNumOperands(); i != e; ++i)
1630     Elements.push_back(CP->getOperand(i));
1631   return Elements;
1632 }
1633
1634 static ManagedStatic<ValueMap<std::vector<Constant*>, VectorType,
1635                               ConstantVector> > VectorConstants;
1636
1637 Constant *ConstantVector::get(const VectorType *Ty,
1638                               const std::vector<Constant*> &V) {
1639   assert(!V.empty() && "Vectors can't be empty");
1640   // If this is an all-undef or alll-zero vector, return a
1641   // ConstantAggregateZero or UndefValue.
1642   Constant *C = V[0];
1643   bool isZero = C->isNullValue();
1644   bool isUndef = isa<UndefValue>(C);
1645
1646   if (isZero || isUndef) {
1647     for (unsigned i = 1, e = V.size(); i != e; ++i)
1648       if (V[i] != C) {
1649         isZero = isUndef = false;
1650         break;
1651       }
1652   }
1653
1654   if (isZero)
1655     return ConstantAggregateZero::get(Ty);
1656   if (isUndef)
1657     return UndefValue::get(Ty);
1658
1659   // Implicitly locked.
1660   return VectorConstants->getOrCreate(Ty, V);
1661 }
1662
1663 Constant *ConstantVector::get(const std::vector<Constant*> &V) {
1664   assert(!V.empty() && "Cannot infer type if V is empty");
1665   return get(VectorType::get(V.front()->getType(),V.size()), V);
1666 }
1667
1668 // destroyConstant - Remove the constant from the constant table...
1669 //
1670 void ConstantVector::destroyConstant() {
1671   sys::SmartScopedWriter<true> Write(&*ConstantsLock);
1672   VectorConstants->remove(this);
1673   destroyConstantImpl();
1674 }
1675
1676 /// This function will return true iff every element in this vector constant
1677 /// is set to all ones.
1678 /// @returns true iff this constant's emements are all set to all ones.
1679 /// @brief Determine if the value is all ones.
1680 bool ConstantVector::isAllOnesValue() const {
1681   // Check out first element.
1682   const Constant *Elt = getOperand(0);
1683   const ConstantInt *CI = dyn_cast<ConstantInt>(Elt);
1684   if (!CI || !CI->isAllOnesValue()) return false;
1685   // Then make sure all remaining elements point to the same value.
1686   for (unsigned I = 1, E = getNumOperands(); I < E; ++I) {
1687     if (getOperand(I) != Elt) return false;
1688   }
1689   return true;
1690 }
1691
1692 /// getSplatValue - If this is a splat constant, where all of the
1693 /// elements have the same value, return that value. Otherwise return null.
1694 Constant *ConstantVector::getSplatValue() {
1695   // Check out first element.
1696   Constant *Elt = getOperand(0);
1697   // Then make sure all remaining elements point to the same value.
1698   for (unsigned I = 1, E = getNumOperands(); I < E; ++I)
1699     if (getOperand(I) != Elt) return 0;
1700   return Elt;
1701 }
1702
1703 //---- ConstantPointerNull::get() implementation...
1704 //
1705
1706 namespace llvm {
1707   // ConstantPointerNull does not take extra "value" argument...
1708   template<class ValType>
1709   struct ConstantCreator<ConstantPointerNull, PointerType, ValType> {
1710     static ConstantPointerNull *create(const PointerType *Ty, const ValType &V){
1711       return new ConstantPointerNull(Ty);
1712     }
1713   };
1714
1715   template<>
1716   struct ConvertConstantType<ConstantPointerNull, PointerType> {
1717     static void convert(ConstantPointerNull *OldC, const PointerType *NewTy) {
1718       // Make everyone now use a constant of the new type...
1719       Constant *New = ConstantPointerNull::get(NewTy);
1720       assert(New != OldC && "Didn't replace constant??");
1721       OldC->uncheckedReplaceAllUsesWith(New);
1722       OldC->destroyConstant();     // This constant is now dead, destroy it.
1723     }
1724   };
1725 }
1726
1727 static ManagedStatic<ValueMap<char, PointerType,
1728                               ConstantPointerNull> > NullPtrConstants;
1729
1730 static char getValType(ConstantPointerNull *) {
1731   return 0;
1732 }
1733
1734
1735 ConstantPointerNull *ConstantPointerNull::get(const PointerType *Ty) {
1736   // Implicitly locked.
1737   return NullPtrConstants->getOrCreate(Ty, 0);
1738 }
1739
1740 // destroyConstant - Remove the constant from the constant table...
1741 //
1742 void ConstantPointerNull::destroyConstant() {
1743   sys::SmartScopedWriter<true> Writer(&*ConstantsLock);
1744   NullPtrConstants->remove(this);
1745   destroyConstantImpl();
1746 }
1747
1748
1749 //---- UndefValue::get() implementation...
1750 //
1751
1752 namespace llvm {
1753   // UndefValue does not take extra "value" argument...
1754   template<class ValType>
1755   struct ConstantCreator<UndefValue, Type, ValType> {
1756     static UndefValue *create(const Type *Ty, const ValType &V) {
1757       return new UndefValue(Ty);
1758     }
1759   };
1760
1761   template<>
1762   struct ConvertConstantType<UndefValue, Type> {
1763     static void convert(UndefValue *OldC, const Type *NewTy) {
1764       // Make everyone now use a constant of the new type.
1765       Constant *New = UndefValue::get(NewTy);
1766       assert(New != OldC && "Didn't replace constant??");
1767       OldC->uncheckedReplaceAllUsesWith(New);
1768       OldC->destroyConstant();     // This constant is now dead, destroy it.
1769     }
1770   };
1771 }
1772
1773 static ManagedStatic<ValueMap<char, Type, UndefValue> > UndefValueConstants;
1774
1775 static char getValType(UndefValue *) {
1776   return 0;
1777 }
1778
1779
1780 UndefValue *UndefValue::get(const Type *Ty) {
1781   // Implicitly locked.
1782   return UndefValueConstants->getOrCreate(Ty, 0);
1783 }
1784
1785 // destroyConstant - Remove the constant from the constant table.
1786 //
1787 void UndefValue::destroyConstant() {
1788   // Implicitly locked.
1789   UndefValueConstants->remove(this);
1790   destroyConstantImpl();
1791 }
1792
1793 //---- MDString::get() implementation
1794 //
1795
1796 MDString::MDString(const char *begin, const char *end)
1797   : Constant(Type::MetadataTy, MDStringVal, 0, 0),
1798     StrBegin(begin), StrEnd(end) {}
1799
1800 static ManagedStatic<StringMap<MDString*> > MDStringCache;
1801
1802 MDString *MDString::get(const char *StrBegin, const char *StrEnd) {
1803   sys::SmartScopedWriter<true> Writer(&*ConstantsLock);
1804   StringMapEntry<MDString *> &Entry = MDStringCache->GetOrCreateValue(
1805                                         StrBegin, StrEnd);
1806   MDString *&S = Entry.getValue();
1807   if (!S) S = new MDString(Entry.getKeyData(),
1808                            Entry.getKeyData() + Entry.getKeyLength());
1809
1810   return S;
1811 }
1812
1813 void MDString::destroyConstant() {
1814   sys::SmartScopedWriter<true> Writer(&*ConstantsLock);
1815   MDStringCache->erase(MDStringCache->find(StrBegin, StrEnd));
1816   destroyConstantImpl();
1817 }
1818
1819 //---- MDNode::get() implementation
1820 //
1821
1822 static ManagedStatic<FoldingSet<MDNode> > MDNodeSet;
1823
1824 MDNode::MDNode(Value*const* Vals, unsigned NumVals)
1825   : Constant(Type::MetadataTy, MDNodeVal, 0, 0) {
1826   for (unsigned i = 0; i != NumVals; ++i)
1827     Node.push_back(ElementVH(Vals[i], this));
1828 }
1829
1830 void MDNode::Profile(FoldingSetNodeID &ID) const {
1831   for (const_elem_iterator I = elem_begin(), E = elem_end(); I != E; ++I)
1832     ID.AddPointer(*I);
1833 }
1834
1835 MDNode *MDNode::get(Value*const* Vals, unsigned NumVals) {
1836   FoldingSetNodeID ID;
1837   for (unsigned i = 0; i != NumVals; ++i)
1838     ID.AddPointer(Vals[i]);
1839
1840   ConstantsLock->reader_acquire();
1841   void *InsertPoint;
1842   MDNode *N = MDNodeSet->FindNodeOrInsertPos(ID, InsertPoint);
1843   ConstantsLock->reader_release();
1844
1845   if (!N) {
1846     sys::SmartScopedWriter<true> Writer(&*ConstantsLock);
1847     N = MDNodeSet->FindNodeOrInsertPos(ID, InsertPoint);
1848     if (!N) {
1849       // InsertPoint will have been set by the FindNodeOrInsertPos call.
1850       N = new(0) MDNode(Vals, NumVals);
1851       MDNodeSet->InsertNode(N, InsertPoint);
1852     }
1853   }
1854   return N;
1855 }
1856
1857 void MDNode::destroyConstant() {
1858   sys::SmartScopedWriter<true> Writer(&*ConstantsLock);
1859   MDNodeSet->RemoveNode(this);
1860
1861   destroyConstantImpl();
1862 }
1863
1864 //---- ConstantExpr::get() implementations...
1865 //
1866
1867 namespace {
1868
1869 struct ExprMapKeyType {
1870   typedef SmallVector<unsigned, 4> IndexList;
1871
1872   ExprMapKeyType(unsigned opc,
1873       const std::vector<Constant*> &ops,
1874       unsigned short pred = 0,
1875       const IndexList &inds = IndexList())
1876         : opcode(opc), predicate(pred), operands(ops), indices(inds) {}
1877   uint16_t opcode;
1878   uint16_t predicate;
1879   std::vector<Constant*> operands;
1880   IndexList indices;
1881   bool operator==(const ExprMapKeyType& that) const {
1882     return this->opcode == that.opcode &&
1883            this->predicate == that.predicate &&
1884            this->operands == that.operands &&
1885            this->indices == that.indices;
1886   }
1887   bool operator<(const ExprMapKeyType & that) const {
1888     return this->opcode < that.opcode ||
1889       (this->opcode == that.opcode && this->predicate < that.predicate) ||
1890       (this->opcode == that.opcode && this->predicate == that.predicate &&
1891        this->operands < that.operands) ||
1892       (this->opcode == that.opcode && this->predicate == that.predicate &&
1893        this->operands == that.operands && this->indices < that.indices);
1894   }
1895
1896   bool operator!=(const ExprMapKeyType& that) const {
1897     return !(*this == that);
1898   }
1899 };
1900
1901 }
1902
1903 namespace llvm {
1904   template<>
1905   struct ConstantCreator<ConstantExpr, Type, ExprMapKeyType> {
1906     static ConstantExpr *create(const Type *Ty, const ExprMapKeyType &V,
1907         unsigned short pred = 0) {
1908       if (Instruction::isCast(V.opcode))
1909         return new UnaryConstantExpr(V.opcode, V.operands[0], Ty);
1910       if ((V.opcode >= Instruction::BinaryOpsBegin &&
1911            V.opcode < Instruction::BinaryOpsEnd))
1912         return new BinaryConstantExpr(V.opcode, V.operands[0], V.operands[1]);
1913       if (V.opcode == Instruction::Select)
1914         return new SelectConstantExpr(V.operands[0], V.operands[1],
1915                                       V.operands[2]);
1916       if (V.opcode == Instruction::ExtractElement)
1917         return new ExtractElementConstantExpr(V.operands[0], V.operands[1]);
1918       if (V.opcode == Instruction::InsertElement)
1919         return new InsertElementConstantExpr(V.operands[0], V.operands[1],
1920                                              V.operands[2]);
1921       if (V.opcode == Instruction::ShuffleVector)
1922         return new ShuffleVectorConstantExpr(V.operands[0], V.operands[1],
1923                                              V.operands[2]);
1924       if (V.opcode == Instruction::InsertValue)
1925         return new InsertValueConstantExpr(V.operands[0], V.operands[1],
1926                                            V.indices, Ty);
1927       if (V.opcode == Instruction::ExtractValue)
1928         return new ExtractValueConstantExpr(V.operands[0], V.indices, Ty);
1929       if (V.opcode == Instruction::GetElementPtr) {
1930         std::vector<Constant*> IdxList(V.operands.begin()+1, V.operands.end());
1931         return GetElementPtrConstantExpr::Create(V.operands[0], IdxList, Ty);
1932       }
1933
1934       // The compare instructions are weird. We have to encode the predicate
1935       // value and it is combined with the instruction opcode by multiplying
1936       // the opcode by one hundred. We must decode this to get the predicate.
1937       if (V.opcode == Instruction::ICmp)
1938         return new CompareConstantExpr(Ty, Instruction::ICmp, V.predicate,
1939                                        V.operands[0], V.operands[1]);
1940       if (V.opcode == Instruction::FCmp)
1941         return new CompareConstantExpr(Ty, Instruction::FCmp, V.predicate,
1942                                        V.operands[0], V.operands[1]);
1943       if (V.opcode == Instruction::VICmp)
1944         return new CompareConstantExpr(Ty, Instruction::VICmp, V.predicate,
1945                                        V.operands[0], V.operands[1]);
1946       if (V.opcode == Instruction::VFCmp)
1947         return new CompareConstantExpr(Ty, Instruction::VFCmp, V.predicate,
1948                                        V.operands[0], V.operands[1]);
1949       assert(0 && "Invalid ConstantExpr!");
1950       return 0;
1951     }
1952   };
1953
1954   template<>
1955   struct ConvertConstantType<ConstantExpr, Type> {
1956     static void convert(ConstantExpr *OldC, const Type *NewTy) {
1957       Constant *New;
1958       switch (OldC->getOpcode()) {
1959       case Instruction::Trunc:
1960       case Instruction::ZExt:
1961       case Instruction::SExt:
1962       case Instruction::FPTrunc:
1963       case Instruction::FPExt:
1964       case Instruction::UIToFP:
1965       case Instruction::SIToFP:
1966       case Instruction::FPToUI:
1967       case Instruction::FPToSI:
1968       case Instruction::PtrToInt:
1969       case Instruction::IntToPtr:
1970       case Instruction::BitCast:
1971         New = ConstantExpr::getCast(OldC->getOpcode(), OldC->getOperand(0),
1972                                     NewTy);
1973         break;
1974       case Instruction::Select:
1975         New = ConstantExpr::getSelectTy(NewTy, OldC->getOperand(0),
1976                                         OldC->getOperand(1),
1977                                         OldC->getOperand(2));
1978         break;
1979       default:
1980         assert(OldC->getOpcode() >= Instruction::BinaryOpsBegin &&
1981                OldC->getOpcode() <  Instruction::BinaryOpsEnd);
1982         New = ConstantExpr::getTy(NewTy, OldC->getOpcode(), OldC->getOperand(0),
1983                                   OldC->getOperand(1));
1984         break;
1985       case Instruction::GetElementPtr:
1986         // Make everyone now use a constant of the new type...
1987         std::vector<Value*> Idx(OldC->op_begin()+1, OldC->op_end());
1988         New = ConstantExpr::getGetElementPtrTy(NewTy, OldC->getOperand(0),
1989                                                &Idx[0], Idx.size());
1990         break;
1991       }
1992
1993       assert(New != OldC && "Didn't replace constant??");
1994       OldC->uncheckedReplaceAllUsesWith(New);
1995       OldC->destroyConstant();    // This constant is now dead, destroy it.
1996     }
1997   };
1998 } // end namespace llvm
1999
2000
2001 static ExprMapKeyType getValType(ConstantExpr *CE) {
2002   std::vector<Constant*> Operands;
2003   Operands.reserve(CE->getNumOperands());
2004   for (unsigned i = 0, e = CE->getNumOperands(); i != e; ++i)
2005     Operands.push_back(cast<Constant>(CE->getOperand(i)));
2006   return ExprMapKeyType(CE->getOpcode(), Operands,
2007       CE->isCompare() ? CE->getPredicate() : 0,
2008       CE->hasIndices() ?
2009         CE->getIndices() : SmallVector<unsigned, 4>());
2010 }
2011
2012 static ManagedStatic<ValueMap<ExprMapKeyType, Type,
2013                               ConstantExpr> > ExprConstants;
2014
2015 /// This is a utility function to handle folding of casts and lookup of the
2016 /// cast in the ExprConstants map. It is used by the various get* methods below.
2017 static inline Constant *getFoldedCast(
2018   Instruction::CastOps opc, Constant *C, const Type *Ty) {
2019   assert(Ty->isFirstClassType() && "Cannot cast to an aggregate type!");
2020   // Fold a few common cases
2021   if (Constant *FC = ConstantFoldCastInstruction(opc, C, Ty))
2022     return FC;
2023
2024   // Look up the constant in the table first to ensure uniqueness
2025   std::vector<Constant*> argVec(1, C);
2026   ExprMapKeyType Key(opc, argVec);
2027
2028   // Implicitly locked.
2029   return ExprConstants->getOrCreate(Ty, Key);
2030 }
2031
2032 Constant *ConstantExpr::getCast(unsigned oc, Constant *C, const Type *Ty) {
2033   Instruction::CastOps opc = Instruction::CastOps(oc);
2034   assert(Instruction::isCast(opc) && "opcode out of range");
2035   assert(C && Ty && "Null arguments to getCast");
2036   assert(Ty->isFirstClassType() && "Cannot cast to an aggregate type!");
2037
2038   switch (opc) {
2039     default:
2040       assert(0 && "Invalid cast opcode");
2041       break;
2042     case Instruction::Trunc:    return getTrunc(C, Ty);
2043     case Instruction::ZExt:     return getZExt(C, Ty);
2044     case Instruction::SExt:     return getSExt(C, Ty);
2045     case Instruction::FPTrunc:  return getFPTrunc(C, Ty);
2046     case Instruction::FPExt:    return getFPExtend(C, Ty);
2047     case Instruction::UIToFP:   return getUIToFP(C, Ty);
2048     case Instruction::SIToFP:   return getSIToFP(C, Ty);
2049     case Instruction::FPToUI:   return getFPToUI(C, Ty);
2050     case Instruction::FPToSI:   return getFPToSI(C, Ty);
2051     case Instruction::PtrToInt: return getPtrToInt(C, Ty);
2052     case Instruction::IntToPtr: return getIntToPtr(C, Ty);
2053     case Instruction::BitCast:  return getBitCast(C, Ty);
2054   }
2055   return 0;
2056 }
2057
2058 Constant *ConstantExpr::getZExtOrBitCast(Constant *C, const Type *Ty) {
2059   if (C->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
2060     return getCast(Instruction::BitCast, C, Ty);
2061   return getCast(Instruction::ZExt, C, Ty);
2062 }
2063
2064 Constant *ConstantExpr::getSExtOrBitCast(Constant *C, const Type *Ty) {
2065   if (C->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
2066     return getCast(Instruction::BitCast, C, Ty);
2067   return getCast(Instruction::SExt, C, Ty);
2068 }
2069
2070 Constant *ConstantExpr::getTruncOrBitCast(Constant *C, const Type *Ty) {
2071   if (C->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
2072     return getCast(Instruction::BitCast, C, Ty);
2073   return getCast(Instruction::Trunc, C, Ty);
2074 }
2075
2076 Constant *ConstantExpr::getPointerCast(Constant *S, const Type *Ty) {
2077   assert(isa<PointerType>(S->getType()) && "Invalid cast");
2078   assert((Ty->isInteger() || isa<PointerType>(Ty)) && "Invalid cast");
2079
2080   if (Ty->isInteger())
2081     return getCast(Instruction::PtrToInt, S, Ty);
2082   return getCast(Instruction::BitCast, S, Ty);
2083 }
2084
2085 Constant *ConstantExpr::getIntegerCast(Constant *C, const Type *Ty,
2086                                        bool isSigned) {
2087   assert(C->getType()->isIntOrIntVector() &&
2088          Ty->isIntOrIntVector() && "Invalid cast");
2089   unsigned SrcBits = C->getType()->getScalarSizeInBits();
2090   unsigned DstBits = Ty->getScalarSizeInBits();
2091   Instruction::CastOps opcode =
2092     (SrcBits == DstBits ? Instruction::BitCast :
2093      (SrcBits > DstBits ? Instruction::Trunc :
2094       (isSigned ? Instruction::SExt : Instruction::ZExt)));
2095   return getCast(opcode, C, Ty);
2096 }
2097
2098 Constant *ConstantExpr::getFPCast(Constant *C, const Type *Ty) {
2099   assert(C->getType()->isFPOrFPVector() && Ty->isFPOrFPVector() &&
2100          "Invalid cast");
2101   unsigned SrcBits = C->getType()->getScalarSizeInBits();
2102   unsigned DstBits = Ty->getScalarSizeInBits();
2103   if (SrcBits == DstBits)
2104     return C; // Avoid a useless cast
2105   Instruction::CastOps opcode =
2106      (SrcBits > DstBits ? Instruction::FPTrunc : Instruction::FPExt);
2107   return getCast(opcode, C, Ty);
2108 }
2109
2110 Constant *ConstantExpr::getTrunc(Constant *C, const Type *Ty) {
2111 #ifndef NDEBUG
2112   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
2113   bool toVec = Ty->getTypeID() == Type::VectorTyID;
2114 #endif
2115   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
2116   assert(C->getType()->isIntOrIntVector() && "Trunc operand must be integer");
2117   assert(Ty->isIntOrIntVector() && "Trunc produces only integral");
2118   assert(C->getType()->getScalarSizeInBits() > Ty->getScalarSizeInBits()&&
2119          "SrcTy must be larger than DestTy for Trunc!");
2120
2121   return getFoldedCast(Instruction::Trunc, C, Ty);
2122 }
2123
2124 Constant *ConstantExpr::getSExt(Constant *C, const Type *Ty) {
2125 #ifndef NDEBUG
2126   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
2127   bool toVec = Ty->getTypeID() == Type::VectorTyID;
2128 #endif
2129   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
2130   assert(C->getType()->isIntOrIntVector() && "SExt operand must be integral");
2131   assert(Ty->isIntOrIntVector() && "SExt produces only integer");
2132   assert(C->getType()->getScalarSizeInBits() < Ty->getScalarSizeInBits()&&
2133          "SrcTy must be smaller than DestTy for SExt!");
2134
2135   return getFoldedCast(Instruction::SExt, C, Ty);
2136 }
2137
2138 Constant *ConstantExpr::getZExt(Constant *C, const Type *Ty) {
2139 #ifndef NDEBUG
2140   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
2141   bool toVec = Ty->getTypeID() == Type::VectorTyID;
2142 #endif
2143   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
2144   assert(C->getType()->isIntOrIntVector() && "ZEXt operand must be integral");
2145   assert(Ty->isIntOrIntVector() && "ZExt produces only integer");
2146   assert(C->getType()->getScalarSizeInBits() < Ty->getScalarSizeInBits()&&
2147          "SrcTy must be smaller than DestTy for ZExt!");
2148
2149   return getFoldedCast(Instruction::ZExt, C, Ty);
2150 }
2151
2152 Constant *ConstantExpr::getFPTrunc(Constant *C, const Type *Ty) {
2153 #ifndef NDEBUG
2154   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
2155   bool toVec = Ty->getTypeID() == Type::VectorTyID;
2156 #endif
2157   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
2158   assert(C->getType()->isFPOrFPVector() && Ty->isFPOrFPVector() &&
2159          C->getType()->getScalarSizeInBits() > Ty->getScalarSizeInBits()&&
2160          "This is an illegal floating point truncation!");
2161   return getFoldedCast(Instruction::FPTrunc, C, Ty);
2162 }
2163
2164 Constant *ConstantExpr::getFPExtend(Constant *C, const Type *Ty) {
2165 #ifndef NDEBUG
2166   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
2167   bool toVec = Ty->getTypeID() == Type::VectorTyID;
2168 #endif
2169   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
2170   assert(C->getType()->isFPOrFPVector() && Ty->isFPOrFPVector() &&
2171          C->getType()->getScalarSizeInBits() < Ty->getScalarSizeInBits()&&
2172          "This is an illegal floating point extension!");
2173   return getFoldedCast(Instruction::FPExt, C, Ty);
2174 }
2175
2176 Constant *ConstantExpr::getUIToFP(Constant *C, const Type *Ty) {
2177 #ifndef NDEBUG
2178   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
2179   bool toVec = Ty->getTypeID() == Type::VectorTyID;
2180 #endif
2181   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
2182   assert(C->getType()->isIntOrIntVector() && Ty->isFPOrFPVector() &&
2183          "This is an illegal uint to floating point cast!");
2184   return getFoldedCast(Instruction::UIToFP, C, Ty);
2185 }
2186
2187 Constant *ConstantExpr::getSIToFP(Constant *C, const Type *Ty) {
2188 #ifndef NDEBUG
2189   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
2190   bool toVec = Ty->getTypeID() == Type::VectorTyID;
2191 #endif
2192   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
2193   assert(C->getType()->isIntOrIntVector() && Ty->isFPOrFPVector() &&
2194          "This is an illegal sint to floating point cast!");
2195   return getFoldedCast(Instruction::SIToFP, C, Ty);
2196 }
2197
2198 Constant *ConstantExpr::getFPToUI(Constant *C, const Type *Ty) {
2199 #ifndef NDEBUG
2200   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
2201   bool toVec = Ty->getTypeID() == Type::VectorTyID;
2202 #endif
2203   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
2204   assert(C->getType()->isFPOrFPVector() && Ty->isIntOrIntVector() &&
2205          "This is an illegal floating point to uint cast!");
2206   return getFoldedCast(Instruction::FPToUI, C, Ty);
2207 }
2208
2209 Constant *ConstantExpr::getFPToSI(Constant *C, const Type *Ty) {
2210 #ifndef NDEBUG
2211   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
2212   bool toVec = Ty->getTypeID() == Type::VectorTyID;
2213 #endif
2214   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
2215   assert(C->getType()->isFPOrFPVector() && Ty->isIntOrIntVector() &&
2216          "This is an illegal floating point to sint cast!");
2217   return getFoldedCast(Instruction::FPToSI, C, Ty);
2218 }
2219
2220 Constant *ConstantExpr::getPtrToInt(Constant *C, const Type *DstTy) {
2221   assert(isa<PointerType>(C->getType()) && "PtrToInt source must be pointer");
2222   assert(DstTy->isInteger() && "PtrToInt destination must be integral");
2223   return getFoldedCast(Instruction::PtrToInt, C, DstTy);
2224 }
2225
2226 Constant *ConstantExpr::getIntToPtr(Constant *C, const Type *DstTy) {
2227   assert(C->getType()->isInteger() && "IntToPtr source must be integral");
2228   assert(isa<PointerType>(DstTy) && "IntToPtr destination must be a pointer");
2229   return getFoldedCast(Instruction::IntToPtr, C, DstTy);
2230 }
2231
2232 Constant *ConstantExpr::getBitCast(Constant *C, const Type *DstTy) {
2233   // BitCast implies a no-op cast of type only. No bits change.  However, you
2234   // can't cast pointers to anything but pointers.
2235 #ifndef NDEBUG
2236   const Type *SrcTy = C->getType();
2237   assert((isa<PointerType>(SrcTy) == isa<PointerType>(DstTy)) &&
2238          "BitCast cannot cast pointer to non-pointer and vice versa");
2239
2240   // Now we know we're not dealing with mismatched pointer casts (ptr->nonptr
2241   // or nonptr->ptr). For all the other types, the cast is okay if source and
2242   // destination bit widths are identical.
2243   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
2244   unsigned DstBitSize = DstTy->getPrimitiveSizeInBits();
2245 #endif
2246   assert(SrcBitSize == DstBitSize && "BitCast requires types of same width");
2247
2248   // It is common to ask for a bitcast of a value to its own type, handle this
2249   // speedily.
2250   if (C->getType() == DstTy) return C;
2251
2252   return getFoldedCast(Instruction::BitCast, C, DstTy);
2253 }
2254
2255 Constant *ConstantExpr::getAlignOf(const Type *Ty) {
2256   // alignof is implemented as: (i64) gep ({i8,Ty}*)null, 0, 1
2257   const Type *AligningTy = StructType::get(Type::Int8Ty, Ty, NULL);
2258   Constant *NullPtr = getNullValue(AligningTy->getPointerTo());
2259   Constant *Zero = ConstantInt::get(Type::Int32Ty, 0);
2260   Constant *One = ConstantInt::get(Type::Int32Ty, 1);
2261   Constant *Indices[2] = { Zero, One };
2262   Constant *GEP = getGetElementPtr(NullPtr, Indices, 2);
2263   return getCast(Instruction::PtrToInt, GEP, Type::Int32Ty);
2264 }
2265
2266 Constant *ConstantExpr::getSizeOf(const Type *Ty) {
2267   // sizeof is implemented as: (i64) gep (Ty*)null, 1
2268   Constant *GEPIdx = ConstantInt::get(Type::Int32Ty, 1);
2269   Constant *GEP =
2270     getGetElementPtr(getNullValue(PointerType::getUnqual(Ty)), &GEPIdx, 1);
2271   return getCast(Instruction::PtrToInt, GEP, Type::Int64Ty);
2272 }
2273
2274 Constant *ConstantExpr::getTy(const Type *ReqTy, unsigned Opcode,
2275                               Constant *C1, Constant *C2) {
2276   // Check the operands for consistency first
2277   assert(Opcode >= Instruction::BinaryOpsBegin &&
2278          Opcode <  Instruction::BinaryOpsEnd   &&
2279          "Invalid opcode in binary constant expression");
2280   assert(C1->getType() == C2->getType() &&
2281          "Operand types in binary constant expression should match");
2282
2283   if (ReqTy == C1->getType() || ReqTy == Type::Int1Ty)
2284     if (Constant *FC = ConstantFoldBinaryInstruction(Opcode, C1, C2))
2285       return FC;          // Fold a few common cases...
2286
2287   std::vector<Constant*> argVec(1, C1); argVec.push_back(C2);
2288   ExprMapKeyType Key(Opcode, argVec);
2289
2290   // Implicitly locked.
2291   return ExprConstants->getOrCreate(ReqTy, Key);
2292 }
2293
2294 Constant *ConstantExpr::getCompareTy(unsigned short predicate,
2295                                      Constant *C1, Constant *C2) {
2296   bool isVectorType = C1->getType()->getTypeID() == Type::VectorTyID;
2297   switch (predicate) {
2298     default: assert(0 && "Invalid CmpInst predicate");
2299     case CmpInst::FCMP_FALSE: case CmpInst::FCMP_OEQ: case CmpInst::FCMP_OGT:
2300     case CmpInst::FCMP_OGE:   case CmpInst::FCMP_OLT: case CmpInst::FCMP_OLE:
2301     case CmpInst::FCMP_ONE:   case CmpInst::FCMP_ORD: case CmpInst::FCMP_UNO:
2302     case CmpInst::FCMP_UEQ:   case CmpInst::FCMP_UGT: case CmpInst::FCMP_UGE:
2303     case CmpInst::FCMP_ULT:   case CmpInst::FCMP_ULE: case CmpInst::FCMP_UNE:
2304     case CmpInst::FCMP_TRUE:
2305       return isVectorType ? getVFCmp(predicate, C1, C2)
2306                           : getFCmp(predicate, C1, C2);
2307     case CmpInst::ICMP_EQ:  case CmpInst::ICMP_NE:  case CmpInst::ICMP_UGT:
2308     case CmpInst::ICMP_UGE: case CmpInst::ICMP_ULT: case CmpInst::ICMP_ULE:
2309     case CmpInst::ICMP_SGT: case CmpInst::ICMP_SGE: case CmpInst::ICMP_SLT:
2310     case CmpInst::ICMP_SLE:
2311       return isVectorType ? getVICmp(predicate, C1, C2)
2312                           : getICmp(predicate, C1, C2);
2313   }
2314 }
2315
2316 Constant *ConstantExpr::get(unsigned Opcode, Constant *C1, Constant *C2) {
2317   // API compatibility: Adjust integer opcodes to floating-point opcodes.
2318   if (C1->getType()->isFPOrFPVector()) {
2319     if (Opcode == Instruction::Add) Opcode = Instruction::FAdd;
2320     else if (Opcode == Instruction::Sub) Opcode = Instruction::FSub;
2321     else if (Opcode == Instruction::Mul) Opcode = Instruction::FMul;
2322   }
2323 #ifndef NDEBUG
2324   switch (Opcode) {
2325   case Instruction::Add:
2326   case Instruction::Sub:
2327   case Instruction::Mul:
2328     assert(C1->getType() == C2->getType() && "Op types should be identical!");
2329     assert(C1->getType()->isIntOrIntVector() &&
2330            "Tried to create an integer operation on a non-integer type!");
2331     break;
2332   case Instruction::FAdd:
2333   case Instruction::FSub:
2334   case Instruction::FMul:
2335     assert(C1->getType() == C2->getType() && "Op types should be identical!");
2336     assert(C1->getType()->isFPOrFPVector() &&
2337            "Tried to create a floating-point operation on a "
2338            "non-floating-point type!");
2339     break;
2340   case Instruction::UDiv:
2341   case Instruction::SDiv:
2342     assert(C1->getType() == C2->getType() && "Op types should be identical!");
2343     assert(C1->getType()->isIntOrIntVector() &&
2344            "Tried to create an arithmetic operation on a non-arithmetic type!");
2345     break;
2346   case Instruction::FDiv:
2347     assert(C1->getType() == C2->getType() && "Op types should be identical!");
2348     assert(C1->getType()->isFPOrFPVector() &&
2349            "Tried to create an arithmetic operation on a non-arithmetic type!");
2350     break;
2351   case Instruction::URem:
2352   case Instruction::SRem:
2353     assert(C1->getType() == C2->getType() && "Op types should be identical!");
2354     assert(C1->getType()->isIntOrIntVector() &&
2355            "Tried to create an arithmetic operation on a non-arithmetic type!");
2356     break;
2357   case Instruction::FRem:
2358     assert(C1->getType() == C2->getType() && "Op types should be identical!");
2359     assert(C1->getType()->isFPOrFPVector() &&
2360            "Tried to create an arithmetic operation on a non-arithmetic type!");
2361     break;
2362   case Instruction::And:
2363   case Instruction::Or:
2364   case Instruction::Xor:
2365     assert(C1->getType() == C2->getType() && "Op types should be identical!");
2366     assert(C1->getType()->isIntOrIntVector() &&
2367            "Tried to create a logical operation on a non-integral type!");
2368     break;
2369   case Instruction::Shl:
2370   case Instruction::LShr:
2371   case Instruction::AShr:
2372     assert(C1->getType() == C2->getType() && "Op types should be identical!");
2373     assert(C1->getType()->isIntOrIntVector() &&
2374            "Tried to create a shift operation on a non-integer type!");
2375     break;
2376   default:
2377     break;
2378   }
2379 #endif
2380
2381   return getTy(C1->getType(), Opcode, C1, C2);
2382 }
2383
2384 Constant *ConstantExpr::getCompare(unsigned short pred,
2385                             Constant *C1, Constant *C2) {
2386   assert(C1->getType() == C2->getType() && "Op types should be identical!");
2387   return getCompareTy(pred, C1, C2);
2388 }
2389
2390 Constant *ConstantExpr::getSelectTy(const Type *ReqTy, Constant *C,
2391                                     Constant *V1, Constant *V2) {
2392   assert(!SelectInst::areInvalidOperands(C, V1, V2)&&"Invalid select operands");
2393
2394   if (ReqTy == V1->getType())
2395     if (Constant *SC = ConstantFoldSelectInstruction(C, V1, V2))
2396       return SC;        // Fold common cases
2397
2398   std::vector<Constant*> argVec(3, C);
2399   argVec[1] = V1;
2400   argVec[2] = V2;
2401   ExprMapKeyType Key(Instruction::Select, argVec);
2402
2403   // Implicitly locked.
2404   return ExprConstants->getOrCreate(ReqTy, Key);
2405 }
2406
2407 Constant *ConstantExpr::getGetElementPtrTy(const Type *ReqTy, Constant *C,
2408                                            Value* const *Idxs,
2409                                            unsigned NumIdx) {
2410   assert(GetElementPtrInst::getIndexedType(C->getType(), Idxs,
2411                                            Idxs+NumIdx) ==
2412          cast<PointerType>(ReqTy)->getElementType() &&
2413          "GEP indices invalid!");
2414
2415   if (Constant *FC = ConstantFoldGetElementPtr(C, (Constant**)Idxs, NumIdx))
2416     return FC;          // Fold a few common cases...
2417
2418   assert(isa<PointerType>(C->getType()) &&
2419          "Non-pointer type for constant GetElementPtr expression");
2420   // Look up the constant in the table first to ensure uniqueness
2421   std::vector<Constant*> ArgVec;
2422   ArgVec.reserve(NumIdx+1);
2423   ArgVec.push_back(C);
2424   for (unsigned i = 0; i != NumIdx; ++i)
2425     ArgVec.push_back(cast<Constant>(Idxs[i]));
2426   const ExprMapKeyType Key(Instruction::GetElementPtr, ArgVec);
2427
2428   // Implicitly locked.
2429   return ExprConstants->getOrCreate(ReqTy, Key);
2430 }
2431
2432 Constant *ConstantExpr::getGetElementPtr(Constant *C, Value* const *Idxs,
2433                                          unsigned NumIdx) {
2434   // Get the result type of the getelementptr!
2435   const Type *Ty =
2436     GetElementPtrInst::getIndexedType(C->getType(), Idxs, Idxs+NumIdx);
2437   assert(Ty && "GEP indices invalid!");
2438   unsigned As = cast<PointerType>(C->getType())->getAddressSpace();
2439   return getGetElementPtrTy(PointerType::get(Ty, As), C, Idxs, NumIdx);
2440 }
2441
2442 Constant *ConstantExpr::getGetElementPtr(Constant *C, Constant* const *Idxs,
2443                                          unsigned NumIdx) {
2444   return getGetElementPtr(C, (Value* const *)Idxs, NumIdx);
2445 }
2446
2447
2448 Constant *
2449 ConstantExpr::getICmp(unsigned short pred, Constant* LHS, Constant* RHS) {
2450   assert(LHS->getType() == RHS->getType());
2451   assert(pred >= ICmpInst::FIRST_ICMP_PREDICATE &&
2452          pred <= ICmpInst::LAST_ICMP_PREDICATE && "Invalid ICmp Predicate");
2453
2454   if (Constant *FC = ConstantFoldCompareInstruction(pred, LHS, RHS))
2455     return FC;          // Fold a few common cases...
2456
2457   // Look up the constant in the table first to ensure uniqueness
2458   std::vector<Constant*> ArgVec;
2459   ArgVec.push_back(LHS);
2460   ArgVec.push_back(RHS);
2461   // Get the key type with both the opcode and predicate
2462   const ExprMapKeyType Key(Instruction::ICmp, ArgVec, pred);
2463
2464   // Implicitly locked.
2465   return ExprConstants->getOrCreate(Type::Int1Ty, Key);
2466 }
2467
2468 Constant *
2469 ConstantExpr::getFCmp(unsigned short pred, Constant* LHS, Constant* RHS) {
2470   assert(LHS->getType() == RHS->getType());
2471   assert(pred <= FCmpInst::LAST_FCMP_PREDICATE && "Invalid FCmp Predicate");
2472
2473   if (Constant *FC = ConstantFoldCompareInstruction(pred, LHS, RHS))
2474     return FC;          // Fold a few common cases...
2475
2476   // Look up the constant in the table first to ensure uniqueness
2477   std::vector<Constant*> ArgVec;
2478   ArgVec.push_back(LHS);
2479   ArgVec.push_back(RHS);
2480   // Get the key type with both the opcode and predicate
2481   const ExprMapKeyType Key(Instruction::FCmp, ArgVec, pred);
2482
2483   // Implicitly locked.
2484   return ExprConstants->getOrCreate(Type::Int1Ty, Key);
2485 }
2486
2487 Constant *
2488 ConstantExpr::getVICmp(unsigned short pred, Constant* LHS, Constant* RHS) {
2489   assert(isa<VectorType>(LHS->getType()) && LHS->getType() == RHS->getType() &&
2490          "Tried to create vicmp operation on non-vector type!");
2491   assert(pred >= ICmpInst::FIRST_ICMP_PREDICATE &&
2492          pred <= ICmpInst::LAST_ICMP_PREDICATE && "Invalid VICmp Predicate");
2493
2494   const VectorType *VTy = cast<VectorType>(LHS->getType());
2495   const Type *EltTy = VTy->getElementType();
2496   unsigned NumElts = VTy->getNumElements();
2497
2498   // See if we can fold the element-wise comparison of the LHS and RHS.
2499   SmallVector<Constant *, 16> LHSElts, RHSElts;
2500   LHS->getVectorElements(LHSElts);
2501   RHS->getVectorElements(RHSElts);
2502
2503   if (!LHSElts.empty() && !RHSElts.empty()) {
2504     SmallVector<Constant *, 16> Elts;
2505     for (unsigned i = 0; i != NumElts; ++i) {
2506       Constant *FC = ConstantFoldCompareInstruction(pred, LHSElts[i],
2507                                                     RHSElts[i]);
2508       if (ConstantInt *FCI = dyn_cast_or_null<ConstantInt>(FC)) {
2509         if (FCI->getZExtValue())
2510           Elts.push_back(ConstantInt::getAllOnesValue(EltTy));
2511         else
2512           Elts.push_back(ConstantInt::get(EltTy, 0ULL));
2513       } else if (FC && isa<UndefValue>(FC)) {
2514         Elts.push_back(UndefValue::get(EltTy));
2515       } else {
2516         break;
2517       }
2518     }
2519     if (Elts.size() == NumElts)
2520       return ConstantVector::get(&Elts[0], Elts.size());
2521   }
2522
2523   // Look up the constant in the table first to ensure uniqueness
2524   std::vector<Constant*> ArgVec;
2525   ArgVec.push_back(LHS);
2526   ArgVec.push_back(RHS);
2527   // Get the key type with both the opcode and predicate
2528   const ExprMapKeyType Key(Instruction::VICmp, ArgVec, pred);
2529
2530   // Implicitly locked.
2531   return ExprConstants->getOrCreate(LHS->getType(), Key);
2532 }
2533
2534 Constant *
2535 ConstantExpr::getVFCmp(unsigned short pred, Constant* LHS, Constant* RHS) {
2536   assert(isa<VectorType>(LHS->getType()) &&
2537          "Tried to create vfcmp operation on non-vector type!");
2538   assert(LHS->getType() == RHS->getType());
2539   assert(pred <= FCmpInst::LAST_FCMP_PREDICATE && "Invalid VFCmp Predicate");
2540
2541   const VectorType *VTy = cast<VectorType>(LHS->getType());
2542   unsigned NumElts = VTy->getNumElements();
2543   const Type *EltTy = VTy->getElementType();
2544   const Type *REltTy = IntegerType::get(EltTy->getPrimitiveSizeInBits());
2545   const Type *ResultTy = VectorType::get(REltTy, NumElts);
2546
2547   // See if we can fold the element-wise comparison of the LHS and RHS.
2548   SmallVector<Constant *, 16> LHSElts, RHSElts;
2549   LHS->getVectorElements(LHSElts);
2550   RHS->getVectorElements(RHSElts);
2551
2552   if (!LHSElts.empty() && !RHSElts.empty()) {
2553     SmallVector<Constant *, 16> Elts;
2554     for (unsigned i = 0; i != NumElts; ++i) {
2555       Constant *FC = ConstantFoldCompareInstruction(pred, LHSElts[i],
2556                                                     RHSElts[i]);
2557       if (ConstantInt *FCI = dyn_cast_or_null<ConstantInt>(FC)) {
2558         if (FCI->getZExtValue())
2559           Elts.push_back(ConstantInt::getAllOnesValue(REltTy));
2560         else
2561           Elts.push_back(ConstantInt::get(REltTy, 0ULL));
2562       } else if (FC && isa<UndefValue>(FC)) {
2563         Elts.push_back(UndefValue::get(REltTy));
2564       } else {
2565         break;
2566       }
2567     }
2568     if (Elts.size() == NumElts)
2569       return ConstantVector::get(&Elts[0], Elts.size());
2570   }
2571
2572   // Look up the constant in the table first to ensure uniqueness
2573   std::vector<Constant*> ArgVec;
2574   ArgVec.push_back(LHS);
2575   ArgVec.push_back(RHS);
2576   // Get the key type with both the opcode and predicate
2577   const ExprMapKeyType Key(Instruction::VFCmp, ArgVec, pred);
2578
2579   // Implicitly locked.
2580   return ExprConstants->getOrCreate(ResultTy, Key);
2581 }
2582
2583 Constant *ConstantExpr::getExtractElementTy(const Type *ReqTy, Constant *Val,
2584                                             Constant *Idx) {
2585   if (Constant *FC = ConstantFoldExtractElementInstruction(Val, Idx))
2586     return FC;          // Fold a few common cases...
2587   // Look up the constant in the table first to ensure uniqueness
2588   std::vector<Constant*> ArgVec(1, Val);
2589   ArgVec.push_back(Idx);
2590   const ExprMapKeyType Key(Instruction::ExtractElement,ArgVec);
2591
2592   // Implicitly locked.
2593   return ExprConstants->getOrCreate(ReqTy, Key);
2594 }
2595
2596 Constant *ConstantExpr::getExtractElement(Constant *Val, Constant *Idx) {
2597   assert(isa<VectorType>(Val->getType()) &&
2598          "Tried to create extractelement operation on non-vector type!");
2599   assert(Idx->getType() == Type::Int32Ty &&
2600          "Extractelement index must be i32 type!");
2601   return getExtractElementTy(cast<VectorType>(Val->getType())->getElementType(),
2602                              Val, Idx);
2603 }
2604
2605 Constant *ConstantExpr::getInsertElementTy(const Type *ReqTy, Constant *Val,
2606                                            Constant *Elt, Constant *Idx) {
2607   if (Constant *FC = ConstantFoldInsertElementInstruction(Val, Elt, Idx))
2608     return FC;          // Fold a few common cases...
2609   // Look up the constant in the table first to ensure uniqueness
2610   std::vector<Constant*> ArgVec(1, Val);
2611   ArgVec.push_back(Elt);
2612   ArgVec.push_back(Idx);
2613   const ExprMapKeyType Key(Instruction::InsertElement,ArgVec);
2614
2615   // Implicitly locked.
2616   return ExprConstants->getOrCreate(ReqTy, Key);
2617 }
2618
2619 Constant *ConstantExpr::getInsertElement(Constant *Val, Constant *Elt,
2620                                          Constant *Idx) {
2621   assert(isa<VectorType>(Val->getType()) &&
2622          "Tried to create insertelement operation on non-vector type!");
2623   assert(Elt->getType() == cast<VectorType>(Val->getType())->getElementType()
2624          && "Insertelement types must match!");
2625   assert(Idx->getType() == Type::Int32Ty &&
2626          "Insertelement index must be i32 type!");
2627   return getInsertElementTy(Val->getType(), Val, Elt, Idx);
2628 }
2629
2630 Constant *ConstantExpr::getShuffleVectorTy(const Type *ReqTy, Constant *V1,
2631                                            Constant *V2, Constant *Mask) {
2632   if (Constant *FC = ConstantFoldShuffleVectorInstruction(V1, V2, Mask))
2633     return FC;          // Fold a few common cases...
2634   // Look up the constant in the table first to ensure uniqueness
2635   std::vector<Constant*> ArgVec(1, V1);
2636   ArgVec.push_back(V2);
2637   ArgVec.push_back(Mask);
2638   const ExprMapKeyType Key(Instruction::ShuffleVector,ArgVec);
2639
2640   // Implicitly locked.
2641   return ExprConstants->getOrCreate(ReqTy, Key);
2642 }
2643
2644 Constant *ConstantExpr::getShuffleVector(Constant *V1, Constant *V2,
2645                                          Constant *Mask) {
2646   assert(ShuffleVectorInst::isValidOperands(V1, V2, Mask) &&
2647          "Invalid shuffle vector constant expr operands!");
2648
2649   unsigned NElts = cast<VectorType>(Mask->getType())->getNumElements();
2650   const Type *EltTy = cast<VectorType>(V1->getType())->getElementType();
2651   const Type *ShufTy = VectorType::get(EltTy, NElts);
2652   return getShuffleVectorTy(ShufTy, V1, V2, Mask);
2653 }
2654
2655 Constant *ConstantExpr::getInsertValueTy(const Type *ReqTy, Constant *Agg,
2656                                          Constant *Val,
2657                                         const unsigned *Idxs, unsigned NumIdx) {
2658   assert(ExtractValueInst::getIndexedType(Agg->getType(), Idxs,
2659                                           Idxs+NumIdx) == Val->getType() &&
2660          "insertvalue indices invalid!");
2661   assert(Agg->getType() == ReqTy &&
2662          "insertvalue type invalid!");
2663   assert(Agg->getType()->isFirstClassType() &&
2664          "Non-first-class type for constant InsertValue expression");
2665   Constant *FC = ConstantFoldInsertValueInstruction(Agg, Val, Idxs, NumIdx);
2666   assert(FC && "InsertValue constant expr couldn't be folded!");
2667   return FC;
2668 }
2669
2670 Constant *ConstantExpr::getInsertValue(Constant *Agg, Constant *Val,
2671                                      const unsigned *IdxList, unsigned NumIdx) {
2672   assert(Agg->getType()->isFirstClassType() &&
2673          "Tried to create insertelement operation on non-first-class type!");
2674
2675   const Type *ReqTy = Agg->getType();
2676 #ifndef NDEBUG
2677   const Type *ValTy =
2678     ExtractValueInst::getIndexedType(Agg->getType(), IdxList, IdxList+NumIdx);
2679 #endif
2680   assert(ValTy == Val->getType() && "insertvalue indices invalid!");
2681   return getInsertValueTy(ReqTy, Agg, Val, IdxList, NumIdx);
2682 }
2683
2684 Constant *ConstantExpr::getExtractValueTy(const Type *ReqTy, Constant *Agg,
2685                                         const unsigned *Idxs, unsigned NumIdx) {
2686   assert(ExtractValueInst::getIndexedType(Agg->getType(), Idxs,
2687                                           Idxs+NumIdx) == ReqTy &&
2688          "extractvalue indices invalid!");
2689   assert(Agg->getType()->isFirstClassType() &&
2690          "Non-first-class type for constant extractvalue expression");
2691   Constant *FC = ConstantFoldExtractValueInstruction(Agg, Idxs, NumIdx);
2692   assert(FC && "ExtractValue constant expr couldn't be folded!");
2693   return FC;
2694 }
2695
2696 Constant *ConstantExpr::getExtractValue(Constant *Agg,
2697                                      const unsigned *IdxList, unsigned NumIdx) {
2698   assert(Agg->getType()->isFirstClassType() &&
2699          "Tried to create extractelement operation on non-first-class type!");
2700
2701   const Type *ReqTy =
2702     ExtractValueInst::getIndexedType(Agg->getType(), IdxList, IdxList+NumIdx);
2703   assert(ReqTy && "extractvalue indices invalid!");
2704   return getExtractValueTy(ReqTy, Agg, IdxList, NumIdx);
2705 }
2706
2707 Constant *ConstantExpr::getZeroValueForNegationExpr(const Type *Ty) {
2708   if (const VectorType *PTy = dyn_cast<VectorType>(Ty))
2709     if (PTy->getElementType()->isFloatingPoint()) {
2710       std::vector<Constant*> zeros(PTy->getNumElements(),
2711                            ConstantFP::getNegativeZero(PTy->getElementType()));
2712       return ConstantVector::get(PTy, zeros);
2713     }
2714
2715   if (Ty->isFloatingPoint())
2716     return ConstantFP::getNegativeZero(Ty);
2717
2718   return Constant::getNullValue(Ty);
2719 }
2720
2721 // destroyConstant - Remove the constant from the constant table...
2722 //
2723 void ConstantExpr::destroyConstant() {
2724   sys::SmartScopedWriter<true> Writer(&*ConstantsLock);
2725   ExprConstants->remove(this);
2726   destroyConstantImpl();
2727 }
2728
2729 const char *ConstantExpr::getOpcodeName() const {
2730   return Instruction::getOpcodeName(getOpcode());
2731 }
2732
2733 //===----------------------------------------------------------------------===//
2734 //                replaceUsesOfWithOnConstant implementations
2735
2736 /// replaceUsesOfWithOnConstant - Update this constant array to change uses of
2737 /// 'From' to be uses of 'To'.  This must update the uniquing data structures
2738 /// etc.
2739 ///
2740 /// Note that we intentionally replace all uses of From with To here.  Consider
2741 /// a large array that uses 'From' 1000 times.  By handling this case all here,
2742 /// ConstantArray::replaceUsesOfWithOnConstant is only invoked once, and that
2743 /// single invocation handles all 1000 uses.  Handling them one at a time would
2744 /// work, but would be really slow because it would have to unique each updated
2745 /// array instance.
2746 void ConstantArray::replaceUsesOfWithOnConstant(Value *From, Value *To,
2747                                                 Use *U) {
2748   assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
2749   Constant *ToC = cast<Constant>(To);
2750
2751   std::pair<ArrayConstantsTy::MapKey, Constant*> Lookup;
2752   Lookup.first.first = getType();
2753   Lookup.second = this;
2754
2755   std::vector<Constant*> &Values = Lookup.first.second;
2756   Values.reserve(getNumOperands());  // Build replacement array.
2757
2758   // Fill values with the modified operands of the constant array.  Also,
2759   // compute whether this turns into an all-zeros array.
2760   bool isAllZeros = false;
2761   unsigned NumUpdated = 0;
2762   if (!ToC->isNullValue()) {
2763     for (Use *O = OperandList, *E = OperandList+getNumOperands(); O != E; ++O) {
2764       Constant *Val = cast<Constant>(O->get());
2765       if (Val == From) {
2766         Val = ToC;
2767         ++NumUpdated;
2768       }
2769       Values.push_back(Val);
2770     }
2771   } else {
2772     isAllZeros = true;
2773     for (Use *O = OperandList, *E = OperandList+getNumOperands(); O != E; ++O) {
2774       Constant *Val = cast<Constant>(O->get());
2775       if (Val == From) {
2776         Val = ToC;
2777         ++NumUpdated;
2778       }
2779       Values.push_back(Val);
2780       if (isAllZeros) isAllZeros = Val->isNullValue();
2781     }
2782   }
2783
2784   Constant *Replacement = 0;
2785   if (isAllZeros) {
2786     Replacement = ConstantAggregateZero::get(getType());
2787   } else {
2788     // Check to see if we have this array type already.
2789     sys::SmartScopedWriter<true> Writer(&*ConstantsLock);
2790     bool Exists;
2791     ArrayConstantsTy::MapTy::iterator I =
2792       ArrayConstants->InsertOrGetItem(Lookup, Exists);
2793
2794     if (Exists) {
2795       Replacement = I->second;
2796     } else {
2797       // Okay, the new shape doesn't exist in the system yet.  Instead of
2798       // creating a new constant array, inserting it, replaceallusesof'ing the
2799       // old with the new, then deleting the old... just update the current one
2800       // in place!
2801       ArrayConstants->MoveConstantToNewSlot(this, I);
2802
2803       // Update to the new value.  Optimize for the case when we have a single
2804       // operand that we're changing, but handle bulk updates efficiently.
2805       if (NumUpdated == 1) {
2806         unsigned OperandToUpdate = U-OperandList;
2807         assert(getOperand(OperandToUpdate) == From &&
2808                "ReplaceAllUsesWith broken!");
2809         setOperand(OperandToUpdate, ToC);
2810       } else {
2811         for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
2812           if (getOperand(i) == From)
2813             setOperand(i, ToC);
2814       }
2815       return;
2816     }
2817   }
2818
2819   // Otherwise, I do need to replace this with an existing value.
2820   assert(Replacement != this && "I didn't contain From!");
2821
2822   // Everyone using this now uses the replacement.
2823   uncheckedReplaceAllUsesWith(Replacement);
2824
2825   // Delete the old constant!
2826   destroyConstant();
2827 }
2828
2829 void ConstantStruct::replaceUsesOfWithOnConstant(Value *From, Value *To,
2830                                                  Use *U) {
2831   assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
2832   Constant *ToC = cast<Constant>(To);
2833
2834   unsigned OperandToUpdate = U-OperandList;
2835   assert(getOperand(OperandToUpdate) == From && "ReplaceAllUsesWith broken!");
2836
2837   std::pair<StructConstantsTy::MapKey, Constant*> Lookup;
2838   Lookup.first.first = getType();
2839   Lookup.second = this;
2840   std::vector<Constant*> &Values = Lookup.first.second;
2841   Values.reserve(getNumOperands());  // Build replacement struct.
2842
2843
2844   // Fill values with the modified operands of the constant struct.  Also,
2845   // compute whether this turns into an all-zeros struct.
2846   bool isAllZeros = false;
2847   if (!ToC->isNullValue()) {
2848     for (Use *O = OperandList, *E = OperandList+getNumOperands(); O != E; ++O)
2849       Values.push_back(cast<Constant>(O->get()));
2850   } else {
2851     isAllZeros = true;
2852     for (Use *O = OperandList, *E = OperandList+getNumOperands(); O != E; ++O) {
2853       Constant *Val = cast<Constant>(O->get());
2854       Values.push_back(Val);
2855       if (isAllZeros) isAllZeros = Val->isNullValue();
2856     }
2857   }
2858   Values[OperandToUpdate] = ToC;
2859
2860   Constant *Replacement = 0;
2861   if (isAllZeros) {
2862     Replacement = ConstantAggregateZero::get(getType());
2863   } else {
2864     // Check to see if we have this array type already.
2865     sys::SmartScopedWriter<true> Writer(&*ConstantsLock);
2866     bool Exists;
2867     StructConstantsTy::MapTy::iterator I =
2868       StructConstants->InsertOrGetItem(Lookup, Exists);
2869
2870     if (Exists) {
2871       Replacement = I->second;
2872     } else {
2873       // Okay, the new shape doesn't exist in the system yet.  Instead of
2874       // creating a new constant struct, inserting it, replaceallusesof'ing the
2875       // old with the new, then deleting the old... just update the current one
2876       // in place!
2877       StructConstants->MoveConstantToNewSlot(this, I);
2878
2879       // Update to the new value.
2880       setOperand(OperandToUpdate, ToC);
2881       return;
2882     }
2883   }
2884
2885   assert(Replacement != this && "I didn't contain From!");
2886
2887   // Everyone using this now uses the replacement.
2888   uncheckedReplaceAllUsesWith(Replacement);
2889
2890   // Delete the old constant!
2891   destroyConstant();
2892 }
2893
2894 void ConstantVector::replaceUsesOfWithOnConstant(Value *From, Value *To,
2895                                                  Use *U) {
2896   assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
2897
2898   std::vector<Constant*> Values;
2899   Values.reserve(getNumOperands());  // Build replacement array...
2900   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
2901     Constant *Val = getOperand(i);
2902     if (Val == From) Val = cast<Constant>(To);
2903     Values.push_back(Val);
2904   }
2905
2906   Constant *Replacement = ConstantVector::get(getType(), Values);
2907   assert(Replacement != this && "I didn't contain From!");
2908
2909   // Everyone using this now uses the replacement.
2910   uncheckedReplaceAllUsesWith(Replacement);
2911
2912   // Delete the old constant!
2913   destroyConstant();
2914 }
2915
2916 void ConstantExpr::replaceUsesOfWithOnConstant(Value *From, Value *ToV,
2917                                                Use *U) {
2918   assert(isa<Constant>(ToV) && "Cannot make Constant refer to non-constant!");
2919   Constant *To = cast<Constant>(ToV);
2920
2921   Constant *Replacement = 0;
2922   if (getOpcode() == Instruction::GetElementPtr) {
2923     SmallVector<Constant*, 8> Indices;
2924     Constant *Pointer = getOperand(0);
2925     Indices.reserve(getNumOperands()-1);
2926     if (Pointer == From) Pointer = To;
2927
2928     for (unsigned i = 1, e = getNumOperands(); i != e; ++i) {
2929       Constant *Val = getOperand(i);
2930       if (Val == From) Val = To;
2931       Indices.push_back(Val);
2932     }
2933     Replacement = ConstantExpr::getGetElementPtr(Pointer,
2934                                                  &Indices[0], Indices.size());
2935   } else if (getOpcode() == Instruction::ExtractValue) {
2936     Constant *Agg = getOperand(0);
2937     if (Agg == From) Agg = To;
2938
2939     const SmallVector<unsigned, 4> &Indices = getIndices();
2940     Replacement = ConstantExpr::getExtractValue(Agg,
2941                                                 &Indices[0], Indices.size());
2942   } else if (getOpcode() == Instruction::InsertValue) {
2943     Constant *Agg = getOperand(0);
2944     Constant *Val = getOperand(1);
2945     if (Agg == From) Agg = To;
2946     if (Val == From) Val = To;
2947
2948     const SmallVector<unsigned, 4> &Indices = getIndices();
2949     Replacement = ConstantExpr::getInsertValue(Agg, Val,
2950                                                &Indices[0], Indices.size());
2951   } else if (isCast()) {
2952     assert(getOperand(0) == From && "Cast only has one use!");
2953     Replacement = ConstantExpr::getCast(getOpcode(), To, getType());
2954   } else if (getOpcode() == Instruction::Select) {
2955     Constant *C1 = getOperand(0);
2956     Constant *C2 = getOperand(1);
2957     Constant *C3 = getOperand(2);
2958     if (C1 == From) C1 = To;
2959     if (C2 == From) C2 = To;
2960     if (C3 == From) C3 = To;
2961     Replacement = ConstantExpr::getSelect(C1, C2, C3);
2962   } else if (getOpcode() == Instruction::ExtractElement) {
2963     Constant *C1 = getOperand(0);
2964     Constant *C2 = getOperand(1);
2965     if (C1 == From) C1 = To;
2966     if (C2 == From) C2 = To;
2967     Replacement = ConstantExpr::getExtractElement(C1, C2);
2968   } else if (getOpcode() == Instruction::InsertElement) {
2969     Constant *C1 = getOperand(0);
2970     Constant *C2 = getOperand(1);
2971     Constant *C3 = getOperand(1);
2972     if (C1 == From) C1 = To;
2973     if (C2 == From) C2 = To;
2974     if (C3 == From) C3 = To;
2975     Replacement = ConstantExpr::getInsertElement(C1, C2, C3);
2976   } else if (getOpcode() == Instruction::ShuffleVector) {
2977     Constant *C1 = getOperand(0);
2978     Constant *C2 = getOperand(1);
2979     Constant *C3 = getOperand(2);
2980     if (C1 == From) C1 = To;
2981     if (C2 == From) C2 = To;
2982     if (C3 == From) C3 = To;
2983     Replacement = ConstantExpr::getShuffleVector(C1, C2, C3);
2984   } else if (isCompare()) {
2985     Constant *C1 = getOperand(0);
2986     Constant *C2 = getOperand(1);
2987     if (C1 == From) C1 = To;
2988     if (C2 == From) C2 = To;
2989     if (getOpcode() == Instruction::ICmp)
2990       Replacement = ConstantExpr::getICmp(getPredicate(), C1, C2);
2991     else if (getOpcode() == Instruction::FCmp)
2992       Replacement = ConstantExpr::getFCmp(getPredicate(), C1, C2);
2993     else if (getOpcode() == Instruction::VICmp)
2994       Replacement = ConstantExpr::getVICmp(getPredicate(), C1, C2);
2995     else {
2996       assert(getOpcode() == Instruction::VFCmp);
2997       Replacement = ConstantExpr::getVFCmp(getPredicate(), C1, C2);
2998     }
2999   } else if (getNumOperands() == 2) {
3000     Constant *C1 = getOperand(0);
3001     Constant *C2 = getOperand(1);
3002     if (C1 == From) C1 = To;
3003     if (C2 == From) C2 = To;
3004     Replacement = ConstantExpr::get(getOpcode(), C1, C2);
3005   } else {
3006     assert(0 && "Unknown ConstantExpr type!");
3007     return;
3008   }
3009
3010   assert(Replacement != this && "I didn't contain From!");
3011
3012   // Everyone using this now uses the replacement.
3013   uncheckedReplaceAllUsesWith(Replacement);
3014
3015   // Delete the old constant!
3016   destroyConstant();
3017 }
3018
3019 void MDNode::replaceElement(Value *From, Value *To) {
3020   SmallVector<Value*, 4> Values;
3021   Values.reserve(getNumElements());  // Build replacement array...
3022   for (unsigned i = 0, e = getNumElements(); i != e; ++i) {
3023     Value *Val = getElement(i);
3024     if (Val == From) Val = To;
3025     Values.push_back(Val);
3026   }
3027
3028   MDNode *Replacement = MDNode::get(&Values[0], Values.size());
3029   assert(Replacement != this && "I didn't contain From!");
3030
3031   uncheckedReplaceAllUsesWith(Replacement);
3032
3033   destroyConstant();
3034 }