lib/VMCore/Module.cpp

   1 //===-- Module.cpp - Implement the Module class ---------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the Module class for the VMCore library.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/Module.h"
  15 #include "llvm/InstrTypes.h"
  16 #include "llvm/Constants.h"
  17 #include "llvm/DerivedTypes.h"
  18 #include "Support/STLExtras.h"
  19 #include "Support/LeakDetector.h"
  20 #include "SymbolTableListTraitsImpl.h"
  21 #include <algorithm>
  22 #include <cstdarg>
  23 #include <iostream>
  24 #include <map>
  25 using namespace llvm;
  26
  27 //===----------------------------------------------------------------------===//
  28 // Methods to implement the globals and functions lists.
  29 //
  30
  31 Function *ilist_traits<Function>::createNode() {
  32   FunctionType *FTy =
  33     FunctionType::get(Type::VoidTy, std::vector<const Type*>(), false);
  34   Function *Ret = new Function(FTy, GlobalValue::ExternalLinkage);
  35   // This should not be garbage monitored.
  36   LeakDetector::removeGarbageObject(Ret);
  37   return Ret;
  38 }
  39 GlobalVariable *ilist_traits<GlobalVariable>::createNode() {
  40   GlobalVariable *Ret = new GlobalVariable(Type::IntTy, false,
  41                                            GlobalValue::ExternalLinkage);
  42   // This should not be garbage monitored.
  43   LeakDetector::removeGarbageObject(Ret);
  44   return Ret;
  45 }
  46
  47 iplist<Function> &ilist_traits<Function>::getList(Module *M) {
  48   return M->getFunctionList();
  49 }
  50 iplist<GlobalVariable> &ilist_traits<GlobalVariable>::getList(Module *M) {
  51   return M->getGlobalList();
  52 }
  53
  54 // Explicit instantiations of SymbolTableListTraits since some of the methods
  55 // are not in the public header file...
  56 template class SymbolTableListTraits<GlobalVariable, Module, Module>;
  57 template class SymbolTableListTraits<Function, Module, Module>;
  58
  59 //===----------------------------------------------------------------------===//
  60 // Primitive Module methods.
  61 //
  62
  63 Module::Module(const std::string &MID)
  64   : ModuleID(MID), Endian(AnyEndianness), PtrSize(AnyPointerSize) {
  65   FunctionList.setItemParent(this);
  66   FunctionList.setParent(this);
  67   GlobalList.setItemParent(this);
  68   GlobalList.setParent(this);
  69   SymTab = new SymbolTable();
  70 }
  71
  72 Module::~Module() {
  73   dropAllReferences();
  74   GlobalList.clear();
  75   GlobalList.setParent(0);
  76   FunctionList.clear();
  77   FunctionList.setParent(0);
  78   delete SymTab;
  79 }
  80
  81 // Module::dump() - Allow printing from debugger
  82 void Module::dump() const {
  83   print(std::cerr);
  84 }
  85
  86 //===----------------------------------------------------------------------===//
  87 // Methods for easy access to the functions in the module.
  88 //
  89
  90 // getOrInsertFunction - Look up the specified function in the module symbol
  91 // table.  If it does not exist, add a prototype for the function and return
  92 // it.  This is nice because it allows most passes to get away with not handling
  93 // the symbol table directly for this common task.
  94 //
  95 Function *Module::getOrInsertFunction(const std::string &Name,
  96                                       const FunctionType *Ty) {
  97   SymbolTable &SymTab = getSymbolTable();
  98
  99   // See if we have a definitions for the specified function already...
 100   if (Value *V = SymTab.lookup(PointerType::get(Ty), Name)) {
 101     return cast<Function>(V);      // Yup, got it
 102   } else {                         // Nope, add one
 103     Function *New = new Function(Ty, GlobalVariable::ExternalLinkage, Name);
 104     FunctionList.push_back(New);
 105     return New;                    // Return the new prototype...
 106   }
 107 }
 108
 109 // getOrInsertFunction - Look up the specified function in the module symbol
 110 // table.  If it does not exist, add a prototype for the function and return it.
 111 // This version of the method takes a null terminated list of function
 112 // arguments, which makes it easier for clients to use.
 113 //
 114 Function *Module::getOrInsertFunction(const std::string &Name,
 115                                       const Type *RetTy, ...) {
 116   va_list Args;
 117   va_start(Args, RetTy);
 118
 119   // Build the list of argument types...
 120   std::vector<const Type*> ArgTys;
 121   while (const Type *ArgTy = va_arg(Args, const Type*))
 122     ArgTys.push_back(ArgTy);
 123
 124   va_end(Args);
 125
 126   // Build the function type and chain to the other getOrInsertFunction...
 127   return getOrInsertFunction(Name, FunctionType::get(RetTy, ArgTys, false));
 128 }
 129
 130
 131 // getFunction - Look up the specified function in the module symbol table.
 132 // If it does not exist, return null.
 133 //
 134 Function *Module::getFunction(const std::string &Name, const FunctionType *Ty) {
 135   SymbolTable &SymTab = getSymbolTable();
 136   return cast_or_null<Function>(SymTab.lookup(PointerType::get(Ty), Name));
 137 }
 138
 139
 140 /// getMainFunction - This function looks up main efficiently.  This is such a
 141 /// common case, that it is a method in Module.  If main cannot be found, a
 142 /// null pointer is returned.
 143 ///
 144 Function *Module::getMainFunction() {
 145   std::vector<const Type*> Params;
 146
 147   // int main(void)...
 148   if (Function *F = getFunction("main", FunctionType::get(Type::IntTy,
 149                                                           Params, false)))
 150     return F;
 151
 152   // void main(void)...
 153   if (Function *F = getFunction("main", FunctionType::get(Type::VoidTy,
 154                                                           Params, false)))
 155     return F;
 156
 157   Params.push_back(Type::IntTy);
 158
 159   // int main(int argc)...
 160   if (Function *F = getFunction("main", FunctionType::get(Type::IntTy,
 161                                                           Params, false)))
 162     return F;
 163
 164   // void main(int argc)...
 165   if (Function *F = getFunction("main", FunctionType::get(Type::VoidTy,
 166                                                           Params, false)))
 167     return F;
 168
 169   for (unsigned i = 0; i != 2; ++i) {  // Check argv and envp
 170     Params.push_back(PointerType::get(PointerType::get(Type::SByteTy)));
 171
 172     // int main(int argc, char **argv)...
 173     if (Function *F = getFunction("main", FunctionType::get(Type::IntTy,
 174                                                             Params, false)))
 175       return F;
 176
 177     // void main(int argc, char **argv)...
 178     if (Function *F = getFunction("main", FunctionType::get(Type::VoidTy,
 179                                                             Params, false)))
 180       return F;
 181   }
 182
 183   // Ok, try to find main the hard way...
 184   return getNamedFunction("main");
 185 }
 186
 187 /// getNamedFunction - Return the first function in the module with the
 188 /// specified name, of arbitrary type.  This method returns null if a function
 189 /// with the specified name is not found.
 190 ///
 191 Function *Module::getNamedFunction(const std::string &Name) {
 192   // Loop over all of the functions, looking for the function desired
 193   Function *Found = 0;
 194   for (iterator I = begin(), E = end(); I != E; ++I)
 195     if (I->getName() == Name)
 196       if (I->isExternal())
 197         Found = I;
 198       else
 199         return I;
 200   return Found; // Non-external function not found...
 201 }
 202
 203 //===----------------------------------------------------------------------===//
 204 // Methods for easy access to the global variables in the module.
 205 //
 206
 207 /// getGlobalVariable - Look up the specified global variable in the module
 208 /// symbol table.  If it does not exist, return null.  Note that this only
 209 /// returns a global variable if it does not have internal linkage.  The type
 210 /// argument should be the underlying type of the global, ie, it should not
 211 /// have the top-level PointerType, which represents the address of the
 212 /// global.
 213 ///
 214 GlobalVariable *Module::getGlobalVariable(const std::string &Name,
 215                                           const Type *Ty) {
 216   if (Value *V = getSymbolTable().lookup(PointerType::get(Ty), Name)) {
 217     GlobalVariable *Result = cast<GlobalVariable>(V);
 218     if (!Result->hasInternalLinkage())
 219       return Result;
 220   }
 221   return 0;
 222 }
 223
 224
 225
 226 //===----------------------------------------------------------------------===//
 227 // Methods for easy access to the types in the module.
 228 //
 229
 230
 231 // addTypeName - Insert an entry in the symbol table mapping Str to Type.  If
 232 // there is already an entry for this name, true is returned and the symbol
 233 // table is not modified.
 234 //
 235 bool Module::addTypeName(const std::string &Name, const Type *Ty) {
 236   SymbolTable &ST = getSymbolTable();
 237
 238   if (ST.lookupType(Name)) return true;  // Already in symtab...
 239
 240   // Not in symbol table?  Set the name with the Symtab as an argument so the
 241   // type knows what to update...
 242   ST.insert(Name, Ty);
 243
 244   return false;
 245 }
 246
 247 /// getTypeByName - Return the type with the specified name in this module, or
 248 /// null if there is none by that name.
 249 const Type *Module::getTypeByName(const std::string &Name) const {
 250   const SymbolTable &ST = getSymbolTable();
 251   return cast_or_null<Type>(ST.lookupType(Name));
 252 }
 253
 254 // getTypeName - If there is at least one entry in the symbol table for the
 255 // specified type, return it.
 256 //
 257 std::string Module::getTypeName(const Type *Ty) const {
 258   const SymbolTable &ST = getSymbolTable();
 259
 260   SymbolTable::type_const_iterator TI = ST.type_begin();
 261   SymbolTable::type_const_iterator TE = ST.type_end();
 262   if ( TI == TE ) return ""; // No names for types
 263
 264   while (TI != TE && TI->second != Ty)
 265     ++TI;
 266
 267   if (TI != TE)  // Must have found an entry!
 268     return TI->first;
 269   return "";     // Must not have found anything...
 270 }
 271
 272
 273 //===----------------------------------------------------------------------===//
 274 // Other module related stuff.
 275 //
 276
 277
 278 // dropAllReferences() - This function causes all the subelementss to "let go"
 279 // of all references that they are maintaining.  This allows one to 'delete' a
 280 // whole module at a time, even though there may be circular references... first
 281 // all references are dropped, and all use counts go to zero.  Then everything
 282 // is deleted for real.  Note that no operations are valid on an object that
 283 // has "dropped all references", except operator delete.
 284 //
 285 void Module::dropAllReferences() {
 286   for(Module::iterator I = begin(), E = end(); I != E; ++I)
 287     I->dropAllReferences();
 288
 289   for(Module::giterator I = gbegin(), E = gend(); I != E; ++I)
 290     I->dropAllReferences();
 291 }
 292