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