gh-116738: Make grp module thread-safe by yoney · Pull Request #135434 · python/cpython · GitHub | Latest TMZ Celebrity News & Gossip | Watch TMZ Live
Skip to content

gh-116738: Make grp module thread-safe #135434

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Conversation

yoney
Copy link
Contributor

@yoney yoney commented Jun 12, 2025

Make grp module methods getgrgid() and getgrnam() thread-safe when the GIL is disabled and getgrgid_r()/getgrnam_r() C APIs are not available.

  • Move run_concurrently() to test.support.threading_helper to resuse across multiple tests.

cc: @mpage @colesbury @Yhg1s

@yoney yoney marked this pull request as ready for review June 12, 2025 16:01
@yoney yoney requested a review from rhettinger as a code owner June 12, 2025 16:01
@yoney
Copy link
Contributor Author

yoney commented Jun 12, 2025

Note: I am not sure if there is a CI setup where getgrgid_r()/getgrnam_r() are not available. I tested those manually on my local machine.

@colesbury colesbury added the 🔨 test-with-buildbots Test PR w/ buildbots; report in status section label Jun 16, 2025
@bedevere-bot
Copy link

🤖 New build scheduled with the buildbot fleet by @colesbury for commit 269b454 🤖

Results will be shown at:

https://buildbot.python.org/all/#/grid?branch=refs%2Fpull%2F135434%2Fmerge

If you want to schedule another build, you need to add the 🔨 test-with-buildbots label again.

@bedevere-bot bedevere-bot removed the 🔨 test-with-buildbots Test PR w/ buildbots; report in status section label Jun 16, 2025
@colesbury colesbury added the needs backport to 3.14 bugs and security fixes label Jun 16, 2025
@rhettinger rhettinger removed their request for review June 17, 2025 02:52
@mpage
Copy link
Contributor

mpage commented Jun 26, 2025

@yoney - Can you merge main and fix up the conflicts?

@yoney
Copy link
Contributor Author

yoney commented Jun 26, 2025

@yoney - Can you merge main and fix up the conflicts?

I rebased and force push but I think this is not the right way, I should have merged the main on top of my branch, I am sorry.

@mpage
Copy link
Contributor

mpage commented Jun 26, 2025

I rebased and force push but I think this is not the right way, I should have merged the main on top of my branch, I am sorry.

No worries!

Copy link
Member

@ZeroIntensity ZeroIntensity left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The core changes look good to me, just a few comments about the new threading_helper function.

@@ -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):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that args=() is the overwhelmingly common case. It should be fine to make it a default. For completeness, let's also add a kwargs parameter. So, the signature should end up looking like this:

# It's fine to use a mutable default here because it's not mutated
def run_concurrently(worker_func, nthreads, args=(), kwargs={}):

You also need to document this at https://docs.python.org/3/library/test.html#module-test.support.threading_helper.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @ZeroIntensity! I updated run_concurrently()

@@ -261,6 +277,9 @@ grp_getgrnam_impl(PyObject *module, PyObject *name)
goto out;
}
retval = mkgrent(module, p);
#ifndef HAVE_GETGRNAM_R
PyMutex_Unlock(&getgrnam_mutex);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is it necessary to hold the lock while calling mkgrent?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, hm, I thought this was a grp function. You're right--I don't think it's safe to hold the lock while calling it, because it executes finalizers.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is it necessary to hold the lock while calling mkgrent?

I think we should hold the lock while processing a pointer to a struct group

The returned pointer, and pointers within the structure, might be invalidated or the structure or the storage areas might be overwritten by a subsequent call to getgrent(), getgrgid(), or getgrnam(). (link)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, hm, I thought this was a grp function. You're right--I don't think it's safe to hold the lock while calling it, because it executes finalizers.

cpython/Modules/grpmodule.c

Lines 294 to 298 in da79ac9

// gh-126316: Don't release the mutex around mkgrent() since
// setgrent()/endgrent() are not reentrant / thread-safe. A deadlock
// is unlikely since mkgrent() should not be able to call arbitrary
// Python code.
PyObject *v = mkgrent(module, p);

grp_getgrall_impl() holds the lock around mkgrent(), but I'll check if it's something we need to fix.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

might be overwritten by a subsequent call to getgrent(), getgrgid(), or getgrnam()

When I re-read the document, I think we need one lock to protect all those function calls. I'll update the PR.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, so we're intentionally playing with fire a little bit. I think the lock is fine, then.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants

TMZ Celebrity News – Breaking Stories, Videos & Gossip

Looking for the latest TMZ celebrity news? You've come to the right place. From shocking Hollywood scandals to exclusive videos, TMZ delivers it all in real time.

Whether it’s a red carpet slip-up, a viral paparazzi moment, or a legal drama involving your favorite stars, TMZ news is always first to break the story. Stay in the loop with daily updates, insider tips, and jaw-dropping photos.

🎥 Watch TMZ Live

TMZ Live brings you daily celebrity news and interviews straight from the TMZ newsroom. Don’t miss a beat—watch now and see what’s trending in Hollywood.