source: trunk/third-party/libutp/utp.cpp @ 11959

Last change on this file since 11959 was 11959, checked in by jch, 11 years ago

Resynchronise with libutp 2011-02-09 15:29:29.

File size: 86.4 KB
Line 
1#include <StdAfx.h>
2
3#include "utp.h"
4#include "templates.h"
5
6#include <stdio.h>
7#include <assert.h>
8#include <string.h>
9#include <string.h>
10#include <stdlib.h>
11#include <errno.h>
12#include <limits.h> // for UINT_MAX
13
14#ifdef WIN32
15#include "win32_inet_ntop.h"
16
17// newer versions of MSVC define these in errno.h
18#ifndef ECONNRESET
19#define ECONNRESET WSAECONNRESET
20#define EMSGSIZE WSAEMSGSIZE
21#define ECONNREFUSED WSAECONNREFUSED
22#define ETIMEDOUT WSAETIMEDOUT
23#endif
24#endif
25
26#ifdef POSIX
27typedef sockaddr_storage SOCKADDR_STORAGE;
28#endif // POSIX
29
30// number of bytes to increase max window size by, per RTT. This is
31// scaled down linearly proportional to off_target. i.e. if all packets
32// in one window have 0 delay, window size will increase by this number.
33// Typically it's less. TCP increases one MSS per RTT, which is 1500
34#define MAX_CWND_INCREASE_BYTES_PER_RTT 3000
35#define CUR_DELAY_SIZE 3
36// experiments suggest that a clock skew of 10 ms per 325 seconds
37// is not impossible. Reset delay_base every 13 minutes. The clock
38// skew is dealt with by observing the delay base in the other
39// direction, and adjusting our own upwards if the opposite direction
40// delay base keeps going down
41#define DELAY_BASE_HISTORY 13
42#define MAX_WINDOW_DECAY 100 // ms
43
44#define REORDER_BUFFER_SIZE 32
45#define REORDER_BUFFER_MAX_SIZE 511
46#define OUTGOING_BUFFER_MAX_SIZE 511
47
48#define PACKET_SIZE 350
49
50// this is the minimum max_window value. It can never drop below this
51#define MIN_WINDOW_SIZE 10
52
53// when window sizes are smaller than one packet_size, this
54// will pace the packets to average at the given window size
55// if it's not set, it will simply not send anything until
56// there's a timeout
57#define USE_PACKET_PACING 1
58
59// if we receive 4 or more duplicate acks, we resend the packet
60// that hasn't been acked yet
61#define DUPLICATE_ACKS_BEFORE_RESEND 3
62
63#define DELAYED_ACK_BYTE_THRESHOLD 2400 // bytes
64#define DELAYED_ACK_TIME_THRESHOLD 100 // milliseconds
65
66#define RST_INFO_TIMEOUT 10000
67#define RST_INFO_LIMIT 1000
68// 29 seconds determined from measuring many home NAT devices
69#define KEEPALIVE_INTERVAL 29000
70
71
72#define SEQ_NR_MASK 0xFFFF
73#define ACK_NR_MASK 0xFFFF
74
75#define DIV_ROUND_UP(num, denom) ((num + denom - 1) / denom)
76
77#include "utp_utils.h"
78#include "utp_config.h"
79
80#define LOG_UTP if (g_log_utp) utp_log
81#define LOG_UTPV if (g_log_utp_verbose) utp_log
82
83uint32 g_current_ms;
84
85// The totals are derived from the following data:
86//  45: IPv6 address including embedded IPv4 address
87//  11: Scope Id
88//   2: Brackets around IPv6 address when port is present
89//   6: Port (including colon)
90//   1: Terminating null byte
91char addrbuf[65];
92char addrbuf2[65];
93#define addrfmt(x, s) x.fmt(s, sizeof(s))
94
95#pragma pack(push,1)
96
97struct PackedSockAddr {
98
99        // The values are always stored here in network byte order
100        union {
101                byte _in6[16];          // IPv6
102                uint16 _in6w[8];        // IPv6, word based (for convenience)
103                uint32 _in6d[4];        // Dword access
104                in6_addr _in6addr;      // For convenience
105        } _in;
106
107        // Host byte order
108        uint16 _port;
109
110#define _sin4 _in._in6d[3]      // IPv4 is stored where it goes if mapped
111
112#define _sin6 _in._in6
113#define _sin6w _in._in6w
114#define _sin6d _in._in6d
115
116        byte get_family() const
117        {
118                return (IN6_IS_ADDR_V4MAPPED((in6_addr*)_sin6) != 0) ? AF_INET : AF_INET6;
119        }
120
121        bool operator==(const PackedSockAddr& rhs) const
122        {
123                if (&rhs == this)
124                        return true;
125                if (_port != rhs._port)
126                        return false;
127                return memcmp(_sin6, rhs._sin6, sizeof(_sin6)) == 0;
128        }
129        bool operator!=(const PackedSockAddr& rhs) const { return !(*this == rhs); }
130
131        PackedSockAddr(const SOCKADDR_STORAGE* sa, socklen_t len)
132        {
133                if (sa->ss_family == AF_INET) {
134                        assert(len >= sizeof(sockaddr_in));
135                        const sockaddr_in *sin = (sockaddr_in*)sa;
136                        _sin6w[0] = 0;
137                        _sin6w[1] = 0;
138                        _sin6w[2] = 0;
139                        _sin6w[3] = 0;
140                        _sin6w[4] = 0;
141                        _sin6w[5] = 0xffff;
142                        _sin4 = sin->sin_addr.s_addr;
143                        _port = ntohs(sin->sin_port);
144                } else {
145                        assert(len >= sizeof(sockaddr_in6));
146                        const sockaddr_in6 *sin6 = (sockaddr_in6*)sa;
147                        _in._in6addr = sin6->sin6_addr;
148                        _port = ntohs(sin6->sin6_port);
149                }
150        }
151
152        SOCKADDR_STORAGE get_sockaddr_storage(socklen_t *len = NULL) const
153        {
154                SOCKADDR_STORAGE sa;
155                const byte family = get_family();
156                if (family == AF_INET) {
157                        sockaddr_in *sin = (sockaddr_in*)&sa;
158                        if (len) *len = sizeof(sockaddr_in);
159                        memset(sin, 0, sizeof(sockaddr_in));
160                        sin->sin_family = family;
161                        sin->sin_port = htons(_port);
162                        sin->sin_addr.s_addr = _sin4;
163                } else {
164                        sockaddr_in6 *sin6 = (sockaddr_in6*)&sa;
165                        memset(sin6, 0, sizeof(sockaddr_in6));
166                        if (len) *len = sizeof(sockaddr_in6);
167                        sin6->sin6_family = family;
168                        sin6->sin6_addr = _in._in6addr;
169                        sin6->sin6_port = htons(_port);
170                }
171                return sa;
172        }
173
174        cstr fmt(str s, size_t len) const
175        {
176                memset(s, 0, len);
177                const byte family = get_family();
178                str i;
179                if (family == AF_INET) {
180                        inet_ntop(family, (uint32*)&_sin4, s, len);
181                        i = s;
182                        while (*++i) {}
183                } else {
184                        i = s;
185                        *i++ = '[';
186                        inet_ntop(family, (in6_addr*)&_in._in6addr, i, len-1);
187                        while (*++i) {}
188                        *i++ = ']';
189                }
190                snprintf(i, len - (i-s), ":%u", _port);
191                return s;
192        }
193};
194
195struct RST_Info {
196        PackedSockAddr addr;
197        uint32 connid;
198        uint32 timestamp;
199        uint16 ack_nr;
200};
201
202// these packet sizes are including the uTP header wich
203// is either 20 or 23 bytes depending on version
204#define PACKET_SIZE_EMPTY_BUCKET 0
205#define PACKET_SIZE_EMPTY 23
206#define PACKET_SIZE_SMALL_BUCKET 1
207#define PACKET_SIZE_SMALL 373
208#define PACKET_SIZE_MID_BUCKET 2
209#define PACKET_SIZE_MID 723
210#define PACKET_SIZE_BIG_BUCKET 3
211#define PACKET_SIZE_BIG 1400
212#define PACKET_SIZE_HUGE_BUCKET 4
213
214struct PacketFormat {
215        // connection ID
216        uint32_big connid;
217        uint32_big tv_sec;
218        uint32_big tv_usec;
219        uint32_big reply_micro;
220        // receive window size in PACKET_SIZE chunks
221        byte windowsize;
222        // Type of the first extension header
223        byte ext;
224        // Flags
225        byte flags;
226        // Sequence number
227        uint16_big seq_nr;
228        // Acknowledgment number
229        uint16_big ack_nr;
230};
231
232struct PacketFormatAck {
233        PacketFormat pf;
234        byte ext_next;
235        byte ext_len;
236        byte acks[4];
237};
238
239struct PacketFormatExtensions {
240        PacketFormat pf;
241        byte ext_next;
242        byte ext_len;
243        byte extensions[8];
244};
245
246struct PacketFormatV1 {
247        // packet_type (4 high bits)
248        // protocol version (4 low bits)
249        byte ver_type;
250        byte version() const { return ver_type & 0xf; }
251        byte type() const { return ver_type >> 4; }
252        void set_version(byte v) { ver_type = (ver_type & 0xf0) | (v & 0xf); }
253        void set_type(byte t) { ver_type = (ver_type & 0xf) | (t << 4); }
254
255        // Type of the first extension header
256        byte ext;
257        // connection ID
258        uint16_big connid;
259        uint32_big tv_usec;
260        uint32_big reply_micro;
261        // receive window size in bytes
262        uint32_big windowsize;
263        // Sequence number
264        uint16_big seq_nr;
265        // Acknowledgment number
266        uint16_big ack_nr;
267};
268
269struct PacketFormatAckV1 {
270        PacketFormatV1 pf;
271        byte ext_next;
272        byte ext_len;
273        byte acks[4];
274};
275
276struct PacketFormatExtensionsV1 {
277        PacketFormatV1 pf;
278        byte ext_next;
279        byte ext_len;
280        byte extensions[8];
281};
282
283#pragma pack(pop)
284
285enum {
286        ST_DATA = 0,            // Data packet.
287        ST_FIN = 1,                     // Finalize the connection. This is the last packet.
288        ST_STATE = 2,           // State packet. Used to transmit an ACK with no data.
289        ST_RESET = 3,           // Terminate connection forcefully.
290        ST_SYN = 4,                     // Connect SYN
291        ST_NUM_STATES,          // used for bounds checking
292};
293
294static const cstr flagnames[] = {
295        "ST_DATA","ST_FIN","ST_STATE","ST_RESET","ST_SYN"
296};
297
298enum CONN_STATE {
299        CS_IDLE = 0,
300        CS_SYN_SENT = 1,
301        CS_CONNECTED = 2,
302        CS_CONNECTED_FULL = 3,
303        CS_GOT_FIN = 4,
304        CS_DESTROY_DELAY = 5,
305        CS_FIN_SENT = 6,
306        CS_RESET = 7,
307        CS_DESTROY = 8,
308};
309
310static const cstr statenames[] = {
311        "IDLE","SYN_SENT","CONNECTED","CONNECTED_FULL","GOT_FIN","DESTROY_DELAY","FIN_SENT","RESET","DESTROY"
312};
313
314struct OutgoingPacket {
315        size_t length;
316        size_t payload;
317        uint64 time_sent; // microseconds
318        uint transmissions:31;
319        bool need_resend:1;
320        byte data[1];
321};
322
323void no_read(void *socket, const byte *bytes, size_t count) {}
324void no_write(void *socket, byte *bytes, size_t count) {}
325size_t no_rb_size(void *socket) { return 0; }
326void no_state(void *socket, int state) {}
327void no_error(void *socket, int errcode) {}
328void no_overhead(void *socket, bool send, size_t count, int type) {}
329
330UTPFunctionTable zero_funcs = {
331        &no_read,
332        &no_write,
333        &no_rb_size,
334        &no_state,
335        &no_error,
336        &no_overhead,
337};
338
339struct SizableCircularBuffer {
340        // This is the mask. Since it's always a power of 2, adding 1 to this value will return the size.
341        size_t mask;
342        // This is the elements that the circular buffer points to
343        void **elements;
344
345        void *get(size_t i) { assert(elements); return elements ? elements[i & mask] : NULL; }
346        void put(size_t i, void *data) { assert(elements); elements[i&mask] = data; }
347
348        void grow(size_t item, size_t index);
349        void ensure_size(size_t item, size_t index) { if (index > mask) grow(item, index); }
350        size_t size() { return mask + 1; }
351};
352
353static struct UTPGlobalStats _global_stats;
354
355// Item contains the element we want to make space for
356// index is the index in the list.
357void SizableCircularBuffer::grow(size_t item, size_t index)
358{
359        // Figure out the new size.
360        size_t size = mask + 1;
361        do size *= 2; while (index >= size);
362
363        // Allocate the new buffer
364        void **buf = (void**)calloc(size, sizeof(void*));
365
366        size--;
367
368        // Copy elements from the old buffer to the new buffer
369        for (size_t i = 0; i <= mask; i++) {
370                buf[(item - index + i) & size] = get(item - index + i);
371        }
372
373        // Swap to the newly allocated buffer
374        mask = size;
375        free(elements);
376        elements = buf;
377}
378
379// compare if lhs is less than rhs, taking wrapping
380// into account. if lhs is close to UINT_MAX and rhs
381// is close to 0, lhs is assumed to have wrapped and
382// considered smaller
383bool wrapping_compare_less(uint32 lhs, uint32 rhs)
384{
385        // distance walking from lhs to rhs, downwards
386        const uint32 dist_down = lhs - rhs;
387        // distance walking from lhs to rhs, upwards
388        const uint32 dist_up = rhs - lhs;
389
390        // if the distance walking up is shorter, lhs
391        // is less than rhs. If the distance walking down
392        // is shorter, then rhs is less than lhs
393        return dist_up < dist_down;
394}
395
396struct DelayHist {
397        uint32 delay_base;
398
399        // this is the history of delay samples,
400        // normalized by using the delay_base. These
401        // values are always greater than 0 and measures
402        // the queuing delay in microseconds
403        uint32 cur_delay_hist[CUR_DELAY_SIZE];
404        size_t cur_delay_idx;
405
406        // this is the history of delay_base. It's
407        // a number that doesn't have an absolute meaning
408        // only relative. It doesn't make sense to initialize
409        // it to anything other than values relative to
410        // what's been seen in the real world.
411        uint32 delay_base_hist[DELAY_BASE_HISTORY];
412        size_t delay_base_idx;
413        // the time when we last stepped the delay_base_idx
414        uint32 delay_base_time;
415
416        bool delay_base_initialized;
417
418        void clear()
419        {
420                delay_base_initialized = false;
421                delay_base = 0;
422                cur_delay_idx = 0;
423                delay_base_idx = 0;
424                delay_base_time = g_current_ms;
425                for (size_t i = 0; i < CUR_DELAY_SIZE; i++) {
426                        cur_delay_hist[i] = 0;
427                }
428                for (size_t i = 0; i < DELAY_BASE_HISTORY; i++) {
429                        delay_base_hist[i] = 0;
430                }
431        }
432
433        void shift(const uint32 offset)
434        {
435                // the offset should never be "negative"
436                // assert(offset < 0x10000000);
437
438                // increase all of our base delays by this amount
439                // this is used to take clock skew into account
440                // by observing the other side's changes in its base_delay
441                for (size_t i = 0; i < DELAY_BASE_HISTORY; i++) {
442                        delay_base_hist[i] += offset;
443                }
444                delay_base += offset;
445        }
446
447        void add_sample(const uint32 sample)
448        {
449                // The two clocks (in the two peers) are assumed not to
450                // progress at the exact same rate. They are assumed to be
451                // drifting, which causes the delay samples to contain
452                // a systematic error, either they are under-
453                // estimated or over-estimated. This is why we update the
454                // delay_base every two minutes, to adjust for this.
455
456                // This means the values will keep drifting and eventually wrap.
457                // We can cross the wrapping boundry in two directions, either
458                // going up, crossing the highest value, or going down, crossing 0.
459
460                // if the delay_base is close to the max value and sample actually
461                // wrapped on the other end we would see something like this:
462                // delay_base = 0xffffff00, sample = 0x00000400
463                // sample - delay_base = 0x500 which is the correct difference
464
465                // if the delay_base is instead close to 0, and we got an even lower
466                // sample (that will eventually update the delay_base), we may see
467                // something like this:
468                // delay_base = 0x00000400, sample = 0xffffff00
469                // sample - delay_base = 0xfffffb00
470                // this needs to be interpreted as a negative number and the actual
471                // recorded delay should be 0.
472
473                // It is important that all arithmetic that assume wrapping
474                // is done with unsigned intergers. Signed integers are not guaranteed
475                // to wrap the way unsigned integers do. At least GCC takes advantage
476                // of this relaxed rule and won't necessarily wrap signed ints.
477
478                // remove the clock offset and propagation delay.
479                // delay base is min of the sample and the current
480                // delay base. This min-operation is subject to wrapping
481                // and care needs to be taken to correctly choose the
482                // true minimum.
483
484                // specifically the problem case is when delay_base is very small
485                // and sample is very large (because it wrapped past zero), sample
486                // needs to be considered the smaller
487
488                if (!delay_base_initialized) {
489                        // delay_base being 0 suggests that we haven't initialized
490                        // it or its history with any real measurements yet. Initialize
491                        // everything with this sample.
492                        for (size_t i = 0; i < DELAY_BASE_HISTORY; i++) {
493                                // if we don't have a value, set it to the current sample
494                                delay_base_hist[i] = sample;
495                                continue;
496                        }
497                        delay_base = sample;
498                        delay_base_initialized = true;
499                }
500
501                if (wrapping_compare_less(sample, delay_base_hist[delay_base_idx])) {
502                        // sample is smaller than the current delay_base_hist entry
503                        // update it
504                        delay_base_hist[delay_base_idx] = sample;
505                }
506
507                // is sample lower than delay_base? If so, update delay_base
508                if (wrapping_compare_less(sample, delay_base)) {
509                        // sample is smaller than the current delay_base
510                        // update it
511                        delay_base = sample;
512                }
513               
514                // this operation may wrap, and is supposed to
515                const uint32 delay = sample - delay_base;
516                // sanity check. If this is triggered, something fishy is going on
517                // it means the measured sample was greater than 32 seconds!
518//              assert(delay < 0x2000000);
519
520                cur_delay_hist[cur_delay_idx] = delay;
521                cur_delay_idx = (cur_delay_idx + 1) % CUR_DELAY_SIZE;
522
523                // once every minute
524                if (g_current_ms - delay_base_time > 60 * 1000) {
525                        delay_base_time = g_current_ms;
526                        delay_base_idx = (delay_base_idx + 1) % DELAY_BASE_HISTORY;
527                        // clear up the new delay base history spot by initializing
528                        // it to the current sample, then update it
529                        delay_base_hist[delay_base_idx] = sample;
530                        delay_base = delay_base_hist[0];
531                        // Assign the lowest delay in the last 2 minutes to delay_base
532                        for (size_t i = 0; i < DELAY_BASE_HISTORY; i++) {
533                                if (wrapping_compare_less(delay_base_hist[i], delay_base))
534                                        delay_base = delay_base_hist[i];
535                        }
536                }
537        }
538
539        uint32 get_value()
540        {
541                uint32 value = UINT_MAX;
542                for (size_t i = 0; i < CUR_DELAY_SIZE; i++) {
543                        value = min<uint32>(cur_delay_hist[i], value);
544                }
545                // value could be UINT_MAX if we have no samples yet...
546                return value;
547        }
548};
549
550struct UTPSocket {
551        PackedSockAddr addr;
552
553        size_t idx;
554
555        uint16 reorder_count;
556        byte duplicate_ack;
557
558        // the number of bytes we've received but not acked yet
559        size_t bytes_since_ack;
560
561        // the number of packets in the send queue. Packets that haven't
562        // yet been sent count as well as packets marked as needing resend
563        // the oldest un-acked packet in the send queue is seq_nr - cur_window_packets
564        uint16 cur_window_packets;
565
566        // how much of the window is used, number of bytes in-flight
567        // packets that have not yet been sent do not count, packets
568        // that are marked as needing to be re-sent (due to a timeout)
569        // don't count either
570        size_t cur_window;
571        // maximum window size, in bytes
572        size_t max_window;
573        // SO_SNDBUF setting, in bytes
574        size_t opt_sndbuf;
575        // SO_RCVBUF setting, in bytes
576        size_t opt_rcvbuf;
577
578        // Is a FIN packet in the reassembly buffer?
579        bool got_fin:1;
580        // Timeout procedure
581        bool fast_timeout:1;
582
583        // max receive window for other end, in bytes
584        size_t max_window_user;
585        // 0 = original uTP header, 1 = second revision
586        byte version;
587        CONN_STATE state;
588        // TickCount when we last decayed window (wraps)
589        int32 last_rwin_decay;
590
591        // the sequence number of the FIN packet. This field is only set
592        // when we have received a FIN, and the flag field has the FIN flag set.
593        // it is used to know when it is safe to destroy the socket, we must have
594        // received all packets up to this sequence number first.
595        uint16 eof_pkt;
596
597        // All sequence numbers up to including this have been properly received
598        // by us
599        uint16 ack_nr;
600        // This is the sequence number for the next packet to be sent.
601        uint16 seq_nr;
602
603        uint16 timeout_seq_nr;
604
605        // This is the sequence number of the next packet we're allowed to
606        // do a fast resend with. This makes sure we only do a fast-resend
607        // once per packet. We can resend the packet with this sequence number
608        // or any later packet (with a higher sequence number).
609        uint16 fast_resend_seq_nr;
610
611        uint32 reply_micro;
612
613        // the time when we need to send another ack. If there's
614        // nothing to ack, this is a very large number
615        uint32 ack_time;
616
617        uint32 last_got_packet;
618        uint32 last_sent_packet;
619        uint32 last_measured_delay;
620        uint32 last_maxed_out_window;
621
622        // the last time we added send quota to the connection
623        // when adding send quota, this is subtracted from the
624        // current time multiplied by max_window / rtt
625        // which is the current allowed send rate.
626        int32 last_send_quota;
627
628        // the number of bytes we are allowed to send on
629        // this connection. If this is more than one packet
630        // size when we run out of data to send, it is clamped
631        // to the packet size
632        // this value is multiplied by 100 in order to get
633        // higher accuracy when dealing with low rates
634        int32 send_quota;
635
636        SendToProc *send_to_proc;
637        void *send_to_userdata;
638        UTPFunctionTable func;
639        void *userdata;
640
641        // Round trip time
642        uint rtt;
643        // Round trip time variance
644        uint rtt_var;
645        // Round trip timeout
646        uint rto;
647        DelayHist rtt_hist;
648        uint retransmit_timeout;
649        // The RTO timer will timeout here.
650        uint rto_timeout;
651        // When the window size is set to zero, start this timer. It will send a new packet every 30secs.
652        uint32 zerowindow_time;
653
654        uint32 conn_seed;
655        // Connection ID for packets I receive
656        uint32 conn_id_recv;
657        // Connection ID for packets I send
658        uint32 conn_id_send;
659        // Last rcv window we advertised, in bytes
660        size_t last_rcv_win;
661
662        DelayHist our_hist;
663        DelayHist their_hist;
664
665        // extension bytes from SYN packet
666        byte extensions[8];
667
668        SizableCircularBuffer inbuf, outbuf;
669
670#ifdef _DEBUG
671        // Public stats, returned by UTP_GetStats().  See utp.h
672        UTPStats _stats;
673#endif // _DEBUG
674
675        // Calculates the current receive window
676        size_t get_rcv_window() const
677        {
678                // If we don't have a connection (such as during connection
679                // establishment, always act as if we have an empty buffer).
680                if (!userdata) return opt_rcvbuf;
681
682                // Trim window down according to what's already in buffer.
683                const size_t numbuf = func.get_rb_size(userdata);
684                assert((int)numbuf >= 0);
685                return opt_rcvbuf > numbuf ? opt_rcvbuf - numbuf : 0;
686        }
687
688        // Test if we're ready to decay max_window
689        // XXX this breaks when spaced by > INT_MAX/2, which is 49
690        // days; the failure mode in that case is we do an extra decay
691        // or fail to do one when we really shouldn't.
692        bool can_decay_win(int32 msec) const
693        {
694                return msec - last_rwin_decay >= MAX_WINDOW_DECAY;
695        }
696
697        // If we can, decay max window, returns true if we actually did so
698        void maybe_decay_win()
699        {
700                if (can_decay_win(g_current_ms)) {
701                        // TCP uses 0.5
702                        max_window = (size_t)(max_window * .5);
703                        last_rwin_decay = g_current_ms;
704                        if (max_window < MIN_WINDOW_SIZE)
705                                max_window = MIN_WINDOW_SIZE;
706                }
707        }
708
709        size_t get_header_size() const
710        {
711                return (version ? sizeof(PacketFormatV1) : sizeof(PacketFormat));
712        }
713
714        size_t get_header_extensions_size() const
715        {
716                return (version ? sizeof(PacketFormatExtensionsV1) : sizeof(PacketFormatExtensions));
717        }
718
719        void sent_ack()
720        {
721                ack_time = g_current_ms + 0x70000000;
722                bytes_since_ack = 0;
723        }
724
725        size_t get_udp_mtu() const
726        {
727                socklen_t len;
728                SOCKADDR_STORAGE sa = addr.get_sockaddr_storage(&len);
729                return UTP_GetUDPMTU((const struct sockaddr *)&sa, len);
730        }
731
732        size_t get_udp_overhead() const
733        {
734                socklen_t len;
735                SOCKADDR_STORAGE sa = addr.get_sockaddr_storage(&len);
736                return UTP_GetUDPOverhead((const struct sockaddr *)&sa, len);
737        }
738
739        uint64 get_global_utp_bytes_sent() const
740        {
741                socklen_t len;
742                SOCKADDR_STORAGE sa = addr.get_sockaddr_storage(&len);
743                return UTP_GetGlobalUTPBytesSent((const struct sockaddr *)&sa, len);
744        }
745
746        size_t get_overhead() const
747        {
748                return get_udp_overhead() + get_header_size();
749        }
750
751        void send_data(PacketFormat* b, size_t length, bandwidth_type_t type);
752
753        void send_ack(bool synack = false);
754
755        void send_keep_alive();
756
757        static void send_rst(SendToProc *send_to_proc, void *send_to_userdata,
758                                                 const PackedSockAddr &addr, uint32 conn_id_send,
759                                                 uint16 ack_nr, uint16 seq_nr, byte version);
760
761        void send_packet(OutgoingPacket *pkt);
762
763        bool is_writable(size_t to_write);
764
765        bool flush_packets();
766
767        void write_outgoing_packet(size_t payload, uint flags);
768
769        void update_send_quota();
770
771#ifdef _DEBUG
772        void check_invariant();
773#endif
774
775        void check_timeouts();
776
777        int ack_packet(uint16 seq);
778
779        size_t selective_ack_bytes(uint base, const byte* mask, byte len, int64& min_rtt);
780
781        void selective_ack(uint base, const byte *mask, byte len);
782
783        void apply_ledbat_ccontrol(size_t bytes_acked, uint32 actual_delay, int64 min_rtt);
784
785        size_t get_packet_size();
786};
787
788Array<RST_Info> g_rst_info;
789Array<UTPSocket*> g_utp_sockets;
790
791static void UTP_RegisterSentPacket(size_t length) {
792        if (length <= PACKET_SIZE_MID) {
793                if (length <= PACKET_SIZE_EMPTY) {
794                        _global_stats._nraw_send[PACKET_SIZE_EMPTY_BUCKET]++;
795                } else if (length <= PACKET_SIZE_SMALL) {
796                        _global_stats._nraw_send[PACKET_SIZE_SMALL_BUCKET]++;
797                } else
798                        _global_stats._nraw_send[PACKET_SIZE_MID_BUCKET]++;
799        } else {
800                if (length <= PACKET_SIZE_BIG) {
801                        _global_stats._nraw_send[PACKET_SIZE_BIG_BUCKET]++;
802                } else
803                        _global_stats._nraw_send[PACKET_SIZE_HUGE_BUCKET]++;
804        }
805}
806
807void send_to_addr(SendToProc *send_to_proc, void *send_to_userdata, const byte *p, size_t len, const PackedSockAddr &addr)
808{
809        socklen_t tolen;
810        SOCKADDR_STORAGE to = addr.get_sockaddr_storage(&tolen);
811        UTP_RegisterSentPacket(len);
812        send_to_proc(send_to_userdata, p, len, (const struct sockaddr *)&to, tolen);
813}
814
815void UTPSocket::send_data(PacketFormat* b, size_t length, bandwidth_type_t type)
816{
817        // time stamp this packet with local time, the stamp goes into
818        // the header of every packet at the 8th byte for 8 bytes :
819        // two integers, check packet.h for more
820        uint64 time = UTP_GetMicroseconds();
821
822        PacketFormatV1* b1 = (PacketFormatV1*)b;
823        if (version == 0) {
824                b->tv_sec = (uint32)(time / 1000000);
825                b->tv_usec = time % 1000000;
826                b->reply_micro = reply_micro;
827        } else {
828                b1->tv_usec = (uint32)time;
829                b1->reply_micro = reply_micro;
830        }
831
832        last_sent_packet = g_current_ms;
833
834#ifdef _DEBUG
835        _stats._nbytes_xmit += length;
836        ++_stats._nxmit;
837#endif
838        if (userdata) {
839                size_t n;
840                if (type == payload_bandwidth) {
841                        // if this packet carries payload, just
842                        // count the header as overhead
843                        type = header_overhead;
844                        n = get_overhead();
845                } else {
846                        n = length + get_udp_overhead();
847                }
848                func.on_overhead(userdata, true, n, type);
849        }
850#if g_log_utp_verbose
851        int flags = version == 0 ? b->flags : b1->type();
852        uint16 seq_nr = version == 0 ? b->seq_nr : b1->seq_nr;
853        uint16 ack_nr = version == 0 ? b->ack_nr : b1->ack_nr;
854        LOG_UTPV("0x%08x: send %s len:%u id:%u timestamp:"I64u" reply_micro:%u flags:%s seq_nr:%u ack_nr:%u",
855                         this, addrfmt(addr, addrbuf), (uint)length, conn_id_send, time, reply_micro, flagnames[flags],
856                         seq_nr, ack_nr);
857#endif
858        send_to_addr(send_to_proc, send_to_userdata, (const byte*)b, length, addr);
859}
860
861void UTPSocket::send_ack(bool synack)
862{
863        PacketFormatExtensions pfe;
864        zeromem(&pfe);
865        PacketFormatExtensionsV1& pfe1 = (PacketFormatExtensionsV1&)pfe;
866        PacketFormatAck& pfa = (PacketFormatAck&)pfe1;
867        PacketFormatAckV1& pfa1 = (PacketFormatAckV1&)pfe1;
868
869        size_t len;
870        last_rcv_win = get_rcv_window();
871        if (version == 0) {
872                pfa.pf.connid = conn_id_send;
873                pfa.pf.ack_nr = (uint16)ack_nr;
874                pfa.pf.seq_nr = (uint16)seq_nr;
875                pfa.pf.flags = ST_STATE;
876                pfa.pf.ext = 0;
877                pfa.pf.windowsize = (byte)DIV_ROUND_UP(last_rcv_win, PACKET_SIZE);
878                len = sizeof(PacketFormat);
879        } else {
880                pfa1.pf.set_version(1);
881                pfa1.pf.set_type(ST_STATE);
882                pfa1.pf.ext = 0;
883                pfa1.pf.connid = conn_id_send;
884                pfa1.pf.ack_nr = ack_nr;
885                pfa1.pf.seq_nr = seq_nr;
886                pfa1.pf.windowsize = (uint32)last_rcv_win;
887                len = sizeof(PacketFormatV1);
888        }
889
890        // we never need to send EACK for connections
891        // that are shutting down
892        if (reorder_count != 0 && state < CS_GOT_FIN) {
893                // if reorder count > 0, send an EACK.
894                // reorder count should always be 0
895                // for synacks, so this should not be
896                // as synack
897                assert(!synack);
898                if (version == 0) {
899                        pfa.pf.ext = 1;
900                        pfa.ext_next = 0;
901                        pfa.ext_len = 4;
902                } else {
903                        pfa1.pf.ext = 1;
904                        pfa1.ext_next = 0;
905                        pfa1.ext_len = 4;
906                }
907                uint m = 0;
908
909                // reorder count should only be non-zero
910                // if the packet ack_nr + 1 has not yet
911                // been received
912                assert(inbuf.get(ack_nr + 1) == NULL);
913                size_t window = min<size_t>(14+16, inbuf.size());
914                // Generate bit mask of segments received.
915                for (size_t i = 0; i < window; i++) {
916                        if (inbuf.get(ack_nr + i + 2) != NULL) {
917                                m |= 1 << i;
918                                LOG_UTPV("0x%08x: EACK packet [%u]", this, ack_nr + i + 2);
919                        }
920                }
921                if (version == 0) {
922                        pfa.acks[0] = (byte)m;
923                        pfa.acks[1] = (byte)(m >> 8);
924                        pfa.acks[2] = (byte)(m >> 16);
925                        pfa.acks[3] = (byte)(m >> 24);
926                } else {
927                        pfa1.acks[0] = (byte)m;
928                        pfa1.acks[1] = (byte)(m >> 8);
929                        pfa1.acks[2] = (byte)(m >> 16);
930                        pfa1.acks[3] = (byte)(m >> 24);
931                }
932                len += 4 + 2;
933                LOG_UTPV("0x%08x: Sending EACK %u [%u] bits:[%032b]", this, ack_nr, conn_id_send, m);
934        } else if (synack) {
935                // we only send "extensions" in response to SYN
936                // and the reorder count is 0 in that state
937
938                LOG_UTPV("0x%08x: Sending ACK %u [%u] with extension bits", this, ack_nr, conn_id_send);
939                if (version == 0) {
940                        pfe.pf.ext = 2;
941                        pfe.ext_next = 0;
942                        pfe.ext_len = 8;
943                        memset(pfe.extensions, 0, 8);
944                } else {
945                        pfe1.pf.ext = 2;
946                        pfe1.ext_next = 0;
947                        pfe1.ext_len = 8;
948                        memset(pfe1.extensions, 0, 8);
949                }
950                len += 8 + 2;
951        } else {
952                LOG_UTPV("0x%08x: Sending ACK %u [%u]", this, ack_nr, conn_id_send);
953        }
954
955        sent_ack();
956        send_data((PacketFormat*)&pfe, len, ack_overhead);
957}
958
959void UTPSocket::send_keep_alive()
960{
961        ack_nr--;
962        LOG_UTPV("0x%08x: Sending KeepAlive ACK %u [%u]", this, ack_nr, conn_id_send);
963        send_ack();
964        ack_nr++;
965}
966
967void UTPSocket::send_rst(SendToProc *send_to_proc, void *send_to_userdata,
968                                                 const PackedSockAddr &addr, uint32 conn_id_send, uint16 ack_nr, uint16 seq_nr, byte version)
969{
970        PacketFormat pf;
971        zeromem(&pf);
972        PacketFormatV1& pf1 = (PacketFormatV1&)pf;
973
974        size_t len;
975        if (version == 0) {
976                pf.connid = conn_id_send;
977                pf.ack_nr = ack_nr;
978                pf.seq_nr = seq_nr;
979                pf.flags = ST_RESET;
980                pf.ext = 0;
981                pf.windowsize = 0;
982                len = sizeof(PacketFormat);
983        } else {
984                pf1.set_version(1);
985                pf1.set_type(ST_RESET);
986                pf1.ext = 0;
987                pf1.connid = conn_id_send;
988                pf1.ack_nr = ack_nr;
989                pf1.seq_nr = seq_nr;
990                pf1.windowsize = 0;
991                len = sizeof(PacketFormatV1);
992        }
993
994        LOG_UTPV("%s: Sending RST id:%u seq_nr:%u ack_nr:%u", addrfmt(addr, addrbuf), conn_id_send, seq_nr, ack_nr);
995        LOG_UTPV("send %s len:%u id:%u", addrfmt(addr, addrbuf), (uint)len, conn_id_send);
996        send_to_addr(send_to_proc, send_to_userdata, (const byte*)&pf1, len, addr);
997}
998
999void UTPSocket::send_packet(OutgoingPacket *pkt)
1000{
1001        // only count against the quota the first time we
1002        // send the packet. Don't enforce quota when closing
1003        // a socket. Only enforce the quota when we're sending
1004        // at slow rates (max window < packet size)
1005        size_t max_send = min(max_window, opt_sndbuf, max_window_user);
1006
1007        if (pkt->transmissions == 0 || pkt->need_resend) {
1008                cur_window += pkt->payload;
1009        }
1010
1011        size_t packet_size = get_packet_size();
1012        if (pkt->transmissions == 0 && max_send < packet_size) {
1013                assert(state == CS_FIN_SENT ||
1014                           (int32)pkt->payload <= send_quota / 100);
1015                send_quota = send_quota - (int32)(pkt->payload * 100);
1016        }
1017
1018        pkt->need_resend = false;
1019
1020        PacketFormatV1* p1 = (PacketFormatV1*)pkt->data;
1021        PacketFormat* p = (PacketFormat*)pkt->data;
1022        if (version == 0) {
1023                p->ack_nr = ack_nr;
1024        } else {
1025                p1->ack_nr = ack_nr;
1026        }
1027        pkt->time_sent = UTP_GetMicroseconds();
1028        pkt->transmissions++;
1029        sent_ack();
1030        send_data((PacketFormat*)pkt->data, pkt->length,
1031                (state == CS_SYN_SENT) ? connect_overhead
1032                : (pkt->transmissions == 1) ? payload_bandwidth
1033                : retransmit_overhead);
1034}
1035
1036bool UTPSocket::is_writable(size_t to_write)
1037{
1038        // return true if it's OK to stuff another packet into the
1039        // outgoing queue. Since we may be using packet pacing, we
1040        // might not actually send the packet right away to affect the
1041        // cur_window. The only thing that happens when we add another
1042        // packet is that cur_window_packets is increased.
1043        size_t max_send = min(max_window, opt_sndbuf, max_window_user);
1044
1045        size_t packet_size = get_packet_size();
1046
1047        if (cur_window + packet_size >= max_window)
1048                last_maxed_out_window = g_current_ms;
1049
1050        // if we don't have enough quota, we can't write regardless
1051        if (USE_PACKET_PACING) {
1052                if (send_quota / 100 < (int32)to_write) return false;
1053        }
1054
1055        // subtract one to save space for the FIN packet
1056        if (cur_window_packets >= OUTGOING_BUFFER_MAX_SIZE - 1) return false;
1057
1058        // if sending another packet would not make the window exceed
1059        // the max_window, we can write
1060        if (cur_window + packet_size <= max_send) return true;
1061
1062        // if the window size is less than a packet, and we have enough
1063        // quota to send a packet, we can write, even though it would
1064        // make the window exceed the max size
1065        // the last condition is needed to not put too many packets
1066        // in the send buffer. cur_window isn't updated until we flush
1067        // the send buffer, so we need to take the number of packets
1068        // into account
1069        if (USE_PACKET_PACING) {
1070                if (max_window < to_write &&
1071                        cur_window < max_window &&
1072                        cur_window_packets == 0) {
1073                        return true;
1074                }
1075        }
1076
1077        return false;
1078}
1079
1080bool UTPSocket::flush_packets()
1081{
1082        size_t packet_size = get_packet_size();
1083
1084        // send packets that are waiting on the pacer to be sent
1085        // i has to be an unsigned 16 bit counter to wrap correctly
1086        // signed types are not guaranteed to wrap the way you expect
1087        for (uint16 i = seq_nr - cur_window_packets; i != seq_nr; ++i) {
1088                OutgoingPacket *pkt = (OutgoingPacket*)outbuf.get(i);
1089                if (pkt == 0 || (pkt->transmissions > 0 && pkt->need_resend == false)) continue;
1090                // have we run out of quota?
1091                if (!is_writable(pkt->payload)) {
1092                        return true;
1093                }
1094
1095                // Nagle check
1096                // don't send the last packet if we have one packet in-flight
1097                // and the current packet is still smaller than packet_size.
1098                if (i != ((seq_nr - 1) & ACK_NR_MASK) ||
1099                        cur_window_packets == 1 ||
1100                        pkt->payload >= packet_size) {
1101                        send_packet(pkt);
1102
1103                        // No need to send another ack if there is nothing to reorder.
1104                        if (reorder_count == 0) {
1105                                sent_ack();
1106                        }
1107                }
1108        }
1109        return false;
1110}
1111
1112void UTPSocket::write_outgoing_packet(size_t payload, uint flags)
1113{
1114        // Setup initial timeout timer
1115        if (cur_window_packets == 0) {
1116                retransmit_timeout = rto;
1117                rto_timeout = g_current_ms + retransmit_timeout;
1118                assert(cur_window == 0);
1119        }
1120
1121        size_t packet_size = get_packet_size();
1122        do {
1123                assert(cur_window_packets < OUTGOING_BUFFER_MAX_SIZE);
1124                assert(flags == ST_DATA || flags == ST_FIN);
1125
1126                size_t added = 0;
1127
1128                OutgoingPacket *pkt = NULL;
1129               
1130                if (cur_window_packets > 0) {
1131                        pkt = (OutgoingPacket*)outbuf.get(seq_nr - 1);
1132                }
1133
1134                const size_t header_size = get_header_size();
1135                bool append = true;
1136
1137                // if there's any room left in the last packet in the window
1138                // and it hasn't been sent yet, fill that frame first
1139                if (payload && pkt && !pkt->transmissions && pkt->payload < packet_size) {
1140                        // Use the previous unsent packet
1141                        added = min(payload + pkt->payload, max<size_t>(packet_size, pkt->payload)) - pkt->payload;
1142                        pkt = (OutgoingPacket*)realloc(pkt,
1143                                                                                   (sizeof(OutgoingPacket) - 1) +
1144                                                                                   header_size +
1145                                                                                   pkt->payload + added);
1146                        outbuf.put(seq_nr - 1, pkt);
1147                        append = false;
1148                        assert(!pkt->need_resend);
1149                } else {
1150                        // Create the packet to send.
1151                        added = payload;
1152                        pkt = (OutgoingPacket*)malloc((sizeof(OutgoingPacket) - 1) +
1153                                                                                  header_size +
1154                                                                                  added);
1155                        pkt->payload = 0;
1156                        pkt->transmissions = 0;
1157                        pkt->need_resend = false;
1158                }
1159
1160                if (added) {
1161                        // Fill it with data from the upper layer.
1162                        func.on_write(userdata, pkt->data + header_size + pkt->payload, added);
1163                }
1164                pkt->payload += added;
1165                pkt->length = header_size + pkt->payload;
1166
1167                last_rcv_win = get_rcv_window();
1168
1169                PacketFormat* p = (PacketFormat*)pkt->data;
1170                PacketFormatV1* p1 = (PacketFormatV1*)pkt->data;
1171                if (version == 0) {
1172                        p->connid = conn_id_send;
1173                        p->ext = 0;
1174                        p->windowsize = (byte)DIV_ROUND_UP(last_rcv_win, PACKET_SIZE);
1175                        p->ack_nr = ack_nr;
1176                        p->flags = flags;
1177                } else {
1178                        p1->set_version(1);
1179                        p1->set_type(flags);
1180                        p1->ext = 0;
1181                        p1->connid = conn_id_send;
1182                        p1->windowsize = (uint32)last_rcv_win;
1183                        p1->ack_nr = ack_nr;
1184                }
1185
1186                if (append) {
1187                        // Remember the message in the outgoing queue.
1188                        outbuf.ensure_size(seq_nr, cur_window_packets);
1189                        outbuf.put(seq_nr, pkt);
1190                        if (version == 0) p->seq_nr = seq_nr;
1191                        else p1->seq_nr = seq_nr;
1192                        seq_nr++;
1193                        cur_window_packets++;
1194                }
1195
1196                payload -= added;
1197
1198        } while (payload);
1199
1200        flush_packets();
1201}
1202
1203void UTPSocket::update_send_quota()
1204{
1205        int dt = g_current_ms - last_send_quota;
1206        if (dt == 0) return;
1207        last_send_quota = g_current_ms;
1208        size_t add = max_window * dt * 100 / (rtt_hist.delay_base?rtt_hist.delay_base:50);
1209        if (add > max_window * 100 && add > MAX_CWND_INCREASE_BYTES_PER_RTT * 100) add = max_window;
1210        send_quota += (int32)add;
1211//      LOG_UTPV("0x%08x: UTPSocket::update_send_quota dt:%d rtt:%u max_window:%u quota:%d",
1212//                       this, dt, rtt, (uint)max_window, send_quota / 100);
1213}
1214
1215#ifdef _DEBUG
1216void UTPSocket::check_invariant()
1217{
1218        if (reorder_count > 0) {
1219                assert(inbuf.get(ack_nr + 1) == NULL);
1220        }
1221
1222        size_t outstanding_bytes = 0;
1223        for (int i = 0; i < cur_window_packets; ++i) {
1224                OutgoingPacket *pkt = (OutgoingPacket*)outbuf.get(seq_nr - i - 1);
1225                if (pkt == 0 || pkt->transmissions == 0 || pkt->need_resend) continue;
1226                outstanding_bytes += pkt->payload;
1227        }
1228        assert(outstanding_bytes == cur_window);
1229}
1230#endif
1231
1232void UTPSocket::check_timeouts()
1233{
1234#ifdef _DEBUG
1235        check_invariant();
1236#endif
1237
1238        // this invariant should always be true
1239        assert(cur_window_packets == 0 || outbuf.get(seq_nr - cur_window_packets));
1240
1241        LOG_UTPV("0x%08x: CheckTimeouts timeout:%d max_window:%u cur_window:%u quota:%d "
1242                         "state:%s cur_window_packets:%u bytes_since_ack:%u ack_time:%d",
1243                         this, (int)(rto_timeout - g_current_ms), (uint)max_window, (uint)cur_window,
1244                         send_quota / 100, statenames[state], cur_window_packets,
1245                         (uint)bytes_since_ack, (int)(g_current_ms - ack_time));
1246
1247        update_send_quota();
1248        flush_packets();
1249
1250
1251        if (USE_PACKET_PACING) {
1252                // In case the new send quota made it possible to send another packet
1253                // Mark the socket as writable. If we don't use pacing, the send
1254                // quota does not affect if the socket is writeable
1255                // if we don't use packet pacing, the writable event is triggered
1256                // whenever the cur_window falls below the max_window, so we don't
1257                // need this check then
1258                if (state == CS_CONNECTED_FULL && is_writable(get_packet_size())) {
1259                        state = CS_CONNECTED;
1260                        LOG_UTPV("0x%08x: Socket writable. max_window:%u cur_window:%u quota:%d packet_size:%u",
1261                                         this, (uint)max_window, (uint)cur_window, send_quota / 100, (uint)get_packet_size());
1262                        func.on_state(userdata, UTP_STATE_WRITABLE);
1263                }
1264        }
1265
1266        switch (state) {
1267        case CS_SYN_SENT:
1268        case CS_CONNECTED_FULL:
1269        case CS_CONNECTED:
1270        case CS_FIN_SENT: {
1271
1272                // Reset max window...
1273                if ((int)(g_current_ms - zerowindow_time) >= 0 && max_window_user == 0) {
1274                        max_window_user = PACKET_SIZE;
1275                }
1276
1277                if ((int)(g_current_ms - rto_timeout) >= 0 &&
1278                        (!(USE_PACKET_PACING) || cur_window_packets > 0) &&
1279                        rto_timeout > 0) {
1280
1281                        /*
1282                        OutgoingPacket *pkt = (OutgoingPacket*)outbuf.get(seq_nr - cur_window_packets);
1283                       
1284                        // If there were a lot of retransmissions, force recomputation of round trip time
1285                        if (pkt->transmissions >= 4)
1286                                rtt = 0;
1287                        */
1288
1289                        // Increase RTO
1290                        const uint new_timeout = retransmit_timeout * 2;
1291                        if (new_timeout >= 30000 || (state == CS_SYN_SENT && new_timeout > 6000)) {
1292                                // more than 30 seconds with no reply. kill it.
1293                                // if we haven't even connected yet, give up sooner. 6 seconds
1294                                // means 2 tries at the following timeouts: 3, 6 seconds
1295                                if (state == CS_FIN_SENT)
1296                                        state = CS_DESTROY;
1297                                else
1298                                        state = CS_RESET;
1299                                func.on_error(userdata, ETIMEDOUT);
1300                                goto getout;
1301                        }
1302
1303                        retransmit_timeout = new_timeout;
1304                        rto_timeout = g_current_ms + new_timeout;
1305
1306                        // On Timeout
1307                        duplicate_ack = 0;
1308
1309                        // rate = min_rate
1310                        max_window = get_packet_size();
1311                        send_quota = max<int32>((int32)max_window * 100, send_quota);
1312
1313                        // every packet should be considered lost
1314                        for (int i = 0; i < cur_window_packets; ++i) {
1315                                OutgoingPacket *pkt = (OutgoingPacket*)outbuf.get(seq_nr - i - 1);
1316                                if (pkt == 0 || pkt->transmissions == 0 || pkt->need_resend) continue;
1317                                pkt->need_resend = true;
1318                                assert(cur_window >= pkt->payload);
1319                                cur_window -= pkt->payload;
1320                        }
1321
1322                        // used in parse_log.py
1323                        LOG_UTP("0x%08x: Packet timeout. Resend. seq_nr:%u. timeout:%u max_window:%u",
1324                                        this, seq_nr - cur_window_packets, retransmit_timeout, (uint)max_window);
1325
1326                        fast_timeout = true;
1327                        timeout_seq_nr = seq_nr;
1328
1329                        if (cur_window_packets > 0) {
1330                                OutgoingPacket *pkt = (OutgoingPacket*)outbuf.get(seq_nr - cur_window_packets);
1331                                assert(pkt);
1332                                send_quota = max<int32>((int32)pkt->length * 100, send_quota);
1333
1334                                // Re-send the packet.
1335                                send_packet(pkt);
1336                        }
1337                }
1338
1339                // Mark the socket as writable
1340                if (state == CS_CONNECTED_FULL && is_writable(get_packet_size())) {
1341                        state = CS_CONNECTED;
1342                        LOG_UTPV("0x%08x: Socket writable. max_window:%u cur_window:%u quota:%d packet_size:%u",
1343                                         this, (uint)max_window, (uint)cur_window, send_quota / 100, (uint)get_packet_size());
1344                        func.on_state(userdata, UTP_STATE_WRITABLE);
1345                }
1346
1347                if (state >= CS_CONNECTED && state <= CS_FIN_SENT) {
1348                        // Send acknowledgment packets periodically, or when the threshold is reached
1349                        if (bytes_since_ack > DELAYED_ACK_BYTE_THRESHOLD ||
1350                                (int)(g_current_ms - ack_time) >= 0) {
1351                                send_ack();
1352                        }
1353
1354                        if ((int)(g_current_ms - last_sent_packet) >= KEEPALIVE_INTERVAL) {
1355                                send_keep_alive();
1356                        }
1357                }
1358
1359                break;
1360        }
1361
1362        // Close?
1363        case CS_GOT_FIN:
1364        case CS_DESTROY_DELAY:
1365                if ((int)(g_current_ms - rto_timeout) >= 0) {
1366                        state = (state == CS_DESTROY_DELAY) ? CS_DESTROY : CS_RESET;
1367                        if (cur_window_packets > 0 && userdata) {
1368                                func.on_error(userdata, ECONNRESET);
1369                        }
1370                }
1371                break;
1372        // prevent warning
1373        case CS_IDLE:
1374        case CS_RESET:
1375        case CS_DESTROY:
1376                break;
1377        }
1378
1379        getout:
1380
1381        // make sure we don't accumulate quota when we don't have
1382        // anything to send
1383        int32 limit = max<int32>((int32)max_window / 2, 5 * (int32)get_packet_size()) * 100;
1384        if (send_quota > limit) send_quota = limit;
1385}
1386
1387// returns:
1388// 0: the packet was acked.
1389// 1: it means that the packet had already been acked
1390// 2: the packet has not been sent yet
1391int UTPSocket::ack_packet(uint16 seq)
1392{
1393        OutgoingPacket *pkt = (OutgoingPacket*)outbuf.get(seq);
1394
1395        // the packet has already been acked (or not sent)
1396        if (pkt == NULL) {
1397                LOG_UTPV("0x%08x: got ack for:%u (already acked, or never sent)", this, seq);
1398                return 1;
1399        }
1400
1401        // can't ack packets that haven't been sent yet!
1402        if (pkt->transmissions == 0) {
1403                LOG_UTPV("0x%08x: got ack for:%u (never sent, pkt_size:%u need_resend:%u)",
1404                                 this, seq, (uint)pkt->payload, pkt->need_resend);
1405                return 2;
1406        }
1407
1408        LOG_UTPV("0x%08x: got ack for:%u (pkt_size:%u need_resend:%u)",
1409                         this, seq, (uint)pkt->payload, pkt->need_resend);
1410
1411        outbuf.put(seq, NULL);
1412
1413        // if we never re-sent the packet, update the RTT estimate
1414        if (pkt->transmissions == 1) {
1415                // Estimate the round trip time.
1416                const uint32 ertt = (uint32)((UTP_GetMicroseconds() - pkt->time_sent) / 1000);
1417                if (rtt == 0) {
1418                        // First round trip time sample
1419                        rtt = ertt;
1420                        rtt_var = ertt / 2;
1421                        // sanity check. rtt should never be more than 6 seconds
1422//                      assert(rtt < 6000);
1423                } else {
1424                        // Compute new round trip times
1425                        const int delta = (int)rtt - ertt;
1426                        rtt_var = rtt_var + (int)(abs(delta) - rtt_var) / 4;
1427                        rtt = rtt - rtt/8 + ertt/8;
1428                        // sanity check. rtt should never be more than 6 seconds
1429//                      assert(rtt < 6000);
1430                        rtt_hist.add_sample(ertt);
1431                }
1432                rto = max<uint>(rtt + rtt_var * 4, 500);
1433                LOG_UTPV("0x%08x: rtt:%u avg:%u var:%u rto:%u",
1434                                 this, ertt, rtt, rtt_var, rto);
1435        }
1436        retransmit_timeout = rto;
1437        rto_timeout = g_current_ms + rto;
1438        // if need_resend is set, this packet has already
1439        // been considered timed-out, and is not included in
1440        // the cur_window anymore
1441        if (!pkt->need_resend) {
1442                assert(cur_window >= pkt->payload);
1443                cur_window -= pkt->payload;
1444        }
1445        free(pkt);
1446        return 0;
1447}
1448
1449// count the number of bytes that were acked by the EACK header
1450size_t UTPSocket::selective_ack_bytes(uint base, const byte* mask, byte len, int64& min_rtt)
1451{
1452        if (cur_window_packets == 0) return 0;
1453
1454        size_t acked_bytes = 0;
1455        int bits = len * 8;
1456
1457        do {
1458                uint v = base + bits;
1459
1460                // ignore bits that haven't been sent yet
1461                // see comment in UTPSocket::selective_ack
1462                if (((seq_nr - v - 1) & ACK_NR_MASK) >= (uint16)(cur_window_packets - 1))
1463                        continue;
1464
1465                // ignore bits that represents packets we haven't sent yet
1466                // or packets that have already been acked
1467                OutgoingPacket *pkt = (OutgoingPacket*)outbuf.get(v);
1468                if (!pkt || pkt->transmissions == 0)
1469                        continue;
1470
1471                // Count the number of segments that were successfully received past it.
1472                if (bits >= 0 && mask[bits>>3] & (1 << (bits & 7))) {
1473                        assert((int)(pkt->payload) >= 0);
1474                        acked_bytes += pkt->payload;
1475                        min_rtt = min<int64>(min_rtt, UTP_GetMicroseconds() - pkt->time_sent);
1476                        continue;
1477                }
1478        } while (--bits >= -1);
1479        return acked_bytes;
1480}
1481
1482void UTPSocket::selective_ack(uint base, const byte *mask, byte len)
1483{
1484        if (cur_window_packets == 0) return;
1485
1486        // the range is inclusive [0, 31] bits
1487        int bits = len * 8 - 1;
1488
1489        int count = 0;
1490
1491        // resends is a stack of sequence numbers we need to resend. Since we
1492        // iterate in reverse over the acked packets, at the end, the top packets
1493        // are the ones we want to resend
1494        int resends[32];
1495        int nr = 0;
1496
1497        LOG_UTPV("0x%08x: Got EACK [%032b] base:%u", this, *(uint32*)mask, base);
1498        do {
1499                // we're iterating over the bits from higher sequence numbers
1500                // to lower (kind of in reverse order, wich might not be very
1501                // intuitive)
1502                uint v = base + bits;
1503
1504                // ignore bits that haven't been sent yet
1505                // and bits that fall below the ACKed sequence number
1506                // this can happen if an EACK message gets
1507                // reordered and arrives after a packet that ACKs up past
1508                // the base for thie EACK message
1509
1510                // this is essentially the same as:
1511                // if v >= seq_nr || v <= seq_nr - cur_window_packets
1512                // but it takes wrapping into account
1513
1514                // if v == seq_nr the -1 will make it wrap. if v > seq_nr
1515                // it will also wrap (since it will fall further below 0)
1516                // and be > cur_window_packets.
1517                // if v == seq_nr - cur_window_packets, the result will be
1518                // seq_nr - (seq_nr - cur_window_packets) - 1
1519                // == seq_nr - seq_nr + cur_window_packets - 1
1520                // == cur_window_packets - 1 which will be caught by the
1521                // test. If v < seq_nr - cur_window_packets the result will grow
1522                // fall furhter outside of the cur_window_packets range.
1523
1524                // sequence number space:
1525                //
1526                //     rejected <   accepted   > rejected
1527                // <============+--------------+============>
1528                //              ^              ^
1529                //              |              |
1530                //        (seq_nr-wnd)         seq_nr
1531
1532                if (((seq_nr - v - 1) & ACK_NR_MASK) >= (uint16)(cur_window_packets - 1))
1533                        continue;
1534
1535                // this counts as a duplicate ack, even though we might have
1536                // received an ack for this packet previously (in another EACK
1537                // message for instance)
1538                bool bit_set = bits >= 0 && mask[bits>>3] & (1 << (bits & 7));
1539
1540                // if this packet is acked, it counts towards the duplicate ack counter
1541                if (bit_set) count++;
1542
1543                // ignore bits that represents packets we haven't sent yet
1544                // or packets that have already been acked
1545                OutgoingPacket *pkt = (OutgoingPacket*)outbuf.get(v);
1546                if (!pkt || pkt->transmissions == 0) {
1547                        LOG_UTPV("0x%08x: skipping %u. pkt:%08x transmissions:%u %s",
1548                                         this, v, pkt, pkt?pkt->transmissions:0, pkt?"(not sent yet?)":"(already acked?)");
1549                        continue;
1550                }
1551
1552                // Count the number of segments that were successfully received past it.
1553                if (bit_set) {
1554                        // the selective ack should never ACK the packet we're waiting for to decrement cur_window_packets
1555                        assert((v & outbuf.mask) != ((seq_nr - cur_window_packets) & outbuf.mask));
1556                        ack_packet(v);
1557                        continue;
1558                }
1559
1560                // Resend segments
1561                // if count is less than our re-send limit, we haven't seen enough
1562                // acked packets in front of this one to warrant a re-send.
1563                // if count == 0, we're still going through the tail of zeroes
1564                if (((v - fast_resend_seq_nr) & ACK_NR_MASK) <= OUTGOING_BUFFER_MAX_SIZE &&
1565                        count >= DUPLICATE_ACKS_BEFORE_RESEND &&
1566                        duplicate_ack < DUPLICATE_ACKS_BEFORE_RESEND) {
1567                        resends[nr++] = v;
1568                        LOG_UTPV("0x%08x: no ack for %u", this, v);
1569                } else {
1570                        LOG_UTPV("0x%08x: not resending %u count:%d dup_ack:%u fast_resend_seq_nr:%u",
1571                                         this, v, count, duplicate_ack, fast_resend_seq_nr);
1572                }
1573        } while (--bits >= -1);
1574
1575        if (((base - 1 - fast_resend_seq_nr) & ACK_NR_MASK) < 256 &&
1576                count >= DUPLICATE_ACKS_BEFORE_RESEND &&
1577                duplicate_ack < DUPLICATE_ACKS_BEFORE_RESEND) {
1578                // if we get enough duplicate acks to start
1579                // resending, the first packet we should resend
1580                // is base-1
1581                resends[nr++] = base - 1;
1582        } else {
1583                LOG_UTPV("0x%08x: not resending %u count:%d dup_ack:%u fast_resend_seq_nr:%u",
1584                                 this, base - 1, count, duplicate_ack, fast_resend_seq_nr);
1585        }
1586
1587        bool back_off = false;
1588        int i = 0;
1589        while (nr > 0) {
1590                uint v = resends[--nr];
1591                // don't consider the tail of 0:es to be lost packets
1592                // only unacked packets with acked packets after should
1593                // be considered lost
1594                OutgoingPacket *pkt = (OutgoingPacket*)outbuf.get(v);
1595
1596                // this may be an old (re-ordered) packet, and some of the
1597                // packets in here may have been acked already. In which
1598                // case they will not be in the send queue anymore
1599                if (!pkt) continue;
1600
1601                // used in parse_log.py
1602                LOG_UTP("0x%08x: Packet %u lost. Resending", this, v);
1603
1604                // On Loss
1605                back_off = true;
1606#ifdef _DEBUG
1607                ++_stats._rexmit;
1608#endif
1609                send_packet(pkt);
1610                fast_resend_seq_nr = v + 1;
1611
1612                // Re-send max 4 packets.
1613                if (++i >= 4) break;
1614        }
1615
1616        if (back_off)
1617                maybe_decay_win();
1618
1619        duplicate_ack = count;
1620}
1621
1622void UTPSocket::apply_ledbat_ccontrol(size_t bytes_acked, uint32 actual_delay, int64 min_rtt)
1623{
1624        // the delay can never be greater than the rtt. The min_rtt
1625        // variable is the RTT in microseconds
1626       
1627        assert(min_rtt >= 0);
1628        int32 our_delay = min<uint32>(our_hist.get_value(), uint32(min_rtt));
1629        assert(our_delay != INT_MAX);
1630        assert(our_delay >= 0);
1631        assert(our_hist.get_value() >= 0);
1632
1633        SOCKADDR_STORAGE sa = addr.get_sockaddr_storage();
1634        UTP_DelaySample((sockaddr*)&sa, our_delay / 1000);
1635
1636        // This test the connection under heavy load from foreground
1637        // traffic. Pretend that our delays are very high to force the
1638        // connection to use sub-packet size window sizes
1639        //our_delay *= 4;
1640
1641        // target is microseconds
1642        int target = CCONTROL_TARGET;
1643        if (target <= 0) target = 100000;
1644
1645        double off_target = target - our_delay;
1646
1647        // this is the same as:
1648        //
1649        //    (min(off_target, target) / target) * (bytes_acked / max_window) * MAX_CWND_INCREASE_BYTES_PER_RTT
1650        //
1651        // so, it's scaling the max increase by the fraction of the window this ack represents, and the fraction
1652        // of the target delay the current delay represents.
1653        // The min() around off_target protects against crazy values of our_delay, which may happen when th
1654        // timestamps wraps, or by just having a malicious peer sending garbage. This caps the increase
1655        // of the window size to MAX_CWND_INCREASE_BYTES_PER_RTT per rtt.
1656        // as for large negative numbers, this direction is already capped at the min packet size further down
1657        // the min around the bytes_acked protects against the case where the window size was recently
1658        // shrunk and the number of acked bytes exceeds that. This is considered no more than one full
1659        // window, in order to keep the gain within sane boundries.
1660
1661        assert(bytes_acked > 0);
1662        double window_factor = (double)min(bytes_acked, max_window) / (double)max(max_window, bytes_acked);
1663        double delay_factor = off_target / target;
1664        double scaled_gain = MAX_CWND_INCREASE_BYTES_PER_RTT * window_factor * delay_factor;
1665
1666        // since MAX_CWND_INCREASE_BYTES_PER_RTT is a cap on how much the window size (max_window)
1667        // may increase per RTT, we may not increase the window size more than that proportional
1668        // to the number of bytes that were acked, so that once one window has been acked (one rtt)
1669        // the increase limit is not exceeded
1670        // the +1. is to allow for floating point imprecision
1671        assert(scaled_gain <= 1. + MAX_CWND_INCREASE_BYTES_PER_RTT * (int)min(bytes_acked, max_window) / (double)max(max_window, bytes_acked));
1672
1673        if (scaled_gain > 0 && g_current_ms - last_maxed_out_window > 300) {
1674                // if it was more than 300 milliseconds since we tried to send a packet
1675                // and stopped because we hit the max window, we're most likely rate
1676                // limited (which prevents us from ever hitting the window size)
1677                // if this is the case, we cannot let the max_window grow indefinitely
1678                scaled_gain = 0;
1679        }
1680
1681        if (scaled_gain + max_window < MIN_WINDOW_SIZE) {
1682                max_window = MIN_WINDOW_SIZE;
1683        } else {
1684                max_window = (size_t)(max_window + scaled_gain);
1685        }
1686
1687        // make sure that the congestion window is below max
1688        // make sure that we don't shrink our window too small
1689        max_window = clamp<size_t>(max_window, MIN_WINDOW_SIZE, opt_sndbuf);
1690
1691        // used in parse_log.py
1692        LOG_UTP("0x%08x: actual_delay:%u our_delay:%d their_delay:%u off_target:%d max_window:%u "
1693                        "delay_base:%u delay_sum:%d target_delay:%d acked_bytes:%u cur_window:%u "
1694                        "scaled_gain:%f rtt:%u rate:%u quota:%d wnduser:%u rto:%u timeout:%d get_microseconds:"I64u" "
1695                        "cur_window_packets:%u packet_size:%u their_delay_base:%u their_actual_delay:%u",
1696                        this, actual_delay, our_delay / 1000, their_hist.get_value() / 1000,
1697                        (int)off_target / 1000, (uint)(max_window),  our_hist.delay_base,
1698                        (our_delay + their_hist.get_value()) / 1000, target / 1000, (uint)bytes_acked,
1699                        (uint)(cur_window - bytes_acked), (float)(scaled_gain), rtt,
1700                        (uint)(max_window * 1000 / (rtt_hist.delay_base?rtt_hist.delay_base:50)),
1701                        send_quota / 100, (uint)max_window_user, rto, (int)(rto_timeout - g_current_ms),
1702                        UTP_GetMicroseconds(), cur_window_packets, (uint)get_packet_size(),
1703                        their_hist.delay_base, their_hist.delay_base + their_hist.get_value());
1704}
1705
1706static void UTP_RegisterRecvPacket(UTPSocket *conn, size_t len)
1707{
1708#ifdef _DEBUG
1709        ++conn->_stats._nrecv;
1710        conn->_stats._nbytes_recv += len;
1711#endif
1712
1713        if (len <= PACKET_SIZE_MID) {
1714                if (len <= PACKET_SIZE_EMPTY) {
1715                        _global_stats._nraw_recv[PACKET_SIZE_EMPTY_BUCKET]++;
1716                } else if (len <= PACKET_SIZE_SMALL) {
1717                        _global_stats._nraw_recv[PACKET_SIZE_SMALL_BUCKET]++;
1718                } else 
1719                        _global_stats._nraw_recv[PACKET_SIZE_MID_BUCKET]++;
1720        } else {
1721                if (len <= PACKET_SIZE_BIG) {
1722                        _global_stats._nraw_recv[PACKET_SIZE_BIG_BUCKET]++;
1723                } else 
1724                        _global_stats._nraw_recv[PACKET_SIZE_HUGE_BUCKET]++;
1725        }
1726}
1727
1728// returns the max number of bytes of payload the uTP
1729// connection is allowed to send
1730size_t UTPSocket::get_packet_size()
1731{
1732        int header_size = version == 1
1733                ? sizeof(PacketFormatV1)
1734                : sizeof(PacketFormat);
1735
1736        size_t mtu = get_udp_mtu();
1737
1738        if (DYNAMIC_PACKET_SIZE_ENABLED) {
1739                SOCKADDR_STORAGE sa = addr.get_sockaddr_storage();
1740                size_t max_packet_size = UTP_GetPacketSize((sockaddr*)&sa);
1741                return min(mtu - header_size, max_packet_size);
1742        }
1743        else
1744        {
1745                return mtu - header_size;
1746        }
1747}
1748
1749// Process an incoming packet
1750// syn is true if this is the first packet received. It will cut off parsing
1751// as soon as the header is done
1752size_t UTP_ProcessIncoming(UTPSocket *conn, const byte *packet, size_t len, bool syn = false)
1753{
1754        UTP_RegisterRecvPacket(conn, len);
1755
1756        g_current_ms = UTP_GetMilliseconds();
1757
1758        conn->update_send_quota();
1759
1760        const PacketFormat *pf = (PacketFormat*)packet;
1761        const PacketFormatV1 *pf1 = (PacketFormatV1*)packet;
1762        const byte *packet_end = packet + len;
1763
1764        uint16 pk_seq_nr;
1765        uint16 pk_ack_nr;
1766        uint8 pk_flags;
1767        if (conn->version == 0) {
1768                pk_seq_nr = pf->seq_nr;
1769                pk_ack_nr = pf->ack_nr;
1770                pk_flags = pf->flags;
1771        } else {
1772                pk_seq_nr = pf1->seq_nr;
1773                pk_ack_nr = pf1->ack_nr;
1774                pk_flags = pf1->type();
1775        }
1776
1777        if (pk_flags >= ST_NUM_STATES) return 0;
1778
1779        LOG_UTPV("0x%08x: Got %s. seq_nr:%u ack_nr:%u state:%s version:%u timestamp:"I64u" reply_micro:%u",
1780                         conn, flagnames[pk_flags], pk_seq_nr, pk_ack_nr, statenames[conn->state], conn->version,
1781                         conn->version == 0?(uint64)(pf->tv_sec) * 1000000 + pf->tv_usec:uint64(pf1->tv_usec),
1782                         conn->version == 0?(uint32)(pf->reply_micro):(uint32)(pf1->reply_micro));
1783
1784        // mark receipt time
1785        uint64 time = UTP_GetMicroseconds();
1786
1787        // RSTs are handled earlier, since the connid matches the send id not the recv id
1788        assert(pk_flags != ST_RESET);
1789
1790        // TODO: maybe send a ST_RESET if we're in CS_RESET?
1791
1792        const byte *selack_ptr = NULL;
1793
1794        // Unpack UTP packet options
1795        // Data pointer
1796        const byte *data = (const byte*)pf + conn->get_header_size();
1797        if (conn->get_header_size() > len) {
1798                LOG_UTPV("0x%08x: Invalid packet size (less than header size)", conn);
1799                return 0;
1800        }
1801        // Skip the extension headers
1802        uint extension = conn->version == 0 ? pf->ext : pf1->ext;
1803        if (extension != 0) {
1804                do {
1805                        // Verify that the packet is valid.
1806                        data += 2;
1807
1808                        if ((int)(packet_end - data) < 0 || (int)(packet_end - data) < data[-1]) {
1809                                LOG_UTPV("0x%08x: Invalid len of extensions", conn);
1810                                return 0;
1811                        }
1812
1813                        switch(extension) {
1814                        case 1: // Selective Acknowledgment
1815                                selack_ptr = data;
1816                                break;
1817                        case 2: // extension bits
1818                                if (data[-1] != 8) {
1819                                        LOG_UTPV("0x%08x: Invalid len of extension bits header", conn);
1820                                        return 0;
1821                                }
1822                                memcpy(conn->extensions, data, 8);
1823                                LOG_UTPV("0x%08x: got extension bits:%02x%02x%02x%02x%02x%02x%02x%02x", conn,
1824                                        conn->extensions[0], conn->extensions[1], conn->extensions[2], conn->extensions[3],
1825                                        conn->extensions[4], conn->extensions[5], conn->extensions[6], conn->extensions[7]);
1826                        }
1827                        extension = data[-2];
1828                        data += data[-1];
1829                } while (extension);
1830        }
1831
1832        if (conn->state == CS_SYN_SENT) {
1833                // if this is a syn-ack, initialize our ack_nr
1834                // to match the sequence number we got from
1835                // the other end
1836                conn->ack_nr = (pk_seq_nr - 1) & SEQ_NR_MASK;
1837        }
1838
1839        g_current_ms = UTP_GetMilliseconds();
1840        conn->last_got_packet = g_current_ms;
1841
1842        if (syn) {
1843                return 0;
1844        }
1845
1846        // seqnr is the number of packets past the expected
1847        // packet this is. ack_nr is the last acked, seq_nr is the
1848        // current. Subtracring 1 makes 0 mean "this is the next
1849        // expected packet".
1850        const uint seqnr = (pk_seq_nr - conn->ack_nr - 1) & SEQ_NR_MASK;
1851
1852        // Getting an invalid sequence number?
1853        if (seqnr >= REORDER_BUFFER_MAX_SIZE) {
1854                if (seqnr >= (SEQ_NR_MASK + 1) - REORDER_BUFFER_MAX_SIZE && pk_flags != ST_STATE) {
1855                        conn->ack_time = g_current_ms + min<uint>(conn->ack_time - g_current_ms, DELAYED_ACK_TIME_THRESHOLD);
1856                }
1857                LOG_UTPV("    Got old Packet/Ack (%u/%u)=%u!", pk_seq_nr, conn->ack_nr, seqnr);
1858                return 0;
1859        }
1860
1861        // Process acknowledgment
1862        // acks is the number of packets that was acked
1863        int acks = (pk_ack_nr - (conn->seq_nr - 1 - conn->cur_window_packets)) & ACK_NR_MASK;
1864
1865        // this happens when we receive an old ack nr
1866        if (acks > conn->cur_window_packets) acks = 0;
1867
1868        // if we get the same ack_nr as in the last packet
1869        // increase the duplicate_ack counter, otherwise reset
1870        // it to 0
1871        if (conn->cur_window_packets > 0) {
1872                if (pk_ack_nr == ((conn->seq_nr - conn->cur_window_packets - 1) & ACK_NR_MASK) &&
1873                        conn->cur_window_packets > 0) {
1874                        //++conn->duplicate_ack;
1875                } else {
1876                        conn->duplicate_ack = 0;
1877                }
1878
1879                // TODO: if duplicate_ack == DUPLICATE_ACK_BEFORE_RESEND
1880                // and fast_resend_seq_nr <= ack_nr + 1
1881                //    resend ack_nr + 1
1882        }
1883
1884        // figure out how many bytes were acked
1885        size_t acked_bytes = 0;
1886
1887        // the minimum rtt of all acks
1888        // this is the upper limit on the delay we get back
1889        // from the other peer. Our delay cannot exceed
1890        // the rtt of the packet. If it does, clamp it.
1891        // this is done in apply_ledbat_ccontrol()
1892        int64 min_rtt = INT64_MAX;
1893
1894        for (int i = 0; i < acks; ++i) {
1895                int seq = conn->seq_nr - conn->cur_window_packets + i;
1896                OutgoingPacket *pkt = (OutgoingPacket*)conn->outbuf.get(seq);
1897                if (pkt == 0 || pkt->transmissions == 0) continue;
1898                assert((int)(pkt->payload) >= 0);
1899                acked_bytes += pkt->payload;
1900                min_rtt = min<int64>(min_rtt, UTP_GetMicroseconds() - pkt->time_sent);
1901        }
1902       
1903        // count bytes acked by EACK
1904        if (selack_ptr != NULL) {
1905                acked_bytes += conn->selective_ack_bytes((pk_ack_nr + 2) & ACK_NR_MASK,
1906                                                                                                 selack_ptr, selack_ptr[-1], min_rtt);
1907        }
1908
1909        LOG_UTPV("0x%08x: acks:%d acked_bytes:%u seq_nr:%d cur_window:%u cur_window_packets:%u relative_seqnr:%u max_window:%u min_rtt:%u rtt:%u",
1910                         conn, acks, (uint)acked_bytes, conn->seq_nr, (uint)conn->cur_window, conn->cur_window_packets,
1911                         seqnr, (uint)conn->max_window, (uint)(min_rtt / 1000), conn->rtt);
1912
1913        uint64 p;
1914
1915        if (conn->version == 0) {
1916                p = uint64(pf->tv_sec) * 1000000 + pf->tv_usec;
1917        } else {
1918                p = pf1->tv_usec;
1919        }
1920
1921        conn->last_measured_delay = g_current_ms;
1922
1923        // get delay in both directions
1924        // record the delay to report back
1925        const uint32 their_delay = (uint32)(p == 0 ? 0 : time - p);
1926        conn->reply_micro = their_delay;
1927        uint32 prev_delay_base = conn->their_hist.delay_base;
1928        if (their_delay != 0) conn->their_hist.add_sample(their_delay);
1929
1930        // if their new delay base is less than their previous one
1931        // we should shift our delay base in the other direction in order
1932        // to take the clock skew into account
1933        if (prev_delay_base != 0 &&
1934                wrapping_compare_less(conn->their_hist.delay_base, prev_delay_base)) {
1935                // never adjust more than 10 milliseconds
1936                if (prev_delay_base - conn->their_hist.delay_base <= 10000) {
1937                        conn->our_hist.shift(prev_delay_base - conn->their_hist.delay_base);
1938                }
1939        }
1940
1941        const uint32 actual_delay = conn->version==0
1942                ?(pf->reply_micro==INT_MAX?0:uint32(pf->reply_micro))
1943                :(uint32(pf1->reply_micro)==INT_MAX?0:uint32(pf1->reply_micro));
1944
1945        assert(conn->our_hist.get_value() >= 0);
1946        // if the actual delay is 0, it means the other end
1947        // hasn't received a sample from us yet, and doesn't
1948        // know what it is. We can't update out history unless
1949        // we have a true measured sample
1950        prev_delay_base = conn->our_hist.delay_base;
1951        if (actual_delay != 0) conn->our_hist.add_sample(actual_delay);
1952        assert(conn->our_hist.get_value() >= 0);
1953
1954        // if our new delay base is less than our previous one
1955        // we should shift the other end's delay base in the other
1956        // direction in order to take the clock skew into account
1957        // This is commented out because it creates bad interactions
1958        // with our adjustment in the other direction. We don't really
1959        // need our estimates of the other peer to be very accurate
1960        // anyway. The problem with shifting here is that we're more
1961        // likely shift it back later because of a low latency. This
1962        // second shift back would cause us to shift our delay base
1963        // which then get's into a death spiral of shifting delay bases
1964/*      if (prev_delay_base != 0 &&
1965                wrapping_compare_less(conn->our_hist.delay_base, prev_delay_base)) {
1966                // never adjust more than 10 milliseconds
1967                if (prev_delay_base - conn->our_hist.delay_base <= 10000) {
1968                        conn->their_hist.Shift(prev_delay_base - conn->our_hist.delay_base);
1969                }
1970        }
1971*/
1972
1973        // if the delay estimate exceeds the RTT, adjust the base_delay to
1974        // compensate
1975        if (conn->our_hist.get_value() > uint32(min_rtt)) {
1976                conn->our_hist.shift(conn->our_hist.get_value() - min_rtt);
1977        }
1978
1979        // only apply the congestion controller on acks
1980        // if we don't have a delay measurement, there's
1981        // no point in invoking the congestion control
1982        if (actual_delay != 0 && acked_bytes >= 1)
1983                conn->apply_ledbat_ccontrol(acked_bytes, actual_delay, min_rtt);
1984
1985        // sanity check, the other end should never ack packets
1986        // past the point we've sent
1987        if (acks <= conn->cur_window_packets) {
1988                conn->max_window_user = conn->version == 0
1989                        ? pf->windowsize * PACKET_SIZE : pf1->windowsize;
1990
1991                // If max user window is set to 0, then we startup a timer
1992                // That will reset it to 1 after 15 seconds.
1993                if (conn->max_window_user == 0)
1994                        // Reset max_window_user to 1 every 15 seconds.
1995                        conn->zerowindow_time = g_current_ms + 15000;
1996
1997                // Respond to connect message
1998                // Switch to CONNECTED state.
1999                if (conn->state == CS_SYN_SENT) {
2000                        conn->state = CS_CONNECTED;
2001                        conn->func.on_state(conn->userdata, UTP_STATE_CONNECT);
2002
2003                // We've sent a fin, and everything was ACKed (including the FIN),
2004                // it's safe to destroy the socket. cur_window_packets == acks
2005                // means that this packet acked all the remaining packets that
2006                // were in-flight.
2007                } else if (conn->state == CS_FIN_SENT && conn->cur_window_packets == acks) {
2008                        conn->state = CS_DESTROY;
2009                }
2010
2011                // Update fast resend counter
2012                if (wrapping_compare_less(conn->fast_resend_seq_nr, (pk_ack_nr + 1) & ACK_NR_MASK))
2013                        conn->fast_resend_seq_nr = pk_ack_nr + 1;
2014
2015                LOG_UTPV("0x%08x: fast_resend_seq_nr:%u", conn, conn->fast_resend_seq_nr);
2016
2017                for (int i = 0; i < acks; ++i) {
2018                        int ack_status = conn->ack_packet(conn->seq_nr - conn->cur_window_packets);
2019                        // if ack_status is 0, the packet was acked.
2020                        // if acl_stauts is 1, it means that the packet had already been acked
2021                        // if it's 2, the packet has not been sent yet
2022                        // We need to break this loop in the latter case. This could potentially
2023                        // happen if we get an ack_nr that does not exceed what we have stuffed
2024                        // into the outgoing buffer, but does exceed what we have sent
2025                        if (ack_status == 2) {
2026#ifdef _DEBUG
2027                                OutgoingPacket* pkt = (OutgoingPacket*)conn->outbuf.get(conn->seq_nr - conn->cur_window_packets);
2028                                assert(pkt->transmissions == 0);
2029#endif
2030                                break;
2031                        }
2032                        conn->cur_window_packets--;
2033                }
2034#ifdef _DEBUG
2035                if (conn->cur_window_packets == 0) assert(conn->cur_window == 0);
2036#endif
2037
2038                // packets in front of this may have been acked by a
2039                // selective ack (EACK). Keep decreasing the window packet size
2040                // until we hit a packet that is still waiting to be acked
2041                // in the send queue
2042                // this is especially likely to happen when the other end
2043                // has the EACK send bug older versions of uTP had
2044                while (conn->cur_window_packets > 0 && !conn->outbuf.get(conn->seq_nr - conn->cur_window_packets))
2045                        conn->cur_window_packets--;
2046
2047#ifdef _DEBUG
2048                if (conn->cur_window_packets == 0) assert(conn->cur_window == 0);
2049#endif
2050
2051                // this invariant should always be true
2052                assert(conn->cur_window_packets == 0 || conn->outbuf.get(conn->seq_nr - conn->cur_window_packets));
2053
2054                // flush Nagle
2055                if (conn->cur_window_packets == 1) {
2056                        OutgoingPacket *pkt = (OutgoingPacket*)conn->outbuf.get(conn->seq_nr - 1);
2057                        // do we still have quota?
2058                        if (pkt->transmissions == 0 &&
2059                                (!(USE_PACKET_PACING) || conn->send_quota / 100 >= (int32)pkt->length)) {
2060                                conn->send_packet(pkt);
2061
2062                                // No need to send another ack if there is nothing to reorder.
2063                                if (conn->reorder_count == 0) {
2064                                        conn->sent_ack();
2065                                }
2066                        }
2067                }
2068
2069                // Fast timeout-retry
2070                if (conn->fast_timeout) {
2071                        LOG_UTPV("Fast timeout %u,%u,%u?", (uint)conn->cur_window, conn->seq_nr - conn->timeout_seq_nr, conn->timeout_seq_nr);
2072                        // if the fast_resend_seq_nr is not pointing to the oldest outstanding packet, it suggests that we've already
2073                        // resent the packet that timed out, and we should leave the fast-timeout mode.
2074                        if (((conn->seq_nr - conn->cur_window_packets) & ACK_NR_MASK) != conn->fast_resend_seq_nr) {
2075                                conn->fast_timeout = false;
2076                        } else {
2077                                // resend the oldest packet and increment fast_resend_seq_nr
2078                                // to not allow another fast resend on it again
2079                                OutgoingPacket *pkt = (OutgoingPacket*)conn->outbuf.get(conn->seq_nr - conn->cur_window_packets);
2080                                if (pkt && pkt->transmissions > 0) {
2081                                        LOG_UTPV("0x%08x: Packet %u fast timeout-retry.", conn, conn->seq_nr - conn->cur_window_packets);
2082#ifdef _DEBUG
2083                                        ++conn->_stats._fastrexmit;
2084#endif
2085                                        conn->fast_resend_seq_nr++;
2086                                        conn->send_packet(pkt);
2087                                }
2088                        }
2089                }
2090        }
2091
2092        // Process selective acknowledgent
2093        if (selack_ptr != NULL) {
2094                conn->selective_ack(pk_ack_nr + 2, selack_ptr, selack_ptr[-1]);
2095        }
2096
2097        // this invariant should always be true
2098        assert(conn->cur_window_packets == 0 || conn->outbuf.get(conn->seq_nr - conn->cur_window_packets));
2099
2100        LOG_UTPV("0x%08x: acks:%d acked_bytes:%u seq_nr:%u cur_window:%u cur_window_packets:%u quota:%d",
2101                         conn, acks, (uint)acked_bytes, conn->seq_nr, (uint)conn->cur_window, conn->cur_window_packets,
2102                         conn->send_quota / 100);
2103
2104        // In case the ack dropped the current window below
2105        // the max_window size, Mark the socket as writable
2106        if (conn->state == CS_CONNECTED_FULL && conn->is_writable(conn->get_packet_size())) {
2107                conn->state = CS_CONNECTED;
2108                LOG_UTPV("0x%08x: Socket writable. max_window:%u cur_window:%u quota:%d packet_size:%u",
2109                                 conn, (uint)conn->max_window, (uint)conn->cur_window, conn->send_quota / 100, (uint)conn->get_packet_size());
2110                conn->func.on_state(conn->userdata, UTP_STATE_WRITABLE);
2111        }
2112
2113        if (pk_flags == ST_STATE) {
2114                // This is a state packet only.
2115                return 0;
2116        }
2117
2118        // The connection is not in a state that can accept data?
2119        if (conn->state != CS_CONNECTED &&
2120                conn->state != CS_CONNECTED_FULL &&
2121                conn->state != CS_FIN_SENT) {
2122                return 0;
2123        }
2124
2125        // Is this a finalize packet?
2126        if (pk_flags == ST_FIN && !conn->got_fin) {
2127                LOG_UTPV("Got FIN eof_pkt:%u", pk_seq_nr);
2128                conn->got_fin = true;
2129                conn->eof_pkt = pk_seq_nr;
2130                // at this point, it is possible for the
2131                // other end to have sent packets with
2132                // sequence numbers higher than seq_nr.
2133                // if this is the case, our reorder_count
2134                // is out of sync. This case is dealt with
2135                // when we re-order and hit the eof_pkt.
2136                // we'll just ignore any packets with
2137                // sequence numbers past this
2138        }
2139
2140        // Getting an in-order packet?
2141        if (seqnr == 0) {
2142                size_t count = packet_end - data;
2143                if (count > 0 && conn->state != CS_FIN_SENT) {
2144                        LOG_UTPV("0x%08x: Got Data len:%u (rb:%u)", conn, (uint)count, (uint)conn->func.get_rb_size(conn->userdata));
2145                        // Post bytes to the upper layer
2146                        conn->func.on_read(conn->userdata, data, count);
2147                }
2148                conn->ack_nr++;
2149                conn->bytes_since_ack += count;
2150
2151                // Check if the next packet has been received too, but waiting
2152                // in the reorder buffer.
2153                for (;;) {
2154
2155                        if (conn->got_fin && conn->eof_pkt == conn->ack_nr) {
2156                                if (conn->state != CS_FIN_SENT) {
2157                                        conn->state = CS_GOT_FIN;
2158                                        conn->rto_timeout = g_current_ms + min<uint>(conn->rto * 3, 60);
2159
2160                                        LOG_UTPV("0x%08x: Posting EOF", conn);
2161                                        conn->func.on_state(conn->userdata, UTP_STATE_EOF);
2162                                }
2163
2164                                // if the other end wants to close, ack immediately
2165                                conn->send_ack();
2166
2167                                // reorder_count is not necessarily 0 at this point.
2168                                // even though it is most of the time, the other end
2169                                // may have sent packets with higher sequence numbers
2170                                // than what later end up being eof_pkt
2171                                // since we have received all packets up to eof_pkt
2172                                // just ignore the ones after it.
2173                                conn->reorder_count = 0;
2174                        }
2175
2176                        // Quick get-out in case there is nothing to reorder
2177                        if (conn->reorder_count == 0)
2178                                break;
2179
2180                        // Check if there are additional buffers in the reorder buffers
2181                        // that need delivery.
2182                        byte *p = (byte*)conn->inbuf.get(conn->ack_nr+1);
2183                        if (p == NULL)
2184                                break;
2185                        conn->inbuf.put(conn->ack_nr+1, NULL);
2186                        count = *(uint*)p;
2187                        if (count > 0 && conn->state != CS_FIN_SENT) {
2188                                // Pass the bytes to the upper layer
2189                                conn->func.on_read(conn->userdata, p + sizeof(uint), count);
2190                        }
2191                        conn->ack_nr++;
2192                        conn->bytes_since_ack += count;
2193
2194                        // Free the element from the reorder buffer
2195                        free(p);
2196                        assert(conn->reorder_count > 0);
2197                        conn->reorder_count--;
2198                }
2199
2200                // start the delayed ACK timer
2201                conn->ack_time = g_current_ms + min<uint>(conn->ack_time - g_current_ms, DELAYED_ACK_TIME_THRESHOLD);
2202        } else {
2203                // Getting an out of order packet.
2204                // The packet needs to be remembered and rearranged later.
2205
2206                // if we have received a FIN packet, and the EOF-sequence number
2207                // is lower than the sequence number of the packet we just received
2208                // something is wrong.
2209                if (conn->got_fin && pk_seq_nr > conn->eof_pkt) {
2210                        LOG_UTPV("0x%08x: Got an invalid packet sequence number, past EOF "
2211                                "reorder_count:%u len:%u (rb:%u)",
2212                                conn, conn->reorder_count, (uint)(packet_end - data), (uint)conn->func.get_rb_size(conn->userdata));
2213                        return 0;
2214                }
2215
2216                // if the sequence number is entirely off the expected
2217                // one, just drop it. We can't allocate buffer space in
2218                // the inbuf entirely based on untrusted input
2219                if (seqnr > 0x3ff) {
2220                        LOG_UTPV("0x%08x: Got an invalid packet sequence number, too far off "
2221                                "reorder_count:%u len:%u (rb:%u)",
2222                                conn, conn->reorder_count, (uint)(packet_end - data), (uint)conn->func.get_rb_size(conn->userdata));
2223                        return 0;
2224                }
2225
2226                // we need to grow the circle buffer before we
2227                // check if the packet is already in here, so that
2228                // we don't end up looking at an older packet (since
2229                // the indices wraps around).
2230                conn->inbuf.ensure_size(pk_seq_nr + 1, seqnr + 1);
2231
2232                // Has this packet already been received? (i.e. a duplicate)
2233                // If that is the case, just discard it.
2234                if (conn->inbuf.get(pk_seq_nr) != NULL) {
2235#ifdef _DEBUG
2236                        ++conn->_stats._nduprecv;
2237#endif
2238                        return 0;
2239                }
2240
2241                // Allocate memory to fit the packet that needs to re-ordered
2242                byte *mem = (byte*)malloc((packet_end - data) + sizeof(uint));
2243                *(uint*)mem = (uint)(packet_end - data);
2244                memcpy(mem + sizeof(uint), data, packet_end - data);
2245
2246                // Insert into reorder buffer and increment the count
2247                // of # of packets to be reordered.
2248                // we add one to seqnr in order to leave the last
2249                // entry empty, that way the assert in send_ack
2250                // is valid. we have to add one to seqnr too, in order
2251                // to make the circular buffer grow around the correct
2252                // point (which is conn->ack_nr + 1).
2253                assert(conn->inbuf.get(pk_seq_nr) == NULL);
2254                assert((pk_seq_nr & conn->inbuf.mask) != ((conn->ack_nr+1) & conn->inbuf.mask));
2255                conn->inbuf.put(pk_seq_nr, mem);
2256                conn->reorder_count++;
2257
2258                LOG_UTPV("0x%08x: Got out of order data reorder_count:%u len:%u (rb:%u)",
2259                        conn, conn->reorder_count, (uint)(packet_end - data), (uint)conn->func.get_rb_size(conn->userdata));
2260
2261                // Setup so the partial ACK message will get sent immediately.
2262                conn->ack_time = g_current_ms + min<uint>(conn->ack_time - g_current_ms, 1);
2263        }
2264
2265        // If ack_time or ack_bytes indicate that we need to send and ack, send one
2266        // here instead of waiting for the timer to trigger
2267        LOG_UTPV("bytes_since_ack:%u ack_time:%d",
2268                         (uint)conn->bytes_since_ack, (int)(g_current_ms - conn->ack_time));
2269        if (conn->state == CS_CONNECTED || conn->state == CS_CONNECTED_FULL) {
2270                if (conn->bytes_since_ack > DELAYED_ACK_BYTE_THRESHOLD ||
2271                        (int)(g_current_ms - conn->ack_time) >= 0) {
2272                        conn->send_ack();
2273                }
2274        }
2275        return (size_t)(packet_end - data);
2276}
2277
2278inline bool UTP_IsV1(PacketFormatV1 const* pf)
2279{
2280        return pf->version() == 1 && pf->type() < ST_NUM_STATES && pf->ext < 3;
2281}
2282
2283void UTP_Free(UTPSocket *conn)
2284{
2285        LOG_UTPV("0x%08x: Killing socket", conn);
2286
2287        conn->func.on_state(conn->userdata, UTP_STATE_DESTROYING);
2288        UTP_SetCallbacks(conn, NULL, NULL);
2289
2290        assert(conn->idx < g_utp_sockets.GetCount());
2291        assert(g_utp_sockets[conn->idx] == conn);
2292
2293        // Unlink object from the global list
2294        assert(g_utp_sockets.GetCount() > 0);
2295
2296        UTPSocket *last = g_utp_sockets[g_utp_sockets.GetCount() - 1];
2297
2298        assert(last->idx < g_utp_sockets.GetCount());
2299        assert(g_utp_sockets[last->idx] == last);
2300
2301        last->idx = conn->idx;
2302       
2303        g_utp_sockets[conn->idx] = last;
2304
2305        // Decrease the count
2306        g_utp_sockets.SetCount(g_utp_sockets.GetCount() - 1);
2307
2308        // Free all memory occupied by the socket object.
2309        for (size_t i = 0; i <= conn->inbuf.mask; i++) {
2310                free(conn->inbuf.elements[i]);
2311        }
2312        for (size_t i = 0; i <= conn->outbuf.mask; i++) {
2313                free(conn->outbuf.elements[i]);
2314        }
2315        free(conn->inbuf.elements);
2316        free(conn->outbuf.elements);
2317
2318        // Finally free the socket object
2319        free(conn);
2320}
2321
2322
2323// Public functions:
2324///////////////////////////////////////////////////////////////////////////////
2325
2326// Create a UTP socket
2327UTPSocket *UTP_Create(SendToProc *send_to_proc, void *send_to_userdata, const struct sockaddr *addr, socklen_t addrlen)
2328{
2329        UTPSocket *conn = (UTPSocket*)calloc(1, sizeof(UTPSocket));
2330
2331        g_current_ms = UTP_GetMilliseconds();
2332
2333        UTP_SetCallbacks(conn, NULL, NULL);
2334        conn->our_hist.clear();
2335        conn->their_hist.clear();
2336        conn->rto = 3000;
2337        conn->rtt_var = 800;
2338        conn->seq_nr = 1;
2339        conn->ack_nr = 0;
2340        conn->max_window_user = 255 * PACKET_SIZE;
2341        conn->addr = PackedSockAddr((const SOCKADDR_STORAGE*)addr, addrlen);
2342        conn->send_to_proc = send_to_proc;
2343        conn->send_to_userdata = send_to_userdata;
2344        conn->ack_time = g_current_ms + 0x70000000;
2345        conn->last_got_packet = g_current_ms;
2346        conn->last_sent_packet = g_current_ms;
2347        conn->last_measured_delay = g_current_ms + 0x70000000;
2348        conn->last_rwin_decay = int32(g_current_ms) - MAX_WINDOW_DECAY;
2349        conn->last_send_quota = g_current_ms;
2350        conn->send_quota = PACKET_SIZE * 100;
2351        conn->cur_window_packets = 0;
2352        conn->fast_resend_seq_nr = conn->seq_nr;
2353
2354        // default to version 1
2355        UTP_SetSockopt(conn, SO_UTPVERSION, 1);
2356
2357        // we need to fit one packet in the window
2358        // when we start the connection
2359        conn->max_window = conn->get_packet_size();
2360        conn->state = CS_IDLE;
2361
2362        conn->outbuf.mask = 15;
2363        conn->inbuf.mask = 15;
2364
2365        conn->outbuf.elements = (void**)calloc(16, sizeof(void*));
2366        conn->inbuf.elements = (void**)calloc(16, sizeof(void*));
2367
2368        conn->idx = g_utp_sockets.Append(conn);
2369
2370        LOG_UTPV("0x%08x: UTP_Create", conn);
2371
2372        return conn;
2373}
2374
2375void UTP_SetCallbacks(UTPSocket *conn, UTPFunctionTable *funcs, void *userdata)
2376{
2377        assert(conn);
2378
2379        if (funcs == NULL) {
2380                funcs = &zero_funcs;
2381        }
2382        conn->func = *funcs;
2383        conn->userdata = userdata;
2384}
2385
2386bool UTP_SetSockopt(UTPSocket* conn, int opt, int val)
2387{
2388        assert(conn);
2389
2390        switch (opt) {
2391        case SO_SNDBUF:
2392                assert(val >= 1);
2393                conn->opt_sndbuf = val;
2394                return true;
2395        case SO_RCVBUF:
2396                conn->opt_rcvbuf = val;
2397                return true;
2398        case SO_UTPVERSION:
2399                assert(conn->state == CS_IDLE);
2400                if (conn->state != CS_IDLE) {
2401                        // too late
2402                        return false;
2403                }
2404                if (conn->version == 1 && val == 0) {
2405                        conn->reply_micro = INT_MAX;
2406                        conn->opt_rcvbuf = 200 * 1024;
2407                        conn->opt_sndbuf = OUTGOING_BUFFER_MAX_SIZE * PACKET_SIZE;
2408                } else if (conn->version == 0 && val == 1) {
2409                        conn->reply_micro = 0;
2410                        conn->opt_rcvbuf = 3 * 1024 * 1024 + 512 * 1024;
2411                        conn->opt_sndbuf = conn->opt_rcvbuf;
2412                }
2413                conn->version = val;
2414                return true;
2415        }
2416
2417        return false;
2418}
2419
2420// Try to connect to a specified host.
2421// 'initial' is the number of data bytes to send in the connect packet.
2422void UTP_Connect(UTPSocket *conn)
2423{
2424        assert(conn);
2425
2426        assert(conn->state == CS_IDLE);
2427        assert(conn->cur_window_packets == 0);
2428        assert(conn->outbuf.get(conn->seq_nr) == NULL);
2429        assert(sizeof(PacketFormatV1) == 20);
2430
2431        conn->state = CS_SYN_SENT;
2432
2433        g_current_ms = UTP_GetMilliseconds();
2434
2435        // Create and send a connect message
2436        uint32 conn_seed = UTP_Random();
2437
2438        // we identify newer versions by setting the
2439        // first two bytes to 0x0001
2440        if (conn->version > 0) {
2441                conn_seed &= 0xffff;
2442        }
2443
2444        // used in parse_log.py
2445        LOG_UTP("0x%08x: UTP_Connect conn_seed:%u packet_size:%u (B) "
2446                        "target_delay:%u (ms) delay_history:%u "
2447                        "delay_base_history:%u (minutes)",
2448                        conn, conn_seed, PACKET_SIZE, CCONTROL_TARGET / 1000,
2449                        CUR_DELAY_SIZE, DELAY_BASE_HISTORY);
2450
2451        // Setup initial timeout timer.
2452        conn->retransmit_timeout = 3000;
2453        conn->rto_timeout = g_current_ms + conn->retransmit_timeout;
2454        conn->last_rcv_win = conn->get_rcv_window();
2455
2456        conn->conn_seed = conn_seed;
2457        conn->conn_id_recv = conn_seed;
2458        conn->conn_id_send = conn_seed+1;
2459        // if you need compatibiltiy with 1.8.1, use this. it increases attackability though.
2460        //conn->seq_nr = 1;
2461        conn->seq_nr = UTP_Random();
2462
2463        // Create the connect packet.
2464        const size_t header_ext_size = conn->get_header_extensions_size();
2465
2466        OutgoingPacket *pkt = (OutgoingPacket*)malloc(sizeof(OutgoingPacket) - 1 + header_ext_size);
2467
2468        PacketFormatExtensions* p = (PacketFormatExtensions*)pkt->data;
2469        PacketFormatExtensionsV1* p1 = (PacketFormatExtensionsV1*)pkt->data;
2470
2471        memset(p, 0, header_ext_size);
2472        // SYN packets are special, and have the receive ID in the connid field,
2473        // instead of conn_id_send.
2474        if (conn->version == 0) {
2475                p->pf.connid = conn->conn_id_recv;
2476                p->pf.ext = 2;
2477                p->pf.windowsize = (byte)DIV_ROUND_UP(conn->last_rcv_win, PACKET_SIZE);
2478                p->pf.seq_nr = conn->seq_nr;
2479                p->pf.flags = ST_SYN;
2480                p->ext_next = 0;
2481                p->ext_len = 8;
2482                memset(p->extensions, 0, 8);
2483        } else {
2484                p1->pf.set_version(1);
2485                p1->pf.set_type(ST_SYN);
2486                p1->pf.ext = 2;
2487                p1->pf.connid = conn->conn_id_recv;
2488                p1->pf.windowsize = (uint32)conn->last_rcv_win;
2489                p1->pf.seq_nr = conn->seq_nr;
2490                p1->ext_next = 0;
2491                p1->ext_len = 8;
2492                memset(p1->extensions, 0, 8);
2493        }
2494        pkt->transmissions = 0;
2495        pkt->length = header_ext_size;
2496        pkt->payload = 0;
2497
2498        //LOG_UTPV("0x%08x: Sending connect %s [%u].",
2499        //               conn, addrfmt(conn->addr, addrbuf), conn_seed);
2500
2501        // Remember the message in the outgoing queue.
2502        conn->outbuf.ensure_size(conn->seq_nr, conn->cur_window_packets);
2503        conn->outbuf.put(conn->seq_nr, pkt);
2504        conn->seq_nr++;
2505        conn->cur_window_packets++;
2506
2507        conn->send_packet(pkt);
2508}
2509
2510bool UTP_IsIncomingUTP(UTPGotIncomingConnection *incoming_proc,
2511                                           SendToProc *send_to_proc, void *send_to_userdata,
2512                                           const byte *buffer, size_t len, const struct sockaddr *to, socklen_t tolen)
2513{
2514        const PackedSockAddr addr((const SOCKADDR_STORAGE*)to, tolen);
2515
2516        if (len < sizeof(PacketFormat) && len < sizeof(PacketFormatV1)) {
2517                LOG_UTPV("recv %s len:%u too small", addrfmt(addr, addrbuf), (uint)len);
2518                return false;
2519        }
2520
2521        const PacketFormat* p = (PacketFormat*)buffer;
2522        const PacketFormatV1* p1 = (PacketFormatV1*)buffer;
2523
2524        const byte version = UTP_IsV1(p1);
2525        const uint32 id = (version == 0) ? p->connid : uint32(p1->connid);
2526
2527        if (version == 0 && len < sizeof(PacketFormat)) {
2528                LOG_UTPV("recv %s len:%u version:%u too small", addrfmt(addr, addrbuf), (uint)len, version);
2529                return false;
2530        }
2531
2532        if (version == 1 && len < sizeof(PacketFormatV1)) {
2533                LOG_UTPV("recv %s len:%u version:%u too small", addrfmt(addr, addrbuf), (uint)len, version);
2534                return false;
2535        }
2536
2537        LOG_UTPV("recv %s len:%u id:%u", addrfmt(addr, addrbuf), (uint)len, id);
2538
2539        const PacketFormat *pf = (PacketFormat*)p;
2540        const PacketFormatV1 *pf1 = (PacketFormatV1*)p;
2541
2542        if (version == 0) {
2543                LOG_UTPV("recv id:%u seq_nr:%u ack_nr:%u", id, (uint)pf->seq_nr, (uint)pf->ack_nr);
2544        } else {
2545                LOG_UTPV("recv id:%u seq_nr:%u ack_nr:%u", id, (uint)pf1->seq_nr, (uint)pf1->ack_nr);
2546        }
2547
2548        const byte flags = version == 0 ? pf->flags : pf1->type();
2549
2550        for (size_t i = 0; i < g_utp_sockets.GetCount(); i++) {
2551                UTPSocket *conn = g_utp_sockets[i];
2552                //LOG_UTPV("Examining UTPSocket %s for %s and (seed:%u s:%u r:%u) for %u",
2553                //              addrfmt(conn->addr, addrbuf), addrfmt(addr, addrbuf2), conn->conn_seed, conn->conn_id_send, conn->conn_id_recv, id);
2554                if (conn->addr != addr)
2555                        continue;
2556
2557                if (flags == ST_RESET && (conn->conn_id_send == id || conn->conn_id_recv == id)) {
2558                        LOG_UTPV("0x%08x: recv RST for existing connection", conn);
2559                        if (!conn->userdata || conn->state == CS_FIN_SENT) {
2560                                conn->state = CS_DESTROY;
2561                        } else {
2562                                conn->state = CS_RESET;
2563                        }
2564                        if (conn->userdata) {
2565                                conn->func.on_overhead(conn->userdata, false, len + conn->get_udp_overhead(),
2566                                                                           close_overhead);
2567                                const int err = conn->state == CS_SYN_SENT ?
2568                                        ECONNREFUSED :
2569                                        ECONNRESET;
2570                                conn->func.on_error(conn->userdata, err);
2571                        }
2572                        return true;
2573                } else if (flags != ST_SYN && conn->conn_id_recv == id) {
2574                        LOG_UTPV("0x%08x: recv processing", conn);
2575                        const size_t read = UTP_ProcessIncoming(conn, buffer, len);
2576                        if (conn->userdata) {
2577                                conn->func.on_overhead(conn->userdata, false,
2578                                        (len - read) + conn->get_udp_overhead(),
2579                                        header_overhead);
2580                        }
2581                        return true;
2582                }
2583        }
2584
2585        if (flags == ST_RESET) {
2586                LOG_UTPV("recv RST for unknown connection");
2587                return true;
2588        }
2589
2590        const uint32 seq_nr = version == 0 ? pf->seq_nr : pf1->seq_nr;
2591        if (flags != ST_SYN) {
2592                for (size_t i = 0; i < g_rst_info.GetCount(); i++) {
2593                        if (g_rst_info[i].connid != id)
2594                                continue;
2595                        if (g_rst_info[i].addr != addr)
2596                                continue;
2597                        if (seq_nr != g_rst_info[i].ack_nr)
2598                                continue;
2599                        g_rst_info[i].timestamp = UTP_GetMilliseconds();
2600                        LOG_UTPV("recv not sending RST to non-SYN (stored)");
2601                        return true;
2602                }
2603                if (g_rst_info.GetCount() > RST_INFO_LIMIT) {
2604                        LOG_UTPV("recv not sending RST to non-SYN (limit at %u stored)", (uint)g_rst_info.GetCount());
2605                        return true;
2606                }
2607                LOG_UTPV("recv send RST to non-SYN (%u stored)", (uint)g_rst_info.GetCount());
2608                RST_Info &r = g_rst_info.Append();
2609                r.addr = addr;
2610                r.connid = id;
2611                r.ack_nr = seq_nr;
2612                r.timestamp = UTP_GetMilliseconds();
2613
2614                UTPSocket::send_rst(send_to_proc, send_to_userdata, addr, id, seq_nr, UTP_Random(), version);
2615                return true;
2616        }
2617
2618        if (incoming_proc) {
2619                LOG_UTPV("Incoming connection from %s uTP version:%u", addrfmt(addr, addrbuf), version);
2620
2621                // Create a new UTP socket to handle this new connection
2622                UTPSocket *conn = UTP_Create(send_to_proc, send_to_userdata, to, tolen);
2623                // Need to track this value to be able to detect duplicate CONNECTs
2624                conn->conn_seed = id;
2625                // This is value that identifies this connection for them.
2626                conn->conn_id_send = id;
2627                // This is value that identifies this connection for us.
2628                conn->conn_id_recv = id+1;
2629                conn->ack_nr = seq_nr;
2630                conn->seq_nr = UTP_Random();
2631                conn->fast_resend_seq_nr = conn->seq_nr;
2632
2633                UTP_SetSockopt(conn, SO_UTPVERSION, version);
2634                conn->state = CS_CONNECTED;
2635
2636                const size_t read = UTP_ProcessIncoming(conn, buffer, len, true);
2637
2638                LOG_UTPV("0x%08x: recv send connect ACK", conn);
2639                conn->send_ack(true);
2640
2641                incoming_proc(send_to_userdata, conn);
2642
2643                // we report overhead after incoming_proc, because the callbacks are setup now
2644                if (conn->userdata) {
2645                        // SYN
2646                        conn->func.on_overhead(conn->userdata, false, (len - read) + conn->get_udp_overhead(),
2647                                                                   header_overhead);
2648                        // SYNACK
2649                        conn->func.on_overhead(conn->userdata, true, conn->get_overhead(),
2650                                                                   ack_overhead);
2651                }
2652        }
2653
2654        return true;
2655}
2656
2657bool UTP_HandleICMP(const byte* buffer, size_t len, const struct sockaddr *to, socklen_t tolen)
2658{
2659        const PackedSockAddr addr((const SOCKADDR_STORAGE*)to, tolen);
2660
2661        // Want the whole packet so we have connection ID
2662        if (len < sizeof(PacketFormat)) {
2663                return false;
2664        }
2665
2666        const PacketFormat* p = (PacketFormat*)buffer;
2667        const PacketFormatV1* p1 = (PacketFormatV1*)buffer;
2668
2669        const byte version = UTP_IsV1(p1);
2670        const uint32 id = (version == 0) ? p->connid : uint32(p1->connid);
2671
2672        for (size_t i = 0; i < g_utp_sockets.GetCount(); ++i) {
2673                UTPSocket *conn = g_utp_sockets[i];
2674                if (conn->addr == addr &&
2675                        conn->conn_id_recv == id) {
2676                        // Don't pass on errors for idle/closed connections
2677                        if (conn->state != CS_IDLE) {
2678                                if (!conn->userdata || conn->state == CS_FIN_SENT) {
2679                                        LOG_UTPV("0x%08x: icmp packet causing socket destruction", conn);
2680                                        conn->state = CS_DESTROY;
2681                                } else {
2682                                        conn->state = CS_RESET;
2683                                }
2684                                if (conn->userdata) {
2685                                        const int err = conn->state == CS_SYN_SENT ?
2686                                                ECONNREFUSED :
2687                                                ECONNRESET;
2688                                        LOG_UTPV("0x%08x: icmp packet causing error on socket:%d", conn, err);
2689                                        conn->func.on_error(conn->userdata, err);
2690                                }
2691                        }
2692                        return true;
2693                }
2694        }
2695        return false;
2696}
2697
2698// Write bytes to the UTP socket.
2699// Returns true if the socket is still writable.
2700bool UTP_Write(UTPSocket *conn, size_t bytes)
2701{
2702        assert(conn);
2703
2704#ifdef g_log_utp_verbose
2705        size_t param = bytes;
2706#endif
2707
2708        if (conn->state != CS_CONNECTED) {
2709                LOG_UTPV("0x%08x: UTP_Write %u bytes = false (not CS_CONNECTED)", conn, (uint)bytes);
2710                return false;
2711        }
2712
2713        g_current_ms = UTP_GetMilliseconds();
2714
2715        conn->update_send_quota();
2716
2717        // don't send unless it will all fit in the window
2718        size_t packet_size = conn->get_packet_size();
2719        size_t num_to_send = min<size_t>(bytes, packet_size);
2720        while (conn->is_writable(num_to_send)) {
2721                // Send an outgoing packet.
2722                // Also add it to the outgoing of packets that have been sent but not ACKed.
2723
2724                if (num_to_send == 0) {
2725                        LOG_UTPV("0x%08x: UTP_Write %u bytes = true", conn, (uint)param);
2726                        return true;
2727                }
2728                bytes -= num_to_send;
2729
2730                LOG_UTPV("0x%08x: Sending packet. seq_nr:%u ack_nr:%u wnd:%u/%u/%u rcv_win:%u size:%u quota:%d cur_window_packets:%u",
2731                                 conn, conn->seq_nr, conn->ack_nr,
2732                                 (uint)(conn->cur_window + num_to_send),
2733                                 (uint)conn->max_window, (uint)conn->max_window_user,
2734                                 (uint)conn->last_rcv_win, num_to_send, conn->send_quota / 100,
2735                                 conn->cur_window_packets);
2736                conn->write_outgoing_packet(num_to_send, ST_DATA);
2737                num_to_send = min<size_t>(bytes, packet_size);
2738        }
2739
2740        // mark the socket as not being writable.
2741        conn->state = CS_CONNECTED_FULL;
2742        LOG_UTPV("0x%08x: UTP_Write %u bytes = false", conn, (uint)bytes);
2743        return false;
2744}
2745
2746void UTP_RBDrained(UTPSocket *conn)
2747{
2748        assert(conn);
2749
2750        const size_t rcvwin = conn->get_rcv_window();
2751
2752        if (rcvwin > conn->last_rcv_win) {
2753                // If last window was 0 send ACK immediately, otherwise should set timer
2754                if (conn->last_rcv_win == 0) {
2755                        conn->send_ack();
2756                } else {
2757                        conn->ack_time = g_current_ms + min<uint>(conn->ack_time - g_current_ms, DELAYED_ACK_TIME_THRESHOLD);
2758                }
2759        }
2760}
2761
2762void UTP_CheckTimeouts()
2763{
2764        g_current_ms = UTP_GetMilliseconds();
2765
2766        for (size_t i = 0; i < g_rst_info.GetCount(); i++) {
2767                if ((int)(g_current_ms - g_rst_info[i].timestamp) >= RST_INFO_TIMEOUT) {
2768                        g_rst_info.MoveUpLast(i);
2769                        i--;
2770                }
2771        }
2772        if (g_rst_info.GetCount() != g_rst_info.GetAlloc()) {
2773                g_rst_info.Compact();
2774        }
2775
2776        for (size_t i = 0; i != g_utp_sockets.GetCount(); i++) {
2777                UTPSocket *conn = g_utp_sockets[i];
2778                conn->check_timeouts();
2779
2780                // Check if the object was deleted
2781                if (conn->state == CS_DESTROY) {
2782                        LOG_UTPV("0x%08x: Destroying", conn);
2783                        UTP_Free(conn);
2784                        i--;
2785                }
2786        }
2787}
2788
2789size_t UTP_GetPacketSize(UTPSocket *socket)
2790{
2791        return socket->get_packet_size();
2792}
2793
2794void UTP_GetPeerName(UTPSocket *conn, struct sockaddr *addr, socklen_t *addrlen)
2795{
2796        assert(conn);
2797
2798        socklen_t len;
2799        const SOCKADDR_STORAGE sa = conn->addr.get_sockaddr_storage(&len);
2800        *addrlen = min(len, *addrlen);
2801        memcpy(addr, &sa, *addrlen);
2802}
2803
2804void UTP_GetDelays(UTPSocket *conn, int32 *ours, int32 *theirs, uint32 *age)
2805{
2806        assert(conn);
2807
2808        if (ours) *ours = conn->our_hist.get_value();
2809        if (theirs) *theirs = conn->their_hist.get_value();
2810        if (age) *age = g_current_ms - conn->last_measured_delay;
2811}
2812
2813#ifdef _DEBUG
2814void UTP_GetStats(UTPSocket *conn, UTPStats *stats)
2815{
2816        assert(conn);
2817
2818        *stats = conn->_stats;
2819}
2820#endif // _DEBUG
2821
2822void UTP_GetGlobalStats(UTPGlobalStats *stats)
2823{
2824        *stats = _global_stats;
2825}
2826
2827// Close the UTP socket.
2828// It is not valid for the upper layer to refer to socket after it is closed.
2829// Data will keep to try being delivered after the close.
2830void UTP_Close(UTPSocket *conn)
2831{
2832        assert(conn);
2833
2834        assert(conn->state != CS_DESTROY_DELAY && conn->state != CS_FIN_SENT && conn->state != CS_DESTROY);
2835
2836        LOG_UTPV("0x%08x: UTP_Close in state:%s", conn, statenames[conn->state]);
2837
2838        switch(conn->state) {
2839        case CS_CONNECTED:
2840        case CS_CONNECTED_FULL:
2841                conn->state = CS_FIN_SENT;
2842                conn->write_outgoing_packet(0, ST_FIN);
2843                break;
2844
2845        case CS_SYN_SENT:
2846                conn->rto_timeout = UTP_GetMilliseconds() + min<uint>(conn->rto * 2, 60);
2847        case CS_GOT_FIN:
2848                conn->state = CS_DESTROY_DELAY;
2849                break;
2850
2851        default:
2852                conn->state = CS_DESTROY;
2853                break;
2854        }
2855}
Note: See TracBrowser for help on using the repository browser.