Merge branch 'main'

Author: kleisauke

.circleci/config.yml

@@ -22,6 +22,7 @@ ignorePatterns:
   - "src/emrun_postjs.js"
   - "src/worker.js"
   - "src/wasm_worker.js"
+  - "src/audio_worklet.js"
   - "src/wasm2js.js"
   - "src/webGLClient.js"
   - "src/webGLWorker.js"
@@ -30,7 +31,6 @@ ignorePatterns:
   - "src/threadprofiler.js"
   - "src/cpuprofiler.js"
   - "src/memoryprofiler.js"
-  - "src/support.js"
   - "src/gl-matrix.js"
   - "src/headless.js"
   - "src/headlessCanvas.js"

.eslintrc.yml

@@ -1,3 +1,6 @@
 [submodule "test/third_party/posixtestsuite"]
 	path = test/third_party/posixtestsuite
 	url = https://github.com/emscripten-core/posixtestsuite
+[submodule "test/third_party/googletest"]
+	path = test/third_party/googletest
+	url = https://github.com/google/googletest

.gitmodules

@@ -18,8 +18,109 @@ to browse the changes between the tags.
 
 See docs/process.md for more on how version tagging works.
 
-3.1.29 (in development)
+3.1.35 (in development)
 -----------------------
+- `SDL_image` port was updated to version 2.6.0.
+- `-z` arguments are now passed directly to wasm-ld without the need for the
+  `-Wl,` prefix.  This matches the behaviour of both clang and gcc. (#18956)
+- Reverted #18525 which runs the JS pre-processor over files passed via
+  --pre-js and --post-js.  It turned out this change caused issue for several
+  folks who had JS files with lines that start with `#` so can't be run through
+  the pre-processor.  If folks want to re-enable this we can looks into ways to
+  make it conditional/optional.
+- The `{{{ cDefine('name') }}}` helper macro can now be simplified to just `{{{
+  cDefs.name }}}`.
+
+3.1.34 - 03/14/23
+-----------------
+- Fix for using `EM_JS` functions defined in other object files.  This was a bug
+  that was introduced when `LLD_REPORT_UNDEFINED` was enabled by default back in
+  3.1.28. (#18928)
+- The prefered way to enable pthread is now to just the the standard `-pthread`
+  flag.  The `-sUSE_PTHREADS` setting still works but is marked as legacy and
+  will generate a warning in `-sSTRICT` mode.
+- When targeting node, and using `-sMODULARIZE`, we no longer internally catch
+  unhandled promise rejections or exit status code. That is to say the,
+  `NODEJS_CATCH_REJECTION` and `NODEJS_CATCH_EXIT` are no longer compatible
+  with `-sMODULARIZE`.   
+
+3.1.33 - 03/08/23
+-----------------
+- Initial support for C++20 modules.  We have added a very simple test in form
+  of `other.test_cpp_module`. (#18915)
+- Removed `sys/sysctl.h` compatibility header.  We don't implement the function
+  it defines. (#18863)
+- Update SDL2_ttf port to 2.20.2 (#18804)
+- Update glfw header to 3.3.8 (#18826)
+- The `LLD_REPORT_UNDEFINED` setting has been removed.  It's now essentially
+  always enabled. (#18342)
+- Added `-sEXPORT_KEEPALIVE` to export symbols. When using
+  `MINIMAL_RUNTIME`, the option will be **disabled** by default.
+  This option simply exports the symbols on the module object, i.e.,
+  `Module['X'] = X;`
+- The WasmFS OPFS backend is now faster in browsers that implement
+  [`Atomics.waitAsync`](https://caniuse.com/mdn-javascript_builtins_atomics_waitasync).
+  (#18861)
+
+3.1.32 - 02/17/23
+-----------------
+- Added new linker option `-sEXCEPTION_STACK_TRACES` which will display a stack
+  trace when an uncaught exception occurs. This defaults to true when
+  `ASSERTIONS` is enabled. This option is mainly for the users who want only
+  exceptions' stack traces without turning `ASSERTIONS` on. (#18642 and #18535)
+- `SUPPORT_LONGJMP`'s default value now depends on the exception mode. If Wasm
+  EH (`-fwasm-exception`) is used, it defaults to `wasm`, and if Emscripten EH
+  (`-sDISABLE_EXCEPTION_CATCHING=0`) is used or no exception support is used, it
+  defaults to `emscripten`. Previously it always defaulted to `emscripten`, so
+  when a user specified `-fwasm-exceptions`, it resulted in Wasm EH + Emscripten
+  SjLj, the combination we do not intend to support for the long term.
+- Added support for Wasm-based AudioWorklets for realtime audio processing
+  (#16449)
+- Synchronous proxying functions in emscripten/proxying.h now return errors
+  instead of hanging forever when the worker thread dies before the proxied work
+  is finished.
+- The `emscripten_proxy_async_with_callback` API was replaced with a simpler
+  `emscripten_proxy_callback` API that takes a second callback to be called if
+  the worker thread dies before completing the proxied work.
+
+3.1.31 - 01/26/23
+-----------------
+- Symbols that were previously exported from native code, but only for internal
+  reasons, are no longer exported on the `Module` object by default.  For
+  example, previously if you were using `Module._malloc` but not explicitly
+  including `_malloc` in `EXPORTED_FUNCTIONS`, it might have been exported
+  anyway due to internal use of `malloc` within the JS library code. (#18564)
+- The `STACK_SIZE`, `STACK_ALIGN`, `POINTER_SIZE`, and `ASSERTIONS` JavaScript
+  globals were removed by default.  In debug builds a clear error is shown if
+  you try to use these. (#18503)
+- --pre-js and --post-js files are now fed through the JS preprocessor, just
+  like JS library files and the core runtime JS files.  This means they can
+  now contain #if/#else/#endif blocks and {{{ }}} macro blocks. (#18525)
+- `-sEXPORT_ALL` can now be used to export symbols on the `Module` object
+  when used with `-sMINIMAL_RUNTIME` and `-sMODULARIZE` together. (#17911)
+- The llvm version that emscripten uses was updated to 17.0.0 trunk.
+
+3.1.30 - 01/11/23
+-----------------
+- The default pthread stack size will now be set to match `-sSTACK_SIZE` by
+  default.  Set `DEFAULT_PTHREAD_STACK_SIZE` explicitly to override this.
+  (#18479)
+- The `buffer` JavaScript variable was removed.  This underlying buffer is
+  still accessible via `wasmMemory.buffer` or `HEAPXX.buffer`.  In debug builds,
+  a clear error is shown if you try to use it.  (#18454)
+- The SDLv1 header directory is no longer added to the include path by default.
+  This means if you include SDL headers without the explicit version in them
+  (e.g. `SDL_events.h`) you will now need to add `-sUSE_SDL` explicitly at
+  compile time.  If you include the SDL headers with the directory name included
+  (e.g. `SDL/SDL_events.h`) you will not be affected by this change. (#18443)
+- Significant improvements were made (in the version of LLVM associated with
+  this emsdk release) to the quality of DWARF debug info when building in
+  optimized mode. See https://reviews.llvm.org/D140373. Using the -O1 flag is
+  recommended if a program is too large or slow to debug with -O0 (although
+  -O0 is still better for debugging when feasible).
+
+3.1.29 - 01/03/23
+-----------------
 - Fixed bug in `PROXY_TO_PTHREAD` whereby certain async operations on the main
   thread would cause the whole program to exit, even when the proxied main
   function was still running. (#18372)
@@ -258,7 +359,7 @@ See docs/process.md for more on how version tagging works.
   However, they all still available by default due to a new setting called
   `LEGACY_RUNTIME` which is enabled by default.  When `LEGACY_RUNTIME` is
   disabled (which it may be in the future) these symbols would only be included
-  if there were explictly exported via `EXPORTED_RUNTIME_METHODS` or added to
+  if there were explicitly exported via `EXPORTED_RUNTIME_METHODS` or added to
   `DEFAULT_LIBRARY_FUNCS_TO_INCLUDE`.  `LEGACY_RUNTIME` is disabled by default
   in `STRICT` mode so this change only effects users of `STRICT` mode. (#17370,
   #17403)
@@ -354,7 +455,7 @@ See docs/process.md for more on how version tagging works.
   binaryen optimizations are limited due to DWARF information being requested.
   Several binaryen passed are not compatible with the preservation of DWARF
   information. (#16428)
-- Use normalized mouse wheel delta for GLFW 3 in `library_glfw.js`. This changes 
+- Use normalized mouse wheel delta for GLFW 3 in `library_glfw.js`. This changes
   the vertical scroll amount for GLFW 3. (#16480)
 - The emsdk binaries for macOS now require macOS 10.14 Mojave (or above).
   Prior versions of emsdk could run on 10.11 (or above), but supporting those
@@ -392,7 +493,7 @@ See docs/process.md for more on how version tagging works.
 3.1.5 - 02/17/2022
 ------------------
 - Emscripten no longer uses the `allocate()` runtime function.  For backwards
-  compatabiliy with external JS code we still include this function by default
+  compatibility with external JS code we still include this function by default
   but it will no longer be included in `-sSTRICT` mode.  Usages of this function
   are generally best replaced with `_malloc`, `stackAlloc` or `allocateUTF8`.
 
@@ -462,7 +563,7 @@ See docs/process.md for more on how version tagging works.
   For most users targeting the default set of browsers this is a code size win.
   For projects targeting older browsers (e.g. `-sMIN_CHROME_VERSION=10`),
   emscripten will now run closure compiler in `WHITESPACE_ONLY` mode in order to
-  traspile any ES6 down to ES5.  When this automatic transpilation is performed
+  transpile any ES6 down to ES5.  When this automatic transpilation is performed
   we generate a warning which can be disabled (using `-Wno-transpile`) or by
   explicitly opting in-to or out-of closure using `--closure=1` or
   `--closure=0`. (#15763).
@@ -539,7 +640,7 @@ See docs/process.md for more on how version tagging works.
   EM_WORKAROUND_PYTHON_BUG_34780 and EM_WORKAROUND_WIN7_BAD_ERRORLEVEL_BUG that
   can be enabled to work around a Windows Python issue
   https://bugs.python.org/issue34780 , and a Windows 7 exit code issue (#15146)
-- Support a new CMake propert `EMSCRIPTEN_SYSTEM_PROCESSOR` which can be used
+- Support a new CMake property `EMSCRIPTEN_SYSTEM_PROCESSOR` which can be used
   to override the default value of `CMAKE_SYSTEM_PROCESSOR` set by the
   toolchain file.
 - Remove support for the `EMIT_EMSCRIPTEN_METADATA` setting.  This setting has
@@ -700,7 +801,7 @@ See docs/process.md for more on how version tagging works.
   list of symbols can now use a simple one-symbol-per-line format.  This new
   format is much simpler and doesn't require commas between symbols, opening
   or closing braces, or any kind of escaping for special characters.
-- The WebAssembly linker (`wasm-ld`) now performes string tail merging on any
+- The WebAssembly linker (`wasm-ld`) now performs string tail merging on any
   static string data in your program.   This has long been part of the native
   ELF linker and should not be observable in well-behaved programs.  This
   behavior can be disabled by passing `-Wl,-O0`.
@@ -765,9 +866,9 @@ See docs/process.md for more on how version tagging works.
   list explicit `EXPORTED_FUNCTIONS`.  Also, users of `MAIN_MODULE=1` with
   dynamic linking (not dlopen) who list all side modules on the command line,
   should be able to switch to `MAIN_MODULE=2` and get a reduction in code size.
-- When building with `MAIN_MODULE` it is now possbile to warn or error on
+- When building with `MAIN_MODULE` it is now possible to warn or error on
   undefined symbols assuming all the side modules are passed at link time.  This
-  means that for many projects it should now be possbile to enable
+  means that for many projects it should now be possible to enable
   `ERROR_ON_UNDEFINED_SYMBOLS` along with `MAIN_MODULE`.
 
 2.0.17: 04/10/2021

ChangeLog.md

@@ -7,7 +7,8 @@
 # The implementation is based on the standard FindOpenAL.cmake provided with CMake,
 # but customized for targeting Emscripten only.
 
-if (NOT OPENAL_FOUND)
+if (NOT OpenAL_FOUND OR NOT OPENAL_FOUND)
+	SET(OpenAL_FOUND TRUE)
 	SET(OPENAL_FOUND TRUE)
 
 	# For Emscripten-compiled apps in the test suite (test_alut), this is expected...

cmake/Modules/FindOpenAL.cmake

@@ -87,14 +87,15 @@ else()
 endif()
 
 # Specify the compilers to use for C and C++
-set(CMAKE_C_COMPILER "${EMSCRIPTEN_ROOT_PATH}/emcc${EMCC_SUFFIX}" CACHE FILEPATH "Emscripten emcc")
-set(CMAKE_CXX_COMPILER "${EMSCRIPTEN_ROOT_PATH}/em++${EMCC_SUFFIX}" CACHE FILEPATH "Emscripten em++")
-set(CMAKE_AR "${EMSCRIPTEN_ROOT_PATH}/emar${EMCC_SUFFIX}" CACHE FILEPATH "Emscripten ar")
-set(CMAKE_RANLIB "${EMSCRIPTEN_ROOT_PATH}/emranlib${EMCC_SUFFIX}" CACHE FILEPATH "Emscripten ranlib")
-set(CMAKE_C_COMPILER_AR "${CMAKE_AR}" CACHE FILEPATH "Emscripten ar")
-set(CMAKE_CXX_COMPILER_AR "${CMAKE_AR}" CACHE FILEPATH "Emscripten ar")
-set(CMAKE_C_COMPILER_RANLIB "${CMAKE_RANLIB}" CACHE FILEPATH "Emscripten ranlib")
-set(CMAKE_CXX_COMPILER_RANLIB "${CMAKE_RANLIB}" CACHE FILEPATH "Emscripten ranlib")
+set(CMAKE_C_COMPILER "${EMSCRIPTEN_ROOT_PATH}/emcc${EMCC_SUFFIX}")
+set(CMAKE_CXX_COMPILER "${EMSCRIPTEN_ROOT_PATH}/em++${EMCC_SUFFIX}")
+set(CMAKE_NM "${EMSCRIPTEN_ROOT_PATH}/emnm${EMCC_SUFFIX}")
+set(CMAKE_AR "${EMSCRIPTEN_ROOT_PATH}/emar${EMCC_SUFFIX}")
+set(CMAKE_RANLIB "${EMSCRIPTEN_ROOT_PATH}/emranlib${EMCC_SUFFIX}")
+set(CMAKE_C_COMPILER_AR "${CMAKE_AR}")
+set(CMAKE_CXX_COMPILER_AR "${CMAKE_AR}")
+set(CMAKE_C_COMPILER_RANLIB "${CMAKE_RANLIB}")
+set(CMAKE_CXX_COMPILER_RANLIB "${CMAKE_RANLIB}")
 
 # Capture the Emscripten version to EMSCRIPTEN_VERSION variable.
 if (NOT EMSCRIPTEN_VERSION)

cmake/Modules/Platform/Emscripten.cmake

@@ -547,7 +547,7 @@ Options that are modified or new in *emcc* are listed below:
 "--threadprofiler"
    [link] Embeds a thread activity profiler onto the generated page.
    Use this to profile the application usage of pthreads when
-   targeting multithreaded builds (-sUSE_PTHREADS=1/2).
+   targeting multithreaded builds (-pthread).
 
 "--em-config <path>"
    [general] Specifies the location of the **.emscripten**

docs/emcc.txt

@@ -88,8 +88,8 @@ How:
    [emscripten-releases][releases_repo] repo. When this CL is committed, let the
    resulting SHA be `<LTO-sha>`. An example of this CL is
    https://chromium-review.googlesource.com/c/emscripten-releases/+/3781978.
-1. Run [`./scripts/create_release.py`][create_release] in the emsdk repository.
-   When we do both an LTO and a non-LTO release, run:
+1. Run [`scripts/create_release.py`][create_release_emsdk] in the emsdk
+   repository. When we do both an LTO and a non-LTO release, run:
    ```
    ./scripts/create_release.py <LTO-sha> <non-LTO-sha>
    ```
@@ -101,19 +101,21 @@ How:
    ```
    This will make the `<non-LTO-sha>` point directly to the versioned name
    release (e.g. `3.1.7`) and there will be no assert build release. If we run
-   [`./scripts/create_release.py`][create_release] without any arguments, it
+   [`scripts/create_release.py`][create_release_emsdk] without any arguments, it
    will automatically pick a tot version from
    [emscripten-releases][releases_repo] repo and make it point to the versioned
-   name release. Running this [`./scripts/create_release.py`][create_release]
-   script will update [emscripten-releases-tags.json][emscripten_releases_tags],
-   adding a new version. The script will create a new git branch that can be
-   uploaded as a PR. An example of this PR is emscripten-core/emsdk#1071.
+   name release. Running this
+   [`scripts/create_release.py`][create_release_emsdk] script will update
+   [emscripten-releases-tags.json][emscripten_releases_tags], adding a new
+   version. The script will create a new git branch that can be uploaded as a
+   PR. An example of this PR is emscripten-core/emsdk#1071.
 1. [Tag][emsdk_tags] the `emsdk` repo with the new version number, on the commit
    that does the update, after it lands on main.
 1. [Tag][emscripten_tags] the `emscripten` repo with the new version number, on
    the commit referred to in the [DEPS][DEPS] (or DEPS.tagged-release) file
    above.
-1. Run the `tools/maint/create_release.py` tool in the emscripten repo to update
+1. Run the [`tools/maint/create_release.py`][create_release_emscripten]
+   tool in the emscripten repo to update
    [`emscripten-version.txt`][emscripten_version] and
    [`ChangeLog.md`][changelog].  An example of such PR is
    emscripten-core/emscripten#17439.
@@ -147,9 +149,9 @@ How:
 The site is currently hosted in `gh-pages` branch of the separate [site
 repository][site_repo]. To update the docs, rebuild them and copy them into
 this repository.  There is a script that will perform these steps automatically:
-`tools/maint/update_docs.py`.  Just run this script with no arguments if the
-emscripten-site repository is checked out alongside emscripten itself, or pass
-the location of the checkout if not.
+[`tools/maint/update_docs.py`][update_docs].  Just run this script with no
+arguments if the emscripten-site repository is checked out alongside emscripten
+itself, or pass the location of the checkout if not.
 
 You will need the specific sphinx version installed, which you can do using
 `pip3 install -r requirements-dev.txt` (depending on your system, you may then
@@ -177,7 +179,8 @@ See notes above on installing sphinx.
 [waterfall]: https://ci.chromium.org/p/emscripten-releases/g/main/console
 [emscripten_version]: https://github.com/emscripten-core/emscripten/blob/main/emscripten-version.txt
 [changelog]: https://github.com/emscripten-core/emscripten/blob/main/ChangeLog.md
-[create_release]: https://github.com/emscripten-core/emsdk/blob/main/scripts/create_release.py
+[create_release_emsdk]: https://github.com/emscripten-core/emsdk/blob/main/scripts/create_release.py
+[create_release_emscripten]: https://github.com/emscripten-core/emscripten/blob/main/tools/maint/create_release.py
 [emscripten_releases_tags]: https://github.com/emscripten-core/emsdk/blob/main/emscripten-releases-tags.json
 [DEPS]: https://chromium.googlesource.com/emscripten-releases/+/refs/heads/main/DEPS
 [DEPS.tagged-release]: https://chromium.googlesource.com/emscripten-releases/+/refs/heads/main/DEPS.tagged-release
@@ -186,3 +189,4 @@ See notes above on installing sphinx.
 [clang-format]: https://github.com/emscripten-core/emscripten/blob/main/.clang-format
 [flake8]: https://github.com/emscripten-core/emscripten/blob/main/.flake8
 [mypy]: https://github.com/emscripten-core/emscripten/blob/main/.mypy
+[update_docs]: https://github.com/emscripten-core/emscripten/blob/main/tools/maint/update_docs.py