Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[browser] wasm memory snapshot into browser cache #82049

Merged
merged 56 commits into from
Mar 14, 2023
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
56 commits
Select commit Hold shift + click to select a range
ea02d94
wip
pavelsavara Mar 3, 2023
c1aa6c3
wip
pavelsavara Mar 3, 2023
bf9ef4d
wip
pavelsavara Mar 3, 2023
f883a72
Merge branch 'main' into browser_memory_snapshot3
pavelsavara Mar 3, 2023
3fe9aba
wip
pavelsavara Mar 3, 2023
f4225aa
Merge branch 'main' into browser_memory_snapshot3
pavelsavara Mar 3, 2023
d2e5b49
fix
pavelsavara Mar 3, 2023
c409f51
Merge branch 'main' into browser_memory_snapshot3
pavelsavara Mar 6, 2023
e695c42
feedback
pavelsavara Mar 6, 2023
1189015
lint
pavelsavara Mar 6, 2023
b92c82e
Update src/mono/wasm/memory-snapshot.md
pavelsavara Mar 6, 2023
7ccc8e6
Update src/mono/wasm/memory-snapshot.md
pavelsavara Mar 6, 2023
ec762ac
Update src/mono/wasm/memory-snapshot.md
pavelsavara Mar 6, 2023
91c0211
Update src/mono/wasm/memory-snapshot.md
pavelsavara Mar 6, 2023
20d548b
Update src/mono/wasm/memory-snapshot.md
pavelsavara Mar 6, 2023
8e6865c
more linear memory usage and recovery from failure of snapshot use
pavelsavara Mar 6, 2023
7bf7881
feedback
pavelsavara Mar 6, 2023
aec9b53
Merge branch 'main' into browser_memory_snapshot3
pavelsavara Mar 8, 2023
5651f37
start runtime twice for unit tests, so that the actual tests is runni…
pavelsavara Mar 8, 2023
a16f667
Merge branch 'main' into browser_memory_snapshot3
pavelsavara Mar 8, 2023
31b46ff
wip
pavelsavara Mar 8, 2023
43a73e1
continue loading non-snapshot assets
pavelsavara Mar 8, 2023
f49354a
disable adding methods to __indirect_function_table before we take me…
pavelsavara Mar 8, 2023
53781ab
rename startupMemoryCache
pavelsavara Mar 8, 2023
60b2c5a
try to fix threads
pavelsavara Mar 8, 2023
33b6e3e
Merge branch 'main' into browser_memory_snapshot3
pavelsavara Mar 8, 2023
977b46c
whitespace
pavelsavara Mar 8, 2023
933594b
fix
pavelsavara Mar 9, 2023
c68c9e8
fix storing memory
pavelsavara Mar 9, 2023
fa3e331
assert
pavelsavara Mar 9, 2023
c7f913b
- make snapshot hash more resilient
pavelsavara Mar 9, 2023
9cb1b72
fix
pavelsavara Mar 9, 2023
d1bbb9c
- renamed memorySnapshotSkippedOrDone
pavelsavara Mar 9, 2023
ee4ba76
- rename loadedMemorySnapshot
pavelsavara Mar 9, 2023
83f0032
Merge branch 'main' into browser_memory_snapshot3
pavelsavara Mar 9, 2023
85ac81d
fix
pavelsavara Mar 9, 2023
b7790f2
Merge branch 'main' into browser_memory_snapshot3
pavelsavara Mar 10, 2023
3168c42
- internal config exitAfterSnapshot
pavelsavara Mar 10, 2023
4a25447
measure
pavelsavara Mar 10, 2023
5067cf7
Merge branch 'main' into browser_memory_snapshot3
pavelsavara Mar 11, 2023
1761786
fix
pavelsavara Mar 11, 2023
94e931a
fix
pavelsavara Mar 13, 2023
2a7508e
optimize timezone detection
pavelsavara Mar 13, 2023
9759ad8
feedback
pavelsavara Mar 13, 2023
1f4e4c6
fix
pavelsavara Mar 13, 2023
e2a2cd4
- enable snapshot in blazor
pavelsavara Mar 13, 2023
eaaeaa5
store cache key
pavelsavara Mar 13, 2023
bc86ffe
feedback and cleanup
pavelsavara Mar 13, 2023
59a7a56
fix debugging
pavelsavara Mar 13, 2023
6d9f7ee
fix
pavelsavara Mar 14, 2023
3e961d1
Merge branch 'main' into browser_memory_snapshot3
pavelsavara Mar 14, 2023
f617787
Update src/mono/wasm/memory-snapshot.md
pavelsavara Mar 14, 2023
cfc5acf
Update src/mono/wasm/memory-snapshot.md
pavelsavara Mar 14, 2023
c78ef57
Update src/mono/wasm/runtime/assets.ts
pavelsavara Mar 14, 2023
7309e43
Update src/mono/wasm/runtime/assets.ts
pavelsavara Mar 14, 2023
5f8aeef
Merge branch 'main' into browser_memory_snapshot3
pavelsavara Mar 14, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 11 additions & 34 deletions src/mono/wasm/runtime/assets.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,35 +46,8 @@ const skipInstantiateByAssetTypes: {
"dotnetwasm": true,
};

