lib/VMCore/Type.cpp

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