src/mesa/main/transformfeedback.c

   1 /*
   2  * Mesa 3-D graphics library
   3  *
   4  * Copyright (C) 2010  VMware, Inc.  All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the "Software"),
   8  * to deal in the Software without restriction, including without limitation
   9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10  * and/or sell copies of the Software, and to permit persons to whom the
  11  * Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included
  14  * in all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  20  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  22  * OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24
  25
  26 /*
  27  * Transform feedback support.
  28  *
  29  * Authors:
  30  *   Brian Paul
  31  */
  32
  33
  34 #include "buffers.h"
  35 #include "context.h"
  36 #include "hash.h"
  37 #include "macros.h"
  38 #include "mtypes.h"
  39 #include "transformfeedback.h"
  40 #include "shaderapi.h"
  41 #include "shaderobj.h"
  42 #include "main/dispatch.h"
  43
  44 #include "program/prog_parameter.h"
  45
  46 struct using_program_tuple
  47 {
  48    struct gl_shader_program *shProg;
  49    bool found;
  50 };
  51
  52 static void
  53 active_xfb_object_references_program(GLuint key, void *data, void *user_data)
  54 {
  55    struct using_program_tuple *callback_data = user_data;
  56    struct gl_transform_feedback_object *obj = data;
  57    if (obj->Active && obj->shader_program == callback_data->shProg)
  58       callback_data->found = true;
  59 }
  60
  61 /**
  62  * Return true if any active transform feedback object is using a program.
  63  */
  64 bool
  65 _mesa_transform_feedback_is_using_program(struct gl_context *ctx,
  66                                           struct gl_shader_program *shProg)
  67 {
  68    struct using_program_tuple callback_data;
  69    callback_data.shProg = shProg;
  70    callback_data.found = false;
  71
  72    _mesa_HashWalk(ctx->TransformFeedback.Objects,
  73                   active_xfb_object_references_program, &callback_data);
  74
  75    /* Also check DefaultObject, as it's not in the Objects hash table. */
  76    active_xfb_object_references_program(0, ctx->TransformFeedback.DefaultObject,
  77                                         &callback_data);
  78
  79    return callback_data.found;
  80 }
  81
  82 /**
  83  * Do reference counting of transform feedback buffers.
  84  */
  85 static void
  86 reference_transform_feedback_object(struct gl_transform_feedback_object **ptr,
  87                                     struct gl_transform_feedback_object *obj)
  88 {
  89    if (*ptr == obj)
  90       return;
  91
  92    if (*ptr) {
  93       /* Unreference the old object */
  94       struct gl_transform_feedback_object *oldObj = *ptr;
  95
  96       assert(oldObj->RefCount > 0);
  97       oldObj->RefCount--;
  98
  99       if (oldObj->RefCount == 0) {
 100          GET_CURRENT_CONTEXT(ctx);
 101          if (ctx)
 102             ctx->Driver.DeleteTransformFeedback(ctx, oldObj);
 103       }
 104
 105       *ptr = NULL;
 106    }
 107    assert(!*ptr);
 108
 109    if (obj) {
 110       /* reference new object */
 111       if (obj->RefCount == 0) {
 112          _mesa_problem(NULL, "referencing deleted transform feedback object");
 113          *ptr = NULL;
 114       }
 115       else {
 116          obj->RefCount++;
 117          obj->EverBound = GL_TRUE;
 118          *ptr = obj;
 119       }
 120    }
 121 }
 122
 123
 124 /**
 125  * Check that all the buffer objects currently bound for transform
 126  * feedback actually exist.  Raise a GL_INVALID_OPERATION error if
 127  * any buffers are missing.
 128  * \return GL_TRUE for success, GL_FALSE if error
 129  */
 130 GLboolean
 131 _mesa_validate_transform_feedback_buffers(struct gl_context *ctx)
 132 {
 133    /* XXX to do */
 134    return GL_TRUE;
 135 }
 136
 137
 138
 139 /**
 140  * Per-context init for transform feedback.
 141  */
 142 void
 143 _mesa_init_transform_feedback(struct gl_context *ctx)
 144 {
 145    /* core mesa expects this, even a dummy one, to be available */
 146    assert(ctx->Driver.NewTransformFeedback);
 147
 148    ctx->TransformFeedback.DefaultObject =
 149       ctx->Driver.NewTransformFeedback(ctx, 0);
 150
 151    assert(ctx->TransformFeedback.DefaultObject->RefCount == 1);
 152
 153    reference_transform_feedback_object(&ctx->TransformFeedback.CurrentObject,
 154                                        ctx->TransformFeedback.DefaultObject);
 155
 156    assert(ctx->TransformFeedback.DefaultObject->RefCount == 2);
 157
 158    ctx->TransformFeedback.Objects = _mesa_NewHashTable();
 159
 160    _mesa_reference_buffer_object(ctx,
 161                                  &ctx->TransformFeedback.CurrentBuffer,
 162                                  ctx->Shared->NullBufferObj);
 163 }
 164
 165
 166
 167 /**
 168  * Callback for _mesa_HashDeleteAll().
 169  */
 170 static void
 171 delete_cb(GLuint key, void *data, void *userData)
 172 {
 173    struct gl_context *ctx = (struct gl_context *) userData;
 174    struct gl_transform_feedback_object *obj =
 175       (struct gl_transform_feedback_object *) data;
 176
 177    ctx->Driver.DeleteTransformFeedback(ctx, obj);
 178 }
 179
 180
 181 /**
 182  * Per-context free/clean-up for transform feedback.
 183  */
 184 void
 185 _mesa_free_transform_feedback(struct gl_context *ctx)
 186 {
 187    /* core mesa expects this, even a dummy one, to be available */
 188    assert(ctx->Driver.NewTransformFeedback);
 189
 190    _mesa_reference_buffer_object(ctx,
 191                                  &ctx->TransformFeedback.CurrentBuffer,
 192                                  NULL);
 193
 194    /* Delete all feedback objects */
 195    _mesa_HashDeleteAll(ctx->TransformFeedback.Objects, delete_cb, ctx);
 196    _mesa_DeleteHashTable(ctx->TransformFeedback.Objects);
 197
 198    /* Delete the default feedback object */
 199    assert(ctx->Driver.DeleteTransformFeedback);
 200    ctx->Driver.DeleteTransformFeedback(ctx,
 201                                        ctx->TransformFeedback.DefaultObject);
 202
 203    ctx->TransformFeedback.CurrentObject = NULL;
 204 }
 205
 206
 207 /** Initialize the fields of a gl_transform_feedback_object. */
 208 void
 209 _mesa_init_transform_feedback_object(struct gl_transform_feedback_object *obj,
 210                                      GLuint name)
 211 {
 212    if (!obj)
 213       return;
 214
 215    obj->Name = name;
 216    obj->RefCount = 1;
 217    obj->EverBound = GL_FALSE;
 218 }
 219
 220
 221 /** Default fallback for ctx->Driver.NewTransformFeedback() */
 222 static struct gl_transform_feedback_object *
 223 new_transform_feedback(struct gl_context *ctx, GLuint name)
 224 {
 225    struct gl_transform_feedback_object *obj;
 226    obj = CALLOC_STRUCT(gl_transform_feedback_object);
 227    _mesa_init_transform_feedback_object(obj, name);
 228    return obj;
 229 }
 230
 231 /** Default fallback for ctx->Driver.DeleteTransformFeedback() */
 232 static void
 233 delete_transform_feedback(struct gl_context *ctx,
 234                           struct gl_transform_feedback_object *obj)
 235 {
 236    GLuint i;
 237
 238    for (i = 0; i < ARRAY_SIZE(obj->Buffers); i++) {
 239       _mesa_reference_buffer_object(ctx, &obj->Buffers[i], NULL);
 240    }
 241
 242    free(obj->Label);
 243    free(obj);
 244 }
 245
 246
 247 /** Default fallback for ctx->Driver.BeginTransformFeedback() */
 248 static void
 249 begin_transform_feedback(struct gl_context *ctx, GLenum mode,
 250                          struct gl_transform_feedback_object *obj)
 251 {
 252    /* nop */
 253 }
 254
 255 /** Default fallback for ctx->Driver.EndTransformFeedback() */
 256 static void
 257 end_transform_feedback(struct gl_context *ctx,
 258                        struct gl_transform_feedback_object *obj)
 259 {
 260    /* nop */
 261 }
 262
 263 /** Default fallback for ctx->Driver.PauseTransformFeedback() */
 264 static void
 265 pause_transform_feedback(struct gl_context *ctx,
 266                          struct gl_transform_feedback_object *obj)
 267 {
 268    /* nop */
 269 }
 270
 271 /** Default fallback for ctx->Driver.ResumeTransformFeedback() */
 272 static void
 273 resume_transform_feedback(struct gl_context *ctx,
 274                           struct gl_transform_feedback_object *obj)
 275 {
 276    /* nop */
 277 }
 278
 279
 280 /**
 281  * Plug in default device driver functions for transform feedback.
 282  * Most drivers will override some/all of these.
 283  */
 284 void
 285 _mesa_init_transform_feedback_functions(struct dd_function_table *driver)
 286 {
 287    driver->NewTransformFeedback = new_transform_feedback;
 288    driver->DeleteTransformFeedback = delete_transform_feedback;
 289    driver->BeginTransformFeedback = begin_transform_feedback;
 290    driver->EndTransformFeedback = end_transform_feedback;
 291    driver->PauseTransformFeedback = pause_transform_feedback;
 292    driver->ResumeTransformFeedback = resume_transform_feedback;
 293 }
 294
 295
 296 /**
 297  * Fill in the correct Size value for each buffer in \c obj.
 298  *
 299  * From the GL 4.3 spec, section 6.1.1 ("Binding Buffer Objects to Indexed
 300  * Targets"):
 301  *
 302  *   BindBufferBase binds the entire buffer, even when the size of the buffer
 303  *   is changed after the binding is established. It is equivalent to calling
 304  *   BindBufferRange with offset zero, while size is determined by the size of
 305  *   the bound buffer at the time the binding is used.
 306  *
 307  *   Regardless of the size specified with BindBufferRange, or indirectly with
 308  *   BindBufferBase, the GL will never read or write beyond the end of a bound
 309  *   buffer. In some cases this constraint may result in visibly different
 310  *   behavior when a buffer overflow would otherwise result, such as described
 311  *   for transform feedback operations in section 13.2.2.
 312  */
 313 static void
 314 compute_transform_feedback_buffer_sizes(
 315       struct gl_transform_feedback_object *obj)
 316 {
 317    unsigned i = 0;
 318    for (i = 0; i < MAX_FEEDBACK_BUFFERS; ++i) {
 319       GLintptr offset = obj->Offset[i];
 320       GLsizeiptr buffer_size
 321          = obj->Buffers[i] == NULL ? 0 : obj->Buffers[i]->Size;
 322       GLsizeiptr available_space
 323          = buffer_size <= offset ? 0 : buffer_size - offset;
 324       GLsizeiptr computed_size;
 325       if (obj->RequestedSize[i] == 0) {
 326          /* No size was specified at the time the buffer was bound, so allow
 327           * writing to all available space in the buffer.
 328           */
 329          computed_size = available_space;
 330       } else {
 331          /* A size was specified at the time the buffer was bound, however
 332           * it's possible that the buffer has shrunk since then.  So only
 333           * allow writing to the minimum of the specified size and the space
 334           * available.
 335           */
 336          computed_size = MIN2(available_space, obj->RequestedSize[i]);
 337       }
 338
 339       /* Legal sizes must be multiples of four, so round down if necessary. */
 340       obj->Size[i] = computed_size & ~0x3;
 341    }
 342 }
 343
 344
 345 /**
 346  * Compute the maximum number of vertices that can be written to the currently
 347  * enabled transform feedback buffers without overflowing any of them.
 348  */
 349 unsigned
 350 _mesa_compute_max_transform_feedback_vertices(
 351       const struct gl_transform_feedback_object *obj,
 352       const struct gl_transform_feedback_info *info)
 353 {
 354    unsigned max_index = 0xffffffff;
 355    unsigned i;
 356
 357    for (i = 0; i < info->NumBuffers; ++i) {
 358       unsigned stride = info->BufferStride[i];
 359       unsigned max_for_this_buffer;
 360
 361       /* Skip any inactive buffers, which have a stride of 0. */
 362       if (stride == 0)
 363          continue;
 364
 365       max_for_this_buffer = obj->Size[i] / (4 * stride);
 366       max_index = MIN2(max_index, max_for_this_buffer);
 367    }
 368
 369    return max_index;
 370 }
 371
 372
 373 /**
 374  ** Begin API functions
 375  **/
 376
 377
 378 /**
 379  * Figure out which stage of the pipeline is the source of transform feedback
 380  * data given the current context state, and return its gl_shader_program.
 381  *
 382  * If no active program can generate transform feedback data (i.e. no vertex
 383  * shader is active), returns NULL.
 384  */
 385 static struct gl_shader_program *
 386 get_xfb_source(struct gl_context *ctx)
 387 {
 388    int i;
 389    for (i = MESA_SHADER_GEOMETRY; i >= MESA_SHADER_VERTEX; i--) {
 390       if (ctx->_Shader->CurrentProgram[i] != NULL)
 391          return ctx->_Shader->CurrentProgram[i];
 392    }
 393    return NULL;
 394 }
 395
 396
 397 void GLAPIENTRY
 398 _mesa_BeginTransformFeedback(GLenum mode)
 399 {
 400    struct gl_transform_feedback_object *obj;
 401    struct gl_transform_feedback_info *info = NULL;
 402    struct gl_shader_program *source;
 403    GLuint i;
 404    unsigned vertices_per_prim;
 405    GET_CURRENT_CONTEXT(ctx);
 406
 407    obj = ctx->TransformFeedback.CurrentObject;
 408
 409    /* Figure out what pipeline stage is the source of data for transform
 410     * feedback.
 411     */
 412    source = get_xfb_source(ctx);
 413    if (source == NULL) {
 414       _mesa_error(ctx, GL_INVALID_OPERATION,
 415                   "glBeginTransformFeedback(no program active)");
 416       return;
 417    }
 418
 419    info = &source->LinkedTransformFeedback;
 420
 421    if (info->NumOutputs == 0) {
 422       _mesa_error(ctx, GL_INVALID_OPERATION,
 423                   "glBeginTransformFeedback(no varyings to record)");
 424       return;
 425    }
 426
 427    switch (mode) {
 428    case GL_POINTS:
 429       vertices_per_prim = 1;
 430       break;
 431    case GL_LINES:
 432       vertices_per_prim = 2;
 433       break;
 434    case GL_TRIANGLES:
 435       vertices_per_prim = 3;
 436       break;
 437    default:
 438       _mesa_error(ctx, GL_INVALID_ENUM, "glBeginTransformFeedback(mode)");
 439       return;
 440    }
 441
 442    if (obj->Active) {
 443       _mesa_error(ctx, GL_INVALID_OPERATION,
 444                   "glBeginTransformFeedback(already active)");
 445       return;
 446    }
 447
 448    for (i = 0; i < info->NumBuffers; ++i) {
 449       if (obj->BufferNames[i] == 0) {
 450          _mesa_error(ctx, GL_INVALID_OPERATION,
 451                      "glBeginTransformFeedback(binding point %d does not have "
 452                      "a buffer object bound)", i);
 453          return;
 454       }
 455    }
 456
 457    FLUSH_VERTICES(ctx, 0);
 458    ctx->NewDriverState |= ctx->DriverFlags.NewTransformFeedback;
 459
 460    obj->Active = GL_TRUE;
 461    ctx->TransformFeedback.Mode = mode;
 462
 463    compute_transform_feedback_buffer_sizes(obj);
 464
 465    if (_mesa_is_gles3(ctx)) {
 466       /* In GLES3, we are required to track the usage of the transform
 467        * feedback buffer and report INVALID_OPERATION if a draw call tries to
 468        * exceed it.  So compute the maximum number of vertices that we can
 469        * write without overflowing any of the buffers currently being used for
 470        * feedback.
 471        */
 472       unsigned max_vertices
 473          = _mesa_compute_max_transform_feedback_vertices(obj, info);
 474       obj->GlesRemainingPrims = max_vertices / vertices_per_prim;
 475    }
 476
 477    if (obj->shader_program != source) {
 478       ctx->NewDriverState |= ctx->DriverFlags.NewTransformFeedbackProg;
 479       obj->shader_program = source;
 480    }
 481
 482    assert(ctx->Driver.BeginTransformFeedback);
 483    ctx->Driver.BeginTransformFeedback(ctx, mode, obj);
 484 }
 485
 486
 487 void GLAPIENTRY
 488 _mesa_EndTransformFeedback(void)
 489 {
 490    struct gl_transform_feedback_object *obj;
 491    GET_CURRENT_CONTEXT(ctx);
 492
 493    obj = ctx->TransformFeedback.CurrentObject;
 494
 495    if (!obj->Active) {
 496       _mesa_error(ctx, GL_INVALID_OPERATION,
 497                   "glEndTransformFeedback(not active)");
 498       return;
 499    }
 500
 501    FLUSH_VERTICES(ctx, 0);
 502    ctx->NewDriverState |= ctx->DriverFlags.NewTransformFeedback;
 503
 504    ctx->TransformFeedback.CurrentObject->Active = GL_FALSE;
 505    ctx->TransformFeedback.CurrentObject->Paused = GL_FALSE;
 506    ctx->TransformFeedback.CurrentObject->EndedAnytime = GL_TRUE;
 507
 508    assert(ctx->Driver.EndTransformFeedback);
 509    ctx->Driver.EndTransformFeedback(ctx, obj);
 510 }
 511
 512
 513 /**
 514  * Helper used by BindBufferRange() and BindBufferBase().
 515  */
 516 static void
 517 bind_buffer_range(struct gl_context *ctx,
 518                   struct gl_transform_feedback_object *obj,
 519                   GLuint index,
 520                   struct gl_buffer_object *bufObj,
 521                   GLintptr offset, GLsizeiptr size,
 522                   bool dsa)
 523 {
 524    /* Note: no need to FLUSH_VERTICES or flag NewTransformFeedback, because
 525     * transform feedback buffers can't be changed while transform feedback is
 526     * active.
 527     */
 528
 529    if (!dsa) {
 530       /* The general binding point */
 531       _mesa_reference_buffer_object(ctx,
 532                                     &ctx->TransformFeedback.CurrentBuffer,
 533                                     bufObj);
 534    }
 535
 536    /* The per-attribute binding point */
 537    _mesa_set_transform_feedback_binding(ctx, obj, index, bufObj, offset, size);
 538 }
 539
 540
 541 /**
 542  * Specify a buffer object to receive transform feedback results.  Plus,
 543  * specify the starting offset to place the results, and max size.
 544  * Called from the glBindBufferRange() and glTransformFeedbackBufferRange
 545  * functions.
 546  */
 547 void
 548 _mesa_bind_buffer_range_transform_feedback(struct gl_context *ctx,
 549                                            struct gl_transform_feedback_object *obj,
 550                                            GLuint index,
 551                                            struct gl_buffer_object *bufObj,
 552                                            GLintptr offset,
 553                                            GLsizeiptr size,
 554                                            bool dsa)
 555 {
 556    const char *gl_methd_name;
 557    if (dsa)
 558       gl_methd_name = "glTransformFeedbackBufferRange";
 559    else
 560       gl_methd_name = "glBindBufferRange";
 561
 562
 563    if (obj->Active) {
 564       _mesa_error(ctx, GL_INVALID_OPERATION, "%s(transform feedback active)",
 565                   gl_methd_name);
 566       return;
 567    }
 568
 569    if (index >= ctx->Const.MaxTransformFeedbackBuffers) {
 570       /* OpenGL 4.5 core profile, 6.1, pdf page 82: "An INVALID_VALUE error is
 571        * generated if index is greater than or equal to the number of binding
 572        * points for transform feedback, as described in section 6.7.1."
 573        */
 574       _mesa_error(ctx, GL_INVALID_VALUE, "%s(index=%d out of bounds)",
 575                   gl_methd_name, index);
 576       return;
 577    }
 578
 579    if (size & 0x3) {
 580       /* OpenGL 4.5 core profile, 6.7, pdf page 103: multiple of 4 */
 581       _mesa_error(ctx, GL_INVALID_VALUE, "%s(size=%d must be a multiple of "
 582                   "four)", gl_methd_name, (int) size);
 583       return;
 584    }
 585
 586    if (offset & 0x3) {
 587       /* OpenGL 4.5 core profile, 6.7, pdf page 103: multiple of 4 */
 588       _mesa_error(ctx, GL_INVALID_VALUE, "%s(offset=%d must be a multiple "
 589                   "of four)", gl_methd_name, (int) offset);
 590       return;
 591    }
 592
 593    if (offset < 0) {
 594       /* OpenGL 4.5 core profile, 6.1, pdf page 82: "An INVALID_VALUE error is
 595        * generated by BindBufferRange if offset is negative."
 596        *
 597        * OpenGL 4.5 core profile, 13.2, pdf page 445: "An INVALID_VALUE error
 598        * is generated by TransformFeedbackBufferRange if offset is negative."
 599        */
 600       _mesa_error(ctx, GL_INVALID_VALUE, "%s(offset=%d must be >= 0)",
 601                   gl_methd_name,
 602                   (int) offset);
 603       return;
 604    }
 605
 606    if (size <= 0 && (dsa || bufObj != ctx->Shared->NullBufferObj)) {
 607       /* OpenGL 4.5 core profile, 6.1, pdf page 82: "An INVALID_VALUE error is
 608        * generated by BindBufferRange if buffer is non-zero and size is less
 609        * than or equal to zero."
 610        *
 611        * OpenGL 4.5 core profile, 13.2, pdf page 445: "An INVALID_VALUE error
 612        * is generated by TransformFeedbackBufferRange if size is less than or
 613        * equal to zero."
 614        */
 615       _mesa_error(ctx, GL_INVALID_VALUE, "%s(size=%d must be > 0)",
 616                   gl_methd_name, (int) size);
 617       return;
 618    }
 619
 620    bind_buffer_range(ctx, obj, index, bufObj, offset, size, dsa);
 621 }
 622
 623
 624 /**
 625  * Specify a buffer object to receive transform feedback results.
 626  * As above, but start at offset = 0.
 627  * Called from the glBindBufferBase() and glTransformFeedbackBufferBase()
 628  * functions.
 629  */
 630 void
 631 _mesa_bind_buffer_base_transform_feedback(struct gl_context *ctx,
 632                                           struct gl_transform_feedback_object *obj,
 633                                           GLuint index,
 634                                           struct gl_buffer_object *bufObj,
 635                                           bool dsa)
 636 {
 637    if (obj->Active) {
 638       _mesa_error(ctx, GL_INVALID_OPERATION,
 639                   "%s(transform feedback active)",
 640                   dsa ? "glTransformFeedbackBufferBase" : "glBindBufferBase");
 641       return;
 642    }
 643
 644    if (index >= ctx->Const.MaxTransformFeedbackBuffers) {
 645       _mesa_error(ctx, GL_INVALID_VALUE, "%s(index=%d out of bounds)",
 646                   dsa ? "glTransformFeedbackBufferBase" : "glBindBufferBase",
 647                   index);
 648       return;
 649    }
 650
 651    bind_buffer_range(ctx, obj, index, bufObj, 0, 0, dsa);
 652 }
 653
 654 /**
 655  * Wrapper around lookup_transform_feedback_object that throws
 656  * GL_INVALID_OPERATION if id is not in the hash table. After calling
 657  * _mesa_error, it returns NULL.
 658  */
 659 static struct gl_transform_feedback_object *
 660 lookup_transform_feedback_object_err(struct gl_context *ctx,
 661                                      GLuint xfb, const char* func)
 662 {
 663    struct gl_transform_feedback_object *obj;
 664
 665    obj = _mesa_lookup_transform_feedback_object(ctx, xfb);
 666    if (!obj) {
 667       _mesa_error(ctx, GL_INVALID_OPERATION,
 668                   "%s(xfb=%u: non-generated object name)", func, xfb);
 669    }
 670
 671    return obj;
 672 }
 673
 674 /**
 675  * Wrapper around _mesa_lookup_bufferobj that throws GL_INVALID_VALUE if id
 676  * is not in the hash table. Specialised version for the
 677  * transform-feedback-related functions. After calling _mesa_error, it
 678  * returns NULL.
 679  */
 680 static struct gl_buffer_object *
 681 lookup_transform_feedback_bufferobj_err(struct gl_context *ctx,
 682                                         GLuint buffer, const char* func)
 683 {
 684    struct gl_buffer_object *bufObj;
 685
 686    /* OpenGL 4.5 core profile, 13.2, pdf page 444: buffer must be zero or the
 687     * name of an existing buffer object.
 688     */
 689    if (buffer == 0) {
 690       bufObj = ctx->Shared->NullBufferObj;
 691    } else {
 692       bufObj = _mesa_lookup_bufferobj(ctx, buffer);
 693       if (!bufObj) {
 694          _mesa_error(ctx, GL_INVALID_VALUE, "%s(invalid buffer=%u)", func,
 695                      buffer);
 696       }
 697    }
 698
 699    return bufObj;
 700 }
 701
 702 void GLAPIENTRY
 703 _mesa_TransformFeedbackBufferBase(GLuint xfb, GLuint index, GLuint buffer)
 704 {
 705    GET_CURRENT_CONTEXT(ctx);
 706    struct gl_transform_feedback_object *obj;
 707    struct gl_buffer_object *bufObj;
 708
 709    obj = lookup_transform_feedback_object_err(ctx, xfb,
 710                                               "glTransformFeedbackBufferBase");
 711    if(!obj) {
 712       return;
 713    }
 714
 715    bufObj = lookup_transform_feedback_bufferobj_err(ctx, buffer,
 716                                               "glTransformFeedbackBufferBase");
 717    if(!bufObj) {
 718       return;
 719    }
 720
 721    _mesa_bind_buffer_base_transform_feedback(ctx, obj, index, bufObj, true);
 722 }
 723
 724 void GLAPIENTRY
 725 _mesa_TransformFeedbackBufferRange(GLuint xfb, GLuint index, GLuint buffer,
 726                                    GLintptr offset, GLsizeiptr size)
 727 {
 728    GET_CURRENT_CONTEXT(ctx);
 729    struct gl_transform_feedback_object *obj;
 730    struct gl_buffer_object *bufObj;
 731
 732    obj = lookup_transform_feedback_object_err(ctx, xfb,
 733                                               "glTransformFeedbackBufferRange");
 734    if(!obj) {
 735       return;
 736    }
 737
 738    bufObj = lookup_transform_feedback_bufferobj_err(ctx, buffer,
 739                                               "glTransformFeedbackBufferRange");
 740    if(!bufObj) {
 741       return;
 742    }
 743
 744    _mesa_bind_buffer_range_transform_feedback(ctx, obj, index, bufObj, offset,
 745                                               size, true);
 746 }
 747
 748 /**
 749  * Specify a buffer object to receive transform feedback results, plus the
 750  * offset in the buffer to start placing results.
 751  * This function is part of GL_EXT_transform_feedback, but not GL3.
 752  */
 753 void GLAPIENTRY
 754 _mesa_BindBufferOffsetEXT(GLenum target, GLuint index, GLuint buffer,
 755                           GLintptr offset)
 756 {
 757    struct gl_transform_feedback_object *obj;
 758    struct gl_buffer_object *bufObj;
 759    GET_CURRENT_CONTEXT(ctx);
 760
 761    if (target != GL_TRANSFORM_FEEDBACK_BUFFER) {
 762       _mesa_error(ctx, GL_INVALID_ENUM, "glBindBufferOffsetEXT(target)");
 763       return;
 764    }
 765
 766    obj = ctx->TransformFeedback.CurrentObject;
 767
 768    if (obj->Active) {
 769       _mesa_error(ctx, GL_INVALID_OPERATION,
 770                   "glBindBufferOffsetEXT(transform feedback active)");
 771       return;
 772    }
 773
 774    if (index >= ctx->Const.MaxTransformFeedbackBuffers) {
 775       _mesa_error(ctx, GL_INVALID_VALUE,
 776                   "glBindBufferOffsetEXT(index=%d)", index);
 777       return;
 778    }
 779
 780    if (offset & 0x3) {
 781       /* must be multiple of four */
 782       _mesa_error(ctx, GL_INVALID_VALUE,
 783                   "glBindBufferOffsetEXT(offset=%d)", (int) offset);
 784       return;
 785    }
 786
 787    if (buffer == 0) {
 788       bufObj = ctx->Shared->NullBufferObj;
 789    } else {
 790       bufObj = _mesa_lookup_bufferobj(ctx, buffer);
 791    }
 792
 793    if (!bufObj) {
 794       _mesa_error(ctx, GL_INVALID_OPERATION,
 795                   "glBindBufferOffsetEXT(invalid buffer=%u)", buffer);
 796       return;
 797    }
 798
 799    bind_buffer_range(ctx, obj, index, bufObj, offset, 0, false);
 800 }
 801
 802
 803 /**
 804  * This function specifies the transform feedback outputs to be written
 805  * to the feedback buffer(s), and in what order.
 806  */
 807 void GLAPIENTRY
 808 _mesa_TransformFeedbackVaryings(GLuint program, GLsizei count,
 809                                 const GLchar * const *varyings,
 810                                 GLenum bufferMode)
 811 {
 812    struct gl_shader_program *shProg;
 813    GLint i;
 814    GET_CURRENT_CONTEXT(ctx);
 815
 816    /* From the ARB_transform_feedback2 specification:
 817     * "The error INVALID_OPERATION is generated by TransformFeedbackVaryings
 818     *  if the current transform feedback object is active, even if paused."
 819     */
 820    if (ctx->TransformFeedback.CurrentObject->Active) {
 821       _mesa_error(ctx, GL_INVALID_OPERATION,
 822                "glTransformFeedbackVaryings(current object is active)");
 823       return;
 824    }
 825
 826    switch (bufferMode) {
 827    case GL_INTERLEAVED_ATTRIBS:
 828       break;
 829    case GL_SEPARATE_ATTRIBS:
 830       break;
 831    default:
 832       _mesa_error(ctx, GL_INVALID_ENUM,
 833                   "glTransformFeedbackVaryings(bufferMode)");
 834       return;
 835    }
 836
 837    if (count < 0 ||
 838        (bufferMode == GL_SEPARATE_ATTRIBS &&
 839         (GLuint) count > ctx->Const.MaxTransformFeedbackBuffers)) {
 840       _mesa_error(ctx, GL_INVALID_VALUE,
 841                   "glTransformFeedbackVaryings(count=%d)", count);
 842       return;
 843    }
 844
 845    shProg = _mesa_lookup_shader_program(ctx, program);
 846    if (!shProg) {
 847       _mesa_error(ctx, GL_INVALID_VALUE,
 848                   "glTransformFeedbackVaryings(program=%u)", program);
 849       return;
 850    }
 851
 852    if (ctx->Extensions.ARB_transform_feedback3) {
 853       if (bufferMode == GL_INTERLEAVED_ATTRIBS) {
 854          unsigned buffers = 1;
 855
 856          for (i = 0; i < count; i++) {
 857             if (strcmp(varyings[i], "gl_NextBuffer") == 0)
 858                buffers++;
 859          }
 860
 861          if (buffers > ctx->Const.MaxTransformFeedbackBuffers) {
 862             _mesa_error(ctx, GL_INVALID_OPERATION,
 863                         "glTransformFeedbackVaryings(too many gl_NextBuffer "
 864                         "occurrences)");
 865             return;
 866          }
 867       } else {
 868          for (i = 0; i < count; i++) {
 869             if (strcmp(varyings[i], "gl_NextBuffer") == 0 ||
 870                 strcmp(varyings[i], "gl_SkipComponents1") == 0 ||
 871                 strcmp(varyings[i], "gl_SkipComponents2") == 0 ||
 872                 strcmp(varyings[i], "gl_SkipComponents3") == 0 ||
 873                 strcmp(varyings[i], "gl_SkipComponents4") == 0) {
 874                _mesa_error(ctx, GL_INVALID_OPERATION,
 875                            "glTransformFeedbackVaryings(SEPARATE_ATTRIBS,"
 876                            "varying=%s)",
 877                            varyings[i]);
 878                return;
 879             }
 880          }
 881       }
 882    }
 883
 884    /* free existing varyings, if any */
 885    for (i = 0; i < (GLint) shProg->TransformFeedback.NumVarying; i++) {
 886       free(shProg->TransformFeedback.VaryingNames[i]);
 887    }
 888    free(shProg->TransformFeedback.VaryingNames);
 889
 890    /* allocate new memory for varying names */
 891    shProg->TransformFeedback.VaryingNames =
 892       malloc(count * sizeof(GLchar *));
 893
 894    if (!shProg->TransformFeedback.VaryingNames) {
 895       _mesa_error(ctx, GL_OUT_OF_MEMORY, "glTransformFeedbackVaryings()");
 896       return;
 897    }
 898
 899    /* Save the new names and the count */
 900    for (i = 0; i < count; i++) {
 901       shProg->TransformFeedback.VaryingNames[i] = strdup(varyings[i]);
 902    }
 903    shProg->TransformFeedback.NumVarying = count;
 904
 905    shProg->TransformFeedback.BufferMode = bufferMode;
 906
 907    /* No need to invoke FLUSH_VERTICES or flag NewTransformFeedback since
 908     * the varyings won't be used until shader link time.
 909     */
 910 }
 911
 912
 913 /**
 914  * Get info about the transform feedback outputs which are to be written
 915  * to the feedback buffer(s).
 916  */
 917 void GLAPIENTRY
 918 _mesa_GetTransformFeedbackVarying(GLuint program, GLuint index,
 919                                   GLsizei bufSize, GLsizei *length,
 920                                   GLsizei *size, GLenum *type, GLchar *name)
 921 {
 922    const struct gl_shader_program *shProg;
 923    struct gl_program_resource *res;
 924    GET_CURRENT_CONTEXT(ctx);
 925
 926    shProg = _mesa_lookup_shader_program(ctx, program);
 927    if (!shProg) {
 928       _mesa_error(ctx, GL_INVALID_VALUE,
 929                   "glGetTransformFeedbackVarying(program=%u)", program);
 930       return;
 931    }
 932
 933    res = _mesa_program_resource_find_index((struct gl_shader_program *) shProg,
 934                                            GL_TRANSFORM_FEEDBACK_VARYING,
 935                                            index);
 936    if (!res) {
 937       _mesa_error(ctx, GL_INVALID_VALUE,
 938                   "glGetTransformFeedbackVarying(index=%u)", index);
 939       return;
 940    }
 941
 942    /* return the varying's name and length */
 943    _mesa_copy_string(name, bufSize, length, _mesa_program_resource_name(res));
 944
 945    /* return the datatype and value's size (in datatype units) */
 946    if (type)
 947       _mesa_program_resource_prop((struct gl_shader_program *) shProg,
 948                                   res, index, GL_TYPE, (GLint*) type,
 949                                   "glGetTransformFeedbackVarying");
 950    if (size)
 951       _mesa_program_resource_prop((struct gl_shader_program *) shProg,
 952                                   res, index, GL_ARRAY_SIZE, (GLint*) size,
 953                                   "glGetTransformFeedbackVarying");
 954 }
 955
 956
 957
 958 struct gl_transform_feedback_object *
 959 _mesa_lookup_transform_feedback_object(struct gl_context *ctx, GLuint name)
 960 {
 961    /* OpenGL 4.5 core profile, 13.2 pdf page 444: "xfb must be zero, indicating
 962     * the default transform feedback object, or the name of an existing
 963     * transform feedback object."
 964     */
 965    if (name == 0) {
 966       return ctx->TransformFeedback.DefaultObject;
 967    }
 968    else
 969       return (struct gl_transform_feedback_object *)
 970          _mesa_HashLookup(ctx->TransformFeedback.Objects, name);
 971 }
 972
 973 static void
 974 create_transform_feedbacks(struct gl_context *ctx, GLsizei n, GLuint *ids,
 975                            bool dsa)
 976 {
 977    GLuint first;
 978    const char* func;
 979
 980    if (dsa)
 981       func = "glCreateTransformFeedbacks";
 982    else
 983       func = "glGenTransformFeedbacks";
 984
 985    if (n < 0) {
 986       _mesa_error(ctx, GL_INVALID_VALUE, "%s(n < 0)", func);
 987       return;
 988    }
 989
 990    if (!ids)
 991       return;
 992
 993    /* we don't need contiguous IDs, but this might be faster */
 994    first = _mesa_HashFindFreeKeyBlock(ctx->TransformFeedback.Objects, n);
 995    if (first) {
 996       GLsizei i;
 997       for (i = 0; i < n; i++) {
 998          struct gl_transform_feedback_object *obj
 999             = ctx->Driver.NewTransformFeedback(ctx, first + i);
1000          if (!obj) {
1001             _mesa_error(ctx, GL_OUT_OF_MEMORY, "%s", func);
1002             return;
1003          }
1004          ids[i] = first + i;
1005          _mesa_HashInsert(ctx->TransformFeedback.Objects, first + i, obj);
1006          if (dsa) {
1007             /* this is normally done at bind time in the non-dsa case */
1008             obj->EverBound = GL_TRUE;
1009          }
1010       }
1011    }
1012    else {
1013       _mesa_error(ctx, GL_OUT_OF_MEMORY, "%s", func);
1014    }
1015 }
1016
1017 /**
1018  * Create new transform feedback objects.   Transform feedback objects
1019  * encapsulate the state related to transform feedback to allow quickly
1020  * switching state (and drawing the results, below).
1021  * Part of GL_ARB_transform_feedback2.
1022  */
1023 void GLAPIENTRY
1024 _mesa_GenTransformFeedbacks(GLsizei n, GLuint *names)
1025 {
1026    GET_CURRENT_CONTEXT(ctx);
1027
1028    /* GenTransformFeedbacks should just reserve the object names that a
1029     * subsequent call to BindTransformFeedback should actively create. For
1030     * the sake of simplicity, we reserve the names and create the objects
1031     * straight away.
1032     */
1033
1034    create_transform_feedbacks(ctx, n, names, false);
1035 }
1036
1037 /**
1038  * Create new transform feedback objects.   Transform feedback objects
1039  * encapsulate the state related to transform feedback to allow quickly
1040  * switching state (and drawing the results, below).
1041  * Part of GL_ARB_direct_state_access.
1042  */
1043 void GLAPIENTRY
1044 _mesa_CreateTransformFeedbacks(GLsizei n, GLuint *names)
1045 {
1046    GET_CURRENT_CONTEXT(ctx);
1047
1048    create_transform_feedbacks(ctx, n, names, true);
1049 }
1050
1051
1052 /**
1053  * Is the given ID a transform feedback object?
1054  * Part of GL_ARB_transform_feedback2.
1055  */
1056 GLboolean GLAPIENTRY
1057 _mesa_IsTransformFeedback(GLuint name)
1058 {
1059    struct gl_transform_feedback_object *obj;
1060    GET_CURRENT_CONTEXT(ctx);
1061
1062    ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, GL_FALSE);
1063
1064    if (name == 0)
1065       return GL_FALSE;
1066
1067    obj = _mesa_lookup_transform_feedback_object(ctx, name);
1068    if (obj == NULL)
1069       return GL_FALSE;
1070
1071    return obj->EverBound;
1072 }
1073
1074
1075 /**
1076  * Bind the given transform feedback object.
1077  * Part of GL_ARB_transform_feedback2.
1078  */
1079 void GLAPIENTRY
1080 _mesa_BindTransformFeedback(GLenum target, GLuint name)
1081 {
1082    struct gl_transform_feedback_object *obj;
1083    GET_CURRENT_CONTEXT(ctx);
1084
1085    if (target != GL_TRANSFORM_FEEDBACK) {
1086       _mesa_error(ctx, GL_INVALID_ENUM, "glBindTransformFeedback(target)");
1087       return;
1088    }
1089
1090    if (_mesa_is_xfb_active_and_unpaused(ctx)) {
1091       _mesa_error(ctx, GL_INVALID_OPERATION,
1092               "glBindTransformFeedback(transform is active, or not paused)");
1093       return;
1094    }
1095
1096    obj = _mesa_lookup_transform_feedback_object(ctx, name);
1097    if (!obj) {
1098       _mesa_error(ctx, GL_INVALID_OPERATION,
1099                   "glBindTransformFeedback(name=%u)", name);
1100       return;
1101    }
1102
1103    reference_transform_feedback_object(&ctx->TransformFeedback.CurrentObject,
1104                                        obj);
1105 }
1106
1107
1108 /**
1109  * Delete the given transform feedback objects.
1110  * Part of GL_ARB_transform_feedback2.
1111  */
1112 void GLAPIENTRY
1113 _mesa_DeleteTransformFeedbacks(GLsizei n, const GLuint *names)
1114 {
1115    GLint i;
1116    GET_CURRENT_CONTEXT(ctx);
1117
1118    if (n < 0) {
1119       _mesa_error(ctx, GL_INVALID_VALUE, "glDeleteTransformFeedbacks(n < 0)");
1120       return;
1121    }
1122
1123    if (!names)
1124       return;
1125
1126    for (i = 0; i < n; i++) {
1127       if (names[i] > 0) {
1128          struct gl_transform_feedback_object *obj
1129             = _mesa_lookup_transform_feedback_object(ctx, names[i]);
1130          if (obj) {
1131             if (obj->Active) {
1132                _mesa_error(ctx, GL_INVALID_OPERATION,
1133                            "glDeleteTransformFeedbacks(object %u is active)",
1134                            names[i]);
1135                return;
1136             }
1137             _mesa_HashRemove(ctx->TransformFeedback.Objects, names[i]);
1138             /* unref, but object may not be deleted until later */
1139             if (obj == ctx->TransformFeedback.CurrentObject) {
1140                reference_transform_feedback_object(
1141                      &ctx->TransformFeedback.CurrentObject,
1142                      ctx->TransformFeedback.DefaultObject);
1143             }
1144             reference_transform_feedback_object(&obj, NULL);
1145          }
1146       }
1147    }
1148 }
1149
1150
1151 /**
1152  * Pause transform feedback.
1153  * Part of GL_ARB_transform_feedback2.
1154  */
1155 void GLAPIENTRY
1156 _mesa_PauseTransformFeedback(void)
1157 {
1158    struct gl_transform_feedback_object *obj;
1159    GET_CURRENT_CONTEXT(ctx);
1160
1161    obj = ctx->TransformFeedback.CurrentObject;
1162
1163    if (!_mesa_is_xfb_active_and_unpaused(ctx)) {
1164       _mesa_error(ctx, GL_INVALID_OPERATION,
1165            "glPauseTransformFeedback(feedback not active or already paused)");
1166       return;
1167    }
1168
1169    FLUSH_VERTICES(ctx, 0);
1170    ctx->NewDriverState |= ctx->DriverFlags.NewTransformFeedback;
1171
1172    obj->Paused = GL_TRUE;
1173
1174    assert(ctx->Driver.PauseTransformFeedback);
1175    ctx->Driver.PauseTransformFeedback(ctx, obj);
1176 }
1177
1178
1179 /**
1180  * Resume transform feedback.
1181  * Part of GL_ARB_transform_feedback2.
1182  */
1183 void GLAPIENTRY
1184 _mesa_ResumeTransformFeedback(void)
1185 {
1186    struct gl_transform_feedback_object *obj;
1187    GET_CURRENT_CONTEXT(ctx);
1188
1189    obj = ctx->TransformFeedback.CurrentObject;
1190
1191    if (!obj->Active || !obj->Paused) {
1192       _mesa_error(ctx, GL_INVALID_OPERATION,
1193                "glResumeTransformFeedback(feedback not active or not paused)");
1194       return;
1195    }
1196
1197    /* From the ARB_transform_feedback2 specification:
1198     * "The error INVALID_OPERATION is generated by ResumeTransformFeedback if
1199     *  the program object being used by the current transform feedback object
1200     *  is not active."
1201     */
1202    if (obj->shader_program != get_xfb_source(ctx)) {
1203       _mesa_error(ctx, GL_INVALID_OPERATION,
1204                   "glResumeTransformFeedback(wrong program bound)");
1205       return;
1206    }
1207
1208    FLUSH_VERTICES(ctx, 0);
1209    ctx->NewDriverState |= ctx->DriverFlags.NewTransformFeedback;
1210
1211    obj->Paused = GL_FALSE;
1212
1213    assert(ctx->Driver.ResumeTransformFeedback);
1214    ctx->Driver.ResumeTransformFeedback(ctx, obj);
1215 }
1216
1217 extern void GLAPIENTRY
1218 _mesa_GetTransformFeedbackiv(GLuint xfb, GLenum pname, GLint *param)
1219 {
1220     struct gl_transform_feedback_object *obj;
1221     GET_CURRENT_CONTEXT(ctx);
1222
1223     obj = lookup_transform_feedback_object_err(ctx, xfb,
1224                                                "glGetTransformFeedbackiv");
1225     if(!obj) {
1226        return;
1227     }
1228
1229     switch(pname) {
1230     case GL_TRANSFORM_FEEDBACK_PAUSED:
1231        *param = obj->Paused;
1232        break;
1233     case GL_TRANSFORM_FEEDBACK_ACTIVE:
1234        *param = obj->Active;
1235        break;
1236     default:
1237        _mesa_error(ctx, GL_INVALID_ENUM,
1238                    "glGetTransformFeedbackiv(pname=%i)", pname);
1239     }
1240 }
1241
1242 extern void GLAPIENTRY
1243 _mesa_GetTransformFeedbacki_v(GLuint xfb, GLenum pname, GLuint index,
1244                               GLint *param)
1245 {
1246    struct gl_transform_feedback_object *obj;
1247    GET_CURRENT_CONTEXT(ctx);
1248
1249    obj = lookup_transform_feedback_object_err(ctx, xfb,
1250                                               "glGetTransformFeedbacki_v");
1251    if(!obj) {
1252       return;
1253    }
1254
1255    if (index >= ctx->Const.MaxTransformFeedbackBuffers) {
1256       _mesa_error(ctx, GL_INVALID_VALUE,
1257                   "glGetTransformFeedbacki_v(index=%i)", index);
1258       return;
1259    }
1260
1261    switch(pname) {
1262    case GL_TRANSFORM_FEEDBACK_BUFFER_BINDING:
1263       *param = obj->BufferNames[index];
1264       break;
1265    default:
1266       _mesa_error(ctx, GL_INVALID_ENUM,
1267                   "glGetTransformFeedbacki_v(pname=%i)", pname);
1268    }
1269 }
1270
1271 extern void GLAPIENTRY
1272 _mesa_GetTransformFeedbacki64_v(GLuint xfb, GLenum pname, GLuint index,
1273                                 GLint64 *param)
1274 {
1275    struct gl_transform_feedback_object *obj;
1276    GET_CURRENT_CONTEXT(ctx);
1277
1278    obj = lookup_transform_feedback_object_err(ctx, xfb,
1279                                               "glGetTransformFeedbacki64_v");
1280    if(!obj) {
1281       return;
1282    }
1283
1284    if (index >= ctx->Const.MaxTransformFeedbackBuffers) {
1285       _mesa_error(ctx, GL_INVALID_VALUE,
1286                   "glGetTransformFeedbacki64_v(index=%i)", index);
1287       return;
1288    }
1289
1290    switch(pname) {
1291    case GL_TRANSFORM_FEEDBACK_BUFFER_START:
1292       *param = obj->Offset[index];
1293       break;
1294    case GL_TRANSFORM_FEEDBACK_BUFFER_SIZE:
1295       *param = obj->RequestedSize[index];
1296       break;
1297    default:
1298       _mesa_error(ctx, GL_INVALID_ENUM,
1299                   "glGetTransformFeedbacki64_v(pname=%i)", pname);
1300    }
1301 }