[wasm] Improve the autogenerated project (#1936)

* Remove `runtimeSrcDir` command line parameter used by wasm

* [wasm] Update the autogenerated project

- Use a single template project file
- Automatically import any `$projectName.Wasm.props`, and
  `$projectName.Wasm.targets` files, if found.
  - This allows the actual project to control settings for the generated
    project, eg, for modifying the wasm build to add some files to the
    wasm vfs.

Author: radical

src/BenchmarkDotNet/ConsoleArguments/CommandLineOptions.cs

@@ -187,9 +187,6 @@ public class CommandLineOptions
         [Option("AOTCompilerMode", Required = false, Default = MonoAotCompilerMode.mini, HelpText = "Mono AOT compiler mode, either 'mini' or 'llvm'")]
         public MonoAotCompilerMode AOTCompilerMode { get; set; }
 
-        [Option("runtimeSrcDir", Required = false, HelpText = "Path to a local copy of dotnet/runtime. . Used by the WASM toolchain when AOTCompilerMode is 'wasm'.")]
-        public DirectoryInfo RuntimeSrcDir { get; set; }
-
         internal bool UserProvidedFilters => Filters.Any() || AttributeNames.Any() || AllCategories.Any() || AnyCategories.Any();
 
         [Usage(ApplicationAlias = "")]

src/BenchmarkDotNet/ConsoleArguments/ConfigParser.cs

@@ -97,21 +97,6 @@ private static Parser CreateParser(ILogger logger)
                 settings.MaximumDisplayWidth = Math.Max(MinimumDisplayWidth, GetMaximumDisplayWidth());
             });
 
-        private static bool MonikerIsWasm(RuntimeMoniker moniker)
-
-        {
-            switch (moniker)
-            {
-                case RuntimeMoniker.Wasm:
-                case RuntimeMoniker.WasmNet50:
-                case RuntimeMoniker.WasmNet60:
-                case RuntimeMoniker.WasmNet70:
-                    return true;
-                default:
-                    return false;
-            }
-        }
-
         private static bool Validate(CommandLineOptions options, ILogger logger)
         {
             if (!AvailableJobs.ContainsKey(options.BaseJob))
@@ -131,12 +116,6 @@ private static bool Validate(CommandLineOptions options, ILogger logger)
                 {
                      logger.WriteLineError($"The provided {nameof(options.AOTCompilerPath)} \"{ options.AOTCompilerPath }\" does NOT exist. It MUST be provided.");
                 }
-                else if (MonikerIsWasm(runtimeMoniker) && (options.RuntimeSrcDir == null || options.RuntimeSrcDir.IsNotNullButDoesNotExist()))
-
-                {
-                    logger.WriteLineError($"The provided {nameof(options.RuntimeSrcDir)} \"{options.RuntimeSrcDir}\" does NOT exist. It MUST be provided for wasm-aot.");
-                    return false;
-                }
             }
 
             foreach (string exporter in options.Exporters)
@@ -447,7 +426,6 @@ private static Job MakeWasmJob(Job baseJob, CommandLineOptions options, string m
                 javaScriptEngine: options.WasmJavascriptEngine?.FullName ?? "v8",
                 javaScriptEngineArguments: options.WasmJavaScriptEngineArguments,
                 aot: wasmAot,
-                runtimeSrcDir: options.RuntimeSrcDir,
                 moniker: moniker);
 
             var toolChain = WasmToolChain.From(new NetCoreAppSettings(

src/BenchmarkDotNet/Environments/Runtimes/WasmRuntime.cs

@@ -16,8 +16,6 @@ public class WasmRuntime : Runtime, IEquatable<WasmRuntime>
 
         public bool Aot { get;  }
 
-        public DirectoryInfo RuntimeSrcDir { get;  }
-
         /// <summary>
         /// creates new instance of WasmRuntime
         /// </summary>
@@ -26,25 +24,23 @@ public class WasmRuntime : Runtime, IEquatable<WasmRuntime>
         /// <param name="msBuildMoniker">moniker, default: "net5.0"</param>
         /// <param name="displayName">default: "Wasm"</param>
         /// <param name="aot">Specifies whether AOT or Interpreter (default) project should be generated.</param>
-        /// <param name="runtimeSrcDir">The path to runtime source directory.</param>
-        public WasmRuntime(string msBuildMoniker = "net5.0", string displayName = "Wasm", string javaScriptEngine = "v8", string javaScriptEngineArguments = "--expose_wasm", bool aot = false, DirectoryInfo runtimeSrcDir = null, RuntimeMoniker moniker = RuntimeMoniker.Wasm) : base(moniker, msBuildMoniker, displayName)
+        public WasmRuntime(string msBuildMoniker = "net5.0", string displayName = "Wasm", string javaScriptEngine = "v8", string javaScriptEngineArguments = "--expose_wasm", bool aot = false, RuntimeMoniker moniker = RuntimeMoniker.Wasm) : base(moniker, msBuildMoniker, displayName)
         {
             if (!string.IsNullOrEmpty(javaScriptEngine) && javaScriptEngine != "v8" && !File.Exists(javaScriptEngine))
                 throw new FileNotFoundException($"Provided {nameof(javaScriptEngine)} file: \"{javaScriptEngine}\" doest NOT exist");
 
             JavaScriptEngine = javaScriptEngine;
             JavaScriptEngineArguments = javaScriptEngineArguments;
             Aot = aot;
-            RuntimeSrcDir = runtimeSrcDir;
         }
 
         public override bool Equals(object obj)
             => obj is WasmRuntime other && Equals(other);
 
         public bool Equals(WasmRuntime other)
-            => other != null && base.Equals(other) && other.JavaScriptEngine == JavaScriptEngine && other.JavaScriptEngineArguments == JavaScriptEngineArguments && other.Aot == Aot && other.RuntimeSrcDir == RuntimeSrcDir;
+            => other != null && base.Equals(other) && other.JavaScriptEngine == JavaScriptEngine && other.JavaScriptEngineArguments == JavaScriptEngineArguments && other.Aot == Aot;
 
         public override int GetHashCode()
-            => base.GetHashCode() ^ (JavaScriptEngine?.GetHashCode() ?? 0) ^ (JavaScriptEngineArguments?.GetHashCode() ?? 0 ^ Aot.GetHashCode() ^ (RuntimeSrcDir?.GetHashCode() ?? 0));
+            => base.GetHashCode() ^ (JavaScriptEngine?.GetHashCode() ?? 0) ^ (JavaScriptEngineArguments?.GetHashCode() ?? 0 ^ Aot.GetHashCode());
     }
 }

