Skip to content

Commit 84ca5b3

Browse files
committed
doc: mention sanitizer suppressions in developer docs
Should be enough to close #17834.
1 parent 6758bd7 commit 84ca5b3

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

doc/developer-notes.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -560,8 +560,19 @@ address sanitizer, libtsan for the thread sanitizer, and libubsan for the
560560
undefined sanitizer. If you are missing required libraries, the configure script
561561
will fail with a linker error when testing the sanitizer flags.
562562

563-
The test suite should pass cleanly with the `thread` and `undefined` sanitizers,
564-
but there are a number of known problems when using the `address` sanitizer. The
563+
The test suite should pass cleanly with the `thread` and `undefined` sanitizers. You
564+
may need to use a suppressions file, see `test/sanitizer_suppressions`. They may be
565+
used as follows:
566+
```bash
567+
export LSAN_OPTIONS="suppressions=$(pwd)/test/sanitizer_suppressions/lsan"
568+
export TSAN_OPTIONS="suppressions=$(pwd)/test/sanitizer_suppressions/tsan:halt_on_error=1:second_deadlock_stack=1"
569+
export UBSAN_OPTIONS="suppressions=$(pwd)/test/sanitizer_suppressions/ubsan:print_stacktrace=1:halt_on_error=1:report_error_type=1"
570+
```
571+
572+
See the CI config for more examples, and upstream documentation for more information
573+
about any additional options.
574+
575+
There are a number of known problems when using the `address` sanitizer. The
565576
address sanitizer is known to fail in
566577
[sha256_sse4::Transform](/src/crypto/sha256_sse4.cpp) which makes it unusable
567578
unless you also use `--disable-asm` when running configure. We would like to fix

0 commit comments

Comments
 (0)