micro-optimizations in ProtocolWriter (#329)

* micro-optimizations in ProtocolWriter Signed-off-by: Caleb Lloyd <caleb@synadia.com> * fix constants bench Signed-off-by: Caleb Lloyd <caleb@synadia.com> * fix comment Signed-off-by: Caleb Lloyd <caleb@synadia.com> --------- Signed-off-by: Caleb Lloyd <caleb@synadia.com>
nats-io · Jan 12, 2024 · 1bdf319 · 1bdf319
1 parent ff8a8f0
commit 1bdf319
Show file tree

Hide file tree

Showing 4 changed files with 268 additions and 86 deletions.
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -1,5 +1,6 @@
 <Project>
     <PropertyGroup>
+        <LangVersion>latest</LangVersion>
         <Nullable>enable</Nullable>
         <NoWarn>$(NoWarn);CS1591;SA0001</NoWarn>
         <SignAssembly>true</SignAssembly>

diff --git a/sandbox/MicroBenchmark/CommandConstantsBench.cs b/sandbox/MicroBenchmark/CommandConstantsBench.cs
@@ -0,0 +1,162 @@
+using System.Buffers.Binary;
+using BenchmarkDotNet.Attributes;
+
+namespace MicroBenchmark;
+
+[MemoryDiagnoser]
+[ShortRunJob]
+[PlainExporter]
+public class CommandConstantsBench
+{
+    private const ushort NewLineConst = '\r' + ('\n' << 4);
+    private const uint PubSpaceConst = 'P' + ('U' << 8) + ('B' << 16) + (' ' << 24);
+    private const ulong ConnectSpaceConst = 'C' + ('O' << 8) + ('N' << 16) + ('N' << 24) + ((ulong)'E' << 32) + ((ulong)'C' << 40) + ((ulong)'T' << 48) + ((ulong)' ' << 56);
+
+    private static readonly byte[] Bytes = new byte[8];
+    private static readonly ushort NewLineReadonly = BinaryPrimitives.ReadUInt16LittleEndian("\r\n"u8);
+    private static readonly uint PubSpaceReadonly = BinaryPrimitives.ReadUInt32LittleEndian("PUB "u8);
+    private static readonly ulong ConnectSpaceReadonly = BinaryPrimitives.ReadUInt64LittleEndian("CONNECT "u8);
+
+    [Params(1_000_000)]
+    public int Iter { get; set; }
+
+    [Params(2, 4, 8)]
+    public int Size { get; set; }
+
+    private static ReadOnlySpan<byte> NewLine => "\r\n"u8;
+
+    private static ReadOnlySpan<byte> PubSpace => "PUB "u8;
+
+    private static ReadOnlySpan<byte> ConnectSpace => "CONNECT "u8;
+
+    [Benchmark]
+    public void PubCopy()
+    {
+        var dest = Bytes.AsSpan();
+        switch (Size)
+        {
+        case 2:
+            for (var i = 0; i < Iter; i++)
+            {
+                NewLine.CopyTo(dest);
+            }
+
+            break;
+        case 4:
+            for (var i = 0; i < Iter; i++)
+            {
+                PubSpace.CopyTo(dest);
+            }
+
+            break;
+        case 8:
+            for (var i = 0; i < Iter; i++)
+            {
+                ConnectSpace.CopyTo(dest);
+            }
+
+            break;
+        }
+    }
+
+    [Benchmark]
+    public void PubSetIndex()
+    {
+        var dest = Bytes.AsSpan();
+        switch (Size)
+        {
+        case 2:
+            for (var i = 0; i < Iter; i++)
+            {
+                dest[0] = (byte)'\r';
+                dest[1] = (byte)'\n';
+            }
+
+            break;
+        case 4:
+            for (var i = 0; i < Iter; i++)
+            {
+                dest[0] = (byte)'P';
+                dest[1] = (byte)'U';
+                dest[2] = (byte)'B';
+                dest[3] = (byte)' ';
+            }
+
+            break;
+        case 8:
+            for (var i = 0; i < Iter; i++)
+            {
+                dest[0] = (byte)'C';
+                dest[1] = (byte)'O';
+                dest[2] = (byte)'N';
+                dest[3] = (byte)'N';
+                dest[4] = (byte)'E';
+                dest[5] = (byte)'C';
+                dest[6] = (byte)'T';
+                dest[7] = (byte)' ';
+            }
+
+            break;
+        }
+    }
+
+    [Benchmark]
+    public void PubBinaryConst()
+    {
+        var dest = Bytes.AsSpan();
+        switch (Size)
+        {
+        case 2:
+            for (var i = 0; i < Iter; i++)
+            {
+                BinaryPrimitives.WriteUInt16LittleEndian(dest, NewLineConst);
+            }
+
+            break;
+        case 4:
+            for (var i = 0; i < Iter; i++)
+            {
+                BinaryPrimitives.WriteUInt32LittleEndian(dest, PubSpaceConst);
+            }
+
+            break;
+        case 8:
+            for (var i = 0; i < Iter; i++)
+            {
+                BinaryPrimitives.WriteUInt64LittleEndian(dest, ConnectSpaceConst);
+            }
+
+            break;
+        }
+    }
+
+    [Benchmark]
+    public void PubBinaryReadonly()
+    {
+        var dest = Bytes.AsSpan();
+        switch (Size)
+        {
+        case 2:
+            for (var i = 0; i < Iter; i++)
+            {
+                BinaryPrimitives.WriteUInt16LittleEndian(dest, NewLineReadonly);
+            }
+
+            break;
+        case 4:
+            for (var i = 0; i < Iter; i++)
+            {
+                BinaryPrimitives.WriteUInt32LittleEndian(dest, PubSpaceReadonly);
+            }
+
+            break;
+        case 8:
+            for (var i = 0; i < Iter; i++)
+            {
+                BinaryPrimitives.WriteUInt64LittleEndian(dest, ConnectSpaceReadonly);
+            }
+
+            break;
+        }
+    }
+}
diff --git a/sandbox/MicroBenchmark/MicroBenchmark.csproj b/sandbox/MicroBenchmark/MicroBenchmark.csproj
@@ -2,16 +2,15 @@
 
     <PropertyGroup>
         <OutputType>Exe</OutputType>
-        <TargetFramework>net6.0</TargetFramework>
+        <TargetFramework>net8.0</TargetFramework>
         <ImplicitUsings>enable</ImplicitUsings>
         <Nullable>enable</Nullable>
         <IsPackable>false</IsPackable>
         <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="BenchmarkDotNet" Version="0.13.8" />
-        <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="6.0.0" />
+        <PackageReference Include="BenchmarkDotNet" Version="0.13.12" />
         <PackageReference Include="StackExchange.Redis" Version="2.5.43" />
         <PackageReference Include="ZLogger" Version="1.6.1" />
         <PackageReference Include="NATS.Client" Version="0.14.5" />