2 * Mesa 3-D graphics library
4 * Copyright (C) 1999-2008 Brian Paul All Rights Reserved.
5 * Copyright (C) 2009-2011 VMware, Inc. All Rights Reserved.
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the "Software"),
9 * to deal in the Software without restriction, including without limitation
10 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
11 * and/or sell copies of the Software, and to permit persons to whom the
12 * Software is furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
21 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
22 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
23 * OTHER DEALINGS IN THE SOFTWARE.
29 * \brief Functions related to Pixel Buffer Objects.
35 #include "bufferobj.h"
36 #include "glformats.h"
45 * When we're about to read pixel data out of a PBO (via glDrawPixels,
46 * glTexImage, etc) or write data into a PBO (via glReadPixels,
47 * glGetTexImage, etc) we call this function to check that we're not
48 * going to read/write out of bounds.
50 * XXX This would also be a convenient time to check that the PBO isn't
51 * currently mapped. Whoever calls this function should check for that.
52 * Remember, we can't use a PBO when it's mapped!
54 * If we're not using a PBO, this is a no-op.
56 * \param width width of image to read/write
57 * \param height height of image to read/write
58 * \param depth depth of image to read/write
59 * \param format format of image to read/write
60 * \param type datatype of image to read/write
61 * \param clientMemSize the maximum number of bytes to read/write
62 * \param ptr the user-provided pointer/offset
63 * \return GL_TRUE if the buffer access is OK, GL_FALSE if the access would
67 _mesa_validate_pbo_access(GLuint dimensions
,
68 const struct gl_pixelstore_attrib
*pack
,
69 GLsizei width
, GLsizei height
, GLsizei depth
,
70 GLenum format
, GLenum type
, GLsizei clientMemSize
,
73 /* unsigned, to detect overflow/wrap-around */
74 uintptr_t start
, end
, offset
, size
;
76 /* If no PBO is bound, 'ptr' is a pointer to client memory containing
77 'clientMemSize' bytes.
78 If a PBO is bound, 'ptr' is an offset into the bound PBO.
79 In that case 'clientMemSize' is ignored: we just use the PBO's size.
81 if (!_mesa_is_bufferobj(pack
->BufferObj
)) {
83 size
= (clientMemSize
== INT_MAX
) ? UINTPTR_MAX
: clientMemSize
;
85 offset
= (uintptr_t)ptr
;
86 size
= pack
->BufferObj
->Size
;
87 /* The ARB_pixel_buffer_object spec says:
88 * "INVALID_OPERATION is generated by ColorTable, ColorSubTable,
89 * ConvolutionFilter2D, ConvolutionFilter1D, SeparableFilter2D,
90 * TexImage1D, TexImage2D, TexImage3D, TexSubImage1D,
91 * TexSubImage2D, TexSubImage3D, and DrawPixels if the current
92 * PIXEL_UNPACK_BUFFER_BINDING_ARB value is non-zero and the data
93 * parameter is not evenly divisible into the number of basic machine
94 * units needed to store in memory a datum indicated by the type
97 if (type
!= GL_BITMAP
&&
98 (offset
% _mesa_sizeof_packed_type(type
)))
106 /* If the size of the image is zero then no pixels are accessed so we
107 * don't need to check anything else.
109 if (width
== 0 || height
== 0 || depth
== 0)
112 /* get the offset to the first pixel we'll read/write */
113 start
= _mesa_image_offset(dimensions
, pack
, width
, height
,
114 format
, type
, 0, 0, 0);
116 /* get the offset to just past the last pixel we'll read/write */
117 end
= _mesa_image_offset(dimensions
, pack
, width
, height
,
118 format
, type
, depth
-1, height
-1, width
);
124 /* This will catch negative values / wrap-around */
128 /* Image read/write goes beyond end of buffer */
138 * For commands that read from a PBO (glDrawPixels, glTexImage,
139 * glPolygonStipple, etc), if we're reading from a PBO, map it read-only
140 * and return the pointer into the PBO. If we're not reading from a
141 * PBO, return \p src as-is.
142 * If non-null return, must call _mesa_unmap_pbo_source() when done.
144 * \return NULL if error, else pointer to start of data
147 _mesa_map_pbo_source(struct gl_context
*ctx
,
148 const struct gl_pixelstore_attrib
*unpack
,
153 if (_mesa_is_bufferobj(unpack
->BufferObj
)) {
154 /* unpack from PBO */
155 buf
= (GLubyte
*) ctx
->Driver
.MapBufferRange(ctx
, 0,
156 unpack
->BufferObj
->Size
,
163 buf
= ADD_POINTERS(buf
, src
);
166 /* unpack from normal memory */
174 * Perform PBO validation for read operations with uncompressed textures.
175 * If any GL errors are detected, false is returned, otherwise returns true.
176 * \sa _mesa_validate_pbo_access
179 _mesa_validate_pbo_source(struct gl_context
*ctx
, GLuint dimensions
,
180 const struct gl_pixelstore_attrib
*unpack
,
181 GLsizei width
, GLsizei height
, GLsizei depth
,
182 GLenum format
, GLenum type
,
183 GLsizei clientMemSize
,
184 const GLvoid
*ptr
, const char *where
)
186 assert(dimensions
== 1 || dimensions
== 2 || dimensions
== 3);
188 if (!_mesa_validate_pbo_access(dimensions
, unpack
, width
, height
, depth
,
189 format
, type
, clientMemSize
, ptr
)) {
190 if (_mesa_is_bufferobj(unpack
->BufferObj
)) {
191 _mesa_error(ctx
, GL_INVALID_OPERATION
,
192 "%s(out of bounds PBO access)",
195 _mesa_error(ctx
, GL_INVALID_OPERATION
,
196 "%s(out of bounds access: bufSize (%d) is too small)",
197 where
, clientMemSize
);
202 if (!_mesa_is_bufferobj(unpack
->BufferObj
)) {
203 /* non-PBO access: no further validation to be done */
207 if (_mesa_check_disallowed_mapping(unpack
->BufferObj
)) {
208 /* buffer is already mapped - that's an error */
209 _mesa_error(ctx
, GL_INVALID_OPERATION
, "%s(PBO is mapped)",
218 * Perform PBO validation for read operations with compressed textures.
219 * If any GL errors are detected, false is returned, otherwise returns true.
222 _mesa_validate_pbo_source_compressed(struct gl_context
*ctx
, GLuint dimensions
,
223 const struct gl_pixelstore_attrib
*unpack
,
224 GLsizei imageSize
, const GLvoid
*pixels
,
227 if (!_mesa_is_bufferobj(unpack
->BufferObj
)) {
228 /* not using a PBO */
232 if ((const GLubyte
*) pixels
+ imageSize
>
233 ((const GLubyte
*) 0) + unpack
->BufferObj
->Size
) {
234 /* out of bounds read! */
235 _mesa_error(ctx
, GL_INVALID_OPERATION
, "%s(invalid PBO access)",
240 if (_mesa_check_disallowed_mapping(unpack
->BufferObj
)) {
241 /* buffer is already mapped - that's an error */
242 _mesa_error(ctx
, GL_INVALID_OPERATION
, "%s(PBO is mapped)",
251 * Perform PBO-read mapping.
252 * If any GL errors are detected, they'll be recorded and NULL returned.
253 * \sa _mesa_validate_pbo_source
254 * \sa _mesa_map_pbo_source
255 * A call to this function should have a matching call to
256 * _mesa_unmap_pbo_source().
259 _mesa_map_validate_pbo_source(struct gl_context
*ctx
,
261 const struct gl_pixelstore_attrib
*unpack
,
262 GLsizei width
, GLsizei height
, GLsizei depth
,
263 GLenum format
, GLenum type
,
264 GLsizei clientMemSize
,
265 const GLvoid
*ptr
, const char *where
)
267 if (!_mesa_validate_pbo_source(ctx
, dimensions
, unpack
,
268 width
, height
, depth
, format
, type
,
269 clientMemSize
, ptr
, where
)) {
273 ptr
= _mesa_map_pbo_source(ctx
, unpack
, ptr
);
279 * Counterpart to _mesa_map_pbo_source()
282 _mesa_unmap_pbo_source(struct gl_context
*ctx
,
283 const struct gl_pixelstore_attrib
*unpack
)
285 assert(unpack
!= &ctx
->Pack
); /* catch pack/unpack mismatch */
286 if (_mesa_is_bufferobj(unpack
->BufferObj
)) {
287 ctx
->Driver
.UnmapBuffer(ctx
, unpack
->BufferObj
, MAP_INTERNAL
);
293 * For commands that write to a PBO (glReadPixels, glGetColorTable, etc),
294 * if we're writing to a PBO, map it write-only and return the pointer
295 * into the PBO. If we're not writing to a PBO, return \p dst as-is.
296 * If non-null return, must call _mesa_unmap_pbo_dest() when done.
298 * \return NULL if error, else pointer to start of data
301 _mesa_map_pbo_dest(struct gl_context
*ctx
,
302 const struct gl_pixelstore_attrib
*pack
,
307 if (_mesa_is_bufferobj(pack
->BufferObj
)) {
309 buf
= (GLubyte
*) ctx
->Driver
.MapBufferRange(ctx
, 0,
310 pack
->BufferObj
->Size
,
317 buf
= ADD_POINTERS(buf
, dest
);
320 /* pack to normal memory */
329 * Combine PBO-write validation and mapping.
330 * If any GL errors are detected, they'll be recorded and NULL returned.
331 * \sa _mesa_validate_pbo_access
332 * \sa _mesa_map_pbo_dest
333 * A call to this function should have a matching call to
334 * _mesa_unmap_pbo_dest().
337 _mesa_map_validate_pbo_dest(struct gl_context
*ctx
,
339 const struct gl_pixelstore_attrib
*unpack
,
340 GLsizei width
, GLsizei height
, GLsizei depth
,
341 GLenum format
, GLenum type
, GLsizei clientMemSize
,
342 GLvoid
*ptr
, const char *where
)
344 assert(dimensions
== 1 || dimensions
== 2 || dimensions
== 3);
346 if (!_mesa_validate_pbo_access(dimensions
, unpack
, width
, height
, depth
,
347 format
, type
, clientMemSize
, ptr
)) {
348 if (_mesa_is_bufferobj(unpack
->BufferObj
)) {
349 _mesa_error(ctx
, GL_INVALID_OPERATION
,
350 "%s(out of bounds PBO access)", where
);
352 _mesa_error(ctx
, GL_INVALID_OPERATION
,
353 "%s(out of bounds access: bufSize (%d) is too small)",
354 where
, clientMemSize
);
359 if (!_mesa_is_bufferobj(unpack
->BufferObj
)) {
360 /* non-PBO access: no further validation to be done */
364 if (_mesa_check_disallowed_mapping(unpack
->BufferObj
)) {
365 /* buffer is already mapped - that's an error */
366 _mesa_error(ctx
, GL_INVALID_OPERATION
, "%s(PBO is mapped)", where
);
370 ptr
= _mesa_map_pbo_dest(ctx
, unpack
, ptr
);
376 * Counterpart to _mesa_map_pbo_dest()
379 _mesa_unmap_pbo_dest(struct gl_context
*ctx
,
380 const struct gl_pixelstore_attrib
*pack
)
382 assert(pack
!= &ctx
->Unpack
); /* catch pack/unpack mismatch */
383 if (_mesa_is_bufferobj(pack
->BufferObj
)) {
384 ctx
->Driver
.UnmapBuffer(ctx
, pack
->BufferObj
, MAP_INTERNAL
);
390 * Check if an unpack PBO is active prior to fetching a texture image.
391 * If so, do bounds checking and map the buffer into main memory.
392 * Any errors detected will be recorded.
393 * The caller _must_ call _mesa_unmap_teximage_pbo() too!
396 _mesa_validate_pbo_teximage(struct gl_context
*ctx
, GLuint dimensions
,
397 GLsizei width
, GLsizei height
, GLsizei depth
,
398 GLenum format
, GLenum type
, const GLvoid
*pixels
,
399 const struct gl_pixelstore_attrib
*unpack
,
400 const char *funcName
)
404 if (!_mesa_is_bufferobj(unpack
->BufferObj
)) {
408 if (!_mesa_validate_pbo_access(dimensions
, unpack
, width
, height
, depth
,
409 format
, type
, INT_MAX
, pixels
)) {
410 _mesa_error(ctx
, GL_INVALID_OPERATION
, "%s%uD(invalid PBO access)",
411 funcName
, dimensions
);
415 buf
= (GLubyte
*) ctx
->Driver
.MapBufferRange(ctx
, 0,
416 unpack
->BufferObj
->Size
,
421 _mesa_error(ctx
, GL_INVALID_OPERATION
, "%s%uD(PBO is mapped)", funcName
,
426 return ADD_POINTERS(buf
, pixels
);
431 * Check if an unpack PBO is active prior to fetching a compressed texture
433 * If so, do bounds checking and map the buffer into main memory.
434 * Any errors detected will be recorded.
435 * The caller _must_ call _mesa_unmap_teximage_pbo() too!
438 _mesa_validate_pbo_compressed_teximage(struct gl_context
*ctx
,
439 GLuint dimensions
, GLsizei imageSize
,
440 const GLvoid
*pixels
,
441 const struct gl_pixelstore_attrib
*packing
,
442 const char *funcName
)
446 if (!_mesa_validate_pbo_source_compressed(ctx
, dimensions
, packing
,
447 imageSize
, pixels
, funcName
)) {
448 /* error is already set during validation */
452 if (!_mesa_is_bufferobj(packing
->BufferObj
)) {
453 /* not using a PBO - return pointer unchanged */
457 buf
= (GLubyte
*) ctx
->Driver
.MapBufferRange(ctx
, 0,
458 packing
->BufferObj
->Size
,
463 /* Validation above already checked that PBO is not mapped, so buffer
464 * should not be null.
468 return ADD_POINTERS(buf
, pixels
);
473 * This function must be called after either of the validate_pbo_*_teximage()
474 * functions. It unmaps the PBO buffer if it was mapped earlier.
477 _mesa_unmap_teximage_pbo(struct gl_context
*ctx
,
478 const struct gl_pixelstore_attrib
*unpack
)
480 if (_mesa_is_bufferobj(unpack
->BufferObj
)) {
481 ctx
->Driver
.UnmapBuffer(ctx
, unpack
->BufferObj
, MAP_INTERNAL
);