2 utcp.c -- Userspace TCP
3 Copyright (C) 2014 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) do {\
49 (r)->tv_sec = (a)->tv_sec - (b)->tv_sec;\
50 (r)->tv_usec = (a)->tv_usec - (b)->tv_usec;\
52 (r)->tv_sec--, (r)->tv_usec += 1000000;\
59 static void debug(const char *format, ...) {
62 vfprintf(stderr, format, ap);
66 static void print_packet(struct utcp *utcp, const char *dir, const void *pkt, size_t len) {
68 if(len < sizeof hdr) {
69 debug("%p %s: short packet (%zu bytes)\n", utcp, dir, len);
73 memcpy(&hdr, pkt, sizeof hdr);
74 fprintf (stderr, "%p %s: len=%zu, src=%u dst=%u seq=%u ack=%u wnd=%u ctl=", utcp, dir, len, hdr.src, hdr.dst, hdr.seq, hdr.ack, hdr.wnd);
84 if(len > sizeof hdr) {
86 for(int i = sizeof hdr; i < len; i++) {
87 const char *data = pkt;
88 debug("%c", data[i] >= 32 ? data[i] : '.');
96 #define print_packet(...)
99 static void set_state(struct utcp_connection *c, enum state state) {
101 if(state == ESTABLISHED)
102 timerclear(&c->conn_timeout);
103 debug("%p new state: %s\n", c->utcp, strstate[state]);
106 static inline void list_connections(struct utcp *utcp) {
107 debug("%p has %d connections:\n", utcp, utcp->nconnections);
108 for(int i = 0; i < utcp->nconnections; i++)
109 debug(" %u -> %u state %s\n", utcp->connections[i]->src, utcp->connections[i]->dst, strstate[utcp->connections[i]->state]);
112 static int32_t seqdiff(uint32_t a, uint32_t b) {
117 // TODO: convert to ringbuffers to avoid memmove() operations.
119 // Store data into the buffer
120 static ssize_t buffer_put(struct buffer *buf, const void *data, size_t len) {
121 if(buf->maxsize <= buf->used)
123 if(len > buf->maxsize - buf->used)
124 len = buf->maxsize - buf->used;
125 if(len > buf->size - buf->used) {
126 size_t newsize = buf->size;
129 } while(newsize < buf->used + len);
130 if(newsize > buf->maxsize)
131 newsize = buf->maxsize;
132 char *newdata = realloc(buf->data, newsize);
138 memcpy(buf->data + buf->used, data, len);
143 // Get data from the buffer. data can be NULL.
144 static ssize_t buffer_get(struct buffer *buf, void *data, size_t len) {
148 memcpy(data, buf->data, len);
150 memmove(buf->data, buf->data + len, buf->used - len);
155 // Copy data from the buffer without removing it.
156 static ssize_t buffer_copy(struct buffer *buf, void *data, size_t offset, size_t len) {
157 if(offset >= buf->used)
159 if(offset + len > buf->used)
160 len = buf->used - offset;
161 memcpy(data, buf->data + offset, len);
165 static bool buffer_init(struct buffer *buf, uint32_t len, uint32_t maxlen) {
166 memset(buf, 0, sizeof *buf);
167 buf->data = malloc(len);
171 buf->maxsize = maxlen;
175 static void buffer_exit(struct buffer *buf) {
177 memset(buf, 0, sizeof *buf);
180 static uint32_t buffer_free(const struct buffer *buf) {
181 return buf->maxsize - buf->used;
184 // Connections are stored in a sorted list.
185 // This gives O(log(N)) lookup time, O(N log(N)) insertion time and O(N) deletion time.
187 static int compare(const void *va, const void *vb) {
190 const struct utcp_connection *a = *(struct utcp_connection **)va;
191 const struct utcp_connection *b = *(struct utcp_connection **)vb;
194 assert(a->src && b->src);
196 int c = (int)a->src - (int)b->src;
199 c = (int)a->dst - (int)b->dst;
203 static struct utcp_connection *find_connection(const struct utcp *utcp, uint16_t src, uint16_t dst) {
204 if(!utcp->nconnections)
206 struct utcp_connection key = {
210 struct utcp_connection **match = bsearch(&keyp, utcp->connections, utcp->nconnections, sizeof *utcp->connections, compare);
211 return match ? *match : NULL;
214 static void free_connection(struct utcp_connection *c) {
215 struct utcp *utcp = c->utcp;
216 struct utcp_connection **cp = bsearch(&c, utcp->connections, utcp->nconnections, sizeof *utcp->connections, compare);
220 int i = cp - utcp->connections;
221 memmove(cp, cp + 1, (utcp->nconnections - i - 1) * sizeof *cp);
222 utcp->nconnections--;
224 buffer_exit(&c->sndbuf);
228 static struct utcp_connection *allocate_connection(struct utcp *utcp, uint16_t src, uint16_t dst) {
229 // Check whether this combination of src and dst is free
232 if(find_connection(utcp, src, dst)) {
236 } else { // If src == 0, generate a random port number with the high bit set
237 if(utcp->nconnections >= 32767) {
241 src = rand() | 0x8000;
242 while(find_connection(utcp, src, dst))
246 // Allocate memory for the new connection
248 if(utcp->nconnections >= utcp->nallocated) {
249 if(!utcp->nallocated)
250 utcp->nallocated = 4;
252 utcp->nallocated *= 2;
253 struct utcp_connection **new_array = realloc(utcp->connections, utcp->nallocated * sizeof *utcp->connections);
256 utcp->connections = new_array;
259 struct utcp_connection *c = calloc(1, sizeof *c);
263 if(!buffer_init(&c->sndbuf, DEFAULT_SNDBUFSIZE, DEFAULT_MAXSNDBUFSIZE)) {
268 // Fill in the details
273 c->snd.una = c->snd.iss;
274 c->snd.nxt = c->snd.iss + 1;
275 c->rcv.wnd = utcp->mtu;
276 c->snd.last = c->snd.nxt;
277 c->snd.cwnd = utcp->mtu;
280 // Add it to the sorted list of connections
282 utcp->connections[utcp->nconnections++] = c;
283 qsort(utcp->connections, utcp->nconnections, sizeof *utcp->connections, compare);
288 struct utcp_connection *utcp_connect(struct utcp *utcp, uint16_t dst, utcp_recv_t recv, void *priv) {
289 struct utcp_connection *c = allocate_connection(utcp, 0, dst);
300 hdr.seq = c->snd.iss;
302 hdr.wnd = c->rcv.wnd;
306 set_state(c, SYN_SENT);
308 print_packet(utcp, "send", &hdr, sizeof hdr);
309 utcp->send(utcp, &hdr, sizeof hdr);
311 gettimeofday(&c->conn_timeout, NULL);
312 c->conn_timeout.tv_sec += utcp->timeout;
317 void utcp_accept(struct utcp_connection *c, utcp_recv_t recv, void *priv) {
318 if(c->reapable || c->state != SYN_RECEIVED) {
319 debug("Error: accept() called on invalid connection %p in state %s\n", c, strstate[c->state]);
323 debug("%p accepted, %p %p\n", c, recv, priv);
326 set_state(c, ESTABLISHED);
329 static void ack(struct utcp_connection *c, bool sendatleastone) {
330 int32_t left = seqdiff(c->snd.last, c->snd.nxt);
331 int32_t cwndleft = c->snd.cwnd - seqdiff(c->snd.nxt, c->snd.una);
341 if(!left && !sendatleastone)
349 pkt = malloc(sizeof pkt->hdr + c->utcp->mtu);
353 pkt->hdr.src = c->src;
354 pkt->hdr.dst = c->dst;
355 pkt->hdr.ack = c->rcv.nxt;
356 pkt->hdr.wnd = c->snd.wnd;
361 uint32_t seglen = left > c->utcp->mtu ? c->utcp->mtu : left;
362 pkt->hdr.seq = c->snd.nxt;
364 buffer_copy(&c->sndbuf, pkt->data, seqdiff(c->snd.nxt, c->snd.una), seglen);
366 c->snd.nxt += seglen;
369 if(c->state != ESTABLISHED && seglen && c->snd.nxt == c->snd.last) {
381 print_packet(c->utcp, "send", pkt, sizeof pkt->hdr + seglen);
382 c->utcp->send(c->utcp, pkt, sizeof pkt->hdr + seglen);
388 ssize_t utcp_send(struct utcp_connection *c, const void *data, size_t len) {
390 debug("Error: send() called on closed connection %p\n", c);
400 debug("Error: send() called on unconnected connection %p\n", c);
411 debug("Error: send() called on closing connection %p\n", c);
416 // Add data to send buffer
426 len = buffer_put(&c->sndbuf, data, len);
437 static void swap_ports(struct hdr *hdr) {
438 uint16_t tmp = hdr->src;
443 static void retransmit(struct utcp_connection *c) {
444 if(c->state == CLOSED || c->snd.nxt == c->snd.una)
447 struct utcp *utcp = c->utcp;
454 pkt = malloc(sizeof pkt->hdr + c->utcp->mtu);
458 pkt->hdr.src = c->src;
459 pkt->hdr.dst = c->dst;
463 // TODO: this should not happen
467 pkt->hdr.seq = c->snd.iss;
469 pkt->hdr.wnd = c->rcv.wnd;
471 print_packet(c->utcp, "rtrx", pkt, sizeof pkt->hdr);
472 utcp->send(utcp, pkt, sizeof pkt->hdr);
476 pkt->hdr.seq = c->snd.nxt;
477 pkt->hdr.ack = c->rcv.nxt;
478 pkt->hdr.ctl = SYN | ACK;
479 print_packet(c->utcp, "rtrx", pkt, sizeof pkt->hdr);
480 utcp->send(utcp, pkt, sizeof pkt->hdr);
485 pkt->hdr.seq = c->snd.una;
486 pkt->hdr.ack = c->rcv.nxt;
488 uint32_t len = seqdiff(c->snd.nxt, c->snd.una);
489 if(c->state == FIN_WAIT_1)
494 if(c->state == FIN_WAIT_1)
497 buffer_copy(&c->sndbuf, pkt->data, 0, len);
498 print_packet(c->utcp, "rtrx", pkt, sizeof pkt->hdr + len);
499 utcp->send(utcp, pkt, sizeof pkt->hdr + len);
514 ssize_t utcp_recv(struct utcp *utcp, const void *data, size_t len) {
528 print_packet(utcp, "recv", data, len);
530 // Drop packets smaller than the header
533 if(len < sizeof hdr) {
538 // Make a copy from the potentially unaligned data to a struct hdr
540 memcpy(&hdr, data, sizeof hdr);
544 // Drop packets with an unknown CTL flag
546 if(hdr.ctl & ~(SYN | ACK | RST | FIN)) {
551 // Try to match the packet to an existing connection
553 struct utcp_connection *c = find_connection(utcp, hdr.dst, hdr.src);
555 // Is it for a new connection?
558 // Ignore RST packets
563 // Is it a SYN packet and are we LISTENing?
565 if(hdr.ctl & SYN && !(hdr.ctl & ACK) && utcp->accept) {
566 // If we don't want to accept it, send a RST back
567 if((utcp->pre_accept && !utcp->pre_accept(utcp, hdr.dst))) {
572 // Try to allocate memory, otherwise send a RST back
573 c = allocate_connection(utcp, hdr.dst, hdr.src);
579 // Return SYN+ACK, go to SYN_RECEIVED state
580 c->snd.wnd = hdr.wnd;
581 c->rcv.irs = hdr.seq;
582 c->rcv.nxt = c->rcv.irs + 1;
583 set_state(c, SYN_RECEIVED);
587 hdr.ack = c->rcv.irs + 1;
588 hdr.seq = c->snd.iss;
590 print_packet(c->utcp, "send", &hdr, sizeof hdr);
591 utcp->send(utcp, &hdr, sizeof hdr);
593 // No, we don't want your packets, send a RST back
601 debug("%p state %s\n", c->utcp, strstate[c->state]);
603 // In case this is for a CLOSED connection, ignore the packet.
604 // TODO: make it so incoming packets can never match a CLOSED connection.
606 if(c->state == CLOSED)
609 // It is for an existing connection.
611 uint32_t prevrcvnxt = c->rcv.nxt;
613 // 1. Drop invalid packets.
615 // 1a. Drop packets that should not happen in our current state.
635 // 1b. Drop packets with a sequence number not in our receive window.
639 if(c->state == SYN_SENT)
642 // TODO: handle packets overlapping c->rcv.nxt.
644 // Only use this when accepting out-of-order packets.
647 acceptable = hdr.seq == c->rcv.nxt;
649 acceptable = (seqdiff(hdr.seq, c->rcv.nxt) >= 0 && seqdiff(hdr.seq, c->rcv.nxt + c->rcv.wnd) < 0);
652 // We don't accept data when the receive window is zero.
655 // Both start and end of packet must be within the receive window
656 acceptable = (seqdiff(hdr.seq, c->rcv.nxt) >= 0 && seqdiff(hdr.seq, c->rcv.nxt + c->rcv.wnd) < 0)
657 || (seqdiff(hdr.seq + len + 1, c->rcv.nxt) >= 0 && seqdiff(hdr.seq + len - 1, c->rcv.nxt + c->rcv.wnd) < 0);
659 if(c->state != SYN_SENT)
660 acceptable = hdr.seq == c->rcv.nxt;
664 debug("Packet not acceptable, %u <= %u + %zu < %u\n", c->rcv.nxt, hdr.seq, len, c->rcv.nxt + c->rcv.wnd);
665 // Ignore unacceptable RST packets.
668 // Otherwise, send an ACK back in the hope things improve.
673 c->snd.wnd = hdr.wnd; // TODO: move below
675 // 1c. Drop packets with an invalid ACK.
676 // ackno should not roll back, and it should also not be bigger than snd.nxt.
678 if(hdr.ctl & ACK && (seqdiff(hdr.ack, c->snd.nxt) > 0 || seqdiff(hdr.ack, c->snd.una) < 0)) {
679 debug("Packet ack seqno out of range, %u %u %u\n", hdr.ack, c->snd.una, c->snd.nxt);
680 // Ignore unacceptable RST packets.
686 // 2. Handle RST packets
693 // The peer has refused our connection.
694 set_state(c, CLOSED);
695 errno = ECONNREFUSED;
702 // We haven't told the application about this connection yet. Silently delete.
711 // The peer has aborted our connection.
712 set_state(c, CLOSED);
722 // As far as the application is concerned, the connection has already been closed.
723 // If it has called utcp_close() already, we can immediately free this connection.
728 // Otherwise, immediately move to the CLOSED state.
729 set_state(c, CLOSED);
739 // 3. Advance snd.una
741 uint32_t advanced = seqdiff(hdr.ack, c->snd.una);
742 prevrcvnxt = c->rcv.nxt;
745 int32_t data_acked = advanced;
752 // TODO: handle FIN as well.
757 assert(data_acked >= 0);
759 int32_t bufused = seqdiff(c->snd.last, c->snd.una);
760 assert(data_acked <= bufused);
763 buffer_get(&c->sndbuf, NULL, data_acked);
765 c->snd.una = hdr.ack;
768 c->snd.cwnd += utcp->mtu;
769 if(c->snd.cwnd > c->sndbuf.maxsize)
770 c->snd.cwnd = c->sndbuf.maxsize;
772 // Check if we have sent a FIN that is now ACKed.
775 if(c->snd.una == c->snd.last)
776 set_state(c, FIN_WAIT_2);
779 if(c->snd.una == c->snd.last) {
780 gettimeofday(&c->conn_timeout, NULL);
781 c->conn_timeout.tv_sec += 60;
782 set_state(c, TIME_WAIT);
792 debug("Triplicate ACK\n");
793 //TODO: Resend one packet and go to fast recovery mode. See RFC 6582.
794 //We do a very simple variant here; reset the nxt pointer to the last acknowledged packet from the peer.
795 //This will cause us to start retransmitting, but at the same speed as the incoming ACKs arrive,
796 //thus preventing a drop in speed.
797 c->snd.nxt = c->snd.una;
805 timerclear(&c->conn_timeout); // It will be set anew in utcp_timeout() if c->snd.una != c->snd.nxt.
806 if(c->snd.una == c->snd.nxt)
807 timerclear(&c->rtrx_timeout);
810 // 5. Process SYN stuff
815 // This is a SYNACK. It should always have ACKed the SYN.
818 c->rcv.irs = hdr.seq;
819 c->rcv.nxt = hdr.seq;
820 set_state(c, ESTABLISHED);
821 // TODO: notify application of this somehow.
831 // Ehm, no. We should never receive a second SYN.
840 // SYN counts as one sequence number
844 // 6. Process new data
846 if(c->state == SYN_RECEIVED) {
847 // This is the ACK after the SYNACK. It should always have ACKed the SYNACK.
851 // Are we still LISTENing?
853 utcp->accept(c, c->src);
855 if(c->state != ESTABLISHED) {
856 set_state(c, CLOSED);
866 // This should never happen.
879 // Ehm no, We should never receive more data after a FIN.
891 rxd = c->recv(c, data, len);
893 // TODO: once we have a receive buffer, handle the application not accepting all data.
899 rxd = len; // Bad application, bad!
907 // 7. Process FIN stuff
913 // This should never happen.
919 set_state(c, CLOSE_WAIT);
922 set_state(c, CLOSING);
925 gettimeofday(&c->conn_timeout, NULL);
926 c->conn_timeout.tv_sec += 60;
927 set_state(c, TIME_WAIT);
933 // Ehm, no. We should never receive a second FIN.
942 // FIN counts as one sequence number
946 // Inform the application that the peer closed the connection.
953 // Now we send something back if:
954 // - we advanced rcv.nxt (ie, we got some data that needs to be ACKed)
955 // -> sendatleastone = true
956 // - or we got an ack, so we should maybe send a bit more data
957 // -> sendatleastone = false
960 ack(c, prevrcvnxt != c->rcv.nxt);
970 hdr.ack = hdr.seq + len;
974 print_packet(utcp, "send", &hdr, sizeof hdr);
975 utcp->send(utcp, &hdr, sizeof hdr);
980 int utcp_shutdown(struct utcp_connection *c, int dir) {
981 debug("%p shutdown %d at %u\n", c ? c->utcp : NULL, dir, c->snd.last);
988 debug("Error: shutdown() called on closed connection %p\n", c);
994 // TODO: check that repeated calls with the same parameters should have no effect
1001 set_state(c, CLOSED);
1006 set_state(c, FIN_WAIT_1);
1012 set_state(c, CLOSING);
1027 int utcp_close(struct utcp_connection *c) {
1028 if(utcp_shutdown(c, SHUT_RDWR))
1036 int utcp_abort(struct utcp_connection *c) {
1043 debug("Error: abort() called on closed connection %p\n", c);
1060 set_state(c, CLOSED);
1068 set_state(c, CLOSED);
1078 hdr.seq = c->snd.nxt;
1083 print_packet(c->utcp, "send", &hdr, sizeof hdr);
1084 c->utcp->send(c->utcp, &hdr, sizeof hdr);
1089 * One call to this function will loop through all connections,
1090 * checking if something needs to be resent or not.
1091 * The return value is the time to the next timeout in milliseconds,
1092 * or maybe a negative value if the timeout is infinite.
1094 struct timeval utcp_timeout(struct utcp *utcp) {
1096 gettimeofday(&now, NULL);
1097 struct timeval next = {now.tv_sec + 3600, now.tv_usec};
1099 for(int i = 0; i < utcp->nconnections; i++) {
1100 struct utcp_connection *c = utcp->connections[i];
1104 if(c->state == CLOSED) {
1106 debug("Reaping %p\n", c);
1113 if(timerisset(&c->conn_timeout) && timercmp(&c->conn_timeout, &now, <)) {
1117 c->recv(c, NULL, 0);
1121 if(timerisset(&c->rtrx_timeout) && timercmp(&c->rtrx_timeout, &now, <)) {
1125 if(c->poll && buffer_free(&c->sndbuf) && (c->state == ESTABLISHED || c->state == CLOSE_WAIT))
1126 c->poll(c, buffer_free(&c->sndbuf));
1128 if(timerisset(&c->conn_timeout) && timercmp(&c->conn_timeout, &next, <))
1129 next = c->conn_timeout;
1131 if(c->snd.nxt != c->snd.una) {
1132 c->rtrx_timeout = now;
1133 c->rtrx_timeout.tv_sec++;
1135 timerclear(&c->rtrx_timeout);
1138 if(timerisset(&c->rtrx_timeout) && timercmp(&c->rtrx_timeout, &next, <))
1139 next = c->rtrx_timeout;
1142 struct timeval diff;
1143 timersub(&next, &now, &diff);
1147 struct utcp *utcp_init(utcp_accept_t accept, utcp_pre_accept_t pre_accept, utcp_send_t send, void *priv) {
1148 struct utcp *utcp = calloc(1, sizeof *utcp);
1157 utcp->accept = accept;
1158 utcp->pre_accept = pre_accept;
1167 void utcp_exit(struct utcp *utcp) {
1170 for(int i = 0; i < utcp->nconnections; i++) {
1171 if(!utcp->connections[i]->reapable)
1172 debug("Warning, freeing unclosed connection %p\n", utcp->connections[i]);
1173 buffer_exit(&utcp->connections[i]->sndbuf);
1174 free(utcp->connections[i]);
1176 free(utcp->connections);
1180 uint16_t utcp_get_mtu(struct utcp *utcp) {
1181 return utcp ? utcp->mtu : 0;
1184 void utcp_set_mtu(struct utcp *utcp, uint16_t mtu) {
1185 // TODO: handle overhead of the header
1190 int utcp_get_user_timeout(struct utcp *u) {
1191 return u ? u->timeout : 0;
1194 void utcp_set_user_timeout(struct utcp *u, int timeout) {
1196 u->timeout = timeout;
1199 size_t utcp_get_sndbuf(struct utcp_connection *c) {
1200 return c ? c->sndbuf.maxsize : 0;
1203 size_t utcp_get_sndbuf_free(struct utcp_connection *c) {
1204 if(c && (c->state == ESTABLISHED || c->state == CLOSE_WAIT))
1205 return buffer_free(&c->sndbuf);
1210 void utcp_set_sndbuf(struct utcp_connection *c, size_t size) {
1213 c->sndbuf.maxsize = size;
1214 if(c->sndbuf.maxsize != size)
1215 c->sndbuf.maxsize = -1;
1218 bool utcp_get_nodelay(struct utcp_connection *c) {
1219 return c ? c->nodelay : false;
1222 void utcp_set_nodelay(struct utcp_connection *c, bool nodelay) {
1224 c->nodelay = nodelay;
1227 bool utcp_get_keepalive(struct utcp_connection *c) {
1228 return c ? c->keepalive : false;
1231 void utcp_set_keepalive(struct utcp_connection *c, bool keepalive) {
1233 c->keepalive = keepalive;
1236 size_t utcp_get_outq(struct utcp_connection *c) {
1237 return c ? seqdiff(c->snd.nxt, c->snd.una) : 0;
1240 void utcp_set_recv_cb(struct utcp_connection *c, utcp_recv_t recv) {
1245 void utcp_set_poll_cb(struct utcp_connection *c, utcp_poll_t poll) {