gh-116738: Make grp module thread-safe

Author: yoney

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()

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()

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()

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 <free threading>` build.

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);