FireBee_SVN/BaS_gcc/net/tftp.c

/*
 * File:        tftp.c
 * Purpose:     Trivial File Transfer Protocol driver for reading a file
 *              from a remote host.
 *
 * Notes:       See RFC 1350
 *
 * Modifications:
 *
 */

#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>

#include "bas_printf.h"
#include "bas_string.h"
#include "net.h"
#include "net_timer.h"

#define TIMER_NETWORK	3

/* The one and only TFTP connection */
static TFTP_Connection tcxn;

/* Progress Indicators */
static char hash[] = {'-','\\','|','/'};
static int ihash = 0;

static int tftp_rwrq(void)
{
	NBUF *pNbuf;
	RWRQ *rwrq;
	int i, j, result;

	pNbuf = nbuf_alloc();
	if (pNbuf == NULL)
	{
		xprintf("TFTP: tftp_rwrq() couldn't allocate Tx buffer\n");
		return 0;
	}

	rwrq = (RWRQ *)&pNbuf->data[TFTP_HDR_OFFSET];

	/* Indicate a R/WRQ */
	rwrq->opcode = tcxn.dir;

	/* Copy in filename */
	strcpy(&rwrq->filename_mode[0], tcxn.file);
	i = strlen(tcxn.file) + 1;

	/* Indicate transfer type */
	strcpy (&rwrq->filename_mode[i], OCTET);

	for (j = 0; j < 3; ++j)
	{
		pNbuf->length = (uint16_t)(i + strlen(OCTET) + 1 + 2);
		result = udp_send(tcxn.nif,
				tcxn.server_ip,
				tcxn.my_port,
				tcxn.server_port,
				pNbuf);
		if (result == 1)
			break;
	}

	if (result == 0)
		nbuf_free(pNbuf);

	return result;
}

static int tftp_ack(uint16_t blocknum)
{
	ACK *ack;
	NBUF *pNbuf;
	int i, result;

	pNbuf = nbuf_alloc();
	if (pNbuf == NULL)
	{
		xprintf("TFTP: tftp_ack() couldn't allocate Tx buffer\n");
		return 0;
	}

	ack = (ACK *)&pNbuf->data[TFTP_HDR_OFFSET];
	ack->opcode = TFTP_ACK;
	ack->blocknum = blocknum;

	for (i = 0; i < 3; ++i)
	{
		pNbuf->length = 4;
		result = udp_send(tcxn.nif,
				tcxn.server_ip,
				tcxn.my_port,
				tcxn.server_port,
				pNbuf);
		if (result == 1)
			break;
	}

	if (result == 0)
		nbuf_free(pNbuf);

	return result;
} 

static int tftp_error(uint16_t error_code, uint16_t server_port)
{
	ERROR *err;
	NBUF *pNbuf;
	int i, result;

	pNbuf = nbuf_alloc();
	if (pNbuf == NULL)
	{
		xprintf("TFTP: tftp_error() couldn't allocate Tx buffer\n");
		return 0;
	}

	err = (ERROR *)&pNbuf->data[TFTP_HDR_OFFSET];
	err->opcode = TFTP_ERROR;
	err->code = error_code;
	err->msg[0] = '\0';

	for (i = 0; i < 3; ++i)
	{
		pNbuf->length = 5;
		result = udp_send(tcxn.nif,
				tcxn.server_ip,
				tcxn.my_port,
				server_port,
				pNbuf);
		if (result == 1)
			break;
	}

	if (result == 0)
		nbuf_free(pNbuf);

	return result;
}


