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
commit7a06040dbe89cf54a898e88135a76ed6b5619443 (patch)
treedab0e3c8217bb4af7a2f57037d49ee8d8a3a2f3a
parent76605f5718e07bc0e551620a39a0853cb6fc81f5 (diff)
downloadllvm-users/vitalybuka/spr/main.update.zip
llvm-users/vitalybuka/spr/main.update.tar.gz
llvm-users/vitalybuka/spr/main.update.tar.bz2
[𝘀𝗽𝗿] changes to main this commit is based onusers/vitalybuka/spr/main.update
Created using spr 1.3.4 [skip ci]
-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..024bed2 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:
+
+* Conditional branches controlled by uninitialized values.
+* Using uninitalized pointers for memory accesses.
+* Passing and returning uninitialized values to/from function calls. Can be disabled with ``-fno-sanitize-memory-param-retval``.
+* Passing uninitialized data into libc calls.
+
How to build
============