lib/VMCore/ValueSymbolTable.cpp

   1 //===-- ValueSymbolTable.cpp - Implement the ValueSymbolTable class -------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group.  It is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the ValueSymbolTable class for the VMCore library.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #define DEBUG_TYPE "valuesymtab"
  15 #include "llvm/GlobalValue.h"
  16 #include "llvm/Type.h"
  17 #include "llvm/ValueSymbolTable.h"
  18 #include "llvm/ADT/StringExtras.h"
  19 #include "llvm/Support/Debug.h"
  20 #include <algorithm>
  21 using namespace llvm;
  22
  23 // Class destructor
  24 ValueSymbolTable::~ValueSymbolTable() {
  25 #ifndef NDEBUG   // Only do this in -g mode...
  26   bool LeftoverValues = true;
  27   for (iterator VI = vmap.begin(), VE = vmap.end(); VI != VE; ++VI)
  28     if (!isa<Constant>(VI->second) ) {
  29       DEBUG(DOUT << "Value still in symbol table! Type = '"
  30            << VI->second->getType()->getDescription() << "' Name = '"
  31            << VI->first << "'\n");
  32       LeftoverValues = false;
  33     }
  34   assert(LeftoverValues && "Values remain in symbol table!");
  35 #endif
  36 }
  37
  38 // getUniqueName - Given a base name, return a string that is either equal to
  39 // it (or derived from it) that does not already occur in the symbol table for
  40 // the specified type.
  41 //
  42 std::string ValueSymbolTable::getUniqueName(const std::string &BaseName) const {
  43   std::string TryName = BaseName;
  44   const_iterator End = vmap.end();
  45
  46   // See if the name exists
  47   while (vmap.find(TryName) != End)            // Loop until we find a free
  48     TryName = BaseName + utostr(++LastUnique); // name in the symbol table
  49   return TryName;
  50 }
  51
  52
  53 // lookup a value - Returns null on failure...
  54 //
  55 Value *ValueSymbolTable::lookup(const std::string &Name) const {
  56   const_iterator VI = vmap.find(Name);
  57   if (VI != vmap.end())                   // We found the symbol
  58     return const_cast<Value*>(VI->second);
  59   return 0;
  60 }
  61
  62 // Strip the symbol table of its names.
  63 //
  64 bool ValueSymbolTable::strip() {
  65   bool RemovedSymbol = false;
  66   for (iterator VI = vmap.begin(), VE = vmap.end(); VI != VE; ) {
  67     Value *V = VI->second;
  68     ++VI;
  69     if (!isa<GlobalValue>(V) || cast<GlobalValue>(V)->hasInternalLinkage()) {
  70       // Set name to "", removing from symbol table!
  71       V->setName("");
  72       RemovedSymbol = true;
  73     }
  74   }
  75   return RemovedSymbol;
  76 }
  77
  78 // Insert a value into the symbol table with the specified name...
  79 //
  80 void ValueSymbolTable::insert(Value* V) {
  81   assert(V && "Can't insert null Value into symbol table!");
  82   assert(V->hasName() && "Can't insert nameless Value into symbol table");
  83
  84   // Try inserting the name, assuming it won't conflict.
  85   if (vmap.insert(make_pair(V->Name, V)).second) {
  86     DOUT << " Inserted value: " << V->Name << ": " << *V << "\n";
  87     return;
  88   }
  89
  90   // Otherwise, there is a naming conflict.  Rename this value.
  91   std::string UniqueName = V->getName();
  92   unsigned BaseSize = UniqueName.size();
  93   do {
  94     // Trim any suffix off.
  95     UniqueName.resize(BaseSize);
  96     UniqueName += utostr(++LastUnique);
  97   } while (!vmap.insert(make_pair(UniqueName, V)).second);
  98
  99   DEBUG(DOUT << " Inserting value: " << UniqueName << ": " << *V << "\n");
 100
 101   // Insert the vmap entry
 102   V->Name = UniqueName;
 103 }
 104
 105 // Remove a value
 106 bool ValueSymbolTable::remove(Value *V) {
 107   assert(V->hasName() && "Value doesn't have name!");
 108   iterator Entry = vmap.find(V->getName());
 109   if (Entry == vmap.end())
 110     return false;
 111
 112   DEBUG(DOUT << " Removing Value: " << Entry->second->getName() << "\n");
 113
 114   // Remove the value from the plane...
 115   vmap.erase(Entry);
 116   return true;
 117 }
 118
 119
 120 // rename - Given a value with a non-empty name, remove its existing entry
 121 // from the symbol table and insert a new one for Name.  This is equivalent to
 122 // doing "remove(V), V->Name = Name, insert(V)",
 123 //
 124 bool ValueSymbolTable::rename(Value *V, const std::string &name) {
 125   assert(V && "Can't rename a null Value");
 126   assert(V->hasName() && "Can't rename a nameless Value");
 127   assert(!V->getName().empty() && "Can't rename an Value with null name");
 128   assert(V->getName() != name && "Can't rename a Value with same name");
 129   assert(!name.empty() && "Can't rename a named Value with a null name");
 130
 131   // Find the name
 132   iterator VI = vmap.find(V->getName());
 133
 134   // If we didn't find it, we're done
 135   if (VI == vmap.end())
 136     return false;
 137
 138   // Remove the old entry.
 139   vmap.erase(VI);
 140
 141   // See if we can insert the new name.
 142   VI = vmap.lower_bound(name);
 143
 144   // Is there a naming conflict?
 145   if (VI != vmap.end() && VI->first == name) {
 146     V->Name = getUniqueName( name);
 147     vmap.insert(make_pair(V->Name, V));
 148   } else {
 149     V->Name = name;
 150     vmap.insert(VI, make_pair(V->Name, V));
 151   }
 152
 153   return true;
 154 }
 155
 156 // DumpVal - a std::for_each function for dumping a value
 157 //
 158 static void DumpVal(const std::pair<const std::string, Value *> &V) {
 159   DOUT << "  '" << V.first << "' = ";
 160   V.second->dump();
 161   DOUT << "\n";
 162 }
 163
 164 // dump - print out the symbol table
 165 //
 166 void ValueSymbolTable::dump() const {
 167   DOUT << "ValueSymbolTable:\n";
 168   for_each(vmap.begin(), vmap.end(), DumpVal);
 169 }