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 *b, size_t headroom)
 179 {
 180     struct ofpbuf *new_buffer;
 181
 182     new_buffer = ofpbuf_clone_data_with_headroom(b->data, b->size, headroom);
 183     if (b->header) {
 184         ptrdiff_t header_offset = (char *) b->header - (char *) b->data;
 185
 186         new_buffer->header = (char *) new_buffer->data + header_offset;
 187     }
 188     new_buffer->msg = b->msg;
 189
 190     return new_buffer;
 191 }
 192
 193 /* Creates and returns a new ofpbuf that initially contains a copy of the
 194  * 'size' bytes of data starting at 'data' with no headroom or tailroom. */
 195 struct ofpbuf *
 196 ofpbuf_clone_data(const void *data, size_t size)
 197 {
 198     return ofpbuf_clone_data_with_headroom(data, size, 0);
 199 }
 200
 201 /* Creates and returns a new ofpbuf that initially contains 'headroom' bytes of
 202  * headroom followed by a copy of the 'size' bytes of data starting at
 203  * 'data'. */
 204 struct ofpbuf *
 205 ofpbuf_clone_data_with_headroom(const void *data, size_t size, size_t headroom)
 206 {
 207     struct ofpbuf *b = ofpbuf_new_with_headroom(size, headroom);
 208     ofpbuf_put(b, data, size);
 209     return b;
 210 }
 211
 212 static void
 213 ofpbuf_copy__(struct ofpbuf *b, uint8_t *new_base,
 214               size_t new_headroom, size_t new_tailroom)
 215 {
 216     const uint8_t *old_base = b->base;
 217     size_t old_headroom = ofpbuf_headroom(b);
 218     size_t old_tailroom = ofpbuf_tailroom(b);
 219     size_t copy_headroom = MIN(old_headroom, new_headroom);
 220     size_t copy_tailroom = MIN(old_tailroom, new_tailroom);
 221
 222     memcpy(&new_base[new_headroom - copy_headroom],
 223            &old_base[old_headroom - copy_headroom],
 224            copy_headroom + b->size + copy_tailroom);
 225 }
 226
 227 /* Reallocates 'b' so that it has exactly 'new_headroom' and 'new_tailroom'
 228  * bytes of headroom and tailroom, respectively. */
 229 static void
 230 ofpbuf_resize__(struct ofpbuf *b, size_t new_headroom, size_t new_tailroom)
 231 {
 232     void *new_base, *new_data;
 233     size_t new_allocated;
 234
 235     new_allocated = new_headroom + b->size + new_tailroom;
 236
 237     switch (b->source) {
 238     case OFPBUF_MALLOC:
 239         if (new_headroom == ofpbuf_headroom(b)) {
 240             new_base = xrealloc(b->base, new_allocated);
 241         } else {
 242             new_base = xmalloc(new_allocated);
 243             ofpbuf_copy__(b, new_base, new_headroom, new_tailroom);
 244             free(b->base);
 245         }
 246         break;
 247
 248     case OFPBUF_STACK:
 249         OVS_NOT_REACHED();
 250
 251     case OFPBUF_STUB:
 252         b->source = OFPBUF_MALLOC;
 253         new_base = xmalloc(new_allocated);
 254         ofpbuf_copy__(b, new_base, new_headroom, new_tailroom);
 255         break;
 256
 257     default:
 258         OVS_NOT_REACHED();
 259     }
 260
 261     b->allocated = new_allocated;
 262     b->base = new_base;
 263
 264     new_data = (char *) new_base + new_headroom;
 265     if (b->data != new_data) {
 266         if (b->header) {
 267             ptrdiff_t header_offset = (char *) b->header - (char *) b->data;
 268
 269             b->header = (char *) new_data + header_offset;
 270         }
 271         if (b->msg) {
 272             ptrdiff_t msg_offset = (char *) b->msg - (char *) b->data;
 273
 274             b->msg = (char *) new_data + msg_offset;
 275         }
 276         b->data = new_data;
 277     }
 278 }
 279
 280 /* Ensures that 'b' has room for at least 'size' bytes at its tail end,
 281  * reallocating and copying its data if necessary.  Its headroom, if any, is
 282  * preserved. */
 283 void
 284 ofpbuf_prealloc_tailroom(struct ofpbuf *b, size_t size)
 285 {
 286     if (size > ofpbuf_tailroom(b)) {
 287         ofpbuf_resize__(b, ofpbuf_headroom(b), MAX(size, 64));
 288     }
 289 }
 290
 291 /* Ensures that 'b' has room for at least 'size' bytes at its head,
 292  * reallocating and copying its data if necessary.  Its tailroom, if any, is
 293  * preserved. */
 294 void
 295 ofpbuf_prealloc_headroom(struct ofpbuf *b, size_t size)
 296 {
 297     if (size > ofpbuf_headroom(b)) {
 298         ofpbuf_resize__(b, MAX(size, 64), ofpbuf_tailroom(b));
 299     }
 300 }
 301
 302 /* Trims the size of 'b' to fit its actual content, reducing its headroom and
 303  * tailroom to 0, if any.
 304  *
 305  * Buffers not obtained from malloc() are not resized, since that wouldn't save
 306  * any memory.
 307  *
 308  * Caller needs to updates 'b->header' and 'b->msg' so that they point to the
 309  * same locations in the data.  (If they pointed into the tailroom or headroom
 310  * then they become invalid.)
 311  *
 312  */
 313 void
 314 ofpbuf_trim(struct ofpbuf *b)
 315 {
 316     if (b->source == OFPBUF_MALLOC
 317         && (ofpbuf_headroom(b) || ofpbuf_tailroom(b))) {
 318         ofpbuf_resize__(b, 0, 0);
 319     }
 320 }
 321
 322 /* If 'b' is shorter than 'length' bytes, pads its tail out with zeros to that
 323  * length. */
 324 void
 325 ofpbuf_padto(struct ofpbuf *b, size_t length)
 326 {
 327     if (b->size < length) {
 328         ofpbuf_put_zeros(b, length - b->size);
 329     }
 330 }
 331
 332 /* Shifts all of the data within the allocated space in 'b' by 'delta' bytes.
 333  * For example, a 'delta' of 1 would cause each byte of data to move one byte
 334  * forward (from address 'p' to 'p+1'), and a 'delta' of -1 would cause each
 335  * byte to move one byte backward (from 'p' to 'p-1').
 336  *
 337  * If used, user must make sure the 'header' and 'msg' pointers are updated
 338  * after shifting.
 339  */
 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 *) b->data + delta;
 349         memmove(dst, b->data, b->size);
 350         b->data = 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     b->size += 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 spaces
 390  * or periods) from the beginning of 's', appending bytes for their values to
 391  * 'b'.  Returns the first character of 's' that is not the first of a pair of
 392  * hex 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 = b->size;
 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 = b->size - 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(!b->size);
 422     ofpbuf_prealloc_tailroom(b, size);
 423     b->data = (char*)b->data + size;
 424 }
 425
 426 /* Prefixes 'size' bytes to the head end of 'b', reallocating and copying its
 427  * data if necessary.  Returns a pointer to the first byte of the data's
 428  * location in the ofpbuf.  The new data is left uninitialized. */
 429 void *
 430 ofpbuf_push_uninit(struct ofpbuf *b, size_t size)
 431 {
 432     ofpbuf_prealloc_headroom(b, size);
 433     b->data = (char*)b->data - size;
 434     b->size += size;
 435     return b->data;
 436 }
 437
 438 /* Prefixes 'size' zeroed bytes to the head end of 'b', reallocating and
 439  * copying its data if necessary.  Returns a pointer to the first byte of the
 440  * data's location in the ofpbuf. */
 441 void *
 442 ofpbuf_push_zeros(struct ofpbuf *b, size_t size)
 443 {
 444     void *dst = ofpbuf_push_uninit(b, size);
 445     memset(dst, 0, size);
 446     return dst;
 447 }
 448
 449 /* Copies the 'size' bytes starting at 'p' to the head end of 'b', reallocating
 450  * and copying its data if necessary.  Returns a pointer to the first byte of
 451  * the data's location in the ofpbuf. */
 452 void *
 453 ofpbuf_push(struct ofpbuf *b, const void *p, size_t size)
 454 {
 455     void *dst = ofpbuf_push_uninit(b, size);
 456     memcpy(dst, p, size);
 457     return dst;
 458 }
 459
 460 /* Returns the data in 'b' as a block of malloc()'d memory and frees the buffer
 461  * within 'b'.  (If 'b' itself was dynamically allocated, e.g. with
 462  * ofpbuf_new(), then it should still be freed with, e.g., ofpbuf_delete().) */
 463 void *
 464 ofpbuf_steal_data(struct ofpbuf *b)
 465 {
 466     void *p;
 467
 468     if (b->source == OFPBUF_MALLOC && b->data == b->base) {
 469         p = b->data;
 470     } else {
 471         p = xmemdup(b->data, b->size);
 472         if (b->source == OFPBUF_MALLOC) {
 473             free(b->base);
 474         }
 475     }
 476     b->base = NULL;
 477     b->data = NULL;
 478     b->header = NULL;
 479     b->msg = NULL;
 480     return p;
 481 }
 482
 483 /* Returns a string that describes some of 'b''s metadata plus a hex dump of up
 484  * to 'maxbytes' from the start of the buffer. */
 485 char *
 486 ofpbuf_to_string(const struct ofpbuf *b, size_t maxbytes)
 487 {
 488     struct ds s;
 489
 490     ds_init(&s);
 491     ds_put_format(&s, "size=%"PRIu32", allocated=%"PRIu32", head=%"PRIuSIZE", tail=%"PRIuSIZE"\n",
 492                   b->size, b->allocated,
 493                   ofpbuf_headroom(b), ofpbuf_tailroom(b));
 494     ds_put_hex_dump(&s, b->data, MIN(b->size, maxbytes), 0, false);
 495     return ds_cstr(&s);
 496 }
 497
 498 /* Removes each of the "struct ofpbuf"s on 'list' from the list and frees
 499  * them.  */
 500 void
 501 ofpbuf_list_delete(struct ovs_list *list)
 502 {
 503     struct ofpbuf *b;
 504
 505     LIST_FOR_EACH_POP (b, list_node, list) {
 506         ofpbuf_delete(b);
 507     }
 508 }