View source code
Display the source code in core/atomic.d from which this page was generated on github.
Report a bug
If you spot a problem with this page, click here to create a Bugzilla issue.
Improve this page
Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using local clone.

Module core.atomic

The atomic module provides basic support for lock-free concurrent programming.

Note: Use the -preview=nosharedaccess compiler flag to detect unsafe individual read or write operations on shared data.

Example

int y = 2;
shared int x = y; // OK

//x++; // read modify write error
x.atomicOp!"+="(1); // OK
//y = x; // read error with preview flag
y = x.atomicLoad(); // OK
writeln(y); // 3
//x = 5; // write error with preview flag
x.atomicStore(5); // OK
writeln(x.atomicLoad()); // 5

Functions

NameDescription
atomicExchange(here, exchangeWith) Exchange exchangeWith with the memory referenced by here. This operation is both lock-free and atomic.
atomicFence() Inserts a full load/store memory fence (on platforms that need it). This ensures that all loads and stores before a call to this function are executed before any loads and stores after the call.
atomicFetchAdd(val, mod) Atomically adds mod to the value referenced by val and returns the value val held previously. This operation is both lock-free and atomic.
atomicFetchSub(val, mod) Atomically subtracts mod from the value referenced by val and returns the value val held previously. This operation is both lock-free and atomic.
atomicLoad(val) Loads 'val' from memory and returns it. The memory barrier specified by 'ms' is applied to the operation, which is fully sequenced by default. Valid memory orders are MemoryOrder.raw, MemoryOrder.acq, and MemoryOrder.seq.
atomicOp(val, mod) Performs the binary operation 'op' on val using 'mod' as the modifier.
atomicStore(val, newval) Writes 'newval' into 'val'. The memory barrier specified by 'ms' is applied to the operation, which is fully sequenced by default. Valid memory orders are MemoryOrder.raw, MemoryOrder.rel, and MemoryOrder.seq.
casWeak(here, ifThis, writeThis) Stores 'writeThis' to the memory referenced by 'here' if the value referenced by 'here' is equal to 'ifThis'. The 'weak' version of cas may spuriously fail. It is recommended to use casWeak only when cas would be used in a loop. This operation is both lock-free and atomic.
casWeak(here, ifThis, writeThis) Stores 'writeThis' to the memory referenced by 'here' if the value referenced by 'here' is equal to the value referenced by 'ifThis'. The prior value referenced by 'here' is written to ifThis and returned to the user. The 'weak' version of cas may spuriously fail. It is recommended to use casWeak only when cas would be used in a loop. This operation is both lock-free and atomic.
pause() Gives a hint to the processor that the calling thread is in a 'spin-wait' loop, allowing to more efficiently allocate resources.

Enums

NameDescription
MemoryOrder Specifies the memory ordering semantics of an atomic operation.

Templates

NameDescription
cas Performs either compare-and-set or compare-and-swap (or exchange).

Authors

Sean Kelly, Alex Rønne Petersen, Manu Evans

License

Boost License 1.0