src/include/gpxe/iobuf.h

   1 #ifndef _GPXE_IOBUF_H
   2 #define _GPXE_IOBUF_H
   3
   4 /** @file
   5  *
   6  * I/O buffers
   7  *
   8  */
   9
  10 #include <stdint.h>
  11 #include <assert.h>
  12 #include <gpxe/list.h>
  13
  14 /**
  15  * A persistent I/O buffer
  16  *
  17  * This data structure encapsulates a long-lived I/O buffer.  The
  18  * buffer may be passed between multiple owners, queued for possible
  19  * retransmission, etc.
  20  */
  21 struct io_buffer {
  22         /** List of which this buffer is a member
  23          *
  24          * The list must belong to the current owner of the buffer.
  25          * Different owners may maintain different lists (e.g. a
  26          * retransmission list for TCP).
  27          */
  28         struct list_head list;
  29
  30         /** Start of the buffer */
  31         void *head;
  32         /** Start of data */
  33         void *data;
  34         /** End of data */
  35         void *tail;
  36         /** End of the buffer */
  37         void *end;
  38 };
  39
  40 /**
  41  * Reserve space at start of I/O buffer
  42  *
  43  * @v iob       I/O buffer
  44  * @v len       Length to reserve
  45  * @ret data    Pointer to new start of buffer
  46  */
  47 static inline void * iob_reserve ( struct io_buffer *iob, size_t len ) {
  48         iob->data += len;
  49         iob->tail += len;
  50         assert ( iob->tail <= iob->end );
  51         return iob->data;
  52 }
  53
  54 /**
  55  * Add data to start of I/O buffer
  56  *
  57  * @v iob       I/O buffer
  58  * @v len       Length to add
  59  * @ret data    Pointer to new start of buffer
  60  */
  61 static inline void * iob_push ( struct io_buffer *iob, size_t len ) {
  62         iob->data -= len;
  63         assert ( iob->data >= iob->head );
  64         return iob->data;
  65 }
  66
  67 /**
  68  * Remove data from start of I/O buffer
  69  *
  70  * @v iob       I/O buffer
  71  * @v len       Length to remove
  72  * @ret data    Pointer to new start of buffer
  73  */
  74 static inline void * iob_pull ( struct io_buffer *iob, size_t len ) {
  75         iob->data += len;
  76         assert ( iob->data <= iob->tail );
  77         return iob->data;
  78 }
  79
  80 /**
  81  * Add data to end of I/O buffer
  82  *
  83  * @v iob       I/O buffer
  84  * @v len       Length to add
  85  * @ret data    Pointer to newly added space
  86  */
  87 static inline void * iob_put ( struct io_buffer *iob, size_t len ) {
  88         void *old_tail = iob->tail;
  89         iob->tail += len;
  90         assert ( iob->tail <= iob->end );
  91         return old_tail;
  92 }
  93
  94 /**
  95  * Remove data from end of I/O buffer
  96  *
  97  * @v iob       I/O buffer
  98  * @v len       Length to remove
  99  */
 100 static inline void iob_unput ( struct io_buffer *iob, size_t len ) {
 101         iob->tail -= len;
 102         assert ( iob->tail >= iob->data );
 103 }
 104
 105 /**
 106  * Empty an I/O buffer
 107  *
 108  * @v iob       I/O buffer
 109  */
 110 static inline void iob_empty ( struct io_buffer *iob ) {
 111         iob->tail = iob->data;
 112 }
 113
 114 /**
 115  * Calculate length of data in an I/O buffer
 116  *
 117  * @v iob       I/O buffer
 118  * @ret len     Length of data in buffer
 119  */
 120 static inline size_t iob_len ( struct io_buffer *iob ) {
 121         return ( iob->tail - iob->data );
 122 }
 123
 124 /**
 125  * Calculate available space at start of an I/O buffer
 126  *
 127  * @v iob       I/O buffer
 128  * @ret len     Length of data available at start of buffer
 129  */
 130 static inline size_t iob_headroom ( struct io_buffer *iob ) {
 131         return ( iob->data - iob->head );
 132 }
 133
 134 /**
 135  * Calculate available space at end of an I/O buffer
 136  *
 137  * @v iob       I/O buffer
 138  * @ret len     Length of data available at end of buffer
 139  */
 140 static inline size_t iob_tailroom ( struct io_buffer *iob ) {
 141         return ( iob->end - iob->tail );
 142 }
 143
 144 extern struct io_buffer * alloc_iob ( size_t len );
 145 extern void free_iob ( struct io_buffer *iob );
 146 extern void iob_pad ( struct io_buffer *iob, size_t min_len );
 147
 148 #endif /* _GPXE_IOBUF_H */