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 "LLVMContextImpl.h"
  15 #include "llvm/Constants.h"
  16 #include "ConstantFold.h"
  17 #include "llvm/DerivedTypes.h"
  18 #include "llvm/GlobalValue.h"
  19 #include "llvm/Instructions.h"
  20 #include "llvm/Module.h"
  21 #include "llvm/Operator.h"
  22 #include "llvm/ADT/FoldingSet.h"
  23 #include "llvm/ADT/StringExtras.h"
  24 #include "llvm/ADT/StringMap.h"
  25 #include "llvm/Support/Compiler.h"
  26 #include "llvm/Support/Debug.h"
  27 #include "llvm/Support/ErrorHandling.h"
  28 #include "llvm/Support/ManagedStatic.h"
  29 #include "llvm/Support/MathExtras.h"
  30 #include "llvm/System/Mutex.h"
  31 #include "llvm/System/RWMutex.h"
  32 #include "llvm/System/Threading.h"
  33 #include "llvm/ADT/DenseMap.h"
  34 #include "llvm/ADT/SmallVector.h"
  35 #include <algorithm>
  36 #include <map>
  37 using namespace llvm;
  38
  39 //===----------------------------------------------------------------------===//
  40 //                              Constant Class
  41 //===----------------------------------------------------------------------===//
  42
  43 // Constructor to create a '0' constant of arbitrary type...
  44 static const uint64_t zero[2] = {0, 0};
  45 Constant* Constant::getNullValue(const Type* Ty) {
  46   switch (Ty->getTypeID()) {
  47   case Type::IntegerTyID:
  48     return ConstantInt::get(Ty, 0);
  49   case Type::FloatTyID:
  50     return ConstantFP::get(Ty->getContext(), APFloat(APInt(32, 0)));
  51   case Type::DoubleTyID:
  52     return ConstantFP::get(Ty->getContext(), APFloat(APInt(64, 0)));
  53   case Type::X86_FP80TyID:
  54     return ConstantFP::get(Ty->getContext(), APFloat(APInt(80, 2, zero)));
  55   case Type::FP128TyID:
  56     return ConstantFP::get(Ty->getContext(),
  57                            APFloat(APInt(128, 2, zero), true));
  58   case Type::PPC_FP128TyID:
  59     return ConstantFP::get(Ty->getContext(), APFloat(APInt(128, 2, zero)));
  60   case Type::PointerTyID:
  61     return ConstantPointerNull::get(cast<PointerType>(Ty));
  62   case Type::StructTyID:
  63   case Type::ArrayTyID:
  64   case Type::VectorTyID:
  65     return ConstantAggregateZero::get(Ty);
  66   default:
  67     // Function, Label, or Opaque type?
  68     assert(!"Cannot create a null constant of that type!");
  69     return 0;
  70   }
  71 }
  72
  73 Constant* Constant::getIntegerValue(const Type* Ty, const APInt &V) {
  74   const Type *ScalarTy = Ty->getScalarType();
  75
  76   // Create the base integer constant.
  77   Constant *C = ConstantInt::get(Ty->getContext(), V);
  78
  79   // Convert an integer to a pointer, if necessary.
  80   if (const PointerType *PTy = dyn_cast<PointerType>(ScalarTy))
  81     C = ConstantExpr::getIntToPtr(C, PTy);
  82
  83   // Broadcast a scalar to a vector, if necessary.
  84   if (const VectorType *VTy = dyn_cast<VectorType>(Ty))
  85     C = ConstantVector::get(std::vector<Constant *>(VTy->getNumElements(), C));
  86
  87   return C;
  88 }
  89
  90 Constant* Constant::getAllOnesValue(const Type* Ty) {
  91   if (const IntegerType* ITy = dyn_cast<IntegerType>(Ty))
  92     return ConstantInt::get(Ty->getContext(),
  93                             APInt::getAllOnesValue(ITy->getBitWidth()));
  94
  95   std::vector<Constant*> Elts;
  96   const VectorType* VTy = cast<VectorType>(Ty);
  97   Elts.resize(VTy->getNumElements(), getAllOnesValue(VTy->getElementType()));
  98   assert(Elts[0] && "Not a vector integer type!");
  99   return cast<ConstantVector>(ConstantVector::get(Elts));
 100 }
 101
 102 void Constant::destroyConstantImpl() {
 103   // When a Constant is destroyed, there may be lingering
 104   // references to the constant by other constants in the constant pool.  These
 105   // constants are implicitly dependent on the module that is being deleted,
 106   // but they don't know that.  Because we only find out when the CPV is
 107   // deleted, we must now notify all of our users (that should only be
 108   // Constants) that they are, in fact, invalid now and should be deleted.
 109   //
 110   while (!use_empty()) {
 111     Value *V = use_back();
 112 #ifndef NDEBUG      // Only in -g mode...
 113     if (!isa<Constant>(V))
 114       DOUT << "While deleting: " << *this
 115            << "\n\nUse still stuck around after Def is destroyed: "
 116            << *V << "\n\n";
 117 #endif
 118     assert(isa<Constant>(V) && "References remain to Constant being destroyed");
 119     Constant *CV = cast<Constant>(V);
 120     CV->destroyConstant();
 121
 122     // The constant should remove itself from our use list...
 123     assert((use_empty() || use_back() != V) && "Constant not removed!");
 124   }
 125
 126   // Value has no outstanding references it is safe to delete it now...
 127   delete this;
 128 }
 129
 130 /// canTrap - Return true if evaluation of this constant could trap.  This is
 131 /// true for things like constant expressions that could divide by zero.
 132 bool Constant::canTrap() const {
 133   assert(getType()->isFirstClassType() && "Cannot evaluate aggregate vals!");
 134   // The only thing that could possibly trap are constant exprs.
 135   const ConstantExpr *CE = dyn_cast<ConstantExpr>(this);
 136   if (!CE) return false;
 137
 138   // ConstantExpr traps if any operands can trap.
 139   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
 140     if (getOperand(i)->canTrap())
 141       return true;
 142
 143   // Otherwise, only specific operations can trap.
 144   switch (CE->getOpcode()) {
 145   default:
 146     return false;
 147   case Instruction::UDiv:
 148   case Instruction::SDiv:
 149   case Instruction::FDiv:
 150   case Instruction::URem:
 151   case Instruction::SRem:
 152   case Instruction::FRem:
 153     // Div and rem can trap if the RHS is not known to be non-zero.
 154     if (!isa<ConstantInt>(getOperand(1)) || getOperand(1)->isNullValue())
 155       return true;
 156     return false;
 157   }
 158 }
 159
 160
 161 /// getRelocationInfo - This method classifies the entry according to
 162 /// whether or not it may generate a relocation entry.  This must be
 163 /// conservative, so if it might codegen to a relocatable entry, it should say
 164 /// so.  The return values are:
 165 ///
 166 ///  NoRelocation: This constant pool entry is guaranteed to never have a
 167 ///     relocation applied to it (because it holds a simple constant like
 168 ///     '4').
 169 ///  LocalRelocation: This entry has relocations, but the entries are
 170 ///     guaranteed to be resolvable by the static linker, so the dynamic
 171 ///     linker will never see them.
 172 ///  GlobalRelocations: This entry may have arbitrary relocations.
 173 ///
 174 /// FIXME: This really should not be in VMCore.
 175 Constant::PossibleRelocationsTy Constant::getRelocationInfo() const {
 176   if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
 177     if (GV->hasLocalLinkage() || GV->hasHiddenVisibility())
 178       return LocalRelocation;  // Local to this file/library.
 179     return GlobalRelocations;    // Global reference.
 180   }
 181
 182   PossibleRelocationsTy Result = NoRelocation;
 183   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
 184     Result = std::max(Result, getOperand(i)->getRelocationInfo());
 185
 186   return Result;
 187 }
 188
 189
 190 /// getVectorElements - This method, which is only valid on constant of vector
 191 /// type, returns the elements of the vector in the specified smallvector.
 192 /// This handles breaking down a vector undef into undef elements, etc.  For
 193 /// constant exprs and other cases we can't handle, we return an empty vector.
 194 void Constant::getVectorElements(LLVMContext &Context,
 195                                  SmallVectorImpl<Constant*> &Elts) const {
 196   assert(isa<VectorType>(getType()) && "Not a vector constant!");
 197
 198   if (const ConstantVector *CV = dyn_cast<ConstantVector>(this)) {
 199     for (unsigned i = 0, e = CV->getNumOperands(); i != e; ++i)
 200       Elts.push_back(CV->getOperand(i));
 201     return;
 202   }
 203
 204   const VectorType *VT = cast<VectorType>(getType());
 205   if (isa<ConstantAggregateZero>(this)) {
 206     Elts.assign(VT->getNumElements(),
 207                 Constant::getNullValue(VT->getElementType()));
 208     return;
 209   }
 210
 211   if (isa<UndefValue>(this)) {
 212     Elts.assign(VT->getNumElements(), UndefValue::get(VT->getElementType()));
 213     return;
 214   }
 215
 216   // Unknown type, must be constant expr etc.
 217 }
 218
 219
 220
 221 //===----------------------------------------------------------------------===//
 222 //                                ConstantInt
 223 //===----------------------------------------------------------------------===//
 224
 225 ConstantInt::ConstantInt(const IntegerType *Ty, const APInt& V)
 226   : Constant(Ty, ConstantIntVal, 0, 0), Val(V) {
 227   assert(V.getBitWidth() == Ty->getBitWidth() && "Invalid constant for type");
 228 }
 229
 230 ConstantInt* ConstantInt::getTrue(LLVMContext &Context) {
 231   LLVMContextImpl *pImpl = Context.pImpl;
 232   sys::SmartScopedWriter<true>(pImpl->ConstantsLock);
 233   if (pImpl->TheTrueVal)
 234     return pImpl->TheTrueVal;
 235   else
 236     return (pImpl->TheTrueVal = ConstantInt::get(IntegerType::get(1), 1));
 237 }
 238
 239 ConstantInt* ConstantInt::getFalse(LLVMContext &Context) {
 240   LLVMContextImpl *pImpl = Context.pImpl;
 241   sys::SmartScopedWriter<true>(pImpl->ConstantsLock);
 242   if (pImpl->TheFalseVal)
 243     return pImpl->TheFalseVal;
 244   else
 245     return (pImpl->TheFalseVal = ConstantInt::get(IntegerType::get(1), 0));
 246 }
 247
 248
 249 // Get a ConstantInt from an APInt. Note that the value stored in the DenseMap
 250 // as the key, is a DenseMapAPIntKeyInfo::KeyTy which has provided the
 251 // operator== and operator!= to ensure that the DenseMap doesn't attempt to
 252 // compare APInt's of different widths, which would violate an APInt class
 253 // invariant which generates an assertion.
 254 ConstantInt *ConstantInt::get(LLVMContext &Context, const APInt& V) {
 255   // Get the corresponding integer type for the bit width of the value.
 256   const IntegerType *ITy = IntegerType::get(V.getBitWidth());
 257   // get an existing value or the insertion position
 258   DenseMapAPIntKeyInfo::KeyTy Key(V, ITy);
 259
 260   Context.pImpl->ConstantsLock.reader_acquire();
 261   ConstantInt *&Slot = Context.pImpl->IntConstants[Key];
 262   Context.pImpl->ConstantsLock.reader_release();
 263
 264   if (!Slot) {
 265     sys::SmartScopedWriter<true> Writer(Context.pImpl->ConstantsLock);
 266     ConstantInt *&NewSlot = Context.pImpl->IntConstants[Key];
 267     if (!Slot) {
 268       NewSlot = new ConstantInt(ITy, V);
 269     }
 270
 271     return NewSlot;
 272   } else {
 273     return Slot;
 274   }
 275 }
 276
 277 Constant* ConstantInt::get(const Type* Ty, uint64_t V, bool isSigned) {
 278   Constant *C = get(cast<IntegerType>(Ty->getScalarType()),
 279                                V, isSigned);
 280
 281   // For vectors, broadcast the value.
 282   if (const VectorType *VTy = dyn_cast<VectorType>(Ty))
 283     return ConstantVector::get(
 284       std::vector<Constant *>(VTy->getNumElements(), C));
 285
 286   return C;
 287 }
 288
 289 ConstantInt* ConstantInt::get(const IntegerType* Ty, uint64_t V,
 290                               bool isSigned) {
 291   return get(Ty->getContext(), APInt(Ty->getBitWidth(), V, isSigned));
 292 }
 293
 294 ConstantInt* ConstantInt::getSigned(const IntegerType* Ty, int64_t V) {
 295   return get(Ty, V, true);
 296 }
 297
 298 Constant *ConstantInt::getSigned(const Type *Ty, int64_t V) {
 299   return get(Ty, V, true);
 300 }
 301
 302 Constant* ConstantInt::get(const Type* Ty, const APInt& V) {
 303   ConstantInt *C = get(Ty->getContext(), V);
 304   assert(C->getType() == Ty->getScalarType() &&
 305          "ConstantInt type doesn't match the type implied by its value!");
 306
 307   // For vectors, broadcast the value.
 308   if (const VectorType *VTy = dyn_cast<VectorType>(Ty))
 309     return ConstantVector::get(
 310       std::vector<Constant *>(VTy->getNumElements(), C));
 311
 312   return C;
 313 }
 314
 315 //===----------------------------------------------------------------------===//
 316 //                                ConstantFP
 317 //===----------------------------------------------------------------------===//
 318
 319 static const fltSemantics *TypeToFloatSemantics(const Type *Ty) {
 320   if (Ty == Type::FloatTy)
 321     return &APFloat::IEEEsingle;
 322   if (Ty == Type::DoubleTy)
 323     return &APFloat::IEEEdouble;
 324   if (Ty == Type::X86_FP80Ty)
 325     return &APFloat::x87DoubleExtended;
 326   else if (Ty == Type::FP128Ty)
 327     return &APFloat::IEEEquad;
 328
 329   assert(Ty == Type::PPC_FP128Ty && "Unknown FP format");
 330   return &APFloat::PPCDoubleDouble;
 331 }
 332
 333 /// get() - This returns a constant fp for the specified value in the
 334 /// specified type.  This should only be used for simple constant values like
 335 /// 2.0/1.0 etc, that are known-valid both as double and as the target format.
 336 Constant* ConstantFP::get(const Type* Ty, double V) {
 337   LLVMContext &Context = Ty->getContext();
 338
 339   APFloat FV(V);
 340   bool ignored;
 341   FV.convert(*TypeToFloatSemantics(Ty->getScalarType()),
 342              APFloat::rmNearestTiesToEven, &ignored);
 343   Constant *C = get(Context, FV);
 344
 345   // For vectors, broadcast the value.
 346   if (const VectorType *VTy = dyn_cast<VectorType>(Ty))
 347     return ConstantVector::get(
 348       std::vector<Constant *>(VTy->getNumElements(), C));
 349
 350   return C;
 351 }
 352
 353 ConstantFP* ConstantFP::getNegativeZero(const Type* Ty) {
 354   LLVMContext &Context = Ty->getContext();
 355   APFloat apf = cast <ConstantFP>(Constant::getNullValue(Ty))->getValueAPF();
 356   apf.changeSign();
 357   return get(Context, apf);
 358 }
 359
 360
 361 Constant* ConstantFP::getZeroValueForNegation(const Type* Ty) {
 362   if (const VectorType *PTy = dyn_cast<VectorType>(Ty))
 363     if (PTy->getElementType()->isFloatingPoint()) {
 364       std::vector<Constant*> zeros(PTy->getNumElements(),
 365                            getNegativeZero(PTy->getElementType()));
 366       return ConstantVector::get(PTy, zeros);
 367     }
 368
 369   if (Ty->isFloatingPoint())
 370     return getNegativeZero(Ty);
 371
 372   return Constant::getNullValue(Ty);
 373 }
 374
 375
 376 // ConstantFP accessors.
 377 ConstantFP* ConstantFP::get(LLVMContext &Context, const APFloat& V) {
 378   DenseMapAPFloatKeyInfo::KeyTy Key(V);
 379
 380   LLVMContextImpl* pImpl = Context.pImpl;
 381
 382   pImpl->ConstantsLock.reader_acquire();
 383   ConstantFP *&Slot = pImpl->FPConstants[Key];
 384   pImpl->ConstantsLock.reader_release();
 385
 386   if (!Slot) {
 387     sys::SmartScopedWriter<true> Writer(pImpl->ConstantsLock);
 388     ConstantFP *&NewSlot = pImpl->FPConstants[Key];
 389     if (!NewSlot) {
 390       const Type *Ty;
 391       if (&V.getSemantics() == &APFloat::IEEEsingle)
 392         Ty = Type::FloatTy;
 393       else if (&V.getSemantics() == &APFloat::IEEEdouble)
 394         Ty = Type::DoubleTy;
 395       else if (&V.getSemantics() == &APFloat::x87DoubleExtended)
 396         Ty = Type::X86_FP80Ty;
 397       else if (&V.getSemantics() == &APFloat::IEEEquad)
 398         Ty = Type::FP128Ty;
 399       else {
 400         assert(&V.getSemantics() == &APFloat::PPCDoubleDouble &&
 401                "Unknown FP format");
 402         Ty = Type::PPC_FP128Ty;
 403       }
 404       NewSlot = new ConstantFP(Ty, V);
 405     }
 406
 407     return NewSlot;
 408   }
 409
 410   return Slot;
 411 }
 412
 413 ConstantFP::ConstantFP(const Type *Ty, const APFloat& V)
 414   : Constant(Ty, ConstantFPVal, 0, 0), Val(V) {
 415   assert(&V.getSemantics() == TypeToFloatSemantics(Ty) &&
 416          "FP type Mismatch");
 417 }
 418
 419 bool ConstantFP::isNullValue() const {
 420   return Val.isZero() && !Val.isNegative();
 421 }
 422
 423 bool ConstantFP::isExactlyValue(const APFloat& V) const {
 424   return Val.bitwiseIsEqual(V);
 425 }
 426
 427 //===----------------------------------------------------------------------===//
 428 //                            ConstantXXX Classes
 429 //===----------------------------------------------------------------------===//
 430
 431
 432 ConstantArray::ConstantArray(const ArrayType *T,
 433                              const std::vector<Constant*> &V)
 434   : Constant(T, ConstantArrayVal,
 435              OperandTraits<ConstantArray>::op_end(this) - V.size(),
 436              V.size()) {
 437   assert(V.size() == T->getNumElements() &&
 438          "Invalid initializer vector for constant array");
 439   Use *OL = OperandList;
 440   for (std::vector<Constant*>::const_iterator I = V.begin(), E = V.end();
 441        I != E; ++I, ++OL) {
 442     Constant *C = *I;
 443     assert((C->getType() == T->getElementType() ||
 444             (T->isAbstract() &&
 445              C->getType()->getTypeID() == T->getElementType()->getTypeID())) &&
 446            "Initializer for array element doesn't match array element type!");
 447     *OL = C;
 448   }
 449 }
 450
 451 Constant *ConstantArray::get(const ArrayType *Ty,
 452                              const std::vector<Constant*> &V) {
 453   LLVMContextImpl *pImpl = Ty->getContext().pImpl;
 454   // If this is an all-zero array, return a ConstantAggregateZero object
 455   if (!V.empty()) {
 456     Constant *C = V[0];
 457     if (!C->isNullValue()) {
 458       // Implicitly locked.
 459       return pImpl->ArrayConstants.getOrCreate(Ty, V);
 460     }
 461     for (unsigned i = 1, e = V.size(); i != e; ++i)
 462       if (V[i] != C) {
 463         // Implicitly locked.
 464         return pImpl->ArrayConstants.getOrCreate(Ty, V);
 465       }
 466   }
 467
 468   return ConstantAggregateZero::get(Ty);
 469 }
 470
 471
 472 Constant* ConstantArray::get(const ArrayType* T, Constant* const* Vals,
 473                              unsigned NumVals) {
 474   // FIXME: make this the primary ctor method.
 475   return get(T, std::vector<Constant*>(Vals, Vals+NumVals));
 476 }
 477
 478 /// ConstantArray::get(const string&) - Return an array that is initialized to
 479 /// contain the specified string.  If length is zero then a null terminator is
 480 /// added to the specified string so that it may be used in a natural way.
 481 /// Otherwise, the length parameter specifies how much of the string to use
 482 /// and it won't be null terminated.
 483 ///
 484 Constant* ConstantArray::get(const StringRef &Str, bool AddNull) {
 485   std::vector<Constant*> ElementVals;
 486   for (unsigned i = 0; i < Str.size(); ++i)
 487     ElementVals.push_back(ConstantInt::get(Type::Int8Ty, Str[i]));
 488
 489   // Add a null terminator to the string...
 490   if (AddNull) {
 491     ElementVals.push_back(ConstantInt::get(Type::Int8Ty, 0));
 492   }
 493
 494   ArrayType *ATy = ArrayType::get(Type::Int8Ty, ElementVals.size());
 495   return get(ATy, ElementVals);
 496 }
 497
 498
 499
 500 ConstantStruct::ConstantStruct(const StructType *T,
 501                                const std::vector<Constant*> &V)
 502   : Constant(T, ConstantStructVal,
 503              OperandTraits<ConstantStruct>::op_end(this) - V.size(),
 504              V.size()) {
 505   assert(V.size() == T->getNumElements() &&
 506          "Invalid initializer vector for constant structure");
 507   Use *OL = OperandList;
 508   for (std::vector<Constant*>::const_iterator I = V.begin(), E = V.end();
 509        I != E; ++I, ++OL) {
 510     Constant *C = *I;
 511     assert((C->getType() == T->getElementType(I-V.begin()) ||
 512             ((T->getElementType(I-V.begin())->isAbstract() ||
 513               C->getType()->isAbstract()) &&
 514              T->getElementType(I-V.begin())->getTypeID() ==
 515                    C->getType()->getTypeID())) &&
 516            "Initializer for struct element doesn't match struct element type!");
 517     *OL = C;
 518   }
 519 }
 520
 521 // ConstantStruct accessors.
 522 Constant* ConstantStruct::get(const StructType* T,
 523                               const std::vector<Constant*>& V) {
 524   LLVMContextImpl* pImpl = T->getContext().pImpl;
 525
 526   // Create a ConstantAggregateZero value if all elements are zeros...
 527   for (unsigned i = 0, e = V.size(); i != e; ++i)
 528     if (!V[i]->isNullValue())
 529       // Implicitly locked.
 530       return pImpl->StructConstants.getOrCreate(T, V);
 531
 532   return ConstantAggregateZero::get(T);
 533 }
 534
 535 Constant* ConstantStruct::get(const std::vector<Constant*>& V, bool packed) {
 536   std::vector<const Type*> StructEls;
 537   StructEls.reserve(V.size());
 538   for (unsigned i = 0, e = V.size(); i != e; ++i)
 539     StructEls.push_back(V[i]->getType());
 540   return get(StructType::get(StructEls, packed), V);
 541 }
 542
 543 Constant* ConstantStruct::get(Constant* const *Vals, unsigned NumVals,
 544                               bool Packed) {
 545   // FIXME: make this the primary ctor method.
 546   return get(std::vector<Constant*>(Vals, Vals+NumVals), Packed);
 547 }
 548
 549 ConstantVector::ConstantVector(const VectorType *T,
 550                                const std::vector<Constant*> &V)
 551   : Constant(T, ConstantVectorVal,
 552              OperandTraits<ConstantVector>::op_end(this) - V.size(),
 553              V.size()) {
 554   Use *OL = OperandList;
 555     for (std::vector<Constant*>::const_iterator I = V.begin(), E = V.end();
 556          I != E; ++I, ++OL) {
 557       Constant *C = *I;
 558       assert((C->getType() == T->getElementType() ||
 559             (T->isAbstract() &&
 560              C->getType()->getTypeID() == T->getElementType()->getTypeID())) &&
 561            "Initializer for vector element doesn't match vector element type!");
 562     *OL = C;
 563   }
 564 }
 565
 566 // ConstantVector accessors.
 567 Constant* ConstantVector::get(const VectorType* T,
 568                               const std::vector<Constant*>& V) {
 569    assert(!V.empty() && "Vectors can't be empty");
 570    LLVMContext &Context = T->getContext();
 571    LLVMContextImpl *pImpl = Context.pImpl;
 572
 573   // If this is an all-undef or alll-zero vector, return a
 574   // ConstantAggregateZero or UndefValue.
 575   Constant *C = V[0];
 576   bool isZero = C->isNullValue();
 577   bool isUndef = isa<UndefValue>(C);
 578
 579   if (isZero || isUndef) {
 580     for (unsigned i = 1, e = V.size(); i != e; ++i)
 581       if (V[i] != C) {
 582         isZero = isUndef = false;
 583         break;
 584       }
 585   }
 586
 587   if (isZero)
 588     return ConstantAggregateZero::get(T);
 589   if (isUndef)
 590     return UndefValue::get(T);
 591
 592   // Implicitly locked.
 593   return pImpl->VectorConstants.getOrCreate(T, V);
 594 }
 595
 596 Constant* ConstantVector::get(const std::vector<Constant*>& V) {
 597   assert(!V.empty() && "Cannot infer type if V is empty");
 598   return get(VectorType::get(V.front()->getType(),V.size()), V);
 599 }
 600
 601 Constant* ConstantVector::get(Constant* const* Vals, unsigned NumVals) {
 602   // FIXME: make this the primary ctor method.
 603   return get(std::vector<Constant*>(Vals, Vals+NumVals));
 604 }
 605
 606
 607 namespace llvm {
 608 // We declare several classes private to this file, so use an anonymous
 609 // namespace
 610 namespace {
 611
 612 /// UnaryConstantExpr - This class is private to Constants.cpp, and is used
 613 /// behind the scenes to implement unary constant exprs.
 614 class VISIBILITY_HIDDEN UnaryConstantExpr : public ConstantExpr {
 615   void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
 616 public:
 617   // allocate space for exactly one operand
 618   void *operator new(size_t s) {
 619     return User::operator new(s, 1);
 620   }
 621   UnaryConstantExpr(unsigned Opcode, Constant *C, const Type *Ty)
 622     : ConstantExpr(Ty, Opcode, &Op<0>(), 1) {
 623     Op<0>() = C;
 624   }
 625   /// Transparently provide more efficient getOperand methods.
 626   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
 627 };
 628
 629 /// BinaryConstantExpr - This class is private to Constants.cpp, and is used
 630 /// behind the scenes to implement binary constant exprs.
 631 class VISIBILITY_HIDDEN BinaryConstantExpr : public ConstantExpr {
 632   void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
 633 public:
 634   // allocate space for exactly two operands
 635   void *operator new(size_t s) {
 636     return User::operator new(s, 2);
 637   }
 638   BinaryConstantExpr(unsigned Opcode, Constant *C1, Constant *C2)
 639     : ConstantExpr(C1->getType(), Opcode, &Op<0>(), 2) {
 640     Op<0>() = C1;
 641     Op<1>() = C2;
 642   }
 643   /// Transparently provide more efficient getOperand methods.
 644   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
 645 };
 646
 647 /// SelectConstantExpr - This class is private to Constants.cpp, and is used
 648 /// behind the scenes to implement select constant exprs.
 649 class VISIBILITY_HIDDEN SelectConstantExpr : public ConstantExpr {
 650   void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
 651 public:
 652   // allocate space for exactly three operands
 653   void *operator new(size_t s) {
 654     return User::operator new(s, 3);
 655   }
 656   SelectConstantExpr(Constant *C1, Constant *C2, Constant *C3)
 657     : ConstantExpr(C2->getType(), Instruction::Select, &Op<0>(), 3) {
 658     Op<0>() = C1;
 659     Op<1>() = C2;
 660     Op<2>() = C3;
 661   }
 662   /// Transparently provide more efficient getOperand methods.
 663   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
 664 };
 665
 666 /// ExtractElementConstantExpr - This class is private to
 667 /// Constants.cpp, and is used behind the scenes to implement
 668 /// extractelement constant exprs.
 669 class VISIBILITY_HIDDEN ExtractElementConstantExpr : public ConstantExpr {
 670   void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
 671 public:
 672   // allocate space for exactly two operands
 673   void *operator new(size_t s) {
 674     return User::operator new(s, 2);
 675   }
 676   ExtractElementConstantExpr(Constant *C1, Constant *C2)
 677     : ConstantExpr(cast<VectorType>(C1->getType())->getElementType(),
 678                    Instruction::ExtractElement, &Op<0>(), 2) {
 679     Op<0>() = C1;
 680     Op<1>() = C2;
 681   }
 682   /// Transparently provide more efficient getOperand methods.
 683   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
 684 };
 685
 686 /// InsertElementConstantExpr - This class is private to
 687 /// Constants.cpp, and is used behind the scenes to implement
 688 /// insertelement constant exprs.
 689 class VISIBILITY_HIDDEN InsertElementConstantExpr : public ConstantExpr {
 690   void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
 691 public:
 692   // allocate space for exactly three operands
 693   void *operator new(size_t s) {
 694     return User::operator new(s, 3);
 695   }
 696   InsertElementConstantExpr(Constant *C1, Constant *C2, Constant *C3)
 697     : ConstantExpr(C1->getType(), Instruction::InsertElement,
 698                    &Op<0>(), 3) {
 699     Op<0>() = C1;
 700     Op<1>() = C2;
 701     Op<2>() = C3;
 702   }
 703   /// Transparently provide more efficient getOperand methods.
 704   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
 705 };
 706
 707 /// ShuffleVectorConstantExpr - This class is private to
 708 /// Constants.cpp, and is used behind the scenes to implement
 709 /// shufflevector constant exprs.
 710 class VISIBILITY_HIDDEN ShuffleVectorConstantExpr : public ConstantExpr {
 711   void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
 712 public:
 713   // allocate space for exactly three operands
 714   void *operator new(size_t s) {
 715     return User::operator new(s, 3);
 716   }
 717   ShuffleVectorConstantExpr(Constant *C1, Constant *C2, Constant *C3)
 718   : ConstantExpr(VectorType::get(
 719                    cast<VectorType>(C1->getType())->getElementType(),
 720                    cast<VectorType>(C3->getType())->getNumElements()),
 721                  Instruction::ShuffleVector,
 722                  &Op<0>(), 3) {
 723     Op<0>() = C1;
 724     Op<1>() = C2;
 725     Op<2>() = C3;
 726   }
 727   /// Transparently provide more efficient getOperand methods.
 728   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
 729 };
 730
 731 /// ExtractValueConstantExpr - This class is private to
 732 /// Constants.cpp, and is used behind the scenes to implement
 733 /// extractvalue constant exprs.
 734 class VISIBILITY_HIDDEN ExtractValueConstantExpr : public ConstantExpr {
 735   void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
 736 public:
 737   // allocate space for exactly one operand
 738   void *operator new(size_t s) {
 739     return User::operator new(s, 1);
 740   }
 741   ExtractValueConstantExpr(Constant *Agg,
 742                            const SmallVector<unsigned, 4> &IdxList,
 743                            const Type *DestTy)
 744     : ConstantExpr(DestTy, Instruction::ExtractValue, &Op<0>(), 1),
 745       Indices(IdxList) {
 746     Op<0>() = Agg;
 747   }
 748
 749   /// Indices - These identify which value to extract.
 750   const SmallVector<unsigned, 4> Indices;
 751
 752   /// Transparently provide more efficient getOperand methods.
 753   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
 754 };
 755
 756 /// InsertValueConstantExpr - This class is private to
 757 /// Constants.cpp, and is used behind the scenes to implement
 758 /// insertvalue constant exprs.
 759 class VISIBILITY_HIDDEN InsertValueConstantExpr : public ConstantExpr {
 760   void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
 761 public:
 762   // allocate space for exactly one operand
 763   void *operator new(size_t s) {
 764     return User::operator new(s, 2);
 765   }
 766   InsertValueConstantExpr(Constant *Agg, Constant *Val,
 767                           const SmallVector<unsigned, 4> &IdxList,
 768                           const Type *DestTy)
 769     : ConstantExpr(DestTy, Instruction::InsertValue, &Op<0>(), 2),
 770       Indices(IdxList) {
 771     Op<0>() = Agg;
 772     Op<1>() = Val;
 773   }
 774
 775   /// Indices - These identify the position for the insertion.
 776   const SmallVector<unsigned, 4> Indices;
 777
 778   /// Transparently provide more efficient getOperand methods.
 779   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
 780 };
 781
 782
 783 /// GetElementPtrConstantExpr - This class is private to Constants.cpp, and is
 784 /// used behind the scenes to implement getelementpr constant exprs.
 785 class VISIBILITY_HIDDEN GetElementPtrConstantExpr : public ConstantExpr {
 786   GetElementPtrConstantExpr(Constant *C, const std::vector<Constant*> &IdxList,
 787                             const Type *DestTy);
 788 public:
 789   static GetElementPtrConstantExpr *Create(Constant *C,
 790                                            const std::vector<Constant*>&IdxList,
 791                                            const Type *DestTy) {
 792     return
 793       new(IdxList.size() + 1) GetElementPtrConstantExpr(C, IdxList, DestTy);
 794   }
 795   /// Transparently provide more efficient getOperand methods.
 796   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
 797 };
 798
 799 // CompareConstantExpr - This class is private to Constants.cpp, and is used
 800 // behind the scenes to implement ICmp and FCmp constant expressions. This is
 801 // needed in order to store the predicate value for these instructions.
 802 struct VISIBILITY_HIDDEN CompareConstantExpr : public ConstantExpr {
 803   void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
 804   // allocate space for exactly two operands
 805   void *operator new(size_t s) {
 806     return User::operator new(s, 2);
 807   }
 808   unsigned short predicate;
 809   CompareConstantExpr(const Type *ty, Instruction::OtherOps opc,
 810                       unsigned short pred,  Constant* LHS, Constant* RHS)
 811     : ConstantExpr(ty, opc, &Op<0>(), 2), predicate(pred) {
 812     Op<0>() = LHS;
 813     Op<1>() = RHS;
 814   }
 815   /// Transparently provide more efficient getOperand methods.
 816   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
 817 };
 818
 819 } // end anonymous namespace
 820
 821 template <>
 822 struct OperandTraits<UnaryConstantExpr> : FixedNumOperandTraits<1> {
 823 };
 824 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(UnaryConstantExpr, Value)
 825
 826 template <>
 827 struct OperandTraits<BinaryConstantExpr> : FixedNumOperandTraits<2> {
 828 };
 829 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(BinaryConstantExpr, Value)
 830
 831 template <>
 832 struct OperandTraits<SelectConstantExpr> : FixedNumOperandTraits<3> {
 833 };
 834 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SelectConstantExpr, Value)
 835
 836 template <>
 837 struct OperandTraits<ExtractElementConstantExpr> : FixedNumOperandTraits<2> {
 838 };
 839 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ExtractElementConstantExpr, Value)
 840
 841 template <>
 842 struct OperandTraits<InsertElementConstantExpr> : FixedNumOperandTraits<3> {
 843 };
 844 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertElementConstantExpr, Value)
 845
 846 template <>
 847 struct OperandTraits<ShuffleVectorConstantExpr> : FixedNumOperandTraits<3> {
 848 };
 849 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ShuffleVectorConstantExpr, Value)
 850
 851 template <>
 852 struct OperandTraits<ExtractValueConstantExpr> : FixedNumOperandTraits<1> {
 853 };
 854 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ExtractValueConstantExpr, Value)
 855
 856 template <>
 857 struct OperandTraits<InsertValueConstantExpr> : FixedNumOperandTraits<2> {
 858 };
 859 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertValueConstantExpr, Value)
 860
 861 template <>
 862 struct OperandTraits<GetElementPtrConstantExpr> : VariadicOperandTraits<1> {
 863 };
 864
 865 GetElementPtrConstantExpr::GetElementPtrConstantExpr
 866   (Constant *C,
 867    const std::vector<Constant*> &IdxList,
 868    const Type *DestTy)
 869     : ConstantExpr(DestTy, Instruction::GetElementPtr,
 870                    OperandTraits<GetElementPtrConstantExpr>::op_end(this)
 871                    - (IdxList.size()+1),
 872                    IdxList.size()+1) {
 873   OperandList[0] = C;
 874   for (unsigned i = 0, E = IdxList.size(); i != E; ++i)
 875     OperandList[i+1] = IdxList[i];
 876 }
 877
 878 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(GetElementPtrConstantExpr, Value)
 879
 880
 881 template <>
 882 struct OperandTraits<CompareConstantExpr> : FixedNumOperandTraits<2> {
 883 };
 884 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CompareConstantExpr, Value)
 885
 886
 887 } // End llvm namespace
 888
 889
 890 // Utility function for determining if a ConstantExpr is a CastOp or not. This
 891 // can't be inline because we don't want to #include Instruction.h into
 892 // Constant.h
 893 bool ConstantExpr::isCast() const {
 894   return Instruction::isCast(getOpcode());
 895 }
 896
 897 bool ConstantExpr::isCompare() const {
 898   return getOpcode() == Instruction::ICmp || getOpcode() == Instruction::FCmp;
 899 }
 900
 901 bool ConstantExpr::hasIndices() const {
 902   return getOpcode() == Instruction::ExtractValue ||
 903          getOpcode() == Instruction::InsertValue;
 904 }
 905
 906 const SmallVector<unsigned, 4> &ConstantExpr::getIndices() const {
 907   if (const ExtractValueConstantExpr *EVCE =
 908         dyn_cast<ExtractValueConstantExpr>(this))
 909     return EVCE->Indices;
 910
 911   return cast<InsertValueConstantExpr>(this)->Indices;
 912 }
 913
 914 unsigned ConstantExpr::getPredicate() const {
 915   assert(getOpcode() == Instruction::FCmp ||
 916          getOpcode() == Instruction::ICmp);
 917   return ((const CompareConstantExpr*)this)->predicate;
 918 }
 919
 920 /// getWithOperandReplaced - Return a constant expression identical to this
 921 /// one, but with the specified operand set to the specified value.
 922 Constant *
 923 ConstantExpr::getWithOperandReplaced(unsigned OpNo, Constant *Op) const {
 924   assert(OpNo < getNumOperands() && "Operand num is out of range!");
 925   assert(Op->getType() == getOperand(OpNo)->getType() &&
 926          "Replacing operand with value of different type!");
 927   if (getOperand(OpNo) == Op)
 928     return const_cast<ConstantExpr*>(this);
 929
 930   Constant *Op0, *Op1, *Op2;
 931   switch (getOpcode()) {
 932   case Instruction::Trunc:
 933   case Instruction::ZExt:
 934   case Instruction::SExt:
 935   case Instruction::FPTrunc:
 936   case Instruction::FPExt:
 937   case Instruction::UIToFP:
 938   case Instruction::SIToFP:
 939   case Instruction::FPToUI:
 940   case Instruction::FPToSI:
 941   case Instruction::PtrToInt:
 942   case Instruction::IntToPtr:
 943   case Instruction::BitCast:
 944     return ConstantExpr::getCast(getOpcode(), Op, getType());
 945   case Instruction::Select:
 946     Op0 = (OpNo == 0) ? Op : getOperand(0);
 947     Op1 = (OpNo == 1) ? Op : getOperand(1);
 948     Op2 = (OpNo == 2) ? Op : getOperand(2);
 949     return ConstantExpr::getSelect(Op0, Op1, Op2);
 950   case Instruction::InsertElement:
 951     Op0 = (OpNo == 0) ? Op : getOperand(0);
 952     Op1 = (OpNo == 1) ? Op : getOperand(1);
 953     Op2 = (OpNo == 2) ? Op : getOperand(2);
 954     return ConstantExpr::getInsertElement(Op0, Op1, Op2);
 955   case Instruction::ExtractElement:
 956     Op0 = (OpNo == 0) ? Op : getOperand(0);
 957     Op1 = (OpNo == 1) ? Op : getOperand(1);
 958     return ConstantExpr::getExtractElement(Op0, Op1);
 959   case Instruction::ShuffleVector:
 960     Op0 = (OpNo == 0) ? Op : getOperand(0);
 961     Op1 = (OpNo == 1) ? Op : getOperand(1);
 962     Op2 = (OpNo == 2) ? Op : getOperand(2);
 963     return ConstantExpr::getShuffleVector(Op0, Op1, Op2);
 964   case Instruction::GetElementPtr: {
 965     SmallVector<Constant*, 8> Ops;
 966     Ops.resize(getNumOperands()-1);
 967     for (unsigned i = 1, e = getNumOperands(); i != e; ++i)
 968       Ops[i-1] = getOperand(i);
 969     if (OpNo == 0)
 970       return ConstantExpr::getGetElementPtr(Op, &Ops[0], Ops.size());
 971     Ops[OpNo-1] = Op;
 972     return ConstantExpr::getGetElementPtr(getOperand(0), &Ops[0], Ops.size());
 973   }
 974   default:
 975     assert(getNumOperands() == 2 && "Must be binary operator?");
 976     Op0 = (OpNo == 0) ? Op : getOperand(0);
 977     Op1 = (OpNo == 1) ? Op : getOperand(1);
 978     return ConstantExpr::get(getOpcode(), Op0, Op1);
 979   }
 980 }
 981
 982 /// getWithOperands - This returns the current constant expression with the
 983 /// operands replaced with the specified values.  The specified operands must
 984 /// match count and type with the existing ones.
 985 Constant *ConstantExpr::
 986 getWithOperands(Constant* const *Ops, unsigned NumOps) const {
 987   assert(NumOps == getNumOperands() && "Operand count mismatch!");
 988   bool AnyChange = false;
 989   for (unsigned i = 0; i != NumOps; ++i) {
 990     assert(Ops[i]->getType() == getOperand(i)->getType() &&
 991            "Operand type mismatch!");
 992     AnyChange |= Ops[i] != getOperand(i);
 993   }
 994   if (!AnyChange)  // No operands changed, return self.
 995     return const_cast<ConstantExpr*>(this);
 996
 997   switch (getOpcode()) {
 998   case Instruction::Trunc:
 999   case Instruction::ZExt:
1000   case Instruction::SExt:
1001   case Instruction::FPTrunc:
1002   case Instruction::FPExt:
1003   case Instruction::UIToFP:
1004   case Instruction::SIToFP:
1005   case Instruction::FPToUI:
1006   case Instruction::FPToSI:
1007   case Instruction::PtrToInt:
1008   case Instruction::IntToPtr:
1009   case Instruction::BitCast:
1010     return ConstantExpr::getCast(getOpcode(), Ops[0], getType());
1011   case Instruction::Select:
1012     return ConstantExpr::getSelect(Ops[0], Ops[1], Ops[2]);
1013   case Instruction::InsertElement:
1014     return ConstantExpr::getInsertElement(Ops[0], Ops[1], Ops[2]);
1015   case Instruction::ExtractElement:
1016     return ConstantExpr::getExtractElement(Ops[0], Ops[1]);
1017   case Instruction::ShuffleVector:
1018     return ConstantExpr::getShuffleVector(Ops[0], Ops[1], Ops[2]);
1019   case Instruction::GetElementPtr:
1020     return ConstantExpr::getGetElementPtr(Ops[0], &Ops[1], NumOps-1);
1021   case Instruction::ICmp:
1022   case Instruction::FCmp:
1023     return ConstantExpr::getCompare(getPredicate(), Ops[0], Ops[1]);
1024   default:
1025     assert(getNumOperands() == 2 && "Must be binary operator?");
1026     return ConstantExpr::get(getOpcode(), Ops[0], Ops[1]);
1027   }
1028 }
1029
1030
1031 //===----------------------------------------------------------------------===//
1032 //                      isValueValidForType implementations
1033
1034 bool ConstantInt::isValueValidForType(const Type *Ty, uint64_t Val) {
1035   unsigned NumBits = cast<IntegerType>(Ty)->getBitWidth(); // assert okay
1036   if (Ty == Type::Int1Ty)
1037     return Val == 0 || Val == 1;
1038   if (NumBits >= 64)
1039     return true; // always true, has to fit in largest type
1040   uint64_t Max = (1ll << NumBits) - 1;
1041   return Val <= Max;
1042 }
1043
1044 bool ConstantInt::isValueValidForType(const Type *Ty, int64_t Val) {
1045   unsigned NumBits = cast<IntegerType>(Ty)->getBitWidth(); // assert okay
1046   if (Ty == Type::Int1Ty)
1047     return Val == 0 || Val == 1 || Val == -1;
1048   if (NumBits >= 64)
1049     return true; // always true, has to fit in largest type
1050   int64_t Min = -(1ll << (NumBits-1));
1051   int64_t Max = (1ll << (NumBits-1)) - 1;
1052   return (Val >= Min && Val <= Max);
1053 }
1054
1055 bool ConstantFP::isValueValidForType(const Type *Ty, const APFloat& Val) {
1056   // convert modifies in place, so make a copy.
1057   APFloat Val2 = APFloat(Val);
1058   bool losesInfo;
1059   switch (Ty->getTypeID()) {
1060   default:
1061     return false;         // These can't be represented as floating point!
1062
1063   // FIXME rounding mode needs to be more flexible
1064   case Type::FloatTyID: {
1065     if (&Val2.getSemantics() == &APFloat::IEEEsingle)
1066       return true;
1067     Val2.convert(APFloat::IEEEsingle, APFloat::rmNearestTiesToEven, &losesInfo);
1068     return !losesInfo;
1069   }
1070   case Type::DoubleTyID: {
1071     if (&Val2.getSemantics() == &APFloat::IEEEsingle ||
1072         &Val2.getSemantics() == &APFloat::IEEEdouble)
1073       return true;
1074     Val2.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven, &losesInfo);
1075     return !losesInfo;
1076   }
1077   case Type::X86_FP80TyID:
1078     return &Val2.getSemantics() == &APFloat::IEEEsingle ||
1079            &Val2.getSemantics() == &APFloat::IEEEdouble ||
1080            &Val2.getSemantics() == &APFloat::x87DoubleExtended;
1081   case Type::FP128TyID:
1082     return &Val2.getSemantics() == &APFloat::IEEEsingle ||
1083            &Val2.getSemantics() == &APFloat::IEEEdouble ||
1084            &Val2.getSemantics() == &APFloat::IEEEquad;
1085   case Type::PPC_FP128TyID:
1086     return &Val2.getSemantics() == &APFloat::IEEEsingle ||
1087            &Val2.getSemantics() == &APFloat::IEEEdouble ||
1088            &Val2.getSemantics() == &APFloat::PPCDoubleDouble;
1089   }
1090 }
1091
1092 //===----------------------------------------------------------------------===//
1093 //                      Factory Function Implementation
1094
1095 static char getValType(ConstantAggregateZero *CPZ) { return 0; }
1096
1097 ConstantAggregateZero* ConstantAggregateZero::get(const Type* Ty) {
1098   assert((isa<StructType>(Ty) || isa<ArrayType>(Ty) || isa<VectorType>(Ty)) &&
1099          "Cannot create an aggregate zero of non-aggregate type!");
1100
1101   LLVMContextImpl *pImpl = Ty->getContext().pImpl;
1102   // Implicitly locked.
1103   return pImpl->AggZeroConstants.getOrCreate(Ty, 0);
1104 }
1105
1106 /// destroyConstant - Remove the constant from the constant table...
1107 ///
1108 void ConstantAggregateZero::destroyConstant() {
1109   // Implicitly locked.
1110   getType()->getContext().pImpl->AggZeroConstants.remove(this);
1111   destroyConstantImpl();
1112 }
1113
1114 /// destroyConstant - Remove the constant from the constant table...
1115 ///
1116 void ConstantArray::destroyConstant() {
1117   // Implicitly locked.
1118   getType()->getContext().pImpl->ArrayConstants.remove(this);
1119   destroyConstantImpl();
1120 }
1121
1122 /// isString - This method returns true if the array is an array of i8, and
1123 /// if the elements of the array are all ConstantInt's.
1124 bool ConstantArray::isString() const {
1125   // Check the element type for i8...
1126   if (getType()->getElementType() != Type::Int8Ty)
1127     return false;
1128   // Check the elements to make sure they are all integers, not constant
1129   // expressions.
1130   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
1131     if (!isa<ConstantInt>(getOperand(i)))
1132       return false;
1133   return true;
1134 }
1135
1136 /// isCString - This method returns true if the array is a string (see
1137 /// isString) and it ends in a null byte \\0 and does not contains any other
1138 /// null bytes except its terminator.
1139 bool ConstantArray::isCString() const {
1140   // Check the element type for i8...
1141   if (getType()->getElementType() != Type::Int8Ty)
1142     return false;
1143
1144   // Last element must be a null.
1145   if (!getOperand(getNumOperands()-1)->isNullValue())
1146     return false;
1147   // Other elements must be non-null integers.
1148   for (unsigned i = 0, e = getNumOperands()-1; i != e; ++i) {
1149     if (!isa<ConstantInt>(getOperand(i)))
1150       return false;
1151     if (getOperand(i)->isNullValue())
1152       return false;
1153   }
1154   return true;
1155 }
1156
1157
1158 /// getAsString - If the sub-element type of this array is i8
1159 /// then this method converts the array to an std::string and returns it.
1160 /// Otherwise, it asserts out.
1161 ///
1162 std::string ConstantArray::getAsString() const {
1163   assert(isString() && "Not a string!");
1164   std::string Result;
1165   Result.reserve(getNumOperands());
1166   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
1167     Result.push_back((char)cast<ConstantInt>(getOperand(i))->getZExtValue());
1168   return Result;
1169 }
1170
1171
1172 //---- ConstantStruct::get() implementation...
1173 //
1174
1175 namespace llvm {
1176
1177 }
1178
1179 // destroyConstant - Remove the constant from the constant table...
1180 //
1181 void ConstantStruct::destroyConstant() {
1182   // Implicitly locked.
1183   getType()->getContext().pImpl->StructConstants.remove(this);
1184   destroyConstantImpl();
1185 }
1186
1187 // destroyConstant - Remove the constant from the constant table...
1188 //
1189 void ConstantVector::destroyConstant() {
1190   // Implicitly locked.
1191   getType()->getContext().pImpl->VectorConstants.remove(this);
1192   destroyConstantImpl();
1193 }
1194
1195 /// This function will return true iff every element in this vector constant
1196 /// is set to all ones.
1197 /// @returns true iff this constant's emements are all set to all ones.
1198 /// @brief Determine if the value is all ones.
1199 bool ConstantVector::isAllOnesValue() const {
1200   // Check out first element.
1201   const Constant *Elt = getOperand(0);
1202   const ConstantInt *CI = dyn_cast<ConstantInt>(Elt);
1203   if (!CI || !CI->isAllOnesValue()) return false;
1204   // Then make sure all remaining elements point to the same value.
1205   for (unsigned I = 1, E = getNumOperands(); I < E; ++I) {
1206     if (getOperand(I) != Elt) return false;
1207   }
1208   return true;
1209 }
1210
1211 /// getSplatValue - If this is a splat constant, where all of the
1212 /// elements have the same value, return that value. Otherwise return null.
1213 Constant *ConstantVector::getSplatValue() {
1214   // Check out first element.
1215   Constant *Elt = getOperand(0);
1216   // Then make sure all remaining elements point to the same value.
1217   for (unsigned I = 1, E = getNumOperands(); I < E; ++I)
1218     if (getOperand(I) != Elt) return 0;
1219   return Elt;
1220 }
1221
1222 //---- ConstantPointerNull::get() implementation...
1223 //
1224
1225 static char getValType(ConstantPointerNull *) {
1226   return 0;
1227 }
1228
1229
1230 ConstantPointerNull *ConstantPointerNull::get(const PointerType *Ty) {
1231   // Implicitly locked.
1232   return Ty->getContext().pImpl->NullPtrConstants.getOrCreate(Ty, 0);
1233 }
1234
1235 // destroyConstant - Remove the constant from the constant table...
1236 //
1237 void ConstantPointerNull::destroyConstant() {
1238   // Implicitly locked.
1239   getType()->getContext().pImpl->NullPtrConstants.remove(this);
1240   destroyConstantImpl();
1241 }
1242
1243
1244 //---- UndefValue::get() implementation...
1245 //
1246
1247 static char getValType(UndefValue *) {
1248   return 0;
1249 }
1250
1251 UndefValue *UndefValue::get(const Type *Ty) {
1252   // Implicitly locked.
1253   return Ty->getContext().pImpl->UndefValueConstants.getOrCreate(Ty, 0);
1254 }
1255
1256 // destroyConstant - Remove the constant from the constant table.
1257 //
1258 void UndefValue::destroyConstant() {
1259   // Implicitly locked.
1260   getType()->getContext().pImpl->UndefValueConstants.remove(this);
1261   destroyConstantImpl();
1262 }
1263
1264 //---- ConstantExpr::get() implementations...
1265 //
1266
1267 namespace {
1268
1269 struct ExprMapKeyType {
1270   typedef SmallVector<unsigned, 4> IndexList;
1271
1272   ExprMapKeyType(unsigned opc,
1273       const std::vector<Constant*> &ops,
1274       unsigned short pred = 0,
1275       const IndexList &inds = IndexList())
1276         : opcode(opc), predicate(pred), operands(ops), indices(inds) {}
1277   uint16_t opcode;
1278   uint16_t predicate;
1279   std::vector<Constant*> operands;
1280   IndexList indices;
1281   bool operator==(const ExprMapKeyType& that) const {
1282     return this->opcode == that.opcode &&
1283            this->predicate == that.predicate &&
1284            this->operands == that.operands &&
1285            this->indices == that.indices;
1286   }
1287   bool operator<(const ExprMapKeyType & that) const {
1288     return this->opcode < that.opcode ||
1289       (this->opcode == that.opcode && this->predicate < that.predicate) ||
1290       (this->opcode == that.opcode && this->predicate == that.predicate &&
1291        this->operands < that.operands) ||
1292       (this->opcode == that.opcode && this->predicate == that.predicate &&
1293        this->operands == that.operands && this->indices < that.indices);
1294   }
1295
1296   bool operator!=(const ExprMapKeyType& that) const {
1297     return !(*this == that);
1298   }
1299 };
1300
1301 }
1302
1303 namespace llvm {
1304   template<>
1305   struct ConstantCreator<ConstantExpr, Type, ExprMapKeyType> {
1306     static ConstantExpr *create(const Type *Ty, const ExprMapKeyType &V,
1307         unsigned short pred = 0) {
1308       if (Instruction::isCast(V.opcode))
1309         return new UnaryConstantExpr(V.opcode, V.operands[0], Ty);
1310       if ((V.opcode >= Instruction::BinaryOpsBegin &&
1311            V.opcode < Instruction::BinaryOpsEnd))
1312         return new BinaryConstantExpr(V.opcode, V.operands[0], V.operands[1]);
1313       if (V.opcode == Instruction::Select)
1314         return new SelectConstantExpr(V.operands[0], V.operands[1],
1315                                       V.operands[2]);
1316       if (V.opcode == Instruction::ExtractElement)
1317         return new ExtractElementConstantExpr(V.operands[0], V.operands[1]);
1318       if (V.opcode == Instruction::InsertElement)
1319         return new InsertElementConstantExpr(V.operands[0], V.operands[1],
1320                                              V.operands[2]);
1321       if (V.opcode == Instruction::ShuffleVector)
1322         return new ShuffleVectorConstantExpr(V.operands[0], V.operands[1],
1323                                              V.operands[2]);
1324       if (V.opcode == Instruction::InsertValue)
1325         return new InsertValueConstantExpr(V.operands[0], V.operands[1],
1326                                            V.indices, Ty);
1327       if (V.opcode == Instruction::ExtractValue)
1328         return new ExtractValueConstantExpr(V.operands[0], V.indices, Ty);
1329       if (V.opcode == Instruction::GetElementPtr) {
1330         std::vector<Constant*> IdxList(V.operands.begin()+1, V.operands.end());
1331         return GetElementPtrConstantExpr::Create(V.operands[0], IdxList, Ty);
1332       }
1333
1334       // The compare instructions are weird. We have to encode the predicate
1335       // value and it is combined with the instruction opcode by multiplying
1336       // the opcode by one hundred. We must decode this to get the predicate.
1337       if (V.opcode == Instruction::ICmp)
1338         return new CompareConstantExpr(Ty, Instruction::ICmp, V.predicate,
1339                                        V.operands[0], V.operands[1]);
1340       if (V.opcode == Instruction::FCmp)
1341         return new CompareConstantExpr(Ty, Instruction::FCmp, V.predicate,
1342                                        V.operands[0], V.operands[1]);
1343       llvm_unreachable("Invalid ConstantExpr!");
1344       return 0;
1345     }
1346   };
1347
1348   template<>
1349   struct ConvertConstantType<ConstantExpr, Type> {
1350     static void convert(ConstantExpr *OldC, const Type *NewTy) {
1351       Constant *New;
1352       switch (OldC->getOpcode()) {
1353       case Instruction::Trunc:
1354       case Instruction::ZExt:
1355       case Instruction::SExt:
1356       case Instruction::FPTrunc:
1357       case Instruction::FPExt:
1358       case Instruction::UIToFP:
1359       case Instruction::SIToFP:
1360       case Instruction::FPToUI:
1361       case Instruction::FPToSI:
1362       case Instruction::PtrToInt:
1363       case Instruction::IntToPtr:
1364       case Instruction::BitCast:
1365         New = ConstantExpr::getCast(OldC->getOpcode(), OldC->getOperand(0),
1366                                     NewTy);
1367         break;
1368       case Instruction::Select:
1369         New = ConstantExpr::getSelectTy(NewTy, OldC->getOperand(0),
1370                                         OldC->getOperand(1),
1371                                         OldC->getOperand(2));
1372         break;
1373       default:
1374         assert(OldC->getOpcode() >= Instruction::BinaryOpsBegin &&
1375                OldC->getOpcode() <  Instruction::BinaryOpsEnd);
1376         New = ConstantExpr::getTy(NewTy, OldC->getOpcode(), OldC->getOperand(0),
1377                                   OldC->getOperand(1));
1378         break;
1379       case Instruction::GetElementPtr:
1380         // Make everyone now use a constant of the new type...
1381         std::vector<Value*> Idx(OldC->op_begin()+1, OldC->op_end());
1382         New = ConstantExpr::getGetElementPtrTy(NewTy, OldC->getOperand(0),
1383                                                &Idx[0], Idx.size());
1384         break;
1385       }
1386
1387       assert(New != OldC && "Didn't replace constant??");
1388       OldC->uncheckedReplaceAllUsesWith(New);
1389       OldC->destroyConstant();    // This constant is now dead, destroy it.
1390     }
1391   };
1392 } // end namespace llvm
1393
1394
1395 static ExprMapKeyType getValType(ConstantExpr *CE) {
1396   std::vector<Constant*> Operands;
1397   Operands.reserve(CE->getNumOperands());
1398   for (unsigned i = 0, e = CE->getNumOperands(); i != e; ++i)
1399     Operands.push_back(cast<Constant>(CE->getOperand(i)));
1400   return ExprMapKeyType(CE->getOpcode(), Operands,
1401       CE->isCompare() ? CE->getPredicate() : 0,
1402       CE->hasIndices() ?
1403         CE->getIndices() : SmallVector<unsigned, 4>());
1404 }
1405
1406 static ManagedStatic<ValueMap<ExprMapKeyType, Type,
1407                               ConstantExpr> > ExprConstants;
1408
1409 /// This is a utility function to handle folding of casts and lookup of the
1410 /// cast in the ExprConstants map. It is used by the various get* methods below.
1411 static inline Constant *getFoldedCast(
1412   Instruction::CastOps opc, Constant *C, const Type *Ty) {
1413   assert(Ty->isFirstClassType() && "Cannot cast to an aggregate type!");
1414   // Fold a few common cases
1415   if (Constant *FC = ConstantFoldCastInstruction(Ty->getContext(), opc, C, Ty))
1416     return FC;
1417
1418   // Look up the constant in the table first to ensure uniqueness
1419   std::vector<Constant*> argVec(1, C);
1420   ExprMapKeyType Key(opc, argVec);
1421
1422   // Implicitly locked.
1423   return ExprConstants->getOrCreate(Ty, Key);
1424 }
1425
1426 Constant *ConstantExpr::getCast(unsigned oc, Constant *C, const Type *Ty) {
1427   Instruction::CastOps opc = Instruction::CastOps(oc);
1428   assert(Instruction::isCast(opc) && "opcode out of range");
1429   assert(C && Ty && "Null arguments to getCast");
1430   assert(Ty->isFirstClassType() && "Cannot cast to an aggregate type!");
1431
1432   switch (opc) {
1433     default:
1434       llvm_unreachable("Invalid cast opcode");
1435       break;
1436     case Instruction::Trunc:    return getTrunc(C, Ty);
1437     case Instruction::ZExt:     return getZExt(C, Ty);
1438     case Instruction::SExt:     return getSExt(C, Ty);
1439     case Instruction::FPTrunc:  return getFPTrunc(C, Ty);
1440     case Instruction::FPExt:    return getFPExtend(C, Ty);
1441     case Instruction::UIToFP:   return getUIToFP(C, Ty);
1442     case Instruction::SIToFP:   return getSIToFP(C, Ty);
1443     case Instruction::FPToUI:   return getFPToUI(C, Ty);
1444     case Instruction::FPToSI:   return getFPToSI(C, Ty);
1445     case Instruction::PtrToInt: return getPtrToInt(C, Ty);
1446     case Instruction::IntToPtr: return getIntToPtr(C, Ty);
1447     case Instruction::BitCast:  return getBitCast(C, Ty);
1448   }
1449   return 0;
1450 }
1451
1452 Constant *ConstantExpr::getZExtOrBitCast(Constant *C, const Type *Ty) {
1453   if (C->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
1454     return getCast(Instruction::BitCast, C, Ty);
1455   return getCast(Instruction::ZExt, C, Ty);
1456 }
1457
1458 Constant *ConstantExpr::getSExtOrBitCast(Constant *C, const Type *Ty) {
1459   if (C->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
1460     return getCast(Instruction::BitCast, C, Ty);
1461   return getCast(Instruction::SExt, C, Ty);
1462 }
1463
1464 Constant *ConstantExpr::getTruncOrBitCast(Constant *C, const Type *Ty) {
1465   if (C->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
1466     return getCast(Instruction::BitCast, C, Ty);
1467   return getCast(Instruction::Trunc, C, Ty);
1468 }
1469
1470 Constant *ConstantExpr::getPointerCast(Constant *S, const Type *Ty) {
1471   assert(isa<PointerType>(S->getType()) && "Invalid cast");
1472   assert((Ty->isInteger() || isa<PointerType>(Ty)) && "Invalid cast");
1473
1474   if (Ty->isInteger())
1475     return getCast(Instruction::PtrToInt, S, Ty);
1476   return getCast(Instruction::BitCast, S, Ty);
1477 }
1478
1479 Constant *ConstantExpr::getIntegerCast(Constant *C, const Type *Ty,
1480                                        bool isSigned) {
1481   assert(C->getType()->isIntOrIntVector() &&
1482          Ty->isIntOrIntVector() && "Invalid cast");
1483   unsigned SrcBits = C->getType()->getScalarSizeInBits();
1484   unsigned DstBits = Ty->getScalarSizeInBits();
1485   Instruction::CastOps opcode =
1486     (SrcBits == DstBits ? Instruction::BitCast :
1487      (SrcBits > DstBits ? Instruction::Trunc :
1488       (isSigned ? Instruction::SExt : Instruction::ZExt)));
1489   return getCast(opcode, C, Ty);
1490 }
1491
1492 Constant *ConstantExpr::getFPCast(Constant *C, const Type *Ty) {
1493   assert(C->getType()->isFPOrFPVector() && Ty->isFPOrFPVector() &&
1494          "Invalid cast");
1495   unsigned SrcBits = C->getType()->getScalarSizeInBits();
1496   unsigned DstBits = Ty->getScalarSizeInBits();
1497   if (SrcBits == DstBits)
1498     return C; // Avoid a useless cast
1499   Instruction::CastOps opcode =
1500      (SrcBits > DstBits ? Instruction::FPTrunc : Instruction::FPExt);
1501   return getCast(opcode, C, Ty);
1502 }
1503
1504 Constant *ConstantExpr::getTrunc(Constant *C, const Type *Ty) {
1505 #ifndef NDEBUG
1506   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1507   bool toVec = Ty->getTypeID() == Type::VectorTyID;
1508 #endif
1509   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1510   assert(C->getType()->isIntOrIntVector() && "Trunc operand must be integer");
1511   assert(Ty->isIntOrIntVector() && "Trunc produces only integral");
1512   assert(C->getType()->getScalarSizeInBits() > Ty->getScalarSizeInBits()&&
1513          "SrcTy must be larger than DestTy for Trunc!");
1514
1515   return getFoldedCast(Instruction::Trunc, C, Ty);
1516 }
1517
1518 Constant *ConstantExpr::getSExt(Constant *C, const Type *Ty) {
1519 #ifndef NDEBUG
1520   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1521   bool toVec = Ty->getTypeID() == Type::VectorTyID;
1522 #endif
1523   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1524   assert(C->getType()->isIntOrIntVector() && "SExt operand must be integral");
1525   assert(Ty->isIntOrIntVector() && "SExt produces only integer");
1526   assert(C->getType()->getScalarSizeInBits() < Ty->getScalarSizeInBits()&&
1527          "SrcTy must be smaller than DestTy for SExt!");
1528
1529   return getFoldedCast(Instruction::SExt, C, Ty);
1530 }
1531
1532 Constant *ConstantExpr::getZExt(Constant *C, const Type *Ty) {
1533 #ifndef NDEBUG
1534   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1535   bool toVec = Ty->getTypeID() == Type::VectorTyID;
1536 #endif
1537   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1538   assert(C->getType()->isIntOrIntVector() && "ZEXt operand must be integral");
1539   assert(Ty->isIntOrIntVector() && "ZExt produces only integer");
1540   assert(C->getType()->getScalarSizeInBits() < Ty->getScalarSizeInBits()&&
1541          "SrcTy must be smaller than DestTy for ZExt!");
1542
1543   return getFoldedCast(Instruction::ZExt, C, Ty);
1544 }
1545
1546 Constant *ConstantExpr::getFPTrunc(Constant *C, const Type *Ty) {
1547 #ifndef NDEBUG
1548   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1549   bool toVec = Ty->getTypeID() == Type::VectorTyID;
1550 #endif
1551   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1552   assert(C->getType()->isFPOrFPVector() && Ty->isFPOrFPVector() &&
1553          C->getType()->getScalarSizeInBits() > Ty->getScalarSizeInBits()&&
1554          "This is an illegal floating point truncation!");
1555   return getFoldedCast(Instruction::FPTrunc, C, Ty);
1556 }
1557
1558 Constant *ConstantExpr::getFPExtend(Constant *C, const Type *Ty) {
1559 #ifndef NDEBUG
1560   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1561   bool toVec = Ty->getTypeID() == Type::VectorTyID;
1562 #endif
1563   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1564   assert(C->getType()->isFPOrFPVector() && Ty->isFPOrFPVector() &&
1565          C->getType()->getScalarSizeInBits() < Ty->getScalarSizeInBits()&&
1566          "This is an illegal floating point extension!");
1567   return getFoldedCast(Instruction::FPExt, C, Ty);
1568 }
1569
1570 Constant *ConstantExpr::getUIToFP(Constant *C, const Type *Ty) {
1571 #ifndef NDEBUG
1572   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1573   bool toVec = Ty->getTypeID() == Type::VectorTyID;
1574 #endif
1575   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1576   assert(C->getType()->isIntOrIntVector() && Ty->isFPOrFPVector() &&
1577          "This is an illegal uint to floating point cast!");
1578   return getFoldedCast(Instruction::UIToFP, C, Ty);
1579 }
1580
1581 Constant *ConstantExpr::getSIToFP(Constant *C, const Type *Ty) {
1582 #ifndef NDEBUG
1583   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1584   bool toVec = Ty->getTypeID() == Type::VectorTyID;
1585 #endif
1586   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1587   assert(C->getType()->isIntOrIntVector() && Ty->isFPOrFPVector() &&
1588          "This is an illegal sint to floating point cast!");
1589   return getFoldedCast(Instruction::SIToFP, C, Ty);
1590 }
1591
1592 Constant *ConstantExpr::getFPToUI(Constant *C, const Type *Ty) {
1593 #ifndef NDEBUG
1594   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1595   bool toVec = Ty->getTypeID() == Type::VectorTyID;
1596 #endif
1597   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1598   assert(C->getType()->isFPOrFPVector() && Ty->isIntOrIntVector() &&
1599          "This is an illegal floating point to uint cast!");
1600   return getFoldedCast(Instruction::FPToUI, C, Ty);
1601 }
1602
1603 Constant *ConstantExpr::getFPToSI(Constant *C, const Type *Ty) {
1604 #ifndef NDEBUG
1605   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1606   bool toVec = Ty->getTypeID() == Type::VectorTyID;
1607 #endif
1608   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1609   assert(C->getType()->isFPOrFPVector() && Ty->isIntOrIntVector() &&
1610          "This is an illegal floating point to sint cast!");
1611   return getFoldedCast(Instruction::FPToSI, C, Ty);
1612 }
1613
1614 Constant *ConstantExpr::getPtrToInt(Constant *C, const Type *DstTy) {
1615   assert(isa<PointerType>(C->getType()) && "PtrToInt source must be pointer");
1616   assert(DstTy->isInteger() && "PtrToInt destination must be integral");
1617   return getFoldedCast(Instruction::PtrToInt, C, DstTy);
1618 }
1619
1620 Constant *ConstantExpr::getIntToPtr(Constant *C, const Type *DstTy) {
1621   assert(C->getType()->isInteger() && "IntToPtr source must be integral");
1622   assert(isa<PointerType>(DstTy) && "IntToPtr destination must be a pointer");
1623   return getFoldedCast(Instruction::IntToPtr, C, DstTy);
1624 }
1625
1626 Constant *ConstantExpr::getBitCast(Constant *C, const Type *DstTy) {
1627   // BitCast implies a no-op cast of type only. No bits change.  However, you
1628   // can't cast pointers to anything but pointers.
1629 #ifndef NDEBUG
1630   const Type *SrcTy = C->getType();
1631   assert((isa<PointerType>(SrcTy) == isa<PointerType>(DstTy)) &&
1632          "BitCast cannot cast pointer to non-pointer and vice versa");
1633
1634   // Now we know we're not dealing with mismatched pointer casts (ptr->nonptr
1635   // or nonptr->ptr). For all the other types, the cast is okay if source and
1636   // destination bit widths are identical.
1637   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
1638   unsigned DstBitSize = DstTy->getPrimitiveSizeInBits();
1639 #endif
1640   assert(SrcBitSize == DstBitSize && "BitCast requires types of same width");
1641
1642   // It is common to ask for a bitcast of a value to its own type, handle this
1643   // speedily.
1644   if (C->getType() == DstTy) return C;
1645
1646   return getFoldedCast(Instruction::BitCast, C, DstTy);
1647 }
1648
1649 Constant *ConstantExpr::getTy(const Type *ReqTy, unsigned Opcode,
1650                               Constant *C1, Constant *C2) {
1651   // Check the operands for consistency first
1652   assert(Opcode >= Instruction::BinaryOpsBegin &&
1653          Opcode <  Instruction::BinaryOpsEnd   &&
1654          "Invalid opcode in binary constant expression");
1655   assert(C1->getType() == C2->getType() &&
1656          "Operand types in binary constant expression should match");
1657
1658   if (ReqTy == C1->getType() || ReqTy == Type::Int1Ty)
1659     if (Constant *FC = ConstantFoldBinaryInstruction(ReqTy->getContext(),
1660                                                      Opcode, C1, C2))
1661       return FC;          // Fold a few common cases...
1662
1663   std::vector<Constant*> argVec(1, C1); argVec.push_back(C2);
1664   ExprMapKeyType Key(Opcode, argVec);
1665
1666   // Implicitly locked.
1667   return ExprConstants->getOrCreate(ReqTy, Key);
1668 }
1669
1670 Constant *ConstantExpr::getCompareTy(unsigned short predicate,
1671                                      Constant *C1, Constant *C2) {
1672   switch (predicate) {
1673     default: llvm_unreachable("Invalid CmpInst predicate");
1674     case CmpInst::FCMP_FALSE: case CmpInst::FCMP_OEQ: case CmpInst::FCMP_OGT:
1675     case CmpInst::FCMP_OGE:   case CmpInst::FCMP_OLT: case CmpInst::FCMP_OLE:
1676     case CmpInst::FCMP_ONE:   case CmpInst::FCMP_ORD: case CmpInst::FCMP_UNO:
1677     case CmpInst::FCMP_UEQ:   case CmpInst::FCMP_UGT: case CmpInst::FCMP_UGE:
1678     case CmpInst::FCMP_ULT:   case CmpInst::FCMP_ULE: case CmpInst::FCMP_UNE:
1679     case CmpInst::FCMP_TRUE:
1680       return getFCmp(predicate, C1, C2);
1681
1682     case CmpInst::ICMP_EQ:  case CmpInst::ICMP_NE:  case CmpInst::ICMP_UGT:
1683     case CmpInst::ICMP_UGE: case CmpInst::ICMP_ULT: case CmpInst::ICMP_ULE:
1684     case CmpInst::ICMP_SGT: case CmpInst::ICMP_SGE: case CmpInst::ICMP_SLT:
1685     case CmpInst::ICMP_SLE:
1686       return getICmp(predicate, C1, C2);
1687   }
1688 }
1689
1690 Constant *ConstantExpr::get(unsigned Opcode, Constant *C1, Constant *C2) {
1691   // API compatibility: Adjust integer opcodes to floating-point opcodes.
1692   if (C1->getType()->isFPOrFPVector()) {
1693     if (Opcode == Instruction::Add) Opcode = Instruction::FAdd;
1694     else if (Opcode == Instruction::Sub) Opcode = Instruction::FSub;
1695     else if (Opcode == Instruction::Mul) Opcode = Instruction::FMul;
1696   }
1697 #ifndef NDEBUG
1698   switch (Opcode) {
1699   case Instruction::Add:
1700   case Instruction::Sub:
1701   case Instruction::Mul:
1702     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1703     assert(C1->getType()->isIntOrIntVector() &&
1704            "Tried to create an integer operation on a non-integer type!");
1705     break;
1706   case Instruction::FAdd:
1707   case Instruction::FSub:
1708   case Instruction::FMul:
1709     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1710     assert(C1->getType()->isFPOrFPVector() &&
1711            "Tried to create a floating-point operation on a "
1712            "non-floating-point type!");
1713     break;
1714   case Instruction::UDiv:
1715   case Instruction::SDiv:
1716     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1717     assert(C1->getType()->isIntOrIntVector() &&
1718            "Tried to create an arithmetic operation on a non-arithmetic type!");
1719     break;
1720   case Instruction::FDiv:
1721     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1722     assert(C1->getType()->isFPOrFPVector() &&
1723            "Tried to create an arithmetic operation on a non-arithmetic type!");
1724     break;
1725   case Instruction::URem:
1726   case Instruction::SRem:
1727     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1728     assert(C1->getType()->isIntOrIntVector() &&
1729            "Tried to create an arithmetic operation on a non-arithmetic type!");
1730     break;
1731   case Instruction::FRem:
1732     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1733     assert(C1->getType()->isFPOrFPVector() &&
1734            "Tried to create an arithmetic operation on a non-arithmetic type!");
1735     break;
1736   case Instruction::And:
1737   case Instruction::Or:
1738   case Instruction::Xor:
1739     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1740     assert(C1->getType()->isIntOrIntVector() &&
1741            "Tried to create a logical operation on a non-integral type!");
1742     break;
1743   case Instruction::Shl:
1744   case Instruction::LShr:
1745   case Instruction::AShr:
1746     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1747     assert(C1->getType()->isIntOrIntVector() &&
1748            "Tried to create a shift operation on a non-integer type!");
1749     break;
1750   default:
1751     break;
1752   }
1753 #endif
1754
1755   return getTy(C1->getType(), Opcode, C1, C2);
1756 }
1757
1758 Constant* ConstantExpr::getSizeOf(const Type* Ty) {
1759   // sizeof is implemented as: (i64) gep (Ty*)null, 1
1760   // Note that a non-inbounds gep is used, as null isn't within any object.
1761   Constant *GEPIdx = ConstantInt::get(Type::Int32Ty, 1);
1762   Constant *GEP = getGetElementPtr(
1763                  Constant::getNullValue(PointerType::getUnqual(Ty)), &GEPIdx, 1);
1764   return getCast(Instruction::PtrToInt, GEP, Type::Int64Ty);
1765 }
1766
1767 Constant* ConstantExpr::getAlignOf(const Type* Ty) {
1768   // alignof is implemented as: (i64) gep ({i8,Ty}*)null, 0, 1
1769   const Type *AligningTy = StructType::get(Type::Int8Ty, Ty, NULL);
1770   Constant *NullPtr = Constant::getNullValue(AligningTy->getPointerTo());
1771   Constant *Zero = ConstantInt::get(Type::Int32Ty, 0);
1772   Constant *One = ConstantInt::get(Type::Int32Ty, 1);
1773   Constant *Indices[2] = { Zero, One };
1774   Constant *GEP = getGetElementPtr(NullPtr, Indices, 2);
1775   return getCast(Instruction::PtrToInt, GEP, Type::Int32Ty);
1776 }
1777
1778
1779 Constant *ConstantExpr::getCompare(unsigned short pred,
1780                             Constant *C1, Constant *C2) {
1781   assert(C1->getType() == C2->getType() && "Op types should be identical!");
1782   return getCompareTy(pred, C1, C2);
1783 }
1784
1785 Constant *ConstantExpr::getSelectTy(const Type *ReqTy, Constant *C,
1786                                     Constant *V1, Constant *V2) {
1787   assert(!SelectInst::areInvalidOperands(C, V1, V2)&&"Invalid select operands");
1788
1789   if (ReqTy == V1->getType())
1790     if (Constant *SC = ConstantFoldSelectInstruction(
1791                                                 ReqTy->getContext(), C, V1, V2))
1792       return SC;        // Fold common cases
1793
1794   std::vector<Constant*> argVec(3, C);
1795   argVec[1] = V1;
1796   argVec[2] = V2;
1797   ExprMapKeyType Key(Instruction::Select, argVec);
1798
1799   // Implicitly locked.
1800   return ExprConstants->getOrCreate(ReqTy, Key);
1801 }
1802
1803 Constant *ConstantExpr::getGetElementPtrTy(const Type *ReqTy, Constant *C,
1804                                            Value* const *Idxs,
1805                                            unsigned NumIdx) {
1806   assert(GetElementPtrInst::getIndexedType(C->getType(), Idxs,
1807                                            Idxs+NumIdx) ==
1808          cast<PointerType>(ReqTy)->getElementType() &&
1809          "GEP indices invalid!");
1810
1811   if (Constant *FC = ConstantFoldGetElementPtr(
1812                               ReqTy->getContext(), C, (Constant**)Idxs, NumIdx))
1813     return FC;          // Fold a few common cases...
1814
1815   assert(isa<PointerType>(C->getType()) &&
1816          "Non-pointer type for constant GetElementPtr expression");
1817   // Look up the constant in the table first to ensure uniqueness
1818   std::vector<Constant*> ArgVec;
1819   ArgVec.reserve(NumIdx+1);
1820   ArgVec.push_back(C);
1821   for (unsigned i = 0; i != NumIdx; ++i)
1822     ArgVec.push_back(cast<Constant>(Idxs[i]));
1823   const ExprMapKeyType Key(Instruction::GetElementPtr, ArgVec);
1824
1825   // Implicitly locked.
1826   return ExprConstants->getOrCreate(ReqTy, Key);
1827 }
1828
1829 Constant *ConstantExpr::getGetElementPtr(Constant *C, Value* const *Idxs,
1830                                          unsigned NumIdx) {
1831   // Get the result type of the getelementptr!
1832   const Type *Ty =
1833     GetElementPtrInst::getIndexedType(C->getType(), Idxs, Idxs+NumIdx);
1834   assert(Ty && "GEP indices invalid!");
1835   unsigned As = cast<PointerType>(C->getType())->getAddressSpace();
1836   return getGetElementPtrTy(PointerType::get(Ty, As), C, Idxs, NumIdx);
1837 }
1838
1839 Constant *ConstantExpr::getGetElementPtr(Constant *C, Constant* const *Idxs,
1840                                          unsigned NumIdx) {
1841   return getGetElementPtr(C, (Value* const *)Idxs, NumIdx);
1842 }
1843
1844
1845 Constant *
1846 ConstantExpr::getICmp(unsigned short pred, Constant* LHS, Constant* RHS) {
1847   assert(LHS->getType() == RHS->getType());
1848   assert(pred >= ICmpInst::FIRST_ICMP_PREDICATE &&
1849          pred <= ICmpInst::LAST_ICMP_PREDICATE && "Invalid ICmp Predicate");
1850
1851   if (Constant *FC = ConstantFoldCompareInstruction(
1852                                              LHS->getContext(), pred, LHS, RHS))
1853     return FC;          // Fold a few common cases...
1854
1855   // Look up the constant in the table first to ensure uniqueness
1856   std::vector<Constant*> ArgVec;
1857   ArgVec.push_back(LHS);
1858   ArgVec.push_back(RHS);
1859   // Get the key type with both the opcode and predicate
1860   const ExprMapKeyType Key(Instruction::ICmp, ArgVec, pred);
1861
1862   // Implicitly locked.
1863   return ExprConstants->getOrCreate(Type::Int1Ty, Key);
1864 }
1865
1866 Constant *
1867 ConstantExpr::getFCmp(unsigned short pred, Constant* LHS, Constant* RHS) {
1868   assert(LHS->getType() == RHS->getType());
1869   assert(pred <= FCmpInst::LAST_FCMP_PREDICATE && "Invalid FCmp Predicate");
1870
1871   if (Constant *FC = ConstantFoldCompareInstruction(
1872                                             LHS->getContext(), pred, LHS, RHS))
1873     return FC;          // Fold a few common cases...
1874
1875   // Look up the constant in the table first to ensure uniqueness
1876   std::vector<Constant*> ArgVec;
1877   ArgVec.push_back(LHS);
1878   ArgVec.push_back(RHS);
1879   // Get the key type with both the opcode and predicate
1880   const ExprMapKeyType Key(Instruction::FCmp, ArgVec, pred);
1881
1882   // Implicitly locked.
1883   return ExprConstants->getOrCreate(Type::Int1Ty, Key);
1884 }
1885
1886 Constant *ConstantExpr::getExtractElementTy(const Type *ReqTy, Constant *Val,
1887                                             Constant *Idx) {
1888   if (Constant *FC = ConstantFoldExtractElementInstruction(
1889                                                 ReqTy->getContext(), Val, Idx))
1890     return FC;          // Fold a few common cases...
1891   // Look up the constant in the table first to ensure uniqueness
1892   std::vector<Constant*> ArgVec(1, Val);
1893   ArgVec.push_back(Idx);
1894   const ExprMapKeyType Key(Instruction::ExtractElement,ArgVec);
1895
1896   // Implicitly locked.
1897   return ExprConstants->getOrCreate(ReqTy, Key);
1898 }
1899
1900 Constant *ConstantExpr::getExtractElement(Constant *Val, Constant *Idx) {
1901   assert(isa<VectorType>(Val->getType()) &&
1902          "Tried to create extractelement operation on non-vector type!");
1903   assert(Idx->getType() == Type::Int32Ty &&
1904          "Extractelement index must be i32 type!");
1905   return getExtractElementTy(cast<VectorType>(Val->getType())->getElementType(),
1906                              Val, Idx);
1907 }
1908
1909 Constant *ConstantExpr::getInsertElementTy(const Type *ReqTy, Constant *Val,
1910                                            Constant *Elt, Constant *Idx) {
1911   if (Constant *FC = ConstantFoldInsertElementInstruction(
1912                                             ReqTy->getContext(), Val, Elt, Idx))
1913     return FC;          // Fold a few common cases...
1914   // Look up the constant in the table first to ensure uniqueness
1915   std::vector<Constant*> ArgVec(1, Val);
1916   ArgVec.push_back(Elt);
1917   ArgVec.push_back(Idx);
1918   const ExprMapKeyType Key(Instruction::InsertElement,ArgVec);
1919
1920   // Implicitly locked.
1921   return ExprConstants->getOrCreate(ReqTy, Key);
1922 }
1923
1924 Constant *ConstantExpr::getInsertElement(Constant *Val, Constant *Elt,
1925                                          Constant *Idx) {
1926   assert(isa<VectorType>(Val->getType()) &&
1927          "Tried to create insertelement operation on non-vector type!");
1928   assert(Elt->getType() == cast<VectorType>(Val->getType())->getElementType()
1929          && "Insertelement types must match!");
1930   assert(Idx->getType() == Type::Int32Ty &&
1931          "Insertelement index must be i32 type!");
1932   return getInsertElementTy(Val->getType(), Val, Elt, Idx);
1933 }
1934
1935 Constant *ConstantExpr::getShuffleVectorTy(const Type *ReqTy, Constant *V1,
1936                                            Constant *V2, Constant *Mask) {
1937   if (Constant *FC = ConstantFoldShuffleVectorInstruction(
1938                                             ReqTy->getContext(), V1, V2, Mask))
1939     return FC;          // Fold a few common cases...
1940   // Look up the constant in the table first to ensure uniqueness
1941   std::vector<Constant*> ArgVec(1, V1);
1942   ArgVec.push_back(V2);
1943   ArgVec.push_back(Mask);
1944   const ExprMapKeyType Key(Instruction::ShuffleVector,ArgVec);
1945
1946   // Implicitly locked.
1947   return ExprConstants->getOrCreate(ReqTy, Key);
1948 }
1949
1950 Constant *ConstantExpr::getShuffleVector(Constant *V1, Constant *V2,
1951                                          Constant *Mask) {
1952   assert(ShuffleVectorInst::isValidOperands(V1, V2, Mask) &&
1953          "Invalid shuffle vector constant expr operands!");
1954
1955   unsigned NElts = cast<VectorType>(Mask->getType())->getNumElements();
1956   const Type *EltTy = cast<VectorType>(V1->getType())->getElementType();
1957   const Type *ShufTy = VectorType::get(EltTy, NElts);
1958   return getShuffleVectorTy(ShufTy, V1, V2, Mask);
1959 }
1960
1961 Constant *ConstantExpr::getInsertValueTy(const Type *ReqTy, Constant *Agg,
1962                                          Constant *Val,
1963                                         const unsigned *Idxs, unsigned NumIdx) {
1964   assert(ExtractValueInst::getIndexedType(Agg->getType(), Idxs,
1965                                           Idxs+NumIdx) == Val->getType() &&
1966          "insertvalue indices invalid!");
1967   assert(Agg->getType() == ReqTy &&
1968          "insertvalue type invalid!");
1969   assert(Agg->getType()->isFirstClassType() &&
1970          "Non-first-class type for constant InsertValue expression");
1971   Constant *FC = ConstantFoldInsertValueInstruction(
1972                                   ReqTy->getContext(), Agg, Val, Idxs, NumIdx);
1973   assert(FC && "InsertValue constant expr couldn't be folded!");
1974   return FC;
1975 }
1976
1977 Constant *ConstantExpr::getInsertValue(Constant *Agg, Constant *Val,
1978                                      const unsigned *IdxList, unsigned NumIdx) {
1979   assert(Agg->getType()->isFirstClassType() &&
1980          "Tried to create insertelement operation on non-first-class type!");
1981
1982   const Type *ReqTy = Agg->getType();
1983 #ifndef NDEBUG
1984   const Type *ValTy =
1985     ExtractValueInst::getIndexedType(Agg->getType(), IdxList, IdxList+NumIdx);
1986 #endif
1987   assert(ValTy == Val->getType() && "insertvalue indices invalid!");
1988   return getInsertValueTy(ReqTy, Agg, Val, IdxList, NumIdx);
1989 }
1990
1991 Constant *ConstantExpr::getExtractValueTy(const Type *ReqTy, Constant *Agg,
1992                                         const unsigned *Idxs, unsigned NumIdx) {
1993   assert(ExtractValueInst::getIndexedType(Agg->getType(), Idxs,
1994                                           Idxs+NumIdx) == ReqTy &&
1995          "extractvalue indices invalid!");
1996   assert(Agg->getType()->isFirstClassType() &&
1997          "Non-first-class type for constant extractvalue expression");
1998   Constant *FC = ConstantFoldExtractValueInstruction(
1999                                         ReqTy->getContext(), Agg, Idxs, NumIdx);
2000   assert(FC && "ExtractValue constant expr couldn't be folded!");
2001   return FC;
2002 }
2003
2004 Constant *ConstantExpr::getExtractValue(Constant *Agg,
2005                                      const unsigned *IdxList, unsigned NumIdx) {
2006   assert(Agg->getType()->isFirstClassType() &&
2007          "Tried to create extractelement operation on non-first-class type!");
2008
2009   const Type *ReqTy =
2010     ExtractValueInst::getIndexedType(Agg->getType(), IdxList, IdxList+NumIdx);
2011   assert(ReqTy && "extractvalue indices invalid!");
2012   return getExtractValueTy(ReqTy, Agg, IdxList, NumIdx);
2013 }
2014
2015 Constant* ConstantExpr::getNeg(Constant* C) {
2016   // API compatibility: Adjust integer opcodes to floating-point opcodes.
2017   if (C->getType()->isFPOrFPVector())
2018     return getFNeg(C);
2019   assert(C->getType()->isIntOrIntVector() &&
2020          "Cannot NEG a nonintegral value!");
2021   return get(Instruction::Sub,
2022              ConstantFP::getZeroValueForNegation(C->getType()),
2023              C);
2024 }
2025
2026 Constant* ConstantExpr::getFNeg(Constant* C) {
2027   assert(C->getType()->isFPOrFPVector() &&
2028          "Cannot FNEG a non-floating-point value!");
2029   return get(Instruction::FSub,
2030              ConstantFP::getZeroValueForNegation(C->getType()),
2031              C);
2032 }
2033
2034 Constant* ConstantExpr::getNot(Constant* C) {
2035   assert(C->getType()->isIntOrIntVector() &&
2036          "Cannot NOT a nonintegral value!");
2037   return get(Instruction::Xor, C, Constant::getAllOnesValue(C->getType()));
2038 }
2039
2040 Constant* ConstantExpr::getAdd(Constant* C1, Constant* C2) {
2041   return get(Instruction::Add, C1, C2);
2042 }
2043
2044 Constant* ConstantExpr::getFAdd(Constant* C1, Constant* C2) {
2045   return get(Instruction::FAdd, C1, C2);
2046 }
2047
2048 Constant* ConstantExpr::getSub(Constant* C1, Constant* C2) {
2049   return get(Instruction::Sub, C1, C2);
2050 }
2051
2052 Constant* ConstantExpr::getFSub(Constant* C1, Constant* C2) {
2053   return get(Instruction::FSub, C1, C2);
2054 }
2055
2056 Constant* ConstantExpr::getMul(Constant* C1, Constant* C2) {
2057   return get(Instruction::Mul, C1, C2);
2058 }
2059
2060 Constant* ConstantExpr::getFMul(Constant* C1, Constant* C2) {
2061   return get(Instruction::FMul, C1, C2);
2062 }
2063
2064 Constant* ConstantExpr::getUDiv(Constant* C1, Constant* C2) {
2065   return get(Instruction::UDiv, C1, C2);
2066 }
2067
2068 Constant* ConstantExpr::getSDiv(Constant* C1, Constant* C2) {
2069   return get(Instruction::SDiv, C1, C2);
2070 }
2071
2072 Constant* ConstantExpr::getFDiv(Constant* C1, Constant* C2) {
2073   return get(Instruction::FDiv, C1, C2);
2074 }
2075
2076 Constant* ConstantExpr::getURem(Constant* C1, Constant* C2) {
2077   return get(Instruction::URem, C1, C2);
2078 }
2079
2080 Constant* ConstantExpr::getSRem(Constant* C1, Constant* C2) {
2081   return get(Instruction::SRem, C1, C2);
2082 }
2083
2084 Constant* ConstantExpr::getFRem(Constant* C1, Constant* C2) {
2085   return get(Instruction::FRem, C1, C2);
2086 }
2087
2088 Constant* ConstantExpr::getAnd(Constant* C1, Constant* C2) {
2089   return get(Instruction::And, C1, C2);
2090 }
2091
2092 Constant* ConstantExpr::getOr(Constant* C1, Constant* C2) {
2093   return get(Instruction::Or, C1, C2);
2094 }
2095
2096 Constant* ConstantExpr::getXor(Constant* C1, Constant* C2) {
2097   return get(Instruction::Xor, C1, C2);
2098 }
2099
2100 Constant* ConstantExpr::getShl(Constant* C1, Constant* C2) {
2101   return get(Instruction::Shl, C1, C2);
2102 }
2103
2104 Constant* ConstantExpr::getLShr(Constant* C1, Constant* C2) {
2105   return get(Instruction::LShr, C1, C2);
2106 }
2107
2108 Constant* ConstantExpr::getAShr(Constant* C1, Constant* C2) {
2109   return get(Instruction::AShr, C1, C2);
2110 }
2111
2112 // destroyConstant - Remove the constant from the constant table...
2113 //
2114 void ConstantExpr::destroyConstant() {
2115   // Implicitly locked.
2116   ExprConstants->remove(this);
2117   destroyConstantImpl();
2118 }
2119
2120 const char *ConstantExpr::getOpcodeName() const {
2121   return Instruction::getOpcodeName(getOpcode());
2122 }
2123
2124 //===----------------------------------------------------------------------===//
2125 //                replaceUsesOfWithOnConstant implementations
2126
2127 /// replaceUsesOfWithOnConstant - Update this constant array to change uses of
2128 /// 'From' to be uses of 'To'.  This must update the uniquing data structures
2129 /// etc.
2130 ///
2131 /// Note that we intentionally replace all uses of From with To here.  Consider
2132 /// a large array that uses 'From' 1000 times.  By handling this case all here,
2133 /// ConstantArray::replaceUsesOfWithOnConstant is only invoked once, and that
2134 /// single invocation handles all 1000 uses.  Handling them one at a time would
2135 /// work, but would be really slow because it would have to unique each updated
2136 /// array instance.
2137
2138 static std::vector<Constant*> getValType(ConstantArray *CA) {
2139   std::vector<Constant*> Elements;
2140   Elements.reserve(CA->getNumOperands());
2141   for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
2142     Elements.push_back(cast<Constant>(CA->getOperand(i)));
2143   return Elements;
2144 }
2145
2146
2147 void ConstantArray::replaceUsesOfWithOnConstant(Value *From, Value *To,
2148                                                 Use *U) {
2149   assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
2150   Constant *ToC = cast<Constant>(To);
2151
2152   LLVMContext &Context = getType()->getContext();
2153   LLVMContextImpl *pImpl = Context.pImpl;
2154
2155   std::pair<LLVMContextImpl::ArrayConstantsTy::MapKey, Constant*> Lookup;
2156   Lookup.first.first = getType();
2157   Lookup.second = this;
2158
2159   std::vector<Constant*> &Values = Lookup.first.second;
2160   Values.reserve(getNumOperands());  // Build replacement array.
2161
2162   // Fill values with the modified operands of the constant array.  Also,
2163   // compute whether this turns into an all-zeros array.
2164   bool isAllZeros = false;
2165   unsigned NumUpdated = 0;
2166   if (!ToC->isNullValue()) {
2167     for (Use *O = OperandList, *E = OperandList+getNumOperands(); O != E; ++O) {
2168       Constant *Val = cast<Constant>(O->get());
2169       if (Val == From) {
2170         Val = ToC;
2171         ++NumUpdated;
2172       }
2173       Values.push_back(Val);
2174     }
2175   } else {
2176     isAllZeros = true;
2177     for (Use *O = OperandList, *E = OperandList+getNumOperands();O != E; ++O) {
2178       Constant *Val = cast<Constant>(O->get());
2179       if (Val == From) {
2180         Val = ToC;
2181         ++NumUpdated;
2182       }
2183       Values.push_back(Val);
2184       if (isAllZeros) isAllZeros = Val->isNullValue();
2185     }
2186   }
2187
2188   Constant *Replacement = 0;
2189   if (isAllZeros) {
2190     Replacement = ConstantAggregateZero::get(getType());
2191   } else {
2192     // Check to see if we have this array type already.
2193     sys::SmartScopedWriter<true> Writer(pImpl->ConstantsLock);
2194     bool Exists;
2195     LLVMContextImpl::ArrayConstantsTy::MapTy::iterator I =
2196       pImpl->ArrayConstants.InsertOrGetItem(Lookup, Exists);
2197
2198     if (Exists) {
2199       Replacement = I->second;
2200     } else {
2201       // Okay, the new shape doesn't exist in the system yet.  Instead of
2202       // creating a new constant array, inserting it, replaceallusesof'ing the
2203       // old with the new, then deleting the old... just update the current one
2204       // in place!
2205       pImpl->ArrayConstants.MoveConstantToNewSlot(this, I);
2206
2207       // Update to the new value.  Optimize for the case when we have a single
2208       // operand that we're changing, but handle bulk updates efficiently.
2209       if (NumUpdated == 1) {
2210         unsigned OperandToUpdate = U - OperandList;
2211         assert(getOperand(OperandToUpdate) == From &&
2212                "ReplaceAllUsesWith broken!");
2213         setOperand(OperandToUpdate, ToC);
2214       } else {
2215         for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
2216           if (getOperand(i) == From)
2217             setOperand(i, ToC);
2218       }
2219       return;
2220     }
2221   }
2222
2223   // Otherwise, I do need to replace this with an existing value.
2224   assert(Replacement != this && "I didn't contain From!");
2225
2226   // Everyone using this now uses the replacement.
2227   uncheckedReplaceAllUsesWith(Replacement);
2228
2229   // Delete the old constant!
2230   destroyConstant();
2231 }
2232
2233 static std::vector<Constant*> getValType(ConstantStruct *CS) {
2234   std::vector<Constant*> Elements;
2235   Elements.reserve(CS->getNumOperands());
2236   for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i)
2237     Elements.push_back(cast<Constant>(CS->getOperand(i)));
2238   return Elements;
2239 }
2240
2241 void ConstantStruct::replaceUsesOfWithOnConstant(Value *From, Value *To,
2242                                                  Use *U) {
2243   assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
2244   Constant *ToC = cast<Constant>(To);
2245
2246   unsigned OperandToUpdate = U-OperandList;
2247   assert(getOperand(OperandToUpdate) == From && "ReplaceAllUsesWith broken!");
2248
2249   std::pair<LLVMContextImpl::StructConstantsTy::MapKey, Constant*> Lookup;
2250   Lookup.first.first = getType();
2251   Lookup.second = this;
2252   std::vector<Constant*> &Values = Lookup.first.second;
2253   Values.reserve(getNumOperands());  // Build replacement struct.
2254
2255
2256   // Fill values with the modified operands of the constant struct.  Also,
2257   // compute whether this turns into an all-zeros struct.
2258   bool isAllZeros = false;
2259   if (!ToC->isNullValue()) {
2260     for (Use *O = OperandList, *E = OperandList + getNumOperands(); O != E; ++O)
2261       Values.push_back(cast<Constant>(O->get()));
2262   } else {
2263     isAllZeros = true;
2264     for (Use *O = OperandList, *E = OperandList+getNumOperands(); O != E; ++O) {
2265       Constant *Val = cast<Constant>(O->get());
2266       Values.push_back(Val);
2267       if (isAllZeros) isAllZeros = Val->isNullValue();
2268     }
2269   }
2270   Values[OperandToUpdate] = ToC;
2271
2272   LLVMContext &Context = getType()->getContext();
2273   LLVMContextImpl *pImpl = Context.pImpl;
2274
2275   Constant *Replacement = 0;
2276   if (isAllZeros) {
2277     Replacement = ConstantAggregateZero::get(getType());
2278   } else {
2279     // Check to see if we have this array type already.
2280     sys::SmartScopedWriter<true> Writer(pImpl->ConstantsLock);
2281     bool Exists;
2282     LLVMContextImpl::StructConstantsTy::MapTy::iterator I =
2283       pImpl->StructConstants.InsertOrGetItem(Lookup, Exists);
2284
2285     if (Exists) {
2286       Replacement = I->second;
2287     } else {
2288       // Okay, the new shape doesn't exist in the system yet.  Instead of
2289       // creating a new constant struct, inserting it, replaceallusesof'ing the
2290       // old with the new, then deleting the old... just update the current one
2291       // in place!
2292       pImpl->StructConstants.MoveConstantToNewSlot(this, I);
2293
2294       // Update to the new value.
2295       setOperand(OperandToUpdate, ToC);
2296       return;
2297     }
2298   }
2299
2300   assert(Replacement != this && "I didn't contain From!");
2301
2302   // Everyone using this now uses the replacement.
2303   uncheckedReplaceAllUsesWith(Replacement);
2304
2305   // Delete the old constant!
2306   destroyConstant();
2307 }
2308
2309 static std::vector<Constant*> getValType(ConstantVector *CP) {
2310   std::vector<Constant*> Elements;
2311   Elements.reserve(CP->getNumOperands());
2312   for (unsigned i = 0, e = CP->getNumOperands(); i != e; ++i)
2313     Elements.push_back(CP->getOperand(i));
2314   return Elements;
2315 }
2316
2317 void ConstantVector::replaceUsesOfWithOnConstant(Value *From, Value *To,
2318                                                  Use *U) {
2319   assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
2320
2321   std::vector<Constant*> Values;
2322   Values.reserve(getNumOperands());  // Build replacement array...
2323   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
2324     Constant *Val = getOperand(i);
2325     if (Val == From) Val = cast<Constant>(To);
2326     Values.push_back(Val);
2327   }
2328
2329   Constant *Replacement = get(getType(), Values);
2330   assert(Replacement != this && "I didn't contain From!");
2331
2332   // Everyone using this now uses the replacement.
2333   uncheckedReplaceAllUsesWith(Replacement);
2334
2335   // Delete the old constant!
2336   destroyConstant();
2337 }
2338
2339 void ConstantExpr::replaceUsesOfWithOnConstant(Value *From, Value *ToV,
2340                                                Use *U) {
2341   assert(isa<Constant>(ToV) && "Cannot make Constant refer to non-constant!");
2342   Constant *To = cast<Constant>(ToV);
2343
2344   Constant *Replacement = 0;
2345   if (getOpcode() == Instruction::GetElementPtr) {
2346     SmallVector<Constant*, 8> Indices;
2347     Constant *Pointer = getOperand(0);
2348     Indices.reserve(getNumOperands()-1);
2349     if (Pointer == From) Pointer = To;
2350
2351     for (unsigned i = 1, e = getNumOperands(); i != e; ++i) {
2352       Constant *Val = getOperand(i);
2353       if (Val == From) Val = To;
2354       Indices.push_back(Val);
2355     }
2356     Replacement = ConstantExpr::getGetElementPtr(Pointer,
2357                                                  &Indices[0], Indices.size());
2358   } else if (getOpcode() == Instruction::ExtractValue) {
2359     Constant *Agg = getOperand(0);
2360     if (Agg == From) Agg = To;
2361
2362     const SmallVector<unsigned, 4> &Indices = getIndices();
2363     Replacement = ConstantExpr::getExtractValue(Agg,
2364                                                 &Indices[0], Indices.size());
2365   } else if (getOpcode() == Instruction::InsertValue) {
2366     Constant *Agg = getOperand(0);
2367     Constant *Val = getOperand(1);
2368     if (Agg == From) Agg = To;
2369     if (Val == From) Val = To;
2370
2371     const SmallVector<unsigned, 4> &Indices = getIndices();
2372     Replacement = ConstantExpr::getInsertValue(Agg, Val,
2373                                                &Indices[0], Indices.size());
2374   } else if (isCast()) {
2375     assert(getOperand(0) == From && "Cast only has one use!");
2376     Replacement = ConstantExpr::getCast(getOpcode(), To, getType());
2377   } else if (getOpcode() == Instruction::Select) {
2378     Constant *C1 = getOperand(0);
2379     Constant *C2 = getOperand(1);
2380     Constant *C3 = getOperand(2);
2381     if (C1 == From) C1 = To;
2382     if (C2 == From) C2 = To;
2383     if (C3 == From) C3 = To;
2384     Replacement = ConstantExpr::getSelect(C1, C2, C3);
2385   } else if (getOpcode() == Instruction::ExtractElement) {
2386     Constant *C1 = getOperand(0);
2387     Constant *C2 = getOperand(1);
2388     if (C1 == From) C1 = To;
2389     if (C2 == From) C2 = To;
2390     Replacement = ConstantExpr::getExtractElement(C1, C2);
2391   } else if (getOpcode() == Instruction::InsertElement) {
2392     Constant *C1 = getOperand(0);
2393     Constant *C2 = getOperand(1);
2394     Constant *C3 = getOperand(1);
2395     if (C1 == From) C1 = To;
2396     if (C2 == From) C2 = To;
2397     if (C3 == From) C3 = To;
2398     Replacement = ConstantExpr::getInsertElement(C1, C2, C3);
2399   } else if (getOpcode() == Instruction::ShuffleVector) {
2400     Constant *C1 = getOperand(0);
2401     Constant *C2 = getOperand(1);
2402     Constant *C3 = getOperand(2);
2403     if (C1 == From) C1 = To;
2404     if (C2 == From) C2 = To;
2405     if (C3 == From) C3 = To;
2406     Replacement = ConstantExpr::getShuffleVector(C1, C2, C3);
2407   } else if (isCompare()) {
2408     Constant *C1 = getOperand(0);
2409     Constant *C2 = getOperand(1);
2410     if (C1 == From) C1 = To;
2411     if (C2 == From) C2 = To;
2412     if (getOpcode() == Instruction::ICmp)
2413       Replacement = ConstantExpr::getICmp(getPredicate(), C1, C2);
2414     else {
2415       assert(getOpcode() == Instruction::FCmp);
2416       Replacement = ConstantExpr::getFCmp(getPredicate(), C1, C2);
2417     }
2418   } else if (getNumOperands() == 2) {
2419     Constant *C1 = getOperand(0);
2420     Constant *C2 = getOperand(1);
2421     if (C1 == From) C1 = To;
2422     if (C2 == From) C2 = To;
2423     Replacement = ConstantExpr::get(getOpcode(), C1, C2);
2424   } else {
2425     llvm_unreachable("Unknown ConstantExpr type!");
2426     return;
2427   }
2428
2429   assert(Replacement != this && "I didn't contain From!");
2430
2431   // Everyone using this now uses the replacement.
2432   uncheckedReplaceAllUsesWith(Replacement);
2433
2434   // Delete the old constant!
2435   destroyConstant();
2436 }
2437