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>
65 #include "util/hash_table.h"
67 #include "util/u_memory.h"
71 static struct gl_sync_object
*
72 _mesa_new_sync_object(struct gl_context
*ctx
)
74 struct gl_sync_object
*s
= CALLOC_STRUCT(gl_sync_object
);
82 _mesa_delete_sync_object(struct gl_context
*ctx
, struct gl_sync_object
*syncObj
)
91 _mesa_fence_sync(struct gl_context
*ctx
, struct gl_sync_object
*syncObj
,
92 GLenum condition
, GLbitfield flags
)
98 syncObj
->StatusFlag
= 1;
103 _mesa_check_sync(struct gl_context
*ctx
, struct gl_sync_object
*syncObj
)
108 /* No-op for software rendering. Hardware drivers will need to determine
109 * whether the state of the sync object has changed.
115 _mesa_wait_sync(struct gl_context
*ctx
, struct gl_sync_object
*syncObj
,
116 GLbitfield flags
, GLuint64 timeout
)
123 /* No-op for software rendering. Hardware drivers will need to wait until
124 * the state of the sync object changes or the timeout expires.
130 _mesa_init_sync_object_functions(struct dd_function_table
*driver
)
132 driver
->NewSyncObject
= _mesa_new_sync_object
;
133 driver
->FenceSync
= _mesa_fence_sync
;
134 driver
->DeleteSyncObject
= _mesa_delete_sync_object
;
135 driver
->CheckSync
= _mesa_check_sync
;
137 /* Use the same no-op wait function for both.
139 driver
->ClientWaitSync
= _mesa_wait_sync
;
140 driver
->ServerWaitSync
= _mesa_wait_sync
;
144 * Allocate/init the context state related to sync objects.
147 _mesa_init_sync(struct gl_context
*ctx
)
154 * Free the context state related to sync objects.
157 _mesa_free_sync_data(struct gl_context
*ctx
)
164 * Check if the given sync object is:
166 * - not in sync objects hash table
167 * - not marked as deleted
169 * Returns the internal gl_sync_object pointer if the sync object is valid
170 * or NULL if it isn't.
172 * If "incRefCount" is true, the reference count is incremented, which is
173 * normally what you want; otherwise, a glDeleteSync from another thread
174 * could delete the sync object while you are still working on it.
176 struct gl_sync_object
*
177 _mesa_get_and_ref_sync(struct gl_context
*ctx
, GLsync sync
, bool incRefCount
)
179 struct gl_sync_object
*syncObj
= (struct gl_sync_object
*) sync
;
180 simple_mtx_lock(&ctx
->Shared
->Mutex
);
182 && _mesa_set_search(ctx
->Shared
->SyncObjects
, syncObj
) != NULL
183 && !syncObj
->DeletePending
) {
190 simple_mtx_unlock(&ctx
->Shared
->Mutex
);
196 _mesa_unref_sync_object(struct gl_context
*ctx
, struct gl_sync_object
*syncObj
,
199 struct set_entry
*entry
;
201 simple_mtx_lock(&ctx
->Shared
->Mutex
);
202 syncObj
->RefCount
-= amount
;
203 if (syncObj
->RefCount
== 0) {
204 entry
= _mesa_set_search(ctx
->Shared
->SyncObjects
, syncObj
);
205 assert (entry
!= NULL
);
206 _mesa_set_remove(ctx
->Shared
->SyncObjects
, entry
);
207 simple_mtx_unlock(&ctx
->Shared
->Mutex
);
209 ctx
->Driver
.DeleteSyncObject(ctx
, syncObj
);
211 simple_mtx_unlock(&ctx
->Shared
->Mutex
);
217 _mesa_IsSync(GLsync sync
)
219 GET_CURRENT_CONTEXT(ctx
);
220 ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx
, GL_FALSE
);
222 return _mesa_get_and_ref_sync(ctx
, sync
, false) ? GL_TRUE
: GL_FALSE
;
226 static ALWAYS_INLINE
void
227 delete_sync(struct gl_context
*ctx
, GLsync sync
, bool no_error
)
229 struct gl_sync_object
*syncObj
;
231 /* From the GL_ARB_sync spec:
233 * DeleteSync will silently ignore a <sync> value of zero. An
234 * INVALID_VALUE error is generated if <sync> is neither zero nor the
235 * name of a sync object.
241 syncObj
= _mesa_get_and_ref_sync(ctx
, sync
, true);
242 if (!no_error
&& !syncObj
) {
243 _mesa_error(ctx
, GL_INVALID_VALUE
,
244 "glDeleteSync (not a valid sync object)");
248 /* If there are no client-waits or server-waits pending on this sync, delete
249 * the underlying object. Note that we double-unref the object, as
250 * _mesa_get_and_ref_sync above took an extra refcount to make sure the
251 * pointer is valid for us to manipulate.
253 syncObj
->DeletePending
= GL_TRUE
;
254 _mesa_unref_sync_object(ctx
, syncObj
, 2);
259 _mesa_DeleteSync_no_error(GLsync sync
)
261 GET_CURRENT_CONTEXT(ctx
);
262 delete_sync(ctx
, sync
, true);
267 _mesa_DeleteSync(GLsync sync
)
269 GET_CURRENT_CONTEXT(ctx
);
270 delete_sync(ctx
, sync
, false);
275 fence_sync(struct gl_context
*ctx
, GLenum condition
, GLbitfield flags
)
277 struct gl_sync_object
*syncObj
;
279 syncObj
= ctx
->Driver
.NewSyncObject(ctx
);
280 if (syncObj
!= NULL
) {
281 /* The name is not currently used, and it is never visible to
282 * applications. If sync support is extended to provide support for
283 * NV_fence, this field will be used. We'll also need to add an object
287 syncObj
->RefCount
= 1;
288 syncObj
->DeletePending
= GL_FALSE
;
289 syncObj
->SyncCondition
= condition
;
290 syncObj
->Flags
= flags
;
291 syncObj
->StatusFlag
= 0;
293 ctx
->Driver
.FenceSync(ctx
, syncObj
, condition
, flags
);
295 simple_mtx_lock(&ctx
->Shared
->Mutex
);
296 _mesa_set_add(ctx
->Shared
->SyncObjects
, syncObj
);
297 simple_mtx_unlock(&ctx
->Shared
->Mutex
);
299 return (GLsync
)syncObj
;
307 _mesa_FenceSync_no_error(GLenum condition
, GLbitfield flags
)
309 GET_CURRENT_CONTEXT(ctx
);
310 return fence_sync(ctx
, condition
, flags
);
315 _mesa_FenceSync(GLenum condition
, GLbitfield flags
)
317 GET_CURRENT_CONTEXT(ctx
);
318 ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx
, 0);
320 if (condition
!= GL_SYNC_GPU_COMMANDS_COMPLETE
) {
321 _mesa_error(ctx
, GL_INVALID_ENUM
, "glFenceSync(condition=0x%x)",
327 _mesa_error(ctx
, GL_INVALID_VALUE
, "glFenceSync(flags=0x%x)", condition
);
331 return fence_sync(ctx
, condition
, flags
);
336 client_wait_sync(struct gl_context
*ctx
, struct gl_sync_object
*syncObj
,
337 GLbitfield flags
, GLuint64 timeout
)
341 /* From the GL_ARB_sync spec:
343 * ClientWaitSync returns one of four status values. A return value of
344 * ALREADY_SIGNALED indicates that <sync> was signaled at the time
345 * ClientWaitSync was called. ALREADY_SIGNALED will always be returned
346 * if <sync> was signaled, even if the value of <timeout> is zero.
348 ctx
->Driver
.CheckSync(ctx
, syncObj
);
349 if (syncObj
->StatusFlag
) {
350 ret
= GL_ALREADY_SIGNALED
;
353 ret
= GL_TIMEOUT_EXPIRED
;
355 ctx
->Driver
.ClientWaitSync(ctx
, syncObj
, flags
, timeout
);
357 ret
= syncObj
->StatusFlag
358 ? GL_CONDITION_SATISFIED
: GL_TIMEOUT_EXPIRED
;
362 _mesa_unref_sync_object(ctx
, syncObj
, 1);
368 _mesa_ClientWaitSync_no_error(GLsync sync
, GLbitfield flags
, GLuint64 timeout
)
370 GET_CURRENT_CONTEXT(ctx
);
372 struct gl_sync_object
*syncObj
= _mesa_get_and_ref_sync(ctx
, sync
, true);
373 return client_wait_sync(ctx
, syncObj
, flags
, timeout
);
378 _mesa_ClientWaitSync(GLsync sync
, GLbitfield flags
, GLuint64 timeout
)
380 GET_CURRENT_CONTEXT(ctx
);
381 struct gl_sync_object
*syncObj
;
383 ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx
, GL_WAIT_FAILED
);
385 if ((flags
& ~GL_SYNC_FLUSH_COMMANDS_BIT
) != 0) {
386 _mesa_error(ctx
, GL_INVALID_VALUE
, "glClientWaitSync(flags=0x%x)", flags
);
387 return GL_WAIT_FAILED
;
390 syncObj
= _mesa_get_and_ref_sync(ctx
, sync
, true);
392 _mesa_error(ctx
, GL_INVALID_VALUE
,
393 "glClientWaitSync (not a valid sync object)");
394 return GL_WAIT_FAILED
;
397 return client_wait_sync(ctx
, syncObj
, flags
, timeout
);
402 wait_sync(struct gl_context
*ctx
, struct gl_sync_object
*syncObj
,
403 GLbitfield flags
, GLuint64 timeout
)
405 ctx
->Driver
.ServerWaitSync(ctx
, syncObj
, flags
, timeout
);
406 _mesa_unref_sync_object(ctx
, syncObj
, 1);
411 _mesa_WaitSync_no_error(GLsync sync
, GLbitfield flags
, GLuint64 timeout
)
413 GET_CURRENT_CONTEXT(ctx
);
415 struct gl_sync_object
*syncObj
= _mesa_get_and_ref_sync(ctx
, sync
, true);
416 wait_sync(ctx
, syncObj
, flags
, timeout
);
421 _mesa_WaitSync(GLsync sync
, GLbitfield flags
, GLuint64 timeout
)
423 GET_CURRENT_CONTEXT(ctx
);
424 struct gl_sync_object
*syncObj
;
427 _mesa_error(ctx
, GL_INVALID_VALUE
, "glWaitSync(flags=0x%x)", flags
);
431 if (timeout
!= GL_TIMEOUT_IGNORED
) {
432 _mesa_error(ctx
, GL_INVALID_VALUE
, "glWaitSync(timeout=0x%" PRIx64
")",
437 syncObj
= _mesa_get_and_ref_sync(ctx
, sync
, true);
439 _mesa_error(ctx
, GL_INVALID_VALUE
,
440 "glWaitSync (not a valid sync object)");
444 wait_sync(ctx
, syncObj
, flags
, timeout
);
449 _mesa_GetSynciv(GLsync sync
, GLenum pname
, GLsizei bufSize
, GLsizei
*length
,
452 GET_CURRENT_CONTEXT(ctx
);
453 struct gl_sync_object
*syncObj
;
457 syncObj
= _mesa_get_and_ref_sync(ctx
, sync
, true);
459 _mesa_error(ctx
, GL_INVALID_VALUE
,
460 "glGetSynciv (not a valid sync object)");
466 v
[0] = GL_SYNC_FENCE
;
470 case GL_SYNC_CONDITION
:
471 v
[0] = syncObj
->SyncCondition
;
476 /* Update the state of the sync by dipping into the driver. Note that
477 * this call won't block. It just updates state in the common object
478 * data from the current driver state.
480 ctx
->Driver
.CheckSync(ctx
, syncObj
);
482 v
[0] = (syncObj
->StatusFlag
) ? GL_SIGNALED
: GL_UNSIGNALED
;
487 v
[0] = syncObj
->Flags
;
492 _mesa_error(ctx
, GL_INVALID_ENUM
, "glGetSynciv(pname=0x%x)\n", pname
);
493 _mesa_unref_sync_object(ctx
, syncObj
, 1);
497 /* Section 4.1.3 (Sync Object Queries) of the OpenGL ES 3.10 spec says:
499 * "An INVALID_VALUE error is generated if bufSize is negative."
502 _mesa_error(ctx
, GL_INVALID_VALUE
, "glGetSynciv(pname=0x%x)\n", pname
);
505 if (size
> 0 && bufSize
> 0) {
506 const GLsizei copy_count
= MIN2(size
, bufSize
);
508 memcpy(values
, v
, sizeof(GLint
) * copy_count
);
511 if (length
!= NULL
) {
515 _mesa_unref_sync_object(ctx
, syncObj
, 1);