lib/librte_mbuf/rte_mbuf.h

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