Author: vedantk Date: Mon Sep 11 14:37:05 2017 New Revision: 312957 URL: http://llvm.org/viewvc/llvm-project?rev=312957&view=rev Log: [ubsan-minimal] Document the new runtime
Differential Revision: https://reviews.llvm.org/D37647 Modified: cfe/trunk/docs/ReleaseNotes.rst cfe/trunk/docs/UndefinedBehaviorSanitizer.rst Modified: cfe/trunk/docs/ReleaseNotes.rst URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/docs/ReleaseNotes.rst?rev=312957&r1=312956&r2=312957&view=diff ============================================================================== --- cfe/trunk/docs/ReleaseNotes.rst (original) +++ cfe/trunk/docs/ReleaseNotes.rst Mon Sep 11 14:37:05 2017 @@ -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 ========================== Modified: cfe/trunk/docs/UndefinedBehaviorSanitizer.rst URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/docs/UndefinedBehaviorSanitizer.rst?rev=312957&r1=312956&r2=312957&view=diff ============================================================================== --- cfe/trunk/docs/UndefinedBehaviorSanitizer.rst (original) +++ cfe/trunk/docs/UndefinedBehaviorSanitizer.rst Mon Sep 11 14:37:05 2017 @@ -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 _______________________________________________ cfe-commits mailing list cfe-commits@lists.llvm.org http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits