PXENV_UDP_WRITE
[PXE UDP API]

UDP WRITE. More...

Data Structures
struct	s_PXENV_UDP_WRITE
	Parameter block for pxenv_udp_write(). More...
Defines
#define	PXENV_UDP_WRITE   0x0033
	PXE API function code for pxenv_udp_write().
Typedefs
typedef struct s_PXENV_UDP_WRITE	PXENV_UDP_WRITE_t
Functions
PXENV_EXIT_t	pxenv_udp_write (struct s_PXENV_UDP_WRITE *udp_write)
	UDP WRITE.

---

Detailed Description

UDP WRITE.

---

Define Documentation

#define PXENV_UDP_WRITE   0x0033

PXE API function code for pxenv_udp_write().

Definition at line 784 of file pxe_api.h.

Referenced by pxe_api_call().

---

Typedef Documentation

typedef struct s_PXENV_UDP_WRITE PXENV_UDP_WRITE_t

Definition at line 797 of file pxe_api.h.

---

Function Documentation

PXENV_EXIT_t pxenv_udp_write

(

struct s_PXENV_UDP_WRITE *

pxenv_udp_write

)

UDP WRITE.

Parameters:

	pxenv_udp_write	Pointer to a struct s_PXENV_UDP_WRITE
	s_PXENV_UDP_WRITE::ip	Destination IP address
	s_PXENV_UDP_WRITE::gw	Relay agent IP address, or 0.0.0.0
	s_PXENV_UDP_WRITE::src_port	Source UDP port, or 0
	s_PXENV_UDP_WRITE::dst_port	Destination UDP port
	s_PXENV_UDP_WRITE::buffer_size	Length of the UDP payload
	s_PXENV_UDP_WRITE::buffer	Address of the UDP payload

Return values:

	PXENV_EXIT_SUCCESS	Packet was transmitted successfully
	PXENV_EXIT_FAILURE	Packet could not be transmitted
	s_PXENV_UDP_WRITE::Status	PXE status code

Exceptions:

	PXENV_STATUS_UDP_CLOSED	UDP connection is not open
	PXENV_STATUS_UNDI_TRANSMIT_ERROR	Could not transmit packet

Transmits a single UDP packet. A valid IP and UDP header will be prepended to the payload in s_PXENV_UDP_WRITE::buffer; the buffer should not contain precomputed IP and UDP headers, nor should it contain space allocated for these headers. The first byte of the buffer will be transmitted as the first byte following the UDP header.

If s_PXENV_UDP_WRITE::gw is 0.0.0.0, normal IP routing will take place. See the relevant implementation note for more details.

If s_PXENV_UDP_WRITE::src_port is 0, port 2069 will be used.

You must have opened a UDP connection with pxenv_udp_open() before calling pxenv_udp_write().

On x86, you must set the s_PXE::StatusCallout field to a nonzero value before calling this function in protected mode. You cannot call this function with a 32-bit stack segment. (See the relevant implementation note for more details.)

Note:

Etherboot currently ignores the s_PXENV_UDP_WRITE::gw parameter.

Definition at line 256 of file pxe_udp.c.

References AF_INET, s_PXENV_UDP_WRITE::buffer, s_PXENV_UDP_WRITE::buffer_size, copy_from_user(), DBG, s_PXENV_UDP_WRITE::dst_port, htons, inet_ntoa(), iob_put, s_PXENV_UDP_WRITE::ip, pxe_udp_connection::local, memset(), ntohs, s_SEGOFF16::offset, pxe_netdev, PXENV_EXIT_FAILURE, PXENV_EXIT_SUCCESS, PXENV_STATUS, PXENV_STATUS_OUT_OF_RESOURCES, PXENV_STATUS_SUCCESS, real_to_user(), in_addr::s_addr, s_SEGOFF16::segment, sockaddr_in::sin_addr, sockaddr_in::sin_family, sockaddr_in::sin_port, xfer_metadata::src, s_PXENV_UDP_WRITE::src_port, s_PXENV_UDP_WRITE::Status, pxe_udp_connection::xfer, xfer_alloc_iob(), and xfer_deliver_iob_meta().

Referenced by pxe_api_call().

                                                                           {
        struct sockaddr_in dest;
        struct xfer_metadata meta = {
                .src = ( struct sockaddr * ) &pxe_udp.local,
                .dest = ( struct sockaddr * ) &dest,
                .netdev = pxe_netdev,
        };
        size_t len;
        struct io_buffer *iobuf;
        userptr_t buffer;
        int rc;

        DBG ( "PXENV_UDP_WRITE" );

        /* Construct destination socket address */
        memset ( &dest, 0, sizeof ( dest ) );
        dest.sin_family = AF_INET;
        dest.sin_addr.s_addr = pxenv_udp_write->ip;
        dest.sin_port = pxenv_udp_write->dst_port;

        /* Set local (source) port.  PXE spec says source port is 2069
         * if not specified.  Really, this ought to be set at UDP open
         * time but hey, we didn't design this API.
         */
        pxe_udp.local.sin_port = pxenv_udp_write->src_port;
        if ( ! pxe_udp.local.sin_port )
                pxe_udp.local.sin_port = htons ( 2069 );

        /* FIXME: we ignore the gateway specified, since we're
         * confident of being able to do our own routing.  We should
         * probably allow for multiple gateways.
         */

        /* Allocate and fill data buffer */
        len = pxenv_udp_write->buffer_size;
        iobuf = xfer_alloc_iob ( &pxe_udp.xfer, len );
        if ( ! iobuf ) {
                pxenv_udp_write->Status = PXENV_STATUS_OUT_OF_RESOURCES;
                return PXENV_EXIT_FAILURE;
        }
        buffer = real_to_user ( pxenv_udp_write->buffer.segment,
                                pxenv_udp_write->buffer.offset );
        copy_from_user ( iob_put ( iobuf, len ), buffer, 0, len );

        DBG ( " %04x:%04x+%x %d->%s:%d", pxenv_udp_write->buffer.segment,
              pxenv_udp_write->buffer.offset, pxenv_udp_write->buffer_size,
              ntohs ( pxenv_udp_write->src_port ),
              inet_ntoa ( dest.sin_addr ),
              ntohs ( pxenv_udp_write->dst_port ) );
        
        /* Transmit packet */
        if ( ( rc = xfer_deliver_iob_meta ( &pxe_udp.xfer, iobuf,
                                            &meta ) ) != 0 ) {
                pxenv_udp_write->Status = PXENV_STATUS ( rc );
                return PXENV_EXIT_FAILURE;
        }

        pxenv_udp_write->Status = PXENV_STATUS_SUCCESS;
        return PXENV_EXIT_SUCCESS;
}