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