atomic_fetch_sub, atomic_fetch_sub_explicit

< c‎ | atomic
Defined in header <stdatomic.h>
C atomic_fetch_sub( volatile A* obj, M arg );
(1) (since C11)
C atomic_fetch_sub_explicit( volatile A* obj, M arg, memory_order order );
(2) (since C11)

Atomically replaces the value pointed by obj with the result of subtraction of arg from the old value of obj, and returns the value obj held previously. The operation is read-modify-write operation. The first version orders memory accesses according to memory_order_seq_cst, the second version orders memory accesses according to order.

This is a generic function defined for all atomic object types. A is the type of an atomic object, M is either the non-atomic type corresponding to A if A is atomic integer type, or ptrdiff_t if A is atomic pointer type.

For signed integer types, arithmetic is defined to use two’s complement representation. There are no undefined results. For pointer types, the result may be an undefined address, but the operations otherwise have no undefined behavior.


[edit] Parameters

obj - pointer to the atomic object to modify
arg - the value to subtract from the value stored in the atomic object
order - the memory synchronization ordering for this operation: all values are permitted

[edit] Return value

The value held previously be the atomic object pointed to by obj.

[edit] References

  • C11 standard (ISO/IEC 9899:2011):
  • The atomic_fetch and modify generic functions (p: 284-285)

[edit] See also

atomic addition
(function) [edit]
C++ documentation for atomic_fetch_sub, atomic_fetch_sub_explicit