Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[EXPERIMENTAL] NATS protocol parser #465

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

[EXPERIMENTAL] NATS protocol parser #465

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f25cbf8
NATS protocol parser
mtmk Apr 4, 2024
34cfc8a
wip
mtmk Apr 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions NATS.Client.sln
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Example.OpenTelemetry", "sa
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NATS.Net.OpenTelemetry.Tests", "tests\NATS.Net.OpenTelemetry.Tests\NATS.Net.OpenTelemetry.Tests.csproj", "{B8554582-DE19-41A2-9784-9B27C9F22429}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NatsProtocolParserProf", "NatsProtocolParserProf\NatsProtocolParserProf.csproj", "{1981B633-D522-4468-873D-5CC49B489159}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Expand Down Expand Up @@ -285,6 +287,10 @@ Global
{B8554582-DE19-41A2-9784-9B27C9F22429}.Debug|Any CPU.Build.0 = Debug|Any CPU
{B8554582-DE19-41A2-9784-9B27C9F22429}.Release|Any CPU.ActiveCfg = Release|Any CPU
{B8554582-DE19-41A2-9784-9B27C9F22429}.Release|Any CPU.Build.0 = Release|Any CPU
{1981B633-D522-4468-873D-5CC49B489159}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{1981B633-D522-4468-873D-5CC49B489159}.Debug|Any CPU.Build.0 = Debug|Any CPU
{1981B633-D522-4468-873D-5CC49B489159}.Release|Any CPU.ActiveCfg = Release|Any CPU
{1981B633-D522-4468-873D-5CC49B489159}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
Expand Down
14 changes: 14 additions & 0 deletions NatsProtocolParserProf/NatsProtocolParserProf.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
</PropertyGroup>

<ItemGroup>
<ProjectReference Include="..\src\NATS.Client.Core\NATS.Client.Core.csproj" />
</ItemGroup>

</Project>
137 changes: 137 additions & 0 deletions NatsProtocolParserProf/Program.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
// See https://aka.ms/new-console-template for more information

using System.Buffers;
using NATS.Client.Core;

var bench = new NatsProtoParserBench();
bench.Setup();

Console.WriteLine("Setup completed");
Console.ReadLine();

var count = 0;
for (var i = 0; i < 1_000_000; i++)
{
count += bench.Parse();
}

Console.WriteLine($"count: {count}");
Console.ReadLine();

public class NatsProtoParserBench
{
private List<ReadOnlySequence<byte>> _sequences = new();
private NatsProtocolParser _parser = new();

public void Setup()
{
_sequences =
[
new SequenceBuilder()
.Append("INFO {\"server_id\":\"nats-server\""u8.ToArray())
.Append("}\r"u8.ToArray())
.Append("\nPI"u8.ToArray())
.ReadOnlySequence,

new SequenceBuilder()
.Append("NG"u8.ToArray())
.Append("\r"u8.ToArray())
.Append("\n"u8.ToArray())
.Append("PO"u8.ToArray())
.ReadOnlySequence,

new SequenceBuilder()
.Append("NG\r\n"u8.ToArray())
.Append("+OK\r\n"u8.ToArray())
.Append("-ER"u8.ToArray())
.Append("R 'cra"u8.ToArray())
.Append("sh!'\r\nPI"u8.ToArray())
.Append("NG\r\n"u8.ToArray())
.ReadOnlySequence,

new SequenceBuilder()
.Append("MSG subject sid1 reply_to 1\r\nx\r\n"u8.ToArray())
.ReadOnlySequence,

new SequenceBuilder()
.Append("PING\r\n"u8.ToArray())
.ReadOnlySequence
];

_parser = new NatsProtocolParser();
}

public int Parse()
{
var tokenizer = new NatsProtocolParser.NatsTokenizer();
var count = 0;

foreach (var sequence in _sequences)
{
var buffer = sequence;

while (_parser.TryRead(ref tokenizer, ref buffer))
{
switch (_parser.Command)
{
case NatsProtocolParser.NatsTokenizer.Command.INFO:
case NatsProtocolParser.NatsTokenizer.Command.PING:
case NatsProtocolParser.NatsTokenizer.Command.PONG:
case NatsProtocolParser.NatsTokenizer.Command.OK:
case NatsProtocolParser.NatsTokenizer.Command.ERR:
case NatsProtocolParser.NatsTokenizer.Command.MSG:
count++;
break;
}

_parser.Reset();
}
}

if (count != 8)
throw new Exception("Invalid count");

return count;
}

private class BufferSegment : ReadOnlySequenceSegment<byte>
{
public void SetMemory(ReadOnlyMemory<byte> memory) => Memory = memory;

public void SetNextSegment(BufferSegment? segment) => Next = segment;

public void SetRunningIndex(int index) => RunningIndex = index;
}

private class SequenceBuilder
{
private BufferSegment? _start;
private BufferSegment? _end;
private int _length;

public ReadOnlySequence<byte> ReadOnlySequence => new(_start!, 0, _end!, _end!.Memory.Length);

// Memory is only allowed rent from ArrayPool.
public SequenceBuilder Append(ReadOnlyMemory<byte> buffer)
{
var segment = new BufferSegment();
segment.SetMemory(buffer);

if (_start == null)
{
_start = segment;
_end = segment;
}
else
{
_end!.SetNextSegment(segment);
segment.SetRunningIndex(_length);
_end = segment;
}

_length += buffer.Length;

return this;
}
}
}
128 changes: 128 additions & 0 deletions sandbox/MicroBenchmark/NatsProtoParserBench.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
using System.Buffers;
using BenchmarkDotNet.Attributes;
using NATS.Client.Core;

