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