Files
openflow/lib/buffer.c
T
Ben Pfaff 60a87c9b00 Break data_hello and control_hello messages into multiple messages.
We want to allow multiple OpenFlow connections to a switch, so that
dpctl and other management tools can also connect to a switch that
is connecte to the controller.  These tools will want to fetch the
information in the data_hello message, but currently this can only
be done by sending a control_hello message, which changes the
switch configuration state.  So breaking the hello messages up into
multiple different messages, only some of which affect configuration
state, cures the problem.

Also, clean up the kernel datapath a bit, by adding helper functions
for allocating and resizing Generic Netlink messages that encapsulate
OpenFlow messages.
2008-04-04 16:22:21 -07:00

243 lines
6.8 KiB
C

/* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
* Junior University
*
* We are making the OpenFlow specification and associated documentation
* (Software) available for public use and benefit with the expectation
* that others will use, modify and enhance the Software and contribute
* those enhancements back to the community. However, since we would
* like to make the Software available for broadest use, with as few
* restrictions as possible permission is hereby granted, free of
* charge, to any person obtaining a copy of this Software to deal in
* the Software under the copyrights without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* The name and trademarks of copyright holder(s) may NOT be used in
* advertising or publicity pertaining to the Software or any
* derivatives without specific, written prior permission.
*/
#include "buffer.h"
#include <assert.h>
#include <stdlib.h>
#include <string.h>
#include "util.h"
/* Initializes 'b' as an empty buffer that contains the 'allocated' bytes of
* memory starting at 'base'.
*
* 'base' should ordinarily be the first byte of a region obtained from
* malloc(), but in circumstances where it can be guaranteed that 'b' will
* never need to be expanded or freed, it can be a pointer into arbitrary
* memory. */
void
buffer_use(struct buffer *b, void *base, size_t allocated)
{
b->base = b->data = base;
b->allocated = allocated;
b->size = 0;
b->l2 = b->l3 = b->l4 = NULL;
b->next = NULL;
}
/* Initializes 'b' as a buffer with an initial capacity of 'size' bytes. */
void
buffer_init(struct buffer *b, size_t size)
{
buffer_use(b, size ? xmalloc(size) : NULL, size);
}
/* Frees memory that 'b' points to. */
void
buffer_uninit(struct buffer *b)
{
if (b) {
free(b->base);
}
}
/* Frees memory that 'b' points to and allocates a new buffer */
void
buffer_reinit(struct buffer *b, size_t size)
{
buffer_uninit(b);
buffer_init(b, size);
}
/* Creates and returns a new buffer with an initial capacity of 'size'
* bytes. */
struct buffer *
buffer_new(size_t size)
{
struct buffer *b = xmalloc(sizeof *b);
buffer_init(b, size);
return b;
}
struct buffer *
buffer_clone(const struct buffer *buffer)
{
/* FIXME: reference counting. */
struct buffer *b = buffer_new(buffer->size);
buffer_put(b, buffer->data, buffer->size);
return b;
}
/* Frees memory that 'b' points to, as well as 'b' itself. */
void
buffer_delete(struct buffer *b)
{
if (b) {
buffer_uninit(b);
free(b);
}
}
/* Returns the number of bytes of headroom in 'b', that is, the number of bytes
* of unused space in buffer 'b' before the data that is in use. (Most
* commonly, the data in a buffer is at its beginning, and thus the buffer's
* headroom is 0.) */
size_t
buffer_headroom(struct buffer *b)
{
return b->data - b->base;
}
/* Returns the number of bytes that may be appended to the tail end of buffer
* 'b' before the buffer must be reallocated. */
size_t
buffer_tailroom(struct buffer *b)
{
return buffer_end(b) - buffer_tail(b);
}
/* Ensures that 'b' has room for at least 'size' bytes at its tail end,
* reallocating and copying its data if necessary. */
void
buffer_reserve_tailroom(struct buffer *b, size_t size)
{
if (size > buffer_tailroom(b)) {
size_t new_allocated = b->allocated + MAX(size, 64);
void *new_base = xmalloc(new_allocated);
uintptr_t base_delta = new_base - b->base;
memcpy(new_base, b->base, b->allocated);
free(b->base);
b->base = new_base;
b->allocated = new_allocated;
b->data += base_delta;
if (b->l2) {
b->l2 += base_delta;
}
if (b->l3) {
b->l3 += base_delta;
}
if (b->l4) {
b->l4 += base_delta;
}
}
}
void
buffer_reserve_headroom(struct buffer *b, size_t size)
{
assert(size <= buffer_headroom(b));
}
/* Appends 'size' bytes of data to the tail end of 'b', reallocating and
* copying its data if necessary. Returns a pointer to the first byte of the
* new data, which is left uninitialized. */
void *
buffer_put_uninit(struct buffer *b, size_t size)
{
void *p;
buffer_reserve_tailroom(b, size);
p = buffer_tail(b);
b->size += size;
return p;
}
/* Appends the 'size' bytes of data in 'p' to the tail end of 'b'. Data in 'b'
* is reallocated and copied if necessary. Returns a pointer to the first
* byte of the data's location in the buffer. */
void *
buffer_put(struct buffer *b, const void *p, size_t size)
{
void *dst = buffer_put_uninit(b, size);
memcpy(dst, p, size);
return dst;
}
void *
buffer_push_uninit(struct buffer *b, size_t size)
{
buffer_reserve_headroom(b, size);
b->data -= size;
b->size += size;
return b->data;
}
/* If 'b' contains at least 'offset + size' bytes of data, returns a pointer to
* byte 'offset'. Otherwise, returns a null pointers. */
void *
buffer_at(const struct buffer *b, size_t offset, size_t size)
{
return offset + size <= b->size ? (char *) b->data + offset : NULL;
}
/* Returns a pointer to byte 'offset' in 'b', which must contain at least
* 'offset + size' bytes of data. */
void *
buffer_at_assert(const struct buffer *b, size_t offset, size_t size)
{
assert(offset + size <= b->size);
return ((char *) b->data) + offset;
}
/* Returns the byte following the last byte of data in use in 'b'. */
void *
buffer_tail(const struct buffer *b)
{
return (char *) b->data + b->size;
}
/* Returns the byte following the last byte allocated for use (but not
* necessarily in use) by 'b'. */
void *
buffer_end(const struct buffer *b)
{
return (char *) b->base + b->allocated;
}
/* Clears any data from 'b'. */
void
buffer_clear(struct buffer *b)
{
b->data = b->base;
b->size = 0;
}
/* Removes 'size' bytes from the head end of 'b', which must contain at least
* 'size' bytes of data. */
void
buffer_pull(struct buffer *b, size_t size)
{
assert(b->size >= size);
b->data += size;
b->size -= size;
}