TFTP: block id wrap bug fix
[platform/upstream/curl.git] / lib / tftp.c
1 /***************************************************************************
2  *                                  _   _ ____  _
3  *  Project                     ___| | | |  _ \| |
4  *                             / __| | | | |_) | |
5  *                            | (__| |_| |  _ <| |___
6  *                             \___|\___/|_| \_\_____|
7  *
8  * Copyright (C) 1998 - 2010, Daniel Stenberg, <daniel@haxx.se>, et al.
9  *
10  * This software is licensed as described in the file COPYING, which
11  * you should have received as part of this distribution. The terms
12  * are also available at http://curl.haxx.se/docs/copyright.html.
13  *
14  * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15  * copies of the Software, and permit persons to whom the Software is
16  * furnished to do so, under the terms of the COPYING file.
17  *
18  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19  * KIND, either express or implied.
20  *
21  ***************************************************************************/
22
23 #include "setup.h"
24
25 #ifndef CURL_DISABLE_TFTP
26 /* -- WIN32 approved -- */
27 #include <stdio.h>
28 #include <stdarg.h>
29 #include <stdlib.h>
30 #include <ctype.h>
31
32 #if defined(WIN32)
33 #include <time.h>
34 #include <io.h>
35 #else
36 #ifdef HAVE_SYS_SOCKET_H
37 #include <sys/socket.h>
38 #endif
39 #include <netinet/in.h>
40 #ifdef HAVE_SYS_TIME_H
41 #include <sys/time.h>
42 #endif
43 #ifdef HAVE_UNISTD_H
44 #include <unistd.h>
45 #endif
46 #include <netdb.h>
47 #ifdef HAVE_ARPA_INET_H
48 #include <arpa/inet.h>
49 #endif
50 #ifdef HAVE_NET_IF_H
51 #include <net/if.h>
52 #endif
53 #ifdef HAVE_SYS_IOCTL_H
54 #include <sys/ioctl.h>
55 #endif
56
57 #ifdef HAVE_SYS_PARAM_H
58 #include <sys/param.h>
59 #endif
60
61 #endif /* WIN32 */
62
63 #include "urldata.h"
64 #include <curl/curl.h>
65 #include "transfer.h"
66 #include "sendf.h"
67 #include "tftp.h"
68 #include "progress.h"
69 #include "connect.h"
70 #include "strerror.h"
71 #include "sockaddr.h" /* required for Curl_sockaddr_storage */
72 #include "multiif.h"
73 #include "url.h"
74 #include "rawstr.h"
75
76 #define _MPRINTF_REPLACE /* use our functions only */
77 #include <curl/mprintf.h>
78
79 #include "curl_memory.h"
80 #include "select.h"
81
82 /* The last #include file should be: */
83 #include "memdebug.h"
84
85 /* RFC2348 allows the block size to be negotiated */
86 #define TFTP_BLKSIZE_DEFAULT 512
87 #define TFTP_BLKSIZE_MIN 8
88 #define TFTP_BLKSIZE_MAX 65464
89 #define TFTP_OPTION_BLKSIZE "blksize"
90
91 /* from RFC2349: */
92 #define TFTP_OPTION_TSIZE    "tsize"
93 #define TFTP_OPTION_INTERVAL "timeout"
94
95 typedef enum {
96   TFTP_MODE_NETASCII=0,
97   TFTP_MODE_OCTET
98 } tftp_mode_t;
99
100 typedef enum {
101   TFTP_STATE_START=0,
102   TFTP_STATE_RX,
103   TFTP_STATE_TX,
104   TFTP_STATE_FIN
105 } tftp_state_t;
106
107 typedef enum {
108   TFTP_EVENT_NONE = -1,
109   TFTP_EVENT_INIT = 0,
110   TFTP_EVENT_RRQ = 1,
111   TFTP_EVENT_WRQ = 2,
112   TFTP_EVENT_DATA = 3,
113   TFTP_EVENT_ACK = 4,
114   TFTP_EVENT_ERROR = 5,
115   TFTP_EVENT_OACK = 6,
116   TFTP_EVENT_TIMEOUT
117 } tftp_event_t;
118
119 typedef enum {
120   TFTP_ERR_UNDEF=0,
121   TFTP_ERR_NOTFOUND,
122   TFTP_ERR_PERM,
123   TFTP_ERR_DISKFULL,
124   TFTP_ERR_ILLEGAL,
125   TFTP_ERR_UNKNOWNID,
126   TFTP_ERR_EXISTS,
127   TFTP_ERR_NOSUCHUSER,  /* This will never be triggered by this code */
128
129   /* The remaining error codes are internal to curl */
130   TFTP_ERR_NONE = -100,
131   TFTP_ERR_TIMEOUT,
132   TFTP_ERR_NORESPONSE
133 } tftp_error_t;
134
135 typedef struct tftp_packet {
136   unsigned char *data;
137 } tftp_packet_t;
138
139 typedef struct tftp_state_data {
140   tftp_state_t    state;
141   tftp_mode_t     mode;
142   tftp_error_t    error;
143   tftp_event_t    event;
144   struct connectdata      *conn;
145   curl_socket_t   sockfd;
146   int             retries;
147   int             retry_time;
148   int             retry_max;
149   time_t          start_time;
150   time_t          max_time;
151   time_t          rx_time;
152   unsigned short  block;
153   struct Curl_sockaddr_storage   local_addr;
154   struct Curl_sockaddr_storage   remote_addr;
155   curl_socklen_t  remote_addrlen;
156   int             rbytes;
157   int             sbytes;
158   int             blksize;
159   int             requested_blksize;
160   tftp_packet_t   rpacket;
161   tftp_packet_t   spacket;
162 } tftp_state_data_t;
163
164
165 /* Forward declarations */
166 static CURLcode tftp_rx(tftp_state_data_t *state, tftp_event_t event) ;
167 static CURLcode tftp_tx(tftp_state_data_t *state, tftp_event_t event) ;
168 static CURLcode tftp_connect(struct connectdata *conn, bool *done);
169 static CURLcode tftp_disconnect(struct connectdata *conn);
170 static CURLcode tftp_do(struct connectdata *conn, bool *done);
171 static CURLcode tftp_done(struct connectdata *conn,
172                                CURLcode, bool premature);
173 static CURLcode tftp_setup_connection(struct connectdata * conn);
174 static CURLcode tftp_multi_statemach(struct connectdata *conn, bool *done);
175 static CURLcode tftp_doing(struct connectdata *conn, bool *dophase_done);
176 static int tftp_getsock(struct connectdata *conn, curl_socket_t *socks,
177                         int numsocks);
178 static CURLcode tftp_translate_code(tftp_error_t error);
179
180
181 /*
182  * TFTP protocol handler.
183  */
184
185 const struct Curl_handler Curl_handler_tftp = {
186   "TFTP",                               /* scheme */
187   tftp_setup_connection,                /* setup_connection */
188   tftp_do,                              /* do_it */
189   tftp_done,                            /* done */
190   ZERO_NULL,                            /* do_more */
191   tftp_connect,                         /* connect_it */
192   tftp_multi_statemach,                 /* connecting */
193   tftp_doing,                           /* doing */
194   tftp_getsock,                         /* proto_getsock */
195   tftp_getsock,                         /* doing_getsock */
196   ZERO_NULL,                            /* perform_getsock */
197   tftp_disconnect,                      /* disconnect */
198   PORT_TFTP,                            /* defport */
199   PROT_TFTP                             /* protocol */
200 };
201
202 /**********************************************************
203  *
204  * tftp_set_timeouts -
205  *
206  * Set timeouts based on state machine state.
207  * Use user provided connect timeouts until DATA or ACK
208  * packet is received, then use user-provided transfer timeouts
209  *
210  *
211  **********************************************************/
212 static CURLcode tftp_set_timeouts(tftp_state_data_t *state)
213 {
214   time_t maxtime, timeout;
215   long timeout_ms;
216   bool start = (bool)(state->state == TFTP_STATE_START);
217
218   time(&state->start_time);
219
220   /* Compute drop-dead time */
221   timeout_ms = Curl_timeleft(state->conn, NULL, start);
222
223   if(timeout_ms < 0) {
224     /* time-out, bail out, go home */
225     failf(state->conn->data, "Connection time-out");
226     return CURLE_OPERATION_TIMEDOUT;
227   }
228
229   if(start) {
230
231     maxtime = (time_t)(timeout_ms + 500) / 1000;
232     state->max_time = state->start_time+maxtime;
233
234     /* Set per-block timeout to total */
235     timeout = maxtime ;
236
237     /* Average restart after 5 seconds */
238     state->retry_max = (int)timeout/5;
239
240     if(state->retry_max < 1)
241       /* avoid division by zero below */
242       state->retry_max = 1;
243
244     /* Compute the re-start interval to suit the timeout */
245     state->retry_time = (int)timeout/state->retry_max;
246     if(state->retry_time<1)
247       state->retry_time=1;
248
249   }
250   else {
251     if(timeout_ms > 0)
252       maxtime = (time_t)(timeout_ms + 500) / 1000;
253     else
254       maxtime = 3600;
255
256     state->max_time = state->start_time+maxtime;
257
258     /* Set per-block timeout to 10% of total */
259     timeout = maxtime/10 ;
260
261     /* Average reposting an ACK after 15 seconds */
262     state->retry_max = (int)timeout/15;
263   }
264   /* But bound the total number */
265   if(state->retry_max<3)
266     state->retry_max=3;
267
268   if(state->retry_max>50)
269     state->retry_max=50;
270
271   /* Compute the re-ACK interval to suit the timeout */
272   state->retry_time = (int)(timeout/state->retry_max);
273   if(state->retry_time<1)
274     state->retry_time=1;
275
276   infof(state->conn->data,
277         "set timeouts for state %d; Total %ld, retry %d maxtry %d\n",
278         (int)state->state, (long)(state->max_time-state->start_time),
279         state->retry_time, state->retry_max);
280
281   /* init RX time */
282   time(&state->rx_time);
283
284   return CURLE_OK;
285 }
286
287 /**********************************************************
288  *
289  * tftp_set_send_first
290  *
291  * Event handler for the START state
292  *
293  **********************************************************/
294
295 static void setpacketevent(tftp_packet_t *packet, unsigned short num)
296 {
297   packet->data[0] = (unsigned char)(num >> 8);
298   packet->data[1] = (unsigned char)(num & 0xff);
299 }
300
301
302 static void setpacketblock(tftp_packet_t *packet, unsigned short num)
303 {
304   packet->data[2] = (unsigned char)(num >> 8);
305   packet->data[3] = (unsigned char)(num & 0xff);
306 }
307
308 static unsigned short getrpacketevent(const tftp_packet_t *packet)
309 {
310   return (unsigned short)((packet->data[0] << 8) | packet->data[1]);
311 }
312
313 static unsigned short getrpacketblock(const tftp_packet_t *packet)
314 {
315   return (unsigned short)((packet->data[2] << 8) | packet->data[3]);
316 }
317
318 static size_t Curl_strnlen(const char *string, size_t maxlen)
319 {
320   const char *end = memchr (string, '\0', maxlen);
321   return end ? (size_t) (end - string) : maxlen;
322 }
323
324 static const char *tftp_option_get(const char *buf, size_t len,
325                                    const char **option, const char **value)
326 {
327   size_t loc;
328
329   loc = Curl_strnlen( buf, len );
330   loc++; /* NULL term */
331
332   if (loc >= len)
333     return NULL;
334   *option = buf;
335
336   loc += Curl_strnlen( buf+loc, len-loc );
337   loc++; /* NULL term */
338
339   if (loc > len)
340     return NULL;
341   *value = &buf[strlen(*option) + 1];
342
343   return &buf[loc];
344 }
345
346 static CURLcode tftp_parse_option_ack(tftp_state_data_t *state,
347                                       const char *ptr, int len)
348 {
349   const char *tmp = ptr;
350   struct SessionHandle *data = state->conn->data;
351
352   /* if OACK doesn't contain blksize option, the default (512) must be used */
353   state->blksize = TFTP_BLKSIZE_DEFAULT;
354
355   while (tmp < ptr + len) {
356     const char *option, *value;
357
358     tmp = tftp_option_get(tmp, ptr + len - tmp, &option, &value);
359     if(tmp == NULL) {
360       failf(data, "Malformed ACK packet, rejecting");
361       return CURLE_TFTP_ILLEGAL;
362     }
363
364     infof(data, "got option=(%s) value=(%s)\n", option, value);
365
366     if(checkprefix(option, TFTP_OPTION_BLKSIZE)) {
367       long blksize;
368
369       blksize = strtol( value, NULL, 10 );
370
371       if(!blksize) {
372         failf(data, "invalid blocksize value in OACK packet");
373         return CURLE_TFTP_ILLEGAL;
374       }
375       else if(blksize > TFTP_BLKSIZE_MAX) {
376         failf(data, "%s (%d)", "blksize is larger than max supported",
377                 TFTP_BLKSIZE_MAX);
378         return CURLE_TFTP_ILLEGAL;
379       }
380       else if(blksize < TFTP_BLKSIZE_MIN) {
381         failf(data, "%s (%d)", "blksize is smaller than min supported",
382                 TFTP_BLKSIZE_MIN);
383         return CURLE_TFTP_ILLEGAL;
384       }
385       else if (blksize > state->requested_blksize) {
386         /* could realloc pkt buffers here, but the spec doesn't call out
387          * support for the server requesting a bigger blksize than the client
388          * requests */
389         failf(data, "%s (%ld)",
390                 "server requested blksize larger than allocated", blksize);
391         return CURLE_TFTP_ILLEGAL;
392       }
393
394       state->blksize = (int)blksize;
395       infof(data, "%s (%d) %s (%d)\n", "blksize parsed from OACK",
396         state->blksize, "requested", state->requested_blksize);
397     }
398     else if(checkprefix(option, TFTP_OPTION_TSIZE)) {
399       long tsize = 0;
400
401       tsize = strtol( value, NULL, 10 );
402       infof(data, "%s (%ld)\n", "tsize parsed from OACK", tsize);
403
404       /* tsize should be ignored on upload: Who cares about the size of the
405          remote file? */
406       if (!data->set.upload) {
407         if(!tsize) {
408           failf(data, "invalid tsize -:%s:- value in OACK packet", value);
409           return CURLE_TFTP_ILLEGAL;
410         }
411         Curl_pgrsSetDownloadSize(data, tsize);
412       }
413     }
414   }
415
416   return CURLE_OK;
417 }
418
419 static size_t tftp_option_add(tftp_state_data_t *state, size_t csize,
420                               char *buf, const char *option)
421 {
422   if( ( strlen(option) + csize + 1 ) > (size_t)state->blksize )
423     return 0;
424   strcpy(buf, option);
425   return( strlen(option) + 1 );
426 }
427
428 static CURLcode tftp_connect_for_tx(tftp_state_data_t *state,
429                                     tftp_event_t event)
430 {
431   CURLcode res;
432 #ifndef CURL_DISABLE_VERBOSE_STRINGS
433   struct SessionHandle *data = state->conn->data;
434
435   infof(data, "%s\n", "Connected for transmit");
436 #endif
437   state->state = TFTP_STATE_TX;
438   res = tftp_set_timeouts(state);
439   if(res != CURLE_OK)
440     return(res);
441   return tftp_tx(state, event);
442 }
443
444 static CURLcode tftp_connect_for_rx(tftp_state_data_t *state,
445                                     tftp_event_t event)
446 {
447   CURLcode res;
448 #ifndef CURL_DISABLE_VERBOSE_STRINGS
449   struct SessionHandle *data = state->conn->data;
450
451   infof(data, "%s\n", "Connected for receive");
452 #endif
453   state->state = TFTP_STATE_RX;
454   res = tftp_set_timeouts(state);
455   if(res != CURLE_OK)
456     return(res);
457   return tftp_rx(state, event);
458 }
459
460 static CURLcode tftp_send_first(tftp_state_data_t *state, tftp_event_t event)
461 {
462   size_t sbytes;
463   ssize_t senddata;
464   const char *mode = "octet";
465   char *filename;
466   char buf[64];
467   struct SessionHandle *data = state->conn->data;
468   CURLcode res = CURLE_OK;
469
470   /* Set ascii mode if -B flag was used */
471   if(data->set.prefer_ascii)
472     mode = "netascii";
473
474   switch(event) {
475
476   case TFTP_EVENT_INIT:    /* Send the first packet out */
477   case TFTP_EVENT_TIMEOUT: /* Resend the first packet out */
478     /* Increment the retry counter, quit if over the limit */
479     state->retries++;
480     if(state->retries>state->retry_max) {
481       state->error = TFTP_ERR_NORESPONSE;
482       state->state = TFTP_STATE_FIN;
483       return res;
484     }
485
486     if(data->set.upload) {
487       /* If we are uploading, send an WRQ */
488       setpacketevent(&state->spacket, TFTP_EVENT_WRQ);
489       state->conn->data->req.upload_fromhere =
490         (char *)state->spacket.data+4;
491       if(data->set.infilesize != -1)
492         Curl_pgrsSetUploadSize(data, data->set.infilesize);
493     }
494     else {
495       /* If we are downloading, send an RRQ */
496       setpacketevent(&state->spacket, TFTP_EVENT_RRQ);
497     }
498     /* As RFC3617 describes the separator slash is not actually part of the
499        file name so we skip the always-present first letter of the path
500        string. */
501     filename = curl_easy_unescape(data, &state->conn->data->state.path[1], 0,
502                                   NULL);
503     if(!filename)
504       return CURLE_OUT_OF_MEMORY;
505
506     snprintf((char *)state->spacket.data+2,
507              state->blksize,
508              "%s%c%s%c", filename, '\0',  mode, '\0');
509     sbytes = 4 + strlen(filename) + strlen(mode);
510
511     /* add tsize option */
512     if(data->set.upload && (data->set.infilesize != -1))
513       snprintf( buf, sizeof(buf), "%" FORMAT_OFF_T, data->set.infilesize );
514     else
515       strcpy(buf, "0"); /* the destination is large enough */
516
517     sbytes += tftp_option_add(state, sbytes,
518                               (char *)state->spacket.data+sbytes,
519                               TFTP_OPTION_TSIZE);
520     sbytes += tftp_option_add(state, sbytes,
521                               (char *)state->spacket.data+sbytes, buf);
522     /* add blksize option */
523     snprintf( buf, sizeof(buf), "%d", state->requested_blksize );
524     sbytes += tftp_option_add(state, sbytes,
525                               (char *)state->spacket.data+sbytes,
526                               TFTP_OPTION_BLKSIZE);
527     sbytes += tftp_option_add(state, sbytes,
528                               (char *)state->spacket.data+sbytes, buf );
529     /* add timeout option, this is the max time the session may live */
530     snprintf( buf, sizeof(buf), "%d", state->retry_time*state->retry_max );
531     sbytes += tftp_option_add(state, sbytes,
532                               (char *)state->spacket.data+sbytes,
533                               TFTP_OPTION_INTERVAL);
534     sbytes += tftp_option_add(state, sbytes,
535                               (char *)state->spacket.data+sbytes, buf );
536
537     senddata = sendto(state->sockfd, (void *)state->spacket.data,
538                     sbytes, 0,
539                     state->conn->ip_addr->ai_addr,
540                     state->conn->ip_addr->ai_addrlen);
541     if(senddata != (ssize_t)sbytes) {
542       failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
543     }
544     Curl_safefree(filename);
545     break;
546
547   case TFTP_EVENT_OACK:
548     if(data->set.upload) {
549       res = tftp_connect_for_tx(state, event);
550     }
551     else {
552       res = tftp_connect_for_rx(state, event);
553     }
554     break;
555
556   case TFTP_EVENT_ACK: /* Connected for transmit */
557     res = tftp_connect_for_tx(state, event);
558     break;
559
560   case TFTP_EVENT_DATA: /* Connected for receive */
561     res = tftp_connect_for_rx(state, event);
562     break;
563
564   case TFTP_EVENT_ERROR:
565     state->state = TFTP_STATE_FIN;
566     break;
567
568   default:
569     failf(state->conn->data, "tftp_send_first: internal error");
570     break;
571   }
572   return res;
573 }
574
575 /* the next blocknum is x + 1 but it needs to wrap at an unsigned 16bit
576    boundary */
577 #define NEXT_BLOCKNUM(x) (((x)+1)&0xffff)
578
579 /**********************************************************
580  *
581  * tftp_rx
582  *
583  * Event handler for the RX state
584  *
585  **********************************************************/
586 static CURLcode tftp_rx(tftp_state_data_t *state, tftp_event_t event)
587 {
588   ssize_t sbytes;
589   int rblock;
590   struct SessionHandle *data = state->conn->data;
591
592   switch(event) {
593
594   case TFTP_EVENT_DATA:
595     /* Is this the block we expect? */
596     rblock = getrpacketblock(&state->rpacket);
597     if(NEXT_BLOCKNUM(state->block) != rblock) {
598       /* No, log it, up the retry count and fail if over the limit */
599       infof(data,
600             "Received unexpected DATA packet block %d\n", rblock);
601       state->retries++;
602       if(state->retries>state->retry_max) {
603         failf(data, "tftp_rx: giving up waiting for block %d",
604               NEXT_BLOCKNUM(state->block));
605         return CURLE_TFTP_ILLEGAL;
606       }
607     }
608     /* This is the expected block.  Reset counters and ACK it. */
609     state->block = (unsigned short)rblock;
610     state->retries = 0;
611     setpacketevent(&state->spacket, TFTP_EVENT_ACK);
612     setpacketblock(&state->spacket, state->block);
613     sbytes = sendto(state->sockfd, (void *)state->spacket.data,
614                     4, SEND_4TH_ARG,
615                     (struct sockaddr *)&state->remote_addr,
616                     state->remote_addrlen);
617     if(sbytes < 0) {
618       failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
619       return CURLE_SEND_ERROR;
620     }
621
622     /* Check if completed (That is, a less than full packet is received) */
623     if(state->rbytes < (ssize_t)state->blksize+4){
624       state->state = TFTP_STATE_FIN;
625     }
626     else {
627       state->state = TFTP_STATE_RX;
628     }
629     time(&state->rx_time);
630     break;
631
632   case TFTP_EVENT_OACK:
633     /* ACK option acknowledgement so we can move on to data */
634     state->block = 0;
635     state->retries = 0;
636     setpacketevent(&state->spacket, TFTP_EVENT_ACK);
637     setpacketblock(&state->spacket, state->block);
638     sbytes = sendto(state->sockfd, (void *)state->spacket.data,
639                     4, SEND_4TH_ARG,
640                     (struct sockaddr *)&state->remote_addr,
641                     state->remote_addrlen);
642     if(sbytes < 0) {
643       failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
644       return CURLE_SEND_ERROR;
645     }
646
647     /* we're ready to RX data */
648     state->state = TFTP_STATE_RX;
649     time(&state->rx_time);
650     break;
651
652   case TFTP_EVENT_TIMEOUT:
653     /* Increment the retry count and fail if over the limit */
654     state->retries++;
655     infof(data,
656           "Timeout waiting for block %d ACK.  Retries = %d\n",
657           NEXT_BLOCKNUM(state->block), state->retries);
658     if(state->retries > state->retry_max) {
659       state->error = TFTP_ERR_TIMEOUT;
660       state->state = TFTP_STATE_FIN;
661     }
662     else {
663       /* Resend the previous ACK */
664       sbytes = sendto(state->sockfd, (void *)state->spacket.data,
665                       4, SEND_4TH_ARG,
666                       (struct sockaddr *)&state->remote_addr,
667                       state->remote_addrlen);
668       if(sbytes<0) {
669         failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
670         return CURLE_SEND_ERROR;
671       }
672     }
673     break;
674
675   case TFTP_EVENT_ERROR:
676     setpacketevent(&state->spacket, TFTP_EVENT_ERROR);
677     setpacketblock(&state->spacket, state->block);
678     (void)sendto(state->sockfd, (void *)state->spacket.data,
679                  4, SEND_4TH_ARG,
680                  (struct sockaddr *)&state->remote_addr,
681                  state->remote_addrlen);
682     /* don't bother with the return code, but if the socket is still up we
683      * should be a good TFTP client and let the server know we're done */
684     state->state = TFTP_STATE_FIN;
685     break;
686
687   default:
688     failf(data, "%s", "tftp_rx: internal error");
689     return CURLE_TFTP_ILLEGAL; /* not really the perfect return code for
690                                   this */
691   }
692   return CURLE_OK;
693 }
694
695 /**********************************************************
696  *
697  * tftp_tx
698  *
699  * Event handler for the TX state
700  *
701  **********************************************************/
702 static CURLcode tftp_tx(tftp_state_data_t *state, tftp_event_t event)
703 {
704   struct SessionHandle *data = state->conn->data;
705   ssize_t sbytes;
706   int rblock;
707   CURLcode res = CURLE_OK;
708   struct SingleRequest *k = &data->req;
709
710   switch(event) {
711
712   case TFTP_EVENT_ACK:
713   case TFTP_EVENT_OACK:
714     if (event == TFTP_EVENT_ACK) {
715        /* Ack the packet */
716        rblock = getrpacketblock(&state->rpacket);
717
718        if(rblock != state->block) {
719           /* This isn't the expected block.  Log it and up the retry counter */
720           infof(data, "Received ACK for block %d, expecting %d\n",
721                 rblock, state->block);
722           state->retries++;
723           /* Bail out if over the maximum */
724           if(state->retries>state->retry_max) {
725              failf(data, "tftp_tx: giving up waiting for block %d ack",
726                    state->block);
727              res = CURLE_SEND_ERROR;
728           }
729           else {
730              /* Re-send the data packet */
731              sbytes = sendto(state->sockfd, (void *)&state->spacket,
732                              4+state->sbytes, SEND_4TH_ARG,
733                              (struct sockaddr *)&state->remote_addr,
734                              state->remote_addrlen);
735              /* Check all sbytes were sent */
736              if(sbytes<0) {
737                 failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
738                 res = CURLE_SEND_ERROR;
739              }
740           }
741           return res;
742        }
743        /* This is the expected packet.  Reset the counters and send the next
744           block */
745        time(&state->rx_time);
746        state->block++;
747     }
748     else {
749        state->block = 1; /* first data block is 1 when using OACK */
750     }
751     state->retries = 0;
752     setpacketevent(&state->spacket, TFTP_EVENT_DATA);
753     setpacketblock(&state->spacket, state->block);
754     if(state->block > 1 && state->sbytes < (int)state->blksize) {
755       state->state = TFTP_STATE_FIN;
756       return CURLE_OK;
757     }
758     res = Curl_fillreadbuffer(state->conn, (size_t)state->blksize,
759                               &state->sbytes);
760     if(res)
761       return res;
762     sbytes = sendto(state->sockfd, (void *)state->spacket.data,
763                     4+state->sbytes, SEND_4TH_ARG,
764                     (struct sockaddr *)&state->remote_addr,
765                     state->remote_addrlen);
766     /* Check all sbytes were sent */
767     if(sbytes<0) {
768       failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
769       return CURLE_SEND_ERROR;
770     }
771     /* Update the progress meter */
772     k->writebytecount += state->sbytes;
773     Curl_pgrsSetUploadCounter(data, k->writebytecount);
774     break;
775
776   case TFTP_EVENT_TIMEOUT:
777     /* Increment the retry counter and log the timeout */
778     state->retries++;
779     infof(data, "Timeout waiting for block %d ACK. "
780           " Retries = %d\n", NEXT_BLOCKNUM(state->block), state->retries);
781     /* Decide if we've had enough */
782     if(state->retries > state->retry_max) {
783       state->error = TFTP_ERR_TIMEOUT;
784       state->state = TFTP_STATE_FIN;
785     }
786     else {
787       /* Re-send the data packet */
788       sbytes = sendto(state->sockfd, (void *)state->spacket.data,
789                       4+state->sbytes, SEND_4TH_ARG,
790                       (struct sockaddr *)&state->remote_addr,
791                       state->remote_addrlen);
792       /* Check all sbytes were sent */
793       if(sbytes<0) {
794         failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
795         return CURLE_SEND_ERROR;
796       }
797       /* since this was a re-send, we remain at the still byte position */
798       Curl_pgrsSetUploadCounter(data, k->writebytecount);
799     }
800     break;
801
802   case TFTP_EVENT_ERROR:
803     state->state = TFTP_STATE_FIN;
804     setpacketevent(&state->spacket, TFTP_EVENT_ERROR);
805     setpacketblock(&state->spacket, state->block);
806     (void)sendto(state->sockfd, (void *)state->spacket.data, 4, SEND_4TH_ARG,
807                  (struct sockaddr *)&state->remote_addr,
808                  state->remote_addrlen);
809     /* don't bother with the return code, but if the socket is still up we
810      * should be a good TFTP client and let the server know we're done */
811     state->state = TFTP_STATE_FIN;
812     break;
813
814   default:
815     failf(data, "tftp_tx: internal error, event: %i", (int)(event));
816     break;
817   }
818
819   return res;
820 }
821
822 /**********************************************************
823  *
824  * tftp_translate_code
825  *
826  * Translate internal error codes to CURL error codes
827  *
828  **********************************************************/
829 static CURLcode tftp_translate_code(tftp_error_t error)
830 {
831   CURLcode code = CURLE_OK;
832
833   if(error != TFTP_ERR_NONE) {
834     switch(error) {
835     case TFTP_ERR_NOTFOUND:
836       code = CURLE_TFTP_NOTFOUND;
837       break;
838     case TFTP_ERR_PERM:
839       code = CURLE_TFTP_PERM;
840       break;
841     case TFTP_ERR_DISKFULL:
842       code = CURLE_REMOTE_DISK_FULL;
843       break;
844     case TFTP_ERR_UNDEF:
845     case TFTP_ERR_ILLEGAL:
846       code = CURLE_TFTP_ILLEGAL;
847       break;
848     case TFTP_ERR_UNKNOWNID:
849       code = CURLE_TFTP_UNKNOWNID;
850       break;
851     case TFTP_ERR_EXISTS:
852       code = CURLE_REMOTE_FILE_EXISTS;
853       break;
854     case TFTP_ERR_NOSUCHUSER:
855       code = CURLE_TFTP_NOSUCHUSER;
856       break;
857     case TFTP_ERR_TIMEOUT:
858       code = CURLE_OPERATION_TIMEDOUT;
859       break;
860     case TFTP_ERR_NORESPONSE:
861       code = CURLE_COULDNT_CONNECT;
862       break;
863     default:
864       code= CURLE_ABORTED_BY_CALLBACK;
865       break;
866     }
867   }
868   else {
869     code = CURLE_OK;
870   }
871
872   return(code);
873 }
874
875 /**********************************************************
876  *
877  * tftp_state_machine
878  *
879  * The tftp state machine event dispatcher
880  *
881  **********************************************************/
882 static CURLcode tftp_state_machine(tftp_state_data_t *state,
883                                    tftp_event_t event)
884 {
885   CURLcode res = CURLE_OK;
886   struct SessionHandle *data = state->conn->data;
887   switch(state->state) {
888   case TFTP_STATE_START:
889     DEBUGF(infof(data, "TFTP_STATE_START\n"));
890     res = tftp_send_first(state, event);
891     break;
892   case TFTP_STATE_RX:
893     DEBUGF(infof(data, "TFTP_STATE_RX\n"));
894     res = tftp_rx(state, event);
895     break;
896   case TFTP_STATE_TX:
897     DEBUGF(infof(data, "TFTP_STATE_TX\n"));
898     res = tftp_tx(state, event);
899     break;
900   case TFTP_STATE_FIN:
901     infof(data, "%s\n", "TFTP finished");
902     break;
903   default:
904     DEBUGF(infof(data, "STATE: %d\n", state->state));
905     failf(data, "%s", "Internal state machine error");
906     res = CURLE_TFTP_ILLEGAL;
907     break;
908   }
909   return res;
910 }
911
912 /**********************************************************
913  *
914  * tftp_disconnect
915  *
916  * The disconnect callback
917  *
918  **********************************************************/
919 static CURLcode tftp_disconnect(struct connectdata *conn)
920 {
921   tftp_state_data_t *state = conn->proto.tftpc;
922
923   /* done, free dynamically allocated pkt buffers */
924   if(state) {
925     Curl_safefree(state->rpacket.data);
926     Curl_safefree(state->spacket.data);
927     free(state);
928   }
929
930   return CURLE_OK;
931 }
932
933 /**********************************************************
934  *
935  * tftp_connect
936  *
937  * The connect callback
938  *
939  **********************************************************/
940 static CURLcode tftp_connect(struct connectdata *conn, bool *done)
941 {
942   CURLcode code;
943   tftp_state_data_t *state;
944   int blksize, rc;
945
946   blksize = TFTP_BLKSIZE_DEFAULT;
947
948   /* If there already is a protocol-specific struct allocated for this
949      sessionhandle, deal with it */
950   Curl_reset_reqproto(conn);
951
952   state = conn->proto.tftpc = calloc(1, sizeof(tftp_state_data_t));
953   if(!state)
954     return CURLE_OUT_OF_MEMORY;
955
956   /* alloc pkt buffers based on specified blksize */
957   if(conn->data->set.tftp_blksize) {
958     blksize = (int)conn->data->set.tftp_blksize;
959     if(blksize > TFTP_BLKSIZE_MAX || blksize < TFTP_BLKSIZE_MIN )
960       return CURLE_TFTP_ILLEGAL;
961   }
962
963   if(!state->rpacket.data) {
964     state->rpacket.data = calloc(1, blksize + 2 + 2);
965
966     if(!state->rpacket.data)
967       return CURLE_OUT_OF_MEMORY;
968   }
969
970   if(!state->spacket.data) {
971     state->spacket.data = calloc(1, blksize + 2 + 2);
972
973     if(!state->spacket.data)
974       return CURLE_OUT_OF_MEMORY;
975   }
976
977   conn->bits.close = TRUE; /* we don't keep TFTP connections up bascially
978                               because there's none or very little gain for UDP
979                            */
980
981   state->conn = conn;
982   state->sockfd = state->conn->sock[FIRSTSOCKET];
983   state->state = TFTP_STATE_START;
984   state->error = TFTP_ERR_NONE;
985   state->blksize = TFTP_BLKSIZE_DEFAULT;
986   state->requested_blksize = blksize;
987
988   ((struct sockaddr *)&state->local_addr)->sa_family =
989     (unsigned short)(conn->ip_addr->ai_family);
990
991   tftp_set_timeouts(state);
992
993   if(!conn->bits.bound) {
994     /* If not already bound, bind to any interface, random UDP port. If it is
995      * reused or a custom local port was desired, this has already been done!
996      *
997      * We once used the size of the local_addr struct as the third argument
998      * for bind() to better work with IPv6 or whatever size the struct could
999      * have, but we learned that at least Tru64, AIX and IRIX *requires* the
1000      * size of that argument to match the exact size of a 'sockaddr_in' struct
1001      * when running IPv4-only.
1002      *
1003      * Therefore we use the size from the address we connected to, which we
1004      * assume uses the same IP version and thus hopefully this works for both
1005      * IPv4 and IPv6...
1006      */
1007     rc = bind(state->sockfd, (struct sockaddr *)&state->local_addr,
1008               conn->ip_addr->ai_addrlen);
1009     if(rc) {
1010       failf(conn->data, "bind() failed; %s",
1011             Curl_strerror(conn, SOCKERRNO));
1012       return CURLE_COULDNT_CONNECT;
1013     }
1014     conn->bits.bound = TRUE;
1015   }
1016
1017   Curl_pgrsStartNow(conn->data);
1018
1019   *done = TRUE;
1020   code = CURLE_OK;
1021   return(code);
1022 }
1023
1024 /**********************************************************
1025  *
1026  * tftp_done
1027  *
1028  * The done callback
1029  *
1030  **********************************************************/
1031 static CURLcode tftp_done(struct connectdata *conn, CURLcode status,
1032                                bool premature)
1033 {
1034   CURLcode code = CURLE_OK;
1035   tftp_state_data_t *state = (tftp_state_data_t *)conn->proto.tftpc;
1036
1037   (void)status; /* unused */
1038   (void)premature; /* not used */
1039
1040   Curl_pgrsDone(conn);
1041
1042   /* If we have encountered an error */
1043   code = tftp_translate_code(state->error);
1044
1045   return code;
1046 }
1047
1048 /**********************************************************
1049  *
1050  * tftp_getsock
1051  *
1052  * The getsock callback
1053  *
1054  **********************************************************/
1055 static int tftp_getsock(struct connectdata *conn, curl_socket_t *socks,
1056                        int numsocks)
1057 {
1058   if(!numsocks)
1059     return GETSOCK_BLANK;
1060
1061   socks[0] = conn->sock[FIRSTSOCKET];
1062
1063   return GETSOCK_READSOCK(0);
1064 }
1065
1066 /**********************************************************
1067  *
1068  * tftp_receive_packet
1069  *
1070  * Called once select fires and data is ready on the socket
1071  *
1072  **********************************************************/
1073 static CURLcode tftp_receive_packet(struct connectdata *conn)
1074 {
1075   struct Curl_sockaddr_storage fromaddr;
1076   curl_socklen_t        fromlen;
1077   CURLcode              result = CURLE_OK;
1078   struct SessionHandle  *data = conn->data;
1079   tftp_state_data_t     *state = (tftp_state_data_t *)conn->proto.tftpc;
1080   struct SingleRequest  *k = &data->req;
1081
1082   /* Receive the packet */
1083   fromlen = sizeof(fromaddr);
1084   state->rbytes = (int)recvfrom(state->sockfd,
1085                                    (void *)state->rpacket.data,
1086                                    state->blksize+4,
1087                                    0,
1088                                    (struct sockaddr *)&fromaddr,
1089                                    &fromlen);
1090   if(state->remote_addrlen==0) {
1091     memcpy(&state->remote_addr, &fromaddr, fromlen);
1092     state->remote_addrlen = fromlen;
1093   }
1094
1095   /* Sanity check packet length */
1096   if(state->rbytes < 4) {
1097     failf(data, "Received too short packet");
1098     /* Not a timeout, but how best to handle it? */
1099     state->event = TFTP_EVENT_TIMEOUT;
1100   }
1101   else {
1102     /* The event is given by the TFTP packet time */
1103     state->event = (tftp_event_t)getrpacketevent(&state->rpacket);
1104
1105     switch(state->event) {
1106     case TFTP_EVENT_DATA:
1107       /* Don't pass to the client empty or retransmitted packets */
1108       if(state->rbytes > 4 &&
1109          (NEXT_BLOCKNUM(state->block) == getrpacketblock(&state->rpacket))) {
1110         result = Curl_client_write(conn, CLIENTWRITE_BODY,
1111                                    (char *)state->rpacket.data+4,
1112                                    state->rbytes-4);
1113         if(result) {
1114           tftp_state_machine(state, TFTP_EVENT_ERROR);
1115           return result;
1116         }
1117         k->bytecount += state->rbytes-4;
1118         Curl_pgrsSetDownloadCounter(data, (curl_off_t) k->bytecount);
1119       }
1120       break;
1121     case TFTP_EVENT_ERROR:
1122       state->error = (tftp_error_t)getrpacketblock(&state->rpacket);
1123       infof(data, "%s\n", (const char *)state->rpacket.data+4);
1124       break;
1125     case TFTP_EVENT_ACK:
1126       break;
1127     case TFTP_EVENT_OACK:
1128       result = tftp_parse_option_ack(state,
1129                                    (const char *)state->rpacket.data+2,
1130                                    state->rbytes-2);
1131       if(result)
1132         return result;
1133       break;
1134     case TFTP_EVENT_RRQ:
1135     case TFTP_EVENT_WRQ:
1136     default:
1137       failf(data, "%s", "Internal error: Unexpected packet");
1138       break;
1139     }
1140
1141     /* Update the progress meter */
1142     if(Curl_pgrsUpdate(conn)) {
1143       tftp_state_machine(state, TFTP_EVENT_ERROR);
1144       return CURLE_ABORTED_BY_CALLBACK;
1145     }
1146   }
1147   return result;
1148 }
1149
1150 /**********************************************************
1151  *
1152  * tftp_state_timeout
1153  *
1154  * Check if timeouts have been reached
1155  *
1156  **********************************************************/
1157 static long tftp_state_timeout(struct connectdata *conn, tftp_event_t *event)
1158 {
1159   time_t                current;
1160   tftp_state_data_t     *state = (tftp_state_data_t *)conn->proto.tftpc;
1161
1162   if (event)
1163     *event = TFTP_EVENT_NONE;
1164
1165   time(&current);
1166   if(current > state->max_time) {
1167     DEBUGF(infof(conn->data, "timeout: %ld > %ld\n",
1168                  (long)current, (long)state->max_time));
1169     state->error = TFTP_ERR_TIMEOUT;
1170     state->state = TFTP_STATE_FIN;
1171     return(0);
1172   }
1173   else if (current > state->rx_time+state->retry_time) {
1174     if (event)
1175       *event = TFTP_EVENT_TIMEOUT;
1176     time(&state->rx_time); /* update even though we received nothing */
1177     return(state->max_time-current);
1178   }
1179   else {
1180     return(state->max_time-current);
1181   }
1182 }
1183
1184
1185 /**********************************************************
1186  *
1187  * tftp_easy_statemach
1188  *
1189  * Handle easy request until completion
1190  *
1191  **********************************************************/
1192 static CURLcode tftp_easy_statemach(struct connectdata *conn)
1193 {
1194   int                   rc;
1195   int                   check_time = 0;
1196   CURLcode              result = CURLE_OK;
1197   struct SessionHandle  *data = conn->data;
1198   tftp_state_data_t     *state = (tftp_state_data_t *)conn->proto.tftpc;
1199   int                   fd_read;
1200   long                  timeout_ms;
1201   struct SingleRequest  *k = &data->req;
1202   struct timeval        transaction_start = Curl_tvnow();
1203
1204   k->start = transaction_start;
1205   k->now = transaction_start;
1206
1207   /* Run the TFTP State Machine */
1208   for(; (state->state != TFTP_STATE_FIN) && (result == CURLE_OK); ) {
1209
1210     timeout_ms = state->retry_time * 1000;
1211
1212     if (data->set.upload) {
1213       if (data->set.max_send_speed &&
1214           (data->progress.ulspeed > data->set.max_send_speed)) {
1215         fd_read = CURL_SOCKET_BAD;
1216         timeout_ms = Curl_sleep_time(data->set.max_send_speed,
1217                                      data->progress.ulspeed, state->blksize);
1218       }
1219       else {
1220         fd_read = state->sockfd;
1221       }
1222     }
1223     else {
1224       if (data->set.max_recv_speed &&
1225           (data->progress.dlspeed > data->set.max_recv_speed)) {
1226         fd_read = CURL_SOCKET_BAD;
1227         timeout_ms = Curl_sleep_time(data->set.max_recv_speed,
1228                                      data->progress.dlspeed, state->blksize);
1229       }
1230       else {
1231         fd_read = state->sockfd;
1232       }
1233     }
1234
1235     if(data->set.timeout) {
1236       timeout_ms = data->set.timeout - Curl_tvdiff(k->now, k->start);
1237       if (timeout_ms > state->retry_time * 1000)
1238         timeout_ms = state->retry_time * 1000;
1239       else if(timeout_ms < 0)
1240         timeout_ms = 0;
1241     }
1242
1243
1244     /* Wait until ready to read or timeout occurs */
1245     rc = Curl_socket_ready(fd_read, CURL_SOCKET_BAD, (int)(timeout_ms));
1246
1247     k->now = Curl_tvnow();
1248
1249     /* Force a progress callback if it's been too long */
1250     if (Curl_tvdiff(k->now, k->start) >= data->set.timeout) {
1251        if(Curl_pgrsUpdate(conn)) {
1252           tftp_state_machine(state, TFTP_EVENT_ERROR);
1253           return CURLE_ABORTED_BY_CALLBACK;
1254        }
1255        k->start = k->now;
1256     }
1257
1258     if(rc == -1) {
1259       /* bail out */
1260       int error = SOCKERRNO;
1261       failf(data, "%s", Curl_strerror(conn, error));
1262       state->event = TFTP_EVENT_ERROR;
1263     }
1264     else {
1265
1266       if(rc==0) {
1267         /* A timeout occured, but our timeout is variable, so maybe
1268            just continue? */
1269         long rtms = state->retry_time * 1000;
1270         if (Curl_tvdiff(k->now, transaction_start) > rtms) {
1271           state->event = TFTP_EVENT_TIMEOUT;
1272           /* Force a look at transfer timeouts */
1273           check_time = 1;
1274         }
1275         else {
1276           continue; /* skip state machine */
1277         }
1278       }
1279       else {
1280         result = tftp_receive_packet(conn);
1281         if (result == CURLE_OK)
1282            transaction_start = Curl_tvnow();
1283
1284         if(k->bytecountp)
1285           *k->bytecountp = k->bytecount; /* read count */
1286         if(k->writebytecountp)
1287           *k->writebytecountp = k->writebytecount; /* write count */
1288       }
1289     }
1290
1291     if(check_time) {
1292       tftp_state_timeout(conn, NULL);
1293       check_time = 0;
1294     }
1295
1296     if(result)
1297       return(result);
1298
1299     result = tftp_state_machine(state, state->event);
1300   }
1301
1302   /* Tell curl we're done */
1303   Curl_setup_transfer(conn, -1, -1, FALSE, NULL, -1, NULL);
1304
1305   return(result);
1306 }
1307
1308 /**********************************************************
1309  *
1310  * tftp_multi_statemach
1311  *
1312  * Handle single RX socket event and return
1313  *
1314  **********************************************************/
1315 static CURLcode tftp_multi_statemach(struct connectdata *conn, bool *done)
1316 {
1317   int                   rc;
1318   tftp_event_t          event;
1319   CURLcode              result = CURLE_OK;
1320   struct SessionHandle  *data = conn->data;
1321   tftp_state_data_t     *state = (tftp_state_data_t *)conn->proto.tftpc;
1322   long                  timeout_ms = tftp_state_timeout(conn, &event);
1323
1324   *done = FALSE;
1325
1326   if(timeout_ms <= 0) {
1327     failf(data, "TFTP response timeout");
1328     return CURLE_OPERATION_TIMEDOUT;
1329   }
1330   else if (event != TFTP_EVENT_NONE) {
1331     result = tftp_state_machine(state, event);
1332     if(result != CURLE_OK)
1333       return(result);
1334     *done = (bool)(state->state == TFTP_STATE_FIN);
1335     if(*done)
1336       /* Tell curl we're done */
1337       Curl_setup_transfer(conn, -1, -1, FALSE, NULL, -1, NULL);
1338   }
1339   else {
1340     /* no timeouts to handle, check our socket */
1341     rc = Curl_socket_ready(state->sockfd, CURL_SOCKET_BAD, 0);
1342
1343     if(rc == -1) {
1344       /* bail out */
1345       int error = SOCKERRNO;
1346       failf(data, "%s", Curl_strerror(conn, error));
1347       state->event = TFTP_EVENT_ERROR;
1348     }
1349     else if(rc != 0) {
1350       result = tftp_receive_packet(conn);
1351       if(result != CURLE_OK)
1352         return(result);
1353       result = tftp_state_machine(state, state->event);
1354       if(result != CURLE_OK)
1355         return(result);
1356       *done = (bool)(state->state == TFTP_STATE_FIN);
1357       if(*done)
1358         /* Tell curl we're done */
1359         Curl_setup_transfer(conn, -1, -1, FALSE, NULL, -1, NULL);
1360     }
1361     /* if rc == 0, then select() timed out */
1362   }
1363
1364   return result;
1365 }
1366
1367 /**********************************************************
1368  *
1369  * tftp_doing
1370  *
1371  * Called from multi.c while DOing
1372  *
1373  **********************************************************/
1374 static CURLcode tftp_doing(struct connectdata *conn, bool *dophase_done)
1375 {
1376   CURLcode result;
1377   result = tftp_multi_statemach(conn, dophase_done);
1378
1379   if(*dophase_done) {
1380     DEBUGF(infof(conn->data, "DO phase is complete\n"));
1381   }
1382   return result;
1383 }
1384
1385 /**********************************************************
1386  *
1387  * tftp_peform
1388  *
1389  * Entry point for transfer from tftp_do, sarts state mach
1390  *
1391  **********************************************************/
1392 static CURLcode tftp_perform(struct connectdata *conn, bool *dophase_done)
1393 {
1394   CURLcode              result = CURLE_OK;
1395   tftp_state_data_t     *state = (tftp_state_data_t *)conn->proto.tftpc;
1396
1397   *dophase_done = FALSE;
1398
1399   result = tftp_state_machine(state, TFTP_EVENT_INIT);
1400
1401   if(state->state == TFTP_STATE_FIN || result != CURLE_OK)
1402     return(result);
1403
1404   if(conn->data->state.used_interface == Curl_if_multi)
1405     tftp_multi_statemach(conn, dophase_done);
1406   else {
1407     result = tftp_easy_statemach(conn);
1408     *dophase_done = TRUE; /* with the easy interface we are done here */
1409   }
1410
1411   if(*dophase_done)
1412     DEBUGF(infof(conn->data, "DO phase is complete\n"));
1413
1414   return result;
1415 }
1416
1417
1418 /**********************************************************
1419  *
1420  * tftp_do
1421  *
1422  * The do callback
1423  *
1424  * This callback initiates the TFTP transfer
1425  *
1426  **********************************************************/
1427
1428 static CURLcode tftp_do(struct connectdata *conn, bool *done)
1429 {
1430   tftp_state_data_t     *state;
1431   CURLcode              code;
1432
1433   *done = FALSE;
1434
1435   /*
1436     Since connections can be re-used between SessionHandles, this might be a
1437     connection already existing but on a fresh SessionHandle struct so we must
1438     make sure we have a good 'struct TFTP' to play with. For new connections,
1439     the struct TFTP is allocated and setup in the tftp_connect() function.
1440   */
1441   Curl_reset_reqproto(conn);
1442
1443   if(!conn->proto.tftpc) {
1444     code = tftp_connect(conn, done);
1445     if(code)
1446       return code;
1447   }
1448   state = (tftp_state_data_t *)conn->proto.tftpc;
1449
1450   code = tftp_perform(conn, done);
1451
1452   /* If tftp_perform() returned an error, use that for return code. If it
1453      was OK, see if tftp_translate_code() has an error. */
1454   if (code == CURLE_OK) 
1455     /* If we have encountered an internal tftp error, translate it. */
1456     code = tftp_translate_code(state->error);
1457
1458   return code;
1459 }
1460
1461 static CURLcode tftp_setup_connection(struct connectdata * conn)
1462 {
1463   struct SessionHandle *data = conn->data;
1464   char * type;
1465   char command;
1466
1467   conn->socktype = SOCK_DGRAM;   /* UDP datagram based */
1468
1469   /* TFTP URLs support an extension like ";mode=<typecode>" that
1470    * we'll try to get now! */
1471   type = strstr(data->state.path, ";mode=");
1472
1473   if(!type)
1474     type = strstr(conn->host.rawalloc, ";mode=");
1475
1476   if(type) {
1477     *type = 0;                   /* it was in the middle of the hostname */
1478     command = Curl_raw_toupper(type[6]);
1479
1480     switch (command) {
1481     case 'A': /* ASCII mode */
1482     case 'N': /* NETASCII mode */
1483       data->set.prefer_ascii = TRUE;
1484       break;
1485
1486     case 'O': /* octet mode */
1487     case 'I': /* binary mode */
1488     default:
1489       /* switch off ASCII */
1490       data->set.prefer_ascii = FALSE;
1491       break;
1492     }
1493   }
1494
1495   return CURLE_OK;
1496 }
1497 #endif