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(LLVMContext &Context,
 536                               const std::vector<Constant*>& V, bool packed) {
 537   std::vector<const Type*> StructEls;
 538   StructEls.reserve(V.size());
 539   for (unsigned i = 0, e = V.size(); i != e; ++i)
 540     StructEls.push_back(V[i]->getType());
 541   return get(StructType::get(Context, StructEls, packed), V);
 542 }
 543
 544 Constant* ConstantStruct::get(LLVMContext &Context,
 545                               Constant* const *Vals, unsigned NumVals,
 546                               bool Packed) {
 547   // FIXME: make this the primary ctor method.
 548   return get(Context, std::vector<Constant*>(Vals, Vals+NumVals), Packed);
 549 }
 550
 551 ConstantVector::ConstantVector(const VectorType *T,
 552                                const std::vector<Constant*> &V)
 553   : Constant(T, ConstantVectorVal,
 554              OperandTraits<ConstantVector>::op_end(this) - V.size(),
 555              V.size()) {
 556   Use *OL = OperandList;
 557     for (std::vector<Constant*>::const_iterator I = V.begin(), E = V.end();
 558          I != E; ++I, ++OL) {
 559       Constant *C = *I;
 560       assert((C->getType() == T->getElementType() ||
 561             (T->isAbstract() &&
 562              C->getType()->getTypeID() == T->getElementType()->getTypeID())) &&
 563            "Initializer for vector element doesn't match vector element type!");
 564     *OL = C;
 565   }
 566 }
 567
 568 // ConstantVector accessors.
 569 Constant* ConstantVector::get(const VectorType* T,
 570                               const std::vector<Constant*>& V) {
 571    assert(!V.empty() && "Vectors can't be empty");
 572    LLVMContext &Context = T->getContext();
 573    LLVMContextImpl *pImpl = Context.pImpl;
 574
 575   // If this is an all-undef or alll-zero vector, return a
 576   // ConstantAggregateZero or UndefValue.
 577   Constant *C = V[0];
 578   bool isZero = C->isNullValue();
 579   bool isUndef = isa<UndefValue>(C);
 580
 581   if (isZero || isUndef) {
 582     for (unsigned i = 1, e = V.size(); i != e; ++i)
 583       if (V[i] != C) {
 584         isZero = isUndef = false;
 585         break;
 586       }
 587   }
 588
 589   if (isZero)
 590     return ConstantAggregateZero::get(T);
 591   if (isUndef)
 592     return UndefValue::get(T);
 593
 594   // Implicitly locked.
 595   return pImpl->VectorConstants.getOrCreate(T, V);
 596 }
 597
 598 Constant* ConstantVector::get(const std::vector<Constant*>& V) {
 599   assert(!V.empty() && "Cannot infer type if V is empty");
 600   return get(VectorType::get(V.front()->getType(),V.size()), V);
 601 }
 602
 603 Constant* ConstantVector::get(Constant* const* Vals, unsigned NumVals) {
 604   // FIXME: make this the primary ctor method.
 605   return get(std::vector<Constant*>(Vals, Vals+NumVals));
 606 }
 607
 608 Constant* ConstantExpr::getExactSDiv(Constant* C1, Constant* C2) {
 609   Constant *C = getSDiv(C1, C2);
 610   cast<SDivOperator>(C)->setIsExact(true);
 611   return C;
 612 }
 613
 614 // Utility function for determining if a ConstantExpr is a CastOp or not. This
 615 // can't be inline because we don't want to #include Instruction.h into
 616 // Constant.h
 617 bool ConstantExpr::isCast() const {
 618   return Instruction::isCast(getOpcode());
 619 }
 620
 621 bool ConstantExpr::isCompare() const {
 622   return getOpcode() == Instruction::ICmp || getOpcode() == Instruction::FCmp;
 623 }
 624
 625 bool ConstantExpr::hasIndices() const {
 626   return getOpcode() == Instruction::ExtractValue ||
 627          getOpcode() == Instruction::InsertValue;
 628 }
 629
 630 const SmallVector<unsigned, 4> &ConstantExpr::getIndices() const {
 631   if (const ExtractValueConstantExpr *EVCE =
 632         dyn_cast<ExtractValueConstantExpr>(this))
 633     return EVCE->Indices;
 634
 635   return cast<InsertValueConstantExpr>(this)->Indices;
 636 }
 637
 638 unsigned ConstantExpr::getPredicate() const {
 639   assert(getOpcode() == Instruction::FCmp ||
 640          getOpcode() == Instruction::ICmp);
 641   return ((const CompareConstantExpr*)this)->predicate;
 642 }
 643
 644 /// getWithOperandReplaced - Return a constant expression identical to this
 645 /// one, but with the specified operand set to the specified value.
 646 Constant *
 647 ConstantExpr::getWithOperandReplaced(unsigned OpNo, Constant *Op) const {
 648   assert(OpNo < getNumOperands() && "Operand num is out of range!");
 649   assert(Op->getType() == getOperand(OpNo)->getType() &&
 650          "Replacing operand with value of different type!");
 651   if (getOperand(OpNo) == Op)
 652     return const_cast<ConstantExpr*>(this);
 653
 654   Constant *Op0, *Op1, *Op2;
 655   switch (getOpcode()) {
 656   case Instruction::Trunc:
 657   case Instruction::ZExt:
 658   case Instruction::SExt:
 659   case Instruction::FPTrunc:
 660   case Instruction::FPExt:
 661   case Instruction::UIToFP:
 662   case Instruction::SIToFP:
 663   case Instruction::FPToUI:
 664   case Instruction::FPToSI:
 665   case Instruction::PtrToInt:
 666   case Instruction::IntToPtr:
 667   case Instruction::BitCast:
 668     return ConstantExpr::getCast(getOpcode(), Op, getType());
 669   case Instruction::Select:
 670     Op0 = (OpNo == 0) ? Op : getOperand(0);
 671     Op1 = (OpNo == 1) ? Op : getOperand(1);
 672     Op2 = (OpNo == 2) ? Op : getOperand(2);
 673     return ConstantExpr::getSelect(Op0, Op1, Op2);
 674   case Instruction::InsertElement:
 675     Op0 = (OpNo == 0) ? Op : getOperand(0);
 676     Op1 = (OpNo == 1) ? Op : getOperand(1);
 677     Op2 = (OpNo == 2) ? Op : getOperand(2);
 678     return ConstantExpr::getInsertElement(Op0, Op1, Op2);
 679   case Instruction::ExtractElement:
 680     Op0 = (OpNo == 0) ? Op : getOperand(0);
 681     Op1 = (OpNo == 1) ? Op : getOperand(1);
 682     return ConstantExpr::getExtractElement(Op0, Op1);
 683   case Instruction::ShuffleVector:
 684     Op0 = (OpNo == 0) ? Op : getOperand(0);
 685     Op1 = (OpNo == 1) ? Op : getOperand(1);
 686     Op2 = (OpNo == 2) ? Op : getOperand(2);
 687     return ConstantExpr::getShuffleVector(Op0, Op1, Op2);
 688   case Instruction::GetElementPtr: {
 689     SmallVector<Constant*, 8> Ops;
 690     Ops.resize(getNumOperands()-1);
 691     for (unsigned i = 1, e = getNumOperands(); i != e; ++i)
 692       Ops[i-1] = getOperand(i);
 693     if (OpNo == 0)
 694       return ConstantExpr::getGetElementPtr(Op, &Ops[0], Ops.size());
 695     Ops[OpNo-1] = Op;
 696     return ConstantExpr::getGetElementPtr(getOperand(0), &Ops[0], Ops.size());
 697   }
 698   default:
 699     assert(getNumOperands() == 2 && "Must be binary operator?");
 700     Op0 = (OpNo == 0) ? Op : getOperand(0);
 701     Op1 = (OpNo == 1) ? Op : getOperand(1);
 702     return ConstantExpr::get(getOpcode(), Op0, Op1);
 703   }
 704 }
 705
 706 /// getWithOperands - This returns the current constant expression with the
 707 /// operands replaced with the specified values.  The specified operands must
 708 /// match count and type with the existing ones.
 709 Constant *ConstantExpr::
 710 getWithOperands(Constant* const *Ops, unsigned NumOps) const {
 711   assert(NumOps == getNumOperands() && "Operand count mismatch!");
 712   bool AnyChange = false;
 713   for (unsigned i = 0; i != NumOps; ++i) {
 714     assert(Ops[i]->getType() == getOperand(i)->getType() &&
 715            "Operand type mismatch!");
 716     AnyChange |= Ops[i] != getOperand(i);
 717   }
 718   if (!AnyChange)  // No operands changed, return self.
 719     return const_cast<ConstantExpr*>(this);
 720
 721   switch (getOpcode()) {
 722   case Instruction::Trunc:
 723   case Instruction::ZExt:
 724   case Instruction::SExt:
 725   case Instruction::FPTrunc:
 726   case Instruction::FPExt:
 727   case Instruction::UIToFP:
 728   case Instruction::SIToFP:
 729   case Instruction::FPToUI:
 730   case Instruction::FPToSI:
 731   case Instruction::PtrToInt:
 732   case Instruction::IntToPtr:
 733   case Instruction::BitCast:
 734     return ConstantExpr::getCast(getOpcode(), Ops[0], getType());
 735   case Instruction::Select:
 736     return ConstantExpr::getSelect(Ops[0], Ops[1], Ops[2]);
 737   case Instruction::InsertElement:
 738     return ConstantExpr::getInsertElement(Ops[0], Ops[1], Ops[2]);
 739   case Instruction::ExtractElement:
 740     return ConstantExpr::getExtractElement(Ops[0], Ops[1]);
 741   case Instruction::ShuffleVector:
 742     return ConstantExpr::getShuffleVector(Ops[0], Ops[1], Ops[2]);
 743   case Instruction::GetElementPtr:
 744     return ConstantExpr::getGetElementPtr(Ops[0], &Ops[1], NumOps-1);
 745   case Instruction::ICmp:
 746   case Instruction::FCmp:
 747     return ConstantExpr::getCompare(getPredicate(), Ops[0], Ops[1]);
 748   default:
 749     assert(getNumOperands() == 2 && "Must be binary operator?");
 750     return ConstantExpr::get(getOpcode(), Ops[0], Ops[1]);
 751   }
 752 }
 753
 754
 755 //===----------------------------------------------------------------------===//
 756 //                      isValueValidForType implementations
 757
 758 bool ConstantInt::isValueValidForType(const Type *Ty, uint64_t Val) {
 759   unsigned NumBits = cast<IntegerType>(Ty)->getBitWidth(); // assert okay
 760   if (Ty == Type::Int1Ty)
 761     return Val == 0 || Val == 1;
 762   if (NumBits >= 64)
 763     return true; // always true, has to fit in largest type
 764   uint64_t Max = (1ll << NumBits) - 1;
 765   return Val <= Max;
 766 }
 767
 768 bool ConstantInt::isValueValidForType(const Type *Ty, int64_t Val) {
 769   unsigned NumBits = cast<IntegerType>(Ty)->getBitWidth(); // assert okay
 770   if (Ty == Type::Int1Ty)
 771     return Val == 0 || Val == 1 || Val == -1;
 772   if (NumBits >= 64)
 773     return true; // always true, has to fit in largest type
 774   int64_t Min = -(1ll << (NumBits-1));
 775   int64_t Max = (1ll << (NumBits-1)) - 1;
 776   return (Val >= Min && Val <= Max);
 777 }
 778
 779 bool ConstantFP::isValueValidForType(const Type *Ty, const APFloat& Val) {
 780   // convert modifies in place, so make a copy.
 781   APFloat Val2 = APFloat(Val);
 782   bool losesInfo;
 783   switch (Ty->getTypeID()) {
 784   default:
 785     return false;         // These can't be represented as floating point!
 786
 787   // FIXME rounding mode needs to be more flexible
 788   case Type::FloatTyID: {
 789     if (&Val2.getSemantics() == &APFloat::IEEEsingle)
 790       return true;
 791     Val2.convert(APFloat::IEEEsingle, APFloat::rmNearestTiesToEven, &losesInfo);
 792     return !losesInfo;
 793   }
 794   case Type::DoubleTyID: {
 795     if (&Val2.getSemantics() == &APFloat::IEEEsingle ||
 796         &Val2.getSemantics() == &APFloat::IEEEdouble)
 797       return true;
 798     Val2.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven, &losesInfo);
 799     return !losesInfo;
 800   }
 801   case Type::X86_FP80TyID:
 802     return &Val2.getSemantics() == &APFloat::IEEEsingle ||
 803            &Val2.getSemantics() == &APFloat::IEEEdouble ||
 804            &Val2.getSemantics() == &APFloat::x87DoubleExtended;
 805   case Type::FP128TyID:
 806     return &Val2.getSemantics() == &APFloat::IEEEsingle ||
 807            &Val2.getSemantics() == &APFloat::IEEEdouble ||
 808            &Val2.getSemantics() == &APFloat::IEEEquad;
 809   case Type::PPC_FP128TyID:
 810     return &Val2.getSemantics() == &APFloat::IEEEsingle ||
 811            &Val2.getSemantics() == &APFloat::IEEEdouble ||
 812            &Val2.getSemantics() == &APFloat::PPCDoubleDouble;
 813   }
 814 }
 815
 816 //===----------------------------------------------------------------------===//
 817 //                      Factory Function Implementation
 818
 819 static char getValType(ConstantAggregateZero *CPZ) { return 0; }
 820
 821 ConstantAggregateZero* ConstantAggregateZero::get(const Type* Ty) {
 822   assert((isa<StructType>(Ty) || isa<ArrayType>(Ty) || isa<VectorType>(Ty)) &&
 823          "Cannot create an aggregate zero of non-aggregate type!");
 824
 825   LLVMContextImpl *pImpl = Ty->getContext().pImpl;
 826   // Implicitly locked.
 827   return pImpl->AggZeroConstants.getOrCreate(Ty, 0);
 828 }
 829
 830 /// destroyConstant - Remove the constant from the constant table...
 831 ///
 832 void ConstantAggregateZero::destroyConstant() {
 833   // Implicitly locked.
 834   getType()->getContext().pImpl->AggZeroConstants.remove(this);
 835   destroyConstantImpl();
 836 }
 837
 838 /// destroyConstant - Remove the constant from the constant table...
 839 ///
 840 void ConstantArray::destroyConstant() {
 841   // Implicitly locked.
 842   getType()->getContext().pImpl->ArrayConstants.remove(this);
 843   destroyConstantImpl();
 844 }
 845
 846 /// isString - This method returns true if the array is an array of i8, and
 847 /// if the elements of the array are all ConstantInt's.
 848 bool ConstantArray::isString() const {
 849   // Check the element type for i8...
 850   if (getType()->getElementType() != Type::Int8Ty)
 851     return false;
 852   // Check the elements to make sure they are all integers, not constant
 853   // expressions.
 854   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
 855     if (!isa<ConstantInt>(getOperand(i)))
 856       return false;
 857   return true;
 858 }
 859
 860 /// isCString - This method returns true if the array is a string (see
 861 /// isString) and it ends in a null byte \\0 and does not contains any other
 862 /// null bytes except its terminator.
 863 bool ConstantArray::isCString() const {
 864   // Check the element type for i8...
 865   if (getType()->getElementType() != Type::Int8Ty)
 866     return false;
 867
 868   // Last element must be a null.
 869   if (!getOperand(getNumOperands()-1)->isNullValue())
 870     return false;
 871   // Other elements must be non-null integers.
 872   for (unsigned i = 0, e = getNumOperands()-1; i != e; ++i) {
 873     if (!isa<ConstantInt>(getOperand(i)))
 874       return false;
 875     if (getOperand(i)->isNullValue())
 876       return false;
 877   }
 878   return true;
 879 }
 880
 881
 882 /// getAsString - If the sub-element type of this array is i8
 883 /// then this method converts the array to an std::string and returns it.
 884 /// Otherwise, it asserts out.
 885 ///
 886 std::string ConstantArray::getAsString() const {
 887   assert(isString() && "Not a string!");
 888   std::string Result;
 889   Result.reserve(getNumOperands());
 890   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
 891     Result.push_back((char)cast<ConstantInt>(getOperand(i))->getZExtValue());
 892   return Result;
 893 }
 894
 895
 896 //---- ConstantStruct::get() implementation...
 897 //
 898
 899 namespace llvm {
 900
 901 }
 902
 903 // destroyConstant - Remove the constant from the constant table...
 904 //
 905 void ConstantStruct::destroyConstant() {
 906   // Implicitly locked.
 907   getType()->getContext().pImpl->StructConstants.remove(this);
 908   destroyConstantImpl();
 909 }
 910
 911 // destroyConstant - Remove the constant from the constant table...
 912 //
 913 void ConstantVector::destroyConstant() {
 914   // Implicitly locked.
 915   getType()->getContext().pImpl->VectorConstants.remove(this);
 916   destroyConstantImpl();
 917 }
 918
 919 /// This function will return true iff every element in this vector constant
 920 /// is set to all ones.
 921 /// @returns true iff this constant's emements are all set to all ones.
 922 /// @brief Determine if the value is all ones.
 923 bool ConstantVector::isAllOnesValue() const {
 924   // Check out first element.
 925   const Constant *Elt = getOperand(0);
 926   const ConstantInt *CI = dyn_cast<ConstantInt>(Elt);
 927   if (!CI || !CI->isAllOnesValue()) return false;
 928   // Then make sure all remaining elements point to the same value.
 929   for (unsigned I = 1, E = getNumOperands(); I < E; ++I) {
 930     if (getOperand(I) != Elt) return false;
 931   }
 932   return true;
 933 }
 934
 935 /// getSplatValue - If this is a splat constant, where all of the
 936 /// elements have the same value, return that value. Otherwise return null.
 937 Constant *ConstantVector::getSplatValue() {
 938   // Check out first element.
 939   Constant *Elt = getOperand(0);
 940   // Then make sure all remaining elements point to the same value.
 941   for (unsigned I = 1, E = getNumOperands(); I < E; ++I)
 942     if (getOperand(I) != Elt) return 0;
 943   return Elt;
 944 }
 945
 946 //---- ConstantPointerNull::get() implementation...
 947 //
 948
 949 static char getValType(ConstantPointerNull *) {
 950   return 0;
 951 }
 952
 953
 954 ConstantPointerNull *ConstantPointerNull::get(const PointerType *Ty) {
 955   // Implicitly locked.
 956   return Ty->getContext().pImpl->NullPtrConstants.getOrCreate(Ty, 0);
 957 }
 958
 959 // destroyConstant - Remove the constant from the constant table...
 960 //
 961 void ConstantPointerNull::destroyConstant() {
 962   // Implicitly locked.
 963   getType()->getContext().pImpl->NullPtrConstants.remove(this);
 964   destroyConstantImpl();
 965 }
 966
 967
 968 //---- UndefValue::get() implementation...
 969 //
 970
 971 static char getValType(UndefValue *) {
 972   return 0;
 973 }
 974
 975 UndefValue *UndefValue::get(const Type *Ty) {
 976   // Implicitly locked.
 977   return Ty->getContext().pImpl->UndefValueConstants.getOrCreate(Ty, 0);
 978 }
 979
 980 // destroyConstant - Remove the constant from the constant table.
 981 //
 982 void UndefValue::destroyConstant() {
 983   // Implicitly locked.
 984   getType()->getContext().pImpl->UndefValueConstants.remove(this);
 985   destroyConstantImpl();
 986 }
 987
 988 //---- ConstantExpr::get() implementations...
 989 //
 990
 991 static ExprMapKeyType getValType(ConstantExpr *CE) {
 992   std::vector<Constant*> Operands;
 993   Operands.reserve(CE->getNumOperands());
 994   for (unsigned i = 0, e = CE->getNumOperands(); i != e; ++i)
 995     Operands.push_back(cast<Constant>(CE->getOperand(i)));
 996   return ExprMapKeyType(CE->getOpcode(), Operands,
 997       CE->isCompare() ? CE->getPredicate() : 0,
 998       CE->hasIndices() ?
 999         CE->getIndices() : SmallVector<unsigned, 4>());
1000 }
1001
1002 /// This is a utility function to handle folding of casts and lookup of the
1003 /// cast in the ExprConstants map. It is used by the various get* methods below.
1004 static inline Constant *getFoldedCast(
1005   Instruction::CastOps opc, Constant *C, const Type *Ty) {
1006   assert(Ty->isFirstClassType() && "Cannot cast to an aggregate type!");
1007   // Fold a few common cases
1008   if (Constant *FC = ConstantFoldCastInstruction(Ty->getContext(), opc, C, Ty))
1009     return FC;
1010
1011   LLVMContextImpl *pImpl = Ty->getContext().pImpl;
1012
1013   // Look up the constant in the table first to ensure uniqueness
1014   std::vector<Constant*> argVec(1, C);
1015   ExprMapKeyType Key(opc, argVec);
1016
1017   // Implicitly locked.
1018   return pImpl->ExprConstants.getOrCreate(Ty, Key);
1019 }
1020
1021 Constant *ConstantExpr::getCast(unsigned oc, Constant *C, const Type *Ty) {
1022   Instruction::CastOps opc = Instruction::CastOps(oc);
1023   assert(Instruction::isCast(opc) && "opcode out of range");
1024   assert(C && Ty && "Null arguments to getCast");
1025   assert(Ty->isFirstClassType() && "Cannot cast to an aggregate type!");
1026
1027   switch (opc) {
1028     default:
1029       llvm_unreachable("Invalid cast opcode");
1030       break;
1031     case Instruction::Trunc:    return getTrunc(C, Ty);
1032     case Instruction::ZExt:     return getZExt(C, Ty);
1033     case Instruction::SExt:     return getSExt(C, Ty);
1034     case Instruction::FPTrunc:  return getFPTrunc(C, Ty);
1035     case Instruction::FPExt:    return getFPExtend(C, Ty);
1036     case Instruction::UIToFP:   return getUIToFP(C, Ty);
1037     case Instruction::SIToFP:   return getSIToFP(C, Ty);
1038     case Instruction::FPToUI:   return getFPToUI(C, Ty);
1039     case Instruction::FPToSI:   return getFPToSI(C, Ty);
1040     case Instruction::PtrToInt: return getPtrToInt(C, Ty);
1041     case Instruction::IntToPtr: return getIntToPtr(C, Ty);
1042     case Instruction::BitCast:  return getBitCast(C, Ty);
1043   }
1044   return 0;
1045 }
1046
1047 Constant *ConstantExpr::getZExtOrBitCast(Constant *C, const Type *Ty) {
1048   if (C->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
1049     return getCast(Instruction::BitCast, C, Ty);
1050   return getCast(Instruction::ZExt, C, Ty);
1051 }
1052
1053 Constant *ConstantExpr::getSExtOrBitCast(Constant *C, const Type *Ty) {
1054   if (C->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
1055     return getCast(Instruction::BitCast, C, Ty);
1056   return getCast(Instruction::SExt, C, Ty);
1057 }
1058
1059 Constant *ConstantExpr::getTruncOrBitCast(Constant *C, const Type *Ty) {
1060   if (C->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
1061     return getCast(Instruction::BitCast, C, Ty);
1062   return getCast(Instruction::Trunc, C, Ty);
1063 }
1064
1065 Constant *ConstantExpr::getPointerCast(Constant *S, const Type *Ty) {
1066   assert(isa<PointerType>(S->getType()) && "Invalid cast");
1067   assert((Ty->isInteger() || isa<PointerType>(Ty)) && "Invalid cast");
1068
1069   if (Ty->isInteger())
1070     return getCast(Instruction::PtrToInt, S, Ty);
1071   return getCast(Instruction::BitCast, S, Ty);
1072 }
1073
1074 Constant *ConstantExpr::getIntegerCast(Constant *C, const Type *Ty,
1075                                        bool isSigned) {
1076   assert(C->getType()->isIntOrIntVector() &&
1077          Ty->isIntOrIntVector() && "Invalid cast");
1078   unsigned SrcBits = C->getType()->getScalarSizeInBits();
1079   unsigned DstBits = Ty->getScalarSizeInBits();
1080   Instruction::CastOps opcode =
1081     (SrcBits == DstBits ? Instruction::BitCast :
1082      (SrcBits > DstBits ? Instruction::Trunc :
1083       (isSigned ? Instruction::SExt : Instruction::ZExt)));
1084   return getCast(opcode, C, Ty);
1085 }
1086
1087 Constant *ConstantExpr::getFPCast(Constant *C, const Type *Ty) {
1088   assert(C->getType()->isFPOrFPVector() && Ty->isFPOrFPVector() &&
1089          "Invalid cast");
1090   unsigned SrcBits = C->getType()->getScalarSizeInBits();
1091   unsigned DstBits = Ty->getScalarSizeInBits();
1092   if (SrcBits == DstBits)
1093     return C; // Avoid a useless cast
1094   Instruction::CastOps opcode =
1095      (SrcBits > DstBits ? Instruction::FPTrunc : Instruction::FPExt);
1096   return getCast(opcode, C, Ty);
1097 }
1098
1099 Constant *ConstantExpr::getTrunc(Constant *C, const Type *Ty) {
1100 #ifndef NDEBUG
1101   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1102   bool toVec = Ty->getTypeID() == Type::VectorTyID;
1103 #endif
1104   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1105   assert(C->getType()->isIntOrIntVector() && "Trunc operand must be integer");
1106   assert(Ty->isIntOrIntVector() && "Trunc produces only integral");
1107   assert(C->getType()->getScalarSizeInBits() > Ty->getScalarSizeInBits()&&
1108          "SrcTy must be larger than DestTy for Trunc!");
1109
1110   return getFoldedCast(Instruction::Trunc, C, Ty);
1111 }
1112
1113 Constant *ConstantExpr::getSExt(Constant *C, const Type *Ty) {
1114 #ifndef NDEBUG
1115   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1116   bool toVec = Ty->getTypeID() == Type::VectorTyID;
1117 #endif
1118   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1119   assert(C->getType()->isIntOrIntVector() && "SExt operand must be integral");
1120   assert(Ty->isIntOrIntVector() && "SExt produces only integer");
1121   assert(C->getType()->getScalarSizeInBits() < Ty->getScalarSizeInBits()&&
1122          "SrcTy must be smaller than DestTy for SExt!");
1123
1124   return getFoldedCast(Instruction::SExt, C, Ty);
1125 }
1126
1127 Constant *ConstantExpr::getZExt(Constant *C, const Type *Ty) {
1128 #ifndef NDEBUG
1129   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1130   bool toVec = Ty->getTypeID() == Type::VectorTyID;
1131 #endif
1132   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1133   assert(C->getType()->isIntOrIntVector() && "ZEXt operand must be integral");
1134   assert(Ty->isIntOrIntVector() && "ZExt produces only integer");
1135   assert(C->getType()->getScalarSizeInBits() < Ty->getScalarSizeInBits()&&
1136          "SrcTy must be smaller than DestTy for ZExt!");
1137
1138   return getFoldedCast(Instruction::ZExt, C, Ty);
1139 }
1140
1141 Constant *ConstantExpr::getFPTrunc(Constant *C, const Type *Ty) {
1142 #ifndef NDEBUG
1143   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1144   bool toVec = Ty->getTypeID() == Type::VectorTyID;
1145 #endif
1146   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1147   assert(C->getType()->isFPOrFPVector() && Ty->isFPOrFPVector() &&
1148          C->getType()->getScalarSizeInBits() > Ty->getScalarSizeInBits()&&
1149          "This is an illegal floating point truncation!");
1150   return getFoldedCast(Instruction::FPTrunc, C, Ty);
1151 }
1152
1153 Constant *ConstantExpr::getFPExtend(Constant *C, const Type *Ty) {
1154 #ifndef NDEBUG
1155   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1156   bool toVec = Ty->getTypeID() == Type::VectorTyID;
1157 #endif
1158   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1159   assert(C->getType()->isFPOrFPVector() && Ty->isFPOrFPVector() &&
1160          C->getType()->getScalarSizeInBits() < Ty->getScalarSizeInBits()&&
1161          "This is an illegal floating point extension!");
1162   return getFoldedCast(Instruction::FPExt, C, Ty);
1163 }
1164
1165 Constant *ConstantExpr::getUIToFP(Constant *C, const Type *Ty) {
1166 #ifndef NDEBUG
1167   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1168   bool toVec = Ty->getTypeID() == Type::VectorTyID;
1169 #endif
1170   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1171   assert(C->getType()->isIntOrIntVector() && Ty->isFPOrFPVector() &&
1172          "This is an illegal uint to floating point cast!");
1173   return getFoldedCast(Instruction::UIToFP, C, Ty);
1174 }
1175
1176 Constant *ConstantExpr::getSIToFP(Constant *C, const Type *Ty) {
1177 #ifndef NDEBUG
1178   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1179   bool toVec = Ty->getTypeID() == Type::VectorTyID;
1180 #endif
1181   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1182   assert(C->getType()->isIntOrIntVector() && Ty->isFPOrFPVector() &&
1183          "This is an illegal sint to floating point cast!");
1184   return getFoldedCast(Instruction::SIToFP, C, Ty);
1185 }
1186
1187 Constant *ConstantExpr::getFPToUI(Constant *C, const Type *Ty) {
1188 #ifndef NDEBUG
1189   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1190   bool toVec = Ty->getTypeID() == Type::VectorTyID;
1191 #endif
1192   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1193   assert(C->getType()->isFPOrFPVector() && Ty->isIntOrIntVector() &&
1194          "This is an illegal floating point to uint cast!");
1195   return getFoldedCast(Instruction::FPToUI, C, Ty);
1196 }
1197
1198 Constant *ConstantExpr::getFPToSI(Constant *C, const Type *Ty) {
1199 #ifndef NDEBUG
1200   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1201   bool toVec = Ty->getTypeID() == Type::VectorTyID;
1202 #endif
1203   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1204   assert(C->getType()->isFPOrFPVector() && Ty->isIntOrIntVector() &&
1205          "This is an illegal floating point to sint cast!");
1206   return getFoldedCast(Instruction::FPToSI, C, Ty);
1207 }
1208
1209 Constant *ConstantExpr::getPtrToInt(Constant *C, const Type *DstTy) {
1210   assert(isa<PointerType>(C->getType()) && "PtrToInt source must be pointer");
1211   assert(DstTy->isInteger() && "PtrToInt destination must be integral");
1212   return getFoldedCast(Instruction::PtrToInt, C, DstTy);
1213 }
1214
1215 Constant *ConstantExpr::getIntToPtr(Constant *C, const Type *DstTy) {
1216   assert(C->getType()->isInteger() && "IntToPtr source must be integral");
1217   assert(isa<PointerType>(DstTy) && "IntToPtr destination must be a pointer");
1218   return getFoldedCast(Instruction::IntToPtr, C, DstTy);
1219 }
1220
1221 Constant *ConstantExpr::getBitCast(Constant *C, const Type *DstTy) {
1222   // BitCast implies a no-op cast of type only. No bits change.  However, you
1223   // can't cast pointers to anything but pointers.
1224 #ifndef NDEBUG
1225   const Type *SrcTy = C->getType();
1226   assert((isa<PointerType>(SrcTy) == isa<PointerType>(DstTy)) &&
1227          "BitCast cannot cast pointer to non-pointer and vice versa");
1228
1229   // Now we know we're not dealing with mismatched pointer casts (ptr->nonptr
1230   // or nonptr->ptr). For all the other types, the cast is okay if source and
1231   // destination bit widths are identical.
1232   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
1233   unsigned DstBitSize = DstTy->getPrimitiveSizeInBits();
1234 #endif
1235   assert(SrcBitSize == DstBitSize && "BitCast requires types of same width");
1236
1237   // It is common to ask for a bitcast of a value to its own type, handle this
1238   // speedily.
1239   if (C->getType() == DstTy) return C;
1240
1241   return getFoldedCast(Instruction::BitCast, C, DstTy);
1242 }
1243
1244 Constant *ConstantExpr::getTy(const Type *ReqTy, unsigned Opcode,
1245                               Constant *C1, Constant *C2) {
1246   // Check the operands for consistency first
1247   assert(Opcode >= Instruction::BinaryOpsBegin &&
1248          Opcode <  Instruction::BinaryOpsEnd   &&
1249          "Invalid opcode in binary constant expression");
1250   assert(C1->getType() == C2->getType() &&
1251          "Operand types in binary constant expression should match");
1252
1253   if (ReqTy == C1->getType() || ReqTy == Type::Int1Ty)
1254     if (Constant *FC = ConstantFoldBinaryInstruction(ReqTy->getContext(),
1255                                                      Opcode, C1, C2))
1256       return FC;          // Fold a few common cases...
1257
1258   std::vector<Constant*> argVec(1, C1); argVec.push_back(C2);
1259   ExprMapKeyType Key(Opcode, argVec);
1260
1261   LLVMContextImpl *pImpl = ReqTy->getContext().pImpl;
1262
1263   // Implicitly locked.
1264   return pImpl->ExprConstants.getOrCreate(ReqTy, Key);
1265 }
1266
1267 Constant *ConstantExpr::getCompareTy(unsigned short predicate,
1268                                      Constant *C1, Constant *C2) {
1269   switch (predicate) {
1270     default: llvm_unreachable("Invalid CmpInst predicate");
1271     case CmpInst::FCMP_FALSE: case CmpInst::FCMP_OEQ: case CmpInst::FCMP_OGT:
1272     case CmpInst::FCMP_OGE:   case CmpInst::FCMP_OLT: case CmpInst::FCMP_OLE:
1273     case CmpInst::FCMP_ONE:   case CmpInst::FCMP_ORD: case CmpInst::FCMP_UNO:
1274     case CmpInst::FCMP_UEQ:   case CmpInst::FCMP_UGT: case CmpInst::FCMP_UGE:
1275     case CmpInst::FCMP_ULT:   case CmpInst::FCMP_ULE: case CmpInst::FCMP_UNE:
1276     case CmpInst::FCMP_TRUE:
1277       return getFCmp(predicate, C1, C2);
1278
1279     case CmpInst::ICMP_EQ:  case CmpInst::ICMP_NE:  case CmpInst::ICMP_UGT:
1280     case CmpInst::ICMP_UGE: case CmpInst::ICMP_ULT: case CmpInst::ICMP_ULE:
1281     case CmpInst::ICMP_SGT: case CmpInst::ICMP_SGE: case CmpInst::ICMP_SLT:
1282     case CmpInst::ICMP_SLE:
1283       return getICmp(predicate, C1, C2);
1284   }
1285 }
1286
1287 Constant *ConstantExpr::get(unsigned Opcode, Constant *C1, Constant *C2) {
1288   // API compatibility: Adjust integer opcodes to floating-point opcodes.
1289   if (C1->getType()->isFPOrFPVector()) {
1290     if (Opcode == Instruction::Add) Opcode = Instruction::FAdd;
1291     else if (Opcode == Instruction::Sub) Opcode = Instruction::FSub;
1292     else if (Opcode == Instruction::Mul) Opcode = Instruction::FMul;
1293   }
1294 #ifndef NDEBUG
1295   switch (Opcode) {
1296   case Instruction::Add:
1297   case Instruction::Sub:
1298   case Instruction::Mul:
1299     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1300     assert(C1->getType()->isIntOrIntVector() &&
1301            "Tried to create an integer operation on a non-integer type!");
1302     break;
1303   case Instruction::FAdd:
1304   case Instruction::FSub:
1305   case Instruction::FMul:
1306     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1307     assert(C1->getType()->isFPOrFPVector() &&
1308            "Tried to create a floating-point operation on a "
1309            "non-floating-point type!");
1310     break;
1311   case Instruction::UDiv:
1312   case Instruction::SDiv:
1313     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1314     assert(C1->getType()->isIntOrIntVector() &&
1315            "Tried to create an arithmetic operation on a non-arithmetic type!");
1316     break;
1317   case Instruction::FDiv:
1318     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1319     assert(C1->getType()->isFPOrFPVector() &&
1320            "Tried to create an arithmetic operation on a non-arithmetic type!");
1321     break;
1322   case Instruction::URem:
1323   case Instruction::SRem:
1324     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1325     assert(C1->getType()->isIntOrIntVector() &&
1326            "Tried to create an arithmetic operation on a non-arithmetic type!");
1327     break;
1328   case Instruction::FRem:
1329     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1330     assert(C1->getType()->isFPOrFPVector() &&
1331            "Tried to create an arithmetic operation on a non-arithmetic type!");
1332     break;
1333   case Instruction::And:
1334   case Instruction::Or:
1335   case Instruction::Xor:
1336     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1337     assert(C1->getType()->isIntOrIntVector() &&
1338            "Tried to create a logical operation on a non-integral type!");
1339     break;
1340   case Instruction::Shl:
1341   case Instruction::LShr:
1342   case Instruction::AShr:
1343     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1344     assert(C1->getType()->isIntOrIntVector() &&
1345            "Tried to create a shift operation on a non-integer type!");
1346     break;
1347   default:
1348     break;
1349   }
1350 #endif
1351
1352   return getTy(C1->getType(), Opcode, C1, C2);
1353 }
1354
1355 Constant* ConstantExpr::getSizeOf(const Type* Ty) {
1356   // sizeof is implemented as: (i64) gep (Ty*)null, 1
1357   // Note that a non-inbounds gep is used, as null isn't within any object.
1358   Constant *GEPIdx = ConstantInt::get(Type::Int32Ty, 1);
1359   Constant *GEP = getGetElementPtr(
1360                  Constant::getNullValue(PointerType::getUnqual(Ty)), &GEPIdx, 1);
1361   return getCast(Instruction::PtrToInt, GEP, Type::Int64Ty);
1362 }
1363
1364 Constant* ConstantExpr::getAlignOf(const Type* Ty) {
1365   // alignof is implemented as: (i64) gep ({i8,Ty}*)null, 0, 1
1366   // Note that a non-inbounds gep is used, as null isn't within any object.
1367   const Type *AligningTy = StructType::get(Ty->getContext(),
1368                                            Type::Int8Ty, Ty, NULL);
1369   Constant *NullPtr = Constant::getNullValue(AligningTy->getPointerTo());
1370   Constant *Zero = ConstantInt::get(Type::Int32Ty, 0);
1371   Constant *One = ConstantInt::get(Type::Int32Ty, 1);
1372   Constant *Indices[2] = { Zero, One };
1373   Constant *GEP = getGetElementPtr(NullPtr, Indices, 2);
1374   return getCast(Instruction::PtrToInt, GEP, Type::Int32Ty);
1375 }
1376
1377
1378 Constant *ConstantExpr::getCompare(unsigned short pred,
1379                             Constant *C1, Constant *C2) {
1380   assert(C1->getType() == C2->getType() && "Op types should be identical!");
1381   return getCompareTy(pred, C1, C2);
1382 }
1383
1384 Constant *ConstantExpr::getSelectTy(const Type *ReqTy, Constant *C,
1385                                     Constant *V1, Constant *V2) {
1386   assert(!SelectInst::areInvalidOperands(C, V1, V2)&&"Invalid select operands");
1387
1388   if (ReqTy == V1->getType())
1389     if (Constant *SC = ConstantFoldSelectInstruction(
1390                                                 ReqTy->getContext(), C, V1, V2))
1391       return SC;        // Fold common cases
1392
1393   std::vector<Constant*> argVec(3, C);
1394   argVec[1] = V1;
1395   argVec[2] = V2;
1396   ExprMapKeyType Key(Instruction::Select, argVec);
1397
1398   LLVMContextImpl *pImpl = ReqTy->getContext().pImpl;
1399
1400   // Implicitly locked.
1401   return pImpl->ExprConstants.getOrCreate(ReqTy, Key);
1402 }
1403
1404 Constant *ConstantExpr::getGetElementPtrTy(const Type *ReqTy, Constant *C,
1405                                            Value* const *Idxs,
1406                                            unsigned NumIdx) {
1407   assert(GetElementPtrInst::getIndexedType(C->getType(), Idxs,
1408                                            Idxs+NumIdx) ==
1409          cast<PointerType>(ReqTy)->getElementType() &&
1410          "GEP indices invalid!");
1411
1412   if (Constant *FC = ConstantFoldGetElementPtr(
1413                               ReqTy->getContext(), C, (Constant**)Idxs, NumIdx))
1414     return FC;          // Fold a few common cases...
1415
1416   assert(isa<PointerType>(C->getType()) &&
1417          "Non-pointer type for constant GetElementPtr expression");
1418   // Look up the constant in the table first to ensure uniqueness
1419   std::vector<Constant*> ArgVec;
1420   ArgVec.reserve(NumIdx+1);
1421   ArgVec.push_back(C);
1422   for (unsigned i = 0; i != NumIdx; ++i)
1423     ArgVec.push_back(cast<Constant>(Idxs[i]));
1424   const ExprMapKeyType Key(Instruction::GetElementPtr, ArgVec);
1425
1426   LLVMContextImpl *pImpl = ReqTy->getContext().pImpl;
1427
1428   // Implicitly locked.
1429   return pImpl->ExprConstants.getOrCreate(ReqTy, Key);
1430 }
1431
1432 Constant *ConstantExpr::getGetElementPtr(Constant *C, Value* const *Idxs,
1433                                          unsigned NumIdx) {
1434   // Get the result type of the getelementptr!
1435   const Type *Ty =
1436     GetElementPtrInst::getIndexedType(C->getType(), Idxs, Idxs+NumIdx);
1437   assert(Ty && "GEP indices invalid!");
1438   unsigned As = cast<PointerType>(C->getType())->getAddressSpace();
1439   return getGetElementPtrTy(PointerType::get(Ty, As), C, Idxs, NumIdx);
1440 }
1441
1442 Constant *ConstantExpr::getInBoundsGetElementPtr(Constant *C,
1443                                                  Value* const *Idxs,
1444                                                  unsigned NumIdx) {
1445   Constant *Result = getGetElementPtr(C, Idxs, NumIdx);
1446   // Set in bounds attribute, assuming constant folding didn't eliminate the
1447   // GEP.
1448   if (GEPOperator *GEP = dyn_cast<GEPOperator>(Result))
1449     GEP->setIsInBounds(true);
1450   return Result;
1451 }
1452
1453 Constant *ConstantExpr::getGetElementPtr(Constant *C, Constant* const *Idxs,
1454                                          unsigned NumIdx) {
1455   return getGetElementPtr(C, (Value* const *)Idxs, NumIdx);
1456 }
1457
1458 Constant *ConstantExpr::getInBoundsGetElementPtr(Constant *C,
1459                                                  Constant* const *Idxs,
1460                                                  unsigned NumIdx) {
1461   return getInBoundsGetElementPtr(C, (Value* const *)Idxs, NumIdx);
1462 }
1463
1464 Constant *
1465 ConstantExpr::getICmp(unsigned short pred, Constant* LHS, Constant* RHS) {
1466   assert(LHS->getType() == RHS->getType());
1467   assert(pred >= ICmpInst::FIRST_ICMP_PREDICATE &&
1468          pred <= ICmpInst::LAST_ICMP_PREDICATE && "Invalid ICmp Predicate");
1469
1470   if (Constant *FC = ConstantFoldCompareInstruction(
1471                                              LHS->getContext(), pred, LHS, RHS))
1472     return FC;          // Fold a few common cases...
1473
1474   // Look up the constant in the table first to ensure uniqueness
1475   std::vector<Constant*> ArgVec;
1476   ArgVec.push_back(LHS);
1477   ArgVec.push_back(RHS);
1478   // Get the key type with both the opcode and predicate
1479   const ExprMapKeyType Key(Instruction::ICmp, ArgVec, pred);
1480
1481   LLVMContextImpl *pImpl = LHS->getType()->getContext().pImpl;
1482
1483   // Implicitly locked.
1484   return pImpl->ExprConstants.getOrCreate(Type::Int1Ty, Key);
1485 }
1486
1487 Constant *
1488 ConstantExpr::getFCmp(unsigned short pred, Constant* LHS, Constant* RHS) {
1489   assert(LHS->getType() == RHS->getType());
1490   assert(pred <= FCmpInst::LAST_FCMP_PREDICATE && "Invalid FCmp Predicate");
1491
1492   if (Constant *FC = ConstantFoldCompareInstruction(
1493                                             LHS->getContext(), pred, LHS, RHS))
1494     return FC;          // Fold a few common cases...
1495
1496   // Look up the constant in the table first to ensure uniqueness
1497   std::vector<Constant*> ArgVec;
1498   ArgVec.push_back(LHS);
1499   ArgVec.push_back(RHS);
1500   // Get the key type with both the opcode and predicate
1501   const ExprMapKeyType Key(Instruction::FCmp, ArgVec, pred);
1502
1503   LLVMContextImpl *pImpl = LHS->getType()->getContext().pImpl;
1504
1505   // Implicitly locked.
1506   return pImpl->ExprConstants.getOrCreate(Type::Int1Ty, Key);
1507 }
1508
1509 Constant *ConstantExpr::getExtractElementTy(const Type *ReqTy, Constant *Val,
1510                                             Constant *Idx) {
1511   if (Constant *FC = ConstantFoldExtractElementInstruction(
1512                                                 ReqTy->getContext(), Val, Idx))
1513     return FC;          // Fold a few common cases...
1514   // Look up the constant in the table first to ensure uniqueness
1515   std::vector<Constant*> ArgVec(1, Val);
1516   ArgVec.push_back(Idx);
1517   const ExprMapKeyType Key(Instruction::ExtractElement,ArgVec);
1518
1519   LLVMContextImpl *pImpl = ReqTy->getContext().pImpl;
1520
1521   // Implicitly locked.
1522   return pImpl->ExprConstants.getOrCreate(ReqTy, Key);
1523 }
1524
1525 Constant *ConstantExpr::getExtractElement(Constant *Val, Constant *Idx) {
1526   assert(isa<VectorType>(Val->getType()) &&
1527          "Tried to create extractelement operation on non-vector type!");
1528   assert(Idx->getType() == Type::Int32Ty &&
1529          "Extractelement index must be i32 type!");
1530   return getExtractElementTy(cast<VectorType>(Val->getType())->getElementType(),
1531                              Val, Idx);
1532 }
1533
1534 Constant *ConstantExpr::getInsertElementTy(const Type *ReqTy, Constant *Val,
1535                                            Constant *Elt, Constant *Idx) {
1536   if (Constant *FC = ConstantFoldInsertElementInstruction(
1537                                             ReqTy->getContext(), Val, Elt, Idx))
1538     return FC;          // Fold a few common cases...
1539   // Look up the constant in the table first to ensure uniqueness
1540   std::vector<Constant*> ArgVec(1, Val);
1541   ArgVec.push_back(Elt);
1542   ArgVec.push_back(Idx);
1543   const ExprMapKeyType Key(Instruction::InsertElement,ArgVec);
1544
1545   LLVMContextImpl *pImpl = ReqTy->getContext().pImpl;
1546
1547   // Implicitly locked.
1548   return pImpl->ExprConstants.getOrCreate(ReqTy, Key);
1549 }
1550
1551 Constant *ConstantExpr::getInsertElement(Constant *Val, Constant *Elt,
1552                                          Constant *Idx) {
1553   assert(isa<VectorType>(Val->getType()) &&
1554          "Tried to create insertelement operation on non-vector type!");
1555   assert(Elt->getType() == cast<VectorType>(Val->getType())->getElementType()
1556          && "Insertelement types must match!");
1557   assert(Idx->getType() == Type::Int32Ty &&
1558          "Insertelement index must be i32 type!");
1559   return getInsertElementTy(Val->getType(), Val, Elt, Idx);
1560 }
1561
1562 Constant *ConstantExpr::getShuffleVectorTy(const Type *ReqTy, Constant *V1,
1563                                            Constant *V2, Constant *Mask) {
1564   if (Constant *FC = ConstantFoldShuffleVectorInstruction(
1565                                             ReqTy->getContext(), V1, V2, Mask))
1566     return FC;          // Fold a few common cases...
1567   // Look up the constant in the table first to ensure uniqueness
1568   std::vector<Constant*> ArgVec(1, V1);
1569   ArgVec.push_back(V2);
1570   ArgVec.push_back(Mask);
1571   const ExprMapKeyType Key(Instruction::ShuffleVector,ArgVec);
1572
1573   LLVMContextImpl *pImpl = ReqTy->getContext().pImpl;
1574
1575   // Implicitly locked.
1576   return pImpl->ExprConstants.getOrCreate(ReqTy, Key);
1577 }
1578
1579 Constant *ConstantExpr::getShuffleVector(Constant *V1, Constant *V2,
1580                                          Constant *Mask) {
1581   assert(ShuffleVectorInst::isValidOperands(V1, V2, Mask) &&
1582          "Invalid shuffle vector constant expr operands!");
1583
1584   unsigned NElts = cast<VectorType>(Mask->getType())->getNumElements();
1585   const Type *EltTy = cast<VectorType>(V1->getType())->getElementType();
1586   const Type *ShufTy = VectorType::get(EltTy, NElts);
1587   return getShuffleVectorTy(ShufTy, V1, V2, Mask);
1588 }
1589
1590 Constant *ConstantExpr::getInsertValueTy(const Type *ReqTy, Constant *Agg,
1591                                          Constant *Val,
1592                                         const unsigned *Idxs, unsigned NumIdx) {
1593   assert(ExtractValueInst::getIndexedType(Agg->getType(), Idxs,
1594                                           Idxs+NumIdx) == Val->getType() &&
1595          "insertvalue indices invalid!");
1596   assert(Agg->getType() == ReqTy &&
1597          "insertvalue type invalid!");
1598   assert(Agg->getType()->isFirstClassType() &&
1599          "Non-first-class type for constant InsertValue expression");
1600   Constant *FC = ConstantFoldInsertValueInstruction(
1601                                   ReqTy->getContext(), Agg, Val, Idxs, NumIdx);
1602   assert(FC && "InsertValue constant expr couldn't be folded!");
1603   return FC;
1604 }
1605
1606 Constant *ConstantExpr::getInsertValue(Constant *Agg, Constant *Val,
1607                                      const unsigned *IdxList, unsigned NumIdx) {
1608   assert(Agg->getType()->isFirstClassType() &&
1609          "Tried to create insertelement operation on non-first-class type!");
1610
1611   const Type *ReqTy = Agg->getType();
1612 #ifndef NDEBUG
1613   const Type *ValTy =
1614     ExtractValueInst::getIndexedType(Agg->getType(), IdxList, IdxList+NumIdx);
1615 #endif
1616   assert(ValTy == Val->getType() && "insertvalue indices invalid!");
1617   return getInsertValueTy(ReqTy, Agg, Val, IdxList, NumIdx);
1618 }
1619
1620 Constant *ConstantExpr::getExtractValueTy(const Type *ReqTy, Constant *Agg,
1621                                         const unsigned *Idxs, unsigned NumIdx) {
1622   assert(ExtractValueInst::getIndexedType(Agg->getType(), Idxs,
1623                                           Idxs+NumIdx) == ReqTy &&
1624          "extractvalue indices invalid!");
1625   assert(Agg->getType()->isFirstClassType() &&
1626          "Non-first-class type for constant extractvalue expression");
1627   Constant *FC = ConstantFoldExtractValueInstruction(
1628                                         ReqTy->getContext(), Agg, Idxs, NumIdx);
1629   assert(FC && "ExtractValue constant expr couldn't be folded!");
1630   return FC;
1631 }
1632
1633 Constant *ConstantExpr::getExtractValue(Constant *Agg,
1634                                      const unsigned *IdxList, unsigned NumIdx) {
1635   assert(Agg->getType()->isFirstClassType() &&
1636          "Tried to create extractelement operation on non-first-class type!");
1637
1638   const Type *ReqTy =
1639     ExtractValueInst::getIndexedType(Agg->getType(), IdxList, IdxList+NumIdx);
1640   assert(ReqTy && "extractvalue indices invalid!");
1641   return getExtractValueTy(ReqTy, Agg, IdxList, NumIdx);
1642 }
1643
1644 Constant* ConstantExpr::getNeg(Constant* C) {
1645   // API compatibility: Adjust integer opcodes to floating-point opcodes.
1646   if (C->getType()->isFPOrFPVector())
1647     return getFNeg(C);
1648   assert(C->getType()->isIntOrIntVector() &&
1649          "Cannot NEG a nonintegral value!");
1650   return get(Instruction::Sub,
1651              ConstantFP::getZeroValueForNegation(C->getType()),
1652              C);
1653 }
1654
1655 Constant* ConstantExpr::getFNeg(Constant* C) {
1656   assert(C->getType()->isFPOrFPVector() &&
1657          "Cannot FNEG a non-floating-point value!");
1658   return get(Instruction::FSub,
1659              ConstantFP::getZeroValueForNegation(C->getType()),
1660              C);
1661 }
1662
1663 Constant* ConstantExpr::getNot(Constant* C) {
1664   assert(C->getType()->isIntOrIntVector() &&
1665          "Cannot NOT a nonintegral value!");
1666   return get(Instruction::Xor, C, Constant::getAllOnesValue(C->getType()));
1667 }
1668
1669 Constant* ConstantExpr::getAdd(Constant* C1, Constant* C2) {
1670   return get(Instruction::Add, C1, C2);
1671 }
1672
1673 Constant* ConstantExpr::getFAdd(Constant* C1, Constant* C2) {
1674   return get(Instruction::FAdd, C1, C2);
1675 }
1676
1677 Constant* ConstantExpr::getSub(Constant* C1, Constant* C2) {
1678   return get(Instruction::Sub, C1, C2);
1679 }
1680
1681 Constant* ConstantExpr::getFSub(Constant* C1, Constant* C2) {
1682   return get(Instruction::FSub, C1, C2);
1683 }
1684
1685 Constant* ConstantExpr::getMul(Constant* C1, Constant* C2) {
1686   return get(Instruction::Mul, C1, C2);
1687 }
1688
1689 Constant* ConstantExpr::getFMul(Constant* C1, Constant* C2) {
1690   return get(Instruction::FMul, C1, C2);
1691 }
1692
1693 Constant* ConstantExpr::getUDiv(Constant* C1, Constant* C2) {
1694   return get(Instruction::UDiv, C1, C2);
1695 }
1696
1697 Constant* ConstantExpr::getSDiv(Constant* C1, Constant* C2) {
1698   return get(Instruction::SDiv, C1, C2);
1699 }
1700
1701 Constant* ConstantExpr::getFDiv(Constant* C1, Constant* C2) {
1702   return get(Instruction::FDiv, C1, C2);
1703 }
1704
1705 Constant* ConstantExpr::getURem(Constant* C1, Constant* C2) {
1706   return get(Instruction::URem, C1, C2);
1707 }
1708
1709 Constant* ConstantExpr::getSRem(Constant* C1, Constant* C2) {
1710   return get(Instruction::SRem, C1, C2);
1711 }
1712
1713 Constant* ConstantExpr::getFRem(Constant* C1, Constant* C2) {
1714   return get(Instruction::FRem, C1, C2);
1715 }
1716
1717 Constant* ConstantExpr::getAnd(Constant* C1, Constant* C2) {
1718   return get(Instruction::And, C1, C2);
1719 }
1720
1721 Constant* ConstantExpr::getOr(Constant* C1, Constant* C2) {
1722   return get(Instruction::Or, C1, C2);
1723 }
1724
1725 Constant* ConstantExpr::getXor(Constant* C1, Constant* C2) {
1726   return get(Instruction::Xor, C1, C2);
1727 }
1728
1729 Constant* ConstantExpr::getShl(Constant* C1, Constant* C2) {
1730   return get(Instruction::Shl, C1, C2);
1731 }
1732
1733 Constant* ConstantExpr::getLShr(Constant* C1, Constant* C2) {
1734   return get(Instruction::LShr, C1, C2);
1735 }
1736
1737 Constant* ConstantExpr::getAShr(Constant* C1, Constant* C2) {
1738   return get(Instruction::AShr, C1, C2);
1739 }
1740
1741 // destroyConstant - Remove the constant from the constant table...
1742 //
1743 void ConstantExpr::destroyConstant() {
1744   // Implicitly locked.
1745   LLVMContextImpl *pImpl = getType()->getContext().pImpl;
1746   pImpl->ExprConstants.remove(this);
1747   destroyConstantImpl();
1748 }
1749
1750 const char *ConstantExpr::getOpcodeName() const {
1751   return Instruction::getOpcodeName(getOpcode());
1752 }
1753
1754 //===----------------------------------------------------------------------===//
1755 //                replaceUsesOfWithOnConstant implementations
1756
1757 /// replaceUsesOfWithOnConstant - Update this constant array to change uses of
1758 /// 'From' to be uses of 'To'.  This must update the uniquing data structures
1759 /// etc.
1760 ///
1761 /// Note that we intentionally replace all uses of From with To here.  Consider
1762 /// a large array that uses 'From' 1000 times.  By handling this case all here,
1763 /// ConstantArray::replaceUsesOfWithOnConstant is only invoked once, and that
1764 /// single invocation handles all 1000 uses.  Handling them one at a time would
1765 /// work, but would be really slow because it would have to unique each updated
1766 /// array instance.
1767
1768 static std::vector<Constant*> getValType(ConstantArray *CA) {
1769   std::vector<Constant*> Elements;
1770   Elements.reserve(CA->getNumOperands());
1771   for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
1772     Elements.push_back(cast<Constant>(CA->getOperand(i)));
1773   return Elements;
1774 }
1775
1776
1777 void ConstantArray::replaceUsesOfWithOnConstant(Value *From, Value *To,
1778                                                 Use *U) {
1779   assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
1780   Constant *ToC = cast<Constant>(To);
1781
1782   LLVMContext &Context = getType()->getContext();
1783   LLVMContextImpl *pImpl = Context.pImpl;
1784
1785   std::pair<LLVMContextImpl::ArrayConstantsTy::MapKey, Constant*> Lookup;
1786   Lookup.first.first = getType();
1787   Lookup.second = this;
1788
1789   std::vector<Constant*> &Values = Lookup.first.second;
1790   Values.reserve(getNumOperands());  // Build replacement array.
1791
1792   // Fill values with the modified operands of the constant array.  Also,
1793   // compute whether this turns into an all-zeros array.
1794   bool isAllZeros = false;
1795   unsigned NumUpdated = 0;
1796   if (!ToC->isNullValue()) {
1797     for (Use *O = OperandList, *E = OperandList+getNumOperands(); O != E; ++O) {
1798       Constant *Val = cast<Constant>(O->get());
1799       if (Val == From) {
1800         Val = ToC;
1801         ++NumUpdated;
1802       }
1803       Values.push_back(Val);
1804     }
1805   } else {
1806     isAllZeros = true;
1807     for (Use *O = OperandList, *E = OperandList+getNumOperands();O != E; ++O) {
1808       Constant *Val = cast<Constant>(O->get());
1809       if (Val == From) {
1810         Val = ToC;
1811         ++NumUpdated;
1812       }
1813       Values.push_back(Val);
1814       if (isAllZeros) isAllZeros = Val->isNullValue();
1815     }
1816   }
1817
1818   Constant *Replacement = 0;
1819   if (isAllZeros) {
1820     Replacement = ConstantAggregateZero::get(getType());
1821   } else {
1822     // Check to see if we have this array type already.
1823     sys::SmartScopedWriter<true> Writer(pImpl->ConstantsLock);
1824     bool Exists;
1825     LLVMContextImpl::ArrayConstantsTy::MapTy::iterator I =
1826       pImpl->ArrayConstants.InsertOrGetItem(Lookup, Exists);
1827
1828     if (Exists) {
1829       Replacement = cast<Constant>(I->second);
1830     } else {
1831       // Okay, the new shape doesn't exist in the system yet.  Instead of
1832       // creating a new constant array, inserting it, replaceallusesof'ing the
1833       // old with the new, then deleting the old... just update the current one
1834       // in place!
1835       pImpl->ArrayConstants.MoveConstantToNewSlot(this, I);
1836
1837       // Update to the new value.  Optimize for the case when we have a single
1838       // operand that we're changing, but handle bulk updates efficiently.
1839       if (NumUpdated == 1) {
1840         unsigned OperandToUpdate = U - OperandList;
1841         assert(getOperand(OperandToUpdate) == From &&
1842                "ReplaceAllUsesWith broken!");
1843         setOperand(OperandToUpdate, ToC);
1844       } else {
1845         for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
1846           if (getOperand(i) == From)
1847             setOperand(i, ToC);
1848       }
1849       return;
1850     }
1851   }
1852
1853   // Otherwise, I do need to replace this with an existing value.
1854   assert(Replacement != this && "I didn't contain From!");
1855
1856   // Everyone using this now uses the replacement.
1857   uncheckedReplaceAllUsesWith(Replacement);
1858
1859   // Delete the old constant!
1860   destroyConstant();
1861 }
1862
1863 static std::vector<Constant*> getValType(ConstantStruct *CS) {
1864   std::vector<Constant*> Elements;
1865   Elements.reserve(CS->getNumOperands());
1866   for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i)
1867     Elements.push_back(cast<Constant>(CS->getOperand(i)));
1868   return Elements;
1869 }
1870
1871 void ConstantStruct::replaceUsesOfWithOnConstant(Value *From, Value *To,
1872                                                  Use *U) {
1873   assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
1874   Constant *ToC = cast<Constant>(To);
1875
1876   unsigned OperandToUpdate = U-OperandList;
1877   assert(getOperand(OperandToUpdate) == From && "ReplaceAllUsesWith broken!");
1878
1879   std::pair<LLVMContextImpl::StructConstantsTy::MapKey, Constant*> Lookup;
1880   Lookup.first.first = getType();
1881   Lookup.second = this;
1882   std::vector<Constant*> &Values = Lookup.first.second;
1883   Values.reserve(getNumOperands());  // Build replacement struct.
1884
1885
1886   // Fill values with the modified operands of the constant struct.  Also,
1887   // compute whether this turns into an all-zeros struct.
1888   bool isAllZeros = false;
1889   if (!ToC->isNullValue()) {
1890     for (Use *O = OperandList, *E = OperandList + getNumOperands(); O != E; ++O)
1891       Values.push_back(cast<Constant>(O->get()));
1892   } else {
1893     isAllZeros = true;
1894     for (Use *O = OperandList, *E = OperandList+getNumOperands(); O != E; ++O) {
1895       Constant *Val = cast<Constant>(O->get());
1896       Values.push_back(Val);
1897       if (isAllZeros) isAllZeros = Val->isNullValue();
1898     }
1899   }
1900   Values[OperandToUpdate] = ToC;
1901
1902   LLVMContext &Context = getType()->getContext();
1903   LLVMContextImpl *pImpl = Context.pImpl;
1904
1905   Constant *Replacement = 0;
1906   if (isAllZeros) {
1907     Replacement = ConstantAggregateZero::get(getType());
1908   } else {
1909     // Check to see if we have this array type already.
1910     sys::SmartScopedWriter<true> Writer(pImpl->ConstantsLock);
1911     bool Exists;
1912     LLVMContextImpl::StructConstantsTy::MapTy::iterator I =
1913       pImpl->StructConstants.InsertOrGetItem(Lookup, Exists);
1914
1915     if (Exists) {
1916       Replacement = cast<Constant>(I->second);
1917     } else {
1918       // Okay, the new shape doesn't exist in the system yet.  Instead of
1919       // creating a new constant struct, inserting it, replaceallusesof'ing the
1920       // old with the new, then deleting the old... just update the current one
1921       // in place!
1922       pImpl->StructConstants.MoveConstantToNewSlot(this, I);
1923
1924       // Update to the new value.
1925       setOperand(OperandToUpdate, ToC);
1926       return;
1927     }
1928   }
1929
1930   assert(Replacement != this && "I didn't contain From!");
1931
1932   // Everyone using this now uses the replacement.
1933   uncheckedReplaceAllUsesWith(Replacement);
1934
1935   // Delete the old constant!
1936   destroyConstant();
1937 }
1938
1939 static std::vector<Constant*> getValType(ConstantVector *CP) {
1940   std::vector<Constant*> Elements;
1941   Elements.reserve(CP->getNumOperands());
1942   for (unsigned i = 0, e = CP->getNumOperands(); i != e; ++i)
1943     Elements.push_back(CP->getOperand(i));
1944   return Elements;
1945 }
1946
1947 void ConstantVector::replaceUsesOfWithOnConstant(Value *From, Value *To,
1948                                                  Use *U) {
1949   assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
1950
1951   std::vector<Constant*> Values;
1952   Values.reserve(getNumOperands());  // Build replacement array...
1953   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
1954     Constant *Val = getOperand(i);
1955     if (Val == From) Val = cast<Constant>(To);
1956     Values.push_back(Val);
1957   }
1958
1959   Constant *Replacement = get(getType(), Values);
1960   assert(Replacement != this && "I didn't contain From!");
1961
1962   // Everyone using this now uses the replacement.
1963   uncheckedReplaceAllUsesWith(Replacement);
1964
1965   // Delete the old constant!
1966   destroyConstant();
1967 }
1968
1969 void ConstantExpr::replaceUsesOfWithOnConstant(Value *From, Value *ToV,
1970                                                Use *U) {
1971   assert(isa<Constant>(ToV) && "Cannot make Constant refer to non-constant!");
1972   Constant *To = cast<Constant>(ToV);
1973
1974   Constant *Replacement = 0;
1975   if (getOpcode() == Instruction::GetElementPtr) {
1976     SmallVector<Constant*, 8> Indices;
1977     Constant *Pointer = getOperand(0);
1978     Indices.reserve(getNumOperands()-1);
1979     if (Pointer == From) Pointer = To;
1980
1981     for (unsigned i = 1, e = getNumOperands(); i != e; ++i) {
1982       Constant *Val = getOperand(i);
1983       if (Val == From) Val = To;
1984       Indices.push_back(Val);
1985     }
1986     Replacement = ConstantExpr::getGetElementPtr(Pointer,
1987                                                  &Indices[0], Indices.size());
1988   } else if (getOpcode() == Instruction::ExtractValue) {
1989     Constant *Agg = getOperand(0);
1990     if (Agg == From) Agg = To;
1991
1992     const SmallVector<unsigned, 4> &Indices = getIndices();
1993     Replacement = ConstantExpr::getExtractValue(Agg,
1994                                                 &Indices[0], Indices.size());
1995   } else if (getOpcode() == Instruction::InsertValue) {
1996     Constant *Agg = getOperand(0);
1997     Constant *Val = getOperand(1);
1998     if (Agg == From) Agg = To;
1999     if (Val == From) Val = To;
2000
2001     const SmallVector<unsigned, 4> &Indices = getIndices();
2002     Replacement = ConstantExpr::getInsertValue(Agg, Val,
2003                                                &Indices[0], Indices.size());
2004   } else if (isCast()) {
2005     assert(getOperand(0) == From && "Cast only has one use!");
2006     Replacement = ConstantExpr::getCast(getOpcode(), To, getType());
2007   } else if (getOpcode() == Instruction::Select) {
2008     Constant *C1 = getOperand(0);
2009     Constant *C2 = getOperand(1);
2010     Constant *C3 = getOperand(2);
2011     if (C1 == From) C1 = To;
2012     if (C2 == From) C2 = To;
2013     if (C3 == From) C3 = To;
2014     Replacement = ConstantExpr::getSelect(C1, C2, C3);
2015   } else if (getOpcode() == Instruction::ExtractElement) {
2016     Constant *C1 = getOperand(0);
2017     Constant *C2 = getOperand(1);
2018     if (C1 == From) C1 = To;
2019     if (C2 == From) C2 = To;
2020     Replacement = ConstantExpr::getExtractElement(C1, C2);
2021   } else if (getOpcode() == Instruction::InsertElement) {
2022     Constant *C1 = getOperand(0);
2023     Constant *C2 = getOperand(1);
2024     Constant *C3 = getOperand(1);
2025     if (C1 == From) C1 = To;
2026     if (C2 == From) C2 = To;
2027     if (C3 == From) C3 = To;
2028     Replacement = ConstantExpr::getInsertElement(C1, C2, C3);
2029   } else if (getOpcode() == Instruction::ShuffleVector) {
2030     Constant *C1 = getOperand(0);
2031     Constant *C2 = getOperand(1);
2032     Constant *C3 = getOperand(2);
2033     if (C1 == From) C1 = To;
2034     if (C2 == From) C2 = To;
2035     if (C3 == From) C3 = To;
2036     Replacement = ConstantExpr::getShuffleVector(C1, C2, C3);
2037   } else if (isCompare()) {
2038     Constant *C1 = getOperand(0);
2039     Constant *C2 = getOperand(1);
2040     if (C1 == From) C1 = To;
2041     if (C2 == From) C2 = To;
2042     if (getOpcode() == Instruction::ICmp)
2043       Replacement = ConstantExpr::getICmp(getPredicate(), C1, C2);
2044     else {
2045       assert(getOpcode() == Instruction::FCmp);
2046       Replacement = ConstantExpr::getFCmp(getPredicate(), C1, C2);
2047     }
2048   } else if (getNumOperands() == 2) {
2049     Constant *C1 = getOperand(0);
2050     Constant *C2 = getOperand(1);
2051     if (C1 == From) C1 = To;
2052     if (C2 == From) C2 = To;
2053     Replacement = ConstantExpr::get(getOpcode(), C1, C2);
2054   } else {
2055     llvm_unreachable("Unknown ConstantExpr type!");
2056     return;
2057   }
2058
2059   assert(Replacement != this && "I didn't contain From!");
2060
2061   // Everyone using this now uses the replacement.
2062   uncheckedReplaceAllUsesWith(Replacement);
2063
2064   // Delete the old constant!
2065   destroyConstant();
2066 }
2067