Up to date
This page is up to date for Godot 4.0.
If you still find outdated information, please open an issue.
Using sanitizers¶
What are sanitizers?¶
Sanitizers are static instrumentation tools that help find bugs that traditional debuggers usually cannot catch. This is particularly useful when combined with Unit testing in continuous integration.
Sanitizers can be used on Windows, macOS and Linux by using the Clang (LLVM), GCC or Visual Studio compilers. Certain platforms may also have their own sanitizers available. In situations where a single sanitizer is provided by several different compilers, remember that their output and behavior will differ slightly.
Using sanitizers on Godot¶
Sanitizers require recompiling the binary. This means you cannot use official Godot binaries to run sanitizers.
When compiling with any of the sanitizers enabled,
the resulting binary will have the .san suffix added to its name to
distinguish it from a binary without sanitizers.
There is a performance impact as many additional runtime checks need to be performed. Memory utilization will also increase. It is possible to enable certain combinations of multiple sanitizers in a single build. Beware of the performance impact when using multiple sanitizers at once though, as the resulting binary may be excessively slow.
Certain options can be passed to sanitizers without having to recompile the binary using environment variables.