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>
66 static struct gl_sync_object
*
67 _mesa_new_sync_object(GLcontext
*ctx
, GLenum type
)
69 struct gl_sync_object
*s
= MALLOC_STRUCT(gl_sync_object
);
78 _mesa_delete_sync_object(GLcontext
*ctx
, struct gl_sync_object
*syncObj
)
86 _mesa_fence_sync(GLcontext
*ctx
, struct gl_sync_object
*syncObj
,
87 GLenum condition
, GLbitfield flags
)
93 syncObj
->StatusFlag
= 1;
98 _mesa_check_sync(GLcontext
*ctx
, struct gl_sync_object
*syncObj
)
103 /* No-op for software rendering. Hardware drivers will need to determine
104 * whether the state of the sync object has changed.
110 _mesa_wait_sync(GLcontext
*ctx
, struct gl_sync_object
*syncObj
,
111 GLbitfield flags
, GLuint64 timeout
)
118 /* No-op for software rendering. Hardware drivers will need to wait until
119 * the state of the sync object changes or the timeout expires.
125 _mesa_init_sync_object_functions(struct dd_function_table
*driver
)
127 driver
->NewSyncObject
= _mesa_new_sync_object
;
128 driver
->FenceSync
= _mesa_fence_sync
;
129 driver
->DeleteSyncObject
= _mesa_delete_sync_object
;
130 driver
->CheckSync
= _mesa_check_sync
;
132 /* Use the same no-op wait function for both.
134 driver
->ClientWaitSync
= _mesa_wait_sync
;
135 driver
->ServerWaitSync
= _mesa_wait_sync
;
140 * Allocate/init the context state related to sync objects.
143 _mesa_init_sync(GLcontext
*ctx
)
150 * Free the context state related to sync objects.
153 _mesa_free_sync_data(GLcontext
*ctx
)
160 _mesa_validate_sync(struct gl_sync_object
*syncObj
)
162 return (syncObj
!= NULL
)
163 && (syncObj
->Type
== GL_SYNC_FENCE
)
164 && !syncObj
->DeletePending
;
169 _mesa_ref_sync_object(GLcontext
*ctx
, struct gl_sync_object
*syncObj
)
171 _glthread_LOCK_MUTEX(ctx
->Shared
->Mutex
);
173 _glthread_UNLOCK_MUTEX(ctx
->Shared
->Mutex
);
178 _mesa_unref_sync_object(GLcontext
*ctx
, struct gl_sync_object
*syncObj
)
180 _glthread_LOCK_MUTEX(ctx
->Shared
->Mutex
);
182 if (syncObj
->RefCount
== 0) {
183 remove_from_list(& syncObj
->link
);
184 _glthread_UNLOCK_MUTEX(ctx
->Shared
->Mutex
);
186 ctx
->Driver
.DeleteSyncObject(ctx
, syncObj
);
188 _glthread_UNLOCK_MUTEX(ctx
->Shared
->Mutex
);
194 _mesa_IsSync(GLsync sync
)
196 GET_CURRENT_CONTEXT(ctx
);
197 struct gl_sync_object
*const syncObj
= (struct gl_sync_object
*) sync
;
198 ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx
, GL_FALSE
);
200 return _mesa_validate_sync(syncObj
) ? GL_TRUE
: GL_FALSE
;
205 _mesa_DeleteSync(GLsync sync
)
207 GET_CURRENT_CONTEXT(ctx
);
208 struct gl_sync_object
*const syncObj
= (struct gl_sync_object
*) sync
;
209 ASSERT_OUTSIDE_BEGIN_END(ctx
);
211 /* From the GL_ARB_sync spec:
213 * DeleteSync will silently ignore a <sync> value of zero. An
214 * INVALID_VALUE error is generated if <sync> is neither zero nor the
215 * name of a sync object.
221 if (!_mesa_validate_sync(syncObj
)) {
222 _mesa_error(ctx
, GL_INVALID_OPERATION
, "glDeleteSync");
226 /* If there are no client-waits or server-waits pending on this sync, delete
227 * the underlying object.
229 syncObj
->DeletePending
= GL_TRUE
;
230 _mesa_unref_sync_object(ctx
, syncObj
);
235 _mesa_FenceSync(GLenum condition
, GLbitfield flags
)
237 GET_CURRENT_CONTEXT(ctx
);
238 struct gl_sync_object
*syncObj
;
239 ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx
, 0);
241 if (condition
!= GL_SYNC_GPU_COMMANDS_COMPLETE
) {
242 _mesa_error(ctx
, GL_INVALID_ENUM
, "glFenceSync(condition=0x%x)",
248 _mesa_error(ctx
, GL_INVALID_VALUE
, "glFenceSync(flags=0x%x)",
253 syncObj
= ctx
->Driver
.NewSyncObject(ctx
, GL_SYNC_FENCE
);
254 if (syncObj
!= NULL
) {
255 syncObj
->Type
= GL_SYNC_FENCE
;
256 /* The name is not currently used, and it is never visible to
257 * applications. If sync support is extended to provide support for
258 * NV_fence, this field will be used. We'll also need to add an object
262 syncObj
->RefCount
= 1;
263 syncObj
->DeletePending
= GL_FALSE
;
264 syncObj
->SyncCondition
= condition
;
265 syncObj
->Flags
= flags
;
266 syncObj
->StatusFlag
= 0;
268 ctx
->Driver
.FenceSync(ctx
, syncObj
, condition
, flags
);
270 _glthread_LOCK_MUTEX(ctx
->Shared
->Mutex
);
271 insert_at_tail(& ctx
->Shared
->SyncObjects
, & syncObj
->link
);
272 _glthread_UNLOCK_MUTEX(ctx
->Shared
->Mutex
);
274 return (GLsync
) syncObj
;
282 _mesa_ClientWaitSync(GLsync sync
, GLbitfield flags
, GLuint64 timeout
)
284 GET_CURRENT_CONTEXT(ctx
);
285 struct gl_sync_object
*const syncObj
= (struct gl_sync_object
*) sync
;
287 ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx
, GL_WAIT_FAILED
);
289 if (!_mesa_validate_sync(syncObj
)) {
290 _mesa_error(ctx
, GL_INVALID_OPERATION
, "glClientWaitSync");
291 return GL_WAIT_FAILED
;
294 if ((flags
& ~GL_SYNC_FLUSH_COMMANDS_BIT
) != 0) {
295 _mesa_error(ctx
, GL_INVALID_ENUM
, "glClientWaitSync(flags=0x%x)", flags
);
296 return GL_WAIT_FAILED
;
299 _mesa_ref_sync_object(ctx
, syncObj
);
301 /* From the GL_ARB_sync spec:
303 * ClientWaitSync returns one of four status values. A return value of
304 * ALREADY_SIGNALED indicates that <sync> was signaled at the time
305 * ClientWaitSync was called. ALREADY_SIGNALED will always be returned
306 * if <sync> was signaled, even if the value of <timeout> is zero.
308 ctx
->Driver
.CheckSync(ctx
, syncObj
);
309 if (syncObj
->StatusFlag
) {
310 ret
= GL_ALREADY_SIGNALED
;
312 ctx
->Driver
.ClientWaitSync(ctx
, syncObj
, flags
, timeout
);
314 ret
= syncObj
->StatusFlag
? GL_CONDITION_SATISFIED
: GL_TIMEOUT_EXPIRED
;
317 _mesa_unref_sync_object(ctx
, syncObj
);
323 _mesa_WaitSync(GLsync sync
, GLbitfield flags
, GLuint64 timeout
)
325 GET_CURRENT_CONTEXT(ctx
);
326 struct gl_sync_object
*const syncObj
= (struct gl_sync_object
*) sync
;
327 ASSERT_OUTSIDE_BEGIN_END(ctx
);
329 if (!_mesa_validate_sync(syncObj
)) {
330 _mesa_error(ctx
, GL_INVALID_OPERATION
, "glWaitSync");
335 _mesa_error(ctx
, GL_INVALID_ENUM
, "glWaitSync(flags=0x%x)", flags
);
339 /* From the GL_ARB_sync spec:
341 * If the value of <timeout> is zero, then WaitSync does nothing.
347 ctx
->Driver
.ServerWaitSync(ctx
, syncObj
, flags
, timeout
);
352 _mesa_GetSynciv(GLsync sync
, GLenum pname
, GLsizei bufSize
, GLsizei
*length
,
355 GET_CURRENT_CONTEXT(ctx
);
356 struct gl_sync_object
*const syncObj
= (struct gl_sync_object
*) sync
;
359 ASSERT_OUTSIDE_BEGIN_END(ctx
);
361 if (!_mesa_validate_sync(syncObj
)) {
362 _mesa_error(ctx
, GL_INVALID_OPERATION
, "glGetSynciv");
368 v
[0] = syncObj
->Type
;
372 case GL_SYNC_CONDITION
:
373 v
[0] = syncObj
->SyncCondition
;
378 /* Update the state of the sync by dipping into the driver. Note that
379 * this call won't block. It just updates state in the common object
380 * data from the current driver state.
382 ctx
->Driver
.CheckSync(ctx
, syncObj
);
384 v
[0] = (syncObj
->StatusFlag
) ? GL_SIGNALED
: GL_UNSIGNALED
;
389 v
[0] = syncObj
->Flags
;
394 _mesa_error(ctx
, GL_INVALID_ENUM
, "glGetSynciv(pname=0x%x)\n", pname
);
399 const GLsizei copy_count
= MIN2(size
, bufSize
);
401 _mesa_memcpy(values
, v
, sizeof(GLint
) * copy_count
);
404 if (length
!= NULL
) {
409 #endif /* FEATURE_ARB_sync */