//===-- llvm/Module.h - C++ class to represent a VM module ------*- C++ -*-===//
-//
+//
// 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.
//
-// This file contains the declarations for the Module class that is used to
-// maintain all the information related to a VM module.
+//===----------------------------------------------------------------------===//
//
-// A module also maintains a GlobalValRefMap object that is used to hold all
-// constant references to global variables in the module. When a global
-// variable is destroyed, it should have no entries in the GlobalValueRefMap.
+/// @file
+/// Module.h This file contains the declarations for the Module class.
//
//===----------------------------------------------------------------------===//
#include "llvm/Function.h"
#include "llvm/GlobalVariable.h"
-#include "llvm/ADT/SetVector.h"
+#include "llvm/GlobalAlias.h"
+#include "llvm/Support/DataTypes.h"
+#include <vector>
namespace llvm {
-class GlobalVariable;
class GlobalValueRefMap; // Used by ConstantVals.cpp
class FunctionType;
-class SymbolTable;
+class LLVMContext;
template<> struct ilist_traits<Function>
- : public SymbolTableListTraits<Function, Module, Module> {
- // createNode is used to create a node that marks the end of the list...
- static Function *createNode();
- static iplist<Function> &getList(Module *M);
+ : public SymbolTableListTraits<Function, Module> {
+
+ // createSentinel is used to get hold of the node that marks the end of the
+ // list... (same trick used here as in ilist_traits<Instruction>)
+ Function *createSentinel() const {
+ return static_cast<Function*>(&Sentinel);
+ }
+ static void destroySentinel(Function*) {}
+
+ Function *provideInitialHead() const { return createSentinel(); }
+ Function *ensureHead(Function*) const { return createSentinel(); }
+ static void noteHead(Function*, Function*) {}
+
+private:
+ mutable ilist_node<Function> Sentinel;
};
template<> struct ilist_traits<GlobalVariable>
- : public SymbolTableListTraits<GlobalVariable, Module, Module> {
- // createNode is used to create a node that marks the end of the list...
- static GlobalVariable *createNode();
- static iplist<GlobalVariable> &getList(Module *M);
+ : public SymbolTableListTraits<GlobalVariable, Module> {
+ // createSentinel is used to create a node that marks the end of the list.
+ static GlobalVariable *createSentinel();
+ static void destroySentinel(GlobalVariable *GV) { delete GV; }
+};
+template<> struct ilist_traits<GlobalAlias>
+ : public SymbolTableListTraits<GlobalAlias, Module> {
+ // createSentinel is used to create a node that marks the end of the list.
+ static GlobalAlias *createSentinel();
+ static void destroySentinel(GlobalAlias *GA) { delete GA; }
};
+/// 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
+/// Intermediate Representation (IR) objects. Each module directly contains a
+/// 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.
+///
+/// A module maintains a GlobalValRefMap object that is used to hold all
+/// constant references to global variables in the module. When a global
+/// variable is destroyed, it should have no entries in the GlobalValueRefMap.
+/// @brief The main container class for the LLVM Intermediate Representation.
class Module {
+/// @name Types And Enumerations
+/// @{
public:
+ /// The type for the list of global variables.
typedef iplist<GlobalVariable> GlobalListType;
+ /// The type for the list of functions.
typedef iplist<Function> FunctionListType;
- typedef SetVector<std::string> LibraryListType;
+ /// The type for the list of aliases.
+ typedef iplist<GlobalAlias> AliasListType;
+
+ /// The type for the list of dependent libraries.
+ typedef std::vector<std::string> LibraryListType;
- // Global Variable iterators...
- typedef GlobalListType::iterator giterator;
- typedef GlobalListType::const_iterator const_giterator;
- typedef std::reverse_iterator<giterator> reverse_giterator;
- typedef std::reverse_iterator<const_giterator> const_reverse_giterator;
+ /// The Global Variable iterator.
+ typedef GlobalListType::iterator global_iterator;
+ /// The Global Variable constant iterator.
+ typedef GlobalListType::const_iterator const_global_iterator;
- // Function iterators...
+ /// The Function iterators.
typedef FunctionListType::iterator iterator;
+ /// The Function constant iterator
typedef FunctionListType::const_iterator const_iterator;
- typedef std::reverse_iterator<iterator> reverse_iterator;
- typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
- // Library list iterators
+ /// 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;
+ /// An enumeration for describing the endianess of the target machine.
enum Endianness { AnyEndianness, LittleEndian, BigEndian };
+
+ /// An enumeration for describing the size of a pointer on the target machine.
enum PointerSize { AnyPointerSize, Pointer32, Pointer64 };
+/// @}
+/// @name Member Variables
+/// @{
private:
- GlobalListType GlobalList; // The Global Variables in the module
- FunctionListType FunctionList; // The Functions in the module
- LibraryListType LibraryList; // The Libraries needed by the module
- SymbolTable *SymTab; // Symbol Table for the module
- std::string ModuleID; // Human readable identifier for the module
- std::string TargetTriple; // Platform target triple Module compiled on
-
- // These flags are probably not the right long-term way to handle this kind of
- // target information, but it is sufficient for now.
- Endianness Endian; // True if target is little endian
- PointerSize PtrSize; // True if target has 32-bit pointers (false = 64-bit)
+ LLVMContext* Context; ///< The LLVMContext from which types and
+ ///< constants are allocated.
+ 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
+ TypeSymbolTable *TypeSymTab; ///< Symbol table for types
+ std::string ModuleID; ///< Human readable identifier for the module
+ std::string TargetTriple; ///< Platform target triple Module compiled on
+ std::string DataLayout; ///< Target data description
friend class Constant;
+/// @}
+/// @name Constructors
+/// @{
public:
- Module(const std::string &ModuleID);
+ /// The Module constructor. Note that there is no default constructor. You
+ /// must provide a name for the module upon construction.
+ explicit Module(const std::string &ModuleID, LLVMContext* C);
+ /// The module destructor. This will dropAllReferences.
~Module();
- const std::string& getModuleIdentifier() const { return ModuleID; }
- const std::string& getTargetTriple() const { return TargetTriple; }
- void setTargetTriple(const std::string& T) { TargetTriple = T; }
+/// @}
+/// @name Module Level Accessors
+/// @{
+public:
+ /// Get the module identifier which is, essentially, the name of the module.
+ /// @returns the module identifier as a string
+ const std::string &getModuleIdentifier() const { return ModuleID; }
+
+ /// Get the data layout string for the module's target platform. This encodes
+ /// the type sizes and alignments expected by this module.
+ /// @returns the data layout as a string
+ const std::string& getDataLayout() const { return DataLayout; }
+
+ /// Get the target triple which is a string describing the target host.
+ /// @returns a string containing the target triple.
+ const std::string &getTargetTriple() const { return TargetTriple; }
+
+ /// Get the target endian information.
+ /// @returns Endianess - an enumeration for the endianess of the target
+ Endianness getEndianness() const;
+
+ /// Get the target pointer size.
+ /// @returns PointerSize - an enumeration for the size of the target's pointer
+ PointerSize getPointerSize() const;
+
+ /// Get the global data context.
+ /// @returns LLVMContext - a container for LLVM's global information
+ LLVMContext* getContext() const { return Context; }
+
+ /// Get any module-scope inline assembly blocks.
+ /// @returns a string containing the module-scope inline assembly blocks.
+ const std::string &getModuleInlineAsm() const { return GlobalScopeAsm; }
+/// @}
+/// @name Module Level Mutators
+/// @{
+public:
- /// Target endian information...
- Endianness getEndianness() const { return Endian; }
- void setEndianness(Endianness E) { Endian = E; }
+ /// Set the module identifier.
+ void setModuleIdentifier(const std::string &ID) { ModuleID = ID; }
- /// Target Pointer Size information...
- PointerSize getPointerSize() const { return PtrSize; }
- void setPointerSize(PointerSize PS) { PtrSize = PS; }
+ /// Set the data layout
+ void setDataLayout(const std::string& DL) { DataLayout = DL; }
- //===--------------------------------------------------------------------===//
- // Methods for easy access to the functions in the module.
- //
+ /// Set the target triple.
+ void setTargetTriple(const std::string &T) { TargetTriple = T; }
+ /// 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 Generic Value Accessors
+/// @{
+
+ /// getNamedValue - Return the first global value in the module with
+ /// the specified name, of arbitrary type. This method returns null
+ /// if a global with the specified name is not found.
+ GlobalValue *getNamedValue(const std::string &Name) const;
+ GlobalValue *getNamedValue(const char *Name) const;
+
+/// @}
+/// @name Function Accessors
+/// @{
+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.
- Function *getOrInsertFunction(const std::string &Name, const FunctionType *T);
+ /// table. Four possibilities:
+ /// 1. If it does not exist, add a prototype for the function and return it.
+ /// 2. If it exists, and has a local linkage, the existing function is
+ /// renamed and a new one is inserted.
+ /// 3. Otherwise, if the existing function has the correct prototype, return
+ /// the existing function.
+ /// 4. Finally, the function exists but has the wrong prototype: return the
+ /// function with a constantexpr cast to the right prototype.
+ Constant *getOrInsertFunction(const std::string &Name, const FunctionType *T,
+ AttrListPtr AttributeList);
+
+ Constant *getOrInsertFunction(const std::string &Name, const FunctionType *T);
/// 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 version of the method takes a null terminated list of function
- /// arguments, which makes it easier for clients to use.
- Function *getOrInsertFunction(const std::string &Name, const Type *RetTy,...);
-
+ /// 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.
+ Constant *getOrInsertFunction(const std::string &Name,
+ AttrListPtr AttributeList,
+ const Type *RetTy, ...) END_WITH_NULL;
+
+ Constant *getOrInsertFunction(const std::string &Name, const Type *RetTy, ...)
+ END_WITH_NULL;
+
+ Constant *getOrInsertTargetIntrinsic(const std::string &Name,
+ const FunctionType *Ty,
+ AttrListPtr AttributeList);
+
/// getFunction - Look up the specified function in the module symbol table.
/// If it does not exist, return null.
- ///
- Function *getFunction(const std::string &Name, const FunctionType *Ty);
-
- /// getMainFunction - This function looks up main efficiently. This is such a
- /// common case, that it is a method in Module. If main cannot be found, a
- /// null pointer is returned.
- ///
- Function *getMainFunction();
-
- /// getNamedFunction - Return the first function in the module with the
- /// specified name, of arbitrary type. This method returns null if a function
- /// with the specified name is not found.
- ///
- Function *getNamedFunction(const std::string &Name);
-
- //===--------------------------------------------------------------------===//
- // Methods for easy access to the global variables in the module.
- //
+ Function *getFunction(const std::string &Name) const;
+ Function *getFunction(const char *Name) const;
+/// @}
+/// @name Global Variable Accessors
+/// @{
+public:
/// getGlobalVariable - Look up the specified global variable in the module
- /// symbol table. If it does not exist, return null. Note that this only
- /// returns a global variable if it does not have internal linkage. 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.
- ///
- GlobalVariable *getGlobalVariable(const std::string &Name, const Type *Ty);
-
-
- //===--------------------------------------------------------------------===//
- // Methods for easy access to the types in the module.
- //
+ /// 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
+ /// specified name, of arbitrary type. This method returns null if a global
+ /// with the specified name is not found.
+ GlobalVariable *getNamedGlobal(const std::string &Name) const {
+ return getGlobalVariable(Name, true);
+ }
+
+ /// getOrInsertGlobal - Look up the specified global in the module symbol
+ /// table.
+ /// 1. If it does not exist, add a declaration of the global and return it.
+ /// 2. Else, the global exists but has the wrong type: return the function
+ /// with a constantexpr cast to the right type.
+ /// 3. Finally, if the existing global is the correct delclaration, return
+ /// the existing global.
+ Constant *getOrInsertGlobal(const std::string &Name, const Type *Ty);
+
+/// @}
+/// @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
+/// @{
+public:
/// addTypeName - Insert an entry in the symbol table mapping Str to Type. If
/// there is already an entry for this name, true is returned and the symbol
/// table is not modified.
- ///
bool addTypeName(const std::string &Name, const Type *Ty);
/// getTypeName - If there is at least one entry in the symbol table for the
/// specified type, return it.
- ///
std::string getTypeName(const Type *Ty) const;
/// getTypeByName - Return the type with the specified name in this module, or
/// null if there is none by that name.
const Type *getTypeByName(const std::string &Name) const;
-
- //===--------------------------------------------------------------------===//
- // Methods for direct access to the globals list, functions list, and symbol
- // table.
- //
-
- /// Get the underlying elements of the Module...
- inline const GlobalListType &getGlobalList() const { return GlobalList; }
- inline GlobalListType &getGlobalList() { return GlobalList; }
- inline const FunctionListType &getFunctionList() const { return FunctionList;}
- inline FunctionListType &getFunctionList() { return FunctionList;}
-
- /// getSymbolTable() - Get access to the symbol table for the module, where
- /// global variables and functions are identified.
- ///
- inline SymbolTable &getSymbolTable() { return *SymTab; }
- inline const SymbolTable &getSymbolTable() const { return *SymTab; }
-
-
- //===--------------------------------------------------------------------===//
- // Module iterator forwarding functions
- //
- // Globals list interface
- inline giterator gbegin() { return GlobalList.begin(); }
- inline const_giterator gbegin() const { return GlobalList.begin(); }
- inline giterator gend () { return GlobalList.end(); }
- inline const_giterator gend () const { return GlobalList.end(); }
-
- inline reverse_giterator grbegin() { return GlobalList.rbegin(); }
- inline const_reverse_giterator grbegin() const { return GlobalList.rbegin(); }
- inline reverse_giterator grend () { return GlobalList.rend(); }
- inline const_reverse_giterator grend () const { return GlobalList.rend(); }
-
- inline size_t gsize() const { return GlobalList.size(); }
- inline bool gempty() const { return GlobalList.empty(); }
- inline const GlobalVariable &gfront() const { return GlobalList.front(); }
- inline GlobalVariable &gfront() { return GlobalList.front(); }
- inline const GlobalVariable &gback() const { return GlobalList.back(); }
- inline GlobalVariable &gback() { return GlobalList.back(); }
-
- // FunctionList interface
- inline iterator begin() { return FunctionList.begin(); }
- inline const_iterator begin() const { return FunctionList.begin(); }
- inline iterator end () { return FunctionList.end(); }
- inline const_iterator end () const { return FunctionList.end(); }
-
- inline reverse_iterator rbegin() { return FunctionList.rbegin(); }
- inline const_reverse_iterator rbegin() const { return FunctionList.rbegin(); }
- inline reverse_iterator rend () { return FunctionList.rend(); }
- inline const_reverse_iterator rend () const { return FunctionList.rend(); }
-
- inline size_t size() const { return FunctionList.size(); }
- inline bool empty() const { return FunctionList.empty(); }
- inline const Function &front() const { return FunctionList.front(); }
- inline Function &front() { return FunctionList.front(); }
- inline const Function &back() const { return FunctionList.back(); }
- inline Function &back() { return FunctionList.back(); }
-
- //===--------------------------------------------------------------------===//
- // List of dependent library access functions
-
+/// @}
+/// @name Direct access to the globals list, functions list, and symbol table
+/// @{
+public:
+ /// Get the Module's list of global variables (constant).
+ const GlobalListType &getGlobalList() const { return GlobalList; }
+ /// Get the Module's list of global variables.
+ GlobalListType &getGlobalList() { return GlobalList; }
+ static iplist<GlobalVariable> Module::*getSublistAccess(GlobalVariable*) {
+ return &Module::GlobalList;
+ }
+ /// Get the Module's list of functions (constant).
+ const FunctionListType &getFunctionList() const { return FunctionList; }
+ /// Get the Module's list of functions.
+ FunctionListType &getFunctionList() { return FunctionList; }
+ static iplist<Function> Module::*getSublistAccess(Function*) {
+ return &Module::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; }
+ static iplist<GlobalAlias> Module::*getSublistAccess(GlobalAlias*) {
+ return &Module::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; }
+ /// Get the Module's symbol table of types
+ TypeSymbolTable &getTypeSymbolTable() { return *TypeSymTab; }
+
+/// @}
+/// @name Global Variable Iteration
+/// @{
+public:
+ /// Get an iterator to the first global variable
+ global_iterator global_begin() { return GlobalList.begin(); }
+ /// Get a constant iterator to the first global variable
+ const_global_iterator global_begin() const { return GlobalList.begin(); }
+ /// Get an iterator to the last global variable
+ global_iterator global_end () { return GlobalList.end(); }
+ /// Get a constant iterator to the last global variable
+ const_global_iterator global_end () const { return GlobalList.end(); }
+ /// Determine if the list of globals is empty.
+ bool global_empty() const { return GlobalList.empty(); }
+
+/// @}
+/// @name Function Iteration
+/// @{
+public:
+ /// Get an iterator to the first function.
+ iterator begin() { return FunctionList.begin(); }
+ /// Get a constant iterator to the first function.
+ const_iterator begin() const { return FunctionList.begin(); }
+ /// Get an iterator to the last function.
+ iterator end () { return FunctionList.end(); }
+ /// 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(); }
+ /// Determine if the list of functions is empty.
+ bool empty() const { return FunctionList.empty(); }
+
+/// @}
+/// @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
- inline void addLibrary(const std::string& Lib){ LibraryList.insert(Lib); }
-
+ void addLibrary(const std::string& Lib);
/// @brief Remove a library from the list of dependent libraries
- inline void removeLibrary(const std::string& Lib) { LibraryList.remove(Lib); }
-
- /// @brief Get all the libraries
+ void removeLibrary(const std::string& Lib);
+ /// @brief Get all the libraries
inline const LibraryListType& getLibraries() const { return LibraryList; }
- //===--------------------------------------------------------------------===//
- // Utility functions for printing and dumping Module objects
-
- void print(std::ostream &OS) const { print(OS, 0); }
+/// @}
+/// @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
+/// @{
+public:
+ /// Print the module to an output stream with AssemblyAnnotationWriter.
+ void print(raw_ostream &OS, AssemblyAnnotationWriter *AAW) const;
void print(std::ostream &OS, AssemblyAnnotationWriter *AAW) const;
-
+
+ /// Dump the module to stderr (for debugging).
void dump() const;
-
- /// dropAllReferences() - 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 has "dropped all references", except operator
- /// delete.
- ///
+ /// 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 has "dropped all references", except operator delete.
void dropAllReferences();
+/// @}
};
-inline std::ostream &operator<<(std::ostream &O, const Module *M) {
- M->print(O);
+/// An iostream inserter for modules.
+inline std::ostream &operator<<(std::ostream &O, const Module &M) {
+ M.print(O, 0);
return O;
}
-
-inline std::ostream &operator<<(std::ostream &O, const Module &M) {
- M.print(O);
+inline raw_ostream &operator<<(raw_ostream &O, const Module &M) {
+ M.print(O, 0);
return O;
}
projects / oota-llvm.git / blobdiff