Skip to content

Update README.developers.md : Added sanitizer suppression file info, and mention of valgrind. #1809

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 29, 2021
Merged

Update README.developers.md : Added sanitizer suppression file info, and mention of valgrind. #1809

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9033cfb
Update README.developers.md
vaughnbetz Jul 29, 2021
364a22f
Update README.developers.md
vaughnbetz Jul 29, 2021
5013c76
Update README.developers.md
vaughnbetz Jul 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.developers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -934,6 +934,24 @@ $ cmake -D VTR_ENABLE_SANITIZE=ON build
$ make
```

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

Note that some of the continuous integration (CI) regtests (run automatically on pull requests) turn on sanitizers (currently S: Basic and R: Odin-II Basic Tests)

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

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

## Assertion Levels
VTR supports configurable assertion levels.

Expand Down