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_mempool.h>
  58 #include <rte_atomic.h>
  59 #include <rte_prefetch.h>
  60 #include <rte_branch_prediction.h>
  61
  62 #ifdef __cplusplus
  63 extern "C" {
  64 #endif
  65
  66 /* deprecated feature, renamed in RTE_MBUF_REFCNT */
  67 #pragma GCC poison RTE_MBUF_SCATTER_GATHER
  68
  69 /*
  70  * Packet Offload Features Flags. It also carry packet type information.
  71  * Critical resources. Both rx/tx shared these bits. Be cautious on any change
  72  *
  73  * - RX flags start at bit position zero, and get added to the left of previous
  74  *   flags.
  75  * - The most-significant 8 bits are reserved for generic mbuf flags
  76  * - TX flags therefore start at bit position 55 (i.e. 63-8), and new flags get
  77  *   added to the right of the previously defined flags
  78  *
  79  * Keep these flags synchronized with rte_get_rx_ol_flag_name() and
  80  * rte_get_tx_ol_flag_name().
  81  */
  82 #define PKT_RX_VLAN_PKT      (1ULL << 0)  /**< RX packet is a 802.1q VLAN packet. */
  83 #define PKT_RX_RSS_HASH      (1ULL << 1)  /**< RX packet with RSS hash result. */
  84 #define PKT_RX_FDIR          (1ULL << 2)  /**< RX packet with FDIR match indicate. */
  85 #define PKT_RX_L4_CKSUM_BAD  (1ULL << 3)  /**< L4 cksum of RX pkt. is not OK. */
  86 #define PKT_RX_IP_CKSUM_BAD  (1ULL << 4)  /**< IP cksum of RX pkt. is not OK. */
  87 #define PKT_RX_EIP_CKSUM_BAD (0ULL << 0)  /**< External IP header checksum error. */
  88 #define PKT_RX_OVERSIZE      (0ULL << 0)  /**< Num of desc of an RX pkt oversize. */
  89 #define PKT_RX_HBUF_OVERFLOW (0ULL << 0)  /**< Header buffer overflow. */
  90 #define PKT_RX_RECIP_ERR     (0ULL << 0)  /**< Hardware processing error. */
  91 #define PKT_RX_MAC_ERR       (0ULL << 0)  /**< MAC error. */
  92 #define PKT_RX_IPV4_HDR      (1ULL << 5)  /**< RX packet with IPv4 header. */
  93 #define PKT_RX_IPV4_HDR_EXT  (1ULL << 6)  /**< RX packet with extended IPv4 header. */
  94 #define PKT_RX_IPV6_HDR      (1ULL << 7)  /**< RX packet with IPv6 header. */
  95 #define PKT_RX_IPV6_HDR_EXT  (1ULL << 8)  /**< RX packet with extended IPv6 header. */
  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_TUNNEL_IPV4_HDR (1ULL << 11) /**< RX tunnel packet with IPv4 header.*/
  99 #define PKT_RX_TUNNEL_IPV6_HDR (1ULL << 12) /**< RX tunnel packet with IPv6 header. */
 100 #define PKT_RX_FDIR_ID       (1ULL << 13) /**< FD id reported if FDIR match. */
 101 #define PKT_RX_FDIR_FLX      (1ULL << 14) /**< Flexible bytes reported if FDIR match. */
 102 /* add new RX flags here */
 103
 104 /* add new TX flags here */
 105
 106 /**
 107  * TCP segmentation offload. To enable this offload feature for a
 108  * packet to be transmitted on hardware supporting TSO:
 109  *  - set the PKT_TX_TCP_SEG flag in mbuf->ol_flags (this flag implies
 110  *    PKT_TX_TCP_CKSUM)
 111  *  - set the flag PKT_TX_IPV4 or PKT_TX_IPV6
 112  *  - if it's IPv4, set the PKT_TX_IP_CKSUM flag and write the IP checksum
 113  *    to 0 in the packet
 114  *  - fill the mbuf offload information: l2_len, l3_len, l4_len, tso_segsz
 115  *  - calculate the pseudo header checksum without taking ip_len in account,
 116  *    and set it in the TCP header. Refer to rte_ipv4_phdr_cksum() and
 117  *    rte_ipv6_phdr_cksum() that can be used as helpers.
 118  */
 119 #define PKT_TX_TCP_SEG       (1ULL << 49)
 120
 121 #define PKT_TX_VXLAN_CKSUM   (1ULL << 50) /**< TX checksum of VXLAN computed by NIC */
 122 #define PKT_TX_IEEE1588_TMST (1ULL << 51) /**< TX IEEE1588 packet to timestamp. */
 123
 124 /**
 125  * Bits 52+53 used for L4 packet type with checksum enabled: 00: Reserved,
 126  * 01: TCP checksum, 10: SCTP checksum, 11: UDP checksum. To use hardware
 127  * L4 checksum offload, the user needs to:
 128  *  - fill l2_len and l3_len in mbuf
 129  *  - set the flags PKT_TX_TCP_CKSUM, PKT_TX_SCTP_CKSUM or PKT_TX_UDP_CKSUM
 130  *  - set the flag PKT_TX_IPV4 or PKT_TX_IPV6
 131  *  - calculate the pseudo header checksum and set it in the L4 header (only
 132  *    for TCP or UDP). See rte_ipv4_phdr_cksum() and rte_ipv6_phdr_cksum().
 133  *    For SCTP, set the crc field to 0.
 134  */
 135 #define PKT_TX_L4_NO_CKSUM   (0ULL << 52) /**< Disable L4 cksum of TX pkt. */
 136 #define PKT_TX_TCP_CKSUM     (1ULL << 52) /**< TCP cksum of TX pkt. computed by NIC. */
 137 #define PKT_TX_SCTP_CKSUM    (2ULL << 52) /**< SCTP cksum of TX pkt. computed by NIC. */
 138 #define PKT_TX_UDP_CKSUM     (3ULL << 52) /**< UDP cksum of TX pkt. computed by NIC. */
 139 #define PKT_TX_L4_MASK       (3ULL << 52) /**< Mask for L4 cksum offload request. */
 140
 141 #define PKT_TX_IP_CKSUM      (1ULL << 54) /**< IP cksum of TX pkt. computed by NIC. */
 142 #define PKT_TX_IPV4_CSUM     PKT_TX_IP_CKSUM /**< Alias of PKT_TX_IP_CKSUM. */
 143
 144 /** Packet is IPv4 without requiring IP checksum offload. */
 145 #define PKT_TX_IPV4          (1ULL << 55)
 146
 147 /** Tell the NIC it's an IPv6 packet.*/
 148 #define PKT_TX_IPV6          (1ULL << 56)
 149
 150 #define PKT_TX_VLAN_PKT      (1ULL << 57) /**< TX packet is a 802.1q VLAN packet. */
 151
 152 /* Use final bit of flags to indicate a control mbuf */
 153 #define CTRL_MBUF_FLAG       (1ULL << 63) /**< Mbuf contains control data */
 154
 155 /**
 156  * Get the name of a RX offload flag
 157  *
 158  * @param mask
 159  *   The mask describing the flag.
 160  * @return
 161  *   The name of this flag, or NULL if it's not a valid RX flag.
 162  */
 163 const char *rte_get_rx_ol_flag_name(uint64_t mask);
 164
 165 /**
 166  * Get the name of a TX offload flag
 167  *
 168  * @param mask
 169  *   The mask describing the flag. Usually only one bit must be set.
 170  *   Several bits can be given if they belong to the same mask.
 171  *   Ex: PKT_TX_L4_MASK.
 172  * @return
 173  *   The name of this flag, or NULL if it's not a valid TX flag.
 174  */
 175 const char *rte_get_tx_ol_flag_name(uint64_t mask);
 176
 177 /* define a set of marker types that can be used to refer to set points in the
 178  * mbuf */
 179 typedef void    *MARKER[0];   /**< generic marker for a point in a structure */
 180 typedef uint64_t MARKER64[0]; /**< marker that allows us to overwrite 8 bytes
 181                                * with a single assignment */
 182 /**
 183  * The generic rte_mbuf, containing a packet mbuf.
 184  */
 185 struct rte_mbuf {
 186         MARKER cacheline0;
 187
 188         void *buf_addr;           /**< Virtual address of segment buffer. */
 189         phys_addr_t buf_physaddr; /**< Physical address of segment buffer. */
 190
 191         /* next 8 bytes are initialised on RX descriptor rearm */
 192         MARKER64 rearm_data;
 193         uint16_t buf_len;         /**< Length of segment buffer. */
 194         uint16_t data_off;
 195
 196         /**
 197          * 16-bit Reference counter.
 198          * It should only be accessed using the following functions:
 199          * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and
 200          * rte_mbuf_refcnt_set(). The functionality of these functions (atomic,
 201          * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC
 202          * config option.
 203          */
 204         union {
 205 #ifdef RTE_MBUF_REFCNT
 206                 rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */
 207                 uint16_t refcnt;              /**< Non-atomically accessed refcnt */
 208 #endif
 209                 uint16_t refcnt_reserved;     /**< Do not use this field */
 210         };
 211         uint8_t nb_segs;          /**< Number of segments. */
 212         uint8_t port;             /**< Input port. */
 213
 214         uint64_t ol_flags;        /**< Offload features. */
 215
 216         /* remaining bytes are set on RX when pulling packet from descriptor */
 217         MARKER rx_descriptor_fields1;
 218
 219         /**
 220          * The packet type, which is used to indicate ordinary packet and also
 221          * tunneled packet format, i.e. each number is represented a type of
 222          * packet.
 223          */
 224         uint16_t packet_type;
 225
 226         uint16_t data_len;        /**< Amount of data in segment buffer. */
 227         uint32_t pkt_len;         /**< Total pkt len: sum of all segments. */
 228         uint16_t vlan_tci;        /**< VLAN Tag Control Identifier (CPU order) */
 229         uint16_t reserved;
 230         union {
 231                 uint32_t rss;     /**< RSS hash result if RSS enabled */
 232                 struct {
 233                         union {
 234                                 struct {
 235                                         uint16_t hash;
 236                                         uint16_t id;
 237                                 };
 238                                 uint32_t lo;
 239                                 /**< Second 4 flexible bytes */
 240                         };
 241                         uint32_t hi;
 242                         /**< First 4 flexible bytes or FD ID, dependent on
 243                              PKT_RX_FDIR_* flag in ol_flags. */
 244                 } fdir;           /**< Filter identifier if FDIR enabled */
 245                 uint32_t sched;   /**< Hierarchical scheduler */
 246                 uint32_t usr;     /**< User defined tags. See @rte_distributor_process */
 247         } hash;                   /**< hash information */
 248
 249         /* second cache line - fields only used in slow path or on TX */
 250         MARKER cacheline1 __rte_cache_aligned;
 251
 252         union {
 253                 void *userdata;   /**< Can be used for external metadata */
 254                 uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */
 255         };
 256
 257         struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */
 258         struct rte_mbuf *next;    /**< Next segment of scattered packet. */
 259
 260         /* fields to support TX offloads */
 261         union {
 262                 uint64_t tx_offload;       /**< combined for easy fetch */
 263                 struct {
 264                         uint64_t l2_len:7; /**< L2 (MAC) Header Length. */
 265                         uint64_t l3_len:9; /**< L3 (IP) Header Length. */
 266                         uint64_t l4_len:8; /**< L4 (TCP/UDP) Header Length. */
 267                         uint64_t tso_segsz:16; /**< TCP TSO segment size */
 268
 269                         /* fields for TX offloading of tunnels */
 270                         uint64_t inner_l3_len:9; /**< inner L3 (IP) Hdr Length. */
 271                         uint64_t inner_l2_len:7; /**< inner L2 (MAC) Hdr Length. */
 272
 273                         /* uint64_t unused:8; */
 274                 };
 275         };
 276 } __rte_cache_aligned;
 277
 278 /**
 279  * Given the buf_addr returns the pointer to corresponding mbuf.
 280  */
 281 #define RTE_MBUF_FROM_BADDR(ba)     (((struct rte_mbuf *)(ba)) - 1)
 282
 283 /**
 284  * Given the pointer to mbuf returns an address where it's  buf_addr
 285  * should point to.
 286  */
 287 #define RTE_MBUF_TO_BADDR(mb)       (((struct rte_mbuf *)(mb)) + 1)
 288
 289 /**
 290  * Returns TRUE if given mbuf is indirect, or FALSE otherwise.
 291  */
 292 #define RTE_MBUF_INDIRECT(mb)   (RTE_MBUF_FROM_BADDR((mb)->buf_addr) != (mb))
 293
 294 /**
 295  * Returns TRUE if given mbuf is direct, or FALSE otherwise.
 296  */
 297 #define RTE_MBUF_DIRECT(mb)     (RTE_MBUF_FROM_BADDR((mb)->buf_addr) == (mb))
 298
 299
 300 /**
 301  * Private data in case of pktmbuf pool.
 302  *
 303  * A structure that contains some pktmbuf_pool-specific data that are
 304  * appended after the mempool structure (in private data).
 305  */
 306 struct rte_pktmbuf_pool_private {
 307         uint16_t mbuf_data_room_size; /**< Size of data space in each mbuf.*/
 308 };
 309
 310 #ifdef RTE_LIBRTE_MBUF_DEBUG
 311
 312 /**  check mbuf type in debug mode */
 313 #define __rte_mbuf_sanity_check(m, is_h) rte_mbuf_sanity_check(m, is_h)
 314
 315 /**  check mbuf type in debug mode if mbuf pointer is not null */
 316 #define __rte_mbuf_sanity_check_raw(m, is_h)    do {       \
 317         if ((m) != NULL)                                   \
 318                 rte_mbuf_sanity_check(m, is_h);          \
 319 } while (0)
 320
 321 /**  MBUF asserts in debug mode */
 322 #define RTE_MBUF_ASSERT(exp)                                         \
 323 if (!(exp)) {                                                        \
 324         rte_panic("line%d\tassert \"" #exp "\" failed\n", __LINE__); \
 325 }
 326
 327 #else /*  RTE_LIBRTE_MBUF_DEBUG */
 328
 329 /**  check mbuf type in debug mode */
 330 #define __rte_mbuf_sanity_check(m, is_h) do { } while (0)
 331
 332 /**  check mbuf type in debug mode if mbuf pointer is not null */
 333 #define __rte_mbuf_sanity_check_raw(m, is_h) do { } while (0)
 334
 335 /**  MBUF asserts in debug mode */
 336 #define RTE_MBUF_ASSERT(exp)                do { } while (0)
 337
 338 #endif /*  RTE_LIBRTE_MBUF_DEBUG */
 339
 340 #ifdef RTE_MBUF_REFCNT
 341 #ifdef RTE_MBUF_REFCNT_ATOMIC
 342
 343 /**
 344  * Adds given value to an mbuf's refcnt and returns its new value.
 345  * @param m
 346  *   Mbuf to update
 347  * @param value
 348  *   Value to add/subtract
 349  * @return
 350  *   Updated value
 351  */
 352 static inline uint16_t
 353 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
 354 {
 355         return (uint16_t)(rte_atomic16_add_return(&m->refcnt_atomic, value));
 356 }
 357
 358 /**
 359  * Reads the value of an mbuf's refcnt.
 360  * @param m
 361  *   Mbuf to read
 362  * @return
 363  *   Reference count number.
 364  */
 365 static inline uint16_t
 366 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
 367 {
 368         return (uint16_t)(rte_atomic16_read(&m->refcnt_atomic));
 369 }
 370
 371 /**
 372  * Sets an mbuf's refcnt to a defined value.
 373  * @param m
 374  *   Mbuf to update
 375  * @param new_value
 376  *   Value set
 377  */
 378 static inline void
 379 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
 380 {
 381         rte_atomic16_set(&m->refcnt_atomic, new_value);
 382 }
 383
 384 #else /* ! RTE_MBUF_REFCNT_ATOMIC */
 385
 386 /**
 387  * Adds given value to an mbuf's refcnt and returns its new value.
 388  */
 389 static inline uint16_t
 390 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
 391 {
 392         m->refcnt = (uint16_t)(m->refcnt + value);
 393         return m->refcnt;
 394 }
 395
 396 /**
 397  * Reads the value of an mbuf's refcnt.
 398  */
 399 static inline uint16_t
 400 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
 401 {
 402         return m->refcnt;
 403 }
 404
 405 /**
 406  * Sets an mbuf's refcnt to the defined value.
 407  */
 408 static inline void
 409 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
 410 {
 411         m->refcnt = new_value;
 412 }
 413
 414 #endif /* RTE_MBUF_REFCNT_ATOMIC */
 415
 416 /** Mbuf prefetch */
 417 #define RTE_MBUF_PREFETCH_TO_FREE(m) do {       \
 418         if ((m) != NULL)                        \
 419                 rte_prefetch0(m);               \
 420 } while (0)
 421
 422 #else /* ! RTE_MBUF_REFCNT */
 423
 424 /** Mbuf prefetch */
 425 #define RTE_MBUF_PREFETCH_TO_FREE(m) do { } while(0)
 426
 427 #define rte_mbuf_refcnt_set(m,v) do { } while(0)
 428
 429 #endif /* RTE_MBUF_REFCNT */
 430
 431
 432 /**
 433  * Sanity checks on an mbuf.
 434  *
 435  * Check the consistency of the given mbuf. The function will cause a
 436  * panic if corruption is detected.
 437  *
 438  * @param m
 439  *   The mbuf to be checked.
 440  * @param is_header
 441  *   True if the mbuf is a packet header, false if it is a sub-segment
 442  *   of a packet (in this case, some fields like nb_segs are not checked)
 443  */
 444 void
 445 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header);
 446
 447 /**
 448  * @internal Allocate a new mbuf from mempool *mp*.
 449  * The use of that function is reserved for RTE internal needs.
 450  * Please use rte_pktmbuf_alloc().
 451  *
 452  * @param mp
 453  *   The mempool from which mbuf is allocated.
 454  * @return
 455  *   - The pointer to the new mbuf on success.
 456  *   - NULL if allocation failed.
 457  */
 458 static inline struct rte_mbuf *__rte_mbuf_raw_alloc(struct rte_mempool *mp)
 459 {
 460         struct rte_mbuf *m;
 461         void *mb = NULL;
 462         if (rte_mempool_get(mp, &mb) < 0)
 463                 return NULL;
 464         m = (struct rte_mbuf *)mb;
 465 #ifdef RTE_MBUF_REFCNT
 466         RTE_MBUF_ASSERT(rte_mbuf_refcnt_read(m) == 0);
 467         rte_mbuf_refcnt_set(m, 1);
 468 #endif /* RTE_MBUF_REFCNT */
 469         return (m);
 470 }
 471
 472 /**
 473  * @internal Put mbuf back into its original mempool.
 474  * The use of that function is reserved for RTE internal needs.
 475  * Please use rte_pktmbuf_free().
 476  *
 477  * @param m
 478  *   The mbuf to be freed.
 479  */
 480 static inline void __attribute__((always_inline))
 481 __rte_mbuf_raw_free(struct rte_mbuf *m)
 482 {
 483 #ifdef RTE_MBUF_REFCNT
 484         RTE_MBUF_ASSERT(rte_mbuf_refcnt_read(m) == 0);
 485 #endif /* RTE_MBUF_REFCNT */
 486         rte_mempool_put(m->pool, m);
 487 }
 488
 489 /* Operations on ctrl mbuf */
 490
 491 /**
 492  * The control mbuf constructor.
 493  *
 494  * This function initializes some fields in an mbuf structure that are
 495  * not modified by the user once created (mbuf type, origin pool, buffer
 496  * start address, and so on). This function is given as a callback function
 497  * to rte_mempool_create() at pool creation time.
 498  *
 499  * @param mp
 500  *   The mempool from which the mbuf is allocated.
 501  * @param opaque_arg
 502  *   A pointer that can be used by the user to retrieve useful information
 503  *   for mbuf initialization. This pointer comes from the ``init_arg``
 504  *   parameter of rte_mempool_create().
 505  * @param m
 506  *   The mbuf to initialize.
 507  * @param i
 508  *   The index of the mbuf in the pool table.
 509  */
 510 void rte_ctrlmbuf_init(struct rte_mempool *mp, void *opaque_arg,
 511                 void *m, unsigned i);
 512
 513 /**
 514  * Allocate a new mbuf (type is ctrl) from mempool *mp*.
 515  *
 516  * This new mbuf is initialized with data pointing to the beginning of
 517  * buffer, and with a length of zero.
 518  *
 519  * @param mp
 520  *   The mempool from which the mbuf is allocated.
 521  * @return
 522  *   - The pointer to the new mbuf on success.
 523  *   - NULL if allocation failed.
 524  */
 525 #define rte_ctrlmbuf_alloc(mp) rte_pktmbuf_alloc(mp)
 526
 527 /**
 528  * Free a control mbuf back into its original mempool.
 529  *
 530  * @param m
 531  *   The control mbuf to be freed.
 532  */
 533 #define rte_ctrlmbuf_free(m) rte_pktmbuf_free(m)
 534
 535 /**
 536  * A macro that returns the pointer to the carried data.
 537  *
 538  * The value that can be read or assigned.
 539  *
 540  * @param m
 541  *   The control mbuf.
 542  */
 543 #define rte_ctrlmbuf_data(m) ((char *)((m)->buf_addr) + (m)->data_off)
 544
 545 /**
 546  * A macro that returns the length of the carried data.
 547  *
 548  * The value that can be read or assigned.
 549  *
 550  * @param m
 551  *   The control mbuf.
 552  */
 553 #define rte_ctrlmbuf_len(m) rte_pktmbuf_data_len(m)
 554
 555 /**
 556  * Tests if an mbuf is a control mbuf
 557  *
 558  * @param m
 559  *   The mbuf to be tested
 560  * @return
 561  *   - True (1) if the mbuf is a control mbuf
 562  *   - False(0) otherwise
 563  */
 564 static inline int
 565 rte_is_ctrlmbuf(struct rte_mbuf *m)
 566 {
 567         return (!!(m->ol_flags & CTRL_MBUF_FLAG));
 568 }
 569
 570 /* Operations on pkt mbuf */
 571
 572 /**
 573  * The packet mbuf constructor.
 574  *
 575  * This function initializes some fields in the mbuf structure that are
 576  * not modified by the user once created (origin pool, buffer start
 577  * address, and so on). This function is given as a callback function to
 578  * rte_mempool_create() at pool creation time.
 579  *
 580  * @param mp
 581  *   The mempool from which mbufs originate.
 582  * @param opaque_arg
 583  *   A pointer that can be used by the user to retrieve useful information
 584  *   for mbuf initialization. This pointer comes from the ``init_arg``
 585  *   parameter of rte_mempool_create().
 586  * @param m
 587  *   The mbuf to initialize.
 588  * @param i
 589  *   The index of the mbuf in the pool table.
 590  */
 591 void rte_pktmbuf_init(struct rte_mempool *mp, void *opaque_arg,
 592                       void *m, unsigned i);
 593
 594
 595 /**
 596  * A  packet mbuf pool constructor.
 597  *
 598  * This function initializes the mempool private data in the case of a
 599  * pktmbuf pool. This private data is needed by the driver. The
 600  * function is given as a callback function to rte_mempool_create() at
 601  * pool creation. It can be extended by the user, for example, to
 602  * provide another packet size.
 603  *
 604  * @param mp
 605  *   The mempool from which mbufs originate.
 606  * @param opaque_arg
 607  *   A pointer that can be used by the user to retrieve useful information
 608  *   for mbuf initialization. This pointer comes from the ``init_arg``
 609  *   parameter of rte_mempool_create().
 610  */
 611 void rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg);
 612
 613 /**
 614  * Reset the fields of a packet mbuf to their default values.
 615  *
 616  * The given mbuf must have only one segment.
 617  *
 618  * @param m
 619  *   The packet mbuf to be resetted.
 620  */
 621 static inline void rte_pktmbuf_reset(struct rte_mbuf *m)
 622 {
 623         m->next = NULL;
 624         m->pkt_len = 0;
 625         m->tx_offload = 0;
 626         m->vlan_tci = 0;
 627         m->nb_segs = 1;
 628         m->port = 0xff;
 629
 630         m->ol_flags = 0;
 631         m->packet_type = 0;
 632         m->data_off = (RTE_PKTMBUF_HEADROOM <= m->buf_len) ?
 633                         RTE_PKTMBUF_HEADROOM : m->buf_len;
 634
 635         m->data_len = 0;
 636         __rte_mbuf_sanity_check(m, 1);
 637 }
 638
 639 /**
 640  * Allocate a new mbuf from a mempool.
 641  *
 642  * This new mbuf contains one segment, which has a length of 0. The pointer
 643  * to data is initialized to have some bytes of headroom in the buffer
 644  * (if buffer size allows).
 645  *
 646  * @param mp
 647  *   The mempool from which the mbuf is allocated.
 648  * @return
 649  *   - The pointer to the new mbuf on success.
 650  *   - NULL if allocation failed.
 651  */
 652 static inline struct rte_mbuf *rte_pktmbuf_alloc(struct rte_mempool *mp)
 653 {
 654         struct rte_mbuf *m;
 655         if ((m = __rte_mbuf_raw_alloc(mp)) != NULL)
 656                 rte_pktmbuf_reset(m);
 657         return (m);
 658 }
 659
 660 #ifdef RTE_MBUF_REFCNT
 661
 662 /**
 663  * Attach packet mbuf to another packet mbuf.
 664  * After attachment we refer the mbuf we attached as 'indirect',
 665  * while mbuf we attached to as 'direct'.
 666  * Right now, not supported:
 667  *  - attachment to indirect mbuf (e.g. - md  has to be direct).
 668  *  - attachment for already indirect mbuf (e.g. - mi has to be direct).
 669  *  - mbuf we trying to attach (mi) is used by someone else
 670  *    e.g. it's reference counter is greater then 1.
 671  *
 672  * @param mi
 673  *   The indirect packet mbuf.
 674  * @param md
 675  *   The direct packet mbuf.
 676  */
 677
 678 static inline void rte_pktmbuf_attach(struct rte_mbuf *mi, struct rte_mbuf *md)
 679 {
 680         RTE_MBUF_ASSERT(RTE_MBUF_DIRECT(md) &&
 681             RTE_MBUF_DIRECT(mi) &&
 682             rte_mbuf_refcnt_read(mi) == 1);
 683
 684         rte_mbuf_refcnt_update(md, 1);
 685         mi->buf_physaddr = md->buf_physaddr;
 686         mi->buf_addr = md->buf_addr;
 687         mi->buf_len = md->buf_len;
 688
 689         mi->next = md->next;
 690         mi->data_off = md->data_off;
 691         mi->data_len = md->data_len;
 692         mi->port = md->port;
 693         mi->vlan_tci = md->vlan_tci;
 694         mi->tx_offload = md->tx_offload;
 695         mi->hash = md->hash;
 696
 697         mi->next = NULL;
 698         mi->pkt_len = mi->data_len;
 699         mi->nb_segs = 1;
 700         mi->ol_flags = md->ol_flags;
 701         mi->packet_type = md->packet_type;
 702
 703         __rte_mbuf_sanity_check(mi, 1);
 704         __rte_mbuf_sanity_check(md, 0);
 705 }
 706
 707 /**
 708  * Detach an indirect packet mbuf -
 709  *  - restore original mbuf address and length values.
 710  *  - reset pktmbuf data and data_len to their default values.
 711  *  All other fields of the given packet mbuf will be left intact.
 712  *
 713  * @param m
 714  *   The indirect attached packet mbuf.
 715  */
 716
 717 static inline void rte_pktmbuf_detach(struct rte_mbuf *m)
 718 {
 719         const struct rte_mempool *mp = m->pool;
 720         void *buf = RTE_MBUF_TO_BADDR(m);
 721         uint32_t buf_len = mp->elt_size - sizeof(*m);
 722         m->buf_physaddr = rte_mempool_virt2phy(mp, m) + sizeof (*m);
 723
 724         m->buf_addr = buf;
 725         m->buf_len = (uint16_t)buf_len;
 726
 727         m->data_off = (RTE_PKTMBUF_HEADROOM <= m->buf_len) ?
 728                         RTE_PKTMBUF_HEADROOM : m->buf_len;
 729
 730         m->data_len = 0;
 731 }
 732
 733 #endif /* RTE_MBUF_REFCNT */
 734
 735
 736 static inline struct rte_mbuf* __attribute__((always_inline))
 737 __rte_pktmbuf_prefree_seg(struct rte_mbuf *m)
 738 {
 739         __rte_mbuf_sanity_check(m, 0);
 740
 741 #ifdef RTE_MBUF_REFCNT
 742         if (likely (rte_mbuf_refcnt_read(m) == 1) ||
 743                         likely (rte_mbuf_refcnt_update(m, -1) == 0)) {
 744                 struct rte_mbuf *md = RTE_MBUF_FROM_BADDR(m->buf_addr);
 745
 746                 rte_mbuf_refcnt_set(m, 0);
 747
 748                 /* if this is an indirect mbuf, then
 749                  *  - detach mbuf
 750                  *  - free attached mbuf segment
 751                  */
 752                 if (unlikely (md != m)) {
 753                         rte_pktmbuf_detach(m);
 754                         if (rte_mbuf_refcnt_update(md, -1) == 0)
 755                                 __rte_mbuf_raw_free(md);
 756                 }
 757 #endif
 758                 return(m);
 759 #ifdef RTE_MBUF_REFCNT
 760         }
 761         return (NULL);
 762 #endif
 763 }
 764
 765 /**
 766  * Free a segment of a packet mbuf into its original mempool.
 767  *
 768  * Free an mbuf, without parsing other segments in case of chained
 769  * buffers.
 770  *
 771  * @param m
 772  *   The packet mbuf segment to be freed.
 773  */
 774 static inline void __attribute__((always_inline))
 775 rte_pktmbuf_free_seg(struct rte_mbuf *m)
 776 {
 777         if (likely(NULL != (m = __rte_pktmbuf_prefree_seg(m)))) {
 778                 m->next = NULL;
 779                 __rte_mbuf_raw_free(m);
 780         }
 781 }
 782
 783 /**
 784  * Free a packet mbuf back into its original mempool.
 785  *
 786  * Free an mbuf, and all its segments in case of chained buffers. Each
 787  * segment is added back into its original mempool.
 788  *
 789  * @param m
 790  *   The packet mbuf to be freed.
 791  */
 792 static inline void rte_pktmbuf_free(struct rte_mbuf *m)
 793 {
 794         struct rte_mbuf *m_next;
 795
 796         __rte_mbuf_sanity_check(m, 1);
 797
 798         while (m != NULL) {
 799                 m_next = m->next;
 800                 rte_pktmbuf_free_seg(m);
 801                 m = m_next;
 802         }
 803 }
 804
 805 #ifdef RTE_MBUF_REFCNT
 806
 807 /**
 808  * Creates a "clone" of the given packet mbuf.
 809  *
 810  * Walks through all segments of the given packet mbuf, and for each of them:
 811  *  - Creates a new packet mbuf from the given pool.
 812  *  - Attaches newly created mbuf to the segment.
 813  * Then updates pkt_len and nb_segs of the "clone" packet mbuf to match values
 814  * from the original packet mbuf.
 815  *
 816  * @param md
 817  *   The packet mbuf to be cloned.
 818  * @param mp
 819  *   The mempool from which the "clone" mbufs are allocated.
 820  * @return
 821  *   - The pointer to the new "clone" mbuf on success.
 822  *   - NULL if allocation fails.
 823  */
 824 static inline struct rte_mbuf *rte_pktmbuf_clone(struct rte_mbuf *md,
 825                 struct rte_mempool *mp)
 826 {
 827         struct rte_mbuf *mc, *mi, **prev;
 828         uint32_t pktlen;
 829         uint8_t nseg;
 830
 831         if (unlikely ((mc = rte_pktmbuf_alloc(mp)) == NULL))
 832                 return (NULL);
 833
 834         mi = mc;
 835         prev = &mi->next;
 836         pktlen = md->pkt_len;
 837         nseg = 0;
 838
 839         do {
 840                 nseg++;
 841                 rte_pktmbuf_attach(mi, md);
 842                 *prev = mi;
 843                 prev = &mi->next;
 844         } while ((md = md->next) != NULL &&
 845             (mi = rte_pktmbuf_alloc(mp)) != NULL);
 846
 847         *prev = NULL;
 848         mc->nb_segs = nseg;
 849         mc->pkt_len = pktlen;
 850
 851         /* Allocation of new indirect segment failed */
 852         if (unlikely (mi == NULL)) {
 853                 rte_pktmbuf_free(mc);
 854                 return (NULL);
 855         }
 856
 857         __rte_mbuf_sanity_check(mc, 1);
 858         return (mc);
 859 }
 860
 861 /**
 862  * Adds given value to the refcnt of all packet mbuf segments.
 863  *
 864  * Walks through all segments of given packet mbuf and for each of them
 865  * invokes rte_mbuf_refcnt_update().
 866  *
 867  * @param m
 868  *   The packet mbuf whose refcnt to be updated.
 869  * @param v
 870  *   The value to add to the mbuf's segments refcnt.
 871  */
 872 static inline void rte_pktmbuf_refcnt_update(struct rte_mbuf *m, int16_t v)
 873 {
 874         __rte_mbuf_sanity_check(m, 1);
 875
 876         do {
 877                 rte_mbuf_refcnt_update(m, v);
 878         } while ((m = m->next) != NULL);
 879 }
 880
 881 #endif /* RTE_MBUF_REFCNT */
 882
 883 /**
 884  * Get the headroom in a packet mbuf.
 885  *
 886  * @param m
 887  *   The packet mbuf.
 888  * @return
 889  *   The length of the headroom.
 890  */
 891 static inline uint16_t rte_pktmbuf_headroom(const struct rte_mbuf *m)
 892 {
 893         __rte_mbuf_sanity_check(m, 1);
 894         return m->data_off;
 895 }
 896
 897 /**
 898  * Get the tailroom of a packet mbuf.
 899  *
 900  * @param m
 901  *   The packet mbuf.
 902  * @return
 903  *   The length of the tailroom.
 904  */
 905 static inline uint16_t rte_pktmbuf_tailroom(const struct rte_mbuf *m)
 906 {
 907         __rte_mbuf_sanity_check(m, 1);
 908         return (uint16_t)(m->buf_len - rte_pktmbuf_headroom(m) -
 909                           m->data_len);
 910 }
 911
 912 /**
 913  * Get the last segment of the packet.
 914  *
 915  * @param m
 916  *   The packet mbuf.
 917  * @return
 918  *   The last segment of the given mbuf.
 919  */
 920 static inline struct rte_mbuf *rte_pktmbuf_lastseg(struct rte_mbuf *m)
 921 {
 922         struct rte_mbuf *m2 = (struct rte_mbuf *)m;
 923
 924         __rte_mbuf_sanity_check(m, 1);
 925         while (m2->next != NULL)
 926                 m2 = m2->next;
 927         return m2;
 928 }
 929
 930 /**
 931  * A macro that points to the start of the data in the mbuf.
 932  *
 933  * The returned pointer is cast to type t. Before using this
 934  * function, the user must ensure that m_headlen(m) is large enough to
 935  * read its data.
 936  *
 937  * @param m
 938  *   The packet mbuf.
 939  * @param t
 940  *   The type to cast the result into.
 941  */
 942 #define rte_pktmbuf_mtod(m, t) ((t)((char *)(m)->buf_addr + (m)->data_off))
 943
 944 /**
 945  * A macro that returns the length of the packet.
 946  *
 947  * The value can be read or assigned.
 948  *
 949  * @param m
 950  *   The packet mbuf.
 951  */
 952 #define rte_pktmbuf_pkt_len(m) ((m)->pkt_len)
 953
 954 /**
 955  * A macro that returns the length of the segment.
 956  *
 957  * The value can be read or assigned.
 958  *
 959  * @param m
 960  *   The packet mbuf.
 961  */
 962 #define rte_pktmbuf_data_len(m) ((m)->data_len)
 963
 964 /**
 965  * Prepend len bytes to an mbuf data area.
 966  *
 967  * Returns a pointer to the new
 968  * data start address. If there is not enough headroom in the first
 969  * segment, the function will return NULL, without modifying the mbuf.
 970  *
 971  * @param m
 972  *   The pkt mbuf.
 973  * @param len
 974  *   The amount of data to prepend (in bytes).
 975  * @return
 976  *   A pointer to the start of the newly prepended data, or
 977  *   NULL if there is not enough headroom space in the first segment
 978  */
 979 static inline char *rte_pktmbuf_prepend(struct rte_mbuf *m,
 980                                         uint16_t len)
 981 {
 982         __rte_mbuf_sanity_check(m, 1);
 983
 984         if (unlikely(len > rte_pktmbuf_headroom(m)))
 985                 return NULL;
 986
 987         m->data_off -= len;
 988         m->data_len = (uint16_t)(m->data_len + len);
 989         m->pkt_len  = (m->pkt_len + len);
 990
 991         return (char *)m->buf_addr + m->data_off;
 992 }
 993
 994 /**
 995  * Append len bytes to an mbuf.
 996  *
 997  * Append len bytes to an mbuf and return a pointer to the start address
 998  * of the added data. If there is not enough tailroom in the last
 999  * segment, the function will return NULL, without modifying the mbuf.
1000  *
1001  * @param m
1002  *   The packet mbuf.
1003  * @param len
1004  *   The amount of data to append (in bytes).
1005  * @return
1006  *   A pointer to the start of the newly appended data, or
1007  *   NULL if there is not enough tailroom space in the last segment
1008  */
1009 static inline char *rte_pktmbuf_append(struct rte_mbuf *m, uint16_t len)
1010 {
1011         void *tail;
1012         struct rte_mbuf *m_last;
1013
1014         __rte_mbuf_sanity_check(m, 1);
1015
1016         m_last = rte_pktmbuf_lastseg(m);
1017         if (unlikely(len > rte_pktmbuf_tailroom(m_last)))
1018                 return NULL;
1019
1020         tail = (char *)m_last->buf_addr + m_last->data_off + m_last->data_len;
1021         m_last->data_len = (uint16_t)(m_last->data_len + len);
1022         m->pkt_len  = (m->pkt_len + len);
1023         return (char*) tail;
1024 }
1025
1026 /**
1027  * Remove len bytes at the beginning of an mbuf.
1028  *
1029  * Returns a pointer to the start address of the new data area. If the
1030  * length is greater than the length of the first segment, then the
1031  * function will fail and return NULL, without modifying the mbuf.
1032  *
1033  * @param m
1034  *   The packet mbuf.
1035  * @param len
1036  *   The amount of data to remove (in bytes).
1037  * @return
1038  *   A pointer to the new start of the data.
1039  */
1040 static inline char *rte_pktmbuf_adj(struct rte_mbuf *m, uint16_t len)
1041 {
1042         __rte_mbuf_sanity_check(m, 1);
1043
1044         if (unlikely(len > m->data_len))
1045                 return NULL;
1046
1047         m->data_len = (uint16_t)(m->data_len - len);
1048         m->data_off += len;
1049         m->pkt_len  = (m->pkt_len - len);
1050         return (char *)m->buf_addr + m->data_off;
1051 }
1052
1053 /**
1054  * Remove len bytes of data at the end of the mbuf.
1055  *
1056  * If the length is greater than the length of the last segment, the
1057  * function will fail and return -1 without modifying the mbuf.
1058  *
1059  * @param m
1060  *   The packet mbuf.
1061  * @param len
1062  *   The amount of data to remove (in bytes).
1063  * @return
1064  *   - 0: On success.
1065  *   - -1: On error.
1066  */
1067 static inline int rte_pktmbuf_trim(struct rte_mbuf *m, uint16_t len)
1068 {
1069         struct rte_mbuf *m_last;
1070
1071         __rte_mbuf_sanity_check(m, 1);
1072
1073         m_last = rte_pktmbuf_lastseg(m);
1074         if (unlikely(len > m_last->data_len))
1075                 return -1;
1076
1077         m_last->data_len = (uint16_t)(m_last->data_len - len);
1078         m->pkt_len  = (m->pkt_len - len);
1079         return 0;
1080 }
1081
1082 /**
1083  * Test if mbuf data is contiguous.
1084  *
1085  * @param m
1086  *   The packet mbuf.
1087  * @return
1088  *   - 1, if all data is contiguous (one segment).
1089  *   - 0, if there is several segments.
1090  */
1091 static inline int rte_pktmbuf_is_contiguous(const struct rte_mbuf *m)
1092 {
1093         __rte_mbuf_sanity_check(m, 1);
1094         return !!(m->nb_segs == 1);
1095 }
1096
1097 /**
1098  * Dump an mbuf structure to the console.
1099  *
1100  * Dump all fields for the given packet mbuf and all its associated
1101  * segments (in the case of a chained buffer).
1102  *
1103  * @param f
1104  *   A pointer to a file for output
1105  * @param m
1106  *   The packet mbuf.
1107  * @param dump_len
1108  *   If dump_len != 0, also dump the "dump_len" first data bytes of
1109  *   the packet.
1110  */
1111 void rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len);
1112
1113 #ifdef __cplusplus
1114 }
1115 #endif
1116
1117 #endif /* _RTE_MBUF_H_ */