From 616618288d0499f833a95263e51bf11a59052389 Mon Sep 17 00:00:00 2001 From: Naomi Musgrave Date: Thu, 17 Sep 2015 00:10:59 +0000 Subject: [PATCH] Updating docs for MSan to describe poison-in-dtor. Summary: Describe the compile and runtime flags to enable MemorySanitizer detection of use-after-destroy. Reviewers: eugenis Subscribers: llvm-commits Differential Revision: http://reviews.llvm.org/D12914 Revise doc description of use-after-dtor. Change wording to specify memory no longer readable. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@247871 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/UsersManual.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/UsersManual.rst b/docs/UsersManual.rst index 66597b8a13..ab6089ce0e 100644 --- a/docs/UsersManual.rst +++ b/docs/UsersManual.rst @@ -1065,6 +1065,16 @@ are listed below. order of memory stores the uninitialized value went through. This mode may use extra memory in programs that copy uninitialized memory a lot. + - ``-fsanitize-memory-use-after-dtor``: Enables use-after-destruction + detection in MemorySanitizer. After invocation of the destructor, + the object is considered no longer readable. Facilitates the + detection of use-after-destroy bugs. + + Setting the MSAN_OPTIONS=poison_in_dtor=1 enables the poisoning of + memory at runtime. Any subsequent access to the destroyed object + fails at runtime. This feature is still experimental, but this + environment variable must be set to 1 in order for the above flag + to have any effect. The ``-fsanitize=`` argument must also be provided when linking, in order to link to the appropriate runtime library. When using -- 2.40.0