-//===-- llvm/Module.h - C++ class to represent a VM module -------*- C++ -*--=//
+//===-- 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
// maintain all the information related to a VM module.
#include "llvm/Function.h"
#include "llvm/GlobalVariable.h"
+
+namespace llvm {
+
class GlobalVariable;
class GlobalValueRefMap; // Used by ConstantVals.cpp
class ConstantPointerRef;
static iplist<GlobalVariable> &getList(Module *M);
};
-class Module : public Annotable {
-public:
+struct Module : public Annotable {
typedef iplist<GlobalVariable> GlobalListType;
typedef iplist<Function> FunctionListType;
typedef std::reverse_iterator<const_giterator> const_reverse_giterator;
// Function iterators...
- typedef FunctionListType::iterator iterator;
- typedef FunctionListType::const_iterator const_iterator;
+ 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;
-private:
- GlobalListType GlobalList; // The Global Variables
- FunctionListType FunctionList; // The Functions
+ enum Endianness { AnyEndianness, LittleEndian, BigEndian };
+ enum PointerSize { AnyPointerSize, Pointer32, Pointer64 };
- GlobalValueRefMap *GVRefMap;
-
- SymbolTable *SymTab;
-
- // Accessor for the underlying GlobalValRefMap... only through the
- // ConstantPointerRef class...
+private:
+ GlobalListType GlobalList; // The Global Variables in the module
+ FunctionListType FunctionList; // The Functions in the module
+ GlobalValueRefMap *GVRefMap; // Keep track of GlobalValueRef's
+ SymbolTable *SymTab; // Symbol Table for the module
+ std::string ModuleID; // Human readable identifier for the module
+
+ // 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)
+
+ // Accessor for the underlying GVRefMap... only through the Constant class...
+ friend class Constant;
friend class ConstantPointerRef;
void mutateConstantPointerRef(GlobalValue *OldGV, GlobalValue *NewGV);
ConstantPointerRef *getConstantPointerRef(GlobalValue *GV);
+ void destroyConstantPointerRef(ConstantPointerRef *CPR);
public:
- Module();
+ Module(const std::string &ModuleID);
~Module();
- // 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);
+ const std::string &getModuleIdentifier() const { return ModuleID; }
+
+ /// Target endian information...
+ Endianness getEndianness() const { return Endian; }
+ void setEndianness(Endianness E) { Endian = E; }
- // getFunction - Look up the specified function in the module symbol table.
- // If it does not exist, return null.
+ /// Target Pointer Size information...
+ PointerSize getPointerSize() const { return PtrSize; }
+ void setPointerSize(PointerSize PS) { PtrSize = PS; }
+
+ //===--------------------------------------------------------------------===//
+ // Methods for easy access to the functions in the module.
//
+
+ /// 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,...);
+
+ /// 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);
- // 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);
+ /// 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);
- // getTypeName - If there is at least one entry in the symbol table for the
- // specified type, return it.
+ //===--------------------------------------------------------------------===//
+ // Methods for easy access to the global variables in the module.
//
- std::string getTypeName(const Type *Ty);
- // 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;}
+ /// 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, ie, it should not
+ /// have the top-level PointerType, which represents the address of the
+ /// global.
+ ///
+ GlobalVariable *getGlobalVariable(const std::string &Name, const Type *Ty);
//===--------------------------------------------------------------------===//
- // Symbol table support functions...
-
- // hasSymbolTable() - Returns true if there is a symbol table allocated to
- // this object AND if there is at least one name in it!
+ // Methods for easy access to the types in the module.
//
- bool hasSymbolTable() const;
- // CAUTION: The current symbol table may be null if there are no names (ie,
- // the symbol table is empty)
- //
- inline SymbolTable *getSymbolTable() { return SymTab; }
- inline const SymbolTable *getSymbolTable() const { return SymTab; }
+ /// 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;
- // getSymbolTableSure is guaranteed to not return a null pointer, because if
- // the method does not already have a symtab, one is created. Use this if
- // you intend to put something into the symbol table for the method.
+ /// 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.
//
- SymbolTable *getSymbolTableSure();
+
+ /// 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; }
//===--------------------------------------------------------------------===//
inline const Function &back() const { return FunctionList.back(); }
inline Function &back() { return FunctionList.back(); }
- void print(std::ostream &OS) const;
+ void print(std::ostream &OS) const { print(OS, 0); }
+ void print(std::ostream &OS, AssemblyAnnotationWriter *AAW) 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 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();
};
return O;
}
+inline std::ostream &operator<<(std::ostream &O, const Module &M) {
+ M.print(O);
+ return O;
+}
+
+} // End llvm namespace
+
#endif
projects / oota-llvm.git / blobdiff