src/mesa/main/syncobj.c

   1 /*
   2  * Copyright © 2009 Intel Corporation
   3  *
   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:
  10  *
  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
  13  * Software.
  14  *
  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.
  22  */
  23
  24 /**
  25  * \file syncobj.c
  26  * Sync object management.
  27  *
  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:
  32  *
  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.
  36  *
  37  * References are removed:
  38  *
  39  *    - By \c glDeleteSync.
  40  *    - At the end of \c glClientWaitSync.
  41  *
  42  * Additionally, drivers may call \c _mesa_ref_sync_object and
  43  * \c _mesa_unref_sync_object as needed to implement \c ServerWaitSync.
  44  *
  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
  48  * this flag.
  49  *
  50  * \note
  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.
  54  *
  55  * \author Ian Romanick <ian.d.romanick@intel.com>
  56  */
  57
  58 #include <inttypes.h>
  59 #include "glheader.h"
  60 #include "imports.h"
  61 #include "context.h"
  62 #include "macros.h"
  63 #include "mfeatures.h"
  64 #include "get.h"
  65 #include "dispatch.h"
  66 #include "mtypes.h"
  67 #include "set.h"
  68 #include "hash_table.h"
  69
  70 #include "syncobj.h"
  71
  72 static struct gl_sync_object *
  73 _mesa_new_sync_object(struct gl_context *ctx, GLenum type)
  74 {
  75    struct gl_sync_object *s = MALLOC_STRUCT(gl_sync_object);
  76    (void) ctx;
  77    (void) type;
  78
  79    return s;
  80 }
  81
  82
  83 static void
  84 _mesa_delete_sync_object(struct gl_context *ctx, struct gl_sync_object *syncObj)
  85 {
  86    (void) ctx;
  87    free(syncObj);
  88 }
  89
  90
  91 static void
  92 _mesa_fence_sync(struct gl_context *ctx, struct gl_sync_object *syncObj,
  93                  GLenum condition, GLbitfield flags)
  94 {
  95    (void) ctx;
  96    (void) condition;
  97    (void) flags;
  98
  99    syncObj->StatusFlag = 1;
 100 }
 101
 102
 103 static void
 104 _mesa_check_sync(struct gl_context *ctx, struct gl_sync_object *syncObj)
 105 {
 106    (void) ctx;
 107    (void) syncObj;
 108
 109    /* No-op for software rendering.  Hardware drivers will need to determine
 110     * whether the state of the sync object has changed.
 111     */
 112 }
 113
 114
 115 static void
 116 _mesa_wait_sync(struct gl_context *ctx, struct gl_sync_object *syncObj,
 117                 GLbitfield flags, GLuint64 timeout)
 118 {
 119    (void) ctx;
 120    (void) syncObj;
 121    (void) flags;
 122    (void) timeout;
 123
 124    /* No-op for software rendering.  Hardware drivers will need to wait until
 125     * the state of the sync object changes or the timeout expires.
 126     */
 127 }
 128
 129
 130 void
 131 _mesa_init_sync_object_functions(struct dd_function_table *driver)
 132 {
 133    driver->NewSyncObject = _mesa_new_sync_object;
 134    driver->FenceSync = _mesa_fence_sync;
 135    driver->DeleteSyncObject = _mesa_delete_sync_object;
 136    driver->CheckSync = _mesa_check_sync;
 137
 138    /* Use the same no-op wait function for both.
 139     */
 140    driver->ClientWaitSync = _mesa_wait_sync;
 141    driver->ServerWaitSync = _mesa_wait_sync;
 142 }
 143
 144 /**
 145  * Allocate/init the context state related to sync objects.
 146  */
 147 void
 148 _mesa_init_sync(struct gl_context *ctx)
 149 {
 150    (void) ctx;
 151 }
 152
 153
 154 /**
 155  * Free the context state related to sync objects.
 156  */
 157 void
 158 _mesa_free_sync_data(struct gl_context *ctx)
 159 {
 160    (void) ctx;
 161 }
 162
 163
 164 static int
 165 _mesa_validate_sync(struct gl_context *ctx, struct gl_sync_object *syncObj)
 166 {
 167    return (syncObj != NULL)
 168       && _mesa_set_search(ctx->Shared->SyncObjects,
 169                           _mesa_hash_pointer(syncObj),
 170                           syncObj) != NULL
 171       && (syncObj->Type == GL_SYNC_FENCE)
 172       && !syncObj->DeletePending;
 173 }
 174
 175
 176 void
 177 _mesa_ref_sync_object(struct gl_context *ctx, struct gl_sync_object *syncObj)
 178 {
 179    _glthread_LOCK_MUTEX(ctx->Shared->Mutex);
 180    syncObj->RefCount++;
 181    _glthread_UNLOCK_MUTEX(ctx->Shared->Mutex);
 182 }
 183
 184
 185 void
 186 _mesa_unref_sync_object(struct gl_context *ctx, struct gl_sync_object *syncObj)
 187 {
 188    struct set_entry *entry;
 189
 190    _glthread_LOCK_MUTEX(ctx->Shared->Mutex);
 191    syncObj->RefCount--;
 192    if (syncObj->RefCount == 0) {
 193       entry = _mesa_set_search(ctx->Shared->SyncObjects,
 194                                _mesa_hash_pointer(syncObj),
 195                                syncObj);
 196       assert (entry != NULL);
 197       _mesa_set_remove(ctx->Shared->SyncObjects, entry);
 198       _glthread_UNLOCK_MUTEX(ctx->Shared->Mutex);
 199
 200       ctx->Driver.DeleteSyncObject(ctx, syncObj);
 201    } else {
 202       _glthread_UNLOCK_MUTEX(ctx->Shared->Mutex);
 203    }
 204 }
 205
 206
 207 GLboolean GLAPIENTRY
 208 _mesa_IsSync(GLsync sync)
 209 {
 210    GET_CURRENT_CONTEXT(ctx);
 211    struct gl_sync_object *const syncObj = (struct gl_sync_object *) sync;
 212    ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, GL_FALSE);
 213
 214    return _mesa_validate_sync(ctx, syncObj) ? GL_TRUE : GL_FALSE;
 215 }
 216
 217
 218 void GLAPIENTRY
 219 _mesa_DeleteSync(GLsync sync)
 220 {
 221    GET_CURRENT_CONTEXT(ctx);
 222    struct gl_sync_object *const syncObj = (struct gl_sync_object *) sync;
 223
 224    /* From the GL_ARB_sync spec:
 225     *
 226     *    DeleteSync will silently ignore a <sync> value of zero. An
 227     *    INVALID_VALUE error is generated if <sync> is neither zero nor the
 228     *    name of a sync object.
 229     */
 230    if (sync == 0) {
 231       return;
 232    }
 233
 234    if (!_mesa_validate_sync(ctx, syncObj)) {
 235       _mesa_error(ctx, GL_INVALID_VALUE, "glDeleteSync (not a valid sync object)");
 236       return;
 237    }
 238
 239    /* If there are no client-waits or server-waits pending on this sync, delete
 240     * the underlying object.
 241     */
 242    syncObj->DeletePending = GL_TRUE;
 243    _mesa_unref_sync_object(ctx, syncObj);
 244 }
 245
 246
 247 GLsync GLAPIENTRY
 248 _mesa_FenceSync(GLenum condition, GLbitfield flags)
 249 {
 250    GET_CURRENT_CONTEXT(ctx);
 251    struct gl_sync_object *syncObj;
 252    ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, 0);
 253
 254    if (condition != GL_SYNC_GPU_COMMANDS_COMPLETE) {
 255       _mesa_error(ctx, GL_INVALID_ENUM, "glFenceSync(condition=0x%x)",
 256                   condition);
 257       return 0;
 258    }
 259
 260    if (flags != 0) {
 261       _mesa_error(ctx, GL_INVALID_VALUE, "glFenceSync(flags=0x%x)",
 262                   condition);
 263       return 0;
 264    }
 265
 266    syncObj = ctx->Driver.NewSyncObject(ctx, GL_SYNC_FENCE);
 267    if (syncObj != NULL) {
 268       syncObj->Type = GL_SYNC_FENCE;
 269       /* The name is not currently used, and it is never visible to
 270        * applications.  If sync support is extended to provide support for
 271        * NV_fence, this field will be used.  We'll also need to add an object
 272        * ID hashtable.
 273        */
 274       syncObj->Name = 1;
 275       syncObj->RefCount = 1;
 276       syncObj->DeletePending = GL_FALSE;
 277       syncObj->SyncCondition = condition;
 278       syncObj->Flags = flags;
 279       syncObj->StatusFlag = 0;
 280
 281       ctx->Driver.FenceSync(ctx, syncObj, condition, flags);
 282
 283       _glthread_LOCK_MUTEX(ctx->Shared->Mutex);
 284       _mesa_set_add(ctx->Shared->SyncObjects,
 285                     _mesa_hash_pointer(syncObj),
 286                     syncObj);
 287       _glthread_UNLOCK_MUTEX(ctx->Shared->Mutex);
 288
 289       return (GLsync) syncObj;
 290    }
 291
 292    return NULL;
 293 }
 294
 295
 296 GLenum GLAPIENTRY
 297 _mesa_ClientWaitSync(GLsync sync, GLbitfield flags, GLuint64 timeout)
 298 {
 299    GET_CURRENT_CONTEXT(ctx);
 300    struct gl_sync_object *const syncObj = (struct gl_sync_object *) sync;
 301    GLenum ret;
 302    ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, GL_WAIT_FAILED);
 303
 304    if (!_mesa_validate_sync(ctx, syncObj)) {
 305       _mesa_error(ctx, GL_INVALID_VALUE, "glClientWaitSync (not a valid sync object)");
 306       return GL_WAIT_FAILED;
 307    }
 308
 309    if ((flags & ~GL_SYNC_FLUSH_COMMANDS_BIT) != 0) {
 310       _mesa_error(ctx, GL_INVALID_VALUE, "glClientWaitSync(flags=0x%x)", flags);
 311       return GL_WAIT_FAILED;
 312    }
 313
 314    _mesa_ref_sync_object(ctx, syncObj);
 315
 316    /* From the GL_ARB_sync spec:
 317     *
 318     *    ClientWaitSync returns one of four status values. A return value of
 319     *    ALREADY_SIGNALED indicates that <sync> was signaled at the time
 320     *    ClientWaitSync was called. ALREADY_SIGNALED will always be returned
 321     *    if <sync> was signaled, even if the value of <timeout> is zero.
 322     */
 323    ctx->Driver.CheckSync(ctx, syncObj);
 324    if (syncObj->StatusFlag) {
 325       ret = GL_ALREADY_SIGNALED;
 326    } else {
 327       if (timeout == 0) {
 328          ret = GL_TIMEOUT_EXPIRED;
 329       } else {
 330          ctx->Driver.ClientWaitSync(ctx, syncObj, flags, timeout);
 331
 332          ret = syncObj->StatusFlag ? GL_CONDITION_SATISFIED : GL_TIMEOUT_EXPIRED;
 333       }
 334    }
 335
 336    _mesa_unref_sync_object(ctx, syncObj);
 337    return ret;
 338 }
 339
 340
 341 void GLAPIENTRY
 342 _mesa_WaitSync(GLsync sync, GLbitfield flags, GLuint64 timeout)
 343 {
 344    GET_CURRENT_CONTEXT(ctx);
 345    struct gl_sync_object *const syncObj = (struct gl_sync_object *) sync;
 346
 347    if (!_mesa_validate_sync(ctx, syncObj)) {
 348       _mesa_error(ctx, GL_INVALID_VALUE, "glWaitSync (not a valid sync object)");
 349       return;
 350    }
 351
 352    if (flags != 0) {
 353       _mesa_error(ctx, GL_INVALID_VALUE, "glWaitSync(flags=0x%x)", flags);
 354       return;
 355    }
 356
 357    if (timeout != GL_TIMEOUT_IGNORED) {
 358       _mesa_error(ctx, GL_INVALID_VALUE, "glWaitSync(timeout=0x%" PRIx64 ")",
 359                   (uint64_t) timeout);
 360       return;
 361    }
 362
 363    ctx->Driver.ServerWaitSync(ctx, syncObj, flags, timeout);
 364 }
 365
 366
 367 void GLAPIENTRY
 368 _mesa_GetSynciv(GLsync sync, GLenum pname, GLsizei bufSize, GLsizei *length,
 369                 GLint *values)
 370 {
 371    GET_CURRENT_CONTEXT(ctx);
 372    struct gl_sync_object *const syncObj = (struct gl_sync_object *) sync;
 373    GLsizei size = 0;
 374    GLint v[1];
 375
 376    if (!_mesa_validate_sync(ctx, syncObj)) {
 377       _mesa_error(ctx, GL_INVALID_VALUE, "glGetSynciv (not a valid sync object)");
 378       return;
 379    }
 380
 381    switch (pname) {
 382    case GL_OBJECT_TYPE:
 383       v[0] = syncObj->Type;
 384       size = 1;
 385       break;
 386
 387    case GL_SYNC_CONDITION:
 388       v[0] = syncObj->SyncCondition;
 389       size = 1;
 390       break;
 391
 392    case GL_SYNC_STATUS:
 393       /* Update the state of the sync by dipping into the driver.  Note that
 394        * this call won't block.  It just updates state in the common object
 395        * data from the current driver state.
 396        */
 397       ctx->Driver.CheckSync(ctx, syncObj);
 398
 399       v[0] = (syncObj->StatusFlag) ? GL_SIGNALED : GL_UNSIGNALED;
 400       size = 1;
 401       break;
 402
 403    case GL_SYNC_FLAGS:
 404       v[0] = syncObj->Flags;
 405       size = 1;
 406       break;
 407
 408    default:
 409       _mesa_error(ctx, GL_INVALID_ENUM, "glGetSynciv(pname=0x%x)\n", pname);
 410       return;
 411    }
 412
 413    if (size > 0) {
 414       const GLsizei copy_count = MIN2(size, bufSize);
 415
 416       memcpy(values, v, sizeof(GLint) * copy_count);
 417    }
 418
 419    if (length != NULL) {
 420       *length = size;
 421    }
 422 }