Fix spelling of `propagate'.
[oota-llvm.git] / lib / VMCore / Module.cpp
index 1b6e71725a5ed1cfd8af980c8d5d43cfd228357a..397b5e28341d5cae70373ff37d2c2297978392d9 100644 (file)
 //===----------------------------------------------------------------------===//
 
 #include "llvm/Module.h"
-#include "llvm/Method.h"
-#include "llvm/GlobalVariable.h"
 #include "llvm/InstrTypes.h"
-#include "llvm/ValueHolderImpl.h"
-#include "llvm/Type.h"
-#include "llvm/ConstantVals.h"
+#include "llvm/Constants.h"
+#include "llvm/DerivedTypes.h"
 #include "Support/STLExtras.h"
+#include "Support/LeakDetector.h"
+#include "SymbolTableListTraitsImpl.h"
+#include <algorithm>
 #include <map>
 
-// Instantiate Templates - This ugliness is the price we have to pay
-// for having a DefHolderImpl.h file seperate from DefHolder.h!  :(
-//
-template class ValueHolder<GlobalVariable, Module, Module>;
-template class ValueHolder<Method, Module, Module>;
+Function *ilist_traits<Function>::createNode() {
+  FunctionType *FTy =
+    FunctionType::get(Type::VoidTy, std::vector<const Type*>(), false);
+  Function *Ret = new Function(FTy, false);
+  // This should not be garbage monitored.
+  LeakDetector::removeGarbageObject(Ret);
+  return Ret;
+}
+GlobalVariable *ilist_traits<GlobalVariable>::createNode() {
+  GlobalVariable *Ret = new GlobalVariable(Type::IntTy, false, false);
+  // This should not be garbage monitored.
+  LeakDetector::removeGarbageObject(Ret);
+  return Ret;
+}
+
+iplist<Function> &ilist_traits<Function>::getList(Module *M) {
+  return M->getFunctionList();
+}
+iplist<GlobalVariable> &ilist_traits<GlobalVariable>::getList(Module *M) {
+  return M->getGlobalList();
+}
+
+// Explicit instantiations of SymbolTableListTraits since some of the methods
+// are not in the public header file...
+template SymbolTableListTraits<GlobalVariable, Module, Module>;
+template SymbolTableListTraits<Function, Module, Module>;
 
 // Define the GlobalValueRefMap as a struct that wraps a map so that we don't
 // have Module.h depend on <map>
 //
-struct GlobalValueRefMap : public std::map<GlobalValue*, ConstantPointerRef*>{
+struct GlobalValueRefMap {
+  typedef std::map<GlobalValue*, ConstantPointerRef*> MapTy;
+  typedef MapTy::iterator iterator;
+  std::map<GlobalValue*, ConstantPointerRef*> Map;
 };
 
 
-Module::Module()
-  : Value(Type::VoidTy, Value::ModuleVal, ""), SymTabValue(this),
-    GlobalList(this, this), MethodList(this, this), GVRefMap(0) {
+Module::Module() {
+  FunctionList.setItemParent(this);
+  FunctionList.setParent(this);
+  GlobalList.setItemParent(this);
+  GlobalList.setParent(this);
+  GVRefMap = 0;
+  SymTab = 0;
 }
 
 Module::~Module() {
   dropAllReferences();
-  GlobalList.delete_all();
+  GlobalList.clear();
   GlobalList.setParent(0);
-  MethodList.delete_all();
-  MethodList.setParent(0);
+  FunctionList.clear();
+  FunctionList.setParent(0);
+  delete SymTab;
 }
 
+// Module::dump() - Allow printing from debugger
+void Module::dump() const {
+  print(std::cerr);
+}
+
+SymbolTable *Module::getSymbolTableSure() {
+  if (!SymTab) SymTab = new SymbolTable();
+  return SymTab;
+}
 
-// dropAllReferences() - This function causes all the subinstructions to "let
-// go" of all references that they are maintaining.  This allows one to
-// 'delete' a whole class at a time, even though there may be circular
-// references... first all references are dropped, and all use counts go to
-// zero.  Then everything is delete'd for real.  Note that no operations are
-// valid on an object that has "dropped all references", except operator 
-// delete.
+// hasSymbolTable() - Returns true if there is a symbol table allocated to
+// this object AND if there is at least one name in it!
 //
-void Module::dropAllReferences() {
-  for_each(MethodList.begin(), MethodList.end(),
-          std::mem_fun(&Method::dropAllReferences));
+bool Module::hasSymbolTable() const {
+  if (!SymTab) return false;
+
+  for (SymbolTable::const_iterator I = SymTab->begin(), E = SymTab->end();
+       I != E; ++I)
+    if (I->second.begin() != I->second.end())
+      return true;                                // Found nonempty type plane!
+  
+  return false;
+}
 
-  for_each(GlobalList.begin(), GlobalList.end(),
-          std::mem_fun(&GlobalVariable::dropAllReferences));
 
-  // If there are any GlobalVariable references still out there, nuke them now.
-  // Since all references are hereby dropped, nothing could possibly reference
-  // them still.
-  if (GVRefMap) {
-    for (GlobalValueRefMap::iterator I = GVRefMap->begin(), E = GVRefMap->end();
-        I != E; ++I) {
-      // Delete the ConstantPointerRef node...
-      I->second->destroyConstant();
-    }
-
-    // Since the table is empty, we can now delete it...
-    delete GVRefMap;
+// getOrInsertFunction - Look up the specified function in the module symbol
+// table.  If it does not exist, add a prototype for the function and return
+// it.  This is nice because it allows most passes to get away with not handling
+// the symbol table directly for this common task.
+//
+Function *Module::getOrInsertFunction(const std::string &Name,
+                                      const FunctionType *Ty) {
+  SymbolTable *SymTab = getSymbolTableSure();
+
+  // See if we have a definitions for the specified function already...
+  if (Value *V = SymTab->lookup(PointerType::get(Ty), Name)) {
+    return cast<Function>(V);      // Yup, got it
+  } else {                         // Nope, add one
+    Function *New = new Function(Ty, false, Name);
+    FunctionList.push_back(New);
+    return New;                    // Return the new prototype...
   }
 }
 
-// reduceApply - Apply the specified function to all of the methods in this 
-// module.  The result values are or'd together and the result is returned.
+// getFunction - Look up the specified function in the module symbol table.
+// If it does not exist, return null.
 //
-bool Module::reduceApply(bool (*Func)(GlobalVariable*)) {
-  return reduce_apply_bool(gbegin(), gend(), Func);
+Function *Module::getFunction(const std::string &Name, const FunctionType *Ty) {
+  SymbolTable *SymTab = getSymbolTable();
+  if (SymTab == 0) return 0;  // No symtab, no symbols...
+
+  return cast_or_null<Function>(SymTab->lookup(PointerType::get(Ty), Name));
 }
-bool Module::reduceApply(bool (*Func)(const GlobalVariable*)) const {
-  return reduce_apply_bool(gbegin(), gend(), Func);
+
+// addTypeName - Insert an entry in the symbol table mapping Str to Type.  If
+// there is already an entry for this name, true is returned and the symbol
+// table is not modified.
+//
+bool Module::addTypeName(const std::string &Name, const Type *Ty) {
+  SymbolTable *ST = getSymbolTableSure();
+
+  if (ST->lookup(Type::TypeTy, Name)) return true;  // Already in symtab...
+  
+  // Not in symbol table?  Set the name with the Symtab as an argument so the
+  // type knows what to update...
+  ((Value*)Ty)->setName(Name, ST);
+
+  return false;
 }
-bool Module::reduceApply(bool (*Func)(Method*)) {
-  return reduce_apply_bool(begin(), end(), Func);
+
+// getTypeName - If there is at least one entry in the symbol table for the
+// specified type, return it.
+//
+std::string Module::getTypeName(const Type *Ty) {
+  const SymbolTable *ST = getSymbolTable();
+  if (ST == 0) return "";  // No symbol table, must not have an entry...
+  if (ST->find(Type::TypeTy) == ST->end())
+    return ""; // No names for types...
+
+  SymbolTable::type_const_iterator TI = ST->type_begin(Type::TypeTy);
+  SymbolTable::type_const_iterator TE = ST->type_end(Type::TypeTy);
+
+  while (TI != TE && TI->second != (const Value*)Ty)
+    ++TI;
+
+  if (TI != TE)  // Must have found an entry!
+    return TI->first;
+  return "";     // Must not have found anything...
 }
-bool Module::reduceApply(bool (*Func)(const Method*)) const {
-  return reduce_apply_bool(begin(), end(), Func);
+
+
+// dropAllReferences() - This function causes all the subelementss to "let go"
+// of all references that they are maintaining.  This allows one to 'delete' a
+// whole module at a time, even though there may be circular references... first
+// all references are dropped, and all use counts go to zero.  Then everything
+// is delete'd for real.  Note that no operations are valid on an object that
+// has "dropped all references", except operator delete.
+//
+void Module::dropAllReferences() {
+  for(Module::iterator I = begin(), E = end(); I != E; ++I)
+    I->dropAllReferences();
+
+  for(Module::giterator I = gbegin(), E = gend(); I != E; ++I)
+    I->dropAllReferences();
+
+  // If there are any GlobalVariable references still out there, nuke them now.
+  // Since all references are hereby dropped, nothing could possibly reference
+  // them still.  Note that destroying all of the constant pointer refs will
+  // eventually cause the GVRefMap field to be set to null (by
+  // destroyConstantPointerRef, below).
+  //
+  while (GVRefMap)
+    // Delete the ConstantPointerRef node...  
+    GVRefMap->Map.begin()->second->destroyConstant();
 }
 
 // Accessor for the underlying GlobalValRefMap...
@@ -92,24 +190,34 @@ ConstantPointerRef *Module::getConstantPointerRef(GlobalValue *V){
   // Create ref map lazily on demand...
   if (GVRefMap == 0) GVRefMap = new GlobalValueRefMap();
 
-  GlobalValueRefMap::iterator I = GVRefMap->find(V);
-  if (I != GVRefMap->end()) return I->second;
+  GlobalValueRefMap::iterator I = GVRefMap->Map.find(V);
+  if (I != GVRefMap->Map.end()) return I->second;
 
   ConstantPointerRef *Ref = new ConstantPointerRef(V);
-  GVRefMap->insert(std::make_pair(V, Ref));
-
+  GVRefMap->Map[V] = Ref;
   return Ref;
 }
 
+void Module::destroyConstantPointerRef(ConstantPointerRef *CPR) {
+  assert(GVRefMap && "No map allocated, but we have a CPR?");
+  if (!GVRefMap->Map.erase(CPR->getValue()))  // Remove it from the map...
+    assert(0 && "ConstantPointerRef not found in module CPR map!");
+  
+  if (GVRefMap->Map.empty()) {   // If the map is empty, delete it.
+    delete GVRefMap;
+    GVRefMap = 0;
+  }
+}
+
 void Module::mutateConstantPointerRef(GlobalValue *OldGV, GlobalValue *NewGV) {
-  GlobalValueRefMap::iterator I = GVRefMap->find(OldGV);
-  assert(I != GVRefMap->end() && 
+  GlobalValueRefMap::iterator I = GVRefMap->Map.find(OldGV);
+  assert(I != GVRefMap->Map.end() && 
         "mutateConstantPointerRef; OldGV not in table!");
   ConstantPointerRef *Ref = I->second;
 
   // Remove the old entry...
-  GVRefMap->erase(I);
+  GVRefMap->Map.erase(I);
 
   // Insert the new entry...
-  GVRefMap->insert(std::make_pair(NewGV, Ref));
+  GVRefMap->Map.insert(std::make_pair(NewGV, Ref));
 }