Difference between revisions of "cpp/atomic/atomic fetch and"
(cosmetic formatting) |
m (→Return value: #) |
||
(23 intermediate revisions by 10 users not shown) | |||
Line 1: | Line 1: | ||
{{cpp/title|atomic_fetch_and|atomic_fetch_and_explicit}} | {{cpp/title|atomic_fetch_and|atomic_fetch_and_explicit}} | ||
− | {{cpp/ | + | {{cpp/thread/navbar}} |
− | {{ | + | {{dcl begin}} |
− | {{ | + | {{dcl header|atomic}} |
− | {{ | + | {{dcl|num=1|since=c++11| |
− | template< class | + | template< class T > |
− | + | T atomic_fetch_and( std::atomic<T>* obj, | |
+ | typename std::atomic<T>::value_type arg ) noexcept; | ||
}} | }} | ||
− | {{ | + | {{dcl|num=2|since=c++11| |
− | template< class | + | template< class T > |
− | + | T atomic_fetch_and( volatile std::atomic<T>* obj, | |
+ | typename std::atomic<T>::value_type arg ) noexcept; | ||
}} | }} | ||
− | {{ | + | {{dcl|num=3|since=c++11| |
− | template< class | + | template< class T > |
− | + | T atomic_fetch_and_explicit( std::atomic<T>* obj, | |
− | + | typename std::atomic<T>::value_type arg, | |
+ | std::memory_order order ) noexcept; | ||
}} | }} | ||
− | {{ | + | {{dcl|num=4|since=c++11| |
− | template< class | + | template< class T > |
− | + | T atomic_fetch_and_explicit( volatile std::atomic<T>* obj, | |
− | + | typename std::atomic<T>::value_type arg, | |
+ | std::memory_order order ) noexcept; | ||
}} | }} | ||
− | {{ | + | {{dcl end}} |
− | + | Atomically replaces the value pointed by {{c|obj}} with the result of bitwise AND between the old value of {{c|obj}} and {{c|arg}}. Returns the value {{c|obj}} held previously. | |
− | + | The operation is performed as if the following is executed: | |
− | + | ||
− | {{ | + | @1,2@ {{c|obj->fetch_and(arg)}} |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
+ | @3,4@ {{c|obj->fetch_and(arg, order)}} | ||
− | + | If {{tt|std::atomic<T>}} has no {{tt|fetch_and}} member (this member is only provided for {{rlp|atomic#Specializations for integral types|integral types}} except {{c/core|bool}}), the program is ill-formed. | |
− | + | ||
− | === | + | ===Parameters=== |
− | {{ | + | {{par begin}} |
+ | {{par|obj|pointer to the atomic object to modify}} | ||
+ | {{par|arg|the value to bitwise AND to the value stored in the atomic object}} | ||
+ | {{par|order|the memory synchronization ordering}} | ||
+ | {{par end}} | ||
− | === | + | ===Return value=== |
− | {{ | + | The value immediately preceding the effects of this function in the {{lsd|cpp/atomic/memory order#Modification order}} of {{c|*obj}}. |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | }} | + | |
===Example=== | ===Example=== | ||
− | {{ | + | {{include|cpp/atomic/atomic fetch cond example}} |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ===Defect reports=== | |
− | + | {{dr list begin}} | |
− | + | {{dr list item|std=C++11|paper=P0558R1|before=exact type match was required because<br>{{tt|T}} was deduced from multiple arguments|after={{tt|T}} is only deduced<br>from obj}} | |
− | + | {{dr list end}} | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | { | + | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | }} | + | |
===See also=== | ===See also=== | ||
− | {{ | + | {{dsc begin}} |
− | {{ | + | {{dsc inc|cpp/atomic/atomic/dsc fetch_and}} |
− | {{ | + | {{dsc inc|cpp/atomic/dsc atomic_fetch_or}} |
− | {{ | + | {{dsc inc|cpp/atomic/dsc atomic_fetch_xor}} |
− | {{ | + | {{dsc see c|c/atomic/atomic_fetch_and|atomic_fetch_and|atomic_fetch_and_explicit}} |
− | {{ | + | {{dsc end}} |
− | + | {{langlinks|de|es|fr|it|ja|pt|ru|zh}} | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + |
Latest revision as of 08:11, 25 October 2023
Defined in header <atomic>
|
||
template< class T > T atomic_fetch_and( std::atomic<T>* obj, |
(1) | (since C++11) |
template< class T > T atomic_fetch_and( volatile std::atomic<T>* obj, |
(2) | (since C++11) |
template< class T > T atomic_fetch_and_explicit( std::atomic<T>* obj, |
(3) | (since C++11) |
template< class T > T atomic_fetch_and_explicit( volatile std::atomic<T>* obj, |
(4) | (since C++11) |
Atomically replaces the value pointed by obj with the result of bitwise AND between the old value of obj and arg. Returns the value obj held previously.
The operation is performed as if the following is executed:
If std::atomic<T>
has no fetch_and
member (this member is only provided for integral types except bool), the program is ill-formed.
Contents |
[edit] Parameters
obj | - | pointer to the atomic object to modify |
arg | - | the value to bitwise AND to the value stored in the atomic object |
order | - | the memory synchronization ordering |
[edit] Return value
The value immediately preceding the effects of this function in the modification order of *obj.
[edit] Example
#include <atomic> #include <chrono> #include <functional> #include <iostream> #include <thread> // Binary semaphore for demonstrative purposes only. // This is a simple yet meaningful example: atomic operations // are unnecessary without threads. class Semaphore { std::atomic_char m_signaled; public: Semaphore(bool initial = false) { m_signaled = initial; } // Block until semaphore is signaled void take() { while (!std::atomic_fetch_and(&m_signaled, false)) { std::this_thread::sleep_for(std::chrono::milliseconds(10)); } } void put() { std::atomic_fetch_or(&m_signaled, true); } }; class ThreadedCounter { static const int N = 100; static const int REPORT_INTERVAL = 10; int m_count; bool m_done; Semaphore m_count_sem; Semaphore m_print_sem; void count_up() { for (m_count = 1; m_count <= N; ++m_count) if (m_count % REPORT_INTERVAL == 0) { if (m_count == N) m_done = true; m_print_sem.put(); // signal printing to occur m_count_sem.take(); // wait until printing is complete proceeding } std::cout << "count_up() done\n"; m_done = true; m_print_sem.put(); } void print_count() { do { m_print_sem.take(); std::cout << m_count << '\n'; m_count_sem.put(); } while (!m_done); std::cout << "print_count() done\n"; } public: ThreadedCounter() : m_done(false) {} void run() { auto print_thread = std::thread(&ThreadedCounter::print_count, this); auto count_thread = std::thread(&ThreadedCounter::count_up, this); print_thread.join(); count_thread.join(); } }; int main() { ThreadedCounter m_counter; m_counter.run(); }
Output:
10 20 30 40 50 60 70 80 90 100 print_count() done count_up() done
[edit] Defect reports
The following behavior-changing defect reports were applied retroactively to previously published C++ standards.
DR | Applied to | Behavior as published | Correct behavior |
---|---|---|---|
P0558R1 | C++11 | exact type match was required becauseT was deduced from multiple arguments
|
T is only deducedfrom obj |
[edit] See also
atomically performs bitwise AND between the argument and the value of the atomic object and obtains the value held previously (public member function of std::atomic<T> )
| |
(C++11)(C++11) |
replaces the atomic object with the result of bitwise OR with a non-atomic argument and obtains the previous value of the atomic (function template) |
(C++11)(C++11) |
replaces the atomic object with the result of bitwise XOR with a non-atomic argument and obtains the previous value of the atomic (function template) |
C documentation for atomic_fetch_and, atomic_fetch_and_explicit
|