1 /**************************************************************************
3 * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas.
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:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
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.
26 **************************************************************************/
29 * Texture tile caching.
35 #include "pipe/p_inlines.h"
36 #include "util/u_memory.h"
37 #include "util/u_tile.h"
38 #include "sp_context.h"
39 #include "sp_surface.h"
40 #include "sp_texture.h"
41 #include "sp_tile_cache.h"
43 #define NUM_ENTRIES 50
47 #define MAX_WIDTH 4096
48 #define MAX_HEIGHT 4096
51 struct softpipe_tile_cache
53 struct pipe_screen
*screen
;
54 struct pipe_surface
*surface
; /**< the surface we're caching */
55 struct pipe_transfer
*transfer
;
57 struct pipe_texture
*texture
; /**< if caching a texture */
58 struct softpipe_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? */
64 struct pipe_transfer
*tex_trans
;
66 int tex_face
, tex_level
, tex_z
;
68 struct softpipe_cached_tile tile
; /**< scratch tile for clears */
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.
78 #define CACHE_POS(x, y) \
79 (((x) / TILE_SIZE + ((y) / TILE_SIZE) * 5) % NUM_ENTRIES)
84 * Is the tile at (x,y) in cleared state?
87 is_clear_flag_set(const uint
*bitvec
, int x
, int y
)
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));
100 * Mark the tile at (x,y) as not cleared.
103 clear_clear_flag(uint
*bitvec
, int x
, int y
)
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));
114 struct softpipe_tile_cache
*
115 sp_create_tile_cache( struct pipe_screen
*screen
)
117 struct softpipe_tile_cache
*tc
;
120 tc
= CALLOC_STRUCT( softpipe_tile_cache
);
123 for (pos
= 0; pos
< NUM_ENTRIES
; pos
++) {
125 tc
->entries
[pos
].y
= -1;
133 sp_destroy_tile_cache(struct softpipe_tile_cache
*tc
)
135 struct pipe_screen
*screen
;
138 for (pos
= 0; pos
< NUM_ENTRIES
; pos
++) {
139 /*assert(tc->entries[pos].x < 0);*/
142 screen
= tc
->transfer
->texture
->screen
;
143 screen
->tex_transfer_destroy(tc
->transfer
);
146 screen
= tc
->tex_trans
->texture
->screen
;
147 screen
->tex_transfer_destroy(tc
->tex_trans
);
155 * Specify the surface to cache.
158 sp_tile_cache_set_surface(struct softpipe_tile_cache
*tc
,
159 struct pipe_surface
*ps
)
161 assert(!tc
->texture
);
164 struct pipe_screen
*screen
= tc
->transfer
->texture
->screen
;
166 if (ps
== tc
->surface
)
169 if (tc
->transfer_map
) {
170 screen
->transfer_unmap(screen
, tc
->transfer
);
171 tc
->transfer_map
= NULL
;
174 screen
->tex_transfer_destroy(tc
->transfer
);
181 struct pipe_screen
*screen
= ps
->texture
->screen
;
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
);
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
);
200 * Return the transfer being cached.
202 struct pipe_surface
*
203 sp_tile_cache_get_surface(struct softpipe_tile_cache
*tc
)
210 sp_tile_cache_map_transfers(struct softpipe_tile_cache
*tc
)
212 if (tc
->transfer
&& !tc
->transfer_map
)
213 tc
->transfer_map
= tc
->screen
->transfer_map(tc
->screen
, tc
->transfer
);
215 if (tc
->tex_trans
&& !tc
->tex_trans_map
)
216 tc
->tex_trans_map
= tc
->screen
->transfer_map(tc
->screen
, tc
->tex_trans
);
221 sp_tile_cache_unmap_transfers(struct softpipe_tile_cache
*tc
)
223 if (tc
->transfer_map
) {
224 tc
->screen
->transfer_unmap(tc
->screen
, tc
->transfer
);
225 tc
->transfer_map
= NULL
;
228 if (tc
->tex_trans_map
) {
229 tc
->screen
->transfer_unmap(tc
->screen
, tc
->tex_trans
);
230 tc
->tex_trans_map
= NULL
;
236 * Specify the texture to cache.
239 sp_tile_cache_set_texture(struct pipe_context
*pipe
,
240 struct softpipe_tile_cache
*tc
,
241 struct pipe_texture
*texture
)
245 assert(!tc
->transfer
);
247 pipe_texture_reference(&tc
->texture
, texture
);
250 struct pipe_screen
*screen
= tc
->tex_trans
->texture
->screen
;
252 if (tc
->tex_trans_map
) {
253 screen
->transfer_unmap(screen
, tc
->tex_trans
);
254 tc
->tex_trans_map
= NULL
;
257 screen
->tex_transfer_destroy(tc
->tex_trans
);
258 tc
->tex_trans
= NULL
;
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;
267 tc
->tex_face
= -1; /* any invalid value here */
272 * Set pixels in a tile to the given clear color/value, float.
275 clear_tile_rgba(struct softpipe_cached_tile
*tile
,
276 enum pipe_format format
,
277 const float clear_value
[4])
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
));
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];
300 * Set a tile to a solid value/color.
303 clear_tile(struct softpipe_cached_tile
*tile
,
304 enum pipe_format format
,
309 switch (pf_get_size(format
)) {
311 memset(tile
->data
.any
, 0, TILE_SIZE
* TILE_SIZE
);
314 if (clear_value
== 0) {
315 memset(tile
->data
.any
, 0, 2 * TILE_SIZE
* TILE_SIZE
);
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
;
326 if (clear_value
== 0) {
327 memset(tile
->data
.any
, 0, 4 * TILE_SIZE
* TILE_SIZE
);
330 for (i
= 0; i
< TILE_SIZE
; i
++) {
331 for (j
= 0; j
< TILE_SIZE
; j
++) {
332 tile
->data
.color32
[i
][j
] = clear_value
;
344 * Actually clear the tiles which were flagged as being in a clear state.
347 sp_tile_cache_flush_clear(struct pipe_context
*pipe
,
348 struct softpipe_tile_cache
*tc
)
350 struct pipe_transfer
*pt
= tc
->transfer
;
351 const uint w
= tc
->transfer
->width
;
352 const uint h
= tc
->transfer
->height
;
356 /* clear the scratch tile to the clear value */
357 clear_tile(&tc
->tile
, pt
->format
, tc
->clear_val
);
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*/);
368 clear_clear_flag(tc
->clear_flags
, x
, y
);
375 debug_printf("num cleared: %u\n", numCleared
);
381 * Flush the tile cache: write all dirty tiles back to the transfer.
382 * any tiles "flagged" as cleared will be "really" cleared.
385 sp_flush_tile_cache(struct softpipe_context
*softpipe
,
386 struct softpipe_tile_cache
*tc
)
388 struct pipe_transfer
*pt
= tc
->transfer
;
392 /* caching a drawing transfer */
393 for (pos
= 0; pos
< NUM_ENTRIES
; pos
++) {
394 struct softpipe_cached_tile
*tile
= tc
->entries
+ pos
;
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*/);
402 pipe_put_tile_rgba(pt
,
403 tile
->x
, tile
->y
, TILE_SIZE
, TILE_SIZE
,
404 (float *) tile
->data
.color
);
406 tile
->x
= tile
->y
= -1; /* mark as empty */
411 #if TILE_CLEAR_OPTIMIZATION
412 sp_tile_cache_flush_clear(&softpipe
->pipe
, tc
);
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;
424 debug_printf("flushed tiles in use: %d\n", inuse
);
430 * Get a tile from the cache.
431 * \param x, y position of tile, in pixels
433 struct softpipe_cached_tile
*
434 sp_get_cached_tile(struct softpipe_context
*softpipe
,
435 struct softpipe_tile_cache
*tc
, int x
, int y
)
437 struct pipe_transfer
*pt
= tc
->transfer
;
439 /* tile pos in framebuffer: */
440 const int tile_x
= x
& ~(TILE_SIZE
- 1);
441 const int tile_y
= y
& ~(TILE_SIZE
- 1);
443 /* cache pos/entry: */
444 const int pos
= CACHE_POS(x
, y
);
445 struct softpipe_cached_tile
*tile
= tc
->entries
+ pos
;
447 if (tile_x
!= tile
->x
||
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*/);
458 pipe_put_tile_rgba(pt
,
459 tile
->x
, tile
->y
, TILE_SIZE
, TILE_SIZE
,
460 (float *) tile
->data
.color
);
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
);
473 clear_tile_rgba(tile
, pt
->format
, tc
->clear_color
);
475 clear_clear_flag(tc
->clear_flags
, x
, y
);
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*/);
485 pipe_get_tile_rgba(pt
,
486 tile
->x
, tile
->y
, TILE_SIZE
, TILE_SIZE
,
487 (float *) tile
->data
.color
);
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.
504 tex_cache_pos(int x
, int y
, int z
, int face
, int level
)
506 uint entry
= x
+ y
* 9 + z
* 3 + face
+ level
* 7;
507 return entry
% NUM_ENTRIES
;
512 * Similar to sp_get_cached_tile() but for textures.
513 * Tiles are read-only and indexed with more params.
515 const struct softpipe_cached_tile
*
516 sp_get_cached_tile_tex(struct softpipe_context
*sp
,
517 struct softpipe_tile_cache
*tc
, int x
, int y
, int z
,
520 struct pipe_screen
*screen
= sp
->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
,
527 struct softpipe_cached_tile
*tile
= tc
->entries
+ pos
;
530 struct softpipe_texture
*spt
= softpipe_texture(tc
->texture
);
532 /* texture was modified, invalidate all cached tiles */
534 for (p
= 0; p
< NUM_ENTRIES
; p
++) {
535 tile
= tc
->entries
+ p
;
538 spt
->modified
= FALSE
;
542 if (tile_x
!= tile
->x
||
545 face
!= tile
->face
||
546 level
!= tile
->level
) {
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
);
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
||
558 /* get new transfer (view into texture) */
561 if (tc
->tex_trans_map
) {
562 tc
->screen
->transfer_unmap(tc
->screen
, tc
->tex_trans
);
563 tc
->tex_trans_map
= NULL
;
566 screen
->tex_transfer_destroy(tc
->tex_trans
);
567 tc
->tex_trans
= NULL
;
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
);
577 tc
->tex_level
= level
;
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
);
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.
602 sp_tile_cache_clear(struct softpipe_tile_cache
*tc
, const float *rgba
,
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];
612 tc
->clear_val
= clearValue
;
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
));
618 /* disable the optimization */
619 memset(tc
->clear_flags
, 0, sizeof(tc
->clear_flags
));
622 for (pos
= 0; pos
< NUM_ENTRIES
; pos
++) {
623 struct softpipe_cached_tile
*tile
= tc
->entries
+ pos
;
624 tile
->x
= tile
->y
= -1;