[Bf-blender-cvs] [82a197cc7f7] master: GPUDebug: Reformat GL debug callbacks and move them to GL backend

Clément Foucault noreply at git.blender.org
Tue Sep 1 00:30:43 CEST 2020


Commit: 82a197cc7f74be2e8f4fbe2d40fc2aec100c4276
Author: Clément Foucault
Date:   Mon Aug 31 22:41:04 2020 +0200
Branches: master
https://developer.blender.org/rB82a197cc7f74be2e8f4fbe2d40fc2aec100c4276

GPUDebug: Reformat GL debug callbacks and move them to GL backend

Now the callbacks are setup for each debug context.

The formating has been reworked to be less verbose and make errors
and warnings stand out from the notifications.
Errors are most of the time sufficiently explicit in their message.

This also remove the support for AMD_debug_output which is 10 years old.

This is related to the Vulkan port T68990.

===================================================================

M	source/blender/gpu/CMakeLists.txt
M	source/blender/gpu/GPU_debug.h
M	source/blender/gpu/intern/gpu_debug.cc
M	source/blender/gpu/intern/gpu_init_exit.c
M	source/blender/gpu/intern/gpu_private.h
M	source/blender/gpu/opengl/gl_context.cc
A	source/blender/gpu/opengl/gl_debug.cc
A	source/blender/gpu/opengl/gl_debug.hh

===================================================================