export function get_preferred_icu_asset(): string | null {
if (!runtimeHelpers.config.assets)
return null;

// By setting <WasmIcuDataFileName> user can define what ICU source file they want to load.
// There is no need to check application's culture when <WasmIcuDataFileName> is set.
// If it was not set, then we have 3 "icu" assets in config and we should choose
// only one for loading, the one that matches the application's locale.
const icuAssets = runtimeHelpers.config.assets.filter(a => a["behavior"] == "icu");
if (icuAssets.length === 1)
return icuAssets[0].name;

// reads the browsers locale / the OS's locale
const preferredCulture = ENVIRONMENT_IS_WEB ? navigator.language : Intl.DateTimeFormat().resolvedOptions().locale;
const prefix = preferredCulture.split("-")[0];
const CJK = "icudt_CJK.dat";
const EFIGS = "icudt_EFIGS.dat";
const OTHERS = "icudt_no_CJK.dat";

// not all "fr-*", "it-*", "de-*", "es-*" are in EFIGS, only the one that is mostly used
if (prefix == "en" || ["fr", "fr-FR", "it", "it-IT", "de", "de-DE", "es", "es-ES"].includes(preferredCulture))
return EFIGS;
if (["zh", "ko", "ja"].includes(prefix))
return CJK;
return OTHERS;
}

