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