3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 #ifndef CONNECTION_HEADER
21 #define CONNECTION_HEADER
23 #include "irrlichttypes_bloated.h"
25 #include "exceptions.h"
26 #include "constants.h"
27 #include "util/pointer.h"
28 #include "util/container.h"
29 #include "util/thread.h"
30 #include "util/numeric.h"
42 class NotFoundException : public BaseException
45 NotFoundException(const char *s):
50 class PeerNotFoundException : public BaseException
53 PeerNotFoundException(const char *s):
58 class ConnectionException : public BaseException
61 ConnectionException(const char *s):
66 class ConnectionBindFailed : public BaseException
69 ConnectionBindFailed(const char *s):
74 class InvalidIncomingDataException : public BaseException
77 InvalidIncomingDataException(const char *s):
82 class InvalidOutgoingDataException : public BaseException
85 InvalidOutgoingDataException(const char *s):
90 class NoIncomingDataException : public BaseException
93 NoIncomingDataException(const char *s):
98 class ProcessedSilentlyException : public BaseException
101 ProcessedSilentlyException(const char *s):
106 class ProcessedQueued : public BaseException
109 ProcessedQueued(const char *s):
114 class IncomingDataCorruption : public BaseException
117 IncomingDataCorruption(const char *s):
122 typedef enum MTProtocols {
125 MINETEST_RELIABLE_UDP
128 #define SEQNUM_MAX 65535
129 inline bool seqnum_higher(u16 totest, u16 base)
133 if((totest - base) > (SEQNUM_MAX/2))
140 if((base - totest) > (SEQNUM_MAX/2))
147 inline bool seqnum_in_window(u16 seqnum, u16 next,u16 window_size)
149 u16 window_start = next;
150 u16 window_end = ( next + window_size ) % (SEQNUM_MAX+1);
152 if (window_start < window_end)
154 return ((seqnum >= window_start) && (seqnum < window_end));
158 return ((seqnum < window_end) || (seqnum >= window_start));
162 struct BufferedPacket
164 BufferedPacket(u8 *a_data, u32 a_size):
165 data(a_data, a_size), time(0.0), totaltime(0.0), absolute_send_time(-1)
167 BufferedPacket(u32 a_size):
168 data(a_size), time(0.0), totaltime(0.0), absolute_send_time(-1)
170 SharedBuffer<u8> data; // Data of the packet, including headers
171 float time; // Seconds from buffering the packet or re-sending
172 float totaltime; // Seconds from buffering the packet
173 unsigned int absolute_send_time;
174 Address address; // Sender or destination
177 // This adds the base headers to the data and makes a packet out of it
178 BufferedPacket makePacket(Address &address, u8 *data, u32 datasize,
179 u32 protocol_id, u16 sender_peer_id, u8 channel);
180 BufferedPacket makePacket(Address &address, SharedBuffer<u8> &data,
181 u32 protocol_id, u16 sender_peer_id, u8 channel);
183 // Add the TYPE_ORIGINAL header to the data
184 SharedBuffer<u8> makeOriginalPacket(
185 SharedBuffer<u8> data);
187 // Split data in chunks and add TYPE_SPLIT headers to them
188 std::list<SharedBuffer<u8> > makeSplitPacket(
189 SharedBuffer<u8> data,
193 // Depending on size, make a TYPE_ORIGINAL or TYPE_SPLIT packet
194 // Increments split_seqnum if a split packet is made
195 std::list<SharedBuffer<u8> > makeAutoSplitPacket(
196 SharedBuffer<u8> data,
200 // Add the TYPE_RELIABLE header to the data
201 SharedBuffer<u8> makeReliablePacket(
202 SharedBuffer<u8> data,
205 struct IncomingSplitPacket
207 IncomingSplitPacket()
212 // Key is chunk number, value is data without headers
213 std::map<u16, SharedBuffer<u8> > chunks;
215 float time; // Seconds from adding
216 bool reliable; // If true, isn't deleted on timeout
220 return (chunks.size() == chunk_count);
227 A packet is sent through a channel to a peer with a basic header:
228 TODO: Should we have a receiver_peer_id also?
231 [4] u16 sender_peer_id
235 value 0 (PEER_ID_INEXISTENT) is reserved for making new connections
236 value 1 (PEER_ID_SERVER) is reserved for server
237 these constants are defined in constants.h
239 The lower the number, the higher the priority is.
240 Only channels 0, 1 and 2 exist.
242 #define BASE_HEADER_SIZE 7
243 #define CHANNEL_COUNT 3
247 CONTROL: This is a packet used by the protocol.
248 - When this is processed, nothing is handed to the user.
252 controltype and data description:
255 CONTROLTYPE_SET_PEER_ID
258 - There is no actual reply, but this can be sent in a reliable
259 packet to get a reply
262 #define TYPE_CONTROL 0
263 #define CONTROLTYPE_ACK 0
264 #define CONTROLTYPE_SET_PEER_ID 1
265 #define CONTROLTYPE_PING 2
266 #define CONTROLTYPE_DISCO 3
267 #define CONTROLTYPE_ENABLE_BIG_SEND_WINDOW 4
270 ORIGINAL: This is a plain packet with no control and no error
272 - When this is processed, it is directly handed to the user.
276 #define TYPE_ORIGINAL 1
277 #define ORIGINAL_HEADER_SIZE 1
279 SPLIT: These are sequences of packets forming one bigger piece of
281 - When processed and all the packet_nums 0...packet_count-1 are
282 present (this should be buffered), the resulting data shall be
283 directly handed to the user.
284 - If the data fails to come up in a reasonable time, the buffer shall
285 be silently discarded.
286 - These can be sent as-is or atop of a RELIABLE packet stream.
295 RELIABLE: Delivery of all RELIABLE packets shall be forced by ACKs,
296 and they shall be delivered in the same order as sent. This is done
297 with a buffer in the receiving and transmitting end.
298 - When this is processed, the contents of each packet is recursively
299 processed as packets.
305 #define TYPE_RELIABLE 3
306 #define RELIABLE_HEADER_SIZE 3
307 #define SEQNUM_INITIAL 65500
310 A buffer which stores reliable packets and sorts them internally
311 for fast access to the smallest one.
314 typedef std::list<BufferedPacket>::iterator RPBSearchResult;
316 class ReliablePacketBuffer
319 ReliablePacketBuffer();
321 bool getFirstSeqnum(u16& result);
323 BufferedPacket popFirst();
324 BufferedPacket popSeqnum(u16 seqnum);
325 void insert(BufferedPacket &p,u16 next_expected);
327 void incrementTimeouts(float dtime);
328 std::list<BufferedPacket> getTimedOuts(float timeout,
329 unsigned int max_packets);
333 bool containsPacket(u16 seqnum);
334 RPBSearchResult notFound();
339 RPBSearchResult findPacket(u16 seqnum);
341 std::list<BufferedPacket> m_list;
344 u16 m_oldest_non_answered_ack;
348 unsigned int writeptr;
352 A buffer for reconstructing split packets
355 class IncomingSplitBuffer
358 ~IncomingSplitBuffer();
360 Returns a reference counted buffer of length != 0 when a full split
361 packet is constructed. If not, returns one of length 0.
363 SharedBuffer<u8> insert(BufferedPacket &p, bool reliable);
365 void removeUnreliableTimedOuts(float dtime, float timeout);
369 std::map<u16, IncomingSplitPacket*> m_buf;
374 struct OutgoingPacket
378 SharedBuffer<u8> data;
382 OutgoingPacket(u16 peer_id_, u8 channelnum_, SharedBuffer<u8> data_,
383 bool reliable_,bool ack_=false):
385 channelnum(channelnum_),
393 enum ConnectionCommandType{
398 CONNCMD_DISCONNECT_PEER,
403 CONCMD_DISABLE_LEGACY
406 struct ConnectionCommand
408 enum ConnectionCommandType type;
416 ConnectionCommand(): type(CONNCMD_NONE), peer_id(PEER_ID_INEXISTENT), reliable(false), raw(false) {}
418 void serve(Address address_)
420 type = CONNCMD_SERVE;
423 void connect(Address address_)
425 type = CONNCMD_CONNECT;
430 type = CONNCMD_DISCONNECT;
432 void disconnect_peer(u16 peer_id_)
434 type = CONNCMD_DISCONNECT_PEER;
437 void send(u16 peer_id_, u8 channelnum_,
438 SharedBuffer<u8> data_, bool reliable_)
442 channelnum = channelnum_;
444 reliable = reliable_;
446 void sendToAll(u8 channelnum_, SharedBuffer<u8> data_, bool reliable_)
448 type = CONNCMD_SEND_TO_ALL;
449 channelnum = channelnum_;
451 reliable = reliable_;
454 void ack(u16 peer_id_, u8 channelnum_, SharedBuffer<u8> data_)
458 channelnum = channelnum_;
463 void createPeer(u16 peer_id_, SharedBuffer<u8> data_)
465 type = CONCMD_CREATE_PEER;
473 void disableLegacy(u16 peer_id_, SharedBuffer<u8> data_)
475 type = CONCMD_DISABLE_LEGACY;
488 u16 readNextIncomingSeqNum();
489 u16 incNextIncomingSeqNum();
491 u16 getOutgoingSequenceNumber(bool& successfull);
492 u16 readOutgoingSequenceNumber();
493 bool putBackSequenceNumber(u16);
495 u16 readNextSplitSeqNum();
496 void setNextSplitSeqNum(u16 seqnum);
498 // This is for buffering the incoming packets that are coming in
500 ReliablePacketBuffer incoming_reliables;
501 // This is for buffering the sent packets so that the sender can
502 // re-send them if no ACK is received
503 ReliablePacketBuffer outgoing_reliables_sent;
505 //queued reliable packets
506 Queue<BufferedPacket> queued_reliables;
508 //queue commands prior splitting to packets
509 Queue<ConnectionCommand> queued_commands;
511 IncomingSplitBuffer incoming_splits;
516 void UpdatePacketLossCounter(unsigned int count);
517 void UpdatePacketTooLateCounter();
518 void UpdateBytesSent(unsigned int bytes,unsigned int packages=1);
519 void UpdateBytesLost(unsigned int bytes);
521 void UpdateTimers(float dtime);
523 const float getCurrentDownloadRateKB()
524 { JMutexAutoLock lock(m_internal_mutex); return cur_kbps; };
525 const float getMaxDownloadRateKB()
526 { JMutexAutoLock lock(m_internal_mutex); return max_kbps; };
528 const float getCurrentLossRateKB()
529 { JMutexAutoLock lock(m_internal_mutex); return cur_kbps_lost; };
530 const float getMaxLossRateKB()
531 { JMutexAutoLock lock(m_internal_mutex); return max_kbps_lost; };
533 const float getAvgDownloadRateKB()
534 { JMutexAutoLock lock(m_internal_mutex); return avg_kbps; };
535 const float getAvgLossRateKB()
536 { JMutexAutoLock lock(m_internal_mutex); return avg_kbps_lost; };
538 const unsigned int getWindowSize() const { return window_size; };
540 void setWindowSize(unsigned int size) { window_size = size; };
542 JMutex m_internal_mutex;
543 unsigned int window_size;
545 u16 next_incoming_seqnum;
547 u16 next_outgoing_seqnum;
548 u16 next_outgoing_split_seqnum;
550 unsigned int current_packet_loss;
551 unsigned int current_packet_too_late;
552 unsigned int current_packet_successfull;
553 float packet_loss_counter;
555 unsigned int current_bytes_transfered;
556 unsigned int current_bytes_lost;
587 virtual ~PeerHandler()
592 This is called after the Peer has been inserted into the
593 Connection's peer container.
595 virtual void peerAdded(Peer *peer) = 0;
597 This is called before the Peer has been removed from the
598 Connection's peer container.
600 virtual void deletingPeer(Peer *peer, bool timeout) = 0;
607 PeerHelper(Peer* peer);
610 PeerHelper& operator=(Peer* peer);
611 Peer* operator->() const;
613 Peer* operator&() const;
614 bool operator!=(void* ptr);
622 typedef enum rtt_stat_type {
633 friend class PeerHelper;
635 Peer(Address address_,u16 id_,Connection* connection) :
637 m_increment_packets_remaining(9),
638 m_increment_bytes_remaining(0),
639 m_pending_deletion(false),
640 m_connection(connection),
645 m_timeout_counter(0.0),
646 m_last_timeout_check(porting::getTimeMs()),
647 m_has_sent_with_id(false)
649 m_rtt.avg_rtt = -1.0;
650 m_rtt.jitter_avg = -1.0;
651 m_rtt.jitter_max = 0.0;
653 m_rtt.jitter_min = FLT_MAX;
654 m_rtt.min_rtt = FLT_MAX;
658 JMutexAutoLock usage_lock(m_exclusive_access_mutex);
659 assert(m_usage == 0);
662 // Unique id of the peer
667 virtual void PutReliableSendCommand(ConnectionCommand &c,
668 unsigned int max_packet_size) {};
670 virtual bool isActive() { return false; };
672 virtual bool getAddress(MTProtocols type, Address& toset) = 0;
675 {JMutexAutoLock lock(m_exclusive_access_mutex); m_timeout_counter=0.0; };
677 bool isTimedOut(float timeout);
680 { JMutexAutoLock lock(m_exclusive_access_mutex); m_has_sent_with_id = true; };
683 { JMutexAutoLock lock(m_exclusive_access_mutex); return m_has_sent_with_id; };
685 unsigned int m_increment_packets_remaining;
686 unsigned int m_increment_bytes_remaining;
688 virtual u16 getNextSplitSequenceNumber(u8 channel) { return 0; };
689 virtual void setNextSplitSequenceNumber(u8 channel, u16 seqnum) {};
690 virtual SharedBuffer<u8> addSpiltPacket(u8 channel,
691 BufferedPacket toadd,
694 fprintf(stderr,"Peer: addSplitPacket called, this is supposed to be never called!\n");
695 return SharedBuffer<u8>(0);
698 virtual bool Ping(float dtime, SharedBuffer<u8>& data) { return false; };
700 virtual float getStat(rtt_stat_type type) const {
703 return m_rtt.min_rtt;
705 return m_rtt.max_rtt;
707 return m_rtt.avg_rtt;
709 return m_rtt.jitter_min;
711 return m_rtt.jitter_max;
713 return m_rtt.jitter_avg;
718 virtual void reportRTT(float rtt) {};
720 void RTTStatistics(float rtt,
721 std::string profiler_id="",
722 unsigned int num_samples=1000);
727 JMutex m_exclusive_access_mutex;
729 bool m_pending_deletion;
731 Connection* m_connection;
733 // Address of the peer
752 // current usage count
753 unsigned int m_usage;
755 // Seconds from last receive
756 float m_timeout_counter;
758 u32 m_last_timeout_check;
760 bool m_has_sent_with_id;
763 class UDPPeer : public Peer
767 friend class PeerHelper;
768 friend class ConnectionReceiveThread;
769 friend class ConnectionSendThread;
771 UDPPeer(u16 a_id, Address a_address, Connection* connection);
772 virtual ~UDPPeer() {};
774 void PutReliableSendCommand(ConnectionCommand &c,
775 unsigned int max_packet_size);
778 { return ((hasSentWithID()) && (!m_pending_deletion)); };
780 bool getAddress(MTProtocols type, Address& toset);
782 void setNonLegacyPeer();
785 { return m_legacy_peer; }
787 u16 getNextSplitSequenceNumber(u8 channel);
788 void setNextSplitSequenceNumber(u8 channel, u16 seqnum);
790 SharedBuffer<u8> addSpiltPacket(u8 channel,
791 BufferedPacket toadd,
797 Calculates avg_rtt and resend_timeout.
798 rtt=-1 only recalculates resend_timeout
800 void reportRTT(float rtt);
802 void RunCommandQueues(
803 unsigned int max_packet_size,
804 unsigned int maxcommands,
805 unsigned int maxtransfer);
807 float getResendTimeout()
808 { JMutexAutoLock lock(m_exclusive_access_mutex); return resend_timeout; }
810 void setResendTimeout(float timeout)
811 { JMutexAutoLock lock(m_exclusive_access_mutex); resend_timeout = timeout; }
812 bool Ping(float dtime,SharedBuffer<u8>& data);
814 Channel channels[CHANNEL_COUNT];
815 bool m_pending_disconnect;
817 // This is changed dynamically
818 float resend_timeout;
820 bool processReliableSendCommand(
821 ConnectionCommand &c,
822 unsigned int max_packet_size);
831 enum ConnectionEventType{
833 CONNEVENT_DATA_RECEIVED,
834 CONNEVENT_PEER_ADDED,
835 CONNEVENT_PEER_REMOVED,
836 CONNEVENT_BIND_FAILED,
839 struct ConnectionEvent
841 enum ConnectionEventType type;
847 ConnectionEvent(): type(CONNEVENT_NONE) {}
849 std::string describe()
853 return "CONNEVENT_NONE";
854 case CONNEVENT_DATA_RECEIVED:
855 return "CONNEVENT_DATA_RECEIVED";
856 case CONNEVENT_PEER_ADDED:
857 return "CONNEVENT_PEER_ADDED";
858 case CONNEVENT_PEER_REMOVED:
859 return "CONNEVENT_PEER_REMOVED";
860 case CONNEVENT_BIND_FAILED:
861 return "CONNEVENT_BIND_FAILED";
863 return "Invalid ConnectionEvent";
866 void dataReceived(u16 peer_id_, SharedBuffer<u8> data_)
868 type = CONNEVENT_DATA_RECEIVED;
872 void peerAdded(u16 peer_id_, Address address_)
874 type = CONNEVENT_PEER_ADDED;
878 void peerRemoved(u16 peer_id_, bool timeout_, Address address_)
880 type = CONNEVENT_PEER_REMOVED;
887 type = CONNEVENT_BIND_FAILED;
891 class ConnectionSendThread : public JThread {
894 friend class UDPPeer;
896 ConnectionSendThread(Connection* parent,
897 unsigned int max_packet_size, float timeout);
903 void setPeerTimeout(float peer_timeout)
904 { m_timeout = peer_timeout; }
907 void runTimeouts (float dtime);
908 void rawSend (const BufferedPacket &packet);
909 bool rawSendAsPacket(u16 peer_id, u8 channelnum,
910 SharedBuffer<u8> data, bool reliable);
912 void processReliableCommand (ConnectionCommand &c);
913 void processNonReliableCommand (ConnectionCommand &c);
914 void serve (Address bind_address);
915 void connect (Address address);
917 void disconnect_peer(u16 peer_id);
918 void send (u16 peer_id, u8 channelnum,
919 SharedBuffer<u8> data);
920 void sendReliable (ConnectionCommand &c);
921 void sendToAll (u8 channelnum,
922 SharedBuffer<u8> data);
923 void sendToAllReliable(ConnectionCommand &c);
925 void sendPackets (float dtime);
927 void sendAsPacket (u16 peer_id, u8 channelnum,
928 SharedBuffer<u8> data,bool ack=false);
930 void sendAsPacketReliable(BufferedPacket& p, Channel* channel);
932 bool packetsQueued();
934 Connection* m_connection;
935 unsigned int m_max_packet_size;
937 Queue<OutgoingPacket> m_outgoing_queue;
938 JSemaphore m_send_sleep_semaphore;
940 unsigned int m_iteration_packets_avaialble;
941 unsigned int m_max_commands_per_iteration;
942 unsigned int m_max_data_packets_per_iteration;
943 unsigned int m_max_packets_requeued;
946 class ConnectionReceiveThread : public JThread {
948 ConnectionReceiveThread(Connection* parent,
949 unsigned int max_packet_size);
956 // Returns next data from a buffer if possible
957 // If found, returns true; if not, false.
958 // If found, sets peer_id and dst
959 bool getFromBuffers (u16 &peer_id, SharedBuffer<u8> &dst);
961 bool checkIncomingBuffers(Channel *channel, u16 &peer_id,
962 SharedBuffer<u8> &dst);
965 Processes a packet with the basic header stripped out.
967 packetdata: Data in packet (with no base headers)
968 peer_id: peer id of the sender of the packet in question
969 channelnum: channel on which the packet was sent
970 reliable: true if recursing into a reliable packet
972 SharedBuffer<u8> processPacket(Channel *channel,
973 SharedBuffer<u8> packetdata, u16 peer_id,
974 u8 channelnum, bool reliable);
977 Connection* m_connection;
978 unsigned int m_max_packet_size;
984 friend class ConnectionSendThread;
985 friend class ConnectionReceiveThread;
987 Connection(u32 protocol_id, u32 max_packet_size, float timeout, bool ipv6);
988 Connection(u32 protocol_id, u32 max_packet_size, float timeout, bool ipv6,
989 PeerHandler *peerhandler);
993 ConnectionEvent getEvent();
994 ConnectionEvent waitEvent(u32 timeout_ms);
995 void putCommand(ConnectionCommand &c);
997 void SetTimeoutMs(int timeout){ m_bc_receive_timeout = timeout; }
998 void Serve(Address bind_addr);
999 void Connect(Address address);
1002 u32 Receive(u16 &peer_id, SharedBuffer<u8> &data);
1003 void SendToAll(u8 channelnum, SharedBuffer<u8> data, bool reliable);
1004 void Send(u16 peer_id, u8 channelnum, SharedBuffer<u8> data, bool reliable);
1005 u16 GetPeerID(){ return m_peer_id; }
1006 Address GetPeerAddress(u16 peer_id);
1007 float getPeerStat(u16 peer_id, rtt_stat_type type);
1008 const u32 GetProtocolID() const { return m_protocol_id; };
1009 const std::string getDesc();
1010 void DisconnectPeer(u16 peer_id);
1013 PeerHelper getPeer(u16 peer_id);
1014 PeerHelper getPeerNoEx(u16 peer_id);
1015 u16 lookupPeer(Address& sender);
1017 u16 createPeer(Address& sender, MTProtocols protocol, int fd);
1018 UDPPeer* createServerPeer(Address& sender);
1019 bool deletePeer(u16 peer_id, bool timeout);
1021 void SetPeerID(u16 id){ m_peer_id = id; }
1023 void sendAck(u16 peer_id, u8 channelnum, u16 seqnum);
1025 void PrintInfo(std::ostream &out);
1028 std::list<u16> getPeerIDs();
1030 UDPSocket m_udpSocket;
1031 MutexedQueue<ConnectionCommand> m_command_queue;
1033 void putEvent(ConnectionEvent &e);
1036 { m_sendThread.Trigger(); }
1038 std::list<Peer*> getPeers();
1040 MutexedQueue<ConnectionEvent> m_event_queue;
1045 std::map<u16, Peer*> m_peers;
1046 JMutex m_peers_mutex;
1048 ConnectionSendThread m_sendThread;
1049 ConnectionReceiveThread m_receiveThread;
1051 JMutex m_info_mutex;
1053 // Backwards compatibility
1054 PeerHandler *m_bc_peerhandler;
1055 int m_bc_receive_timeout;
1057 bool m_shutting_down;
1059 u16 m_next_remote_peer_id;