Add support for multi-thread and/or SIMD WebAssembly #2620

mattleibow · 2023-09-18T21:16:00Z

Description of Change

Support multithreading or SIMD blazor apps out the box.

Bugs Fixed

Fixes [BUG] wasm-ld : error : --shared-memory is disallowed by libskia.SkOpts.o because it was not compiled with 'atomics' or 'bulk-memory' features. #2614
Fixes [BUG] System.DllNotFoundException: libSkiaSharp when using SkiaSharp.Blazor.Views in Blazor WASM in .NET 9 RC2 #3037
Fixes [BUG] System.DllNotFoundException: libSkiaSharp when using SkiaSharp.Blazor.Views in WASM in .Net 9 RC2 #3035

API Changes

None.

Behavioral Changes

None.

Required skia PR

None.

PR Checklist

Has tests (if omitted, state reason in description)
Rebased on top of main at time of PR
Merged related skia PRs
Changes adhere to coding standard
Updated documentation

mattleibow · 2024-03-27T20:29:58Z

This PR is not super useful since net7 and net8 don't support any of this. Maybe net9 will.

mattleibow · 2024-09-18T19:18:18Z

@jairbubbles does this PR help at all?

maxkatz6 · 2024-09-28T20:39:37Z

binding/SkiaSharp.NativeAssets.WebAssembly/buildTransitive/SkiaSharp.targets

  </PropertyGroup>
-  <ItemGroup Condition="'$(UsingMicrosoftNETSdkBlazorWebAssembly)' == 'true' and '$(TargetFrameworkVersion)' != ''">
+  <ItemGroup Condition="'$(UsingMicrosoftNETSdkBlazorWebAssembly)' == 'true' and '$(TargetFrameworkVersion)' != '' and '$(ShouldIncludeNativeSkiaSharp)' == 'True'">


Since NativeFileReference format is consistent for any Mono WASM project, would it make sense to use another property here?

Imagine something like:

<PropertyGroup> <ShouldIncludeNativeSkiaSharp Condition="'$(ShouldIncludeNativeSkiaSharp)' == '' AND '$(UsingMicrosoftNETSdkBlazorWebAssembly)' == 'true'">true</ShouldIncludeNativeSkiaSharp> </PropertyGroup>

This way third party, like Avalonia, can set ShouldIncludeNativeSkiaSharp to true.
And it will still support Blazor as a first party by defaulting to UsingMicrosoftNETSdkBlazorWebAssembly value.

Minor note, Native AOT uses <NativeLibrary /> instead of <NativeFileReference/>. But that's likely wouldn't be a concern here until .NET 10 or 11.

@jeromelaban you folks have a different way of loading native things? You just read the @(Content) and figure it out. Are there some checks that if we add will cause issues?

@maxkatz6 are you just the normal logic and no special checks? So you are suggesting that we set it up such that ShouldIncludeNativeSkiaSharp =True always includes the bits without doing fancy checks, and leave the blazor check for rather the default value of ShouldIncludeNativeSkiaSharp?

And for Uno, this means that it will not be set by default but we use the $(IsUnoHead) value to add the Uno way.

@maxkatz6 is there a Is Avalonia App property that I can check to always include? Or would you rather it be opt in? Or even opt out by setting it to false?

@jeromelaban you folks have a different way of loading native things? You just read the @(Content) and figure it out. Are there some checks that if we add will cause issues?

Indeed, this predates the support from the runtime, but it also supports automatic selection based on the path's format. Starting from net9, we'll transitively include the NativeFileReference support.

And for Uno, this means that it will not be set by default but we use the $(IsUnoHead) value to add the Uno way.

We could also add support that property, but in general, the fact that '$(OutputType)' == 'exe' may be enough to conditionally include assets. We had that $(IsUnoHead) property in the past because some targets were requiring the head to be a dll, not an exe.

As for the condition suggested by @maxkatz6, I'd adjust it as:

