]>
Commit | Line | Data |
---|---|---|
064af421 | 1 | /* |
30f07f1a | 2 | * Copyright (c) 2008, 2009, 2010 Nicira Networks. |
064af421 | 3 | * |
a14bc59f BP |
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: | |
064af421 | 7 | * |
a14bc59f BP |
8 | * http://www.apache.org/licenses/LICENSE-2.0 |
9 | * | |
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. | |
064af421 BP |
15 | */ |
16 | ||
17 | #ifndef OFPBUF_H | |
18 | #define OFPBUF_H 1 | |
19 | ||
20 | #include <stddef.h> | |
31ac1e59 | 21 | #include <stdint.h> |
b3907fbc | 22 | #include "list.h" |
31ac1e59 | 23 | #include "util.h" |
064af421 | 24 | |
d45e9c65 BP |
25 | #ifdef __cplusplus |
26 | extern "C" { | |
27 | #endif | |
28 | ||
31ac1e59 BP |
29 | enum ofpbuf_source { |
30 | OFPBUF_MALLOC, /* Obtained via malloc(). */ | |
31 | OFPBUF_STACK, /* Stack space or static buffer. */ | |
32 | OFPBUF_CONST /* Must not be expanded. */ | |
33 | }; | |
34 | ||
064af421 BP |
35 | /* Buffer for holding arbitrary data. An ofpbuf is automatically reallocated |
36 | * as necessary if it grows too large for the available memory. */ | |
37 | struct ofpbuf { | |
31ac1e59 | 38 | void *base; /* First byte of allocated space. */ |
064af421 | 39 | size_t allocated; /* Number of bytes allocated. */ |
31ac1e59 | 40 | enum ofpbuf_source source; /* Source of memory allocated as 'base'. */ |
064af421 BP |
41 | |
42 | void *data; /* First byte actually in use. */ | |
43 | size_t size; /* Number of bytes in use. */ | |
44 | ||
45 | void *l2; /* Link-level header. */ | |
46 | void *l3; /* Network-level header. */ | |
47 | void *l4; /* Transport-level header. */ | |
48 | void *l7; /* Application data. */ | |
49 | ||
b3907fbc | 50 | struct list list_node; /* Private list element for use by owner. */ |
d45e9c65 | 51 | void *private_p; /* Private pointer for use by owner. */ |
064af421 BP |
52 | }; |
53 | ||
31ac1e59 BP |
54 | /* Declares NAME as a SIZE-byte array aligned properly for storing any kind of |
55 | * data. For use with ofpbuf_use_stack(). */ | |
56 | #define OFPBUF_STACK_BUFFER(NAME, SIZE) uint64_t NAME[DIV_ROUND_UP(SIZE, 8)] | |
57 | ||
064af421 | 58 | void ofpbuf_use(struct ofpbuf *, void *, size_t); |
31ac1e59 | 59 | void ofpbuf_use_stack(struct ofpbuf *, void *, size_t); |
0bc9407d | 60 | void ofpbuf_use_const(struct ofpbuf *, const void *, size_t); |
064af421 BP |
61 | |
62 | void ofpbuf_init(struct ofpbuf *, size_t); | |
63 | void ofpbuf_uninit(struct ofpbuf *); | |
64 | void ofpbuf_reinit(struct ofpbuf *, size_t); | |
65 | ||
66 | struct ofpbuf *ofpbuf_new(size_t); | |
68efcbec | 67 | struct ofpbuf *ofpbuf_new_with_headroom(size_t, size_t headroom); |
064af421 | 68 | struct ofpbuf *ofpbuf_clone(const struct ofpbuf *); |
68efcbec BP |
69 | struct ofpbuf *ofpbuf_clone_with_headroom(const struct ofpbuf *, |
70 | size_t headroom); | |
064af421 | 71 | struct ofpbuf *ofpbuf_clone_data(const void *, size_t); |
a46c577a BP |
72 | struct ofpbuf *ofpbuf_clone_data_with_headroom(const void *, size_t, |
73 | size_t headroom); | |
064af421 BP |
74 | void ofpbuf_delete(struct ofpbuf *); |
75 | ||
76 | void *ofpbuf_at(const struct ofpbuf *, size_t offset, size_t size); | |
77 | void *ofpbuf_at_assert(const struct ofpbuf *, size_t offset, size_t size); | |
78 | void *ofpbuf_tail(const struct ofpbuf *); | |
79 | void *ofpbuf_end(const struct ofpbuf *); | |
80 | ||
81 | void *ofpbuf_put_uninit(struct ofpbuf *, size_t); | |
82 | void *ofpbuf_put_zeros(struct ofpbuf *, size_t); | |
83 | void *ofpbuf_put(struct ofpbuf *, const void *, size_t); | |
78090f63 | 84 | char *ofpbuf_put_hex(struct ofpbuf *, const char *s, size_t *n); |
064af421 BP |
85 | void ofpbuf_reserve(struct ofpbuf *, size_t); |
86 | void *ofpbuf_push_uninit(struct ofpbuf *b, size_t); | |
30f07f1a | 87 | void *ofpbuf_push_zeros(struct ofpbuf *, size_t); |
064af421 BP |
88 | void *ofpbuf_push(struct ofpbuf *b, const void *, size_t); |
89 | ||
5019f688 BP |
90 | size_t ofpbuf_headroom(const struct ofpbuf *); |
91 | size_t ofpbuf_tailroom(const struct ofpbuf *); | |
064af421 BP |
92 | void ofpbuf_prealloc_headroom(struct ofpbuf *, size_t); |
93 | void ofpbuf_prealloc_tailroom(struct ofpbuf *, size_t); | |
94 | void ofpbuf_trim(struct ofpbuf *); | |
95 | ||
96 | void ofpbuf_clear(struct ofpbuf *); | |
97 | void *ofpbuf_pull(struct ofpbuf *, size_t); | |
98 | void *ofpbuf_try_pull(struct ofpbuf *, size_t); | |
99 | ||
0ab8e15f BP |
100 | char *ofpbuf_to_string(const struct ofpbuf *, size_t maxbytes); |
101 | ||
b3907fbc BP |
102 | static inline struct ofpbuf *ofpbuf_from_list(const struct list *list) |
103 | { | |
104 | return CONTAINER_OF(list, struct ofpbuf, list_node); | |
105 | } | |
106 | void ofpbuf_list_delete(struct list *); | |
107 | ||
d45e9c65 BP |
108 | #ifdef __cplusplus |
109 | } | |
110 | #endif | |
111 | ||
064af421 | 112 | #endif /* ofpbuf.h */ |