lib/VMCore/Type.cpp

   1 //===-- Type.cpp - Implement the Type class -------------------------------===//
   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 Type class for the VMCore library.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/AbstractTypeUser.h"
  15 #include "llvm/DerivedTypes.h"
  16 #include "llvm/ParameterAttributes.h"
  17 #include "llvm/Constants.h"
  18 #include "llvm/ADT/DepthFirstIterator.h"
  19 #include "llvm/ADT/StringExtras.h"
  20 #include "llvm/ADT/SCCIterator.h"
  21 #include "llvm/ADT/STLExtras.h"
  22 #include "llvm/Support/MathExtras.h"
  23 #include "llvm/Support/Compiler.h"
  24 #include "llvm/Support/ManagedStatic.h"
  25 #include "llvm/Support/Debug.h"
  26 #include <algorithm>
  27 using namespace llvm;
  28
  29 // DEBUG_MERGE_TYPES - Enable this #define to see how and when derived types are
  30 // created and later destroyed, all in an effort to make sure that there is only
  31 // a single canonical version of a type.
  32 //
  33 // #define DEBUG_MERGE_TYPES 1
  34
  35 AbstractTypeUser::~AbstractTypeUser() {}
  36
  37
  38 //===----------------------------------------------------------------------===//
  39 //                         Type PATypeHolder Implementation
  40 //===----------------------------------------------------------------------===//
  41
  42 /// get - This implements the forwarding part of the union-find algorithm for
  43 /// abstract types.  Before every access to the Type*, we check to see if the
  44 /// type we are pointing to is forwarding to a new type.  If so, we drop our
  45 /// reference to the type.
  46 ///
  47 Type* PATypeHolder::get() const {
  48   const Type *NewTy = Ty->getForwardedType();
  49   if (!NewTy) return const_cast<Type*>(Ty);
  50   return *const_cast<PATypeHolder*>(this) = NewTy;
  51 }
  52
  53 //===----------------------------------------------------------------------===//
  54 //                         Type Class Implementation
  55 //===----------------------------------------------------------------------===//
  56
  57 // Concrete/Abstract TypeDescriptions - We lazily calculate type descriptions
  58 // for types as they are needed.  Because resolution of types must invalidate
  59 // all of the abstract type descriptions, we keep them in a seperate map to make
  60 // this easy.
  61 static ManagedStatic<std::map<const Type*,
  62                               std::string> > ConcreteTypeDescriptions;
  63 static ManagedStatic<std::map<const Type*,
  64                               std::string> > AbstractTypeDescriptions;
  65
  66 /// Because of the way Type subclasses are allocated, this function is necessary
  67 /// to use the correct kind of "delete" operator to deallocate the Type object.
  68 /// Some type objects (FunctionTy, StructTy) allocate additional space after
  69 /// the space for their derived type to hold the contained types array of
  70 /// PATypeHandles. Using this allocation scheme means all the PATypeHandles are
  71 /// allocated with the type object, decreasing allocations and eliminating the
  72 /// need for a std::vector to be used in the Type class itself.
  73 /// @brief Type destruction function
  74 void Type::destroy() const {
  75
  76   // Structures and Functions allocate their contained types past the end of
  77   // the type object itself. These need to be destroyed differently than the
  78   // other types.
  79   if (isa<FunctionType>(this) || isa<StructType>(this)) {
  80     // First, make sure we destruct any PATypeHandles allocated by these
  81     // subclasses.  They must be manually destructed.
  82     for (unsigned i = 0; i < NumContainedTys; ++i)
  83       ContainedTys[i].PATypeHandle::~PATypeHandle();
  84
  85     // Now call the destructor for the subclass directly because we're going
  86     // to delete this as an array of char.
  87     if (isa<FunctionType>(this))
  88       ((FunctionType*)this)->FunctionType::~FunctionType();
  89     else
  90       ((StructType*)this)->StructType::~StructType();
  91
  92     // Finally, remove the memory as an array deallocation of the chars it was
  93     // constructed from.
  94     delete [] reinterpret_cast<const char*>(this);
  95
  96     return;
  97   }
  98
  99   // For all the other type subclasses, there is either no contained types or
 100   // just one (all Sequentials). For Sequentials, the PATypeHandle is not
 101   // allocated past the type object, its included directly in the SequentialType
 102   // class. This means we can safely just do "normal" delete of this object and
 103   // all the destructors that need to run will be run.
 104   delete this;
 105 }
 106
 107 const Type *Type::getPrimitiveType(TypeID IDNumber) {
 108   switch (IDNumber) {
 109   case VoidTyID  : return VoidTy;
 110   case FloatTyID : return FloatTy;
 111   case DoubleTyID: return DoubleTy;
 112   case LabelTyID : return LabelTy;
 113   default:
 114     return 0;
 115   }
 116 }
 117
 118 const Type *Type::getVAArgsPromotedType() const {
 119   if (ID == IntegerTyID && getSubclassData() < 32)
 120     return Type::Int32Ty;
 121   else if (ID == FloatTyID)
 122     return Type::DoubleTy;
 123   else
 124     return this;
 125 }
 126
 127 /// isFPOrFPVector - Return true if this is a FP type or a vector of FP types.
 128 ///
 129 bool Type::isFPOrFPVector() const {
 130   if (ID == Type::FloatTyID || ID == Type::DoubleTyID) return true;
 131   if (ID != Type::VectorTyID) return false;
 132
 133   return cast<VectorType>(this)->getElementType()->isFloatingPoint();
 134 }
 135
 136 // canLosslesllyBitCastTo - Return true if this type can be converted to
 137 // 'Ty' without any reinterpretation of bits.  For example, uint to int.
 138 //
 139 bool Type::canLosslesslyBitCastTo(const Type *Ty) const {
 140   // Identity cast means no change so return true
 141   if (this == Ty)
 142     return true;
 143
 144   // They are not convertible unless they are at least first class types
 145   if (!this->isFirstClassType() || !Ty->isFirstClassType())
 146     return false;
 147
 148   // Vector -> Vector conversions are always lossless if the two vector types
 149   // have the same size, otherwise not.
 150   if (const VectorType *thisPTy = dyn_cast<VectorType>(this))
 151     if (const VectorType *thatPTy = dyn_cast<VectorType>(Ty))
 152       return thisPTy->getBitWidth() == thatPTy->getBitWidth();
 153
 154   // At this point we have only various mismatches of the first class types
 155   // remaining and ptr->ptr. Just select the lossless conversions. Everything
 156   // else is not lossless.
 157   if (isa<PointerType>(this))
 158     return isa<PointerType>(Ty);
 159   return false;  // Other types have no identity values
 160 }
 161
 162 unsigned Type::getPrimitiveSizeInBits() const {
 163   switch (getTypeID()) {
 164   case Type::FloatTyID: return 32;
 165   case Type::DoubleTyID: return 64;
 166   case Type::IntegerTyID: return cast<IntegerType>(this)->getBitWidth();
 167   case Type::VectorTyID:  return cast<VectorType>(this)->getBitWidth();
 168   default: return 0;
 169   }
 170 }
 171
 172 /// isSizedDerivedType - Derived types like structures and arrays are sized
 173 /// iff all of the members of the type are sized as well.  Since asking for
 174 /// their size is relatively uncommon, move this operation out of line.
 175 bool Type::isSizedDerivedType() const {
 176   if (isa<IntegerType>(this))
 177     return true;
 178
 179   if (const ArrayType *ATy = dyn_cast<ArrayType>(this))
 180     return ATy->getElementType()->isSized();
 181
 182   if (const VectorType *PTy = dyn_cast<VectorType>(this))
 183     return PTy->getElementType()->isSized();
 184
 185   if (!isa<StructType>(this))
 186     return false;
 187
 188   // Okay, our struct is sized if all of the elements are...
 189   for (subtype_iterator I = subtype_begin(), E = subtype_end(); I != E; ++I)
 190     if (!(*I)->isSized())
 191       return false;
 192
 193   return true;
 194 }
 195
 196 /// getForwardedTypeInternal - This method is used to implement the union-find
 197 /// algorithm for when a type is being forwarded to another type.
 198 const Type *Type::getForwardedTypeInternal() const {
 199   assert(ForwardType && "This type is not being forwarded to another type!");
 200
 201   // Check to see if the forwarded type has been forwarded on.  If so, collapse
 202   // the forwarding links.
 203   const Type *RealForwardedType = ForwardType->getForwardedType();
 204   if (!RealForwardedType)
 205     return ForwardType;  // No it's not forwarded again
 206
 207   // Yes, it is forwarded again.  First thing, add the reference to the new
 208   // forward type.
 209   if (RealForwardedType->isAbstract())
 210     cast<DerivedType>(RealForwardedType)->addRef();
 211
 212   // Now drop the old reference.  This could cause ForwardType to get deleted.
 213   cast<DerivedType>(ForwardType)->dropRef();
 214
 215   // Return the updated type.
 216   ForwardType = RealForwardedType;
 217   return ForwardType;
 218 }
 219
 220 void Type::refineAbstractType(const DerivedType *OldTy, const Type *NewTy) {
 221   abort();
 222 }
 223 void Type::typeBecameConcrete(const DerivedType *AbsTy) {
 224   abort();
 225 }
 226
 227
 228 // getTypeDescription - This is a recursive function that walks a type hierarchy
 229 // calculating the description for a type.
 230 //
 231 static std::string getTypeDescription(const Type *Ty,
 232                                       std::vector<const Type *> &TypeStack) {
 233   if (isa<OpaqueType>(Ty)) {                     // Base case for the recursion
 234     std::map<const Type*, std::string>::iterator I =
 235       AbstractTypeDescriptions->lower_bound(Ty);
 236     if (I != AbstractTypeDescriptions->end() && I->first == Ty)
 237       return I->second;
 238     std::string Desc = "opaque";
 239     AbstractTypeDescriptions->insert(std::make_pair(Ty, Desc));
 240     return Desc;
 241   }
 242
 243   if (!Ty->isAbstract()) {                       // Base case for the recursion
 244     std::map<const Type*, std::string>::iterator I =
 245       ConcreteTypeDescriptions->find(Ty);
 246     if (I != ConcreteTypeDescriptions->end())
 247       return I->second;
 248
 249     if (Ty->isPrimitiveType()) {
 250       switch (Ty->getTypeID()) {
 251       default: assert(0 && "Unknown prim type!");
 252       case Type::VoidTyID:   return (*ConcreteTypeDescriptions)[Ty] = "void";
 253       case Type::FloatTyID:  return (*ConcreteTypeDescriptions)[Ty] = "float";
 254       case Type::DoubleTyID: return (*ConcreteTypeDescriptions)[Ty] = "double";
 255       case Type::LabelTyID:  return (*ConcreteTypeDescriptions)[Ty] = "label";
 256       }
 257     }
 258   }
 259
 260   // Check to see if the Type is already on the stack...
 261   unsigned Slot = 0, CurSize = TypeStack.size();
 262   while (Slot < CurSize && TypeStack[Slot] != Ty) ++Slot; // Scan for type
 263
 264   // This is another base case for the recursion.  In this case, we know
 265   // that we have looped back to a type that we have previously visited.
 266   // Generate the appropriate upreference to handle this.
 267   //
 268   if (Slot < CurSize)
 269     return "\\" + utostr(CurSize-Slot);         // Here's the upreference
 270
 271   // Recursive case: derived types...
 272   std::string Result;
 273   TypeStack.push_back(Ty);    // Add us to the stack..
 274
 275   switch (Ty->getTypeID()) {
 276   case Type::IntegerTyID: {
 277     const IntegerType *ITy = cast<IntegerType>(Ty);
 278     Result = "i" + utostr(ITy->getBitWidth());
 279     break;
 280   }
 281   case Type::FunctionTyID: {
 282     const FunctionType *FTy = cast<FunctionType>(Ty);
 283     if (!Result.empty())
 284       Result += " ";
 285     Result += getTypeDescription(FTy->getReturnType(), TypeStack) + " (";
 286     unsigned Idx = 1;
 287     const ParamAttrsList *Attrs = FTy->getParamAttrs();
 288     for (FunctionType::param_iterator I = FTy->param_begin(),
 289            E = FTy->param_end(); I != E; ++I) {
 290       if (I != FTy->param_begin())
 291         Result += ", ";
 292       if (Attrs && Attrs->getParamAttrs(Idx) != ParamAttr::None)
 293         Result += Attrs->getParamAttrsTextByIndex(Idx);
 294       Idx++;
 295       Result += getTypeDescription(*I, TypeStack);
 296     }
 297     if (FTy->isVarArg()) {
 298       if (FTy->getNumParams()) Result += ", ";
 299       Result += "...";
 300     }
 301     Result += ")";
 302     if (Attrs && Attrs->getParamAttrs(0) != ParamAttr::None) {
 303       Result += " " + Attrs->getParamAttrsTextByIndex(0);
 304     }
 305     break;
 306   }
 307   case Type::PackedStructTyID:
 308   case Type::StructTyID: {
 309     const StructType *STy = cast<StructType>(Ty);
 310     if (STy->isPacked())
 311       Result = "<{ ";
 312     else
 313       Result = "{ ";
 314     for (StructType::element_iterator I = STy->element_begin(),
 315            E = STy->element_end(); I != E; ++I) {
 316       if (I != STy->element_begin())
 317         Result += ", ";
 318       Result += getTypeDescription(*I, TypeStack);
 319     }
 320     Result += " }";
 321     if (STy->isPacked())
 322       Result += ">";
 323     break;
 324   }
 325   case Type::PointerTyID: {
 326     const PointerType *PTy = cast<PointerType>(Ty);
 327     Result = getTypeDescription(PTy->getElementType(), TypeStack) + " *";
 328     break;
 329   }
 330   case Type::ArrayTyID: {
 331     const ArrayType *ATy = cast<ArrayType>(Ty);
 332     unsigned NumElements = ATy->getNumElements();
 333     Result = "[";
 334     Result += utostr(NumElements) + " x ";
 335     Result += getTypeDescription(ATy->getElementType(), TypeStack) + "]";
 336     break;
 337   }
 338   case Type::VectorTyID: {
 339     const VectorType *PTy = cast<VectorType>(Ty);
 340     unsigned NumElements = PTy->getNumElements();
 341     Result = "<";
 342     Result += utostr(NumElements) + " x ";
 343     Result += getTypeDescription(PTy->getElementType(), TypeStack) + ">";
 344     break;
 345   }
 346   default:
 347     Result = "<error>";
 348     assert(0 && "Unhandled type in getTypeDescription!");
 349   }
 350
 351   TypeStack.pop_back();       // Remove self from stack...
 352
 353   return Result;
 354 }
 355
 356
 357
 358 static const std::string &getOrCreateDesc(std::map<const Type*,std::string>&Map,
 359                                           const Type *Ty) {
 360   std::map<const Type*, std::string>::iterator I = Map.find(Ty);
 361   if (I != Map.end()) return I->second;
 362
 363   std::vector<const Type *> TypeStack;
 364   std::string Result = getTypeDescription(Ty, TypeStack);
 365   return Map[Ty] = Result;
 366 }
 367
 368
 369 const std::string &Type::getDescription() const {
 370   if (isAbstract())
 371     return getOrCreateDesc(*AbstractTypeDescriptions, this);
 372   else
 373     return getOrCreateDesc(*ConcreteTypeDescriptions, this);
 374 }
 375
 376
 377 bool StructType::indexValid(const Value *V) const {
 378   // Structure indexes require 32-bit integer constants.
 379   if (V->getType() == Type::Int32Ty)
 380     if (const ConstantInt *CU = dyn_cast<ConstantInt>(V))
 381       return CU->getZExtValue() < NumContainedTys;
 382   return false;
 383 }
 384
 385 // getTypeAtIndex - Given an index value into the type, return the type of the
 386 // element.  For a structure type, this must be a constant value...
 387 //
 388 const Type *StructType::getTypeAtIndex(const Value *V) const {
 389   assert(indexValid(V) && "Invalid structure index!");
 390   unsigned Idx = (unsigned)cast<ConstantInt>(V)->getZExtValue();
 391   return ContainedTys[Idx];
 392 }
 393
 394 //===----------------------------------------------------------------------===//
 395 //                          Primitive 'Type' data
 396 //===----------------------------------------------------------------------===//
 397
 398 const Type *Type::VoidTy   = new Type(Type::VoidTyID);
 399 const Type *Type::FloatTy  = new Type(Type::FloatTyID);
 400 const Type *Type::DoubleTy = new Type(Type::DoubleTyID);
 401 const Type *Type::LabelTy  = new Type(Type::LabelTyID);
 402
 403 namespace {
 404   struct BuiltinIntegerType : public IntegerType {
 405     BuiltinIntegerType(unsigned W) : IntegerType(W) {}
 406   };
 407 }
 408 const IntegerType *Type::Int1Ty  = new BuiltinIntegerType(1);
 409 const IntegerType *Type::Int8Ty  = new BuiltinIntegerType(8);
 410 const IntegerType *Type::Int16Ty = new BuiltinIntegerType(16);
 411 const IntegerType *Type::Int32Ty = new BuiltinIntegerType(32);
 412 const IntegerType *Type::Int64Ty = new BuiltinIntegerType(64);
 413
 414
 415 //===----------------------------------------------------------------------===//
 416 //                          Derived Type Constructors
 417 //===----------------------------------------------------------------------===//
 418
 419 FunctionType::FunctionType(const Type *Result,
 420                            const std::vector<const Type*> &Params,
 421                            bool IsVarArgs, ParamAttrsList *Attrs)
 422   : DerivedType(FunctionTyID), isVarArgs(IsVarArgs), ParamAttrs(Attrs) {
 423   ContainedTys = reinterpret_cast<PATypeHandle*>(this+1);
 424   NumContainedTys = Params.size() + 1; // + 1 for result type
 425   assert((Result->isFirstClassType() || Result == Type::VoidTy ||
 426          isa<OpaqueType>(Result)) &&
 427          "LLVM functions cannot return aggregates");
 428   bool isAbstract = Result->isAbstract();
 429   new (&ContainedTys[0]) PATypeHandle(Result, this);
 430
 431   for (unsigned i = 0; i != Params.size(); ++i) {
 432     assert((Params[i]->isFirstClassType() || isa<OpaqueType>(Params[i])) &&
 433            "Function arguments must be value types!");
 434     new (&ContainedTys[i+1]) PATypeHandle(Params[i],this);
 435     isAbstract |= Params[i]->isAbstract();
 436   }
 437
 438   // Calculate whether or not this type is abstract
 439   setAbstract(isAbstract);
 440 }
 441
 442 StructType::StructType(const std::vector<const Type*> &Types, bool isPacked)
 443   : CompositeType(StructTyID) {
 444   ContainedTys = reinterpret_cast<PATypeHandle*>(this + 1);
 445   NumContainedTys = Types.size();
 446   setSubclassData(isPacked);
 447   bool isAbstract = false;
 448   for (unsigned i = 0; i < Types.size(); ++i) {
 449     assert(Types[i] != Type::VoidTy && "Void type for structure field!!");
 450      new (&ContainedTys[i]) PATypeHandle(Types[i], this);
 451     isAbstract |= Types[i]->isAbstract();
 452   }
 453
 454   // Calculate whether or not this type is abstract
 455   setAbstract(isAbstract);
 456 }
 457
 458 ArrayType::ArrayType(const Type *ElType, uint64_t NumEl)
 459   : SequentialType(ArrayTyID, ElType) {
 460   NumElements = NumEl;
 461
 462   // Calculate whether or not this type is abstract
 463   setAbstract(ElType->isAbstract());
 464 }
 465
 466 VectorType::VectorType(const Type *ElType, unsigned NumEl)
 467   : SequentialType(VectorTyID, ElType) {
 468   NumElements = NumEl;
 469   setAbstract(ElType->isAbstract());
 470   assert(NumEl > 0 && "NumEl of a VectorType must be greater than 0");
 471   assert((ElType->isInteger() || ElType->isFloatingPoint() ||
 472           isa<OpaqueType>(ElType)) &&
 473          "Elements of a VectorType must be a primitive type");
 474
 475 }
 476
 477
 478 PointerType::PointerType(const Type *E) : SequentialType(PointerTyID, E) {
 479   // Calculate whether or not this type is abstract
 480   setAbstract(E->isAbstract());
 481 }
 482
 483 OpaqueType::OpaqueType() : DerivedType(OpaqueTyID) {
 484   setAbstract(true);
 485 #ifdef DEBUG_MERGE_TYPES
 486   DOUT << "Derived new type: " << *this << "\n";
 487 #endif
 488 }
 489
 490 // dropAllTypeUses - When this (abstract) type is resolved to be equal to
 491 // another (more concrete) type, we must eliminate all references to other
 492 // types, to avoid some circular reference problems.
 493 void DerivedType::dropAllTypeUses() {
 494   if (NumContainedTys != 0) {
 495     // The type must stay abstract.  To do this, we insert a pointer to a type
 496     // that will never get resolved, thus will always be abstract.
 497     static Type *AlwaysOpaqueTy = OpaqueType::get();
 498     static PATypeHolder Holder(AlwaysOpaqueTy);
 499     ContainedTys[0] = AlwaysOpaqueTy;
 500
 501     // Change the rest of the types to be Int32Ty's.  It doesn't matter what we
 502     // pick so long as it doesn't point back to this type.  We choose something
 503     // concrete to avoid overhead for adding to AbstracTypeUser lists and stuff.
 504     for (unsigned i = 1, e = NumContainedTys; i != e; ++i)
 505       ContainedTys[i] = Type::Int32Ty;
 506   }
 507 }
 508
 509
 510
 511 /// TypePromotionGraph and graph traits - this is designed to allow us to do
 512 /// efficient SCC processing of type graphs.  This is the exact same as
 513 /// GraphTraits<Type*>, except that we pretend that concrete types have no
 514 /// children to avoid processing them.
 515 struct TypePromotionGraph {
 516   Type *Ty;
 517   TypePromotionGraph(Type *T) : Ty(T) {}
 518 };
 519
 520 namespace llvm {
 521   template <> struct GraphTraits<TypePromotionGraph> {
 522     typedef Type NodeType;
 523     typedef Type::subtype_iterator ChildIteratorType;
 524
 525     static inline NodeType *getEntryNode(TypePromotionGraph G) { return G.Ty; }
 526     static inline ChildIteratorType child_begin(NodeType *N) {
 527       if (N->isAbstract())
 528         return N->subtype_begin();
 529       else           // No need to process children of concrete types.
 530         return N->subtype_end();
 531     }
 532     static inline ChildIteratorType child_end(NodeType *N) {
 533       return N->subtype_end();
 534     }
 535   };
 536 }
 537
 538
 539 // PromoteAbstractToConcrete - This is a recursive function that walks a type
 540 // graph calculating whether or not a type is abstract.
 541 //
 542 void Type::PromoteAbstractToConcrete() {
 543   if (!isAbstract()) return;
 544
 545   scc_iterator<TypePromotionGraph> SI = scc_begin(TypePromotionGraph(this));
 546   scc_iterator<TypePromotionGraph> SE = scc_end  (TypePromotionGraph(this));
 547
 548   for (; SI != SE; ++SI) {
 549     std::vector<Type*> &SCC = *SI;
 550
 551     // Concrete types are leaves in the tree.  Since an SCC will either be all
 552     // abstract or all concrete, we only need to check one type.
 553     if (SCC[0]->isAbstract()) {
 554       if (isa<OpaqueType>(SCC[0]))
 555         return;     // Not going to be concrete, sorry.
 556
 557       // If all of the children of all of the types in this SCC are concrete,
 558       // then this SCC is now concrete as well.  If not, neither this SCC, nor
 559       // any parent SCCs will be concrete, so we might as well just exit.
 560       for (unsigned i = 0, e = SCC.size(); i != e; ++i)
 561         for (Type::subtype_iterator CI = SCC[i]->subtype_begin(),
 562                E = SCC[i]->subtype_end(); CI != E; ++CI)
 563           if ((*CI)->isAbstract())
 564             // If the child type is in our SCC, it doesn't make the entire SCC
 565             // abstract unless there is a non-SCC abstract type.
 566             if (std::find(SCC.begin(), SCC.end(), *CI) == SCC.end())
 567               return;               // Not going to be concrete, sorry.
 568
 569       // Okay, we just discovered this whole SCC is now concrete, mark it as
 570       // such!
 571       for (unsigned i = 0, e = SCC.size(); i != e; ++i) {
 572         assert(SCC[i]->isAbstract() && "Why are we processing concrete types?");
 573
 574         SCC[i]->setAbstract(false);
 575       }
 576
 577       for (unsigned i = 0, e = SCC.size(); i != e; ++i) {
 578         assert(!SCC[i]->isAbstract() && "Concrete type became abstract?");
 579         // The type just became concrete, notify all users!
 580         cast<DerivedType>(SCC[i])->notifyUsesThatTypeBecameConcrete();
 581       }
 582     }
 583   }
 584 }
 585
 586
 587 //===----------------------------------------------------------------------===//
 588 //                      Type Structural Equality Testing
 589 //===----------------------------------------------------------------------===//
 590
 591 // TypesEqual - Two types are considered structurally equal if they have the
 592 // same "shape": Every level and element of the types have identical primitive
 593 // ID's, and the graphs have the same edges/nodes in them.  Nodes do not have to
 594 // be pointer equals to be equivalent though.  This uses an optimistic algorithm
 595 // that assumes that two graphs are the same until proven otherwise.
 596 //
 597 static bool TypesEqual(const Type *Ty, const Type *Ty2,
 598                        std::map<const Type *, const Type *> &EqTypes) {
 599   if (Ty == Ty2) return true;
 600   if (Ty->getTypeID() != Ty2->getTypeID()) return false;
 601   if (isa<OpaqueType>(Ty))
 602     return false;  // Two unequal opaque types are never equal
 603
 604   std::map<const Type*, const Type*>::iterator It = EqTypes.lower_bound(Ty);
 605   if (It != EqTypes.end() && It->first == Ty)
 606     return It->second == Ty2;    // Looping back on a type, check for equality
 607
 608   // Otherwise, add the mapping to the table to make sure we don't get
 609   // recursion on the types...
 610   EqTypes.insert(It, std::make_pair(Ty, Ty2));
 611
 612   // Two really annoying special cases that breaks an otherwise nice simple
 613   // algorithm is the fact that arraytypes have sizes that differentiates types,
 614   // and that function types can be varargs or not.  Consider this now.
 615   //
 616   if (const IntegerType *ITy = dyn_cast<IntegerType>(Ty)) {
 617     const IntegerType *ITy2 = cast<IntegerType>(Ty2);
 618     return ITy->getBitWidth() == ITy2->getBitWidth();
 619   } else if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
 620     return TypesEqual(PTy->getElementType(),
 621                       cast<PointerType>(Ty2)->getElementType(), EqTypes);
 622   } else if (const StructType *STy = dyn_cast<StructType>(Ty)) {
 623     const StructType *STy2 = cast<StructType>(Ty2);
 624     if (STy->getNumElements() != STy2->getNumElements()) return false;
 625     if (STy->isPacked() != STy2->isPacked()) return false;
 626     for (unsigned i = 0, e = STy2->getNumElements(); i != e; ++i)
 627       if (!TypesEqual(STy->getElementType(i), STy2->getElementType(i), EqTypes))
 628         return false;
 629     return true;
 630   } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
 631     const ArrayType *ATy2 = cast<ArrayType>(Ty2);
 632     return ATy->getNumElements() == ATy2->getNumElements() &&
 633            TypesEqual(ATy->getElementType(), ATy2->getElementType(), EqTypes);
 634   } else if (const VectorType *PTy = dyn_cast<VectorType>(Ty)) {
 635     const VectorType *PTy2 = cast<VectorType>(Ty2);
 636     return PTy->getNumElements() == PTy2->getNumElements() &&
 637            TypesEqual(PTy->getElementType(), PTy2->getElementType(), EqTypes);
 638   } else if (const FunctionType *FTy = dyn_cast<FunctionType>(Ty)) {
 639     const FunctionType *FTy2 = cast<FunctionType>(Ty2);
 640     if (FTy->isVarArg() != FTy2->isVarArg() ||
 641         FTy->getNumParams() != FTy2->getNumParams() ||
 642         !TypesEqual(FTy->getReturnType(), FTy2->getReturnType(), EqTypes))
 643       return false;
 644     const ParamAttrsList *Attrs1 = FTy->getParamAttrs();
 645     const ParamAttrsList *Attrs2 = FTy2->getParamAttrs();
 646     if ((!Attrs1 && Attrs2) || (!Attrs2 && Attrs1) ||
 647         (Attrs1 && Attrs2 && (Attrs1->size() != Attrs2->size() ||
 648          (Attrs1->getParamAttrs(0) != Attrs2->getParamAttrs(0)))))
 649       return false;
 650
 651     for (unsigned i = 0, e = FTy2->getNumParams(); i != e; ++i) {
 652       if (Attrs1 && Attrs1->getParamAttrs(i+1) != Attrs2->getParamAttrs(i+1))
 653         return false;
 654       if (!TypesEqual(FTy->getParamType(i), FTy2->getParamType(i), EqTypes))
 655         return false;
 656     }
 657     return true;
 658   } else {
 659     assert(0 && "Unknown derived type!");
 660     return false;
 661   }
 662 }
 663
 664 static bool TypesEqual(const Type *Ty, const Type *Ty2) {
 665   std::map<const Type *, const Type *> EqTypes;
 666   return TypesEqual(Ty, Ty2, EqTypes);
 667 }
 668
 669 // AbstractTypeHasCycleThrough - Return true there is a path from CurTy to
 670 // TargetTy in the type graph.  We know that Ty is an abstract type, so if we
 671 // ever reach a non-abstract type, we know that we don't need to search the
 672 // subgraph.
 673 static bool AbstractTypeHasCycleThrough(const Type *TargetTy, const Type *CurTy,
 674                                 std::set<const Type*> &VisitedTypes) {
 675   if (TargetTy == CurTy) return true;
 676   if (!CurTy->isAbstract()) return false;
 677
 678   if (!VisitedTypes.insert(CurTy).second)
 679     return false;  // Already been here.
 680
 681   for (Type::subtype_iterator I = CurTy->subtype_begin(),
 682        E = CurTy->subtype_end(); I != E; ++I)
 683     if (AbstractTypeHasCycleThrough(TargetTy, *I, VisitedTypes))
 684       return true;
 685   return false;
 686 }
 687
 688 static bool ConcreteTypeHasCycleThrough(const Type *TargetTy, const Type *CurTy,
 689                                         std::set<const Type*> &VisitedTypes) {
 690   if (TargetTy == CurTy) return true;
 691
 692   if (!VisitedTypes.insert(CurTy).second)
 693     return false;  // Already been here.
 694
 695   for (Type::subtype_iterator I = CurTy->subtype_begin(),
 696        E = CurTy->subtype_end(); I != E; ++I)
 697     if (ConcreteTypeHasCycleThrough(TargetTy, *I, VisitedTypes))
 698       return true;
 699   return false;
 700 }
 701
 702 /// TypeHasCycleThroughItself - Return true if the specified type has a cycle
 703 /// back to itself.
 704 static bool TypeHasCycleThroughItself(const Type *Ty) {
 705   std::set<const Type*> VisitedTypes;
 706
 707   if (Ty->isAbstract()) {  // Optimized case for abstract types.
 708     for (Type::subtype_iterator I = Ty->subtype_begin(), E = Ty->subtype_end();
 709          I != E; ++I)
 710       if (AbstractTypeHasCycleThrough(Ty, *I, VisitedTypes))
 711         return true;
 712   } else {
 713     for (Type::subtype_iterator I = Ty->subtype_begin(), E = Ty->subtype_end();
 714          I != E; ++I)
 715       if (ConcreteTypeHasCycleThrough(Ty, *I, VisitedTypes))
 716         return true;
 717   }
 718   return false;
 719 }
 720
 721 /// getSubElementHash - Generate a hash value for all of the SubType's of this
 722 /// type.  The hash value is guaranteed to be zero if any of the subtypes are
 723 /// an opaque type.  Otherwise we try to mix them in as well as possible, but do
 724 /// not look at the subtype's subtype's.
 725 static unsigned getSubElementHash(const Type *Ty) {
 726   unsigned HashVal = 0;
 727   for (Type::subtype_iterator I = Ty->subtype_begin(), E = Ty->subtype_end();
 728        I != E; ++I) {
 729     HashVal *= 32;
 730     const Type *SubTy = I->get();
 731     HashVal += SubTy->getTypeID();
 732     switch (SubTy->getTypeID()) {
 733     default: break;
 734     case Type::OpaqueTyID: return 0;    // Opaque -> hash = 0 no matter what.
 735     case Type::IntegerTyID:
 736       HashVal ^= (cast<IntegerType>(SubTy)->getBitWidth() << 3);
 737       break;
 738     case Type::FunctionTyID:
 739       HashVal ^= cast<FunctionType>(SubTy)->getNumParams()*2 +
 740                  cast<FunctionType>(SubTy)->isVarArg();
 741       break;
 742     case Type::ArrayTyID:
 743       HashVal ^= cast<ArrayType>(SubTy)->getNumElements();
 744       break;
 745     case Type::VectorTyID:
 746       HashVal ^= cast<VectorType>(SubTy)->getNumElements();
 747       break;
 748     case Type::StructTyID:
 749       HashVal ^= cast<StructType>(SubTy)->getNumElements();
 750       break;
 751     }
 752   }
 753   return HashVal ? HashVal : 1;  // Do not return zero unless opaque subty.
 754 }
 755
 756 //===----------------------------------------------------------------------===//
 757 //                       Derived Type Factory Functions
 758 //===----------------------------------------------------------------------===//
 759
 760 namespace llvm {
 761 class TypeMapBase {
 762 protected:
 763   /// TypesByHash - Keep track of types by their structure hash value.  Note
 764   /// that we only keep track of types that have cycles through themselves in
 765   /// this map.
 766   ///
 767   std::multimap<unsigned, PATypeHolder> TypesByHash;
 768
 769 public:
 770   void RemoveFromTypesByHash(unsigned Hash, const Type *Ty) {
 771     std::multimap<unsigned, PATypeHolder>::iterator I =
 772       TypesByHash.lower_bound(Hash);
 773     for (; I != TypesByHash.end() && I->first == Hash; ++I) {
 774       if (I->second == Ty) {
 775         TypesByHash.erase(I);
 776         return;
 777       }
 778     }
 779
 780     // This must be do to an opaque type that was resolved.  Switch down to hash
 781     // code of zero.
 782     assert(Hash && "Didn't find type entry!");
 783     RemoveFromTypesByHash(0, Ty);
 784   }
 785
 786   /// TypeBecameConcrete - When Ty gets a notification that TheType just became
 787   /// concrete, drop uses and make Ty non-abstract if we should.
 788   void TypeBecameConcrete(DerivedType *Ty, const DerivedType *TheType) {
 789     // If the element just became concrete, remove 'ty' from the abstract
 790     // type user list for the type.  Do this for as many times as Ty uses
 791     // OldType.
 792     for (Type::subtype_iterator I = Ty->subtype_begin(), E = Ty->subtype_end();
 793          I != E; ++I)
 794       if (I->get() == TheType)
 795         TheType->removeAbstractTypeUser(Ty);
 796
 797     // If the type is currently thought to be abstract, rescan all of our
 798     // subtypes to see if the type has just become concrete!  Note that this
 799     // may send out notifications to AbstractTypeUsers that types become
 800     // concrete.
 801     if (Ty->isAbstract())
 802       Ty->PromoteAbstractToConcrete();
 803   }
 804 };
 805 }
 806
 807
 808 // TypeMap - Make sure that only one instance of a particular type may be
 809 // created on any given run of the compiler... note that this involves updating
 810 // our map if an abstract type gets refined somehow.
 811 //
 812 namespace llvm {
 813 template<class ValType, class TypeClass>
 814 class TypeMap : public TypeMapBase {
 815   std::map<ValType, PATypeHolder> Map;
 816 public:
 817   typedef typename std::map<ValType, PATypeHolder>::iterator iterator;
 818   ~TypeMap() { print("ON EXIT"); }
 819
 820   inline TypeClass *get(const ValType &V) {
 821     iterator I = Map.find(V);
 822     return I != Map.end() ? cast<TypeClass>((Type*)I->second.get()) : 0;
 823   }
 824
 825   inline void add(const ValType &V, TypeClass *Ty) {
 826     Map.insert(std::make_pair(V, Ty));
 827
 828     // If this type has a cycle, remember it.
 829     TypesByHash.insert(std::make_pair(ValType::hashTypeStructure(Ty), Ty));
 830     print("add");
 831   }
 832
 833   /// RefineAbstractType - This method is called after we have merged a type
 834   /// with another one.  We must now either merge the type away with
 835   /// some other type or reinstall it in the map with it's new configuration.
 836   void RefineAbstractType(TypeClass *Ty, const DerivedType *OldType,
 837                         const Type *NewType) {
 838 #ifdef DEBUG_MERGE_TYPES
 839     DOUT << "RefineAbstractType(" << (void*)OldType << "[" << *OldType
 840          << "], " << (void*)NewType << " [" << *NewType << "])\n";
 841 #endif
 842
 843     // Otherwise, we are changing one subelement type into another.  Clearly the
 844     // OldType must have been abstract, making us abstract.
 845     assert(Ty->isAbstract() && "Refining a non-abstract type!");
 846     assert(OldType != NewType);
 847
 848     // Make a temporary type holder for the type so that it doesn't disappear on
 849     // us when we erase the entry from the map.
 850     PATypeHolder TyHolder = Ty;
 851
 852     // The old record is now out-of-date, because one of the children has been
 853     // updated.  Remove the obsolete entry from the map.
 854     unsigned NumErased = Map.erase(ValType::get(Ty));
 855     assert(NumErased && "Element not found!");
 856
 857     // Remember the structural hash for the type before we start hacking on it,
 858     // in case we need it later.
 859     unsigned OldTypeHash = ValType::hashTypeStructure(Ty);
 860
 861     // Find the type element we are refining... and change it now!
 862     for (unsigned i = 0, e = Ty->getNumContainedTypes(); i != e; ++i)
 863       if (Ty->ContainedTys[i] == OldType)
 864         Ty->ContainedTys[i] = NewType;
 865     unsigned NewTypeHash = ValType::hashTypeStructure(Ty);
 866
 867     // If there are no cycles going through this node, we can do a simple,
 868     // efficient lookup in the map, instead of an inefficient nasty linear
 869     // lookup.
 870     if (!TypeHasCycleThroughItself(Ty)) {
 871       typename std::map<ValType, PATypeHolder>::iterator I;
 872       bool Inserted;
 873
 874       tie(I, Inserted) = Map.insert(std::make_pair(ValType::get(Ty), Ty));
 875       if (!Inserted) {
 876         // Refined to a different type altogether?
 877         RemoveFromTypesByHash(OldTypeHash, Ty);
 878
 879         // We already have this type in the table.  Get rid of the newly refined
 880         // type.
 881         TypeClass *NewTy = cast<TypeClass>((Type*)I->second.get());
 882         Ty->refineAbstractTypeTo(NewTy);
 883         return;
 884       }
 885     } else {
 886       // Now we check to see if there is an existing entry in the table which is
 887       // structurally identical to the newly refined type.  If so, this type
 888       // gets refined to the pre-existing type.
 889       //
 890       std::multimap<unsigned, PATypeHolder>::iterator I, E, Entry;
 891       tie(I, E) = TypesByHash.equal_range(NewTypeHash);
 892       Entry = E;
 893       for (; I != E; ++I) {
 894         if (I->second == Ty) {
 895           // Remember the position of the old type if we see it in our scan.
 896           Entry = I;
 897         } else {
 898           if (TypesEqual(Ty, I->second)) {
 899             TypeClass *NewTy = cast<TypeClass>((Type*)I->second.get());
 900
 901             // Remove the old entry form TypesByHash.  If the hash values differ
 902             // now, remove it from the old place.  Otherwise, continue scanning
 903             // withing this hashcode to reduce work.
 904             if (NewTypeHash != OldTypeHash) {
 905               RemoveFromTypesByHash(OldTypeHash, Ty);
 906             } else {
 907               if (Entry == E) {
 908                 // Find the location of Ty in the TypesByHash structure if we
 909                 // haven't seen it already.
 910                 while (I->second != Ty) {
 911                   ++I;
 912                   assert(I != E && "Structure doesn't contain type??");
 913                 }
 914                 Entry = I;
 915               }
 916               TypesByHash.erase(Entry);
 917             }
 918             Ty->refineAbstractTypeTo(NewTy);
 919             return;
 920           }
 921         }
 922       }
 923
 924       // If there is no existing type of the same structure, we reinsert an
 925       // updated record into the map.
 926       Map.insert(std::make_pair(ValType::get(Ty), Ty));
 927     }
 928
 929     // If the hash codes differ, update TypesByHash
 930     if (NewTypeHash != OldTypeHash) {
 931       RemoveFromTypesByHash(OldTypeHash, Ty);
 932       TypesByHash.insert(std::make_pair(NewTypeHash, Ty));
 933     }
 934
 935     // If the type is currently thought to be abstract, rescan all of our
 936     // subtypes to see if the type has just become concrete!  Note that this
 937     // may send out notifications to AbstractTypeUsers that types become
 938     // concrete.
 939     if (Ty->isAbstract())
 940       Ty->PromoteAbstractToConcrete();
 941   }
 942
 943   void print(const char *Arg) const {
 944 #ifdef DEBUG_MERGE_TYPES
 945     DOUT << "TypeMap<>::" << Arg << " table contents:\n";
 946     unsigned i = 0;
 947     for (typename std::map<ValType, PATypeHolder>::const_iterator I
 948            = Map.begin(), E = Map.end(); I != E; ++I)
 949       DOUT << " " << (++i) << ". " << (void*)I->second.get() << " "
 950            << *I->second.get() << "\n";
 951 #endif
 952   }
 953
 954   void dump() const { print("dump output"); }
 955 };
 956 }
 957
 958
 959 //===----------------------------------------------------------------------===//
 960 // Function Type Factory and Value Class...
 961 //
 962
 963 //===----------------------------------------------------------------------===//
 964 // Integer Type Factory...
 965 //
 966 namespace llvm {
 967 class IntegerValType {
 968   uint32_t bits;
 969 public:
 970   IntegerValType(uint16_t numbits) : bits(numbits) {}
 971
 972   static IntegerValType get(const IntegerType *Ty) {
 973     return IntegerValType(Ty->getBitWidth());
 974   }
 975
 976   static unsigned hashTypeStructure(const IntegerType *Ty) {
 977     return (unsigned)Ty->getBitWidth();
 978   }
 979
 980   inline bool operator<(const IntegerValType &IVT) const {
 981     return bits < IVT.bits;
 982   }
 983 };
 984 }
 985
 986 static ManagedStatic<TypeMap<IntegerValType, IntegerType> > IntegerTypes;
 987
 988 const IntegerType *IntegerType::get(unsigned NumBits) {
 989   assert(NumBits >= MIN_INT_BITS && "bitwidth too small");
 990   assert(NumBits <= MAX_INT_BITS && "bitwidth too large");
 991
 992   // Check for the built-in integer types
 993   switch (NumBits) {
 994     case  1: return cast<IntegerType>(Type::Int1Ty);
 995     case  8: return cast<IntegerType>(Type::Int8Ty);
 996     case 16: return cast<IntegerType>(Type::Int16Ty);
 997     case 32: return cast<IntegerType>(Type::Int32Ty);
 998     case 64: return cast<IntegerType>(Type::Int64Ty);
 999     default:
1000       break;
1001   }
1002
1003   IntegerValType IVT(NumBits);
1004   IntegerType *ITy = IntegerTypes->get(IVT);
1005   if (ITy) return ITy;           // Found a match, return it!
1006
1007   // Value not found.  Derive a new type!
1008   ITy = new IntegerType(NumBits);
1009   IntegerTypes->add(IVT, ITy);
1010
1011 #ifdef DEBUG_MERGE_TYPES
1012   DOUT << "Derived new type: " << *ITy << "\n";
1013 #endif
1014   return ITy;
1015 }
1016
1017 bool IntegerType::isPowerOf2ByteWidth() const {
1018   unsigned BitWidth = getBitWidth();
1019   return (BitWidth > 7) && isPowerOf2_32(BitWidth);
1020 }
1021
1022 APInt IntegerType::getMask() const {
1023   return APInt::getAllOnesValue(getBitWidth());
1024 }
1025
1026 // FunctionValType - Define a class to hold the key that goes into the TypeMap
1027 //
1028 namespace llvm {
1029 class FunctionValType {
1030   const Type *RetTy;
1031   std::vector<const Type*> ArgTypes;
1032   const ParamAttrsList *ParamAttrs;
1033   bool isVarArg;
1034 public:
1035   FunctionValType(const Type *ret, const std::vector<const Type*> &args,
1036                   bool IVA, const ParamAttrsList *attrs)
1037     : RetTy(ret), ParamAttrs(attrs), isVarArg(IVA) {
1038     for (unsigned i = 0; i < args.size(); ++i)
1039       ArgTypes.push_back(args[i]);
1040   }
1041
1042   static FunctionValType get(const FunctionType *FT);
1043
1044   static unsigned hashTypeStructure(const FunctionType *FT) {
1045     unsigned Result = FT->getNumParams()*64 + FT->isVarArg();
1046     if (FT->getParamAttrs())
1047       Result += FT->getParamAttrs()->size()*2;
1048     return Result;
1049   }
1050
1051   inline bool operator<(const FunctionValType &MTV) const {
1052     if (RetTy < MTV.RetTy) return true;
1053     if (RetTy > MTV.RetTy) return false;
1054     if (isVarArg < MTV.isVarArg) return true;
1055     if (isVarArg > MTV.isVarArg) return false;
1056     if (ArgTypes < MTV.ArgTypes) return true;
1057     if (ArgTypes > MTV.ArgTypes) return false;
1058     if (ParamAttrs)
1059       if (MTV.ParamAttrs)
1060         return *ParamAttrs < *MTV.ParamAttrs;
1061       else
1062         return false;
1063     else if (MTV.ParamAttrs)
1064       return true;
1065     return false;
1066   }
1067 };
1068 }
1069
1070 // Define the actual map itself now...
1071 static ManagedStatic<TypeMap<FunctionValType, FunctionType> > FunctionTypes;
1072
1073 FunctionValType FunctionValType::get(const FunctionType *FT) {
1074   // Build up a FunctionValType
1075   std::vector<const Type *> ParamTypes;
1076   ParamTypes.reserve(FT->getNumParams());
1077   for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i)
1078     ParamTypes.push_back(FT->getParamType(i));
1079   return FunctionValType(FT->getReturnType(), ParamTypes, FT->isVarArg(),
1080                          FT->getParamAttrs());
1081 }
1082
1083
1084 // FunctionType::get - The factory function for the FunctionType class...
1085 FunctionType *FunctionType::get(const Type *ReturnType,
1086                                 const std::vector<const Type*> &Params,
1087                                 bool isVarArg,
1088                                 ParamAttrsList *Attrs) {
1089
1090   FunctionValType VT(ReturnType, Params, isVarArg, Attrs);
1091   FunctionType *FT = FunctionTypes->get(VT);
1092   if (FT) {
1093     return FT;
1094   }
1095
1096   FT = (FunctionType*) new char[sizeof(FunctionType) +
1097                                 sizeof(PATypeHandle)*(Params.size()+1)];
1098   new (FT) FunctionType(ReturnType, Params, isVarArg, Attrs);
1099   FunctionTypes->add(VT, FT);
1100
1101 #ifdef DEBUG_MERGE_TYPES
1102   DOUT << "Derived new type: " << FT << "\n";
1103 #endif
1104   return FT;
1105 }
1106
1107 bool FunctionType::isStructReturn() const {
1108   if (ParamAttrs)
1109     return ParamAttrs->paramHasAttr(1, ParamAttr::StructRet);
1110   return false;
1111 }
1112
1113 //===----------------------------------------------------------------------===//
1114 // Array Type Factory...
1115 //
1116 namespace llvm {
1117 class ArrayValType {
1118   const Type *ValTy;
1119   uint64_t Size;
1120 public:
1121   ArrayValType(const Type *val, uint64_t sz) : ValTy(val), Size(sz) {}
1122
1123   static ArrayValType get(const ArrayType *AT) {
1124     return ArrayValType(AT->getElementType(), AT->getNumElements());
1125   }
1126
1127   static unsigned hashTypeStructure(const ArrayType *AT) {
1128     return (unsigned)AT->getNumElements();
1129   }
1130
1131   inline bool operator<(const ArrayValType &MTV) const {
1132     if (Size < MTV.Size) return true;
1133     return Size == MTV.Size && ValTy < MTV.ValTy;
1134   }
1135 };
1136 }
1137 static ManagedStatic<TypeMap<ArrayValType, ArrayType> > ArrayTypes;
1138
1139
1140 ArrayType *ArrayType::get(const Type *ElementType, uint64_t NumElements) {
1141   assert(ElementType && "Can't get array of null types!");
1142
1143   ArrayValType AVT(ElementType, NumElements);
1144   ArrayType *AT = ArrayTypes->get(AVT);
1145   if (AT) return AT;           // Found a match, return it!
1146
1147   // Value not found.  Derive a new type!
1148   ArrayTypes->add(AVT, AT = new ArrayType(ElementType, NumElements));
1149
1150 #ifdef DEBUG_MERGE_TYPES
1151   DOUT << "Derived new type: " << *AT << "\n";
1152 #endif
1153   return AT;
1154 }
1155
1156
1157 //===----------------------------------------------------------------------===//
1158 // Vector Type Factory...
1159 //
1160 namespace llvm {
1161 class VectorValType {
1162   const Type *ValTy;
1163   unsigned Size;
1164 public:
1165   VectorValType(const Type *val, int sz) : ValTy(val), Size(sz) {}
1166
1167   static VectorValType get(const VectorType *PT) {
1168     return VectorValType(PT->getElementType(), PT->getNumElements());
1169   }
1170
1171   static unsigned hashTypeStructure(const VectorType *PT) {
1172     return PT->getNumElements();
1173   }
1174
1175   inline bool operator<(const VectorValType &MTV) const {
1176     if (Size < MTV.Size) return true;
1177     return Size == MTV.Size && ValTy < MTV.ValTy;
1178   }
1179 };
1180 }
1181 static ManagedStatic<TypeMap<VectorValType, VectorType> > VectorTypes;
1182
1183
1184 VectorType *VectorType::get(const Type *ElementType, unsigned NumElements) {
1185   assert(ElementType && "Can't get packed of null types!");
1186   assert(isPowerOf2_32(NumElements) && "Vector length should be a power of 2!");
1187
1188   VectorValType PVT(ElementType, NumElements);
1189   VectorType *PT = VectorTypes->get(PVT);
1190   if (PT) return PT;           // Found a match, return it!
1191
1192   // Value not found.  Derive a new type!
1193   VectorTypes->add(PVT, PT = new VectorType(ElementType, NumElements));
1194
1195 #ifdef DEBUG_MERGE_TYPES
1196   DOUT << "Derived new type: " << *PT << "\n";
1197 #endif
1198   return PT;
1199 }
1200
1201 //===----------------------------------------------------------------------===//
1202 // Struct Type Factory...
1203 //
1204
1205 namespace llvm {
1206 // StructValType - Define a class to hold the key that goes into the TypeMap
1207 //
1208 class StructValType {
1209   std::vector<const Type*> ElTypes;
1210   bool packed;
1211 public:
1212   StructValType(const std::vector<const Type*> &args, bool isPacked)
1213     : ElTypes(args), packed(isPacked) {}
1214
1215   static StructValType get(const StructType *ST) {
1216     std::vector<const Type *> ElTypes;
1217     ElTypes.reserve(ST->getNumElements());
1218     for (unsigned i = 0, e = ST->getNumElements(); i != e; ++i)
1219       ElTypes.push_back(ST->getElementType(i));
1220
1221     return StructValType(ElTypes, ST->isPacked());
1222   }
1223
1224   static unsigned hashTypeStructure(const StructType *ST) {
1225     return ST->getNumElements();
1226   }
1227
1228   inline bool operator<(const StructValType &STV) const {
1229     if (ElTypes < STV.ElTypes) return true;
1230     else if (ElTypes > STV.ElTypes) return false;
1231     else return (int)packed < (int)STV.packed;
1232   }
1233 };
1234 }
1235
1236 static ManagedStatic<TypeMap<StructValType, StructType> > StructTypes;
1237
1238 StructType *StructType::get(const std::vector<const Type*> &ETypes,
1239                             bool isPacked) {
1240   StructValType STV(ETypes, isPacked);
1241   StructType *ST = StructTypes->get(STV);
1242   if (ST) return ST;
1243
1244   // Value not found.  Derive a new type!
1245   ST = (StructType*) new char[sizeof(StructType) +
1246                               sizeof(PATypeHandle) * ETypes.size()];
1247   new (ST) StructType(ETypes, isPacked);
1248   StructTypes->add(STV, ST);
1249
1250 #ifdef DEBUG_MERGE_TYPES
1251   DOUT << "Derived new type: " << *ST << "\n";
1252 #endif
1253   return ST;
1254 }
1255
1256
1257
1258 //===----------------------------------------------------------------------===//
1259 // Pointer Type Factory...
1260 //
1261
1262 // PointerValType - Define a class to hold the key that goes into the TypeMap
1263 //
1264 namespace llvm {
1265 class PointerValType {
1266   const Type *ValTy;
1267 public:
1268   PointerValType(const Type *val) : ValTy(val) {}
1269
1270   static PointerValType get(const PointerType *PT) {
1271     return PointerValType(PT->getElementType());
1272   }
1273
1274   static unsigned hashTypeStructure(const PointerType *PT) {
1275     return getSubElementHash(PT);
1276   }
1277
1278   bool operator<(const PointerValType &MTV) const {
1279     return ValTy < MTV.ValTy;
1280   }
1281 };
1282 }
1283
1284 static ManagedStatic<TypeMap<PointerValType, PointerType> > PointerTypes;
1285
1286 PointerType *PointerType::get(const Type *ValueType) {
1287   assert(ValueType && "Can't get a pointer to <null> type!");
1288   assert(ValueType != Type::VoidTy &&
1289          "Pointer to void is not valid, use sbyte* instead!");
1290   assert(ValueType != Type::LabelTy && "Pointer to label is not valid!");
1291   PointerValType PVT(ValueType);
1292
1293   PointerType *PT = PointerTypes->get(PVT);
1294   if (PT) return PT;
1295
1296   // Value not found.  Derive a new type!
1297   PointerTypes->add(PVT, PT = new PointerType(ValueType));
1298
1299 #ifdef DEBUG_MERGE_TYPES
1300   DOUT << "Derived new type: " << *PT << "\n";
1301 #endif
1302   return PT;
1303 }
1304
1305 //===----------------------------------------------------------------------===//
1306 //                     Derived Type Refinement Functions
1307 //===----------------------------------------------------------------------===//
1308
1309 // removeAbstractTypeUser - Notify an abstract type that a user of the class
1310 // no longer has a handle to the type.  This function is called primarily by
1311 // the PATypeHandle class.  When there are no users of the abstract type, it
1312 // is annihilated, because there is no way to get a reference to it ever again.
1313 //
1314 void Type::removeAbstractTypeUser(AbstractTypeUser *U) const {
1315   // Search from back to front because we will notify users from back to
1316   // front.  Also, it is likely that there will be a stack like behavior to
1317   // users that register and unregister users.
1318   //
1319   unsigned i;
1320   for (i = AbstractTypeUsers.size(); AbstractTypeUsers[i-1] != U; --i)
1321     assert(i != 0 && "AbstractTypeUser not in user list!");
1322
1323   --i;  // Convert to be in range 0 <= i < size()
1324   assert(i < AbstractTypeUsers.size() && "Index out of range!");  // Wraparound?
1325
1326   AbstractTypeUsers.erase(AbstractTypeUsers.begin()+i);
1327
1328 #ifdef DEBUG_MERGE_TYPES
1329   DOUT << "  remAbstractTypeUser[" << (void*)this << ", "
1330        << *this << "][" << i << "] User = " << U << "\n";
1331 #endif
1332
1333   if (AbstractTypeUsers.empty() && getRefCount() == 0 && isAbstract()) {
1334 #ifdef DEBUG_MERGE_TYPES
1335     DOUT << "DELETEing unused abstract type: <" << *this
1336          << ">[" << (void*)this << "]" << "\n";
1337 #endif
1338     this->destroy();
1339   }
1340 }
1341
1342 // refineAbstractTypeTo - This function is used when it is discovered that
1343 // the 'this' abstract type is actually equivalent to the NewType specified.
1344 // This causes all users of 'this' to switch to reference the more concrete type
1345 // NewType and for 'this' to be deleted.
1346 //
1347 void DerivedType::refineAbstractTypeTo(const Type *NewType) {
1348   assert(isAbstract() && "refineAbstractTypeTo: Current type is not abstract!");
1349   assert(this != NewType && "Can't refine to myself!");
1350   assert(ForwardType == 0 && "This type has already been refined!");
1351
1352   // The descriptions may be out of date.  Conservatively clear them all!
1353   AbstractTypeDescriptions->clear();
1354
1355 #ifdef DEBUG_MERGE_TYPES
1356   DOUT << "REFINING abstract type [" << (void*)this << " "
1357        << *this << "] to [" << (void*)NewType << " "
1358        << *NewType << "]!\n";
1359 #endif
1360
1361   // Make sure to put the type to be refined to into a holder so that if IT gets
1362   // refined, that we will not continue using a dead reference...
1363   //
1364   PATypeHolder NewTy(NewType);
1365
1366   // Any PATypeHolders referring to this type will now automatically forward to
1367   // the type we are resolved to.
1368   ForwardType = NewType;
1369   if (NewType->isAbstract())
1370     cast<DerivedType>(NewType)->addRef();
1371
1372   // Add a self use of the current type so that we don't delete ourself until
1373   // after the function exits.
1374   //
1375   PATypeHolder CurrentTy(this);
1376
1377   // To make the situation simpler, we ask the subclass to remove this type from
1378   // the type map, and to replace any type uses with uses of non-abstract types.
1379   // This dramatically limits the amount of recursive type trouble we can find
1380   // ourselves in.
1381   dropAllTypeUses();
1382
1383   // Iterate over all of the uses of this type, invoking callback.  Each user
1384   // should remove itself from our use list automatically.  We have to check to
1385   // make sure that NewTy doesn't _become_ 'this'.  If it does, resolving types
1386   // will not cause users to drop off of the use list.  If we resolve to ourself
1387   // we succeed!
1388   //
1389   while (!AbstractTypeUsers.empty() && NewTy != this) {
1390     AbstractTypeUser *User = AbstractTypeUsers.back();
1391
1392     unsigned OldSize = AbstractTypeUsers.size();
1393 #ifdef DEBUG_MERGE_TYPES
1394     DOUT << " REFINING user " << OldSize-1 << "[" << (void*)User
1395          << "] of abstract type [" << (void*)this << " "
1396          << *this << "] to [" << (void*)NewTy.get() << " "
1397          << *NewTy << "]!\n";
1398 #endif
1399     User->refineAbstractType(this, NewTy);
1400
1401     assert(AbstractTypeUsers.size() != OldSize &&
1402            "AbsTyUser did not remove self from user list!");
1403   }
1404
1405   // If we were successful removing all users from the type, 'this' will be
1406   // deleted when the last PATypeHolder is destroyed or updated from this type.
1407   // This may occur on exit of this function, as the CurrentTy object is
1408   // destroyed.
1409 }
1410
1411 // notifyUsesThatTypeBecameConcrete - Notify AbstractTypeUsers of this type that
1412 // the current type has transitioned from being abstract to being concrete.
1413 //
1414 void DerivedType::notifyUsesThatTypeBecameConcrete() {
1415 #ifdef DEBUG_MERGE_TYPES
1416   DOUT << "typeIsREFINED type: " << (void*)this << " " << *this << "\n";
1417 #endif
1418
1419   unsigned OldSize = AbstractTypeUsers.size();
1420   while (!AbstractTypeUsers.empty()) {
1421     AbstractTypeUser *ATU = AbstractTypeUsers.back();
1422     ATU->typeBecameConcrete(this);
1423
1424     assert(AbstractTypeUsers.size() < OldSize-- &&
1425            "AbstractTypeUser did not remove itself from the use list!");
1426   }
1427 }
1428
1429 // refineAbstractType - Called when a contained type is found to be more
1430 // concrete - this could potentially change us from an abstract type to a
1431 // concrete type.
1432 //
1433 void FunctionType::refineAbstractType(const DerivedType *OldType,
1434                                       const Type *NewType) {
1435   FunctionTypes->RefineAbstractType(this, OldType, NewType);
1436 }
1437
1438 void FunctionType::typeBecameConcrete(const DerivedType *AbsTy) {
1439   FunctionTypes->TypeBecameConcrete(this, AbsTy);
1440 }
1441
1442
1443 // refineAbstractType - Called when a contained type is found to be more
1444 // concrete - this could potentially change us from an abstract type to a
1445 // concrete type.
1446 //
1447 void ArrayType::refineAbstractType(const DerivedType *OldType,
1448                                    const Type *NewType) {
1449   ArrayTypes->RefineAbstractType(this, OldType, NewType);
1450 }
1451
1452 void ArrayType::typeBecameConcrete(const DerivedType *AbsTy) {
1453   ArrayTypes->TypeBecameConcrete(this, AbsTy);
1454 }
1455
1456 // refineAbstractType - Called when a contained type is found to be more
1457 // concrete - this could potentially change us from an abstract type to a
1458 // concrete type.
1459 //
1460 void VectorType::refineAbstractType(const DerivedType *OldType,
1461                                    const Type *NewType) {
1462   VectorTypes->RefineAbstractType(this, OldType, NewType);
1463 }
1464
1465 void VectorType::typeBecameConcrete(const DerivedType *AbsTy) {
1466   VectorTypes->TypeBecameConcrete(this, AbsTy);
1467 }
1468
1469 // refineAbstractType - Called when a contained type is found to be more
1470 // concrete - this could potentially change us from an abstract type to a
1471 // concrete type.
1472 //
1473 void StructType::refineAbstractType(const DerivedType *OldType,
1474                                     const Type *NewType) {
1475   StructTypes->RefineAbstractType(this, OldType, NewType);
1476 }
1477
1478 void StructType::typeBecameConcrete(const DerivedType *AbsTy) {
1479   StructTypes->TypeBecameConcrete(this, AbsTy);
1480 }
1481
1482 // refineAbstractType - Called when a contained type is found to be more
1483 // concrete - this could potentially change us from an abstract type to a
1484 // concrete type.
1485 //
1486 void PointerType::refineAbstractType(const DerivedType *OldType,
1487                                      const Type *NewType) {
1488   PointerTypes->RefineAbstractType(this, OldType, NewType);
1489 }
1490
1491 void PointerType::typeBecameConcrete(const DerivedType *AbsTy) {
1492   PointerTypes->TypeBecameConcrete(this, AbsTy);
1493 }
1494
1495 bool SequentialType::indexValid(const Value *V) const {
1496   if (const IntegerType *IT = dyn_cast<IntegerType>(V->getType()))
1497     return IT->getBitWidth() == 32 || IT->getBitWidth() == 64;
1498   return false;
1499 }
1500
1501 namespace llvm {
1502 std::ostream &operator<<(std::ostream &OS, const Type *T) {
1503   if (T == 0)
1504     OS << "<null> value!\n";
1505   else
1506     T->print(OS);
1507   return OS;
1508 }
1509
1510 std::ostream &operator<<(std::ostream &OS, const Type &T) {
1511   T.print(OS);
1512   return OS;
1513 }
1514 }