lib/VMCore/Constants.cpp

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