mbuf: add raw allocation function
[dpdk.git] / lib / librte_mbuf / rte_mbuf.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
5  *   Copyright 2014 6WIND S.A.
6  *   All rights reserved.
7  *
8  *   Redistribution and use in source and binary forms, with or without
9  *   modification, are permitted provided that the following conditions
10  *   are met:
11  *
12  *     * Redistributions of source code must retain the above copyright
13  *       notice, this list of conditions and the following disclaimer.
14  *     * Redistributions in binary form must reproduce the above copyright
15  *       notice, this list of conditions and the following disclaimer in
16  *       the documentation and/or other materials provided with the
17  *       distribution.
18  *     * Neither the name of Intel Corporation nor the names of its
19  *       contributors may be used to endorse or promote products derived
20  *       from this software without specific prior written permission.
21  *
22  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  */
34
35 #ifndef _RTE_MBUF_H_
36 #define _RTE_MBUF_H_
37
38 /**
39  * @file
40  * RTE Mbuf
41  *
42  * The mbuf library provides the ability to create and destroy buffers
43  * that may be used by the RTE application to store message
44  * buffers. The message buffers are stored in a mempool, using the
45  * RTE mempool library.
46  *
47  * This library provide an API to allocate/free packet mbufs, which are
48  * used to carry network packets.
49  *
50  * To understand the concepts of packet buffers or mbufs, you
51  * should read "TCP/IP Illustrated, Volume 2: The Implementation,
52  * Addison-Wesley, 1995, ISBN 0-201-63354-X from Richard Stevens"
53  * http://www.kohala.com/start/tcpipiv2.html
54  */
55
56 #include <stdint.h>
57 #include <rte_common.h>
58 #include <rte_mempool.h>
59 #include <rte_memory.h>
60 #include <rte_atomic.h>
61 #include <rte_prefetch.h>
62 #include <rte_branch_prediction.h>
63
64 #ifdef __cplusplus
65 extern "C" {
66 #endif
67
68 /*
69  * Packet Offload Features Flags. It also carry packet type information.
70  * Critical resources. Both rx/tx shared these bits. Be cautious on any change
71  *
72  * - RX flags start at bit position zero, and get added to the left of previous
73  *   flags.
74  * - The most-significant 3 bits are reserved for generic mbuf flags
75  * - TX flags therefore start at bit position 60 (i.e. 63-3), and new flags get
76  *   added to the right of the previously defined flags i.e. they should count
77  *   downwards, not upwards.
78  *
79  * Keep these flags synchronized with rte_get_rx_ol_flag_name() and
80  * rte_get_tx_ol_flag_name().
81  */
82 #define PKT_RX_VLAN_PKT      (1ULL << 0)  /**< RX packet is a 802.1q VLAN packet. */
83 #define PKT_RX_RSS_HASH      (1ULL << 1)  /**< RX packet with RSS hash result. */
84 #define PKT_RX_FDIR          (1ULL << 2)  /**< RX packet with FDIR match indicate. */
85 #define PKT_RX_L4_CKSUM_BAD  (1ULL << 3)  /**< L4 cksum of RX pkt. is not OK. */
86 #define PKT_RX_IP_CKSUM_BAD  (1ULL << 4)  /**< IP cksum of RX pkt. is not OK. */
87 #define PKT_RX_EIP_CKSUM_BAD (1ULL << 5)  /**< External IP header checksum error. */
88 #define PKT_RX_OVERSIZE      (0ULL << 0)  /**< Num of desc of an RX pkt oversize. */
89 #define PKT_RX_HBUF_OVERFLOW (0ULL << 0)  /**< Header buffer overflow. */
90 #define PKT_RX_RECIP_ERR     (0ULL << 0)  /**< Hardware processing error. */
91 #define PKT_RX_MAC_ERR       (0ULL << 0)  /**< MAC error. */
92 #define PKT_RX_IEEE1588_PTP  (1ULL << 9)  /**< RX IEEE1588 L2 Ethernet PT Packet. */
93 #define PKT_RX_IEEE1588_TMST (1ULL << 10) /**< RX IEEE1588 L2/L4 timestamped packet.*/
94 #define PKT_RX_FDIR_ID       (1ULL << 13) /**< FD id reported if FDIR match. */
95 #define PKT_RX_FDIR_FLX      (1ULL << 14) /**< Flexible bytes reported if FDIR match. */
96 #define PKT_RX_QINQ_PKT      (1ULL << 15)  /**< RX packet with double VLAN stripped. */
97 /* add new RX flags here */
98
99 /* add new TX flags here */
100
101 /**
102  * Second VLAN insertion (QinQ) flag.
103  */
104 #define PKT_TX_QINQ_PKT    (1ULL << 49)   /**< TX packet with double VLAN inserted. */
105
106 /**
107  * TCP segmentation offload. To enable this offload feature for a
108  * packet to be transmitted on hardware supporting TSO:
109  *  - set the PKT_TX_TCP_SEG flag in mbuf->ol_flags (this flag implies
110  *    PKT_TX_TCP_CKSUM)
111  *  - set the flag PKT_TX_IPV4 or PKT_TX_IPV6
112  *  - if it's IPv4, set the PKT_TX_IP_CKSUM flag and write the IP checksum
113  *    to 0 in the packet
114  *  - fill the mbuf offload information: l2_len, l3_len, l4_len, tso_segsz
115  *  - calculate the pseudo header checksum without taking ip_len in account,
116  *    and set it in the TCP header. Refer to rte_ipv4_phdr_cksum() and
117  *    rte_ipv6_phdr_cksum() that can be used as helpers.
118  */
119 #define PKT_TX_TCP_SEG       (1ULL << 50)
120
121 #define PKT_TX_IEEE1588_TMST (1ULL << 51) /**< TX IEEE1588 packet to timestamp. */
122
123 /**
124  * Bits 52+53 used for L4 packet type with checksum enabled: 00: Reserved,
125  * 01: TCP checksum, 10: SCTP checksum, 11: UDP checksum. To use hardware
126  * L4 checksum offload, the user needs to:
127  *  - fill l2_len and l3_len in mbuf
128  *  - set the flags PKT_TX_TCP_CKSUM, PKT_TX_SCTP_CKSUM or PKT_TX_UDP_CKSUM
129  *  - set the flag PKT_TX_IPV4 or PKT_TX_IPV6
130  *  - calculate the pseudo header checksum and set it in the L4 header (only
131  *    for TCP or UDP). See rte_ipv4_phdr_cksum() and rte_ipv6_phdr_cksum().
132  *    For SCTP, set the crc field to 0.
133  */
134 #define PKT_TX_L4_NO_CKSUM   (0ULL << 52) /**< Disable L4 cksum of TX pkt. */
135 #define PKT_TX_TCP_CKSUM     (1ULL << 52) /**< TCP cksum of TX pkt. computed by NIC. */
136 #define PKT_TX_SCTP_CKSUM    (2ULL << 52) /**< SCTP cksum of TX pkt. computed by NIC. */
137 #define PKT_TX_UDP_CKSUM     (3ULL << 52) /**< UDP cksum of TX pkt. computed by NIC. */
138 #define PKT_TX_L4_MASK       (3ULL << 52) /**< Mask for L4 cksum offload request. */
139
140 /**
141  * Offload the IP checksum in the hardware. The flag PKT_TX_IPV4 should
142  * also be set by the application, although a PMD will only check
143  * PKT_TX_IP_CKSUM.
144  *  - set the IP checksum field in the packet to 0
145  *  - fill the mbuf offload information: l2_len, l3_len
146  */
147 #define PKT_TX_IP_CKSUM      (1ULL << 54)
148
149 /**
150  * Packet is IPv4. This flag must be set when using any offload feature
151  * (TSO, L3 or L4 checksum) to tell the NIC that the packet is an IPv4
152  * packet. If the packet is a tunneled packet, this flag is related to
153  * the inner headers.
154  */
155 #define PKT_TX_IPV4          (1ULL << 55)
156
157 /**
158  * Packet is IPv6. This flag must be set when using an offload feature
159  * (TSO or L4 checksum) to tell the NIC that the packet is an IPv6
160  * packet. If the packet is a tunneled packet, this flag is related to
161  * the inner headers.
162  */
163 #define PKT_TX_IPV6          (1ULL << 56)
164
165 #define PKT_TX_VLAN_PKT      (1ULL << 57) /**< TX packet is a 802.1q VLAN packet. */
166
167 /**
168  * Offload the IP checksum of an external header in the hardware. The
169  * flag PKT_TX_OUTER_IPV4 should also be set by the application, alto ugh
170  * a PMD will only check PKT_TX_IP_CKSUM.  The IP checksum field in the
171  * packet must be set to 0.
172  *  - set the outer IP checksum field in the packet to 0
173  *  - fill the mbuf offload information: outer_l2_len, outer_l3_len
174  */
175 #define PKT_TX_OUTER_IP_CKSUM   (1ULL << 58)
176
177 /**
178  * Packet outer header is IPv4. This flag must be set when using any
179  * outer offload feature (L3 or L4 checksum) to tell the NIC that the
180  * outer header of the tunneled packet is an IPv4 packet.
181  */
182 #define PKT_TX_OUTER_IPV4   (1ULL << 59)
183
184 /**
185  * Packet outer header is IPv6. This flag must be set when using any
186  * outer offload feature (L4 checksum) to tell the NIC that the outer
187  * header of the tunneled packet is an IPv6 packet.
188  */
189 #define PKT_TX_OUTER_IPV6    (1ULL << 60)
190
191 #define __RESERVED           (1ULL << 61) /**< reserved for future mbuf use */
192
193 #define IND_ATTACHED_MBUF    (1ULL << 62) /**< Indirect attached mbuf */
194
195 /* Use final bit of flags to indicate a control mbuf */
196 #define CTRL_MBUF_FLAG       (1ULL << 63) /**< Mbuf contains control data */
197
198 /*
199  * 32 bits are divided into several fields to mark packet types. Note that
200  * each field is indexical.
201  * - Bit 3:0 is for L2 types.
202  * - Bit 7:4 is for L3 or outer L3 (for tunneling case) types.
203  * - Bit 11:8 is for L4 or outer L4 (for tunneling case) types.
204  * - Bit 15:12 is for tunnel types.
205  * - Bit 19:16 is for inner L2 types.
206  * - Bit 23:20 is for inner L3 types.
207  * - Bit 27:24 is for inner L4 types.
208  * - Bit 31:28 is reserved.
209  *
210  * To be compatible with Vector PMD, RTE_PTYPE_L3_IPV4, RTE_PTYPE_L3_IPV4_EXT,
211  * RTE_PTYPE_L3_IPV6, RTE_PTYPE_L3_IPV6_EXT, RTE_PTYPE_L4_TCP, RTE_PTYPE_L4_UDP
212  * and RTE_PTYPE_L4_SCTP should be kept as below in a contiguous 7 bits.
213  *
214  * Note that L3 types values are selected for checking IPV4/IPV6 header from
215  * performance point of view. Reading annotations of RTE_ETH_IS_IPV4_HDR and
216  * RTE_ETH_IS_IPV6_HDR is needed for any future changes of L3 type values.
217  *
218  * Note that the packet types of the same packet recognized by different
219  * hardware may be different, as different hardware may have different
220  * capability of packet type recognition.
221  *
222  * examples:
223  * <'ether type'=0x0800
224  * | 'version'=4, 'protocol'=0x29
225  * | 'version'=6, 'next header'=0x3A
226  * | 'ICMPv6 header'>
227  * will be recognized on i40e hardware as packet type combination of,
228  * RTE_PTYPE_L2_ETHER |
229  * RTE_PTYPE_L3_IPV4_EXT_UNKNOWN |
230  * RTE_PTYPE_TUNNEL_IP |
231  * RTE_PTYPE_INNER_L3_IPV6_EXT_UNKNOWN |
232  * RTE_PTYPE_INNER_L4_ICMP.
233  *
234  * <'ether type'=0x86DD
235  * | 'version'=6, 'next header'=0x2F
236  * | 'GRE header'
237  * | 'version'=6, 'next header'=0x11
238  * | 'UDP header'>
239  * will be recognized on i40e hardware as packet type combination of,
240  * RTE_PTYPE_L2_ETHER |
241  * RTE_PTYPE_L3_IPV6_EXT_UNKNOWN |
242  * RTE_PTYPE_TUNNEL_GRENAT |
243  * RTE_PTYPE_INNER_L3_IPV6_EXT_UNKNOWN |
244  * RTE_PTYPE_INNER_L4_UDP.
245  */
246 #define RTE_PTYPE_UNKNOWN                   0x00000000
247 /**
248  * Ethernet packet type.
249  * It is used for outer packet for tunneling cases.
250  *
251  * Packet format:
252  * <'ether type'=[0x0800|0x86DD]>
253  */
254 #define RTE_PTYPE_L2_ETHER                  0x00000001
255 /**
256  * Ethernet packet type for time sync.
257  *
258  * Packet format:
259  * <'ether type'=0x88F7>
260  */
261 #define RTE_PTYPE_L2_ETHER_TIMESYNC         0x00000002
262 /**
263  * ARP (Address Resolution Protocol) packet type.
264  *
265  * Packet format:
266  * <'ether type'=0x0806>
267  */
268 #define RTE_PTYPE_L2_ETHER_ARP              0x00000003
269 /**
270  * LLDP (Link Layer Discovery Protocol) packet type.
271  *
272  * Packet format:
273  * <'ether type'=0x88CC>
274  */
275 #define RTE_PTYPE_L2_ETHER_LLDP             0x00000004
276 /**
277  * Mask of layer 2 packet types.
278  * It is used for outer packet for tunneling cases.
279  */
280 #define RTE_PTYPE_L2_MASK                   0x0000000f
281 /**
282  * IP (Internet Protocol) version 4 packet type.
283  * It is used for outer packet for tunneling cases, and does not contain any
284  * header option.
285  *
286  * Packet format:
287  * <'ether type'=0x0800
288  * | 'version'=4, 'ihl'=5>
289  */
290 #define RTE_PTYPE_L3_IPV4                   0x00000010
291 /**
292  * IP (Internet Protocol) version 4 packet type.
293  * It is used for outer packet for tunneling cases, and contains header
294  * options.
295  *
296  * Packet format:
297  * <'ether type'=0x0800
298  * | 'version'=4, 'ihl'=[6-15], 'options'>
299  */
300 #define RTE_PTYPE_L3_IPV4_EXT               0x00000030
301 /**
302  * IP (Internet Protocol) version 6 packet type.
303  * It is used for outer packet for tunneling cases, and does not contain any
304  * extension header.
305  *
306  * Packet format:
307  * <'ether type'=0x86DD
308  * | 'version'=6, 'next header'=0x3B>
309  */
310 #define RTE_PTYPE_L3_IPV6                   0x00000040
311 /**
312  * IP (Internet Protocol) version 4 packet type.
313  * It is used for outer packet for tunneling cases, and may or maynot contain
314  * header options.
315  *
316  * Packet format:
317  * <'ether type'=0x0800
318  * | 'version'=4, 'ihl'=[5-15], <'options'>>
319  */
320 #define RTE_PTYPE_L3_IPV4_EXT_UNKNOWN       0x00000090
321 /**
322  * IP (Internet Protocol) version 6 packet type.
323  * It is used for outer packet for tunneling cases, and contains extension
324  * headers.
325  *
326  * Packet format:
327  * <'ether type'=0x86DD
328  * | 'version'=6, 'next header'=[0x0|0x2B|0x2C|0x32|0x33|0x3C|0x87],
329  *   'extension headers'>
330  */
331 #define RTE_PTYPE_L3_IPV6_EXT               0x000000c0
332 /**
333  * IP (Internet Protocol) version 6 packet type.
334  * It is used for outer packet for tunneling cases, and may or maynot contain
335  * extension headers.
336  *
337  * Packet format:
338  * <'ether type'=0x86DD
339  * | 'version'=6, 'next header'=[0x3B|0x0|0x2B|0x2C|0x32|0x33|0x3C|0x87],
340  *   <'extension headers'>>
341  */
342 #define RTE_PTYPE_L3_IPV6_EXT_UNKNOWN       0x000000e0
343 /**
344  * Mask of layer 3 packet types.
345  * It is used for outer packet for tunneling cases.
346  */
347 #define RTE_PTYPE_L3_MASK                   0x000000f0
348 /**
349  * TCP (Transmission Control Protocol) packet type.
350  * It is used for outer packet for tunneling cases.
351  *
352  * Packet format:
353  * <'ether type'=0x0800
354  * | 'version'=4, 'protocol'=6, 'MF'=0>
355  * or,
356  * <'ether type'=0x86DD
357  * | 'version'=6, 'next header'=6>
358  */
359 #define RTE_PTYPE_L4_TCP                    0x00000100
360 /**
361  * UDP (User Datagram Protocol) packet type.
362  * It is used for outer packet for tunneling cases.
363  *
364  * Packet format:
365  * <'ether type'=0x0800
366  * | 'version'=4, 'protocol'=17, 'MF'=0>
367  * or,
368  * <'ether type'=0x86DD
369  * | 'version'=6, 'next header'=17>
370  */
371 #define RTE_PTYPE_L4_UDP                    0x00000200
372 /**
373  * Fragmented IP (Internet Protocol) packet type.
374  * It is used for outer packet for tunneling cases.
375  *
376  * It refers to those packets of any IP types, which can be recognized as
377  * fragmented. A fragmented packet cannot be recognized as any other L4 types
378  * (RTE_PTYPE_L4_TCP, RTE_PTYPE_L4_UDP, RTE_PTYPE_L4_SCTP, RTE_PTYPE_L4_ICMP,
379  * RTE_PTYPE_L4_NONFRAG).
380  *
381  * Packet format:
382  * <'ether type'=0x0800
383  * | 'version'=4, 'MF'=1>
384  * or,
385  * <'ether type'=0x86DD
386  * | 'version'=6, 'next header'=44>
387  */
388 #define RTE_PTYPE_L4_FRAG                   0x00000300
389 /**
390  * SCTP (Stream Control Transmission Protocol) packet type.
391  * It is used for outer packet for tunneling cases.
392  *
393  * Packet format:
394  * <'ether type'=0x0800
395  * | 'version'=4, 'protocol'=132, 'MF'=0>
396  * or,
397  * <'ether type'=0x86DD
398  * | 'version'=6, 'next header'=132>
399  */
400 #define RTE_PTYPE_L4_SCTP                   0x00000400
401 /**
402  * ICMP (Internet Control Message Protocol) packet type.
403  * It is used for outer packet for tunneling cases.
404  *
405  * Packet format:
406  * <'ether type'=0x0800
407  * | 'version'=4, 'protocol'=1, 'MF'=0>
408  * or,
409  * <'ether type'=0x86DD
410  * | 'version'=6, 'next header'=1>
411  */
412 #define RTE_PTYPE_L4_ICMP                   0x00000500
413 /**
414  * Non-fragmented IP (Internet Protocol) packet type.
415  * It is used for outer packet for tunneling cases.
416  *
417  * It refers to those packets of any IP types, while cannot be recognized as
418  * any of above L4 types (RTE_PTYPE_L4_TCP, RTE_PTYPE_L4_UDP,
419  * RTE_PTYPE_L4_FRAG, RTE_PTYPE_L4_SCTP, RTE_PTYPE_L4_ICMP).
420  *
421  * Packet format:
422  * <'ether type'=0x0800
423  * | 'version'=4, 'protocol'!=[6|17|132|1], 'MF'=0>
424  * or,
425  * <'ether type'=0x86DD
426  * | 'version'=6, 'next header'!=[6|17|44|132|1]>
427  */
428 #define RTE_PTYPE_L4_NONFRAG                0x00000600
429 /**
430  * Mask of layer 4 packet types.
431  * It is used for outer packet for tunneling cases.
432  */
433 #define RTE_PTYPE_L4_MASK                   0x00000f00
434 /**
435  * IP (Internet Protocol) in IP (Internet Protocol) tunneling packet type.
436  *
437  * Packet format:
438  * <'ether type'=0x0800
439  * | 'version'=4, 'protocol'=[4|41]>
440  * or,
441  * <'ether type'=0x86DD
442  * | 'version'=6, 'next header'=[4|41]>
443  */
444 #define RTE_PTYPE_TUNNEL_IP                 0x00001000
445 /**
446  * GRE (Generic Routing Encapsulation) tunneling packet type.
447  *
448  * Packet format:
449  * <'ether type'=0x0800
450  * | 'version'=4, 'protocol'=47>
451  * or,
452  * <'ether type'=0x86DD
453  * | 'version'=6, 'next header'=47>
454  */
455 #define RTE_PTYPE_TUNNEL_GRE                0x00002000
456 /**
457  * VXLAN (Virtual eXtensible Local Area Network) tunneling packet type.
458  *
459  * Packet format:
460  * <'ether type'=0x0800
461  * | 'version'=4, 'protocol'=17
462  * | 'destination port'=4798>
463  * or,
464  * <'ether type'=0x86DD
465  * | 'version'=6, 'next header'=17
466  * | 'destination port'=4798>
467  */
468 #define RTE_PTYPE_TUNNEL_VXLAN              0x00003000
469 /**
470  * NVGRE (Network Virtualization using Generic Routing Encapsulation) tunneling
471  * packet type.
472  *
473  * Packet format:
474  * <'ether type'=0x0800
475  * | 'version'=4, 'protocol'=47
476  * | 'protocol type'=0x6558>
477  * or,
478  * <'ether type'=0x86DD
479  * | 'version'=6, 'next header'=47
480  * | 'protocol type'=0x6558'>
481  */
482 #define RTE_PTYPE_TUNNEL_NVGRE              0x00004000
483 /**
484  * GENEVE (Generic Network Virtualization Encapsulation) tunneling packet type.
485  *
486  * Packet format:
487  * <'ether type'=0x0800
488  * | 'version'=4, 'protocol'=17
489  * | 'destination port'=6081>
490  * or,
491  * <'ether type'=0x86DD
492  * | 'version'=6, 'next header'=17
493  * | 'destination port'=6081>
494  */
495 #define RTE_PTYPE_TUNNEL_GENEVE             0x00005000
496 /**
497  * Tunneling packet type of Teredo, VXLAN (Virtual eXtensible Local Area
498  * Network) or GRE (Generic Routing Encapsulation) could be recognized as this
499  * packet type, if they can not be recognized independently as of hardware
500  * capability.
501  */
502 #define RTE_PTYPE_TUNNEL_GRENAT             0x00006000
503 /**
504  * Mask of tunneling packet types.
505  */
506 #define RTE_PTYPE_TUNNEL_MASK               0x0000f000
507 /**
508  * Ethernet packet type.
509  * It is used for inner packet type only.
510  *
511  * Packet format (inner only):
512  * <'ether type'=[0x800|0x86DD]>
513  */
514 #define RTE_PTYPE_INNER_L2_ETHER            0x00010000
515 /**
516  * Ethernet packet type with VLAN (Virtual Local Area Network) tag.
517  *
518  * Packet format (inner only):
519  * <'ether type'=[0x800|0x86DD], vlan=[1-4095]>
520  */
521 #define RTE_PTYPE_INNER_L2_ETHER_VLAN       0x00020000
522 /**
523  * Mask of inner layer 2 packet types.
524  */
525 #define RTE_PTYPE_INNER_L2_MASK             0x000f0000
526 /**
527  * IP (Internet Protocol) version 4 packet type.
528  * It is used for inner packet only, and does not contain any header option.
529  *
530  * Packet format (inner only):
531  * <'ether type'=0x0800
532  * | 'version'=4, 'ihl'=5>
533  */
534 #define RTE_PTYPE_INNER_L3_IPV4             0x00100000
535 /**
536  * IP (Internet Protocol) version 4 packet type.
537  * It is used for inner packet only, and contains header options.
538  *
539  * Packet format (inner only):
540  * <'ether type'=0x0800
541  * | 'version'=4, 'ihl'=[6-15], 'options'>
542  */
543 #define RTE_PTYPE_INNER_L3_IPV4_EXT         0x00200000
544 /**
545  * IP (Internet Protocol) version 6 packet type.
546  * It is used for inner packet only, and does not contain any extension header.
547  *
548  * Packet format (inner only):
549  * <'ether type'=0x86DD
550  * | 'version'=6, 'next header'=0x3B>
551  */
552 #define RTE_PTYPE_INNER_L3_IPV6             0x00300000
553 /**
554  * IP (Internet Protocol) version 4 packet type.
555  * It is used for inner packet only, and may or maynot contain header options.
556  *
557  * Packet format (inner only):
558  * <'ether type'=0x0800
559  * | 'version'=4, 'ihl'=[5-15], <'options'>>
560  */
561 #define RTE_PTYPE_INNER_L3_IPV4_EXT_UNKNOWN 0x00400000
562 /**
563  * IP (Internet Protocol) version 6 packet type.
564  * It is used for inner packet only, and contains extension headers.
565  *
566  * Packet format (inner only):
567  * <'ether type'=0x86DD
568  * | 'version'=6, 'next header'=[0x0|0x2B|0x2C|0x32|0x33|0x3C|0x87],
569  *   'extension headers'>
570  */
571 #define RTE_PTYPE_INNER_L3_IPV6_EXT         0x00500000
572 /**
573  * IP (Internet Protocol) version 6 packet type.
574  * It is used for inner packet only, and may or maynot contain extension
575  * headers.
576  *
577  * Packet format (inner only):
578  * <'ether type'=0x86DD
579  * | 'version'=6, 'next header'=[0x3B|0x0|0x2B|0x2C|0x32|0x33|0x3C|0x87],
580  *   <'extension headers'>>
581  */
582 #define RTE_PTYPE_INNER_L3_IPV6_EXT_UNKNOWN 0x00600000
583 /**
584  * Mask of inner layer 3 packet types.
585  */
586 #define RTE_PTYPE_INNER_L3_MASK             0x00f00000
587 /**
588  * TCP (Transmission Control Protocol) packet type.
589  * It is used for inner packet only.
590  *
591  * Packet format (inner only):
592  * <'ether type'=0x0800
593  * | 'version'=4, 'protocol'=6, 'MF'=0>
594  * or,
595  * <'ether type'=0x86DD
596  * | 'version'=6, 'next header'=6>
597  */
598 #define RTE_PTYPE_INNER_L4_TCP              0x01000000
599 /**
600  * UDP (User Datagram Protocol) packet type.
601  * It is used for inner packet only.
602  *
603  * Packet format (inner only):
604  * <'ether type'=0x0800
605  * | 'version'=4, 'protocol'=17, 'MF'=0>
606  * or,
607  * <'ether type'=0x86DD
608  * | 'version'=6, 'next header'=17>
609  */
610 #define RTE_PTYPE_INNER_L4_UDP              0x02000000
611 /**
612  * Fragmented IP (Internet Protocol) packet type.
613  * It is used for inner packet only, and may or maynot have layer 4 packet.
614  *
615  * Packet format (inner only):
616  * <'ether type'=0x0800
617  * | 'version'=4, 'MF'=1>
618  * or,
619  * <'ether type'=0x86DD
620  * | 'version'=6, 'next header'=44>
621  */
622 #define RTE_PTYPE_INNER_L4_FRAG             0x03000000
623 /**
624  * SCTP (Stream Control Transmission Protocol) packet type.
625  * It is used for inner packet only.
626  *
627  * Packet format (inner only):
628  * <'ether type'=0x0800
629  * | 'version'=4, 'protocol'=132, 'MF'=0>
630  * or,
631  * <'ether type'=0x86DD
632  * | 'version'=6, 'next header'=132>
633  */
634 #define RTE_PTYPE_INNER_L4_SCTP             0x04000000
635 /**
636  * ICMP (Internet Control Message Protocol) packet type.
637  * It is used for inner packet only.
638  *
639  * Packet format (inner only):
640  * <'ether type'=0x0800
641  * | 'version'=4, 'protocol'=1, 'MF'=0>
642  * or,
643  * <'ether type'=0x86DD
644  * | 'version'=6, 'next header'=1>
645  */
646 #define RTE_PTYPE_INNER_L4_ICMP             0x05000000
647 /**
648  * Non-fragmented IP (Internet Protocol) packet type.
649  * It is used for inner packet only, and may or maynot have other unknown layer
650  * 4 packet types.
651  *
652  * Packet format (inner only):
653  * <'ether type'=0x0800
654  * | 'version'=4, 'protocol'!=[6|17|132|1], 'MF'=0>
655  * or,
656  * <'ether type'=0x86DD
657  * | 'version'=6, 'next header'!=[6|17|44|132|1]>
658  */
659 #define RTE_PTYPE_INNER_L4_NONFRAG          0x06000000
660 /**
661  * Mask of inner layer 4 packet types.
662  */
663 #define RTE_PTYPE_INNER_L4_MASK             0x0f000000
664
665 /**
666  * Check if the (outer) L3 header is IPv4. To avoid comparing IPv4 types one by
667  * one, bit 4 is selected to be used for IPv4 only. Then checking bit 4 can
668  * determine if it is an IPV4 packet.
669  */
670 #define  RTE_ETH_IS_IPV4_HDR(ptype) ((ptype) & RTE_PTYPE_L3_IPV4)
671
672 /**
673  * Check if the (outer) L3 header is IPv4. To avoid comparing IPv4 types one by
674  * one, bit 6 is selected to be used for IPv4 only. Then checking bit 6 can
675  * determine if it is an IPV4 packet.
676  */
677 #define  RTE_ETH_IS_IPV6_HDR(ptype) ((ptype) & RTE_PTYPE_L3_IPV6)
678
679 /* Check if it is a tunneling packet */
680 #define RTE_ETH_IS_TUNNEL_PKT(ptype) ((ptype) & (RTE_PTYPE_TUNNEL_MASK | \
681                                                  RTE_PTYPE_INNER_L2_MASK | \
682                                                  RTE_PTYPE_INNER_L3_MASK | \
683                                                  RTE_PTYPE_INNER_L4_MASK))
684
685 /** Alignment constraint of mbuf private area. */
686 #define RTE_MBUF_PRIV_ALIGN 8
687
688 /**
689  * Get the name of a RX offload flag
690  *
691  * @param mask
692  *   The mask describing the flag.
693  * @return
694  *   The name of this flag, or NULL if it's not a valid RX flag.
695  */
696 const char *rte_get_rx_ol_flag_name(uint64_t mask);
697
698 /**
699  * Get the name of a TX offload flag
700  *
701  * @param mask
702  *   The mask describing the flag. Usually only one bit must be set.
703  *   Several bits can be given if they belong to the same mask.
704  *   Ex: PKT_TX_L4_MASK.
705  * @return
706  *   The name of this flag, or NULL if it's not a valid TX flag.
707  */
708 const char *rte_get_tx_ol_flag_name(uint64_t mask);
709
710 /**
711  * Some NICs need at least 2KB buffer to RX standard Ethernet frame without
712  * splitting it into multiple segments.
713  * So, for mbufs that planned to be involved into RX/TX, the recommended
714  * minimal buffer length is 2KB + RTE_PKTMBUF_HEADROOM.
715  */
716 #define RTE_MBUF_DEFAULT_DATAROOM       2048
717 #define RTE_MBUF_DEFAULT_BUF_SIZE       \
718         (RTE_MBUF_DEFAULT_DATAROOM + RTE_PKTMBUF_HEADROOM)
719
720 /* define a set of marker types that can be used to refer to set points in the
721  * mbuf */
722 typedef void    *MARKER[0];   /**< generic marker for a point in a structure */
723 typedef uint8_t  MARKER8[0];  /**< generic marker with 1B alignment */
724 typedef uint64_t MARKER64[0]; /**< marker that allows us to overwrite 8 bytes
725                                * with a single assignment */
726
727 /**
728  * The generic rte_mbuf, containing a packet mbuf.
729  */
730 struct rte_mbuf {
731         MARKER cacheline0;
732
733         void *buf_addr;           /**< Virtual address of segment buffer. */
734         phys_addr_t buf_physaddr; /**< Physical address of segment buffer. */
735
736         uint16_t buf_len;         /**< Length of segment buffer. */
737
738         /* next 6 bytes are initialised on RX descriptor rearm */
739         MARKER8 rearm_data;
740         uint16_t data_off;
741
742         /**
743          * 16-bit Reference counter.
744          * It should only be accessed using the following functions:
745          * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and
746          * rte_mbuf_refcnt_set(). The functionality of these functions (atomic,
747          * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC
748          * config option.
749          */
750         union {
751                 rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */
752                 uint16_t refcnt;              /**< Non-atomically accessed refcnt */
753         };
754         uint8_t nb_segs;          /**< Number of segments. */
755         uint8_t port;             /**< Input port. */
756
757         uint64_t ol_flags;        /**< Offload features. */
758
759         /* remaining bytes are set on RX when pulling packet from descriptor */
760         MARKER rx_descriptor_fields1;
761
762         /*
763          * The packet type, which is the combination of outer/inner L2, L3, L4
764          * and tunnel types.
765          */
766         union {
767                 uint32_t packet_type; /**< L2/L3/L4 and tunnel information. */
768                 struct {
769                         uint32_t l2_type:4; /**< (Outer) L2 type. */
770                         uint32_t l3_type:4; /**< (Outer) L3 type. */
771                         uint32_t l4_type:4; /**< (Outer) L4 type. */
772                         uint32_t tun_type:4; /**< Tunnel type. */
773                         uint32_t inner_l2_type:4; /**< Inner L2 type. */
774                         uint32_t inner_l3_type:4; /**< Inner L3 type. */
775                         uint32_t inner_l4_type:4; /**< Inner L4 type. */
776                 };
777         };
778
779         uint32_t pkt_len;         /**< Total pkt len: sum of all segments. */
780         uint16_t data_len;        /**< Amount of data in segment buffer. */
781         uint16_t vlan_tci;        /**< VLAN Tag Control Identifier (CPU order) */
782
783         union {
784                 uint32_t rss;     /**< RSS hash result if RSS enabled */
785                 struct {
786                         union {
787                                 struct {
788                                         uint16_t hash;
789                                         uint16_t id;
790                                 };
791                                 uint32_t lo;
792                                 /**< Second 4 flexible bytes */
793                         };
794                         uint32_t hi;
795                         /**< First 4 flexible bytes or FD ID, dependent on
796                              PKT_RX_FDIR_* flag in ol_flags. */
797                 } fdir;           /**< Filter identifier if FDIR enabled */
798                 struct {
799                         uint32_t lo;
800                         uint32_t hi;
801                 } sched;          /**< Hierarchical scheduler */
802                 uint32_t usr;     /**< User defined tags. See rte_distributor_process() */
803         } hash;                   /**< hash information */
804
805         uint32_t seqn; /**< Sequence number. See also rte_reorder_insert() */
806
807         uint16_t vlan_tci_outer;  /**< Outer VLAN Tag Control Identifier (CPU order) */
808
809         /* second cache line - fields only used in slow path or on TX */
810         MARKER cacheline1 __rte_cache_min_aligned;
811
812         union {
813                 void *userdata;   /**< Can be used for external metadata */
814                 uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */
815         };
816
817         struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */
818         struct rte_mbuf *next;    /**< Next segment of scattered packet. */
819
820         /* fields to support TX offloads */
821         union {
822                 uint64_t tx_offload;       /**< combined for easy fetch */
823                 struct {
824                         uint64_t l2_len:7; /**< L2 (MAC) Header Length. */
825                         uint64_t l3_len:9; /**< L3 (IP) Header Length. */
826                         uint64_t l4_len:8; /**< L4 (TCP/UDP) Header Length. */
827                         uint64_t tso_segsz:16; /**< TCP TSO segment size */
828
829                         /* fields for TX offloading of tunnels */
830                         uint64_t outer_l3_len:9; /**< Outer L3 (IP) Hdr Length. */
831                         uint64_t outer_l2_len:7; /**< Outer L2 (MAC) Hdr Length. */
832
833                         /* uint64_t unused:8; */
834                 };
835         };
836
837         /** Size of the application private data. In case of an indirect
838          * mbuf, it stores the direct mbuf private data size. */
839         uint16_t priv_size;
840
841         /** Timesync flags for use with IEEE1588. */
842         uint16_t timesync;
843 } __rte_cache_aligned;
844
845 static inline uint16_t rte_pktmbuf_priv_size(struct rte_mempool *mp);
846
847 /**
848  * Return the DMA address of the beginning of the mbuf data
849  *
850  * @param mb
851  *   The pointer to the mbuf.
852  * @return
853  *   The physical address of the beginning of the mbuf data
854  */
855 static inline phys_addr_t
856 rte_mbuf_data_dma_addr(const struct rte_mbuf *mb)
857 {
858         return mb->buf_physaddr + mb->data_off;
859 }
860
861 /**
862  * Return the default DMA address of the beginning of the mbuf data
863  *
864  * This function is used by drivers in their receive function, as it
865  * returns the location where data should be written by the NIC, taking
866  * the default headroom in account.
867  *
868  * @param mb
869  *   The pointer to the mbuf.
870  * @return
871  *   The physical address of the beginning of the mbuf data
872  */
873 static inline phys_addr_t
874 rte_mbuf_data_dma_addr_default(const struct rte_mbuf *mb)
875 {
876         return mb->buf_physaddr + RTE_PKTMBUF_HEADROOM;
877 }
878
879 /**
880  * Return the mbuf owning the data buffer address of an indirect mbuf.
881  *
882  * @param mi
883  *   The pointer to the indirect mbuf.
884  * @return
885  *   The address of the direct mbuf corresponding to buffer_addr.
886  */
887 static inline struct rte_mbuf *
888 rte_mbuf_from_indirect(struct rte_mbuf *mi)
889 {
890         return (struct rte_mbuf *)RTE_PTR_SUB(mi->buf_addr, sizeof(*mi) + mi->priv_size);
891 }
892
893 /**
894  * Return the buffer address embedded in the given mbuf.
895  *
896  * @param md
897  *   The pointer to the mbuf.
898  * @return
899  *   The address of the data buffer owned by the mbuf.
900  */
901 static inline char *
902 rte_mbuf_to_baddr(struct rte_mbuf *md)
903 {
904         char *buffer_addr;
905         buffer_addr = (char *)md + sizeof(*md) + rte_pktmbuf_priv_size(md->pool);
906         return buffer_addr;
907 }
908
909 /**
910  * Returns TRUE if given mbuf is indirect, or FALSE otherwise.
911  */
912 #define RTE_MBUF_INDIRECT(mb)   ((mb)->ol_flags & IND_ATTACHED_MBUF)
913
914 /**
915  * Returns TRUE if given mbuf is direct, or FALSE otherwise.
916  */
917 #define RTE_MBUF_DIRECT(mb)     (!RTE_MBUF_INDIRECT(mb))
918
919 /**
920  * Private data in case of pktmbuf pool.
921  *
922  * A structure that contains some pktmbuf_pool-specific data that are
923  * appended after the mempool structure (in private data).
924  */
925 struct rte_pktmbuf_pool_private {
926         uint16_t mbuf_data_room_size; /**< Size of data space in each mbuf. */
927         uint16_t mbuf_priv_size;      /**< Size of private area in each mbuf. */
928 };
929
930 #ifdef RTE_LIBRTE_MBUF_DEBUG
931
932 /**  check mbuf type in debug mode */
933 #define __rte_mbuf_sanity_check(m, is_h) rte_mbuf_sanity_check(m, is_h)
934
935 #else /*  RTE_LIBRTE_MBUF_DEBUG */
936
937 /**  check mbuf type in debug mode */
938 #define __rte_mbuf_sanity_check(m, is_h) do { } while (0)
939
940 #endif /*  RTE_LIBRTE_MBUF_DEBUG */
941
942 #ifdef RTE_MBUF_REFCNT_ATOMIC
943
944 /**
945  * Reads the value of an mbuf's refcnt.
946  * @param m
947  *   Mbuf to read
948  * @return
949  *   Reference count number.
950  */
951 static inline uint16_t
952 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
953 {
954         return (uint16_t)(rte_atomic16_read(&m->refcnt_atomic));
955 }
956
957 /**
958  * Sets an mbuf's refcnt to a defined value.
959  * @param m
960  *   Mbuf to update
961  * @param new_value
962  *   Value set
963  */
964 static inline void
965 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
966 {
967         rte_atomic16_set(&m->refcnt_atomic, new_value);
968 }
969
970 /**
971  * Adds given value to an mbuf's refcnt and returns its new value.
972  * @param m
973  *   Mbuf to update
974  * @param value
975  *   Value to add/subtract
976  * @return
977  *   Updated value
978  */
979 static inline uint16_t
980 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
981 {
982         /*
983          * The atomic_add is an expensive operation, so we don't want to
984          * call it in the case where we know we are the uniq holder of
985          * this mbuf (i.e. ref_cnt == 1). Otherwise, an atomic
986          * operation has to be used because concurrent accesses on the
987          * reference counter can occur.
988          */
989         if (likely(rte_mbuf_refcnt_read(m) == 1)) {
990                 rte_mbuf_refcnt_set(m, 1 + value);
991                 return 1 + value;
992         }
993
994         return (uint16_t)(rte_atomic16_add_return(&m->refcnt_atomic, value));
995 }
996
997 #else /* ! RTE_MBUF_REFCNT_ATOMIC */
998
999 /**
1000  * Adds given value to an mbuf's refcnt and returns its new value.
1001  */
1002 static inline uint16_t
1003 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
1004 {
1005         m->refcnt = (uint16_t)(m->refcnt + value);
1006         return m->refcnt;
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 /** Mbuf prefetch */
1030 #define RTE_MBUF_PREFETCH_TO_FREE(m) do {       \
1031         if ((m) != NULL)                        \
1032                 rte_prefetch0(m);               \
1033 } while (0)
1034
1035
1036 /**
1037  * Sanity checks on an mbuf.
1038  *
1039  * Check the consistency of the given mbuf. The function will cause a
1040  * panic if corruption is detected.
1041  *
1042  * @param m
1043  *   The mbuf to be checked.
1044  * @param is_header
1045  *   True if the mbuf is a packet header, false if it is a sub-segment
1046  *   of a packet (in this case, some fields like nb_segs are not checked)
1047  */
1048 void
1049 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header);
1050
1051 /**
1052  * Allocate an unitialized mbuf from mempool *mp*.
1053  *
1054  * This function can be used by PMDs (especially in RX functions) to
1055  * allocate an unitialized mbuf. The driver is responsible of
1056  * initializing all the required fields. See rte_pktmbuf_reset().
1057  * For standard needs, prefer rte_pktmbuf_alloc().
1058  *
1059  * @param mp
1060  *   The mempool from which mbuf is allocated.
1061  * @return
1062  *   - The pointer to the new mbuf on success.
1063  *   - NULL if allocation failed.
1064  */
1065 static inline struct rte_mbuf *rte_mbuf_raw_alloc(struct rte_mempool *mp)
1066 {
1067         struct rte_mbuf *m;
1068         void *mb = NULL;
1069
1070         if (rte_mempool_get(mp, &mb) < 0)
1071                 return NULL;
1072         m = (struct rte_mbuf *)mb;
1073         RTE_ASSERT(rte_mbuf_refcnt_read(m) == 0);
1074         rte_mbuf_refcnt_set(m, 1);
1075         __rte_mbuf_sanity_check(m, 0);
1076
1077         return m;
1078 }
1079
1080 /* compat with older versions */
1081 __rte_deprecated static inline struct rte_mbuf *
1082 __rte_mbuf_raw_alloc(struct rte_mempool *mp)
1083 {
1084         return rte_mbuf_raw_alloc(mp);
1085 }
1086
1087 /**
1088  * @internal Put mbuf back into its original mempool.
1089  * The use of that function is reserved for RTE internal needs.
1090  * Please use rte_pktmbuf_free().
1091  *
1092  * @param m
1093  *   The mbuf to be freed.
1094  */
1095 static inline void __attribute__((always_inline))
1096 __rte_mbuf_raw_free(struct rte_mbuf *m)
1097 {
1098         RTE_ASSERT(rte_mbuf_refcnt_read(m) == 0);
1099         rte_mempool_put(m->pool, m);
1100 }
1101
1102 /* Operations on ctrl mbuf */
1103
1104 /**
1105  * The control mbuf constructor.
1106  *
1107  * This function initializes some fields in an mbuf structure that are
1108  * not modified by the user once created (mbuf type, origin pool, buffer
1109  * start address, and so on). This function is given as a callback function
1110  * to rte_mempool_create() at pool creation time.
1111  *
1112  * @param mp
1113  *   The mempool from which the mbuf is allocated.
1114  * @param opaque_arg
1115  *   A pointer that can be used by the user to retrieve useful information
1116  *   for mbuf initialization. This pointer comes from the ``init_arg``
1117  *   parameter of rte_mempool_create().
1118  * @param m
1119  *   The mbuf to initialize.
1120  * @param i
1121  *   The index of the mbuf in the pool table.
1122  */
1123 void rte_ctrlmbuf_init(struct rte_mempool *mp, void *opaque_arg,
1124                 void *m, unsigned i);
1125
1126 /**
1127  * Allocate a new mbuf (type is ctrl) from mempool *mp*.
1128  *
1129  * This new mbuf is initialized with data pointing to the beginning of
1130  * buffer, and with a length of zero.
1131  *
1132  * @param mp
1133  *   The mempool from which the mbuf is allocated.
1134  * @return
1135  *   - The pointer to the new mbuf on success.
1136  *   - NULL if allocation failed.
1137  */
1138 #define rte_ctrlmbuf_alloc(mp) rte_pktmbuf_alloc(mp)
1139
1140 /**
1141  * Free a control mbuf back into its original mempool.
1142  *
1143  * @param m
1144  *   The control mbuf to be freed.
1145  */
1146 #define rte_ctrlmbuf_free(m) rte_pktmbuf_free(m)
1147
1148 /**
1149  * A macro that returns the pointer to the carried data.
1150  *
1151  * The value that can be read or assigned.
1152  *
1153  * @param m
1154  *   The control mbuf.
1155  */
1156 #define rte_ctrlmbuf_data(m) ((char *)((m)->buf_addr) + (m)->data_off)
1157
1158 /**
1159  * A macro that returns the length of the carried data.
1160  *
1161  * The value that can be read or assigned.
1162  *
1163  * @param m
1164  *   The control mbuf.
1165  */
1166 #define rte_ctrlmbuf_len(m) rte_pktmbuf_data_len(m)
1167
1168 /**
1169  * Tests if an mbuf is a control mbuf
1170  *
1171  * @param m
1172  *   The mbuf to be tested
1173  * @return
1174  *   - True (1) if the mbuf is a control mbuf
1175  *   - False(0) otherwise
1176  */
1177 static inline int
1178 rte_is_ctrlmbuf(struct rte_mbuf *m)
1179 {
1180         return !!(m->ol_flags & CTRL_MBUF_FLAG);
1181 }
1182
1183 /* Operations on pkt mbuf */
1184
1185 /**
1186  * The packet mbuf constructor.
1187  *
1188  * This function initializes some fields in the mbuf structure that are
1189  * not modified by the user once created (origin pool, buffer start
1190  * address, and so on). This function is given as a callback function to
1191  * rte_mempool_create() at pool creation time.
1192  *
1193  * @param mp
1194  *   The mempool from which mbufs originate.
1195  * @param opaque_arg
1196  *   A pointer that can be used by the user to retrieve useful information
1197  *   for mbuf initialization. This pointer comes from the ``init_arg``
1198  *   parameter of rte_mempool_create().
1199  * @param m
1200  *   The mbuf to initialize.
1201  * @param i
1202  *   The index of the mbuf in the pool table.
1203  */
1204 void rte_pktmbuf_init(struct rte_mempool *mp, void *opaque_arg,
1205                       void *m, unsigned i);
1206
1207
1208 /**
1209  * A  packet mbuf pool constructor.
1210  *
1211  * This function initializes the mempool private data in the case of a
1212  * pktmbuf pool. This private data is needed by the driver. The
1213  * function is given as a callback function to rte_mempool_create() at
1214  * pool creation. It can be extended by the user, for example, to
1215  * provide another packet size.
1216  *
1217  * @param mp
1218  *   The mempool from which mbufs originate.
1219  * @param opaque_arg
1220  *   A pointer that can be used by the user to retrieve useful information
1221  *   for mbuf initialization. This pointer comes from the ``init_arg``
1222  *   parameter of rte_mempool_create().
1223  */
1224 void rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg);
1225
1226 /**
1227  * Create a mbuf pool.
1228  *
1229  * This function creates and initializes a packet mbuf pool. It is
1230  * a wrapper to rte_mempool_create() with the proper packet constructor
1231  * and mempool constructor.
1232  *
1233  * @param name
1234  *   The name of the mbuf pool.
1235  * @param n
1236  *   The number of elements in the mbuf pool. The optimum size (in terms
1237  *   of memory usage) for a mempool is when n is a power of two minus one:
1238  *   n = (2^q - 1).
1239  * @param cache_size
1240  *   Size of the per-core object cache. See rte_mempool_create() for
1241  *   details.
1242  * @param priv_size
1243  *   Size of application private are between the rte_mbuf structure
1244  *   and the data buffer. This value must be aligned to RTE_MBUF_PRIV_ALIGN.
1245  * @param data_room_size
1246  *   Size of data buffer in each mbuf, including RTE_PKTMBUF_HEADROOM.
1247  * @param socket_id
1248  *   The socket identifier where the memory should be allocated. The
1249  *   value can be *SOCKET_ID_ANY* if there is no NUMA constraint for the
1250  *   reserved zone.
1251  * @return
1252  *   The pointer to the new allocated mempool, on success. NULL on error
1253  *   with rte_errno set appropriately. Possible rte_errno values include:
1254  *    - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
1255  *    - E_RTE_SECONDARY - function was called from a secondary process instance
1256  *    - EINVAL - cache size provided is too large, or priv_size is not aligned.
1257  *    - ENOSPC - the maximum number of memzones has already been allocated
1258  *    - EEXIST - a memzone with the same name already exists
1259  *    - ENOMEM - no appropriate memory area found in which to create memzone
1260  */
1261 struct rte_mempool *
1262 rte_pktmbuf_pool_create(const char *name, unsigned n,
1263         unsigned cache_size, uint16_t priv_size, uint16_t data_room_size,
1264         int socket_id);
1265
1266 /**
1267  * Get the data room size of mbufs stored in a pktmbuf_pool
1268  *
1269  * The data room size is the amount of data that can be stored in a
1270  * mbuf including the headroom (RTE_PKTMBUF_HEADROOM).
1271  *
1272  * @param mp
1273  *   The packet mbuf pool.
1274  * @return
1275  *   The data room size of mbufs stored in this mempool.
1276  */
1277 static inline uint16_t
1278 rte_pktmbuf_data_room_size(struct rte_mempool *mp)
1279 {
1280         struct rte_pktmbuf_pool_private *mbp_priv;
1281
1282         mbp_priv = (struct rte_pktmbuf_pool_private *)rte_mempool_get_priv(mp);
1283         return mbp_priv->mbuf_data_room_size;
1284 }
1285
1286 /**
1287  * Get the application private size of mbufs stored in a pktmbuf_pool
1288  *
1289  * The private size of mbuf is a zone located between the rte_mbuf
1290  * structure and the data buffer where an application can store data
1291  * associated to a packet.
1292  *
1293  * @param mp
1294  *   The packet mbuf pool.
1295  * @return
1296  *   The private size of mbufs stored in this mempool.
1297  */
1298 static inline uint16_t
1299 rte_pktmbuf_priv_size(struct rte_mempool *mp)
1300 {
1301         struct rte_pktmbuf_pool_private *mbp_priv;
1302
1303         mbp_priv = (struct rte_pktmbuf_pool_private *)rte_mempool_get_priv(mp);
1304         return mbp_priv->mbuf_priv_size;
1305 }
1306
1307 /**
1308  * Reset the fields of a packet mbuf to their default values.
1309  *
1310  * The given mbuf must have only one segment.
1311  *
1312  * @param m
1313  *   The packet mbuf to be resetted.
1314  */
1315 static inline void rte_pktmbuf_reset(struct rte_mbuf *m)
1316 {
1317         m->next = NULL;
1318         m->pkt_len = 0;
1319         m->tx_offload = 0;
1320         m->vlan_tci = 0;
1321         m->vlan_tci_outer = 0;
1322         m->nb_segs = 1;
1323         m->port = 0xff;
1324
1325         m->ol_flags = 0;
1326         m->packet_type = 0;
1327         m->data_off = (RTE_PKTMBUF_HEADROOM <= m->buf_len) ?
1328                         RTE_PKTMBUF_HEADROOM : m->buf_len;
1329
1330         m->data_len = 0;
1331         __rte_mbuf_sanity_check(m, 1);
1332 }
1333
1334 /**
1335  * Allocate a new mbuf from a mempool.
1336  *
1337  * This new mbuf contains one segment, which has a length of 0. The pointer
1338  * to data is initialized to have some bytes of headroom in the buffer
1339  * (if buffer size allows).
1340  *
1341  * @param mp
1342  *   The mempool from which the mbuf is allocated.
1343  * @return
1344  *   - The pointer to the new mbuf on success.
1345  *   - NULL if allocation failed.
1346  */
1347 static inline struct rte_mbuf *rte_pktmbuf_alloc(struct rte_mempool *mp)
1348 {
1349         struct rte_mbuf *m;
1350         if ((m = rte_mbuf_raw_alloc(mp)) != NULL)
1351                 rte_pktmbuf_reset(m);
1352         return m;
1353 }
1354
1355 /**
1356  * Allocate a bulk of mbufs, initialize refcnt and reset the fields to default
1357  * values.
1358  *
1359  *  @param pool
1360  *    The mempool from which mbufs are allocated.
1361  *  @param mbufs
1362  *    Array of pointers to mbufs
1363  *  @param count
1364  *    Array size
1365  *  @return
1366  *   - 0: Success
1367  */
1368 static inline int rte_pktmbuf_alloc_bulk(struct rte_mempool *pool,
1369          struct rte_mbuf **mbufs, unsigned count)
1370 {
1371         unsigned idx = 0;
1372         int rc;
1373
1374         rc = rte_mempool_get_bulk(pool, (void **)mbufs, count);
1375         if (unlikely(rc))
1376                 return rc;
1377
1378         /* To understand duff's device on loop unwinding optimization, see
1379          * https://en.wikipedia.org/wiki/Duff's_device.
1380          * Here while() loop is used rather than do() while{} to avoid extra
1381          * check if count is zero.
1382          */
1383         switch (count % 4) {
1384         case 0:
1385                 while (idx != count) {
1386                         RTE_ASSERT(rte_mbuf_refcnt_read(mbufs[idx]) == 0);
1387                         rte_mbuf_refcnt_set(mbufs[idx], 1);
1388                         rte_pktmbuf_reset(mbufs[idx]);
1389                         idx++;
1390         case 3:
1391                         RTE_ASSERT(rte_mbuf_refcnt_read(mbufs[idx]) == 0);
1392                         rte_mbuf_refcnt_set(mbufs[idx], 1);
1393                         rte_pktmbuf_reset(mbufs[idx]);
1394                         idx++;
1395         case 2:
1396                         RTE_ASSERT(rte_mbuf_refcnt_read(mbufs[idx]) == 0);
1397                         rte_mbuf_refcnt_set(mbufs[idx], 1);
1398                         rte_pktmbuf_reset(mbufs[idx]);
1399                         idx++;
1400         case 1:
1401                         RTE_ASSERT(rte_mbuf_refcnt_read(mbufs[idx]) == 0);
1402                         rte_mbuf_refcnt_set(mbufs[idx], 1);
1403                         rte_pktmbuf_reset(mbufs[idx]);
1404                         idx++;
1405                 }
1406         }
1407         return 0;
1408 }
1409
1410 /**
1411  * Attach packet mbuf to another packet mbuf.
1412  *
1413  * After attachment we refer the mbuf we attached as 'indirect',
1414  * while mbuf we attached to as 'direct'.
1415  * Right now, not supported:
1416  *  - attachment for already indirect mbuf (e.g. - mi has to be direct).
1417  *  - mbuf we trying to attach (mi) is used by someone else
1418  *    e.g. it's reference counter is greater then 1.
1419  *
1420  * @param mi
1421  *   The indirect packet mbuf.
1422  * @param m
1423  *   The packet mbuf we're attaching to.
1424  */
1425 static inline void rte_pktmbuf_attach(struct rte_mbuf *mi, struct rte_mbuf *m)
1426 {
1427         struct rte_mbuf *md;
1428
1429         RTE_ASSERT(RTE_MBUF_DIRECT(mi) &&
1430             rte_mbuf_refcnt_read(mi) == 1);
1431
1432         /* if m is not direct, get the mbuf that embeds the data */
1433         if (RTE_MBUF_DIRECT(m))
1434                 md = m;
1435         else
1436                 md = rte_mbuf_from_indirect(m);
1437
1438         rte_mbuf_refcnt_update(md, 1);
1439         mi->priv_size = m->priv_size;
1440         mi->buf_physaddr = m->buf_physaddr;
1441         mi->buf_addr = m->buf_addr;
1442         mi->buf_len = m->buf_len;
1443
1444         mi->next = m->next;
1445         mi->data_off = m->data_off;
1446         mi->data_len = m->data_len;
1447         mi->port = m->port;
1448         mi->vlan_tci = m->vlan_tci;
1449         mi->vlan_tci_outer = m->vlan_tci_outer;
1450         mi->tx_offload = m->tx_offload;
1451         mi->hash = m->hash;
1452
1453         mi->next = NULL;
1454         mi->pkt_len = mi->data_len;
1455         mi->nb_segs = 1;
1456         mi->ol_flags = m->ol_flags | IND_ATTACHED_MBUF;
1457         mi->packet_type = m->packet_type;
1458
1459         __rte_mbuf_sanity_check(mi, 1);
1460         __rte_mbuf_sanity_check(m, 0);
1461 }
1462
1463 /**
1464  * Detach an indirect packet mbuf.
1465  *
1466  *  - restore original mbuf address and length values.
1467  *  - reset pktmbuf data and data_len to their default values.
1468  *  All other fields of the given packet mbuf will be left intact.
1469  *
1470  * @param m
1471  *   The indirect attached packet mbuf.
1472  */
1473 static inline void rte_pktmbuf_detach(struct rte_mbuf *m)
1474 {
1475         struct rte_mempool *mp = m->pool;
1476         uint32_t mbuf_size, buf_len, priv_size;
1477
1478         priv_size = rte_pktmbuf_priv_size(mp);
1479         mbuf_size = sizeof(struct rte_mbuf) + priv_size;
1480         buf_len = rte_pktmbuf_data_room_size(mp);
1481
1482         m->priv_size = priv_size;
1483         m->buf_addr = (char *)m + mbuf_size;
1484         m->buf_physaddr = rte_mempool_virt2phy(mp, m) + mbuf_size;
1485         m->buf_len = (uint16_t)buf_len;
1486         m->data_off = RTE_MIN(RTE_PKTMBUF_HEADROOM, (uint16_t)m->buf_len);
1487         m->data_len = 0;
1488         m->ol_flags = 0;
1489 }
1490
1491 static inline struct rte_mbuf* __attribute__((always_inline))
1492 __rte_pktmbuf_prefree_seg(struct rte_mbuf *m)
1493 {
1494         __rte_mbuf_sanity_check(m, 0);
1495
1496         if (likely(rte_mbuf_refcnt_update(m, -1) == 0)) {
1497
1498                 /* if this is an indirect mbuf, then
1499                  *  - detach mbuf
1500                  *  - free attached mbuf segment
1501                  */
1502                 if (RTE_MBUF_INDIRECT(m)) {
1503                         struct rte_mbuf *md = rte_mbuf_from_indirect(m);
1504                         rte_pktmbuf_detach(m);
1505                         if (rte_mbuf_refcnt_update(md, -1) == 0)
1506                                 __rte_mbuf_raw_free(md);
1507                 }
1508                 return m;
1509         }
1510         return NULL;
1511 }
1512
1513 /**
1514  * Free a segment of a packet mbuf into its original mempool.
1515  *
1516  * Free an mbuf, without parsing other segments in case of chained
1517  * buffers.
1518  *
1519  * @param m
1520  *   The packet mbuf segment to be freed.
1521  */
1522 static inline void __attribute__((always_inline))
1523 rte_pktmbuf_free_seg(struct rte_mbuf *m)
1524 {
1525         if (likely(NULL != (m = __rte_pktmbuf_prefree_seg(m)))) {
1526                 m->next = NULL;
1527                 __rte_mbuf_raw_free(m);
1528         }
1529 }
1530
1531 /**
1532  * Free a packet mbuf back into its original mempool.
1533  *
1534  * Free an mbuf, and all its segments in case of chained buffers. Each
1535  * segment is added back into its original mempool.
1536  *
1537  * @param m
1538  *   The packet mbuf to be freed.
1539  */
1540 static inline void rte_pktmbuf_free(struct rte_mbuf *m)
1541 {
1542         struct rte_mbuf *m_next;
1543
1544         __rte_mbuf_sanity_check(m, 1);
1545
1546         while (m != NULL) {
1547                 m_next = m->next;
1548                 rte_pktmbuf_free_seg(m);
1549                 m = m_next;
1550         }
1551 }
1552
1553 /**
1554  * Creates a "clone" of the given packet mbuf.
1555  *
1556  * Walks through all segments of the given packet mbuf, and for each of them:
1557  *  - Creates a new packet mbuf from the given pool.
1558  *  - Attaches newly created mbuf to the segment.
1559  * Then updates pkt_len and nb_segs of the "clone" packet mbuf to match values
1560  * from the original packet mbuf.
1561  *
1562  * @param md
1563  *   The packet mbuf to be cloned.
1564  * @param mp
1565  *   The mempool from which the "clone" mbufs are allocated.
1566  * @return
1567  *   - The pointer to the new "clone" mbuf on success.
1568  *   - NULL if allocation fails.
1569  */
1570 static inline struct rte_mbuf *rte_pktmbuf_clone(struct rte_mbuf *md,
1571                 struct rte_mempool *mp)
1572 {
1573         struct rte_mbuf *mc, *mi, **prev;
1574         uint32_t pktlen;
1575         uint8_t nseg;
1576
1577         if (unlikely ((mc = rte_pktmbuf_alloc(mp)) == NULL))
1578                 return NULL;
1579
1580         mi = mc;
1581         prev = &mi->next;
1582         pktlen = md->pkt_len;
1583         nseg = 0;
1584
1585         do {
1586                 nseg++;
1587                 rte_pktmbuf_attach(mi, md);
1588                 *prev = mi;
1589                 prev = &mi->next;
1590         } while ((md = md->next) != NULL &&
1591             (mi = rte_pktmbuf_alloc(mp)) != NULL);
1592
1593         *prev = NULL;
1594         mc->nb_segs = nseg;
1595         mc->pkt_len = pktlen;
1596
1597         /* Allocation of new indirect segment failed */
1598         if (unlikely (mi == NULL)) {
1599                 rte_pktmbuf_free(mc);
1600                 return NULL;
1601         }
1602
1603         __rte_mbuf_sanity_check(mc, 1);
1604         return mc;
1605 }
1606
1607 /**
1608  * Adds given value to the refcnt of all packet mbuf segments.
1609  *
1610  * Walks through all segments of given packet mbuf and for each of them
1611  * invokes rte_mbuf_refcnt_update().
1612  *
1613  * @param m
1614  *   The packet mbuf whose refcnt to be updated.
1615  * @param v
1616  *   The value to add to the mbuf's segments refcnt.
1617  */
1618 static inline void rte_pktmbuf_refcnt_update(struct rte_mbuf *m, int16_t v)
1619 {
1620         __rte_mbuf_sanity_check(m, 1);
1621
1622         do {
1623                 rte_mbuf_refcnt_update(m, v);
1624         } while ((m = m->next) != NULL);
1625 }
1626
1627 /**
1628  * Get the headroom in a packet mbuf.
1629  *
1630  * @param m
1631  *   The packet mbuf.
1632  * @return
1633  *   The length of the headroom.
1634  */
1635 static inline uint16_t rte_pktmbuf_headroom(const struct rte_mbuf *m)
1636 {
1637         __rte_mbuf_sanity_check(m, 1);
1638         return m->data_off;
1639 }
1640
1641 /**
1642  * Get the tailroom of a packet mbuf.
1643  *
1644  * @param m
1645  *   The packet mbuf.
1646  * @return
1647  *   The length of the tailroom.
1648  */
1649 static inline uint16_t rte_pktmbuf_tailroom(const struct rte_mbuf *m)
1650 {
1651         __rte_mbuf_sanity_check(m, 1);
1652         return (uint16_t)(m->buf_len - rte_pktmbuf_headroom(m) -
1653                           m->data_len);
1654 }
1655
1656 /**
1657  * Get the last segment of the packet.
1658  *
1659  * @param m
1660  *   The packet mbuf.
1661  * @return
1662  *   The last segment of the given mbuf.
1663  */
1664 static inline struct rte_mbuf *rte_pktmbuf_lastseg(struct rte_mbuf *m)
1665 {
1666         struct rte_mbuf *m2 = (struct rte_mbuf *)m;
1667
1668         __rte_mbuf_sanity_check(m, 1);
1669         while (m2->next != NULL)
1670                 m2 = m2->next;
1671         return m2;
1672 }
1673
1674 /**
1675  * A macro that points to an offset into the data in the mbuf.
1676  *
1677  * The returned pointer is cast to type t. Before using this
1678  * function, the user must ensure that the first segment is large
1679  * enough to accommodate its data.
1680  *
1681  * @param m
1682  *   The packet mbuf.
1683  * @param o
1684  *   The offset into the mbuf data.
1685  * @param t
1686  *   The type to cast the result into.
1687  */
1688 #define rte_pktmbuf_mtod_offset(m, t, o)        \
1689         ((t)((char *)(m)->buf_addr + (m)->data_off + (o)))
1690
1691 /**
1692  * A macro that points to the start of the data in the mbuf.
1693  *
1694  * The returned pointer is cast to type t. Before using this
1695  * function, the user must ensure that the first segment is large
1696  * enough to accommodate its data.
1697  *
1698  * @param m
1699  *   The packet mbuf.
1700  * @param t
1701  *   The type to cast the result into.
1702  */
1703 #define rte_pktmbuf_mtod(m, t) rte_pktmbuf_mtod_offset(m, t, 0)
1704
1705 /**
1706  * A macro that returns the physical address that points to an offset of the
1707  * start of the data in the mbuf
1708  *
1709  * @param m
1710  *   The packet mbuf.
1711  * @param o
1712  *   The offset into the data to calculate address from.
1713  */
1714 #define rte_pktmbuf_mtophys_offset(m, o) \
1715         (phys_addr_t)((m)->buf_physaddr + (m)->data_off + (o))
1716
1717 /**
1718  * A macro that returns the physical address that points to the start of the
1719  * data in the mbuf
1720  *
1721  * @param m
1722  *   The packet mbuf.
1723  */
1724 #define rte_pktmbuf_mtophys(m) rte_pktmbuf_mtophys_offset(m, 0)
1725
1726 /**
1727  * A macro that returns the length of the packet.
1728  *
1729  * The value can be read or assigned.
1730  *
1731  * @param m
1732  *   The packet mbuf.
1733  */
1734 #define rte_pktmbuf_pkt_len(m) ((m)->pkt_len)
1735
1736 /**
1737  * A macro that returns the length of the segment.
1738  *
1739  * The value can be read or assigned.
1740  *
1741  * @param m
1742  *   The packet mbuf.
1743  */
1744 #define rte_pktmbuf_data_len(m) ((m)->data_len)
1745
1746 /**
1747  * Prepend len bytes to an mbuf data area.
1748  *
1749  * Returns a pointer to the new
1750  * data start address. If there is not enough headroom in the first
1751  * segment, the function will return NULL, without modifying the mbuf.
1752  *
1753  * @param m
1754  *   The pkt mbuf.
1755  * @param len
1756  *   The amount of data to prepend (in bytes).
1757  * @return
1758  *   A pointer to the start of the newly prepended data, or
1759  *   NULL if there is not enough headroom space in the first segment
1760  */
1761 static inline char *rte_pktmbuf_prepend(struct rte_mbuf *m,
1762                                         uint16_t len)
1763 {
1764         __rte_mbuf_sanity_check(m, 1);
1765
1766         if (unlikely(len > rte_pktmbuf_headroom(m)))
1767                 return NULL;
1768
1769         m->data_off -= len;
1770         m->data_len = (uint16_t)(m->data_len + len);
1771         m->pkt_len  = (m->pkt_len + len);
1772
1773         return (char *)m->buf_addr + m->data_off;
1774 }
1775
1776 /**
1777  * Append len bytes to an mbuf.
1778  *
1779  * Append len bytes to an mbuf and return a pointer to the start address
1780  * of the added data. If there is not enough tailroom in the last
1781  * segment, the function will return NULL, without modifying the mbuf.
1782  *
1783  * @param m
1784  *   The packet mbuf.
1785  * @param len
1786  *   The amount of data to append (in bytes).
1787  * @return
1788  *   A pointer to the start of the newly appended data, or
1789  *   NULL if there is not enough tailroom space in the last segment
1790  */
1791 static inline char *rte_pktmbuf_append(struct rte_mbuf *m, uint16_t len)
1792 {
1793         void *tail;
1794         struct rte_mbuf *m_last;
1795
1796         __rte_mbuf_sanity_check(m, 1);
1797
1798         m_last = rte_pktmbuf_lastseg(m);
1799         if (unlikely(len > rte_pktmbuf_tailroom(m_last)))
1800                 return NULL;
1801
1802         tail = (char *)m_last->buf_addr + m_last->data_off + m_last->data_len;
1803         m_last->data_len = (uint16_t)(m_last->data_len + len);
1804         m->pkt_len  = (m->pkt_len + len);
1805         return (char*) tail;
1806 }
1807
1808 /**
1809  * Remove len bytes at the beginning of an mbuf.
1810  *
1811  * Returns a pointer to the start address of the new data area. If the
1812  * length is greater than the length of the first segment, then the
1813  * function will fail and return NULL, without modifying the mbuf.
1814  *
1815  * @param m
1816  *   The packet mbuf.
1817  * @param len
1818  *   The amount of data to remove (in bytes).
1819  * @return
1820  *   A pointer to the new start of the data.
1821  */
1822 static inline char *rte_pktmbuf_adj(struct rte_mbuf *m, uint16_t len)
1823 {
1824         __rte_mbuf_sanity_check(m, 1);
1825
1826         if (unlikely(len > m->data_len))
1827                 return NULL;
1828
1829         m->data_len = (uint16_t)(m->data_len - len);
1830         m->data_off += len;
1831         m->pkt_len  = (m->pkt_len - len);
1832         return (char *)m->buf_addr + m->data_off;
1833 }
1834
1835 /**
1836  * Remove len bytes of data at the end of the mbuf.
1837  *
1838  * If the length is greater than the length of the last segment, the
1839  * function will fail and return -1 without modifying the mbuf.
1840  *
1841  * @param m
1842  *   The packet mbuf.
1843  * @param len
1844  *   The amount of data to remove (in bytes).
1845  * @return
1846  *   - 0: On success.
1847  *   - -1: On error.
1848  */
1849 static inline int rte_pktmbuf_trim(struct rte_mbuf *m, uint16_t len)
1850 {
1851         struct rte_mbuf *m_last;
1852
1853         __rte_mbuf_sanity_check(m, 1);
1854
1855         m_last = rte_pktmbuf_lastseg(m);
1856         if (unlikely(len > m_last->data_len))
1857                 return -1;
1858
1859         m_last->data_len = (uint16_t)(m_last->data_len - len);
1860         m->pkt_len  = (m->pkt_len - len);
1861         return 0;
1862 }
1863
1864 /**
1865  * Test if mbuf data is contiguous.
1866  *
1867  * @param m
1868  *   The packet mbuf.
1869  * @return
1870  *   - 1, if all data is contiguous (one segment).
1871  *   - 0, if there is several segments.
1872  */
1873 static inline int rte_pktmbuf_is_contiguous(const struct rte_mbuf *m)
1874 {
1875         __rte_mbuf_sanity_check(m, 1);
1876         return !!(m->nb_segs == 1);
1877 }
1878
1879 /**
1880  * Chain an mbuf to another, thereby creating a segmented packet.
1881  *
1882  * Note: The implementation will do a linear walk over the segments to find
1883  * the tail entry. For cases when there are many segments, it's better to
1884  * chain the entries manually.
1885  *
1886  * @param head
1887  *   The head of the mbuf chain (the first packet)
1888  * @param tail
1889  *   The mbuf to put last in the chain
1890  *
1891  * @return
1892  *   - 0, on success.
1893  *   - -EOVERFLOW, if the chain is full (256 entries)
1894  */
1895 static inline int rte_pktmbuf_chain(struct rte_mbuf *head, struct rte_mbuf *tail)
1896 {
1897         struct rte_mbuf *cur_tail;
1898
1899         /* Check for number-of-segments-overflow */
1900         if (head->nb_segs + tail->nb_segs >= 1 << (sizeof(head->nb_segs) * 8))
1901                 return -EOVERFLOW;
1902
1903         /* Chain 'tail' onto the old tail */
1904         cur_tail = rte_pktmbuf_lastseg(head);
1905         cur_tail->next = tail;
1906
1907         /* accumulate number of segments and total length. */
1908         head->nb_segs = (uint8_t)(head->nb_segs + tail->nb_segs);
1909         head->pkt_len += tail->pkt_len;
1910
1911         /* pkt_len is only set in the head */
1912         tail->pkt_len = tail->data_len;
1913
1914         return 0;
1915 }
1916
1917 /**
1918  * Dump an mbuf structure to the console.
1919  *
1920  * Dump all fields for the given packet mbuf and all its associated
1921  * segments (in the case of a chained buffer).
1922  *
1923  * @param f
1924  *   A pointer to a file for output
1925  * @param m
1926  *   The packet mbuf.
1927  * @param dump_len
1928  *   If dump_len != 0, also dump the "dump_len" first data bytes of
1929  *   the packet.
1930  */
1931 void rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len);
1932
1933 #ifdef __cplusplus
1934 }
1935 #endif
1936
1937 #endif /* _RTE_MBUF_H_ */