[tcp] Allow out-of-order receive queue to be discarded
[gpxe.git] / src / net / tcp.c
1 #include <string.h>
2 #include <stdlib.h>
3 #include <stdio.h>
4 #include <assert.h>
5 #include <errno.h>
6 #include <byteswap.h>
7 #include <gpxe/timer.h>
8 #include <gpxe/iobuf.h>
9 #include <gpxe/malloc.h>
10 #include <gpxe/retry.h>
11 #include <gpxe/refcnt.h>
12 #include <gpxe/xfer.h>
13 #include <gpxe/open.h>
14 #include <gpxe/uri.h>
15 #include <gpxe/tcpip.h>
16 #include <gpxe/tcp.h>
17
18 /** @file
19  *
20  * TCP protocol
21  *
22  */
23
24 FILE_LICENCE ( GPL2_OR_LATER );
25
26 /** A TCP connection */
27 struct tcp_connection {
28         /** Reference counter */
29         struct refcnt refcnt;
30         /** List of TCP connections */
31         struct list_head list;
32
33         /** Flags */
34         unsigned int flags;
35
36         /** Data transfer interface */
37         struct xfer_interface xfer;
38
39         /** Remote socket address */
40         struct sockaddr_tcpip peer;
41         /** Local port */
42         unsigned int local_port;
43
44         /** Current TCP state */
45         unsigned int tcp_state;
46         /** Previous TCP state
47          *
48          * Maintained only for debug messages
49          */
50         unsigned int prev_tcp_state;
51         /** Current sequence number
52          *
53          * Equivalent to SND.UNA in RFC 793 terminology.
54          */
55         uint32_t snd_seq;
56         /** Unacknowledged sequence count
57          *
58          * Equivalent to (SND.NXT-SND.UNA) in RFC 793 terminology.
59          */
60         uint32_t snd_sent;
61         /** Send window
62          *
63          * Equivalent to SND.WND in RFC 793 terminology
64          */
65         uint32_t snd_win;
66         /** Current acknowledgement number
67          *
68          * Equivalent to RCV.NXT in RFC 793 terminology.
69          */
70         uint32_t rcv_ack;
71         /** Receive window
72          *
73          * Equivalent to RCV.WND in RFC 793 terminology.
74          */
75         uint32_t rcv_win;
76         /** Most recent received timestamp
77          *
78          * Equivalent to TS.Recent in RFC 1323 terminology.
79          */
80         uint32_t ts_recent;
81
82         /** Transmit queue */
83         struct list_head tx_queue;
84         /** Receive queue */
85         struct list_head rx_queue;
86         /** Retransmission timer */
87         struct retry_timer timer;
88         /** Shutdown (TIME_WAIT) timer */
89         struct retry_timer wait;
90 };
91
92 /** TCP flags */
93 enum tcp_flags {
94         /** TCP data transfer interface has been closed */
95         TCP_XFER_CLOSED = 0x0001,
96         /** TCP timestamps are enabled */
97         TCP_TS_ENABLED = 0x0002,
98         /** TCP acknowledgement is pending */
99         TCP_ACK_PENDING = 0x0004,
100 };
101
102 /** TCP internal header
103  *
104  * This is the header that replaces the TCP header for packets
105  * enqueued on the receive queue.
106  */
107 struct tcp_rx_queued_header {
108         /** SEQ value, in host-endian order
109          *
110          * This represents the SEQ value at the time the packet is
111          * enqueued, and so excludes the SYN, if present.
112          */
113         uint32_t seq;
114         /** Flags
115          *
116          * Only FIN is valid within this flags byte; all other flags
117          * have already been processed by the time the packet is
118          * enqueued.
119          */
120         uint8_t flags;
121         /** Reserved */
122         uint8_t reserved[3];
123 };
124
125 /**
126  * List of registered TCP connections
127  */
128 static LIST_HEAD ( tcp_conns );
129
130 /* Forward declarations */
131 static struct xfer_interface_operations tcp_xfer_operations;
132 static void tcp_expired ( struct retry_timer *timer, int over );
133 static void tcp_wait_expired ( struct retry_timer *timer, int over );
134 static int tcp_rx_ack ( struct tcp_connection *tcp, uint32_t ack,
135                         uint32_t win );
136
137 /**
138  * Name TCP state
139  *
140  * @v state             TCP state
141  * @ret name            Name of TCP state
142  */
143 static inline __attribute__ (( always_inline )) const char *
144 tcp_state ( int state ) {
145         switch ( state ) {
146         case TCP_CLOSED:                return "CLOSED";
147         case TCP_LISTEN:                return "LISTEN";
148         case TCP_SYN_SENT:              return "SYN_SENT";
149         case TCP_SYN_RCVD:              return "SYN_RCVD";
150         case TCP_ESTABLISHED:           return "ESTABLISHED";
151         case TCP_FIN_WAIT_1:            return "FIN_WAIT_1";
152         case TCP_FIN_WAIT_2:            return "FIN_WAIT_2";
153         case TCP_CLOSING_OR_LAST_ACK:   return "CLOSING/LAST_ACK";
154         case TCP_TIME_WAIT:             return "TIME_WAIT";
155         case TCP_CLOSE_WAIT:            return "CLOSE_WAIT";
156         default:                        return "INVALID";
157         }
158 }
159
160 /**
161  * Dump TCP state transition
162  *
163  * @v tcp               TCP connection
164  */
165 static inline __attribute__ (( always_inline )) void
166 tcp_dump_state ( struct tcp_connection *tcp ) {
167
168         if ( tcp->tcp_state != tcp->prev_tcp_state ) {
169                 DBGC ( tcp, "TCP %p transitioned from %s to %s\n", tcp,
170                        tcp_state ( tcp->prev_tcp_state ),
171                        tcp_state ( tcp->tcp_state ) );
172         }
173         tcp->prev_tcp_state = tcp->tcp_state;
174 }
175
176 /**
177  * Dump TCP flags
178  *
179  * @v flags             TCP flags
180  */
181 static inline __attribute__ (( always_inline )) void
182 tcp_dump_flags ( struct tcp_connection *tcp, unsigned int flags ) {
183         if ( flags & TCP_RST )
184                 DBGC2 ( tcp, " RST" );
185         if ( flags & TCP_SYN )
186                 DBGC2 ( tcp, " SYN" );
187         if ( flags & TCP_PSH )
188                 DBGC2 ( tcp, " PSH" );
189         if ( flags & TCP_FIN )
190                 DBGC2 ( tcp, " FIN" );
191         if ( flags & TCP_ACK )
192                 DBGC2 ( tcp, " ACK" );
193 }
194
195 /***************************************************************************
196  *
197  * Open and close
198  *
199  ***************************************************************************
200  */
201
202 /**
203  * Bind TCP connection to local port
204  *
205  * @v tcp               TCP connection
206  * @v port              Local port number
207  * @ret rc              Return status code
208  *
209  * If the port is 0, the connection is assigned an available port
210  * between 1024 and 65535.
211  */
212 static int tcp_bind ( struct tcp_connection *tcp, unsigned int port ) {
213         struct tcp_connection *existing;
214         uint16_t try_port;
215         int i;
216
217         /* If no port specified, find an available port */
218         if ( ! port ) {
219                 try_port = ( random() % 64512 ) + 1023;
220                 for ( i = 0 ; i < 65536 ; ++i ) {
221                         if ( ++try_port < 1024 )
222                                 continue;
223                         if ( tcp_bind ( tcp, try_port ) == 0 )
224                                 return 0;
225                 }
226                 DBGC ( tcp, "TCP %p could not bind: no free ports\n", tcp );
227                 return -EADDRINUSE;
228         }
229
230         /* Attempt bind to local port */
231         list_for_each_entry ( existing, &tcp_conns, list ) {
232                 if ( existing->local_port == port ) {
233                         DBGC ( tcp, "TCP %p could not bind: port %d in use\n",
234                                tcp, port );
235                         return -EADDRINUSE;
236                 }
237         }
238         tcp->local_port = port;
239
240         DBGC ( tcp, "TCP %p bound to port %d\n", tcp, port );
241         return 0;
242 }
243
244 /**
245  * Open a TCP connection
246  *
247  * @v xfer              Data transfer interface
248  * @v peer              Peer socket address
249  * @v local             Local socket address, or NULL
250  * @ret rc              Return status code
251  */
252 static int tcp_open ( struct xfer_interface *xfer, struct sockaddr *peer,
253                       struct sockaddr *local ) {
254         struct sockaddr_tcpip *st_peer = ( struct sockaddr_tcpip * ) peer;
255         struct sockaddr_tcpip *st_local = ( struct sockaddr_tcpip * ) local;
256         struct tcp_connection *tcp;
257         unsigned int bind_port;
258         int rc;
259
260         /* Allocate and initialise structure */
261         tcp = zalloc ( sizeof ( *tcp ) );
262         if ( ! tcp )
263                 return -ENOMEM;
264         DBGC ( tcp, "TCP %p allocated\n", tcp );
265         ref_init ( &tcp->refcnt, NULL );
266         xfer_init ( &tcp->xfer, &tcp_xfer_operations, &tcp->refcnt );
267         timer_init ( &tcp->timer, tcp_expired );
268         timer_init ( &tcp->wait, tcp_wait_expired );
269         tcp->prev_tcp_state = TCP_CLOSED;
270         tcp->tcp_state = TCP_STATE_SENT ( TCP_SYN );
271         tcp_dump_state ( tcp );
272         tcp->snd_seq = random();
273         INIT_LIST_HEAD ( &tcp->tx_queue );
274         INIT_LIST_HEAD ( &tcp->rx_queue );
275         memcpy ( &tcp->peer, st_peer, sizeof ( tcp->peer ) );
276
277         /* Bind to local port */
278         bind_port = ( st_local ? ntohs ( st_local->st_port ) : 0 );
279         if ( ( rc = tcp_bind ( tcp, bind_port ) ) != 0 )
280                 goto err;
281
282         /* Start timer to initiate SYN */
283         start_timer_nodelay ( &tcp->timer );
284
285         /* Attach parent interface, transfer reference to connection
286          * list and return
287          */
288         xfer_plug_plug ( &tcp->xfer, xfer );
289         list_add ( &tcp->list, &tcp_conns );
290         return 0;
291
292  err:
293         ref_put ( &tcp->refcnt );
294         return rc;
295 }
296
297 /**
298  * Close TCP connection
299  *
300  * @v tcp               TCP connection
301  * @v rc                Reason for close
302  *
303  * Closes the data transfer interface.  If the TCP state machine is in
304  * a suitable state, the connection will be deleted.
305  */
306 static void tcp_close ( struct tcp_connection *tcp, int rc ) {
307         struct io_buffer *iobuf;
308         struct io_buffer *tmp;
309
310         /* Close data transfer interface */
311         xfer_nullify ( &tcp->xfer );
312         xfer_close ( &tcp->xfer, rc );
313         tcp->flags |= TCP_XFER_CLOSED;
314
315         /* If we are in CLOSED, or have otherwise not yet received a
316          * SYN (i.e. we are in LISTEN or SYN_SENT), just delete the
317          * connection.
318          */
319         if ( ! ( tcp->tcp_state & TCP_STATE_RCVD ( TCP_SYN ) ) ) {
320
321                 /* Transition to CLOSED for the sake of debugging messages */
322                 tcp->tcp_state = TCP_CLOSED;
323                 tcp_dump_state ( tcp );
324
325                 /* Free any unprocessed I/O buffers */
326                 list_for_each_entry_safe ( iobuf, tmp, &tcp->rx_queue, list ) {
327                         list_del ( &iobuf->list );
328                         free_iob ( iobuf );
329                 }
330
331                 /* Free any unsent I/O buffers */
332                 list_for_each_entry_safe ( iobuf, tmp, &tcp->tx_queue, list ) {
333                         list_del ( &iobuf->list );
334                         free_iob ( iobuf );
335                 }
336
337                 /* Remove from list and drop reference */
338                 stop_timer ( &tcp->timer );
339                 list_del ( &tcp->list );
340                 ref_put ( &tcp->refcnt );
341                 DBGC ( tcp, "TCP %p connection deleted\n", tcp );
342                 return;
343         }
344
345         /* If we have not had our SYN acknowledged (i.e. we are in
346          * SYN_RCVD), pretend that it has been acknowledged so that we
347          * can send a FIN without breaking things.
348          */
349         if ( ! ( tcp->tcp_state & TCP_STATE_ACKED ( TCP_SYN ) ) )
350                 tcp_rx_ack ( tcp, ( tcp->snd_seq + 1 ), 0 );
351
352         /* If we have no data remaining to send, start sending FIN */
353         if ( list_empty ( &tcp->tx_queue ) ) {
354                 tcp->tcp_state |= TCP_STATE_SENT ( TCP_FIN );
355                 tcp_dump_state ( tcp );
356         }
357 }
358
359 /***************************************************************************
360  *
361  * Transmit data path
362  *
363  ***************************************************************************
364  */
365
366 /**
367  * Calculate transmission window
368  *
369  * @v tcp               TCP connection
370  * @ret len             Maximum length that can be sent in a single packet
371  */
372 static size_t tcp_xmit_win ( struct tcp_connection *tcp ) {
373         size_t len;
374
375         /* Not ready if we're not in a suitable connection state */
376         if ( ! TCP_CAN_SEND_DATA ( tcp->tcp_state ) )
377                 return 0;
378
379         /* Length is the minimum of the receiver's window and the path MTU */
380         len = tcp->snd_win;
381         if ( len > TCP_PATH_MTU )
382                 len = TCP_PATH_MTU;
383
384         return len;
385 }
386
387 /**
388  * Process TCP transmit queue
389  *
390  * @v tcp               TCP connection
391  * @v max_len           Maximum length to process
392  * @v dest              I/O buffer to fill with data, or NULL
393  * @v remove            Remove data from queue
394  * @ret len             Length of data processed
395  *
396  * This processes at most @c max_len bytes from the TCP connection's
397  * transmit queue.  Data will be copied into the @c dest I/O buffer
398  * (if provided) and, if @c remove is true, removed from the transmit
399  * queue.
400  */
401 static size_t tcp_process_tx_queue ( struct tcp_connection *tcp, size_t max_len,
402                                      struct io_buffer *dest, int remove ) {
403         struct io_buffer *iobuf;
404         struct io_buffer *tmp;
405         size_t frag_len;
406         size_t len = 0;
407
408         list_for_each_entry_safe ( iobuf, tmp, &tcp->tx_queue, list ) {
409                 frag_len = iob_len ( iobuf );
410                 if ( frag_len > max_len )
411                         frag_len = max_len;
412                 if ( dest ) {
413                         memcpy ( iob_put ( dest, frag_len ), iobuf->data,
414                                  frag_len );
415                 }
416                 if ( remove ) {
417                         iob_pull ( iobuf, frag_len );
418                         if ( ! iob_len ( iobuf ) ) {
419                                 list_del ( &iobuf->list );
420                                 free_iob ( iobuf );
421                         }
422                 }
423                 len += frag_len;
424                 max_len -= frag_len;
425         }
426         return len;
427 }
428
429 /**
430  * Transmit any outstanding data
431  *
432  * @v tcp               TCP connection
433  * 
434  * Transmits any outstanding data on the connection.
435  *
436  * Note that even if an error is returned, the retransmission timer
437  * will have been started if necessary, and so the stack will
438  * eventually attempt to retransmit the failed packet.
439  */
440 static int tcp_xmit ( struct tcp_connection *tcp ) {
441         struct io_buffer *iobuf;
442         struct tcp_header *tcphdr;
443         struct tcp_mss_option *mssopt;
444         struct tcp_timestamp_padded_option *tsopt;
445         void *payload;
446         unsigned int flags;
447         size_t len = 0;
448         uint32_t seq_len;
449         uint32_t app_win;
450         uint32_t max_rcv_win;
451         int rc;
452
453         /* If retransmission timer is already running, do nothing */
454         if ( timer_running ( &tcp->timer ) )
455                 return 0;
456
457         /* Calculate both the actual (payload) and sequence space
458          * lengths that we wish to transmit.
459          */
460         if ( TCP_CAN_SEND_DATA ( tcp->tcp_state ) ) {
461                 len = tcp_process_tx_queue ( tcp, tcp_xmit_win ( tcp ),
462                                              NULL, 0 );
463         }
464         seq_len = len;
465         flags = TCP_FLAGS_SENDING ( tcp->tcp_state );
466         if ( flags & ( TCP_SYN | TCP_FIN ) ) {
467                 /* SYN or FIN consume one byte, and we can never send both */
468                 assert ( ! ( ( flags & TCP_SYN ) && ( flags & TCP_FIN ) ) );
469                 seq_len++;
470         }
471         tcp->snd_sent = seq_len;
472
473         /* If we have nothing to transmit, stop now */
474         if ( ( seq_len == 0 ) && ! ( tcp->flags & TCP_ACK_PENDING ) )
475                 return 0;
476
477         /* If we are transmitting anything that requires
478          * acknowledgement (i.e. consumes sequence space), start the
479          * retransmission timer.  Do this before attempting to
480          * allocate the I/O buffer, in case allocation itself fails.
481          */
482         if ( seq_len )
483                 start_timer ( &tcp->timer );
484
485         /* Allocate I/O buffer */
486         iobuf = alloc_iob ( len + MAX_HDR_LEN );
487         if ( ! iobuf ) {
488                 DBGC ( tcp, "TCP %p could not allocate iobuf for %08x..%08x "
489                        "%08x\n", tcp, tcp->snd_seq, ( tcp->snd_seq + seq_len ),
490                        tcp->rcv_ack );
491                 return -ENOMEM;
492         }
493         iob_reserve ( iobuf, MAX_HDR_LEN );
494
495         /* Fill data payload from transmit queue */
496         tcp_process_tx_queue ( tcp, len, iobuf, 0 );
497
498         /* Expand receive window if possible */
499         max_rcv_win = ( ( freemem * 3 ) / 4 );
500         if ( max_rcv_win > TCP_MAX_WINDOW_SIZE )
501                 max_rcv_win = TCP_MAX_WINDOW_SIZE;
502         app_win = xfer_window ( &tcp->xfer );
503         if ( max_rcv_win > app_win )
504                 max_rcv_win = app_win;
505         max_rcv_win &= ~0x03; /* Keep everything dword-aligned */
506         if ( tcp->rcv_win < max_rcv_win )
507                 tcp->rcv_win = max_rcv_win;
508
509         /* Fill up the TCP header */
510         payload = iobuf->data;
511         if ( flags & TCP_SYN ) {
512                 mssopt = iob_push ( iobuf, sizeof ( *mssopt ) );
513                 mssopt->kind = TCP_OPTION_MSS;
514                 mssopt->length = sizeof ( *mssopt );
515                 mssopt->mss = htons ( TCP_MSS );
516         }
517         if ( ( flags & TCP_SYN ) || ( tcp->flags & TCP_TS_ENABLED ) ) {
518                 tsopt = iob_push ( iobuf, sizeof ( *tsopt ) );
519                 memset ( tsopt->nop, TCP_OPTION_NOP, sizeof ( tsopt->nop ) );
520                 tsopt->tsopt.kind = TCP_OPTION_TS;
521                 tsopt->tsopt.length = sizeof ( tsopt->tsopt );
522                 tsopt->tsopt.tsval = htonl ( currticks() );
523                 tsopt->tsopt.tsecr = htonl ( tcp->ts_recent );
524         }
525         if ( ! ( flags & TCP_SYN ) )
526                 flags |= TCP_PSH;
527         tcphdr = iob_push ( iobuf, sizeof ( *tcphdr ) );
528         memset ( tcphdr, 0, sizeof ( *tcphdr ) );
529         tcphdr->src = htons ( tcp->local_port );
530         tcphdr->dest = tcp->peer.st_port;
531         tcphdr->seq = htonl ( tcp->snd_seq );
532         tcphdr->ack = htonl ( tcp->rcv_ack );
533         tcphdr->hlen = ( ( payload - iobuf->data ) << 2 );
534         tcphdr->flags = flags;
535         tcphdr->win = htons ( tcp->rcv_win );
536         tcphdr->csum = tcpip_chksum ( iobuf->data, iob_len ( iobuf ) );
537
538         /* Dump header */
539         DBGC2 ( tcp, "TCP %p TX %d->%d %08x..%08x           %08x %4zd",
540                 tcp, ntohs ( tcphdr->src ), ntohs ( tcphdr->dest ),
541                 ntohl ( tcphdr->seq ), ( ntohl ( tcphdr->seq ) + seq_len ),
542                 ntohl ( tcphdr->ack ), len );
543         tcp_dump_flags ( tcp, tcphdr->flags );
544         DBGC2 ( tcp, "\n" );
545
546         /* Transmit packet */
547         if ( ( rc = tcpip_tx ( iobuf, &tcp_protocol, NULL, &tcp->peer, NULL,
548                                &tcphdr->csum ) ) != 0 ) {
549                 DBGC ( tcp, "TCP %p could not transmit %08x..%08x %08x: %s\n",
550                        tcp, tcp->snd_seq, ( tcp->snd_seq + tcp->snd_sent ),
551                        tcp->rcv_ack, strerror ( rc ) );
552                 return rc;
553         }
554
555         /* Clear ACK-pending flag */
556         tcp->flags &= ~TCP_ACK_PENDING;
557
558         return 0;
559 }
560
561 /**
562  * Retransmission timer expired
563  *
564  * @v timer             Retransmission timer
565  * @v over              Failure indicator
566  */
567 static void tcp_expired ( struct retry_timer *timer, int over ) {
568         struct tcp_connection *tcp =
569                 container_of ( timer, struct tcp_connection, timer );
570
571         DBGC ( tcp, "TCP %p timer %s in %s for %08x..%08x %08x\n", tcp,
572                ( over ? "expired" : "fired" ), tcp_state ( tcp->tcp_state ),
573                tcp->snd_seq, ( tcp->snd_seq + tcp->snd_sent ), tcp->rcv_ack );
574
575         assert ( ( tcp->tcp_state == TCP_SYN_SENT ) ||
576                  ( tcp->tcp_state == TCP_SYN_RCVD ) ||
577                  ( tcp->tcp_state == TCP_ESTABLISHED ) ||
578                  ( tcp->tcp_state == TCP_FIN_WAIT_1 ) ||
579                  ( tcp->tcp_state == TCP_CLOSE_WAIT ) ||
580                  ( tcp->tcp_state == TCP_CLOSING_OR_LAST_ACK ) );
581
582         if ( over ) {
583                 /* If we have finally timed out and given up,
584                  * terminate the connection
585                  */
586                 tcp->tcp_state = TCP_CLOSED;
587                 tcp_dump_state ( tcp );
588                 tcp_close ( tcp, -ETIMEDOUT );
589         } else {
590                 /* Otherwise, retransmit the packet */
591                 tcp_xmit ( tcp );
592         }
593 }
594
595 /**
596  * Shutdown timer expired
597  *
598  * @v timer             Shutdown timer
599  * @v over              Failure indicator
600  */
601 static void tcp_wait_expired ( struct retry_timer *timer, int over __unused ) {
602         struct tcp_connection *tcp =
603                 container_of ( timer, struct tcp_connection, wait );
604
605         assert ( tcp->tcp_state == TCP_TIME_WAIT );
606
607         DBGC ( tcp, "TCP %p wait complete in %s for %08x..%08x %08x\n", tcp,
608                tcp_state ( tcp->tcp_state ), tcp->snd_seq,
609                ( tcp->snd_seq + tcp->snd_sent ), tcp->rcv_ack );
610
611         tcp->tcp_state = TCP_CLOSED;
612         tcp_dump_state ( tcp );
613         tcp_close ( tcp, 0 );
614 }
615
616 /**
617  * Send RST response to incoming packet
618  *
619  * @v in_tcphdr         TCP header of incoming packet
620  * @ret rc              Return status code
621  */
622 static int tcp_xmit_reset ( struct tcp_connection *tcp,
623                             struct sockaddr_tcpip *st_dest,
624                             struct tcp_header *in_tcphdr ) {
625         struct io_buffer *iobuf;
626         struct tcp_header *tcphdr;
627         int rc;
628
629         /* Allocate space for dataless TX buffer */
630         iobuf = alloc_iob ( MAX_HDR_LEN );
631         if ( ! iobuf ) {
632                 DBGC ( tcp, "TCP %p could not allocate iobuf for RST "
633                        "%08x..%08x %08x\n", tcp, ntohl ( in_tcphdr->ack ),
634                        ntohl ( in_tcphdr->ack ), ntohl ( in_tcphdr->seq ) );
635                 return -ENOMEM;
636         }
637         iob_reserve ( iobuf, MAX_HDR_LEN );
638
639         /* Construct RST response */
640         tcphdr = iob_push ( iobuf, sizeof ( *tcphdr ) );
641         memset ( tcphdr, 0, sizeof ( *tcphdr ) );
642         tcphdr->src = in_tcphdr->dest;
643         tcphdr->dest = in_tcphdr->src;
644         tcphdr->seq = in_tcphdr->ack;
645         tcphdr->ack = in_tcphdr->seq;
646         tcphdr->hlen = ( ( sizeof ( *tcphdr ) / 4 ) << 4 );
647         tcphdr->flags = ( TCP_RST | TCP_ACK );
648         tcphdr->win = htons ( TCP_MAX_WINDOW_SIZE );
649         tcphdr->csum = tcpip_chksum ( iobuf->data, iob_len ( iobuf ) );
650
651         /* Dump header */
652         DBGC2 ( tcp, "TCP %p TX %d->%d %08x..%08x           %08x %4d",
653                 tcp, ntohs ( tcphdr->src ), ntohs ( tcphdr->dest ),
654                 ntohl ( tcphdr->seq ), ( ntohl ( tcphdr->seq ) ),
655                 ntohl ( tcphdr->ack ), 0 );
656         tcp_dump_flags ( tcp, tcphdr->flags );
657         DBGC2 ( tcp, "\n" );
658
659         /* Transmit packet */
660         if ( ( rc = tcpip_tx ( iobuf, &tcp_protocol, NULL, st_dest,
661                                NULL, &tcphdr->csum ) ) != 0 ) {
662                 DBGC ( tcp, "TCP %p could not transmit RST %08x..%08x %08x: "
663                        "%s\n", tcp, ntohl ( in_tcphdr->ack ),
664                        ntohl ( in_tcphdr->ack ), ntohl ( in_tcphdr->seq ),
665                        strerror ( rc ) );
666                 return rc;
667         }
668
669         return 0;
670 }
671
672 /***************************************************************************
673  *
674  * Receive data path
675  *
676  ***************************************************************************
677  */
678
679 /**
680  * Identify TCP connection by local port number
681  *
682  * @v local_port        Local port
683  * @ret tcp             TCP connection, or NULL
684  */
685 static struct tcp_connection * tcp_demux ( unsigned int local_port ) {
686         struct tcp_connection *tcp;
687
688         list_for_each_entry ( tcp, &tcp_conns, list ) {
689                 if ( tcp->local_port == local_port )
690                         return tcp;
691         }
692         return NULL;
693 }
694
695 /**
696  * Parse TCP received options
697  *
698  * @v tcp               TCP connection
699  * @v data              Raw options data
700  * @v len               Raw options length
701  * @v options           Options structure to fill in
702  */
703 static void tcp_rx_opts ( struct tcp_connection *tcp, const void *data,
704                           size_t len, struct tcp_options *options ) {
705         const void *end = ( data + len );
706         const struct tcp_option *option;
707         unsigned int kind;
708
709         memset ( options, 0, sizeof ( *options ) );
710         while ( data < end ) {
711                 option = data;
712                 kind = option->kind;
713                 if ( kind == TCP_OPTION_END )
714                         return;
715                 if ( kind == TCP_OPTION_NOP ) {
716                         data++;
717                         continue;
718                 }
719                 switch ( kind ) {
720                 case TCP_OPTION_MSS:
721                         options->mssopt = data;
722                         break;
723                 case TCP_OPTION_TS:
724                         options->tsopt = data;
725                         break;
726                 default:
727                         DBGC ( tcp, "TCP %p received unknown option %d\n",
728                                tcp, kind );
729                         break;
730                 }
731                 data += option->length;
732         }
733 }
734
735 /**
736  * Consume received sequence space
737  *
738  * @v tcp               TCP connection
739  * @v seq_len           Sequence space length to consume
740  */
741 static void tcp_rx_seq ( struct tcp_connection *tcp, uint32_t seq_len ) {
742         tcp->rcv_ack += seq_len;
743         if ( tcp->rcv_win > seq_len ) {
744                 tcp->rcv_win -= seq_len;
745         } else {
746                 tcp->rcv_win = 0;
747         }
748         tcp->flags |= TCP_ACK_PENDING;
749 }
750
751 /**
752  * Handle TCP received SYN
753  *
754  * @v tcp               TCP connection
755  * @v seq               SEQ value (in host-endian order)
756  * @v options           TCP options
757  * @ret rc              Return status code
758  */
759 static int tcp_rx_syn ( struct tcp_connection *tcp, uint32_t seq,
760                         struct tcp_options *options ) {
761
762         /* Synchronise sequence numbers on first SYN */
763         if ( ! ( tcp->tcp_state & TCP_STATE_RCVD ( TCP_SYN ) ) ) {
764                 tcp->rcv_ack = seq;
765                 if ( options->tsopt )
766                         tcp->flags |= TCP_TS_ENABLED;
767         }
768
769         /* Ignore duplicate SYN */
770         if ( seq != tcp->rcv_ack )
771                 return 0;
772
773         /* Acknowledge SYN */
774         tcp_rx_seq ( tcp, 1 );
775
776         /* Mark SYN as received and start sending ACKs with each packet */
777         tcp->tcp_state |= ( TCP_STATE_SENT ( TCP_ACK ) |
778                             TCP_STATE_RCVD ( TCP_SYN ) );
779
780         return 0;
781 }
782
783 /**
784  * Handle TCP received ACK
785  *
786  * @v tcp               TCP connection
787  * @v ack               ACK value (in host-endian order)
788  * @v win               WIN value (in host-endian order)
789  * @ret rc              Return status code
790  */
791 static int tcp_rx_ack ( struct tcp_connection *tcp, uint32_t ack,
792                         uint32_t win ) {
793         uint32_t ack_len = ( ack - tcp->snd_seq );
794         size_t len;
795         unsigned int acked_flags;
796
797         /* Check for out-of-range or old duplicate ACKs */
798         if ( ack_len > tcp->snd_sent ) {
799                 DBGC ( tcp, "TCP %p received ACK for %08x..%08x, "
800                        "sent only %08x..%08x\n", tcp, tcp->snd_seq,
801                        ( tcp->snd_seq + ack_len ), tcp->snd_seq,
802                        ( tcp->snd_seq + tcp->snd_sent ) );
803
804                 if ( TCP_HAS_BEEN_ESTABLISHED ( tcp->tcp_state ) ) {
805                         /* Just ignore what might be old duplicate ACKs */
806                         return 0;
807                 } else {
808                         /* Send RST if an out-of-range ACK is received
809                          * on a not-yet-established connection, as per
810                          * RFC 793.
811                          */
812                         return -EINVAL;
813                 }
814         }
815
816         /* Ignore ACKs that don't actually acknowledge any new data.
817          * (In particular, do not stop the retransmission timer; this
818          * avoids creating a sorceror's apprentice syndrome when a
819          * duplicate ACK is received and we still have data in our
820          * transmit queue.)
821          */
822         if ( ack_len == 0 )
823                 return 0;
824
825         /* Stop the retransmission timer */
826         stop_timer ( &tcp->timer );
827
828         /* Determine acknowledged flags and data length */
829         len = ack_len;
830         acked_flags = ( TCP_FLAGS_SENDING ( tcp->tcp_state ) &
831                         ( TCP_SYN | TCP_FIN ) );
832         if ( acked_flags )
833                 len--;
834
835         /* Update SEQ and sent counters, and window size */
836         tcp->snd_seq = ack;
837         tcp->snd_sent = 0;
838         tcp->snd_win = win;
839
840         /* Remove any acknowledged data from transmit queue */
841         tcp_process_tx_queue ( tcp, len, NULL, 1 );
842                 
843         /* Mark SYN/FIN as acknowledged if applicable. */
844         if ( acked_flags )
845                 tcp->tcp_state |= TCP_STATE_ACKED ( acked_flags );
846
847         /* Start sending FIN if we've had all possible data ACKed */
848         if ( list_empty ( &tcp->tx_queue ) && ( tcp->flags & TCP_XFER_CLOSED ) )
849                 tcp->tcp_state |= TCP_STATE_SENT ( TCP_FIN );
850
851         return 0;
852 }
853
854 /**
855  * Handle TCP received data
856  *
857  * @v tcp               TCP connection
858  * @v seq               SEQ value (in host-endian order)
859  * @v iobuf             I/O buffer
860  * @ret rc              Return status code
861  *
862  * This function takes ownership of the I/O buffer.
863  */
864 static int tcp_rx_data ( struct tcp_connection *tcp, uint32_t seq,
865                          struct io_buffer *iobuf ) {
866         uint32_t already_rcvd;
867         uint32_t len;
868         int rc;
869
870         /* Ignore duplicate or out-of-order data */
871         already_rcvd = ( tcp->rcv_ack - seq );
872         len = iob_len ( iobuf );
873         if ( already_rcvd >= len ) {
874                 free_iob ( iobuf );
875                 return 0;
876         }
877         iob_pull ( iobuf, already_rcvd );
878         len -= already_rcvd;
879
880         /* Acknowledge new data */
881         tcp_rx_seq ( tcp, len );
882
883         /* Deliver data to application */
884         if ( ( rc = xfer_deliver_iob ( &tcp->xfer, iobuf ) ) != 0 ) {
885                 DBGC ( tcp, "TCP %p could not deliver %08x..%08x: %s\n",
886                        tcp, seq, ( seq + len ), strerror ( rc ) );
887                 return rc;
888         }
889
890         return 0;
891 }
892
893 /**
894  * Handle TCP received FIN
895  *
896  * @v tcp               TCP connection
897  * @v seq               SEQ value (in host-endian order)
898  * @ret rc              Return status code
899  */
900 static int tcp_rx_fin ( struct tcp_connection *tcp, uint32_t seq ) {
901
902         /* Ignore duplicate or out-of-order FIN */
903         if ( seq != tcp->rcv_ack )
904                 return 0;
905
906         /* Acknowledge FIN */
907         tcp_rx_seq ( tcp, 1 );
908
909         /* Mark FIN as received */
910         tcp->tcp_state |= TCP_STATE_RCVD ( TCP_FIN );
911
912         /* Close connection */
913         tcp_close ( tcp, 0 );
914
915         return 0;
916 }
917
918 /**
919  * Handle TCP received RST
920  *
921  * @v tcp               TCP connection
922  * @v seq               SEQ value (in host-endian order)
923  * @ret rc              Return status code
924  */
925 static int tcp_rx_rst ( struct tcp_connection *tcp, uint32_t seq ) {
926
927         /* Accept RST only if it falls within the window.  If we have
928          * not yet received a SYN, then we have no window to test
929          * against, so fall back to checking that our SYN has been
930          * ACKed.
931          */
932         if ( tcp->tcp_state & TCP_STATE_RCVD ( TCP_SYN ) ) {
933                 if ( ! tcp_in_window ( seq, tcp->rcv_ack, tcp->rcv_win ) )
934                         return 0;
935         } else {
936                 if ( ! ( tcp->tcp_state & TCP_STATE_ACKED ( TCP_SYN ) ) )
937                         return 0;
938         }
939
940         /* Abort connection */
941         tcp->tcp_state = TCP_CLOSED;
942         tcp_dump_state ( tcp );
943         tcp_close ( tcp, -ECONNRESET );
944
945         DBGC ( tcp, "TCP %p connection reset by peer\n", tcp );
946         return -ECONNRESET;
947 }
948
949 /**
950  * Enqueue received TCP packet
951  *
952  * @v tcp               TCP connection
953  * @v seq               SEQ value (in host-endian order)
954  * @v flags             TCP flags
955  * @v iobuf             I/O buffer
956  */
957 static void tcp_rx_enqueue ( struct tcp_connection *tcp, uint32_t seq,
958                              uint8_t flags, struct io_buffer *iobuf ) {
959         struct tcp_rx_queued_header *tcpqhdr;
960         struct io_buffer *queued;
961         size_t len;
962         uint32_t seq_len;
963
964         /* Calculate remaining flags and sequence length.  Note that
965          * SYN, if present, has already been processed by this point.
966          */
967         flags &= TCP_FIN;
968         len = iob_len ( iobuf );
969         seq_len = ( len + ( flags ? 1 : 0 ) );
970
971         /* Discard immediately (to save memory) if:
972          *
973          * a) we have not yet received a SYN (and so have no defined
974          *    receive window), or
975          * b) the packet lies entirely outside the receive window, or
976          * c) there is no further content to process.
977          */
978         if ( ( ! ( tcp->tcp_state & TCP_STATE_RCVD ( TCP_SYN ) ) ) ||
979              ( tcp_cmp ( seq, tcp->rcv_ack + tcp->rcv_win ) >= 0 ) ||
980              ( tcp_cmp ( seq + seq_len, tcp->rcv_ack ) < 0 ) ||
981              ( seq_len == 0 ) ) {
982                 free_iob ( iobuf );
983                 return;
984         }
985
986         /* Add internal header */
987         tcpqhdr = iob_push ( iobuf, sizeof ( *tcpqhdr ) );
988         tcpqhdr->seq = seq;
989         tcpqhdr->flags = flags;
990
991         /* Add to RX queue */
992         list_for_each_entry ( queued, &tcp->rx_queue, list ) {
993                 tcpqhdr = queued->data;
994                 if ( tcp_cmp ( seq, tcpqhdr->seq ) < 0 )
995                         break;
996         }
997         list_add_tail ( &iobuf->list, &queued->list );
998 }
999
1000 /**
1001  * Process receive queue
1002  *
1003  * @v tcp               TCP connection
1004  */
1005 static void tcp_process_rx_queue ( struct tcp_connection *tcp ) {
1006         struct io_buffer *iobuf;
1007         struct tcp_rx_queued_header *tcpqhdr;
1008         uint32_t seq;
1009         unsigned int flags;
1010         size_t len;
1011
1012         /* Process all applicable received buffers.  Note that we
1013          * cannot use list_for_each_entry() to iterate over the RX
1014          * queue, since tcp_discard() may remove packets from the RX
1015          * queue while we are processing.
1016          */
1017         while ( ! list_empty ( &tcp->rx_queue ) ) {
1018                 list_for_each_entry ( iobuf, &tcp->rx_queue, list )
1019                         break;
1020
1021                 /* Stop processing when we hit the first gap */
1022                 tcpqhdr = iobuf->data;
1023                 if ( tcp_cmp ( tcpqhdr->seq, tcp->rcv_ack ) > 0 )
1024                         break;
1025
1026                 /* Strip internal header and remove from RX queue */
1027                 list_del ( &iobuf->list );
1028                 seq = tcpqhdr->seq;
1029                 flags = tcpqhdr->flags;
1030                 iob_pull ( iobuf, sizeof ( *tcpqhdr ) );
1031                 len = iob_len ( iobuf );
1032
1033                 /* Handle new data, if any */
1034                 tcp_rx_data ( tcp, seq, iob_disown ( iobuf ) );
1035                 seq += len;
1036
1037                 /* Handle FIN, if present */
1038                 if ( flags & TCP_FIN ) {
1039                         tcp_rx_fin ( tcp, seq );
1040                         seq++;
1041                 }
1042         }
1043 }
1044
1045 /**
1046  * Process received packet
1047  *
1048  * @v iobuf             I/O buffer
1049  * @v st_src            Partially-filled source address
1050  * @v st_dest           Partially-filled destination address
1051  * @v pshdr_csum        Pseudo-header checksum
1052  * @ret rc              Return status code
1053   */
1054 static int tcp_rx ( struct io_buffer *iobuf,
1055                     struct sockaddr_tcpip *st_src,
1056                     struct sockaddr_tcpip *st_dest __unused,
1057                     uint16_t pshdr_csum ) {
1058         struct tcp_header *tcphdr = iobuf->data;
1059         struct tcp_connection *tcp;
1060         struct tcp_options options;
1061         size_t hlen;
1062         uint16_t csum;
1063         uint32_t seq;
1064         uint32_t ack;
1065         uint32_t win;
1066         unsigned int flags;
1067         size_t len;
1068         uint32_t seq_len;
1069         int rc;
1070
1071         /* Sanity check packet */
1072         if ( iob_len ( iobuf ) < sizeof ( *tcphdr ) ) {
1073                 DBG ( "TCP packet too short at %zd bytes (min %zd bytes)\n",
1074                       iob_len ( iobuf ), sizeof ( *tcphdr ) );
1075                 rc = -EINVAL;
1076                 goto discard;
1077         }
1078         hlen = ( ( tcphdr->hlen & TCP_MASK_HLEN ) / 16 ) * 4;
1079         if ( hlen < sizeof ( *tcphdr ) ) {
1080                 DBG ( "TCP header too short at %zd bytes (min %zd bytes)\n",
1081                       hlen, sizeof ( *tcphdr ) );
1082                 rc = -EINVAL;
1083                 goto discard;
1084         }
1085         if ( hlen > iob_len ( iobuf ) ) {
1086                 DBG ( "TCP header too long at %zd bytes (max %zd bytes)\n",
1087                       hlen, iob_len ( iobuf ) );
1088                 rc = -EINVAL;
1089                 goto discard;
1090         }
1091         csum = tcpip_continue_chksum ( pshdr_csum, iobuf->data,
1092                                        iob_len ( iobuf ) );
1093         if ( csum != 0 ) {
1094                 DBG ( "TCP checksum incorrect (is %04x including checksum "
1095                       "field, should be 0000)\n", csum );
1096                 rc = -EINVAL;
1097                 goto discard;
1098         }
1099         
1100         /* Parse parameters from header and strip header */
1101         tcp = tcp_demux ( ntohs ( tcphdr->dest ) );
1102         seq = ntohl ( tcphdr->seq );
1103         ack = ntohl ( tcphdr->ack );
1104         win = ntohs ( tcphdr->win );
1105         flags = tcphdr->flags;
1106         tcp_rx_opts ( tcp, ( ( ( void * ) tcphdr ) + sizeof ( *tcphdr ) ),
1107                       ( hlen - sizeof ( *tcphdr ) ), &options );
1108         iob_pull ( iobuf, hlen );
1109         len = iob_len ( iobuf );
1110         seq_len = ( len + ( ( flags & TCP_SYN ) ? 1 : 0 ) +
1111                     ( ( flags & TCP_FIN ) ? 1 : 0 ) );
1112
1113         /* Dump header */
1114         DBGC2 ( tcp, "TCP %p RX %d<-%d           %08x %08x..%08x %4zd",
1115                 tcp, ntohs ( tcphdr->dest ), ntohs ( tcphdr->src ),
1116                 ntohl ( tcphdr->ack ), ntohl ( tcphdr->seq ),
1117                 ( ntohl ( tcphdr->seq ) + seq_len ), len );
1118         tcp_dump_flags ( tcp, tcphdr->flags );
1119         DBGC2 ( tcp, "\n" );
1120
1121         /* If no connection was found, send RST */
1122         if ( ! tcp ) {
1123                 tcp_xmit_reset ( tcp, st_src, tcphdr );
1124                 rc = -ENOTCONN;
1125                 goto discard;
1126         }
1127
1128         /* Update timestamp, if applicable */
1129         if ( options.tsopt && tcp_in_window ( tcp->rcv_ack, seq, seq_len ) )
1130                 tcp->ts_recent = ntohl ( options.tsopt->tsval );
1131
1132         /* Handle ACK, if present */
1133         if ( flags & TCP_ACK ) {
1134                 if ( ( rc = tcp_rx_ack ( tcp, ack, win ) ) != 0 ) {
1135                         tcp_xmit_reset ( tcp, st_src, tcphdr );
1136                         goto discard;
1137                 }
1138         }
1139
1140         /* Force an ACK if this packet is out of order */
1141         if ( ( tcp->tcp_state & TCP_STATE_RCVD ( TCP_SYN ) ) &&
1142              ( seq != tcp->rcv_ack ) ) {
1143                 tcp->flags |= TCP_ACK_PENDING;
1144         }
1145
1146         /* Handle SYN, if present */
1147         if ( flags & TCP_SYN ) {
1148                 tcp_rx_syn ( tcp, seq, &options );
1149                 seq++;
1150         }
1151
1152         /* Handle RST, if present */
1153         if ( flags & TCP_RST ) {
1154                 if ( ( rc = tcp_rx_rst ( tcp, seq ) ) != 0 )
1155                         goto discard;
1156         }
1157
1158         /* Enqueue received data */
1159         tcp_rx_enqueue ( tcp, seq, flags, iob_disown ( iobuf ) );
1160
1161         /* Process receive queue */
1162         tcp_process_rx_queue ( tcp );
1163
1164         /* Dump out any state change as a result of the received packet */
1165         tcp_dump_state ( tcp );
1166
1167         /* Send out any pending data */
1168         tcp_xmit ( tcp );
1169
1170         /* If this packet was the last we expect to receive, set up
1171          * timer to expire and cause the connection to be freed.
1172          */
1173         if ( TCP_CLOSED_GRACEFULLY ( tcp->tcp_state ) ) {
1174                 stop_timer ( &tcp->wait );
1175                 start_timer_fixed ( &tcp->wait, ( 2 * TCP_MSL ) );
1176         }
1177
1178         return 0;
1179
1180  discard:
1181         /* Free received packet */
1182         free_iob ( iobuf );
1183         return rc;
1184 }
1185
1186 /** TCP protocol */
1187 struct tcpip_protocol tcp_protocol __tcpip_protocol = {
1188         .name = "TCP",
1189         .rx = tcp_rx,
1190         .tcpip_proto = IP_TCP,
1191 };
1192
1193 /**
1194  * Discard some cached TCP data
1195  *
1196  * @ret discarded       Number of cached items discarded
1197  */
1198 static unsigned int tcp_discard ( void ) {
1199         struct tcp_connection *tcp;
1200         struct io_buffer *iobuf;
1201         unsigned int discarded = 0;
1202
1203         /* Try to drop one queued RX packet from each connection */
1204         list_for_each_entry ( tcp, &tcp_conns, list ) {
1205                 list_for_each_entry_reverse ( iobuf, &tcp->rx_queue, list ) {
1206                         list_del ( &iobuf->list );
1207                         free_iob ( iobuf );
1208                         discarded++;
1209                         break;
1210                 }
1211         }
1212
1213         return discarded;
1214 }
1215
1216 /** TCP cache discarder */
1217 struct cache_discarder tcp_cache_discarder __cache_discarder = {
1218         .discard = tcp_discard,
1219 };
1220
1221 /***************************************************************************
1222  *
1223  * Data transfer interface
1224  *
1225  ***************************************************************************
1226  */
1227
1228 /**
1229  * Close interface
1230  *
1231  * @v xfer              Data transfer interface
1232  * @v rc                Reason for close
1233  */
1234 static void tcp_xfer_close ( struct xfer_interface *xfer, int rc ) {
1235         struct tcp_connection *tcp =
1236                 container_of ( xfer, struct tcp_connection, xfer );
1237
1238         /* Close data transfer interface */
1239         tcp_close ( tcp, rc );
1240
1241         /* Transmit FIN, if possible */
1242         tcp_xmit ( tcp );
1243 }
1244
1245 /**
1246  * Check flow control window
1247  *
1248  * @v xfer              Data transfer interface
1249  * @ret len             Length of window
1250  */
1251 static size_t tcp_xfer_window ( struct xfer_interface *xfer ) {
1252         struct tcp_connection *tcp =
1253                 container_of ( xfer, struct tcp_connection, xfer );
1254
1255         /* Not ready if data queue is non-empty.  This imposes a limit
1256          * of only one unACKed packet in the TX queue at any time; we
1257          * do this to conserve memory usage.
1258          */
1259         if ( ! list_empty ( &tcp->tx_queue ) )
1260                 return 0;
1261
1262         /* Return TCP window length */
1263         return tcp_xmit_win ( tcp );
1264 }
1265
1266 /**
1267  * Deliver datagram as I/O buffer
1268  *
1269  * @v xfer              Data transfer interface
1270  * @v iobuf             Datagram I/O buffer
1271  * @v meta              Data transfer metadata
1272  * @ret rc              Return status code
1273  */
1274 static int tcp_xfer_deliver_iob ( struct xfer_interface *xfer,
1275                                   struct io_buffer *iobuf,
1276                                   struct xfer_metadata *meta __unused ) {
1277         struct tcp_connection *tcp =
1278                 container_of ( xfer, struct tcp_connection, xfer );
1279
1280         /* Enqueue packet */
1281         list_add_tail ( &iobuf->list, &tcp->tx_queue );
1282
1283         /* Transmit data, if possible */
1284         tcp_xmit ( tcp );
1285
1286         return 0;
1287 }
1288
1289 /** TCP data transfer interface operations */
1290 static struct xfer_interface_operations tcp_xfer_operations = {
1291         .close          = tcp_xfer_close,
1292         .vredirect      = ignore_xfer_vredirect,
1293         .window         = tcp_xfer_window,
1294         .alloc_iob      = default_xfer_alloc_iob,
1295         .deliver_iob    = tcp_xfer_deliver_iob,
1296         .deliver_raw    = xfer_deliver_as_iob,
1297 };
1298
1299 /***************************************************************************
1300  *
1301  * Openers
1302  *
1303  ***************************************************************************
1304  */
1305
1306 /** TCP socket opener */
1307 struct socket_opener tcp_socket_opener __socket_opener = {
1308         .semantics      = TCP_SOCK_STREAM,
1309         .family         = AF_INET,
1310         .open           = tcp_open,
1311 };
1312
1313 /** Linkage hack */
1314 int tcp_sock_stream = TCP_SOCK_STREAM;
1315
1316 /**
1317  * Open TCP URI
1318  *
1319  * @v xfer              Data transfer interface
1320  * @v uri               URI
1321  * @ret rc              Return status code
1322  */
1323 static int tcp_open_uri ( struct xfer_interface *xfer, struct uri *uri ) {
1324         struct sockaddr_tcpip peer;
1325
1326         /* Sanity check */
1327         if ( ! uri->host )
1328                 return -EINVAL;
1329
1330         memset ( &peer, 0, sizeof ( peer ) );
1331         peer.st_port = htons ( uri_port ( uri, 0 ) );
1332         return xfer_open_named_socket ( xfer, SOCK_STREAM,
1333                                         ( struct sockaddr * ) &peer,
1334                                         uri->host, NULL );
1335 }
1336
1337 /** TCP URI opener */
1338 struct uri_opener tcp_uri_opener __uri_opener = {
1339         .scheme         = "tcp",
1340         .open           = tcp_open_uri,
1341 };
1342