//===-- 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 contains the declarations for the Module class that is used to
+// 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
#include "llvm/Function.h"
#include "llvm/GlobalVariable.h"
#include "llvm/ADT/SetVector.h"
+#include "llvm/Support/DataTypes.h"
namespace llvm {
typedef iplist<Function> FunctionListType;
typedef SetVector<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;
+ // Global Variable iterators.
+ typedef GlobalListType::iterator global_iterator;
+ typedef GlobalListType::const_iterator const_global_iterator;
- // Function iterators...
+ // Function iterators.
typedef FunctionListType::iterator 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
+ // Library list iterators.
typedef LibraryListType::const_iterator lib_iterator;
enum Endianness { AnyEndianness, LittleEndian, BigEndian };
GlobalListType GlobalList; // The Global Variables in the module
FunctionListType FunctionList; // The Functions in the module
LibraryListType LibraryList; // The Libraries needed by the module
+ std::string GlobalScopeAsm; // Inline Asm at global scope.
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)
+ Endianness Endian; // Endianness assumed in the module
+ PointerSize PtrSize; // Pointer size assumed in the module
friend class Constant;
Module(const std::string &ModuleID);
~Module();
- const std::string& getModuleIdentifier() const { return ModuleID; }
- const std::string& getTargetTriple() const { return TargetTriple; }
- void setTargetTriple(const std::string& T) { TargetTriple = T; }
+ const std::string &getModuleIdentifier() const { return ModuleID; }
+ void setModuleIdentifier(const std::string &ID) { ModuleID = ID; }
+
+ const std::string &getTargetTriple() const { return TargetTriple; }
+ void setTargetTriple(const std::string &T) { TargetTriple = T; }
/// Target endian information...
Endianness getEndianness() const { return Endian; }
PointerSize getPointerSize() const { return PtrSize; }
void setPointerSize(PointerSize PS) { PtrSize = PS; }
+ // Access to any module-scope inline asm blocks.
+ const std::string &getModuleInlineAsm() const { return GlobalScopeAsm; }
+ void setModuleInlineAsm(const std::string &Asm) { GlobalScopeAsm = Asm; }
+
//===--------------------------------------------------------------------===//
// Methods for easy access to the functions in the module.
//
/// 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,...);
+ Function *getOrInsertFunction(const std::string &Name, const Type *RetTy,...)
+ END_WITH_NULL;
/// getFunction - Look up the specified function in the module symbol table.
/// If it does not exist, return null.
//
/// 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.
+ /// 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, const Type *Ty);
+ GlobalVariable *getGlobalVariable(const std::string &Name, const Type *Ty,
+ bool AllowInternal = false);
+ /// 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);
+
//===--------------------------------------------------------------------===//
// Methods for easy access to the types in the module.
// 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;}
+ // Get the underlying elements of the Module.
+ const GlobalListType &getGlobalList() const { return GlobalList; }
+ GlobalListType &getGlobalList() { return GlobalList; }
+ const FunctionListType &getFunctionList() const { return FunctionList; }
+ 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; }
+ SymbolTable &getSymbolTable() { return *SymTab; }
+ 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(); }
+ global_iterator global_begin() { return GlobalList.begin(); }
+ const_global_iterator global_begin() const { return GlobalList.begin(); }
+ global_iterator global_end () { return GlobalList.end(); }
+ const_global_iterator global_end () const { return GlobalList.end(); }
+ bool global_empty() const { return GlobalList.empty(); }
// 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(); }
+ iterator begin() { return FunctionList.begin(); }
+ const_iterator begin() const { return FunctionList.begin(); }
+ iterator end () { return FunctionList.end(); }
+ const_iterator end () const { return FunctionList.end(); }
+
+ size_t size() const { return FunctionList.size(); }
+ bool empty() const { return FunctionList.empty(); }
//===--------------------------------------------------------------------===//
// List of dependent library access functions
/// @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
+ /// @brief Get all the libraries
inline const LibraryListType& getLibraries() const { return LibraryList; }
//===--------------------------------------------------------------------===//
/// '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
+ /// 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);
- return O;
-}
-
inline std::ostream &operator<<(std::ostream &O, const Module &M) {
M.print(O);
return O;
projects / oota-llvm.git / blobdiff