lib/VMCore/SymbolTable.cpp

   1 //===-- SymbolTable.cpp - Implement the SymbolTable class -----------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and revised by Reid
   6 // Spencer. It is distributed under the University of Illinois Open Source
   7 // License. See LICENSE.TXT for details.
   8 //
   9 //===----------------------------------------------------------------------===//
  10 //
  11 // This file implements the SymbolTable class for the VMCore library.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/SymbolTable.h"
  16 #include "llvm/DerivedTypes.h"
  17 #include "llvm/Module.h"
  18 #include "Support/StringExtras.h"
  19 #include <algorithm>
  20 #include <iostream>
  21
  22 using namespace llvm;
  23
  24 #define DEBUG_SYMBOL_TABLE 0
  25 #define DEBUG_ABSTYPE 0
  26
  27 SymbolTable::~SymbolTable() {
  28   // Drop all abstract type references in the type plane...
  29   for (type_iterator TI = tmap.begin(), TE = tmap.end(); TI != TE; ++TI) {
  30     if (TI->second->isAbstract())   // If abstract, drop the reference...
  31       cast<DerivedType>(TI->second)->removeAbstractTypeUser(this);
  32   }
  33
  34  // TODO: FIXME: BIG ONE: This doesn't unreference abstract types for the
  35  // planes that could still have entries!
  36
  37 #ifndef NDEBUG   // Only do this in -g mode...
  38   bool LeftoverValues = true;
  39   for (plane_iterator PI = pmap.begin(); PI != pmap.end(); ++PI) {
  40     for (value_iterator VI = PI->second.begin(); VI != PI->second.end(); ++VI)
  41       if (!isa<Constant>(VI->second) ) {
  42         std::cerr << "Value still in symbol table! Type = '"
  43                   << PI->first->getDescription() << "' Name = '"
  44                   << VI->first << "'\n";
  45         LeftoverValues = false;
  46       }
  47   }
  48
  49   assert(LeftoverValues && "Values remain in symbol table!");
  50 #endif
  51 }
  52
  53 // getUniqueName - Given a base name, return a string that is either equal to
  54 // it (or derived from it) that does not already occur in the symbol table for
  55 // the specified type.
  56 //
  57 std::string SymbolTable::getUniqueName(const Type *Ty,
  58                                        const std::string &BaseName) const {
  59   // Find the plane
  60   plane_const_iterator PI = pmap.find(Ty);
  61   if (PI == pmap.end()) return BaseName;
  62
  63   std::string TryName = BaseName;
  64   const ValueMap& vmap = PI->second;
  65   value_const_iterator End = vmap.end();
  66
  67   // See if the name exists
  68   while (vmap.find(TryName) != End)            // Loop until we find a free
  69     TryName = BaseName + utostr(++LastUnique); // name in the symbol table
  70   return TryName;
  71 }
  72
  73
  74 // lookup a value - Returns null on failure...
  75 Value *SymbolTable::lookup(const Type *Ty, const std::string &Name) const {
  76   plane_const_iterator PI = pmap.find(Ty);
  77   if (PI != pmap.end()) {                  // We have symbols in that plane...
  78     value_const_iterator VI = PI->second.find(Name);
  79     if (VI != PI->second.end())            // and the name is in our hash table...
  80       return VI->second;
  81   }
  82   return 0;
  83 }
  84
  85
  86 // lookup a type by name - returns null on failure
  87 Type* SymbolTable::lookupType( const std::string& Name ) const {
  88   type_const_iterator TI = tmap.find( Name );
  89   if ( TI != tmap.end() )
  90     return const_cast<Type*>(TI->second);
  91   return 0;
  92 }
  93
  94 // Remove a value
  95 void SymbolTable::remove(Value *N) {
  96   assert(N->hasName() && "Value doesn't have name!");
  97   if (InternallyInconsistent) return;
  98
  99   plane_iterator PI = pmap.find(N->getType());
 100   assert(PI != pmap.end() &&
 101          "Trying to remove a value that doesn't have a type plane yet!");
 102   removeEntry(PI, PI->second.find(N->getName()));
 103 }
 104
 105
 106 // removeEntry - Remove a value from the symbol table...
 107 Value *SymbolTable::removeEntry(plane_iterator Plane, value_iterator Entry) {
 108   if (InternallyInconsistent) return 0;
 109   assert(Plane != pmap.end() &&
 110          Entry != Plane->second.end() && "Invalid entry to remove!");
 111
 112   Value *Result = Entry->second;
 113 #if DEBUG_SYMBOL_TABLE
 114   dump();
 115   std::cerr << " Removing Value: " << Result->getName() << "\n";
 116 #endif
 117
 118   // Remove the value from the plane...
 119   Plane->second.erase(Entry);
 120
 121   // If the plane is empty, remove it now!
 122   if (Plane->second.empty()) {
 123     // If the plane represented an abstract type that we were interested in,
 124     // unlink ourselves from this plane.
 125     //
 126     if (Plane->first->isAbstract()) {
 127 #if DEBUG_ABSTYPE
 128       std::cerr << "Plane Empty: Removing type: "
 129                 << Plane->first->getDescription() << "\n";
 130 #endif
 131       cast<DerivedType>(Plane->first)->removeAbstractTypeUser(this);
 132     }
 133
 134     pmap.erase(Plane);
 135   }
 136   return Result;
 137 }
 138
 139
 140 // remove - Remove a type
 141 void SymbolTable::remove(const Type* Ty ) {
 142   type_iterator TI = this->type_begin();
 143   type_iterator TE = this->type_end();
 144
 145   // Search for the entry
 146   while ( TI != TE && TI->second != Ty )
 147     ++TI;
 148
 149   if ( TI != TE )
 150     this->removeEntry( TI );
 151 }
 152
 153
 154 // removeEntry - Remove a type from the symbol table...
 155 Type* SymbolTable::removeEntry(type_iterator Entry) {
 156   if (InternallyInconsistent) return 0;
 157   assert( Entry != tmap.end() && "Invalid entry to remove!");
 158
 159   const Type* Result = Entry->second;
 160
 161 #if DEBUG_SYMBOL_TABLE
 162   dump();
 163   std::cerr << " Removing Value: " << Result->getName() << "\n";
 164 #endif
 165
 166   tmap.erase(Entry);
 167
 168   // If we are removing an abstract type, remove the symbol table from it's use
 169   // list...
 170   if (Result->isAbstract()) {
 171 #if DEBUG_ABSTYPE
 172     std::cerr << "Removing abstract type from symtab" << Result->getDescription()<<"\n";
 173 #endif
 174     cast<DerivedType>(Result)->removeAbstractTypeUser(this);
 175   }
 176
 177   return const_cast<Type*>(Result);
 178 }
 179
 180
 181 // insertEntry - Insert a value into the symbol table with the specified name.
 182 void SymbolTable::insertEntry(const std::string &Name, const Type *VTy,
 183                               Value *V) {
 184   // Check to see if there is a naming conflict.  If so, rename this value!
 185   if (lookup(VTy, Name)) {
 186     std::string UniqueName = getUniqueName(VTy, Name);
 187     assert(InternallyInconsistent == false && "Infinite loop inserting value!");
 188     InternallyInconsistent = true;
 189     V->setName(UniqueName, this);
 190     InternallyInconsistent = false;
 191     return;
 192   }
 193
 194 #if DEBUG_SYMBOL_TABLE
 195   dump();
 196   std::cerr << " Inserting definition: " << Name << ": "
 197             << VTy->getDescription() << "\n";
 198 #endif
 199
 200   plane_iterator PI = pmap.find(VTy);
 201   if (PI == pmap.end()) {      // Not in collection yet... insert dummy entry
 202     // Insert a new empty element.  I points to the new elements.
 203     PI = pmap.insert(make_pair(VTy, ValueMap())).first;
 204     assert(PI != pmap.end() && "How did insert fail?");
 205
 206     // Check to see if the type is abstract.  If so, it might be refined in the
 207     // future, which would cause the plane of the old type to get merged into
 208     // a new type plane.
 209     //
 210     if (VTy->isAbstract()) {
 211       cast<DerivedType>(VTy)->addAbstractTypeUser(this);
 212 #if DEBUG_ABSTYPE
 213       std::cerr << "Added abstract type value: " << VTy->getDescription()
 214                 << "\n";
 215 #endif
 216     }
 217   }
 218
 219   PI->second.insert(make_pair(Name, V));
 220 }
 221
 222
 223 // insertEntry - Insert a value into the symbol table with the specified
 224 // name...
 225 //
 226 void SymbolTable::insertEntry(const std::string& Name, const Type* T) {
 227
 228   // Check to see if there is a naming conflict.  If so, rename this type!
 229   std::string UniqueName = Name;
 230   if (lookupType(Name))
 231     UniqueName = getUniqueName(T, Name);
 232
 233 #if DEBUG_SYMBOL_TABLE
 234   dump();
 235   std::cerr << " Inserting type: " << UniqueName << ": "
 236             << T->getDescription() << "\n";
 237 #endif
 238
 239   // Insert the tmap entry
 240   tmap.insert(make_pair(UniqueName, T));
 241
 242   // If we are adding an abstract type, add the symbol table to it's use list.
 243   if (T->isAbstract()) {
 244     cast<DerivedType>(T)->addAbstractTypeUser(this);
 245 #if DEBUG_ABSTYPE
 246     std::cerr << "Added abstract type to ST: " << T->getDescription() << "\n";
 247 #endif
 248   }
 249 }
 250
 251
 252 // Determine how many entries for a given type.
 253 unsigned SymbolTable::type_size(const Type *Ty) const {
 254   plane_const_iterator PI = pmap.find(Ty);
 255   if ( PI == pmap.end() ) return 0;
 256   return PI->second.size();
 257 }
 258
 259
 260 // Get the name of a value
 261 std::string SymbolTable::get_name( const Value* V ) const {
 262   value_const_iterator VI = this->value_begin( V->getType() );
 263   value_const_iterator VE = this->value_end( V->getType() );
 264
 265   // Search for the entry
 266   while ( VI != VE && VI->second != V )
 267     ++VI;
 268
 269   if ( VI != VE )
 270     return VI->first;
 271
 272   return "";
 273 }
 274
 275
 276 // Get the name of a type
 277 std::string SymbolTable::get_name( const Type* T ) const {
 278   if (tmap.empty()) return ""; // No types at all.
 279
 280   type_const_iterator TI = tmap.begin();
 281   type_const_iterator TE = tmap.end();
 282
 283   // Search for the entry
 284   while (TI != TE && TI->second != T )
 285     ++TI;
 286
 287   if (TI != TE)  // Must have found an entry!
 288     return TI->first;
 289   return "";     // Must not have found anything...
 290 }
 291
 292
 293 // Strip the symbol table of its names.
 294 bool SymbolTable::strip( void ) {
 295   bool RemovedSymbol = false;
 296   for (plane_iterator I = pmap.begin(); I != pmap.end();) {
 297     // Removing items from the plane can cause the plane itself to get deleted.
 298     // If this happens, make sure we incremented our plane iterator already!
 299     ValueMap &Plane = (I++)->second;
 300     value_iterator B = Plane.begin(), Bend = Plane.end();
 301     while (B != Bend) {   // Found nonempty type plane!
 302       Value *V = B->second;
 303       if (!isa<GlobalValue>(V) || cast<GlobalValue>(V)->hasInternalLinkage()){
 304         // Set name to "", removing from symbol table!
 305         V->setName("", this);
 306         RemovedSymbol = true;
 307       } else if (isa<Constant>(V) ) {
 308         remove(V);
 309         RemovedSymbol = true;
 310       }
 311       ++B;
 312     }
 313   }
 314
 315   for (type_iterator TI = tmap.begin(); TI != tmap.end(); ) {
 316     const Type* T = (TI++)->second;
 317     remove(T);
 318     RemovedSymbol = true;
 319   }
 320
 321   return RemovedSymbol;
 322 }
 323
 324
 325 // This function is called when one of the types in the type plane are refined
 326 void SymbolTable::refineAbstractType(const DerivedType *OldType,
 327                                      const Type *NewType) {
 328
 329   // Search to see if we have any values of the type Oldtype.  If so, we need to
 330   // move them into the newtype plane...
 331   plane_iterator PI = pmap.find(OldType);
 332   if (PI != pmap.end()) {
 333     // Get a handle to the new type plane...
 334     plane_iterator NewTypeIt = pmap.find(NewType);
 335     if (NewTypeIt == pmap.end()) {      // If no plane exists, add one
 336       NewTypeIt = pmap.insert(make_pair(NewType, ValueMap())).first;
 337
 338       if (NewType->isAbstract()) {
 339         cast<DerivedType>(NewType)->addAbstractTypeUser(this);
 340 #if DEBUG_ABSTYPE
 341         std::cerr << "[Added] refined to abstype: " << NewType->getDescription()
 342                   << "\n";
 343 #endif
 344       }
 345     }
 346
 347     ValueMap &NewPlane = NewTypeIt->second;
 348     ValueMap &OldPlane = PI->second;
 349     while (!OldPlane.empty()) {
 350       std::pair<const std::string, Value*> V = *OldPlane.begin();
 351
 352       // Check to see if there is already a value in the symbol table that this
 353       // would collide with.
 354       value_iterator VI = NewPlane.find(V.first);
 355       if (VI != NewPlane.end() && VI->second == V.second) {
 356         // No action
 357
 358       } else if (VI != NewPlane.end()) {
 359         // The only thing we are allowing for now is two external global values
 360         // folded into one.
 361         //
 362         GlobalValue *ExistGV = dyn_cast<GlobalValue>(VI->second);
 363         GlobalValue *NewGV = dyn_cast<GlobalValue>(V.second);
 364
 365         if (ExistGV && NewGV) {
 366           assert((ExistGV->isExternal() || NewGV->isExternal()) &&
 367                  "Two planes folded together with overlapping value names!");
 368
 369           // Make sure that ExistGV is the one we want to keep!
 370           if (!NewGV->isExternal())
 371             std::swap(NewGV, ExistGV);
 372
 373           // Ok we have two external global values.  Make all uses of the new
 374           // one use the old one...
 375           NewGV->uncheckedReplaceAllUsesWith(ExistGV);
 376
 377           // Now we just convert it to an unnamed method... which won't get
 378           // added to our symbol table.  The problem is that if we call
 379           // setName on the method that it will try to remove itself from
 380           // the symbol table and die... because it's not in the symtab
 381           // right now.  To fix this, we have an internally consistent flag
 382           // that turns remove into a noop.  Thus the name will get null'd
 383           // out, but the symbol table won't get upset.
 384           //
 385           assert(InternallyInconsistent == false &&
 386                  "Symbol table already inconsistent!");
 387           InternallyInconsistent = true;
 388
 389           // Remove newM from the symtab
 390           NewGV->setName("");
 391           InternallyInconsistent = false;
 392
 393           // Now we can remove this global from the module entirely...
 394           Module *M = NewGV->getParent();
 395           if (Function *F = dyn_cast<Function>(NewGV))
 396             M->getFunctionList().remove(F);
 397           else
 398             M->getGlobalList().remove(cast<GlobalVariable>(NewGV));
 399           delete NewGV;
 400         } else {
 401           // If they are not global values, they must be just random values who
 402           // happen to conflict now that types have been resolved.  If this is
 403           // the case, reinsert the value into the new plane, allowing it to get
 404           // renamed.
 405           assert(V.second->getType() == NewType &&"Type resolution is broken!");
 406           insert(V.second);
 407         }
 408       } else {
 409         insertEntry(V.first, NewType, V.second);
 410
 411       }
 412       // Remove the item from the old type plane
 413       OldPlane.erase(OldPlane.begin());
 414     }
 415
 416     // Ok, now we are not referencing the type anymore... take me off your user
 417     // list please!
 418 #if DEBUG_ABSTYPE
 419     std::cerr << "Removing type " << OldType->getDescription() << "\n";
 420 #endif
 421     OldType->removeAbstractTypeUser(this);
 422
 423     // Remove the plane that is no longer used
 424     pmap.erase(PI);
 425   }
 426
 427   // Loop over all of the types in the symbol table, replacing any references
 428   // to OldType with references to NewType.  Note that there may be multiple
 429   // occurrences, and although we only need to remove one at a time, it's
 430   // faster to remove them all in one pass.
 431   //
 432   for (type_iterator I = type_begin(), E = type_end(); I != E; ++I) {
 433     if (I->second == (Type*)OldType) {  // FIXME when Types aren't const.
 434 #if DEBUG_ABSTYPE
 435       std::cerr << "Removing type " << OldType->getDescription() << "\n";
 436 #endif
 437       OldType->removeAbstractTypeUser(this);
 438
 439       I->second = (Type*)NewType;  // TODO FIXME when types aren't const
 440       if (NewType->isAbstract()) {
 441 #if DEBUG_ABSTYPE
 442         std::cerr << "Added type " << NewType->getDescription() << "\n";
 443 #endif
 444         cast<DerivedType>(NewType)->addAbstractTypeUser(this);
 445       }
 446     }
 447   }
 448 }
 449
 450
 451 // Handle situation where type becomes Concreate from Abstract
 452 void SymbolTable::typeBecameConcrete(const DerivedType *AbsTy) {
 453   plane_iterator PI = pmap.find(AbsTy);
 454
 455   // If there are any values in the symbol table of this type, then the type
 456   // plane is a use of the abstract type which must be dropped.
 457   if (PI != pmap.end())
 458     AbsTy->removeAbstractTypeUser(this);
 459
 460   // Loop over all of the types in the symbol table, dropping any abstract
 461   // type user entries for AbsTy which occur because there are names for the
 462   // type.
 463   for (type_iterator TI = type_begin(), TE = type_end(); TI != TE; ++TI)
 464     if (TI->second == (Type*)AbsTy)   // FIXME when Types aren't const.
 465       AbsTy->removeAbstractTypeUser(this);
 466 }
 467
 468 static void DumpVal(const std::pair<const std::string, Value *> &V) {
 469   std::cerr << "  '" << V.first << "' = ";
 470   V.second->dump();
 471   std::cerr << "\n";
 472 }
 473
 474 static void DumpPlane(const std::pair<const Type *,
 475                                       std::map<const std::string, Value *> >&P){
 476   P.first->dump();
 477   std::cerr << "\n";
 478   for_each(P.second.begin(), P.second.end(), DumpVal);
 479 }
 480
 481 static void DumpTypes(const std::pair<const std::string, const Type*>& T ) {
 482   std::cerr << "  '" << T.first << "' = ";
 483   T.second->dump();
 484   std::cerr << "\n";
 485 }
 486
 487 void SymbolTable::dump() const {
 488   std::cerr << "Symbol table dump:\n  Plane:";
 489   for_each(pmap.begin(), pmap.end(), DumpPlane);
 490   std::cerr << "  Types: ";
 491   for_each(tmap.begin(), tmap.end(), DumpTypes);
 492 }
 493
 494 // vim: sw=2 ai