src/mesa/main/api_validate.c

   1 /*
   2  * Mesa 3-D graphics library
   3  * Version:  7.1
   4  *
   5  * Copyright (C) 1999-2007  Brian Paul   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  * BRIAN PAUL 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 #include "glheader.h"
  26 #include "api_validate.h"
  27 #include "bufferobj.h"
  28 #include "context.h"
  29 #include "imports.h"
  30 #include "mtypes.h"
  31 #include "state.h"
  32 #include "vbo/vbo.h"
  33
  34
  35 /**
  36  * \return  number of bytes in array [count] of type.
  37  */
  38 static GLsizei
  39 index_bytes(GLenum type, GLsizei count)
  40 {
  41    if (type == GL_UNSIGNED_INT) {
  42       return count * sizeof(GLuint);
  43    }
  44    else if (type == GL_UNSIGNED_BYTE) {
  45       return count * sizeof(GLubyte);
  46    }
  47    else {
  48       ASSERT(type == GL_UNSIGNED_SHORT);
  49       return count * sizeof(GLushort);
  50    }
  51 }
  52
  53
  54 /**
  55  * Find the max index in the given element/index buffer
  56  */
  57 GLuint
  58 _mesa_max_buffer_index(GLcontext *ctx, GLuint count, GLenum type,
  59                        const void *indices,
  60                        struct gl_buffer_object *elementBuf)
  61 {
  62    const GLubyte *map = NULL;
  63    GLuint max = 0;
  64    GLuint i;
  65
  66    if (_mesa_is_bufferobj(elementBuf)) {
  67       /* elements are in a user-defined buffer object.  need to map it */
  68       map = ctx->Driver.MapBuffer(ctx, GL_ELEMENT_ARRAY_BUFFER,
  69                                   GL_READ_ONLY, elementBuf);
  70       /* Actual address is the sum of pointers */
  71       indices = (const GLvoid *) ADD_POINTERS(map, (const GLubyte *) indices);
  72    }
  73
  74    if (type == GL_UNSIGNED_INT) {
  75       for (i = 0; i < count; i++)
  76          if (((GLuint *) indices)[i] > max)
  77             max = ((GLuint *) indices)[i];
  78    }
  79    else if (type == GL_UNSIGNED_SHORT) {
  80       for (i = 0; i < count; i++)
  81          if (((GLushort *) indices)[i] > max)
  82             max = ((GLushort *) indices)[i];
  83    }
  84    else {
  85       ASSERT(type == GL_UNSIGNED_BYTE);
  86       for (i = 0; i < count; i++)
  87          if (((GLubyte *) indices)[i] > max)
  88             max = ((GLubyte *) indices)[i];
  89    }
  90
  91    if (map) {
  92       ctx->Driver.UnmapBuffer(ctx, GL_ELEMENT_ARRAY_BUFFER_ARB, elementBuf);
  93    }
  94
  95    return max;
  96 }
  97
  98
  99 /**
 100  * Check if OK to draw arrays/elements.
 101  */
 102 static GLboolean
 103 check_valid_to_render(GLcontext *ctx, const char *function)
 104 {
 105    if (!_mesa_valid_to_render(ctx, function)) {
 106       return GL_FALSE;
 107    }
 108
 109 #if FEATURE_es2_glsl
 110    /* For ES2, we can draw if any vertex array is enabled (and we should
 111     * always have a vertex program/shader).
 112     */
 113    if (ctx->Array.ArrayObj->_Enabled == 0x0 || !ctx->VertexProgram._Current)
 114       return GL_FALSE;
 115 #else
 116    /* For regular OpenGL, only draw if we have vertex positions (regardless
 117     * of whether or not we have a vertex program/shader).
 118     */
 119    if (!ctx->Array.ArrayObj->Vertex.Enabled &&
 120        !ctx->Array.ArrayObj->VertexAttrib[0].Enabled)
 121       return GL_FALSE;
 122 #endif
 123
 124    return GL_TRUE;
 125 }
 126
 127 static GLboolean
 128 check_index_bounds(GLcontext *ctx, GLsizei count, GLenum type,
 129                    const GLvoid *indices, GLint basevertex)
 130 {
 131    struct _mesa_prim prim;
 132    struct _mesa_index_buffer ib;
 133    GLuint min, max;
 134
 135    /* Only the X Server needs to do this -- otherwise, accessing outside
 136     * array/BO bounds allows application termination.
 137     */
 138    if (!ctx->Const.CheckArrayBounds)
 139       return GL_TRUE;
 140
 141    memset(&prim, 0, sizeof(prim));
 142    prim.count = count;
 143
 144    memset(&ib, 0, sizeof(ib));
 145    ib.type = type;
 146    ib.ptr = indices;
 147    ib.obj = ctx->Array.ElementArrayBufferObj;
 148
 149    vbo_get_minmax_index(ctx, &prim, &ib, &min, &max);
 150
 151    if (min + basevertex < 0 ||
 152        max + basevertex > ctx->Array.ArrayObj->_MaxElement) {
 153       /* the max element is out of bounds of one or more enabled arrays */
 154       _mesa_warning(ctx, "glDrawElements() index=%u is "
 155                     "out of bounds (max=%u)", max, ctx->Array.ArrayObj->_MaxElement);
 156       return GL_FALSE;
 157    }
 158
 159    return GL_TRUE;
 160 }
 161
 162 /**
 163  * Error checking for glDrawElements().  Includes parameter checking
 164  * and VBO bounds checking.
 165  * \return GL_TRUE if OK to render, GL_FALSE if error found
 166  */
 167 GLboolean
 168 _mesa_validate_DrawElements(GLcontext *ctx,
 169                             GLenum mode, GLsizei count, GLenum type,
 170                             const GLvoid *indices, GLint basevertex)
 171 {
 172    ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx,  GL_FALSE);
 173
 174    if (count <= 0) {
 175       if (count < 0)
 176          _mesa_error(ctx, GL_INVALID_VALUE, "glDrawElements(count)" );
 177       return GL_FALSE;
 178    }
 179
 180    if (mode > GL_POLYGON) {
 181       _mesa_error(ctx, GL_INVALID_ENUM, "glDrawElements(mode)" );
 182       return GL_FALSE;
 183    }
 184
 185    if (type != GL_UNSIGNED_INT &&
 186        type != GL_UNSIGNED_BYTE &&
 187        type != GL_UNSIGNED_SHORT)
 188    {
 189       _mesa_error(ctx, GL_INVALID_ENUM, "glDrawElements(type)" );
 190       return GL_FALSE;
 191    }
 192
 193    if (!check_valid_to_render(ctx, "glDrawElements"))
 194       return GL_FALSE;
 195
 196    /* Vertex buffer object tests */
 197    if (_mesa_is_bufferobj(ctx->Array.ElementArrayBufferObj)) {
 198       /* use indices in the buffer object */
 199       /* make sure count doesn't go outside buffer bounds */
 200       if (index_bytes(type, count) > ctx->Array.ElementArrayBufferObj->Size) {
 201          _mesa_warning(ctx, "glDrawElements index out of buffer bounds");
 202          return GL_FALSE;
 203       }
 204    }
 205    else {
 206       /* not using a VBO */
 207       if (!indices)
 208          return GL_FALSE;
 209    }
 210
 211    if (!check_index_bounds(ctx, count, type, indices, basevertex))
 212       return GL_FALSE;
 213
 214    return GL_TRUE;
 215 }
 216
 217
 218 /**
 219  * Error checking for glDrawRangeElements().  Includes parameter checking
 220  * and VBO bounds checking.
 221  * \return GL_TRUE if OK to render, GL_FALSE if error found
 222  */
 223 GLboolean
 224 _mesa_validate_DrawRangeElements(GLcontext *ctx, GLenum mode,
 225                                  GLuint start, GLuint end,
 226                                  GLsizei count, GLenum type,
 227                                  const GLvoid *indices, GLint basevertex)
 228 {
 229    ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, GL_FALSE);
 230
 231    if (count <= 0) {
 232       if (count < 0)
 233          _mesa_error(ctx, GL_INVALID_VALUE, "glDrawRangeElements(count)" );
 234       return GL_FALSE;
 235    }
 236
 237    if (mode > GL_POLYGON) {
 238       _mesa_error(ctx, GL_INVALID_ENUM, "glDrawRangeElements(mode)" );
 239       return GL_FALSE;
 240    }
 241
 242    if (end < start) {
 243       _mesa_error(ctx, GL_INVALID_VALUE, "glDrawRangeElements(end<start)");
 244       return GL_FALSE;
 245    }
 246
 247    if (type != GL_UNSIGNED_INT &&
 248        type != GL_UNSIGNED_BYTE &&
 249        type != GL_UNSIGNED_SHORT) {
 250       _mesa_error(ctx, GL_INVALID_ENUM, "glDrawRangeElements(type)" );
 251       return GL_FALSE;
 252    }
 253
 254    if (!check_valid_to_render(ctx, "glDrawRangeElements"))
 255       return GL_FALSE;
 256
 257    /* Vertex buffer object tests */
 258    if (_mesa_is_bufferobj(ctx->Array.ElementArrayBufferObj)) {
 259       /* use indices in the buffer object */
 260       /* make sure count doesn't go outside buffer bounds */
 261       if (index_bytes(type, count) > ctx->Array.ElementArrayBufferObj->Size) {
 262          _mesa_warning(ctx, "glDrawRangeElements index out of buffer bounds");
 263          return GL_FALSE;
 264       }
 265    }
 266    else {
 267       /* not using a VBO */
 268       if (!indices)
 269          return GL_FALSE;
 270    }
 271
 272    if (!check_index_bounds(ctx, count, type, indices, basevertex))
 273       return GL_FALSE;
 274
 275    return GL_TRUE;
 276 }
 277
 278
 279 /**
 280  * Called from the tnl module to error check the function parameters and
 281  * verify that we really can draw something.
 282  * \return GL_TRUE if OK to render, GL_FALSE if error found
 283  */
 284 GLboolean
 285 _mesa_validate_DrawArrays(GLcontext *ctx,
 286                           GLenum mode, GLint start, GLsizei count)
 287 {
 288    ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, GL_FALSE);
 289
 290    if (count <= 0) {
 291       if (count < 0)
 292          _mesa_error(ctx, GL_INVALID_VALUE, "glDrawArrays(count)" );
 293       return GL_FALSE;
 294    }
 295
 296    if (mode > GL_POLYGON) {
 297       _mesa_error(ctx, GL_INVALID_ENUM, "glDrawArrays(mode)" );
 298       return GL_FALSE;
 299    }
 300
 301    if (!check_valid_to_render(ctx, "glDrawArrays"))
 302       return GL_FALSE;
 303
 304    if (ctx->Const.CheckArrayBounds) {
 305       if (start + count > (GLint) ctx->Array.ArrayObj->_MaxElement)
 306          return GL_FALSE;
 307    }
 308
 309    return GL_TRUE;
 310 }