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