Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/atomic/atomic flag test and set"

From cppreference.com
< cpp‎ | atomic
(+see also, fmt)
m (r2.7.3) (Robot: Adding de, es, fr, it, ja, pt, ru, zh)
Line 103: Line 103:
 
{{dcl list see c | c/atomic/atomic_flag_test_and_set | atomic_flag_test_and_set | atomic_flag_test_and_set_explicit}}
 
{{dcl list see c | c/atomic/atomic_flag_test_and_set | atomic_flag_test_and_set | atomic_flag_test_and_set_explicit}}
 
{{dcl list end}}
 
{{dcl list end}}
 +
 +
[[de:cpp/atomic/atomic flag test and set]]
 +
[[es:cpp/atomic/atomic flag test and set]]
 +
[[fr:cpp/atomic/atomic flag test and set]]
 +
[[it:cpp/atomic/atomic flag test and set]]
 +
[[ja:cpp/atomic/atomic flag test and set]]
 +
[[pt:cpp/atomic/atomic flag test and set]]
 +
[[ru:cpp/atomic/atomic flag test and set]]
 +
[[zh:cpp/atomic/atomic flag test and set]]

Revision as of 16:13, 2 November 2012

 
 
 

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 >
bool atomic_flag_test_and_set( volatile std::atomic_flag* p );
</td>

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

<td >
bool atomic_flag_test_and_set( std::atomic_flag* p );
</td>

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

<td >
bool atomic_flag_test_and_set_explicit( volatile std::atomic_flag* p,
                                        std::memory_order order );
</td>

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

<td >
bool atomic_flag_test_and_set_explicit( std::atomic_flag* p,
                                        std::memory_order order );
</td>

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

Atomically changes the state of a std::atomic_flag pointed to by p to set (true) and returns the value it held before.

Contents

Parameters

p - pointer to std::atomic_flag to access
order - the memory synchronization order for this operation

Return value

The value previously held by the flag pointed to by p

Exceptions

noexcept specification:  
noexcept
  

Possible implementation

First version
bool atomic_flag_test_and_set(volatile std::atomic_flag* p)
{
    return p->test_and_set();
}
Second version
bool atomic_flag_test_and_set(std::atomic_flag* p)
{
    return p->test_and_set();
}
Third version
bool atomic_flag_test_and_set_explicit(volatile std::atomic_flag* p, 
                                       std::memory_order order)
{
    return p->test_and_set(order);
}
Fourth version
bool atomic_flag_test_and_set_explicit(std::atomic_flag* p, 
                                       std::memory_order order) 
{
    return p->test_and_set(order);
}

Example

A spinlock mutex can be implemented in userspace using an atomic_flag

#include <thread>
#include <vector>
#include <iostream>
#include <atomic>
 
std::atomic_flag lock = ATOMIC_FLAG_INIT;
 
void f(int n)
{
    for(int cnt = 0; cnt < 100; ++cnt) {
        while(std::atomic_flag_test_and_set_explicit(&lock, std::memory_order_acquire))
             ; // spin until the lock is acquired
        std::cout << "Output from thread " << n << '\n';
        std::atomic_flag_clear_explicit(&lock, 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/dcl list atomic flagTemplate:cpp/atomic/dcl list atomic flag clearTemplate:cpp/atomic/dcl list memory order
C documentation for atomic_flag_test_and_set, atomic_flag_test_and_set_explicit