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_tile_soa.h"
  40 #include "lp_rast.h"
  41
  42 struct lp_scene_queue;
  43
  44 /* We're limited to 2K by 2K for 32bit fixed point rasterization.
  45  * Will need a 64-bit version for larger framebuffers.
  46  */
  47 #define TILES_X (LP_MAX_WIDTH / TILE_SIZE)
  48 #define TILES_Y (LP_MAX_HEIGHT / TILE_SIZE)
  49
  50
  51 #define CMD_BLOCK_MAX 128
  52 #define DATA_BLOCK_SIZE (16 * 1024 - sizeof(unsigned) - sizeof(void *))
  53
  54
  55
  56 /* switch to a non-pointer value for this:
  57  */
  58 typedef void (*lp_rast_cmd)( struct lp_rasterizer_task *,
  59                              const union lp_rast_cmd_arg );
  60
  61 struct cmd_block {
  62    lp_rast_cmd cmd[CMD_BLOCK_MAX];
  63    union lp_rast_cmd_arg arg[CMD_BLOCK_MAX];
  64    unsigned count;
  65    struct cmd_block *next;
  66 };
  67
  68 struct data_block {
  69    ubyte data[DATA_BLOCK_SIZE];
  70    unsigned used;
  71    struct data_block *next;
  72 };
  73
  74 struct cmd_block_list {
  75    struct cmd_block *head;
  76    struct cmd_block *tail;
  77 };
  78
  79 /**
  80  * For each screen tile we have one of these bins.
  81  */
  82 struct cmd_bin {
  83    struct cmd_block_list commands;
  84 };
  85
  86
  87 /**
  88  * This stores bulk data which is shared by all bins within a scene.
  89  * Examples include triangle data and state data.  The commands in
  90  * the per-tile bins will point to chunks of data in this structure.
  91  */
  92 struct data_block_list {
  93    struct data_block *head;
  94    struct data_block *tail;
  95 };
  96
  97
  98 /** List of resource references */
  99 struct resource_ref {
 100    struct pipe_resource *resource;
 101    struct resource_ref *prev, *next;  /**< linked list w/ u_simple_list.h */
 102 };
 103
 104
 105 /**
 106  * All bins and bin data are contained here.
 107  * Per-bin data goes into the 'tile' bins.
 108  * Shared data goes into the 'data' buffer.
 109  *
 110  * When there are multiple threads, will want to double-buffer between
 111  * scenes:
 112  */
 113 struct lp_scene {
 114    struct pipe_context *pipe;
 115
 116    /** the framebuffer to render the scene into */
 117    struct pipe_framebuffer_state fb;
 118
 119    /** list of resources referenced by the scene commands */
 120    struct resource_ref resources;
 121
 122    /** Approx memory used by the scene (in bytes).  This includes the
 123     * shared and per-tile bins plus any referenced resources/textures.
 124     */
 125    unsigned scene_size;
 126
 127    boolean write_depth;
 128    boolean has_color_clear;
 129    boolean has_depth_clear;
 130
 131    /**
 132     * Number of active tiles in each dimension.
 133     * This basically the framebuffer size divided by tile size
 134     */
 135    unsigned tiles_x, tiles_y;
 136
 137    int curr_x, curr_y;  /**< for iterating over bins */
 138    pipe_mutex mutex;
 139
 140    /* Where to place this scene once it has been rasterized:
 141     */
 142    struct lp_scene_queue *empty_queue;
 143
 144    struct cmd_bin tile[TILES_X][TILES_Y];
 145    struct data_block_list data;
 146 };
 147
 148
 149
 150 struct lp_scene *lp_scene_create(struct pipe_context *pipe,
 151                                  struct lp_scene_queue *empty_queue);
 152
 153 void lp_scene_destroy(struct lp_scene *scene);
 154
 155
 156
 157 boolean lp_scene_is_empty(struct lp_scene *scene );
 158
 159 void lp_scene_reset(struct lp_scene *scene );
 160
 161
 162 void lp_bin_new_data_block( struct data_block_list *list );
 163
 164 void lp_bin_new_cmd_block( struct cmd_block_list *list );
 165
 166 unsigned lp_scene_data_size( const struct lp_scene *scene );
 167
 168 unsigned lp_scene_bin_size( const struct lp_scene *scene, unsigned x, unsigned y );
 169
 170 void lp_scene_add_resource_reference(struct lp_scene *scene,
 171                                      struct pipe_resource *resource);
 172
 173 boolean lp_scene_is_resource_referenced(const struct lp_scene *scene,
 174                                         const struct pipe_resource *resource );
 175
 176
 177 /**
 178  * Allocate space for a command/data in the bin's data buffer.
 179  * Grow the block list if needed.
 180  */
 181 static INLINE void *
 182 lp_scene_alloc( struct lp_scene *scene, unsigned size)
 183 {
 184    struct data_block_list *list = &scene->data;
 185
 186    if (list->tail->used + size > DATA_BLOCK_SIZE) {
 187       lp_bin_new_data_block( list );
 188    }
 189
 190    scene->scene_size += size;
 191
 192    {
 193       struct data_block *tail = list->tail;
 194       ubyte *data = tail->data + tail->used;
 195       tail->used += size;
 196       return data;
 197    }
 198 }
 199
 200
 201 /**
 202  * As above, but with specific alignment.
 203  */
 204 static INLINE void *
 205 lp_scene_alloc_aligned( struct lp_scene *scene, unsigned size,
 206                         unsigned alignment )
 207 {
 208    struct data_block_list *list = &scene->data;
 209
 210    if (list->tail->used + size + alignment - 1 > DATA_BLOCK_SIZE) {
 211       lp_bin_new_data_block( list );
 212    }
 213
 214    scene->scene_size += size;
 215
 216    {
 217       struct data_block *tail = list->tail;
 218       ubyte *data = tail->data + tail->used;
 219       unsigned offset = (((uintptr_t)data + alignment - 1) & ~(alignment - 1)) - (uintptr_t)data;
 220       tail->used += offset + size;
 221       return data + offset;
 222    }
 223 }
 224
 225
 226 /* Put back data if we decide not to use it, eg. culled triangles.
 227  */
 228 static INLINE void
 229 lp_scene_putback_data( struct lp_scene *scene, unsigned size)
 230 {
 231    struct data_block_list *list = &scene->data;
 232    scene->scene_size -= size;
 233    assert(list->tail->used >= size);
 234    list->tail->used -= size;
 235 }
 236
 237
 238 /** Return pointer to a particular tile's bin. */
 239 static INLINE struct cmd_bin *
 240 lp_scene_get_bin(struct lp_scene *scene, unsigned x, unsigned y)
 241 {
 242    return &scene->tile[x][y];
 243 }
 244
 245
 246 /** Remove all commands from a bin */
 247 void
 248 lp_scene_bin_reset(struct lp_scene *scene, unsigned x, unsigned y);
 249
 250
 251 /* Add a command to bin[x][y].
 252  */
 253 static INLINE void
 254 lp_scene_bin_command( struct lp_scene *scene,
 255                 unsigned x, unsigned y,
 256                 lp_rast_cmd cmd,
 257                 union lp_rast_cmd_arg arg )
 258 {
 259    struct cmd_bin *bin = lp_scene_get_bin(scene, x, y);
 260    struct cmd_block_list *list = &bin->commands;
 261
 262    assert(x < scene->tiles_x);
 263    assert(y < scene->tiles_y);
 264
 265    if (list->tail->count == CMD_BLOCK_MAX) {
 266       lp_bin_new_cmd_block( list );
 267    }
 268
 269    {
 270       struct cmd_block *tail = list->tail;
 271       unsigned i = tail->count;
 272       tail->cmd[i] = cmd;
 273       tail->arg[i] = arg;
 274       tail->count++;
 275    }
 276 }
 277
 278
 279 /* Add a command to all active bins.
 280  */
 281 static INLINE void
 282 lp_scene_bin_everywhere( struct lp_scene *scene,
 283                          lp_rast_cmd cmd,
 284                          const union lp_rast_cmd_arg arg )
 285 {
 286    unsigned i, j;
 287    for (i = 0; i < scene->tiles_x; i++)
 288       for (j = 0; j < scene->tiles_y; j++)
 289          lp_scene_bin_command( scene, i, j, cmd, arg );
 290 }
 291
 292
 293 void
 294 lp_scene_bin_state_command( struct lp_scene *scene,
 295                             lp_rast_cmd cmd,
 296                             const union lp_rast_cmd_arg arg );
 297
 298
 299 static INLINE unsigned
 300 lp_scene_get_num_bins( const struct lp_scene *scene )
 301 {
 302    return scene->tiles_x * scene->tiles_y;
 303 }
 304
 305
 306 void
 307 lp_scene_bin_iter_begin( struct lp_scene *scene );
 308
 309 struct cmd_bin *
 310 lp_scene_bin_iter_next( struct lp_scene *scene, int *bin_x, int *bin_y );
 311
 312
 313 void
 314 lp_scene_rasterize( struct lp_scene *scene,
 315                     struct lp_rasterizer *rast,
 316                     boolean write_depth );
 317
 318 void
 319 lp_scene_begin_binning( struct lp_scene *scene,
 320                         struct pipe_framebuffer_state *fb );
 321
 322
 323 static INLINE unsigned
 324 lp_scene_get_size(const struct lp_scene *scene)
 325 {
 326    return scene->scene_size;
 327 }
 328
 329
 330 #endif /* LP_BIN_H */