4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
5 * Copyright 2014 6WIND S.A.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * * Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
18 * * Neither the name of Intel Corporation nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
43 #include <sys/queue.h>
45 #include <rte_debug.h>
46 #include <rte_common.h>
48 #include <rte_memory.h>
49 #include <rte_memzone.h>
50 #include <rte_launch.h>
52 #include <rte_per_lcore.h>
53 #include <rte_lcore.h>
54 #include <rte_atomic.h>
55 #include <rte_branch_prediction.h>
56 #include <rte_mempool.h>
58 #include <rte_string_fns.h>
59 #include <rte_hexdump.h>
60 #include <rte_errno.h>
63 * ctrlmbuf constructor, given as a callback function to
64 * rte_mempool_create()
67 rte_ctrlmbuf_init(struct rte_mempool *mp,
68 __attribute__((unused)) void *opaque_arg,
70 __attribute__((unused)) unsigned i)
72 struct rte_mbuf *m = _m;
73 rte_pktmbuf_init(mp, opaque_arg, _m, i);
74 m->ol_flags |= CTRL_MBUF_FLAG;
78 * pktmbuf pool constructor, given as a callback function to
79 * rte_mempool_create()
82 rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg)
84 struct rte_pktmbuf_pool_private *user_mbp_priv, *mbp_priv;
85 struct rte_pktmbuf_pool_private default_mbp_priv;
88 RTE_ASSERT(mp->elt_size >= sizeof(struct rte_mbuf));
90 /* if no structure is provided, assume no mbuf private area */
91 user_mbp_priv = opaque_arg;
92 if (user_mbp_priv == NULL) {
93 default_mbp_priv.mbuf_priv_size = 0;
94 if (mp->elt_size > sizeof(struct rte_mbuf))
95 roomsz = mp->elt_size - sizeof(struct rte_mbuf);
98 default_mbp_priv.mbuf_data_room_size = roomsz;
99 user_mbp_priv = &default_mbp_priv;
102 RTE_ASSERT(mp->elt_size >= sizeof(struct rte_mbuf) +
103 user_mbp_priv->mbuf_data_room_size +
104 user_mbp_priv->mbuf_priv_size);
106 mbp_priv = rte_mempool_get_priv(mp);
107 memcpy(mbp_priv, user_mbp_priv, sizeof(*mbp_priv));
111 * pktmbuf constructor, given as a callback function to
112 * rte_mempool_create().
113 * Set the fields of a packet mbuf to their default values.
116 rte_pktmbuf_init(struct rte_mempool *mp,
117 __attribute__((unused)) void *opaque_arg,
119 __attribute__((unused)) unsigned i)
121 struct rte_mbuf *m = _m;
122 uint32_t mbuf_size, buf_len, priv_size;
124 priv_size = rte_pktmbuf_priv_size(mp);
125 mbuf_size = sizeof(struct rte_mbuf) + priv_size;
126 buf_len = rte_pktmbuf_data_room_size(mp);
128 RTE_ASSERT(RTE_ALIGN(priv_size, RTE_MBUF_PRIV_ALIGN) == priv_size);
129 RTE_ASSERT(mp->elt_size >= mbuf_size);
130 RTE_ASSERT(buf_len <= UINT16_MAX);
132 memset(m, 0, mp->elt_size);
134 /* start of buffer is after mbuf structure and priv data */
135 m->priv_size = priv_size;
136 m->buf_addr = (char *)m + mbuf_size;
137 m->buf_physaddr = rte_mempool_virt2phy(mp, m) + mbuf_size;
138 m->buf_len = (uint16_t)buf_len;
140 /* keep some headroom between start of buffer and data */
141 m->data_off = RTE_MIN(RTE_PKTMBUF_HEADROOM, (uint16_t)m->buf_len);
143 /* init some constant fields */
149 /* helper to create a mbuf pool */
151 rte_pktmbuf_pool_create(const char *name, unsigned n,
152 unsigned cache_size, uint16_t priv_size, uint16_t data_room_size,
155 struct rte_mempool *mp;
156 struct rte_pktmbuf_pool_private mbp_priv;
160 if (RTE_ALIGN(priv_size, RTE_MBUF_PRIV_ALIGN) != priv_size) {
161 RTE_LOG(ERR, MBUF, "mbuf priv_size=%u is not aligned\n",
166 elt_size = sizeof(struct rte_mbuf) + (unsigned)priv_size +
167 (unsigned)data_room_size;
168 mbp_priv.mbuf_data_room_size = data_room_size;
169 mbp_priv.mbuf_priv_size = priv_size;
171 mp = rte_mempool_create_empty(name, n, elt_size, cache_size,
172 sizeof(struct rte_pktmbuf_pool_private), socket_id, 0);
176 rte_errno = rte_mempool_set_ops_byname(mp,
177 RTE_MBUF_DEFAULT_MEMPOOL_OPS, NULL);
178 if (rte_errno != 0) {
179 RTE_LOG(ERR, MBUF, "error setting mempool handler\n");
182 rte_pktmbuf_pool_init(mp, &mbp_priv);
184 ret = rte_mempool_populate_default(mp);
186 rte_mempool_free(mp);
191 rte_mempool_obj_iter(mp, rte_pktmbuf_init, NULL);
196 /* do some sanity checks on a mbuf: panic if it fails */
198 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header)
200 const struct rte_mbuf *m_seg;
204 rte_panic("mbuf is NULL\n");
208 rte_panic("bad mbuf pool\n");
209 if (m->buf_physaddr == 0)
210 rte_panic("bad phys addr\n");
211 if (m->buf_addr == NULL)
212 rte_panic("bad virt addr\n");
214 uint16_t cnt = rte_mbuf_refcnt_read(m);
215 if ((cnt == 0) || (cnt == UINT16_MAX))
216 rte_panic("bad ref cnt\n");
218 /* nothing to check for sub-segments */
222 nb_segs = m->nb_segs;
224 while (m_seg && nb_segs != 0) {
229 rte_panic("bad nb_segs\n");
232 /* dump a mbuf on console */
234 rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len)
239 __rte_mbuf_sanity_check(m, 1);
241 fprintf(f, "dump mbuf at %p, phys=%"PRIx64", buf_len=%u\n",
242 m, (uint64_t)m->buf_physaddr, (unsigned)m->buf_len);
243 fprintf(f, " pkt_len=%"PRIu32", ol_flags=%"PRIx64", nb_segs=%u, "
244 "in_port=%u\n", m->pkt_len, m->ol_flags,
245 (unsigned)m->nb_segs, (unsigned)m->port);
246 nb_segs = m->nb_segs;
248 while (m && nb_segs != 0) {
249 __rte_mbuf_sanity_check(m, 0);
251 fprintf(f, " segment at %p, data=%p, data_len=%u\n",
252 m, rte_pktmbuf_mtod(m, void *), (unsigned)m->data_len);
254 if (len > m->data_len)
257 rte_hexdump(f, NULL, rte_pktmbuf_mtod(m, void *), len);
265 * Get the name of a RX offload flag. Must be kept synchronized with flag
266 * definitions in rte_mbuf.h.
268 const char *rte_get_rx_ol_flag_name(uint64_t mask)
271 case PKT_RX_VLAN_PKT: return "PKT_RX_VLAN_PKT";
272 case PKT_RX_RSS_HASH: return "PKT_RX_RSS_HASH";
273 case PKT_RX_FDIR: return "PKT_RX_FDIR";
274 case PKT_RX_L4_CKSUM_BAD: return "PKT_RX_L4_CKSUM_BAD";
275 case PKT_RX_IP_CKSUM_BAD: return "PKT_RX_IP_CKSUM_BAD";
276 case PKT_RX_EIP_CKSUM_BAD: return "PKT_RX_EIP_CKSUM_BAD";
277 case PKT_RX_VLAN_STRIPPED: return "PKT_RX_VLAN_STRIPPED";
278 case PKT_RX_IEEE1588_PTP: return "PKT_RX_IEEE1588_PTP";
279 case PKT_RX_IEEE1588_TMST: return "PKT_RX_IEEE1588_TMST";
280 case PKT_RX_QINQ_STRIPPED: return "PKT_RX_QINQ_STRIPPED";
281 default: return NULL;
286 * Get the name of a TX offload flag. Must be kept synchronized with flag
287 * definitions in rte_mbuf.h.
289 const char *rte_get_tx_ol_flag_name(uint64_t mask)
292 case PKT_TX_VLAN_PKT: return "PKT_TX_VLAN_PKT";
293 case PKT_TX_IP_CKSUM: return "PKT_TX_IP_CKSUM";
294 case PKT_TX_TCP_CKSUM: return "PKT_TX_TCP_CKSUM";
295 case PKT_TX_SCTP_CKSUM: return "PKT_TX_SCTP_CKSUM";
296 case PKT_TX_UDP_CKSUM: return "PKT_TX_UDP_CKSUM";
297 case PKT_TX_IEEE1588_TMST: return "PKT_TX_IEEE1588_TMST";
298 case PKT_TX_TCP_SEG: return "PKT_TX_TCP_SEG";
299 case PKT_TX_IPV4: return "PKT_TX_IPV4";
300 case PKT_TX_IPV6: return "PKT_TX_IPV6";
301 case PKT_TX_OUTER_IP_CKSUM: return "PKT_TX_OUTER_IP_CKSUM";
302 case PKT_TX_OUTER_IPV4: return "PKT_TX_OUTER_IPV4";
303 case PKT_TX_OUTER_IPV6: return "PKT_TX_OUTER_IPV6";
304 default: return NULL;