aboutsummaryrefslogtreecommitdiff
path: root/platform/linux-generic/include/api/odp_atomic.h
blob: e45a751b2e85219c855fa9962a8f9efff6fe7afd (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
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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
/* Copyright (c) 2013, Linaro Limited
 * All rights reserved.
 *
 * SPDX-License-Identifier:     BSD-3-Clause
 */


/**
 * @file
 *
 * ODP atomic operations
 */

#ifndef ODP_ATOMIC_H_
#define ODP_ATOMIC_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <odp_align.h>

/** @addtogroup odp_synchronizers
 *  Atomic types and relaxed operations. These operations cannot be used for
 *  synchronization.
 *  @{
 */


/**
 * Atomic 64-bit unsigned integer
 */
typedef struct {
	uint64_t v; /**< Actual storage for the atomic variable */
#if __GCC_ATOMIC_LLONG_LOCK_FREE < 2
	/* Some architectures do not support lock-free operations on 64-bit
	 * data types. We use a spin lock to ensure atomicity. */
	char lock; /**< Spin lock (if needed) used to ensure atomic access */
#endif
} odp_atomic_u64_t
ODP_ALIGNED(sizeof(uint64_t)); /* Enforce alignement! */


/**
 * Atomic 32-bit unsigned integer
 */
typedef struct {
	uint32_t v; /**< Actual storage for the atomic variable */
} odp_atomic_u32_t
ODP_ALIGNED(sizeof(uint32_t)); /* Enforce alignement! */


/**
 * Initialize atomic uint32 variable
 * @note Relaxed memory order, cannot be used for synchronization
 *
 * @param[out] atom Pointer to an atomic uint32 variable
 * @param val Value to initialize the variable with
 */
static inline void odp_atomic_init_u32(odp_atomic_u32_t *atom, uint32_t val)
{
	__atomic_store_n(&atom->v, val, __ATOMIC_RELAXED);
}

/**
 * Load value of atomic uint32 variable
 * @note Relaxed memory order, cannot be used for synchronization
 *
 * @param atom Pointer to an atomic uint32 variable
 *
 * @return Value of the variable
 */
static inline uint32_t odp_atomic_load_u32(odp_atomic_u32_t *atom)
{
	return __atomic_load_n(&atom->v, __ATOMIC_RELAXED);
}

/**
 * Store value to atomic uint32 variable
 * @note Relaxed memory order, cannot be used for synchronization
 *
 * @param[out] atom Pointer to an atomic uint32 variable
 * @param val Value to store in the variable
 */
static inline void odp_atomic_store_u32(odp_atomic_u32_t *atom,
					uint32_t val)
{
	__atomic_store_n(&atom->v, val, __ATOMIC_RELAXED);
}

/**
 * Fetch and add to atomic uint32 variable
 * @note Relaxed memory order, cannot be used for synchronization
 *
 * @param[in,out] atom Pointer to an atomic uint32 variable
 * @param val Value to be added to the variable
 *
 * @return Value of the variable before the addition
 */
static inline uint32_t odp_atomic_fetch_add_u32(odp_atomic_u32_t *atom,
						uint32_t val)
{
	return __atomic_fetch_add(&atom->v, val, __ATOMIC_RELAXED);
}

/**
 * Add to atomic uint32 variable
 * @note Relaxed memory order, cannot be used for synchronization
 *
 * @param[in,out] atom Pointer to an atomic uint32 variable
 * @param val A value to be added to the variable
 */
static inline void odp_atomic_add_u32(odp_atomic_u32_t *atom,
				      uint32_t val)
{
	(void)__atomic_fetch_add(&atom->v, val, __ATOMIC_RELAXED);
}

/**
 * Fetch and subtract from atomic uint32 variable
 * @note Relaxed memory order, cannot be used for synchronization
 *
 * @param[in,out] atom Pointer to an atomic uint32 variable
 * @param val A value to be subracted from the variable
 *
 * @return Value of the variable before the subtraction
 */
static inline uint32_t odp_atomic_fetch_sub_u32(odp_atomic_u32_t *atom,
						uint32_t val)
{
	return __atomic_fetch_sub(&atom->v, val, __ATOMIC_RELAXED);
}

/**
 * Subtract from atomic uint32 variable
 * @note Relaxed memory order, cannot be used for synchronization
 *
 * @param[in,out] atom Pointer to an atomic uint32 variable
 * @param val Value to be subtracted from the variable
 */
static inline void odp_atomic_sub_u32(odp_atomic_u32_t *atom,
				      uint32_t val)
{
	(void)__atomic_fetch_sub(&atom->v, val, __ATOMIC_RELAXED);
}

/**
 * Fetch and increment atomic uint32 variable
 * @note Relaxed memory order, cannot be used for synchronization
 *
 * @param[in,out] atom Pointer to an atomic uint32 variable
 *
 * @return Value of the variable before the increment
 */

static inline uint32_t odp_atomic_fetch_inc_u32(odp_atomic_u32_t *atom)
{
	return __atomic_fetch_add(&atom->v, 1, __ATOMIC_RELAXED);
}

/**
 * Increment atomic uint32 variable
 * @note Relaxed memory order, cannot be used for synchronization
 *
 * @param[in,out] atom Pointer to an atomic uint32 variable
 */
static inline void odp_atomic_inc_u32(odp_atomic_u32_t *atom)
{
	(void)__atomic_fetch_add(&atom->v, 1, __ATOMIC_RELAXED);
}

/**
 * Fetch and decrement atomic uint32 variable
 * @note Relaxed memory order, cannot be used for synchronization
 *
 * @param[in,out] atom Pointer to an atomic uint32 variable
 *
 * @return Value of the variable before the subtraction
 */
static inline uint32_t odp_atomic_fetch_dec_u32(odp_atomic_u32_t *atom)
{
	return __atomic_fetch_sub(&atom->v, 1, __ATOMIC_RELAXED);
}

/**
 * Decrement atomic uint32 variable
 * @note Relaxed memory order, cannot be used for synchronization
 *
 * @param[in,out] atom Pointer to an atomic uint32 variable
 */
static inline void odp_atomic_dec_u32(odp_atomic_u32_t *atom)
{
	(void)__atomic_fetch_sub(&atom->v, 1, __ATOMIC_RELAXED);
}

/**
 * Initialize atomic uint64 variable
 * @note Relaxed memory order, cannot be used for synchronization
 *
 * @param[out] atom Pointer to an atomic uint64 variable
 * @param val Value to initialize the variable with
 */
static inline void odp_atomic_init_u64(odp_atomic_u64_t *atom, uint64_t val)
{
	atom->v = val;
#if __GCC_ATOMIC_LLONG_LOCK_FREE < 2
	__atomic_clear(&atom->lock, __ATOMIC_RELAXED);
#endif
}

#if __GCC_ATOMIC_LLONG_LOCK_FREE < 2
/**
 * @internal
 * Helper macro for lock-based atomic operations on 64-bit integers
 * @param[in,out] atom Pointer to the 64-bit atomic variable
 * @param expr Expression used update the variable.
 * @return The old value of the variable.
 */
#define ATOMIC_OP(atom, expr) \
({ \
	uint64_t old_val; \
	/* Loop while lock is already taken, stop when lock becomes clear */ \
	while (__atomic_test_and_set(&(atom)->lock, __ATOMIC_ACQUIRE)) \
		(void)0; \
	old_val = (atom)->v; \
	(expr); /* Perform whatever update is desired */ \
	__atomic_clear(&(atom)->lock, __ATOMIC_RELEASE); \
	old_val; /* Return old value */ \
})
#endif

/**
 * Load value of atomic uint64 variable
 * @note Relaxed memory order, cannot be used for synchronization
 *
 * @param atom Pointer to an atomic uint64 variable
 *
 * @return Value of the variable
 */
static inline uint64_t odp_atomic_load_u64(odp_atomic_u64_t *atom)
{
#if __GCC_ATOMIC_LLONG_LOCK_FREE < 2
	return ATOMIC_OP(atom, (void)0);
#else
	return __atomic_load_n(&atom->v, __ATOMIC_RELAXED);
#endif
}

/**
 * Store value to atomic uint64 variable
 * @note Relaxed memory order, cannot be used for synchronization
 *
 * @param[out] atom Pointer to an atomic uint64 variable
 * @param val Value to store in the variable
 */
static inline void odp_atomic_store_u64(odp_atomic_u64_t *atom,
					uint64_t val)
{
#if __GCC_ATOMIC_LLONG_LOCK_FREE < 2
	(void)ATOMIC_OP(atom, atom->v = val);
#else
	__atomic_store_n(&atom->v, val, __ATOMIC_RELAXED);
#endif
}

/**
 * Fetch and add to atomic uint64 variable
 * @note Relaxed memory order, cannot be used for synchronization
 *
 * @param[in,out] atom Pointer to an atomic uint64 variable
 * @param val Value to be added to the variable
 *
 * @return Value of the variable before the addition
 */

static inline uint64_t odp_atomic_fetch_add_u64(odp_atomic_u64_t *atom,
						uint64_t val)
{
#if __GCC_ATOMIC_LLONG_LOCK_FREE < 2
	return ATOMIC_OP(atom, atom->v += val);
#else
	return __atomic_fetch_add(&atom->v, val, __ATOMIC_RELAXED);
#endif
}

/**
 * Add to atomic uint64 variable
 * @note Relaxed memory order, cannot be used for synchronization
 *
 * @param[in,out] atom Pointer to an atomic uint64 variable
 * @param val Value to be added to the variable
 *
 */
static inline void odp_atomic_add_u64(odp_atomic_u64_t *atom, uint64_t val)
{
#if __GCC_ATOMIC_LLONG_LOCK_FREE < 2
	(void)ATOMIC_OP(atom, atom->v += val);
#else
	(void)__atomic_fetch_add(&atom->v, val, __ATOMIC_RELAXED);
#endif
}

/**
 * Fetch and subtract from atomic uint64 variable
 * @note Relaxed memory order, cannot be used for synchronization
 *
 * @param[in,out] atom Pointer to an atomic uint64 variable
 * @param val Value to be subtracted from the variable
 *
 * @return Value of the variable before the subtraction
 */
static inline uint64_t odp_atomic_fetch_sub_u64(odp_atomic_u64_t *atom,
						uint64_t val)
{
#if __GCC_ATOMIC_LLONG_LOCK_FREE < 2
	return ATOMIC_OP(atom, atom->v -= val);
#else
	return __atomic_fetch_sub(&atom->v, val, __ATOMIC_RELAXED);
#endif
}

/**
 * Subtract from atomic uint64 variable
 * @note Relaxed memory order, cannot be used for synchronization
 *
 * @param[in,out] atom Pointer to an atomic uint64 variable
 * @param val Value to be subtracted from the variable
 */
static inline void odp_atomic_sub_u64(odp_atomic_u64_t *atom, uint64_t val)
{
#if __GCC_ATOMIC_LLONG_LOCK_FREE < 2
	(void)ATOMIC_OP(atom, atom->v -= val);
#else
	(void)__atomic_fetch_sub(&atom->v, val, __ATOMIC_RELAXED);
#endif
}

/**
 * Fetch and increment atomic uint64 variable
 * @note Relaxed memory order, cannot be used for synchronization
 *
 * @param[in,out] atom Pointer to an atomic uint64 variable
 *
 * @return Value of the variable before the increment
 */
static inline uint64_t odp_atomic_fetch_inc_u64(odp_atomic_u64_t *atom)
{
#if __GCC_ATOMIC_LLONG_LOCK_FREE < 2
	return ATOMIC_OP(atom, atom->v++);
#else
	return __atomic_fetch_add(&atom->v, 1, __ATOMIC_RELAXED);
#endif
}

/**
 * Increment atomic uint64 variable
 * @note Relaxed memory order, cannot be used for synchronization
 *
 * @param[in,out] atom Pointer to an atomic uint64 variable
 */
static inline void odp_atomic_inc_u64(odp_atomic_u64_t *atom)
{
#if __GCC_ATOMIC_LLONG_LOCK_FREE < 2
	(void)ATOMIC_OP(atom, atom->v++);
#else
	(void)__atomic_fetch_add(&atom->v, 1, __ATOMIC_RELAXED);
#endif
}

/**
 * Fetch and decrement atomic uint64 variable
 * @note Relaxed memory order, cannot be used for synchronization
 *
 * @param[in,out] atom Pointer to an atomic uint64 variable
 *
 * @return Value of the variable before the decrement
 */
static inline uint64_t odp_atomic_fetch_dec_u64(odp_atomic_u64_t *atom)
{
#if __GCC_ATOMIC_LLONG_LOCK_FREE < 2
	return ATOMIC_OP(atom, atom->v--);
#else
	return __atomic_fetch_sub(&atom->v, 1, __ATOMIC_RELAXED);
#endif
}

/**
 * Decrement atomic uint64 variable
 * @note Relaxed memory order, cannot be used for synchronization
 *
 * @param[in,out] atom Pointer to an atomic uint64 variable
 */
static inline void odp_atomic_dec_u64(odp_atomic_u64_t *atom)
{
#if __GCC_ATOMIC_LLONG_LOCK_FREE < 2
	(void)ATOMIC_OP(atom, atom->v--);
#else
	(void)__atomic_fetch_sub(&atom->v, 1, __ATOMIC_RELAXED);
#endif
}

/**
 * @}
 */

#ifdef __cplusplus
}
#endif

#endif