rte_atomic.h File Reference

#include <stdint.h>

Data Structures
struct	rte_atomic16_t
struct	rte_atomic32_t
struct	rte_atomic64_t

Macros
#define	rte_compiler_barrier()
#define	RTE_ATOMIC16_INIT(val)   { (val) }
#define	RTE_ATOMIC32_INIT(val)   { (val) }
#define	RTE_ATOMIC64_INIT(val)   { (val) }

Functions
static void	rte_mb (void)
static void	rte_wmb (void)
static void	rte_rmb (void)
static int	rte_atomic16_cmpset (volatile uint16_t *dst, uint16_t exp, uint16_t src)
static void	rte_atomic16_init (rte_atomic16_t *v)
static int16_t	rte_atomic16_read (const rte_atomic16_t *v)
static void	rte_atomic16_set (rte_atomic16_t *v, int16_t new_value)
static void	rte_atomic16_add (rte_atomic16_t *v, int16_t inc)
static void	rte_atomic16_sub (rte_atomic16_t *v, int16_t dec)
static void	rte_atomic16_inc (rte_atomic16_t *v)
static void	rte_atomic16_dec (rte_atomic16_t *v)
static int16_t	rte_atomic16_add_return (rte_atomic16_t *v, int16_t inc)
static int16_t	rte_atomic16_sub_return (rte_atomic16_t *v, int16_t dec)
static int	rte_atomic16_inc_and_test (rte_atomic16_t *v)
static int	rte_atomic16_dec_and_test (rte_atomic16_t *v)
static int	rte_atomic16_test_and_set (rte_atomic16_t *v)
static void	rte_atomic16_clear (rte_atomic16_t *v)
static int	rte_atomic32_cmpset (volatile uint32_t *dst, uint32_t exp, uint32_t src)
static void	rte_atomic32_init (rte_atomic32_t *v)
static int32_t	rte_atomic32_read (const rte_atomic32_t *v)
static void	rte_atomic32_set (rte_atomic32_t *v, int32_t new_value)
static void	rte_atomic32_add (rte_atomic32_t *v, int32_t inc)
static void	rte_atomic32_sub (rte_atomic32_t *v, int32_t dec)
static void	rte_atomic32_inc (rte_atomic32_t *v)
static void	rte_atomic32_dec (rte_atomic32_t *v)
static int32_t	rte_atomic32_add_return (rte_atomic32_t *v, int32_t inc)
static int32_t	rte_atomic32_sub_return (rte_atomic32_t *v, int32_t dec)
static int	rte_atomic32_inc_and_test (rte_atomic32_t *v)
static int	rte_atomic32_dec_and_test (rte_atomic32_t *v)
static int	rte_atomic32_test_and_set (rte_atomic32_t *v)
static void	rte_atomic32_clear (rte_atomic32_t *v)
static int	rte_atomic64_cmpset (volatile uint64_t *dst, uint64_t exp, uint64_t src)
static void	rte_atomic64_init (rte_atomic64_t *v)
static int64_t	rte_atomic64_read (rte_atomic64_t *v)
static void	rte_atomic64_set (rte_atomic64_t *v, int64_t new_value)
static void	rte_atomic64_add (rte_atomic64_t *v, int64_t inc)
static void	rte_atomic64_sub (rte_atomic64_t *v, int64_t dec)
static void	rte_atomic64_inc (rte_atomic64_t *v)
static void	rte_atomic64_dec (rte_atomic64_t *v)
static int64_t	rte_atomic64_add_return (rte_atomic64_t *v, int64_t inc)
static int64_t	rte_atomic64_sub_return (rte_atomic64_t *v, int64_t dec)
static int	rte_atomic64_inc_and_test (rte_atomic64_t *v)
static int	rte_atomic64_dec_and_test (rte_atomic64_t *v)
static int	rte_atomic64_test_and_set (rte_atomic64_t *v)
static void	rte_atomic64_clear (rte_atomic64_t *v)

Detailed Description

Atomic Operations

This file defines a generic API for atomic operations.

Macro Definition Documentation

#define RTE_ATOMIC16_INIT

(

val

)

{ (val) }

Static initializer for an atomic counter.

#define RTE_ATOMIC32_INIT

(

val

)

{ (val) }

