ring: convert license headers to SPDX tags
[dpdk.git] / lib / librte_ring / rte_ring.c
index 93a8692..d215ace 100644 (file)
@@ -1,67 +1,11 @@
-/*-
- *   BSD LICENSE
- *
- *   Copyright(c) 2010-2015 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
- *   are met:
- *
- *     * 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
- *       distribution.
- *     * 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
- *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-/*
- * Derived from FreeBSD's bufring.c
- *
- **************************************************************************
+/* SPDX-License-Identifier: BSD-3-Clause
  *
+ * Copyright (c) 2010-2015 Intel Corporation
  * Copyright (c) 2007,2008 Kip Macy kmacy@freebsd.org
  * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * 1. Redistributions of source code must retain the above copyright notice,
- *    this list of conditions and the following disclaimer.
- *
- * 2. The name of Kip Macy nor the names of other
- *    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 OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- * POSSIBILITY OF SUCH DAMAGE.
- *
- ***************************************************************************/
+ * Derived from FreeBSD's bufring.h
+ * Used as BSD-3 Licensed with permission from Kip Macy.
+ */
 
 #include <stdio.h>
 #include <stdarg.h>
@@ -131,12 +75,6 @@ rte_ring_init(struct rte_ring *r, const char *name, unsigned count,
                          RTE_CACHE_LINE_MASK) != 0);
        RTE_BUILD_BUG_ON((offsetof(struct rte_ring, prod) &
                          RTE_CACHE_LINE_MASK) != 0);
-#ifdef RTE_LIBRTE_RING_DEBUG
-       RTE_BUILD_BUG_ON((sizeof(struct rte_ring_debug_stats) &
-                         RTE_CACHE_LINE_MASK) != 0);
-       RTE_BUILD_BUG_ON((offsetof(struct rte_ring, stats) &
-                         RTE_CACHE_LINE_MASK) != 0);
-#endif
 
        /* init the ring structure */
        memset(r, 0, sizeof(*r));
@@ -144,11 +82,24 @@ rte_ring_init(struct rte_ring *r, const char *name, unsigned count,
        if (ret < 0 || ret >= (int)sizeof(r->name))
                return -ENAMETOOLONG;
        r->flags = flags;
-       r->prod.watermark = count;
-       r->prod.single = !!(flags & RING_F_SP_ENQ);
-       r->cons.single = !!(flags & RING_F_SC_DEQ);
-       r->prod.size = r->cons.size = count;
-       r->prod.mask = r->cons.mask = count-1;
+       r->prod.single = (flags & RING_F_SP_ENQ) ? __IS_SP : __IS_MP;
+       r->cons.single = (flags & RING_F_SC_DEQ) ? __IS_SC : __IS_MC;
+
+       if (flags & RING_F_EXACT_SZ) {
+               r->size = rte_align32pow2(count + 1);
+               r->mask = r->size - 1;
+               r->capacity = count;
+       } else {
+               if ((!POWEROF2(count)) || (count > RTE_RING_SZ_MASK)) {
+                       RTE_LOG(ERR, RING,
+                               "Requested size is invalid, must be power of 2, and not exceed the size limit %u\n",
+                               RTE_RING_SZ_MASK);
+                       return -EINVAL;
+               }
+               r->size = count;
+               r->mask = count - 1;
+               r->capacity = r->mask;
+       }
        r->prod.head = r->cons.head = 0;
        r->prod.tail = r->cons.tail = 0;
 
@@ -167,10 +118,15 @@ rte_ring_create(const char *name, unsigned count, int socket_id,
        ssize_t ring_size;
        int mz_flags = 0;
        struct rte_ring_list* ring_list = NULL;
+       const unsigned int requested_count = count;
        int ret;
 
        ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
 
+       /* for an exact size ring, round up from count to a power of two */
+       if (flags & RING_F_EXACT_SZ)
+               count = rte_align32pow2(count + 1);
+
        ring_size = rte_ring_get_memsize(count);
        if (ring_size < 0) {
                rte_errno = ring_size;
@@ -196,12 +152,13 @@ rte_ring_create(const char *name, unsigned count, int socket_id,
        /* 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);
+       mz = rte_memzone_reserve_aligned(mz_name, ring_size, socket_id,
+                                        mz_flags, __alignof__(*r));
        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);
+               rte_ring_init(r, name, requested_count, flags);
 
                te->data = (void *) r;
                r->memzone = mz;
@@ -262,76 +219,20 @@ rte_ring_free(struct rte_ring *r)
        rte_free(te);
 }
 
-/*
- * change the high water mark. If *count* is 0, water marking is
- * disabled
- */
-int
-rte_ring_set_water_mark(struct rte_ring *r, unsigned count)
-{
-       if (count >= r->prod.size)
-               return -EINVAL;
-
-       /* if count is 0, disable the watermarking */
-       if (count == 0)
-               count = r->prod.size;
-
-       r->prod.watermark = count;
-       return 0;
-}
-
 /* dump the status of the ring on the console */
 void
 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
-
        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, "  size=%"PRIu32"\n", r->size);
+       fprintf(f, "  capacity=%"PRIu32"\n", r->capacity);
        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)
-               fprintf(f, "  watermark=0\n");
-       else
-               fprintf(f, "  watermark=%"PRIu32"\n", r->prod.watermark);
-
-       /* sum and dump statistics */
-#ifdef RTE_LIBRTE_RING_DEBUG
-       memset(&sum, 0, sizeof(sum));
-       for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
-               sum.enq_success_bulk += r->stats[lcore_id].enq_success_bulk;
-               sum.enq_success_objs += r->stats[lcore_id].enq_success_objs;
-               sum.enq_quota_bulk += r->stats[lcore_id].enq_quota_bulk;
-               sum.enq_quota_objs += r->stats[lcore_id].enq_quota_objs;
-               sum.enq_fail_bulk += r->stats[lcore_id].enq_fail_bulk;
-               sum.enq_fail_objs += r->stats[lcore_id].enq_fail_objs;
-               sum.deq_success_bulk += r->stats[lcore_id].deq_success_bulk;
-               sum.deq_success_objs += r->stats[lcore_id].deq_success_objs;
-               sum.deq_fail_bulk += r->stats[lcore_id].deq_fail_bulk;
-               sum.deq_fail_objs += r->stats[lcore_id].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
-       fprintf(f, "  no statistics available\n");
-#endif
 }
 
 /* dump the status of all rings on the console */