1 //===- llvm/ExecutionEngine/Orc/RPCSerialization.h --------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #ifndef LLVM_EXECUTIONENGINE_ORC_RPCSERIALIZATION_H
11 #define LLVM_EXECUTIONENGINE_ORC_RPCSERIALIZATION_H
14 #include "llvm/Support/thread.h"
29 /// TypeNameSequence is a utility for rendering sequences of types to a string
30 /// by rendering each type, separated by ", ".
31 template <typename... ArgTs> class RPCTypeNameSequence {};
33 /// Render an empty TypeNameSequence to an ostream.
34 template <typename OStream>
35 OStream &operator<<(OStream &OS, const RPCTypeNameSequence<> &V) {
39 /// Render a TypeNameSequence of a single type to an ostream.
40 template <typename OStream, typename ArgT>
41 OStream &operator<<(OStream &OS, const RPCTypeNameSequence<ArgT> &V) {
42 OS << RPCTypeName<ArgT>::getName();
46 /// Render a TypeNameSequence of more than one type to an ostream.
47 template <typename OStream, typename ArgT1, typename ArgT2, typename... ArgTs>
49 operator<<(OStream &OS, const RPCTypeNameSequence<ArgT1, ArgT2, ArgTs...> &V) {
50 OS << RPCTypeName<ArgT1>::getName() << ", "
51 << RPCTypeNameSequence<ArgT2, ArgTs...>();
56 class RPCTypeName<void> {
58 static const char* getName() { return "void"; }
62 class RPCTypeName<int8_t> {
64 static const char* getName() { return "int8_t"; }
68 class RPCTypeName<uint8_t> {
70 static const char* getName() { return "uint8_t"; }
74 class RPCTypeName<int16_t> {
76 static const char* getName() { return "int16_t"; }
80 class RPCTypeName<uint16_t> {
82 static const char* getName() { return "uint16_t"; }
86 class RPCTypeName<int32_t> {
88 static const char* getName() { return "int32_t"; }
92 class RPCTypeName<uint32_t> {
94 static const char* getName() { return "uint32_t"; }
98 class RPCTypeName<int64_t> {
100 static const char* getName() { return "int64_t"; }
104 class RPCTypeName<uint64_t> {
106 static const char* getName() { return "uint64_t"; }
110 class RPCTypeName<bool> {
112 static const char* getName() { return "bool"; }
116 class RPCTypeName<std::string> {
118 static const char* getName() { return "std::string"; }
122 class RPCTypeName<Error> {
124 static const char* getName() { return "Error"; }
127 template <typename T>
128 class RPCTypeName<Expected<T>> {
130 static const char* getName() {
131 std::lock_guard<std::mutex> Lock(NameMutex);
133 raw_string_ostream(Name) << "Expected<"
134 << RPCTypeNameSequence<T>()
140 static std::mutex NameMutex;
141 static std::string Name;
144 template <typename T>
145 std::mutex RPCTypeName<Expected<T>>::NameMutex;
147 template <typename T>
148 std::string RPCTypeName<Expected<T>>::Name;
150 template <typename T1, typename T2>
151 class RPCTypeName<std::pair<T1, T2>> {
153 static const char* getName() {
154 std::lock_guard<std::mutex> Lock(NameMutex);
156 raw_string_ostream(Name) << "std::pair<" << RPCTypeNameSequence<T1, T2>()
161 static std::mutex NameMutex;
162 static std::string Name;
165 template <typename T1, typename T2>
166 std::mutex RPCTypeName<std::pair<T1, T2>>::NameMutex;
167 template <typename T1, typename T2>
168 std::string RPCTypeName<std::pair<T1, T2>>::Name;
170 template <typename... ArgTs>
171 class RPCTypeName<std::tuple<ArgTs...>> {
173 static const char* getName() {
174 std::lock_guard<std::mutex> Lock(NameMutex);
176 raw_string_ostream(Name) << "std::tuple<"
177 << RPCTypeNameSequence<ArgTs...>() << ">";
181 static std::mutex NameMutex;
182 static std::string Name;
185 template <typename... ArgTs>
186 std::mutex RPCTypeName<std::tuple<ArgTs...>>::NameMutex;
187 template <typename... ArgTs>
188 std::string RPCTypeName<std::tuple<ArgTs...>>::Name;
190 template <typename T>
191 class RPCTypeName<std::vector<T>> {
193 static const char*getName() {
194 std::lock_guard<std::mutex> Lock(NameMutex);
196 raw_string_ostream(Name) << "std::vector<" << RPCTypeName<T>::getName()
202 static std::mutex NameMutex;
203 static std::string Name;
206 template <typename T>
207 std::mutex RPCTypeName<std::vector<T>>::NameMutex;
208 template <typename T>
209 std::string RPCTypeName<std::vector<T>>::Name;
211 template <typename T> class RPCTypeName<std::set<T>> {
213 static const char *getName() {
214 std::lock_guard<std::mutex> Lock(NameMutex);
216 raw_string_ostream(Name)
217 << "std::set<" << RPCTypeName<T>::getName() << ">";
222 static std::mutex NameMutex;
223 static std::string Name;
226 template <typename T> std::mutex RPCTypeName<std::set<T>>::NameMutex;
227 template <typename T> std::string RPCTypeName<std::set<T>>::Name;
229 template <typename K, typename V> class RPCTypeName<std::map<K, V>> {
231 static const char *getName() {
232 std::lock_guard<std::mutex> Lock(NameMutex);
234 raw_string_ostream(Name)
235 << "std::map<" << RPCTypeNameSequence<K, V>() << ">";
240 static std::mutex NameMutex;
241 static std::string Name;
244 template <typename K, typename V>
245 std::mutex RPCTypeName<std::map<K, V>>::NameMutex;
246 template <typename K, typename V> std::string RPCTypeName<std::map<K, V>>::Name;
248 /// The SerializationTraits<ChannelT, T> class describes how to serialize and
249 /// deserialize an instance of type T to/from an abstract channel of type
250 /// ChannelT. It also provides a representation of the type's name via the
253 /// Specializations of this class should provide the following functions:
257 /// static const char* getName();
258 /// static Error serialize(ChannelT&, const T&);
259 /// static Error deserialize(ChannelT&, T&);
263 /// The third argument of SerializationTraits is intended to support SFINAE.
268 /// class MyVirtualChannel { ... };
270 /// template <DerivedChannelT>
271 /// class SerializationTraits<DerivedChannelT, bool,
272 /// typename std::enable_if<
273 /// std::is_base_of<VirtChannel, DerivedChannel>::value
276 /// static const char* getName() { ... };
280 template <typename ChannelT, typename WireType,
281 typename ConcreteType = WireType, typename = void>
282 class SerializationTraits;
284 template <typename ChannelT>
285 class SequenceTraits {
287 static Error emitSeparator(ChannelT &C) { return Error::success(); }
288 static Error consumeSeparator(ChannelT &C) { return Error::success(); }
291 /// Utility class for serializing sequences of values of varying types.
292 /// Specializations of this class contain 'serialize' and 'deserialize' methods
293 /// for the given channel. The ArgTs... list will determine the "over-the-wire"
294 /// types to be serialized. The serialize and deserialize methods take a list
295 /// CArgTs... ("caller arg types") which must be the same length as ArgTs...,
296 /// but may be different types from ArgTs, provided that for each CArgT there
297 /// is a SerializationTraits specialization
298 /// SerializeTraits<ChannelT, ArgT, CArgT> with methods that can serialize the
299 /// caller argument to over-the-wire value.
300 template <typename ChannelT, typename... ArgTs>
301 class SequenceSerialization;
303 template <typename ChannelT>
304 class SequenceSerialization<ChannelT> {
306 static Error serialize(ChannelT &C) { return Error::success(); }
307 static Error deserialize(ChannelT &C) { return Error::success(); }
310 template <typename ChannelT, typename ArgT>
311 class SequenceSerialization<ChannelT, ArgT> {
314 template <typename CArgT>
315 static Error serialize(ChannelT &C, CArgT &&CArg) {
316 return SerializationTraits<ChannelT, ArgT,
317 typename std::decay<CArgT>::type>::
318 serialize(C, std::forward<CArgT>(CArg));
321 template <typename CArgT>
322 static Error deserialize(ChannelT &C, CArgT &CArg) {
323 return SerializationTraits<ChannelT, ArgT, CArgT>::deserialize(C, CArg);
327 template <typename ChannelT, typename ArgT, typename... ArgTs>
328 class SequenceSerialization<ChannelT, ArgT, ArgTs...> {
331 template <typename CArgT, typename... CArgTs>
332 static Error serialize(ChannelT &C, CArgT &&CArg,
333 CArgTs &&... CArgs) {
335 SerializationTraits<ChannelT, ArgT, typename std::decay<CArgT>::type>::
336 serialize(C, std::forward<CArgT>(CArg)))
338 if (auto Err = SequenceTraits<ChannelT>::emitSeparator(C))
340 return SequenceSerialization<ChannelT, ArgTs...>::
341 serialize(C, std::forward<CArgTs>(CArgs)...);
344 template <typename CArgT, typename... CArgTs>
345 static Error deserialize(ChannelT &C, CArgT &CArg,
348 SerializationTraits<ChannelT, ArgT, CArgT>::deserialize(C, CArg))
350 if (auto Err = SequenceTraits<ChannelT>::consumeSeparator(C))
352 return SequenceSerialization<ChannelT, ArgTs...>::deserialize(C, CArgs...);
356 template <typename ChannelT, typename... ArgTs>
357 Error serializeSeq(ChannelT &C, ArgTs &&... Args) {
358 return SequenceSerialization<ChannelT, typename std::decay<ArgTs>::type...>::
359 serialize(C, std::forward<ArgTs>(Args)...);
362 template <typename ChannelT, typename... ArgTs>
363 Error deserializeSeq(ChannelT &C, ArgTs &... Args) {
364 return SequenceSerialization<ChannelT, ArgTs...>::deserialize(C, Args...);
367 template <typename ChannelT>
368 class SerializationTraits<ChannelT, Error> {
371 using WrappedErrorSerializer =
372 std::function<Error(ChannelT &C, const ErrorInfoBase&)>;
374 using WrappedErrorDeserializer =
375 std::function<Error(ChannelT &C, Error &Err)>;
377 template <typename ErrorInfoT, typename SerializeFtor,
378 typename DeserializeFtor>
379 static void registerErrorType(std::string Name, SerializeFtor Serialize,
380 DeserializeFtor Deserialize) {
381 assert(!Name.empty() &&
382 "The empty string is reserved for the Success value");
384 const std::string *KeyName = nullptr;
386 // We're abusing the stability of std::map here: We take a reference to the
387 // key of the deserializers map to save us from duplicating the string in
388 // the serializer. This should be changed to use a stringpool if we switch
389 // to a map type that may move keys in memory.
390 std::lock_guard<std::recursive_mutex> Lock(DeserializersMutex);
392 Deserializers.insert(Deserializers.begin(),
393 std::make_pair(std::move(Name),
394 std::move(Deserialize)));
399 assert(KeyName != nullptr && "No keyname pointer");
400 std::lock_guard<std::recursive_mutex> Lock(SerializersMutex);
401 // FIXME: Move capture Serialize once we have C++14.
402 Serializers[ErrorInfoT::classID()] =
403 [KeyName, Serialize](ChannelT &C, const ErrorInfoBase &EIB) -> Error {
404 assert(EIB.dynamicClassID() == ErrorInfoT::classID() &&
405 "Serializer called for wrong error type");
406 if (auto Err = serializeSeq(C, *KeyName))
408 return Serialize(C, static_cast<const ErrorInfoT &>(EIB));
413 static Error serialize(ChannelT &C, Error &&Err) {
414 std::lock_guard<std::recursive_mutex> Lock(SerializersMutex);
417 return serializeSeq(C, std::string());
419 return handleErrors(std::move(Err),
420 [&C](const ErrorInfoBase &EIB) {
421 auto SI = Serializers.find(EIB.dynamicClassID());
422 if (SI == Serializers.end())
423 return serializeAsStringError(C, EIB);
424 return (SI->second)(C, EIB);
428 static Error deserialize(ChannelT &C, Error &Err) {
429 std::lock_guard<std::recursive_mutex> Lock(DeserializersMutex);
432 if (auto Err = deserializeSeq(C, Key))
436 ErrorAsOutParameter EAO(&Err);
437 Err = Error::success();
438 return Error::success();
441 auto DI = Deserializers.find(Key);
442 assert(DI != Deserializers.end() && "No deserializer for error type");
443 return (DI->second)(C, Err);
448 static Error serializeAsStringError(ChannelT &C, const ErrorInfoBase &EIB) {
451 raw_string_ostream ErrMsgStream(ErrMsg);
452 EIB.log(ErrMsgStream);
454 return serialize(C, make_error<StringError>(std::move(ErrMsg),
455 inconvertibleErrorCode()));
458 static std::recursive_mutex SerializersMutex;
459 static std::recursive_mutex DeserializersMutex;
460 static std::map<const void*, WrappedErrorSerializer> Serializers;
461 static std::map<std::string, WrappedErrorDeserializer> Deserializers;
464 template <typename ChannelT>
465 std::recursive_mutex SerializationTraits<ChannelT, Error>::SerializersMutex;
467 template <typename ChannelT>
468 std::recursive_mutex SerializationTraits<ChannelT, Error>::DeserializersMutex;
470 template <typename ChannelT>
471 std::map<const void*,
472 typename SerializationTraits<ChannelT, Error>::WrappedErrorSerializer>
473 SerializationTraits<ChannelT, Error>::Serializers;
475 template <typename ChannelT>
476 std::map<std::string,
477 typename SerializationTraits<ChannelT, Error>::WrappedErrorDeserializer>
478 SerializationTraits<ChannelT, Error>::Deserializers;
480 /// Registers a serializer and deserializer for the given error type on the
481 /// given channel type.
482 template <typename ChannelT, typename ErrorInfoT, typename SerializeFtor,
483 typename DeserializeFtor>
484 void registerErrorSerialization(std::string Name, SerializeFtor &&Serialize,
485 DeserializeFtor &&Deserialize) {
486 SerializationTraits<ChannelT, Error>::template registerErrorType<ErrorInfoT>(
488 std::forward<SerializeFtor>(Serialize),
489 std::forward<DeserializeFtor>(Deserialize));
492 /// Registers serialization/deserialization for StringError.
493 template <typename ChannelT>
494 void registerStringError() {
495 static bool AlreadyRegistered = false;
496 if (!AlreadyRegistered) {
497 registerErrorSerialization<ChannelT, StringError>(
499 [](ChannelT &C, const StringError &SE) {
500 return serializeSeq(C, SE.getMessage());
502 [](ChannelT &C, Error &Err) -> Error {
503 ErrorAsOutParameter EAO(&Err);
505 if (auto E2 = deserializeSeq(C, Msg))
508 make_error<StringError>(std::move(Msg),
510 OrcErrorCode::UnknownErrorCodeFromRemote));
511 return Error::success();
513 AlreadyRegistered = true;
517 /// SerializationTraits for Expected<T1> from an Expected<T2>.
518 template <typename ChannelT, typename T1, typename T2>
519 class SerializationTraits<ChannelT, Expected<T1>, Expected<T2>> {
522 static Error serialize(ChannelT &C, Expected<T2> &&ValOrErr) {
524 if (auto Err = serializeSeq(C, true))
526 return SerializationTraits<ChannelT, T1, T2>::serialize(C, *ValOrErr);
528 if (auto Err = serializeSeq(C, false))
530 return serializeSeq(C, ValOrErr.takeError());
533 static Error deserialize(ChannelT &C, Expected<T2> &ValOrErr) {
534 ExpectedAsOutParameter<T2> EAO(&ValOrErr);
536 if (auto Err = deserializeSeq(C, HasValue))
539 return SerializationTraits<ChannelT, T1, T2>::deserialize(C, *ValOrErr);
540 Error Err = Error::success();
541 if (auto E2 = deserializeSeq(C, Err))
543 ValOrErr = std::move(Err);
544 return Error::success();
548 /// SerializationTraits for Expected<T1> from a T2.
549 template <typename ChannelT, typename T1, typename T2>
550 class SerializationTraits<ChannelT, Expected<T1>, T2> {
553 static Error serialize(ChannelT &C, T2 &&Val) {
554 return serializeSeq(C, Expected<T2>(std::forward<T2>(Val)));
558 /// SerializationTraits for Expected<T1> from an Error.
559 template <typename ChannelT, typename T>
560 class SerializationTraits<ChannelT, Expected<T>, Error> {
563 static Error serialize(ChannelT &C, Error &&Err) {
564 return serializeSeq(C, Expected<T>(std::move(Err)));
568 /// SerializationTraits default specialization for std::pair.
569 template <typename ChannelT, typename T1, typename T2, typename T3, typename T4>
570 class SerializationTraits<ChannelT, std::pair<T1, T2>, std::pair<T3, T4>> {
572 static Error serialize(ChannelT &C, const std::pair<T3, T4> &V) {
573 if (auto Err = SerializationTraits<ChannelT, T1, T3>::serialize(C, V.first))
575 return SerializationTraits<ChannelT, T2, T4>::serialize(C, V.second);
578 static Error deserialize(ChannelT &C, std::pair<T3, T4> &V) {
580 SerializationTraits<ChannelT, T1, T3>::deserialize(C, V.first))
582 return SerializationTraits<ChannelT, T2, T4>::deserialize(C, V.second);
586 /// SerializationTraits default specialization for std::tuple.
587 template <typename ChannelT, typename... ArgTs>
588 class SerializationTraits<ChannelT, std::tuple<ArgTs...>> {
591 /// RPC channel serialization for std::tuple.
592 static Error serialize(ChannelT &C, const std::tuple<ArgTs...> &V) {
593 return serializeTupleHelper(C, V, llvm::index_sequence_for<ArgTs...>());
596 /// RPC channel deserialization for std::tuple.
597 static Error deserialize(ChannelT &C, std::tuple<ArgTs...> &V) {
598 return deserializeTupleHelper(C, V, llvm::index_sequence_for<ArgTs...>());
602 // Serialization helper for std::tuple.
603 template <size_t... Is>
604 static Error serializeTupleHelper(ChannelT &C, const std::tuple<ArgTs...> &V,
605 llvm::index_sequence<Is...> _) {
606 return serializeSeq(C, std::get<Is>(V)...);
609 // Serialization helper for std::tuple.
610 template <size_t... Is>
611 static Error deserializeTupleHelper(ChannelT &C, std::tuple<ArgTs...> &V,
612 llvm::index_sequence<Is...> _) {
613 return deserializeSeq(C, std::get<Is>(V)...);
617 /// SerializationTraits default specialization for std::vector.
618 template <typename ChannelT, typename T>
619 class SerializationTraits<ChannelT, std::vector<T>> {
622 /// Serialize a std::vector<T> from std::vector<T>.
623 static Error serialize(ChannelT &C, const std::vector<T> &V) {
624 if (auto Err = serializeSeq(C, static_cast<uint64_t>(V.size())))
627 for (const auto &E : V)
628 if (auto Err = serializeSeq(C, E))
631 return Error::success();
634 /// Deserialize a std::vector<T> to a std::vector<T>.
635 static Error deserialize(ChannelT &C, std::vector<T> &V) {
637 "Expected default-constructed vector to deserialize into");
640 if (auto Err = deserializeSeq(C, Count))
645 if (auto Err = deserializeSeq(C, E))
648 return Error::success();
652 template <typename ChannelT, typename T, typename T2>
653 class SerializationTraits<ChannelT, std::set<T>, std::set<T2>> {
655 /// Serialize a std::set<T> from std::set<T2>.
656 static Error serialize(ChannelT &C, const std::set<T2> &S) {
657 if (auto Err = serializeSeq(C, static_cast<uint64_t>(S.size())))
660 for (const auto &E : S)
661 if (auto Err = SerializationTraits<ChannelT, T, T2>::serialize(C, E))
664 return Error::success();
667 /// Deserialize a std::set<T> to a std::set<T>.
668 static Error deserialize(ChannelT &C, std::set<T2> &S) {
669 assert(S.empty() && "Expected default-constructed set to deserialize into");
672 if (auto Err = deserializeSeq(C, Count))
675 while (Count-- != 0) {
677 if (auto Err = SerializationTraits<ChannelT, T, T2>::deserialize(C, Val))
680 auto Added = S.insert(Val).second;
682 return make_error<StringError>("Duplicate element in deserialized set",
683 orcError(OrcErrorCode::UnknownORCError));
686 return Error::success();
690 template <typename ChannelT, typename K, typename V, typename K2, typename V2>
691 class SerializationTraits<ChannelT, std::map<K, V>, std::map<K2, V2>> {
693 /// Serialize a std::map<K, V> from std::map<K2, V2>.
694 static Error serialize(ChannelT &C, const std::map<K2, V2> &M) {
695 if (auto Err = serializeSeq(C, static_cast<uint64_t>(M.size())))
698 for (const auto &E : M) {
700 SerializationTraits<ChannelT, K, K2>::serialize(C, E.first))
703 SerializationTraits<ChannelT, V, V2>::serialize(C, E.second))
707 return Error::success();
710 /// Deserialize a std::map<K, V> to a std::map<K, V>.
711 static Error deserialize(ChannelT &C, std::map<K2, V2> &M) {
712 assert(M.empty() && "Expected default-constructed map to deserialize into");
715 if (auto Err = deserializeSeq(C, Count))
718 while (Count-- != 0) {
719 std::pair<K2, V2> Val;
721 SerializationTraits<ChannelT, K, K2>::deserialize(C, Val.first))
725 SerializationTraits<ChannelT, V, V2>::deserialize(C, Val.second))
728 auto Added = M.insert(Val).second;
730 return make_error<StringError>("Duplicate element in deserialized map",
731 orcError(OrcErrorCode::UnknownORCError));
734 return Error::success();
738 } // end namespace rpc
739 } // end namespace orc
740 } // end namespace llvm
742 #endif // LLVM_EXECUTIONENGINE_ORC_RPCSERIALIZATION_H