mbuf: add a non fatal sanity check helper
[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 the buffer address embedded in the given mbuf.
795  *
796  * @param md
797  *   The pointer to the mbuf.
798  * @return
799  *   The address of the data buffer owned by the mbuf.
800  */
801 static inline char *
802 rte_mbuf_to_baddr(struct rte_mbuf *md)
803 {
804         char *buffer_addr;
805         buffer_addr = (char *)md + sizeof(*md) + rte_pktmbuf_priv_size(md->pool);
806         return buffer_addr;
807 }
808
809 /**
810  * Return the starting address of the private data area embedded in
811  * the given mbuf.
812  *
813  * Note that no check is made to ensure that a private data area
814  * actually exists in the supplied mbuf.
815  *
816  * @param m
817  *   The pointer to the mbuf.
818  * @return
819  *   The starting address of the private data area of the given mbuf.
820  */
821 static inline void * __rte_experimental
822 rte_mbuf_to_priv(struct rte_mbuf *m)
823 {
824         return RTE_PTR_ADD(m, sizeof(struct rte_mbuf));
825 }
826
827 /**
828  * Returns TRUE if given mbuf is cloned by mbuf indirection, or FALSE
829  * otherwise.
830  *
831  * If a mbuf has its data in another mbuf and references it by mbuf
832  * indirection, this mbuf can be defined as a cloned mbuf.
833  */
834 #define RTE_MBUF_CLONED(mb)     ((mb)->ol_flags & IND_ATTACHED_MBUF)
835
836 /**
837  * Returns TRUE if given mbuf has an external buffer, or FALSE otherwise.
838  *
839  * External buffer is a user-provided anonymous buffer.
840  */
841 #define RTE_MBUF_HAS_EXTBUF(mb) ((mb)->ol_flags & EXT_ATTACHED_MBUF)
842
843 /**
844  * Returns TRUE if given mbuf is direct, or FALSE otherwise.
845  *
846  * If a mbuf embeds its own data after the rte_mbuf structure, this mbuf
847  * can be defined as a direct mbuf.
848  */
849 #define RTE_MBUF_DIRECT(mb) \
850         (!((mb)->ol_flags & (IND_ATTACHED_MBUF | EXT_ATTACHED_MBUF)))
851
852 /**
853  * Private data in case of pktmbuf pool.
854  *
855  * A structure that contains some pktmbuf_pool-specific data that are
856  * appended after the mempool structure (in private data).
857  */
858 struct rte_pktmbuf_pool_private {
859         uint16_t mbuf_data_room_size; /**< Size of data space in each mbuf. */
860         uint16_t mbuf_priv_size;      /**< Size of private area in each mbuf. */
861 };
862
863 #ifdef RTE_LIBRTE_MBUF_DEBUG
864
865 /**  check mbuf type in debug mode */
866 #define __rte_mbuf_sanity_check(m, is_h) rte_mbuf_sanity_check(m, is_h)
867
868 #else /*  RTE_LIBRTE_MBUF_DEBUG */
869
870 /**  check mbuf type in debug mode */
871 #define __rte_mbuf_sanity_check(m, is_h) do { } while (0)
872
873 #endif /*  RTE_LIBRTE_MBUF_DEBUG */
874
875 #ifdef RTE_MBUF_REFCNT_ATOMIC
876
877 /**
878  * Reads the value of an mbuf's refcnt.
879  * @param m
880  *   Mbuf to read
881  * @return
882  *   Reference count number.
883  */
884 static inline uint16_t
885 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
886 {
887         return (uint16_t)(rte_atomic16_read(&m->refcnt_atomic));
888 }
889
890 /**
891  * Sets an mbuf's refcnt to a defined value.
892  * @param m
893  *   Mbuf to update
894  * @param new_value
895  *   Value set
896  */
897 static inline void
898 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
899 {
900         rte_atomic16_set(&m->refcnt_atomic, (int16_t)new_value);
901 }
902
903 /* internal */
904 static inline uint16_t
905 __rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
906 {
907         return (uint16_t)(rte_atomic16_add_return(&m->refcnt_atomic, value));
908 }
909
910 /**
911  * Adds given value to an mbuf's refcnt and returns its new value.
912  * @param m
913  *   Mbuf to update
914  * @param value
915  *   Value to add/subtract
916  * @return
917  *   Updated value
918  */
919 static inline uint16_t
920 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
921 {
922         /*
923          * The atomic_add is an expensive operation, so we don't want to
924          * call it in the case where we know we are the uniq holder of
925          * this mbuf (i.e. ref_cnt == 1). Otherwise, an atomic
926          * operation has to be used because concurrent accesses on the
927          * reference counter can occur.
928          */
929         if (likely(rte_mbuf_refcnt_read(m) == 1)) {
930                 ++value;
931                 rte_mbuf_refcnt_set(m, (uint16_t)value);
932                 return (uint16_t)value;
933         }
934
935         return __rte_mbuf_refcnt_update(m, value);
936 }
937
938 #else /* ! RTE_MBUF_REFCNT_ATOMIC */
939
940 /* internal */
941 static inline uint16_t
942 __rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
943 {
944         m->refcnt = (uint16_t)(m->refcnt + value);
945         return m->refcnt;
946 }
947
948 /**
949  * Adds given value to an mbuf's refcnt and returns its new value.
950  */
951 static inline uint16_t
952 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
953 {
954         return __rte_mbuf_refcnt_update(m, value);
955 }
956
957 /**
958  * Reads the value of an mbuf's refcnt.
959  */
960 static inline uint16_t
961 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
962 {
963         return m->refcnt;
964 }
965
966 /**
967  * Sets an mbuf's refcnt to the defined value.
968  */
969 static inline void
970 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
971 {
972         m->refcnt = new_value;
973 }
974
975 #endif /* RTE_MBUF_REFCNT_ATOMIC */
976
977 /**
978  * Reads the refcnt of an external buffer.
979  *
980  * @param shinfo
981  *   Shared data of the external buffer.
982  * @return
983  *   Reference count number.
984  */
985 static inline uint16_t
986 rte_mbuf_ext_refcnt_read(const struct rte_mbuf_ext_shared_info *shinfo)
987 {
988         return (uint16_t)(rte_atomic16_read(&shinfo->refcnt_atomic));
989 }
990
991 /**
992  * Set refcnt of an external buffer.
993  *
994  * @param shinfo
995  *   Shared data of the external buffer.
996  * @param new_value
997  *   Value set
998  */
999 static inline void
1000 rte_mbuf_ext_refcnt_set(struct rte_mbuf_ext_shared_info *shinfo,
1001         uint16_t new_value)
1002 {
1003         rte_atomic16_set(&shinfo->refcnt_atomic, (int16_t)new_value);
1004 }
1005
1006 /**
1007  * Add given value to refcnt of an external buffer and return its new
1008  * value.
1009  *
1010  * @param shinfo
1011  *   Shared data of the external buffer.
1012  * @param value
1013  *   Value to add/subtract
1014  * @return
1015  *   Updated value
1016  */
1017 static inline uint16_t
1018 rte_mbuf_ext_refcnt_update(struct rte_mbuf_ext_shared_info *shinfo,
1019         int16_t value)
1020 {
1021         if (likely(rte_mbuf_ext_refcnt_read(shinfo) == 1)) {
1022                 ++value;
1023                 rte_mbuf_ext_refcnt_set(shinfo, (uint16_t)value);
1024                 return (uint16_t)value;
1025         }
1026
1027         return (uint16_t)rte_atomic16_add_return(&shinfo->refcnt_atomic, value);
1028 }
1029
1030 /** Mbuf prefetch */
1031 #define RTE_MBUF_PREFETCH_TO_FREE(m) do {       \
1032         if ((m) != NULL)                        \
1033                 rte_prefetch0(m);               \
1034 } while (0)
1035
1036
1037 /**
1038  * Sanity checks on an mbuf.
1039  *
1040  * Check the consistency of the given mbuf. The function will cause a
1041  * panic if corruption is detected.
1042  *
1043  * @param m
1044  *   The mbuf to be checked.
1045  * @param is_header
1046  *   True if the mbuf is a packet header, false if it is a sub-segment
1047  *   of a packet (in this case, some fields like nb_segs are not checked)
1048  */
1049 void
1050 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header);
1051
1052 /**
1053  * Sanity checks on a mbuf.
1054  *
1055  * Almost like rte_mbuf_sanity_check(), but this function gives the reason
1056  * if corruption is detected rather than panic.
1057  *
1058  * @param m
1059  *   The mbuf to be checked.
1060  * @param is_header
1061  *   True if the mbuf is a packet header, false if it is a sub-segment
1062  *   of a packet (in this case, some fields like nb_segs are not checked)
1063  * @param reason
1064  *   A reference to a string pointer where to store the reason why a mbuf is
1065  *   considered invalid.
1066  * @return
1067  *   - 0 if no issue has been found, reason is left untouched.
1068  *   - -1 if a problem is detected, reason then points to a string describing
1069  *     the reason why the mbuf is deemed invalid.
1070  */
1071 __rte_experimental
1072 int rte_mbuf_check(const struct rte_mbuf *m, int is_header,
1073                    const char **reason);
1074
1075 #define MBUF_RAW_ALLOC_CHECK(m) do {                            \
1076         RTE_ASSERT(rte_mbuf_refcnt_read(m) == 1);               \
1077         RTE_ASSERT((m)->next == NULL);                          \
1078         RTE_ASSERT((m)->nb_segs == 1);                          \
1079         __rte_mbuf_sanity_check(m, 0);                          \
1080 } while (0)
1081
1082 /**
1083  * Allocate an uninitialized mbuf from mempool *mp*.
1084  *
1085  * This function can be used by PMDs (especially in RX functions) to
1086  * allocate an uninitialized mbuf. The driver is responsible of
1087  * initializing all the required fields. See rte_pktmbuf_reset().
1088  * For standard needs, prefer rte_pktmbuf_alloc().
1089  *
1090  * The caller can expect that the following fields of the mbuf structure
1091  * are initialized: buf_addr, buf_iova, buf_len, refcnt=1, nb_segs=1,
1092  * next=NULL, pool, priv_size. The other fields must be initialized
1093  * by the caller.
1094  *
1095  * @param mp
1096  *   The mempool from which mbuf is allocated.
1097  * @return
1098  *   - The pointer to the new mbuf on success.
1099  *   - NULL if allocation failed.
1100  */
1101 static inline struct rte_mbuf *rte_mbuf_raw_alloc(struct rte_mempool *mp)
1102 {
1103         struct rte_mbuf *m;
1104
1105         if (rte_mempool_get(mp, (void **)&m) < 0)
1106                 return NULL;
1107         MBUF_RAW_ALLOC_CHECK(m);
1108         return m;
1109 }
1110
1111 /**
1112  * Put mbuf back into its original mempool.
1113  *
1114  * The caller must ensure that the mbuf is direct and properly
1115  * reinitialized (refcnt=1, next=NULL, nb_segs=1), as done by
1116  * rte_pktmbuf_prefree_seg().
1117  *
1118  * This function should be used with care, when optimization is
1119  * required. For standard needs, prefer rte_pktmbuf_free() or
1120  * rte_pktmbuf_free_seg().
1121  *
1122  * @param m
1123  *   The mbuf to be freed.
1124  */
1125 static __rte_always_inline void
1126 rte_mbuf_raw_free(struct rte_mbuf *m)
1127 {
1128         RTE_ASSERT(RTE_MBUF_DIRECT(m));
1129         RTE_ASSERT(rte_mbuf_refcnt_read(m) == 1);
1130         RTE_ASSERT(m->next == NULL);
1131         RTE_ASSERT(m->nb_segs == 1);
1132         __rte_mbuf_sanity_check(m, 0);
1133         rte_mempool_put(m->pool, m);
1134 }
1135
1136 /**
1137  * The packet mbuf constructor.
1138  *
1139  * This function initializes some fields in the mbuf structure that are
1140  * not modified by the user once created (origin pool, buffer start
1141  * address, and so on). This function is given as a callback function to
1142  * rte_mempool_obj_iter() or rte_mempool_create() at pool creation time.
1143  *
1144  * @param mp
1145  *   The mempool from which mbufs originate.
1146  * @param opaque_arg
1147  *   A pointer that can be used by the user to retrieve useful information
1148  *   for mbuf initialization. This pointer is the opaque argument passed to
1149  *   rte_mempool_obj_iter() or rte_mempool_create().
1150  * @param m
1151  *   The mbuf to initialize.
1152  * @param i
1153  *   The index of the mbuf in the pool table.
1154  */
1155 void rte_pktmbuf_init(struct rte_mempool *mp, void *opaque_arg,
1156                       void *m, unsigned i);
1157
1158
1159 /**
1160  * A  packet mbuf pool constructor.
1161  *
1162  * This function initializes the mempool private data in the case of a
1163  * pktmbuf pool. This private data is needed by the driver. The
1164  * function must be called on the mempool before it is used, or it
1165  * can be given as a callback function to rte_mempool_create() at
1166  * pool creation. It can be extended by the user, for example, to
1167  * provide another packet size.
1168  *
1169  * @param mp
1170  *   The mempool from which mbufs originate.
1171  * @param opaque_arg
1172  *   A pointer that can be used by the user to retrieve useful information
1173  *   for mbuf initialization. This pointer is the opaque argument passed to
1174  *   rte_mempool_create().
1175  */
1176 void rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg);
1177
1178 /**
1179  * Create a mbuf pool.
1180  *
1181  * This function creates and initializes a packet mbuf pool. It is
1182  * a wrapper to rte_mempool functions.
1183  *
1184  * @param name
1185  *   The name of the mbuf pool.
1186  * @param n
1187  *   The number of elements in the mbuf pool. The optimum size (in terms
1188  *   of memory usage) for a mempool is when n is a power of two minus one:
1189  *   n = (2^q - 1).
1190  * @param cache_size
1191  *   Size of the per-core object cache. See rte_mempool_create() for
1192  *   details.
1193  * @param priv_size
1194  *   Size of application private are between the rte_mbuf structure
1195  *   and the data buffer. This value must be aligned to RTE_MBUF_PRIV_ALIGN.
1196  * @param data_room_size
1197  *   Size of data buffer in each mbuf, including RTE_PKTMBUF_HEADROOM.
1198  * @param socket_id
1199  *   The socket identifier where the memory should be allocated. The
1200  *   value can be *SOCKET_ID_ANY* if there is no NUMA constraint for the
1201  *   reserved zone.
1202  * @return
1203  *   The pointer to the new allocated mempool, on success. NULL on error
1204  *   with rte_errno set appropriately. Possible rte_errno values include:
1205  *    - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
1206  *    - E_RTE_SECONDARY - function was called from a secondary process instance
1207  *    - EINVAL - cache size provided is too large, or priv_size is not aligned.
1208  *    - ENOSPC - the maximum number of memzones has already been allocated
1209  *    - EEXIST - a memzone with the same name already exists
1210  *    - ENOMEM - no appropriate memory area found in which to create memzone
1211  */
1212 struct rte_mempool *
1213 rte_pktmbuf_pool_create(const char *name, unsigned n,
1214         unsigned cache_size, uint16_t priv_size, uint16_t data_room_size,
1215         int socket_id);
1216
1217 /**
1218  * Create a mbuf pool with a given mempool ops name
1219  *
1220  * This function creates and initializes a packet mbuf pool. It is
1221  * a wrapper to rte_mempool functions.
1222  *
1223  * @param name
1224  *   The name of the mbuf pool.
1225  * @param n
1226  *   The number of elements in the mbuf pool. The optimum size (in terms
1227  *   of memory usage) for a mempool is when n is a power of two minus one:
1228  *   n = (2^q - 1).
1229  * @param cache_size
1230  *   Size of the per-core object cache. See rte_mempool_create() for
1231  *   details.
1232  * @param priv_size
1233  *   Size of application private are between the rte_mbuf structure
1234  *   and the data buffer. This value must be aligned to RTE_MBUF_PRIV_ALIGN.
1235  * @param data_room_size
1236  *   Size of data buffer in each mbuf, including RTE_PKTMBUF_HEADROOM.
1237  * @param socket_id
1238  *   The socket identifier where the memory should be allocated. The
1239  *   value can be *SOCKET_ID_ANY* if there is no NUMA constraint for the
1240  *   reserved zone.
1241  * @param ops_name
1242  *   The mempool ops name to be used for this mempool instead of
1243  *   default mempool. The value can be *NULL* to use default mempool.
1244  * @return
1245  *   The pointer to the new allocated mempool, on success. NULL on error
1246  *   with rte_errno set appropriately. Possible rte_errno values include:
1247  *    - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
1248  *    - E_RTE_SECONDARY - function was called from a secondary process instance
1249  *    - EINVAL - cache size provided is too large, or priv_size is not aligned.
1250  *    - ENOSPC - the maximum number of memzones has already been allocated
1251  *    - EEXIST - a memzone with the same name already exists
1252  *    - ENOMEM - no appropriate memory area found in which to create memzone
1253  */
1254 struct rte_mempool *
1255 rte_pktmbuf_pool_create_by_ops(const char *name, unsigned int n,
1256         unsigned int cache_size, uint16_t priv_size, uint16_t data_room_size,
1257         int socket_id, const char *ops_name);
1258
1259 /**
1260  * Get the data room size of mbufs stored in a pktmbuf_pool
1261  *
1262  * The data room size is the amount of data that can be stored in a
1263  * mbuf including the headroom (RTE_PKTMBUF_HEADROOM).
1264  *
1265  * @param mp
1266  *   The packet mbuf pool.
1267  * @return
1268  *   The data room size of mbufs stored in this mempool.
1269  */
1270 static inline uint16_t
1271 rte_pktmbuf_data_room_size(struct rte_mempool *mp)
1272 {
1273         struct rte_pktmbuf_pool_private *mbp_priv;
1274
1275         mbp_priv = (struct rte_pktmbuf_pool_private *)rte_mempool_get_priv(mp);
1276         return mbp_priv->mbuf_data_room_size;
1277 }
1278
1279 /**
1280  * Get the application private size of mbufs stored in a pktmbuf_pool
1281  *
1282  * The private size of mbuf is a zone located between the rte_mbuf
1283  * structure and the data buffer where an application can store data
1284  * associated to a packet.
1285  *
1286  * @param mp
1287  *   The packet mbuf pool.
1288  * @return
1289  *   The private size of mbufs stored in this mempool.
1290  */
1291 static inline uint16_t
1292 rte_pktmbuf_priv_size(struct rte_mempool *mp)
1293 {
1294         struct rte_pktmbuf_pool_private *mbp_priv;
1295
1296         mbp_priv = (struct rte_pktmbuf_pool_private *)rte_mempool_get_priv(mp);
1297         return mbp_priv->mbuf_priv_size;
1298 }
1299
1300 /**
1301  * Reset the data_off field of a packet mbuf to its default value.
1302  *
1303  * The given mbuf must have only one segment, which should be empty.
1304  *
1305  * @param m
1306  *   The packet mbuf's data_off field has to be reset.
1307  */
1308 static inline void rte_pktmbuf_reset_headroom(struct rte_mbuf *m)
1309 {
1310         m->data_off = (uint16_t)RTE_MIN((uint16_t)RTE_PKTMBUF_HEADROOM,
1311                                         (uint16_t)m->buf_len);
1312 }
1313
1314 /**
1315  * Reset the fields of a packet mbuf to their default values.
1316  *
1317  * The given mbuf must have only one segment.
1318  *
1319  * @param m
1320  *   The packet mbuf to be resetted.
1321  */
1322 #define MBUF_INVALID_PORT UINT16_MAX
1323
1324 static inline void rte_pktmbuf_reset(struct rte_mbuf *m)
1325 {
1326         m->next = NULL;
1327         m->pkt_len = 0;
1328         m->tx_offload = 0;
1329         m->vlan_tci = 0;
1330         m->vlan_tci_outer = 0;
1331         m->nb_segs = 1;
1332         m->port = MBUF_INVALID_PORT;
1333
1334         m->ol_flags = 0;
1335         m->packet_type = 0;
1336         rte_pktmbuf_reset_headroom(m);
1337
1338         m->data_len = 0;
1339         __rte_mbuf_sanity_check(m, 1);
1340 }
1341
1342 /**
1343  * Allocate a new mbuf from a mempool.
1344  *
1345  * This new mbuf contains one segment, which has a length of 0. The pointer
1346  * to data is initialized to have some bytes of headroom in the buffer
1347  * (if buffer size allows).
1348  *
1349  * @param mp
1350  *   The mempool from which the mbuf is allocated.
1351  * @return
1352  *   - The pointer to the new mbuf on success.
1353  *   - NULL if allocation failed.
1354  */
1355 static inline struct rte_mbuf *rte_pktmbuf_alloc(struct rte_mempool *mp)
1356 {
1357         struct rte_mbuf *m;
1358         if ((m = rte_mbuf_raw_alloc(mp)) != NULL)
1359                 rte_pktmbuf_reset(m);
1360         return m;
1361 }
1362
1363 /**
1364  * Allocate a bulk of mbufs, initialize refcnt and reset the fields to default
1365  * values.
1366  *
1367  *  @param pool
1368  *    The mempool from which mbufs are allocated.
1369  *  @param mbufs
1370  *    Array of pointers to mbufs
1371  *  @param count
1372  *    Array size
1373  *  @return
1374  *   - 0: Success
1375  *   - -ENOENT: Not enough entries in the mempool; no mbufs are retrieved.
1376  */
1377 static inline int rte_pktmbuf_alloc_bulk(struct rte_mempool *pool,
1378          struct rte_mbuf **mbufs, unsigned count)
1379 {
1380         unsigned idx = 0;
1381         int rc;
1382
1383         rc = rte_mempool_get_bulk(pool, (void **)mbufs, count);
1384         if (unlikely(rc))
1385                 return rc;
1386
1387         /* To understand duff's device on loop unwinding optimization, see
1388          * https://en.wikipedia.org/wiki/Duff's_device.
1389          * Here while() loop is used rather than do() while{} to avoid extra
1390          * check if count is zero.
1391          */
1392         switch (count % 4) {
1393         case 0:
1394                 while (idx != count) {
1395                         MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1396                         rte_pktmbuf_reset(mbufs[idx]);
1397                         idx++;
1398                         /* fall-through */
1399         case 3:
1400                         MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1401                         rte_pktmbuf_reset(mbufs[idx]);
1402                         idx++;
1403                         /* fall-through */
1404         case 2:
1405                         MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1406                         rte_pktmbuf_reset(mbufs[idx]);
1407                         idx++;
1408                         /* fall-through */
1409         case 1:
1410                         MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1411                         rte_pktmbuf_reset(mbufs[idx]);
1412                         idx++;
1413                         /* fall-through */
1414                 }
1415         }
1416         return 0;
1417 }
1418
1419 /**
1420  * Initialize shared data at the end of an external buffer before attaching
1421  * to a mbuf by ``rte_pktmbuf_attach_extbuf()``. This is not a mandatory
1422  * initialization but a helper function to simply spare a few bytes at the
1423  * end of the buffer for shared data. If shared data is allocated
1424  * separately, this should not be called but application has to properly
1425  * initialize the shared data according to its need.
1426  *
1427  * Free callback and its argument is saved and the refcnt is set to 1.
1428  *
1429  * @warning
1430  * The value of buf_len will be reduced to RTE_PTR_DIFF(shinfo, buf_addr)
1431  * after this initialization. This shall be used for
1432  * ``rte_pktmbuf_attach_extbuf()``
1433  *
1434  * @param buf_addr
1435  *   The pointer to the external buffer.
1436  * @param [in,out] buf_len
1437  *   The pointer to length of the external buffer. Input value must be
1438  *   larger than the size of ``struct rte_mbuf_ext_shared_info`` and
1439  *   padding for alignment. If not enough, this function will return NULL.
1440  *   Adjusted buffer length will be returned through this pointer.
1441  * @param free_cb
1442  *   Free callback function to call when the external buffer needs to be
1443  *   freed.
1444  * @param fcb_opaque
1445  *   Argument for the free callback function.
1446  *
1447  * @return
1448  *   A pointer to the initialized shared data on success, return NULL
1449  *   otherwise.
1450  */
1451 static inline struct rte_mbuf_ext_shared_info *
1452 rte_pktmbuf_ext_shinfo_init_helper(void *buf_addr, uint16_t *buf_len,
1453         rte_mbuf_extbuf_free_callback_t free_cb, void *fcb_opaque)
1454 {
1455         struct rte_mbuf_ext_shared_info *shinfo;
1456         void *buf_end = RTE_PTR_ADD(buf_addr, *buf_len);
1457         void *addr;
1458
1459         addr = RTE_PTR_ALIGN_FLOOR(RTE_PTR_SUB(buf_end, sizeof(*shinfo)),
1460                                    sizeof(uintptr_t));
1461         if (addr <= buf_addr)
1462                 return NULL;
1463
1464         shinfo = (struct rte_mbuf_ext_shared_info *)addr;
1465         shinfo->free_cb = free_cb;
1466         shinfo->fcb_opaque = fcb_opaque;
1467         rte_mbuf_ext_refcnt_set(shinfo, 1);
1468
1469         *buf_len = (uint16_t)RTE_PTR_DIFF(shinfo, buf_addr);
1470         return shinfo;
1471 }
1472
1473 /**
1474  * Attach an external buffer to a mbuf.
1475  *
1476  * User-managed anonymous buffer can be attached to an mbuf. When attaching
1477  * it, corresponding free callback function and its argument should be
1478  * provided via shinfo. This callback function will be called once all the
1479  * mbufs are detached from the buffer (refcnt becomes zero).
1480  *
1481  * The headroom for the attaching mbuf will be set to zero and this can be
1482  * properly adjusted after attachment. For example, ``rte_pktmbuf_adj()``
1483  * or ``rte_pktmbuf_reset_headroom()`` might be used.
1484  *
1485  * More mbufs can be attached to the same external buffer by
1486  * ``rte_pktmbuf_attach()`` once the external buffer has been attached by
1487  * this API.
1488  *
1489  * Detachment can be done by either ``rte_pktmbuf_detach_extbuf()`` or
1490  * ``rte_pktmbuf_detach()``.
1491  *
1492  * Memory for shared data must be provided and user must initialize all of
1493  * the content properly, escpecially free callback and refcnt. The pointer
1494  * of shared data will be stored in m->shinfo.
1495  * ``rte_pktmbuf_ext_shinfo_init_helper`` can help to simply spare a few
1496  * bytes at the end of buffer for the shared data, store free callback and
1497  * its argument and set the refcnt to 1. The following is an example:
1498  *
1499  *   struct rte_mbuf_ext_shared_info *shinfo =
1500  *          rte_pktmbuf_ext_shinfo_init_helper(buf_addr, &buf_len,
1501  *                                             free_cb, fcb_arg);
1502  *   rte_pktmbuf_attach_extbuf(m, buf_addr, buf_iova, buf_len, shinfo);
1503  *   rte_pktmbuf_reset_headroom(m);
1504  *   rte_pktmbuf_adj(m, data_len);
1505  *
1506  * Attaching an external buffer is quite similar to mbuf indirection in
1507  * replacing buffer addresses and length of a mbuf, but a few differences:
1508  * - When an indirect mbuf is attached, refcnt of the direct mbuf would be
1509  *   2 as long as the direct mbuf itself isn't freed after the attachment.
1510  *   In such cases, the buffer area of a direct mbuf must be read-only. But
1511  *   external buffer has its own refcnt and it starts from 1. Unless
1512  *   multiple mbufs are attached to a mbuf having an external buffer, the
1513  *   external buffer is writable.
1514  * - There's no need to allocate buffer from a mempool. Any buffer can be
1515  *   attached with appropriate free callback and its IO address.
1516  * - Smaller metadata is required to maintain shared data such as refcnt.
1517  *
1518  * @param m
1519  *   The pointer to the mbuf.
1520  * @param buf_addr
1521  *   The pointer to the external buffer.
1522  * @param buf_iova
1523  *   IO address of the external buffer.
1524  * @param buf_len
1525  *   The size of the external buffer.
1526  * @param shinfo
1527  *   User-provided memory for shared data of the external buffer.
1528  */
1529 static inline void
1530 rte_pktmbuf_attach_extbuf(struct rte_mbuf *m, void *buf_addr,
1531         rte_iova_t buf_iova, uint16_t buf_len,
1532         struct rte_mbuf_ext_shared_info *shinfo)
1533 {
1534         /* mbuf should not be read-only */
1535         RTE_ASSERT(RTE_MBUF_DIRECT(m) && rte_mbuf_refcnt_read(m) == 1);
1536         RTE_ASSERT(shinfo->free_cb != NULL);
1537
1538         m->buf_addr = buf_addr;
1539         m->buf_iova = buf_iova;
1540         m->buf_len = buf_len;
1541
1542         m->data_len = 0;
1543         m->data_off = 0;
1544
1545         m->ol_flags |= EXT_ATTACHED_MBUF;
1546         m->shinfo = shinfo;
1547 }
1548
1549 /**
1550  * Detach the external buffer attached to a mbuf, same as
1551  * ``rte_pktmbuf_detach()``
1552  *
1553  * @param m
1554  *   The mbuf having external buffer.
1555  */
1556 #define rte_pktmbuf_detach_extbuf(m) rte_pktmbuf_detach(m)
1557
1558 /**
1559  * Attach packet mbuf to another packet mbuf.
1560  *
1561  * If the mbuf we are attaching to isn't a direct buffer and is attached to
1562  * an external buffer, the mbuf being attached will be attached to the
1563  * external buffer instead of mbuf indirection.
1564  *
1565  * Otherwise, the mbuf will be indirectly attached. After attachment we
1566  * refer the mbuf we attached as 'indirect', while mbuf we attached to as
1567  * 'direct'.  The direct mbuf's reference counter is incremented.
1568  *
1569  * Right now, not supported:
1570  *  - attachment for already indirect mbuf (e.g. - mi has to be direct).
1571  *  - mbuf we trying to attach (mi) is used by someone else
1572  *    e.g. it's reference counter is greater then 1.
1573  *
1574  * @param mi
1575  *   The indirect packet mbuf.
1576  * @param m
1577  *   The packet mbuf we're attaching to.
1578  */
1579 static inline void rte_pktmbuf_attach(struct rte_mbuf *mi, struct rte_mbuf *m)
1580 {
1581         RTE_ASSERT(RTE_MBUF_DIRECT(mi) &&
1582             rte_mbuf_refcnt_read(mi) == 1);
1583
1584         if (RTE_MBUF_HAS_EXTBUF(m)) {
1585                 rte_mbuf_ext_refcnt_update(m->shinfo, 1);
1586                 mi->ol_flags = m->ol_flags;
1587                 mi->shinfo = m->shinfo;
1588         } else {
1589                 /* if m is not direct, get the mbuf that embeds the data */
1590                 rte_mbuf_refcnt_update(rte_mbuf_from_indirect(m), 1);
1591                 mi->priv_size = m->priv_size;
1592                 mi->ol_flags = m->ol_flags | IND_ATTACHED_MBUF;
1593         }
1594
1595         mi->buf_iova = m->buf_iova;
1596         mi->buf_addr = m->buf_addr;
1597         mi->buf_len = m->buf_len;
1598
1599         mi->data_off = m->data_off;
1600         mi->data_len = m->data_len;
1601         mi->port = m->port;
1602         mi->vlan_tci = m->vlan_tci;
1603         mi->vlan_tci_outer = m->vlan_tci_outer;
1604         mi->tx_offload = m->tx_offload;
1605         mi->hash = m->hash;
1606
1607         mi->next = NULL;
1608         mi->pkt_len = mi->data_len;
1609         mi->nb_segs = 1;
1610         mi->packet_type = m->packet_type;
1611         mi->timestamp = m->timestamp;
1612
1613         __rte_mbuf_sanity_check(mi, 1);
1614         __rte_mbuf_sanity_check(m, 0);
1615 }
1616
1617 /**
1618  * @internal used by rte_pktmbuf_detach().
1619  *
1620  * Decrement the reference counter of the external buffer. When the
1621  * reference counter becomes 0, the buffer is freed by pre-registered
1622  * callback.
1623  */
1624 static inline void
1625 __rte_pktmbuf_free_extbuf(struct rte_mbuf *m)
1626 {
1627         RTE_ASSERT(RTE_MBUF_HAS_EXTBUF(m));
1628         RTE_ASSERT(m->shinfo != NULL);
1629
1630         if (rte_mbuf_ext_refcnt_update(m->shinfo, -1) == 0)
1631                 m->shinfo->free_cb(m->buf_addr, m->shinfo->fcb_opaque);
1632 }
1633
1634 /**
1635  * @internal used by rte_pktmbuf_detach().
1636  *
1637  * Decrement the direct mbuf's reference counter. When the reference
1638  * counter becomes 0, the direct mbuf is freed.
1639  */
1640 static inline void
1641 __rte_pktmbuf_free_direct(struct rte_mbuf *m)
1642 {
1643         struct rte_mbuf *md;
1644
1645         RTE_ASSERT(RTE_MBUF_CLONED(m));
1646
1647         md = rte_mbuf_from_indirect(m);
1648
1649         if (rte_mbuf_refcnt_update(md, -1) == 0) {
1650                 md->next = NULL;
1651                 md->nb_segs = 1;
1652                 rte_mbuf_refcnt_set(md, 1);
1653                 rte_mbuf_raw_free(md);
1654         }
1655 }
1656
1657 /**
1658  * Detach a packet mbuf from external buffer or direct buffer.
1659  *
1660  *  - decrement refcnt and free the external/direct buffer if refcnt
1661  *    becomes zero.
1662  *  - restore original mbuf address and length values.
1663  *  - reset pktmbuf data and data_len to their default values.
1664  *
1665  * All other fields of the given packet mbuf will be left intact.
1666  *
1667  * @param m
1668  *   The indirect attached packet mbuf.
1669  */
1670 static inline void rte_pktmbuf_detach(struct rte_mbuf *m)
1671 {
1672         struct rte_mempool *mp = m->pool;
1673         uint32_t mbuf_size, buf_len;
1674         uint16_t priv_size;
1675
1676         if (RTE_MBUF_HAS_EXTBUF(m))
1677                 __rte_pktmbuf_free_extbuf(m);
1678         else
1679                 __rte_pktmbuf_free_direct(m);
1680
1681         priv_size = rte_pktmbuf_priv_size(mp);
1682         mbuf_size = (uint32_t)(sizeof(struct rte_mbuf) + priv_size);
1683         buf_len = rte_pktmbuf_data_room_size(mp);
1684
1685         m->priv_size = priv_size;
1686         m->buf_addr = (char *)m + mbuf_size;
1687         m->buf_iova = rte_mempool_virt2iova(m) + mbuf_size;
1688         m->buf_len = (uint16_t)buf_len;
1689         rte_pktmbuf_reset_headroom(m);
1690         m->data_len = 0;
1691         m->ol_flags = 0;
1692 }
1693
1694 /**
1695  * Decrease reference counter and unlink a mbuf segment
1696  *
1697  * This function does the same than a free, except that it does not
1698  * return the segment to its pool.
1699  * It decreases the reference counter, and if it reaches 0, it is
1700  * detached from its parent for an indirect mbuf.
1701  *
1702  * @param m
1703  *   The mbuf to be unlinked
1704  * @return
1705  *   - (m) if it is the last reference. It can be recycled or freed.
1706  *   - (NULL) if the mbuf still has remaining references on it.
1707  */
1708 static __rte_always_inline struct rte_mbuf *
1709 rte_pktmbuf_prefree_seg(struct rte_mbuf *m)
1710 {
1711         __rte_mbuf_sanity_check(m, 0);
1712
1713         if (likely(rte_mbuf_refcnt_read(m) == 1)) {
1714
1715                 if (!RTE_MBUF_DIRECT(m))
1716                         rte_pktmbuf_detach(m);
1717
1718                 if (m->next != NULL) {
1719                         m->next = NULL;
1720                         m->nb_segs = 1;
1721                 }
1722
1723                 return m;
1724
1725         } else if (__rte_mbuf_refcnt_update(m, -1) == 0) {
1726
1727                 if (!RTE_MBUF_DIRECT(m))
1728                         rte_pktmbuf_detach(m);
1729
1730                 if (m->next != NULL) {
1731                         m->next = NULL;
1732                         m->nb_segs = 1;
1733                 }
1734                 rte_mbuf_refcnt_set(m, 1);
1735
1736                 return m;
1737         }
1738         return NULL;
1739 }
1740
1741 /**
1742  * Free a segment of a packet mbuf into its original mempool.
1743  *
1744  * Free an mbuf, without parsing other segments in case of chained
1745  * buffers.
1746  *
1747  * @param m
1748  *   The packet mbuf segment to be freed.
1749  */
1750 static __rte_always_inline void
1751 rte_pktmbuf_free_seg(struct rte_mbuf *m)
1752 {
1753         m = rte_pktmbuf_prefree_seg(m);
1754         if (likely(m != NULL))
1755                 rte_mbuf_raw_free(m);
1756 }
1757
1758 /**
1759  * Free a packet mbuf back into its original mempool.
1760  *
1761  * Free an mbuf, and all its segments in case of chained buffers. Each
1762  * segment is added back into its original mempool.
1763  *
1764  * @param m
1765  *   The packet mbuf to be freed. If NULL, the function does nothing.
1766  */
1767 static inline void rte_pktmbuf_free(struct rte_mbuf *m)
1768 {
1769         struct rte_mbuf *m_next;
1770
1771         if (m != NULL)
1772                 __rte_mbuf_sanity_check(m, 1);
1773
1774         while (m != NULL) {
1775                 m_next = m->next;
1776                 rte_pktmbuf_free_seg(m);
1777                 m = m_next;
1778         }
1779 }
1780
1781 /**
1782  * Creates a "clone" of the given packet mbuf.
1783  *
1784  * Walks through all segments of the given packet mbuf, and for each of them:
1785  *  - Creates a new packet mbuf from the given pool.
1786  *  - Attaches newly created mbuf to the segment.
1787  * Then updates pkt_len and nb_segs of the "clone" packet mbuf to match values
1788  * from the original packet mbuf.
1789  *
1790  * @param md
1791  *   The packet mbuf to be cloned.
1792  * @param mp
1793  *   The mempool from which the "clone" mbufs are allocated.
1794  * @return
1795  *   - The pointer to the new "clone" mbuf on success.
1796  *   - NULL if allocation fails.
1797  */
1798 static inline struct rte_mbuf *rte_pktmbuf_clone(struct rte_mbuf *md,
1799                 struct rte_mempool *mp)
1800 {
1801         struct rte_mbuf *mc, *mi, **prev;
1802         uint32_t pktlen;
1803         uint16_t nseg;
1804
1805         if (unlikely ((mc = rte_pktmbuf_alloc(mp)) == NULL))
1806                 return NULL;
1807
1808         mi = mc;
1809         prev = &mi->next;
1810         pktlen = md->pkt_len;
1811         nseg = 0;
1812
1813         do {
1814                 nseg++;
1815                 rte_pktmbuf_attach(mi, md);
1816                 *prev = mi;
1817                 prev = &mi->next;
1818         } while ((md = md->next) != NULL &&
1819             (mi = rte_pktmbuf_alloc(mp)) != NULL);
1820
1821         *prev = NULL;
1822         mc->nb_segs = nseg;
1823         mc->pkt_len = pktlen;
1824
1825         /* Allocation of new indirect segment failed */
1826         if (unlikely (mi == NULL)) {
1827                 rte_pktmbuf_free(mc);
1828                 return NULL;
1829         }
1830
1831         __rte_mbuf_sanity_check(mc, 1);
1832         return mc;
1833 }
1834
1835 /**
1836  * Adds given value to the refcnt of all packet mbuf segments.
1837  *
1838  * Walks through all segments of given packet mbuf and for each of them
1839  * invokes rte_mbuf_refcnt_update().
1840  *
1841  * @param m
1842  *   The packet mbuf whose refcnt to be updated.
1843  * @param v
1844  *   The value to add to the mbuf's segments refcnt.
1845  */
1846 static inline void rte_pktmbuf_refcnt_update(struct rte_mbuf *m, int16_t v)
1847 {
1848         __rte_mbuf_sanity_check(m, 1);
1849
1850         do {
1851                 rte_mbuf_refcnt_update(m, v);
1852         } while ((m = m->next) != NULL);
1853 }
1854
1855 /**
1856  * Get the headroom in a packet mbuf.
1857  *
1858  * @param m
1859  *   The packet mbuf.
1860  * @return
1861  *   The length of the headroom.
1862  */
1863 static inline uint16_t rte_pktmbuf_headroom(const struct rte_mbuf *m)
1864 {
1865         __rte_mbuf_sanity_check(m, 0);
1866         return m->data_off;
1867 }
1868
1869 /**
1870  * Get the tailroom of a packet mbuf.
1871  *
1872  * @param m
1873  *   The packet mbuf.
1874  * @return
1875  *   The length of the tailroom.
1876  */
1877 static inline uint16_t rte_pktmbuf_tailroom(const struct rte_mbuf *m)
1878 {
1879         __rte_mbuf_sanity_check(m, 0);
1880         return (uint16_t)(m->buf_len - rte_pktmbuf_headroom(m) -
1881                           m->data_len);
1882 }
1883
1884 /**
1885  * Get the last segment of the packet.
1886  *
1887  * @param m
1888  *   The packet mbuf.
1889  * @return
1890  *   The last segment of the given mbuf.
1891  */
1892 static inline struct rte_mbuf *rte_pktmbuf_lastseg(struct rte_mbuf *m)
1893 {
1894         __rte_mbuf_sanity_check(m, 1);
1895         while (m->next != NULL)
1896                 m = m->next;
1897         return m;
1898 }
1899
1900 /**
1901  * A macro that points to an offset into the data in the mbuf.
1902  *
1903  * The returned pointer is cast to type t. Before using this
1904  * function, the user must ensure that the first segment is large
1905  * enough to accommodate its data.
1906  *
1907  * @param m
1908  *   The packet mbuf.
1909  * @param o
1910  *   The offset into the mbuf data.
1911  * @param t
1912  *   The type to cast the result into.
1913  */
1914 #define rte_pktmbuf_mtod_offset(m, t, o)        \
1915         ((t)((char *)(m)->buf_addr + (m)->data_off + (o)))
1916
1917 /**
1918  * A macro that points to the start of the data in the mbuf.
1919  *
1920  * The returned pointer is cast to type t. Before using this
1921  * function, the user must ensure that the first segment is large
1922  * enough to accommodate its data.
1923  *
1924  * @param m
1925  *   The packet mbuf.
1926  * @param t
1927  *   The type to cast the result into.
1928  */
1929 #define rte_pktmbuf_mtod(m, t) rte_pktmbuf_mtod_offset(m, t, 0)
1930
1931 /**
1932  * A macro that returns the IO address that points to an offset of the
1933  * start of the data in the mbuf
1934  *
1935  * @param m
1936  *   The packet mbuf.
1937  * @param o
1938  *   The offset into the data to calculate address from.
1939  */
1940 #define rte_pktmbuf_iova_offset(m, o) \
1941         (rte_iova_t)((m)->buf_iova + (m)->data_off + (o))
1942
1943 /* deprecated */
1944 #define rte_pktmbuf_mtophys_offset(m, o) \
1945         rte_pktmbuf_iova_offset(m, o)
1946
1947 /**
1948  * A macro that returns the IO address that points to the start of the
1949  * data in the mbuf
1950  *
1951  * @param m
1952  *   The packet mbuf.
1953  */
1954 #define rte_pktmbuf_iova(m) rte_pktmbuf_iova_offset(m, 0)
1955
1956 /* deprecated */
1957 #define rte_pktmbuf_mtophys(m) rte_pktmbuf_iova(m)
1958
1959 /**
1960  * A macro that returns the length of the packet.
1961  *
1962  * The value can be read or assigned.
1963  *
1964  * @param m
1965  *   The packet mbuf.
1966  */
1967 #define rte_pktmbuf_pkt_len(m) ((m)->pkt_len)
1968
1969 /**
1970  * A macro that returns the length of the segment.
1971  *
1972  * The value can be read or assigned.
1973  *
1974  * @param m
1975  *   The packet mbuf.
1976  */
1977 #define rte_pktmbuf_data_len(m) ((m)->data_len)
1978
1979 /**
1980  * Prepend len bytes to an mbuf data area.
1981  *
1982  * Returns a pointer to the new
1983  * data start address. If there is not enough headroom in the first
1984  * segment, the function will return NULL, without modifying the mbuf.
1985  *
1986  * @param m
1987  *   The pkt mbuf.
1988  * @param len
1989  *   The amount of data to prepend (in bytes).
1990  * @return
1991  *   A pointer to the start of the newly prepended data, or
1992  *   NULL if there is not enough headroom space in the first segment
1993  */
1994 static inline char *rte_pktmbuf_prepend(struct rte_mbuf *m,
1995                                         uint16_t len)
1996 {
1997         __rte_mbuf_sanity_check(m, 1);
1998
1999         if (unlikely(len > rte_pktmbuf_headroom(m)))
2000                 return NULL;
2001
2002         /* NB: elaborating the subtraction like this instead of using
2003          *     -= allows us to ensure the result type is uint16_t
2004          *     avoiding compiler warnings on gcc 8.1 at least */
2005         m->data_off = (uint16_t)(m->data_off - len);
2006         m->data_len = (uint16_t)(m->data_len + len);
2007         m->pkt_len  = (m->pkt_len + len);
2008
2009         return (char *)m->buf_addr + m->data_off;
2010 }
2011
2012 /**
2013  * Append len bytes to an mbuf.
2014  *
2015  * Append len bytes to an mbuf and return a pointer to the start address
2016  * of the added data. If there is not enough tailroom in the last
2017  * segment, the function will return NULL, without modifying the mbuf.
2018  *
2019  * @param m
2020  *   The packet mbuf.
2021  * @param len
2022  *   The amount of data to append (in bytes).
2023  * @return
2024  *   A pointer to the start of the newly appended data, or
2025  *   NULL if there is not enough tailroom space in the last segment
2026  */
2027 static inline char *rte_pktmbuf_append(struct rte_mbuf *m, uint16_t len)
2028 {
2029         void *tail;
2030         struct rte_mbuf *m_last;
2031
2032         __rte_mbuf_sanity_check(m, 1);
2033
2034         m_last = rte_pktmbuf_lastseg(m);
2035         if (unlikely(len > rte_pktmbuf_tailroom(m_last)))
2036                 return NULL;
2037
2038         tail = (char *)m_last->buf_addr + m_last->data_off + m_last->data_len;
2039         m_last->data_len = (uint16_t)(m_last->data_len + len);
2040         m->pkt_len  = (m->pkt_len + len);
2041         return (char*) tail;
2042 }
2043
2044 /**
2045  * Remove len bytes at the beginning of an mbuf.
2046  *
2047  * Returns a pointer to the start address of the new data area. If the
2048  * length is greater than the length of the first segment, then the
2049  * function will fail and return NULL, without modifying the mbuf.
2050  *
2051  * @param m
2052  *   The packet mbuf.
2053  * @param len
2054  *   The amount of data to remove (in bytes).
2055  * @return
2056  *   A pointer to the new start of the data.
2057  */
2058 static inline char *rte_pktmbuf_adj(struct rte_mbuf *m, uint16_t len)
2059 {
2060         __rte_mbuf_sanity_check(m, 1);
2061
2062         if (unlikely(len > m->data_len))
2063                 return NULL;
2064
2065         /* NB: elaborating the addition like this instead of using
2066          *     += allows us to ensure the result type is uint16_t
2067          *     avoiding compiler warnings on gcc 8.1 at least */
2068         m->data_len = (uint16_t)(m->data_len - len);
2069         m->data_off = (uint16_t)(m->data_off + len);
2070         m->pkt_len  = (m->pkt_len - len);
2071         return (char *)m->buf_addr + m->data_off;
2072 }
2073
2074 /**
2075  * Remove len bytes of data at the end of the mbuf.
2076  *
2077  * If the length is greater than the length of the last segment, the
2078  * function will fail and return -1 without modifying the mbuf.
2079  *
2080  * @param m
2081  *   The packet mbuf.
2082  * @param len
2083  *   The amount of data to remove (in bytes).
2084  * @return
2085  *   - 0: On success.
2086  *   - -1: On error.
2087  */
2088 static inline int rte_pktmbuf_trim(struct rte_mbuf *m, uint16_t len)
2089 {
2090         struct rte_mbuf *m_last;
2091
2092         __rte_mbuf_sanity_check(m, 1);
2093
2094         m_last = rte_pktmbuf_lastseg(m);
2095         if (unlikely(len > m_last->data_len))
2096                 return -1;
2097
2098         m_last->data_len = (uint16_t)(m_last->data_len - len);
2099         m->pkt_len  = (m->pkt_len - len);
2100         return 0;
2101 }
2102
2103 /**
2104  * Test if mbuf data is contiguous.
2105  *
2106  * @param m
2107  *   The packet mbuf.
2108  * @return
2109  *   - 1, if all data is contiguous (one segment).
2110  *   - 0, if there is several segments.
2111  */
2112 static inline int rte_pktmbuf_is_contiguous(const struct rte_mbuf *m)
2113 {
2114         __rte_mbuf_sanity_check(m, 1);
2115         return !!(m->nb_segs == 1);
2116 }
2117
2118 /**
2119  * @internal used by rte_pktmbuf_read().
2120  */
2121 const void *__rte_pktmbuf_read(const struct rte_mbuf *m, uint32_t off,
2122         uint32_t len, void *buf);
2123
2124 /**
2125  * Read len data bytes in a mbuf at specified offset.
2126  *
2127  * If the data is contiguous, return the pointer in the mbuf data, else
2128  * copy the data in the buffer provided by the user and return its
2129  * pointer.
2130  *
2131  * @param m
2132  *   The pointer to the mbuf.
2133  * @param off
2134  *   The offset of the data in the mbuf.
2135  * @param len
2136  *   The amount of bytes to read.
2137  * @param buf
2138  *   The buffer where data is copied if it is not contiguous in mbuf
2139  *   data. Its length should be at least equal to the len parameter.
2140  * @return
2141  *   The pointer to the data, either in the mbuf if it is contiguous,
2142  *   or in the user buffer. If mbuf is too small, NULL is returned.
2143  */
2144 static inline const void *rte_pktmbuf_read(const struct rte_mbuf *m,
2145         uint32_t off, uint32_t len, void *buf)
2146 {
2147         if (likely(off + len <= rte_pktmbuf_data_len(m)))
2148                 return rte_pktmbuf_mtod_offset(m, char *, off);
2149         else
2150                 return __rte_pktmbuf_read(m, off, len, buf);
2151 }
2152
2153 /**
2154  * Chain an mbuf to another, thereby creating a segmented packet.
2155  *
2156  * Note: The implementation will do a linear walk over the segments to find
2157  * the tail entry. For cases when there are many segments, it's better to
2158  * chain the entries manually.
2159  *
2160  * @param head
2161  *   The head of the mbuf chain (the first packet)
2162  * @param tail
2163  *   The mbuf to put last in the chain
2164  *
2165  * @return
2166  *   - 0, on success.
2167  *   - -EOVERFLOW, if the chain segment limit exceeded
2168  */
2169 static inline int rte_pktmbuf_chain(struct rte_mbuf *head, struct rte_mbuf *tail)
2170 {
2171         struct rte_mbuf *cur_tail;
2172
2173         /* Check for number-of-segments-overflow */
2174         if (head->nb_segs + tail->nb_segs > RTE_MBUF_MAX_NB_SEGS)
2175                 return -EOVERFLOW;
2176
2177         /* Chain 'tail' onto the old tail */
2178         cur_tail = rte_pktmbuf_lastseg(head);
2179         cur_tail->next = tail;
2180
2181         /* accumulate number of segments and total length.
2182          * NB: elaborating the addition like this instead of using
2183          *     -= allows us to ensure the result type is uint16_t
2184          *     avoiding compiler warnings on gcc 8.1 at least */
2185         head->nb_segs = (uint16_t)(head->nb_segs + tail->nb_segs);
2186         head->pkt_len += tail->pkt_len;
2187
2188         /* pkt_len is only set in the head */
2189         tail->pkt_len = tail->data_len;
2190
2191         return 0;
2192 }
2193
2194 /**
2195  * Validate general requirements for Tx offload in mbuf.
2196  *
2197  * This function checks correctness and completeness of Tx offload settings.
2198  *
2199  * @param m
2200  *   The packet mbuf to be validated.
2201  * @return
2202  *   0 if packet is valid
2203  */
2204 static inline int
2205 rte_validate_tx_offload(const struct rte_mbuf *m)
2206 {
2207         uint64_t ol_flags = m->ol_flags;
2208         uint64_t inner_l3_offset = m->l2_len;
2209
2210         /* Does packet set any of available offloads? */
2211         if (!(ol_flags & PKT_TX_OFFLOAD_MASK))
2212                 return 0;
2213
2214         if (ol_flags & PKT_TX_OUTER_IP_CKSUM)
2215                 /* NB: elaborating the addition like this instead of using
2216                  *     += gives the result uint64_t type instead of int,
2217                  *     avoiding compiler warnings on gcc 8.1 at least */
2218                 inner_l3_offset = inner_l3_offset + m->outer_l2_len +
2219                                   m->outer_l3_len;
2220
2221         /* Headers are fragmented */
2222         if (rte_pktmbuf_data_len(m) < inner_l3_offset + m->l3_len + m->l4_len)
2223                 return -ENOTSUP;
2224
2225         /* IP checksum can be counted only for IPv4 packet */
2226         if ((ol_flags & PKT_TX_IP_CKSUM) && (ol_flags & PKT_TX_IPV6))
2227                 return -EINVAL;
2228
2229         /* IP type not set when required */
2230         if (ol_flags & (PKT_TX_L4_MASK | PKT_TX_TCP_SEG))
2231                 if (!(ol_flags & (PKT_TX_IPV4 | PKT_TX_IPV6)))
2232                         return -EINVAL;
2233
2234         /* Check requirements for TSO packet */
2235         if (ol_flags & PKT_TX_TCP_SEG)
2236                 if ((m->tso_segsz == 0) ||
2237                                 ((ol_flags & PKT_TX_IPV4) &&
2238                                 !(ol_flags & PKT_TX_IP_CKSUM)))
2239                         return -EINVAL;
2240
2241         /* PKT_TX_OUTER_IP_CKSUM set for non outer IPv4 packet. */
2242         if ((ol_flags & PKT_TX_OUTER_IP_CKSUM) &&
2243                         !(ol_flags & PKT_TX_OUTER_IPV4))
2244                 return -EINVAL;
2245
2246         return 0;
2247 }
2248
2249 /**
2250  * Linearize data in mbuf.
2251  *
2252  * This function moves the mbuf data in the first segment if there is enough
2253  * tailroom. The subsequent segments are unchained and freed.
2254  *
2255  * @param mbuf
2256  *   mbuf to linearize
2257  * @return
2258  *   - 0, on success
2259  *   - -1, on error
2260  */
2261 static inline int
2262 rte_pktmbuf_linearize(struct rte_mbuf *mbuf)
2263 {
2264         size_t seg_len, copy_len;
2265         struct rte_mbuf *m;
2266         struct rte_mbuf *m_next;
2267         char *buffer;
2268
2269         if (rte_pktmbuf_is_contiguous(mbuf))
2270                 return 0;
2271
2272         /* Extend first segment to the total packet length */
2273         copy_len = rte_pktmbuf_pkt_len(mbuf) - rte_pktmbuf_data_len(mbuf);
2274
2275         if (unlikely(copy_len > rte_pktmbuf_tailroom(mbuf)))
2276                 return -1;
2277
2278         buffer = rte_pktmbuf_mtod_offset(mbuf, char *, mbuf->data_len);
2279         mbuf->data_len = (uint16_t)(mbuf->pkt_len);
2280
2281         /* Append data from next segments to the first one */
2282         m = mbuf->next;
2283         while (m != NULL) {
2284                 m_next = m->next;
2285
2286                 seg_len = rte_pktmbuf_data_len(m);
2287                 rte_memcpy(buffer, rte_pktmbuf_mtod(m, char *), seg_len);
2288                 buffer += seg_len;
2289
2290                 rte_pktmbuf_free_seg(m);
2291                 m = m_next;
2292         }
2293
2294         mbuf->next = NULL;
2295         mbuf->nb_segs = 1;
2296
2297         return 0;
2298 }
2299
2300 /**
2301  * Dump an mbuf structure to a file.
2302  *
2303  * Dump all fields for the given packet mbuf and all its associated
2304  * segments (in the case of a chained buffer).
2305  *
2306  * @param f
2307  *   A pointer to a file for output
2308  * @param m
2309  *   The packet mbuf.
2310  * @param dump_len
2311  *   If dump_len != 0, also dump the "dump_len" first data bytes of
2312  *   the packet.
2313  */
2314 void rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len);
2315
2316 /**
2317  * Get the value of mbuf sched queue_id field.
2318  */
2319 static inline uint32_t
2320 rte_mbuf_sched_queue_get(const struct rte_mbuf *m)
2321 {
2322         return m->hash.sched.queue_id;
2323 }
2324
2325 /**
2326  * Get the value of mbuf sched traffic_class field.
2327  */
2328 static inline uint8_t
2329 rte_mbuf_sched_traffic_class_get(const struct rte_mbuf *m)
2330 {
2331         return m->hash.sched.traffic_class;
2332 }
2333
2334 /**
2335  * Get the value of mbuf sched color field.
2336  */
2337 static inline uint8_t
2338 rte_mbuf_sched_color_get(const struct rte_mbuf *m)
2339 {
2340         return m->hash.sched.color;
2341 }
2342
2343 /**
2344  * Get the values of mbuf sched queue_id, traffic_class and color.
2345  *
2346  * @param m
2347  *   Mbuf to read
2348  * @param queue_id
2349  *  Returns the queue id
2350  * @param traffic_class
2351  *  Returns the traffic class id
2352  * @param color
2353  *  Returns the colour id
2354  */
2355 static inline void
2356 rte_mbuf_sched_get(const struct rte_mbuf *m, uint32_t *queue_id,
2357                         uint8_t *traffic_class,
2358                         uint8_t *color)
2359 {
2360         struct rte_mbuf_sched sched = m->hash.sched;
2361
2362         *queue_id = sched.queue_id;
2363         *traffic_class = sched.traffic_class;
2364         *color = sched.color;
2365 }
2366
2367 /**
2368  * Set the mbuf sched queue_id to the defined value.
2369  */
2370 static inline void
2371 rte_mbuf_sched_queue_set(struct rte_mbuf *m, uint32_t queue_id)
2372 {
2373         m->hash.sched.queue_id = queue_id;
2374 }
2375
2376 /**
2377  * Set the mbuf sched traffic_class id to the defined value.
2378  */
2379 static inline void
2380 rte_mbuf_sched_traffic_class_set(struct rte_mbuf *m, uint8_t traffic_class)
2381 {
2382         m->hash.sched.traffic_class = traffic_class;
2383 }
2384
2385 /**
2386  * Set the mbuf sched color id to the defined value.
2387  */
2388 static inline void
2389 rte_mbuf_sched_color_set(struct rte_mbuf *m, uint8_t color)
2390 {
2391         m->hash.sched.color = color;
2392 }
2393
2394 /**
2395  * Set the mbuf sched queue_id, traffic_class and color.
2396  *
2397  * @param m
2398  *   Mbuf to set
2399  * @param queue_id
2400  *  Queue id value to be set
2401  * @param traffic_class
2402  *  Traffic class id value to be set
2403  * @param color
2404  *  Color id to be set
2405  */
2406 static inline void
2407 rte_mbuf_sched_set(struct rte_mbuf *m, uint32_t queue_id,
2408                         uint8_t traffic_class,
2409                         uint8_t color)
2410 {
2411         m->hash.sched = (struct rte_mbuf_sched){
2412                                 .queue_id = queue_id,
2413                                 .traffic_class = traffic_class,
2414                                 .color = color,
2415                         };
2416 }
2417
2418 #ifdef __cplusplus
2419 }
2420 #endif
2421
2422 #endif /* _RTE_MBUF_H_ */