Skip to content

gh-135239: simpler use of mutex in hashlib & co #135267

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 30 commits into
base: main
Choose a base branch
from

Conversation

picnixz
Copy link
Member

@picnixz picnixz commented Jun 8, 2025

I've taken the liberty of normalizing code style. I'll do the same in other modules, (SHA and BLAKE2). That way, I'll never need to touch cosmetics again in crypto-modules. Well, if it's too much I can drop the last commit.

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.

Note that PyMutex_Lock will release the GIL/detach the thread state anyway. You want _PyMutex_LockFlags(m, _Py_LOCK_DONT_DETACH) if you're worried about GIL overhead.

@picnixz picnixz marked this pull request as draft June 8, 2025 19:37
@picnixz picnixz requested a review from ZeroIntensity June 15, 2025 09:40
@picnixz picnixz marked this pull request as ready for review June 15, 2025 11:39
@picnixz picnixz marked this pull request as draft June 16, 2025 10:16
@picnixz picnixz force-pushed the perf/hashlib/mutex-135239 branch from bb237c2 to db57278 Compare June 16, 2025 10:35
@picnixz
Copy link
Member Author

picnixz commented Jun 16, 2025

I think this is a nice refactoring. I haven't tested performances yet but I doubt it'll degrade by much. And even if it does degrade a bit, I'd rather make use of an unconditional lock rather than hoping that HACL* lib is threadsafe (which I don't know and maybe it's not easy to do it).

@picnixz
Copy link
Member Author

picnixz commented Jun 16, 2025

Hum. We're loosing quite a lot of speed if we do incremental hashing with small buffers (we are 2x-3x slower). However, even with small buffers, we probably already have a race condition right, assuming that HACL* interface is not thread-safe (which I think it's not as the state doesn't have hold a mutex).

@picnixz picnixz marked this pull request as draft June 16, 2025 11:13
@picnixz
Copy link
Member Author

picnixz commented Jun 16, 2025

Ok, so we're actually losing speed because of Py_BEGIN_ALLOW_THREADS. However, without those calls, we could end up being blocked by the update call itself, right? Thus, I'll restore the check for large buffers, and only release the GIL when the buffers are really large (but I'll still lock the object itself).

Am I right here @ZeroIntensity ?

@picnixz
Copy link
Member Author

picnixz commented Jun 16, 2025

Ok, I managed to restore the perfs!

@picnixz
Copy link
Member Author

picnixz commented Jun 16, 2025

I think we're good now. I'm leaving my dev session and won't be back until Thursday so this will need to wait.

@picnixz picnixz marked this pull request as ready for review June 16, 2025 13:28
@ZeroIntensity
Copy link
Member

Ok, so we're actually losing speed because of Py_BEGIN_ALLOW_THREADS. However, without those calls, we could end up being blocked by the update call itself, right? Thus, I'll restore the check for large buffers, and only release the GIL when the buffers are really large (but I'll still lock the object itself).

That sounds fine to me, but make sure that the locking is done in a consistent order. Note that acquiring the lock will release the GIL, unless you explicitly tell it not to with _Py_LOCK_DONT_DETACH.

do { \
(obj)->mutex = (PyMutex){0}; \
(obj)->use_mutex = true; \
#define PyObject_HASHLIB_HEAD \
Copy link
Member

Choose a reason for hiding this comment

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

Would it be possible to make it private? Rename it to _PyObject_HASHLIB_HEAD.

Copy link
Member Author

Choose a reason for hiding this comment

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

Strictly speaking, it's an undefined behavior to have an underscore followed by a capital letter, but since we have so many _Py* in the codebase, I can either rename it as you suggested or HASHLIB_OBJECT_HEAD. Which one do you prefer (I can also add some _Py* prefixes to other macros but we historically had only HASHLIB_* prefixes).

Copy link
Member

Choose a reason for hiding this comment

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

I'm fine with HASHLIB_OBJECT_HEAD.

}
return PyUnicode_FromStringAndSize(digest_hex, sizeof(digest_hex));
HASHLIB_RELEASE_LOCK(self);
return _Py_strhex((const char *)digest, MD5_DIGESTSIZE);
Copy link
Member

Choose a reason for hiding this comment

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

This change is unrelated and should be done in a separated PR.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'll isolate it when I'm offline. I won't merge this PR before the end of the week anyway

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting core review skip news type-refactor Code refactoring (with no changes in behavior)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants