🐛 fix(async_executor): implement cooperative cancellation

This commit is contained in:
csh
2026-07-13 16:03:56 +08:00
parent edea37202d
commit 89b8937697
17 changed files with 685 additions and 420 deletions
+6 -7
View File
@@ -1,6 +1,5 @@
module; module;
export module lsp.core.dispatcher; export module lsp.core.dispatcher;
import spdlog; import spdlog;
@@ -51,13 +50,13 @@ export namespace lsp::core
{ {
public: public:
ExecutionContext(LifecycleCallback lifecycle_callback, ExecutionContext(LifecycleCallback lifecycle_callback,
scheduler::AsyncExecutor& scheduler, scheduler::async_executor::AsyncExecutor& scheduler,
manager::ManagerHub& manager_hub) : manager::ManagerHub& manager_hub) :
lifecycle_callback_(lifecycle_callback), lifecycle_callback_(lifecycle_callback),
async_executor_(scheduler), async_executor_(scheduler),
manager_hub_(manager_hub) {} manager_hub_(manager_hub) {}
scheduler::AsyncExecutor& GetScheduler() const { return async_executor_; } scheduler::async_executor::AsyncExecutor& GetScheduler() const { return async_executor_; }
manager::ManagerHub& GetManagerHub() const { return manager_hub_; } manager::ManagerHub& GetManagerHub() const { return manager_hub_; }
void TriggerLifecycleEvent(ServerLifecycleEvent event) const void TriggerLifecycleEvent(ServerLifecycleEvent event) const
@@ -68,7 +67,7 @@ export namespace lsp::core
private: private:
LifecycleCallback lifecycle_callback_; LifecycleCallback lifecycle_callback_;
scheduler::AsyncExecutor& async_executor_; scheduler::async_executor::AsyncExecutor& async_executor_;
manager::ManagerHub& manager_hub_; manager::ManagerHub& manager_hub_;
}; };
@@ -80,7 +79,7 @@ export namespace lsp::core
RequestDispatcher(); RequestDispatcher();
~RequestDispatcher() = default; ~RequestDispatcher() = default;
void SetRequestScheduler(scheduler::AsyncExecutor* scheduler); void SetRequestScheduler(scheduler::async_executor::AsyncExecutor* scheduler);
void SetManagerHub(manager::ManagerHub* manager_hub); void SetManagerHub(manager::ManagerHub* manager_hub);
void RegisterRequestProvider(std::shared_ptr<IRequestProvider> provider); void RegisterRequestProvider(std::shared_ptr<IRequestProvider> provider);
@@ -114,7 +113,7 @@ export namespace lsp::core
LifecycleCallback context_lifecycle_callback_; LifecycleCallback context_lifecycle_callback_;
scheduler::AsyncExecutor* async_executor_ = nullptr; scheduler::async_executor::AsyncExecutor* async_executor_ = nullptr;
manager::ManagerHub* manager_hub_ = nullptr; manager::ManagerHub* manager_hub_ = nullptr;
}; };
} }
@@ -128,7 +127,7 @@ namespace lsp::core
}; };
} }
void RequestDispatcher::SetRequestScheduler(scheduler::AsyncExecutor* scheduler) void RequestDispatcher::SetRequestScheduler(scheduler::async_executor::AsyncExecutor* scheduler)
{ {
async_executor_ = scheduler; async_executor_ = scheduler;
spdlog::debug("Request scheduler set"); spdlog::debug("Request scheduler set");
+1 -1
View File
@@ -75,7 +75,7 @@ export namespace lsp::core
private: private:
RequestDispatcher dispatcher_; RequestDispatcher dispatcher_;
manager::ManagerHub manager_hub_; manager::ManagerHub manager_hub_;
scheduler::AsyncExecutor async_executor_; scheduler::async_executor::AsyncExecutor async_executor_;
std::string interpreter_path_; std::string interpreter_path_;
std::atomic<bool> is_initialized_ = false; std::atomic<bool> is_initialized_ = false;
+8 -8
View File
@@ -12,7 +12,7 @@ export namespace lsp::manager::bootstrap
{ {
void InitializeManagerHub( void InitializeManagerHub(
ManagerHub& hub, ManagerHub& hub,
scheduler::AsyncExecutor& async_executor, scheduler::async_executor::AsyncExecutor& async_executor,
const std::vector<std::string>& system_lib_paths); const std::vector<std::string>& system_lib_paths);
} }
@@ -20,7 +20,7 @@ namespace lsp::manager::bootstrap
{ {
void InitializeManagerHub( void InitializeManagerHub(
ManagerHub& hub, ManagerHub& hub,
scheduler::AsyncExecutor& async_executor, scheduler::async_executor::AsyncExecutor& async_executor,
const std::vector<std::string>& system_lib_paths) const std::vector<std::string>& system_lib_paths)
{ {
spdlog::info("Initializing manager hub..."); spdlog::info("Initializing manager hub...");
@@ -31,10 +31,10 @@ namespace lsp::manager::bootstrap
async_executor.Submit( async_executor.Submit(
task_name, task_name,
[&hub, path]() -> std::optional<std::string> { [&hub, path](std::stop_token stop_token) -> std::optional<std::string> {
try try
{ {
hub.symbols().LoadSystemLibrary(path); hub.symbols().LoadSystemLibrary(path, stop_token);
return std::format("Loaded system library: {}", path); return std::format("Loaded system library: {}", path);
} }
catch (const std::exception& e) catch (const std::exception& e)
@@ -43,11 +43,11 @@ namespace lsp::manager::bootstrap
throw; throw;
} }
}, },
[path](const std::optional<std::string>& result, bool cancelled) { [path](const scheduler::async_executor::TaskResult& result) {
if (cancelled) if (result.status == scheduler::async_executor::TaskStatus::kCancelled)
spdlog::info("System library load task cancelled: {}", path); spdlog::info("System library load task cancelled: {}", path);
else if (result) else if (result.status == scheduler::async_executor::TaskStatus::kCompleted && result.value)
spdlog::info("{}", *result); spdlog::info("{}", *result.value);
}); });
} }
spdlog::info("Manager hub initialized, system library loading in background"); spdlog::info("Manager hub initialized, system library loading in background");
+62 -10
View File
@@ -37,11 +37,11 @@ export namespace lsp::manager
explicit Symbol(EventBus& event_bus); explicit Symbol(EventBus& event_bus);
~Symbol(); ~Symbol();
void LoadSystemLibrary(const std::string& lib_path); void LoadSystemLibrary(const std::string& lib_path, std::stop_token stop_token = {});
void LoadWorkspace(const protocol::DocumentUri& workspace_uri); void LoadWorkspace(const protocol::DocumentUri& workspace_uri, std::stop_token stop_token = {});
void IndexWorkspaceFiles(const std::vector<protocol::DocumentUri>& uris); void IndexWorkspaceFiles(const std::vector<protocol::DocumentUri>& uris, std::stop_token stop_token = {});
void RemoveWorkspaceFiles(const std::vector<protocol::DocumentUri>& uris); void RemoveWorkspaceFiles(const std::vector<protocol::DocumentUri>& uris, std::stop_token stop_token = {});
void RenameWorkspaceFiles(const std::vector<std::pair<protocol::DocumentUri, protocol::DocumentUri>>& files); void RenameWorkspaceFiles(const std::vector<std::pair<protocol::DocumentUri, protocol::DocumentUri>>& files);
const language::symbol::SymbolTable* GetSymbolTable(const protocol::DocumentUri& uri) const; const language::symbol::SymbolTable* GetSymbolTable(const protocol::DocumentUri& uri) const;
@@ -306,11 +306,16 @@ namespace lsp::manager
Symbol::~Symbol() = default; Symbol::~Symbol() = default;
void Symbol::LoadSystemLibrary(const std::string& lib_path) void Symbol::LoadSystemLibrary(const std::string& lib_path, std::stop_token stop_token)
{ {
spdlog::info("Loading system library from: {}", lib_path); spdlog::info("Loading system library from: {}", lib_path);
auto start = std::chrono::steady_clock::now(); auto start = std::chrono::steady_clock::now();
if (stop_token.stop_requested())
{
return;
}
if (!std::filesystem::exists(lib_path)) if (!std::filesystem::exists(lib_path))
{ {
spdlog::warn("System library path does not exist: {}", lib_path); spdlog::warn("System library path does not exist: {}", lib_path);
@@ -326,6 +331,11 @@ namespace lsp::manager
for (const auto& entry : std::filesystem::recursive_directory_iterator(lib_path, options)) for (const auto& entry : std::filesystem::recursive_directory_iterator(lib_path, options))
{ {
if (stop_token.stop_requested())
{
return;
}
if (!entry.is_regular_file()) if (!entry.is_regular_file())
continue; continue;
@@ -338,6 +348,10 @@ namespace lsp::manager
spdlog::trace("Indexing library file: {}", entry.path().string()); spdlog::trace("Indexing library file: {}", entry.path().string());
auto table = BuildSymbolTableFromFile(entry.path()); auto table = BuildSymbolTableFromFile(entry.path());
if (stop_token.stop_requested())
{
return;
}
if (!table) if (!table)
{ {
spdlog::trace("Failed to build symbol table for: {}", entry.path().string()); spdlog::trace("Failed to build symbol table for: {}", entry.path().string());
@@ -362,6 +376,11 @@ namespace lsp::manager
++loaded; ++loaded;
} }
if (stop_token.stop_requested())
{
return;
}
{ {
std::unique_lock<std::shared_mutex> lock(mutex_); std::unique_lock<std::shared_mutex> lock(mutex_);
system_symbols_ = std::move(new_symbols); system_symbols_ = std::move(new_symbols);
@@ -378,12 +397,17 @@ namespace lsp::manager
duration); duration);
} }
void Symbol::LoadWorkspace(const protocol::DocumentUri& workspace_uri) void Symbol::LoadWorkspace(const protocol::DocumentUri& workspace_uri, std::stop_token stop_token)
{ {
auto workspace_path = UriToPath(workspace_uri); auto workspace_path = UriToPath(workspace_uri);
spdlog::info("Loading workspace from: {}", workspace_path); spdlog::info("Loading workspace from: {}", workspace_path);
auto start = std::chrono::steady_clock::now(); auto start = std::chrono::steady_clock::now();
if (stop_token.stop_requested())
{
return;
}
if (!std::filesystem::exists(workspace_path)) if (!std::filesystem::exists(workspace_path))
{ {
spdlog::warn("Workspace path does not exist: {}", workspace_path); spdlog::warn("Workspace path does not exist: {}", workspace_path);
@@ -399,6 +423,11 @@ namespace lsp::manager
for (const auto& entry : std::filesystem::recursive_directory_iterator(workspace_path, options)) for (const auto& entry : std::filesystem::recursive_directory_iterator(workspace_path, options))
{ {
if (stop_token.stop_requested())
{
return;
}
if (!entry.is_regular_file()) if (!entry.is_regular_file())
continue; continue;
@@ -407,6 +436,10 @@ namespace lsp::manager
continue; continue;
auto table = BuildSymbolTableFromFile(entry.path()); auto table = BuildSymbolTableFromFile(entry.path());
if (stop_token.stop_requested())
{
return;
}
if (!table) if (!table)
{ {
++failed; ++failed;
@@ -431,6 +464,11 @@ namespace lsp::manager
++loaded; ++loaded;
} }
if (stop_token.stop_requested())
{
return;
}
{ {
std::unique_lock<std::shared_mutex> lock(mutex_); std::unique_lock<std::shared_mutex> lock(mutex_);
workspace_symbols_ = std::move(new_symbols); workspace_symbols_ = std::move(new_symbols);
@@ -447,7 +485,7 @@ namespace lsp::manager
duration); duration);
} }
void Symbol::IndexWorkspaceFiles(const std::vector<protocol::DocumentUri>& uris) void Symbol::IndexWorkspaceFiles(const std::vector<protocol::DocumentUri>& uris, std::stop_token stop_token)
{ {
std::unordered_map<std::string, StoredSymbolEntry> updates; std::unordered_map<std::string, StoredSymbolEntry> updates;
std::vector<std::string> removals; std::vector<std::string> removals;
@@ -457,6 +495,11 @@ namespace lsp::manager
for (const auto& uri : uris) for (const auto& uri : uris)
{ {
if (stop_token.stop_requested())
{
return;
}
auto file_path = std::filesystem::path(UriToPath(uri)); auto file_path = std::filesystem::path(UriToPath(uri));
auto kind = GetTslFileKind(file_path); auto kind = GetTslFileKind(file_path);
if (kind == TslFileKind::kOther) if (kind == TslFileKind::kOther)
@@ -473,6 +516,10 @@ namespace lsp::manager
} }
auto table = BuildSymbolTableFromFile(file_path); auto table = BuildSymbolTableFromFile(file_path);
if (stop_token.stop_requested())
{
return;
}
if (!table) if (!table)
{ {
removals.push_back(std::move(normalized_uri)); removals.push_back(std::move(normalized_uri));
@@ -494,7 +541,7 @@ namespace lsp::manager
updates[normalized_uri] = std::move(stored); updates[normalized_uri] = std::move(stored);
} }
if (updates.empty() && removals.empty()) if (stop_token.stop_requested() || (updates.empty() && removals.empty()))
{ {
return; return;
} }
@@ -513,7 +560,7 @@ namespace lsp::manager
} }
} }
void Symbol::RemoveWorkspaceFiles(const std::vector<protocol::DocumentUri>& uris) void Symbol::RemoveWorkspaceFiles(const std::vector<protocol::DocumentUri>& uris, std::stop_token stop_token)
{ {
if (uris.empty()) if (uris.empty())
{ {
@@ -525,6 +572,11 @@ namespace lsp::manager
for (const auto& uri : uris) for (const auto& uri : uris)
{ {
if (stop_token.stop_requested())
{
return;
}
auto file_path = std::filesystem::path(UriToPath(uri)); auto file_path = std::filesystem::path(UriToPath(uri));
auto kind = GetTslFileKind(file_path); auto kind = GetTslFileKind(file_path);
if (kind == TslFileKind::kOther) if (kind == TslFileKind::kOther)
@@ -534,7 +586,7 @@ namespace lsp::manager
removals.push_back(PathToUri(file_path)); removals.push_back(PathToUri(file_path));
} }
if (removals.empty()) if (stop_token.stop_requested() || removals.empty())
{ {
return; return;
} }
@@ -40,9 +40,6 @@ export namespace lsp::provider
namespace lsp::provider namespace lsp::provider
{ {
std::string Initialize::ProvideResponse(const protocol::RequestMessage& request, ExecutionContext& context) std::string Initialize::ProvideResponse(const protocol::RequestMessage& request, ExecutionContext& context)
{ {
spdlog::debug("Initialize request {}", request.method); spdlog::debug("Initialize request {}", request.method);
@@ -219,24 +216,24 @@ namespace lsp::provider
for (const auto& workspace_folder : workspace_folders) for (const auto& workspace_folder : workspace_folders)
{ {
auto task_id = std::format("Load workspace symbols: {}", workspace_folder.uri); auto task_id = std::format("Load workspace symbols: {}", workspace_folder.uri);
scheduler.Submit(task_id, [&manager_hub, uri = workspace_folder.uri, folder_name = workspace_folder.name]() -> std::optional<std::string> { scheduler.Submit(task_id, [&manager_hub, uri = workspace_folder.uri, folder_name = workspace_folder.name](std::stop_token stop_token) -> std::optional<std::string> {
try try
{ {
manager_hub.symbols().LoadWorkspace(uri); manager_hub.symbols().LoadWorkspace(uri, stop_token);
return std::format("Loaded workspace {} symbols", uri); return std::format("Loaded workspace {} symbols", uri);
} }
catch (const std::exception& e) catch (const std::exception& e)
{ {
spdlog::error("Failed to load workspace {} symbols: {}", folder_name, e.what()); spdlog::error("Failed to load workspace {} symbols: {}", folder_name, e.what());
throw; // Request会处理异常 throw; // Request会处理异常
} }, [](const std::optional<std::string>& result, bool cancelled) { } }, [](const ::lsp::scheduler::async_executor::TaskResult& result) {
if (cancelled) if (result.status == ::lsp::scheduler::async_executor::TaskStatus::kCancelled)
{ {
spdlog::debug("Workspace loading task cancelled"); spdlog::debug("Workspace loading task cancelled");
} }
else if (result) else if (result.status == ::lsp::scheduler::async_executor::TaskStatus::kCompleted && result.value)
{ {
spdlog::info("Workspace loading result: {}", *result); spdlog::info("Workspace loading result: {}", *result.value);
} }); } });
} }
@@ -1,6 +1,5 @@
module; module;
export module lsp.provider.workspace.did_change_workspace_folders; export module lsp.provider.workspace.did_change_workspace_folders;
import spdlog; import spdlog;
@@ -9,6 +8,7 @@ import std;
import lsp.protocol; import lsp.protocol;
import lsp.codec.facade; import lsp.codec.facade;
import lsp.provider.base.interface; import lsp.provider.base.interface;
import lsp.scheduler.async_executor;
export namespace lsp::provider::workspace export namespace lsp::provider::workspace
{ {
@@ -123,10 +123,17 @@ namespace lsp::provider::workspace
return folders; return folders;
} }
std::vector<protocol::DocumentUri> EnumerateWorkspaceFiles(const protocol::DocumentUri& workspace_uri) std::vector<protocol::DocumentUri> EnumerateWorkspaceFiles(
const protocol::DocumentUri& workspace_uri,
std::stop_token stop_token)
{ {
std::vector<protocol::DocumentUri> uris; std::vector<protocol::DocumentUri> uris;
if (stop_token.stop_requested())
{
return uris;
}
std::filesystem::path workspace_path; std::filesystem::path workspace_path;
try try
{ {
@@ -147,6 +154,11 @@ namespace lsp::provider::workspace
for (const auto& entry : std::filesystem::recursive_directory_iterator(workspace_path, options)) for (const auto& entry : std::filesystem::recursive_directory_iterator(workspace_path, options))
{ {
if (stop_token.stop_requested())
{
return {};
}
if (!entry.is_regular_file()) if (!entry.is_regular_file())
{ {
continue; continue;
@@ -211,22 +223,26 @@ namespace lsp::provider::workspace
auto task_id = std::format("Remove workspace folder: {}", folder.uri); auto task_id = std::format("Remove workspace folder: {}", folder.uri);
scheduler.Submit( scheduler.Submit(
task_id, task_id,
[&hub, uri = folder.uri]() -> std::optional<std::string> { [&hub, uri = folder.uri](std::stop_token stop_token) -> std::optional<std::string> {
auto uris = EnumerateWorkspaceFiles(uri); auto uris = EnumerateWorkspaceFiles(uri, stop_token);
if (stop_token.stop_requested())
{
return std::nullopt;
}
if (!uris.empty()) if (!uris.empty())
{ {
hub.symbols().RemoveWorkspaceFiles(uris); hub.symbols().RemoveWorkspaceFiles(uris, stop_token);
} }
return std::format("Removed {} workspace file(s)", uris.size()); return std::format("Removed {} workspace file(s)", uris.size());
}, },
[](const std::optional<std::string>& result, bool cancelled) { [](const ::lsp::scheduler::async_executor::TaskResult& result) {
if (cancelled) if (result.status == ::lsp::scheduler::async_executor::TaskStatus::kCancelled)
{ {
spdlog::debug("Workspace folder removal task cancelled"); spdlog::debug("Workspace folder removal task cancelled");
} }
else if (result) else if (result.status == ::lsp::scheduler::async_executor::TaskStatus::kCompleted && result.value)
{ {
spdlog::info("{}", *result); spdlog::info("{}", *result.value);
} }
}); });
} }
@@ -236,22 +252,26 @@ namespace lsp::provider::workspace
auto task_id = std::format("Index workspace folder: {}", folder.uri); auto task_id = std::format("Index workspace folder: {}", folder.uri);
scheduler.Submit( scheduler.Submit(
task_id, task_id,
[&hub, uri = folder.uri]() -> std::optional<std::string> { [&hub, uri = folder.uri](std::stop_token stop_token) -> std::optional<std::string> {
auto uris = EnumerateWorkspaceFiles(uri); auto uris = EnumerateWorkspaceFiles(uri, stop_token);
if (stop_token.stop_requested())
{
return std::nullopt;
}
if (!uris.empty()) if (!uris.empty())
{ {
hub.symbols().IndexWorkspaceFiles(uris); hub.symbols().IndexWorkspaceFiles(uris, stop_token);
} }
return std::format("Indexed {} workspace file(s)", uris.size()); return std::format("Indexed {} workspace file(s)", uris.size());
}, },
[](const std::optional<std::string>& result, bool cancelled) { [](const ::lsp::scheduler::async_executor::TaskResult& result) {
if (cancelled) if (result.status == ::lsp::scheduler::async_executor::TaskStatus::kCancelled)
{ {
spdlog::debug("Workspace folder indexing task cancelled"); spdlog::debug("Workspace folder indexing task cancelled");
} }
else if (result) else if (result.status == ::lsp::scheduler::async_executor::TaskStatus::kCompleted && result.value)
{ {
spdlog::info("{}", *result); spdlog::info("{}", *result.value);
} }
}); });
} }
@@ -1,6 +1,5 @@
module; module;
export module lsp.provider.workspace.execute_command; export module lsp.provider.workspace.execute_command;
import spdlog; import spdlog;
@@ -107,8 +106,8 @@ namespace lsp::provider::workspace
auto& hub = context.GetManagerHub(); auto& hub = context.GetManagerHub();
auto& scheduler = context.GetScheduler(); auto& scheduler = context.GetScheduler();
auto task_id = std::format("ExecuteCommand load workspace: {}", *uri); auto task_id = std::format("ExecuteCommand load workspace: {}", *uri);
scheduler.Submit(task_id, [&hub, uri = *uri]() -> std::optional<std::string> { scheduler.Submit(task_id, [&hub, uri = *uri](std::stop_token stop_token) -> std::optional<std::string> {
hub.symbols().LoadWorkspace(uri); hub.symbols().LoadWorkspace(uri, stop_token);
return std::string("ok"); return std::string("ok");
}); });
@@ -125,8 +124,8 @@ namespace lsp::provider::workspace
auto& hub = context.GetManagerHub(); auto& hub = context.GetManagerHub();
auto& scheduler = context.GetScheduler(); auto& scheduler = context.GetScheduler();
auto task_id = std::format("ExecuteCommand index files: {}", uris.size()); auto task_id = std::format("ExecuteCommand index files: {}", uris.size());
scheduler.Submit(task_id, [&hub, uris = std::move(uris)]() -> std::optional<std::string> { scheduler.Submit(task_id, [&hub, uris = std::move(uris)](std::stop_token stop_token) -> std::optional<std::string> {
hub.symbols().IndexWorkspaceFiles(uris); hub.symbols().IndexWorkspaceFiles(uris, stop_token);
return std::string("ok"); return std::string("ok");
}); });
+221 -251
View File
@@ -4,29 +4,20 @@ import spdlog;
import taskflow; import taskflow;
import std; import std;
export namespace lsp::scheduler export namespace lsp::scheduler::async_executor
{ {
class AsyncExecutor; enum class TaskStatus
namespace detail
{ {
struct ExecutionState kCompleted,
{ kCancelled,
std::atomic<bool> cancelled{ false }; kFailed,
std::mutex mutex;
std::condition_variable cv;
bool completed = false;
bool callback_completed = false;
std::optional<std::string> result;
std::exception_ptr error;
std::chrono::steady_clock::time_point start_time{};
}; };
struct ActiveEntry struct TaskResult
{ {
std::shared_ptr<ExecutionState> state; TaskStatus status;
std::function<void(const std::optional<std::string>& result, bool cancelled)> callback; std::optional<std::string> value;
std::chrono::steady_clock::time_point start_time; std::exception_ptr error;
}; };
struct ExecutorMetrics struct ExecutorMetrics
@@ -37,37 +28,37 @@ export namespace lsp::scheduler
std::uint64_t failed = 0; std::uint64_t failed = 0;
std::uint64_t cancelled = 0; std::uint64_t cancelled = 0;
}; };
}
class AsyncExecutor;
class TaskHandle class TaskHandle
{ {
public: public:
TaskHandle() = default; TaskHandle() = default;
TaskHandle(AsyncExecutor* executor, std::string task_id, std::shared_ptr<detail::ExecutionState> state) :
executor_(executor), task_id_(std::move(task_id)), state_(std::move(state))
{
}
bool Valid() const
{
return executor_ != nullptr && !task_id_.empty() && !state_.expired();
}
bool Valid() const;
bool Cancel() const; bool Cancel() const;
bool Wait() const; std::optional<TaskResult> Wait() const;
std::optional<std::string> GetResult() const; std::optional<TaskResult> TryGetResult() const;
private: private:
AsyncExecutor* executor_ = nullptr; struct State;
std::string task_id_;
std::weak_ptr<detail::ExecutionState> state_; explicit TaskHandle(std::shared_ptr<State> state);
std::shared_ptr<State> state_;
friend class AsyncExecutor;
}; };
class AsyncExecutor class AsyncExecutor
{ {
public: public:
using TaskClosure = std::function<std::optional<std::string>()>; using TaskClosure = std::function<std::optional<std::string>(std::stop_token)>;
using TaskCallback = std::function<void(const std::optional<std::string>&, bool)>;
// A callback must not wait on its own handle or call WaitAll() on this
// executor because either operation would wait for the callback itself.
using TaskCallback = std::function<void(const TaskResult&)>;
explicit AsyncExecutor(std::size_t concurrency = std::thread::hardware_concurrency()); explicit AsyncExecutor(std::size_t concurrency = std::thread::hardware_concurrency());
~AsyncExecutor(); ~AsyncExecutor();
@@ -77,89 +68,114 @@ export namespace lsp::scheduler
TaskHandle Submit(const std::string& task_id, TaskClosure task, TaskCallback callback = nullptr); TaskHandle Submit(const std::string& task_id, TaskClosure task, TaskCallback callback = nullptr);
bool Cancel(const std::string& task_id); bool Cancel(const std::string& task_id);
bool WaitForTask(const std::string& task_id);
void WaitAll(); void WaitAll();
std::size_t GetRunningTaskCount() const; std::size_t GetRunningTaskCount() const;
void LogStatus() const; void LogStatus() const;
detail::ExecutorMetrics GetStatistics() const; ExecutorMetrics GetStatistics() const;
private: private:
void ExecuteTask(const std::string& task_id, TaskClosure task, std::shared_ptr<detail::ExecutionState> state, TaskCallback callback); using TaskState = TaskHandle::State;
void CompleteTask(const std::string& task_id,
std::chrono::steady_clock::time_point start_time, static bool RequestCancel(const std::shared_ptr<TaskState>& state);
std::shared_ptr<detail::ExecutionState> state, void ExecuteTask(std::shared_ptr<TaskState> state, TaskClosure task, TaskCallback callback);
const std::optional<std::string>& result, void CompleteTask(const std::shared_ptr<TaskState>& state, TaskResult result, const TaskCallback& callback);
bool cancelled, void FinalizeTask(const std::shared_ptr<TaskState>& state);
bool failed,
TaskCallback callback);
bool RegisterTask(const std::string& task_id, const detail::ActiveEntry& ctx);
void UnregisterTask(const std::string& task_id, const std::shared_ptr<detail::ExecutionState>& state);
bool MarkTaskCancelled(const std::string& task_id);
std::chrono::milliseconds GetElapsedTime(std::chrono::steady_clock::time_point start_time) const;
private:
tf::Executor executor_; tf::Executor executor_;
mutable std::mutex mutex_; mutable std::mutex mutex_;
std::unordered_map<std::string, detail::ActiveEntry> running_tasks_; std::condition_variable active_tasks_cv_;
std::unordered_map<std::string, std::shared_ptr<TaskState>> current_tasks_;
std::unordered_set<std::shared_ptr<TaskState>> active_tasks_;
std::atomic<std::uint64_t> submitted_{ 0 }; std::atomic<std::uint64_t> submitted_{ 0 };
std::atomic<std::uint64_t> completed_{ 0 }; std::atomic<std::uint64_t> completed_{ 0 };
std::atomic<std::uint64_t> failed_{ 0 }; std::atomic<std::uint64_t> failed_{ 0 };
std::atomic<std::uint64_t> cancelled_{ 0 }; std::atomic<std::uint64_t> cancelled_{ 0 };
static constexpr std::size_t kStatusLogInterval = 10; friend class TaskHandle;
}; };
} }
namespace lsp::scheduler namespace lsp::scheduler::async_executor
{ {
struct TaskHandle::State
{
enum class Phase
{
kPending,
kRunning,
kCompleted,
};
explicit State(std::string id) : task_id(std::move(id)) {}
std::string task_id;
std::chrono::steady_clock::time_point start_time = std::chrono::steady_clock::now();
std::stop_source stop_source;
mutable std::mutex mutex;
std::condition_variable cv;
Phase phase = Phase::kPending;
bool cancel_requested = false;
std::optional<TaskResult> result;
bool callback_completed = false;
};
namespace namespace
{ {
constexpr const char* kLogTag = "AsyncExecutor"; constexpr const char* kLogTag = "AsyncExecutor";
std::size_t NormalizeConcurrency(std::size_t concurrency)
{
return std::max<std::size_t>(1, concurrency);
}
template<typename Duration> template<typename Duration>
std::string FormatDuration(Duration duration) std::string FormatDuration(Duration duration)
{ {
auto ms = std::chrono::duration_cast<std::chrono::milliseconds>(duration).count(); auto milliseconds = std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
if (ms < 1000) if (milliseconds < 1000)
return std::to_string(ms) + "ms"; return std::to_string(milliseconds) + "ms";
else return std::to_string(milliseconds / 1000.0) + "s";
return std::to_string(ms / 1000.0) + "s";
} }
} }
TaskHandle::TaskHandle(std::shared_ptr<State> state) : state_(std::move(state)) {}
bool TaskHandle::Valid() const
{
return state_ != nullptr;
}
bool TaskHandle::Cancel() const bool TaskHandle::Cancel() const
{ {
if (!Valid()) return AsyncExecutor::RequestCancel(state_);
return false;
return executor_->Cancel(task_id_);
} }
bool TaskHandle::Wait() const std::optional<TaskResult> TaskHandle::Wait() const
{ {
auto state = state_.lock(); if (!state_)
if (!state)
return false;
std::unique_lock<std::mutex> lk(state->mutex);
state->cv.wait(lk, [state]() { return state->completed && state->callback_completed; });
return true;
}
std::optional<std::string> TaskHandle::GetResult() const
{
auto state = state_.lock();
if (!state)
return std::nullopt; return std::nullopt;
std::unique_lock<std::mutex> lk(state->mutex);
if (!state->completed || !state->callback_completed || state->error) std::unique_lock lock(state_->mutex);
return std::nullopt; state_->cv.wait(lock, [this] { return state_->callback_completed; });
return state->result; return state_->result;
} }
AsyncExecutor::AsyncExecutor(std::size_t concurrency) : executor_(concurrency) std::optional<TaskResult> TaskHandle::TryGetResult() const
{ {
spdlog::info("{}: Initialized with {} threads", kLogTag, concurrency); if (!state_)
return std::nullopt;
std::lock_guard lock(state_->mutex);
if (!state_->callback_completed)
return std::nullopt;
return state_->result;
}
AsyncExecutor::AsyncExecutor(std::size_t concurrency) : executor_(NormalizeConcurrency(concurrency))
{
spdlog::info("{}: Initialized with {} threads", kLogTag, NormalizeConcurrency(concurrency));
} }
AsyncExecutor::~AsyncExecutor() AsyncExecutor::~AsyncExecutor()
@@ -171,91 +187,71 @@ namespace lsp::scheduler
TaskHandle AsyncExecutor::Submit(const std::string& task_id, TaskClosure task, TaskCallback callback) TaskHandle AsyncExecutor::Submit(const std::string& task_id, TaskClosure task, TaskCallback callback)
{ {
detail::ActiveEntry entry; auto state = std::make_shared<TaskState>(task_id);
entry.state = std::make_shared<detail::ExecutionState>(); std::shared_ptr<TaskState> replaced_state;
entry.state->start_time = std::chrono::steady_clock::now(); {
entry.callback = callback; std::lock_guard lock(mutex_);
entry.start_time = entry.state->start_time; auto current = current_tasks_.find(task_id);
if (current != current_tasks_.end())
replaced_state = current->second;
current_tasks_[task_id] = state;
active_tasks_.insert(state);
++submitted_;
}
bool replaced_existing = RegisterTask(task_id, entry); if (replaced_state)
{
if (replaced_existing) RequestCancel(replaced_state);
spdlog::warn("[{}] Replaced existing task", task_id); spdlog::warn("[{}] Replaced existing task", task_id);
}
try try
{ {
executor_.async([this, task_id, task = std::move(task), state = entry.state, callback]() mutable { executor_.async([this, state, task = std::move(task), callback]() mutable {
ExecuteTask(task_id, std::move(task), state, callback); ExecuteTask(std::move(state), std::move(task), std::move(callback));
}); });
} }
catch (const std::exception& e) catch (...)
{ {
spdlog::error("[{}] Failed to submit task: {}", task_id, e.what()); auto error = std::current_exception();
CompleteTask(task_id, entry.start_time, entry.state, std::nullopt, false, true, callback); spdlog::error("[{}] Failed to submit task", task_id);
CompleteTask(state, TaskResult{ TaskStatus::kFailed, std::nullopt, error }, callback);
} }
return TaskHandle(this, task_id, entry.state); return TaskHandle(std::move(state));
} }
bool AsyncExecutor::Cancel(const std::string& task_id) bool AsyncExecutor::Cancel(const std::string& task_id)
{ {
return MarkTaskCancelled(task_id); std::shared_ptr<TaskState> state;
}
bool AsyncExecutor::WaitForTask(const std::string& task_id)
{ {
std::shared_ptr<detail::ExecutionState> state; std::lock_guard lock(mutex_);
{ auto current = current_tasks_.find(task_id);
std::unique_lock<std::mutex> lock(mutex_); if (current == current_tasks_.end())
auto it = running_tasks_.find(task_id);
if (it == running_tasks_.end())
return false; return false;
state = it->second.state; state = current->second;
} }
return RequestCancel(state);
std::unique_lock<std::mutex> lk(state->mutex);
state->cv.wait(lk, [state]() { return state->completed && state->callback_completed; });
return true;
} }
void AsyncExecutor::WaitAll() void AsyncExecutor::WaitAll()
{ {
std::vector<std::shared_ptr<detail::ExecutionState>> tasks;
{ {
std::unique_lock<std::mutex> lock(mutex_); std::unique_lock lock(mutex_);
for (const auto& [_, entry] : running_tasks_) active_tasks_cv_.wait(lock, [this] { return active_tasks_.empty(); });
{
tasks.push_back(entry.state);
} }
}
for (const auto& state : tasks)
{
std::unique_lock<std::mutex> lk(state->mutex);
state->cv.wait(lk, [state]() { return state->completed && state->callback_completed; });
}
// Ensure the underlying executor finishes any tasks that may have been
// cancelled or replaced but are still running.
executor_.wait_for_all(); executor_.wait_for_all();
} }
std::size_t AsyncExecutor::GetRunningTaskCount() const std::size_t AsyncExecutor::GetRunningTaskCount() const
{ {
std::unique_lock<std::mutex> lock(mutex_); std::lock_guard lock(mutex_);
return running_tasks_.size(); return active_tasks_.size();
} }
void AsyncExecutor::LogStatus() const void AsyncExecutor::LogStatus() const
{ {
std::unique_lock<std::mutex> lock(mutex_); const auto metrics = GetStatistics();
detail::ExecutorMetrics metrics;
metrics.running = running_tasks_.size();
metrics.submitted = submitted_;
metrics.completed = completed_;
metrics.failed = failed_;
metrics.cancelled = cancelled_;
spdlog::info("[{}] Running: {}, Submitted: {}, Completed: {}, Failed: {}, Cancelled: {}", spdlog::info("[{}] Running: {}, Submitted: {}, Completed: {}, Failed: {}, Cancelled: {}",
kLogTag, kLogTag,
metrics.running, metrics.running,
@@ -265,157 +261,131 @@ namespace lsp::scheduler
metrics.cancelled); metrics.cancelled);
} }
detail::ExecutorMetrics AsyncExecutor::GetStatistics() const ExecutorMetrics AsyncExecutor::GetStatistics() const
{ {
detail::ExecutorMetrics metrics; ExecutorMetrics metrics;
std::unique_lock<std::mutex> lock(mutex_); {
metrics.running = running_tasks_.size(); std::lock_guard lock(mutex_);
metrics.submitted = submitted_; metrics.running = active_tasks_.size();
metrics.completed = completed_; }
metrics.failed = failed_; metrics.submitted = submitted_.load();
metrics.cancelled = cancelled_; metrics.completed = completed_.load();
metrics.failed = failed_.load();
metrics.cancelled = cancelled_.load();
return metrics; return metrics;
} }
void AsyncExecutor::ExecuteTask(const std::string& task_id, TaskClosure task, std::shared_ptr<detail::ExecutionState> state, TaskCallback callback) bool AsyncExecutor::RequestCancel(const std::shared_ptr<TaskState>& state)
{ {
if (!state)
return false;
{
std::lock_guard lock(state->mutex);
if (state->phase == TaskState::Phase::kCompleted || state->cancel_requested)
return false;
state->cancel_requested = true;
}
return state->stop_source.request_stop();
}
void AsyncExecutor::ExecuteTask(std::shared_ptr<TaskState> state, TaskClosure task, TaskCallback callback)
{
const auto stop_token = state->stop_source.get_token();
bool cancelled_before_start = false;
{
std::lock_guard lock(state->mutex);
cancelled_before_start = state->cancel_requested;
if (!cancelled_before_start)
state->phase = TaskState::Phase::kRunning;
}
if (cancelled_before_start)
{
CompleteTask(state, TaskResult{ TaskStatus::kCancelled, std::nullopt, nullptr }, callback);
return;
}
TaskResult result;
try try
{ {
auto result = task(); auto value = task(stop_token);
CompleteTask(task_id, if (stop_token.stop_requested())
state->start_time, result = TaskResult{ TaskStatus::kCancelled, std::nullopt, nullptr };
state, else
result, result = TaskResult{ TaskStatus::kCompleted, std::move(value), nullptr };
state->cancelled.load(std::memory_order_relaxed),
false,
callback);
} }
catch (const std::exception& e) catch (const std::exception& e)
{ {
spdlog::error("[{}] Task threw exception: {}", task_id, e.what()); spdlog::error("[{}] Task threw exception: {}", state->task_id, e.what());
CompleteTask(task_id, result = TaskResult{ TaskStatus::kFailed, std::nullopt, std::current_exception() };
state->start_time,
state,
std::nullopt,
state->cancelled.load(std::memory_order_relaxed),
true,
callback);
} }
catch (...) catch (...)
{ {
spdlog::error("[{}] Task threw unknown exception", task_id); spdlog::error("[{}] Task threw unknown exception", state->task_id);
CompleteTask(task_id, result = TaskResult{ TaskStatus::kFailed, std::nullopt, std::current_exception() };
state->start_time,
state,
std::nullopt,
state->cancelled.load(std::memory_order_relaxed),
true,
callback);
}
} }
void AsyncExecutor::CompleteTask(const std::string& task_id, CompleteTask(state, std::move(result), callback);
std::chrono::steady_clock::time_point start_time, }
std::shared_ptr<detail::ExecutionState> state,
const std::optional<std::string>& result,
bool cancelled,
bool failed,
TaskCallback callback)
{
if (!state)
return;
const bool is_cancelled = cancelled || state->cancelled.load(std::memory_order_relaxed); void AsyncExecutor::CompleteTask(const std::shared_ptr<TaskState>& state, TaskResult result, const TaskCallback& callback)
{ {
std::unique_lock<std::mutex> lk(state->mutex); {
state->completed = true; std::lock_guard lock(state->mutex);
if (result.status == TaskStatus::kCompleted && state->cancel_requested)
result = TaskResult{ TaskStatus::kCancelled, std::nullopt, nullptr };
state->phase = TaskState::Phase::kCompleted;
state->result = result; state->result = result;
state->cancelled = is_cancelled;
if (failed)
state->error = std::make_exception_ptr(std::runtime_error("Task failed"));
} }
UnregisterTask(task_id, state);
auto elapsed = GetElapsedTime(start_time);
bool callback_failed = false;
if (callback) if (callback)
{ {
try try
{ {
callback(result, is_cancelled); callback(result);
} }
catch (...) catch (...)
{ {
callback_failed = true; spdlog::error("[{}] Task callback threw exception", state->task_id);
std::unique_lock<std::mutex> lk(state->mutex);
state->error = std::current_exception();
} }
} }
const bool has_failed = failed || callback_failed; switch (result.status)
if (has_failed)
++failed_;
else if (is_cancelled)
++cancelled_;
else
++completed_;
{ {
std::unique_lock<std::mutex> lk(state->mutex); case TaskStatus::kCompleted:
++completed_;
break;
case TaskStatus::kCancelled:
++cancelled_;
break;
case TaskStatus::kFailed:
++failed_;
break;
}
FinalizeTask(state);
const auto elapsed = std::chrono::steady_clock::now() - state->start_time;
spdlog::info("[{}] Task completed. status={}, elapsed={}",
state->task_id,
static_cast<int>(result.status),
FormatDuration(elapsed));
}
void AsyncExecutor::FinalizeTask(const std::shared_ptr<TaskState>& state)
{
{
std::lock_guard lock(mutex_);
active_tasks_.erase(state);
auto current = current_tasks_.find(state->task_id);
if (current != current_tasks_.end() && current->second == state)
current_tasks_.erase(current);
std::lock_guard state_lock(state->mutex);
state->callback_completed = true; state->callback_completed = true;
} }
state->cv.notify_all(); state->cv.notify_all();
active_tasks_cv_.notify_all();
if (callback_failed)
spdlog::error("[{}] Task callback threw exception", task_id);
spdlog::info("[{}] Task completed. cancelled={}, failed={}, elapsed={}", task_id, is_cancelled, has_failed, FormatDuration(elapsed));
} }
bool AsyncExecutor::RegisterTask(const std::string& task_id, const detail::ActiveEntry& ctx)
{
std::unique_lock<std::mutex> lock(mutex_);
auto it = running_tasks_.find(task_id);
const bool replaced = it != running_tasks_.end();
if (it != running_tasks_.end())
{
// Mark prior task as cancelled; completion will observe this flag.
it->second.state->cancelled.store(true, std::memory_order_relaxed);
}
running_tasks_[task_id] = ctx;
++submitted_;
return replaced;
}
void AsyncExecutor::UnregisterTask(const std::string& task_id, const std::shared_ptr<detail::ExecutionState>& state)
{
std::unique_lock<std::mutex> lock(mutex_);
auto it = running_tasks_.find(task_id);
if (it != running_tasks_.end() && it->second.state == state)
{
running_tasks_.erase(it);
}
}
bool AsyncExecutor::MarkTaskCancelled(const std::string& task_id)
{
std::unique_lock<std::mutex> lock(mutex_);
auto it = running_tasks_.find(task_id);
if (it == running_tasks_.end())
return false;
auto& state = it->second.state;
{
std::unique_lock<std::mutex> lk(state->mutex);
state->cancelled = true;
}
return true;
}
std::chrono::milliseconds AsyncExecutor::GetElapsedTime(std::chrono::steady_clock::time_point start_time) const
{
return std::chrono::duration_cast<std::chrono::milliseconds>(std::chrono::steady_clock::now() - start_time);
}
} }
@@ -64,7 +64,7 @@ namespace lsp::test::provider
{ {
struct ProviderEnv struct ProviderEnv
{ {
scheduler::AsyncExecutor scheduler{ 1 }; scheduler::async_executor::AsyncExecutor scheduler{ 1 };
manager::ManagerHub hub{}; manager::ManagerHub hub{};
core::ExecutionContext context; core::ExecutionContext context;
@@ -33,7 +33,7 @@ namespace lsp::test::provider
{ {
struct ProviderEnv struct ProviderEnv
{ {
scheduler::AsyncExecutor scheduler{ 1 }; scheduler::async_executor::AsyncExecutor scheduler{ 1 };
manager::ManagerHub hub{}; manager::ManagerHub hub{};
core::ExecutionContext context; core::ExecutionContext context;
@@ -34,7 +34,7 @@ namespace lsp::test::provider
struct ProviderEnv struct ProviderEnv
{ {
scheduler::AsyncExecutor scheduler{ 4 }; scheduler::async_executor::AsyncExecutor scheduler{ 4 };
manager::ManagerHub hub{}; manager::ManagerHub hub{};
core::ExecutionContext context; core::ExecutionContext context;
@@ -35,7 +35,7 @@ namespace lsp::test::provider
{ {
struct ProviderEnv struct ProviderEnv
{ {
scheduler::AsyncExecutor scheduler{ 1 }; scheduler::async_executor::AsyncExecutor scheduler{ 1 };
manager::ManagerHub hub{}; manager::ManagerHub hub{};
core::ExecutionContext context; core::ExecutionContext context;
@@ -49,7 +49,7 @@ namespace lsp::test::provider
struct ProviderEnv struct ProviderEnv
{ {
scheduler::AsyncExecutor scheduler{ 1 }; scheduler::async_executor::AsyncExecutor scheduler{ 1 };
manager::ManagerHub hub{}; manager::ManagerHub hub{};
core::RequestDispatcher dispatcher{}; core::RequestDispatcher dispatcher{};
@@ -1225,7 +1225,7 @@ namespace lsp::test::provider
auto code_action_tree = env.hub.parser().GetTree(code_action_uri); auto code_action_tree = env.hub.parser().GetTree(code_action_uri);
auto code_action_diagnostics = BuildDiagnosticsFromSyntaxErrors(code_action_tree, code_action_content); auto code_action_diagnostics = BuildDiagnosticsFromSyntaxErrors(code_action_tree, code_action_content);
env.scheduler.Submit("json_cancel_me", []() -> std::optional<std::string> { env.scheduler.Submit("json_cancel_me", [](std::stop_token) -> std::optional<std::string> {
std::this_thread::sleep_for(std::chrono::milliseconds(200)); std::this_thread::sleep_for(std::chrono::milliseconds(200));
return std::string("done"); return std::string("done");
}); });
@@ -176,7 +176,7 @@ namespace lsp::test::provider
struct ProviderEnv struct ProviderEnv
{ {
std::vector<core::ServerLifecycleEvent> events; std::vector<core::ServerLifecycleEvent> events;
scheduler::AsyncExecutor scheduler{ 1 }; scheduler::async_executor::AsyncExecutor scheduler{ 1 };
manager::ManagerHub hub{}; manager::ManagerHub hub{};
core::ExecutionContext context; core::ExecutionContext context;
@@ -3426,7 +3426,7 @@ namespace lsp::test::provider
ProviderEnv env; ProviderEnv env;
std::atomic<bool> started{ false }; std::atomic<bool> started{ false };
env.scheduler.Submit("cancel_me", [&started]() -> std::optional<std::string> { env.scheduler.Submit("cancel_me", [&started](std::stop_token) -> std::optional<std::string> {
started.store(true); started.store(true);
std::this_thread::sleep_for(std::chrono::milliseconds(200)); std::this_thread::sleep_for(std::chrono::milliseconds(200));
return std::string("done"); return std::string("done");
@@ -113,7 +113,7 @@ namespace lsp::test::provider
struct ProviderEnv struct ProviderEnv
{ {
scheduler::AsyncExecutor scheduler{ 1 }; scheduler::async_executor::AsyncExecutor scheduler{ 1 };
manager::ManagerHub hub{}; manager::ManagerHub hub{};
core::ExecutionContext context; core::ExecutionContext context;
+1 -1
View File
@@ -2,5 +2,5 @@ import lsp.test.scheduler.async_executor;
int main() int main()
{ {
return Run(); return lsp::test::scheduler::async_executor::Run();
} }
@@ -10,6 +10,9 @@ using namespace std::chrono_literals;
namespace namespace
{ {
using lsp::scheduler::async_executor::AsyncExecutor;
using lsp::scheduler::async_executor::TaskStatus;
void Expect(bool condition, const std::string& message) void Expect(bool condition, const std::string& message)
{ {
if (!condition) if (!condition)
@@ -42,7 +45,7 @@ namespace
} }
catch (const std::exception& e) catch (const std::exception& e)
{ {
failures++; ++failures;
std::cout << "[FAIL] " << entry.name << " -> " << e.what() << std::endl; std::cout << "[FAIL] " << entry.name << " -> " << e.what() << std::endl;
} }
} }
@@ -53,112 +56,337 @@ namespace
private: private:
std::vector<Entry> entries_; std::vector<Entry> entries_;
}; };
class BlockingCallbackCopy
{
public:
BlockingCallbackCopy(std::latch& copy_started, std::latch& release_copy) :
copy_started_(copy_started), release_copy_(release_copy)
{
}
BlockingCallbackCopy(const BlockingCallbackCopy& other) :
copy_started_(other.copy_started_), release_copy_(other.release_copy_)
{
copy_started_.count_down();
release_copy_.wait();
}
BlockingCallbackCopy(BlockingCallbackCopy&&) = default;
void operator()(const lsp::scheduler::async_executor::TaskResult&) const {}
private:
std::latch& copy_started_;
std::latch& release_copy_;
};
} }
export int Run() export namespace lsp::test::scheduler::async_executor
{ {
int Run()
{
SchedulerTestSuite suite; SchedulerTestSuite suite;
suite.Add("Completes basic task", [] { suite.Add("Rejects operations on a default handle", [] {
lsp::scheduler::AsyncExecutor executor(2); lsp::scheduler::async_executor::TaskHandle handle;
std::mutex callback_mutex; Expect(!handle.Valid(), "default handle should be invalid");
std::optional<std::string> callback_result; Expect(!handle.Cancel(), "invalid handle cancellation should fail");
bool callback_cancelled = false; Expect(!handle.Wait().has_value(), "invalid handle wait should be empty");
Expect(!handle.TryGetResult().has_value(), "invalid handle result should be empty");
});
auto handle = executor.Submit("task.simple", []() -> std::optional<std::string> { suite.Add("Retains completed task result through handle", [] {
std::this_thread::sleep_for(5ms); AsyncExecutor executor{ 1 };
return std::string("done"); }, [&](const std::optional<std::string>& result, bool cancelled) { auto handle = executor.Submit("fast", [](std::stop_token) {
std::lock_guard<std::mutex> lk(callback_mutex); return std::optional<std::string>{ "done" };
callback_result = result; });
callback_cancelled = cancelled; });
Expect(handle.Valid(), "Task handle should be valid"); auto result = handle.Wait();
Expect(handle.Wait(), "Handle wait should succeed"); Expect(handle.Valid(), "completed handle should remain valid");
Expect(result && result->status == TaskStatus::kCompleted, "task should complete");
Expect(result->value == "done", "task value should remain available");
Expect(handle.TryGetResult().has_value(), "completed result should be non-blocking");
Expect(!handle.Cancel(), "completed task cancellation should fail");
});
suite.Add("Waits for callback completion", [] {
AsyncExecutor executor{ 1 };
std::latch callback_started{ 1 };
std::latch release_callback{ 1 };
auto handle = executor.Submit(
"callback.wait",
[](std::stop_token) { return std::optional<std::string>{ "done" }; },
[&](const lsp::scheduler::async_executor::TaskResult&) {
callback_started.count_down();
release_callback.wait();
});
callback_started.wait();
auto waiter = std::async(std::launch::async, [&handle] { return handle.Wait(); });
const bool blocked = waiter.wait_for(20ms) == std::future_status::timeout;
const bool unavailable = !handle.TryGetResult().has_value();
release_callback.count_down();
auto result = waiter.get();
Expect(blocked, "wait should block until callback returns");
Expect(unavailable, "result should remain unavailable during callback");
Expect(result && result->status == TaskStatus::kCompleted, "wait should return task result");
});
suite.Add("Skips a queued task cancelled through its handle", [] {
AsyncExecutor executor{ 1 };
std::latch blocker_started{ 1 };
std::latch release_blocker{ 1 };
auto blocker = executor.Submit("blocker", [&](std::stop_token) {
blocker_started.count_down();
release_blocker.wait();
return std::optional<std::string>{};
});
blocker_started.wait();
std::atomic<bool> ran{ false };
auto queued = executor.Submit("queued", [&](std::stop_token) {
ran = true;
return std::optional<std::string>{};
});
const bool first_cancel = queued.Cancel();
const bool second_cancel = queued.Cancel();
release_blocker.count_down();
auto queued_result = queued.Wait();
auto blocker_result = blocker.Wait();
Expect(first_cancel, "first queued cancellation should succeed");
Expect(!second_cancel, "repeated cancellation should fail");
Expect(queued_result && queued_result->status == TaskStatus::kCancelled, "queued task should cancel");
Expect(!ran, "cancelled queued closure must not execute");
Expect(blocker_result && blocker_result->status == TaskStatus::kCompleted, "blocker should finish");
});
suite.Add("Running task observes stop token", [] {
AsyncExecutor executor{ 1 };
std::latch started{ 1 };
std::atomic<bool> observed_stop{ false };
std::atomic<bool> release_task{ false };
auto handle = executor.Submit("running", [&](std::stop_token stop_token) {
started.count_down();
while (!stop_token.stop_requested() && !release_task.load())
std::this_thread::yield();
observed_stop = stop_token.stop_requested();
return std::optional<std::string>{ "ignored" };
});
started.wait();
const bool cancelled = executor.Cancel("running");
release_task = true;
auto result = handle.Wait();
Expect(cancelled, "ID cancellation should find current task");
Expect(observed_stop, "running task should observe stop token");
Expect(result && result->status == TaskStatus::kCancelled, "running task should finish cancelled");
Expect(!result->value.has_value(), "cancelled task should not expose a value");
});
suite.Add("Does not hold state lock while requesting stop", [] {
AsyncExecutor executor{ 1 };
lsp::scheduler::async_executor::TaskHandle handle;
std::latch allow_callback_registration{ 1 };
std::latch callback_registered{ 1 };
std::atomic<bool> reentrant_cancel_blocked{ false };
std::thread reentrant_cancel;
handle = executor.Submit("stop.callback", [&](std::stop_token stop_token) {
allow_callback_registration.wait();
std::stop_callback callback(stop_token, [&] {
auto reentrant_done = std::make_shared<std::promise<void>>();
auto reentrant_future = reentrant_done->get_future();
reentrant_cancel = std::thread([&, reentrant_done] {
handle.Cancel();
reentrant_done->set_value();
});
reentrant_cancel_blocked = reentrant_future.wait_for(20ms) == std::future_status::timeout;
});
callback_registered.count_down();
while (!stop_token.stop_requested())
std::this_thread::yield();
return std::optional<std::string>{};
});
allow_callback_registration.count_down();
callback_registered.wait();
const bool cancelled = handle.Cancel();
reentrant_cancel.join();
auto result = handle.Wait();
Expect(cancelled, "initial cancellation should succeed");
Expect(!reentrant_cancel_blocked, "stop callback should reenter cancellation without blocking on state lock");
Expect(result && result->status == TaskStatus::kCancelled, "task should finish cancelled");
});
suite.Add("Old same-ID handle cannot cancel replacement", [] {
AsyncExecutor executor{ 2 };
std::latch first_started{ 1 };
std::atomic<bool> release_first{ false };
auto first = executor.Submit("duplicate", [&](std::stop_token stop_token) {
first_started.count_down();
while (!stop_token.stop_requested() && !release_first.load())
std::this_thread::yield();
return std::optional<std::string>{ "first" };
});
first_started.wait();
std::latch second_started{ 1 };
std::latch release_second{ 1 };
std::atomic<bool> second_saw_stop{ false };
auto second = executor.Submit("duplicate", [&](std::stop_token stop_token) {
second_started.count_down();
release_second.wait();
second_saw_stop = stop_token.stop_requested();
return std::optional<std::string>{ "second" };
});
second_started.wait();
const bool old_cancel = first.Cancel();
release_first = true;
release_second.count_down();
auto first_result = first.Wait();
auto second_result = second.Wait();
Expect(!old_cancel, "already replaced task should reject repeated cancellation");
Expect(first_result && first_result->status == TaskStatus::kCancelled, "replaced task should cancel");
Expect(second_result && second_result->status == TaskStatus::kCompleted, "replacement should complete");
Expect(!second_saw_stop, "old handle must not stop replacement");
});
suite.Add("Counts every active same-ID instance", [] {
AsyncExecutor executor{ 2 };
std::latch first_started{ 1 };
std::latch second_started{ 1 };
std::latch release_tasks{ 1 };
auto first = executor.Submit("same", [&](std::stop_token) {
first_started.count_down();
release_tasks.wait();
return std::optional<std::string>{};
});
first_started.wait();
auto second = executor.Submit("same", [&](std::stop_token) {
second_started.count_down();
release_tasks.wait();
return std::optional<std::string>{};
});
second_started.wait();
const auto active_count = executor.GetRunningTaskCount();
release_tasks.count_down();
executor.WaitAll();
Expect(active_count == 2, "both same-ID instances should be active");
Expect(executor.GetRunningTaskCount() == 0, "all instances should unregister");
Expect(first.Wait().has_value() && second.Wait().has_value(), "both handles should retain results");
});
suite.Add("WaitAll observes a task before Taskflow submission", [] {
AsyncExecutor executor{ 1 };
std::latch callback_copy_started{ 1 };
std::latch release_callback_copy{ 1 };
AsyncExecutor::TaskCallback callback{
BlockingCallbackCopy(callback_copy_started, release_callback_copy)
};
auto submitter = std::async(std::launch::async, [&] {
return executor.Submit(
"submission.window",
[](std::stop_token) { return std::optional<std::string>{}; },
std::move(callback));
});
callback_copy_started.wait();
auto waiter = std::async(std::launch::async, [&] { executor.WaitAll(); });
const bool waited_for_registered_task = waiter.wait_for(20ms) == std::future_status::timeout;
release_callback_copy.count_down();
auto handle = submitter.get();
waiter.get();
auto result = handle.Wait();
Expect(waited_for_registered_task, "WaitAll should not return while a registered task is being submitted");
Expect(result && result->status == TaskStatus::kCompleted, "submitted task should complete");
});
suite.Add("Normalizes zero concurrency", [] {
AsyncExecutor executor{ 0 };
auto result = executor.Submit("zero", [](std::stop_token) {
return std::optional<std::string>{ "done" };
})
.Wait();
Expect(result && result->status == TaskStatus::kCompleted, "zero concurrency should use one worker");
});
suite.Add("Preserves task exception", [] {
AsyncExecutor executor{ 1 };
auto result = executor.Submit("failure", [](std::stop_token) -> std::optional<std::string> {
throw std::logic_error("original failure");
})
.Wait();
Expect(result && result->status == TaskStatus::kFailed, "throwing task should fail");
Expect(result->error != nullptr, "failed task should retain exception");
try
{ {
std::lock_guard<std::mutex> lk(callback_mutex); std::rethrow_exception(result->error);
Expect(callback_result.has_value(), "Task result should be reported by callback");
Expect(!callback_cancelled, "Callback should not be marked cancelled");
Expect(callback_result.value() == "done", "Task result should match");
} }
catch (const std::logic_error& e)
executor.WaitAll();
auto stats = executor.GetStatistics();
Expect(stats.completed == 1, "Completed count should be 1");
Expect(stats.cancelled == 0, "Cancelled count should be 0");
Expect(stats.failed == 0, "Failed count should be 0");
});
suite.Add("Cancels running task via handle", [] {
lsp::scheduler::AsyncExecutor executor(1);
std::atomic<bool> callback_cancelled{ false };
auto handle = executor.Submit("task.cancel", []() -> std::optional<std::string> {
std::this_thread::sleep_for(50ms);
return std::string("late"); }, [&](const std::optional<std::string>&, bool cancelled) { callback_cancelled.store(cancelled, std::memory_order_relaxed); });
std::this_thread::sleep_for(10ms);
Expect(handle.Cancel(), "Handle cancel should report success");
Expect(handle.Wait(), "Wait after cancellation should still succeed");
executor.WaitAll();
Expect(callback_cancelled.load(std::memory_order_relaxed), "Callback should observe cancellation");
auto stats = executor.GetStatistics();
Expect(stats.cancelled == 1, "Cancelled count should be 1");
});
suite.Add("Replaces existing task with same id", [] {
lsp::scheduler::AsyncExecutor executor(2);
std::atomic<bool> first_cancelled{ false };
auto first = executor.Submit("task.duplicate", []() -> std::optional<std::string> {
std::this_thread::sleep_for(30ms);
return std::string("first"); }, [&](const std::optional<std::string>&, bool cancelled) {
if (cancelled)
first_cancelled.store(true, std::memory_order_relaxed); });
std::this_thread::sleep_for(5ms);
std::atomic<bool> second_completed{ false };
auto second = executor.Submit("task.duplicate", [&]() -> std::optional<std::string> {
std::this_thread::sleep_for(20ms);
second_completed.store(true, std::memory_order_relaxed);
return std::string("second");
});
Expect(second.Wait(), "Second handle should finish");
Expect(first.Wait(), "First handle should finish");
executor.WaitAll();
Expect(first_cancelled.load(std::memory_order_relaxed), "First callback should report cancellation");
auto stats = executor.GetStatistics();
Expect(stats.completed == 1, "One task should complete successfully");
Expect(stats.cancelled >= 1, "At least one task should be cancelled");
Expect(second_completed.load(std::memory_order_relaxed), "Second task body should run");
});
suite.Add("Handles many concurrent submissions", [] {
constexpr int kTaskCount = 32;
lsp::scheduler::AsyncExecutor executor(8);
std::atomic<int> callback_count{ 0 };
for (int i = 0; i < kTaskCount; ++i)
{ {
executor.Submit("task." + std::to_string(i), [i]() -> std::optional<std::string> { Expect(std::string_view(e.what()) == "original failure", "original exception should be preserved");
std::this_thread::sleep_for(2ms);
return std::to_string(i * i); }, [&](const std::optional<std::string>& result, bool cancelled) {
Expect(!cancelled, "Concurrent tasks should not be cancelled");
Expect(result.has_value(), "Concurrent task should produce a result");
callback_count.fetch_add(1, std::memory_order_relaxed); });
} }
});
suite.Add("Ignores callback exception in task result", [] {
AsyncExecutor executor{ 1 };
auto handle = executor.Submit(
"callback.failure",
[](std::stop_token) { return std::optional<std::string>{ "done" }; },
[](const lsp::scheduler::async_executor::TaskResult&) {
throw std::runtime_error("callback failure");
});
auto result = handle.Wait();
Expect(result && result->status == TaskStatus::kCompleted, "callback failure should not alter task status");
Expect(result->value == "done", "callback failure should not alter task value");
Expect(result->error == nullptr, "callback failure should not become task error");
});
suite.Add("Reports terminal metrics", [] {
AsyncExecutor executor{ 1 };
std::latch blocker_started{ 1 };
std::latch release_blocker{ 1 };
auto completed = executor.Submit("complete", [&](std::stop_token) {
blocker_started.count_down();
release_blocker.wait();
return std::optional<std::string>{ "done" };
});
blocker_started.wait();
auto cancelled = executor.Submit("cancel", [](std::stop_token) {
return std::optional<std::string>{};
});
auto failed = executor.Submit("fail", [](std::stop_token) -> std::optional<std::string> {
throw std::runtime_error("failed");
});
const bool cancel_requested = cancelled.Cancel();
release_blocker.count_down();
executor.WaitAll(); executor.WaitAll();
auto stats = executor.GetStatistics();
Expect(stats.completed == kTaskCount, "All concurrent tasks should complete"); const auto metrics = executor.GetStatistics();
Expect(stats.cancelled == 0 && stats.failed == 0, "No concurrent tasks should fail or cancel"); Expect(cancel_requested, "queued task cancellation should succeed");
Expect(callback_count.load(std::memory_order_relaxed) == kTaskCount, "Callbacks should run for every task"); Expect(completed.Wait()->status == TaskStatus::kCompleted, "completed status should match metrics");
Expect(cancelled.Wait()->status == TaskStatus::kCancelled, "cancelled status should match metrics");
Expect(failed.Wait()->status == TaskStatus::kFailed, "failed status should match metrics");
Expect(metrics.running == 0, "no task should remain active");
Expect(metrics.submitted == 3, "submitted count should be 3");
Expect(metrics.completed == 1, "completed count should be 1");
Expect(metrics.cancelled == 1, "cancelled count should be 1");
Expect(metrics.failed == 1, "failed count should be 1");
}); });
const int failures = suite.RunAll(); const int failures = suite.RunAll();
return failures == 0 ? 0 : 1; return failures == 0 ? 0 : 1;
}
} }