96e7fc2c9a
The name "Service" better reflects the general purpose of this class: It provides *something* (often resource management) to the Session, is owned by the Session, and receives notifications from the Session when the controller detaches / is detached, and when the Session is shut down. An example of a non-resource-managing Service (to be added in an upcoming patch) is a detach / shutdown notification service: Clients can add this service to register arbitrary callbacks to be run on detach / shutdown. The advantage of this over the current Session detach / shutdown callback system is that clients can control both the order of the callbacks, and their order relative to notification of other services.
127 lines
3.9 KiB
C++
127 lines
3.9 KiB
C++
//===- Session.cpp --------------------------------------------------------===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// Contains the implementation of the Session class and related APIs.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "orc-rt/Session.h"
|
|
|
|
namespace orc_rt {
|
|
|
|
Session::ControllerAccess::~ControllerAccess() = default;
|
|
|
|
Session::~Session() { waitForShutdown(); }
|
|
|
|
void Session::shutdown(OnShutdownCompleteFn OnShutdownComplete) {
|
|
assert(OnShutdownComplete && "OnShutdownComplete must be set");
|
|
|
|
// Safe to call concurrently / redundantly.
|
|
detachFromController();
|
|
|
|
{
|
|
std::scoped_lock<std::mutex> Lock(M);
|
|
if (SI) {
|
|
// SI exists: someone called shutdown already. If the shutdown is not yet
|
|
// complete then just add OnShutdownComplete to the list of pending
|
|
// callbacks for the in-progress shutdown, then return.
|
|
// (If the shutdown is already complete then we'll run the handler
|
|
// directly below).
|
|
if (!SI->Complete)
|
|
return SI->OnCompletes.push_back(std::move(OnShutdownComplete));
|
|
} else {
|
|
// SI does not exist: We're the first to call shutdown. Create a
|
|
// ShutdownInfo struct and add OnShutdownComplete to the list of pending
|
|
// callbacks, then call shutdownNext below (outside the lock).
|
|
SI = std::make_unique<ShutdownInfo>();
|
|
SI->OnCompletes.push_back(std::move(OnShutdownComplete));
|
|
std::swap(SI->Services, Services);
|
|
}
|
|
}
|
|
|
|
// OnShutdownComplete is set (i.e. not moved into the list of pending
|
|
// callbacks). This can only happen if shutdown is already complete. Call
|
|
// OnComplete directly and return.
|
|
if (OnShutdownComplete)
|
|
return OnShutdownComplete();
|
|
|
|
// OnShutdownComplete is _not_ set (i.e. was moved into the list of pending
|
|
// handlers), and we didn't return under the lock above, so we must be
|
|
// responsible for the shutdown. Call shutdownNext.
|
|
shutdownNext(Error::success());
|
|
}
|
|
|
|
void Session::waitForShutdown() {
|
|
std::promise<void> P;
|
|
auto F = P.get_future();
|
|
shutdown([P = std::move(P)]() mutable { P.set_value(); });
|
|
F.get();
|
|
}
|
|
|
|
void Session::addService(std::unique_ptr<Service> Srv) {
|
|
std::scoped_lock<std::mutex> Lock(M);
|
|
assert(!SI && "addService called after shutdown");
|
|
Services.push_back(std::move(Srv));
|
|
}
|
|
|
|
void Session::setController(std::shared_ptr<ControllerAccess> CA) {
|
|
assert(CA && "Cannot attach null controller");
|
|
std::scoped_lock<std::mutex> Lock(M);
|
|
assert(!this->CA && "Cannot re-attach controller");
|
|
assert(!SI && "Cannot attach controller after shutdown");
|
|
this->CA = std::move(CA);
|
|
}
|
|
|
|
void Session::detachFromController() {
|
|
if (auto TmpCA = CA) {
|
|
TmpCA->doDisconnect();
|
|
CA = nullptr;
|
|
}
|
|
}
|
|
|
|
void Session::shutdownNext(Error Err) {
|
|
if (Err)
|
|
reportError(std::move(Err));
|
|
|
|
if (SI->Services.empty())
|
|
return shutdownComplete();
|
|
|
|
// Get the next Service to shut down.
|
|
auto NextSrv = std::move(SI->Services.back());
|
|
SI->Services.pop_back();
|
|
NextSrv->onShutdown([this](Error Err) { shutdownNext(std::move(Err)); });
|
|
}
|
|
|
|
void Session::shutdownComplete() {
|
|
|
|
std::unique_ptr<TaskDispatcher> TmpDispatcher;
|
|
{
|
|
std::scoped_lock<std::mutex> Lock(M);
|
|
TmpDispatcher = std::move(Dispatcher);
|
|
}
|
|
|
|
TmpDispatcher->shutdown();
|
|
|
|
std::vector<OnShutdownCompleteFn> OnCompletes;
|
|
{
|
|
std::scoped_lock<std::mutex> Lock(M);
|
|
SI->Complete = true;
|
|
OnCompletes = std::move(SI->OnCompletes);
|
|
}
|
|
|
|
for (auto &OnShutdownComplete : OnCompletes)
|
|
OnShutdownComplete();
|
|
}
|
|
|
|
void Session::wrapperReturn(orc_rt_SessionRef S, uint64_t CallId,
|
|
orc_rt_WrapperFunctionBuffer ResultBytes) {
|
|
unwrap(S)->sendWrapperResult(CallId, WrapperFunctionBuffer(ResultBytes));
|
|
}
|
|
|
|
} // namespace orc_rt
|