<PropertyGroup> <ShouldIncludeNativeSkiaSharp Condition="'$(ShouldIncludeNativeSkiaSharp)' == '' AND ( '$(UsingMicrosoftNETSdkBlazorWebAssembly)' == 'true' OR '$(UsingMicrosoftNETSdkWebAssembly)' == 'true' )">true</ShouldIncludeNativeSkiaSharp> </PropertyGroup>

to support the non-blazor Wasm SDK.

@maxkatz6 is there a Is Avalonia App property that I can check to always include?

No, not really.
For our needs, there is a little of advantage of adding avalonia specific checks into SkiaSharp, since we completely reuse runtime NativeFileReference support. I.e. without any special handling.

The only exception of special handling was NativeAOT, but even then, it's the same build-in runtime feature (just a different runtime), not something Avalonia specific.

@mattleibow these changes look good to me.

The only thing, native files inclusion can't be forced, unless user uses correct SDK. As WASM projects can be used with a standard SDK just fine. But this change improves defaults anyway.

When you say forced, are you saying I am forcing something here? Or are you saying it as a precaution?

No, no.
I mean, some developer might want to enable ShouldIncludeNativeSkiaSharp, even if they don't use WASM SDK. Since it's possible to run Browser apps without WASM SDK. Most of older Avalonia Browser apps don't use WASM SDK for example.

It's not possible to force this property right now. But is possible to manually include these files, so that's not a blocker.

By WASM SDK I mean <Project SDK="Microsoft.NET.Sdk.WebAssembly"> specifically. This PR includes a check for this (or Blazor) SDK.

Oh, I see. The opposite of what I was thinking. You want to be able to force the native. Did you use the same item group name "NativeFileReference"?

mattleibow · 2024-09-30T03:05:44Z

binding/SkiaSharp.NativeAssets.WebAssembly/buildTransitive/SkiaSharp.targets

@@ -14,15 +19,25 @@
  </ItemGroup>

  <!-- If this is a ASP.NET Blazor web assembly app -->
-  <PropertyGroup Condition="'$(UsingMicrosoftNETSdkBlazorWebAssembly)' == 'true'">
+  <PropertyGroup Condition="'$(UsingMicrosoftNETSdkBlazorWebAssembly)' == 'true' and '$(ShouldIncludeNativeSkiaSharp)' == 'True'">
    <WasmBuildNative Condition="'$(WasmBuildNative)' == ''">true</WasmBuildNative>
    <EmccExtraLDFlags>$(EmccExtraLDFlags) -s USE_WEBGL2=1</EmccExtraLDFlags>


Note to me: I see Uno has -s OFFSCREEN_FRAMEBUFFER=1 in the flags, so I am wondering if we need that too for Blazor (I was not able to test before since this feature did not exist yet). However, this probably means it is actually needed so maybe I need to check that as well.

mattleibow · 2024-10-25T11:31:24Z

Not sure what I am doing wrong, but wasm and skia seem to be fighting

https://github.com/mattleibow/SkiaSharpWasm

logging.ts:43 MONO_WASM: instantiate_wasm_module() failed CompileError: WebAssembly.compileStreaming(): Compiling function #27054:"CompressionNative_Crc32" failed: expected 1 elements on the stack for fallthru, found 3 @+8047983

jeromelaban · 2024-10-25T11:44:45Z

logging.ts:43 MONO_WASM: instantiate_wasm_module() failed CompileError: WebAssembly.compileStreaming(): Compiling function #27054:"CompressionNative_Crc32" failed: expected 1 elements on the stack for fallthru, found 3 @+8047983

I've noticed something similar in another project, with net9 specifically. It's not related to threading nor to simd, for what I can tell. In my context, it is failing in debug but not in release. Is it the case for you as well?

# Conflicts: # scripts/azure-templates-stages.yml

mattleibow · 2024-10-25T12:04:14Z

failing in debug but not in release

