Merge branch 'mesa_7_5_branch'
[mesa.git] / src / mesa / main / bufferobj.c
1 /*
2 * Mesa 3-D graphics library
3 * Version: 7.5
4 *
5 * Copyright (C) 1999-2008 Brian Paul All Rights Reserved.
6 * Copyright (C) 1999-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 * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
22 * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
23 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24 */
25
26
27 /**
28 * \file bufferobj.c
29 * \brief Functions for the GL_ARB_vertex/pixel_buffer_object extensions.
30 * \author Brian Paul, Ian Romanick
31 */
32
33
34 #include "glheader.h"
35 #include "hash.h"
36 #include "imports.h"
37 #include "image.h"
38 #include "context.h"
39 #include "bufferobj.h"
40
41
42 #ifdef FEATURE_OES_mapbuffer
43 #define DEFAULT_ACCESS GL_WRITE_ONLY;
44 #else
45 #define DEFAULT_ACCESS GL_READ_WRITE;
46 #endif
47
48
49 /**
50 * Get the buffer object bound to the specified target in a GL context.
51 *
52 * \param ctx GL context
53 * \param target Buffer object target to be retrieved. Currently this must
54 * be either \c GL_ARRAY_BUFFER or \c GL_ELEMENT_ARRAY_BUFFER.
55 * \return A pointer to the buffer object bound to \c target in the
56 * specified context or \c NULL if \c target is invalid.
57 */
58 static INLINE struct gl_buffer_object *
59 get_buffer(GLcontext *ctx, GLenum target)
60 {
61 struct gl_buffer_object * bufObj = NULL;
62
63 switch (target) {
64 case GL_ARRAY_BUFFER_ARB:
65 bufObj = ctx->Array.ArrayBufferObj;
66 break;
67 case GL_ELEMENT_ARRAY_BUFFER_ARB:
68 bufObj = ctx->Array.ElementArrayBufferObj;
69 break;
70 case GL_PIXEL_PACK_BUFFER_EXT:
71 bufObj = ctx->Pack.BufferObj;
72 break;
73 case GL_PIXEL_UNPACK_BUFFER_EXT:
74 bufObj = ctx->Unpack.BufferObj;
75 break;
76 default:
77 /* error must be recorded by caller */
78 return NULL;
79 }
80
81 /* bufObj should point to NullBufferObj or a user-created buffer object */
82 ASSERT(bufObj);
83
84 return bufObj;
85 }
86
87
88 /**
89 * Tests the subdata range parameters and sets the GL error code for
90 * \c glBufferSubDataARB and \c glGetBufferSubDataARB.
91 *
92 * \param ctx GL context.
93 * \param target Buffer object target on which to operate.
94 * \param offset Offset of the first byte of the subdata range.
95 * \param size Size, in bytes, of the subdata range.
96 * \param caller Name of calling function for recording errors.
97 * \return A pointer to the buffer object bound to \c target in the
98 * specified context or \c NULL if any of the parameter or state
99 * conditions for \c glBufferSubDataARB or \c glGetBufferSubDataARB
100 * are invalid.
101 *
102 * \sa glBufferSubDataARB, glGetBufferSubDataARB
103 */
104 static struct gl_buffer_object *
105 buffer_object_subdata_range_good( GLcontext * ctx, GLenum target,
106 GLintptrARB offset, GLsizeiptrARB size,
107 const char *caller )
108 {
109 struct gl_buffer_object *bufObj;
110
111 if (size < 0) {
112 _mesa_error(ctx, GL_INVALID_VALUE, "%s(size < 0)", caller);
113 return NULL;
114 }
115
116 if (offset < 0) {
117 _mesa_error(ctx, GL_INVALID_VALUE, "%s(offset < 0)", caller);
118 return NULL;
119 }
120
121 bufObj = get_buffer(ctx, target);
122 if (!bufObj) {
123 _mesa_error(ctx, GL_INVALID_ENUM, "%s(target)", caller);
124 return NULL;
125 }
126 if (bufObj->Name == 0) {
127 _mesa_error(ctx, GL_INVALID_OPERATION, "%s", caller);
128 return NULL;
129 }
130 if (offset + size > bufObj->Size) {
131 _mesa_error(ctx, GL_INVALID_VALUE,
132 "%s(size + offset > buffer size)", caller);
133 return NULL;
134 }
135 if (bufObj->Pointer) {
136 /* Buffer is currently mapped */
137 _mesa_error(ctx, GL_INVALID_OPERATION, "%s", caller);
138 return NULL;
139 }
140
141 return bufObj;
142 }
143
144
145 /**
146 * Allocate and initialize a new buffer object.
147 *
148 * Default callback for the \c dd_function_table::NewBufferObject() hook.
149 */
150 struct gl_buffer_object *
151 _mesa_new_buffer_object( GLcontext *ctx, GLuint name, GLenum target )
152 {
153 struct gl_buffer_object *obj;
154
155 (void) ctx;
156
157 obj = MALLOC_STRUCT(gl_buffer_object);
158 _mesa_initialize_buffer_object(obj, name, target);
159 return obj;
160 }
161
162
163 /**
164 * Delete a buffer object.
165 *
166 * Default callback for the \c dd_function_table::DeleteBuffer() hook.
167 */
168 void
169 _mesa_delete_buffer_object( GLcontext *ctx, struct gl_buffer_object *bufObj )
170 {
171 (void) ctx;
172
173 if (bufObj->Data)
174 _mesa_free(bufObj->Data);
175
176 /* assign strange values here to help w/ debugging */
177 bufObj->RefCount = -1000;
178 bufObj->Name = ~0;
179
180 _mesa_free(bufObj);
181 }
182
183
184
185 /**
186 * Set ptr to bufObj w/ reference counting.
187 */
188 void
189 _mesa_reference_buffer_object(GLcontext *ctx,
190 struct gl_buffer_object **ptr,
191 struct gl_buffer_object *bufObj)
192 {
193 if (*ptr == bufObj)
194 return;
195
196 if (*ptr) {
197 /* Unreference the old buffer */
198 GLboolean deleteFlag = GL_FALSE;
199 struct gl_buffer_object *oldObj = *ptr;
200
201 /*_glthread_LOCK_MUTEX(oldObj->Mutex);*/
202 ASSERT(oldObj->RefCount > 0);
203 oldObj->RefCount--;
204 #if 0
205 printf("BufferObj %p %d DECR to %d\n",
206 (void *) oldObj, oldObj->Name, oldObj->RefCount);
207 #endif
208 deleteFlag = (oldObj->RefCount == 0);
209 /*_glthread_UNLOCK_MUTEX(oldObj->Mutex);*/
210
211 if (deleteFlag) {
212
213 /* some sanity checking: don't delete a buffer still in use */
214 #if 0
215 /* unfortunately, these tests are invalid during context tear-down */
216 ASSERT(ctx->Array.ArrayBufferObj != bufObj);
217 ASSERT(ctx->Array.ElementArrayBufferObj != bufObj);
218 ASSERT(ctx->Array.ArrayObj->Vertex.BufferObj != bufObj);
219 #endif
220
221 ASSERT(ctx->Driver.DeleteBuffer);
222 ctx->Driver.DeleteBuffer(ctx, oldObj);
223 }
224
225 *ptr = NULL;
226 }
227 ASSERT(!*ptr);
228
229 if (bufObj) {
230 /* reference new buffer */
231 /*_glthread_LOCK_MUTEX(tex->Mutex);*/
232 if (bufObj->RefCount == 0) {
233 /* this buffer's being deleted (look just above) */
234 /* Not sure this can every really happen. Warn if it does. */
235 _mesa_problem(NULL, "referencing deleted buffer object");
236 *ptr = NULL;
237 }
238 else {
239 bufObj->RefCount++;
240 #if 0
241 printf("BufferObj %p %d INCR to %d\n",
242 (void *) bufObj, bufObj->Name, bufObj->RefCount);
243 #endif
244 *ptr = bufObj;
245 }
246 /*_glthread_UNLOCK_MUTEX(tex->Mutex);*/
247 }
248 }
249
250
251 /**
252 * Initialize a buffer object to default values.
253 */
254 void
255 _mesa_initialize_buffer_object( struct gl_buffer_object *obj,
256 GLuint name, GLenum target )
257 {
258 (void) target;
259
260 _mesa_bzero(obj, sizeof(struct gl_buffer_object));
261 obj->RefCount = 1;
262 obj->Name = name;
263 obj->Usage = GL_STATIC_DRAW_ARB;
264 obj->Access = DEFAULT_ACCESS;
265 }
266
267
268 /**
269 * Allocate space for and store data in a buffer object. Any data that was
270 * previously stored in the buffer object is lost. If \c data is \c NULL,
271 * memory will be allocated, but no copy will occur.
272 *
273 * This is the default callback for \c dd_function_table::BufferData()
274 * Note that all GL error checking will have been done already.
275 *
276 * \param ctx GL context.
277 * \param target Buffer object target on which to operate.
278 * \param size Size, in bytes, of the new data store.
279 * \param data Pointer to the data to store in the buffer object. This
280 * pointer may be \c NULL.
281 * \param usage Hints about how the data will be used.
282 * \param bufObj Object to be used.
283 *
284 * \sa glBufferDataARB, dd_function_table::BufferData.
285 */
286 void
287 _mesa_buffer_data( GLcontext *ctx, GLenum target, GLsizeiptrARB size,
288 const GLvoid * data, GLenum usage,
289 struct gl_buffer_object * bufObj )
290 {
291 void * new_data;
292
293 (void) ctx; (void) target;
294
295 new_data = _mesa_realloc( bufObj->Data, bufObj->Size, size );
296 if (new_data) {
297 bufObj->Data = (GLubyte *) new_data;
298 bufObj->Size = size;
299 bufObj->Usage = usage;
300
301 if (data) {
302 _mesa_memcpy( bufObj->Data, data, size );
303 }
304 }
305 }
306
307
308 /**
309 * Replace data in a subrange of buffer object. If the data range
310 * specified by \c size + \c offset extends beyond the end of the buffer or
311 * if \c data is \c NULL, no copy is performed.
312 *
313 * This is the default callback for \c dd_function_table::BufferSubData()
314 * Note that all GL error checking will have been done already.
315 *
316 * \param ctx GL context.
317 * \param target Buffer object target on which to operate.
318 * \param offset Offset of the first byte to be modified.
319 * \param size Size, in bytes, of the data range.
320 * \param data Pointer to the data to store in the buffer object.
321 * \param bufObj Object to be used.
322 *
323 * \sa glBufferSubDataARB, dd_function_table::BufferSubData.
324 */
325 void
326 _mesa_buffer_subdata( GLcontext *ctx, GLenum target, GLintptrARB offset,
327 GLsizeiptrARB size, const GLvoid * data,
328 struct gl_buffer_object * bufObj )
329 {
330 (void) ctx; (void) target;
331
332 /* this should have been caught in _mesa_BufferSubData() */
333 ASSERT(size + offset <= bufObj->Size);
334
335 if (bufObj->Data) {
336 _mesa_memcpy( (GLubyte *) bufObj->Data + offset, data, size );
337 }
338 }
339
340
341 /**
342 * Retrieve data from a subrange of buffer object. If the data range
343 * specified by \c size + \c offset extends beyond the end of the buffer or
344 * if \c data is \c NULL, no copy is performed.
345 *
346 * This is the default callback for \c dd_function_table::GetBufferSubData()
347 * Note that all GL error checking will have been done already.
348 *
349 * \param ctx GL context.
350 * \param target Buffer object target on which to operate.
351 * \param offset Offset of the first byte to be fetched.
352 * \param size Size, in bytes, of the data range.
353 * \param data Destination for data
354 * \param bufObj Object to be used.
355 *
356 * \sa glBufferGetSubDataARB, dd_function_table::GetBufferSubData.
357 */
358 void
359 _mesa_buffer_get_subdata( GLcontext *ctx, GLenum target, GLintptrARB offset,
360 GLsizeiptrARB size, GLvoid * data,
361 struct gl_buffer_object * bufObj )
362 {
363 (void) ctx; (void) target;
364
365 if (bufObj->Data && ((GLsizeiptrARB) (size + offset) <= bufObj->Size)) {
366 _mesa_memcpy( data, (GLubyte *) bufObj->Data + offset, size );
367 }
368 }
369
370
371 /**
372 * Default callback for \c dd_function_tabel::MapBuffer().
373 *
374 * The function parameters will have been already tested for errors.
375 *
376 * \param ctx GL context.
377 * \param target Buffer object target on which to operate.
378 * \param access Information about how the buffer will be accessed.
379 * \param bufObj Object to be mapped.
380 * \return A pointer to the object's internal data store that can be accessed
381 * by the processor
382 *
383 * \sa glMapBufferARB, dd_function_table::MapBuffer
384 */
385 void *
386 _mesa_buffer_map( GLcontext *ctx, GLenum target, GLenum access,
387 struct gl_buffer_object *bufObj )
388 {
389 (void) ctx;
390 (void) target;
391 (void) access;
392 /* Just return a direct pointer to the data */
393 if (bufObj->Pointer) {
394 /* already mapped! */
395 return NULL;
396 }
397 bufObj->Pointer = bufObj->Data;
398 return bufObj->Pointer;
399 }
400
401
402 /**
403 * Default callback for \c dd_function_table::MapBuffer().
404 *
405 * The input parameters will have been already tested for errors.
406 *
407 * \sa glUnmapBufferARB, dd_function_table::UnmapBuffer
408 */
409 GLboolean
410 _mesa_buffer_unmap( GLcontext *ctx, GLenum target,
411 struct gl_buffer_object *bufObj )
412 {
413 (void) ctx;
414 (void) target;
415 /* XXX we might assert here that bufObj->Pointer is non-null */
416 bufObj->Pointer = NULL;
417 return GL_TRUE;
418 }
419
420
421 /**
422 * Initialize the state associated with buffer objects
423 */
424 void
425 _mesa_init_buffer_objects( GLcontext *ctx )
426 {
427 ctx->Array.ArrayBufferObj = ctx->Shared->NullBufferObj;
428 ctx->Array.ElementArrayBufferObj = ctx->Shared->NullBufferObj;
429 }
430
431
432 /**
433 * Bind the specified target to buffer for the specified context.
434 */
435 static void
436 bind_buffer_object(GLcontext *ctx, GLenum target, GLuint buffer)
437 {
438 struct gl_buffer_object *oldBufObj;
439 struct gl_buffer_object *newBufObj = NULL;
440 struct gl_buffer_object **bindTarget = NULL;
441
442 switch (target) {
443 case GL_ARRAY_BUFFER_ARB:
444 bindTarget = &ctx->Array.ArrayBufferObj;
445 break;
446 case GL_ELEMENT_ARRAY_BUFFER_ARB:
447 bindTarget = &ctx->Array.ElementArrayBufferObj;
448 break;
449 case GL_PIXEL_PACK_BUFFER_EXT:
450 bindTarget = &ctx->Pack.BufferObj;
451 break;
452 case GL_PIXEL_UNPACK_BUFFER_EXT:
453 bindTarget = &ctx->Unpack.BufferObj;
454 break;
455 default:
456 _mesa_error(ctx, GL_INVALID_ENUM, "glBindBufferARB(target)");
457 return;
458 }
459
460 /* Get pointer to old buffer object (to be unbound) */
461 oldBufObj = get_buffer(ctx, target);
462 if (oldBufObj && oldBufObj->Name == buffer)
463 return; /* rebinding the same buffer object- no change */
464
465 /*
466 * Get pointer to new buffer object (newBufObj)
467 */
468 if (buffer == 0) {
469 /* The spec says there's not a buffer object named 0, but we use
470 * one internally because it simplifies things.
471 */
472 newBufObj = ctx->Shared->NullBufferObj;
473 }
474 else {
475 /* non-default buffer object */
476 newBufObj = _mesa_lookup_bufferobj(ctx, buffer);
477 if (!newBufObj) {
478 /* if this is a new buffer object id, allocate a buffer object now */
479 ASSERT(ctx->Driver.NewBufferObject);
480 newBufObj = ctx->Driver.NewBufferObject(ctx, buffer, target);
481 if (!newBufObj) {
482 _mesa_error(ctx, GL_OUT_OF_MEMORY, "glBindBufferARB");
483 return;
484 }
485 _mesa_HashInsert(ctx->Shared->BufferObjects, buffer, newBufObj);
486 }
487 }
488
489 /* bind new buffer */
490 _mesa_reference_buffer_object(ctx, bindTarget, newBufObj);
491
492 /* Pass BindBuffer call to device driver */
493 if (ctx->Driver.BindBuffer)
494 ctx->Driver.BindBuffer( ctx, target, newBufObj );
495 }
496
497
498 /**
499 * Update the default buffer objects in the given context to reference those
500 * specified in the shared state and release those referencing the old
501 * shared state.
502 */
503 void
504 _mesa_update_default_objects_buffer_objects(GLcontext *ctx)
505 {
506 /* Bind the NullBufferObj to remove references to those
507 * in the shared context hash table.
508 */
509 bind_buffer_object( ctx, GL_ARRAY_BUFFER_ARB, 0);
510 bind_buffer_object( ctx, GL_ELEMENT_ARRAY_BUFFER_ARB, 0);
511 bind_buffer_object( ctx, GL_PIXEL_PACK_BUFFER_ARB, 0);
512 bind_buffer_object( ctx, GL_PIXEL_UNPACK_BUFFER_ARB, 0);
513 }
514
515
516 /**
517 * When we're about to read pixel data out of a PBO (via glDrawPixels,
518 * glTexImage, etc) or write data into a PBO (via glReadPixels,
519 * glGetTexImage, etc) we call this function to check that we're not
520 * going to read out of bounds.
521 *
522 * XXX This would also be a convenient time to check that the PBO isn't
523 * currently mapped. Whoever calls this function should check for that.
524 * Remember, we can't use a PBO when it's mapped!
525 *
526 * \param width width of image to read/write
527 * \param height height of image to read/write
528 * \param depth depth of image to read/write
529 * \param format format of image to read/write
530 * \param type datatype of image to read/write
531 * \param ptr the user-provided pointer/offset
532 * \return GL_TRUE if the PBO access is OK, GL_FALSE if the access would
533 * go out of bounds.
534 */
535 GLboolean
536 _mesa_validate_pbo_access(GLuint dimensions,
537 const struct gl_pixelstore_attrib *pack,
538 GLsizei width, GLsizei height, GLsizei depth,
539 GLenum format, GLenum type, const GLvoid *ptr)
540 {
541 GLvoid *start, *end;
542 const GLubyte *sizeAddr; /* buffer size, cast to a pointer */
543
544 ASSERT(pack->BufferObj->Name != 0);
545
546 if (pack->BufferObj->Size == 0)
547 /* no buffer! */
548 return GL_FALSE;
549
550 /* get address of first pixel we'll read */
551 start = _mesa_image_address(dimensions, pack, ptr, width, height,
552 format, type, 0, 0, 0);
553
554 /* get address just past the last pixel we'll read */
555 end = _mesa_image_address(dimensions, pack, ptr, width, height,
556 format, type, depth-1, height-1, width);
557
558
559 sizeAddr = ((const GLubyte *) 0) + pack->BufferObj->Size;
560
561 if ((const GLubyte *) start > sizeAddr) {
562 /* This will catch negative values / wrap-around */
563 return GL_FALSE;
564 }
565 if ((const GLubyte *) end > sizeAddr) {
566 /* Image read goes beyond end of buffer */
567 return GL_FALSE;
568 }
569
570 /* OK! */
571 return GL_TRUE;
572 }
573
574
575 /**
576 * If the source of glBitmap data is a PBO, check that we won't read out
577 * of buffer bounds, then map the buffer.
578 * If not sourcing from a PBO, just return the bitmap pointer.
579 * This is a helper function for (some) drivers.
580 * Return NULL if error.
581 * If non-null return, must call _mesa_unmap_bitmap_pbo() when done.
582 */
583 const GLubyte *
584 _mesa_map_bitmap_pbo(GLcontext *ctx,
585 const struct gl_pixelstore_attrib *unpack,
586 const GLubyte *bitmap)
587 {
588 const GLubyte *buf;
589
590 if (unpack->BufferObj->Name) {
591 /* unpack from PBO */
592 buf = (GLubyte *) ctx->Driver.MapBuffer(ctx, GL_PIXEL_UNPACK_BUFFER_EXT,
593 GL_READ_ONLY_ARB,
594 unpack->BufferObj);
595 if (!buf)
596 return NULL;
597
598 buf = ADD_POINTERS(buf, bitmap);
599 }
600 else {
601 /* unpack from normal memory */
602 buf = bitmap;
603 }
604
605 return buf;
606 }
607
608
609 /**
610 * Counterpart to _mesa_map_bitmap_pbo()
611 * This is a helper function for (some) drivers.
612 */
613 void
614 _mesa_unmap_bitmap_pbo(GLcontext *ctx,
615 const struct gl_pixelstore_attrib *unpack)
616 {
617 if (unpack->BufferObj->Name) {
618 ctx->Driver.UnmapBuffer(ctx, GL_PIXEL_UNPACK_BUFFER_EXT,
619 unpack->BufferObj);
620 }
621 }
622
623
624 /**
625 * \sa _mesa_map_bitmap_pbo
626 */
627 const GLvoid *
628 _mesa_map_drawpix_pbo(GLcontext *ctx,
629 const struct gl_pixelstore_attrib *unpack,
630 const GLvoid *pixels)
631 {
632 const GLvoid *buf;
633
634 if (unpack->BufferObj->Name) {
635 /* unpack from PBO */
636 buf = (GLubyte *) ctx->Driver.MapBuffer(ctx, GL_PIXEL_UNPACK_BUFFER_EXT,
637 GL_READ_ONLY_ARB,
638 unpack->BufferObj);
639 if (!buf)
640 return NULL;
641
642 buf = ADD_POINTERS(buf, pixels);
643 }
644 else {
645 /* unpack from normal memory */
646 buf = pixels;
647 }
648
649 return buf;
650 }
651
652
653 /**
654 * \sa _mesa_unmap_bitmap_pbo
655 */
656 void
657 _mesa_unmap_drawpix_pbo(GLcontext *ctx,
658 const struct gl_pixelstore_attrib *unpack)
659 {
660 if (unpack->BufferObj->Name) {
661 ctx->Driver.UnmapBuffer(ctx, GL_PIXEL_UNPACK_BUFFER_EXT,
662 unpack->BufferObj);
663 }
664 }
665
666
667 /**
668 * If PBO is bound, map the buffer, return dest pointer in mapped buffer.
669 * Call _mesa_unmap_readpix_pbo() when finished
670 * \return NULL if error
671 */
672 void *
673 _mesa_map_readpix_pbo(GLcontext *ctx,
674 const struct gl_pixelstore_attrib *pack,
675 GLvoid *dest)
676 {
677 void *buf;
678
679 if (pack->BufferObj->Name) {
680 /* pack into PBO */
681 buf = (GLubyte *) ctx->Driver.MapBuffer(ctx, GL_PIXEL_PACK_BUFFER_EXT,
682 GL_WRITE_ONLY_ARB,
683 pack->BufferObj);
684 if (!buf)
685 return NULL;
686
687 buf = ADD_POINTERS(buf, dest);
688 }
689 else {
690 /* pack to normal memory */
691 buf = dest;
692 }
693
694 return buf;
695 }
696
697
698 /**
699 * Counterpart to _mesa_map_readpix_pbo()
700 */
701 void
702 _mesa_unmap_readpix_pbo(GLcontext *ctx,
703 const struct gl_pixelstore_attrib *pack)
704 {
705 if (pack->BufferObj->Name) {
706 ctx->Driver.UnmapBuffer(ctx, GL_PIXEL_PACK_BUFFER_EXT, pack->BufferObj);
707 }
708 }
709
710
711
712 /**
713 * Return the gl_buffer_object for the given ID.
714 * Always return NULL for ID 0.
715 */
716 struct gl_buffer_object *
717 _mesa_lookup_bufferobj(GLcontext *ctx, GLuint buffer)
718 {
719 if (buffer == 0)
720 return NULL;
721 else
722 return (struct gl_buffer_object *)
723 _mesa_HashLookup(ctx->Shared->BufferObjects, buffer);
724 }
725
726
727 /**
728 * If *ptr points to obj, set ptr = the Null/default buffer object.
729 * This is a helper for buffer object deletion.
730 * The GL spec says that deleting a buffer object causes it to get
731 * unbound from all arrays in the current context.
732 */
733 static void
734 unbind(GLcontext *ctx,
735 struct gl_buffer_object **ptr,
736 struct gl_buffer_object *obj)
737 {
738 if (*ptr == obj) {
739 _mesa_reference_buffer_object(ctx, ptr, ctx->Shared->NullBufferObj);
740 }
741 }
742
743
744
745 /**********************************************************************/
746 /* API Functions */
747 /**********************************************************************/
748
749 void GLAPIENTRY
750 _mesa_BindBufferARB(GLenum target, GLuint buffer)
751 {
752 GET_CURRENT_CONTEXT(ctx);
753 ASSERT_OUTSIDE_BEGIN_END(ctx);
754
755 bind_buffer_object(ctx, target, buffer);
756 }
757
758
759 /**
760 * Delete a set of buffer objects.
761 *
762 * \param n Number of buffer objects to delete.
763 * \param ids Array of \c n buffer object IDs.
764 */
765 void GLAPIENTRY
766 _mesa_DeleteBuffersARB(GLsizei n, const GLuint *ids)
767 {
768 GET_CURRENT_CONTEXT(ctx);
769 GLsizei i;
770 ASSERT_OUTSIDE_BEGIN_END(ctx);
771
772 if (n < 0) {
773 _mesa_error(ctx, GL_INVALID_VALUE, "glDeleteBuffersARB(n)");
774 return;
775 }
776
777 _glthread_LOCK_MUTEX(ctx->Shared->Mutex);
778
779 for (i = 0; i < n; i++) {
780 struct gl_buffer_object *bufObj = _mesa_lookup_bufferobj(ctx, ids[i]);
781 if (bufObj) {
782 GLuint j;
783
784 ASSERT(bufObj->Name == ids[i]);
785
786 if (bufObj->Pointer) {
787 /* if mapped, unmap it now */
788 ctx->Driver.UnmapBuffer(ctx, 0, bufObj);
789 bufObj->Access = DEFAULT_ACCESS;
790 bufObj->Pointer = NULL;
791 }
792
793 /* unbind any vertex pointers bound to this buffer */
794 unbind(ctx, &ctx->Array.ArrayObj->Vertex.BufferObj, bufObj);
795 unbind(ctx, &ctx->Array.ArrayObj->Normal.BufferObj, bufObj);
796 unbind(ctx, &ctx->Array.ArrayObj->Color.BufferObj, bufObj);
797 unbind(ctx, &ctx->Array.ArrayObj->SecondaryColor.BufferObj, bufObj);
798 unbind(ctx, &ctx->Array.ArrayObj->FogCoord.BufferObj, bufObj);
799 unbind(ctx, &ctx->Array.ArrayObj->Index.BufferObj, bufObj);
800 unbind(ctx, &ctx->Array.ArrayObj->EdgeFlag.BufferObj, bufObj);
801 for (j = 0; j < MAX_TEXTURE_COORD_UNITS; j++) {
802 unbind(ctx, &ctx->Array.ArrayObj->TexCoord[j].BufferObj, bufObj);
803 }
804 for (j = 0; j < VERT_ATTRIB_MAX; j++) {
805 unbind(ctx, &ctx->Array.ArrayObj->VertexAttrib[j].BufferObj, bufObj);
806 }
807
808 if (ctx->Array.ArrayBufferObj == bufObj) {
809 _mesa_BindBufferARB( GL_ARRAY_BUFFER_ARB, 0 );
810 }
811 if (ctx->Array.ElementArrayBufferObj == bufObj) {
812 _mesa_BindBufferARB( GL_ELEMENT_ARRAY_BUFFER_ARB, 0 );
813 }
814
815 /* unbind any pixel pack/unpack pointers bound to this buffer */
816 if (ctx->Pack.BufferObj == bufObj) {
817 _mesa_BindBufferARB( GL_PIXEL_PACK_BUFFER_EXT, 0 );
818 }
819 if (ctx->Unpack.BufferObj == bufObj) {
820 _mesa_BindBufferARB( GL_PIXEL_UNPACK_BUFFER_EXT, 0 );
821 }
822
823 /* The ID is immediately freed for re-use */
824 _mesa_HashRemove(ctx->Shared->BufferObjects, bufObj->Name);
825 _mesa_reference_buffer_object(ctx, &bufObj, NULL);
826 }
827 }
828
829 _glthread_UNLOCK_MUTEX(ctx->Shared->Mutex);
830 }
831
832
833 /**
834 * Generate a set of unique buffer object IDs and store them in \c buffer.
835 *
836 * \param n Number of IDs to generate.
837 * \param buffer Array of \c n locations to store the IDs.
838 */
839 void GLAPIENTRY
840 _mesa_GenBuffersARB(GLsizei n, GLuint *buffer)
841 {
842 GET_CURRENT_CONTEXT(ctx);
843 GLuint first;
844 GLint i;
845 ASSERT_OUTSIDE_BEGIN_END(ctx);
846
847 if (n < 0) {
848 _mesa_error(ctx, GL_INVALID_VALUE, "glGenBuffersARB");
849 return;
850 }
851
852 if (!buffer) {
853 return;
854 }
855
856 /*
857 * This must be atomic (generation and allocation of buffer object IDs)
858 */
859 _glthread_LOCK_MUTEX(ctx->Shared->Mutex);
860
861 first = _mesa_HashFindFreeKeyBlock(ctx->Shared->BufferObjects, n);
862
863 /* Allocate new, empty buffer objects and return identifiers */
864 for (i = 0; i < n; i++) {
865 struct gl_buffer_object *bufObj;
866 GLuint name = first + i;
867 GLenum target = 0;
868 bufObj = ctx->Driver.NewBufferObject( ctx, name, target );
869 if (!bufObj) {
870 _glthread_UNLOCK_MUTEX(ctx->Shared->Mutex);
871 _mesa_error(ctx, GL_OUT_OF_MEMORY, "glGenBuffersARB");
872 return;
873 }
874 _mesa_HashInsert(ctx->Shared->BufferObjects, first + i, bufObj);
875 buffer[i] = first + i;
876 }
877
878 _glthread_UNLOCK_MUTEX(ctx->Shared->Mutex);
879 }
880
881
882 /**
883 * Determine if ID is the name of a buffer object.
884 *
885 * \param id ID of the potential buffer object.
886 * \return \c GL_TRUE if \c id is the name of a buffer object,
887 * \c GL_FALSE otherwise.
888 */
889 GLboolean GLAPIENTRY
890 _mesa_IsBufferARB(GLuint id)
891 {
892 struct gl_buffer_object *bufObj;
893 GET_CURRENT_CONTEXT(ctx);
894 ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, GL_FALSE);
895
896 _glthread_LOCK_MUTEX(ctx->Shared->Mutex);
897 bufObj = _mesa_lookup_bufferobj(ctx, id);
898 _glthread_UNLOCK_MUTEX(ctx->Shared->Mutex);
899
900 return bufObj ? GL_TRUE : GL_FALSE;
901 }
902
903
904 void GLAPIENTRY
905 _mesa_BufferDataARB(GLenum target, GLsizeiptrARB size,
906 const GLvoid * data, GLenum usage)
907 {
908 GET_CURRENT_CONTEXT(ctx);
909 struct gl_buffer_object *bufObj;
910 ASSERT_OUTSIDE_BEGIN_END(ctx);
911
912 if (size < 0) {
913 _mesa_error(ctx, GL_INVALID_VALUE, "glBufferDataARB(size < 0)");
914 return;
915 }
916
917 switch (usage) {
918 case GL_STREAM_DRAW_ARB:
919 case GL_STREAM_READ_ARB:
920 case GL_STREAM_COPY_ARB:
921 case GL_STATIC_DRAW_ARB:
922 case GL_STATIC_READ_ARB:
923 case GL_STATIC_COPY_ARB:
924 case GL_DYNAMIC_DRAW_ARB:
925 case GL_DYNAMIC_READ_ARB:
926 case GL_DYNAMIC_COPY_ARB:
927 /* OK */
928 break;
929 default:
930 _mesa_error(ctx, GL_INVALID_ENUM, "glBufferDataARB(usage)");
931 return;
932 }
933
934 bufObj = get_buffer(ctx, target);
935 if (!bufObj) {
936 _mesa_error(ctx, GL_INVALID_ENUM, "glBufferDataARB(target)" );
937 return;
938 }
939 if (bufObj->Name == 0) {
940 _mesa_error(ctx, GL_INVALID_OPERATION, "glBufferDataARB(buffer 0)" );
941 return;
942 }
943
944 if (bufObj->Pointer) {
945 /* Unmap the existing buffer. We'll replace it now. Not an error. */
946 ctx->Driver.UnmapBuffer(ctx, target, bufObj);
947 bufObj->Access = DEFAULT_ACCESS;
948 bufObj->Pointer = NULL;
949 }
950
951 FLUSH_VERTICES(ctx, _NEW_BUFFER_OBJECT);
952
953 ASSERT(ctx->Driver.BufferData);
954
955 bufObj->Written = GL_TRUE;
956
957 /* Give the buffer object to the driver! <data> may be null! */
958 ctx->Driver.BufferData( ctx, target, size, data, usage, bufObj );
959 }
960
961
962 void GLAPIENTRY
963 _mesa_BufferSubDataARB(GLenum target, GLintptrARB offset,
964 GLsizeiptrARB size, const GLvoid * data)
965 {
966 GET_CURRENT_CONTEXT(ctx);
967 struct gl_buffer_object *bufObj;
968 ASSERT_OUTSIDE_BEGIN_END(ctx);
969
970 bufObj = buffer_object_subdata_range_good( ctx, target, offset, size,
971 "glBufferSubDataARB" );
972 if (!bufObj) {
973 /* error already recorded */
974 return;
975 }
976
977 bufObj->Written = GL_TRUE;
978
979 ASSERT(ctx->Driver.BufferSubData);
980 ctx->Driver.BufferSubData( ctx, target, offset, size, data, bufObj );
981 }
982
983
984 void GLAPIENTRY
985 _mesa_GetBufferSubDataARB(GLenum target, GLintptrARB offset,
986 GLsizeiptrARB size, void * data)
987 {
988 GET_CURRENT_CONTEXT(ctx);
989 struct gl_buffer_object *bufObj;
990 ASSERT_OUTSIDE_BEGIN_END(ctx);
991
992 bufObj = buffer_object_subdata_range_good( ctx, target, offset, size,
993 "glGetBufferSubDataARB" );
994 if (!bufObj) {
995 /* error already recorded */
996 return;
997 }
998
999 ASSERT(ctx->Driver.GetBufferSubData);
1000 ctx->Driver.GetBufferSubData( ctx, target, offset, size, data, bufObj );
1001 }
1002
1003
1004 void * GLAPIENTRY
1005 _mesa_MapBufferARB(GLenum target, GLenum access)
1006 {
1007 GET_CURRENT_CONTEXT(ctx);
1008 struct gl_buffer_object * bufObj;
1009 ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, NULL);
1010
1011 switch (access) {
1012 case GL_READ_ONLY_ARB:
1013 case GL_WRITE_ONLY_ARB:
1014 case GL_READ_WRITE_ARB:
1015 /* OK */
1016 break;
1017 default:
1018 _mesa_error(ctx, GL_INVALID_ENUM, "glMapBufferARB(access)");
1019 return NULL;
1020 }
1021
1022 bufObj = get_buffer(ctx, target);
1023 if (!bufObj) {
1024 _mesa_error(ctx, GL_INVALID_ENUM, "glMapBufferARB(target)" );
1025 return NULL;
1026 }
1027 if (bufObj->Name == 0) {
1028 _mesa_error(ctx, GL_INVALID_OPERATION, "glMapBufferARB(buffer 0)" );
1029 return NULL;
1030 }
1031 if (bufObj->Pointer) {
1032 _mesa_error(ctx, GL_INVALID_OPERATION, "glMapBufferARB(already mapped)");
1033 return NULL;
1034 }
1035
1036 ASSERT(ctx->Driver.MapBuffer);
1037 bufObj->Pointer = ctx->Driver.MapBuffer( ctx, target, access, bufObj );
1038 if (!bufObj->Pointer) {
1039 _mesa_error(ctx, GL_OUT_OF_MEMORY, "glMapBufferARB(access)");
1040 }
1041
1042 bufObj->Access = access;
1043 if (access == GL_WRITE_ONLY_ARB || access == GL_READ_WRITE_ARB)
1044 bufObj->Written = GL_TRUE;
1045
1046 return bufObj->Pointer;
1047 }
1048
1049
1050 GLboolean GLAPIENTRY
1051 _mesa_UnmapBufferARB(GLenum target)
1052 {
1053 GET_CURRENT_CONTEXT(ctx);
1054 struct gl_buffer_object *bufObj;
1055 GLboolean status = GL_TRUE;
1056 ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, GL_FALSE);
1057
1058 bufObj = get_buffer(ctx, target);
1059 if (!bufObj) {
1060 _mesa_error(ctx, GL_INVALID_ENUM, "glUnmapBufferARB(target)" );
1061 return GL_FALSE;
1062 }
1063 if (bufObj->Name == 0) {
1064 _mesa_error(ctx, GL_INVALID_OPERATION, "glUnmapBufferARB" );
1065 return GL_FALSE;
1066 }
1067 if (!bufObj->Pointer) {
1068 _mesa_error(ctx, GL_INVALID_OPERATION, "glUnmapBufferARB");
1069 return GL_FALSE;
1070 }
1071
1072 status = ctx->Driver.UnmapBuffer( ctx, target, bufObj );
1073 bufObj->Access = DEFAULT_ACCESS;
1074 bufObj->Pointer = NULL;
1075
1076 return status;
1077 }
1078
1079
1080 void GLAPIENTRY
1081 _mesa_GetBufferParameterivARB(GLenum target, GLenum pname, GLint *params)
1082 {
1083 GET_CURRENT_CONTEXT(ctx);
1084 struct gl_buffer_object *bufObj;
1085 ASSERT_OUTSIDE_BEGIN_END(ctx);
1086
1087 bufObj = get_buffer(ctx, target);
1088 if (!bufObj) {
1089 _mesa_error(ctx, GL_INVALID_ENUM, "GetBufferParameterivARB(target)" );
1090 return;
1091 }
1092 if (bufObj->Name == 0) {
1093 _mesa_error(ctx, GL_INVALID_OPERATION, "GetBufferParameterivARB" );
1094 return;
1095 }
1096
1097 switch (pname) {
1098 case GL_BUFFER_SIZE_ARB:
1099 *params = (GLint) bufObj->Size;
1100 break;
1101 case GL_BUFFER_USAGE_ARB:
1102 *params = bufObj->Usage;
1103 break;
1104 case GL_BUFFER_ACCESS_ARB:
1105 *params = bufObj->Access;
1106 break;
1107 case GL_BUFFER_MAPPED_ARB:
1108 *params = (bufObj->Pointer != NULL);
1109 break;
1110 default:
1111 _mesa_error(ctx, GL_INVALID_ENUM, "glGetBufferParameterivARB(pname)");
1112 return;
1113 }
1114 }
1115
1116
1117 void GLAPIENTRY
1118 _mesa_GetBufferPointervARB(GLenum target, GLenum pname, GLvoid **params)
1119 {
1120 GET_CURRENT_CONTEXT(ctx);
1121 struct gl_buffer_object * bufObj;
1122 ASSERT_OUTSIDE_BEGIN_END(ctx);
1123
1124 if (pname != GL_BUFFER_MAP_POINTER_ARB) {
1125 _mesa_error(ctx, GL_INVALID_ENUM, "glGetBufferPointervARB(pname)");
1126 return;
1127 }
1128
1129 bufObj = get_buffer(ctx, target);
1130 if (!bufObj) {
1131 _mesa_error(ctx, GL_INVALID_ENUM, "glGetBufferPointervARB(target)" );
1132 return;
1133 }
1134 if (bufObj->Name == 0) {
1135 _mesa_error(ctx, GL_INVALID_OPERATION, "glGetBufferPointervARB" );
1136 return;
1137 }
1138
1139 *params = bufObj->Pointer;
1140 }