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>
62 #include "mfeatures.h"
70 static struct gl_sync_object *
71 _mesa_new_sync_object(struct gl_context *ctx, GLenum type)
73 struct gl_sync_object *s = MALLOC_STRUCT(gl_sync_object);
82 _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;
144 _mesa_init_sync_dispatch(struct _glapi_table *disp)
146 SET_IsSync(disp, _mesa_IsSync);
147 SET_DeleteSync(disp, _mesa_DeleteSync);
148 SET_FenceSync(disp, _mesa_FenceSync);
149 SET_ClientWaitSync(disp, _mesa_ClientWaitSync);
150 SET_WaitSync(disp, _mesa_WaitSync);
151 SET_GetInteger64v(disp, _mesa_GetInteger64v);
152 SET_GetSynciv(disp, _mesa_GetSynciv);
157 * Allocate/init the context state related to sync objects.
160 _mesa_init_sync(struct gl_context *ctx)
167 * Free the context state related to sync objects.
170 _mesa_free_sync_data(struct gl_context *ctx)
177 _mesa_validate_sync(struct gl_sync_object *syncObj)
179 return (syncObj != NULL)
180 && (syncObj->Type == GL_SYNC_FENCE)
181 && !syncObj->DeletePending;
186 _mesa_ref_sync_object(struct gl_context *ctx, struct gl_sync_object *syncObj)
188 _glthread_LOCK_MUTEX(ctx->Shared->Mutex);
190 _glthread_UNLOCK_MUTEX(ctx->Shared->Mutex);
195 _mesa_unref_sync_object(struct gl_context *ctx, struct gl_sync_object *syncObj)
197 _glthread_LOCK_MUTEX(ctx->Shared->Mutex);
199 if (syncObj->RefCount == 0) {
200 remove_from_list(& syncObj->link);
201 _glthread_UNLOCK_MUTEX(ctx->Shared->Mutex);
203 ctx->Driver.DeleteSyncObject(ctx, syncObj);
205 _glthread_UNLOCK_MUTEX(ctx->Shared->Mutex);
211 _mesa_IsSync(GLsync sync)
213 GET_CURRENT_CONTEXT(ctx);
214 struct gl_sync_object *const syncObj = (struct gl_sync_object *) sync;
215 ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, GL_FALSE);
217 return _mesa_validate_sync(syncObj) ? GL_TRUE : GL_FALSE;
222 _mesa_DeleteSync(GLsync sync)
224 GET_CURRENT_CONTEXT(ctx);
225 struct gl_sync_object *const syncObj = (struct gl_sync_object *) sync;
226 ASSERT_OUTSIDE_BEGIN_END(ctx);
228 /* From the GL_ARB_sync spec:
230 * DeleteSync will silently ignore a <sync> value of zero. An
231 * INVALID_VALUE error is generated if <sync> is neither zero nor the
232 * name of a sync object.
238 if (!_mesa_validate_sync(syncObj)) {
239 _mesa_error(ctx, GL_INVALID_OPERATION, "glDeleteSync");
243 /* If there are no client-waits or server-waits pending on this sync, delete
244 * the underlying object.
246 syncObj->DeletePending = GL_TRUE;
247 _mesa_unref_sync_object(ctx, syncObj);
252 _mesa_FenceSync(GLenum condition, GLbitfield flags)
254 GET_CURRENT_CONTEXT(ctx);
255 struct gl_sync_object *syncObj;
256 ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, 0);
258 if (condition != GL_SYNC_GPU_COMMANDS_COMPLETE) {
259 _mesa_error(ctx, GL_INVALID_ENUM, "glFenceSync(condition=0x%x)",
265 _mesa_error(ctx, GL_INVALID_VALUE, "glFenceSync(flags=0x%x)",
270 syncObj = ctx->Driver.NewSyncObject(ctx, GL_SYNC_FENCE);
271 if (syncObj != NULL) {
272 syncObj->Type = GL_SYNC_FENCE;
273 /* The name is not currently used, and it is never visible to
274 * applications. If sync support is extended to provide support for
275 * NV_fence, this field will be used. We'll also need to add an object
279 syncObj->RefCount = 1;
280 syncObj->DeletePending = GL_FALSE;
281 syncObj->SyncCondition = condition;
282 syncObj->Flags = flags;
283 syncObj->StatusFlag = 0;
285 ctx->Driver.FenceSync(ctx, syncObj, condition, flags);
287 _glthread_LOCK_MUTEX(ctx->Shared->Mutex);
288 insert_at_tail(& ctx->Shared->SyncObjects, & syncObj->link);
289 _glthread_UNLOCK_MUTEX(ctx->Shared->Mutex);
291 return (GLsync) syncObj;
299 _mesa_ClientWaitSync(GLsync sync, GLbitfield flags, GLuint64 timeout)
301 GET_CURRENT_CONTEXT(ctx);
302 struct gl_sync_object *const syncObj = (struct gl_sync_object *) sync;
304 ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, GL_WAIT_FAILED);
306 if (!_mesa_validate_sync(syncObj)) {
307 _mesa_error(ctx, GL_INVALID_OPERATION, "glClientWaitSync");
308 return GL_WAIT_FAILED;
311 if ((flags & ~GL_SYNC_FLUSH_COMMANDS_BIT) != 0) {
312 _mesa_error(ctx, GL_INVALID_ENUM, "glClientWaitSync(flags=0x%x)", flags);
313 return GL_WAIT_FAILED;
316 _mesa_ref_sync_object(ctx, syncObj);
318 /* From the GL_ARB_sync spec:
320 * ClientWaitSync returns one of four status values. A return value of
321 * ALREADY_SIGNALED indicates that <sync> was signaled at the time
322 * ClientWaitSync was called. ALREADY_SIGNALED will always be returned
323 * if <sync> was signaled, even if the value of <timeout> is zero.
325 ctx->Driver.CheckSync(ctx, syncObj);
326 if (syncObj->StatusFlag) {
327 ret = GL_ALREADY_SIGNALED;
329 ctx->Driver.ClientWaitSync(ctx, syncObj, flags, timeout);
331 ret = syncObj->StatusFlag ? GL_CONDITION_SATISFIED : GL_TIMEOUT_EXPIRED;
334 _mesa_unref_sync_object(ctx, syncObj);
340 _mesa_WaitSync(GLsync sync, GLbitfield flags, GLuint64 timeout)
342 GET_CURRENT_CONTEXT(ctx);
343 struct gl_sync_object *const syncObj = (struct gl_sync_object *) sync;
344 ASSERT_OUTSIDE_BEGIN_END(ctx);
346 if (!_mesa_validate_sync(syncObj)) {
347 _mesa_error(ctx, GL_INVALID_OPERATION, "glWaitSync");
352 _mesa_error(ctx, GL_INVALID_ENUM, "glWaitSync(flags=0x%x)", flags);
356 /* From the GL_ARB_sync spec:
358 * If the value of <timeout> is zero, then WaitSync does nothing.
364 ctx->Driver.ServerWaitSync(ctx, syncObj, flags, timeout);
369 _mesa_GetSynciv(GLsync sync, GLenum pname, GLsizei bufSize, GLsizei *length,
372 GET_CURRENT_CONTEXT(ctx);
373 struct gl_sync_object *const syncObj = (struct gl_sync_object *) sync;
376 ASSERT_OUTSIDE_BEGIN_END(ctx);
378 if (!_mesa_validate_sync(syncObj)) {
379 _mesa_error(ctx, GL_INVALID_OPERATION, "glGetSynciv");
385 v[0] = syncObj->Type;
389 case GL_SYNC_CONDITION:
390 v[0] = syncObj->SyncCondition;
395 /* Update the state of the sync by dipping into the driver. Note that
396 * this call won't block. It just updates state in the common object
397 * data from the current driver state.
399 ctx->Driver.CheckSync(ctx, syncObj);
401 v[0] = (syncObj->StatusFlag) ? GL_SIGNALED : GL_UNSIGNALED;
406 v[0] = syncObj->Flags;
411 _mesa_error(ctx, GL_INVALID_ENUM, "glGetSynciv(pname=0x%x)\n", pname);
416 const GLsizei copy_count = MIN2(size, bufSize);
418 memcpy(values, v, sizeof(GLint) * copy_count);
421 if (length != NULL) {
426 #endif /* FEATURE_ARB_sync */