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         /* sequence number - field used in distributor and reorder library */
 292         uint32_t seqn;
 293
 294         /* second cache line - fields only used in slow path or on TX */
 295         MARKER cacheline1 __rte_cache_aligned;
 296
 297         union {
 298                 void *userdata;   /**< Can be used for external metadata */
 299                 uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */
 300         };
 301
 302         struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */
 303         struct rte_mbuf *next;    /**< Next segment of scattered packet. */
 304
 305         /* fields to support TX offloads */
 306         union {
 307                 uint64_t tx_offload;       /**< combined for easy fetch */
 308                 struct {
 309                         uint64_t l2_len:7; /**< L2 (MAC) Header Length. */
 310                         uint64_t l3_len:9; /**< L3 (IP) Header Length. */
 311                         uint64_t l4_len:8; /**< L4 (TCP/UDP) Header Length. */
 312                         uint64_t tso_segsz:16; /**< TCP TSO segment size */
 313
 314                         /* fields for TX offloading of tunnels */
 315                         uint64_t outer_l3_len:9; /**< Outer L3 (IP) Hdr Length. */
 316                         uint64_t outer_l2_len:7; /**< Outer L2 (MAC) Hdr Length. */
 317
 318                         /* uint64_t unused:8; */
 319                 };
 320         };
 321 } __rte_cache_aligned;
 322
 323 /**
 324  * Given the buf_addr returns the pointer to corresponding mbuf.
 325  */
 326 #define RTE_MBUF_FROM_BADDR(ba)     (((struct rte_mbuf *)(ba)) - 1)
 327
 328 /**
 329  * Given the pointer to mbuf returns an address where it's  buf_addr
 330  * should point to.
 331  */
 332 #define RTE_MBUF_TO_BADDR(mb)       (((struct rte_mbuf *)(mb)) + 1)
 333
 334 /**
 335  * Returns TRUE if given mbuf is indirect, or FALSE otherwise.
 336  */
 337 #define RTE_MBUF_INDIRECT(mb)   ((mb)->ol_flags & IND_ATTACHED_MBUF)
 338
 339 /**
 340  * Returns TRUE if given mbuf is direct, or FALSE otherwise.
 341  */
 342 #define RTE_MBUF_DIRECT(mb)     (!RTE_MBUF_INDIRECT(mb))
 343
 344 /**
 345  * Private data in case of pktmbuf pool.
 346  *
 347  * A structure that contains some pktmbuf_pool-specific data that are
 348  * appended after the mempool structure (in private data).
 349  */
 350 struct rte_pktmbuf_pool_private {
 351         uint16_t mbuf_data_room_size; /**< Size of data space in each mbuf.*/
 352 };
 353
 354 #ifdef RTE_LIBRTE_MBUF_DEBUG
 355
 356 /**  check mbuf type in debug mode */
 357 #define __rte_mbuf_sanity_check(m, is_h) rte_mbuf_sanity_check(m, is_h)
 358
 359 /**  check mbuf type in debug mode if mbuf pointer is not null */
 360 #define __rte_mbuf_sanity_check_raw(m, is_h)    do {       \
 361         if ((m) != NULL)                                   \
 362                 rte_mbuf_sanity_check(m, is_h);          \
 363 } while (0)
 364
 365 /**  MBUF asserts in debug mode */
 366 #define RTE_MBUF_ASSERT(exp)                                         \
 367 if (!(exp)) {                                                        \
 368         rte_panic("line%d\tassert \"" #exp "\" failed\n", __LINE__); \
 369 }
 370
 371 #else /*  RTE_LIBRTE_MBUF_DEBUG */
 372
 373 /**  check mbuf type in debug mode */
 374 #define __rte_mbuf_sanity_check(m, is_h) do { } while (0)
 375
 376 /**  check mbuf type in debug mode if mbuf pointer is not null */
 377 #define __rte_mbuf_sanity_check_raw(m, is_h) do { } while (0)
 378
 379 /**  MBUF asserts in debug mode */
 380 #define RTE_MBUF_ASSERT(exp)                do { } while (0)
 381
 382 #endif /*  RTE_LIBRTE_MBUF_DEBUG */
 383
 384 #ifdef RTE_MBUF_REFCNT_ATOMIC
 385
 386 /**
 387  * Adds given value to an mbuf's refcnt and returns its new value.
 388  * @param m
 389  *   Mbuf to update
 390  * @param value
 391  *   Value to add/subtract
 392  * @return
 393  *   Updated value
 394  */
 395 static inline uint16_t
 396 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
 397 {
 398         return (uint16_t)(rte_atomic16_add_return(&m->refcnt_atomic, value));
 399 }
 400
 401 /**
 402  * Reads the value of an mbuf's refcnt.
 403  * @param m
 404  *   Mbuf to read
 405  * @return
 406  *   Reference count number.
 407  */
 408 static inline uint16_t
 409 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
 410 {
 411         return (uint16_t)(rte_atomic16_read(&m->refcnt_atomic));
 412 }
 413
 414 /**
 415  * Sets an mbuf's refcnt to a defined value.
 416  * @param m
 417  *   Mbuf to update
 418  * @param new_value
 419  *   Value set
 420  */
 421 static inline void
 422 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
 423 {
 424         rte_atomic16_set(&m->refcnt_atomic, new_value);
 425 }
 426
 427 #else /* ! RTE_MBUF_REFCNT_ATOMIC */
 428
 429 /**
 430  * Adds given value to an mbuf's refcnt and returns its new value.
 431  */
 432 static inline uint16_t
 433 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
 434 {
 435         m->refcnt = (uint16_t)(m->refcnt + value);
 436         return m->refcnt;
 437 }
 438
 439 /**
 440  * Reads the value of an mbuf's refcnt.
 441  */
 442 static inline uint16_t
 443 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
 444 {
 445         return m->refcnt;
 446 }
 447
 448 /**
 449  * Sets an mbuf's refcnt to the defined value.
 450  */
 451 static inline void
 452 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
 453 {
 454         m->refcnt = new_value;
 455 }
 456
 457 #endif /* RTE_MBUF_REFCNT_ATOMIC */
 458
 459 /** Mbuf prefetch */
 460 #define RTE_MBUF_PREFETCH_TO_FREE(m) do {       \
 461         if ((m) != NULL)                        \
 462                 rte_prefetch0(m);               \
 463 } while (0)
 464
 465
 466 /**
 467  * Sanity checks on an mbuf.
 468  *
 469  * Check the consistency of the given mbuf. The function will cause a
 470  * panic if corruption is detected.
 471  *
 472  * @param m
 473  *   The mbuf to be checked.
 474  * @param is_header
 475  *   True if the mbuf is a packet header, false if it is a sub-segment
 476  *   of a packet (in this case, some fields like nb_segs are not checked)
 477  */
 478 void
 479 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header);
 480
 481 /**
 482  * @internal Allocate a new mbuf from mempool *mp*.
 483  * The use of that function is reserved for RTE internal needs.
 484  * Please use rte_pktmbuf_alloc().
 485  *
 486  * @param mp
 487  *   The mempool from which mbuf is allocated.
 488  * @return
 489  *   - The pointer to the new mbuf on success.
 490  *   - NULL if allocation failed.
 491  */
 492 static inline struct rte_mbuf *__rte_mbuf_raw_alloc(struct rte_mempool *mp)
 493 {
 494         struct rte_mbuf *m;
 495         void *mb = NULL;
 496         if (rte_mempool_get(mp, &mb) < 0)
 497                 return NULL;
 498         m = (struct rte_mbuf *)mb;
 499         RTE_MBUF_ASSERT(rte_mbuf_refcnt_read(m) == 0);
 500         rte_mbuf_refcnt_set(m, 1);
 501         return (m);
 502 }
 503
 504 /**
 505  * @internal Put mbuf back into its original mempool.
 506  * The use of that function is reserved for RTE internal needs.
 507  * Please use rte_pktmbuf_free().
 508  *
 509  * @param m
 510  *   The mbuf to be freed.
 511  */
 512 static inline void __attribute__((always_inline))
 513 __rte_mbuf_raw_free(struct rte_mbuf *m)
 514 {
 515         RTE_MBUF_ASSERT(rte_mbuf_refcnt_read(m) == 0);
 516         rte_mempool_put(m->pool, m);
 517 }
 518
 519 /* Operations on ctrl mbuf */
 520
 521 /**
 522  * The control mbuf constructor.
 523  *
 524  * This function initializes some fields in an mbuf structure that are
 525  * not modified by the user once created (mbuf type, origin pool, buffer
 526  * start address, and so on). This function is given as a callback function
 527  * to rte_mempool_create() at pool creation time.
 528  *
 529  * @param mp
 530  *   The mempool from which the mbuf is allocated.
 531  * @param opaque_arg
 532  *   A pointer that can be used by the user to retrieve useful information
 533  *   for mbuf initialization. This pointer comes from the ``init_arg``
 534  *   parameter of rte_mempool_create().
 535  * @param m
 536  *   The mbuf to initialize.
 537  * @param i
 538  *   The index of the mbuf in the pool table.
 539  */
 540 void rte_ctrlmbuf_init(struct rte_mempool *mp, void *opaque_arg,
 541                 void *m, unsigned i);
 542
 543 /**
 544  * Allocate a new mbuf (type is ctrl) from mempool *mp*.
 545  *
 546  * This new mbuf is initialized with data pointing to the beginning of
 547  * buffer, and with a length of zero.
 548  *
 549  * @param mp
 550  *   The mempool from which the mbuf is allocated.
 551  * @return
 552  *   - The pointer to the new mbuf on success.
 553  *   - NULL if allocation failed.
 554  */
 555 #define rte_ctrlmbuf_alloc(mp) rte_pktmbuf_alloc(mp)
 556
 557 /**
 558  * Free a control mbuf back into its original mempool.
 559  *
 560  * @param m
 561  *   The control mbuf to be freed.
 562  */
 563 #define rte_ctrlmbuf_free(m) rte_pktmbuf_free(m)
 564
 565 /**
 566  * A macro that returns the pointer to the carried data.
 567  *
 568  * The value that can be read or assigned.
 569  *
 570  * @param m
 571  *   The control mbuf.
 572  */
 573 #define rte_ctrlmbuf_data(m) ((char *)((m)->buf_addr) + (m)->data_off)
 574
 575 /**
 576  * A macro that returns the length of the carried data.
 577  *
 578  * The value that can be read or assigned.
 579  *
 580  * @param m
 581  *   The control mbuf.
 582  */
 583 #define rte_ctrlmbuf_len(m) rte_pktmbuf_data_len(m)
 584
 585 /**
 586  * Tests if an mbuf is a control mbuf
 587  *
 588  * @param m
 589  *   The mbuf to be tested
 590  * @return
 591  *   - True (1) if the mbuf is a control mbuf
 592  *   - False(0) otherwise
 593  */
 594 static inline int
 595 rte_is_ctrlmbuf(struct rte_mbuf *m)
 596 {
 597         return (!!(m->ol_flags & CTRL_MBUF_FLAG));
 598 }
 599
 600 /* Operations on pkt mbuf */
 601
 602 /**
 603  * The packet mbuf constructor.
 604  *
 605  * This function initializes some fields in the mbuf structure that are
 606  * not modified by the user once created (origin pool, buffer start
 607  * address, and so on). This function is given as a callback function to
 608  * rte_mempool_create() at pool creation time.
 609  *
 610  * @param mp
 611  *   The mempool from which mbufs originate.
 612  * @param opaque_arg
 613  *   A pointer that can be used by the user to retrieve useful information
 614  *   for mbuf initialization. This pointer comes from the ``init_arg``
 615  *   parameter of rte_mempool_create().
 616  * @param m
 617  *   The mbuf to initialize.
 618  * @param i
 619  *   The index of the mbuf in the pool table.
 620  */
 621 void rte_pktmbuf_init(struct rte_mempool *mp, void *opaque_arg,
 622                       void *m, unsigned i);
 623
 624
 625 /**
 626  * A  packet mbuf pool constructor.
 627  *
 628  * This function initializes the mempool private data in the case of a
 629  * pktmbuf pool. This private data is needed by the driver. The
 630  * function is given as a callback function to rte_mempool_create() at
 631  * pool creation. It can be extended by the user, for example, to
 632  * provide another packet size.
 633  *
 634  * @param mp
 635  *   The mempool from which mbufs originate.
 636  * @param opaque_arg
 637  *   A pointer that can be used by the user to retrieve useful information
 638  *   for mbuf initialization. This pointer comes from the ``init_arg``
 639  *   parameter of rte_mempool_create().
 640  */
 641 void rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg);
 642
 643 /**
 644  * Reset the fields of a packet mbuf to their default values.
 645  *
 646  * The given mbuf must have only one segment.
 647  *
 648  * @param m
 649  *   The packet mbuf to be resetted.
 650  */
 651 static inline void rte_pktmbuf_reset(struct rte_mbuf *m)
 652 {
 653         m->next = NULL;
 654         m->pkt_len = 0;
 655         m->tx_offload = 0;
 656         m->vlan_tci = 0;
 657         m->nb_segs = 1;
 658         m->port = 0xff;
 659
 660         m->ol_flags = 0;
 661         m->packet_type = 0;
 662         m->data_off = (RTE_PKTMBUF_HEADROOM <= m->buf_len) ?
 663                         RTE_PKTMBUF_HEADROOM : m->buf_len;
 664
 665         m->data_len = 0;
 666         __rte_mbuf_sanity_check(m, 1);
 667 }
 668
 669 /**
 670  * Allocate a new mbuf from a mempool.
 671  *
 672  * This new mbuf contains one segment, which has a length of 0. The pointer
 673  * to data is initialized to have some bytes of headroom in the buffer
 674  * (if buffer size allows).
 675  *
 676  * @param mp
 677  *   The mempool from which the mbuf is allocated.
 678  * @return
 679  *   - The pointer to the new mbuf on success.
 680  *   - NULL if allocation failed.
 681  */
 682 static inline struct rte_mbuf *rte_pktmbuf_alloc(struct rte_mempool *mp)
 683 {
 684         struct rte_mbuf *m;
 685         if ((m = __rte_mbuf_raw_alloc(mp)) != NULL)
 686                 rte_pktmbuf_reset(m);
 687         return (m);
 688 }
 689
 690 /**
 691  * Attach packet mbuf to another packet mbuf.
 692  * After attachment we refer the mbuf we attached as 'indirect',
 693  * while mbuf we attached to as 'direct'.
 694  * Right now, not supported:
 695  *  - attachment to indirect mbuf (e.g. - md  has to be direct).
 696  *  - attachment for already indirect mbuf (e.g. - mi has to be direct).
 697  *  - mbuf we trying to attach (mi) is used by someone else
 698  *    e.g. it's reference counter is greater then 1.
 699  *
 700  * @param mi
 701  *   The indirect packet mbuf.
 702  * @param md
 703  *   The direct packet mbuf.
 704  */
 705
 706 static inline void rte_pktmbuf_attach(struct rte_mbuf *mi, struct rte_mbuf *md)
 707 {
 708         RTE_MBUF_ASSERT(RTE_MBUF_DIRECT(md) &&
 709             RTE_MBUF_DIRECT(mi) &&
 710             rte_mbuf_refcnt_read(mi) == 1);
 711
 712         rte_mbuf_refcnt_update(md, 1);
 713         mi->buf_physaddr = md->buf_physaddr;
 714         mi->buf_addr = md->buf_addr;
 715         mi->buf_len = md->buf_len;
 716
 717         mi->next = md->next;
 718         mi->data_off = md->data_off;
 719         mi->data_len = md->data_len;
 720         mi->port = md->port;
 721         mi->vlan_tci = md->vlan_tci;
 722         mi->tx_offload = md->tx_offload;
 723         mi->hash = md->hash;
 724
 725         mi->next = NULL;
 726         mi->pkt_len = mi->data_len;
 727         mi->nb_segs = 1;
 728         mi->ol_flags = md->ol_flags | IND_ATTACHED_MBUF;
 729         mi->packet_type = md->packet_type;
 730
 731         __rte_mbuf_sanity_check(mi, 1);
 732         __rte_mbuf_sanity_check(md, 0);
 733 }
 734
 735 /**
 736  * Detach an indirect packet mbuf -
 737  *  - restore original mbuf address and length values.
 738  *  - reset pktmbuf data and data_len to their default values.
 739  *  All other fields of the given packet mbuf will be left intact.
 740  *
 741  * @param m
 742  *   The indirect attached packet mbuf.
 743  */
 744
 745 static inline void rte_pktmbuf_detach(struct rte_mbuf *m)
 746 {
 747         const struct rte_mempool *mp = m->pool;
 748         void *buf = RTE_MBUF_TO_BADDR(m);
 749         uint32_t buf_len = mp->elt_size - sizeof(*m);
 750         m->buf_physaddr = rte_mempool_virt2phy(mp, m) + sizeof (*m);
 751
 752         m->buf_addr = buf;
 753         m->buf_len = (uint16_t)buf_len;
 754
 755         m->data_off = (RTE_PKTMBUF_HEADROOM <= m->buf_len) ?
 756                         RTE_PKTMBUF_HEADROOM : m->buf_len;
 757
 758         m->data_len = 0;
 759
 760         m->ol_flags = 0;
 761 }
 762
 763 static inline struct rte_mbuf* __attribute__((always_inline))
 764 __rte_pktmbuf_prefree_seg(struct rte_mbuf *m)
 765 {
 766         __rte_mbuf_sanity_check(m, 0);
 767
 768         if (likely (rte_mbuf_refcnt_read(m) == 1) ||
 769                         likely (rte_mbuf_refcnt_update(m, -1) == 0)) {
 770
 771                 rte_mbuf_refcnt_set(m, 0);
 772
 773                 /* if this is an indirect mbuf, then
 774                  *  - detach mbuf
 775                  *  - free attached mbuf segment
 776                  */
 777                 if (RTE_MBUF_INDIRECT(m)) {
 778                         struct rte_mbuf *md = RTE_MBUF_FROM_BADDR(m->buf_addr);
 779                         rte_pktmbuf_detach(m);
 780                         if (rte_mbuf_refcnt_update(md, -1) == 0)
 781                                 __rte_mbuf_raw_free(md);
 782                 }
 783                 return(m);
 784         }
 785         return (NULL);
 786 }
 787
 788 /**
 789  * Free a segment of a packet mbuf into its original mempool.
 790  *
 791  * Free an mbuf, without parsing other segments in case of chained
 792  * buffers.
 793  *
 794  * @param m
 795  *   The packet mbuf segment to be freed.
 796  */
 797 static inline void __attribute__((always_inline))
 798 rte_pktmbuf_free_seg(struct rte_mbuf *m)
 799 {
 800         if (likely(NULL != (m = __rte_pktmbuf_prefree_seg(m)))) {
 801                 m->next = NULL;
 802                 __rte_mbuf_raw_free(m);
 803         }
 804 }
 805
 806 /**
 807  * Free a packet mbuf back into its original mempool.
 808  *
 809  * Free an mbuf, and all its segments in case of chained buffers. Each
 810  * segment is added back into its original mempool.
 811  *
 812  * @param m
 813  *   The packet mbuf to be freed.
 814  */
 815 static inline void rte_pktmbuf_free(struct rte_mbuf *m)
 816 {
 817         struct rte_mbuf *m_next;
 818
 819         __rte_mbuf_sanity_check(m, 1);
 820
 821         while (m != NULL) {
 822                 m_next = m->next;
 823                 rte_pktmbuf_free_seg(m);
 824                 m = m_next;
 825         }
 826 }
 827
 828 /**
 829  * Creates a "clone" of the given packet mbuf.
 830  *
 831  * Walks through all segments of the given packet mbuf, and for each of them:
 832  *  - Creates a new packet mbuf from the given pool.
 833  *  - Attaches newly created mbuf to the segment.
 834  * Then updates pkt_len and nb_segs of the "clone" packet mbuf to match values
 835  * from the original packet mbuf.
 836  *
 837  * @param md
 838  *   The packet mbuf to be cloned.
 839  * @param mp
 840  *   The mempool from which the "clone" mbufs are allocated.
 841  * @return
 842  *   - The pointer to the new "clone" mbuf on success.
 843  *   - NULL if allocation fails.
 844  */
 845 static inline struct rte_mbuf *rte_pktmbuf_clone(struct rte_mbuf *md,
 846                 struct rte_mempool *mp)
 847 {
 848         struct rte_mbuf *mc, *mi, **prev;
 849         uint32_t pktlen;
 850         uint8_t nseg;
 851
 852         if (unlikely ((mc = rte_pktmbuf_alloc(mp)) == NULL))
 853                 return (NULL);
 854
 855         mi = mc;
 856         prev = &mi->next;
 857         pktlen = md->pkt_len;
 858         nseg = 0;
 859
 860         do {
 861                 nseg++;
 862                 rte_pktmbuf_attach(mi, md);
 863                 *prev = mi;
 864                 prev = &mi->next;
 865         } while ((md = md->next) != NULL &&
 866             (mi = rte_pktmbuf_alloc(mp)) != NULL);
 867
 868         *prev = NULL;
 869         mc->nb_segs = nseg;
 870         mc->pkt_len = pktlen;
 871
 872         /* Allocation of new indirect segment failed */
 873         if (unlikely (mi == NULL)) {
 874                 rte_pktmbuf_free(mc);
 875                 return (NULL);
 876         }
 877
 878         __rte_mbuf_sanity_check(mc, 1);
 879         return (mc);
 880 }
 881
 882 /**
 883  * Adds given value to the refcnt of all packet mbuf segments.
 884  *
 885  * Walks through all segments of given packet mbuf and for each of them
 886  * invokes rte_mbuf_refcnt_update().
 887  *
 888  * @param m
 889  *   The packet mbuf whose refcnt to be updated.
 890  * @param v
 891  *   The value to add to the mbuf's segments refcnt.
 892  */
 893 static inline void rte_pktmbuf_refcnt_update(struct rte_mbuf *m, int16_t v)
 894 {
 895         __rte_mbuf_sanity_check(m, 1);
 896
 897         do {
 898                 rte_mbuf_refcnt_update(m, v);
 899         } while ((m = m->next) != NULL);
 900 }
 901
 902 /**
 903  * Get the headroom in a packet mbuf.
 904  *
 905  * @param m
 906  *   The packet mbuf.
 907  * @return
 908  *   The length of the headroom.
 909  */
 910 static inline uint16_t rte_pktmbuf_headroom(const struct rte_mbuf *m)
 911 {
 912         __rte_mbuf_sanity_check(m, 1);
 913         return m->data_off;
 914 }
 915
 916 /**
 917  * Get the tailroom of a packet mbuf.
 918  *
 919  * @param m
 920  *   The packet mbuf.
 921  * @return
 922  *   The length of the tailroom.
 923  */
 924 static inline uint16_t rte_pktmbuf_tailroom(const struct rte_mbuf *m)
 925 {
 926         __rte_mbuf_sanity_check(m, 1);
 927         return (uint16_t)(m->buf_len - rte_pktmbuf_headroom(m) -
 928                           m->data_len);
 929 }
 930
 931 /**
 932  * Get the last segment of the packet.
 933  *
 934  * @param m
 935  *   The packet mbuf.
 936  * @return
 937  *   The last segment of the given mbuf.
 938  */
 939 static inline struct rte_mbuf *rte_pktmbuf_lastseg(struct rte_mbuf *m)
 940 {
 941         struct rte_mbuf *m2 = (struct rte_mbuf *)m;
 942
 943         __rte_mbuf_sanity_check(m, 1);
 944         while (m2->next != NULL)
 945                 m2 = m2->next;
 946         return m2;
 947 }
 948
 949 /**
 950  * A macro that points to the start of the data in the mbuf.
 951  *
 952  * The returned pointer is cast to type t. Before using this
 953  * function, the user must ensure that m_headlen(m) is large enough to
 954  * read its data.
 955  *
 956  * @param m
 957  *   The packet mbuf.
 958  * @param t
 959  *   The type to cast the result into.
 960  */
 961 #define rte_pktmbuf_mtod(m, t) ((t)((char *)(m)->buf_addr + (m)->data_off))
 962
 963 /**
 964  * A macro that returns the length of the packet.
 965  *
 966  * The value can be read or assigned.
 967  *
 968  * @param m
 969  *   The packet mbuf.
 970  */
 971 #define rte_pktmbuf_pkt_len(m) ((m)->pkt_len)
 972
 973 /**
 974  * A macro that returns the length of the segment.
 975  *
 976  * The value can be read or assigned.
 977  *
 978  * @param m
 979  *   The packet mbuf.
 980  */
 981 #define rte_pktmbuf_data_len(m) ((m)->data_len)
 982
 983 /**
 984  * Prepend len bytes to an mbuf data area.
 985  *
 986  * Returns a pointer to the new
 987  * data start address. If there is not enough headroom in the first
 988  * segment, the function will return NULL, without modifying the mbuf.
 989  *
 990  * @param m
 991  *   The pkt mbuf.
 992  * @param len
 993  *   The amount of data to prepend (in bytes).
 994  * @return
 995  *   A pointer to the start of the newly prepended data, or
 996  *   NULL if there is not enough headroom space in the first segment
 997  */
 998 static inline char *rte_pktmbuf_prepend(struct rte_mbuf *m,
 999                                         uint16_t len)
