aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVitaly Buka <vitalybuka@google.com>2024-07-29 17:15:43 -0700
committerVitaly Buka <vitalybuka@google.com>2024-07-29 17:15:43 -0700
commit23f0136dac386ebabac2d29cd1522e51d821fe51 (patch)
tree1dd8f284e78e6c9aa0cb3eb429c6195de3ab9ce9
parent76605f5718e07bc0e551620a39a0853cb6fc81f5 (diff)
parent7a06040dbe89cf54a898e88135a76ed6b5619443 (diff)
downloadllvm-users/vitalybuka/spr/update.zip
llvm-users/vitalybuka/spr/update.tar.gz
llvm-users/vitalybuka/spr/update.tar.bz2
[𝘀𝗽𝗿] initial versionusers/vitalybuka/spr/update
Created using spr 1.3.4
-rw-r--r--clang/docs/MemorySanitizer.rst9
1 files changed, 8 insertions, 1 deletions
diff --git a/clang/docs/MemorySanitizer.rst b/clang/docs/MemorySanitizer.rst
index bcc6cc8..1181778 100644
--- a/clang/docs/MemorySanitizer.rst
+++ b/clang/docs/MemorySanitizer.rst
@@ -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``.
+* Uninitialized data was passed into some libc calls.
+
How to build
============