1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
4 * We are making the OpenFlow specification and associated documentation
5 * (Software) available for public use and benefit with the expectation
6 * that others will use, modify and enhance the Software and contribute
7 * those enhancements back to the community. However, since we would
8 * like to make the Software available for broadest use, with as few
9 * restrictions as possible permission is hereby granted, free of
10 * charge, to any person obtaining a copy of this Software to deal in
11 * the Software under the copyrights without restriction, including
12 * without limitation the rights to use, copy, modify, merge, publish,
13 * distribute, sublicense, and/or sell copies of the Software, and to
14 * permit persons to whom the Software is furnished to do so, subject to
15 * the following conditions:
17 * The above copyright notice and this permission notice shall be
18 * included in all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
24 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
25 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
26 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 * The name and trademarks of copyright holder(s) may NOT be used in
30 * advertising or publicity pertaining to the Software or any
31 * derivatives without specific, written prior permission.
39 /* Buffer for holding arbitrary data. A buffer is automatically reallocated as
40 * necessary if it grows too large for the available memory. */
42 void *base; /* First byte of area malloc()'d area. */
43 size_t allocated; /* Number of bytes allocated. */
45 void *data; /* First byte actually in use. */
46 size_t size; /* Number of bytes in use. */
48 void *l2; /* Link-level header. */
49 void *l3; /* Network-level header. */
50 void *l4; /* Transport-level header. */
51 void *l7; /* Application data. */
53 struct buffer *next; /* Next in a list of buffers. */
56 void buffer_use(struct buffer *, void *, size_t);
58 void buffer_init(struct buffer *, size_t);
59 void buffer_uninit(struct buffer *);
60 void buffer_reinit(struct buffer *, size_t);
62 struct buffer *buffer_new(size_t);
63 struct buffer *buffer_clone(const struct buffer *);
64 void buffer_delete(struct buffer *);
66 void *buffer_at(const struct buffer *, size_t offset, size_t size);
67 void *buffer_at_assert(const struct buffer *, size_t offset, size_t size);
68 void *buffer_tail(const struct buffer *);
69 void *buffer_end(const struct buffer *);
71 void *buffer_put_uninit(struct buffer *, size_t);
72 void *buffer_put(struct buffer *, const void *, size_t);
73 void buffer_reserve(struct buffer *, size_t);
74 void *buffer_push_uninit(struct buffer *b, size_t);
75 void *buffer_push(struct buffer *b, const void *, size_t);
77 size_t buffer_headroom(struct buffer *);
78 size_t buffer_tailroom(struct buffer *);
79 void buffer_prealloc_headroom(struct buffer *, size_t);
80 void buffer_prealloc_tailroom(struct buffer *, size_t);
82 void buffer_clear(struct buffer *);
83 void *buffer_pull(struct buffer *, size_t);
84 void *buffer_try_pull(struct buffer *, size_t);