[clang] [docs][msan] List common cases reported by msan (PR #101105)

Thurston Dang via cfe-commits cfe-commits at lists.llvm.org
Mon Jul 29 20:52:48 PDT 2024


================
@@ -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 list cases when MemorySanitizer will report an error:
+
+* A code uses uninitialized value in a conditional branch.
+* Uninitialized pointer was used for memory accesses.
+* Uninitialized value passed or returned from a function call, when it considered an undefined behavior. The check can be disabled with ``-fno-sanitize-memory-param-retval``.
----------------
thurstond wrote:

Nit: "which is"?

https://github.com/llvm/llvm-project/pull/101105


More information about the cfe-commits mailing list