namespace MicroBenchmark;

[ShortRunJob]
[MemoryDiagnoser]
[PlainExporter]
public class NatsProtoParserBench
{
private List<ReadOnlySequence<byte>> _sequences = new();
private NatsProtocolParser _parser = new();

[GlobalSetup]
public void Setup()
{
_sequences =
[
new SequenceBuilder()
.Append("INFO {\"server_id\":\"nats-server\""u8.ToArray())
.Append("}\r"u8.ToArray())
.Append("\nPI"u8.ToArray())
.ReadOnlySequence,

new SequenceBuilder()
.Append("NG"u8.ToArray())
.Append("\r"u8.ToArray())
.Append("\n"u8.ToArray())
.Append("PO"u8.ToArray())
.ReadOnlySequence,

new SequenceBuilder()
.Append("NG\r\n"u8.ToArray())
.Append("+OK\r\n"u8.ToArray())
.Append("-ER"u8.ToArray())
.Append("R 'cra"u8.ToArray())
.Append("sh!'\r\nPI"u8.ToArray())
.Append("NG\r\n"u8.ToArray())
.ReadOnlySequence,

new SequenceBuilder()
.Append("MSG subject sid1 reply_to 1\r\nx\r\n"u8.ToArray())
.ReadOnlySequence,

new SequenceBuilder()
.Append("PING\r\n"u8.ToArray())
.ReadOnlySequence
];

_parser = new NatsProtocolParser();
}

[Benchmark]
public int Parse()
{
var tokenizer = new NatsProtocolParser.NatsTokenizer();
var count = 0;

foreach (var sequence in _sequences)
{
var buffer = sequence;

while (_parser.TryRead(ref tokenizer, ref buffer))
{
switch (_parser.Command)
{
case NatsProtocolParser.NatsTokenizer.Command.INFO:
case NatsProtocolParser.NatsTokenizer.Command.PING:
case NatsProtocolParser.NatsTokenizer.Command.PONG:
case NatsProtocolParser.NatsTokenizer.Command.OK:
case NatsProtocolParser.NatsTokenizer.Command.ERR:
case NatsProtocolParser.NatsTokenizer.Command.MSG:
count++;
break;
}

_parser.Reset();
}
}

if (count != 8)
throw new Exception("Invalid count");

return count;
}

private class BufferSegment : ReadOnlySequenceSegment<byte>
{
public void SetMemory(ReadOnlyMemory<byte> memory) => Memory = memory;

public void SetNextSegment(BufferSegment? segment) => Next = segment;

public void SetRunningIndex(int index) => RunningIndex = index;
}

private class SequenceBuilder
{
private BufferSegment? _start;
private BufferSegment? _end;
private int _length;

public ReadOnlySequence<byte> ReadOnlySequence => new(_start!, 0, _end!, _end!.Memory.Length);

// Memory is only allowed rent from ArrayPool.
public SequenceBuilder Append(ReadOnlyMemory<byte> buffer)
{
var segment = new BufferSegment();
segment.SetMemory(buffer);

if (_start == null)
{
_start = segment;
_end = segment;
}
else
{
_end!.SetNextSegment(segment);
segment.SetRunningIndex(_length);
_end = segment;
}

_length += buffer.Length;

return this;
}
}
}
Loading
Loading