1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2014 Intel Corporation.
3 * Copyright 2014 6WIND S.A.
14 #include <sys/queue.h>
16 #include <rte_compat.h>
17 #include <rte_debug.h>
18 #include <rte_common.h>
20 #include <rte_memory.h>
21 #include <rte_launch.h>
23 #include <rte_per_lcore.h>
24 #include <rte_lcore.h>
25 #include <rte_atomic.h>
26 #include <rte_branch_prediction.h>
27 #include <rte_mempool.h>
29 #include <rte_mbuf_pool_ops.h>
30 #include <rte_string_fns.h>
31 #include <rte_hexdump.h>
32 #include <rte_errno.h>
33 #include <rte_memcpy.h>
36 * ctrlmbuf constructor, given as a callback function to
37 * rte_mempool_obj_iter() or rte_mempool_create()
40 rte_ctrlmbuf_init(struct rte_mempool *mp,
41 __attribute__((unused)) void *opaque_arg,
43 __attribute__((unused)) unsigned i)
45 struct rte_mbuf *m = _m;
46 rte_pktmbuf_init(mp, opaque_arg, _m, i);
47 m->ol_flags |= CTRL_MBUF_FLAG;
51 * pktmbuf pool constructor, given as a callback function to
52 * rte_mempool_create(), or called directly if using
53 * rte_mempool_create_empty()/rte_mempool_populate()
56 rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg)
58 struct rte_pktmbuf_pool_private *user_mbp_priv, *mbp_priv;
59 struct rte_pktmbuf_pool_private default_mbp_priv;
62 RTE_ASSERT(mp->elt_size >= sizeof(struct rte_mbuf));
64 /* if no structure is provided, assume no mbuf private area */
65 user_mbp_priv = opaque_arg;
66 if (user_mbp_priv == NULL) {
67 default_mbp_priv.mbuf_priv_size = 0;
68 if (mp->elt_size > sizeof(struct rte_mbuf))
69 roomsz = mp->elt_size - sizeof(struct rte_mbuf);
72 default_mbp_priv.mbuf_data_room_size = roomsz;
73 user_mbp_priv = &default_mbp_priv;
76 RTE_ASSERT(mp->elt_size >= sizeof(struct rte_mbuf) +
77 user_mbp_priv->mbuf_data_room_size +
78 user_mbp_priv->mbuf_priv_size);
80 mbp_priv = rte_mempool_get_priv(mp);
81 memcpy(mbp_priv, user_mbp_priv, sizeof(*mbp_priv));
85 * pktmbuf constructor, given as a callback function to
86 * rte_mempool_obj_iter() or rte_mempool_create().
87 * Set the fields of a packet mbuf to their default values.
90 rte_pktmbuf_init(struct rte_mempool *mp,
91 __attribute__((unused)) void *opaque_arg,
93 __attribute__((unused)) unsigned i)
95 struct rte_mbuf *m = _m;
96 uint32_t mbuf_size, buf_len, priv_size;
98 priv_size = rte_pktmbuf_priv_size(mp);
99 mbuf_size = sizeof(struct rte_mbuf) + priv_size;
100 buf_len = rte_pktmbuf_data_room_size(mp);
102 RTE_ASSERT(RTE_ALIGN(priv_size, RTE_MBUF_PRIV_ALIGN) == priv_size);
103 RTE_ASSERT(mp->elt_size >= mbuf_size);
104 RTE_ASSERT(buf_len <= UINT16_MAX);
106 memset(m, 0, mbuf_size);
107 /* start of buffer is after mbuf structure and priv data */
108 m->priv_size = priv_size;
109 m->buf_addr = (char *)m + mbuf_size;
110 m->buf_iova = rte_mempool_virt2iova(m) + mbuf_size;
111 m->buf_len = (uint16_t)buf_len;
113 /* keep some headroom between start of buffer and data */
114 m->data_off = RTE_MIN(RTE_PKTMBUF_HEADROOM, (uint16_t)m->buf_len);
116 /* init some constant fields */
119 m->port = MBUF_INVALID_PORT;
120 rte_mbuf_refcnt_set(m, 1);
124 /* Helper to create a mbuf pool with given mempool ops name*/
125 struct rte_mempool * __rte_experimental
126 rte_pktmbuf_pool_create_by_ops(const char *name, unsigned int n,
127 unsigned int cache_size, uint16_t priv_size, uint16_t data_room_size,
128 int socket_id, const char *ops_name)
130 struct rte_mempool *mp;
131 struct rte_pktmbuf_pool_private mbp_priv;
132 const char *mp_ops_name = ops_name;
136 if (RTE_ALIGN(priv_size, RTE_MBUF_PRIV_ALIGN) != priv_size) {
137 RTE_LOG(ERR, MBUF, "mbuf priv_size=%u is not aligned\n",
142 elt_size = sizeof(struct rte_mbuf) + (unsigned)priv_size +
143 (unsigned)data_room_size;
144 mbp_priv.mbuf_data_room_size = data_room_size;
145 mbp_priv.mbuf_priv_size = priv_size;
147 mp = rte_mempool_create_empty(name, n, elt_size, cache_size,
148 sizeof(struct rte_pktmbuf_pool_private), socket_id, 0);
152 if (mp_ops_name == NULL)
153 mp_ops_name = rte_mbuf_best_mempool_ops();
154 ret = rte_mempool_set_ops_byname(mp, mp_ops_name, NULL);
156 RTE_LOG(ERR, MBUF, "error setting mempool handler\n");
157 rte_mempool_free(mp);
161 rte_pktmbuf_pool_init(mp, &mbp_priv);
163 ret = rte_mempool_populate_default(mp);
165 rte_mempool_free(mp);
170 rte_mempool_obj_iter(mp, rte_pktmbuf_init, NULL);
175 /* helper to create a mbuf pool */
177 rte_pktmbuf_pool_create(const char *name, unsigned int n,
178 unsigned int cache_size, uint16_t priv_size, uint16_t data_room_size,
181 return rte_pktmbuf_pool_create_by_ops(name, n, cache_size, priv_size,
182 data_room_size, socket_id, NULL);
185 /* do some sanity checks on a mbuf: panic if it fails */
187 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header)
189 unsigned int nb_segs, pkt_len;
192 rte_panic("mbuf is NULL\n");
196 rte_panic("bad mbuf pool\n");
197 if (m->buf_iova == 0)
198 rte_panic("bad IO addr\n");
199 if (m->buf_addr == NULL)
200 rte_panic("bad virt addr\n");
202 uint16_t cnt = rte_mbuf_refcnt_read(m);
203 if ((cnt == 0) || (cnt == UINT16_MAX))
204 rte_panic("bad ref cnt\n");
206 /* nothing to check for sub-segments */
210 /* data_len is supposed to be not more than pkt_len */
211 if (m->data_len > m->pkt_len)
212 rte_panic("bad data_len\n");
214 nb_segs = m->nb_segs;
215 pkt_len = m->pkt_len;
219 pkt_len -= m->data_len;
220 } while ((m = m->next) != NULL);
223 rte_panic("bad nb_segs\n");
225 rte_panic("bad pkt_len\n");
228 /* dump a mbuf on console */
230 rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len)
233 unsigned int nb_segs;
235 __rte_mbuf_sanity_check(m, 1);
237 fprintf(f, "dump mbuf at %p, iova=%"PRIx64", buf_len=%u\n",
238 m, (uint64_t)m->buf_iova, (unsigned)m->buf_len);
239 fprintf(f, " pkt_len=%"PRIu32", ol_flags=%"PRIx64", nb_segs=%u, "
240 "in_port=%u\n", m->pkt_len, m->ol_flags,
241 (unsigned)m->nb_segs, (unsigned)m->port);
242 nb_segs = m->nb_segs;
244 while (m && nb_segs != 0) {
245 __rte_mbuf_sanity_check(m, 0);
247 fprintf(f, " segment at %p, data=%p, data_len=%u\n",
248 m, rte_pktmbuf_mtod(m, void *), (unsigned)m->data_len);
250 if (len > m->data_len)
253 rte_hexdump(f, NULL, rte_pktmbuf_mtod(m, void *), len);
260 /* read len data bytes in a mbuf at specified offset (internal) */
261 const void *__rte_pktmbuf_read(const struct rte_mbuf *m, uint32_t off,
262 uint32_t len, void *buf)
264 const struct rte_mbuf *seg = m;
265 uint32_t buf_off = 0, copy_len;
267 if (off + len > rte_pktmbuf_pkt_len(m))
270 while (off >= rte_pktmbuf_data_len(seg)) {
271 off -= rte_pktmbuf_data_len(seg);
275 if (off + len <= rte_pktmbuf_data_len(seg))
276 return rte_pktmbuf_mtod_offset(seg, char *, off);
278 /* rare case: header is split among several segments */
280 copy_len = rte_pktmbuf_data_len(seg) - off;
283 rte_memcpy((char *)buf + buf_off,
284 rte_pktmbuf_mtod_offset(seg, char *, off), copy_len);
295 * Get the name of a RX offload flag. Must be kept synchronized with flag
296 * definitions in rte_mbuf.h.
298 const char *rte_get_rx_ol_flag_name(uint64_t mask)
301 case PKT_RX_VLAN: return "PKT_RX_VLAN";
302 case PKT_RX_RSS_HASH: return "PKT_RX_RSS_HASH";
303 case PKT_RX_FDIR: return "PKT_RX_FDIR";
304 case PKT_RX_L4_CKSUM_BAD: return "PKT_RX_L4_CKSUM_BAD";
305 case PKT_RX_L4_CKSUM_GOOD: return "PKT_RX_L4_CKSUM_GOOD";
306 case PKT_RX_L4_CKSUM_NONE: return "PKT_RX_L4_CKSUM_NONE";
307 case PKT_RX_IP_CKSUM_BAD: return "PKT_RX_IP_CKSUM_BAD";
308 case PKT_RX_IP_CKSUM_GOOD: return "PKT_RX_IP_CKSUM_GOOD";
309 case PKT_RX_IP_CKSUM_NONE: return "PKT_RX_IP_CKSUM_NONE";
310 case PKT_RX_EIP_CKSUM_BAD: return "PKT_RX_EIP_CKSUM_BAD";
311 case PKT_RX_VLAN_STRIPPED: return "PKT_RX_VLAN_STRIPPED";
312 case PKT_RX_IEEE1588_PTP: return "PKT_RX_IEEE1588_PTP";
313 case PKT_RX_IEEE1588_TMST: return "PKT_RX_IEEE1588_TMST";
314 case PKT_RX_QINQ_STRIPPED: return "PKT_RX_QINQ_STRIPPED";
315 case PKT_RX_LRO: return "PKT_RX_LRO";
316 case PKT_RX_TIMESTAMP: return "PKT_RX_TIMESTAMP";
317 case PKT_RX_SEC_OFFLOAD: return "PKT_RX_SEC_OFFLOAD";
318 case PKT_RX_SEC_OFFLOAD_FAILED: return "PKT_RX_SEC_OFFLOAD_FAILED";
319 default: return NULL;
326 const char *default_name;
329 /* write the list of rx ol flags in buffer buf */
331 rte_get_rx_ol_flag_list(uint64_t mask, char *buf, size_t buflen)
333 const struct flag_mask rx_flags[] = {
334 { PKT_RX_VLAN, PKT_RX_VLAN, NULL },
335 { PKT_RX_RSS_HASH, PKT_RX_RSS_HASH, NULL },
336 { PKT_RX_FDIR, PKT_RX_FDIR, NULL },
337 { PKT_RX_L4_CKSUM_BAD, PKT_RX_L4_CKSUM_MASK, NULL },
338 { PKT_RX_L4_CKSUM_GOOD, PKT_RX_L4_CKSUM_MASK, NULL },
339 { PKT_RX_L4_CKSUM_NONE, PKT_RX_L4_CKSUM_MASK, NULL },
340 { PKT_RX_L4_CKSUM_UNKNOWN, PKT_RX_L4_CKSUM_MASK,
341 "PKT_RX_L4_CKSUM_UNKNOWN" },
342 { PKT_RX_IP_CKSUM_BAD, PKT_RX_IP_CKSUM_MASK, NULL },
343 { PKT_RX_IP_CKSUM_GOOD, PKT_RX_IP_CKSUM_MASK, NULL },
344 { PKT_RX_IP_CKSUM_NONE, PKT_RX_IP_CKSUM_MASK, NULL },
345 { PKT_RX_IP_CKSUM_UNKNOWN, PKT_RX_IP_CKSUM_MASK,
346 "PKT_RX_IP_CKSUM_UNKNOWN" },
347 { PKT_RX_EIP_CKSUM_BAD, PKT_RX_EIP_CKSUM_BAD, NULL },
348 { PKT_RX_VLAN_STRIPPED, PKT_RX_VLAN_STRIPPED, NULL },
349 { PKT_RX_IEEE1588_PTP, PKT_RX_IEEE1588_PTP, NULL },
350 { PKT_RX_IEEE1588_TMST, PKT_RX_IEEE1588_TMST, NULL },
351 { PKT_RX_QINQ_STRIPPED, PKT_RX_QINQ_STRIPPED, NULL },
352 { PKT_RX_LRO, PKT_RX_LRO, NULL },
353 { PKT_RX_TIMESTAMP, PKT_RX_TIMESTAMP, NULL },
354 { PKT_RX_SEC_OFFLOAD, PKT_RX_SEC_OFFLOAD, NULL },
355 { PKT_RX_SEC_OFFLOAD_FAILED, PKT_RX_SEC_OFFLOAD_FAILED, NULL },
356 { PKT_RX_QINQ, PKT_RX_QINQ, NULL },
366 for (i = 0; i < RTE_DIM(rx_flags); i++) {
367 if ((mask & rx_flags[i].mask) != rx_flags[i].flag)
369 name = rte_get_rx_ol_flag_name(rx_flags[i].flag);
371 name = rx_flags[i].default_name;
372 ret = snprintf(buf, buflen, "%s ", name);
375 if ((size_t)ret >= buflen)
385 * Get the name of a TX offload flag. Must be kept synchronized with flag
386 * definitions in rte_mbuf.h.
388 const char *rte_get_tx_ol_flag_name(uint64_t mask)
391 case PKT_TX_VLAN_PKT: return "PKT_TX_VLAN_PKT";
392 case PKT_TX_IP_CKSUM: return "PKT_TX_IP_CKSUM";
393 case PKT_TX_TCP_CKSUM: return "PKT_TX_TCP_CKSUM";
394 case PKT_TX_SCTP_CKSUM: return "PKT_TX_SCTP_CKSUM";
395 case PKT_TX_UDP_CKSUM: return "PKT_TX_UDP_CKSUM";
396 case PKT_TX_IEEE1588_TMST: return "PKT_TX_IEEE1588_TMST";
397 case PKT_TX_TCP_SEG: return "PKT_TX_TCP_SEG";
398 case PKT_TX_IPV4: return "PKT_TX_IPV4";
399 case PKT_TX_IPV6: return "PKT_TX_IPV6";
400 case PKT_TX_OUTER_IP_CKSUM: return "PKT_TX_OUTER_IP_CKSUM";
401 case PKT_TX_OUTER_IPV4: return "PKT_TX_OUTER_IPV4";
402 case PKT_TX_OUTER_IPV6: return "PKT_TX_OUTER_IPV6";
403 case PKT_TX_TUNNEL_VXLAN: return "PKT_TX_TUNNEL_VXLAN";
404 case PKT_TX_TUNNEL_GRE: return "PKT_TX_TUNNEL_GRE";
405 case PKT_TX_TUNNEL_IPIP: return "PKT_TX_TUNNEL_IPIP";
406 case PKT_TX_TUNNEL_GENEVE: return "PKT_TX_TUNNEL_GENEVE";
407 case PKT_TX_TUNNEL_MPLSINUDP: return "PKT_TX_TUNNEL_MPLSINUDP";
408 case PKT_TX_MACSEC: return "PKT_TX_MACSEC";
409 case PKT_TX_SEC_OFFLOAD: return "PKT_TX_SEC_OFFLOAD";
410 default: return NULL;
414 /* write the list of tx ol flags in buffer buf */
416 rte_get_tx_ol_flag_list(uint64_t mask, char *buf, size_t buflen)
418 const struct flag_mask tx_flags[] = {
419 { PKT_TX_VLAN_PKT, PKT_TX_VLAN_PKT, NULL },
420 { PKT_TX_IP_CKSUM, PKT_TX_IP_CKSUM, NULL },
421 { PKT_TX_TCP_CKSUM, PKT_TX_L4_MASK, NULL },
422 { PKT_TX_SCTP_CKSUM, PKT_TX_L4_MASK, NULL },
423 { PKT_TX_UDP_CKSUM, PKT_TX_L4_MASK, NULL },
424 { PKT_TX_L4_NO_CKSUM, PKT_TX_L4_MASK, "PKT_TX_L4_NO_CKSUM" },
425 { PKT_TX_IEEE1588_TMST, PKT_TX_IEEE1588_TMST, NULL },
426 { PKT_TX_TCP_SEG, PKT_TX_TCP_SEG, NULL },
427 { PKT_TX_IPV4, PKT_TX_IPV4, NULL },
428 { PKT_TX_IPV6, PKT_TX_IPV6, NULL },
429 { PKT_TX_OUTER_IP_CKSUM, PKT_TX_OUTER_IP_CKSUM, NULL },
430 { PKT_TX_OUTER_IPV4, PKT_TX_OUTER_IPV4, NULL },
431 { PKT_TX_OUTER_IPV6, PKT_TX_OUTER_IPV6, NULL },
432 { PKT_TX_TUNNEL_VXLAN, PKT_TX_TUNNEL_MASK,
433 "PKT_TX_TUNNEL_NONE" },
434 { PKT_TX_TUNNEL_GRE, PKT_TX_TUNNEL_MASK,
435 "PKT_TX_TUNNEL_NONE" },
436 { PKT_TX_TUNNEL_IPIP, PKT_TX_TUNNEL_MASK,
437 "PKT_TX_TUNNEL_NONE" },
438 { PKT_TX_TUNNEL_GENEVE, PKT_TX_TUNNEL_MASK,
439 "PKT_TX_TUNNEL_NONE" },
440 { PKT_TX_TUNNEL_MPLSINUDP, PKT_TX_TUNNEL_MASK,
441 "PKT_TX_TUNNEL_NONE" },
442 { PKT_TX_MACSEC, PKT_TX_MACSEC, NULL },
443 { PKT_TX_SEC_OFFLOAD, PKT_TX_SEC_OFFLOAD, NULL },
453 for (i = 0; i < RTE_DIM(tx_flags); i++) {
454 if ((mask & tx_flags[i].mask) != tx_flags[i].flag)
456 name = rte_get_tx_ol_flag_name(tx_flags[i].flag);
458 name = tx_flags[i].default_name;
459 ret = snprintf(buf, buflen, "%s ", name);
462 if ((size_t)ret >= buflen)