eal: remove redundant API description
PATCH 1/1 eal: remove redundant API description
Atomic functions are described in doxygen of the file lib/librte_eal/common/include/generic/rte_atomic.h The copies in arch-specific files are redundant and confuse readers about the genericity of the API.
--- .../common/include/arch/arm/rte_atomic_32.h | 18 ------------------ .../common/include/arch/ppc_64/rte_atomic.h | 18 ------------------ .../common/include/generic/rte_atomic.h | 3 --- 3 files changed, 39 deletions(-)
lib/librte_eal/common/include/arch/arm/rte_atomic_32.h +0 -18
@@ -15,28 +15,10 @@ extern "C" {#include "generic/rte_atomic.h" -/** -* General memory barrier. -* -* Guarantees that the LOAD and STORE operations generated before the -* barrier occur before the LOAD and STORE operations generated after. -*/ #define rte_mb () __sync_synchronize() -/** -* Write memory barrier. -* -* Guarantees that the STORE operations generated before the barrier -* occur before the STORE operations generated after. -*/ #define rte_wmb () do { asm volatile ("dmb st" : : : "memory"); } while (0) -/** -* Read memory barrier. -* -* Guarantees that the LOAD operations generated before the barrier -* occur before the LOAD operations generated after. -*/ #define rte_rmb () __sync_synchronize()#define rte_smp_mb () rte_mb()
lib/librte_eal/common/include/arch/ppc_64/rte_atomic.h +0 -18
@@ -49,32 +49,14 @@ extern "C" {#include <stdint.h> #include "generic/rte_atomic.h" -/** -* General memory barrier. -* -* Guarantees that the LOAD and STORE operations generated before the -* barrier occur before the LOAD and STORE operations generated after. -*/ #define rte_mb () asm volatile("sync" : : : "memory") -/** -* Write memory barrier. -* -* Guarantees that the STORE operations generated before the barrier -* occur before the STORE operations generated after. -*/ #ifdef RTE_ARCH_64 #define rte_wmb () asm volatile("lwsync" : : : "memory")#else #define rte_wmb () asm volatile("sync" : : : "memory")#endif -/** -* Read memory barrier. -* -* Guarantees that the LOAD operations generated before the barrier -* occur before the LOAD operations generated after. -*/ #ifdef RTE_ARCH_64 #define rte_rmb () asm volatile("lwsync" : : : "memory")#else
lib/librte_eal/common/include/generic/rte_atomic.h +0 -3
@@ -25,7 +25,6 @@* * Guarantees that the LOAD and STORE operations generated before the * barrier occur before the LOAD and STORE operations generated after. -* This function is architecture dependent. */ static inline void rte_mb (void );
@@ -34,7 +33,6 @@ static inline void rte_mb(void);* * Guarantees that the STORE operations generated before the barrier * occur before the STORE operations generated after. -* This function is architecture dependent. */ static inline void rte_wmb (void );
@@ -43,7 +41,6 @@ static inline void rte_wmb(void);* * Guarantees that the LOAD operations generated before the barrier * occur before the LOAD operations generated after. -* This function is architecture dependent. */ static inline void rte_rmb (void );///@}
Signature · 1 line
2.20.1
Tuesday, March 19, 2019 11:16 PM, Thomas Monjalon:
Quoted 8 lines
Subject: [dpdk-dev] [PATCH] eal: remove redundant API description
Atomic functions are described in doxygen of the file
lib/librte_eal/common/include/generic/rte_atomic.h
The copies in arch-specific files are redundant and confuse readers about the genericity of the API.Signed-off-by Thomas Monjalon <[email protected]>
Quoted 110 lines
--- .../common/include/arch/arm/rte_atomic_32.h | 18 ------------------ .../common/include/arch/ppc_64/rte_atomic.h | 18 ------------------ .../common/include/generic/rte_atomic.h | 3 --- 3 files changed, 39 deletions(-)lib/librte_eal/common/include/arch/arm/rte_atomic_32.h +0
-18@@ -15,28 +15,10 @@ extern "C" {#include "generic/rte_atomic.h" -/** -* General memory barrier. -* -* Guarantees that the LOAD and STORE operations generated before the -* barrier occur before the LOAD and STORE operations generated after. -*/ #define rte_mb () __sync_synchronize() -/** -* Write memory barrier. -* -* Guarantees that the STORE operations generated before the barrier -* occur before the STORE operations generated after. -*/ #define rte_wmb () do { asm volatile ("dmb st" : : : "memory"); } while (0) -/** -* Read memory barrier. -* -* Guarantees that the LOAD operations generated before the barrier -* occur before the LOAD operations generated after. - */#define rte_rmb () __sync_synchronize()#define
rte_smp_mb()rte_mb()lib/librte_eal/common/include/arch/ppc_64/rte_atomic.h +0
-18@@ -49,32 +49,14 @@ extern "C" {#include <stdint.h> #include "generic/rte_atomic.h" -/** -* General memory barrier. -* -* Guarantees that the LOAD and STORE operations generated before the -* barrier occur before the LOAD and STORE operations generated after. -*/ #define rte_mb () asm volatile("sync" : : : "memory") -/** -* Write memory barrier. -* -* Guarantees that the STORE operations generated before the barrier -* occur before the STORE operations generated after. -*/ #ifdef RTE_ARCH_64 #define rte_wmb () asm volatile("lwsync" : : : "memory")#else #define rte_wmb () asm volatile("sync" : : : "memory")#endif -/** -* Read memory barrier. -* -* Guarantees that the LOAD operations generated before the barrier -* occur before the LOAD operations generated after. -*/ #ifdef RTE_ARCH_64 #define rte_rmb () asm volatile("lwsync" : : : "memory")#else lib/librte_eal/common/include/generic/rte_atomic.h +0
-4@@ -25,7 +25,6 @@* * Guarantees that the LOAD and STORE operations generated before the * barrier occur before the LOAD and STORE operations generated after. -* This function is architecture dependent. */ static inline void rte_mb (void );@@ -34,7 +33,6 @@ static inline void rte_mb(void);* * Guarantees that the STORE operations generated before the barrier * occur before the STORE operations generated after. -* This function is architecture dependent. */ static inline void rte_wmb (void );@@ -43,7 +41,6 @@ static inline void rte_wmb(void);* * Guarantees that the LOAD operations generated before the barrier * occur before the LOAD operations generated after. -* This function is architecture dependent. */ static inline void rte_rmb (void );///@} --2.20.1
Thomas Monjalon
Applied20/03/2019 07:46, Shahaf Shuler:
Quoted 11 lines
Tuesday, March 19, 2019 11:16 PM, Thomas Monjalon:
Quoted 8 lines
Subject: [dpdk-dev] [PATCH] eal: remove redundant API description
Atomic functions are described in doxygen of the file
lib/librte_eal/common/include/generic/rte_atomic.h
The copies in arch-specific files are redundant and confuse readers about the genericity of the API.Signed-off-by Thomas Monjalon <[email protected]>Acked-by Shahaf Shuler <[email protected]>
Applied