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