82055fcdaae4c865801d832d6f08b5746ee8ed21
[people/cooldavid/gpxe.git] / src / net / udp / tftp.c
1 /*
2  * Copyright (C) 2006 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 FILE_LICENCE ( GPL2_OR_LATER );
20
21 #include <stdint.h>
22 #include <stdlib.h>
23 #include <stdio.h>
24 #include <string.h>
25 #include <strings.h>
26 #include <byteswap.h>
27 #include <errno.h>
28 #include <assert.h>
29 #include <gpxe/refcnt.h>
30 #include <gpxe/xfer.h>
31 #include <gpxe/open.h>
32 #include <gpxe/uri.h>
33 #include <gpxe/tcpip.h>
34 #include <gpxe/retry.h>
35 #include <gpxe/features.h>
36 #include <gpxe/bitmap.h>
37 #include <gpxe/settings.h>
38 #include <gpxe/dhcp.h>
39 #include <gpxe/uri.h>
40 #include <gpxe/tftp.h>
41
42 /** @file
43  *
44  * TFTP protocol
45  *
46  */
47
48 FEATURE ( FEATURE_PROTOCOL, "TFTP", DHCP_EB_FEATURE_TFTP, 1 );
49
50 /* TFTP-specific error codes */
51 #define ETFTP_INVALID_BLKSIZE   EUNIQ_01
52 #define ETFTP_INVALID_TSIZE     EUNIQ_02
53 #define ETFTP_MC_NO_PORT        EUNIQ_03
54 #define ETFTP_MC_NO_MC          EUNIQ_04
55 #define ETFTP_MC_INVALID_MC     EUNIQ_05
56 #define ETFTP_MC_INVALID_IP     EUNIQ_06
57 #define ETFTP_MC_INVALID_PORT   EUNIQ_07
58
59 /**
60  * A TFTP request
61  *
62  * This data structure holds the state for an ongoing TFTP transfer.
63  */
64 struct tftp_request {
65         /** Reference count */
66         struct refcnt refcnt;
67         /** Data transfer interface */
68         struct xfer_interface xfer;
69
70         /** URI being fetched */
71         struct uri *uri;
72         /** Transport layer interface */
73         struct xfer_interface socket;
74         /** Multicast transport layer interface */
75         struct xfer_interface mc_socket;
76
77         /** Data block size
78          *
79          * This is the "blksize" option negotiated with the TFTP
80          * server.  (If the TFTP server does not support TFTP options,
81          * this will default to 512).
82          */
83         unsigned int blksize;
84         /** File size
85          *
86          * This is the value returned in the "tsize" option from the
87          * TFTP server.  If the TFTP server does not support the
88          * "tsize" option, this value will be zero.
89          */
90         unsigned long tsize;
91         
92         /** Server port
93          *
94          * This is the port to which RRQ packets are sent.
95          */
96         unsigned int port;
97         /** Peer address
98          *
99          * The peer address is determined by the first response
100          * received to the TFTP RRQ.
101          */
102         struct sockaddr_tcpip peer;
103         /** Request flags */
104         unsigned int flags;
105         /** MTFTP timeout count */
106         unsigned int mtftp_timeouts;
107
108         /** Block bitmap */
109         struct bitmap bitmap;
110         /** Maximum known length
111          *
112          * We don't always know the file length in advance.  In
113          * particular, if the TFTP server doesn't support the tsize
114          * option, or we are using MTFTP, then we don't know the file
115          * length until we see the end-of-file block (which, in the
116          * case of MTFTP, may not be the last block we see).
117          *
118          * This value is updated whenever we obtain information about
119          * the file length.
120          */
121         size_t filesize;
122         /** Retransmission timer */
123         struct retry_timer timer;
124 };
125
126 /** TFTP request flags */
127 enum {
128         /** Send ACK packets */
129         TFTP_FL_SEND_ACK = 0x0001,
130         /** Request blksize and tsize options */
131         TFTP_FL_RRQ_SIZES = 0x0002,
132         /** Request multicast option */
133         TFTP_FL_RRQ_MULTICAST = 0x0004,
134         /** Perform MTFTP recovery on timeout */
135         TFTP_FL_MTFTP_RECOVERY = 0x0008,
136 };
137
138 /** Maximum number of MTFTP open requests before falling back to TFTP */
139 #define MTFTP_MAX_TIMEOUTS 3
140
141 /**
142  * Free TFTP request
143  *
144  * @v refcnt            Reference counter
145  */
146 static void tftp_free ( struct refcnt *refcnt ) {
147         struct tftp_request *tftp =
148                 container_of ( refcnt, struct tftp_request, refcnt );
149
150         uri_put ( tftp->uri );
151         bitmap_free ( &tftp->bitmap );
152         free ( tftp );
153 }
154
155 /**
156  * Mark TFTP request as complete
157  *
158  * @v tftp              TFTP connection
159  * @v rc                Return status code
160  */
161 static void tftp_done ( struct tftp_request *tftp, int rc ) {
162
163         DBGC ( tftp, "TFTP %p finished with status %d (%s)\n",
164                tftp, rc, strerror ( rc ) );
165
166         /* Stop the retry timer */
167         stop_timer ( &tftp->timer );
168
169         /* Close all data transfer interfaces */
170         xfer_nullify ( &tftp->socket );
171         xfer_close ( &tftp->socket, rc );
172         xfer_nullify ( &tftp->mc_socket );
173         xfer_close ( &tftp->mc_socket, rc );
174         xfer_nullify ( &tftp->xfer );
175         xfer_close ( &tftp->xfer, rc );
176 }
177
178 /**
179  * Reopen TFTP socket
180  *
181  * @v tftp              TFTP connection
182  * @ret rc              Return status code
183  */
184 static int tftp_reopen ( struct tftp_request *tftp ) {
185         struct sockaddr_tcpip server;
186         int rc;
187
188         /* Close socket */
189         xfer_close ( &tftp->socket, 0 );
190
191         /* Disable ACK sending. */
192         tftp->flags &= ~TFTP_FL_SEND_ACK;
193
194         /* Reset peer address */
195         memset ( &tftp->peer, 0, sizeof ( tftp->peer ) );
196
197         /* Open socket */
198         memset ( &server, 0, sizeof ( server ) );
199         server.st_port = htons ( tftp->port );
200         if ( ( rc = xfer_open_named_socket ( &tftp->socket, SOCK_DGRAM,
201                                              ( struct sockaddr * ) &server,
202                                              tftp->uri->host, NULL ) ) != 0 ) {
203                 DBGC ( tftp, "TFTP %p could not open socket: %s\n",
204                        tftp, strerror ( rc ) );
205                 return rc;
206         }
207
208         return 0;
209 }
210
211 /**
212  * Reopen TFTP multicast socket
213  *
214  * @v tftp              TFTP connection
215  * @v local             Local socket address
216  * @ret rc              Return status code
217  */
218 static int tftp_reopen_mc ( struct tftp_request *tftp,
219                             struct sockaddr *local ) {
220         int rc;
221
222         /* Close multicast socket */
223         xfer_close ( &tftp->mc_socket, 0 );
224
225         /* Open multicast socket.  We never send via this socket, so
226          * use the local address as the peer address (since the peer
227          * address cannot be NULL).
228          */
229         if ( ( rc = xfer_open_socket ( &tftp->mc_socket, SOCK_DGRAM,
230                                        local, local ) ) != 0 ) {
231                 DBGC ( tftp, "TFTP %p could not open multicast "
232                        "socket: %s\n", tftp, strerror ( rc ) );
233                 return rc;
234         }
235
236         return 0;
237 }
238
239 /**
240  * Presize TFTP receive buffers and block bitmap
241  *
242  * @v tftp              TFTP connection
243  * @v filesize          Known minimum file size
244  * @ret rc              Return status code
245  */
246 static int tftp_presize ( struct tftp_request *tftp, size_t filesize ) {
247         unsigned int num_blocks;
248         int rc;
249
250         /* Do nothing if we are already large enough */
251         if ( filesize <= tftp->filesize )
252                 return 0;
253
254         /* Record filesize */
255         tftp->filesize = filesize;
256
257         /* Notify recipient of file size */
258         xfer_seek ( &tftp->xfer, filesize, SEEK_SET );
259         xfer_seek ( &tftp->xfer, 0, SEEK_SET );
260
261         /* Calculate expected number of blocks.  Note that files whose
262          * length is an exact multiple of the blocksize will have a
263          * trailing zero-length block, which must be included.
264          */
265         num_blocks = ( ( filesize / tftp->blksize ) + 1 );
266         if ( ( rc = bitmap_resize ( &tftp->bitmap, num_blocks ) ) != 0 ) {
267                 DBGC ( tftp, "TFTP %p could not resize bitmap to %d blocks: "
268                        "%s\n", tftp, num_blocks, strerror ( rc ) );
269                 return rc;
270         }
271
272         return 0;
273 }
274
275 /**
276  * TFTP requested blocksize
277  *
278  * This is treated as a global configuration parameter.
279  */
280 static unsigned int tftp_request_blksize = TFTP_MAX_BLKSIZE;
281
282 /**
283  * Set TFTP request blocksize
284  *
285  * @v blksize           Requested block size
286  */
287 void tftp_set_request_blksize ( unsigned int blksize ) {
288         if ( blksize < TFTP_DEFAULT_BLKSIZE )
289                 blksize = TFTP_DEFAULT_BLKSIZE;
290         tftp_request_blksize = blksize;
291 }
292
293 /**
294  * MTFTP multicast receive address
295  *
296  * This is treated as a global configuration parameter.
297  */
298 static struct sockaddr_in tftp_mtftp_socket = {
299         .sin_family = AF_INET,
300         .sin_addr.s_addr = htonl ( 0xefff0101 ),
301         .sin_port = htons ( 3001 ),
302 };
303
304 /**
305  * Set MTFTP multicast address
306  *
307  * @v address           Multicast IPv4 address
308  */
309 void tftp_set_mtftp_address ( struct in_addr address ) {
310         tftp_mtftp_socket.sin_addr = address;
311 }
312
313 /**
314  * Set MTFTP multicast port
315  *
316  * @v port              Multicast port
317  */
318 void tftp_set_mtftp_port ( unsigned int port ) {
319         tftp_mtftp_socket.sin_port = htons ( port );
320 }
321
322 /**
323  * Transmit RRQ
324  *
325  * @v tftp              TFTP connection
326  * @ret rc              Return status code
327  */
328 static int tftp_send_rrq ( struct tftp_request *tftp ) {
329         struct tftp_rrq *rrq;
330         const char *path;
331         size_t len;
332         struct io_buffer *iobuf;
333
334         /* Strip initial '/' if present.  If we were opened via the
335          * URI interface, then there will be an initial '/', since a
336          * full tftp:// URI provides no way to specify a non-absolute
337          * path.  However, many TFTP servers (particularly Windows
338          * TFTP servers) complain about having an initial '/', and it
339          * violates user expectations to have a '/' silently added to
340          * the DHCP-specified filename.
341          */
342         path = tftp->uri->path;
343         if ( *path == '/' )
344                 path++;
345
346         DBGC ( tftp, "TFTP %p requesting \"%s\"\n", tftp, path );
347
348         /* Allocate buffer */
349         len = ( sizeof ( *rrq ) + strlen ( path ) + 1 /* NUL */
350                 + 5 + 1 /* "octet" + NUL */
351                 + 7 + 1 + 5 + 1 /* "blksize" + NUL + ddddd + NUL */
352                 + 5 + 1 + 1 + 1 /* "tsize" + NUL + "0" + NUL */ 
353                 + 9 + 1 + 1 /* "multicast" + NUL + NUL */ );
354         iobuf = xfer_alloc_iob ( &tftp->socket, len );
355         if ( ! iobuf )
356                 return -ENOMEM;
357
358         /* Build request */
359         rrq = iob_put ( iobuf, sizeof ( *rrq ) );
360         rrq->opcode = htons ( TFTP_RRQ );
361         iob_put ( iobuf, snprintf ( iobuf->tail, iob_tailroom ( iobuf ),
362                                     "%s%coctet", path, 0 ) + 1 );
363         if ( tftp->flags & TFTP_FL_RRQ_SIZES ) {
364                 iob_put ( iobuf, snprintf ( iobuf->tail,
365                                             iob_tailroom ( iobuf ),
366                                             "blksize%c%d%ctsize%c0", 0,
367                                             tftp_request_blksize, 0, 0 ) + 1 );
368         }
369         if ( tftp->flags & TFTP_FL_RRQ_MULTICAST ) {
370                 iob_put ( iobuf, snprintf ( iobuf->tail,
371                                             iob_tailroom ( iobuf ),
372                                             "multicast%c", 0 ) + 1 );
373         }
374
375         /* RRQ always goes to the address specified in the initial
376          * xfer_open() call
377          */
378         return xfer_deliver_iob ( &tftp->socket, iobuf );
379 }
380
381 /**
382  * Transmit ACK
383  *
384  * @v tftp              TFTP connection
385  * @ret rc              Return status code
386  */
387 static int tftp_send_ack ( struct tftp_request *tftp ) {
388         struct tftp_ack *ack;
389         struct io_buffer *iobuf;
390         struct xfer_metadata meta = {
391                 .dest = ( struct sockaddr * ) &tftp->peer,
392         };
393         unsigned int block;
394
395         /* Determine next required block number */
396         block = bitmap_first_gap ( &tftp->bitmap );
397         DBGC2 ( tftp, "TFTP %p sending ACK for block %d\n", tftp, block );
398
399         /* Allocate buffer */
400         iobuf = xfer_alloc_iob ( &tftp->socket, sizeof ( *ack ) );
401         if ( ! iobuf )
402                 return -ENOMEM;
403
404         /* Build ACK */
405         ack = iob_put ( iobuf, sizeof ( *ack ) );
406         ack->opcode = htons ( TFTP_ACK );
407         ack->block = htons ( block );
408
409         /* ACK always goes to the peer recorded from the RRQ response */
410         return xfer_deliver_iob_meta ( &tftp->socket, iobuf, &meta );
411 }
412
413 /**
414  * Transmit next relevant packet
415  *
416  * @v tftp              TFTP connection
417  * @ret rc              Return status code
418  */
419 static int tftp_send_packet ( struct tftp_request *tftp ) {
420
421         /* Update retransmission timer */
422         stop_timer ( &tftp->timer );
423         start_timer ( &tftp->timer );
424
425         /* Send RRQ or ACK as appropriate */
426         if ( ! tftp->peer.st_family ) {
427                 return tftp_send_rrq ( tftp );
428         } else {
429                 if ( tftp->flags & TFTP_FL_SEND_ACK ) {
430                         return tftp_send_ack ( tftp );
431                 } else {
432                         return 0;
433                 }
434         }
435 }
436
437 /**
438  * Handle TFTP retransmission timer expiry
439  *
440  * @v timer             Retry timer
441  * @v fail              Failure indicator
442  */
443 static void tftp_timer_expired ( struct retry_timer *timer, int fail ) {
444         struct tftp_request *tftp =
445                 container_of ( timer, struct tftp_request, timer );
446         int rc;
447
448         /* If we are doing MTFTP, attempt the various recovery strategies */
449         if ( tftp->flags & TFTP_FL_MTFTP_RECOVERY ) {
450                 if ( tftp->peer.st_family ) {
451                         /* If we have received any response from the server,
452                          * try resending the RRQ to restart the download.
453                          */
454                         DBGC ( tftp, "TFTP %p attempting reopen\n", tftp );
455                         if ( ( rc = tftp_reopen ( tftp ) ) != 0 )
456                                 goto err;
457                 } else {
458                         /* Fall back to plain TFTP after several attempts */
459                         tftp->mtftp_timeouts++;
460                         DBGC ( tftp, "TFTP %p timeout %d waiting for MTFTP "
461                                "open\n", tftp, tftp->mtftp_timeouts );
462
463                         if ( tftp->mtftp_timeouts > MTFTP_MAX_TIMEOUTS ) {
464                                 DBGC ( tftp, "TFTP %p falling back to plain "
465                                        "TFTP\n", tftp );
466                                 tftp->flags = TFTP_FL_RRQ_SIZES;
467
468                                 /* Close multicast socket */
469                                 xfer_close ( &tftp->mc_socket, 0 );
470
471                                 /* Reset retry timer */
472                                 start_timer_nodelay ( &tftp->timer );
473
474                                 /* The blocksize may change: discard
475                                  * the block bitmap
476                                  */
477                                 bitmap_free ( &tftp->bitmap );
478                                 memset ( &tftp->bitmap, 0,
479                                          sizeof ( tftp->bitmap ) );
480
481                                 /* Reopen on standard TFTP port */
482                                 tftp->port = TFTP_PORT;
483                                 if ( ( rc = tftp_reopen ( tftp ) ) != 0 )
484                                         goto err;
485                         }
486                 }
487         } else {
488                 /* Not doing MTFTP (or have fallen back to plain
489                  * TFTP); fail as per normal.
490                  */
491                 if ( fail ) {
492                         rc = -ETIMEDOUT;
493                         goto err;
494                 }
495         }
496         tftp_send_packet ( tftp );
497         return;
498
499  err:
500         tftp_done ( tftp, rc );
501 }
502
503 /**
504  * Process TFTP "blksize" option
505  *
506  * @v tftp              TFTP connection
507  * @v value             Option value
508  * @ret rc              Return status code
509  */
510 static int tftp_process_blksize ( struct tftp_request *tftp,
511                                   const char *value ) {
512         char *end;
513
514         tftp->blksize = strtoul ( value, &end, 10 );
515         if ( *end ) {
516                 DBGC ( tftp, "TFTP %p got invalid blksize \"%s\"\n",
517                        tftp, value );
518                 return -( EINVAL | ETFTP_INVALID_BLKSIZE );
519         }
520         DBGC ( tftp, "TFTP %p blksize=%d\n", tftp, tftp->blksize );
521
522         return 0;
523 }
524
525 /**
526  * Process TFTP "tsize" option
527  *
528  * @v tftp              TFTP connection
529  * @v value             Option value
530  * @ret rc              Return status code
531  */
532 static int tftp_process_tsize ( struct tftp_request *tftp,
533                                 const char *value ) {
534         char *end;
535
536         tftp->tsize = strtoul ( value, &end, 10 );
537         if ( *end ) {
538                 DBGC ( tftp, "TFTP %p got invalid tsize \"%s\"\n",
539                        tftp, value );
540                 return -( EINVAL | ETFTP_INVALID_TSIZE );
541         }
542         DBGC ( tftp, "TFTP %p tsize=%ld\n", tftp, tftp->tsize );
543
544         return 0;
545 }
546
547 /**
548  * Process TFTP "multicast" option
549  *
550  * @v tftp              TFTP connection
551  * @v value             Option value
552  * @ret rc              Return status code
553  */
554 static int tftp_process_multicast ( struct tftp_request *tftp,
555                                     const char *value ) {
556         union {
557                 struct sockaddr sa;
558                 struct sockaddr_in sin;
559         } socket;
560         char buf[ strlen ( value ) + 1 ];
561         char *addr;
562         char *port;
563         char *port_end;
564         char *mc;
565         char *mc_end;
566         int rc;
567
568         /* Split value into "addr,port,mc" fields */
569         memcpy ( buf, value, sizeof ( buf ) );
570         addr = buf;
571         port = strchr ( addr, ',' );
572         if ( ! port ) {
573                 DBGC ( tftp, "TFTP %p multicast missing port,mc\n", tftp );
574                 return -( EINVAL | ETFTP_MC_NO_PORT );
575         }
576         *(port++) = '\0';
577         mc = strchr ( port, ',' );
578         if ( ! mc ) {
579                 DBGC ( tftp, "TFTP %p multicast missing mc\n", tftp );
580                 return -( EINVAL | ETFTP_MC_NO_MC );
581         }
582         *(mc++) = '\0';
583
584         /* Parse parameters */
585         if ( strtoul ( mc, &mc_end, 0 ) == 0 )
586                 tftp->flags &= ~TFTP_FL_SEND_ACK;
587         if ( *mc_end ) {
588                 DBGC ( tftp, "TFTP %p multicast invalid mc %s\n", tftp, mc );
589                 return -( EINVAL | ETFTP_MC_INVALID_MC );
590         }
591         DBGC ( tftp, "TFTP %p is%s the master client\n",
592                tftp, ( ( tftp->flags & TFTP_FL_SEND_ACK ) ? "" : " not" ) );
593         if ( *addr && *port ) {
594                 socket.sin.sin_family = AF_INET;
595                 if ( inet_aton ( addr, &socket.sin.sin_addr ) == 0 ) {
596                         DBGC ( tftp, "TFTP %p multicast invalid IP address "
597                                "%s\n", tftp, addr );
598                         return -( EINVAL | ETFTP_MC_INVALID_IP );
599                 }
600                 DBGC ( tftp, "TFTP %p multicast IP address %s\n",
601                        tftp, inet_ntoa ( socket.sin.sin_addr ) );
602                 socket.sin.sin_port = htons ( strtoul ( port, &port_end, 0 ) );
603                 if ( *port_end ) {
604                         DBGC ( tftp, "TFTP %p multicast invalid port %s\n",
605                                tftp, port );
606                         return -( EINVAL | ETFTP_MC_INVALID_PORT );
607                 }
608                 DBGC ( tftp, "TFTP %p multicast port %d\n",
609                        tftp, ntohs ( socket.sin.sin_port ) );
610                 if ( ( rc = tftp_reopen_mc ( tftp, &socket.sa ) ) != 0 )
611                         return rc;
612         }
613
614         return 0;
615 }
616
617 /** A TFTP option */
618 struct tftp_option {
619         /** Option name */
620         const char *name;
621         /** Option processor
622          *
623          * @v tftp      TFTP connection
624          * @v value     Option value
625          * @ret rc      Return status code
626          */
627         int ( * process ) ( struct tftp_request *tftp, const char *value );
628 };
629
630 /** Recognised TFTP options */
631 static struct tftp_option tftp_options[] = {
632         { "blksize", tftp_process_blksize },
633         { "tsize", tftp_process_tsize },
634         { "multicast", tftp_process_multicast },
635         { NULL, NULL }
636 };
637
638 /**
639  * Process TFTP option
640  *
641  * @v tftp              TFTP connection
642  * @v name              Option name
643  * @v value             Option value
644  * @ret rc              Return status code
645  */
646 static int tftp_process_option ( struct tftp_request *tftp,
647                                  const char *name, const char *value ) {
648         struct tftp_option *option;
649
650         for ( option = tftp_options ; option->name ; option++ ) {
651                 if ( strcasecmp ( name, option->name ) == 0 )
652                         return option->process ( tftp, value );
653         }
654
655         DBGC ( tftp, "TFTP %p received unknown option \"%s\" = \"%s\"\n",
656                tftp, name, value );
657
658         /* Unknown options should be silently ignored */
659         return 0;
660 }
661
662 /**
663  * Receive OACK
664  *
665  * @v tftp              TFTP connection
666  * @v buf               Temporary data buffer
667  * @v len               Length of temporary data buffer
668  * @ret rc              Return status code
669  */
670 static int tftp_rx_oack ( struct tftp_request *tftp, void *buf, size_t len ) {
671         struct tftp_oack *oack = buf;
672         char *end = buf + len;
673         char *name;
674         char *value;
675         char *next;
676         int rc = 0;
677
678         /* Sanity check */
679         if ( len < sizeof ( *oack ) ) {
680                 DBGC ( tftp, "TFTP %p received underlength OACK packet "
681                        "length %zd\n", tftp, len );
682                 rc = -EINVAL;
683                 goto done;
684         }
685
686         /* Process each option in turn */
687         for ( name = oack->data ; name < end ; name = next ) {
688
689                 /* Parse option name and value
690                  *
691                  * We treat parsing errors as non-fatal, because there
692                  * exists at least one TFTP server (IBM Tivoli PXE
693                  * Server 5.1.0.3) that has been observed to send
694                  * malformed OACKs containing trailing garbage bytes.
695                  */
696                 value = ( name + strnlen ( name, ( end - name ) ) + 1 );
697                 if ( value > end ) {
698                         DBGC ( tftp, "TFTP %p received OACK with malformed "
699                                "option name:\n", tftp );
700                         DBGC_HD ( tftp, oack, len );
701                         break;
702                 }
703                 if ( value == end ) {
704                         DBGC ( tftp, "TFTP %p received OACK missing value "
705                                "for option \"%s\"\n", tftp, name );
706                         DBGC_HD ( tftp, oack, len );
707                         break;
708                 }
709                 next = ( value + strnlen ( value, ( end - value ) ) + 1 );
710                 if ( next > end ) {
711                         DBGC ( tftp, "TFTP %p received OACK with malformed "
712                                "value for option \"%s\":\n", tftp, name );
713                         DBGC_HD ( tftp, oack, len );
714                         break;
715                 }
716
717                 /* Process option */
718                 if ( ( rc = tftp_process_option ( tftp, name, value ) ) != 0 )
719                         goto done;
720         }
721
722         /* Process tsize information, if available */
723         if ( tftp->tsize ) {
724                 if ( ( rc = tftp_presize ( tftp, tftp->tsize ) ) != 0 )
725                         goto done;
726         }
727
728         /* Request next data block */
729         tftp_send_packet ( tftp );
730
731  done:
732         if ( rc )
733                 tftp_done ( tftp, rc );
734         return rc;
735 }
736
737 /**
738  * Receive DATA
739  *
740  * @v tftp              TFTP connection
741  * @v iobuf             I/O buffer
742  * @ret rc              Return status code
743  *
744  * Takes ownership of I/O buffer.
745  */
746 static int tftp_rx_data ( struct tftp_request *tftp,
747                           struct io_buffer *iobuf ) {
748         struct tftp_data *data = iobuf->data;
749         struct xfer_metadata meta;
750         unsigned int block;
751         off_t offset;
752         size_t data_len;
753         int rc;
754
755         /* Sanity check */
756         if ( iob_len ( iobuf ) < sizeof ( *data ) ) {
757                 DBGC ( tftp, "TFTP %p received underlength DATA packet "
758                        "length %zd\n", tftp, iob_len ( iobuf ) );
759                 rc = -EINVAL;
760                 goto done;
761         }
762
763         /* Calculate block number */
764         block = ( ( bitmap_first_gap ( &tftp->bitmap ) + 1 ) & ~0xffff );
765         if ( data->block == 0 && block == 0 ) {
766                 DBGC ( tftp, "TFTP %p received data block 0\n", tftp );
767                 rc = -EINVAL;
768                 goto done;
769         }
770         block += ( ntohs ( data->block ) - 1 );
771
772         /* Extract data */
773         offset = ( block * tftp->blksize );
774         iob_pull ( iobuf, sizeof ( *data ) );
775         data_len = iob_len ( iobuf );
776         if ( data_len > tftp->blksize ) {
777                 DBGC ( tftp, "TFTP %p received overlength DATA packet "
778                        "length %zd\n", tftp, data_len );
779                 rc = -EINVAL;
780                 goto done;
781         }
782
783         /* Deliver data */
784         memset ( &meta, 0, sizeof ( meta ) );
785         meta.whence = SEEK_SET;
786         meta.offset = offset;
787         if ( ( rc = xfer_deliver_iob_meta ( &tftp->xfer, iob_disown ( iobuf ),
788                                             &meta ) ) != 0 ) {
789                 DBGC ( tftp, "TFTP %p could not deliver data: %s\n",
790                        tftp, strerror ( rc ) );
791                 goto done;
792         }
793
794         /* Ensure block bitmap is ready */
795         if ( ( rc = tftp_presize ( tftp, ( offset + data_len ) ) ) != 0 )
796                 goto done;
797
798         /* Mark block as received */
799         bitmap_set ( &tftp->bitmap, block );
800
801         /* Acknowledge block */
802         tftp_send_packet ( tftp );
803
804         /* If all blocks have been received, finish. */
805         if ( bitmap_full ( &tftp->bitmap ) )
806                 tftp_done ( tftp, 0 );
807
808  done:
809         free_iob ( iobuf );
810         if ( rc )
811                 tftp_done ( tftp, rc );
812         return rc;
813 }
814
815 /** Translation between TFTP errors and internal error numbers */
816 static const int tftp_errors[] = {
817         [TFTP_ERR_FILE_NOT_FOUND]       = ENOENT,
818         [TFTP_ERR_ACCESS_DENIED]        = EACCES,
819         [TFTP_ERR_ILLEGAL_OP]           = ENOTSUP,
820 };
821
822 /**
823  * Receive ERROR
824  *
825  * @v tftp              TFTP connection
826  * @v buf               Temporary data buffer
827  * @v len               Length of temporary data buffer
828  * @ret rc              Return status code
829  */
830 static int tftp_rx_error ( struct tftp_request *tftp, void *buf, size_t len ) {
831         struct tftp_error *error = buf;
832         unsigned int err;
833         int rc = 0;
834
835         /* Sanity check */
836         if ( len < sizeof ( *error ) ) {
837                 DBGC ( tftp, "TFTP %p received underlength ERROR packet "
838                        "length %zd\n", tftp, len );
839                 return -EINVAL;
840         }
841
842         DBGC ( tftp, "TFTP %p received ERROR packet with code %d, message "
843                "\"%s\"\n", tftp, ntohs ( error->errcode ), error->errmsg );
844         
845         /* Determine final operation result */
846         err = ntohs ( error->errcode );
847         if ( err < ( sizeof ( tftp_errors ) / sizeof ( tftp_errors[0] ) ) )
848                 rc = -tftp_errors[err];
849         if ( ! rc )
850                 rc = -ENOTSUP;
851
852         /* Close TFTP request */
853         tftp_done ( tftp, rc );
854
855         return 0;
856 }
857
858 /**
859  * Receive new data
860  *
861  * @v tftp              TFTP connection
862  * @v iobuf             I/O buffer
863  * @v meta              Transfer metadata
864  * @ret rc              Return status code
865  */
866 static int tftp_rx ( struct tftp_request *tftp,
867                      struct io_buffer *iobuf,
868                      struct xfer_metadata *meta ) {
869         struct sockaddr_tcpip *st_src;
870         struct tftp_common *common = iobuf->data;
871         size_t len = iob_len ( iobuf );
872         int rc = -EINVAL;
873         
874         /* Sanity checks */
875         if ( len < sizeof ( *common ) ) {
876                 DBGC ( tftp, "TFTP %p received underlength packet length "
877                        "%zd\n", tftp, len );
878                 goto done;
879         }
880         if ( ! meta->src ) {
881                 DBGC ( tftp, "TFTP %p received packet without source port\n",
882                        tftp );
883                 goto done;
884         }
885
886         /* Filter by TID.  Set TID on first response received */
887         st_src = ( struct sockaddr_tcpip * ) meta->src;
888         if ( ! tftp->peer.st_family ) {
889                 memcpy ( &tftp->peer, st_src, sizeof ( tftp->peer ) );
890                 DBGC ( tftp, "TFTP %p using remote port %d\n", tftp,
891                        ntohs ( tftp->peer.st_port ) );
892         } else if ( memcmp ( &tftp->peer, st_src,
893                              sizeof ( tftp->peer ) ) != 0 ) {
894                 DBGC ( tftp, "TFTP %p received packet from wrong source (got "
895                        "%d, wanted %d)\n", tftp, ntohs ( st_src->st_port ),
896                        ntohs ( tftp->peer.st_port ) );
897                 goto done;
898         }
899
900         switch ( common->opcode ) {
901         case htons ( TFTP_OACK ):
902                 rc = tftp_rx_oack ( tftp, iobuf->data, len );
903                 break;
904         case htons ( TFTP_DATA ):
905                 rc = tftp_rx_data ( tftp, iob_disown ( iobuf ) );
906                 break;
907         case htons ( TFTP_ERROR ):
908                 rc = tftp_rx_error ( tftp, iobuf->data, len );
909                 break;
910         default:
911                 DBGC ( tftp, "TFTP %p received strange packet type %d\n",
912                        tftp, ntohs ( common->opcode ) );
913                 break;
914         };
915
916  done:
917         free_iob ( iobuf );
918         return rc;
919 }
920
921 /**
922  * Receive new data via socket
923  *
924  * @v socket            Transport layer interface
925  * @v iobuf             I/O buffer
926  * @v meta              Transfer metadata
927  * @ret rc              Return status code
928  */
929 static int tftp_socket_deliver_iob ( struct xfer_interface *socket,
930                                      struct io_buffer *iobuf,
931                                      struct xfer_metadata *meta ) {
932         struct tftp_request *tftp =
933                 container_of ( socket, struct tftp_request, socket );
934
935         /* Enable sending ACKs when we receive a unicast packet.  This
936          * covers three cases:
937          *
938          * 1. Standard TFTP; we should always send ACKs, and will
939          *    always receive a unicast packet before we need to send the
940          *    first ACK.
941          *
942          * 2. RFC2090 multicast TFTP; the only unicast packets we will
943          *    receive are the OACKs; enable sending ACKs here (before
944          *    processing the OACK) and disable it when processing the
945          *    multicast option if we are not the master client.
946          *
947          * 3. MTFTP; receiving a unicast datagram indicates that we
948          *    are the "master client" and should send ACKs.
949          */
950         tftp->flags |= TFTP_FL_SEND_ACK;
951
952         return tftp_rx ( tftp, iobuf, meta );
953 }
954
955 /** TFTP socket operations */
956 static struct xfer_interface_operations tftp_socket_operations = {
957         .close          = ignore_xfer_close,
958         .vredirect      = xfer_vreopen,
959         .window         = unlimited_xfer_window,
960         .alloc_iob      = default_xfer_alloc_iob,
961         .deliver_iob    = tftp_socket_deliver_iob,
962         .deliver_raw    = xfer_deliver_as_iob,
963 };
964
965 /**
966  * Receive new data via multicast socket
967  *
968  * @v mc_socket         Multicast transport layer interface
969  * @v iobuf             I/O buffer
970  * @v meta              Transfer metadata
971  * @ret rc              Return status code
972  */
973 static int tftp_mc_socket_deliver_iob ( struct xfer_interface *mc_socket,
974                                         struct io_buffer *iobuf,
975                                         struct xfer_metadata *meta ) {
976         struct tftp_request *tftp =
977                 container_of ( mc_socket, struct tftp_request, mc_socket );
978
979         return tftp_rx ( tftp, iobuf, meta );
980 }
981
982 /** TFTP multicast socket operations */
983 static struct xfer_interface_operations tftp_mc_socket_operations = {
984         .close          = ignore_xfer_close,
985         .vredirect      = xfer_vreopen,
986         .window         = unlimited_xfer_window,
987         .alloc_iob      = default_xfer_alloc_iob,
988         .deliver_iob    = tftp_mc_socket_deliver_iob,
989         .deliver_raw    = xfer_deliver_as_iob,
990 };
991
992 /**
993  * Close TFTP data transfer interface
994  *
995  * @v xfer              Data transfer interface
996  * @v rc                Reason for close
997  */
998 static void tftp_xfer_close ( struct xfer_interface *xfer, int rc ) {
999         struct tftp_request *tftp =
1000                 container_of ( xfer, struct tftp_request, xfer );
1001
1002         DBGC ( tftp, "TFTP %p interface closed: %s\n",
1003                tftp, strerror ( rc ) );
1004
1005         tftp_done ( tftp, rc );
1006 }
1007
1008 /**
1009  * Check flow control window
1010  *
1011  * @v xfer              Data transfer interface
1012  * @ret len             Length of window
1013  */
1014 static size_t tftp_xfer_window ( struct xfer_interface *xfer ) {
1015         struct tftp_request *tftp =
1016                 container_of ( xfer, struct tftp_request, xfer );
1017
1018         /* We abuse this data-xfer method to convey the blocksize to
1019          * the caller.  This really should be done using some kind of
1020          * stat() method, but we don't yet have the facility to do
1021          * that.
1022          */
1023         return tftp->blksize;
1024 }
1025
1026 /** TFTP data transfer interface operations */
1027 static struct xfer_interface_operations tftp_xfer_operations = {
1028         .close          = tftp_xfer_close,
1029         .vredirect      = ignore_xfer_vredirect,
1030         .window         = tftp_xfer_window,
1031         .alloc_iob      = default_xfer_alloc_iob,
1032         .deliver_iob    = xfer_deliver_as_raw,
1033         .deliver_raw    = ignore_xfer_deliver_raw,
1034 };
1035
1036 /**
1037  * Initiate TFTP/TFTM/MTFTP download
1038  *
1039  * @v xfer              Data transfer interface
1040  * @v uri               Uniform Resource Identifier
1041  * @ret rc              Return status code
1042  */
1043 static int tftp_core_open ( struct xfer_interface *xfer, struct uri *uri,
1044                             unsigned int default_port,
1045                             struct sockaddr *multicast,
1046                             unsigned int flags ) {
1047         struct tftp_request *tftp;
1048         int rc;
1049
1050         /* Sanity checks */
1051         if ( ! uri->host )
1052                 return -EINVAL;
1053         if ( ! uri->path )
1054                 return -EINVAL;
1055
1056         /* Allocate and populate TFTP structure */
1057         tftp = zalloc ( sizeof ( *tftp ) );
1058         if ( ! tftp )
1059                 return -ENOMEM;
1060         tftp->refcnt.free = tftp_free;
1061         xfer_init ( &tftp->xfer, &tftp_xfer_operations, &tftp->refcnt );
1062         tftp->uri = uri_get ( uri );
1063         xfer_init ( &tftp->socket, &tftp_socket_operations, &tftp->refcnt );
1064         xfer_init ( &tftp->mc_socket, &tftp_mc_socket_operations,
1065                     &tftp->refcnt );
1066         tftp->blksize = TFTP_DEFAULT_BLKSIZE;
1067         tftp->flags = flags;
1068         tftp->timer.expired = tftp_timer_expired;
1069
1070         /* Open socket */
1071         tftp->port = uri_port ( tftp->uri, default_port );
1072         if ( ( rc = tftp_reopen ( tftp ) ) != 0 )
1073                 goto err;
1074
1075         /* Open multicast socket */
1076         if ( multicast ) {
1077                 if ( ( rc = tftp_reopen_mc ( tftp, multicast ) ) != 0 )
1078                         goto err;
1079         }
1080
1081         /* Start timer to initiate RRQ */
1082         start_timer_nodelay ( &tftp->timer );
1083
1084         /* Attach to parent interface, mortalise self, and return */
1085         xfer_plug_plug ( &tftp->xfer, xfer );
1086         ref_put ( &tftp->refcnt );
1087         return 0;
1088
1089  err:
1090         DBGC ( tftp, "TFTP %p could not create request: %s\n",
1091                tftp, strerror ( rc ) );
1092         tftp_done ( tftp, rc );
1093         ref_put ( &tftp->refcnt );
1094         return rc;
1095 }
1096
1097 /**
1098  * Initiate TFTP download
1099  *
1100  * @v xfer              Data transfer interface
1101  * @v uri               Uniform Resource Identifier
1102  * @ret rc              Return status code
1103  */
1104 static int tftp_open ( struct xfer_interface *xfer, struct uri *uri ) {
1105         return tftp_core_open ( xfer, uri, TFTP_PORT, NULL,
1106                                 TFTP_FL_RRQ_SIZES );
1107
1108 }
1109
1110 /** TFTP URI opener */
1111 struct uri_opener tftp_uri_opener __uri_opener = {
1112         .scheme = "tftp",
1113         .open   = tftp_open,
1114 };
1115
1116 /**
1117  * Initiate TFTM download
1118  *
1119  * @v xfer              Data transfer interface
1120  * @v uri               Uniform Resource Identifier
1121  * @ret rc              Return status code
1122  */
1123 static int tftm_open ( struct xfer_interface *xfer, struct uri *uri ) {
1124         return tftp_core_open ( xfer, uri, TFTP_PORT, NULL,
1125                                 ( TFTP_FL_RRQ_SIZES |
1126                                   TFTP_FL_RRQ_MULTICAST ) );
1127
1128 }
1129
1130 /** TFTM URI opener */
1131 struct uri_opener tftm_uri_opener __uri_opener = {
1132         .scheme = "tftm",
1133         .open   = tftm_open,
1134 };
1135
1136 /**
1137  * Initiate MTFTP download
1138  *
1139  * @v xfer              Data transfer interface
1140  * @v uri               Uniform Resource Identifier
1141  * @ret rc              Return status code
1142  */
1143 static int mtftp_open ( struct xfer_interface *xfer, struct uri *uri ) {
1144         return tftp_core_open ( xfer, uri, MTFTP_PORT,
1145                                 ( struct sockaddr * ) &tftp_mtftp_socket,
1146                                 TFTP_FL_MTFTP_RECOVERY );
1147 }
1148
1149 /** MTFTP URI opener */
1150 struct uri_opener mtftp_uri_opener __uri_opener = {
1151         .scheme = "mtftp",
1152         .open   = mtftp_open,
1153 };
1154
1155 /******************************************************************************
1156  *
1157  * Settings
1158  *
1159  ******************************************************************************
1160  */
1161
1162 /** TFTP server setting */
1163 struct setting next_server_setting __setting = {
1164         .name = "next-server",
1165         .description = "TFTP server",
1166         .tag = DHCP_EB_SIADDR,
1167         .type = &setting_type_ipv4,
1168 };
1169
1170 /**
1171  * Apply TFTP configuration settings
1172  *
1173  * @ret rc              Return status code
1174  */
1175 static int tftp_apply_settings ( void ) {
1176         static struct in_addr tftp_server = { 0 };
1177         struct in_addr last_tftp_server;
1178         char uri_string[32];
1179         struct uri *uri;
1180
1181         /* Retrieve TFTP server setting */
1182         last_tftp_server = tftp_server;
1183         fetch_ipv4_setting ( NULL, &next_server_setting, &tftp_server );
1184
1185         /* If TFTP server setting has changed, set the current working
1186          * URI to match.  Do it only when the TFTP server has changed
1187          * to try to minimise surprises to the user, who probably
1188          * won't expect the CWURI to change just because they updated
1189          * an unrelated setting and triggered all the settings
1190          * applicators.
1191          */
1192         if ( tftp_server.s_addr != last_tftp_server.s_addr ) {
1193                 snprintf ( uri_string, sizeof ( uri_string ),
1194                            "tftp://%s/", inet_ntoa ( tftp_server ) );
1195                 uri = parse_uri ( uri_string );
1196                 if ( ! uri )
1197                         return -ENOMEM;
1198                 churi ( uri );
1199                 uri_put ( uri );
1200         }
1201
1202         return 0;
1203 }
1204
1205 /** TFTP settings applicator */
1206 struct settings_applicator tftp_settings_applicator __settings_applicator = {
1207         .apply = tftp_apply_settings,
1208 };