From 269b45485bc223e863a83088f5c8af6b930a8a8f Mon Sep 17 00:00:00 2001 From: alperyoney Date: Wed, 11 Jun 2025 22:08:12 -0700 Subject: [PATCH 1/4] gh-116738: Make grp module thread-safe --- Lib/test/test_free_threading/test_ft.py | 52 +++++++++++++++++++ Lib/test/test_free_threading/test_grp.py | 36 +++++++++++++ Lib/test/test_free_threading/test_heapq.py | 43 ++++----------- ...-06-12-00-03-34.gh-issue-116738.iBBAdo.rst | 1 + Modules/grpmodule.c | 33 ++++++++++-- 5 files changed, 130 insertions(+), 35 deletions(-) create mode 100644 Lib/test/test_free_threading/test_ft.py create mode 100644 Lib/test/test_free_threading/test_grp.py create mode 100644 Misc/NEWS.d/next/Core_and_Builtins/2025-06-12-00-03-34.gh-issue-116738.iBBAdo.rst diff --git a/Lib/test/test_free_threading/test_ft.py b/Lib/test/test_free_threading/test_ft.py new file mode 100644 index 00000000000000..95feb6b009817a --- /dev/null +++ b/Lib/test/test_free_threading/test_ft.py @@ -0,0 +1,52 @@ +import unittest + +from threading import Thread, Barrier +from test.support import threading_helper + + +def run_concurrently(worker_func, args, nthreads): + """ + Run the worker function concurrently in multiple threads. + """ + barrier = Barrier(nthreads) + + def wrapper_func(*args): + # Wait for all threads to reach this point before proceeding. + barrier.wait() + worker_func(*args) + + with threading_helper.catch_threading_exception() as cm: + workers = ( + Thread(target=wrapper_func, args=args) for _ in range(nthreads) + ) + with threading_helper.start_threads(workers): + pass + + # If a worker thread raises an exception, re-raise it. + if cm.exc_value is not None: + raise cm.exc_value + + +@threading_helper.requires_working_threading() +class TestFTUtils(unittest.TestCase): + def test_run_concurrently(self): + lst = [] + + def worker(lst): + lst.append(42) + + nthreads = 10 + run_concurrently(worker, (lst,), nthreads) + self.assertEqual(lst, [42] * nthreads) + + def test_run_concurrently_raise(self): + def worker(): + raise RuntimeError("Error") + + nthreads = 3 + with self.assertRaises(RuntimeError): + run_concurrently(worker, (), nthreads) + + +if __name__ == "__main__": + unittest.main() diff --git a/Lib/test/test_free_threading/test_grp.py b/Lib/test/test_free_threading/test_grp.py new file mode 100644 index 00000000000000..af4e5b6bb73dfd --- /dev/null +++ b/Lib/test/test_free_threading/test_grp.py @@ -0,0 +1,36 @@ +import unittest + +from test.support import import_helper, threading_helper +from test.test_free_threading.test_ft import run_concurrently + +grp = import_helper.import_module("grp") + +from test import test_grp + + +NTHREADS = 10 + + +@threading_helper.requires_working_threading() +class TestGrp(unittest.TestCase): + def setUp(self): + self.test_grp = test_grp.GroupDatabaseTestCase() + + def test_racing_test_values(self): + # test_grp.test_values() calls grp.getgrall() and checks the entries + run_concurrently( + worker_func=self.test_grp.test_values, args=(), nthreads=NTHREADS + ) + + def test_racing_test_values_extended(self): + # test_grp.test_values_extended() calls grp.getgrall(), grp.getgrgid(), + # grp.getgrnam() and checks the entries + run_concurrently( + worker_func=self.test_grp.test_values_extended, + args=(), + nthreads=NTHREADS, + ) + + +if __name__ == "__main__": + unittest.main() diff --git a/Lib/test/test_free_threading/test_heapq.py b/Lib/test/test_free_threading/test_heapq.py index f75fb264c8ac0f..48e5783d143202 100644 --- a/Lib/test/test_free_threading/test_heapq.py +++ b/Lib/test/test_free_threading/test_heapq.py @@ -3,10 +3,10 @@ import heapq from enum import Enum -from threading import Thread, Barrier from random import shuffle, randint from test.support import threading_helper +from test.test_free_threading.test_ft import run_concurrently from test import test_heapq @@ -28,7 +28,7 @@ def test_racing_heapify(self): heap = list(range(OBJECT_COUNT)) shuffle(heap) - self.run_concurrently( + run_concurrently( worker_func=heapq.heapify, args=(heap,), nthreads=NTHREADS ) self.test_heapq.check_invariant(heap) @@ -40,7 +40,7 @@ def heappush_func(heap): for item in reversed(range(OBJECT_COUNT)): heapq.heappush(heap, item) - self.run_concurrently( + run_concurrently( worker_func=heappush_func, args=(heap,), nthreads=NTHREADS ) self.test_heapq.check_invariant(heap) @@ -61,7 +61,7 @@ def heappop_func(heap, pop_count): # Each local list should be sorted self.assertTrue(self.is_sorted_ascending(local_list)) - self.run_concurrently( + run_concurrently( worker_func=heappop_func, args=(heap, per_thread_pop_count), nthreads=NTHREADS, @@ -77,7 +77,7 @@ def heappushpop_func(heap, pushpop_items): popped_item = heapq.heappushpop(heap, item) self.assertTrue(popped_item <= item) - self.run_concurrently( + run_concurrently( worker_func=heappushpop_func, args=(heap, pushpop_items), nthreads=NTHREADS, @@ -93,7 +93,7 @@ def heapreplace_func(heap, replace_items): for item in replace_items: heapq.heapreplace(heap, item) - self.run_concurrently( + run_concurrently( worker_func=heapreplace_func, args=(heap, replace_items), nthreads=NTHREADS, @@ -105,7 +105,7 @@ def test_racing_heapify_max(self): max_heap = list(range(OBJECT_COUNT)) shuffle(max_heap) - self.run_concurrently( + run_concurrently( worker_func=heapq.heapify_max, args=(max_heap,), nthreads=NTHREADS ) self.test_heapq.check_max_invariant(max_heap) @@ -117,7 +117,7 @@ def heappush_max_func(max_heap): for item in range(OBJECT_COUNT): heapq.heappush_max(max_heap, item) - self.run_concurrently( + run_concurrently( worker_func=heappush_max_func, args=(max_heap,), nthreads=NTHREADS ) self.test_heapq.check_max_invariant(max_heap) @@ -138,7 +138,7 @@ def heappop_max_func(max_heap, pop_count): # Each local list should be sorted self.assertTrue(self.is_sorted_descending(local_list)) - self.run_concurrently( + run_concurrently( worker_func=heappop_max_func, args=(max_heap, per_thread_pop_count), nthreads=NTHREADS, @@ -154,7 +154,7 @@ def heappushpop_max_func(max_heap, pushpop_items): popped_item = heapq.heappushpop_max(max_heap, item) self.assertTrue(popped_item >= item) - self.run_concurrently( + run_concurrently( worker_func=heappushpop_max_func, args=(max_heap, pushpop_items), nthreads=NTHREADS, @@ -170,7 +170,7 @@ def heapreplace_max_func(max_heap, replace_items): for item in replace_items: heapq.heapreplace_max(max_heap, item) - self.run_concurrently( + run_concurrently( worker_func=heapreplace_max_func, args=(max_heap, replace_items), nthreads=NTHREADS, @@ -214,27 +214,6 @@ def create_random_list(a, b, size): """ return [randint(-a, b) for _ in range(size)] - def run_concurrently(self, worker_func, args, nthreads): - """ - Run the worker function concurrently in multiple threads. - """ - barrier = Barrier(nthreads) - - def wrapper_func(*args): - # Wait for all threads to reach this point before proceeding. - barrier.wait() - worker_func(*args) - - with threading_helper.catch_threading_exception() as cm: - workers = ( - Thread(target=wrapper_func, args=args) for _ in range(nthreads) - ) - with threading_helper.start_threads(workers): - pass - - # Worker threads should not raise any exceptions - self.assertIsNone(cm.exc_value) - if __name__ == "__main__": unittest.main() diff --git a/Misc/NEWS.d/next/Core_and_Builtins/2025-06-12-00-03-34.gh-issue-116738.iBBAdo.rst b/Misc/NEWS.d/next/Core_and_Builtins/2025-06-12-00-03-34.gh-issue-116738.iBBAdo.rst new file mode 100644 index 00000000000000..1f3c53c3464ace --- /dev/null +++ b/Misc/NEWS.d/next/Core_and_Builtins/2025-06-12-00-03-34.gh-issue-116738.iBBAdo.rst @@ -0,0 +1 @@ +Make methods in :mod:`grp` thread-safe on the :term:`free threaded ` build. diff --git a/Modules/grpmodule.c b/Modules/grpmodule.c index 29da9936b65504..35350f9de53fa5 100644 --- a/Modules/grpmodule.c +++ b/Modules/grpmodule.c @@ -132,7 +132,7 @@ grp_getgrgid_impl(PyObject *module, PyObject *id) if (!_Py_Gid_Converter(id, &gid)) { return NULL; } -#ifdef HAVE_GETGRGID_R +#if defined(HAVE_GETGRGID_R) int status; Py_ssize_t bufsize; /* Note: 'grp' will be used via pointer 'p' on getgrgid_r success. */ @@ -167,6 +167,17 @@ grp_getgrgid_impl(PyObject *module, PyObject *id) } Py_END_ALLOW_THREADS +#elif defined(Py_GIL_DISABLED) + static PyMutex getgrgid_mutex = {0}; + PyMutex_Lock(&getgrgid_mutex); + // The getgrgid() function need not be thread-safe. + // https://pubs.opengroup.org/onlinepubs/9699919799/functions/getgrgid.html + p = getgrgid(gid); + if (p == NULL) { + // Unlock the mutex on error. The following error handling block will + // handle the rest. + PyMutex_Unlock(&getgrgid_mutex); + } #else p = getgrgid(gid); #endif @@ -183,8 +194,10 @@ grp_getgrgid_impl(PyObject *module, PyObject *id) return NULL; } retval = mkgrent(module, p); -#ifdef HAVE_GETGRGID_R +#if defined(HAVE_GETGRGID_R) PyMem_RawFree(buf); +#elif defined(Py_GIL_DISABLED) + PyMutex_Unlock(&getgrgid_mutex); #endif return retval; } @@ -213,7 +226,7 @@ grp_getgrnam_impl(PyObject *module, PyObject *name) /* check for embedded null bytes */ if (PyBytes_AsStringAndSize(bytes, &name_chars, NULL) == -1) goto out; -#ifdef HAVE_GETGRNAM_R +#if defined(HAVE_GETGRNAM_R) int status; Py_ssize_t bufsize; /* Note: 'grp' will be used via pointer 'p' on getgrnam_r success. */ @@ -248,6 +261,17 @@ grp_getgrnam_impl(PyObject *module, PyObject *name) } Py_END_ALLOW_THREADS +#elif defined(Py_GIL_DISABLED) + static PyMutex getgrnam_mutex = {0}; + PyMutex_Lock(&getgrnam_mutex); + // The getgrnam() function need not be thread-safe. + // https://pubs.opengroup.org/onlinepubs/9699919799/functions/getgrnam.html + p = getgrnam(name_chars); + if (p == NULL) { + // Unlock the mutex on error. The following error handling block will + // handle the rest. + PyMutex_Unlock(&getgrnam_mutex); + } #else p = getgrnam(name_chars); #endif @@ -261,6 +285,9 @@ grp_getgrnam_impl(PyObject *module, PyObject *name) goto out; } retval = mkgrent(module, p); +#if !defined(HAVE_GETGRNAM_R) && defined(Py_GIL_DISABLED) + PyMutex_Unlock(&getgrnam_mutex); +#endif out: PyMem_RawFree(buf); Py_DECREF(bytes); From 9dc5fb680a3512866ab4721c2a840b77f15f7be6 Mon Sep 17 00:00:00 2001 From: alperyoney Date: Mon, 16 Jun 2025 14:39:38 -0700 Subject: [PATCH 2/4] gh-116738: Protect non thread-safe functions in default build --- Modules/grpmodule.c | 30 +++++++++++------------------- 1 file changed, 11 insertions(+), 19 deletions(-) diff --git a/Modules/grpmodule.c b/Modules/grpmodule.c index 35350f9de53fa5..b1916ae78885fe 100644 --- a/Modules/grpmodule.c +++ b/Modules/grpmodule.c @@ -132,7 +132,7 @@ grp_getgrgid_impl(PyObject *module, PyObject *id) if (!_Py_Gid_Converter(id, &gid)) { return NULL; } -#if defined(HAVE_GETGRGID_R) +#ifdef HAVE_GETGRGID_R int status; Py_ssize_t bufsize; /* Note: 'grp' will be used via pointer 'p' on getgrgid_r success. */ @@ -167,21 +167,17 @@ grp_getgrgid_impl(PyObject *module, PyObject *id) } Py_END_ALLOW_THREADS -#elif defined(Py_GIL_DISABLED) +#else static PyMutex getgrgid_mutex = {0}; PyMutex_Lock(&getgrgid_mutex); // The getgrgid() function need not be thread-safe. // https://pubs.opengroup.org/onlinepubs/9699919799/functions/getgrgid.html p = getgrgid(gid); +#endif if (p == NULL) { - // Unlock the mutex on error. The following error handling block will - // handle the rest. +#ifndef HAVE_GETGRGID_R PyMutex_Unlock(&getgrgid_mutex); - } -#else - p = getgrgid(gid); #endif - if (p == NULL) { PyMem_RawFree(buf); if (nomem == 1) { return PyErr_NoMemory(); @@ -194,9 +190,9 @@ grp_getgrgid_impl(PyObject *module, PyObject *id) return NULL; } retval = mkgrent(module, p); -#if defined(HAVE_GETGRGID_R) +#ifdef HAVE_GETGRGID_R PyMem_RawFree(buf); -#elif defined(Py_GIL_DISABLED) +#else PyMutex_Unlock(&getgrgid_mutex); #endif return retval; @@ -226,7 +222,7 @@ grp_getgrnam_impl(PyObject *module, PyObject *name) /* check for embedded null bytes */ if (PyBytes_AsStringAndSize(bytes, &name_chars, NULL) == -1) goto out; -#if defined(HAVE_GETGRNAM_R) +#ifdef HAVE_GETGRNAM_R int status; Py_ssize_t bufsize; /* Note: 'grp' will be used via pointer 'p' on getgrnam_r success. */ @@ -261,21 +257,17 @@ grp_getgrnam_impl(PyObject *module, PyObject *name) } Py_END_ALLOW_THREADS -#elif defined(Py_GIL_DISABLED) +#else static PyMutex getgrnam_mutex = {0}; PyMutex_Lock(&getgrnam_mutex); // The getgrnam() function need not be thread-safe. // https://pubs.opengroup.org/onlinepubs/9699919799/functions/getgrnam.html p = getgrnam(name_chars); +#endif if (p == NULL) { - // Unlock the mutex on error. The following error handling block will - // handle the rest. +#ifndef HAVE_GETGRGID_R PyMutex_Unlock(&getgrnam_mutex); - } -#else - p = getgrnam(name_chars); #endif - if (p == NULL) { if (nomem == 1) { PyErr_NoMemory(); } @@ -285,7 +277,7 @@ grp_getgrnam_impl(PyObject *module, PyObject *name) goto out; } retval = mkgrent(module, p); -#if !defined(HAVE_GETGRNAM_R) && defined(Py_GIL_DISABLED) +#ifndef HAVE_GETGRNAM_R PyMutex_Unlock(&getgrnam_mutex); #endif out: From 0e0dda027d9a8629a0992caa246b6f01d960bb8b Mon Sep 17 00:00:00 2001 From: alperyoney Date: Mon, 16 Jun 2025 15:27:06 -0700 Subject: [PATCH 3/4] gh-116738: Fix pre-processor block --- Modules/grpmodule.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Modules/grpmodule.c b/Modules/grpmodule.c index b1916ae78885fe..b33f5e472dee98 100644 --- a/Modules/grpmodule.c +++ b/Modules/grpmodule.c @@ -265,7 +265,7 @@ grp_getgrnam_impl(PyObject *module, PyObject *name) p = getgrnam(name_chars); #endif if (p == NULL) { -#ifndef HAVE_GETGRGID_R +#ifndef HAVE_GETGRNAM_R PyMutex_Unlock(&getgrnam_mutex); #endif if (nomem == 1) { From dedbae964b1c60f062fa43a8ca43f09add8675e3 Mon Sep 17 00:00:00 2001 From: alperyoney Date: Tue, 17 Jun 2025 12:58:30 -0700 Subject: [PATCH 4/4] gh-116738: Move run_concurrently() to threading_helper --- Lib/test/support/threading_helper.py | 24 ++++++++++ Lib/test/test_free_threading/test_ft.py | 52 ---------------------- Lib/test/test_free_threading/test_grp.py | 2 +- Lib/test/test_free_threading/test_heapq.py | 2 +- 4 files changed, 26 insertions(+), 54 deletions(-) delete mode 100644 Lib/test/test_free_threading/test_ft.py diff --git a/Lib/test/support/threading_helper.py b/Lib/test/support/threading_helper.py index afa25a76f63829..7724f863ca42f0 100644 --- a/Lib/test/support/threading_helper.py +++ b/Lib/test/support/threading_helper.py @@ -248,3 +248,27 @@ def requires_working_threading(*, module=False): raise unittest.SkipTest(msg) else: return unittest.skipUnless(can_start_thread, msg) + + +def run_concurrently(worker_func, args, nthreads): + """ + Run the worker function concurrently in multiple threads. + """ + barrier = threading.Barrier(nthreads) + + def wrapper_func(*args): + # Wait for all threads to reach this point before proceeding. + barrier.wait() + worker_func(*args) + + with catch_threading_exception() as cm: + workers = ( + threading.Thread(target=wrapper_func, args=args) + for _ in range(nthreads) + ) + with start_threads(workers): + pass + + # If a worker thread raises an exception, re-raise it. + if cm.exc_value is not None: + raise cm.exc_value diff --git a/Lib/test/test_free_threading/test_ft.py b/Lib/test/test_free_threading/test_ft.py deleted file mode 100644 index 95feb6b009817a..00000000000000 --- a/Lib/test/test_free_threading/test_ft.py +++ /dev/null @@ -1,52 +0,0 @@ -import unittest - -from threading import Thread, Barrier -from test.support import threading_helper - - -def run_concurrently(worker_func, args, nthreads): - """ - Run the worker function concurrently in multiple threads. - """ - barrier = Barrier(nthreads) - - def wrapper_func(*args): - # Wait for all threads to reach this point before proceeding. - barrier.wait() - worker_func(*args) - - with threading_helper.catch_threading_exception() as cm: - workers = ( - Thread(target=wrapper_func, args=args) for _ in range(nthreads) - ) - with threading_helper.start_threads(workers): - pass - - # If a worker thread raises an exception, re-raise it. - if cm.exc_value is not None: - raise cm.exc_value - - -@threading_helper.requires_working_threading() -class TestFTUtils(unittest.TestCase): - def test_run_concurrently(self): - lst = [] - - def worker(lst): - lst.append(42) - - nthreads = 10 - run_concurrently(worker, (lst,), nthreads) - self.assertEqual(lst, [42] * nthreads) - - def test_run_concurrently_raise(self): - def worker(): - raise RuntimeError("Error") - - nthreads = 3 - with self.assertRaises(RuntimeError): - run_concurrently(worker, (), nthreads) - - -if __name__ == "__main__": - unittest.main() diff --git a/Lib/test/test_free_threading/test_grp.py b/Lib/test/test_free_threading/test_grp.py index af4e5b6bb73dfd..493475809f04eb 100644 --- a/Lib/test/test_free_threading/test_grp.py +++ b/Lib/test/test_free_threading/test_grp.py @@ -1,7 +1,7 @@ import unittest from test.support import import_helper, threading_helper -from test.test_free_threading.test_ft import run_concurrently +from test.support.threading_helper import run_concurrently grp = import_helper.import_module("grp") diff --git a/Lib/test/test_free_threading/test_heapq.py b/Lib/test/test_free_threading/test_heapq.py index 48e5783d143202..601ffe093ac43a 100644 --- a/Lib/test/test_free_threading/test_heapq.py +++ b/Lib/test/test_free_threading/test_heapq.py @@ -6,7 +6,7 @@ from random import shuffle, randint from test.support import threading_helper -from test.test_free_threading.test_ft import run_concurrently +from test.support.threading_helper import run_concurrently from test import test_heapq