1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694
|
//===----- RPCUTils.h - Basic tilities for building RPC APIs ----*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// Basic utilities for building RPC APIs.
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_EXECUTIONENGINE_ORC_RPCUTILS_H
#define LLVM_EXECUTIONENGINE_ORC_RPCUTILS_H
#include <map>
#include <vector>
#include "llvm/ADT/Optional.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ExecutionEngine/Orc/OrcError.h"
#ifdef _MSC_VER
// concrt.h depends on eh.h for __uncaught_exception declaration
// even if we disable exceptions.
#include <eh.h>
// Disable warnings from ppltasks.h transitively included by <future>.
#pragma warning(push)
#pragma warning(disable : 4530)
#pragma warning(disable : 4062)
#endif
#include <future>
#ifdef _MSC_VER
#pragma warning(pop)
#endif
namespace llvm {
namespace orc {
namespace remote {
/// Describes reserved RPC Function Ids.
///
/// The default implementation will serve for integer and enum function id
/// types. If you want to use a custom type as your FunctionId you can
/// specialize this class and provide unique values for InvalidId,
/// ResponseId and FirstValidId.
template <typename T> class RPCFunctionIdTraits {
public:
static const T InvalidId = static_cast<T>(0);
static const T ResponseId = static_cast<T>(1);
static const T FirstValidId = static_cast<T>(2);
};
// Base class containing utilities that require partial specialization.
// These cannot be included in RPC, as template class members cannot be
// partially specialized.
class RPCBase {
protected:
// RPC Function description type.
//
// This class provides the information and operations needed to support the
// RPC primitive operations (call, expect, etc) for a given function. It
// is specialized for void and non-void functions to deal with the differences
// betwen the two. Both specializations have the same interface:
//
// Id - The function's unique identifier.
// OptionalReturn - The return type for asyncronous calls.
// ErrorReturn - The return type for synchronous calls.
// optionalToErrorReturn - Conversion from a valid OptionalReturn to an
// ErrorReturn.
// readResult - Deserialize a result from a channel.
// abandon - Abandon a promised (asynchronous) result.
// respond - Retun a result on the channel.
template <typename FunctionIdT, FunctionIdT FuncId, typename FnT>
class FunctionHelper {};
// RPC Function description specialization for non-void functions.
template <typename FunctionIdT, FunctionIdT FuncId, typename RetT,
typename... ArgTs>
class FunctionHelper<FunctionIdT, FuncId, RetT(ArgTs...)> {
public:
static_assert(FuncId != RPCFunctionIdTraits<FunctionIdT>::InvalidId &&
FuncId != RPCFunctionIdTraits<FunctionIdT>::ResponseId,
"Cannot define custom function with InvalidId or ResponseId. "
"Please use RPCFunctionTraits<FunctionIdT>::FirstValidId.");
static const FunctionIdT Id = FuncId;
typedef Optional<RetT> OptionalReturn;
typedef Expected<RetT> ErrorReturn;
static ErrorReturn optionalToErrorReturn(OptionalReturn &&V) {
assert(V && "Return value not available");
return std::move(*V);
}
template <typename ChannelT>
static Error readResult(ChannelT &C, std::promise<OptionalReturn> &P) {
RetT Val;
auto Err = deserialize(C, Val);
auto Err2 = endReceiveMessage(C);
Err = joinErrors(std::move(Err), std::move(Err2));
if (Err) {
P.set_value(OptionalReturn());
return Err;
}
P.set_value(std::move(Val));
return Error::success();
}
static void abandon(std::promise<OptionalReturn> &P) {
P.set_value(OptionalReturn());
}
template <typename ChannelT, typename SequenceNumberT>
static Error respond(ChannelT &C, SequenceNumberT SeqNo,
ErrorReturn &Result) {
FunctionIdT ResponseId = RPCFunctionIdTraits<FunctionIdT>::ResponseId;
// If the handler returned an error then bail out with that.
if (!Result)
return Result.takeError();
// Otherwise open a new message on the channel and send the result.
if (auto Err = startSendMessage(C))
return Err;
if (auto Err = serializeSeq(C, ResponseId, SeqNo, *Result))
return Err;
return endSendMessage(C);
}
};
// RPC Function description specialization for void functions.
template <typename FunctionIdT, FunctionIdT FuncId, typename... ArgTs>
class FunctionHelper<FunctionIdT, FuncId, void(ArgTs...)> {
public:
static_assert(FuncId != RPCFunctionIdTraits<FunctionIdT>::InvalidId &&
FuncId != RPCFunctionIdTraits<FunctionIdT>::ResponseId,
"Cannot define custom function with InvalidId or ResponseId. "
"Please use RPCFunctionTraits<FunctionIdT>::FirstValidId.");
static const FunctionIdT Id = FuncId;
typedef bool OptionalReturn;
typedef Error ErrorReturn;
static ErrorReturn optionalToErrorReturn(OptionalReturn &&V) {
assert(V && "Return value not available");
return Error::success();
}
template <typename ChannelT>
static Error readResult(ChannelT &C, std::promise<OptionalReturn> &P) {
// Void functions don't have anything to deserialize, so we're good.
P.set_value(true);
return endReceiveMessage(C);
}
static void abandon(std::promise<OptionalReturn> &P) { P.set_value(false); }
template <typename ChannelT, typename SequenceNumberT>
static Error respond(ChannelT &C, SequenceNumberT SeqNo,
ErrorReturn &Result) {
const FunctionIdT ResponseId =
RPCFunctionIdTraits<FunctionIdT>::ResponseId;
// If the handler returned an error then bail out with that.
if (Result)
return std::move(Result);
// Otherwise open a new message on the channel and send the result.
if (auto Err = startSendMessage(C))
return Err;
if (auto Err = serializeSeq(C, ResponseId, SeqNo))
return Err;
return endSendMessage(C);
}
};
// Helper for the call primitive.
template <typename ChannelT, typename SequenceNumberT, typename Func>
class CallHelper;
template <typename ChannelT, typename SequenceNumberT, typename FunctionIdT,
FunctionIdT FuncId, typename RetT, typename... ArgTs>
class CallHelper<ChannelT, SequenceNumberT,
FunctionHelper<FunctionIdT, FuncId, RetT(ArgTs...)>> {
public:
static Error call(ChannelT &C, SequenceNumberT SeqNo,
const ArgTs &... Args) {
if (auto Err = startSendMessage(C))
return Err;
if (auto Err = serializeSeq(C, FuncId, SeqNo, Args...))
return Err;
return endSendMessage(C);
}
};
// Helper for handle primitive.
template <typename ChannelT, typename SequenceNumberT, typename Func>
class HandlerHelper;
template <typename ChannelT, typename SequenceNumberT, typename FunctionIdT,
FunctionIdT FuncId, typename RetT, typename... ArgTs>
class HandlerHelper<ChannelT, SequenceNumberT,
FunctionHelper<FunctionIdT, FuncId, RetT(ArgTs...)>> {
public:
template <typename HandlerT>
static Error handle(ChannelT &C, HandlerT Handler) {
return readAndHandle(C, Handler, llvm::index_sequence_for<ArgTs...>());
}
private:
typedef FunctionHelper<FunctionIdT, FuncId, RetT(ArgTs...)> Func;
template <typename HandlerT, size_t... Is>
static Error readAndHandle(ChannelT &C, HandlerT Handler,
llvm::index_sequence<Is...> _) {
std::tuple<ArgTs...> RPCArgs;
SequenceNumberT SeqNo;
// GCC 4.7 and 4.8 incorrectly issue a -Wunused-but-set-variable warning
// for RPCArgs. Void cast RPCArgs to work around this for now.
// FIXME: Remove this workaround once we can assume a working GCC version.
(void)RPCArgs;
if (auto Err = deserializeSeq(C, SeqNo, std::get<Is>(RPCArgs)...))
return Err;
// We've deserialized the arguments, so unlock the channel for reading
// before we call the handler. This allows recursive RPC calls.
if (auto Err = endReceiveMessage(C))
return Err;
// Run the handler and get the result.
auto Result = Handler(std::get<Is>(RPCArgs)...);
// Return the result to the client.
return Func::template respond<ChannelT, SequenceNumberT>(C, SeqNo,
Result);
}
};
// Helper for wrapping member functions up as functors.
template <typename ClassT, typename RetT, typename... ArgTs>
class MemberFnWrapper {
public:
typedef RetT (ClassT::*MethodT)(ArgTs...);
MemberFnWrapper(ClassT &Instance, MethodT Method)
: Instance(Instance), Method(Method) {}
RetT operator()(ArgTs &... Args) { return (Instance.*Method)(Args...); }
private:
ClassT &Instance;
MethodT Method;
};
// Helper that provides a Functor for deserializing arguments.
template <typename... ArgTs> class ReadArgs {
public:
Error operator()() { return Error::success(); }
};
template <typename ArgT, typename... ArgTs>
class ReadArgs<ArgT, ArgTs...> : public ReadArgs<ArgTs...> {
public:
ReadArgs(ArgT &Arg, ArgTs &... Args)
: ReadArgs<ArgTs...>(Args...), Arg(Arg) {}
Error operator()(ArgT &ArgVal, ArgTs &... ArgVals) {
this->Arg = std::move(ArgVal);
return ReadArgs<ArgTs...>::operator()(ArgVals...);
}
private:
ArgT &Arg;
};
};
/// Contains primitive utilities for defining, calling and handling calls to
/// remote procedures. ChannelT is a bidirectional stream conforming to the
/// RPCChannel interface (see RPCChannel.h), and FunctionIdT is a procedure
/// identifier type that must be serializable on ChannelT.
///
/// These utilities support the construction of very primitive RPC utilities.
/// Their intent is to ensure correct serialization and deserialization of
/// procedure arguments, and to keep the client and server's view of the API in
/// sync.
///
/// These utilities do not support return values. These can be handled by
/// declaring a corresponding '.*Response' procedure and expecting it after a
/// call). They also do not support versioning: the client and server *must* be
/// compiled with the same procedure definitions.
///
///
///
/// Overview (see comments individual types/methods for details):
///
/// Function<Id, Args...> :
///
/// associates a unique serializable id with an argument list.
///
///
/// call<Func>(Channel, Args...) :
///
/// Calls the remote procedure 'Func' by serializing Func's id followed by its
/// arguments and sending the resulting bytes to 'Channel'.
///
///
/// handle<Func>(Channel, <functor matching Error(Args...)> :
///
/// Handles a call to 'Func' by deserializing its arguments and calling the
/// given functor. This assumes that the id for 'Func' has already been
/// deserialized.
///
/// expect<Func>(Channel, <functor matching Error(Args...)> :
///
/// The same as 'handle', except that the procedure id should not have been
/// read yet. Expect will deserialize the id and assert that it matches Func's
/// id. If it does not, and unexpected RPC call error is returned.
template <typename ChannelT, typename FunctionIdT = uint32_t,
typename SequenceNumberT = uint16_t>
class RPC : public RPCBase {
public:
/// RPC default constructor.
RPC() = default;
/// RPC instances cannot be copied.
RPC(const RPC &) = delete;
/// RPC instances cannot be copied.
RPC &operator=(const RPC &) = delete;
/// RPC move constructor.
// FIXME: Remove once MSVC can synthesize move ops.
RPC(RPC &&Other)
: SequenceNumberMgr(std::move(Other.SequenceNumberMgr)),
OutstandingResults(std::move(Other.OutstandingResults)) {}
/// RPC move assignment.
// FIXME: Remove once MSVC can synthesize move ops.
RPC &operator=(RPC &&Other) {
SequenceNumberMgr = std::move(Other.SequenceNumberMgr);
OutstandingResults = std::move(Other.OutstandingResults);
return *this;
}
/// Utility class for defining/referring to RPC procedures.
///
/// Typedefs of this utility are used when calling/handling remote procedures.
///
/// FuncId should be a unique value of FunctionIdT (i.e. not used with any
/// other Function typedef in the RPC API being defined.
///
/// the template argument Ts... gives the argument list for the remote
/// procedure.
///
/// E.g.
///
/// typedef Function<0, bool> Func1;
/// typedef Function<1, std::string, std::vector<int>> Func2;
///
/// if (auto Err = call<Func1>(Channel, true))
/// /* handle Err */;
///
/// if (auto Err = expect<Func2>(Channel,
/// [](std::string &S, std::vector<int> &V) {
/// // Stuff.
/// return Error::success();
/// })
/// /* handle Err */;
///
template <FunctionIdT FuncId, typename FnT>
using Function = FunctionHelper<FunctionIdT, FuncId, FnT>;
/// Return type for asynchronous call primitives.
template <typename Func>
using AsyncCallResult = std::future<typename Func::OptionalReturn>;
/// Return type for asynchronous call-with-seq primitives.
template <typename Func>
using AsyncCallWithSeqResult =
std::pair<std::future<typename Func::OptionalReturn>, SequenceNumberT>;
/// Serialize Args... to channel C, but do not call C.send().
///
/// Returns an error (on serialization failure) or a pair of:
/// (1) A future Optional<T> (or future<bool> for void functions), and
/// (2) A sequence number.
///
/// This utility function is primarily used for single-threaded mode support,
/// where the sequence number can be used to wait for the corresponding
/// result. In multi-threaded mode the appendCallAsync method, which does not
/// return the sequence numeber, should be preferred.
template <typename Func, typename... ArgTs>
Expected<AsyncCallWithSeqResult<Func>>
appendCallAsyncWithSeq(ChannelT &C, const ArgTs &... Args) {
auto SeqNo = SequenceNumberMgr.getSequenceNumber();
std::promise<typename Func::OptionalReturn> Promise;
auto Result = Promise.get_future();
OutstandingResults[SeqNo] =
createOutstandingResult<Func>(std::move(Promise));
if (auto Err = CallHelper<ChannelT, SequenceNumberT, Func>::call(C, SeqNo,
Args...)) {
abandonOutstandingResults();
return std::move(Err);
} else
return AsyncCallWithSeqResult<Func>(std::move(Result), SeqNo);
}
/// The same as appendCallAsyncWithSeq, except that it calls C.send() to
/// flush the channel after serializing the call.
template <typename Func, typename... ArgTs>
Expected<AsyncCallWithSeqResult<Func>>
callAsyncWithSeq(ChannelT &C, const ArgTs &... Args) {
auto Result = appendCallAsyncWithSeq<Func>(C, Args...);
if (!Result)
return Result;
if (auto Err = C.send()) {
abandonOutstandingResults();
return std::move(Err);
}
return Result;
}
/// Serialize Args... to channel C, but do not call send.
/// Returns an error if serialization fails, otherwise returns a
/// std::future<Optional<T>> (or a future<bool> for void functions).
template <typename Func, typename... ArgTs>
Expected<AsyncCallResult<Func>> appendCallAsync(ChannelT &C,
const ArgTs &... Args) {
auto ResAndSeqOrErr = appendCallAsyncWithSeq<Func>(C, Args...);
if (ResAndSeqOrErr)
return std::move(ResAndSeqOrErr->first);
return ResAndSeqOrErr.getError();
}
/// The same as appendCallAsync, except that it calls C.send to flush the
/// channel after serializing the call.
template <typename Func, typename... ArgTs>
Expected<AsyncCallResult<Func>> callAsync(ChannelT &C,
const ArgTs &... Args) {
auto ResAndSeqOrErr = callAsyncWithSeq<Func>(C, Args...);
if (ResAndSeqOrErr)
return std::move(ResAndSeqOrErr->first);
return ResAndSeqOrErr.getError();
}
/// This can be used in single-threaded mode.
template <typename Func, typename HandleFtor, typename... ArgTs>
typename Func::ErrorReturn
callSTHandling(ChannelT &C, HandleFtor &HandleOther, const ArgTs &... Args) {
if (auto ResultAndSeqNoOrErr = callAsyncWithSeq<Func>(C, Args...)) {
auto &ResultAndSeqNo = *ResultAndSeqNoOrErr;
if (auto Err = waitForResult(C, ResultAndSeqNo.second, HandleOther))
return std::move(Err);
return Func::optionalToErrorReturn(ResultAndSeqNo.first.get());
} else
return ResultAndSeqNoOrErr.takeError();
}
// This can be used in single-threaded mode.
template <typename Func, typename... ArgTs>
typename Func::ErrorReturn callST(ChannelT &C, const ArgTs &... Args) {
return callSTHandling<Func>(C, handleNone, Args...);
}
/// Start receiving a new function call.
///
/// Calls startReceiveMessage on the channel, then deserializes a FunctionId
/// into Id.
Error startReceivingFunction(ChannelT &C, FunctionIdT &Id) {
if (auto Err = startReceiveMessage(C))
return Err;
return deserialize(C, Id);
}
/// Deserialize args for Func from C and call Handler. The signature of
/// handler must conform to 'Error(Args...)' where Args... matches
/// the arguments used in the Func typedef.
template <typename Func, typename HandlerT>
static Error handle(ChannelT &C, HandlerT Handler) {
return HandlerHelper<ChannelT, SequenceNumberT, Func>::handle(C, Handler);
}
/// Helper version of 'handle' for calling member functions.
template <typename Func, typename ClassT, typename RetT, typename... ArgTs>
static Error handle(ChannelT &C, ClassT &Instance,
RetT (ClassT::*HandlerMethod)(ArgTs...)) {
return handle<Func>(
C, MemberFnWrapper<ClassT, RetT, ArgTs...>(Instance, HandlerMethod));
}
/// Deserialize a FunctionIdT from C and verify it matches the id for Func.
/// If the id does match, deserialize the arguments and call the handler
/// (similarly to handle).
/// If the id does not match, return an unexpect RPC call error and do not
/// deserialize any further bytes.
template <typename Func, typename HandlerT>
Error expect(ChannelT &C, HandlerT Handler) {
FunctionIdT FuncId;
if (auto Err = startReceivingFunction(C, FuncId))
return std::move(Err);
if (FuncId != Func::Id)
return orcError(OrcErrorCode::UnexpectedRPCCall);
return handle<Func>(C, Handler);
}
/// Helper version of expect for calling member functions.
template <typename Func, typename ClassT, typename... ArgTs>
static Error expect(ChannelT &C, ClassT &Instance,
Error (ClassT::*HandlerMethod)(ArgTs...)) {
return expect<Func>(
C, MemberFnWrapper<ClassT, ArgTs...>(Instance, HandlerMethod));
}
/// Helper for handling setter procedures - this method returns a functor that
/// sets the variables referred to by Args... to values deserialized from the
/// channel.
/// E.g.
///
/// typedef Function<0, bool, int> Func1;
///
/// ...
/// bool B;
/// int I;
/// if (auto Err = expect<Func1>(Channel, readArgs(B, I)))
/// /* Handle Args */ ;
///
template <typename... ArgTs>
static ReadArgs<ArgTs...> readArgs(ArgTs &... Args) {
return ReadArgs<ArgTs...>(Args...);
}
/// Read a response from Channel.
/// This should be called from the receive loop to retrieve results.
Error handleResponse(ChannelT &C, SequenceNumberT *SeqNoRet = nullptr) {
SequenceNumberT SeqNo;
if (auto Err = deserialize(C, SeqNo)) {
abandonOutstandingResults();
return Err;
}
if (SeqNoRet)
*SeqNoRet = SeqNo;
auto I = OutstandingResults.find(SeqNo);
if (I == OutstandingResults.end()) {
abandonOutstandingResults();
return orcError(OrcErrorCode::UnexpectedRPCResponse);
}
if (auto Err = I->second->readResult(C)) {
abandonOutstandingResults();
// FIXME: Release sequence numbers?
return Err;
}
OutstandingResults.erase(I);
SequenceNumberMgr.releaseSequenceNumber(SeqNo);
return Error::success();
}
// Loop waiting for a result with the given sequence number.
// This can be used as a receive loop if the user doesn't have a default.
template <typename HandleOtherFtor>
Error waitForResult(ChannelT &C, SequenceNumberT TgtSeqNo,
HandleOtherFtor &HandleOther = handleNone) {
bool GotTgtResult = false;
while (!GotTgtResult) {
FunctionIdT Id = RPCFunctionIdTraits<FunctionIdT>::InvalidId;
if (auto Err = startReceivingFunction(C, Id))
return Err;
if (Id == RPCFunctionIdTraits<FunctionIdT>::ResponseId) {
SequenceNumberT SeqNo;
if (auto Err = handleResponse(C, &SeqNo))
return Err;
GotTgtResult = (SeqNo == TgtSeqNo);
} else if (auto Err = HandleOther(C, Id))
return Err;
}
return Error::success();
}
// Default handler for 'other' (non-response) functions when waiting for a
// result from the channel.
static Error handleNone(ChannelT &, FunctionIdT) {
return orcError(OrcErrorCode::UnexpectedRPCCall);
};
private:
// Manage sequence numbers.
class SequenceNumberManager {
public:
SequenceNumberManager() = default;
SequenceNumberManager(const SequenceNumberManager &) = delete;
SequenceNumberManager &operator=(const SequenceNumberManager &) = delete;
SequenceNumberManager(SequenceNumberManager &&Other)
: NextSequenceNumber(std::move(Other.NextSequenceNumber)),
FreeSequenceNumbers(std::move(Other.FreeSequenceNumbers)) {}
SequenceNumberManager &operator=(SequenceNumberManager &&Other) {
NextSequenceNumber = std::move(Other.NextSequenceNumber);
FreeSequenceNumbers = std::move(Other.FreeSequenceNumbers);
}
void reset() {
std::lock_guard<std::mutex> Lock(SeqNoLock);
NextSequenceNumber = 0;
FreeSequenceNumbers.clear();
}
SequenceNumberT getSequenceNumber() {
std::lock_guard<std::mutex> Lock(SeqNoLock);
if (FreeSequenceNumbers.empty())
return NextSequenceNumber++;
auto SequenceNumber = FreeSequenceNumbers.back();
FreeSequenceNumbers.pop_back();
return SequenceNumber;
}
void releaseSequenceNumber(SequenceNumberT SequenceNumber) {
std::lock_guard<std::mutex> Lock(SeqNoLock);
FreeSequenceNumbers.push_back(SequenceNumber);
}
private:
std::mutex SeqNoLock;
SequenceNumberT NextSequenceNumber = 0;
std::vector<SequenceNumberT> FreeSequenceNumbers;
};
// Base class for results that haven't been returned from the other end of the
// RPC connection yet.
class OutstandingResult {
public:
virtual ~OutstandingResult() {}
virtual Error readResult(ChannelT &C) = 0;
virtual void abandon() = 0;
};
// Outstanding results for a specific function.
template <typename Func>
class OutstandingResultImpl : public OutstandingResult {
private:
public:
OutstandingResultImpl(std::promise<typename Func::OptionalReturn> &&P)
: P(std::move(P)) {}
Error readResult(ChannelT &C) override { return Func::readResult(C, P); }
void abandon() override { Func::abandon(P); }
private:
std::promise<typename Func::OptionalReturn> P;
};
// Create an outstanding result for the given function.
template <typename Func>
std::unique_ptr<OutstandingResult>
createOutstandingResult(std::promise<typename Func::OptionalReturn> &&P) {
return llvm::make_unique<OutstandingResultImpl<Func>>(std::move(P));
}
// Abandon all outstanding results.
void abandonOutstandingResults() {
for (auto &KV : OutstandingResults)
KV.second->abandon();
OutstandingResults.clear();
SequenceNumberMgr.reset();
}
SequenceNumberManager SequenceNumberMgr;
std::map<SequenceNumberT, std::unique_ptr<OutstandingResult>>
OutstandingResults;
};
} // end namespace remote
} // end namespace orc
} // end namespace llvm
#endif
|