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