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/list.h"
39 #include "util/u_thread.h"
45 #define UTIL_QUEUE_INIT_USE_MINIMUM_PRIORITY (1 << 0)
47 /* Job completion fence.
48 * Put this into your job structure.
50 struct util_queue_fence
{
56 typedef void (*util_queue_execute_func
)(void *job
, int thread_index
);
58 struct util_queue_job
{
60 struct util_queue_fence
*fence
;
61 util_queue_execute_func execute
;
62 util_queue_execute_func cleanup
;
65 /* Put this into your context. */
69 cnd_t has_queued_cond
;
77 int write_idx
, read_idx
; /* ring buffer pointers */
78 struct util_queue_job
*jobs
;
80 /* for cleanup at exit(), protected by exit_mutex */
81 struct list_head head
;
84 bool util_queue_init(struct util_queue
*queue
,
89 void util_queue_destroy(struct util_queue
*queue
);
90 void util_queue_fence_init(struct util_queue_fence
*fence
);
91 void util_queue_fence_destroy(struct util_queue_fence
*fence
);
93 /* optional cleanup callback is called after fence is signaled: */
94 void util_queue_add_job(struct util_queue
*queue
,
96 struct util_queue_fence
*fence
,
97 util_queue_execute_func execute
,
98 util_queue_execute_func cleanup
);
99 void util_queue_drop_job(struct util_queue
*queue
,
100 struct util_queue_fence
*fence
);
102 void util_queue_fence_wait(struct util_queue_fence
*fence
);
103 int64_t util_queue_get_thread_time_nano(struct util_queue
*queue
,
104 unsigned thread_index
);
106 /* util_queue needs to be cleared to zeroes for this to work */
108 util_queue_is_initialized(struct util_queue
*queue
)
110 return queue
->threads
!= NULL
;
114 util_queue_fence_is_signalled(struct util_queue_fence
*fence
)
116 return fence
->signalled
!= 0;