This appears to be the case for me too. I am trying to test the SIMD as well, but not sure how to "test" that. Is there a something that fails with SIMD disabled I can try to make sure I am doing it right?

Setting <WasmEnableSIMD>false</WasmEnableSIMD> still adds --enable-simd to the wasm build CLI:

jeromelaban · 2024-10-25T12:09:37Z

This appears to be the case for me too. I am trying to test the SIMD as well, but not sure how to "test" that. Is there a something that fails with SIMD disabled I can try to make sure I am doing it right?

The test I made was to use the non-SIMD version of skiasharp, based on the hints from @kg. Not sure why disabling SIMD entirely does have an effect, though.

mattleibow · 2024-10-25T12:12:51Z

Target Name=_RunWasmOptPostLink Project=SkiaSharpWasm.csproj
    Task "Error" skipped, due to false condition; ('$(_WasmOutputFileName)' == '') was evaluated as ('dotnet.native.wasm' == '').
    Exec
        Assembly = C:\Program Files\dotnet\sdk\9.0.100-rc.2.24474.11\Microsoft.Build.Tasks.Core.dll
        Parameters
            EnvironmentVariables
                EMSDK_PYTHON=C:\Program Files\dotnet\packs\Microsoft.NET.Runtime.Emscripten.3.1.56.Python.win-x64\9.0.0-rc.2.24468.8\Sdk\..\tools\\python.exe
                PYTHONUTF8=1
                DOTNET_EMSCRIPTEN_LLVM_ROOT=C:\Program Files\dotnet\packs\Microsoft.NET.Runtime.Emscripten.3.1.56.Sdk.win-x64\9.0.0-rc.2.24468.8\tools\bin
                DOTNET_EMSCRIPTEN_BINARYEN_ROOT=C:\Program Files\dotnet\packs\Microsoft.NET.Runtime.Emscripten.3.1.56.Sdk.win-x64\9.0.0-rc.2.24468.8\tools\
                DOTNET_EMSCRIPTEN_NODE_JS=C:\Program Files\dotnet\packs\Microsoft.NET.Runtime.Emscripten.3.1.56.Node.win-x64\9.0.0-rc.2.24468.8\tools\bin\node.exe
                PATH=........
                PYTHONUTF8=1
                EM_WORKAROUND_PYTHON_BUG_34780=1
                EMSDK_PYTHON=C:\Program Files\dotnet\packs\Microsoft.NET.Runtime.Emscripten.3.1.56.Python.win-x64\9.0.0-rc.2.24468.8\Sdk\..\tools\python.exe
                PYTHONPATH=C:\Program Files\dotnet\packs\Microsoft.NET.Runtime.Emscripten.3.1.56.Python.win-x64\9.0.0-rc.2.24468.8\Sdk\..\tools\
                PYTHONHOME=
                EM_CACHE=C:\Program Files\dotnet\packs\Microsoft.NET.Runtime.Emscripten.3.1.56.Cache.win-x64\9.0.0-rc.2.24468.8\tools\emscripten\cache\
                EM_FROZEN_CACHE=1
                ENABLE_JS_INTEROP_BY_VALUE=0
                WASM_ENABLE_SIMD=0
                WASM_ENABLE_EH=1
                ENABLE_AOT_PROFILER=0
                ENABLE_BROWSER_PROFILER=0
                ENABLE_LOG_PROFILER=0
                RUN_AOT_COMPILATION=0
            IgnoreStandardErrorWarningFormat = True
            Command = wasm-opt.exe --enable-simd --enable-exception-handling --enable-bulk-memory --strip-dwarf "D:\GitHub\SkiaSharpWasm\obj\Release\net9.0\wasm\for-build\dotnet.native.wasm" -o "D:\GitHub\SkiaSharpWasm\obj\Release\net9.0\wasm\for-build\dotnet.native.wasm"
        CommandLineArguments = wasm-opt.exe --enable-simd --enable-exception-handling --enable-bulk-memory --strip-dwarf "D:\GitHub\SkiaSharpWasm\obj\Release\net9.0\wasm\for-build\dotnet.native.wasm" -o "D:\GitHub\SkiaSharpWasm\obj\Release\net9.0\wasm\for-build\dotnet.native.wasm"
        Messages
            Environment Variables passed to tool:
              EMSDK_PYTHON=C:\Program Files\dotnet\packs\Microsoft.NET.Runtime.Emscripten.3.1.56.Python.win-x64\9.0.0-rc.2.24468.8\Sdk\..\tools\\python.exe
              PYTHONUTF8=1
              DOTNET_EMSCRIPTEN_LLVM_ROOT=C:\Program Files\dotnet\packs\Microsoft.NET.Runtime.Emscripten.3.1.56.Sdk.win-x64\9.0.0-rc.2.24468.8\tools\bin
              DOTNET_EMSCRIPTEN_BINARYEN_ROOT=C:\Program Files\dotnet\packs\Microsoft.NET.Runtime.Emscripten.3.1.56.Sdk.win-x64\9.0.0-rc.2.24468.8\tools\
              DOTNET_EMSCRIPTEN_NODE_JS=C:\Program Files\dotnet\packs\Microsoft.NET.Runtime.Emscripten.3.1.56.Node.win-x64\9.0.0-rc.2.24468.8\tools\bin\node.exe
              PATH=..........
              PYTHONUTF8=1
              EM_WORKAROUND_PYTHON_BUG_34780=1
              EMSDK_PYTHON=C:\Program Files\dotnet\packs\Microsoft.NET.Runtime.Emscripten.3.1.56.Python.win-x64\9.0.0-rc.2.24468.8\Sdk\..\tools\python.exe
              PYTHONPATH=C:\Program Files\dotnet\packs\Microsoft.NET.Runtime.Emscripten.3.1.56.Python.win-x64\9.0.0-rc.2.24468.8\Sdk\..\tools\
              PYTHONHOME=
              EM_CACHE=C:\Program Files\dotnet\packs\Microsoft.NET.Runtime.Emscripten.3.1.56.Cache.win-x64\9.0.0-rc.2.24468.8\tools\emscripten\cache\
              EM_FROZEN_CACHE=1
              ENABLE_JS_INTEROP_BY_VALUE=0
              WASM_ENABLE_SIMD=0
              WASM_ENABLE_EH=1
              ENABLE_AOT_PROFILER=0
              ENABLE_BROWSER_PROFILER=0
              ENABLE_LOG_PROFILER=0
              RUN_AOT_COMPILATION=0

lewing · 2024-10-25T17:08:49Z

cc @radekdoulik

maxkatz6 · 2024-10-27T01:39:16Z

When I run Avalonia with 2.88.9-preview.2.2 referenced, in .NET 9, I also have a similar problem:

logging.ts:43 
 MONO_WASM: instantiate_wasm_module() failed CompileError: WebAssembly.compileStreaming(): Compiling function #18452:"mono_ppdb_load_file" failed: expected 0 elements on the stack for fallthru, found 4 @+6972508

No threading or simd. Works fine in Release, but not in Debug.

mattleibow · 2024-10-28T11:48:15Z

Going to merge this now in an effort to get things working with .NET 9.

If there are any changes with regards to MSBuild targets or some way we can do better, feel free to open a PR. Or you can open an issue. PRs are more cool though!

mattleibow added the backport/release/2.x Backport this PR to release/2.x label Sep 18, 2023

mattleibow force-pushed the dev/mt-main branch from de89c99 to fc04fc6 Compare January 10, 2024 20:45

mattleibow closed this Jan 10, 2024

mattleibow reopened this Jan 10, 2024

mattleibow changed the title ~~Add support for multi-thread wasm blazor~~ Add support for multi-thread and/or SIMD WebAssembly Mar 1, 2024

mattleibow removed the backport/release/2.x Backport this PR to release/2.x label Mar 1, 2024

mattleibow mentioned this pull request Mar 1, 2024

[release/2.x] Add support for multi-thread wasm blazor #2619

Closed

5 tasks

mattleibow added 4 commits March 27, 2024 22:29

Add support for multi-thread wasm blazor

af82561

Order the folder name parts (#2774)

911fe98

this

68ca253

handle the matrix of st/mt and /simd/non-simd

1268755

mattleibow force-pushed the dev/mt-main branch from 0db2b05 to 1268755 Compare March 27, 2024 20:29

mattleibow mentioned this pull request Sep 18, 2024

Update .NET to 8.0 #2927

Merged

Merge branch 'main' into dev/mt-main

4f0bd19

mattleibow mentioned this pull request Sep 28, 2024

[release/2.x] feat: Add support for .NET 9 #3012

Merged

maxkatz6 reviewed Sep 28, 2024

View reviewed changes

mattleibow commented Sep 30, 2024

View reviewed changes

Merge remote-tracking branch 'origin/main' into dev/mt-main

917c987

Merge remote-tracking branch 'origin/main' into dev/mt-main

15897ac

# Conflicts: # scripts/azure-templates-stages.yml

mattleibow added 2 commits October 25, 2024 21:21

wasm things

cad4cb1

Added a sample

5d4d9f4

mattleibow merged commit 9bea7b2 into main Oct 28, 2024
2 checks passed

mattleibow deleted the dev/mt-main branch October 28, 2024 12:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for multi-thread and/or SIMD WebAssembly #2620

Add support for multi-thread and/or SIMD WebAssembly #2620

mattleibow commented Sep 18, 2023 •

edited

Loading

mattleibow commented Mar 27, 2024 •

edited

Loading

mattleibow commented Sep 18, 2024

maxkatz6 Sep 28, 2024

maxkatz6 Sep 28, 2024

mattleibow Sep 30, 2024 •

edited

Loading

jeromelaban Sep 30, 2024 •

edited

Loading

maxkatz6 Sep 30, 2024

maxkatz6 Oct 27, 2024

mattleibow Oct 27, 2024

maxkatz6 Oct 27, 2024

maxkatz6 Oct 27, 2024

mattleibow Oct 27, 2024 •

edited

Loading

mattleibow Sep 30, 2024

mattleibow commented Oct 25, 2024

jeromelaban commented Oct 25, 2024

mattleibow commented Oct 25, 2024 •

edited

Loading

jeromelaban commented Oct 25, 2024

mattleibow commented Oct 25, 2024 •

edited

Loading

lewing commented Oct 25, 2024

maxkatz6 commented Oct 27, 2024

mattleibow commented Oct 28, 2024

Add support for multi-thread and/or SIMD WebAssembly #2620

Add support for multi-thread and/or SIMD WebAssembly #2620

Conversation

mattleibow commented Sep 18, 2023 • edited Loading

mattleibow commented Mar 27, 2024 • edited Loading

mattleibow commented Sep 18, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mattleibow Sep 30, 2024 • edited Loading

Choose a reason for hiding this comment

jeromelaban Sep 30, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mattleibow Oct 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mattleibow commented Oct 25, 2024

jeromelaban commented Oct 25, 2024

mattleibow commented Oct 25, 2024 • edited Loading

jeromelaban commented Oct 25, 2024

mattleibow commented Oct 25, 2024 • edited Loading

lewing commented Oct 25, 2024

maxkatz6 commented Oct 27, 2024

mattleibow commented Oct 28, 2024

mattleibow commented Sep 18, 2023 •

edited

Loading

mattleibow commented Mar 27, 2024 •

edited

Loading

mattleibow Sep 30, 2024 •

edited

Loading

jeromelaban Sep 30, 2024 •

edited

Loading

mattleibow Oct 27, 2024 •

edited

Loading

mattleibow commented Oct 25, 2024 •

edited

Loading

mattleibow commented Oct 25, 2024 •

edited

Loading