View source code Display the source code in core/bitop.d from which this page was generated on github. 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. Page wiki View or edit the community-maintained wiki page associated with this page.

Function core.bitop.volatileStore

Read/write value from/to the memory location indicated by ptr.

These functions are recognized by the compiler, and calls to them are guaranteed to not be removed (as dead assignment elimination or presumed to have no effect) or reordered in the same thread.

These reordering guarantees are only made with regards to other operations done through these functions; the compiler is free to reorder regular loads/stores with regards to loads/stores done through these functions.

This is useful when dealing with memory-mapped I/O (MMIO) where a store can have an effect other than just writing a value, or where sequential loads with no intervening stores can retrieve different values from the same location due to external stores to the location.

These functions will, when possible, do the load/store as a single operation. In general, this is possible when the size of the operation is less than or equal to (void*).sizeof, although some targets may support larger operations. If the load/store cannot be done as a single operation, multiple smaller operations will be used.

These are not to be conflated with atomic operations. They do not guarantee any atomicity. This may be provided by coincidence as a result of the instructions used on the target, but this should not be relied on for portable programs. Further, no memory fences are implied by these functions. They should not be used for communication between threads. They may be used to guarantee a write or read cycle occurs at a specified address.

Prototypes

void volatileStore(
  ubyte* ptr,
  ubyte value
) nothrow @nogc @safe;

void volatileStore(
  ushort* ptr,
  ushort value
) nothrow @nogc @safe;

void volatileStore(
  uint* ptr,
  uint value
) nothrow @nogc @safe;

void volatileStore(
  ulong* ptr,
  ulong value
) nothrow @nogc @safe;

Authors

Don Clugston, Sean Kelly, Walter Bright, Alex Rønne Petersen

License

Boost License 1.0

Comments