Skip to content

Commit 364a22f

Browse files
authored
Update README.developers.md
Added a bit more info to the valgrind and sanitizers.
1 parent 9033cfb commit 364a22f

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.developers.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -935,17 +935,20 @@ $ make
935935
```
936936

937937
You can suppress reporting of known memory leaks in libraries used by vpr by setting the environment variable below:
938+
```shell
938939
LSAN_OPTIONS=suppressions=$VTR_ROOT/vpr/lsan.supp
940+
```
939941
where $VTR_ROOT is the root directory of your vtr source code tree.
940942

941943
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)
942944

943945
## Valgrind
944946
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
945947
```shell
946-
valgrind --leak-check=full --suppressions=$VTR_ROOT/vpr/valgrind.supp vpr [... usual vpr options here ...]
948+
#From the VTR root directory
949+
valgrind --leak-check=full --suppressions=./vpr/valgrind.supp ./vpr/vpr [... usual vpr options here ...]
947950
```
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.
951+
The suppression file included in the command above will suppress reporting of known memory leaks in libraries included by vpr.
949952

950953
Note that valgrind is run on some flows by the continuous integration (CI) tests run on pull requests.
951954

0 commit comments

Comments
 (0)