-//===-- llvm/Module.h - C++ class to represent a VM module -------*- C++ -*--=//
+//===-- llvm/Module.h - C++ class to represent a VM module ------*- C++ -*-===//
//
-// This file contains the declarations for the Module class that is used to
+// 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
// 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.
+//
//===----------------------------------------------------------------------===//
#ifndef LLVM_MODULE_H
#define LLVM_MODULE_H
-#include "llvm/Value.h"
-#include "llvm/SymTabValue.h"
-class Method;
+#include "llvm/Function.h"
+#include "llvm/GlobalVariable.h"
+#include "llvm/ADT/SetVector.h"
+#include "llvm/Support/DataTypes.h"
+
+namespace llvm {
-class Module : public Value, public SymTabValue {
+class GlobalVariable;
+class GlobalValueRefMap; // Used by ConstantVals.cpp
+class FunctionType;
+class SymbolTable;
+
+template<> struct ilist_traits<Function>
+ : public SymbolTableListTraits<Function, Module, Module> {
+ // createSentinel is used to create a node that marks the end of the list.
+ static Function *createSentinel();
+ static void destroySentinel(Function *F) { delete F; }
+ static iplist<Function> &getList(Module *M);
+};
+template<> struct ilist_traits<GlobalVariable>
+ : public SymbolTableListTraits<GlobalVariable, Module, 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; }
+ static iplist<GlobalVariable> &getList(Module *M);
+};
+
+class Module {
public:
- typedef ValueHolder<Method, Module, Module> MethodListType;
+ typedef iplist<GlobalVariable> GlobalListType;
+ typedef iplist<Function> FunctionListType;
+ typedef SetVector<std::string> LibraryListType;
+
+ // Global Variable iterators.
+ typedef GlobalListType::iterator global_iterator;
+ typedef GlobalListType::const_iterator const_global_iterator;
+
+ // Function iterators.
+ typedef FunctionListType::iterator iterator;
+ typedef FunctionListType::const_iterator const_iterator;
+
+ // Library list iterators.
+ typedef LibraryListType::const_iterator lib_iterator;
+
+ enum Endianness { AnyEndianness, LittleEndian, BigEndian };
+ enum PointerSize { AnyPointerSize, Pointer32, Pointer64 };
- // Method iterators...
- typedef MethodListType::iterator iterator;
- typedef MethodListType::const_iterator const_iterator;
- typedef reverse_iterator<const_iterator> const_reverse_iterator;
- typedef reverse_iterator<iterator> reverse_iterator;
private:
- MethodListType MethodList; // The Methods
+ 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
+ Endianness Endian; // Endianness assumed in the module
+ PointerSize PtrSize; // Pointer size assumed in the module
+
+ friend class Constant;
public:
- Module();
+ Module(const std::string &ModuleID);
~Module();
- // reduceApply - Apply the specified function to all of the methods in this
- // module. The result values are or'd together and the result is returned.
+ 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; }
+ void setEndianness(Endianness E) { Endian = E; }
+
+ /// Target Pointer Size information...
+ PointerSize getPointerSize() const { return PtrSize; }
+ void setPointerSize(PointerSize PS) { PtrSize = PS; }
+
+ // Access to any module-scope inline asm blocks.
+ const std::string &getInlineAsm() const { return GlobalScopeAsm; }
+ void setInlineAsm(const std::string &Asm) { GlobalScopeAsm = Asm; }
+
+ //===--------------------------------------------------------------------===//
+ // Methods for easy access to the functions in the module.
//
- bool reduceApply(bool (*Func)(Method*));
- bool reduceApply(bool (*Func)(const Method*)) const;
+ /// 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);
+
+ /// 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,...)
+ END_WITH_NULL;
+
+ /// 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();
- // Get the underlying elements of the Module...
- inline const MethodListType &getMethodList() const { return MethodList; }
- inline MethodListType &getMethodList() { return MethodList; }
+ /// 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);
//===--------------------------------------------------------------------===//
- // Module iterator forwarding functions
+ // Methods for easy access to the global variables in the module.
//
- inline iterator begin() { return MethodList.begin(); }
- inline const_iterator begin() const { return MethodList.begin(); }
- inline iterator end () { return MethodList.end(); }
- inline const_iterator end () const { return MethodList.end(); }
-
- inline reverse_iterator rbegin() { return MethodList.rbegin(); }
- inline const_reverse_iterator rbegin() const { return MethodList.rbegin(); }
- inline reverse_iterator rend () { return MethodList.rend(); }
- inline const_reverse_iterator rend () const { return MethodList.rend(); }
-
- inline unsigned size() const { return MethodList.size(); }
- inline bool empty() const { return MethodList.empty(); }
- inline const Method *front() const { return MethodList.front(); }
- inline Method *front() { return MethodList.front(); }
- inline const Method *back() const { return MethodList.back(); }
- inline Method *back() { return MethodList.back(); }
-
-
- // 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.
+
+ /// 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, const Type *Ty,
+ bool AllowInternal = false);
+
+
+ //===--------------------------------------------------------------------===//
+ // Methods for easy access to the types in the module.
//
+
+ /// 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
+ 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 size_t size() const { return FunctionList.size(); }
+ inline bool empty() const { return FunctionList.empty(); }
+
+ //===--------------------------------------------------------------------===//
+ // List of dependent library access functions
+
+ /// @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(); }
+
+ /// @brief Returns the number of items in the list of libraries.
+ 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); }
+
+ /// @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
+ inline const LibraryListType& getLibraries() const { return LibraryList; }
+
+ //===--------------------------------------------------------------------===//
+ // Utility functions for printing and dumping Module objects
+
+ void print(std::ostream &OS) const { print(OS, 0); }
+ void print(std::ostream &OS, AssemblyAnnotationWriter *AAW) const;
+
+ 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.
+ ///
void dropAllReferences();
};
+inline std::ostream &operator<<(std::ostream &O, const Module &M) {
+ M.print(O);
+ return O;
+}
+
+} // End llvm namespace
+
#endif
projects / oota-llvm.git / blobdiff