BenchmarkDotNet NativeAot10_0 error

[kimdiego2098]

Error:

  System.CommandLine.CommandLineException: Unrecognized instruction set popcnt
     at System.CommandLine.Helpers.ConfigureInstructionSetSupport(String, Int32, Boolean, TargetArchitecture, TargetOS, String, String, Logger, Boolean) + 0xcca
     at ILCompiler.Program.Run() + 0x7a1
     at ILCompiler.ILCompilerRootCommand.<>c__DisplayClass261_0.<.ctor>b__0(ParseResult) + 0x31f

Info:

.NET SDK:
 Version:           10.0.100-rc.2.25502.107
 Commit:            89c8f6a112
 Workload version:  10.0.100-manifests.4d32cd9e
 MSBuild version:   18.0.0-preview-25502-107+89c8f6a11


 OS Name:     Windows
 OS Version:  10.0.19045
 OS Platform: Windows
 RID:         win-x64
 Base Path:   C:\Program Files\dotnet\sdk\10.0.100-rc.2.25502.107\

Host:
  Version:      10.0.0-rc.2.25502.107
  Architecture: x64
  Commit:       89c8f6a112

I set the Attribute

//[SimpleJob(RuntimeMoniker.Net80)]
//[SimpleJob(RuntimeMoniker.NativeAot80)]
//[SimpleJob(RuntimeMoniker.Net10_0)]
[SimpleJob(RuntimeMoniker.NativeAot10_0)]
[MemoryDiagnoser]

Net80 and NativeAot80 and Net10-0 runs well, but NativeAut10-0 has the following errors

  Generating native code
EXEC : error : Unrecognized instruction set popcnt [E:\ThingsGateway_AOT\ThingsGateway.Foundation.Benchmark\bin\Release\net10.0\ThingsGateway.Foundation.Benchmark-1\BenchmarkDotNet.Autogenerated.csproj]
  System.CommandLine.CommandLineException: Unrecognized instruction set popcnt
     at System.CommandLine.Helpers.ConfigureInstructionSetSupport(String, Int32, Boolean, TargetArchitecture, TargetOS, String, String, Logger, Boolean) + 0xcca
     at ILCompiler.Program.Run() + 0x7a1
     at ILCompiler.ILCompilerRootCommand.<>c__DisplayClass261_0.<.ctor>b__0(ParseResult) + 0x31f

The following is the content of BenchmarkDotNet.Autogenerated.cproj

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <ImportDirectoryBuildProps>false</ImportDirectoryBuildProps>
    <ImportDirectoryBuildTargets>false</ImportDirectoryBuildTargets>
    <OutputType>Exe</OutputType>
    <TargetFramework>net10.0</TargetFramework>
    <RuntimeIdentifier>win-x64</RuntimeIdentifier>
    <RuntimeFrameworkVersion></RuntimeFrameworkVersion>
    <AssemblyName>ThingsGateway.Foundation.Benchmark-1</AssemblyName>
    <AssemblyTitle>ThingsGateway.Foundation.Benchmark-1</AssemblyTitle>
    <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
    <PlatformTarget>x64</PlatformTarget>
    <TreatWarningsAsErrors>False</TreatWarningsAsErrors>
    <DebugSymbols>false</DebugSymbols>
    <UseSharedCompilation>false</UseSharedCompilation>
    <Deterministic>true</Deterministic>
    <RunAnalyzers>false</RunAnalyzers>
    <PublishAot Condition="$([MSBuild]::VersionGreaterThan('$(NETCoreSdkVersion)', '6.0'))">true</PublishAot>
    <IlcOptimizationPreference>Speed</IlcOptimizationPreference>
    <OptimizationPreference>Speed</OptimizationPreference>
    <TrimMode>link</TrimMode><TrimmerDefaultAction>link</TrimmerDefaultAction>
    <IlcGenerateStackTraceData>True</IlcGenerateStackTraceData>
    <StackTraceSupport>True</StackTraceSupport>
    <EnsureNETCoreAppRuntime>false</EnsureNETCoreAppRuntime> <!-- workaround for 'This runtime may not be supported by.NET Core.' error -->
    <ErrorOnDuplicatePublishOutputFiles>false</ErrorOnDuplicatePublishOutputFiles> <!-- workaround for 'Found multiple publish output files with the same relative path.' error -->
    <ValidateExecutableReferencesMatchSelfContained>false</ValidateExecutableReferencesMatchSelfContained>
    <SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings> <!-- Suppress warning for nuget package used in old (unsupported) tfm. -->
    <IlcInstructionSet>base,sse4.2,popcnt,avx,avx2,bmi,bmi2,fma,lzcnt,aes,pclmul</IlcInstructionSet>
  </PropertyGroup>
  <PropertyGroup>
<ServerGarbageCollection>false</ServerGarbageCollection>
<ConcurrentGarbageCollection>true</ConcurrentGarbageCollection>
</PropertyGroup>

  <ItemGroup>
    <Compile Include="ThingsGateway.Foundation.Benchmark-1.notcs" Exclude="bin\**;obj\**;**\*.xproj;packages\**" />
  </ItemGroup>
  <ItemGroup>
    
    <ProjectReference Include="E:\ThingsGateway_AOT\ThingsGateway.Foundation.Benchmark\ThingsGateway.Foundation.Benchmark.csproj" />
  </ItemGroup>
  <ItemGroup>
    <RdXmlFile Include="bdn_generated.rd.xml" />
  </ItemGroup>

