Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/atomic/atomic exchange"

From cppreference.com
< cpp‎ | atomic
m (Text replace - "/sidebar" to "/navbar")
(→‎See also: +see c)
Line 83: Line 83:
 
{{dcl list template | cpp/atomic/dcl list atomic_compare_exchange}}
 
{{dcl list template | cpp/atomic/dcl list atomic_compare_exchange}}
 
{{dcl list tfun | cpp/memory/shared_ptr/atomic_access | title=std::atomic_exchange{{dcl small|(std::shared_ptr)}}
 
{{dcl list tfun | cpp/memory/shared_ptr/atomic_access | title=std::atomic_exchange{{dcl small|(std::shared_ptr)}}
−
<br>std::atomic_exchange_explicit{{dcl small|(std::shared_ptr)}} | specializes atomic operations for std::shared_ptr }}
+
<br>std::atomic_exchange_explicit{{dcl small|(std::shared_ptr)}} | specializes atomic operations for {{c|std::shared_ptr}} }}
 +
{{dcl list see c | c/atomic/atomic_exchange | atomic_exchange | atomic_exchange_explicit}}
 
{{dcl list end}}
 
{{dcl list end}}

Revision as of 09:42, 28 August 2012

 
C++
 
Atomic operations library
Types
(C++11)
(C++20)
Functions
(C++11)(C++11)
(C++11)(C++11)
atomic_exchangeatomic_exchange_explicit
(C++11)(C++11)
(C++11)(C++11)(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)
(C++20)(C++20)
(C++20)
(C++20)
Atomic flags
(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++20)(C++20)
(C++20)(C++20)
(C++20)
(C++20)
Initialization
(C++11)(deprecated in C++20)
(C++11)(deprecated in C++20)
(C++11)(deprecated in C++20)
Memory ordering
(C++11)
(C++11)
(C++11)
(C++11)
 

Template:ddcl list begin <tr class="t-dsc-header">

<td>
Defined in header <atomic>
</td>

<td></td> <td></td> </tr> <tr class="t-dcl ">

<td >
template< class T >
T atomic_exchange( std::atomic<T>* obj, T desr );
</td>

<td > (1) </td> <td > (since C++11) </td> </tr> <tr class="t-dcl ">

<td >
template< class T >
T atomic_exchange( volatile std::atomic<T>* obj, T desr );
</td>

<td > (2) </td> <td > (since C++11) </td> </tr> <tr class="t-dcl ">

<td >
template< class T >

T atomic_exchange_explicit( std::atomic<T>* obj, T desr,

                            std::memory_order order );
</td>

<td > (3) </td> <td > (since C++11) </td> </tr> <tr class="t-dcl ">

<td >
template< class T >

T atomic_exchange_explicit( volatile std::atomic<T>* obj, T desr,

                            std::memory_order order );
</td>

<td > (4) </td> <td > (since C++11) </td> </tr> Template:ddcl list end

1-2) Atomically replaces the value pointed to by obj with the value of desr and returns the value obj held previously, as if by obj->exhange(desr)

3-4) Atomically replaces the value pointed to by obj with the value of desr and returns the value obj held previously, as if by obj->exhange(desr, order)

Contents

Parameters

obj - pointer to the atomic object to modify
desr - the value to store in the atomic object
order - the memory sycnhronization ordering for this operation: all values are permitted.

Return value

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

Exceptions

noexcept specification:  
noexcept
  

Example

A spinlock mutex can be implemented in userspace using an atomic exchange operation, similar to atomic_flag_test_and_set

Run this code
#include <thread>
#include <vector>
#include <iostream>
#include <atomic>
 
std::atomic<bool> lock = ATOMIC_VAR_INIT(false);
 
void f(int n)
{
    for(int cnt = 0; cnt < 100; ++cnt) {
        while(std::atomic_exchange_explicit(&lock, true, std::memory_order_acquire))
             ; // spin until acquired
        std::cout << "Output from thread " << n << '\n';
        std::atomic_store_explicit(&lock, false, std::memory_order_release);
    }
}
int main()
{
    std::vector<std::thread> v;
    for (int n = 0; n < 10; ++n) {
        v.emplace_back(f, n);
    }
    for (auto& t : v) {
        t.join();
    }
}

Output: 

Output from thread 2
Output from thread 6
Output from thread 7
...<exactly 1000 lines>...

See also

Template:cpp/atomic/atomic/dcl list exchangeTemplate:cpp/atomic/dcl list atomic compare exchange
 specializes atomic operations for std::shared_ptr
(function template)
C documentation for atomic_exchange, atomic_exchange_explicit
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/atomic/atomic_exchange&oldid=39111"