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/iMemory.h"
  18 #include "llvm/SymbolTable.h"
  19 #include "llvm/Module.h"
  20 #include "Support/StringExtras.h"
  21 #include <algorithm>
  22 using namespace llvm;
  23
  24 ConstantBool *ConstantBool::True  = new ConstantBool(true);
  25 ConstantBool *ConstantBool::False = new ConstantBool(false);
  26
  27
  28 //===----------------------------------------------------------------------===//
  29 //                              Constant Class
  30 //===----------------------------------------------------------------------===//
  31
  32 // Specialize setName to take care of symbol table majik
  33 void Constant::setName(const std::string &Name, SymbolTable *ST) {
  34   assert(ST && "Type::setName - Must provide symbol table argument!");
  35
  36   if (Name.size()) ST->insert(Name, this);
  37 }
  38
  39 void Constant::destroyConstantImpl() {
  40   // When a Constant is destroyed, there may be lingering
  41   // references to the constant by other constants in the constant pool.  These
  42   // constants are implicitly dependent on the module that is being deleted,
  43   // but they don't know that.  Because we only find out when the CPV is
  44   // deleted, we must now notify all of our users (that should only be
  45   // Constants) that they are, in fact, invalid now and should be deleted.
  46   //
  47   while (!use_empty()) {
  48     Value *V = use_back();
  49 #ifndef NDEBUG      // Only in -g mode...
  50     if (!isa<Constant>(V))
  51       std::cerr << "While deleting: " << *this
  52                 << "\n\nUse still stuck around after Def is destroyed: "
  53                 << *V << "\n\n";
  54 #endif
  55     assert(isa<Constant>(V) && "References remain to Constant being destroyed");
  56     Constant *CPV = cast<Constant>(V);
  57     CPV->destroyConstant();
  58
  59     // The constant should remove itself from our use list...
  60     assert((use_empty() || use_back() != V) && "Constant not removed!");
  61   }
  62
  63   // Value has no outstanding references it is safe to delete it now...
  64   delete this;
  65 }
  66
  67 // Static constructor to create a '0' constant of arbitrary type...
  68 Constant *Constant::getNullValue(const Type *Ty) {
  69   switch (Ty->getPrimitiveID()) {
  70   case Type::BoolTyID: {
  71     static Constant *NullBool = ConstantBool::get(false);
  72     return NullBool;
  73   }
  74   case Type::SByteTyID: {
  75     static Constant *NullSByte = ConstantSInt::get(Type::SByteTy, 0);
  76     return NullSByte;
  77   }
  78   case Type::UByteTyID: {
  79     static Constant *NullUByte = ConstantUInt::get(Type::UByteTy, 0);
  80     return NullUByte;
  81   }
  82   case Type::ShortTyID: {
  83     static Constant *NullShort = ConstantSInt::get(Type::ShortTy, 0);
  84     return NullShort;
  85   }
  86   case Type::UShortTyID: {
  87     static Constant *NullUShort = ConstantUInt::get(Type::UShortTy, 0);
  88     return NullUShort;
  89   }
  90   case Type::IntTyID: {
  91     static Constant *NullInt = ConstantSInt::get(Type::IntTy, 0);
  92     return NullInt;
  93   }
  94   case Type::UIntTyID: {
  95     static Constant *NullUInt = ConstantUInt::get(Type::UIntTy, 0);
  96     return NullUInt;
  97   }
  98   case Type::LongTyID: {
  99     static Constant *NullLong = ConstantSInt::get(Type::LongTy, 0);
 100     return NullLong;
 101   }
 102   case Type::ULongTyID: {
 103     static Constant *NullULong = ConstantUInt::get(Type::ULongTy, 0);
 104     return NullULong;
 105   }
 106
 107   case Type::FloatTyID: {
 108     static Constant *NullFloat = ConstantFP::get(Type::FloatTy, 0);
 109     return NullFloat;
 110   }
 111   case Type::DoubleTyID: {
 112     static Constant *NullDouble = ConstantFP::get(Type::DoubleTy, 0);
 113     return NullDouble;
 114   }
 115
 116   case Type::PointerTyID:
 117     return ConstantPointerNull::get(cast<PointerType>(Ty));
 118
 119   case Type::StructTyID:
 120   case Type::ArrayTyID:
 121     return ConstantAggregateZero::get(Ty);
 122   default:
 123     // Function, Type, Label, or Opaque type?
 124     assert(0 && "Cannot create a null constant of that type!");
 125     return 0;
 126   }
 127 }
 128
 129 // Static constructor to create the maximum constant of an integral type...
 130 ConstantIntegral *ConstantIntegral::getMaxValue(const Type *Ty) {
 131   switch (Ty->getPrimitiveID()) {
 132   case Type::BoolTyID:   return ConstantBool::True;
 133   case Type::SByteTyID:
 134   case Type::ShortTyID:
 135   case Type::IntTyID:
 136   case Type::LongTyID: {
 137     // Calculate 011111111111111...
 138     unsigned TypeBits = Ty->getPrimitiveSize()*8;
 139     int64_t Val = INT64_MAX;             // All ones
 140     Val >>= 64-TypeBits;                 // Shift out unwanted 1 bits...
 141     return ConstantSInt::get(Ty, Val);
 142   }
 143
 144   case Type::UByteTyID:
 145   case Type::UShortTyID:
 146   case Type::UIntTyID:
 147   case Type::ULongTyID:  return getAllOnesValue(Ty);
 148
 149   default: return 0;
 150   }
 151 }
 152
 153 // Static constructor to create the minimum constant for an integral type...
 154 ConstantIntegral *ConstantIntegral::getMinValue(const Type *Ty) {
 155   switch (Ty->getPrimitiveID()) {
 156   case Type::BoolTyID:   return ConstantBool::False;
 157   case Type::SByteTyID:
 158   case Type::ShortTyID:
 159   case Type::IntTyID:
 160   case Type::LongTyID: {
 161      // Calculate 1111111111000000000000
 162      unsigned TypeBits = Ty->getPrimitiveSize()*8;
 163      int64_t Val = -1;                    // All ones
 164      Val <<= TypeBits-1;                  // Shift over to the right spot
 165      return ConstantSInt::get(Ty, Val);
 166   }
 167
 168   case Type::UByteTyID:
 169   case Type::UShortTyID:
 170   case Type::UIntTyID:
 171   case Type::ULongTyID:  return ConstantUInt::get(Ty, 0);
 172
 173   default: return 0;
 174   }
 175 }
 176
 177 // Static constructor to create an integral constant with all bits set
 178 ConstantIntegral *ConstantIntegral::getAllOnesValue(const Type *Ty) {
 179   switch (Ty->getPrimitiveID()) {
 180   case Type::BoolTyID:   return ConstantBool::True;
 181   case Type::SByteTyID:
 182   case Type::ShortTyID:
 183   case Type::IntTyID:
 184   case Type::LongTyID:   return ConstantSInt::get(Ty, -1);
 185
 186   case Type::UByteTyID:
 187   case Type::UShortTyID:
 188   case Type::UIntTyID:
 189   case Type::ULongTyID: {
 190     // Calculate ~0 of the right type...
 191     unsigned TypeBits = Ty->getPrimitiveSize()*8;
 192     uint64_t Val = ~0ULL;                // All ones
 193     Val >>= 64-TypeBits;                 // Shift out unwanted 1 bits...
 194     return ConstantUInt::get(Ty, Val);
 195   }
 196   default: return 0;
 197   }
 198 }
 199
 200 bool ConstantUInt::isAllOnesValue() const {
 201   unsigned TypeBits = getType()->getPrimitiveSize()*8;
 202   uint64_t Val = ~0ULL;                // All ones
 203   Val >>= 64-TypeBits;                 // Shift out inappropriate bits
 204   return getValue() == Val;
 205 }
 206
 207
 208 //===----------------------------------------------------------------------===//
 209 //                            ConstantXXX Classes
 210 //===----------------------------------------------------------------------===//
 211
 212 //===----------------------------------------------------------------------===//
 213 //                             Normal Constructors
 214
 215 ConstantBool::ConstantBool(bool V) : ConstantIntegral(Type::BoolTy) {
 216   Val = V;
 217 }
 218
 219 ConstantInt::ConstantInt(const Type *Ty, uint64_t V) : ConstantIntegral(Ty) {
 220   Val.Unsigned = 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 unsigned 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) : Constant(Ty) {
 236   assert(isValueValidForType(Ty, V) && "Value too large for type!");
 237   Val = V;
 238 }
 239
 240 ConstantArray::ConstantArray(const ArrayType *T,
 241                              const std::vector<Constant*> &V) : Constant(T) {
 242   Operands.reserve(V.size());
 243   for (unsigned i = 0, e = V.size(); i != e; ++i) {
 244     assert(V[i]->getType() == T->getElementType() ||
 245            (T->isAbstract() &&
 246             V[i]->getType()->getPrimitiveID() ==
 247             T->getElementType()->getPrimitiveID()));
 248     Operands.push_back(Use(V[i], this));
 249   }
 250 }
 251
 252 ConstantStruct::ConstantStruct(const StructType *T,
 253                                const std::vector<Constant*> &V) : Constant(T) {
 254   assert(V.size() == T->getNumElements() &&
 255          "Invalid initializer vector for constant structure");
 256   Operands.reserve(V.size());
 257   for (unsigned i = 0, e = V.size(); i != e; ++i) {
 258     assert((V[i]->getType() == T->getElementType(i) ||
 259             ((T->getElementType(i)->isAbstract() ||
 260               V[i]->getType()->isAbstract()) &&
 261              T->getElementType(i)->getPrimitiveID() ==
 262                       V[i]->getType()->getPrimitiveID())) &&
 263            "Initializer for struct element doesn't match struct element type!");
 264     Operands.push_back(Use(V[i], this));
 265   }
 266 }
 267
 268 ConstantPointerRef::ConstantPointerRef(GlobalValue *GV)
 269   : Constant(GV->getType()) {
 270   Operands.push_back(Use(GV, this));
 271 }
 272
 273 ConstantExpr::ConstantExpr(unsigned Opcode, Constant *C, const Type *Ty)
 274   : Constant(Ty), iType(Opcode) {
 275   Operands.push_back(Use(C, this));
 276 }
 277
 278 static bool isSetCC(unsigned Opcode) {
 279   return Opcode == Instruction::SetEQ || Opcode == Instruction::SetNE ||
 280          Opcode == Instruction::SetLT || Opcode == Instruction::SetGT ||
 281          Opcode == Instruction::SetLE || Opcode == Instruction::SetGE;
 282 }
 283
 284 ConstantExpr::ConstantExpr(unsigned Opcode, Constant *C1, Constant *C2)
 285   : Constant(isSetCC(Opcode) ? Type::BoolTy : C1->getType()), iType(Opcode) {
 286   Operands.push_back(Use(C1, this));
 287   Operands.push_back(Use(C2, this));
 288 }
 289
 290 ConstantExpr::ConstantExpr(Constant *C, const std::vector<Constant*> &IdxList,
 291                            const Type *DestTy)
 292   : Constant(DestTy), iType(Instruction::GetElementPtr) {
 293   Operands.reserve(1+IdxList.size());
 294   Operands.push_back(Use(C, this));
 295   for (unsigned i = 0, E = IdxList.size(); i != E; ++i)
 296     Operands.push_back(Use(IdxList[i], this));
 297 }
 298
 299
 300
 301 //===----------------------------------------------------------------------===//
 302 //                           classof implementations
 303
 304 bool ConstantIntegral::classof(const Constant *CPV) {
 305   return CPV->getType()->isIntegral() && !isa<ConstantExpr>(CPV);
 306 }
 307
 308 bool ConstantInt::classof(const Constant *CPV) {
 309   return CPV->getType()->isInteger() && !isa<ConstantExpr>(CPV);
 310 }
 311 bool ConstantSInt::classof(const Constant *CPV) {
 312   return CPV->getType()->isSigned() && !isa<ConstantExpr>(CPV);
 313 }
 314 bool ConstantUInt::classof(const Constant *CPV) {
 315   return CPV->getType()->isUnsigned() && !isa<ConstantExpr>(CPV);
 316 }
 317 bool ConstantFP::classof(const Constant *CPV) {
 318   const Type *Ty = CPV->getType();
 319   return ((Ty == Type::FloatTy || Ty == Type::DoubleTy) &&
 320           !isa<ConstantExpr>(CPV));
 321 }
 322 bool ConstantAggregateZero::classof(const Constant *CPV) {
 323   return (isa<ArrayType>(CPV->getType()) || isa<StructType>(CPV->getType())) &&
 324          CPV->isNullValue();
 325 }
 326 bool ConstantArray::classof(const Constant *CPV) {
 327   return isa<ArrayType>(CPV->getType()) && !CPV->isNullValue();
 328 }
 329 bool ConstantStruct::classof(const Constant *CPV) {
 330   return isa<StructType>(CPV->getType()) && !CPV->isNullValue();
 331 }
 332
 333 bool ConstantPointerNull::classof(const Constant *CPV) {
 334   return isa<PointerType>(CPV->getType()) && !isa<ConstantExpr>(CPV) &&
 335          CPV->getNumOperands() == 0;
 336 }
 337
 338 bool ConstantPointerRef::classof(const Constant *CPV) {
 339   return isa<PointerType>(CPV->getType()) && !isa<ConstantExpr>(CPV) &&
 340          CPV->getNumOperands() == 1;
 341 }
 342
 343
 344
 345 //===----------------------------------------------------------------------===//
 346 //                      isValueValidForType implementations
 347
 348 bool ConstantSInt::isValueValidForType(const Type *Ty, int64_t Val) {
 349   switch (Ty->getPrimitiveID()) {
 350   default:
 351     return false;         // These can't be represented as integers!!!
 352
 353     // Signed types...
 354   case Type::SByteTyID:
 355     return (Val <= INT8_MAX && Val >= INT8_MIN);
 356   case Type::ShortTyID:
 357     return (Val <= INT16_MAX && Val >= INT16_MIN);
 358   case Type::IntTyID:
 359     return (Val <= INT32_MAX && Val >= INT32_MIN);
 360   case Type::LongTyID:
 361     return true;          // This is the largest type...
 362   }
 363   assert(0 && "WTF?");
 364   return false;
 365 }
 366
 367 bool ConstantUInt::isValueValidForType(const Type *Ty, uint64_t Val) {
 368   switch (Ty->getPrimitiveID()) {
 369   default:
 370     return false;         // These can't be represented as integers!!!
 371
 372     // Unsigned types...
 373   case Type::UByteTyID:
 374     return (Val <= UINT8_MAX);
 375   case Type::UShortTyID:
 376     return (Val <= UINT16_MAX);
 377   case Type::UIntTyID:
 378     return (Val <= UINT32_MAX);
 379   case Type::ULongTyID:
 380     return true;          // This is the largest type...
 381   }
 382   assert(0 && "WTF?");
 383   return false;
 384 }
 385
 386 bool ConstantFP::isValueValidForType(const Type *Ty, double Val) {
 387   switch (Ty->getPrimitiveID()) {
 388   default:
 389     return false;         // These can't be represented as floating point!
 390
 391     // TODO: Figure out how to test if a double can be cast to a float!
 392   case Type::FloatTyID:
 393   case Type::DoubleTyID:
 394     return true;          // This is the largest type...
 395   }
 396 };
 397
 398 //===----------------------------------------------------------------------===//
 399 //                replaceUsesOfWithOnConstant implementations
 400
 401 void ConstantArray::replaceUsesOfWithOnConstant(Value *From, Value *To,
 402                                                 bool DisableChecking) {
 403   assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
 404
 405   std::vector<Constant*> Values;
 406   Values.reserve(getValues().size());  // Build replacement array...
 407   for (unsigned i = 0, e = getValues().size(); i != e; ++i) {
 408     Constant *Val = cast<Constant>(getValues()[i]);
 409     if (Val == From) Val = cast<Constant>(To);
 410     Values.push_back(Val);
 411   }
 412
 413   Constant *Replacement = ConstantArray::get(getType(), Values);
 414   assert(Replacement != this && "I didn't contain From!");
 415
 416   // Everyone using this now uses the replacement...
 417   if (DisableChecking)
 418     uncheckedReplaceAllUsesWith(Replacement);
 419   else
 420     replaceAllUsesWith(Replacement);
 421
 422   // Delete the old constant!
 423   destroyConstant();
 424 }
 425
 426 void ConstantStruct::replaceUsesOfWithOnConstant(Value *From, Value *To,
 427                                                  bool DisableChecking) {
 428   assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
 429
 430   std::vector<Constant*> Values;
 431   Values.reserve(getValues().size());
 432   for (unsigned i = 0, e = getValues().size(); i != e; ++i) {
 433     Constant *Val = cast<Constant>(getValues()[i]);
 434     if (Val == From) Val = cast<Constant>(To);
 435     Values.push_back(Val);
 436   }
 437
 438   Constant *Replacement = ConstantStruct::get(getType(), Values);
 439   assert(Replacement != this && "I didn't contain From!");
 440
 441   // Everyone using this now uses the replacement...
 442   if (DisableChecking)
 443     uncheckedReplaceAllUsesWith(Replacement);
 444   else
 445     replaceAllUsesWith(Replacement);
 446
 447   // Delete the old constant!
 448   destroyConstant();
 449 }
 450
 451 void ConstantPointerRef::replaceUsesOfWithOnConstant(Value *From, Value *To,
 452                                                      bool DisableChecking) {
 453   if (isa<GlobalValue>(To)) {
 454     assert(From == getOperand(0) && "Doesn't contain from!");
 455     ConstantPointerRef *Replacement =
 456       ConstantPointerRef::get(cast<GlobalValue>(To));
 457
 458     // Everyone using this now uses the replacement...
 459     if (DisableChecking)
 460       uncheckedReplaceAllUsesWith(Replacement);
 461     else
 462       replaceAllUsesWith(Replacement);
 463
 464   } else {
 465     // Just replace ourselves with the To value specified.
 466     if (DisableChecking)
 467       uncheckedReplaceAllUsesWith(To);
 468     else
 469       replaceAllUsesWith(To);
 470   }
 471
 472   // Delete the old constant!
 473   destroyConstant();
 474 }
 475
 476 void ConstantExpr::replaceUsesOfWithOnConstant(Value *From, Value *ToV,
 477                                                bool DisableChecking) {
 478   assert(isa<Constant>(ToV) && "Cannot make Constant refer to non-constant!");
 479   Constant *To = cast<Constant>(ToV);
 480
 481   Constant *Replacement = 0;
 482   if (getOpcode() == Instruction::GetElementPtr) {
 483     std::vector<Constant*> Indices;
 484     Constant *Pointer = getOperand(0);
 485     Indices.reserve(getNumOperands()-1);
 486     if (Pointer == From) Pointer = To;
 487
 488     for (unsigned i = 1, e = getNumOperands(); i != e; ++i) {
 489       Constant *Val = getOperand(i);
 490       if (Val == From) Val = To;
 491       Indices.push_back(Val);
 492     }
 493     Replacement = ConstantExpr::getGetElementPtr(Pointer, Indices);
 494   } else if (getOpcode() == Instruction::Cast) {
 495     assert(getOperand(0) == From && "Cast only has one use!");
 496     Replacement = ConstantExpr::getCast(To, getType());
 497   } else if (getNumOperands() == 2) {
 498     Constant *C1 = getOperand(0);
 499     Constant *C2 = getOperand(1);
 500     if (C1 == From) C1 = To;
 501     if (C2 == From) C2 = To;
 502     Replacement = ConstantExpr::get(getOpcode(), C1, C2);
 503   } else {
 504     assert(0 && "Unknown ConstantExpr type!");
 505     return;
 506   }
 507
 508   assert(Replacement != this && "I didn't contain From!");
 509
 510   // Everyone using this now uses the replacement...
 511   if (DisableChecking)
 512     uncheckedReplaceAllUsesWith(Replacement);
 513   else
 514     replaceAllUsesWith(Replacement);
 515
 516   // Delete the old constant!
 517   destroyConstant();
 518 }
 519
 520 //===----------------------------------------------------------------------===//
 521 //                      Factory Function Implementation
 522
 523 // ConstantCreator - A class that is used to create constants by
 524 // ValueMap*.  This class should be partially specialized if there is
 525 // something strange that needs to be done to interface to the ctor for the
 526 // constant.
 527 //
 528 namespace llvm {
 529   template<class ConstantClass, class TypeClass, class ValType>
 530   struct ConstantCreator {
 531     static ConstantClass *create(const TypeClass *Ty, const ValType &V) {
 532       return new ConstantClass(Ty, V);
 533     }
 534   };
 535
 536   template<class ConstantClass, class TypeClass>
 537   struct ConvertConstantType {
 538     static void convert(ConstantClass *OldC, const TypeClass *NewTy) {
 539       assert(0 && "This type cannot be converted!\n");
 540       abort();
 541     }
 542   };
 543 }
 544
 545 namespace {
 546   template<class ValType, class TypeClass, class ConstantClass>
 547   class ValueMap : public AbstractTypeUser {
 548     typedef std::pair<const TypeClass*, ValType> MapKey;
 549     typedef std::map<MapKey, ConstantClass *> MapTy;
 550     typedef typename MapTy::iterator MapIterator;
 551     MapTy Map;
 552
 553     typedef std::map<const TypeClass*, MapIterator> AbstractTypeMapTy;
 554     AbstractTypeMapTy AbstractTypeMap;
 555   public:
 556     // getOrCreate - Return the specified constant from the map, creating it if
 557     // necessary.
 558     ConstantClass *getOrCreate(const TypeClass *Ty, const ValType &V) {
 559       MapKey Lookup(Ty, V);
 560       MapIterator I = Map.lower_bound(Lookup);
 561       if (I != Map.end() && I->first == Lookup)
 562         return I->second;  // Is it in the map?
 563
 564       // If no preexisting value, create one now...
 565       ConstantClass *Result =
 566         ConstantCreator<ConstantClass,TypeClass,ValType>::create(Ty, V);
 567
 568
 569       /// FIXME: why does this assert fail when loading 176.gcc?
 570       //assert(Result->getType() == Ty && "Type specified is not correct!");
 571       I = Map.insert(I, std::make_pair(MapKey(Ty, V), Result));
 572
 573       // If the type of the constant is abstract, make sure that an entry exists
 574       // for it in the AbstractTypeMap.
 575       if (Ty->isAbstract()) {
 576         typename AbstractTypeMapTy::iterator TI =
 577           AbstractTypeMap.lower_bound(Ty);
 578
 579         if (TI == AbstractTypeMap.end() || TI->first != Ty) {
 580           // Add ourselves to the ATU list of the type.
 581           cast<DerivedType>(Ty)->addAbstractTypeUser(this);
 582
 583           AbstractTypeMap.insert(TI, std::make_pair(Ty, I));
 584         }
 585       }
 586       return Result;
 587     }
 588
 589     void remove(ConstantClass *CP) {
 590       // FIXME: This should not use a linear scan.  If this gets to be a
 591       // performance problem, someone should look at this.
 592       MapIterator I = Map.begin();
 593       for (MapIterator E = Map.end(); I != E && I->second != CP; ++I)
 594         /* empty */;
 595
 596       assert(I != Map.end() && "Constant not found in constant table!");
 597
 598       // Now that we found the entry, make sure this isn't the entry that
 599       // the AbstractTypeMap points to.
 600       const TypeClass *Ty = I->first.first;
 601       if (Ty->isAbstract()) {
 602         assert(AbstractTypeMap.count(Ty) &&
 603                "Abstract type not in AbstractTypeMap?");
 604         MapIterator &ATMEntryIt = AbstractTypeMap[Ty];
 605         if (ATMEntryIt == I) {
 606           // Yes, we are removing the representative entry for this type.
 607           // See if there are any other entries of the same type.
 608           MapIterator TmpIt = ATMEntryIt;
 609
 610           // First check the entry before this one...
 611           if (TmpIt != Map.begin()) {
 612             --TmpIt;
 613             if (TmpIt->first.first != Ty) // Not the same type, move back...
 614               ++TmpIt;
 615           }
 616
 617           // If we didn't find the same type, try to move forward...
 618           if (TmpIt == ATMEntryIt) {
 619             ++TmpIt;
 620             if (TmpIt == Map.end() || TmpIt->first.first != Ty)
 621               --TmpIt;   // No entry afterwards with the same type
 622           }
 623
 624           // If there is another entry in the map of the same abstract type,
 625           // update the AbstractTypeMap entry now.
 626           if (TmpIt != ATMEntryIt) {
 627             ATMEntryIt = TmpIt;
 628           } else {
 629             // Otherwise, we are removing the last instance of this type
 630             // from the table.  Remove from the ATM, and from user list.
 631             cast<DerivedType>(Ty)->removeAbstractTypeUser(this);
 632             AbstractTypeMap.erase(Ty);
 633           }
 634         }
 635       }
 636
 637       Map.erase(I);
 638     }
 639
 640     void refineAbstractType(const DerivedType *OldTy, const Type *NewTy) {
 641       typename AbstractTypeMapTy::iterator I =
 642         AbstractTypeMap.find(cast<TypeClass>(OldTy));
 643
 644       assert(I != AbstractTypeMap.end() &&
 645              "Abstract type not in AbstractTypeMap?");
 646
 647       // Convert a constant at a time until the last one is gone.  The last one
 648       // leaving will remove() itself, causing the AbstractTypeMapEntry to be
 649       // eliminated eventually.
 650       do {
 651         ConvertConstantType<ConstantClass,
 652                             TypeClass>::convert(I->second->second,
 653                                                 cast<TypeClass>(NewTy));
 654
 655         I = AbstractTypeMap.find(cast<TypeClass>(OldTy));
 656       } while (I != AbstractTypeMap.end());
 657     }
 658
 659     // If the type became concrete without being refined to any other existing
 660     // type, we just remove ourselves from the ATU list.
 661     void typeBecameConcrete(const DerivedType *AbsTy) {
 662       AbsTy->removeAbstractTypeUser(this);
 663     }
 664
 665     void dump() const {
 666       std::cerr << "Constant.cpp: ValueMap\n";
 667     }
 668   };
 669 }
 670
 671
 672
 673 //---- ConstantUInt::get() and ConstantSInt::get() implementations...
 674 //
 675 static ValueMap< int64_t, Type, ConstantSInt> SIntConstants;
 676 static ValueMap<uint64_t, Type, ConstantUInt> UIntConstants;
 677
 678 ConstantSInt *ConstantSInt::get(const Type *Ty, int64_t V) {
 679   return SIntConstants.getOrCreate(Ty, V);
 680 }
 681
 682 ConstantUInt *ConstantUInt::get(const Type *Ty, uint64_t V) {
 683   return UIntConstants.getOrCreate(Ty, V);
 684 }
 685
 686 ConstantInt *ConstantInt::get(const Type *Ty, unsigned char V) {
 687   assert(V <= 127 && "Can only be used with very small positive constants!");
 688   if (Ty->isSigned()) return ConstantSInt::get(Ty, V);
 689   return ConstantUInt::get(Ty, V);
 690 }
 691
 692 //---- ConstantFP::get() implementation...
 693 //
 694 namespace llvm {
 695   template<>
 696   struct ConstantCreator<ConstantFP, Type, uint64_t> {
 697     static ConstantFP *create(const Type *Ty, uint64_t V) {
 698       assert(Ty == Type::DoubleTy);
 699       union {
 700         double F;
 701         uint64_t I;
 702       } T;
 703       T.I = V;
 704       return new ConstantFP(Ty, T.F);
 705     }
 706   };
 707   template<>
 708   struct ConstantCreator<ConstantFP, Type, uint32_t> {
 709     static ConstantFP *create(const Type *Ty, uint32_t V) {
 710       assert(Ty == Type::FloatTy);
 711       union {
 712         float F;
 713         uint32_t I;
 714       } T;
 715       T.I = V;
 716       return new ConstantFP(Ty, T.F);
 717     }
 718   };
 719 }
 720
 721 static ValueMap<uint64_t, Type, ConstantFP> DoubleConstants;
 722 static ValueMap<uint32_t, Type, ConstantFP> FloatConstants;
 723
 724 ConstantFP *ConstantFP::get(const Type *Ty, double V) {
 725   if (Ty == Type::FloatTy) {
 726     // Force the value through memory to normalize it.
 727     union {
 728       float F;
 729       uint32_t I;
 730     } T;
 731     T.F = (float)V;
 732     return FloatConstants.getOrCreate(Ty, T.I);
 733   } else {
 734     assert(Ty == Type::DoubleTy);
 735     union {
 736       double F;
 737       uint64_t I;
 738     } T;
 739     T.F = V;
 740     return DoubleConstants.getOrCreate(Ty, T.I);
 741   }
 742 }
 743
 744 //---- ConstantAggregateZero::get() implementation...
 745 //
 746 namespace llvm {
 747   // ConstantAggregateZero does not take extra "value" argument...
 748   template<class ValType>
 749   struct ConstantCreator<ConstantAggregateZero, Type, ValType> {
 750     static ConstantAggregateZero *create(const Type *Ty, const ValType &V){
 751       return new ConstantAggregateZero(Ty);
 752     }
 753   };
 754
 755   template<>
 756   struct ConvertConstantType<ConstantAggregateZero, Type> {
 757     static void convert(ConstantAggregateZero *OldC, const Type *NewTy) {
 758       // Make everyone now use a constant of the new type...
 759       Constant *New = ConstantAggregateZero::get(NewTy);
 760       assert(New != OldC && "Didn't replace constant??");
 761       OldC->uncheckedReplaceAllUsesWith(New);
 762       OldC->destroyConstant();     // This constant is now dead, destroy it.
 763     }
 764   };
 765 }
 766
 767 static ValueMap<char, Type, ConstantAggregateZero> AggZeroConstants;
 768
 769 Constant *ConstantAggregateZero::get(const Type *Ty) {
 770   return AggZeroConstants.getOrCreate(Ty, 0);
 771 }
 772
 773 // destroyConstant - Remove the constant from the constant table...
 774 //
 775 void ConstantAggregateZero::destroyConstant() {
 776   AggZeroConstants.remove(this);
 777   destroyConstantImpl();
 778 }
 779
 780 void ConstantAggregateZero::replaceUsesOfWithOnConstant(Value *From, Value *To,
 781                                                         bool DisableChecking) {
 782   assert(0 && "No uses!");
 783   abort();
 784 }
 785
 786
 787
 788 //---- ConstantArray::get() implementation...
 789 //
 790 namespace llvm {
 791   template<>
 792   struct ConvertConstantType<ConstantArray, ArrayType> {
 793     static void convert(ConstantArray *OldC, const ArrayType *NewTy) {
 794       // Make everyone now use a constant of the new type...
 795       std::vector<Constant*> C;
 796       for (unsigned i = 0, e = OldC->getNumOperands(); i != e; ++i)
 797         C.push_back(cast<Constant>(OldC->getOperand(i)));
 798       Constant *New = ConstantArray::get(NewTy, C);
 799       assert(New != OldC && "Didn't replace constant??");
 800       OldC->uncheckedReplaceAllUsesWith(New);
 801       OldC->destroyConstant();    // This constant is now dead, destroy it.
 802     }
 803   };
 804 }
 805
 806 static ValueMap<std::vector<Constant*>, ArrayType,
 807                 ConstantArray> ArrayConstants;
 808
 809 Constant *ConstantArray::get(const ArrayType *Ty,
 810                              const std::vector<Constant*> &V) {
 811   // If this is an all-zero array, return a ConstantAggregateZero object
 812   if (!V.empty()) {
 813     Constant *C = V[0];
 814     if (!C->isNullValue())
 815       return ArrayConstants.getOrCreate(Ty, V);
 816     for (unsigned i = 1, e = V.size(); i != e; ++i)
 817       if (V[i] != C)
 818         return ArrayConstants.getOrCreate(Ty, V);
 819   }
 820   return ConstantAggregateZero::get(Ty);
 821 }
 822
 823 // destroyConstant - Remove the constant from the constant table...
 824 //
 825 void ConstantArray::destroyConstant() {
 826   ArrayConstants.remove(this);
 827   destroyConstantImpl();
 828 }
 829
 830 // ConstantArray::get(const string&) - Return an array that is initialized to
 831 // contain the specified string.  A null terminator is added to the specified
 832 // string so that it may be used in a natural way...
 833 //
 834 Constant *ConstantArray::get(const std::string &Str) {
 835   std::vector<Constant*> ElementVals;
 836
 837   for (unsigned i = 0; i < Str.length(); ++i)
 838     ElementVals.push_back(ConstantSInt::get(Type::SByteTy, Str[i]));
 839
 840   // Add a null terminator to the string...
 841   ElementVals.push_back(ConstantSInt::get(Type::SByteTy, 0));
 842
 843   ArrayType *ATy = ArrayType::get(Type::SByteTy, Str.length()+1);
 844   return ConstantArray::get(ATy, ElementVals);
 845 }
 846
 847 /// isString - This method returns true if the array is an array of sbyte or
 848 /// ubyte, and if the elements of the array are all ConstantInt's.
 849 bool ConstantArray::isString() const {
 850   // Check the element type for sbyte or ubyte...
 851   if (getType()->getElementType() != Type::UByteTy &&
 852       getType()->getElementType() != Type::SByteTy)
 853     return false;
 854   // Check the elements to make sure they are all integers, not constant
 855   // expressions.
 856   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
 857     if (!isa<ConstantInt>(getOperand(i)))
 858       return false;
 859   return true;
 860 }
 861
 862 // getAsString - If the sub-element type of this array is either sbyte or ubyte,
 863 // then this method converts the array to an std::string and returns it.
 864 // Otherwise, it asserts out.
 865 //
 866 std::string ConstantArray::getAsString() const {
 867   assert(isString() && "Not a string!");
 868   std::string Result;
 869   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
 870     Result += (char)cast<ConstantInt>(getOperand(i))->getRawValue();
 871   return Result;
 872 }
 873
 874
 875 //---- ConstantStruct::get() implementation...
 876 //
 877
 878 namespace llvm {
 879   template<>
 880   struct ConvertConstantType<ConstantStruct, StructType> {
 881     static void convert(ConstantStruct *OldC, const StructType *NewTy) {
 882       // Make everyone now use a constant of the new type...
 883       std::vector<Constant*> C;
 884       for (unsigned i = 0, e = OldC->getNumOperands(); i != e; ++i)
 885         C.push_back(cast<Constant>(OldC->getOperand(i)));
 886       Constant *New = ConstantStruct::get(NewTy, C);
 887       assert(New != OldC && "Didn't replace constant??");
 888
 889       OldC->uncheckedReplaceAllUsesWith(New);
 890       OldC->destroyConstant();    // This constant is now dead, destroy it.
 891     }
 892   };
 893 }
 894
 895 static ValueMap<std::vector<Constant*>, StructType,
 896                 ConstantStruct> StructConstants;
 897
 898 Constant *ConstantStruct::get(const StructType *Ty,
 899                               const std::vector<Constant*> &V) {
 900   // Create a ConstantAggregateZero value if all elements are zeros...
 901   for (unsigned i = 0, e = V.size(); i != e; ++i)
 902     if (!V[i]->isNullValue())
 903       return StructConstants.getOrCreate(Ty, V);
 904
 905   return ConstantAggregateZero::get(Ty);
 906 }
 907
 908 // destroyConstant - Remove the constant from the constant table...
 909 //
 910 void ConstantStruct::destroyConstant() {
 911   StructConstants.remove(this);
 912   destroyConstantImpl();
 913 }
 914
 915 //---- ConstantPointerNull::get() implementation...
 916 //
 917
 918 namespace llvm {
 919   // ConstantPointerNull does not take extra "value" argument...
 920   template<class ValType>
 921   struct ConstantCreator<ConstantPointerNull, PointerType, ValType> {
 922     static ConstantPointerNull *create(const PointerType *Ty, const ValType &V){
 923       return new ConstantPointerNull(Ty);
 924     }
 925   };
 926
 927   template<>
 928   struct ConvertConstantType<ConstantPointerNull, PointerType> {
 929     static void convert(ConstantPointerNull *OldC, const PointerType *NewTy) {
 930       // Make everyone now use a constant of the new type...
 931       Constant *New = ConstantPointerNull::get(NewTy);
 932       assert(New != OldC && "Didn't replace constant??");
 933       OldC->uncheckedReplaceAllUsesWith(New);
 934       OldC->destroyConstant();     // This constant is now dead, destroy it.
 935     }
 936   };
 937 }
 938
 939 static ValueMap<char, PointerType, ConstantPointerNull> NullPtrConstants;
 940
 941 ConstantPointerNull *ConstantPointerNull::get(const PointerType *Ty) {
 942   return NullPtrConstants.getOrCreate(Ty, 0);
 943 }
 944
 945 // destroyConstant - Remove the constant from the constant table...
 946 //
 947 void ConstantPointerNull::destroyConstant() {
 948   NullPtrConstants.remove(this);
 949   destroyConstantImpl();
 950 }
 951
 952
 953 //---- ConstantPointerRef::get() implementation...
 954 //
 955 ConstantPointerRef *ConstantPointerRef::get(GlobalValue *GV) {
 956   assert(GV->getParent() && "Global Value must be attached to a module!");
 957
 958   // The Module handles the pointer reference sharing...
 959   return GV->getParent()->getConstantPointerRef(GV);
 960 }
 961
 962 // destroyConstant - Remove the constant from the constant table...
 963 //
 964 void ConstantPointerRef::destroyConstant() {
 965   getValue()->getParent()->destroyConstantPointerRef(this);
 966   destroyConstantImpl();
 967 }
 968
 969
 970 //---- ConstantExpr::get() implementations...
 971 //
 972 typedef std::pair<unsigned, std::vector<Constant*> > ExprMapKeyType;
 973
 974 namespace llvm {
 975   template<>
 976   struct ConstantCreator<ConstantExpr, Type, ExprMapKeyType> {
 977     static ConstantExpr *create(const Type *Ty, const ExprMapKeyType &V) {
 978       if (V.first == Instruction::Cast)
 979         return new ConstantExpr(Instruction::Cast, V.second[0], Ty);
 980       if ((V.first >= Instruction::BinaryOpsBegin &&
 981            V.first < Instruction::BinaryOpsEnd) ||
 982           V.first == Instruction::Shl || V.first == Instruction::Shr)
 983         return new ConstantExpr(V.first, V.second[0], V.second[1]);
 984
 985       assert(V.first == Instruction::GetElementPtr && "Invalid ConstantExpr!");
 986
 987       std::vector<Constant*> IdxList(V.second.begin()+1, V.second.end());
 988       return new ConstantExpr(V.second[0], IdxList, Ty);
 989     }
 990   };
 991
 992   template<>
 993   struct ConvertConstantType<ConstantExpr, Type> {
 994     static void convert(ConstantExpr *OldC, const Type *NewTy) {
 995       Constant *New;
 996       switch (OldC->getOpcode()) {
 997       case Instruction::Cast:
 998         New = ConstantExpr::getCast(OldC->getOperand(0), NewTy);
 999         break;
1000       case Instruction::Shl:
1001       case Instruction::Shr:
1002         New = ConstantExpr::getShiftTy(NewTy, OldC->getOpcode(),
1003                                      OldC->getOperand(0), OldC->getOperand(1));
1004         break;
1005       default:
1006         assert(OldC->getOpcode() >= Instruction::BinaryOpsBegin &&
1007                OldC->getOpcode() < Instruction::BinaryOpsEnd);
1008         New = ConstantExpr::getTy(NewTy, OldC->getOpcode(), OldC->getOperand(0),
1009                                   OldC->getOperand(1));
1010         break;
1011       case Instruction::GetElementPtr:
1012         // Make everyone now use a constant of the new type...
1013         std::vector<Constant*> C;
1014         for (unsigned i = 1, e = OldC->getNumOperands(); i != e; ++i)
1015           C.push_back(cast<Constant>(OldC->getOperand(i)));
1016         New = ConstantExpr::getGetElementPtrTy(NewTy, OldC->getOperand(0), C);
1017         break;
1018       }
1019
1020       assert(New != OldC && "Didn't replace constant??");
1021       OldC->uncheckedReplaceAllUsesWith(New);
1022       OldC->destroyConstant();    // This constant is now dead, destroy it.
1023     }
1024   };
1025 } // end namespace llvm
1026
1027
1028 static ValueMap<ExprMapKeyType, Type, ConstantExpr> ExprConstants;
1029
1030 Constant *ConstantExpr::getCast(Constant *C, const Type *Ty) {
1031   assert(Ty->isFirstClassType() && "Cannot cast to an aggregate type!");
1032
1033   if (Constant *FC = ConstantFoldCastInstruction(C, Ty))
1034     return FC;          // Fold a few common cases...
1035
1036   // Look up the constant in the table first to ensure uniqueness
1037   std::vector<Constant*> argVec(1, C);
1038   ExprMapKeyType Key = std::make_pair(Instruction::Cast, argVec);
1039   return ExprConstants.getOrCreate(Ty, Key);
1040 }
1041
1042 Constant *ConstantExpr::getTy(const Type *ReqTy, unsigned Opcode,
1043                               Constant *C1, Constant *C2) {
1044   if (Opcode == Instruction::Shl || Opcode == Instruction::Shr)
1045     return getShiftTy(ReqTy, Opcode, C1, C2);
1046   // Check the operands for consistency first
1047   assert((Opcode >= Instruction::BinaryOpsBegin &&
1048           Opcode < Instruction::BinaryOpsEnd) &&
1049          "Invalid opcode in binary constant expression");
1050   assert(C1->getType() == C2->getType() &&
1051          "Operand types in binary constant expression should match");
1052
1053   if (ReqTy == C1->getType())
1054     if (Constant *FC = ConstantFoldBinaryInstruction(Opcode, C1, C2))
1055       return FC;          // Fold a few common cases...
1056
1057   std::vector<Constant*> argVec(1, C1); argVec.push_back(C2);
1058   ExprMapKeyType Key = std::make_pair(Opcode, argVec);
1059   return ExprConstants.getOrCreate(ReqTy, Key);
1060 }
1061
1062 /// getShiftTy - Return a shift left or shift right constant expr
1063 Constant *ConstantExpr::getShiftTy(const Type *ReqTy, unsigned Opcode,
1064                                    Constant *C1, Constant *C2) {
1065   // Check the operands for consistency first
1066   assert((Opcode == Instruction::Shl ||
1067           Opcode == Instruction::Shr) &&
1068          "Invalid opcode in binary constant expression");
1069   assert(C1->getType()->isIntegral() && C2->getType() == Type::UByteTy &&
1070          "Invalid operand types for Shift constant expr!");
1071
1072   if (Constant *FC = ConstantFoldBinaryInstruction(Opcode, C1, C2))
1073     return FC;          // Fold a few common cases...
1074
1075   // Look up the constant in the table first to ensure uniqueness
1076   std::vector<Constant*> argVec(1, C1); argVec.push_back(C2);
1077   ExprMapKeyType Key = std::make_pair(Opcode, argVec);
1078   return ExprConstants.getOrCreate(ReqTy, Key);
1079 }
1080
1081
1082 Constant *ConstantExpr::getGetElementPtrTy(const Type *ReqTy, Constant *C,
1083                                         const std::vector<Constant*> &IdxList) {
1084   if (Constant *FC = ConstantFoldGetElementPtr(C, IdxList))
1085     return FC;          // Fold a few common cases...
1086   assert(isa<PointerType>(C->getType()) &&
1087          "Non-pointer type for constant GetElementPtr expression");
1088
1089   // Look up the constant in the table first to ensure uniqueness
1090   std::vector<Constant*> argVec(1, C);
1091   argVec.insert(argVec.end(), IdxList.begin(), IdxList.end());
1092   const ExprMapKeyType &Key = std::make_pair(Instruction::GetElementPtr,argVec);
1093   return ExprConstants.getOrCreate(ReqTy, Key);
1094 }
1095
1096 Constant *ConstantExpr::getGetElementPtr(Constant *C,
1097                                          const std::vector<Constant*> &IdxList){
1098   // Get the result type of the getelementptr!
1099   std::vector<Value*> VIdxList(IdxList.begin(), IdxList.end());
1100
1101   const Type *Ty = GetElementPtrInst::getIndexedType(C->getType(), VIdxList,
1102                                                      true);
1103   assert(Ty && "GEP indices invalid!");
1104
1105   if (C->isNullValue()) {
1106     bool isNull = true;
1107     for (unsigned i = 0, e = IdxList.size(); i != e; ++i)
1108       if (!IdxList[i]->isNullValue()) {
1109         isNull = false;
1110         break;
1111       }
1112     if (isNull) return ConstantPointerNull::get(PointerType::get(Ty));
1113   }
1114
1115   return getGetElementPtrTy(PointerType::get(Ty), C, IdxList);
1116 }
1117
1118
1119 // destroyConstant - Remove the constant from the constant table...
1120 //
1121 void ConstantExpr::destroyConstant() {
1122   ExprConstants.remove(this);
1123   destroyConstantImpl();
1124 }
1125
1126 const char *ConstantExpr::getOpcodeName() const {
1127   return Instruction::getOpcodeName(getOpcode());
1128 }
1129
1130 unsigned Constant::mutateReferences(Value *OldV, Value *NewV) {
1131   // Uses of constant pointer refs are global values, not constants!
1132   if (ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(this)) {
1133     GlobalValue *NewGV = cast<GlobalValue>(NewV);
1134     GlobalValue *OldGV = CPR->getValue();
1135
1136     assert(OldGV == OldV && "Cannot mutate old value if I'm not using it!");
1137     Operands[0] = NewGV;
1138     OldGV->getParent()->mutateConstantPointerRef(OldGV, NewGV);
1139     return 1;
1140   } else {
1141     Constant *NewC = cast<Constant>(NewV);
1142     unsigned NumReplaced = 0;
1143     for (unsigned i = 0, N = getNumOperands(); i != N; ++i)
1144       if (Operands[i] == OldV) {
1145         ++NumReplaced;
1146         Operands[i] = NewC;
1147       }
1148     return NumReplaced;
1149   }
1150 }
1151