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>
57 #include <rte_mempool.h>
59 #include <rte_string_fns.h>
60 #include <rte_hexdump.h>
61 #include <rte_errno.h>
64 * ctrlmbuf constructor, given as a callback function to
65 * rte_mempool_create()
68 rte_ctrlmbuf_init(struct rte_mempool *mp,
69 __attribute__((unused)) void *opaque_arg,
71 __attribute__((unused)) unsigned i)
73 struct rte_mbuf *m = _m;
74 rte_pktmbuf_init(mp, opaque_arg, _m, i);
75 m->ol_flags |= CTRL_MBUF_FLAG;
79 * pktmbuf pool constructor, given as a callback function to
80 * rte_mempool_create()
83 rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg)
85 struct rte_pktmbuf_pool_private *user_mbp_priv, *mbp_priv;
86 struct rte_pktmbuf_pool_private default_mbp_priv;
89 RTE_MBUF_ASSERT(mp->elt_size >= sizeof(struct rte_mbuf));
91 /* if no structure is provided, assume no mbuf private area */
92 user_mbp_priv = opaque_arg;
93 if (user_mbp_priv == NULL) {
94 default_mbp_priv.mbuf_priv_size = 0;
95 if (mp->elt_size > sizeof(struct rte_mbuf))
96 roomsz = mp->elt_size - sizeof(struct rte_mbuf);
99 default_mbp_priv.mbuf_data_room_size = roomsz;
100 user_mbp_priv = &default_mbp_priv;
103 RTE_MBUF_ASSERT(mp->elt_size >= sizeof(struct rte_mbuf) +
104 user_mbp_priv->mbuf_data_room_size +
105 user_mbp_priv->mbuf_priv_size);
107 mbp_priv = rte_mempool_get_priv(mp);
108 memcpy(mbp_priv, user_mbp_priv, sizeof(*mbp_priv));
112 * pktmbuf constructor, given as a callback function to
113 * rte_mempool_create().
114 * Set the fields of a packet mbuf to their default values.
117 rte_pktmbuf_init(struct rte_mempool *mp,
118 __attribute__((unused)) void *opaque_arg,
120 __attribute__((unused)) unsigned i)
122 struct rte_mbuf *m = _m;
123 uint32_t mbuf_size, buf_len, priv_size;
125 priv_size = rte_pktmbuf_priv_size(mp);
126 mbuf_size = sizeof(struct rte_mbuf) + priv_size;
127 buf_len = rte_pktmbuf_data_room_size(mp);
129 RTE_MBUF_ASSERT(RTE_ALIGN(priv_size, RTE_MBUF_PRIV_ALIGN) == priv_size);
130 RTE_MBUF_ASSERT(mp->elt_size >= mbuf_size);
131 RTE_MBUF_ASSERT(buf_len <= UINT16_MAX);
133 memset(m, 0, mp->elt_size);
135 /* start of buffer is after mbuf structure and priv data */
136 m->priv_size = priv_size;
137 m->buf_addr = (char *)m + mbuf_size;
138 m->buf_physaddr = rte_mempool_virt2phy(mp, m) + mbuf_size;
139 m->buf_len = (uint16_t)buf_len;
141 /* keep some headroom between start of buffer and data */
142 m->data_off = RTE_MIN(RTE_PKTMBUF_HEADROOM, (uint16_t)m->buf_len);
144 /* init some constant fields */
150 /* helper to create a mbuf pool */
152 rte_pktmbuf_pool_create(const char *name, unsigned n,
153 unsigned cache_size, uint16_t priv_size, uint16_t data_room_size,
156 struct rte_pktmbuf_pool_private mbp_priv;
159 if (RTE_ALIGN(priv_size, RTE_MBUF_PRIV_ALIGN) != priv_size) {
160 RTE_LOG(ERR, MBUF, "mbuf priv_size=%u is not aligned\n",
165 elt_size = sizeof(struct rte_mbuf) + (unsigned)priv_size +
166 (unsigned)data_room_size;
167 mbp_priv.mbuf_data_room_size = data_room_size;
168 mbp_priv.mbuf_priv_size = priv_size;
170 return rte_mempool_create(name, n, elt_size,
171 cache_size, sizeof(struct rte_pktmbuf_pool_private),
172 rte_pktmbuf_pool_init, &mbp_priv, rte_pktmbuf_init, NULL,
176 /* do some sanity checks on a mbuf: panic if it fails */
178 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header)
180 const struct rte_mbuf *m_seg;
184 rte_panic("mbuf is NULL\n");
188 rte_panic("bad mbuf pool\n");
189 if (m->buf_physaddr == 0)
190 rte_panic("bad phys addr\n");
191 if (m->buf_addr == NULL)
192 rte_panic("bad virt addr\n");
194 uint16_t cnt = rte_mbuf_refcnt_read(m);
195 if ((cnt == 0) || (cnt == UINT16_MAX))
196 rte_panic("bad ref cnt\n");
198 /* nothing to check for sub-segments */
202 nb_segs = m->nb_segs;
204 while (m_seg && nb_segs != 0) {
209 rte_panic("bad nb_segs\n");
212 /* dump a mbuf on console */
214 rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len)
219 __rte_mbuf_sanity_check(m, 1);
221 fprintf(f, "dump mbuf at 0x%p, phys=%"PRIx64", buf_len=%u\n",
222 m, (uint64_t)m->buf_physaddr, (unsigned)m->buf_len);
223 fprintf(f, " pkt_len=%"PRIu32", ol_flags=%"PRIx64", nb_segs=%u, "
224 "in_port=%u\n", m->pkt_len, m->ol_flags,
225 (unsigned)m->nb_segs, (unsigned)m->port);
226 nb_segs = m->nb_segs;
228 while (m && nb_segs != 0) {
229 __rte_mbuf_sanity_check(m, 0);
231 fprintf(f, " segment at 0x%p, data=0x%p, data_len=%u\n",
232 m, rte_pktmbuf_mtod(m, void *), (unsigned)m->data_len);
234 if (len > m->data_len)
237 rte_hexdump(f, NULL, rte_pktmbuf_mtod(m, void *), len);
245 * Get the name of a RX offload flag. Must be kept synchronized with flag
246 * definitions in rte_mbuf.h.
248 const char *rte_get_rx_ol_flag_name(uint64_t mask)
251 case PKT_RX_VLAN_PKT: return "PKT_RX_VLAN_PKT";
252 case PKT_RX_RSS_HASH: return "PKT_RX_RSS_HASH";
253 case PKT_RX_FDIR: return "PKT_RX_FDIR";
254 case PKT_RX_L4_CKSUM_BAD: return "PKT_RX_L4_CKSUM_BAD";
255 case PKT_RX_IP_CKSUM_BAD: return "PKT_RX_IP_CKSUM_BAD";
256 /* case PKT_RX_EIP_CKSUM_BAD: return "PKT_RX_EIP_CKSUM_BAD"; */
257 /* case PKT_RX_OVERSIZE: return "PKT_RX_OVERSIZE"; */
258 /* case PKT_RX_HBUF_OVERFLOW: return "PKT_RX_HBUF_OVERFLOW"; */
259 /* case PKT_RX_RECIP_ERR: return "PKT_RX_RECIP_ERR"; */
260 /* case PKT_RX_MAC_ERR: return "PKT_RX_MAC_ERR"; */
261 case PKT_RX_IEEE1588_PTP: return "PKT_RX_IEEE1588_PTP";
262 case PKT_RX_IEEE1588_TMST: return "PKT_RX_IEEE1588_TMST";
263 default: return NULL;
268 * Get the name of a TX offload flag. Must be kept synchronized with flag
269 * definitions in rte_mbuf.h.
271 const char *rte_get_tx_ol_flag_name(uint64_t mask)
274 case PKT_TX_VLAN_PKT: return "PKT_TX_VLAN_PKT";
275 case PKT_TX_IP_CKSUM: return "PKT_TX_IP_CKSUM";
276 case PKT_TX_TCP_CKSUM: return "PKT_TX_TCP_CKSUM";
277 case PKT_TX_SCTP_CKSUM: return "PKT_TX_SCTP_CKSUM";
278 case PKT_TX_UDP_CKSUM: return "PKT_TX_UDP_CKSUM";
279 case PKT_TX_IEEE1588_TMST: return "PKT_TX_IEEE1588_TMST";
280 case PKT_TX_TCP_SEG: return "PKT_TX_TCP_SEG";
281 case PKT_TX_IPV4: return "PKT_TX_IPV4";
282 case PKT_TX_IPV6: return "PKT_TX_IPV6";
283 case PKT_TX_OUTER_IP_CKSUM: return "PKT_TX_OUTER_IP_CKSUM";
284 case PKT_TX_OUTER_IPV4: return "PKT_TX_OUTER_IPV4";
285 case PKT_TX_OUTER_IPV6: return "PKT_TX_OUTER_IPV6";
286 default: return NULL;