From: Vedant Kumar Date: Mon, 11 Sep 2017 21:37:05 +0000 (+0000) Subject: [ubsan-minimal] Document the new runtime X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=519beb3effcebdba66151386c754fc2bcdb8d96e;p=clang [ubsan-minimal] Document the new runtime Differential Revision: https://reviews.llvm.org/D37647 git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@312957 91177308-0d34-0410-b5e6-96231b3b80d8 --- diff --git a/docs/ReleaseNotes.rst b/docs/ReleaseNotes.rst index 60d418bd4a..6f4644c01c 100644 --- a/docs/ReleaseNotes.rst +++ b/docs/ReleaseNotes.rst @@ -229,7 +229,10 @@ Static Analyzer Undefined Behavior Sanitizer (UBSan) ------------------------------------ -... +* A minimal runtime is now available. It is suitable for use in production + environments, and has a small attack surface. It only provides very basic + issue logging and deduplication, and does not support ``-fsanitize=vptr`` + checking. Core Analysis Improvements ========================== diff --git a/docs/UndefinedBehaviorSanitizer.rst b/docs/UndefinedBehaviorSanitizer.rst index 5b43e2ef84..ed9357754c 100644 --- a/docs/UndefinedBehaviorSanitizer.rst +++ b/docs/UndefinedBehaviorSanitizer.rst @@ -155,6 +155,19 @@ Volatile The ``null``, ``alignment``, ``object-size``, and ``vptr`` checks do not apply to pointers to types with the ``volatile`` qualifier. +Minimal Runtime +=============== + +There is a minimal UBSan runtime available suitable for use in production +environments. This runtime has a small attack surface. It only provides very +basic issue logging and deduplication, and does not support ``-fsanitize=vptr`` +checking. + +To use the minimal runtime, add ``-fsanitize-minimal-runtime`` to the clang +command line options. For example, if you're used to compiling with +``-fsanitize=undefined``, you could enable the minimal runtime with +``-fsanitize=undefined -fsanitize-minimal-runtime``. + Stack traces and report symbolization ===================================== If you want UBSan to print symbolized stack trace for each error report, you