For PR411:
[oota-llvm.git] / lib / VMCore / Module.cpp
index fbe85867146b38d4d407d778154cdab6479d99f6..163d8d2ac173797909502b7616020a9b8efd39db 100644 (file)
-//===-- 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/Module.h"
-#include "llvm/Method.h"
-#include "llvm/GlobalVariable.h"
-#include "llvm/BasicBlock.h"
 #include "llvm/InstrTypes.h"
-#include "llvm/ValueHolderImpl.h"
-#include "llvm/Support/STLExtras.h"
-#include "llvm/Type.h"
+#include "llvm/Constants.h"
+#include "llvm/DerivedTypes.h"
+#include "llvm/ADT/STLExtras.h"
+#include "llvm/ADT/StringExtras.h"
+#include "llvm/Support/LeakDetector.h"
+#include "SymbolTableListTraitsImpl.h"
+#include "llvm/TypeSymbolTable.h"
+#include <algorithm>
+#include <cstdarg>
+#include <cstdlib>
 #include <map>
+using namespace llvm;
 
-// Instantiate Templates - This ugliness is the price we have to pay
-// for having a DefHolderImpl.h file seperate from DefHolder.h!  :(
+//===----------------------------------------------------------------------===//
+// Methods to implement the globals and functions lists.
 //
