xfer.h File Reference

Data transfer interfaces. More...

#include <stddef.h>
#include <stdarg.h>
#include <ipxe/interface.h>

Go to the source code of this file.

Data Structures
struct	xfer_metadata
	Data transfer metadata. More...

Macros
#define	XFER_FL_ABS_OFFSET   0x0001
	Offset is absolute. More...
#define	XFER_FL_OVER   0x0002
	Sender is relinquishing use of half-duplex channel. More...
#define	XFER_FL_OUT   0x0004
	This is the final data transfer. More...
#define	XFER_FL_CMD_STAT   0x0008
	Data content represents a command or status message. More...
#define	XFER_FL_RESPONSE   0x0010
	Data content is a response. More...
#define	xfer_vredirect_TYPE(object_type)   typeof ( int ( object_type, int type, va_list args ) )
#define	xfer_window_TYPE(object_type)   typeof ( size_t ( object_type ) )
#define	xfer_window_changed_TYPE(object_type)   typeof ( void ( object_type ) )
#define	xfer_alloc_iob_TYPE(object_type)   typeof ( struct io_buffer * ( object_type, size_t len ) )
#define	xfer_deliver_TYPE(object_type)

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
int	xfer_vredirect (struct interface *intf, int type, va_list args)
	Send redirection event. More...
size_t	xfer_window (struct interface *intf)
	Check flow control window. More...
void	xfer_window_changed (struct interface *intf)
	Report change of flow control window. More...
struct io_buffer *	xfer_alloc_iob (struct interface *intf, size_t len)
	Allocate I/O buffer. More...
int	xfer_deliver (struct interface *intf, struct io_buffer *iobuf, struct xfer_metadata *meta)
	Deliver datagram. More...
int	xfer_redirect (struct interface *xfer, int type,...)
	Send redirection event. More...
int	xfer_deliver_iob (struct interface *intf, struct io_buffer *iobuf)
	Deliver datagram as I/O buffer without metadata. More...
int	xfer_deliver_raw_meta (struct interface *intf, const void *data, size_t len, struct xfer_metadata *meta)
	Deliver datagram as raw data. More...
int	xfer_deliver_raw (struct interface *intf, const void *data, size_t len)
	Deliver datagram as raw data without metadata. More...
int	xfer_vprintf (struct interface *intf, const char *format, va_list args)
	Deliver formatted string. More...
