timer: remove useless check on x86 TSC reliability
[dpdk.git] / lib / librte_ring / rte_ring_c11_mem.h
index 8ccb937..0fb73a3 100644 (file)
@@ -1,66 +1,11 @@
-/*-
- *   BSD LICENSE
- *
- *   Copyright(c) 2017 HXT-semitech Corporation.
- *
- *   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 HXT-semitech 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.h
- *
- **************************************************************************
+/* SPDX-License-Identifier: BSD-3-Clause
  *
+ * Copyright (c) 2017,2018 HXT-semitech Corporation.
  * Copyright (c) 2007-2009 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.
+ */
 
 #ifndef _RTE_RING_C11_MEM_H_
 #define _RTE_RING_C11_MEM_H_
@@ -106,24 +51,31 @@ update_tail(struct rte_ring_headtail *ht, uint32_t old_val, uint32_t new_val,
  *   If behavior == RTE_RING_QUEUE_FIXED, this will be 0 or n only.
  */
 static __rte_always_inline unsigned int
-__rte_ring_move_prod_head(struct rte_ring *r, int is_sp,
+__rte_ring_move_prod_head(struct rte_ring *r, unsigned int is_sp,
                unsigned int n, enum rte_ring_queue_behavior behavior,
                uint32_t *old_head, uint32_t *new_head,
                uint32_t *free_entries)
 {
        const uint32_t capacity = r->capacity;
+       uint32_t cons_tail;
        unsigned int max = n;
        int success;
 
+       *old_head = __atomic_load_n(&r->prod.head, __ATOMIC_RELAXED);
        do {
                /* Reset n to the initial burst count */
                n = max;
 
-               *old_head = __atomic_load_n(&r->prod.head,
+               /* Ensure the head is read before tail */
+               __atomic_thread_fence(__ATOMIC_ACQUIRE);
+
+               /* load-acquire synchronize with store-release of ht->tail
+                * in update_tail.
+                */
+               cons_tail = __atomic_load_n(&r->cons.tail,
                                        __ATOMIC_ACQUIRE);
-               const uint32_t cons_tail = r->cons.tail;
-               /*
-                *  The subtraction is done between two unsigned 32bits value
+
+               /* The subtraction is done between two unsigned 32bits value
                 * (the result is always modulo 32 bits even if we have
                 * *old_head > cons_tail). So 'free_entries' is always between 0
                 * and capacity (which is < size).
@@ -142,9 +94,10 @@ __rte_ring_move_prod_head(struct rte_ring *r, int is_sp,
                if (is_sp)
                        r->prod.head = *new_head, success = 1;
                else
+                       /* on failure, *old_head is updated */
                        success = __atomic_compare_exchange_n(&r->prod.head,
                                        old_head, *new_head,
-                                       0, __ATOMIC_ACQUIRE,
+                                       0, __ATOMIC_RELAXED,
                                        __ATOMIC_RELAXED);
        } while (unlikely(success == 0));
        return n;
@@ -180,15 +133,24 @@ __rte_ring_move_cons_head(struct rte_ring *r, int is_sc,
                uint32_t *entries)
 {
        unsigned int max = n;
+       uint32_t prod_tail;
        int success;
 
        /* move cons.head atomically */
+       *old_head = __atomic_load_n(&r->cons.head, __ATOMIC_RELAXED);
        do {
                /* Restore n as it may change every loop */
                n = max;
-               *old_head = __atomic_load_n(&r->cons.head,
+
+               /* Ensure the head is read before tail */
+               __atomic_thread_fence(__ATOMIC_ACQUIRE);
+
+               /* this load-acquire synchronize with store-release of ht->tail
+                * in update_tail.
+                */
+               prod_tail = __atomic_load_n(&r->prod.tail,
                                        __ATOMIC_ACQUIRE);
-               const uint32_t prod_tail = r->prod.tail;
+
                /* The subtraction is done between two unsigned 32bits value
                 * (the result is always modulo 32 bits even if we have
                 * cons_head > prod_tail). So 'entries' is always between 0
@@ -207,9 +169,10 @@ __rte_ring_move_cons_head(struct rte_ring *r, int is_sc,
                if (is_sc)
                        r->cons.head = *new_head, success = 1;
                else
+                       /* on failure, *old_head will be updated */
                        success = __atomic_compare_exchange_n(&r->cons.head,
                                                        old_head, *new_head,
-                                                       0, __ATOMIC_ACQUIRE,
+                                                       0, __ATOMIC_RELAXED,
                                                        __ATOMIC_RELAXED);
        } while (unlikely(success == 0));
        return n;