Skip to content

Commit

Permalink
[docs][msan] List common cases reported by msan (llvm#101105)
Browse files Browse the repository at this point in the history
  • Loading branch information
vitalybuka authored and banach-space committed Aug 7, 2024
1 parent aeb1362 commit 368694f
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion clang/docs/MemorySanitizer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,18 @@ MemorySanitizer
Introduction
============

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

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

Here is a not comprehensive of list cases when MemorySanitizer will report an error:

* Uninitialized value was used in a conditional branch.
* Uninitialized pointer was used for memory accesses.
* 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``.
* Uninitialized data was passed into some libc calls.

How to build
============

Expand Down

0 comments on commit 368694f

Please sign in to comment.