2 * Copyright (c) 2008, 2009 Nicira Networks.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 /* Buffer for holding arbitrary data. An ofpbuf is automatically reallocated
23 * as necessary if it grows too large for the available memory. */
25 void *base; /* First byte of area malloc()'d area. */
26 size_t allocated; /* Number of bytes allocated. */
28 void *data; /* First byte actually in use. */
29 size_t size; /* Number of bytes in use. */
31 void *l2; /* Link-level header. */
32 void *l3; /* Network-level header. */
33 void *l4; /* Transport-level header. */
34 void *l7; /* Application data. */
36 struct ofpbuf *next; /* Next in a list of ofpbufs. */
37 void *private; /* Private pointer for use by owner. */
40 void ofpbuf_use(struct ofpbuf *, void *, size_t);
42 void ofpbuf_init(struct ofpbuf *, size_t);
43 void ofpbuf_uninit(struct ofpbuf *);
44 void ofpbuf_reinit(struct ofpbuf *, size_t);
46 struct ofpbuf *ofpbuf_new(size_t);
47 struct ofpbuf *ofpbuf_clone(const struct ofpbuf *);
48 struct ofpbuf *ofpbuf_clone_data(const void *, size_t);
49 void ofpbuf_delete(struct ofpbuf *);
51 void *ofpbuf_at(const struct ofpbuf *, size_t offset, size_t size);
52 void *ofpbuf_at_assert(const struct ofpbuf *, size_t offset, size_t size);
53 void *ofpbuf_tail(const struct ofpbuf *);
54 void *ofpbuf_end(const struct ofpbuf *);
56 void *ofpbuf_put_uninit(struct ofpbuf *, size_t);
57 void *ofpbuf_put_zeros(struct ofpbuf *, size_t);
58 void *ofpbuf_put(struct ofpbuf *, const void *, size_t);
59 void ofpbuf_reserve(struct ofpbuf *, size_t);
60 void *ofpbuf_push_uninit(struct ofpbuf *b, size_t);
61 void *ofpbuf_push(struct ofpbuf *b, const void *, size_t);
63 size_t ofpbuf_headroom(struct ofpbuf *);
64 size_t ofpbuf_tailroom(struct ofpbuf *);
65 void ofpbuf_prealloc_headroom(struct ofpbuf *, size_t);
66 void ofpbuf_prealloc_tailroom(struct ofpbuf *, size_t);
67 void ofpbuf_trim(struct ofpbuf *);
69 void ofpbuf_clear(struct ofpbuf *);
70 void *ofpbuf_pull(struct ofpbuf *, size_t);
71 void *ofpbuf_try_pull(struct ofpbuf *, size_t);