Move common runtime includes to runtime_shared.js. NFC (emscripten-co…

…re#23269) This reduces duplication between preamble.js and preamble_minimal.js. Even though this is completely NFC there were some code size changes due to the ordering of the code.
sbc100 · Jan 2, 2025 · a7dc5cd · a7dc5cd
1 parent b08c9f1
commit a7dc5cd
Show file tree

Hide file tree

Showing 38 changed files with 79 additions and 114 deletions.
diff --git a/src/preamble.js b/src/preamble.js
@@ -44,18 +44,6 @@ if (typeof WebAssembly != 'object') {
 }
 #endif
 
-#if SAFE_HEAP
-#include "runtime_safe_heap.js"
-#endif
-
-#if SHARED_MEMORY && ALLOW_MEMORY_GROWTH
-#include "growableHeap.js"
-#endif
-
-#if USE_ASAN
-#include "runtime_asan.js"
-#endif
-
 #if SUPPORT_BASE64_EMBEDDING || FORCE_FILESYSTEM
 #include "base64Utils.js"
 #endif
@@ -150,12 +138,16 @@ var HEAP,
 var HEAP_DATA_VIEW;
 #endif
 
-#include "runtime_shared.js"
+var runtimeInitialized = false;
 
-#if PTHREADS
-#include "runtime_pthread.js"
+#if EXIT_RUNTIME
+var runtimeExited = false;
 #endif
 
+#include "URIUtils.js"
+
+#include "runtime_shared.js"
+
 #if ASSERTIONS
 assert(!Module['STACK_SIZE'], 'STACK_SIZE can no longer be set at runtime.  Use -sSTACK_SIZE at link time')
 #endif
@@ -174,8 +166,6 @@ assert(!Module['wasmMemory'], 'Use of `wasmMemory` detected.  Use -sIMPORTED_MEM
 assert(!Module['INITIAL_MEMORY'], 'Detected runtime INITIAL_MEMORY setting.  Use -sIMPORTED_MEMORY to define wasmMemory dynamically');
 #endif // !IMPORTED_MEMORY && ASSERTIONS
 
-#include "runtime_stack_check.js"
-
 var __ATPRERUN__  = []; // functions called before the runtime is initialized
 var __ATINIT__    = []; // functions called during startup
 #if HAS_MAIN
@@ -188,12 +178,6 @@ var __ATPOSTRUN__ = []; // functions called after the main() is called
 var __RELOC_FUNCS__ = [];
 #endif
 
-var runtimeInitialized = false;
-
-#if EXIT_RUNTIME
-var runtimeExited = false;
-#endif
-
 function preRun() {
 #if ASSERTIONS && PTHREADS
   assert(!ENVIRONMENT_IS_PTHREAD); // PThreads reuse the runtime from the main thread.
@@ -483,8 +467,6 @@ function abort(what) {
   throw e;
 }
 
-#include "memoryprofiler.js"
-
 #if ASSERTIONS && !('$FS' in addedLibraryItems)
 // show errors on likely calls to FS when it was not included
 var FS = {
@@ -506,8 +488,6 @@ Module['FS_createDataFile'] = FS.createDataFile;
 Module['FS_createPreloadedFile'] = FS.createPreloadedFile;
 #endif
 
-#include "URIUtils.js"
-
 #if ASSERTIONS
 function createExportWrapper(name, nargs) {
   return (...args) => {
@@ -524,8 +504,6 @@ function createExportWrapper(name, nargs) {
 }
 #endif
 
-#include "runtime_exceptions.js"
-
 #if ABORT_ON_WASM_EXCEPTIONS
 // `abortWrapperDepth` counts the recursion level of the wrapper function so
 // that we only handle exceptions at the top level letting the exception
@@ -675,16 +653,6 @@ async function getWasmBinary(binaryFile) {
   return getBinarySync(binaryFile);
 }
 
-#if LOAD_SOURCE_MAP
-var wasmSourceMap;
-#include "source_map_support.js"
-#endif
-
-#if USE_OFFSET_CONVERTER
-var wasmOffsetConverter;
-#include "wasm_offset_converter.js"
-#endif
-
 #if SPLIT_MODULE
 {{{ makeModuleReceiveWithVar('loadSplitModule', undefined, 'instantiateSync',  true) }}}
 var splitModuleProxyHandler = {
@@ -1127,8 +1095,6 @@ var tempDouble;
 var tempI64;
 #endif
 
-#include "runtime_debug.js"
-
 #if RETAIN_COMPILER_SETTINGS
 var compilerSettings = {{{ JSON.stringify(makeRetainedCompilerSettings()) }}} ;
 

diff --git a/src/preamble_minimal.js b/src/preamble_minimal.js
@@ -4,18 +4,6 @@
  * SPDX-License-Identifier: MIT
  */
 
-#if SAFE_HEAP
-#include "runtime_safe_heap.js"
-#endif
-
-#if SHARED_MEMORY && ALLOW_MEMORY_GROWTH
-#include "growableHeap.js"
-#endif
-
-#if USE_ASAN
-#include "runtime_asan.js"
-#endif
-
 #if ASSERTIONS
 /** @type {function(*, string=)} */
 function assert(condition, text) {
@@ -58,39 +46,19 @@ var HEAP8, HEAP16, HEAP32, HEAPU8, HEAPU16, HEAPU32, HEAPF32, HEAPF64,
 #endif
   wasmMemory;
 
-#include "runtime_shared.js"
-
-#if PTHREADS
-#include "runtime_pthread.js"
-#endif
-
-#if IMPORTED_MEMORY
-#include "runtime_init_memory.js"
-#endif // IMPORTED_MEMORY
-
-#include "runtime_stack_check.js"
-
-#if LOAD_SOURCE_MAP
-var wasmSourceMap;
-#include "source_map_support.js"
-#endif
-
-#if USE_OFFSET_CONVERTER
-var wasmOffsetConverter;
-#include "wasm_offset_converter.js"
+#if ASSERTIONS || SAFE_HEAP || USE_ASAN
+var runtimeInitialized = false;
 #endif
 
 #if EXIT_RUNTIME
 var __ATEXIT__    = []; // functions called during shutdown
 var runtimeExited = false;
 #endif
 
-#if ASSERTIONS || SAFE_HEAP || USE_ASAN
-var runtimeInitialized = false;
-#endif
+#include "runtime_shared.js"
 
-#include "memoryprofiler.js"
-#include "runtime_exceptions.js"
-#include "runtime_debug.js"
+#if IMPORTED_MEMORY
+#include "runtime_init_memory.js"
+#endif // IMPORTED_MEMORY
 
 // === Body ===
diff --git a/src/runtime_shared.js b/src/runtime_shared.js
@@ -4,6 +4,37 @@
  * SPDX-License-Identifier: MIT
  */
 
+#include "runtime_stack_check.js"
+#include "runtime_exceptions.js"
+#include "runtime_debug.js"
+#include "memoryprofiler.js"
+
+#if SAFE_HEAP
+#include "runtime_safe_heap.js"
+#endif
+
+#if SHARED_MEMORY && ALLOW_MEMORY_GROWTH
+#include "growableHeap.js"
+#endif
+
+#if USE_ASAN
+#include "runtime_asan.js"
+#endif
+
+#if PTHREADS
+#include "runtime_pthread.js"
+#endif
+
+#if LOAD_SOURCE_MAP
+var wasmSourceMap;
+#include "source_map_support.js"
+#endif
+
+#if USE_OFFSET_CONVERTER
+var wasmOffsetConverter;
+#include "wasm_offset_converter.js"
+#endif
+
 {{{
   // Helper function to export a heap symbol on the module object,
   // if requested.

diff --git a/test/other/codesize/test_codesize_cxx_except_wasm.gzsize b/test/other/codesize/test_codesize_cxx_except_wasm.gzsize
@@ -1 +1 @@
-8329
+8328
diff --git a/test/other/codesize/test_codesize_cxx_except_wasm.jssize b/test/other/codesize/test_codesize_cxx_except_wasm.jssize
@@ -1 +1 @@
-20266
+20267
diff --git a/test/other/codesize/test_codesize_cxx_except_wasm_exnref.gzsize b/test/other/codesize/test_codesize_cxx_except_wasm_exnref.gzsize
@@ -1 +1 @@
-8329
+8328
diff --git a/test/other/codesize/test_codesize_cxx_except_wasm_exnref.jssize b/test/other/codesize/test_codesize_cxx_except_wasm_exnref.jssize
@@ -1 +1 @@
-20266
+20267
diff --git a/test/other/codesize/test_codesize_cxx_lto.gzsize b/test/other/codesize/test_codesize_cxx_lto.gzsize
@@ -1 +1 @@
-8363
+8360
diff --git a/test/other/codesize/test_codesize_cxx_mangle.gzsize b/test/other/codesize/test_codesize_cxx_mangle.gzsize
@@ -1 +1 @@
-9375
+9374
diff --git a/test/other/codesize/test_codesize_cxx_wasmfs.gzsize b/test/other/codesize/test_codesize_cxx_wasmfs.gzsize
@@ -1 +1 @@
-3600
+3599
diff --git a/test/other/codesize/test_codesize_files_js_fs.gzsize b/test/other/codesize/test_codesize_files_js_fs.gzsize
@@ -1 +1 @@
-7656
+7655
diff --git a/test/other/codesize/test_codesize_files_wasmfs.gzsize b/test/other/codesize/test_codesize_files_wasmfs.gzsize
@@ -1 +1 @@
-2837
+2836
diff --git a/test/other/codesize/test_codesize_hello_O0.gzsize b/test/other/codesize/test_codesize_hello_O0.gzsize
@@ -1 +1 @@
-7891
+7905
diff --git a/test/other/codesize/test_codesize_hello_O0.jssize b/test/other/codesize/test_codesize_hello_O0.jssize
@@ -1 +1 @@
-21016
+21012
diff --git a/test/other/codesize/test_codesize_hello_O2.gzsize b/test/other/codesize/test_codesize_hello_O2.gzsize
@@ -1 +1 @@
-2357
+2356
diff --git a/test/other/codesize/test_codesize_hello_O3.gzsize b/test/other/codesize/test_codesize_hello_O3.gzsize
@@ -1 +1 @@
-2296
+2297
diff --git a/test/other/codesize/test_codesize_hello_Os.gzsize b/test/other/codesize/test_codesize_hello_Os.gzsize
@@ -1 +1 @@
-2296
+2297
diff --git a/test/other/codesize/test_codesize_hello_Oz.gzsize b/test/other/codesize/test_codesize_hello_Oz.gzsize
@@ -1 +1 @@
-2279
+2278
diff --git a/test/other/codesize/test_codesize_hello_dylink.gzsize b/test/other/codesize/test_codesize_hello_dylink.gzsize
@@ -1 +1 @@
-6028
+6026
diff --git a/test/other/codesize/test_codesize_hello_dylink.jssize b/test/other/codesize/test_codesize_hello_dylink.jssize
@@ -1 +1 @@
-13317
+13316
diff --git a/test/other/codesize/test_codesize_hello_export_nothing.gzsize b/test/other/codesize/test_codesize_hello_export_nothing.gzsize
@@ -1 +1 @@
-1681
+1678
diff --git a/test/other/codesize/test_codesize_hello_wasmfs.gzsize b/test/other/codesize/test_codesize_hello_wasmfs.gzsize
@@ -1 +1 @@
-2296
+2297
diff --git a/test/other/codesize/test_codesize_libcxxabi_message_O3.gzsize b/test/other/codesize/test_codesize_libcxxabi_message_O3.gzsize
@@ -1 +1 @@
-1873
+1874
diff --git a/test/other/codesize/test_codesize_mem_O3.gzsize b/test/other/codesize/test_codesize_mem_O3.gzsize
@@ -1 +1 @@
-2327
+2326
diff --git a/test/other/codesize/test_codesize_mem_O3_grow.gzsize b/test/other/codesize/test_codesize_mem_O3_grow.gzsize
@@ -1 +1 @@
-2476
+2474
diff --git a/test/other/codesize/test_codesize_mem_O3_grow_standalone.gzsize b/test/other/codesize/test_codesize_mem_O3_grow_standalone.gzsize
@@ -1 +1 @@
-2177
+2175
diff --git a/test/other/codesize/test_codesize_mem_O3_standalone.gzsize b/test/other/codesize/test_codesize_mem_O3_standalone.gzsize
@@ -1 +1 @@
-2140
+2141
diff --git a/test/other/codesize/test_codesize_minimal_O0.gzsize b/test/other/codesize/test_codesize_minimal_O0.gzsize
@@ -1 +1 @@
-6435
+6443
diff --git a/test/other/codesize/test_codesize_minimal_O2.gzsize b/test/other/codesize/test_codesize_minimal_O2.gzsize
@@ -1 +1 @@
-1381
+1380
diff --git a/test/other/codesize/test_codesize_minimal_O3.gzsize b/test/other/codesize/test_codesize_minimal_O3.gzsize
@@ -1 +1 @@
-1348
+1347
diff --git a/test/other/codesize/test_codesize_minimal_Os.gzsize b/test/other/codesize/test_codesize_minimal_Os.gzsize
@@ -1 +1 @@
-1348
+1347
diff --git a/test/other/codesize/test_codesize_minimal_Oz.gzsize b/test/other/codesize/test_codesize_minimal_Oz.gzsize
@@ -1 +1 @@
-1348
+1347
diff --git a/test/other/codesize/test_codesize_minimal_esm.gzsize b/test/other/codesize/test_codesize_minimal_esm.gzsize
@@ -1 +1 @@
-1541
+1542
diff --git a/test/other/codesize/test_codesize_minimal_pthreads.gzsize b/test/other/codesize/test_codesize_minimal_pthreads.gzsize
@@ -1 +1 @@
-4190
+4186
diff --git a/test/other/codesize/test_codesize_minimal_wasmfs.gzsize b/test/other/codesize/test_codesize_minimal_wasmfs.gzsize
@@ -1 +1 @@
-1348
+1347
diff --git a/test/other/test_unoptimized_code_size.js.size b/test/other/test_unoptimized_code_size.js.size
@@ -1 +1 @@
-52853
+52855
diff --git a/test/other/test_unoptimized_code_size_no_asserts.js.size b/test/other/test_unoptimized_code_size_no_asserts.js.size
@@ -1 +1 @@
-28644
+28646
diff --git a/test/other/test_unoptimized_code_size_strict.js.size b/test/other/test_unoptimized_code_size_strict.js.size
@@ -1 +1 @@
-51636
+51638