src/mesa/vbo/vbo_save_api.c

   1 /**************************************************************************
   2
   3 Copyright 2002-2008 VMware, Inc.
   4
   5 All Rights Reserved.
   6
   7 Permission is hereby granted, free of charge, to any person obtaining a
   8 copy of this software and associated documentation files (the "Software"),
   9 to deal in the Software without restriction, including without limitation
  10 on the rights to use, copy, modify, merge, publish, distribute, sub
  11 license, and/or sell copies of the Software, and to permit persons to whom
  12 the Software is furnished to do so, subject to the following conditions:
  13
  14 The above copyright notice and this permission notice (including the next
  15 paragraph) shall be included in all copies or substantial portions of the
  16 Software.
  17
  18 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20 FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
  21 VMWARE AND/OR THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM,
  22 DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  23 OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  24 USE OR OTHER DEALINGS IN THE SOFTWARE.
  25
  26 **************************************************************************/
  27
  28 /*
  29  * Authors:
  30  *   Keith Whitwell <keithw@vmware.com>
  31  */
  32
  33
  34
  35 /* Display list compiler attempts to store lists of vertices with the
  36  * same vertex layout.  Additionally it attempts to minimize the need
  37  * for execute-time fixup of these vertex lists, allowing them to be
  38  * cached on hardware.
  39  *
  40  * There are still some circumstances where this can be thwarted, for
  41  * example by building a list that consists of one very long primitive
  42  * (eg Begin(Triangles), 1000 vertices, End), and calling that list
  43  * from inside a different begin/end object (Begin(Lines), CallList,
  44  * End).
  45  *
  46  * In that case the code will have to replay the list as individual
  47  * commands through the Exec dispatch table, or fix up the copied
  48  * vertices at execute-time.
  49  *
  50  * The other case where fixup is required is when a vertex attribute
  51  * is introduced in the middle of a primitive.  Eg:
  52  *  Begin(Lines)
  53  *  TexCoord1f()           Vertex2f()
  54  *  TexCoord1f() Color3f() Vertex2f()
  55  *  End()
  56  *
  57  *  If the current value of Color isn't known at compile-time, this
  58  *  primitive will require fixup.
  59  *
  60  *
  61  * The list compiler currently doesn't attempt to compile lists
  62  * containing EvalCoord or EvalPoint commands.  On encountering one of
  63  * these, compilation falls back to opcodes.
  64  *
  65  * This could be improved to fallback only when a mix of EvalCoord and
  66  * Vertex commands are issued within a single primitive.
  67  */
  68
  69
  70 #include "main/glheader.h"
  71 #include "main/arrayobj.h"
  72 #include "main/bufferobj.h"
  73 #include "main/context.h"
  74 #include "main/dlist.h"
  75 #include "main/enums.h"
  76 #include "main/eval.h"
  77 #include "main/macros.h"
  78 #include "main/draw_validate.h"
  79 #include "main/api_arrayelt.h"
  80 #include "main/vtxfmt.h"
  81 #include "main/dispatch.h"
  82 #include "main/state.h"
  83 #include "main/varray.h"
  84 #include "util/bitscan.h"
  85
  86 #include "vbo_noop.h"
  87 #include "vbo_private.h"
  88
  89
  90 #ifdef ERROR
  91 #undef ERROR
  92 #endif
  93
  94 /**
  95  * Display list flag only used by this VBO code.
  96  */
  97 #define DLIST_DANGLING_REFS     0x1
  98
  99
 100 /* An interesting VBO number/name to help with debugging */
 101 #define VBO_BUF_ID  12345
 102
 103
 104 /*
 105  * NOTE: Old 'parity' issue is gone, but copying can still be
 106  * wrong-footed on replay.
 107  */
 108 static GLuint
 109 copy_vertices(struct gl_context *ctx,
 110               const struct vbo_save_vertex_list *node,
 111               const fi_type * src_buffer)
 112 {
 113    struct vbo_save_context *save = &vbo_context(ctx)->save;
 114    const struct _mesa_prim *prim = &node->prims[node->prim_count - 1];
 115    GLuint nr = prim->count;
 116    GLuint sz = save->vertex_size;
 117    const fi_type *src = src_buffer + prim->start * sz;
 118    fi_type *dst = save->copied.buffer;
 119    GLuint ovf, i;
 120
 121    if (prim->end)
 122       return 0;
 123
 124    switch (prim->mode) {
 125    case GL_POINTS:
 126       return 0;
 127    case GL_LINES:
 128       ovf = nr & 1;
 129       for (i = 0; i < ovf; i++)
 130          memcpy(dst + i * sz, src + (nr - ovf + i) * sz,
 131                 sz * sizeof(GLfloat));
 132       return i;
 133    case GL_TRIANGLES:
 134       ovf = nr % 3;
 135       for (i = 0; i < ovf; i++)
 136          memcpy(dst + i * sz, src + (nr - ovf + i) * sz,
 137                 sz * sizeof(GLfloat));
 138       return i;
 139    case GL_QUADS:
 140       ovf = nr & 3;
 141       for (i = 0; i < ovf; i++)
 142          memcpy(dst + i * sz, src + (nr - ovf + i) * sz,
 143                 sz * sizeof(GLfloat));
 144       return i;
 145    case GL_LINE_STRIP:
 146       if (nr == 0)
 147          return 0;
 148       else {
 149          memcpy(dst, src + (nr - 1) * sz, sz * sizeof(GLfloat));
 150          return 1;
 151       }
 152    case GL_LINE_LOOP:
 153    case GL_TRIANGLE_FAN:
 154    case GL_POLYGON:
 155       if (nr == 0)
 156          return 0;
 157       else if (nr == 1) {
 158          memcpy(dst, src + 0, sz * sizeof(GLfloat));
 159          return 1;
 160       }
 161       else {
 162          memcpy(dst, src + 0, sz * sizeof(GLfloat));
 163          memcpy(dst + sz, src + (nr - 1) * sz, sz * sizeof(GLfloat));
 164          return 2;
 165       }
 166    case GL_TRIANGLE_STRIP:
 167    case GL_QUAD_STRIP:
 168       switch (nr) {
 169       case 0:
 170          ovf = 0;
 171          break;
 172       case 1:
 173          ovf = 1;
 174          break;
 175       default:
 176          ovf = 2 + (nr & 1);
 177          break;
 178       }
 179       for (i = 0; i < ovf; i++)
 180          memcpy(dst + i * sz, src + (nr - ovf + i) * sz,
 181                 sz * sizeof(GLfloat));
 182       return i;
 183    default:
 184       unreachable("Unexpected primitive type");
 185       return 0;
 186    }
 187 }
 188
 189
 190 static struct vbo_save_vertex_store *
 191 alloc_vertex_store(struct gl_context *ctx)
 192 {
 193    struct vbo_save_context *save = &vbo_context(ctx)->save;
 194    struct vbo_save_vertex_store *vertex_store =
 195       CALLOC_STRUCT(vbo_save_vertex_store);
 196
 197    /* obj->Name needs to be non-zero, but won't ever be examined more
 198     * closely than that.  In particular these buffers won't be entered
 199     * into the hash and can never be confused with ones visible to the
 200     * user.  Perhaps there could be a special number for internal
 201     * buffers:
 202     */
 203    vertex_store->bufferobj = ctx->Driver.NewBufferObject(ctx, VBO_BUF_ID);
 204    if (vertex_store->bufferobj) {
 205       save->out_of_memory =
 206          !ctx->Driver.BufferData(ctx,
 207                                  GL_ARRAY_BUFFER_ARB,
 208                                  VBO_SAVE_BUFFER_SIZE * sizeof(GLfloat),
 209                                  NULL, GL_STATIC_DRAW_ARB,
 210                                  GL_MAP_WRITE_BIT |
 211                                  GL_DYNAMIC_STORAGE_BIT,
 212                                  vertex_store->bufferobj);
 213    }
 214    else {
 215       save->out_of_memory = GL_TRUE;
 216    }
 217
 218    if (save->out_of_memory) {
 219       _mesa_error(ctx, GL_OUT_OF_MEMORY, "internal VBO allocation");
 220       _mesa_install_save_vtxfmt(ctx, &save->vtxfmt_noop);
 221    }
 222
 223    vertex_store->buffer_map = NULL;
 224    vertex_store->used = 0;
 225
 226    return vertex_store;
 227 }
 228
 229
 230 static void
 231 free_vertex_store(struct gl_context *ctx,
 232                   struct vbo_save_vertex_store *vertex_store)
 233 {
 234    assert(!vertex_store->buffer_map);
 235
 236    if (vertex_store->bufferobj) {
 237       _mesa_reference_buffer_object(ctx, &vertex_store->bufferobj, NULL);
 238    }
 239
 240    free(vertex_store);
 241 }
 242
 243
 244 fi_type *
 245 vbo_save_map_vertex_store(struct gl_context *ctx,
 246                           struct vbo_save_vertex_store *vertex_store)
 247 {
 248    const GLbitfield access = (GL_MAP_WRITE_BIT |
 249                               GL_MAP_INVALIDATE_RANGE_BIT |
 250                               GL_MAP_UNSYNCHRONIZED_BIT |
 251                               GL_MAP_FLUSH_EXPLICIT_BIT);
 252
 253    assert(vertex_store->bufferobj);
 254    assert(!vertex_store->buffer_map);  /* the buffer should not be mapped */
 255
 256    if (vertex_store->bufferobj->Size > 0) {
 257       /* Map the remaining free space in the VBO */
 258       GLintptr offset = vertex_store->used * sizeof(GLfloat);
 259       GLsizeiptr size = vertex_store->bufferobj->Size - offset;
 260       fi_type *range = (fi_type *)
 261          ctx->Driver.MapBufferRange(ctx, offset, size, access,
 262                                     vertex_store->bufferobj,
 263                                     MAP_INTERNAL);
 264       if (range) {
 265          /* compute address of start of whole buffer (needed elsewhere) */
 266          vertex_store->buffer_map = range - vertex_store->used;
 267          assert(vertex_store->buffer_map);
 268          return range;
 269       }
 270       else {
 271          vertex_store->buffer_map = NULL;
 272          return NULL;
 273       }
 274    }
 275    else {
 276       /* probably ran out of memory for buffers */
 277       return NULL;
 278    }
 279 }
 280
 281
 282 void
 283 vbo_save_unmap_vertex_store(struct gl_context *ctx,
 284                             struct vbo_save_vertex_store *vertex_store)
 285 {
 286    if (vertex_store->bufferobj->Size > 0) {
 287       GLintptr offset = 0;
 288       GLsizeiptr length = vertex_store->used * sizeof(GLfloat)
 289          - vertex_store->bufferobj->Mappings[MAP_INTERNAL].Offset;
 290
 291       /* Explicitly flush the region we wrote to */
 292       ctx->Driver.FlushMappedBufferRange(ctx, offset, length,
 293                                          vertex_store->bufferobj,
 294                                          MAP_INTERNAL);
 295
 296       ctx->Driver.UnmapBuffer(ctx, vertex_store->bufferobj, MAP_INTERNAL);
 297    }
 298    vertex_store->buffer_map = NULL;
 299 }
 300
 301
 302 static struct vbo_save_primitive_store *
 303 alloc_prim_store(void)
 304 {
 305    struct vbo_save_primitive_store *store =
 306       CALLOC_STRUCT(vbo_save_primitive_store);
 307    store->used = 0;
 308    store->refcount = 1;
 309    return store;
 310 }
 311
 312
 313 static void
 314 reset_counters(struct gl_context *ctx)
 315 {
 316    struct vbo_save_context *save = &vbo_context(ctx)->save;
 317
 318    save->prims = save->prim_store->prims + save->prim_store->used;
 319    save->buffer_map = save->vertex_store->buffer_map + save->vertex_store->used;
 320
 321    assert(save->buffer_map == save->buffer_ptr);
 322
 323    if (save->vertex_size)
 324       save->max_vert = (VBO_SAVE_BUFFER_SIZE - save->vertex_store->used) /
 325                         save->vertex_size;
 326    else
 327       save->max_vert = 0;
 328
 329    save->vert_count = 0;
 330    save->prim_count = 0;
 331    save->prim_max = VBO_SAVE_PRIM_SIZE - save->prim_store->used;
 332    save->dangling_attr_ref = GL_FALSE;
 333 }
 334
 335 /**
 336  * For a list of prims, try merging prims that can just be extensions of the
 337  * previous prim.
 338  */
 339 static void
 340 merge_prims(struct _mesa_prim *prim_list,
 341             GLuint *prim_count)
 342 {
 343    GLuint i;
 344    struct _mesa_prim *prev_prim = prim_list;
 345
 346    for (i = 1; i < *prim_count; i++) {
 347       struct _mesa_prim *this_prim = prim_list + i;
 348
 349       vbo_try_prim_conversion(this_prim);
 350
 351       if (vbo_can_merge_prims(prev_prim, this_prim)) {
 352          /* We've found a prim that just extend the previous one.  Tack it
 353           * onto the previous one, and let this primitive struct get dropped.
 354           */
 355          vbo_merge_prims(prev_prim, this_prim);
 356          continue;
 357       }
 358
 359       /* If any previous primitives have been dropped, then we need to copy
 360        * this later one into the next available slot.
 361        */
 362       prev_prim++;
 363       if (prev_prim != this_prim)
 364          *prev_prim = *this_prim;
 365    }
 366
 367    *prim_count = prev_prim - prim_list + 1;
 368 }
 369
 370
 371 /**
 372  * Convert GL_LINE_LOOP primitive into GL_LINE_STRIP so that drivers
 373  * don't have to worry about handling the _mesa_prim::begin/end flags.
 374  * See https://bugs.freedesktop.org/show_bug.cgi?id=81174
 375  */
 376 static void
 377 convert_line_loop_to_strip(struct vbo_save_context *save,
 378                            struct vbo_save_vertex_list *node)
 379 {
 380    struct _mesa_prim *prim = &node->prims[node->prim_count - 1];
 381
 382    assert(prim->mode == GL_LINE_LOOP);
 383
 384    if (prim->end) {
 385       /* Copy the 0th vertex to end of the buffer and extend the
 386        * vertex count by one to finish the line loop.
 387        */
 388       const GLuint sz = save->vertex_size;
 389       /* 0th vertex: */
 390       const fi_type *src = save->buffer_map + prim->start * sz;
 391       /* end of buffer: */
 392       fi_type *dst = save->buffer_map + (prim->start + prim->count) * sz;
 393
 394       memcpy(dst, src, sz * sizeof(float));
 395
 396       prim->count++;
 397       node->vertex_count++;
 398       save->vert_count++;
 399       save->buffer_ptr += sz;
 400       save->vertex_store->used += sz;
 401    }
 402
 403    if (!prim->begin) {
 404       /* Drawing the second or later section of a long line loop.
 405        * Skip the 0th vertex.
 406        */
 407       prim->start++;
 408       prim->count--;
 409    }
 410
 411    prim->mode = GL_LINE_STRIP;
 412 }
 413
 414
 415 /* Compare the present vao if it has the same setup. */
 416 static bool
 417 compare_vao(gl_vertex_processing_mode mode,
 418             const struct gl_vertex_array_object *vao,
 419             const struct gl_buffer_object *bo, GLintptr buffer_offset,
 420             GLuint stride, GLbitfield64 vao_enabled,
 421             const GLubyte size[VBO_ATTRIB_MAX],
 422             const GLenum16 type[VBO_ATTRIB_MAX],
 423             const GLuint offset[VBO_ATTRIB_MAX])
 424 {
 425    if (!vao)
 426       return false;
 427
 428    /* If the enabled arrays are not the same we are not equal. */
 429    if (vao_enabled != vao->Enabled)
 430       return false;
 431
 432    /* Check the buffer binding at 0 */
 433    if (vao->BufferBinding[0].BufferObj != bo)
 434       return false;
 435    /* BufferBinding[0].Offset != buffer_offset is checked per attribute */
 436    if (vao->BufferBinding[0].Stride != stride)
 437       return false;
 438    assert(vao->BufferBinding[0].InstanceDivisor == 0);
 439
 440    /* Retrieve the mapping from VBO_ATTRIB to VERT_ATTRIB space */
 441    const GLubyte *const vao_to_vbo_map = _vbo_attribute_alias_map[mode];
 442
 443    /* Now check the enabled arrays */
 444    GLbitfield mask = vao_enabled;
 445    while (mask) {
 446       const int attr = u_bit_scan(&mask);
 447       const unsigned char vbo_attr = vao_to_vbo_map[attr];
 448       const GLenum16 tp = type[vbo_attr];
 449       const GLintptr off = offset[vbo_attr] + buffer_offset;
 450       const struct gl_array_attributes *attrib = &vao->VertexAttrib[attr];
 451       if (attrib->RelativeOffset + vao->BufferBinding[0].Offset != off)
 452          return false;
 453       if (attrib->Format.Type != tp)
 454          return false;
 455       if (attrib->Format.Size != size[vbo_attr])
 456          return false;
 457       assert(attrib->Format.Format == GL_RGBA);
 458       assert(attrib->Format.Normalized == GL_FALSE);
 459       assert(attrib->Format.Integer == vbo_attrtype_to_integer_flag(tp));
 460       assert(attrib->Format.Doubles == vbo_attrtype_to_double_flag(tp));
 461       assert(attrib->BufferBindingIndex == 0);
 462    }
 463
 464    return true;
 465 }
 466
 467
 468 /* Create or reuse the vao for the vertex processing mode. */
 469 static void
 470 update_vao(struct gl_context *ctx,
 471            gl_vertex_processing_mode mode,
 472            struct gl_vertex_array_object **vao,
 473            struct gl_buffer_object *bo, GLintptr buffer_offset,
 474            GLuint stride, GLbitfield64 vbo_enabled,
 475            const GLubyte size[VBO_ATTRIB_MAX],
 476            const GLenum16 type[VBO_ATTRIB_MAX],
 477            const GLuint offset[VBO_ATTRIB_MAX])
 478 {
 479    /* Compute the bitmasks of vao_enabled arrays */
 480    GLbitfield vao_enabled = _vbo_get_vao_enabled_from_vbo(mode, vbo_enabled);
 481
 482    /*
 483     * Check if we can possibly reuse the exisiting one.
 484     * In the long term we should reset them when something changes.
 485     */
 486    if (compare_vao(mode, *vao, bo, buffer_offset, stride,
 487                    vao_enabled, size, type, offset))
 488       return;
 489
 490    /* The initial refcount is 1 */
 491    _mesa_reference_vao(ctx, vao, NULL);
 492    *vao = _mesa_new_vao(ctx, ~((GLuint)0));
 493
 494    /*
 495     * assert(stride <= ctx->Const.MaxVertexAttribStride);
 496     * MaxVertexAttribStride is not set for drivers that does not
 497     * expose GL 44 or GLES 31.
 498     */
 499
 500    /* Bind the buffer object at binding point 0 */
 501    _mesa_bind_vertex_buffer(ctx, *vao, 0, bo, buffer_offset, stride);
 502
 503    /* Retrieve the mapping from VBO_ATTRIB to VERT_ATTRIB space
 504     * Note that the position/generic0 aliasing is done in the VAO.
 505     */
 506    const GLubyte *const vao_to_vbo_map = _vbo_attribute_alias_map[mode];
 507    /* Now set the enable arrays */
 508    GLbitfield mask = vao_enabled;
 509    while (mask) {
 510       const int vao_attr = u_bit_scan(&mask);
 511       const GLubyte vbo_attr = vao_to_vbo_map[vao_attr];
 512       assert(offset[vbo_attr] <= ctx->Const.MaxVertexAttribRelativeOffset);
 513
 514       _vbo_set_attrib_format(ctx, *vao, vao_attr, buffer_offset,
 515                              size[vbo_attr], type[vbo_attr], offset[vbo_attr]);
 516       _mesa_vertex_attrib_binding(ctx, *vao, vao_attr, 0);
 517    }
 518    _mesa_enable_vertex_array_attribs(ctx, *vao, vao_enabled);
 519    assert(vao_enabled == (*vao)->Enabled);
 520    assert((vao_enabled & ~(*vao)->VertexAttribBufferMask) == 0);
 521
 522    /* Finalize and freeze the VAO */
 523    _mesa_set_vao_immutable(ctx, *vao);
 524 }
 525
 526
 527 /**
 528  * Insert the active immediate struct onto the display list currently
 529  * being built.
 530  */
 531 static void
 532 compile_vertex_list(struct gl_context *ctx)
 533 {
 534    struct vbo_save_context *save = &vbo_context(ctx)->save;
 535    struct vbo_save_vertex_list *node;
 536
 537    /* Allocate space for this structure in the display list currently
 538     * being compiled.
 539     */
 540    node = (struct vbo_save_vertex_list *)
 541       _mesa_dlist_alloc_aligned(ctx, save->opcode_vertex_list, sizeof(*node));
 542
 543    if (!node)
 544       return;
 545
 546    /* Make sure the pointer is aligned to the size of a pointer */
 547    assert((GLintptr) node % sizeof(void *) == 0);
 548
 549    /* Duplicate our template, increment refcounts to the storage structs:
 550     */
 551    GLintptr old_offset = 0;
 552    if (save->VAO[0]) {
 553       old_offset = save->VAO[0]->BufferBinding[0].Offset
 554          + save->VAO[0]->VertexAttrib[VERT_ATTRIB_POS].RelativeOffset;
 555    }
 556    const GLsizei stride = save->vertex_size*sizeof(GLfloat);
 557    GLintptr buffer_offset =
 558        (save->buffer_map - save->vertex_store->buffer_map) * sizeof(GLfloat);
 559    assert(old_offset <= buffer_offset);
 560    const GLintptr offset_diff = buffer_offset - old_offset;
 561    GLuint start_offset = 0;
 562    if (offset_diff > 0 && stride > 0 && offset_diff % stride == 0) {
 563       /* The vertex size is an exact multiple of the buffer offset.
 564        * This means that we can use zero-based vertex attribute pointers
 565        * and specify the start of the primitive with the _mesa_prim::start
 566        * field.  This results in issuing several draw calls with identical
 567        * vertex attribute information.  This can result in fewer state
 568        * changes in drivers.  In particular, the Gallium CSO module will
 569        * filter out redundant vertex buffer changes.
 570        */
 571       /* We cannot immediately update the primitives as some methods below
 572        * still need the uncorrected start vertices
 573        */
 574       start_offset = offset_diff/stride;
 575       assert(old_offset == buffer_offset - offset_diff);
 576       buffer_offset = old_offset;
 577    }
 578    GLuint offsets[VBO_ATTRIB_MAX];
 579    for (unsigned i = 0, offset = 0; i < VBO_ATTRIB_MAX; ++i) {
 580       offsets[i] = offset;
 581       offset += save->attrsz[i] * sizeof(GLfloat);
 582    }
 583    node->vertex_count = save->vert_count;
 584    node->wrap_count = save->copied.nr;
 585    node->prims = save->prims;
 586    node->prim_count = save->prim_count;
 587    node->prim_store = save->prim_store;
 588
 589    /* Create a pair of VAOs for the possible VERTEX_PROCESSING_MODEs
 590     * Note that this may reuse the previous one of possible.
 591     */
 592    for (gl_vertex_processing_mode vpm = VP_MODE_FF; vpm < VP_MODE_MAX; ++vpm) {
 593       /* create or reuse the vao */
 594       update_vao(ctx, vpm, &save->VAO[vpm],
 595                  save->vertex_store->bufferobj, buffer_offset, stride,
 596                  save->enabled, save->attrsz, save->attrtype, offsets);
 597       /* Reference the vao in the dlist */
 598       node->VAO[vpm] = NULL;
 599       _mesa_reference_vao(ctx, &node->VAO[vpm], save->VAO[vpm]);
 600    }
 601
 602    node->prim_store->refcount++;
 603
 604    if (save->no_current_update) {
 605       node->current_data = NULL;
 606    }
 607    else {
 608       GLuint current_size = save->vertex_size - save->attrsz[0];
 609       node->current_data = NULL;
 610
 611       if (current_size) {
 612          node->current_data = malloc(current_size * sizeof(GLfloat));
 613          if (node->current_data) {
 614             const char *buffer = (const char *)save->buffer_map;
 615             unsigned attr_offset = save->attrsz[0] * sizeof(GLfloat);
 616             unsigned vertex_offset = 0;
 617
 618             if (node->vertex_count)
 619                vertex_offset = (node->vertex_count - 1) * stride;
 620
 621             memcpy(node->current_data, buffer + vertex_offset + attr_offset,
 622                    current_size * sizeof(GLfloat));
 623          } else {
 624             _mesa_error(ctx, GL_OUT_OF_MEMORY, "Current value allocation");
 625          }
 626       }
 627    }
 628
 629    assert(save->attrsz[VBO_ATTRIB_POS] != 0 || node->vertex_count == 0);
 630
 631    if (save->dangling_attr_ref)
 632       ctx->ListState.CurrentList->Flags |= DLIST_DANGLING_REFS;
 633
 634    save->vertex_store->used += save->vertex_size * node->vertex_count;
 635    save->prim_store->used += node->prim_count;
 636
 637    /* Copy duplicated vertices
 638     */
 639    save->copied.nr = copy_vertices(ctx, node, save->buffer_map);
 640
 641    if (node->prims[node->prim_count - 1].mode == GL_LINE_LOOP) {
 642       convert_line_loop_to_strip(save, node);
 643    }
 644
 645    merge_prims(node->prims, &node->prim_count);
 646
 647    /* Correct the primitive starts, we can only do this here as copy_vertices
 648     * and convert_line_loop_to_strip above consume the uncorrected starts.
 649     * On the other hand the _vbo_loopback_vertex_list call below needs the
 650     * primitves to be corrected already.
 651     */
 652    for (unsigned i = 0; i < node->prim_count; i++) {
 653       node->prims[i].start += start_offset;
 654    }
 655
 656    /* Deal with GL_COMPILE_AND_EXECUTE:
 657     */
 658    if (ctx->ExecuteFlag) {
 659       struct _glapi_table *dispatch = GET_DISPATCH();
 660
 661       _glapi_set_dispatch(ctx->Exec);
 662
 663       /* Note that the range of referenced vertices must be mapped already */
 664       _vbo_loopback_vertex_list(ctx, node);
 665
 666       _glapi_set_dispatch(dispatch);
 667    }
 668
 669    /* Decide whether the storage structs are full, or can be used for
 670     * the next vertex lists as well.
 671     */
 672    if (save->vertex_store->used >
 673        VBO_SAVE_BUFFER_SIZE - 16 * (save->vertex_size + 4)) {
 674
 675       /* Unmap old store:
 676        */
 677       vbo_save_unmap_vertex_store(ctx, save->vertex_store);
 678
 679       /* Release old reference:
 680        */
 681       free_vertex_store(ctx, save->vertex_store);
 682       save->vertex_store = NULL;
 683       /* When we have a new vbo, we will for sure need a new vao */
 684       for (gl_vertex_processing_mode vpm = 0; vpm < VP_MODE_MAX; ++vpm)
 685          _mesa_reference_vao(ctx, &save->VAO[vpm], NULL);
 686
 687       /* Allocate and map new store:
 688        */
 689       save->vertex_store = alloc_vertex_store(ctx);
 690       save->buffer_ptr = vbo_save_map_vertex_store(ctx, save->vertex_store);
 691       save->out_of_memory = save->buffer_ptr == NULL;
 692    }
 693    else {
 694       /* update buffer_ptr for next vertex */
 695       save->buffer_ptr = save->vertex_store->buffer_map
 696          + save->vertex_store->used;
 697    }
 698
 699    if (save->prim_store->used > VBO_SAVE_PRIM_SIZE - 6) {
 700       save->prim_store->refcount--;
 701       assert(save->prim_store->refcount != 0);
 702       save->prim_store = alloc_prim_store();
 703    }
 704
 705    /* Reset our structures for the next run of vertices:
 706     */
 707    reset_counters(ctx);
 708 }
 709
 710
 711 /**
 712  * This is called when we fill a vertex buffer before we hit a glEnd().
 713  * We
 714  * TODO -- If no new vertices have been stored, don't bother saving it.
 715  */
 716 static void
 717 wrap_buffers(struct gl_context *ctx)
 718 {
 719    struct vbo_save_context *save = &vbo_context(ctx)->save;
 720    GLint i = save->prim_count - 1;
 721    GLenum mode;
 722
 723    assert(i < (GLint) save->prim_max);
 724    assert(i >= 0);
 725
 726    /* Close off in-progress primitive.
 727     */
 728    save->prims[i].count = (save->vert_count - save->prims[i].start);
 729    mode = save->prims[i].mode;
 730
 731    /* store the copied vertices, and allocate a new list.
 732     */
 733    compile_vertex_list(ctx);
 734
 735    /* Restart interrupted primitive
 736     */
 737    save->prims[0].mode = mode;
 738    save->prims[0].begin = 0;
 739    save->prims[0].end = 0;
 740    save->prims[0].start = 0;
 741    save->prims[0].count = 0;
 742    save->prims[0].num_instances = 1;
 743    save->prims[0].base_instance = 0;
 744    save->prim_count = 1;
 745 }
 746
 747
 748 /**
 749  * Called only when buffers are wrapped as the result of filling the
 750  * vertex_store struct.
 751  */
 752 static void
 753 wrap_filled_vertex(struct gl_context *ctx)
 754 {
 755    struct vbo_save_context *save = &vbo_context(ctx)->save;
 756    unsigned numComponents;
 757
 758    /* Emit a glEnd to close off the last vertex list.
 759     */
 760    wrap_buffers(ctx);
 761
 762    /* Copy stored stored vertices to start of new list.
 763     */
 764    assert(save->max_vert - save->vert_count > save->copied.nr);
 765
 766    numComponents = save->copied.nr * save->vertex_size;
 767    memcpy(save->buffer_ptr,
 768           save->copied.buffer,
 769           numComponents * sizeof(fi_type));
 770    save->buffer_ptr += numComponents;
 771    save->vert_count += save->copied.nr;
 772 }
 773
 774
 775 static void
 776 copy_to_current(struct gl_context *ctx)
 777 {
 778    struct vbo_save_context *save = &vbo_context(ctx)->save;
 779    GLbitfield64 enabled = save->enabled & (~BITFIELD64_BIT(VBO_ATTRIB_POS));
 780
 781    while (enabled) {
 782       const int i = u_bit_scan64(&enabled);
 783       assert(save->attrsz[i]);
 784
 785       if (save->attrtype[i] == GL_DOUBLE ||
 786           save->attrtype[i] == GL_UNSIGNED_INT64_ARB)
 787          memcpy(save->current[i], save->attrptr[i], save->attrsz[i] * sizeof(GLfloat));
 788       else
 789          COPY_CLEAN_4V_TYPE_AS_UNION(save->current[i], save->attrsz[i],
 790                                      save->attrptr[i], save->attrtype[i]);
 791    }
 792 }
 793
 794
 795 static void
 796 copy_from_current(struct gl_context *ctx)
 797 {
 798    struct vbo_save_context *save = &vbo_context(ctx)->save;
 799    GLbitfield64 enabled = save->enabled & (~BITFIELD64_BIT(VBO_ATTRIB_POS));
 800
 801    while (enabled) {
 802       const int i = u_bit_scan64(&enabled);
 803
 804       switch (save->attrsz[i]) {
 805       case 4:
 806          save->attrptr[i][3] = save->current[i][3];
 807       case 3:
 808          save->attrptr[i][2] = save->current[i][2];
 809       case 2:
 810          save->attrptr[i][1] = save->current[i][1];
 811       case 1:
 812          save->attrptr[i][0] = save->current[i][0];
 813          break;
 814       case 0:
 815          unreachable("Unexpected vertex attribute size");
 816       }
 817    }
 818 }
 819
 820
 821 /**
 822  * Called when we increase the size of a vertex attribute.  For example,
 823  * if we've seen one or more glTexCoord2f() calls and now we get a
 824  * glTexCoord3f() call.
 825  * Flush existing data, set new attrib size, replay copied vertices.
 826  */
 827 static void
 828 upgrade_vertex(struct gl_context *ctx, GLuint attr, GLuint newsz)
 829 {
 830    struct vbo_save_context *save = &vbo_context(ctx)->save;
 831    GLuint oldsz;
 832    GLuint i;
 833    fi_type *tmp;
 834
 835    /* Store the current run of vertices, and emit a GL_END.  Emit a
 836     * BEGIN in the new buffer.
 837     */
 838    if (save->vert_count)
 839       wrap_buffers(ctx);
 840    else
 841       assert(save->copied.nr == 0);
 842
 843    /* Do a COPY_TO_CURRENT to ensure back-copying works for the case
 844     * when the attribute already exists in the vertex and is having
 845     * its size increased.
 846     */
 847    copy_to_current(ctx);
 848
 849    /* Fix up sizes:
 850     */
 851    oldsz = save->attrsz[attr];
 852    save->attrsz[attr] = newsz;
 853    save->enabled |= BITFIELD64_BIT(attr);
 854
 855    save->vertex_size += newsz - oldsz;
 856    save->max_vert = ((VBO_SAVE_BUFFER_SIZE - save->vertex_store->used) /
 857                      save->vertex_size);
 858    save->vert_count = 0;
 859
 860    /* Recalculate all the attrptr[] values:
 861     */
 862    tmp = save->vertex;
 863    for (i = 0; i < VBO_ATTRIB_MAX; i++) {
 864       if (save->attrsz[i]) {
 865          save->attrptr[i] = tmp;
 866          tmp += save->attrsz[i];
 867       }
 868       else {
 869          save->attrptr[i] = NULL;       /* will not be dereferenced. */
 870       }
 871    }
 872
 873    /* Copy from current to repopulate the vertex with correct values.
 874     */
 875    copy_from_current(ctx);
 876
 877    /* Replay stored vertices to translate them to new format here.
 878     *
 879     * If there are copied vertices and the new (upgraded) attribute
 880     * has not been defined before, this list is somewhat degenerate,
 881     * and will need fixup at runtime.
 882     */
 883    if (save->copied.nr) {
 884       const fi_type *data = save->copied.buffer;
 885       fi_type *dest = save->buffer_map;
 886
 887       /* Need to note this and fix up at runtime (or loopback):
 888        */
 889       if (attr != VBO_ATTRIB_POS && save->currentsz[attr][0] == 0) {
 890          assert(oldsz == 0);
 891          save->dangling_attr_ref = GL_TRUE;
 892       }
 893
 894       for (i = 0; i < save->copied.nr; i++) {
 895          GLbitfield64 enabled = save->enabled;
 896          while (enabled) {
 897             const int j = u_bit_scan64(&enabled);
 898             assert(save->attrsz[j]);
 899             if (j == attr) {
 900                if (oldsz) {
 901                   COPY_CLEAN_4V_TYPE_AS_UNION(dest, oldsz, data,
 902                                               save->attrtype[j]);
 903                   data += oldsz;
 904                   dest += newsz;
 905                }
 906                else {
 907                   COPY_SZ_4V(dest, newsz, save->current[attr]);
 908                   dest += newsz;
 909                }
 910             }
 911             else {
 912                GLint sz = save->attrsz[j];
 913                COPY_SZ_4V(dest, sz, data);
 914                data += sz;
 915                dest += sz;
 916             }
 917          }
 918       }
 919
 920       save->buffer_ptr = dest;
 921       save->vert_count += save->copied.nr;
 922    }
 923 }
 924
 925
 926 /**
 927  * This is called when the size of a vertex attribute changes.
 928  * For example, after seeing one or more glTexCoord2f() calls we
 929  * get a glTexCoord4f() or glTexCoord1f() call.
 930  */
 931 static void
 932 fixup_vertex(struct gl_context *ctx, GLuint attr,
 933              GLuint sz, GLenum newType)
 934 {
 935    struct vbo_save_context *save = &vbo_context(ctx)->save;
 936
 937    if (sz > save->attrsz[attr] ||
 938        newType != save->attrtype[attr]) {
 939       /* New size is larger.  Need to flush existing vertices and get
 940        * an enlarged vertex format.
 941        */
 942       upgrade_vertex(ctx, attr, sz);
 943    }
 944    else if (sz < save->active_sz[attr]) {
 945       GLuint i;
 946       const fi_type *id = vbo_get_default_vals_as_union(save->attrtype[attr]);
 947
 948       /* New size is equal or smaller - just need to fill in some
 949        * zeros.
 950        */
 951       for (i = sz; i <= save->attrsz[attr]; i++)
 952          save->attrptr[attr][i - 1] = id[i - 1];
 953    }
 954
 955    save->active_sz[attr] = sz;
 956 }
 957
 958
 959 /**
 960  * Reset the current size of all vertex attributes to the default
 961  * value of 0.  This signals that we haven't yet seen any per-vertex
 962  * commands such as glNormal3f() or glTexCoord2f().
 963  */
 964 static void
 965 reset_vertex(struct gl_context *ctx)
 966 {
 967    struct vbo_save_context *save = &vbo_context(ctx)->save;
 968
 969    while (save->enabled) {
 970       const int i = u_bit_scan64(&save->enabled);
 971       assert(save->attrsz[i]);
 972       save->attrsz[i] = 0;
 973       save->active_sz[i] = 0;
 974    }
 975
 976    save->vertex_size = 0;
 977 }
 978
 979
 980 /**
 981  * If index=0, does glVertexAttrib*() alias glVertex() to emit a vertex?
 982  * It depends on a few things, including whether we're inside or outside
 983  * of glBegin/glEnd.
 984  */
 985 static inline bool
 986 is_vertex_position(const struct gl_context *ctx, GLuint index)
 987 {
 988    return (index == 0 &&
 989            _mesa_attr_zero_aliases_vertex(ctx) &&
 990            _mesa_inside_dlist_begin_end(ctx));
 991 }
 992
 993
 994
 995 #define ERROR(err)   _mesa_compile_error(ctx, err, __func__);
 996
 997
 998 /* Only one size for each attribute may be active at once.  Eg. if
 999  * Color3f is installed/active, then Color4f may not be, even if the
1000  * vertex actually contains 4 color coordinates.  This is because the
1001  * 3f version won't otherwise set color[3] to 1.0 -- this is the job
1002  * of the chooser function when switching between Color4f and Color3f.
1003  */
1004 #define ATTR_UNION(A, N, T, C, V0, V1, V2, V3)                  \
1005 do {                                                            \
1006    struct vbo_save_context *save = &vbo_context(ctx)->save;     \
1007    int sz = (sizeof(C) / sizeof(GLfloat));                      \
1008                                                                 \
1009    if (save->active_sz[A] != N)                                 \
1010       fixup_vertex(ctx, A, N * sz, T);                          \
1011                                                                 \
1012    {                                                            \
1013       C *dest = (C *)save->attrptr[A];                          \
1014       if (N>0) dest[0] = V0;                                    \
1015       if (N>1) dest[1] = V1;                                    \
1016       if (N>2) dest[2] = V2;                                    \
1017       if (N>3) dest[3] = V3;                                    \
1018       save->attrtype[A] = T;                                    \
1019    }                                                            \
1020                                                                 \
1021    if ((A) == 0) {                                              \
1022       GLuint i;                                                 \
1023                                                                 \
1024       for (i = 0; i < save->vertex_size; i++)                   \
1025          save->buffer_ptr[i] = save->vertex[i];                 \
1026                                                                 \
1027       save->buffer_ptr += save->vertex_size;                    \
1028                                                                 \
1029       if (++save->vert_count >= save->max_vert)                 \
1030          wrap_filled_vertex(ctx);                               \
1031    }                                                            \
1032 } while (0)
1033
1034 #define TAG(x) _save_##x
1035
1036 #include "vbo_attrib_tmp.h"
1037
1038
1039
1040 #define MAT( ATTR, N, face, params )                    \
1041 do {                                                    \
1042    if (face != GL_BACK)                                 \
1043       MAT_ATTR( ATTR, N, params ); /* front */          \
1044    if (face != GL_FRONT)                                \
1045       MAT_ATTR( ATTR + 1, N, params ); /* back */       \
1046 } while (0)
1047
1048
1049 /**
1050  * Save a glMaterial call found between glBegin/End.
1051  * glMaterial calls outside Begin/End are handled in dlist.c.
1052  */
1053 static void GLAPIENTRY
1054 _save_Materialfv(GLenum face, GLenum pname, const GLfloat *params)
1055 {
1056    GET_CURRENT_CONTEXT(ctx);
1057
1058    if (face != GL_FRONT && face != GL_BACK && face != GL_FRONT_AND_BACK) {
1059       _mesa_compile_error(ctx, GL_INVALID_ENUM, "glMaterial(face)");
1060       return;
1061    }
1062
1063    switch (pname) {
1064    case GL_EMISSION:
1065       MAT(VBO_ATTRIB_MAT_FRONT_EMISSION, 4, face, params);
1066       break;
1067    case GL_AMBIENT:
1068       MAT(VBO_ATTRIB_MAT_FRONT_AMBIENT, 4, face, params);
1069       break;
1070    case GL_DIFFUSE:
1071       MAT(VBO_ATTRIB_MAT_FRONT_DIFFUSE, 4, face, params);
1072       break;
1073    case GL_SPECULAR:
1074       MAT(VBO_ATTRIB_MAT_FRONT_SPECULAR, 4, face, params);
1075       break;
1076    case GL_SHININESS:
1077       if (*params < 0 || *params > ctx->Const.MaxShininess) {
1078          _mesa_compile_error(ctx, GL_INVALID_VALUE, "glMaterial(shininess)");
1079       }
1080       else {
1081          MAT(VBO_ATTRIB_MAT_FRONT_SHININESS, 1, face, params);
1082       }
1083       break;
1084    case GL_COLOR_INDEXES:
1085       MAT(VBO_ATTRIB_MAT_FRONT_INDEXES, 3, face, params);
1086       break;
1087    case GL_AMBIENT_AND_DIFFUSE:
1088       MAT(VBO_ATTRIB_MAT_FRONT_AMBIENT, 4, face, params);
1089       MAT(VBO_ATTRIB_MAT_FRONT_DIFFUSE, 4, face, params);
1090       break;
1091    default:
1092       _mesa_compile_error(ctx, GL_INVALID_ENUM, "glMaterial(pname)");
1093       return;
1094    }
1095 }
1096
1097
1098 /* Cope with EvalCoord/CallList called within a begin/end object:
1099  *     -- Flush current buffer
1100  *     -- Fallback to opcodes for the rest of the begin/end object.
1101  */
1102 static void
1103 dlist_fallback(struct gl_context *ctx)
1104 {
1105    struct vbo_save_context *save = &vbo_context(ctx)->save;
1106
1107    if (save->vert_count || save->prim_count) {
1108       if (save->prim_count > 0) {
1109          /* Close off in-progress primitive. */
1110          GLint i = save->prim_count - 1;
1111          save->prims[i].count = save->vert_count - save->prims[i].start;
1112       }
1113
1114       /* Need to replay this display list with loopback,
1115        * unfortunately, otherwise this primitive won't be handled
1116        * properly:
1117        */
1118       save->dangling_attr_ref = GL_TRUE;
1119
1120       compile_vertex_list(ctx);
1121    }
1122
1123    copy_to_current(ctx);
1124    reset_vertex(ctx);
1125    reset_counters(ctx);
1126    if (save->out_of_memory) {
1127       _mesa_install_save_vtxfmt(ctx, &save->vtxfmt_noop);
1128    }
1129    else {
1130       _mesa_install_save_vtxfmt(ctx, &ctx->ListState.ListVtxfmt);
1131    }
1132    ctx->Driver.SaveNeedFlush = GL_FALSE;
1133 }
1134
1135
1136 static void GLAPIENTRY
1137 _save_EvalCoord1f(GLfloat u)
1138 {
1139    GET_CURRENT_CONTEXT(ctx);
1140    dlist_fallback(ctx);
1141    CALL_EvalCoord1f(ctx->Save, (u));
1142 }
1143
1144 static void GLAPIENTRY
1145 _save_EvalCoord1fv(const GLfloat * v)
1146 {
1147    GET_CURRENT_CONTEXT(ctx);
1148    dlist_fallback(ctx);
1149    CALL_EvalCoord1fv(ctx->Save, (v));
1150 }
1151
1152 static void GLAPIENTRY
1153 _save_EvalCoord2f(GLfloat u, GLfloat v)
1154 {
1155    GET_CURRENT_CONTEXT(ctx);
1156    dlist_fallback(ctx);
1157    CALL_EvalCoord2f(ctx->Save, (u, v));
1158 }
1159
1160 static void GLAPIENTRY
1161 _save_EvalCoord2fv(const GLfloat * v)
1162 {
1163    GET_CURRENT_CONTEXT(ctx);
1164    dlist_fallback(ctx);
1165    CALL_EvalCoord2fv(ctx->Save, (v));
1166 }
1167
1168 static void GLAPIENTRY
1169 _save_EvalPoint1(GLint i)
1170 {
1171    GET_CURRENT_CONTEXT(ctx);
1172    dlist_fallback(ctx);
1173    CALL_EvalPoint1(ctx->Save, (i));
1174 }
1175
1176 static void GLAPIENTRY
1177 _save_EvalPoint2(GLint i, GLint j)
1178 {
1179    GET_CURRENT_CONTEXT(ctx);
1180    dlist_fallback(ctx);
1181    CALL_EvalPoint2(ctx->Save, (i, j));
1182 }
1183
1184 static void GLAPIENTRY
1185 _save_CallList(GLuint l)
1186 {
1187    GET_CURRENT_CONTEXT(ctx);
1188    dlist_fallback(ctx);
1189    CALL_CallList(ctx->Save, (l));
1190 }
1191
1192 static void GLAPIENTRY
1193 _save_CallLists(GLsizei n, GLenum type, const GLvoid * v)
1194 {
1195    GET_CURRENT_CONTEXT(ctx);
1196    dlist_fallback(ctx);
1197    CALL_CallLists(ctx->Save, (n, type, v));
1198 }
1199
1200
1201
1202 /**
1203  * Called when a glBegin is getting compiled into a display list.
1204  * Updating of ctx->Driver.CurrentSavePrimitive is already taken care of.
1205  */
1206 void
1207 vbo_save_NotifyBegin(struct gl_context *ctx, GLenum mode,
1208                      bool no_current_update)
1209 {
1210    struct vbo_save_context *save = &vbo_context(ctx)->save;
1211    const GLuint i = save->prim_count++;
1212
1213    ctx->Driver.CurrentSavePrimitive = mode;
1214
1215    assert(i < save->prim_max);
1216    save->prims[i].mode = mode & VBO_SAVE_PRIM_MODE_MASK;
1217    save->prims[i].begin = 1;
1218    save->prims[i].end = 0;
1219    save->prims[i].start = save->vert_count;
1220    save->prims[i].count = 0;
1221    save->prims[i].num_instances = 1;
1222    save->prims[i].base_instance = 0;
1223
1224    save->no_current_update = no_current_update;
1225
1226    if (save->out_of_memory) {
1227       _mesa_install_save_vtxfmt(ctx, &save->vtxfmt_noop);
1228    }
1229    else {
1230       _mesa_install_save_vtxfmt(ctx, &save->vtxfmt);
1231    }
1232
1233    /* We need to call vbo_save_SaveFlushVertices() if there's state change */
1234    ctx->Driver.SaveNeedFlush = GL_TRUE;
1235 }
1236
1237
1238 static void GLAPIENTRY
1239 _save_End(void)
1240 {
1241    GET_CURRENT_CONTEXT(ctx);
1242    struct vbo_save_context *save = &vbo_context(ctx)->save;
1243    const GLint i = save->prim_count - 1;
1244
1245    ctx->Driver.CurrentSavePrimitive = PRIM_OUTSIDE_BEGIN_END;
1246    save->prims[i].end = 1;
1247    save->prims[i].count = (save->vert_count - save->prims[i].start);
1248
1249    if (i == (GLint) save->prim_max - 1) {
1250       compile_vertex_list(ctx);
1251       assert(save->copied.nr == 0);
1252    }
1253
1254    /* Swap out this vertex format while outside begin/end.  Any color,
1255     * etc. received between here and the next begin will be compiled
1256     * as opcodes.
1257     */
1258    if (save->out_of_memory) {
1259       _mesa_install_save_vtxfmt(ctx, &save->vtxfmt_noop);
1260    }
1261    else {
1262       _mesa_install_save_vtxfmt(ctx, &ctx->ListState.ListVtxfmt);
1263    }
1264 }
1265
1266
1267 static void GLAPIENTRY
1268 _save_Begin(GLenum mode)
1269 {
1270    GET_CURRENT_CONTEXT(ctx);
1271    (void) mode;
1272    _mesa_compile_error(ctx, GL_INVALID_OPERATION, "Recursive glBegin");
1273 }
1274
1275
1276 static void GLAPIENTRY
1277 _save_PrimitiveRestartNV(void)
1278 {
1279    GET_CURRENT_CONTEXT(ctx);
1280    struct vbo_save_context *save = &vbo_context(ctx)->save;
1281
1282    if (save->prim_count == 0) {
1283       /* We're not inside a glBegin/End pair, so calling glPrimitiverRestartNV
1284        * is an error.
1285        */
1286       _mesa_compile_error(ctx, GL_INVALID_OPERATION,
1287                           "glPrimitiveRestartNV called outside glBegin/End");
1288    } else {
1289       /* get current primitive mode */
1290       GLenum curPrim = save->prims[save->prim_count - 1].mode;
1291       bool no_current_update = save->no_current_update;
1292
1293       /* restart primitive */
1294       CALL_End(GET_DISPATCH(), ());
1295       vbo_save_NotifyBegin(ctx, curPrim, no_current_update);
1296    }
1297 }
1298
1299
1300 /* Unlike the functions above, these are to be hooked into the vtxfmt
1301  * maintained in ctx->ListState, active when the list is known or
1302  * suspected to be outside any begin/end primitive.
1303  * Note: OBE = Outside Begin/End
1304  */
1305 static void GLAPIENTRY
1306 _save_OBE_Rectf(GLfloat x1, GLfloat y1, GLfloat x2, GLfloat y2)
1307 {
1308    GET_CURRENT_CONTEXT(ctx);
1309    vbo_save_NotifyBegin(ctx, GL_QUADS, false);
1310    CALL_Vertex2f(GET_DISPATCH(), (x1, y1));
1311    CALL_Vertex2f(GET_DISPATCH(), (x2, y1));
1312    CALL_Vertex2f(GET_DISPATCH(), (x2, y2));
1313    CALL_Vertex2f(GET_DISPATCH(), (x1, y2));
1314    CALL_End(GET_DISPATCH(), ());
1315 }
1316
1317
1318 static void GLAPIENTRY
1319 _save_OBE_DrawArrays(GLenum mode, GLint start, GLsizei count)
1320 {
1321    GET_CURRENT_CONTEXT(ctx);
1322    struct gl_vertex_array_object *vao = ctx->Array.VAO;
1323    struct vbo_save_context *save = &vbo_context(ctx)->save;
1324    GLint i;
1325
1326    if (!_mesa_is_valid_prim_mode(ctx, mode)) {
1327       _mesa_compile_error(ctx, GL_INVALID_ENUM, "glDrawArrays(mode)");
1328       return;
1329    }
1330    if (count < 0) {
1331       _mesa_compile_error(ctx, GL_INVALID_VALUE, "glDrawArrays(count<0)");
1332       return;
1333    }
1334
1335    if (save->out_of_memory)
1336       return;
1337
1338    /* Make sure to process any VBO binding changes */
1339    _mesa_update_state(ctx);
1340
1341    _mesa_vao_map_arrays(ctx, vao, GL_MAP_READ_BIT);
1342
1343    vbo_save_NotifyBegin(ctx, mode, true);
1344
1345    for (i = 0; i < count; i++)
1346       _mesa_array_element(ctx, start + i);
1347    CALL_End(GET_DISPATCH(), ());
1348
1349    _mesa_vao_unmap_arrays(ctx, vao);
1350 }
1351
1352
1353 static void GLAPIENTRY
1354 _save_OBE_MultiDrawArrays(GLenum mode, const GLint *first,
1355                           const GLsizei *count, GLsizei primcount)
1356 {
1357    GET_CURRENT_CONTEXT(ctx);
1358    GLint i;
1359
1360    if (!_mesa_is_valid_prim_mode(ctx, mode)) {
1361       _mesa_compile_error(ctx, GL_INVALID_ENUM, "glMultiDrawArrays(mode)");
1362       return;
1363    }
1364
1365    if (primcount < 0) {
1366       _mesa_compile_error(ctx, GL_INVALID_VALUE,
1367                           "glMultiDrawArrays(primcount<0)");
1368       return;
1369    }
1370
1371    for (i = 0; i < primcount; i++) {
1372       if (count[i] < 0) {
1373          _mesa_compile_error(ctx, GL_INVALID_VALUE,
1374                              "glMultiDrawArrays(count[i]<0)");
1375          return;
1376       }
1377    }
1378
1379    for (i = 0; i < primcount; i++) {
1380       if (count[i] > 0) {
1381          _save_OBE_DrawArrays(mode, first[i], count[i]);
1382       }
1383    }
1384 }
1385
1386
1387 static void
1388 array_element(struct gl_context *ctx,
1389               GLint basevertex, GLuint elt, unsigned index_size)
1390 {
1391    /* Section 10.3.5 Primitive Restart:
1392     * [...]
1393     *    When one of the *BaseVertex drawing commands specified in section 10.5
1394     * is used, the primitive restart comparison occurs before the basevertex
1395     * offset is added to the array index.
1396     */
1397    /* If PrimitiveRestart is enabled and the index is the RestartIndex
1398     * then we call PrimitiveRestartNV and return.
1399     */
1400    if (ctx->Array._PrimitiveRestart &&
1401        elt == _mesa_primitive_restart_index(ctx, index_size)) {
1402       CALL_PrimitiveRestartNV(GET_DISPATCH(), ());
1403       return;
1404    }
1405
1406    _mesa_array_element(ctx, basevertex + elt);
1407 }
1408
1409
1410 /* Could do better by copying the arrays and element list intact and
1411  * then emitting an indexed prim at runtime.
1412  */
1413 static void GLAPIENTRY
1414 _save_OBE_DrawElementsBaseVertex(GLenum mode, GLsizei count, GLenum type,
1415                                  const GLvoid * indices, GLint basevertex)
1416 {
1417    GET_CURRENT_CONTEXT(ctx);
1418    struct vbo_save_context *save = &vbo_context(ctx)->save;
1419    struct gl_vertex_array_object *vao = ctx->Array.VAO;
1420    struct gl_buffer_object *indexbuf = vao->IndexBufferObj;
1421    GLint i;
1422
1423    if (!_mesa_is_valid_prim_mode(ctx, mode)) {
1424       _mesa_compile_error(ctx, GL_INVALID_ENUM, "glDrawElements(mode)");
1425       return;
1426    }
1427    if (count < 0) {
1428       _mesa_compile_error(ctx, GL_INVALID_VALUE, "glDrawElements(count<0)");
1429       return;
1430    }
1431    if (type != GL_UNSIGNED_BYTE &&
1432        type != GL_UNSIGNED_SHORT &&
1433        type != GL_UNSIGNED_INT) {
1434       _mesa_compile_error(ctx, GL_INVALID_VALUE, "glDrawElements(count<0)");
1435       return;
1436    }
1437
1438    if (save->out_of_memory)
1439       return;
1440
1441    /* Make sure to process any VBO binding changes */
1442    _mesa_update_state(ctx);
1443
1444    _mesa_vao_map(ctx, vao, GL_MAP_READ_BIT);
1445
1446    if (_mesa_is_bufferobj(indexbuf))
1447       indices =
1448          ADD_POINTERS(indexbuf->Mappings[MAP_INTERNAL].Pointer, indices);
1449
1450    vbo_save_NotifyBegin(ctx, mode, true);
1451
1452    switch (type) {
1453    case GL_UNSIGNED_BYTE:
1454       for (i = 0; i < count; i++)
1455          array_element(ctx, basevertex, ((GLubyte *) indices)[i], 1);
1456       break;
1457    case GL_UNSIGNED_SHORT:
1458       for (i = 0; i < count; i++)
1459          array_element(ctx, basevertex, ((GLushort *) indices)[i], 2);
1460       break;
1461    case GL_UNSIGNED_INT:
1462       for (i = 0; i < count; i++)
1463          array_element(ctx, basevertex, ((GLuint *) indices)[i], 4);
1464       break;
1465    default:
1466       _mesa_error(ctx, GL_INVALID_ENUM, "glDrawElements(type)");
1467       break;
1468    }
1469
1470    CALL_End(GET_DISPATCH(), ());
1471
1472    _mesa_vao_unmap(ctx, vao);
1473 }
1474
1475 static void GLAPIENTRY
1476 _save_OBE_DrawElements(GLenum mode, GLsizei count, GLenum type,
1477                        const GLvoid * indices)
1478 {
1479    _save_OBE_DrawElementsBaseVertex(mode, count, type, indices, 0);
1480 }
1481
1482
1483 static void GLAPIENTRY
1484 _save_OBE_DrawRangeElements(GLenum mode, GLuint start, GLuint end,
1485                             GLsizei count, GLenum type,
1486                             const GLvoid * indices)
1487 {
1488    GET_CURRENT_CONTEXT(ctx);
1489    struct vbo_save_context *save = &vbo_context(ctx)->save;
1490
1491    if (!_mesa_is_valid_prim_mode(ctx, mode)) {
1492       _mesa_compile_error(ctx, GL_INVALID_ENUM, "glDrawRangeElements(mode)");
1493       return;
1494    }
1495    if (count < 0) {
1496       _mesa_compile_error(ctx, GL_INVALID_VALUE,
1497                           "glDrawRangeElements(count<0)");
1498       return;
1499    }
1500    if (type != GL_UNSIGNED_BYTE &&
1501        type != GL_UNSIGNED_SHORT &&
1502        type != GL_UNSIGNED_INT) {
1503       _mesa_compile_error(ctx, GL_INVALID_ENUM, "glDrawRangeElements(type)");
1504       return;
1505    }
1506    if (end < start) {
1507       _mesa_compile_error(ctx, GL_INVALID_VALUE,
1508                           "glDrawRangeElements(end < start)");
1509       return;
1510    }
1511
1512    if (save->out_of_memory)
1513       return;
1514
1515    _save_OBE_DrawElements(mode, count, type, indices);
1516 }
1517
1518
1519 static void GLAPIENTRY
1520 _save_OBE_MultiDrawElements(GLenum mode, const GLsizei *count, GLenum type,
1521                             const GLvoid * const *indices, GLsizei primcount)
1522 {
1523    GLsizei i;
1524
1525    for (i = 0; i < primcount; i++) {
1526       if (count[i] > 0) {
1527          CALL_DrawElements(GET_DISPATCH(), (mode, count[i], type, indices[i]));
1528       }
1529    }
1530 }
1531
1532
1533 static void GLAPIENTRY
1534 _save_OBE_MultiDrawElementsBaseVertex(GLenum mode, const GLsizei *count,
1535                                       GLenum type,
1536                                       const GLvoid * const *indices,
1537                                       GLsizei primcount,
1538                                       const GLint *basevertex)
1539 {
1540    GLsizei i;
1541
1542    for (i = 0; i < primcount; i++) {
1543       if (count[i] > 0) {
1544          CALL_DrawElementsBaseVertex(GET_DISPATCH(), (mode, count[i], type,
1545                                                       indices[i],
1546                                                       basevertex[i]));
1547       }
1548    }
1549 }
1550
1551
1552 static void
1553 vtxfmt_init(struct gl_context *ctx)
1554 {
1555    struct vbo_save_context *save = &vbo_context(ctx)->save;
1556    GLvertexformat *vfmt = &save->vtxfmt;
1557
1558 #define NAME_AE(x) _ae_##x
1559 #define NAME_CALLLIST(x) _save_##x
1560 #define NAME(x) _save_##x
1561 #define NAME_ES(x) _save_##x##ARB
1562
1563 #include "vbo_init_tmp.h"
1564 }
1565
1566
1567 /**
1568  * Initialize the dispatch table with the VBO functions for display
1569  * list compilation.
1570  */
1571 void
1572 vbo_initialize_save_dispatch(const struct gl_context *ctx,
1573                              struct _glapi_table *exec)
1574 {
1575    SET_DrawArrays(exec, _save_OBE_DrawArrays);
1576    SET_MultiDrawArrays(exec, _save_OBE_MultiDrawArrays);
1577    SET_DrawElements(exec, _save_OBE_DrawElements);
1578    SET_DrawElementsBaseVertex(exec, _save_OBE_DrawElementsBaseVertex);
1579    SET_DrawRangeElements(exec, _save_OBE_DrawRangeElements);
1580    SET_MultiDrawElementsEXT(exec, _save_OBE_MultiDrawElements);
1581    SET_MultiDrawElementsBaseVertex(exec, _save_OBE_MultiDrawElementsBaseVertex);
1582    SET_Rectf(exec, _save_OBE_Rectf);
1583    /* Note: other glDraw functins aren't compiled into display lists */
1584 }
1585
1586
1587
1588 void
1589 vbo_save_SaveFlushVertices(struct gl_context *ctx)
1590 {
1591    struct vbo_save_context *save = &vbo_context(ctx)->save;
1592
1593    /* Noop when we are actually active:
1594     */
1595    if (ctx->Driver.CurrentSavePrimitive <= PRIM_MAX)
1596       return;
1597
1598    if (save->vert_count || save->prim_count)
1599       compile_vertex_list(ctx);
1600
1601    copy_to_current(ctx);
1602    reset_vertex(ctx);
1603    reset_counters(ctx);
1604    ctx->Driver.SaveNeedFlush = GL_FALSE;
1605 }
1606
1607
1608 /**
1609  * Called from glNewList when we're starting to compile a display list.
1610  */
1611 void
1612 vbo_save_NewList(struct gl_context *ctx, GLuint list, GLenum mode)
1613 {
1614    struct vbo_save_context *save = &vbo_context(ctx)->save;
1615
1616    (void) list;
1617    (void) mode;
1618
1619    if (!save->prim_store)
1620       save->prim_store = alloc_prim_store();
1621
1622    if (!save->vertex_store)
1623       save->vertex_store = alloc_vertex_store(ctx);
1624
1625    save->buffer_ptr = vbo_save_map_vertex_store(ctx, save->vertex_store);
1626
1627    reset_vertex(ctx);
1628    reset_counters(ctx);
1629    ctx->Driver.SaveNeedFlush = GL_FALSE;
1630 }
1631
1632
1633 /**
1634  * Called from glEndList when we're finished compiling a display list.
1635  */
1636 void
1637 vbo_save_EndList(struct gl_context *ctx)
1638 {
1639    struct vbo_save_context *save = &vbo_context(ctx)->save;
1640
1641    /* EndList called inside a (saved) Begin/End pair?
1642     */
1643    if (_mesa_inside_dlist_begin_end(ctx)) {
1644       if (save->prim_count > 0) {
1645          GLint i = save->prim_count - 1;
1646          ctx->Driver.CurrentSavePrimitive = PRIM_OUTSIDE_BEGIN_END;
1647          save->prims[i].end = 0;
1648          save->prims[i].count = save->vert_count - save->prims[i].start;
1649       }
1650
1651       /* Make sure this vertex list gets replayed by the "loopback"
1652        * mechanism:
1653        */
1654       save->dangling_attr_ref = GL_TRUE;
1655       vbo_save_SaveFlushVertices(ctx);
1656
1657       /* Swap out this vertex format while outside begin/end.  Any color,
1658        * etc. received between here and the next begin will be compiled
1659        * as opcodes.
1660        */
1661       _mesa_install_save_vtxfmt(ctx, &ctx->ListState.ListVtxfmt);
1662    }
1663
1664    vbo_save_unmap_vertex_store(ctx, save->vertex_store);
1665
1666    assert(save->vertex_size == 0);
1667 }
1668
1669
1670 /**
1671  * Called from the display list code when we're about to execute a
1672  * display list.
1673  */
1674 void
1675 vbo_save_BeginCallList(struct gl_context *ctx, struct gl_display_list *dlist)
1676 {
1677    struct vbo_save_context *save = &vbo_context(ctx)->save;
1678    save->replay_flags |= dlist->Flags;
1679 }
1680
1681
1682 /**
1683  * Called from the display list code when we're finished executing a
1684  * display list.
1685  */
1686 void
1687 vbo_save_EndCallList(struct gl_context *ctx)
1688 {
1689    struct vbo_save_context *save = &vbo_context(ctx)->save;
1690
1691    if (ctx->ListState.CallDepth == 1)
1692       save->replay_flags = 0;
1693 }
1694
1695
1696 /**
1697  * Called by display list code when a display list is being deleted.
1698  */
1699 static void
1700 vbo_destroy_vertex_list(struct gl_context *ctx, void *data)
1701 {
1702    struct vbo_save_vertex_list *node = (struct vbo_save_vertex_list *) data;
1703
1704    for (gl_vertex_processing_mode vpm = VP_MODE_FF; vpm < VP_MODE_MAX; ++vpm)
1705       _mesa_reference_vao(ctx, &node->VAO[vpm], NULL);
1706
1707    if (--node->prim_store->refcount == 0)
1708       free(node->prim_store);
1709
1710    free(node->current_data);
1711    node->current_data = NULL;
1712 }
1713
1714
1715 static void
1716 vbo_print_vertex_list(struct gl_context *ctx, void *data, FILE *f)
1717 {
1718    struct vbo_save_vertex_list *node = (struct vbo_save_vertex_list *) data;
1719    GLuint i;
1720    struct gl_buffer_object *buffer = node->VAO[0]->BufferBinding[0].BufferObj;
1721    const GLuint vertex_size = _vbo_save_get_stride(node)/sizeof(GLfloat);
1722    (void) ctx;
1723
1724    fprintf(f, "VBO-VERTEX-LIST, %u vertices, %d primitives, %d vertsize, "
1725            "buffer %p\n",
1726            node->vertex_count, node->prim_count, vertex_size,
1727            buffer);
1728
1729    for (i = 0; i < node->prim_count; i++) {
1730       struct _mesa_prim *prim = &node->prims[i];
1731       fprintf(f, "   prim %d: %s %d..%d %s %s\n",
1732              i,
1733              _mesa_lookup_prim_by_nr(prim->mode),
1734              prim->start,
1735              prim->start + prim->count,
1736              (prim->begin) ? "BEGIN" : "(wrap)",
1737              (prim->end) ? "END" : "(wrap)");
1738    }
1739 }
1740
1741
1742 /**
1743  * Called during context creation/init.
1744  */
1745 static void
1746 current_init(struct gl_context *ctx)
1747 {
1748    struct vbo_save_context *save = &vbo_context(ctx)->save;
1749    GLint i;
1750
1751    for (i = VBO_ATTRIB_POS; i <= VBO_ATTRIB_GENERIC15; i++) {
1752       const GLuint j = i - VBO_ATTRIB_POS;
1753       assert(j < VERT_ATTRIB_MAX);
1754       save->currentsz[i] = &ctx->ListState.ActiveAttribSize[j];
1755       save->current[i] = (fi_type *) ctx->ListState.CurrentAttrib[j];
1756    }
1757
1758    for (i = VBO_ATTRIB_FIRST_MATERIAL; i <= VBO_ATTRIB_LAST_MATERIAL; i++) {
1759       const GLuint j = i - VBO_ATTRIB_FIRST_MATERIAL;
1760       assert(j < MAT_ATTRIB_MAX);
1761       save->currentsz[i] = &ctx->ListState.ActiveMaterialSize[j];
1762       save->current[i] = (fi_type *) ctx->ListState.CurrentMaterial[j];
1763    }
1764 }
1765
1766
1767 /**
1768  * Initialize the display list compiler.  Called during context creation.
1769  */
1770 void
1771 vbo_save_api_init(struct vbo_save_context *save)
1772 {
1773    struct gl_context *ctx = save->ctx;
1774
1775    save->opcode_vertex_list =
1776       _mesa_dlist_alloc_opcode(ctx,
1777                                sizeof(struct vbo_save_vertex_list),
1778                                vbo_save_playback_vertex_list,
1779                                vbo_destroy_vertex_list,
1780                                vbo_print_vertex_list);
1781
1782    vtxfmt_init(ctx);
1783    current_init(ctx);
1784    _mesa_noop_vtxfmt_init(ctx, &save->vtxfmt_noop);
1785 }