Add some missing node names
[oota-llvm.git] / lib / VMCore / Module.cpp
index e0a6fb271ceabbe5d95959cc7d7b8c1ab49cb5a0..7c400aa515d032fe370de57308ba2258cd43e61b 100644 (file)
@@ -1,4 +1,11 @@
-//===-- Module.cpp - Implement the Module class ------------------*- C++ -*--=//
+//===-- Module.cpp - Implement the Module class ---------------------------===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
 //
 // This file implements the Module class for the VMCore library.
 //
 #include "llvm/InstrTypes.h"
 #include "llvm/Constants.h"
 #include "llvm/DerivedTypes.h"
-#include "Support/STLExtras.h"
-#include "Support/LeakDetector.h"
+#include "llvm/ADT/STLExtras.h"
+#include "llvm/Support/LeakDetector.h"
 #include "SymbolTableListTraitsImpl.h"
 #include <algorithm>
+#include <cstdarg>
+#include <iostream>
 #include <map>
+using namespace llvm;
+
+//===----------------------------------------------------------------------===//
+// Methods to implement the globals and functions lists.
+//
 
-Function *ilist_traits<Function>::createNode() {
+Function *ilist_traits<Function>::createSentinel() {
   FunctionType *FTy =
     FunctionType::get(Type::VoidTy, std::vector<const Type*>(), false);
   Function *Ret = new Function(FTy, GlobalValue::ExternalLinkage);
@@ -22,7 +36,7 @@ Function *ilist_traits<Function>::createNode() {
   LeakDetector::removeGarbageObject(Ret);
   return Ret;
 }
-GlobalVariable *ilist_traits<GlobalVariable>::createNode() {
+GlobalVariable *ilist_traits<GlobalVariable>::createSentinel() {
   GlobalVariable *Ret = new GlobalVariable(Type::IntTy, false,
                                            GlobalValue::ExternalLinkage);
   // This should not be garbage monitored.
@@ -38,26 +52,20 @@ iplist<GlobalVariable> &ilist_traits<GlobalVariable>::getList(Module *M) {
 }
 
 // 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>;
+// are not in the public header file.
+template class SymbolTableListTraits<GlobalVariable, Module, Module>;
+template class 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>
+//===----------------------------------------------------------------------===//
+// Primitive Module methods.
 //
-struct GlobalValueRefMap {
-  typedef std::map<GlobalValue*, ConstantPointerRef*> MapTy;
-  typedef MapTy::iterator iterator;
-  std::map<GlobalValue*, ConstantPointerRef*> Map;
-};
 
-
-Module::Module() {
+Module::Module(const std::string &MID)
+  : ModuleID(MID), Endian(AnyEndianness), PtrSize(AnyPointerSize) {
   FunctionList.setItemParent(this);
   FunctionList.setParent(this);
   GlobalList.setItemParent(this);
   GlobalList.setParent(this);
-  GVRefMap = 0;
   SymTab = new SymbolTable();
 }
 
@@ -67,6 +75,7 @@ Module::~Module() {
   GlobalList.setParent(0);
   FunctionList.clear();
   FunctionList.setParent(0);
+  LibraryList.clear();
   delete SymTab;
 }
 
@@ -75,6 +84,10 @@ void Module::dump() const {
   print(std::cerr);
 }
 
+//===----------------------------------------------------------------------===//
+// Methods for easy access to the functions in the module.
+//
+
 // 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
@@ -94,6 +107,28 @@ Function *Module::getOrInsertFunction(const std::string &Name,
   }
 }
 
+// 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 version of the method takes a null terminated list of function
+// arguments, which makes it easier for clients to use.
+//
+Function *Module::getOrInsertFunction(const std::string &Name,
+                                      const Type *RetTy, ...) {
+  va_list Args;
+  va_start(Args, RetTy);
+
+  // Build the list of argument types...
+  std::vector<const Type*> ArgTys;
+  while (const Type *ArgTy = va_arg(Args, const Type*))
+    ArgTys.push_back(ArgTy);
+
+  va_end(Args);
+
+  // Build the function type and chain to the other getOrInsertFunction...
+  return getOrInsertFunction(Name, FunctionType::get(RetTy, ArgTys, false));
+}
+
+
 // getFunction - Look up the specified function in the module symbol table.
 // If it does not exist, return null.
 //
@@ -102,21 +137,6 @@ Function *Module::getFunction(const std::string &Name, const FunctionType *Ty) {
   return cast_or_null<Function>(SymTab.lookup(PointerType::get(Ty), Name));
 }
 
-// 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 = getSymbolTable();
-
-  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;
-}
 
 /// getMainFunction - This function looks up main efficiently.  This is such a
 /// common case, that it is a method in Module.  If main cannot be found, a
@@ -154,7 +174,7 @@ Function *Module::getMainFunction() {
     if (Function *F = getFunction("main", FunctionType::get(Type::IntTy,
                                                             Params, false)))
       return F;
-    
+
     // void main(int argc, char **argv)...
     if (Function *F = getFunction("main", FunctionType::get(Type::VoidTy,
                                                             Params, false)))
@@ -171,26 +191,92 @@ Function *Module::getMainFunction() {
 ///
 Function *Module::getNamedFunction(const std::string &Name) {
   // Loop over all of the functions, looking for the function desired
+  Function *Found = 0;
   for (iterator I = begin(), E = end(); I != E; ++I)
     if (I->getName() == Name)
+      if (I->isExternal())
+        Found = I;
+      else
+        return I;
+  return Found; // Non-external function not found...
+}
+
+//===----------------------------------------------------------------------===//
+// Methods for easy access to the global variables in the module.
+//
+
+/// getGlobalVariable - Look up the specified global variable in the module
+/// symbol table.  If it does not exist, return null.  The type argument
+/// should be the underlying type of the global, i.e., it should not have
+/// the top-level PointerType, which represents the address of the global.
+/// If AllowInternal is set to true, this function will return types that
+/// have InternalLinkage. By default, these types are not returned.
+///
+GlobalVariable *Module::getGlobalVariable(const std::string &Name,
+                                          const Type *Ty, bool AllowInternal) {
+  if (Value *V = getSymbolTable().lookup(PointerType::get(Ty), Name)) {
+    GlobalVariable *Result = cast<GlobalVariable>(V);
+    if (AllowInternal || !Result->hasInternalLinkage())
+      return Result;
+  }
+  return 0;
+}
+
+/// getNamedGlobal - Return the first global variable in the module with the
+/// specified name, of arbitrary type.  This method returns null if a global
+/// with the specified name is not found.
+///
+GlobalVariable *Module::getNamedGlobal(const std::string &Name) {
+  // FIXME: This would be much faster with a symbol table that doesn't
+  // discriminate based on type!
+  for (global_iterator I = global_begin(), E = global_end();
+       I != E; ++I)
+    if (I->getName() == Name) 
       return I;
-  return 0; // function not found...
+  return 0;
 }
 
 
 
+//===----------------------------------------------------------------------===//
+// Methods for easy access to the types in the module.
+//
+
+
+// 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 = getSymbolTable();
+
+  if (ST.lookupType(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...
+  ST.insert(Name, Ty);
+
+  return false;
+}
+
+/// getTypeByName - Return the type with the specified name in this module, or
+/// null if there is none by that name.
+const Type *Module::getTypeByName(const std::string &Name) const {
+  const SymbolTable &ST = getSymbolTable();
+  return cast_or_null<Type>(ST.lookupType(Name));
+}
+
 // 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) {
+std::string Module::getTypeName(const Type *Ty) const {
   const SymbolTable &ST = getSymbolTable();
-  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);
+  SymbolTable::type_const_iterator TI = ST.type_begin();
+  SymbolTable::type_const_iterator TE = ST.type_end();
+  if ( TI == TE ) return ""; // No names for types
 
-  while (TI != TE && TI->second != (const Value*)Ty)
+  while (TI != TE && TI->second != Ty)
     ++TI;
 
   if (TI != TE)  // Must have found an entry!
@@ -198,65 +284,23 @@ std::string Module::getTypeName(const Type *Ty) {
   return "";     // Must not have found anything...
 }
 
+//===----------------------------------------------------------------------===//
+// Other module related stuff.
+//
+
 
 // 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
+// is deleted 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)
+  for(Module::global_iterator I = global_begin(), E = global_end(); 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...
-ConstantPointerRef *Module::getConstantPointerRef(GlobalValue *V){
-  // Create ref map lazily on demand...
-  if (GVRefMap == 0) GVRefMap = new GlobalValueRefMap();
-
-  GlobalValueRefMap::iterator I = GVRefMap->Map.find(V);
-  if (I != GVRefMap->Map.end()) return I->second;
-
-  ConstantPointerRef *Ref = new ConstantPointerRef(V);
-  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->Map.find(OldGV);
-  assert(I != GVRefMap->Map.end() && 
-        "mutateConstantPointerRef; OldGV not in table!");
-  ConstantPointerRef *Ref = I->second;
-
-  // Remove the old entry...
-  GVRefMap->Map.erase(I);
-
-  // Insert the new entry...
-  GVRefMap->Map.insert(std::make_pair(NewGV, Ref));
-}