`assert` in metal?

Is there an equivalent of assert in metal? I'm looking for a way to abnormally halt a shader and indicate it ought to be debugged.

assert itself is defined ((void) 0), so that won't work. __builtin_trap() will halt execution, but there's no indication the shader was trapped other than lack of side effects of it completing.

I'm wondering if there is some "other" way to trap, like emitting an invalid instruction into the shader, or doing something the metal API validator will flag as illegal.

Up vote post of drewcrawford Down vote post of drewcrawford
1.4k views
Posted by
drewcrawford
Reply
Add a Comment

Apple Recommended

One limitation of buffer out-of-bounds, is that a buffer is not always in-scope (such as inside a math function). Adding a buffer argument for the sole purpose of trapping is not ideal.

Based on your suggestion, I am now using this pattern

Code Block 
    device float *f = 0;
    *f = 12;

which seems to trap OK without an explicit buffer. I had previously filed FB7731230 for assert.
Posted by
drewcrawford
Post not yet marked as solved Up vote reply of drewcrawford Down vote reply of drewcrawford
Post marked as Apple Recommended
Add a Comment

Replies

Currently, there is no support for assert in the Metal Shading Language. We do not recommend using the Clang’s __builtin_trap() for this.
Please submit an enhancement request via Feedback Assistant.

Having said that, please consider turning on the validation layer and performing an out-of-bounds access on a buffer as a solution to what you are trying to do.
For more information on the validation layer please watch Debug GPU-side errors in Metal.

Posted by
Graphics and Games Engineer
Post not yet marked as solved Up vote reply of Graphics and Games Engineer Down vote reply of Graphics and Games Engineer
Add a Comment
One limitation of buffer out-of-bounds, is that a buffer is not always in-scope (such as inside a math function). Adding a buffer argument for the sole purpose of trapping is not ideal.

Based on your suggestion, I am now using this pattern

Code Block 
    device float *f = 0;
    *f = 12;

which seems to trap OK without an explicit buffer. I had previously filed FB7731230 for assert.
Posted by
drewcrawford
Post not yet marked as solved Up vote reply of drewcrawford Down vote reply of drewcrawford
Post marked as Apple Recommended
Add a Comment

I also need an assert. The MBP 16" is generating valid uv, with 0 length derivatives and that causes problems. Being able to assert on this condition would help. Drew's recommendation just seems to result in a compilation failure on macOS Big Sur.

Posted by
Alecazam
Up vote reply of Alecazam Down vote reply of Alecazam
Add a Comment