-template class ValueHolder<GlobalVariable, Module, Module>;
-template class ValueHolder<Method, 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 map<GlobalValue*, ConstPoolPointerReference*>{
-};
+Function *ilist_traits<Function>::createSentinel() {
+  FunctionType *FTy =
+    FunctionType::get(Type::VoidTy, std::vector<const Type*>(), false, 
+                      std::vector<FunctionType::ParameterAttributes>() );
+  Function *Ret = new Function(FTy, GlobalValue::ExternalLinkage);
+  // This should not be garbage monitored.
+  LeakDetector::removeGarbageObject(Ret);
+  return Ret;
+}
+GlobalVariable *ilist_traits<GlobalVariable>::createSentinel() {
+  GlobalVariable *Ret = new GlobalVariable(Type::Int32Ty, false,
+                                           GlobalValue::ExternalLinkage);
+  // 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 class SymbolTableListTraits<GlobalVariable, Module, Module>;
+template class SymbolTableListTraits<Function, Module, Module>;
+
+//===----------------------------------------------------------------------===//
+// Primitive Module methods.
+//
 
-Module::Module()
-  : Value(Type::VoidTy, Value::ModuleVal, ""), SymTabValue(this),
-    GlobalList(this, this), MethodList(this, this), GVRefMap(0) {
+Module::Module(const std::string &MID)
+  : ModuleID(MID), DataLayout("") {
+  FunctionList.setItemParent(this);
+  FunctionList.setParent(this);
+  GlobalList.setItemParent(this);
+  GlobalList.setParent(this);
+  ValSymTab = new ValueSymbolTable();
+  TypeSymTab = new TypeSymbolTable();
 }
 
 Module::~Module() {
   dropAllReferences();
-  GlobalList.delete_all();
+  GlobalList.clear();
   GlobalList.setParent(0);
-  MethodList.delete_all();
-  MethodList.setParent(0);
+  FunctionList.clear();
+  FunctionList.setParent(0);
+  LibraryList.clear();
+  delete ValSymTab;
+  delete TypeSymTab;
 }
 
+// Module::dump() - Allow printing from debugger
+void Module::dump() const {
+  print(*cerr.stream());
+}
 
-// 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.
-//
-void Module::dropAllReferences() {
-  for_each(MethodList.begin(), MethodList.end(),
-          std::mem_fun(&Method::dropAllReferences));
-
-  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 ConstPoolPointerReference node...
-      I->second->destroyConstant();
+/// Target endian information...
+Module::Endianness Module::getEndianness() const {
+  std::string temp = DataLayout;
+  Module::Endianness ret = AnyEndianness;
+  
+  while (!temp.empty()) {
+    std::string token = getToken(temp, "-");
+    
+    if (token[0] == 'e') {
+      ret = LittleEndian;
+    } else if (token[0] == 'E') {
+      ret = BigEndian;
     }
+  }
+  
+  return ret;
+}
 
-    // Since the table is empty, we can now delete it...
-    delete GVRefMap;
+/// Target Pointer Size information...
+Module::PointerSize Module::getPointerSize() const {
+  std::string temp = DataLayout;
+  Module::PointerSize ret = AnyPointerSize;
+  
+  while (!temp.empty()) {
+    std::string token = getToken(temp, "-");
+    char signal = getToken(token, ":")[0];
+    
+    if (signal == 'p') {
+      int size = atoi(getToken(token, ":").c_str());
+      if (size == 32)
+        ret = Pointer32;
+      else if (size == 64)
+        ret = Pointer64;
+    }
   }
+  
+  return ret;
 }
 
-// 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.
+//===----------------------------------------------------------------------===//
+// 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
+// the symbol table directly for this common task.
 //
-bool Module::reduceApply(bool (*Func)(GlobalVariable*)) {
-  return reduce_apply_bool(gbegin(), gend(), Func);
+Constant *Module::getOrInsertFunction(const std::string &Name,
+                                      const FunctionType *Ty) {
+  ValueSymbolTable &SymTab = getValueSymbolTable();
+
+  // See if we have a definition for the specified function already.
+  Function *F = dyn_cast_or_null<Function>(SymTab.lookup(Name));
+  if (F == 0) {
+    // Nope, add it
+    Function *New = new Function(Ty, GlobalVariable::ExternalLinkage, Name);
+    FunctionList.push_back(New);
+    return New;                    // Return the new prototype.
+  }
+
+  // Okay, the function exists.  Does it have externally visible linkage?
+  if (F->hasInternalLinkage()) {
+    // Rename the function.
+    F->setName(SymTab.getUniqueName(F->getName()));
+    // Retry, now there won't be a conflict.
+    return getOrInsertFunction(Name, Ty);
+  }
+
+  // If the function exists but has the wrong type, return a bitcast to the
+  // right type.
+  if (F->getFunctionType() != Ty)
+    return ConstantExpr::getBitCast(F, PointerType::get(Ty));
+  
+  // Otherwise, we just found the existing function or a prototype.
+  return F;  
 }
-bool Module::reduceApply(bool (*Func)(const GlobalVariable*)) const {
-  return reduce_apply_bool(gbegin(), gend(), Func);
+
+// 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.
+//
+Constant *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));
 }
-bool Module::reduceApply(bool (*Func)(Method*)) {
-  return reduce_apply_bool(begin(), end(), Func);
+
+
+// getFunction - Look up the specified function in the module symbol table.
+// If it does not exist, return null.
+//
+Function *Module::getFunction(const std::string &Name) const {
+  const ValueSymbolTable &SymTab = getValueSymbolTable();
+  return dyn_cast_or_null<Function>(SymTab.lookup(Name));
+}
+
+//===----------------------------------------------------------------------===//
+// 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,
+                                          bool AllowInternal) const {
+  if (Value *V = ValSymTab->lookup(Name)) {
+    GlobalVariable *Result = dyn_cast<GlobalVariable>(V);
+    if (Result && (AllowInternal || !Result->hasInternalLinkage()))
+      return Result;
+  }
+  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) {
+  TypeSymbolTable &ST = getTypeSymbolTable();
+
+  if (ST.lookup(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;
 }
-bool Module::reduceApply(bool (*Func)(const Method*)) const {
-  return reduce_apply_bool(begin(), end(), Func);
+
+/// 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 TypeSymbolTable &ST = getTypeSymbolTable();
+  return cast_or_null<Type>(ST.lookup(Name));
 }
 
-// Accessor for the underlying GlobalValRefMap...
-ConstPoolPointerReference *Module::getConstPoolPointerReference(GlobalValue *V){
-  // Create ref map lazily on demand...
-  if (GVRefMap == 0) GVRefMap = new GlobalValueRefMap();
+// 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 {
+  const TypeSymbolTable &ST = getTypeSymbolTable();
 
-  GlobalValueRefMap::iterator I = GVRefMap->find(V);
-  if (I != GVRefMap->end()) return I->second;
+  TypeSymbolTable::const_iterator TI = ST.begin();
+  TypeSymbolTable::const_iterator TE = ST.end();
+  if ( TI == TE ) return ""; // No names for types
 
-  ConstPoolPointerReference *Ref = new ConstPoolPointerReference(V);
-  GVRefMap->insert(make_pair(V, Ref));
+  while (TI != TE && TI->second != Ty)
+    ++TI;
 
-  return Ref;
+  if (TI != TE)  // Must have found an entry!
+    return TI->first;
+  return "";     // Must not have found anything...
 }
 
-void Module::mutateConstPoolPointerReference(GlobalValue *OldGV, 
-                                            GlobalValue *NewGV) {
-  GlobalValueRefMap::iterator I = GVRefMap->find(OldGV);
-  assert(I != GVRefMap->end() && 
-        "mutateConstPoolPointerReference; OldGV not in table!");
-  ConstPoolPointerReference *Ref = I->second;
+//===----------------------------------------------------------------------===//
+// Other module related stuff.
+//
+
 
-  // Remove the old entry...
-  GVRefMap->erase(I);
+// 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 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::global_iterator I = global_begin(), E = global_end(); I != E; ++I)
+    I->dropAllReferences();
+}
 
-  // Insert the new entry...
-  GVRefMap->insert(make_pair(NewGV, Ref));
+void Module::addLibrary(const std::string& Lib) {
+  for (Module::lib_iterator I = lib_begin(), E = lib_end(); I != E; ++I)
+    if (*I == Lib)
+      return;
+  LibraryList.push_back(Lib);
 }
+
+void Module::removeLibrary(const std::string& Lib) {
+  LibraryListType::iterator I = LibraryList.begin();
+  LibraryListType::iterator E = LibraryList.end();
+  for (;I != E; ++I)
+    if (*I == Lib) {
+      LibraryList.erase(I);
+      return;
+    }
+}
+