rcutils  master
C API providing common utilities and data structures.
Macros | Typedefs | Enumerations | Functions
stdatomic.h File Reference
#include <stddef.h>
#include <stdint.h>
Include dependency graph for stdatomic.h:

Go to the source code of this file.

Macros

#define __has_feature(x)   0
 
#define __has_builtin(x)   0
 
#define __GNUC_PREREQ__(maj, min)   0
 
#define _Atomic(T)   struct { volatile __typeof__(T) __val; }
 
#define ATOMIC_VAR_INIT(value)   { .__val = (value) }
 
#define atomic_init(obj, value)
 
#define __ATOMIC_RELAXED   0
 
#define __ATOMIC_CONSUME   1
 
#define __ATOMIC_ACQUIRE   2
 
#define __ATOMIC_RELEASE   3
 
#define __ATOMIC_ACQ_REL   4
 
#define __ATOMIC_SEQ_CST   5
 
#define atomic_thread_fence(order)   __sync_synchronize()
 
#define atomic_signal_fence(order)   __asm volatile ("" : : : "memory")
 
#define atomic_is_lock_free(obj)   (sizeof((obj)->__val) <= sizeof(void *))
 
#define atomic_compare_exchange_strong_explicit(object, expected, desired, success, failure)
 
#define atomic_compare_exchange_weak_explicit(object, expected, desired, success, failure)
 
#define atomic_exchange_explicit(object, desired, order)
 
#define atomic_fetch_add_explicit(object, operand, order)   __sync_fetch_and_add(&(object)->__val, operand)
 
#define atomic_fetch_and_explicit(object, operand, order)   __sync_fetch_and_and(&(object)->__val, operand)
 
#define atomic_fetch_or_explicit(object, operand, order)   __sync_fetch_and_or(&(object)->__val, operand)
 
#define atomic_fetch_sub_explicit(object, operand, order)   __sync_fetch_and_sub(&(object)->__val, operand)
 
#define atomic_fetch_xor_explicit(object, operand, order)   __sync_fetch_and_xor(&(object)->__val, operand)
 
#define atomic_load_explicit(object, order)   __sync_fetch_and_add(&(object)->__val, 0)
 
#define atomic_store_explicit(object, desired, order)
 
#define atomic_compare_exchange_strong(object, expected, desired)
 
#define atomic_compare_exchange_weak(object, expected, desired)
 
#define atomic_exchange(object, desired)   atomic_exchange_explicit(object, desired, memory_order_seq_cst)
 
#define atomic_fetch_add(object, operand)   atomic_fetch_add_explicit(object, operand, memory_order_seq_cst)
 
#define atomic_fetch_and(object, operand)   atomic_fetch_and_explicit(object, operand, memory_order_seq_cst)
 
#define atomic_fetch_or(object, operand)   atomic_fetch_or_explicit(object, operand, memory_order_seq_cst)
 
#define atomic_fetch_sub(object, operand)   atomic_fetch_sub_explicit(object, operand, memory_order_seq_cst)
 
#define atomic_fetch_xor(object, operand)   atomic_fetch_xor_explicit(object, operand, memory_order_seq_cst)
 
#define atomic_load(object)   atomic_load_explicit(object, memory_order_seq_cst)
 
#define atomic_store(object, desired)   atomic_store_explicit(object, desired, memory_order_seq_cst)
 
#define ATOMIC_FLAG_INIT   ATOMIC_VAR_INIT(0)
 
#define atomic_flag_clear_explicit(object, order)   atomic_store_explicit(object, 0, order)
 
#define atomic_flag_test_and_set_explicit(object, order)   atomic_compare_exchange_strong_explicit(object, 0, 1, order, order)
 
#define atomic_flag_clear(object)   atomic_flag_clear_explicit(object, memory_order_seq_cst)
 
#define atomic_flag_test_and_set(object)   atomic_flag_test_and_set_explicit(object, memory_order_seq_cst)
 

Typedefs

typedef enum memory_order memory_order
 
typedef atomic_bool atomic_flag
 

Enumerations