src/BenchmarkDotNet/Templates/WasmAotCsProj.txt

@@ -1,42 +1,51 @@
 <Project Sdk="$SDKNAME$" DefaultTargets="publish">
+  <PropertyGroup>
+    <OriginalCSProjPath>$CSPROJPATH$</OriginalCSProjPath>
+    <WasmPropsPath>$([System.IO.Path]::ChangeExtension('$(OriginalCSProjPath)', '.Wasm.props'))</WasmPropsPath>
+    <WasmTargetsPath>$([System.IO.Path]::ChangeExtension('$(OriginalCSProjPath)', '.Wasm.targets'))</WasmTargetsPath>
+  </PropertyGroup>
+
+  <Import Project="$(WasmPropsPath)" Condition="Exists($(WasmPropsPath))" />
+
   <PropertyGroup>
     <OutputType>Exe</OutputType>
     <OutputPath>bin</OutputPath>
-    <RuntimeSrcDir>$RUNTIMESRCDIR$</RuntimeSrcDir>
     <RuntimeConfig>Release</RuntimeConfig>
     <EnableDefaultCompileItems>false</EnableDefaultCompileItems>
     <TargetFramework>$TFM$</TargetFramework>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     <AppDir>$(MSBuildThisFileDirectory)\bin\$TFM$\browser-wasm\publish</AppDir>
     <AssemblyName>$PROGRAMNAME$</AssemblyName>
     <RuntimeIdentifier>browser-wasm</RuntimeIdentifier>
-    <PublishTrimmed>false</PublishTrimmed>
-    <RunAOTCompilation>false</RunAOTCompilation>
-    <WasmMainJSPath>$(RuntimeSrcDir)\src\mono\wasm\$MAINJS$</WasmMainJSPath>
+    <SuppressTrimAnalysisWarnings>true</SuppressTrimAnalysisWarnings>
+    <RunAOTCompilation>$RUN_AOT$</RunAOTCompilation>
+    <PublishTrimmed>$(RunAOTCompilation)</PublishTrimmed>
     <WasmGenerateRunV8Script>true</WasmGenerateRunV8Script>
     <ValidateExecutableReferencesMatchSelfContained>false</ValidateExecutableReferencesMatchSelfContained>
-    <WasmNativeWorkload>false</WasmNativeWorkload>
-    <UsingBrowserRuntimeWorkload>false</UsingBrowserRuntimeWorkload>
+    <EnableDefaultWasmAssembliesToBundle>false</EnableDefaultWasmAssembliesToBundle>
     $COPIEDSETTINGS$
   </PropertyGroup>
 
-  <Import Project="$(RuntimeSrcDir)/src/mono/wasm/build/WasmApp.LocalBuild.props" />
-  <Import Project="$(RuntimeSrcDir)/src/mono/wasm/build/WasmApp.LocalBuild.targets" />
-
   <ItemGroup>
     <Compile Include="$CODEFILENAME$" Exclude="bin\**;obj\**;**\*.xproj;packages\**" />
+    <!-- move this too? -->
+    <TrimmerRootDescriptor Include="WasmLinkerDescription.xml" Condition="'$(RunAOTCompilation)' == 'true'" />
   </ItemGroup>
 
   <ItemGroup>
-    <ProjectReference Include="$CSPROJPATH$" />
+    <ProjectReference Include="$(OriginalCSProjPath)" />
   </ItemGroup>
 
   <PropertyGroup>
     <WasmBuildAppAfterThisTarget>PrepareForWasmBuild</WasmBuildAppAfterThisTarget>
   </PropertyGroup>
