23#include "llvm/ADT/STLExtras.h"
24#include "llvm/ADT/SetVector.h"
25#include "llvm/ADT/SmallPtrSet.h"
26#include "llvm/ADT/SmallVector.h"
27#include "llvm/ADT/StringRef.h"
28#include "llvm/ADT/iterator.h"
29#include "llvm/Support/Chrono.h"
30#include "llvm/Support/DOTGraphTraits.h"
31#include "llvm/Support/ErrorOr.h"
32#include "llvm/Support/GraphWriter.h"
33#include "llvm/Support/MemoryBuffer.h"
34#include "llvm/Support/VirtualFileSystem.h"
39#include <system_error>
42using namespace serialization;
45 auto Entry = FileMgr.
getFile(Name,
false,
62 return Modules.lookup(
File);
65std::unique_ptr<llvm::MemoryBuffer>
67 auto Entry = FileMgr.
getFile(Name,
false,
71 return std::move(InMemoryBuffers[*Entry]);
76 std::string &ErrorStr) {
77 if (!ExpectedSignature || Signature == ExpectedSignature)
81 Signature ?
"signature mismatch" :
"could not read module signature";
89 ImportedBy->
Imports.insert(&MF);
102 off_t ExpectedSize, time_t ExpectedModTime,
106 std::string &ErrorStr) {
122 ErrorStr =
"module file out of date";
127 ErrorStr =
"module file not found";
149 return Entry.getName() == MF->FileName;
153 if (
ModuleFile *ModuleEntry = Modules.lookup(Entry)) {
154 if (implicitModuleNamesMatch(
Type, ModuleEntry, *Entry)) {
156 if (
checkSignature(ModuleEntry->Signature, ExpectedSignature, ErrorStr))
166 auto NewModule = std::make_unique<ModuleFile>(
Type, Generation);
167 NewModule->Index = Chain.size();
168 NewModule->FileName =
FileName.str();
169 NewModule->File = Entry;
170 NewModule->ImportLoc = ImportLoc;
171 NewModule->InputFilesValidationTimestamp = 0;
174 std::string TimestampFilename = NewModule->getTimestampFilename();
175 llvm::vfs::Status Status;
178 NewModule->InputFilesValidationTimestamp =
179 llvm::sys::toTimeT(Status.getLastModificationTime());
185 NewModule->Buffer = &ModuleCache->addBuiltPCM(
FileName, std::move(Buffer));
190 }
else if (llvm::MemoryBuffer *Buffer =
192 NewModule->Buffer = Buffer;
202 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> Buf((std::error_code()));
204 Buf = llvm::MemoryBuffer::getSTDIN();
218 ErrorStr = Buf.getError().message();
226 NewModule->Data = PCHContainerRdr.
ExtractPCH(*NewModule->Buffer);
230 if (ExpectedSignature &&
checkSignature(ReadSignature(NewModule->Data),
231 ExpectedSignature, ErrorStr))
235 Module = Modules[Entry] = NewModule.get();
239 if (!NewModule->isModule())
240 PCHChain.push_back(NewModule.get());
242 Roots.push_back(NewModule.get());
244 Chain.push_back(std::move(NewModule));
258 (llvm::pointer_iterator<ModuleIterator>(
First)),
259 (llvm::pointer_iterator<ModuleIterator>(
Last)));
262 return victimSet.count(MF);
266 I->Imports.remove_if(IsVictim);
267 I->ImportedBy.remove_if(IsVictim);
269 llvm::erase_if(Roots, IsVictim);
273 if (!I->isModule()) {
274 PCHChain.erase(llvm::find(PCHChain, &*I), PCHChain.end());
281 Modules.erase(victim->File);
283 Chain.erase(Chain.begin() + (
First -
begin()), Chain.end());
288 std::unique_ptr<llvm::MemoryBuffer> Buffer) {
291 InMemoryBuffers[Entry] = std::move(Buffer);
294std::unique_ptr<ModuleManager::VisitState> ModuleManager::allocateVisitState() {
296 if (FirstVisitState) {
297 auto Result = std::move(FirstVisitState);
298 FirstVisitState = std::move(
Result->NextState);
303 return std::make_unique<VisitState>(
size());
306void ModuleManager::returnVisitState(std::unique_ptr<VisitState> State) {
307 assert(State->NextState ==
nullptr &&
"Visited state is in list?");
308 State->NextState = std::move(FirstVisitState);
309 FirstVisitState = std::move(State);
315 ModulesInCommonWithGlobalIndex.clear();
323 ModulesInCommonWithGlobalIndex.push_back(&M);
330 ModulesInCommonWithGlobalIndex.push_back(MF);
337 : FileMgr(FileMgr), ModuleCache(&ModuleCache),
338 PCHContainerRdr(PCHContainerRdr), HeaderSearchInfo(HeaderSearchInfo) {}
341 llvm::SmallPtrSetImpl<ModuleFile *> *ModuleFilesHit) {
343 if (VisitOrder.size() != Chain.size()) {
346 VisitOrder.reserve(N);
354 UnusedIncomingEdges.resize(
size());
357 UnusedIncomingEdges[M.
Index] = Size;
364 while (!Queue.empty()) {
365 ModuleFile *CurrentModule = Queue.pop_back_val();
366 VisitOrder.push_back(CurrentModule);
375 unsigned &NumUnusedEdges = UnusedIncomingEdges[M->
Index];
376 if (NumUnusedEdges && (--NumUnusedEdges == 0))
381 assert(VisitOrder.size() == N &&
"Visitation order is wrong?");
383 FirstVisitState =
nullptr;
386 auto State = allocateVisitState();
387 unsigned VisitNumber = State->NextVisitNumber++;
392 if (ModuleFilesHit && !ModulesInCommonWithGlobalIndex.empty()) {
393 for (
unsigned I = 0, N = ModulesInCommonWithGlobalIndex.size(); I != N; ++I)
395 ModuleFile *M = ModulesInCommonWithGlobalIndex[I];
396 if (!ModuleFilesHit->count(M))
397 State->VisitNumber[M->
Index] = VisitNumber;
401 for (
unsigned I = 0, N = VisitOrder.size(); I != N; ++I) {
404 if (State->VisitNumber[CurrentModule->
Index] == VisitNumber)
408 assert(State->VisitNumber[CurrentModule->
Index] == VisitNumber - 1);
409 State->VisitNumber[CurrentModule->
Index] = VisitNumber;
410 if (!Visitor(*CurrentModule))
420 for (llvm::SetVector<ModuleFile *>::iterator
421 M = NextModule->
Imports.begin(),
422 MEnd = NextModule->
Imports.end();
424 if (State->VisitNumber[(*M)->Index] != VisitNumber) {
425 State->Stack.push_back(*M);
426 State->VisitNumber[(*M)->Index] = VisitNumber;
430 if (State->Stack.empty())
434 NextModule = State->Stack.pop_back_val();
438 returnVisitState(std::move(State));
442 time_t ExpectedModTime,
458 if ((ExpectedSize && ExpectedSize !=
File->getSize()) ||
459 (ExpectedModTime && ExpectedModTime !=
File->getModificationTime()))
477 return Node->Imports.begin();
481 return Node->Imports.end();
508 llvm::ViewGraph(*
this,
"Modules");
Defines the clang::FileManager interface and associated types.
Forward-declares and imports various common LLVM datatypes that clang wants to use unqualified.
static bool checkSignature(ASTFileSignature Signature, ASTFileSignature ExpectedSignature, std::string &ErrorStr)
static void updateModuleImports(ModuleFile &MF, ModuleFile *ImportedBy, SourceLocation ImportLoc)
A reference to a FileEntry that includes the name of the file as it was accessed by the FileManager's...
Cached information about one file (either on disk or in the virtual file system).
Implements support for file system lookup, file system caching, and directory search management.
std::error_code getNoncachedStatValue(StringRef Path, llvm::vfs::Status &Result)
Get the 'stat' information for the given Path.
const FileEntry * getVirtualFile(StringRef Filename, off_t Size, time_t ModificationTime)
llvm::ErrorOr< std::unique_ptr< llvm::MemoryBuffer > > getBufferForFile(FileEntryRef Entry, bool isVolatile=false, bool RequiresNullTerminator=true)
Open the specified file as a MemoryBuffer, returning a new MemoryBuffer if successful,...
llvm::ErrorOr< const FileEntry * > getFile(StringRef Filename, bool OpenFile=false, bool CacheFailure=true)
Lookup, cache, and verify the specified file (real or virtual).
llvm::Expected< FileEntryRef > getFileRef(StringRef Filename, bool OpenFile=false, bool CacheFailure=true)
Lookup, cache, and verify the specified file (real or virtual).
A global index for a set of module files, providing information about the identifiers within those mo...
bool loadedModuleFile(ModuleFile *File)
Note that the given module file has been loaded.
In-memory cache for modules.
llvm::MemoryBuffer & addPCM(llvm::StringRef Filename, std::unique_ptr< llvm::MemoryBuffer > Buffer)
Store the PCM under the Filename.
Module * findModule(StringRef Name) const
Retrieve a module with the given name.
Describes a module or submodule.
Wrapper around OptionalFileEntryRef that degrades to 'const FileEntry*', facilitating incremental pat...
This abstract interface provides operations for unwrapping containers for serialized ASTs (precompile...
virtual llvm::StringRef ExtractPCH(llvm::MemoryBufferRef Buffer) const =0
Returns the serialized AST inside the PCH container Buffer.
Encodes a location in the source.
The base class of the type hierarchy.
Information about a module that has been loaded by the ASTReader.
bool DirectlyImported
Whether this module has been directly imported by the user.
llvm::SetVector< ModuleFile * > ImportedBy
List of modules which depend on this module.
SourceLocation ImportLoc
The source location where this module was first imported.
unsigned Index
The index of this module in the list of modules.
llvm::SetVector< ModuleFile * > Imports
List of modules which this module depends on.
std::string ModuleName
The name of the module.
Manages the set of modules loaded by an AST reader.
ModuleManager(FileManager &FileMgr, InMemoryModuleCache &ModuleCache, const PCHContainerReader &PCHContainerRdr, const HeaderSearch &HeaderSearchInfo)
bool lookupModuleFile(StringRef FileName, off_t ExpectedSize, time_t ExpectedModTime, OptionalFileEntryRef &File)
Attempt to resolve the given module file name to a file entry.
AddModuleResult
The result of attempting to add a new module.
@ Missing
The module file is missing.
@ OutOfDate
The module file is out-of-date.
@ NewlyLoaded
The module file was just loaded in response to this call.
@ AlreadyLoaded
The module file had already been loaded.
void moduleFileAccepted(ModuleFile *MF)
Notification from the AST reader that the given module file has been "accepted", and will not (can no...
ModuleFile * lookup(const FileEntry *File) const
Returns the module associated with the given module file.
void viewGraph()
View the graphviz representation of the module graph.
ModuleIterator begin()
Forward iterator to traverse all loaded modules.
void setGlobalIndex(GlobalModuleIndex *Index)
Set the global module index.
ModuleFile * lookupByFileName(StringRef FileName) const
Returns the module associated with the given file name.
void removeModules(ModuleIterator First)
Remove the modules starting from First (to the end).
ModuleIterator end()
Forward iterator end-point to traverse all loaded modules.
std::unique_ptr< llvm::MemoryBuffer > lookupBuffer(StringRef Name)
Returns the in-memory (virtual file) buffer with the given name.
void addInMemoryBuffer(StringRef FileName, std::unique_ptr< llvm::MemoryBuffer > Buffer)
Add an in-memory buffer the list of known buffers.
void visit(llvm::function_ref< bool(ModuleFile &M)> Visitor, llvm::SmallPtrSetImpl< ModuleFile * > *ModuleFilesHit=nullptr)
Visit each of the modules.
unsigned size() const
Number of modules loaded.
InMemoryModuleCache & getModuleCache() const
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.
ASTFileSignature(*)(StringRef) ASTFileSignatureReader
llvm::pointee_iterator< SmallVectorImpl< std::unique_ptr< ModuleFile > >::iterator > ModuleIterator
ModuleFile * lookupByModuleName(StringRef ModName) const
Returns the module associated with the given module name.
ModuleKind
Specifies the kind of module that has been loaded.
@ MK_ExplicitModule
File is an explicitly-loaded module.
@ MK_ImplicitModule
File is an implicitly-loaded module.
@ MK_PrebuiltModule
File is from a prebuilt module path.
@ Result
The result type of a method or function.
YAML serialization mapping.
The signature of a module, which is a hash of the AST content.
DOTGraphTraits(bool IsSimple=false)
std::string getNodeLabel(ModuleFile *M, const ModuleManager &)
static bool renderGraphFromBottomUp()
static ChildIteratorType child_end(NodeRef Node)
static nodes_iterator nodes_begin(const ModuleManager &Manager)
static ChildIteratorType child_begin(NodeRef Node)
pointer_iterator< ModuleManager::ModuleConstIterator > nodes_iterator
llvm::SetVector< ModuleFile * >::const_iterator ChildIteratorType
static nodes_iterator nodes_end(const ModuleManager &Manager)