GPU: Print shader source on compilation error #116470

Miguel Pozo · 2023-12-22T17:45:53+01:00

Miguel Pozo commented

2023-12-22 17:45:53 +01:00

Add a define (DEBUG_LOG_SHADER_SRC_ON_ERROR ) in gpu_shader_private.h
to print the full source code of shaders that fail to compile.

Add a define (DEBUG_LOG_SHADER_SRC_ON_ERROR ) in `gpu_shader_private.h` to print the full source code of shaders that fail to compile.

Miguel Pozo added the

Module

EEVEE & Viewport

label 2023-12-22 17:45:53 +01:00

Miguel Pozo added 1 commit 2023-12-22 17:46:05 +01:00

3090f2c5cd Print source on error

Miguel Pozo requested review from Jeroen Bakker 2024-01-08 18:40:07 +01:00

Miguel Pozo requested review from Clément Foucault 2024-01-08 18:40:07 +01:00

Miguel Pozo commented

2024-01-08 18:46:22 +01:00

I did this when looking into #115226.
Not sure if you guys think it's a good idea or if you would prefer to enable the option in some other way.
Printing the whole source code can be slow, but at the same time, if you're debugging and there's a shader compilation error, that's probably what you are looking for in the first place.

I did this when looking into #115226. Not sure if you guys think it's a good idea or if you would prefer to enable the option in some other way. Printing the whole source code can be slow, but at the same time, if you're debugging and there's a shader compilation error, that's probably what you are looking for in the first place.

Clément Foucault commented

2024-01-08 21:07:21 +01:00

I wouldn't do this. This is uneeded 95% of the time.
But you have a point that it is useful if you want to diff two shaders.
Usually you want to compare two part of the code not the whole shader.

This is not readable (and slow) in the console so I would suggest to write the shader code to a file instead. About keeping it behing G_DEBUG_GPU, I'm not sure. I would say it is preferable to have a #define option instead.

I wouldn't do this. This is uneeded 95% of the time. But you have a point that it is useful if you want to diff two shaders. Usually you want to compare two part of the code not the whole shader. This is not readable (and slow) in the console so I would suggest to write the shader code to a file instead. About keeping it behing `G_DEBUG_GPU`, I'm not sure. I would say it is preferable to have a `#define` option instead.

Jeroen Bakker commented

2024-01-09 07:29:10 +01:00

+1 for using a define. I normally just add a print statement in the logger..

Miguel Pozo commented

2024-01-09 10:56:10 +01:00

This is uneeded 95% of the time.

Yes, but that 95% of the time it's not going to print anything, that's why I thought just enabling it in GPU debug mode might be ok.
But a define would be ok too.

Usually you want to compare two part of the code not the whole shader.

I think, ideally, you want to see only the generated code, and keep the require statements as-is without inlining them. That would probably be the best solution, but it's not trivial to implement.

so I would suggest to write the shader code to a file instead.

Sounds good to me. Something like a shader_compiler_error.log in the Blender root directory?

I normally just add a print statement in the logger..

The issue is this doesn't work for linking errors, because the source is no longer available.

> This is uneeded 95% of the time. Yes, but that 95% of the time it's not going to print anything, that's why I thought just enabling it in GPU debug mode might be ok. But a define would be ok too. > Usually you want to compare two part of the code not the whole shader. I think, ideally, you want to see only the generated code, and keep the `require` statements as-is without inlining them. That would probably be the best solution, but it's not trivial to implement. > so I would suggest to write the shader code to a file instead. Sounds good to me. Something like a `shader_compiler_error.log` in the Blender root directory? > I normally just add a print statement in the logger.. The issue is this doesn't work for linking errors, because the source is no longer available.

Clément Foucault commented

2024-01-10 23:06:14 +01:00

Yes, but that 95% of the time it's not going to print anything

If you mean the shader logger is not working on some platform we should improve and fix it.

I think, ideally, you want to see only the generated code, and keep the require statements as-is without inlining them. That would probably be the best solution, but it's not trivial to implement.

I'm not sure what you mean by that. Do you mean you want the name of the required files + the generated code?

Something like a shader_compiler_error.log in the Blender root directory?

I would use current working directory. It's easier to find.

The issue is this doesn't work for linking errors

That unfortunate yes. I'm not sure what we can do about this.

> Yes, but that 95% of the time it's not going to print anything If you mean the shader logger is not working on some platform we should improve and fix it. > I think, ideally, you want to see only the generated code, and keep the require statements as-is without inlining them. That would probably be the best solution, but it's not trivial to implement. I'm not sure what you mean by that. Do you mean you want the name of the required files + the generated code? > Something like a shader_compiler_error.log in the Blender root directory? I would use current working directory. It's easier to find. > The issue is this doesn't work for linking errors That unfortunate yes. I'm not sure what we can do about this.

Clément Foucault requested changes 2024-02-25 17:27:15 +01:00

Dismissed

Clément Foucault left a comment

Just requesting review for updating the state of the PR. We decided to hide this option behind a preprocessor define option.

Miguel Pozo added 2 commits 2024-02-26 13:34:09 +01:00

8531a3589d Merge branch 'main' into pull-gpu-better-shader-log

3581158512 Use preprocesor define

Clément Foucault approved these changes 2024-02-26 14:03:29 +01:00

Miguel Pozo merged commit c713fbc2d3 into main

2024-02-26 17:30:25 +01:00

Miguel Pozo referenced this issue from a commit

2024-02-26 17:30:26 +01:00

GPU: Allow printing full shader source on compilation error

Miguel Pozo deleted branch pull-gpu-better-shader-log

2024-02-26 17:30:27 +01:00

Sign in to join this conversation.

No reviewers

No Label

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

GPU: Print shader source on compilation error #116470