This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
SDL_atomic.h
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
/*
SDL - Simple DirectMedia Layer
Copyright (C) 1997-2006 Sam Lantinga
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Sam Lantinga
slouken@libsdl.org
*/
/**
* \file SDL_atomic.h
*
26
* Atomic operations.
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
*/
#ifndef _SDL_atomic_h_
#define _SDL_atomic_h_
#include "SDL_stdinc.h"
#include "SDL_platform.h"
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
/* *INDENT-OFF* */
extern "C" {
/* *INDENT-ON* */
#endif
45
46
47
48
49
50
* These operations may, or may not, actually be implemented using
* processor specific atomic operations. When possible they are
* implemented as true processor specific atomic operations. When that
* is not possible the are implemented using locks that *do* use the
* available atomic operations. In rare cases they may be implemented
* using SDL's mutex fuctions.
53
/* Function prototypes */
55
/* 8 bit atomic operations */
57
58
59
60
61
62
63
64
65
66
67
68
69
extern DECLSPEC Uint8 SDLCALL SDL_AtomicExchange8(Uint8 * ptr, Uint8 value);
extern DECLSPEC SDL_bool SDLCALL SDL_AtomicCompareThenSet8(Uint8 * ptr,
Uint8 oldvalue, Uint8 newvalue);
extern DECLSPEC SDL_bool SDLCALL SDL_AtomicTestThenSet8(Uint8 * ptr);
extern DECLSPEC void SDLCALL SDL_AtomicClear8(Uint8 * ptr);
extern DECLSPEC Uint8 SDLCALL SDL_AtomicFetchThenIncrement8(Uint8 * ptr);
extern DECLSPEC Uint8 SDLCALL SDL_AtomicFetchThenDecrement8(Uint8 * ptr);
extern DECLSPEC Uint8 SDLCALL SDL_AtomicFetchThenAdd8(Uint8 * ptr, Uint8 value);
extern DECLSPEC Uint8 SDLCALL SDL_AtomicFetchThenSubtract8(Uint8 * ptr, Uint8 value);
extern DECLSPEC Uint8 SDLCALL SDL_AtomicIncrementThenFetch8(Uint8 * ptr);
extern DECLSPEC Uint8 SDLCALL SDL_AtomicDecrementThenFetch8(Uint8 * ptr);
extern DECLSPEC Uint8 SDLCALL SDL_AtomicAddThenFetch8(Uint8 * ptr, Uint8 value);
extern DECLSPEC Uint8 SDLCALL SDL_AtomicSubtractThenFetch8(Uint8 * ptr, Uint8 value);
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
/* 16 bit atomic operations */
extern DECLSPEC Uint16 SDLCALL SDL_AtomicExchange16(Uint16 * ptr, Uint16 value);
extern DECLSPEC SDL_bool SDLCALL SDL_AtomicCompareThenSet16(Uint16 * ptr,
Uint16 oldvalue, Uint16 newvalue);
extern DECLSPEC SDL_bool SDLCALL SDL_AtomicTestThenSet16(Uint16 * ptr);
extern DECLSPEC void SDLCALL SDL_AtomicClear16(Uint16 * ptr);
extern DECLSPEC Uint16 SDLCALL SDL_AtomicFetchThenIncrement16(Uint16 * ptr);
extern DECLSPEC Uint16 SDLCALL SDL_AtomicFetchThenDecrement16(Uint16 * ptr);
extern DECLSPEC Uint16 SDLCALL SDL_AtomicFetchThenAdd16(Uint16 * ptr, Uint16 value);
extern DECLSPEC Uint16 SDLCALL SDL_AtomicFetchThenSubtract16(Uint16 * ptr, Uint16 value);
extern DECLSPEC Uint16 SDLCALL SDL_AtomicIncrementThenFetch16(Uint16 * ptr);
extern DECLSPEC Uint16 SDLCALL SDL_AtomicDecrementThenFetch16(Uint16 * ptr);
extern DECLSPEC Uint16 SDLCALL SDL_AtomicAddThenFetch16(Uint16 * ptr, Uint16 value);
extern DECLSPEC Uint16 SDLCALL SDL_AtomicSubtractThenFetch16(Uint16 * ptr, Uint16 value);
/* 32 bit atomic operations */
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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
/**
* \fn int SDL_AtomicExchange32(Uint32 * ptr, Uint32 value)
*
* \brief Atomically exchange two 32 bit values.
*
* \return the value point to by ptr.
*
* \param ptr points to the value to be fetched from *ptr.
* \param value is value to be stored at *ptr.
*
* The current value stored at *ptr is returned and it is replaced
* with value. This function can be used to implement SDL_TestThenSet.
*
*/
extern DECLSPEC Uint32 SDLCALL SDL_AtomicExchange32(Uint32 * ptr, Uint32 value);
/**
* \fn int SDL_AtomicCompareThenSet32(Uint32 * ptr, Uint32 oldvalue, Uint32 newvalue)
*
* \brief If *ptr == oldvalue then replace the contents of *ptr by new value.
*
* \return true if the newvalue was stored.
*
* \param *ptr is the value to be compared and replaced.
* \param oldvalue is value to be compared to *ptr.
* \param newvalue is value to be stored at *ptr.
*
*/
extern DECLSPEC SDL_bool SDLCALL SDL_AtomicCompareThenSet32(Uint32 * ptr,
Uint32 oldvalue, Uint32 newvalue);
/**
* \fn SDL_bool SDL_AtomicTestThenSet32(Uint32 * ptr);
*
* \brief Check to see if *ptr == 0 and set it to non-zero.
*
* \return SDL_True if the value pointed to by ptr was zero and
* SDL_False if it was not zero
*
* \param ptr points to the value to be tested and set.
*
*/
extern DECLSPEC SDL_bool SDLCALL SDL_AtomicTestThenSet32(Uint32 * ptr);
/**
* \fn void SDL_AtomicClear32(Uint32 * ptr);
*
* \brief set the value pointed to by ptr to be zero.
*
* \param ptr address of the value to be set to zero
*
*/
extern DECLSPEC void SDLCALL SDL_AtomicClear32(Uint32 * ptr);
/**
* \fn Uint32 SDL_AtomicFetchThenIncrement32(Uint32 * ptr);
*
* \brief fetch the current value of *ptr and then increment that
* value in place.
*
* \return the value before it was incremented.
*
* \param ptr address of the value to fetch and increment
*
*/
extern DECLSPEC Uint32 SDLCALL SDL_AtomicFetchThenIncrement32(Uint32 * ptr);
/**
* \fn Uint32 SDL_AtomicFetchThenDecrement32(Uint32 * ptr);
*
* \brief fetch *ptr and then decrement the value in place.
*
* \return the value before it was decremented.
*
* \param ptr address of the value to fetch and drement
*
*/
extern DECLSPEC Uint32 SDLCALL SDL_AtomicFetchThenDecrement32(Uint32 * ptr);
/**
* \fn Uint32 SDL_AtomicFetchThenAdd32(Uint32 * ptr, Uint32 value);
*
* \brief fetch the current value at ptr and then add value to *ptr.
*
* \return *ptr before the addition took place.
*
* \param ptr the address of data we are changing.
* \param value the value to add to *ptr.
*
*/
extern DECLSPEC Uint32 SDLCALL SDL_AtomicFetchThenAdd32(Uint32 * ptr, Uint32 value);
/**
* \fn Uint32 SDL_AtomicFetchThenSubtract32(Uint32 * ptr, Uint32 value);
*
* \brief Fetch *ptr and then subtract value from it.
*
* \return *ptr before the subtraction took place.
*
* \param ptr the address of the data being changed.
* \param value the value to subtract from *ptr.
*
*/
extern DECLSPEC Uint32 SDLCALL SDL_AtomicFetchThenSubtract32(Uint32 * ptr, Uint32 value);
/**
* \fn Uint32 SDL_AtomicIncrementThenFetch32(Uint32 * ptr);
*
* \brief Add one to the data pointed to by ptr and return that value.
*
* \return the incremented value.
*
* \param ptr address of the data to increment.
*
*/
extern DECLSPEC Uint32 SDLCALL SDL_AtomicIncrementThenFetch32(Uint32 * ptr);
/**
* \fn Uint32 SDL_AtomicDecrementThenFetch32(Uint32 * ptr);
*
* \brief Subtract one from data pointed to by ptr and return the new value.
*
* \return The decremented value.
*
* \param ptr The address of the data to decrement.
*
*/
extern DECLSPEC Uint32 SDLCALL SDL_AtomicDecrementThenFetch32(Uint32 * ptr);
/**
* \fn Uint32 SDL_AtomicAddThenFetch32(Uint32 * ptr, Uint32 value);
*
* \brief Add value to the data pointed to by ptr and return result.
*
* \return The sum of *ptr and value.
*
* \param ptr The address of the data to be modified.
* \param value The value to be added.
*
*/
extern DECLSPEC Uint32 SDLCALL SDL_AtomicAddThenFetch32(Uint32 * ptr, Uint32 value);
/**
* \fn Uint32 SDL_AtomicSubtractThenFetch32(Uint32 * ptr, Uint32 value);
*
* \brief Subtract value from the data pointed to by ptr and return the result.
*
* \return the difference between *ptr and value.
*
* \param ptr The address of the data to be modified.
* \param value The value to be subtracted.
*
*/
extern DECLSPEC Uint32 SDLCALL SDL_AtomicSubtractThenFetch32(Uint32 * ptr, Uint32 value);
233
/* 64 bit atomic operations */
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
#ifdef SDL_HAS_64BIT_TYPE
extern DECLSPEC Uint64 SDLCALL SDL_AtomicExchange64(Uint64 * ptr, Uint64 value);
extern DECLSPEC SDL_bool SDLCALL SDL_AtomicCompareThenSet64(Uint64 * ptr,
Uint64 oldvalue, Uint64 newvalue);
extern DECLSPEC SDL_bool SDLCALL SDL_AtomicTestThenSet64(Uint64 * ptr);
extern DECLSPEC void SDLCALL SDL_AtomicClear64(Uint64 * ptr);
extern DECLSPEC Uint64 SDLCALL SDL_AtomicFetchThenIncrement64(Uint64 * ptr);
extern DECLSPEC Uint64 SDLCALL SDL_AtomicFetchThenDecrement64(Uint64 * ptr);
extern DECLSPEC Uint64 SDLCALL SDL_AtomicFetchThenAdd64(Uint64 * ptr, Uint64 value);
extern DECLSPEC Uint64 SDLCALL SDL_AtomicFetchThenSubtract64(Uint64 * ptr, Uint64 value);
extern DECLSPEC Uint64 SDLCALL SDL_AtomicIncrementThenFetch64(Uint64 * ptr);
extern DECLSPEC Uint64 SDLCALL SDL_AtomicDecrementThenFetch64(Uint64 * ptr);
extern DECLSPEC Uint64 SDLCALL SDL_AtomicAddThenFetch64(Uint64 * ptr, Uint64 value);
extern DECLSPEC Uint64 SDLCALL SDL_AtomicSubtractThenFetch64(Uint64 * ptr, Uint64 value);
249
#endif /* SDL_HAS_64BIT_TYPE */
250
251
252
253
254
255
256
257
258
259
260
261
262
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
/* *INDENT-OFF* */
}
/* *INDENT-ON* */
#endif
#include "close_code.h"
#endif /* _SDL_atomic_h_ */
/* vi: set ts=4 sw=4 expandtab: */