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