include/llvm/Module.h

   1 //===-- llvm/Module.h - C++ class to represent a VM module ------*- C++ -*-===//
   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 contains the declarations for the Module class that is used to
  11 // maintain all the information related to a VM module.
  12 //
  13 // A module also maintains a GlobalValRefMap object that is used to hold all
  14 // constant references to global variables in the module.  When a global
  15 // variable is destroyed, it should have no entries in the GlobalValueRefMap.
  16 //
  17 //===----------------------------------------------------------------------===//
  18
  19 #ifndef LLVM_MODULE_H
  20 #define LLVM_MODULE_H
  21
  22 #include "llvm/Function.h"
  23 #include "llvm/GlobalVariable.h"
  24
  25 namespace llvm {
  26
  27 class GlobalVariable;
  28 class GlobalValueRefMap;   // Used by ConstantVals.cpp
  29 class ConstantPointerRef;
  30 class FunctionType;
  31 class SymbolTable;
  32
  33 template<> struct ilist_traits<Function>
  34   : public SymbolTableListTraits<Function, Module, Module> {
  35   // createNode is used to create a node that marks the end of the list...
  36   static Function *createNode();
  37   static iplist<Function> &getList(Module *M);
  38 };
  39 template<> struct ilist_traits<GlobalVariable>
  40   : public SymbolTableListTraits<GlobalVariable, Module, Module> {
  41   // createNode is used to create a node that marks the end of the list...
  42   static GlobalVariable *createNode();
  43   static iplist<GlobalVariable> &getList(Module *M);
  44 };
  45
  46 struct Module : public Annotable {
  47   typedef iplist<GlobalVariable> GlobalListType;
  48   typedef iplist<Function> FunctionListType;
  49
  50   // Global Variable iterators...
  51   typedef GlobalListType::iterator                             giterator;
  52   typedef GlobalListType::const_iterator                 const_giterator;
  53   typedef std::reverse_iterator<giterator>             reverse_giterator;
  54   typedef std::reverse_iterator<const_giterator> const_reverse_giterator;
  55
  56   // Function iterators...
  57   typedef FunctionListType::iterator                          iterator;
  58   typedef FunctionListType::const_iterator              const_iterator;
  59   typedef std::reverse_iterator<iterator>             reverse_iterator;
  60   typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
  61
  62   enum Endianness  { AnyEndianness, LittleEndian, BigEndian };
  63   enum PointerSize { AnyPointerSize, Pointer32, Pointer64 };
  64
  65 private:
  66   GlobalListType GlobalList;     // The Global Variables in the module
  67   FunctionListType FunctionList; // The Functions in the module
  68   GlobalValueRefMap *GVRefMap;   // Keep track of GlobalValueRef's
  69   SymbolTable *SymTab;           // Symbol Table for the module
  70   std::string ModuleID;    // Human readable identifier for the module
  71
  72   // These flags are probably not the right long-term way to handle this kind of
  73   // target information, but it is sufficient for now.
  74   Endianness  Endian;       // True if target is little endian
  75   PointerSize PtrSize;    // True if target has 32-bit pointers (false = 64-bit)
  76
  77   // Accessor for the underlying GVRefMap... only through the Constant class...
  78   friend class Constant;
  79   friend class ConstantPointerRef;
  80   void mutateConstantPointerRef(GlobalValue *OldGV, GlobalValue *NewGV);
  81   ConstantPointerRef *getConstantPointerRef(GlobalValue *GV);
  82   void destroyConstantPointerRef(ConstantPointerRef *CPR);
  83
  84 public:
  85   Module(const std::string &ModuleID);
  86   ~Module();
  87
  88   const std::string &getModuleIdentifier() const { return ModuleID; }
  89
  90   /// Target endian information...
  91   Endianness getEndianness() const { return Endian; }
  92   void setEndianness(Endianness E) { Endian = E; }
  93
  94   /// Target Pointer Size information...
  95   PointerSize getPointerSize() const { return PtrSize; }
  96   void setPointerSize(PointerSize PS) { PtrSize = PS; }
  97
  98   /// getOrInsertFunction - Look up the specified function in the module symbol
  99   /// table.  If it does not exist, add a prototype for the function and return
 100   /// it.
 101   Function *getOrInsertFunction(const std::string &Name, const FunctionType *T);
 102
 103   /// getOrInsertFunction - Look up the specified function in the module symbol
 104   /// table.  If it does not exist, add a prototype for the function and return
 105   /// it.  This version of the method takes a null terminated list of function
 106   /// arguments, which makes it easier for clients to use.
 107   Function *getOrInsertFunction(const std::string &Name, const Type *RetTy,...);
 108
 109   /// getFunction - Look up the specified function in the module symbol table.
 110   /// If it does not exist, return null.
 111   ///
 112   Function *getFunction(const std::string &Name, const FunctionType *Ty);
 113
 114   /// getMainFunction - This function looks up main efficiently.  This is such a
 115   /// common case, that it is a method in Module.  If main cannot be found, a
 116   /// null pointer is returned.
 117   ///
 118   Function *getMainFunction();
 119
 120   /// getNamedFunction - Return the first function in the module with the
 121   /// specified name, of arbitrary type.  This method returns null if a function
 122   /// with the specified name is not found.
 123   ///
 124   Function *getNamedFunction(const std::string &Name);
 125
 126   /// addTypeName - Insert an entry in the symbol table mapping Str to Type.  If
 127   /// there is already an entry for this name, true is returned and the symbol
 128   /// table is not modified.
 129   ///
 130   bool addTypeName(const std::string &Name, const Type *Ty);
 131
 132   /// getTypeName - If there is at least one entry in the symbol table for the
 133   /// specified type, return it.
 134   ///
 135   std::string getTypeName(const Type *Ty) const;
 136
 137   /// getTypeByName - Return the type with the specified name in this module, or
 138   /// null if there is none by that name.
 139   const Type *getTypeByName(const std::string &Name) const;
 140
 141   /// Get the underlying elements of the Module...
 142   inline const GlobalListType &getGlobalList() const  { return GlobalList; }
 143   inline       GlobalListType &getGlobalList()        { return GlobalList; }
 144   inline const FunctionListType &getFunctionList() const { return FunctionList;}
 145   inline       FunctionListType &getFunctionList()       { return FunctionList;}
 146
 147
 148   //===--------------------------------------------------------------------===//
 149   // Symbol table support functions...
 150
 151   /// getSymbolTable() - Get access to the symbol table for the module, where
 152   /// global variables and functions are identified.
 153   ///
 154   inline       SymbolTable &getSymbolTable()       { return *SymTab; }
 155   inline const SymbolTable &getSymbolTable() const { return *SymTab; }
 156
 157
 158   //===--------------------------------------------------------------------===//
 159   // Module iterator forwarding functions
 160   //
 161   inline giterator                gbegin()       { return GlobalList.begin(); }
 162   inline const_giterator          gbegin() const { return GlobalList.begin(); }
 163   inline giterator                gend  ()       { return GlobalList.end();   }
 164   inline const_giterator          gend  () const { return GlobalList.end();   }
 165
 166   inline reverse_giterator       grbegin()       { return GlobalList.rbegin(); }
 167   inline const_reverse_giterator grbegin() const { return GlobalList.rbegin(); }
 168   inline reverse_giterator       grend  ()       { return GlobalList.rend();   }
 169   inline const_reverse_giterator grend  () const { return GlobalList.rend();   }
 170
 171   inline unsigned                  gsize() const { return GlobalList.size(); }
 172   inline bool                     gempty() const { return GlobalList.empty(); }
 173   inline const GlobalVariable    &gfront() const { return GlobalList.front(); }
 174   inline       GlobalVariable    &gfront()       { return GlobalList.front(); }
 175   inline const GlobalVariable     &gback() const { return GlobalList.back(); }
 176   inline       GlobalVariable     &gback()       { return GlobalList.back(); }
 177
 178
 179
 180   inline iterator                begin()       { return FunctionList.begin(); }
 181   inline const_iterator          begin() const { return FunctionList.begin(); }
 182   inline iterator                end  ()       { return FunctionList.end();   }
 183   inline const_iterator          end  () const { return FunctionList.end();   }
 184
 185   inline reverse_iterator       rbegin()       { return FunctionList.rbegin(); }
 186   inline const_reverse_iterator rbegin() const { return FunctionList.rbegin(); }
 187   inline reverse_iterator       rend  ()       { return FunctionList.rend();   }
 188   inline const_reverse_iterator rend  () const { return FunctionList.rend();   }
 189
 190   inline unsigned                 size() const { return FunctionList.size(); }
 191   inline bool                    empty() const { return FunctionList.empty(); }
 192   inline const Function         &front() const { return FunctionList.front(); }
 193   inline       Function         &front()       { return FunctionList.front(); }
 194   inline const Function          &back() const { return FunctionList.back(); }
 195   inline       Function          &back()       { return FunctionList.back(); }
 196
 197   void print(std::ostream &OS) const { print(OS, 0); }
 198   void print(std::ostream &OS, AssemblyAnnotationWriter *AAW) const;
 199
 200   void dump() const;
 201
 202   /// dropAllReferences() - This function causes all the subinstructions to "let
 203   /// go" of all references that they are maintaining.  This allows one to
 204   /// 'delete' a whole class at a time, even though there may be circular
 205   /// references... first all references are dropped, and all use counts go to
 206   /// zero.  Then everything is delete'd for real.  Note that no operations are
 207   /// valid on an object that has "dropped all references", except operator
 208   /// delete.
 209   ///
 210   void dropAllReferences();
 211 };
 212
 213 inline std::ostream &operator<<(std::ostream &O, const Module *M) {
 214   M->print(O);
 215   return O;
 216 }
 217
 218 inline std::ostream &operator<<(std::ostream &O, const Module &M) {
 219   M.print(O);
 220   return O;
 221 }
 222
 223 } // End llvm namespace
 224
 225 #endif