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