ring: get size in memory
[dpdk.git] / lib / librte_ring / rte_ring.c
index 67e5223..156fe49 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.
- * 
  */
 
 /*
@@ -86,6 +85,7 @@
 #include <rte_branch_prediction.h>
 #include <rte_errno.h>
 #include <rte_string_fns.h>
+#include <rte_spinlock.h>
 
 #include "rte_ring.h"
 
@@ -94,6 +94,25 @@ TAILQ_HEAD(rte_ring_list, rte_ring);
 /* true if x is a power of 2 */
 #define POWEROF2(x) ((((x)-1) & (x)) == 0)
 
+/* return the size of memory occupied by a ring */
+ssize_t
+rte_ring_get_memsize(unsigned count)
+{
+       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;
+}
+
 /* create the ring */
 struct rte_ring *
 rte_ring_create(const char *name, unsigned count, int socket_id,
@@ -102,15 +121,17 @@ rte_ring_create(const char *name, unsigned count, int socket_id,
        char mz_name[RTE_MEMZONE_NAMESIZE];
        struct rte_ring *r;
        const struct rte_memzone *mz;
-       size_t ring_size;
+       ssize_t ring_size;
        int mz_flags = 0;
        struct rte_ring_list* ring_list = NULL;
 
        /* 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
@@ -127,15 +148,15 @@ rte_ring_create(const char *name, unsigned count, int socket_id,
                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
@@ -161,6 +182,7 @@ rte_ring_create(const char *name, unsigned count, int socket_id,
                r = NULL;
                RTE_LOG(ERR, RING, "Cannot reserve memory\n");
        }
+       rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
        
        return r;
 }
@@ -205,7 +227,6 @@ rte_ring_dump(const struct rte_ring *r)
                printf("  watermark=0\n");
        else
                printf("  watermark=%"PRIu32"\n", r->prod.watermark);
-       printf("  bulk_default=%"PRIu32"\n", r->prod.bulk_default);
 
        /* sum and dump statistics */
 #ifdef RTE_LIBRTE_RING_DEBUG
@@ -252,9 +273,13 @@ rte_ring_list_dump(void)
                return; 
        }
 
+       rte_rwlock_read_lock(RTE_EAL_TAILQ_RWLOCK);
+
        TAILQ_FOREACH(mp, ring_list, next) {
                rte_ring_dump(mp);
        }
+
+       rte_rwlock_read_unlock(RTE_EAL_TAILQ_RWLOCK);
 }
 
 /* search a ring from its name */
@@ -271,11 +296,15 @@ rte_ring_lookup(const char *name)
                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;