clang-tools 20.0.0git
|
Records status information for files open()ed or stat()ed during preamble build (except for the main file), so we can avoid stat()s on the underlying FS when reusing the preamble. More...
#include <FS.h>
Public Member Functions | |
PreambleFileStatusCache (llvm::StringRef MainFilePath) | |
MainFilePath is the absolute path of the main source file this preamble corresponds to. | |
void | update (const llvm::vfs::FileSystem &FS, llvm::vfs::Status S, llvm::StringRef File) |
std::optional< llvm::vfs::Status > | lookup (llvm::StringRef Path) const |
Path is a path stored in preamble. | |
IntrusiveRefCntPtr< llvm::vfs::FileSystem > | getProducingFS (IntrusiveRefCntPtr< llvm::vfs::FileSystem > FS) |
Returns a VFS that collects file status. | |
IntrusiveRefCntPtr< llvm::vfs::FileSystem > | getConsumingFS (IntrusiveRefCntPtr< llvm::vfs::FileSystem > FS) const |
Returns a VFS that uses the cache collected. | |
Records status information for files open()ed or stat()ed during preamble build (except for the main file), so we can avoid stat()s on the underlying FS when reusing the preamble.
For example, code completion can re-stat files when getting FileID for source locations stored in preamble (e.g. checking whether a location is in the main file).
The cache is keyed by absolute path of file name in cached status, as this is what preamble stores.
The cache is not thread-safe when updates happen, so the use pattern should be:
Note that the cache is only valid when reusing preamble.
clang::clangd::PreambleFileStatusCache::PreambleFileStatusCache | ( | llvm::StringRef | MainFilePath | ) |
llvm::IntrusiveRefCntPtr< llvm::vfs::FileSystem > clang::clangd::PreambleFileStatusCache::getConsumingFS | ( | IntrusiveRefCntPtr< llvm::vfs::FileSystem > | FS | ) | const |
llvm::IntrusiveRefCntPtr< llvm::vfs::FileSystem > clang::clangd::PreambleFileStatusCache::getProducingFS | ( | IntrusiveRefCntPtr< llvm::vfs::FileSystem > | FS | ) |
Returns a VFS that collects file status.
Only cache stats for files that exist because 1) we only care about existing files when reusing preamble, unlike building preamble. 2) we use the file name in the Status as the cache key.
Note that the returned VFS should not outlive the cache.
Definition at line 56 of file FS.cpp.
References update().
std::optional< llvm::vfs::Status > clang::clangd::PreambleFileStatusCache::lookup | ( | llvm::StringRef | Path | ) | const |
Path
is a path stored in preamble.
Definition at line 42 of file FS.cpp.
References clang::clangd::File.
Referenced by getConsumingFS().
void clang::clangd::PreambleFileStatusCache::update | ( | const llvm::vfs::FileSystem & | FS, |
llvm::vfs::Status | S, | ||
llvm::StringRef | File | ||
) |
Definition at line 26 of file FS.cpp.
References clang::clangd::File.
Referenced by getProducingFS().