Skip to content

Commit c48fb0a

Browse files
Merge pull request MicrosoftDocs#4962 from zacklj89/docs-editor/asan-debugger-integration-1687963050
Update asan-debugger-integration.md
2 parents ad36f6f + 80dff49 commit c48fb0a

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

docs/sanitizers/asan-debugger-integration.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,21 @@ When you link the VCAsan library to your executable, users can enable it to gene
3434

3535
`set ASAN_SAVE_DUMPS=MyFileName.dmp`
3636

37-
The file must have a .dmp suffix to follow the Visual Studio IDE conventions.
37+
The file must have a `.dmp` extension to follow the Visual Studio IDE conventions. (Prior to 17.7)
3838

3939
Here's what happens when a dump file is specified for `ASAN_SAVE_DUMPS`: If an error gets caught by the AddressSanitizer runtime, it saves a crash dump file that has the metadata associated with the error. The debugger in Visual Studio version 16.9 and later can parse the metadata that's saved in the dump file. You can set `ASAN_SAVE_DUMPS` on a per-test basis, store these binary artifacts, and then view them in the IDE with proper source indexing.
4040

41+
Visual Studio version 17.7 and later supports the following:
42+
43+
* Quoted strings are now handled correctly. In previous versions, for environments inside of Visual Studio or when using PowerShell, setting the environment variable to contain quotes or spaces would fail to create the expected dump file.
44+
45+
* When the `.dmp` extension is explicitly specified (for example, `set ASAN_SAVE_DUMPS=MyDmp.dmp`), VCAsan uses it explicitly, and will not add an associated process ID to the dump file name.
46+
47+
* If a `.dmp` file already exists with the same name specified from the environment variable, VCAsan modifies the file name as follows:
48+
* Appends a number to the filename in parentheses. For example, `Myfile (1).dmp`.
49+
* If after several attempts appending a number in parentheses fails to generate a unique name, the file is saved to an `%APPLOCAL%` temporary path that VCAsan will print. For example, `C:\Users\~\AppData\Local\Temp\Dump.dmp`.
50+
* If saving to a temporary path fails, a diagnostic error is displayed.
51+
4152
## See also
4253

4354
[AddressSanitizer overview](./asan.md)\
@@ -47,3 +58,4 @@ Here's what happens when a dump file is specified for `ASAN_SAVE_DUMPS`: If an e
4758
[AddressSanitizer shadow bytes](./asan-shadow-bytes.md)\
4859
[AddressSanitizer cloud or distributed testing](./asan-offline-crash-dumps.md)\
4960
[AddressSanitizer error examples](./asan-error-examples.md)
61+

0 commit comments

Comments
 (0)