lib/librte_mbuf/rte_mbuf.h

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