Part two of dynCall removal

This change now passes flags to binaryen to limit the creation
of the dynCall functions and removes more internal use of the
legacy dynCall functions.

See #12002

Author: sbc100

emcc.py

@@ -1260,6 +1260,10 @@ def check(input_file):
     if shared.Settings.RELOCATABLE:
       shared.Settings.ALLOW_TABLE_GROWTH = 1
 
+    if shared.Settings.WASM2C or shared.Settings.ASYNCIFY or shared.Settings.EMBIND:
+      shared.Settings.USE_LEGACY_DYNCALLS = 1
+      shared.Settings.DEFAULT_LIBRARY_FUNCS_TO_INCLUDE += ['$getDynCallerBound']
+
     # Reconfigure the cache now that settings have been applied. Some settings
     # such as LTO and SIDE_MODULE/MAIN_MODULE effect which cache directory we use.
     shared.reconfigure_cache()
@@ -1515,7 +1519,7 @@ def check(input_file):
         'removeRunDependency',
       ]
 
-    if not shared.Settings.MINIMAL_RUNTIME or (shared.Settings.USE_PTHREADS or shared.Settings.EXIT_RUNTIME):
+    if not shared.Settings.MINIMAL_RUNTIME or shared.Settings.EXIT_RUNTIME:
       # MINIMAL_RUNTIME only needs callRuntimeCallbacks in certain cases, but the normal runtime
       # always does.
       shared.Settings.DEFAULT_LIBRARY_FUNCS_TO_INCLUDE += ['$callRuntimeCallbacks']
@@ -1524,10 +1528,7 @@ def check(input_file):
       # memalign is used to ensure allocated thread stacks are aligned.
       shared.Settings.EXPORTED_FUNCTIONS += ['_memalign', '_malloc']
 
-      # dynCall_ii is used to call pthread entry points in worker.js (as
-      # metadce does not consider worker.js, which is external, we must
-      # consider it a user export, i.e., one which can never be removed).
-      building.user_requested_exports += ['dynCall_ii']
+      shared.Settings.DEFAULT_LIBRARY_FUNCS_TO_INCLUDE += ['$dynCall']
 
       if shared.Settings.MINIMAL_RUNTIME:
         building.user_requested_exports += ['exit']

emscripten.py

@@ -549,6 +549,13 @@ def finalize_wasm(temp_files, infile, outfile, memfile, DEBUG):
     args.append('-g')
   if shared.Settings.WASM_BIGINT:
     args.append('--bigint')
+
+  if not shared.Settings.USE_LEGACY_DYNCALLS:
+    if shared.Settings.WASM_BIGINT:
+      args.append('--no-dyncalls')
+    else:
+      args.append('--dyncalls-i64')
+
   if shared.Settings.LEGALIZE_JS_FFI != 1:
     args.append('--no-legalize-javascript-ffi')
   if not shared.Settings.MEM_INIT_IN_WASM:

src/library.js

@@ -3867,12 +3867,12 @@ LibraryManager.library = {
 
   // libunwind
 
-  _Unwind_Backtrace__deps: ['emscripten_get_callstack_js'],
+  _Unwind_Backtrace__deps: ['emscripten_get_callstack_js', '$getDynCaller'],
   _Unwind_Backtrace: function(func, arg) {
     var trace = _emscripten_get_callstack_js();
     var parts = trace.split('\n');
     for (var i = 0; i < parts.length; i++) {
-      var ret = {{{ makeDynCall('iii') }}}(func, 0, arg);
+      var ret = {{{ makeDynCallBound('iii', 'func') }}}(0, arg);
       if (ret !== 0) return;
     }
   },
@@ -3918,10 +3918,11 @@ LibraryManager.library = {
 
   // special runtime support
 
+  emscripten_scan_stack__deps: ['$getDynCaller'],
   emscripten_scan_stack: function(func) {
     var base = STACK_BASE; // TODO verify this is right on pthreads
     var end = stackSave();
-    {{{ makeDynCall('vii') }}}(func, Math.min(base, end), Math.max(base, end));
+    {{{ makeDynCallBound('vii', 'func') }}}(Math.min(base, end), Math.max(base, end));
   },
 
   // misc definitions to avoid unnecessary unresolved symbols being reported
@@ -4004,6 +4005,57 @@ LibraryManager.library = {
     });
   },
 
