mbuf: fix struct initialization with C++
[dpdk.git] / lib / librte_mbuf / rte_mbuf.h
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_H_
7 #define _RTE_MBUF_H_
8
9 /**
10  * @file
11  * RTE Mbuf
12  *
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.
17  *
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
23  * details.
24  *
25  * This library provides an API to allocate/free packet mbufs, which are
26  * used to carry network packets.
27  *
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
32  */
33
34 #include <stdint.h>
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>
44
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48
49 /*
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
52  *
53  * - RX flags start at bit position zero, and get added to the left of previous
54  *   flags.
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.
59  *
60  * Keep these flags synchronized with rte_get_rx_ol_flag_name() and
61  * rte_get_tx_ol_flag_name().
62  */
63
64 /**
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
69  * present.
70  */
71 #define PKT_RX_VLAN          (1ULL << 0)
72
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. */
75
76 /**
77  * Deprecated.
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.
82  */
83 #define PKT_RX_L4_CKSUM_BAD  (1ULL << 3)
84
85 /**
86  * Deprecated.
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.
91  */
92 #define PKT_RX_IP_CKSUM_BAD  (1ULL << 4)
93
94 #define PKT_RX_EIP_CKSUM_BAD (1ULL << 5)  /**< External IP header checksum error. */
95
96 /**
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.
101  */
102 #define PKT_RX_VLAN_STRIPPED (1ULL << 6)
103
104 /**
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.
111  */
112 #define PKT_RX_IP_CKSUM_MASK ((1ULL << 4) | (1ULL << 7))
113
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))
118
119 /**
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.
126  */
127 #define PKT_RX_L4_CKSUM_MASK ((1ULL << 3) | (1ULL << 8))
128
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))
133
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. */
138
139 /**
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.
146  */
147 #define PKT_RX_QINQ_STRIPPED (1ULL << 15)
148
149 /**
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.
153  */
154 #define PKT_RX_LRO           (1ULL << 16)
155
156 /**
157  * Indicate that the timestamp field in the mbuf is valid.
158  */
159 #define PKT_RX_TIMESTAMP     (1ULL << 17)
160
161 /**
162  * Indicate that security offload processing was applied on the RX packet.
163  */
164 #define PKT_RX_SEC_OFFLOAD              (1ULL << 18)
165
166 /**
167  * Indicate that security offload processing failed on the RX packet.
168  */
169 #define PKT_RX_SEC_OFFLOAD_FAILED       (1ULL << 19)
170
171 /**
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
177  * present.
178  */
179 #define PKT_RX_QINQ          (1ULL << 20)
180
181 /**
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.
187  *
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.
192  */
193 #define PKT_RX_OUTER_L4_CKSUM_MASK      ((1ULL << 21) | (1ULL << 22))
194
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))
199
200 /* add new RX flags here */
201
202 /* add new TX flags here */
203
204 /**
205  * Indicate that the metadata field in the mbuf is in use.
206  */
207 #define PKT_TX_METADATA (1ULL << 40)
208
209 /**
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.
217  */
218 #define PKT_TX_OUTER_UDP_CKSUM     (1ULL << 41)
219
220 /**
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.
224  */
225 #define PKT_TX_UDP_SEG  (1ULL << 42)
226
227 /**
228  * Request security offload processing on the TX packet.
229  */
230 #define PKT_TX_SEC_OFFLOAD              (1ULL << 43)
231
232 /**
233  * Offload the MACsec. This flag must be set by the application to enable
234  * this offload feature for a packet to be transmitted.
235  */
236 #define PKT_TX_MACSEC        (1ULL << 44)
237
238 /**
239  * Bits 45:48 used for the tunnel type.
240  * The tunnel type must be specified for TSO or checksum on the inner part
241  * of tunnel packets.
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.
245  */
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)
253 /**
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
260  * PKT_TX_xxx_CKSUM.
261  * Specific tunnel headers that contain payload length, sequence id
262  * or checksum are not expected to be updated.
263  */
264 #define PKT_TX_TUNNEL_IP (0xDULL << 45)
265 /**
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
270  * if possible.
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
273  * PKT_TX_xxx_CKSUM.
274  * Specific tunnel headers that contain payload length, sequence id
275  * or checksum are not expected to be updated.
276  */
277 #define PKT_TX_TUNNEL_UDP (0xEULL << 45)
278 /* add new TX TUNNEL type here */
279 #define PKT_TX_TUNNEL_MASK    (0xFULL << 45)
280
281 /**
282  * Second VLAN insertion (QinQ) flag.
283  */
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
287
288 /**
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
292  *    PKT_TX_TCP_CKSUM)
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
296  */
297 #define PKT_TX_TCP_SEG       (1ULL << 50)
298
299 #define PKT_TX_IEEE1588_TMST (1ULL << 51) /**< TX IEEE1588 packet to timestamp. */
300
301 /**
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
308  */
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. */
314
315 /**
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
318  * PKT_TX_IP_CKSUM.
319  *  - fill the mbuf offload information: l2_len, l3_len
320  */
321 #define PKT_TX_IP_CKSUM      (1ULL << 54)
322
323 /**
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
327  * the inner headers.
328  */
329 #define PKT_TX_IPV4          (1ULL << 55)
330
331 /**
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
335  * the inner headers.
336  */
337 #define PKT_TX_IPV6          (1ULL << 56)
338
339 /**
340  * TX packet is a 802.1q VLAN packet.
341  */
342 #define PKT_TX_VLAN          (1ULL << 57)
343 /* this old name is deprecated */
344 #define PKT_TX_VLAN_PKT      PKT_TX_VLAN
345
346 /**
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
351  */
352 #define PKT_TX_OUTER_IP_CKSUM   (1ULL << 58)
353
354 /**
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.
358  */
359 #define PKT_TX_OUTER_IPV4   (1ULL << 59)
360
361 /**
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.
365  */
366 #define PKT_TX_OUTER_IPV6    (1ULL << 60)
367
368 /**
369  * Bitmask of all supported packet Tx offload features flags,
370  * which can be set for packet.
371  */
372 #define PKT_TX_OFFLOAD_MASK (    \
373                 PKT_TX_OUTER_IPV6 |      \
374                 PKT_TX_OUTER_IPV4 |      \
375                 PKT_TX_OUTER_IP_CKSUM |  \
376                 PKT_TX_VLAN_PKT |        \
377                 PKT_TX_IPV6 |            \
378                 PKT_TX_IPV4 |            \
379                 PKT_TX_IP_CKSUM |        \
380                 PKT_TX_L4_MASK |         \
381                 PKT_TX_IEEE1588_TMST |   \
382                 PKT_TX_TCP_SEG |         \
383                 PKT_TX_QINQ_PKT |        \
384                 PKT_TX_TUNNEL_MASK |     \
385                 PKT_TX_MACSEC |          \
386                 PKT_TX_SEC_OFFLOAD |     \
387                 PKT_TX_UDP_SEG |         \
388                 PKT_TX_OUTER_UDP_CKSUM | \
389                 PKT_TX_METADATA)
390
391 /**
392  * Mbuf having an external buffer attached. shinfo in mbuf must be filled.
393  */
394 #define EXT_ATTACHED_MBUF    (1ULL << 61)
395
396 #define IND_ATTACHED_MBUF    (1ULL << 62) /**< Indirect attached mbuf */
397
398 /** Alignment constraint of mbuf private area. */
399 #define RTE_MBUF_PRIV_ALIGN 8
400
401 /**
402  * Get the name of a RX offload flag
403  *
404  * @param mask
405  *   The mask describing the flag.
406  * @return
407  *   The name of this flag, or NULL if it's not a valid RX flag.
408  */
409 const char *rte_get_rx_ol_flag_name(uint64_t mask);
410
411 /**
412  * Dump the list of RX offload flags in a buffer
413  *
414  * @param mask
415  *   The mask describing the RX flags.
416  * @param buf
417  *   The output buffer.
418  * @param buflen
419  *   The length of the buffer.
420  * @return
421  *   0 on success, (-1) on error.
422  */
423 int rte_get_rx_ol_flag_list(uint64_t mask, char *buf, size_t buflen);
424
425 /**
426  * Get the name of a TX offload flag
427  *
428  * @param mask
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.
432  * @return
433  *   The name of this flag, or NULL if it's not a valid TX flag.
434  */
435 const char *rte_get_tx_ol_flag_name(uint64_t mask);
436
437 /**
438  * Dump the list of TX offload flags in a buffer
439  *
440  * @param mask
441  *   The mask describing the TX flags.
442  * @param buf
443  *   The output buffer.
444  * @param buflen
445  *   The length of the buffer.
446  * @return
447  *   0 on success, (-1) on error.
448  */
449 int rte_get_tx_ol_flag_list(uint64_t mask, char *buf, size_t buflen);
450
451 /**
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.
456  */
457 #define RTE_MBUF_DEFAULT_DATAROOM       2048
458 #define RTE_MBUF_DEFAULT_BUF_SIZE       \
459         (RTE_MBUF_DEFAULT_DATAROOM + RTE_PKTMBUF_HEADROOM)
460
461 /* define a set of marker types that can be used to refer to set points in the
462  * mbuf */
463 __extension__
464 typedef void    *MARKER[0];   /**< generic marker for a point in a structure */
465 __extension__
466 typedef uint8_t  MARKER8[0];  /**< generic marker with 1B alignment */
467 __extension__
468 typedef uint64_t MARKER64[0]; /**< marker that allows us to overwrite 8 bytes
469                                * with a single assignment */
470
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.
476          */
477         uint8_t color;
478         /**< Color. @see enum rte_color.*/
479         uint16_t reserved;   /**< Reserved. */
480 }; /**< Hierarchical scheduler */
481
482 /**
483  * The generic rte_mbuf, containing a packet mbuf.
484  */
485 struct rte_mbuf {
486         MARKER cacheline0;
487
488         void *buf_addr;           /**< Virtual address of segment buffer. */
489         /**
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.
494          */
495         RTE_STD_C11
496         union {
497                 rte_iova_t buf_iova;
498                 rte_iova_t buf_physaddr; /**< deprecated */
499         } __rte_aligned(sizeof(rte_iova_t));
500
501         /* next 8 bytes are initialised on RX descriptor rearm */
502         MARKER64 rearm_data;
503         uint16_t data_off;
504
505         /**
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
512          * config option.
513          */
514         RTE_STD_C11
515         union {
516                 rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */
517                 uint16_t refcnt;              /**< Non-atomically accessed refcnt */
518         };
519         uint16_t nb_segs;         /**< Number of segments. */
520
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.
523          */
524         uint16_t port;
525
526         uint64_t ol_flags;        /**< Offload features. */
527
528         /* remaining bytes are set on RX when pulling packet from descriptor */
529         MARKER rx_descriptor_fields1;
530
531         /*
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.
537          */
538         RTE_STD_C11
539         union {
540                 uint32_t packet_type; /**< L2/L3/L4 and tunnel information. */
541                 struct {
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. */
546                         RTE_STD_C11
547                         union {
548                                 uint8_t inner_esp_next_proto;
549                                 /**< ESP next protocol type, valid if
550                                  * RTE_PTYPE_TUNNEL_ESP tunnel type is set
551                                  * on both Tx and Rx.
552                                  */
553                                 __extension__
554                                 struct {
555                                         uint8_t inner_l2_type:4;
556                                         /**< Inner L2 type. */
557                                         uint8_t inner_l3_type:4;
558                                         /**< Inner L3 type. */
559                                 };
560                         };
561                         uint32_t inner_l4_type:4; /**< Inner L4 type. */
562                 };
563         };
564
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. */
568         uint16_t vlan_tci;
569
570         RTE_STD_C11
571         union {
572                 union {
573                         uint32_t rss;     /**< RSS hash result if RSS enabled */
574                         struct {
575                                 union {
576                                         struct {
577                                                 uint16_t hash;
578                                                 uint16_t id;
579                                         };
580                                         uint32_t lo;
581                                         /**< Second 4 flexible bytes */
582                                 };
583                                 uint32_t hi;
584                                 /**< First 4 flexible bytes or FD ID, dependent
585                                  * on PKT_RX_FDIR_* flag in ol_flags.
586                                  */
587                         } fdir; /**< Filter identifier if FDIR enabled */
588                         struct rte_mbuf_sched sched;
589                         /**< Hierarchical scheduler : 8 bytes */
590                         struct {
591                                 uint32_t reserved1;
592                                 uint16_t reserved2;
593                                 uint16_t txq;
594                                 /**< The event eth Tx adapter uses this field
595                                  * to store Tx queue id.
596                                  * @see rte_event_eth_tx_adapter_txq_set()
597                                  */
598                         } txadapter; /**< Eventdev ethdev Tx adapter */
599                         /**< User defined tags. See rte_distributor_process() */
600                         uint32_t usr;
601                 } hash;                   /**< hash information */
602                 struct {
603                         /**
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.
609                          */
610                         uint32_t tx_metadata;
611                         uint32_t reserved;
612                 };
613         };
614
615         /** Outer VLAN TCI (CPU order), valid if PKT_RX_QINQ is set. */
616         uint16_t vlan_tci_outer;
617
618         uint16_t buf_len;         /**< Length of segment buffer. */
619
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.
622          */
623         uint64_t timestamp;
624
625         /* second cache line - fields only used in slow path or on TX */
626         MARKER cacheline1 __rte_cache_min_aligned;
627
628         RTE_STD_C11
629         union {
630                 void *userdata;   /**< Can be used for external metadata */
631                 uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */
632         };
633
634         struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */
635         struct rte_mbuf *next;    /**< Next segment of scattered packet. */
636
637         /* fields to support TX offloads */
638         RTE_STD_C11
639         union {
640                 uint64_t tx_offload;       /**< combined for easy fetch */
641                 __extension__
642                 struct {
643                         uint64_t l2_len:7;
644                         /**< L2 (MAC) Header Length for non-tunneling pkt.
645                          * Outer_L4_len + ... + Inner_L2_len for tunneling pkt.
646                          */
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 */
650
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. */
654
655                         /* uint64_t unused:8; */
656                 };
657         };
658
659         /** Size of the application private data. In case of an indirect
660          * mbuf, it stores the direct mbuf private data size. */
661         uint16_t priv_size;
662
663         /** Timesync flags for use with IEEE1588. */
664         uint16_t timesync;
665
666         /** Sequence number. See also rte_reorder_insert(). */
667         uint32_t seqn;
668
669         /** Shared data for external buffer attached to mbuf. See
670          * rte_pktmbuf_attach_extbuf().
671          */
672         struct rte_mbuf_ext_shared_info *shinfo;
673
674 } __rte_cache_aligned;
675
676 /**
677  * Function typedef of callback to free externally attached buffer.
678  */
679 typedef void (*rte_mbuf_extbuf_free_callback_t)(void *addr, void *opaque);
680
681 /**
682  * Shared data at the end of an external buffer.
683  */
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 */
688 };
689
690 /**< Maximum number of nb_segs allowed. */
691 #define RTE_MBUF_MAX_NB_SEGS    UINT16_MAX
692
693 /**
694  * Prefetch the first part of the mbuf
695  *
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.
699  *
700  * @param m
701  *   The pointer to the mbuf.
702  */
703 static inline void
704 rte_mbuf_prefetch_part1(struct rte_mbuf *m)
705 {
706         rte_prefetch0(&m->cacheline0);
707 }
708
709 /**
710  * Prefetch the second part of the mbuf
711  *
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
715  * already in cache.
716  *
717  * @param m
718  *   The pointer to the mbuf.
719  */
720 static inline void
721 rte_mbuf_prefetch_part2(struct rte_mbuf *m)
722 {
723 #if RTE_CACHE_LINE_SIZE == 64
724         rte_prefetch0(&m->cacheline1);
725 #else
726         RTE_SET_USED(m);
727 #endif
728 }
729
730
731 static inline uint16_t rte_pktmbuf_priv_size(struct rte_mempool *mp);
732
733 /**
734  * Return the IO address of the beginning of the mbuf data
735  *
736  * @param mb
737  *   The pointer to the mbuf.
738  * @return
739  *   The IO address of the beginning of the mbuf data
740  */
741 static inline rte_iova_t
742 rte_mbuf_data_iova(const struct rte_mbuf *mb)
743 {
744         return mb->buf_iova + mb->data_off;
745 }
746
747 __rte_deprecated
748 static inline phys_addr_t
749 rte_mbuf_data_dma_addr(const struct rte_mbuf *mb)
750 {
751         return rte_mbuf_data_iova(mb);
752 }
753
754 /**
755  * Return the default IO address of the beginning of the mbuf data
756  *
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.
760  *
761  * @param mb
762  *   The pointer to the mbuf.
763  * @return
764  *   The IO address of the beginning of the mbuf data
765  */
766 static inline rte_iova_t
767 rte_mbuf_data_iova_default(const struct rte_mbuf *mb)
768 {
769         return mb->buf_iova + RTE_PKTMBUF_HEADROOM;
770 }
771
772 __rte_deprecated
773 static inline phys_addr_t
774 rte_mbuf_data_dma_addr_default(const struct rte_mbuf *mb)
775 {
776         return rte_mbuf_data_iova_default(mb);
777 }
778
779 /**
780  * Return the mbuf owning the data buffer address of an indirect mbuf.
781  *
782  * @param mi
783  *   The pointer to the indirect mbuf.
784  * @return
785  *   The address of the direct mbuf corresponding to buffer_addr.
786  */
787 static inline struct rte_mbuf *
788 rte_mbuf_from_indirect(struct rte_mbuf *mi)
789 {
790         return (struct rte_mbuf *)RTE_PTR_SUB(mi->buf_addr, sizeof(*mi) + mi->priv_size);
791 }
792
793 /**
794  * Return address of buffer embedded in the given mbuf.
795  *
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.
800  *
801  * @warning
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.
805  *
806  * @param mb
807  *   The pointer to the mbuf.
808  * @param mp
809  *   The pointer to the mempool of the mbuf.
810  * @return
811  *   The pointer of the mbuf buffer.
812  */
813 static inline char * __rte_experimental
814 rte_mbuf_buf_addr(struct rte_mbuf *mb, struct rte_mempool *mp)
815 {
816         return (char *)mb + sizeof(*mb) + rte_pktmbuf_priv_size(mp);
817 }
818
819 /**
820  * Return the default address of the beginning of the mbuf data.
821  *
822  * @warning
823  * @b EXPERIMENTAL: This API may change without prior notice.
824  *
825  * @param mb
826  *   The pointer to the mbuf.
827  * @return
828  *   The pointer of the beginning of the mbuf data.
829  */
830 static inline char * __rte_experimental
831 rte_mbuf_data_addr_default(struct rte_mbuf *mb)
832 {
833         return rte_mbuf_buf_addr(mb, mb->pool) + RTE_PKTMBUF_HEADROOM;
834 }
835
836 /**
837  * Return address of buffer embedded in the given mbuf.
838  *
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.
843  *
844  * @param md
845  *   The pointer to the mbuf.
846  * @return
847  *   The address of the data buffer owned by the mbuf.
848  */
849 static inline char *
850 rte_mbuf_to_baddr(struct rte_mbuf *md)
851 {
852 #ifdef ALLOW_EXPERIMENTAL_API
853         return rte_mbuf_buf_addr(md, md->pool);
854 #else
855         char *buffer_addr;
856         buffer_addr = (char *)md + sizeof(*md) + rte_pktmbuf_priv_size(md->pool);
857         return buffer_addr;
858 #endif
859 }
860
861 /**
862  * Return the starting address of the private data area embedded in
863  * the given mbuf.
864  *
865  * Note that no check is made to ensure that a private data area
866  * actually exists in the supplied mbuf.
867  *
868  * @param m
869  *   The pointer to the mbuf.
870  * @return
871  *   The starting address of the private data area of the given mbuf.
872  */
873 static inline void * __rte_experimental
874 rte_mbuf_to_priv(struct rte_mbuf *m)
875 {
876         return RTE_PTR_ADD(m, sizeof(struct rte_mbuf));
877 }
878
879 /**
880  * Returns TRUE if given mbuf is cloned by mbuf indirection, or FALSE
881  * otherwise.
882  *
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.
885  */
886 #define RTE_MBUF_CLONED(mb)     ((mb)->ol_flags & IND_ATTACHED_MBUF)
887
888 /**
889  * Returns TRUE if given mbuf has an external buffer, or FALSE otherwise.
890  *
891  * External buffer is a user-provided anonymous buffer.
892  */
893 #define RTE_MBUF_HAS_EXTBUF(mb) ((mb)->ol_flags & EXT_ATTACHED_MBUF)
894
895 /**
896  * Returns TRUE if given mbuf is direct, or FALSE otherwise.
897  *
898  * If a mbuf embeds its own data after the rte_mbuf structure, this mbuf
899  * can be defined as a direct mbuf.
900  */
901 #define RTE_MBUF_DIRECT(mb) \
902         (!((mb)->ol_flags & (IND_ATTACHED_MBUF | EXT_ATTACHED_MBUF)))
903
904 /**
905  * Private data in case of pktmbuf pool.
906  *
907  * A structure that contains some pktmbuf_pool-specific data that are
908  * appended after the mempool structure (in private data).
909  */
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. */
913 };
914
915 #ifdef RTE_LIBRTE_MBUF_DEBUG
916
917 /**  check mbuf type in debug mode */
918 #define __rte_mbuf_sanity_check(m, is_h) rte_mbuf_sanity_check(m, is_h)
919
920 #else /*  RTE_LIBRTE_MBUF_DEBUG */
921
922 /**  check mbuf type in debug mode */
923 #define __rte_mbuf_sanity_check(m, is_h) do { } while (0)
924
925 #endif /*  RTE_LIBRTE_MBUF_DEBUG */
926
927 #ifdef RTE_MBUF_REFCNT_ATOMIC
928
929 /**
930  * Reads the value of an mbuf's refcnt.
931  * @param m
932  *   Mbuf to read
933  * @return
934  *   Reference count number.
935  */
936 static inline uint16_t
937 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
938 {
939         return (uint16_t)(rte_atomic16_read(&m->refcnt_atomic));
940 }
941
942 /**
943  * Sets an mbuf's refcnt to a defined value.
944  * @param m
945  *   Mbuf to update
946  * @param new_value
947  *   Value set
948  */
949 static inline void
950 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
951 {
952         rte_atomic16_set(&m->refcnt_atomic, (int16_t)new_value);
953 }
954
955 /* internal */
956 static inline uint16_t
957 __rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
958 {
959         return (uint16_t)(rte_atomic16_add_return(&m->refcnt_atomic, value));
960 }
961
962 /**
963  * Adds given value to an mbuf's refcnt and returns its new value.
964  * @param m
965  *   Mbuf to update
966  * @param value
967  *   Value to add/subtract
968  * @return
969  *   Updated value
970  */
971 static inline uint16_t
972 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
973 {
974         /*
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.
980          */
981         if (likely(rte_mbuf_refcnt_read(m) == 1)) {
982                 ++value;
983                 rte_mbuf_refcnt_set(m, (uint16_t)value);
984                 return (uint16_t)value;
985         }
986
987         return __rte_mbuf_refcnt_update(m, value);
988 }
989
990 #else /* ! RTE_MBUF_REFCNT_ATOMIC */
991
992 /* internal */
993 static inline uint16_t
994 __rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
995 {
996         m->refcnt = (uint16_t)(m->refcnt + value);
997         return m->refcnt;
998 }
999
1000 /**
1001  * Adds given value to an mbuf's refcnt and returns its new value.
1002  */
1003 static inline uint16_t
1004 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
1005 {
1006         return __rte_mbuf_refcnt_update(m, value);
1007 }
1008
1009 /**
1010  * Reads the value of an mbuf's refcnt.
1011  */
1012 static inline uint16_t
1013 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
1014 {
1015         return m->refcnt;
1016 }
1017
1018 /**
1019  * Sets an mbuf's refcnt to the defined value.
1020  */
1021 static inline void
1022 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
1023 {
1024         m->refcnt = new_value;
1025 }
1026
1027 #endif /* RTE_MBUF_REFCNT_ATOMIC */
1028
1029 /**
1030  * Reads the refcnt of an external buffer.
1031  *
1032  * @param shinfo
1033  *   Shared data of the external buffer.
1034  * @return
1035  *   Reference count number.
1036  */
1037 static inline uint16_t
1038 rte_mbuf_ext_refcnt_read(const struct rte_mbuf_ext_shared_info *shinfo)
1039 {
1040         return (uint16_t)(rte_atomic16_read(&shinfo->refcnt_atomic));
1041 }
1042
1043 /**
1044  * Set refcnt of an external buffer.
1045  *
1046  * @param shinfo
1047  *   Shared data of the external buffer.
1048  * @param new_value
1049  *   Value set
1050  */
1051 static inline void
1052 rte_mbuf_ext_refcnt_set(struct rte_mbuf_ext_shared_info *shinfo,
1053         uint16_t new_value)
1054 {
1055         rte_atomic16_set(&shinfo->refcnt_atomic, (int16_t)new_value);
1056 }
1057
1058 /**
1059  * Add given value to refcnt of an external buffer and return its new
1060  * value.
1061  *
1062  * @param shinfo
1063  *   Shared data of the external buffer.
1064  * @param value
1065  *   Value to add/subtract
1066  * @return
1067  *   Updated value
1068  */
1069 static inline uint16_t
1070 rte_mbuf_ext_refcnt_update(struct rte_mbuf_ext_shared_info *shinfo,
1071         int16_t value)
1072 {
1073         if (likely(rte_mbuf_ext_refcnt_read(shinfo) == 1)) {
1074                 ++value;
1075                 rte_mbuf_ext_refcnt_set(shinfo, (uint16_t)value);
1076                 return (uint16_t)value;
1077         }
1078
1079         return (uint16_t)rte_atomic16_add_return(&shinfo->refcnt_atomic, value);
1080 }
1081
1082 /** Mbuf prefetch */
1083 #define RTE_MBUF_PREFETCH_TO_FREE(m) do {       \
1084         if ((m) != NULL)                        \
1085                 rte_prefetch0(m);               \
1086 } while (0)
1087
1088
1089 /**
1090  * Sanity checks on an mbuf.
1091  *
1092  * Check the consistency of the given mbuf. The function will cause a
1093  * panic if corruption is detected.
1094  *
1095  * @param m
1096  *   The mbuf to be checked.
1097  * @param is_header
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)
1100  */
1101 void
1102 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header);
1103
1104 /**
1105  * Sanity checks on a mbuf.
1106  *
1107  * Almost like rte_mbuf_sanity_check(), but this function gives the reason
1108  * if corruption is detected rather than panic.
1109  *
1110  * @param m
1111  *   The mbuf to be checked.
1112  * @param is_header
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)
1115  * @param reason
1116  *   A reference to a string pointer where to store the reason why a mbuf is
1117  *   considered invalid.
1118  * @return
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.
1122  */
1123 __rte_experimental
1124 int rte_mbuf_check(const struct rte_mbuf *m, int is_header,
1125                    const char **reason);
1126
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);                          \
1132 } while (0)
1133
1134 /**
1135  * Allocate an uninitialized mbuf from mempool *mp*.
1136  *
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().
1141  *
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
1145  * by the caller.
1146  *
1147  * @param mp
1148  *   The mempool from which mbuf is allocated.
1149  * @return
1150  *   - The pointer to the new mbuf on success.
1151  *   - NULL if allocation failed.
1152  */
1153 static inline struct rte_mbuf *rte_mbuf_raw_alloc(struct rte_mempool *mp)
1154 {
1155         struct rte_mbuf *m;
1156
1157         if (rte_mempool_get(mp, (void **)&m) < 0)
1158                 return NULL;
1159         MBUF_RAW_ALLOC_CHECK(m);
1160         return m;
1161 }
1162
1163 /**
1164  * Put mbuf back into its original mempool.
1165  *
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().
1169  *
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().
1173  *
1174  * @param m
1175  *   The mbuf to be freed.
1176  */
1177 static __rte_always_inline void
1178 rte_mbuf_raw_free(struct rte_mbuf *m)
1179 {
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);
1186 }
1187
1188 /**
1189  * The packet mbuf constructor.
1190  *
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.
1195  *
1196  * @param mp
1197  *   The mempool from which mbufs originate.
1198  * @param opaque_arg
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().
1202  * @param m
1203  *   The mbuf to initialize.
1204  * @param i
1205  *   The index of the mbuf in the pool table.
1206  */
1207 void rte_pktmbuf_init(struct rte_mempool *mp, void *opaque_arg,
1208                       void *m, unsigned i);
1209
1210
1211 /**
1212  * A  packet mbuf pool constructor.
1213  *
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.
1220  *
1221  * @param mp
1222  *   The mempool from which mbufs originate.
1223  * @param opaque_arg
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().
1227  */
1228 void rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg);
1229
1230 /**
1231  * Create a mbuf pool.
1232  *
1233  * This function creates and initializes a packet mbuf pool. It is
1234  * a wrapper to rte_mempool functions.
1235  *
1236  * @param name
1237  *   The name of the mbuf pool.
1238  * @param n
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:
1241  *   n = (2^q - 1).
1242  * @param cache_size
1243  *   Size of the per-core object cache. See rte_mempool_create() for
1244  *   details.
1245  * @param priv_size
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.
1250  * @param socket_id
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
1253  *   reserved zone.
1254  * @return
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
1263  */
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,
1267         int socket_id);
1268
1269 /**
1270  * Create a mbuf pool with a given mempool ops name
1271  *
1272  * This function creates and initializes a packet mbuf pool. It is
1273  * a wrapper to rte_mempool functions.
1274  *
1275  * @param name
1276  *   The name of the mbuf pool.
1277  * @param n
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:
1280  *   n = (2^q - 1).
1281  * @param cache_size
1282  *   Size of the per-core object cache. See rte_mempool_create() for
1283  *   details.
1284  * @param priv_size
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.
1289  * @param socket_id
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
1292  *   reserved zone.
1293  * @param ops_name
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.
1296  * @return
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
1305  */
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);
1310
1311 /**
1312  * Get the data room size of mbufs stored in a pktmbuf_pool
1313  *
1314  * The data room size is the amount of data that can be stored in a
1315  * mbuf including the headroom (RTE_PKTMBUF_HEADROOM).
1316  *
1317  * @param mp
1318  *   The packet mbuf pool.
1319  * @return
1320  *   The data room size of mbufs stored in this mempool.
1321  */
1322 static inline uint16_t
1323 rte_pktmbuf_data_room_size(struct rte_mempool *mp)
1324 {
1325         struct rte_pktmbuf_pool_private *mbp_priv;
1326
1327         mbp_priv = (struct rte_pktmbuf_pool_private *)rte_mempool_get_priv(mp);
1328         return mbp_priv->mbuf_data_room_size;
1329 }
1330
1331 /**
1332  * Get the application private size of mbufs stored in a pktmbuf_pool
1333  *
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.
1337  *
1338  * @param mp
1339  *   The packet mbuf pool.
1340  * @return
1341  *   The private size of mbufs stored in this mempool.
1342  */
1343 static inline uint16_t
1344 rte_pktmbuf_priv_size(struct rte_mempool *mp)
1345 {
1346         struct rte_pktmbuf_pool_private *mbp_priv;
1347
1348         mbp_priv = (struct rte_pktmbuf_pool_private *)rte_mempool_get_priv(mp);
1349         return mbp_priv->mbuf_priv_size;
1350 }
1351
1352 /**
1353  * Reset the data_off field of a packet mbuf to its default value.
1354  *
1355  * The given mbuf must have only one segment, which should be empty.
1356  *
1357  * @param m
1358  *   The packet mbuf's data_off field has to be reset.
1359  */
1360 static inline void rte_pktmbuf_reset_headroom(struct rte_mbuf *m)
1361 {
1362         m->data_off = (uint16_t)RTE_MIN((uint16_t)RTE_PKTMBUF_HEADROOM,
1363                                         (uint16_t)m->buf_len);
1364 }
1365
1366 /**
1367  * Reset the fields of a packet mbuf to their default values.
1368  *
1369  * The given mbuf must have only one segment.
1370  *
1371  * @param m
1372  *   The packet mbuf to be resetted.
1373  */
1374 #define MBUF_INVALID_PORT UINT16_MAX
1375
1376 static inline void rte_pktmbuf_reset(struct rte_mbuf *m)
1377 {
1378         m->next = NULL;
1379         m->pkt_len = 0;
1380         m->tx_offload = 0;
1381         m->vlan_tci = 0;
1382         m->vlan_tci_outer = 0;
1383         m->nb_segs = 1;
1384         m->port = MBUF_INVALID_PORT;
1385
1386         m->ol_flags = 0;
1387         m->packet_type = 0;
1388         rte_pktmbuf_reset_headroom(m);
1389
1390         m->data_len = 0;
1391         __rte_mbuf_sanity_check(m, 1);
1392 }
1393
1394 /**
1395  * Allocate a new mbuf from a mempool.
1396  *
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).
1400  *
1401  * @param mp
1402  *   The mempool from which the mbuf is allocated.
1403  * @return
1404  *   - The pointer to the new mbuf on success.
1405  *   - NULL if allocation failed.
1406  */
1407 static inline struct rte_mbuf *rte_pktmbuf_alloc(struct rte_mempool *mp)
1408 {
1409         struct rte_mbuf *m;
1410         if ((m = rte_mbuf_raw_alloc(mp)) != NULL)
1411                 rte_pktmbuf_reset(m);
1412         return m;
1413 }
1414
1415 /**
1416  * Allocate a bulk of mbufs, initialize refcnt and reset the fields to default
1417  * values.
1418  *
1419  *  @param pool
1420  *    The mempool from which mbufs are allocated.
1421  *  @param mbufs
1422  *    Array of pointers to mbufs
1423  *  @param count
1424  *    Array size
1425  *  @return
1426  *   - 0: Success
1427  *   - -ENOENT: Not enough entries in the mempool; no mbufs are retrieved.
1428  */
1429 static inline int rte_pktmbuf_alloc_bulk(struct rte_mempool *pool,
1430          struct rte_mbuf **mbufs, unsigned count)
1431 {
1432         unsigned idx = 0;
1433         int rc;
1434
1435         rc = rte_mempool_get_bulk(pool, (void **)mbufs, count);
1436         if (unlikely(rc))
1437                 return rc;
1438
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.
1443          */
1444         switch (count % 4) {
1445         case 0:
1446                 while (idx != count) {
1447                         MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1448                         rte_pktmbuf_reset(mbufs[idx]);
1449                         idx++;
1450                         /* fall-through */
1451         case 3:
1452                         MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1453                         rte_pktmbuf_reset(mbufs[idx]);
1454                         idx++;
1455                         /* fall-through */
1456         case 2:
1457                         MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1458                         rte_pktmbuf_reset(mbufs[idx]);
1459                         idx++;
1460                         /* fall-through */
1461         case 1:
1462                         MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1463                         rte_pktmbuf_reset(mbufs[idx]);
1464                         idx++;
1465                         /* fall-through */
1466                 }
1467         }
1468         return 0;
1469 }
1470
1471 /**
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.
1478  *
1479  * Free callback and its argument is saved and the refcnt is set to 1.
1480  *
1481  * @warning
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()``
1485  *
1486  * @param buf_addr
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.
1493  * @param free_cb
1494  *   Free callback function to call when the external buffer needs to be
1495  *   freed.
1496  * @param fcb_opaque
1497  *   Argument for the free callback function.
1498  *
1499  * @return
1500  *   A pointer to the initialized shared data on success, return NULL
1501  *   otherwise.
1502  */
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)
1506 {
1507         struct rte_mbuf_ext_shared_info *shinfo;
1508         void *buf_end = RTE_PTR_ADD(buf_addr, *buf_len);
1509         void *addr;
1510
1511         addr = RTE_PTR_ALIGN_FLOOR(RTE_PTR_SUB(buf_end, sizeof(*shinfo)),
1512                                    sizeof(uintptr_t));
1513         if (addr <= buf_addr)
1514                 return NULL;
1515
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);
1520
1521         *buf_len = (uint16_t)RTE_PTR_DIFF(shinfo, buf_addr);
1522         return shinfo;
1523 }
1524
1525 /**
1526  * Attach an external buffer to a mbuf.
1527  *
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).
1532  *
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.
1536  *
1537  * More mbufs can be attached to the same external buffer by
1538  * ``rte_pktmbuf_attach()`` once the external buffer has been attached by
1539  * this API.
1540  *
1541  * Detachment can be done by either ``rte_pktmbuf_detach_extbuf()`` or
1542  * ``rte_pktmbuf_detach()``.
1543  *
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:
1550  *
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);
1557  *
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.
1569  *
1570  * @param m
1571  *   The pointer to the mbuf.
1572  * @param buf_addr
1573  *   The pointer to the external buffer.
1574  * @param buf_iova
1575  *   IO address of the external buffer.
1576  * @param buf_len
1577  *   The size of the external buffer.
1578  * @param shinfo
1579  *   User-provided memory for shared data of the external buffer.
1580  */
1581 static inline void
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)
1585 {
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);
1589
1590         m->buf_addr = buf_addr;
1591         m->buf_iova = buf_iova;
1592         m->buf_len = buf_len;
1593
1594         m->data_len = 0;
1595         m->data_off = 0;
1596
1597         m->ol_flags |= EXT_ATTACHED_MBUF;
1598         m->shinfo = shinfo;
1599 }
1600
1601 /**
1602  * Detach the external buffer attached to a mbuf, same as
1603  * ``rte_pktmbuf_detach()``
1604  *
1605  * @param m
1606  *   The mbuf having external buffer.
1607  */
1608 #define rte_pktmbuf_detach_extbuf(m) rte_pktmbuf_detach(m)
1609
1610 /**
1611  * Attach packet mbuf to another packet mbuf.
1612  *
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.
1616  *
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.
1620  *
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.
1625  *
1626  * @param mi
1627  *   The indirect packet mbuf.
1628  * @param m
1629  *   The packet mbuf we're attaching to.
1630  */
1631 static inline void rte_pktmbuf_attach(struct rte_mbuf *mi, struct rte_mbuf *m)
1632 {
1633         RTE_ASSERT(RTE_MBUF_DIRECT(mi) &&
1634             rte_mbuf_refcnt_read(mi) == 1);
1635
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;
1640         } else {
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;
1645         }
1646
1647         mi->buf_iova = m->buf_iova;
1648         mi->buf_addr = m->buf_addr;
1649         mi->buf_len = m->buf_len;
1650
1651         mi->data_off = m->data_off;
1652         mi->data_len = m->data_len;
1653         mi->port = m->port;
1654         mi->vlan_tci = m->vlan_tci;
1655         mi->vlan_tci_outer = m->vlan_tci_outer;
1656         mi->tx_offload = m->tx_offload;
1657         mi->hash = m->hash;
1658
1659         mi->next = NULL;
1660         mi->pkt_len = mi->data_len;
1661         mi->nb_segs = 1;
1662         mi->packet_type = m->packet_type;
1663         mi->timestamp = m->timestamp;
1664
1665         __rte_mbuf_sanity_check(mi, 1);
1666         __rte_mbuf_sanity_check(m, 0);
1667 }
1668
1669 /**
1670  * @internal used by rte_pktmbuf_detach().
1671  *
1672  * Decrement the reference counter of the external buffer. When the
1673  * reference counter becomes 0, the buffer is freed by pre-registered
1674  * callback.
1675  */
1676 static inline void
1677 __rte_pktmbuf_free_extbuf(struct rte_mbuf *m)
1678 {
1679         RTE_ASSERT(RTE_MBUF_HAS_EXTBUF(m));
1680         RTE_ASSERT(m->shinfo != NULL);
1681
1682         if (rte_mbuf_ext_refcnt_update(m->shinfo, -1) == 0)
1683                 m->shinfo->free_cb(m->buf_addr, m->shinfo->fcb_opaque);
1684 }
1685
1686 /**
1687  * @internal used by rte_pktmbuf_detach().
1688  *
1689  * Decrement the direct mbuf's reference counter. When the reference
1690  * counter becomes 0, the direct mbuf is freed.
1691  */
1692 static inline void
1693 __rte_pktmbuf_free_direct(struct rte_mbuf *m)
1694 {
1695         struct rte_mbuf *md;
1696
1697         RTE_ASSERT(RTE_MBUF_CLONED(m));
1698
1699         md = rte_mbuf_from_indirect(m);
1700
1701         if (rte_mbuf_refcnt_update(md, -1) == 0) {
1702                 md->next = NULL;
1703                 md->nb_segs = 1;
1704                 rte_mbuf_refcnt_set(md, 1);
1705                 rte_mbuf_raw_free(md);
1706         }
1707 }
1708
1709 /**
1710  * Detach a packet mbuf from external buffer or direct buffer.
1711  *
1712  *  - decrement refcnt and free the external/direct buffer if refcnt
1713  *    becomes zero.
1714  *  - restore original mbuf address and length values.
1715  *  - reset pktmbuf data and data_len to their default values.
1716  *
1717  * All other fields of the given packet mbuf will be left intact.
1718  *
1719  * @param m
1720  *   The indirect attached packet mbuf.
1721  */
1722 static inline void rte_pktmbuf_detach(struct rte_mbuf *m)
1723 {
1724         struct rte_mempool *mp = m->pool;
1725         uint32_t mbuf_size, buf_len;
1726         uint16_t priv_size;
1727
1728         if (RTE_MBUF_HAS_EXTBUF(m))
1729                 __rte_pktmbuf_free_extbuf(m);
1730         else
1731                 __rte_pktmbuf_free_direct(m);
1732
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);
1736
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);
1742         m->data_len = 0;
1743         m->ol_flags = 0;
1744 }
1745
1746 /**
1747  * Decrease reference counter and unlink a mbuf segment
1748  *
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.
1753  *
1754  * @param m
1755  *   The mbuf to be unlinked
1756  * @return
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.
1759  */
1760 static __rte_always_inline struct rte_mbuf *
1761 rte_pktmbuf_prefree_seg(struct rte_mbuf *m)
1762 {
1763         __rte_mbuf_sanity_check(m, 0);
1764
1765         if (likely(rte_mbuf_refcnt_read(m) == 1)) {
1766
1767                 if (!RTE_MBUF_DIRECT(m))
1768                         rte_pktmbuf_detach(m);
1769
1770                 if (m->next != NULL) {
1771                         m->next = NULL;
1772                         m->nb_segs = 1;
1773                 }
1774
1775                 return m;
1776
1777         } else if (__rte_mbuf_refcnt_update(m, -1) == 0) {
1778
1779                 if (!RTE_MBUF_DIRECT(m))
1780                         rte_pktmbuf_detach(m);
1781
1782                 if (m->next != NULL) {
1783                         m->next = NULL;
1784                         m->nb_segs = 1;
1785                 }
1786                 rte_mbuf_refcnt_set(m, 1);
1787
1788                 return m;
1789         }
1790         return NULL;
1791 }
1792
1793 /**
1794  * Free a segment of a packet mbuf into its original mempool.
1795  *
1796  * Free an mbuf, without parsing other segments in case of chained
1797  * buffers.
1798  *
1799  * @param m
1800  *   The packet mbuf segment to be freed.
1801  */
1802 static __rte_always_inline void
1803 rte_pktmbuf_free_seg(struct rte_mbuf *m)
1804 {
1805         m = rte_pktmbuf_prefree_seg(m);
1806         if (likely(m != NULL))
1807                 rte_mbuf_raw_free(m);
1808 }
1809
1810 /**
1811  * Free a packet mbuf back into its original mempool.
1812  *
1813  * Free an mbuf, and all its segments in case of chained buffers. Each
1814  * segment is added back into its original mempool.
1815  *
1816  * @param m
1817  *   The packet mbuf to be freed. If NULL, the function does nothing.
1818  */
1819 static inline void rte_pktmbuf_free(struct rte_mbuf *m)
1820 {
1821         struct rte_mbuf *m_next;
1822
1823         if (m != NULL)
1824                 __rte_mbuf_sanity_check(m, 1);
1825
1826         while (m != NULL) {
1827                 m_next = m->next;
1828                 rte_pktmbuf_free_seg(m);
1829                 m = m_next;
1830         }
1831 }
1832
1833 /**
1834  * Creates a "clone" of the given packet mbuf.
1835  *
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.
1841  *
1842  * @param md
1843  *   The packet mbuf to be cloned.
1844  * @param mp
1845  *   The mempool from which the "clone" mbufs are allocated.
1846  * @return
1847  *   - The pointer to the new "clone" mbuf on success.
1848  *   - NULL if allocation fails.
1849  */
1850 static inline struct rte_mbuf *rte_pktmbuf_clone(struct rte_mbuf *md,
1851                 struct rte_mempool *mp)
1852 {
1853         struct rte_mbuf *mc, *mi, **prev;
1854         uint32_t pktlen;
1855         uint16_t nseg;
1856
1857         if (unlikely ((mc = rte_pktmbuf_alloc(mp)) == NULL))
1858                 return NULL;
1859
1860         mi = mc;
1861         prev = &mi->next;
1862         pktlen = md->pkt_len;
1863         nseg = 0;
1864
1865         do {
1866                 nseg++;
1867                 rte_pktmbuf_attach(mi, md);
1868                 *prev = mi;
1869                 prev = &mi->next;
1870         } while ((md = md->next) != NULL &&
1871             (mi = rte_pktmbuf_alloc(mp)) != NULL);
1872
1873         *prev = NULL;
1874         mc->nb_segs = nseg;
1875         mc->pkt_len = pktlen;
1876
1877         /* Allocation of new indirect segment failed */
1878         if (unlikely (mi == NULL)) {
1879                 rte_pktmbuf_free(mc);
1880                 return NULL;
1881         }
1882
1883         __rte_mbuf_sanity_check(mc, 1);
1884         return mc;
1885 }
1886
1887 /**
1888  * Adds given value to the refcnt of all packet mbuf segments.
1889  *
1890  * Walks through all segments of given packet mbuf and for each of them
1891  * invokes rte_mbuf_refcnt_update().
1892  *
1893  * @param m
1894  *   The packet mbuf whose refcnt to be updated.
1895  * @param v
1896  *   The value to add to the mbuf's segments refcnt.
1897  */
1898 static inline void rte_pktmbuf_refcnt_update(struct rte_mbuf *m, int16_t v)
1899 {
1900         __rte_mbuf_sanity_check(m, 1);
1901
1902         do {
1903                 rte_mbuf_refcnt_update(m, v);
1904         } while ((m = m->next) != NULL);
1905 }
1906
1907 /**
1908  * Get the headroom in a packet mbuf.
1909  *
1910  * @param m
1911  *   The packet mbuf.
1912  * @return
1913  *   The length of the headroom.
1914  */
1915 static inline uint16_t rte_pktmbuf_headroom(const struct rte_mbuf *m)
1916 {
1917         __rte_mbuf_sanity_check(m, 0);
1918         return m->data_off;
1919 }
1920
1921 /**
1922  * Get the tailroom of a packet mbuf.
1923  *
1924  * @param m
1925  *   The packet mbuf.
1926  * @return
1927  *   The length of the tailroom.
1928  */
1929 static inline uint16_t rte_pktmbuf_tailroom(const struct rte_mbuf *m)
1930 {
1931         __rte_mbuf_sanity_check(m, 0);
1932         return (uint16_t)(m->buf_len - rte_pktmbuf_headroom(m) -
1933                           m->data_len);
1934 }
1935
1936 /**
1937  * Get the last segment of the packet.
1938  *
1939  * @param m
1940  *   The packet mbuf.
1941  * @return
1942  *   The last segment of the given mbuf.
1943  */
1944 static inline struct rte_mbuf *rte_pktmbuf_lastseg(struct rte_mbuf *m)
1945 {
1946         __rte_mbuf_sanity_check(m, 1);
1947         while (m->next != NULL)
1948                 m = m->next;
1949         return m;
1950 }
1951
1952 /**
1953  * A macro that points to an offset into the data in the mbuf.
1954  *
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.
1958  *
1959  * @param m
1960  *   The packet mbuf.
1961  * @param o
1962  *   The offset into the mbuf data.
1963  * @param t
1964  *   The type to cast the result into.
1965  */
1966 #define rte_pktmbuf_mtod_offset(m, t, o)        \
1967         ((t)((char *)(m)->buf_addr + (m)->data_off + (o)))
1968
1969 /**
1970  * A macro that points to the start of the data in the mbuf.
1971  *
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.
1975  *
1976  * @param m
1977  *   The packet mbuf.
1978  * @param t
1979  *   The type to cast the result into.
1980  */
1981 #define rte_pktmbuf_mtod(m, t) rte_pktmbuf_mtod_offset(m, t, 0)
1982
1983 /**
1984  * A macro that returns the IO address that points to an offset of the
1985  * start of the data in the mbuf
1986  *
1987  * @param m
1988  *   The packet mbuf.
1989  * @param o
1990  *   The offset into the data to calculate address from.
1991  */
1992 #define rte_pktmbuf_iova_offset(m, o) \
1993         (rte_iova_t)((m)->buf_iova + (m)->data_off + (o))
1994
1995 /* deprecated */
1996 #define rte_pktmbuf_mtophys_offset(m, o) \
1997         rte_pktmbuf_iova_offset(m, o)
1998
1999 /**
2000  * A macro that returns the IO address that points to the start of the
2001  * data in the mbuf
2002  *
2003  * @param m
2004  *   The packet mbuf.
2005  */
2006 #define rte_pktmbuf_iova(m) rte_pktmbuf_iova_offset(m, 0)
2007
2008 /* deprecated */
2009 #define rte_pktmbuf_mtophys(m) rte_pktmbuf_iova(m)
2010
2011 /**
2012  * A macro that returns the length of the packet.
2013  *
2014  * The value can be read or assigned.
2015  *
2016  * @param m
2017  *   The packet mbuf.
2018  */
2019 #define rte_pktmbuf_pkt_len(m) ((m)->pkt_len)
2020
2021 /**
2022  * A macro that returns the length of the segment.
2023  *
2024  * The value can be read or assigned.
2025  *
2026  * @param m
2027  *   The packet mbuf.
2028  */
2029 #define rte_pktmbuf_data_len(m) ((m)->data_len)
2030
2031 /**
2032  * Prepend len bytes to an mbuf data area.
2033  *
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.
2037  *
2038  * @param m
2039  *   The pkt mbuf.
2040  * @param len
2041  *   The amount of data to prepend (in bytes).
2042  * @return
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
2045  */
2046 static inline char *rte_pktmbuf_prepend(struct rte_mbuf *m,
2047                                         uint16_t len)
2048 {
2049         __rte_mbuf_sanity_check(m, 1);
2050
2051         if (unlikely(len > rte_pktmbuf_headroom(m)))
2052                 return NULL;
2053
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);
2060
2061         return (char *)m->buf_addr + m->data_off;
2062 }
2063
2064 /**
2065  * Append len bytes to an mbuf.
2066  *
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.
2070  *
2071  * @param m
2072  *   The packet mbuf.
2073  * @param len
2074  *   The amount of data to append (in bytes).
2075  * @return
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
2078  */
2079 static inline char *rte_pktmbuf_append(struct rte_mbuf *m, uint16_t len)
2080 {
2081         void *tail;
2082         struct rte_mbuf *m_last;
2083
2084         __rte_mbuf_sanity_check(m, 1);
2085
2086         m_last = rte_pktmbuf_lastseg(m);
2087         if (unlikely(len > rte_pktmbuf_tailroom(m_last)))
2088                 return NULL;
2089
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;
2094 }
2095
2096 /**
2097  * Remove len bytes at the beginning of an mbuf.
2098  *
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.
2102  *
2103  * @param m
2104  *   The packet mbuf.
2105  * @param len
2106  *   The amount of data to remove (in bytes).
2107  * @return
2108  *   A pointer to the new start of the data.
2109  */
2110 static inline char *rte_pktmbuf_adj(struct rte_mbuf *m, uint16_t len)
2111 {
2112         __rte_mbuf_sanity_check(m, 1);
2113
2114         if (unlikely(len > m->data_len))
2115                 return NULL;
2116
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;
2124 }
2125
2126 /**
2127  * Remove len bytes of data at the end of the mbuf.
2128  *
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.
2131  *
2132  * @param m
2133  *   The packet mbuf.
2134  * @param len
2135  *   The amount of data to remove (in bytes).
2136  * @return
2137  *   - 0: On success.
2138  *   - -1: On error.
2139  */
2140 static inline int rte_pktmbuf_trim(struct rte_mbuf *m, uint16_t len)
2141 {
2142         struct rte_mbuf *m_last;
2143
2144         __rte_mbuf_sanity_check(m, 1);
2145
2146         m_last = rte_pktmbuf_lastseg(m);
2147         if (unlikely(len > m_last->data_len))
2148                 return -1;
2149
2150         m_last->data_len = (uint16_t)(m_last->data_len - len);
2151         m->pkt_len  = (m->pkt_len - len);
2152         return 0;
2153 }
2154
2155 /**
2156  * Test if mbuf data is contiguous.
2157  *
2158  * @param m
2159  *   The packet mbuf.
2160  * @return
2161  *   - 1, if all data is contiguous (one segment).
2162  *   - 0, if there is several segments.
2163  */
2164 static inline int rte_pktmbuf_is_contiguous(const struct rte_mbuf *m)
2165 {
2166         __rte_mbuf_sanity_check(m, 1);
2167         return !!(m->nb_segs == 1);
2168 }
2169
2170 /**
2171  * @internal used by rte_pktmbuf_read().
2172  */
2173 const void *__rte_pktmbuf_read(const struct rte_mbuf *m, uint32_t off,
2174         uint32_t len, void *buf);
2175
2176 /**
2177  * Read len data bytes in a mbuf at specified offset.
2178  *
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
2181  * pointer.
2182  *
2183  * @param m
2184  *   The pointer to the mbuf.
2185  * @param off
2186  *   The offset of the data in the mbuf.
2187  * @param len
2188  *   The amount of bytes to read.
2189  * @param buf
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.
2192  * @return
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.
2195  */
2196 static inline const void *rte_pktmbuf_read(const struct rte_mbuf *m,
2197         uint32_t off, uint32_t len, void *buf)
2198 {
2199         if (likely(off + len <= rte_pktmbuf_data_len(m)))
2200                 return rte_pktmbuf_mtod_offset(m, char *, off);
2201         else
2202                 return __rte_pktmbuf_read(m, off, len, buf);
2203 }
2204
2205 /**
2206  * Chain an mbuf to another, thereby creating a segmented packet.
2207  *
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.
2211  *
2212  * @param head
2213  *   The head of the mbuf chain (the first packet)
2214  * @param tail
2215  *   The mbuf to put last in the chain
2216  *
2217  * @return
2218  *   - 0, on success.
2219  *   - -EOVERFLOW, if the chain segment limit exceeded
2220  */
2221 static inline int rte_pktmbuf_chain(struct rte_mbuf *head, struct rte_mbuf *tail)
2222 {
2223         struct rte_mbuf *cur_tail;
2224
2225         /* Check for number-of-segments-overflow */
2226         if (head->nb_segs + tail->nb_segs > RTE_MBUF_MAX_NB_SEGS)
2227                 return -EOVERFLOW;
2228
2229         /* Chain 'tail' onto the old tail */
2230         cur_tail = rte_pktmbuf_lastseg(head);
2231         cur_tail->next = tail;
2232
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;
2239
2240         /* pkt_len is only set in the head */
2241         tail->pkt_len = tail->data_len;
2242
2243         return 0;
2244 }
2245
2246 /**
2247  * Validate general requirements for Tx offload in mbuf.
2248  *
2249  * This function checks correctness and completeness of Tx offload settings.
2250  *
2251  * @param m
2252  *   The packet mbuf to be validated.
2253  * @return
2254  *   0 if packet is valid
2255  */
2256 static inline int
2257 rte_validate_tx_offload(const struct rte_mbuf *m)
2258 {
2259         uint64_t ol_flags = m->ol_flags;
2260         uint64_t inner_l3_offset = m->l2_len;
2261
2262         /* Does packet set any of available offloads? */
2263         if (!(ol_flags & PKT_TX_OFFLOAD_MASK))
2264                 return 0;
2265
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 +
2271                                   m->outer_l3_len;
2272
2273         /* Headers are fragmented */
2274         if (rte_pktmbuf_data_len(m) < inner_l3_offset + m->l3_len + m->l4_len)
2275                 return -ENOTSUP;
2276
2277         /* IP checksum can be counted only for IPv4 packet */
2278         if ((ol_flags & PKT_TX_IP_CKSUM) && (ol_flags & PKT_TX_IPV6))
2279                 return -EINVAL;
2280
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)))
2284                         return -EINVAL;
2285
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)))
2291                         return -EINVAL;
2292
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))
2296                 return -EINVAL;
2297
2298         return 0;
2299 }
2300
2301 /**
2302  * Linearize data in mbuf.
2303  *
2304  * This function moves the mbuf data in the first segment if there is enough
2305  * tailroom. The subsequent segments are unchained and freed.
2306  *
2307  * @param mbuf
2308  *   mbuf to linearize
2309  * @return
2310  *   - 0, on success
2311  *   - -1, on error
2312  */
2313 static inline int
2314 rte_pktmbuf_linearize(struct rte_mbuf *mbuf)
2315 {
2316         size_t seg_len, copy_len;
2317         struct rte_mbuf *m;
2318         struct rte_mbuf *m_next;
2319         char *buffer;
2320
2321         if (rte_pktmbuf_is_contiguous(mbuf))
2322                 return 0;
2323
2324         /* Extend first segment to the total packet length */
2325         copy_len = rte_pktmbuf_pkt_len(mbuf) - rte_pktmbuf_data_len(mbuf);
2326
2327         if (unlikely(copy_len > rte_pktmbuf_tailroom(mbuf)))
2328                 return -1;
2329
2330         buffer = rte_pktmbuf_mtod_offset(mbuf, char *, mbuf->data_len);
2331         mbuf->data_len = (uint16_t)(mbuf->pkt_len);
2332
2333         /* Append data from next segments to the first one */
2334         m = mbuf->next;
2335         while (m != NULL) {
2336                 m_next = m->next;
2337
2338                 seg_len = rte_pktmbuf_data_len(m);
2339                 rte_memcpy(buffer, rte_pktmbuf_mtod(m, char *), seg_len);
2340                 buffer += seg_len;
2341
2342                 rte_pktmbuf_free_seg(m);
2343                 m = m_next;
2344         }
2345
2346         mbuf->next = NULL;
2347         mbuf->nb_segs = 1;
2348
2349         return 0;
2350 }
2351
2352 /**
2353  * Dump an mbuf structure to a file.
2354  *
2355  * Dump all fields for the given packet mbuf and all its associated
2356  * segments (in the case of a chained buffer).
2357  *
2358  * @param f
2359  *   A pointer to a file for output
2360  * @param m
2361  *   The packet mbuf.
2362  * @param dump_len
2363  *   If dump_len != 0, also dump the "dump_len" first data bytes of
2364  *   the packet.
2365  */
2366 void rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len);
2367
2368 /**
2369  * Get the value of mbuf sched queue_id field.
2370  */
2371 static inline uint32_t
2372 rte_mbuf_sched_queue_get(const struct rte_mbuf *m)
2373 {
2374         return m->hash.sched.queue_id;
2375 }
2376
2377 /**
2378  * Get the value of mbuf sched traffic_class field.
2379  */
2380 static inline uint8_t
2381 rte_mbuf_sched_traffic_class_get(const struct rte_mbuf *m)
2382 {
2383         return m->hash.sched.traffic_class;
2384 }
2385
2386 /**
2387  * Get the value of mbuf sched color field.
2388  */
2389 static inline uint8_t
2390 rte_mbuf_sched_color_get(const struct rte_mbuf *m)
2391 {
2392         return m->hash.sched.color;
2393 }
2394
2395 /**
2396  * Get the values of mbuf sched queue_id, traffic_class and color.
2397  *
2398  * @param m
2399  *   Mbuf to read
2400  * @param queue_id
2401  *  Returns the queue id
2402  * @param traffic_class
2403  *  Returns the traffic class id
2404  * @param color
2405  *  Returns the colour id
2406  */
2407 static inline void
2408 rte_mbuf_sched_get(const struct rte_mbuf *m, uint32_t *queue_id,
2409                         uint8_t *traffic_class,
2410                         uint8_t *color)
2411 {
2412         struct rte_mbuf_sched sched = m->hash.sched;
2413
2414         *queue_id = sched.queue_id;
2415         *traffic_class = sched.traffic_class;
2416         *color = sched.color;
2417 }
2418
2419 /**
2420  * Set the mbuf sched queue_id to the defined value.
2421  */
2422 static inline void
2423 rte_mbuf_sched_queue_set(struct rte_mbuf *m, uint32_t queue_id)
2424 {
2425         m->hash.sched.queue_id = queue_id;
2426 }
2427
2428 /**
2429  * Set the mbuf sched traffic_class id to the defined value.
2430  */
2431 static inline void
2432 rte_mbuf_sched_traffic_class_set(struct rte_mbuf *m, uint8_t traffic_class)
2433 {
2434         m->hash.sched.traffic_class = traffic_class;
2435 }
2436
2437 /**
2438  * Set the mbuf sched color id to the defined value.
2439  */
2440 static inline void
2441 rte_mbuf_sched_color_set(struct rte_mbuf *m, uint8_t color)
2442 {
2443         m->hash.sched.color = color;
2444 }
2445
2446 /**
2447  * Set the mbuf sched queue_id, traffic_class and color.
2448  *
2449  * @param m
2450  *   Mbuf to set
2451  * @param queue_id
2452  *  Queue id value to be set
2453  * @param traffic_class
2454  *  Traffic class id value to be set
2455  * @param color
2456  *  Color id to be set
2457  */
2458 static inline void
2459 rte_mbuf_sched_set(struct rte_mbuf *m, uint32_t queue_id,
2460                         uint8_t traffic_class,
2461                         uint8_t color)
2462 {
2463         m->hash.sched = (struct rte_mbuf_sched){
2464                                 .queue_id = queue_id,
2465                                 .traffic_class = traffic_class,
2466                                 .color = color,
2467                                 .reserved = 0,
2468                         };
2469 }
2470
2471 #ifdef __cplusplus
2472 }
2473 #endif
2474
2475 #endif /* _RTE_MBUF_H_ */