Skip to content

[embind] Use a single invoker mechanism #24577

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 17, 2025
Merged

[embind] Use a single invoker mechanism #24577

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 49 additions & 53 deletions src/lib/libemval.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,13 +122,6 @@ var LibraryEmVal = {
_emval_new_u16string__deps: ['$Emval'],
_emval_new_u16string: (v) => Emval.toHandle(UTF16ToString(v)),

_emval_take_value__deps: ['$Emval', '$requireRegisteredType'],
_emval_take_value: (type, arg) => {
type = requireRegisteredType(type, '_emval_take_value');
var v = type['readValueFromPointer'](arg);
return Emval.toHandle(v);
},

#if SUPPORTS_GLOBALTHIS
$emval_get_global: () => globalThis,
#elif !DYNAMIC_EXECUTION
Expand Down Expand Up @@ -209,27 +202,6 @@ var LibraryEmVal = {
return result;
},

_emval_as__deps: ['$Emval', '$requireRegisteredType', '$emval_returnValue'],
_emval_as: (handle, returnType, destructorsRef) => {
handle = Emval.toValue(handle);
returnType = requireRegisteredType(returnType, 'emval::as');
return emval_returnValue(returnType, destructorsRef, handle);
},

_emval_as_int64__deps: ['$Emval', '$requireRegisteredType'],
_emval_as_int64: (handle, returnType) => {
handle = Emval.toValue(handle);
returnType = requireRegisteredType(returnType, 'emval::as');
return returnType['toWireType'](null, handle);
},

_emval_as_uint64__deps: ['$Emval', '$requireRegisteredType'],
_emval_as_uint64: (handle, returnType) => {
handle = Emval.toValue(handle);
returnType = requireRegisteredType(returnType, 'emval::as');
return returnType['toWireType'](null, handle);
},

_emval_equals__deps: ['$Emval'],
_emval_equals: (first, second) => {
first = Emval.toValue(first);
Expand Down Expand Up @@ -264,13 +236,6 @@ var LibraryEmVal = {
return !object;
},

_emval_call__deps: ['$emval_methodCallers', '$Emval'],
_emval_call: (caller, handle, destructorsRef, args) => {
caller = emval_methodCallers[caller];
handle = Emval.toValue(handle);
return caller(null, handle, destructorsRef, args);
},

$emval_lookupTypes__deps: ['$requireRegisteredType'],
$emval_lookupTypes: (argCount, argTypes) => {
var a = new Array(argCount);
Expand All @@ -292,11 +257,12 @@ var LibraryEmVal = {
return id;
},

_emval_get_method_caller__deps: [
_emval_create_invoker__deps: [
'$emval_addMethodCaller', '$emval_lookupTypes',
'$createNamedFunction', '$emval_returnValue',
'$Emval', '$getStringOrSymbol',
],
_emval_get_method_caller: (argCount, argTypes, kind) => {
_emval_create_invoker: (argCount, argTypes, kind) => {
var GenericWireTypeSize = {{{ 2 * POINTER_SIZE }}};

var types = emval_lookupTypes(argCount, argTypes);
Expand All @@ -305,26 +271,38 @@ var LibraryEmVal = {

#if !DYNAMIC_EXECUTION
var argN = new Array(argCount);
var invokerFunction = (obj, func, destructorsRef, args) => {
var invokerFunction = (handle, methodName, destructorsRef, args) => {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Would it make more sense to call the first argument receiver? Or is handle (the type of the receiver I guess?) more descriptive here?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

handle as in generally EM_VAL. If the invoker kind is "method" then it's a handle of the receiver, if it's a "function" or a "constructor" then it's a handle of the function itself, and if it's a cast, then it's just null... A handle seemed like the most generic name.

var offset = 0;
for (var i = 0; i < argCount; ++i) {
argN[i] = types[i]['readValueFromPointer'](args + offset);
offset += GenericWireTypeSize;
}
var rv = kind === /* CONSTRUCTOR */ 1 ? Reflect.construct(func, argN) : func.apply(obj, argN);
var rv;
switch (kind) {
case {{{ cDefs['internal::EM_INVOKER_KIND::FUNCTION'] }}}:
rv = Emval.toValue(handle).apply(null, argN);
break;
case {{{ cDefs['internal::EM_INVOKER_KIND::CONSTRUCTOR'] }}}:
rv = Reflect.construct(Emval.toValue(handle), argN);
break;
case {{{ cDefs['internal::EM_INVOKER_KIND::CAST'] }}}:
// no-op, just return the argument
rv = argN[0];
break;
case {{{ cDefs['internal::EM_INVOKER_KIND::METHOD'] }}}:
rv = Emval.toValue(handle)[getStringOrSymbol(methodName)](...argN);
break;
}
return emval_returnValue(retType, destructorsRef, rv);
};
#else
var functionBody =
`return function (obj, func, destructorsRef, args) {\n`;
`return function (handle, methodName, destructorsRef, args) {\n`;

var offset = 0;
var argsList = []; // 'obj?, arg0, arg1, arg2, ... , argN'
if (kind === {{{ cDefs['internal::EM_METHOD_CALLER_KIND::FUNCTION'] }}}) {
argsList.push('obj');
}
var params = ['retType'];
var args = [retType];
var argsList = []; // 'arg0, arg1, arg2, ... , argN'
var params = ['toValue', 'retType'];
var args = [Emval.toValue, retType];
for (var i = 0; i < argCount; ++i) {
argsList.push(`arg${i}`);
params.push(`argType${i}`);
Expand All @@ -333,7 +311,23 @@ var LibraryEmVal = {
` var arg${i} = argType${i}.readValueFromPointer(args${offset ? '+' + offset : ''});\n`;
offset += GenericWireTypeSize;
}
var invoker = kind === {{{ cDefs['internal::EM_METHOD_CALLER_KIND::CONSTRUCTOR'] }}} ? 'new func' : 'func.call';
var invoker;
switch (kind){
case {{{ cDefs['internal::EM_INVOKER_KIND::FUNCTION'] }}}:
invoker = 'toValue(handle)';
break;
case {{{ cDefs['internal::EM_INVOKER_KIND::CONSTRUCTOR'] }}}:
invoker = 'new (toValue(handle))';
break;
case {{{ cDefs['internal::EM_INVOKER_KIND::CAST'] }}}:
invoker = '';
break;
case {{{ cDefs['internal::EM_INVOKER_KIND::METHOD'] }}}:
params.push('getStringOrSymbol');
args.push(getStringOrSymbol);
invoker = 'toValue(handle)[getStringOrSymbol(methodName)]';
break;
}
functionBody +=
` var rv = ${invoker}(${argsList.join(', ')});\n`;
if (!retType.isVoid) {
Expand All @@ -351,14 +345,16 @@ var LibraryEmVal = {
return emval_addMethodCaller(createNamedFunction(functionName, invokerFunction));
},

_emval_call_method__deps: ['$getStringOrSymbol', '$emval_methodCallers', '$Emval'],
_emval_call_method: (caller, objHandle, methodName, destructorsRef, args) => {
caller = emval_methodCallers[caller];
objHandle = Emval.toValue(objHandle);
methodName = getStringOrSymbol(methodName);
return caller(objHandle, objHandle[methodName], destructorsRef, args);
_emval_invoke__deps: ['$getStringOrSymbol', '$emval_methodCallers', '$Emval'],
_emval_invoke: (caller, handle, methodName, destructorsRef, args) => {
return emval_methodCallers[caller](handle, methodName, destructorsRef, args);
},

// Same as `_emval_invoke`, just imported into Wasm under a different return type.
// TODO: remove this if/when https://github.com/emscripten-core/emscripten/issues/20478 is fixed.
_emval_invoke_i64__deps: ['_emval_invoke'],
_emval_invoke_i64: '=__emval_invoke',

_emval_typeof__deps: ['$Emval'],
_emval_typeof: (handle) => {
handle = Emval.toValue(handle);
Expand Down
10 changes: 3 additions & 7 deletions src/lib/libsigs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -335,26 +335,23 @@ sigs = {
_emscripten_thread_mailbox_await__sig: 'vp',
_emscripten_thread_set_strongref__sig: 'vp',
_emscripten_throw_longjmp__sig: 'v',
_emval_as__sig: 'dppp',
_emval_as_int64__sig: 'jpp',
_emval_as_uint64__sig: 'jpp',
_emval_await__sig: 'pp',
_emval_call__sig: 'dpppp',
_emval_call_method__sig: 'dppppp',
_emval_coro_make_promise__sig: 'ppp',
_emval_coro_suspend__sig: 'vpp',
_emval_create_invoker__sig: 'pipi',
_emval_decref__sig: 'vp',
_emval_delete__sig: 'ipp',
_emval_equals__sig: 'ipp',
_emval_from_current_cxa_exception__sig: 'p',
_emval_get_global__sig: 'pp',
_emval_get_method_caller__sig: 'pipi',
_emval_get_module_property__sig: 'pp',
_emval_get_property__sig: 'ppp',
_emval_greater_than__sig: 'ipp',
_emval_in__sig: 'ipp',
_emval_incref__sig: 'vp',
_emval_instanceof__sig: 'ipp',
_emval_invoke__sig: 'dppppp',
_emval_invoke_i64__sig: 'jppppp',
_emval_is_number__sig: 'ip',
_emval_is_string__sig: 'ip',
_emval_iter_begin__sig: 'pp',
Expand All @@ -371,7 +368,6 @@ sigs = {
_emval_run_destructors__sig: 'vp',
_emval_set_property__sig: 'vppp',
_emval_strictly_equals__sig: 'ipp',
_emval_take_value__sig: 'ppp',
_emval_throw__sig: 'ip',
_emval_typeof__sig: 'pp',
_gmtime_js__sig: 'vjp',
Expand Down
6 changes: 4 additions & 2 deletions src/struct_info_cxx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,10 @@
{
"file": "emscripten/val.h",
"defines": [
"emscripten::internal::EM_METHOD_CALLER_KIND::FUNCTION",
"emscripten::internal::EM_METHOD_CALLER_KIND::CONSTRUCTOR"
"emscripten::internal::EM_INVOKER_KIND::FUNCTION",
"emscripten::internal::EM_INVOKER_KIND::METHOD",
"emscripten::internal::EM_INVOKER_KIND::CONSTRUCTOR",
"emscripten::internal::EM_INVOKER_KIND::CAST"
]
}
]
6 changes: 4 additions & 2 deletions src/struct_info_generated.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -516,8 +516,10 @@
"__WASI_RIGHTS_PATH_UNLINK_FILE": 67108864,
"__WASI_RIGHTS_POLL_FD_READWRITE": 134217728,
"__WASI_RIGHTS_SOCK_SHUTDOWN": 268435456,
"internal::EM_METHOD_CALLER_KIND::CONSTRUCTOR": 1,
"internal::EM_METHOD_CALLER_KIND::FUNCTION": 0
"internal::EM_INVOKER_KIND::CAST": 3,
"internal::EM_INVOKER_KIND::CONSTRUCTOR": 2,
"internal::EM_INVOKER_KIND::FUNCTION": 0,
"internal::EM_INVOKER_KIND::METHOD": 1
},
"structs": {
"AudioParamFrame": {
Expand Down
6 changes: 4 additions & 2 deletions src/struct_info_generated_wasm64.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -516,8 +516,10 @@
"__WASI_RIGHTS_PATH_UNLINK_FILE": 67108864,
"__WASI_RIGHTS_POLL_FD_READWRITE": 134217728,
"__WASI_RIGHTS_SOCK_SHUTDOWN": 268435456,
"internal::EM_METHOD_CALLER_KIND::CONSTRUCTOR": 1,
"internal::EM_METHOD_CALLER_KIND::FUNCTION": 0
"internal::EM_INVOKER_KIND::CAST": 3,
"internal::EM_INVOKER_KIND::CONSTRUCTOR": 2,
"internal::EM_INVOKER_KIND::FUNCTION": 0,
"internal::EM_INVOKER_KIND::METHOD": 1
},
"structs": {
"AudioParamFrame": {
Expand Down
Loading