[BusyBox] [PATCH] tftp blocksize support
Magnus Damm
damm at opensource.se
Thu Oct 4 07:11:02 UTC 2001
Hi all,
Here's a patch for the tftp client!
Changes:
Support for blocksize negotiation. (RFC2347 + RFC2348)
Moved back the opcode constants for readability.
Option parsing via getopt now works correctly.
Usage.h now supports -b optionally.
Usage:
You need to set BB_FEATURE_TFTP_BLOCKSIZE in Config.h
and use the -b option to select blocksize. If the server
doesn't support the blocksize option you will get a
warning and the client will go back to use standard
512-octets blocks.
Testing:
The tftp-client has been tested on PowerPC and x86 targets,
but only against the following servers:
utftpd-0.2.4 (x86) - supports blocksize.
atftp-0.2 (x86) - supports blocksize.
tftpd-0.10-1 (debian-2.2, x86) - no blocksize support.
PumpKIN (Windows) - no blocksize support.
Code size:
With BB_FEATURE_TFTP_BLOCKSIZE is defined,
the busybox binary will get 704 bytes bigger (x86),
otherwise the code size is unchanged.
The patch:
This patch is made against the 0.60.1 release.
The CVS version of usage.h will not get patched cleanly.
Feedback is very welcome.
Cheers /
magnus
-------------- next part --------------
diff -urN busybox-0.60.1/Config.h busybox-0.60.1-tftp/Config.h
--- busybox-0.60.1/Config.h Fri Aug 24 00:14:30 2001
+++ busybox-0.60.1-tftp/Config.h Thu Oct 4 13:57:52 2001
@@ -372,6 +372,7 @@
// Tell tftp what commands that should be supported.
#define BB_FEATURE_TFTP_PUT
#define BB_FEATURE_TFTP_GET
+//#define BB_FEATURE_TFTP_BLOCKSIZE
//
// features for vi
#define BB_FEATURE_VI_COLON // ":" colon commands, no "ex" mode
diff -urN busybox-0.60.1/tftp.c busybox-0.60.1-tftp/tftp.c
--- busybox-0.60.1/tftp.c Fri Aug 24 00:14:31 2001
+++ busybox-0.60.1-tftp/tftp.c Thu Oct 4 13:57:11 2001
@@ -3,7 +3,8 @@
/* */
/* A simple tftp client for busybox. */
/* Tries to follow RFC1350. */
-/* Only "octet" mode and 512-byte data blocks are supported. */
+/* Only "octet" mode supported. */
+/* Optional blocksize negotiation (RFC2347 + RFC2348) */
/* */
/* Copyright (C) 2001 Magnus Damm <damm at opensource.se> */
/* */
@@ -47,6 +48,18 @@
//#define BB_FEATURE_TFTP_DEBUG
+#define TFTP_BLOCKSIZE_DEFAULT 512 /* according to RFC 1350, don't change */
+#define TFTP_TIMEOUT 5 /* seconds */
+
+/* opcodes we support */
+
+#define TFTP_RRQ 1
+#define TFTP_WRQ 2
+#define TFTP_DATA 3
+#define TFTP_ACK 4
+#define TFTP_ERROR 5
+#define TFTP_OACK 6
+
static const char *tftp_error_msg[] = {
"Undefined error",
"File not found",
@@ -61,8 +74,71 @@
const int tftp_cmd_get = 1;
const int tftp_cmd_put = 2;
+#ifdef BB_FEATURE_TFTP_BLOCKSIZE
+
+static int tftp_blocksize_check(int blocksize, int bufsize)
+{
+ /* Check if the blocksize is valid:
+ * RFC2348 says between 8 and 65464,
+ * but our implementation makes it impossible
+ * to use blocksizes smaller than 22 octets.
+ */
+
+ if ((bufsize && (blocksize > bufsize)) ||
+ (blocksize < 8) || (blocksize > 65464)) {
+ error_msg("bad blocksize");
+ return 0;
+ }
+
+ return blocksize;
+}
+
+static char *tftp_option_get(char *buf, int len, char *option)
+{
+ int opt_val = 0;
+ int opt_found = 0;
+ int k;
+
+ while (len > 0) {
+
+ /* Make sure the options are terminated correctly */
+
+ for (k = 0; k < len; k++) {
+ if (buf[k] == '\0') {
+ break;
+ }
+ }
+
+ if (k >= len) {
+ break;
+ }
+
+ if (opt_val == 0) {
+ if (strcasecmp(buf, option) == 0) {
+ opt_found = 1;
+ }
+ }
+ else {
+ if (opt_found) {
+ return buf;
+ }
+ }
+
+ k++;
+
+ buf += k;
+ len -= k;
+
+ opt_val ^= 1;
+ }
+
+ return NULL;
+}
+
+#endif
+
static inline int tftp(const int cmd, const struct hostent *host,
- const char *serverfile, int localfd, const int port, int tftp_bufsize)
+ const char *remotefile, int localfd, const int port, int tftp_bufsize)
{
const int cmd_get = cmd & tftp_cmd_get;
const int cmd_put = cmd & tftp_cmd_put;
@@ -81,7 +157,12 @@
int finished = 0;
int timeout = bb_tftp_num_retries;
int block_nr = 1;
- RESERVE_BB_BUFFER(buf, tftp_bufsize + 4); // Why 4 ?
+
+#ifdef BB_FEATURE_TFTP_BLOCKSIZE
+ int want_option_ack = 0;
+#endif
+
+ RESERVE_BB_BUFFER(buf, tftp_bufsize + 4); /* Opcode + Block # + Data */
tftp_bufsize += 4;
@@ -103,50 +184,79 @@
/* build opcode */
if (cmd_get) {
- opcode = 1; // read request = 1
+ opcode = TFTP_RRQ;
}
if (cmd_put) {
- opcode = 2; // write request = 2
+ opcode = TFTP_WRQ;
}
while (1) {
-
- /* build packet of type "opcode" */
-
-
cp = buf;
+ /* first create the opcode part */
+
*((unsigned short *) cp) = htons(opcode);
cp += 2;
/* add filename and mode */
- if ((cmd_get && (opcode == 1)) || // read request = 1
- (cmd_put && (opcode == 2))) { // write request = 2
+ if ((cmd_get && (opcode == TFTP_RRQ)) ||
+ (cmd_put && (opcode == TFTP_WRQ))) {
+ int too_long = 0;
- /* what is this trying to do ? */
- while (cp != &buf[tftp_bufsize - 1]) {
- if ((*cp = *serverfile++) == '\0')
- break;
- cp++;
+ /* see if the filename fits into buf */
+ /* and fill in packet */
+
+ len = strlen(remotefile) + 1;
+
+ if ((cp + len) >= &buf[tftp_bufsize - 1]) {
+ too_long = 1;
+ }
+ else {
+ safe_strncpy(cp, remotefile, len);
+ cp += len;
}
- /* and this ? */
- if ((*cp != '\0') || (&buf[tftp_bufsize - 1] - cp) < 7) {
- error_msg("too long server-filename");
+
+ if (too_long || ((&buf[tftp_bufsize - 1] - cp) < 6)) {
+ error_msg("too long remote-filename");
break;
}
- memcpy(cp + 1, "octet", 6);
- cp += 7;
+ /* add "mode" part of the package */
+
+ memcpy(cp, "octet", 6);
+ cp += 6;
+
+#ifdef BB_FEATURE_TFTP_BLOCKSIZE
+
+ len = tftp_bufsize - 4; /* data block size */
+
+ if (len != TFTP_BLOCKSIZE_DEFAULT) {
+
+ if ((&buf[tftp_bufsize - 1] - cp) < 15) {
+ error_msg("too long remote-filename");
+ break;
+ }
+
+ /* add "blksize" + number of blocks */
+
+ memcpy(cp, "blksize", 8);
+ cp += 8;
+
+ cp += snprintf(cp, 6, "%d", len) + 1;
+
+ want_option_ack = 1;
+ }
+#endif
}
/* add ack and data */
- if ((cmd_get && (opcode == 4)) || // acknowledgement = 4
- (cmd_put && (opcode == 3))) { // data packet == 3
+ if ((cmd_get && (opcode == TFTP_ACK)) ||
+ (cmd_put && (opcode == TFTP_DATA))) {
*((unsigned short *) cp) = htons(block_nr);
@@ -154,7 +264,7 @@
block_nr++;
- if (cmd_put && (opcode == 3)) { // data packet == 3
+ if (cmd_put && (opcode == TFTP_DATA)) {
len = read(localfd, cp, tftp_bufsize - 4);
if (len < 0) {
@@ -200,7 +310,7 @@
memset(&from, 0, sizeof(from));
fromlen = sizeof(from);
- tv.tv_sec = 5; // BB_TFPT_TIMEOUT = 5
+ tv.tv_sec = TFTP_TIMEOUT;
tv.tv_usec = 0;
FD_ZERO(&rfds);
@@ -261,9 +371,76 @@
printf("received %d bytes: %04x %04x\n", len, opcode, tmp);
#endif
- if (cmd_get && (opcode == 3)) { // data packet == 3
+ if (opcode == TFTP_ERROR) {
+ char *msg = NULL;
+
+ if (buf[4] != '\0') {
+ msg = &buf[4];
+ buf[tftp_bufsize - 1] = '\0';
+ } else if (tmp < (sizeof(tftp_error_msg)
+ / sizeof(char *))) {
+
+ msg = (char *) tftp_error_msg[tmp];
+ }
+
+ if (msg) {
+ error_msg("server says: %s", msg);
+ }
+
+ break;
+ }
+
+#ifdef BB_FEATURE_TFTP_BLOCKSIZE
+ if (want_option_ack) {
+
+ want_option_ack = 0;
+
+ if (opcode == TFTP_OACK) {
+
+ /* server seems to support options */
+
+ char *res;
+
+ res = tftp_option_get(&buf[2], len-2,
+ "blksize");
+
+ if (res) {
+ int foo = atoi(res);
+
+ if (tftp_blocksize_check(foo,
+ tftp_bufsize - 4)) {
+
+ if (cmd_put) {
+ opcode = TFTP_DATA;
+ }
+ else {
+ opcode = TFTP_ACK;
+ }
+#ifdef BB_FEATURE_TFTP_DEBUG
+ printf("using blksize %u\n");
+#endif
+ tftp_bufsize = foo + 4;
+ block_nr = 0;
+ continue;
+ }
+ }
+ /* FIXME:
+ * we should send ERROR 8 */
+ error_msg("bad server option");
+ break;
+ }
+
+ error_msg("warning: blksize not supported by server"
+ " - reverting to 512");
+
+ tftp_bufsize = TFTP_BLOCKSIZE_DEFAULT + 4;
+ }
+#endif
+
+ if (cmd_get && (opcode == TFTP_DATA)) {
if (tmp == block_nr) {
+
len = write(localfd, &buf[4], len - 4);
if (len < 0) {
@@ -275,43 +452,30 @@
finished++;
}
- opcode = 4; // acknowledgement = 4
+ opcode = TFTP_ACK;
continue;
}
}
- if (cmd_put && (opcode == 4)) { // acknowledgement = 4
+ if (cmd_put && (opcode == TFTP_ACK)) {
if (tmp == (block_nr - 1)) {
if (finished) {
break;
}
- opcode = 3; // data packet == 3
+ opcode = TFTP_DATA;
continue;
}
}
-
- if (opcode == 5) { // error code == 5
- char *msg = NULL;
-
- if (buf[4] != '\0') {
- msg = &buf[4];
- buf[tftp_bufsize - 1] = '\0';
- } else if (tmp < (sizeof(tftp_error_msg) / sizeof(char *))) {
- msg = (char *) tftp_error_msg[tmp];
- }
-
- if (msg) {
- error_msg("server says: %s", msg);
- }
-
- break;
- }
}
+#ifdef BB_FEATURE_CLEAN_UP
close(socketfd);
+ RELEASE_BB_BUFFER(buf);
+#endif
+
return finished ? EXIT_SUCCESS : EXIT_FAILURE;
}
@@ -326,13 +490,38 @@
int flags = 0;
int opt;
int result;
- int blocksize = 512;
+ int blocksize = TFTP_BLOCKSIZE_DEFAULT;
+
+ /* figure out what to pass to getopt */
- while ((opt = getopt(argc, argv, "b:gpl:r:")) != -1) {
+#ifdef BB_FEATURE_TFTP_BLOCKSIZE
+#define BS "b:"
+#else
+#define BS
+#endif
+
+#ifdef BB_FEATURE_TFTP_GET
+#define GET "g"
+#else
+#define GET
+#endif
+
+#ifdef BB_FEATURE_TFTP_PUT
+#define PUT "p"
+#else
+#define PUT
+#endif
+
+ while ((opt = getopt(argc, argv, BS GET PUT "l:r:")) != -1) {
switch (opt) {
+#ifdef BB_FEATURE_TFTP_BLOCKSIZE
case 'b':
blocksize = atoi(optarg);
+ if (!tftp_blocksize_check(blocksize, 0)) {
+ return EXIT_FAILURE;
+ }
break;
+#endif
#ifdef BB_FEATURE_TFTP_GET
case 'g':
cmd = tftp_cmd_get;
@@ -370,14 +559,16 @@
}
#ifdef BB_FEATURE_TFTP_DEBUG
- printf("using server \"%s\", serverfile \"%s\","
+ printf("using server \"%s\", remotefile \"%s\", "
"localfile \"%s\".\n",
inet_ntoa(*((struct in_addr *) host->h_addr)),
remotefile, localfile);
#endif
result = tftp(cmd, host, remotefile, fd, port, blocksize);
- close(fd);
+#ifdef BB_FEATURE_CLEAN_UP
+ close(fd);
+#endif
return(result);
-}
\ No newline at end of file
+}
diff -urN busybox-0.60.1/usage.h busybox-0.60.1-tftp/usage.h
--- busybox-0.60.1/usage.h Fri Aug 24 00:14:31 2001
+++ busybox-0.60.1-tftp/usage.h Thu Oct 4 14:06:24 2001
@@ -1573,19 +1573,28 @@
#else
#define USAGE_TFTP_PUT(a)
#endif
+#ifdef BB_FEATURE_TFTP_BLOCKSIZE
+ #define USAGE_TFTP_BS(a) a
+#else
+ #define USAGE_TFTP_BS(a)
+#endif
#define tftp_trivial_usage \
- "command SOURCE DEST"
+ "[OPTION]... HOST [PORT]"
#define tftp_full_usage \
"Transfers a file from/to a tftp server using \"octet\" mode.\n\n" \
- "Commands:\n" \
+ "Options:\n" \
+ "\t-l FILE\tLocal FILE.\n" \
+ "\t-r FILE\tRemote FILE.\n" \
USAGE_TFTP_GET( \
- "\tget\tGet file from server SOURCE and store to local DEST.\n" \
+ "\t-g\tGet file.\n" \
) \
USAGE_TFTP_PUT( \
- "\tput\tPut local file SOURCE to server DEST.\n" \
+ "\t-p\tPut file.\n" \
) \
- "\nWhen naming a server, use the syntax \"server:file\"."
+ USAGE_TFTP_BS( \
+ "\t-b SIZE\tTransfer blocks of SIZE octets.\n" \
+ )
#define touch_trivial_usage \
"[-c] FILE [FILE ...]"
More information about the busybox
mailing list