X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FModule.h;h=bce671ddb296b378065191badf44ad8214bb10b2;hb=0011dc4738fbe624d44197ef9496517fd093eaa4;hp=e645f51c1c3a426fddaabf8c9e029a1560795288;hpb=17fcdd5e1b78b829068ca657c97357a39d6e768b;p=oota-llvm.git diff --git a/include/llvm/Module.h b/include/llvm/Module.h index e645f51c1c3..bce671ddb29 100644 --- a/include/llvm/Module.h +++ b/include/llvm/Module.h @@ -2,12 +2,12 @@ // // 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 is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// // -/// @file This file contains the declarations for the Module class. +/// @file This file contains the declarations for the Module class. // //===----------------------------------------------------------------------===// @@ -16,12 +16,12 @@ #include "llvm/Function.h" #include "llvm/GlobalVariable.h" +#include "llvm/GlobalAlias.h" #include "llvm/Support/DataTypes.h" #include namespace llvm { -class GlobalVariable; class GlobalValueRefMap; // Used by ConstantVals.cpp class FunctionType; @@ -32,6 +32,7 @@ template<> struct ilist_traits static void destroySentinel(Function *F) { delete F; } static iplist &getList(Module *M); static inline ValueSymbolTable *getSymTab(Module *M); + static int getListOffset(); }; template<> struct ilist_traits : public SymbolTableListTraits { @@ -40,12 +41,22 @@ template<> struct ilist_traits static void destroySentinel(GlobalVariable *GV) { delete GV; } static iplist &getList(Module *M); static inline ValueSymbolTable *getSymTab(Module *M); + static int getListOffset(); +}; +template<> struct ilist_traits + : public SymbolTableListTraits { + // createSentinel is used to create a node that marks the end of the list. + static GlobalAlias *createSentinel(); + static void destroySentinel(GlobalAlias *GA) { delete GA; } + static iplist &getList(Module *M); + static inline ValueSymbolTable *getSymTab(Module *M); + static int getListOffset(); }; /// A Module instance is used to store all the information related to an -/// LLVM module. Modules are the top level container of all other LLVM +/// LLVM module. Modules are the top level container of all other LLVM /// Intermediate Representation (IR) objects. Each module directly contains a -/// list of globals variables, a list of functions, a list of libraries (or +/// list of globals variables, a list of functions, a list of libraries (or /// other modules) this module depends on, a symbol table, and various data /// about the target's characteristics. /// @@ -61,6 +72,8 @@ public: typedef iplist GlobalListType; /// The type for the list of functions. typedef iplist FunctionListType; + /// The type for the list of aliases. + typedef iplist AliasListType; /// The type for the list of dependent libraries. typedef std::vector LibraryListType; @@ -75,6 +88,11 @@ public: /// The Function constant iterator typedef FunctionListType::const_iterator const_iterator; + /// The Global Alias iterators. + typedef AliasListType::iterator alias_iterator; + /// The Global Alias constant iterator + typedef AliasListType::const_iterator const_alias_iterator; + /// The Library list iterator. typedef LibraryListType::const_iterator lib_iterator; @@ -90,6 +108,7 @@ public: private: GlobalListType GlobalList; ///< The Global Variables in the module FunctionListType FunctionList; ///< The Functions in the module + AliasListType AliasList; ///< The Aliases in the module LibraryListType LibraryList; ///< The Libraries needed by the module std::string GlobalScopeAsm; ///< Inline Asm at global scope. ValueSymbolTable *ValSymTab; ///< Symbol table for values @@ -154,7 +173,14 @@ public: /// Set the module-scope inline assembly blocks. void setModuleInlineAsm(const std::string &Asm) { GlobalScopeAsm = Asm; } - + + /// Append to the module-scope inline assembly blocks, automatically + /// appending a newline to the end. + void appendModuleInlineAsm(const std::string &Asm) { + GlobalScopeAsm += Asm; + GlobalScopeAsm += '\n'; + } + /// @} /// @name Function Accessors /// @{ @@ -173,10 +199,10 @@ public: /// 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 function guarantees to return a constant of pointer to the - /// specified function type or a ConstantExpr BitCast of that type if the - /// named /// function has a different type. This version of the method - /// takes a null terminated list of function arguments, which makes it - /// easier for clients to use. + /// specified function type or a ConstantExpr BitCast of that type if the + /// named function has a different type. This version of the method takes a + /// null terminated list of function arguments, which makes it easier for + /// clients to use. Constant *getOrInsertFunction(const std::string &Name, const Type *RetTy,...) END_WITH_NULL; @@ -185,16 +211,14 @@ public: Function *getFunction(const std::string &Name) const; /// @} -/// @name Global Variable Accessors +/// @name Global Variable Accessors /// @{ public: /// 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 *getGlobalVariable(const std::string &Name, + /// symbol table. If it does not exist, return null. If AllowInternal is set + /// to true, this function will return types that have InternalLinkage. By + /// default, these types are not returned. + GlobalVariable *getGlobalVariable(const std::string &Name, bool AllowInternal = false) const; /// getNamedGlobal - Return the first global variable in the module with the @@ -203,7 +227,16 @@ public: GlobalVariable *getNamedGlobal(const std::string &Name) const { return getGlobalVariable(Name, true); } - + +/// @} +/// @name Global Alias Accessors +/// @{ +public: + /// getNamedAlias - Return the first global alias in the module with the + /// specified name, of arbitrary type. This method returns null if a global + /// with the specified name is not found. + GlobalAlias *getNamedAlias(const std::string &Name) const; + /// @} /// @name Type Accessors /// @{ @@ -233,14 +266,18 @@ public: const FunctionListType &getFunctionList() const { return FunctionList; } /// Get the Module's list of functions. FunctionListType &getFunctionList() { return FunctionList; } + /// Get the Module's list of aliases (constant). + const AliasListType &getAliasList() const { return AliasList; } + /// Get the Module's list of aliases. + AliasListType &getAliasList() { return AliasList; } /// Get the symbol table of global variable and function identifiers const ValueSymbolTable &getValueSymbolTable() const { return *ValSymTab; } /// Get the Module's symbol table of global variable and function identifiers. ValueSymbolTable &getValueSymbolTable() { return *ValSymTab; } /// Get the symbol table of types - const TypeSymbolTable &getTypeSymbolTable() const { return *TypeSymTab; } + const TypeSymbolTable &getTypeSymbolTable() const { return *TypeSymTab; } /// Get the Module's symbol table of types - TypeSymbolTable &getTypeSymbolTable() { return *TypeSymTab; } + TypeSymbolTable &getTypeSymbolTable() { return *TypeSymTab; } /// @} /// @name Global Variable Iteration @@ -270,20 +307,20 @@ public: /// Get a constant iterator to the last function. const_iterator end () const { return FunctionList.end(); } /// Determine how many functions are in the Module's list of functions. - size_t size() const { return FunctionList.size(); } + size_t size() const { return FunctionList.size(); } /// Determine if the list of functions is empty. bool empty() const { return FunctionList.empty(); } /// @} -/// @name Dependent Library Iteration +/// @name Dependent Library Iteration /// @{ public: /// @brief Get a constant iterator to beginning of dependent library list. inline lib_iterator lib_begin() const { return LibraryList.begin(); } /// @brief Get a constant iterator to end of dependent library list. - inline lib_iterator lib_end() const { return LibraryList.end(); } + inline lib_iterator lib_end() const { return LibraryList.end(); } /// @brief Returns the number of items in the list of libraries. - inline size_t lib_size() const { return LibraryList.size(); } + inline size_t lib_size() const { return LibraryList.size(); } /// @brief Add a library to the list of dependent libraries void addLibrary(const std::string& Lib); /// @brief Remove a library from the list of dependent libraries @@ -291,6 +328,23 @@ public: /// @brief Get all the libraries inline const LibraryListType& getLibraries() const { return LibraryList; } +/// @} +/// @name Alias Iteration +/// @{ +public: + /// Get an iterator to the first alias. + alias_iterator alias_begin() { return AliasList.begin(); } + /// Get a constant iterator to the first alias. + const_alias_iterator alias_begin() const { return AliasList.begin(); } + /// Get an iterator to the last alias. + alias_iterator alias_end () { return AliasList.end(); } + /// Get a constant iterator to the last alias. + const_alias_iterator alias_end () const { return AliasList.end(); } + /// Determine how many functions are in the Module's list of aliases. + size_t alias_size () const { return AliasList.size(); } + /// Determine if the list of aliases is empty. + bool alias_empty() const { return AliasList.empty(); } + /// @} /// @name Utility functions for printing and dumping Module objects /// @{ @@ -306,13 +360,26 @@ public: /// Dump the module to std::cerr (for debugging). void dump() const; /// 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 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 dropAllReferences(); /// @} + + static unsigned getFunctionListOffset() { + Module *Obj = 0; + return unsigned(reinterpret_cast(&Obj->FunctionList)); + } + static unsigned getGlobalVariableListOffset() { + Module *Obj = 0; + return unsigned(reinterpret_cast(&Obj->GlobalList)); + } + static unsigned getAliasListOffset() { + Module *Obj = 0; + return unsigned(reinterpret_cast(&Obj->AliasList)); + } }; /// An iostream inserter for modules. @@ -331,6 +398,25 @@ ilist_traits::getSymTab(Module *M) { return M ? &M->getValueSymbolTable() : 0; } +inline ValueSymbolTable * +ilist_traits::getSymTab(Module *M) { + return M ? &M->getValueSymbolTable() : 0; +} + +inline int +ilist_traits::getListOffset() { + return Module::getFunctionListOffset(); +} + +inline int +ilist_traits::getListOffset() { + return Module::getGlobalVariableListOffset(); +} + +inline int +ilist_traits::getListOffset() { + return Module::getAliasListOffset(); +} } // End llvm namespace