1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2014 Intel Corporation.
3 * Copyright 2014 6WIND S.A.
13 * The mbuf library provides the ability to create and destroy buffers
14 * that may be used by the RTE application to store message
15 * buffers. The message buffers are stored in a mempool, using the
16 * RTE mempool library.
18 * The preferred way to create a mbuf pool is to use
19 * rte_pktmbuf_pool_create(). However, in some situations, an
20 * application may want to have more control (ex: populate the pool with
21 * specific memory), in this case it is possible to use functions from
22 * rte_mempool. See how rte_pktmbuf_pool_create() is implemented for
25 * This library provides an API to allocate/free packet mbufs, which are
26 * used to carry network packets.
28 * To understand the concepts of packet buffers or mbufs, you
29 * should read "TCP/IP Illustrated, Volume 2: The Implementation,
30 * Addison-Wesley, 1995, ISBN 0-201-63354-X from Richard Stevens"
31 * http://www.kohala.com/start/tcpipiv2.html
35 #include <rte_compat.h>
36 #include <rte_common.h>
37 #include <rte_config.h>
38 #include <rte_mempool.h>
39 #include <rte_memory.h>
40 #include <rte_atomic.h>
41 #include <rte_prefetch.h>
42 #include <rte_branch_prediction.h>
43 #include <rte_mbuf_ptype.h>
50 * Packet Offload Features Flags. It also carry packet type information.
51 * Critical resources. Both rx/tx shared these bits. Be cautious on any change
53 * - RX flags start at bit position zero, and get added to the left of previous
55 * - The most-significant 3 bits are reserved for generic mbuf flags
56 * - TX flags therefore start at bit position 60 (i.e. 63-3), and new flags get
57 * added to the right of the previously defined flags i.e. they should count
58 * downwards, not upwards.
60 * Keep these flags synchronized with rte_get_rx_ol_flag_name() and
61 * rte_get_tx_ol_flag_name().
65 * The RX packet is a 802.1q VLAN packet, and the tci has been
66 * saved in in mbuf->vlan_tci.
67 * If the flag PKT_RX_VLAN_STRIPPED is also present, the VLAN
68 * header has been stripped from mbuf data, else it is still
71 #define PKT_RX_VLAN (1ULL << 0)
73 #define PKT_RX_RSS_HASH (1ULL << 1) /**< RX packet with RSS hash result. */
74 #define PKT_RX_FDIR (1ULL << 2) /**< RX packet with FDIR match indicate. */
78 * Checking this flag alone is deprecated: check the 2 bits of
79 * PKT_RX_L4_CKSUM_MASK.
80 * This flag was set when the L4 checksum of a packet was detected as
81 * wrong by the hardware.
83 #define PKT_RX_L4_CKSUM_BAD (1ULL << 3)
87 * Checking this flag alone is deprecated: check the 2 bits of
88 * PKT_RX_IP_CKSUM_MASK.
89 * This flag was set when the IP checksum of a packet was detected as
90 * wrong by the hardware.
92 #define PKT_RX_IP_CKSUM_BAD (1ULL << 4)
94 #define PKT_RX_EIP_CKSUM_BAD (1ULL << 5) /**< External IP header checksum error. */
97 * A vlan has been stripped by the hardware and its tci is saved in
98 * mbuf->vlan_tci. This can only happen if vlan stripping is enabled
99 * in the RX configuration of the PMD.
100 * When PKT_RX_VLAN_STRIPPED is set, PKT_RX_VLAN must also be set.
102 #define PKT_RX_VLAN_STRIPPED (1ULL << 6)
105 * Mask of bits used to determine the status of RX IP checksum.
106 * - PKT_RX_IP_CKSUM_UNKNOWN: no information about the RX IP checksum
107 * - PKT_RX_IP_CKSUM_BAD: the IP checksum in the packet is wrong
108 * - PKT_RX_IP_CKSUM_GOOD: the IP checksum in the packet is valid
109 * - PKT_RX_IP_CKSUM_NONE: the IP checksum is not correct in the packet
110 * data, but the integrity of the IP header is verified.
112 #define PKT_RX_IP_CKSUM_MASK ((1ULL << 4) | (1ULL << 7))
114 #define PKT_RX_IP_CKSUM_UNKNOWN 0
115 #define PKT_RX_IP_CKSUM_BAD (1ULL << 4)
116 #define PKT_RX_IP_CKSUM_GOOD (1ULL << 7)
117 #define PKT_RX_IP_CKSUM_NONE ((1ULL << 4) | (1ULL << 7))
120 * Mask of bits used to determine the status of RX L4 checksum.
121 * - PKT_RX_L4_CKSUM_UNKNOWN: no information about the RX L4 checksum
122 * - PKT_RX_L4_CKSUM_BAD: the L4 checksum in the packet is wrong
123 * - PKT_RX_L4_CKSUM_GOOD: the L4 checksum in the packet is valid
124 * - PKT_RX_L4_CKSUM_NONE: the L4 checksum is not correct in the packet
125 * data, but the integrity of the L4 data is verified.
127 #define PKT_RX_L4_CKSUM_MASK ((1ULL << 3) | (1ULL << 8))
129 #define PKT_RX_L4_CKSUM_UNKNOWN 0
130 #define PKT_RX_L4_CKSUM_BAD (1ULL << 3)
131 #define PKT_RX_L4_CKSUM_GOOD (1ULL << 8)
132 #define PKT_RX_L4_CKSUM_NONE ((1ULL << 3) | (1ULL << 8))
134 #define PKT_RX_IEEE1588_PTP (1ULL << 9) /**< RX IEEE1588 L2 Ethernet PT Packet. */
135 #define PKT_RX_IEEE1588_TMST (1ULL << 10) /**< RX IEEE1588 L2/L4 timestamped packet.*/
136 #define PKT_RX_FDIR_ID (1ULL << 13) /**< FD id reported if FDIR match. */
137 #define PKT_RX_FDIR_FLX (1ULL << 14) /**< Flexible bytes reported if FDIR match. */
140 * The 2 vlans have been stripped by the hardware and their tci are
141 * saved in mbuf->vlan_tci (inner) and mbuf->vlan_tci_outer (outer).
142 * This can only happen if vlan stripping is enabled in the RX
143 * configuration of the PMD.
144 * When PKT_RX_QINQ_STRIPPED is set, the flags (PKT_RX_VLAN |
145 * PKT_RX_VLAN_STRIPPED | PKT_RX_QINQ) must also be set.
147 #define PKT_RX_QINQ_STRIPPED (1ULL << 15)
150 * When packets are coalesced by a hardware or virtual driver, this flag
151 * can be set in the RX mbuf, meaning that the m->tso_segsz field is
152 * valid and is set to the segment size of original packets.
154 #define PKT_RX_LRO (1ULL << 16)
157 * Indicate that the timestamp field in the mbuf is valid.
159 #define PKT_RX_TIMESTAMP (1ULL << 17)
162 * Indicate that security offload processing was applied on the RX packet.
164 #define PKT_RX_SEC_OFFLOAD (1ULL << 18)
167 * Indicate that security offload processing failed on the RX packet.
169 #define PKT_RX_SEC_OFFLOAD_FAILED (1ULL << 19)
172 * The RX packet is a double VLAN, and the outer tci has been
173 * saved in in mbuf->vlan_tci_outer. If PKT_RX_QINQ set, PKT_RX_VLAN
174 * also should be set and inner tci should be saved to mbuf->vlan_tci.
175 * If the flag PKT_RX_QINQ_STRIPPED is also present, both VLANs
176 * headers have been stripped from mbuf data, else they are still
179 #define PKT_RX_QINQ (1ULL << 20)
182 * Mask of bits used to determine the status of outer RX L4 checksum.
183 * - PKT_RX_OUTER_L4_CKSUM_UNKNOWN: no info about the outer RX L4 checksum
184 * - PKT_RX_OUTER_L4_CKSUM_BAD: the outer L4 checksum in the packet is wrong
185 * - PKT_RX_OUTER_L4_CKSUM_GOOD: the outer L4 checksum in the packet is valid
186 * - PKT_RX_OUTER_L4_CKSUM_INVALID: invalid outer L4 checksum state.
188 * The detection of PKT_RX_OUTER_L4_CKSUM_GOOD shall be based on the given
189 * HW capability, At minimum, the PMD should support
190 * PKT_RX_OUTER_L4_CKSUM_UNKNOWN and PKT_RX_OUTER_L4_CKSUM_BAD states
191 * if the DEV_RX_OFFLOAD_OUTER_UDP_CKSUM offload is available.
193 #define PKT_RX_OUTER_L4_CKSUM_MASK ((1ULL << 21) | (1ULL << 22))
195 #define PKT_RX_OUTER_L4_CKSUM_UNKNOWN 0
196 #define PKT_RX_OUTER_L4_CKSUM_BAD (1ULL << 21)
197 #define PKT_RX_OUTER_L4_CKSUM_GOOD (1ULL << 22)
198 #define PKT_RX_OUTER_L4_CKSUM_INVALID ((1ULL << 21) | (1ULL << 22))
200 /* add new RX flags here */
202 /* add new TX flags here */
205 * Indicate that the metadata field in the mbuf is in use.
207 #define PKT_TX_METADATA (1ULL << 40)
210 * Outer UDP checksum offload flag. This flag is used for enabling
211 * outer UDP checksum in PMD. To use outer UDP checksum, the user needs to
212 * 1) Enable the following in mbuff,
213 * a) Fill outer_l2_len and outer_l3_len in mbuf.
214 * b) Set the PKT_TX_OUTER_UDP_CKSUM flag.
215 * c) Set the PKT_TX_OUTER_IPV4 or PKT_TX_OUTER_IPV6 flag.
216 * 2) Configure DEV_TX_OFFLOAD_OUTER_UDP_CKSUM offload flag.
218 #define PKT_TX_OUTER_UDP_CKSUM (1ULL << 41)
221 * UDP Fragmentation Offload flag. This flag is used for enabling UDP
222 * fragmentation in SW or in HW. When use UFO, mbuf->tso_segsz is used
223 * to store the MSS of UDP fragments.
225 #define PKT_TX_UDP_SEG (1ULL << 42)
228 * Request security offload processing on the TX packet.
230 #define PKT_TX_SEC_OFFLOAD (1ULL << 43)
233 * Offload the MACsec. This flag must be set by the application to enable
234 * this offload feature for a packet to be transmitted.
236 #define PKT_TX_MACSEC (1ULL << 44)
239 * Bits 45:48 used for the tunnel type.
240 * The tunnel type must be specified for TSO or checksum on the inner part
242 * These flags can be used with PKT_TX_TCP_SEG for TSO, or PKT_TX_xxx_CKSUM.
243 * The mbuf fields for inner and outer header lengths are required:
244 * outer_l2_len, outer_l3_len, l2_len, l3_len, l4_len and tso_segsz for TSO.
246 #define PKT_TX_TUNNEL_VXLAN (0x1ULL << 45)
247 #define PKT_TX_TUNNEL_GRE (0x2ULL << 45)
248 #define PKT_TX_TUNNEL_IPIP (0x3ULL << 45)
249 #define PKT_TX_TUNNEL_GENEVE (0x4ULL << 45)
250 /** TX packet with MPLS-in-UDP RFC 7510 header. */
251 #define PKT_TX_TUNNEL_MPLSINUDP (0x5ULL << 45)
252 #define PKT_TX_TUNNEL_VXLAN_GPE (0x6ULL << 45)
254 * Generic IP encapsulated tunnel type, used for TSO and checksum offload.
255 * It can be used for tunnels which are not standards or listed above.
256 * It is preferred to use specific tunnel flags like PKT_TX_TUNNEL_GRE
257 * or PKT_TX_TUNNEL_IPIP if possible.
258 * The ethdev must be configured with DEV_TX_OFFLOAD_IP_TNL_TSO.
259 * Outer and inner checksums are done according to the existing flags like
261 * Specific tunnel headers that contain payload length, sequence id
262 * or checksum are not expected to be updated.
264 #define PKT_TX_TUNNEL_IP (0xDULL << 45)
266 * Generic UDP encapsulated tunnel type, used for TSO and checksum offload.
267 * UDP tunnel type implies outer IP layer.
268 * It can be used for tunnels which are not standards or listed above.
269 * It is preferred to use specific tunnel flags like PKT_TX_TUNNEL_VXLAN
271 * The ethdev must be configured with DEV_TX_OFFLOAD_UDP_TNL_TSO.
272 * Outer and inner checksums are done according to the existing flags like
274 * Specific tunnel headers that contain payload length, sequence id
275 * or checksum are not expected to be updated.
277 #define PKT_TX_TUNNEL_UDP (0xEULL << 45)
278 /* add new TX TUNNEL type here */
279 #define PKT_TX_TUNNEL_MASK (0xFULL << 45)
282 * Second VLAN insertion (QinQ) flag.
284 #define PKT_TX_QINQ (1ULL << 49) /**< TX packet with double VLAN inserted. */
285 /* this old name is deprecated */
286 #define PKT_TX_QINQ_PKT PKT_TX_QINQ
289 * TCP segmentation offload. To enable this offload feature for a
290 * packet to be transmitted on hardware supporting TSO:
291 * - set the PKT_TX_TCP_SEG flag in mbuf->ol_flags (this flag implies
293 * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6
294 * - if it's IPv4, set the PKT_TX_IP_CKSUM flag
295 * - fill the mbuf offload information: l2_len, l3_len, l4_len, tso_segsz
297 #define PKT_TX_TCP_SEG (1ULL << 50)
299 #define PKT_TX_IEEE1588_TMST (1ULL << 51) /**< TX IEEE1588 packet to timestamp. */
302 * Bits 52+53 used for L4 packet type with checksum enabled: 00: Reserved,
303 * 01: TCP checksum, 10: SCTP checksum, 11: UDP checksum. To use hardware
304 * L4 checksum offload, the user needs to:
305 * - fill l2_len and l3_len in mbuf
306 * - set the flags PKT_TX_TCP_CKSUM, PKT_TX_SCTP_CKSUM or PKT_TX_UDP_CKSUM
307 * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6
309 #define PKT_TX_L4_NO_CKSUM (0ULL << 52) /**< Disable L4 cksum of TX pkt. */
310 #define PKT_TX_TCP_CKSUM (1ULL << 52) /**< TCP cksum of TX pkt. computed by NIC. */
311 #define PKT_TX_SCTP_CKSUM (2ULL << 52) /**< SCTP cksum of TX pkt. computed by NIC. */
312 #define PKT_TX_UDP_CKSUM (3ULL << 52) /**< UDP cksum of TX pkt. computed by NIC. */
313 #define PKT_TX_L4_MASK (3ULL << 52) /**< Mask for L4 cksum offload request. */
316 * Offload the IP checksum in the hardware. The flag PKT_TX_IPV4 should
317 * also be set by the application, although a PMD will only check
319 * - fill the mbuf offload information: l2_len, l3_len
321 #define PKT_TX_IP_CKSUM (1ULL << 54)
324 * Packet is IPv4. This flag must be set when using any offload feature
325 * (TSO, L3 or L4 checksum) to tell the NIC that the packet is an IPv4
326 * packet. If the packet is a tunneled packet, this flag is related to
329 #define PKT_TX_IPV4 (1ULL << 55)
332 * Packet is IPv6. This flag must be set when using an offload feature
333 * (TSO or L4 checksum) to tell the NIC that the packet is an IPv6
334 * packet. If the packet is a tunneled packet, this flag is related to
337 #define PKT_TX_IPV6 (1ULL << 56)
340 * TX packet is a 802.1q VLAN packet.
342 #define PKT_TX_VLAN (1ULL << 57)
343 /* this old name is deprecated */
344 #define PKT_TX_VLAN_PKT PKT_TX_VLAN
347 * Offload the IP checksum of an external header in the hardware. The
348 * flag PKT_TX_OUTER_IPV4 should also be set by the application, although
349 * a PMD will only check PKT_TX_OUTER_IP_CKSUM.
350 * - fill the mbuf offload information: outer_l2_len, outer_l3_len
352 #define PKT_TX_OUTER_IP_CKSUM (1ULL << 58)
355 * Packet outer header is IPv4. This flag must be set when using any
356 * outer offload feature (L3 or L4 checksum) to tell the NIC that the
357 * outer header of the tunneled packet is an IPv4 packet.
359 #define PKT_TX_OUTER_IPV4 (1ULL << 59)
362 * Packet outer header is IPv6. This flag must be set when using any
363 * outer offload feature (L4 checksum) to tell the NIC that the outer
364 * header of the tunneled packet is an IPv6 packet.
366 #define PKT_TX_OUTER_IPV6 (1ULL << 60)
369 * Bitmask of all supported packet Tx offload features flags,
370 * which can be set for packet.
372 #define PKT_TX_OFFLOAD_MASK ( \
373 PKT_TX_OUTER_IPV6 | \
374 PKT_TX_OUTER_IPV4 | \
375 PKT_TX_OUTER_IP_CKSUM | \
381 PKT_TX_IEEE1588_TMST | \
384 PKT_TX_TUNNEL_MASK | \
386 PKT_TX_SEC_OFFLOAD | \
388 PKT_TX_OUTER_UDP_CKSUM | \
392 * Mbuf having an external buffer attached. shinfo in mbuf must be filled.
394 #define EXT_ATTACHED_MBUF (1ULL << 61)
396 #define IND_ATTACHED_MBUF (1ULL << 62) /**< Indirect attached mbuf */
398 /** Alignment constraint of mbuf private area. */
399 #define RTE_MBUF_PRIV_ALIGN 8
402 * Get the name of a RX offload flag
405 * The mask describing the flag.
407 * The name of this flag, or NULL if it's not a valid RX flag.
409 const char *rte_get_rx_ol_flag_name(uint64_t mask);
412 * Dump the list of RX offload flags in a buffer
415 * The mask describing the RX flags.
419 * The length of the buffer.
421 * 0 on success, (-1) on error.
423 int rte_get_rx_ol_flag_list(uint64_t mask, char *buf, size_t buflen);
426 * Get the name of a TX offload flag
429 * The mask describing the flag. Usually only one bit must be set.
430 * Several bits can be given if they belong to the same mask.
431 * Ex: PKT_TX_L4_MASK.
433 * The name of this flag, or NULL if it's not a valid TX flag.
435 const char *rte_get_tx_ol_flag_name(uint64_t mask);
438 * Dump the list of TX offload flags in a buffer
441 * The mask describing the TX flags.
445 * The length of the buffer.
447 * 0 on success, (-1) on error.
449 int rte_get_tx_ol_flag_list(uint64_t mask, char *buf, size_t buflen);
452 * Some NICs need at least 2KB buffer to RX standard Ethernet frame without
453 * splitting it into multiple segments.
454 * So, for mbufs that planned to be involved into RX/TX, the recommended
455 * minimal buffer length is 2KB + RTE_PKTMBUF_HEADROOM.
457 #define RTE_MBUF_DEFAULT_DATAROOM 2048
458 #define RTE_MBUF_DEFAULT_BUF_SIZE \
459 (RTE_MBUF_DEFAULT_DATAROOM + RTE_PKTMBUF_HEADROOM)
461 /* define a set of marker types that can be used to refer to set points in the
464 typedef void *MARKER[0]; /**< generic marker for a point in a structure */
466 typedef uint8_t MARKER8[0]; /**< generic marker with 1B alignment */
468 typedef uint64_t MARKER64[0]; /**< marker that allows us to overwrite 8 bytes
469 * with a single assignment */
471 struct rte_mbuf_sched {
472 uint32_t queue_id; /**< Queue ID. */
473 uint8_t traffic_class;
474 /**< Traffic class ID. Traffic class 0
475 * is the highest priority traffic class.
478 /**< Color. @see enum rte_color.*/
479 uint16_t reserved; /**< Reserved. */
480 }; /**< Hierarchical scheduler */
483 * The generic rte_mbuf, containing a packet mbuf.
488 void *buf_addr; /**< Virtual address of segment buffer. */
490 * Physical address of segment buffer.
491 * Force alignment to 8-bytes, so as to ensure we have the exact
492 * same mbuf cacheline0 layout for 32-bit and 64-bit. This makes
493 * working on vector drivers easier.
498 rte_iova_t buf_physaddr; /**< deprecated */
499 } __rte_aligned(sizeof(rte_iova_t));
501 /* next 8 bytes are initialised on RX descriptor rearm */
506 * Reference counter. Its size should at least equal to the size
507 * of port field (16 bits), to support zero-copy broadcast.
508 * It should only be accessed using the following functions:
509 * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and
510 * rte_mbuf_refcnt_set(). The functionality of these functions (atomic,
511 * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC
516 rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */
517 uint16_t refcnt; /**< Non-atomically accessed refcnt */
519 uint16_t nb_segs; /**< Number of segments. */
521 /** Input port (16 bits to support more than 256 virtual ports).
522 * The event eth Tx adapter uses this field to specify the output port.
526 uint64_t ol_flags; /**< Offload features. */
528 /* remaining bytes are set on RX when pulling packet from descriptor */
529 MARKER rx_descriptor_fields1;
532 * The packet type, which is the combination of outer/inner L2, L3, L4
533 * and tunnel types. The packet_type is about data really present in the
534 * mbuf. Example: if vlan stripping is enabled, a received vlan packet
535 * would have RTE_PTYPE_L2_ETHER and not RTE_PTYPE_L2_VLAN because the
536 * vlan is stripped from the data.
540 uint32_t packet_type; /**< L2/L3/L4 and tunnel information. */
542 uint32_t l2_type:4; /**< (Outer) L2 type. */
543 uint32_t l3_type:4; /**< (Outer) L3 type. */
544 uint32_t l4_type:4; /**< (Outer) L4 type. */
545 uint32_t tun_type:4; /**< Tunnel type. */
548 uint8_t inner_esp_next_proto;
549 /**< ESP next protocol type, valid if
550 * RTE_PTYPE_TUNNEL_ESP tunnel type is set
555 uint8_t inner_l2_type:4;
556 /**< Inner L2 type. */
557 uint8_t inner_l3_type:4;
558 /**< Inner L3 type. */
561 uint32_t inner_l4_type:4; /**< Inner L4 type. */
565 uint32_t pkt_len; /**< Total pkt len: sum of all segments. */
566 uint16_t data_len; /**< Amount of data in segment buffer. */
567 /** VLAN TCI (CPU order), valid if PKT_RX_VLAN is set. */
573 uint32_t rss; /**< RSS hash result if RSS enabled */
581 /**< Second 4 flexible bytes */
584 /**< First 4 flexible bytes or FD ID, dependent
585 * on PKT_RX_FDIR_* flag in ol_flags.
587 } fdir; /**< Filter identifier if FDIR enabled */
588 struct rte_mbuf_sched sched;
589 /**< Hierarchical scheduler : 8 bytes */
594 /**< The event eth Tx adapter uses this field
595 * to store Tx queue id.
596 * @see rte_event_eth_tx_adapter_txq_set()
598 } txadapter; /**< Eventdev ethdev Tx adapter */
599 /**< User defined tags. See rte_distributor_process() */
601 } hash; /**< hash information */
604 * Application specific metadata value
605 * for egress flow rule match.
606 * Valid if PKT_TX_METADATA is set.
607 * Located here to allow conjunct use
608 * with hash.sched.hi.
610 uint32_t tx_metadata;
615 /** Outer VLAN TCI (CPU order), valid if PKT_RX_QINQ is set. */
616 uint16_t vlan_tci_outer;
618 uint16_t buf_len; /**< Length of segment buffer. */
620 /** Valid if PKT_RX_TIMESTAMP is set. The unit and time reference
621 * are not normalized but are always the same for a given port.
625 /* second cache line - fields only used in slow path or on TX */
626 MARKER cacheline1 __rte_cache_min_aligned;
630 void *userdata; /**< Can be used for external metadata */
631 uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */
634 struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */
635 struct rte_mbuf *next; /**< Next segment of scattered packet. */
637 /* fields to support TX offloads */
640 uint64_t tx_offload; /**< combined for easy fetch */
644 /**< L2 (MAC) Header Length for non-tunneling pkt.
645 * Outer_L4_len + ... + Inner_L2_len for tunneling pkt.
647 uint64_t l3_len:9; /**< L3 (IP) Header Length. */
648 uint64_t l4_len:8; /**< L4 (TCP/UDP) Header Length. */
649 uint64_t tso_segsz:16; /**< TCP TSO segment size */
651 /* fields for TX offloading of tunnels */
652 uint64_t outer_l3_len:9; /**< Outer L3 (IP) Hdr Length. */
653 uint64_t outer_l2_len:7; /**< Outer L2 (MAC) Hdr Length. */
655 /* uint64_t unused:8; */
659 /** Size of the application private data. In case of an indirect
660 * mbuf, it stores the direct mbuf private data size. */
663 /** Timesync flags for use with IEEE1588. */
666 /** Sequence number. See also rte_reorder_insert(). */
669 /** Shared data for external buffer attached to mbuf. See
670 * rte_pktmbuf_attach_extbuf().
672 struct rte_mbuf_ext_shared_info *shinfo;
674 } __rte_cache_aligned;
677 * Function typedef of callback to free externally attached buffer.
679 typedef void (*rte_mbuf_extbuf_free_callback_t)(void *addr, void *opaque);
682 * Shared data at the end of an external buffer.
684 struct rte_mbuf_ext_shared_info {
685 rte_mbuf_extbuf_free_callback_t free_cb; /**< Free callback function */
686 void *fcb_opaque; /**< Free callback argument */
687 rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */
690 /**< Maximum number of nb_segs allowed. */
691 #define RTE_MBUF_MAX_NB_SEGS UINT16_MAX
694 * Prefetch the first part of the mbuf
696 * The first 64 bytes of the mbuf corresponds to fields that are used early
697 * in the receive path. If the cache line of the architecture is higher than
698 * 64B, the second part will also be prefetched.
701 * The pointer to the mbuf.
704 rte_mbuf_prefetch_part1(struct rte_mbuf *m)
706 rte_prefetch0(&m->cacheline0);
710 * Prefetch the second part of the mbuf
712 * The next 64 bytes of the mbuf corresponds to fields that are used in the
713 * transmit path. If the cache line of the architecture is higher than 64B,
714 * this function does nothing as it is expected that the full mbuf is
718 * The pointer to the mbuf.
721 rte_mbuf_prefetch_part2(struct rte_mbuf *m)
723 #if RTE_CACHE_LINE_SIZE == 64
724 rte_prefetch0(&m->cacheline1);
731 static inline uint16_t rte_pktmbuf_priv_size(struct rte_mempool *mp);
734 * Return the IO address of the beginning of the mbuf data
737 * The pointer to the mbuf.
739 * The IO address of the beginning of the mbuf data
741 static inline rte_iova_t
742 rte_mbuf_data_iova(const struct rte_mbuf *mb)
744 return mb->buf_iova + mb->data_off;
748 static inline phys_addr_t
749 rte_mbuf_data_dma_addr(const struct rte_mbuf *mb)
751 return rte_mbuf_data_iova(mb);
755 * Return the default IO address of the beginning of the mbuf data
757 * This function is used by drivers in their receive function, as it
758 * returns the location where data should be written by the NIC, taking
759 * the default headroom in account.
762 * The pointer to the mbuf.
764 * The IO address of the beginning of the mbuf data
766 static inline rte_iova_t
767 rte_mbuf_data_iova_default(const struct rte_mbuf *mb)
769 return mb->buf_iova + RTE_PKTMBUF_HEADROOM;
773 static inline phys_addr_t
774 rte_mbuf_data_dma_addr_default(const struct rte_mbuf *mb)
776 return rte_mbuf_data_iova_default(mb);
780 * Return the mbuf owning the data buffer address of an indirect mbuf.
783 * The pointer to the indirect mbuf.
785 * The address of the direct mbuf corresponding to buffer_addr.
787 static inline struct rte_mbuf *
788 rte_mbuf_from_indirect(struct rte_mbuf *mi)
790 return (struct rte_mbuf *)RTE_PTR_SUB(mi->buf_addr, sizeof(*mi) + mi->priv_size);
794 * Return address of buffer embedded in the given mbuf.
796 * The return value shall be same as mb->buf_addr if the mbuf is already
797 * initialized and direct. However, this API is useful if mempool of the
798 * mbuf is already known because it doesn't need to access mbuf contents in
799 * order to get the mempool pointer.
802 * @b EXPERIMENTAL: This API may change without prior notice.
803 * This will be used by rte_mbuf_to_baddr() which has redundant code once
804 * experimental tag is removed.
807 * The pointer to the mbuf.
809 * The pointer to the mempool of the mbuf.
811 * The pointer of the mbuf buffer.
813 static inline char * __rte_experimental
814 rte_mbuf_buf_addr(struct rte_mbuf *mb, struct rte_mempool *mp)
816 return (char *)mb + sizeof(*mb) + rte_pktmbuf_priv_size(mp);
820 * Return the default address of the beginning of the mbuf data.
823 * @b EXPERIMENTAL: This API may change without prior notice.
826 * The pointer to the mbuf.
828 * The pointer of the beginning of the mbuf data.
830 static inline char * __rte_experimental
831 rte_mbuf_data_addr_default(struct rte_mbuf *mb)
833 return rte_mbuf_buf_addr(mb, mb->pool) + RTE_PKTMBUF_HEADROOM;
837 * Return address of buffer embedded in the given mbuf.
839 * @note: Accessing mempool pointer of a mbuf is expensive because the
840 * pointer is stored in the 2nd cache line of mbuf. If mempool is known, it
841 * is better not to reference the mempool pointer in mbuf but calling
842 * rte_mbuf_buf_addr() would be more efficient.
845 * The pointer to the mbuf.
847 * The address of the data buffer owned by the mbuf.
850 rte_mbuf_to_baddr(struct rte_mbuf *md)
852 #ifdef ALLOW_EXPERIMENTAL_API
853 return rte_mbuf_buf_addr(md, md->pool);
856 buffer_addr = (char *)md + sizeof(*md) + rte_pktmbuf_priv_size(md->pool);
862 * Return the starting address of the private data area embedded in
865 * Note that no check is made to ensure that a private data area
866 * actually exists in the supplied mbuf.
869 * The pointer to the mbuf.
871 * The starting address of the private data area of the given mbuf.
873 static inline void * __rte_experimental
874 rte_mbuf_to_priv(struct rte_mbuf *m)
876 return RTE_PTR_ADD(m, sizeof(struct rte_mbuf));
880 * Returns TRUE if given mbuf is cloned by mbuf indirection, or FALSE
883 * If a mbuf has its data in another mbuf and references it by mbuf
884 * indirection, this mbuf can be defined as a cloned mbuf.
886 #define RTE_MBUF_CLONED(mb) ((mb)->ol_flags & IND_ATTACHED_MBUF)
889 * Returns TRUE if given mbuf has an external buffer, or FALSE otherwise.
891 * External buffer is a user-provided anonymous buffer.
893 #define RTE_MBUF_HAS_EXTBUF(mb) ((mb)->ol_flags & EXT_ATTACHED_MBUF)
896 * Returns TRUE if given mbuf is direct, or FALSE otherwise.
898 * If a mbuf embeds its own data after the rte_mbuf structure, this mbuf
899 * can be defined as a direct mbuf.
901 #define RTE_MBUF_DIRECT(mb) \
902 (!((mb)->ol_flags & (IND_ATTACHED_MBUF | EXT_ATTACHED_MBUF)))
905 * Private data in case of pktmbuf pool.
907 * A structure that contains some pktmbuf_pool-specific data that are
908 * appended after the mempool structure (in private data).
910 struct rte_pktmbuf_pool_private {
911 uint16_t mbuf_data_room_size; /**< Size of data space in each mbuf. */
912 uint16_t mbuf_priv_size; /**< Size of private area in each mbuf. */
915 #ifdef RTE_LIBRTE_MBUF_DEBUG
917 /** check mbuf type in debug mode */
918 #define __rte_mbuf_sanity_check(m, is_h) rte_mbuf_sanity_check(m, is_h)
920 #else /* RTE_LIBRTE_MBUF_DEBUG */
922 /** check mbuf type in debug mode */
923 #define __rte_mbuf_sanity_check(m, is_h) do { } while (0)
925 #endif /* RTE_LIBRTE_MBUF_DEBUG */
927 #ifdef RTE_MBUF_REFCNT_ATOMIC
930 * Reads the value of an mbuf's refcnt.
934 * Reference count number.
936 static inline uint16_t
937 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
939 return (uint16_t)(rte_atomic16_read(&m->refcnt_atomic));
943 * Sets an mbuf's refcnt to a defined value.
950 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
952 rte_atomic16_set(&m->refcnt_atomic, (int16_t)new_value);
956 static inline uint16_t
957 __rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
959 return (uint16_t)(rte_atomic16_add_return(&m->refcnt_atomic, value));
963 * Adds given value to an mbuf's refcnt and returns its new value.
967 * Value to add/subtract
971 static inline uint16_t
972 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
975 * The atomic_add is an expensive operation, so we don't want to
976 * call it in the case where we know we are the uniq holder of
977 * this mbuf (i.e. ref_cnt == 1). Otherwise, an atomic
978 * operation has to be used because concurrent accesses on the
979 * reference counter can occur.
981 if (likely(rte_mbuf_refcnt_read(m) == 1)) {
983 rte_mbuf_refcnt_set(m, (uint16_t)value);
984 return (uint16_t)value;
987 return __rte_mbuf_refcnt_update(m, value);
990 #else /* ! RTE_MBUF_REFCNT_ATOMIC */
993 static inline uint16_t
994 __rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
996 m->refcnt = (uint16_t)(m->refcnt + value);
1001 * Adds given value to an mbuf's refcnt and returns its new value.
1003 static inline uint16_t
1004 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
1006 return __rte_mbuf_refcnt_update(m, value);
1010 * Reads the value of an mbuf's refcnt.
1012 static inline uint16_t
1013 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
1019 * Sets an mbuf's refcnt to the defined value.
1022 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
1024 m->refcnt = new_value;
1027 #endif /* RTE_MBUF_REFCNT_ATOMIC */
1030 * Reads the refcnt of an external buffer.
1033 * Shared data of the external buffer.
1035 * Reference count number.
1037 static inline uint16_t
1038 rte_mbuf_ext_refcnt_read(const struct rte_mbuf_ext_shared_info *shinfo)
1040 return (uint16_t)(rte_atomic16_read(&shinfo->refcnt_atomic));
1044 * Set refcnt of an external buffer.
1047 * Shared data of the external buffer.
1052 rte_mbuf_ext_refcnt_set(struct rte_mbuf_ext_shared_info *shinfo,
1055 rte_atomic16_set(&shinfo->refcnt_atomic, (int16_t)new_value);
1059 * Add given value to refcnt of an external buffer and return its new
1063 * Shared data of the external buffer.
1065 * Value to add/subtract
1069 static inline uint16_t
1070 rte_mbuf_ext_refcnt_update(struct rte_mbuf_ext_shared_info *shinfo,
1073 if (likely(rte_mbuf_ext_refcnt_read(shinfo) == 1)) {
1075 rte_mbuf_ext_refcnt_set(shinfo, (uint16_t)value);
1076 return (uint16_t)value;
1079 return (uint16_t)rte_atomic16_add_return(&shinfo->refcnt_atomic, value);
1082 /** Mbuf prefetch */
1083 #define RTE_MBUF_PREFETCH_TO_FREE(m) do { \
1090 * Sanity checks on an mbuf.
1092 * Check the consistency of the given mbuf. The function will cause a
1093 * panic if corruption is detected.
1096 * The mbuf to be checked.
1098 * True if the mbuf is a packet header, false if it is a sub-segment
1099 * of a packet (in this case, some fields like nb_segs are not checked)
1102 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header);
1105 * Sanity checks on a mbuf.
1107 * Almost like rte_mbuf_sanity_check(), but this function gives the reason
1108 * if corruption is detected rather than panic.
1111 * The mbuf to be checked.
1113 * True if the mbuf is a packet header, false if it is a sub-segment
1114 * of a packet (in this case, some fields like nb_segs are not checked)
1116 * A reference to a string pointer where to store the reason why a mbuf is
1117 * considered invalid.
1119 * - 0 if no issue has been found, reason is left untouched.
1120 * - -1 if a problem is detected, reason then points to a string describing
1121 * the reason why the mbuf is deemed invalid.
1124 int rte_mbuf_check(const struct rte_mbuf *m, int is_header,
1125 const char **reason);
1127 #define MBUF_RAW_ALLOC_CHECK(m) do { \
1128 RTE_ASSERT(rte_mbuf_refcnt_read(m) == 1); \
1129 RTE_ASSERT((m)->next == NULL); \
1130 RTE_ASSERT((m)->nb_segs == 1); \
1131 __rte_mbuf_sanity_check(m, 0); \
1135 * Allocate an uninitialized mbuf from mempool *mp*.
1137 * This function can be used by PMDs (especially in RX functions) to
1138 * allocate an uninitialized mbuf. The driver is responsible of
1139 * initializing all the required fields. See rte_pktmbuf_reset().
1140 * For standard needs, prefer rte_pktmbuf_alloc().
1142 * The caller can expect that the following fields of the mbuf structure
1143 * are initialized: buf_addr, buf_iova, buf_len, refcnt=1, nb_segs=1,
1144 * next=NULL, pool, priv_size. The other fields must be initialized
1148 * The mempool from which mbuf is allocated.
1150 * - The pointer to the new mbuf on success.
1151 * - NULL if allocation failed.
1153 static inline struct rte_mbuf *rte_mbuf_raw_alloc(struct rte_mempool *mp)
1157 if (rte_mempool_get(mp, (void **)&m) < 0)
1159 MBUF_RAW_ALLOC_CHECK(m);
1164 * Put mbuf back into its original mempool.
1166 * The caller must ensure that the mbuf is direct and properly
1167 * reinitialized (refcnt=1, next=NULL, nb_segs=1), as done by
1168 * rte_pktmbuf_prefree_seg().
1170 * This function should be used with care, when optimization is
1171 * required. For standard needs, prefer rte_pktmbuf_free() or
1172 * rte_pktmbuf_free_seg().
1175 * The mbuf to be freed.
1177 static __rte_always_inline void
1178 rte_mbuf_raw_free(struct rte_mbuf *m)
1180 RTE_ASSERT(RTE_MBUF_DIRECT(m));
1181 RTE_ASSERT(rte_mbuf_refcnt_read(m) == 1);
1182 RTE_ASSERT(m->next == NULL);
1183 RTE_ASSERT(m->nb_segs == 1);
1184 __rte_mbuf_sanity_check(m, 0);
1185 rte_mempool_put(m->pool, m);
1189 * The packet mbuf constructor.
1191 * This function initializes some fields in the mbuf structure that are
1192 * not modified by the user once created (origin pool, buffer start
1193 * address, and so on). This function is given as a callback function to
1194 * rte_mempool_obj_iter() or rte_mempool_create() at pool creation time.
1197 * The mempool from which mbufs originate.
1199 * A pointer that can be used by the user to retrieve useful information
1200 * for mbuf initialization. This pointer is the opaque argument passed to
1201 * rte_mempool_obj_iter() or rte_mempool_create().
1203 * The mbuf to initialize.
1205 * The index of the mbuf in the pool table.
1207 void rte_pktmbuf_init(struct rte_mempool *mp, void *opaque_arg,
1208 void *m, unsigned i);
1212 * A packet mbuf pool constructor.
1214 * This function initializes the mempool private data in the case of a
1215 * pktmbuf pool. This private data is needed by the driver. The
1216 * function must be called on the mempool before it is used, or it
1217 * can be given as a callback function to rte_mempool_create() at
1218 * pool creation. It can be extended by the user, for example, to
1219 * provide another packet size.
1222 * The mempool from which mbufs originate.
1224 * A pointer that can be used by the user to retrieve useful information
1225 * for mbuf initialization. This pointer is the opaque argument passed to
1226 * rte_mempool_create().
1228 void rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg);
1231 * Create a mbuf pool.
1233 * This function creates and initializes a packet mbuf pool. It is
1234 * a wrapper to rte_mempool functions.
1237 * The name of the mbuf pool.
1239 * The number of elements in the mbuf pool. The optimum size (in terms
1240 * of memory usage) for a mempool is when n is a power of two minus one:
1243 * Size of the per-core object cache. See rte_mempool_create() for
1246 * Size of application private are between the rte_mbuf structure
1247 * and the data buffer. This value must be aligned to RTE_MBUF_PRIV_ALIGN.
1248 * @param data_room_size
1249 * Size of data buffer in each mbuf, including RTE_PKTMBUF_HEADROOM.
1251 * The socket identifier where the memory should be allocated. The
1252 * value can be *SOCKET_ID_ANY* if there is no NUMA constraint for the
1255 * The pointer to the new allocated mempool, on success. NULL on error
1256 * with rte_errno set appropriately. Possible rte_errno values include:
1257 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
1258 * - E_RTE_SECONDARY - function was called from a secondary process instance
1259 * - EINVAL - cache size provided is too large, or priv_size is not aligned.
1260 * - ENOSPC - the maximum number of memzones has already been allocated
1261 * - EEXIST - a memzone with the same name already exists
1262 * - ENOMEM - no appropriate memory area found in which to create memzone
1264 struct rte_mempool *
1265 rte_pktmbuf_pool_create(const char *name, unsigned n,
1266 unsigned cache_size, uint16_t priv_size, uint16_t data_room_size,
1270 * Create a mbuf pool with a given mempool ops name
1272 * This function creates and initializes a packet mbuf pool. It is
1273 * a wrapper to rte_mempool functions.
1276 * The name of the mbuf pool.
1278 * The number of elements in the mbuf pool. The optimum size (in terms
1279 * of memory usage) for a mempool is when n is a power of two minus one:
1282 * Size of the per-core object cache. See rte_mempool_create() for
1285 * Size of application private are between the rte_mbuf structure
1286 * and the data buffer. This value must be aligned to RTE_MBUF_PRIV_ALIGN.
1287 * @param data_room_size
1288 * Size of data buffer in each mbuf, including RTE_PKTMBUF_HEADROOM.
1290 * The socket identifier where the memory should be allocated. The
1291 * value can be *SOCKET_ID_ANY* if there is no NUMA constraint for the
1294 * The mempool ops name to be used for this mempool instead of
1295 * default mempool. The value can be *NULL* to use default mempool.
1297 * The pointer to the new allocated mempool, on success. NULL on error
1298 * with rte_errno set appropriately. Possible rte_errno values include:
1299 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
1300 * - E_RTE_SECONDARY - function was called from a secondary process instance
1301 * - EINVAL - cache size provided is too large, or priv_size is not aligned.
1302 * - ENOSPC - the maximum number of memzones has already been allocated
1303 * - EEXIST - a memzone with the same name already exists
1304 * - ENOMEM - no appropriate memory area found in which to create memzone
1306 struct rte_mempool *
1307 rte_pktmbuf_pool_create_by_ops(const char *name, unsigned int n,
1308 unsigned int cache_size, uint16_t priv_size, uint16_t data_room_size,
1309 int socket_id, const char *ops_name);
1312 * Get the data room size of mbufs stored in a pktmbuf_pool
1314 * The data room size is the amount of data that can be stored in a
1315 * mbuf including the headroom (RTE_PKTMBUF_HEADROOM).
1318 * The packet mbuf pool.
1320 * The data room size of mbufs stored in this mempool.
1322 static inline uint16_t
1323 rte_pktmbuf_data_room_size(struct rte_mempool *mp)
1325 struct rte_pktmbuf_pool_private *mbp_priv;
1327 mbp_priv = (struct rte_pktmbuf_pool_private *)rte_mempool_get_priv(mp);
1328 return mbp_priv->mbuf_data_room_size;
1332 * Get the application private size of mbufs stored in a pktmbuf_pool
1334 * The private size of mbuf is a zone located between the rte_mbuf
1335 * structure and the data buffer where an application can store data
1336 * associated to a packet.
1339 * The packet mbuf pool.
1341 * The private size of mbufs stored in this mempool.
1343 static inline uint16_t
1344 rte_pktmbuf_priv_size(struct rte_mempool *mp)
1346 struct rte_pktmbuf_pool_private *mbp_priv;
1348 mbp_priv = (struct rte_pktmbuf_pool_private *)rte_mempool_get_priv(mp);
1349 return mbp_priv->mbuf_priv_size;
1353 * Reset the data_off field of a packet mbuf to its default value.
1355 * The given mbuf must have only one segment, which should be empty.
1358 * The packet mbuf's data_off field has to be reset.
1360 static inline void rte_pktmbuf_reset_headroom(struct rte_mbuf *m)
1362 m->data_off = (uint16_t)RTE_MIN((uint16_t)RTE_PKTMBUF_HEADROOM,
1363 (uint16_t)m->buf_len);
1367 * Reset the fields of a packet mbuf to their default values.
1369 * The given mbuf must have only one segment.
1372 * The packet mbuf to be resetted.
1374 #define MBUF_INVALID_PORT UINT16_MAX
1376 static inline void rte_pktmbuf_reset(struct rte_mbuf *m)
1382 m->vlan_tci_outer = 0;
1384 m->port = MBUF_INVALID_PORT;
1388 rte_pktmbuf_reset_headroom(m);
1391 __rte_mbuf_sanity_check(m, 1);
1395 * Allocate a new mbuf from a mempool.
1397 * This new mbuf contains one segment, which has a length of 0. The pointer
1398 * to data is initialized to have some bytes of headroom in the buffer
1399 * (if buffer size allows).
1402 * The mempool from which the mbuf is allocated.
1404 * - The pointer to the new mbuf on success.
1405 * - NULL if allocation failed.
1407 static inline struct rte_mbuf *rte_pktmbuf_alloc(struct rte_mempool *mp)
1410 if ((m = rte_mbuf_raw_alloc(mp)) != NULL)
1411 rte_pktmbuf_reset(m);
1416 * Allocate a bulk of mbufs, initialize refcnt and reset the fields to default
1420 * The mempool from which mbufs are allocated.
1422 * Array of pointers to mbufs
1427 * - -ENOENT: Not enough entries in the mempool; no mbufs are retrieved.
1429 static inline int rte_pktmbuf_alloc_bulk(struct rte_mempool *pool,
1430 struct rte_mbuf **mbufs, unsigned count)
1435 rc = rte_mempool_get_bulk(pool, (void **)mbufs, count);
1439 /* To understand duff's device on loop unwinding optimization, see
1440 * https://en.wikipedia.org/wiki/Duff's_device.
1441 * Here while() loop is used rather than do() while{} to avoid extra
1442 * check if count is zero.
1444 switch (count % 4) {
1446 while (idx != count) {
1447 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1448 rte_pktmbuf_reset(mbufs[idx]);
1452 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1453 rte_pktmbuf_reset(mbufs[idx]);
1457 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1458 rte_pktmbuf_reset(mbufs[idx]);
1462 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1463 rte_pktmbuf_reset(mbufs[idx]);
1472 * Initialize shared data at the end of an external buffer before attaching
1473 * to a mbuf by ``rte_pktmbuf_attach_extbuf()``. This is not a mandatory
1474 * initialization but a helper function to simply spare a few bytes at the
1475 * end of the buffer for shared data. If shared data is allocated
1476 * separately, this should not be called but application has to properly
1477 * initialize the shared data according to its need.
1479 * Free callback and its argument is saved and the refcnt is set to 1.
1482 * The value of buf_len will be reduced to RTE_PTR_DIFF(shinfo, buf_addr)
1483 * after this initialization. This shall be used for
1484 * ``rte_pktmbuf_attach_extbuf()``
1487 * The pointer to the external buffer.
1488 * @param [in,out] buf_len
1489 * The pointer to length of the external buffer. Input value must be
1490 * larger than the size of ``struct rte_mbuf_ext_shared_info`` and
1491 * padding for alignment. If not enough, this function will return NULL.
1492 * Adjusted buffer length will be returned through this pointer.
1494 * Free callback function to call when the external buffer needs to be
1497 * Argument for the free callback function.
1500 * A pointer to the initialized shared data on success, return NULL
1503 static inline struct rte_mbuf_ext_shared_info *
1504 rte_pktmbuf_ext_shinfo_init_helper(void *buf_addr, uint16_t *buf_len,
1505 rte_mbuf_extbuf_free_callback_t free_cb, void *fcb_opaque)
1507 struct rte_mbuf_ext_shared_info *shinfo;
1508 void *buf_end = RTE_PTR_ADD(buf_addr, *buf_len);
1511 addr = RTE_PTR_ALIGN_FLOOR(RTE_PTR_SUB(buf_end, sizeof(*shinfo)),
1513 if (addr <= buf_addr)
1516 shinfo = (struct rte_mbuf_ext_shared_info *)addr;
1517 shinfo->free_cb = free_cb;
1518 shinfo->fcb_opaque = fcb_opaque;
1519 rte_mbuf_ext_refcnt_set(shinfo, 1);
1521 *buf_len = (uint16_t)RTE_PTR_DIFF(shinfo, buf_addr);
1526 * Attach an external buffer to a mbuf.
1528 * User-managed anonymous buffer can be attached to an mbuf. When attaching
1529 * it, corresponding free callback function and its argument should be
1530 * provided via shinfo. This callback function will be called once all the
1531 * mbufs are detached from the buffer (refcnt becomes zero).
1533 * The headroom for the attaching mbuf will be set to zero and this can be
1534 * properly adjusted after attachment. For example, ``rte_pktmbuf_adj()``
1535 * or ``rte_pktmbuf_reset_headroom()`` might be used.
1537 * More mbufs can be attached to the same external buffer by
1538 * ``rte_pktmbuf_attach()`` once the external buffer has been attached by
1541 * Detachment can be done by either ``rte_pktmbuf_detach_extbuf()`` or
1542 * ``rte_pktmbuf_detach()``.
1544 * Memory for shared data must be provided and user must initialize all of
1545 * the content properly, escpecially free callback and refcnt. The pointer
1546 * of shared data will be stored in m->shinfo.
1547 * ``rte_pktmbuf_ext_shinfo_init_helper`` can help to simply spare a few
1548 * bytes at the end of buffer for the shared data, store free callback and
1549 * its argument and set the refcnt to 1. The following is an example:
1551 * struct rte_mbuf_ext_shared_info *shinfo =
1552 * rte_pktmbuf_ext_shinfo_init_helper(buf_addr, &buf_len,
1553 * free_cb, fcb_arg);
1554 * rte_pktmbuf_attach_extbuf(m, buf_addr, buf_iova, buf_len, shinfo);
1555 * rte_pktmbuf_reset_headroom(m);
1556 * rte_pktmbuf_adj(m, data_len);
1558 * Attaching an external buffer is quite similar to mbuf indirection in
1559 * replacing buffer addresses and length of a mbuf, but a few differences:
1560 * - When an indirect mbuf is attached, refcnt of the direct mbuf would be
1561 * 2 as long as the direct mbuf itself isn't freed after the attachment.
1562 * In such cases, the buffer area of a direct mbuf must be read-only. But
1563 * external buffer has its own refcnt and it starts from 1. Unless
1564 * multiple mbufs are attached to a mbuf having an external buffer, the
1565 * external buffer is writable.
1566 * - There's no need to allocate buffer from a mempool. Any buffer can be
1567 * attached with appropriate free callback and its IO address.
1568 * - Smaller metadata is required to maintain shared data such as refcnt.
1571 * The pointer to the mbuf.
1573 * The pointer to the external buffer.
1575 * IO address of the external buffer.
1577 * The size of the external buffer.
1579 * User-provided memory for shared data of the external buffer.
1582 rte_pktmbuf_attach_extbuf(struct rte_mbuf *m, void *buf_addr,
1583 rte_iova_t buf_iova, uint16_t buf_len,
1584 struct rte_mbuf_ext_shared_info *shinfo)
1586 /* mbuf should not be read-only */
1587 RTE_ASSERT(RTE_MBUF_DIRECT(m) && rte_mbuf_refcnt_read(m) == 1);
1588 RTE_ASSERT(shinfo->free_cb != NULL);
1590 m->buf_addr = buf_addr;
1591 m->buf_iova = buf_iova;
1592 m->buf_len = buf_len;
1597 m->ol_flags |= EXT_ATTACHED_MBUF;
1602 * Detach the external buffer attached to a mbuf, same as
1603 * ``rte_pktmbuf_detach()``
1606 * The mbuf having external buffer.
1608 #define rte_pktmbuf_detach_extbuf(m) rte_pktmbuf_detach(m)
1611 * Attach packet mbuf to another packet mbuf.
1613 * If the mbuf we are attaching to isn't a direct buffer and is attached to
1614 * an external buffer, the mbuf being attached will be attached to the
1615 * external buffer instead of mbuf indirection.
1617 * Otherwise, the mbuf will be indirectly attached. After attachment we
1618 * refer the mbuf we attached as 'indirect', while mbuf we attached to as
1619 * 'direct'. The direct mbuf's reference counter is incremented.
1621 * Right now, not supported:
1622 * - attachment for already indirect mbuf (e.g. - mi has to be direct).
1623 * - mbuf we trying to attach (mi) is used by someone else
1624 * e.g. it's reference counter is greater then 1.
1627 * The indirect packet mbuf.
1629 * The packet mbuf we're attaching to.
1631 static inline void rte_pktmbuf_attach(struct rte_mbuf *mi, struct rte_mbuf *m)
1633 RTE_ASSERT(RTE_MBUF_DIRECT(mi) &&
1634 rte_mbuf_refcnt_read(mi) == 1);
1636 if (RTE_MBUF_HAS_EXTBUF(m)) {
1637 rte_mbuf_ext_refcnt_update(m->shinfo, 1);
1638 mi->ol_flags = m->ol_flags;
1639 mi->shinfo = m->shinfo;
1641 /* if m is not direct, get the mbuf that embeds the data */
1642 rte_mbuf_refcnt_update(rte_mbuf_from_indirect(m), 1);
1643 mi->priv_size = m->priv_size;
1644 mi->ol_flags = m->ol_flags | IND_ATTACHED_MBUF;
1647 mi->buf_iova = m->buf_iova;
1648 mi->buf_addr = m->buf_addr;
1649 mi->buf_len = m->buf_len;
1651 mi->data_off = m->data_off;
1652 mi->data_len = m->data_len;
1654 mi->vlan_tci = m->vlan_tci;
1655 mi->vlan_tci_outer = m->vlan_tci_outer;
1656 mi->tx_offload = m->tx_offload;
1660 mi->pkt_len = mi->data_len;
1662 mi->packet_type = m->packet_type;
1663 mi->timestamp = m->timestamp;
1665 __rte_mbuf_sanity_check(mi, 1);
1666 __rte_mbuf_sanity_check(m, 0);
1670 * @internal used by rte_pktmbuf_detach().
1672 * Decrement the reference counter of the external buffer. When the
1673 * reference counter becomes 0, the buffer is freed by pre-registered
1677 __rte_pktmbuf_free_extbuf(struct rte_mbuf *m)
1679 RTE_ASSERT(RTE_MBUF_HAS_EXTBUF(m));
1680 RTE_ASSERT(m->shinfo != NULL);
1682 if (rte_mbuf_ext_refcnt_update(m->shinfo, -1) == 0)
1683 m->shinfo->free_cb(m->buf_addr, m->shinfo->fcb_opaque);
1687 * @internal used by rte_pktmbuf_detach().
1689 * Decrement the direct mbuf's reference counter. When the reference
1690 * counter becomes 0, the direct mbuf is freed.
1693 __rte_pktmbuf_free_direct(struct rte_mbuf *m)
1695 struct rte_mbuf *md;
1697 RTE_ASSERT(RTE_MBUF_CLONED(m));
1699 md = rte_mbuf_from_indirect(m);
1701 if (rte_mbuf_refcnt_update(md, -1) == 0) {
1704 rte_mbuf_refcnt_set(md, 1);
1705 rte_mbuf_raw_free(md);
1710 * Detach a packet mbuf from external buffer or direct buffer.
1712 * - decrement refcnt and free the external/direct buffer if refcnt
1714 * - restore original mbuf address and length values.
1715 * - reset pktmbuf data and data_len to their default values.
1717 * All other fields of the given packet mbuf will be left intact.
1720 * The indirect attached packet mbuf.
1722 static inline void rte_pktmbuf_detach(struct rte_mbuf *m)
1724 struct rte_mempool *mp = m->pool;
1725 uint32_t mbuf_size, buf_len;
1728 if (RTE_MBUF_HAS_EXTBUF(m))
1729 __rte_pktmbuf_free_extbuf(m);
1731 __rte_pktmbuf_free_direct(m);
1733 priv_size = rte_pktmbuf_priv_size(mp);
1734 mbuf_size = (uint32_t)(sizeof(struct rte_mbuf) + priv_size);
1735 buf_len = rte_pktmbuf_data_room_size(mp);
1737 m->priv_size = priv_size;
1738 m->buf_addr = (char *)m + mbuf_size;
1739 m->buf_iova = rte_mempool_virt2iova(m) + mbuf_size;
1740 m->buf_len = (uint16_t)buf_len;
1741 rte_pktmbuf_reset_headroom(m);
1747 * Decrease reference counter and unlink a mbuf segment
1749 * This function does the same than a free, except that it does not
1750 * return the segment to its pool.
1751 * It decreases the reference counter, and if it reaches 0, it is
1752 * detached from its parent for an indirect mbuf.
1755 * The mbuf to be unlinked
1757 * - (m) if it is the last reference. It can be recycled or freed.
1758 * - (NULL) if the mbuf still has remaining references on it.
1760 static __rte_always_inline struct rte_mbuf *
1761 rte_pktmbuf_prefree_seg(struct rte_mbuf *m)
1763 __rte_mbuf_sanity_check(m, 0);
1765 if (likely(rte_mbuf_refcnt_read(m) == 1)) {
1767 if (!RTE_MBUF_DIRECT(m))
1768 rte_pktmbuf_detach(m);
1770 if (m->next != NULL) {
1777 } else if (__rte_mbuf_refcnt_update(m, -1) == 0) {
1779 if (!RTE_MBUF_DIRECT(m))
1780 rte_pktmbuf_detach(m);
1782 if (m->next != NULL) {
1786 rte_mbuf_refcnt_set(m, 1);
1794 * Free a segment of a packet mbuf into its original mempool.
1796 * Free an mbuf, without parsing other segments in case of chained
1800 * The packet mbuf segment to be freed.
1802 static __rte_always_inline void
1803 rte_pktmbuf_free_seg(struct rte_mbuf *m)
1805 m = rte_pktmbuf_prefree_seg(m);
1806 if (likely(m != NULL))
1807 rte_mbuf_raw_free(m);
1811 * Free a packet mbuf back into its original mempool.
1813 * Free an mbuf, and all its segments in case of chained buffers. Each
1814 * segment is added back into its original mempool.
1817 * The packet mbuf to be freed. If NULL, the function does nothing.
1819 static inline void rte_pktmbuf_free(struct rte_mbuf *m)
1821 struct rte_mbuf *m_next;
1824 __rte_mbuf_sanity_check(m, 1);
1828 rte_pktmbuf_free_seg(m);
1834 * Creates a "clone" of the given packet mbuf.
1836 * Walks through all segments of the given packet mbuf, and for each of them:
1837 * - Creates a new packet mbuf from the given pool.
1838 * - Attaches newly created mbuf to the segment.
1839 * Then updates pkt_len and nb_segs of the "clone" packet mbuf to match values
1840 * from the original packet mbuf.
1843 * The packet mbuf to be cloned.
1845 * The mempool from which the "clone" mbufs are allocated.
1847 * - The pointer to the new "clone" mbuf on success.
1848 * - NULL if allocation fails.
1850 static inline struct rte_mbuf *rte_pktmbuf_clone(struct rte_mbuf *md,
1851 struct rte_mempool *mp)
1853 struct rte_mbuf *mc, *mi, **prev;
1857 if (unlikely ((mc = rte_pktmbuf_alloc(mp)) == NULL))
1862 pktlen = md->pkt_len;
1867 rte_pktmbuf_attach(mi, md);
1870 } while ((md = md->next) != NULL &&
1871 (mi = rte_pktmbuf_alloc(mp)) != NULL);
1875 mc->pkt_len = pktlen;
1877 /* Allocation of new indirect segment failed */
1878 if (unlikely (mi == NULL)) {
1879 rte_pktmbuf_free(mc);
1883 __rte_mbuf_sanity_check(mc, 1);
1888 * Adds given value to the refcnt of all packet mbuf segments.
1890 * Walks through all segments of given packet mbuf and for each of them
1891 * invokes rte_mbuf_refcnt_update().
1894 * The packet mbuf whose refcnt to be updated.
1896 * The value to add to the mbuf's segments refcnt.
1898 static inline void rte_pktmbuf_refcnt_update(struct rte_mbuf *m, int16_t v)
1900 __rte_mbuf_sanity_check(m, 1);
1903 rte_mbuf_refcnt_update(m, v);
1904 } while ((m = m->next) != NULL);
1908 * Get the headroom in a packet mbuf.
1913 * The length of the headroom.
1915 static inline uint16_t rte_pktmbuf_headroom(const struct rte_mbuf *m)
1917 __rte_mbuf_sanity_check(m, 0);
1922 * Get the tailroom of a packet mbuf.
1927 * The length of the tailroom.
1929 static inline uint16_t rte_pktmbuf_tailroom(const struct rte_mbuf *m)
1931 __rte_mbuf_sanity_check(m, 0);
1932 return (uint16_t)(m->buf_len - rte_pktmbuf_headroom(m) -
1937 * Get the last segment of the packet.
1942 * The last segment of the given mbuf.
1944 static inline struct rte_mbuf *rte_pktmbuf_lastseg(struct rte_mbuf *m)
1946 __rte_mbuf_sanity_check(m, 1);
1947 while (m->next != NULL)
1953 * A macro that points to an offset into the data in the mbuf.
1955 * The returned pointer is cast to type t. Before using this
1956 * function, the user must ensure that the first segment is large
1957 * enough to accommodate its data.
1962 * The offset into the mbuf data.
1964 * The type to cast the result into.
1966 #define rte_pktmbuf_mtod_offset(m, t, o) \
1967 ((t)((char *)(m)->buf_addr + (m)->data_off + (o)))
1970 * A macro that points to the start of the data in the mbuf.
1972 * The returned pointer is cast to type t. Before using this
1973 * function, the user must ensure that the first segment is large
1974 * enough to accommodate its data.
1979 * The type to cast the result into.
1981 #define rte_pktmbuf_mtod(m, t) rte_pktmbuf_mtod_offset(m, t, 0)
1984 * A macro that returns the IO address that points to an offset of the
1985 * start of the data in the mbuf
1990 * The offset into the data to calculate address from.
1992 #define rte_pktmbuf_iova_offset(m, o) \
1993 (rte_iova_t)((m)->buf_iova + (m)->data_off + (o))
1996 #define rte_pktmbuf_mtophys_offset(m, o) \
1997 rte_pktmbuf_iova_offset(m, o)
2000 * A macro that returns the IO address that points to the start of the
2006 #define rte_pktmbuf_iova(m) rte_pktmbuf_iova_offset(m, 0)
2009 #define rte_pktmbuf_mtophys(m) rte_pktmbuf_iova(m)
2012 * A macro that returns the length of the packet.
2014 * The value can be read or assigned.
2019 #define rte_pktmbuf_pkt_len(m) ((m)->pkt_len)
2022 * A macro that returns the length of the segment.
2024 * The value can be read or assigned.
2029 #define rte_pktmbuf_data_len(m) ((m)->data_len)
2032 * Prepend len bytes to an mbuf data area.
2034 * Returns a pointer to the new
2035 * data start address. If there is not enough headroom in the first
2036 * segment, the function will return NULL, without modifying the mbuf.
2041 * The amount of data to prepend (in bytes).
2043 * A pointer to the start of the newly prepended data, or
2044 * NULL if there is not enough headroom space in the first segment
2046 static inline char *rte_pktmbuf_prepend(struct rte_mbuf *m,
2049 __rte_mbuf_sanity_check(m, 1);
2051 if (unlikely(len > rte_pktmbuf_headroom(m)))
2054 /* NB: elaborating the subtraction like this instead of using
2055 * -= allows us to ensure the result type is uint16_t
2056 * avoiding compiler warnings on gcc 8.1 at least */
2057 m->data_off = (uint16_t)(m->data_off - len);
2058 m->data_len = (uint16_t)(m->data_len + len);
2059 m->pkt_len = (m->pkt_len + len);
2061 return (char *)m->buf_addr + m->data_off;
2065 * Append len bytes to an mbuf.
2067 * Append len bytes to an mbuf and return a pointer to the start address
2068 * of the added data. If there is not enough tailroom in the last
2069 * segment, the function will return NULL, without modifying the mbuf.
2074 * The amount of data to append (in bytes).
2076 * A pointer to the start of the newly appended data, or
2077 * NULL if there is not enough tailroom space in the last segment
2079 static inline char *rte_pktmbuf_append(struct rte_mbuf *m, uint16_t len)
2082 struct rte_mbuf *m_last;
2084 __rte_mbuf_sanity_check(m, 1);
2086 m_last = rte_pktmbuf_lastseg(m);
2087 if (unlikely(len > rte_pktmbuf_tailroom(m_last)))
2090 tail = (char *)m_last->buf_addr + m_last->data_off + m_last->data_len;
2091 m_last->data_len = (uint16_t)(m_last->data_len + len);
2092 m->pkt_len = (m->pkt_len + len);
2093 return (char*) tail;
2097 * Remove len bytes at the beginning of an mbuf.
2099 * Returns a pointer to the start address of the new data area. If the
2100 * length is greater than the length of the first segment, then the
2101 * function will fail and return NULL, without modifying the mbuf.
2106 * The amount of data to remove (in bytes).
2108 * A pointer to the new start of the data.
2110 static inline char *rte_pktmbuf_adj(struct rte_mbuf *m, uint16_t len)
2112 __rte_mbuf_sanity_check(m, 1);
2114 if (unlikely(len > m->data_len))
2117 /* NB: elaborating the addition like this instead of using
2118 * += allows us to ensure the result type is uint16_t
2119 * avoiding compiler warnings on gcc 8.1 at least */
2120 m->data_len = (uint16_t)(m->data_len - len);
2121 m->data_off = (uint16_t)(m->data_off + len);
2122 m->pkt_len = (m->pkt_len - len);
2123 return (char *)m->buf_addr + m->data_off;
2127 * Remove len bytes of data at the end of the mbuf.
2129 * If the length is greater than the length of the last segment, the
2130 * function will fail and return -1 without modifying the mbuf.
2135 * The amount of data to remove (in bytes).
2140 static inline int rte_pktmbuf_trim(struct rte_mbuf *m, uint16_t len)
2142 struct rte_mbuf *m_last;
2144 __rte_mbuf_sanity_check(m, 1);
2146 m_last = rte_pktmbuf_lastseg(m);
2147 if (unlikely(len > m_last->data_len))
2150 m_last->data_len = (uint16_t)(m_last->data_len - len);
2151 m->pkt_len = (m->pkt_len - len);
2156 * Test if mbuf data is contiguous.
2161 * - 1, if all data is contiguous (one segment).
2162 * - 0, if there is several segments.
2164 static inline int rte_pktmbuf_is_contiguous(const struct rte_mbuf *m)
2166 __rte_mbuf_sanity_check(m, 1);
2167 return !!(m->nb_segs == 1);
2171 * @internal used by rte_pktmbuf_read().
2173 const void *__rte_pktmbuf_read(const struct rte_mbuf *m, uint32_t off,
2174 uint32_t len, void *buf);
2177 * Read len data bytes in a mbuf at specified offset.
2179 * If the data is contiguous, return the pointer in the mbuf data, else
2180 * copy the data in the buffer provided by the user and return its
2184 * The pointer to the mbuf.
2186 * The offset of the data in the mbuf.
2188 * The amount of bytes to read.
2190 * The buffer where data is copied if it is not contiguous in mbuf
2191 * data. Its length should be at least equal to the len parameter.
2193 * The pointer to the data, either in the mbuf if it is contiguous,
2194 * or in the user buffer. If mbuf is too small, NULL is returned.
2196 static inline const void *rte_pktmbuf_read(const struct rte_mbuf *m,
2197 uint32_t off, uint32_t len, void *buf)
2199 if (likely(off + len <= rte_pktmbuf_data_len(m)))
2200 return rte_pktmbuf_mtod_offset(m, char *, off);
2202 return __rte_pktmbuf_read(m, off, len, buf);
2206 * Chain an mbuf to another, thereby creating a segmented packet.
2208 * Note: The implementation will do a linear walk over the segments to find
2209 * the tail entry. For cases when there are many segments, it's better to
2210 * chain the entries manually.
2213 * The head of the mbuf chain (the first packet)
2215 * The mbuf to put last in the chain
2219 * - -EOVERFLOW, if the chain segment limit exceeded
2221 static inline int rte_pktmbuf_chain(struct rte_mbuf *head, struct rte_mbuf *tail)
2223 struct rte_mbuf *cur_tail;
2225 /* Check for number-of-segments-overflow */
2226 if (head->nb_segs + tail->nb_segs > RTE_MBUF_MAX_NB_SEGS)
2229 /* Chain 'tail' onto the old tail */
2230 cur_tail = rte_pktmbuf_lastseg(head);
2231 cur_tail->next = tail;
2233 /* accumulate number of segments and total length.
2234 * NB: elaborating the addition like this instead of using
2235 * -= allows us to ensure the result type is uint16_t
2236 * avoiding compiler warnings on gcc 8.1 at least */
2237 head->nb_segs = (uint16_t)(head->nb_segs + tail->nb_segs);
2238 head->pkt_len += tail->pkt_len;
2240 /* pkt_len is only set in the head */
2241 tail->pkt_len = tail->data_len;
2247 * Validate general requirements for Tx offload in mbuf.
2249 * This function checks correctness and completeness of Tx offload settings.
2252 * The packet mbuf to be validated.
2254 * 0 if packet is valid
2257 rte_validate_tx_offload(const struct rte_mbuf *m)
2259 uint64_t ol_flags = m->ol_flags;
2260 uint64_t inner_l3_offset = m->l2_len;
2262 /* Does packet set any of available offloads? */
2263 if (!(ol_flags & PKT_TX_OFFLOAD_MASK))
2266 if (ol_flags & PKT_TX_OUTER_IP_CKSUM)
2267 /* NB: elaborating the addition like this instead of using
2268 * += gives the result uint64_t type instead of int,
2269 * avoiding compiler warnings on gcc 8.1 at least */
2270 inner_l3_offset = inner_l3_offset + m->outer_l2_len +
2273 /* Headers are fragmented */
2274 if (rte_pktmbuf_data_len(m) < inner_l3_offset + m->l3_len + m->l4_len)
2277 /* IP checksum can be counted only for IPv4 packet */
2278 if ((ol_flags & PKT_TX_IP_CKSUM) && (ol_flags & PKT_TX_IPV6))
2281 /* IP type not set when required */
2282 if (ol_flags & (PKT_TX_L4_MASK | PKT_TX_TCP_SEG))
2283 if (!(ol_flags & (PKT_TX_IPV4 | PKT_TX_IPV6)))
2286 /* Check requirements for TSO packet */
2287 if (ol_flags & PKT_TX_TCP_SEG)
2288 if ((m->tso_segsz == 0) ||
2289 ((ol_flags & PKT_TX_IPV4) &&
2290 !(ol_flags & PKT_TX_IP_CKSUM)))
2293 /* PKT_TX_OUTER_IP_CKSUM set for non outer IPv4 packet. */
2294 if ((ol_flags & PKT_TX_OUTER_IP_CKSUM) &&
2295 !(ol_flags & PKT_TX_OUTER_IPV4))
2302 * Linearize data in mbuf.
2304 * This function moves the mbuf data in the first segment if there is enough
2305 * tailroom. The subsequent segments are unchained and freed.
2314 rte_pktmbuf_linearize(struct rte_mbuf *mbuf)
2316 size_t seg_len, copy_len;
2318 struct rte_mbuf *m_next;
2321 if (rte_pktmbuf_is_contiguous(mbuf))
2324 /* Extend first segment to the total packet length */
2325 copy_len = rte_pktmbuf_pkt_len(mbuf) - rte_pktmbuf_data_len(mbuf);
2327 if (unlikely(copy_len > rte_pktmbuf_tailroom(mbuf)))
2330 buffer = rte_pktmbuf_mtod_offset(mbuf, char *, mbuf->data_len);
2331 mbuf->data_len = (uint16_t)(mbuf->pkt_len);
2333 /* Append data from next segments to the first one */
2338 seg_len = rte_pktmbuf_data_len(m);
2339 rte_memcpy(buffer, rte_pktmbuf_mtod(m, char *), seg_len);
2342 rte_pktmbuf_free_seg(m);
2353 * Dump an mbuf structure to a file.
2355 * Dump all fields for the given packet mbuf and all its associated
2356 * segments (in the case of a chained buffer).
2359 * A pointer to a file for output
2363 * If dump_len != 0, also dump the "dump_len" first data bytes of
2366 void rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len);
2369 * Get the value of mbuf sched queue_id field.
2371 static inline uint32_t
2372 rte_mbuf_sched_queue_get(const struct rte_mbuf *m)
2374 return m->hash.sched.queue_id;
2378 * Get the value of mbuf sched traffic_class field.
2380 static inline uint8_t
2381 rte_mbuf_sched_traffic_class_get(const struct rte_mbuf *m)
2383 return m->hash.sched.traffic_class;
2387 * Get the value of mbuf sched color field.
2389 static inline uint8_t
2390 rte_mbuf_sched_color_get(const struct rte_mbuf *m)
2392 return m->hash.sched.color;
2396 * Get the values of mbuf sched queue_id, traffic_class and color.
2401 * Returns the queue id
2402 * @param traffic_class
2403 * Returns the traffic class id
2405 * Returns the colour id
2408 rte_mbuf_sched_get(const struct rte_mbuf *m, uint32_t *queue_id,
2409 uint8_t *traffic_class,
2412 struct rte_mbuf_sched sched = m->hash.sched;
2414 *queue_id = sched.queue_id;
2415 *traffic_class = sched.traffic_class;
2416 *color = sched.color;
2420 * Set the mbuf sched queue_id to the defined value.
2423 rte_mbuf_sched_queue_set(struct rte_mbuf *m, uint32_t queue_id)
2425 m->hash.sched.queue_id = queue_id;
2429 * Set the mbuf sched traffic_class id to the defined value.
2432 rte_mbuf_sched_traffic_class_set(struct rte_mbuf *m, uint8_t traffic_class)
2434 m->hash.sched.traffic_class = traffic_class;
2438 * Set the mbuf sched color id to the defined value.
2441 rte_mbuf_sched_color_set(struct rte_mbuf *m, uint8_t color)
2443 m->hash.sched.color = color;
2447 * Set the mbuf sched queue_id, traffic_class and color.
2452 * Queue id value to be set
2453 * @param traffic_class
2454 * Traffic class id value to be set
2456 * Color id to be set
2459 rte_mbuf_sched_set(struct rte_mbuf *m, uint32_t queue_id,
2460 uint8_t traffic_class,
2463 m->hash.sched = (struct rte_mbuf_sched){
2464 .queue_id = queue_id,
2465 .traffic_class = traffic_class,
2475 #endif /* _RTE_MBUF_H_ */