Skip to content
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

gh-111569: Fix critical sections test on WebAssembly #111897

Merged
merged 3 commits into from Nov 9, 2023

Conversation

colesbury
Copy link
Contributor

@colesbury colesbury commented Nov 9, 2023

This adds a macro Py_CAN_START_THREADS that corresponds to the Python function test.support.threading_helper.can_start_thread(). Some WebAssembly platforms do not have a working pthread implementation.

This macro is used to guard the critical sections C API tests that require a working threads implementation.

This adds a macro `Py_CAN_START_THREADS` that corresponds to the Python
function `test.support.threading_helper.can_start_thread()`. WASI and
some Emscripten builds do not have a working pthread implementation.

This macro is used to guard the critical sections C API tests that
require a working threads implementation.
@colesbury
Copy link
Contributor Author

!buildbot wasm

@bedevere-bot
Copy link

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

The command will test the builders whose names match following regular expression: wasm

The builders matched are:

  • wasm32-emscripten browser (dynamic linking, no tests) PR
  • wasm32 WASI PR
  • wasm32-emscripten node (dynamic linking) PR
  • wasm32-emscripten node (pthreads) PR
  • wasm32-wasi PR

@colesbury
Copy link
Contributor Author

!buildbot wasm

@bedevere-bot
Copy link

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

The command will test the builders whose names match following regular expression: wasm

The builders matched are:

  • wasm32-emscripten browser (dynamic linking, no tests) PR
  • wasm32 WASI PR
  • wasm32-emscripten node (dynamic linking) PR
  • wasm32-emscripten node (pthreads) PR
  • wasm32-wasi PR

Copy link
Member

@brettcannon brettcannon left a comment

Choose a reason for hiding this comment

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

Unfortunately there's more subtlety to thread support under WASI as it's possible via --with-wasm-pthreads, but it's opt-in (until threads fully land in the WebAssembly standard and support trickles down through the tooling).

Include/pyport.h Outdated
Comment on lines 476 to 478
#if !defined(__wasi__) && (!defined(__EMSCRIPTEN__) || defined(__EMSCRIPTEN_PTHREADS__))
# define Py_CAN_START_THREADS 1
#endif
Copy link
Member

Choose a reason for hiding this comment

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

Unfortunately it's trickier than that because you can do a WASI build with experimental threading support (the "experimental" bit is on the WASI side, not our side); see the --with-wasm-pthreads for turning the support on.

cpython/configure.ac

Lines 2123 to 2127 in 6f09f69

AS_VAR_IF([enable_wasm_pthreads], [yes], [
AS_VAR_APPEND([CFLAGS_NODIST], [" -pthread"])
AS_VAR_APPEND([LDFLAGS_NODIST], [" -sUSE_PTHREADS"])
AS_VAR_APPEND([LINKFORSHARED], [" -sPROXY_TO_PTHREAD"])
])

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@brettcannon, do you think the general approach here is a reasonable? Previously, I had been just checking for thread support on the Python side, but that's a bit awkward for these C API tests.

I'm a bit confused by your comment that you can do a WASI build with threading support. I see that there is Emscripten support for pthreads. That's already handled by the __EMSCRIPTEN_PTHREADS__ check on line 476.

The Python equivalent assumes that WASI never supports threads:

elif sys.platform == "wasi":
return False

I see that there is a WASI proposal for threads (https://github.com/WebAssembly/wasi-threads), but that looks like it's still marked "phase 1".

Copy link
Member

Choose a reason for hiding this comment

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

The Python equivalent assumes that WASI never supports threads

The threading support isn't well-tested because I haven't set up a buildbot yet and made it priority to more thoroughly test it. 😅

I see that there is a WASI proposal for threads (https://github.com/WebAssembly/wasi-threads), but that looks like it's still marked "phase 1".

Yep, and it's staying at that phase because threading is being taken up by the WebAssembly CG at the W3C which acts as an upstream to WASI. That proposal hit I think phase 4 last month (it's definitely moving forward regardless of whether I got the number right), hence why this whole "threads in WASI" thing continues to be experimental both in WASI and for us.

I think we need to make a decision about free-threading and WASI. Do we want to try and make it work with the experimental threading support that's there, or do we say it's not worth it and wait on the more official support to land?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think we need to make a decision about free-threading and WASI.

My 2¢ is "no, not for now", but I also think that's only tangentially related to this issue. The test breakage is not happening in a free-threaded (--disable-gil) build. Even if we don't support the combination of --disable-gil and wasm, I'd still like a way to determine at compile time (in C code) if PyThread_start_new_thread will actually launch a thread (or is just a no-op stub).

I think we might be able to just use HAVE_PTHREAD_STUBS here instead of defining a new Py_CAN_START_THREADS.

I'm hoping to run this on the wasm buildbots, but I think the runner is backed up... probably because the test_critical_sections_threads test hangs until the test suite times out.

Copy link
Member

Choose a reason for hiding this comment

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

👍 if the HAVE_PTHREADS_STUBS solution works.

Copy link
Member

Choose a reason for hiding this comment

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

And I think the buildbots have calmed down: https://buildbot.python.org/all/#/builders?tags=wasm

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmmm... HAVE_PTHREAD_STUBS did not seem to work.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It appears that when built without thread support WASI uses HAVE_PTHREAD_STUBS, but Emscripten stubs pthreads internally.

@bedevere-app
Copy link

bedevere-app bot commented Nov 9, 2023

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@colesbury colesbury marked this pull request as ready for review November 9, 2023 19:14
@colesbury colesbury marked this pull request as draft November 9, 2023 19:25
@colesbury colesbury marked this pull request as ready for review November 9, 2023 20:15
@colesbury
Copy link
Contributor Author

Ok, I think this is ready for review now. I went back to the Py_CAN_START_THREADS approach, but check for HAVE_PTHREAD_STUBS and the Emscripten combiation. WASI support for threads is indicated by the absence/presence of HAVE_PTHREAD_STUBS. Emscripten support for threads is indicated by __EMSCRIPTEN_PTHREADS__.

@brettcannon
Copy link
Member

!buildbot wasm

@bedevere-bot
Copy link

🤖 New build scheduled with the buildbot fleet by @brettcannon for commit 2ac2321 🤖

The command will test the builders whose names match following regular expression: wasm

The builders matched are:

  • wasm32-emscripten browser (dynamic linking, no tests) PR
  • wasm32 WASI PR
  • wasm32-emscripten node (dynamic linking) PR
  • wasm32-emscripten node (pthreads) PR
  • wasm32-wasi PR

@brettcannon brettcannon merged commit 289af86 into python:main Nov 9, 2023
33 checks passed
@brettcannon
Copy link
Member

Thanks, @colesbury !

@colesbury colesbury deleted the critical_sections-wasm branch November 9, 2023 23:38
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
…111897)

This adds a macro `Py_CAN_START_THREADS` that corresponds to the Python
function `test.support.threading_helper.can_start_thread()`. WASI and
some Emscripten builds do not have a working pthread implementation.

This macro is used to guard the critical sections C API tests that
require a working threads implementation.
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.

None yet

3 participants