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].pad = 0;
 741    save->prims[0].start = 0;
 742    save->prims[0].count = 0;
 743    save->prims[0].num_instances = 1;
 744    save->prims[0].base_instance = 0;
 745    save->prim_count = 1;
 746 }
 747
 748
 749 /**
 750  * Called only when buffers are wrapped as the result of filling the
 751  * vertex_store struct.
 752  */
 753 static void
 754 wrap_filled_vertex(struct gl_context *ctx)
 755 {
 756    struct vbo_save_context *save = &vbo_context(ctx)->save;
 757    unsigned numComponents;
 758
 759    /* Emit a glEnd to close off the last vertex list.
 760     */
 761    wrap_buffers(ctx);
 762
 763    /* Copy stored stored vertices to start of new list.
 764     */
 765    assert(save->max_vert - save->vert_count > save->copied.nr);
 766
 767    numComponents = save->copied.nr * save->vertex_size;
 768    memcpy(save->buffer_ptr,
 769           save->copied.buffer,
 770           numComponents * sizeof(fi_type));
 771    save->buffer_ptr += numComponents;
 772    save->vert_count += save->copied.nr;
 773 }
 774
 775
 776 static void
 777 copy_to_current(struct gl_context *ctx)
 778 {
 779    struct vbo_save_context *save = &vbo_context(ctx)->save;
 780    GLbitfield64 enabled = save->enabled & (~BITFIELD64_BIT(VBO_ATTRIB_POS));
 781
 782    while (enabled) {
 783       const int i = u_bit_scan64(&enabled);
 784       assert(save->attrsz[i]);
 785
 786       if (save->attrtype[i] == GL_DOUBLE ||
 787           save->attrtype[i] == GL_UNSIGNED_INT64_ARB)
 788          memcpy(save->current[i], save->attrptr[i], save->attrsz[i] * sizeof(GLfloat));
 789       else
 790          COPY_CLEAN_4V_TYPE_AS_UNION(save->current[i], save->attrsz[i],
 791                                      save->attrptr[i], save->attrtype[i]);
 792    }
 793 }
 794
 795
 796 static void
 797 copy_from_current(struct gl_context *ctx)
 798 {
 799    struct vbo_save_context *save = &vbo_context(ctx)->save;
 800    GLbitfield64 enabled = save->enabled & (~BITFIELD64_BIT(VBO_ATTRIB_POS));
 801
 802    while (enabled) {
 803       const int i = u_bit_scan64(&enabled);
 804
 805       switch (save->attrsz[i]) {
 806       case 4:
 807          save->attrptr[i][3] = save->current[i][3];
 808       case 3:
 809          save->attrptr[i][2] = save->current[i][2];
 810       case 2:
 811          save->attrptr[i][1] = save->current[i][1];
 812       case 1:
 813          save->attrptr[i][0] = save->current[i][0];
 814          break;
 815       case 0:
 816          unreachable("Unexpected vertex attribute size");
 817       }
 818    }
 819 }
 820
 821
 822 /**
 823  * Called when we increase the size of a vertex attribute.  For example,
 824  * if we've seen one or more glTexCoord2f() calls and now we get a
 825  * glTexCoord3f() call.
 826  * Flush existing data, set new attrib size, replay copied vertices.
 827  */
 828 static void
 829 upgrade_vertex(struct gl_context *ctx, GLuint attr, GLuint newsz)
 830 {
 831    struct vbo_save_context *save = &vbo_context(ctx)->save;
 832    GLuint oldsz;
 833    GLuint i;
 834    fi_type *tmp;
 835
 836    /* Store the current run of vertices, and emit a GL_END.  Emit a
 837     * BEGIN in the new buffer.
 838     */
 839    if (save->vert_count)
 840       wrap_buffers(ctx);
 841    else
 842       assert(save->copied.nr == 0);
 843
 844    /* Do a COPY_TO_CURRENT to ensure back-copying works for the case
 845     * when the attribute already exists in the vertex and is having
 846     * its size increased.
 847     */
 848    copy_to_current(ctx);
 849
 850    /* Fix up sizes:
 851     */
 852    oldsz = save->attrsz[attr];
 853    save->attrsz[attr] = newsz;
 854    save->enabled |= BITFIELD64_BIT(attr);
 855
 856    save->vertex_size += newsz - oldsz;
 857    save->max_vert = ((VBO_SAVE_BUFFER_SIZE - save->vertex_store->used) /
 858                      save->vertex_size);
 859    save->vert_count = 0;
 860
 861    /* Recalculate all the attrptr[] values:
 862     */
 863    tmp = save->vertex;
 864    for (i = 0; i < VBO_ATTRIB_MAX; i++) {
 865       if (save->attrsz[i]) {
 866          save->attrptr[i] = tmp;
 867          tmp += save->attrsz[i];
 868       }
 869       else {
 870          save->attrptr[i] = NULL;       /* will not be dereferenced. */
 871       }
 872    }
 873
 874    /* Copy from current to repopulate the vertex with correct values.
 875     */
 876    copy_from_current(ctx);
 877
 878    /* Replay stored vertices to translate them to new format here.
 879     *
 880     * If there are copied vertices and the new (upgraded) attribute
 881     * has not been defined before, this list is somewhat degenerate,
 882     * and will need fixup at runtime.
 883     */
 884    if (save->copied.nr) {
 885       const fi_type *data = save->copied.buffer;
 886       fi_type *dest = save->buffer_map;
 887
 888       /* Need to note this and fix up at runtime (or loopback):
 889        */
 890       if (attr != VBO_ATTRIB_POS && save->currentsz[attr][0] == 0) {
 891          assert(oldsz == 0);
 892          save->dangling_attr_ref = GL_TRUE;
 893       }
 894
 895       for (i = 0; i < save->copied.nr; i++) {
 896          GLbitfield64 enabled = save->enabled;
 897          while (enabled) {
 898             const int j = u_bit_scan64(&enabled);
 899             assert(save->attrsz[j]);
 900             if (j == attr) {
 901                if (oldsz) {
 902                   COPY_CLEAN_4V_TYPE_AS_UNION(dest, oldsz, data,
 903                                               save->attrtype[j]);
 904                   data += oldsz;
 905                   dest += newsz;
 906                }
 907                else {
 908                   COPY_SZ_4V(dest, newsz, save->current[attr]);
 909                   dest += newsz;
 910                }
 911             }
 912             else {
 913                GLint sz = save->attrsz[j];
 914                COPY_SZ_4V(dest, sz, data);
 915                data += sz;
 916                dest += sz;
 917             }
 918          }
 919       }
 920
 921       save->buffer_ptr = dest;
 922       save->vert_count += save->copied.nr;
 923    }
 924 }
 925
 926
 927 /**
 928  * This is called when the size of a vertex attribute changes.
 929  * For example, after seeing one or more glTexCoord2f() calls we
 930  * get a glTexCoord4f() or glTexCoord1f() call.
 931  */
 932 static void
 933 fixup_vertex(struct gl_context *ctx, GLuint attr,
 934              GLuint sz, GLenum newType)
 935 {
 936    struct vbo_save_context *save = &vbo_context(ctx)->save;
 937
 938    if (sz > save->attrsz[attr] ||
 939        newType != save->attrtype[attr]) {
 940       /* New size is larger.  Need to flush existing vertices and get
 941        * an enlarged vertex format.
 942        */
 943       upgrade_vertex(ctx, attr, sz);
 944    }
 945    else if (sz < save->active_sz[attr]) {
 946       GLuint i;
 947       const fi_type *id = vbo_get_default_vals_as_union(save->attrtype[attr]);
 948
 949       /* New size is equal or smaller - just need to fill in some
 950        * zeros.
 951        */
 952       for (i = sz; i <= save->attrsz[attr]; i++)
 953          save->attrptr[attr][i - 1] = id[i - 1];
 954    }
 955
 956    save->active_sz[attr] = sz;
 957 }
 958
 959
 960 /**
 961  * Reset the current size of all vertex attributes to the default
 962  * value of 0.  This signals that we haven't yet seen any per-vertex
 963  * commands such as glNormal3f() or glTexCoord2f().
 964  */
 965 static void
 966 reset_vertex(struct gl_context *ctx)
 967 {
 968    struct vbo_save_context *save = &vbo_context(ctx)->save;
 969
 970    while (save->enabled) {
 971       const int i = u_bit_scan64(&save->enabled);
 972       assert(save->attrsz[i]);
 973       save->attrsz[i] = 0;
 974       save->active_sz[i] = 0;
 975    }
 976
 977    save->vertex_size = 0;
 978 }
 979
 980
 981 /**
 982  * If index=0, does glVertexAttrib*() alias glVertex() to emit a vertex?
 983  * It depends on a few things, including whether we're inside or outside
 984  * of glBegin/glEnd.
 985  */
 986 static inline bool
 987 is_vertex_position(const struct gl_context *ctx, GLuint index)
 988 {
 989    return (index == 0 &&
 990            _mesa_attr_zero_aliases_vertex(ctx) &&
 991            _mesa_inside_dlist_begin_end(ctx));
 992 }
 993
 994
 995
 996 #define ERROR(err)   _mesa_compile_error(ctx, err, __func__);
 997
 998
 999 /* Only one size for each attribute may be active at once.  Eg. if
1000  * Color3f is installed/active, then Color4f may not be, even if the
1001  * vertex actually contains 4 color coordinates.  This is because the
1002  * 3f version won't otherwise set color[3] to 1.0 -- this is the job
1003  * of the chooser function when switching between Color4f and Color3f.
1004  */
1005 #define ATTR_UNION(A, N, T, C, V0, V1, V2, V3)                  \
1006 do {                                                            \
1007    struct vbo_save_context *save = &vbo_context(ctx)->save;     \
1008    int sz = (sizeof(C) / sizeof(GLfloat));                      \
1009                                                                 \
1010    if (save->active_sz[A] != N)                                 \
1011       fixup_vertex(ctx, A, N * sz, T);                          \
1012                                                                 \
1013    {                                                            \
1014       C *dest = (C *)save->attrptr[A];                          \
1015       if (N>0) dest[0] = V0;                                    \
1016       if (N>1) dest[1] = V1;                                    \
1017       if (N>2) dest[2] = V2;                                    \
1018       if (N>3) dest[3] = V3;                                    \
1019       save->attrtype[A] = T;                                    \
1020    }                                                            \
1021                                                                 \
1022    if ((A) == 0) {                                              \
1023       GLuint i;                                                 \
1024                                                                 \
1025       for (i = 0; i < save->vertex_size; i++)                   \
1026          save->buffer_ptr[i] = save->vertex[i];                 \
1027                                                                 \
1028       save->buffer_ptr += save->vertex_size;                    \
1029                                                                 \
1030       if (++save->vert_count >= save->max_vert)                 \
1031          wrap_filled_vertex(ctx);                               \
1032    }                                                            \
1033 } while (0)
1034
1035 #define TAG(x) _save_##x
1036
1037 #include "vbo_attrib_tmp.h"
1038
1039
1040
1041 #define MAT( ATTR, N, face, params )                    \
1042 do {                                                    \
1043    if (face != GL_BACK)                                 \
1044       MAT_ATTR( ATTR, N, params ); /* front */          \
1045    if (face != GL_FRONT)                                \
1046       MAT_ATTR( ATTR + 1, N, params ); /* back */       \
1047 } while (0)
1048
1049
1050 /**
1051  * Save a glMaterial call found between glBegin/End.
1052  * glMaterial calls outside Begin/End are handled in dlist.c.
1053  */
1054 static void GLAPIENTRY
1055 _save_Materialfv(GLenum face, GLenum pname, const GLfloat *params)
1056 {
1057    GET_CURRENT_CONTEXT(ctx);
1058
1059    if (face != GL_FRONT && face != GL_BACK && face != GL_FRONT_AND_BACK) {
1060       _mesa_compile_error(ctx, GL_INVALID_ENUM, "glMaterial(face)");
1061       return;
1062    }
1063
1064    switch (pname) {
1065    case GL_EMISSION:
1066       MAT(VBO_ATTRIB_MAT_FRONT_EMISSION, 4, face, params);
1067       break;
1068    case GL_AMBIENT:
1069       MAT(VBO_ATTRIB_MAT_FRONT_AMBIENT, 4, face, params);
1070       break;
1071    case GL_DIFFUSE:
1072       MAT(VBO_ATTRIB_MAT_FRONT_DIFFUSE, 4, face, params);
1073       break;
1074    case GL_SPECULAR:
1075       MAT(VBO_ATTRIB_MAT_FRONT_SPECULAR, 4, face, params);
1076       break;
1077    case GL_SHININESS:
1078       if (*params < 0 || *params > ctx->Const.MaxShininess) {
1079          _mesa_compile_error(ctx, GL_INVALID_VALUE, "glMaterial(shininess)");
1080       }
1081       else {
1082          MAT(VBO_ATTRIB_MAT_FRONT_SHININESS, 1, face, params);
1083       }
1084       break;
1085    case GL_COLOR_INDEXES:
1086       MAT(VBO_ATTRIB_MAT_FRONT_INDEXES, 3, face, params);
1087       break;
1088    case GL_AMBIENT_AND_DIFFUSE:
1089       MAT(VBO_ATTRIB_MAT_FRONT_AMBIENT, 4, face, params);
1090       MAT(VBO_ATTRIB_MAT_FRONT_DIFFUSE, 4, face, params);
1091       break;
1092    default:
1093       _mesa_compile_error(ctx, GL_INVALID_ENUM, "glMaterial(pname)");
1094       return;
1095    }
1096 }
1097
1098
1099 /* Cope with EvalCoord/CallList called within a begin/end object:
1100  *     -- Flush current buffer
1101  *     -- Fallback to opcodes for the rest of the begin/end object.
1102  */
1103 static void
1104 dlist_fallback(struct gl_context *ctx)
1105 {
1106    struct vbo_save_context *save = &vbo_context(ctx)->save;
1107
1108    if (save->vert_count || save->prim_count) {
1109       if (save->prim_count > 0) {
1110          /* Close off in-progress primitive. */
1111          GLint i = save->prim_count - 1;
1112          save->prims[i].count = save->vert_count - save->prims[i].start;
1113       }
1114
1115       /* Need to replay this display list with loopback,
1116        * unfortunately, otherwise this primitive won't be handled
1117        * properly:
1118        */
1119       save->dangling_attr_ref = GL_TRUE;
1120
1121       compile_vertex_list(ctx);
1122    }
1123
1124    copy_to_current(ctx);
1125    reset_vertex(ctx);
1126    reset_counters(ctx);
1127    if (save->out_of_memory) {
1128       _mesa_install_save_vtxfmt(ctx, &save->vtxfmt_noop);
1129    }
1130    else {
1131       _mesa_install_save_vtxfmt(ctx, &ctx->ListState.ListVtxfmt);
1132    }
1133    ctx->Driver.SaveNeedFlush = GL_FALSE;
1134 }
1135
1136
1137 static void GLAPIENTRY
1138 _save_EvalCoord1f(GLfloat u)
1139 {
1140    GET_CURRENT_CONTEXT(ctx);
1141    dlist_fallback(ctx);
1142    CALL_EvalCoord1f(ctx->Save, (u));
1143 }
1144
1145 static void GLAPIENTRY
1146 _save_EvalCoord1fv(const GLfloat * v)
1147 {
1148    GET_CURRENT_CONTEXT(ctx);
1149    dlist_fallback(ctx);
1150    CALL_EvalCoord1fv(ctx->Save, (v));
1151 }
1152
1153 static void GLAPIENTRY
1154 _save_EvalCoord2f(GLfloat u, GLfloat v)
1155 {
1156    GET_CURRENT_CONTEXT(ctx);
1157    dlist_fallback(ctx);
1158    CALL_EvalCoord2f(ctx->Save, (u, v));
1159 }
1160
1161 static void GLAPIENTRY
1162 _save_EvalCoord2fv(const GLfloat * v)
1163 {
1164    GET_CURRENT_CONTEXT(ctx);
1165    dlist_fallback(ctx);
1166    CALL_EvalCoord2fv(ctx->Save, (v));
1167 }
1168
1169 static void GLAPIENTRY
1170 _save_EvalPoint1(GLint i)
1171 {
1172    GET_CURRENT_CONTEXT(ctx);
1173    dlist_fallback(ctx);
1174    CALL_EvalPoint1(ctx->Save, (i));
1175 }
1176
1177 static void GLAPIENTRY
1178 _save_EvalPoint2(GLint i, GLint j)
1179 {
1180    GET_CURRENT_CONTEXT(ctx);
1181    dlist_fallback(ctx);
1182    CALL_EvalPoint2(ctx->Save, (i, j));
1183 }
1184
1185 static void GLAPIENTRY
1186 _save_CallList(GLuint l)
1187 {
1188    GET_CURRENT_CONTEXT(ctx);
1189    dlist_fallback(ctx);
1190    CALL_CallList(ctx->Save, (l));
1191 }
1192
1193 static void GLAPIENTRY
1194 _save_CallLists(GLsizei n, GLenum type, const GLvoid * v)
1195 {
1196    GET_CURRENT_CONTEXT(ctx);
1197    dlist_fallback(ctx);
1198    CALL_CallLists(ctx->Save, (n, type, v));
1199 }
1200
1201
1202
1203 /**
1204  * Called when a glBegin is getting compiled into a display list.
1205  * Updating of ctx->Driver.CurrentSavePrimitive is already taken care of.
1206  */
1207 void
1208 vbo_save_NotifyBegin(struct gl_context *ctx, GLenum mode,
1209                      bool no_current_update)
1210 {
1211    struct vbo_save_context *save = &vbo_context(ctx)->save;
1212    const GLuint i = save->prim_count++;
1213
1214    ctx->Driver.CurrentSavePrimitive = mode;
1215
1216    assert(i < save->prim_max);
1217    save->prims[i].mode = mode & VBO_SAVE_PRIM_MODE_MASK;
1218    save->prims[i].begin = 1;
1219    save->prims[i].end = 0;
1220    save->prims[i].pad = 0;
1221    save->prims[i].start = save->vert_count;
1222    save->prims[i].count = 0;
1223    save->prims[i].num_instances = 1;
1224    save->prims[i].base_instance = 0;
1225
1226    save->no_current_update = no_current_update;
1227
1228    if (save->out_of_memory) {
1229       _mesa_install_save_vtxfmt(ctx, &save->vtxfmt_noop);
1230    }
1231    else {
1232       _mesa_install_save_vtxfmt(ctx, &save->vtxfmt);
1233    }
1234
1235    /* We need to call vbo_save_SaveFlushVertices() if there's state change */
1236    ctx->Driver.SaveNeedFlush = GL_TRUE;
1237 }
1238
1239
1240 static void GLAPIENTRY
1241 _save_End(void)
1242 {
1243    GET_CURRENT_CONTEXT(ctx);
1244    struct vbo_save_context *save = &vbo_context(ctx)->save;
1245    const GLint i = save->prim_count - 1;
1246
1247    ctx->Driver.CurrentSavePrimitive = PRIM_OUTSIDE_BEGIN_END;
1248    save->prims[i].end = 1;
1249    save->prims[i].count = (save->vert_count - save->prims[i].start);
1250
1251    if (i == (GLint) save->prim_max - 1) {
1252       compile_vertex_list(ctx);
1253       assert(save->copied.nr == 0);
1254    }
1255
1256    /* Swap out this vertex format while outside begin/end.  Any color,
1257     * etc. received between here and the next begin will be compiled
1258     * as opcodes.
1259     */
1260    if (save->out_of_memory) {
1261       _mesa_install_save_vtxfmt(ctx, &save->vtxfmt_noop);
1262    }
1263    else {
1264       _mesa_install_save_vtxfmt(ctx, &ctx->ListState.ListVtxfmt);
1265    }
1266 }
1267
1268
1269 static void GLAPIENTRY
1270 _save_Begin(GLenum mode)
1271 {
1272    GET_CURRENT_CONTEXT(ctx);
1273    (void) mode;
1274    _mesa_compile_error(ctx, GL_INVALID_OPERATION, "Recursive glBegin");
1275 }
1276
1277
1278 static void GLAPIENTRY
1279 _save_PrimitiveRestartNV(void)
1280 {
1281    GET_CURRENT_CONTEXT(ctx);
1282    struct vbo_save_context *save = &vbo_context(ctx)->save;
1283
1284    if (save->prim_count == 0) {
1285       /* We're not inside a glBegin/End pair, so calling glPrimitiverRestartNV
1286        * is an error.
1287        */
1288       _mesa_compile_error(ctx, GL_INVALID_OPERATION,
1289                           "glPrimitiveRestartNV called outside glBegin/End");
1290    } else {
1291       /* get current primitive mode */
1292       GLenum curPrim = save->prims[save->prim_count - 1].mode;
1293       bool no_current_update = save->no_current_update;
1294
1295       /* restart primitive */
1296       CALL_End(GET_DISPATCH(), ());
1297       vbo_save_NotifyBegin(ctx, curPrim, no_current_update);
1298    }
1299 }
1300
1301
1302 /* Unlike the functions above, these are to be hooked into the vtxfmt
1303  * maintained in ctx->ListState, active when the list is known or
1304  * suspected to be outside any begin/end primitive.
1305  * Note: OBE = Outside Begin/End
1306  */
1307 static void GLAPIENTRY
1308 _save_OBE_Rectf(GLfloat x1, GLfloat y1, GLfloat x2, GLfloat y2)
1309 {
1310    GET_CURRENT_CONTEXT(ctx);
1311    vbo_save_NotifyBegin(ctx, GL_QUADS, false);
1312    CALL_Vertex2f(GET_DISPATCH(), (x1, y1));
1313    CALL_Vertex2f(GET_DISPATCH(), (x2, y1));
1314    CALL_Vertex2f(GET_DISPATCH(), (x2, y2));
1315    CALL_Vertex2f(GET_DISPATCH(), (x1, y2));
1316    CALL_End(GET_DISPATCH(), ());
1317 }
1318
1319
1320 static void GLAPIENTRY
1321 _save_OBE_DrawArrays(GLenum mode, GLint start, GLsizei count)
1322 {
1323    GET_CURRENT_CONTEXT(ctx);
1324    struct gl_vertex_array_object *vao = ctx->Array.VAO;
1325    struct vbo_save_context *save = &vbo_context(ctx)->save;
1326    GLint i;
1327
1328    if (!_mesa_is_valid_prim_mode(ctx, mode)) {
1329       _mesa_compile_error(ctx, GL_INVALID_ENUM, "glDrawArrays(mode)");
1330       return;
1331    }
1332    if (count < 0) {
1333       _mesa_compile_error(ctx, GL_INVALID_VALUE, "glDrawArrays(count<0)");
1334       return;
1335    }
1336
1337    if (save->out_of_memory)
1338       return;
1339
1340    /* Make sure to process any VBO binding changes */
1341    _mesa_update_state(ctx);
1342
1343    _mesa_vao_map_arrays(ctx, vao, GL_MAP_READ_BIT);
1344
1345    vbo_save_NotifyBegin(ctx, mode, true);
1346
1347    for (i = 0; i < count; i++)
1348       _mesa_array_element(ctx, start + i);
1349    CALL_End(GET_DISPATCH(), ());
1350
1351    _mesa_vao_unmap_arrays(ctx, vao);
1352 }
1353
1354
1355 static void GLAPIENTRY
1356 _save_OBE_MultiDrawArrays(GLenum mode, const GLint *first,
1357                           const GLsizei *count, GLsizei primcount)
1358 {
1359    GET_CURRENT_CONTEXT(ctx);
1360    GLint i;
1361
1362    if (!_mesa_is_valid_prim_mode(ctx, mode)) {
1363       _mesa_compile_error(ctx, GL_INVALID_ENUM, "glMultiDrawArrays(mode)");
1364       return;
1365    }
1366
1367    if (primcount < 0) {
1368       _mesa_compile_error(ctx, GL_INVALID_VALUE,
1369                           "glMultiDrawArrays(primcount<0)");
1370       return;
1371    }
1372
1373    for (i = 0; i < primcount; i++) {
1374       if (count[i] < 0) {
1375          _mesa_compile_error(ctx, GL_INVALID_VALUE,
1376                              "glMultiDrawArrays(count[i]<0)");
1377          return;
1378       }
1379    }
1380
1381    for (i = 0; i < primcount; i++) {
1382       if (count[i] > 0) {
1383          _save_OBE_DrawArrays(mode, first[i], count[i]);
1384       }
1385    }
1386 }
1387
1388
1389 static void
1390 array_element(struct gl_context *ctx,
1391               GLint basevertex, GLuint elt, unsigned index_size)
1392 {
1393    /* Section 10.3.5 Primitive Restart:
1394     * [...]
1395     *    When one of the *BaseVertex drawing commands specified in section 10.5
1396     * is used, the primitive restart comparison occurs before the basevertex
1397     * offset is added to the array index.
1398     */
1399    /* If PrimitiveRestart is enabled and the index is the RestartIndex
1400     * then we call PrimitiveRestartNV and return.
1401     */
1402    if (ctx->Array._PrimitiveRestart &&
1403        elt == _mesa_primitive_restart_index(ctx, index_size)) {
1404       CALL_PrimitiveRestartNV(GET_DISPATCH(), ());
1405       return;
1406    }
1407
1408    _mesa_array_element(ctx, basevertex + elt);
1409 }
1410
1411
1412 /* Could do better by copying the arrays and element list intact and
1413  * then emitting an indexed prim at runtime.
1414  */
1415 static void GLAPIENTRY
1416 _save_OBE_DrawElementsBaseVertex(GLenum mode, GLsizei count, GLenum type,
1417                                  const GLvoid * indices, GLint basevertex)
1418 {
1419    GET_CURRENT_CONTEXT(ctx);
1420    struct vbo_save_context *save = &vbo_context(ctx)->save;
1421    struct gl_vertex_array_object *vao = ctx->Array.VAO;
1422    struct gl_buffer_object *indexbuf = vao->IndexBufferObj;
1423    GLint i;
1424
1425    if (!_mesa_is_valid_prim_mode(ctx, mode)) {
1426       _mesa_compile_error(ctx, GL_INVALID_ENUM, "glDrawElements(mode)");
1427       return;
1428    }
1429    if (count < 0) {
1430       _mesa_compile_error(ctx, GL_INVALID_VALUE, "glDrawElements(count<0)");
1431       return;
1432    }
1433    if (type != GL_UNSIGNED_BYTE &&
1434        type != GL_UNSIGNED_SHORT &&
1435        type != GL_UNSIGNED_INT) {
1436       _mesa_compile_error(ctx, GL_INVALID_VALUE, "glDrawElements(count<0)");
1437       return;
1438    }
1439
1440    if (save->out_of_memory)
1441       return;
1442
1443    /* Make sure to process any VBO binding changes */
1444    _mesa_update_state(ctx);
1445
1446    _mesa_vao_map(ctx, vao, GL_MAP_READ_BIT);
1447
1448    if (_mesa_is_bufferobj(indexbuf))
1449       indices =
1450          ADD_POINTERS(indexbuf->Mappings[MAP_INTERNAL].Pointer, indices);
1451
1452    vbo_save_NotifyBegin(ctx, mode, true);
1453
1454    switch (type) {
1455    case GL_UNSIGNED_BYTE:
1456       for (i = 0; i < count; i++)
1457          array_element(ctx, basevertex, ((GLubyte *) indices)[i], 1);
1458       break;
1459    case GL_UNSIGNED_SHORT:
1460       for (i = 0; i < count; i++)
1461          array_element(ctx, basevertex, ((GLushort *) indices)[i], 2);
1462       break;
1463    case GL_UNSIGNED_INT:
1464       for (i = 0; i < count; i++)
1465          array_element(ctx, basevertex, ((GLuint *) indices)[i], 4);
1466       break;
1467    default:
1468       _mesa_error(ctx, GL_INVALID_ENUM, "glDrawElements(type)");
1469       break;
1470    }
1471
1472    CALL_End(GET_DISPATCH(), ());
1473
1474    _mesa_vao_unmap(ctx, vao);
1475 }
1476
1477 static void GLAPIENTRY
1478 _save_OBE_DrawElements(GLenum mode, GLsizei count, GLenum type,
1479                        const GLvoid * indices)
1480 {
1481    _save_OBE_DrawElementsBaseVertex(mode, count, type, indices, 0);
1482 }
1483
1484
1485 static void GLAPIENTRY
1486 _save_OBE_DrawRangeElements(GLenum mode, GLuint start, GLuint end,
1487                             GLsizei count, GLenum type,
1488                             const GLvoid * indices)
1489 {
1490    GET_CURRENT_CONTEXT(ctx);
1491    struct vbo_save_context *save = &vbo_context(ctx)->save;
1492
1493    if (!_mesa_is_valid_prim_mode(ctx, mode)) {
1494       _mesa_compile_error(ctx, GL_INVALID_ENUM, "glDrawRangeElements(mode)");
1495       return;
1496    }
1497    if (count < 0) {
1498       _mesa_compile_error(ctx, GL_INVALID_VALUE,
1499                           "glDrawRangeElements(count<0)");
1500       return;
1501    }
1502    if (type != GL_UNSIGNED_BYTE &&
1503        type != GL_UNSIGNED_SHORT &&
1504        type != GL_UNSIGNED_INT) {
1505       _mesa_compile_error(ctx, GL_INVALID_ENUM, "glDrawRangeElements(type)");
1506       return;
1507    }
1508    if (end < start) {
1509       _mesa_compile_error(ctx, GL_INVALID_VALUE,
1510                           "glDrawRangeElements(end < start)");
1511       return;
1512    }
1513
1514    if (save->out_of_memory)
1515       return;
1516
1517    _save_OBE_DrawElements(mode, count, type, indices);
1518 }
1519
1520
1521 static void GLAPIENTRY
1522 _save_OBE_MultiDrawElements(GLenum mode, const GLsizei *count, GLenum type,
1523                             const GLvoid * const *indices, GLsizei primcount)
1524 {
1525    GLsizei i;
1526
1527    for (i = 0; i < primcount; i++) {
1528       if (count[i] > 0) {
1529          CALL_DrawElements(GET_DISPATCH(), (mode, count[i], type, indices[i]));
1530       }
1531    }
1532 }
1533
1534
1535 static void GLAPIENTRY
1536 _save_OBE_MultiDrawElementsBaseVertex(GLenum mode, const GLsizei *count,
1537                                       GLenum type,
1538                                       const GLvoid * const *indices,
1539                                       GLsizei primcount,
1540                                       const GLint *basevertex)
1541 {
1542    GLsizei i;
1543
1544    for (i = 0; i < primcount; i++) {
1545       if (count[i] > 0) {
1546          CALL_DrawElementsBaseVertex(GET_DISPATCH(), (mode, count[i], type,
1547                                                       indices[i],
1548                                                       basevertex[i]));
1549       }
1550    }
1551 }
1552
1553
1554 static void
1555 vtxfmt_init(struct gl_context *ctx)
1556 {
1557    struct vbo_save_context *save = &vbo_context(ctx)->save;
1558    GLvertexformat *vfmt = &save->vtxfmt;
1559
1560 #define NAME_AE(x) _ae_##x
1561 #define NAME_CALLLIST(x) _save_##x
1562 #define NAME(x) _save_##x
1563 #define NAME_ES(x) _save_##x##ARB
1564
1565 #include "vbo_init_tmp.h"
1566 }
1567
1568
1569 /**
1570  * Initialize the dispatch table with the VBO functions for display
1571  * list compilation.
1572  */
1573 void
1574 vbo_initialize_save_dispatch(const struct gl_context *ctx,
1575                              struct _glapi_table *exec)
1576 {
1577    SET_DrawArrays(exec, _save_OBE_DrawArrays);
1578    SET_MultiDrawArrays(exec, _save_OBE_MultiDrawArrays);
1579    SET_DrawElements(exec, _save_OBE_DrawElements);
1580    SET_DrawElementsBaseVertex(exec, _save_OBE_DrawElementsBaseVertex);
1581    SET_DrawRangeElements(exec, _save_OBE_DrawRangeElements);
1582    SET_MultiDrawElementsEXT(exec, _save_OBE_MultiDrawElements);
1583    SET_MultiDrawElementsBaseVertex(exec, _save_OBE_MultiDrawElementsBaseVertex);
1584    SET_Rectf(exec, _save_OBE_Rectf);
1585    /* Note: other glDraw functins aren't compiled into display lists */
1586 }
1587
1588
1589
1590 void
1591 vbo_save_SaveFlushVertices(struct gl_context *ctx)
1592 {
1593    struct vbo_save_context *save = &vbo_context(ctx)->save;
1594
1595    /* Noop when we are actually active:
1596     */
1597    if (ctx->Driver.CurrentSavePrimitive <= PRIM_MAX)
1598       return;
1599
1600    if (save->vert_count || save->prim_count)
1601       compile_vertex_list(ctx);
1602
1603    copy_to_current(ctx);
1604    reset_vertex(ctx);
1605    reset_counters(ctx);
1606    ctx->Driver.SaveNeedFlush = GL_FALSE;
1607 }
1608
1609
1610 /**
1611  * Called from glNewList when we're starting to compile a display list.
1612  */
1613 void
1614 vbo_save_NewList(struct gl_context *ctx, GLuint list, GLenum mode)
1615 {
1616    struct vbo_save_context *save = &vbo_context(ctx)->save;
1617
1618    (void) list;
1619    (void) mode;
1620
1621    if (!save->prim_store)
1622       save->prim_store = alloc_prim_store();
1623
1624    if (!save->vertex_store)
1625       save->vertex_store = alloc_vertex_store(ctx);
1626
1627    save->buffer_ptr = vbo_save_map_vertex_store(ctx, save->vertex_store);
1628
1629    reset_vertex(ctx);
1630    reset_counters(ctx);
1631    ctx->Driver.SaveNeedFlush = GL_FALSE;
1632 }
1633
1634
1635 /**
1636  * Called from glEndList when we're finished compiling a display list.
1637  */
1638 void
1639 vbo_save_EndList(struct gl_context *ctx)
1640 {
1641    struct vbo_save_context *save = &vbo_context(ctx)->save;
1642
1643    /* EndList called inside a (saved) Begin/End pair?
1644     */
1645    if (_mesa_inside_dlist_begin_end(ctx)) {
1646       if (save->prim_count > 0) {
1647          GLint i = save->prim_count - 1;
1648          ctx->Driver.CurrentSavePrimitive = PRIM_OUTSIDE_BEGIN_END;
1649          save->prims[i].end = 0;
1650          save->prims[i].count = save->vert_count - save->prims[i].start;
1651       }
1652
1653       /* Make sure this vertex list gets replayed by the "loopback"
1654        * mechanism:
1655        */
1656       save->dangling_attr_ref = GL_TRUE;
1657       vbo_save_SaveFlushVertices(ctx);
1658
1659       /* Swap out this vertex format while outside begin/end.  Any color,
1660        * etc. received between here and the next begin will be compiled
1661        * as opcodes.
1662        */
1663       _mesa_install_save_vtxfmt(ctx, &ctx->ListState.ListVtxfmt);
1664    }
1665
1666    vbo_save_unmap_vertex_store(ctx, save->vertex_store);
1667
1668    assert(save->vertex_size == 0);
1669 }
1670
1671
1672 /**
1673  * Called from the display list code when we're about to execute a
1674  * display list.
1675  */
1676 void
1677 vbo_save_BeginCallList(struct gl_context *ctx, struct gl_display_list *dlist)
1678 {
1679    struct vbo_save_context *save = &vbo_context(ctx)->save;
1680    save->replay_flags |= dlist->Flags;
1681 }
1682
1683
1684 /**
1685  * Called from the display list code when we're finished executing a
1686  * display list.
1687  */
1688 void
1689 vbo_save_EndCallList(struct gl_context *ctx)
1690 {
1691    struct vbo_save_context *save = &vbo_context(ctx)->save;
1692
1693    if (ctx->ListState.CallDepth == 1)
1694       save->replay_flags = 0;
1695 }
1696
1697
1698 /**
1699  * Called by display list code when a display list is being deleted.
1700  */
1701 static void
1702 vbo_destroy_vertex_list(struct gl_context *ctx, void *data)
1703 {
1704    struct vbo_save_vertex_list *node = (struct vbo_save_vertex_list *) data;
1705
1706    for (gl_vertex_processing_mode vpm = VP_MODE_FF; vpm < VP_MODE_MAX; ++vpm)
1707       _mesa_reference_vao(ctx, &node->VAO[vpm], NULL);
1708
1709    if (--node->prim_store->refcount == 0)
1710       free(node->prim_store);
1711
1712    free(node->current_data);
1713    node->current_data = NULL;
1714 }
1715
1716
1717 static void
1718 vbo_print_vertex_list(struct gl_context *ctx, void *data, FILE *f)
1719 {
1720    struct vbo_save_vertex_list *node = (struct vbo_save_vertex_list *) data;
1721    GLuint i;
1722    struct gl_buffer_object *buffer = node->VAO[0]->BufferBinding[0].BufferObj;
1723    const GLuint vertex_size = _vbo_save_get_stride(node)/sizeof(GLfloat);
1724    (void) ctx;
1725
1726    fprintf(f, "VBO-VERTEX-LIST, %u vertices, %d primitives, %d vertsize, "
1727            "buffer %p\n",
1728            node->vertex_count, node->prim_count, vertex_size,
1729            buffer);
1730
1731    for (i = 0; i < node->prim_count; i++) {
1732       struct _mesa_prim *prim = &node->prims[i];
1733       fprintf(f, "   prim %d: %s %d..%d %s %s\n",
1734              i,
1735              _mesa_lookup_prim_by_nr(prim->mode),
1736              prim->start,
1737              prim->start + prim->count,
1738              (prim->begin) ? "BEGIN" : "(wrap)",
1739              (prim->end) ? "END" : "(wrap)");
1740    }
1741 }
1742
1743
1744 /**
1745  * Called during context creation/init.
1746  */
1747 static void
1748 current_init(struct gl_context *ctx)
1749 {
1750    struct vbo_save_context *save = &vbo_context(ctx)->save;
1751    GLint i;
1752
1753    for (i = VBO_ATTRIB_POS; i <= VBO_ATTRIB_GENERIC15; i++) {
1754       const GLuint j = i - VBO_ATTRIB_POS;
1755       assert(j < VERT_ATTRIB_MAX);
1756       save->currentsz[i] = &ctx->ListState.ActiveAttribSize[j];
1757       save->current[i] = (fi_type *) ctx->ListState.CurrentAttrib[j];
1758    }
1759
1760    for (i = VBO_ATTRIB_FIRST_MATERIAL; i <= VBO_ATTRIB_LAST_MATERIAL; i++) {
1761       const GLuint j = i - VBO_ATTRIB_FIRST_MATERIAL;
1762       assert(j < MAT_ATTRIB_MAX);
1763       save->currentsz[i] = &ctx->ListState.ActiveMaterialSize[j];
1764       save->current[i] = (fi_type *) ctx->ListState.CurrentMaterial[j];
1765    }
1766 }
1767
1768
1769 /**
1770  * Initialize the display list compiler.  Called during context creation.
1771  */
1772 void
1773 vbo_save_api_init(struct vbo_save_context *save)
1774 {
1775    struct gl_context *ctx = save->ctx;
1776
1777    save->opcode_vertex_list =
1778       _mesa_dlist_alloc_opcode(ctx,
1779                                sizeof(struct vbo_save_vertex_list),
1780                                vbo_save_playback_vertex_list,
1781                                vbo_destroy_vertex_list,
1782                                vbo_print_vertex_list);
1783
1784    vtxfmt_init(ctx);
1785    current_init(ctx);
1786    _mesa_noop_vtxfmt_init(ctx, &save->vtxfmt_noop);
1787 }