What is atomic_compare_exchange_weak_explicit in C?

atomic_compare_exchange_weak_explicit is a function that compares memory contents pointed to by two different objects. In addition, it also allows you to specify the memory order in the case of success and failure. memory_order is used as an argument to functions that involve atomic operations for synchronization of operations on other threads.

Syntax

bool atomic_compare_exchange_weak_explicit( volatile A* obj, C* expected, C desired, memory_order success, memory_order failure );

The function compares the value of obj with expected. If they are bitwise equal, it replaces the value contained in obj with the desired value. Otherwise, it replaces the value pointed by expected with the one contained in obj by performing a load operation.

The operation of the function described above, where it reads and replaces data is atomic. This means that other threads cannot change the value between the time it is read and replaced.

This function reads and compares the actual contents on the disk of the value contained in obj and the value pointed by expected. The comparison may fail for some values that compare using the == operator.

Unlike its counterpart, atomic_compare_exchange_strong, this function is allowed to fail spuriously, which means that it can act as if *obj != *expected even if they are the same and return false. This behavior might be acceptable for certain algorithms that involve loops, leading to better performance on some platforms.

Parameters

• obj is a pointer to an atomic object to be compared.
• expected is a pointer to the value that is to be compared with the one contained in obj.
• desired is the value to store in obj if the comparison is successful.
• success is the synchronization mode when the comparison is successful. All memory_order values are accepted in this argument.
• failure is the synchronization mode when the comparison is unsuccessful. All memory_order values except memory_order_release, memory_order_acq_rel and the ones stronger than success are accepted in this argument.

Return value

The function returns true if the values pointed by obj and expected are equal and false if otherwise.