int	__attribute__ ((format(printf, 2, 3))) xfer_printf(struct interface *intf
int const char int	xfer_seek (struct interface *intf, off_t offset)
	Seek to position. More...
int	xfer_check_order (struct xfer_metadata *meta, size_t *pos, size_t len)
	Check that data is delivered strictly in order. More...

Variables
int const char *	format

Detailed Description

Data transfer interfaces.

Definition in file xfer.h.

Macro Definition Documentation

XFER_FL_ABS_OFFSET

#define XFER_FL_ABS_OFFSET   0x0001

Offset is absolute.

Definition at line 47 of file xfer.h.

XFER_FL_OVER

#define XFER_FL_OVER   0x0002

Sender is relinquishing use of half-duplex channel.

Definition at line 50 of file xfer.h.

XFER_FL_OUT

#define XFER_FL_OUT   0x0004

This is the final data transfer.

Definition at line 53 of file xfer.h.

XFER_FL_CMD_STAT

#define XFER_FL_CMD_STAT   0x0008

Data content represents a command or status message.

The flag XFER_FL_RESPONSE is used to distinguish between a command message and a status message.

Definition at line 60 of file xfer.h.

XFER_FL_RESPONSE

#define XFER_FL_RESPONSE   0x0010

Data content is a response.

Definition at line 63 of file xfer.h.

xfer_vredirect_TYPE

#define xfer_vredirect_TYPE

(

object_type

)

typeof ( int ( object_type, int type, va_list args ) )

Definition at line 69 of file xfer.h.

xfer_window_TYPE

#define xfer_window_TYPE

(

object_type

)

typeof ( size_t ( object_type ) )

Definition at line 73 of file xfer.h.

xfer_window_changed_TYPE

#define xfer_window_changed_TYPE

(

object_type

)

typeof ( void ( object_type ) )

Definition at line 77 of file xfer.h.

xfer_alloc_iob_TYPE

#define xfer_alloc_iob_TYPE

(

object_type

)

typeof ( struct io_buffer * ( object_type, size_t len ) )

Definition at line 82 of file xfer.h.

xfer_deliver_TYPE

#define xfer_deliver_TYPE

(

object_type

)

Value:

typeof ( int ( object_type, struct io_buffer *iobuf,    \
                       struct xfer_metadata *meta ) )

Definition at line 88 of file xfer.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

xfer_vredirect()

int xfer_vredirect	(	struct interface *	intf,
		int	type,
		va_list	args
	)

Send redirection event.

Parameters

intf	Data transfer interface
type	New location type
args	Remaining arguments depend upon location type

Return values

rc	Return status code

Definition at line 62 of file xfer.c.

                                                                      {
        struct interface tmp;
        struct interface *dest;
        xfer_vredirect_TYPE ( void * ) *op =
                intf_get_dest_op_no_passthru ( intf, xfer_vredirect, &dest );
        void *object = intf_object ( dest );
        int rc;

        DBGC ( INTF_COL ( intf ), "INTF " INTF_INTF_FMT " redirect\n",
               INTF_INTF_DBG ( intf, dest ) );

        if ( op ) {
                rc = op ( object, type, args );
        } else {
                /* Default is to reopen the interface as instructed,
                 * then send xfer_window_changed() messages to both
                 * new child and parent interfaces.  Since our
                 * original child interface is likely to be closed and
                 * unplugged as a result of the call to
                 * xfer_vreopen(), we create a temporary interface in
                 * order to be able to send xfer_window_changed() to
                 * the parent.
                 *
                 * If redirection fails, then send intf_close() to the
                 * parent interface.
                 */
                intf_temp_init ( &tmp, intf );
                intf_plug ( &tmp, dest );
                rc = xfer_vreopen ( dest, type, args );
                if ( rc == 0 ) {
                        xfer_window_changed ( dest );
                        xfer_window_changed ( &tmp );
                } else {
                        intf_close ( &tmp, rc );
                }
                intf_unplug ( &tmp );
        }

        if ( rc != 0 ) {
                DBGC ( INTF_COL ( intf ), "INTF " INTF_INTF_FMT " redirect "
                       "failed: %s\n", INTF_INTF_DBG ( intf, dest ),
                       strerror ( rc ) );
        }

        intf_put ( dest );
        return rc;
}

References DBGC, dest, interface::intf, intf_close(), INTF_COL, intf_get_dest_op_no_passthru, INTF_INTF_DBG, INTF_INTF_FMT, intf_object(), intf_plug(), intf_put(), intf_temp_init(), intf_unplug(), op, rc, strerror(), tmp, type, xfer_vredirect(), xfer_vredirect_TYPE, xfer_vreopen(), and xfer_window_changed().

Referenced by xfer_redirect(), and xfer_vredirect().

xfer_window()

size_t xfer_window

(

struct interface *

intf

)

Check flow control window.

Parameters

intf	Data transfer interface

Return values

len	Length of window

Definition at line 116 of file xfer.c.

                                              {
        struct interface *dest;
        xfer_window_TYPE ( void * ) *op =
                intf_get_dest_op ( intf, xfer_window, &dest );
        void *object = intf_object ( dest );
        size_t len;

        if ( op ) {
                len = op ( object );
        } else {
                /* Default is to provide an unlimited window */
                len = ~( ( size_t ) 0 );
        }

        intf_put ( dest );
        return len;
}

References dest, interface::intf, intf_get_dest_op, intf_object(), intf_put(), len, op, xfer_window(), and xfer_window_TYPE.

Referenced by efi_local_step(), fc_port_window_changed(), fcpcmd_send_wrdata(), http_step(), hw_step(), ipair_window_changed(), iscsi_tx_step(), nfs_mount_step(), nfs_pm_step(), nfs_step(), pinger_window_changed(), pxenv_tftp_open(), sanpath_step(), scsidev_step(), scsidev_window(), syslogs_window_changed(), tcp_xmit_sack(), tftp_send_packet(), tftp_send_rrq(), tls_cipherstream_window(), tls_plainstream_window(), tls_tx_step(), xcm_step(), and xfer_window().

xfer_window_changed()

void xfer_window_changed

(

struct interface *

intf

)

Report change of flow control window.

Parameters

intf	Data transfer interface

Note that this method is used to indicate only unsolicited changes in the flow control window. In particular, this method must not be called as part of the response to xfer_deliver(), since that could easily lead to an infinite loop. Callers of xfer_deliver() should assume that the flow control window will have changed without generating an xfer_window_changed() message.

Definition at line 146 of file xfer.c.

                                                    {

        intf_poke ( intf, xfer_window_changed );
}

References interface::intf, intf_poke(), and xfer_window_changed().

Referenced by aoedev_config_done(), fcoe_expired(), fcoe_reset(), fcpdev_examine(), http_step(), ib_cmrc_changed(), iscsi_rx_login_response(), scsidev_ready(), srp_login_rsp(), tcp_rx(), tls_new_finished(), tls_tx_step(), xfer_vredirect(), and xfer_window_changed().

xfer_alloc_iob()

struct io_buffer* xfer_alloc_iob	(	struct interface *	intf,
		size_t	len
	)

Allocate I/O buffer.

Parameters

intf	Data transfer interface
len	I/O buffer payload length

Return values

iobuf

I/O buffer

Definition at line 158 of file xfer.c.

                                                                         {
        struct interface *dest;
        xfer_alloc_iob_TYPE ( void * ) *op =
                intf_get_dest_op ( intf, xfer_alloc_iob, &dest );
        void *object = intf_object ( dest );
        struct io_buffer *iobuf;

        DBGC ( INTF_COL ( intf ), "INTF " INTF_INTF_FMT " alloc_iob %zd\n",
               INTF_INTF_DBG ( intf, dest ), len );

        if ( op ) {
                iobuf = op ( object, len );
        } else {
                /* Default is to allocate an I/O buffer with no
                 * reserved space.
                 */
                iobuf = alloc_iob ( len );
        }

        if ( ! iobuf ) {
                DBGC ( INTF_COL ( intf ), "INTF " INTF_INTF_FMT " alloc_iob "
                       "failed\n", INTF_INTF_DBG ( intf, dest ) );
        }

        intf_put ( dest );
        return iobuf;
}

References alloc_iob(), DBGC, dest, interface::intf, INTF_COL, intf_get_dest_op, INTF_INTF_DBG, INTF_INTF_FMT, intf_object(), intf_put(), len, op, xfer_alloc_iob(), and xfer_alloc_iob_TYPE.

Referenced by dhcp_tx(), dhcpv6_tx(), efi_local_step(), efi_pxe_udp_write(), fc_xchg_alloc_iob(), fcpcmd_send_cmnd(), fcpcmd_send_wrdata(), ipair_tx(), iscsi_tx_data_out(), iscsi_tx_login_request(), pinger_expired(), pxenv_udp_write(), slam_tx_nack(), srp_cmd(), srp_login(), tftp_send_ack(), tftp_send_error(), tftp_send_rrq(), tls_send_plaintext(), xfer_alloc_iob(), xfer_deliver_raw_meta(), and xfer_seek().

xfer_deliver()

int xfer_deliver	(	struct interface *	intf,
		struct io_buffer *	iobuf,
		struct xfer_metadata *	meta
	)

Deliver datagram.

Parameters

intf	Data transfer interface
iobuf	Datagram I/O buffer
meta	Data transfer metadata

Return values

rc	Return status code

Definition at line 194 of file xfer.c.

                                                {
        struct interface *dest;
        xfer_deliver_TYPE ( void * ) *op =
                intf_get_dest_op ( intf, xfer_deliver, &dest );
        void *object = intf_object ( dest );
        int rc;

        DBGC ( INTF_COL ( intf ), "INTF " INTF_INTF_FMT " deliver %zd\n",
               INTF_INTF_DBG ( intf, dest ), iob_len ( iobuf ) );

        if ( op ) {
                rc = op ( object, iobuf, meta );
        } else {
                /* Default is to discard the I/O buffer */
                free_iob ( iobuf );
                rc = -EPIPE;
        }

        if ( rc != 0 ) {
                DBGC ( INTF_COL ( intf ), "INTF " INTF_INTF_FMT
                       " deliver failed: %s\n",
                       INTF_INTF_DBG ( intf, dest ), strerror ( rc ) );
        }

        intf_put ( dest );
        return rc;
}

References DBGC, dest, EPIPE, free_iob(), interface::intf, INTF_COL, intf_get_dest_op, INTF_INTF_DBG, INTF_INTF_FMT, intf_object(), intf_put(), iob_len(), meta(), op, rc, strerror(), xfer_deliver(), and xfer_deliver_TYPE.

Referenced by dhcp_tx(), efi_pxe_udp_write(), fc_xchg_rx(), fcpcmd_send_cmnd(), fcpcmd_send_wrdata(), http_conn_socket_deliver(), http_content_deliver(), peerblk_deliver(), peermux_block_deliver(), ping_rx(), pinger_expired(), pxenv_udp_write(), slam_mc_socket_deliver(), tftp_rx_data(), tftp_send_ack(), tftp_send_error(), udp_rx(), xfer_buffer(), xfer_deliver(), xfer_deliver_iob(), xfer_deliver_raw_meta(), and xfer_seek().

xfer_redirect()

int xfer_redirect	(	struct interface *	intf,
		int	type,
			...
	)

Send redirection event.

Parameters

intf	Data transfer interface
type	New location type
...	Remaining arguments depend upon location type

Return values

rc	Return status code

Definition at line 238 of file xfer.c.

                                                            {
        va_list args;
        int rc;

        va_start ( args, type );
        rc = xfer_vredirect ( intf, type, args );
        va_end ( args );
        return rc;
}

References interface::intf, rc, type, va_end, va_start, and xfer_vredirect().

Referenced by http_redirect(), and named_resolv_done().

xfer_deliver_iob()

int xfer_deliver_iob	(	struct interface *	intf,
		struct io_buffer *	iobuf
	)

Deliver datagram as I/O buffer without metadata.

Parameters

intf	Data transfer interface
iobuf	Datagram I/O buffer

Return values

rc	Return status code

Definition at line 255 of file xfer.c.

                                                                         {
        return xfer_deliver ( intf, iobuf, &dummy_metadata );
}

References dummy_metadata, interface::intf, and xfer_deliver().

Referenced by dhcpv6_tx(), efi_local_step(), fc_xchg_tx(), fcoe_rx(), http_rx_chunk_data(), http_rx_transfer_identity(), http_tx_request(), ib_cmrc_complete_recv(), imux_rx_tcp(), ipair_tx(), iscsi_tx_data_out(), iscsi_tx_login_request(), nfs_deliver(), oncrpc_call(), slam_tx_nack(), srp_cmd(), srp_login(), tcp_rx_data(), tftp_send_rrq(), tls_new_data(), and tls_send_plaintext().

xfer_deliver_raw_meta()

int xfer_deliver_raw_meta	(	struct interface *	intf,
		const void *	data,
		size_t	len,
		struct xfer_metadata *	meta
	)

Deliver datagram as raw data.

Parameters

intf	Data transfer interface
data	Data
len	Length of data
meta	Data transfer metadata

Return values

rc	Return status code

Definition at line 268 of file xfer.c.

                                                                     {
        struct io_buffer *iobuf;

        iobuf = xfer_alloc_iob ( intf, len );
        if ( ! iobuf )
                return -ENOMEM;

        memcpy ( iob_put ( iobuf, len ), data, len );
        return xfer_deliver ( intf, iobuf, meta );
}

References data, ENOMEM, iob_put, len, memcpy(), meta(), xfer_alloc_iob(), and xfer_deliver().

Referenced by dns_send_packet(), fc_els_tx(), fc_ns_query_step(), peerdisc_socket_tx(), and xfer_deliver_raw().

xfer_deliver_raw()

int xfer_deliver_raw	(	struct interface *	intf,
		const void *	data,
		size_t	len
	)

Deliver datagram as raw data without metadata.

Parameters

intf	Data transfer interface
data	Data
len	Length of data

Return values

rc	Return status code

Definition at line 288 of file xfer.c.

                                                                              {
        return xfer_deliver_raw_meta ( intf, data, len, &dummy_metadata );
}

References data, dummy_metadata, len, and xfer_deliver_raw_meta().

Referenced by fcoe_fip_rx_els_response(), hw_step(), ib_cmrc_changed(), iscsi_tx_bhs(), ntp_request(), slam_finished(), xcm_step(), xfer_vprintf(), xsmp_tx_session(), and xsmp_tx_xve().

xfer_vprintf()

int xfer_vprintf	(	struct interface *	intf,
		const char *	format,
		va_list	args
	)

Deliver formatted string.

Parameters

intf	Data transfer interface
format	Format string
args	Arguments corresponding to the format string

Return values

rc	Return status code

Definition at line 300 of file xfer.c.

                                  {
        va_list args_tmp;
        char *buf;
        int len;
        int rc;

        /* Create temporary string */
        va_copy ( args_tmp, args );
        len = vasprintf ( &buf, format, args );
        va_end ( args_tmp );
        if ( len < 0 ) {
                rc = len;
                goto err_asprintf;
        }

        /* Transmit string */
        if ( ( rc = xfer_deliver_raw ( intf, buf, len ) ) != 0 )
                goto err_deliver;

 err_deliver:
        free ( buf );
 err_asprintf:
        return rc;
}

References format, free, len, rc, va_copy, va_end, vasprintf(), and xfer_deliver_raw().

Referenced by xfer_printf().

__attribute__()

int __attribute__

(

(format(printf, 2, 3))

)

xfer_seek()

int const char int xfer_seek	(	struct interface *	intf,
		off_t	offset
	)

Seek to position.

Parameters

intf	Data transfer interface
offset	Offset to new position

Return values

rc	Return status code

Definition at line 351 of file xfer.c.

                                                       {
        struct io_buffer *iobuf;
        struct xfer_metadata meta = {
                .flags = XFER_FL_ABS_OFFSET,
                .offset = offset,
        };

        DBGC ( INTF_COL ( intf ), "INTF " INTF_FMT " seek to %ld\n",
               INTF_DBG ( intf ), offset );

        /* Allocate and send a zero-length data buffer */
        iobuf = xfer_alloc_iob ( intf, 0 );
        if ( ! iobuf )
                return -ENOMEM;

        return xfer_deliver ( intf, iobuf, &meta );
}

References DBGC, ENOMEM, INTF_COL, INTF_DBG, INTF_FMT, meta(), offset, xfer_alloc_iob(), xfer_deliver(), and XFER_FL_ABS_OFFSET.

Referenced by efi_local_step(), ftp_reply(), http_rx_chunk_len(), http_rx_headers(), nfs_deliver(), peermux_info_close(), slam_pull_header(), and tftp_presize().

xfer_check_order()

int xfer_check_order	(	struct xfer_metadata *	meta,
		size_t *	pos,
		size_t	len
	)

Check that data is delivered strictly in order.

Parameters

meta	Data transfer metadata
pos	Current position
len	Length of data

Return values

rc	Return status code

Definition at line 377 of file xfer.c.

                                                                             {
        size_t new_pos;

        /* Allow out-of-order zero-length packets (as used by xfer_seek()) */
        if ( len == 0 )
                return 0;

        /* Calculate position of this delivery */
        new_pos = *pos;
        if ( meta->flags & XFER_FL_ABS_OFFSET )
                new_pos = 0;
        new_pos += meta->offset;

        /* Fail if delivery position is not equal to current position */
        if ( new_pos != *pos )
                return -EPROTO;

        /* Update current position */
        *pos += len;

        return 0;
}

References EPROTO, len, meta(), and XFER_FL_ABS_OFFSET.

Referenced by peerblk_raw_rx().

Variable Documentation

format

int const char* format

Definition at line 104 of file xfer.h.

Referenced by deflate_init(), xfer_printf(), xfer_vprintf(), and zlib_deflate().