dotnet/runtime

Perf-trap with `IBinaryInteger<T>.WriteLittleEndian`

Open

#77.969 aperta il 7 nov 2022

Vedi su GitHub
 (6 commenti) (2 reazioni) (0 assegnatari)C# (5445 fork)batch import
area-System.Numericshelp wanted

Metriche repository

Star
 (17.886 star)
Metriche merge PR
 (Merge medio 12g 11h) (661 PR mergiate in 30 g)

Descrizione

https://github.com/dotnet/runtime/pull/67939 added IBinaryInteger<T>.WriteLittleEndian as default interface method around TryWriteLittleEndian which is implemented by the numeric types.

The problem with the DIM is that value types get boxed, thus leading to unexpected allocations as encountered in https://github.com/dotnet/orleans/pull/8100#discussion_r1015299807.

Repro:

using System.Numerics;

Span<byte> span = stackalloc byte[128];
int value = 42;

for (int i = 0; i < 1_000_000; ++i)
{
    WriteLittleEndian(span, value);
}

int collections = GC.CollectionCount(0);
Console.WriteLine($"Collected: {(collections == 0 ? "no" : "yes")}");

static void WriteLittleEndian<T>(Span<byte> buffer, T value) where T : struct, IBinaryInteger<T>
{
    value.WriteLittleEndian(buffer);
}

Mitigation is

static void WriteLittleEndian<T>(Span<byte> buffer, T value) where T : struct, IBinaryInteger<T>
{
-    value.WriteLittleEndian(buffer);
+    value.TryWriteLittleEndian(buffer, out _);
}

But that is non-intuitive.

It would be better to either remove the DIM and implement that method on the concrete types (code duplication) or to make it a static virtual interface method. The latter would be a breaking change and for .NET 7 it's too late (I fear). Or there's some compiler magic to undo the boxing.

Guida contributor