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