src/gallium/auxiliary/draw/draw_pipe_vbuf.c

   1 /**************************************************************************
   2  *
   3  * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas.
   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 TUNGSTEN GRAPHICS 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  * \file
  30  * Vertex buffer drawing stage.
  31  *
  32  * \author Jose Fonseca <jrfonsec@tungstengraphics.com>
  33  * \author Keith Whitwell <keith@tungstengraphics.com>
  34  */
  35
  36
  37 #include "util/u_debug.h"
  38 #include "util/u_math.h"
  39 #include "util/u_memory.h"
  40
  41 #include "draw_vbuf.h"
  42 #include "draw_private.h"
  43 #include "draw_vertex.h"
  44 #include "draw_pipe.h"
  45 #include "translate/translate.h"
  46 #include "translate/translate_cache.h"
  47
  48
  49 /**
  50  * Vertex buffer emit stage.
  51  */
  52 struct vbuf_stage {
  53    struct draw_stage stage; /**< This must be first (base class) */
  54
  55    struct vbuf_render *render;
  56
  57    const struct vertex_info *vinfo;
  58
  59    /** Vertex size in bytes */
  60    unsigned vertex_size;
  61
  62    struct translate *translate;
  63
  64    /* FIXME: we have no guarantee that 'unsigned' is 32bit */
  65
  66    /** Vertices in hardware format */
  67    unsigned *vertices;
  68    unsigned *vertex_ptr;
  69    unsigned max_vertices;
  70    unsigned nr_vertices;
  71
  72    /** Indices */
  73    ushort *indices;
  74    unsigned max_indices;
  75    unsigned nr_indices;
  76
  77    /* Cache point size somewhere it's address won't change:
  78     */
  79    float point_size;
  80
  81    struct translate_cache *cache;
  82 };
  83
  84
  85 /**
  86  * Basically a cast wrapper.
  87  */
  88 static INLINE struct vbuf_stage *
  89 vbuf_stage( struct draw_stage *stage )
  90 {
  91    assert(stage);
  92    return (struct vbuf_stage *)stage;
  93 }
  94
  95
  96 static void vbuf_flush_vertices( struct vbuf_stage *vbuf );
  97 static void vbuf_alloc_vertices( struct vbuf_stage *vbuf );
  98
  99
 100 static INLINE boolean
 101 overflow( void *map, void *ptr, unsigned bytes, unsigned bufsz )
 102 {
 103    unsigned long used = (unsigned long) ((char *)ptr - (char *)map);
 104    return (used + bytes) > bufsz;
 105 }
 106
 107
 108 static INLINE void
 109 check_space( struct vbuf_stage *vbuf, unsigned nr )
 110 {
 111    if (vbuf->nr_vertices + nr > vbuf->max_vertices ||
 112        vbuf->nr_indices + nr > vbuf->max_indices)
 113    {
 114       vbuf_flush_vertices( vbuf );
 115       vbuf_alloc_vertices( vbuf );
 116    }
 117 }
 118
 119
 120
 121
 122 /**
 123  * Extract the needed fields from post-transformed vertex and emit
 124  * a hardware(driver) vertex.
 125  * Recall that the vertices are constructed by the 'draw' module and
 126  * have a couple of slots at the beginning (1-dword header, 4-dword
 127  * clip pos) that we ignore here.  We only use the vertex->data[] fields.
 128  */
 129 static INLINE ushort
 130 emit_vertex( struct vbuf_stage *vbuf,
 131              struct vertex_header *vertex )
 132 {
 133    if(vertex->vertex_id == UNDEFINED_VERTEX_ID) {
 134       /* Hmm - vertices are emitted one at a time - better make sure
 135        * set_buffer is efficient.  Consider a special one-shot mode for
 136        * translate.
 137        */
 138       /* Note: we really do want data[0] here, not data[pos]:
 139        */
 140       vbuf->translate->set_buffer(vbuf->translate, 0, vertex->data[0], 0);
 141       vbuf->translate->run(vbuf->translate, 0, 1, vbuf->vertex_ptr);
 142
 143       if (0) draw_dump_emitted_vertex(vbuf->vinfo, (uint8_t *)vbuf->vertex_ptr);
 144
 145       vbuf->vertex_ptr += vbuf->vertex_size/4;
 146       vertex->vertex_id = vbuf->nr_vertices++;
 147    }
 148
 149    return (ushort)vertex->vertex_id;
 150 }
 151
 152
 153 static void
 154 vbuf_tri( struct draw_stage *stage,
 155           struct prim_header *prim )
 156 {
 157    struct vbuf_stage *vbuf = vbuf_stage( stage );
 158    unsigned i;
 159
 160    check_space( vbuf, 3 );
 161
 162    for (i = 0; i < 3; i++) {
 163       vbuf->indices[vbuf->nr_indices++] = emit_vertex( vbuf, prim->v[i] );
 164    }
 165 }
 166
 167
 168 static void
 169 vbuf_line( struct draw_stage *stage,
 170            struct prim_header *prim )
 171 {
 172    struct vbuf_stage *vbuf = vbuf_stage( stage );
 173    unsigned i;
 174
 175    check_space( vbuf, 2 );
 176
 177    for (i = 0; i < 2; i++) {
 178       vbuf->indices[vbuf->nr_indices++] = emit_vertex( vbuf, prim->v[i] );
 179    }
 180 }
 181
 182
 183 static void
 184 vbuf_point( struct draw_stage *stage,
 185             struct prim_header *prim )
 186 {
 187    struct vbuf_stage *vbuf = vbuf_stage( stage );
 188
 189    check_space( vbuf, 1 );
 190
 191    vbuf->indices[vbuf->nr_indices++] = emit_vertex( vbuf, prim->v[0] );
 192 }
 193
 194
 195
 196
 197 /**
 198  * Set the prim type for subsequent vertices.
 199  * This may result in a new vertex size.  The existing vbuffer (if any)
 200  * will be flushed if needed and a new one allocated.
 201  */
 202 static void
 203 vbuf_start_prim( struct vbuf_stage *vbuf, uint prim )
 204 {
 205    struct translate_key hw_key;
 206    unsigned dst_offset;
 207    unsigned i;
 208
 209    vbuf->render->set_primitive(vbuf->render, prim);
 210
 211    /* Must do this after set_primitive() above:
 212     *
 213     * XXX: need some state managment to track when this needs to be
 214     * recalculated.  The driver should tell us whether there was a
 215     * state change.
 216     */
 217    vbuf->vinfo = vbuf->render->get_vertex_info(vbuf->render);
 218    vbuf->vertex_size = vbuf->vinfo->size * sizeof(float);
 219
 220    /* Translate from pipeline vertices to hw vertices.
 221     */
 222    dst_offset = 0;
 223
 224    for (i = 0; i < vbuf->vinfo->num_attribs; i++) {
 225       unsigned emit_sz = 0;
 226       unsigned src_buffer = 0;
 227       unsigned output_format;
 228       unsigned src_offset = (vbuf->vinfo->attrib[i].src_index * 4 * sizeof(float) );
 229
 230       switch (vbuf->vinfo->attrib[i].emit) {
 231       case EMIT_4F:
 232          output_format = PIPE_FORMAT_R32G32B32A32_FLOAT;
 233          emit_sz = 4 * sizeof(float);
 234          break;
 235       case EMIT_3F:
 236          output_format = PIPE_FORMAT_R32G32B32_FLOAT;
 237          emit_sz = 3 * sizeof(float);
 238          break;
 239       case EMIT_2F:
 240          output_format = PIPE_FORMAT_R32G32_FLOAT;
 241          emit_sz = 2 * sizeof(float);
 242          break;
 243       case EMIT_1F:
 244          output_format = PIPE_FORMAT_R32_FLOAT;
 245          emit_sz = 1 * sizeof(float);
 246          break;
 247       case EMIT_1F_PSIZE:
 248          output_format = PIPE_FORMAT_R32_FLOAT;
 249          emit_sz = 1 * sizeof(float);
 250          src_buffer = 1;
 251          src_offset = 0;
 252          break;
 253       case EMIT_4UB:
 254          output_format = PIPE_FORMAT_B8G8R8A8_UNORM;
 255          emit_sz = 4 * sizeof(ubyte);
 256          break;
 257       default:
 258          assert(0);
 259          output_format = PIPE_FORMAT_NONE;
 260          emit_sz = 0;
 261          break;
 262       }
 263
 264       hw_key.element[i].input_format = PIPE_FORMAT_R32G32B32A32_FLOAT;
 265       hw_key.element[i].input_buffer = src_buffer;
 266       hw_key.element[i].input_offset = src_offset;
 267       hw_key.element[i].output_format = output_format;
 268       hw_key.element[i].output_offset = dst_offset;
 269
 270       dst_offset += emit_sz;
 271    }
 272
 273    hw_key.nr_elements = vbuf->vinfo->num_attribs;
 274    hw_key.output_stride = vbuf->vinfo->size * 4;
 275
 276    /* Don't bother with caching at this stage:
 277     */
 278    if (!vbuf->translate ||
 279        translate_key_compare(&vbuf->translate->key, &hw_key) != 0)
 280    {
 281       translate_key_sanitize(&hw_key);
 282       vbuf->translate = translate_cache_find(vbuf->cache, &hw_key);
 283
 284       vbuf->translate->set_buffer(vbuf->translate, 1, &vbuf->point_size, 0);
 285    }
 286
 287    vbuf->point_size = vbuf->stage.draw->rasterizer->point_size;
 288
 289    /* Allocate new buffer?
 290     */
 291    assert(vbuf->vertices == NULL);
 292    vbuf_alloc_vertices(vbuf);
 293 }
 294
 295
 296 static void
 297 vbuf_first_tri( struct draw_stage *stage,
 298                 struct prim_header *prim )
 299 {
 300    struct vbuf_stage *vbuf = vbuf_stage( stage );
 301
 302    vbuf_flush_vertices( vbuf );
 303    vbuf_start_prim(vbuf, PIPE_PRIM_TRIANGLES);
 304    stage->tri = vbuf_tri;
 305    stage->tri( stage, prim );
 306 }
 307
 308
 309 static void
 310 vbuf_first_line( struct draw_stage *stage,
 311                  struct prim_header *prim )
 312 {
 313    struct vbuf_stage *vbuf = vbuf_stage( stage );
 314
 315    vbuf_flush_vertices( vbuf );
 316    vbuf_start_prim(vbuf, PIPE_PRIM_LINES);
 317    stage->line = vbuf_line;
 318    stage->line( stage, prim );
 319 }
 320
 321
 322 static void
 323 vbuf_first_point( struct draw_stage *stage,
 324                   struct prim_header *prim )
 325 {
 326    struct vbuf_stage *vbuf = vbuf_stage( stage );
 327
 328    vbuf_flush_vertices(vbuf);
 329    vbuf_start_prim(vbuf, PIPE_PRIM_POINTS);
 330    stage->point = vbuf_point;
 331    stage->point( stage, prim );
 332 }
 333
 334
 335
 336 /**
 337  * Flush existing vertex buffer and allocate a new one.
 338  */
 339 static void
 340 vbuf_flush_vertices( struct vbuf_stage *vbuf )
 341 {
 342    if(vbuf->vertices) {
 343
 344       vbuf->render->unmap_vertices( vbuf->render, 0, vbuf->nr_vertices - 1 );
 345
 346       if (vbuf->nr_indices)
 347       {
 348          vbuf->render->draw(vbuf->render,
 349                             vbuf->indices,
 350                             vbuf->nr_indices );
 351
 352          vbuf->nr_indices = 0;
 353       }
 354
 355       /* Reset temporary vertices ids */
 356       if(vbuf->nr_vertices)
 357          draw_reset_vertex_ids( vbuf->stage.draw );
 358
 359       /* Free the vertex buffer */
 360       vbuf->render->release_vertices( vbuf->render );
 361
 362       vbuf->max_vertices = vbuf->nr_vertices = 0;
 363       vbuf->vertex_ptr = vbuf->vertices = NULL;
 364    }
 365 }
 366
 367
 368 static void
 369 vbuf_alloc_vertices( struct vbuf_stage *vbuf )
 370 {
 371    assert(!vbuf->nr_indices);
 372    assert(!vbuf->vertices);
 373
 374    /* Allocate a new vertex buffer */
 375    vbuf->max_vertices = vbuf->render->max_vertex_buffer_bytes / vbuf->vertex_size;
 376
 377    /* even number */
 378    vbuf->max_vertices = vbuf->max_vertices & ~1;
 379
 380    if(vbuf->max_vertices >= UNDEFINED_VERTEX_ID)
 381       vbuf->max_vertices = UNDEFINED_VERTEX_ID - 1;
 382
 383    /* Must always succeed -- driver gives us a
 384     * 'max_vertex_buffer_bytes' which it guarantees it can allocate,
 385     * and it will flush itself if necessary to do so.  If this does
 386     * fail, we are basically without usable hardware.
 387     */
 388    vbuf->render->allocate_vertices(vbuf->render,
 389                                    (ushort) vbuf->vertex_size,
 390                                    (ushort) vbuf->max_vertices);
 391
 392    vbuf->vertices = (uint *) vbuf->render->map_vertices( vbuf->render );
 393
 394    vbuf->vertex_ptr = vbuf->vertices;
 395 }
 396
 397
 398
 399 static void
 400 vbuf_flush( struct draw_stage *stage, unsigned flags )
 401 {
 402    struct vbuf_stage *vbuf = vbuf_stage( stage );
 403
 404    vbuf_flush_vertices( vbuf );
 405
 406    stage->point = vbuf_first_point;
 407    stage->line = vbuf_first_line;
 408    stage->tri = vbuf_first_tri;
 409 }
 410
 411
 412 static void
 413 vbuf_reset_stipple_counter( struct draw_stage *stage )
 414 {
 415    /* XXX: Need to do something here for hardware with linestipple.
 416     */
 417    (void) stage;
 418 }
 419
 420
 421 static void vbuf_destroy( struct draw_stage *stage )
 422 {
 423    struct vbuf_stage *vbuf = vbuf_stage( stage );
 424
 425    if(vbuf->indices)
 426       align_free( vbuf->indices );
 427
 428    if (vbuf->render)
 429       vbuf->render->destroy( vbuf->render );
 430
 431    if (vbuf->cache)
 432       translate_cache_destroy(vbuf->cache);
 433
 434    FREE( stage );
 435 }
 436
 437
 438 /**
 439  * Create a new primitive vbuf/render stage.
 440  */
 441 struct draw_stage *draw_vbuf_stage( struct draw_context *draw,
 442                                     struct vbuf_render *render )
 443 {
 444    struct vbuf_stage *vbuf = CALLOC_STRUCT(vbuf_stage);
 445    if (vbuf == NULL)
 446       goto fail;
 447
 448    vbuf->stage.draw = draw;
 449    vbuf->stage.name = "vbuf";
 450    vbuf->stage.point = vbuf_first_point;
 451    vbuf->stage.line = vbuf_first_line;
 452    vbuf->stage.tri = vbuf_first_tri;
 453    vbuf->stage.flush = vbuf_flush;
 454    vbuf->stage.reset_stipple_counter = vbuf_reset_stipple_counter;
 455    vbuf->stage.destroy = vbuf_destroy;
 456
 457    vbuf->render = render;
 458    vbuf->max_indices = MAX2(render->max_indices, UNDEFINED_VERTEX_ID-1);
 459
 460    vbuf->indices = (ushort *) align_malloc( vbuf->max_indices *
 461                                             sizeof(vbuf->indices[0]),
 462                                             16 );
 463    if (!vbuf->indices)
 464       goto fail;
 465
 466    vbuf->cache = translate_cache_create();
 467    if (!vbuf->cache)
 468       goto fail;
 469
 470
 471    vbuf->vertices = NULL;
 472    vbuf->vertex_ptr = vbuf->vertices;
 473
 474    return &vbuf->stage;
 475
 476  fail:
 477    if (vbuf)
 478       vbuf_destroy(&vbuf->stage);
 479
 480    return NULL;
 481 }