Skip to content

Commit eb32f9f

Browse files
melverpaulmckrcu
authored andcommitted
kcsan: Improve some Kconfig comments
Improve comment for CC_HAS_TSAN_COMPOUND_READ_BEFORE_WRITE. Also shorten the comment above the "strictness" configuration options. Acked-by: Mark Rutland <mark.rutland@arm.com> Signed-off-by: Marco Elver <elver@google.com> Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
1 parent 2734d6c commit eb32f9f

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

lib/Kconfig.kcsan

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,14 @@ menuconfig KCSAN
4040

4141
if KCSAN
4242

43-
# Compiler capabilities that should not fail the test if they are unavailable.
4443
config CC_HAS_TSAN_COMPOUND_READ_BEFORE_WRITE
4544
def_bool (CC_IS_CLANG && $(cc-option,-fsanitize=thread -mllvm -tsan-compound-read-before-write=1)) || \
4645
(CC_IS_GCC && $(cc-option,-fsanitize=thread --param tsan-compound-read-before-write=1))
46+
help
47+
The compiler instruments plain compound read-write operations
48+
differently (++, --, +=, -=, |=, &=, etc.), which allows KCSAN to
49+
distinguish them from other plain accesses. This is currently
50+
supported by Clang 12 or later.
4751

4852
config KCSAN_VERBOSE
4953
bool "Show verbose reports with more information about system state"
@@ -169,13 +173,9 @@ config KCSAN_REPORT_ONCE_IN_MS
169173
reporting to avoid flooding the console with reports. Setting this
170174
to 0 disables rate limiting.
171175

172-
# The main purpose of the below options is to control reported data races (e.g.
173-
# in fuzzer configs), and are not expected to be switched frequently by other
174-
# users. We could turn some of them into boot parameters, but given they should
175-
# not be switched normally, let's keep them here to simplify configuration.
176-
#
177-
# The defaults below are chosen to be very conservative, and may miss certain
178-
# bugs.
176+
# The main purpose of the below options is to control reported data races, and
177+
# are not expected to be switched frequently by non-testers or at runtime.
178+
# The defaults are chosen to be conservative, and can miss certain bugs.
179179

180180
config KCSAN_REPORT_RACE_UNKNOWN_ORIGIN
181181
bool "Report races of unknown origin"

0 commit comments

Comments
 (0)