Emscripten: static (non-MAIN_MODULE) builds fail at startup on dynamic-linking-only JS helpers
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
Bug description:
CPython's Emscripten platform code is written for the -sMAIN_MODULE dynamic-linking configuration it is built and tested in. Several EM_JS bodies reference JS helpers that only exist in that configuration. Because EM_JS bodies are emitted verbatim into the output, Emscripten's dependency tracker cannot see those references, so a static link silently emits JS calling helpers it never included and fails at runtime instead of at link time.
Four such references, each confirmed against Emscripten 6.0.9:
Python/emscripten_syscalls.c:110hooksresolveGlobalSymbol()to wrapmain()inWebAssembly.promising(). That helper is defined insrc/lib/libdylink.js, whichsrc/modules.mjs:99links in onlyif (MAIN_MODULE); the file itself#errors otherwise, and the symbol is marked__internal: true. The read sits below theif (!WebAssembly.promising) return;guard on line 106, so this only fires once a runtime exposes JSPI.Python/emscripten_trampoline.c:54and:82usewasmTableandaddFunction(). Neither is included by default;MAIN_MODULEhappens to pull both in through libdylink's own__deps.- The promising-main wrapper calls
_emscripten_exit_with_live_runtime()(emscripten_syscalls.c:128), which is likewise dropped from a static link. Python/emscripten_trampoline.c:93reads__PyRuntime, which is bound into the JS glue only becauseconfigurelists it in-sEXPORTED_FUNCTIONSfor CPython's ownpython.mjslink. An embedder linkinglibpythoninto their own application gets no such flag. Unlike the others, this one fails on every runtime, JSPI or not.
Minimal reproducer
This is the shape of (1) with no CPython involved:
#include <emscripten.h>
EM_JS(void, probe, (void), {
if (!WebAssembly.promising) return;
const orig = resolveGlobalSymbol;
})
__attribute__((constructor)) void c(void) { probe(); }
int main(void) { return 0; }
$ emcc t.c -o t.js # links clean, no diagnostic at all
$ node t.js # fine, the guard returns early
$ node --experimental-wasm-jspi t.js
ReferenceError: resolveGlobalSymbol is not defined
at probe (t.js:1513:136)
at initRuntime (t.js:540:35)
Emscripten does warn for library symbols it knows about — referencing addFunction the same way produces "addFunction is a library symbol and not included by default". resolveGlobalSymbol gets nothing, because without MAIN_MODULE libdylink.js is never loaded and the name is not in the symbol set to warn about.
Full reproduction
I built libpython3.14.a for wasm32-emscripten with --disable-wasm-dynamic-linking MODULE_BUILDTYPE=static CFLAGS=-DPY_CALL_TRAMPOLINE and linked it into a small C application that runs an interactive Python console in the browser. It aborts during startup on __PyRuntime; with that symbol exported by hand it then aborts on resolveGlobalSymbol as soon as JSPI is enabled, and works with JSPI off.
Note on the fix
EM_JS_DEPS (emscripten/em_macros.h) exists precisely to declare these, and emscripten_syscalls.c:43 already uses it for $SYSCALLS. Declaring $resolveGlobalSymbol converts the silent breakage into a link-time error: undefined symbol: $resolveGlobalSymbol, which is the behaviour you would want in a configuration that genuinely cannot support it.
Why this is not caught today
Every wasm test builds through Platforms/emscripten/__main__.py, which hard-codes --enable-wasm-dynamic-linking at line 510. web_example, web_example_pyrepl_jspi and browser_test therefore all exercise MAIN_MODULE only; the static configuration has no coverage.
Context for the report: this blocks embedding CPython in Kodi's WebAssembly port, which links statically.
CPython versions tested on:
3.14, CPython main branch
Operating systems tested on:
Other
Linked PRs
- gh-156781
- gh-156798
- gh-157238
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review Python/emscripten_syscalls.c, Python/emscripten_trampoline.c, emscripten/em_macros.h, and Platforms/emscripten/main.py, starting with the existing EM_JS_DEPS usage and static-link configuration. Reproduce the minimal C example and inspect the web_example, web_example_pyrepl_jspi, and browser_test paths; done means static builds no longer fail at startup and report unsupported references during linking instead.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c, javascript, python, wasm
- Domain
- build-system, web-dev
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 25/100