src/gallium/drivers/llvmpipe/lp_tile_cache.c

   1 /**************************************************************************
   2  *
   3  * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas.
   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 TUNGSTEN GRAPHICS 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 /**
  29  * Texture tile caching.
  30  *
  31  * Author:
  32  *    Brian Paul
  33  */
  34
  35 #include "pipe/p_inlines.h"
  36 #include "util/u_memory.h"
  37 #include "util/u_tile.h"
  38 #include "lp_context.h"
  39 #include "lp_surface.h"
  40 #include "lp_texture.h"
  41 #include "lp_tile_cache.h"
  42
  43 #define NUM_ENTRIES 50
  44
  45
  46 /** XXX move these */
  47 #define MAX_WIDTH 2048
  48 #define MAX_HEIGHT 2048
  49
  50
  51 struct llvmpipe_tile_cache
  52 {
  53    struct pipe_screen *screen;
  54    struct pipe_surface *surface;  /**< the surface we're caching */
  55    struct pipe_transfer *transfer;
  56    void *transfer_map;
  57    struct pipe_texture *texture;  /**< if caching a texture */
  58    struct llvmpipe_cached_tile entries[NUM_ENTRIES];
  59    uint clear_flags[(MAX_WIDTH / TILE_SIZE) * (MAX_HEIGHT / TILE_SIZE) / 32];
  60    float clear_color[4];  /**< for color bufs */
  61    uint clear_val;        /**< for z+stencil, or packed color clear value */
  62    boolean depth_stencil; /**< Is the surface a depth/stencil format? */
  63
  64    struct pipe_transfer *tex_trans;
  65    void *tex_trans_map;
  66    int tex_face, tex_level, tex_z;
  67
  68    struct llvmpipe_cached_tile tile;  /**< scratch tile for clears */
  69 };
  70
  71
  72 /**
  73  * Return the position in the cache for the tile that contains win pos (x,y).
  74  * We currently use a direct mapped cache so this is like a hack key.
  75  * At some point we should investige something more sophisticated, like
  76  * a LRU replacement policy.
  77  */
  78 #define CACHE_POS(x, y) \
  79    (((x) / TILE_SIZE + ((y) / TILE_SIZE) * 5) % NUM_ENTRIES)
  80
  81
  82
  83 /**
  84  * Is the tile at (x,y) in cleared state?
  85  */
  86 static INLINE uint
  87 is_clear_flag_set(const uint *bitvec, int x, int y)
  88 {
  89    int pos, bit;
  90    x /= TILE_SIZE;
  91    y /= TILE_SIZE;
  92    pos = y * (MAX_WIDTH / TILE_SIZE) + x;
  93    assert(pos / 32 < (MAX_WIDTH / TILE_SIZE) * (MAX_HEIGHT / TILE_SIZE) / 32);
  94    bit = bitvec[pos / 32] & (1 << (pos & 31));
  95    return bit;
  96 }
  97
  98
  99 /**
 100  * Mark the tile at (x,y) as not cleared.
 101  */
 102 static INLINE void
 103 clear_clear_flag(uint *bitvec, int x, int y)
 104 {
 105    int pos;
 106    x /= TILE_SIZE;
 107    y /= TILE_SIZE;
 108    pos = y * (MAX_WIDTH / TILE_SIZE) + x;
 109    assert(pos / 32 < (MAX_WIDTH / TILE_SIZE) * (MAX_HEIGHT / TILE_SIZE) / 32);
 110    bitvec[pos / 32] &= ~(1 << (pos & 31));
 111 }
 112
 113
 114 struct llvmpipe_tile_cache *
 115 lp_create_tile_cache( struct pipe_screen *screen )
 116 {
 117    struct llvmpipe_tile_cache *tc;
 118    uint pos;
 119
 120    tc = CALLOC_STRUCT( llvmpipe_tile_cache );
 121    if (tc) {
 122       tc->screen = screen;
 123       for (pos = 0; pos < NUM_ENTRIES; pos++) {
 124          tc->entries[pos].x =
 125          tc->entries[pos].y = -1;
 126       }
 127    }
 128    return tc;
 129 }
 130
 131
 132 void
 133 lp_destroy_tile_cache(struct llvmpipe_tile_cache *tc)
 134 {
 135    struct pipe_screen *screen;
 136    uint pos;
 137
 138    for (pos = 0; pos < NUM_ENTRIES; pos++) {
 139       /*assert(tc->entries[pos].x < 0);*/
 140    }
 141    if (tc->transfer) {
 142       screen = tc->transfer->texture->screen;
 143       screen->tex_transfer_destroy(tc->transfer);
 144    }
 145    if (tc->tex_trans) {
 146       screen = tc->tex_trans->texture->screen;
 147       screen->tex_transfer_destroy(tc->tex_trans);
 148    }
 149
 150    FREE( tc );
 151 }
 152
 153
 154 /**
 155  * Specify the surface to cache.
 156  */
 157 void
 158 lp_tile_cache_set_surface(struct llvmpipe_tile_cache *tc,
 159                           struct pipe_surface *ps)
 160 {
 161    assert(!tc->texture);
 162
 163    if (tc->transfer) {
 164       struct pipe_screen *screen = tc->transfer->texture->screen;
 165
 166       if (ps == tc->surface)
 167          return;
 168
 169       if (tc->transfer_map) {
 170          screen->transfer_unmap(screen, tc->transfer);
 171          tc->transfer_map = NULL;
 172       }
 173
 174       screen->tex_transfer_destroy(tc->transfer);
 175       tc->transfer = NULL;
 176    }
 177
 178    tc->surface = ps;
 179
 180    if (ps) {
 181       struct pipe_screen *screen = ps->texture->screen;
 182
 183       tc->transfer = screen->get_tex_transfer(screen, ps->texture, ps->face,
 184                                               ps->level, ps->zslice,
 185                                               PIPE_TRANSFER_READ_WRITE,
 186                                               0, 0, ps->width, ps->height);
 187
 188       tc->depth_stencil = (ps->format == PIPE_FORMAT_S8Z24_UNORM ||
 189                            ps->format == PIPE_FORMAT_X8Z24_UNORM ||
 190                            ps->format == PIPE_FORMAT_Z24S8_UNORM ||
 191                            ps->format == PIPE_FORMAT_Z24X8_UNORM ||
 192                            ps->format == PIPE_FORMAT_Z16_UNORM ||
 193                            ps->format == PIPE_FORMAT_Z32_UNORM ||
 194                            ps->format == PIPE_FORMAT_S8_UNORM);
 195    }
 196 }
 197
 198
 199 /**
 200  * Return the transfer being cached.
 201  */
 202 struct pipe_surface *
 203 lp_tile_cache_get_surface(struct llvmpipe_tile_cache *tc)
 204 {
 205    return tc->surface;
 206 }
 207
 208
 209 void
 210 lp_tile_cache_map_transfers(struct llvmpipe_tile_cache *tc)
 211 {
 212    if (tc->transfer && !tc->transfer_map)
 213       tc->transfer_map = tc->screen->transfer_map(tc->screen, tc->transfer);
 214
 215    if (tc->tex_trans && !tc->tex_trans_map)
 216       tc->tex_trans_map = tc->screen->transfer_map(tc->screen, tc->tex_trans);
 217 }
 218
 219
 220 void
 221 lp_tile_cache_unmap_transfers(struct llvmpipe_tile_cache *tc)
 222 {
 223    if (tc->transfer_map) {
 224       tc->screen->transfer_unmap(tc->screen, tc->transfer);
 225       tc->transfer_map = NULL;
 226    }
 227
 228    if (tc->tex_trans_map) {
 229       tc->screen->transfer_unmap(tc->screen, tc->tex_trans);
 230       tc->tex_trans_map = NULL;
 231    }
 232 }
 233
 234
 235 /**
 236  * Specify the texture to cache.
 237  */
 238 void
 239 lp_tile_cache_set_texture(struct pipe_context *pipe,
 240                           struct llvmpipe_tile_cache *tc,
 241                           struct pipe_texture *texture)
 242 {
 243    uint i;
 244
 245    assert(!tc->transfer);
 246
 247    pipe_texture_reference(&tc->texture, texture);
 248
 249    if (tc->tex_trans) {
 250       struct pipe_screen *screen = tc->tex_trans->texture->screen;
 251
 252       if (tc->tex_trans_map) {
 253          screen->transfer_unmap(screen, tc->tex_trans);
 254          tc->tex_trans_map = NULL;
 255       }
 256
 257       screen->tex_transfer_destroy(tc->tex_trans);
 258       tc->tex_trans = NULL;
 259    }
 260
 261    /* mark as entries as invalid/empty */
 262    /* XXX we should try to avoid this when the teximage hasn't changed */
 263    for (i = 0; i < NUM_ENTRIES; i++) {
 264       tc->entries[i].x = -1;
 265    }
 266
 267    tc->tex_face = -1; /* any invalid value here */
 268 }
 269
 270
 271 /**
 272  * Set pixels in a tile to the given clear color/value, float.
 273  */
 274 static void
 275 clear_tile_rgba(struct llvmpipe_cached_tile *tile,
 276                 enum pipe_format format,
 277                 const float clear_value[4])
 278 {
 279    if (clear_value[0] == 0.0 &&
 280        clear_value[1] == 0.0 &&
 281        clear_value[2] == 0.0 &&
 282        clear_value[3] == 0.0) {
 283       memset(tile->data.color, 0, sizeof(tile->data.color));
 284    }
 285    else {
 286       uint i, j;
 287       for (i = 0; i < TILE_SIZE; i++) {
 288          for (j = 0; j < TILE_SIZE; j++) {
 289             tile->data.color[i][j][0] = clear_value[0];
 290             tile->data.color[i][j][1] = clear_value[1];
 291             tile->data.color[i][j][2] = clear_value[2];
 292             tile->data.color[i][j][3] = clear_value[3];
 293          }
 294       }
 295    }
 296 }
 297
 298
 299 /**
 300  * Set a tile to a solid value/color.
 301  */
 302 static void
 303 clear_tile(struct llvmpipe_cached_tile *tile,
 304            enum pipe_format format,
 305            uint clear_value)
 306 {
 307    uint i, j;
 308
 309    switch (pf_get_size(format)) {
 310    case 1:
 311       memset(tile->data.any, 0, TILE_SIZE * TILE_SIZE);
 312       break;
 313    case 2:
 314       if (clear_value == 0) {
 315          memset(tile->data.any, 0, 2 * TILE_SIZE * TILE_SIZE);
 316       }
 317       else {
 318          for (i = 0; i < TILE_SIZE; i++) {
 319             for (j = 0; j < TILE_SIZE; j++) {
 320                tile->data.depth16[i][j] = (ushort) clear_value;
 321             }
 322          }
 323       }
 324       break;
 325    case 4:
 326       if (clear_value == 0) {
 327          memset(tile->data.any, 0, 4 * TILE_SIZE * TILE_SIZE);
 328       }
 329       else {
 330          for (i = 0; i < TILE_SIZE; i++) {
 331             for (j = 0; j < TILE_SIZE; j++) {
 332                tile->data.color32[i][j] = clear_value;
 333             }
 334          }
 335       }
 336       break;
 337    default:
 338       assert(0);
 339    }
 340 }
 341
 342
 343 /**
 344  * Actually clear the tiles which were flagged as being in a clear state.
 345  */
 346 static void
 347 lp_tile_cache_flush_clear(struct pipe_context *pipe,
 348                           struct llvmpipe_tile_cache *tc)
 349 {
 350    struct pipe_transfer *pt = tc->transfer;
 351    const uint w = tc->transfer->width;
 352    const uint h = tc->transfer->height;
 353    uint x, y;
 354    uint numCleared = 0;
 355
 356    /* clear the scratch tile to the clear value */
 357    clear_tile(&tc->tile, pt->format, tc->clear_val);
 358
 359    /* push the tile to all positions marked as clear */
 360    for (y = 0; y < h; y += TILE_SIZE) {
 361       for (x = 0; x < w; x += TILE_SIZE) {
 362          if (is_clear_flag_set(tc->clear_flags, x, y)) {
 363             pipe_put_tile_raw(pt,
 364                               x, y, TILE_SIZE, TILE_SIZE,
 365                               tc->tile.data.color32, 0/*STRIDE*/);
 366
 367             /* do this? */
 368             clear_clear_flag(tc->clear_flags, x, y);
 369
 370             numCleared++;
 371          }
 372       }
 373    }
 374 #if 0
 375    debug_printf("num cleared: %u\n", numCleared);
 376 #endif
 377 }
 378
 379
 380 /**
 381  * Flush the tile cache: write all dirty tiles back to the transfer.
 382  * any tiles "flagged" as cleared will be "really" cleared.
 383  */
 384 void
 385 lp_flush_tile_cache(struct llvmpipe_context *llvmpipe,
 386                     struct llvmpipe_tile_cache *tc)
 387 {
 388    struct pipe_transfer *pt = tc->transfer;
 389    int inuse = 0, pos;
 390
 391    if (pt) {
 392       /* caching a drawing transfer */
 393       for (pos = 0; pos < NUM_ENTRIES; pos++) {
 394          struct llvmpipe_cached_tile *tile = tc->entries + pos;
 395          if (tile->x >= 0) {
 396             if (tc->depth_stencil) {
 397                pipe_put_tile_raw(pt,
 398                                  tile->x, tile->y, TILE_SIZE, TILE_SIZE,
 399                                  tile->data.depth32, 0/*STRIDE*/);
 400             }
 401             else {
 402                pipe_put_tile_rgba(pt,
 403                                   tile->x, tile->y, TILE_SIZE, TILE_SIZE,
 404                                   (float *) tile->data.color);
 405             }
 406             tile->x = tile->y = -1;  /* mark as empty */
 407             inuse++;
 408          }
 409       }
 410
 411 #if TILE_CLEAR_OPTIMIZATION
 412       lp_tile_cache_flush_clear(&llvmpipe->pipe, tc);
 413 #endif
 414    }
 415    else if (tc->texture) {
 416       /* caching a texture, mark all entries as empty */
 417       for (pos = 0; pos < NUM_ENTRIES; pos++) {
 418          tc->entries[pos].x = -1;
 419       }
 420       tc->tex_face = -1;
 421    }
 422
 423 #if 0
 424    debug_printf("flushed tiles in use: %d\n", inuse);
 425 #endif
 426 }
 427
 428
 429 /**
 430  * Get a tile from the cache.
 431  * \param x, y  position of tile, in pixels
 432  */
 433 struct llvmpipe_cached_tile *
 434 lp_get_cached_tile(struct llvmpipe_context *llvmpipe,
 435                    struct llvmpipe_tile_cache *tc, int x, int y)
 436 {
 437    struct pipe_transfer *pt = tc->transfer;
 438
 439    /* tile pos in framebuffer: */
 440    const int tile_x = x & ~(TILE_SIZE - 1);
 441    const int tile_y = y & ~(TILE_SIZE - 1);
 442
 443    /* cache pos/entry: */
 444    const int pos = CACHE_POS(x, y);
 445    struct llvmpipe_cached_tile *tile = tc->entries + pos;
 446
 447    if (tile_x != tile->x ||
 448        tile_y != tile->y) {
 449
 450       if (tile->x != -1) {
 451          /* put dirty tile back in framebuffer */
 452          if (tc->depth_stencil) {
 453             pipe_put_tile_raw(pt,
 454                               tile->x, tile->y, TILE_SIZE, TILE_SIZE,
 455                               tile->data.depth32, 0/*STRIDE*/);
 456          }
 457          else {
 458             pipe_put_tile_rgba(pt,
 459                                tile->x, tile->y, TILE_SIZE, TILE_SIZE,
 460                                (float *) tile->data.color);
 461          }
 462       }
 463
 464       tile->x = tile_x;
 465       tile->y = tile_y;
 466
 467       if (is_clear_flag_set(tc->clear_flags, x, y)) {
 468          /* don't get tile from framebuffer, just clear it */
 469          if (tc->depth_stencil) {
 470             clear_tile(tile, pt->format, tc->clear_val);
 471          }
 472          else {
 473             clear_tile_rgba(tile, pt->format, tc->clear_color);
 474          }
 475          clear_clear_flag(tc->clear_flags, x, y);
 476       }
 477       else {
 478          /* get new tile data from transfer */
 479          if (tc->depth_stencil) {
 480             pipe_get_tile_raw(pt,
 481                               tile->x, tile->y, TILE_SIZE, TILE_SIZE,
 482                               tile->data.depth32, 0/*STRIDE*/);
 483          }
 484          else {
 485             pipe_get_tile_rgba(pt,
 486                                tile->x, tile->y, TILE_SIZE, TILE_SIZE,
 487                                (float *) tile->data.color);
 488          }
 489       }
 490    }
 491
 492    return tile;
 493 }
 494
 495
 496 /**
 497  * Given the texture face, level, zslice, x and y values, compute
 498  * the cache entry position/index where we'd hope to find the
 499  * cached texture tile.
 500  * This is basically a direct-map cache.
 501  * XXX There's probably lots of ways in which we can improve this.
 502  */
 503 static INLINE uint
 504 tex_cache_pos(int x, int y, int z, int face, int level)
 505 {
 506    uint entry = x + y * 9 + z * 3 + face + level * 7;
 507    return entry % NUM_ENTRIES;
 508 }
 509
 510
 511 /**
 512  * Similar to lp_get_cached_tile() but for textures.
 513  * Tiles are read-only and indexed with more params.
 514  */
 515 const struct llvmpipe_cached_tile *
 516 lp_get_cached_tile_tex(struct llvmpipe_context *lp,
 517                        struct llvmpipe_tile_cache *tc, int x, int y, int z,
 518                        int face, int level)
 519 {
 520    struct pipe_screen *screen = lp->pipe.screen;
 521    /* tile pos in framebuffer: */
 522    const int tile_x = x & ~(TILE_SIZE - 1);
 523    const int tile_y = y & ~(TILE_SIZE - 1);
 524    /* cache pos/entry: */
 525    const uint pos = tex_cache_pos(x / TILE_SIZE, y / TILE_SIZE, z,
 526                                   face, level);
 527    struct llvmpipe_cached_tile *tile = tc->entries + pos;
 528
 529    if (tc->texture) {
 530       struct llvmpipe_texture *lpt = llvmpipe_texture(tc->texture);
 531       if (lpt->modified) {
 532          /* texture was modified, invalidate all cached tiles */
 533          uint p;
 534          for (p = 0; p < NUM_ENTRIES; p++) {
 535             tile = tc->entries + p;
 536             tile->x = -1;
 537          }
 538          lpt->modified = FALSE;
 539       }
 540    }
 541
 542    if (tile_x != tile->x ||
 543        tile_y != tile->y ||
 544        z != tile->z ||
 545        face != tile->face ||
 546        level != tile->level) {
 547       /* cache miss */
 548
 549 #if 0
 550       printf("miss at %u  x=%d y=%d z=%d face=%d level=%d\n", pos,
 551              x/TILE_SIZE, y/TILE_SIZE, z, face, level);
 552 #endif
 553       /* check if we need to get a new transfer */
 554       if (!tc->tex_trans ||
 555           tc->tex_face != face ||
 556           tc->tex_level != level ||
 557           tc->tex_z != z) {
 558          /* get new transfer (view into texture) */
 559
 560          if (tc->tex_trans) {
 561             if (tc->tex_trans_map) {
 562                tc->screen->transfer_unmap(tc->screen, tc->tex_trans);
 563                tc->tex_trans_map = NULL;
 564             }
 565
 566             screen->tex_transfer_destroy(tc->tex_trans);
 567             tc->tex_trans = NULL;
 568          }
 569
 570          tc->tex_trans = screen->get_tex_transfer(screen, tc->texture, face, level, z,
 571                                                   PIPE_TRANSFER_READ, 0, 0,
 572                                                   tc->texture->width[level],
 573                                                   tc->texture->height[level]);
 574          tc->tex_trans_map = screen->transfer_map(screen, tc->tex_trans);
 575
 576          tc->tex_face = face;
 577          tc->tex_level = level;
 578          tc->tex_z = z;
 579       }
 580
 581       /* get tile from the transfer (view into texture) */
 582       pipe_get_tile_rgba(tc->tex_trans,
 583                          tile_x, tile_y, TILE_SIZE, TILE_SIZE,
 584                          (float *) tile->data.color);
 585       tile->x = tile_x;
 586       tile->y = tile_y;
 587       tile->z = z;
 588       tile->face = face;
 589       tile->level = level;
 590    }
 591
 592    return tile;
 593 }
 594
 595
 596 /**
 597  * When a whole surface is being cleared to a value we can avoid
 598  * fetching tiles above.
 599  * Save the color and set a 'clearflag' for each tile of the screen.
 600  */
 601 void
 602 lp_tile_cache_clear(struct llvmpipe_tile_cache *tc, const float *rgba,
 603                     uint clearValue)
 604 {
 605    uint pos;
 606
 607    tc->clear_color[0] = rgba[0];
 608    tc->clear_color[1] = rgba[1];
 609    tc->clear_color[2] = rgba[2];
 610    tc->clear_color[3] = rgba[3];
 611
 612    tc->clear_val = clearValue;
 613
 614 #if TILE_CLEAR_OPTIMIZATION
 615    /* set flags to indicate all the tiles are cleared */
 616    memset(tc->clear_flags, 255, sizeof(tc->clear_flags));
 617 #else
 618    /* disable the optimization */
 619    memset(tc->clear_flags, 0, sizeof(tc->clear_flags));
 620 #endif
 621
 622    for (pos = 0; pos < NUM_ENTRIES; pos++) {
 623       struct llvmpipe_cached_tile *tile = tc->entries + pos;
 624       tile->x = tile->y = -1;
 625    }
 626 }