src/mesa/main/shared.c

   1 /*
   2  * Mesa 3-D graphics library
   3  *
   4  * Copyright (C) 2009  VMware, Inc.  All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the "Software"),
   8  * to deal in the Software without restriction, including without limitation
   9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10  * and/or sell copies of the Software, and to permit persons to whom the
  11  * Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included
  14  * in all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  20  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  22  * OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24
  25 /**
  26  * \file shared.c
  27  * Shared-context state
  28  */
  29
  30 #include "util/imports.h"
  31 #include "mtypes.h"
  32 #include "hash.h"
  33 #include "atifragshader.h"
  34 #include "bufferobj.h"
  35 #include "shared.h"
  36 #include "program/program.h"
  37 #include "dlist.h"
  38 #include "samplerobj.h"
  39 #include "shaderapi.h"
  40 #include "shaderobj.h"
  41 #include "syncobj.h"
  42 #include "texturebindless.h"
  43
  44 #include "util/hash_table.h"
  45 #include "util/set.h"
  46
  47 static void
  48 free_shared_state(struct gl_context *ctx, struct gl_shared_state *shared);
  49
  50 /**
  51  * Allocate and initialize a shared context state structure.
  52  * Initializes the display list, texture objects and vertex programs hash
  53  * tables, allocates the texture objects. If it runs out of memory, frees
  54  * everything already allocated before returning NULL.
  55  *
  56  * \return pointer to a gl_shared_state structure on success, or NULL on
  57  * failure.
  58  */
  59 struct gl_shared_state *
  60 _mesa_alloc_shared_state(struct gl_context *ctx)
  61 {
  62    struct gl_shared_state *shared;
  63    GLuint i;
  64
  65    shared = CALLOC_STRUCT(gl_shared_state);
  66    if (!shared)
  67       return NULL;
  68
  69    simple_mtx_init(&shared->Mutex, mtx_plain);
  70
  71    shared->DisplayList = _mesa_NewHashTable();
  72    shared->BitmapAtlas = _mesa_NewHashTable();
  73    shared->TexObjects = _mesa_NewHashTable();
  74    shared->Programs = _mesa_NewHashTable();
  75
  76    shared->DefaultVertexProgram =
  77       ctx->Driver.NewProgram(ctx, GL_VERTEX_PROGRAM_ARB, 0, true);
  78    shared->DefaultFragmentProgram =
  79       ctx->Driver.NewProgram(ctx, GL_FRAGMENT_PROGRAM_ARB, 0, true);
  80
  81    shared->ATIShaders = _mesa_NewHashTable();
  82    shared->DefaultFragmentShader = _mesa_new_ati_fragment_shader(ctx, 0);
  83
  84    shared->ShaderObjects = _mesa_NewHashTable();
  85
  86    shared->BufferObjects = _mesa_NewHashTable();
  87
  88    /* GL_ARB_sampler_objects */
  89    shared->SamplerObjects = _mesa_NewHashTable();
  90
  91    /* GL_ARB_bindless_texture */
  92    _mesa_init_shared_handles(shared);
  93
  94    /* ARB_shading_language_include */
  95    _mesa_init_shader_includes(shared);
  96    mtx_init(&shared->ShaderIncludeMutex, mtx_plain);
  97
  98    /* Create default texture objects */
  99    for (i = 0; i < NUM_TEXTURE_TARGETS; i++) {
 100       /* NOTE: the order of these enums matches the TEXTURE_x_INDEX values */
 101       static const GLenum targets[] = {
 102          GL_TEXTURE_2D_MULTISAMPLE,
 103          GL_TEXTURE_2D_MULTISAMPLE_ARRAY,
 104          GL_TEXTURE_CUBE_MAP_ARRAY,
 105          GL_TEXTURE_BUFFER,
 106          GL_TEXTURE_2D_ARRAY_EXT,
 107          GL_TEXTURE_1D_ARRAY_EXT,
 108          GL_TEXTURE_EXTERNAL_OES,
 109          GL_TEXTURE_CUBE_MAP,
 110          GL_TEXTURE_3D,
 111          GL_TEXTURE_RECTANGLE_NV,
 112          GL_TEXTURE_2D,
 113          GL_TEXTURE_1D
 114       };
 115       STATIC_ASSERT(ARRAY_SIZE(targets) == NUM_TEXTURE_TARGETS);
 116       shared->DefaultTex[i] = ctx->Driver.NewTextureObject(ctx, 0, targets[i]);
 117       /* Need to explicitly set/overwrite the TargetIndex field here since
 118        * the call to _mesa_tex_target_to_index() in NewTextureObject() may
 119        * fail if the texture target is not supported.
 120        */
 121       shared->DefaultTex[i]->TargetIndex = i;
 122    }
 123
 124    /* sanity check */
 125    assert(shared->DefaultTex[TEXTURE_1D_INDEX]->RefCount == 1);
 126
 127    /* Mutex and timestamp for texobj state validation */
 128    mtx_init(&shared->TexMutex, mtx_recursive);
 129    shared->TextureStateStamp = 0;
 130
 131    shared->FrameBuffers = _mesa_NewHashTable();
 132    shared->RenderBuffers = _mesa_NewHashTable();
 133
 134    shared->SyncObjects = _mesa_set_create(NULL, _mesa_hash_pointer,
 135                                           _mesa_key_pointer_equal);
 136
 137    shared->MemoryObjects = _mesa_NewHashTable();
 138    shared->SemaphoreObjects = _mesa_NewHashTable();
 139
 140    return shared;
 141 }
 142
 143
 144 /**
 145  * Callback for deleting a display list.  Called by _mesa_HashDeleteAll().
 146  */
 147 static void
 148 delete_displaylist_cb(GLuint id, void *data, void *userData)
 149 {
 150    struct gl_display_list *list = (struct gl_display_list *) data;
 151    struct gl_context *ctx = (struct gl_context *) userData;
 152    _mesa_delete_list(ctx, list);
 153 }
 154
 155
 156 /**
 157  * Callback for deleting a bitmap atlas.  Called by _mesa_HashDeleteAll().
 158  */
 159 static void
 160 delete_bitmap_atlas_cb(GLuint id, void *data, void *userData)
 161 {
 162    struct gl_bitmap_atlas *atlas = (struct gl_bitmap_atlas *) data;
 163    struct gl_context *ctx = (struct gl_context *) userData;
 164    _mesa_delete_bitmap_atlas(ctx, atlas);
 165 }
 166
 167
 168 /**
 169  * Callback for deleting a texture object.  Called by _mesa_HashDeleteAll().
 170  */
 171 static void
 172 delete_texture_cb(GLuint id, void *data, void *userData)
 173 {
 174    struct gl_texture_object *texObj = (struct gl_texture_object *) data;
 175    struct gl_context *ctx = (struct gl_context *) userData;
 176    ctx->Driver.DeleteTexture(ctx, texObj);
 177 }
 178
 179
 180 /**
 181  * Callback for deleting a program object.  Called by _mesa_HashDeleteAll().
 182  */
 183 static void
 184 delete_program_cb(GLuint id, void *data, void *userData)
 185 {
 186    struct gl_program *prog = (struct gl_program *) data;
 187    struct gl_context *ctx = (struct gl_context *) userData;
 188    if(prog != &_mesa_DummyProgram) {
 189       assert(prog->RefCount == 1); /* should only be referenced by hash table */
 190       prog->RefCount = 0;  /* now going away */
 191       ctx->Driver.DeleteProgram(ctx, prog);
 192    }
 193 }
 194
 195
 196 /**
 197  * Callback for deleting an ATI fragment shader object.
 198  * Called by _mesa_HashDeleteAll().
 199  */
 200 static void
 201 delete_fragshader_cb(GLuint id, void *data, void *userData)
 202 {
 203    struct ati_fragment_shader *shader = (struct ati_fragment_shader *) data;
 204    struct gl_context *ctx = (struct gl_context *) userData;
 205    _mesa_delete_ati_fragment_shader(ctx, shader);
 206 }
 207
 208
 209 /**
 210  * Callback for deleting a buffer object.  Called by _mesa_HashDeleteAll().
 211  */
 212 static void
 213 delete_bufferobj_cb(GLuint id, void *data, void *userData)
 214 {
 215    struct gl_buffer_object *bufObj = (struct gl_buffer_object *) data;
 216    struct gl_context *ctx = (struct gl_context *) userData;
 217
 218    _mesa_buffer_unmap_all_mappings(ctx, bufObj);
 219    _mesa_reference_buffer_object(ctx, &bufObj, NULL);
 220 }
 221
 222
 223 /**
 224  * Callback for freeing shader program data. Call it before delete_shader_cb
 225  * to avoid memory access error.
 226  */
 227 static void
 228 free_shader_program_data_cb(GLuint id, void *data, void *userData)
 229 {
 230    struct gl_context *ctx = (struct gl_context *) userData;
 231    struct gl_shader_program *shProg = (struct gl_shader_program *) data;
 232
 233    if (shProg->Type == GL_SHADER_PROGRAM_MESA) {
 234        _mesa_free_shader_program_data(ctx, shProg);
 235    }
 236 }
 237
 238
 239 /**
 240  * Callback for deleting shader and shader programs objects.
 241  * Called by _mesa_HashDeleteAll().
 242  */
 243 static void
 244 delete_shader_cb(GLuint id, void *data, void *userData)
 245 {
 246    struct gl_context *ctx = (struct gl_context *) userData;
 247    struct gl_shader *sh = (struct gl_shader *) data;
 248    if (_mesa_validate_shader_target(ctx, sh->Type)) {
 249       _mesa_delete_shader(ctx, sh);
 250    }
 251    else {
 252       struct gl_shader_program *shProg = (struct gl_shader_program *) data;
 253       assert(shProg->Type == GL_SHADER_PROGRAM_MESA);
 254       _mesa_delete_shader_program(ctx, shProg);
 255    }
 256 }
 257
 258
 259 /**
 260  * Callback for deleting a framebuffer object.  Called by _mesa_HashDeleteAll()
 261  */
 262 static void
 263 delete_framebuffer_cb(GLuint id, void *data, void *userData)
 264 {
 265    struct gl_framebuffer *fb = (struct gl_framebuffer *) data;
 266    /* The fact that the framebuffer is in the hashtable means its refcount
 267     * is one, but we're removing from the hashtable now.  So clear refcount.
 268     */
 269    /*assert(fb->RefCount == 1);*/
 270    fb->RefCount = 0;
 271
 272    /* NOTE: Delete should always be defined but there are two reports
 273     * of it being NULL (bugs 13507, 14293).  Work-around for now.
 274     */
 275    if (fb->Delete)
 276       fb->Delete(fb);
 277 }
 278
 279
 280 /**
 281  * Callback for deleting a renderbuffer object. Called by _mesa_HashDeleteAll()
 282  */
 283 static void
 284 delete_renderbuffer_cb(GLuint id, void *data, void *userData)
 285 {
 286    struct gl_context *ctx = (struct gl_context *) userData;
 287    struct gl_renderbuffer *rb = (struct gl_renderbuffer *) data;
 288    rb->RefCount = 0;  /* see comment for FBOs above */
 289    if (rb->Delete)
 290       rb->Delete(ctx, rb);
 291 }
 292
 293
 294 /**
 295  * Callback for deleting a sampler object. Called by _mesa_HashDeleteAll()
 296  */
 297 static void
 298 delete_sampler_object_cb(GLuint id, void *data, void *userData)
 299 {
 300    struct gl_context *ctx = (struct gl_context *) userData;
 301    struct gl_sampler_object *sampObj = (struct gl_sampler_object *) data;
 302    _mesa_reference_sampler_object(ctx, &sampObj, NULL);
 303 }
 304
 305 /**
 306  * Callback for deleting a memory object.  Called by _mesa_HashDeleteAll().
 307  */
 308 static void
 309 delete_memory_object_cb(GLuint id, void *data, void *userData)
 310 {
 311    struct gl_memory_object *memObj = (struct gl_memory_object *) data;
 312    struct gl_context *ctx = (struct gl_context *) userData;
 313    ctx->Driver.DeleteMemoryObject(ctx, memObj);
 314 }
 315
 316 /**
 317  * Callback for deleting a memory object.  Called by _mesa_HashDeleteAll().
 318  */
 319 static void
 320 delete_semaphore_object_cb(GLuint id, void *data, void *userData)
 321 {
 322    struct gl_semaphore_object *semObj = (struct gl_semaphore_object *) data;
 323    struct gl_context *ctx = (struct gl_context *) userData;
 324    ctx->Driver.DeleteSemaphoreObject(ctx, semObj);
 325 }
 326
 327 /**
 328  * Deallocate a shared state object and all children structures.
 329  *
 330  * \param ctx GL context.
 331  * \param shared shared state pointer.
 332  *
 333  * Frees the display lists, the texture objects (calling the driver texture
 334  * deletion callback to free its private data) and the vertex programs, as well
 335  * as their hash tables.
 336  *
 337  * \sa alloc_shared_state().
 338  */
 339 static void
 340 free_shared_state(struct gl_context *ctx, struct gl_shared_state *shared)
 341 {
 342    GLuint i;
 343
 344    /* Free the dummy/fallback texture objects */
 345    for (i = 0; i < NUM_TEXTURE_TARGETS; i++) {
 346       if (shared->FallbackTex[i])
 347          ctx->Driver.DeleteTexture(ctx, shared->FallbackTex[i]);
 348    }
 349
 350    /*
 351     * Free display lists
 352     */
 353    if (shared->DisplayList) {
 354       _mesa_HashDeleteAll(shared->DisplayList, delete_displaylist_cb, ctx);
 355       _mesa_DeleteHashTable(shared->DisplayList);
 356    }
 357
 358    if (shared->BitmapAtlas) {
 359       _mesa_HashDeleteAll(shared->BitmapAtlas, delete_bitmap_atlas_cb, ctx);
 360       _mesa_DeleteHashTable(shared->BitmapAtlas);
 361    }
 362
 363    if (shared->ShaderObjects) {
 364       _mesa_HashWalk(shared->ShaderObjects, free_shader_program_data_cb, ctx);
 365       _mesa_HashDeleteAll(shared->ShaderObjects, delete_shader_cb, ctx);
 366       _mesa_DeleteHashTable(shared->ShaderObjects);
 367    }
 368
 369    if (shared->Programs) {
 370       _mesa_HashDeleteAll(shared->Programs, delete_program_cb, ctx);
 371       _mesa_DeleteHashTable(shared->Programs);
 372    }
 373
 374    if (shared->DefaultVertexProgram)
 375       _mesa_reference_program(ctx, &shared->DefaultVertexProgram, NULL);
 376
 377    if (shared->DefaultFragmentProgram)
 378       _mesa_reference_program(ctx, &shared->DefaultFragmentProgram, NULL);
 379
 380    if (shared->DefaultFragmentShader)
 381       _mesa_delete_ati_fragment_shader(ctx, shared->DefaultFragmentShader);
 382
 383    if (shared->ATIShaders) {
 384       _mesa_HashDeleteAll(shared->ATIShaders, delete_fragshader_cb, ctx);
 385       _mesa_DeleteHashTable(shared->ATIShaders);
 386    }
 387
 388    if (shared->BufferObjects) {
 389       _mesa_HashDeleteAll(shared->BufferObjects, delete_bufferobj_cb, ctx);
 390       _mesa_DeleteHashTable(shared->BufferObjects);
 391    }
 392
 393    if (shared->FrameBuffers) {
 394       _mesa_HashDeleteAll(shared->FrameBuffers, delete_framebuffer_cb, ctx);
 395       _mesa_DeleteHashTable(shared->FrameBuffers);
 396    }
 397
 398    if (shared->RenderBuffers) {
 399       _mesa_HashDeleteAll(shared->RenderBuffers, delete_renderbuffer_cb, ctx);
 400       _mesa_DeleteHashTable(shared->RenderBuffers);
 401    }
 402
 403    if (shared->SyncObjects) {
 404       set_foreach(shared->SyncObjects, entry) {
 405          _mesa_unref_sync_object(ctx, (struct gl_sync_object *) entry->key, 1);
 406       }
 407
 408       _mesa_set_destroy(shared->SyncObjects, NULL);
 409    }
 410
 411    if (shared->SamplerObjects) {
 412       _mesa_HashDeleteAll(shared->SamplerObjects, delete_sampler_object_cb,
 413                           ctx);
 414       _mesa_DeleteHashTable(shared->SamplerObjects);
 415    }
 416
 417    /*
 418     * Free texture objects (after FBOs since some textures might have
 419     * been bound to FBOs).
 420     */
 421    assert(ctx->Driver.DeleteTexture);
 422    /* the default textures */
 423    for (i = 0; i < NUM_TEXTURE_TARGETS; i++) {
 424       if (shared->DefaultTex[i])
 425          ctx->Driver.DeleteTexture(ctx, shared->DefaultTex[i]);
 426    }
 427
 428    /* all other textures */
 429    if (shared->TexObjects) {
 430       _mesa_HashDeleteAll(shared->TexObjects, delete_texture_cb, ctx);
 431       _mesa_DeleteHashTable(shared->TexObjects);
 432    }
 433
 434    _mesa_free_shared_handles(shared);
 435
 436    /* ARB_shading_language_include */
 437    _mesa_destroy_shader_includes(shared);
 438    mtx_destroy(&shared->ShaderIncludeMutex);
 439
 440    if (shared->MemoryObjects) {
 441       _mesa_HashDeleteAll(shared->MemoryObjects, delete_memory_object_cb, ctx);
 442       _mesa_DeleteHashTable(shared->MemoryObjects);
 443    }
 444
 445    if (shared->SemaphoreObjects) {
 446       _mesa_HashDeleteAll(shared->SemaphoreObjects, delete_semaphore_object_cb, ctx);
 447       _mesa_DeleteHashTable(shared->SemaphoreObjects);
 448    }
 449
 450    simple_mtx_destroy(&shared->Mutex);
 451    mtx_destroy(&shared->TexMutex);
 452
 453    free(shared);
 454 }
 455
 456
 457 /**
 458  * gl_shared_state objects are ref counted.
 459  * If ptr's refcount goes to zero, free the shared state.
 460  */
 461 void
 462 _mesa_reference_shared_state(struct gl_context *ctx,
 463                              struct gl_shared_state **ptr,
 464                              struct gl_shared_state *state)
 465 {
 466    if (*ptr == state)
 467       return;
 468
 469    if (*ptr) {
 470       /* unref old state */
 471       struct gl_shared_state *old = *ptr;
 472       GLboolean delete;
 473
 474       simple_mtx_lock(&old->Mutex);
 475       assert(old->RefCount >= 1);
 476       old->RefCount--;
 477       delete = (old->RefCount == 0);
 478       simple_mtx_unlock(&old->Mutex);
 479
 480       if (delete) {
 481          free_shared_state(ctx, old);
 482       }
 483
 484       *ptr = NULL;
 485    }
 486
 487    if (state) {
 488       /* reference new state */
 489       simple_mtx_lock(&state->Mutex);
 490       state->RefCount++;
 491       *ptr = state;
 492       simple_mtx_unlock(&state->Mutex);
 493    }
 494 }