Skip to content
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

Clarify ASan test running instructions #5240

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Clarify ASan test running instructions #5240

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b43886b
Add subtle reminder ASan tests also need to run inside the `\out\<arc…
davidmrdavid Jan 16, 2025
3a9b91c
Update README.md
davidmrdavid Jan 16, 2025
33178c8
Update README.md
davidmrdavid Jan 16, 2025
d8a4b8c
add deliberate line-wrapping
davidmrdavid Jan 16, 2025
99033e8
Consistently depict tests as being run from out\x64.
StephanTLavavej Jan 17, 2025
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
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -412,7 +412,8 @@ set PATH=C:\STL\out\x64\out\bin\amd64;%PATH%
## Running Tests With Address Sanitizer (ASan)

You don't need any extra steps to run with test code and the code in STL headers instrumented with [ASan][].
The test matrices include both ASan and non-ASan configurations.
The test matrices include both ASan and non-ASan configurations if you don't pass `-Dtags=ASAN` or `-Dnotags=ASAN`
to exclude one or the other.

However, to instrument the separately-compiled code (the DLL, the satellites, the [Import Library][] - everything that's
in `/stl/src`), you need to build the STL with ASan. Change the build steps to add `-DSTL_ASAN_BUILD=ON`:
Expand All @@ -425,6 +426,8 @@ cmake --build --preset x64
ASan-instrumented STL binaries require that the executable be instrumented as well, so you'll have to skip the non-ASan
configurations by passing `-Dtags=ASAN` to `stl-lit.py`:

(This example assumes that your current directory is `C:\Dev\STL\out\x64`.)

```
python tests\utils\stl-lit\stl-lit.py ..\..\tests\std\tests\VSO_0000000_vector_algorithms -Dtags=ASAN -v
```
Expand Down