lib/ofpbuf.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2016 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->header = NULL;
  31     b->msg = NULL;
  32     list_poison(&b->list_node);
  33 }
  34
  35 static void
  36 ofpbuf_use__(struct ofpbuf *b, void *base, size_t allocated, size_t size,
  37              enum ofpbuf_source source)
  38 {
  39     b->base = base;
  40     b->data = base;
  41     b->size = size;
  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 static void
  51 ofpbuf_use(struct ofpbuf *b, void *base, size_t allocated)
  52 {
  53     ofpbuf_use__(b, base, allocated, 0, OFPBUF_MALLOC);
  54 }
  55
  56 /* Converts ds into ofpbuf 'b'. 'b' contains the 'ds->allocated' bytes of
  57  * memory starting at 'ds->string'.  'ds' should not be modified any more.
  58  * The memory allocated for 'ds' will be freed (with free()) if 'b' is
  59  * resized or freed. */
  60 void
  61 ofpbuf_use_ds(struct ofpbuf *b, const struct ds *ds)
  62 {
  63     ofpbuf_use__(b, ds->string, ds->allocated + 1, ds->length, OFPBUF_MALLOC);
  64 }
  65
  66 /* Initializes 'b' as an empty ofpbuf that contains the 'allocated' bytes of
  67  * memory starting at 'base'.  'base' should point to a buffer on the stack.
  68  * (Nothing actually relies on 'base' being allocated on the stack.  It could
  69  * be static or malloc()'d memory.  But stack space is the most common use
  70  * case.)
  71  *
  72  * 'base' should be appropriately aligned.  Using an array of uint32_t or
  73  * uint64_t for the buffer is a reasonable way to ensure appropriate alignment
  74  * for 32- or 64-bit data.
  75  *
  76  * An ofpbuf operation that requires reallocating data will assert-fail if this
  77  * function was used to initialize it.  Thus, one need not call ofpbuf_uninit()
  78  * on an ofpbuf initialized by this function (though doing so is harmless),
  79  * because it is guaranteed that 'b' does not own any heap-allocated memory. */
  80 void
  81 ofpbuf_use_stack(struct ofpbuf *b, void *base, size_t allocated)
  82 {
  83     ofpbuf_use__(b, base, allocated, 0, OFPBUF_STACK);
  84 }
  85
  86 /* Initializes 'b' as an empty ofpbuf that contains the 'allocated' bytes of
  87  * memory starting at 'base'.  'base' should point to a buffer on the stack.
  88  * (Nothing actually relies on 'base' being allocated on the stack.  It could
  89  * be static or malloc()'d memory.  But stack space is the most common use
  90  * case.)
  91  *
  92  * 'base' should be appropriately aligned.  Using an array of uint32_t or
  93  * uint64_t for the buffer is a reasonable way to ensure appropriate alignment
  94  * for 32- or 64-bit data.
  95  *
  96  * An ofpbuf operation that requires reallocating data will copy the provided
  97  * buffer into a malloc()'d buffer.  Thus, it is wise to call ofpbuf_uninit()
  98  * on an ofpbuf initialized by this function, so that if it expanded into the
  99  * heap, that memory is freed. */
 100 void
 101 ofpbuf_use_stub(struct ofpbuf *b, void *base, size_t allocated)
 102 {
 103     ofpbuf_use__(b, base, allocated, 0, OFPBUF_STUB);
 104 }
 105
 106 /* Initializes 'b' as an ofpbuf whose data starts at 'data' and continues for
 107  * 'size' bytes.  This is appropriate for an ofpbuf that will be used to
 108  * inspect existing data, without moving it around or reallocating it, and
 109  * generally without modifying it at all.
 110  *
 111  * An ofpbuf operation that requires reallocating data will assert-fail if this
 112  * function was used to initialize it. */
 113 void
 114 ofpbuf_use_const(struct ofpbuf *b, const void *data, size_t size)
 115 {
 116     ofpbuf_use__(b, CONST_CAST(void *, data), size, size, OFPBUF_STACK);
 117 }
 118
 119 /* Initializes 'b' as an empty ofpbuf with an initial capacity of 'size'
 120  * bytes. */
 121 void
 122 ofpbuf_init(struct ofpbuf *b, size_t size)
 123 {
 124     ofpbuf_use(b, size ? xmalloc(size) : NULL, size);
 125 }
 126
 127 /* Frees memory that 'b' points to. */
 128 void
 129 ofpbuf_uninit(struct ofpbuf *b)
 130 {
 131     if (b) {
 132         if (b->source == OFPBUF_MALLOC) {
 133             free(b->base);
 134         }
 135     }
 136 }
 137
 138 /* Frees memory that 'b' points to and allocates a new ofpbuf */
 139 void
 140 ofpbuf_reinit(struct ofpbuf *b, size_t size)
 141 {
 142     ofpbuf_uninit(b);
 143     ofpbuf_init(b, size);
 144 }
 145
 146 /* Creates and returns a new ofpbuf with an initial capacity of 'size'
 147  * bytes. */
 148 struct ofpbuf *
 149 ofpbuf_new(size_t size)
 150 {
 151     struct ofpbuf *b = xmalloc(sizeof *b);
 152     ofpbuf_init(b, size);
 153     return b;
 154 }
 155
 156 /* Creates and returns a new ofpbuf with an initial capacity of 'size +
 157  * headroom' bytes, reserving the first 'headroom' bytes as headroom. */
 158 struct ofpbuf *
 159 ofpbuf_new_with_headroom(size_t size, size_t headroom)
 160 {
 161     struct ofpbuf *b = ofpbuf_new(size + headroom);
 162     ofpbuf_reserve(b, headroom);
 163     return b;
 164 }
 165
 166 /* Creates and returns a new ofpbuf that initially contains a copy of the
 167  * 'buffer->size' bytes of data starting at 'buffer->data' with no headroom or
 168  * tailroom. */
 169 struct ofpbuf *
 170 ofpbuf_clone(const struct ofpbuf *buffer)
 171 {
 172     return ofpbuf_clone_with_headroom(buffer, 0);
 173 }
 174
 175 /* Creates and returns a new ofpbuf whose data are copied from 'buffer'.   The
 176  * returned ofpbuf will additionally have 'headroom' bytes of headroom. */
 177 struct ofpbuf *
 178 ofpbuf_clone_with_headroom(const struct ofpbuf *buffer, size_t headroom)
 179 {
 180     struct ofpbuf *new_buffer;
 181
 182     new_buffer = ofpbuf_clone_data_with_headroom(buffer->data,
 183                                                  buffer->size,
 184                                                  headroom);
 185     if (buffer->header) {
 186         uintptr_t data_delta
 187             = (char *)new_buffer->data - (char *)buffer->data;
 188
 189         new_buffer->header = (char *) buffer->header + data_delta;
 190     }
 191     new_buffer->msg = buffer->msg;
 192
 193     return new_buffer;
 194 }
 195
 196 /* Creates and returns a new ofpbuf that initially contains a copy of the
 197  * 'size' bytes of data starting at 'data' with no headroom or tailroom. */
 198 struct ofpbuf *
 199 ofpbuf_clone_data(const void *data, size_t size)
 200 {
 201     return ofpbuf_clone_data_with_headroom(data, size, 0);
 202 }
 203
 204 /* Creates and returns a new ofpbuf that initially contains 'headroom' bytes of
 205  * headroom followed by a copy of the 'size' bytes of data starting at
 206  * 'data'. */
 207 struct ofpbuf *
 208 ofpbuf_clone_data_with_headroom(const void *data, size_t size, size_t headroom)
 209 {
 210     struct ofpbuf *b = ofpbuf_new_with_headroom(size, headroom);
 211     ofpbuf_put(b, data, size);
 212     return b;
 213 }
 214
 215 static void
 216 ofpbuf_copy__(struct ofpbuf *b, uint8_t *new_base,
 217               size_t new_headroom, size_t new_tailroom)
 218 {
 219     const uint8_t *old_base = b->base;
 220     size_t old_headroom = ofpbuf_headroom(b);
 221     size_t old_tailroom = ofpbuf_tailroom(b);
 222     size_t copy_headroom = MIN(old_headroom, new_headroom);
 223     size_t copy_tailroom = MIN(old_tailroom, new_tailroom);
 224
 225     memcpy(&new_base[new_headroom - copy_headroom],
 226            &old_base[old_headroom - copy_headroom],
 227            copy_headroom + b->size + copy_tailroom);
 228 }
 229
 230 /* Reallocates 'b' so that it has exactly 'new_headroom' and 'new_tailroom'
 231  * bytes of headroom and tailroom, respectively. */
 232 static void
 233 ofpbuf_resize__(struct ofpbuf *b, size_t new_headroom, size_t new_tailroom)
 234 {
 235     void *new_base, *new_data;
 236     size_t new_allocated;
 237
 238     new_allocated = new_headroom + b->size + new_tailroom;
 239
 240     switch (b->source) {
 241     case OFPBUF_MALLOC:
 242         if (new_headroom == ofpbuf_headroom(b)) {
 243             new_base = xrealloc(b->base, new_allocated);
 244         } else {
 245             new_base = xmalloc(new_allocated);
 246             ofpbuf_copy__(b, new_base, new_headroom, new_tailroom);
 247             free(b->base);
 248         }
 249         break;
 250
 251     case OFPBUF_STACK:
 252         OVS_NOT_REACHED();
 253
 254     case OFPBUF_STUB:
 255         b->source = OFPBUF_MALLOC;
 256         new_base = xmalloc(new_allocated);
 257         ofpbuf_copy__(b, new_base, new_headroom, new_tailroom);
 258         break;
 259
 260     default:
 261         OVS_NOT_REACHED();
 262     }
 263
 264     b->allocated = new_allocated;
 265     b->base = new_base;
 266
 267     new_data = (char *) new_base + new_headroom;
 268     if (b->data != new_data) {
 269         if (b->header) {
 270             uintptr_t data_delta = (char *) b->header - (char *) b->data;
 271
 272             b->header = (char *) new_data + data_delta;
 273         }
 274         if (b->msg) {
 275             uintptr_t data_delta = (char *) b->msg - (char *) b->data;
 276
 277             b->msg = (char *) new_data + data_delta;
 278         }
 279         b->data = new_data;
 280     }
 281 }
 282
 283 /* Ensures that 'b' has room for at least 'size' bytes at its tail end,
 284  * reallocating and copying its data if necessary.  Its headroom, if any, is
 285  * preserved. */
 286 void
 287 ofpbuf_prealloc_tailroom(struct ofpbuf *b, size_t size)
 288 {
 289     if (size > ofpbuf_tailroom(b)) {
 290         ofpbuf_resize__(b, ofpbuf_headroom(b), MAX(size, 64));
 291     }
 292 }
 293
 294 /* Ensures that 'b' has room for at least 'size' bytes at its head,
 295  * reallocating and copying its data if necessary.  Its tailroom, if any, is
 296  * preserved. */
 297 void
 298 ofpbuf_prealloc_headroom(struct ofpbuf *b, size_t size)
 299 {
 300     if (size > ofpbuf_headroom(b)) {
 301         ofpbuf_resize__(b, MAX(size, 64), ofpbuf_tailroom(b));
 302     }
 303 }
 304
 305 /* Trims the size of 'b' to fit its actual content, reducing its headroom and
 306  * tailroom to 0, if any.
 307  *
 308  * Buffers not obtained from malloc() are not resized, since that wouldn't save
 309  * any memory.
 310  *
 311  * Caller needs to updates 'b->header' and 'b->msg' so that they point to the
 312  * same locations in the data.  (If they pointed into the tailroom or headroom
 313  * then they become invalid.)
 314  *
 315  */
 316 void
 317 ofpbuf_trim(struct ofpbuf *b)
 318 {
 319     if (b->source == OFPBUF_MALLOC
 320         && (ofpbuf_headroom(b) || ofpbuf_tailroom(b))) {
 321         ofpbuf_resize__(b, 0, 0);
 322     }
 323 }
 324
 325 /* If 'b' is shorter than 'length' bytes, pads its tail out with zeros to that
 326  * length. */
 327 void
 328 ofpbuf_padto(struct ofpbuf *b, size_t length)
 329 {
 330     if (b->size < length) {
 331         ofpbuf_put_zeros(b, length - b->size);
 332     }
 333 }
 334
 335 /* Shifts all of the data within the allocated space in 'b' by 'delta' bytes.
 336  * For example, a 'delta' of 1 would cause each byte of data to move one byte
 337  * forward (from address 'p' to 'p+1'), and a 'delta' of -1 would cause each
 338  * byte to move one byte backward (from 'p' to 'p-1').
 339  *
 340  * If used, user must make sure the 'header' and 'msg' pointers are updated
 341  * after shifting.
 342  */
 343 void
 344 ofpbuf_shift(struct ofpbuf *b, int delta)
 345 {
 346     ovs_assert(delta > 0 ? delta <= ofpbuf_tailroom(b)
 347                : delta < 0 ? -delta <= ofpbuf_headroom(b)
 348                : true);
 349
 350     if (delta != 0) {
 351         char *dst = (char *) b->data + delta;
 352         memmove(dst, b->data, b->size);
 353         b->data = dst;
 354     }
 355 }
 356
 357 /* Appends 'size' bytes of data to the tail end of 'b', reallocating and
 358  * copying its data if necessary.  Returns a pointer to the first byte of the
 359  * new data, which is left uninitialized. */
 360 void *
 361 ofpbuf_put_uninit(struct ofpbuf *b, size_t size)
 362 {
 363     void *p;
 364     ofpbuf_prealloc_tailroom(b, size);
 365     p = ofpbuf_tail(b);
 366     b->size += size;
 367     return p;
 368 }
 369
 370 /* Appends 'size' zeroed bytes to the tail end of 'b'.  Data in 'b' is
 371  * reallocated and copied if necessary.  Returns a pointer to the first byte of
 372  * the data's location in the ofpbuf. */
 373 void *
 374 ofpbuf_put_zeros(struct ofpbuf *b, size_t size)
 375 {
 376     void *dst = ofpbuf_put_uninit(b, size);
 377     memset(dst, 0, size);
 378     return dst;
 379 }
 380
 381 /* Appends the 'size' bytes of data in 'p' to the tail end of 'b'.  Data in 'b'
 382  * is reallocated and copied if necessary.  Returns a pointer to the first
 383  * byte of the data's location in the ofpbuf. */
 384 void *
 385 ofpbuf_put(struct ofpbuf *b, const void *p, size_t size)
 386 {
 387     void *dst = ofpbuf_put_uninit(b, size);
 388     memcpy(dst, p, size);
 389     return dst;
 390 }
 391
 392 /* Parses as many pairs of hex digits as possible (possibly separated by spaces
 393  * or periods) from the beginning of 's', appending bytes for their values to
 394  * 'b'.  Returns the first character of 's' that is not the first of a pair of
 395  * hex digits.  If 'n' is nonnull, stores the number of bytes added to 'b' in
 396  * '*n'. */
 397 char *
 398 ofpbuf_put_hex(struct ofpbuf *b, const char *s, size_t *n)
 399 {
 400     size_t initial_size = b->size;
 401     for (;;) {
 402         uint8_t byte;
 403         bool ok;
 404
 405         s += strspn(s, " .\t\r\n");
 406         byte = hexits_value(s, 2, &ok);
 407         if (!ok) {
 408             if (n) {
 409                 *n = b->size - initial_size;
 410             }
 411             return CONST_CAST(char *, s);
 412         }
 413
 414         ofpbuf_put(b, &byte, 1);
 415         s += 2;
 416     }
 417 }
 418
 419 /* Reserves 'size' bytes of headroom so that they can be later allocated with
 420  * ofpbuf_push_uninit() without reallocating the ofpbuf. */
 421 void
 422 ofpbuf_reserve(struct ofpbuf *b, size_t size)
 423 {
 424     ovs_assert(!b->size);
 425     ofpbuf_prealloc_tailroom(b, size);
 426     b->data = (char*)b->data + size;
 427 }
 428
 429 /* Prefixes 'size' bytes to the head end of 'b', reallocating and copying its
 430  * data if necessary.  Returns a pointer to the first byte of the data's
 431  * location in the ofpbuf.  The new data is left uninitialized. */
 432 void *
 433 ofpbuf_push_uninit(struct ofpbuf *b, size_t size)
 434 {
 435     ofpbuf_prealloc_headroom(b, size);
 436     b->data = (char*)b->data - size;
 437     b->size += size;
 438     return b->data;
 439 }
 440
 441 /* Prefixes 'size' zeroed bytes to the head end of 'b', reallocating and
 442  * copying its data if necessary.  Returns a pointer to the first byte of the
 443  * data's location in the ofpbuf. */
 444 void *
 445 ofpbuf_push_zeros(struct ofpbuf *b, size_t size)
 446 {
 447     void *dst = ofpbuf_push_uninit(b, size);
 448     memset(dst, 0, size);
 449     return dst;
 450 }
 451
 452 /* Copies the 'size' bytes starting at 'p' to the head end of 'b', reallocating
 453  * and copying its data if necessary.  Returns a pointer to the first byte of
 454  * the data's location in the ofpbuf. */
 455 void *
 456 ofpbuf_push(struct ofpbuf *b, const void *p, size_t size)
 457 {
 458     void *dst = ofpbuf_push_uninit(b, size);
 459     memcpy(dst, p, size);
 460     return dst;
 461 }
 462
 463 /* Returns the data in 'b' as a block of malloc()'d memory and frees the buffer
 464  * within 'b'.  (If 'b' itself was dynamically allocated, e.g. with
 465  * ofpbuf_new(), then it should still be freed with, e.g., ofpbuf_delete().) */
 466 void *
 467 ofpbuf_steal_data(struct ofpbuf *b)
 468 {
 469     void *p;
 470
 471     if (b->source == OFPBUF_MALLOC && b->data == b->base) {
 472         p = b->data;
 473     } else {
 474         p = xmemdup(b->data, b->size);
 475         if (b->source == OFPBUF_MALLOC) {
 476             free(b->base);
 477         }
 478     }
 479     b->base = NULL;
 480     b->data = NULL;
 481     b->header = NULL;
 482     b->msg = 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=%"PRIu32", allocated=%"PRIu32", 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 ovs_list *list)
 505 {
 506     struct ofpbuf *b;
 507
 508     LIST_FOR_EACH_POP (b, list_node, list) {
 509         ofpbuf_delete(b);
 510     }
 511 }