mesa: Implement glPushDebugGroup and glPopDebugGroup
[mesa.git] / src / mesa / main / syncobj.c
index eeeeb49175f1e321cbaa2da0d4e51799f07ee7f8..c8d25cdf13b19ca22f7e88ede397036ab73f2b14 100644 (file)
  * \file syncobj.c
  * Sync object management.
  *
+ * Unlike textures and other objects that are shared between contexts, sync
+ * objects are not bound to the context.  As a result, the reference counting
+ * and delete behavior of sync objects is slightly different.  References to
+ * sync objects are added:
+ *
+ *    - By \c glFencSynce.  This sets the initial reference count to 1.
+ *    - At the start of \c glClientWaitSync.  The reference is held for the
+ *      duration of the wait call.
+ *
+ * References are removed:
+ *
+ *    - By \c glDeleteSync.
+ *    - At the end of \c glClientWaitSync.
+ *
+ * Additionally, drivers may call \c _mesa_ref_sync_object and
+ * \c _mesa_unref_sync_object as needed to implement \c ServerWaitSync.
+ *
+ * As with shader objects, sync object names become invalid as soon as
+ * \c glDeleteSync is called.  For this reason \c glDeleteSync sets the
+ * \c DeletePending flag.  All functions validate object handles by testing
+ * this flag.
+ *
+ * \note
+ * Only \c GL_ARB_sync objects are shared between contexts.  If support is ever
+ * added for either \c GL_NV_fence or \c GL_APPLE_fence different semantics
+ * will need to be implemented.
+ *
  * \author Ian Romanick <ian.d.romanick@intel.com>
  */
 
+#include <inttypes.h>
 #include "glheader.h"
-#include "hash.h"
 #include "imports.h"
 #include "context.h"
+#include "macros.h"
+#include "get.h"
+#include "dispatch.h"
+#include "mtypes.h"
+#include "set.h"
+#include "hash_table.h"
 
-#if FEATURE_ARB_sync
 #include "syncobj.h"
 
 static struct gl_sync_object *
