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