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