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