lib/ofpbuf.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18 #include "ofpbuf.h"
  19 #include <assert.h>
  20 #include <stdlib.h>
  21 #include <string.h>
  22 #include "dynamic-string.h"
  23 #include "util.h"
  24
  25 static void
  26 ofpbuf_use__(struct ofpbuf *b, void *base, size_t allocated,
  27              enum ofpbuf_source source)
  28 {
  29     b->base = b->data = base;
  30     b->allocated = allocated;
  31     b->source = source;
  32     b->size = 0;
  33     b->l2 = b->l3 = b->l4 = b->l7 = NULL;
  34     list_poison(&b->list_node);
  35     b->private_p = NULL;
  36 }
  37
  38 /* Initializes 'b' as an empty ofpbuf that contains the 'allocated' bytes of
  39  * memory starting at 'base'.  'base' should be the first byte of a region
  40  * obtained from malloc().  It will be freed (with free()) if 'b' is resized or
  41  * freed. */
  42 void
  43 ofpbuf_use(struct ofpbuf *b, void *base, size_t allocated)
  44 {
  45     ofpbuf_use__(b, base, allocated, OFPBUF_MALLOC);
  46 }
  47
  48 /* Initializes 'b' as an empty ofpbuf that contains the 'allocated' bytes of
  49  * memory starting at 'base'.  'base' should point to a buffer on the stack.
  50  *
  51  * An ofpbuf operation that requires reallocating data will assert-fail if this
  52  * function was used to initialize it.
  53  *
  54  * 'base' should be appropriately aligned.  Using an array of uint32_t or
  55  * uint64_t for the buffer is a reasonable way to ensure appropriate alignment
  56  * for 32- or 64-bit data.
  57  *
  58  * (Nothing actually relies on 'base' being allocated on the stack.  It could
  59  * be static or malloc()'d memory.  But stack space is the most common use
  60  * case.) */
  61 void
  62 ofpbuf_use_stack(struct ofpbuf *b, void *base, size_t allocated)
  63 {
  64     ofpbuf_use__(b, base, allocated, OFPBUF_STACK);
  65 }
  66
  67 /* Initializes 'b' as an ofpbuf whose data starts at 'data' and continues for
  68  * 'size' bytes.  This is appropriate for an ofpbuf that will be used to
  69  * inspect existing data, without moving it around or reallocating it, and
  70  * generally without modifying it at all.
  71  *
  72  * An ofpbuf operation that requires reallocating data will assert-fail if this
  73  * function was used to initialize it. */
  74 void
  75 ofpbuf_use_const(struct ofpbuf *b, const void *data, size_t size)
  76 {
  77     ofpbuf_use__(b, (void *) data, size, OFPBUF_STACK);
  78     b->size = size;
  79 }
  80
  81 /* Initializes 'b' as an empty ofpbuf with an initial capacity of 'size'
  82  * bytes. */
  83 void
  84 ofpbuf_init(struct ofpbuf *b, size_t size)
  85 {
  86     ofpbuf_use(b, size ? xmalloc(size) : NULL, size);
  87 }
  88
  89 /* Frees memory that 'b' points to. */
  90 void
  91 ofpbuf_uninit(struct ofpbuf *b)
  92 {
  93     if (b && b->source == OFPBUF_MALLOC) {
  94         free(b->base);
  95     }
  96 }
  97
  98 /* Frees memory that 'b' points to and allocates a new ofpbuf */
  99 void
 100 ofpbuf_reinit(struct ofpbuf *b, size_t size)
 101 {
 102     ofpbuf_uninit(b);
 103     ofpbuf_init(b, size);
 104 }
 105
 106 /* Creates and returns a new ofpbuf with an initial capacity of 'size'
 107  * bytes. */
 108 struct ofpbuf *
 109 ofpbuf_new(size_t size)
 110 {
 111     struct ofpbuf *b = xmalloc(sizeof *b);
 112     ofpbuf_init(b, size);
 113     return b;
 114 }
 115
 116 /* Creates and returns a new ofpbuf with an initial capacity of 'size +
 117  * headroom' bytes, reserving the first 'headroom' bytes as headroom. */
 118 struct ofpbuf *
 119 ofpbuf_new_with_headroom(size_t size, size_t headroom)
 120 {
 121     struct ofpbuf *b = ofpbuf_new(size + headroom);
 122     ofpbuf_reserve(b, headroom);
 123     return b;
 124 }
 125
 126 /* Creates and returns a new ofpbuf that initially contains a copy of the
 127  * 'buffer->size' bytes of data starting at 'buffer->data' with no headroom or
 128  * tailroom. */
 129 struct ofpbuf *
 130 ofpbuf_clone(const struct ofpbuf *buffer)
 131 {
 132     return ofpbuf_clone_with_headroom(buffer, 0);
 133 }
 134
 135 /* Creates and returns a new ofpbuf whose data are copied from 'buffer'.   The
 136  * returned ofpbuf will additionally have 'headroom' bytes of headroom. */
 137 struct ofpbuf *
 138 ofpbuf_clone_with_headroom(const struct ofpbuf *buffer, size_t headroom)
 139 {
 140     struct ofpbuf *new_buffer;
 141     uintptr_t data_delta;
 142
 143     new_buffer = ofpbuf_clone_data_with_headroom(buffer->data, buffer->size,
 144                                                  headroom);
 145     data_delta = (char *) new_buffer->data - (char *) buffer->data;
 146
 147     if (buffer->l2) {
 148         new_buffer->l2 = (char *) buffer->l2 + data_delta;
 149     }
 150     if (buffer->l3) {
 151         new_buffer->l3 = (char *) buffer->l3 + data_delta;
 152     }
 153     if (buffer->l4) {
 154         new_buffer->l4 = (char *) buffer->l4 + data_delta;
 155     }
 156     if (buffer->l7) {
 157         new_buffer->l7 = (char *) buffer->l7 + data_delta;
 158     }
 159
 160     return new_buffer;
 161 }
 162
 163 /* Creates and returns a new ofpbuf that initially contains a copy of the
 164  * 'size' bytes of data starting at 'data' with no headroom or tailroom. */
 165 struct ofpbuf *
 166 ofpbuf_clone_data(const void *data, size_t size)
 167 {
 168     return ofpbuf_clone_data_with_headroom(data, size, 0);
 169 }
 170
 171 /* Creates and returns a new ofpbuf that initially contains 'headroom' bytes of
 172  * headroom followed by a copy of the 'size' bytes of data starting at
 173  * 'data'. */
 174 struct ofpbuf *
 175 ofpbuf_clone_data_with_headroom(const void *data, size_t size, size_t headroom)
 176 {
 177     struct ofpbuf *b = ofpbuf_new_with_headroom(size, headroom);
 178     ofpbuf_put(b, data, size);
 179     return b;
 180 }
 181
 182 /* Frees memory that 'b' points to, as well as 'b' itself. */
 183 void
 184 ofpbuf_delete(struct ofpbuf *b)
 185 {
 186     if (b) {
 187         ofpbuf_uninit(b);
 188         free(b);
 189     }
 190 }
 191
 192 /* Returns the number of bytes of headroom in 'b', that is, the number of bytes
 193  * of unused space in ofpbuf 'b' before the data that is in use.  (Most
 194  * commonly, the data in a ofpbuf is at its beginning, and thus the ofpbuf's
 195  * headroom is 0.) */
 196 size_t
 197 ofpbuf_headroom(const struct ofpbuf *b)
 198 {
 199     return (char*)b->data - (char*)b->base;
 200 }
 201
 202 /* Returns the number of bytes that may be appended to the tail end of ofpbuf
 203  * 'b' before the ofpbuf must be reallocated. */
 204 size_t
 205 ofpbuf_tailroom(const struct ofpbuf *b)
 206 {
 207     return (char*)ofpbuf_end(b) - (char*)ofpbuf_tail(b);
 208 }
 209
 210 static void
 211 ofpbuf_copy__(struct ofpbuf *b, uint8_t *new_base,
 212               size_t new_headroom, size_t new_tailroom)
 213 {
 214     const uint8_t *old_base = b->base;
 215     size_t old_headroom = ofpbuf_headroom(b);
 216     size_t old_tailroom = ofpbuf_tailroom(b);
 217     size_t copy_headroom = MIN(old_headroom, new_headroom);
 218     size_t copy_tailroom = MIN(old_tailroom, new_tailroom);
 219
 220     memcpy(&new_base[new_headroom - copy_headroom],
 221            &old_base[old_headroom - copy_headroom],
 222            copy_headroom + b->size + copy_tailroom);
 223 }
 224
 225 /* Reallocates 'b' so that it has exactly 'new_headroom' and 'new_tailroom'
 226  * bytes of headroom and tailroom, respectively. */
 227 static void
 228 ofpbuf_resize__(struct ofpbuf *b, size_t new_headroom, size_t new_tailroom)
 229 {
 230     void *new_base, *new_data;
 231     size_t new_allocated;
 232
 233     new_allocated = new_headroom + b->size + new_tailroom;
 234
 235     switch (b->source) {
 236     case OFPBUF_MALLOC:
 237         if (new_headroom == ofpbuf_headroom(b)) {
 238             new_base = xrealloc(b->base, new_allocated);
 239         } else {
 240             new_base = xmalloc(new_allocated);
 241             ofpbuf_copy__(b, new_base, new_headroom, new_tailroom);
 242             free(b->base);
 243         }
 244         break;
 245
 246     case OFPBUF_STACK:
 247         NOT_REACHED();
 248
 249     default:
 250         NOT_REACHED();
 251     }
 252
 253     b->allocated = new_allocated;
 254     b->base = new_base;
 255
 256     new_data = (char *) new_base + new_headroom;
 257     if (b->data != new_data) {
 258         uintptr_t data_delta = (char *) new_data - (char *) b->data;
 259         b->data = new_data;
 260         if (b->l2) {
 261             b->l2 = (char *) b->l2 + data_delta;
 262         }
 263         if (b->l3) {
 264             b->l3 = (char *) b->l3 + data_delta;
 265         }
 266         if (b->l4) {
 267             b->l4 = (char *) b->l4 + data_delta;
 268         }
 269         if (b->l7) {
 270             b->l7 = (char *) b->l7 + data_delta;
 271         }
 272     }
 273 }
 274
 275 /* Ensures that 'b' has room for at least 'size' bytes at its tail end,
 276  * reallocating and copying its data if necessary.  Its headroom, if any, is
 277  * preserved. */
 278 void
 279 ofpbuf_prealloc_tailroom(struct ofpbuf *b, size_t size)
 280 {
 281     if (size > ofpbuf_tailroom(b)) {
 282         ofpbuf_resize__(b, ofpbuf_headroom(b), MAX(size, 64));
 283     }
 284 }
 285
 286 /* Ensures that 'b' has room for at least 'size' bytes at its head,
 287  * reallocating and copying its data if necessary.  Its tailroom, if any, is
 288  * preserved. */
 289 void
 290 ofpbuf_prealloc_headroom(struct ofpbuf *b, size_t size)
 291 {
 292     if (size > ofpbuf_headroom(b)) {
 293         ofpbuf_resize__(b, MAX(size, 64), ofpbuf_tailroom(b));
 294     }
 295 }
 296
 297 /* Trims the size of 'b' to fit its actual content, reducing its tailroom to
 298  * 0.  Its headroom, if any, is preserved.
 299  *
 300  * Buffers not obtained from malloc() are not resized, since that wouldn't save
 301  * any memory. */
 302 void
 303 ofpbuf_trim(struct ofpbuf *b)
 304 {
 305     if (b->source == OFPBUF_MALLOC
 306         && (ofpbuf_headroom(b) || ofpbuf_tailroom(b))) {
 307         ofpbuf_resize__(b, 0, 0);
 308     }
 309 }
 310
 311 /* If 'b' is shorter than 'length' bytes, pads its tail out with zeros to that
 312  * length. */
 313 void
 314 ofpbuf_padto(struct ofpbuf *b, size_t length)
 315 {
 316     if (b->size < length) {
 317         ofpbuf_put_zeros(b, length - b->size);
 318     }
 319 }
 320
 321 /* Appends 'size' bytes of data to the tail end of 'b', reallocating and
 322  * copying its data if necessary.  Returns a pointer to the first byte of the
 323  * new data, which is left uninitialized. */
 324 void *
 325 ofpbuf_put_uninit(struct ofpbuf *b, size_t size)
 326 {
 327     void *p;
 328     ofpbuf_prealloc_tailroom(b, size);
 329     p = ofpbuf_tail(b);
 330     b->size += size;
 331     return p;
 332 }
 333
 334 /* Appends 'size' zeroed bytes to the tail end of 'b'.  Data in 'b' is
 335  * reallocated and copied if necessary.  Returns a pointer to the first byte of
 336  * the data's location in the ofpbuf. */
 337 void *
 338 ofpbuf_put_zeros(struct ofpbuf *b, size_t size)
 339 {
 340     void *dst = ofpbuf_put_uninit(b, size);
 341     memset(dst, 0, size);
 342     return dst;
 343 }
 344
 345 /* Appends the 'size' bytes of data in 'p' to the tail end of 'b'.  Data in 'b'
 346  * is reallocated and copied if necessary.  Returns a pointer to the first
 347  * byte of the data's location in the ofpbuf. */
 348 void *
 349 ofpbuf_put(struct ofpbuf *b, const void *p, size_t size)
 350 {
 351     void *dst = ofpbuf_put_uninit(b, size);
 352     memcpy(dst, p, size);
 353     return dst;
 354 }
 355
 356 /* Parses as many pairs of hex digits as possible (possibly separated by
 357  * spaces) from the beginning of 's', appending bytes for their values to 'b'.
 358  * Returns the first character of 's' that is not the first of a pair of hex
 359  * digits.  If 'n' is nonnull, stores the number of bytes added to 'b' in
 360  * '*n'. */
 361 char *
 362 ofpbuf_put_hex(struct ofpbuf *b, const char *s, size_t *n)
 363 {
 364     size_t initial_size = b->size;
 365     for (;;) {
 366         uint8_t byte;
 367         bool ok;
 368
 369         s += strspn(s, " ");
 370         byte = hexits_value(s, 2, &ok);
 371         if (!ok) {
 372             if (n) {
 373                 *n = b->size - initial_size;
 374             }
 375             return (char *) s;
 376         }
 377
 378         ofpbuf_put(b, &byte, 1);
 379         s += 2;
 380     }
 381 }
 382
 383 /* Reserves 'size' bytes of headroom so that they can be later allocated with
 384  * ofpbuf_push_uninit() without reallocating the ofpbuf. */
 385 void
 386 ofpbuf_reserve(struct ofpbuf *b, size_t size)
 387 {
 388     assert(!b->size);
 389     ofpbuf_prealloc_tailroom(b, size);
 390     b->data = (char*)b->data + size;
 391 }
 392
 393 /* Prefixes 'size' bytes to the head end of 'b', reallocating and copying its
 394  * data if necessary.  Returns a pointer to the first byte of the data's
 395  * location in the ofpbuf.  The new data is left uninitialized. */
 396 void *
 397 ofpbuf_push_uninit(struct ofpbuf *b, size_t size)
 398 {
 399     ofpbuf_prealloc_headroom(b, size);
 400     b->data = (char*)b->data - size;
 401     b->size += size;
 402     return b->data;
 403 }
 404
 405 /* Prefixes 'size' zeroed bytes to the head end of 'b', reallocating and
 406  * copying its data if necessary.  Returns a pointer to the first byte of the
 407  * data's location in the ofpbuf. */
 408 void *
 409 ofpbuf_push_zeros(struct ofpbuf *b, size_t size)
 410 {
 411     void *dst = ofpbuf_push_uninit(b, size);
 412     memset(dst, 0, size);
 413     return dst;
 414 }
 415
 416 /* Copies the 'size' bytes starting at 'p' to the head end of 'b', reallocating
 417  * and copying its data if necessary.  Returns a pointer to the first byte of
 418  * the data's location in the ofpbuf. */
 419 void *
 420 ofpbuf_push(struct ofpbuf *b, const void *p, size_t size)
 421 {
 422     void *dst = ofpbuf_push_uninit(b, size);
 423     memcpy(dst, p, size);
 424     return dst;
 425 }
 426
 427 /* If 'b' contains at least 'offset + size' bytes of data, returns a pointer to
 428  * byte 'offset'.  Otherwise, returns a null pointer. */
 429 void *
 430 ofpbuf_at(const struct ofpbuf *b, size_t offset, size_t size)
 431 {
 432     return offset + size <= b->size ? (char *) b->data + offset : NULL;
 433 }
 434
 435 /* Returns a pointer to byte 'offset' in 'b', which must contain at least
 436  * 'offset + size' bytes of data. */
 437 void *
 438 ofpbuf_at_assert(const struct ofpbuf *b, size_t offset, size_t size)
 439 {
 440     assert(offset + size <= b->size);
 441     return ((char *) b->data) + offset;
 442 }
 443
 444 /* Returns the byte following the last byte of data in use in 'b'. */
 445 void *
 446 ofpbuf_tail(const struct ofpbuf *b)
 447 {
 448     return (char *) b->data + b->size;
 449 }
 450
 451 /* Returns the byte following the last byte allocated for use (but not
 452  * necessarily in use) by 'b'. */
 453 void *
 454 ofpbuf_end(const struct ofpbuf *b)
 455 {
 456     return (char *) b->base + b->allocated;
 457 }
 458
 459 /* Clears any data from 'b'. */
 460 void
 461 ofpbuf_clear(struct ofpbuf *b)
 462 {
 463     b->data = b->base;
 464     b->size = 0;
 465 }
 466
 467 /* Removes 'size' bytes from the head end of 'b', which must contain at least
 468  * 'size' bytes of data.  Returns the first byte of data removed. */
 469 void *
 470 ofpbuf_pull(struct ofpbuf *b, size_t size)
 471 {
 472     void *data = b->data;
 473     assert(b->size >= size);
 474     b->data = (char*)b->data + size;
 475     b->size -= size;
 476     return data;
 477 }
 478
 479 /* If 'b' has at least 'size' bytes of data, removes that many bytes from the
 480  * head end of 'b' and returns the first byte removed.  Otherwise, returns a
 481  * null pointer without modifying 'b'. */
 482 void *
 483 ofpbuf_try_pull(struct ofpbuf *b, size_t size)
 484 {
 485     return b->size >= size ? ofpbuf_pull(b, size) : NULL;
 486 }
 487
 488 /* Returns the data in 'b' as a block of malloc()'d memory and frees the buffer
 489  * within 'b'.  (If 'b' itself was dynamically allocated, e.g. with
 490  * ofpbuf_new(), then it should still be freed with, e.g., ofpbuf_delete().) */
 491 void *
 492 ofpbuf_steal_data(struct ofpbuf *b)
 493 {
 494     void *p;
 495     if (b->source == OFPBUF_MALLOC && b->data == b->base) {
 496         p = b->data;
 497     } else {
 498         p = xmemdup(b->data, b->size);
 499         if (b->source == OFPBUF_MALLOC) {
 500             free(b->base);
 501         }
 502     }
 503     b->base = b->data = NULL;
 504     return p;
 505 }
 506
 507 /* Returns a string that describes some of 'b''s metadata plus a hex dump of up
 508  * to 'maxbytes' from the start of the buffer. */
 509 char *
 510 ofpbuf_to_string(const struct ofpbuf *b, size_t maxbytes)
 511 {
 512     struct ds s;
 513
 514     ds_init(&s);
 515     ds_put_format(&s, "size=%zu, allocated=%zu, head=%zu, tail=%zu\n",
 516                   b->size, b->allocated,
 517                   ofpbuf_headroom(b), ofpbuf_tailroom(b));
 518     ds_put_hex_dump(&s, b->data, MIN(b->size, maxbytes), 0, false);
 519     return ds_cstr(&s);
 520 }
 521
 522 /* Removes each of the "struct ofpbuf"s on 'list' from the list and frees
 523  * them.  */
 524 void
 525 ofpbuf_list_delete(struct list *list)
 526 {
 527     struct ofpbuf *b, *next;
 528
 529     LIST_FOR_EACH_SAFE (b, next, list_node, list) {
 530         list_remove(&b->list_node);
 531         ofpbuf_delete(b);
 532     }
 533 }