/*
- * 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.
*/
#include <config.h>
-#include "ofpbuf.h"
+#include "openvswitch/ofpbuf.h"
#include <stdlib.h>
#include <string.h>
-#include "dynamic-string.h"
-#include "netdev-dpdk.h"
+#include "openvswitch/dynamic-string.h"
#include "util.h"
static void
{
b->allocated = allocated;
b->source = source;
- b->frame = NULL;
- b->l2_5_ofs = b->l3_ofs = b->l4_ofs = UINT16_MAX;
- list_poison(&b->list_node);
+ b->header = NULL;
+ b->msg = NULL;
+ ovs_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);
}
* 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
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
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
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'
{
if (b) {
if (b->source == OFPBUF_MALLOC) {
- free(ofpbuf_base(b));
- } else if (b->source == OFPBUF_DPDK) {
-#ifdef DPDK_NETDEV
- /* If this ofpbuf was allocated by DPDK it must have been
- * created as a dpif_packet */
- free_dpdk_buf((struct dpif_packet*) b);
-#else
- ovs_assert(b->source != OFPBUF_DPDK);
-#endif
+ free(b->base);
}
}
}
}
/* 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)
/* Creates and returns a new ofpbuf whose data are copied from 'buffer'. The
* returned ofpbuf will additionally have 'headroom' bytes of headroom. */
struct ofpbuf *
-ofpbuf_clone_with_headroom(const struct ofpbuf *buffer, size_t headroom)
+ofpbuf_clone_with_headroom(const struct ofpbuf *b, size_t headroom)
{
struct ofpbuf *new_buffer;
- new_buffer = ofpbuf_clone_data_with_headroom(ofpbuf_data(buffer),
- ofpbuf_size(buffer),
- headroom);
- if (buffer->frame) {
- uintptr_t data_delta
- = (char *)ofpbuf_data(new_buffer) - (char *)ofpbuf_data(buffer);
+ new_buffer = ofpbuf_clone_data_with_headroom(b->data, b->size, headroom);
+ if (b->header) {
+ ptrdiff_t header_offset = (char *) b->header - (char *) b->data;
- new_buffer->frame = (char *) buffer->frame + data_delta;
+ new_buffer->header = (char *) new_buffer->data + header_offset;
+ }
+ if (b->msg) {
+ ptrdiff_t msg_offset = (char *) b->msg - (char *) b->data;
+
+ new_buffer->msg = (char *) new_buffer->data + msg_offset;
}
- new_buffer->l2_5_ofs = buffer->l2_5_ofs;
- new_buffer->l3_ofs = buffer->l3_ofs;
- new_buffer->l4_ofs = buffer->l4_ofs;
return new_buffer;
}
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);
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'
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;
}
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) {
- if (b->frame) {
- uintptr_t data_delta = (char *) new_data - (char *) ofpbuf_data(b);
+ if (b->data != new_data) {
+ if (b->header) {
+ ptrdiff_t header_offset = (char *) b->header - (char *) b->data;
+
+ b->header = (char *) new_data + header_offset;
+ }
+ if (b->msg) {
+ ptrdiff_t msg_offset = (char *) b->msg - (char *) b->data;
- b->frame = (char *) b->frame + data_delta;
+ b->msg = (char *) new_data + msg_offset;
}
- ofpbuf_set_data(b, new_data);
+ b->data = new_data;
}
}
}
}
-/* 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);
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)
{
: 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;
}
}
void *p;
ofpbuf_prealloc_tailroom(b, size);
p = ofpbuf_tail(b);
- ofpbuf_set_size(b, ofpbuf_size(b) + size);
+ b->size += size;
return p;
}
ofpbuf_put_zeros(struct ofpbuf *b, size_t size)
{
void *dst = ofpbuf_put_uninit(b, size);
- memset(dst, 0, size);
+ nullable_memset(dst, 0, size);
return dst;
}
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);
}
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
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
return dst;
}
+/* Inserts the 'n' bytes of 'data' into 'b' starting at the given 'offset',
+ * moving data forward as necessary to make room.
+ *
+ * 'data' must not point inside 'b'. */
+void
+ofpbuf_insert(struct ofpbuf *b, size_t offset, const void *data, size_t n)
+{
+ if (offset < b->size) {
+ ofpbuf_put_uninit(b, n); /* b->size gets increased. */
+ memmove((char *) b->data + offset + n, (char *) b->data + offset,
+ b->size - offset - n);
+ memcpy((char *) b->data + offset, data, n);
+ } else {
+ ovs_assert(offset == b->size);
+ ofpbuf_put(b, data, n);
+ }
+}
+
/* Returns the data in 'b' as a block of malloc()'d memory and frees the buffer
* within 'b'. (If 'b' itself was dynamically allocated, e.g. with
* ofpbuf_new(), then it should still be freed with, e.g., ofpbuf_delete().) */
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;
}
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->frame = 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->frame;
-}
-
-/* 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->frame;
-}