lib/ofpbuf.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
   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 <assert.h>
  20 #include <stdlib.h>
  21 #include <string.h>
  22 #include "dynamic-string.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->l3 = b->l4 = b->l7 = 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  *
  51  * An ofpbuf operation that requires reallocating data will assert-fail if this
  52  * function was used to initialize it.
  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  * (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 void
  62 ofpbuf_use_stack(struct ofpbuf *b, void *base, size_t allocated)
  63 {
  64     ofpbuf_use__(b, base, allocated, OFPBUF_STACK);
  65 }
  66
  67 /* Initializes 'b' as an ofpbuf whose data starts at 'data' and continues for
  68  * 'size' bytes.  This is appropriate for an ofpbuf that will be used to
  69  * inspect existing data, without moving it around or reallocating it, and
  70  * generally without modifying it at all.
  71  *
  72  * An ofpbuf operation that requires reallocating data will assert-fail if this
  73  * function was used to initialize it. */
  74 void
  75 ofpbuf_use_const(struct ofpbuf *b, const void *data, size_t size)
  76 {
  77     ofpbuf_use__(b, (void *) data, size, OFPBUF_STACK);
  78     b->size = size;
  79 }
  80
  81 /* Initializes 'b' as an empty ofpbuf with an initial capacity of 'size'
  82  * bytes. */
  83 void
  84 ofpbuf_init(struct ofpbuf *b, size_t size)
  85 {
  86     ofpbuf_use(b, size ? xmalloc(size) : NULL, size);
  87 }
  88
  89 /* Frees memory that 'b' points to. */
  90 void
  91 ofpbuf_uninit(struct ofpbuf *b)
  92 {
  93     if (b && b->source == OFPBUF_MALLOC) {
  94         free(b->base);
  95     }
  96 }
  97
  98 /* Frees memory that 'b' points to and allocates a new ofpbuf */
  99 void
 100 ofpbuf_reinit(struct ofpbuf *b, size_t size)
 101 {
 102     ofpbuf_uninit(b);
 103     ofpbuf_init(b, size);
 104 }
 105
 106 /* Creates and returns a new ofpbuf with an initial capacity of 'size'
 107  * bytes. */
 108 struct ofpbuf *
 109 ofpbuf_new(size_t size)
 110 {
 111     struct ofpbuf *b = xmalloc(sizeof *b);
 112     ofpbuf_init(b, size);
 113     return b;
 114 }
 115
 116 /* Creates and returns a new ofpbuf with an initial capacity of 'size +
 117  * headroom' bytes, reserving the first 'headroom' bytes as headroom. */
 118 struct ofpbuf *
 119 ofpbuf_new_with_headroom(size_t size, size_t headroom)
 120 {
 121     struct ofpbuf *b = ofpbuf_new(size + headroom);
 122     ofpbuf_reserve(b, headroom);
 123     return b;
 124 }
 125
 126 /* Creates and returns a new ofpbuf that initially contains a copy of the
 127  * 'buffer->size' bytes of data starting at 'buffer->data' with no headroom or
 128  * tailroom. */
 129 struct ofpbuf *
 130 ofpbuf_clone(const struct ofpbuf *buffer)
 131 {
 132     return ofpbuf_clone_data(buffer->data, buffer->size);
 133 }
 134
 135 /* Creates and returns a new ofpbuf whose data are copied from 'buffer'.   The
 136  * returned ofpbuf will additionally have 'headroom' bytes of headroom. */
 137 struct ofpbuf *
 138 ofpbuf_clone_with_headroom(const struct ofpbuf *buffer, size_t headroom)
 139 {
 140     return ofpbuf_clone_data_with_headroom(buffer->data, buffer->size,
 141                                            headroom);
 142 }
 143
 144 /* Creates and returns a new ofpbuf that initially contains a copy of the
 145  * 'size' bytes of data starting at 'data' with no headroom or tailroom. */
 146 struct ofpbuf *
 147 ofpbuf_clone_data(const void *data, size_t size)
 148 {
 149     return ofpbuf_clone_data_with_headroom(data, size, 0);
 150 }
 151
 152 /* Creates and returns a new ofpbuf that initially contains 'headroom' bytes of
 153  * headroom followed by a copy of the 'size' bytes of data starting at
 154  * 'data'. */
 155 struct ofpbuf *
 156 ofpbuf_clone_data_with_headroom(const void *data, size_t size, size_t headroom)
 157 {
 158     struct ofpbuf *b = ofpbuf_new_with_headroom(size, headroom);
 159     ofpbuf_put(b, data, size);
 160     return b;
 161 }
 162
 163 /* Frees memory that 'b' points to, as well as 'b' itself. */
 164 void
 165 ofpbuf_delete(struct ofpbuf *b)
 166 {
 167     if (b) {
 168         ofpbuf_uninit(b);
 169         free(b);
 170     }
 171 }
 172
 173 /* Returns the number of bytes of headroom in 'b', that is, the number of bytes
 174  * of unused space in ofpbuf 'b' before the data that is in use.  (Most
 175  * commonly, the data in a ofpbuf is at its beginning, and thus the ofpbuf's
 176  * headroom is 0.) */
 177 size_t
 178 ofpbuf_headroom(const struct ofpbuf *b)
 179 {
 180     return (char*)b->data - (char*)b->base;
 181 }
 182
 183 /* Returns the number of bytes that may be appended to the tail end of ofpbuf
 184  * 'b' before the ofpbuf must be reallocated. */
 185 size_t
 186 ofpbuf_tailroom(const struct ofpbuf *b)
 187 {
 188     return (char*)ofpbuf_end(b) - (char*)ofpbuf_tail(b);
 189 }
 190
 191 static void
 192 ofpbuf_copy__(struct ofpbuf *b, uint8_t *new_base,
 193               size_t new_headroom, size_t new_tailroom)
 194 {
 195     const uint8_t *old_base = b->base;
 196     size_t old_headroom = ofpbuf_headroom(b);
 197     size_t old_tailroom = ofpbuf_tailroom(b);
 198     size_t copy_headroom = MIN(old_headroom, new_headroom);
 199     size_t copy_tailroom = MIN(old_tailroom, new_tailroom);
 200
 201     memcpy(&new_base[new_headroom - copy_headroom],
 202            &old_base[old_headroom - copy_headroom],
 203            copy_headroom + b->size + copy_tailroom);
 204 }
 205
 206 /* Reallocates 'b' so that it has exactly 'new_headroom' and 'new_tailroom'
 207  * bytes of headroom and tailroom, respectively. */
 208 static void
 209 ofpbuf_resize__(struct ofpbuf *b, size_t new_headroom, size_t new_tailroom)
 210 {
 211     void *new_base, *new_data;
 212     size_t new_allocated;
 213
 214     new_allocated = new_headroom + b->size + new_tailroom;
 215
 216     switch (b->source) {
 217     case OFPBUF_MALLOC:
 218         if (new_headroom == ofpbuf_headroom(b)) {
 219             new_base = xrealloc(b->base, new_allocated);
 220         } else {
 221             new_base = xmalloc(new_allocated);
 222             ofpbuf_copy__(b, new_base, new_headroom, new_tailroom);
 223             free(b->base);
 224         }
 225         break;
 226
 227     case OFPBUF_STACK:
 228         NOT_REACHED();
 229
 230     default:
 231         NOT_REACHED();
 232     }
 233
 234     b->allocated = new_allocated;
 235     b->base = new_base;
 236
 237     new_data = (char *) new_base + new_headroom;
 238     if (b->data != new_data) {
 239         uintptr_t data_delta = (char *) new_data - (char *) b->data;
 240         b->data = new_data;
 241         if (b->l2) {
 242             b->l2 = (char *) b->l2 + data_delta;
 243         }
 244         if (b->l3) {
 245             b->l3 = (char *) b->l3 + data_delta;
 246         }
 247         if (b->l4) {
 248             b->l4 = (char *) b->l4 + data_delta;
 249         }
 250         if (b->l7) {
 251             b->l7 = (char *) b->l7 + data_delta;
 252         }
 253     }
 254 }
 255
 256 /* Ensures that 'b' has room for at least 'size' bytes at its tail end,
 257  * reallocating and copying its data if necessary.  Its headroom, if any, is
 258  * preserved. */
 259 void
 260 ofpbuf_prealloc_tailroom(struct ofpbuf *b, size_t size)
 261 {
 262     if (size > ofpbuf_tailroom(b)) {
 263         ofpbuf_resize__(b, ofpbuf_headroom(b), MAX(size, 64));
 264     }
 265 }
 266
 267 /* Ensures that 'b' has room for at least 'size' bytes at its head,
 268  * reallocating and copying its data if necessary.  Its tailroom, if any, is
 269  * preserved. */
 270 void
 271 ofpbuf_prealloc_headroom(struct ofpbuf *b, size_t size)
 272 {
 273     if (size > ofpbuf_headroom(b)) {
 274         ofpbuf_resize__(b, MAX(size, 64), ofpbuf_tailroom(b));
 275     }
 276 }
 277
 278 /* Trims the size of 'b' to fit its actual content, reducing its tailroom to
 279  * 0.  Its headroom, if any, is preserved.
 280  *
 281  * Buffers not obtained from malloc() are not resized, since that wouldn't save
 282  * any memory. */
 283 void
 284 ofpbuf_trim(struct ofpbuf *b)
 285 {
 286     if (b->source == OFPBUF_MALLOC
 287         && (ofpbuf_headroom(b) || ofpbuf_tailroom(b))) {
 288         ofpbuf_resize__(b, 0, 0);
 289     }
 290 }
 291
 292 /* Appends 'size' bytes of data to the tail end of 'b', reallocating and
 293  * copying its data if necessary.  Returns a pointer to the first byte of the
 294  * new data, which is left uninitialized. */
 295 void *
 296 ofpbuf_put_uninit(struct ofpbuf *b, size_t size)
 297 {
 298     void *p;
 299     ofpbuf_prealloc_tailroom(b, size);
 300     p = ofpbuf_tail(b);
 301     b->size += size;
 302     return p;
 303 }
 304
 305 /* Appends 'size' zeroed bytes to the tail end of 'b'.  Data in 'b' is
 306  * reallocated and copied if necessary.  Returns a pointer to the first byte of
 307  * the data's location in the ofpbuf. */
 308 void *
 309 ofpbuf_put_zeros(struct ofpbuf *b, size_t size)
 310 {
 311     void *dst = ofpbuf_put_uninit(b, size);
 312     memset(dst, 0, size);
 313     return dst;
 314 }
 315
 316 /* Appends the 'size' bytes of data in 'p' to the tail end of 'b'.  Data in 'b'
 317  * is reallocated and copied if necessary.  Returns a pointer to the first
 318  * byte of the data's location in the ofpbuf. */
 319 void *
 320 ofpbuf_put(struct ofpbuf *b, const void *p, size_t size)
 321 {
 322     void *dst = ofpbuf_put_uninit(b, size);
 323     memcpy(dst, p, size);
 324     return dst;
 325 }
 326
 327 /* Parses as many pairs of hex digits as possible (possibly separated by
 328  * spaces) from the beginning of 's', appending bytes for their values to 'b'.
 329  * Returns the first character of 's' that is not the first of a pair of hex
 330  * digits.  If 'n' is nonnull, stores the number of bytes added to 'b' in
 331  * '*n'. */
 332 char *
 333 ofpbuf_put_hex(struct ofpbuf *b, const char *s, size_t *n)
 334 {
 335     size_t initial_size = b->size;
 336     for (;;) {
 337         uint8_t byte;
 338         bool ok;
 339
 340         s += strspn(s, " ");
 341         byte = hexits_value(s, 2, &ok);
 342         if (!ok) {
 343             if (n) {
 344                 *n = b->size - initial_size;
 345             }
 346             return (char *) s;
 347         }
 348
 349         ofpbuf_put(b, &byte, 1);
 350         s += 2;
 351     }
 352 }
 353
 354 /* Reserves 'size' bytes of headroom so that they can be later allocated with
 355  * ofpbuf_push_uninit() without reallocating the ofpbuf. */
 356 void
 357 ofpbuf_reserve(struct ofpbuf *b, size_t size)
 358 {
 359     assert(!b->size);
 360     ofpbuf_prealloc_tailroom(b, size);
 361     b->data = (char*)b->data + size;
 362 }
 363
 364 /* Prefixes 'size' bytes to the head end of 'b', reallocating and copying its
 365  * data if necessary.  Returns a pointer to the first byte of the data's
 366  * location in the ofpbuf.  The new data is left uninitialized. */
 367 void *
 368 ofpbuf_push_uninit(struct ofpbuf *b, size_t size)
 369 {
 370     ofpbuf_prealloc_headroom(b, size);
 371     b->data = (char*)b->data - size;
 372     b->size += size;
 373     return b->data;
 374 }
 375
 376 /* Prefixes 'size' zeroed bytes to the head end of 'b', reallocating and
 377  * copying its data if necessary.  Returns a pointer to the first byte of the
 378  * data's location in the ofpbuf. */
 379 void *
 380 ofpbuf_push_zeros(struct ofpbuf *b, size_t size)
 381 {
 382     void *dst = ofpbuf_push_uninit(b, size);
 383     memset(dst, 0, size);
 384     return dst;
 385 }
 386
 387 /* Copies the 'size' bytes starting at 'p' to the head end of 'b', reallocating
 388  * and copying its data if necessary.  Returns a pointer to the first byte of
 389  * the data's location in the ofpbuf. */
 390 void *
 391 ofpbuf_push(struct ofpbuf *b, const void *p, size_t size)
 392 {
 393     void *dst = ofpbuf_push_uninit(b, size);
 394     memcpy(dst, p, size);
 395     return dst;
 396 }
 397
 398 /* If 'b' contains at least 'offset + size' bytes of data, returns a pointer to
 399  * byte 'offset'.  Otherwise, returns a null pointer. */
 400 void *
 401 ofpbuf_at(const struct ofpbuf *b, size_t offset, size_t size)
 402 {
 403     return offset + size <= b->size ? (char *) b->data + offset : NULL;
 404 }
 405
 406 /* Returns a pointer to byte 'offset' in 'b', which must contain at least
 407  * 'offset + size' bytes of data. */
 408 void *
 409 ofpbuf_at_assert(const struct ofpbuf *b, size_t offset, size_t size)
 410 {
 411     assert(offset + size <= b->size);
 412     return ((char *) b->data) + offset;
 413 }
 414
 415 /* Returns the byte following the last byte of data in use in 'b'. */
 416 void *
 417 ofpbuf_tail(const struct ofpbuf *b)
 418 {
 419     return (char *) b->data + b->size;
 420 }
 421
 422 /* Returns the byte following the last byte allocated for use (but not
 423  * necessarily in use) by 'b'. */
 424 void *
 425 ofpbuf_end(const struct ofpbuf *b)
 426 {
 427     return (char *) b->base + b->allocated;
 428 }
 429
 430 /* Clears any data from 'b'. */
 431 void
 432 ofpbuf_clear(struct ofpbuf *b)
 433 {
 434     b->data = b->base;
 435     b->size = 0;
 436 }
 437
 438 /* Removes 'size' bytes from the head end of 'b', which must contain at least
 439  * 'size' bytes of data.  Returns the first byte of data removed. */
 440 void *
 441 ofpbuf_pull(struct ofpbuf *b, size_t size)
 442 {
 443     void *data = b->data;
 444     assert(b->size >= size);
 445     b->data = (char*)b->data + size;
 446     b->size -= size;
 447     return data;
 448 }
 449
 450 /* If 'b' has at least 'size' bytes of data, removes that many bytes from the
 451  * head end of 'b' and returns the first byte removed.  Otherwise, returns a
 452  * null pointer without modifying 'b'. */
 453 void *
 454 ofpbuf_try_pull(struct ofpbuf *b, size_t size)
 455 {
 456     return b->size >= size ? ofpbuf_pull(b, size) : NULL;
 457 }
 458
 459 /* Returns the data in 'b' as a block of malloc()'d memory and frees the buffer
 460  * within 'b'.  (If 'b' itself was dynamically allocated, e.g. with
 461  * ofpbuf_new(), then it should still be freed with, e.g., ofpbuf_delete().) */
 462 void *
 463 ofpbuf_steal_data(struct ofpbuf *b)
 464 {
 465     void *p;
 466     if (b->source == OFPBUF_MALLOC && b->data == b->base) {
 467         p = b->data;
 468     } else {
 469         p = xmemdup(b->data, b->size);
 470         if (b->source == OFPBUF_MALLOC) {
 471             free(b->base);
 472         }
 473     }
 474     b->base = b->data = NULL;
 475     return p;
 476 }
 477
 478 /* Returns a string that describes some of 'b''s metadata plus a hex dump of up
 479  * to 'maxbytes' from the start of the buffer. */
 480 char *
 481 ofpbuf_to_string(const struct ofpbuf *b, size_t maxbytes)
 482 {
 483     struct ds s;
 484
 485     ds_init(&s);
 486     ds_put_format(&s, "size=%zu, allocated=%zu, head=%zu, tail=%zu\n",
 487                   b->size, b->allocated,
 488                   ofpbuf_headroom(b), ofpbuf_tailroom(b));
 489     ds_put_hex_dump(&s, b->data, MIN(b->size, maxbytes), 0, false);
 490     return ds_cstr(&s);
 491 }
 492
 493 /* Removes each of the "struct ofpbuf"s on 'list' from the list and frees
 494  * them.  */
 495 void
 496 ofpbuf_list_delete(struct list *list)
 497 {
 498     struct ofpbuf *b, *next;
 499
 500     LIST_FOR_EACH_SAFE (b, next, list_node, list) {
 501         list_remove(&b->list_node);
 502         ofpbuf_delete(b);
 503     }
 504 }