Atomic.Basic_Operations

Entities

Generic formal parameters

Simple Types

Subprograms

Description

Based on GCC atomic built-ins. See: https://gcc.gnu.org/onlinedocs/gcc/_005f_005fatomic-Builtins.html

The specification is exactly the same for all sizes of data (8, 16, 32, 64).

Compare_Exchange

function Compare_Exchange
  (This          : aliased in out Instance;
   Expected      : T;
   Desired       : T;
   Weak          : Boolean;
   Success_Order : Mem_Order := Seq_Cst;
   Failure_Order : Mem_Order := Seq_Cst) return Boolean
Parameters
This
Expected
Desired
Weak
Success_Order
Failure_Order
Return Value

Compare_Exchange

procedure Compare_Exchange
  (This          : aliased in out Instance;
   Expected      : T;
   Desired       : T;
   Weak          : Boolean;
   Success       : out Boolean;
   Success_Order : Mem_Order := Seq_Cst;
   Failure_Order : Mem_Order := Seq_Cst)
Parameters
This
Expected
Desired
Weak
Success
Success_Order
Failure_Order

Exchange

function Exchange
  (This : aliased in out Instance; Val : T; Order : Mem_Order := Seq_Cst)
   return T
Parameters
This
Val
Order
Return Value

Exchange

procedure Exchange
  (This  : aliased in out Instance;
   Val   : T;
   Old   : out T;
   Order : Mem_Order := Seq_Cst)
Parameters
This
Val
Old
Order

Init

function Init (Val : T) return Instance

Can be used to initialize an atomic instance:

A : My_Atomic_Access.Instance := My_Atomic_Access.Init (null);

Parameters
Val
Return Value

Instance

type Instance is limited private;

This type is limited and private, it can only be manipulated using the primitives below.

Load

function Load
  (This : aliased Instance; Order : Mem_Order := Seq_Cst) return T
Parameters
This
Order
Return Value

Store

procedure Store
  (This : aliased in out Instance; Val : T; Order : Mem_Order := Seq_Cst)
Parameters
This
Val
Order

T

type T is private;

Value

function Value (This : Instance) return T

Ghost function to get the value of an instance without needing it aliased. This function can be used in contracts for instance. This doesn't use the atomic built-ins.

Parameters
This
Return Value