dotnet/runtime

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

开放

#77,969 创建于 2022年11月7日

 (6 条评论) (2 个反应) (0 位负责人)C# (5,445 个派生)batch import
area-System.Numericshelp wanted

仓库指标

星标
 (17,886 个星标)
PR 合并指标
 (平均合并 12天 11小时) (30 天内合并 661 个 PR)

描述

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.

贡献者指南