Merge branch 'main' into patch-1

Author: ifiddynine

.circleci/config.yml

@@ -1,7 +1,7 @@
 version: 2.1
 
 orbs:
-  win: circleci/windows@1.0.0
+  win: circleci/windows@5.0
 
 executors:
   linux-node:
@@ -414,6 +414,7 @@ jobs:
     steps:
       - checkout
       - pip-install
+      - run: tools/maint/update_settings_docs.py --check
       - run: make -C site text
       - run: tools/maint/check_emcc_help_text.py
       - run: make -C site html
@@ -807,6 +808,7 @@ jobs:
             browser64
             skip:browser64.test_4gb_fail
             browser64_4gb.test_async_*
+            browser64_4gb.test_audio_worklet*
             browser64_4gb.test_emscripten_log
             "
   test-browser-firefox:
@@ -827,8 +829,9 @@ jobs:
   # windows and mac do not have separate build and test jobs, as they only run
   # a limited set of tests; it is simpler and faster to do it all in one job.
   test-windows:
+    working_directory: "~/path with spaces"
     executor:
-      name: win/vs2019
+      name: win/server-2019
       shell: bash.exe -eo pipefail
     environment:
       PYTHONUNBUFFERED: "1"
@@ -848,7 +851,7 @@ jobs:
       - run:
           name: Install packages
           command: |
-            choco install cmake.portable ninja pkgconfiglite
+            choco install -y cmake.portable ninja pkgconfiglite
       - run:
           name: Add python to bash path
           command: echo "export PATH=\"$PATH:/c/Python27amd64/\"" >> $BASH_ENV
@@ -916,10 +919,6 @@ jobs:
       - install-emsdk
       # TODO: We can't currently do pip install here since numpy and other packages
       # are currently missing arm64 macos binaries.
-      # TODO: Remove this once emsdk has an arm64 version of node
-      - run:
-          name: Install Rosetta
-          command: /usr/sbin/softwareupdate --install-rosetta --agree-to-license
       - run-tests:
           title: "crossplatform tests"
           test_targets: "--crossplatform-only"

.flake8

@@ -1,6 +1,7 @@
 [flake8]
 ignore = E111,E114,E501,E261,E266,E121,E402,E241,W504,E741,B011,B023,U101
 exclude =
+ ./node_modules/, # third-party code
  ./third_party/, # third-party code
  ./tools/filelock.py, # third-party code
  ./tools/scons/, # third-party code
@@ -9,7 +10,7 @@ exclude =
  ./system/lib/, # system libraries
  ./cache/, # download/built content
  .git
