2 * Copyright © 2016 Advanced Micro Devices, Inc.
5 * Permission is hereby granted, free of charge, to any person obtaining
6 * a copy of this software and associated documentation files (the
7 * "Software"), to deal in the Software without restriction, including
8 * without limitation the rights to use, copy, modify, merge, publish,
9 * distribute, sub license, and/or sell copies of the Software, and to
10 * permit persons to whom the Software is furnished to do so, subject to
11 * the following conditions:
13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
14 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
15 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
16 * NON-INFRINGEMENT. IN NO EVENT SHALL THE COPYRIGHT HOLDERS, AUTHORS
17 * AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 * USE OR OTHER DEALINGS IN THE SOFTWARE.
22 * The above copyright notice and this permission notice (including the
23 * next paragraph) shall be included in all copies or substantial portions
28 #include "util/u_string.h"
30 static void util_queue_killall_and_wait(struct util_queue
*queue
);
32 /****************************************************************************
33 * Wait for all queues to assert idle when exit() is called.
35 * Otherwise, C++ static variable destructors can be called while threads
36 * are using the static variables.
39 static once_flag atexit_once_flag
= ONCE_FLAG_INIT
;
40 static struct list_head queue_list
;
41 static mtx_t exit_mutex
= _MTX_INITIALIZER_NP
;
46 struct util_queue
*iter
;
48 mtx_lock(&exit_mutex
);
49 /* Wait for all queues to assert idle. */
50 LIST_FOR_EACH_ENTRY(iter
, &queue_list
, head
) {
51 util_queue_killall_and_wait(iter
);
53 mtx_unlock(&exit_mutex
);
59 LIST_INITHEAD(&queue_list
);
60 atexit(atexit_handler
);
64 add_to_atexit_list(struct util_queue
*queue
)
66 call_once(&atexit_once_flag
, global_init
);
68 mtx_lock(&exit_mutex
);
69 LIST_ADD(&queue
->head
, &queue_list
);
70 mtx_unlock(&exit_mutex
);
74 remove_from_atexit_list(struct util_queue
*queue
)
76 struct util_queue
*iter
, *tmp
;
78 mtx_lock(&exit_mutex
);
79 LIST_FOR_EACH_ENTRY_SAFE(iter
, tmp
, &queue_list
, head
) {
81 LIST_DEL(&iter
->head
);
85 mtx_unlock(&exit_mutex
);
88 /****************************************************************************
93 util_queue_fence_signal(struct util_queue_fence
*fence
)
95 mtx_lock(&fence
->mutex
);
96 fence
->signalled
= true;
97 cnd_broadcast(&fence
->cond
);
98 mtx_unlock(&fence
->mutex
);
102 util_queue_fence_wait(struct util_queue_fence
*fence
)
104 mtx_lock(&fence
->mutex
);
105 while (!fence
->signalled
)
106 cnd_wait(&fence
->cond
, &fence
->mutex
);
107 mtx_unlock(&fence
->mutex
);
111 util_queue_fence_init(struct util_queue_fence
*fence
)
113 memset(fence
, 0, sizeof(*fence
));
114 (void) mtx_init(&fence
->mutex
, mtx_plain
);
115 cnd_init(&fence
->cond
);
116 fence
->signalled
= true;
120 util_queue_fence_destroy(struct util_queue_fence
*fence
)
122 assert(fence
->signalled
);
123 cnd_destroy(&fence
->cond
);
124 mtx_destroy(&fence
->mutex
);
127 /****************************************************************************
128 * util_queue implementation
131 struct thread_input
{
132 struct util_queue
*queue
;
137 util_queue_thread_func(void *input
)
139 struct util_queue
*queue
= ((struct thread_input
*)input
)->queue
;
140 int thread_index
= ((struct thread_input
*)input
)->thread_index
;
146 util_snprintf(name
, sizeof(name
), "%s:%i", queue
->name
, thread_index
);
147 u_thread_setname(name
);
151 struct util_queue_job job
;
153 mtx_lock(&queue
->lock
);
154 assert(queue
->num_queued
>= 0 && queue
->num_queued
<= queue
->max_jobs
);
156 /* wait if the queue is empty */
157 while (!queue
->kill_threads
&& queue
->num_queued
== 0)
158 cnd_wait(&queue
->has_queued_cond
, &queue
->lock
);
160 if (queue
->kill_threads
) {
161 mtx_unlock(&queue
->lock
);
165 job
= queue
->jobs
[queue
->read_idx
];
166 memset(&queue
->jobs
[queue
->read_idx
], 0, sizeof(struct util_queue_job
));
167 queue
->read_idx
= (queue
->read_idx
+ 1) % queue
->max_jobs
;
170 cnd_signal(&queue
->has_space_cond
);
171 mtx_unlock(&queue
->lock
);
174 job
.execute(job
.job
, thread_index
);
175 util_queue_fence_signal(job
.fence
);
177 job
.cleanup(job
.job
, thread_index
);
181 /* signal remaining jobs before terminating */
182 mtx_lock(&queue
->lock
);
183 while (queue
->jobs
[queue
->read_idx
].job
) {
184 util_queue_fence_signal(queue
->jobs
[queue
->read_idx
].fence
);
186 queue
->jobs
[queue
->read_idx
].job
= NULL
;
187 queue
->read_idx
= (queue
->read_idx
+ 1) % queue
->max_jobs
;
189 queue
->num_queued
= 0; /* reset this when exiting the thread */
190 mtx_unlock(&queue
->lock
);
195 util_queue_init(struct util_queue
*queue
,
198 unsigned num_threads
)
202 memset(queue
, 0, sizeof(*queue
));
204 queue
->num_threads
= num_threads
;
205 queue
->max_jobs
= max_jobs
;
207 queue
->jobs
= (struct util_queue_job
*)
208 calloc(max_jobs
, sizeof(struct util_queue_job
));
212 (void) mtx_init(&queue
->lock
, mtx_plain
);
214 queue
->num_queued
= 0;
215 cnd_init(&queue
->has_queued_cond
);
216 cnd_init(&queue
->has_space_cond
);
218 queue
->threads
= (thrd_t
*) calloc(num_threads
, sizeof(thrd_t
));
223 for (i
= 0; i
< num_threads
; i
++) {
224 struct thread_input
*input
=
225 (struct thread_input
*) malloc(sizeof(struct thread_input
));
226 input
->queue
= queue
;
227 input
->thread_index
= i
;
229 queue
->threads
[i
] = u_thread_create(util_queue_thread_func
, input
);
231 if (!queue
->threads
[i
]) {
235 /* no threads created, fail */
238 /* at least one thread created, so use it */
239 queue
->num_threads
= i
;
245 add_to_atexit_list(queue
);
249 free(queue
->threads
);
252 cnd_destroy(&queue
->has_space_cond
);
253 cnd_destroy(&queue
->has_queued_cond
);
254 mtx_destroy(&queue
->lock
);
257 /* also util_queue_is_initialized can be used to check for success */
258 memset(queue
, 0, sizeof(*queue
));
263 util_queue_killall_and_wait(struct util_queue
*queue
)
267 /* Signal all threads to terminate. */
268 mtx_lock(&queue
->lock
);
269 queue
->kill_threads
= 1;
270 cnd_broadcast(&queue
->has_queued_cond
);
271 mtx_unlock(&queue
->lock
);
273 for (i
= 0; i
< queue
->num_threads
; i
++)
274 thrd_join(queue
->threads
[i
], NULL
);
275 queue
->num_threads
= 0;
279 util_queue_destroy(struct util_queue
*queue
)
281 util_queue_killall_and_wait(queue
);
282 remove_from_atexit_list(queue
);
284 cnd_destroy(&queue
->has_space_cond
);
285 cnd_destroy(&queue
->has_queued_cond
);
286 mtx_destroy(&queue
->lock
);
288 free(queue
->threads
);
292 util_queue_add_job(struct util_queue
*queue
,
294 struct util_queue_fence
*fence
,
295 util_queue_execute_func execute
,
296 util_queue_execute_func cleanup
)
298 struct util_queue_job
*ptr
;
300 assert(fence
->signalled
);
301 fence
->signalled
= false;
303 mtx_lock(&queue
->lock
);
304 assert(queue
->num_queued
>= 0 && queue
->num_queued
<= queue
->max_jobs
);
306 /* if the queue is full, wait until there is space */
307 while (queue
->num_queued
== queue
->max_jobs
)
308 cnd_wait(&queue
->has_space_cond
, &queue
->lock
);
310 ptr
= &queue
->jobs
[queue
->write_idx
];
311 assert(ptr
->job
== NULL
);
314 ptr
->execute
= execute
;
315 ptr
->cleanup
= cleanup
;
316 queue
->write_idx
= (queue
->write_idx
+ 1) % queue
->max_jobs
;
319 cnd_signal(&queue
->has_queued_cond
);
320 mtx_unlock(&queue
->lock
);
324 util_queue_get_thread_time_nano(struct util_queue
*queue
, unsigned thread_index
)
326 /* Allow some flexibility by not raising an error. */
327 if (thread_index
>= queue
->num_threads
)
330 return u_thread_get_time_nano(queue
->threads
[thread_index
]);