2007-04-27 00:44:52 +02:00
|
|
|
#ifndef _GPXE_XFER_H
|
|
|
|
#define _GPXE_XFER_H
|
|
|
|
|
|
|
|
/** @file
|
|
|
|
*
|
|
|
|
* Data transfer interfaces
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
#include <stddef.h>
|
2007-04-28 22:56:24 +02:00
|
|
|
#include <stdarg.h>
|
2007-04-27 00:44:52 +02:00
|
|
|
#include <gpxe/interface.h>
|
|
|
|
#include <gpxe/iobuf.h>
|
|
|
|
|
|
|
|
struct xfer_interface;
|
2007-06-11 16:04:39 +02:00
|
|
|
struct xfer_metadata;
|
2007-04-27 00:44:52 +02:00
|
|
|
|
|
|
|
/** Data transfer interface operations */
|
|
|
|
struct xfer_interface_operations {
|
2007-04-28 22:56:24 +02:00
|
|
|
/** Close interface
|
|
|
|
*
|
2007-04-29 04:03:58 +02:00
|
|
|
* @v xfer Data transfer interface
|
2007-04-28 22:56:24 +02:00
|
|
|
* @v rc Reason for close
|
|
|
|
*/
|
|
|
|
void ( * close ) ( struct xfer_interface *xfer, int rc );
|
|
|
|
/** Redirect to new location
|
|
|
|
*
|
2007-04-29 04:03:58 +02:00
|
|
|
* @v xfer Data transfer interface
|
2007-04-28 22:56:24 +02:00
|
|
|
* @v type New location type
|
|
|
|
* @v args Remaining arguments depend upon location type
|
|
|
|
* @ret rc Return status code
|
|
|
|
*/
|
|
|
|
int ( * vredirect ) ( struct xfer_interface *xfer, int type,
|
|
|
|
va_list args );
|
2007-07-08 15:11:07 +02:00
|
|
|
/** Check flow control window
|
|
|
|
*
|
|
|
|
* @v xfer Data transfer interface
|
|
|
|
* @ret len Length of window
|
|
|
|
*
|
|
|
|
* Flow control is regarded as advisory but not mandatory.
|
|
|
|
* Users who have control over their own rate of data
|
|
|
|
* generation should perform a flow control check before
|
|
|
|
* generating new data. Users who have no control (such as
|
|
|
|
* NIC drivers or filter layers) are not obliged to check.
|
|
|
|
*
|
|
|
|
* Data transfer interfaces must be prepared to accept
|
|
|
|
* datagrams even if they are advertising a window of zero
|
|
|
|
* bytes.
|
|
|
|
*/
|
|
|
|
size_t ( * window ) ( struct xfer_interface *xfer );
|
2007-05-15 17:23:09 +02:00
|
|
|
/** Allocate I/O buffer
|
|
|
|
*
|
|
|
|
* @v xfer Data transfer interface
|
|
|
|
* @v len I/O buffer payload length
|
|
|
|
* @ret iobuf I/O buffer
|
|
|
|
*/
|
|
|
|
struct io_buffer * ( * alloc_iob ) ( struct xfer_interface *xfer,
|
|
|
|
size_t len );
|
2007-06-11 16:04:39 +02:00
|
|
|
/** Deliver datagram as I/O buffer with metadata
|
2007-04-27 00:44:52 +02:00
|
|
|
*
|
2007-04-29 04:03:58 +02:00
|
|
|
* @v xfer Data transfer interface
|
2007-04-27 00:44:52 +02:00
|
|
|
* @v iobuf Datagram I/O buffer
|
2008-01-08 17:46:55 +01:00
|
|
|
* @v meta Data transfer metadata
|
2007-04-27 00:44:52 +02:00
|
|
|
* @ret rc Return status code
|
2007-04-27 02:02:23 +02:00
|
|
|
*
|
|
|
|
* A data transfer interface that wishes to support only raw
|
|
|
|
* data delivery should set this method to
|
2007-05-01 02:07:57 +02:00
|
|
|
* xfer_deliver_as_raw().
|
2007-04-27 00:44:52 +02:00
|
|
|
*/
|
2007-05-15 17:23:09 +02:00
|
|
|
int ( * deliver_iob ) ( struct xfer_interface *xfer,
|
2007-06-11 16:04:39 +02:00
|
|
|
struct io_buffer *iobuf,
|
|
|
|
struct xfer_metadata *meta );
|
2007-04-27 02:02:23 +02:00
|
|
|
/** Deliver datagram as raw data
|
|
|
|
*
|
2007-04-29 04:03:58 +02:00
|
|
|
* @v xfer Data transfer interface
|
2007-04-27 02:02:23 +02:00
|
|
|
* @v data Data buffer
|
|
|
|
* @v len Length of data buffer
|
|
|
|
* @ret rc Return status code
|
|
|
|
*
|
|
|
|
* A data transfer interface that wishes to support only I/O
|
|
|
|
* buffer delivery should set this method to
|
2007-05-15 17:23:09 +02:00
|
|
|
* xfer_deliver_as_iob().
|
2007-04-27 02:02:23 +02:00
|
|
|
*/
|
|
|
|
int ( * deliver_raw ) ( struct xfer_interface *xfer,
|
|
|
|
const void *data, size_t len );
|
2007-04-27 00:44:52 +02:00
|
|
|
};
|
|
|
|
|
|
|
|
/** A data transfer interface */
|
|
|
|
struct xfer_interface {
|
|
|
|
/** Generic object communication interface */
|
|
|
|
struct interface intf;
|
|
|
|
/** Operations for received messages */
|
|
|
|
struct xfer_interface_operations *op;
|
|
|
|
};
|
|
|
|
|
2008-01-08 17:46:55 +01:00
|
|
|
/** Basis positions for seek() events */
|
|
|
|
enum seek_whence {
|
|
|
|
SEEK_CUR = 0,
|
|
|
|
SEEK_SET,
|
|
|
|
};
|
|
|
|
|
2007-06-11 16:04:39 +02:00
|
|
|
/** Data transfer metadata */
|
|
|
|
struct xfer_metadata {
|
2008-01-08 17:46:55 +01:00
|
|
|
/** Position of data within stream */
|
|
|
|
off_t offset;
|
|
|
|
/** Basis for data position
|
|
|
|
*
|
|
|
|
* Must be one of @c SEEK_CUR or @c SEEK_SET.
|
|
|
|
*/
|
|
|
|
int whence;
|
2007-06-11 16:04:39 +02:00
|
|
|
/** Source socket address, or NULL */
|
|
|
|
struct sockaddr *src;
|
|
|
|
/** Destination socket address, or NULL */
|
|
|
|
struct sockaddr *dest;
|
2007-06-28 00:20:36 +02:00
|
|
|
/** Network device, or NULL */
|
|
|
|
struct net_device *netdev;
|
2007-06-11 16:04:39 +02:00
|
|
|
};
|
|
|
|
|
2007-05-26 17:04:36 +02:00
|
|
|
/**
|
|
|
|
* Describe seek basis
|
|
|
|
*
|
|
|
|
* @v whence Basis for new position
|
|
|
|
*/
|
|
|
|
static inline __attribute__ (( always_inline )) const char *
|
|
|
|
whence_text ( int whence ) {
|
|
|
|
switch ( whence ) {
|
|
|
|
case SEEK_CUR: return "CUR";
|
2008-01-08 17:46:55 +01:00
|
|
|
case SEEK_SET: return "SET";
|
2007-05-26 17:04:36 +02:00
|
|
|
default: return "INVALID";
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2007-04-27 00:44:52 +02:00
|
|
|
extern struct xfer_interface null_xfer;
|
|
|
|
extern struct xfer_interface_operations null_xfer_ops;
|
|
|
|
|
2007-05-01 02:07:57 +02:00
|
|
|
extern void xfer_close ( struct xfer_interface *xfer, int rc );
|
|
|
|
extern int xfer_vredirect ( struct xfer_interface *xfer, int type,
|
|
|
|
va_list args );
|
|
|
|
extern int xfer_redirect ( struct xfer_interface *xfer, int type, ... );
|
2007-07-08 15:11:07 +02:00
|
|
|
extern size_t xfer_window ( struct xfer_interface *xfer );
|
2007-05-15 17:23:09 +02:00
|
|
|
extern struct io_buffer * xfer_alloc_iob ( struct xfer_interface *xfer,
|
|
|
|
size_t len );
|
|
|
|
extern int xfer_deliver_iob ( struct xfer_interface *xfer,
|
|
|
|
struct io_buffer *iobuf );
|
2007-06-11 16:04:39 +02:00
|
|
|
extern int xfer_deliver_iob_meta ( struct xfer_interface *xfer,
|
|
|
|
struct io_buffer *iobuf,
|
|
|
|
struct xfer_metadata *meta );
|
2007-05-01 02:07:57 +02:00
|
|
|
extern int xfer_deliver_raw ( struct xfer_interface *xfer,
|
2007-04-27 02:02:23 +02:00
|
|
|
const void *data, size_t len );
|
2007-05-28 22:09:44 +02:00
|
|
|
extern int xfer_vprintf ( struct xfer_interface *xfer,
|
|
|
|
const char *format, va_list args );
|
|
|
|
extern int xfer_printf ( struct xfer_interface *xfer,
|
|
|
|
const char *format, ... );
|
2008-01-08 17:46:55 +01:00
|
|
|
extern int xfer_seek ( struct xfer_interface *xfer, off_t offset, int whence );
|
2007-05-01 02:07:57 +02:00
|
|
|
|
|
|
|
extern void ignore_xfer_close ( struct xfer_interface *xfer, int rc );
|
|
|
|
extern int ignore_xfer_vredirect ( struct xfer_interface *xfer,
|
|
|
|
int type, va_list args );
|
2007-07-08 15:11:07 +02:00
|
|
|
extern size_t unlimited_xfer_window ( struct xfer_interface *xfer );
|
|
|
|
extern size_t no_xfer_window ( struct xfer_interface *xfer );
|
2007-05-15 17:23:09 +02:00
|
|
|
extern struct io_buffer * default_xfer_alloc_iob ( struct xfer_interface *xfer,
|
|
|
|
size_t len );
|
2007-05-01 02:07:57 +02:00
|
|
|
extern int xfer_deliver_as_raw ( struct xfer_interface *xfer,
|
2007-06-11 16:04:39 +02:00
|
|
|
struct io_buffer *iobuf,
|
|
|
|
struct xfer_metadata *meta );
|
2007-05-15 17:23:09 +02:00
|
|
|
extern int xfer_deliver_as_iob ( struct xfer_interface *xfer,
|
|
|
|
const void *data, size_t len );
|
2007-05-01 02:07:57 +02:00
|
|
|
extern int ignore_xfer_deliver_raw ( struct xfer_interface *xfer,
|
|
|
|
const void *data __unused, size_t len );
|
2007-04-29 04:03:58 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Initialise a data transfer interface
|
|
|
|
*
|
|
|
|
* @v xfer Data transfer interface
|
|
|
|
* @v op Data transfer interface operations
|
2007-04-30 01:53:39 +02:00
|
|
|
* @v refcnt Containing object reference counter, or NULL
|
2007-04-29 04:03:58 +02:00
|
|
|
*/
|
|
|
|
static inline void xfer_init ( struct xfer_interface *xfer,
|
|
|
|
struct xfer_interface_operations *op,
|
2007-04-30 01:53:39 +02:00
|
|
|
struct refcnt *refcnt ) {
|
2007-04-29 04:03:58 +02:00
|
|
|
xfer->intf.dest = &null_xfer.intf;
|
|
|
|
xfer->intf.refcnt = refcnt;
|
|
|
|
xfer->op = op;
|
|
|
|
}
|
|
|
|
|
2008-01-22 19:48:47 +01:00
|
|
|
/**
|
|
|
|
* Initialise a static data transfer interface
|
|
|
|
*
|
|
|
|
* @v operations Data transfer interface operations
|
|
|
|
*/
|
|
|
|
#define XFER_INIT( operations ) { \
|
|
|
|
.intf = { \
|
|
|
|
.dest = &null_xfer.intf, \
|
|
|
|
.refcnt = NULL, \
|
|
|
|
}, \
|
|
|
|
.op = operations, \
|
|
|
|
}
|
|
|
|
|
2007-04-29 04:03:58 +02:00
|
|
|
/**
|
|
|
|
* Get data transfer interface from generic object communication interface
|
|
|
|
*
|
|
|
|
* @v intf Generic object communication interface
|
|
|
|
* @ret xfer Data transfer interface
|
|
|
|
*/
|
2007-05-01 12:17:29 +02:00
|
|
|
static inline __attribute__ (( always_inline )) struct xfer_interface *
|
2007-04-29 04:03:58 +02:00
|
|
|
intf_to_xfer ( struct interface *intf ) {
|
|
|
|
return container_of ( intf, struct xfer_interface, intf );
|
|
|
|
}
|
2007-04-27 02:02:23 +02:00
|
|
|
|
|
|
|
/**
|
2007-05-15 18:53:46 +02:00
|
|
|
* Get reference to destination data transfer interface
|
2007-04-27 02:02:23 +02:00
|
|
|
*
|
2007-04-29 04:03:58 +02:00
|
|
|
* @v xfer Data transfer interface
|
2007-04-27 02:02:23 +02:00
|
|
|
* @ret dest Destination interface
|
|
|
|
*/
|
2007-05-01 12:17:29 +02:00
|
|
|
static inline __attribute__ (( always_inline )) struct xfer_interface *
|
2007-05-15 18:53:46 +02:00
|
|
|
xfer_get_dest ( struct xfer_interface *xfer ) {
|
|
|
|
return intf_to_xfer ( intf_get ( xfer->intf.dest ) );
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Drop reference to data transfer interface
|
|
|
|
*
|
|
|
|
* @v xfer Data transfer interface
|
|
|
|
*/
|
|
|
|
static inline __attribute__ (( always_inline )) void
|
|
|
|
xfer_put ( struct xfer_interface *xfer ) {
|
|
|
|
intf_put ( &xfer->intf );
|
2007-04-27 00:44:52 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2007-04-29 04:03:58 +02:00
|
|
|
* Plug a data transfer interface into a new destination interface
|
2007-04-27 00:44:52 +02:00
|
|
|
*
|
2007-04-29 04:03:58 +02:00
|
|
|
* @v xfer Data transfer interface
|
2007-04-27 00:44:52 +02:00
|
|
|
* @v dest New destination interface
|
|
|
|
*/
|
2007-05-15 18:53:46 +02:00
|
|
|
static inline __attribute__ (( always_inline )) void
|
|
|
|
xfer_plug ( struct xfer_interface *xfer, struct xfer_interface *dest ) {
|
2007-04-27 00:44:52 +02:00
|
|
|
plug ( &xfer->intf, &dest->intf );
|
|
|
|
}
|
|
|
|
|
2007-05-01 02:07:57 +02:00
|
|
|
/**
|
|
|
|
* Plug two data transfer interfaces together
|
|
|
|
*
|
|
|
|
* @v a Data transfer interface A
|
|
|
|
* @v b Data transfer interface B
|
|
|
|
*/
|
2007-05-15 18:53:46 +02:00
|
|
|
static inline __attribute__ (( always_inline )) void
|
|
|
|
xfer_plug_plug ( struct xfer_interface *a, struct xfer_interface *b ) {
|
2007-05-01 02:07:57 +02:00
|
|
|
plug_plug ( &a->intf, &b->intf );
|
|
|
|
}
|
|
|
|
|
2007-04-27 00:44:52 +02:00
|
|
|
/**
|
2007-04-29 04:03:58 +02:00
|
|
|
* Unplug a data transfer interface
|
2007-04-27 00:44:52 +02:00
|
|
|
*
|
2007-04-29 04:03:58 +02:00
|
|
|
* @v xfer Data transfer interface
|
2007-04-27 00:44:52 +02:00
|
|
|
*/
|
2007-05-15 18:53:46 +02:00
|
|
|
static inline __attribute__ (( always_inline )) void
|
|
|
|
xfer_unplug ( struct xfer_interface *xfer ) {
|
2007-04-27 00:44:52 +02:00
|
|
|
plug ( &xfer->intf, &null_xfer.intf );
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2007-04-29 04:03:58 +02:00
|
|
|
* Stop using a data transfer interface
|
2007-04-27 00:44:52 +02:00
|
|
|
*
|
2007-04-29 04:03:58 +02:00
|
|
|
* @v xfer Data transfer interface
|
2007-04-27 00:44:52 +02:00
|
|
|
*
|
|
|
|
* After calling this method, no further messages will be received via
|
|
|
|
* the interface.
|
|
|
|
*/
|
2007-04-29 04:03:58 +02:00
|
|
|
static inline void xfer_nullify ( struct xfer_interface *xfer ) {
|
2007-04-27 00:44:52 +02:00
|
|
|
xfer->op = &null_xfer_ops;
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif /* _GPXE_XFER_H */
|