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