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