[clang] [rtsan][NFC] Add documentation link to Function Effects (PR #113979)
Chris Apple via cfe-commits
cfe-commits at lists.llvm.org
Mon Oct 28 16:18:31 PDT 2024
https://github.com/cjappl created https://github.com/llvm/llvm-project/pull/113979
None
>From d2a311863881486fbed6097d6358b096f305377a Mon Sep 17 00:00:00 2001
From: Chris Apple <cja-private at pm.me>
Date: Mon, 28 Oct 2024 16:17:48 -0700
Subject: [PATCH] [rtsan][NFC] Add documentation link to Function Effects
---
clang/docs/RealtimeSanitizer.rst | 11 ++++++++---
1 file changed, 8 insertions(+), 3 deletions(-)
diff --git a/clang/docs/RealtimeSanitizer.rst b/clang/docs/RealtimeSanitizer.rst
index 41b8bbb33baf14..e5f5abfcd9b47e 100644
--- a/clang/docs/RealtimeSanitizer.rst
+++ b/clang/docs/RealtimeSanitizer.rst
@@ -11,11 +11,16 @@ RealtimeSanitizer (a.k.a. RTSan) is a real-time safety testing tool for C and C+
projects. RTSan can be used to detect real-time violations, i.e. calls to methods
that are not safe for use in functions with deterministic run time requirements.
RTSan considers any function marked with the ``[[clang::nonblocking]]`` attribute
-to be a real-time function. If RTSan detects a call to ``malloc``, ``free``,
-``pthread_mutex_lock``, or anything else that could have a non-deterministic
-execution time in a function marked ``[[clang::nonblocking]]``
+to be a real-time function. At run-time, if RTSan detects a call to ``malloc``,
+``free``, ``pthread_mutex_lock``, or anything else that could have a
+non-deterministic execution time in a function marked ``[[clang::nonblocking]]``
RTSan raises an error.
+RTSan performs its analysis at run-time but shares the ``[[clang::nonblocking]]``
+attribute with the :doc:`FunctionEffectAnalysis` system, which operates at
+compile-time to detect potential real-time safety violations. For comprehensive
+detection of real-time safety issues, it is recommended to use both systems together.
+
The runtime slowdown introduced by RealtimeSanitizer is negligible.
How to build
More information about the cfe-commits
mailing list