https://github.com/python/cpython/commit/88cb9720001295f82c7771ab4ebf20f3cd0b31fb
commit: 88cb9720001295f82c7771ab4ebf20f3cd0b31fb
branch: main
author: Samet YASLAN <[email protected]>
committer: corona10 <[email protected]>
date: 2023-12-30T17:17:02+09:00
summary:
gh-112536: Add support for thread sanitizer (TSAN) (gh-112648)
files:
A Misc/NEWS.d/next/Build/2023-12-17-18-23-02.gh-issue-112536.8lr3Ep.rst
M Doc/using/configure.rst
M Include/pyport.h
M Lib/test/libregrtest/utils.py
M Lib/test/support/__init__.py
M Lib/test/test_io.py
M configure
M configure.ac
diff --git a/Doc/using/configure.rst b/Doc/using/configure.rst
index cb7eda42fe3fad..aab9469b44828a 100644
--- a/Doc/using/configure.rst
+++ b/Doc/using/configure.rst
@@ -745,6 +745,13 @@ Debug options
.. versionadded:: 3.6
+.. option:: --with-thread-sanitizer
+
+ Enable ThreadSanitizer data race detector, ``tsan``
+ (default is no).
+
+ .. versionadded:: 3.13
+
Linker options
--------------
diff --git a/Include/pyport.h b/Include/pyport.h
index 328471085f959d..9d7ef0061806ad 100644
--- a/Include/pyport.h
+++ b/Include/pyport.h
@@ -563,6 +563,11 @@ extern "C" {
# define _Py_ADDRESS_SANITIZER
# endif
# endif
+# if __has_feature(thread_sanitizer)
+# if !defined(_Py_THREAD_SANITIZER)
+# define _Py_THREAD_SANITIZER
+# endif
+# endif
#elif defined(__GNUC__)
# if defined(__SANITIZE_ADDRESS__)
# define _Py_ADDRESS_SANITIZER
diff --git a/Lib/test/libregrtest/utils.py b/Lib/test/libregrtest/utils.py
index 26481e71221ade..b30025d962413c 100644
--- a/Lib/test/libregrtest/utils.py
+++ b/Lib/test/libregrtest/utils.py
@@ -340,6 +340,9 @@ def get_build_info():
# --with-undefined-behavior-sanitizer
if support.check_sanitizer(ub=True):
sanitizers.append("UBSAN")
+ # --with-thread-sanitizer
+ if support.check_sanitizer(thread=True):
+ sanitizers.append("TSAN")
if sanitizers:
build.append('+'.join(sanitizers))
@@ -634,6 +637,7 @@ def display_header(use_resources: tuple[str, ...],
asan = support.check_sanitizer(address=True)
msan = support.check_sanitizer(memory=True)
ubsan = support.check_sanitizer(ub=True)
+ tsan = support.check_sanitizer(thread=True)
sanitizers = []
if asan:
sanitizers.append("address")
@@ -641,12 +645,15 @@ def display_header(use_resources: tuple[str, ...],
sanitizers.append("memory")
if ubsan:
sanitizers.append("undefined behavior")
+ if tsan:
+ sanitizers.append("thread")
if sanitizers:
print(f"== sanitizers: {', '.join(sanitizers)}")
for sanitizer, env_var in (
(asan, "ASAN_OPTIONS"),
(msan, "MSAN_OPTIONS"),
(ubsan, "UBSAN_OPTIONS"),
+ (tsan, "TSAN_OPTIONS"),
):
options= os.environ.get(env_var)
if sanitizer and options is not None:
diff --git a/Lib/test/support/__init__.py b/Lib/test/support/__init__.py
index c8f73cede230d8..e5fb725a30b5b8 100644
--- a/Lib/test/support/__init__.py
+++ b/Lib/test/support/__init__.py
@@ -392,10 +392,10 @@ def skip_if_buildbot(reason=None):
isbuildbot = False
return unittest.skipIf(isbuildbot, reason)
-def check_sanitizer(*, address=False, memory=False, ub=False):
+def check_sanitizer(*, address=False, memory=False, ub=False, thread=False):
"""Returns True if Python is compiled with sanitizer support"""
- if not (address or memory or ub):
- raise ValueError('At least one of address, memory, or ub must be True')
+ if not (address or memory or ub or thread):
+ raise ValueError('At least one of address, memory, ub or thread must
be True')
cflags = sysconfig.get_config_var('CFLAGS') or ''
@@ -412,18 +412,23 @@ def check_sanitizer(*, address=False, memory=False,
ub=False):
'-fsanitize=undefined' in cflags or
'--with-undefined-behavior-sanitizer' in config_args
)
+ thread_sanitizer = (
+ '-fsanitize=thread' in cflags or
+ '--with-thread-sanitizer' in config_args
+ )
return (
(memory and memory_sanitizer) or
(address and address_sanitizer) or
- (ub and ub_sanitizer)
+ (ub and ub_sanitizer) or
+ (thread and thread_sanitizer)
)
-def skip_if_sanitizer(reason=None, *, address=False, memory=False, ub=False):
+def skip_if_sanitizer(reason=None, *, address=False, memory=False, ub=False,
thread=False):
"""Decorator raising SkipTest if running with a sanitizer active."""
if not reason:
reason = 'not working with sanitizers active'
- skip = check_sanitizer(address=address, memory=memory, ub=ub)
+ skip = check_sanitizer(address=address, memory=memory, ub=ub,
thread=thread)
return unittest.skipIf(skip, reason)
# gh-89363: True if fork() can hang if Python is built with Address Sanitizer
@@ -432,7 +437,7 @@ def skip_if_sanitizer(reason=None, *, address=False,
memory=False, ub=False):
def set_sanitizer_env_var(env, option):
- for name in ('ASAN_OPTIONS', 'MSAN_OPTIONS', 'UBSAN_OPTIONS'):
+ for name in ('ASAN_OPTIONS', 'MSAN_OPTIONS', 'UBSAN_OPTIONS',
'TSAN_OPTIONS'):
if name in env:
env[name] += f':{option}'
else:
diff --git a/Lib/test/test_io.py b/Lib/test/test_io.py
index 09cced9baef99b..1d78876f2a1c84 100644
--- a/Lib/test/test_io.py
+++ b/Lib/test/test_io.py
@@ -1654,7 +1654,8 @@ def test_truncate_on_read_only(self):
class CBufferedReaderTest(BufferedReaderTest, SizeofTest):
tp = io.BufferedReader
- @skip_if_sanitizer(memory=True, address=True, reason= "sanitizer defaults
to crashing "
+ @skip_if_sanitizer(memory=True, address=True, thread=True,
+ reason="sanitizer defaults to crashing "
"instead of returning NULL for malloc failure.")
def test_constructor(self):
BufferedReaderTest.test_constructor(self)
@@ -2021,7 +2022,8 @@ def test_slow_close_from_thread(self):
class CBufferedWriterTest(BufferedWriterTest, SizeofTest):
tp = io.BufferedWriter
- @skip_if_sanitizer(memory=True, address=True, reason= "sanitizer defaults
to crashing "
+ @skip_if_sanitizer(memory=True, address=True, thread=True,
+ reason="sanitizer defaults to crashing "
"instead of returning NULL for malloc failure.")
def test_constructor(self):
BufferedWriterTest.test_constructor(self)
@@ -2520,7 +2522,8 @@ def test_interleaved_readline_write(self):
class CBufferedRandomTest(BufferedRandomTest, SizeofTest):
tp = io.BufferedRandom
- @skip_if_sanitizer(memory=True, address=True, reason= "sanitizer defaults
to crashing "
+ @skip_if_sanitizer(memory=True, address=True, thread=True,
+ reason="sanitizer defaults to crashing "
"instead of returning NULL for malloc failure.")
def test_constructor(self):
BufferedRandomTest.test_constructor(self)
diff --git
a/Misc/NEWS.d/next/Build/2023-12-17-18-23-02.gh-issue-112536.8lr3Ep.rst
b/Misc/NEWS.d/next/Build/2023-12-17-18-23-02.gh-issue-112536.8lr3Ep.rst
new file mode 100644
index 00000000000000..a136eb47584993
--- /dev/null
+++ b/Misc/NEWS.d/next/Build/2023-12-17-18-23-02.gh-issue-112536.8lr3Ep.rst
@@ -0,0 +1 @@
+Add support for thread sanitizer (TSAN)
diff --git a/configure b/configure
index 3322b7a682dd25..3cc9aecafad13e 100755
--- a/configure
+++ b/configure
@@ -1082,6 +1082,7 @@ with_dsymutil
with_address_sanitizer
with_memory_sanitizer
with_undefined_behavior_sanitizer
+with_thread_sanitizer
with_hash_algorithm
with_tzpath
with_libs
@@ -1860,6 +1861,8 @@ Optional Packages:
--with-undefined-behavior-sanitizer
enable UndefinedBehaviorSanitizer undefined
behaviour detector, 'ubsan' (default is no)
+ --with-thread-sanitizer enable ThreadSanitizer data race detector, 'tsan'
+ (default is no)
--with-hash-algorithm=[fnv|siphash13|siphash24]
select hash algorithm for use in Python/pyhash.c
(default is SipHash13)
@@ -12506,6 +12509,28 @@ with_ubsan="no"
fi
+{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for
--with-thread-sanitizer" >&5
+printf %s "checking for --with-thread-sanitizer... " >&6; }
+
+# Check whether --with-thread_sanitizer was given.
+if test ${with_thread_sanitizer+y}
+then :
+ withval=$with_thread_sanitizer;
+{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $withval" >&5
+printf "%s\n" "$withval" >&6; }
+BASECFLAGS="-fsanitize=thread $BASECFLAGS"
+LDFLAGS="-fsanitize=thread $LDFLAGS"
+with_tsan="yes"
+
+else $as_nop
+
+{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: no" >&5
+printf "%s\n" "no" >&6; }
+with_tsan="no"
+
+fi
+
+
# Set info about shared libraries.
diff --git a/configure.ac b/configure.ac
index 13a6d746763d62..6a80a5d29a04ef 100644
--- a/configure.ac
+++ b/configure.ac
@@ -3067,6 +3067,24 @@ AC_MSG_RESULT([no])
with_ubsan="no"
])
+AC_MSG_CHECKING([for --with-thread-sanitizer])
+AC_ARG_WITH(
+ [thread_sanitizer],
+ [AS_HELP_STRING(
+ [--with-thread-sanitizer],
+ [enable ThreadSanitizer data race detector, 'tsan' (default is no)]
+ )],
+[
+AC_MSG_RESULT([$withval])
+BASECFLAGS="-fsanitize=thread $BASECFLAGS"
+LDFLAGS="-fsanitize=thread $LDFLAGS"
+with_tsan="yes"
+],
+[
+AC_MSG_RESULT([no])
+with_tsan="no"
+])
+
# Set info about shared libraries.
AC_SUBST([SHLIB_SUFFIX])
AC_SUBST([LDSHARED])
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
