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
|
/* Copyright (c) 2013, Linaro Limited
* All rights reserved.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
/**
* @file
*
* ODP atomic operations
*/
#ifndef ODP_API_ATOMIC_H_
#define ODP_API_ATOMIC_H_
#ifdef __cplusplus
extern "C" {
#endif
/**
* @defgroup odp_atomic ODP ATOMIC
* @details
* <b> Atomic integers </b>
*
* Atomic integer types (odp_atomic_u32_t and odp_atomic_u64_t) can be used to
* implement e.g. shared counters. If not otherwise documented, operations in
* this API are implemented using <b> RELAXED memory ordering </b> (see memory
* order descriptions in the C11 specification). Relaxed operations do not
* provide synchronization or ordering for other memory accesses (initiated
* before or after the operation), only atomicity of the operation itself is
* guaranteed.
*
* @{
*/
/**
* @typedef odp_atomic_u64_t
* Atomic 64-bit unsigned integer
*
* @typedef odp_atomic_u32_t
* Atomic 32-bit unsigned integer
*/
/**
* Initialize atomic uint32 variable
*
* @param atom Pointer to atomic variable
* @param val Value to initialize the variable with
*/
void odp_atomic_init_u32(odp_atomic_u32_t *atom, uint32_t val);
/**
* Load value of atomic uint32 variable
*
* @param atom Pointer to atomic variable
*
* @return Value of the variable
*/
uint32_t odp_atomic_load_u32(odp_atomic_u32_t *atom);
/**
* Store value to atomic uint32 variable
*
* @param atom Pointer to atomic variable
* @param val Value to store in the variable
*/
void odp_atomic_store_u32(odp_atomic_u32_t *atom, uint32_t val);
/**
* Fetch and add to atomic uint32 variable
*
* @param atom Pointer to atomic variable
* @param val Value to be added to the variable
*
* @return Value of the variable before the addition
*/
uint32_t odp_atomic_fetch_add_u32(odp_atomic_u32_t *atom, uint32_t val);
/**
* Add to atomic uint32 variable
*
* @param atom Pointer to atomic variable
* @param val Value to be added to the variable
*/
void odp_atomic_add_u32(odp_atomic_u32_t *atom, uint32_t val);
/**
* Fetch and subtract from atomic uint32 variable
*
* @param atom Pointer to atomic variable
* @param val Value to be subracted from the variable
*
* @return Value of the variable before the subtraction
*/
uint32_t odp_atomic_fetch_sub_u32(odp_atomic_u32_t *atom, uint32_t val);
/**
* Subtract from atomic uint32 variable
*
* @param atom Pointer to atomic variable
* @param val Value to be subtracted from the variable
*/
void odp_atomic_sub_u32(odp_atomic_u32_t *atom, uint32_t val);
/**
* Fetch and increment atomic uint32 variable
*
* @param atom Pointer to atomic variable
*
* @return Value of the variable before the increment
*/
uint32_t odp_atomic_fetch_inc_u32(odp_atomic_u32_t *atom);
/**
* Increment atomic uint32 variable
*
* @param atom Pointer to atomic variable
*/
void odp_atomic_inc_u32(odp_atomic_u32_t *atom);
/**
* Fetch and decrement atomic uint32 variable
*
* @param atom Pointer to atomic variable
*
* @return Value of the variable before the subtraction
*/
uint32_t odp_atomic_fetch_dec_u32(odp_atomic_u32_t *atom);
/**
* Decrement atomic uint32 variable
*
* @param atom Pointer to atomic variable
*/
void odp_atomic_dec_u32(odp_atomic_u32_t *atom);
/**
* Initialize atomic uint64 variable
*
* @param atom Pointer to atomic variable
* @param val Value to initialize the variable with
*/
void odp_atomic_init_u64(odp_atomic_u64_t *atom, uint64_t val);
/**
* Load value of atomic uint64 variable
*
* @param atom Pointer to atomic variable
*
* @return Value of the variable
*/
uint64_t odp_atomic_load_u64(odp_atomic_u64_t *atom);
/**
* Store value to atomic uint64 variable
*
* @param atom Pointer to atomic variable
* @param val Value to store in the variable
*/
void odp_atomic_store_u64(odp_atomic_u64_t *atom, uint64_t val);
/**
* Fetch and add to atomic uint64 variable
*
* @param atom Pointer to atomic variable
* @param val Value to be added to the variable
*
* @return Value of the variable before the addition
*/
uint64_t odp_atomic_fetch_add_u64(odp_atomic_u64_t *atom, uint64_t val);
/**
* Add to atomic uint64 variable
*
* @param atom Pointer to atomic variable
* @param val Value to be added to the variable
*/
void odp_atomic_add_u64(odp_atomic_u64_t *atom, uint64_t val);
/**
* Fetch and subtract from atomic uint64 variable
*
* @param atom Pointer to atomic variable
* @param val Value to be subtracted from the variable
*
* @return Value of the variable before the subtraction
*/
uint64_t odp_atomic_fetch_sub_u64(odp_atomic_u64_t *atom, uint64_t val);
/**
* Subtract from atomic uint64 variable
*
* @param atom Pointer to atomic variable
* @param val Value to be subtracted from the variable
*/
void odp_atomic_sub_u64(odp_atomic_u64_t *atom, uint64_t val);
/**
* Fetch and increment atomic uint64 variable
*
* @param atom Pointer to atomic variable
*
* @return Value of the variable before the increment
*/
uint64_t odp_atomic_fetch_inc_u64(odp_atomic_u64_t *atom);
/**
* Increment atomic uint64 variable
*
* @param atom Pointer to atomic variable
*/
void odp_atomic_inc_u64(odp_atomic_u64_t *atom);
/**
* Fetch and decrement atomic uint64 variable
*
* @param atom Pointer to atomic variable
*
* @return Value of the variable before the decrement
*/
uint64_t odp_atomic_fetch_dec_u64(odp_atomic_u64_t *atom);
/**
* Decrement atomic uint64 variable
*
* @param atom Pointer to atomic variable
*/
void odp_atomic_dec_u64(odp_atomic_u64_t *atom);
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#endif
|
