2 * Copyright © 2009 Intel Corporation
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
26 * Sync object management.
28 * Unlike textures and other objects that are shared between contexts, sync
29 * objects are not bound to the context. As a result, the reference counting
30 * and delete behavior of sync objects is slightly different. References to
31 * sync objects are added:
33 * - By \c glFencSynce. This sets the initial reference count to 1.
34 * - At the start of \c glClientWaitSync. The reference is held for the
35 * duration of the wait call.
37 * References are removed:
39 * - By \c glDeleteSync.
40 * - At the end of \c glClientWaitSync.
42 * Additionally, drivers may call \c _mesa_ref_sync_object and
43 * \c _mesa_unref_sync_object as needed to implement \c ServerWaitSync.
45 * As with shader objects, sync object names become invalid as soon as
46 * \c glDeleteSync is called. For this reason \c glDeleteSync sets the
47 * \c DeletePending flag. All functions validate object handles by testing
51 * Only \c GL_ARB_sync objects are shared between contexts. If support is ever
52 * added for either \c GL_NV_fence or \c GL_APPLE_fence different semantics
53 * will need to be implemented.
55 * \author Ian Romanick <ian.d.romanick@intel.com>
60 #include "util/imports.h"
65 #include "util/hash_table.h"
70 static struct gl_sync_object
*
71 _mesa_new_sync_object(struct gl_context
*ctx
)
73 struct gl_sync_object
*s
= CALLOC_STRUCT(gl_sync_object
);
81 _mesa_delete_sync_object(struct gl_context
*ctx
, struct gl_sync_object
*syncObj
)
90 _mesa_fence_sync(struct gl_context
*ctx
, struct gl_sync_object
*syncObj
,
91 GLenum condition
, GLbitfield flags
)
97 syncObj
->StatusFlag
= 1;
102 _mesa_check_sync(struct gl_context
*ctx
, struct gl_sync_object
*syncObj
)
107 /* No-op for software rendering. Hardware drivers will need to determine
108 * whether the state of the sync object has changed.
114 _mesa_wait_sync(struct gl_context
*ctx
, struct gl_sync_object
*syncObj
,
115 GLbitfield flags
, GLuint64 timeout
)
122 /* No-op for software rendering. Hardware drivers will need to wait until
123 * the state of the sync object changes or the timeout expires.
129 _mesa_init_sync_object_functions(struct dd_function_table
*driver
)
131 driver
->NewSyncObject
= _mesa_new_sync_object
;
132 driver
->FenceSync
= _mesa_fence_sync
;
133 driver
->DeleteSyncObject
= _mesa_delete_sync_object
;
134 driver
->CheckSync
= _mesa_check_sync
;
136 /* Use the same no-op wait function for both.
138 driver
->ClientWaitSync
= _mesa_wait_sync
;
139 driver
->ServerWaitSync
= _mesa_wait_sync
;
143 * Allocate/init the context state related to sync objects.
146 _mesa_init_sync(struct gl_context
*ctx
)
153 * Free the context state related to sync objects.
156 _mesa_free_sync_data(struct gl_context
*ctx
)
163 * Check if the given sync object is:
165 * - not in sync objects hash table
166 * - not marked as deleted
168 * Returns the internal gl_sync_object pointer if the sync object is valid
169 * or NULL if it isn't.
171 * If "incRefCount" is true, the reference count is incremented, which is
172 * normally what you want; otherwise, a glDeleteSync from another thread
173 * could delete the sync object while you are still working on it.
175 struct gl_sync_object
*
176 _mesa_get_and_ref_sync(struct gl_context
*ctx
, GLsync sync
, bool incRefCount
)
178 struct gl_sync_object
*syncObj
= (struct gl_sync_object
*) sync
;
179 simple_mtx_lock(&ctx
->Shared
->Mutex
);
181 && _mesa_set_search(ctx
->Shared
->SyncObjects
, syncObj
) != NULL
182 && !syncObj
->DeletePending
) {
189 simple_mtx_unlock(&ctx
->Shared
->Mutex
);
195 _mesa_unref_sync_object(struct gl_context
*ctx
, struct gl_sync_object
*syncObj
,
198 struct set_entry
*entry
;
200 simple_mtx_lock(&ctx
->Shared
->Mutex
);
201 syncObj
->RefCount
-= amount
;
202 if (syncObj
->RefCount
== 0) {
203 entry
= _mesa_set_search(ctx
->Shared
->SyncObjects
, syncObj
);
204 assert (entry
!= NULL
);
205 _mesa_set_remove(ctx
->Shared
->SyncObjects
, entry
);
206 simple_mtx_unlock(&ctx
->Shared
->Mutex
);
208 ctx
->Driver
.DeleteSyncObject(ctx
, syncObj
);
210 simple_mtx_unlock(&ctx
->Shared
->Mutex
);
216 _mesa_IsSync(GLsync sync
)
218 GET_CURRENT_CONTEXT(ctx
);
219 ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx
, GL_FALSE
);
221 return _mesa_get_and_ref_sync(ctx
, sync
, false) ? GL_TRUE
: GL_FALSE
;
225 static ALWAYS_INLINE
void
226 delete_sync(struct gl_context
*ctx
, GLsync sync
, bool no_error
)
228 struct gl_sync_object
*syncObj
;
230 /* From the GL_ARB_sync spec:
232 * DeleteSync will silently ignore a <sync> value of zero. An
233 * INVALID_VALUE error is generated if <sync> is neither zero nor the
234 * name of a sync object.
240 syncObj
= _mesa_get_and_ref_sync(ctx
, sync
, true);
241 if (!no_error
&& !syncObj
) {
242 _mesa_error(ctx
, GL_INVALID_VALUE
,
243 "glDeleteSync (not a valid sync object)");
247 /* If there are no client-waits or server-waits pending on this sync, delete
248 * the underlying object. Note that we double-unref the object, as
249 * _mesa_get_and_ref_sync above took an extra refcount to make sure the
250 * pointer is valid for us to manipulate.
252 syncObj
->DeletePending
= GL_TRUE
;
253 _mesa_unref_sync_object(ctx
, syncObj
, 2);
258 _mesa_DeleteSync_no_error(GLsync sync
)
260 GET_CURRENT_CONTEXT(ctx
);
261 delete_sync(ctx
, sync
, true);
266 _mesa_DeleteSync(GLsync sync
)
268 GET_CURRENT_CONTEXT(ctx
);
269 delete_sync(ctx
, sync
, false);
274 fence_sync(struct gl_context
*ctx
, GLenum condition
, GLbitfield flags
)
276 struct gl_sync_object
*syncObj
;
278 syncObj
= ctx
->Driver
.NewSyncObject(ctx
);
279 if (syncObj
!= NULL
) {
280 /* The name is not currently used, and it is never visible to
281 * applications. If sync support is extended to provide support for
282 * NV_fence, this field will be used. We'll also need to add an object
286 syncObj
->RefCount
= 1;
287 syncObj
->DeletePending
= GL_FALSE
;
288 syncObj
->SyncCondition
= condition
;
289 syncObj
->Flags
= flags
;
290 syncObj
->StatusFlag
= 0;
292 ctx
->Driver
.FenceSync(ctx
, syncObj
, condition
, flags
);
294 simple_mtx_lock(&ctx
->Shared
->Mutex
);
295 _mesa_set_add(ctx
->Shared
->SyncObjects
, syncObj
);
296 simple_mtx_unlock(&ctx
->Shared
->Mutex
);
298 return (GLsync
)syncObj
;
306 _mesa_FenceSync_no_error(GLenum condition
, GLbitfield flags
)
308 GET_CURRENT_CONTEXT(ctx
);
309 return fence_sync(ctx
, condition
, flags
);
314 _mesa_FenceSync(GLenum condition
, GLbitfield flags
)
316 GET_CURRENT_CONTEXT(ctx
);
317 ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx
, 0);
319 if (condition
!= GL_SYNC_GPU_COMMANDS_COMPLETE
) {
320 _mesa_error(ctx
, GL_INVALID_ENUM
, "glFenceSync(condition=0x%x)",
326 _mesa_error(ctx
, GL_INVALID_VALUE
, "glFenceSync(flags=0x%x)", condition
);
330 return fence_sync(ctx
, condition
, flags
);
335 client_wait_sync(struct gl_context
*ctx
, struct gl_sync_object
*syncObj
,
336 GLbitfield flags
, GLuint64 timeout
)
340 /* From the GL_ARB_sync spec:
342 * ClientWaitSync returns one of four status values. A return value of
343 * ALREADY_SIGNALED indicates that <sync> was signaled at the time
344 * ClientWaitSync was called. ALREADY_SIGNALED will always be returned
345 * if <sync> was signaled, even if the value of <timeout> is zero.
347 ctx
->Driver
.CheckSync(ctx
, syncObj
);
348 if (syncObj
->StatusFlag
) {
349 ret
= GL_ALREADY_SIGNALED
;
352 ret
= GL_TIMEOUT_EXPIRED
;
354 ctx
->Driver
.ClientWaitSync(ctx
, syncObj
, flags
, timeout
);
356 ret
= syncObj
->StatusFlag
357 ? GL_CONDITION_SATISFIED
: GL_TIMEOUT_EXPIRED
;
361 _mesa_unref_sync_object(ctx
, syncObj
, 1);
367 _mesa_ClientWaitSync_no_error(GLsync sync
, GLbitfield flags
, GLuint64 timeout
)
369 GET_CURRENT_CONTEXT(ctx
);
371 struct gl_sync_object
*syncObj
= _mesa_get_and_ref_sync(ctx
, sync
, true);
372 return client_wait_sync(ctx
, syncObj
, flags
, timeout
);
377 _mesa_ClientWaitSync(GLsync sync
, GLbitfield flags
, GLuint64 timeout
)
379 GET_CURRENT_CONTEXT(ctx
);
380 struct gl_sync_object
*syncObj
;
382 ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx
, GL_WAIT_FAILED
);
384 if ((flags
& ~GL_SYNC_FLUSH_COMMANDS_BIT
) != 0) {
385 _mesa_error(ctx
, GL_INVALID_VALUE
, "glClientWaitSync(flags=0x%x)", flags
);
386 return GL_WAIT_FAILED
;
389 syncObj
= _mesa_get_and_ref_sync(ctx
, sync
, true);
391 _mesa_error(ctx
, GL_INVALID_VALUE
,
392 "glClientWaitSync (not a valid sync object)");
393 return GL_WAIT_FAILED
;
396 return client_wait_sync(ctx
, syncObj
, flags
, timeout
);
401 wait_sync(struct gl_context
*ctx
, struct gl_sync_object
*syncObj
,
402 GLbitfield flags
, GLuint64 timeout
)
404 ctx
->Driver
.ServerWaitSync(ctx
, syncObj
, flags
, timeout
);
405 _mesa_unref_sync_object(ctx
, syncObj
, 1);
410 _mesa_WaitSync_no_error(GLsync sync
, GLbitfield flags
, GLuint64 timeout
)
412 GET_CURRENT_CONTEXT(ctx
);
414 struct gl_sync_object
*syncObj
= _mesa_get_and_ref_sync(ctx
, sync
, true);
415 wait_sync(ctx
, syncObj
, flags
, timeout
);
420 _mesa_WaitSync(GLsync sync
, GLbitfield flags
, GLuint64 timeout
)
422 GET_CURRENT_CONTEXT(ctx
);
423 struct gl_sync_object
*syncObj
;
426 _mesa_error(ctx
, GL_INVALID_VALUE
, "glWaitSync(flags=0x%x)", flags
);
430 if (timeout
!= GL_TIMEOUT_IGNORED
) {
431 _mesa_error(ctx
, GL_INVALID_VALUE
, "glWaitSync(timeout=0x%" PRIx64
")",
436 syncObj
= _mesa_get_and_ref_sync(ctx
, sync
, true);
438 _mesa_error(ctx
, GL_INVALID_VALUE
,
439 "glWaitSync (not a valid sync object)");
443 wait_sync(ctx
, syncObj
, flags
, timeout
);
448 _mesa_GetSynciv(GLsync sync
, GLenum pname
, GLsizei bufSize
, GLsizei
*length
,
451 GET_CURRENT_CONTEXT(ctx
);
452 struct gl_sync_object
*syncObj
;
456 syncObj
= _mesa_get_and_ref_sync(ctx
, sync
, true);
458 _mesa_error(ctx
, GL_INVALID_VALUE
,
459 "glGetSynciv (not a valid sync object)");
465 v
[0] = GL_SYNC_FENCE
;
469 case GL_SYNC_CONDITION
:
470 v
[0] = syncObj
->SyncCondition
;
475 /* Update the state of the sync by dipping into the driver. Note that
476 * this call won't block. It just updates state in the common object
477 * data from the current driver state.
479 ctx
->Driver
.CheckSync(ctx
, syncObj
);
481 v
[0] = (syncObj
->StatusFlag
) ? GL_SIGNALED
: GL_UNSIGNALED
;
486 v
[0] = syncObj
->Flags
;
491 _mesa_error(ctx
, GL_INVALID_ENUM
, "glGetSynciv(pname=0x%x)\n", pname
);
492 _mesa_unref_sync_object(ctx
, syncObj
, 1);
496 /* Section 4.1.3 (Sync Object Queries) of the OpenGL ES 3.10 spec says:
498 * "An INVALID_VALUE error is generated if bufSize is negative."
501 _mesa_error(ctx
, GL_INVALID_VALUE
, "glGetSynciv(pname=0x%x)\n", pname
);
504 if (size
> 0 && bufSize
> 0) {
505 const GLsizei copy_count
= MIN2(size
, bufSize
);
507 memcpy(values
, v
, sizeof(GLint
) * copy_count
);
510 if (length
!= NULL
) {
514 _mesa_unref_sync_object(ctx
, syncObj
, 1);