Remove xfer_ready() (it has been replaced by xfer_window())
[people/holger/gpxe.git] / src / core / xfer.c
index f2783f5..0689587 100644 (file)
@@ -17,6 +17,7 @@
  */
 
 #include <string.h>
+#include <stdio.h>
 #include <errno.h>
 #include <gpxe/xfer.h>
 
@@ -35,6 +36,8 @@
 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 );
@@ -52,7 +55,14 @@ 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;
 }
@@ -76,49 +86,44 @@ int xfer_redirect ( struct xfer_interface *xfer, int type, ... ) {
 }
 
 /**
- * Request data
+ * Seek to position
  *
  * @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 ) {
+int xfer_seek ( struct xfer_interface *xfer, off_t offset, int whence ) {
        struct xfer_interface *dest = xfer_get_dest ( xfer );
        int rc;
 
-       rc = dest->op->request ( dest, offset, whence, len );
+       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;
 }
 
 /**
- * Request all data
+ * Check flow control window
  *
  * @v xfer             Data transfer interface
- * @ret rc             Return status code
- */
-int xfer_request_all ( struct xfer_interface *xfer ) {
-       return xfer_request ( xfer, 0, SEEK_SET, ~( ( size_t ) 0 ) );
-}
-
-/**
- * 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
+ * @ret len            Length of window
  */
-int xfer_seek ( struct xfer_interface *xfer, off_t offset, int whence ) {
+size_t xfer_window ( struct xfer_interface *xfer ) {
        struct xfer_interface *dest = xfer_get_dest ( xfer );
-       int rc;
+       size_t len;
+
+       len = dest->op->window ( dest );
 
-       rc = dest->op->seek ( dest, offset, whence );
        xfer_put ( dest );
-       return rc;
+       return len;
 }
 
 /**
@@ -132,27 +137,56 @@ 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
+ * Deliver datagram as I/O buffer with metadata
  *
  * @v xfer             Data transfer interface
  * @v iobuf            Datagram I/O buffer
+ * @v meta             Data transfer metadata, or NULL
  * @ret rc             Return status code
  */
-int xfer_deliver_iob ( struct xfer_interface *xfer, struct io_buffer *iobuf ) {
+int xfer_deliver_iob_meta ( struct xfer_interface *xfer,
+                           struct io_buffer *iobuf,
+                           struct xfer_metadata *meta ) {
        struct xfer_interface *dest = xfer_get_dest ( xfer );
        int rc;
 
-       rc = dest->op->deliver_iob ( dest, iobuf );
+       DBGC ( xfer, "XFER %p->%p deliver_iob %zd\n", xfer, dest,
+              iob_len ( iobuf ) );
+
+       rc = dest->op->deliver_iob ( dest, iobuf, meta );
+
+       if ( rc != 0 ) {
+               DBGC ( xfer, "XFER %p<-%p deliver_iob: %s\n", xfer, dest,
+                      strerror ( rc ) );
+       }
        xfer_put ( dest );
        return rc;
 }
 
+/**
+ * Deliver datagram as I/O buffer with metadata
+ *
+ * @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 ) {
+       return xfer_deliver_iob_meta ( xfer, iobuf, NULL );
+}
+
 /**
  * Deliver datagram as raw data
  *
@@ -165,11 +199,60 @@ int xfer_deliver_raw ( struct xfer_interface *xfer,
        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
@@ -204,30 +287,41 @@ int ignore_xfer_vredirect ( struct xfer_interface *xfer __unused,
 }
 
 /**
- * Ignore request() event
+ * Ignore seek() 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 ) {
+int ignore_xfer_seek ( struct xfer_interface *xfer __unused,
+                      off_t offset __unused, int whence __unused ) {
        return 0;
 }
 
 /**
- * Ignore seek() event
+ * Unlimited flow control window
  *
  * @v xfer             Data transfer interface
- * @v offset           Offset to new position
- * @v whence           Basis for new position
- * @ret rc             Return status code
+ * @ret len            Length of window
+ *
+ * This handler indicates that the interface is always ready to accept
+ * data.
  */
-int ignore_xfer_seek ( struct xfer_interface *xfer __unused,
-                      off_t offset __unused, int whence __unused ) {
+size_t unlimited_xfer_window ( struct xfer_interface *xfer __unused ) {
+       return ~( ( size_t ) 0 );
+}
+
+/**
+ * No flow control window
+ *
+ * @v xfer             Data transfer interface
+ * @ret len            Length of window
+ *
+ * This handler indicates that the interface is never ready to accept
+ * data.
+ */
+size_t no_xfer_window ( struct xfer_interface *xfer __unused ) {
        return 0;
 }
 
@@ -248,13 +342,15 @@ default_xfer_alloc_iob ( struct xfer_interface *xfer __unused, size_t len ) {
  *
  * @v xfer             Data transfer interface
  * @v iobuf            Datagram I/O buffer
+ * @v meta             Data transfer metadata
  * @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 ) {
+                         struct io_buffer *iobuf,
+                         struct xfer_metadata *meta __unused ) {
        int rc;
 
        rc = xfer->op->deliver_raw ( xfer, iobuf->data, iob_len ( iobuf ) );
@@ -282,7 +378,7 @@ int xfer_deliver_as_iob ( struct xfer_interface *xfer,
                return -ENOMEM;
 
        memcpy ( iob_put ( iobuf, len ), data, len );
-       return xfer->op->deliver_iob ( xfer, iobuf );
+       return xfer->op->deliver_iob ( xfer, iobuf, NULL );
 }
 
 /**
@@ -305,8 +401,8 @@ int ignore_xfer_deliver_raw ( struct xfer_interface *xfer,
 struct xfer_interface_operations null_xfer_ops = {
        .close          = ignore_xfer_close,
        .vredirect      = ignore_xfer_vredirect,
-       .request        = ignore_xfer_request,
        .seek           = ignore_xfer_seek,
+       .window         = unlimited_xfer_window,
        .alloc_iob      = default_xfer_alloc_iob,
        .deliver_iob    = xfer_deliver_as_raw,
        .deliver_raw    = ignore_xfer_deliver_raw,