add FILE argument to debug functions
[dpdk.git] / lib / librte_ring / rte_ring.c
index 08a3c80..3a919b0 100644 (file)
@@ -1,35 +1,34 @@
 /*-
  *   BSD LICENSE
  * 
- *   Copyright(c) 2010-2012 Intel Corporation. All rights reserved.
+ *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
  *   All rights reserved.
  * 
- *   Redistribution and use in source and binary forms, with or without 
- *   modification, are permitted provided that the following conditions 
+ *   Redistribution and use in source and binary forms, with or without
+ *   modification, are permitted provided that the following conditions
  *   are met:
  * 
- *     * Redistributions of source code must retain the above copyright 
+ *     * Redistributions of source code must retain the above copyright
  *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright 
- *       notice, this list of conditions and the following disclaimer in 
- *       the documentation and/or other materials provided with the 
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in
+ *       the documentation and/or other materials provided with the
  *       distribution.
- *     * Neither the name of Intel Corporation nor the names of its 
- *       contributors may be used to endorse or promote products derived 
+ *     * Neither the name of Intel Corporation nor the names of its
+ *       contributors may be used to endorse or promote products derived
  *       from this software without specific prior written permission.
  * 
- *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
- *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
- *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
- *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
- *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
- *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
- *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
- *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
- *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
- *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
+ *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- * 
  */
 
 /*
 #include <rte_launch.h>
 #include <rte_tailq.h>
 #include <rte_eal.h>
+#include <rte_eal_memconfig.h>
 #include <rte_atomic.h>
 #include <rte_per_lcore.h>
 #include <rte_lcore.h>
 #include <rte_branch_prediction.h>
 #include <rte_errno.h>
 #include <rte_string_fns.h>
+#include <rte_spinlock.h>
 
 #include "rte_ring.h"
 
 TAILQ_HEAD(rte_ring_list, rte_ring);
 
-/* global list of ring (used for debug/dump) */
-static struct rte_ring_list *ring_list = NULL;
-
 /* true if x is a power of 2 */
 #define POWEROF2(x) ((((x)-1) & (x)) == 0)
 
-/* create the ring */
-struct rte_ring *
-rte_ring_create(const char *name, unsigned count, int socket_id,
-               unsigned flags)
+/* return the size of memory occupied by a ring */
+ssize_t
+rte_ring_get_memsize(unsigned count)
 {
-       char mz_name[RTE_MEMZONE_NAMESIZE];
-       struct rte_ring *r;
-       const struct rte_memzone *mz;
-       size_t ring_size;
-       int mz_flags = 0;
+       ssize_t sz;
+
+       /* count must be a power of 2 */
+       if ((!POWEROF2(count)) || (count > RTE_RING_SZ_MASK )) {
+               RTE_LOG(ERR, RING,
+                       "Requested size is invalid, must be power of 2, and "
+                       "do not exceed the size limit %u\n", RTE_RING_SZ_MASK);
+               return -EINVAL;
+       }
+
+       sz = sizeof(struct rte_ring) + count * sizeof(void *);
+       sz = RTE_ALIGN(sz, CACHE_LINE_SIZE);
+       return sz;
+}
 
+int
+rte_ring_init(struct rte_ring *r, const char *name, unsigned count,
+       unsigned flags)
+{
        /* compilation-time checks */
        RTE_BUILD_BUG_ON((sizeof(struct rte_ring) &
                          CACHE_LINE_MASK) != 0);
+#ifdef RTE_RING_SPLIT_PROD_CONS
        RTE_BUILD_BUG_ON((offsetof(struct rte_ring, cons) &
                          CACHE_LINE_MASK) != 0);
+#endif
        RTE_BUILD_BUG_ON((offsetof(struct rte_ring, prod) &
                          CACHE_LINE_MASK) != 0);
 #ifdef RTE_LIBRTE_RING_DEBUG
@@ -121,48 +133,66 @@ rte_ring_create(const char *name, unsigned count, int socket_id,
                          CACHE_LINE_MASK) != 0);
 #endif
 
