lib/VMCore/Constants.cpp

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