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
  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 static GLuint
  58 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
 128 /**
 129  * Error checking for glDrawElements().  Includes parameter checking
 130  * and VBO bounds checking.
 131  * \return GL_TRUE if OK to render, GL_FALSE if error found
 132  */
 133 GLboolean
 134 _mesa_validate_DrawElements(GLcontext *ctx,
 135                             GLenum mode, GLsizei count, GLenum type,
 136                             const GLvoid *indices)
 137 {
 138    ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx,  GL_FALSE);
 139
 140    if (count <= 0) {
 141       if (count < 0)
 142          _mesa_error(ctx, GL_INVALID_VALUE, "glDrawElements(count)" );
 143       return GL_FALSE;
 144    }
 145
 146    if (mode > GL_POLYGON) {
 147       _mesa_error(ctx, GL_INVALID_ENUM, "glDrawElements(mode)" );
 148       return GL_FALSE;
 149    }
 150
 151    if (type != GL_UNSIGNED_INT &&
 152        type != GL_UNSIGNED_BYTE &&
 153        type != GL_UNSIGNED_SHORT)
 154    {
 155       _mesa_error(ctx, GL_INVALID_ENUM, "glDrawElements(type)" );
 156       return GL_FALSE;
 157    }
 158
 159    if (ctx->NewState)
 160       _mesa_update_state(ctx);
 161
 162    if (!check_valid_to_render(ctx, "glDrawElements"))
 163       return GL_FALSE;
 164
 165    /* Vertex buffer object tests */
 166    if (_mesa_is_bufferobj(ctx->Array.ElementArrayBufferObj)) {
 167       /* use indices in the buffer object */
 168       /* make sure count doesn't go outside buffer bounds */
 169       if (index_bytes(type, count) > ctx->Array.ElementArrayBufferObj->Size) {
 170          _mesa_warning(ctx, "glDrawElements index out of buffer bounds");
 171          return GL_FALSE;
 172       }
 173    }
 174    else {
 175       /* not using a VBO */
 176       if (!indices)
 177          return GL_FALSE;
 178    }
 179
 180    if (ctx->Const.CheckArrayBounds) {
 181       /* find max array index */
 182       GLuint max = max_buffer_index(ctx, count, type, indices,
 183                                     ctx->Array.ElementArrayBufferObj);
 184       if (max >= ctx->Array.ArrayObj->_MaxElement) {
 185          /* the max element is out of bounds of one or more enabled arrays */
 186          _mesa_warning(ctx, "glDrawElements() index=%u is "
 187                        "out of bounds (max=%u)", max, ctx->Array.ArrayObj->_MaxElement);
 188          return GL_FALSE;
 189       }
 190    }
 191
 192    return GL_TRUE;
 193 }
 194
 195
 196 /**
 197  * Error checking for glDrawRangeElements().  Includes parameter checking
 198  * and VBO bounds checking.
 199  * \return GL_TRUE if OK to render, GL_FALSE if error found
 200  */
 201 GLboolean
 202 _mesa_validate_DrawRangeElements(GLcontext *ctx, GLenum mode,
 203                                  GLuint start, GLuint end,
 204                                  GLsizei count, GLenum type,
 205                                  const GLvoid *indices)
 206 {
 207    ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, GL_FALSE);
 208
 209    if (count <= 0) {
 210       if (count < 0)
 211          _mesa_error(ctx, GL_INVALID_VALUE, "glDrawRangeElements(count)" );
 212       return GL_FALSE;
 213    }
 214
 215    if (mode > GL_POLYGON) {
 216       _mesa_error(ctx, GL_INVALID_ENUM, "glDrawRangeElements(mode)" );
 217       return GL_FALSE;
 218    }
 219
 220    if (end < start) {
 221       _mesa_error(ctx, GL_INVALID_VALUE, "glDrawRangeElements(end<start)");
 222       return GL_FALSE;
 223    }
 224
 225    if (type != GL_UNSIGNED_INT &&
 226        type != GL_UNSIGNED_BYTE &&
 227        type != GL_UNSIGNED_SHORT) {
 228       _mesa_error(ctx, GL_INVALID_ENUM, "glDrawRangeElements(type)" );
 229       return GL_FALSE;
 230    }
 231
 232    if (ctx->NewState)
 233       _mesa_update_state(ctx);
 234
 235    if (!check_valid_to_render(ctx, "glDrawRangeElements"))
 236       return GL_FALSE;
 237
 238    /* Vertex buffer object tests */
 239    if (_mesa_is_bufferobj(ctx->Array.ElementArrayBufferObj)) {
 240       /* use indices in the buffer object */
 241       /* make sure count doesn't go outside buffer bounds */
 242       if (index_bytes(type, count) > ctx->Array.ElementArrayBufferObj->Size) {
 243          _mesa_warning(ctx, "glDrawRangeElements index out of buffer bounds");
 244          return GL_FALSE;
 245       }
 246    }
 247    else {
 248       /* not using a VBO */
 249       if (!indices)
 250          return GL_FALSE;
 251    }
 252
 253    if (ctx->Const.CheckArrayBounds) {
 254       GLuint max = max_buffer_index(ctx, count, type, indices,
 255                                     ctx->Array.ElementArrayBufferObj);
 256       if (max >= ctx->Array.ArrayObj->_MaxElement) {
 257          /* the max element is out of bounds of one or more enabled arrays */
 258          return GL_FALSE;
 259       }
 260    }
 261
 262    return GL_TRUE;
 263 }
 264
 265
 266 /**
 267  * Called from the tnl module to error check the function parameters and
 268  * verify that we really can draw something.
 269  * \return GL_TRUE if OK to render, GL_FALSE if error found
 270  */
 271 GLboolean
 272 _mesa_validate_DrawArrays(GLcontext *ctx,
 273                           GLenum mode, GLint start, GLsizei count)
 274 {
 275    ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, GL_FALSE);
 276
 277    if (count <= 0) {
 278       if (count < 0)
 279          _mesa_error(ctx, GL_INVALID_VALUE, "glDrawArrays(count)" );
 280       return GL_FALSE;
 281    }
 282
 283    if (mode > GL_POLYGON) {
 284       _mesa_error(ctx, GL_INVALID_ENUM, "glDrawArrays(mode)" );
 285       return GL_FALSE;
 286    }
 287
 288    if (ctx->NewState)
 289       _mesa_update_state(ctx);
 290
 291    if (!check_valid_to_render(ctx, "glDrawArrays"))
 292       return GL_FALSE;
 293
 294    if (ctx->Const.CheckArrayBounds) {
 295       if (start + count > (GLint) ctx->Array.ArrayObj->_MaxElement)
 296          return GL_FALSE;
 297    }
 298
 299    return GL_TRUE;
 300 }