diff --git a/source/blender/gpu/CMakeLists.txt b/source/blender/gpu/CMakeLists.txt
index 549a7585e1b..cf0399b776d 100644
--- a/source/blender/gpu/CMakeLists.txt
+++ b/source/blender/gpu/CMakeLists.txt
@@ -90,6 +90,7 @@ set(SRC
   opengl/gl_batch.cc
   opengl/gl_context.cc
   opengl/gl_drawlist.cc
+  opengl/gl_debug.cc
   opengl/gl_framebuffer.cc
   opengl/gl_immediate.cc
   opengl/gl_shader.cc
@@ -148,6 +149,7 @@ set(SRC
   opengl/gl_backend.hh
   opengl/gl_batch.hh
   opengl/gl_context.hh
+  opengl/gl_debug.hh
   opengl/gl_drawlist.hh
   opengl/gl_framebuffer.hh
   opengl/gl_immediate.hh
diff --git a/source/blender/gpu/GPU_debug.h b/source/blender/gpu/GPU_debug.h
index be822056678..09dc02c0fc6 100644
--- a/source/blender/gpu/GPU_debug.h
+++ b/source/blender/gpu/GPU_debug.h
@@ -30,9 +30,6 @@ extern "C" {
 /* prints something if debug mode is active only */
 void GPU_print_error_debug(const char *str);
 
-/* inserts a debug marker message for the debug context messaging system */
-void GPU_string_marker(const char *str);
-
 #ifdef __cplusplus
 }
 #endif
diff --git a/source/blender/gpu/intern/gpu_debug.cc b/source/blender/gpu/intern/gpu_debug.cc
index f7d6236071d..f179a241926 100644
--- a/source/blender/gpu/intern/gpu_debug.cc
+++ b/source/blender/gpu/intern/gpu_debug.cc
@@ -36,226 +36,6 @@
 #include <stdlib.h>
 #include <string.h>
 
-#ifndef __APPLE__ /* only non-Apple systems implement OpenGL debug callbacks */
-
-/* control whether we use older AMD_debug_output extension
- * some supported GPU + OS combos do not have the newer extensions */
-#  define LEGACY_DEBUG 1
-
-/* Debug callbacks need the same calling convention as OpenGL functions. */
-#  if defined(_WIN32)
-#    define APIENTRY __stdcall
-#  else
-#    define APIENTRY
-#  endif
-
-static const char *source_name(GLenum source)
-{
-  switch (source) {
-    case GL_DEBUG_SOURCE_API:
-      return "API";
-    case GL_DEBUG_SOURCE_WINDOW_SYSTEM:
-      return "window system";
-    case GL_DEBUG_SOURCE_SHADER_COMPILER:
-      return "shader compiler";
-    case GL_DEBUG_SOURCE_THIRD_PARTY:
-      return "3rd party";
-    case GL_DEBUG_SOURCE_APPLICATION:
-      return "application";
-    case GL_DEBUG_SOURCE_OTHER:
-      return "other";
-    default:
-      return "???";
-  }
-}
-
-static const char *message_type_name(GLenum message)
-{
-  switch (message) {
-    case GL_DEBUG_TYPE_ERROR:
-      return "error";
-    case GL_DEBUG_TYPE_DEPRECATED_BEHAVIOR:
-      return "deprecated behavior";
-    case GL_DEBUG_TYPE_UNDEFINED_BEHAVIOR:
-      return "undefined behavior";
-    case GL_DEBUG_TYPE_PORTABILITY:
-      return "portability";
-    case GL_DEBUG_TYPE_PERFORMANCE:
-      return "performance";
-    case GL_DEBUG_TYPE_OTHER:
-      return "other";
-    case GL_DEBUG_TYPE_MARKER:
-      return "marker"; /* KHR has this, ARB does not */
-    default:
-      return "???";
-  }
-}
-
-static void APIENTRY gpu_debug_proc(GLenum source,
-                                    GLenum type,
-                                    GLuint UNUSED(id),
-                                    GLenum severity,
-                                    GLsizei UNUSED(length),
-                                    const GLchar *message,
-                                    const GLvoid *UNUSED(userParm))
-{
-  bool backtrace = false;
-
-  switch (severity) {
-    case GL_DEBUG_SEVERITY_HIGH:
-      backtrace = true;
-      ATTR_FALLTHROUGH;
-    case GL_DEBUG_SEVERITY_MEDIUM:
-    case GL_DEBUG_SEVERITY_LOW:
-    case GL_DEBUG_SEVERITY_NOTIFICATION: /* KHR has this, ARB does not */
-      fprintf(stderr, "GL %s %s: %s\n", source_name(source), message_type_name(type), message);
-  }
-
-  if (backtrace) {
-    BLI_system_backtrace(stderr);
-    fflush(stderr);
-  }
-}
-
-#  if LEGACY_DEBUG
-
-static const char *category_name_amd(GLenum category)
-{
-  switch (category) {
-    case GL_DEBUG_CATEGORY_API_ERROR_AMD:
-      return "API error";
-    case GL_DEBUG_CATEGORY_WINDOW_SYSTEM_AMD:
-      return "window system";
-    case GL_DEBUG_CATEGORY_DEPRECATION_AMD:
-      return "deprecated behavior";
-    case GL_DEBUG_CATEGORY_UNDEFINED_BEHAVIOR_AMD:
-      return "undefined behavior";
-    case GL_DEBUG_CATEGORY_PERFORMANCE_AMD:
-      return "performance";
-    case GL_DEBUG_CATEGORY_SHADER_COMPILER_AMD:
-      return "shader compiler";
-    case GL_DEBUG_CATEGORY_APPLICATION_AMD:
-      return "application";
-    case GL_DEBUG_CATEGORY_OTHER_AMD:
-      return "other";
-    default:
-      return "???";
-  }
-}
-
-static void APIENTRY gpu_debug_proc_amd(GLuint UNUSED(id),
-                                        GLenum category,
-                                        GLenum severity,
-                                        GLsizei UNUSED(length),
-                                        const GLchar *message,
-                                        GLvoid *UNUSED(userParm))
-{
-  bool backtrace = false;
-
-  switch (severity) {
-    case GL_DEBUG_SEVERITY_HIGH:
-      backtrace = true;
-      ATTR_FALLTHROUGH;
-    case GL_DEBUG_SEVERITY_MEDIUM:
-    case GL_DEBUG_SEVERITY_LOW:
-      fprintf(stderr, "GL %s: %s\n", category_name_amd(category), message);
-  }
-
-  if (backtrace) {
-    BLI_system_backtrace(stderr);
-    fflush(stderr);
-  }
-}
-#  endif /* LEGACY_DEBUG */
-
-#  undef APIENTRY
-#endif /* not Apple */
-
-void gpu_debug_init(void)
-{
-#ifdef __APPLE__
-  fprintf(stderr, "OpenGL debug callback is not available on Apple.\n");
-#else /* not Apple */
-  const char success[] = "Successfully hooked OpenGL debug callback.";
-
-  if (GLEW_VERSION_4_3 || GLEW_KHR_debug) {
-    fprintf(stderr,
-            "Using %s\n",
-            GLEW_VERSION_4_3 ? "OpenGL 4.3 debug facilities" : "KHR_debug extension");
-    glEnable(GL_DEBUG_OUTPUT);
-    glEnable(GL_DEBUG_OUTPUT_SYNCHRONOUS);
-    glDebugMessageCallback((GLDEBUGPROC)gpu_debug_proc, NULL);
-    glDebugMessageControl(GL_DONT_CARE, GL_DONT_CARE, GL_DONT_CARE, 0, NULL, GL_TRUE);
-    GPU_string_marker(success);
-  }
-  else if (GLEW_ARB_debug_output) {
-    fprintf(stderr, "Using ARB_debug_output extension\n");
-    glEnable(GL_DEBUG_OUTPUT_SYNCHRONOUS);
-    glDebugMessageCallbackARB((GLDEBUGPROCARB)gpu_debug_proc, NULL);
-    glDebugMessageControlARB(GL_DONT_CARE, GL_DONT_CARE, GL_DONT_CARE, 0, NULL, GL_TRUE);
-    GPU_string_marker(success);
-  }
-#  if LEGACY_DEBUG
-  else if (GLEW_AMD_debug_output) {
-    fprintf(stderr, "Using AMD_debug_output extension\n");
-    glDebugMessageCallbackAMD(gpu_debug_proc_amd, NULL);
-    glDebugMessageEnableAMD(GL_DONT_CARE, GL_DONT_CARE, 0, NULL, GL_TRUE);
-    GPU_string_marker(success);
-  }
-#  endif
-  else {
-    fprintf(stderr, "Failed to hook OpenGL debug callback.\n");
-  }
-#endif /* not Apple */
-}
-
-void gpu_debug_exit(void)
-{
-#ifndef __APPLE__
-  if (GLEW_VERSION_4_3 || GLEW_KHR_debug) {
-    glDebugMessageCallback(NULL, NULL);
-  }
-  else if (GLEW_ARB_debug_output) {
-    glDebugMessageCallbackARB(NULL, NULL);
-  }
-#  if LEGACY_DEBUG
-  else if (GLEW_AMD_debug_output) {
-    glDebugMessageCallbackAMD(NULL, NULL);
-  }
-#  endif
-#endif
-}
-
-void GPU_string_marker(const char *buf)
-{
-#ifdef __APPLE__
-  UNUSED_VARS(buf);
-#else /* not Apple */
-  if (GLEW_VERSION_4_3 || GLEW_KHR_debug) {
-    glDebugMessageInsert(GL_DEBUG_SOURCE_APPLICATION,
-                         GL_DEBUG_TYPE_MARKER,
-                         0,
-                         GL_DEBUG_SEVERITY_NOTIFICATION,
-                         -1,
-                         buf);
-  }
-  else if (GLEW_ARB_debug_output) {
-    glDebugMessageInsertARB(GL_DEBUG_SOURCE_APPLICATION_ARB,
-                            GL_DEBUG_TYPE_OTHER_ARB,
-                            0,
-                            GL_DEBUG_SEVERITY_LOW_ARB,
-                            -1,
-                            buf);
-  }
-#  if LEGACY_DEBUG
-  else if (GLEW_AMD_debug_output) {
-    glDebugMessageInsertAMD(
-        GL_DEBUG_CATEGORY_APPLICATION_AMD, GL_DEBUG_SEVERITY_LOW_AMD, 0, 0, buf);
-  }
-#  endif
-#endif /* not Apple */
-}
-
 void GPU_print_error_debug(const char *str)
 {
   if (G.debug & G_DEBUG) {
diff --git a/source/blender/gpu/intern/gpu_init_exit.c b/source/blender/gpu/intern/gpu_init_exit.c
index 9ae13771842..4cb43db9bce 100644
--- a/source/blender/gpu/intern/gpu_init_exit.c
+++ b/source/blender/gpu/intern/gpu_init_exit.c
@@ -54,10 +54,6 @@ void GPU_init(void)
   gpu_codegen_init();
   gpu_material_library_init();
 
-  if (G.debug & G_DEBUG_GPU) {
-    gpu_debug_init();
-  }
-
   gpu_batch_init();
 
   if (!G.background) {
@@ -81,10 +77,6 @@ void GPU_exit(void)
 
   gpu_batch_exit();
 
-  if (G.debug & G_DEBUG_GPU) {
-    gpu_debug_exit();
-  }
-
   gpu_material_library_exit();
   gpu_codegen_exit();
 
diff --git a/source/blender/gpu/intern/gpu_private.h b/source/blender/gpu/intern/gpu_private.h
index 92663190b8f..505ac3b0278 100644
--- a/source/blender/gpu/intern/gpu_private.h
+++ b/source/blender/gpu/intern/gpu_private.h
@@ -32,10 +32,6 @@ void gpu_platform_exit(void);
 void gpu_extensions_init(void);
 void gpu_extensions_exit(void);
 
-/* gpu_debug.c */
-void gpu_debug_init(void);
-void gpu_debug_exit(void);
-
 /* gpu_pbvh.c */
 void gpu_pbvh_init(void);
 void gpu_pbvh_exit(void);
diff --git a/source/blender/gpu/opengl/gl_context.cc b/source/blender/gpu/opengl/gl_context.cc
index e89eeca1c8a..7d564004a01 100644
--- a/source/blender/gpu/opengl/gl_context.cc
+++ b/source/blender/gpu/opengl/gl_context.cc
@@ -25,12 +25,15 @@
 #include "BLI_system.h"
 #include "BLI_utildefines.h"
 
+#include "BKE_global.h"
+
 #include "GPU_framebuffer.h"
 
 #include "GHOST_C-api.h"
 
 #include "gpu_context_private.hh"
 
+#include "gl_debug.hh"
 #include "gl_immediate.hh"
 #include "gl_state.hh"
 
@@ -47,6 +50,10 @@ using namespace blender::gpu;
 GLContext::GLContext(void *ghost_window, GLSharedOrphanLists &shared_orphan_list)
     : shared_orphan_list_(shared_orphan_list)
 {
+  if (G.debug & G_DEBUG_GPU) {
+    debug::init_gl_callbacks();
+  }
+
   float data[4] = {0.0f, 0.0f, 0.0f, 1.0f};
   glGenBuffers(1, &default_attr_vbo_);
   glBindBuffer(GL_ARRAY_BUFFER, default_attr_vbo_);
diff --git a/source/blender/gpu/opengl/gl_debug.cc b/source/blender/gpu/opengl/gl_debug.cc
new file mo

@@ Diff output truncated at 10240 characters. @@



More information about the Bf-blender-cvs mailing list