Static initializer for an atomic counter.

#define RTE_ATOMIC64_INIT

(

val

)

{ (val) }

Static initializer for an atomic counter.

#define rte_compiler_barrier

(

)

Value:

do {            \
        asm volatile ("" : : : "memory");       \
} while(0)

Compiler barrier.

Guarantees that operation reordering does not occur at compile time for operations directly before and after the barrier.

Function Documentation

static void rte_atomic16_add ( rte_atomic16_t *  v, int16_t  inc  )

inlinestatic

Atomically add a 16-bit value to an atomic counter.

Parameters

v	A pointer to the atomic counter.
inc	The value to be added to the counter.

static int16_t rte_atomic16_add_return ( rte_atomic16_t *  v, int16_t  inc  )

inlinestatic

Atomically add a 16-bit value to a counter and return the result.

Atomically adds the 16-bits value (inc) to the atomic counter (v) and returns the value of v after addition.

Parameters

v	A pointer to the atomic counter.
inc	The value to be added to the counter.

Returns

The value of v after the addition.

static void rte_atomic16_clear ( rte_atomic16_t *  v )

inlinestatic

Atomically set a 16-bit counter to 0.

Parameters

v	A pointer to the atomic counter.

static int rte_atomic16_cmpset ( volatile uint16_t *  dst, uint16_t  exp, uint16_t  src  )

inlinestatic

Atomic compare and set.

(atomic) equivalent to: if (*dst == exp) *dst = src (all 16-bit words)

Parameters

dst	The destination location into which the value will be written.
exp	The expected value.
src	The new value.

Returns

Non-zero on success; 0 on failure.

static void rte_atomic16_dec ( rte_atomic16_t *  v )

inlinestatic

Atomically decrement a counter by one.

Parameters

v	A pointer to the atomic counter.

static int rte_atomic16_dec_and_test ( rte_atomic16_t *  v )

inlinestatic

Atomically decrement a 16-bit counter by one and test.

Atomically decrements the atomic counter (v) by one and returns true if the result is 0, or false in all other cases.

Parameters

v	A pointer to the atomic counter.

Returns

True if the result after the decrement operation is 0; false otherwise.

static void rte_atomic16_inc ( rte_atomic16_t *  v )

inlinestatic

Atomically increment a counter by one.

Parameters

v	A pointer to the atomic counter.

static int rte_atomic16_inc_and_test ( rte_atomic16_t *  v )

inlinestatic

Atomically increment a 16-bit counter by one and test.

Atomically increments the atomic counter (v) by one and returns true if the result is 0, or false in all other cases.

Parameters

v	A pointer to the atomic counter.

Returns

True if the result after the increment operation is 0; false otherwise.

static void rte_atomic16_init ( rte_atomic16_t *  v )

inlinestatic

Initialize an atomic counter.

Parameters

v	A pointer to the atomic counter.

static int16_t rte_atomic16_read ( const rte_atomic16_t *  v )

inlinestatic

Atomically read a 16-bit value from a counter.

Parameters

v	A pointer to the atomic counter.

Returns

The value of the counter.

static void rte_atomic16_set ( rte_atomic16_t *  v, int16_t  new_value  )

inlinestatic

Atomically set a counter to a 16-bit value.

Parameters

v	A pointer to the atomic counter.
new_value	The new value for the counter.

static void rte_atomic16_sub ( rte_atomic16_t *  v, int16_t  dec  )

inlinestatic

Atomically subtract a 16-bit value from an atomic counter.

Parameters

v	A pointer to the atomic counter.
dec	The value to be subtracted from the counter.

static int16_t rte_atomic16_sub_return ( rte_atomic16_t *  v, int16_t  dec  )

inlinestatic

Atomically subtract a 16-bit value from a counter and return the result.

Atomically subtracts the 16-bit value (inc) from the atomic counter (v) and returns the value of v after the subtraction.

Parameters

v	A pointer to the atomic counter.
dec	The value to be subtracted from the counter.

Returns

The value of v after the subtraction.

static int rte_atomic16_test_and_set ( rte_atomic16_t *  v )

inlinestatic

Atomically test and set a 16-bit atomic counter.

If the counter value is already set, return 0 (failed). Otherwise, set the counter value to 1 and return 1 (success).

