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
|
/* Copyright (c) 2015, Linaro Limited
* All rights reserved.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
/**
* @file
*
* ODP thread masks
*/
#ifndef ODP_API_THRMASK_H_
#define ODP_API_THRMASK_H_
#include <odp/visibility_begin.h>
#ifdef __cplusplus
extern "C" {
#endif
#include <odp/api/std_types.h>
/** @addtogroup odp_thread
* Thread mask operations.
* @{
*/
/**
* @def ODP_THRMASK_STR_SIZE
* The maximum number of characters needed to record any thread mask as
* a string (output of odp_thrmask_to_str()).
*/
/**
* Add thread mask bits from a string
*
* Each bit set in the string represents a thread ID to be added into the mask.
* The string is null terminated and consists of hexadecimal digits. It may be
* prepended with '0x' and may contain leading zeros (e.g. 0x0001, 0x1 or 1).
* Thread ID zero is located at the least significant bit (0x1).
*
* @param mask Thread mask to modify
* @param str String of hexadecimal digits
*/
void odp_thrmask_from_str(odp_thrmask_t *mask, const char *str);
/**
* Format a string from thread mask
*
* Output string format is defined in odp_thrmask_from_str() documentation,
* except that the string is always prepended with '0x' and does not have any
* leading zeros (e.g. outputs always 0x1 instead of 0x0001 or 1).
*
* @param mask Thread mask
* @param[out] str String pointer for output
* @param size Size of output buffer. Buffer size ODP_THRMASK_STR_SIZE
* or larger will have enough space for any thread mask.
*
* @return Number of characters written (including terminating null char)
* @retval <0 on failure (e.g. buffer too small)
*/
int32_t odp_thrmask_to_str(const odp_thrmask_t *mask, char *str, int32_t size);
/**
* Clear entire thread mask
* @param mask Thread mask to clear
*/
void odp_thrmask_zero(odp_thrmask_t *mask);
/**
* Add thread to mask
* @param mask Thread mask to update
* @param thr Thread ID
*/
void odp_thrmask_set(odp_thrmask_t *mask, int thr);
/**
* Set all threads in mask
*
* Set all possible threads in the mask. All threads from 0 to
* odp_thread_count_max() minus one are set, regardless of which threads are
* actually active.
*
* @param mask Thread mask to set
*/
void odp_thrmask_setall(odp_thrmask_t *mask);
/**
* Remove thread from mask
* @param mask Thread mask to update
* @param thr Thread ID
*/
void odp_thrmask_clr(odp_thrmask_t *mask, int thr);
/**
* Test if thread is a member of mask
*
* @param mask Thread mask to test
* @param thr Thread ID
*
* @return non-zero if set
* @retval 0 if not set
*/
int odp_thrmask_isset(const odp_thrmask_t *mask, int thr);
/**
* Count number of threads set in mask
*
* @param mask Thread mask
*
* @return population count
*/
int odp_thrmask_count(const odp_thrmask_t *mask);
/**
* Member-wise AND over two thread masks
*
* @param dest Destination thread mask (may be one of the source masks)
* @param src1 Source thread mask 1
* @param src2 Source thread mask 2
*/
void odp_thrmask_and(odp_thrmask_t *dest, const odp_thrmask_t *src1,
const odp_thrmask_t *src2);
/**
* Member-wise OR over two thread masks
*
* @param dest Destination thread mask (may be one of the source masks)
* @param src1 Source thread mask 1
* @param src2 Source thread mask 2
*/
void odp_thrmask_or(odp_thrmask_t *dest, const odp_thrmask_t *src1,
const odp_thrmask_t *src2);
/**
* Member-wise XOR over two thread masks
*
* @param dest Destination thread mask (may be one of the source masks)
* @param src1 Source thread mask 1
* @param src2 Source thread mask 2
*/
void odp_thrmask_xor(odp_thrmask_t *dest, const odp_thrmask_t *src1,
const odp_thrmask_t *src2);
/**
* Test if two thread masks contain the same threads
*
* @param mask1 Thread mask 1
* @param mask2 Thread mask 2
*
* @retval non-zero if thread masks equal
* @retval 0 if thread masks not equal
*/
int odp_thrmask_equal(const odp_thrmask_t *mask1,
const odp_thrmask_t *mask2);
/**
* Copy a thread mask
*
* @param dest Destination thread mask
* @param src Source thread mask
*/
void odp_thrmask_copy(odp_thrmask_t *dest, const odp_thrmask_t *src);
/**
* Find first set thread in mask
*
* @param mask thread mask
*
* @return Thread ID
* @retval <0 if no thread found
*/
int odp_thrmask_first(const odp_thrmask_t *mask);
/**
* Find last set thread in mask
*
* @param mask Thread mask
*
* @return Thread ID
* @retval <0 if no thread found
*/
int odp_thrmask_last(const odp_thrmask_t *mask);
/**
* Find next set thread in mask
*
* Finds the next thread in the thread mask, starting at the thread passed.
* Use with odp_thrmask_first to traverse a thread mask, e.g.
*
* int thr = odp_thrmask_first(&mask);
* while (0 <= thr) {
* ...
* ...
* thr = odp_thrmask_next(&mask, thr);
* }
*
* @param mask Thread mask
* @param thr Thread to start from
*
* @return Thread ID
* @retval <0 if no thread found
*
* @see odp_thrmask_first()
*/
int odp_thrmask_next(const odp_thrmask_t *mask, int thr);
/**
* Worker thread mask
*
* Initializes thread mask with current worker threads and returns the count
* set.
*
* @param[out] mask Thread mask to initialize
*
* @return Number of threads in the mask
*/
int odp_thrmask_worker(odp_thrmask_t *mask);
/**
* Control thread mask
*
* Initializes thread mask with current control threads and returns the count
* set.
*
* @param[out] mask Thread mask to initialize
*
* @return Number of threads in the mask
*/
int odp_thrmask_control(odp_thrmask_t *mask);
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#include <odp/visibility_end.h>
#endif
|
