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 *dispatch(ReceiverBase &, const char *, const char *) const = 0;
 151         };
 152
 153         template<typename P>
 154         class PacketTypeDef: public PacketDefBase
 155         {
 156         private:
 157                 std::unique_ptr<Serializer<P>> serializer;
 158
 159         public:
 160                 PacketTypeDef(unsigned);
 161
 162                 unsigned get_class_id() const override { return get_packet_class_id<P>(); }
 163
 164                 template<typename S>
 165                 void set_serializer(const S &);
 166
 167                 const Serializer<P> &get_serializer() const { return *serializer; }
 168
 169                 std::uint64_t get_hash() const override { return serializer->get_hash(); }
 170                 char *serialize(const P &, char *, char *) const;
 171                 const char *deserialize(P &, const char *, const char *) const;
 172                 const char *dispatch(ReceiverBase &, const char *, const char *) const override;
 173         };
 174
 175         template<typename P, typename S>
 176         class PacketDefBuilder
 177         {
 178         private:
 179                 const Protocol &protocol;
 180                 PacketTypeDef<P> &pktdef;
 181                 S serializer;
 182
 183         public:
 184                 PacketDefBuilder(const Protocol &, PacketTypeDef<P> &, const S &);
 185
 186                 template<typename T>
 187                 PacketDefBuilder<P, typename S::template Next<T>> fields(T P::*);
 188
 189                 template<typename T1, typename T2, typename... Rest>
 190                 auto fields(T1 P::*first, T2 P::*second, Rest P::*...rest) { return fields(first).fields(second, rest...); }
 191         };
 192
 193         PacketTypeDef<PacketHeader> header_def;
 194         unsigned next_packet_id = 1;
 195         std::map<unsigned, std::unique_ptr<PacketDefBase>> packet_class_defs;
 196         std::map<unsigned, PacketDefBase *> packet_id_defs;
 197
 198 protected:
 199         Protocol();
 200
 201 private:
 202         static unsigned get_next_packet_class_id();
 203
 204         template<typename P>
 205         static unsigned get_packet_class_id();
 206
 207         void add_packet(std::unique_ptr<PacketDefBase>);
 208
 209 protected:
 210         template<typename P>
 211         PacketDefBuilder<P, Serializer<P>> add();
 212
 213         template<typename P, typename T, typename... Rest>
 214         auto add(T P::*field, Rest P::*...rest) { return add<P>().fields(field, rest...); }
 215
 216         const PacketDefBase &get_packet_by_class_id(unsigned) const;
 217         const PacketDefBase &get_packet_by_id(unsigned) const;
 218
 219         template<typename P>
 220         const PacketTypeDef<P> &get_packet_by_class() const;
 221
 222 public:
 223         template<typename P>
 224         bool has_packet() const { return packet_class_defs.count(get_packet_class_id<P>()); }
 225
 226         template<typename P>
 227         unsigned get_packet_id() const { return get_item(packet_class_defs, get_packet_class_id<P>())->get_id(); }
 228
 229         unsigned get_max_packet_id() const;
 230
 231         template<typename P>
 232         std::size_t serialize(const P &, char *, std::size_t, unsigned = 0) const;
 233
 234         bool get_packet_header(PacketHeader &, const char *, std::size_t) const;
 235         std::size_t get_packet_size(const char *, std::size_t) const;
 236         std::size_t dispatch(ReceiverBase &, const char *, std::size_t, unsigned = 0) const;
 237
 238         std::uint64_t get_hash() const;
 239 };
 240
 241
 242 template<typename P>
 243 unsigned Protocol::get_packet_class_id()
 244 {
 245         static unsigned id = get_next_packet_class_id();
 246         return id;
 247 }
 248
 249 template<typename P>
 250 Protocol::PacketDefBuilder<P, Protocol::Serializer<P>> Protocol::add()
 251 {
 252         std::unique_ptr<PacketTypeDef<P>> pdef = std::make_unique<PacketTypeDef<P>>(next_packet_id++);
 253         PacketDefBuilder<P, Serializer<P>> next(*this, *pdef, Serializer<P>());
 254         add_packet(move(pdef));
 255         return next;
 256 }
 257
 258 template<typename P>
 259 const Protocol::PacketTypeDef<P> &Protocol::get_packet_by_class() const
 260 {
 261         const PacketDefBase &pdef = get_packet_by_class_id(get_packet_class_id<P>());
 262         return static_cast<const PacketTypeDef<P> &>(pdef);
 263 }
 264
 265 template<typename P>
 266 std::size_t Protocol::serialize(const P &pkt, char *buf, std::size_t size, unsigned base_id) const
 267 {
 268         const PacketTypeDef<P> &pdef = get_packet_by_class<P>();
 269         if(!pdef.get_id())
 270                 throw std::invalid_argument("no packet id");
 271         char *ptr = pdef.serialize(pkt, buf+4, buf+size);
 272         size = ptr-buf;
 273         header_def.serialize(PacketHeader(base_id+pdef.get_id(), size), buf, buf+4);
 274         return size;
 275 }
 276
 277
 278 template<typename T, std::uint8_t K>
 279 struct Protocol::BasicTraits
 280 {
 281         static const std::uint16_t signature = K | (sizeof(T)<<8);
 282         typedef BasicSerializer<T> Serializer;
 283 };
 284
 285 template<typename T>
 286 struct Protocol::Traits
 287 {
 288         static const std::uint16_t signature = 'C';
 289         typedef CompoundSerializer<T> Serializer;
 290 };
 291
 292 template<> struct Protocol::Traits<bool>: BasicTraits<bool, 'B'> { };
 293 template<> struct Protocol::Traits<std::int8_t>: BasicTraits<std::int8_t, 'I'> { };
 294 template<> struct Protocol::Traits<std::uint8_t>: BasicTraits<std::uint8_t, 'U'> { };
 295 template<> struct Protocol::Traits<std::int16_t>: BasicTraits<std::int16_t, 'I'> { };
 296 template<> struct Protocol::Traits<std::uint16_t>: BasicTraits<std::uint16_t, 'U'> { };
 297 template<> struct Protocol::Traits<std::int32_t>: BasicTraits<std::int32_t, 'I'> { };
 298 template<> struct Protocol::Traits<std::uint32_t>: BasicTraits<std::uint32_t, 'U'> { };
 299 template<> struct Protocol::Traits<std::int64_t>: BasicTraits<std::int64_t, 'I'> { };
 300 template<> struct Protocol::Traits<std::uint64_t>: BasicTraits<std::uint64_t, 'U'> { };
 301 template<> struct Protocol::Traits<float>: BasicTraits<float, 'F'> { };
 302 template<> struct Protocol::Traits<double>: BasicTraits<double, 'F'> { };
 303
 304 template<> struct Protocol::Traits<std::string>
 305 {
 306         static const std::uint16_t signature = 'S';
 307         typedef StringSerializer Serializer;
 308 };
 309
 310 template<typename T>
 311 struct Protocol::Traits<std::vector<T>>
 312 {
 313         static const std::uint16_t signature = 'A';
 314         typedef ArraySerializer<std::vector<T>> Serializer;
 315 };
 316
 317
 318 inline std::uint64_t Protocol::StringSerializer::get_hash() const
 319 {
 320         return Traits<std::string>::signature;
 321 }
 322
 323
 324 template<typename A>
 325 Protocol::ArraySerializer<A>::ArraySerializer(const Protocol &proto):
 326         length_serializer(proto),
 327         element_serializer(proto)
 328 { }
 329
 330 template<typename A>
 331 std::uint64_t Protocol::ArraySerializer<A>::get_hash() const
 332 {
 333         return hash_round<64>(element_serializer.get_hash(), 'A');
 334 }
 335
 336 template<typename A>
 337 char *Protocol::ArraySerializer<A>::serialize(const A &array, char *buf, char *end) const
 338 {
 339         buf = length_serializer.serialize(array.size(), buf, end);
 340         for(const auto &e: array)
 341                 buf = element_serializer.serialize(e, buf, end);
 342         return buf;
 343 }
 344
 345 template<typename A>
 346 const char *Protocol::ArraySerializer<A>::deserialize(A &array, const char *buf, const char *end) const
 347 {
 348         std::uint16_t length;
 349         buf = length_serializer.deserialize(length, buf, end);
 350         array.resize(length);
 351         for(unsigned i=0; i<length; ++i)
 352                 buf = element_serializer.deserialize(array[i], buf, end);
 353         return buf;
 354 }
 355
 356
 357 template<typename C>
 358 Protocol::CompoundSerializer<C>::CompoundSerializer(const Protocol &proto):
 359         serializer(proto.get_packet_by_class<C>().get_serializer())
 360 { }
 361
 362 template<typename C>
 363 std::uint64_t Protocol::CompoundSerializer<C>::get_hash() const
 364 {
 365         return hash_round<64>(serializer.get_hash(), 'C');
 366 }
 367
 368 template<typename C>
 369 char *Protocol::CompoundSerializer<C>::serialize(const C &com, char *buf, char *end) const
 370 {
 371         return serializer.serialize(com, buf, end);
 372 }
 373
 374 template<typename C>
 375 const char *Protocol::CompoundSerializer<C>::deserialize(C &com, const char *buf, const char *end) const
 376 {
 377         return serializer.deserialize(com, buf, end);
 378 }
 379
 380
 381 template<typename C, typename Head, typename T>
 382 Protocol::FieldSerializer<C, Head, T>::FieldSerializer(const Head &h, T C::*p, const Protocol &proto):
 383         Head(h),
 384         ptr(p),
 385         ser(proto)
 386 { }
 387
 388 template<typename C, typename Head, typename T>
 389 std::uint64_t Protocol::FieldSerializer<C, Head, T>::get_hash() const
 390 {
 391         return hash_update<64>(Head::get_hash(), ser.get_hash());
 392 }
 393
 394 template<typename C, typename Head, typename T>
 395 char *Protocol::FieldSerializer<C, Head, T>::serialize(const C &com, char *buf, char *end) const
 396 {
 397         buf = Head::serialize(com, buf, end);
 398         return ser.serialize(com.*ptr, buf, end);
 399 }
 400
 401 template<typename C, typename Head, typename T>
 402 const char *Protocol::FieldSerializer<C, Head, T>::deserialize(C &com, const char *buf, const char *end) const
 403 {
 404         buf = Head::deserialize(com, buf, end);
 405         return ser.deserialize(com.*ptr, buf, end);
 406 }
 407
 408
 409 template<typename P>
 410 Protocol::PacketTypeDef<P>::PacketTypeDef(unsigned i):
 411         PacketDefBase(i),
 412         serializer(std::make_unique<Serializer<P>>())
 413 { }
 414
 415 template<typename P>
 416 template<typename S>
 417 void Protocol::PacketTypeDef<P>::set_serializer(const S &ser)
 418 {
 419         serializer = std::make_unique<S>(ser);
 420 }
 421
 422 template<typename P>
 423 char *Protocol::PacketTypeDef<P>::serialize(const P &pkt, char *buf, char *end) const
 424 {
 425         return serializer->serialize(pkt, buf, end);
 426 }
 427
 428 template<typename P>
 429 const char *Protocol::PacketTypeDef<P>::deserialize(P &pkt, const char *buf, const char *end) const
 430 {
 431         return serializer->deserialize(pkt, buf, end);
 432 }
 433
 434 template<typename P>
 435 const char *Protocol::PacketTypeDef<P>::dispatch(ReceiverBase &rcv, const char *buf, const char *end) const
 436 {
 437         PacketReceiver<P> *prcv = dynamic_cast<PacketReceiver<P> *>(&rcv);
 438         if(!prcv)
 439                 throw bad_packet("unsupported");
 440         P pkt;
 441         buf = deserialize(pkt, buf, end);
 442         prcv->receive(pkt);
 443         return buf;
 444 }
 445
 446
 447 template<typename P, typename S>
 448 Protocol::PacketDefBuilder<P, S>::PacketDefBuilder(const Protocol &p, PacketTypeDef<P> &k, const S &s):
 449         protocol(p),
 450         pktdef(k),
 451         serializer(s)
 452 { }
 453
 454 template<typename P, typename S>
 455 template<typename T>
 456 Protocol::PacketDefBuilder<P, typename S::template Next<T>> Protocol::PacketDefBuilder<P, S>::fields(T P::*ptr)
 457 {
 458         typename S::template Next<T> next_ser(serializer, ptr, protocol);
 459         pktdef.set_serializer(next_ser);
 460         return PacketDefBuilder<P, typename S::template Next<T>>(protocol, pktdef, next_ser);
 461 }
 462
 463 } // namespace Net
 464 } // namespace Msp
 465
 466 #endif