-_mesa_new_sync_object(GLcontext *ctx, GLenum type)
+_mesa_new_sync_object(struct gl_context *ctx, GLenum type)
 {
    struct gl_sync_object *s = MALLOC_STRUCT(gl_sync_object);
    (void) ctx;
@@ -48,27 +80,27 @@ _mesa_new_sync_object(GLcontext *ctx, GLenum type)
 
 
 static void
-_mesa_delete_sync_object(GLcontext *ctx, struct gl_sync_object *syncObj)
+_mesa_delete_sync_object(struct gl_context *ctx, struct gl_sync_object *syncObj)
 {
    (void) ctx;
-   _mesa_free(syncObj);
+   free(syncObj);
 }
 
 
 static void
-_mesa_fence_sync(GLcontext *ctx, struct gl_sync_object *syncObj,
+_mesa_fence_sync(struct gl_context *ctx, struct gl_sync_object *syncObj,
                 GLenum condition, GLbitfield flags)
 {
    (void) ctx;
    (void) condition;
    (void) flags;
 
-   syncObj->Status = 1;
+   syncObj->StatusFlag = 1;
 }
 
 
 static void
-_mesa_check_sync(GLcontext *ctx, struct gl_sync_object *syncObj)
+_mesa_check_sync(struct gl_context *ctx, struct gl_sync_object *syncObj)
 {
    (void) ctx;
    (void) syncObj;
@@ -80,7 +112,7 @@ _mesa_check_sync(GLcontext *ctx, struct gl_sync_object *syncObj)
 
 
 static void
-_mesa_wait_sync(GLcontext *ctx, struct gl_sync_object *syncObj,
+_mesa_wait_sync(struct gl_context *ctx, struct gl_sync_object *syncObj,
                GLbitfield flags, GLuint64 timeout)
 {
    (void) ctx;
@@ -88,7 +120,6 @@ _mesa_wait_sync(GLcontext *ctx, struct gl_sync_object *syncObj,
    (void) flags;
    (void) timeout;
 
-
    /* No-op for software rendering.  Hardware drivers will need to wait until
     * the state of the sync object changes or the timeout expires.
     */
@@ -109,12 +140,11 @@ _mesa_init_sync_object_functions(struct dd_function_table *driver)
    driver->ServerWaitSync = _mesa_wait_sync;
 }
 
-
 /**
  * Allocate/init the context state related to sync objects.
  */
 void
-_mesa_init_sync(GLcontext *ctx)
+_mesa_init_sync(struct gl_context *ctx)
 {
    (void) ctx;
 }
@@ -124,45 +154,72 @@ _mesa_init_sync(GLcontext *ctx)
  * Free the context state related to sync objects.
  */
 void
-_mesa_free_sync_data(GLcontext *ctx)
+_mesa_free_sync_data(struct gl_context *ctx)
 {
    (void) ctx;
 }
 
 
-GLboolean
-_mesa_IsSync(GLsync sync)
+static int
+_mesa_validate_sync(struct gl_context *ctx, struct gl_sync_object *syncObj)
 {
-   GET_CURRENT_CONTEXT(ctx);
-   struct gl_sync_object *const syncObj = (struct gl_sync_object *) sync;
-   ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, GL_FALSE);
+   return (syncObj != NULL)
+      && _mesa_set_search(ctx->Shared->SyncObjects,
+                          _mesa_hash_pointer(syncObj),
+                          syncObj) != NULL
+      && (syncObj->Type == GL_SYNC_FENCE)
+      && !syncObj->DeletePending;
+}
 
 
-   return ((syncObj != NULL) && (syncObj->Type == GL_SYNC_FENCE))
-      ? GL_TRUE : GL_FALSE;
+void
+_mesa_ref_sync_object(struct gl_context *ctx, struct gl_sync_object *syncObj)
+{
+   _glthread_LOCK_MUTEX(ctx->Shared->Mutex);
+   syncObj->RefCount++;
+   _glthread_UNLOCK_MUTEX(ctx->Shared->Mutex);
 }
 
 
-static void
-_mesa_unref_sync_object(GLcontext *ctx, struct gl_sync_object *syncObj)
+void
+_mesa_unref_sync_object(struct gl_context *ctx, struct gl_sync_object *syncObj)
 {
+   struct set_entry *entry;
+
+   _glthread_LOCK_MUTEX(ctx->Shared->Mutex);
    syncObj->RefCount--;
    if (syncObj->RefCount == 0) {
-      (*ctx->Driver.DeleteSyncObject)(ctx, syncObj);
+      entry = _mesa_set_search(ctx->Shared->SyncObjects,
+                               _mesa_hash_pointer(syncObj),
+                               syncObj);
+      assert (entry != NULL);
+      _mesa_set_remove(ctx->Shared->SyncObjects, entry);
+      _glthread_UNLOCK_MUTEX(ctx->Shared->Mutex);
+
+      ctx->Driver.DeleteSyncObject(ctx, syncObj);
    } else {
-      syncObj->DeletePending = 1;
+      _glthread_UNLOCK_MUTEX(ctx->Shared->Mutex);
    }
 }
 
 
-void
-_mesa_DeleteSync(GLsync sync)
+GLboolean GLAPIENTRY
+_mesa_IsSync(GLsync sync)
 {
    GET_CURRENT_CONTEXT(ctx);
    struct gl_sync_object *const syncObj = (struct gl_sync_object *) sync;
-   ASSERT_OUTSIDE_BEGIN_END(ctx);
+   ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, GL_FALSE);
+
+   return _mesa_validate_sync(ctx, syncObj) ? GL_TRUE : GL_FALSE;
+}
 
 
+void GLAPIENTRY
+_mesa_DeleteSync(GLsync sync)
+{
+   GET_CURRENT_CONTEXT(ctx);
+   struct gl_sync_object *const syncObj = (struct gl_sync_object *) sync;
+
    /* From the GL_ARB_sync spec:
     *
     *    DeleteSync will silently ignore a <sync> value of zero. An
@@ -173,28 +230,26 @@ _mesa_DeleteSync(GLsync sync)
       return;
    }
 
-   if (syncObj->Type != GL_SYNC_FENCE) {
-      _mesa_error(ctx, GL_INVALID_OPERATION, "glDeleteSync");
+   if (!_mesa_validate_sync(ctx, syncObj)) {
+      _mesa_error(ctx, GL_INVALID_VALUE, "glDeleteSync (not a valid sync object)");
       return;
    }
 
-
    /* If there are no client-waits or server-waits pending on this sync, delete
     * the underlying object.
     */
+   syncObj->DeletePending = GL_TRUE;
    _mesa_unref_sync_object(ctx, syncObj);
 }
 
 
-
-GLsync
+GLsync GLAPIENTRY
 _mesa_FenceSync(GLenum condition, GLbitfield flags)
 {
    GET_CURRENT_CONTEXT(ctx);
    struct gl_sync_object *syncObj;
    ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, 0);
 
-
    if (condition != GL_SYNC_GPU_COMMANDS_COMPLETE) {
       _mesa_error(ctx, GL_INVALID_ENUM, "glFenceSync(condition=0x%x)",
                  condition);
@@ -207,7 +262,7 @@ _mesa_FenceSync(GLenum condition, GLbitfield flags)
       return 0;
    }
 
-   syncObj = (*ctx->Driver.NewSyncObject)(ctx, GL_SYNC_FENCE);
+   syncObj = ctx->Driver.NewSyncObject(ctx, GL_SYNC_FENCE);
    if (syncObj != NULL) {
       syncObj->Type = GL_SYNC_FENCE;
       /* The name is not currently used, and it is never visible to
@@ -220,9 +275,15 @@ _mesa_FenceSync(GLenum condition, GLbitfield flags)
       syncObj->DeletePending = GL_FALSE;
       syncObj->SyncCondition = condition;
       syncObj->Flags = flags;
-      syncObj->Status = 0;
+      syncObj->StatusFlag = 0;
+
+      ctx->Driver.FenceSync(ctx, syncObj, condition, flags);
 
-      (*ctx->Driver.FenceSync)(ctx, syncObj, condition, flags);
+      _glthread_LOCK_MUTEX(ctx->Shared->Mutex);
+      _mesa_set_add(ctx->Shared->SyncObjects,
+                    _mesa_hash_pointer(syncObj),
+                    syncObj);
+      _glthread_UNLOCK_MUTEX(ctx->Shared->Mutex);
 
       return (GLsync) syncObj;
    }
@@ -231,7 +292,7 @@ _mesa_FenceSync(GLenum condition, GLbitfield flags)
 }
 
 
-GLenum
+GLenum GLAPIENTRY
 _mesa_ClientWaitSync(GLsync sync, GLbitfield flags, GLuint64 timeout)
 {
    GET_CURRENT_CONTEXT(ctx);
@@ -239,17 +300,17 @@ _mesa_ClientWaitSync(GLsync sync, GLbitfield flags, GLuint64 timeout)
    GLenum ret;
    ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, GL_WAIT_FAILED);
 
-
-   if ((syncObj == NULL) || (syncObj->Type != GL_SYNC_FENCE)) {
-      _mesa_error(ctx, GL_INVALID_OPERATION, "glClientWaitSync");
+   if (!_mesa_validate_sync(ctx, syncObj)) {
+      _mesa_error(ctx, GL_INVALID_VALUE, "glClientWaitSync (not a valid sync object)");
       return GL_WAIT_FAILED;
    }
 
    if ((flags & ~GL_SYNC_FLUSH_COMMANDS_BIT) != 0) {
-      _mesa_error(ctx, GL_INVALID_ENUM, "glClientWaitSync(flags=0x%x)", flags);
+      _mesa_error(ctx, GL_INVALID_VALUE, "glClientWaitSync(flags=0x%x)", flags);
       return GL_WAIT_FAILED;
    }
 
+   _mesa_ref_sync_object(ctx, syncObj);
 
    /* From the GL_ARB_sync spec:
     *
@@ -258,56 +319,51 @@ _mesa_ClientWaitSync(GLsync sync, GLbitfield flags, GLuint64 timeout)
     *    ClientWaitSync was called. ALREADY_SIGNALED will always be returned
     *    if <sync> was signaled, even if the value of <timeout> is zero.
     */
-   (*ctx->Driver.CheckSync)(ctx, syncObj);
-
-   if (syncObj->Status) {
-      return GL_ALREADY_SIGNALED;
-   }
-
-
-   (*ctx->Driver.ClientWaitSync)(ctx, syncObj, flags, timeout);
-
-   ret = syncObj->Status ? GL_CONDITION_SATISFIED : GL_TIMEOUT_EXPIRED;
+   ctx->Driver.CheckSync(ctx, syncObj);
+   if (syncObj->StatusFlag) {
+      ret = GL_ALREADY_SIGNALED;
+   } else {
+      if (timeout == 0) {
+         ret = GL_TIMEOUT_EXPIRED;
+      } else {
+         ctx->Driver.ClientWaitSync(ctx, syncObj, flags, timeout);
 
-   if (syncObj->DeletePending && syncObj->Status) {
-      _mesa_unref_sync_object(ctx, syncObj);
+         ret = syncObj->StatusFlag ? GL_CONDITION_SATISFIED : GL_TIMEOUT_EXPIRED;
+      }
    }
 
+   _mesa_unref_sync_object(ctx, syncObj);
    return ret;
 }
 
 
-void
+void GLAPIENTRY
 _mesa_WaitSync(GLsync sync, GLbitfield flags, GLuint64 timeout)
 {
    GET_CURRENT_CONTEXT(ctx);
    struct gl_sync_object *const syncObj = (struct gl_sync_object *) sync;
-   ASSERT_OUTSIDE_BEGIN_END(ctx);
-
 
-   if ((syncObj == NULL) || (syncObj->Type != GL_SYNC_FENCE)) {
-      _mesa_error(ctx, GL_INVALID_OPERATION, "glWaitSync");
+   if (!_mesa_validate_sync(ctx, syncObj)) {
+      _mesa_error(ctx, GL_INVALID_VALUE, "glWaitSync (not a valid sync object)");
       return;
    }
 
    if (flags != 0) {
-      _mesa_error(ctx, GL_INVALID_ENUM, "glWaitSync(flags=0x%x)", flags);
+      _mesa_error(ctx, GL_INVALID_VALUE, "glWaitSync(flags=0x%x)", flags);
       return;
    }
 
-   /* From the GL_ARB_sync spec:
-    *
-    *     If the value of <timeout> is zero, then WaitSync does nothing.
-    */
-   if (timeout == 0) {
+   if (timeout != GL_TIMEOUT_IGNORED) {
+      _mesa_error(ctx, GL_INVALID_VALUE, "glWaitSync(timeout=0x%" PRIx64 ")",
+                  (uint64_t) timeout);
       return;
    }
 
-   (*ctx->Driver.ServerWaitSync)(ctx, syncObj, flags, timeout);
+   ctx->Driver.ServerWaitSync(ctx, syncObj, flags, timeout);
 }
 
 
-void
+void GLAPIENTRY
 _mesa_GetSynciv(GLsync sync, GLenum pname, GLsizei bufSize, GLsizei *length,
                GLint *values)
 {
@@ -315,15 +371,12 @@ _mesa_GetSynciv(GLsync sync, GLenum pname, GLsizei bufSize, GLsizei *length,
    struct gl_sync_object *const syncObj = (struct gl_sync_object *) sync;
    GLsizei size = 0;
    GLint v[1];
-   ASSERT_OUTSIDE_BEGIN_END(ctx);
-
 
-   if ((syncObj == NULL) || (syncObj->Type != GL_SYNC_FENCE)) {
-      _mesa_error(ctx, GL_INVALID_OPERATION, "glGetSynciv");
+   if (!_mesa_validate_sync(ctx, syncObj)) {
+      _mesa_error(ctx, GL_INVALID_VALUE, "glGetSynciv (not a valid sync object)");
       return;
    }
 
-
    switch (pname) {
    case GL_OBJECT_TYPE:
       v[0] = syncObj->Type;
@@ -340,9 +393,9 @@ _mesa_GetSynciv(GLsync sync, GLenum pname, GLsizei bufSize, GLsizei *length,
        * this call won't block.  It just updates state in the common object
        * data from the current driver state.
        */
-      (*ctx->Driver.CheckSync)(ctx, syncObj);
+      ctx->Driver.CheckSync(ctx, syncObj);
 
-      v[0] = (syncObj->Status) ? GL_SIGNALED : GL_UNSIGNALED;
+      v[0] = (syncObj->StatusFlag) ? GL_SIGNALED : GL_UNSIGNALED;
       size = 1;
       break;
 
@@ -356,17 +409,13 @@ _mesa_GetSynciv(GLsync sync, GLenum pname, GLsizei bufSize, GLsizei *length,
       return;
    }
 
-
    if (size > 0) {
-      const GLsizei copy_count = (size > bufSize) ? bufSize : size;
+      const GLsizei copy_count = MIN2(size, bufSize);
 
-      _mesa_memcpy(values, v, sizeof(GLint) * copy_count);
+      memcpy(values, v, sizeof(GLint) * copy_count);
    }
 
-
    if (length != NULL) {
       *length = size;
    }
 }
-
-#endif /* FEATURE_ARB_sync */