summaryrefslogtreecommitdiffstats
path: root/src/H5FDsubfiling/mercury/src/util/mercury_atomic.h
blob: 54562ad7261d16a812e2dd1b5f5a65d9eac0d121 (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
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
/**
 * Copyright (c) 2013-2021 UChicago Argonne, LLC and The HDF Group.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

#ifndef MERCURY_ATOMIC_H
#define MERCURY_ATOMIC_H

#include "mercury_util_config.h"

#if defined(_WIN32)
#define _WINSOCKAPI_
#include <windows.h>
typedef struct {
    volatile LONG value;
} hg_atomic_int32_t;
typedef struct {
    volatile LONGLONG value;
} hg_atomic_int64_t;
/* clang-format off */
#    define HG_ATOMIC_VAR_INIT(x) {(x)}
/* clang-format on */
#elif defined(HG_UTIL_HAS_STDATOMIC_H)
#ifndef __cplusplus
#include <stdatomic.h>
typedef atomic_int  hg_atomic_int32_t;
#if (HG_UTIL_ATOMIC_LONG_WIDTH == 8) && !defined(__APPLE__)
typedef atomic_long hg_atomic_int64_t;
#else
typedef atomic_llong hg_atomic_int64_t;
#endif
#else
#include <atomic>
typedef std::atomic_int  hg_atomic_int32_t;
#if (HG_UTIL_ATOMIC_LONG_WIDTH == 8) && !defined(__APPLE__)
typedef std::atomic_long hg_atomic_int64_t;
#else
typedef std::atomic_llong hg_atomic_int64_t;
#endif
using std::atomic_fetch_add_explicit;
using std::atomic_thread_fence;
using std::memory_order_acq_rel;
using std::memory_order_acquire;
using std::memory_order_release;
#endif
#define HG_ATOMIC_VAR_INIT(x) ATOMIC_VAR_INIT(x)
#elif defined(__APPLE__)
#include <libkern/OSAtomic.h>
typedef struct {
    volatile int32_t value;
} hg_atomic_int32_t;
typedef struct {
    volatile int64_t value;
} hg_atomic_int64_t;
/* clang-format off */
#    define HG_ATOMIC_VAR_INIT(x) {(x)}
/* clang-format on */
#else /* GCC 4.7 */
#if !defined(__GNUC__) || ((__GNUC__ < 4) && (__GNUC_MINOR__ < 7))
#error "GCC version >= 4.7 required to support built-in atomics."
#endif
/* builtins do not require volatile */
typedef int32_t hg_atomic_int32_t;
typedef int64_t hg_atomic_int64_t;
#define HG_ATOMIC_VAR_INIT(x) (x)
#endif

#ifdef __cplusplus
extern "C" {
#endif

/**
 * Init atomic value (32-bit integer).
 *
 * \param ptr [OUT]             pointer to an atomic32 integer
 * \param value [IN]            value
 */
static HG_UTIL_INLINE void hg_atomic_init32(hg_atomic_int32_t *ptr, int32_t value);

/**
 * Set atomic value (32-bit integer).
 *
 * \param ptr [OUT]             pointer to an atomic32 integer
 * \param value [IN]            value
 */
static HG_UTIL_INLINE void hg_atomic_set32(hg_atomic_int32_t *ptr, int32_t value);

/**
 * Get atomic value (32-bit integer).
 *
 * \param ptr [OUT]             pointer to an atomic32 integer
 *
 * \return Value of the atomic integer
 */
static HG_UTIL_INLINE int32_t hg_atomic_get32(hg_atomic_int32_t *ptr);

/**
 * Increment atomic value (32-bit integer).
 *
 * \param ptr [IN/OUT]          pointer to an atomic32 integer
 *
 * \return Incremented value
 */
static HG_UTIL_INLINE int32_t hg_atomic_incr32(hg_atomic_int32_t *ptr);

/**
 * Decrement atomic value (32-bit integer).
 *
 * \param ptr [IN/OUT]          pointer to an atomic32 integer
 *
 * \return Decremented value
 */
static HG_UTIL_INLINE int32_t hg_atomic_decr32(hg_atomic_int32_t *ptr);

/**
 * OR atomic value (32-bit integer).
 *
 * \param ptr [IN/OUT]          pointer to an atomic32 integer
 * \param value [IN]            value to OR with
 *
 * \return Original value
 */
static HG_UTIL_INLINE int32_t hg_atomic_or32(hg_atomic_int32_t *ptr, int32_t value);

/**
 * XOR atomic value (32-bit integer).
 *
 * \param ptr [IN/OUT]          pointer to an atomic32 integer
 * \param value [IN]            value to XOR with
 *
 * \return Original value
 */
static HG_UTIL_INLINE int32_t hg_atomic_xor32(hg_atomic_int32_t *ptr, int32_t value);

/**
 * AND atomic value (32-bit integer).
 *
 * \param ptr [IN/OUT]          pointer to an atomic32 integer
 * \param value [IN]            value to AND with
 *
 * \return Original value
 */
static HG_UTIL_INLINE int32_t hg_atomic_and32(hg_atomic_int32_t *ptr, int32_t value);

/**
 * Compare and swap values (32-bit integer).
 *
 * \param ptr [IN/OUT]          pointer to an atomic32 integer
 * \param compare_value [IN]    value to compare to
 * \param swap_value [IN]       value to swap with if ptr value is equal to
 *                              compare value
 *
 * \return true if swapped or false
 */
static HG_UTIL_INLINE bool hg_atomic_cas32(hg_atomic_int32_t *ptr, int32_t compare_value, int32_t swap_value);

/**
 * Init atomic value (64-bit integer).
 *
 * \param ptr [OUT]             pointer to an atomic32 integer
 * \param value [IN]            value
 */
static HG_UTIL_INLINE void hg_atomic_init64(hg_atomic_int64_t *ptr, int64_t value);

/**
 * Set atomic value (64-bit integer).
 *
 * \param ptr [OUT]             pointer to an atomic64 integer
 * \param value [IN]            value
 */
static HG_UTIL_INLINE void hg_atomic_set64(hg_atomic_int64_t *ptr, int64_t value);

/**
 * Get atomic value (64-bit integer).
 *
 * \param ptr [OUT]             pointer to an atomic64 integer
 *
 * \return Value of the atomic integer
 */
static HG_UTIL_INLINE int64_t hg_atomic_get64(hg_atomic_int64_t *ptr);

/**
 * Increment atomic value (64-bit integer).
 *
 * \param ptr [IN/OUT]          pointer to an atomic64 integer
 *
 * \return Incremented value
 */
static HG_UTIL_INLINE int64_t hg_atomic_incr64(hg_atomic_int64_t *ptr);

/**
 * Decrement atomic value (64-bit integer).
 *
 * \param ptr [IN/OUT]          pointer to an atomic64 integer
 *
 * \return Decremented value
 */
static HG_UTIL_INLINE int64_t hg_atomic_decr64(hg_atomic_int64_t *ptr);

/**
 * OR atomic value (64-bit integer).
 *
 * \param ptr [IN/OUT]          pointer to an atomic64 integer
 * \param value [IN]            value to OR with
 *
 * \return Original value
 */
static HG_UTIL_INLINE int64_t hg_atomic_or64(hg_atomic_int64_t *ptr, int64_t value);

/**
 * XOR atomic value (64-bit integer).
 *
 * \param ptr [IN/OUT]          pointer to an atomic64 integer
 * \param value [IN]            value to XOR with
 *
 * \return Original value
 */
static HG_UTIL_INLINE int64_t hg_atomic_xor64(hg_atomic_int64_t *ptr, int64_t value);

/**
 * AND atomic value (64-bit integer).
 *
 * \param ptr [IN/OUT]          pointer to an atomic64 integer
 * \param value [IN]            value to AND with
 *
 * \return Original value
 */
static HG_UTIL_INLINE int64_t hg_atomic_and64(hg_atomic_int64_t *ptr, int64_t value);

/**
 * Compare and swap values (64-bit integer).
 *
 * \param ptr [IN/OUT]          pointer to an atomic64 integer
 * \param compare_value [IN]    value to compare to
 * \param swap_value [IN]       value to swap with if ptr value is equal to
 *                              compare value
 *
 * \return true if swapped or false
 */
static HG_UTIL_INLINE bool hg_atomic_cas64(hg_atomic_int64_t *ptr, int64_t compare_value, int64_t swap_value);

/**
 * Memory barrier.
 *
 */
static HG_UTIL_INLINE void hg_atomic_fence(void);

/*---------------------------------------------------------------------------*/
static HG_UTIL_INLINE void
hg_atomic_init32(hg_atomic_int32_t *ptr, int32_t value)
{
#if defined(HG_UTIL_HAS_STDATOMIC_H)
    atomic_init(ptr, value);
#else
    hg_atomic_set32(ptr, value);
#endif
}

/*---------------------------------------------------------------------------*/
static HG_UTIL_INLINE void
hg_atomic_set32(hg_atomic_int32_t *ptr, int32_t value)
{
#if defined(_WIN32)
    ptr->value = value;
#elif defined(HG_UTIL_HAS_STDATOMIC_H)
    atomic_store_explicit(ptr, value, memory_order_release);
#elif defined(__APPLE__)
    ptr->value = value;
#else
    __atomic_store_n(ptr, value, __ATOMIC_RELEASE);
#endif
}

/*---------------------------------------------------------------------------*/
static HG_UTIL_INLINE int32_t
hg_atomic_get32(hg_atomic_int32_t *ptr)
{
    int32_t ret;

#if defined(_WIN32)
    ret = ptr->value;
#elif defined(HG_UTIL_HAS_STDATOMIC_H)
    ret = atomic_load_explicit(ptr, memory_order_acquire);
#elif defined(__APPLE__)
    ret        = ptr->value;
#else
    ret = __atomic_load_n(ptr, __ATOMIC_ACQUIRE);
#endif

    return ret;
}

/*---------------------------------------------------------------------------*/
static HG_UTIL_INLINE int32_t
hg_atomic_incr32(hg_atomic_int32_t *ptr)
{
    int32_t ret;

#if defined(_WIN32)
    ret = InterlockedIncrementNoFence(&ptr->value);
#elif defined(HG_UTIL_HAS_STDATOMIC_H)
    ret = atomic_fetch_add_explicit(ptr, 1, memory_order_acq_rel) + 1;
#elif defined(__APPLE__)
    ret        = OSAtomicIncrement32(&ptr->value);
#else
    ret = __atomic_fetch_add(ptr, 1, __ATOMIC_ACQ_REL) + 1;
#endif

    return ret;
}

/*---------------------------------------------------------------------------*/
static HG_UTIL_INLINE int32_t
hg_atomic_decr32(hg_atomic_int32_t *ptr)
{
    int32_t ret;

#if defined(_WIN32)
    ret = InterlockedDecrementNoFence(&ptr->value);
#elif defined(HG_UTIL_HAS_STDATOMIC_H)
    ret = atomic_fetch_sub_explicit(ptr, 1, memory_order_acq_rel) - 1;
#elif defined(__APPLE__)
    ret        = OSAtomicDecrement32(&ptr->value);
#else
    ret = __atomic_fetch_sub(ptr, 1, __ATOMIC_ACQ_REL) - 1;
#endif

    return ret;
}

/*---------------------------------------------------------------------------*/
static HG_UTIL_INLINE int32_t
hg_atomic_or32(hg_atomic_int32_t *ptr, int32_t value)
{
    int32_t ret;

#if defined(_WIN32)
    ret = InterlockedOrNoFence(&ptr->value, value);
#elif defined(HG_UTIL_HAS_STDATOMIC_H)
    ret = atomic_fetch_or_explicit(ptr, value, memory_order_acq_rel);
#elif defined(__APPLE__)
    ret        = OSAtomicOr32Orig((uint32_t)value, (volatile uint32_t *)&ptr->value);
#else
    ret = __atomic_fetch_or(ptr, value, __ATOMIC_ACQ_REL);
#endif

    return ret;
}

/*---------------------------------------------------------------------------*/
static HG_UTIL_INLINE int32_t
hg_atomic_xor32(hg_atomic_int32_t *ptr, int32_t value)
{
    int32_t ret;

#if defined(_WIN32)
    ret = InterlockedXorNoFence(&ptr->value, value);
#elif defined(HG_UTIL_HAS_STDATOMIC_H)
    ret = atomic_fetch_xor_explicit(ptr, value, memory_order_acq_rel);
#elif defined(__APPLE__)
    ret        = OSAtomicXor32Orig((uint32_t)value, (volatile uint32_t *)&ptr->value);
#else
    ret = __atomic_fetch_xor(ptr, value, __ATOMIC_ACQ_REL);
#endif

    return ret;
}

/*---------------------------------------------------------------------------*/
static HG_UTIL_INLINE int32_t
hg_atomic_and32(hg_atomic_int32_t *ptr, int32_t value)
{
    int32_t ret;

#if defined(_WIN32)
    ret = InterlockedAndNoFence(&ptr->value, value);
#elif defined(HG_UTIL_HAS_STDATOMIC_H)
    ret = atomic_fetch_and_explicit(ptr, value, memory_order_acq_rel);
#elif defined(__APPLE__)
    ret        = OSAtomicAnd32Orig((uint32_t)value, (volatile uint32_t *)&ptr->value);
#else
    ret = __atomic_fetch_and(ptr, value, __ATOMIC_ACQ_REL);
#endif

    return ret;
}

/*---------------------------------------------------------------------------*/
static HG_UTIL_INLINE bool
hg_atomic_cas32(hg_atomic_int32_t *ptr, int32_t compare_value, int32_t swap_value)
{
    bool ret;

#if defined(_WIN32)
    ret = (compare_value == InterlockedCompareExchangeNoFence(&ptr->value, swap_value, compare_value));
#elif defined(HG_UTIL_HAS_STDATOMIC_H)
    ret = atomic_compare_exchange_strong_explicit(ptr, &compare_value, swap_value, memory_order_acq_rel,
                                                  memory_order_acquire);
#elif defined(__APPLE__)
    ret        = OSAtomicCompareAndSwap32(compare_value, swap_value, &ptr->value);
#else
    ret = __atomic_compare_exchange_n(ptr, &compare_value, swap_value, false, __ATOMIC_ACQ_REL,
                                      __ATOMIC_ACQUIRE);
#endif

    return ret;
}

/*---------------------------------------------------------------------------*/
static HG_UTIL_INLINE void
hg_atomic_init64(hg_atomic_int64_t *ptr, int64_t value)
{
#if defined(HG_UTIL_HAS_STDATOMIC_H)
    atomic_init(ptr, value);
#else
    hg_atomic_set64(ptr, value);
#endif
}

/*---------------------------------------------------------------------------*/
static HG_UTIL_INLINE void
hg_atomic_set64(hg_atomic_int64_t *ptr, int64_t value)
{
#if defined(_WIN32)
    ptr->value = value;
#elif defined(HG_UTIL_HAS_STDATOMIC_H)
    atomic_store_explicit(ptr, value, memory_order_release);
#elif defined(__APPLE__)
    ptr->value = value;
#else
    __atomic_store_n(ptr, value, __ATOMIC_RELEASE);
#endif
}

/*---------------------------------------------------------------------------*/
static HG_UTIL_INLINE int64_t
hg_atomic_get64(hg_atomic_int64_t *ptr)
{
    int64_t ret;

#if defined(_WIN32)
    ret = ptr->value;
#elif defined(HG_UTIL_HAS_STDATOMIC_H)
    ret = atomic_load_explicit(ptr, memory_order_acquire);
#elif defined(__APPLE__)
    ptr->value = value;
#else
    ret = __atomic_load_n(ptr, __ATOMIC_ACQUIRE);
#endif

    return ret;
}

/*---------------------------------------------------------------------------*/
static HG_UTIL_INLINE int64_t
hg_atomic_incr64(hg_atomic_int64_t *ptr)
{
    int64_t ret;

#if defined(_WIN32)
    ret = InterlockedIncrementNoFence64(&ptr->value);
#elif defined(HG_UTIL_HAS_STDATOMIC_H)
    ret = atomic_fetch_add_explicit(ptr, (int64_t)1, memory_order_acq_rel) + 1;
#elif defined(__APPLE__)
    ret        = OSAtomicIncrement64(&ptr->value);
#else
    ret = __atomic_fetch_add(ptr, (int64_t)1, __ATOMIC_ACQ_REL) + 1;
#endif

    return ret;
}

/*---------------------------------------------------------------------------*/
static HG_UTIL_INLINE int64_t
hg_atomic_decr64(hg_atomic_int64_t *ptr)
{
    int64_t ret;

#if defined(_WIN32)
    ret = InterlockedDecrementNoFence64(&ptr->value);
#elif defined(HG_UTIL_HAS_STDATOMIC_H)
    ret = atomic_fetch_sub_explicit(ptr, (int64_t)1, memory_order_acq_rel) - 1;
#elif defined(__APPLE__)
    ret        = OSAtomicDecrement64(&ptr->value);
#else
    ret = __atomic_fetch_sub(ptr, (int64_t)1, __ATOMIC_ACQ_REL) - 1;
#endif

    return ret;
}

/*---------------------------------------------------------------------------*/
static HG_UTIL_INLINE int64_t
hg_atomic_or64(hg_atomic_int64_t *ptr, int64_t value)
{
    int64_t ret;

#if defined(_WIN32)
    ret = InterlockedOr64NoFence(&ptr->value, value);
#elif defined(HG_UTIL_HAS_STDATOMIC_H)
    ret = atomic_fetch_or_explicit(ptr, value, memory_order_acq_rel);
#else
    ret        = __atomic_fetch_or(ptr, value, __ATOMIC_ACQ_REL);
#endif

    return ret;
}

/*---------------------------------------------------------------------------*/
static HG_UTIL_INLINE int64_t
hg_atomic_xor64(hg_atomic_int64_t *ptr, int64_t value)
{
    int64_t ret;

#if defined(_WIN32)
    ret = InterlockedXor64NoFence(&ptr->value, value);
#elif defined(HG_UTIL_HAS_STDATOMIC_H)
    ret = atomic_fetch_xor_explicit(ptr, value, memory_order_acq_rel);
#else
    ret        = __atomic_fetch_xor(ptr, value, __ATOMIC_ACQ_REL);
#endif

    return ret;
}

/*---------------------------------------------------------------------------*/
static HG_UTIL_INLINE int64_t
hg_atomic_and64(hg_atomic_int64_t *ptr, int64_t value)
{
    int64_t ret;

#if defined(_WIN32)
    ret = InterlockedAnd64NoFence(&ptr->value, value);
#elif defined(HG_UTIL_HAS_STDATOMIC_H)
    ret = atomic_fetch_and_explicit(ptr, value, memory_order_acq_rel);
#else
    ret        = __atomic_fetch_and(ptr, value, __ATOMIC_ACQ_REL);
#endif

    return ret;
}

/*---------------------------------------------------------------------------*/
static HG_UTIL_INLINE bool
hg_atomic_cas64(hg_atomic_int64_t *ptr, int64_t compare_value, int64_t swap_value)
{
    bool ret;

#if defined(_WIN32)
    ret = (compare_value == InterlockedCompareExchangeNoFence64(&ptr->value, swap_value, compare_value));
#elif defined(HG_UTIL_HAS_STDATOMIC_H)
    ret = atomic_compare_exchange_strong_explicit(ptr, &compare_value, swap_value, memory_order_acq_rel,
                                                  memory_order_acquire);
#elif defined(__APPLE__)
    ret        = OSAtomicCompareAndSwap64(compare_value, swap_value, &ptr->value);
#else
    ret = __atomic_compare_exchange_n(ptr, &compare_value, swap_value, false, __ATOMIC_ACQ_REL,
                                      __ATOMIC_ACQUIRE);
#endif

    return ret;
}

/*---------------------------------------------------------------------------*/
static HG_UTIL_INLINE void
hg_atomic_fence(void)
{
#if defined(_WIN32)
    MemoryBarrier();
#elif defined(HG_UTIL_HAS_STDATOMIC_H)
    atomic_thread_fence(memory_order_acq_rel);
#elif defined(__APPLE__)
    OSMemoryBarrier();
#else
    __atomic_thread_fence(__ATOMIC_ACQ_REL);
#endif
}

#ifdef __cplusplus
}
#endif

#endif /* MERCURY_ATOMIC_H */