Namespaces
Variants
Views
Actions

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

From cppreference.com
< cpp‎ | atomic
(See also: +see c)
(grammar)
Line 8: Line 8:
 
{{ddcl list end}}
 
{{ddcl list end}}
  
An {{c|std::atomic_flag}} is an atomic boolean type. Unlike all specializations of {{c|std::atomic}}, it is guaranteed to be lock-free. Unlike {{c|std::atomic<bool>}}, {{tt|std::atomic_flag}} does not provide load or store operations.
+
{{c|std::atomic_flag}} is an atomic boolean type. Unlike all specializations of {{c|std::atomic}}, it is guaranteed to be lock-free. Unlike {{c|std::atomic<bool>}}, {{tt|std::atomic_flag}} does not provide load or store operations.
  
 
===Member functions===
 
===Member functions===

Revision as of 10:11, 28 August 2012

 
 
Concurrency support library
Threads
(C++11)
(C++20)
this_thread namespace
(C++11)
(C++11)
(C++11)
Cooperative cancellation
Mutual exclusion
(C++11)
Generic lock management
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
Condition variables
(C++11)
Semaphores
Latches and Barriers
(C++20)
(C++20)
Futures
(C++11)
(C++11)
(C++11)
(C++11)
Safe Reclamation
(C++26)
Hazard Pointers
Atomic types
(C++11)
(C++20)
atomic_flag
(C++11)
Initialization of atomic types
(C++11)(deprecated in C++20)
(C++11)(deprecated in C++20)
Memory ordering
Free functions for atomic operations
Free functions for atomic flags
 
 

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 >
class atomic_flag;
</td>

<td class="t-dcl-nopad"> </td> <td > (since C++11) </td> </tr> Template:ddcl list end

std::atomic_flag is an atomic boolean type. Unlike all specializations of std::atomic, it is guaranteed to be lock-free. Unlike std::atomic<bool>, std::atomic_flag does not provide load or store operations.

Member functions

Template:cpp/atomic/atomic flag/dcl list clearTemplate:cpp/atomic/atomic flag/dcl list test and set
constructs an atomic_flag
(public member function)
the assignment operator
(public member function)

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(lock.test_and_set(std::memory_order_acquire))  // acquire lock
             ; // spin
        std::cout << "Output from thread " << n << '\n';
        lock.clear(std::memory_order_release);               // release lock
    }
}
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 flag test and setTemplate:cpp/atomic/dcl list atomic flag clearTemplate:cpp/atomic/dcl list ATOMIC FLAG INIT
C documentation for atomic_flag