lib/ofpbuf.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 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 <stdlib.h>
  20 #include <string.h>
  21 #include "dynamic-string.h"
  22 #include "netdev-dpdk.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->l2_5 = 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.
  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 use
  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.
  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, CONST_CAST(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) {
 115         if (b->source == OFPBUF_MALLOC) {
 116             free(b->base);
 117         }
 118         if (b->source == OFPBUF_DPDK) {
 119             free_dpdk_buf(b);
 120         }
 121     }
 122 }
 123
 124 /* Returns a pointer that may be passed to free() to accomplish the same thing
 125  * as ofpbuf_uninit(b).  The return value is a null pointer if ofpbuf_uninit()
 126  * would not free any memory. */
 127 void *
 128 ofpbuf_get_uninit_pointer(struct ofpbuf *b)
 129 {
 130     return b && b->source == OFPBUF_MALLOC ? b->base : NULL;
 131 }
 132
 133 /* Frees memory that 'b' points to and allocates a new ofpbuf */
 134 void
 135 ofpbuf_reinit(struct ofpbuf *b, size_t size)
 136 {
 137     ofpbuf_uninit(b);
 138     ofpbuf_init(b, size);
 139 }
 140
 141 /* Creates and returns a new ofpbuf with an initial capacity of 'size'
 142  * bytes. */
 143 struct ofpbuf *
 144 ofpbuf_new(size_t size)
 145 {
 146     struct ofpbuf *b = xmalloc(sizeof *b);
 147     ofpbuf_init(b, size);
 148     return b;
 149 }
 150
 151 /* Creates and returns a new ofpbuf with an initial capacity of 'size +
 152  * headroom' bytes, reserving the first 'headroom' bytes as headroom. */
 153 struct ofpbuf *
 154 ofpbuf_new_with_headroom(size_t size, size_t headroom)
 155 {
 156     struct ofpbuf *b = ofpbuf_new(size + headroom);
 157     ofpbuf_reserve(b, headroom);
 158     return b;
 159 }
 160
 161 /* Creates and returns a new ofpbuf that initially contains a copy of the
 162  * 'buffer->size' bytes of data starting at 'buffer->data' with no headroom or
 163  * tailroom. */
 164 struct ofpbuf *
 165 ofpbuf_clone(const struct ofpbuf *buffer)
 166 {
 167     return ofpbuf_clone_with_headroom(buffer, 0);
 168 }
 169
 170 /* Creates and returns a new ofpbuf whose data are copied from 'buffer'.   The
 171  * returned ofpbuf will additionally have 'headroom' bytes of headroom. */
 172 struct ofpbuf *
 173 ofpbuf_clone_with_headroom(const struct ofpbuf *buffer, size_t headroom)
 174 {
 175     struct ofpbuf *new_buffer;
 176     uintptr_t data_delta;
 177
 178     new_buffer = ofpbuf_clone_data_with_headroom(buffer->data, buffer->size,
 179                                                  headroom);
 180     data_delta = (char *) new_buffer->data - (char *) buffer->data;
 181
 182     if (buffer->l2) {
 183         new_buffer->l2 = (char *) buffer->l2 + data_delta;
 184     }
 185     if (buffer->l2_5) {
 186         new_buffer->l2_5 = (char *) buffer->l2_5 + data_delta;
 187     }
 188     if (buffer->l3) {
 189         new_buffer->l3 = (char *) buffer->l3 + data_delta;
 190     }
 191     if (buffer->l4) {
 192         new_buffer->l4 = (char *) buffer->l4 + data_delta;
 193     }
 194     if (buffer->l7) {
 195         new_buffer->l7 = (char *) buffer->l7 + data_delta;
 196     }
 197
 198     return new_buffer;
 199 }
 200
 201 /* Creates and returns a new ofpbuf that initially contains a copy of the
 202  * 'size' bytes of data starting at 'data' with no headroom or tailroom. */
 203 struct ofpbuf *
 204 ofpbuf_clone_data(const void *data, size_t size)
 205 {
 206     return ofpbuf_clone_data_with_headroom(data, size, 0);
 207 }
 208
 209 /* Creates and returns a new ofpbuf that initially contains 'headroom' bytes of
 210  * headroom followed by a copy of the 'size' bytes of data starting at
 211  * 'data'. */
 212 struct ofpbuf *
 213 ofpbuf_clone_data_with_headroom(const void *data, size_t size, size_t headroom)
 214 {
 215     struct ofpbuf *b = ofpbuf_new_with_headroom(size, headroom);
 216     ofpbuf_put(b, data, size);
 217     return b;
 218 }
 219
 220 /* Frees memory that 'b' points to, as well as 'b' itself. */
 221 void
 222 ofpbuf_delete(struct ofpbuf *b)
 223 {
 224     if (b) {
 225         ofpbuf_uninit(b);
 226         free(b);
 227     }
 228 }
 229
 230 /* Returns the number of bytes of headroom in 'b', that is, the number of bytes
 231  * of unused space in ofpbuf 'b' before the data that is in use.  (Most
 232  * commonly, the data in a ofpbuf is at its beginning, and thus the ofpbuf's
 233  * headroom is 0.) */
 234 size_t
 235 ofpbuf_headroom(const struct ofpbuf *b)
 236 {
 237     return (char*)b->data - (char*)b->base;
 238 }
 239
 240 /* Returns the number of bytes that may be appended to the tail end of ofpbuf
 241  * 'b' before the ofpbuf must be reallocated. */
 242 size_t
 243 ofpbuf_tailroom(const struct ofpbuf *b)
 244 {
 245     return (char*)ofpbuf_end(b) - (char*)ofpbuf_tail(b);
 246 }
 247
 248 static void
 249 ofpbuf_copy__(struct ofpbuf *b, uint8_t *new_base,
 250               size_t new_headroom, size_t new_tailroom)
 251 {
 252     const uint8_t *old_base = b->base;
 253     size_t old_headroom = ofpbuf_headroom(b);
 254     size_t old_tailroom = ofpbuf_tailroom(b);
 255     size_t copy_headroom = MIN(old_headroom, new_headroom);
 256     size_t copy_tailroom = MIN(old_tailroom, new_tailroom);
 257
 258     memcpy(&new_base[new_headroom - copy_headroom],
 259            &old_base[old_headroom - copy_headroom],
 260            copy_headroom + b->size + copy_tailroom);
 261 }
 262
 263 /* Reallocates 'b' so that it has exactly 'new_headroom' and 'new_tailroom'
 264  * bytes of headroom and tailroom, respectively. */
 265 static void
 266 ofpbuf_resize__(struct ofpbuf *b, size_t new_headroom, size_t new_tailroom)
 267 {
 268     void *new_base, *new_data;
 269     size_t new_allocated;
 270
 271     new_allocated = new_headroom + b->size + new_tailroom;
 272
 273     switch (b->source) {
 274     case OFPBUF_DPDK:
 275         OVS_NOT_REACHED();
 276
 277     case OFPBUF_MALLOC:
 278         if (new_headroom == ofpbuf_headroom(b)) {
 279             new_base = xrealloc(b->base, new_allocated);
 280         } else {
 281             new_base = xmalloc(new_allocated);
 282             ofpbuf_copy__(b, new_base, new_headroom, new_tailroom);
 283             free(b->base);
 284         }
 285         break;
 286
 287     case OFPBUF_STACK:
 288         OVS_NOT_REACHED();
 289
 290     case OFPBUF_STUB:
 291         b->source = OFPBUF_MALLOC;
 292         new_base = xmalloc(new_allocated);
 293         ofpbuf_copy__(b, new_base, new_headroom, new_tailroom);
 294         break;
 295
 296     default:
 297         OVS_NOT_REACHED();
 298     }
 299
 300     b->allocated = new_allocated;
 301     b->base = new_base;
 302
 303     new_data = (char *) new_base + new_headroom;
 304     if (b->data != new_data) {
 305         uintptr_t data_delta = (char *) new_data - (char *) b->data;
 306         b->data = new_data;
 307         if (b->l2) {
 308             b->l2 = (char *) b->l2 + data_delta;
 309         }
 310         if (b->l2_5) {
 311             b->l2_5 = (char *) b->l2_5 + data_delta;
 312         }
 313         if (b->l3) {
 314             b->l3 = (char *) b->l3 + data_delta;
 315         }
 316         if (b->l4) {
 317             b->l4 = (char *) b->l4 + data_delta;
 318         }
 319         if (b->l7) {
 320             b->l7 = (char *) b->l7 + data_delta;
 321         }
 322     }
 323 }
 324
 325 /* Ensures that 'b' has room for at least 'size' bytes at its tail end,
 326  * reallocating and copying its data if necessary.  Its headroom, if any, is
 327  * preserved. */
 328 void
 329 ofpbuf_prealloc_tailroom(struct ofpbuf *b, size_t size)
 330 {
 331     if (size > ofpbuf_tailroom(b)) {
 332         ofpbuf_resize__(b, ofpbuf_headroom(b), MAX(size, 64));
 333     }
 334 }
 335
 336 /* Ensures that 'b' has room for at least 'size' bytes at its head,
 337  * reallocating and copying its data if necessary.  Its tailroom, if any, is
 338  * preserved. */
 339 void
 340 ofpbuf_prealloc_headroom(struct ofpbuf *b, size_t size)
 341 {
 342     if (size > ofpbuf_headroom(b)) {
 343         ofpbuf_resize__(b, MAX(size, 64), ofpbuf_tailroom(b));
 344     }
 345 }
 346
 347 /* Trims the size of 'b' to fit its actual content, reducing its tailroom to
 348  * 0.  Its headroom, if any, is preserved.
 349  *
 350  * Buffers not obtained from malloc() are not resized, since that wouldn't save
 351  * any memory. */
 352 void
 353 ofpbuf_trim(struct ofpbuf *b)
 354 {
 355     ovs_assert(b->source != OFPBUF_DPDK);
 356
 357     if (b->source == OFPBUF_MALLOC
 358         && (ofpbuf_headroom(b) || ofpbuf_tailroom(b))) {
 359         ofpbuf_resize__(b, 0, 0);
 360     }
 361 }
 362
 363 /* If 'b' is shorter than 'length' bytes, pads its tail out with zeros to that
 364  * length. */
 365 void
 366 ofpbuf_padto(struct ofpbuf *b, size_t length)
 367 {
 368     if (b->size < length) {
 369         ofpbuf_put_zeros(b, length - b->size);
 370     }
 371 }
 372
 373 /* Shifts all of the data within the allocated space in 'b' by 'delta' bytes.
 374  * For example, a 'delta' of 1 would cause each byte of data to move one byte
 375  * forward (from address 'p' to 'p+1'), and a 'delta' of -1 would cause each
 376  * byte to move one byte backward (from 'p' to 'p-1'). */
 377 void
 378 ofpbuf_shift(struct ofpbuf *b, int delta)
 379 {
 380     ovs_assert(delta > 0 ? delta <= ofpbuf_tailroom(b)
 381                : delta < 0 ? -delta <= ofpbuf_headroom(b)
 382                : true);
 383
 384     if (delta != 0) {
 385         char *dst = (char *) b->data + delta;
 386         memmove(dst, b->data, b->size);
 387         b->data = dst;
 388     }
 389 }
 390
 391 /* Appends 'size' bytes of data to the tail end of 'b', reallocating and
 392  * copying its data if necessary.  Returns a pointer to the first byte of the
 393  * new data, which is left uninitialized. */
 394 void *
 395 ofpbuf_put_uninit(struct ofpbuf *b, size_t size)
 396 {
 397     void *p;
 398     ofpbuf_prealloc_tailroom(b, size);
 399     p = ofpbuf_tail(b);
 400     b->size += size;
 401     return p;
 402 }
 403
 404 /* Appends 'size' zeroed bytes to the tail end of 'b'.  Data in 'b' is
 405  * reallocated and copied if necessary.  Returns a pointer to the first byte of
 406  * the data's location in the ofpbuf. */
 407 void *
 408 ofpbuf_put_zeros(struct ofpbuf *b, size_t size)
 409 {
 410     void *dst = ofpbuf_put_uninit(b, size);
 411     memset(dst, 0, size);
 412     return dst;
 413 }
 414
 415 /* Appends the 'size' bytes of data in 'p' to the tail end of 'b'.  Data in 'b'
 416  * is reallocated and copied if necessary.  Returns a pointer to the first
 417  * byte of the data's location in the ofpbuf. */
 418 void *
 419 ofpbuf_put(struct ofpbuf *b, const void *p, size_t size)
 420 {
 421     void *dst = ofpbuf_put_uninit(b, size);
 422     memcpy(dst, p, size);
 423     return dst;
 424 }
 425
 426 /* Parses as many pairs of hex digits as possible (possibly separated by
 427  * spaces) from the beginning of 's', appending bytes for their values to 'b'.
 428  * Returns the first character of 's' that is not the first of a pair of hex
 429  * digits.  If 'n' is nonnull, stores the number of bytes added to 'b' in
 430  * '*n'. */
 431 char *
 432 ofpbuf_put_hex(struct ofpbuf *b, const char *s, size_t *n)
 433 {
 434     size_t initial_size = b->size;
 435     for (;;) {
 436         uint8_t byte;
 437         bool ok;
 438
 439         s += strspn(s, " \t\r\n");
 440         byte = hexits_value(s, 2, &ok);
 441         if (!ok) {
 442             if (n) {
 443                 *n = b->size - initial_size;
 444             }
 445             return CONST_CAST(char *, s);
 446         }
 447
 448         ofpbuf_put(b, &byte, 1);
 449         s += 2;
 450     }
 451 }
 452
 453 /* Reserves 'size' bytes of headroom so that they can be later allocated with
 454  * ofpbuf_push_uninit() without reallocating the ofpbuf. */
 455 void
 456 ofpbuf_reserve(struct ofpbuf *b, size_t size)
 457 {
 458     ovs_assert(!b->size);
 459     ofpbuf_prealloc_tailroom(b, size);
 460     b->data = (char*)b->data + size;
 461 }
 462
 463 /* Reserves 'size' bytes of headroom so that they can be later allocated with
 464  * ofpbuf_push_uninit() without reallocating the ofpbuf. */
 465 void
 466 ofpbuf_reserve_with_tailroom(struct ofpbuf *b, size_t headroom,
 467                              size_t tailroom)
 468 {
 469     ovs_assert(!b->size);
 470     ofpbuf_prealloc_tailroom(b, headroom + tailroom);
 471     b->data = (char*)b->data + headroom;
 472 }
 473
 474 /* Prefixes 'size' bytes to the head end of 'b', reallocating and copying its
 475  * data if necessary.  Returns a pointer to the first byte of the data's
 476  * location in the ofpbuf.  The new data is left uninitialized. */
 477 void *
 478 ofpbuf_push_uninit(struct ofpbuf *b, size_t size)
 479 {
 480     ofpbuf_prealloc_headroom(b, size);
 481     b->data = (char*)b->data - size;
 482     b->size += size;
 483     return b->data;
 484 }
 485
 486 /* Prefixes 'size' zeroed bytes to the head end of 'b', reallocating and
 487  * copying its data if necessary.  Returns a pointer to the first byte of the
 488  * data's location in the ofpbuf. */
 489 void *
 490 ofpbuf_push_zeros(struct ofpbuf *b, size_t size)
 491 {
 492     void *dst = ofpbuf_push_uninit(b, size);
 493     memset(dst, 0, size);
 494     return dst;
 495 }
 496
 497 /* Copies the 'size' bytes starting at 'p' to the head end of 'b', reallocating
 498  * and copying its data if necessary.  Returns a pointer to the first byte of
 499  * the data's location in the ofpbuf. */
 500 void *
 501 ofpbuf_push(struct ofpbuf *b, const void *p, size_t size)
 502 {
 503     void *dst = ofpbuf_push_uninit(b, size);
 504     memcpy(dst, p, size);
 505     return dst;
 506 }
 507
 508 /* If 'b' contains at least 'offset + size' bytes of data, returns a pointer to
 509  * byte 'offset'.  Otherwise, returns a null pointer. */
 510 void *
 511 ofpbuf_at(const struct ofpbuf *b, size_t offset, size_t size)
 512 {
 513     return offset + size <= b->size ? (char *) b->data + offset : NULL;
 514 }
 515
 516 /* Returns a pointer to byte 'offset' in 'b', which must contain at least
 517  * 'offset + size' bytes of data. */
 518 void *
 519 ofpbuf_at_assert(const struct ofpbuf *b, size_t offset, size_t size)
 520 {
 521     ovs_assert(offset + size <= b->size);
 522     return ((char *) b->data) + offset;
 523 }
 524
 525 /* Returns the byte following the last byte of data in use in 'b'. */
 526 void *
 527 ofpbuf_tail(const struct ofpbuf *b)
 528 {
 529     return (char *) b->data + b->size;
 530 }
 531
 532 /* Returns the byte following the last byte allocated for use (but not
 533  * necessarily in use) by 'b'. */
 534 void *
 535 ofpbuf_end(const struct ofpbuf *b)
 536 {
 537     return (char *) b->base + b->allocated;
 538 }
 539
 540 /* Clears any data from 'b'. */
 541 void
 542 ofpbuf_clear(struct ofpbuf *b)
 543 {
 544     b->data = b->base;
 545     b->size = 0;
 546 }
 547
 548 /* Removes 'size' bytes from the head end of 'b', which must contain at least
 549  * 'size' bytes of data.  Returns the first byte of data removed. */
 550 void *
 551 ofpbuf_pull(struct ofpbuf *b, size_t size)
 552 {
 553     void *data = b->data;
 554     ovs_assert(b->size >= size);
 555     b->data = (char*)b->data + size;
 556     b->size -= size;
 557     return data;
 558 }
 559
 560 /* If 'b' has at least 'size' bytes of data, removes that many bytes from the
 561  * head end of 'b' and returns the first byte removed.  Otherwise, returns a
 562  * null pointer without modifying 'b'. */
 563 void *
 564 ofpbuf_try_pull(struct ofpbuf *b, size_t size)
 565 {
 566     return b->size >= size ? ofpbuf_pull(b, size) : NULL;
 567 }
 568
 569 /* Returns the data in 'b' as a block of malloc()'d memory and frees the buffer
 570  * within 'b'.  (If 'b' itself was dynamically allocated, e.g. with
 571  * ofpbuf_new(), then it should still be freed with, e.g., ofpbuf_delete().) */
 572 void *
 573 ofpbuf_steal_data(struct ofpbuf *b)
 574 {
 575     void *p;
 576     ovs_assert(b->source != OFPBUF_DPDK);
 577
 578     if (b->source == OFPBUF_MALLOC && b->data == b->base) {
 579         p = b->data;
 580     } else {
 581         p = xmemdup(b->data, b->size);
 582         if (b->source == OFPBUF_MALLOC) {
 583             free(b->base);
 584         }
 585     }
 586     b->base = b->data = NULL;
 587     return p;
 588 }
 589
 590 /* Returns a string that describes some of 'b''s metadata plus a hex dump of up
 591  * to 'maxbytes' from the start of the buffer. */
 592 char *
 593 ofpbuf_to_string(const struct ofpbuf *b, size_t maxbytes)
 594 {
 595     struct ds s;
 596
 597     ds_init(&s);
 598     ds_put_format(&s, "size=%"PRIuSIZE", allocated=%"PRIuSIZE", head=%"PRIuSIZE", tail=%"PRIuSIZE"\n",
 599                   b->size, b->allocated,
 600                   ofpbuf_headroom(b), ofpbuf_tailroom(b));
 601     ds_put_hex_dump(&s, b->data, MIN(b->size, maxbytes), 0, false);
 602     return ds_cstr(&s);
 603 }
 604
 605 /* Removes each of the "struct ofpbuf"s on 'list' from the list and frees
 606  * them.  */
 607 void
 608 ofpbuf_list_delete(struct list *list)
 609 {
 610     struct ofpbuf *b, *next;
 611
 612     LIST_FOR_EACH_SAFE (b, next, list_node, list) {
 613         list_remove(&b->list_node);
 614         ofpbuf_delete(b);
 615     }
 616 }