mirror of https://github.com/ipxe/ipxe.git
422 lines
10 KiB
C
422 lines
10 KiB
C
/*
|
|
* Copyright (C) 2007 Michael Brown <mbrown@fensystems.co.uk>.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License as
|
|
* published by the Free Software Foundation; either version 2 of the
|
|
* License, or any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful, but
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
|
*/
|
|
|
|
#include <string.h>
|
|
#include <stdio.h>
|
|
#include <errno.h>
|
|
#include <gpxe/xfer.h>
|
|
|
|
/** @file
|
|
*
|
|
* Data transfer interfaces
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* Close data transfer interface
|
|
*
|
|
* @v xfer Data transfer interface
|
|
* @v rc Reason for close
|
|
*/
|
|
void xfer_close ( struct xfer_interface *xfer, int rc ) {
|
|
struct xfer_interface *dest = xfer_get_dest ( xfer );
|
|
|
|
DBGC ( xfer, "XFER %p->%p close\n", xfer, dest );
|
|
|
|
dest->op->close ( dest, rc );
|
|
xfer_unplug ( xfer );
|
|
xfer_put ( dest );
|
|
}
|
|
|
|
/**
|
|
* Send redirection event
|
|
*
|
|
* @v xfer Data transfer interface
|
|
* @v type New location type
|
|
* @v args Remaining arguments depend upon location type
|
|
* @ret rc Return status code
|
|
*/
|
|
int xfer_vredirect ( struct xfer_interface *xfer, int type, va_list args ) {
|
|
struct xfer_interface *dest = xfer_get_dest ( xfer );
|
|
int rc;
|
|
|
|
DBGC ( xfer, "XFER %p->%p redirect\n", xfer, dest );
|
|
|
|
rc = dest->op->vredirect ( dest, type, args );
|
|
|
|
if ( rc != 0 ) {
|
|
DBGC ( xfer, "XFER %p<-%p redirect: %s\n", xfer, dest,
|
|
strerror ( rc ) );
|
|
}
|
|
xfer_put ( dest );
|
|
return rc;
|
|
}
|
|
|
|
/**
|
|
* Send redirection event
|
|
*
|
|
* @v xfer Data transfer interface
|
|
* @v type New location type
|
|
* @v ... Remaining arguments depend upon location type
|
|
* @ret rc Return status code
|
|
*/
|
|
int xfer_redirect ( struct xfer_interface *xfer, int type, ... ) {
|
|
va_list args;
|
|
int rc;
|
|
|
|
va_start ( args, type );
|
|
rc = xfer_vredirect ( xfer, type, args );
|
|
va_end ( args );
|
|
return rc;
|
|
}
|
|
|
|
/**
|
|
* Request data
|
|
*
|
|
* @v xfer Data transfer interface
|
|
* @v offset Offset to new position
|
|
* @v whence Basis for new position
|
|
* @v len Length of requested data
|
|
* @ret rc Return status code
|
|
*/
|
|
int xfer_request ( struct xfer_interface *xfer, off_t offset, int whence,
|
|
size_t len ) {
|
|
struct xfer_interface *dest = xfer_get_dest ( xfer );
|
|
int rc;
|
|
|
|
DBGC ( xfer, "XFER %p->%p request %s+%ld %zd\n", xfer, dest,
|
|
whence_text ( whence ), offset, len );
|
|
|
|
rc = dest->op->request ( dest, offset, whence, len );
|
|
|
|
if ( rc != 0 ) {
|
|
DBGC ( xfer, "XFER %p<-%p request: %s\n", xfer, dest,
|
|
strerror ( rc ) );
|
|
}
|
|
xfer_put ( dest );
|
|
return rc;
|
|
}
|
|
|
|
/**
|
|
* Seek to position
|
|
*
|
|
* @v xfer Data transfer interface
|
|
* @v offset Offset to new position
|
|
* @v whence Basis for new position
|
|
* @ret rc Return status code
|
|
*/
|
|
int xfer_seek ( struct xfer_interface *xfer, off_t offset, int whence ) {
|
|
struct xfer_interface *dest = xfer_get_dest ( xfer );
|
|
int rc;
|
|
|
|
DBGC ( xfer, "XFER %p->%p seek %s+%ld\n", xfer, dest,
|
|
whence_text ( whence ), offset );
|
|
|
|
rc = dest->op->seek ( dest, offset, whence );
|
|
|
|
if ( rc != 0 ) {
|
|
DBGC ( xfer, "XFER %p<-%p seek: %s\n", xfer, dest,
|
|
strerror ( rc ) );
|
|
}
|
|
xfer_put ( dest );
|
|
return rc;
|
|
}
|
|
|
|
/**
|
|
* Test to see if interface is ready to accept data
|
|
*
|
|
* @v xfer Data transfer interface
|
|
* @ret rc Return status code
|
|
*
|
|
* This test is optional; the data transfer interface may wish that it
|
|
* does not yet wish to accept data, but cannot prevent attempts to
|
|
* deliver data to it.
|
|
*/
|
|
int xfer_ready ( struct xfer_interface *xfer ) {
|
|
return xfer_seek ( xfer, 0, SEEK_CUR );
|
|
}
|
|
|
|
/**
|
|
* Allocate I/O buffer
|
|
*
|
|
* @v xfer Data transfer interface
|
|
* @v len I/O buffer payload length
|
|
* @ret iobuf I/O buffer
|
|
*/
|
|
struct io_buffer * xfer_alloc_iob ( struct xfer_interface *xfer, size_t len ) {
|
|
struct xfer_interface *dest = xfer_get_dest ( xfer );
|
|
struct io_buffer *iobuf;
|
|
|
|
DBGC ( xfer, "XFER %p->%p alloc_iob %zd\n", xfer, dest, len );
|
|
|
|
iobuf = dest->op->alloc_iob ( dest, len );
|
|
|
|
if ( ! iobuf ) {
|
|
DBGC ( xfer, "XFER %p<-%p alloc_iob failed\n", xfer, dest );
|
|
}
|
|
xfer_put ( dest );
|
|
return iobuf;
|
|
}
|
|
|
|
/**
|
|
* Deliver datagram
|
|
*
|
|
* @v xfer Data transfer interface
|
|
* @v iobuf Datagram I/O buffer
|
|
* @ret rc Return status code
|
|
*/
|
|
int xfer_deliver_iob ( struct xfer_interface *xfer, struct io_buffer *iobuf ) {
|
|
struct xfer_interface *dest = xfer_get_dest ( xfer );
|
|
int rc;
|
|
|
|
DBGC ( xfer, "XFER %p->%p deliver_iob %zd\n", xfer, dest,
|
|
iob_len ( iobuf ) );
|
|
|
|
rc = dest->op->deliver_iob ( dest, iobuf );
|
|
|
|
if ( rc != 0 ) {
|
|
DBGC ( xfer, "XFER %p<-%p deliver_iob: %s\n", xfer, dest,
|
|
strerror ( rc ) );
|
|
}
|
|
xfer_put ( dest );
|
|
return rc;
|
|
}
|
|
|
|
/**
|
|
* Deliver datagram as raw data
|
|
*
|
|
* @v xfer Data transfer interface
|
|
* @v iobuf Datagram I/O buffer
|
|
* @ret rc Return status code
|
|
*/
|
|
int xfer_deliver_raw ( struct xfer_interface *xfer,
|
|
const void *data, size_t len ) {
|
|
struct xfer_interface *dest = xfer_get_dest ( xfer );
|
|
int rc;
|
|
|
|
DBGC ( xfer, "XFER %p->%p deliver_raw %p+%zd\n", xfer, dest,
|
|
data, len );
|
|
|
|
rc = dest->op->deliver_raw ( dest, data, len );
|
|
|
|
if ( rc != 0 ) {
|
|
DBGC ( xfer, "XFER %p<-%p deliver_raw: %s\n", xfer, dest,
|
|
strerror ( rc ) );
|
|
}
|
|
xfer_put ( dest );
|
|
return rc;
|
|
}
|
|
|
|
/**
|
|
* Deliver formatted string
|
|
*
|
|
* @v xfer Data transfer interface
|
|
* @v format Format string
|
|
* @v args Arguments corresponding to the format string
|
|
* @ret rc Return status code
|
|
*/
|
|
int xfer_vprintf ( struct xfer_interface *xfer, const char *format,
|
|
va_list args ) {
|
|
size_t len;
|
|
va_list args_tmp;
|
|
|
|
va_copy ( args_tmp, args );
|
|
len = vsnprintf ( NULL, 0, format, args );
|
|
{
|
|
char buf[len + 1];
|
|
vsnprintf ( buf, sizeof ( buf ), format, args_tmp );
|
|
va_end ( args_tmp );
|
|
return xfer_deliver_raw ( xfer, buf, len );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Deliver formatted string
|
|
*
|
|
* @v xfer Data transfer interface
|
|
* @v format Format string
|
|
* @v ... Arguments corresponding to the format string
|
|
* @ret rc Return status code
|
|
*/
|
|
int xfer_printf ( struct xfer_interface *xfer, const char *format, ... ) {
|
|
va_list args;
|
|
int rc;
|
|
|
|
va_start ( args, format );
|
|
rc = xfer_vprintf ( xfer, format, args );
|
|
va_end ( args );
|
|
return rc;
|
|
}
|
|
|
|
/****************************************************************************
|
|
*
|
|
* Helper methods
|
|
*
|
|
* These functions are designed to be used as methods in the
|
|
* xfer_interface_operations table.
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* Ignore close() event
|
|
*
|
|
* @v xfer Data transfer interface
|
|
* @v rc Reason for close
|
|
*/
|
|
void ignore_xfer_close ( struct xfer_interface *xfer __unused,
|
|
int rc __unused ) {
|
|
/* Nothing to do */
|
|
}
|
|
|
|
/**
|
|
* Ignore vredirect() event
|
|
*
|
|
* @v xfer Data transfer interface
|
|
* @v type New location type
|
|
* @v args Remaining arguments depend upon location type
|
|
* @ret rc Return status code
|
|
*/
|
|
int ignore_xfer_vredirect ( struct xfer_interface *xfer __unused,
|
|
int type __unused, va_list args __unused ) {
|
|
return 0;
|
|
}
|
|
|
|
/**
|
|
* Ignore request() event
|
|
*
|
|
* @v xfer Data transfer interface
|
|
* @v offset Offset to new position
|
|
* @v whence Basis for new position
|
|
* @v len Length of requested data
|
|
* @ret rc Return status code
|
|
*/
|
|
int ignore_xfer_request ( struct xfer_interface *xfer __unused,
|
|
off_t offset __unused, int whence __unused,
|
|
size_t len __unused ) {
|
|
return 0;
|
|
}
|
|
|
|
/**
|
|
* Ignore seek() event
|
|
*
|
|
* @v xfer Data transfer interface
|
|
* @v offset Offset to new position
|
|
* @v whence Basis for new position
|
|
* @ret rc Return status code
|
|
*/
|
|
int ignore_xfer_seek ( struct xfer_interface *xfer __unused,
|
|
off_t offset __unused, int whence __unused ) {
|
|
return 0;
|
|
}
|
|
|
|
/**
|
|
* Allocate I/O buffer
|
|
*
|
|
* @v xfer Data transfer interface
|
|
* @v len I/O buffer payload length
|
|
* @ret iobuf I/O buffer
|
|
*/
|
|
struct io_buffer *
|
|
default_xfer_alloc_iob ( struct xfer_interface *xfer __unused, size_t len ) {
|
|
return alloc_iob ( len );
|
|
}
|
|
|
|
/**
|
|
* Deliver datagram as raw data
|
|
*
|
|
* @v xfer Data transfer interface
|
|
* @v iobuf Datagram I/O buffer
|
|
* @ret rc Return status code
|
|
*
|
|
* This function is intended to be used as the deliver() method for
|
|
* data transfer interfaces that prefer to handle raw data.
|
|
*/
|
|
int xfer_deliver_as_raw ( struct xfer_interface *xfer,
|
|
struct io_buffer *iobuf ) {
|
|
int rc;
|
|
|
|
rc = xfer->op->deliver_raw ( xfer, iobuf->data, iob_len ( iobuf ) );
|
|
free_iob ( iobuf );
|
|
return rc;
|
|
}
|
|
|
|
/**
|
|
* Deliver datagram as I/O buffer
|
|
*
|
|
* @v xfer Data transfer interface
|
|
* @v data Data buffer
|
|
* @v len Length of data buffer
|
|
* @ret rc Return status code
|
|
*
|
|
* This function is intended to be used as the deliver_raw() method
|
|
* for data transfer interfaces that prefer to handle I/O buffers.
|
|
*/
|
|
int xfer_deliver_as_iob ( struct xfer_interface *xfer,
|
|
const void *data, size_t len ) {
|
|
struct io_buffer *iobuf;
|
|
|
|
iobuf = xfer->op->alloc_iob ( xfer, len );
|
|
if ( ! iobuf )
|
|
return -ENOMEM;
|
|
|
|
memcpy ( iob_put ( iobuf, len ), data, len );
|
|
return xfer->op->deliver_iob ( xfer, iobuf );
|
|
}
|
|
|
|
/**
|
|
* Ignore datagram as raw data event
|
|
*
|
|
* @v xfer Data transfer interface
|
|
* @v data Data buffer
|
|
* @v len Length of data buffer
|
|
* @ret rc Return status code
|
|
*/
|
|
int ignore_xfer_deliver_raw ( struct xfer_interface *xfer,
|
|
const void *data __unused, size_t len ) {
|
|
DBGC ( xfer, "XFER %p %zd bytes delivered %s\n", xfer, len,
|
|
( ( xfer == &null_xfer ) ?
|
|
"before connection" : "after termination" ) );
|
|
return 0;
|
|
}
|
|
|
|
/** Null data transfer interface operations */
|
|
struct xfer_interface_operations null_xfer_ops = {
|
|
.close = ignore_xfer_close,
|
|
.vredirect = ignore_xfer_vredirect,
|
|
.request = ignore_xfer_request,
|
|
.seek = ignore_xfer_seek,
|
|
.alloc_iob = default_xfer_alloc_iob,
|
|
.deliver_iob = xfer_deliver_as_raw,
|
|
.deliver_raw = ignore_xfer_deliver_raw,
|
|
};
|
|
|
|
/**
|
|
* Null data transfer interface
|
|
*
|
|
* This is the interface to which data transfer interfaces are
|
|
* connected when unplugged. It will never generate messages, and
|
|
* will silently absorb all received messages.
|
|
*/
|
|
struct xfer_interface null_xfer = {
|
|
.intf = {
|
|
.dest = &null_xfer.intf,
|
|
.refcnt = NULL,
|
|
},
|
|
.op = &null_xfer_ops,
|
|
};
|