aboutsummaryrefslogtreecommitdiffstats
path: root/libparc/parc/concurrent/parc_AtomicUint8.h
blob: 7434b93d8c0309f1787bdd43387bbf62dc8e937f (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
/*
 * Copyright (c) 2017 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @file parc_AtomicUint8.h
 * @ingroup threading
 * @brief An atomically updated 8-bit unsigned integer.
 *
 * <#Detailed Description#>
 *
 */
#ifndef PARCLibrary_parc_AtomicUint8
#define PARCLibrary_parc_AtomicUint8
#include <stdbool.h>
#include <stdint.h>

#include <parc/algol/parc_JSON.h>

#ifdef PARCLibrary_DISABLE_ATOMICS
#include <pthread.h>
struct PARCAtomicUint8;
typedef struct PARCAtomicUint8 PARCAtomicUint8;
#else
typedef uint8_t PARCAtomicUint8;
#endif


PARCAtomicUint8 *parcAtomicInteger_CreateUint8(uint8_t value);

uint8_t parcAtomicUint8_AddImpl(PARCAtomicUint8 *value, uint8_t addend);

uint8_t parcAtomicUint8_SubtractImpl(PARCAtomicUint8 *value, uint8_t subtrahend);

bool parcAtomicUint8_CompareAndSwapImpl(PARCAtomicUint8 *value, uint8_t predicate, uint8_t newValue);

#ifdef PARCLibrary_DISABLE_ATOMICS

#define parcAtomicUint8_Add                parcAtomicUint8_AddImpl

#define parcAtomicUint8_Subtract           parcAtomicUint8_SubtractImpl

#define parcAtomicUint8_CompareAndSwap     parcAtomicUint8_CompareAndSwapImpl

#else

#define parcAtomicUint8_Add(_atomic_uint8_, _addend_) \
    __sync_add_and_fetch(_atomic_uint8_, _addend_)

#define parcAtomicUint8_Subtract(_atomic_uint8_, _subtrahend_) \
    __sync_sub_and_fetch(_atomic_uint8_, _subtrahend_)

#define parcAtomicUint8_CompareAndSwap(_atomic_uint8_, _predicate_, _newValue_) \
    __sync_bool_compare_and_swap(_atomic_uint8_, _predicate_, _newValue_)
#endif

#define parcAtomicUint8_Increment(_atomic_uint8_) parcAtomicUint8_Add(_atomic_uint8_, 1)
#define parcAtomicUint8_Decrement(_atomic_uint8_) parcAtomicUint8_Subtract(_atomic_uint8_, 1)

/**
 * Increase the number of references to a `PARCAtomicUint8` instance.
 *
 * Note that new `PARCAtomicUint8` is not created,
 * only that the given `PARCAtomicUint8` reference count is incremented.
 * Discard the reference by invoking `parcAtomicUint8_Release`.
 *
 * @param [in] instance A pointer to a valid PARCAtomicUint8 instance.
 *
 * @return The same value as @p instance.
 *
 * Example:
 * @code
 * {
 *     PARCAtomicUint8 *a = parcAtomicUint8_Create();
 *
 *     PARCAtomicUint8 *b = parcAtomicUint8_Acquire();
 *
 *     parcAtomicUint8_Release(&a);
 *     parcAtomicUint8_Release(&b);
 * }
 * @endcode
 */
PARCAtomicUint8 *parcAtomicUint8_Acquire(const PARCAtomicUint8 *instance);

#ifdef PARCLibrary_DISABLE_VALIDATION
#  define parcAtomicUint8_OptionalAssertValid(_instance_)
#else
#  define parcAtomicUint8_OptionalAssertValid(_instance_) parcAtomicUint8_AssertValid(_instance_)
#endif

/**
 * Assert that the given `PARCAtomicUint8` instance is valid.
 *
 * @param [in] instance A pointer to a valid PARCAtomicUint8 instance.
 *
 * Example:
 * @code
 * {
 *     PARCAtomicUint8 *a = parcAtomicUint8_Create();
 *
 *     parcAtomicUint8_AssertValid(a);
 *
 *     printf("Instance is valid.\n");
 *
 *     parcAtomicUint8_Release(&b);
 * }
 * @endcode
 */
void parcAtomicUint8_AssertValid(const PARCAtomicUint8 *instance);

/**
 * Create an instance of PARCAtomicUint8
 *
 * <#Paragraphs Of Explanation#>
 *
 * @return non-NULL A pointer to a valid PARCAtomicUint8 instance.
 * @return NULL An error occurred.
 *
 * Example:
 * @code
 * {
 *     PARCAtomicUint8 *a = parcAtomicUint8_Create();
 *
 *     parcAtomicUint8_Release(&b);
 * }
 * @endcode
 */
PARCAtomicUint8 *parcAtomicUint8_Create(uint8_t);

/**
 * Compares @p instance with @p other for order.
 *
 * Returns a negative integer, zero, or a positive integer as @p instance
 * is less than, equal to, or greater than @p other.
 *
 * @param [in] instance A pointer to a valid PARCAtomicUint8 instance.
 * @param [in] other A pointer to a valid PARCAtomicUint8 instance.
 *
 * @return <0 Instance is less than @p other.
 * @return 0 Instance a and instance b compare the same.
 * @return >0 Instance a is greater than instance b.
 *
 * Example:
 * @code
 * {
 *     PARCAtomicUint8 *a = parcAtomicUint8_Create();
 *     PARCAtomicUint8 *b = parcAtomicUint8_Create();
 *
 *     if (parcAtomicUint8_Compare(a, b) == 0) {
 *         printf("Instances are equal.\n");
 *     }
 *
 *     parcAtomicUint8_Release(&a);
 *     parcAtomicUint8_Release(&b);
 * }
 * @endcode
 *
 * @see parcAtomicUint8_Equals
 */
int parcAtomicUint8_Compare(const PARCAtomicUint8 *instance, const PARCAtomicUint8 *other);

/**
 * Create an independent copy the given `PARCBuffer`
 *
 * A new buffer is created as a complete copy of the original.
 *
 * @param [in] original A pointer to a valid PARCAtomicUint8 instance.
 *
 * @return NULL Memory could not be allocated.
 * @return non-NULL A pointer to a new `PARCAtomicUint8` instance.
 *
 * Example:
 * @code
 * {
 *     PARCAtomicUint8 *a = parcAtomicUint8_Create();
 *
 *     PARCAtomicUint8 *copy = parcAtomicUint8_Copy(&b);
 *
 *     parcAtomicUint8_Release(&b);
 *     parcAtomicUint8_Release(&copy);
 * }
 * @endcode
 */
PARCAtomicUint8 *parcAtomicUint8_Copy(const PARCAtomicUint8 *original);

/**
 * Determine if two `PARCAtomicUint8` instances are equal.
 *
 * The following equivalence relations on non-null `PARCAtomicUint8` instances are maintained: *
 *   * It is reflexive: for any non-null reference value x, `parcAtomicUint8_Equals(x, x)` must return true.
 *
 *   * It is symmetric: for any non-null reference values x and y, `parcAtomicUint8_Equals(x, y)` must return true if and only if
 *        `parcAtomicUint8_Equals(y x)` returns true.
 *
 *   * It is transitive: for any non-null reference values x, y, and z, if
 *        `parcAtomicUint8_Equals(x, y)` returns true and
 *        `parcAtomicUint8_Equals(y, z)` returns true,
 *        then `parcAtomicUint8_Equals(x, z)` must return true.
 *
 *   * It is consistent: for any non-null reference values x and y, multiple invocations of `parcAtomicUint8_Equals(x, y)`
 *         consistently return true or consistently return false.
 *
 *   * For any non-null reference value x, `parcAtomicUint8_Equals(x, NULL)` must return false.
 *
 * @param [in] x A pointer to a valid PARCAtomicUint8 instance.
 * @param [in] y A pointer to a valid PARCAtomicUint8 instance.
 *
 * @return true The instances x and y are equal.
 *
 * Example:
 * @code
 * {
 *     PARCAtomicUint8 *a = parcAtomicUint8_Create();
 *     PARCAtomicUint8 *b = parcAtomicUint8_Create();
 *
 *     if (parcAtomicUint8_Equals(a, b)) {
 *         printf("Instances are equal.\n");
 *     }
 *
 *     parcAtomicUint8_Release(&a);
 *     parcAtomicUint8_Release(&b);
 * }
 * @endcode
 * @see parcAtomicUint8_HashCode
 */
bool parcAtomicUint8_Equals(const PARCAtomicUint8 *x, const PARCAtomicUint8 *y);

/**
 * Returns a hash code value for the given instance.
 *
 * The general contract of `HashCode` is:
 *
 * Whenever it is invoked on the same instance more than once during an execution of an application,
 * the `HashCode` function must consistently return the same value,
 * provided no information used in a corresponding comparisons on the instance is modified.
 *
 * This value need not remain consistent from one execution of an application to another execution of the same application.
 * If two instances are equal according to the {@link parcAtomicUint8_Equals} method,
 * then calling the {@link parcAtomicUint8_HashCode} method on each of the two instances must produce the same integer result.
 *
 * It is not required that if two instances are unequal according to the
 * {@link parcAtomicUint8_Equals} function,
 * then calling the `parcAtomicUint8_HashCode`
 * method on each of the two objects must produce distinct integer results.
 *
 * @param [in] instance A pointer to a valid PARCAtomicUint8 instance.
 *
 * @return The hashcode for the given instance.
 *
 * Example:
 * @code
 * {
 *     PARCAtomicUint8 *a = parcAtomicUint8_Create();
 *
 *     PARCHashCode hashValue = parcAtomicUint8_HashCode(buffer);
 *     parcAtomicUint8_Release(&a);
 * }
 * @endcode
 */
PARCHashCode parcAtomicUint8_HashCode(const PARCAtomicUint8 *instance);

/**
 * Determine if an instance of `PARCAtomicUint8` is valid.
 *
 * Valid means the internal state of the type is consistent with its required current or future behaviour.
 * This may include the validation of internal instances of types.
 *
 * @param [in] instance A pointer to a valid PARCAtomicUint8 instance.
 *
 * @return true The instance is valid.
 * @return false The instance is not valid.
 *
 * Example:
 * @code
 * {
 *     PARCAtomicUint8 *a = parcAtomicUint8_Create();
 *
 *     if (parcAtomicUint8_IsValid(a)) {
 *         printf("Instance is valid.\n");
 *     }
 *
 *     parcAtomicUint8_Release(&b);
 * }
 * @endcode
 */
bool parcAtomicUint8_IsValid(const PARCAtomicUint8 *instance);

/**
 * Release a previously acquired reference to the given `PARCAtomicUint8` instance,
 * decrementing the reference count for the instance.
 *
 * The pointer to the instance is set to NULL as a side-effect of this function.
 *
 * If the invocation causes the last reference to the instance to be released,
 * the instance is deallocated and the instance's implementation will perform
 * additional cleanup and release other privately held references.
 *
 * @param [in,out] instancePtr A pointer to a pointer to the instance to release.
 *
 * Example:
 * @code
 * {
 *     PARCAtomicUint8 *a = parcAtomicUint8_Create();
 *
 *     parcAtomicUint8_Release(&a);
 * }
 * @endcode
 */
void parcAtomicUint8_Release(PARCAtomicUint8 **instancePtr);

/**
 * Get the current value of the given `PARCAtomicUint8` instance.
 *
 * @param [in] instance A pointer to a valid `PARCAtomicUint8` instance.
 *
 * @return the current value of the given `PARCAtomicUint8` instance.
 *
 * Example:
 * @code
 * {
 *     PARCAtomicUint8 *instance = parcAtomicUint8_Create(7);
 *
 *     uint8_t value = parcAtomicUint8_GetValue(instance);
 *
 *     parcAtomicUint8_Release(&instance);
 * }
 * @endcode
 */
uint8_t parcAtomicUint8_GetValue(const PARCAtomicUint8 *instance);
#endif