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