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