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 MAXHEIGHT 2048
  48 #define MAXWIDTH 2048
  49 #define TILES_X (MAXWIDTH / TILE_SIZE)
  50 #define TILES_Y (MAXHEIGHT / TILE_SIZE)
  51
  52
  53 #define CMD_BLOCK_MAX 128
  54 #define DATA_BLOCK_SIZE (16 * 1024 - sizeof(unsigned) - sizeof(void *))
  55
  56
  57
  58 /* switch to a non-pointer value for this:
  59  */
  60 typedef void (*lp_rast_cmd)( struct lp_rasterizer_task *,
  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 /** List of texture references */
 101 struct texture_ref {
 102    struct pipe_texture *texture;
 103    struct texture_ref *prev, *next;  /**< linked list w/ u_simple_list.h */
 104 };
 105
 106
 107 /**
 108  * All bins and bin data are contained here.
 109  * Per-bin data goes into the 'tile' bins.
 110  * Shared data goes into the 'data' buffer.
 111  *
 112  * When there are multiple threads, will want to double-buffer between
 113  * scenes:
 114  */
 115 struct lp_scene {
 116    struct pipe_context *pipe;
 117
 118    /* Scene's buffers are mapped at the time the scene is enqueued:
 119     */
 120    void *cbuf_map[PIPE_MAX_COLOR_BUFS];
 121    uint8_t *zsbuf_map;
 122
 123    /** the framebuffer to render the scene into */
 124    struct pipe_framebuffer_state fb;
 125
 126    /** list of textures referenced by the scene commands */
 127    struct texture_ref textures;
 128
 129    boolean write_depth;
 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_texture_reference( struct lp_scene *scene,
 171                                  struct pipe_texture *texture );
 172
 173 boolean lp_scene_is_texture_referenced( const struct lp_scene *scene,
 174                                         const struct pipe_texture *texture );
 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    {
 191       struct data_block *tail = list->tail;
 192       ubyte *data = tail->data + tail->used;
 193       tail->used += size;
 194       return data;
 195    }
 196 }
 197
 198
 199 /**
 200  * As above, but with specific alignment.
 201  */
 202 static INLINE void *
 203 lp_scene_alloc_aligned( struct lp_scene *scene, unsigned size,
 204                         unsigned alignment )
 205 {
 206    struct data_block_list *list = &scene->data;
 207
 208    if (list->tail->used + size + alignment - 1 > DATA_BLOCK_SIZE) {
 209       lp_bin_new_data_block( list );
 210    }
 211
 212    {
 213       struct data_block *tail = list->tail;
 214       ubyte *data = tail->data + tail->used;
 215       unsigned offset = (((uintptr_t)data + alignment - 1) & ~(alignment - 1)) - (uintptr_t)data;
 216       tail->used += offset + size;
 217       return data + offset;
 218    }
 219 }
 220
 221
 222 /* Put back data if we decide not to use it, eg. culled triangles.
 223  */
 224 static INLINE void
 225 lp_scene_putback_data( struct lp_scene *scene, unsigned size)
 226 {
 227    struct data_block_list *list = &scene->data;
 228    assert(list->tail->used >= size);
 229    list->tail->used -= size;
 230 }
 231
 232
 233 /** Return pointer to a particular tile's bin. */
 234 static INLINE struct cmd_bin *
 235 lp_scene_get_bin(struct lp_scene *scene, unsigned x, unsigned y)
 236 {
 237    return &scene->tile[x][y];
 238 }
 239
 240
 241 /** Remove all commands from a bin */
 242 void
 243 lp_scene_bin_reset(struct lp_scene *scene, unsigned x, unsigned y);
 244
 245
 246 /* Add a command to bin[x][y].
 247  */
 248 static INLINE void
 249 lp_scene_bin_command( struct lp_scene *scene,
 250                 unsigned x, unsigned y,
 251                 lp_rast_cmd cmd,
 252                 union lp_rast_cmd_arg arg )
 253 {
 254    struct cmd_bin *bin = lp_scene_get_bin(scene, x, y);
 255    struct cmd_block_list *list = &bin->commands;
 256
 257    assert(x < scene->tiles_x);
 258    assert(y < scene->tiles_y);
 259
 260    if (list->tail->count == CMD_BLOCK_MAX) {
 261       lp_bin_new_cmd_block( list );
 262    }
 263
 264    {
 265       struct cmd_block *tail = list->tail;
 266       unsigned i = tail->count;
 267       tail->cmd[i] = cmd;
 268       tail->arg[i] = arg;
 269       tail->count++;
 270    }
 271 }
 272
 273
 274 /* Add a command to all active bins.
 275  */
 276 static INLINE void
 277 lp_scene_bin_everywhere( struct lp_scene *scene,
 278                          lp_rast_cmd cmd,
 279                          const union lp_rast_cmd_arg arg )
 280 {
 281    unsigned i, j;
 282    for (i = 0; i < scene->tiles_x; i++)
 283       for (j = 0; j < scene->tiles_y; j++)
 284          lp_scene_bin_command( scene, i, j, cmd, arg );
 285 }
 286
 287
 288 void
 289 lp_scene_bin_state_command( struct lp_scene *scene,
 290                             lp_rast_cmd cmd,
 291                             const union lp_rast_cmd_arg arg );
 292
 293
 294 static INLINE unsigned
 295 lp_scene_get_num_bins( const struct lp_scene *scene )
 296 {
 297    return scene->tiles_x * scene->tiles_y;
 298 }
 299
 300
 301 void
 302 lp_scene_bin_iter_begin( struct lp_scene *scene );
 303
 304 struct cmd_bin *
 305 lp_scene_bin_iter_next( struct lp_scene *scene, int *bin_x, int *bin_y );
 306
 307 void
 308 lp_scene_rasterize( struct lp_scene *scene,
 309                     struct lp_rasterizer *rast,
 310                     boolean write_depth );
 311
 312 void
 313 lp_scene_begin_binning( struct lp_scene *scene,
 314                         struct pipe_framebuffer_state *fb );
 315
 316 #endif /* LP_BIN_H */