src/gallium/drivers/llvmpipe/lp_scene.c

   1 /**************************************************************************
   2  *
   3  * Copyright 2009 VMware, Inc.
   4  * 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
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  21  * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
  22  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  **************************************************************************/
  27
  28 #include "util/u_framebuffer.h"
  29 #include "util/u_math.h"
  30 #include "util/u_memory.h"
  31 #include "util/u_inlines.h"
  32 #include "util/u_simple_list.h"
  33 #include "util/u_format.h"
  34 #include "lp_scene.h"
  35 #include "lp_fence.h"
  36 #include "lp_debug.h"
  37
  38
  39 #define RESOURCE_REF_SZ 32
  40
  41 /** List of resource references */
  42 struct resource_ref {
  43    struct pipe_resource *resource[RESOURCE_REF_SZ];
  44    int count;
  45    struct resource_ref *next;
  46 };
  47
  48
  49 /**
  50  * Create a new scene object.
  51  * \param queue  the queue to put newly rendered/emptied scenes into
  52  */
  53 struct lp_scene *
  54 lp_scene_create( struct pipe_context *pipe )
  55 {
  56    struct lp_scene *scene = CALLOC_STRUCT(lp_scene);
  57    if (!scene)
  58       return NULL;
  59
  60    scene->pipe = pipe;
  61
  62    scene->data.head =
  63       CALLOC_STRUCT(data_block);
  64
  65    pipe_mutex_init(scene->mutex);
  66
  67 #ifdef DEBUG
  68    /* Do some scene limit sanity checks here */
  69    {
  70       size_t maxBins = TILES_X * TILES_Y;
  71       size_t maxCommandBytes = sizeof(struct cmd_block) * maxBins;
  72       size_t maxCommandPlusData = maxCommandBytes + DATA_BLOCK_SIZE;
  73       /* We'll need at least one command block per bin.  Make sure that's
  74        * less than the max allowed scene size.
  75        */
  76       assert(maxCommandBytes < LP_SCENE_MAX_SIZE);
  77       /* We'll also need space for at least one other data block */
  78       assert(maxCommandPlusData <= LP_SCENE_MAX_SIZE);
  79    }
  80 #endif
  81
  82    return scene;
  83 }
  84
  85
  86 /**
  87  * Free all data associated with the given scene, and the scene itself.
  88  */
  89 void
  90 lp_scene_destroy(struct lp_scene *scene)
  91 {
  92    lp_fence_reference(&scene->fence, NULL);
  93    pipe_mutex_destroy(scene->mutex);
  94    assert(scene->data.head->next == NULL);
  95    FREE(scene->data.head);
  96    FREE(scene);
  97 }
  98
  99
 100 /**
 101  * Check if the scene's bins are all empty.
 102  * For debugging purposes.
 103  */
 104 boolean
 105 lp_scene_is_empty(struct lp_scene *scene )
 106 {
 107    unsigned x, y;
 108
 109    for (y = 0; y < TILES_Y; y++) {
 110       for (x = 0; x < TILES_X; x++) {
 111          const struct cmd_bin *bin = lp_scene_get_bin(scene, x, y);
 112          if (bin->head) {
 113             return FALSE;
 114          }
 115       }
 116    }
 117    return TRUE;
 118 }
 119
 120
 121 /* Returns true if there has ever been a failed allocation attempt in
 122  * this scene.  Used in triangle emit to avoid having to check success
 123  * at each bin.
 124  */
 125 boolean
 126 lp_scene_is_oom(struct lp_scene *scene)
 127 {
 128    return scene->alloc_failed;
 129 }
 130
 131
 132 /* Remove all commands from a bin.  Tries to reuse some of the memory
 133  * allocated to the bin, however.
 134  */
 135 void
 136 lp_scene_bin_reset(struct lp_scene *scene, unsigned x, unsigned y)
 137 {
 138    struct cmd_bin *bin = lp_scene_get_bin(scene, x, y);
 139
 140    bin->last_state = NULL;
 141    bin->head = bin->tail;
 142    if (bin->tail) {
 143       bin->tail->next = NULL;
 144       bin->tail->count = 0;
 145    }
 146 }
 147
 148
 149 void
 150 lp_scene_begin_rasterization(struct lp_scene *scene)
 151 {
 152    const struct pipe_framebuffer_state *fb = &scene->fb;
 153    int i;
 154
 155    //LP_DBG(DEBUG_RAST, "%s\n", __FUNCTION__);
 156
 157    for (i = 0; i < scene->fb.nr_cbufs; i++) {
 158       struct pipe_surface *cbuf = scene->fb.cbufs[i];
 159       if (llvmpipe_resource_is_texture(cbuf->texture)) {
 160          scene->cbufs[i].stride = llvmpipe_resource_stride(cbuf->texture,
 161                                                            cbuf->u.tex.level);
 162
 163          scene->cbufs[i].map = llvmpipe_resource_map(cbuf->texture,
 164                                                      cbuf->u.tex.level,
 165                                                      cbuf->u.tex.first_layer,
 166                                                      LP_TEX_USAGE_READ_WRITE,
 167                                                      LP_TEX_LAYOUT_LINEAR);
 168       }
 169       else {
 170          struct llvmpipe_resource *lpr = llvmpipe_resource(cbuf->texture);
 171          unsigned pixstride = util_format_get_blocksize(cbuf->format);
 172          scene->cbufs[i].stride = cbuf->texture->width0;
 173          scene->cbufs[i].map = lpr->data;
 174          scene->cbufs[i].map += cbuf->u.buf.first_element * pixstride;
 175       }
 176    }
 177
 178    if (fb->zsbuf) {
 179       struct pipe_surface *zsbuf = scene->fb.zsbuf;
 180       scene->zsbuf.stride = llvmpipe_resource_stride(zsbuf->texture, zsbuf->u.tex.level);
 181       scene->zsbuf.blocksize =
 182          util_format_get_blocksize(zsbuf->texture->format);
 183
 184       scene->zsbuf.map = llvmpipe_resource_map(zsbuf->texture,
 185                                                zsbuf->u.tex.level,
 186                                                zsbuf->u.tex.first_layer,
 187                                                LP_TEX_USAGE_READ_WRITE,
 188                                                LP_TEX_LAYOUT_LINEAR);
 189    }
 190 }
 191
 192
 193
 194
 195 /**
 196  * Free all the temporary data in a scene.
 197  */
 198 void
 199 lp_scene_end_rasterization(struct lp_scene *scene )
 200 {
 201    int i, j;
 202
 203    /* Unmap color buffers */
 204    for (i = 0; i < scene->fb.nr_cbufs; i++) {
 205       if (scene->cbufs[i].map) {
 206          struct pipe_surface *cbuf = scene->fb.cbufs[i];
 207          if (llvmpipe_resource_is_texture(cbuf->texture)) {
 208             llvmpipe_resource_unmap(cbuf->texture,
 209                                     cbuf->u.tex.level,
 210                                     cbuf->u.tex.first_layer);
 211          }
 212          scene->cbufs[i].map = NULL;
 213       }
 214    }
 215
 216    /* Unmap z/stencil buffer */
 217    if (scene->zsbuf.map) {
 218       struct pipe_surface *zsbuf = scene->fb.zsbuf;
 219       llvmpipe_resource_unmap(zsbuf->texture,
 220                               zsbuf->u.tex.level,
 221                               zsbuf->u.tex.first_layer);
 222       scene->zsbuf.map = NULL;
 223    }
 224
 225    /* Reset all command lists:
 226     */
 227    for (i = 0; i < scene->tiles_x; i++) {
 228       for (j = 0; j < scene->tiles_y; j++) {
 229          struct cmd_bin *bin = lp_scene_get_bin(scene, i, j);
 230          bin->head = NULL;
 231          bin->tail = NULL;
 232          bin->last_state = NULL;
 233       }
 234    }
 235
 236    /* If there are any bins which weren't cleared by the loop above,
 237     * they will be caught (on debug builds at least) by this assert:
 238     */
 239    assert(lp_scene_is_empty(scene));
 240
 241    /* Decrement texture ref counts
 242     */
 243    {
 244       struct resource_ref *ref;
 245       int i, j = 0;
 246
 247       for (ref = scene->resources; ref; ref = ref->next) {
 248          for (i = 0; i < ref->count; i++) {
 249             if (LP_DEBUG & DEBUG_SETUP)
 250                debug_printf("resource %d: %p %dx%d sz %d\n",
 251                             j,
 252                             (void *) ref->resource[i],
 253                             ref->resource[i]->width0,
 254                             ref->resource[i]->height0,
 255                             llvmpipe_resource_size(ref->resource[i]));
 256             j++;
 257             pipe_resource_reference(&ref->resource[i], NULL);
 258          }
 259       }
 260
 261       if (LP_DEBUG & DEBUG_SETUP)
 262          debug_printf("scene %d resources, sz %d\n",
 263                       j, scene->resource_reference_size);
 264    }
 265
 266    /* Free all scene data blocks:
 267     */
 268    {
 269       struct data_block_list *list = &scene->data;
 270       struct data_block *block, *tmp;
 271
 272       for (block = list->head->next; block; block = tmp) {
 273          tmp = block->next;
 274          FREE(block);
 275       }
 276
 277       list->head->next = NULL;
 278       list->head->used = 0;
 279    }
 280
 281    lp_fence_reference(&scene->fence, NULL);
 282
 283    scene->resources = NULL;
 284    scene->scene_size = 0;
 285    scene->resource_reference_size = 0;
 286
 287    scene->has_depthstencil_clear = FALSE;
 288    scene->alloc_failed = FALSE;
 289
 290    util_unreference_framebuffer_state( &scene->fb );
 291 }
 292
 293
 294
 295
 296
 297
 298 struct cmd_block *
 299 lp_scene_new_cmd_block( struct lp_scene *scene,
 300                         struct cmd_bin *bin )
 301 {
 302    struct cmd_block *block = lp_scene_alloc(scene, sizeof(struct cmd_block));
 303    if (block) {
 304       if (bin->tail) {
 305          bin->tail->next = block;
 306          bin->tail = block;
 307       }
 308       else {
 309          bin->head = block;
 310          bin->tail = block;
 311       }
 312       //memset(block, 0, sizeof *block);
 313       block->next = NULL;
 314       block->count = 0;
 315    }
 316    return block;
 317 }
 318
 319
 320 struct data_block *
 321 lp_scene_new_data_block( struct lp_scene *scene )
 322 {
 323    if (scene->scene_size + DATA_BLOCK_SIZE > LP_SCENE_MAX_SIZE) {
 324       if (0) debug_printf("%s: failed\n", __FUNCTION__);
 325       scene->alloc_failed = TRUE;
 326       return NULL;
 327    }
 328    else {
 329       struct data_block *block = MALLOC_STRUCT(data_block);
 330       if (block == NULL)
 331          return NULL;
 332
 333       scene->scene_size += sizeof *block;
 334
 335       block->used = 0;
 336       block->next = scene->data.head;
 337       scene->data.head = block;
 338
 339       return block;
 340    }
 341 }
 342
 343
 344 /**
 345  * Return number of bytes used for all bin data within a scene.
 346  * This does not include resources (textures) referenced by the scene.
 347  */
 348 static unsigned
 349 lp_scene_data_size( const struct lp_scene *scene )
 350 {
 351    unsigned size = 0;
 352    const struct data_block *block;
 353    for (block = scene->data.head; block; block = block->next) {
 354       size += block->used;
 355    }
 356    return size;
 357 }
 358
 359
 360
 361 /**
 362  * Add a reference to a resource by the scene.
 363  */
 364 boolean
 365 lp_scene_add_resource_reference(struct lp_scene *scene,
 366                                 struct pipe_resource *resource,
 367                                 boolean initializing_scene)
 368 {
 369    struct resource_ref *ref, **last = &scene->resources;
 370    int i;
 371
 372    /* Look at existing resource blocks:
 373     */
 374    for (ref = scene->resources; ref; ref = ref->next) {
 375       last = &ref->next;
 376
 377       /* Search for this resource:
 378        */
 379       for (i = 0; i < ref->count; i++)
 380          if (ref->resource[i] == resource)
 381             return TRUE;
 382
 383       if (ref->count < RESOURCE_REF_SZ) {
 384          /* If the block is half-empty, then append the reference here.
 385           */
 386          break;
 387       }
 388    }
 389
 390    /* Create a new block if no half-empty block was found.
 391     */
 392    if (!ref) {
 393       assert(*last == NULL);
 394       *last = lp_scene_alloc(scene, sizeof *ref);
 395       if (*last == NULL)
 396           return FALSE;
 397
 398       ref = *last;
 399       memset(ref, 0, sizeof *ref);
 400    }
 401
 402    /* Append the reference to the reference block.
 403     */
 404    pipe_resource_reference(&ref->resource[ref->count++], resource);
 405    scene->resource_reference_size += llvmpipe_resource_size(resource);
 406
 407    /* Heuristic to advise scene flushes.  This isn't helpful in the
 408     * initial setup of the scene, but after that point flush on the
 409     * next resource added which exceeds 64MB in referenced texture
 410     * data.
 411     */
 412    if (!initializing_scene &&
 413        scene->resource_reference_size >= LP_SCENE_MAX_RESOURCE_SIZE)
 414       return FALSE;
 415
 416    return TRUE;
 417 }
 418
 419
 420 /**
 421  * Does this scene have a reference to the given resource?
 422  */
 423 boolean
 424 lp_scene_is_resource_referenced(const struct lp_scene *scene,
 425                                 const struct pipe_resource *resource)
 426 {
 427    const struct resource_ref *ref;
 428    int i;
 429
 430    for (ref = scene->resources; ref; ref = ref->next) {
 431       for (i = 0; i < ref->count; i++)
 432          if (ref->resource[i] == resource)
 433             return TRUE;
 434    }
 435
 436    return FALSE;
 437 }
 438
 439
 440
 441
 442 /** advance curr_x,y to the next bin */
 443 static boolean
 444 next_bin(struct lp_scene *scene)
 445 {
 446    scene->curr_x++;
 447    if (scene->curr_x >= scene->tiles_x) {
 448       scene->curr_x = 0;
 449       scene->curr_y++;
 450    }
 451    if (scene->curr_y >= scene->tiles_y) {
 452       /* no more bins */
 453       return FALSE;
 454    }
 455    return TRUE;
 456 }
 457
 458
 459 void
 460 lp_scene_bin_iter_begin( struct lp_scene *scene )
 461 {
 462    scene->curr_x = scene->curr_y = -1;
 463 }
 464
 465
 466 /**
 467  * Return pointer to next bin to be rendered.
 468  * The lp_scene::curr_x and ::curr_y fields will be advanced.
 469  * Multiple rendering threads will call this function to get a chunk
 470  * of work (a bin) to work on.
 471  */
 472 struct cmd_bin *
 473 lp_scene_bin_iter_next( struct lp_scene *scene )
 474 {
 475    struct cmd_bin *bin = NULL;
 476
 477    pipe_mutex_lock(scene->mutex);
 478
 479    if (scene->curr_x < 0) {
 480       /* first bin */
 481       scene->curr_x = 0;
 482       scene->curr_y = 0;
 483    }
 484    else if (!next_bin(scene)) {
 485       /* no more bins left */
 486       goto end;
 487    }
 488
 489    bin = lp_scene_get_bin(scene, scene->curr_x, scene->curr_y);
 490
 491 end:
 492    /*printf("return bin %p at %d, %d\n", (void *) bin, *bin_x, *bin_y);*/
 493    pipe_mutex_unlock(scene->mutex);
 494    return bin;
 495 }
 496
 497
 498 void lp_scene_begin_binning( struct lp_scene *scene,
 499                              struct pipe_framebuffer_state *fb, boolean discard )
 500 {
 501    assert(lp_scene_is_empty(scene));
 502
 503    scene->discard = discard;
 504    util_copy_framebuffer_state(&scene->fb, fb);
 505
 506    scene->tiles_x = align(fb->width, TILE_SIZE) / TILE_SIZE;
 507    scene->tiles_y = align(fb->height, TILE_SIZE) / TILE_SIZE;
 508
 509    assert(scene->tiles_x <= TILES_X);
 510    assert(scene->tiles_y <= TILES_Y);
 511 }
 512
 513
 514 void lp_scene_end_binning( struct lp_scene *scene )
 515 {
 516    if (LP_DEBUG & DEBUG_SCENE) {
 517       debug_printf("rasterize scene:\n");
 518       debug_printf("  scene_size: %u\n",
 519                    scene->scene_size);
 520       debug_printf("  data size: %u\n",
 521                    lp_scene_data_size(scene));
 522
 523       if (0)
 524          lp_debug_bins( scene );
 525    }
 526 }