lib/buffer.c

   1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   4  * We are making the OpenFlow specification and associated documentation
   5  * (Software) available for public use and benefit with the expectation
   6  * that others will use, modify and enhance the Software and contribute
   7  * those enhancements back to the community. However, since we would
   8  * like to make the Software available for broadest use, with as few
   9  * restrictions as possible permission is hereby granted, free of
  10  * charge, to any person obtaining a copy of this Software to deal in
  11  * the Software under the copyrights without restriction, including
  12  * without limitation the rights to use, copy, modify, merge, publish,
  13  * distribute, sublicense, and/or sell copies of the Software, and to
  14  * permit persons to whom the Software is furnished to do so, subject to
  15  * the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  *
  29  * The name and trademarks of copyright holder(s) may NOT be used in
  30  * advertising or publicity pertaining to the Software or any
  31  * derivatives without specific, written prior permission.
  32  */
  33
  34 #include <config.h>
  35 #include "buffer.h"
  36 #include <assert.h>
  37 #include <stdlib.h>
  38 #include <string.h>
  39 #include "util.h"
  40
  41 /* Initializes 'b' as an empty buffer that contains the 'allocated' bytes of
  42  * memory starting at 'base'.
  43  *
  44  * 'base' should ordinarily be the first byte of a region obtained from
  45  * malloc(), but in circumstances where it can be guaranteed that 'b' will
  46  * never need to be expanded or freed, it can be a pointer into arbitrary
  47  * memory. */
  48 void
  49 buffer_use(struct buffer *b, void *base, size_t allocated)
  50 {
  51     b->base = b->data = base;
  52     b->allocated = allocated;
  53     b->size = 0;
  54     b->l2 = b->l3 = b->l4 = b->l7 = NULL;
  55     b->next = NULL;
  56 }
  57
  58 /* Initializes 'b' as a buffer with an initial capacity of 'size' bytes. */
  59 void
  60 buffer_init(struct buffer *b, size_t size)
  61 {
  62     buffer_use(b, size ? xmalloc(size) : NULL, size);
  63 }
  64
  65 /* Frees memory that 'b' points to. */
  66 void
  67 buffer_uninit(struct buffer *b)
  68 {
  69     if (b) {
  70         free(b->base);
  71     }
  72 }
  73
  74 /* Frees memory that 'b' points to and allocates a new buffer */
  75 void
  76 buffer_reinit(struct buffer *b, size_t size)
  77 {
  78     buffer_uninit(b);
  79     buffer_init(b, size);
  80 }
  81
  82 /* Creates and returns a new buffer with an initial capacity of 'size'
  83  * bytes. */
  84 struct buffer *
  85 buffer_new(size_t size)
  86 {
  87     struct buffer *b = xmalloc(sizeof *b);
  88     buffer_init(b, size);
  89     return b;
  90 }
  91
  92 struct buffer *
  93 buffer_clone(const struct buffer *buffer)
  94 {
  95     /* FIXME: reference counting. */
  96     struct buffer *b = buffer_new(buffer->size);
  97     buffer_put(b, buffer->data, buffer->size);
  98     return b;
  99 }
 100
 101 /* Frees memory that 'b' points to, as well as 'b' itself. */
 102 void
 103 buffer_delete(struct buffer *b)
 104 {
 105     if (b) {
 106         buffer_uninit(b);
 107         free(b);
 108     }
 109 }
 110
 111 /* Returns the number of bytes of headroom in 'b', that is, the number of bytes
 112  * of unused space in buffer 'b' before the data that is in use.  (Most
 113  * commonly, the data in a buffer is at its beginning, and thus the buffer's
 114  * headroom is 0.) */
 115 size_t
 116 buffer_headroom(struct buffer *b)
 117 {
 118     return b->data - b->base;
 119 }
 120
 121 /* Returns the number of bytes that may be appended to the tail end of buffer
 122  * 'b' before the buffer must be reallocated. */
 123 size_t
 124 buffer_tailroom(struct buffer *b)
 125 {
 126     return buffer_end(b) - buffer_tail(b);
 127 }
 128
 129 /* Ensures that 'b' has room for at least 'size' bytes at its tail end,
 130  * reallocating and copying its data if necessary. */
 131 void
 132 buffer_prealloc_tailroom(struct buffer *b, size_t size)
 133 {
 134     if (size > buffer_tailroom(b)) {
 135         size_t new_allocated = b->allocated + MAX(size, 64);
 136         void *new_base = xmalloc(new_allocated);
 137         uintptr_t base_delta = new_base - b->base;
 138         memcpy(new_base, b->base, b->allocated);
 139         free(b->base);
 140         b->base = new_base;
 141         b->allocated = new_allocated;
 142         b->data += base_delta;
 143         if (b->l2) {
 144             b->l2 += base_delta;
 145         }
 146         if (b->l3) {
 147             b->l3 += base_delta;
 148         }
 149         if (b->l4) {
 150             b->l4 += base_delta;
 151         }
 152         if (b->l7) {
 153             b->l7 += base_delta;
 154         }
 155     }
 156 }
 157
 158 void
 159 buffer_prealloc_headroom(struct buffer *b, size_t size)
 160 {
 161     assert(size <= buffer_headroom(b));
 162 }
 163
 164 /* Appends 'size' bytes of data to the tail end of 'b', reallocating and
 165  * copying its data if necessary.  Returns a pointer to the first byte of the
 166  * new data, which is left uninitialized. */
 167 void *
 168 buffer_put_uninit(struct buffer *b, size_t size)
 169 {
 170     void *p;
 171     buffer_prealloc_tailroom(b, size);
 172     p = buffer_tail(b);
 173     b->size += size;
 174     return p;
 175 }
 176
 177 /* Appends the 'size' bytes of data in 'p' to the tail end of 'b'.  Data in 'b'
 178  * is reallocated and copied if necessary.  Returns a pointer to the first
 179  * byte of the data's location in the buffer. */
 180 void *
 181 buffer_put(struct buffer *b, const void *p, size_t size)
 182 {
 183     void *dst = buffer_put_uninit(b, size);
 184     memcpy(dst, p, size);
 185     return dst;
 186 }
 187
 188 /* Reserves 'size' bytes of headroom so that they can be later allocated with
 189  * buffer_push_uninit() without reallocating the buffer. */
 190 void
 191 buffer_reserve(struct buffer *b, size_t size)
 192 {
 193     assert(!b->size);
 194     buffer_prealloc_tailroom(b, size);
 195     b->data += size;
 196 }
 197
 198 void *
 199 buffer_push_uninit(struct buffer *b, size_t size)
 200 {
 201     buffer_prealloc_headroom(b, size);
 202     b->data -= size;
 203     b->size += size;
 204     return b->data;
 205 }
 206
 207 void *
 208 buffer_push(struct buffer *b, const void *p, size_t size)
 209 {
 210     void *dst = buffer_push_uninit(b, size);
 211     memcpy(dst, p, size);
 212     return dst;
 213 }
 214
 215 /* If 'b' contains at least 'offset + size' bytes of data, returns a pointer to
 216  * byte 'offset'.  Otherwise, returns a null pointers. */
 217 void *
 218 buffer_at(const struct buffer *b, size_t offset, size_t size)
 219 {
 220     return offset + size <= b->size ? (char *) b->data + offset : NULL;
 221 }
 222
 223 /* Returns a pointer to byte 'offset' in 'b', which must contain at least
 224  * 'offset + size' bytes of data. */
 225 void *
 226 buffer_at_assert(const struct buffer *b, size_t offset, size_t size)
 227 {
 228     assert(offset + size <= b->size);
 229     return ((char *) b->data) + offset;
 230 }
 231
 232 /* Returns the byte following the last byte of data in use in 'b'. */
 233 void *
 234 buffer_tail(const struct buffer *b)
 235 {
 236     return (char *) b->data + b->size;
 237 }
 238
 239 /* Returns the byte following the last byte allocated for use (but not
 240  * necessarily in use) by 'b'. */
 241 void *
 242 buffer_end(const struct buffer *b)
 243 {
 244     return (char *) b->base + b->allocated;
 245 }
 246
 247 /* Clears any data from 'b'. */
 248 void
 249 buffer_clear(struct buffer *b)
 250 {
 251     b->data = b->base;
 252     b->size = 0;
 253 }
 254
 255 /* Removes 'size' bytes from the head end of 'b', which must contain at least
 256  * 'size' bytes of data.  Returns the first byte of data removed. */
 257 void *
 258 buffer_pull(struct buffer *b, size_t size)
 259 {
 260     void *data = b->data;
 261     assert(b->size >= size);
 262     b->data += size;
 263     b->size -= size;
 264     return data;
 265 }
 266
 267 /* If 'b' has at least 'size' bytes of data, removes that many bytes from the
 268  * head end of 'b' and returns the first byte removed.  Otherwise, returns a
 269  * null pointer without modifying 'b'. */
 270 void *
 271 buffer_try_pull(struct buffer *b, size_t size)
 272 {
 273     return b->size >= size ? buffer_pull(b, size) : NULL;
 274 }