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
27 /* Job queue with execution in a separate thread.
29 * Jobs can be added from any thread. After that, the wait call can be used
30 * to wait for completion of the job.
38 #include "util/futex.h"
39 #include "util/list.h"
40 #include "util/macros.h"
41 #include "util/os_time.h"
42 #include "util/u_atomic.h"
43 #include "util/u_thread.h"
49 #define UTIL_QUEUE_INIT_USE_MINIMUM_PRIORITY (1 << 0)
50 #define UTIL_QUEUE_INIT_RESIZE_IF_FULL (1 << 1)
51 #define UTIL_QUEUE_INIT_SET_FULL_THREAD_AFFINITY (1 << 2)
53 #if defined(__GNUC__) && defined(HAVE_LINUX_FUTEX_H)
54 #define UTIL_QUEUE_FENCE_FUTEX
56 #define UTIL_QUEUE_FENCE_STANDARD
59 #ifdef UTIL_QUEUE_FENCE_FUTEX
60 /* Job completion fence.
61 * Put this into your job structure.
63 struct util_queue_fence {
64 /* The fence can be in one of three states:
67 * 2 - unsignaled, may have waiters
73 util_queue_fence_init(struct util_queue_fence *fence)
79 util_queue_fence_destroy(struct util_queue_fence *fence)
81 assert(fence->val == 0);
86 util_queue_fence_signal(struct util_queue_fence *fence)
88 uint32_t val = p_atomic_xchg(&fence->val, 0);
93 futex_wake(&fence->val, INT_MAX);
97 * Move \p fence back into unsignalled state.
99 * \warning The caller must ensure that no other thread may currently be
100 * waiting (or about to wait) on the fence.
103 util_queue_fence_reset(struct util_queue_fence *fence)
108 uint32_t v = p_atomic_xchg(&fence->val, 1);
114 util_queue_fence_is_signalled(struct util_queue_fence *fence)
116 return fence->val == 0;
120 #ifdef UTIL_QUEUE_FENCE_STANDARD
121 /* Job completion fence.
122 * Put this into your job structure.
124 struct util_queue_fence {
130 void util_queue_fence_init(struct util_queue_fence *fence);
131 void util_queue_fence_destroy(struct util_queue_fence *fence);
132 void util_queue_fence_signal(struct util_queue_fence *fence);
135 * Move \p fence back into unsignalled state.
137 * \warning The caller must ensure that no other thread may currently be
138 * waiting (or about to wait) on the fence.
141 util_queue_fence_reset(struct util_queue_fence *fence)
143 assert(fence->signalled);
144 fence->signalled = 0;
148 util_queue_fence_is_signalled(struct util_queue_fence *fence)
150 return fence->signalled != 0;
155 _util_queue_fence_wait(struct util_queue_fence *fence);
158 util_queue_fence_wait(struct util_queue_fence *fence)
160 if (unlikely(!util_queue_fence_is_signalled(fence)))
161 _util_queue_fence_wait(fence);
165 _util_queue_fence_wait_timeout(struct util_queue_fence *fence,
166 int64_t abs_timeout);
169 * Wait for the fence to be signaled with a timeout.
171 * \param fence the fence
172 * \param abs_timeout the absolute timeout in nanoseconds, relative to the
173 * clock provided by os_time_get_nano.
175 * \return true if the fence was signaled, false if the timeout occurred.
178 util_queue_fence_wait_timeout(struct util_queue_fence *fence,
181 if (util_queue_fence_is_signalled(fence))
184 if (abs_timeout == (int64_t)OS_TIMEOUT_INFINITE) {
185 _util_queue_fence_wait(fence);
189 return _util_queue_fence_wait_timeout(fence, abs_timeout);
192 typedef void (*util_queue_execute_func)(void *job, int thread_index);
194 struct util_queue_job {
196 struct util_queue_fence *fence;
197 util_queue_execute_func execute;
198 util_queue_execute_func cleanup;
201 /* Put this into your context. */
203 char name[14]; /* 13 characters = the thread name without the index */
204 mtx_t finish_lock; /* only for util_queue_finish */
206 cnd_t has_queued_cond;
207 cnd_t has_space_cond;
211 unsigned num_threads;
214 int write_idx, read_idx; /* ring buffer pointers */
215 struct util_queue_job *jobs;
217 /* for cleanup at exit(), protected by exit_mutex */
218 struct list_head head;
221 bool util_queue_init(struct util_queue *queue,
224 unsigned num_threads,
226 void util_queue_destroy(struct util_queue *queue);
228 /* optional cleanup callback is called after fence is signaled: */
229 void util_queue_add_job(struct util_queue *queue,
231 struct util_queue_fence *fence,
232 util_queue_execute_func execute,
233 util_queue_execute_func cleanup);
234 void util_queue_drop_job(struct util_queue *queue,
235 struct util_queue_fence *fence);
237 void util_queue_finish(struct util_queue *queue);
239 int64_t util_queue_get_thread_time_nano(struct util_queue *queue,
240 unsigned thread_index);
242 /* util_queue needs to be cleared to zeroes for this to work */
244 util_queue_is_initialized(struct util_queue *queue)
246 return queue->threads != NULL;
249 /* Convenient structure for monitoring the queue externally and passing
250 * the structure between Mesa components. The queue doesn't use it directly.
252 struct util_queue_monitoring
254 /* For querying the thread busyness. */
255 struct util_queue *queue;
257 /* Counters updated by the user of the queue. */
258 unsigned num_offloaded_items;
259 unsigned num_direct_items;