Parameters

v	A pointer to the atomic counter.

Returns

0 if failed; else 1, success.

static void rte_atomic32_add ( rte_atomic32_t *  v, int32_t  inc  )

inlinestatic

Atomically add a 32-bit value to an atomic counter.

Parameters

v	A pointer to the atomic counter.
inc	The value to be added to the counter.

static int32_t rte_atomic32_add_return ( rte_atomic32_t *  v, int32_t  inc  )

inlinestatic

Atomically add a 32-bit value to a counter and return the result.

Atomically adds the 32-bits value (inc) to the atomic counter (v) and returns the value of v after addition.

Parameters

v	A pointer to the atomic counter.
inc	The value to be added to the counter.

Returns

The value of v after the addition.

static void rte_atomic32_clear ( rte_atomic32_t *  v )

inlinestatic

Atomically set a 32-bit counter to 0.

Parameters

v	A pointer to the atomic counter.

static int rte_atomic32_cmpset ( volatile uint32_t *  dst, uint32_t  exp, uint32_t  src  )

inlinestatic

Atomic compare and set.

(atomic) equivalent to: if (*dst == exp) *dst = src (all 32-bit words)

Parameters

dst	The destination location into which the value will be written.
exp	The expected value.
src	The new value.

Returns

Non-zero on success; 0 on failure.

static void rte_atomic32_dec ( rte_atomic32_t *  v )

inlinestatic

Atomically decrement a counter by one.

Parameters

v	A pointer to the atomic counter.

static int rte_atomic32_dec_and_test ( rte_atomic32_t *  v )

inlinestatic

Atomically decrement a 32-bit counter by one and test.

Atomically decrements the atomic counter (v) by one and returns true if the result is 0, or false in all other cases.

Parameters

v	A pointer to the atomic counter.

Returns

True if the result after the decrement operation is 0; false otherwise.

static void rte_atomic32_inc ( rte_atomic32_t *  v )

inlinestatic

Atomically increment a counter by one.

Parameters

v	A pointer to the atomic counter.

static int rte_atomic32_inc_and_test ( rte_atomic32_t *  v )

inlinestatic

Atomically increment a 32-bit counter by one and test.

Atomically increments the atomic counter (v) by one and returns true if the result is 0, or false in all other cases.

Parameters

v	A pointer to the atomic counter.

Returns

True if the result after the increment operation is 0; false otherwise.

static void rte_atomic32_init ( rte_atomic32_t *  v )

inlinestatic

Initialize an atomic counter.

Parameters

v	A pointer to the atomic counter.

static int32_t rte_atomic32_read ( const rte_atomic32_t *  v )

inlinestatic

Atomically read a 32-bit value from a counter.

Parameters

v	A pointer to the atomic counter.

Returns

The value of the counter.

static void rte_atomic32_set ( rte_atomic32_t *  v, int32_t  new_value  )

inlinestatic

Atomically set a counter to a 32-bit value.

Parameters

v	A pointer to the atomic counter.
new_value	The new value for the counter.

static void rte_atomic32_sub ( rte_atomic32_t *  v, int32_t  dec  )

inlinestatic

Atomically subtract a 32-bit value from an atomic counter.

Parameters

v	A pointer to the atomic counter.
dec	The value to be subtracted from the counter.

static int32_t rte_atomic32_sub_return ( rte_atomic32_t *  v, int32_t  dec  )

inlinestatic

Atomically subtract a 32-bit value from a counter and return the result.

Atomically subtracts the 32-bit value (inc) from the atomic counter (v) and returns the value of v after the subtraction.

Parameters

v	A pointer to the atomic counter.
dec	The value to be subtracted from the counter.

Returns

The value of v after the subtraction.

static int rte_atomic32_test_and_set ( rte_atomic32_t *  v )

inlinestatic

Atomically test and set a 32-bit atomic counter.

If the counter value is already set, return 0 (failed). Otherwise, set the counter value to 1 and return 1 (success).

Parameters

v	A pointer to the atomic counter.

Returns

0 if failed; else 1, success.

static void rte_atomic64_add ( rte_atomic64_t *  v, int64_t  inc  )

inlinestatic

Atomically add a 64-bit value to a counter.

Parameters

