[browser][coreCLR] TypeScript host skeleton (#119866)

Author: pavelsavara

src/coreclr/hosts/corerun/CMakeLists.txt

@@ -56,11 +56,13 @@ else(CLR_CMAKE_HOST_WIN32)
                 System.Native.Browser-Static)
             set(JS_SYSTEM_NATIVE_BROWSER
                 "${CLR_ARTIFACTS_OBJ_DIR}/native/browser-${CMAKE_BUILD_TYPE}-wasm/System.Native.Browser/libSystem.Native.Browser.js")
+            set(JS_SYSTEM_BROWSER_UTILS
+                "${CLR_ARTIFACTS_OBJ_DIR}/native/browser-${CMAKE_BUILD_TYPE}-wasm/System.Native.Browser/libSystem.Browser.Utils.js")
             set(JS_CORE_RUN_PRE
                 "${CMAKE_CURRENT_SOURCE_DIR}/libCorerun.pre.js")
             set_target_properties(corerun PROPERTIES
-                LINK_DEPENDS "${JS_CORE_RUN_PRE};${JS_SYSTEM_NATIVE_BROWSER};"
-                LINK_FLAGS "--pre-js ${JS_CORE_RUN_PRE} --js-library ${JS_SYSTEM_NATIVE_BROWSER}"
+                LINK_DEPENDS "${JS_CORE_RUN_PRE};${JS_SYSTEM_NATIVE_BROWSER};${JS_SYSTEM_BROWSER_UTILS};"
+                LINK_FLAGS "--pre-js ${JS_CORE_RUN_PRE} --js-library ${JS_SYSTEM_NATIVE_BROWSER} --js-library ${JS_SYSTEM_BROWSER_UTILS}"
                 RUNTIME_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}")
             target_link_options(corerun PRIVATE
                 -fwasm-exceptions

src/coreclr/hosts/corewasmrun/CMakeLists.txt

@@ -20,11 +20,13 @@ target_compile_options(corewasmrun PRIVATE -fwasm-exceptions)
 
 set(JS_SYSTEM_NATIVE_BROWSER
     "${CLR_ARTIFACTS_OBJ_DIR}/native/browser-${CMAKE_BUILD_TYPE}-wasm/System.Native.Browser/libSystem.Native.Browser.js")
+set(JS_SYSTEM_BROWSER_UTILS
+    "${CLR_ARTIFACTS_OBJ_DIR}/native/browser-${CMAKE_BUILD_TYPE}-wasm/System.Native.Browser/libSystem.Browser.Utils.js")
 set(JS_CORE_WASM_RUN_PRE
     "${CMAKE_CURRENT_SOURCE_DIR}/libCorewasmrun.pre.js")
 set_target_properties(corewasmrun PROPERTIES
-  LINK_DEPENDS "${JS_CORE_WASM_RUN_PRE};${JS_SYSTEM_NATIVE_BROWSER};"
-  LINK_FLAGS "--pre-js ${JS_CORE_WASM_RUN_PRE} --js-library ${JS_SYSTEM_NATIVE_BROWSER}"
+  LINK_DEPENDS "${JS_CORE_WASM_RUN_PRE};${JS_SYSTEM_NATIVE_BROWSER};${JS_SYSTEM_BROWSER_UTILS};"
+  LINK_FLAGS "--pre-js ${JS_CORE_WASM_RUN_PRE} --js-library ${JS_SYSTEM_NATIVE_BROWSER} --js-library ${JS_SYSTEM_BROWSER_UTILS}"
   RUNTIME_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}")
 target_link_options(corewasmrun PRIVATE
   -fwasm-exceptions

src/native/.eslintignore

@@ -1,3 +1 @@
 ./corehost/browserhost/loader/dotnet.d.ts
-./**/*.js
-./**/*.mjs

src/native/.eslintrc.cjs

@@ -20,8 +20,6 @@ module.exports = {
         "node_modules/**/*.*",
         "bin/**/*.*",
         "obj/**/*.*",
-        "**/*.js",
-        "**/*.mjs",
         "dotnet.d.ts",
     ],
     "rules": {

src/native/corehost/browserhost/CMakeLists.txt

@@ -50,6 +50,8 @@ target_compile_options(browserhost PRIVATE
 
 set(JS_SYSTEM_NATIVE_BROWSER
     "${CLR_ARTIFACTS_OBJ_DIR}/native/browser-${CMAKE_BUILD_TYPE}-wasm/System.Native.Browser/libSystem.Native.Browser.js")
+set(JS_SYSTEM_BROWSER_UTILS
+    "${CLR_ARTIFACTS_OBJ_DIR}/native/browser-${CMAKE_BUILD_TYPE}-wasm/System.Native.Browser/libSystem.Browser.Utils.js")
 set(JS_SYSTEM_RUNTIME_INTEROPSERVICES_JAVASCRIPT_NATIVE
     "${CLR_ARTIFACTS_OBJ_DIR}/native/browser-${CMAKE_BUILD_TYPE}-wasm/System.Runtime.InteropServices.JavaScript.Native/libSystem.Runtime.InteropServices.JavaScript.Native.js")
 set(JS_BROWSER_HOST
@@ -58,8 +60,8 @@ set(JS_SYSTEM_NATIVE_BROWSER_EXPOST
     "${CMAKE_CURRENT_SOURCE_DIR}/../../libs/System.Native.Browser/libSystem.Native.Browser.extpost.js")
 
 set_target_properties(browserhost PROPERTIES
-    LINK_DEPENDS "${JS_SYSTEM_NATIVE_BROWSER};${JS_SYSTEM_RUNTIME_INTEROPSERVICES_JAVASCRIPT_NATIVE};${JS_BROWSER_HOST};${JS_SYSTEM_NATIVE_BROWSER_EXPOST};"
-    LINK_FLAGS "--js-library ${JS_SYSTEM_NATIVE_BROWSER} --js-library ${JS_SYSTEM_RUNTIME_INTEROPSERVICES_JAVASCRIPT_NATIVE} --js-library ${JS_BROWSER_HOST} --extern-post-js ${JS_SYSTEM_NATIVE_BROWSER_EXPOST}"
+    LINK_DEPENDS "${JS_SYSTEM_NATIVE_BROWSER};${JS_SYSTEM_BROWSER_UTILS};${JS_SYSTEM_RUNTIME_INTEROPSERVICES_JAVASCRIPT_NATIVE};${JS_BROWSER_HOST};${JS_SYSTEM_NATIVE_BROWSER_EXPOST};"
+    LINK_FLAGS "--js-library ${JS_SYSTEM_NATIVE_BROWSER} --js-library ${JS_SYSTEM_BROWSER_UTILS} --js-library ${JS_SYSTEM_RUNTIME_INTEROPSERVICES_JAVASCRIPT_NATIVE} --js-library ${JS_BROWSER_HOST} --extern-post-js ${JS_SYSTEM_NATIVE_BROWSER_EXPOST}"
     RUNTIME_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}")
 
 if (UPPERCASE_CMAKE_BUILD_TYPE STREQUAL DEBUG)
@@ -72,9 +74,9 @@ if (UPPERCASE_CMAKE_BUILD_TYPE STREQUAL DEBUG)
     )
 endif ()
 
-# TODO-WASM    -sWASM_BIGINT=1
-# TODO-WASM    -emit-llvm
-# TODO-WASM    --source-map-base http://microsoft.com
+# WASM-TODO    -sWASM_BIGINT=1
+# WASM-TODO    -emit-llvm
+# WASM-TODO    --source-map-base http://microsoft.com
 target_link_options(browserhost PRIVATE
     -sINITIAL_MEMORY=134217728
     -sMAXIMUM_MEMORY=2147483648
@@ -85,7 +87,7 @@ target_link_options(browserhost PRIVATE
     -sEXPORT_ES6=1
     -sEXIT_RUNTIME=0
     -sEXPORTED_RUNTIME_METHODS=UTF8ToString,cwrap,ccall,HEAPU8,HEAPU32,HEAPU64,BROWSER_HOST
-    -sEXPORTED_FUNCTIONS=_posix_memalign,_free,stackAlloc,stackRestore,stackSave,_browserHostInitializeCoreCLR,_browserHostExecuteAssembly,___cpp_exception
+    -sEXPORTED_FUNCTIONS=_posix_memalign,_free,stackAlloc,stackRestore,stackSave,_BrowserHost_InitializeCoreCLR,_BrowserHost_ExecuteAssembly,___cpp_exception
     -sEXPORT_NAME=createDotnetRuntime
     -fwasm-exceptions
     -msimd128

src/native/corehost/browserhost/ReadMe.md

@@ -19,6 +19,7 @@ It is **Emscripten application** statically linked from libraries.
 - `host/index.ts` -> compiled -> `libBrowserHost.js` linked -> `dotnet.native.js`
 - `libBrowserHost.footer.js` -> compiled -> `libBrowserHost.js` linked -> `dotnet.native.js`
 - `libSystem.Native.Browser.js` linked -> `dotnet.native.js`
+- `libSystem.Browser.Utils.js` linked -> `dotnet.native.js`
 - `libSystem.Runtime.InteropServices.JavaScript.Native.js` linked -> `dotnet.native.js`
 - `browserhost.cpp` compiled + linked -> `dotnet.native.wasm`
 - `libSystem.Native.Browser.a` linked -> `dotnet.native.wasm`

src/native/corehost/browserhost/browserhost.cpp

@@ -50,9 +50,9 @@ extern "C"
     const void* GlobalizationResolveDllImport(const char* name);
     const void* CompressionResolveDllImport(const char* name);
 
-    bool browserHostExternalAssemblyProbe(const char* pathPtr, /*out*/ void **outDataStartPtr, /*out*/ int64_t* outSize);
-    void browserHostResolveMain(int exitCode);
-    void browserHostRejectMain(const char *reason);
+    bool BrowserHost_ExternalAssemblyProbe(const char* pathPtr, /*out*/ void **outDataStartPtr, /*out*/ int64_t* outSize);
+    void BrowserHost_ResolveMain(int exitCode);
+    void BrowserHost_RejectMain(const char *reason);
 }
 
 // The current CoreCLR instance details.
@@ -64,13 +64,6 @@ static void log_error_info(const char* line)
     std::fprintf(stderr, "log error: %s\n", line);
 }
 
-static bool external_assembly_probe(const char* path, /*out*/ void **data_start, /*out*/ int64_t* size)
-{
-    *size = 0;
-    *data_start = nullptr;
-    return browserHostExternalAssemblyProbe(path, data_start, size);;
-}
-
 static const void* pinvoke_override(const char* library_name, const char* entry_point_name)
 {
     if (strcmp(library_name, "libSystem.Native") == 0)
@@ -107,9 +100,11 @@ static std::vector<const char*> propertyKeys;
 static std::vector<const char*> propertyValues;
 static pal::char_t ptr_to_string_buffer[STRING_LENGTH("0xffffffffffffffff") + 1];
 
-extern "C" int browserHostInitializeCoreCLR(void)
+// WASM-TODO: pass TPA via argument, not env
+// WASM-TODO: pass app_path via argument, not env
+// WASM-TODO: pass search_paths via argument, not env
+extern "C" int BrowserHost_InitializeCoreCLR(void)
 {
-    //WASM-TODO: does getenv return UTF8 ?
     pal::getenv(HOST_PROPERTY_APP_PATHS, &app_path);
     pal::getenv(HOST_PROPERTY_NATIVE_DLL_SEARCH_DIRECTORIES, &search_paths);
     pal::getenv(HOST_PROPERTY_TRUSTED_PLATFORM_ASSEMBLIES, &tpa);
@@ -124,7 +119,7 @@ extern "C" int browserHostInitializeCoreCLR(void)
 
     host_runtime_contract host_contract = { sizeof(host_runtime_contract), nullptr };
     host_contract.pinvoke_override = &pinvoke_override;
-    host_contract.external_assembly_probe = &external_assembly_probe;
+    host_contract.external_assembly_probe = &BrowserHost_ExternalAssemblyProbe;
 
     pal::snwprintf(ptr_to_string_buffer, ARRAY_SIZE(ptr_to_string_buffer), _X("0x%zx"), (size_t)(&host_contract));
 
@@ -144,7 +139,8 @@ extern "C" int browserHostInitializeCoreCLR(void)
 }
 
 // WASM-TODO: browser needs async entrypoint
-extern "C" int browserHostExecuteAssembly(const char* assemblyPath)
+// WASM-TODO: don't coreclr_shutdown_2 when browser
+extern "C" int BrowserHost_ExecuteAssembly(const char* assemblyPath)
 {
     int exit_code;
     int retval = coreclr_execute_assembly(CurrentClrInstance, CurrentAppDomainId, 0, nullptr, assemblyPath, (uint32_t*)&exit_code);
@@ -164,11 +160,11 @@ extern "C" int browserHostExecuteAssembly(const char* assemblyPath)
         std::fprintf(stderr, "coreclr_shutdown_2 failed - Error: 0x%08x\n", retval);
         exit_code = -1;
         // WASM-TODO: this is too trivial
-        browserHostRejectMain("coreclr_shutdown_2 failed");
+        BrowserHost_RejectMain("coreclr_shutdown_2 failed");
     }
 
     // WASM-TODO: this is too trivial
     // because nothing runs continuations yet and also coreclr_execute_assembly is sync looping
-    browserHostResolveMain(exit_code);
+    BrowserHost_ResolveMain(exit_code);
     return retval;
 }

src/native/corehost/browserhost/host/cross-linked.ts

@@ -0,0 +1,5 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+import { } from "../../../libs/Common/JavaScript/cross-linked";
+

src/native/corehost/browserhost/host/host.ts

@@ -0,0 +1,75 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+import type { CharPtr, VoidPtr, VoidPtrPtr } from "./types";
+import { } from "./cross-linked"; // ensure ambient symbols are declared
+
+const loadedAssemblies : Map<string, { ptr: number, length: number }> = new Map();
+
+export function registerDllBytes(bytes: Uint8Array, asset: { name: string }) {
+    const sp = Module.stackSave();
+    try {
+        const sizeOfPtr = 4;
+        const ptrPtr = Module.stackAlloc(sizeOfPtr);
+        if (Module._posix_memalign(ptrPtr as any, 16, bytes.length)) {
+            throw new Error("posix_memalign failed");
+        }
+
+        const ptr = Module.HEAPU32[ptrPtr as any >>> 2];
+        Module.HEAPU8.set(bytes, ptr);
+        loadedAssemblies.set(asset.name, { ptr, length: bytes.length });
+    } finally {
+        Module.stackRestore(sp);
+    }
+}
+
+// bool BrowserHost_ExternalAssemblyProbe(const char* pathPtr, /*out*/ void **outDataStartPtr, /*out*/ int64_t* outSize);
+export function BrowserHost_ExternalAssemblyProbe(pathPtr:CharPtr, outDataStartPtr:VoidPtrPtr, outSize:VoidPtr) {
+    const path = Module.UTF8ToString(pathPtr);
+    const assembly = loadedAssemblies.get(path);
+    if (assembly) {
+        Module.HEAPU32[outDataStartPtr as any >>> 2] = assembly.ptr;
+        // int64_t target
+        Module.HEAPU32[outSize as any >>> 2] = assembly.length;
+        Module.HEAPU32[((outSize as any) + 4) >>> 2] = 0;
+        return true;
+    }
+    Module.HEAPU32[outDataStartPtr as any >>> 2] = 0;
+    Module.HEAPU32[outSize as any >>> 2] = 0;
+    Module.HEAPU32[((outSize as any) + 4) >>> 2] = 0;
+    return false;
+}
+
+export function BrowserHost_ResolveMain(exitCode:number) {
+    dotnetLoaderExports.resolveRunMainPromise(exitCode);
+}
+
+export function BrowserHost_RejectMain(reason:any) {
+    dotnetLoaderExports.rejectRunMainPromise(reason);
+}
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export async function runMain(mainAssemblyName?: string, args?: string[]): Promise<number> {
+    // int BrowserHost_ExecuteAssembly(char * assemblyPath)
+    const res = Module.ccall("BrowserHost_ExecuteAssembly", "number", ["string"], [mainAssemblyName]) as number;
+    if (res != 0) {
+        const reason = new Error("Failed to execute assembly");
+        dotnetApi.exit(res, reason);
+        throw reason;
+    }
+
+    return dotnetLoaderExports.getRunMainPromise();
+}
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export async function runMainAndExit(mainAssemblyName?: string, args?: string[]): Promise<number> {
+    try {
+        await runMain(mainAssemblyName, args);
+    } catch (error) {
+        dotnetApi.exit(1, error);
+        throw error;
+    }
+    dotnetApi.exit(0, null);
+    return 0;
+}
+

src/native/corehost/browserhost/host/index.ts

@@ -0,0 +1,29 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+import type { InternalExchange, BrowserHostExports, RuntimeAPI, BrowserHostExportsTable } from "./types";
+import { InternalExchangeIndex } from "./types";
+import { } from "./cross-linked"; // ensure ambient symbols are declared
+
+import { runMain, runMainAndExit, registerDllBytes } from "./host";
+
+export function dotnetInitializeModule(internals: InternalExchange): void {
+    const runtimeApiLocal: Partial<RuntimeAPI> = {
+        runMain,
+        runMainAndExit,
+    };
+    Object.assign(internals[InternalExchangeIndex.RuntimeAPI], runtimeApiLocal);
+
+    internals[InternalExchangeIndex.BrowserHostExportsTable] = browserHostExportsToTable({
+        registerDllBytes,
+    });
+    dotnetUpdateInternals(internals, dotnetUpdateInternalsSubscriber);
+    function browserHostExportsToTable(map:BrowserHostExports):BrowserHostExportsTable {
+        // keep in sync with browserHostExportsFromTable()
+        return [
+            map.registerDllBytes,
+        ];
+    }
+}
+
+export { BrowserHost_ExternalAssemblyProbe, BrowserHost_ResolveMain, BrowserHost_RejectMain } from "./host";