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                                       AttrListPtr AttributeList) {
 142   ValueSymbolTable &SymTab = getValueSymbolTable();
 143
 144   // See if we have a definition for the specified function already.
 145   GlobalValue *F = dyn_cast_or_null<GlobalValue>(SymTab.lookup(Name));
 146   if (F == 0) {
 147     // Nope, add it
 148     Function *New = Function::Create(Ty, GlobalVariable::ExternalLinkage, Name);
 149     if (!New->isIntrinsic())       // Intrinsics get attrs set on construction
 150       New->setAttributes(AttributeList);
 151     FunctionList.push_back(New);
 152     return New;                    // Return the new prototype.
 153   }
 154
 155   // Okay, the function exists.  Does it have externally visible linkage?
 156   if (F->hasLocalLinkage()) {
 157     // Clear the function's name.
 158     F->setName("");
 159     // Retry, now there won't be a conflict.
 160     Constant *NewF = getOrInsertFunction(Name, Ty);
 161     F->setName(&Name[0], Name.size());
 162     return NewF;
 163   }
 164
 165   // If the function exists but has the wrong type, return a bitcast to the
 166   // right type.
 167   if (F->getType() != PointerType::getUnqual(Ty))
 168     return ConstantExpr::getBitCast(F, PointerType::getUnqual(Ty));
 169
 170   // Otherwise, we just found the existing function or a prototype.
 171   return F;
 172 }
 173
 174 Constant *Module::getOrInsertTargetIntrinsic(const std::string &Name,
 175                                              const FunctionType *Ty,
 176                                              AttrListPtr AttributeList) {
 177   ValueSymbolTable &SymTab = getValueSymbolTable();
 178
 179   // See if we have a definition for the specified function already.
 180   GlobalValue *F = dyn_cast_or_null<GlobalValue>(SymTab.lookup(Name));
 181   if (F == 0) {
 182     // Nope, add it
 183     Function *New = Function::Create(Ty, GlobalVariable::ExternalLinkage, Name);
 184     New->setAttributes(AttributeList);
 185     FunctionList.push_back(New);
 186     return New; // Return the new prototype.
 187   }
 188
 189   // Otherwise, we just found the existing function or a prototype.
 190   return F;
 191 }
 192
 193 Constant *Module::getOrInsertFunction(const std::string &Name,
 194                                       const FunctionType *Ty) {
 195   AttrListPtr AttributeList = AttrListPtr::get((AttributeWithIndex *)0, 0);
 196   return getOrInsertFunction(Name, Ty, AttributeList);
 197 }
 198
 199 // getOrInsertFunction - Look up the specified function in the module symbol
 200 // table.  If it does not exist, add a prototype for the function and return it.
 201 // This version of the method takes a null terminated list of function
 202 // arguments, which makes it easier for clients to use.
 203 //
 204 Constant *Module::getOrInsertFunction(const std::string &Name,
 205                                       AttrListPtr AttributeList,
 206                                       const Type *RetTy, ...) {
 207   va_list Args;
 208   va_start(Args, RetTy);
 209
 210   // Build the list of argument types...
 211   std::vector<const Type*> ArgTys;
 212   while (const Type *ArgTy = va_arg(Args, const Type*))
 213     ArgTys.push_back(ArgTy);
 214
 215   va_end(Args);
 216
 217   // Build the function type and chain to the other getOrInsertFunction...
 218   return getOrInsertFunction(Name, FunctionType::get(RetTy, ArgTys, false),
 219                              AttributeList);
 220 }
 221
 222 Constant *Module::getOrInsertFunction(const std::string &Name,
 223                                       const Type *RetTy, ...) {
 224   va_list Args;
 225   va_start(Args, RetTy);
 226
 227   // Build the list of argument types...
 228   std::vector<const Type*> ArgTys;
 229   while (const Type *ArgTy = va_arg(Args, const Type*))
 230     ArgTys.push_back(ArgTy);
 231
 232   va_end(Args);
 233
 234   // Build the function type and chain to the other getOrInsertFunction...
 235   return getOrInsertFunction(Name, FunctionType::get(RetTy, ArgTys, false),
 236                              AttrListPtr::get((AttributeWithIndex *)0, 0));
 237 }
 238
 239 // getFunction - Look up the specified function in the module symbol table.
 240 // If it does not exist, return null.
 241 //
 242 Function *Module::getFunction(const std::string &Name) const {
 243   const ValueSymbolTable &SymTab = getValueSymbolTable();
 244   return dyn_cast_or_null<Function>(SymTab.lookup(Name));
 245 }
 246
 247 Function *Module::getFunction(const char *Name) const {
 248   const ValueSymbolTable &SymTab = getValueSymbolTable();
 249   return dyn_cast_or_null<Function>(SymTab.lookup(Name, Name+strlen(Name)));
 250 }
 251
 252 //===----------------------------------------------------------------------===//
 253 // Methods for easy access to the global variables in the module.
 254 //
 255
 256 /// getGlobalVariable - Look up the specified global variable in the module
 257 /// symbol table.  If it does not exist, return null.  The type argument
 258 /// should be the underlying type of the global, i.e., it should not have
 259 /// the top-level PointerType, which represents the address of the global.
 260 /// If AllowLocal is set to true, this function will return types that
 261 /// have an local. By default, these types are not returned.
 262 ///
 263 GlobalVariable *Module::getGlobalVariable(const std::string &Name,
 264                                           bool AllowLocal) const {
 265   if (Value *V = ValSymTab->lookup(Name)) {
 266     GlobalVariable *Result = dyn_cast<GlobalVariable>(V);
 267     if (Result && (AllowLocal || !Result->hasLocalLinkage()))
 268       return Result;
 269   }
 270   return 0;
 271 }
 272
 273 /// getOrInsertGlobal - Look up the specified global in the module symbol table.
 274 ///   1. If it does not exist, add a declaration of the global and return it.
 275 ///   2. Else, the global exists but has the wrong type: return the function
 276 ///      with a constantexpr cast to the right type.
 277 ///   3. Finally, if the existing global is the correct delclaration, return the
 278 ///      existing global.
 279 Constant *Module::getOrInsertGlobal(const std::string &Name, const Type *Ty) {
 280   ValueSymbolTable &SymTab = getValueSymbolTable();
 281
 282   // See if we have a definition for the specified global already.
 283   GlobalVariable *GV = dyn_cast_or_null<GlobalVariable>(SymTab.lookup(Name));
 284   if (GV == 0) {
 285     // Nope, add it
 286     GlobalVariable *New =
 287       new GlobalVariable(Ty, false, GlobalVariable::ExternalLinkage, 0, Name);
 288     GlobalList.push_back(New);
 289     return New;                    // Return the new declaration.
 290   }
 291
 292   // If the variable exists but has the wrong type, return a bitcast to the
 293   // right type.
 294   if (GV->getType() != PointerType::getUnqual(Ty))
 295     return ConstantExpr::getBitCast(GV, PointerType::getUnqual(Ty));
 296
 297   // Otherwise, we just found the existing function or a prototype.
 298   return GV;
 299 }
 300
 301 //===----------------------------------------------------------------------===//
 302 // Methods for easy access to the global variables in the module.
 303 //
 304
 305 // getNamedAlias - Look up the specified global in the module symbol table.
 306 // If it does not exist, return null.
 307 //
 308 GlobalAlias *Module::getNamedAlias(const std::string &Name) const {
 309   const ValueSymbolTable &SymTab = getValueSymbolTable();
 310   return dyn_cast_or_null<GlobalAlias>(SymTab.lookup(Name));
 311 }
 312
 313 //===----------------------------------------------------------------------===//
 314 // Methods for easy access to the types in the module.
 315 //
 316
 317
 318 // addTypeName - Insert an entry in the symbol table mapping Str to Type.  If
 319 // there is already an entry for this name, true is returned and the symbol
 320 // table is not modified.
 321 //
 322 bool Module::addTypeName(const std::string &Name, const Type *Ty) {
 323   TypeSymbolTable &ST = getTypeSymbolTable();
 324
 325   if (ST.lookup(Name)) return true;  // Already in symtab...
 326
 327   // Not in symbol table?  Set the name with the Symtab as an argument so the
 328   // type knows what to update...
 329   ST.insert(Name, Ty);
 330
 331   return false;
 332 }
 333
 334 /// getTypeByName - Return the type with the specified name in this module, or
 335 /// null if there is none by that name.
 336 const Type *Module::getTypeByName(const std::string &Name) const {
 337   const TypeSymbolTable &ST = getTypeSymbolTable();
 338   return cast_or_null<Type>(ST.lookup(Name));
 339 }
 340
 341 // getTypeName - If there is at least one entry in the symbol table for the
 342 // specified type, return it.
 343 //
 344 std::string Module::getTypeName(const Type *Ty) const {
 345   const TypeSymbolTable &ST = getTypeSymbolTable();
 346
 347   TypeSymbolTable::const_iterator TI = ST.begin();
 348   TypeSymbolTable::const_iterator TE = ST.end();
 349   if ( TI == TE ) return ""; // No names for types
 350
 351   while (TI != TE && TI->second != Ty)
 352     ++TI;
 353
 354   if (TI != TE)  // Must have found an entry!
 355     return TI->first;
 356   return "";     // Must not have found anything...
 357 }
 358
 359 //===----------------------------------------------------------------------===//
 360 // Other module related stuff.
 361 //
 362
 363
 364 // dropAllReferences() - This function causes all the subelementss to "let go"
 365 // of all references that they are maintaining.  This allows one to 'delete' a
 366 // whole module at a time, even though there may be circular references... first
 367 // all references are dropped, and all use counts go to zero.  Then everything
 368 // is deleted for real.  Note that no operations are valid on an object that
 369 // has "dropped all references", except operator delete.
 370 //
 371 void Module::dropAllReferences() {
 372   for(Module::iterator I = begin(), E = end(); I != E; ++I)
 373     I->dropAllReferences();
 374
 375   for(Module::global_iterator I = global_begin(), E = global_end(); I != E; ++I)
 376     I->dropAllReferences();
 377
 378   for(Module::alias_iterator I = alias_begin(), E = alias_end(); I != E; ++I)
 379     I->dropAllReferences();
 380 }
 381
 382 void Module::addLibrary(const std::string& Lib) {
 383   for (Module::lib_iterator I = lib_begin(), E = lib_end(); I != E; ++I)
 384     if (*I == Lib)
 385       return;
 386   LibraryList.push_back(Lib);
 387 }
 388
 389 void Module::removeLibrary(const std::string& Lib) {
 390   LibraryListType::iterator I = LibraryList.begin();
 391   LibraryListType::iterator E = LibraryList.end();
 392   for (;I != E; ++I)
 393     if (*I == Lib) {
 394       LibraryList.erase(I);
 395       return;
 396     }
 397 }