2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
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.
25 #include "netdev-dpdk.h"
31 enum OVS_PACKED_ENUM ofpbuf_source {
32 OFPBUF_MALLOC, /* Obtained via malloc(). */
33 OFPBUF_STACK, /* Un-movable stack space or static buffer. */
34 OFPBUF_STUB, /* Starts on stack, may expand into heap. */
35 OFPBUF_DPDK, /* buffer data is from DPDK allocated memory.
36 ref to build_ofpbuf() in netdev-dpdk. */
39 /* Buffer for holding arbitrary data. An ofpbuf is automatically reallocated
40 * as necessary if it grows too large for the available memory. */
42 void *base; /* First byte of allocated space. */
43 uint32_t allocated; /* Number of bytes allocated. */
44 uint32_t size; /* Number of bytes in use. */
45 void *data; /* First byte actually in use. */
47 void *l2; /* Link-level header. */
48 uint16_t l2_5_ofs; /* MPLS label stack offset from l2, or
50 uint16_t l3_ofs; /* Network-level header offset from l2, or
52 uint16_t l4_ofs; /* Transport-level header offset from l2, or
54 enum ofpbuf_source source; /* Source of memory allocated as 'base'. */
55 struct list list_node; /* Private list element for use by owner. */
57 void *private_p; /* private pointer for use by dpdk */
61 static inline void * ofpbuf_data(const struct ofpbuf *);
62 static inline void ofpbuf_set_data(struct ofpbuf *, void *);
63 static inline void * ofpbuf_base(const struct ofpbuf *);
64 static inline void ofpbuf_set_base(struct ofpbuf *, void *);
66 static inline uint32_t ofpbuf_size(const struct ofpbuf *);
67 static inline void ofpbuf_set_size(struct ofpbuf *, uint32_t);
69 void * ofpbuf_resize_l2(struct ofpbuf *, int increment);
70 void * ofpbuf_resize_l2_5(struct ofpbuf *, int increment);
71 static inline void * ofpbuf_get_l2_5(const struct ofpbuf *);
72 static inline void ofpbuf_set_l2_5(struct ofpbuf *, void *);
73 static inline void * ofpbuf_get_l3(const struct ofpbuf *);
74 static inline void ofpbuf_set_l3(struct ofpbuf *, void *);
75 static inline void * ofpbuf_get_l4(const struct ofpbuf *);
76 static inline void ofpbuf_set_l4(struct ofpbuf *, void *);
77 static inline size_t ofpbuf_get_l4_size(const struct ofpbuf *);
78 static inline const void *ofpbuf_get_tcp_payload(const struct ofpbuf *);
79 static inline const void *ofpbuf_get_udp_payload(const struct ofpbuf *);
80 static inline const void *ofpbuf_get_sctp_payload(const struct ofpbuf *);
81 static inline const void *ofpbuf_get_icmp_payload(const struct ofpbuf *);
83 void ofpbuf_use(struct ofpbuf *, void *, size_t);
84 void ofpbuf_use_stack(struct ofpbuf *, void *, size_t);
85 void ofpbuf_use_stub(struct ofpbuf *, void *, size_t);
86 void ofpbuf_use_const(struct ofpbuf *, const void *, size_t);
88 void ofpbuf_init(struct ofpbuf *, size_t);
89 void ofpbuf_uninit(struct ofpbuf *);
90 static inline void *ofpbuf_get_uninit_pointer(struct ofpbuf *);
91 void ofpbuf_reinit(struct ofpbuf *, size_t);
93 struct ofpbuf *ofpbuf_new(size_t);
94 struct ofpbuf *ofpbuf_new_with_headroom(size_t, size_t headroom);
95 struct ofpbuf *ofpbuf_clone(const struct ofpbuf *);
96 struct ofpbuf *ofpbuf_clone_with_headroom(const struct ofpbuf *,
98 struct ofpbuf *ofpbuf_clone_data(const void *, size_t);
99 struct ofpbuf *ofpbuf_clone_data_with_headroom(const void *, size_t,
101 static inline void ofpbuf_delete(struct ofpbuf *);
103 static inline void *ofpbuf_at(const struct ofpbuf *, size_t offset,
105 static inline void *ofpbuf_at_assert(const struct ofpbuf *, size_t offset,
107 static inline void *ofpbuf_tail(const struct ofpbuf *);
108 static inline void *ofpbuf_end(const struct ofpbuf *);
110 void *ofpbuf_put_uninit(struct ofpbuf *, size_t);
111 void *ofpbuf_put_zeros(struct ofpbuf *, size_t);
112 void *ofpbuf_put(struct ofpbuf *, const void *, size_t);
113 char *ofpbuf_put_hex(struct ofpbuf *, const char *s, size_t *n);
114 void ofpbuf_reserve(struct ofpbuf *, size_t);
115 void ofpbuf_reserve_with_tailroom(struct ofpbuf *b, size_t headroom,
117 void *ofpbuf_push_uninit(struct ofpbuf *b, size_t);
118 void *ofpbuf_push_zeros(struct ofpbuf *, size_t);
119 void *ofpbuf_push(struct ofpbuf *b, const void *, size_t);
121 static inline size_t ofpbuf_headroom(const struct ofpbuf *);
122 static inline size_t ofpbuf_tailroom(const struct ofpbuf *);
123 void ofpbuf_prealloc_headroom(struct ofpbuf *, size_t);
124 void ofpbuf_prealloc_tailroom(struct ofpbuf *, size_t);
125 void ofpbuf_trim(struct ofpbuf *);
126 void ofpbuf_padto(struct ofpbuf *, size_t);
127 void ofpbuf_shift(struct ofpbuf *, int);
129 static inline void ofpbuf_clear(struct ofpbuf *);
130 static inline void *ofpbuf_pull(struct ofpbuf *, size_t);
131 static inline void *ofpbuf_try_pull(struct ofpbuf *, size_t);
133 void *ofpbuf_steal_data(struct ofpbuf *);
135 char *ofpbuf_to_string(const struct ofpbuf *, size_t maxbytes);
136 static inline struct ofpbuf *ofpbuf_from_list(const struct list *);
137 void ofpbuf_list_delete(struct list *);
138 static inline bool ofpbuf_equal(const struct ofpbuf *, const struct ofpbuf *);
141 /* Returns a pointer that may be passed to free() to accomplish the same thing
142 * as ofpbuf_uninit(b). The return value is a null pointer if ofpbuf_uninit()
143 * would not free any memory. */
144 static inline void *ofpbuf_get_uninit_pointer(struct ofpbuf *b)
146 /* XXX: If 'source' is OFPBUF_DPDK memory gets leaked! */
147 return b && b->source == OFPBUF_MALLOC ? ofpbuf_base(b) : NULL;
150 /* Frees memory that 'b' points to, as well as 'b' itself. */
151 static inline void ofpbuf_delete(struct ofpbuf *b)
159 /* If 'b' contains at least 'offset + size' bytes of data, returns a pointer to
160 * byte 'offset'. Otherwise, returns a null pointer. */
161 static inline void *ofpbuf_at(const struct ofpbuf *b, size_t offset,
164 return offset + size <= ofpbuf_size(b) ? (char *) ofpbuf_data(b) + offset : NULL;
167 /* Returns a pointer to byte 'offset' in 'b', which must contain at least
168 * 'offset + size' bytes of data. */
169 static inline void *ofpbuf_at_assert(const struct ofpbuf *b, size_t offset,
172 ovs_assert(offset + size <= ofpbuf_size(b));
173 return ((char *) ofpbuf_data(b)) + offset;
176 /* Returns the byte following the last byte of data in use in 'b'. */
177 static inline void *ofpbuf_tail(const struct ofpbuf *b)
179 return (char *) ofpbuf_data(b) + ofpbuf_size(b);
182 /* Returns the byte following the last byte allocated for use (but not
183 * necessarily in use) by 'b'. */
184 static inline void *ofpbuf_end(const struct ofpbuf *b)
186 return (char *) ofpbuf_base(b) + b->allocated;
189 /* Returns the number of bytes of headroom in 'b', that is, the number of bytes
190 * of unused space in ofpbuf 'b' before the data that is in use. (Most
191 * commonly, the data in a ofpbuf is at its beginning, and thus the ofpbuf's
193 static inline size_t ofpbuf_headroom(const struct ofpbuf *b)
195 return (char*)ofpbuf_data(b) - (char*)ofpbuf_base(b);
198 /* Returns the number of bytes that may be appended to the tail end of ofpbuf
199 * 'b' before the ofpbuf must be reallocated. */
200 static inline size_t ofpbuf_tailroom(const struct ofpbuf *b)
202 return (char*)ofpbuf_end(b) - (char*)ofpbuf_tail(b);
205 /* Clears any data from 'b'. */
206 static inline void ofpbuf_clear(struct ofpbuf *b)
208 ofpbuf_set_data(b, ofpbuf_base(b));
209 ofpbuf_set_size(b, 0);
212 /* Removes 'size' bytes from the head end of 'b', which must contain at least
213 * 'size' bytes of data. Returns the first byte of data removed. */
214 static inline void *ofpbuf_pull(struct ofpbuf *b, size_t size)
216 void *data = ofpbuf_data(b);
217 ovs_assert(ofpbuf_size(b) >= size);
218 ofpbuf_set_data(b, (char*)ofpbuf_data(b) + size);
219 ofpbuf_set_size(b, ofpbuf_size(b) - size);
223 /* If 'b' has at least 'size' bytes of data, removes that many bytes from the
224 * head end of 'b' and returns the first byte removed. Otherwise, returns a
225 * null pointer without modifying 'b'. */
226 static inline void *ofpbuf_try_pull(struct ofpbuf *b, size_t size)
228 return ofpbuf_size(b) >= size ? ofpbuf_pull(b, size) : NULL;
231 static inline struct ofpbuf *ofpbuf_from_list(const struct list *list)
233 return CONTAINER_OF(list, struct ofpbuf, list_node);
236 static inline bool ofpbuf_equal(const struct ofpbuf *a, const struct ofpbuf *b)
238 return ofpbuf_size(a) == ofpbuf_size(b) &&
239 memcmp(ofpbuf_data(a), ofpbuf_data(b), ofpbuf_size(a)) == 0;
242 static inline void * ofpbuf_get_l2_5(const struct ofpbuf *b)
244 return b->l2_5_ofs != UINT16_MAX ? (char *)b->l2 + b->l2_5_ofs : NULL;
247 static inline void ofpbuf_set_l2_5(struct ofpbuf *b, void *l2_5)
249 b->l2_5_ofs = l2_5 ? (char *)l2_5 - (char *)b->l2 : UINT16_MAX;
252 static inline void * ofpbuf_get_l3(const struct ofpbuf *b)
254 return b->l3_ofs != UINT16_MAX ? (char *)b->l2 + b->l3_ofs : NULL;
257 static inline void ofpbuf_set_l3(struct ofpbuf *b, void *l3)
259 b->l3_ofs = l3 ? (char *)l3 - (char *)b->l2 : UINT16_MAX;
262 static inline void * ofpbuf_get_l4(const struct ofpbuf *b)
264 return b->l4_ofs != UINT16_MAX ? (char *)b->l2 + b->l4_ofs : NULL;
267 static inline void ofpbuf_set_l4(struct ofpbuf *b, void *l4)
269 b->l4_ofs = l4 ? (char *)l4 - (char *)b->l2 : UINT16_MAX;
272 static inline size_t ofpbuf_get_l4_size(const struct ofpbuf *b)
274 return b->l4_ofs != UINT16_MAX
275 ? (const char *)ofpbuf_tail(b) - (const char *)ofpbuf_get_l4(b) : 0;
278 static inline const void *ofpbuf_get_tcp_payload(const struct ofpbuf *b)
280 size_t l4_size = ofpbuf_get_l4_size(b);
282 if (OVS_LIKELY(l4_size >= TCP_HEADER_LEN)) {
283 struct tcp_header *tcp = ofpbuf_get_l4(b);
284 int tcp_len = TCP_OFFSET(tcp->tcp_ctl) * 4;
286 if (OVS_LIKELY(tcp_len >= TCP_HEADER_LEN && tcp_len <= l4_size)) {
287 return (const char *)tcp + tcp_len;
293 static inline const void *ofpbuf_get_udp_payload(const struct ofpbuf *b)
295 return OVS_LIKELY(ofpbuf_get_l4_size(b) >= UDP_HEADER_LEN)
296 ? (const char *)ofpbuf_get_l4(b) + UDP_HEADER_LEN : NULL;
299 static inline const void *ofpbuf_get_sctp_payload(const struct ofpbuf *b)
301 return OVS_LIKELY(ofpbuf_get_l4_size(b) >= SCTP_HEADER_LEN)
302 ? (const char *)ofpbuf_get_l4(b) + SCTP_HEADER_LEN : NULL;
305 static inline const void *ofpbuf_get_icmp_payload(const struct ofpbuf *b)
307 return OVS_LIKELY(ofpbuf_get_l4_size(b) >= ICMP_HEADER_LEN)
308 ? (const char *)ofpbuf_get_l4(b) + ICMP_HEADER_LEN : NULL;
311 static inline void * ofpbuf_data(const struct ofpbuf *b)
316 static inline void ofpbuf_set_data(struct ofpbuf *b, void *d)
321 static inline void * ofpbuf_base(const struct ofpbuf *b)
326 static inline void ofpbuf_set_base(struct ofpbuf *b, void *d)
331 static inline uint32_t ofpbuf_size(const struct ofpbuf *b)
336 static inline void ofpbuf_set_size(struct ofpbuf *b, uint32_t v)
345 #endif /* ofpbuf.h */