aboutsummaryrefslogtreecommitdiffstats
path: root/gcc-4.8.3/gcc/ada/s-atopri.ads
blob: ba4b73351aa1c32385b7ff2ce11994a340c42fc4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
------------------------------------------------------------------------------
--                                                                          --
--                         GNAT RUN-TIME COMPONENTS                         --
--                                                                          --
--               S Y S T E M . A T O M I C _ P R I M I T I V E S            --
--                                                                          --
--                                 S p e c                                  --
--                                                                          --
--              Copyright (C) 2012, Free Software Foundation, Inc.          --
--                                                                          --
-- GNAT is free software;  you can  redistribute it  and/or modify it under --
-- terms of the  GNU General Public License as published  by the Free Soft- --
-- ware  Foundation;  either version 3,  or (at your option) any later ver- --
-- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
-- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
-- or FITNESS FOR A PARTICULAR PURPOSE.                                     --
--                                                                          --
-- As a special exception under Section 7 of GPL version 3, you are granted --
-- additional permissions described in the GCC Runtime Library Exception,   --
-- version 3.1, as published by the Free Software Foundation.               --
--                                                                          --
-- You should have received a copy of the GNU General Public License and    --
-- a copy of the GCC Runtime Library Exception along with this program;     --
-- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --
-- <http://www.gnu.org/licenses/>.                                          --
--                                                                          --
-- GNAT was originally developed  by the GNAT team at  New York University. --
-- Extensive contributions were provided by Ada Core Technologies Inc.      --
--                                                                          --
------------------------------------------------------------------------------

--  This package contains both atomic primitives defined from gcc built-in
--  functions and operations used by the compiler to generate the lock-free
--  implementation of protected objects.

package System.Atomic_Primitives is
   pragma Preelaborate;

   type uint is mod 2 ** Long_Integer'Size;

   type uint8  is mod 2**8
     with Size => 8;

   type uint16 is mod 2**16
     with Size => 16;

   type uint32 is mod 2**32
     with Size => 32;

   type uint64 is mod 2**64
     with Size => 64;

   Relaxed : constant := 0;
   Consume : constant := 1;
   Acquire : constant := 2;
   Release : constant := 3;
   Acq_Rel : constant := 4;
   Seq_Cst : constant := 5;
   Last    : constant := 6;

   subtype Mem_Model is Integer range Relaxed .. Last;

   ------------------------------------
   -- GCC built-in atomic primitives --
   ------------------------------------

   function Atomic_Load_8
     (Ptr   : Address;
      Model : Mem_Model := Seq_Cst) return uint8;
   pragma Import (Intrinsic, Atomic_Load_8, "__atomic_load_1");

   function Atomic_Load_16
     (Ptr   : Address;
      Model : Mem_Model := Seq_Cst) return uint16;
   pragma Import (Intrinsic, Atomic_Load_16, "__atomic_load_2");

   function Atomic_Load_32
     (Ptr   : Address;
      Model : Mem_Model := Seq_Cst) return uint32;
   pragma Import (Intrinsic, Atomic_Load_32, "__atomic_load_4");

   function Atomic_Load_64
     (Ptr   : Address;
      Model : Mem_Model := Seq_Cst) return uint64;
   pragma Import (Intrinsic, Atomic_Load_64, "__atomic_load_8");

   function Sync_Compare_And_Swap_8
     (Ptr      : Address;
      Expected : uint8;
      Desired  : uint8) return uint8;
   pragma Import (Intrinsic,
                  Sync_Compare_And_Swap_8,
                  "__sync_val_compare_and_swap_1");

   --  ??? Should use __atomic_compare_exchange_1 (doesn't work yet):
   --  function Sync_Compare_And_Swap_8
   --    (Ptr           : Address;
   --     Expected      : Address;
   --     Desired       : uint8;
   --     Weak          : Boolean   := False;
   --     Success_Model : Mem_Model := Seq_Cst;
   --     Failure_Model : Mem_Model := Seq_Cst) return Boolean;
   --  pragma Import (Intrinsic,
   --                 Sync_Compare_And_Swap_8,
   --                 "__atomic_compare_exchange_1");

   function Sync_Compare_And_Swap_16
     (Ptr      : Address;
      Expected : uint16;
      Desired  : uint16) return uint16;
   pragma Import (Intrinsic,
                  Sync_Compare_And_Swap_16,
                  "__sync_val_compare_and_swap_2");

   function Sync_Compare_And_Swap_32
     (Ptr      : Address;
      Expected : uint32;
      Desired  : uint32) return uint32;
   pragma Import (Intrinsic,
                  Sync_Compare_And_Swap_32,
                  "__sync_val_compare_and_swap_4");

   function Sync_Compare_And_Swap_64
     (Ptr      : Address;
      Expected : uint64;
      Desired  : uint64) return uint64;
   pragma Import (Intrinsic,
                  Sync_Compare_And_Swap_64,
                  "__sync_val_compare_and_swap_8");

   --------------------------
   -- Lock-free operations --
   --------------------------

   --  The lock-free implementation uses two atomic instructions for the
   --  expansion of protected operations:

   --  * Lock_Free_Read_N atomically loads the value of the protected component
   --    accessed by the current protected operation.

   --  * Lock_Free_Try_Write_N tries to write the Desired value into Ptr only
   --    if Expected and Desired mismatch.

   function Lock_Free_Read_8 (Ptr : Address) return uint8;

   function Lock_Free_Read_16 (Ptr : Address) return uint16;

   function Lock_Free_Read_32 (Ptr : Address) return uint32;

   function Lock_Free_Read_64 (Ptr : Address) return uint64;

   function Lock_Free_Try_Write_8
      (Ptr      : Address;
       Expected : in out uint8;
       Desired  : uint8) return Boolean;

   function Lock_Free_Try_Write_16
      (Ptr      : Address;
       Expected : in out uint16;
       Desired  : uint16) return Boolean;

   function Lock_Free_Try_Write_32
      (Ptr      : Address;
       Expected : in out uint32;
       Desired  : uint32) return Boolean;

   function Lock_Free_Try_Write_64
      (Ptr      : Address;
       Expected : in out uint64;
       Desired  : uint64) return Boolean;

   pragma Inline (Lock_Free_Read_8);
   pragma Inline (Lock_Free_Read_16);
   pragma Inline (Lock_Free_Read_32);
   pragma Inline (Lock_Free_Read_64);
   pragma Inline (Lock_Free_Try_Write_8);
   pragma Inline (Lock_Free_Try_Write_16);
   pragma Inline (Lock_Free_Try_Write_32);
   pragma Inline (Lock_Free_Try_Write_64);
end System.Atomic_Primitives;