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 "get.h"
  64 #include "dispatch.h"
  65 #include "mtypes.h"
  66 #include "util/hash_table.h"
  67 #include "util/set.h"
  68
  69 #include "syncobj.h"
  70
  71 static struct gl_sync_object *
  72 _mesa_new_sync_object(struct gl_context *ctx)
  73 {
  74    struct gl_sync_object *s = CALLOC_STRUCT(gl_sync_object);
  75    (void) ctx;
  76
  77    return s;
  78 }
  79
  80
  81 static void
  82 _mesa_delete_sync_object(struct gl_context *ctx, struct gl_sync_object *syncObj)
  83 {
  84    (void) ctx;
  85    free(syncObj->Label);
  86    free(syncObj);
  87 }
  88
  89
  90 static void
  91 _mesa_fence_sync(struct gl_context *ctx, struct gl_sync_object *syncObj,
  92                  GLenum condition, GLbitfield flags)
  93 {
  94    (void) ctx;
  95    (void) condition;
  96    (void) flags;
  97
  98    syncObj->StatusFlag = 1;
  99 }
 100
 101
 102 static void
 103 _mesa_check_sync(struct gl_context *ctx, struct gl_sync_object *syncObj)
 104 {
 105    (void) ctx;
 106    (void) syncObj;
 107
 108    /* No-op for software rendering.  Hardware drivers will need to determine
 109     * whether the state of the sync object has changed.
 110     */
 111 }
 112
 113
 114 static void
 115 _mesa_wait_sync(struct gl_context *ctx, struct gl_sync_object *syncObj,
 116                 GLbitfield flags, GLuint64 timeout)
 117 {
 118    (void) ctx;
 119    (void) syncObj;
 120    (void) flags;
 121    (void) timeout;
 122
 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.
 125     */
 126 }
 127
 128
 129 void
 130 _mesa_init_sync_object_functions(struct dd_function_table *driver)
 131 {
 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;
 136
 137    /* Use the same no-op wait function for both.
 138     */
 139    driver->ClientWaitSync = _mesa_wait_sync;
 140    driver->ServerWaitSync = _mesa_wait_sync;
 141 }
 142
 143 /**
 144  * Allocate/init the context state related to sync objects.
 145  */
 146 void
 147 _mesa_init_sync(struct gl_context *ctx)
 148 {
 149    (void) ctx;
 150 }
 151
 152
 153 /**
 154  * Free the context state related to sync objects.
 155  */
 156 void
 157 _mesa_free_sync_data(struct gl_context *ctx)
 158 {
 159    (void) ctx;
 160 }
 161
 162
 163 /**
 164  * Check if the given sync object is:
 165  *  - non-null
 166  *  - not in sync objects hash table
 167  *  - not marked as deleted
 168  *
 169  * Returns the internal gl_sync_object pointer if the sync object is valid
 170  * or NULL if it isn't.
 171  *
 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.
 175  */
 176 struct gl_sync_object *
 177 _mesa_get_and_ref_sync(struct gl_context *ctx, GLsync sync, bool incRefCount)
 178 {
 179    struct gl_sync_object *syncObj = (struct gl_sync_object *) sync;
 180    mtx_lock(&ctx->Shared->Mutex);
 181    if (syncObj != NULL
 182       && _mesa_set_search(ctx->Shared->SyncObjects, syncObj) != NULL
 183       && !syncObj->DeletePending) {
 184      if (incRefCount) {
 185        syncObj->RefCount++;
 186      }
 187    } else {
 188      syncObj = NULL;
 189    }
 190    mtx_unlock(&ctx->Shared->Mutex);
 191    return syncObj;
 192 }
 193
 194
 195 void
 196 _mesa_unref_sync_object(struct gl_context *ctx, struct gl_sync_object *syncObj,
 197                         int amount)
 198 {
 199    struct set_entry *entry;
 200
 201    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       mtx_unlock(&ctx->Shared->Mutex);
 208
 209       ctx->Driver.DeleteSyncObject(ctx, syncObj);
 210    } else {
 211       mtx_unlock(&ctx->Shared->Mutex);
 212    }
 213 }
 214
 215
 216 GLboolean GLAPIENTRY
 217 _mesa_IsSync(GLsync sync)
 218 {
 219    GET_CURRENT_CONTEXT(ctx);
 220    ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, GL_FALSE);
 221
 222    return _mesa_get_and_ref_sync(ctx, sync, false) ? GL_TRUE : GL_FALSE;
 223 }
 224
 225
 226 void GLAPIENTRY
 227 _mesa_DeleteSync(GLsync sync)
 228 {
 229    GET_CURRENT_CONTEXT(ctx);
 230    struct gl_sync_object *syncObj;
 231
 232    /* From the GL_ARB_sync spec:
 233     *
 234     *    DeleteSync will silently ignore a <sync> value of zero. An
 235     *    INVALID_VALUE error is generated if <sync> is neither zero nor the
 236     *    name of a sync object.
 237     */
 238    if (sync == 0) {
 239       return;
 240    }
 241
 242    syncObj = _mesa_get_and_ref_sync(ctx, sync, true);
 243    if (!syncObj) {
 244       _mesa_error(ctx, GL_INVALID_VALUE, "glDeleteSync (not a valid sync object)");
 245       return;
 246    }
 247
 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 pointer
 251     * is valid for us to manipulate.
 252     */
 253    syncObj->DeletePending = GL_TRUE;
 254    _mesa_unref_sync_object(ctx, syncObj, 2);
 255 }
 256
 257
 258 static GLsync
 259 fence_sync(struct gl_context *ctx, GLenum condition, GLbitfield flags)
 260 {
 261    struct gl_sync_object *syncObj;
 262
 263    syncObj = ctx->Driver.NewSyncObject(ctx);
 264    if (syncObj != NULL) {
 265       /* The name is not currently used, and it is never visible to
 266        * applications.  If sync support is extended to provide support for
 267        * NV_fence, this field will be used.  We'll also need to add an object
 268        * ID hashtable.
 269        */
 270       syncObj->Name = 1;
 271       syncObj->RefCount = 1;
 272       syncObj->DeletePending = GL_FALSE;
 273       syncObj->SyncCondition = condition;
 274       syncObj->Flags = flags;
 275       syncObj->StatusFlag = 0;
 276
 277       ctx->Driver.FenceSync(ctx, syncObj, condition, flags);
 278
 279       mtx_lock(&ctx->Shared->Mutex);
 280       _mesa_set_add(ctx->Shared->SyncObjects, syncObj);
 281       mtx_unlock(&ctx->Shared->Mutex);
 282
 283       return (GLsync)syncObj;
 284    }
 285
 286    return NULL;
 287 }
 288
 289
 290 GLsync GLAPIENTRY
 291 _mesa_FenceSync_no_error(GLenum condition, GLbitfield flags)
 292 {
 293    GET_CURRENT_CONTEXT(ctx);
 294    return fence_sync(ctx, condition, flags);
 295 }
 296
 297
 298 GLsync GLAPIENTRY
 299 _mesa_FenceSync(GLenum condition, GLbitfield flags)
 300 {
 301    GET_CURRENT_CONTEXT(ctx);
 302    ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, 0);
 303
 304    if (condition != GL_SYNC_GPU_COMMANDS_COMPLETE) {
 305       _mesa_error(ctx, GL_INVALID_ENUM, "glFenceSync(condition=0x%x)",
 306                   condition);
 307       return 0;
 308    }
 309
 310    if (flags != 0) {
 311       _mesa_error(ctx, GL_INVALID_VALUE, "glFenceSync(flags=0x%x)",
 312                   condition);
 313       return 0;
 314    }
 315
 316    return fence_sync(ctx, condition, flags);
 317 }
 318
 319
 320 static GLenum
 321 client_wait_sync(struct gl_context *ctx, struct gl_sync_object *syncObj,
 322                  GLbitfield flags, GLuint64 timeout)
 323 {
 324    GLenum ret;
 325
 326    /* From the GL_ARB_sync spec:
 327     *
 328     *    ClientWaitSync returns one of four status values. A return value of
 329     *    ALREADY_SIGNALED indicates that <sync> was signaled at the time
 330     *    ClientWaitSync was called. ALREADY_SIGNALED will always be returned
 331     *    if <sync> was signaled, even if the value of <timeout> is zero.
 332     */
 333    ctx->Driver.CheckSync(ctx, syncObj);
 334    if (syncObj->StatusFlag) {
 335       ret = GL_ALREADY_SIGNALED;
 336    } else {
 337       if (timeout == 0) {
 338          ret = GL_TIMEOUT_EXPIRED;
 339       } else {
 340          ctx->Driver.ClientWaitSync(ctx, syncObj, flags, timeout);
 341
 342          ret = syncObj->StatusFlag ? GL_CONDITION_SATISFIED : GL_TIMEOUT_EXPIRED;
 343       }
 344    }
 345
 346    _mesa_unref_sync_object(ctx, syncObj, 1);
 347    return ret;
 348 }
 349
 350
 351 GLenum GLAPIENTRY
 352 _mesa_ClientWaitSync_no_error(GLsync sync, GLbitfield flags, GLuint64 timeout)
 353 {
 354    GET_CURRENT_CONTEXT(ctx);
 355
 356    struct gl_sync_object *syncObj = _mesa_get_and_ref_sync(ctx, sync, true);
 357    return client_wait_sync(ctx, syncObj, flags, timeout);
 358 }
 359
 360
 361 GLenum GLAPIENTRY
 362 _mesa_ClientWaitSync(GLsync sync, GLbitfield flags, GLuint64 timeout)
 363 {
 364    GET_CURRENT_CONTEXT(ctx);
 365    struct gl_sync_object *syncObj;
 366
 367    ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, GL_WAIT_FAILED);
 368
 369    if ((flags & ~GL_SYNC_FLUSH_COMMANDS_BIT) != 0) {
 370       _mesa_error(ctx, GL_INVALID_VALUE, "glClientWaitSync(flags=0x%x)", flags);
 371       return GL_WAIT_FAILED;
 372    }
 373
 374    syncObj = _mesa_get_and_ref_sync(ctx, sync, true);
 375    if (!syncObj) {
 376       _mesa_error(ctx, GL_INVALID_VALUE, "glClientWaitSync (not a valid sync object)");
 377       return GL_WAIT_FAILED;
 378    }
 379
 380    return client_wait_sync(ctx, syncObj, flags, timeout);
 381 }
 382
 383
 384 static void
 385 wait_sync(struct gl_context *ctx, struct gl_sync_object *syncObj,
 386           GLbitfield flags, GLuint64 timeout)
 387 {
 388    ctx->Driver.ServerWaitSync(ctx, syncObj, flags, timeout);
 389    _mesa_unref_sync_object(ctx, syncObj, 1);
 390 }
 391
 392
 393 void GLAPIENTRY
 394 _mesa_WaitSync(GLsync sync, GLbitfield flags, GLuint64 timeout)
 395 {
 396    GET_CURRENT_CONTEXT(ctx);
 397    struct gl_sync_object *syncObj;
 398
 399    if (flags != 0) {
 400       _mesa_error(ctx, GL_INVALID_VALUE, "glWaitSync(flags=0x%x)", flags);
 401       return;
 402    }
 403
 404    if (timeout != GL_TIMEOUT_IGNORED) {
 405       _mesa_error(ctx, GL_INVALID_VALUE, "glWaitSync(timeout=0x%" PRIx64 ")",
 406                   (uint64_t) timeout);
 407       return;
 408    }
 409
 410    syncObj = _mesa_get_and_ref_sync(ctx, sync, true);
 411    if (!syncObj) {
 412       _mesa_error(ctx, GL_INVALID_VALUE, "glWaitSync (not a valid sync object)");
 413       return;
 414    }
 415
 416    wait_sync(ctx, syncObj, flags, timeout);
 417 }
 418
 419
 420 void GLAPIENTRY
 421 _mesa_GetSynciv(GLsync sync, GLenum pname, GLsizei bufSize, GLsizei *length,
 422                 GLint *values)
 423 {
 424    GET_CURRENT_CONTEXT(ctx);
 425    struct gl_sync_object *syncObj;
 426    GLsizei size = 0;
 427    GLint v[1];
 428
 429    syncObj = _mesa_get_and_ref_sync(ctx, sync, true);
 430    if (!syncObj) {
 431       _mesa_error(ctx, GL_INVALID_VALUE, "glGetSynciv (not a valid sync object)");
 432       return;
 433    }
 434
 435    switch (pname) {
 436    case GL_OBJECT_TYPE:
 437       v[0] = GL_SYNC_FENCE;
 438       size = 1;
 439       break;
 440
 441    case GL_SYNC_CONDITION:
 442       v[0] = syncObj->SyncCondition;
 443       size = 1;
 444       break;
 445
 446    case GL_SYNC_STATUS:
 447       /* Update the state of the sync by dipping into the driver.  Note that
 448        * this call won't block.  It just updates state in the common object
 449        * data from the current driver state.
 450        */
 451       ctx->Driver.CheckSync(ctx, syncObj);
 452
 453       v[0] = (syncObj->StatusFlag) ? GL_SIGNALED : GL_UNSIGNALED;
 454       size = 1;
 455       break;
 456
 457    case GL_SYNC_FLAGS:
 458       v[0] = syncObj->Flags;
 459       size = 1;
 460       break;
 461
 462    default:
 463       _mesa_error(ctx, GL_INVALID_ENUM, "glGetSynciv(pname=0x%x)\n", pname);
 464       _mesa_unref_sync_object(ctx, syncObj, 1);
 465       return;
 466    }
 467
 468    /* Section 4.1.3 (Sync Object Queries) of the OpenGL ES 3.10 spec says:
 469     *
 470     *    "An INVALID_VALUE error is generated if bufSize is negative."
 471     */
 472    if (bufSize < 0) {
 473       _mesa_error(ctx, GL_INVALID_VALUE, "glGetSynciv(pname=0x%x)\n", pname);
 474    }
 475
 476    if (size > 0 && bufSize > 0) {
 477       const GLsizei copy_count = MIN2(size, bufSize);
 478
 479       memcpy(values, v, sizeof(GLint) * copy_count);
 480    }
 481
 482    if (length != NULL) {
 483       *length = size;
 484    }
 485
 486    _mesa_unref_sync_object(ctx, syncObj, 1);
 487 }