lib/ofpbuf.c

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