mesa: inline remove_array_object()
[mesa.git] / src / mesa / main / arrayobj.c
1 /*
2 * Mesa 3-D graphics library
3 *
4 * Copyright (C) 1999-2008 Brian Paul All Rights Reserved.
5 * (C) Copyright IBM Corporation 2006
6 * Copyright (C) 2009 VMware, Inc. All Rights Reserved.
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the "Software"),
10 * to deal in the Software without restriction, including without limitation
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12 * and/or sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included
16 * in all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
22 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
23 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
24 * OTHER DEALINGS IN THE SOFTWARE.
25 */
26
27
28 /**
29 * \file arrayobj.c
30 *
31 * Implementation of Vertex Array Objects (VAOs), from OpenGL 3.1+ /
32 * the GL_ARB_vertex_array_object extension.
33 *
34 * \todo
35 * The code in this file borrows a lot from bufferobj.c. There's a certain
36 * amount of cruft left over from that origin that may be unnecessary.
37 *
38 * \author Ian Romanick <idr@us.ibm.com>
39 * \author Brian Paul
40 */
41
42
43 #include "glheader.h"
44 #include "hash.h"
45 #include "image.h"
46 #include "imports.h"
47 #include "context.h"
48 #include "bufferobj.h"
49 #include "arrayobj.h"
50 #include "macros.h"
51 #include "mtypes.h"
52 #include "varray.h"
53 #include "main/dispatch.h"
54 #include "util/bitscan.h"
55
56
57 /**
58 * Look up the array object for the given ID.
59 *
60 * \returns
61 * Either a pointer to the array object with the specified ID or \c NULL for
62 * a non-existent ID. The spec defines ID 0 as being technically
63 * non-existent.
64 */
65
66 struct gl_vertex_array_object *
67 _mesa_lookup_vao(struct gl_context *ctx, GLuint id)
68 {
69 if (id == 0)
70 return NULL;
71 else
72 return (struct gl_vertex_array_object *)
73 _mesa_HashLookupLocked(ctx->Array.Objects, id);
74 }
75
76
77 /**
78 * Looks up the array object for the given ID.
79 *
80 * Unlike _mesa_lookup_vao, this function generates a GL_INVALID_OPERATION
81 * error if the array object does not exist. It also returns the default
82 * array object when ctx is a compatibility profile context and id is zero.
83 */
84 struct gl_vertex_array_object *
85 _mesa_lookup_vao_err(struct gl_context *ctx, GLuint id, const char *caller)
86 {
87 /* The ARB_direct_state_access specification says:
88 *
89 * "<vaobj> is [compatibility profile:
90 * zero, indicating the default vertex array object, or]
91 * the name of the vertex array object."
92 */
93 if (id == 0) {
94 if (ctx->API == API_OPENGL_CORE) {
95 _mesa_error(ctx, GL_INVALID_OPERATION,
96 "%s(zero is not valid vaobj name in a core profile "
97 "context)", caller);
98 return NULL;
99 }
100
101 return ctx->Array.DefaultVAO;
102 } else {
103 struct gl_vertex_array_object *vao;
104
105 if (ctx->Array.LastLookedUpVAO &&
106 ctx->Array.LastLookedUpVAO->Name == id) {
107 vao = ctx->Array.LastLookedUpVAO;
108 } else {
109 vao = (struct gl_vertex_array_object *)
110 _mesa_HashLookupLocked(ctx->Array.Objects, id);
111
112 /* The ARB_direct_state_access specification says:
113 *
114 * "An INVALID_OPERATION error is generated if <vaobj> is not
115 * [compatibility profile: zero or] the name of an existing
116 * vertex array object."
117 */
118 if (!vao || !vao->EverBound) {
119 _mesa_error(ctx, GL_INVALID_OPERATION,
120 "%s(non-existent vaobj=%u)", caller, id);
121 return NULL;
122 }
123
124 _mesa_reference_vao(ctx, &ctx->Array.LastLookedUpVAO, vao);
125 }
126
127 return vao;
128 }
129 }
130
131
132 /**
133 * For all the vertex binding points in the array object, unbind any pointers
134 * to any buffer objects (VBOs).
135 * This is done just prior to array object destruction.
136 */
137 static void
138 unbind_array_object_vbos(struct gl_context *ctx, struct gl_vertex_array_object *obj)
139 {
140 GLuint i;
141
142 for (i = 0; i < ARRAY_SIZE(obj->BufferBinding); i++)
143 _mesa_reference_buffer_object(ctx, &obj->BufferBinding[i].BufferObj, NULL);
144
145 for (i = 0; i < ARRAY_SIZE(obj->_VertexAttrib); i++)
146 _mesa_reference_buffer_object(ctx, &obj->_VertexAttrib[i].BufferObj, NULL);
147 }
148
149
150 /**
151 * Allocate and initialize a new vertex array object.
152 */
153 struct gl_vertex_array_object *
154 _mesa_new_vao(struct gl_context *ctx, GLuint name)
155 {
156 struct gl_vertex_array_object *obj = CALLOC_STRUCT(gl_vertex_array_object);
157 if (obj)
158 _mesa_initialize_vao(ctx, obj, name);
159 return obj;
160 }
161
162
163 /**
164 * Delete an array object.
165 */
166 void
167 _mesa_delete_vao(struct gl_context *ctx, struct gl_vertex_array_object *obj)
168 {
169 unbind_array_object_vbos(ctx, obj);
170 _mesa_reference_buffer_object(ctx, &obj->IndexBufferObj, NULL);
171 free(obj->Label);
172 free(obj);
173 }
174
175
176 /**
177 * Set ptr to vao w/ reference counting.
178 * Note: this should only be called from the _mesa_reference_vao()
179 * inline function.
180 */
181 void
182 _mesa_reference_vao_(struct gl_context *ctx,
183 struct gl_vertex_array_object **ptr,
184 struct gl_vertex_array_object *vao)
185 {
186 assert(*ptr != vao);
187
188 if (*ptr) {
189 /* Unreference the old array object */
190 struct gl_vertex_array_object *oldObj = *ptr;
191
192 assert(oldObj->RefCount > 0);
193 oldObj->RefCount--;
194
195 if (oldObj->RefCount == 0)
196 _mesa_delete_vao(ctx, oldObj);
197
198 *ptr = NULL;
199 }
200 assert(!*ptr);
201
202 if (vao) {
203 /* reference new array object */
204 assert(vao->RefCount > 0);
205
206 vao->RefCount++;
207 *ptr = vao;
208 }
209 }
210
211
212 /**
213 * Initialize attribtes of a vertex array within a vertex array object.
214 * \param vao the container vertex array object
215 * \param index which array in the VAO to initialize
216 * \param size number of components (1, 2, 3 or 4) per attribute
217 * \param type datatype of the attribute (GL_FLOAT, GL_INT, etc).
218 */
219 static void
220 init_array(struct gl_context *ctx,
221 struct gl_vertex_array_object *vao,
222 GLuint index, GLint size, GLint type)
223 {
224 struct gl_array_attributes *array = &vao->VertexAttrib[index];
225 struct gl_vertex_buffer_binding *binding = &vao->BufferBinding[index];
226
227 array->Size = size;
228 array->Type = type;
229 array->Format = GL_RGBA; /* only significant for GL_EXT_vertex_array_bgra */
230 array->Stride = 0;
231 array->Ptr = NULL;
232 array->RelativeOffset = 0;
233 array->Enabled = GL_FALSE;
234 array->Normalized = GL_FALSE;
235 array->Integer = GL_FALSE;
236 array->Doubles = GL_FALSE;
237 array->_ElementSize = size * _mesa_sizeof_type(type);
238 array->BufferBindingIndex = index;
239
240 binding->Offset = 0;
241 binding->Stride = array->_ElementSize;
242 binding->BufferObj = NULL;
243 binding->_BoundArrays = BITFIELD64_BIT(index);
244
245 /* Vertex array buffers */
246 _mesa_reference_buffer_object(ctx, &binding->BufferObj,
247 ctx->Shared->NullBufferObj);
248 }
249
250
251 /**
252 * Initialize a gl_vertex_array_object's arrays.
253 */
254 void
255 _mesa_initialize_vao(struct gl_context *ctx,
256 struct gl_vertex_array_object *vao,
257 GLuint name)
258 {
259 GLuint i;
260
261 vao->Name = name;
262
263 vao->RefCount = 1;
264
265 /* Init the individual arrays */
266 for (i = 0; i < ARRAY_SIZE(vao->VertexAttrib); i++) {
267 switch (i) {
268 case VERT_ATTRIB_WEIGHT:
269 init_array(ctx, vao, VERT_ATTRIB_WEIGHT, 1, GL_FLOAT);
270 break;
271 case VERT_ATTRIB_NORMAL:
272 init_array(ctx, vao, VERT_ATTRIB_NORMAL, 3, GL_FLOAT);
273 break;
274 case VERT_ATTRIB_COLOR1:
275 init_array(ctx, vao, VERT_ATTRIB_COLOR1, 3, GL_FLOAT);
276 break;
277 case VERT_ATTRIB_FOG:
278 init_array(ctx, vao, VERT_ATTRIB_FOG, 1, GL_FLOAT);
279 break;
280 case VERT_ATTRIB_COLOR_INDEX:
281 init_array(ctx, vao, VERT_ATTRIB_COLOR_INDEX, 1, GL_FLOAT);
282 break;
283 case VERT_ATTRIB_EDGEFLAG:
284 init_array(ctx, vao, VERT_ATTRIB_EDGEFLAG, 1, GL_BOOL);
285 break;
286 case VERT_ATTRIB_POINT_SIZE:
287 init_array(ctx, vao, VERT_ATTRIB_POINT_SIZE, 1, GL_FLOAT);
288 break;
289 default:
290 init_array(ctx, vao, i, 4, GL_FLOAT);
291 break;
292 }
293 }
294
295 _mesa_reference_buffer_object(ctx, &vao->IndexBufferObj,
296 ctx->Shared->NullBufferObj);
297 }
298
299
300 /**
301 * Add the given array object to the array object pool.
302 */
303 static void
304 save_array_object(struct gl_context *ctx, struct gl_vertex_array_object *vao)
305 {
306 if (vao->Name > 0) {
307 /* insert into hash table */
308 _mesa_HashInsertLocked(ctx->Array.Objects, vao->Name, vao);
309 }
310 }
311
312
313 /**
314 * Updates the derived gl_vertex_arrays when a gl_vertex_attrib_array
315 * or a gl_vertex_buffer_binding has changed.
316 */
317 void
318 _mesa_update_vao_client_arrays(struct gl_context *ctx,
319 struct gl_vertex_array_object *vao)
320 {
321 GLbitfield64 arrays = vao->NewArrays;
322
323 while (arrays) {
324 const int attrib = u_bit_scan64(&arrays);
325 struct gl_vertex_array *client_array = &vao->_VertexAttrib[attrib];
326 const struct gl_array_attributes *attrib_array =
327 &vao->VertexAttrib[attrib];
328 const struct gl_vertex_buffer_binding *buffer_binding =
329 &vao->BufferBinding[attrib_array->BufferBindingIndex];
330
331 _mesa_update_client_array(ctx, client_array, attrib_array,
332 buffer_binding);
333 }
334 }
335
336
337 bool
338 _mesa_all_varyings_in_vbos(const struct gl_vertex_array_object *vao)
339 {
340 /* Walk those enabled arrays that have the default vbo attached */
341 GLbitfield64 mask = vao->_Enabled & ~vao->VertexAttribBufferMask;
342
343 while (mask) {
344 /* Do not use u_bit_scan64 as we can walk multiple
345 * attrib arrays at once
346 */
347 const int i = ffsll(mask) - 1;
348 const struct gl_array_attributes *attrib_array =
349 &vao->VertexAttrib[i];
350 const struct gl_vertex_buffer_binding *buffer_binding =
351 &vao->BufferBinding[attrib_array->BufferBindingIndex];
352
353 /* Only enabled arrays shall appear in the _Enabled bitmask */
354 assert(attrib_array->Enabled);
355 /* We have already masked out vao->VertexAttribBufferMask */
356 assert(!_mesa_is_bufferobj(buffer_binding->BufferObj));
357
358 /* Bail out once we find the first non vbo with a non zero stride */
359 if (buffer_binding->Stride != 0)
360 return false;
361
362 /* Note that we cannot use the xor variant since the _BoundArray mask
363 * may contain array attributes that are bound but not enabled.
364 */
365 mask &= ~buffer_binding->_BoundArrays;
366 }
367
368 return true;
369 }
370
371 bool
372 _mesa_all_buffers_are_unmapped(const struct gl_vertex_array_object *vao)
373 {
374 /* Walk the enabled arrays that have a vbo attached */
375 GLbitfield64 mask = vao->_Enabled & vao->VertexAttribBufferMask;
376
377 while (mask) {
378 const int i = ffsll(mask) - 1;
379 const struct gl_array_attributes *attrib_array =
380 &vao->VertexAttrib[i];
381 const struct gl_vertex_buffer_binding *buffer_binding =
382 &vao->BufferBinding[attrib_array->BufferBindingIndex];
383
384 /* Only enabled arrays shall appear in the _Enabled bitmask */
385 assert(attrib_array->Enabled);
386 /* We have already masked with vao->VertexAttribBufferMask */
387 assert(_mesa_is_bufferobj(buffer_binding->BufferObj));
388
389 /* Bail out once we find the first disallowed mapping */
390 if (_mesa_check_disallowed_mapping(buffer_binding->BufferObj))
391 return false;
392
393 /* We have handled everything that is bound to this buffer_binding. */
394 mask &= ~buffer_binding->_BoundArrays;
395 }
396
397 return true;
398 }
399
400 /**********************************************************************/
401 /* API Functions */
402 /**********************************************************************/
403
404
405 /**
406 * ARB version of glBindVertexArray()
407 */
408 void GLAPIENTRY
409 _mesa_BindVertexArray( GLuint id )
410 {
411 GET_CURRENT_CONTEXT(ctx);
412
413 struct gl_vertex_array_object * const oldObj = ctx->Array.VAO;
414 struct gl_vertex_array_object *newObj = NULL;
415
416 assert(oldObj != NULL);
417
418 if (oldObj->Name == id)
419 return; /* rebinding the same array object- no change */
420
421 /*
422 * Get pointer to new array object (newObj)
423 */
424 if (id == 0) {
425 /* The spec says there is no array object named 0, but we use
426 * one internally because it simplifies things.
427 */
428 newObj = ctx->Array.DefaultVAO;
429 }
430 else {
431 /* non-default array object */
432 newObj = _mesa_lookup_vao(ctx, id);
433 if (!newObj) {
434 _mesa_error(ctx, GL_INVALID_OPERATION,
435 "glBindVertexArray(non-gen name)");
436 return;
437 }
438
439 newObj->EverBound = GL_TRUE;
440 }
441
442 if (ctx->Array.DrawMethod == DRAW_ARRAYS) {
443 /* The _DrawArrays pointer is pointing at the VAO being unbound and
444 * that VAO may be in the process of being deleted. If it's not going
445 * to be deleted, this will have no effect, because the pointer needs
446 * to be updated by the VBO module anyway.
447 *
448 * Before the VBO module can update the pointer, we have to set it
449 * to NULL for drivers not to set up arrays which are not bound,
450 * or to prevent a crash if the VAO being unbound is going to be
451 * deleted.
452 */
453 ctx->Array._DrawArrays = NULL;
454 ctx->Array.DrawMethod = DRAW_NONE;
455 }
456
457 ctx->NewState |= _NEW_ARRAY;
458 _mesa_reference_vao(ctx, &ctx->Array.VAO, newObj);
459 }
460
461
462 /**
463 * Delete a set of array objects.
464 *
465 * \param n Number of array objects to delete.
466 * \param ids Array of \c n array object IDs.
467 */
468 void GLAPIENTRY
469 _mesa_DeleteVertexArrays(GLsizei n, const GLuint *ids)
470 {
471 GET_CURRENT_CONTEXT(ctx);
472 GLsizei i;
473
474 if (n < 0) {
475 _mesa_error(ctx, GL_INVALID_VALUE, "glDeleteVertexArray(n)");
476 return;
477 }
478
479 for (i = 0; i < n; i++) {
480 struct gl_vertex_array_object *obj = _mesa_lookup_vao(ctx, ids[i]);
481
482 if (obj) {
483 assert(obj->Name == ids[i]);
484
485 /* If the array object is currently bound, the spec says "the binding
486 * for that object reverts to zero and the default vertex array
487 * becomes current."
488 */
489 if (obj == ctx->Array.VAO)
490 _mesa_BindVertexArray(0);
491
492 /* The ID is immediately freed for re-use */
493 _mesa_HashRemoveLocked(ctx->Array.Objects, obj->Name);
494
495 if (ctx->Array.LastLookedUpVAO == obj)
496 _mesa_reference_vao(ctx, &ctx->Array.LastLookedUpVAO, NULL);
497
498 /* Unreference the array object.
499 * If refcount hits zero, the object will be deleted.
500 */
501 _mesa_reference_vao(ctx, &obj, NULL);
502 }
503 }
504 }
505
506
507 /**
508 * Generate a set of unique array object IDs and store them in \c arrays.
509 * Helper for _mesa_GenVertexArrays() and _mesa_CreateVertexArrays()
510 * below.
511 *
512 * \param n Number of IDs to generate.
513 * \param arrays Array of \c n locations to store the IDs.
514 * \param create Indicates that the objects should also be created.
515 * \param func The name of the GL entry point.
516 */
517 static void
518 gen_vertex_arrays(struct gl_context *ctx, GLsizei n, GLuint *arrays,
519 bool create, const char *func)
520 {
521 GLuint first;
522 GLint i;
523
524 if (n < 0) {
525 _mesa_error(ctx, GL_INVALID_VALUE, "%s(n < 0)", func);
526 return;
527 }
528
529 if (!arrays) {
530 return;
531 }
532
533 first = _mesa_HashFindFreeKeyBlock(ctx->Array.Objects, n);
534
535 /* For the sake of simplicity we create the array objects in both
536 * the Gen* and Create* cases. The only difference is the value of
537 * EverBound, which is set to true in the Create* case.
538 */
539 for (i = 0; i < n; i++) {
540 struct gl_vertex_array_object *obj;
541 GLuint name = first + i;
542
543 obj = _mesa_new_vao(ctx, name);
544 if (!obj) {
545 _mesa_error(ctx, GL_OUT_OF_MEMORY, "%s", func);
546 return;
547 }
548 obj->EverBound = create;
549 save_array_object(ctx, obj);
550 arrays[i] = first + i;
551 }
552 }
553
554
555 /**
556 * ARB version of glGenVertexArrays()
557 * All arrays will be required to live in VBOs.
558 */
559 void GLAPIENTRY
560 _mesa_GenVertexArrays(GLsizei n, GLuint *arrays)
561 {
562 GET_CURRENT_CONTEXT(ctx);
563 gen_vertex_arrays(ctx, n, arrays, false, "glGenVertexArrays");
564 }
565
566
567 /**
568 * ARB_direct_state_access
569 * Generates ID's and creates the array objects.
570 */
571 void GLAPIENTRY
572 _mesa_CreateVertexArrays(GLsizei n, GLuint *arrays)
573 {
574 GET_CURRENT_CONTEXT(ctx);
575 gen_vertex_arrays(ctx, n, arrays, true, "glCreateVertexArrays");
576 }
577
578
579 /**
580 * Determine if ID is the name of an array object.
581 *
582 * \param id ID of the potential array object.
583 * \return \c GL_TRUE if \c id is the name of a array object,
584 * \c GL_FALSE otherwise.
585 */
586 GLboolean GLAPIENTRY
587 _mesa_IsVertexArray( GLuint id )
588 {
589 struct gl_vertex_array_object * obj;
590 GET_CURRENT_CONTEXT(ctx);
591 ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, GL_FALSE);
592
593 obj = _mesa_lookup_vao(ctx, id);
594
595 return obj != NULL && obj->EverBound;
596 }
597
598
599 /**
600 * Sets the element array buffer binding of a vertex array object.
601 *
602 * This is the ARB_direct_state_access equivalent of
603 * glBindBuffer(GL_ELEMENT_ARRAY_BUFFER, buffer).
604 */
605 void GLAPIENTRY
606 _mesa_VertexArrayElementBuffer(GLuint vaobj, GLuint buffer)
607 {
608 GET_CURRENT_CONTEXT(ctx);
609 struct gl_vertex_array_object *vao;
610 struct gl_buffer_object *bufObj;
611
612 ASSERT_OUTSIDE_BEGIN_END(ctx);
613
614 /* The GL_ARB_direct_state_access specification says:
615 *
616 * "An INVALID_OPERATION error is generated by VertexArrayElementBuffer
617 * if <vaobj> is not [compatibility profile: zero or] the name of an
618 * existing vertex array object."
619 */
620 vao =_mesa_lookup_vao_err(ctx, vaobj, "glVertexArrayElementBuffer");
621 if (!vao)
622 return;
623
624 /* The GL_ARB_direct_state_access specification says:
625 *
626 * "An INVALID_OPERATION error is generated if <buffer> is not zero or
627 * the name of an existing buffer object."
628 */
629 if (buffer != 0)
630 bufObj = _mesa_lookup_bufferobj_err(ctx, buffer,
631 "glVertexArrayElementBuffer");
632 else
633 bufObj = ctx->Shared->NullBufferObj;
634
635 if (bufObj)
636 _mesa_reference_buffer_object(ctx, &vao->IndexBufferObj, bufObj);
637 }
638
639
640 void GLAPIENTRY
641 _mesa_GetVertexArrayiv(GLuint vaobj, GLenum pname, GLint *param)
642 {
643 GET_CURRENT_CONTEXT(ctx);
644 struct gl_vertex_array_object *vao;
645
646 ASSERT_OUTSIDE_BEGIN_END(ctx);
647
648 /* The GL_ARB_direct_state_access specification says:
649 *
650 * "An INVALID_OPERATION error is generated if <vaobj> is not
651 * [compatibility profile: zero or] the name of an existing
652 * vertex array object."
653 */
654 vao =_mesa_lookup_vao_err(ctx, vaobj, "glGetVertexArrayiv");
655 if (!vao)
656 return;
657
658 /* The GL_ARB_direct_state_access specification says:
659 *
660 * "An INVALID_ENUM error is generated if <pname> is not
661 * ELEMENT_ARRAY_BUFFER_BINDING."
662 */
663 if (pname != GL_ELEMENT_ARRAY_BUFFER_BINDING) {
664 _mesa_error(ctx, GL_INVALID_ENUM,
665 "glGetVertexArrayiv(pname != "
666 "GL_ELEMENT_ARRAY_BUFFER_BINDING)");
667 return;
668 }
669
670 param[0] = vao->IndexBufferObj->Name;
671 }