enum  memory_order {
  memory_order_relaxed = __ATOMIC_RELAXED, memory_order_consume = __ATOMIC_CONSUME, memory_order_acquire = __ATOMIC_ACQUIRE, memory_order_release = __ATOMIC_RELEASE,
  memory_order_acq_rel = __ATOMIC_ACQ_REL, memory_order_seq_cst = __ATOMIC_SEQ_CST, memory_order_relaxed = __ATOMIC_RELAXED, memory_order_consume = __ATOMIC_CONSUME,
  memory_order_acquire = __ATOMIC_ACQUIRE, memory_order_release = __ATOMIC_RELEASE, memory_order_acq_rel = __ATOMIC_ACQ_REL, memory_order_seq_cst = __ATOMIC_SEQ_CST
}
 

Functions

typedef _Atomic (_Bool) atomic_bool
 
typedef _Atomic (char) atomic_char
 
typedef _Atomic (signed char) atomic_schar
 
typedef _Atomic (unsigned char) atomic_uchar
 
typedef _Atomic (short) atomic_short
 
typedef _Atomic (unsigned short) atomic_ushort
 
typedef _Atomic (int) atomic_int
 
typedef _Atomic (unsigned int) atomic_uint
 
typedef _Atomic (long) atomic_long
 
typedef _Atomic (unsigned long) atomic_ulong
 
typedef _Atomic (long long) atomic_llong
 
typedef _Atomic (unsigned long long) atomic_ullong
 
typedef _Atomic (wchar_t) atomic_wchar_t
 
typedef _Atomic (int_least8_t) atomic_int_least8_t
 
typedef _Atomic (uint_least8_t) atomic_uint_least8_t
 
typedef _Atomic (int_least16_t) atomic_int_least16_t
 
typedef _Atomic (uint_least16_t) atomic_uint_least16_t
 
typedef _Atomic (int_least32_t) atomic_int_least32_t
 
typedef _Atomic (uint_least32_t) atomic_uint_least32_t
 
typedef _Atomic (int_least64_t) atomic_int_least64_t
 
typedef _Atomic (uint_least64_t) atomic_uint_least64_t
 
typedef _Atomic (int_fast8_t) atomic_int_fast8_t
 
typedef _Atomic (uint_fast8_t) atomic_uint_fast8_t
 
typedef _Atomic (int_fast16_t) atomic_int_fast16_t
 
typedef _Atomic (uint_fast16_t) atomic_uint_fast16_t
 
typedef _Atomic (int_fast32_t) atomic_int_fast32_t
 
typedef _Atomic (uint_fast32_t) atomic_uint_fast32_t
 
typedef _Atomic (int_fast64_t) atomic_int_fast64_t
 
typedef _Atomic (uint_fast64_t) atomic_uint_fast64_t
 
typedef _Atomic (intptr_t) atomic_intptr_t
 
typedef _Atomic (uintptr_t) atomic_uintptr_t
 
typedef _Atomic (size_t) atomic_size_t
 
typedef _Atomic (ptrdiff_t) atomic_ptrdiff_t
 
typedef _Atomic (intmax_t) atomic_intmax_t
 
typedef _Atomic (uintmax_t) atomic_uintmax_t
 

Macro Definition Documentation

◆ __has_feature

#define __has_feature (   x)    0

◆ __has_builtin

#define __has_builtin (   x)    0

◆ __GNUC_PREREQ__

#define __GNUC_PREREQ__ (   maj,
  min 
)    0

◆ _Atomic

#define _Atomic (   T)    struct { volatile __typeof__(T) __val; }

◆ ATOMIC_VAR_INIT

#define ATOMIC_VAR_INIT (   value)    { .__val = (value) }

◆ atomic_init

#define atomic_init (   obj,
  value 
)
Value:
do { \
(obj)->__val = (value); \
} while (0)

◆ __ATOMIC_RELAXED

#define __ATOMIC_RELAXED   0

◆ __ATOMIC_CONSUME

#define __ATOMIC_CONSUME   1

◆ __ATOMIC_ACQUIRE

#define __ATOMIC_ACQUIRE   2

◆ __ATOMIC_RELEASE

#define __ATOMIC_RELEASE   3

◆ __ATOMIC_ACQ_REL

#define __ATOMIC_ACQ_REL   4

◆ __ATOMIC_SEQ_CST

#define __ATOMIC_SEQ_CST   5

◆ atomic_thread_fence

#define atomic_thread_fence (   order)    __sync_synchronize()

◆ atomic_signal_fence

#define atomic_signal_fence (   order)    __asm volatile ("" : : : "memory")

