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->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,
  37              enum ofpbuf_source source)
  38 {
  39     b->base = base;
  40     b->data = base;
  41     b->size = 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     b->size = size;
 108 }
 109
 110 /* Initializes 'b' as an empty ofpbuf with an initial capacity of 'size'
 111  * bytes. */
 112 void
 113 ofpbuf_init(struct ofpbuf *b, size_t size)
 114 {
 115     ofpbuf_use(b, size ? xmalloc(size) : NULL, size);
 116 }
 117
 118 /* Frees memory that 'b' points to. */
 119 void
 120 ofpbuf_uninit(struct ofpbuf *b)
 121 {
 122     if (b) {
 123         if (b->source == OFPBUF_MALLOC) {
 124             free(b->base);
 125         }
 126     }
 127 }
 128
 129 /* Frees memory that 'b' points to and allocates a new ofpbuf */
 130 void
 131 ofpbuf_reinit(struct ofpbuf *b, size_t size)
 132 {
 133     ofpbuf_uninit(b);
 134     ofpbuf_init(b, size);
 135 }
 136
 137 /* Creates and returns a new ofpbuf with an initial capacity of 'size'
 138  * bytes. */
 139 struct ofpbuf *
 140 ofpbuf_new(size_t size)
 141 {
 142     struct ofpbuf *b = xmalloc(sizeof *b);
 143     ofpbuf_init(b, size);
 144     return b;
 145 }
 146
 147 /* Creates and returns a new ofpbuf with an initial capacity of 'size +
 148  * headroom' bytes, reserving the first 'headroom' bytes as headroom. */
 149 struct ofpbuf *
 150 ofpbuf_new_with_headroom(size_t size, size_t headroom)
 151 {
 152     struct ofpbuf *b = ofpbuf_new(size + headroom);
 153     ofpbuf_reserve(b, headroom);
 154     return b;
 155 }
 156
 157 /* Creates and returns a new ofpbuf that initially contains a copy of the
 158  * 'buffer->size' bytes of data starting at 'buffer->data' with no headroom or
 159  * tailroom. */
 160 struct ofpbuf *
 161 ofpbuf_clone(const struct ofpbuf *buffer)
 162 {
 163     return ofpbuf_clone_with_headroom(buffer, 0);
 164 }
 165
 166 /* Creates and returns a new ofpbuf whose data are copied from 'buffer'.   The
 167  * returned ofpbuf will additionally have 'headroom' bytes of headroom. */
 168 struct ofpbuf *
 169 ofpbuf_clone_with_headroom(const struct ofpbuf *buffer, size_t headroom)
 170 {
 171     struct ofpbuf *new_buffer;
 172
 173     new_buffer = ofpbuf_clone_data_with_headroom(buffer->data,
 174                                                  buffer->size,
 175                                                  headroom);
 176     if (buffer->header) {
 177         uintptr_t data_delta
 178             = (char *)new_buffer->data - (char *)buffer->data;
 179
 180         new_buffer->header = (char *) buffer->header + data_delta;
 181     }
 182     new_buffer->msg = buffer->msg;
 183
 184     return new_buffer;
 185 }
 186
 187 /* Creates and returns a new ofpbuf that initially contains a copy of the
 188  * 'size' bytes of data starting at 'data' with no headroom or tailroom. */
 189 struct ofpbuf *
 190 ofpbuf_clone_data(const void *data, size_t size)
 191 {
 192     return ofpbuf_clone_data_with_headroom(data, size, 0);
 193 }
 194
 195 /* Creates and returns a new ofpbuf that initially contains 'headroom' bytes of
 196  * headroom followed by a copy of the 'size' bytes of data starting at
 197  * 'data'. */
 198 struct ofpbuf *
 199 ofpbuf_clone_data_with_headroom(const void *data, size_t size, size_t headroom)
 200 {
 201     struct ofpbuf *b = ofpbuf_new_with_headroom(size, headroom);
 202     ofpbuf_put(b, data, size);
 203     return b;
 204 }
 205
 206 static void
 207 ofpbuf_copy__(struct ofpbuf *b, uint8_t *new_base,
 208               size_t new_headroom, size_t new_tailroom)
 209 {
 210     const uint8_t *old_base = b->base;
 211     size_t old_headroom = ofpbuf_headroom(b);
 212     size_t old_tailroom = ofpbuf_tailroom(b);
 213     size_t copy_headroom = MIN(old_headroom, new_headroom);
 214     size_t copy_tailroom = MIN(old_tailroom, new_tailroom);
 215
 216     memcpy(&new_base[new_headroom - copy_headroom],
 217            &old_base[old_headroom - copy_headroom],
 218            copy_headroom + b->size + copy_tailroom);
 219 }
 220
 221 /* Reallocates 'b' so that it has exactly 'new_headroom' and 'new_tailroom'
 222  * bytes of headroom and tailroom, respectively. */
 223 static void
 224 ofpbuf_resize__(struct ofpbuf *b, size_t new_headroom, size_t new_tailroom)
 225 {
 226     void *new_base, *new_data;
 227     size_t new_allocated;
 228
 229     new_allocated = new_headroom + b->size + new_tailroom;
 230
 231     switch (b->source) {
 232     case OFPBUF_MALLOC:
 233         if (new_headroom == ofpbuf_headroom(b)) {
 234             new_base = xrealloc(b->base, new_allocated);
 235         } else {
 236             new_base = xmalloc(new_allocated);
 237             ofpbuf_copy__(b, new_base, new_headroom, new_tailroom);
 238             free(b->base);
 239         }
 240         break;
 241
 242     case OFPBUF_STACK:
 243         OVS_NOT_REACHED();
 244
 245     case OFPBUF_STUB:
 246         b->source = OFPBUF_MALLOC;
 247         new_base = xmalloc(new_allocated);
 248         ofpbuf_copy__(b, new_base, new_headroom, new_tailroom);
 249         break;
 250
 251     default:
 252         OVS_NOT_REACHED();
 253     }
 254
 255     b->allocated = new_allocated;
 256     b->base = new_base;
 257
 258     new_data = (char *) new_base + new_headroom;
 259     if (b->data != new_data) {
 260         if (b->header) {
 261             uintptr_t data_delta = (char *) b->header - (char *) b->data;
 262
 263             b->header = (char *) new_data + data_delta;
 264         }
 265         if (b->msg) {
 266             uintptr_t data_delta = (char *) b->msg - (char *) b->data;
 267
 268             b->msg = (char *) new_data + data_delta;
 269         }
 270         b->data = new_data;
 271     }
 272 }
 273
 274 /* Ensures that 'b' has room for at least 'size' bytes at its tail end,
 275  * reallocating and copying its data if necessary.  Its headroom, if any, is
 276  * preserved. */
 277 void
 278 ofpbuf_prealloc_tailroom(struct ofpbuf *b, size_t size)
 279 {
 280     if (size > ofpbuf_tailroom(b)) {
 281         ofpbuf_resize__(b, ofpbuf_headroom(b), MAX(size, 64));
 282     }
 283 }
 284
 285 /* Ensures that 'b' has room for at least 'size' bytes at its head,
 286  * reallocating and copying its data if necessary.  Its tailroom, if any, is
 287  * preserved. */
 288 void
 289 ofpbuf_prealloc_headroom(struct ofpbuf *b, size_t size)
 290 {
 291     if (size > ofpbuf_headroom(b)) {
 292         ofpbuf_resize__(b, MAX(size, 64), ofpbuf_tailroom(b));
 293     }
 294 }
 295
 296 /* Trims the size of 'b' to fit its actual content, reducing its headroom and
 297  * tailroom to 0, if any.
 298  *
 299  * Buffers not obtained from malloc() are not resized, since that wouldn't save
 300  * any memory.
 301  *
 302  * Caller needs to updates 'b->header' and 'b->msg' so that they point to the
 303  * same locations in the data.  (If they pointed into the tailroom or headroom
 304  * then they become invalid.)
 305  *
 306  */
 307 void
 308 ofpbuf_trim(struct ofpbuf *b)
 309 {
 310     if (b->source == OFPBUF_MALLOC
 311         && (ofpbuf_headroom(b) || ofpbuf_tailroom(b))) {
 312         ofpbuf_resize__(b, 0, 0);
 313     }
 314 }
 315
 316 /* If 'b' is shorter than 'length' bytes, pads its tail out with zeros to that
 317  * length. */
 318 void
 319 ofpbuf_padto(struct ofpbuf *b, size_t length)
 320 {
 321     if (b->size < length) {
 322         ofpbuf_put_zeros(b, length - b->size);
 323     }
 324 }
 325
 326 /* Shifts all of the data within the allocated space in 'b' by 'delta' bytes.
 327  * For example, a 'delta' of 1 would cause each byte of data to move one byte
 328  * forward (from address 'p' to 'p+1'), and a 'delta' of -1 would cause each
 329  * byte to move one byte backward (from 'p' to 'p-1').
 330  *
 331  * If used, user must make sure the 'header' and 'msg' pointers are updated
 332  * after shifting.
 333  */
 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 /* Prefixes 'size' bytes to the head end of 'b', reallocating and copying its
 421  * data if necessary.  Returns a pointer to the first byte of the data's
 422  * location in the ofpbuf.  The new data is left uninitialized. */
 423 void *
 424 ofpbuf_push_uninit(struct ofpbuf *b, size_t size)
 425 {
 426     ofpbuf_prealloc_headroom(b, size);
 427     b->data = (char*)b->data - size;
 428     b->size += size;
 429     return b->data;
 430 }
 431
 432 /* Prefixes 'size' zeroed bytes to the head end of 'b', reallocating and
 433  * copying its data if necessary.  Returns a pointer to the first byte of the
 434  * data's location in the ofpbuf. */
 435 void *
 436 ofpbuf_push_zeros(struct ofpbuf *b, size_t size)
 437 {
 438     void *dst = ofpbuf_push_uninit(b, size);
 439     memset(dst, 0, size);
 440     return dst;
 441 }
 442
 443 /* Copies the 'size' bytes starting at 'p' to the head end of 'b', reallocating
 444  * and copying its data if necessary.  Returns a pointer to the first byte of
 445  * the data's location in the ofpbuf. */
 446 void *
 447 ofpbuf_push(struct ofpbuf *b, const void *p, size_t size)
 448 {
 449     void *dst = ofpbuf_push_uninit(b, size);
 450     memcpy(dst, p, size);
 451     return dst;
 452 }
 453
 454 /* Returns the data in 'b' as a block of malloc()'d memory and frees the buffer
 455  * within 'b'.  (If 'b' itself was dynamically allocated, e.g. with
 456  * ofpbuf_new(), then it should still be freed with, e.g., ofpbuf_delete().) */
 457 void *
 458 ofpbuf_steal_data(struct ofpbuf *b)
 459 {
 460     void *p;
 461
 462     if (b->source == OFPBUF_MALLOC && b->data == b->base) {
 463         p = b->data;
 464     } else {
 465         p = xmemdup(b->data, b->size);
 466         if (b->source == OFPBUF_MALLOC) {
 467             free(b->base);
 468         }
 469     }
 470     b->base = NULL;
 471     b->data = NULL;
 472     b->header = NULL;
 473     b->msg = NULL;
 474     return p;
 475 }
 476
 477 /* Returns a string that describes some of 'b''s metadata plus a hex dump of up
 478  * to 'maxbytes' from the start of the buffer. */
 479 char *
 480 ofpbuf_to_string(const struct ofpbuf *b, size_t maxbytes)
 481 {
 482     struct ds s;
 483
 484     ds_init(&s);
 485     ds_put_format(&s, "size=%"PRIu32", allocated=%"PRIu32", head=%"PRIuSIZE", tail=%"PRIuSIZE"\n",
 486                   b->size, b->allocated,
 487                   ofpbuf_headroom(b), ofpbuf_tailroom(b));
 488     ds_put_hex_dump(&s, b->data, MIN(b->size, maxbytes), 0, false);
 489     return ds_cstr(&s);
 490 }
 491
 492 /* Removes each of the "struct ofpbuf"s on 'list' from the list and frees
 493  * them.  */
 494 void
 495 ofpbuf_list_delete(struct ovs_list *list)
 496 {
 497     struct ofpbuf *b;
 498
 499     LIST_FOR_EACH_POP (b, list_node, list) {
 500         ofpbuf_delete(b);
 501     }
 502 }