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/MathExtras.h"
  23 #include <algorithm>
  24 #include <iostream>
  25 using namespace llvm;
  26
  27 ConstantBool *ConstantBool::True  = new ConstantBool(true);
  28 ConstantBool *ConstantBool::False = new ConstantBool(false);
  29
  30
  31 //===----------------------------------------------------------------------===//
  32 //                              Constant Class
  33 //===----------------------------------------------------------------------===//
  34
  35 void Constant::destroyConstantImpl() {
  36   // When a Constant is destroyed, there may be lingering
  37   // references to the constant by other constants in the constant pool.  These
  38   // constants are implicitly dependent on the module that is being deleted,
  39   // but they don't know that.  Because we only find out when the CPV is
  40   // deleted, we must now notify all of our users (that should only be
  41   // Constants) that they are, in fact, invalid now and should be deleted.
  42   //
  43   while (!use_empty()) {
  44     Value *V = use_back();
  45 #ifndef NDEBUG      // Only in -g mode...
  46     if (!isa<Constant>(V))
  47       std::cerr << "While deleting: " << *this
  48                 << "\n\nUse still stuck around after Def is destroyed: "
  49                 << *V << "\n\n";
  50 #endif
  51     assert(isa<Constant>(V) && "References remain to Constant being destroyed");
  52     Constant *CV = cast<Constant>(V);
  53     CV->destroyConstant();
  54
  55     // The constant should remove itself from our use list...
  56     assert((use_empty() || use_back() != V) && "Constant not removed!");
  57   }
  58
  59   // Value has no outstanding references it is safe to delete it now...
  60   delete this;
  61 }
  62
  63 // Static constructor to create a '0' constant of arbitrary type...
  64 Constant *Constant::getNullValue(const Type *Ty) {
  65   switch (Ty->getTypeID()) {
  66   case Type::BoolTyID: {
  67     static Constant *NullBool = ConstantBool::get(false);
  68     return NullBool;
  69   }
  70   case Type::SByteTyID: {
  71     static Constant *NullSByte = ConstantSInt::get(Type::SByteTy, 0);
  72     return NullSByte;
  73   }
  74   case Type::UByteTyID: {
  75     static Constant *NullUByte = ConstantUInt::get(Type::UByteTy, 0);
  76     return NullUByte;
  77   }
  78   case Type::ShortTyID: {
  79     static Constant *NullShort = ConstantSInt::get(Type::ShortTy, 0);
  80     return NullShort;
  81   }
  82   case Type::UShortTyID: {
  83     static Constant *NullUShort = ConstantUInt::get(Type::UShortTy, 0);
  84     return NullUShort;
  85   }
  86   case Type::IntTyID: {
  87     static Constant *NullInt = ConstantSInt::get(Type::IntTy, 0);
  88     return NullInt;
  89   }
  90   case Type::UIntTyID: {
  91     static Constant *NullUInt = ConstantUInt::get(Type::UIntTy, 0);
  92     return NullUInt;
  93   }
  94   case Type::LongTyID: {
  95     static Constant *NullLong = ConstantSInt::get(Type::LongTy, 0);
  96     return NullLong;
  97   }
  98   case Type::ULongTyID: {
  99     static Constant *NullULong = ConstantUInt::get(Type::ULongTy, 0);
 100     return NullULong;
 101   }
 102
 103   case Type::FloatTyID: {
 104     static Constant *NullFloat = ConstantFP::get(Type::FloatTy, 0);
 105     return NullFloat;
 106   }
 107   case Type::DoubleTyID: {
 108     static Constant *NullDouble = ConstantFP::get(Type::DoubleTy, 0);
 109     return NullDouble;
 110   }
 111
 112   case Type::PointerTyID:
 113     return ConstantPointerNull::get(cast<PointerType>(Ty));
 114
 115   case Type::StructTyID:
 116   case Type::ArrayTyID:
 117   case Type::PackedTyID:
 118     return ConstantAggregateZero::get(Ty);
 119   default:
 120     // Function, Label, or Opaque type?
 121     assert(!"Cannot create a null constant of that type!");
 122     return 0;
 123   }
 124 }
 125
 126 // Static constructor to create the maximum constant of an integral type...
 127 ConstantIntegral *ConstantIntegral::getMaxValue(const Type *Ty) {
 128   switch (Ty->getTypeID()) {
 129   case Type::BoolTyID:   return ConstantBool::True;
 130   case Type::SByteTyID:
 131   case Type::ShortTyID:
 132   case Type::IntTyID:
 133   case Type::LongTyID: {
 134     // Calculate 011111111111111...
 135     unsigned TypeBits = Ty->getPrimitiveSize()*8;
 136     int64_t Val = INT64_MAX;             // All ones
 137     Val >>= 64-TypeBits;                 // Shift out unwanted 1 bits...
 138     return ConstantSInt::get(Ty, Val);
 139   }
 140
 141   case Type::UByteTyID:
 142   case Type::UShortTyID:
 143   case Type::UIntTyID:
 144   case Type::ULongTyID:  return getAllOnesValue(Ty);
 145
 146   default: return 0;
 147   }
 148 }
 149
 150 // Static constructor to create the minimum constant for an integral type...
 151 ConstantIntegral *ConstantIntegral::getMinValue(const Type *Ty) {
 152   switch (Ty->getTypeID()) {
 153   case Type::BoolTyID:   return ConstantBool::False;
 154   case Type::SByteTyID:
 155   case Type::ShortTyID:
 156   case Type::IntTyID:
 157   case Type::LongTyID: {
 158      // Calculate 1111111111000000000000
 159      unsigned TypeBits = Ty->getPrimitiveSize()*8;
 160      int64_t Val = -1;                    // All ones
 161      Val <<= TypeBits-1;                  // Shift over to the right spot
 162      return ConstantSInt::get(Ty, Val);
 163   }
 164
 165   case Type::UByteTyID:
 166   case Type::UShortTyID:
 167   case Type::UIntTyID:
 168   case Type::ULongTyID:  return ConstantUInt::get(Ty, 0);
 169
 170   default: return 0;
 171   }
 172 }
 173
 174 // Static constructor to create an integral constant with all bits set
 175 ConstantIntegral *ConstantIntegral::getAllOnesValue(const Type *Ty) {
 176   switch (Ty->getTypeID()) {
 177   case Type::BoolTyID:   return ConstantBool::True;
 178   case Type::SByteTyID:
 179   case Type::ShortTyID:
 180   case Type::IntTyID:
 181   case Type::LongTyID:   return ConstantSInt::get(Ty, -1);
 182
 183   case Type::UByteTyID:
 184   case Type::UShortTyID:
 185   case Type::UIntTyID:
 186   case Type::ULongTyID: {
 187     // Calculate ~0 of the right type...
 188     unsigned TypeBits = Ty->getPrimitiveSize()*8;
 189     uint64_t Val = ~0ULL;                // All ones
 190     Val >>= 64-TypeBits;                 // Shift out unwanted 1 bits...
 191     return ConstantUInt::get(Ty, Val);
 192   }
 193   default: return 0;
 194   }
 195 }
 196
 197 bool ConstantUInt::isAllOnesValue() const {
 198   unsigned TypeBits = getType()->getPrimitiveSize()*8;
 199   uint64_t Val = ~0ULL;                // All ones
 200   Val >>= 64-TypeBits;                 // Shift out inappropriate bits
 201   return getValue() == Val;
 202 }
 203
 204
 205 //===----------------------------------------------------------------------===//
 206 //                            ConstantXXX Classes
 207 //===----------------------------------------------------------------------===//
 208
 209 //===----------------------------------------------------------------------===//
 210 //                             Normal Constructors
 211
 212 ConstantIntegral::ConstantIntegral(const Type *Ty, uint64_t V)
 213   : Constant(Ty, SimpleConstantVal, 0, 0) {
 214     Val.Unsigned = V;
 215 }
 216
 217 ConstantBool::ConstantBool(bool V) : ConstantIntegral(Type::BoolTy, V) {
 218 }
 219
 220 ConstantInt::ConstantInt(const Type *Ty, uint64_t V) : ConstantIntegral(Ty, V) {
 221 }
 222
 223 ConstantSInt::ConstantSInt(const Type *Ty, int64_t V) : ConstantInt(Ty, V) {
 224   assert(Ty->isInteger() && Ty->isSigned() &&
 225          "Illegal type for signed integer constant!");
 226   assert(isValueValidForType(Ty, V) && "Value too large for type!");
 227 }
 228
 229 ConstantUInt::ConstantUInt(const Type *Ty, uint64_t V) : ConstantInt(Ty, V) {
 230   assert(Ty->isInteger() && Ty->isUnsigned() &&
 231          "Illegal type for unsigned integer constant!");
 232   assert(isValueValidForType(Ty, V) && "Value too large for type!");
 233 }
 234
 235 ConstantFP::ConstantFP(const Type *Ty, double V)
 236   : Constant(Ty, SimpleConstantVal, 0, 0) {
 237   assert(isValueValidForType(Ty, V) && "Value too large for type!");
 238   Val = V;
 239 }
 240
 241 ConstantArray::ConstantArray(const ArrayType *T,
 242                              const std::vector<Constant*> &V)
 243   : Constant(T, SimpleConstantVal, new Use[V.size()], V.size()) {
 244   assert(V.size() == T->getNumElements() &&
 245          "Invalid initializer vector for constant array");
 246   Use *OL = OperandList;
 247   for (unsigned i = 0, e = V.size(); i != e; ++i) {
 248     assert((V[i]->getType() == T->getElementType() ||
 249             (T->isAbstract() &&
 250              V[i]->getType()->getTypeID()==T->getElementType()->getTypeID())) &&
 251            "Initializer for array element doesn't match array element type!");
 252     OL[i].init(V[i], this);
 253   }
 254 }
 255
 256 ConstantArray::~ConstantArray() {
 257   delete [] OperandList;
 258 }
 259
 260 ConstantStruct::ConstantStruct(const StructType *T,
 261                                const std::vector<Constant*> &V)
 262   : Constant(T, SimpleConstantVal, new Use[V.size()], V.size()) {
 263   assert(V.size() == T->getNumElements() &&
 264          "Invalid initializer vector for constant structure");
 265   Use *OL = OperandList;
 266   for (unsigned i = 0, e = V.size(); i != e; ++i) {
 267     assert((V[i]->getType() == T->getElementType(i) ||
 268             ((T->getElementType(i)->isAbstract() ||
 269               V[i]->getType()->isAbstract()) &&
 270              T->getElementType(i)->getTypeID()==V[i]->getType()->getTypeID()))&&
 271            "Initializer for struct element doesn't match struct element type!");
 272     OL[i].init(V[i], this);
 273   }
 274 }
 275
 276 ConstantStruct::~ConstantStruct() {
 277   delete [] OperandList;
 278 }
 279
 280
 281 ConstantPacked::ConstantPacked(const PackedType *T,
 282                                const std::vector<Constant*> &V)
 283   : Constant(T, SimpleConstantVal, new Use[V.size()], V.size()) {
 284   Use *OL = OperandList;
 285   for (unsigned i = 0, e = V.size(); i != e; ++i) {
 286     assert((V[i]->getType() == T->getElementType() ||
 287             (T->isAbstract() &&
 288              V[i]->getType()->getTypeID()==T->getElementType()->getTypeID())) &&
 289            "Initializer for packed element doesn't match packed element type!");
 290     OL[i].init(V[i], this);
 291   }
 292 }
 293
 294 ConstantPacked::~ConstantPacked() {
 295   delete [] OperandList;
 296 }
 297
 298 /// UnaryConstantExpr - This class is private to Constants.cpp, and is used
 299 /// behind the scenes to implement unary constant exprs.
 300 class UnaryConstantExpr : public ConstantExpr {
 301   Use Op;
 302 public:
 303   UnaryConstantExpr(unsigned Opcode, Constant *C, const Type *Ty)
 304     : ConstantExpr(Ty, Opcode, &Op, 1), Op(C, this) {}
 305 };
 306
 307 static bool isSetCC(unsigned Opcode) {
 308   return Opcode == Instruction::SetEQ || Opcode == Instruction::SetNE ||
 309          Opcode == Instruction::SetLT || Opcode == Instruction::SetGT ||
 310          Opcode == Instruction::SetLE || Opcode == Instruction::SetGE;
 311 }
 312
 313 /// BinaryConstantExpr - This class is private to Constants.cpp, and is used
 314 /// behind the scenes to implement binary constant exprs.
 315 class BinaryConstantExpr : public ConstantExpr {
 316   Use Ops[2];
 317 public:
 318   BinaryConstantExpr(unsigned Opcode, Constant *C1, Constant *C2)
 319     : ConstantExpr(isSetCC(Opcode) ? Type::BoolTy : C1->getType(),
 320                    Opcode, Ops, 2) {
 321     Ops[0].init(C1, this);
 322     Ops[1].init(C2, this);
 323   }
 324 };
 325
 326 /// SelectConstantExpr - This class is private to Constants.cpp, and is used
 327 /// behind the scenes to implement select constant exprs.
 328 class SelectConstantExpr : public ConstantExpr {
 329   Use Ops[3];
 330 public:
 331   SelectConstantExpr(Constant *C1, Constant *C2, Constant *C3)
 332     : ConstantExpr(C2->getType(), Instruction::Select, Ops, 3) {
 333     Ops[0].init(C1, this);
 334     Ops[1].init(C2, this);
 335     Ops[2].init(C3, this);
 336   }
 337 };
 338
 339 /// GetElementPtrConstantExpr - This class is private to Constants.cpp, and is
 340 /// used behind the scenes to implement getelementpr constant exprs.
 341 struct GetElementPtrConstantExpr : public ConstantExpr {
 342   GetElementPtrConstantExpr(Constant *C, const std::vector<Constant*> &IdxList,
 343                             const Type *DestTy)
 344     : ConstantExpr(DestTy, Instruction::GetElementPtr,
 345                    new Use[IdxList.size()+1], IdxList.size()+1) {
 346     OperandList[0].init(C, this);
 347     for (unsigned i = 0, E = IdxList.size(); i != E; ++i)
 348       OperandList[i+1].init(IdxList[i], this);
 349   }
 350   ~GetElementPtrConstantExpr() {
 351     delete [] OperandList;
 352   }
 353 };
 354
 355 /// ConstantExpr::get* - Return some common constants without having to
 356 /// specify the full Instruction::OPCODE identifier.
 357 ///
 358 Constant *ConstantExpr::getNeg(Constant *C) {
 359   if (!C->getType()->isFloatingPoint())
 360     return get(Instruction::Sub, getNullValue(C->getType()), C);
 361   else
 362     return get(Instruction::Sub, ConstantFP::get(C->getType(), -0.0), C);
 363 }
 364 Constant *ConstantExpr::getNot(Constant *C) {
 365   assert(isa<ConstantIntegral>(C) && "Cannot NOT a nonintegral type!");
 366   return get(Instruction::Xor, C,
 367              ConstantIntegral::getAllOnesValue(C->getType()));
 368 }
 369 Constant *ConstantExpr::getAdd(Constant *C1, Constant *C2) {
 370   return get(Instruction::Add, C1, C2);
 371 }
 372 Constant *ConstantExpr::getSub(Constant *C1, Constant *C2) {
 373   return get(Instruction::Sub, C1, C2);
 374 }
 375 Constant *ConstantExpr::getMul(Constant *C1, Constant *C2) {
 376   return get(Instruction::Mul, C1, C2);
 377 }
 378 Constant *ConstantExpr::getDiv(Constant *C1, Constant *C2) {
 379   return get(Instruction::Div, C1, C2);
 380 }
 381 Constant *ConstantExpr::getRem(Constant *C1, Constant *C2) {
 382   return get(Instruction::Rem, C1, C2);
 383 }
 384 Constant *ConstantExpr::getAnd(Constant *C1, Constant *C2) {
 385   return get(Instruction::And, C1, C2);
 386 }
 387 Constant *ConstantExpr::getOr(Constant *C1, Constant *C2) {
 388   return get(Instruction::Or, C1, C2);
 389 }
 390 Constant *ConstantExpr::getXor(Constant *C1, Constant *C2) {
 391   return get(Instruction::Xor, C1, C2);
 392 }
 393 Constant *ConstantExpr::getSetEQ(Constant *C1, Constant *C2) {
 394   return get(Instruction::SetEQ, C1, C2);
 395 }
 396 Constant *ConstantExpr::getSetNE(Constant *C1, Constant *C2) {
 397   return get(Instruction::SetNE, C1, C2);
 398 }
 399 Constant *ConstantExpr::getSetLT(Constant *C1, Constant *C2) {
 400   return get(Instruction::SetLT, C1, C2);
 401 }
 402 Constant *ConstantExpr::getSetGT(Constant *C1, Constant *C2) {
 403   return get(Instruction::SetGT, C1, C2);
 404 }
 405 Constant *ConstantExpr::getSetLE(Constant *C1, Constant *C2) {
 406   return get(Instruction::SetLE, C1, C2);
 407 }
 408 Constant *ConstantExpr::getSetGE(Constant *C1, Constant *C2) {
 409   return get(Instruction::SetGE, C1, C2);
 410 }
 411 Constant *ConstantExpr::getShl(Constant *C1, Constant *C2) {
 412   return get(Instruction::Shl, C1, C2);
 413 }
 414 Constant *ConstantExpr::getShr(Constant *C1, Constant *C2) {
 415   return get(Instruction::Shr, C1, C2);
 416 }
 417
 418 Constant *ConstantExpr::getUShr(Constant *C1, Constant *C2) {
 419   if (C1->getType()->isUnsigned()) return getShr(C1, C2);
 420   return getCast(getShr(getCast(C1,
 421                     C1->getType()->getUnsignedVersion()), C2), C1->getType());
 422 }
 423
 424 Constant *ConstantExpr::getSShr(Constant *C1, Constant *C2) {
 425   if (C1->getType()->isSigned()) return getShr(C1, C2);
 426   return getCast(getShr(getCast(C1,
 427                         C1->getType()->getSignedVersion()), C2), C1->getType());
 428 }
 429
 430
 431 //===----------------------------------------------------------------------===//
 432 //                      isValueValidForType implementations
 433
 434 bool ConstantSInt::isValueValidForType(const Type *Ty, int64_t Val) {
 435   switch (Ty->getTypeID()) {
 436   default:
 437     return false;         // These can't be represented as integers!!!
 438     // Signed types...
 439   case Type::SByteTyID:
 440     return (Val <= INT8_MAX && Val >= INT8_MIN);
 441   case Type::ShortTyID:
 442     return (Val <= INT16_MAX && Val >= INT16_MIN);
 443   case Type::IntTyID:
 444     return (Val <= int(INT32_MAX) && Val >= int(INT32_MIN));
 445   case Type::LongTyID:
 446     return true;          // This is the largest type...
 447   }
 448 }
 449
 450 bool ConstantUInt::isValueValidForType(const Type *Ty, uint64_t Val) {
 451   switch (Ty->getTypeID()) {
 452   default:
 453     return false;         // These can't be represented as integers!!!
 454
 455     // Unsigned types...
 456   case Type::UByteTyID:
 457     return (Val <= UINT8_MAX);
 458   case Type::UShortTyID:
 459     return (Val <= UINT16_MAX);
 460   case Type::UIntTyID:
 461     return (Val <= UINT32_MAX);
 462   case Type::ULongTyID:
 463     return true;          // This is the largest type...
 464   }
 465 }
 466
 467 bool ConstantFP::isValueValidForType(const Type *Ty, double Val) {
 468   switch (Ty->getTypeID()) {
 469   default:
 470     return false;         // These can't be represented as floating point!
 471
 472     // TODO: Figure out how to test if a double can be cast to a float!
 473   case Type::FloatTyID:
 474   case Type::DoubleTyID:
 475     return true;          // This is the largest type...
 476   }
 477 };
 478
 479 //===----------------------------------------------------------------------===//
 480 //                replaceUsesOfWithOnConstant implementations
 481
 482 void ConstantArray::replaceUsesOfWithOnConstant(Value *From, Value *To,
 483                                                 bool DisableChecking) {
 484   assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
 485
 486   std::vector<Constant*> Values;
 487   Values.reserve(getNumOperands());  // Build replacement array...
 488   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
 489     Constant *Val = getOperand(i);
 490     if (Val == From) Val = cast<Constant>(To);
 491     Values.push_back(Val);
 492   }
 493
 494   Constant *Replacement = ConstantArray::get(getType(), Values);
 495   assert(Replacement != this && "I didn't contain From!");
 496
 497   // Everyone using this now uses the replacement...
 498   if (DisableChecking)
 499     uncheckedReplaceAllUsesWith(Replacement);
 500   else
 501     replaceAllUsesWith(Replacement);
 502
 503   // Delete the old constant!
 504   destroyConstant();
 505 }
 506
 507 void ConstantStruct::replaceUsesOfWithOnConstant(Value *From, Value *To,
 508                                                  bool DisableChecking) {
 509   assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
 510
 511   std::vector<Constant*> Values;
 512   Values.reserve(getNumOperands());  // Build replacement array...
 513   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
 514     Constant *Val = getOperand(i);
 515     if (Val == From) Val = cast<Constant>(To);
 516     Values.push_back(Val);
 517   }
 518
 519   Constant *Replacement = ConstantStruct::get(getType(), Values);
 520   assert(Replacement != this && "I didn't contain From!");
 521
 522   // Everyone using this now uses the replacement...
 523   if (DisableChecking)
 524     uncheckedReplaceAllUsesWith(Replacement);
 525   else
 526     replaceAllUsesWith(Replacement);
 527
 528   // Delete the old constant!
 529   destroyConstant();
 530 }
 531
 532 void ConstantPacked::replaceUsesOfWithOnConstant(Value *From, Value *To,
 533                                                  bool DisableChecking) {
 534   assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
 535
 536   std::vector<Constant*> Values;
 537   Values.reserve(getNumOperands());  // Build replacement array...
 538   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
 539     Constant *Val = getOperand(i);
 540     if (Val == From) Val = cast<Constant>(To);
 541     Values.push_back(Val);
 542   }
 543
 544   Constant *Replacement = ConstantPacked::get(getType(), Values);
 545   assert(Replacement != this && "I didn't contain From!");
 546
 547   // Everyone using this now uses the replacement...
 548   if (DisableChecking)
 549     uncheckedReplaceAllUsesWith(Replacement);
 550   else
 551     replaceAllUsesWith(Replacement);
 552
 553   // Delete the old constant!
 554   destroyConstant();
 555 }
 556
 557 void ConstantExpr::replaceUsesOfWithOnConstant(Value *From, Value *ToV,
 558                                                bool DisableChecking) {
 559   assert(isa<Constant>(ToV) && "Cannot make Constant refer to non-constant!");
 560   Constant *To = cast<Constant>(ToV);
 561
 562   Constant *Replacement = 0;
 563   if (getOpcode() == Instruction::GetElementPtr) {
 564     std::vector<Constant*> Indices;
 565     Constant *Pointer = getOperand(0);
 566     Indices.reserve(getNumOperands()-1);
 567     if (Pointer == From) Pointer = To;
 568
 569     for (unsigned i = 1, e = getNumOperands(); i != e; ++i) {
 570       Constant *Val = getOperand(i);
 571       if (Val == From) Val = To;
 572       Indices.push_back(Val);
 573     }
 574     Replacement = ConstantExpr::getGetElementPtr(Pointer, Indices);
 575   } else if (getOpcode() == Instruction::Cast) {
 576     assert(getOperand(0) == From && "Cast only has one use!");
 577     Replacement = ConstantExpr::getCast(To, getType());
 578   } else if (getOpcode() == Instruction::Select) {
 579     Constant *C1 = getOperand(0);
 580     Constant *C2 = getOperand(1);
 581     Constant *C3 = getOperand(2);
 582     if (C1 == From) C1 = To;
 583     if (C2 == From) C2 = To;
 584     if (C3 == From) C3 = To;
 585     Replacement = ConstantExpr::getSelect(C1, C2, C3);
 586   } else if (getNumOperands() == 2) {
 587     Constant *C1 = getOperand(0);
 588     Constant *C2 = getOperand(1);
 589     if (C1 == From) C1 = To;
 590     if (C2 == From) C2 = To;
 591     Replacement = ConstantExpr::get(getOpcode(), C1, C2);
 592   } else {
 593     assert(0 && "Unknown ConstantExpr type!");
 594     return;
 595   }
 596
 597   assert(Replacement != this && "I didn't contain From!");
 598
 599   // Everyone using this now uses the replacement...
 600   if (DisableChecking)
 601     uncheckedReplaceAllUsesWith(Replacement);
 602   else
 603     replaceAllUsesWith(Replacement);
 604
 605   // Delete the old constant!
 606   destroyConstant();
 607 }
 608
 609 //===----------------------------------------------------------------------===//
 610 //                      Factory Function Implementation
 611
 612 // ConstantCreator - A class that is used to create constants by
 613 // ValueMap*.  This class should be partially specialized if there is
 614 // something strange that needs to be done to interface to the ctor for the
 615 // constant.
 616 //
 617 namespace llvm {
 618   template<class ConstantClass, class TypeClass, class ValType>
 619   struct ConstantCreator {
 620     static ConstantClass *create(const TypeClass *Ty, const ValType &V) {
 621       return new ConstantClass(Ty, V);
 622     }
 623   };
 624
 625   template<class ConstantClass, class TypeClass>
 626   struct ConvertConstantType {
 627     static void convert(ConstantClass *OldC, const TypeClass *NewTy) {
 628       assert(0 && "This type cannot be converted!\n");
 629       abort();
 630     }
 631   };
 632 }
 633
 634 namespace {
 635   template<class ValType, class TypeClass, class ConstantClass>
 636   class ValueMap : public AbstractTypeUser {
 637     typedef std::pair<const TypeClass*, ValType> MapKey;
 638     typedef std::map<MapKey, ConstantClass *> MapTy;
 639     typedef typename MapTy::iterator MapIterator;
 640     MapTy Map;
 641
 642     typedef std::map<const TypeClass*, MapIterator> AbstractTypeMapTy;
 643     AbstractTypeMapTy AbstractTypeMap;
 644
 645     friend void Constant::clearAllValueMaps();
 646   private:
 647     void clear(std::vector<Constant *> &Constants) {
 648       for(MapIterator I = Map.begin(); I != Map.end(); ++I)
 649         Constants.push_back(I->second);
 650       Map.clear();
 651       AbstractTypeMap.clear();
 652     }
 653
 654   public:
 655     // getOrCreate - Return the specified constant from the map, creating it if
 656     // necessary.
 657     ConstantClass *getOrCreate(const TypeClass *Ty, const ValType &V) {
 658       MapKey Lookup(Ty, V);
 659       MapIterator I = Map.lower_bound(Lookup);
 660       if (I != Map.end() && I->first == Lookup)
 661         return I->second;  // Is it in the map?
 662
 663       // If no preexisting value, create one now...
 664       ConstantClass *Result =
 665         ConstantCreator<ConstantClass,TypeClass,ValType>::create(Ty, V);
 666
 667
 668       /// FIXME: why does this assert fail when loading 176.gcc?
 669       //assert(Result->getType() == Ty && "Type specified is not correct!");
 670       I = Map.insert(I, std::make_pair(MapKey(Ty, V), Result));
 671
 672       // If the type of the constant is abstract, make sure that an entry exists
 673       // for it in the AbstractTypeMap.
 674       if (Ty->isAbstract()) {
 675         typename AbstractTypeMapTy::iterator TI =
 676           AbstractTypeMap.lower_bound(Ty);
 677
 678         if (TI == AbstractTypeMap.end() || TI->first != Ty) {
 679           // Add ourselves to the ATU list of the type.
 680           cast<DerivedType>(Ty)->addAbstractTypeUser(this);
 681
 682           AbstractTypeMap.insert(TI, std::make_pair(Ty, I));
 683         }
 684       }
 685       return Result;
 686     }
 687
 688     void remove(ConstantClass *CP) {
 689       MapIterator I = Map.find(MapKey((TypeClass*)CP->getRawType(),
 690                                       getValType(CP)));
 691       if (I == Map.end() || I->second != CP) {
 692         // FIXME: This should not use a linear scan.  If this gets to be a
 693         // performance problem, someone should look at this.
 694         for (I = Map.begin(); I != Map.end() && I->second != CP; ++I)
 695           /* empty */;
 696       }
 697
 698       assert(I != Map.end() && "Constant not found in constant table!");
 699       assert(I->second == CP && "Didn't find correct element?");
 700
 701       // Now that we found the entry, make sure this isn't the entry that
 702       // the AbstractTypeMap points to.
 703       const TypeClass *Ty = I->first.first;
 704       if (Ty->isAbstract()) {
 705         assert(AbstractTypeMap.count(Ty) &&
 706                "Abstract type not in AbstractTypeMap?");
 707         MapIterator &ATMEntryIt = AbstractTypeMap[Ty];
 708         if (ATMEntryIt == I) {
 709           // Yes, we are removing the representative entry for this type.
 710           // See if there are any other entries of the same type.
 711           MapIterator TmpIt = ATMEntryIt;
 712
 713           // First check the entry before this one...
 714           if (TmpIt != Map.begin()) {
 715             --TmpIt;
 716             if (TmpIt->first.first != Ty) // Not the same type, move back...
 717               ++TmpIt;
 718           }
 719
 720           // If we didn't find the same type, try to move forward...
 721           if (TmpIt == ATMEntryIt) {
 722             ++TmpIt;
 723             if (TmpIt == Map.end() || TmpIt->first.first != Ty)
 724               --TmpIt;   // No entry afterwards with the same type
 725           }
 726
 727           // If there is another entry in the map of the same abstract type,
 728           // update the AbstractTypeMap entry now.
 729           if (TmpIt != ATMEntryIt) {
 730             ATMEntryIt = TmpIt;
 731           } else {
 732             // Otherwise, we are removing the last instance of this type
 733             // from the table.  Remove from the ATM, and from user list.
 734             cast<DerivedType>(Ty)->removeAbstractTypeUser(this);
 735             AbstractTypeMap.erase(Ty);
 736           }
 737         }
 738       }
 739
 740       Map.erase(I);
 741     }
 742
 743     void refineAbstractType(const DerivedType *OldTy, const Type *NewTy) {
 744       typename AbstractTypeMapTy::iterator I =
 745         AbstractTypeMap.find(cast<TypeClass>(OldTy));
 746
 747       assert(I != AbstractTypeMap.end() &&
 748              "Abstract type not in AbstractTypeMap?");
 749
 750       // Convert a constant at a time until the last one is gone.  The last one
 751       // leaving will remove() itself, causing the AbstractTypeMapEntry to be
 752       // eliminated eventually.
 753       do {
 754         ConvertConstantType<ConstantClass,
 755                             TypeClass>::convert(I->second->second,
 756                                                 cast<TypeClass>(NewTy));
 757
 758         I = AbstractTypeMap.find(cast<TypeClass>(OldTy));
 759       } while (I != AbstractTypeMap.end());
 760     }
 761
 762     // If the type became concrete without being refined to any other existing
 763     // type, we just remove ourselves from the ATU list.
 764     void typeBecameConcrete(const DerivedType *AbsTy) {
 765       AbsTy->removeAbstractTypeUser(this);
 766     }
 767
 768     void dump() const {
 769       std::cerr << "Constant.cpp: ValueMap\n";
 770     }
 771   };
 772 }
 773
 774 //---- ConstantUInt::get() and ConstantSInt::get() implementations...
 775 //
 776 static ValueMap< int64_t, Type, ConstantSInt> SIntConstants;
 777 static ValueMap<uint64_t, Type, ConstantUInt> UIntConstants;
 778
 779 ConstantSInt *ConstantSInt::get(const Type *Ty, int64_t V) {
 780   return SIntConstants.getOrCreate(Ty, V);
 781 }
 782
 783 ConstantUInt *ConstantUInt::get(const Type *Ty, uint64_t V) {
 784   return UIntConstants.getOrCreate(Ty, V);
 785 }
 786
 787 ConstantInt *ConstantInt::get(const Type *Ty, unsigned char V) {
 788   assert(V <= 127 && "Can only be used with very small positive constants!");
 789   if (Ty->isSigned()) return ConstantSInt::get(Ty, V);
 790   return ConstantUInt::get(Ty, V);
 791 }
 792
 793 //---- ConstantFP::get() implementation...
 794 //
 795 namespace llvm {
 796   template<>
 797   struct ConstantCreator<ConstantFP, Type, uint64_t> {
 798     static ConstantFP *create(const Type *Ty, uint64_t V) {
 799       assert(Ty == Type::DoubleTy);
 800       return new ConstantFP(Ty, BitsToDouble(V));
 801     }
 802   };
 803   template<>
 804   struct ConstantCreator<ConstantFP, Type, uint32_t> {
 805     static ConstantFP *create(const Type *Ty, uint32_t V) {
 806       assert(Ty == Type::FloatTy);
 807       return new ConstantFP(Ty, BitsToFloat(V));
 808     }
 809   };
 810 }
 811
 812 static ValueMap<uint64_t, Type, ConstantFP> DoubleConstants;
 813 static ValueMap<uint32_t, Type, ConstantFP> FloatConstants;
 814
 815 ConstantFP *ConstantFP::get(const Type *Ty, double V) {
 816   if (Ty == Type::FloatTy) {
 817     // Force the value through memory to normalize it.
 818     return FloatConstants.getOrCreate(Ty, FloatToBits(V));
 819   } else {
 820     assert(Ty == Type::DoubleTy);
 821     return DoubleConstants.getOrCreate(Ty, DoubleToBits(V));
 822   }
 823 }
 824
 825 //---- ConstantAggregateZero::get() implementation...
 826 //
 827 namespace llvm {
 828   // ConstantAggregateZero does not take extra "value" argument...
 829   template<class ValType>
 830   struct ConstantCreator<ConstantAggregateZero, Type, ValType> {
 831     static ConstantAggregateZero *create(const Type *Ty, const ValType &V){
 832       return new ConstantAggregateZero(Ty);
 833     }
 834   };
 835
 836   template<>
 837   struct ConvertConstantType<ConstantAggregateZero, Type> {
 838     static void convert(ConstantAggregateZero *OldC, const Type *NewTy) {
 839       // Make everyone now use a constant of the new type...
 840       Constant *New = ConstantAggregateZero::get(NewTy);
 841       assert(New != OldC && "Didn't replace constant??");
 842       OldC->uncheckedReplaceAllUsesWith(New);
 843       OldC->destroyConstant();     // This constant is now dead, destroy it.
 844     }
 845   };
 846 }
 847
 848 static ValueMap<char, Type, ConstantAggregateZero> AggZeroConstants;
 849
 850 static char getValType(ConstantAggregateZero *CPZ) { return 0; }
 851
 852 Constant *ConstantAggregateZero::get(const Type *Ty) {
 853   return AggZeroConstants.getOrCreate(Ty, 0);
 854 }
 855
 856 // destroyConstant - Remove the constant from the constant table...
 857 //
 858 void ConstantAggregateZero::destroyConstant() {
 859   AggZeroConstants.remove(this);
 860   destroyConstantImpl();
 861 }
 862
 863 void ConstantAggregateZero::replaceUsesOfWithOnConstant(Value *From, Value *To,
 864                                                         bool DisableChecking) {
 865   assert(0 && "No uses!");
 866   abort();
 867 }
 868
 869
 870
 871 //---- ConstantArray::get() implementation...
 872 //
 873 namespace llvm {
 874   template<>
 875   struct ConvertConstantType<ConstantArray, ArrayType> {
 876     static void convert(ConstantArray *OldC, const ArrayType *NewTy) {
 877       // Make everyone now use a constant of the new type...
 878       std::vector<Constant*> C;
 879       for (unsigned i = 0, e = OldC->getNumOperands(); i != e; ++i)
 880         C.push_back(cast<Constant>(OldC->getOperand(i)));
 881       Constant *New = ConstantArray::get(NewTy, C);
 882       assert(New != OldC && "Didn't replace constant??");
 883       OldC->uncheckedReplaceAllUsesWith(New);
 884       OldC->destroyConstant();    // This constant is now dead, destroy it.
 885     }
 886   };
 887 }
 888
 889 static std::vector<Constant*> getValType(ConstantArray *CA) {
 890   std::vector<Constant*> Elements;
 891   Elements.reserve(CA->getNumOperands());
 892   for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
 893     Elements.push_back(cast<Constant>(CA->getOperand(i)));
 894   return Elements;
 895 }
 896
 897 static ValueMap<std::vector<Constant*>, ArrayType,
 898                 ConstantArray> ArrayConstants;
 899
 900 Constant *ConstantArray::get(const ArrayType *Ty,
 901                              const std::vector<Constant*> &V) {
 902   // If this is an all-zero array, return a ConstantAggregateZero object
 903   if (!V.empty()) {
 904     Constant *C = V[0];
 905     if (!C->isNullValue())
 906       return ArrayConstants.getOrCreate(Ty, V);
 907     for (unsigned i = 1, e = V.size(); i != e; ++i)
 908       if (V[i] != C)
 909         return ArrayConstants.getOrCreate(Ty, V);
 910   }
 911   return ConstantAggregateZero::get(Ty);
 912 }
 913
 914 // destroyConstant - Remove the constant from the constant table...
 915 //
 916 void ConstantArray::destroyConstant() {
 917   ArrayConstants.remove(this);
 918   destroyConstantImpl();
 919 }
 920
 921 // ConstantArray::get(const string&) - Return an array that is initialized to
 922 // contain the specified string.  A null terminator is added to the specified
 923 // string so that it may be used in a natural way...
 924 //
 925 Constant *ConstantArray::get(const std::string &Str) {
 926   std::vector<Constant*> ElementVals;
 927
 928   for (unsigned i = 0; i < Str.length(); ++i)
 929     ElementVals.push_back(ConstantSInt::get(Type::SByteTy, Str[i]));
 930
 931   // Add a null terminator to the string...
 932   ElementVals.push_back(ConstantSInt::get(Type::SByteTy, 0));
 933
 934   ArrayType *ATy = ArrayType::get(Type::SByteTy, Str.length()+1);
 935   return ConstantArray::get(ATy, ElementVals);
 936 }
 937
 938 /// isString - This method returns true if the array is an array of sbyte or
 939 /// ubyte, and if the elements of the array are all ConstantInt's.
 940 bool ConstantArray::isString() const {
 941   // Check the element type for sbyte or ubyte...
 942   if (getType()->getElementType() != Type::UByteTy &&
 943       getType()->getElementType() != Type::SByteTy)
 944     return false;
 945   // Check the elements to make sure they are all integers, not constant
 946   // expressions.
 947   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
 948     if (!isa<ConstantInt>(getOperand(i)))
 949       return false;
 950   return true;
 951 }
 952
 953 // getAsString - If the sub-element type of this array is either sbyte or ubyte,
 954 // then this method converts the array to an std::string and returns it.
 955 // Otherwise, it asserts out.
 956 //
 957 std::string ConstantArray::getAsString() const {
 958   assert(isString() && "Not a string!");
 959   std::string Result;
 960   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
 961     Result += (char)cast<ConstantInt>(getOperand(i))->getRawValue();
 962   return Result;
 963 }
 964
 965
 966 //---- ConstantStruct::get() implementation...
 967 //
 968
 969 namespace llvm {
 970   template<>
 971   struct ConvertConstantType<ConstantStruct, StructType> {
 972     static void convert(ConstantStruct *OldC, const StructType *NewTy) {
 973       // Make everyone now use a constant of the new type...
 974       std::vector<Constant*> C;
 975       for (unsigned i = 0, e = OldC->getNumOperands(); i != e; ++i)
 976         C.push_back(cast<Constant>(OldC->getOperand(i)));
 977       Constant *New = ConstantStruct::get(NewTy, C);
 978       assert(New != OldC && "Didn't replace constant??");
 979
 980       OldC->uncheckedReplaceAllUsesWith(New);
 981       OldC->destroyConstant();    // This constant is now dead, destroy it.
 982     }
 983   };
 984 }
 985
 986 static ValueMap<std::vector<Constant*>, StructType,
 987                 ConstantStruct> StructConstants;
 988
 989 static std::vector<Constant*> getValType(ConstantStruct *CS) {
 990   std::vector<Constant*> Elements;
 991   Elements.reserve(CS->getNumOperands());
 992   for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i)
 993     Elements.push_back(cast<Constant>(CS->getOperand(i)));
 994   return Elements;
 995 }
 996
 997 Constant *ConstantStruct::get(const StructType *Ty,
 998                               const std::vector<Constant*> &V) {
 999   // Create a ConstantAggregateZero value if all elements are zeros...
1000   for (unsigned i = 0, e = V.size(); i != e; ++i)
1001     if (!V[i]->isNullValue())
1002       return StructConstants.getOrCreate(Ty, V);
1003
1004   return ConstantAggregateZero::get(Ty);
1005 }
1006
1007 Constant *ConstantStruct::get(const std::vector<Constant*> &V) {
1008   std::vector<const Type*> StructEls;
1009   StructEls.reserve(V.size());
1010   for (unsigned i = 0, e = V.size(); i != e; ++i)
1011     StructEls.push_back(V[i]->getType());
1012   return get(StructType::get(StructEls), V);
1013 }
1014
1015 // destroyConstant - Remove the constant from the constant table...
1016 //
1017 void ConstantStruct::destroyConstant() {
1018   StructConstants.remove(this);
1019   destroyConstantImpl();
1020 }
1021
1022 //---- ConstantPacked::get() implementation...
1023 //
1024 namespace llvm {
1025   template<>
1026   struct ConvertConstantType<ConstantPacked, PackedType> {
1027     static void convert(ConstantPacked *OldC, const PackedType *NewTy) {
1028       // Make everyone now use a constant of the new type...
1029       std::vector<Constant*> C;
1030       for (unsigned i = 0, e = OldC->getNumOperands(); i != e; ++i)
1031         C.push_back(cast<Constant>(OldC->getOperand(i)));
1032       Constant *New = ConstantPacked::get(NewTy, C);
1033       assert(New != OldC && "Didn't replace constant??");
1034       OldC->uncheckedReplaceAllUsesWith(New);
1035       OldC->destroyConstant();    // This constant is now dead, destroy it.
1036     }
1037   };
1038 }
1039
1040 static std::vector<Constant*> getValType(ConstantPacked *CP) {
1041   std::vector<Constant*> Elements;
1042   Elements.reserve(CP->getNumOperands());
1043   for (unsigned i = 0, e = CP->getNumOperands(); i != e; ++i)
1044     Elements.push_back(CP->getOperand(i));
1045   return Elements;
1046 }
1047
1048 static ValueMap<std::vector<Constant*>, PackedType,
1049                 ConstantPacked> PackedConstants;
1050
1051 Constant *ConstantPacked::get(const PackedType *Ty,
1052                               const std::vector<Constant*> &V) {
1053   // If this is an all-zero packed, return a ConstantAggregateZero object
1054   if (!V.empty()) {
1055     Constant *C = V[0];
1056     if (!C->isNullValue())
1057       return PackedConstants.getOrCreate(Ty, V);
1058     for (unsigned i = 1, e = V.size(); i != e; ++i)
1059       if (V[i] != C)
1060         return PackedConstants.getOrCreate(Ty, V);
1061   }
1062   return ConstantAggregateZero::get(Ty);
1063 }
1064
1065 Constant *ConstantPacked::get(const std::vector<Constant*> &V) {
1066   assert(!V.empty() && "Cannot infer type if V is empty");
1067   return get(PackedType::get(V.front()->getType(),V.size()), V);
1068 }
1069
1070 // destroyConstant - Remove the constant from the constant table...
1071 //
1072 void ConstantPacked::destroyConstant() {
1073   PackedConstants.remove(this);
1074   destroyConstantImpl();
1075 }
1076
1077 //---- ConstantPointerNull::get() implementation...
1078 //
1079
1080 namespace llvm {
1081   // ConstantPointerNull does not take extra "value" argument...
1082   template<class ValType>
1083   struct ConstantCreator<ConstantPointerNull, PointerType, ValType> {
1084     static ConstantPointerNull *create(const PointerType *Ty, const ValType &V){
1085       return new ConstantPointerNull(Ty);
1086     }
1087   };
1088
1089   template<>
1090   struct ConvertConstantType<ConstantPointerNull, PointerType> {
1091     static void convert(ConstantPointerNull *OldC, const PointerType *NewTy) {
1092       // Make everyone now use a constant of the new type...
1093       Constant *New = ConstantPointerNull::get(NewTy);
1094       assert(New != OldC && "Didn't replace constant??");
1095       OldC->uncheckedReplaceAllUsesWith(New);
1096       OldC->destroyConstant();     // This constant is now dead, destroy it.
1097     }
1098   };
1099 }
1100
1101 static ValueMap<char, PointerType, ConstantPointerNull> NullPtrConstants;
1102
1103 static char getValType(ConstantPointerNull *) {
1104   return 0;
1105 }
1106
1107
1108 ConstantPointerNull *ConstantPointerNull::get(const PointerType *Ty) {
1109   return NullPtrConstants.getOrCreate(Ty, 0);
1110 }
1111
1112 // destroyConstant - Remove the constant from the constant table...
1113 //
1114 void ConstantPointerNull::destroyConstant() {
1115   NullPtrConstants.remove(this);
1116   destroyConstantImpl();
1117 }
1118
1119
1120 //---- UndefValue::get() implementation...
1121 //
1122
1123 namespace llvm {
1124   // UndefValue does not take extra "value" argument...
1125   template<class ValType>
1126   struct ConstantCreator<UndefValue, Type, ValType> {
1127     static UndefValue *create(const Type *Ty, const ValType &V) {
1128       return new UndefValue(Ty);
1129     }
1130   };
1131
1132   template<>
1133   struct ConvertConstantType<UndefValue, Type> {
1134     static void convert(UndefValue *OldC, const Type *NewTy) {
1135       // Make everyone now use a constant of the new type.
1136       Constant *New = UndefValue::get(NewTy);
1137       assert(New != OldC && "Didn't replace constant??");
1138       OldC->uncheckedReplaceAllUsesWith(New);
1139       OldC->destroyConstant();     // This constant is now dead, destroy it.
1140     }
1141   };
1142 }
1143
1144 static ValueMap<char, Type, UndefValue> UndefValueConstants;
1145
1146 static char getValType(UndefValue *) {
1147   return 0;
1148 }
1149
1150
1151 UndefValue *UndefValue::get(const Type *Ty) {
1152   return UndefValueConstants.getOrCreate(Ty, 0);
1153 }
1154
1155 // destroyConstant - Remove the constant from the constant table.
1156 //
1157 void UndefValue::destroyConstant() {
1158   UndefValueConstants.remove(this);
1159   destroyConstantImpl();
1160 }
1161
1162
1163
1164
1165 //---- ConstantExpr::get() implementations...
1166 //
1167 typedef std::pair<unsigned, std::vector<Constant*> > ExprMapKeyType;
1168
1169 namespace llvm {
1170   template<>
1171   struct ConstantCreator<ConstantExpr, Type, ExprMapKeyType> {
1172     static ConstantExpr *create(const Type *Ty, const ExprMapKeyType &V) {
1173       if (V.first == Instruction::Cast)
1174         return new UnaryConstantExpr(Instruction::Cast, V.second[0], Ty);
1175       if ((V.first >= Instruction::BinaryOpsBegin &&
1176            V.first < Instruction::BinaryOpsEnd) ||
1177           V.first == Instruction::Shl || V.first == Instruction::Shr)
1178         return new BinaryConstantExpr(V.first, V.second[0], V.second[1]);
1179       if (V.first == Instruction::Select)
1180         return new SelectConstantExpr(V.second[0], V.second[1], V.second[2]);
1181
1182       assert(V.first == Instruction::GetElementPtr && "Invalid ConstantExpr!");
1183
1184       std::vector<Constant*> IdxList(V.second.begin()+1, V.second.end());
1185       return new GetElementPtrConstantExpr(V.second[0], IdxList, Ty);
1186     }
1187   };
1188
1189   template<>
1190   struct ConvertConstantType<ConstantExpr, Type> {
1191     static void convert(ConstantExpr *OldC, const Type *NewTy) {
1192       Constant *New;
1193       switch (OldC->getOpcode()) {
1194       case Instruction::Cast:
1195         New = ConstantExpr::getCast(OldC->getOperand(0), NewTy);
1196         break;
1197       case Instruction::Select:
1198         New = ConstantExpr::getSelectTy(NewTy, OldC->getOperand(0),
1199                                         OldC->getOperand(1),
1200                                         OldC->getOperand(2));
1201         break;
1202       case Instruction::Shl:
1203       case Instruction::Shr:
1204         New = ConstantExpr::getShiftTy(NewTy, OldC->getOpcode(),
1205                                      OldC->getOperand(0), OldC->getOperand(1));
1206         break;
1207       default:
1208         assert(OldC->getOpcode() >= Instruction::BinaryOpsBegin &&
1209                OldC->getOpcode() < Instruction::BinaryOpsEnd);
1210         New = ConstantExpr::getTy(NewTy, OldC->getOpcode(), OldC->getOperand(0),
1211                                   OldC->getOperand(1));
1212         break;
1213       case Instruction::GetElementPtr:
1214         // Make everyone now use a constant of the new type...
1215         std::vector<Value*> Idx(OldC->op_begin()+1, OldC->op_end());
1216         New = ConstantExpr::getGetElementPtrTy(NewTy, OldC->getOperand(0), Idx);
1217         break;
1218       }
1219
1220       assert(New != OldC && "Didn't replace constant??");
1221       OldC->uncheckedReplaceAllUsesWith(New);
1222       OldC->destroyConstant();    // This constant is now dead, destroy it.
1223     }
1224   };
1225 } // end namespace llvm
1226
1227
1228 static ExprMapKeyType getValType(ConstantExpr *CE) {
1229   std::vector<Constant*> Operands;
1230   Operands.reserve(CE->getNumOperands());
1231   for (unsigned i = 0, e = CE->getNumOperands(); i != e; ++i)
1232     Operands.push_back(cast<Constant>(CE->getOperand(i)));
1233   return ExprMapKeyType(CE->getOpcode(), Operands);
1234 }
1235
1236 static ValueMap<ExprMapKeyType, Type, ConstantExpr> ExprConstants;
1237
1238 Constant *ConstantExpr::getCast(Constant *C, const Type *Ty) {
1239   assert(Ty->isFirstClassType() && "Cannot cast to an aggregate type!");
1240
1241   if (Constant *FC = ConstantFoldCastInstruction(C, Ty))
1242     return FC;          // Fold a few common cases...
1243
1244   // Look up the constant in the table first to ensure uniqueness
1245   std::vector<Constant*> argVec(1, C);
1246   ExprMapKeyType Key = std::make_pair(Instruction::Cast, argVec);
1247   return ExprConstants.getOrCreate(Ty, Key);
1248 }
1249
1250 Constant *ConstantExpr::getSignExtend(Constant *C, const Type *Ty) {
1251   assert(C->getType()->isIntegral() && Ty->isIntegral() &&
1252          C->getType()->getPrimitiveSize() <= Ty->getPrimitiveSize() &&
1253          "This is an illegal sign extension!");
1254   if (C->getType() != Type::BoolTy) {
1255     C = ConstantExpr::getCast(C, C->getType()->getSignedVersion());
1256     return ConstantExpr::getCast(C, Ty);
1257   } else {
1258     if (C == ConstantBool::True)
1259       return ConstantIntegral::getAllOnesValue(Ty);
1260     else
1261       return ConstantIntegral::getNullValue(Ty);
1262   }
1263 }
1264
1265 Constant *ConstantExpr::getZeroExtend(Constant *C, const Type *Ty) {
1266   assert(C->getType()->isIntegral() && Ty->isIntegral() &&
1267          C->getType()->getPrimitiveSize() <= Ty->getPrimitiveSize() &&
1268          "This is an illegal zero extension!");
1269   if (C->getType() != Type::BoolTy)
1270     C = ConstantExpr::getCast(C, C->getType()->getUnsignedVersion());
1271   return ConstantExpr::getCast(C, Ty);
1272 }
1273
1274 Constant *ConstantExpr::getSizeOf(const Type *Ty) {
1275   // sizeof is implemented as: (ulong) gep (Ty*)null, 1
1276   return getCast(
1277     getGetElementPtr(getNullValue(PointerType::get(Ty)),
1278                  std::vector<Constant*>(1, ConstantInt::get(Type::UIntTy, 1))),
1279     Type::ULongTy);
1280 }
1281
1282 Constant *ConstantExpr::getPtrPtrFromArrayPtr(Constant *C) {
1283   // pointer from array is implemented as: getelementptr arr ptr, 0, 0
1284   static std::vector<Constant*> Indices(2, ConstantUInt::get(Type::UIntTy, 0));
1285
1286   return ConstantExpr::getGetElementPtr(C, Indices);
1287 }
1288
1289 Constant *ConstantExpr::getTy(const Type *ReqTy, unsigned Opcode,
1290                               Constant *C1, Constant *C2) {
1291   if (Opcode == Instruction::Shl || Opcode == Instruction::Shr)
1292     return getShiftTy(ReqTy, Opcode, C1, C2);
1293   // Check the operands for consistency first
1294   assert((Opcode >= Instruction::BinaryOpsBegin &&
1295           Opcode < Instruction::BinaryOpsEnd) &&
1296          "Invalid opcode in binary constant expression");
1297   assert(C1->getType() == C2->getType() &&
1298          "Operand types in binary constant expression should match");
1299
1300   if (ReqTy == C1->getType() || (Instruction::isRelational(Opcode) &&
1301                                  ReqTy == Type::BoolTy))
1302     if (Constant *FC = ConstantFoldBinaryInstruction(Opcode, C1, C2))
1303       return FC;          // Fold a few common cases...
1304
1305   std::vector<Constant*> argVec(1, C1); argVec.push_back(C2);
1306   ExprMapKeyType Key = std::make_pair(Opcode, argVec);
1307   return ExprConstants.getOrCreate(ReqTy, Key);
1308 }
1309
1310 Constant *ConstantExpr::get(unsigned Opcode, Constant *C1, Constant *C2) {
1311 #ifndef NDEBUG
1312   switch (Opcode) {
1313   case Instruction::Add: case Instruction::Sub:
1314   case Instruction::Mul: case Instruction::Div:
1315   case Instruction::Rem:
1316     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1317     assert((C1->getType()->isInteger() || C1->getType()->isFloatingPoint()) &&
1318            "Tried to create an arithmetic operation on a non-arithmetic type!");
1319     break;
1320   case Instruction::And:
1321   case Instruction::Or:
1322   case Instruction::Xor:
1323     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1324     assert(C1->getType()->isIntegral() &&
1325            "Tried to create a logical operation on a non-integral type!");
1326     break;
1327   case Instruction::SetLT: case Instruction::SetGT: case Instruction::SetLE:
1328   case Instruction::SetGE: case Instruction::SetEQ: case Instruction::SetNE:
1329     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1330     break;
1331   case Instruction::Shl:
1332   case Instruction::Shr:
1333     assert(C2->getType() == Type::UByteTy && "Shift should be by ubyte!");
1334     assert(C1->getType()->isInteger() &&
1335            "Tried to create a shift operation on a non-integer type!");
1336     break;
1337   default:
1338     break;
1339   }
1340 #endif
1341
1342   if (Instruction::isRelational(Opcode))
1343     return getTy(Type::BoolTy, Opcode, C1, C2);
1344   else
1345     return getTy(C1->getType(), Opcode, C1, C2);
1346 }
1347
1348 Constant *ConstantExpr::getSelectTy(const Type *ReqTy, Constant *C,
1349                                     Constant *V1, Constant *V2) {
1350   assert(C->getType() == Type::BoolTy && "Select condition must be bool!");
1351   assert(V1->getType() == V2->getType() && "Select value types must match!");
1352   assert(V1->getType()->isFirstClassType() && "Cannot select aggregate type!");
1353
1354   if (ReqTy == V1->getType())
1355     if (Constant *SC = ConstantFoldSelectInstruction(C, V1, V2))
1356       return SC;        // Fold common cases
1357
1358   std::vector<Constant*> argVec(3, C);
1359   argVec[1] = V1;
1360   argVec[2] = V2;
1361   ExprMapKeyType Key = std::make_pair(Instruction::Select, argVec);
1362   return ExprConstants.getOrCreate(ReqTy, Key);
1363 }
1364
1365 /// getShiftTy - Return a shift left or shift right constant expr
1366 Constant *ConstantExpr::getShiftTy(const Type *ReqTy, unsigned Opcode,
1367                                    Constant *C1, Constant *C2) {
1368   // Check the operands for consistency first
1369   assert((Opcode == Instruction::Shl ||
1370           Opcode == Instruction::Shr) &&
1371          "Invalid opcode in binary constant expression");
1372   assert(C1->getType()->isIntegral() && C2->getType() == Type::UByteTy &&
1373          "Invalid operand types for Shift constant expr!");
1374
1375   if (Constant *FC = ConstantFoldBinaryInstruction(Opcode, C1, C2))
1376     return FC;          // Fold a few common cases...
1377
1378   // Look up the constant in the table first to ensure uniqueness
1379   std::vector<Constant*> argVec(1, C1); argVec.push_back(C2);
1380   ExprMapKeyType Key = std::make_pair(Opcode, argVec);
1381   return ExprConstants.getOrCreate(ReqTy, Key);
1382 }
1383
1384
1385 Constant *ConstantExpr::getGetElementPtrTy(const Type *ReqTy, Constant *C,
1386                                            const std::vector<Value*> &IdxList) {
1387   assert(GetElementPtrInst::getIndexedType(C->getType(), IdxList, true) &&
1388          "GEP indices invalid!");
1389
1390   if (Constant *FC = ConstantFoldGetElementPtr(C, IdxList))
1391     return FC;          // Fold a few common cases...
1392
1393   assert(isa<PointerType>(C->getType()) &&
1394          "Non-pointer type for constant GetElementPtr expression");
1395   // Look up the constant in the table first to ensure uniqueness
1396   std::vector<Constant*> ArgVec;
1397   ArgVec.reserve(IdxList.size()+1);
1398   ArgVec.push_back(C);
1399   for (unsigned i = 0, e = IdxList.size(); i != e; ++i)
1400     ArgVec.push_back(cast<Constant>(IdxList[i]));
1401   const ExprMapKeyType &Key = std::make_pair(Instruction::GetElementPtr,ArgVec);
1402   return ExprConstants.getOrCreate(ReqTy, Key);
1403 }
1404
1405 Constant *ConstantExpr::getGetElementPtr(Constant *C,
1406                                          const std::vector<Constant*> &IdxList){
1407   // Get the result type of the getelementptr!
1408   std::vector<Value*> VIdxList(IdxList.begin(), IdxList.end());
1409
1410   const Type *Ty = GetElementPtrInst::getIndexedType(C->getType(), VIdxList,
1411                                                      true);
1412   assert(Ty && "GEP indices invalid!");
1413   return getGetElementPtrTy(PointerType::get(Ty), C, VIdxList);
1414 }
1415
1416 Constant *ConstantExpr::getGetElementPtr(Constant *C,
1417                                          const std::vector<Value*> &IdxList) {
1418   // Get the result type of the getelementptr!
1419   const Type *Ty = GetElementPtrInst::getIndexedType(C->getType(), IdxList,
1420                                                      true);
1421   assert(Ty && "GEP indices invalid!");
1422   return getGetElementPtrTy(PointerType::get(Ty), C, IdxList);
1423 }
1424
1425
1426 // destroyConstant - Remove the constant from the constant table...
1427 //
1428 void ConstantExpr::destroyConstant() {
1429   ExprConstants.remove(this);
1430   destroyConstantImpl();
1431 }
1432
1433 const char *ConstantExpr::getOpcodeName() const {
1434   return Instruction::getOpcodeName(getOpcode());
1435 }
1436
1437 /// clearAllValueMaps - This method frees all internal memory used by the
1438 /// constant subsystem, which can be used in environments where this memory
1439 /// is otherwise reported as a leak.
1440 void Constant::clearAllValueMaps() {
1441   std::vector<Constant *> Constants;
1442
1443   DoubleConstants.clear(Constants);
1444   FloatConstants.clear(Constants);
1445   SIntConstants.clear(Constants);
1446   UIntConstants.clear(Constants);
1447   AggZeroConstants.clear(Constants);
1448   ArrayConstants.clear(Constants);
1449   StructConstants.clear(Constants);
1450   PackedConstants.clear(Constants);
1451   NullPtrConstants.clear(Constants);
1452   UndefValueConstants.clear(Constants);
1453   ExprConstants.clear(Constants);
1454
1455   for (std::vector<Constant *>::iterator I = Constants.begin(),
1456        E = Constants.end(); I != E; ++I)
1457     (*I)->dropAllReferences();
1458   for (std::vector<Constant *>::iterator I = Constants.begin(),
1459        E = Constants.end(); I != E; ++I)
1460     (*I)->destroyConstantImpl();
1461   Constants.clear();
1462 }