export function shouldLoadIcuAsset(asset: AssetEntryInternal, preferredIcuAsset: string | null): boolean {
return !(asset.behavior == "icu" && asset.name != preferredIcuAsset);
export function shouldLoadIcuAsset(asset: AssetEntryInternal): boolean {
return !(asset.behavior == "icu" && asset.name != runtimeHelpers.preferredIcuAsset);
}

export function resolve_asset_path(behavior: AssetBehaviours) {
Expand All @@ -86,7 +59,11 @@ export function resolve_asset_path(behavior: AssetBehaviours) {
return asset;
}
export async function mono_download_assets(): Promise<void> {
const preferredIcuAsset = get_preferred_icu_asset();
if (runtimeHelpers.memoryIsLoaded) {
allAssetsInMemory.promise_control.resolve();
return;
}

if (runtimeHelpers.diagnosticTracing) console.debug("MONO_WASM: mono_download_assets");
runtimeHelpers.maxParallelDownloads = runtimeHelpers.config.maxParallelDownloads || runtimeHelpers.maxParallelDownloads;
runtimeHelpers.enableDownloadRetry = runtimeHelpers.config.enableDownloadRetry || runtimeHelpers.enableDownloadRetry;
Expand All @@ -101,10 +78,10 @@ export async function mono_download_assets(): Promise<void> {
mono_assert(!asset.resolvedUrl || typeof asset.resolvedUrl === "string", "asset resolvedUrl could be string");
mono_assert(!asset.hash || typeof asset.hash === "string", "asset resolvedUrl could be string");
mono_assert(!asset.pendingDownload || typeof asset.pendingDownload === "object", "asset pendingDownload could be object");
if (!skipInstantiateByAssetTypes[asset.behavior] && shouldLoadIcuAsset(asset, preferredIcuAsset)) {
if (!skipInstantiateByAssetTypes[asset.behavior] && shouldLoadIcuAsset(asset)) {
expected_instantiated_assets_count++;
}
if (!skipDownloadsByAssetTypes[asset.behavior] && shouldLoadIcuAsset(asset, preferredIcuAsset)) {
if (!skipDownloadsByAssetTypes[asset.behavior] && shouldLoadIcuAsset(asset)) {
expected_downloaded_assets_count++;
promises_of_assets.push(start_asset_download(asset));
}
Expand Down Expand Up @@ -132,10 +109,10 @@ export async function mono_download_assets(): Promise<void> {
const headersOnly = skipBufferByAssetTypes[asset.behavior];
if (!headersOnly) {
mono_assert(asset.isOptional, "Expected asset to have the downloaded buffer");
if (!skipDownloadsByAssetTypes[asset.behavior] && shouldLoadIcuAsset(asset, preferredIcuAsset)) {
if (!skipDownloadsByAssetTypes[asset.behavior] && shouldLoadIcuAsset(asset)) {
expected_downloaded_assets_count--;
}
if (!skipInstantiateByAssetTypes[asset.behavior] && shouldLoadIcuAsset(asset, preferredIcuAsset)) {
if (!skipInstantiateByAssetTypes[asset.behavior] && shouldLoadIcuAsset(asset)) {
expected_instantiated_assets_count--;
}
} else {
Expand Down
5 changes: 5 additions & 0 deletions src/mono/wasm/runtime/dotnet.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ interface DotnetHostBuilder {
withDebugging(level: number): DotnetHostBuilder;
withMainAssembly(mainAssemblyName: string): DotnetHostBuilder;
withApplicationArgumentsFromQuery(): DotnetHostBuilder;
withMemoryCache(value: boolean): DotnetHostBuilder;
create(): Promise<RuntimeAPI>;
run(): Promise<number>;
}
Expand Down Expand Up @@ -132,6 +133,10 @@ type MonoConfig = {
* initial number of workers to add to the emscripten pthread pool
*/
pthreadPoolSize?: number;
/**
* If true, the snapshot of runtime's memory will be stored in the browser and used for faster startup next time. Default is true.
*/
cacheMemory?: boolean;
/**
* hash of assets
*/
Expand Down
26 changes: 26 additions & 0 deletions src/mono/wasm/runtime/icu.ts
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,29 @@ export function mono_wasm_globalization_init(): void {
}
}

export function get_preferred_icu_asset(): string | null {
if (!runtimeHelpers.config.assets)
return null;

// By setting <WasmIcuDataFileName> user can define what ICU source file they want to load.
// There is no need to check application's culture when <WasmIcuDataFileName> is set.
// If it was not set, then we have 3 "icu" assets in config and we should choose
// only one for loading, the one that matches the application's locale.
const icuAssets = runtimeHelpers.config.assets.filter(a => a["behavior"] == "icu");
if (icuAssets.length === 1)
return icuAssets[0].name;

// reads the browsers locale / the OS's locale
const preferredCulture = ENVIRONMENT_IS_WEB ? navigator.language : Intl.DateTimeFormat().resolvedOptions().locale;
const prefix = preferredCulture.split("-")[0];
const CJK = "icudt_CJK.dat";
const EFIGS = "icudt_EFIGS.dat";
const OTHERS = "icudt_no_CJK.dat";

// not all "fr-*", "it-*", "de-*", "es-*" are in EFIGS, only the one that is mostly used
if (prefix == "en" || ["fr", "fr-FR", "it", "it-IT", "de", "de-DE", "es", "es-ES"].includes(preferredCulture))
return EFIGS;
if (["zh", "ko", "ja"].includes(prefix))
return CJK;
return OTHERS;
}
3 changes: 2 additions & 1 deletion src/mono/wasm/runtime/imports.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import type { EmscriptenModule } from "./types/emscripten";

// these are our public API (except internal)
export let Module: EmscriptenModule & DotnetModule;
export let anyModule: any = undefined;
export let INTERNAL: any;
export let IMPORTS: any;

Expand All @@ -29,7 +30,7 @@ export function set_imports_exports(
): void {
INTERNAL = exports.internal;
IMPORTS = exports.marshaled_imports;
Module = exports.module;
anyModule = Module = exports.module;

ENVIRONMENT_IS_NODE = imports.isNode;
ENVIRONMENT_IS_SHELL = imports.isShell;
Expand Down
3 changes: 1 addition & 2 deletions src/mono/wasm/runtime/managed-exports.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,13 @@

import { GCHandle, MarshalerToCs, MarshalerToJs, MonoMethod, mono_assert } from "./types";
import cwraps from "./cwraps";
import { Module, runtimeHelpers, ENVIRONMENT_IS_PTHREAD } from "./imports";
import { runtimeHelpers, ENVIRONMENT_IS_PTHREAD, anyModule } from "./imports";
import { alloc_stack_frame, get_arg, get_arg_gc_handle, MarshalerType, set_arg_type, set_gc_handle } from "./marshal";
import { invoke_method_and_handle_exception } from "./invoke-cs";
import { marshal_array_to_cs_impl, marshal_exception_to_cs, marshal_intptr_to_cs } from "./marshal-to-cs";
import { marshal_int32_to_js, marshal_string_to_js, marshal_task_to_js } from "./marshal-to-js";

export function init_managed_exports(): void {
const anyModule = Module as any;
const exports_fqn_asm = "System.Runtime.InteropServices.JavaScript";
runtimeHelpers.runtime_interop_module = cwraps.mono_wasm_assembly_load(exports_fqn_asm);
if (!runtimeHelpers.runtime_interop_module)
Expand Down
3 changes: 1 addition & 2 deletions src/mono/wasm/runtime/marshal.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
// The .NET Foundation licenses this file to you under the MIT license.

import { js_owned_gc_handle_symbol, teardown_managed_proxy } from "./gc-handles";
import { Module, runtimeHelpers } from "./imports";
import { anyModule, Module, runtimeHelpers } from "./imports";
import { getF32, getF64, getI16, getI32, getI64Big, getU16, getU32, getU8, setF32, setF64, setI16, setI32, setI64Big, setU16, setU32, setU8 } from "./memory";
import { mono_wasm_new_external_root } from "./roots";
import { mono_assert, GCHandle, JSHandle, MonoObject, MonoString, GCHandleNull, JSMarshalerArguments, JSFunctionSignature, JSMarshalerType, JSMarshalerArgument, MarshalerToJs, MarshalerToCs, WasmRoot } from "./types";
Expand Down Expand Up @@ -41,7 +41,6 @@ export const JSMarshalerTypeSize = 32;
export const JSMarshalerSignatureHeaderSize = 4 + 4; // without Exception and Result

export function alloc_stack_frame(size: number): JSMarshalerArguments {
const anyModule = Module as any;
const args = anyModule.stackAlloc(JavaScriptMarshalerArgSize * size);
mono_assert(args && (<any>args) % 8 == 0, "Arg alignment");
const exc = get_arg(args, 0);
Expand Down
5 changes: 2 additions & 3 deletions src/mono/wasm/runtime/polyfills.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

import BuildConfiguration from "consts:configuration";
import MonoWasmThreads from "consts:monoWasmThreads";
import { ENVIRONMENT_IS_NODE, ENVIRONMENT_IS_SHELL, ENVIRONMENT_IS_WEB, ENVIRONMENT_IS_WORKER, INTERNAL, Module, runtimeHelpers } from "./imports";
import { anyModule, ENVIRONMENT_IS_NODE, ENVIRONMENT_IS_SHELL, ENVIRONMENT_IS_WEB, ENVIRONMENT_IS_WORKER, INTERNAL, Module, runtimeHelpers } from "./imports";
import { afterUpdateGlobalBufferAndViews } from "./memory";
import { replaceEmscriptenPThreadLibrary } from "./pthreads/shared/emscripten-replacements";
import { DotnetModuleConfigImports, EarlyReplacements } from "./types";
Expand All @@ -13,7 +13,6 @@ let node_fs: any | undefined = undefined;
let node_url: any | undefined = undefined;

export function init_polyfills(replacements: EarlyReplacements): void {
const anyModule = Module as any;

// performance.now() is used by emscripten and doesn't work in JSC
if (typeof globalThis.performance === "undefined") {
Expand Down Expand Up @@ -177,7 +176,7 @@ export function init_polyfills(replacements: EarlyReplacements): void {

// memory
const originalUpdateGlobalBufferAndViews = replacements.updateGlobalBufferAndViews;
replacements.updateGlobalBufferAndViews = (buffer: ArrayBufferLike) => {
runtimeHelpers.updateGlobalBufferAndViews = replacements.updateGlobalBufferAndViews = (buffer: ArrayBufferLike) => {
originalUpdateGlobalBufferAndViews(buffer);
afterUpdateGlobalBufferAndViews(buffer);
};
Expand Down
14 changes: 14 additions & 0 deletions src/mono/wasm/runtime/run-outer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ export interface DotnetHostBuilder {
withDebugging(level: number): DotnetHostBuilder
withMainAssembly(mainAssemblyName: string): DotnetHostBuilder
withApplicationArgumentsFromQuery(): DotnetHostBuilder
withMemoryCache(value: boolean): DotnetHostBuilder
create(): Promise<RuntimeAPI>
run(): Promise<number>
}
Expand Down Expand Up @@ -137,6 +138,19 @@ class HostBuilder implements DotnetHostBuilder {
}
}

withMemoryCache(value: boolean): DotnetHostBuilder {
try {
const configInternal: MonoConfigInternal = {
cacheMemory: value
};
Object.assign(this.moduleConfig.config!, configInternal);
return this;
} catch (err) {
mono_exit(1, err);
throw err;
}
}

withConfig(config: MonoConfig): DotnetHostBuilder {
try {
const providedConfig = { ...config };
Expand Down
Loading