src/gallium/drivers/llvmpipe/lp_scene.h

   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
  29 /**
  30  * Binner data structures and bin-related functions.
  31  * Note: the "setup" code is concerned with building scenes while
  32  * The "rast" code is concerned with consuming/executing scenes.
  33  */
  34
  35 #ifndef LP_SCENE_H
  36 #define LP_SCENE_H
  37
  38 #include "os/os_thread.h"
  39 #include "lp_rast.h"
  40 #include "lp_debug.h"
  41
  42 struct lp_scene_queue;
  43 struct lp_rast_state;
  44
  45 /* We're limited to 2K by 2K for 32bit fixed point rasterization.
  46  * Will need a 64-bit version for larger framebuffers.
  47  */
  48 #define TILES_X (LP_MAX_WIDTH / TILE_SIZE)
  49 #define TILES_Y (LP_MAX_HEIGHT / TILE_SIZE)
  50
  51
  52 /* Commands per command block (ideally so sizeof(cmd_block) is a power of
  53  * two in size.)
  54  */
  55 #define CMD_BLOCK_MAX 29
  56
  57 /* Bytes per data block.
  58  */
  59 #define DATA_BLOCK_SIZE (64 * 1024)
  60
  61 /* Scene temporary storage is clamped to this size:
  62  */
  63 #define LP_SCENE_MAX_SIZE (9*1024*1024)
  64
  65 /* The maximum amount of texture storage referenced by a scene is
  66  * clamped ot this size:
  67  */
  68 #define LP_SCENE_MAX_RESOURCE_SIZE (64*1024*1024)
  69
  70
  71 /* switch to a non-pointer value for this:
  72  */
  73 typedef void (*lp_rast_cmd_func)( struct lp_rasterizer_task *,
  74                                   const union lp_rast_cmd_arg );
  75
  76
  77 struct cmd_block {
  78    uint8_t cmd[CMD_BLOCK_MAX];
  79    union lp_rast_cmd_arg arg[CMD_BLOCK_MAX];
  80    unsigned count;
  81    struct cmd_block *next;
  82 };
  83
  84
  85 struct data_block {
  86    ubyte data[DATA_BLOCK_SIZE];
  87    unsigned used;
  88    struct data_block *next;
  89 };
  90
  91
  92
  93 /**
  94  * For each screen tile we have one of these bins.
  95  */
  96 struct cmd_bin {
  97    const struct lp_rast_state *last_state;       /* most recent state set in bin */
  98    struct cmd_block *head;
  99    struct cmd_block *tail;
 100 };
 101
 102
 103 /**
 104  * This stores bulk data which is used for all memory allocations
 105  * within a scene.
 106  *
 107  * Examples include triangle data and state data.  The commands in
 108  * the per-tile bins will point to chunks of data in this structure.
 109  *
 110  * Include the first block of data statically to ensure we can always
 111  * initiate a scene without relying on malloc succeeding.
 112  */
 113 struct data_block_list {
 114    struct data_block first;
 115    struct data_block *head;
 116 };
 117
 118 struct resource_ref;
 119
 120 /**
 121  * All bins and bin data are contained here.
 122  * Per-bin data goes into the 'tile' bins.
 123  * Shared data goes into the 'data' buffer.
 124  *
 125  * When there are multiple threads, will want to double-buffer between
 126  * scenes:
 127  */
 128 struct lp_scene {
 129    struct pipe_context *pipe;
 130    struct lp_fence *fence;
 131
 132    /* Framebuffer mappings - valid only between begin_rasterization()
 133     * and end_rasterization().
 134     */
 135    struct {
 136       uint8_t *map;
 137       unsigned stride;
 138       unsigned blocksize;
 139    } zsbuf, cbufs[PIPE_MAX_COLOR_BUFS];
 140
 141    /** the framebuffer to render the scene into */
 142    struct pipe_framebuffer_state fb;
 143
 144    /** list of resources referenced by the scene commands */
 145    struct resource_ref *resources;
 146
 147    /** aligned scene width, height */
 148    unsigned width_aligned;
 149    unsigned height_aligned;
 150
 151    /** Total memory used by the scene (in bytes).  This sums all the
 152     * data blocks and counts all bins, state, resource references and
 153     * other random allocations within the scene.
 154     */
 155    unsigned scene_size;
 156
 157    /** Sum of sizes of all resources referenced by the scene.  Sums
 158     * all the textures read by the scene:
 159     */
 160    unsigned resource_reference_size;
 161
 162    boolean alloc_failed;
 163    boolean has_depthstencil_clear;
 164    boolean discard;
 165    /**
 166     * Number of active tiles in each dimension.
 167     * This basically the framebuffer size divided by tile size
 168     */
 169    unsigned tiles_x, tiles_y;
 170
 171    int curr_x, curr_y;  /**< for iterating over bins */
 172    pipe_mutex mutex;
 173
 174    struct cmd_bin tile[TILES_X][TILES_Y];
 175    struct data_block_list data;
 176 };
 177
 178
 179
 180 struct lp_scene *lp_scene_create(struct pipe_context *pipe);
 181
 182 void lp_scene_destroy(struct lp_scene *scene);
 183
 184 boolean lp_scene_is_empty(struct lp_scene *scene );
 185 boolean lp_scene_is_oom(struct lp_scene *scene );
 186
 187
 188 struct data_block *lp_scene_new_data_block( struct lp_scene *scene );
 189
 190 struct cmd_block *lp_scene_new_cmd_block( struct lp_scene *scene,
 191                                           struct cmd_bin *bin );
 192
 193 boolean lp_scene_add_resource_reference(struct lp_scene *scene,
 194                                         struct pipe_resource *resource,
 195                                         boolean initializing_scene);
 196
 197 boolean lp_scene_is_resource_referenced(const struct lp_scene *scene,
 198                                         const struct pipe_resource *resource );
 199
 200
 201 /**
 202  * Allocate space for a command/data in the bin's data buffer.
 203  * Grow the block list if needed.
 204  */
 205 static INLINE void *
 206 lp_scene_alloc( struct lp_scene *scene, unsigned size)
 207 {
 208    struct data_block_list *list = &scene->data;
 209    struct data_block *block = list->head;
 210
 211    assert(size <= DATA_BLOCK_SIZE);
 212    assert(block != NULL);
 213
 214    if (LP_DEBUG & DEBUG_MEM)
 215       debug_printf("alloc %u block %u/%u tot %u/%u\n",
 216                    size, block->used, DATA_BLOCK_SIZE,
 217                    scene->scene_size, LP_SCENE_MAX_SIZE);
 218
 219    if (block->used + size > DATA_BLOCK_SIZE) {
 220       block = lp_scene_new_data_block( scene );
 221       if (!block) {
 222          /* out of memory */
 223          return NULL;
 224       }
 225    }
 226
 227    {
 228       ubyte *data = block->data + block->used;
 229       block->used += size;
 230       return data;
 231    }
 232 }
 233
 234
 235 /**
 236  * As above, but with specific alignment.
 237  */
 238 static INLINE void *
 239 lp_scene_alloc_aligned( struct lp_scene *scene, unsigned size,
 240                         unsigned alignment )
 241 {
 242    struct data_block_list *list = &scene->data;
 243    struct data_block *block = list->head;
 244
 245    assert(block != NULL);
 246
 247    if (LP_DEBUG & DEBUG_MEM)
 248       debug_printf("alloc %u block %u/%u tot %u/%u\n",
 249                    size + alignment - 1,
 250                    block->used, DATA_BLOCK_SIZE,
 251                    scene->scene_size, LP_SCENE_MAX_SIZE);
 252
 253    if (block->used + size + alignment - 1 > DATA_BLOCK_SIZE) {
 254       block = lp_scene_new_data_block( scene );
 255       if (!block)
 256          return NULL;
 257    }
 258
 259    {
 260       ubyte *data = block->data + block->used;
 261       unsigned offset = (((uintptr_t)data + alignment - 1) & ~(alignment - 1)) - (uintptr_t)data;
 262       block->used += offset + size;
 263       return data + offset;
 264    }
 265 }
 266
 267
 268 /* Put back data if we decide not to use it, eg. culled triangles.
 269  */
 270 static INLINE void
 271 lp_scene_putback_data( struct lp_scene *scene, unsigned size)
 272 {
 273    struct data_block_list *list = &scene->data;
 274    assert(list->head && list->head->used >= size);
 275    list->head->used -= size;
 276 }
 277
 278
 279 /** Return pointer to a particular tile's bin. */
 280 static INLINE struct cmd_bin *
 281 lp_scene_get_bin(struct lp_scene *scene, unsigned x, unsigned y)
 282 {
 283    return &scene->tile[x][y];
 284 }
 285
 286
 287 /** Remove all commands from a bin */
 288 void
 289 lp_scene_bin_reset(struct lp_scene *scene, unsigned x, unsigned y);
 290
 291
 292 /* Add a command to bin[x][y].
 293  */
 294 static INLINE boolean
 295 lp_scene_bin_command( struct lp_scene *scene,
 296                       unsigned x, unsigned y,
 297                       unsigned cmd,
 298                       union lp_rast_cmd_arg arg )
 299 {
 300    struct cmd_bin *bin = lp_scene_get_bin(scene, x, y);
 301    struct cmd_block *tail = bin->tail;
 302
 303    assert(x < scene->tiles_x);
 304    assert(y < scene->tiles_y);
 305    assert(cmd < LP_RAST_OP_MAX);
 306
 307    if (tail == NULL || tail->count == CMD_BLOCK_MAX) {
 308       tail = lp_scene_new_cmd_block( scene, bin );
 309       if (!tail) {
 310          return FALSE;
 311       }
 312       assert(tail->count == 0);
 313    }
 314
 315    {
 316       unsigned i = tail->count;
 317       tail->cmd[i] = cmd & LP_RAST_OP_MASK;
 318       tail->arg[i] = arg;
 319       tail->count++;
 320    }
 321
 322    return TRUE;
 323 }
 324
 325
 326 static INLINE boolean
 327 lp_scene_bin_cmd_with_state( struct lp_scene *scene,
 328                              unsigned x, unsigned y,
 329                              const struct lp_rast_state *state,
 330                              unsigned cmd,
 331                              union lp_rast_cmd_arg arg )
 332 {
 333    struct cmd_bin *bin = lp_scene_get_bin(scene, x, y);
 334
 335    if (state != bin->last_state) {
 336       bin->last_state = state;
 337       if (!lp_scene_bin_command(scene, x, y,
 338                                 LP_RAST_OP_SET_STATE,
 339                                 lp_rast_arg_state(state)))
 340          return FALSE;
 341    }
 342
 343    if (!lp_scene_bin_command( scene, x, y, cmd, arg ))
 344       return FALSE;
 345
 346    return TRUE;
 347 }
 348
 349
 350 /* Add a command to all active bins.
 351  */
 352 static INLINE boolean
 353 lp_scene_bin_everywhere( struct lp_scene *scene,
 354                          unsigned cmd,
 355                          const union lp_rast_cmd_arg arg )
 356 {
 357    unsigned i, j;
 358    for (i = 0; i < scene->tiles_x; i++) {
 359       for (j = 0; j < scene->tiles_y; j++) {
 360          if (!lp_scene_bin_command( scene, i, j, cmd, arg ))
 361             return FALSE;
 362       }
 363    }
 364
 365    return TRUE;
 366 }
 367
 368
 369 static INLINE unsigned
 370 lp_scene_get_num_bins( const struct lp_scene *scene )
 371 {
 372    return scene->tiles_x * scene->tiles_y;
 373 }
 374
 375
 376 void
 377 lp_scene_bin_iter_begin( struct lp_scene *scene );
 378
 379 struct cmd_bin *
 380 lp_scene_bin_iter_next( struct lp_scene *scene, int *x, int *y );
 381
 382
 383
 384 /* Begin/end binning of a scene
 385  */
 386 void
 387 lp_scene_begin_binning( struct lp_scene *scene,
 388                         struct pipe_framebuffer_state *fb,
 389                         boolean discard );
 390
 391 void
 392 lp_scene_end_binning( struct lp_scene *scene );
 393
 394
 395 /* Begin/end rasterization of a scene
 396  */
 397 void
 398 lp_scene_begin_rasterization(struct lp_scene *scene);
 399
 400 void
 401 lp_scene_end_rasterization(struct lp_scene *scene );
 402
 403
 404
 405
 406
 407 #endif /* LP_BIN_H */