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

FIX Fill in GOT entries when libs are loaded with allowUndefined #22053

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

hoodmane
Copy link
Collaborator

@hoodmane hoodmane commented Jun 4, 2024

Resolves #22052.

@hoodmane hoodmane force-pushed the got-null-allow-undefined branch from 14b7425 to d4eff65 Compare June 4, 2024 14:51
rtn.value = addFunction(value, value.sig);
} else if (typeof value == {{{ POINTER_JS_TYPE }}}) {
rtn.value = value;
}
Copy link
Collaborator

Choose a reason for hiding this comment

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

It looks like this code is very similar to existing code in both reportUndefinedSymbols and updateGOT. I wonder if we can factor this better?

Also, I think there is probably some reason we delay updated the GOT at GOTHandler time and instead do it later on. Perhaps we could instead modify the existing updateGOT function?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Sounds good I'll try factoring out the shared logic and moving the change to updateGot.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Is __cxa_throw effected because its a JS symbol?

The problem specifically seems to be that updateGOT fills in the GOT table for all wasm exports from the loaded library. So it misses JavaScript symbols exported from the main module. Perhaps it would fix it to add GOT entries for all of the JS-implemented library funcs in the main module?

Copy link
Collaborator

Choose a reason for hiding this comment

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

How about if we rename reportUndefinedSymbols to handleUndefinedSymbols and have it take an reportErrors flags?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Well it seems to me that the only reason we need this GOT update behavior in reportUndefinedSymbols is because of JS symbols from the main module which are not handled by updateGOT. So they only get added to the GOT if first we have a library that needs them. Why not just stick all JS symbols in the GOT at startup and not worry about having something like handleUndefinedSymbols?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Oh sorry, yes, strong symbols should always win, although I'm not sure how important that edge case is.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

But you think the case where a JS symbol is overridden by a native symbol is more important? Are the JS symbols automatically counted as weak?

Copy link
Collaborator

Choose a reason for hiding this comment

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

No, not necessarily. I was just trying to imagine/remember the reason for factoring the code this way.

I do think we have good test coverage here, so I think its reasonably safe to try refactoring this code and if the tests pass it should be fine.

Copy link
Collaborator

Choose a reason for hiding this comment

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

There is also a non-zero cost to adding JS functions to the wasm table.. see the addFunction helper.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Right, in the future where WebAssembly.Function is available it will be better. Is it possible we could just import and reexport all these JS functions from the main module so that they would all get added by updateGOT in the normal way?

@hoodmane
Copy link
Collaborator Author

hoodmane commented Jun 5, 2024

@sbc100 I think ideally reportUndefinedSymbols() shouldn't adjust the GOT because the name makes it sound like it's for error detection/debugging. The fact that it can be necessary to keep things from breaking is unfortunate given the name.

@sbc100
Copy link
Collaborator

sbc100 commented Jun 5, 2024

@sbc100 I think ideally reportUndefinedSymbols() shouldn't adjust the GOT because the name makes it sound like it's for error detection/debugging. The fact that it can be necessary to keep things from breaking is unfortunate given the name.

I agree.. we should probably split the reportUndefinedSymbols logic

@hoodmane
Copy link
Collaborator Author

hoodmane commented Jun 8, 2024

@sbc100 Could this be a regression from #21785? It seems like a regression from Pyodide 0.25 to 0.26 and we upgraded from Emscripten 3.1.52 to 3.1.58. In the changelog in that range, #21785 seems like the most likely culprit.

@sbc100
Copy link
Collaborator

sbc100 commented Jun 8, 2024

@sbc100 Could this be a regression from #21785? It seems like a regression from Pyodide 0.25 to 0.26 and we upgraded from Emscripten 3.1.52 to 3.1.58. In the changelog in that range, #21785 seems like the most likely culprit.

I assume that by "this" you are referring to #22052? Its hard to say right now since I don't fully understand the exact issue. However I will say that #21785 pertains the native symbols and which of them get exported on the Module, whereas #22052 appears to pertain to JS symbols, is that right?

@sbc100
Copy link
Collaborator

sbc100 commented Jun 8, 2024

It seems like a regression from Pyodide 0.25 to 0.26 and we upgraded from Emscripten 3.1.52 to 3.1.58

Is it possible to confirm that for sure by upgrading just emscripten, and keeping all other things constant? Even better could you bisect to find out exactly which emscripten change caused the regression?

@hoodmane
Copy link
Collaborator Author

hoodmane commented Jun 9, 2024

Okay it reproduces on 3.1.57. So maybe not a regression, will check 3.1.52 next.

@hoodmane
Copy link
Collaborator Author

hoodmane commented Jun 9, 2024

Does not reproduce in 3.1.52, so indeed a regression since then. Will bisect.

@hoodmane
Copy link
Collaborator Author

hoodmane commented Jun 9, 2024

Regression was between 3.1.56 and 3.1.57.

@hoodmane
Copy link
Collaborator Author

The regression was #21638. Reverting this on top of the main branch has no conflicts and makes the problem go away.

hoodmane added a commit to hoodmane/emscripten that referenced this pull request Jun 21, 2024
hoodmane added a commit to hoodmane/emscripten that referenced this pull request Jun 21, 2024
@sbc100
Copy link
Collaborator

sbc100 commented Feb 8, 2025

Did this PR get superseded or do we still want to work on landing it?

@hoodmane
Copy link
Collaborator Author

hoodmane commented Feb 8, 2025

I will try to check in a couple days but I think it's still a problem and it would be nice to work on landing a fix.

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

Successfully merging this pull request may close these issues.

Emscripten calls null GOT entry when side module loaded with allowUndefined: true
2 participants