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 "LLVMContextImpl.h"
  15 #include "llvm/DerivedTypes.h"
  16 #include "llvm/Constants.h"
  17 #include "llvm/Assembly/Writer.h"
  18 #include "llvm/LLVMContext.h"
  19 #include "llvm/Metadata.h"
  20 #include "llvm/ADT/DepthFirstIterator.h"
  21 #include "llvm/ADT/StringExtras.h"
  22 #include "llvm/ADT/SCCIterator.h"
  23 #include "llvm/ADT/STLExtras.h"
  24 #include "llvm/Support/Compiler.h"
  25 #include "llvm/Support/Debug.h"
  26 #include "llvm/Support/ErrorHandling.h"
  27 #include "llvm/Support/ManagedStatic.h"
  28 #include "llvm/Support/MathExtras.h"
  29 #include "llvm/Support/raw_ostream.h"
  30 #include "llvm/System/Threading.h"
  31 #include <algorithm>
  32 #include <cstdarg>
  33 using namespace llvm;
  34
  35 // DEBUG_MERGE_TYPES - Enable this #define to see how and when derived types are
  36 // created and later destroyed, all in an effort to make sure that there is only
  37 // a single canonical version of a type.
  38 //
  39 // #define DEBUG_MERGE_TYPES 1
  40
  41 AbstractTypeUser::~AbstractTypeUser() {}
  42
  43 void AbstractTypeUser::setType(Value *V, const Type *NewTy) {
  44   V->VTy = NewTy;
  45 }
  46
  47 //===----------------------------------------------------------------------===//
  48 //                         Type Class Implementation
  49 //===----------------------------------------------------------------------===//
  50
  51 /// Because of the way Type subclasses are allocated, this function is necessary
  52 /// to use the correct kind of "delete" operator to deallocate the Type object.
  53 /// Some type objects (FunctionTy, StructTy, UnionTy) allocate additional space
  54 /// after the space for their derived type to hold the contained types array of
  55 /// PATypeHandles. Using this allocation scheme means all the PATypeHandles are
  56 /// allocated with the type object, decreasing allocations and eliminating the
  57 /// need for a std::vector to be used in the Type class itself.
  58 /// @brief Type destruction function
  59 void Type::destroy() const {
  60   // Nothing calls getForwardedType from here on.
  61   if (ForwardType && ForwardType->isAbstract()) {
  62     ForwardType->dropRef();
  63     ForwardType = NULL;
  64   }
  65
  66   // Structures and Functions allocate their contained types past the end of
  67   // the type object itself. These need to be destroyed differently than the
  68   // other types.
  69   if (this->isFunctionTy() || this->isStructTy() ||
  70       this->isUnionTy()) {
  71     // First, make sure we destruct any PATypeHandles allocated by these
  72     // subclasses.  They must be manually destructed.
  73     for (unsigned i = 0; i < NumContainedTys; ++i)
  74       ContainedTys[i].PATypeHandle::~PATypeHandle();
  75
  76     // Now call the destructor for the subclass directly because we're going
  77     // to delete this as an array of char.
  78     if (this->isFunctionTy())
  79       static_cast<const FunctionType*>(this)->FunctionType::~FunctionType();
  80     else if (this->isStructTy())
  81       static_cast<const StructType*>(this)->StructType::~StructType();
  82     else
  83       static_cast<const UnionType*>(this)->UnionType::~UnionType();
  84
  85     // Finally, remove the memory as an array deallocation of the chars it was
  86     // constructed from.
  87     operator delete(const_cast<Type *>(this));
  88
  89     return;
  90   } else if (const OpaqueType *opaque_this = dyn_cast<OpaqueType>(this)) {
  91     LLVMContextImpl *pImpl = this->getContext().pImpl;
  92     pImpl->OpaqueTypes.erase(opaque_this);
  93   }
  94
  95   // For all the other type subclasses, there is either no contained types or
  96   // just one (all Sequentials). For Sequentials, the PATypeHandle is not
  97   // allocated past the type object, its included directly in the SequentialType
  98   // class. This means we can safely just do "normal" delete of this object and
  99   // all the destructors that need to run will be run.
 100   delete this;
 101 }
 102
 103 const Type *Type::getPrimitiveType(LLVMContext &C, TypeID IDNumber) {
 104   switch (IDNumber) {
 105   case VoidTyID      : return getVoidTy(C);
 106   case FloatTyID     : return getFloatTy(C);
 107   case DoubleTyID    : return getDoubleTy(C);
 108   case X86_FP80TyID  : return getX86_FP80Ty(C);
 109   case FP128TyID     : return getFP128Ty(C);
 110   case PPC_FP128TyID : return getPPC_FP128Ty(C);
 111   case LabelTyID     : return getLabelTy(C);
 112   case MetadataTyID  : return getMetadataTy(C);
 113   default:
 114     return 0;
 115   }
 116 }
 117
 118 const Type *Type::getVAArgsPromotedType(LLVMContext &C) const {
 119   if (ID == IntegerTyID && getSubclassData() < 32)
 120     return Type::getInt32Ty(C);
 121   else if (ID == FloatTyID)
 122     return Type::getDoubleTy(C);
 123   else
 124     return this;
 125 }
 126
 127 /// getScalarType - If this is a vector type, return the element type,
 128 /// otherwise return this.
 129 const Type *Type::getScalarType() const {
 130   if (const VectorType *VTy = dyn_cast<VectorType>(this))
 131     return VTy->getElementType();
 132   return this;
 133 }
 134
 135 /// isIntegerTy - Return true if this is an IntegerType of the specified width.
 136 bool Type::isIntegerTy(unsigned Bitwidth) const {
 137   return isIntegerTy() && cast<IntegerType>(this)->getBitWidth() == Bitwidth;
 138 }
 139
 140 /// isIntOrIntVectorTy - Return true if this is an integer type or a vector of
 141 /// integer types.
 142 ///
 143 bool Type::isIntOrIntVectorTy() const {
 144   if (isIntegerTy())
 145     return true;
 146   if (ID != Type::VectorTyID) return false;
 147
 148   return cast<VectorType>(this)->getElementType()->isIntegerTy();
 149 }
 150
 151 /// isFPOrFPVectorTy - Return true if this is a FP type or a vector of FP types.
 152 ///
 153 bool Type::isFPOrFPVectorTy() const {
 154   if (ID == Type::FloatTyID || ID == Type::DoubleTyID ||
 155       ID == Type::FP128TyID || ID == Type::X86_FP80TyID ||
 156       ID == Type::PPC_FP128TyID)
 157     return true;
 158   if (ID != Type::VectorTyID) return false;
 159
 160   return cast<VectorType>(this)->getElementType()->isFloatingPointTy();
 161 }
 162
 163 // canLosslesslyBitCastTo - Return true if this type can be converted to
 164 // 'Ty' without any reinterpretation of bits.  For example, i8* to i32*.
 165 //
 166 bool Type::canLosslesslyBitCastTo(const Type *Ty) const {
 167   // Identity cast means no change so return true
 168   if (this == Ty)
 169     return true;
 170
 171   // They are not convertible unless they are at least first class types
 172   if (!this->isFirstClassType() || !Ty->isFirstClassType())
 173     return false;
 174
 175   // Vector -> Vector conversions are always lossless if the two vector types
 176   // have the same size, otherwise not.
 177   if (const VectorType *thisPTy = dyn_cast<VectorType>(this))
 178     if (const VectorType *thatPTy = dyn_cast<VectorType>(Ty))
 179       return thisPTy->getBitWidth() == thatPTy->getBitWidth();
 180
 181   // At this point we have only various mismatches of the first class types
 182   // remaining and ptr->ptr. Just select the lossless conversions. Everything
 183   // else is not lossless.
 184   if (this->isPointerTy())
 185     return Ty->isPointerTy();
 186   return false;  // Other types have no identity values
 187 }
 188
 189 unsigned Type::getPrimitiveSizeInBits() const {
 190   switch (getTypeID()) {
 191   case Type::FloatTyID: return 32;
 192   case Type::DoubleTyID: return 64;
 193   case Type::X86_FP80TyID: return 80;
 194   case Type::FP128TyID: return 128;
 195   case Type::PPC_FP128TyID: return 128;
 196   case Type::IntegerTyID: return cast<IntegerType>(this)->getBitWidth();
 197   case Type::VectorTyID:  return cast<VectorType>(this)->getBitWidth();
 198   default: return 0;
 199   }
 200 }
 201
 202 /// getScalarSizeInBits - If this is a vector type, return the
 203 /// getPrimitiveSizeInBits value for the element type. Otherwise return the
 204 /// getPrimitiveSizeInBits value for this type.
 205 unsigned Type::getScalarSizeInBits() const {
 206   return getScalarType()->getPrimitiveSizeInBits();
 207 }
 208
 209 /// getFPMantissaWidth - Return the width of the mantissa of this type.  This
 210 /// is only valid on floating point types.  If the FP type does not
 211 /// have a stable mantissa (e.g. ppc long double), this method returns -1.
 212 int Type::getFPMantissaWidth() const {
 213   if (const VectorType *VTy = dyn_cast<VectorType>(this))
 214     return VTy->getElementType()->getFPMantissaWidth();
 215   assert(isFloatingPointTy() && "Not a floating point type!");
 216   if (ID == FloatTyID) return 24;
 217   if (ID == DoubleTyID) return 53;
 218   if (ID == X86_FP80TyID) return 64;
 219   if (ID == FP128TyID) return 113;
 220   assert(ID == PPC_FP128TyID && "unknown fp type");
 221   return -1;
 222 }
 223
 224 /// isSizedDerivedType - Derived types like structures and arrays are sized
 225 /// iff all of the members of the type are sized as well.  Since asking for
 226 /// their size is relatively uncommon, move this operation out of line.
 227 bool Type::isSizedDerivedType() const {
 228   if (this->isIntegerTy())
 229     return true;
 230
 231   if (const ArrayType *ATy = dyn_cast<ArrayType>(this))
 232     return ATy->getElementType()->isSized();
 233
 234   if (const VectorType *PTy = dyn_cast<VectorType>(this))
 235     return PTy->getElementType()->isSized();
 236
 237   if (!this->isStructTy() && !this->isUnionTy())
 238     return false;
 239
 240   // Okay, our struct is sized if all of the elements are...
 241   for (subtype_iterator I = subtype_begin(), E = subtype_end(); I != E; ++I)
 242     if (!(*I)->isSized())
 243       return false;
 244
 245   return true;
 246 }
 247
 248 /// getForwardedTypeInternal - This method is used to implement the union-find
 249 /// algorithm for when a type is being forwarded to another type.
 250 const Type *Type::getForwardedTypeInternal() const {
 251   assert(ForwardType && "This type is not being forwarded to another type!");
 252
 253   // Check to see if the forwarded type has been forwarded on.  If so, collapse
 254   // the forwarding links.
 255   const Type *RealForwardedType = ForwardType->getForwardedType();
 256   if (!RealForwardedType)
 257     return ForwardType;  // No it's not forwarded again
 258
 259   // Yes, it is forwarded again.  First thing, add the reference to the new
 260   // forward type.
 261   if (RealForwardedType->isAbstract())
 262     RealForwardedType->addRef();
 263
 264   // Now drop the old reference.  This could cause ForwardType to get deleted.
 265   // ForwardType must be abstract because only abstract types can have their own
 266   // ForwardTypes.
 267   ForwardType->dropRef();
 268
 269   // Return the updated type.
 270   ForwardType = RealForwardedType;
 271   return ForwardType;
 272 }
 273
 274 void Type::refineAbstractType(const DerivedType *OldTy, const Type *NewTy) {
 275   llvm_unreachable("Attempting to refine a derived type!");
 276 }
 277 void Type::typeBecameConcrete(const DerivedType *AbsTy) {
 278   llvm_unreachable("DerivedType is already a concrete type!");
 279 }
 280
 281
 282 std::string Type::getDescription() const {
 283   LLVMContextImpl *pImpl = getContext().pImpl;
 284   TypePrinting &Map =
 285     isAbstract() ?
 286       pImpl->AbstractTypeDescriptions :
 287       pImpl->ConcreteTypeDescriptions;
 288
 289   std::string DescStr;
 290   raw_string_ostream DescOS(DescStr);
 291   Map.print(this, DescOS);
 292   return DescOS.str();
 293 }
 294
 295
 296 bool StructType::indexValid(const Value *V) const {
 297   // Structure indexes require 32-bit integer constants.
 298   if (V->getType()->isIntegerTy(32))
 299     if (const ConstantInt *CU = dyn_cast<ConstantInt>(V))
 300       return indexValid(CU->getZExtValue());
 301   return false;
 302 }
 303
 304 bool StructType::indexValid(unsigned V) const {
 305   return V < NumContainedTys;
 306 }
 307
 308 // getTypeAtIndex - Given an index value into the type, return the type of the
 309 // element.  For a structure type, this must be a constant value...
 310 //
 311 const Type *StructType::getTypeAtIndex(const Value *V) const {
 312   unsigned Idx = (unsigned)cast<ConstantInt>(V)->getZExtValue();
 313   return getTypeAtIndex(Idx);
 314 }
 315
 316 const Type *StructType::getTypeAtIndex(unsigned Idx) const {
 317   assert(indexValid(Idx) && "Invalid structure index!");
 318   return ContainedTys[Idx];
 319 }
 320
 321
 322 bool UnionType::indexValid(const Value *V) const {
 323   // Union indexes require 32-bit integer constants.
 324   if (V->getType()->isIntegerTy(32))
 325     if (const ConstantInt *CU = dyn_cast<ConstantInt>(V))
 326       return indexValid(CU->getZExtValue());
 327   return false;
 328 }
 329
 330 bool UnionType::indexValid(unsigned V) const {
 331   return V < NumContainedTys;
 332 }
 333
 334 // getTypeAtIndex - Given an index value into the type, return the type of the
 335 // element.  For a structure type, this must be a constant value...
 336 //
 337 const Type *UnionType::getTypeAtIndex(const Value *V) const {
 338   unsigned Idx = (unsigned)cast<ConstantInt>(V)->getZExtValue();
 339   return getTypeAtIndex(Idx);
 340 }
 341
 342 const Type *UnionType::getTypeAtIndex(unsigned Idx) const {
 343   assert(indexValid(Idx) && "Invalid structure index!");
 344   return ContainedTys[Idx];
 345 }
 346
 347 //===----------------------------------------------------------------------===//
 348 //                          Primitive 'Type' data
 349 //===----------------------------------------------------------------------===//
 350
 351 const Type *Type::getVoidTy(LLVMContext &C) {
 352   return &C.pImpl->VoidTy;
 353 }
 354
 355 const Type *Type::getLabelTy(LLVMContext &C) {
 356   return &C.pImpl->LabelTy;
 357 }
 358
 359 const Type *Type::getFloatTy(LLVMContext &C) {
 360   return &C.pImpl->FloatTy;
 361 }
 362
 363 const Type *Type::getDoubleTy(LLVMContext &C) {
 364   return &C.pImpl->DoubleTy;
 365 }
 366
 367 const Type *Type::getMetadataTy(LLVMContext &C) {
 368   return &C.pImpl->MetadataTy;
 369 }
 370
 371 const Type *Type::getX86_FP80Ty(LLVMContext &C) {
 372   return &C.pImpl->X86_FP80Ty;
 373 }
 374
 375 const Type *Type::getFP128Ty(LLVMContext &C) {
 376   return &C.pImpl->FP128Ty;
 377 }
 378
 379 const Type *Type::getPPC_FP128Ty(LLVMContext &C) {
 380   return &C.pImpl->PPC_FP128Ty;
 381 }
 382
 383 const IntegerType *Type::getIntNTy(LLVMContext &C, unsigned N) {
 384   return IntegerType::get(C, N);
 385 }
 386
 387 const IntegerType *Type::getInt1Ty(LLVMContext &C) {
 388   return &C.pImpl->Int1Ty;
 389 }
 390
 391 const IntegerType *Type::getInt8Ty(LLVMContext &C) {
 392   return &C.pImpl->Int8Ty;
 393 }
 394
 395 const IntegerType *Type::getInt16Ty(LLVMContext &C) {
 396   return &C.pImpl->Int16Ty;
 397 }
 398
 399 const IntegerType *Type::getInt32Ty(LLVMContext &C) {
 400   return &C.pImpl->Int32Ty;
 401 }
 402
 403 const IntegerType *Type::getInt64Ty(LLVMContext &C) {
 404   return &C.pImpl->Int64Ty;
 405 }
 406
 407 const PointerType *Type::getFloatPtrTy(LLVMContext &C, unsigned AS) {
 408   return getFloatTy(C)->getPointerTo(AS);
 409 }
 410
 411 const PointerType *Type::getDoublePtrTy(LLVMContext &C, unsigned AS) {
 412   return getDoubleTy(C)->getPointerTo(AS);
 413 }
 414
 415 const PointerType *Type::getX86_FP80PtrTy(LLVMContext &C, unsigned AS) {
 416   return getX86_FP80Ty(C)->getPointerTo(AS);
 417 }
 418
 419 const PointerType *Type::getFP128PtrTy(LLVMContext &C, unsigned AS) {
 420   return getFP128Ty(C)->getPointerTo(AS);
 421 }
 422
 423 const PointerType *Type::getPPC_FP128PtrTy(LLVMContext &C, unsigned AS) {
 424   return getPPC_FP128Ty(C)->getPointerTo(AS);
 425 }
 426
 427 const PointerType *Type::getIntNPtrTy(LLVMContext &C, unsigned N, unsigned AS) {
 428   return getIntNTy(C, N)->getPointerTo(AS);
 429 }
 430
 431 const PointerType *Type::getInt1PtrTy(LLVMContext &C, unsigned AS) {
 432   return getInt1Ty(C)->getPointerTo(AS);
 433 }
 434
 435 const PointerType *Type::getInt8PtrTy(LLVMContext &C, unsigned AS) {
 436   return getInt8Ty(C)->getPointerTo(AS);
 437 }
 438
 439 const PointerType *Type::getInt16PtrTy(LLVMContext &C, unsigned AS) {
 440   return getInt16Ty(C)->getPointerTo(AS);
 441 }
 442
 443 const PointerType *Type::getInt32PtrTy(LLVMContext &C, unsigned AS) {
 444   return getInt32Ty(C)->getPointerTo(AS);
 445 }
 446
 447 const PointerType *Type::getInt64PtrTy(LLVMContext &C, unsigned AS) {
 448   return getInt64Ty(C)->getPointerTo(AS);
 449 }
 450
 451 //===----------------------------------------------------------------------===//
 452 //                          Derived Type Constructors
 453 //===----------------------------------------------------------------------===//
 454
 455 /// isValidReturnType - Return true if the specified type is valid as a return
 456 /// type.
 457 bool FunctionType::isValidReturnType(const Type *RetTy) {
 458   return RetTy->getTypeID() != LabelTyID &&
 459          RetTy->getTypeID() != MetadataTyID;
 460 }
 461
 462 /// isValidArgumentType - Return true if the specified type is valid as an
 463 /// argument type.
 464 bool FunctionType::isValidArgumentType(const Type *ArgTy) {
 465   return ArgTy->isFirstClassType() || ArgTy->isOpaqueTy();
 466 }
 467
 468 FunctionType::FunctionType(const Type *Result,
 469                            const std::vector<const Type*> &Params,
 470                            bool IsVarArgs)
 471   : DerivedType(Result->getContext(), FunctionTyID), isVarArgs(IsVarArgs) {
 472   ContainedTys = reinterpret_cast<PATypeHandle*>(this+1);
 473   NumContainedTys = Params.size() + 1; // + 1 for result type
 474   assert(isValidReturnType(Result) && "invalid return type for function");
 475
 476
 477   bool isAbstract = Result->isAbstract();
 478   new (&ContainedTys[0]) PATypeHandle(Result, this);
 479
 480   for (unsigned i = 0; i != Params.size(); ++i) {
 481     assert(isValidArgumentType(Params[i]) &&
 482            "Not a valid type for function argument!");
 483     new (&ContainedTys[i+1]) PATypeHandle(Params[i], this);
 484     isAbstract |= Params[i]->isAbstract();
 485   }
 486
 487   // Calculate whether or not this type is abstract
 488   setAbstract(isAbstract);
 489 }
 490
 491 StructType::StructType(LLVMContext &C,
 492                        const std::vector<const Type*> &Types, bool isPacked)
 493   : CompositeType(C, StructTyID) {
 494   ContainedTys = reinterpret_cast<PATypeHandle*>(this + 1);
 495   NumContainedTys = Types.size();
 496   setSubclassData(isPacked);
 497   bool isAbstract = false;
 498   for (unsigned i = 0; i < Types.size(); ++i) {
 499     assert(Types[i] && "<null> type for structure field!");
 500     assert(isValidElementType(Types[i]) &&
 501            "Invalid type for structure element!");
 502     new (&ContainedTys[i]) PATypeHandle(Types[i], this);
 503     isAbstract |= Types[i]->isAbstract();
 504   }
 505
 506   // Calculate whether or not this type is abstract
 507   setAbstract(isAbstract);
 508 }
 509
 510 UnionType::UnionType(LLVMContext &C,const Type* const* Types, unsigned NumTypes)
 511   : CompositeType(C, UnionTyID) {
 512   ContainedTys = reinterpret_cast<PATypeHandle*>(this + 1);
 513   NumContainedTys = NumTypes;
 514   bool isAbstract = false;
 515   for (unsigned i = 0; i < NumTypes; ++i) {
 516     assert(Types[i] && "<null> type for union field!");
 517     assert(isValidElementType(Types[i]) &&
 518            "Invalid type for union element!");
 519     new (&ContainedTys[i]) PATypeHandle(Types[i], this);
 520     isAbstract |= Types[i]->isAbstract();
 521   }
 522
 523   // Calculate whether or not this type is abstract
 524   setAbstract(isAbstract);
 525 }
 526
 527 ArrayType::ArrayType(const Type *ElType, uint64_t NumEl)
 528   : SequentialType(ArrayTyID, ElType) {
 529   NumElements = NumEl;
 530
 531   // Calculate whether or not this type is abstract
 532   setAbstract(ElType->isAbstract());
 533 }
 534
 535 VectorType::VectorType(const Type *ElType, unsigned NumEl)
 536   : SequentialType(VectorTyID, ElType) {
 537   NumElements = NumEl;
 538   setAbstract(ElType->isAbstract());
 539   assert(NumEl > 0 && "NumEl of a VectorType must be greater than 0");
 540   assert(isValidElementType(ElType) &&
 541          "Elements of a VectorType must be a primitive type");
 542
 543 }
 544
 545
 546 PointerType::PointerType(const Type *E, unsigned AddrSpace)
 547   : SequentialType(PointerTyID, E) {
 548   AddressSpace = AddrSpace;
 549   // Calculate whether or not this type is abstract
 550   setAbstract(E->isAbstract());
 551 }
 552
 553 OpaqueType::OpaqueType(LLVMContext &C) : DerivedType(C, OpaqueTyID) {
 554   setAbstract(true);
 555 #ifdef DEBUG_MERGE_TYPES
 556   DEBUG(dbgs() << "Derived new type: " << *this << "\n");
 557 #endif
 558 }
 559
 560 void PATypeHolder::destroy() {
 561   Ty = 0;
 562 }
 563
 564 // dropAllTypeUses - When this (abstract) type is resolved to be equal to
 565 // another (more concrete) type, we must eliminate all references to other
 566 // types, to avoid some circular reference problems.
 567 void DerivedType::dropAllTypeUses() {
 568   if (NumContainedTys != 0) {
 569     // The type must stay abstract.  To do this, we insert a pointer to a type
 570     // that will never get resolved, thus will always be abstract.
 571     ContainedTys[0] = getContext().pImpl->AlwaysOpaqueTy;
 572
 573     // Change the rest of the types to be Int32Ty's.  It doesn't matter what we
 574     // pick so long as it doesn't point back to this type.  We choose something
 575     // concrete to avoid overhead for adding to AbstractTypeUser lists and
 576     // stuff.
 577     const Type *ConcreteTy = Type::getInt32Ty(getContext());
 578     for (unsigned i = 1, e = NumContainedTys; i != e; ++i)
 579       ContainedTys[i] = ConcreteTy;
 580   }
 581 }
 582
 583
 584 namespace {
 585
 586 /// TypePromotionGraph and graph traits - this is designed to allow us to do
 587 /// efficient SCC processing of type graphs.  This is the exact same as
 588 /// GraphTraits<Type*>, except that we pretend that concrete types have no
 589 /// children to avoid processing them.
 590 struct TypePromotionGraph {
 591   Type *Ty;
 592   TypePromotionGraph(Type *T) : Ty(T) {}
 593 };
 594
 595 }
 596
 597 namespace llvm {
 598   template <> struct GraphTraits<TypePromotionGraph> {
 599     typedef Type NodeType;
 600     typedef Type::subtype_iterator ChildIteratorType;
 601
 602     static inline NodeType *getEntryNode(TypePromotionGraph G) { return G.Ty; }
 603     static inline ChildIteratorType child_begin(NodeType *N) {
 604       if (N->isAbstract())
 605         return N->subtype_begin();
 606       else           // No need to process children of concrete types.
 607         return N->subtype_end();
 608     }
 609     static inline ChildIteratorType child_end(NodeType *N) {
 610       return N->subtype_end();
 611     }
 612   };
 613 }
 614
 615
 616 // PromoteAbstractToConcrete - This is a recursive function that walks a type
 617 // graph calculating whether or not a type is abstract.
 618 //
 619 void Type::PromoteAbstractToConcrete() {
 620   if (!isAbstract()) return;
 621
 622   scc_iterator<TypePromotionGraph> SI = scc_begin(TypePromotionGraph(this));
 623   scc_iterator<TypePromotionGraph> SE = scc_end  (TypePromotionGraph(this));
 624
 625   for (; SI != SE; ++SI) {
 626     std::vector<Type*> &SCC = *SI;
 627
 628     // Concrete types are leaves in the tree.  Since an SCC will either be all
 629     // abstract or all concrete, we only need to check one type.
 630     if (SCC[0]->isAbstract()) {
 631       if (SCC[0]->isOpaqueTy())
 632         return;     // Not going to be concrete, sorry.
 633
 634       // If all of the children of all of the types in this SCC are concrete,
 635       // then this SCC is now concrete as well.  If not, neither this SCC, nor
 636       // any parent SCCs will be concrete, so we might as well just exit.
 637       for (unsigned i = 0, e = SCC.size(); i != e; ++i)
 638         for (Type::subtype_iterator CI = SCC[i]->subtype_begin(),
 639                E = SCC[i]->subtype_end(); CI != E; ++CI)
 640           if ((*CI)->isAbstract())
 641             // If the child type is in our SCC, it doesn't make the entire SCC
 642             // abstract unless there is a non-SCC abstract type.
 643             if (std::find(SCC.begin(), SCC.end(), *CI) == SCC.end())
 644               return;               // Not going to be concrete, sorry.
 645
 646       // Okay, we just discovered this whole SCC is now concrete, mark it as
 647       // such!
 648       for (unsigned i = 0, e = SCC.size(); i != e; ++i) {
 649         assert(SCC[i]->isAbstract() && "Why are we processing concrete types?");
 650
 651         SCC[i]->setAbstract(false);
 652       }
 653
 654       for (unsigned i = 0, e = SCC.size(); i != e; ++i) {
 655         assert(!SCC[i]->isAbstract() && "Concrete type became abstract?");
 656         // The type just became concrete, notify all users!
 657         cast<DerivedType>(SCC[i])->notifyUsesThatTypeBecameConcrete();
 658       }
 659     }
 660   }
 661 }
 662
 663
 664 //===----------------------------------------------------------------------===//
 665 //                      Type Structural Equality Testing
 666 //===----------------------------------------------------------------------===//
 667
 668 // TypesEqual - Two types are considered structurally equal if they have the
 669 // same "shape": Every level and element of the types have identical primitive
 670 // ID's, and the graphs have the same edges/nodes in them.  Nodes do not have to
 671 // be pointer equals to be equivalent though.  This uses an optimistic algorithm
 672 // that assumes that two graphs are the same until proven otherwise.
 673 //
 674 static bool TypesEqual(const Type *Ty, const Type *Ty2,
 675                        std::map<const Type *, const Type *> &EqTypes) {
 676   if (Ty == Ty2) return true;
 677   if (Ty->getTypeID() != Ty2->getTypeID()) return false;
 678   if (Ty->isOpaqueTy())
 679     return false;  // Two unequal opaque types are never equal
 680
 681   std::map<const Type*, const Type*>::iterator It = EqTypes.find(Ty);
 682   if (It != EqTypes.end())
 683     return It->second == Ty2;    // Looping back on a type, check for equality
 684
 685   // Otherwise, add the mapping to the table to make sure we don't get
 686   // recursion on the types...
 687   EqTypes.insert(It, std::make_pair(Ty, Ty2));
 688
 689   // Two really annoying special cases that breaks an otherwise nice simple
 690   // algorithm is the fact that arraytypes have sizes that differentiates types,
 691   // and that function types can be varargs or not.  Consider this now.
 692   //
 693   if (const IntegerType *ITy = dyn_cast<IntegerType>(Ty)) {
 694     const IntegerType *ITy2 = cast<IntegerType>(Ty2);
 695     return ITy->getBitWidth() == ITy2->getBitWidth();
 696   } else if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
 697     const PointerType *PTy2 = cast<PointerType>(Ty2);
 698     return PTy->getAddressSpace() == PTy2->getAddressSpace() &&
 699            TypesEqual(PTy->getElementType(), PTy2->getElementType(), EqTypes);
 700   } else if (const StructType *STy = dyn_cast<StructType>(Ty)) {
 701     const StructType *STy2 = cast<StructType>(Ty2);
 702     if (STy->getNumElements() != STy2->getNumElements()) return false;
 703     if (STy->isPacked() != STy2->isPacked()) return false;
 704     for (unsigned i = 0, e = STy2->getNumElements(); i != e; ++i)
 705       if (!TypesEqual(STy->getElementType(i), STy2->getElementType(i), EqTypes))
 706         return false;
 707     return true;
 708   } else if (const UnionType *UTy = dyn_cast<UnionType>(Ty)) {
 709     const UnionType *UTy2 = cast<UnionType>(Ty2);
 710     if (UTy->getNumElements() != UTy2->getNumElements()) return false;
 711     for (unsigned i = 0, e = UTy2->getNumElements(); i != e; ++i)
 712       if (!TypesEqual(UTy->getElementType(i), UTy2->getElementType(i), EqTypes))
 713         return false;
 714     return true;
 715   } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
 716     const ArrayType *ATy2 = cast<ArrayType>(Ty2);
 717     return ATy->getNumElements() == ATy2->getNumElements() &&
 718            TypesEqual(ATy->getElementType(), ATy2->getElementType(), EqTypes);
 719   } else if (const VectorType *PTy = dyn_cast<VectorType>(Ty)) {
 720     const VectorType *PTy2 = cast<VectorType>(Ty2);
 721     return PTy->getNumElements() == PTy2->getNumElements() &&
 722            TypesEqual(PTy->getElementType(), PTy2->getElementType(), EqTypes);
 723   } else if (const FunctionType *FTy = dyn_cast<FunctionType>(Ty)) {
 724     const FunctionType *FTy2 = cast<FunctionType>(Ty2);
 725     if (FTy->isVarArg() != FTy2->isVarArg() ||
 726         FTy->getNumParams() != FTy2->getNumParams() ||
 727         !TypesEqual(FTy->getReturnType(), FTy2->getReturnType(), EqTypes))
 728       return false;
 729     for (unsigned i = 0, e = FTy2->getNumParams(); i != e; ++i) {
 730       if (!TypesEqual(FTy->getParamType(i), FTy2->getParamType(i), EqTypes))
 731         return false;
 732     }
 733     return true;
 734   } else {
 735     llvm_unreachable("Unknown derived type!");
 736     return false;
 737   }
 738 }
 739
 740 namespace llvm { // in namespace llvm so findable by ADL
 741 static bool TypesEqual(const Type *Ty, const Type *Ty2) {
 742   std::map<const Type *, const Type *> EqTypes;
 743   return ::TypesEqual(Ty, Ty2, EqTypes);
 744 }
 745 }
 746
 747 // AbstractTypeHasCycleThrough - Return true there is a path from CurTy to
 748 // TargetTy in the type graph.  We know that Ty is an abstract type, so if we
 749 // ever reach a non-abstract type, we know that we don't need to search the
 750 // subgraph.
 751 static bool AbstractTypeHasCycleThrough(const Type *TargetTy, const Type *CurTy,
 752                                 SmallPtrSet<const Type*, 128> &VisitedTypes) {
 753   if (TargetTy == CurTy) return true;
 754   if (!CurTy->isAbstract()) return false;
 755
 756   if (!VisitedTypes.insert(CurTy))
 757     return false;  // Already been here.
 758
 759   for (Type::subtype_iterator I = CurTy->subtype_begin(),
 760        E = CurTy->subtype_end(); I != E; ++I)
 761     if (AbstractTypeHasCycleThrough(TargetTy, *I, VisitedTypes))
 762       return true;
 763   return false;
 764 }
 765
 766 static bool ConcreteTypeHasCycleThrough(const Type *TargetTy, const Type *CurTy,
 767                                 SmallPtrSet<const Type*, 128> &VisitedTypes) {
 768   if (TargetTy == CurTy) return true;
 769
 770   if (!VisitedTypes.insert(CurTy))
 771     return false;  // Already been here.
 772
 773   for (Type::subtype_iterator I = CurTy->subtype_begin(),
 774        E = CurTy->subtype_end(); I != E; ++I)
 775     if (ConcreteTypeHasCycleThrough(TargetTy, *I, VisitedTypes))
 776       return true;
 777   return false;
 778 }
 779
 780 /// TypeHasCycleThroughItself - Return true if the specified type has
 781 /// a cycle back to itself.
 782
 783 namespace llvm { // in namespace llvm so it's findable by ADL
 784 static bool TypeHasCycleThroughItself(const Type *Ty) {
 785   SmallPtrSet<const Type*, 128> VisitedTypes;
 786
 787   if (Ty->isAbstract()) {  // Optimized case for abstract types.
 788     for (Type::subtype_iterator I = Ty->subtype_begin(), E = Ty->subtype_end();
 789          I != E; ++I)
 790       if (AbstractTypeHasCycleThrough(Ty, *I, VisitedTypes))
 791         return true;
 792   } else {
 793     for (Type::subtype_iterator I = Ty->subtype_begin(), E = Ty->subtype_end();
 794          I != E; ++I)
 795       if (ConcreteTypeHasCycleThrough(Ty, *I, VisitedTypes))
 796         return true;
 797   }
 798   return false;
 799 }
 800 }
 801
 802 //===----------------------------------------------------------------------===//
 803 // Function Type Factory and Value Class...
 804 //
 805 const IntegerType *IntegerType::get(LLVMContext &C, unsigned NumBits) {
 806   assert(NumBits >= MIN_INT_BITS && "bitwidth too small");
 807   assert(NumBits <= MAX_INT_BITS && "bitwidth too large");
 808
 809   // Check for the built-in integer types
 810   switch (NumBits) {
 811     case  1: return cast<IntegerType>(Type::getInt1Ty(C));
 812     case  8: return cast<IntegerType>(Type::getInt8Ty(C));
 813     case 16: return cast<IntegerType>(Type::getInt16Ty(C));
 814     case 32: return cast<IntegerType>(Type::getInt32Ty(C));
 815     case 64: return cast<IntegerType>(Type::getInt64Ty(C));
 816     default:
 817       break;
 818   }
 819
 820   LLVMContextImpl *pImpl = C.pImpl;
 821
 822   IntegerValType IVT(NumBits);
 823   IntegerType *ITy = 0;
 824
 825   // First, see if the type is already in the table, for which
 826   // a reader lock suffices.
 827   ITy = pImpl->IntegerTypes.get(IVT);
 828
 829   if (!ITy) {
 830     // Value not found.  Derive a new type!
 831     ITy = new IntegerType(C, NumBits);
 832     pImpl->IntegerTypes.add(IVT, ITy);
 833   }
 834 #ifdef DEBUG_MERGE_TYPES
 835   DEBUG(dbgs() << "Derived new type: " << *ITy << "\n");
 836 #endif
 837   return ITy;
 838 }
 839
 840 bool IntegerType::isPowerOf2ByteWidth() const {
 841   unsigned BitWidth = getBitWidth();
 842   return (BitWidth > 7) && isPowerOf2_32(BitWidth);
 843 }
 844
 845 APInt IntegerType::getMask() const {
 846   return APInt::getAllOnesValue(getBitWidth());
 847 }
 848
 849 FunctionValType FunctionValType::get(const FunctionType *FT) {
 850   // Build up a FunctionValType
 851   std::vector<const Type *> ParamTypes;
 852   ParamTypes.reserve(FT->getNumParams());
 853   for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i)
 854     ParamTypes.push_back(FT->getParamType(i));
 855   return FunctionValType(FT->getReturnType(), ParamTypes, FT->isVarArg());
 856 }
 857
 858
 859 // FunctionType::get - The factory function for the FunctionType class...
 860 FunctionType *FunctionType::get(const Type *ReturnType,
 861                                 const std::vector<const Type*> &Params,
 862                                 bool isVarArg) {
 863   FunctionValType VT(ReturnType, Params, isVarArg);
 864   FunctionType *FT = 0;
 865
 866   LLVMContextImpl *pImpl = ReturnType->getContext().pImpl;
 867
 868   FT = pImpl->FunctionTypes.get(VT);
 869
 870   if (!FT) {
 871     FT = (FunctionType*) operator new(sizeof(FunctionType) +
 872                                     sizeof(PATypeHandle)*(Params.size()+1));
 873     new (FT) FunctionType(ReturnType, Params, isVarArg);
 874     pImpl->FunctionTypes.add(VT, FT);
 875   }
 876
 877 #ifdef DEBUG_MERGE_TYPES
 878   DEBUG(dbgs() << "Derived new type: " << FT << "\n");
 879 #endif
 880   return FT;
 881 }
 882
 883 ArrayType *ArrayType::get(const Type *ElementType, uint64_t NumElements) {
 884   assert(ElementType && "Can't get array of <null> types!");
 885   assert(isValidElementType(ElementType) && "Invalid type for array element!");
 886
 887   ArrayValType AVT(ElementType, NumElements);
 888   ArrayType *AT = 0;
 889
 890   LLVMContextImpl *pImpl = ElementType->getContext().pImpl;
 891
 892   AT = pImpl->ArrayTypes.get(AVT);
 893
 894   if (!AT) {
 895     // Value not found.  Derive a new type!
 896     pImpl->ArrayTypes.add(AVT, AT = new ArrayType(ElementType, NumElements));
 897   }
 898 #ifdef DEBUG_MERGE_TYPES
 899   DEBUG(dbgs() << "Derived new type: " << *AT << "\n");
 900 #endif
 901   return AT;
 902 }
 903
 904 bool ArrayType::isValidElementType(const Type *ElemTy) {
 905   return ElemTy->getTypeID() != VoidTyID && ElemTy->getTypeID() != LabelTyID &&
 906          ElemTy->getTypeID() != MetadataTyID && !ElemTy->isFunctionTy();
 907 }
 908
 909 VectorType *VectorType::get(const Type *ElementType, unsigned NumElements) {
 910   assert(ElementType && "Can't get vector of <null> types!");
 911
 912   VectorValType PVT(ElementType, NumElements);
 913   VectorType *PT = 0;
 914
 915   LLVMContextImpl *pImpl = ElementType->getContext().pImpl;
 916
 917   PT = pImpl->VectorTypes.get(PVT);
 918
 919   if (!PT) {
 920     pImpl->VectorTypes.add(PVT, PT = new VectorType(ElementType, NumElements));
 921   }
 922 #ifdef DEBUG_MERGE_TYPES
 923   DEBUG(dbgs() << "Derived new type: " << *PT << "\n");
 924 #endif
 925   return PT;
 926 }
 927
 928 bool VectorType::isValidElementType(const Type *ElemTy) {
 929   return ElemTy->isIntegerTy() || ElemTy->isFloatingPointTy() ||
 930          ElemTy->isOpaqueTy();
 931 }
 932
 933 //===----------------------------------------------------------------------===//
 934 // Struct Type Factory...
 935 //
 936
 937 StructType *StructType::get(LLVMContext &Context,
 938                             const std::vector<const Type*> &ETypes,
 939                             bool isPacked) {
 940   StructValType STV(ETypes, isPacked);
 941   StructType *ST = 0;
 942
 943   LLVMContextImpl *pImpl = Context.pImpl;
 944
 945   ST = pImpl->StructTypes.get(STV);
 946
 947   if (!ST) {
 948     // Value not found.  Derive a new type!
 949     ST = (StructType*) operator new(sizeof(StructType) +
 950                                     sizeof(PATypeHandle) * ETypes.size());
 951     new (ST) StructType(Context, ETypes, isPacked);
 952     pImpl->StructTypes.add(STV, ST);
 953   }
 954 #ifdef DEBUG_MERGE_TYPES
 955   DEBUG(dbgs() << "Derived new type: " << *ST << "\n");
 956 #endif
 957   return ST;
 958 }
 959
 960 StructType *StructType::get(LLVMContext &Context, const Type *type, ...) {
 961   va_list ap;
 962   std::vector<const llvm::Type*> StructFields;
 963   va_start(ap, type);
 964   while (type) {
 965     StructFields.push_back(type);
 966     type = va_arg(ap, llvm::Type*);
 967   }
 968   return llvm::StructType::get(Context, StructFields);
 969 }
 970
 971 bool StructType::isValidElementType(const Type *ElemTy) {
 972   return !ElemTy->isVoidTy() && !ElemTy->isLabelTy() &&
 973          !ElemTy->isMetadataTy() && !ElemTy->isFunctionTy();
 974 }
 975
 976
 977 //===----------------------------------------------------------------------===//
 978 // Union Type Factory...
 979 //
 980
 981 UnionType *UnionType::get(const Type* const* Types, unsigned NumTypes) {
 982   assert(NumTypes > 0 && "union must have at least one member type!");
 983   UnionValType UTV(Types, NumTypes);
 984   UnionType *UT = 0;
 985
 986   LLVMContextImpl *pImpl = Types[0]->getContext().pImpl;
 987
 988   UT = pImpl->UnionTypes.get(UTV);
 989
 990   if (!UT) {
 991     // Value not found.  Derive a new type!
 992     UT = (UnionType*) operator new(sizeof(UnionType) +
 993                                    sizeof(PATypeHandle) * NumTypes);
 994     new (UT) UnionType(Types[0]->getContext(), Types, NumTypes);
 995     pImpl->UnionTypes.add(UTV, UT);
 996   }
 997 #ifdef DEBUG_MERGE_TYPES
 998   DEBUG(dbgs() << "Derived new type: " << *UT << "\n");
 999 #endif
1000   return UT;
1001 }
1002
1003 UnionType *UnionType::get(const Type *type, ...) {
1004   va_list ap;
1005   SmallVector<const llvm::Type*, 8> UnionFields;
1006   va_start(ap, type);
1007   while (type) {
1008     UnionFields.push_back(type);
1009     type = va_arg(ap, llvm::Type*);
1010   }
1011   unsigned NumTypes = UnionFields.size();
1012   assert(NumTypes > 0 && "union must have at least one member type!");
1013   return llvm::UnionType::get(&UnionFields[0], NumTypes);
1014 }
1015
1016 bool UnionType::isValidElementType(const Type *ElemTy) {
1017   return !ElemTy->isVoidTy() && !ElemTy->isLabelTy() &&
1018          !ElemTy->isMetadataTy() && !ElemTy->isFunctionTy();
1019 }
1020
1021 int UnionType::getElementTypeIndex(const Type *ElemTy) const {
1022   int index = 0;
1023   for (UnionType::element_iterator I = element_begin(), E = element_end();
1024        I != E; ++I, ++index) {
1025      if (ElemTy == *I) return index;
1026   }
1027
1028   return -1;
1029 }
1030
1031 //===----------------------------------------------------------------------===//
1032 // Pointer Type Factory...
1033 //
1034
1035 PointerType *PointerType::get(const Type *ValueType, unsigned AddressSpace) {
1036   assert(ValueType && "Can't get a pointer to <null> type!");
1037   assert(ValueType->getTypeID() != VoidTyID &&
1038          "Pointer to void is not valid, use i8* instead!");
1039   assert(isValidElementType(ValueType) && "Invalid type for pointer element!");
1040   PointerValType PVT(ValueType, AddressSpace);
1041
1042   PointerType *PT = 0;
1043
1044   LLVMContextImpl *pImpl = ValueType->getContext().pImpl;
1045
1046   PT = pImpl->PointerTypes.get(PVT);
1047
1048   if (!PT) {
1049     // Value not found.  Derive a new type!
1050     pImpl->PointerTypes.add(PVT, PT = new PointerType(ValueType, AddressSpace));
1051   }
1052 #ifdef DEBUG_MERGE_TYPES
1053   DEBUG(dbgs() << "Derived new type: " << *PT << "\n");
1054 #endif
1055   return PT;
1056 }
1057
1058 const PointerType *Type::getPointerTo(unsigned addrs) const {
1059   return PointerType::get(this, addrs);
1060 }
1061
1062 bool PointerType::isValidElementType(const Type *ElemTy) {
1063   return ElemTy->getTypeID() != VoidTyID &&
1064          ElemTy->getTypeID() != LabelTyID &&
1065          ElemTy->getTypeID() != MetadataTyID;
1066 }
1067
1068
1069 //===----------------------------------------------------------------------===//
1070 // Opaque Type Factory...
1071 //
1072
1073 OpaqueType *OpaqueType::get(LLVMContext &C) {
1074   OpaqueType *OT = new OpaqueType(C);           // All opaque types are distinct
1075
1076   LLVMContextImpl *pImpl = C.pImpl;
1077   pImpl->OpaqueTypes.insert(OT);
1078   return OT;
1079 }
1080
1081
1082
1083 //===----------------------------------------------------------------------===//
1084 //                     Derived Type Refinement Functions
1085 //===----------------------------------------------------------------------===//
1086
1087 // addAbstractTypeUser - Notify an abstract type that there is a new user of
1088 // it.  This function is called primarily by the PATypeHandle class.
1089 void Type::addAbstractTypeUser(AbstractTypeUser *U) const {
1090   assert(isAbstract() && "addAbstractTypeUser: Current type not abstract!");
1091   AbstractTypeUsers.push_back(U);
1092 }
1093
1094
1095 // removeAbstractTypeUser - Notify an abstract type that a user of the class
1096 // no longer has a handle to the type.  This function is called primarily by
1097 // the PATypeHandle class.  When there are no users of the abstract type, it
1098 // is annihilated, because there is no way to get a reference to it ever again.
1099 //
1100 void Type::removeAbstractTypeUser(AbstractTypeUser *U) const {
1101
1102   // Search from back to front because we will notify users from back to
1103   // front.  Also, it is likely that there will be a stack like behavior to
1104   // users that register and unregister users.
1105   //
1106   unsigned i;
1107   for (i = AbstractTypeUsers.size(); AbstractTypeUsers[i-1] != U; --i)
1108     assert(i != 0 && "AbstractTypeUser not in user list!");
1109
1110   --i;  // Convert to be in range 0 <= i < size()
1111   assert(i < AbstractTypeUsers.size() && "Index out of range!");  // Wraparound?
1112
1113   AbstractTypeUsers.erase(AbstractTypeUsers.begin()+i);
1114
1115 #ifdef DEBUG_MERGE_TYPES
1116   DEBUG(dbgs() << "  remAbstractTypeUser[" << (void*)this << ", "
1117                << *this << "][" << i << "] User = " << U << "\n");
1118 #endif
1119
1120   if (AbstractTypeUsers.empty() && getRefCount() == 0 && isAbstract()) {
1121 #ifdef DEBUG_MERGE_TYPES
1122     DEBUG(dbgs() << "DELETEing unused abstract type: <" << *this
1123                  << ">[" << (void*)this << "]" << "\n");
1124 #endif
1125
1126   this->destroy();
1127   }
1128
1129 }
1130
1131 // refineAbstractTypeTo - This function is used when it is discovered
1132 // that the 'this' abstract type is actually equivalent to the NewType
1133 // specified. This causes all users of 'this' to switch to reference the more
1134 // concrete type NewType and for 'this' to be deleted.  Only used for internal
1135 // callers.
1136 //
1137 void DerivedType::refineAbstractTypeTo(const Type *NewType) {
1138   assert(isAbstract() && "refineAbstractTypeTo: Current type is not abstract!");
1139   assert(this != NewType && "Can't refine to myself!");
1140   assert(ForwardType == 0 && "This type has already been refined!");
1141
1142   LLVMContextImpl *pImpl = getContext().pImpl;
1143
1144   // The descriptions may be out of date.  Conservatively clear them all!
1145   pImpl->AbstractTypeDescriptions.clear();
1146
1147 #ifdef DEBUG_MERGE_TYPES
1148   DEBUG(dbgs() << "REFINING abstract type [" << (void*)this << " "
1149                << *this << "] to [" << (void*)NewType << " "
1150                << *NewType << "]!\n");
1151 #endif
1152
1153   // Make sure to put the type to be refined to into a holder so that if IT gets
1154   // refined, that we will not continue using a dead reference...
1155   //
1156   PATypeHolder NewTy(NewType);
1157   // Any PATypeHolders referring to this type will now automatically forward to
1158   // the type we are resolved to.
1159   ForwardType = NewType;
1160   if (ForwardType->isAbstract())
1161     ForwardType->addRef();
1162
1163   // Add a self use of the current type so that we don't delete ourself until
1164   // after the function exits.
1165   //
1166   PATypeHolder CurrentTy(this);
1167
1168   // To make the situation simpler, we ask the subclass to remove this type from
1169   // the type map, and to replace any type uses with uses of non-abstract types.
1170   // This dramatically limits the amount of recursive type trouble we can find
1171   // ourselves in.
1172   dropAllTypeUses();
1173
1174   // Iterate over all of the uses of this type, invoking callback.  Each user
1175   // should remove itself from our use list automatically.  We have to check to
1176   // make sure that NewTy doesn't _become_ 'this'.  If it does, resolving types
1177   // will not cause users to drop off of the use list.  If we resolve to ourself
1178   // we succeed!
1179   //
1180   while (!AbstractTypeUsers.empty() && NewTy != this) {
1181     AbstractTypeUser *User = AbstractTypeUsers.back();
1182
1183     unsigned OldSize = AbstractTypeUsers.size(); OldSize=OldSize;
1184 #ifdef DEBUG_MERGE_TYPES
1185     DEBUG(dbgs() << " REFINING user " << OldSize-1 << "[" << (void*)User
1186                  << "] of abstract type [" << (void*)this << " "
1187                  << *this << "] to [" << (void*)NewTy.get() << " "
1188                  << *NewTy << "]!\n");
1189 #endif
1190     User->refineAbstractType(this, NewTy);
1191
1192     assert(AbstractTypeUsers.size() != OldSize &&
1193            "AbsTyUser did not remove self from user list!");
1194   }
1195
1196   // If we were successful removing all users from the type, 'this' will be
1197   // deleted when the last PATypeHolder is destroyed or updated from this type.
1198   // This may occur on exit of this function, as the CurrentTy object is
1199   // destroyed.
1200 }
1201
1202 // notifyUsesThatTypeBecameConcrete - Notify AbstractTypeUsers of this type that
1203 // the current type has transitioned from being abstract to being concrete.
1204 //
1205 void DerivedType::notifyUsesThatTypeBecameConcrete() {
1206 #ifdef DEBUG_MERGE_TYPES
1207   DEBUG(dbgs() << "typeIsREFINED type: " << (void*)this << " " << *this <<"\n");
1208 #endif
1209
1210   unsigned OldSize = AbstractTypeUsers.size(); OldSize=OldSize;
1211   while (!AbstractTypeUsers.empty()) {
1212     AbstractTypeUser *ATU = AbstractTypeUsers.back();
1213     ATU->typeBecameConcrete(this);
1214
1215     assert(AbstractTypeUsers.size() < OldSize-- &&
1216            "AbstractTypeUser did not remove itself from the use list!");
1217   }
1218 }
1219
1220 // refineAbstractType - Called when a contained type is found to be more
1221 // concrete - this could potentially change us from an abstract type to a
1222 // concrete type.
1223 //
1224 void FunctionType::refineAbstractType(const DerivedType *OldType,
1225                                       const Type *NewType) {
1226   LLVMContextImpl *pImpl = OldType->getContext().pImpl;
1227   pImpl->FunctionTypes.RefineAbstractType(this, OldType, NewType);
1228 }
1229
1230 void FunctionType::typeBecameConcrete(const DerivedType *AbsTy) {
1231   LLVMContextImpl *pImpl = AbsTy->getContext().pImpl;
1232   pImpl->FunctionTypes.TypeBecameConcrete(this, AbsTy);
1233 }
1234
1235
1236 // refineAbstractType - Called when a contained type is found to be more
1237 // concrete - this could potentially change us from an abstract type to a
1238 // concrete type.
1239 //
1240 void ArrayType::refineAbstractType(const DerivedType *OldType,
1241                                    const Type *NewType) {
1242   LLVMContextImpl *pImpl = OldType->getContext().pImpl;
1243   pImpl->ArrayTypes.RefineAbstractType(this, OldType, NewType);
1244 }
1245
1246 void ArrayType::typeBecameConcrete(const DerivedType *AbsTy) {
1247   LLVMContextImpl *pImpl = AbsTy->getContext().pImpl;
1248   pImpl->ArrayTypes.TypeBecameConcrete(this, AbsTy);
1249 }
1250
1251 // refineAbstractType - Called when a contained type is found to be more
1252 // concrete - this could potentially change us from an abstract type to a
1253 // concrete type.
1254 //
1255 void VectorType::refineAbstractType(const DerivedType *OldType,
1256                                    const Type *NewType) {
1257   LLVMContextImpl *pImpl = OldType->getContext().pImpl;
1258   pImpl->VectorTypes.RefineAbstractType(this, OldType, NewType);
1259 }
1260
1261 void VectorType::typeBecameConcrete(const DerivedType *AbsTy) {
1262   LLVMContextImpl *pImpl = AbsTy->getContext().pImpl;
1263   pImpl->VectorTypes.TypeBecameConcrete(this, AbsTy);
1264 }
1265
1266 // refineAbstractType - Called when a contained type is found to be more
1267 // concrete - this could potentially change us from an abstract type to a
1268 // concrete type.
1269 //
1270 void StructType::refineAbstractType(const DerivedType *OldType,
1271                                     const Type *NewType) {
1272   LLVMContextImpl *pImpl = OldType->getContext().pImpl;
1273   pImpl->StructTypes.RefineAbstractType(this, OldType, NewType);
1274 }
1275
1276 void StructType::typeBecameConcrete(const DerivedType *AbsTy) {
1277   LLVMContextImpl *pImpl = AbsTy->getContext().pImpl;
1278   pImpl->StructTypes.TypeBecameConcrete(this, AbsTy);
1279 }
1280
1281 // refineAbstractType - Called when a contained type is found to be more
1282 // concrete - this could potentially change us from an abstract type to a
1283 // concrete type.
1284 //
1285 void UnionType::refineAbstractType(const DerivedType *OldType,
1286                                     const Type *NewType) {
1287   LLVMContextImpl *pImpl = OldType->getContext().pImpl;
1288   pImpl->UnionTypes.RefineAbstractType(this, OldType, NewType);
1289 }
1290
1291 void UnionType::typeBecameConcrete(const DerivedType *AbsTy) {
1292   LLVMContextImpl *pImpl = AbsTy->getContext().pImpl;
1293   pImpl->UnionTypes.TypeBecameConcrete(this, AbsTy);
1294 }
1295
1296 // refineAbstractType - Called when a contained type is found to be more
1297 // concrete - this could potentially change us from an abstract type to a
1298 // concrete type.
1299 //
1300 void PointerType::refineAbstractType(const DerivedType *OldType,
1301                                      const Type *NewType) {
1302   LLVMContextImpl *pImpl = OldType->getContext().pImpl;
1303   pImpl->PointerTypes.RefineAbstractType(this, OldType, NewType);
1304 }
1305
1306 void PointerType::typeBecameConcrete(const DerivedType *AbsTy) {
1307   LLVMContextImpl *pImpl = AbsTy->getContext().pImpl;
1308   pImpl->PointerTypes.TypeBecameConcrete(this, AbsTy);
1309 }
1310
1311 bool SequentialType::indexValid(const Value *V) const {
1312   if (V->getType()->isIntegerTy())
1313     return true;
1314   return false;
1315 }
1316
1317 namespace llvm {
1318 raw_ostream &operator<<(raw_ostream &OS, const Type &T) {
1319   T.print(OS);
1320   return OS;
1321 }
1322 }