void tftp_handler(NIF *nif, NBUF *pNbuf)
{
	union TFTPpacket *tftp_pkt;
	udp_frame_hdr *udpframe;
	static int cnt;
	(void) nif;

	tftp_pkt = (union TFTPpacket *)&pNbuf->data[pNbuf->offset];
	udpframe = (udp_frame_hdr *)&pNbuf->data[pNbuf->offset - UDP_HDR_SIZE];

	switch (tftp_pkt->generic.opcode)
	{
		case TFTP_DATA:
			/* Is this the expected block number? */
			if (tftp_pkt->data.blocknum == tcxn.exp_blocknum)
			{
				/* Is this is the first data block received? */
				if (tftp_pkt->data.blocknum == 1)
				{
					/* Save the server's transfer ID */
					tcxn.server_port = UDP_SOURCE(udpframe);

					/* Mark the connection as open */
					tcxn.open = true;

					/* Start progress indicator */
					xprintf("%c", hash[0]);
					cnt = 0;
				}
				else
				{   
					/* Check the server's transfer ID */
					if (tcxn.server_port != UDP_SOURCE(udpframe))
					{
						xprintf("TFTP: Invalid server port: %d\n", \
								UDP_SOURCE(udpframe));

						/* Send ERROR packet to source */
						tftp_error(TFTP_ERR_TID, UDP_SOURCE(udpframe));
						break;
					}
				}

				/* Add the buffer to the TFTP queue */
				queue_add(&tcxn.queue, (QNODE *)pNbuf);

				/* Update number of the next block expected */
				tcxn.exp_blocknum++;

				/* Increment number of bytes received counter */
				tcxn.bytes_recv += (pNbuf->length - 4);

				/* Update progress indicator */
				if (++cnt == 50)
				{
					ihash = (ihash + 1) % 4;
					xprintf("\r");
					xprintf("%c", hash[ihash]);
					cnt = 0;
				}
			}
			else
			{
				if (tftp_pkt->data.blocknum < tcxn.exp_blocknum)
				{
					/* Re-ACK this packet */
					tftp_ack(tftp_pkt->data.blocknum);
				}

				/* This is NOT the block expected */
				xprintf("Exp: %d, ", tcxn.exp_blocknum);
				xprintf("Rcv: %d\n", tftp_pkt->data.blocknum);

				/* Free the network buffer */
				nbuf_free(pNbuf);
			}
			break;
		case TFTP_ERROR:
			xprintf("\nTFTP Error #%d: ",tftp_pkt->error.code);
			xprintf("%s\n",tftp_pkt->error.msg);
			tcxn.error = true;
			/* Free the network buffer */
			nbuf_free(pNbuf);
			break;
		case TFTP_ACK:
			if (tftp_pkt->ack.blocknum == tcxn.exp_blocknum)
			{
				if (tftp_pkt->data.blocknum == 0)
				{   /* This is the first ACK received */

					/* Save the server's transfer ID */
					tcxn.server_port = UDP_SOURCE(udpframe);

					/* Mark the connection as open */
					tcxn.open = true;
				}
				else
				{   /* Check the server's transfer ID */
					if (tcxn.server_port != UDP_SOURCE(udpframe))
					{
						xprintf("TFTP: Invalid server port: %d\n", \
								UDP_SOURCE(udpframe));

						/*Send ERROR packet to source */
						tftp_error(TFTP_ERR_TID, UDP_SOURCE(udpframe));
						break;
					}
				}

				tcxn.exp_blocknum++;
			}
			else
			{
				/* This is NOT the block number expected */
				xprintf("ACK Exp: %d, ", tcxn.exp_blocknum);
				xprintf("ACK Rcv: %d\n", tftp_pkt->ack.blocknum);
			}

			/* Free the network buffer */
			nbuf_free(pNbuf);
			break;
		case TFTP_RRQ:
		case TFTP_WRQ:
		default:
			/* Free the network buffer */
			nbuf_free(pNbuf);
			break;
	}
}

void tftp_end(int success)
{
	/* 
	 * Following a successful transfer the caller should pass in 
	 * true, there should have been no ERROR packets received, and 
	 * the connection should have been marked as closed by the 
	 * tftp_in_char() routine.
	 */
	if (success && !tcxn.error && (tcxn.open == false))
	{
		xprintf("\bTFTP transfer completed \n");
		xprintf("Read %d bytes (%d blocks)\n",   \
				tcxn.bytes_recv, tcxn.exp_blocknum - 1);
	}
	else
	{
		/* Send error packet to stifle the server */
		tftp_error(TFTP_ERR_ILL, tcxn.server_port);

		xprintf("\bErrors in TFTP transfer.\n");
		xprintf("Read %d bytes (%d blocks)\n",   \
				tcxn.bytes_recv, tcxn.exp_blocknum - 1);
	}

	/* Free up any buffers left in the queue */
	while (!queue_isempty(&tcxn.queue))
		nbuf_free((NBUF *)queue_remove(&tcxn.queue));

	/* Free the UDP port */
	udp_free_port(tcxn.my_port);
}