+       /* init the ring structure */
+       memset(r, 0, sizeof(*r));
+       rte_snprintf(r->name, sizeof(r->name), "%s", name);
+       r->flags = flags;
+       r->prod.watermark = count;
+       r->prod.sp_enqueue = !!(flags & RING_F_SP_ENQ);
+       r->cons.sc_dequeue = !!(flags & RING_F_SC_DEQ);
+       r->prod.size = r->cons.size = count;
+       r->prod.mask = r->cons.mask = count-1;
+       r->prod.head = r->cons.head = 0;
+       r->prod.tail = r->cons.tail = 0;
+
+       return 0;
+}
+
+/* create the ring */
+struct rte_ring *
+rte_ring_create(const char *name, unsigned count, int socket_id,
+               unsigned flags)
+{
+       char mz_name[RTE_MEMZONE_NAMESIZE];
+       struct rte_ring *r;
+       const struct rte_memzone *mz;
+       ssize_t ring_size;
+       int mz_flags = 0;
+       struct rte_ring_list* ring_list = NULL;
+
        /* check that we have an initialised tail queue */
-       if (ring_list == NULL)
-               if ((ring_list = RTE_TAILQ_RESERVE("RTE_RING", rte_ring_list)) == NULL){
-                       rte_errno = E_RTE_NO_TAILQ;
-                       return NULL;
-               }
+       if ((ring_list =
+            RTE_TAILQ_LOOKUP_BY_IDX(RTE_TAILQ_RING, rte_ring_list)) == NULL) {
+               rte_errno = E_RTE_NO_TAILQ;
+               return NULL;
+       }
 
-       /* count must be a power of 2 */
-       if (!POWEROF2(count)) {
-               rte_errno = EINVAL;
-               RTE_LOG(ERR, RING, "Requested size is not a power of 2\n");
+       ring_size = rte_ring_get_memsize(count);
+       if (ring_size < 0) {
+               rte_errno = ring_size;
                return NULL;
        }
 
-       rte_snprintf(mz_name, sizeof(mz_name), "RG_%s", name);
-       ring_size = count * sizeof(void *) + sizeof(struct rte_ring);
+       rte_snprintf(mz_name, sizeof(mz_name), "%s%s", RTE_RING_MZ_PREFIX, name);
+
+       rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
 
        /* reserve a memory zone for this ring. If we can't get rte_config or
         * we are secondary process, the memzone_reserve function will set
         * rte_errno for us appropriately - hence no check in this this function */
        mz = rte_memzone_reserve(mz_name, ring_size, socket_id, mz_flags);
-       if (mz == NULL) {
+       if (mz != NULL) {
+               r = mz->addr;
+               /* no need to check return value here, we already checked the
+                * arguments above */
+               rte_ring_init(r, name, count, flags);
+               TAILQ_INSERT_TAIL(ring_list, r, next);
+       } else {
+               r = NULL;
                RTE_LOG(ERR, RING, "Cannot reserve memory\n");
-               return NULL;
        }
+       rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
 
-       r = mz->addr;
-
-       /* init the ring structure */
-       memset(r, 0, sizeof(*r));
-       rte_snprintf(r->name, sizeof(r->name), "%s", name);
-       r->flags = flags;
-       r->prod.bulk_default = r->cons.bulk_default = 1;
-       r->prod.watermark = count;
-       r->prod.sp_enqueue = !!(flags & RING_F_SP_ENQ);
-       r->cons.sc_dequeue = !!(flags & RING_F_SC_DEQ);
-       r->prod.size = r->cons.size = count;
-       r->prod.mask = r->cons.mask = count-1;
-       r->prod.head = r->cons.head = 0;
-       r->prod.tail = r->cons.tail = 0;
-
-       TAILQ_INSERT_TAIL(ring_list, r, next);
        return r;
 }
 
@@ -186,27 +216,26 @@ rte_ring_set_water_mark(struct rte_ring *r, unsigned count)
 
 /* dump the status of the ring on the console */
 void
-rte_ring_dump(const struct rte_ring *r)
+rte_ring_dump(FILE *f, const struct rte_ring *r)
 {
 #ifdef RTE_LIBRTE_RING_DEBUG
        struct rte_ring_debug_stats sum;
        unsigned lcore_id;
 #endif
 
-       printf("ring <%s>@%p\n", r->name, r);
-       printf("  flags=%x\n", r->flags);
-       printf("  size=%"PRIu32"\n", r->prod.size);
-       printf("  ct=%"PRIu32"\n", r->cons.tail);
-       printf("  ch=%"PRIu32"\n", r->cons.head);
-       printf("  pt=%"PRIu32"\n", r->prod.tail);
-       printf("  ph=%"PRIu32"\n", r->prod.head);
-       printf("  used=%u\n", rte_ring_count(r));
-       printf("  avail=%u\n", rte_ring_free_count(r));
+       fprintf(f, "ring <%s>@%p\n", r->name, r);
+       fprintf(f, "  flags=%x\n", r->flags);
+       fprintf(f, "  size=%"PRIu32"\n", r->prod.size);
+       fprintf(f, "  ct=%"PRIu32"\n", r->cons.tail);
+       fprintf(f, "  ch=%"PRIu32"\n", r->cons.head);
+       fprintf(f, "  pt=%"PRIu32"\n", r->prod.tail);
+       fprintf(f, "  ph=%"PRIu32"\n", r->prod.head);
+       fprintf(f, "  used=%u\n", rte_ring_count(r));
+       fprintf(f, "  avail=%u\n", rte_ring_free_count(r));
        if (r->prod.watermark == r->prod.size)
-               printf("  watermark=0\n");
+               fprintf(f, "  watermark=0\n");
        else
-               printf("  watermark=%"PRIu32"\n", r->prod.watermark);
-       printf("  bulk_default=%"PRIu32"\n", r->prod.bulk_default);
+               fprintf(f, "  watermark=%"PRIu32"\n", r->prod.watermark);
 
        /* sum and dump statistics */
 #ifdef RTE_LIBRTE_RING_DEBUG
@@ -223,38 +252,43 @@ rte_ring_dump(const struct rte_ring *r)
                sum.deq_fail_bulk += r->stats[lcore_id].deq_fail_bulk;
                sum.deq_fail_objs += r->stats[lcore_id].deq_fail_objs;
        }
-       printf("  size=%"PRIu32"\n", r->prod.size);
-       printf("  enq_success_bulk=%"PRIu64"\n", sum.enq_success_bulk);
-       printf("  enq_success_objs=%"PRIu64"\n", sum.enq_success_objs);
-       printf("  enq_quota_bulk=%"PRIu64"\n", sum.enq_quota_bulk);
-       printf("  enq_quota_objs=%"PRIu64"\n", sum.enq_quota_objs);
-       printf("  enq_fail_bulk=%"PRIu64"\n", sum.enq_fail_bulk);
-       printf("  enq_fail_objs=%"PRIu64"\n", sum.enq_fail_objs);
-       printf("  deq_success_bulk=%"PRIu64"\n", sum.deq_success_bulk);
-       printf("  deq_success_objs=%"PRIu64"\n", sum.deq_success_objs);
-       printf("  deq_fail_bulk=%"PRIu64"\n", sum.deq_fail_bulk);
-       printf("  deq_fail_objs=%"PRIu64"\n", sum.deq_fail_objs);
+       fprintf(f, "  size=%"PRIu32"\n", r->prod.size);
+       fprintf(f, "  enq_success_bulk=%"PRIu64"\n", sum.enq_success_bulk);
+       fprintf(f, "  enq_success_objs=%"PRIu64"\n", sum.enq_success_objs);
+       fprintf(f, "  enq_quota_bulk=%"PRIu64"\n", sum.enq_quota_bulk);
+       fprintf(f, "  enq_quota_objs=%"PRIu64"\n", sum.enq_quota_objs);
+       fprintf(f, "  enq_fail_bulk=%"PRIu64"\n", sum.enq_fail_bulk);
+       fprintf(f, "  enq_fail_objs=%"PRIu64"\n", sum.enq_fail_objs);
+       fprintf(f, "  deq_success_bulk=%"PRIu64"\n", sum.deq_success_bulk);
+       fprintf(f, "  deq_success_objs=%"PRIu64"\n", sum.deq_success_objs);
+       fprintf(f, "  deq_fail_bulk=%"PRIu64"\n", sum.deq_fail_bulk);
+       fprintf(f, "  deq_fail_objs=%"PRIu64"\n", sum.deq_fail_objs);
 #else
-       printf("  no statistics available\n");
+       fprintf(f, "  no statistics available\n");
 #endif
 }
 
 /* dump the status of all rings on the console */
 void
-rte_ring_list_dump(void)
+rte_ring_list_dump(FILE *f)
 {
        const struct rte_ring *mp;
+       struct rte_ring_list *ring_list;
 
        /* check that we have an initialised tail queue */
-       if (ring_list == NULL)
-               if ((ring_list = RTE_TAILQ_RESERVE("RTE_RING", rte_ring_list)) == NULL){
-                       rte_errno = E_RTE_NO_TAILQ;
-                       return;
-               }
+       if ((ring_list = 
+            RTE_TAILQ_LOOKUP_BY_IDX(RTE_TAILQ_RING, rte_ring_list)) == NULL) {
+               rte_errno = E_RTE_NO_TAILQ;
+               return; 
+       }
+
+       rte_rwlock_read_lock(RTE_EAL_TAILQ_RWLOCK);
 
        TAILQ_FOREACH(mp, ring_list, next) {
-               rte_ring_dump(mp);
+               rte_ring_dump(f, mp);
        }
+
+       rte_rwlock_read_unlock(RTE_EAL_TAILQ_RWLOCK);
 }
 
 /* search a ring from its name */
@@ -262,19 +296,24 @@ struct rte_ring *
 rte_ring_lookup(const char *name)
 {
        struct rte_ring *r;
+       struct rte_ring_list *ring_list;
 
-       /* check that we have an initialised tail queue */
-       if (ring_list == NULL)
-               if ((ring_list = RTE_TAILQ_RESERVE("RTE_RING", rte_ring_list)) == NULL){
-                       rte_errno = E_RTE_NO_TAILQ;
-                       return NULL;
-               }
+       /* check that we have an initialized tail queue */
+       if ((ring_list = 
+            RTE_TAILQ_LOOKUP_BY_IDX(RTE_TAILQ_RING, rte_ring_list)) == NULL) {
+               rte_errno = E_RTE_NO_TAILQ;
+               return NULL;    
+       }
 
+       rte_rwlock_read_lock(RTE_EAL_TAILQ_RWLOCK);
+       
        TAILQ_FOREACH(r, ring_list, next) {
                if (strncmp(name, r->name, RTE_RING_NAMESIZE) == 0)
                        break;
        }
 
+       rte_rwlock_read_unlock(RTE_EAL_TAILQ_RWLOCK);
+
        if (r == NULL)
                rte_errno = ENOENT;