Blender  V2.93
gl_debug_layer.cc
Go to the documentation of this file.
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2005 Blender Foundation.
17  * All rights reserved.
18  */
19 
27 #include "BLI_utildefines.h"
28 
29 #include "glew-mx.h"
30 
31 #include "gl_debug.hh"
32 
33 using GPUvoidptr = void *;
34 
35 #define GPUvoidptr_set void *ret =
36 #define GPUvoidptr_ret return ret
37 
38 #define GLboolean_set GLboolean ret =
39 #define GLboolean_ret return ret
40 
41 #define void_set
42 #define void_ret
43 
44 #define DEBUG_FUNC_DECLARE(pfn, rtn_type, fn, ...) \
45  static pfn real_##fn; \
46  static rtn_type GLAPIENTRY debug_##fn(ARG_LIST(__VA_ARGS__)) \
47  { \
48  debug::check_gl_error("generated before " #fn); \
49  rtn_type##_set real_##fn(ARG_LIST_CALL(__VA_ARGS__)); \
50  debug::check_gl_error("" #fn); \
51  rtn_type##_ret; \
52  }
53 
54 namespace blender::gpu::debug {
55 
56 /* List of wrapped functions. We don't have to support all of them.
57  * Some functions might be declared as `extern` in GLEW. We cannot override them in this case.
58  * Keep the list in alphabetical order. */
59 
60 /* Avoid very long declarations. */
61 /* clang-format off */
62 DEBUG_FUNC_DECLARE(PFNGLBEGINQUERYPROC, void, glBeginQuery, GLenum, target, GLuint, id);
63 DEBUG_FUNC_DECLARE(PFNGLBEGINTRANSFORMFEEDBACKPROC, void, glBeginTransformFeedback, GLenum, primitiveMode);
64 DEBUG_FUNC_DECLARE(PFNGLBINDBUFFERBASEPROC, void, glBindBufferBase, GLenum, target, GLuint, index, GLuint, buffer);
65 DEBUG_FUNC_DECLARE(PFNGLBINDBUFFERPROC, void, glBindBuffer, GLenum, target, GLuint, buffer);
66 DEBUG_FUNC_DECLARE(PFNGLBINDFRAMEBUFFERPROC, void, glBindFramebuffer, GLenum, target, GLuint, framebuffer);
67 DEBUG_FUNC_DECLARE(PFNGLBINDSAMPLERPROC, void, glBindSampler, GLuint, unit, GLuint, sampler);
68 DEBUG_FUNC_DECLARE(PFNGLBINDVERTEXARRAYPROC, void, glBindVertexArray, GLuint, array);
69 DEBUG_FUNC_DECLARE(PFNGLBLITFRAMEBUFFERPROC, void, glBlitFramebuffer, GLint, srcX0, GLint, srcY0, GLint, srcX1, GLint, srcY1, GLint, dstX0, GLint, dstY0, GLint, dstX1, GLint, dstY1, GLbitfield, mask, GLenum, filter);
70 DEBUG_FUNC_DECLARE(PFNGLBUFFERDATAPROC, void, glBufferData, GLenum, target, GLsizeiptr, size, const void *, data, GLenum, usage);
71 DEBUG_FUNC_DECLARE(PFNGLBUFFERSUBDATAPROC, void, glBufferSubData, GLenum, target, GLintptr, offset, GLsizeiptr, size, const void *, data);
72 DEBUG_FUNC_DECLARE(PFNGLDELETEBUFFERSPROC, void, glDeleteBuffers, GLsizei, n, const GLuint *, buffers);
73 DEBUG_FUNC_DECLARE(PFNGLDELETEFRAMEBUFFERSPROC, void, glDeleteFramebuffers, GLsizei, n, const GLuint*, framebuffers);
74 DEBUG_FUNC_DECLARE(PFNGLDELETEPROGRAMPROC, void, glDeleteProgram, GLuint, program);
75 DEBUG_FUNC_DECLARE(PFNGLDELETEQUERIESPROC, void, glDeleteQueries, GLsizei, n, const GLuint *, ids);
76 DEBUG_FUNC_DECLARE(PFNGLDELETESAMPLERSPROC, void, glDeleteSamplers, GLsizei, count, const GLuint *, samplers);
77 DEBUG_FUNC_DECLARE(PFNGLDELETESHADERPROC, void, glDeleteShader, GLuint, shader);
78 DEBUG_FUNC_DECLARE(PFNGLDELETEVERTEXARRAYSPROC, void, glDeleteVertexArrays, GLsizei, n, const GLuint *, arrays);
79 DEBUG_FUNC_DECLARE(PFNGLDRAWARRAYSINSTANCEDBASEINSTANCEPROC, void, glDrawArraysInstancedBaseInstance, GLenum, mode, GLint, first, GLsizei, count, GLsizei, primcount, GLuint, baseinstance);
80 DEBUG_FUNC_DECLARE(PFNGLDRAWARRAYSINSTANCEDPROC, void, glDrawArraysInstanced, GLenum, mode, GLint, first, GLsizei, count, GLsizei, primcount);
81 DEBUG_FUNC_DECLARE(PFNGLDRAWBUFFERSPROC, void, glDrawBuffers, GLsizei, n, const GLenum*, bufs);
82 DEBUG_FUNC_DECLARE(PFNGLDRAWELEMENTSINSTANCEDBASEVERTEXBASEINSTANCEPROC, void, glDrawElementsInstancedBaseVertexBaseInstance, GLenum, mode, GLsizei, count, GLenum, type, const void *, indices, GLsizei, primcount, GLint, basevertex, GLuint, baseinstance);
83 DEBUG_FUNC_DECLARE(PFNGLDRAWELEMENTSINSTANCEDBASEVERTEXPROC, void, glDrawElementsInstancedBaseVertex, GLenum, mode, GLsizei, count, GLenum, type, const void *, indices, GLsizei, instancecount, GLint, basevertex);
84 DEBUG_FUNC_DECLARE(PFNGLENDQUERYPROC, void, glEndQuery, GLenum, target);
85 DEBUG_FUNC_DECLARE(PFNGLENDTRANSFORMFEEDBACKPROC, void, glEndTransformFeedback, void);
86 DEBUG_FUNC_DECLARE(PFNGLFRAMEBUFFERTEXTURE2DPROC, void, glFramebufferTexture2D, GLenum, target, GLenum, attachment, GLenum, textarget, GLuint, texture, GLint, level);
87 DEBUG_FUNC_DECLARE(PFNGLFRAMEBUFFERTEXTURELAYERPROC, void, glFramebufferTextureLayer, GLenum, target, GLenum, attachment, GLuint, texture, GLint, level, GLint, layer);
88 DEBUG_FUNC_DECLARE(PFNGLFRAMEBUFFERTEXTUREPROC, void, glFramebufferTexture, GLenum, target, GLenum, attachment, GLuint, texture, GLint, level);
89 DEBUG_FUNC_DECLARE(PFNGLGENBUFFERSPROC, void, glGenBuffers, GLsizei, n, GLuint *, buffers);
90 DEBUG_FUNC_DECLARE(PFNGLGENERATEMIPMAPPROC, void, glGenerateMipmap, GLenum, target);
91 DEBUG_FUNC_DECLARE(PFNGLGENERATETEXTUREMIPMAPPROC, void, glGenerateTextureMipmap, GLuint, texture);
92 DEBUG_FUNC_DECLARE(PFNGLGENFRAMEBUFFERSPROC, void, glGenFramebuffers, GLsizei, n, GLuint *, framebuffers);
93 DEBUG_FUNC_DECLARE(PFNGLGENQUERIESPROC, void, glGenQueries, GLsizei, n, GLuint *, ids);
94 DEBUG_FUNC_DECLARE(PFNGLGENSAMPLERSPROC, void, glGenSamplers, GLsizei, n, GLuint *, samplers);
95 DEBUG_FUNC_DECLARE(PFNGLGENVERTEXARRAYSPROC, void, glGenVertexArrays, GLsizei, n, GLuint *, arrays);
96 DEBUG_FUNC_DECLARE(PFNGLLINKPROGRAMPROC, void, glLinkProgram, GLuint, program);
97 DEBUG_FUNC_DECLARE(PFNGLMAPBUFFERRANGEPROC, GPUvoidptr, glMapBufferRange, GLenum, target, GLintptr, offset, GLsizeiptr, length, GLbitfield, access);
98 DEBUG_FUNC_DECLARE(PFNGLTEXBUFFERPROC, void, glTexBuffer, GLenum, target, GLenum, internalFormat, GLuint, buffer);
99 DEBUG_FUNC_DECLARE(PFNGLTEXIMAGE3DPROC, void, glTexImage3D, GLenum, target, GLint, level, GLint, internalFormat, GLsizei, width, GLsizei, height, GLsizei, depth, GLint, border, GLenum, format, GLenum, type, const GLvoid *,pixels);
100 DEBUG_FUNC_DECLARE(PFNGLTEXSUBIMAGE3DPROC, void, glTexSubImage3D, GLenum, target, GLint, level, GLint, xoffset, GLint, yoffset, GLint, zoffset, GLsizei, width, GLsizei, height, GLsizei, depth, GLenum, format, GLenum, type, const GLvoid *, pixels);
101 DEBUG_FUNC_DECLARE(PFNGLTEXTUREBUFFERPROC, void, glTextureBuffer, GLuint, texture, GLenum, internalformat, GLuint, buffer);
102 DEBUG_FUNC_DECLARE(PFNGLUNMAPBUFFERPROC, GLboolean, glUnmapBuffer, GLenum, target);
103 DEBUG_FUNC_DECLARE(PFNGLUSEPROGRAMPROC, void, glUseProgram, GLuint, program);
104 /* clang-format on */
105 
106 #undef DEBUG_FUNC_DECLARE
107 
113 void init_debug_layer()
114 {
115 #define DEBUG_WRAP(function) \
116  do { \
117  real_##function = ::function; \
118  ::function = &debug_##function; \
119  } while (0)
120 
121  DEBUG_WRAP(glBeginQuery);
122  DEBUG_WRAP(glBeginTransformFeedback);
123  DEBUG_WRAP(glBindBuffer);
124  DEBUG_WRAP(glBindBufferBase);
125  DEBUG_WRAP(glBindFramebuffer);
126  DEBUG_WRAP(glBindSampler);
127  DEBUG_WRAP(glBindVertexArray);
128  DEBUG_WRAP(glBlitFramebuffer);
129  DEBUG_WRAP(glBufferData);
130  DEBUG_WRAP(glBufferSubData);
131  DEBUG_WRAP(glDeleteBuffers);
132  DEBUG_WRAP(glDeleteFramebuffers);
133  DEBUG_WRAP(glDeleteProgram);
134  DEBUG_WRAP(glDeleteQueries);
135  DEBUG_WRAP(glDeleteSamplers);
136  DEBUG_WRAP(glDeleteShader);
137  DEBUG_WRAP(glDeleteVertexArrays);
138  DEBUG_WRAP(glDrawArraysInstanced);
139  DEBUG_WRAP(glDrawArraysInstancedBaseInstance);
140  DEBUG_WRAP(glDrawBuffers);
141  DEBUG_WRAP(glDrawElementsInstancedBaseVertex);
142  DEBUG_WRAP(glDrawElementsInstancedBaseVertexBaseInstance);
143  DEBUG_WRAP(glEndQuery);
144  DEBUG_WRAP(glEndTransformFeedback);
145  DEBUG_WRAP(glFramebufferTexture);
146  DEBUG_WRAP(glFramebufferTexture2D);
147  DEBUG_WRAP(glFramebufferTextureLayer);
148  DEBUG_WRAP(glGenBuffers);
149  DEBUG_WRAP(glGenerateMipmap);
150  DEBUG_WRAP(glGenerateTextureMipmap);
151  DEBUG_WRAP(glGenFramebuffers);
152  DEBUG_WRAP(glGenQueries);
153  DEBUG_WRAP(glGenSamplers);
154  DEBUG_WRAP(glGenVertexArrays);
155  DEBUG_WRAP(glLinkProgram);
156  DEBUG_WRAP(glMapBufferRange);
157  DEBUG_WRAP(glTexBuffer);
158  DEBUG_WRAP(glTexImage3D);
159  DEBUG_WRAP(glTexSubImage3D);
160  DEBUG_WRAP(glTextureBuffer);
161  DEBUG_WRAP(glUnmapBuffer);
162  DEBUG_WRAP(glUseProgram);
163 
164 #undef DEBUG_WRAP
165 }
166 
167 } // namespace blender::gpu::debug
BLI_utildefines.h
width
_GL_VOID GLfloat value _GL_VOID_RET _GL_VOID const GLuint GLboolean *residences _GL_BOOL_RET _GL_VOID GLsizei GLfloat GLfloat GLfloat GLfloat const GLubyte *bitmap _GL_VOID_RET _GL_VOID GLenum const void *lists _GL_VOID_RET _GL_VOID const GLdouble *equation _GL_VOID_RET _GL_VOID GLdouble GLdouble blue _GL_VOID_RET _GL_VOID GLfloat GLfloat blue _GL_VOID_RET _GL_VOID GLint GLint blue _GL_VOID_RET _GL_VOID GLshort GLshort blue _GL_VOID_RET _GL_VOID GLubyte GLubyte blue _GL_VOID_RET _GL_VOID GLuint GLuint blue _GL_VOID_RET _GL_VOID GLushort GLushort blue _GL_VOID_RET _GL_VOID GLbyte GLbyte GLbyte alpha _GL_VOID_RET _GL_VOID GLdouble GLdouble GLdouble alpha _GL_VOID_RET _GL_VOID GLfloat GLfloat GLfloat alpha _GL_VOID_RET _GL_VOID GLint GLint GLint alpha _GL_VOID_RET _GL_VOID GLshort GLshort GLshort alpha _GL_VOID_RET _GL_VOID GLubyte GLubyte GLubyte alpha _GL_VOID_RET _GL_VOID GLuint GLuint GLuint alpha _GL_VOID_RET _GL_VOID GLushort GLushort GLushort alpha _GL_VOID_RET _GL_VOID GLenum mode _GL_VOID_RET _GL_VOID GLint GLsizei width
Definition: GPU_legacy_stubs.h:206
type
_GL_VOID GLfloat value _GL_VOID_RET _GL_VOID const GLuint GLboolean *residences _GL_BOOL_RET _GL_VOID GLsizei GLfloat GLfloat GLfloat GLfloat const GLubyte *bitmap _GL_VOID_RET _GL_VOID GLenum type
Definition: GPU_legacy_stubs.h:167
height
_GL_VOID GLfloat value _GL_VOID_RET _GL_VOID const GLuint GLboolean *residences _GL_BOOL_RET _GL_VOID GLsizei height
Definition: GPU_legacy_stubs.h:160
data
data
Definition: bmesh_operator_api_inline.h:176
size
static DBVT_INLINE btScalar size(const btDbvtVolume &a)
Definition: btDbvt.cpp:52
length
SIMD_FORCE_INLINE btScalar length(const btQuaternion &q)
Return the length of a quaternion.
Definition: btQuaternion.h:895
indices
static ushort indices[]
Definition: geom_arrow_gizmo.c:58
gl_debug.hh
DEBUG_WRAP
#define DEBUG_WRAP(function)
GPUvoidptr
void * GPUvoidptr
Definition: gl_debug_layer.cc:33
framebuffers
GPUFrameBuffer * framebuffers[FRAMEBUFFER_STACK_DEPTH]
Definition: gpu_framebuffer.cc:487
filter
DO_INLINE void filter(lfVector *V, fmatrix3x3 *S)
Definition: implicit_blender.c:774
border
IconTextureDrawCall border
Definition: interface_icons.c:1573
count
int count
Definition: interface_widgets.c:1165
shader
void KERNEL_FUNCTION_FULL_NAME() shader(KernelGlobals *kg, uint4 *input, float4 *output, int type, int filter, int i, int offset, int sample)
Definition: kernel_cpu_impl.h:151
buffer
__kernel void ccl_constant KernelData ccl_global void ccl_global char ccl_global int ccl_global char ccl_global unsigned int ccl_global float * buffer
Definition: kernel_split_function.h:33
format
format
Definition: logImageCore.h:47
blender::gpu::debug::init_debug_layer
void init_debug_layer(void)
Definition: gl_debug_layer.cc:113
blender::gpu::debug::DEBUG_FUNC_DECLARE
DEBUG_FUNC_DECLARE(PFNGLBEGINQUERYPROC, void, glBeginQuery, GLenum, target, GLuint, id)
blender::arrays
static RawVector< RawArray< int64_t, 0 > > arrays
Definition: BLI_index_range.cc:27
mask
ccl_device_inline float4 mask(const int4 &mask, const float4 &a)
Definition: util_math_float4.h:471
Generated on Tue Jan 31 2023 14:37:24 for Blender by  doxygen 1.9.1