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 * 'frame' and offset conventions:
44 * Network frames (aka "packets"): 'frame' MUST be set to the start of the
45 * packet, layer offsets MAY be set as appropriate for the packet.
46 * Additionally, we assume in many places that the 'frame' and 'data' are
47 * the same for packets.
49 * OpenFlow messages: 'frame' points to the start of the OpenFlow
50 * header, while 'l3_ofs' is the length of the OpenFlow header.
51 * When parsing, the 'data' will move past these, as data is being
52 * pulled from the OpenFlow message.
54 * Actions: When encoding OVS action lists, the 'frame' is used
55 * as a pointer to the beginning of the current action (see ofpact_put()).
57 * rconn: Reuses 'frame' as a private pointer while queuing.
61 struct rte_mbuf mbuf; /* DPDK mbuf */
63 void *base_; /* First byte of allocated space. */
64 void *data_; /* First byte actually in use. */
65 uint32_t size_; /* Number of bytes in use. */
67 uint32_t allocated; /* Number of bytes allocated. */
69 void *frame; /* Packet frame start, or NULL. */
70 uint16_t l2_5_ofs; /* MPLS label stack offset from 'frame', or
72 uint16_t l3_ofs; /* Network-level header offset from 'frame',
74 uint16_t l4_ofs; /* Transport-level header offset from 'frame',
76 enum ofpbuf_source source; /* Source of memory allocated as 'base'. */
77 struct list list_node; /* Private list element for use by owner. */
80 static inline void * ofpbuf_data(const struct ofpbuf *);
81 static inline void ofpbuf_set_data(struct ofpbuf *, void *);
82 static inline void * ofpbuf_base(const struct ofpbuf *);
83 static inline void ofpbuf_set_base(struct ofpbuf *, void *);
85 static inline uint32_t ofpbuf_size(const struct ofpbuf *);
86 static inline void ofpbuf_set_size(struct ofpbuf *, uint32_t);
88 void * ofpbuf_resize_l2(struct ofpbuf *, int increment);
89 void * ofpbuf_resize_l2_5(struct ofpbuf *, int increment);
90 static inline void * ofpbuf_l2(const struct ofpbuf *);
91 static inline void ofpbuf_set_frame(struct ofpbuf *, void *);
92 static inline void * ofpbuf_l2_5(const struct ofpbuf *);
93 static inline void ofpbuf_set_l2_5(struct ofpbuf *, void *);
94 static inline void * ofpbuf_l3(const struct ofpbuf *);
95 static inline void ofpbuf_set_l3(struct ofpbuf *, void *);
96 static inline void * ofpbuf_l4(const struct ofpbuf *);
97 static inline void ofpbuf_set_l4(struct ofpbuf *, void *);
98 static inline size_t ofpbuf_l4_size(const struct ofpbuf *);
99 static inline const void *ofpbuf_get_tcp_payload(const struct ofpbuf *);
100 static inline const void *ofpbuf_get_udp_payload(const struct ofpbuf *);
101 static inline const void *ofpbuf_get_sctp_payload(const struct ofpbuf *);
102 static inline const void *ofpbuf_get_icmp_payload(const struct ofpbuf *);
104 void ofpbuf_use(struct ofpbuf *, void *, size_t);
105 void ofpbuf_use_stack(struct ofpbuf *, void *, size_t);
106 void ofpbuf_use_stub(struct ofpbuf *, void *, size_t);
107 void ofpbuf_use_const(struct ofpbuf *, const void *, size_t);
109 void ofpbuf_init_dpdk(struct ofpbuf *b, size_t allocated);
111 void ofpbuf_init(struct ofpbuf *, size_t);
112 void ofpbuf_uninit(struct ofpbuf *);
113 static inline void *ofpbuf_get_uninit_pointer(struct ofpbuf *);
114 void ofpbuf_reinit(struct ofpbuf *, size_t);
116 struct ofpbuf *ofpbuf_new(size_t);
117 struct ofpbuf *ofpbuf_new_with_headroom(size_t, size_t headroom);
118 struct ofpbuf *ofpbuf_clone(const struct ofpbuf *);
119 struct ofpbuf *ofpbuf_clone_with_headroom(const struct ofpbuf *,
121 struct ofpbuf *ofpbuf_clone_data(const void *, size_t);
122 struct ofpbuf *ofpbuf_clone_data_with_headroom(const void *, size_t,
124 static inline void ofpbuf_delete(struct ofpbuf *);
126 static inline void *ofpbuf_at(const struct ofpbuf *, size_t offset,
128 static inline void *ofpbuf_at_assert(const struct ofpbuf *, size_t offset,
130 static inline void *ofpbuf_tail(const struct ofpbuf *);
131 static inline void *ofpbuf_end(const struct ofpbuf *);
133 void *ofpbuf_put_uninit(struct ofpbuf *, size_t);
134 void *ofpbuf_put_zeros(struct ofpbuf *, size_t);
135 void *ofpbuf_put(struct ofpbuf *, const void *, size_t);
136 char *ofpbuf_put_hex(struct ofpbuf *, const char *s, size_t *n);
137 void ofpbuf_reserve(struct ofpbuf *, size_t);
138 void ofpbuf_reserve_with_tailroom(struct ofpbuf *b, size_t headroom,
140 void *ofpbuf_push_uninit(struct ofpbuf *b, size_t);
141 void *ofpbuf_push_zeros(struct ofpbuf *, size_t);
142 void *ofpbuf_push(struct ofpbuf *b, const void *, size_t);
144 static inline size_t ofpbuf_headroom(const struct ofpbuf *);
145 static inline size_t ofpbuf_tailroom(const struct ofpbuf *);
146 void ofpbuf_prealloc_headroom(struct ofpbuf *, size_t);
147 void ofpbuf_prealloc_tailroom(struct ofpbuf *, size_t);
148 void ofpbuf_trim(struct ofpbuf *);
149 void ofpbuf_padto(struct ofpbuf *, size_t);
150 void ofpbuf_shift(struct ofpbuf *, int);
152 static inline void ofpbuf_clear(struct ofpbuf *);
153 static inline void *ofpbuf_pull(struct ofpbuf *, size_t);
154 static inline void *ofpbuf_try_pull(struct ofpbuf *, size_t);
156 void *ofpbuf_steal_data(struct ofpbuf *);
158 char *ofpbuf_to_string(const struct ofpbuf *, size_t maxbytes);
159 static inline struct ofpbuf *ofpbuf_from_list(const struct list *);
160 void ofpbuf_list_delete(struct list *);
161 static inline bool ofpbuf_equal(const struct ofpbuf *, const struct ofpbuf *);
164 /* Returns a pointer that may be passed to free() to accomplish the same thing
165 * as ofpbuf_uninit(b). The return value is a null pointer if ofpbuf_uninit()
166 * would not free any memory. */
167 static inline void *ofpbuf_get_uninit_pointer(struct ofpbuf *b)
169 /* XXX: If 'source' is OFPBUF_DPDK memory gets leaked! */
170 return b && b->source == OFPBUF_MALLOC ? ofpbuf_base(b) : NULL;
173 /* Frees memory that 'b' points to, as well as 'b' itself. */
174 static inline void ofpbuf_delete(struct ofpbuf *b)
177 if (b->source == OFPBUF_DPDK) {
178 /* If this ofpbuf was allocated by DPDK it must have been
179 * created as a dpif_packet */
180 free_dpdk_buf((struct dpif_packet*) b);
189 /* If 'b' contains at least 'offset + size' bytes of data, returns a pointer to
190 * byte 'offset'. Otherwise, returns a null pointer. */
191 static inline void *ofpbuf_at(const struct ofpbuf *b, size_t offset,
194 return offset + size <= ofpbuf_size(b) ? (char *) ofpbuf_data(b) + offset : NULL;
197 /* Returns a pointer to byte 'offset' in 'b', which must contain at least
198 * 'offset + size' bytes of data. */
199 static inline void *ofpbuf_at_assert(const struct ofpbuf *b, size_t offset,
202 ovs_assert(offset + size <= ofpbuf_size(b));
203 return ((char *) ofpbuf_data(b)) + offset;
206 /* Returns a pointer to byte following the last byte of data in use in 'b'. */
207 static inline void *ofpbuf_tail(const struct ofpbuf *b)
209 return (char *) ofpbuf_data(b) + ofpbuf_size(b);
212 /* Returns a pointer to byte following the last byte allocated for use (but
213 * not necessarily in use) in 'b'. */
214 static inline void *ofpbuf_end(const struct ofpbuf *b)
216 return (char *) ofpbuf_base(b) + b->allocated;
219 /* Returns the number of bytes of headroom in 'b', that is, the number of bytes
220 * of unused space in ofpbuf 'b' before the data that is in use. (Most
221 * commonly, the data in a ofpbuf is at its beginning, and thus the ofpbuf's
223 static inline size_t ofpbuf_headroom(const struct ofpbuf *b)
225 return (char*)ofpbuf_data(b) - (char*)ofpbuf_base(b);
228 /* Returns the number of bytes that may be appended to the tail end of ofpbuf
229 * 'b' before the ofpbuf must be reallocated. */
230 static inline size_t ofpbuf_tailroom(const struct ofpbuf *b)
232 return (char*)ofpbuf_end(b) - (char*)ofpbuf_tail(b);
235 /* Clears any data from 'b'. */
236 static inline void ofpbuf_clear(struct ofpbuf *b)
238 ofpbuf_set_data(b, ofpbuf_base(b));
239 ofpbuf_set_size(b, 0);
242 /* Removes 'size' bytes from the head end of 'b', which must contain at least
243 * 'size' bytes of data. Returns the first byte of data removed. */
244 static inline void *ofpbuf_pull(struct ofpbuf *b, size_t size)
246 void *data = ofpbuf_data(b);
247 ovs_assert(ofpbuf_size(b) >= size);
248 ofpbuf_set_data(b, (char*)ofpbuf_data(b) + size);
249 ofpbuf_set_size(b, ofpbuf_size(b) - size);
253 /* If 'b' has at least 'size' bytes of data, removes that many bytes from the
254 * head end of 'b' and returns the first byte removed. Otherwise, returns a
255 * null pointer without modifying 'b'. */
256 static inline void *ofpbuf_try_pull(struct ofpbuf *b, size_t size)
258 return ofpbuf_size(b) >= size ? ofpbuf_pull(b, size) : NULL;
261 static inline struct ofpbuf *ofpbuf_from_list(const struct list *list)
263 return CONTAINER_OF(list, struct ofpbuf, list_node);
266 static inline bool ofpbuf_equal(const struct ofpbuf *a, const struct ofpbuf *b)
268 return ofpbuf_size(a) == ofpbuf_size(b) &&
269 memcmp(ofpbuf_data(a), ofpbuf_data(b), ofpbuf_size(a)) == 0;
272 /* Get the start if the Ethernet frame. 'l3_ofs' marks the end of the l2
273 * headers, so return NULL if it is not set. */
274 static inline void * ofpbuf_l2(const struct ofpbuf *b)
276 return (b->l3_ofs != UINT16_MAX) ? b->frame : NULL;
279 /* Sets the packet frame start pointer and resets all layer offsets.
280 * l3 offset must be set before 'l2' can be retrieved. */
281 static inline void ofpbuf_set_frame(struct ofpbuf *b, void *packet)
284 b->l2_5_ofs = UINT16_MAX;
285 b->l3_ofs = UINT16_MAX;
286 b->l4_ofs = UINT16_MAX;
289 static inline void * ofpbuf_l2_5(const struct ofpbuf *b)
291 return b->l2_5_ofs != UINT16_MAX ? (char *)b->frame + b->l2_5_ofs : NULL;
294 static inline void ofpbuf_set_l2_5(struct ofpbuf *b, void *l2_5)
296 b->l2_5_ofs = l2_5 ? (char *)l2_5 - (char *)b->frame : UINT16_MAX;
299 static inline void * ofpbuf_l3(const struct ofpbuf *b)
301 return b->l3_ofs != UINT16_MAX ? (char *)b->frame + b->l3_ofs : NULL;
304 static inline void ofpbuf_set_l3(struct ofpbuf *b, void *l3)
306 b->l3_ofs = l3 ? (char *)l3 - (char *)b->frame : UINT16_MAX;
309 static inline void * ofpbuf_l4(const struct ofpbuf *b)
311 return b->l4_ofs != UINT16_MAX ? (char *)b->frame + b->l4_ofs : NULL;
314 static inline void ofpbuf_set_l4(struct ofpbuf *b, void *l4)
316 b->l4_ofs = l4 ? (char *)l4 - (char *)b->frame : UINT16_MAX;
319 static inline size_t ofpbuf_l4_size(const struct ofpbuf *b)
321 return b->l4_ofs != UINT16_MAX
322 ? (const char *)ofpbuf_tail(b) - (const char *)ofpbuf_l4(b) : 0;
325 static inline const void *ofpbuf_get_tcp_payload(const struct ofpbuf *b)
327 size_t l4_size = ofpbuf_l4_size(b);
329 if (OVS_LIKELY(l4_size >= TCP_HEADER_LEN)) {
330 struct tcp_header *tcp = ofpbuf_l4(b);
331 int tcp_len = TCP_OFFSET(tcp->tcp_ctl) * 4;
333 if (OVS_LIKELY(tcp_len >= TCP_HEADER_LEN && tcp_len <= l4_size)) {
334 return (const char *)tcp + tcp_len;
340 static inline const void *ofpbuf_get_udp_payload(const struct ofpbuf *b)
342 return OVS_LIKELY(ofpbuf_l4_size(b) >= UDP_HEADER_LEN)
343 ? (const char *)ofpbuf_l4(b) + UDP_HEADER_LEN : NULL;
346 static inline const void *ofpbuf_get_sctp_payload(const struct ofpbuf *b)
348 return OVS_LIKELY(ofpbuf_l4_size(b) >= SCTP_HEADER_LEN)
349 ? (const char *)ofpbuf_l4(b) + SCTP_HEADER_LEN : NULL;
352 static inline const void *ofpbuf_get_icmp_payload(const struct ofpbuf *b)
354 return OVS_LIKELY(ofpbuf_l4_size(b) >= ICMP_HEADER_LEN)
355 ? (const char *)ofpbuf_l4(b) + ICMP_HEADER_LEN : NULL;
359 BUILD_ASSERT_DECL(offsetof(struct ofpbuf, mbuf) == 0);
361 static inline void * ofpbuf_data(const struct ofpbuf *b)
363 return b->mbuf.pkt.data;
366 static inline void ofpbuf_set_data(struct ofpbuf *b, void *d)
368 b->mbuf.pkt.data = d;
371 static inline void * ofpbuf_base(const struct ofpbuf *b)
373 return b->mbuf.buf_addr;
376 static inline void ofpbuf_set_base(struct ofpbuf *b, void *d)
378 b->mbuf.buf_addr = d;
381 static inline uint32_t ofpbuf_size(const struct ofpbuf *b)
383 return b->mbuf.pkt.pkt_len;
386 static inline void ofpbuf_set_size(struct ofpbuf *b, uint32_t v)
388 b->mbuf.pkt.data_len = v; /* Current seg length. */
389 b->mbuf.pkt.pkt_len = v; /* Total length of all segments linked to
394 static inline void * ofpbuf_data(const struct ofpbuf *b)
399 static inline void ofpbuf_set_data(struct ofpbuf *b, void *d)
404 static inline void * ofpbuf_base(const struct ofpbuf *b)
409 static inline void ofpbuf_set_base(struct ofpbuf *b, void *d)
414 static inline uint32_t ofpbuf_size(const struct ofpbuf *b)
419 static inline void ofpbuf_set_size(struct ofpbuf *b, uint32_t v)
429 #endif /* ofpbuf.h */