source/net/protocol.h

   1 #ifndef MSP_NET_PROTOCOL_H_
   2 #define MSP_NET_PROTOCOL_H_
   3
   4 #include <cstdint>
   5 #include <map>
   6 #include <memory>
   7 #include <stdexcept>
   8 #include <vector>
   9 #include <msp/core/hash.h>
  10 #include "mspnet_api.h"
  11 #include "receiver.h"
  12
  13 namespace Msp {
  14 namespace Net {
  15
  16 class MSPNET_API bad_packet: public std::runtime_error
  17 {
  18 public:
  19         bad_packet(const std::string &w): std::runtime_error(w) { }
  20 };
  21
  22
  23 class MSPNET_API buffer_error: public std::runtime_error
  24 {
  25 public:
  26         buffer_error(const std::string &w): std::runtime_error(w) { }
  27 };
  28
  29
  30 class MSPNET_API Protocol
  31 {
  32 public:
  33         struct PacketHeader
  34         {
  35                 std::uint16_t type = 0;
  36                 std::uint16_t length = 0;
  37
  38                 PacketHeader() = default;
  39                 PacketHeader(std::uint16_t, std::uint16_t);
  40         };
  41
  42 private:
  43         template<typename T, std::uint8_t K>
  44         struct BasicTraits;
  45
  46         template<typename T>
  47         struct Traits;
  48
  49         template<typename C>
  50         class Serializer;
  51
  52         template<typename T>
  53         class BasicSerializer
  54         {
  55         public:
  56                 BasicSerializer(const Protocol &) { }
  57
  58                 std::uint64_t get_hash() const { return Traits<T>::signature; }
  59                 char *serialize(const T &, char *, char *) const;
  60                 const char *deserialize(T &, const char *, const char *) const;
  61         };
  62
  63         class StringSerializer
  64         {
  65         private:
  66                 BasicSerializer<std::uint16_t> length_serializer;
  67
  68         public:
  69                 StringSerializer(const Protocol &);
  70
  71                 std::uint64_t get_hash() const;
  72                 char *serialize(const std::string &, char *, char *) const;
  73                 const char *deserialize(std::string &, const char *, const char *) const;
  74         };
  75
  76         template<typename A>
  77         class ArraySerializer
  78         {
  79         private:
  80                 BasicSerializer<std::uint16_t> length_serializer;
  81                 typename Traits<typename A::value_type>::Serializer element_serializer;
  82
  83         public:
  84                 ArraySerializer(const Protocol &);
  85
  86                 std::uint64_t get_hash() const;
  87                 char *serialize(const A &, char *, char *) const;
  88                 const char *deserialize(A &, const char *, const char *) const;
  89         };
  90
  91         template<typename C>
  92         class CompoundSerializer
  93         {
  94         private:
  95                 const Serializer<C> &serializer;
  96
  97         public:
  98                 CompoundSerializer(const Protocol &);
  99
 100                 std::uint64_t get_hash() const;
 101                 char *serialize(const C &, char *, char *) const;
 102                 const char *deserialize(C &, const char *, const char *) const;
 103         };
 104
 105         template<typename C, typename Head, typename T>
 106         class FieldSerializer: public Head
 107         {
 108         public:
 109                 template<typename N>
 110                 using Next = FieldSerializer<C, FieldSerializer<C, Head, T>, N>;
 111
 112         private:
 113                 T C::*ptr;
 114                 typename Traits<T>::Serializer ser;
 115
 116         public:
 117                 FieldSerializer(const Head &, T C::*, const Protocol &);
 118
 119                 std::uint64_t get_hash() const;
 120                 char *serialize(const C &, char *, char *) const;
 121                 const char *deserialize(C &, const char *, const char *) const;
 122         };
 123
 124         template<typename C>
 125         class Serializer
 126         {
 127         public:
 128                 template<typename N>
 129                 using Next = FieldSerializer<C, Serializer<C>, N>;
 130
 131                 virtual ~Serializer() = default;
 132
 133                 virtual std::uint64_t get_hash() const { return 0; }
 134                 virtual char *serialize(const C &, char *b, char *) const { return b; }
 135                 virtual const char *deserialize(C &, const char *b, const char *) const { return b; }
 136         };
 137
 138         class PacketDefBase
 139         {
 140         protected:
 141                 unsigned id;
 142
 143                 PacketDefBase(unsigned);
 144         public:
 145                 virtual ~PacketDefBase() = default;
 146
 147                 virtual unsigned get_class_id() const = 0;
 148                 unsigned get_id() const { return id; }
 149                 virtual std::uint64_t get_hash() const = 0;
 150                 virtual const char *deserialize(Variant &, const char *, const char *) const = 0;
 151                 virtual const char *dispatch(ReceiverBase &, const char *, const char *) const = 0;
 152         };
 153
 154         template<typename P>
 155         class PacketTypeDef: public PacketDefBase
 156         {
 157         private:
 158                 std::unique_ptr<Serializer<P>> serializer;
 159
 160         public:
 161                 PacketTypeDef(unsigned);
 162
 163                 unsigned get_class_id() const override { return get_packet_class_id<P>(); }
 164
 165                 template<typename S>
 166                 void set_serializer(const S &);
 167
 168                 const Serializer<P> &get_serializer() const { return *serializer; }
 169
 170                 std::uint64_t get_hash() const override { return serializer->get_hash(); }
 171                 char *serialize(const P &, char *, char *) const;
 172                 const char *deserialize(P &, const char *, const char *) const;
 173                 const char *deserialize(Variant &, const char *, const char *) const override;
 174                 const char *dispatch(ReceiverBase &, const char *, const char *) const override;
 175         };
 176
 177         template<typename P, typename S>
 178         class PacketDefBuilder
 179         {
 180         private:
 181                 const Protocol &protocol;
 182                 PacketTypeDef<P> &pktdef;
 183                 S serializer;
 184
 185         public:
 186                 PacketDefBuilder(const Protocol &, PacketTypeDef<P> &, const S &);
 187
 188                 template<typename T>
 189                 PacketDefBuilder<P, typename S::template Next<T>> fields(T P::*);
 190
 191                 template<typename T1, typename T2, typename... Rest>
 192                 auto fields(T1 P::*first, T2 P::*second, Rest P::*...rest) { return fields(first).fields(second, rest...); }
 193         };
 194
 195         PacketTypeDef<PacketHeader> header_def;
 196         unsigned next_packet_id = 1;
 197         std::map<unsigned, std::unique_ptr<PacketDefBase>> packet_class_defs;
 198         std::map<unsigned, PacketDefBase *> packet_id_defs;
 199
 200 protected:
 201         Protocol();
 202
 203 private:
 204         static unsigned get_next_packet_class_id();
 205
 206         template<typename P>
 207         static unsigned get_packet_class_id();
 208
 209         void add_packet(std::unique_ptr<PacketDefBase>);
 210
 211 protected:
 212         template<typename P>
 213         PacketDefBuilder<P, Serializer<P>> add();
 214
 215         template<typename P, typename T, typename... Rest>
 216         auto add(T P::*field, Rest P::*...rest) { return add<P>().fields(field, rest...); }
 217
 218         const PacketDefBase &get_packet_by_class_id(unsigned) const;
 219         const PacketDefBase &get_packet_by_id(unsigned) const;
 220
 221         template<typename P>
 222         const PacketTypeDef<P> &get_packet_by_class() const;
 223
 224 public:
 225         template<typename P>
 226         bool has_packet() const { return packet_class_defs.count(get_packet_class_id<P>()); }
 227
 228         template<typename P>
 229         unsigned get_packet_id() const { return get_item(packet_class_defs, get_packet_class_id<P>())->get_id(); }
 230
 231         unsigned get_max_packet_id() const;
 232
 233         template<typename P>
 234         std::size_t serialize(const P &, char *, std::size_t, unsigned = 0) const;
 235
 236         bool get_packet_header(PacketHeader &, const char *, std::size_t) const;
 237         std::size_t get_packet_size(const char *, std::size_t) const;
 238         std::size_t dispatch(ReceiverBase &, const char *, std::size_t, unsigned = 0) const;
 239
 240         std::uint64_t get_hash() const;
 241 };
 242
 243
 244 template<typename P>
 245 unsigned Protocol::get_packet_class_id()
 246 {
 247         static unsigned id = get_next_packet_class_id();
 248         return id;
 249 }
 250
 251 template<typename P>
 252 Protocol::PacketDefBuilder<P, Protocol::Serializer<P>> Protocol::add()
 253 {
 254         std::unique_ptr<PacketTypeDef<P>> pdef = std::make_unique<PacketTypeDef<P>>(next_packet_id++);
 255         PacketDefBuilder<P, Serializer<P>> next(*this, *pdef, Serializer<P>());
 256         add_packet(move(pdef));
 257         return next;
 258 }
 259
 260 template<typename P>
 261 const Protocol::PacketTypeDef<P> &Protocol::get_packet_by_class() const
 262 {
 263         const PacketDefBase &pdef = get_packet_by_class_id(get_packet_class_id<P>());
 264         return static_cast<const PacketTypeDef<P> &>(pdef);
 265 }
 266
 267 template<typename P>
 268 std::size_t Protocol::serialize(const P &pkt, char *buf, std::size_t size, unsigned base_id) const
 269 {
 270         const PacketTypeDef<P> &pdef = get_packet_by_class<P>();
 271         if(!pdef.get_id())
 272                 throw std::invalid_argument("no packet id");
 273         char *ptr = pdef.serialize(pkt, buf+4, buf+size);
 274         size = ptr-buf;
 275         header_def.serialize(PacketHeader(base_id+pdef.get_id(), size), buf, buf+4);
 276         return size;
 277 }
 278
 279
 280 template<typename T, std::uint8_t K>
 281 struct Protocol::BasicTraits
 282 {
 283         static const std::uint16_t signature = K | (sizeof(T)<<8);
 284         typedef BasicSerializer<T> Serializer;
 285 };
 286
 287 template<typename T>
 288 struct Protocol::Traits
 289 {
 290         static const std::uint16_t signature = 'C';
 291         typedef CompoundSerializer<T> Serializer;
 292 };
 293
 294 template<> struct Protocol::Traits<bool>: BasicTraits<bool, 'B'> { };
 295 template<> struct Protocol::Traits<std::int8_t>: BasicTraits<std::int8_t, 'I'> { };
 296 template<> struct Protocol::Traits<std::uint8_t>: BasicTraits<std::uint8_t, 'U'> { };
 297 template<> struct Protocol::Traits<std::int16_t>: BasicTraits<std::int16_t, 'I'> { };
 298 template<> struct Protocol::Traits<std::uint16_t>: BasicTraits<std::uint16_t, 'U'> { };
 299 template<> struct Protocol::Traits<std::int32_t>: BasicTraits<std::int32_t, 'I'> { };
 300 template<> struct Protocol::Traits<std::uint32_t>: BasicTraits<std::uint32_t, 'U'> { };
 301 template<> struct Protocol::Traits<std::int64_t>: BasicTraits<std::int64_t, 'I'> { };
 302 template<> struct Protocol::Traits<std::uint64_t>: BasicTraits<std::uint64_t, 'U'> { };
 303 template<> struct Protocol::Traits<float>: BasicTraits<float, 'F'> { };
 304 template<> struct Protocol::Traits<double>: BasicTraits<double, 'F'> { };
 305
 306 template<> struct Protocol::Traits<std::string>
 307 {
 308         static const std::uint16_t signature = 'S';
 309         typedef StringSerializer Serializer;
 310 };
 311
 312 template<typename T>
 313 struct Protocol::Traits<std::vector<T>>
 314 {
 315         static const std::uint16_t signature = 'A';
 316         typedef ArraySerializer<std::vector<T>> Serializer;
 317 };
 318
 319
 320 inline std::uint64_t Protocol::StringSerializer::get_hash() const
 321 {
 322         return Traits<std::string>::signature;
 323 }
 324
 325
 326 template<typename A>
 327 Protocol::ArraySerializer<A>::ArraySerializer(const Protocol &proto):
 328         length_serializer(proto),
 329         element_serializer(proto)
 330 { }
 331
 332 template<typename A>
 333 std::uint64_t Protocol::ArraySerializer<A>::get_hash() const
 334 {
 335         return hash_round<64>(element_serializer.get_hash(), 'A');
 336 }
 337
 338 template<typename A>
 339 char *Protocol::ArraySerializer<A>::serialize(const A &array, char *buf, char *end) const
 340 {
 341         buf = length_serializer.serialize(array.size(), buf, end);
 342         for(const auto &e: array)
 343                 buf = element_serializer.serialize(e, buf, end);
 344         return buf;
 345 }
 346
 347 template<typename A>
 348 const char *Protocol::ArraySerializer<A>::deserialize(A &array, const char *buf, const char *end) const
 349 {
 350         std::uint16_t length;
 351         buf = length_serializer.deserialize(length, buf, end);
 352         array.resize(length);
 353         for(unsigned i=0; i<length; ++i)
 354                 buf = element_serializer.deserialize(array[i], buf, end);
 355         return buf;
 356 }
 357
 358
 359 template<typename C>
 360 Protocol::CompoundSerializer<C>::CompoundSerializer(const Protocol &proto):
 361         serializer(proto.get_packet_by_class<C>().get_serializer())
 362 { }
 363
 364 template<typename C>
 365 std::uint64_t Protocol::CompoundSerializer<C>::get_hash() const
 366 {
 367         return hash_round<64>(serializer.get_hash(), 'C');
 368 }
 369
 370 template<typename C>
 371 char *Protocol::CompoundSerializer<C>::serialize(const C &com, char *buf, char *end) const
 372 {
 373         return serializer.serialize(com, buf, end);
 374 }
 375
 376 template<typename C>
 377 const char *Protocol::CompoundSerializer<C>::deserialize(C &com, const char *buf, const char *end) const
 378 {
 379         return serializer.deserialize(com, buf, end);
 380 }
 381
 382
 383 template<typename C, typename Head, typename T>
 384 Protocol::FieldSerializer<C, Head, T>::FieldSerializer(const Head &h, T C::*p, const Protocol &proto):
 385         Head(h),
 386         ptr(p),
 387         ser(proto)
 388 { }
 389
 390 template<typename C, typename Head, typename T>
 391 std::uint64_t Protocol::FieldSerializer<C, Head, T>::get_hash() const
 392 {
 393         return hash_update<64>(Head::get_hash(), ser.get_hash());
 394 }
 395
 396 template<typename C, typename Head, typename T>
 397 char *Protocol::FieldSerializer<C, Head, T>::serialize(const C &com, char *buf, char *end) const
 398 {
 399         buf = Head::serialize(com, buf, end);
 400         return ser.serialize(com.*ptr, buf, end);
 401 }
 402
 403 template<typename C, typename Head, typename T>
 404 const char *Protocol::FieldSerializer<C, Head, T>::deserialize(C &com, const char *buf, const char *end) const
 405 {
 406         buf = Head::deserialize(com, buf, end);
 407         return ser.deserialize(com.*ptr, buf, end);
 408 }
 409
 410
 411 template<typename P>
 412 Protocol::PacketTypeDef<P>::PacketTypeDef(unsigned i):
 413         PacketDefBase(i),
 414         serializer(std::make_unique<Serializer<P>>())
 415 { }
 416
 417 template<typename P>
 418 template<typename S>
 419 void Protocol::PacketTypeDef<P>::set_serializer(const S &ser)
 420 {
 421         serializer = std::make_unique<S>(ser);
 422 }
 423
 424 template<typename P>
 425 char *Protocol::PacketTypeDef<P>::serialize(const P &pkt, char *buf, char *end) const
 426 {
 427         return serializer->serialize(pkt, buf, end);
 428 }
 429
 430 template<typename P>
 431 const char *Protocol::PacketTypeDef<P>::deserialize(P &pkt, const char *buf, const char *end) const
 432 {
 433         return serializer->deserialize(pkt, buf, end);
 434 }
 435
 436 template<typename P>
 437 const char *Protocol::PacketTypeDef<P>::deserialize(Variant &var_pkt, const char *buf, const char *end) const
 438 {
 439         P pkt;
 440         const char *ptr = serializer->deserialize(pkt, buf, end);
 441         var_pkt = std::move(pkt);
 442         return ptr;
 443 }
 444
 445 template<typename P>
 446 const char *Protocol::PacketTypeDef<P>::dispatch(ReceiverBase &rcv, const char *buf, const char *end) const
 447 {
 448         PacketReceiver<P> *prcv = dynamic_cast<PacketReceiver<P> *>(&rcv);
 449         if(!prcv)
 450                 throw bad_packet("unsupported");
 451         P pkt;
 452         buf = deserialize(pkt, buf, end);
 453         prcv->receive(pkt);
 454         return buf;
 455 }
 456
 457
 458 template<typename P, typename S>
 459 Protocol::PacketDefBuilder<P, S>::PacketDefBuilder(const Protocol &p, PacketTypeDef<P> &k, const S &s):
 460         protocol(p),
 461         pktdef(k),
 462         serializer(s)
 463 { }
 464
 465 template<typename P, typename S>
 466 template<typename T>
 467 Protocol::PacketDefBuilder<P, typename S::template Next<T>> Protocol::PacketDefBuilder<P, S>::fields(T P::*ptr)
 468 {
 469         typename S::template Next<T> next_ser(serializer, ptr, protocol);
 470         pktdef.set_serializer(next_ser);
 471         return PacketDefBuilder<P, typename S::template Next<T>>(protocol, pktdef, next_ser);
 472 }
 473
 474 } // namespace Net
 475 } // namespace Msp
 476
 477 #endif