Skip to content

Commit 2edb5d3

Browse files
committed
Update docs
1 parent 709c218 commit 2edb5d3

File tree

1 file changed

+5
-13
lines changed

1 file changed

+5
-13
lines changed

clang/docs/TypeSanitizer.rst

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,6 @@ Typical memory overhead introduced by TypeSanitizer is about **8x**. Runtime slo
2424
depending on how often the instrumented code relies on type aliasing. In the best case slowdown is
2525
**2x-3x**.
2626

27-
The compiler instrumentation also has an impact on code size and compilation overhead. There is an
28-
experimental :ref:`instrumentation outlining option<outlining_flag>` which can greatly reduce this
29-
but this may decrease runtime performance.
30-
3127
The TypeSanitizer Algorithm
3228
===========================
3329
For each TBAA type-access descriptor, encoded in LLVM IR using TBAA Metadata, the instrumentation
@@ -132,17 +128,13 @@ references to LLVM IR specific terms.
132128
Sanitizer features
133129
==================
134130

135-
.. _outlining_flag:
136-
137-
Instrumentation code outlining
131+
Instrumentation code inlining
138132
------------------------------
139133

140-
By default TypeSanitizer inlines the instrumentation code. This leads to increased
141-
binary size and compilation time. Using the clang flag
142-
``-fsanitize-type-outline-instrumentation`` (default: ``false``)
143-
forces all code instrumentation to be outlined. This reduces the size of the
144-
generated code and reduces compile-time overhead, but it also reduces runtime
145-
performance.
134+
By default TypeSanitizer inserts instrumentation through function calls. This may lead to a reduction in
135+
runtime performance. ``-fno-sanitize-type-outline-instrumentation`` (default: ``false``) forces all
136+
code instrumentation to be inlined. This will increase the size of the generated code and compiler
137+
overhead, but may improve the runtime performance of the resulting code.
146138

147139
``__has_feature(type_sanitizer)``
148140
------------------------------------

0 commit comments

Comments
 (0)