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, GLenum type)
  73 {
  74    struct gl_sync_object *s = CALLOC_STRUCT(gl_sync_object);
  75    (void) ctx;
  76    (void) type;
  77
  78    return s;
  79 }
  80
  81
  82 static void
  83 _mesa_delete_sync_object(struct gl_context *ctx, struct gl_sync_object *syncObj)
  84 {
  85    (void) ctx;
  86    free(syncObj->Label);
  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 /**
 165  * Check if the given sync object is:
 166  *  - non-null
 167  *  - not in sync objects hash table
 168  *  - type is GL_SYNC_FENCE
 169  *  - not marked as deleted
 170  */
 171 bool
 172 _mesa_validate_sync(struct gl_context *ctx,
 173                     const struct gl_sync_object *syncObj)
 174 {
 175    return (syncObj != NULL)
 176       && _mesa_set_search(ctx->Shared->SyncObjects, syncObj) != NULL
 177       && (syncObj->Type == GL_SYNC_FENCE)
 178       && !syncObj->DeletePending;
 179 }
 180
 181
 182 void
 183 _mesa_ref_sync_object(struct gl_context *ctx, struct gl_sync_object *syncObj)
 184 {
 185    mtx_lock(&ctx->Shared->Mutex);
 186    syncObj->RefCount++;
 187    mtx_unlock(&ctx->Shared->Mutex);
 188 }
 189
 190
 191 void
 192 _mesa_unref_sync_object(struct gl_context *ctx, struct gl_sync_object *syncObj)
 193 {
 194    struct set_entry *entry;
 195
 196    mtx_lock(&ctx->Shared->Mutex);
 197    syncObj->RefCount--;
 198    if (syncObj->RefCount == 0) {
 199       entry = _mesa_set_search(ctx->Shared->SyncObjects, syncObj);
 200       assert (entry != NULL);
 201       _mesa_set_remove(ctx->Shared->SyncObjects, entry);
 202       mtx_unlock(&ctx->Shared->Mutex);
 203
 204       ctx->Driver.DeleteSyncObject(ctx, syncObj);
 205    } else {
 206       mtx_unlock(&ctx->Shared->Mutex);
 207    }
 208 }
 209
 210
 211 GLboolean GLAPIENTRY
 212 _mesa_IsSync(GLsync sync)
 213 {
 214    GET_CURRENT_CONTEXT(ctx);
 215    struct gl_sync_object *const syncObj = (struct gl_sync_object *) sync;
 216    ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, GL_FALSE);
 217
 218    return _mesa_validate_sync(ctx, syncObj) ? GL_TRUE : GL_FALSE;
 219 }
 220
 221
 222 void GLAPIENTRY
 223 _mesa_DeleteSync(GLsync sync)
 224 {
 225    GET_CURRENT_CONTEXT(ctx);
 226    struct gl_sync_object *const syncObj = (struct gl_sync_object *) sync;
 227
 228    /* From the GL_ARB_sync spec:
 229     *
 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.
 233     */
 234    if (sync == 0) {
 235       return;
 236    }
 237
 238    if (!_mesa_validate_sync(ctx, syncObj)) {
 239       _mesa_error(ctx, GL_INVALID_VALUE, "glDeleteSync (not a valid sync object)");
 240       return;
 241    }
 242
 243    /* If there are no client-waits or server-waits pending on this sync, delete
 244     * the underlying object.
 245     */
 246    syncObj->DeletePending = GL_TRUE;
 247    _mesa_unref_sync_object(ctx, syncObj);
 248 }
 249
 250
 251 GLsync GLAPIENTRY
 252 _mesa_FenceSync(GLenum condition, GLbitfield flags)
 253 {
 254    GET_CURRENT_CONTEXT(ctx);
 255    struct gl_sync_object *syncObj;
 256    ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, 0);
 257
 258    if (condition != GL_SYNC_GPU_COMMANDS_COMPLETE) {
 259       _mesa_error(ctx, GL_INVALID_ENUM, "glFenceSync(condition=0x%x)",
 260                   condition);
 261       return 0;
 262    }
 263
 264    if (flags != 0) {
 265       _mesa_error(ctx, GL_INVALID_VALUE, "glFenceSync(flags=0x%x)",
 266                   condition);
 267       return 0;
 268    }
 269
 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
 276        * ID hashtable.
 277        */
 278       syncObj->Name = 1;
 279       syncObj->RefCount = 1;
 280       syncObj->DeletePending = GL_FALSE;
 281       syncObj->SyncCondition = condition;
 282       syncObj->Flags = flags;
 283       syncObj->StatusFlag = 0;
 284
 285       ctx->Driver.FenceSync(ctx, syncObj, condition, flags);
 286
 287       mtx_lock(&ctx->Shared->Mutex);
 288       _mesa_set_add(ctx->Shared->SyncObjects, syncObj);
 289       mtx_unlock(&ctx->Shared->Mutex);
 290
 291       return (GLsync) syncObj;
 292    }
 293
 294    return NULL;
 295 }
 296
 297
 298 GLenum GLAPIENTRY
 299 _mesa_ClientWaitSync(GLsync sync, GLbitfield flags, GLuint64 timeout)
 300 {
 301    GET_CURRENT_CONTEXT(ctx);
 302    struct gl_sync_object *const syncObj = (struct gl_sync_object *) sync;
 303    GLenum ret;
 304    ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, GL_WAIT_FAILED);
 305
 306    if (!_mesa_validate_sync(ctx, syncObj)) {
 307       _mesa_error(ctx, GL_INVALID_VALUE, "glClientWaitSync (not a valid sync object)");
 308       return GL_WAIT_FAILED;
 309    }
 310
 311    if ((flags & ~GL_SYNC_FLUSH_COMMANDS_BIT) != 0) {
 312       _mesa_error(ctx, GL_INVALID_VALUE, "glClientWaitSync(flags=0x%x)", flags);
 313       return GL_WAIT_FAILED;
 314    }
 315
 316    _mesa_ref_sync_object(ctx, syncObj);
 317
 318    /* From the GL_ARB_sync spec:
 319     *
 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.
 324     */
 325    ctx->Driver.CheckSync(ctx, syncObj);
 326    if (syncObj->StatusFlag) {
 327       ret = GL_ALREADY_SIGNALED;
 328    } else {
 329       if (timeout == 0) {
 330          ret = GL_TIMEOUT_EXPIRED;
 331       } else {
 332          ctx->Driver.ClientWaitSync(ctx, syncObj, flags, timeout);
 333
 334          ret = syncObj->StatusFlag ? GL_CONDITION_SATISFIED : GL_TIMEOUT_EXPIRED;
 335       }
 336    }
 337
 338    _mesa_unref_sync_object(ctx, syncObj);
 339    return ret;
 340 }
 341
 342
 343 void GLAPIENTRY
 344 _mesa_WaitSync(GLsync sync, GLbitfield flags, GLuint64 timeout)
 345 {
 346    GET_CURRENT_CONTEXT(ctx);
 347    struct gl_sync_object *const syncObj = (struct gl_sync_object *) sync;
 348
 349    if (!_mesa_validate_sync(ctx, syncObj)) {
 350       _mesa_error(ctx, GL_INVALID_VALUE, "glWaitSync (not a valid sync object)");
 351       return;
 352    }
 353
 354    if (flags != 0) {
 355       _mesa_error(ctx, GL_INVALID_VALUE, "glWaitSync(flags=0x%x)", flags);
 356       return;
 357    }
 358
 359    if (timeout != GL_TIMEOUT_IGNORED) {
 360       _mesa_error(ctx, GL_INVALID_VALUE, "glWaitSync(timeout=0x%" PRIx64 ")",
 361                   (uint64_t) timeout);
 362       return;
 363    }
 364
 365    ctx->Driver.ServerWaitSync(ctx, syncObj, flags, timeout);
 366 }
 367
 368
 369 void GLAPIENTRY
 370 _mesa_GetSynciv(GLsync sync, GLenum pname, GLsizei bufSize, GLsizei *length,
 371                 GLint *values)
 372 {
 373    GET_CURRENT_CONTEXT(ctx);
 374    struct gl_sync_object *const syncObj = (struct gl_sync_object *) sync;
 375    GLsizei size = 0;
 376    GLint v[1];
 377
 378    if (!_mesa_validate_sync(ctx, syncObj)) {
 379       _mesa_error(ctx, GL_INVALID_VALUE, "glGetSynciv (not a valid sync object)");
 380       return;
 381    }
 382
 383    switch (pname) {
 384    case GL_OBJECT_TYPE:
 385       v[0] = syncObj->Type;
 386       size = 1;
 387       break;
 388
 389    case GL_SYNC_CONDITION:
 390       v[0] = syncObj->SyncCondition;
 391       size = 1;
 392       break;
 393
 394    case GL_SYNC_STATUS:
 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.
 398        */
 399       ctx->Driver.CheckSync(ctx, syncObj);
 400
 401       v[0] = (syncObj->StatusFlag) ? GL_SIGNALED : GL_UNSIGNALED;
 402       size = 1;
 403       break;
 404
 405    case GL_SYNC_FLAGS:
 406       v[0] = syncObj->Flags;
 407       size = 1;
 408       break;
 409
 410    default:
 411       _mesa_error(ctx, GL_INVALID_ENUM, "glGetSynciv(pname=0x%x)\n", pname);
 412       return;
 413    }
 414
 415    if (size > 0 && bufSize > 0) {
 416       const GLsizei copy_count = MIN2(size, bufSize);
 417
 418       memcpy(values, v, sizeof(GLint) * copy_count);
 419    }
 420
 421    if (length != NULL) {
 422       *length = size;
 423    }
 424 }