1000 {
1001         __rte_mbuf_sanity_check(m, 1);
1002
1003         if (unlikely(len > rte_pktmbuf_headroom(m)))
1004                 return NULL;
1005
1006         m->data_off -= len;
1007         m->data_len = (uint16_t)(m->data_len + len);
1008         m->pkt_len  = (m->pkt_len + len);
1009
1010         return (char *)m->buf_addr + m->data_off;
1011 }
1012
1013 /**
1014  * Append len bytes to an mbuf.
1015  *
1016  * Append len bytes to an mbuf and return a pointer to the start address
1017  * of the added data. If there is not enough tailroom in the last
1018  * segment, the function will return NULL, without modifying the mbuf.
1019  *
1020  * @param m
1021  *   The packet mbuf.
1022  * @param len
1023  *   The amount of data to append (in bytes).
1024  * @return
1025  *   A pointer to the start of the newly appended data, or
1026  *   NULL if there is not enough tailroom space in the last segment
1027  */
1028 static inline char *rte_pktmbuf_append(struct rte_mbuf *m, uint16_t len)
1029 {
1030         void *tail;
1031         struct rte_mbuf *m_last;
1032
1033         __rte_mbuf_sanity_check(m, 1);
1034
1035         m_last = rte_pktmbuf_lastseg(m);
1036         if (unlikely(len > rte_pktmbuf_tailroom(m_last)))
1037                 return NULL;
1038
1039         tail = (char *)m_last->buf_addr + m_last->data_off + m_last->data_len;
1040         m_last->data_len = (uint16_t)(m_last->data_len + len);
1041         m->pkt_len  = (m->pkt_len + len);
1042         return (char*) tail;
1043 }
1044
1045 /**
1046  * Remove len bytes at the beginning of an mbuf.
1047  *
1048  * Returns a pointer to the start address of the new data area. If the
1049  * length is greater than the length of the first segment, then the
1050  * function will fail and return NULL, without modifying the mbuf.
1051  *
1052  * @param m
1053  *   The packet mbuf.
1054  * @param len
1055  *   The amount of data to remove (in bytes).
1056  * @return
1057  *   A pointer to the new start of the data.
1058  */
1059 static inline char *rte_pktmbuf_adj(struct rte_mbuf *m, uint16_t len)
1060 {
1061         __rte_mbuf_sanity_check(m, 1);
1062
1063         if (unlikely(len > m->data_len))
1064                 return NULL;
1065
1066         m->data_len = (uint16_t)(m->data_len - len);
1067         m->data_off += len;
1068         m->pkt_len  = (m->pkt_len - len);
1069         return (char *)m->buf_addr + m->data_off;
1070 }
1071
1072 /**
1073  * Remove len bytes of data at the end of the mbuf.
1074  *
1075  * If the length is greater than the length of the last segment, the
1076  * function will fail and return -1 without modifying the mbuf.
1077  *
1078  * @param m
1079  *   The packet mbuf.
1080  * @param len
1081  *   The amount of data to remove (in bytes).
1082  * @return
1083  *   - 0: On success.
1084  *   - -1: On error.
1085  */
1086 static inline int rte_pktmbuf_trim(struct rte_mbuf *m, uint16_t len)
1087 {
1088         struct rte_mbuf *m_last;
1089
1090         __rte_mbuf_sanity_check(m, 1);
1091
1092         m_last = rte_pktmbuf_lastseg(m);
1093         if (unlikely(len > m_last->data_len))
1094                 return -1;
1095
1096         m_last->data_len = (uint16_t)(m_last->data_len - len);
1097         m->pkt_len  = (m->pkt_len - len);
1098         return 0;
1099 }
1100
1101 /**
1102  * Test if mbuf data is contiguous.
1103  *
1104  * @param m
1105  *   The packet mbuf.
1106  * @return
1107  *   - 1, if all data is contiguous (one segment).
1108  *   - 0, if there is several segments.
1109  */
1110 static inline int rte_pktmbuf_is_contiguous(const struct rte_mbuf *m)
1111 {
1112         __rte_mbuf_sanity_check(m, 1);
1113         return !!(m->nb_segs == 1);
1114 }
1115
1116 /**
1117  * Dump an mbuf structure to the console.
1118  *
1119  * Dump all fields for the given packet mbuf and all its associated
1120  * segments (in the case of a chained buffer).
1121  *
1122  * @param f
1123  *   A pointer to a file for output
1124  * @param m
1125  *   The packet mbuf.
1126  * @param dump_len
1127  *   If dump_len != 0, also dump the "dump_len" first data bytes of
1128  *   the packet.
1129  */
1130 void rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len);
1131
1132 #ifdef __cplusplus
1133 }
1134 #endif
1135
1136 #endif /* _RTE_MBUF_H_ */