pxe_tftp.c File Reference

PXE TFTP API. More...

#include <stdlib.h>
#include <stdio.h>
#include <errno.h>
#include <byteswap.h>
#include <gpxe/uaccess.h>
#include <gpxe/in.h>
#include <gpxe/tftp.h>
#include <gpxe/xfer.h>
#include <gpxe/open.h>
#include <gpxe/process.h>
#include <pxe.h>

Go to the source code of this file.

Data Structures
struct	pxe_tftp_connection
	A PXE TFTP connection. More...
Defines
#define	PXE_TFTP_URI_LEN   256
	Maximum length of a PXE TFTP URI.
Functions
	FILE_LICENCE (GPL2_OR_LATER)
static void	pxe_tftp_close (int rc)
	Close PXE TFTP connection.
static int	pxe_tftp_xfer_deliver_iob (struct xfer_interface *xfer __unused, struct io_buffer *iobuf, struct xfer_metadata *meta)
	Receive new data.
static void	pxe_tftp_xfer_close (struct xfer_interface *xfer __unused, int rc)
	Handle close() event.
static int	pxe_tftp_open (uint32_t ipaddress, unsigned int port, const unsigned char *filename, size_t blksize, int sizeonly)
	Open PXE TFTP connection.
PXENV_EXIT_t	pxenv_tftp_open (struct s_PXENV_TFTP_OPEN *tftp_open)
	TFTP OPEN.
PXENV_EXIT_t	pxenv_tftp_close (struct s_PXENV_TFTP_CLOSE *tftp_close)
	TFTP CLOSE.
PXENV_EXIT_t	pxenv_tftp_read (struct s_PXENV_TFTP_READ *tftp_read)
	TFTP READ.
PXENV_EXIT_t	pxenv_tftp_read_file (struct s_PXENV_TFTP_READ_FILE *tftp_read_file)
	TFTP/MTFTP read file.
PXENV_EXIT_t	pxenv_tftp_get_fsize (struct s_PXENV_TFTP_GET_FSIZE *tftp_get_fsize)
	TFTP GET FILE SIZE.
Variables
static struct pxe_tftp_connection	pxe_tftp
	The PXE TFTP connection.
static struct xfer_interface_operations	pxe_tftp_xfer_ops

---

Detailed Description

PXE TFTP API.

Definition in file pxe_tftp.c.

---

Define Documentation

#define PXE_TFTP_URI_LEN   256

Maximum length of a PXE TFTP URI.

The PXE TFTP API provides 128 characters for the filename; the extra 128 bytes allow for the remainder of the URI.

Definition at line 156 of file pxe_tftp.c.

Referenced by pxe_tftp_open().

---

Function Documentation

FILE_LICENCE

(

GPL2_OR_LATER

)

static void pxe_tftp_close

(

int

rc

)

[static]

Close PXE TFTP connection.

Parameters:

rc

Final status code

Definition at line 71 of file pxe_tftp.c.

References pxe_tftp_connection::rc, pxe_tftp_connection::xfer, and xfer_close().

Referenced by pxe_tftp_xfer_close(), pxe_tftp_xfer_deliver_iob(), pxenv_tftp_close(), pxenv_tftp_get_fsize(), pxenv_tftp_open(), and pxenv_tftp_read_file().

                                      {
        xfer_nullify ( &pxe_tftp.xfer );
        xfer_close ( &pxe_tftp.xfer, rc );
        pxe_tftp.rc = rc;
}

static int pxe_tftp_xfer_deliver_iob	(	struct xfer_interface *xfer	__unused,
		struct io_buffer *	iobuf,
		struct xfer_metadata *	meta
	)			[static]

Receive new data.

Parameters:

	xfer	Data transfer interface
	iobuf	I/O buffer
	meta	Transfer metadata

Return values:

rc

Return status code

Definition at line 85 of file pxe_tftp.c.

