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