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