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