//
// 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.
//
//===----------------------------------------------------------------------===//
};
/// 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.
///
private:
GlobalListType GlobalList; ///< The Global Variables in the module
FunctionListType FunctionList; ///< The Functions in the module
- AliasListType AliasList; ///< The Aliases 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
/// 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
/// @{
/// 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;
+ Function *getFunction(const char *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
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 Variable Accessors
+/// @name Global Alias Accessors
/// @{
public:
- /// getNamedGlobal - Return the first global alias in the module with the
+ /// 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
/// @{
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.
/// @name Utility functions for printing and dumping Module objects
/// @{
public:
- /// Print the module to an output stream
- void print(std::ostream &OS) const { print(OS, 0); }
- void print(std::ostream *OS) const { if (OS) print(*OS); }
/// 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;
- void print(std::ostream *OS, AssemblyAnnotationWriter *AAW) const {
- if (OS) print(*OS, AAW);
- }
- /// Dump the module to std::cerr (for debugging).
+
+ /// Dump the module to stderr (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();
/// @}
/// An iostream inserter for modules.
inline std::ostream &operator<<(std::ostream &O, const Module &M) {
- M.print(O);
+ M.print(O, 0);
return O;
}
+inline raw_ostream &operator<<(raw_ostream &O, const Module &M) {
+ M.print(O, 0);
+ return O;
+}
+
inline ValueSymbolTable *
ilist_traits<Function>::getSymTab(Module *M) {
return M ? &M->getValueSymbolTable() : 0;
}
-inline int
+inline int
ilist_traits<Function>::getListOffset() {
return Module::getFunctionListOffset();
}
-inline int
+inline int
ilist_traits<GlobalVariable>::getListOffset() {
return Module::getGlobalVariableListOffset();
}
-inline int
+inline int
ilist_traits<GlobalAlias>::getListOffset() {
return Module::getAliasListOffset();
}
projects / oota-llvm.git / blobdiff