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. */
43 struct rte_mbuf mbuf; /* DPDK mbuf */
44 void *private_p; /* private pointer for use by dpdk */
46 void *base; /* First byte of allocated space. */
47 void *data; /* First byte actually in use. */
48 uint32_t size; /* Number of bytes in use. */
50 uint32_t allocated; /* Number of bytes allocated. */
52 void *l2; /* Link-level header. */
53 uint16_t l2_5_ofs; /* MPLS label stack offset from l2, or
55 uint16_t l3_ofs; /* Network-level header offset from l2, or
57 uint16_t l4_ofs; /* Transport-level header offset from l2, or
59 enum ofpbuf_source source; /* Source of memory allocated as 'base'. */
60 struct list list_node; /* Private list element for use by owner. */
63 static inline void * ofpbuf_data(const struct ofpbuf *);
64 static inline void ofpbuf_set_data(struct ofpbuf *, void *);
65 static inline void * ofpbuf_base(const struct ofpbuf *);
66 static inline void ofpbuf_set_base(struct ofpbuf *, void *);
68 static inline uint32_t ofpbuf_size(const struct ofpbuf *);
69 static inline void ofpbuf_set_size(struct ofpbuf *, uint32_t);
71 void * ofpbuf_resize_l2(struct ofpbuf *, int increment);
72 void * ofpbuf_resize_l2_5(struct ofpbuf *, int increment);
73 static inline void * ofpbuf_get_l2_5(const struct ofpbuf *);
74 static inline void ofpbuf_set_l2_5(struct ofpbuf *, void *);
75 static inline void * ofpbuf_get_l3(const struct ofpbuf *);
76 static inline void ofpbuf_set_l3(struct ofpbuf *, void *);
77 static inline void * ofpbuf_get_l4(const struct ofpbuf *);
78 static inline void ofpbuf_set_l4(struct ofpbuf *, void *);
79 static inline size_t ofpbuf_get_l4_size(const struct ofpbuf *);
80 static inline const void *ofpbuf_get_tcp_payload(const struct ofpbuf *);
81 static inline const void *ofpbuf_get_udp_payload(const struct ofpbuf *);
82 static inline const void *ofpbuf_get_sctp_payload(const struct ofpbuf *);
83 static inline const void *ofpbuf_get_icmp_payload(const struct ofpbuf *);
85 void ofpbuf_use(struct ofpbuf *, void *, size_t);
86 void ofpbuf_use_stack(struct ofpbuf *, void *, size_t);
87 void ofpbuf_use_stub(struct ofpbuf *, void *, size_t);
88 void ofpbuf_use_const(struct ofpbuf *, const void *, size_t);
90 void ofpbuf_init_dpdk(struct ofpbuf *b, size_t allocated);
92 void ofpbuf_init(struct ofpbuf *, size_t);
93 void ofpbuf_uninit(struct ofpbuf *);
94 static inline void *ofpbuf_get_uninit_pointer(struct ofpbuf *);
95 void ofpbuf_reinit(struct ofpbuf *, size_t);
97 struct ofpbuf *ofpbuf_new(size_t);
98 struct ofpbuf *ofpbuf_new_with_headroom(size_t, size_t headroom);
99 struct ofpbuf *ofpbuf_clone(const struct ofpbuf *);
100 struct ofpbuf *ofpbuf_clone_with_headroom(const struct ofpbuf *,
102 struct ofpbuf *ofpbuf_clone_data(const void *, size_t);
103 struct ofpbuf *ofpbuf_clone_data_with_headroom(const void *, size_t,
105 static inline void ofpbuf_delete(struct ofpbuf *);
107 static inline void *ofpbuf_at(const struct ofpbuf *, size_t offset,
109 static inline void *ofpbuf_at_assert(const struct ofpbuf *, size_t offset,
111 static inline void *ofpbuf_tail(const struct ofpbuf *);
112 static inline void *ofpbuf_end(const struct ofpbuf *);
114 void *ofpbuf_put_uninit(struct ofpbuf *, size_t);
115 void *ofpbuf_put_zeros(struct ofpbuf *, size_t);
116 void *ofpbuf_put(struct ofpbuf *, const void *, size_t);
117 char *ofpbuf_put_hex(struct ofpbuf *, const char *s, size_t *n);
118 void ofpbuf_reserve(struct ofpbuf *, size_t);
119 void ofpbuf_reserve_with_tailroom(struct ofpbuf *b, size_t headroom,
121 void *ofpbuf_push_uninit(struct ofpbuf *b, size_t);
122 void *ofpbuf_push_zeros(struct ofpbuf *, size_t);
123 void *ofpbuf_push(struct ofpbuf *b, const void *, size_t);
125 static inline size_t ofpbuf_headroom(const struct ofpbuf *);
126 static inline size_t ofpbuf_tailroom(const struct ofpbuf *);
127 void ofpbuf_prealloc_headroom(struct ofpbuf *, size_t);
128 void ofpbuf_prealloc_tailroom(struct ofpbuf *, size_t);
129 void ofpbuf_trim(struct ofpbuf *);
130 void ofpbuf_padto(struct ofpbuf *, size_t);
131 void ofpbuf_shift(struct ofpbuf *, int);
133 static inline void ofpbuf_clear(struct ofpbuf *);
134 static inline void *ofpbuf_pull(struct ofpbuf *, size_t);
135 static inline void *ofpbuf_try_pull(struct ofpbuf *, size_t);
137 void *ofpbuf_steal_data(struct ofpbuf *);
139 char *ofpbuf_to_string(const struct ofpbuf *, size_t maxbytes);
140 static inline struct ofpbuf *ofpbuf_from_list(const struct list *);
141 void ofpbuf_list_delete(struct list *);
142 static inline bool ofpbuf_equal(const struct ofpbuf *, const struct ofpbuf *);
145 /* Returns a pointer that may be passed to free() to accomplish the same thing
146 * as ofpbuf_uninit(b). The return value is a null pointer if ofpbuf_uninit()
147 * would not free any memory. */
148 static inline void *ofpbuf_get_uninit_pointer(struct ofpbuf *b)
150 /* XXX: If 'source' is OFPBUF_DPDK memory gets leaked! */
151 return b && b->source == OFPBUF_MALLOC ? ofpbuf_base(b) : NULL;
154 /* Frees memory that 'b' points to, as well as 'b' itself. */
155 static inline void ofpbuf_delete(struct ofpbuf *b)
163 /* If 'b' contains at least 'offset + size' bytes of data, returns a pointer to
164 * byte 'offset'. Otherwise, returns a null pointer. */
165 static inline void *ofpbuf_at(const struct ofpbuf *b, size_t offset,
168 return offset + size <= ofpbuf_size(b) ? (char *) ofpbuf_data(b) + offset : NULL;
171 /* Returns a pointer to byte 'offset' in 'b', which must contain at least
172 * 'offset + size' bytes of data. */
173 static inline void *ofpbuf_at_assert(const struct ofpbuf *b, size_t offset,
176 ovs_assert(offset + size <= ofpbuf_size(b));
177 return ((char *) ofpbuf_data(b)) + offset;
180 /* Returns the byte following the last byte of data in use in 'b'. */
181 static inline void *ofpbuf_tail(const struct ofpbuf *b)
183 return (char *) ofpbuf_data(b) + ofpbuf_size(b);
186 /* Returns the byte following the last byte allocated for use (but not
187 * necessarily in use) by 'b'. */
188 static inline void *ofpbuf_end(const struct ofpbuf *b)
190 return (char *) ofpbuf_base(b) + b->allocated;
193 /* Returns the number of bytes of headroom in 'b', that is, the number of bytes
194 * of unused space in ofpbuf 'b' before the data that is in use. (Most
195 * commonly, the data in a ofpbuf is at its beginning, and thus the ofpbuf's
197 static inline size_t ofpbuf_headroom(const struct ofpbuf *b)
199 return (char*)ofpbuf_data(b) - (char*)ofpbuf_base(b);
202 /* Returns the number of bytes that may be appended to the tail end of ofpbuf
203 * 'b' before the ofpbuf must be reallocated. */
204 static inline size_t ofpbuf_tailroom(const struct ofpbuf *b)
206 return (char*)ofpbuf_end(b) - (char*)ofpbuf_tail(b);
209 /* Clears any data from 'b'. */
210 static inline void ofpbuf_clear(struct ofpbuf *b)
212 ofpbuf_set_data(b, ofpbuf_base(b));
213 ofpbuf_set_size(b, 0);
216 /* Removes 'size' bytes from the head end of 'b', which must contain at least
217 * 'size' bytes of data. Returns the first byte of data removed. */
218 static inline void *ofpbuf_pull(struct ofpbuf *b, size_t size)
220 void *data = ofpbuf_data(b);
221 ovs_assert(ofpbuf_size(b) >= size);
222 ofpbuf_set_data(b, (char*)ofpbuf_data(b) + size);
223 ofpbuf_set_size(b, ofpbuf_size(b) - size);
227 /* If 'b' has at least 'size' bytes of data, removes that many bytes from the
228 * head end of 'b' and returns the first byte removed. Otherwise, returns a
229 * null pointer without modifying 'b'. */
230 static inline void *ofpbuf_try_pull(struct ofpbuf *b, size_t size)
232 return ofpbuf_size(b) >= size ? ofpbuf_pull(b, size) : NULL;
235 static inline struct ofpbuf *ofpbuf_from_list(const struct list *list)
237 return CONTAINER_OF(list, struct ofpbuf, list_node);
240 static inline bool ofpbuf_equal(const struct ofpbuf *a, const struct ofpbuf *b)
242 return ofpbuf_size(a) == ofpbuf_size(b) &&
243 memcmp(ofpbuf_data(a), ofpbuf_data(b), ofpbuf_size(a)) == 0;
246 static inline void * ofpbuf_get_l2_5(const struct ofpbuf *b)
248 return b->l2_5_ofs != UINT16_MAX ? (char *)b->l2 + b->l2_5_ofs : NULL;
251 static inline void ofpbuf_set_l2_5(struct ofpbuf *b, void *l2_5)
253 b->l2_5_ofs = l2_5 ? (char *)l2_5 - (char *)b->l2 : UINT16_MAX;
256 static inline void * ofpbuf_get_l3(const struct ofpbuf *b)
258 return b->l3_ofs != UINT16_MAX ? (char *)b->l2 + b->l3_ofs : NULL;
261 static inline void ofpbuf_set_l3(struct ofpbuf *b, void *l3)
263 b->l3_ofs = l3 ? (char *)l3 - (char *)b->l2 : UINT16_MAX;
266 static inline void * ofpbuf_get_l4(const struct ofpbuf *b)
268 return b->l4_ofs != UINT16_MAX ? (char *)b->l2 + b->l4_ofs : NULL;
271 static inline void ofpbuf_set_l4(struct ofpbuf *b, void *l4)
273 b->l4_ofs = l4 ? (char *)l4 - (char *)b->l2 : UINT16_MAX;
276 static inline size_t ofpbuf_get_l4_size(const struct ofpbuf *b)
278 return b->l4_ofs != UINT16_MAX
279 ? (const char *)ofpbuf_tail(b) - (const char *)ofpbuf_get_l4(b) : 0;
282 static inline const void *ofpbuf_get_tcp_payload(const struct ofpbuf *b)
284 size_t l4_size = ofpbuf_get_l4_size(b);
286 if (OVS_LIKELY(l4_size >= TCP_HEADER_LEN)) {
287 struct tcp_header *tcp = ofpbuf_get_l4(b);
288 int tcp_len = TCP_OFFSET(tcp->tcp_ctl) * 4;
290 if (OVS_LIKELY(tcp_len >= TCP_HEADER_LEN && tcp_len <= l4_size)) {
291 return (const char *)tcp + tcp_len;
297 static inline const void *ofpbuf_get_udp_payload(const struct ofpbuf *b)
299 return OVS_LIKELY(ofpbuf_get_l4_size(b) >= UDP_HEADER_LEN)
300 ? (const char *)ofpbuf_get_l4(b) + UDP_HEADER_LEN : NULL;
303 static inline const void *ofpbuf_get_sctp_payload(const struct ofpbuf *b)
305 return OVS_LIKELY(ofpbuf_get_l4_size(b) >= SCTP_HEADER_LEN)
306 ? (const char *)ofpbuf_get_l4(b) + SCTP_HEADER_LEN : NULL;
309 static inline const void *ofpbuf_get_icmp_payload(const struct ofpbuf *b)
311 return OVS_LIKELY(ofpbuf_get_l4_size(b) >= ICMP_HEADER_LEN)
312 ? (const char *)ofpbuf_get_l4(b) + ICMP_HEADER_LEN : NULL;
316 static inline void * ofpbuf_data(const struct ofpbuf *b)
318 return b->mbuf.pkt.data;
321 static inline void ofpbuf_set_data(struct ofpbuf *b, void *d)
323 b->mbuf.pkt.data = d;
326 static inline void * ofpbuf_base(const struct ofpbuf *b)
328 return b->mbuf.buf_addr;
331 static inline void ofpbuf_set_base(struct ofpbuf *b, void *d)
333 b->mbuf.buf_addr = d;
336 static inline uint32_t ofpbuf_size(const struct ofpbuf *b)
338 return b->mbuf.pkt.pkt_len;
341 static inline void ofpbuf_set_size(struct ofpbuf *b, uint32_t v)
343 b->mbuf.pkt.data_len = v; /* Current seg length. */
344 b->mbuf.pkt.pkt_len = v; /* Total length of all segments linked to
349 static inline void * ofpbuf_data(const struct ofpbuf *b)
354 static inline void ofpbuf_set_data(struct ofpbuf *b, void *d)
359 static inline void * ofpbuf_base(const struct ofpbuf *b)
364 static inline void ofpbuf_set_base(struct ofpbuf *b, void *d)
369 static inline uint32_t ofpbuf_size(const struct ofpbuf *b)
374 static inline void ofpbuf_set_size(struct ofpbuf *b, uint32_t v)
384 #endif /* ofpbuf.h */