clang-tools 20.0.0git
|
Handles running tasks for ClangdServer and managing the resources (e.g., preambles and ASTs) for opened files. More...
#include <TUScheduler.h>
Classes | |
class | ASTCache |
An LRU cache of idle ASTs. More... | |
struct | FileData |
struct | FileStats |
class | HeaderIncluderCache |
A map from header files to an opened "proxy" file that includes them. More... | |
struct | Options |
Public Types | |
enum | ASTActionInvalidation { NoInvalidation , InvalidateOnUpdate } |
Defines how a runWithAST action is implicitly cancelled by other actions. More... | |
enum | PreambleConsistency { Stale , StaleOrAbsent } |
Controls whether preamble reads wait for the preamble to be up-to-date. More... | |
Public Member Functions | |
TUScheduler (const GlobalCompilationDatabase &CDB, const Options &Opts, std::unique_ptr< ParsingCallbacks > ASTCallbacks=nullptr) | |
~TUScheduler () | |
llvm::StringMap< FileStats > | fileStats () const |
Returns resources used for each of the currently open files. | |
std::vector< Path > | getFilesWithCachedAST () const |
Returns a list of files with ASTs currently stored in memory. | |
bool | update (PathRef File, ParseInputs Inputs, WantDiagnostics WD) |
Schedule an update for File . | |
void | remove (PathRef File) |
Remove File from the list of tracked files and schedule removal of its resources. | |
void | run (llvm::StringRef Name, llvm::StringRef Path, llvm::unique_function< void()> Action) |
Schedule an async task with no dependencies. | |
void | runQuick (llvm::StringRef Name, llvm::StringRef Path, llvm::unique_function< void()> Action) |
Similar to run, except the task is expected to be quick. | |
void | runWithAST (llvm::StringRef Name, PathRef File, Callback< InputsAndAST > Action, ASTActionInvalidation=NoInvalidation) |
Schedule an async read of the AST. | |
void | runWithPreamble (llvm::StringRef Name, PathRef File, PreambleConsistency Consistency, Callback< InputsAndPreamble > Action) |
Schedule an async read of the preamble. | |
bool | blockUntilIdle (Deadline D) const |
Wait until there are no scheduled or running tasks. | |
void | profile (MemoryTree &MT) const |
Static Public Member Functions | |
static std::optional< llvm::StringRef > | getFileBeingProcessedInContext () |
Handles running tasks for ClangdServer and managing the resources (e.g., preambles and ASTs) for opened files.
TUScheduler is not thread-safe, only one thread should be providing updates and scheduling tasks. Callbacks are run on a threadpool and it's appropriate to do slow work in them. Each task has a name, used for tracing (should be UpperCamelCase).
Definition at line 213 of file TUScheduler.h.
Defines how a runWithAST action is implicitly cancelled by other actions.
Enumerator | |
---|---|
NoInvalidation | The request will run unless explicitly cancelled. |
InvalidateOnUpdate | The request will be implicitly cancelled by a subsequent update(). (Only if the request was not yet cancelled). Useful for requests that are generated by clients, without any explicit user action. These can otherwise e.g. force every version to be built. |
Definition at line 287 of file TUScheduler.h.
Controls whether preamble reads wait for the preamble to be up-to-date.
Definition at line 310 of file TUScheduler.h.
clang::clangd::TUScheduler::TUScheduler | ( | const GlobalCompilationDatabase & | CDB, |
const Options & | Opts, | ||
std::unique_ptr< ParsingCallbacks > | ASTCallbacks = nullptr |
||
) |
Definition at line 1627 of file TUScheduler.cpp.
References clang::clangd::Context::clone(), clang::clangd::TUScheduler::Options::ContextProvider, and clang::clangd::Context::current().
clang::clangd::TUScheduler::~TUScheduler | ( | ) |
Definition at line 1649 of file TUScheduler.cpp.
bool clang::clangd::TUScheduler::blockUntilIdle | ( | Deadline | D | ) | const |
Wait until there are no scheduled or running tasks.
Mostly useful for synchronizing tests.
Definition at line 1660 of file TUScheduler.cpp.
References clang::clangd::File.
llvm::StringMap< TUScheduler::FileStats > clang::clangd::TUScheduler::fileStats | ( | ) | const |
Returns resources used for each of the currently open files.
Results are inherently racy as they measure activity of other threads.
Definition at line 1814 of file TUScheduler.cpp.
Referenced by profile().
|
static |
Definition at line 141 of file TUScheduler.cpp.
References clang::clangd::Context::current(), clang::clangd::File, and clang::clangd::FileBeingProcessed.
std::vector< Path > clang::clangd::TUScheduler::getFilesWithCachedAST | ( | ) | const |
Returns a list of files with ASTs currently stored in memory.
This method is not very reliable and is only used for test. E.g., the results will not contain files that currently run something over their AST.
Definition at line 1822 of file TUScheduler.cpp.
void clang::clangd::TUScheduler::profile | ( | MemoryTree & | MT | ) | const |
Definition at line 1860 of file TUScheduler.cpp.
References clang::clangd::MemoryTree::addUsage(), clang::clangd::MemoryTree::child(), clang::clangd::MemoryTree::detail(), and fileStats().
void clang::clangd::TUScheduler::remove | ( | PathRef | File | ) |
Remove File
from the list of tracked files and schedule removal of its resources.
Pending diagnostics for closed files may not be delivered, even if requested with WantDiags::Auto or WantDiags::Yes.
Definition at line 1695 of file TUScheduler.cpp.
References clang::clangd::elog(), and clang::clangd::File.
void clang::clangd::TUScheduler::run | ( | llvm::StringRef | Name, |
llvm::StringRef | Path, | ||
llvm::unique_function< void()> | Action | ||
) |
Schedule an async task with no dependencies.
Path may be empty (it is used only to set the Context).
Definition at line 1706 of file TUScheduler.cpp.
void clang::clangd::TUScheduler::runQuick | ( | llvm::StringRef | Name, |
llvm::StringRef | Path, | ||
llvm::unique_function< void()> | Action | ||
) |
Similar to run, except the task is expected to be quick.
This function will not honor AsyncThreadsCount (except if threading is disabled with AsyncThreadsCount=0) It is intended to run quick tasks that need to run ASAP
Definition at line 1711 of file TUScheduler.cpp.
void clang::clangd::TUScheduler::runWithAST | ( | llvm::StringRef | Name, |
PathRef | File, | ||
Callback< InputsAndAST > | Action, | ||
ASTActionInvalidation | = NoInvalidation |
||
) |
Schedule an async read of the AST.
Action
will be called when AST is ready. The AST passed to Action
refers to the version of File
tracked at the time of the call, even if new updates are received before Action
is executed. If an error occurs during processing, it is forwarded to the Action
callback. If the context is cancelled before the AST is ready, or the invalidation policy is triggered, the callback will receive a CancelledError.
Definition at line 1739 of file TUScheduler.cpp.
References Action, clang::clangd::File, clang::clangd::InvalidParams, and Name.
void clang::clangd::TUScheduler::runWithPreamble | ( | llvm::StringRef | Name, |
PathRef | File, | ||
PreambleConsistency | Consistency, | ||
Callback< InputsAndPreamble > | Action | ||
) |
Schedule an async read of the preamble.
If there's no up-to-date preamble, we follow the PreambleConsistency policy. If an error occurs, it is forwarded to the Action
callback. Context cancellation is ignored and should be handled by the Action. (In practice, the Action is almost always executed immediately).
Definition at line 1754 of file TUScheduler.cpp.
References Action, clang::clangd::InputsAndPreamble::Contents, clang::clangd::Context::current(), clang::clangd::Context::derive(), clang::clangd::File, clang::clangd::FileBeingProcessed, clang::clangd::InvalidParams, Name, clang::clangd::Preamble, SPAN_ATTACH, and Stale.
bool clang::clangd::TUScheduler::update | ( | PathRef | File, |
ParseInputs | Inputs, | ||
WantDiagnostics | WD | ||
) |
Schedule an update for File
.
The compile command in Inputs
is ignored; worker queries CDB to get the actual compile command. If diagnostics are requested (Yes), and the context is cancelled before they are prepared, they may be skipped if eventual-consistency permits it (i.e. WantDiagnostics is downgraded to Auto). Returns true if the file was not previously tracked.
Definition at line 1670 of file TUScheduler.cpp.
References ContentChanged, clang::clangd::File, and WantDiags.