This is an archive of the discontinued LLVM Phabricator instance.

Differential D37647

[ubsan-minimal] Document the new runtime
ClosedPublic

Authored by vsk on Sep 8 2017, 3:56 PM.

Details

Reviewers
eugenis
Commits
rG90c80a32834f: [ubsan-minimal] Document the new runtime
rC312957: [ubsan-minimal] Document the new runtime
rL312957: [ubsan-minimal] Document the new runtime

Diff Detail

Event Timeline

vsk created this revision.Sep 8 2017, 3:56 PM
eugenis accepted this revision.Sep 8 2017, 6:17 PM
This revision is now accepted and ready to land.Sep 8 2017, 6:17 PM
Closed by commit rL312957: [ubsan-minimal] Document the new runtime (authored by vedantk). · Explain WhySep 11 2017, 2:38 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents

Diff 114449

docs/ReleaseNotes.rst

Show First 20 Lines • Show All 92 Lines • ▼ Show 20 Lines
Static Analyzer Static Analyzer
--------------- ---------------
... ...
Undefined Behavior Sanitizer (UBSan) 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 Core Analysis Improvements
========================== ==========================
- ... - ...
New Issues Found New Issues Found
================ ================
Show All 26 Lines

docs/UndefinedBehaviorSanitizer.rst

Show First 20 Lines • Show All 92 Lines • ▼ Show 20 Lines
so UBSan offers to catch it. so UBSan offers to catch it.
Volatile Volatile
-------- --------
The ``null``, ``alignment``, ``object-size``, and ``vptr`` checks do not apply The ``null``, ``alignment``, ``object-size``, and ``vptr`` checks do not apply
to pointers to types with the ``volatile`` qualifier. 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 Stack traces and report symbolization
===================================== =====================================
If you want UBSan to print symbolized stack trace for each error report, you If you want UBSan to print symbolized stack trace for each error report, you
will need to: will need to:
#. Compile with ``-g`` and ``-fno-omit-frame-pointer`` to get proper debug #. Compile with ``-g`` and ``-fno-omit-frame-pointer`` to get proper debug
information in your binary. information in your binary.
#. Run your program with environment variable #. Run your program with environment variable
▲ Show 20 Lines • Show All 92 Lines • Show Last 20 Lines