lib/librte_ring/rte_ring.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 /*
  35  * Derived from FreeBSD's bufring.h
  36  *
  37  **************************************************************************
  38  *
  39  * Copyright (c) 2007-2009 Kip Macy kmacy@freebsd.org
  40  * All rights reserved.
  41  *
  42  * Redistribution and use in source and binary forms, with or without
  43  * modification, are permitted provided that the following conditions are met:
  44  *
  45  * 1. Redistributions of source code must retain the above copyright notice,
  46  *    this list of conditions and the following disclaimer.
  47  *
  48  * 2. The name of Kip Macy nor the names of other
  49  *    contributors may be used to endorse or promote products derived from
  50  *    this software without specific prior written permission.
  51  *
  52  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  53  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  54  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  55  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  56  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  57  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  58  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  59  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  60  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  61  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  62  * POSSIBILITY OF SUCH DAMAGE.
  63  *
  64  ***************************************************************************/
  65
  66 #ifndef _RTE_RING_H_
  67 #define _RTE_RING_H_
  68
  69 /**
  70  * @file
  71  * RTE Ring
  72  *
  73  * The Ring Manager is a fixed-size queue, implemented as a table of
  74  * pointers. Head and tail pointers are modified atomically, allowing
  75  * concurrent access to it. It has the following features:
  76  *
  77  * - FIFO (First In First Out)
  78  * - Maximum size is fixed; the pointers are stored in a table.
  79  * - Lockless implementation.
  80  * - Multi- or single-consumer dequeue.
  81  * - Multi- or single-producer enqueue.
  82  * - Bulk dequeue.
  83  * - Bulk enqueue.
  84  *
  85  * Note: the ring implementation is not preemptable. A lcore must not
  86  * be interrupted by another task that uses the same ring.
  87  *
  88  */
  89
  90 #ifdef __cplusplus
  91 extern "C" {
  92 #endif
  93
  94 #include <stdio.h>
  95 #include <stdint.h>
  96 #include <sys/queue.h>
  97 #include <errno.h>
  98 #include <rte_common.h>
  99 #include <rte_memory.h>
 100 #include <rte_lcore.h>
 101 #include <rte_atomic.h>
 102 #include <rte_branch_prediction.h>
 103
 104 #define RTE_TAILQ_RING_NAME "RTE_RING"
 105
 106 enum rte_ring_queue_behavior {
 107         RTE_RING_QUEUE_FIXED = 0, /* Enq/Deq a fixed number of items from a ring */
 108         RTE_RING_QUEUE_VARIABLE   /* Enq/Deq as many items a possible from ring */
 109 };
 110
 111 #ifdef RTE_LIBRTE_RING_DEBUG
 112 /**
 113  * A structure that stores the ring statistics (per-lcore).
 114  */
 115 struct rte_ring_debug_stats {
 116         uint64_t enq_success_bulk; /**< Successful enqueues number. */
 117         uint64_t enq_success_objs; /**< Objects successfully enqueued. */
 118         uint64_t enq_quota_bulk;   /**< Successful enqueues above watermark. */
 119         uint64_t enq_quota_objs;   /**< Objects enqueued above watermark. */
 120         uint64_t enq_fail_bulk;    /**< Failed enqueues number. */
 121         uint64_t enq_fail_objs;    /**< Objects that failed to be enqueued. */
 122         uint64_t deq_success_bulk; /**< Successful dequeues number. */
 123         uint64_t deq_success_objs; /**< Objects successfully dequeued. */
 124         uint64_t deq_fail_bulk;    /**< Failed dequeues number. */
 125         uint64_t deq_fail_objs;    /**< Objects that failed to be dequeued. */
 126 } __rte_cache_aligned;
 127 #endif
 128
 129 #define RTE_RING_NAMESIZE 32 /**< The maximum length of a ring name. */
 130 #define RTE_RING_MZ_PREFIX "RG_"
 131
 132 #ifndef RTE_RING_PAUSE_REP_COUNT
 133 #define RTE_RING_PAUSE_REP_COUNT 0 /**< Yield after pause num of times, no yield
 134                                     *   if RTE_RING_PAUSE_REP not defined. */
 135 #endif
 136
 137 struct rte_memzone; /* forward declaration, so as not to require memzone.h */
 138
 139 /**
 140  * An RTE ring structure.
 141  *
 142  * The producer and the consumer have a head and a tail index. The particularity
 143  * of these index is that they are not between 0 and size(ring). These indexes
 144  * are between 0 and 2^32, and we mask their value when we access the ring[]
 145  * field. Thanks to this assumption, we can do subtractions between 2 index
 146  * values in a modulo-32bit base: that's why the overflow of the indexes is not
 147  * a problem.
 148  */
 149 struct rte_ring {
 150         char name[RTE_RING_NAMESIZE];    /**< Name of the ring. */
 151         int flags;                       /**< Flags supplied at creation. */
 152         const struct rte_memzone *memzone;
 153                         /**< Memzone, if any, containing the rte_ring */
 154
 155         /** Ring producer status. */
 156         struct prod {
 157                 uint32_t watermark;      /**< Maximum items before EDQUOT. */
 158                 uint32_t sp_enqueue;     /**< True, if single producer. */
 159                 uint32_t size;           /**< Size of ring. */
 160                 uint32_t mask;           /**< Mask (size-1) of ring. */
 161                 volatile uint32_t head;  /**< Producer head. */
 162                 volatile uint32_t tail;  /**< Producer tail. */
 163         } prod __rte_cache_aligned;
 164
 165         /** Ring consumer status. */
 166         struct cons {
 167                 uint32_t sc_dequeue;     /**< True, if single consumer. */
 168                 uint32_t size;           /**< Size of the ring. */
 169                 uint32_t mask;           /**< Mask (size-1) of ring. */
 170                 volatile uint32_t head;  /**< Consumer head. */
 171                 volatile uint32_t tail;  /**< Consumer tail. */
 172 #ifdef RTE_RING_SPLIT_PROD_CONS
 173         } cons __rte_cache_aligned;
 174 #else
 175         } cons;
 176 #endif
 177
 178 #ifdef RTE_LIBRTE_RING_DEBUG
 179         struct rte_ring_debug_stats stats[RTE_MAX_LCORE];
 180 #endif
 181
 182         void * ring[0] __rte_cache_aligned; /**< Memory space of ring starts here.
 183                                              * not volatile so need to be careful
 184                                              * about compiler re-ordering */
 185 };
 186
 187 #define RING_F_SP_ENQ 0x0001 /**< The default enqueue is "single-producer". */
 188 #define RING_F_SC_DEQ 0x0002 /**< The default dequeue is "single-consumer". */
 189 #define RTE_RING_QUOT_EXCEED (1 << 31)  /**< Quota exceed for burst ops */
 190 #define RTE_RING_SZ_MASK  (unsigned)(0x0fffffff) /**< Ring size mask */
 191
 192 /**
 193  * @internal When debug is enabled, store ring statistics.
 194  * @param r
 195  *   A pointer to the ring.
 196  * @param name
 197  *   The name of the statistics field to increment in the ring.
 198  * @param n
 199  *   The number to add to the object-oriented statistics.
 200  */
 201 #ifdef RTE_LIBRTE_RING_DEBUG
 202 #define __RING_STAT_ADD(r, name, n) do {                        \
 203                 unsigned __lcore_id = rte_lcore_id();           \
 204                 if (__lcore_id < RTE_MAX_LCORE) {               \
 205                         r->stats[__lcore_id].name##_objs += n;  \
 206                         r->stats[__lcore_id].name##_bulk += 1;  \
 207                 }                                               \
 208         } while(0)
 209 #else
 210 #define __RING_STAT_ADD(r, name, n) do {} while(0)
 211 #endif
 212
 213 /**
 214  * Calculate the memory size needed for a ring
 215  *
 216  * This function returns the number of bytes needed for a ring, given
 217  * the number of elements in it. This value is the sum of the size of
 218  * the structure rte_ring and the size of the memory needed by the
 219  * objects pointers. The value is aligned to a cache line size.
 220  *
 221  * @param count
 222  *   The number of elements in the ring (must be a power of 2).
 223  * @return
 224  *   - The memory size needed for the ring on success.
 225  *   - -EINVAL if count is not a power of 2.
 226  */
 227 ssize_t rte_ring_get_memsize(unsigned count);
 228
 229 /**
 230  * Initialize a ring structure.
 231  *
 232  * Initialize a ring structure in memory pointed by "r". The size of the
 233  * memory area must be large enough to store the ring structure and the
 234  * object table. It is advised to use rte_ring_get_memsize() to get the
 235  * appropriate size.
 236  *
 237  * The ring size is set to *count*, which must be a power of two. Water
 238  * marking is disabled by default. The real usable ring size is
 239  * *count-1* instead of *count* to differentiate a free ring from an
 240  * empty ring.
 241  *
 242  * The ring is not added in RTE_TAILQ_RING global list. Indeed, the
 243  * memory given by the caller may not be shareable among dpdk
 244  * processes.
 245  *
 246  * @param r
 247  *   The pointer to the ring structure followed by the objects table.
 248  * @param name
 249  *   The name of the ring.
 250  * @param count
 251  *   The number of elements in the ring (must be a power of 2).
 252  * @param flags
 253  *   An OR of the following:
 254  *    - RING_F_SP_ENQ: If this flag is set, the default behavior when
 255  *      using ``rte_ring_enqueue()`` or ``rte_ring_enqueue_bulk()``
 256  *      is "single-producer". Otherwise, it is "multi-producers".
 257  *    - RING_F_SC_DEQ: If this flag is set, the default behavior when
 258  *      using ``rte_ring_dequeue()`` or ``rte_ring_dequeue_bulk()``
 259  *      is "single-consumer". Otherwise, it is "multi-consumers".
 260  * @return
 261  *   0 on success, or a negative value on error.
 262  */
 263 int rte_ring_init(struct rte_ring *r, const char *name, unsigned count,
 264         unsigned flags);
 265
 266 /**
 267  * Create a new ring named *name* in memory.
 268  *
 269  * This function uses ``memzone_reserve()`` to allocate memory. Then it
 270  * calls rte_ring_init() to initialize an empty ring.
 271  *
 272  * The new ring size is set to *count*, which must be a power of
 273  * two. Water marking is disabled by default. The real usable ring size
 274  * is *count-1* instead of *count* to differentiate a free ring from an
 275  * empty ring.
 276  *
 277  * The ring is added in RTE_TAILQ_RING list.
 278  *
 279  * @param name
 280  *   The name of the ring.
 281  * @param count
 282  *   The size of the ring (must be a power of 2).
 283  * @param socket_id
 284  *   The *socket_id* argument is the socket identifier in case of
 285  *   NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
 286  *   constraint for the reserved zone.
 287  * @param flags
 288  *   An OR of the following:
 289  *    - RING_F_SP_ENQ: If this flag is set, the default behavior when
 290  *      using ``rte_ring_enqueue()`` or ``rte_ring_enqueue_bulk()``
 291  *      is "single-producer". Otherwise, it is "multi-producers".
 292  *    - RING_F_SC_DEQ: If this flag is set, the default behavior when
 293  *      using ``rte_ring_dequeue()`` or ``rte_ring_dequeue_bulk()``
 294  *      is "single-consumer". Otherwise, it is "multi-consumers".
 295  * @return
 296  *   On success, the pointer to the new allocated ring. NULL on error with
 297  *    rte_errno set appropriately. Possible errno values include:
 298  *    - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
 299  *    - E_RTE_SECONDARY - function was called from a secondary process instance
 300  *    - EINVAL - count provided is not a power of 2
 301  *    - ENOSPC - the maximum number of memzones has already been allocated
 302  *    - EEXIST - a memzone with the same name already exists
 303  *    - ENOMEM - no appropriate memory area found in which to create memzone
 304  */
 305 struct rte_ring *rte_ring_create(const char *name, unsigned count,
 306                                  int socket_id, unsigned flags);
 307 /**
 308  * De-allocate all memory used by the ring.
 309  *
 310  * @param r
 311  *   Ring to free
 312  */
 313 void rte_ring_free(struct rte_ring *r);
 314
 315 /**
 316  * Change the high water mark.
 317  *
 318  * If *count* is 0, water marking is disabled. Otherwise, it is set to the
 319  * *count* value. The *count* value must be greater than 0 and less
 320  * than the ring size.
 321  *
 322  * This function can be called at any time (not necessarily at
 323  * initialization).
 324  *
 325  * @param r
 326  *   A pointer to the ring structure.
 327  * @param count
 328  *   The new water mark value.
 329  * @return
 330  *   - 0: Success; water mark changed.
 331  *   - -EINVAL: Invalid water mark value.
 332  */
 333 int rte_ring_set_water_mark(struct rte_ring *r, unsigned count);
 334
 335 /**
 336  * Dump the status of the ring to the console.
 337  *
 338  * @param f
 339  *   A pointer to a file for output
 340  * @param r
 341  *   A pointer to the ring structure.
 342  */
 343 void rte_ring_dump(FILE *f, const struct rte_ring *r);
 344
 345 /* the actual enqueue of pointers on the ring.
 346  * Placed here since identical code needed in both
 347  * single and multi producer enqueue functions */
 348 #define ENQUEUE_PTRS() do { \
 349         const uint32_t size = r->prod.size; \
 350         uint32_t idx = prod_head & mask; \
 351         if (likely(idx + n < size)) { \
 352                 for (i = 0; i < (n & ((~(unsigned)0x3))); i+=4, idx+=4) { \
 353                         r->ring[idx] = obj_table[i]; \
 354                         r->ring[idx+1] = obj_table[i+1]; \
 355                         r->ring[idx+2] = obj_table[i+2]; \
 356                         r->ring[idx+3] = obj_table[i+3]; \
 357                 } \
 358                 switch (n & 0x3) { \
 359                         case 3: r->ring[idx++] = obj_table[i++]; \
 360                         case 2: r->ring[idx++] = obj_table[i++]; \
 361                         case 1: r->ring[idx++] = obj_table[i++]; \
 362                 } \
 363         } else { \
 364                 for (i = 0; idx < size; i++, idx++)\
 365                         r->ring[idx] = obj_table[i]; \
 366                 for (idx = 0; i < n; i++, idx++) \
 367                         r->ring[idx] = obj_table[i]; \
 368         } \
 369 } while(0)
 370
 371 /* the actual copy of pointers on the ring to obj_table.
 372  * Placed here since identical code needed in both
 373  * single and multi consumer dequeue functions */
 374 #define DEQUEUE_PTRS() do { \
 375         uint32_t idx = cons_head & mask; \
 376         const uint32_t size = r->cons.size; \
 377         if (likely(idx + n < size)) { \
 378                 for (i = 0; i < (n & (~(unsigned)0x3)); i+=4, idx+=4) {\
 379                         obj_table[i] = r->ring[idx]; \
 380                         obj_table[i+1] = r->ring[idx+1]; \
 381                         obj_table[i+2] = r->ring[idx+2]; \
 382                         obj_table[i+3] = r->ring[idx+3]; \
 383                 } \
 384                 switch (n & 0x3) { \
 385                         case 3: obj_table[i++] = r->ring[idx++]; \
 386                         case 2: obj_table[i++] = r->ring[idx++]; \
 387                         case 1: obj_table[i++] = r->ring[idx++]; \
 388                 } \
 389         } else { \
 390                 for (i = 0; idx < size; i++, idx++) \
 391                         obj_table[i] = r->ring[idx]; \
 392                 for (idx = 0; i < n; i++, idx++) \
 393                         obj_table[i] = r->ring[idx]; \
 394         } \
 395 } while (0)
 396
 397 /**
 398  * @internal Enqueue several objects on the ring (multi-producers safe).
 399  *
 400  * This function uses a "compare and set" instruction to move the
 401  * producer index atomically.
 402  *
 403  * @param r
 404  *   A pointer to the ring structure.
 405  * @param obj_table
 406  *   A pointer to a table of void * pointers (objects).
 407  * @param n
 408  *   The number of objects to add in the ring from the obj_table.
 409  * @param behavior
 410  *   RTE_RING_QUEUE_FIXED:    Enqueue a fixed number of items from a ring
 411  *   RTE_RING_QUEUE_VARIABLE: Enqueue as many items a possible from ring
 412  * @return
 413  *   Depend on the behavior value
 414  *   if behavior = RTE_RING_QUEUE_FIXED
 415  *   - 0: Success; objects enqueue.
 416  *   - -EDQUOT: Quota exceeded. The objects have been enqueued, but the
 417  *     high water mark is exceeded.
 418  *   - -ENOBUFS: Not enough room in the ring to enqueue, no object is enqueued.
 419  *   if behavior = RTE_RING_QUEUE_VARIABLE
 420  *   - n: Actual number of objects enqueued.
 421  */
 422 static inline int __attribute__((always_inline))
 423 __rte_ring_mp_do_enqueue(struct rte_ring *r, void * const *obj_table,
 424                          unsigned n, enum rte_ring_queue_behavior behavior)
 425 {
 426         uint32_t prod_head, prod_next;
 427         uint32_t cons_tail, free_entries;
 428         const unsigned max = n;
 429         int success;
 430         unsigned i, rep = 0;
 431         uint32_t mask = r->prod.mask;
 432         int ret;
 433
 434         /* move prod.head atomically */
 435         do {
 436                 /* Reset n to the initial burst count */
 437                 n = max;
 438
 439                 prod_head = r->prod.head;
 440                 cons_tail = r->cons.tail;
 441                 /* The subtraction is done between two unsigned 32bits value
 442                  * (the result is always modulo 32 bits even if we have
 443                  * prod_head > cons_tail). So 'free_entries' is always between 0
 444                  * and size(ring)-1. */
 445                 free_entries = (mask + cons_tail - prod_head);
 446
 447                 /* check that we have enough room in ring */
 448                 if (unlikely(n > free_entries)) {
 449                         if (behavior == RTE_RING_QUEUE_FIXED) {
 450                                 __RING_STAT_ADD(r, enq_fail, n);
 451                                 return -ENOBUFS;
 452                         }
 453                         else {
 454                                 /* No free entry available */
 455                                 if (unlikely(free_entries == 0)) {
 456                                         __RING_STAT_ADD(r, enq_fail, n);
 457                                         return 0;
 458                                 }
 459
 460                                 n = free_entries;
 461                         }
 462                 }
 463
 464                 prod_next = prod_head + n;
 465                 success = rte_atomic32_cmpset(&r->prod.head, prod_head,
 466                                               prod_next);
 467         } while (unlikely(success == 0));
 468
 469         /* write entries in ring */
 470         ENQUEUE_PTRS();
 471         rte_smp_wmb();
 472
 473         /* if we exceed the watermark */
 474         if (unlikely(((mask + 1) - free_entries + n) > r->prod.watermark)) {
 475                 ret = (behavior == RTE_RING_QUEUE_FIXED) ? -EDQUOT :
 476                                 (int)(n | RTE_RING_QUOT_EXCEED);
 477                 __RING_STAT_ADD(r, enq_quota, n);
 478         }
 479         else {
 480                 ret = (behavior == RTE_RING_QUEUE_FIXED) ? 0 : n;
 481                 __RING_STAT_ADD(r, enq_success, n);
 482         }
 483
 484         /*
 485          * If there are other enqueues in progress that preceded us,
 486          * we need to wait for them to complete
 487          */
 488         while (unlikely(r->prod.tail != prod_head)) {
 489                 rte_pause();
 490
 491                 /* Set RTE_RING_PAUSE_REP_COUNT to avoid spin too long waiting
 492                  * for other thread finish. It gives pre-empted thread a chance
 493                  * to proceed and finish with ring dequeue operation. */
 494                 if (RTE_RING_PAUSE_REP_COUNT &&
 495                     ++rep == RTE_RING_PAUSE_REP_COUNT) {
 496                         rep = 0;
 497                         sched_yield();
 498                 }
 499         }
 500         r->prod.tail = prod_next;
 501         return ret;
 502 }
 503
 504 /**
 505  * @internal Enqueue several objects on a ring (NOT multi-producers safe).
 506  *
 507  * @param r
 508  *   A pointer to the ring structure.
 509  * @param obj_table
 510  *   A pointer to a table of void * pointers (objects).
 511  * @param n
 512  *   The number of objects to add in the ring from the obj_table.
 513  * @param behavior
 514  *   RTE_RING_QUEUE_FIXED:    Enqueue a fixed number of items from a ring
 515  *   RTE_RING_QUEUE_VARIABLE: Enqueue as many items a possible from ring
 516  * @return
 517  *   Depend on the behavior value
 518  *   if behavior = RTE_RING_QUEUE_FIXED
 519  *   - 0: Success; objects enqueue.
 520  *   - -EDQUOT: Quota exceeded. The objects have been enqueued, but the
 521  *     high water mark is exceeded.
 522  *   - -ENOBUFS: Not enough room in the ring to enqueue, no object is enqueued.
 523  *   if behavior = RTE_RING_QUEUE_VARIABLE
 524  *   - n: Actual number of objects enqueued.
 525  */
 526 static inline int __attribute__((always_inline))
 527 __rte_ring_sp_do_enqueue(struct rte_ring *r, void * const *obj_table,
 528                          unsigned n, enum rte_ring_queue_behavior behavior)
 529 {
 530         uint32_t prod_head, cons_tail;
 531         uint32_t prod_next, free_entries;
 532         unsigned i;
 533         uint32_t mask = r->prod.mask;
 534         int ret;
 535
 536         prod_head = r->prod.head;
 537         cons_tail = r->cons.tail;
 538         /* The subtraction is done between two unsigned 32bits value
 539          * (the result is always modulo 32 bits even if we have
 540          * prod_head > cons_tail). So 'free_entries' is always between 0
 541          * and size(ring)-1. */
 542         free_entries = mask + cons_tail - prod_head;
 543
 544         /* check that we have enough room in ring */
 545         if (unlikely(n > free_entries)) {
 546                 if (behavior == RTE_RING_QUEUE_FIXED) {
 547                         __RING_STAT_ADD(r, enq_fail, n);
 548                         return -ENOBUFS;
 549                 }
 550                 else {
 551                         /* No free entry available */
 552                         if (unlikely(free_entries == 0)) {
 553                                 __RING_STAT_ADD(r, enq_fail, n);
 554                                 return 0;
 555                         }
 556
 557                         n = free_entries;
 558                 }
 559         }
 560
 561         prod_next = prod_head + n;
 562         r->prod.head = prod_next;
 563
 564         /* write entries in ring */
 565         ENQUEUE_PTRS();
 566         rte_smp_wmb();
 567
 568         /* if we exceed the watermark */
 569         if (unlikely(((mask + 1) - free_entries + n) > r->prod.watermark)) {
 570                 ret = (behavior == RTE_RING_QUEUE_FIXED) ? -EDQUOT :
 571                         (int)(n | RTE_RING_QUOT_EXCEED);
 572                 __RING_STAT_ADD(r, enq_quota, n);
 573         }
 574         else {
 575                 ret = (behavior == RTE_RING_QUEUE_FIXED) ? 0 : n;
 576                 __RING_STAT_ADD(r, enq_success, n);
 577         }
 578
 579         r->prod.tail = prod_next;
 580         return ret;
 581 }
 582
 583 /**
 584  * @internal Dequeue several objects from a ring (multi-consumers safe). When
 585  * the request objects are more than the available objects, only dequeue the
 586  * actual number of objects
 587  *
 588  * This function uses a "compare and set" instruction to move the
 589  * consumer index atomically.
 590  *
 591  * @param r
 592  *   A pointer to the ring structure.
 593  * @param obj_table
 594  *   A pointer to a table of void * pointers (objects) that will be filled.
 595  * @param n
 596  *   The number of objects to dequeue from the ring to the obj_table.
 597  * @param behavior
 598  *   RTE_RING_QUEUE_FIXED:    Dequeue a fixed number of items from a ring
 599  *   RTE_RING_QUEUE_VARIABLE: Dequeue as many items a possible from ring
 600  * @return
 601  *   Depend on the behavior value
 602  *   if behavior = RTE_RING_QUEUE_FIXED
 603  *   - 0: Success; objects dequeued.
 604  *   - -ENOENT: Not enough entries in the ring to dequeue; no object is
 605  *     dequeued.
 606  *   if behavior = RTE_RING_QUEUE_VARIABLE
 607  *   - n: Actual number of objects dequeued.
 608  */
 609
 610 static inline int __attribute__((always_inline))
 611 __rte_ring_mc_do_dequeue(struct rte_ring *r, void **obj_table,
 612                  unsigned n, enum rte_ring_queue_behavior behavior)
 613 {
 614         uint32_t cons_head, prod_tail;
 615         uint32_t cons_next, entries;
 616         const unsigned max = n;
 617         int success;
 618         unsigned i, rep = 0;
 619         uint32_t mask = r->prod.mask;
 620
 621         /* move cons.head atomically */
 622         do {
 623                 /* Restore n as it may change every loop */
 624                 n = max;
 625
 626                 cons_head = r->cons.head;
 627                 prod_tail = r->prod.tail;
 628                 /* The subtraction is done between two unsigned 32bits value
 629                  * (the result is always modulo 32 bits even if we have
 630                  * cons_head > prod_tail). So 'entries' is always between 0
 631                  * and size(ring)-1. */
 632                 entries = (prod_tail - cons_head);
 633
 634                 /* Set the actual entries for dequeue */
 635                 if (n > entries) {
 636                         if (behavior == RTE_RING_QUEUE_FIXED) {
 637                                 __RING_STAT_ADD(r, deq_fail, n);
 638                                 return -ENOENT;
 639                         }
 640                         else {
 641                                 if (unlikely(entries == 0)){
 642                                         __RING_STAT_ADD(r, deq_fail, n);
 643                                         return 0;
 644                                 }
 645
 646                                 n = entries;
 647                         }
 648                 }
 649
 650                 cons_next = cons_head + n;
 651                 success = rte_atomic32_cmpset(&r->cons.head, cons_head,
 652                                               cons_next);
 653         } while (unlikely(success == 0));
 654
 655         /* copy in table */
 656         DEQUEUE_PTRS();
 657         rte_smp_rmb();
 658
 659         /*
 660          * If there are other dequeues in progress that preceded us,
 661          * we need to wait for them to complete
 662          */
 663         while (unlikely(r->cons.tail != cons_head)) {
 664                 rte_pause();
 665
 666                 /* Set RTE_RING_PAUSE_REP_COUNT to avoid spin too long waiting
 667                  * for other thread finish. It gives pre-empted thread a chance
 668                  * to proceed and finish with ring dequeue operation. */
 669                 if (RTE_RING_PAUSE_REP_COUNT &&
 670                     ++rep == RTE_RING_PAUSE_REP_COUNT) {
 671                         rep = 0;
 672                         sched_yield();
 673                 }
 674         }
 675         __RING_STAT_ADD(r, deq_success, n);
 676         r->cons.tail = cons_next;
 677
 678         return behavior == RTE_RING_QUEUE_FIXED ? 0 : n;
 679 }
 680
 681 /**
 682  * @internal Dequeue several objects from a ring (NOT multi-consumers safe).
 683  * When the request objects are more than the available objects, only dequeue
 684  * the actual number of objects
 685  *
 686  * @param r
 687  *   A pointer to the ring structure.
 688  * @param obj_table
 689  *   A pointer to a table of void * pointers (objects) that will be filled.
 690  * @param n
 691  *   The number of objects to dequeue from the ring to the obj_table.
 692  * @param behavior
 693  *   RTE_RING_QUEUE_FIXED:    Dequeue a fixed number of items from a ring
 694  *   RTE_RING_QUEUE_VARIABLE: Dequeue as many items a possible from ring
 695  * @return
 696  *   Depend on the behavior value
 697  *   if behavior = RTE_RING_QUEUE_FIXED
 698  *   - 0: Success; objects dequeued.
 699  *   - -ENOENT: Not enough entries in the ring to dequeue; no object is
 700  *     dequeued.
 701  *   if behavior = RTE_RING_QUEUE_VARIABLE
 702  *   - n: Actual number of objects dequeued.
 703  */
 704 static inline int __attribute__((always_inline))
 705 __rte_ring_sc_do_dequeue(struct rte_ring *r, void **obj_table,
 706                  unsigned n, enum rte_ring_queue_behavior behavior)
 707 {
 708         uint32_t cons_head, prod_tail;
 709         uint32_t cons_next, entries;
 710         unsigned i;
 711         uint32_t mask = r->prod.mask;
 712
 713         cons_head = r->cons.head;
 714         prod_tail = r->prod.tail;
 715         /* The subtraction is done between two unsigned 32bits value
 716          * (the result is always modulo 32 bits even if we have
 717          * cons_head > prod_tail). So 'entries' is always between 0
 718          * and size(ring)-1. */
 719         entries = prod_tail - cons_head;
 720
 721         if (n > entries) {
 722                 if (behavior == RTE_RING_QUEUE_FIXED) {
 723                         __RING_STAT_ADD(r, deq_fail, n);
 724                         return -ENOENT;
 725                 }
 726                 else {
 727                         if (unlikely(entries == 0)){
 728                                 __RING_STAT_ADD(r, deq_fail, n);
 729                                 return 0;
 730                         }
 731
 732                         n = entries;
 733                 }
 734         }
 735
 736         cons_next = cons_head + n;
 737         r->cons.head = cons_next;
 738
 739         /* copy in table */
 740         DEQUEUE_PTRS();
 741         rte_smp_rmb();
 742
 743         __RING_STAT_ADD(r, deq_success, n);
 744         r->cons.tail = cons_next;
 745         return behavior == RTE_RING_QUEUE_FIXED ? 0 : n;
 746 }
 747
 748 /**
 749  * Enqueue several objects on the ring (multi-producers safe).
 750  *
 751  * This function uses a "compare and set" instruction to move the
 752  * producer index atomically.
 753  *
 754  * @param r
 755  *   A pointer to the ring structure.
 756  * @param obj_table
 757  *   A pointer to a table of void * pointers (objects).
 758  * @param n
 759  *   The number of objects to add in the ring from the obj_table.
 760  * @return
 761  *   - 0: Success; objects enqueue.
 762  *   - -EDQUOT: Quota exceeded. The objects have been enqueued, but the
 763  *     high water mark is exceeded.
 764  *   - -ENOBUFS: Not enough room in the ring to enqueue, no object is enqueued.
 765  */
 766 static inline int __attribute__((always_inline))
 767 rte_ring_mp_enqueue_bulk(struct rte_ring *r, void * const *obj_table,
 768                          unsigned n)
 769 {
 770         return __rte_ring_mp_do_enqueue(r, obj_table, n, RTE_RING_QUEUE_FIXED);
 771 }
 772
 773 /**
 774  * Enqueue several objects on a ring (NOT multi-producers safe).
 775  *
 776  * @param r
 777  *   A pointer to the ring structure.
 778  * @param obj_table
 779  *   A pointer to a table of void * pointers (objects).
 780  * @param n
 781  *   The number of objects to add in the ring from the obj_table.
 782  * @return
 783  *   - 0: Success; objects enqueued.
 784  *   - -EDQUOT: Quota exceeded. The objects have been enqueued, but the
 785  *     high water mark is exceeded.
 786  *   - -ENOBUFS: Not enough room in the ring to enqueue; no object is enqueued.
 787  */
 788 static inline int __attribute__((always_inline))
 789 rte_ring_sp_enqueue_bulk(struct rte_ring *r, void * const *obj_table,
 790                          unsigned n)
 791 {
 792         return __rte_ring_sp_do_enqueue(r, obj_table, n, RTE_RING_QUEUE_FIXED);
 793 }
 794
 795 /**
 796  * Enqueue several objects on a ring.
 797  *
 798  * This function calls the multi-producer or the single-producer
 799  * version depending on the default behavior that was specified at
 800  * ring creation time (see flags).
 801  *
 802  * @param r
 803  *   A pointer to the ring structure.
 804  * @param obj_table
 805  *   A pointer to a table of void * pointers (objects).
 806  * @param n
 807  *   The number of objects to add in the ring from the obj_table.
 808  * @return
 809  *   - 0: Success; objects enqueued.
 810  *   - -EDQUOT: Quota exceeded. The objects have been enqueued, but the
 811  *     high water mark is exceeded.
 812  *   - -ENOBUFS: Not enough room in the ring to enqueue; no object is enqueued.
 813  */
 814 static inline int __attribute__((always_inline))
 815 rte_ring_enqueue_bulk(struct rte_ring *r, void * const *obj_table,
 816                       unsigned n)
 817 {
 818         if (r->prod.sp_enqueue)
 819                 return rte_ring_sp_enqueue_bulk(r, obj_table, n);
 820         else
 821                 return rte_ring_mp_enqueue_bulk(r, obj_table, n);
 822 }
 823
 824 /**
 825  * Enqueue one object on a ring (multi-producers safe).
 826  *
 827  * This function uses a "compare and set" instruction to move the
 828  * producer index atomically.
 829  *
 830  * @param r
 831  *   A pointer to the ring structure.
 832  * @param obj
 833  *   A pointer to the object to be added.
 834  * @return
 835  *   - 0: Success; objects enqueued.
 836  *   - -EDQUOT: Quota exceeded. The objects have been enqueued, but the
 837  *     high water mark is exceeded.
 838  *   - -ENOBUFS: Not enough room in the ring to enqueue; no object is enqueued.
 839  */
 840 static inline int __attribute__((always_inline))
 841 rte_ring_mp_enqueue(struct rte_ring *r, void *obj)
 842 {
 843         return rte_ring_mp_enqueue_bulk(r, &obj, 1);
 844 }
 845
 846 /**
 847  * Enqueue one object on a ring (NOT multi-producers safe).
 848  *
 849  * @param r
 850  *   A pointer to the ring structure.
 851  * @param obj
 852  *   A pointer to the object to be added.
 853  * @return
 854  *   - 0: Success; objects enqueued.
 855  *   - -EDQUOT: Quota exceeded. The objects have been enqueued, but the
 856  *     high water mark is exceeded.
 857  *   - -ENOBUFS: Not enough room in the ring to enqueue; no object is enqueued.
 858  */
 859 static inline int __attribute__((always_inline))
 860 rte_ring_sp_enqueue(struct rte_ring *r, void *obj)
 861 {
 862         return rte_ring_sp_enqueue_bulk(r, &obj, 1);
 863 }
 864
 865 /**
 866  * Enqueue one object on a ring.
 867  *
 868  * This function calls the multi-producer or the single-producer
 869  * version, depending on the default behaviour that was specified at
 870  * ring creation time (see flags).
 871  *
 872  * @param r
 873  *   A pointer to the ring structure.
 874  * @param obj
 875  *   A pointer to the object to be added.
 876  * @return
 877  *   - 0: Success; objects enqueued.
 878  *   - -EDQUOT: Quota exceeded. The objects have been enqueued, but the
 879  *     high water mark is exceeded.
 880  *   - -ENOBUFS: Not enough room in the ring to enqueue; no object is enqueued.
 881  */
 882 static inline int __attribute__((always_inline))
 883 rte_ring_enqueue(struct rte_ring *r, void *obj)
 884 {
 885         if (r->prod.sp_enqueue)
 886                 return rte_ring_sp_enqueue(r, obj);
 887         else
 888                 return rte_ring_mp_enqueue(r, obj);
 889 }
 890
 891 /**
 892  * Dequeue several objects from a ring (multi-consumers safe).
 893  *
 894  * This function uses a "compare and set" instruction to move the
 895  * consumer index atomically.
 896  *
 897  * @param r
 898  *   A pointer to the ring structure.
 899  * @param obj_table
 900  *   A pointer to a table of void * pointers (objects) that will be filled.
 901  * @param n
 902  *   The number of objects to dequeue from the ring to the obj_table.
 903  * @return
 904  *   - 0: Success; objects dequeued.
 905  *   - -ENOENT: Not enough entries in the ring to dequeue; no object is
 906  *     dequeued.
 907  */
 908 static inline int __attribute__((always_inline))
 909 rte_ring_mc_dequeue_bulk(struct rte_ring *r, void **obj_table, unsigned n)
 910 {
 911         return __rte_ring_mc_do_dequeue(r, obj_table, n, RTE_RING_QUEUE_FIXED);
 912 }
 913
 914 /**
 915  * Dequeue several objects from a ring (NOT multi-consumers safe).
 916  *
 917  * @param r
 918  *   A pointer to the ring structure.
 919  * @param obj_table
 920  *   A pointer to a table of void * pointers (objects) that will be filled.
 921  * @param n
 922  *   The number of objects to dequeue from the ring to the obj_table,
 923  *   must be strictly positive.
 924  * @return
 925  *   - 0: Success; objects dequeued.
 926  *   - -ENOENT: Not enough entries in the ring to dequeue; no object is
 927  *     dequeued.
 928  */
 929 static inline int __attribute__((always_inline))
 930 rte_ring_sc_dequeue_bulk(struct rte_ring *r, void **obj_table, unsigned n)
 931 {
 932         return __rte_ring_sc_do_dequeue(r, obj_table, n, RTE_RING_QUEUE_FIXED);
 933 }
 934
 935 /**
 936  * Dequeue several objects from a ring.
 937  *
 938  * This function calls the multi-consumers or the single-consumer
 939  * version, depending on the default behaviour that was specified at
 940  * ring creation time (see flags).
 941  *
 942  * @param r
 943  *   A pointer to the ring structure.
 944  * @param obj_table
 945  *   A pointer to a table of void * pointers (objects) that will be filled.
 946  * @param n
 947  *   The number of objects to dequeue from the ring to the obj_table.
 948  * @return
 949  *   - 0: Success; objects dequeued.
 950  *   - -ENOENT: Not enough entries in the ring to dequeue, no object is
 951  *     dequeued.
 952  */
 953 static inline int __attribute__((always_inline))
 954 rte_ring_dequeue_bulk(struct rte_ring *r, void **obj_table, unsigned n)
 955 {
 956         if (r->cons.sc_dequeue)
 957                 return rte_ring_sc_dequeue_bulk(r, obj_table, n);
 958         else
 959                 return rte_ring_mc_dequeue_bulk(r, obj_table, n);
 960 }
 961
 962 /**
 963  * Dequeue one object from a ring (multi-consumers safe).
 964  *
 965  * This function uses a "compare and set" instruction to move the
 966  * consumer index atomically.
 967  *
 968  * @param r
 969  *   A pointer to the ring structure.
 970  * @param obj_p
 971  *   A pointer to a void * pointer (object) that will be filled.
 972  * @return
 973  *   - 0: Success; objects dequeued.
 974  *   - -ENOENT: Not enough entries in the ring to dequeue; no object is
 975  *     dequeued.
 976  */
 977 static inline int __attribute__((always_inline))
 978 rte_ring_mc_dequeue(struct rte_ring *r, void **obj_p)
 979 {
 980         return rte_ring_mc_dequeue_bulk(r, obj_p, 1);
 981 }
 982
 983 /**
 984  * Dequeue one object from a ring (NOT multi-consumers safe).
 985  *
 986  * @param r
 987  *   A pointer to the ring structure.
 988  * @param obj_p
 989  *   A pointer to a void * pointer (object) that will be filled.
 990  * @return
 991  *   - 0: Success; objects dequeued.
 992  *   - -ENOENT: Not enough entries in the ring to dequeue, no object is
 993  *     dequeued.
 994  */
 995 static inline int __attribute__((always_inline))
 996 rte_ring_sc_dequeue(struct rte_ring *r, void **obj_p)
 997 {
 998         return rte_ring_sc_dequeue_bulk(r, obj_p, 1);
 999 }
1000
1001 /**
1002  * Dequeue one object from a ring.
1003  *
1004  * This function calls the multi-consumers or the single-consumer
1005  * version depending on the default behaviour that was specified at
1006  * ring creation time (see flags).
1007  *
1008  * @param r
1009  *   A pointer to the ring structure.
1010  * @param obj_p
1011  *   A pointer to a void * pointer (object) that will be filled.
1012  * @return
1013  *   - 0: Success, objects dequeued.
1014  *   - -ENOENT: Not enough entries in the ring to dequeue, no object is
1015  *     dequeued.
1016  */
1017 static inline int __attribute__((always_inline))
1018 rte_ring_dequeue(struct rte_ring *r, void **obj_p)
1019 {
1020         if (r->cons.sc_dequeue)
1021                 return rte_ring_sc_dequeue(r, obj_p);
1022         else
1023                 return rte_ring_mc_dequeue(r, obj_p);
1024 }
1025
1026 /**
1027  * Test if a ring is full.
1028  *
1029  * @param r
1030  *   A pointer to the ring structure.
1031  * @return
1032  *   - 1: The ring is full.
1033  *   - 0: The ring is not full.
1034  */
1035 static inline int
1036 rte_ring_full(const struct rte_ring *r)
1037 {
1038         uint32_t prod_tail = r->prod.tail;
1039         uint32_t cons_tail = r->cons.tail;
1040         return ((cons_tail - prod_tail - 1) & r->prod.mask) == 0;
1041 }
1042
1043 /**
1044  * Test if a ring is empty.
1045  *
1046  * @param r
1047  *   A pointer to the ring structure.
1048  * @return
1049  *   - 1: The ring is empty.
1050  *   - 0: The ring is not empty.
1051  */
1052 static inline int
1053 rte_ring_empty(const struct rte_ring *r)
1054 {
1055         uint32_t prod_tail = r->prod.tail;
1056         uint32_t cons_tail = r->cons.tail;
1057         return !!(cons_tail == prod_tail);
1058 }
1059
1060 /**
1061  * Return the number of entries in a ring.
1062  *
1063  * @param r
1064  *   A pointer to the ring structure.
1065  * @return
1066  *   The number of entries in the ring.
1067  */
1068 static inline unsigned
1069 rte_ring_count(const struct rte_ring *r)
1070 {
1071         uint32_t prod_tail = r->prod.tail;
1072         uint32_t cons_tail = r->cons.tail;
1073         return (prod_tail - cons_tail) & r->prod.mask;
1074 }
1075
1076 /**
1077  * Return the number of free entries in a ring.
1078  *
1079  * @param r
1080  *   A pointer to the ring structure.
1081  * @return
1082  *   The number of free entries in the ring.
1083  */
1084 static inline unsigned
1085 rte_ring_free_count(const struct rte_ring *r)
1086 {
1087         uint32_t prod_tail = r->prod.tail;
1088         uint32_t cons_tail = r->cons.tail;
1089         return (cons_tail - prod_tail - 1) & r->prod.mask;
1090 }
1091
1092 /**
1093  * Dump the status of all rings on the console
1094  *
1095  * @param f
1096  *   A pointer to a file for output
1097  */
1098 void rte_ring_list_dump(FILE *f);
1099
1100 /**
1101  * Search a ring from its name
1102  *
1103  * @param name
1104  *   The name of the ring.
1105  * @return
1106  *   The pointer to the ring matching the name, or NULL if not found,
1107  *   with rte_errno set appropriately. Possible rte_errno values include:
1108  *    - ENOENT - required entry not available to return.
1109  */
1110 struct rte_ring *rte_ring_lookup(const char *name);
1111
1112 /**
1113  * Enqueue several objects on the ring (multi-producers safe).
1114  *
1115  * This function uses a "compare and set" instruction to move the
1116  * producer index atomically.
1117  *
1118  * @param r
1119  *   A pointer to the ring structure.
1120  * @param obj_table
1121  *   A pointer to a table of void * pointers (objects).
1122  * @param n
1123  *   The number of objects to add in the ring from the obj_table.
1124  * @return
1125  *   - n: Actual number of objects enqueued.
1126  */
1127 static inline unsigned __attribute__((always_inline))
1128 rte_ring_mp_enqueue_burst(struct rte_ring *r, void * const *obj_table,
1129                          unsigned n)
1130 {
1131         return __rte_ring_mp_do_enqueue(r, obj_table, n, RTE_RING_QUEUE_VARIABLE);
1132 }
1133
1134 /**
1135  * Enqueue several objects on a ring (NOT multi-producers safe).
1136  *
1137  * @param r
1138  *   A pointer to the ring structure.
1139  * @param obj_table
1140  *   A pointer to a table of void * pointers (objects).
1141  * @param n
1142  *   The number of objects to add in the ring from the obj_table.
1143  * @return
1144  *   - n: Actual number of objects enqueued.
1145  */
1146 static inline unsigned __attribute__((always_inline))
1147 rte_ring_sp_enqueue_burst(struct rte_ring *r, void * const *obj_table,
1148                          unsigned n)
1149 {
1150         return __rte_ring_sp_do_enqueue(r, obj_table, n, RTE_RING_QUEUE_VARIABLE);
1151 }
1152
1153 /**
1154  * Enqueue several objects on a ring.
1155  *
1156  * This function calls the multi-producer or the single-producer
1157  * version depending on the default behavior that was specified at
1158  * ring creation time (see flags).
1159  *
1160  * @param r
1161  *   A pointer to the ring structure.
1162  * @param obj_table
1163  *   A pointer to a table of void * pointers (objects).
1164  * @param n
1165  *   The number of objects to add in the ring from the obj_table.
1166  * @return
1167  *   - n: Actual number of objects enqueued.
1168  */
1169 static inline unsigned __attribute__((always_inline))
1170 rte_ring_enqueue_burst(struct rte_ring *r, void * const *obj_table,
1171                       unsigned n)
1172 {
1173         if (r->prod.sp_enqueue)
1174                 return rte_ring_sp_enqueue_burst(r, obj_table, n);
1175         else
1176                 return rte_ring_mp_enqueue_burst(r, obj_table, n);
1177 }
1178
1179 /**
1180  * Dequeue several objects from a ring (multi-consumers safe). When the request
1181  * objects are more than the available objects, only dequeue the actual number
1182  * of objects
1183  *
1184  * This function uses a "compare and set" instruction to move the
1185  * consumer index atomically.
1186  *
1187  * @param r
1188  *   A pointer to the ring structure.
1189  * @param obj_table
1190  *   A pointer to a table of void * pointers (objects) that will be filled.
1191  * @param n
1192  *   The number of objects to dequeue from the ring to the obj_table.
1193  * @return
1194  *   - n: Actual number of objects dequeued, 0 if ring is empty
1195  */
1196 static inline unsigned __attribute__((always_inline))
1197 rte_ring_mc_dequeue_burst(struct rte_ring *r, void **obj_table, unsigned n)
1198 {
1199         return __rte_ring_mc_do_dequeue(r, obj_table, n, RTE_RING_QUEUE_VARIABLE);
1200 }
1201
1202 /**
1203  * Dequeue several objects from a ring (NOT multi-consumers safe).When the
1204  * request objects are more than the available objects, only dequeue the
1205  * actual number of objects
1206  *
1207  * @param r
1208  *   A pointer to the ring structure.
1209  * @param obj_table
1210  *   A pointer to a table of void * pointers (objects) that will be filled.
1211  * @param n
1212  *   The number of objects to dequeue from the ring to the obj_table.
1213  * @return
1214  *   - n: Actual number of objects dequeued, 0 if ring is empty
1215  */
1216 static inline unsigned __attribute__((always_inline))
1217 rte_ring_sc_dequeue_burst(struct rte_ring *r, void **obj_table, unsigned n)
1218 {
1219         return __rte_ring_sc_do_dequeue(r, obj_table, n, RTE_RING_QUEUE_VARIABLE);
1220 }
1221
1222 /**
1223  * Dequeue multiple objects from a ring up to a maximum number.
1224  *
1225  * This function calls the multi-consumers or the single-consumer
1226  * version, depending on the default behaviour that was specified at
1227  * ring creation time (see flags).
1228  *
1229  * @param r
1230  *   A pointer to the ring structure.
1231  * @param obj_table
1232  *   A pointer to a table of void * pointers (objects) that will be filled.
1233  * @param n
1234  *   The number of objects to dequeue from the ring to the obj_table.
1235  * @return
1236  *   - Number of objects dequeued
1237  */
1238 static inline unsigned __attribute__((always_inline))
1239 rte_ring_dequeue_burst(struct rte_ring *r, void **obj_table, unsigned n)
1240 {
1241         if (r->cons.sc_dequeue)
1242                 return rte_ring_sc_dequeue_burst(r, obj_table, n);
1243         else
1244                 return rte_ring_mc_dequeue_burst(r, obj_table, n);
1245 }
1246
1247 #ifdef __cplusplus
1248 }
1249 #endif
1250
1251 #endif /* _RTE_RING_H_ */