35#define TRIM_NVIDIA_BUFFER_INFO 1
37#define TRIM_SHADER_STATS_INFO 1
50# define APIENTRY __stdcall
60 const GLchar *message,
63 if (
ELEM(type, GL_DEBUG_TYPE_PUSH_GROUP, GL_DEBUG_TYPE_POP_GROUP)) {
86 if (
ELEM(severity, GL_DEBUG_SEVERITY_LOW, GL_DEBUG_SEVERITY_NOTIFICATION)) {
88 const char *format = use_color ?
"\033[2m%s\033[0m" :
"%s";
93 char debug_groups[512] =
"";
105 case GL_DEBUG_TYPE_ERROR:
106 case GL_DEBUG_TYPE_DEPRECATED_BEHAVIOR:
107 case GL_DEBUG_TYPE_UNDEFINED_BEHAVIOR:
110 case GL_DEBUG_TYPE_PORTABILITY:
111 case GL_DEBUG_TYPE_PERFORMANCE:
112 case GL_DEBUG_TYPE_OTHER:
113 case GL_DEBUG_TYPE_MARKER:
120 CLG_logf(
LOG.type, clog_level, debug_groups,
"",
"%s", message);
121 if (severity == GL_DEBUG_SEVERITY_HIGH) {
124 fprintf(stderr,
"\033[2m");
128 fprintf(stderr,
"\033[0m\n");
140 glEnable(GL_DEBUG_OUTPUT);
141 glEnable(GL_DEBUG_OUTPUT_SYNCHRONOUS);
142 glDebugMessageCallback(
static_cast<GLDEBUGPROC
>(
debug_callback),
nullptr);
143 glDebugMessageControl(GL_DONT_CARE, GL_DONT_CARE, GL_DONT_CARE, 0,
nullptr, GL_TRUE);
144 glDebugMessageInsert(GL_DEBUG_SOURCE_APPLICATION,
145 GL_DEBUG_TYPE_MARKER,
147 GL_DEBUG_SEVERITY_NOTIFICATION,
149 "Successfully hooked OpenGL debug callback");
166 GLenum error = glGetError();
168#define ERROR_CASE(err) \
171 SNPRINTF(msg, "%s : %s", #err, info); \
172 debug_callback(0, GL_DEBUG_TYPE_ERROR, 0, GL_DEBUG_SEVERITY_HIGH, 0, msg, nullptr); \
188 SNPRINTF(msg,
"Unknown GL error: %x : %s", error, info);
189 debug_callback(0, GL_DEBUG_TYPE_ERROR, 0, GL_DEBUG_SEVERITY_HIGH, 0, msg,
nullptr);
204 uint16_t ubo_needed = interface->enabled_ubo_mask_;
205 ubo_needed &= ~ctx->bound_ubo_slots;
208 uint16_t ssbo_needed = interface->enabled_ssbo_mask_;
209 ssbo_needed &= ~ctx->bound_ssbo_slots;
212 uint64_t tex_needed = interface->enabled_tex_mask_;
213 tex_needed &=
~GLContext::state_manager_active_get()->bound_texture_slots();
216 uint8_t ima_needed = interface->enabled_ima_mask_;
217 ima_needed &=
~GLContext::state_manager_active_get()->bound_image_slots();
219 if (ubo_needed == 0 && tex_needed == 0 && ima_needed == 0 && ssbo_needed == 0) {
223 for (
int i = 0; ubo_needed != 0; i++, ubo_needed >>= 1) {
224 if ((ubo_needed & 1) != 0) {
225 const ShaderInput *ubo_input = interface->ubo_get(i);
226 const char *ubo_name = interface->input_name_get(ubo_input);
230 msg,
"Missing UBO bind at slot %d : %s > %s : %s", i, sh_name.
c_str(), ubo_name, info);
231 debug_callback(0, GL_DEBUG_TYPE_ERROR, 0, GL_DEBUG_SEVERITY_HIGH, 0, msg,
nullptr);
235 for (
int i = 0; ssbo_needed != 0; i++, ssbo_needed >>= 1) {
236 if ((ssbo_needed & 1) != 0) {
237 const ShaderInput *ssbo_input = interface->ssbo_get(i);
238 const char *ssbo_name = interface->input_name_get(ssbo_input);
242 msg,
"Missing SSBO bind at slot %d : %s > %s : %s", i, sh_name.
c_str(), ssbo_name, info);
243 debug_callback(0, GL_DEBUG_TYPE_ERROR, 0, GL_DEBUG_SEVERITY_HIGH, 0, msg,
nullptr);
247 for (
int i = 0; tex_needed != 0; i++, tex_needed >>= 1) {
248 if ((tex_needed & 1) != 0) {
250 const ShaderInput *tex_input = interface->texture_get(i);
251 const char *tex_name = interface->input_name_get(tex_input);
255 "Missing Texture bind at slot %d : %s > %s : %s",
260 debug_callback(0, GL_DEBUG_TYPE_ERROR, 0, GL_DEBUG_SEVERITY_HIGH, 0, msg,
nullptr);
264 for (
int i = 0; ima_needed != 0; i++, ima_needed >>= 1) {
265 if ((ima_needed & 1) != 0) {
267 const ShaderInput *tex_input = interface->texture_get(i);
268 const char *tex_name = interface->input_name_get(tex_input);
272 msg,
"Missing Image bind at slot %d : %s > %s : %s", i, sh_name.
c_str(), tex_name, info);
273 debug_callback(0, GL_DEBUG_TYPE_ERROR, 0, GL_DEBUG_SEVERITY_HIGH, 0, msg,
nullptr);
280 debug_callback(0, GL_DEBUG_TYPE_ERROR, 0, GL_DEBUG_SEVERITY_HIGH, 0, info,
nullptr);
295 case GL_FRAGMENT_SHADER:
296 case GL_GEOMETRY_SHADER:
297 case GL_VERTEX_SHADER:
307 case GL_VERTEX_ARRAY:
309 case GL_UNIFORM_BUFFER:
320 case GL_FRAGMENT_SHADER:
322 case GL_GEOMETRY_SHADER:
324 case GL_VERTEX_SHADER:
334 (epoxy_gl_version() >= 43 || epoxy_has_gl_extension(
"GL_KHR_debug")))
340 case GL_FRAGMENT_SHADER:
341 case GL_GEOMETRY_SHADER:
342 case GL_VERTEX_SHADER:
343 case GL_COMPUTE_SHADER:
346 case GL_UNIFORM_BUFFER:
347 case GL_SHADER_STORAGE_BUFFER:
348 case GL_ARRAY_BUFFER:
349 case GL_ELEMENT_ARRAY_BUFFER:
355 glObjectLabel(type,
object, -1, label);
374 (epoxy_gl_version() >= 43 || epoxy_has_gl_extension(
"GL_KHR_debug")))
378 glPushDebugGroup(GL_DEBUG_SOURCE_APPLICATION,
index, -1, name);
381 if (!
G.profile_gpu) {
385 TimeQuery query = {};
387 query.finished =
false;
389 glGetInteger64v(GL_TIMESTAMP, &query.cpu_start);
391 glGenQueries(2, query.handles);
392 glQueryCounter(query.handle_start, GL_TIMESTAMP);
394 if (frame_timings.is_empty()) {
395 frame_timings.append({});
397 frame_timings.last().queries.append(query);
403 (epoxy_gl_version() >= 43 || epoxy_has_gl_extension(
"GL_KHR_debug")))
408 if (!
G.profile_gpu) {
413 for (
int i = queries.
size() - 1; i >= 0; i--) {
414 TimeQuery &query = queries[i];
415 if (!query.finished) {
416 query.finished =
true;
417 glQueryCounter(query.handle_end, GL_TIMESTAMP);
418 glGetInteger64v(GL_TIMESTAMP, &query.cpu_end);
422 CLOG_ERROR(&
LOG,
"Profile GPU error: Extra GPU_debug_group_end() call.");
427void GLContext::process_frame_timings()
429 if (!
G.profile_gpu) {
433 for (
int frame_i = 0; frame_i < frame_timings.
size(); frame_i++) {
436 GLint frame_is_ready = 0;
437 bool frame_is_valid = !queries.
is_empty();
439 for (
int i = queries.
size() - 1; i >= 0; i--) {
440 if (!queries[i].finished) {
441 frame_is_valid =
false;
442 CLOG_ERROR(&
LOG,
"Profile GPU error: Missing GPU_debug_group_end() call");
445 glGetQueryObjectiv(queries.
last().handle_end, GL_QUERY_RESULT_AVAILABLE, &frame_is_ready);
450 if (!frame_is_valid) {
452 for (TimeQuery &query : queries) {
453 glDeleteQueries(2, query.handles);
455 frame_timings.remove(frame_i--);
459 if (!frame_is_ready) {
463 for (TimeQuery &query : queries) {
464 GLuint64 gpu_start = 0;
465 GLuint64 gpu_end = 0;
466 glGetQueryObjectui64v(query.handle_start, GL_QUERY_RESULT, &gpu_start);
467 glGetQueryObjectui64v(query.handle_end, GL_QUERY_RESULT, &gpu_end);
468 glDeleteQueries(2, query.handles);
471 query.name, gpu_start, gpu_end, query.cpu_start, query.cpu_end);
474 frame_timings.remove(frame_i--);
477 frame_timings.append({});
489 bool result = renderdoc_.start_frame_capture(
nullptr,
nullptr);
491 renderdoc_.set_frame_capture_title(title);
509 renderdoc_.end_frame_capture(
nullptr,
nullptr);
522 const char *title = (
const char *)scope;
536 const char *title = (
const char *)scope;
#define SNPRINTF(dst, format,...)
#define CLOG_ERROR(clg_ref,...)
void void CLG_logf(const CLG_LogType *lg, enum CLG_Level level, const char *file_line, const char *fn, const char *format,...) _CLOG_ATTR_NONNULL(1
#define CLOG_CHECK(clg_ref, verbose_level,...)
int CLG_color_support_get(CLG_LogRef *clg_ref)
#define GPU_DEBUG_SHADER_SPECIALIZATION_GROUP
#define GPU_DEBUG_SHADER_COMPILATION_GROUP
constexpr const char * c_str() const
constexpr StringRefNull()
const T & last(const int64_t n=0) const
bool debug_capture_begin(const char *title)
void * debug_capture_scope_create(const char *name) override
void debug_unbind_all_ubo() override
void debug_capture_end() override
bool debug_capture_begin(const char *title) override
uint16_t bound_ssbo_slots
void debug_group_begin(const char *name, int index) override
void debug_capture_scope_end(void *scope) override
void debug_group_end() override
bool debug_capture_scope_begin(void *scope) override
void debug_unbind_all_ssbo() override
static ProfileReport & get()
void add_group(StringRefNull name, uint64_t gpu_start, uint64_t gpu_end, uint64_t cpu_start, uint64_t cpu_end)
StringRefNull name_get() const
#define TRIM_NVIDIA_BUFFER_INFO
#define TRIM_SHADER_STATS_INFO
void check_gl_resources(const char *info)
static void APIENTRY debug_callback(GLenum, GLenum type, GLuint, GLenum severity, GLsizei, const GLchar *message, const GLvoid *)
void raise_gl_error(const char *info)
static const char * to_str_prefix(GLenum type)
void check_gl_error(const char *info)
static const char * to_str_suffix(GLenum type)
void object_label(GLenum type, GLuint object, const char *name)
unsigned __int64 uint64_t
bool GPU_type_matches(GPUDeviceType device, GPUOSType os, GPUDriverType driver)
bool GPU_debug_group_match(const char *ref)
void BLI_system_backtrace(FILE *fp)
void GPU_debug_get_groups_names(int name_buf_maxncpy, char *r_name_buf)