lib/VMCore/TypesContext.h

   1 //===-- TypesContext.h - Types-related Context Internals ------------------===//
   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 defines various helper methods and classes used by
  11 // LLVMContextImpl for creating and managing types.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_TYPESCONTEXT_H
  16 #define LLVM_TYPESCONTEXT_H
  17
  18 #include "llvm/ADT/STLExtras.h"
  19 #include <map>
  20
  21
  22 //===----------------------------------------------------------------------===//
  23 //                       Derived Type Factory Functions
  24 //===----------------------------------------------------------------------===//
  25 namespace llvm {
  26
  27 /// getSubElementHash - Generate a hash value for all of the SubType's of this
  28 /// type.  The hash value is guaranteed to be zero if any of the subtypes are
  29 /// an opaque type.  Otherwise we try to mix them in as well as possible, but do
  30 /// not look at the subtype's subtype's.
  31 static unsigned getSubElementHash(const Type *Ty) {
  32   unsigned HashVal = 0;
  33   for (Type::subtype_iterator I = Ty->subtype_begin(), E = Ty->subtype_end();
  34        I != E; ++I) {
  35     HashVal *= 32;
  36     const Type *SubTy = I->get();
  37     HashVal += SubTy->getTypeID();
  38     switch (SubTy->getTypeID()) {
  39     default: break;
  40     case Type::OpaqueTyID: return 0;    // Opaque -> hash = 0 no matter what.
  41     case Type::IntegerTyID:
  42       HashVal ^= (cast<IntegerType>(SubTy)->getBitWidth() << 3);
  43       break;
  44     case Type::FunctionTyID:
  45       HashVal ^= cast<FunctionType>(SubTy)->getNumParams()*2 +
  46                  cast<FunctionType>(SubTy)->isVarArg();
  47       break;
  48     case Type::ArrayTyID:
  49       HashVal ^= cast<ArrayType>(SubTy)->getNumElements();
  50       break;
  51     case Type::VectorTyID:
  52       HashVal ^= cast<VectorType>(SubTy)->getNumElements();
  53       break;
  54     case Type::StructTyID:
  55       HashVal ^= cast<StructType>(SubTy)->getNumElements();
  56       break;
  57     case Type::PointerTyID:
  58       HashVal ^= cast<PointerType>(SubTy)->getAddressSpace();
  59       break;
  60     }
  61   }
  62   return HashVal ? HashVal : 1;  // Do not return zero unless opaque subty.
  63 }
  64
  65 //===----------------------------------------------------------------------===//
  66 // Integer Type Factory...
  67 //
  68 class IntegerValType {
  69   uint32_t bits;
  70 public:
  71   IntegerValType(uint32_t numbits) : bits(numbits) {}
  72
  73   static IntegerValType get(const IntegerType *Ty) {
  74     return IntegerValType(Ty->getBitWidth());
  75   }
  76
  77   static unsigned hashTypeStructure(const IntegerType *Ty) {
  78     return (unsigned)Ty->getBitWidth();
  79   }
  80
  81   inline bool operator<(const IntegerValType &IVT) const {
  82     return bits < IVT.bits;
  83   }
  84 };
  85
  86 // PointerValType - Define a class to hold the key that goes into the TypeMap
  87 //
  88 class PointerValType {
  89   const Type *ValTy;
  90   unsigned AddressSpace;
  91 public:
  92   PointerValType(const Type *val, unsigned as) : ValTy(val), AddressSpace(as) {}
  93
  94   static PointerValType get(const PointerType *PT) {
  95     return PointerValType(PT->getElementType(), PT->getAddressSpace());
  96   }
  97
  98   static unsigned hashTypeStructure(const PointerType *PT) {
  99     return getSubElementHash(PT);
 100   }
 101
 102   bool operator<(const PointerValType &MTV) const {
 103     if (AddressSpace < MTV.AddressSpace) return true;
 104     return AddressSpace == MTV.AddressSpace && ValTy < MTV.ValTy;
 105   }
 106 };
 107
 108 //===----------------------------------------------------------------------===//
 109 // Array Type Factory...
 110 //
 111 class ArrayValType {
 112   const Type *ValTy;
 113   uint64_t Size;
 114 public:
 115   ArrayValType(const Type *val, uint64_t sz) : ValTy(val), Size(sz) {}
 116
 117   static ArrayValType get(const ArrayType *AT) {
 118     return ArrayValType(AT->getElementType(), AT->getNumElements());
 119   }
 120
 121   static unsigned hashTypeStructure(const ArrayType *AT) {
 122     return (unsigned)AT->getNumElements();
 123   }
 124
 125   inline bool operator<(const ArrayValType &MTV) const {
 126     if (Size < MTV.Size) return true;
 127     return Size == MTV.Size && ValTy < MTV.ValTy;
 128   }
 129 };
 130
 131 //===----------------------------------------------------------------------===//
 132 // Vector Type Factory...
 133 //
 134 class VectorValType {
 135   const Type *ValTy;
 136   unsigned Size;
 137 public:
 138   VectorValType(const Type *val, int sz) : ValTy(val), Size(sz) {}
 139
 140   static VectorValType get(const VectorType *PT) {
 141     return VectorValType(PT->getElementType(), PT->getNumElements());
 142   }
 143
 144   static unsigned hashTypeStructure(const VectorType *PT) {
 145     return PT->getNumElements();
 146   }
 147
 148   inline bool operator<(const VectorValType &MTV) const {
 149     if (Size < MTV.Size) return true;
 150     return Size == MTV.Size && ValTy < MTV.ValTy;
 151   }
 152 };
 153
 154 // StructValType - Define a class to hold the key that goes into the TypeMap
 155 //
 156 class StructValType {
 157   std::vector<const Type*> ElTypes;
 158   bool packed;
 159 public:
 160   StructValType(const std::vector<const Type*> &args, bool isPacked)
 161     : ElTypes(args), packed(isPacked) {}
 162
 163   static StructValType get(const StructType *ST) {
 164     std::vector<const Type *> ElTypes;
 165     ElTypes.reserve(ST->getNumElements());
 166     for (unsigned i = 0, e = ST->getNumElements(); i != e; ++i)
 167       ElTypes.push_back(ST->getElementType(i));
 168
 169     return StructValType(ElTypes, ST->isPacked());
 170   }
 171
 172   static unsigned hashTypeStructure(const StructType *ST) {
 173     return ST->getNumElements();
 174   }
 175
 176   inline bool operator<(const StructValType &STV) const {
 177     if (ElTypes < STV.ElTypes) return true;
 178     else if (ElTypes > STV.ElTypes) return false;
 179     else return (int)packed < (int)STV.packed;
 180   }
 181 };
 182
 183 // FunctionValType - Define a class to hold the key that goes into the TypeMap
 184 //
 185 class FunctionValType {
 186   const Type *RetTy;
 187   std::vector<const Type*> ArgTypes;
 188   bool isVarArg;
 189 public:
 190   FunctionValType(const Type *ret, const std::vector<const Type*> &args,
 191                   bool isVA) : RetTy(ret), ArgTypes(args), isVarArg(isVA) {}
 192
 193   static FunctionValType get(const FunctionType *FT);
 194
 195   static unsigned hashTypeStructure(const FunctionType *FT) {
 196     unsigned Result = FT->getNumParams()*2 + FT->isVarArg();
 197     return Result;
 198   }
 199
 200   inline bool operator<(const FunctionValType &MTV) const {
 201     if (RetTy < MTV.RetTy) return true;
 202     if (RetTy > MTV.RetTy) return false;
 203     if (isVarArg < MTV.isVarArg) return true;
 204     if (isVarArg > MTV.isVarArg) return false;
 205     if (ArgTypes < MTV.ArgTypes) return true;
 206     if (ArgTypes > MTV.ArgTypes) return false;
 207     return false;
 208   }
 209 };
 210
 211 class TypeMapBase {
 212 protected:
 213   /// TypesByHash - Keep track of types by their structure hash value.  Note
 214   /// that we only keep track of types that have cycles through themselves in
 215   /// this map.
 216   ///
 217   std::multimap<unsigned, PATypeHolder> TypesByHash;
 218
 219   ~TypeMapBase() {
 220     // PATypeHolder won't destroy non-abstract types.
 221     // We can't destroy them by simply iterating, because
 222     // they may contain references to each-other.
 223     for (std::multimap<unsigned, PATypeHolder>::iterator I
 224          = TypesByHash.begin(), E = TypesByHash.end(); I != E; ++I) {
 225       Type *Ty = const_cast<Type*>(I->second.Ty);
 226       I->second.destroy();
 227       // We can't invoke destroy or delete, because the type may
 228       // contain references to already freed types.
 229       // So we have to destruct the object the ugly way.
 230       if (Ty) {
 231         Ty->AbstractTypeUsers.clear();
 232         static_cast<const Type*>(Ty)->Type::~Type();
 233         operator delete(Ty);
 234       }
 235     }
 236   }
 237
 238 public:
 239   void RemoveFromTypesByHash(unsigned Hash, const Type *Ty) {
 240     std::multimap<unsigned, PATypeHolder>::iterator I =
 241       TypesByHash.lower_bound(Hash);
 242     for (; I != TypesByHash.end() && I->first == Hash; ++I) {
 243       if (I->second == Ty) {
 244         TypesByHash.erase(I);
 245         return;
 246       }
 247     }
 248
 249     // This must be do to an opaque type that was resolved.  Switch down to hash
 250     // code of zero.
 251     assert(Hash && "Didn't find type entry!");
 252     RemoveFromTypesByHash(0, Ty);
 253   }
 254
 255   /// TypeBecameConcrete - When Ty gets a notification that TheType just became
 256   /// concrete, drop uses and make Ty non-abstract if we should.
 257   void TypeBecameConcrete(DerivedType *Ty, const DerivedType *TheType) {
 258     // If the element just became concrete, remove 'ty' from the abstract
 259     // type user list for the type.  Do this for as many times as Ty uses
 260     // OldType.
 261     for (Type::subtype_iterator I = Ty->subtype_begin(), E = Ty->subtype_end();
 262          I != E; ++I)
 263       if (I->get() == TheType)
 264         TheType->removeAbstractTypeUser(Ty);
 265
 266     // If the type is currently thought to be abstract, rescan all of our
 267     // subtypes to see if the type has just become concrete!  Note that this
 268     // may send out notifications to AbstractTypeUsers that types become
 269     // concrete.
 270     if (Ty->isAbstract())
 271       Ty->PromoteAbstractToConcrete();
 272   }
 273 };
 274
 275 // TypeMap - Make sure that only one instance of a particular type may be
 276 // created on any given run of the compiler... note that this involves updating
 277 // our map if an abstract type gets refined somehow.
 278 //
 279 template<class ValType, class TypeClass>
 280 class TypeMap : public TypeMapBase {
 281   std::map<ValType, PATypeHolder> Map;
 282 public:
 283   typedef typename std::map<ValType, PATypeHolder>::iterator iterator;
 284
 285   inline TypeClass *get(const ValType &V) {
 286     iterator I = Map.find(V);
 287     return I != Map.end() ? cast<TypeClass>((Type*)I->second.get()) : 0;
 288   }
 289
 290   inline void add(const ValType &V, TypeClass *Ty) {
 291     Map.insert(std::make_pair(V, Ty));
 292
 293     // If this type has a cycle, remember it.
 294     TypesByHash.insert(std::make_pair(ValType::hashTypeStructure(Ty), Ty));
 295     print("add");
 296   }
 297
 298   /// RefineAbstractType - This method is called after we have merged a type
 299   /// with another one.  We must now either merge the type away with
 300   /// some other type or reinstall it in the map with it's new configuration.
 301   void RefineAbstractType(TypeClass *Ty, const DerivedType *OldType,
 302                         const Type *NewType) {
 303 #ifdef DEBUG_MERGE_TYPES
 304     DEBUG(dbgs() << "RefineAbstractType(" << (void*)OldType << "[" << *OldType
 305                  << "], " << (void*)NewType << " [" << *NewType << "])\n");
 306 #endif
 307
 308     // Otherwise, we are changing one subelement type into another.  Clearly the
 309     // OldType must have been abstract, making us abstract.
 310     assert(Ty->isAbstract() && "Refining a non-abstract type!");
 311     assert(OldType != NewType);
 312
 313     // Make a temporary type holder for the type so that it doesn't disappear on
 314     // us when we erase the entry from the map.
 315     PATypeHolder TyHolder = Ty;
 316
 317     // The old record is now out-of-date, because one of the children has been
 318     // updated.  Remove the obsolete entry from the map.
 319     unsigned NumErased = Map.erase(ValType::get(Ty));
 320     assert(NumErased && "Element not found!"); NumErased = NumErased;
 321
 322     // Remember the structural hash for the type before we start hacking on it,
 323     // in case we need it later.
 324     unsigned OldTypeHash = ValType::hashTypeStructure(Ty);
 325
 326     // Find the type element we are refining... and change it now!
 327     for (unsigned i = 0, e = Ty->getNumContainedTypes(); i != e; ++i)
 328       if (Ty->ContainedTys[i] == OldType)
 329         Ty->ContainedTys[i] = NewType;
 330     unsigned NewTypeHash = ValType::hashTypeStructure(Ty);
 331
 332     // If there are no cycles going through this node, we can do a simple,
 333     // efficient lookup in the map, instead of an inefficient nasty linear
 334     // lookup.
 335     if (!TypeHasCycleThroughItself(Ty)) {
 336       typename std::map<ValType, PATypeHolder>::iterator I;
 337       bool Inserted;
 338
 339       tie(I, Inserted) = Map.insert(std::make_pair(ValType::get(Ty), Ty));
 340       if (!Inserted) {
 341         // Refined to a different type altogether?
 342         RemoveFromTypesByHash(OldTypeHash, Ty);
 343
 344         // We already have this type in the table.  Get rid of the newly refined
 345         // type.
 346         TypeClass *NewTy = cast<TypeClass>((Type*)I->second.get());
 347         Ty->refineAbstractTypeTo(NewTy);
 348         return;
 349       }
 350     } else {
 351       // Now we check to see if there is an existing entry in the table which is
 352       // structurally identical to the newly refined type.  If so, this type
 353       // gets refined to the pre-existing type.
 354       //
 355       std::multimap<unsigned, PATypeHolder>::iterator I, E, Entry;
 356       tie(I, E) = TypesByHash.equal_range(NewTypeHash);
 357       Entry = E;
 358       for (; I != E; ++I) {
 359         if (I->second == Ty) {
 360           // Remember the position of the old type if we see it in our scan.
 361           Entry = I;
 362           continue;
 363         }
 364
 365         if (!TypesEqual(Ty, I->second))
 366           continue;
 367
 368         TypeClass *NewTy = cast<TypeClass>((Type*)I->second.get());
 369
 370         // Remove the old entry form TypesByHash.  If the hash values differ
 371         // now, remove it from the old place.  Otherwise, continue scanning
 372         // withing this hashcode to reduce work.
 373         if (NewTypeHash != OldTypeHash) {
 374           RemoveFromTypesByHash(OldTypeHash, Ty);
 375         } else {
 376           if (Entry == E) {
 377             // Find the location of Ty in the TypesByHash structure if we
 378             // haven't seen it already.
 379             while (I->second != Ty) {
 380               ++I;
 381               assert(I != E && "Structure doesn't contain type??");
 382             }
 383             Entry = I;
 384           }
 385           TypesByHash.erase(Entry);
 386         }
 387         Ty->refineAbstractTypeTo(NewTy);
 388         return;
 389       }
 390
 391       // If there is no existing type of the same structure, we reinsert an
 392       // updated record into the map.
 393       Map.insert(std::make_pair(ValType::get(Ty), Ty));
 394     }
 395
 396     // If the hash codes differ, update TypesByHash
 397     if (NewTypeHash != OldTypeHash) {
 398       RemoveFromTypesByHash(OldTypeHash, Ty);
 399       TypesByHash.insert(std::make_pair(NewTypeHash, Ty));
 400     }
 401
 402     // If the type is currently thought to be abstract, rescan all of our
 403     // subtypes to see if the type has just become concrete!  Note that this
 404     // may send out notifications to AbstractTypeUsers that types become
 405     // concrete.
 406     if (Ty->isAbstract())
 407       Ty->PromoteAbstractToConcrete();
 408   }
 409
 410   void print(const char *Arg) const {
 411 #ifdef DEBUG_MERGE_TYPES
 412     DEBUG(dbgs() << "TypeMap<>::" << Arg << " table contents:\n");
 413     unsigned i = 0;
 414     for (typename std::map<ValType, PATypeHolder>::const_iterator I
 415            = Map.begin(), E = Map.end(); I != E; ++I)
 416       DEBUG(dbgs() << " " << (++i) << ". " << (void*)I->second.get() << " "
 417                    << *I->second.get() << "\n");
 418 #endif
 419   }
 420
 421   void dump() const { print("dump output"); }
 422 };
 423 }
 424
 425 #endif