v	A pointer to the atomic counter.
inc	The value to be added to the counter.

static int64_t rte_atomic64_add_return ( rte_atomic64_t *  v, int64_t  inc  )

inlinestatic

Add a 64-bit value to an atomic counter and return the result.

Atomically adds the 64-bit value (inc) to the atomic counter (v) and returns the value of v after the addition.

Parameters

v	A pointer to the atomic counter.
inc	The value to be added to the counter.

Returns

The value of v after the addition.

static void rte_atomic64_clear ( rte_atomic64_t *  v )

inlinestatic

Atomically set a 64-bit counter to 0.

Parameters

v	A pointer to the atomic counter.

static int rte_atomic64_cmpset ( volatile uint64_t *  dst, uint64_t  exp, uint64_t  src  )

inlinestatic

An atomic compare and set function used by the mutex functions. (atomic) equivalent to: if (*dst == exp) *dst = src (all 64-bit words)

Parameters

dst	The destination into which the value will be written.
exp	The expected value.
src	The new value.

Returns

Non-zero on success; 0 on failure.

static void rte_atomic64_dec ( rte_atomic64_t *  v )

inlinestatic

Atomically decrement a 64-bit counter by one and test.

Parameters

v	A pointer to the atomic counter.

static int rte_atomic64_dec_and_test ( rte_atomic64_t *  v )

inlinestatic

Atomically decrement a 64-bit counter by one and test.

Atomically decrements the atomic counter (v) by one and returns true if the result is 0, or false in all other cases.

Parameters

v	A pointer to the atomic counter.

Returns

True if the result after subtraction is 0; false otherwise.

static void rte_atomic64_inc ( rte_atomic64_t *  v )

inlinestatic

Atomically increment a 64-bit counter by one and test.

Parameters

v	A pointer to the atomic counter.

static int rte_atomic64_inc_and_test ( rte_atomic64_t *  v )

inlinestatic

Atomically increment a 64-bit counter by one and test.

Atomically increments the atomic counter (v) by one and returns true if the result is 0, or false in all other cases.

Parameters

v	A pointer to the atomic counter.

Returns

True if the result after the addition is 0; false otherwise.

static void rte_atomic64_init ( rte_atomic64_t *  v )

inlinestatic

Initialize the atomic counter.

Parameters

v	A pointer to the atomic counter.

static int64_t rte_atomic64_read ( rte_atomic64_t *  v )

inlinestatic

Atomically read a 64-bit counter.

Parameters

v	A pointer to the atomic counter.

Returns

The value of the counter.

static void rte_atomic64_set ( rte_atomic64_t *  v, int64_t  new_value  )

inlinestatic

Atomically set a 64-bit counter.

Parameters

v	A pointer to the atomic counter.
new_value	The new value of the counter.

static void rte_atomic64_sub ( rte_atomic64_t *  v, int64_t  dec  )

inlinestatic

Atomically subtract a 64-bit value from a counter.

Parameters

v	A pointer to the atomic counter.
dec	The value to be subtracted from the counter.

static int64_t rte_atomic64_sub_return ( rte_atomic64_t *  v, int64_t  dec  )

inlinestatic

Subtract a 64-bit value from an atomic counter and return the result.

Atomically subtracts the 64-bit value (dec) from the atomic counter (v) and returns the value of v after the subtraction.

Parameters

v	A pointer to the atomic counter.
dec	The value to be subtracted from the counter.

Returns

The value of v after the subtraction.

static int rte_atomic64_test_and_set ( rte_atomic64_t *  v )

inlinestatic

Atomically test and set a 64-bit atomic counter.

If the counter value is already set, return 0 (failed). Otherwise, set the counter value to 1 and return 1 (success).

Parameters

v	A pointer to the atomic counter.

Returns

0 if failed; else 1, success.

static void rte_mb ( void  )

inlinestatic

General memory barrier.

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 void rte_rmb ( void  )

inlinestatic

Read memory barrier.

Guarantees that the LOAD operations generated before the barrier occur before the LOAD operations generated after. This function is architecture dependent.

static void rte_wmb ( void  )

inlinestatic

Write memory barrier.

Guarantees that the STORE operations generated before the barrier occur before the STORE operations generated after. This function is architecture dependent.