clang 18.0.0git
|
Manages the set of modules loaded by an AST reader. More...
#include "clang/Serialization/ModuleManager.h"
Public Types | |
enum | AddModuleResult { AlreadyLoaded , NewlyLoaded , Missing , OutOfDate } |
The result of attempting to add a new module. More... | |
using | ModuleIterator = llvm::pointee_iterator< SmallVectorImpl< std::unique_ptr< ModuleFile > >::iterator > |
using | ModuleConstIterator = llvm::pointee_iterator< SmallVectorImpl< std::unique_ptr< ModuleFile > >::const_iterator > |
using | ModuleReverseIterator = llvm::pointee_iterator< SmallVectorImpl< std::unique_ptr< ModuleFile > >::reverse_iterator > |
using | ModuleOffset = std::pair< uint32_t, StringRef > |
using | ASTFileSignatureReader = ASTFileSignature(*)(StringRef) |
Public Member Functions | |
ModuleManager (FileManager &FileMgr, InMemoryModuleCache &ModuleCache, const PCHContainerReader &PCHContainerRdr, const HeaderSearch &HeaderSearchInfo) | |
ModuleIterator | begin () |
Forward iterator to traverse all loaded modules. | |
ModuleIterator | end () |
Forward iterator end-point to traverse all loaded modules. | |
ModuleConstIterator | begin () const |
Const forward iterator to traverse all loaded modules. | |
ModuleConstIterator | end () const |
Const forward iterator end-point to traverse all loaded modules. | |
ModuleReverseIterator | rbegin () |
Reverse iterator to traverse all loaded modules. | |
ModuleReverseIterator | rend () |
Reverse iterator end-point to traverse all loaded modules. | |
llvm::iterator_range< SmallVectorImpl< ModuleFile * >::const_iterator > | pch_modules () const |
A range covering the PCH and preamble module files loaded. | |
ModuleFile & | getPrimaryModule () |
Returns the primary module associated with the manager, that is, the first module loaded. | |
ModuleFile & | getPrimaryModule () const |
Returns the primary module associated with the manager, that is, the first module loaded. | |
ModuleFile & | operator[] (unsigned Index) const |
Returns the module associated with the given index. | |
ModuleFile * | lookupByFileName (StringRef FileName) const |
Returns the module associated with the given file name. | |
ModuleFile * | lookupByModuleName (StringRef ModName) const |
Returns the module associated with the given module name. | |
ModuleFile * | lookup (const FileEntry *File) const |
Returns the module associated with the given module file. | |
std::unique_ptr< llvm::MemoryBuffer > | lookupBuffer (StringRef Name) |
Returns the in-memory (virtual file) buffer with the given name. | |
unsigned | size () const |
Number of modules loaded. | |
AddModuleResult | addModule (StringRef FileName, ModuleKind Type, SourceLocation ImportLoc, ModuleFile *ImportedBy, unsigned Generation, off_t ExpectedSize, time_t ExpectedModTime, ASTFileSignature ExpectedSignature, ASTFileSignatureReader ReadSignature, ModuleFile *&Module, std::string &ErrorStr) |
Attempts to create a new module and add it to the list of known modules. | |
void | removeModules (ModuleIterator First) |
Remove the modules starting from First (to the end). | |
void | addInMemoryBuffer (StringRef FileName, std::unique_ptr< llvm::MemoryBuffer > Buffer) |
Add an in-memory buffer the list of known buffers. | |
void | setGlobalIndex (GlobalModuleIndex *Index) |
Set the global module index. | |
void | moduleFileAccepted (ModuleFile *MF) |
Notification from the AST reader that the given module file has been "accepted", and will not (can not) be unloaded. | |
void | visit (llvm::function_ref< bool(ModuleFile &M)> Visitor, llvm::SmallPtrSetImpl< ModuleFile * > *ModuleFilesHit=nullptr) |
Visit each of the modules. | |
bool | lookupModuleFile (StringRef FileName, off_t ExpectedSize, time_t ExpectedModTime, OptionalFileEntryRef &File) |
Attempt to resolve the given module file name to a file entry. | |
void | viewGraph () |
View the graphviz representation of the module graph. | |
InMemoryModuleCache & | getModuleCache () const |
Manages the set of modules loaded by an AST reader.
Definition at line 47 of file ModuleManager.h.
using clang::serialization::ModuleManager::ASTFileSignatureReader = ASTFileSignature (*)(StringRef) |
Definition at line 206 of file ModuleManager.h.
using clang::serialization::ModuleManager::ModuleConstIterator = llvm::pointee_iterator< SmallVectorImpl<std::unique_ptr<ModuleFile> >::const_iterator> |
Definition at line 131 of file ModuleManager.h.
using clang::serialization::ModuleManager::ModuleIterator = llvm::pointee_iterator< SmallVectorImpl<std::unique_ptr<ModuleFile> >::iterator> |
Definition at line 129 of file ModuleManager.h.
using clang::serialization::ModuleManager::ModuleOffset = std::pair<uint32_t, StringRef> |
Definition at line 135 of file ModuleManager.h.
using clang::serialization::ModuleManager::ModuleReverseIterator = llvm::pointee_iterator< SmallVectorImpl<std::unique_ptr<ModuleFile> >::reverse_iterator> |
Definition at line 133 of file ModuleManager.h.
The result of attempting to add a new module.
Definition at line 192 of file ModuleManager.h.
|
explicit |
Definition at line 333 of file ModuleManager.cpp.
void ModuleManager::addInMemoryBuffer | ( | StringRef | FileName, |
std::unique_ptr< llvm::MemoryBuffer > | Buffer | ||
) |
Add an in-memory buffer the list of known buffers.
Definition at line 287 of file ModuleManager.cpp.
References clang::FileName, and clang::FileManager::getVirtualFile().
Referenced by clang::ASTReader::addInMemoryBuffer().
ModuleManager::AddModuleResult ModuleManager::addModule | ( | StringRef | FileName, |
ModuleKind | Type, | ||
SourceLocation | ImportLoc, | ||
ModuleFile * | ImportedBy, | ||
unsigned | Generation, | ||
off_t | ExpectedSize, | ||
time_t | ExpectedModTime, | ||
ASTFileSignature | ExpectedSignature, | ||
ASTFileSignatureReader | ReadSignature, | ||
ModuleFile *& | Module, | ||
std::string & | ErrorStr | ||
) |
Attempts to create a new module and add it to the list of known modules.
FileName | The file name of the module to be loaded. |
Type | The kind of module being loaded. |
ImportLoc | The location at which the module is imported. |
ImportedBy | The module that is importing this module, or NULL if this module is imported directly by the user. |
Generation | The generation in which this module was loaded. |
ExpectedSize | The expected size of the module file, used for validation. This will be zero if unknown. |
ExpectedModTime | The expected modification time of the module file, used for validation. This will be zero if unknown. |
ExpectedSignature | The expected signature of the module file, used for validation. This will be zero if unknown. |
ReadSignature | Reads the signature from an AST file without actually loading it. |
Module | A pointer to the module file if the module was successfully loaded. |
ErrorStr | Will be set to a non-empty string if any errors occurred while trying to load the module. |
Definition at line 99 of file ModuleManager.cpp.
References clang::InMemoryModuleCache::addPCM(), AlreadyLoaded, checkSignature(), clang::PCHContainerReader::ExtractPCH(), clang::FileName, clang::FileManager::getBufferForFile(), getModuleCache(), clang::FileManager::getNoncachedStatValue(), lookupBuffer(), lookupModuleFile(), Missing, clang::serialization::MK_ExplicitModule, clang::serialization::MK_ImplicitModule, clang::serialization::MK_PrebuiltModule, NewlyLoaded, OutOfDate, and updateModuleImports().
|
inline |
Forward iterator to traverse all loaded modules.
Definition at line 142 of file ModuleManager.h.
Referenced by llvm::GraphTraits< ModuleManager >::nodes_begin(), and removeModules().
|
inline |
Const forward iterator to traverse all loaded modules.
Definition at line 148 of file ModuleManager.h.
|
inline |
Forward iterator end-point to traverse all loaded modules.
Definition at line 145 of file ModuleManager.h.
Referenced by llvm::GraphTraits< ModuleManager >::nodes_end(), and removeModules().
|
inline |
Const forward iterator end-point to traverse all loaded modules.
Definition at line 151 of file ModuleManager.h.
|
inline |
Definition at line 310 of file ModuleManager.h.
Referenced by addModule().
|
inline |
Returns the primary module associated with the manager, that is, the first module loaded.
Definition at line 167 of file ModuleManager.h.
Referenced by clang::FrontendAction::BeginSourceFile(), clang::DumpModuleInfoAction::ExecuteAction(), clang::ASTReader::getOriginalSourceFile(), and clang::ASTReader::getSourceDescriptor().
|
inline |
Returns the primary module associated with the manager, that is, the first module loaded.
Definition at line 171 of file ModuleManager.h.
ModuleFile * ModuleManager::lookup | ( | const FileEntry * | File | ) | const |
Returns the module associated with the given module file.
Definition at line 61 of file ModuleManager.cpp.
References clang::File.
Referenced by lookupByFileName(), and lookupByModuleName().
std::unique_ptr< llvm::MemoryBuffer > ModuleManager::lookupBuffer | ( | StringRef | Name | ) |
Returns the in-memory (virtual file) buffer with the given name.
Definition at line 66 of file ModuleManager.cpp.
References clang::FileManager::getFile().
Referenced by addModule().
ModuleFile * ModuleManager::lookupByFileName | ( | StringRef | FileName | ) | const |
Returns the module associated with the given file name.
Definition at line 44 of file ModuleManager.cpp.
References clang::FileManager::getFile(), and lookup().
ModuleFile * ModuleManager::lookupByModuleName | ( | StringRef | ModName | ) | const |
Returns the module associated with the given module name.
Definition at line 53 of file ModuleManager.cpp.
References clang::File, clang::ModuleMap::findModule(), clang::HeaderSearch::getModuleMap(), and lookup().
bool ModuleManager::lookupModuleFile | ( | StringRef | FileName, |
off_t | ExpectedSize, | ||
time_t | ExpectedModTime, | ||
OptionalFileEntryRef & | File | ||
) |
Attempt to resolve the given module file name to a file entry.
FileName | The name of the module file. |
ExpectedSize | The size that the module file is expected to have. If the actual size differs, the resolver should return true . |
ExpectedModTime | The modification time that the module file is expected to have. If the actual modification time differs, the resolver should return true . |
File | Will be set to the file if there is one, or null otherwise. |
Definition at line 441 of file ModuleManager.cpp.
References clang::File, clang::FileName, and clang::FileManager::getFileRef().
Referenced by addModule().
void ModuleManager::moduleFileAccepted | ( | ModuleFile * | MF | ) |
Notification from the AST reader that the given module file has been "accepted", and will not (can not) be unloaded.
Definition at line 326 of file ModuleManager.cpp.
References clang::GlobalModuleIndex::loadedModuleFile().
|
inline |
Returns the module associated with the given index.
Definition at line 174 of file ModuleManager.h.
|
inline |
A range covering the PCH and preamble module files loaded.
Definition at line 161 of file ModuleManager.h.
Referenced by clang::ASTReader::getLocalModuleFile(), clang::ASTReader::getModuleFileID(), and clang::ASTReader::getSourceDescriptor().
|
inline |
Reverse iterator to traverse all loaded modules.
Definition at line 154 of file ModuleManager.h.
Referenced by getTopImportImplicitModule().
void ModuleManager::removeModules | ( | ModuleIterator | First | ) |
Remove the modules starting from First (to the end).
Definition at line 248 of file ModuleManager.cpp.
References begin(), end(), clang::First, and clang::Last.
|
inline |
Reverse iterator end-point to traverse all loaded modules.
Definition at line 157 of file ModuleManager.h.
void ModuleManager::setGlobalIndex | ( | GlobalModuleIndex * | Index | ) |
Set the global module index.
Definition at line 312 of file ModuleManager.cpp.
References clang::GlobalModuleIndex::loadedModuleFile().
|
inline |
Number of modules loaded.
Definition at line 189 of file ModuleManager.h.
Referenced by clang::PCHValidator::ReadDiagnosticOptions(), and visit().
void ModuleManager::viewGraph | ( | ) |
View the graphviz representation of the module graph.
Definition at line 507 of file ModuleManager.cpp.
void ModuleManager::visit | ( | llvm::function_ref< bool(ModuleFile &M)> | Visitor, |
llvm::SmallPtrSetImpl< ModuleFile * > * | ModuleFilesHit = nullptr |
||
) |
Visit each of the modules.
This routine visits each of the modules, starting with the "root" modules that no other loaded modules depend on, and proceeding to the leaf modules, visiting each module only once during the traversal.
This traversal is intended to support various "lookup" operations that can find data in any of the loaded modules.
Visitor | A visitor function that will be invoked with each module. The return value must be convertible to bool; when false, the visitation continues to modules that the current module depends on. When true, the visitation skips any modules that the current module depends on. |
ModuleFilesHit | If non-NULL, contains the set of module files that we know we need to visit because the global module index told us to. Any module that is known to both the global module index and the module manager that is not in this set can be skipped. |
Definition at line 340 of file ModuleManager.cpp.
References clang::serialization::ModuleFile::ImportedBy, clang::serialization::ModuleFile::Imports, clang::serialization::ModuleFile::Index, and size().
Referenced by clang::ASTReader::ReadMethodPool().