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 /**
 702  * Get the name of a RX offload flag
 703  *
 704  * @param mask
 705  *   The mask describing the flag.
 706  * @return
 707  *   The name of this flag, or NULL if it's not a valid RX flag.
 708  */
 709 const char *rte_get_rx_ol_flag_name(uint64_t mask);
 710
 711 /**
 712  * Get the name of a TX offload flag
 713  *
 714  * @param mask
 715  *   The mask describing the flag. Usually only one bit must be set.
 716  *   Several bits can be given if they belong to the same mask.
 717  *   Ex: PKT_TX_L4_MASK.
 718  * @return
 719  *   The name of this flag, or NULL if it's not a valid TX flag.
 720  */
 721 const char *rte_get_tx_ol_flag_name(uint64_t mask);
 722
 723 /**
 724  * Some NICs need at least 2KB buffer to RX standard Ethernet frame without
 725  * splitting it into multiple segments.
 726  * So, for mbufs that planned to be involved into RX/TX, the recommended
 727  * minimal buffer length is 2KB + RTE_PKTMBUF_HEADROOM.
 728  */
 729 #define RTE_MBUF_DEFAULT_DATAROOM       2048
 730 #define RTE_MBUF_DEFAULT_BUF_SIZE       \
 731         (RTE_MBUF_DEFAULT_DATAROOM + RTE_PKTMBUF_HEADROOM)
 732
 733 /* define a set of marker types that can be used to refer to set points in the
 734  * mbuf */
 735 typedef void    *MARKER[0];   /**< generic marker for a point in a structure */
 736 typedef uint8_t  MARKER8[0];  /**< generic marker with 1B alignment */
 737 typedef uint64_t MARKER64[0]; /**< marker that allows us to overwrite 8 bytes
 738                                * with a single assignment */
 739
 740 /**
 741  * The generic rte_mbuf, containing a packet mbuf.
 742  */
 743 struct rte_mbuf {
 744         MARKER cacheline0;
 745
 746         void *buf_addr;           /**< Virtual address of segment buffer. */
 747         phys_addr_t buf_physaddr; /**< Physical address of segment buffer. */
 748
 749         uint16_t buf_len;         /**< Length of segment buffer. */
 750
 751         /* next 6 bytes are initialised on RX descriptor rearm */
 752         MARKER8 rearm_data;
 753         uint16_t data_off;
 754
 755         /**
 756          * 16-bit Reference counter.
 757          * It should only be accessed using the following functions:
 758          * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and
 759          * rte_mbuf_refcnt_set(). The functionality of these functions (atomic,
 760          * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC
 761          * config option.
 762          */
 763         union {
 764                 rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */
 765                 uint16_t refcnt;              /**< Non-atomically accessed refcnt */
 766         };
 767         uint8_t nb_segs;          /**< Number of segments. */
 768         uint8_t port;             /**< Input port. */
 769
 770         uint64_t ol_flags;        /**< Offload features. */
 771
 772         /* remaining bytes are set on RX when pulling packet from descriptor */
 773         MARKER rx_descriptor_fields1;
 774
 775 #ifdef RTE_NEXT_ABI
 776         /*
 777          * The packet type, which is the combination of outer/inner L2, L3, L4
 778          * and tunnel types.
 779          */
 780         union {
 781                 uint32_t packet_type; /**< L2/L3/L4 and tunnel information. */
 782                 struct {
 783                         uint32_t l2_type:4; /**< (Outer) L2 type. */
 784                         uint32_t l3_type:4; /**< (Outer) L3 type. */
 785                         uint32_t l4_type:4; /**< (Outer) L4 type. */
 786                         uint32_t tun_type:4; /**< Tunnel type. */
 787                         uint32_t inner_l2_type:4; /**< Inner L2 type. */
 788                         uint32_t inner_l3_type:4; /**< Inner L3 type. */
 789                         uint32_t inner_l4_type:4; /**< Inner L4 type. */
 790                 };
 791         };
 792
 793         uint32_t pkt_len;         /**< Total pkt len: sum of all segments. */
 794         uint16_t data_len;        /**< Amount of data in segment buffer. */
 795         uint16_t vlan_tci;        /**< VLAN Tag Control Identifier (CPU order) */
 796 #else /* RTE_NEXT_ABI */
 797         /**
 798          * The packet type, which is used to indicate ordinary packet and also
 799          * tunneled packet format, i.e. each number is represented a type of
 800          * packet.
 801          */
 802         uint16_t packet_type;
 803
 804         uint16_t data_len;        /**< Amount of data in segment buffer. */
 805         uint32_t pkt_len;         /**< Total pkt len: sum of all segments. */
 806         uint16_t vlan_tci;        /**< VLAN Tag Control Identifier (CPU order) */
 807         uint16_t vlan_tci_outer;  /**< Outer VLAN Tag Control Identifier (CPU order) */
 808 #endif /* RTE_NEXT_ABI */
 809         union {
 810                 uint32_t rss;     /**< RSS hash result if RSS enabled */
 811                 struct {
 812                         union {
 813                                 struct {
 814                                         uint16_t hash;
 815                                         uint16_t id;
 816                                 };
 817                                 uint32_t lo;
 818                                 /**< Second 4 flexible bytes */
 819                         };
 820                         uint32_t hi;
 821                         /**< First 4 flexible bytes or FD ID, dependent on
 822                              PKT_RX_FDIR_* flag in ol_flags. */
 823                 } fdir;           /**< Filter identifier if FDIR enabled */
 824                 uint32_t sched;   /**< Hierarchical scheduler */
 825                 uint32_t usr;     /**< User defined tags. See rte_distributor_process() */
 826         } hash;                   /**< hash information */
 827
 828         uint32_t seqn; /**< Sequence number. See also rte_reorder_insert() */
 829 #ifdef RTE_NEXT_ABI
 830         uint16_t vlan_tci_outer;  /**< Outer VLAN Tag Control Identifier (CPU order) */
 831 #endif /* RTE_NEXT_ABI */
 832
 833         /* second cache line - fields only used in slow path or on TX */
 834         MARKER cacheline1 __rte_cache_aligned;
 835
 836         union {
 837                 void *userdata;   /**< Can be used for external metadata */
 838                 uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */
 839         };
 840
 841         struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */
 842         struct rte_mbuf *next;    /**< Next segment of scattered packet. */
 843
 844         /* fields to support TX offloads */
 845         union {
 846                 uint64_t tx_offload;       /**< combined for easy fetch */
 847                 struct {
 848                         uint64_t l2_len:7; /**< L2 (MAC) Header Length. */
 849                         uint64_t l3_len:9; /**< L3 (IP) Header Length. */
 850                         uint64_t l4_len:8; /**< L4 (TCP/UDP) Header Length. */
 851                         uint64_t tso_segsz:16; /**< TCP TSO segment size */
 852
 853                         /* fields for TX offloading of tunnels */
 854                         uint64_t outer_l3_len:9; /**< Outer L3 (IP) Hdr Length. */
 855                         uint64_t outer_l2_len:7; /**< Outer L2 (MAC) Hdr Length. */
 856
 857                         /* uint64_t unused:8; */
 858                 };
 859         };
 860
 861         /** Size of the application private data. In case of an indirect
 862          * mbuf, it stores the direct mbuf private data size. */
 863         uint16_t priv_size;
 864
 865         /** Timesync flags for use with IEEE1588. */
 866         uint16_t timesync;
 867 } __rte_cache_aligned;
 868
 869 static inline uint16_t rte_pktmbuf_priv_size(struct rte_mempool *mp);
 870
 871 /**
 872  * Return the mbuf owning the data buffer address of an indirect mbuf.
 873  *
 874  * @param mi
 875  *   The pointer to the indirect mbuf.
 876  * @return
 877  *   The address of the direct mbuf corresponding to buffer_addr.
 878  */
 879 static inline struct rte_mbuf *
 880 rte_mbuf_from_indirect(struct rte_mbuf *mi)
 881 {
 882         return RTE_PTR_SUB(mi->buf_addr, sizeof(*mi) + mi->priv_size);
 883 }
 884
 885 /**
 886  * Return the buffer address embedded in the given mbuf.
 887  *
 888  * @param md
 889  *   The pointer to the mbuf.
 890  * @return
 891  *   The address of the data buffer owned by the mbuf.
 892  */
 893 static inline char *
 894 rte_mbuf_to_baddr(struct rte_mbuf *md)
 895 {
 896         char *buffer_addr;
 897         buffer_addr = (char *)md + sizeof(*md) + rte_pktmbuf_priv_size(md->pool);
 898         return buffer_addr;
 899 }
 900
 901 /**
 902  * Returns TRUE if given mbuf is indirect, or FALSE otherwise.
 903  */
 904 #define RTE_MBUF_INDIRECT(mb)   ((mb)->ol_flags & IND_ATTACHED_MBUF)
 905
 906 /**
 907  * Returns TRUE if given mbuf is direct, or FALSE otherwise.
 908  */
 909 #define RTE_MBUF_DIRECT(mb)     (!RTE_MBUF_INDIRECT(mb))
 910
 911 /**
 912  * Private data in case of pktmbuf pool.
 913  *
 914  * A structure that contains some pktmbuf_pool-specific data that are
 915  * appended after the mempool structure (in private data).
 916  */
 917 struct rte_pktmbuf_pool_private {
 918         uint16_t mbuf_data_room_size; /**< Size of data space in each mbuf. */
 919         uint16_t mbuf_priv_size;      /**< Size of private area in each mbuf. */
 920 };
 921
 922 #ifdef RTE_LIBRTE_MBUF_DEBUG
 923
 924 /**  check mbuf type in debug mode */
 925 #define __rte_mbuf_sanity_check(m, is_h) rte_mbuf_sanity_check(m, is_h)
 926
 927 /**  check mbuf type in debug mode if mbuf pointer is not null */
 928 #define __rte_mbuf_sanity_check_raw(m, is_h)    do {       \
 929         if ((m) != NULL)                                   \
 930                 rte_mbuf_sanity_check(m, is_h);          \
 931 } while (0)
 932
 933 /**  MBUF asserts in debug mode */
 934 #define RTE_MBUF_ASSERT(exp)                                         \
 935 if (!(exp)) {                                                        \
 936         rte_panic("line%d\tassert \"" #exp "\" failed\n", __LINE__); \
 937 }
 938
 939 #else /*  RTE_LIBRTE_MBUF_DEBUG */
 940
 941 /**  check mbuf type in debug mode */
 942 #define __rte_mbuf_sanity_check(m, is_h) do { } while (0)
 943
 944 /**  check mbuf type in debug mode if mbuf pointer is not null */
 945 #define __rte_mbuf_sanity_check_raw(m, is_h) do { } while (0)
 946
 947 /**  MBUF asserts in debug mode */
 948 #define RTE_MBUF_ASSERT(exp)                do { } while (0)
 949
 950 #endif /*  RTE_LIBRTE_MBUF_DEBUG */
 951
 952 #ifdef RTE_MBUF_REFCNT_ATOMIC
 953
 954 /**
 955  * Reads the value of an mbuf's refcnt.
 956  * @param m
 957  *   Mbuf to read
 958  * @return
 959  *   Reference count number.
 960  */
 961 static inline uint16_t
 962 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
 963 {
 964         return (uint16_t)(rte_atomic16_read(&m->refcnt_atomic));
 965 }
 966
 967 /**
 968  * Sets an mbuf's refcnt to a defined value.
 969  * @param m
 970  *   Mbuf to update
 971  * @param new_value
 972  *   Value set
 973  */
 974 static inline void
 975 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
 976 {
 977         rte_atomic16_set(&m->refcnt_atomic, new_value);
 978 }
 979
 980 /**
 981  * Adds given value to an mbuf's refcnt and returns its new value.
 982  * @param m
 983  *   Mbuf to update
 984  * @param value
 985  *   Value to add/subtract
 986  * @return
 987  *   Updated value
 988  */
 989 static inline uint16_t
 990 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
 991 {
 992         /*
 993          * The atomic_add is an expensive operation, so we don't want to
 994          * call it in the case where we know we are the uniq holder of
 995          * this mbuf (i.e. ref_cnt == 1). Otherwise, an atomic
 996          * operation has to be used because concurrent accesses on the
 997          * reference counter can occur.
 998          */
 999         if (likely(rte_mbuf_refcnt_read(m) == 1)) {
1000                 rte_mbuf_refcnt_set(m, 1 + value);
1001                 return 1 + value;
1002         }
1003
1004         return (uint16_t)(rte_atomic16_add_return(&m->refcnt_atomic, value));
1005 }
1006
1007 #else /* ! RTE_MBUF_REFCNT_ATOMIC */
1008
1009 /**
1010  * Adds given value to an mbuf's refcnt and returns its new value.
1011  */
1012 static inline uint16_t
1013 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
1014 {
1015         m->refcnt = (uint16_t)(m->refcnt + value);
1016         return m->refcnt;
1017 }
1018
1019 /**
1020  * Reads the value of an mbuf's refcnt.
1021  */
1022 static inline uint16_t
1023 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
1024 {
1025         return m->refcnt;
1026 }
1027
1028 /**
1029  * Sets an mbuf's refcnt to the defined value.
1030  */
1031 static inline void
1032 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
1033 {
1034         m->refcnt = new_value;
1035 }
1036
1037 #endif /* RTE_MBUF_REFCNT_ATOMIC */
1038
1039 /** Mbuf prefetch */
1040 #define RTE_MBUF_PREFETCH_TO_FREE(m) do {       \
1041         if ((m) != NULL)                        \
1042                 rte_prefetch0(m);               \
1043 } while (0)
1044
1045
1046 /**
1047  * Sanity checks on an mbuf.
1048  *
1049  * Check the consistency of the given mbuf. The function will cause a
1050  * panic if corruption is detected.
1051  *
1052  * @param m
1053  *   The mbuf to be checked.
1054  * @param is_header
1055  *   True if the mbuf is a packet header, false if it is a sub-segment
1056  *   of a packet (in this case, some fields like nb_segs are not checked)
1057  */
1058 void
1059 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header);
1060
1061 /**
1062  * @internal Allocate a new mbuf from mempool *mp*.
1063  * The use of that function is reserved for RTE internal needs.
1064  * Please use rte_pktmbuf_alloc().
1065  *
1066  * @param mp
1067  *   The mempool from which mbuf is allocated.
1068  * @return
1069  *   - The pointer to the new mbuf on success.
1070  *   - NULL if allocation failed.
1071  */
1072 static inline struct rte_mbuf *__rte_mbuf_raw_alloc(struct rte_mempool *mp)
1073 {
1074         struct rte_mbuf *m;
1075         void *mb = NULL;
1076         if (rte_mempool_get(mp, &mb) < 0)
1077                 return NULL;
1078         m = (struct rte_mbuf *)mb;
1079         RTE_MBUF_ASSERT(rte_mbuf_refcnt_read(m) == 0);
1080         rte_mbuf_refcnt_set(m, 1);
1081         return m;
1082 }
1083
1084 /**
1085  * @internal Put mbuf back into its original mempool.
1086  * The use of that function is reserved for RTE internal needs.
1087  * Please use rte_pktmbuf_free().
1088  *
1089  * @param m
1090  *   The mbuf to be freed.
1091  */
1092 static inline void __attribute__((always_inline))
1093 __rte_mbuf_raw_free(struct rte_mbuf *m)
1094 {
1095         RTE_MBUF_ASSERT(rte_mbuf_refcnt_read(m) == 0);
1096         rte_mempool_put(m->pool, m);
1097 }
1098
1099 /* Operations on ctrl mbuf */
1100
1101 /**
1102  * The control mbuf constructor.
1103  *
1104  * This function initializes some fields in an mbuf structure that are
1105  * not modified by the user once created (mbuf type, origin pool, buffer
1106  * start address, and so on). This function is given as a callback function
1107  * to rte_mempool_create() at pool creation time.
1108  *
1109  * @param mp
1110  *   The mempool from which the mbuf is allocated.
1111  * @param opaque_arg
1112  *   A pointer that can be used by the user to retrieve useful information
1113  *   for mbuf initialization. This pointer comes from the ``init_arg``
1114  *   parameter of rte_mempool_create().
1115  * @param m
1116  *   The mbuf to initialize.
1117  * @param i
1118  *   The index of the mbuf in the pool table.
1119  */
1120 void rte_ctrlmbuf_init(struct rte_mempool *mp, void *opaque_arg,
1121                 void *m, unsigned i);
1122
1123 /**
1124  * Allocate a new mbuf (type is ctrl) from mempool *mp*.
1125  *
1126  * This new mbuf is initialized with data pointing to the beginning of
1127  * buffer, and with a length of zero.
1128  *
1129  * @param mp
1130  *   The mempool from which the mbuf is allocated.
1131  * @return
1132  *   - The pointer to the new mbuf on success.
1133  *   - NULL if allocation failed.
1134  */
1135 #define rte_ctrlmbuf_alloc(mp) rte_pktmbuf_alloc(mp)
1136
1137 /**
1138  * Free a control mbuf back into its original mempool.
1139  *
1140  * @param m
1141  *   The control mbuf to be freed.
1142  */
1143 #define rte_ctrlmbuf_free(m) rte_pktmbuf_free(m)
1144
1145 /**
1146  * A macro that returns the pointer to the carried data.
1147  *
1148  * The value that can be read or assigned.
1149  *
1150  * @param m
1151  *   The control mbuf.
1152  */
1153 #define rte_ctrlmbuf_data(m) ((char *)((m)->buf_addr) + (m)->data_off)
1154
1155 /**
1156  * A macro that returns the length of the carried data.
1157  *
1158  * The value that can be read or assigned.
1159  *
1160  * @param m
1161  *   The control mbuf.
1162  */
1163 #define rte_ctrlmbuf_len(m) rte_pktmbuf_data_len(m)
1164
1165 /**
1166  * Tests if an mbuf is a control mbuf
1167  *
1168  * @param m
1169  *   The mbuf to be tested
1170  * @return
1171  *   - True (1) if the mbuf is a control mbuf
1172  *   - False(0) otherwise
1173  */
1174 static inline int
1175 rte_is_ctrlmbuf(struct rte_mbuf *m)
1176 {
1177         return !!(m->ol_flags & CTRL_MBUF_FLAG);
1178 }
1179
1180 /* Operations on pkt mbuf */
1181
1182 /**
1183  * The packet mbuf constructor.
1184  *
1185  * This function initializes some fields in the mbuf structure that are
1186  * not modified by the user once created (origin pool, buffer start
1187  * address, and so on). This function is given as a callback function to
1188  * rte_mempool_create() at pool creation time.
1189  *
1190  * @param mp
1191  *   The mempool from which mbufs originate.
1192  * @param opaque_arg
1193  *   A pointer that can be used by the user to retrieve useful information
1194  *   for mbuf initialization. This pointer comes from the ``init_arg``
1195  *   parameter of rte_mempool_create().
1196  * @param m
1197  *   The mbuf to initialize.
1198  * @param i
1199  *   The index of the mbuf in the pool table.
1200  */
1201 void rte_pktmbuf_init(struct rte_mempool *mp, void *opaque_arg,
1202                       void *m, unsigned i);
1203
1204
1205 /**
1206  * A  packet mbuf pool constructor.
1207  *
1208  * This function initializes the mempool private data in the case of a
1209  * pktmbuf pool. This private data is needed by the driver. The
1210  * function is given as a callback function to rte_mempool_create() at
1211  * pool creation. It can be extended by the user, for example, to
1212  * provide another packet size.
1213  *
1214  * @param mp
1215  *   The mempool from which mbufs originate.
1216  * @param opaque_arg
1217  *   A pointer that can be used by the user to retrieve useful information
1218  *   for mbuf initialization. This pointer comes from the ``init_arg``
1219  *   parameter of rte_mempool_create().
1220  */
1221 void rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg);
1222
1223 /**
1224  * Create a mbuf pool.
1225  *
1226  * This function creates and initializes a packet mbuf pool. It is
1227  * a wrapper to rte_mempool_create() with the proper packet constructor
1228  * and mempool constructor.
1229  *
1230  * @param name
1231  *   The name of the mbuf pool.
1232  * @param n
1233  *   The number of elements in the mbuf pool. The optimum size (in terms
1234  *   of memory usage) for a mempool is when n is a power of two minus one:
1235  *   n = (2^q - 1).
1236  * @param cache_size
1237  *   Size of the per-core object cache. See rte_mempool_create() for
1238  *   details.
1239  * @param priv_size
1240  *   Size of application private are between the rte_mbuf structure
1241  *   and the data buffer.
1242  * @param data_room_size
1243  *   Size of data buffer in each mbuf, including RTE_PKTMBUF_HEADROOM.
1244  * @param socket_id
1245  *   The socket identifier where the memory should be allocated. The
1246  *   value can be *SOCKET_ID_ANY* if there is no NUMA constraint for the
1247  *   reserved zone.
1248  * @return
1249  *   The pointer to the new allocated mempool, on success. NULL on error
1250  *   with rte_errno set appropriately. Possible rte_errno values include:
1251  *    - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
1252  *    - E_RTE_SECONDARY - function was called from a secondary process instance
1253  *    - EINVAL - cache size provided is too large
1254  *    - ENOSPC - the maximum number of memzones has already been allocated
1255  *    - EEXIST - a memzone with the same name already exists
1256  *    - ENOMEM - no appropriate memory area found in which to create memzone
1257  */
1258 struct rte_mempool *
1259 rte_pktmbuf_pool_create(const char *name, unsigned n,
1260         unsigned cache_size, uint16_t priv_size, uint16_t data_room_size,
1261         int socket_id);
1262
1263 /**
1264  * Get the data room size of mbufs stored in a pktmbuf_pool
1265  *
1266  * The data room size is the amount of data that can be stored in a
1267  * mbuf including the headroom (RTE_PKTMBUF_HEADROOM).
1268  *
1269  * @param mp
1270  *   The packet mbuf pool.
1271  * @return
1272  *   The data room size of mbufs stored in this mempool.
1273  */
1274 static inline uint16_t
1275 rte_pktmbuf_data_room_size(struct rte_mempool *mp)
1276 {
1277         struct rte_pktmbuf_pool_private *mbp_priv;
1278
1279         mbp_priv = (struct rte_pktmbuf_pool_private *)rte_mempool_get_priv(mp);
1280         return mbp_priv->mbuf_data_room_size;
1281 }
1282
1283 /**
1284  * Get the application private size of mbufs stored in a pktmbuf_pool
1285  *
1286  * The private size of mbuf is a zone located between the rte_mbuf
1287  * structure and the data buffer where an application can store data
1288  * associated to a packet.
1289  *
1290  * @param mp
1291  *   The packet mbuf pool.
1292  * @return
1293  *   The private size of mbufs stored in this mempool.
1294  */
1295 static inline uint16_t
1296 rte_pktmbuf_priv_size(struct rte_mempool *mp)
1297 {
1298         struct rte_pktmbuf_pool_private *mbp_priv;
1299
1300         mbp_priv = (struct rte_pktmbuf_pool_private *)rte_mempool_get_priv(mp);
1301         return mbp_priv->mbuf_priv_size;
1302 }
1303
1304 /**
1305  * Reset the fields of a packet mbuf to their default values.
1306  *
1307  * The given mbuf must have only one segment.
1308  *
1309  * @param m
1310  *   The packet mbuf to be resetted.
1311  */
1312 static inline void rte_pktmbuf_reset(struct rte_mbuf *m)
1313 {
1314         m->next = NULL;
1315         m->pkt_len = 0;
1316         m->tx_offload = 0;
1317         m->vlan_tci = 0;
1318         m->vlan_tci_outer = 0;
1319         m->nb_segs = 1;
1320         m->port = 0xff;
1321
1322         m->ol_flags = 0;
1323         m->packet_type = 0;
1324         m->data_off = (RTE_PKTMBUF_HEADROOM <= m->buf_len) ?
1325                         RTE_PKTMBUF_HEADROOM : m->buf_len;
1326
1327         m->data_len = 0;
1328         __rte_mbuf_sanity_check(m, 1);
1329 }
1330
1331 /**
1332  * Allocate a new mbuf from a mempool.
1333  *
1334  * This new mbuf contains one segment, which has a length of 0. The pointer
1335  * to data is initialized to have some bytes of headroom in the buffer
1336  * (if buffer size allows).
1337  *
1338  * @param mp
1339  *   The mempool from which the mbuf is allocated.
1340  * @return
1341  *   - The pointer to the new mbuf on success.
1342  *   - NULL if allocation failed.
1343  */
1344 static inline struct rte_mbuf *rte_pktmbuf_alloc(struct rte_mempool *mp)
1345 {
1346         struct rte_mbuf *m;
1347         if ((m = __rte_mbuf_raw_alloc(mp)) != NULL)
1348                 rte_pktmbuf_reset(m);
1349         return m;
1350 }
1351
1352 /**
1353  * Attach packet mbuf to another packet mbuf.
1354  *
1355  * After attachment we refer the mbuf we attached as 'indirect',
1356  * while mbuf we attached to as 'direct'.
1357  * Right now, not supported:
1358  *  - attachment for already indirect mbuf (e.g. - mi has to be direct).
1359  *  - mbuf we trying to attach (mi) is used by someone else
1360  *    e.g. it's reference counter is greater then 1.
1361  *
1362  * @param mi
1363  *   The indirect packet mbuf.
1364  * @param m
1365  *   The packet mbuf we're attaching to.
1366  */
1367 static inline void rte_pktmbuf_attach(struct rte_mbuf *mi, struct rte_mbuf *m)
1368 {
1369         struct rte_mbuf *md;
1370
1371         RTE_MBUF_ASSERT(RTE_MBUF_DIRECT(mi) &&
1372             rte_mbuf_refcnt_read(mi) == 1);
1373
1374         /* if m is not direct, get the mbuf that embeds the data */
1375         if (RTE_MBUF_DIRECT(m))
1376                 md = m;
1377         else
1378                 md = rte_mbuf_from_indirect(m);
1379
1380         rte_mbuf_refcnt_update(md, 1);
1381         mi->priv_size = m->priv_size;
1382         mi->buf_physaddr = m->buf_physaddr;
1383         mi->buf_addr = m->buf_addr;
1384         mi->buf_len = m->buf_len;
1385
1386         mi->next = m->next;
1387         mi->data_off = m->data_off;
1388         mi->data_len = m->data_len;
1389         mi->port = m->port;
1390         mi->vlan_tci = m->vlan_tci;
1391         mi->vlan_tci_outer = m->vlan_tci_outer;
1392         mi->tx_offload = m->tx_offload;
1393         mi->hash = m->hash;
1394
1395         mi->next = NULL;
1396         mi->pkt_len = mi->data_len;
1397         mi->nb_segs = 1;
1398         mi->ol_flags = m->ol_flags | IND_ATTACHED_MBUF;
1399         mi->packet_type = m->packet_type;
1400
1401         __rte_mbuf_sanity_check(mi, 1);
1402         __rte_mbuf_sanity_check(m, 0);
1403 }
1404
1405 /**
1406  * Detach an indirect packet mbuf.
1407  *
1408  *  - restore original mbuf address and length values.
1409  *  - reset pktmbuf data and data_len to their default values.
1410  *  All other fields of the given packet mbuf will be left intact.
1411  *
1412  * @param m
1413  *   The indirect attached packet mbuf.
1414  */
1415 static inline void rte_pktmbuf_detach(struct rte_mbuf *m)
1416 {
1417         struct rte_mempool *mp = m->pool;
1418         uint32_t mbuf_size, buf_len, priv_size;
1419
1420         priv_size = rte_pktmbuf_priv_size(mp);
1421         mbuf_size = sizeof(struct rte_mbuf) + priv_size;
1422         buf_len = rte_pktmbuf_data_room_size(mp);
1423
1424         m->priv_size = priv_size;
1425         m->buf_addr = (char *)m + mbuf_size;
1426         m->buf_physaddr = rte_mempool_virt2phy(mp, m) + mbuf_size;
1427         m->buf_len = (uint16_t)buf_len;
1428         m->data_off = RTE_MIN(RTE_PKTMBUF_HEADROOM, (uint16_t)m->buf_len);
1429         m->data_len = 0;
1430         m->ol_flags = 0;
1431 }
1432
1433 static inline struct rte_mbuf* __attribute__((always_inline))
1434 __rte_pktmbuf_prefree_seg(struct rte_mbuf *m)
1435 {
1436         __rte_mbuf_sanity_check(m, 0);
1437
1438         if (likely(rte_mbuf_refcnt_update(m, -1) == 0)) {
1439
1440                 /* if this is an indirect mbuf, then
1441                  *  - detach mbuf
1442                  *  - free attached mbuf segment
1443                  */
1444                 if (RTE_MBUF_INDIRECT(m)) {
1445                         struct rte_mbuf *md = rte_mbuf_from_indirect(m);
1446                         rte_pktmbuf_detach(m);
1447                         if (rte_mbuf_refcnt_update(md, -1) == 0)
1448                                 __rte_mbuf_raw_free(md);
1449                 }
1450                 return m;
1451         }
1452         return NULL;
1453 }
1454
1455 /**
1456  * Free a segment of a packet mbuf into its original mempool.
1457  *
1458  * Free an mbuf, without parsing other segments in case of chained
1459  * buffers.
1460  *
1461  * @param m
1462  *   The packet mbuf segment to be freed.
1463  */
1464 static inline void __attribute__((always_inline))
1465 rte_pktmbuf_free_seg(struct rte_mbuf *m)
1466 {
1467         if (likely(NULL != (m = __rte_pktmbuf_prefree_seg(m)))) {
1468                 m->next = NULL;
1469                 __rte_mbuf_raw_free(m);
1470         }
1471 }
1472
1473 /**
1474  * Free a packet mbuf back into its original mempool.
1475  *
1476  * Free an mbuf, and all its segments in case of chained buffers. Each
1477  * segment is added back into its original mempool.
1478  *
1479  * @param m
1480  *   The packet mbuf to be freed.
1481  */
1482 static inline void rte_pktmbuf_free(struct rte_mbuf *m)
1483 {
1484         struct rte_mbuf *m_next;
1485
1486         __rte_mbuf_sanity_check(m, 1);
1487
1488         while (m != NULL) {
1489                 m_next = m->next;
1490                 rte_pktmbuf_free_seg(m);
1491                 m = m_next;
1492         }
1493 }
1494
1495 /**
1496  * Creates a "clone" of the given packet mbuf.
1497  *
1498  * Walks through all segments of the given packet mbuf, and for each of them:
1499  *  - Creates a new packet mbuf from the given pool.
1500  *  - Attaches newly created mbuf to the segment.
1501  * Then updates pkt_len and nb_segs of the "clone" packet mbuf to match values
1502  * from the original packet mbuf.
1503  *
1504  * @param md
1505  *   The packet mbuf to be cloned.
1506  * @param mp
1507  *   The mempool from which the "clone" mbufs are allocated.
1508  * @return
1509  *   - The pointer to the new "clone" mbuf on success.
1510  *   - NULL if allocation fails.
1511  */
1512 static inline struct rte_mbuf *rte_pktmbuf_clone(struct rte_mbuf *md,
1513                 struct rte_mempool *mp)
1514 {
1515         struct rte_mbuf *mc, *mi, **prev;
1516         uint32_t pktlen;
1517         uint8_t nseg;
1518
1519         if (unlikely ((mc = rte_pktmbuf_alloc(mp)) == NULL))
1520                 return NULL;
1521
1522         mi = mc;
1523         prev = &mi->next;
1524         pktlen = md->pkt_len;
1525         nseg = 0;
1526
1527         do {
1528                 nseg++;
1529                 rte_pktmbuf_attach(mi, md);
1530                 *prev = mi;
1531                 prev = &mi->next;
1532         } while ((md = md->next) != NULL &&
1533             (mi = rte_pktmbuf_alloc(mp)) != NULL);
1534
1535         *prev = NULL;
1536         mc->nb_segs = nseg;
1537         mc->pkt_len = pktlen;
1538
1539         /* Allocation of new indirect segment failed */
1540         if (unlikely (mi == NULL)) {
1541                 rte_pktmbuf_free(mc);
1542                 return NULL;
1543         }
1544
1545         __rte_mbuf_sanity_check(mc, 1);
1546         return mc;
1547 }
1548
1549 /**
1550  * Adds given value to the refcnt of all packet mbuf segments.
1551  *
1552  * Walks through all segments of given packet mbuf and for each of them
1553  * invokes rte_mbuf_refcnt_update().
1554  *
1555  * @param m
1556  *   The packet mbuf whose refcnt to be updated.
1557  * @param v
1558  *   The value to add to the mbuf's segments refcnt.
1559  */
1560 static inline void rte_pktmbuf_refcnt_update(struct rte_mbuf *m, int16_t v)
1561 {
1562         __rte_mbuf_sanity_check(m, 1);
1563
1564         do {
1565                 rte_mbuf_refcnt_update(m, v);
1566         } while ((m = m->next) != NULL);
1567 }
1568
1569 /**
1570  * Get the headroom in a packet mbuf.
1571  *
1572  * @param m
1573  *   The packet mbuf.
1574  * @return
1575  *   The length of the headroom.
1576  */
1577 static inline uint16_t rte_pktmbuf_headroom(const struct rte_mbuf *m)
1578 {
1579         __rte_mbuf_sanity_check(m, 1);
1580         return m->data_off;
1581 }
1582
1583 /**
1584  * Get the tailroom of a packet mbuf.
1585  *
1586  * @param m
1587  *   The packet mbuf.
1588  * @return
1589  *   The length of the tailroom.
1590  */
1591 static inline uint16_t rte_pktmbuf_tailroom(const struct rte_mbuf *m)
1592 {
1593         __rte_mbuf_sanity_check(m, 1);
1594         return (uint16_t)(m->buf_len - rte_pktmbuf_headroom(m) -
1595                           m->data_len);
1596 }
1597
1598 /**
1599  * Get the last segment of the packet.
1600  *
1601  * @param m
1602  *   The packet mbuf.
1603  * @return
1604  *   The last segment of the given mbuf.
1605  */
1606 static inline struct rte_mbuf *rte_pktmbuf_lastseg(struct rte_mbuf *m)
1607 {
1608         struct rte_mbuf *m2 = (struct rte_mbuf *)m;
1609
1610         __rte_mbuf_sanity_check(m, 1);
1611         while (m2->next != NULL)
1612                 m2 = m2->next;
1613         return m2;
1614 }
1615
1616 /**
1617  * A macro that points to an offset into the data in the mbuf.
1618  *
1619  * The returned pointer is cast to type t. Before using this
1620  * function, the user must ensure that the first segment is large
1621  * enough to accommodate its data.
1622  *
1623  * @param m
1624  *   The packet mbuf.
1625  * @param o
1626  *   The offset into the mbuf data.
1627  * @param t
1628  *   The type to cast the result into.
1629  */
1630 #define rte_pktmbuf_mtod_offset(m, t, o)        \
1631         ((t)((char *)(m)->buf_addr + (m)->data_off + (o)))
1632
1633 /**
1634  * A macro that points to the start of the data in the mbuf.
1635  *
1636  * The returned pointer is cast to type t. Before using this
1637  * function, the user must ensure that the first segment is large
1638  * enough to accommodate its data.
1639  *
1640  * @param m
1641  *   The packet mbuf.
1642  * @param t
1643  *   The type to cast the result into.
1644  */
1645 #define rte_pktmbuf_mtod(m, t) rte_pktmbuf_mtod_offset(m, t, 0)
1646
1647 /**
1648  * A macro that returns the length of the packet.
1649  *
1650  * The value can be read or assigned.
1651  *
1652  * @param m
1653  *   The packet mbuf.
1654  */
1655 #define rte_pktmbuf_pkt_len(m) ((m)->pkt_len)
1656
1657 /**
1658  * A macro that returns the length of the segment.
1659  *
1660  * The value can be read or assigned.
1661  *
1662  * @param m
1663  *   The packet mbuf.
1664  */
1665 #define rte_pktmbuf_data_len(m) ((m)->data_len)
1666
1667 /**
1668  * Prepend len bytes to an mbuf data area.
1669  *
1670  * Returns a pointer to the new
1671  * data start address. If there is not enough headroom in the first
1672  * segment, the function will return NULL, without modifying the mbuf.
1673  *
1674  * @param m
1675  *   The pkt mbuf.
1676  * @param len
1677  *   The amount of data to prepend (in bytes).
1678  * @return
1679  *   A pointer to the start of the newly prepended data, or
1680  *   NULL if there is not enough headroom space in the first segment
1681  */
1682 static inline char *rte_pktmbuf_prepend(struct rte_mbuf *m,
1683                                         uint16_t len)
1684 {
1685         __rte_mbuf_sanity_check(m, 1);
1686
1687         if (unlikely(len > rte_pktmbuf_headroom(m)))
1688                 return NULL;
1689
1690         m->data_off -= len;
1691         m->data_len = (uint16_t)(m->data_len + len);
1692         m->pkt_len  = (m->pkt_len + len);
1693
1694         return (char *)m->buf_addr + m->data_off;
1695 }
1696
1697 /**
1698  * Append len bytes to an mbuf.
1699  *
1700  * Append len bytes to an mbuf and return a pointer to the start address
1701  * of the added data. If there is not enough tailroom in the last
1702  * segment, the function will return NULL, without modifying the mbuf.
1703  *
1704  * @param m
1705  *   The packet mbuf.
1706  * @param len
1707  *   The amount of data to append (in bytes).
1708  * @return
1709  *   A pointer to the start of the newly appended data, or
1710  *   NULL if there is not enough tailroom space in the last segment
1711  */
1712 static inline char *rte_pktmbuf_append(struct rte_mbuf *m, uint16_t len)
1713 {
1714         void *tail;
1715         struct rte_mbuf *m_last;
1716
1717         __rte_mbuf_sanity_check(m, 1);
1718
1719         m_last = rte_pktmbuf_lastseg(m);
1720         if (unlikely(len > rte_pktmbuf_tailroom(m_last)))
1721                 return NULL;
1722
1723         tail = (char *)m_last->buf_addr + m_last->data_off + m_last->data_len;
1724         m_last->data_len = (uint16_t)(m_last->data_len + len);
1725         m->pkt_len  = (m->pkt_len + len);
1726         return (char*) tail;
1727 }
1728
1729 /**
1730  * Remove len bytes at the beginning of an mbuf.
1731  *
1732  * Returns a pointer to the start address of the new data area. If the
1733  * length is greater than the length of the first segment, then the
1734  * function will fail and return NULL, without modifying the mbuf.
1735  *
1736  * @param m
1737  *   The packet mbuf.
1738  * @param len
1739  *   The amount of data to remove (in bytes).
1740  * @return
1741  *   A pointer to the new start of the data.
1742  */
1743 static inline char *rte_pktmbuf_adj(struct rte_mbuf *m, uint16_t len)
1744 {
1745         __rte_mbuf_sanity_check(m, 1);
1746
1747         if (unlikely(len > m->data_len))
1748                 return NULL;
1749
1750         m->data_len = (uint16_t)(m->data_len - len);
1751         m->data_off += len;
1752         m->pkt_len  = (m->pkt_len - len);
1753         return (char *)m->buf_addr + m->data_off;
1754 }
1755
1756 /**
1757  * Remove len bytes of data at the end of the mbuf.
1758  *
1759  * If the length is greater than the length of the last segment, the
1760  * function will fail and return -1 without modifying the mbuf.
1761  *
1762  * @param m
1763  *   The packet mbuf.
1764  * @param len
1765  *   The amount of data to remove (in bytes).
1766  * @return
1767  *   - 0: On success.
1768  *   - -1: On error.
1769  */
1770 static inline int rte_pktmbuf_trim(struct rte_mbuf *m, uint16_t len)
1771 {
1772         struct rte_mbuf *m_last;
1773
1774         __rte_mbuf_sanity_check(m, 1);
1775
1776         m_last = rte_pktmbuf_lastseg(m);
1777         if (unlikely(len > m_last->data_len))
1778                 return -1;
1779
1780         m_last->data_len = (uint16_t)(m_last->data_len - len);
1781         m->pkt_len  = (m->pkt_len - len);
1782         return 0;
1783 }
1784
1785 /**
1786  * Test if mbuf data is contiguous.
1787  *
1788  * @param m
1789  *   The packet mbuf.
1790  * @return
1791  *   - 1, if all data is contiguous (one segment).
1792  *   - 0, if there is several segments.
1793  */
1794 static inline int rte_pktmbuf_is_contiguous(const struct rte_mbuf *m)
1795 {
1796         __rte_mbuf_sanity_check(m, 1);
1797         return !!(m->nb_segs == 1);
1798 }
1799
1800 /**
1801  * Dump an mbuf structure to the console.
1802  *
1803  * Dump all fields for the given packet mbuf and all its associated
1804  * segments (in the case of a chained buffer).
1805  *
1806  * @param f
1807  *   A pointer to a file for output
1808  * @param m
1809  *   The packet mbuf.
1810  * @param dump_len
1811  *   If dump_len != 0, also dump the "dump_len" first data bytes of
1812  *   the packet.
1813  */
1814 void rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len);
1815
1816 #ifdef __cplusplus
1817 }
1818 #endif
1819
1820 #endif /* _RTE_MBUF_H_ */