Skip to content

Commit 9033cfb

Browse files
authored
Update README.developers.md
Added sanitizer suppression file info, and mention of valgrind.
1 parent d3449e8 commit 9033cfb

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.developers.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -934,6 +934,21 @@ $ cmake -D VTR_ENABLE_SANITIZE=ON build
934934
$ make
935935
```
936936

937+
You can suppress reporting of known memory leaks in libraries used by vpr by setting the environment variable below:
938+
LSAN_OPTIONS=suppressions=$VTR_ROOT/vpr/lsan.supp
939+
where $VTR_ROOT is the root directory of your vtr source code tree.
940+
941+
Note that some of the continuous integration (CI) regtests run on pull requests turn on sanitizers (currently S: Basic and R: Odin-II Basic Tests)
942+
943+
## Valgrind
944+
An alternative way to run vtr programs to check for invalid memory accesses and memory leaks is to use the valgrind tool. valgrind can be run on any build except the sanitized build, without recompilation. For example, to run on vpr use
945+
```shell
946+
valgrind --leak-check=full --suppressions=$VTR_ROOT/vpr/valgrind.supp vpr [... usual vpr options here ...]
947+
```
948+
where $VTR_ROOT is the root directory of your vtr source code tree. The suppression file included in the command above will suppress reporting of known memory leaks in libraries included by vpr.
949+
950+
Note that valgrind is run on some flows by the continuous integration (CI) tests run on pull requests.
951+
937952
## Assertion Levels
938953
VTR supports configurable assertion levels.
939954

0 commit comments

Comments
 (0)