+
   <Target Name="PrepareForWasmBuild" AfterTargets="Publish">
     <ItemGroup>
-      <WasmAssembliesToBundle Include="$(TargetDir)publish\*.dll" />
+      <WasmAssembliesToBundle Include="$(TargetDir)publish\*.dll" Condition="'$(RunAOTCompilation)' != 'true'" />
+      <WasmAssembliesToBundle Include="$(TargetDir)publish\*.dll" Exclude="$(TargetDir)publish\KernelTraceControl.dll" Condition="'$(RunAOTCompilation)' == 'true'" />
     </ItemGroup>
   </Target>
+
+  <Import Project="$(WasmTargetsPath)" Condition="Exists($(WasmTargetsPath))" />
 </Project>

src/BenchmarkDotNet/Templates/WasmCsProj.txt

@@ -27,45 +27,17 @@ protected override void GenerateProject(BuildPartition buildPartition, Artifacts
         {
             if (((WasmRuntime)buildPartition.Runtime).Aot)
             {
-                GenerateProjectAot(buildPartition, artifactsPaths, logger);
+                GenerateProjectFile(buildPartition, artifactsPaths, aot: true, logger);
 
                 var linkDescriptionFileName = "WasmLinkerDescription.xml";
                 File.WriteAllText(Path.Combine(Path.GetDirectoryName(artifactsPaths.ProjectFilePath), linkDescriptionFileName), ResourceHelper.LoadTemplate(linkDescriptionFileName));
             } else
             {
-                GenerateProjectInterpreter(buildPartition, artifactsPaths, logger);
+                GenerateProjectFile(buildPartition, artifactsPaths, aot: false, logger);
             }
         }
 
-        protected  void GenerateProjectAot(BuildPartition buildPartition, ArtifactsPaths artifactsPaths, ILogger logger)
-        {
-            BenchmarkCase benchmark = buildPartition.RepresentativeBenchmarkCase;
-            var projectFile = GetProjectFilePath(benchmark.Descriptor.Type, logger);
-
-            WasmRuntime runtime = (WasmRuntime)buildPartition.Runtime;
-
-            using (var file = new StreamReader(File.OpenRead(projectFile.FullName)))
-            {
-                var (customProperties, sdkName) = GetSettingsThatNeedsToBeCopied(file, projectFile);
-
-                string content = new StringBuilder(ResourceHelper.LoadTemplate("WasmAotCsProj.txt"))
-                    .Replace("$PLATFORM$", buildPartition.Platform.ToConfig())
-                    .Replace("$CODEFILENAME$", Path.GetFileName(artifactsPaths.ProgramCodePath))
-                    .Replace("$CSPROJPATH$", projectFile.FullName)
-                    .Replace("$TFM$", TargetFrameworkMoniker)
-                    .Replace("$PROGRAMNAME$", artifactsPaths.ProgramName)
-                    .Replace("$RUNTIMESRCDIR$", runtime.RuntimeSrcDir.ToString())
-                    .Replace("$COPIEDSETTINGS$", customProperties)
-                    .Replace("$CONFIGURATIONNAME$", buildPartition.BuildConfiguration)
-                    .Replace("$SDKNAME$", sdkName)
-                    .Replace("$MAINJS$", MainJS)
-                    .ToString();
-
-                File.WriteAllText(artifactsPaths.ProjectFilePath, content);
-            }
-        }
-
-        protected void GenerateProjectInterpreter(BuildPartition buildPartition, ArtifactsPaths artifactsPaths, ILogger logger)
+        protected void GenerateProjectFile(BuildPartition buildPartition, ArtifactsPaths artifactsPaths, bool aot, ILogger logger)
         {
             BenchmarkCase benchmark = buildPartition.RepresentativeBenchmarkCase;
             var projectFile = GetProjectFilePath(benchmark.Descriptor.Type, logger);
@@ -79,14 +51,13 @@ protected void GenerateProjectInterpreter(BuildPartition buildPartition, Artifac
                 string content = new StringBuilder(ResourceHelper.LoadTemplate("WasmCsProj.txt"))
                     .Replace("$PLATFORM$", buildPartition.Platform.ToConfig())
                     .Replace("$CODEFILENAME$", Path.GetFileName(artifactsPaths.ProgramCodePath))
+                    .Replace("$RUN_AOT$", aot.ToString().ToLower())
                     .Replace("$CSPROJPATH$", projectFile.FullName)
                     .Replace("$TFM$", TargetFrameworkMoniker)
                     .Replace("$PROGRAMNAME$", artifactsPaths.ProgramName)
-                    .Replace("$RUNTIMESRCDIR$", runtime.RuntimeSrcDir.ToString())
                     .Replace("$COPIEDSETTINGS$", customProperties)
                     .Replace("$CONFIGURATIONNAME$", buildPartition.BuildConfiguration)
                     .Replace("$SDKNAME$", sdkName)
-                    .Replace("$RUNTIMEPACK$", CustomRuntimePack ?? "")
                     .Replace("$MAINJS$", MainJS)
                     .Replace("$TARGET$", CustomRuntimePack != null ? "PublishWithCustomRuntimePack" : "Publish")
                 .ToString();