int tftp_write(NIF *nif, char *fn, IP_ADDR_P server, uint32_t begin, uint32_t end)
{
	DATA *data;
	NBUF *pNbuf;

	uint32_t i, retries, bytes_to_send;
	uint16_t blocknum, this_size;
	uint8_t success, *current;
	int result;

	if (fn == 0 || server == 0 || end < begin)
		return 0;

	/* Setup initial connection status */
	tcxn.nif = nif;
	tcxn.file = fn;
	tcxn.server_ip[0] = server[0];
	tcxn.server_ip[1] = server[1];
	tcxn.server_ip[2] = server[2];
	tcxn.server_ip[3] = server[3];
	tcxn.server_port = UDP_PORT_TFTP;
	tcxn.exp_blocknum = 0;
	tcxn.dir = TFTP_WRQ;
	tcxn.open = false;
	tcxn.bytes_sent = 0;
	tcxn.error = false;

	/* Use Mac address as pseudo-random port */
	udp_prime_port((uint16_t)((nif->hwa[4] << 8) | nif->hwa[5]));
	tcxn.my_port = udp_obtain_free_port();
	udp_bind_port(tcxn.my_port,&tftp_handler);

	retries = 4;
	success = false;

	while (--retries)
	{
		/* Make the TFTP Read/Write Request */
		if (!tftp_rwrq())
		{
			xprintf("Error: Couldn't send TFTP Write Request\n");
			udp_free_port(tcxn.my_port);
			return false;
		}

		timer_set_secs(TIMER_NETWORK, TFTP_TIMEOUT);
		while (timer_get_reference(TIMER_NETWORK))
		{
			/* Has the server responded */
			if (tcxn.open)
			{
				success = true;
				break;
			}
		}

		/* If the connection is open, we are done here */
		if (success || tcxn.error)
			break;
	}
	if (!retries)
	{
		xprintf("TFTP could not make connection to server.\n");
		udp_free_port(tcxn.my_port);
		return false;
	}
	else if (tcxn.error)
	{
		xprintf("\bErrors in TFTP upload.\n");
		udp_free_port(tcxn.my_port);
		return false;
	}

	bytes_to_send = end - begin;
	current = (uint8_t *)begin;
	blocknum = 1;
	retries = 4;
	success = false;

	while (--retries)
	{
		pNbuf = nbuf_alloc();
		if (pNbuf == NULL)
		{
			xprintf("TFTP: tftp_write() couldn't allocate Tx buffer\n");
			return false;
		}

		/* Build the packet */
		data = (DATA *)&pNbuf->data[TFTP_HDR_OFFSET];
		data->blocknum = blocknum;
		data->opcode = TFTP_DATA;

		this_size = (bytes_to_send > TFTP_PKTSIZE) ? \
					TFTP_PKTSIZE : (uint16_t)bytes_to_send;

		for (i = 0; i < this_size; i++)
		{
			data->data[i] = current[i];
		}

		/* Set the packet length */
		pNbuf->length = (uint16_t)(4 + this_size);

		/* Attempt to send the packet */
		for (i = 0; i < 3; ++i)
		{
			result = udp_send(tcxn.nif, 
					tcxn.server_ip, 
					tcxn.my_port, 
					tcxn.server_port, 
					pNbuf);

			if (result == 1)
				break;
		}

		if (result == 0)
			nbuf_free(pNbuf);

		timer_set_secs(TIMER_NETWORK, TFTP_TIMEOUT);
		while (timer_get_reference(TIMER_NETWORK))
		{
			/* Has the server responded */
			if ((tcxn.exp_blocknum - 1) == blocknum)
			{
				success = true;
				break;
			}
		}

		/* TFTP Write Compeleted successfully */
		if (success && (this_size < TFTP_PKTSIZE))
		{
			tcxn.bytes_sent += this_size;
			break;
		}

		if (tcxn.error)
			break;

		/* If an ACK was received, keep sending packets */
		if (success)
		{
			tcxn.bytes_sent += TFTP_PKTSIZE;
			bytes_to_send -= TFTP_PKTSIZE;
			current += TFTP_PKTSIZE;
			blocknum++;
			retries = 4;
			success = false;
		}
	}
	if (tcxn.error)
	{
		xprintf("TFTP lost connection to server.\n");
		xprintf("Sent %d bytes (%d blocks)\n",   \
				tcxn.bytes_sent, tcxn.exp_blocknum - 1);
		udp_free_port(tcxn.my_port);
		return false;
	}
	else
	{
		xprintf("\bTFTP upload successful\n");
		xprintf("Sent %d bytes (%d blocks)\n",   \
				tcxn.bytes_sent, tcxn.exp_blocknum - 1);
		udp_free_port(tcxn.my_port);
		return true;
	}
}

