Skip to content

Commit 705f3eb

Browse files
authored
[rtsan][NFC] Add documentation link to Function Effects (llvm#113979)
1 parent 0454950 commit 705f3eb

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

clang/docs/RealtimeSanitizer.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,16 @@ RealtimeSanitizer (a.k.a. RTSan) is a real-time safety testing tool for C and C+
1111
projects. RTSan can be used to detect real-time violations, i.e. calls to methods
1212
that are not safe for use in functions with deterministic run time requirements.
1313
RTSan considers any function marked with the ``[[clang::nonblocking]]`` attribute
14-
to be a real-time function. If RTSan detects a call to ``malloc``, ``free``,
15-
``pthread_mutex_lock``, or anything else that could have a non-deterministic
16-
execution time in a function marked ``[[clang::nonblocking]]``
14+
to be a real-time function. At run-time, if RTSan detects a call to ``malloc``,
15+
``free``, ``pthread_mutex_lock``, or anything else that could have a
16+
non-deterministic execution time in a function marked ``[[clang::nonblocking]]``
1717
RTSan raises an error.
1818

19+
RTSan performs its analysis at run-time but shares the ``[[clang::nonblocking]]``
20+
attribute with the :doc:`FunctionEffectAnalysis` system, which operates at
21+
compile-time to detect potential real-time safety violations. For comprehensive
22+
detection of real-time safety issues, it is recommended to use both systems together.
23+
1924
The runtime slowdown introduced by RealtimeSanitizer is negligible.
2025

2126
How to build

0 commit comments

Comments
 (0)