+#if USE_LEGACY_DYNCALLS || !WASM_BIGINT
+  $dynCallLegacy: function(sig, ptr, args) {
+#if ASSERTIONS
+    assert(('dynCall_' + sig) in Module, 'bad function pointer type - no table for sig \'' + sig + '\'');
+    if (args && args.length) {
+      // j (64-bit integer) must be passed in as two numbers [low 32, high 32].
+      assert(args.length === sig.substring(1).replace(/j/g, '--').length);
+    } else {
+      assert(sig.length == 1);
+    }
+#endif
+    if (args && args.length) {
+      return Module['dynCall_' + sig].apply(null, [ptr].concat(args));
+    }
+    return Module['dynCall_' + sig].call(null, ptr);
+  },
+  $dynCall__deps: ['$dynCallLegacy'],
+#endif
+
+  $dynCall: function (sig, ptr, args) {
+#if USE_LEGACY_DYNCALLS
+    return dynCallLegacy(sig, ptr, args);
+#else
+#if !WASM_BIGINT
+    // Without WASM_BIGINT support we cannot directly call function with i64 as
+    // part of thier signature, so we rely the dynCall functions generated by
+    // wasm-emscripten-finalize
+    if (sig.indexOf('j') != -1) {
+      return dynCallLegacy(sig, ptr, args);
+    }
+#endif
+
+    return wasmTable.get(ptr).apply(null, args)
+#endif
+  },
+
+  $getDynCaller__deps: ['$dynCall'],
+  $getDynCaller: function(sig) {
+    return function(ptr) {
+      return dynCall(sig, ptr, Array.prototype.slice.call(arguments, 1));
+    };
+  },
+
+  $getDynCalleBoundr__deps: ['$dynCall'],
+  $getDynCallerBound: function(sig, ptr) {
+    return function() {
+      return dynCall(sig, ptr, Array.prototype.slice.call(arguments));
+    };
+  },
+
+  $callRuntimeCallbacks__deps: ['$dynCall'],
   $callRuntimeCallbacks: function(callbacks) {
     while(callbacks.length > 0) {
       var callback = callbacks.shift();
@@ -4014,9 +4066,9 @@ LibraryManager.library = {
       var func = callback.func;
       if (typeof func === 'number') {
         if (callback.arg === undefined) {
-          dynCall_v(func);
+          {{{ makeDynCallBound('v', 'func') }}}();
         } else {
-          dynCall_vi(func, callback.arg);
+          {{{ makeDynCallBound('vi', 'func') }}}(callback.arg);
         }
       } else {
         func(callback.arg === undefined ? null : callback.arg);

src/library_async.js

@@ -340,6 +340,7 @@ mergeInto(LibraryManager.library, {
     });
   },
 
+  emscripten_scan_registers__deps: ['$getDynCaller'],
   emscripten_scan_registers: function(func) {
     Asyncify.handleSleep(function(wakeUp) {
       // We must first unwind, so things are spilled to the stack. We
@@ -364,7 +365,7 @@ mergeInto(LibraryManager.library, {
     });
   },
 
-  $Fibers__deps: ['$Asyncify'],
+  $Fibers__deps: ['$Asyncify', '$getDynCaller'],
   $Fibers: {
     nextFiber: 0,
     trampolineRunning: false,

src/library_browser.js

@@ -831,7 +831,7 @@ var LibraryBrowser = {
     function doCallback(callback) {
       if (callback) {
         var stack = stackSave();
-        {{{ makeDynCall('vi') }}}(callback, allocate(intArrayFromString(_file), 'i8', ALLOC_STACK));
+        {{{ makeDynCallBound('vi', 'callback') }}}(allocate(intArrayFromString(_file), 'i8', ALLOC_STACK));
         stackRestore(stack);
       }
     }
@@ -861,7 +861,7 @@ var LibraryBrowser = {
 
   $funcWrappers: {},
 
-  $getFuncWrapper__deps: ['$funcWrappers'],
+  $getFuncWrapper__deps: ['$funcWrappers', '$dynCall'],
   $getFuncWrapper: function(func, sig) {
     if (!func) return; // on null pointer, return undefined
     assert(sig);
@@ -895,10 +895,10 @@ var LibraryBrowser = {
     Browser.asyncLoad(UTF8ToString(url), function(byteArray) {
       var buffer = _malloc(byteArray.length);
       HEAPU8.set(byteArray, buffer);
-      {{{ makeDynCall('viii') }}}(onload, arg, buffer, byteArray.length);
+      {{{ makeDynCallBound('viii', 'onload') }}}(arg, buffer, byteArray.length);
       _free(buffer);
     }, function() {
-      if (onerror) {{{ makeDynCall('vi') }}}(onerror, arg);
+      if (onerror) {{{ makeDynCallBound('vi', 'onerror') }}}(arg);
     }, true /* no need for run dependency, this is async but will not do any prepare etc. step */ );
   },
 
@@ -936,27 +936,27 @@ var LibraryBrowser = {
         FS.createDataFile( _file.substr(0, index), _file.substr(index + 1), new Uint8Array(/** @type{ArrayBuffer}*/(http.response)), true, true, false);
         if (onload) {
           var stack = stackSave();
-          {{{ makeDynCall('viii') }}}(onload, handle, arg, allocate(intArrayFromString(_file), 'i8', ALLOC_STACK));
+          {{{ makeDynCallBound('viii', 'onload') }}}(handle, arg, allocate(intArrayFromString(_file), 'i8', ALLOC_STACK));
           stackRestore(stack);
         }
       } else {
-        if (onerror) {{{ makeDynCall('viii') }}}(onerror, handle, arg, http.status);
+        if (onerror) {{{ makeDynCallBound('viii', 'onerror') }}}(handle, arg, http.status);
       }
 
       delete Browser.wgetRequests[handle];
     };
 
     // ERROR
     http.onerror = function http_onerror(e) {
-      if (onerror) {{{ makeDynCall('viii') }}}(onerror, handle, arg, http.status);
+      if (onerror) {{{ makeDynCallBound('viii', 'onerror') }}}(handle, arg, http.status);
       delete Browser.wgetRequests[handle];
     };
 
     // PROGRESS
     http.onprogress = function http_onprogress(e) {
       if (e.lengthComputable || (e.lengthComputable === undefined && e.total != 0)) {
         var percentComplete = (e.loaded / e.total)*100;
-        if (onprogress) {{{ makeDynCall('viii') }}}(onprogress, handle, arg, percentComplete);
+        if (onprogress) {{{ makeDynCallBound('viii', 'onprogress') }}}(handle, arg, percentComplete);
       }
     };
 
@@ -997,25 +997,25 @@ var LibraryBrowser = {
         var byteArray = new Uint8Array(/** @type{ArrayBuffer} */(http.response));
         var buffer = _malloc(byteArray.length);
         HEAPU8.set(byteArray, buffer);
-        if (onload) {{{ makeDynCall('viiii') }}}(onload, handle, arg, buffer, byteArray.length);
+        if (onload) {{{ makeDynCallBound('viiii', 'onload') }}}(handle, arg, buffer, byteArray.length);
         if (free) _free(buffer);
       } else {
-        if (onerror) {{{ makeDynCall('viiii') }}}(onerror, handle, arg, http.status, http.statusText);
+        if (onerror) {{{ makeDynCallBound('viiii', 'onerror') }}}(handle, arg, http.status, http.statusText);
       }
       delete Browser.wgetRequests[handle];
     };
 
     // ERROR
     http.onerror = function http_onerror(e) {
       if (onerror) {
-        {{{ makeDynCall('viiii') }}}(onerror, handle, arg, http.status, http.statusText);
+        {{{ makeDynCallBound('viiii', 'onerror') }}}(handle, arg, http.status, http.statusText);
       }
       delete Browser.wgetRequests[handle];
     };
 
     // PROGRESS
     http.onprogress = function http_onprogress(e) {
-      if (onprogress) {{{ makeDynCall('viiii') }}}(onprogress, handle, arg, e.loaded, e.lengthComputable || e.lengthComputable === undefined ? e.total : 0);
+      if (onprogress) {{{ makeDynCallBound('viiii', 'onprogress') }}}(handle, arg, e.loaded, e.lengthComputable || e.lengthComputable === undefined ? e.total : 0);
     };
 
     // ABORT
@@ -1059,10 +1059,10 @@ var LibraryBrowser = {
       PATH.basename(_file),
       new Uint8Array(data.object.contents), true, true,
       function() {
-        if (onload) {{{ makeDynCall('vi') }}}(onload, file);
+        if (onload) {{{ makeDynCallBound('vi', 'onload') }}}(file);
       },
       function() {
-        if (onerror) {{{ makeDynCall('vi') }}}(onerror, file);
+        if (onerror) {{{ makeDynCallBound('vi', 'onerror') }}}(file);
       },
       true // don'tCreateFile - it's already there
     );
@@ -1086,10 +1086,10 @@ var LibraryBrowser = {
       {{{ makeHEAPView('U8', 'data', 'data + size') }}},
       true, true,
       function() {
-        if (onload) {{{ makeDynCall('vii') }}}(onload, arg, cname);
+        if (onload) {{{ makeDynCallBound('vii', 'onload') }}}(arg, cname);
       },
       function() {
-        if (onerror) {{{ makeDynCall('vi') }}}(onerror, arg);
+        if (onerror) {{{ makeDynCallBound('vi', 'onerror') }}}(arg);
       },
       true // don'tCreateFile - it's already there
     );
@@ -1196,10 +1196,10 @@ var LibraryBrowser = {
     return 0;
   },
 
-  emscripten_set_main_loop__deps: ['$setMainLoop'],
+  emscripten_set_main_loop__deps: ['$setMainLoop', '$getDynCaller'],
   emscripten_set_main_loop__docs: '/** @param {number|boolean=} noSetTiming */',
   emscripten_set_main_loop: function(func, fps, simulateInfiniteLoop, arg, noSetTiming) {
-    var browserIterationFunc = function() { {{{ makeDynCall('v') }}}(func); };
+    var browserIterationFunc = function() { {{{ makeDynCallBound('v', 'func') }}}(); };
     setMainLoop(browserIterationFunc, fps, simulateInfiniteLoop, arg, noSetTiming);
   },
 
@@ -1334,7 +1334,7 @@ var LibraryBrowser = {
   // Runs natively in pthread, no __proxy needed.
   emscripten_set_main_loop_arg__deps: ['$setMainLoop'],
   emscripten_set_main_loop_arg: function(func, arg, fps, simulateInfiniteLoop) {
-    var browserIterationFunc = function() { {{{ makeDynCall('vi') }}}(func, arg); };
+    var browserIterationFunc = function() { {{{ makeDynCallBound('vi', 'func') }}}(arg); };
     setMainLoop(browserIterationFunc, fps, simulateInfiniteLoop, arg);
   },
 
@@ -1357,15 +1357,15 @@ var LibraryBrowser = {
   // Runs natively in pthread, no __proxy needed.
   _emscripten_push_main_loop_blocker: function(func, arg, name) {
     Browser.mainLoop.queue.push({ func: function() {
-      {{{ makeDynCall('vi') }}}(func, arg);
+      {{{ makeDynCallBound('vi', 'func') }}}(arg);
     }, name: UTF8ToString(name), counted: true });
     Browser.mainLoop.updateStatus();
   },
 
   // Runs natively in pthread, no __proxy needed.
   _emscripten_push_uncounted_main_loop_blocker: function(func, arg, name) {
     Browser.mainLoop.queue.push({ func: function() {
-      {{{ makeDynCall('vi') }}}(func, arg);
+      {{{ makeDynCallBound('vi', 'func') }}}(arg);
     }, name: UTF8ToString(name), counted: false });
     Browser.mainLoop.updateStatus();
   },
@@ -1382,7 +1382,7 @@ var LibraryBrowser = {
     noExitRuntime = true;
 
     function wrapper() {
-      {{{ makeDynCall('vi') }}}(func, arg);
+      {{{ makeDynCallBound('vi', 'func') }}}(arg);
     }
 
     if (millis >= 0) {

src/library_exceptions.js

@@ -179,7 +179,7 @@ var LibraryExceptions = {
     info.add_ref();
   },
 
-  $exception_decRef__deps: ['__cxa_free_exception'
+  $exception_decRef__deps: ['__cxa_free_exception', '$getDynCaller',
 #if EXCEPTION_DEBUG
     , '$exceptionLast', '$exceptionCaught'
 #endif
@@ -195,7 +195,7 @@ var LibraryExceptions = {
       var destructor = info.get_destructor();
       if (destructor) {
         // In Wasm, destructors return 'this' as in ARM
-        {{{ makeDynCall('ii') }}}(destructor, info.excPtr);
+        {{{ makeDynCallBound('ii', 'destructor') }}}(info.excPtr);
       }
       ___cxa_free_exception(info.excPtr);
 #if EXCEPTION_DEBUG