int tftp_read(NIF *nif, char *fn, IP_ADDR_P server)
{
	uint32_t retries;

	if (fn == 0 || server == 0)
		return 0;

	/* Setup initial connection status */
	tcxn.nif = nif;
	tcxn.file = fn;
	tcxn.server_ip[0] = server[0];
	tcxn.server_ip[1] = server[1];
	tcxn.server_ip[2] = server[2];
	tcxn.server_ip[3] = server[3];
	tcxn.server_port = UDP_PORT_TFTP;
	tcxn.exp_blocknum = 1;
	tcxn.last_ack = 0;
	tcxn.dir = TFTP_RRQ;
	tcxn.open = false;
	tcxn.bytes_recv = 0;
	tcxn.rem_bytes = 0;
	tcxn.next_char = NULL;
	tcxn.error = false;
	queue_init(&tcxn.queue);

	/* Use Mac address as pseudo-random port */
	udp_prime_port((uint16_t)((nif->hwa[4] << 8) | nif->hwa[5]));
	tcxn.my_port = udp_obtain_free_port();
	udp_bind_port(tcxn.my_port,&tftp_handler);

	retries = 4;

	while (--retries)
	{
		/* Make the TFTP Read/Write Request */
		if (!tftp_rwrq())
		{
			xprintf("Error: Couldn't send TFTP Read Request\n");
			udp_free_port(tcxn.my_port);
			return false;
		}

		timer_set_secs(TIMER_NETWORK, TFTP_TIMEOUT);
		while (timer_get_reference(TIMER_NETWORK))
		{
			/* Has the server responded */
			if (tcxn.open == true)
				break;
		}

		/* If the connection is open, we are done here */
		if ((tcxn.open == true) || tcxn.error)
			break;
	}
	if (!retries)
	{
		xprintf("TFTP could not make connection to server.\n");
		udp_free_port(tcxn.my_port);
		return false;
	}
	else if (tcxn.error)
	{
		xprintf("\bErrors in TFTP download.\n");
		udp_free_port(tcxn.my_port);
		return false;
	}
	else
		return true;
}

int tftp_in_char(void)
{
	union TFTPpacket *tftp_pkt;
	int retval;
	NBUF *pNbuf;

	if (tcxn.next_char != NULL)
	{
		/* 
		 * A buffer is already being worked on - grab next 
		 * byte from it
		 */
		retval = *tcxn.next_char++;
		if (--tcxn.rem_bytes <= 0)
		{
			/* The buffer is depleted; add it back to the free queue */
			pNbuf = (NBUF *)queue_remove(&tcxn.queue);
			
			nbuf_free(pNbuf);
			tcxn.next_char = NULL;
		}
	}
	else
	{
		/* Is the connection still open? */
		if (tcxn.open == false)
		{
			/*
			 * The last packet has been received and the last data
			 * buffer has been exhausted
			 */
			retval = -1;
		}
		else
		{
			/* Get pointer to the next buffer */
			pNbuf = (NBUF *)queue_peek(&tcxn.queue);

			if (pNbuf == NULL)
			{
				int i;

				/* There was no buffer in the queue */
				for (i = 0; i < 3; ++i)
				{
					timer_set_secs(TIMER_NETWORK, 1);
					while (timer_get_reference(TIMER_NETWORK))
					{
						/* Has the server sent another DATA packet? */
						if (!queue_isempty(&tcxn.queue))
						{
							pNbuf = (NBUF *)queue_peek(&tcxn.queue);
							break;
						}
					}
					if (pNbuf != NULL)
						break;

					/* Ack the last packet again */
					xprintf("Re-acking %d\n",tcxn.last_ack - 1);
					retval = tftp_ack(tcxn.last_ack - 1);
				}
			}
			if (pNbuf == NULL)
			{
				/* The server didn't respond with the expected packet */
				tcxn.open = false;
				tcxn.error = true;
				xprintf("TFTP lost connection to server.\n");
				retval = -1;
			}
			else
			{
				tftp_pkt = (union TFTPpacket *)&pNbuf->data[pNbuf->offset];

				/* Subtract the TFTP header from the data length */
				tcxn.rem_bytes = pNbuf->length - 4;

				/* Point to first data byte in the packet */
				tcxn.next_char = tftp_pkt->data.data;

				/* Save off the block number */
				tcxn.last_ack = tftp_pkt->data.blocknum;

				/* Check to see if this is the last packet of the transfer */
				if (tcxn.rem_bytes < TFTP_PKTSIZE)
					tcxn.open = false;

				/* Check for empty termination packet */
				if (tcxn.rem_bytes == 0)
				{
					pNbuf = (NBUF *)queue_remove(&tcxn.queue);
					nbuf_free(pNbuf);
					tcxn.next_char = NULL;
					retval = tftp_ack(tcxn.last_ack++);
					retval = -1;
				}
				else
				{
					retval = tftp_ack(tcxn.last_ack++);
					retval = *tcxn.next_char++;

					/* Check for a single byte packet */
					if (--tcxn.rem_bytes == 0)
					{
						/* The buffer is depleted; add it back to the free queue */
						pNbuf = (NBUF *)queue_remove(&tcxn.queue);
						nbuf_free(pNbuf);
						tcxn.next_char = NULL;
					}
				}
			}
		}
	}
	return retval;
}