src/mesa/main/pbo.c

   1 /*
   2  * Mesa 3-D graphics library
   3  *
   4  * Copyright (C) 1999-2008  Brian Paul   All Rights Reserved.
   5  * Copyright (C) 2009-2011  VMware, Inc.  All Rights Reserved.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a
   8  * copy of this software and associated documentation files (the "Software"),
   9  * to deal in the Software without restriction, including without limitation
  10  * 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:
  13  *
  14  * The above copyright notice and this permission notice shall be included
  15  * in all copies or substantial portions of the Software.
  16  *
  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 BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  21  * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24
  25
  26 /**
  27  * \file pbo.c
  28  * \brief Functions related to Pixel Buffer Objects.
  29  */
  30
  31
  32
  33 #include "glheader.h"
  34 #include "bufferobj.h"
  35 #include "image.h"
  36 #include "imports.h"
  37 #include "mtypes.h"
  38 #include "pbo.h"
  39
  40
  41
  42 /**
  43  * When we're about to read pixel data out of a PBO (via glDrawPixels,
  44  * glTexImage, etc) or write data into a PBO (via glReadPixels,
  45  * glGetTexImage, etc) we call this function to check that we're not
  46  * going to read/write out of bounds.
  47  *
  48  * XXX This would also be a convenient time to check that the PBO isn't
  49  * currently mapped.  Whoever calls this function should check for that.
  50  * Remember, we can't use a PBO when it's mapped!
  51  *
  52  * If we're not using a PBO, this is a no-op.
  53  *
  54  * \param width  width of image to read/write
  55  * \param height  height of image to read/write
  56  * \param depth  depth of image to read/write
  57  * \param format  format of image to read/write
  58  * \param type  datatype of image to read/write
  59  * \param clientMemSize  the maximum number of bytes to read/write
  60  * \param ptr  the user-provided pointer/offset
  61  * \return GL_TRUE if the buffer access is OK, GL_FALSE if the access would
  62  *         go out of bounds.
  63  */
  64 GLboolean
  65 _mesa_validate_pbo_access(GLuint dimensions,
  66                           const struct gl_pixelstore_attrib *pack,
  67                           GLsizei width, GLsizei height, GLsizei depth,
  68                           GLenum format, GLenum type, GLsizei clientMemSize,
  69                           const GLvoid *ptr)
  70 {
  71    /* unsigned, to detect overflow/wrap-around */
  72    uintptr_t start, end, offset, size;
  73
  74    /* If no PBO is bound, 'ptr' is a pointer to client memory containing
  75       'clientMemSize' bytes.
  76       If a PBO is bound, 'ptr' is an offset into the bound PBO.
  77       In that case 'clientMemSize' is ignored: we just use the PBO's size.
  78     */
  79    if (!_mesa_is_bufferobj(pack->BufferObj)) {
  80       offset = 0;
  81       size = clientMemSize;
  82    } else {
  83       offset = (uintptr_t)ptr;
  84       size = pack->BufferObj->Size;
  85       /* The ARB_pixel_buffer_object spec says:
  86        *    "INVALID_OPERATION is generated by ColorTable, ColorSubTable,
  87        *    ConvolutionFilter2D, ConvolutionFilter1D, SeparableFilter2D,
  88        *    TexImage1D, TexImage2D, TexImage3D, TexSubImage1D,
  89        *    TexSubImage2D, TexSubImage3D, and DrawPixels if the current
  90        *    PIXEL_UNPACK_BUFFER_BINDING_ARB value is non-zero and the data
  91        *    parameter is not evenly divisible into the number of basic machine
  92        *    units needed to store in memory a datum indicated by the type
  93        *    parameter."
  94        */
  95       if (type != GL_BITMAP &&
  96           (offset % _mesa_sizeof_packed_type(type)))
  97          return GL_FALSE;
  98    }
  99
 100    if (size == 0)
 101       /* no buffer! */
 102       return GL_FALSE;
 103
 104    /* get the offset to the first pixel we'll read/write */
 105    start = _mesa_image_offset(dimensions, pack, width, height,
 106                               format, type, 0, 0, 0);
 107
 108    /* get the offset to just past the last pixel we'll read/write */
 109    end =  _mesa_image_offset(dimensions, pack, width, height,
 110                              format, type, depth-1, height-1, width);
 111
 112    start += offset;
 113    end += offset;
 114
 115    if (start > size) {
 116       /* This will catch negative values / wrap-around */
 117       return GL_FALSE;
 118    }
 119    if (end > size) {
 120       /* Image read/write goes beyond end of buffer */
 121       return GL_FALSE;
 122    }
 123
 124    /* OK! */
 125    return GL_TRUE;
 126 }
 127
 128
 129 /**
 130  * For commands that read from a PBO (glDrawPixels, glTexImage,
 131  * glPolygonStipple, etc), if we're reading from a PBO, map it read-only
 132  * and return the pointer into the PBO.  If we're not reading from a
 133  * PBO, return \p src as-is.
 134  * If non-null return, must call _mesa_unmap_pbo_source() when done.
 135  *
 136  * \return NULL if error, else pointer to start of data
 137  */
 138 const GLvoid *
 139 _mesa_map_pbo_source(struct gl_context *ctx,
 140                      const struct gl_pixelstore_attrib *unpack,
 141                      const GLvoid *src)
 142 {
 143    const GLubyte *buf;
 144
 145    if (_mesa_is_bufferobj(unpack->BufferObj)) {
 146       /* unpack from PBO */
 147       buf = (GLubyte *) ctx->Driver.MapBufferRange(ctx, 0,
 148                                                    unpack->BufferObj->Size,
 149                                                    GL_MAP_READ_BIT,
 150                                                    unpack->BufferObj);
 151       if (!buf)
 152          return NULL;
 153
 154       buf = ADD_POINTERS(buf, src);
 155    }
 156    else {
 157       /* unpack from normal memory */
 158       buf = src;
 159    }
 160
 161    return buf;
 162 }
 163
 164
 165 /**
 166  * Combine PBO-read validation and mapping.
 167  * If any GL errors are detected, they'll be recorded and NULL returned.
 168  * \sa _mesa_validate_pbo_access
 169  * \sa _mesa_map_pbo_source
 170  * A call to this function should have a matching call to
 171  * _mesa_unmap_pbo_source().
 172  */
 173 const GLvoid *
 174 _mesa_map_validate_pbo_source(struct gl_context *ctx,
 175                               GLuint dimensions,
 176                               const struct gl_pixelstore_attrib *unpack,
 177                               GLsizei width, GLsizei height, GLsizei depth,
 178                               GLenum format, GLenum type,
 179                               GLsizei clientMemSize,
 180                               const GLvoid *ptr, const char *where)
 181 {
 182    ASSERT(dimensions == 1 || dimensions == 2 || dimensions == 3);
 183
 184    if (!_mesa_validate_pbo_access(dimensions, unpack, width, height, depth,
 185                                   format, type, clientMemSize, ptr)) {
 186       if (_mesa_is_bufferobj(unpack->BufferObj)) {
 187          _mesa_error(ctx, GL_INVALID_OPERATION,
 188                      "%s(out of bounds PBO access)", where);
 189       } else {
 190          _mesa_error(ctx, GL_INVALID_OPERATION,
 191                      "%s(out of bounds access: bufSize (%d) is too small)",
 192                      where, clientMemSize);
 193       }
 194       return NULL;
 195    }
 196
 197    if (!_mesa_is_bufferobj(unpack->BufferObj)) {
 198       /* non-PBO access: no further validation to be done */
 199       return ptr;
 200    }
 201
 202    if (_mesa_bufferobj_mapped(unpack->BufferObj)) {
 203       /* buffer is already mapped - that's an error */
 204       _mesa_error(ctx, GL_INVALID_OPERATION, "%s(PBO is mapped)", where);
 205       return NULL;
 206    }
 207
 208    ptr = _mesa_map_pbo_source(ctx, unpack, ptr);
 209    return ptr;
 210 }
 211
 212
 213 /**
 214  * Counterpart to _mesa_map_pbo_source()
 215  */
 216 void
 217 _mesa_unmap_pbo_source(struct gl_context *ctx,
 218                        const struct gl_pixelstore_attrib *unpack)
 219 {
 220    ASSERT(unpack != &ctx->Pack); /* catch pack/unpack mismatch */
 221    if (_mesa_is_bufferobj(unpack->BufferObj)) {
 222       ctx->Driver.UnmapBuffer(ctx, unpack->BufferObj);
 223    }
 224 }
 225
 226
 227 /**
 228  * For commands that write to a PBO (glReadPixels, glGetColorTable, etc),
 229  * if we're writing to a PBO, map it write-only and return the pointer
 230  * into the PBO.  If we're not writing to a PBO, return \p dst as-is.
 231  * If non-null return, must call _mesa_unmap_pbo_dest() when done.
 232  *
 233  * \return NULL if error, else pointer to start of data
 234  */
 235 void *
 236 _mesa_map_pbo_dest(struct gl_context *ctx,
 237                    const struct gl_pixelstore_attrib *pack,
 238                    GLvoid *dest)
 239 {
 240    void *buf;
 241
 242    if (_mesa_is_bufferobj(pack->BufferObj)) {
 243       /* pack into PBO */
 244       buf = (GLubyte *) ctx->Driver.MapBufferRange(ctx, 0,
 245                                                    pack->BufferObj->Size,
 246                                                    GL_MAP_WRITE_BIT,
 247                                                    pack->BufferObj);
 248       if (!buf)
 249          return NULL;
 250
 251       buf = ADD_POINTERS(buf, dest);
 252    }
 253    else {
 254       /* pack to normal memory */
 255       buf = dest;
 256    }
 257
 258    return buf;
 259 }
 260
 261
 262 /**
 263  * Combine PBO-write validation and mapping.
 264  * If any GL errors are detected, they'll be recorded and NULL returned.
 265  * \sa _mesa_validate_pbo_access
 266  * \sa _mesa_map_pbo_dest
 267  * A call to this function should have a matching call to
 268  * _mesa_unmap_pbo_dest().
 269  */
 270 GLvoid *
 271 _mesa_map_validate_pbo_dest(struct gl_context *ctx,
 272                             GLuint dimensions,
 273                             const struct gl_pixelstore_attrib *unpack,
 274                             GLsizei width, GLsizei height, GLsizei depth,
 275                             GLenum format, GLenum type, GLsizei clientMemSize,
 276                             GLvoid *ptr, const char *where)
 277 {
 278    ASSERT(dimensions == 1 || dimensions == 2 || dimensions == 3);
 279
 280    if (!_mesa_validate_pbo_access(dimensions, unpack, width, height, depth,
 281                                   format, type, clientMemSize, ptr)) {
 282       if (_mesa_is_bufferobj(unpack->BufferObj)) {
 283          _mesa_error(ctx, GL_INVALID_OPERATION,
 284                      "%s(out of bounds PBO access)", where);
 285       } else {
 286          _mesa_error(ctx, GL_INVALID_OPERATION,
 287                      "%s(out of bounds access: bufSize (%d) is too small)",
 288                      where, clientMemSize);
 289       }
 290       return NULL;
 291    }
 292
 293    if (!_mesa_is_bufferobj(unpack->BufferObj)) {
 294       /* non-PBO access: no further validation to be done */
 295       return ptr;
 296    }
 297
 298    if (_mesa_bufferobj_mapped(unpack->BufferObj)) {
 299       /* buffer is already mapped - that's an error */
 300       _mesa_error(ctx, GL_INVALID_OPERATION, "%s(PBO is mapped)", where);
 301       return NULL;
 302    }
 303
 304    ptr = _mesa_map_pbo_dest(ctx, unpack, ptr);
 305    return ptr;
 306 }
 307
 308
 309 /**
 310  * Counterpart to _mesa_map_pbo_dest()
 311  */
 312 void
 313 _mesa_unmap_pbo_dest(struct gl_context *ctx,
 314                      const struct gl_pixelstore_attrib *pack)
 315 {
 316    ASSERT(pack != &ctx->Unpack); /* catch pack/unpack mismatch */
 317    if (_mesa_is_bufferobj(pack->BufferObj)) {
 318       ctx->Driver.UnmapBuffer(ctx, pack->BufferObj);
 319    }
 320 }
 321
 322
 323 /**
 324  * Check if an unpack PBO is active prior to fetching a texture image.
 325  * If so, do bounds checking and map the buffer into main memory.
 326  * Any errors detected will be recorded.
 327  * The caller _must_ call _mesa_unmap_teximage_pbo() too!
 328  */
 329 const GLvoid *
 330 _mesa_validate_pbo_teximage(struct gl_context *ctx, GLuint dimensions,
 331                             GLsizei width, GLsizei height, GLsizei depth,
 332                             GLenum format, GLenum type, const GLvoid *pixels,
 333                             const struct gl_pixelstore_attrib *unpack,
 334                             const char *funcName)
 335 {
 336    GLubyte *buf;
 337
 338    if (!_mesa_is_bufferobj(unpack->BufferObj)) {
 339       /* no PBO */
 340       return pixels;
 341    }
 342    if (!_mesa_validate_pbo_access(dimensions, unpack, width, height, depth,
 343                                   format, type, INT_MAX, pixels)) {
 344       _mesa_error(ctx, GL_INVALID_OPERATION, funcName, "(invalid PBO access)");
 345       return NULL;
 346    }
 347
 348    buf = (GLubyte *) ctx->Driver.MapBufferRange(ctx, 0,
 349                                                 unpack->BufferObj->Size,
 350                                                 GL_MAP_READ_BIT,
 351                                                 unpack->BufferObj);
 352    if (!buf) {
 353       _mesa_error(ctx, GL_INVALID_OPERATION, funcName, "(PBO is mapped)");
 354       return NULL;
 355    }
 356
 357    return ADD_POINTERS(buf, pixels);
 358 }
 359
 360
 361 /**
 362  * Check if an unpack PBO is active prior to fetching a compressed texture
 363  * image.
 364  * If so, do bounds checking and map the buffer into main memory.
 365  * Any errors detected will be recorded.
 366  * The caller _must_ call _mesa_unmap_teximage_pbo() too!
 367  */
 368 const GLvoid *
 369 _mesa_validate_pbo_compressed_teximage(struct gl_context *ctx,
 370                                  GLsizei imageSize, const GLvoid *pixels,
 371                                  const struct gl_pixelstore_attrib *packing,
 372                                  const char *funcName)
 373 {
 374    GLubyte *buf;
 375
 376    if (!_mesa_is_bufferobj(packing->BufferObj)) {
 377       /* not using a PBO - return pointer unchanged */
 378       return pixels;
 379    }
 380    if ((const GLubyte *) pixels + imageSize >
 381        ((const GLubyte *) 0) + packing->BufferObj->Size) {
 382       /* out of bounds read! */
 383       _mesa_error(ctx, GL_INVALID_OPERATION, funcName, "(invalid PBO access)");
 384       return NULL;
 385    }
 386
 387    buf = (GLubyte*) ctx->Driver.MapBufferRange(ctx, 0,
 388                                                packing->BufferObj->Size,
 389                                                GL_MAP_READ_BIT,
 390                                                packing->BufferObj);
 391    if (!buf) {
 392       _mesa_error(ctx, GL_INVALID_OPERATION, funcName, "(PBO is mapped");
 393       return NULL;
 394    }
 395
 396    return ADD_POINTERS(buf, pixels);
 397 }
 398
 399
 400 /**
 401  * This function must be called after either of the validate_pbo_*_teximage()
 402  * functions.  It unmaps the PBO buffer if it was mapped earlier.
 403  */
 404 void
 405 _mesa_unmap_teximage_pbo(struct gl_context *ctx,
 406                          const struct gl_pixelstore_attrib *unpack)
 407 {
 408    if (_mesa_is_bufferobj(unpack->BufferObj)) {
 409       ctx->Driver.UnmapBuffer(ctx, unpack->BufferObj);
 410    }
 411 }