2 utcp.c -- Userspace TCP
3 Copyright (C) 2014-2017 Guus Sliepen <guus@tinc-vpn.org>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
31 #include <sys/socket.h>
33 #include "utcp_priv.h"
48 #define timersub(a, b, r)\
50 (r)->tv_sec = (a)->tv_sec - (b)->tv_sec;\
51 (r)->tv_usec = (a)->tv_usec - (b)->tv_usec;\
53 (r)->tv_sec--, (r)->tv_usec += USEC_PER_SEC;\
57 static inline size_t max(size_t a, size_t b) {
64 static void debug(const char *format, ...) {
67 vfprintf(stderr, format, ap);
71 static void print_packet(struct utcp *utcp, const char *dir, const void *pkt, size_t len) {
74 if(len < sizeof(hdr)) {
75 debug("%p %s: short packet (%lu bytes)\n", utcp, dir, (unsigned long)len);
79 memcpy(&hdr, pkt, sizeof(hdr));
80 debug("%p %s: len=%lu, src=%u dst=%u seq=%u ack=%u wnd=%u aux=%x ctl=", utcp, dir, (unsigned long)len, hdr.src, hdr.dst, hdr.seq, hdr.ack, hdr.wnd, hdr.aux);
98 if(len > sizeof(hdr)) {
99 uint32_t datalen = len - sizeof(hdr);
100 const uint8_t *data = (uint8_t *)pkt + sizeof(hdr);
101 char str[datalen * 2 + 1];
104 for(uint32_t i = 0; i < datalen; i++) {
105 *p++ = "0123456789ABCDEF"[data[i] >> 4];
106 *p++ = "0123456789ABCDEF"[data[i] & 15];
111 debug(" data=%s", str);
117 #define debug(...) do {} while(0)
118 #define print_packet(...) do {} while(0)
121 static void set_state(struct utcp_connection *c, enum state state) {
124 if(state == ESTABLISHED) {
125 timerclear(&c->conn_timeout);
128 debug("%p new state: %s\n", c->utcp, strstate[state]);
131 static bool fin_wanted(struct utcp_connection *c, uint32_t seq) {
132 if(seq != c->snd.last) {
147 static bool is_reliable(struct utcp_connection *c) {
148 return c->flags & UTCP_RELIABLE;
151 static int32_t seqdiff(uint32_t a, uint32_t b) {
156 // TODO: convert to ringbuffers to avoid memmove() operations.
158 // Store data into the buffer
159 static ssize_t buffer_put_at(struct buffer *buf, size_t offset, const void *data, size_t len) {
160 debug("buffer_put_at %lu %lu %lu\n", (unsigned long)buf->used, (unsigned long)offset, (unsigned long)len);
162 size_t required = offset + len;
164 if(required > buf->maxsize) {
165 if(offset >= buf->maxsize) {
169 len = buf->maxsize - offset;
170 required = buf->maxsize;
173 if(required > buf->size) {
174 size_t newsize = buf->size;
181 } while(newsize < required);
184 if(newsize > buf->maxsize) {
185 newsize = buf->maxsize;
188 char *newdata = realloc(buf->data, newsize);
198 memcpy(buf->data + offset, data, len);
200 if(required > buf->used) {
201 buf->used = required;
207 static ssize_t buffer_put(struct buffer *buf, const void *data, size_t len) {
208 return buffer_put_at(buf, buf->used, data, len);
211 // Get data from the buffer. data can be NULL.
212 static ssize_t buffer_get(struct buffer *buf, void *data, size_t len) {
213 if(len > buf->used) {
218 memcpy(data, buf->data, len);
221 if(len < buf->used) {
222 memmove(buf->data, buf->data + len, buf->used - len);
229 // Copy data from the buffer without removing it.
230 static ssize_t buffer_copy(struct buffer *buf, void *data, size_t offset, size_t len) {
231 if(offset >= buf->used) {
235 if(offset + len > buf->used) {
236 len = buf->used - offset;
239 memcpy(data, buf->data + offset, len);
243 static bool buffer_init(struct buffer *buf, uint32_t len, uint32_t maxlen) {
244 memset(buf, 0, sizeof(*buf));
247 buf->data = malloc(len);
255 buf->maxsize = maxlen;
259 static void buffer_exit(struct buffer *buf) {
261 memset(buf, 0, sizeof(*buf));
264 static uint32_t buffer_free(const struct buffer *buf) {
265 return buf->maxsize - buf->used;
268 // Connections are stored in a sorted list.
269 // This gives O(log(N)) lookup time, O(N log(N)) insertion time and O(N) deletion time.
271 static int compare(const void *va, const void *vb) {
274 const struct utcp_connection *a = *(struct utcp_connection **)va;
275 const struct utcp_connection *b = *(struct utcp_connection **)vb;
278 assert(a->src && b->src);
280 int c = (int)a->src - (int)b->src;
286 c = (int)a->dst - (int)b->dst;
290 static struct utcp_connection *find_connection(const struct utcp *utcp, uint16_t src, uint16_t dst) {
291 if(!utcp->nconnections) {
295 struct utcp_connection key = {
299 struct utcp_connection **match = bsearch(&keyp, utcp->connections, utcp->nconnections, sizeof(*utcp->connections), compare);
300 return match ? *match : NULL;
303 static void free_connection(struct utcp_connection *c) {
304 struct utcp *utcp = c->utcp;
305 struct utcp_connection **cp = bsearch(&c, utcp->connections, utcp->nconnections, sizeof(*utcp->connections), compare);
309 int i = cp - utcp->connections;
310 memmove(cp, cp + 1, (utcp->nconnections - i - 1) * sizeof(*cp));
311 utcp->nconnections--;
313 buffer_exit(&c->rcvbuf);
314 buffer_exit(&c->sndbuf);
318 static struct utcp_connection *allocate_connection(struct utcp *utcp, uint16_t src, uint16_t dst) {
319 // Check whether this combination of src and dst is free
322 if(find_connection(utcp, src, dst)) {
326 } else { // If src == 0, generate a random port number with the high bit set
327 if(utcp->nconnections >= 32767) {
332 src = rand() | 0x8000;
334 while(find_connection(utcp, src, dst)) {
339 // Allocate memory for the new connection
341 if(utcp->nconnections >= utcp->nallocated) {
342 if(!utcp->nallocated) {
343 utcp->nallocated = 4;
345 utcp->nallocated *= 2;
348 struct utcp_connection **new_array = realloc(utcp->connections, utcp->nallocated * sizeof(*utcp->connections));
354 utcp->connections = new_array;
357 struct utcp_connection *c = calloc(1, sizeof(*c));
363 if(!buffer_init(&c->sndbuf, DEFAULT_SNDBUFSIZE, DEFAULT_MAXSNDBUFSIZE)) {
368 if(!buffer_init(&c->rcvbuf, DEFAULT_RCVBUFSIZE, DEFAULT_MAXRCVBUFSIZE)) {
369 buffer_exit(&c->sndbuf);
374 // Fill in the details
383 c->snd.una = c->snd.iss;
384 c->snd.nxt = c->snd.iss + 1;
385 c->rcv.wnd = utcp->mtu;
386 c->snd.last = c->snd.nxt;
387 c->snd.cwnd = utcp->mtu;
390 // Add it to the sorted list of connections
392 utcp->connections[utcp->nconnections++] = c;
393 qsort(utcp->connections, utcp->nconnections, sizeof(*utcp->connections), compare);
398 static inline uint32_t absdiff(uint32_t a, uint32_t b) {
406 // Update RTT variables. See RFC 6298.
407 static void update_rtt(struct utcp_connection *c, uint32_t rtt) {
409 debug("invalid rtt\n");
413 struct utcp *utcp = c->utcp;
417 utcp->rttvar = rtt / 2;
419 utcp->rttvar = (utcp->rttvar * 3 + absdiff(utcp->srtt, rtt)) / 4;
420 utcp->srtt = (utcp->srtt * 7 + rtt) / 8;
423 utcp->rto = utcp->srtt + max(4 * utcp->rttvar, CLOCK_GRANULARITY);
425 if(utcp->rto > MAX_RTO) {
429 debug("rtt %u srtt %u rttvar %u rto %u\n", rtt, utcp->srtt, utcp->rttvar, utcp->rto);
432 static void start_retransmit_timer(struct utcp_connection *c) {
433 gettimeofday(&c->rtrx_timeout, NULL);
434 c->rtrx_timeout.tv_usec += c->utcp->rto;
436 while(c->rtrx_timeout.tv_usec >= 1000000) {
437 c->rtrx_timeout.tv_usec -= 1000000;
438 c->rtrx_timeout.tv_sec++;
441 debug("timeout set to %lu.%06lu (%u)\n", c->rtrx_timeout.tv_sec, c->rtrx_timeout.tv_usec, c->utcp->rto);
444 static void stop_retransmit_timer(struct utcp_connection *c) {
445 timerclear(&c->rtrx_timeout);
446 debug("timeout cleared\n");
449 struct utcp_connection *utcp_connect_ex(struct utcp *utcp, uint16_t dst, utcp_recv_t recv, void *priv, uint32_t flags) {
450 struct utcp_connection *c = allocate_connection(utcp, 0, dst);
456 assert((flags & ~0x1f) == 0);
467 pkt.hdr.src = c->src;
468 pkt.hdr.dst = c->dst;
469 pkt.hdr.seq = c->snd.iss;
471 pkt.hdr.wnd = c->rcv.wnd;
473 pkt.hdr.aux = 0x0101;
477 pkt.init[3] = flags & 0x7;
479 set_state(c, SYN_SENT);
481 print_packet(utcp, "send", &pkt, sizeof(pkt));
482 utcp->send(utcp, &pkt, sizeof(pkt));
484 gettimeofday(&c->conn_timeout, NULL);
485 c->conn_timeout.tv_sec += utcp->timeout;
487 start_retransmit_timer(c);
492 struct utcp_connection *utcp_connect(struct utcp *utcp, uint16_t dst, utcp_recv_t recv, void *priv) {
493 return utcp_connect_ex(utcp, dst, recv, priv, UTCP_TCP);
496 void utcp_accept(struct utcp_connection *c, utcp_recv_t recv, void *priv) {
497 if(c->reapable || c->state != SYN_RECEIVED) {
498 debug("Error: accept() called on invalid connection %p in state %s\n", c, strstate[c->state]);
502 debug("%p accepted, %p %p\n", c, recv, priv);
505 set_state(c, ESTABLISHED);
508 static void ack(struct utcp_connection *c, bool sendatleastone) {
509 int32_t left = seqdiff(c->snd.last, c->snd.nxt);
510 int32_t cwndleft = c->snd.cwnd - seqdiff(c->snd.nxt, c->snd.una);
511 debug("cwndleft = %d\n", cwndleft);
519 if(cwndleft < left) {
523 if(!left && !sendatleastone) {
532 pkt = malloc(sizeof(pkt->hdr) + c->utcp->mtu);
538 pkt->hdr.src = c->src;
539 pkt->hdr.dst = c->dst;
540 pkt->hdr.ack = c->rcv.nxt;
541 pkt->hdr.wnd = c->snd.wnd;
546 uint32_t seglen = left > c->utcp->mtu ? c->utcp->mtu : left;
547 pkt->hdr.seq = c->snd.nxt;
549 buffer_copy(&c->sndbuf, pkt->data, seqdiff(c->snd.nxt, c->snd.una), seglen);
551 c->snd.nxt += seglen;
554 if(seglen && fin_wanted(c, c->snd.nxt)) {
559 if(!c->rtt_start.tv_sec) {
560 // Start RTT measurement
561 gettimeofday(&c->rtt_start, NULL);
562 c->rtt_seq = pkt->hdr.seq + seglen;
563 debug("Starting RTT measurement, expecting ack %u\n", c->rtt_seq);
566 print_packet(c->utcp, "send", pkt, sizeof(pkt->hdr) + seglen);
567 c->utcp->send(c->utcp, pkt, sizeof(pkt->hdr) + seglen);
573 ssize_t utcp_send(struct utcp_connection *c, const void *data, size_t len) {
575 debug("Error: send() called on closed connection %p\n", c);
583 debug("Error: send() called on unconnected connection %p\n", c);
598 debug("Error: send() called on closing connection %p\n", c);
603 // Exit early if we have nothing to send.
614 // Check if we need to be able to buffer all data
616 if(c->flags & UTCP_NO_PARTIAL) {
617 if(len > buffer_free(&c->sndbuf)) {
618 if(len > c->sndbuf.maxsize) {
628 // Add data to send buffer.
630 if(is_reliable(c) || (c->state != SYN_SENT && c->state != SYN_RECEIVED)) {
631 len = buffer_put(&c->sndbuf, data, len);
647 // Don't send anything yet if the connection has not fully established yet
649 if(c->state == SYN_SENT || c->state == SYN_RECEIVED) {
655 if(!is_reliable(c)) {
656 c->snd.una = c->snd.nxt = c->snd.last;
657 buffer_get(&c->sndbuf, NULL, c->sndbuf.used);
660 if(is_reliable(c) && !timerisset(&c->rtrx_timeout)) {
661 start_retransmit_timer(c);
664 if(is_reliable(c) && !timerisset(&c->conn_timeout)) {
665 gettimeofday(&c->conn_timeout, NULL);
666 c->conn_timeout.tv_sec += c->utcp->timeout;
672 static void swap_ports(struct hdr *hdr) {
673 uint16_t tmp = hdr->src;
678 static void retransmit(struct utcp_connection *c) {
679 if(c->state == CLOSED || c->snd.last == c->snd.una) {
680 debug("Retransmit() called but nothing to retransmit!\n");
681 stop_retransmit_timer(c);
685 struct utcp *utcp = c->utcp;
692 pkt = malloc(sizeof(pkt->hdr) + c->utcp->mtu);
698 pkt->hdr.src = c->src;
699 pkt->hdr.dst = c->dst;
700 pkt->hdr.wnd = c->rcv.wnd;
705 // Send our SYN again
706 pkt->hdr.seq = c->snd.iss;
709 pkt->hdr.aux = 0x0101;
713 pkt->data[3] = c->flags & 0x7;
714 print_packet(c->utcp, "rtrx", pkt, sizeof(pkt->hdr) + 4);
715 utcp->send(utcp, pkt, sizeof(pkt->hdr) + 4);
720 pkt->hdr.seq = c->snd.nxt;
721 pkt->hdr.ack = c->rcv.nxt;
722 pkt->hdr.ctl = SYN | ACK;
723 print_packet(c->utcp, "rtrx", pkt, sizeof(pkt->hdr));
724 utcp->send(utcp, pkt, sizeof(pkt->hdr));
732 // Send unacked data again.
733 pkt->hdr.seq = c->snd.una;
734 pkt->hdr.ack = c->rcv.nxt;
736 uint32_t len = seqdiff(c->snd.last, c->snd.una);
738 if(len > utcp->mtu) {
742 if(fin_wanted(c, c->snd.una + len)) {
747 c->snd.nxt = c->snd.una + len;
748 c->snd.cwnd = utcp->mtu; // reduce cwnd on retransmit
749 buffer_copy(&c->sndbuf, pkt->data, 0, len);
750 print_packet(c->utcp, "rtrx", pkt, sizeof(pkt->hdr) + len);
751 utcp->send(utcp, pkt, sizeof(pkt->hdr) + len);
758 // We shouldn't need to retransmit anything in this state.
762 stop_retransmit_timer(c);
766 start_retransmit_timer(c);
769 if(utcp->rto > MAX_RTO) {
773 c->rtt_start.tv_sec = 0; // invalidate RTT timer
779 /* Update receive buffer and SACK entries after consuming data.
783 * |.....0000..1111111111.....22222......3333|
786 * 0..3 represent the SACK entries. The ^ indicates up to which point we want
787 * to remove data from the receive buffer. The idea is to substract "len"
788 * from the offset of all the SACK entries, and then remove/cut down entries
789 * that are shifted to before the start of the receive buffer.
791 * There are three cases:
792 * - the SACK entry is after ^, in that case just change the offset.
793 * - the SACK entry starts before and ends after ^, so we have to
794 * change both its offset and size.
795 * - the SACK entry is completely before ^, in that case delete it.
797 static void sack_consume(struct utcp_connection *c, size_t len) {
798 debug("sack_consume %lu\n", (unsigned long)len);
800 if(len > c->rcvbuf.used) {
801 debug("All SACK entries consumed");
806 buffer_get(&c->rcvbuf, NULL, len);
808 for(int i = 0; i < NSACKS && c->sacks[i].len;) {
809 if(len < c->sacks[i].offset) {
810 c->sacks[i].offset -= len;
812 } else if(len < c->sacks[i].offset + c->sacks[i].len) {
813 c->sacks[i].len -= len - c->sacks[i].offset;
814 c->sacks[i].offset = 0;
818 memmove(&c->sacks[i], &c->sacks[i + 1], (NSACKS - 1 - i) * sizeof(c->sacks)[i]);
819 c->sacks[NSACKS - 1].len = 0;
827 for(int i = 0; i < NSACKS && c->sacks[i].len; i++) {
828 debug("SACK[%d] offset %u len %u\n", i, c->sacks[i].offset, c->sacks[i].len);
832 static void handle_out_of_order(struct utcp_connection *c, uint32_t offset, const void *data, size_t len) {
833 debug("out of order packet, offset %u\n", offset);
834 // Packet loss or reordering occured. Store the data in the buffer.
835 ssize_t rxd = buffer_put_at(&c->rcvbuf, offset, data, len);
837 if(rxd < 0 || (size_t)rxd < len) {
841 // Make note of where we put it.
842 for(int i = 0; i < NSACKS; i++) {
843 if(!c->sacks[i].len) { // nothing to merge, add new entry
844 debug("New SACK entry %d\n", i);
845 c->sacks[i].offset = offset;
846 c->sacks[i].len = rxd;
848 } else if(offset < c->sacks[i].offset) {
849 if(offset + rxd < c->sacks[i].offset) { // insert before
850 if(!c->sacks[NSACKS - 1].len) { // only if room left
851 debug("Insert SACK entry at %d\n", i);
852 memmove(&c->sacks[i + 1], &c->sacks[i], (NSACKS - i - 1) * sizeof(c->sacks)[i]);
853 c->sacks[i].offset = offset;
854 c->sacks[i].len = rxd;
856 debug("SACK entries full, dropping packet\n");
861 debug("Merge with start of SACK entry at %d\n", i);
862 c->sacks[i].offset = offset;
865 } else if(offset <= c->sacks[i].offset + c->sacks[i].len) {
866 if(offset + rxd > c->sacks[i].offset + c->sacks[i].len) { // merge
867 debug("Merge with end of SACK entry at %d\n", i);
868 c->sacks[i].len = offset + rxd - c->sacks[i].offset;
869 // TODO: handle potential merge with next entry
876 for(int i = 0; i < NSACKS && c->sacks[i].len; i++) {
877 debug("SACK[%d] offset %u len %u\n", i, c->sacks[i].offset, c->sacks[i].len);
881 static void handle_in_order(struct utcp_connection *c, const void *data, size_t len) {
882 // Check if we can process out-of-order data now.
883 if(c->sacks[0].len && len >= c->sacks[0].offset) { // TODO: handle overlap with second SACK
884 debug("incoming packet len %lu connected with SACK at %u\n", (unsigned long)len, c->sacks[0].offset);
885 buffer_put_at(&c->rcvbuf, 0, data, len); // TODO: handle return value
886 len = max(len, c->sacks[0].offset + c->sacks[0].len);
887 data = c->rcvbuf.data;
891 ssize_t rxd = c->recv(c, data, len);
893 if(rxd < 0 || (size_t)rxd != len) {
894 // TODO: handle the application not accepting all data.
900 sack_consume(c, len);
907 static void handle_incoming_data(struct utcp_connection *c, uint32_t seq, const void *data, size_t len) {
908 if(!is_reliable(c)) {
909 c->recv(c, data, len);
910 c->rcv.nxt = seq + len;
914 uint32_t offset = seqdiff(seq, c->rcv.nxt);
916 if(offset + len > c->rcvbuf.maxsize) {
921 handle_out_of_order(c, offset, data, len);
923 handle_in_order(c, data, len);
928 ssize_t utcp_recv(struct utcp *utcp, const void *data, size_t len) {
929 const uint8_t *ptr = data;
945 print_packet(utcp, "recv", data, len);
947 // Drop packets smaller than the header
951 if(len < sizeof(hdr)) {
956 // Make a copy from the potentially unaligned data to a struct hdr
958 memcpy(&hdr, ptr, sizeof(hdr));
962 // Drop packets with an unknown CTL flag
964 if(hdr.ctl & ~(SYN | ACK | RST | FIN)) {
969 // Check for auxiliary headers
971 const uint8_t *init = NULL;
973 uint16_t aux = hdr.aux;
976 size_t auxlen = 4 * (aux >> 8) & 0xf;
977 uint8_t auxtype = aux & 0xff;
986 if(!(hdr.ctl & SYN) || auxlen != 4) {
1002 if(!(aux & 0x800)) {
1011 memcpy(&aux, ptr, 2);
1016 bool has_data = len || (hdr.ctl & (SYN | FIN));
1018 // Try to match the packet to an existing connection
1020 struct utcp_connection *c = find_connection(utcp, hdr.dst, hdr.src);
1022 // Is it for a new connection?
1025 // Ignore RST packets
1031 // Is it a SYN packet and are we LISTENing?
1033 if(hdr.ctl & SYN && !(hdr.ctl & ACK) && utcp->accept) {
1034 // If we don't want to accept it, send a RST back
1035 if((utcp->pre_accept && !utcp->pre_accept(utcp, hdr.dst))) {
1040 // Try to allocate memory, otherwise send a RST back
1041 c = allocate_connection(utcp, hdr.dst, hdr.src);
1048 // Parse auxilliary information
1055 c->flags = init[3] & 0x7;
1057 c->flags = UTCP_TCP;
1061 // Return SYN+ACK, go to SYN_RECEIVED state
1062 c->snd.wnd = hdr.wnd;
1063 c->rcv.irs = hdr.seq;
1064 c->rcv.nxt = c->rcv.irs + 1;
1065 set_state(c, SYN_RECEIVED);
1072 pkt.hdr.src = c->src;
1073 pkt.hdr.dst = c->dst;
1074 pkt.hdr.ack = c->rcv.irs + 1;
1075 pkt.hdr.seq = c->snd.iss;
1076 pkt.hdr.wnd = c->rcv.wnd;
1077 pkt.hdr.ctl = SYN | ACK;
1080 pkt.hdr.aux = 0x0101;
1084 pkt.data[3] = c->flags & 0x7;
1085 print_packet(c->utcp, "send", &pkt, sizeof(hdr) + 4);
1086 utcp->send(utcp, &pkt, sizeof(hdr) + 4);
1089 print_packet(c->utcp, "send", &pkt, sizeof(hdr));
1090 utcp->send(utcp, &pkt, sizeof(hdr));
1093 // No, we don't want your packets, send a RST back
1101 debug("%p state %s\n", c->utcp, strstate[c->state]);
1103 // In case this is for a CLOSED connection, ignore the packet.
1104 // TODO: make it so incoming packets can never match a CLOSED connection.
1106 if(c->state == CLOSED) {
1107 debug("Got packet for closed connection\n");
1111 // It is for an existing connection.
1113 // 1. Drop invalid packets.
1115 // 1a. Drop packets that should not happen in our current state.
1136 // 1b. Discard data that is not in our receive window.
1138 if(is_reliable(c)) {
1141 if(c->state == SYN_SENT) {
1143 } else if(len == 0) {
1144 acceptable = seqdiff(hdr.seq, c->rcv.nxt) >= 0;
1146 int32_t rcv_offset = seqdiff(hdr.seq, c->rcv.nxt);
1148 // cut already accepted front overlapping
1149 if(rcv_offset < 0) {
1150 acceptable = len > (size_t) - rcv_offset;
1155 hdr.seq -= rcv_offset;
1158 acceptable = seqdiff(hdr.seq, c->rcv.nxt) >= 0 && seqdiff(hdr.seq, c->rcv.nxt) + len <= c->rcvbuf.maxsize;
1163 debug("Packet not acceptable, %u <= %u + %lu < %u\n", c->rcv.nxt, hdr.seq, (unsigned long)len, c->rcv.nxt + c->rcvbuf.maxsize);
1165 // Ignore unacceptable RST packets.
1170 // Otherwise, continue processing.
1175 c->snd.wnd = hdr.wnd; // TODO: move below
1177 // 1c. Drop packets with an invalid ACK.
1178 // ackno should not roll back, and it should also not be bigger than what we ever could have sent
1179 // (= snd.una + c->sndbuf.used).
1181 if(!is_reliable(c)) {
1182 if(hdr.ack != c->snd.last && c->state >= ESTABLISHED) {
1183 hdr.ack = c->snd.una;
1187 if(hdr.ctl & ACK && (seqdiff(hdr.ack, c->snd.last) > 0 || seqdiff(hdr.ack, c->snd.una) < 0)) {
1188 debug("Packet ack seqno out of range, %u <= %u < %u\n", c->snd.una, hdr.ack, c->snd.una + c->sndbuf.used);
1190 // Ignore unacceptable RST packets.
1198 // 2. Handle RST packets
1203 if(!(hdr.ctl & ACK)) {
1207 // The peer has refused our connection.
1208 set_state(c, CLOSED);
1209 errno = ECONNREFUSED;
1212 c->recv(c, NULL, 0);
1215 if(c->poll && !c->reapable) {
1226 // We haven't told the application about this connection yet. Silently delete.
1238 // The peer has aborted our connection.
1239 set_state(c, CLOSED);
1243 c->recv(c, NULL, 0);
1246 if(c->poll && !c->reapable) {
1259 // As far as the application is concerned, the connection has already been closed.
1260 // If it has called utcp_close() already, we can immediately free this connection.
1266 // Otherwise, immediately move to the CLOSED state.
1267 set_state(c, CLOSED);
1280 if(!(hdr.ctl & ACK)) {
1285 // 3. Advance snd.una
1287 advanced = seqdiff(hdr.ack, c->snd.una);
1291 if(c->rtt_start.tv_sec) {
1292 if(c->rtt_seq == hdr.ack) {
1293 struct timeval now, diff;
1294 gettimeofday(&now, NULL);
1295 timersub(&now, &c->rtt_start, &diff);
1296 update_rtt(c, diff.tv_sec * 1000000 + diff.tv_usec);
1297 c->rtt_start.tv_sec = 0;
1298 } else if(c->rtt_seq < hdr.ack) {
1299 debug("Cancelling RTT measurement: %u < %u\n", c->rtt_seq, hdr.ack);
1300 c->rtt_start.tv_sec = 0;
1304 int32_t data_acked = advanced;
1312 // TODO: handle FIN as well.
1317 assert(data_acked >= 0);
1320 int32_t bufused = seqdiff(c->snd.last, c->snd.una);
1321 assert(data_acked <= bufused);
1325 buffer_get(&c->sndbuf, NULL, data_acked);
1328 // Also advance snd.nxt if possible
1329 if(seqdiff(c->snd.nxt, hdr.ack) < 0) {
1330 c->snd.nxt = hdr.ack;
1333 c->snd.una = hdr.ack;
1336 c->snd.cwnd += utcp->mtu;
1338 if(c->snd.cwnd > c->sndbuf.maxsize) {
1339 c->snd.cwnd = c->sndbuf.maxsize;
1342 // Check if we have sent a FIN that is now ACKed.
1345 if(c->snd.una == c->snd.last) {
1346 set_state(c, FIN_WAIT_2);
1352 if(c->snd.una == c->snd.last) {
1353 gettimeofday(&c->conn_timeout, NULL);
1354 c->conn_timeout.tv_sec += utcp->timeout;
1355 set_state(c, TIME_WAIT);
1364 if(!len && is_reliable(c)) {
1367 if(c->dupack == 3) {
1368 debug("Triplicate ACK\n");
1369 //TODO: Resend one packet and go to fast recovery mode. See RFC 6582.
1370 //We do a very simple variant here; reset the nxt pointer to the last acknowledged packet from the peer.
1371 //Reset the congestion window so we wait for ACKs.
1372 c->snd.nxt = c->snd.una;
1373 c->snd.cwnd = utcp->mtu;
1374 start_retransmit_timer(c);
1382 if(c->snd.una == c->snd.last) {
1383 stop_retransmit_timer(c);
1384 timerclear(&c->conn_timeout);
1385 } else if(is_reliable(c)) {
1386 start_retransmit_timer(c);
1387 gettimeofday(&c->conn_timeout, NULL);
1388 c->conn_timeout.tv_sec += utcp->timeout;
1393 // 5. Process SYN stuff
1399 // This is a SYNACK. It should always have ACKed the SYN.
1404 c->rcv.irs = hdr.seq;
1405 c->rcv.nxt = hdr.seq;
1409 set_state(c, FIN_WAIT_1);
1411 set_state(c, ESTABLISHED);
1414 // TODO: notify application of this somehow.
1418 // This is a retransmit of a SYN, send back the SYNACK.
1428 // Ehm, no. We should never receive a second SYN.
1438 // SYN counts as one sequence number
1442 // 6. Process new data
1444 if(c->state == SYN_RECEIVED) {
1445 // This is the ACK after the SYNACK. It should always have ACKed the SYNACK.
1450 // Are we still LISTENing?
1452 utcp->accept(c, c->src);
1455 if(c->state != ESTABLISHED) {
1456 set_state(c, CLOSED);
1466 // This should never happen.
1481 // Ehm no, We should never receive more data after a FIN.
1491 handle_incoming_data(c, hdr.seq, ptr, len);
1494 // 7. Process FIN stuff
1496 if((hdr.ctl & FIN) && (!is_reliable(c) || hdr.seq + len == c->rcv.nxt)) {
1500 // This should never happen.
1507 set_state(c, CLOSE_WAIT);
1511 set_state(c, CLOSING);
1515 gettimeofday(&c->conn_timeout, NULL);
1516 c->conn_timeout.tv_sec += utcp->timeout;
1517 set_state(c, TIME_WAIT);
1524 // Ehm, no. We should never receive a second FIN.
1534 // FIN counts as one sequence number
1538 // Inform the application that the peer closed its end of the connection.
1541 c->recv(c, NULL, 0);
1545 // Now we send something back if:
1546 // - we received data, so we have to send back an ACK
1547 // -> sendatleastone = true
1548 // - or we got an ack, so we should maybe send a bit more data
1549 // -> sendatleastone = false
1551 if(is_reliable(c) || hdr.ctl & SYN || hdr.ctl & FIN) {
1566 hdr.ack = hdr.seq + len;
1568 hdr.ctl = RST | ACK;
1571 print_packet(utcp, "send", &hdr, sizeof(hdr));
1572 utcp->send(utcp, &hdr, sizeof(hdr));
1577 int utcp_shutdown(struct utcp_connection *c, int dir) {
1578 debug("%p shutdown %d at %u\n", c ? c->utcp : NULL, dir, c ? c->snd.last : 0);
1586 debug("Error: shutdown() called on closed connection %p\n", c);
1591 if(!(dir == UTCP_SHUT_RD || dir == UTCP_SHUT_WR || dir == UTCP_SHUT_RDWR)) {
1596 // TCP does not have a provision for stopping incoming packets.
1597 // The best we can do is to just ignore them.
1598 if(dir == UTCP_SHUT_RD || dir == UTCP_SHUT_RDWR) {
1602 // The rest of the code deals with shutting down writes.
1603 if(dir == UTCP_SHUT_RD) {
1607 // Only process shutting down writes once.
1625 set_state(c, FIN_WAIT_1);
1633 set_state(c, CLOSING);
1646 if(!timerisset(&c->rtrx_timeout)) {
1647 start_retransmit_timer(c);
1653 static bool reset_connection(struct utcp_connection *c) {
1660 debug("Error: abort() called on closed connection %p\n", c);
1677 set_state(c, CLOSED);
1685 set_state(c, CLOSED);
1695 hdr.seq = c->snd.nxt;
1700 print_packet(c->utcp, "send", &hdr, sizeof(hdr));
1701 c->utcp->send(c->utcp, &hdr, sizeof(hdr));
1705 // Closes all the opened connections
1706 void utcp_abort_all_connections(struct utcp *utcp) {
1712 for(int i = 0; i < utcp->nconnections; i++) {
1713 struct utcp_connection *c = utcp->connections[i];
1715 if(c->reapable || c->state == CLOSED) {
1719 utcp_recv_t old_recv = c->recv;
1720 utcp_poll_t old_poll = c->poll;
1722 reset_connection(c);
1726 old_recv(c, NULL, 0);
1729 if(old_poll && !c->reapable) {
1738 int utcp_close(struct utcp_connection *c) {
1739 if(utcp_shutdown(c, SHUT_RDWR) && errno != ENOTCONN) {
1749 int utcp_abort(struct utcp_connection *c) {
1750 if(!reset_connection(c)) {
1759 * One call to this function will loop through all connections,
1760 * checking if something needs to be resent or not.
1761 * The return value is the time to the next timeout in milliseconds,
1762 * or maybe a negative value if the timeout is infinite.
1764 struct timeval utcp_timeout(struct utcp *utcp) {
1766 gettimeofday(&now, NULL);
1767 struct timeval next = {now.tv_sec + 3600, now.tv_usec};
1769 for(int i = 0; i < utcp->nconnections; i++) {
1770 struct utcp_connection *c = utcp->connections[i];
1776 // delete connections that have been utcp_close()d.
1777 if(c->state == CLOSED) {
1779 debug("Reaping %p\n", c);
1787 if(timerisset(&c->conn_timeout) && timercmp(&c->conn_timeout, &now, <)) {
1792 c->recv(c, NULL, 0);
1795 if(c->poll && !c->reapable) {
1802 if(timerisset(&c->rtrx_timeout) && timercmp(&c->rtrx_timeout, &now, <)) {
1803 debug("retransmit()\n");
1808 if((c->state == ESTABLISHED || c->state == CLOSE_WAIT)) {
1809 uint32_t len = buffer_free(&c->sndbuf);
1814 } else if(c->state == CLOSED) {
1819 if(timerisset(&c->conn_timeout) && timercmp(&c->conn_timeout, &next, <)) {
1820 next = c->conn_timeout;
1823 if(timerisset(&c->rtrx_timeout) && timercmp(&c->rtrx_timeout, &next, <)) {
1824 next = c->rtrx_timeout;
1828 struct timeval diff;
1830 timersub(&next, &now, &diff);
1835 bool utcp_is_active(struct utcp *utcp) {
1840 for(int i = 0; i < utcp->nconnections; i++)
1841 if(utcp->connections[i]->state != CLOSED && utcp->connections[i]->state != TIME_WAIT) {
1848 struct utcp *utcp_init(utcp_accept_t accept, utcp_pre_accept_t pre_accept, utcp_send_t send, void *priv) {
1854 struct utcp *utcp = calloc(1, sizeof(*utcp));
1860 utcp->accept = accept;
1861 utcp->pre_accept = pre_accept;
1864 utcp->mtu = DEFAULT_MTU;
1865 utcp->timeout = DEFAULT_USER_TIMEOUT; // sec
1866 utcp->rto = START_RTO; // usec
1871 void utcp_exit(struct utcp *utcp) {
1876 for(int i = 0; i < utcp->nconnections; i++) {
1877 struct utcp_connection *c = utcp->connections[i];
1881 c->recv(c, NULL, 0);
1884 if(c->poll && !c->reapable) {
1889 buffer_exit(&c->rcvbuf);
1890 buffer_exit(&c->sndbuf);
1894 free(utcp->connections);
1898 uint16_t utcp_get_mtu(struct utcp *utcp) {
1899 return utcp ? utcp->mtu : 0;
1902 void utcp_set_mtu(struct utcp *utcp, uint16_t mtu) {
1903 // TODO: handle overhead of the header
1909 void utcp_reset_timers(struct utcp *utcp) {
1914 struct timeval now, then;
1916 gettimeofday(&now, NULL);
1920 then.tv_sec += utcp->timeout;
1922 for(int i = 0; i < utcp->nconnections; i++) {
1923 struct utcp_connection *c = utcp->connections[i];
1929 if(timerisset(&c->rtrx_timeout)) {
1930 c->rtrx_timeout = now;
1933 if(timerisset(&c->conn_timeout)) {
1934 c->conn_timeout = then;
1937 c->rtt_start.tv_sec = 0;
1940 if(utcp->rto > START_RTO) {
1941 utcp->rto = START_RTO;
1945 int utcp_get_user_timeout(struct utcp *u) {
1946 return u ? u->timeout : 0;
1949 void utcp_set_user_timeout(struct utcp *u, int timeout) {
1951 u->timeout = timeout;
1955 size_t utcp_get_sndbuf(struct utcp_connection *c) {
1956 return c ? c->sndbuf.maxsize : 0;
1959 size_t utcp_get_sndbuf_free(struct utcp_connection *c) {
1969 return buffer_free(&c->sndbuf);
1976 void utcp_set_sndbuf(struct utcp_connection *c, size_t size) {
1981 c->sndbuf.maxsize = size;
1983 if(c->sndbuf.maxsize != size) {
1984 c->sndbuf.maxsize = -1;
1988 size_t utcp_get_rcvbuf(struct utcp_connection *c) {
1989 return c ? c->rcvbuf.maxsize : 0;
1992 size_t utcp_get_rcvbuf_free(struct utcp_connection *c) {
1993 if(c && (c->state == ESTABLISHED || c->state == CLOSE_WAIT)) {
1994 return buffer_free(&c->rcvbuf);
2000 void utcp_set_rcvbuf(struct utcp_connection *c, size_t size) {
2005 c->rcvbuf.maxsize = size;
2007 if(c->rcvbuf.maxsize != size) {
2008 c->rcvbuf.maxsize = -1;
2012 size_t utcp_get_sendq(struct utcp_connection *c) {
2013 return c->sndbuf.used;
2016 size_t utcp_get_recvq(struct utcp_connection *c) {
2017 return c->rcvbuf.used;
2020 bool utcp_get_nodelay(struct utcp_connection *c) {
2021 return c ? c->nodelay : false;
2024 void utcp_set_nodelay(struct utcp_connection *c, bool nodelay) {
2026 c->nodelay = nodelay;
2030 bool utcp_get_keepalive(struct utcp_connection *c) {
2031 return c ? c->keepalive : false;
2034 void utcp_set_keepalive(struct utcp_connection *c, bool keepalive) {
2036 c->keepalive = keepalive;
2040 size_t utcp_get_outq(struct utcp_connection *c) {
2041 return c ? seqdiff(c->snd.nxt, c->snd.una) : 0;
2044 void utcp_set_recv_cb(struct utcp_connection *c, utcp_recv_t recv) {
2050 void utcp_set_poll_cb(struct utcp_connection *c, utcp_poll_t poll) {
2056 void utcp_set_accept_cb(struct utcp *utcp, utcp_accept_t accept, utcp_pre_accept_t pre_accept) {
2058 utcp->accept = accept;
2059 utcp->pre_accept = pre_accept;
2063 void utcp_expect_data(struct utcp_connection *c, bool expect) {
2064 if(!c || c->reapable) {
2068 if(!(c->state == ESTABLISHED || c->state == FIN_WAIT_1 || c->state == FIN_WAIT_2)) {
2073 // If we expect data, start the connection timer.
2074 if(!timerisset(&c->conn_timeout)) {
2075 gettimeofday(&c->conn_timeout, NULL);
2076 c->conn_timeout.tv_sec += c->utcp->timeout;
2079 // If we want to cancel expecting data, only clear the timer when there is no unACKed data.
2080 if(c->snd.una == c->snd.last) {
2081 timerclear(&c->conn_timeout);
2086 void utcp_offline(struct utcp *utcp, bool offline) {
2088 gettimeofday(&now, NULL);
2090 for(int i = 0; i < utcp->nconnections; i++) {
2091 struct utcp_connection *c = utcp->connections[i];
2097 utcp_expect_data(c, offline);
2100 if(timerisset(&c->rtrx_timeout)) {
2101 c->rtrx_timeout = now;
2104 utcp->connections[i]->rtt_start.tv_sec = 0;
2108 if(!offline && utcp->rto > START_RTO) {
2109 utcp->rto = START_RTO;