xref: /dpdk/lib/mbuf/rte_mbuf_core.h (revision 7be78d02)
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2010-2014 Intel Corporation.
3  * Copyright 2014 6WIND S.A.
4  */
5 
6 #ifndef _RTE_MBUF_CORE_H_
7 #define _RTE_MBUF_CORE_H_
8 
9 /**
10  * @file
11  * This file contains definition of RTE mbuf structure itself,
12  * packet offload flags and some related macros.
13  * For majority of DPDK entities, it is not recommended to include
14  * this file directly, use include <rte_mbuf.h> instead.
15  *
16  * New fields and flags should fit in the "dynamic space".
17  */
18 
19 #include <stdint.h>
20 
21 #include <rte_compat.h>
22 #include <rte_byteorder.h>
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 /*
29  * Packet Offload Features Flags. It also carry packet type information.
30  * Critical resources. Both rx/tx shared these bits. Be cautious on any change
31  *
32  * - RX flags start at bit position zero, and get added to the left of previous
33  *   flags.
34  * - The most-significant 3 bits are reserved for generic mbuf flags
35  * - TX flags therefore start at bit position 60 (i.e. 63-3), and new flags get
36  *   added to the right of the previously defined flags i.e. they should count
37  *   downwards, not upwards.
38  *
39  * Keep these flags synchronized with rte_get_rx_ol_flag_name() and
40  * rte_get_tx_ol_flag_name().
41  */
42 
43 /**
44  * The RX packet is a 802.1q VLAN packet, and the tci has been
45  * saved in in mbuf->vlan_tci.
46  * If the flag RTE_MBUF_F_RX_VLAN_STRIPPED is also present, the VLAN
47  * header has been stripped from mbuf data, else it is still
48  * present.
49  */
50 #define RTE_MBUF_F_RX_VLAN          (1ULL << 0)
51 #define PKT_RX_VLAN RTE_DEPRECATED(PKT_RX_VLAN) RTE_MBUF_F_RX_VLAN
52 
53 /** RX packet with RSS hash result. */
54 #define RTE_MBUF_F_RX_RSS_HASH      (1ULL << 1)
55 #define PKT_RX_RSS_HASH RTE_DEPRECATED(PKT_RX_RSS_HASH) RTE_MBUF_F_RX_RSS_HASH
56 
57  /** RX packet with FDIR match indicate. */
58 #define RTE_MBUF_F_RX_FDIR          (1ULL << 2)
59 #define PKT_RX_FDIR RTE_DEPRECATED(PKT_RX_FDIR) RTE_MBUF_F_RX_FDIR
60 
61 /**
62  * This flag is set when the outermost IP header checksum is detected as
63  * wrong by the hardware.
64  */
65 #define RTE_MBUF_F_RX_OUTER_IP_CKSUM_BAD (1ULL << 5)
66 #define PKT_RX_OUTER_IP_CKSUM_BAD RTE_DEPRECATED(PKT_RX_OUTER_IP_CKSUM_BAD) \
67 		RTE_MBUF_F_RX_OUTER_IP_CKSUM_BAD
68 
69 /**
70  * A vlan has been stripped by the hardware and its tci is saved in
71  * mbuf->vlan_tci. This can only happen if vlan stripping is enabled
72  * in the RX configuration of the PMD.
73  * When RTE_MBUF_F_RX_VLAN_STRIPPED is set, RTE_MBUF_F_RX_VLAN must also be set.
74  */
75 #define RTE_MBUF_F_RX_VLAN_STRIPPED (1ULL << 6)
76 #define PKT_RX_VLAN_STRIPPED RTE_DEPRECATED(PKT_RX_VLAN_STRIPPED) \
77 		RTE_MBUF_F_RX_VLAN_STRIPPED
78 
79 /**
80  * Mask of bits used to determine the status of RX IP checksum.
81  * - RTE_MBUF_F_RX_IP_CKSUM_UNKNOWN: no information about the RX IP checksum
82  * - RTE_MBUF_F_RX_IP_CKSUM_BAD: the IP checksum in the packet is wrong
83  * - RTE_MBUF_F_RX_IP_CKSUM_GOOD: the IP checksum in the packet is valid
84  * - RTE_MBUF_F_RX_IP_CKSUM_NONE: the IP checksum is not correct in the packet
85  *   data, but the integrity of the IP header is verified.
86  */
87 #define RTE_MBUF_F_RX_IP_CKSUM_MASK ((1ULL << 4) | (1ULL << 7))
88 #define PKT_RX_IP_CKSUM_MASK RTE_DEPRECATED(PKT_RX_IP_CKSUM_MASK) \
89 		RTE_MBUF_F_RX_IP_CKSUM_MASK
90 
91 #define RTE_MBUF_F_RX_IP_CKSUM_UNKNOWN 0
92 #define RTE_MBUF_F_RX_IP_CKSUM_BAD     (1ULL << 4)
93 #define RTE_MBUF_F_RX_IP_CKSUM_GOOD    (1ULL << 7)
94 #define RTE_MBUF_F_RX_IP_CKSUM_NONE    ((1ULL << 4) | (1ULL << 7))
95 #define PKT_RX_IP_CKSUM_UNKNOWN RTE_DEPRECATED(PKT_RX_IP_CKSUM_UNKNOWN) \
96 		RTE_MBUF_F_RX_IP_CKSUM_UNKNOWN
97 #define PKT_RX_IP_CKSUM_BAD RTE_DEPRECATED(PKT_RX_IP_CKSUM_BAD) \
98 		RTE_MBUF_F_RX_IP_CKSUM_BAD
99 #define PKT_RX_IP_CKSUM_GOOD RTE_DEPRECATED(PKT_RX_IP_CKSUM_GOOD) \
100 		RTE_MBUF_F_RX_IP_CKSUM_GOOD
101 #define PKT_RX_IP_CKSUM_NONE RTE_DEPRECATED(PKT_RX_IP_CKSUM_NONE) \
102 		RTE_MBUF_F_RX_IP_CKSUM_NONE
103 
104 /**
105  * Mask of bits used to determine the status of RX L4 checksum.
106  * - RTE_MBUF_F_RX_L4_CKSUM_UNKNOWN: no information about the RX L4 checksum
107  * - RTE_MBUF_F_RX_L4_CKSUM_BAD: the L4 checksum in the packet is wrong
108  * - RTE_MBUF_F_RX_L4_CKSUM_GOOD: the L4 checksum in the packet is valid
109  * - RTE_MBUF_F_RX_L4_CKSUM_NONE: the L4 checksum is not correct in the packet
110  *   data, but the integrity of the L4 data is verified.
111  */
112 #define RTE_MBUF_F_RX_L4_CKSUM_MASK ((1ULL << 3) | (1ULL << 8))
113 #define PKT_RX_L4_CKSUM_MASK RTE_DEPRECATED(PKT_RX_L4_CKSUM_MASK) \
114 		RTE_MBUF_F_RX_L4_CKSUM_MASK
115 
116 #define RTE_MBUF_F_RX_L4_CKSUM_UNKNOWN 0
117 #define RTE_MBUF_F_RX_L4_CKSUM_BAD     (1ULL << 3)
118 #define RTE_MBUF_F_RX_L4_CKSUM_GOOD    (1ULL << 8)
119 #define RTE_MBUF_F_RX_L4_CKSUM_NONE    ((1ULL << 3) | (1ULL << 8))
120 #define PKT_RX_L4_CKSUM_UNKNOWN RTE_DEPRECATED(PKT_RX_L4_CKSUM_UNKNOWN) \
121 		RTE_MBUF_F_RX_L4_CKSUM_UNKNOWN
122 #define PKT_RX_L4_CKSUM_BAD RTE_DEPRECATED(PKT_RX_L4_CKSUM_BAD) \
123 		RTE_MBUF_F_RX_L4_CKSUM_BAD
124 #define PKT_RX_L4_CKSUM_GOOD RTE_DEPRECATED(PKT_RX_L4_CKSUM_GOOD) \
125 		RTE_MBUF_F_RX_L4_CKSUM_GOOD
126 #define PKT_RX_L4_CKSUM_NONE RTE_DEPRECATED(PKT_RX_L4_CKSUM_NONE) \
127 		RTE_MBUF_F_RX_L4_CKSUM_NONE
128 
129 /** RX IEEE1588 L2 Ethernet PT Packet. */
130 #define RTE_MBUF_F_RX_IEEE1588_PTP  (1ULL << 9)
131 #define PKT_RX_IEEE1588_PTP RTE_DEPRECATED(PKT_RX_IEEE1588_PTP) \
132 		RTE_MBUF_F_RX_IEEE1588_PTP
133 
134 /** RX IEEE1588 L2/L4 timestamped packet.*/
135 #define RTE_MBUF_F_RX_IEEE1588_TMST (1ULL << 10)
136 #define PKT_RX_IEEE1588_TMST RTE_DEPRECATED(PKT_RX_IEEE1588_TMST) \
137 		RTE_MBUF_F_RX_IEEE1588_TMST
138 
139 /** FD id reported if FDIR match. */
140 #define RTE_MBUF_F_RX_FDIR_ID       (1ULL << 13)
141 #define PKT_RX_FDIR_ID RTE_DEPRECATED(PKT_RX_FDIR_ID) \
142 		RTE_MBUF_F_RX_FDIR_ID
143 
144 /** Flexible bytes reported if FDIR match. */
145 #define RTE_MBUF_F_RX_FDIR_FLX      (1ULL << 14)
146 #define PKT_RX_FDIR_FLX RTE_DEPRECATED(PKT_RX_FDIR_FLX) \
147 		RTE_MBUF_F_RX_FDIR_FLX
148 
149 /**
150  * The outer VLAN has been stripped by the hardware and its TCI is
151  * saved in mbuf->vlan_tci_outer.
152  * This can only happen if VLAN stripping is enabled in the Rx
153  * configuration of the PMD.
154  * When RTE_MBUF_F_RX_QINQ_STRIPPED is set, the flags RTE_MBUF_F_RX_VLAN
155  * and RTE_MBUF_F_RX_QINQ must also be set.
156  *
157  * - If both RTE_MBUF_F_RX_QINQ_STRIPPED and RTE_MBUF_F_RX_VLAN_STRIPPED are
158  *   set, the 2 VLANs have been stripped by the hardware and their TCIs are
159  *   saved in mbuf->vlan_tci (inner) and mbuf->vlan_tci_outer (outer).
160  * - If RTE_MBUF_F_RX_QINQ_STRIPPED is set and RTE_MBUF_F_RX_VLAN_STRIPPED
161  *   is unset, only the outer VLAN is removed from packet data, but both tci
162  *   are saved in mbuf->vlan_tci (inner) and mbuf->vlan_tci_outer (outer).
163  */
164 #define RTE_MBUF_F_RX_QINQ_STRIPPED (1ULL << 15)
165 #define PKT_RX_QINQ_STRIPPED RTE_DEPRECATED(PKT_RX_QINQ_STRIPPED) \
166 		RTE_MBUF_F_RX_QINQ_STRIPPED
167 
168 /**
169  * When packets are coalesced by a hardware or virtual driver, this flag
170  * can be set in the RX mbuf, meaning that the m->tso_segsz field is
171  * valid and is set to the segment size of original packets.
172  */
173 #define RTE_MBUF_F_RX_LRO           (1ULL << 16)
174 #define PKT_RX_LRO RTE_DEPRECATED(PKT_RX_LRO) RTE_MBUF_F_RX_LRO
175 
176 /* There is no flag defined at offset 17. It is free for any future use. */
177 
178 /**
179  * Indicate that security offload processing was applied on the RX packet.
180  */
181 #define RTE_MBUF_F_RX_SEC_OFFLOAD	(1ULL << 18)
182 #define PKT_RX_SEC_OFFLOAD RTE_DEPRECATED(PKT_RX_SEC_OFFLOAD) \
183 		RTE_MBUF_F_RX_SEC_OFFLOAD
184 
185 /**
186  * Indicate that security offload processing failed on the RX packet.
187  */
188 #define RTE_MBUF_F_RX_SEC_OFFLOAD_FAILED	(1ULL << 19)
189 #define PKT_RX_SEC_OFFLOAD_FAILED RTE_DEPRECATED(PKT_RX_SEC_OFFLOAD_FAILED) \
190 		RTE_MBUF_F_RX_SEC_OFFLOAD_FAILED
191 
192 /**
193  * The RX packet is a double VLAN, and the outer tci has been
194  * saved in mbuf->vlan_tci_outer. If this flag is set, RTE_MBUF_F_RX_VLAN
195  * must also be set and the inner tci is saved in mbuf->vlan_tci.
196  * If the flag RTE_MBUF_F_RX_QINQ_STRIPPED is also present, both VLANs
197  * headers have been stripped from mbuf data, else they are still
198  * present.
199  */
200 #define RTE_MBUF_F_RX_QINQ          (1ULL << 20)
201 #define PKT_RX_QINQ RTE_DEPRECATED(PKT_RX_QINQ) RTE_MBUF_F_RX_QINQ
202 
203 /**
204  * Mask of bits used to determine the status of outer RX L4 checksum.
205  * - RTE_MBUF_F_RX_OUTER_L4_CKSUM_UNKNOWN: no info about the outer RX L4
206  *   checksum
207  * - RTE_MBUF_F_RX_OUTER_L4_CKSUM_BAD: the outer L4 checksum in the packet
208  *   is wrong
209  * - RTE_MBUF_F_RX_OUTER_L4_CKSUM_GOOD: the outer L4 checksum in the packet
210  *   is valid
211  * - RTE_MBUF_F_RX_OUTER_L4_CKSUM_INVALID: invalid outer L4 checksum state.
212  *
213  * The detection of RTE_MBUF_F_RX_OUTER_L4_CKSUM_GOOD shall be based on the
214  * given HW capability, At minimum, the PMD should support
215  * RTE_MBUF_F_RX_OUTER_L4_CKSUM_UNKNOWN and RTE_MBUF_F_RX_OUTER_L4_CKSUM_BAD
216  * states if the RTE_ETH_RX_OFFLOAD_OUTER_UDP_CKSUM offload is available.
217  */
218 #define RTE_MBUF_F_RX_OUTER_L4_CKSUM_MASK	((1ULL << 21) | (1ULL << 22))
219 #define PKT_RX_OUTER_L4_CKSUM_MASK RTE_DEPRECATED(PKT_RX_OUTER_L4_CKSUM_MASK) \
220 		RTE_MBUF_F_RX_OUTER_L4_CKSUM_MASK
221 
222 #define RTE_MBUF_F_RX_OUTER_L4_CKSUM_UNKNOWN	0
223 #define RTE_MBUF_F_RX_OUTER_L4_CKSUM_BAD	(1ULL << 21)
224 #define RTE_MBUF_F_RX_OUTER_L4_CKSUM_GOOD	(1ULL << 22)
225 #define RTE_MBUF_F_RX_OUTER_L4_CKSUM_INVALID	((1ULL << 21) | (1ULL << 22))
226 #define PKT_RX_OUTER_L4_CKSUM_UNKNOWN \
227 	RTE_DEPRECATED(PKT_RX_OUTER_L4_CKSUM_UNKNOWN) \
228 	RTE_MBUF_F_RX_OUTER_L4_CKSUM_UNKNOWN
229 #define PKT_RX_OUTER_L4_CKSUM_BAD RTE_DEPRECATED(PKT_RX_OUTER_L4_CKSUM_BAD) \
230 		RTE_MBUF_F_RX_OUTER_L4_CKSUM_BAD
231 #define PKT_RX_OUTER_L4_CKSUM_GOOD RTE_DEPRECATED(PKT_RX_OUTER_L4_CKSUM_GOOD) \
232 		RTE_MBUF_F_RX_OUTER_L4_CKSUM_GOOD
233 #define PKT_RX_OUTER_L4_CKSUM_INVALID \
234 	RTE_DEPRECATED(PKT_RX_OUTER_L4_CKSUM_INVALID) \
235 	RTE_MBUF_F_RX_OUTER_L4_CKSUM_INVALID
236 
237 /* add new RX flags here, don't forget to update RTE_MBUF_F_FIRST_FREE */
238 
239 #define RTE_MBUF_F_FIRST_FREE (1ULL << 23)
240 #define PKT_FIRST_FREE RTE_DEPRECATED(PKT_FIRST_FREE) RTE_MBUF_F_FIRST_FREE
241 #define RTE_MBUF_F_LAST_FREE (1ULL << 40)
242 #define PKT_LAST_FREE RTE_DEPRECATED(PKT_LAST_FREE) RTE_MBUF_F_LAST_FREE
243 
244 /* add new TX flags here, don't forget to update RTE_MBUF_F_LAST_FREE  */
245 
246 /**
247  * Outer UDP checksum offload flag. This flag is used for enabling
248  * outer UDP checksum in PMD. To use outer UDP checksum, the user needs to
249  * 1) Enable the following in mbuf,
250  * a) Fill outer_l2_len and outer_l3_len in mbuf.
251  * b) Set the RTE_MBUF_F_TX_OUTER_UDP_CKSUM flag.
252  * c) Set the RTE_MBUF_F_TX_OUTER_IPV4 or RTE_MBUF_F_TX_OUTER_IPV6 flag.
253  * 2) Configure RTE_ETH_TX_OFFLOAD_OUTER_UDP_CKSUM offload flag.
254  */
255 #define RTE_MBUF_F_TX_OUTER_UDP_CKSUM     (1ULL << 41)
256 #define PKT_TX_OUTER_UDP_CKSUM RTE_DEPRECATED(PKT_TX_OUTER_UDP_CKSUM) \
257 		RTE_MBUF_F_TX_OUTER_UDP_CKSUM
258 
259 /**
260  * UDP Fragmentation Offload flag. This flag is used for enabling UDP
261  * fragmentation in SW or in HW. When use UFO, mbuf->tso_segsz is used
262  * to store the MSS of UDP fragments.
263  */
264 #define RTE_MBUF_F_TX_UDP_SEG	(1ULL << 42)
265 #define PKT_TX_UDP_SEG RTE_DEPRECATED(PKT_TX_UDP_SEG) RTE_MBUF_F_TX_UDP_SEG
266 
267 /**
268  * Request security offload processing on the TX packet.
269  * To use Tx security offload, the user needs to fill l2_len in mbuf
270  * indicating L2 header size and where L3 header starts.
271  */
272 #define RTE_MBUF_F_TX_SEC_OFFLOAD	(1ULL << 43)
273 #define PKT_TX_SEC_OFFLOAD RTE_DEPRECATED(PKT_TX_SEC_OFFLOAD) \
274 		RTE_MBUF_F_TX_SEC_OFFLOAD
275 
276 /**
277  * Offload the MACsec. This flag must be set by the application to enable
278  * this offload feature for a packet to be transmitted.
279  */
280 #define RTE_MBUF_F_TX_MACSEC        (1ULL << 44)
281 #define PKT_TX_MACSEC RTE_DEPRECATED(PKT_TX_MACSEC) RTE_MBUF_F_TX_MACSEC
282 
283 /**
284  * Bits 45:48 used for the tunnel type.
285  * The tunnel type must be specified for TSO or checksum on the inner part
286  * of tunnel packets.
287  * These flags can be used with RTE_MBUF_F_TX_TCP_SEG for TSO, or
288  * RTE_MBUF_F_TX_xxx_CKSUM.
289  * The mbuf fields for inner and outer header lengths are required:
290  * outer_l2_len, outer_l3_len, l2_len, l3_len, l4_len and tso_segsz for TSO.
291  */
292 #define RTE_MBUF_F_TX_TUNNEL_VXLAN   (0x1ULL << 45)
293 #define RTE_MBUF_F_TX_TUNNEL_GRE     (0x2ULL << 45)
294 #define RTE_MBUF_F_TX_TUNNEL_IPIP    (0x3ULL << 45)
295 #define RTE_MBUF_F_TX_TUNNEL_GENEVE  (0x4ULL << 45)
296 /** TX packet with MPLS-in-UDP RFC 7510 header. */
297 #define RTE_MBUF_F_TX_TUNNEL_MPLSINUDP (0x5ULL << 45)
298 #define RTE_MBUF_F_TX_TUNNEL_VXLAN_GPE (0x6ULL << 45)
299 #define RTE_MBUF_F_TX_TUNNEL_GTP       (0x7ULL << 45)
300 #define RTE_MBUF_F_TX_TUNNEL_ESP       (0x8ULL << 45)
301 /**
302  * Generic IP encapsulated tunnel type, used for TSO and checksum offload.
303  * It can be used for tunnels which are not standards or listed above.
304  * It is preferred to use specific tunnel flags like RTE_MBUF_F_TX_TUNNEL_GRE
305  * or RTE_MBUF_F_TX_TUNNEL_IPIP if possible.
306  * The ethdev must be configured with RTE_ETH_TX_OFFLOAD_IP_TNL_TSO.
307  * Outer and inner checksums are done according to the existing flags like
308  * RTE_MBUF_F_TX_xxx_CKSUM.
309  * Specific tunnel headers that contain payload length, sequence id
310  * or checksum are not expected to be updated.
311  */
312 #define RTE_MBUF_F_TX_TUNNEL_IP (0xDULL << 45)
313 /**
314  * Generic UDP encapsulated tunnel type, used for TSO and checksum offload.
315  * UDP tunnel type implies outer IP layer.
316  * It can be used for tunnels which are not standards or listed above.
317  * It is preferred to use specific tunnel flags like RTE_MBUF_F_TX_TUNNEL_VXLAN
318  * if possible.
319  * The ethdev must be configured with RTE_ETH_TX_OFFLOAD_UDP_TNL_TSO.
320  * Outer and inner checksums are done according to the existing flags like
321  * RTE_MBUF_F_TX_xxx_CKSUM.
322  * Specific tunnel headers that contain payload length, sequence id
323  * or checksum are not expected to be updated.
324  */
325 #define RTE_MBUF_F_TX_TUNNEL_UDP (0xEULL << 45)
326 /* add new TX TUNNEL type here */
327 #define RTE_MBUF_F_TX_TUNNEL_MASK    (0xFULL << 45)
328 
329 #define PKT_TX_TUNNEL_VXLAN RTE_DEPRECATED(PKT_TX_TUNNEL_VXLAN) \
330 		RTE_MBUF_F_TX_TUNNEL_VXLAN
331 #define PKT_TX_TUNNEL_GRE RTE_DEPRECATED(PKT_TX_TUNNEL_GRE) \
332 		RTE_MBUF_F_TX_TUNNEL_GRE
333 #define PKT_TX_TUNNEL_IPIP RTE_DEPRECATED(PKT_TX_TUNNEL_IPIP) \
334 		RTE_MBUF_F_TX_TUNNEL_IPIP
335 #define PKT_TX_TUNNEL_GENEVE RTE_DEPRECATED(PKT_TX_TUNNEL_GENEVE) \
336 		RTE_MBUF_F_TX_TUNNEL_GENEVE
337 #define PKT_TX_TUNNEL_MPLSINUDP RTE_DEPRECATED(PKT_TX_TUNNEL_MPLSINUDP) \
338 		RTE_MBUF_F_TX_TUNNEL_MPLSINUDP
339 #define PKT_TX_TUNNEL_VXLAN_GPE RTE_DEPRECATED(PKT_TX_TUNNEL_VXLAN_GPE) \
340 		RTE_MBUF_F_TX_TUNNEL_VXLAN_GPE
341 #define PKT_TX_TUNNEL_GTP RTE_DEPRECATED(PKT_TX_TUNNEL_GTP) \
342 		RTE_MBUF_F_TX_TUNNEL_GTP
343 #define PKT_TX_TUNNEL_IP RTE_DEPRECATED(PKT_TX_TUNNEL_IP) \
344 		RTE_MBUF_F_TX_TUNNEL_IP
345 #define PKT_TX_TUNNEL_UDP RTE_DEPRECATED(PKT_TX_TUNNEL_UDP) \
346 		RTE_MBUF_F_TX_TUNNEL_UDP
347 #define PKT_TX_TUNNEL_MASK RTE_DEPRECATED(PKT_TX_TUNNEL_MASK) \
348 		RTE_MBUF_F_TX_TUNNEL_MASK
349 
350 /**
351  * Double VLAN insertion (QinQ) request to driver, driver may offload the
352  * insertion based on device capability.
353  * mbuf 'vlan_tci' & 'vlan_tci_outer' must be valid when this flag is set.
354  */
355 #define RTE_MBUF_F_TX_QINQ        (1ULL << 49)
356 #define PKT_TX_QINQ RTE_DEPRECATED(PKT_TX_QINQ) RTE_MBUF_F_TX_QINQ
357 #define PKT_TX_QINQ_PKT RTE_DEPRECATED(PKT_TX_QINQ_PKT) RTE_MBUF_F_TX_QINQ
358 
359 /**
360  * TCP segmentation offload. To enable this offload feature for a
361  * packet to be transmitted on hardware supporting TSO:
362  *  - set the RTE_MBUF_F_TX_TCP_SEG flag in mbuf->ol_flags (this flag implies
363  *    RTE_MBUF_F_TX_TCP_CKSUM)
364  *  - set the flag RTE_MBUF_F_TX_IPV4 or RTE_MBUF_F_TX_IPV6
365  *  - if it's IPv4, set the RTE_MBUF_F_TX_IP_CKSUM flag
366  *  - fill the mbuf offload information: l2_len, l3_len, l4_len, tso_segsz
367  */
368 #define RTE_MBUF_F_TX_TCP_SEG       (1ULL << 50)
369 #define PKT_TX_TCP_SEG RTE_DEPRECATED(PKT_TX_TCP_SEG) RTE_MBUF_F_TX_TCP_SEG
370 
371 /** TX IEEE1588 packet to timestamp. */
372 #define RTE_MBUF_F_TX_IEEE1588_TMST (1ULL << 51)
373 #define PKT_TX_IEEE1588_TMST RTE_DEPRECATED(PKT_TX_IEEE1588_TMST) \
374 		RTE_MBUF_F_TX_IEEE1588_TMST
375 
376 /*
377  * Bits 52+53 used for L4 packet type with checksum enabled: 00: Reserved,
378  * 01: TCP checksum, 10: SCTP checksum, 11: UDP checksum. To use hardware
379  * L4 checksum offload, the user needs to:
380  *  - fill l2_len and l3_len in mbuf
381  *  - set the flags RTE_MBUF_F_TX_TCP_CKSUM, RTE_MBUF_F_TX_SCTP_CKSUM or
382  *    RTE_MBUF_F_TX_UDP_CKSUM
383  *  - set the flag RTE_MBUF_F_TX_IPV4 or RTE_MBUF_F_TX_IPV6
384  */
385 
386 /** Disable L4 cksum of TX pkt. */
387 #define RTE_MBUF_F_TX_L4_NO_CKSUM   (0ULL << 52)
388 
389 /** TCP cksum of TX pkt. computed by NIC. */
390 #define RTE_MBUF_F_TX_TCP_CKSUM     (1ULL << 52)
391 
392 /** SCTP cksum of TX pkt. computed by NIC. */
393 #define RTE_MBUF_F_TX_SCTP_CKSUM    (2ULL << 52)
394 
395 /** UDP cksum of TX pkt. computed by NIC. */
396 #define RTE_MBUF_F_TX_UDP_CKSUM     (3ULL << 52)
397 
398 /** Mask for L4 cksum offload request. */
399 #define RTE_MBUF_F_TX_L4_MASK       (3ULL << 52)
400 
401 #define PKT_TX_L4_NO_CKSUM RTE_DEPRECATED(PKT_TX_L4_NO_CKSUM) \
402 		RTE_MBUF_F_TX_L4_NO_CKSUM
403 #define PKT_TX_TCP_CKSUM RTE_DEPRECATED(PKT_TX_TCP_CKSUM) \
404 		RTE_MBUF_F_TX_TCP_CKSUM
405 #define PKT_TX_SCTP_CKSUM RTE_DEPRECATED(PKT_TX_SCTP_CKSUM) \
406 		RTE_MBUF_F_TX_SCTP_CKSUM
407 #define PKT_TX_UDP_CKSUM RTE_DEPRECATED(PKT_TX_UDP_CKSUM) \
408 		RTE_MBUF_F_TX_UDP_CKSUM
409 #define PKT_TX_L4_MASK RTE_DEPRECATED(PKT_TX_L4_MASK) RTE_MBUF_F_TX_L4_MASK
410 
411 /**
412  * Offload the IP checksum in the hardware. The flag RTE_MBUF_F_TX_IPV4 should
413  * also be set by the application, although a PMD will only check
414  * RTE_MBUF_F_TX_IP_CKSUM.
415  *  - fill the mbuf offload information: l2_len, l3_len
416  */
417 #define RTE_MBUF_F_TX_IP_CKSUM      (1ULL << 54)
418 #define PKT_TX_IP_CKSUM RTE_DEPRECATED(PKT_TX_IP_CKSUM) RTE_MBUF_F_TX_IP_CKSUM
419 
420 /**
421  * Packet is IPv4. This flag must be set when using any offload feature
422  * (TSO, L3 or L4 checksum) to tell the NIC that the packet is an IPv4
423  * packet. If the packet is a tunneled packet, this flag is related to
424  * the inner headers.
425  */
426 #define RTE_MBUF_F_TX_IPV4          (1ULL << 55)
427 #define PKT_TX_IPV4 RTE_DEPRECATED(PKT_TX_IPV4) RTE_MBUF_F_TX_IPV4
428 
429 /**
430  * Packet is IPv6. This flag must be set when using an offload feature
431  * (TSO or L4 checksum) to tell the NIC that the packet is an IPv6
432  * packet. If the packet is a tunneled packet, this flag is related to
433  * the inner headers.
434  */
435 #define RTE_MBUF_F_TX_IPV6          (1ULL << 56)
436 #define PKT_TX_IPV6 RTE_DEPRECATED(PKT_TX_IPV6) RTE_MBUF_F_TX_IPV6
437 
438 /**
439  * VLAN tag insertion request to driver, driver may offload the insertion
440  * based on the device capability.
441  * mbuf 'vlan_tci' field must be valid when this flag is set.
442  */
443 #define RTE_MBUF_F_TX_VLAN          (1ULL << 57)
444 #define PKT_TX_VLAN RTE_DEPRECATED(PKT_TX_VLAN) RTE_MBUF_F_TX_VLAN
445 #define PKT_TX_VLAN_PKT RTE_DEPRECATED(PKT_TX_VLAN_PKT) RTE_MBUF_F_TX_VLAN
446 
447 /**
448  * Offload the IP checksum of an external header in the hardware. The
449  * flag RTE_MBUF_F_TX_OUTER_IPV4 should also be set by the application, although
450  * a PMD will only check RTE_MBUF_F_TX_OUTER_IP_CKSUM.
451  *  - fill the mbuf offload information: outer_l2_len, outer_l3_len
452  */
453 #define RTE_MBUF_F_TX_OUTER_IP_CKSUM   (1ULL << 58)
454 #define PKT_TX_OUTER_IP_CKSUM RTE_DEPRECATED(PKT_TX_OUTER_IP_CKSUM) \
455 		RTE_MBUF_F_TX_OUTER_IP_CKSUM
456 
457 /**
458  * Packet outer header is IPv4. This flag must be set when using any
459  * outer offload feature (L3 or L4 checksum) to tell the NIC that the
460  * outer header of the tunneled packet is an IPv4 packet.
461  */
462 #define RTE_MBUF_F_TX_OUTER_IPV4   (1ULL << 59)
463 #define PKT_TX_OUTER_IPV4 RTE_DEPRECATED(PKT_TX_OUTER_IPV4) \
464 		RTE_MBUF_F_TX_OUTER_IPV4
465 
466 /**
467  * Packet outer header is IPv6. This flag must be set when using any
468  * outer offload feature (L4 checksum) to tell the NIC that the outer
469  * header of the tunneled packet is an IPv6 packet.
470  */
471 #define RTE_MBUF_F_TX_OUTER_IPV6    (1ULL << 60)
472 #define PKT_TX_OUTER_IPV6 RTE_DEPRECATED(PKT_TX_OUTER_IPV6) \
473 		RTE_MBUF_F_TX_OUTER_IPV6
474 
475 /**
476  * Bitmask of all supported packet Tx offload features flags,
477  * which can be set for packet.
478  */
479 #define RTE_MBUF_F_TX_OFFLOAD_MASK (    \
480 		RTE_MBUF_F_TX_OUTER_IPV6 |	 \
481 		RTE_MBUF_F_TX_OUTER_IPV4 |	 \
482 		RTE_MBUF_F_TX_OUTER_IP_CKSUM |  \
483 		RTE_MBUF_F_TX_VLAN |        \
484 		RTE_MBUF_F_TX_IPV6 |		 \
485 		RTE_MBUF_F_TX_IPV4 |		 \
486 		RTE_MBUF_F_TX_IP_CKSUM |        \
487 		RTE_MBUF_F_TX_L4_MASK |         \
488 		RTE_MBUF_F_TX_IEEE1588_TMST |	 \
489 		RTE_MBUF_F_TX_TCP_SEG |         \
490 		RTE_MBUF_F_TX_QINQ |        \
491 		RTE_MBUF_F_TX_TUNNEL_MASK |	 \
492 		RTE_MBUF_F_TX_MACSEC |		 \
493 		RTE_MBUF_F_TX_SEC_OFFLOAD |	 \
494 		RTE_MBUF_F_TX_UDP_SEG |	 \
495 		RTE_MBUF_F_TX_OUTER_UDP_CKSUM)
496 #define PKT_TX_OFFLOAD_MASK RTE_DEPRECATED(PKT_TX_OFFLOAD_MASK) RTE_MBUF_F_TX_OFFLOAD_MASK
497 
498 /**
499  * Mbuf having an external buffer attached. shinfo in mbuf must be filled.
500  */
501 #define RTE_MBUF_F_EXTERNAL    (1ULL << 61)
502 #define EXT_ATTACHED_MBUF RTE_DEPRECATED(EXT_ATTACHED_MBUF) RTE_MBUF_F_EXTERNAL
503 
504 #define RTE_MBUF_F_INDIRECT    (1ULL << 62) /**< Indirect attached mbuf */
505 #define IND_ATTACHED_MBUF RTE_DEPRECATED(IND_ATTACHED_MBUF) RTE_MBUF_F_INDIRECT
506 
507 /** Alignment constraint of mbuf private area. */
508 #define RTE_MBUF_PRIV_ALIGN 8
509 
510 /**
511  * Some NICs need at least 2KB buffer to RX standard Ethernet frame without
512  * splitting it into multiple segments.
513  * So, for mbufs that planned to be involved into RX/TX, the recommended
514  * minimal buffer length is 2KB + RTE_PKTMBUF_HEADROOM.
515  */
516 #define	RTE_MBUF_DEFAULT_DATAROOM	2048
517 #define	RTE_MBUF_DEFAULT_BUF_SIZE	\
518 	(RTE_MBUF_DEFAULT_DATAROOM + RTE_PKTMBUF_HEADROOM)
519 
520 struct rte_mbuf_sched {
521 	uint32_t queue_id;   /**< Queue ID. */
522 	uint8_t traffic_class;
523 	/**< Traffic class ID. Traffic class 0
524 	 * is the highest priority traffic class.
525 	 */
526 	uint8_t color;
527 	/**< Color. @see enum rte_color.*/
528 	uint16_t reserved;   /**< Reserved. */
529 }; /**< Hierarchical scheduler */
530 
531 /**
532  * enum for the tx_offload bit-fields lengths and offsets.
533  * defines the layout of rte_mbuf tx_offload field.
534  */
535 enum {
536 	RTE_MBUF_L2_LEN_BITS = 7,
537 	RTE_MBUF_L3_LEN_BITS = 9,
538 	RTE_MBUF_L4_LEN_BITS = 8,
539 	RTE_MBUF_TSO_SEGSZ_BITS = 16,
540 	RTE_MBUF_OUTL3_LEN_BITS = 9,
541 	RTE_MBUF_OUTL2_LEN_BITS = 7,
542 	RTE_MBUF_TXOFLD_UNUSED_BITS = sizeof(uint64_t) * CHAR_BIT -
543 		RTE_MBUF_L2_LEN_BITS -
544 		RTE_MBUF_L3_LEN_BITS -
545 		RTE_MBUF_L4_LEN_BITS -
546 		RTE_MBUF_TSO_SEGSZ_BITS -
547 		RTE_MBUF_OUTL3_LEN_BITS -
548 		RTE_MBUF_OUTL2_LEN_BITS,
549 #if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
550 	RTE_MBUF_L2_LEN_OFS =
551 		sizeof(uint64_t) * CHAR_BIT - RTE_MBUF_L2_LEN_BITS,
552 	RTE_MBUF_L3_LEN_OFS = RTE_MBUF_L2_LEN_OFS - RTE_MBUF_L3_LEN_BITS,
553 	RTE_MBUF_L4_LEN_OFS = RTE_MBUF_L3_LEN_OFS - RTE_MBUF_L4_LEN_BITS,
554 	RTE_MBUF_TSO_SEGSZ_OFS = RTE_MBUF_L4_LEN_OFS - RTE_MBUF_TSO_SEGSZ_BITS,
555 	RTE_MBUF_OUTL3_LEN_OFS =
556 		RTE_MBUF_TSO_SEGSZ_OFS - RTE_MBUF_OUTL3_LEN_BITS,
557 	RTE_MBUF_OUTL2_LEN_OFS =
558 		RTE_MBUF_OUTL3_LEN_OFS - RTE_MBUF_OUTL2_LEN_BITS,
559 	RTE_MBUF_TXOFLD_UNUSED_OFS =
560 		RTE_MBUF_OUTL2_LEN_OFS - RTE_MBUF_TXOFLD_UNUSED_BITS,
561 #else
562 	RTE_MBUF_L2_LEN_OFS = 0,
563 	RTE_MBUF_L3_LEN_OFS = RTE_MBUF_L2_LEN_OFS + RTE_MBUF_L2_LEN_BITS,
564 	RTE_MBUF_L4_LEN_OFS = RTE_MBUF_L3_LEN_OFS + RTE_MBUF_L3_LEN_BITS,
565 	RTE_MBUF_TSO_SEGSZ_OFS = RTE_MBUF_L4_LEN_OFS + RTE_MBUF_L4_LEN_BITS,
566 	RTE_MBUF_OUTL3_LEN_OFS =
567 		RTE_MBUF_TSO_SEGSZ_OFS + RTE_MBUF_TSO_SEGSZ_BITS,
568 	RTE_MBUF_OUTL2_LEN_OFS =
569 		RTE_MBUF_OUTL3_LEN_OFS + RTE_MBUF_OUTL3_LEN_BITS,
570 	RTE_MBUF_TXOFLD_UNUSED_OFS =
571 		RTE_MBUF_OUTL2_LEN_OFS + RTE_MBUF_OUTL2_LEN_BITS,
572 #endif
573 };
574 
575 /**
576  * The generic rte_mbuf, containing a packet mbuf.
577  */
578 struct rte_mbuf {
579 	RTE_MARKER cacheline0;
580 
581 	void *buf_addr;           /**< Virtual address of segment buffer. */
582 	/**
583 	 * Physical address of segment buffer.
584 	 * Force alignment to 8-bytes, so as to ensure we have the exact
585 	 * same mbuf cacheline0 layout for 32-bit and 64-bit. This makes
586 	 * working on vector drivers easier.
587 	 */
588 	rte_iova_t buf_iova __rte_aligned(sizeof(rte_iova_t));
589 
590 	/* next 8 bytes are initialised on RX descriptor rearm */
591 	RTE_MARKER64 rearm_data;
592 	uint16_t data_off;
593 
594 	/**
595 	 * Reference counter. Its size should at least equal to the size
596 	 * of port field (16 bits), to support zero-copy broadcast.
597 	 * It should only be accessed using the following functions:
598 	 * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and
599 	 * rte_mbuf_refcnt_set(). The functionality of these functions (atomic,
600 	 * or non-atomic) is controlled by the RTE_MBUF_REFCNT_ATOMIC flag.
601 	 */
602 	uint16_t refcnt;
603 
604 	/**
605 	 * Number of segments. Only valid for the first segment of an mbuf
606 	 * chain.
607 	 */
608 	uint16_t nb_segs;
609 
610 	/** Input port (16 bits to support more than 256 virtual ports).
611 	 * The event eth Tx adapter uses this field to specify the output port.
612 	 */
613 	uint16_t port;
614 
615 	uint64_t ol_flags;        /**< Offload features. */
616 
617 	/* remaining bytes are set on RX when pulling packet from descriptor */
618 	RTE_MARKER rx_descriptor_fields1;
619 
620 	/*
621 	 * The packet type, which is the combination of outer/inner L2, L3, L4
622 	 * and tunnel types. The packet_type is about data really present in the
623 	 * mbuf. Example: if vlan stripping is enabled, a received vlan packet
624 	 * would have RTE_PTYPE_L2_ETHER and not RTE_PTYPE_L2_VLAN because the
625 	 * vlan is stripped from the data.
626 	 */
627 	RTE_STD_C11
628 	union {
629 		uint32_t packet_type; /**< L2/L3/L4 and tunnel information. */
630 		__extension__
631 		struct {
632 			uint8_t l2_type:4;   /**< (Outer) L2 type. */
633 			uint8_t l3_type:4;   /**< (Outer) L3 type. */
634 			uint8_t l4_type:4;   /**< (Outer) L4 type. */
635 			uint8_t tun_type:4;  /**< Tunnel type. */
636 			RTE_STD_C11
637 			union {
638 				uint8_t inner_esp_next_proto;
639 				/**< ESP next protocol type, valid if
640 				 * RTE_PTYPE_TUNNEL_ESP tunnel type is set
641 				 * on both Tx and Rx.
642 				 */
643 				__extension__
644 				struct {
645 					uint8_t inner_l2_type:4;
646 					/**< Inner L2 type. */
647 					uint8_t inner_l3_type:4;
648 					/**< Inner L3 type. */
649 				};
650 			};
651 			uint8_t inner_l4_type:4; /**< Inner L4 type. */
652 		};
653 	};
654 
655 	uint32_t pkt_len;         /**< Total pkt len: sum of all segments. */
656 	uint16_t data_len;        /**< Amount of data in segment buffer. */
657 	/** VLAN TCI (CPU order), valid if RTE_MBUF_F_RX_VLAN is set. */
658 	uint16_t vlan_tci;
659 
660 	RTE_STD_C11
661 	union {
662 		union {
663 			uint32_t rss;     /**< RSS hash result if RSS enabled */
664 			struct {
665 				union {
666 					struct {
667 						uint16_t hash;
668 						uint16_t id;
669 					};
670 					uint32_t lo;
671 					/**< Second 4 flexible bytes */
672 				};
673 				uint32_t hi;
674 				/**< First 4 flexible bytes or FD ID, dependent
675 				 * on RTE_MBUF_F_RX_FDIR_* flag in ol_flags.
676 				 */
677 			} fdir;	/**< Filter identifier if FDIR enabled */
678 			struct rte_mbuf_sched sched;
679 			/**< Hierarchical scheduler : 8 bytes */
680 			struct {
681 				uint32_t reserved1;
682 				uint16_t reserved2;
683 				uint16_t txq;
684 				/**< The event eth Tx adapter uses this field
685 				 * to store Tx queue id.
686 				 * @see rte_event_eth_tx_adapter_txq_set()
687 				 */
688 			} txadapter; /**< Eventdev ethdev Tx adapter */
689 			/**< User defined tags. See rte_distributor_process() */
690 			uint32_t usr;
691 		} hash;                   /**< hash information */
692 	};
693 
694 	/** Outer VLAN TCI (CPU order), valid if RTE_MBUF_F_RX_QINQ is set. */
695 	uint16_t vlan_tci_outer;
696 
697 	uint16_t buf_len;         /**< Length of segment buffer. */
698 
699 	struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */
700 
701 	/* second cache line - fields only used in slow path or on TX */
702 	RTE_MARKER cacheline1 __rte_cache_min_aligned;
703 
704 	/**
705 	 * Next segment of scattered packet. Must be NULL in the last segment or
706 	 * in case of non-segmented packet.
707 	 */
708 	struct rte_mbuf *next;
709 
710 	/* fields to support TX offloads */
711 	RTE_STD_C11
712 	union {
713 		uint64_t tx_offload;       /**< combined for easy fetch */
714 		__extension__
715 		struct {
716 			uint64_t l2_len:RTE_MBUF_L2_LEN_BITS;
717 			/**< L2 (MAC) Header Length for non-tunneling pkt.
718 			 * Outer_L4_len + ... + Inner_L2_len for tunneling pkt.
719 			 */
720 			uint64_t l3_len:RTE_MBUF_L3_LEN_BITS;
721 			/**< L3 (IP) Header Length. */
722 			uint64_t l4_len:RTE_MBUF_L4_LEN_BITS;
723 			/**< L4 (TCP/UDP) Header Length. */
724 			uint64_t tso_segsz:RTE_MBUF_TSO_SEGSZ_BITS;
725 			/**< TCP TSO segment size */
726 
727 			/*
728 			 * Fields for Tx offloading of tunnels.
729 			 * These are undefined for packets which don't request
730 			 * any tunnel offloads (outer IP or UDP checksum,
731 			 * tunnel TSO).
732 			 *
733 			 * PMDs should not use these fields unconditionally
734 			 * when calculating offsets.
735 			 *
736 			 * Applications are expected to set appropriate tunnel
737 			 * offload flags when they fill in these fields.
738 			 */
739 			uint64_t outer_l3_len:RTE_MBUF_OUTL3_LEN_BITS;
740 			/**< Outer L3 (IP) Hdr Length. */
741 			uint64_t outer_l2_len:RTE_MBUF_OUTL2_LEN_BITS;
742 			/**< Outer L2 (MAC) Hdr Length. */
743 
744 			/* uint64_t unused:RTE_MBUF_TXOFLD_UNUSED_BITS; */
745 		};
746 	};
747 
748 	/** Shared data for external buffer attached to mbuf. See
749 	 * rte_pktmbuf_attach_extbuf().
750 	 */
751 	struct rte_mbuf_ext_shared_info *shinfo;
752 
753 	/** Size of the application private data. In case of an indirect
754 	 * mbuf, it stores the direct mbuf private data size.
755 	 */
756 	uint16_t priv_size;
757 
758 	/** Timesync flags for use with IEEE1588. */
759 	uint16_t timesync;
760 
761 	uint32_t dynfield1[9]; /**< Reserved for dynamic fields. */
762 } __rte_cache_aligned;
763 
764 /**
765  * Function typedef of callback to free externally attached buffer.
766  */
767 typedef void (*rte_mbuf_extbuf_free_callback_t)(void *addr, void *opaque);
768 
769 /**
770  * Shared data at the end of an external buffer.
771  */
772 struct rte_mbuf_ext_shared_info {
773 	rte_mbuf_extbuf_free_callback_t free_cb; /**< Free callback function */
774 	void *fcb_opaque;                        /**< Free callback argument */
775 	uint16_t refcnt;
776 };
777 
778 /** Maximum number of nb_segs allowed. */
779 #define RTE_MBUF_MAX_NB_SEGS	UINT16_MAX
780 
781 /**
782  * Returns TRUE if given mbuf is cloned by mbuf indirection, or FALSE
783  * otherwise.
784  *
785  * If a mbuf has its data in another mbuf and references it by mbuf
786  * indirection, this mbuf can be defined as a cloned mbuf.
787  */
788 #define RTE_MBUF_CLONED(mb)     ((mb)->ol_flags & RTE_MBUF_F_INDIRECT)
789 
790 /**
791  * Returns TRUE if given mbuf has an external buffer, or FALSE otherwise.
792  *
793  * External buffer is a user-provided anonymous buffer.
794  */
795 #define RTE_MBUF_HAS_EXTBUF(mb) ((mb)->ol_flags & RTE_MBUF_F_EXTERNAL)
796 
797 /**
798  * Returns TRUE if given mbuf is direct, or FALSE otherwise.
799  *
800  * If a mbuf embeds its own data after the rte_mbuf structure, this mbuf
801  * can be defined as a direct mbuf.
802  */
803 #define RTE_MBUF_DIRECT(mb) \
804 	(!((mb)->ol_flags & (RTE_MBUF_F_INDIRECT | RTE_MBUF_F_EXTERNAL)))
805 
806 /** Uninitialized or unspecified port. */
807 #define RTE_MBUF_PORT_INVALID UINT16_MAX
808 /** For backwards compatibility. */
809 #define MBUF_INVALID_PORT RTE_MBUF_PORT_INVALID
810 
811 /**
812  * A macro that points to an offset into the data in the mbuf.
813  *
814  * The returned pointer is cast to type t. Before using this
815  * function, the user must ensure that the first segment is large
816  * enough to accommodate its data.
817  *
818  * @param m
819  *   The packet mbuf.
820  * @param o
821  *   The offset into the mbuf data.
822  * @param t
823  *   The type to cast the result into.
824  */
825 #define rte_pktmbuf_mtod_offset(m, t, o)	\
826 	((t)(void *)((char *)(m)->buf_addr + (m)->data_off + (o)))
827 
828 /**
829  * A macro that points to the start of the data in the mbuf.
830  *
831  * The returned pointer is cast to type t. Before using this
832  * function, the user must ensure that the first segment is large
833  * enough to accommodate its data.
834  *
835  * @param m
836  *   The packet mbuf.
837  * @param t
838  *   The type to cast the result into.
839  */
840 #define rte_pktmbuf_mtod(m, t) rte_pktmbuf_mtod_offset(m, t, 0)
841 
842 /**
843  * A macro that returns the IO address that points to an offset of the
844  * start of the data in the mbuf
845  *
846  * @param m
847  *   The packet mbuf.
848  * @param o
849  *   The offset into the data to calculate address from.
850  */
851 #define rte_pktmbuf_iova_offset(m, o) \
852 	(rte_iova_t)((m)->buf_iova + (m)->data_off + (o))
853 
854 /**
855  * A macro that returns the IO address that points to the start of the
856  * data in the mbuf
857  *
858  * @param m
859  *   The packet mbuf.
860  */
861 #define rte_pktmbuf_iova(m) rte_pktmbuf_iova_offset(m, 0)
862 
863 #ifdef __cplusplus
864 }
865 #endif
866 
867 #endif /* _RTE_MBUF_CORE_H_ */
868