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, 0, 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    if (vbuf->stage.draw->rasterizer->flatshade_first) {
 163       /* Put provoking vertex in position expected by the driver.
 164        * Emit last provoking vertex in first pos.
 165        * Swap verts 0 & 1 to preserve polygon winding.
 166        */
 167       vbuf->indices[vbuf->nr_indices++] = emit_vertex( vbuf, prim->v[2] );
 168       vbuf->indices[vbuf->nr_indices++] = emit_vertex( vbuf, prim->v[0] );
 169       vbuf->indices[vbuf->nr_indices++] = emit_vertex( vbuf, prim->v[1] );
 170    }
 171    else {
 172       for (i = 0; i < 3; i++) {
 173          vbuf->indices[vbuf->nr_indices++] = emit_vertex( vbuf, prim->v[i] );
 174       }
 175    }
 176 }
 177
 178
 179 static void
 180 vbuf_line( struct draw_stage *stage,
 181            struct prim_header *prim )
 182 {
 183    struct vbuf_stage *vbuf = vbuf_stage( stage );
 184    unsigned i;
 185
 186    check_space( vbuf, 2 );
 187
 188    for (i = 0; i < 2; i++) {
 189       vbuf->indices[vbuf->nr_indices++] = emit_vertex( vbuf, prim->v[i] );
 190    }
 191 }
 192
 193
 194 static void
 195 vbuf_point( struct draw_stage *stage,
 196             struct prim_header *prim )
 197 {
 198    struct vbuf_stage *vbuf = vbuf_stage( stage );
 199
 200    check_space( vbuf, 1 );
 201
 202    vbuf->indices[vbuf->nr_indices++] = emit_vertex( vbuf, prim->v[0] );
 203 }
 204
 205
 206
 207
 208 /**
 209  * Set the prim type for subsequent vertices.
 210  * This may result in a new vertex size.  The existing vbuffer (if any)
 211  * will be flushed if needed and a new one allocated.
 212  */
 213 static void
 214 vbuf_start_prim( struct vbuf_stage *vbuf, uint prim )
 215 {
 216    struct translate_key hw_key;
 217    unsigned dst_offset;
 218    unsigned i;
 219
 220    vbuf->render->set_primitive(vbuf->render, prim);
 221
 222    /* Must do this after set_primitive() above:
 223     *
 224     * XXX: need some state managment to track when this needs to be
 225     * recalculated.  The driver should tell us whether there was a
 226     * state change.
 227     */
 228    vbuf->vinfo = vbuf->render->get_vertex_info(vbuf->render);
 229    vbuf->vertex_size = vbuf->vinfo->size * sizeof(float);
 230
 231    /* Translate from pipeline vertices to hw vertices.
 232     */
 233    dst_offset = 0;
 234
 235    for (i = 0; i < vbuf->vinfo->num_attribs; i++) {
 236       unsigned emit_sz = 0;
 237       unsigned src_buffer = 0;
 238       unsigned output_format;
 239       unsigned src_offset = (vbuf->vinfo->attrib[i].src_index * 4 * sizeof(float) );
 240
 241       switch (vbuf->vinfo->attrib[i].emit) {
 242       case EMIT_4F:
 243          output_format = PIPE_FORMAT_R32G32B32A32_FLOAT;
 244          emit_sz = 4 * sizeof(float);
 245          break;
 246       case EMIT_3F:
 247          output_format = PIPE_FORMAT_R32G32B32_FLOAT;
 248          emit_sz = 3 * sizeof(float);
 249          break;
 250       case EMIT_2F:
 251          output_format = PIPE_FORMAT_R32G32_FLOAT;
 252          emit_sz = 2 * sizeof(float);
 253          break;
 254       case EMIT_1F:
 255          output_format = PIPE_FORMAT_R32_FLOAT;
 256          emit_sz = 1 * sizeof(float);
 257          break;
 258       case EMIT_1F_PSIZE:
 259          output_format = PIPE_FORMAT_R32_FLOAT;
 260          emit_sz = 1 * sizeof(float);
 261          src_buffer = 1;
 262          src_offset = 0;
 263          break;
 264       case EMIT_4UB:
 265          output_format = PIPE_FORMAT_A8R8G8B8_UNORM;
 266          emit_sz = 4 * sizeof(ubyte);
 267          break;
 268       default:
 269          assert(0);
 270          output_format = PIPE_FORMAT_NONE;
 271          emit_sz = 0;
 272          break;
 273       }
 274
 275       hw_key.element[i].type = TRANSLATE_ELEMENT_NORMAL;
 276       hw_key.element[i].input_format = PIPE_FORMAT_R32G32B32A32_FLOAT;
 277       hw_key.element[i].input_buffer = src_buffer;
 278       hw_key.element[i].input_offset = src_offset;
 279       hw_key.element[i].instance_divisor = 0;
 280       hw_key.element[i].output_format = output_format;
 281       hw_key.element[i].output_offset = dst_offset;
 282
 283       dst_offset += emit_sz;
 284    }
 285
 286    hw_key.nr_elements = vbuf->vinfo->num_attribs;
 287    hw_key.output_stride = vbuf->vinfo->size * 4;
 288
 289    /* Don't bother with caching at this stage:
 290     */
 291    if (!vbuf->translate ||
 292        translate_key_compare(&vbuf->translate->key, &hw_key) != 0)
 293    {
 294       translate_key_sanitize(&hw_key);
 295       vbuf->translate = translate_cache_find(vbuf->cache, &hw_key);
 296
 297       vbuf->translate->set_buffer(vbuf->translate, 1, &vbuf->point_size, 0);
 298    }
 299
 300    vbuf->point_size = vbuf->stage.draw->rasterizer->point_size;
 301
 302    /* Allocate new buffer?
 303     */
 304    assert(vbuf->vertices == NULL);
 305    vbuf_alloc_vertices(vbuf);
 306 }
 307
 308
 309 static void
 310 vbuf_first_tri( 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_TRIANGLES);
 317    stage->tri = vbuf_tri;
 318    stage->tri( stage, prim );
 319 }
 320
 321
 322 static void
 323 vbuf_first_line( 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_LINES);
 330    stage->line = vbuf_line;
 331    stage->line( stage, prim );
 332 }
 333
 334
 335 static void
 336 vbuf_first_point( struct draw_stage *stage,
 337                   struct prim_header *prim )
 338 {
 339    struct vbuf_stage *vbuf = vbuf_stage( stage );
 340
 341    vbuf_flush_vertices(vbuf);
 342    vbuf_start_prim(vbuf, PIPE_PRIM_POINTS);
 343    stage->point = vbuf_point;
 344    stage->point( stage, prim );
 345 }
 346
 347
 348
 349 /**
 350  * Flush existing vertex buffer and allocate a new one.
 351  */
 352 static void
 353 vbuf_flush_vertices( struct vbuf_stage *vbuf )
 354 {
 355    if(vbuf->vertices) {
 356
 357       vbuf->render->unmap_vertices( vbuf->render, 0, vbuf->nr_vertices - 1 );
 358
 359       if (vbuf->nr_indices)
 360       {
 361          vbuf->render->draw(vbuf->render,
 362                             vbuf->indices,
 363                             vbuf->nr_indices );
 364
 365          vbuf->nr_indices = 0;
 366       }
 367
 368       /* Reset temporary vertices ids */
 369       if(vbuf->nr_vertices)
 370          draw_reset_vertex_ids( vbuf->stage.draw );
 371
 372       /* Free the vertex buffer */
 373       vbuf->render->release_vertices( vbuf->render );
 374
 375       vbuf->max_vertices = vbuf->nr_vertices = 0;
 376       vbuf->vertex_ptr = vbuf->vertices = NULL;
 377    }
 378 }
 379
 380
 381 static void
 382 vbuf_alloc_vertices( struct vbuf_stage *vbuf )
 383 {
 384    assert(!vbuf->nr_indices);
 385    assert(!vbuf->vertices);
 386
 387    /* Allocate a new vertex buffer */
 388    vbuf->max_vertices = vbuf->render->max_vertex_buffer_bytes / vbuf->vertex_size;
 389
 390    /* even number */
 391    vbuf->max_vertices = vbuf->max_vertices & ~1;
 392
 393    if(vbuf->max_vertices >= UNDEFINED_VERTEX_ID)
 394       vbuf->max_vertices = UNDEFINED_VERTEX_ID - 1;
 395
 396    /* Must always succeed -- driver gives us a
 397     * 'max_vertex_buffer_bytes' which it guarantees it can allocate,
 398     * and it will flush itself if necessary to do so.  If this does
 399     * fail, we are basically without usable hardware.
 400     */
 401    vbuf->render->allocate_vertices(vbuf->render,
 402                                    (ushort) vbuf->vertex_size,
 403                                    (ushort) vbuf->max_vertices);
 404
 405    vbuf->vertices = (uint *) vbuf->render->map_vertices( vbuf->render );
 406
 407    vbuf->vertex_ptr = vbuf->vertices;
 408 }
 409
 410
 411
 412 static void
 413 vbuf_flush( struct draw_stage *stage, unsigned flags )
 414 {
 415    struct vbuf_stage *vbuf = vbuf_stage( stage );
 416
 417    vbuf_flush_vertices( vbuf );
 418
 419    stage->point = vbuf_first_point;
 420    stage->line = vbuf_first_line;
 421    stage->tri = vbuf_first_tri;
 422 }
 423
 424
 425 static void
 426 vbuf_reset_stipple_counter( struct draw_stage *stage )
 427 {
 428    /* XXX: Need to do something here for hardware with linestipple.
 429     */
 430    (void) stage;
 431 }
 432
 433
 434 static void vbuf_destroy( struct draw_stage *stage )
 435 {
 436    struct vbuf_stage *vbuf = vbuf_stage( stage );
 437
 438    if(vbuf->indices)
 439       align_free( vbuf->indices );
 440
 441    if (vbuf->render)
 442       vbuf->render->destroy( vbuf->render );
 443
 444    if (vbuf->cache)
 445       translate_cache_destroy(vbuf->cache);
 446
 447    FREE( stage );
 448 }
 449
 450
 451 /**
 452  * Create a new primitive vbuf/render stage.
 453  */
 454 struct draw_stage *draw_vbuf_stage( struct draw_context *draw,
 455                                     struct vbuf_render *render )
 456 {
 457    struct vbuf_stage *vbuf = CALLOC_STRUCT(vbuf_stage);
 458    if (vbuf == NULL)
 459       goto fail;
 460
 461    vbuf->stage.draw = draw;
 462    vbuf->stage.name = "vbuf";
 463    vbuf->stage.point = vbuf_first_point;
 464    vbuf->stage.line = vbuf_first_line;
 465    vbuf->stage.tri = vbuf_first_tri;
 466    vbuf->stage.flush = vbuf_flush;
 467    vbuf->stage.reset_stipple_counter = vbuf_reset_stipple_counter;
 468    vbuf->stage.destroy = vbuf_destroy;
 469
 470    vbuf->render = render;
 471    vbuf->max_indices = MAX2(render->max_indices, UNDEFINED_VERTEX_ID-1);
 472
 473    vbuf->indices = (ushort *) align_malloc( vbuf->max_indices *
 474                                             sizeof(vbuf->indices[0]),
 475                                             16 );
 476    if (!vbuf->indices)
 477       goto fail;
 478
 479    vbuf->cache = translate_cache_create();
 480    if (!vbuf->cache)
 481       goto fail;
 482
 483
 484    vbuf->vertices = NULL;
 485    vbuf->vertex_ptr = vbuf->vertices;
 486
 487    return &vbuf->stage;
 488
 489  fail:
 490    if (vbuf)
 491       vbuf_destroy(&vbuf->stage);
 492
 493    return NULL;
 494 }