◆ atomic_is_lock_free

#define atomic_is_lock_free (   obj)    (sizeof((obj)->__val) <= sizeof(void *))

◆ atomic_compare_exchange_strong_explicit

#define atomic_compare_exchange_strong_explicit (   object,
  expected,
  desired,
  success,
  failure 
)
Value:
({ \
__typeof__((object)->__val) __v; \
_Bool __r; \
__v = __sync_val_compare_and_swap(&(object)->__val, \
*(expected), desired); \
__r = *(expected) == __v; \
*(expected) = __v; \
__r; \
})

◆ atomic_compare_exchange_weak_explicit

#define atomic_compare_exchange_weak_explicit (   object,
  expected,
  desired,
  success,
  failure 
)
Value:
desired, success, failure)

◆ atomic_exchange_explicit

#define atomic_exchange_explicit (   object,
  desired,
  order 
)
Value:
({ \
__typeof__((object)->__val) __v; \
__v = __sync_lock_test_and_set(&(object)->__val, desired); \
__sync_synchronize(); \
__v; \
})

◆ atomic_fetch_add_explicit

#define atomic_fetch_add_explicit (   object,
  operand,
  order 
)    __sync_fetch_and_add(&(object)->__val, operand)

◆ atomic_fetch_and_explicit

#define atomic_fetch_and_explicit (   object,
  operand,
  order 
)    __sync_fetch_and_and(&(object)->__val, operand)

◆ atomic_fetch_or_explicit

#define atomic_fetch_or_explicit (   object,
  operand,
  order 
)    __sync_fetch_and_or(&(object)->__val, operand)

◆ atomic_fetch_sub_explicit

#define atomic_fetch_sub_explicit (   object,
  operand,
  order 
)    __sync_fetch_and_sub(&(object)->__val, operand)

◆ atomic_fetch_xor_explicit

#define atomic_fetch_xor_explicit (   object,
  operand,
  order 
)    __sync_fetch_and_xor(&(object)->__val, operand)

◆ atomic_load_explicit

#define atomic_load_explicit (   object,
  order 
)    __sync_fetch_and_add(&(object)->__val, 0)

◆ atomic_store_explicit

#define atomic_store_explicit (   object,
  desired,
  order 
)
Value:
do { \
__sync_synchronize(); \
(object)->__val = (desired); \
__sync_synchronize(); \
} while (0)

◆ atomic_compare_exchange_strong

#define atomic_compare_exchange_strong (   object,
  expected,
  desired 
)

◆ atomic_compare_exchange_weak

#define atomic_compare_exchange_weak (   object,
  expected,
  desired 
)

◆ atomic_exchange

#define atomic_exchange (   object,
  desired 
)    atomic_exchange_explicit(object, desired, memory_order_seq_cst)

◆ atomic_fetch_add

#define atomic_fetch_add (   object,
  operand 
)    atomic_fetch_add_explicit(object, operand, memory_order_seq_cst)

◆ atomic_fetch_and

#define atomic_fetch_and (   object,
  operand 
)    atomic_fetch_and_explicit(object, operand, memory_order_seq_cst)

◆ atomic_fetch_or

#define atomic_fetch_or (   object,
  operand 
)    atomic_fetch_or_explicit(object, operand, memory_order_seq_cst)

◆ atomic_fetch_sub

#define atomic_fetch_sub (   object,
  operand 
)    atomic_fetch_sub_explicit(object, operand, memory_order_seq_cst)

◆ atomic_fetch_xor

#define atomic_fetch_xor (   object,
  operand 
)    atomic_fetch_xor_explicit(object, operand, memory_order_seq_cst)

◆ atomic_load

#define atomic_load (   object)    atomic_load_explicit(object, memory_order_seq_cst)

◆ atomic_store

#define atomic_store (   object,
  desired 
)    atomic_store_explicit(object, desired, memory_order_seq_cst)

◆ ATOMIC_FLAG_INIT

#define ATOMIC_FLAG_INIT   ATOMIC_VAR_INIT(0)

◆ atomic_flag_clear_explicit

#define atomic_flag_clear_explicit (   object,
  order 
)    atomic_store_explicit(object, 0, order)

◆ atomic_flag_test_and_set_explicit