-# The ports plugins have a lot of unused imports becuase
+# The ports plugins have a lot of unused imports because
 # they need to implement the specific plugin APIs
 per-file-ignores =
   ./tools/ports/*.py: U100

AUTHORS

@@ -596,3 +596,4 @@ a license to everyone to use it as detailed in LICENSE.)
 * 郑苏波 (Super Zheng) <[email protected]>
 * James Hu <[email protected]>
 * Jerry Zhuang <[email protected]>
+* Taisei Kon <[email protected]>

ChangeLog.md

@@ -18,13 +18,87 @@ to browse the changes between the tags.
 
 See docs/process.md for more on how version tagging works.
 
-3.1.51 (in development)
+3.1.53 (in development)
 -----------------------
+
+3.1.52 - 01/19/24
+-----------------
+- The core stack manipulation functions (`stackSave`, `stackRestore`,
+  `stackAlloc`) are no longer exported by default.  Users of these function
+  now need to depend on them explicitly (either via `__deps` attributes or via
+  `-sEXPORTED_FUNCTIONS`). (#21075)
+- Building with `pthreads+EXPORT_ES6` will now emit the worker file as
+  `NAME.worker.mjs` rather than `.js`. This is a necessary breaking change to
+  resolve other `pthreads+EXPORT_ES6` issues in Node.js (because Node.js is
+  affected by the suffix in some cases). (#21041)
+- Include paths added by ports (e.g. `-sUSE_SDL=2`) now use `-isystem` rather
+  then `-I`.  This means that files in user-specified include directories will
+  now take precedence over port includes. (#21014)
+- Certain settings that only apply when generating JavaScript output will now
+  trigger a warning if used when generating only Wasm.
+- Fix bug where `main` was mistakenly included in debug builds but not in
+  release builds. (#20971)
+- Remove JAVA from the list of `.emscripten` config file settings.  In the
+  past we used this to run the java version of closure compiler.  If there are
+  folks who prefer to use the java version of closure compiler for some reason
+  it should be possible by adding `--platform=java` to `--closure-args` or
+  `EMCC_CLOSURE_ARGS` but emscripten will no longer do this automatically.
+  (#20919)
+- The WORKAROUND_OLD_WEBGL_UNIFORM_UPLOAD_IGNORED_OFFSET_BUG setting was
+  removed.  This was a workaround from 2018 (#7459) that should no longer be
+  needed. (#20925)
+- The `--default-obj-ext` command line flag was removed. (#20917)
+- emcc will now treat `.bc` files as source files.  These means that will get
+  compiled by clang before being passed to the linker.  This matches the
+  behaviour of clang. (#20922)
+- Emscripten now only supports browsers going back to certain versions. The
+  current set of minimum versions are: Chrome 32, Firefox 34, Safari 9.
+  Attempting to targets version older this using, for example
+  `MIN_CHROME_VERSION` will now result in build-time error.  All of these
+  browser versions are at least 8 years old now so the hope is that nobody
+  is intending to target them today.  (#20924)
+- C++ objects passed into embind's val via constructors, methods, and call
+  function will not be automatically destroyed after the function call. This
+  makes the behavior consistent for invocations. 
+- The `SUPPORT_ERRNO` setting is now deprecated as it only controlled setting
+  errno from JS library functions and emscripten no longer requires this.
+  (#21074)
+
+3.1.51 - 12/13/23
+-----------------
+- Support for explicitly targeting the legacy Internet Explorer or EdgeHTML
+  (edge version prior to the chromium-based edge) browsers via
+  `-sMIN_EDGE_VERSION/-sMIN_IE_VERSION` was removed. (#20881)
+- Emscripten is now more strict about handling unsupported shared library
+  inputs.  For example, under the old behaviour if a system shared library
+  such as `/usr/lib/libz.so` was passed to emscripten it would silently re-write
+  this to `-lz`, which would then search this a libz in its own sysroot.  Now
+  this file is passed though the linker like any other input file and you will
+  see an `unknown file type` error from the linker (just like you would with the
+  native clang or gcc toolchains). (#20886)
+- Support for explicitly targeting the legacy EdgeHTML browser (edge version
+  prior to the chromium-based edge) via `-sMIN_EDGE_VERSION` was removed.
+  Using `-sLEGACY_VM_SUPPORT` should still work if anyone still wanted to target
+  this or any other legacy browser.
 - Breaking change: Using the `*glGetProcAddress()` family of functions now
   requires passing a linker flag -sGL_ENABLE_GET_PROC_ADDRESS. This prevents
   ports of native GL renderers from later accidentally attempting to activate
   "dormant" features if web browser implementations gain new WebGL extensions in
   the future, which `*glGetProcAddress()` is not able to support. (#20802)
+- Added Hi DPI support to GLFW. When enabled, GLFW automatically accounts for
+  the `devicePixelRatio` browser property and changes the size of the canvas
+  accordingly (including dynamically if the canvas is moved from a 4K screen to
+  a 2K screen and vice-versa). `glfwGetFramebufferSize` now properly returns the
+  canvas size in pixels, while `glfwGetWindowSize` returns the canvas size is
+  screen size. By default, this feature is disabled. You can enable it before
+  creating a window by calling `glfwWindowHint(GLFW_SCALE_TO_MONITOR,
+  GLFW_TRUE)`. You can also dynamically change it after the window has been
+  created by calling `glfwSetWindowAttrib(window, GLFW_SCALE_TO_MONITOR,
+  GLFW_TRUE)`. (#20584)
+- Transpilation to support older environments/browsers is now performed by babel
+  rather than closure compiler.  This means that folks targeting older browsers
+  (e.g. `-sLEGACY_VM_SUPPORT`) do not need to ensure their code is closure
+  compliant. (#20879)
 
 3.1.50 - 11/29/23
 -----------------
@@ -38,8 +112,8 @@ See docs/process.md for more on how version tagging works.
   the `DEFAULT_TO_CXX` setting now only applies when linking and not when
   compiling. (#20712)
 - JavaScript library code can now use the full range of ES6 features and we rely
-  on closure compiler to transpile for ES5 when targetting older browsers.
-  For those that would rather perform transpilation seperately outside of
+  on closure compiler to transpile for ES5 when targeting older browsers.
+  For those that would rather perform transpilation separately outside of
   emscripten you can use the `-sPOLYFILL=0` setting. (#20700)
 - libcxx, libcxxabi, libunwind, and compiler-rt were updated to LLVM 17.0.4.
   (#20705, #20707, and #20708)
@@ -71,7 +145,7 @@ See docs/process.md for more on how version tagging works.
   JavaScript code. (#20551)
 - A new top-level `bootstrap` script was added.  This script is for emscripten
   developers and helps take a care of post-checkout tasks such as `npm install`.
-  If this script needs to be run (e.g. becuase package.json was changed, emcc
+  If this script needs to be run (e.g. because package.json was changed, emcc
   will exit with an error. (#19736)
 - If exceptions are disabled, using `new` together with `std::nothrow` no
   longer aborts if the allocation fails. Instead `nullptr` is returned now.
@@ -115,7 +189,7 @@ See docs/process.md for more on how version tagging works.
 -----------------
 - The `wasmTable` global is now a JS library function that will only be included
   as needed.  Code that references `wasmTable` will no need to declare a
-  dependency on it.  It can also be explictly included using
+  dependency on it.  It can also be explicitly included using
   `-sEXPORTED_RUNTIME_METHODS=wasmTable`.
 - libunwind updated to LLVM 16.0.6. (#20088)
 - The `--minify=0` commnad line flag will now preserve comments as well as
@@ -132,7 +206,7 @@ See docs/process.md for more on how version tagging works.
 - The `USE_GLFW` settings now defaults to 0 rather than 2.  This matches other
   other settings such as `USE_SDL` that default to 0 these days and also matches
   the existing behaviour for `MINIMAL_RUNTIME` and `STRICT` mode.
-  If you use GLFW you now need to explictly opt into it using `-sUSE_GLFW` or
+  If you use GLFW you now need to explicitly opt into it using `-sUSE_GLFW` or
   `-lglfw`. (#19939)
 - A new settings `TABLE_BASE` was introduced that can be used to place static
   function addresses (table slots) at a certain offset.  This defaults to 1
@@ -182,7 +256,7 @@ See docs/process.md for more on how version tagging works.
   `-sMIN_NODE_VERSION=101900` which will apply the previous minimum version of
   10.19.0. (#19192).
 - The log message that emcc will sometime print (for example when auto-building
-  system libraries) can now be completely supressed by running with
+  system libraries) can now be completely suppressed by running with
   `EMCC_LOGGING=0`.
 - Runtime dynamic linking symbols such as dlopen and dlsym will no longer cause
   a linker error when building without `-sMAIN_MODULE`.  Instead stub functions
@@ -259,13 +333,13 @@ See docs/process.md for more on how version tagging works.
    - stringToUTF8
    - lengthBytesUTF8
   If you use any of these functions in your JS code you will now need to include
-  them explictly in one of the following ways:
+  them explicitly in one of the following ways:
    - Add them to a `__deps` entry in your JS library file (with leading $)
    - Add them to `DEFAULT_LIBRARY_FUNCS_TO_INCLUDE` (with leading $)
    - Add them to `EXPORTED_FUNCTIONS` (without leading $)
    - Set `-sLEGACY_RUNTIME` to include all of them at once.
 - `FS.loadFilesFromDB` and `FS.saveFilesToDB` were removed.  We think it's
-  unlikly there were any users of these functions since there is now a separate
+  unlikely there were any users of these functions since there is now a separate
   IDBFS filesystem for folks that want persistence. (#19049)
 - `allocateUTF8` and `allocateUTF8OnStack` library function moved to
   `library_legacy.js`.  Prefer the more accurately named `stringToNewUTF8` and
@@ -286,7 +360,7 @@ See docs/process.md for more on how version tagging works.
 - 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`
+- The preferred way to enable pthreads is now to just use 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

bootstrap.bat

@@ -22,7 +22,7 @@
 :: script is invoked via enclosing the invocation in quotes via PATH lookup, then %~f0 and
 :: %~dp0 expansions will not work.
 :: So first try if %~dp0 might work, and if not, manually look up this script from PATH.
-@if exist %~f0 (
+@if exist "%~f0" (
   set MYDIR=%~dp0
   goto FOUND_MYDIR
 )

bootstrap.py

@@ -20,24 +20,37 @@
 from tools import shared, utils
 
 actions = [
-  ('npm packages', 'package.json', [shutil.which('npm'), 'ci']),
-  # TODO(sbc): Remove the checked in entry point files and have them
-  # built on demand by this step.
-  ('create entry points', 'tools/maint/create_entry_points.py', [sys.executable, 'tools/maint/create_entry_points.py']),
-  ('git submodules', 'test/third_party/posixtestsuite/', [shutil.which('git'), 'submodule', 'update', '--init']),
+  ('npm packages', ['package.json'], [shutil.which('npm'), 'ci']),
+  ('create entry points', [
+     'tools/maint/create_entry_points.py',
+     'tools/maint/run_python.bat',
+     'tools/maint/run_python.sh',
+     'tools/maint/run_python.ps1',
+   ],
+   [sys.executable, 'tools/maint/create_entry_points.py']),
+  ('git submodules', ['test/third_party/posixtestsuite/'], [shutil.which('git'), 'submodule', 'update', '--init']),
 ]
 
 
 def get_stamp_file(action_name):
   return os.path.join(STAMP_DIR, action_name.replace(' ', '_') + '.stamp')
 
 
+def check_deps(name, deps):
+  stamp_file = get_stamp_file(name)
+  if not os.path.exists(stamp_file):
+    return False
+  for dep in deps:
+    dep = utils.path_from_root(dep)
+    if os.path.getmtime(dep) > os.path.getmtime(stamp_file):
+      return False
+  return True
+
+
 def check():
-  for name, filename, _ in actions:
-    stamp_file = get_stamp_file(name)
-    filename = utils.path_from_root(filename)
-    if not os.path.exists(stamp_file) or os.path.getmtime(filename) > os.path.getmtime(stamp_file):
-      utils.exit_with_error(f'emscripten setup is not complete ("{name}" is out-of-date). Run bootstrap.py to update')
+  for name, deps, _ in actions:
+    if not check_deps(name, deps):
+      utils.exit_with_error(f'emscripten setup is not complete ("{name}" is out-of-date). Run `bootstrap` to update')
 
 
 def main(args):
@@ -46,13 +59,12 @@ def main(args):
   parser.add_argument('-n', '--dry-run', action='store_true', help='dry run', default=False)
   args = parser.parse_args()
 
-  for name, filename, cmd in actions:
-    stamp_file = get_stamp_file(name)
-    filename = utils.path_from_root(filename)
-    if os.path.exists(stamp_file) and os.path.getmtime(filename) <= os.path.getmtime(stamp_file):
+  for name, deps, cmd in actions:
+    if check_deps(name, deps):
       print('Up-to-date: %s' % name)
       continue
     print('Out-of-date: %s' % name)
+    stamp_file = get_stamp_file(name)
     if args.dry_run:
       print(' (skipping: dry run) -> %s' % ' '.join(cmd))
       return

cmake/Modules/Platform/Emscripten.cmake

@@ -6,7 +6,7 @@
 # line parameters:
 # cmake -DCMAKE_TOOLCHAIN_FILE=<EmscriptenRoot>/cmake/Modules/Platform/Emscripten.cmake
 #       -DCMAKE_BUILD_TYPE=<Debug|RelWithDebInfo|Release|MinSizeRel>
-#       -G "Unix Makefiles" (Linux and OSX)
+#       -G "Unix Makefiles" (Linux and macOS)
 #       -G "MinGW Makefiles" (Windows)
 #       <path/to/CMakeLists.txt> # Note, pass in here ONLY the path to the file, not the filename 'CMakeLists.txt' itself.
 
@@ -354,35 +354,6 @@ function(em_link_post_js target)
   em_add_link_deps(${target} "--post-js" ${ARGN})
 endfunction()
 
-# Experimental support for targeting generation of Visual Studio project files
-# (vs-tool) of Emscripten projects for Windows.  To use this, pass the
-# combination -G "Visual Studio 10" -DCMAKE_TOOLCHAIN_FILE=Emscripten.cmake
-if ("${CMAKE_GENERATOR}" MATCHES "^Visual Studio.*")
-  # By default, CMake generates VS project files with a
-  # <GenerateManifest>true</GenerateManifest> directive.
-  # This causes VS to attempt to invoke rc.exe during the build, which will fail
-  # since app manifests are meaningless for Emscripten.  To disable this, add
-  # the following linker flag. This flag will not go to emcc, since the Visual
-  # Studio CMake generator will swallow it.
-  set(EMSCRIPTEN_VS_LINKER_FLAGS "/MANIFEST:NO")
-  # CMake is hardcoded to write a ClCompile directive
-  # <ObjectFileName>$(IntDir)</ObjectFileName> in all VS project files it
-  # generates.  This makes VS pass emcc a -o param that points to a directory
-  # instead of a file, which causes emcc autogenerate the output filename.
-  # CMake is hardcoded to assume all object files have the suffix .obj, so
-  # adjust the emcc-autogenerated default suffix name to match.
-  set(EMSCRIPTEN_VS_LINKER_FLAGS "${EMSCRIPTEN_VS_LINKER_FLAGS} --default-obj-ext .obj")
-  # Also hint CMake that it should not hardcode <ObjectFileName> generation.
-  # Requires a custom CMake build for this to work (ignored on others)
-  # See http://www.cmake.org/Bug/view.php?id=14673 and https://github.com/juj/CMake
-  set(CMAKE_VS_NO_DEFAULT_OBJECTFILENAME 1)
-
-  # Apply and cache Emscripten Visual Studio IDE-specific linker flags.
-  set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} ${EMSCRIPTEN_VS_LINKER_FLAGS}" CACHE STRING "")
-  set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} ${EMSCRIPTEN_VS_LINKER_FLAGS}" CACHE STRING "")
-  set(CMAKE_MODULE_LINKER_FLAGS "${CMAKE_MODULE_LINKER_FLAGS} ${EMSCRIPTEN_VS_LINKER_FLAGS}" CACHE STRING "")
-endif()
-
 if (NOT DEFINED CMAKE_CROSSCOMPILING_EMULATOR)
   find_program(NODE_JS_EXECUTABLE NAMES nodejs node)
   if(NODE_JS_EXECUTABLE)

docs/emcc.txt

@@ -268,10 +268,6 @@ Options that are modified or new in *emcc* are listed below:
        before the closure-compiled code runs, because then it will
        reuse that variable.
 
-     * If closure compiler hits an out-of-memory, try adjusting
-       "JAVA_HEAP_SIZE" in the environment (for example, to 4096m for
-       4GB).
-
      * Closure is only run if JavaScript opts are being done ("-O2" or
        above).
 
@@ -569,13 +565,6 @@ Options that are modified or new in *emcc* are listed below:
    the user's home directory ("~/.emscripten"). This can be overridden
    using the "EM_CONFIG" environment variable.
 
-"--default-obj-ext <.ext>"
-   [compile] Specifies the output suffix to use when compiling with
-   "-c" in the absence of "-o".  For example, when compiling multiple
-   sources files with "emcc -c *.c" the compiler will normally output
-   files with the ".o" extension, but "--default-obj-ext .obj" can be
-   used to instead generate files with the *.obj* extension.
-
 "--valid-abspath <path>"
    [compile+link] Note an allowed absolute path, which we should not
    warn about (absolute include paths normally are warned about, since

docs/process.md

@@ -1,5 +1,8 @@
 # Development Processes
 
+More information can be found in the [Contribution
+section](https://emscripten.org/docs/contributing/contributing.html) of the
+webside.
 
 ## Landing PRs