summaryrefslogtreecommitdiffstats
path: root/js/src/zydis/Zycore/Atomic.h
blob: 6f5073087d3d29857ff8e7378604ec57c8a82831 (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
/***************************************************************************************************

  Zyan Core Library (Zyan-C)

  Original Author : Florian Bernd

 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.

***************************************************************************************************/

/**
 * @file
 * Cross compiler atomic intrinsics.
 */

#ifndef ZYCORE_ATOMIC_H
#define ZYCORE_ATOMIC_H

#ifdef __cplusplus
extern "C" {
#endif

#include "zydis/Zycore/Defines.h"
#include "zydis/Zycore/Types.h"

/* ============================================================================================== */
/* Enums and Types                                                                                */
/* ============================================================================================== */

/*
 * Wraps a 32-bit value to provide atomic access.
 */
typedef struct ZyanAtomic32_
{
    ZyanU32 volatile value;
} ZyanAtomic32;

/*
 * Wraps a 64-bit value to provide atomic access.
 */
typedef struct ZyanAtomic64_
{
    ZyanU64 volatile value;
} ZyanAtomic64;

/*
 * Wraps a pointer-sized value to provide atomic access.
 */
typedef struct ZyanAtomicPointer_
{
    ZyanVoidPointer volatile value;
} ZyanAtomicPointer;

/* ============================================================================================== */
/* Macros                                                                                         */
/* ============================================================================================== */

/* ---------------------------------------------------------------------------------------------- */
/* Pointer sized                                                                                  */
/* ---------------------------------------------------------------------------------------------- */

/**
 * @copydoc ZyanAtomicCompareExchange
 */
#define ZYAN_ATOMIC_COMPARE_EXCHANGE(destination, comparand, value) \
    ZyanAtomicCompareExchange((ZyanAtomicPointer*)&(destination), (comparand), (value))

/**
 * @copydoc ZyanAtomicIncrement
 */
#define ZYAN_ATOMIC_INCREMENT(destination) \
    ZyanAtomicIncrement((ZyanAtomicPointer*)&(destination));

/**
 * @copydoc ZyanAtomicDecrement
 */
#define ZYAN_ATOMIC_DECREMENT(destination) \
    ZyanAtomicDecrement((ZyanAtomicPointer*)&(destination));

/* ---------------------------------------------------------------------------------------------- */
/* 32-bit                                                                                         */
/* ---------------------------------------------------------------------------------------------- */

/**
 * @copydoc ZyanAtomicCompareExchange
 */
#define ZYAN_ATOMIC_COMPARE_EXCHANGE32(destination, comparand, value) \
    ZyanAtomicCompareExchange32((ZyanAtomic32*)&(destination), (comparand), (value))

/**
 * @copydoc ZyanAtomicIncrement
 */
#define ZYAN_ATOMIC_INCREMENT32(destination) \
    ZyanAtomicIncrement32((ZyanAtomic32*)&(destination));

/**
 * @copydoc ZyanAtomicDecrement
 */
#define ZYAN_ATOMIC_DECREMENT32(destination) \
    ZyanAtomicDecrement32((ZyanAtomic32*)&(destination));

/* ---------------------------------------------------------------------------------------------- */
/* 64-bit                                                                                         */
/* ---------------------------------------------------------------------------------------------- */

/**
 * @copydoc ZyanAtomicCompareExchange
 */
#define ZYAN_ATOMIC_COMPARE_EXCHANGE64(destination, comparand, value) \
    ZyanAtomicCompareExchange64((ZyanAtomic64*)&(destination), (comparand), (value))

/**
 * @copydoc ZyanAtomicIncrement
 */
#define ZYAN_ATOMIC_INCREMENT64(destination) \
    ZyanAtomicIncrement64((ZyanAtomic64*)&(destination));

/**
 * @copydoc ZyanAtomicDecrement
 */
#define ZYAN_ATOMIC_DECREMENT64(destination) \
    ZyanAtomicDecrement64((ZyanAtomic64*)&(destination));

/* ---------------------------------------------------------------------------------------------- */

/* ============================================================================================== */
/* Functions                                                                                      */
/* ============================================================================================== */

/* ---------------------------------------------------------------------------------------------- */
/* Pointer sized                                                                                  */
/* ---------------------------------------------------------------------------------------------- */

/**
 * Compares two values for equality and, if they are equal, replaces the first value.
 *
 * @param   destination A pointer to the destination value.
 * @param   comparand   The value to compare with.
 * @param   value       The replacement value.
 *
 * @return  The original value.
 */
static ZyanUPointer ZyanAtomicCompareExchange(ZyanAtomicPointer* destination,
    ZyanUPointer comparand, ZyanUPointer value);

/**
 * Increments the given value and stores the result, as an atomic operation.
 *
 * @param   destination A pointer to the destination value.
 *
 * @return  The incremented value.
*/
static ZyanUPointer ZyanAtomicIncrement(ZyanAtomicPointer* destination);

/**
 * Decrements the given value and stores the result, as an atomic operation.
 *
 * @param   destination A pointer to the destination value.
 *
 * @return  The decremented value.
*/
static ZyanUPointer ZyanAtomicDecrement(ZyanAtomicPointer* destination);

/* ---------------------------------------------------------------------------------------------- */
/* 32-bit                                                                                         */
/* ---------------------------------------------------------------------------------------------- */

/**
 * @copydoc ZyanAtomicCompareExchange
 */
static ZyanU32 ZyanAtomicCompareExchange32(ZyanAtomic32* destination,
    ZyanU32 comparand, ZyanU32 value);

/**
 * @copydoc ZyanAtomicIncrement
 */
static ZyanU32 ZyanAtomicIncrement32(ZyanAtomic32* destination);

/**
 * @copydoc ZyanAtomicDecrement
 */
static ZyanU32 ZyanAtomicDecrement32(ZyanAtomic32* destination);

/* ---------------------------------------------------------------------------------------------- */
/* 64-bit                                                                                         */
/* ---------------------------------------------------------------------------------------------- */

/**
 * @copydoc ZyanAtomicCompareExchange
 */
static ZyanU64 ZyanAtomicCompareExchange64(ZyanAtomic64* destination,
    ZyanU64 comparand, ZyanU64 value);

/**
 * @copydoc ZyanAtomicIncrement
 */
static ZyanU64 ZyanAtomicIncrement64(ZyanAtomic64* destination);

/**
 * @copydoc ZyanAtomicDecrement
 */
static ZyanU64 ZyanAtomicDecrement64(ZyanAtomic64* destination);

/* ---------------------------------------------------------------------------------------------- */

/* ============================================================================================== */

#if defined(ZYAN_CLANG) || defined(ZYAN_GCC) || defined(ZYAN_ICC)
#   include "zydis/Zycore/Internal/AtomicGNU.h"
#elif defined(ZYAN_MSVC)
#   include "zydis/Zycore/Internal/AtomicMSVC.h"
#else
#   error "Unsupported compiler detected"
#endif

#ifdef __cplusplus
}
#endif

#endif /* ZYCORE_ATOMIC_H */