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 * pktmbuf pool constructor, given as a callback function to
37 * rte_mempool_create(), or called directly if using
38 * rte_mempool_create_empty()/rte_mempool_populate()
41 rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg)
43 struct rte_pktmbuf_pool_private *user_mbp_priv, *mbp_priv;
44 struct rte_pktmbuf_pool_private default_mbp_priv;
47 RTE_ASSERT(mp->elt_size >= sizeof(struct rte_mbuf));
49 /* if no structure is provided, assume no mbuf private area */
50 user_mbp_priv = opaque_arg;
51 if (user_mbp_priv == NULL) {
52 default_mbp_priv.mbuf_priv_size = 0;
53 if (mp->elt_size > sizeof(struct rte_mbuf))
54 roomsz = mp->elt_size - sizeof(struct rte_mbuf);
57 default_mbp_priv.mbuf_data_room_size = roomsz;
58 user_mbp_priv = &default_mbp_priv;
61 RTE_ASSERT(mp->elt_size >= sizeof(struct rte_mbuf) +
62 user_mbp_priv->mbuf_data_room_size +
63 user_mbp_priv->mbuf_priv_size);
65 mbp_priv = rte_mempool_get_priv(mp);
66 memcpy(mbp_priv, user_mbp_priv, sizeof(*mbp_priv));
70 * pktmbuf constructor, given as a callback function to
71 * rte_mempool_obj_iter() or rte_mempool_create().
72 * Set the fields of a packet mbuf to their default values.
75 rte_pktmbuf_init(struct rte_mempool *mp,
76 __attribute__((unused)) void *opaque_arg,
78 __attribute__((unused)) unsigned i)
80 struct rte_mbuf *m = _m;
81 uint32_t mbuf_size, buf_len, priv_size;
83 priv_size = rte_pktmbuf_priv_size(mp);
84 mbuf_size = sizeof(struct rte_mbuf) + priv_size;
85 buf_len = rte_pktmbuf_data_room_size(mp);
87 RTE_ASSERT(RTE_ALIGN(priv_size, RTE_MBUF_PRIV_ALIGN) == priv_size);
88 RTE_ASSERT(mp->elt_size >= mbuf_size);
89 RTE_ASSERT(buf_len <= UINT16_MAX);
91 memset(m, 0, mbuf_size);
92 /* start of buffer is after mbuf structure and priv data */
93 m->priv_size = priv_size;
94 m->buf_addr = (char *)m + mbuf_size;
95 m->buf_iova = rte_mempool_virt2iova(m) + mbuf_size;
96 m->buf_len = (uint16_t)buf_len;
98 /* keep some headroom between start of buffer and data */
99 m->data_off = RTE_MIN(RTE_PKTMBUF_HEADROOM, (uint16_t)m->buf_len);
101 /* init some constant fields */
104 m->port = MBUF_INVALID_PORT;
105 rte_mbuf_refcnt_set(m, 1);
109 /* Helper to create a mbuf pool with given mempool ops name*/
111 rte_pktmbuf_pool_create_by_ops(const char *name, unsigned int n,
112 unsigned int cache_size, uint16_t priv_size, uint16_t data_room_size,
113 int socket_id, const char *ops_name)
115 struct rte_mempool *mp;
116 struct rte_pktmbuf_pool_private mbp_priv;
117 const char *mp_ops_name = ops_name;
121 if (RTE_ALIGN(priv_size, RTE_MBUF_PRIV_ALIGN) != priv_size) {
122 RTE_LOG(ERR, MBUF, "mbuf priv_size=%u is not aligned\n",
127 elt_size = sizeof(struct rte_mbuf) + (unsigned)priv_size +
128 (unsigned)data_room_size;
129 mbp_priv.mbuf_data_room_size = data_room_size;
130 mbp_priv.mbuf_priv_size = priv_size;
132 mp = rte_mempool_create_empty(name, n, elt_size, cache_size,
133 sizeof(struct rte_pktmbuf_pool_private), socket_id, 0);
137 if (mp_ops_name == NULL)
138 mp_ops_name = rte_mbuf_best_mempool_ops();
139 ret = rte_mempool_set_ops_byname(mp, mp_ops_name, NULL);
141 RTE_LOG(ERR, MBUF, "error setting mempool handler\n");
142 rte_mempool_free(mp);
146 rte_pktmbuf_pool_init(mp, &mbp_priv);
148 ret = rte_mempool_populate_default(mp);
150 rte_mempool_free(mp);
155 rte_mempool_obj_iter(mp, rte_pktmbuf_init, NULL);
160 /* helper to create a mbuf pool */
162 rte_pktmbuf_pool_create(const char *name, unsigned int n,
163 unsigned int cache_size, uint16_t priv_size, uint16_t data_room_size,
166 return rte_pktmbuf_pool_create_by_ops(name, n, cache_size, priv_size,
167 data_room_size, socket_id, NULL);
170 /* do some sanity checks on a mbuf: panic if it fails */
172 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header)
176 if (rte_mbuf_check(m, is_header, &reason))
177 rte_panic("%s\n", reason);
180 int rte_mbuf_check(const struct rte_mbuf *m, int is_header,
183 unsigned int nb_segs, pkt_len;
186 *reason = "mbuf is NULL";
191 if (m->pool == NULL) {
192 *reason = "bad mbuf pool";
195 if (m->buf_iova == 0) {
196 *reason = "bad IO addr";
199 if (m->buf_addr == NULL) {
200 *reason = "bad virt addr";
204 uint16_t cnt = rte_mbuf_refcnt_read(m);
205 if ((cnt == 0) || (cnt == UINT16_MAX)) {
206 *reason = "bad ref cnt";
210 /* nothing to check for sub-segments */
214 /* data_len is supposed to be not more than pkt_len */
215 if (m->data_len > m->pkt_len) {
216 *reason = "bad data_len";
220 nb_segs = m->nb_segs;
221 pkt_len = m->pkt_len;
224 if (m->data_off > m->buf_len) {
225 *reason = "data offset too big in mbuf segment";
228 if (m->data_off + m->data_len > m->buf_len) {
229 *reason = "data length too big in mbuf segment";
233 pkt_len -= m->data_len;
234 } while ((m = m->next) != NULL);
237 *reason = "bad nb_segs";
241 *reason = "bad pkt_len";
248 /* convert multi-segment mbuf to single mbuf */
250 __rte_pktmbuf_linearize(struct rte_mbuf *mbuf)
252 size_t seg_len, copy_len;
254 struct rte_mbuf *m_next;
257 /* Extend first segment to the total packet length */
258 copy_len = rte_pktmbuf_pkt_len(mbuf) - rte_pktmbuf_data_len(mbuf);
260 if (unlikely(copy_len > rte_pktmbuf_tailroom(mbuf)))
263 buffer = rte_pktmbuf_mtod_offset(mbuf, char *, mbuf->data_len);
264 mbuf->data_len = (uint16_t)(mbuf->pkt_len);
266 /* Append data from next segments to the first one */
271 seg_len = rte_pktmbuf_data_len(m);
272 rte_memcpy(buffer, rte_pktmbuf_mtod(m, char *), seg_len);
275 rte_pktmbuf_free_seg(m);
285 /* dump a mbuf on console */
287 rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len)
290 unsigned int nb_segs;
292 __rte_mbuf_sanity_check(m, 1);
294 fprintf(f, "dump mbuf at %p, iova=%"PRIx64", buf_len=%u\n",
295 m, (uint64_t)m->buf_iova, (unsigned)m->buf_len);
296 fprintf(f, " pkt_len=%"PRIu32", ol_flags=%"PRIx64", nb_segs=%u, "
297 "in_port=%u\n", m->pkt_len, m->ol_flags,
298 (unsigned)m->nb_segs, (unsigned)m->port);
299 nb_segs = m->nb_segs;
301 while (m && nb_segs != 0) {
302 __rte_mbuf_sanity_check(m, 0);
304 fprintf(f, " segment at %p, data=%p, data_len=%u\n",
305 m, rte_pktmbuf_mtod(m, void *), (unsigned)m->data_len);
307 if (len > m->data_len)
310 rte_hexdump(f, NULL, rte_pktmbuf_mtod(m, void *), len);
317 /* read len data bytes in a mbuf at specified offset (internal) */
318 const void *__rte_pktmbuf_read(const struct rte_mbuf *m, uint32_t off,
319 uint32_t len, void *buf)
321 const struct rte_mbuf *seg = m;
322 uint32_t buf_off = 0, copy_len;
324 if (off + len > rte_pktmbuf_pkt_len(m))
327 while (off >= rte_pktmbuf_data_len(seg)) {
328 off -= rte_pktmbuf_data_len(seg);
332 if (off + len <= rte_pktmbuf_data_len(seg))
333 return rte_pktmbuf_mtod_offset(seg, char *, off);
335 /* rare case: header is split among several segments */
337 copy_len = rte_pktmbuf_data_len(seg) - off;
340 rte_memcpy((char *)buf + buf_off,
341 rte_pktmbuf_mtod_offset(seg, char *, off), copy_len);
352 * Get the name of a RX offload flag. Must be kept synchronized with flag
353 * definitions in rte_mbuf.h.
355 const char *rte_get_rx_ol_flag_name(uint64_t mask)
358 case PKT_RX_VLAN: return "PKT_RX_VLAN";
359 case PKT_RX_RSS_HASH: return "PKT_RX_RSS_HASH";
360 case PKT_RX_FDIR: return "PKT_RX_FDIR";
361 case PKT_RX_L4_CKSUM_BAD: return "PKT_RX_L4_CKSUM_BAD";
362 case PKT_RX_L4_CKSUM_GOOD: return "PKT_RX_L4_CKSUM_GOOD";
363 case PKT_RX_L4_CKSUM_NONE: return "PKT_RX_L4_CKSUM_NONE";
364 case PKT_RX_IP_CKSUM_BAD: return "PKT_RX_IP_CKSUM_BAD";
365 case PKT_RX_IP_CKSUM_GOOD: return "PKT_RX_IP_CKSUM_GOOD";
366 case PKT_RX_IP_CKSUM_NONE: return "PKT_RX_IP_CKSUM_NONE";
367 case PKT_RX_EIP_CKSUM_BAD: return "PKT_RX_EIP_CKSUM_BAD";
368 case PKT_RX_VLAN_STRIPPED: return "PKT_RX_VLAN_STRIPPED";
369 case PKT_RX_IEEE1588_PTP: return "PKT_RX_IEEE1588_PTP";
370 case PKT_RX_IEEE1588_TMST: return "PKT_RX_IEEE1588_TMST";
371 case PKT_RX_FDIR_ID: return "PKT_RX_FDIR_ID";
372 case PKT_RX_FDIR_FLX: return "PKT_RX_FDIR_FLX";
373 case PKT_RX_QINQ_STRIPPED: return "PKT_RX_QINQ_STRIPPED";
374 case PKT_RX_QINQ: return "PKT_RX_QINQ";
375 case PKT_RX_LRO: return "PKT_RX_LRO";
376 case PKT_RX_TIMESTAMP: return "PKT_RX_TIMESTAMP";
377 case PKT_RX_SEC_OFFLOAD: return "PKT_RX_SEC_OFFLOAD";
378 case PKT_RX_SEC_OFFLOAD_FAILED: return "PKT_RX_SEC_OFFLOAD_FAILED";
379 case PKT_RX_OUTER_L4_CKSUM_BAD: return "PKT_RX_OUTER_L4_CKSUM_BAD";
380 case PKT_RX_OUTER_L4_CKSUM_GOOD: return "PKT_RX_OUTER_L4_CKSUM_GOOD";
381 case PKT_RX_OUTER_L4_CKSUM_INVALID:
382 return "PKT_RX_OUTER_L4_CKSUM_INVALID";
384 default: return NULL;
391 const char *default_name;
394 /* write the list of rx ol flags in buffer buf */
396 rte_get_rx_ol_flag_list(uint64_t mask, char *buf, size_t buflen)
398 const struct flag_mask rx_flags[] = {
399 { PKT_RX_VLAN, PKT_RX_VLAN, NULL },
400 { PKT_RX_RSS_HASH, PKT_RX_RSS_HASH, NULL },
401 { PKT_RX_FDIR, PKT_RX_FDIR, NULL },
402 { PKT_RX_L4_CKSUM_BAD, PKT_RX_L4_CKSUM_MASK, NULL },
403 { PKT_RX_L4_CKSUM_GOOD, PKT_RX_L4_CKSUM_MASK, NULL },
404 { PKT_RX_L4_CKSUM_NONE, PKT_RX_L4_CKSUM_MASK, NULL },
405 { PKT_RX_L4_CKSUM_UNKNOWN, PKT_RX_L4_CKSUM_MASK,
406 "PKT_RX_L4_CKSUM_UNKNOWN" },
407 { PKT_RX_IP_CKSUM_BAD, PKT_RX_IP_CKSUM_MASK, NULL },
408 { PKT_RX_IP_CKSUM_GOOD, PKT_RX_IP_CKSUM_MASK, NULL },
409 { PKT_RX_IP_CKSUM_NONE, PKT_RX_IP_CKSUM_MASK, NULL },
410 { PKT_RX_IP_CKSUM_UNKNOWN, PKT_RX_IP_CKSUM_MASK,
411 "PKT_RX_IP_CKSUM_UNKNOWN" },
412 { PKT_RX_EIP_CKSUM_BAD, PKT_RX_EIP_CKSUM_BAD, NULL },
413 { PKT_RX_VLAN_STRIPPED, PKT_RX_VLAN_STRIPPED, NULL },
414 { PKT_RX_IEEE1588_PTP, PKT_RX_IEEE1588_PTP, NULL },
415 { PKT_RX_IEEE1588_TMST, PKT_RX_IEEE1588_TMST, NULL },
416 { PKT_RX_FDIR_ID, PKT_RX_FDIR_ID, NULL },
417 { PKT_RX_FDIR_FLX, PKT_RX_FDIR_FLX, NULL },
418 { PKT_RX_QINQ_STRIPPED, PKT_RX_QINQ_STRIPPED, NULL },
419 { PKT_RX_LRO, PKT_RX_LRO, NULL },
420 { PKT_RX_TIMESTAMP, PKT_RX_TIMESTAMP, NULL },
421 { PKT_RX_SEC_OFFLOAD, PKT_RX_SEC_OFFLOAD, NULL },
422 { PKT_RX_SEC_OFFLOAD_FAILED, PKT_RX_SEC_OFFLOAD_FAILED, NULL },
423 { PKT_RX_QINQ, PKT_RX_QINQ, NULL },
424 { PKT_RX_OUTER_L4_CKSUM_BAD, PKT_RX_OUTER_L4_CKSUM_MASK, NULL },
425 { PKT_RX_OUTER_L4_CKSUM_GOOD, PKT_RX_OUTER_L4_CKSUM_MASK,
427 { PKT_RX_OUTER_L4_CKSUM_INVALID, PKT_RX_OUTER_L4_CKSUM_MASK,
429 { PKT_RX_OUTER_L4_CKSUM_UNKNOWN, PKT_RX_OUTER_L4_CKSUM_MASK,
430 "PKT_RX_OUTER_L4_CKSUM_UNKNOWN" },
440 for (i = 0; i < RTE_DIM(rx_flags); i++) {
441 if ((mask & rx_flags[i].mask) != rx_flags[i].flag)
443 name = rte_get_rx_ol_flag_name(rx_flags[i].flag);
445 name = rx_flags[i].default_name;
446 ret = snprintf(buf, buflen, "%s ", name);
449 if ((size_t)ret >= buflen)
459 * Get the name of a TX offload flag. Must be kept synchronized with flag
460 * definitions in rte_mbuf.h.
462 const char *rte_get_tx_ol_flag_name(uint64_t mask)
465 case PKT_TX_VLAN: return "PKT_TX_VLAN";
466 case PKT_TX_IP_CKSUM: return "PKT_TX_IP_CKSUM";
467 case PKT_TX_TCP_CKSUM: return "PKT_TX_TCP_CKSUM";
468 case PKT_TX_SCTP_CKSUM: return "PKT_TX_SCTP_CKSUM";
469 case PKT_TX_UDP_CKSUM: return "PKT_TX_UDP_CKSUM";
470 case PKT_TX_IEEE1588_TMST: return "PKT_TX_IEEE1588_TMST";
471 case PKT_TX_TCP_SEG: return "PKT_TX_TCP_SEG";
472 case PKT_TX_IPV4: return "PKT_TX_IPV4";
473 case PKT_TX_IPV6: return "PKT_TX_IPV6";
474 case PKT_TX_OUTER_IP_CKSUM: return "PKT_TX_OUTER_IP_CKSUM";
475 case PKT_TX_OUTER_IPV4: return "PKT_TX_OUTER_IPV4";
476 case PKT_TX_OUTER_IPV6: return "PKT_TX_OUTER_IPV6";
477 case PKT_TX_TUNNEL_VXLAN: return "PKT_TX_TUNNEL_VXLAN";
478 case PKT_TX_TUNNEL_GRE: return "PKT_TX_TUNNEL_GRE";
479 case PKT_TX_TUNNEL_IPIP: return "PKT_TX_TUNNEL_IPIP";
480 case PKT_TX_TUNNEL_GENEVE: return "PKT_TX_TUNNEL_GENEVE";
481 case PKT_TX_TUNNEL_MPLSINUDP: return "PKT_TX_TUNNEL_MPLSINUDP";
482 case PKT_TX_TUNNEL_VXLAN_GPE: return "PKT_TX_TUNNEL_VXLAN_GPE";
483 case PKT_TX_TUNNEL_IP: return "PKT_TX_TUNNEL_IP";
484 case PKT_TX_TUNNEL_UDP: return "PKT_TX_TUNNEL_UDP";
485 case PKT_TX_QINQ: return "PKT_TX_QINQ";
486 case PKT_TX_MACSEC: return "PKT_TX_MACSEC";
487 case PKT_TX_SEC_OFFLOAD: return "PKT_TX_SEC_OFFLOAD";
488 case PKT_TX_UDP_SEG: return "PKT_TX_UDP_SEG";
489 case PKT_TX_OUTER_UDP_CKSUM: return "PKT_TX_OUTER_UDP_CKSUM";
490 case PKT_TX_METADATA: return "PKT_TX_METADATA";
491 default: return NULL;
495 /* write the list of tx ol flags in buffer buf */
497 rte_get_tx_ol_flag_list(uint64_t mask, char *buf, size_t buflen)
499 const struct flag_mask tx_flags[] = {
500 { PKT_TX_VLAN, PKT_TX_VLAN, NULL },
501 { PKT_TX_IP_CKSUM, PKT_TX_IP_CKSUM, NULL },
502 { PKT_TX_TCP_CKSUM, PKT_TX_L4_MASK, NULL },
503 { PKT_TX_SCTP_CKSUM, PKT_TX_L4_MASK, NULL },
504 { PKT_TX_UDP_CKSUM, PKT_TX_L4_MASK, NULL },
505 { PKT_TX_L4_NO_CKSUM, PKT_TX_L4_MASK, "PKT_TX_L4_NO_CKSUM" },
506 { PKT_TX_IEEE1588_TMST, PKT_TX_IEEE1588_TMST, NULL },
507 { PKT_TX_TCP_SEG, PKT_TX_TCP_SEG, NULL },
508 { PKT_TX_IPV4, PKT_TX_IPV4, NULL },
509 { PKT_TX_IPV6, PKT_TX_IPV6, NULL },
510 { PKT_TX_OUTER_IP_CKSUM, PKT_TX_OUTER_IP_CKSUM, NULL },
511 { PKT_TX_OUTER_IPV4, PKT_TX_OUTER_IPV4, NULL },
512 { PKT_TX_OUTER_IPV6, PKT_TX_OUTER_IPV6, NULL },
513 { PKT_TX_TUNNEL_VXLAN, PKT_TX_TUNNEL_MASK, NULL },
514 { PKT_TX_TUNNEL_GRE, PKT_TX_TUNNEL_MASK, NULL },
515 { PKT_TX_TUNNEL_IPIP, PKT_TX_TUNNEL_MASK, NULL },
516 { PKT_TX_TUNNEL_GENEVE, PKT_TX_TUNNEL_MASK, NULL },
517 { PKT_TX_TUNNEL_MPLSINUDP, PKT_TX_TUNNEL_MASK, NULL },
518 { PKT_TX_TUNNEL_VXLAN_GPE, PKT_TX_TUNNEL_MASK, NULL },
519 { PKT_TX_TUNNEL_IP, PKT_TX_TUNNEL_MASK, NULL },
520 { PKT_TX_TUNNEL_UDP, PKT_TX_TUNNEL_MASK, NULL },
521 { PKT_TX_QINQ, PKT_TX_QINQ, NULL },
522 { PKT_TX_MACSEC, PKT_TX_MACSEC, NULL },
523 { PKT_TX_SEC_OFFLOAD, PKT_TX_SEC_OFFLOAD, NULL },
524 { PKT_TX_UDP_SEG, PKT_TX_UDP_SEG, NULL },
525 { PKT_TX_OUTER_UDP_CKSUM, PKT_TX_OUTER_UDP_CKSUM, NULL },
526 { PKT_TX_METADATA, PKT_TX_METADATA, NULL },
536 for (i = 0; i < RTE_DIM(tx_flags); i++) {
537 if ((mask & tx_flags[i].mask) != tx_flags[i].flag)
539 name = rte_get_tx_ol_flag_name(tx_flags[i].flag);
541 name = tx_flags[i].default_name;
542 ret = snprintf(buf, buflen, "%s ", name);
545 if ((size_t)ret >= buflen)