</Project>

[timcassell]

cc @tannergooding

[tannergooding]

Is BDN choosing to use the .NET 10 SDK and therefore .NET 10 specific version of ilc (the nativeaot compiler) when compiling .NET 8?

The logic was already updated to pass down the correct arguments for each TFM, so that'd be the only way such a failure would be happening.

[timcassell]

Is BDN choosing to use the .NET 10 SDK and therefore .NET 10 specific version of ilc (the nativeaot compiler) when compiling .NET 8?

What do you mean? It's not compiling .Net 8. <TargetFramework>net10.0</TargetFramework>

@kimdiego2098 What version of BDN are you using?

[tannergooding]

What do you mean? It's not compiling .Net 8. net10.0

Ah, I see. I misread what was being tested and failing for the RuntimeMoniker set (i.e. what BDN will be testing regardless of the csproj settings).

#2828 is what updated BDN to correctly support the .NET 10 changes and these lines in particular should be ensuring that popcnt isn't added except for runtimeMoniker <= RuntimeMoniker.NativeAot90: https://github.com/dotnet/BenchmarkDotNet/pull/2828/files#diff-ee960f66dfd5d8c51863f36aed97e556d3d8dd8b521d60a08a1b2418eaf91c19R259-R263

[kimdiego2098]

using BenchmarkDotNet.Attributes;
using BenchmarkDotNet.Environments;
using BenchmarkDotNet.Jobs;
using BenchmarkDotNet.Toolchains.NativeAot;

[AttributeUsage(AttributeTargets.Class)]
public sealed class CustomNativeAot10_0Attribute : JobConfigBaseAttribute
{
    public CustomNativeAot10_0Attribute() : base(CreateCustomJob()) { }

    private static Job CreateCustomJob()
    {
        var toolchain = NativeAotToolchain.CreateBuilder()
            .UseNuGet()
            .IlcInstructionSet(GetNativeInstructionSets())// 设置指令集
            .TargetFrameworkMoniker("net10.0")
            .ToToolchain();

        return Job.Default
            .WithRuntime(NativeAotRuntime.Net10_0) // AOT 运行时
            .WithToolchain(toolchain)
            .WithId("NativeAot 10.0");
    }
    static string GetNativeInstructionSets()
    {
        List<string> sets = new() { "base" };

        if (System.Runtime.Intrinsics.X86.Sse42.IsSupported)
            sets.Add("sse4.2");

        if (System.Runtime.Intrinsics.X86.Avx.IsSupported)
            sets.Add("avx");

        if (System.Runtime.Intrinsics.X86.Avx2.IsSupported)
            sets.Add("avx2");

        if (System.Runtime.Intrinsics.X86.Avx512F.IsSupported)
            sets.Add("avx512");

        return string.Join(',', sets);
    }

}


[SimpleJob(RuntimeMoniker.Net80, baseline: true)]
[SimpleJob(RuntimeMoniker.NativeAot80)]
[SimpleJob(RuntimeMoniker.Net10_0)]
[CustomNativeAot10_0]
[MemoryDiagnoser]
public class ModbusBenchmark : IDisposable
{

}

IlcInstructionSet is work，After setting, everything is normal

[timcassell]

@kimdiego2098 That doesn't tell us what version of BDN you are using. That workaround should not be necessary if you are using the latest version.

[kimdiego2098]

BDN version is 0.15.5

[filzrev]

It seems NativeAot flag is dropped on following lines.

BenchmarkDotNet/src/BenchmarkDotNet/Toolchains/NativeAot/Generator.cs

Lines 184 to 188 in 6d2e1c7

	private string GetInstructionSetSettings(BuildPartition buildPartition)
	{
	string instructionSet = ilcInstructionSet ?? GetCurrentInstructionSet(buildPartition.Platform);
	return !string.IsNullOrEmpty(instructionSet) ? $"<IlcInstructionSet>{instructionSet}</IlcInstructionSet>" : "";
	}

I thought It need to pass buildPartition.IsNativeAot flag also,
And need to resolve proper RuntimeMoniker by using Platform and IsNativeAot flag.

On current behavior. RuntimeMoniker is resolved to Net10_0 (It's expected to be resolved to NativeAot10_0)

And following code path is always used.

BenchmarkDotNet/src/BenchmarkDotNet/Toolchains/NativeAot/Generator.cs

Line 262 in 6d2e1c7

if (runtimeMoniker <= RuntimeMoniker.NativeAot90) yield return "popcnt";

and popcnt is added on IlcInstructionSet.

<IlcInstructionSet>base,sse4.2,popcnt,avx,avx2,bmi,bmi2,fma,lzcnt,aes,pclmul</IlcInstructionSet>

[timcassell]

The issue is actually just that we parse the MSBuild tfm, we aren't using the correct moniker from the NativeAotRuntime (another side-effect of #2609). Quick-fix is in #2852.