References pxe_tftp_connection::buffer, copy_to_user(), io_buffer::data, DBG, ENOBUFS, free_iob(), iob_len(), pxe_tftp_connection::max_offset, xfer_metadata::offset, pxe_tftp_connection::offset, pxe_tftp_close(), pxe_tftp_connection::rc, SEEK_CUR, pxe_tftp_connection::size, pxe_tftp_connection::start, and xfer_metadata::whence.

                                                                    {
        size_t len = iob_len ( iobuf );
        int rc = 0;

        /* Calculate new buffer position */
        if ( meta->whence != SEEK_CUR )
                pxe_tftp.offset = 0;
        pxe_tftp.offset += meta->offset;

        /* Copy data block to buffer */
        if ( len == 0 ) {
                /* No data (pure seek); treat as success */
        } else if ( pxe_tftp.offset < pxe_tftp.start ) {
                DBG ( " buffer underrun at %zx (min %zx)",
                      pxe_tftp.offset, pxe_tftp.start );
                rc = -ENOBUFS;
        } else if ( ( pxe_tftp.offset + len ) >
                    ( pxe_tftp.start + pxe_tftp.size ) ) {
                DBG ( " buffer overrun at %zx (max %zx)",
                      ( pxe_tftp.offset + len ),
                      ( pxe_tftp.start + pxe_tftp.size ) );
                rc = -ENOBUFS;
        } else {
                copy_to_user ( pxe_tftp.buffer,
                               ( pxe_tftp.offset - pxe_tftp.start ),
                               iobuf->data, len );
        }

        /* Calculate new buffer position */
        pxe_tftp.offset += len;

        /* Record maximum offset as the file size */
        if ( pxe_tftp.max_offset < pxe_tftp.offset )
                pxe_tftp.max_offset = pxe_tftp.offset;

        /* Terminate transfer on error */
        if ( rc != 0 )
                pxe_tftp_close ( rc );

        free_iob ( iobuf );
        return rc;
}

static void pxe_tftp_xfer_close	(	struct xfer_interface *xfer	__unused,
		int	rc
	)			[static]

Handle close() event.

Parameters:

	xfer	Data transfer interface
	rc	Reason for close

Definition at line 136 of file pxe_tftp.c.

References pxe_tftp_close().

                                           {
        pxe_tftp_close ( rc );
}

static int pxe_tftp_open	(	uint32_t	ipaddress,
		unsigned int	port,
		const unsigned char *	filename,
		size_t	blksize,
		int	sizeonly
	)			[static]

Open PXE TFTP connection.

Parameters:

	ipaddress	IP address
	port	TFTP server port
	filename	File name
	blksize	Requested block size

Return values:

rc

Return status code

Definition at line 167 of file pxe_tftp.c.

References DBG, EINPROGRESS, htons, inet_ntoa(), memset(), ntohs, NULL, PXE_TFTP_URI_LEN, pxe_tftp_connection::rc, in_addr::s_addr, snprintf(), strerror(), TFTP_DEFAULT_BLKSIZE, TFTP_PORT, pxe_tftp_connection::xfer, xfer_init(), and xfer_open_uri_string().

Referenced by pxenv_tftp_get_fsize(), pxenv_tftp_open(), and pxenv_tftp_read_file().

                                          {
        char uri_string[PXE_TFTP_URI_LEN];
        struct in_addr address;
        int rc;

        /* Reset PXE TFTP connection structure */
        memset ( &pxe_tftp, 0, sizeof ( pxe_tftp ) );
        xfer_init ( &pxe_tftp.xfer, &pxe_tftp_xfer_ops, NULL );
        pxe_tftp.rc = -EINPROGRESS;

        /* Construct URI string */
        address.s_addr = ipaddress;
        if ( ! port )
                port = htons ( TFTP_PORT );
        if ( blksize < TFTP_DEFAULT_BLKSIZE )
                blksize = TFTP_DEFAULT_BLKSIZE;
        snprintf ( uri_string, sizeof ( uri_string ),
                   "tftp%s://%s:%d%s%s?blksize=%zd",
                   sizeonly ? "size" : "",
                   inet_ntoa ( address ), ntohs ( port ),
                   ( ( filename[0] == '/' ) ? "" : "/" ), filename, blksize );
        DBG ( " %s", uri_string );

        /* Open PXE TFTP connection */
        if ( ( rc = xfer_open_uri_string ( &pxe_tftp.xfer,
                                           uri_string ) ) != 0 ) {
                DBG ( " could not open (%s)\n", strerror ( rc ) );
                return rc;
        }

        return 0;
}

---

Variable Documentation

struct pxe_tftp_connection pxe_tftp [static]

Initial value:

 {
        .xfer = XFER_INIT ( &null_xfer_ops ),
}

The PXE TFTP connection.

Definition at line 62 of file pxe_tftp.c.

struct xfer_interface_operations pxe_tftp_xfer_ops [static]

Initial value:

 {
        .close          = pxe_tftp_xfer_close,
        .vredirect      = xfer_vreopen,
        .window         = unlimited_xfer_window,
        .alloc_iob      = default_xfer_alloc_iob,
        .deliver_iob    = pxe_tftp_xfer_deliver_iob,
        .deliver_raw    = xfer_deliver_as_iob,
}

Definition at line 141 of file pxe_tftp.c.