Skip to content

Commit 1f3b0f4

Browse files
authored
[docs][msan] List common cases reported by msan (#101105)
Fixes google/sanitizers#1755.
1 parent d69d981 commit 1f3b0f4

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

clang/docs/MemorySanitizer.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,18 @@ MemorySanitizer
88
Introduction
99
============
1010

11-
MemorySanitizer is a detector of uninitialized reads. It consists of a
11+
MemorySanitizer is a detector of uninitialized memory use. It consists of a
1212
compiler instrumentation module and a run-time library.
1313

1414
Typical slowdown introduced by MemorySanitizer is **3x**.
1515

16+
Here is a not comprehensive of list cases when MemorySanitizer will report an error:
17+
18+
* Uninitialized value was used in a conditional branch.
19+
* Uninitialized pointer was used for memory accesses.
20+
* Uninitialized value passed or returned from a function call, which is considered an undefined behavior. The check can be disabled with ``-fno-sanitize-memory-param-retval``.
21+
* Uninitialized data was passed into some libc calls.
22+
1623
How to build
1724
============
1825

0 commit comments

Comments
 (0)