1 /**************************************************************************
3 * Copyright 2007 VMware, Inc.
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 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.
26 **************************************************************************/
29 * Render target tile caching.
35 #include "util/u_inlines.h"
36 #include "util/u_format.h"
37 #include "util/u_memory.h"
38 #include "util/u_tile.h"
39 #include "sp_tile_cache.h"
41 static struct softpipe_cached_tile
*
42 sp_alloc_tile(struct softpipe_tile_cache
*tc
);
46 * Return the position in the cache for the tile that contains win pos (x,y).
47 * We currently use a direct mapped cache so this is like a hack key.
48 * At some point we should investige something more sophisticated, like
49 * a LRU replacement policy.
51 #define CACHE_POS(x, y, l) \
52 (((x) + (y) * 5 + (l) * 10) % NUM_ENTRIES)
55 static inline int addr_to_clear_pos(union tile_address addr
)
58 pos
= addr
.bits
.layer
* (MAX_WIDTH
/ TILE_SIZE
) * (MAX_HEIGHT
/ TILE_SIZE
);
59 pos
+= addr
.bits
.y
* (MAX_WIDTH
/ TILE_SIZE
);
64 * Is the tile at (x,y) in cleared state?
67 is_clear_flag_set(const uint
*bitvec
, union tile_address addr
, unsigned max
)
70 pos
= addr_to_clear_pos(addr
);
71 assert(pos
/ 32 < max
);
72 bit
= bitvec
[pos
/ 32] & (1 << (pos
& 31));
78 * Mark the tile at (x,y) as not cleared.
81 clear_clear_flag(uint
*bitvec
, union tile_address addr
, unsigned max
)
84 pos
= addr_to_clear_pos(addr
);
85 assert(pos
/ 32 < max
);
86 bitvec
[pos
/ 32] &= ~(1 << (pos
& 31));
90 struct softpipe_tile_cache
*
91 sp_create_tile_cache( struct pipe_context
*pipe
)
93 struct softpipe_tile_cache
*tc
;
95 int maxLevels
, maxTexSize
;
97 /* sanity checking: max sure MAX_WIDTH/HEIGHT >= largest texture image */
98 maxLevels
= pipe
->screen
->get_param(pipe
->screen
, PIPE_CAP_MAX_TEXTURE_2D_LEVELS
);
99 maxTexSize
= 1 << (maxLevels
- 1);
100 assert(MAX_WIDTH
>= maxTexSize
);
102 assert(sizeof(union tile_address
) == 4);
104 assert((TILE_SIZE
<< TILE_ADDR_BITS
) >= MAX_WIDTH
);
106 tc
= CALLOC_STRUCT( softpipe_tile_cache
);
109 for (pos
= 0; pos
< Elements(tc
->tile_addrs
); pos
++) {
110 tc
->tile_addrs
[pos
].bits
.invalid
= 1;
112 tc
->last_tile_addr
.bits
.invalid
= 1;
114 /* this allocation allows us to guarantee that allocation
115 * failures are never fatal later
117 tc
->tile
= MALLOC_STRUCT( softpipe_cached_tile
);
124 /* XXX this code prevents valgrind warnings about use of uninitialized
125 * memory in programs that don't clear the surface before rendering.
126 * However, it breaks clearing in other situations (such as in
127 * progs/tests/drawbuffers, see bug 24402).
130 /* set flags to indicate all the tiles are cleared */
131 memset(tc
->clear_flags
, 255, sizeof(tc
->clear_flags
));
139 sp_destroy_tile_cache(struct softpipe_tile_cache
*tc
)
144 for (pos
= 0; pos
< Elements(tc
->entries
); pos
++) {
145 /*assert(tc->entries[pos].x < 0);*/
146 FREE( tc
->entries
[pos
] );
152 for (i
= 0; i
< tc
->num_maps
; i
++)
153 if (tc
->transfer
[i
]) {
154 tc
->pipe
->transfer_unmap(tc
->pipe
, tc
->transfer
[i
]);
157 FREE(tc
->transfer_map
);
158 FREE(tc
->clear_flags
);
167 * Specify the surface to cache.
170 sp_tile_cache_set_surface(struct softpipe_tile_cache
*tc
,
171 struct pipe_surface
*ps
)
173 struct pipe_context
*pipe
= tc
->pipe
;
177 if (ps
== tc
->surface
)
180 for (i
= 0; i
< tc
->num_maps
; i
++) {
181 pipe
->transfer_unmap(pipe
, tc
->transfer
[i
]);
182 tc
->transfer
[i
] = NULL
;
183 tc
->transfer_map
[i
] = NULL
;
186 FREE(tc
->transfer_map
);
189 FREE(tc
->clear_flags
);
190 tc
->clear_flags_size
= 0;
196 tc
->num_maps
= ps
->u
.tex
.last_layer
- ps
->u
.tex
.first_layer
+ 1;
197 tc
->transfer
= CALLOC(tc
->num_maps
, sizeof(struct pipe_transfer
*));
198 tc
->transfer_map
= CALLOC(tc
->num_maps
, sizeof(void *));
200 tc
->clear_flags_size
= (MAX_WIDTH
/ TILE_SIZE
) * (MAX_HEIGHT
/ TILE_SIZE
) * tc
->num_maps
/ 32 * sizeof(uint
);
201 tc
->clear_flags
= CALLOC(1, tc
->clear_flags_size
);
203 if (ps
->texture
->target
!= PIPE_BUFFER
) {
204 for (i
= 0; i
< tc
->num_maps
; i
++) {
205 tc
->transfer_map
[i
] = pipe_transfer_map(pipe
, ps
->texture
,
206 ps
->u
.tex
.level
, ps
->u
.tex
.first_layer
+ i
,
207 PIPE_TRANSFER_READ_WRITE
|
208 PIPE_TRANSFER_UNSYNCHRONIZED
,
209 0, 0, ps
->width
, ps
->height
,
214 /* can't render to buffers */
218 tc
->depth_stencil
= util_format_is_depth_or_stencil(ps
->format
);
224 * Return the transfer being cached.
226 struct pipe_surface
*
227 sp_tile_cache_get_surface(struct softpipe_tile_cache
*tc
)
234 * Set pixels in a tile to the given clear color/value, float.
237 clear_tile_rgba(struct softpipe_cached_tile
*tile
,
238 enum pipe_format format
,
239 const union pipe_color_union
*clear_value
)
241 if (clear_value
->f
[0] == 0.0 &&
242 clear_value
->f
[1] == 0.0 &&
243 clear_value
->f
[2] == 0.0 &&
244 clear_value
->f
[3] == 0.0) {
245 memset(tile
->data
.color
, 0, sizeof(tile
->data
.color
));
250 if (util_format_is_pure_uint(format
)) {
251 for (i
= 0; i
< TILE_SIZE
; i
++) {
252 for (j
= 0; j
< TILE_SIZE
; j
++) {
253 tile
->data
.colorui128
[i
][j
][0] = clear_value
->ui
[0];
254 tile
->data
.colorui128
[i
][j
][1] = clear_value
->ui
[1];
255 tile
->data
.colorui128
[i
][j
][2] = clear_value
->ui
[2];
256 tile
->data
.colorui128
[i
][j
][3] = clear_value
->ui
[3];
259 } else if (util_format_is_pure_sint(format
)) {
260 for (i
= 0; i
< TILE_SIZE
; i
++) {
261 for (j
= 0; j
< TILE_SIZE
; j
++) {
262 tile
->data
.colori128
[i
][j
][0] = clear_value
->i
[0];
263 tile
->data
.colori128
[i
][j
][1] = clear_value
->i
[1];
264 tile
->data
.colori128
[i
][j
][2] = clear_value
->i
[2];
265 tile
->data
.colori128
[i
][j
][3] = clear_value
->i
[3];
269 for (i
= 0; i
< TILE_SIZE
; i
++) {
270 for (j
= 0; j
< TILE_SIZE
; j
++) {
271 tile
->data
.color
[i
][j
][0] = clear_value
->f
[0];
272 tile
->data
.color
[i
][j
][1] = clear_value
->f
[1];
273 tile
->data
.color
[i
][j
][2] = clear_value
->f
[2];
274 tile
->data
.color
[i
][j
][3] = clear_value
->f
[3];
283 * Set a tile to a solid value/color.
286 clear_tile(struct softpipe_cached_tile
*tile
,
287 enum pipe_format format
,
288 uint64_t clear_value
)
292 switch (util_format_get_blocksize(format
)) {
294 memset(tile
->data
.any
, (int) clear_value
, TILE_SIZE
* TILE_SIZE
);
297 if (clear_value
== 0) {
298 memset(tile
->data
.any
, 0, 2 * TILE_SIZE
* TILE_SIZE
);
301 for (i
= 0; i
< TILE_SIZE
; i
++) {
302 for (j
= 0; j
< TILE_SIZE
; j
++) {
303 tile
->data
.depth16
[i
][j
] = (ushort
) clear_value
;
309 if (clear_value
== 0) {
310 memset(tile
->data
.any
, 0, 4 * TILE_SIZE
* TILE_SIZE
);
313 for (i
= 0; i
< TILE_SIZE
; i
++) {
314 for (j
= 0; j
< TILE_SIZE
; j
++) {
315 tile
->data
.depth32
[i
][j
] = (uint
) clear_value
;
321 if (clear_value
== 0) {
322 memset(tile
->data
.any
, 0, 8 * TILE_SIZE
* TILE_SIZE
);
325 for (i
= 0; i
< TILE_SIZE
; i
++) {
326 for (j
= 0; j
< TILE_SIZE
; j
++) {
327 tile
->data
.depth64
[i
][j
] = clear_value
;
339 * Actually clear the tiles which were flagged as being in a clear state.
342 sp_tile_cache_flush_clear(struct softpipe_tile_cache
*tc
, int layer
)
344 struct pipe_transfer
*pt
= tc
->transfer
[layer
];
345 const uint w
= tc
->transfer
[layer
]->box
.width
;
346 const uint h
= tc
->transfer
[layer
]->box
.height
;
350 assert(pt
->resource
);
352 /* clear the scratch tile to the clear value */
353 if (tc
->depth_stencil
) {
354 clear_tile(tc
->tile
, pt
->resource
->format
, tc
->clear_val
);
356 clear_tile_rgba(tc
->tile
, pt
->resource
->format
, &tc
->clear_color
);
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 union tile_address addr
= tile_address(x
, y
, layer
);
364 if (is_clear_flag_set(tc
->clear_flags
, addr
, tc
->clear_flags_size
)) {
365 /* write the scratch tile to the surface */
366 if (tc
->depth_stencil
) {
367 pipe_put_tile_raw(pt
, tc
->transfer_map
[layer
],
368 x
, y
, TILE_SIZE
, TILE_SIZE
,
369 tc
->tile
->data
.any
, 0/*STRIDE*/);
372 if (util_format_is_pure_uint(tc
->surface
->format
)) {
373 pipe_put_tile_ui_format(pt
, tc
->transfer_map
[layer
],
374 x
, y
, TILE_SIZE
, TILE_SIZE
,
375 pt
->resource
->format
,
376 (unsigned *) tc
->tile
->data
.colorui128
);
377 } else if (util_format_is_pure_sint(tc
->surface
->format
)) {
378 pipe_put_tile_i_format(pt
, tc
->transfer_map
[layer
],
379 x
, y
, TILE_SIZE
, TILE_SIZE
,
380 pt
->resource
->format
,
381 (int *) tc
->tile
->data
.colori128
);
383 pipe_put_tile_rgba(pt
, tc
->transfer_map
[layer
],
384 x
, y
, TILE_SIZE
, TILE_SIZE
,
385 (float *) tc
->tile
->data
.color
);
395 debug_printf("num cleared: %u\n", numCleared
);
400 sp_flush_tile(struct softpipe_tile_cache
* tc
, unsigned pos
)
402 int layer
= tc
->tile_addrs
[pos
].bits
.layer
;
403 if (!tc
->tile_addrs
[pos
].bits
.invalid
) {
404 if (tc
->depth_stencil
) {
405 pipe_put_tile_raw(tc
->transfer
[layer
], tc
->transfer_map
[layer
],
406 tc
->tile_addrs
[pos
].bits
.x
* TILE_SIZE
,
407 tc
->tile_addrs
[pos
].bits
.y
* TILE_SIZE
,
408 TILE_SIZE
, TILE_SIZE
,
409 tc
->entries
[pos
]->data
.depth32
, 0/*STRIDE*/);
412 if (util_format_is_pure_uint(tc
->surface
->format
)) {
413 pipe_put_tile_ui_format(tc
->transfer
[layer
], tc
->transfer_map
[layer
],
414 tc
->tile_addrs
[pos
].bits
.x
* TILE_SIZE
,
415 tc
->tile_addrs
[pos
].bits
.y
* TILE_SIZE
,
416 TILE_SIZE
, TILE_SIZE
,
418 (unsigned *) tc
->entries
[pos
]->data
.colorui128
);
419 } else if (util_format_is_pure_sint(tc
->surface
->format
)) {
420 pipe_put_tile_i_format(tc
->transfer
[layer
], tc
->transfer_map
[layer
],
421 tc
->tile_addrs
[pos
].bits
.x
* TILE_SIZE
,
422 tc
->tile_addrs
[pos
].bits
.y
* TILE_SIZE
,
423 TILE_SIZE
, TILE_SIZE
,
425 (int *) tc
->entries
[pos
]->data
.colori128
);
427 pipe_put_tile_rgba_format(tc
->transfer
[layer
], tc
->transfer_map
[layer
],
428 tc
->tile_addrs
[pos
].bits
.x
* TILE_SIZE
,
429 tc
->tile_addrs
[pos
].bits
.y
* TILE_SIZE
,
430 TILE_SIZE
, TILE_SIZE
,
432 (float *) tc
->entries
[pos
]->data
.color
);
435 tc
->tile_addrs
[pos
].bits
.invalid
= 1; /* mark as empty */
440 * Flush the tile cache: write all dirty tiles back to the transfer.
441 * any tiles "flagged" as cleared will be "really" cleared.
444 sp_flush_tile_cache(struct softpipe_tile_cache
*tc
)
449 /* caching a drawing transfer */
450 for (pos
= 0; pos
< Elements(tc
->entries
); pos
++) {
451 struct softpipe_cached_tile
*tile
= tc
->entries
[pos
];
454 assert(tc
->tile_addrs
[pos
].bits
.invalid
);
457 sp_flush_tile(tc
, pos
);
462 tc
->tile
= sp_alloc_tile(tc
);
464 for (i
= 0; i
< tc
->num_maps
; i
++)
465 sp_tile_cache_flush_clear(tc
, i
);
466 /* reset all clear flags to zero */
467 memset(tc
->clear_flags
, 0, tc
->clear_flags_size
);
469 tc
->last_tile_addr
.bits
.invalid
= 1;
473 debug_printf("flushed tiles in use: %d\n", inuse
);
477 static struct softpipe_cached_tile
*
478 sp_alloc_tile(struct softpipe_tile_cache
*tc
)
480 struct softpipe_cached_tile
* tile
= MALLOC_STRUCT(softpipe_cached_tile
);
483 /* in this case, steal an existing tile */
487 for (pos
= 0; pos
< Elements(tc
->entries
); ++pos
) {
488 if (!tc
->entries
[pos
])
491 sp_flush_tile(tc
, pos
);
492 tc
->tile
= tc
->entries
[pos
];
493 tc
->entries
[pos
] = NULL
;
497 /* this should never happen */
505 tc
->last_tile_addr
.bits
.invalid
= 1;
511 * Get a tile from the cache.
512 * \param x, y position of tile, in pixels
514 struct softpipe_cached_tile
*
515 sp_find_cached_tile(struct softpipe_tile_cache
*tc
,
516 union tile_address addr
)
518 struct pipe_transfer
*pt
;
519 /* cache pos/entry: */
520 const int pos
= CACHE_POS(addr
.bits
.x
,
521 addr
.bits
.y
, addr
.bits
.layer
);
522 struct softpipe_cached_tile
*tile
= tc
->entries
[pos
];
525 tile
= sp_alloc_tile(tc
);
526 tc
->entries
[pos
] = tile
;
529 if (addr
.value
!= tc
->tile_addrs
[pos
].value
) {
531 layer
= tc
->tile_addrs
[pos
].bits
.layer
;
532 if (tc
->tile_addrs
[pos
].bits
.invalid
== 0) {
533 /* put dirty tile back in framebuffer */
534 if (tc
->depth_stencil
) {
535 pipe_put_tile_raw(tc
->transfer
[layer
], tc
->transfer_map
[layer
],
536 tc
->tile_addrs
[pos
].bits
.x
* TILE_SIZE
,
537 tc
->tile_addrs
[pos
].bits
.y
* TILE_SIZE
,
538 TILE_SIZE
, TILE_SIZE
,
539 tile
->data
.depth32
, 0/*STRIDE*/);
542 if (util_format_is_pure_uint(tc
->surface
->format
)) {
543 pipe_put_tile_ui_format(tc
->transfer
[layer
], tc
->transfer_map
[layer
],
544 tc
->tile_addrs
[pos
].bits
.x
* TILE_SIZE
,
545 tc
->tile_addrs
[pos
].bits
.y
* TILE_SIZE
,
546 TILE_SIZE
, TILE_SIZE
,
548 (unsigned *) tile
->data
.colorui128
);
549 } else if (util_format_is_pure_sint(tc
->surface
->format
)) {
550 pipe_put_tile_i_format(tc
->transfer
[layer
], tc
->transfer_map
[layer
],
551 tc
->tile_addrs
[pos
].bits
.x
* TILE_SIZE
,
552 tc
->tile_addrs
[pos
].bits
.y
* TILE_SIZE
,
553 TILE_SIZE
, TILE_SIZE
,
555 (int *) tile
->data
.colori128
);
557 pipe_put_tile_rgba_format(tc
->transfer
[layer
], tc
->transfer_map
[layer
],
558 tc
->tile_addrs
[pos
].bits
.x
* TILE_SIZE
,
559 tc
->tile_addrs
[pos
].bits
.y
* TILE_SIZE
,
560 TILE_SIZE
, TILE_SIZE
,
562 (float *) tile
->data
.color
);
567 tc
->tile_addrs
[pos
] = addr
;
569 layer
= tc
->tile_addrs
[pos
].bits
.layer
;
570 pt
= tc
->transfer
[layer
];
571 assert(pt
->resource
);
573 if (is_clear_flag_set(tc
->clear_flags
, addr
, tc
->clear_flags_size
)) {
574 /* don't get tile from framebuffer, just clear it */
575 if (tc
->depth_stencil
) {
576 clear_tile(tile
, pt
->resource
->format
, tc
->clear_val
);
579 clear_tile_rgba(tile
, pt
->resource
->format
, &tc
->clear_color
);
581 clear_clear_flag(tc
->clear_flags
, addr
, tc
->clear_flags_size
);
584 /* get new tile data from transfer */
585 if (tc
->depth_stencil
) {
586 pipe_get_tile_raw(tc
->transfer
[layer
], tc
->transfer_map
[layer
],
587 tc
->tile_addrs
[pos
].bits
.x
* TILE_SIZE
,
588 tc
->tile_addrs
[pos
].bits
.y
* TILE_SIZE
,
589 TILE_SIZE
, TILE_SIZE
,
590 tile
->data
.depth32
, 0/*STRIDE*/);
593 if (util_format_is_pure_uint(tc
->surface
->format
)) {
594 pipe_get_tile_ui_format(tc
->transfer
[layer
], tc
->transfer_map
[layer
],
595 tc
->tile_addrs
[pos
].bits
.x
* TILE_SIZE
,
596 tc
->tile_addrs
[pos
].bits
.y
* TILE_SIZE
,
597 TILE_SIZE
, TILE_SIZE
,
599 (unsigned *) tile
->data
.colorui128
);
600 } else if (util_format_is_pure_sint(tc
->surface
->format
)) {
601 pipe_get_tile_i_format(tc
->transfer
[layer
], tc
->transfer_map
[layer
],
602 tc
->tile_addrs
[pos
].bits
.x
* TILE_SIZE
,
603 tc
->tile_addrs
[pos
].bits
.y
* TILE_SIZE
,
604 TILE_SIZE
, TILE_SIZE
,
606 (int *) tile
->data
.colori128
);
608 pipe_get_tile_rgba_format(tc
->transfer
[layer
], tc
->transfer_map
[layer
],
609 tc
->tile_addrs
[pos
].bits
.x
* TILE_SIZE
,
610 tc
->tile_addrs
[pos
].bits
.y
* TILE_SIZE
,
611 TILE_SIZE
, TILE_SIZE
,
613 (float *) tile
->data
.color
);
619 tc
->last_tile
= tile
;
620 tc
->last_tile_addr
= addr
;
629 * When a whole surface is being cleared to a value we can avoid
630 * fetching tiles above.
631 * Save the color and set a 'clearflag' for each tile of the screen.
634 sp_tile_cache_clear(struct softpipe_tile_cache
*tc
,
635 const union pipe_color_union
*color
,
640 tc
->clear_color
= *color
;
642 tc
->clear_val
= clearValue
;
644 /* set flags to indicate all the tiles are cleared */
645 memset(tc
->clear_flags
, 255, tc
->clear_flags_size
);
647 for (pos
= 0; pos
< Elements(tc
->tile_addrs
); pos
++) {
648 tc
->tile_addrs
[pos
].bits
.invalid
= 1;
650 tc
->last_tile_addr
.bits
.invalid
= 1;