Merge branch 'main' into wasm64-pthreads

Author: dakenf

.github/workflows/scorecards.yml

@@ -52,6 +52,6 @@ jobs:
 
       # Upload the results to GitHub's code scanning dashboard.
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@6c089f53dd51dc3fc7e599c3cb5356453a52ca9e # v2.20.0
+        uses: github/codeql-action/upload-sarif@a09933a12a80f87b87005513f0abb1494c27a716 # v2.21.4
         with:
           sarif_file: results.sarif

ChangeLog.md

@@ -20,6 +20,10 @@ See docs/process.md for more on how version tagging works.
 
 3.1.45 (in development)
 -----------------------
+- The function used to add symbols the JS library has been renamed from
+  `mergeInto`, to the more specific `addToLibrary`.  This new function does not
+  require the passing of `LibraryManager.library` as a first argument.  The old
+  `mergeInto` continues to exist for backwards compat.
 
 3.1.44 - 07/25/23
 -----------------

docs/emcc.txt

@@ -408,8 +408,9 @@ Options that are modified or new in *emcc* are listed below:
 "--embind-emit-tsd <path>"
    [link] Generate a TypeScript definition file from the exported
    embind bindings. The program will be instrumented and run in node
-   in order to to generate the file. Note: the program will need to be
-   rebuilt without this flag to be executed normally.
+   in order to to generate the file. Note that the program itself will
+   not be generated when this flag is used.  You will need to be
+   rebuild without this flag to build the program itself.
 
 "--ignore-dynamic-linking"
    [link] Tells the compiler to ignore dynamic linking (the user will

emcc.py

@@ -250,6 +250,7 @@ class EmccOptions:
   def __init__(self):
     self.target = ''
     self.output_file = None
+    self.no_minify = False
     self.post_link = False
     self.executable = False
     self.compiler_wrapper = None
@@ -1844,6 +1845,13 @@ def phase_linker_setup(options, state, newargs):
     logger.warning('disabling source maps because a js transform is being done')
     settings.GENERATE_SOURCE_MAP = 0
 
+  if options.embind_emit_tsd:
+    # Ignore any -o command line arguments when running in --embind-emit-tsd
+    # With this option we don't actually output the program itself only the
+    # TS bindings.
+    options.output_file = in_temp('a.out.js')
+    settings.INVOKE_RUN = False
+
   # options.output_file is the user-specified one, target is what we will generate
   if options.output_file:
     target = options.output_file
@@ -2946,7 +2954,7 @@ def get_full_import_name(name):
   settings.PRE_JS_FILES = [os.path.abspath(f) for f in options.pre_js]
   settings.POST_JS_FILES = [os.path.abspath(f) for f in options.post_js]
 
-  settings.MINIFY_WHITESPACE = settings.OPT_LEVEL >= 2 and settings.DEBUG_LEVEL == 0
+  settings.MINIFY_WHITESPACE = settings.OPT_LEVEL >= 2 and settings.DEBUG_LEVEL == 0 and not options.no_minify
 
   return target, wasm_target
 
@@ -3444,7 +3452,7 @@ def consume_arg_file():
       arg = consume_arg()
       if arg != '0':
         exit_with_error('0 is the only supported option for --minify; 1 has been deprecated')
-      settings.DEBUG_LEVEL = max(1, settings.DEBUG_LEVEL)
+      options.no_minify = True
     elif arg.startswith('-g'):
       options.requested_debug = arg
       requested_level = removeprefix(arg, '-g') or '3'
@@ -3525,7 +3533,6 @@ def consume_arg_file():
       options.source_map_base = consume_arg()
     elif check_arg('--embind-emit-tsd'):
       options.embind_emit_tsd = consume_arg()
-      settings.INVOKE_RUN = False
     elif check_flag('--no-entry'):
       options.no_entry = True
     elif check_arg('--js-library'):

site/source/docs/getting_started/downloads.rst

@@ -52,7 +52,7 @@ GitHub and set them as :term:`active <Active Tool/SDK>`:
     # Activate PATH and other environment variables in the current terminal
     source ./emsdk_env.sh
 
-  .. note:: On Windows, run ``emsdk`` instead of ``./emsdk``, and ``emsdk_env.bat`` instead of ``source ./emsdk_env.sh``.
+  .. note:: On Windows, run ``emsdk.bat`` instead of ``./emsdk``, and ``emsdk_env.bat`` instead of ``source ./emsdk_env.sh``.
 
   .. note:: On Windows, if you use the ``activate`` command, the step of ``emsdk_env.bat`` is optional. If you want to know more, see :ref:`activate SDK version <emsdk-set-active-tools>`.
 

site/source/docs/optimizing/Module-Splitting.rst

@@ -222,7 +222,7 @@ Multithreaded Programs
 
 By default, the data gathered by the wasm-split instrumentation is stored in
 Wasm globals, so it is thread local. But in a multithreaded program, it is
-important to collect profile information from all threads. To do so, you can can
+important to collect profile information from all threads. To do so, you can
 tell wasm-split to collect shared profile information in shared memory using the
 ``--in-memory`` wasm-split flag. This will use memory starting at address zero
 to store the profile information, so you must also pass ``-sGLOBAL_BASE=N`` to

site/source/docs/porting/connecting_cpp_and_javascript/Interacting-with-code.rst

@@ -412,15 +412,15 @@ If you add it to your own file, you should write something like
 
 .. code-block:: javascript
 
-   mergeInto(LibraryManager.library, {
+   addToLibrary({
      my_js: function() {
        alert('hi');
      },
    });
 
-``mergeInto`` just copies the properties on the second parameter onto the
-first, so this add ``my_js`` onto ``LibraryManager.library``, the global
-object where all JavaScript library code should be.
+``addToLibrary`` copies the properties of the input object into
+``LibraryManager.library`` (the global object where all JavaScript library code
+lives). In this case its adds a function called ``my_js`` onto this object.
 
 JavaScript limits in library files
 ----------------------------------
@@ -438,7 +438,7 @@ that you can't use a closure directly, for example, as ``toString``
 isn't compatible with that - just like when using a string to create
 a Web Worker, where you also can't pass a closure. (Note that this
 limitation is just for the values for the keys of the object
-passes to ``mergeInto`` in the JS library, that is, the toplevel
+passes to ``addToLibrary`` in the JS library, that is, the toplevel
 key-value pairs are special. Interior code inside a function can
 have arbitrary JS, of course).
 
@@ -453,7 +453,7 @@ initialization.
 
 .. code-block:: javascript
 
-   mergeInto(LibraryManager.library, {
+   addToLibrary({
 
      // Solution for bind or referencing other functions directly
      good_02__postset: '_good_02();',
@@ -511,7 +511,7 @@ various methods to the functions we actually want.
 
 .. code-block:: javascript
 
-  mergeInto(LibraryManager.library, {
+  addToLibrary({
     $method_support: {},
     $method_support__postset: [
       '(function() {                                  ',
@@ -554,7 +554,7 @@ a function,
 
 .. code-block:: javascript
 
-  mergeInto(LibraryManager.library, {
+  addToLibrary({
     $method_support__postset: 'method_support();',
     $method_support: function() {
       var SomeLib = function() {
@@ -601,7 +601,7 @@ See the `library_*.js`_ files for other examples.
      This is useful when all the implemented methods use a JavaScript
      singleton containing helper methods. See ``library_webgl.js`` for
      an example.
-   - The keys passed into `mergeInto` generate functions that are prefixed
+   - The keys passed into `addToLibrary` generate functions that are prefixed
      by ``_``. In other words ``my_func: function() {},`` becomes
      ``function _my_func() {}``, as all C methods in emscripten have a ``_`` prefix. Keys starting with ``$`` have the ``$``
      stripped and no underscore added.

site/source/docs/tools_reference/emcc.rst

@@ -386,7 +386,11 @@ Options that are modified or new in *emcc* are listed below:
 
 ``--embind-emit-tsd <path>``
   [link]
-  Generate a TypeScript definition file from the exported embind bindings. The program will be instrumented and run in node in order to to generate the file. Note: the program will need to be rebuilt without this flag to be executed normally.
+  Generate a TypeScript definition file from the exported embind bindings. The
+  program will be instrumented and run in node in order to to generate the file.
+  Note that the program itself will not be generated when this flag is
+  used.  You will need to be rebuild without this flag to build the program
+  itself.
 
 ``--ignore-dynamic-linking``
   [link]

src/audio_worklet.js

@@ -49,22 +49,22 @@ function createWasmAudioWorkletProcessor(audioParams) {
         didProduceAudio, paramArray;
 
       // Calculate how much stack space is needed.
-      for(i of inputList) stackMemoryNeeded += i.length * 512;
-      for(i of outputList) stackMemoryNeeded += i.length * 512;
-      for(i in parameters) stackMemoryNeeded += parameters[i].byteLength + 8, ++numParams;
+      for (i of inputList) stackMemoryNeeded += i.length * 512;
+      for (i of outputList) stackMemoryNeeded += i.length * 512;
+      for (i in parameters) stackMemoryNeeded += parameters[i].byteLength + 8, ++numParams;
 
       // Allocate the necessary stack space.
       inputsPtr = stackAlloc(stackMemoryNeeded);
 
       // Copy input audio descriptor structs and data to Wasm
       k = inputsPtr >> 2;
       dataPtr = inputsPtr + numInputs * 8;
-      for(i of inputList) {
+      for (i of inputList) {
         // Write the AudioSampleFrame struct instance
         HEAPU32[k++] = i.length;
         HEAPU32[k++] = dataPtr;
         // Marshal the input audio sample data for each audio channel of this input
-        for(j of i) {
+        for (j of i) {
           HEAPF32.set(j, dataPtr>>2);
           dataPtr += 512;
         }
@@ -74,7 +74,7 @@ function createWasmAudioWorkletProcessor(audioParams) {
       outputsPtr = dataPtr;
       k = outputsPtr >> 2;
       outputDataPtr = (dataPtr += numOutputs * 8) >> 2;
-      for(i of outputList) {
+      for (i of outputList) {
         // Write the AudioSampleFrame struct instance
         HEAPU32[k++] = i.length;
         HEAPU32[k++] = dataPtr;
@@ -86,7 +86,7 @@ function createWasmAudioWorkletProcessor(audioParams) {
       paramsPtr = dataPtr;
       k = paramsPtr >> 2;
       dataPtr += numParams * 8;
-      for(i = 0; paramArray = parameters[i++];) {
+      for (i = 0; paramArray = parameters[i++];) {
         // Write the AudioParamFrame struct instance
         HEAPU32[k++] = paramArray.length;
         HEAPU32[k++] = dataPtr;
@@ -100,9 +100,9 @@ function createWasmAudioWorkletProcessor(audioParams) {
         // Read back the produced audio data to all outputs and their channels.
         // (A garbage-free function TypedArray.copy(dstTypedArray, dstOffset, srcTypedArray, srcOffset, count) would sure be handy..
         //  but web does not have one, so manually copy all bytes in)
-        for(i of outputList) {
-          for(j of i) {
-            for(k = 0; k < 128; ++k) {
+        for (i of outputList) {
+          for (j of i) {
+            for (k = 0; k < 128; ++k) {
               j[k] = HEAPF32[outputDataPtr++];
             }
           }

src/base64Utils.js

@@ -14,7 +14,7 @@ function intArrayFromBase64(s) {
 #if ENVIRONMENT_MAY_BE_NODE
   if (typeof ENVIRONMENT_IS_NODE != 'undefined' && ENVIRONMENT_IS_NODE) {
     var buf = Buffer.from(s, 'base64');
-    return new Uint8Array(buf['buffer'], buf['byteOffset'], buf['byteLength']);
+    return new Uint8Array(buf.buffer, buf.byteOffset, buf.length);
   }
 #endif