lib/VMCore/Module.cpp

   1 //===-- Module.cpp - Implement the Module class ---------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // 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 "llvm/ADT/STLExtras.h"
  19 #include "llvm/ADT/StringExtras.h"
  20 #include "llvm/Support/LeakDetector.h"
  21 #include "SymbolTableListTraitsImpl.h"
  22 #include "llvm/TypeSymbolTable.h"
  23 #include <algorithm>
  24 #include <cstdarg>
  25 #include <cstdlib>
  26 using namespace llvm;
  27
  28 //===----------------------------------------------------------------------===//
  29 // Methods to implement the globals and functions lists.
  30 //
  31
  32 Function *ilist_traits<Function>::createSentinel() {
  33   FunctionType *FTy =
  34     FunctionType::get(Type::VoidTy, std::vector<const Type*>(), false);
  35   Function *Ret = Function::Create(FTy, GlobalValue::ExternalLinkage);
  36   // This should not be garbage monitored.
  37   LeakDetector::removeGarbageObject(Ret);
  38   return Ret;
  39 }
  40 GlobalVariable *ilist_traits<GlobalVariable>::createSentinel() {
  41   GlobalVariable *Ret = new GlobalVariable(Type::Int32Ty, false,
  42                                            GlobalValue::ExternalLinkage);
  43   // This should not be garbage monitored.
  44   LeakDetector::removeGarbageObject(Ret);
  45   return Ret;
  46 }
  47 GlobalAlias *ilist_traits<GlobalAlias>::createSentinel() {
  48   GlobalAlias *Ret = new GlobalAlias(Type::Int32Ty,
  49                                      GlobalValue::ExternalLinkage);
  50   // This should not be garbage monitored.
  51   LeakDetector::removeGarbageObject(Ret);
  52   return Ret;
  53 }
  54
  55 iplist<Function> &ilist_traits<Function>::getList(Module *M) {
  56   return M->getFunctionList();
  57 }
  58 iplist<GlobalVariable> &ilist_traits<GlobalVariable>::getList(Module *M) {
  59   return M->getGlobalList();
  60 }
  61 iplist<GlobalAlias> &ilist_traits<GlobalAlias>::getList(Module *M) {
  62   return M->getAliasList();
  63 }
  64
  65 // Explicit instantiations of SymbolTableListTraits since some of the methods
  66 // are not in the public header file.
  67 template class SymbolTableListTraits<GlobalVariable, Module>;
  68 template class SymbolTableListTraits<Function, Module>;
  69 template class SymbolTableListTraits<GlobalAlias, Module>;
  70
  71 //===----------------------------------------------------------------------===//
  72 // Primitive Module methods.
  73 //
  74
  75 Module::Module(const std::string &MID)
  76   : ModuleID(MID), DataLayout("") {
  77   ValSymTab = new ValueSymbolTable();
  78   TypeSymTab = new TypeSymbolTable();
  79 }
  80
  81 Module::~Module() {
  82   dropAllReferences();
  83   GlobalList.clear();
  84   FunctionList.clear();
  85   AliasList.clear();
  86   LibraryList.clear();
  87   delete ValSymTab;
  88   delete TypeSymTab;
  89 }
  90
  91 /// Target endian information...
  92 Module::Endianness Module::getEndianness() const {
  93   std::string temp = DataLayout;
  94   Module::Endianness ret = AnyEndianness;
  95
  96   while (!temp.empty()) {
  97     std::string token = getToken(temp, "-");
  98
  99     if (token[0] == 'e') {
 100       ret = LittleEndian;
 101     } else if (token[0] == 'E') {
 102       ret = BigEndian;
 103     }
 104   }
 105
 106   return ret;
 107 }
 108
 109 /// Target Pointer Size information...
 110 Module::PointerSize Module::getPointerSize() const {
 111   std::string temp = DataLayout;
 112   Module::PointerSize ret = AnyPointerSize;
 113
 114   while (!temp.empty()) {
 115     std::string token = getToken(temp, "-");
 116     char signal = getToken(token, ":")[0];
 117
 118     if (signal == 'p') {
 119       int size = atoi(getToken(token, ":").c_str());
 120       if (size == 32)
 121         ret = Pointer32;
 122       else if (size == 64)
 123         ret = Pointer64;
 124     }
 125   }
 126
 127   return ret;
 128 }
 129
 130 //===----------------------------------------------------------------------===//
 131 // Methods for easy access to the functions in the module.
 132 //
 133
 134 // getOrInsertFunction - Look up the specified function in the module symbol
 135 // table.  If it does not exist, add a prototype for the function and return
 136 // it.  This is nice because it allows most passes to get away with not handling
 137 // the symbol table directly for this common task.
 138 //
 139 Constant *Module::getOrInsertFunction(const std::string &Name,
 140                                       const FunctionType *Ty) {
 141   ValueSymbolTable &SymTab = getValueSymbolTable();
 142
 143   // See if we have a definition for the specified function already.
 144   GlobalValue *F = dyn_cast_or_null<GlobalValue>(SymTab.lookup(Name));
 145   if (F == 0) {
 146     // Nope, add it
 147     Function *New = Function::Create(Ty, GlobalVariable::ExternalLinkage, Name);
 148     FunctionList.push_back(New);
 149     return New;                    // Return the new prototype.
 150   }
 151
 152   // Okay, the function exists.  Does it have externally visible linkage?
 153   if (F->hasInternalLinkage()) {
 154     // Clear the function's name.
 155     F->setName("");
 156     // Retry, now there won't be a conflict.
 157     Constant *NewF = getOrInsertFunction(Name, Ty);
 158     F->setName(&Name[0], Name.size());
 159     return NewF;
 160   }
 161
 162   // If the function exists but has the wrong type, return a bitcast to the
 163   // right type.
 164   if (F->getType() != PointerType::getUnqual(Ty))
 165     return ConstantExpr::getBitCast(F, PointerType::getUnqual(Ty));
 166
 167   // Otherwise, we just found the existing function or a prototype.
 168   return F;
 169 }
 170
 171 // getOrInsertFunction - Look up the specified function in the module symbol
 172 // table.  If it does not exist, add a prototype for the function and return it.
 173 // This version of the method takes a null terminated list of function
 174 // arguments, which makes it easier for clients to use.
 175 //
 176 Constant *Module::getOrInsertFunction(const std::string &Name,
 177                                       const Type *RetTy, ...) {
 178   va_list Args;
 179   va_start(Args, RetTy);
 180
 181   // Build the list of argument types...
 182   std::vector<const Type*> ArgTys;
 183   while (const Type *ArgTy = va_arg(Args, const Type*))
 184     ArgTys.push_back(ArgTy);
 185
 186   va_end(Args);
 187
 188   // Build the function type and chain to the other getOrInsertFunction...
 189   return getOrInsertFunction(Name, FunctionType::get(RetTy, ArgTys, false));
 190 }
 191
 192
 193 // getFunction - Look up the specified function in the module symbol table.
 194 // If it does not exist, return null.
 195 //
 196 Function *Module::getFunction(const std::string &Name) const {
 197   const ValueSymbolTable &SymTab = getValueSymbolTable();
 198   return dyn_cast_or_null<Function>(SymTab.lookup(Name));
 199 }
 200
 201 Function *Module::getFunction(const char *Name) const {
 202   const ValueSymbolTable &SymTab = getValueSymbolTable();
 203   return dyn_cast_or_null<Function>(SymTab.lookup(Name, Name+strlen(Name)));
 204 }
 205
 206 //===----------------------------------------------------------------------===//
 207 // Methods for easy access to the global variables in the module.
 208 //
 209
 210 /// getGlobalVariable - Look up the specified global variable in the module
 211 /// symbol table.  If it does not exist, return null.  The type argument
 212 /// should be the underlying type of the global, i.e., it should not have
 213 /// the top-level PointerType, which represents the address of the global.
 214 /// If AllowInternal is set to true, this function will return types that
 215 /// have InternalLinkage. By default, these types are not returned.
 216 ///
 217 GlobalVariable *Module::getGlobalVariable(const std::string &Name,
 218                                           bool AllowInternal) const {
 219   if (Value *V = ValSymTab->lookup(Name)) {
 220     GlobalVariable *Result = dyn_cast<GlobalVariable>(V);
 221     if (Result && (AllowInternal || !Result->hasInternalLinkage()))
 222       return Result;
 223   }
 224   return 0;
 225 }
 226
 227 Constant *Module::getOrInsertGlobal(const std::string &Name, const Type *Ty) {
 228   ValueSymbolTable &SymTab = getValueSymbolTable();
 229
 230   // See if we have a definition for the specified global already.
 231   GlobalVariable *GV = dyn_cast_or_null<GlobalVariable>(SymTab.lookup(Name));
 232   if (GV == 0) {
 233     // Nope, add it
 234     GlobalVariable *New =
 235       new GlobalVariable(Ty, false, GlobalVariable::ExternalLinkage, 0, Name);
 236     GlobalList.push_back(New);
 237     return New;                    // Return the new declaration.
 238   }
 239
 240   // If the variable exists but has the wrong type, return a bitcast to the
 241   // right type.
 242   if (GV->getType() != PointerType::getUnqual(Ty))
 243     return ConstantExpr::getBitCast(GV, PointerType::getUnqual(Ty));
 244
 245   // Otherwise, we just found the existing function or a prototype.
 246   return GV;
 247 }
 248
 249 //===----------------------------------------------------------------------===//
 250 // Methods for easy access to the global variables in the module.
 251 //
 252
 253 // getNamedAlias - Look up the specified global in the module symbol table.
 254 // If it does not exist, return null.
 255 //
 256 GlobalAlias *Module::getNamedAlias(const std::string &Name) const {
 257   const ValueSymbolTable &SymTab = getValueSymbolTable();
 258   return dyn_cast_or_null<GlobalAlias>(SymTab.lookup(Name));
 259 }
 260
 261 //===----------------------------------------------------------------------===//
 262 // Methods for easy access to the types in the module.
 263 //
 264
 265
 266 // addTypeName - Insert an entry in the symbol table mapping Str to Type.  If
 267 // there is already an entry for this name, true is returned and the symbol
 268 // table is not modified.
 269 //
 270 bool Module::addTypeName(const std::string &Name, const Type *Ty) {
 271   TypeSymbolTable &ST = getTypeSymbolTable();
 272
 273   if (ST.lookup(Name)) return true;  // Already in symtab...
 274
 275   // Not in symbol table?  Set the name with the Symtab as an argument so the
 276   // type knows what to update...
 277   ST.insert(Name, Ty);
 278
 279   return false;
 280 }
 281
 282 /// getTypeByName - Return the type with the specified name in this module, or
 283 /// null if there is none by that name.
 284 const Type *Module::getTypeByName(const std::string &Name) const {
 285   const TypeSymbolTable &ST = getTypeSymbolTable();
 286   return cast_or_null<Type>(ST.lookup(Name));
 287 }
 288
 289 // getTypeName - If there is at least one entry in the symbol table for the
 290 // specified type, return it.
 291 //
 292 std::string Module::getTypeName(const Type *Ty) const {
 293   const TypeSymbolTable &ST = getTypeSymbolTable();
 294
 295   TypeSymbolTable::const_iterator TI = ST.begin();
 296   TypeSymbolTable::const_iterator TE = ST.end();
 297   if ( TI == TE ) return ""; // No names for types
 298
 299   while (TI != TE && TI->second != Ty)
 300     ++TI;
 301
 302   if (TI != TE)  // Must have found an entry!
 303     return TI->first;
 304   return "";     // Must not have found anything...
 305 }
 306
 307 //===----------------------------------------------------------------------===//
 308 // Other module related stuff.
 309 //
 310
 311
 312 // dropAllReferences() - This function causes all the subelementss to "let go"
 313 // of all references that they are maintaining.  This allows one to 'delete' a
 314 // whole module at a time, even though there may be circular references... first
 315 // all references are dropped, and all use counts go to zero.  Then everything
 316 // is deleted for real.  Note that no operations are valid on an object that
 317 // has "dropped all references", except operator delete.
 318 //
 319 void Module::dropAllReferences() {
 320   for(Module::iterator I = begin(), E = end(); I != E; ++I)
 321     I->dropAllReferences();
 322
 323   for(Module::global_iterator I = global_begin(), E = global_end(); I != E; ++I)
 324     I->dropAllReferences();
 325
 326   for(Module::alias_iterator I = alias_begin(), E = alias_end(); I != E; ++I)
 327     I->dropAllReferences();
 328 }
 329
 330 void Module::addLibrary(const std::string& Lib) {
 331   for (Module::lib_iterator I = lib_begin(), E = lib_end(); I != E; ++I)
 332     if (*I == Lib)
 333       return;
 334   LibraryList.push_back(Lib);
 335 }
 336
 337 void Module::removeLibrary(const std::string& Lib) {
 338   LibraryListType::iterator I = LibraryList.begin();
 339   LibraryListType::iterator E = LibraryList.end();
 340   for (;I != E; ++I)
 341     if (*I == Lib) {
 342       LibraryList.erase(I);
 343       return;
 344     }
 345 }
 346