u_queue: group fence functions together
[mesa.git] / src / util / u_queue.h
1 /*
2 * Copyright © 2016 Advanced Micro Devices, Inc.
3 * All Rights Reserved.
4 *
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:
12 *
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.
21 *
22 * The above copyright notice and this permission notice (including the
23 * next paragraph) shall be included in all copies or substantial portions
24 * of the Software.
25 */
26
27 /* Job queue with execution in a separate thread.
28 *
29 * Jobs can be added from any thread. After that, the wait call can be used
30 * to wait for completion of the job.
31 */
32
33 #ifndef U_QUEUE_H
34 #define U_QUEUE_H
35
36 #include <string.h>
37
38 #include "util/list.h"
39 #include "util/u_thread.h"
40
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44
45 #define UTIL_QUEUE_INIT_USE_MINIMUM_PRIORITY (1 << 0)
46 #define UTIL_QUEUE_INIT_RESIZE_IF_FULL (1 << 1)
47
48 /* Job completion fence.
49 * Put this into your job structure.
50 */
51 struct util_queue_fence {
52 mtx_t mutex;
53 cnd_t cond;
54 int signalled;
55 };
56
57 void util_queue_fence_init(struct util_queue_fence *fence);
58 void util_queue_fence_destroy(struct util_queue_fence *fence);
59 void util_queue_fence_wait(struct util_queue_fence *fence);
60
61 static inline bool
62 util_queue_fence_is_signalled(struct util_queue_fence *fence)
63 {
64 return fence->signalled != 0;
65 }
66
67 typedef void (*util_queue_execute_func)(void *job, int thread_index);
68
69 struct util_queue_job {
70 void *job;
71 struct util_queue_fence *fence;
72 util_queue_execute_func execute;
73 util_queue_execute_func cleanup;
74 };
75
76 /* Put this into your context. */
77 struct util_queue {
78 const char *name;
79 mtx_t lock;
80 cnd_t has_queued_cond;
81 cnd_t has_space_cond;
82 thrd_t *threads;
83 unsigned flags;
84 int num_queued;
85 unsigned num_threads;
86 int kill_threads;
87 int max_jobs;
88 int write_idx, read_idx; /* ring buffer pointers */
89 struct util_queue_job *jobs;
90
91 /* for cleanup at exit(), protected by exit_mutex */
92 struct list_head head;
93 };
94
95 bool util_queue_init(struct util_queue *queue,
96 const char *name,
97 unsigned max_jobs,
98 unsigned num_threads,
99 unsigned flags);
100 void util_queue_destroy(struct util_queue *queue);
101
102 /* optional cleanup callback is called after fence is signaled: */
103 void util_queue_add_job(struct util_queue *queue,
104 void *job,
105 struct util_queue_fence *fence,
106 util_queue_execute_func execute,
107 util_queue_execute_func cleanup);
108 void util_queue_drop_job(struct util_queue *queue,
109 struct util_queue_fence *fence);
110
111 int64_t util_queue_get_thread_time_nano(struct util_queue *queue,
112 unsigned thread_index);
113
114 /* util_queue needs to be cleared to zeroes for this to work */
115 static inline bool
116 util_queue_is_initialized(struct util_queue *queue)
117 {
118 return queue->threads != NULL;
119 }
120
121 /* Convenient structure for monitoring the queue externally and passing
122 * the structure between Mesa components. The queue doesn't use it directly.
123 */
124 struct util_queue_monitoring
125 {
126 /* For querying the thread busyness. */
127 struct util_queue *queue;
128
129 /* Counters updated by the user of the queue. */
130 unsigned num_offloaded_items;
131 unsigned num_direct_items;
132 unsigned num_syncs;
133 };
134
135 #ifdef __cplusplus
136 }
137 #endif
138
139 #endif