#define atomic_flag_test_and_set_explicit (   object,
  order 
)    atomic_compare_exchange_strong_explicit(object, 0, 1, order, order)

◆ atomic_flag_clear

#define atomic_flag_clear (   object)    atomic_flag_clear_explicit(object, memory_order_seq_cst)

◆ atomic_flag_test_and_set

#define atomic_flag_test_and_set (   object)    atomic_flag_test_and_set_explicit(object, memory_order_seq_cst)

Typedef Documentation

◆ memory_order

typedef enum memory_order memory_order

◆ atomic_flag

typedef atomic_bool atomic_flag

Enumeration Type Documentation

◆ memory_order

Enumerator
memory_order_relaxed 
memory_order_consume 
memory_order_acquire 
memory_order_release 
memory_order_acq_rel 
memory_order_seq_cst 
memory_order_relaxed 
memory_order_consume 
memory_order_acquire 
memory_order_release 
memory_order_acq_rel 
memory_order_seq_cst 

Function Documentation

◆ _Atomic() [1/35]

typedef _Atomic ( _Bool  )

◆ _Atomic() [2/35]

typedef _Atomic ( char  )

◆ _Atomic() [3/35]

typedef _Atomic ( signed char  )

◆ _Atomic() [4/35]

typedef _Atomic ( unsigned char  )

◆ _Atomic() [5/35]

typedef _Atomic ( short  )

◆ _Atomic() [6/35]

typedef _Atomic ( unsigned short  )

◆ _Atomic() [7/35]

typedef _Atomic ( int  )

◆ _Atomic() [8/35]

typedef _Atomic ( unsigned int  )

◆ _Atomic() [9/35]

typedef _Atomic ( long  )

◆ _Atomic() [10/35]

typedef _Atomic ( unsigned long  )

◆ _Atomic() [11/35]

typedef _Atomic ( long long  )

◆ _Atomic() [12/35]

typedef _Atomic ( unsigned long long  )

◆ _Atomic() [13/35]

typedef _Atomic ( wchar_t  )

◆ _Atomic() [14/35]

typedef _Atomic ( int_least8_t  )

◆ _Atomic() [15/35]

typedef _Atomic ( uint_least8_t  )

◆ _Atomic() [16/35]

typedef _Atomic ( int_least16_t  )

◆ _Atomic() [17/35]

typedef _Atomic ( uint_least16_t  )

◆ _Atomic() [18/35]

typedef _Atomic ( int_least32_t  )

◆ _Atomic() [19/35]

typedef _Atomic ( uint_least32_t  )

◆ _Atomic() [20/35]

typedef _Atomic ( int_least64_t  )

◆ _Atomic() [21/35]

typedef _Atomic ( uint_least64_t  )

◆ _Atomic() [22/35]

typedef _Atomic ( int_fast8_t  )

◆ _Atomic() [23/35]

typedef _Atomic ( uint_fast8_t  )

◆ _Atomic() [24/35]

typedef _Atomic ( int_fast16_t  )

◆ _Atomic() [25/35]

typedef _Atomic ( uint_fast16_t  )

◆ _Atomic() [26/35]

typedef _Atomic ( int_fast32_t  )

◆ _Atomic() [27/35]

typedef _Atomic ( uint_fast32_t  )

◆ _Atomic() [28/35]

typedef _Atomic ( int_fast64_t  )

◆ _Atomic() [29/35]

typedef _Atomic ( uint_fast64_t  )

◆ _Atomic() [30/35]

typedef _Atomic ( intptr_t  )

◆ _Atomic() [31/35]

typedef _Atomic ( uintptr_t  )

◆ _Atomic() [32/35]

typedef _Atomic ( size_t  )

◆ _Atomic() [33/35]

typedef _Atomic ( ptrdiff_t  )

◆ _Atomic() [34/35]

typedef _Atomic ( intmax_t  )

◆ _Atomic() [35/35]

typedef _Atomic ( uintmax_t  )
atomic_compare_exchange_strong_explicit
#define atomic_compare_exchange_strong_explicit(object, expected, desired, success, failure)
Definition: stdatomic.h:304
memory_order_seq_cst
@ memory_order_seq_cst
Definition: stdatomic.h:166
atomic_compare_exchange_weak_explicit
#define atomic_compare_exchange_weak_explicit(object, expected, desired, success, failure)
Definition: stdatomic.h:315