Use non-generic Array.Sort in EnumInfo on nativeaot

[stephentoub]

Contributes to #79437

@jkotas, worthwhile? We'll pay boxing costs as part of the sort, but it should be only once per enum and only if the values aren't already sorted.

[ghost]

I couldn't figure out the best area label to add to this PR. If you have write-permissions please help me learn by adding exactly one area label.

[hez2010]

I personally would like to take the size regression rather than the unnecessary boxing overhead (it's important for game development)

[MichalPetryka]

I personally would like to take the size regression rather than the unnecessary boxing overhead (it's important for game development)

The boxing here is one time, in fact I feel like having to JIT multiple times would take more than boxing. Not sure about the AreSorted checks though.

[hez2010]

JIT multiple times would take more than boxing

NativeAOT won't JIT at runtime.

[jkotas]

This does not actual help much (HelloWorld before this change 2,904,576, after this change 2,897,920). The non-generic Array.Sort is special-cased for primitive types

runtime/src/libraries/System.Private.CoreLib/src/System/Array.cs

Line 1870 in fcff857

case CorElementType.ELEMENT_TYPE_I1:

. It means we still get the Sort specializations for most primitive types.

I have tried the following:

            if (!Enum.AreSorted(values))
            {
                object[] boxes = new object[values.Length];
                for (int i = 0; i < values.Length; i++)
                    boxes[i] = values[i];

                Array.Sort(keys: boxes, items: names); // using object overload to avoid generic expansion for every underlying enum type

                for (int i = 0; i < values.Length; i++)
                    values[i] = (TUnderlyingValue)boxes[i];
            }

It brought the size down to 2,819,072.

The nativeaot reflection stack reads the enum values as underlying value boxes first. We can save the potential boxing and avoid some of the code duplication by sorting the enum values in the reflection stack while we have the boxes around, pass it as object[] to EnumInfo constructor like what it was done before this change, and the EnumInfo constructor can just assert that the values are sorted.

The best solution for the sort footprint problem would be to sort the values at aot compilation time. It would make the sort go away completely.

[jkotas]

For reference, this is my workflow for using local native AOT builds:

1. `build.cmd -s clr.aot+libs+packs -c Release` (it fails when building packs - ignore the error)

Create native AOT hello world that points to your artifacts directory:

1. `dotnet new console`
2. `dotnet new nugetconfig`
3. Replace the feed in nuget.config to point to your artifacts directory 
 
 <packageSources>
    <add key="nuget" value="C:\runtime\artifacts\packages\Release\Shipping" />
  </packageSources>


4. Add this to .csproj

<PropertyGroup>
  <PublishAot>true</PublishAot>
</PropertyGroup>

<ItemGroup>
  <PackageReference Include="Microsoft.DotNet.ILCompiler" Version="8.0.0-dev" />
</ItemGroup>


5. `dotnet publish -c Release -r win-x64 --packages pkg`. The native aot compiled .exe is going to be `bin\Release\net7.0\win-x64\publish\*.exe`
6. `rmdir /s /q bin obj pkg` to pickup a new local build

[stephentoub]

We can close this then and I can revisit in January, unless you'd like to take it over before then.

[jkotas]

I can take it over.

[stephentoub]

The non-generic Array.Sort is special-cased for primitive types

Those generic specializations won't actually be used here, though, as this check won't be met:

if (items == null || items.GetCorElementTypeOfElementType() == et)

I assume the nativeaot compiler can't see that?

[jkotas]

I assume the nativeaot compiler can't see that?

Right. Our codegen does not perform global optimizations like this today. The codegen can only see things like this through aggressive inlining that is very limited.

[stephentoub]

Thanks. I know that's true with the JIT; I incorrectly thought we did more whole-program optimization like that with nativeaot.

[jkotas]

@MichalStrehovsky PTLA

This fixes some of the size regression by reverting to non-specialized sort, similar to what we have used before.

[MichalStrehovsky]

Thank you!

For the "sort in the compiler TODO" - we would have to do this by sorting the fields themselves. Do we have any compat concerns around doing that? .NET Native used to come up with random order of metadata and I do recall it being a problem (not for enums, but in general).

[jkotas]

we would have to do this by sorting the fields themselves. Do we have any compat concerns around doing that?

Good point. We have fixed reflection to return *Infos in metadata order for predictability, so this would regress the behavior. I will delete the TODO.