ofpbuf: Use ptrdiff_t for pointer delta.
[cascardo/ovs.git] / lib / ofpbuf.c
index 6a44a30..02c9d15 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
+ * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2016 Nicira, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -27,18 +27,18 @@ ofpbuf_init__(struct ofpbuf *b, size_t allocated, enum ofpbuf_source source)
 {
     b->allocated = allocated;
     b->source = source;
-    b->l2 = NULL;
-    b->l2_5_ofs = b->l3_ofs = b->l4_ofs = UINT16_MAX;
+    b->header = NULL;
+    b->msg = NULL;
     list_poison(&b->list_node);
 }
 
 static void
-ofpbuf_use__(struct ofpbuf *b, void *base, size_t allocated,
+ofpbuf_use__(struct ofpbuf *b, void *base, size_t allocated, size_t size,
              enum ofpbuf_source source)
 {
-    ofpbuf_set_base(b, base);
-    ofpbuf_set_data(b, base);
-    ofpbuf_set_size(b, 0);
+    b->base = base;
+    b->data = base;
+    b->size = size;
 
     ofpbuf_init__(b, allocated, source);
 }
@@ -47,10 +47,20 @@ ofpbuf_use__(struct ofpbuf *b, void *base, size_t allocated,
  * memory starting at 'base'.  'base' should be the first byte of a region
  * obtained from malloc().  It will be freed (with free()) if 'b' is resized or
  * freed. */
-void
+static void
 ofpbuf_use(struct ofpbuf *b, void *base, size_t allocated)
 {
-    ofpbuf_use__(b, base, allocated, OFPBUF_MALLOC);
+    ofpbuf_use__(b, base, allocated, 0, OFPBUF_MALLOC);
+}
+
+/* Converts ds into ofpbuf 'b'. 'b' contains the 'ds->allocated' bytes of
+ * memory starting at 'ds->string'.  'ds' should not be modified any more.
+ * The memory allocated for 'ds' will be freed (with free()) if 'b' is
+ * resized or freed. */
+void
+ofpbuf_use_ds(struct ofpbuf *b, const struct ds *ds)
+{
+    ofpbuf_use__(b, ds->string, ds->allocated + 1, ds->length, OFPBUF_MALLOC);
 }
 
 /* Initializes 'b' as an empty ofpbuf that contains the 'allocated' bytes of
@@ -70,7 +80,7 @@ ofpbuf_use(struct ofpbuf *b, void *base, size_t allocated)
 void
 ofpbuf_use_stack(struct ofpbuf *b, void *base, size_t allocated)
 {
-    ofpbuf_use__(b, base, allocated, OFPBUF_STACK);
+    ofpbuf_use__(b, base, allocated, 0, OFPBUF_STACK);
 }
 
 /* Initializes 'b' as an empty ofpbuf that contains the 'allocated' bytes of
@@ -90,7 +100,7 @@ ofpbuf_use_stack(struct ofpbuf *b, void *base, size_t allocated)
 void
 ofpbuf_use_stub(struct ofpbuf *b, void *base, size_t allocated)
 {
-    ofpbuf_use__(b, base, allocated, OFPBUF_STUB);
+    ofpbuf_use__(b, base, allocated, 0, OFPBUF_STUB);
 }
 
 /* Initializes 'b' as an ofpbuf whose data starts at 'data' and continues for
@@ -103,20 +113,7 @@ ofpbuf_use_stub(struct ofpbuf *b, void *base, size_t allocated)
 void
 ofpbuf_use_const(struct ofpbuf *b, const void *data, size_t size)
 {
-    ofpbuf_use__(b, CONST_CAST(void *, data), size, OFPBUF_STACK);
-    ofpbuf_set_size(b, size);
-}
-
-/* Initializes 'b' as an empty ofpbuf that contains the 'allocated' bytes of
- * memory starting at 'base'.  DPDK allocated ofpbuf and *data is allocated
- * from one continous memory region, so in memory data start right after
- * ofpbuf.  Therefore there is special method to free this type of
- * buffer.  ofpbuf base, data and size are initialized by dpdk rcv() so no
- * need to initialize those fields. */
-void
-ofpbuf_init_dpdk(struct ofpbuf *b, size_t allocated)
-{
-    ofpbuf_init__(b, allocated, OFPBUF_DPDK);
+    ofpbuf_use__(b, CONST_CAST(void *, data), size, size, OFPBUF_STACK);
 }
 
 /* Initializes 'b' as an empty ofpbuf with an initial capacity of 'size'
@@ -133,9 +130,8 @@ ofpbuf_uninit(struct ofpbuf *b)
 {
     if (b) {
         if (b->source == OFPBUF_MALLOC) {
-            free(ofpbuf_base(b));
+            free(b->base);
         }
-        ovs_assert(b->source != OFPBUF_DPDK);
     }
 }
 
@@ -168,7 +164,7 @@ ofpbuf_new_with_headroom(size_t size, size_t headroom)
 }
 
 /* Creates and returns a new ofpbuf that initially contains a copy of the
- * 'ofpbuf_size(buffer)' bytes of data starting at 'buffer->data' with no headroom or
+ * 'buffer->size' bytes of data starting at 'buffer->data' with no headroom or
  * tailroom. */
 struct ofpbuf *
 ofpbuf_clone(const struct ofpbuf *buffer)
@@ -183,17 +179,15 @@ ofpbuf_clone_with_headroom(const struct ofpbuf *buffer, size_t headroom)
 {
     struct ofpbuf *new_buffer;
 
-    new_buffer = ofpbuf_clone_data_with_headroom(ofpbuf_data(buffer),
-                                                 ofpbuf_size(buffer),
+    new_buffer = ofpbuf_clone_data_with_headroom(buffer->data,
+                                                 buffer->size,
                                                  headroom);
-    if (buffer->l2) {
-        uintptr_t data_delta = (char *)ofpbuf_data(new_buffer) - (char *)ofpbuf_data(buffer);
+    if (buffer->header) {
+        ptrdiff_t data_delta = (char *)new_buffer->data - (char *)buffer->data;
 
-        new_buffer->l2 = (char *) buffer->l2 + data_delta;
+        new_buffer->header = (char *) buffer->header + data_delta;
     }
-    new_buffer->l2_5_ofs = buffer->l2_5_ofs;
-    new_buffer->l3_ofs = buffer->l3_ofs;
-    new_buffer->l4_ofs = buffer->l4_ofs;
+    new_buffer->msg = buffer->msg;
 
     return new_buffer;
 }
@@ -221,7 +215,7 @@ static void
 ofpbuf_copy__(struct ofpbuf *b, uint8_t *new_base,
               size_t new_headroom, size_t new_tailroom)
 {
-    const uint8_t *old_base = ofpbuf_base(b);
+    const uint8_t *old_base = b->base;
     size_t old_headroom = ofpbuf_headroom(b);
     size_t old_tailroom = ofpbuf_tailroom(b);
     size_t copy_headroom = MIN(old_headroom, new_headroom);
@@ -229,7 +223,7 @@ ofpbuf_copy__(struct ofpbuf *b, uint8_t *new_base,
 
     memcpy(&new_base[new_headroom - copy_headroom],
            &old_base[old_headroom - copy_headroom],
-           copy_headroom + ofpbuf_size(b) + copy_tailroom);
+           copy_headroom + b->size + copy_tailroom);
 }
 
 /* Reallocates 'b' so that it has exactly 'new_headroom' and 'new_tailroom'
@@ -240,19 +234,16 @@ ofpbuf_resize__(struct ofpbuf *b, size_t new_headroom, size_t new_tailroom)
     void *new_base, *new_data;
     size_t new_allocated;
 
-    new_allocated = new_headroom + ofpbuf_size(b) + new_tailroom;
+    new_allocated = new_headroom + b->size + new_tailroom;
 
     switch (b->source) {
-    case OFPBUF_DPDK:
-        OVS_NOT_REACHED();
-
     case OFPBUF_MALLOC:
         if (new_headroom == ofpbuf_headroom(b)) {
-            new_base = xrealloc(ofpbuf_base(b), new_allocated);
+            new_base = xrealloc(b->base, new_allocated);
         } else {
             new_base = xmalloc(new_allocated);
             ofpbuf_copy__(b, new_base, new_headroom, new_tailroom);
-            free(ofpbuf_base(b));
+            free(b->base);
         }
         break;
 
@@ -270,16 +261,21 @@ ofpbuf_resize__(struct ofpbuf *b, size_t new_headroom, size_t new_tailroom)
     }
 
     b->allocated = new_allocated;
-    ofpbuf_set_base(b, new_base);
+    b->base = new_base;
 
     new_data = (char *) new_base + new_headroom;
-    if (ofpbuf_data(b) != new_data) {
-        uintptr_t data_delta = (char *) new_data - (char *) ofpbuf_data(b);
+    if (b->data != new_data) {
+        if (b->header) {
+            ptrdiff_t data_delta = (char *) b->header - (char *) b->data;
+
+            b->header = (char *) new_data + data_delta;
+        }
+        if (b->msg) {
+            ptrdiff_t data_delta = (char *) b->msg - (char *) b->data;
 
-        ofpbuf_set_data(b, new_data);
-        if (b->l2) {
-            b->l2 = (char *) b->l2 + data_delta;
+            b->msg = (char *) new_data + data_delta;
         }
+        b->data = new_data;
     }
 }
 
@@ -305,16 +301,20 @@ ofpbuf_prealloc_headroom(struct ofpbuf *b, size_t size)
     }
 }
 
-/* Trims the size of 'b' to fit its actual content, reducing its tailroom to
- * 0.  Its headroom, if any, is preserved.
+/* Trims the size of 'b' to fit its actual content, reducing its headroom and
+ * tailroom to 0, if any.
  *
  * Buffers not obtained from malloc() are not resized, since that wouldn't save
- * any memory. */
+ * any memory.
+ *
+ * Caller needs to updates 'b->header' and 'b->msg' so that they point to the
+ * same locations in the data.  (If they pointed into the tailroom or headroom
+ * then they become invalid.)
+ *
+ */
 void
 ofpbuf_trim(struct ofpbuf *b)
 {
-    ovs_assert(b->source != OFPBUF_DPDK);
-
     if (b->source == OFPBUF_MALLOC
         && (ofpbuf_headroom(b) || ofpbuf_tailroom(b))) {
         ofpbuf_resize__(b, 0, 0);
@@ -326,15 +326,19 @@ ofpbuf_trim(struct ofpbuf *b)
 void
 ofpbuf_padto(struct ofpbuf *b, size_t length)
 {
-    if (ofpbuf_size(b) < length) {
-        ofpbuf_put_zeros(b, length - ofpbuf_size(b));
+    if (b->size < length) {
+        ofpbuf_put_zeros(b, length - b->size);
     }
 }
 
 /* Shifts all of the data within the allocated space in 'b' by 'delta' bytes.
  * For example, a 'delta' of 1 would cause each byte of data to move one byte
  * forward (from address 'p' to 'p+1'), and a 'delta' of -1 would cause each
- * byte to move one byte backward (from 'p' to 'p-1'). */
+ * byte to move one byte backward (from 'p' to 'p-1').
+ *
+ * If used, user must make sure the 'header' and 'msg' pointers are updated
+ * after shifting.
+ */
 void
 ofpbuf_shift(struct ofpbuf *b, int delta)
 {
@@ -343,9 +347,9 @@ ofpbuf_shift(struct ofpbuf *b, int delta)
                : true);
 
     if (delta != 0) {
-        char *dst = (char *) ofpbuf_data(b) + delta;
-        memmove(dst, ofpbuf_data(b), ofpbuf_size(b));
-        ofpbuf_set_data(b, dst);
+        char *dst = (char *) b->data + delta;
+        memmove(dst, b->data, b->size);
+        b->data = dst;
     }
 }
 
@@ -358,7 +362,7 @@ ofpbuf_put_uninit(struct ofpbuf *b, size_t size)
     void *p;
     ofpbuf_prealloc_tailroom(b, size);
     p = ofpbuf_tail(b);
-    ofpbuf_set_size(b, ofpbuf_size(b) + size);
+    b->size += size;
     return p;
 }
 
@@ -384,24 +388,24 @@ ofpbuf_put(struct ofpbuf *b, const void *p, size_t size)
     return dst;
 }
 
-/* Parses as many pairs of hex digits as possible (possibly separated by
- * spaces) from the beginning of 's', appending bytes for their values to 'b'.
- * Returns the first character of 's' that is not the first of a pair of hex
- * digits.  If 'n' is nonnull, stores the number of bytes added to 'b' in
+/* Parses as many pairs of hex digits as possible (possibly separated by spaces
+ * or periods) from the beginning of 's', appending bytes for their values to
+ * 'b'.  Returns the first character of 's' that is not the first of a pair of
+ * hex digits.  If 'n' is nonnull, stores the number of bytes added to 'b' in
  * '*n'. */
 char *
 ofpbuf_put_hex(struct ofpbuf *b, const char *s, size_t *n)
 {
-    size_t initial_size = ofpbuf_size(b);
+    size_t initial_size = b->size;
     for (;;) {
         uint8_t byte;
         bool ok;
 
-        s += strspn(s, " \t\r\n");
+        s += strspn(s, " .\t\r\n");
         byte = hexits_value(s, 2, &ok);
         if (!ok) {
             if (n) {
-                *n = ofpbuf_size(b) - initial_size;
+                *n = b->size - initial_size;
             }
             return CONST_CAST(char *, s);
         }
@@ -416,20 +420,9 @@ ofpbuf_put_hex(struct ofpbuf *b, const char *s, size_t *n)
 void
 ofpbuf_reserve(struct ofpbuf *b, size_t size)
 {
-    ovs_assert(!ofpbuf_size(b));
+    ovs_assert(!b->size);
     ofpbuf_prealloc_tailroom(b, size);
-    ofpbuf_set_data(b, (char*)ofpbuf_data(b) + size);
-}
-
-/* Reserves 'size' bytes of headroom so that they can be later allocated with
- * ofpbuf_push_uninit() without reallocating the ofpbuf. */
-void
-ofpbuf_reserve_with_tailroom(struct ofpbuf *b, size_t headroom,
-                             size_t tailroom)
-{
-    ovs_assert(!ofpbuf_size(b));
-    ofpbuf_prealloc_tailroom(b, headroom + tailroom);
-    ofpbuf_set_data(b, (char*)ofpbuf_data(b) + headroom);
+    b->data = (char*)b->data + size;
 }
 
 /* Prefixes 'size' bytes to the head end of 'b', reallocating and copying its
@@ -439,9 +432,9 @@ void *
 ofpbuf_push_uninit(struct ofpbuf *b, size_t size)
 {
     ofpbuf_prealloc_headroom(b, size);
-    ofpbuf_set_data(b, (char*)ofpbuf_data(b) - size);
-    ofpbuf_set_size(b, ofpbuf_size(b) + size);
-    return ofpbuf_data(b);
+    b->data = (char*)b->data - size;
+    b->size += size;
+    return b->data;
 }
 
 /* Prefixes 'size' zeroed bytes to the head end of 'b', reallocating and
@@ -473,18 +466,19 @@ void *
 ofpbuf_steal_data(struct ofpbuf *b)
 {
     void *p;
-    ovs_assert(b->source != OFPBUF_DPDK);
 
-    if (b->source == OFPBUF_MALLOC && ofpbuf_data(b) == ofpbuf_base(b)) {
-        p = ofpbuf_data(b);
+    if (b->source == OFPBUF_MALLOC && b->data == b->base) {
+        p = b->data;
     } else {
-        p = xmemdup(ofpbuf_data(b), ofpbuf_size(b));
+        p = xmemdup(b->data, b->size);
         if (b->source == OFPBUF_MALLOC) {
-            free(ofpbuf_base(b));
+            free(b->base);
         }
     }
-    ofpbuf_set_base(b, NULL);
-    ofpbuf_set_data(b, NULL);
+    b->base = NULL;
+    b->data = NULL;
+    b->header = NULL;
+    b->msg = NULL;
     return p;
 }
 
@@ -497,60 +491,20 @@ ofpbuf_to_string(const struct ofpbuf *b, size_t maxbytes)
 
     ds_init(&s);
     ds_put_format(&s, "size=%"PRIu32", allocated=%"PRIu32", head=%"PRIuSIZE", tail=%"PRIuSIZE"\n",
-                  ofpbuf_size(b), b->allocated,
+                  b->size, b->allocated,
                   ofpbuf_headroom(b), ofpbuf_tailroom(b));
-    ds_put_hex_dump(&s, ofpbuf_data(b), MIN(ofpbuf_size(b), maxbytes), 0, false);
+    ds_put_hex_dump(&s, b->data, MIN(b->size, maxbytes), 0, false);
     return ds_cstr(&s);
 }
 
 /* Removes each of the "struct ofpbuf"s on 'list' from the list and frees
  * them.  */
 void
-ofpbuf_list_delete(struct list *list)
+ofpbuf_list_delete(struct ovs_list *list)
 {
-    struct ofpbuf *b, *next;
+    struct ofpbuf *b;
 
-    LIST_FOR_EACH_SAFE (b, next, list_node, list) {
-        list_remove(&b->list_node);
+    LIST_FOR_EACH_POP (b, list_node, list) {
         ofpbuf_delete(b);
     }
 }
-
-static inline void
-ofpbuf_adjust_layer_offset(uint16_t *offset, int increment)
-{
-    if (*offset != UINT16_MAX) {
-        *offset += increment;
-    }
-}
-
-/* Adjust the size of the l2_5 portion of the ofpbuf, updating the l2
- * pointer and the layer offsets.  The caller is responsible for
- * modifying the contents. */
-void *
-ofpbuf_resize_l2_5(struct ofpbuf *b, int increment)
-{
-    if (increment >= 0) {
-        ofpbuf_push_uninit(b, increment);
-    } else {
-        ofpbuf_pull(b, -increment);
-    }
-
-    b->l2 = ofpbuf_data(b);
-    /* Adjust layer offsets after l2_5. */
-    ofpbuf_adjust_layer_offset(&b->l3_ofs, increment);
-    ofpbuf_adjust_layer_offset(&b->l4_ofs, increment);
-
-    return b->l2;
-}
-
-/* Adjust the size of the l2 portion of the ofpbuf, updating the l2
- * pointer and the layer offsets.  The caller is responsible for
- * modifying the contents. */
-void *
-ofpbuf_resize_l2(struct ofpbuf *b, int increment)
-{
-    ofpbuf_resize_l2_5(b, increment);
-    ofpbuf_adjust_layer_offset(&b->l2_5_ofs, increment);
-    return b->l2;
-}