Skip to content

Commit 9fa20b9

Browse files
brantburnettjeffrymorris
brantburnett
authored and
jeffrymorris
committed
NCBC-3904: Improve OperationBuilder perf using IBufferWriter<byte>
Motivation ---------- Using the `IBufferWriter<T>` pattern can significantly improve performance, especially when using the System.Text.Json serializer, by avoiding unnecessary intermediate buffers which add additional heap allocations and memory copies. Modifications ------------- - Refactor `OperationBuilder` to expose the `IBufferWriter<byte>` interface and to use backing buffers from the ArrayPool instead of a backing `MemoryStream` - Update `RawJsonTranscoder` and `RawStringTranscoder` to write strings directly to the `OperationBuilder` rather than an intermediate buffer or a `StreamWriter` with intermediate buffers - When binary data is encoded using `RawBinaryTranscoder` or `RawJsonTranscoder` on down-level runtimes, use `IBufferWriter<byte>` to write directly to the `OperationBuilder` rather than trying to extract an array and possibly needing to use an intermediate buffer - When serializing JSON to `OperationBuilder` via `DefaultTranscoder` or `JsonTranscoder`, if the serializer supports `IBufferedTypeSerializer` and is not the Newtonsoft serializer then serialize via `IBufferWriter<byte>`. - Refactor all operations to build themselves using `IBufferWriter<byte>` methods instead of intermediate arrays or stackallocs. - Refactor ramge scan and sampling scan to serialize themselves using `IBufferWriter<byte>` - Add a suite of unit tests for `OperationBuilder` - Add an option to enable Snappy compression when running integration tests - Fixup benchmarks and add a `RawStringTranscoder` benchmark - Target the .NET 8 SDK via global.json to keep behaviors consistent until we choose to use the .NET 9 SDK for builds Results ------- General performance improvements on key/value operations, most notably when using the System.Text.Json serializer, which offers approximately a 20% reduction that generally scales with the size of the document. BenchmarkDotNet v0.13.12, Windows 11 (10.0.26100.2314) Unknown processor .NET SDK 9.0.100 [Host] : .NET 8.0.11 (8.0.1124.51707), X64 RyuJIT AVX2 Job-UITXDI : .NET 8.0.11 (8.0.1124.51707), X64 RyuJIT AVX2 Runtime=.NET 8.0 Toolchain=net8.0 | Method | DocSize | Mean | Error | StdDev | Ratio | RatioSD | Rank | Gen0 | Allocated | Alloc Ratio | |------- |-------- |-------------:|-----------:|-----------:|------:|--------:|-----:|-------:|----------:|------------:| | Old | 128 | 114.92 ns | 0.495 ns | 0.463 ns | 1.00 | 0.00 | 2 | - | - | NA | | New | 128 | 88.35 ns | 0.238 ns | 0.211 ns | 0.77 | 0.00 | 1 | 0.0095 | 120 B | NA | | | | | | | | | | | | | | Old | 10240 | 1,183.61 ns | 6.884 ns | 6.102 ns | 1.00 | 0.00 | 2 | 0.0114 | 152 B | 1.00 | | New | 10240 | 956.63 ns | 6.595 ns | 6.169 ns | 0.81 | 0.01 | 1 | 0.0095 | 120 B | 0.79 | | | | | | | | | | | | | | Old | 131072 | 15,293.04 ns | 256.661 ns | 240.081 ns | 1.00 | 0.00 | 2 | - | 376 B | 1.00 | | New | 131072 | 12,716.78 ns | 106.768 ns | 94.647 ns | 0.83 | 0.02 | 1 | - | 120 B | 0.32 | Strings passed via `RawStringTranscoder` or `RawJsonTranscoder` also see improvements: BenchmarkDotNet v0.13.12, Windows 11 (10.0.26100.2314) Unknown processor .NET SDK 9.0.100 [Host] : .NET 8.0.11 (8.0.1124.51707), X64 RyuJIT AVX2 Job-AVGOBO : .NET 8.0.11 (8.0.1124.51707), X64 RyuJIT AVX2 Runtime=.NET 8.0 Toolchain=net8.0 | Method | Length | Mean | Error | StdDev | Ratio | Rank | Gen0 | Allocated | Alloc Ratio | |------- |------- |------------:|----------:|----------:|------:|-----:|-------:|----------:|------------:| | Old | 128 | 46.01 ns | 0.120 ns | 0.112 ns | 1.00 | 2 | - | - | NA | | New | 128 | 27.09 ns | 0.273 ns | 0.255 ns | 0.59 | 1 | - | - | NA | | | | | | | | | | | | | Old | 10240 | 809.19 ns | 5.271 ns | 4.930 ns | 1.00 | 2 | 0.4244 | 5328 B | 1.00 | | New | 10240 | 477.67 ns | 1.698 ns | 1.589 ns | 0.59 | 1 | - | - | 0.00 | | | | | | | | | | | | | Old | 131072 | 8,083.21 ns | 44.767 ns | 39.685 ns | 1.00 | 2 | 0.4120 | 5328 B | 1.00 | | New | 131072 | 7,896.41 ns | 61.938 ns | 54.906 ns | 0.98 | 1 | - | - | 0.00 | Additionally, the backing buffers for the OperationBuilder are returned to the ArrayPool when the builder is resized or the builder is disposed, unlike the previous case where the backing MemoryStream used arrays that were simply garbage collected. This was mitigated somewhat before by the pool of OperationBuilders, but the pool would still sometimes discard builders or create new builders that needed to scale up for larger operations. Change-Id: Id8ca603b9de9cdfa81b03282597408a2e737659b Reviewed-on: https://review.couchbase.org/c/couchbase-net-client/+/219679 Reviewed-by: Jeffry Morris <jeffrymorris@gmail.com> Tested-by: Build Bot <build@couchbase.com>
1 parent 28491ad commit 9fa20b9

39 files changed

Lines changed: 1196 additions & 281 deletions

‎Directory.Build.props‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
<!-- Because we're building commits pulled from Gerrit, SourceLink can't find our repository URL -->
1818
<!-- This will manually fill it in (though we'll still see some warnings) -->
19-
<SourceLinkUrlInitializerTargets>SupplySourceRootRepositoryUrl;$(SourceLinkUrlInitializerTargets)</SourceLinkUrlInitializerTargets>
19+
<SourceLinkUrlInitializerTargets Condition=" '$(MSBuildProjectName)' != 'BenchmarkDotNet.Autogenerated' ">SupplySourceRootRepositoryUrl;$(SourceLinkUrlInitializerTargets)</SourceLinkUrlInitializerTargets>
2020
</PropertyGroup>
2121
<PropertyGroup>
2222
<!-- update this after a release-->

‎src/Couchbase/Core/IO/Operations/Config.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,10 +71,10 @@ protected override void WriteExtras(OperationBuilder builder)
7171
//and revision can be sent to the server for deduping
7272
if (Epoch.HasValue && Revision.HasValue)
7373
{
74-
Span<byte> extras = stackalloc byte[16];
74+
var extras = builder.GetSpan(16);
7575
ByteConverter.FromUInt64(Epoch.Value, extras.Slice(0));
7676
ByteConverter.FromUInt64(Revision.Value, extras.Slice(8));
77-
builder.Write(extras);
77+
builder.Advance(16);
7878
}
7979
}
8080

‎src/Couchbase/Core/IO/Operations/Decrement.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ internal Decrement(string bucketName, string key) : base(bucketName, key)
1616

1717
protected override void WriteExtras(OperationBuilder builder)
1818
{
19-
Span<byte> extras = stackalloc byte[20];
19+
var extras = builder.GetSpan(20);
2020
ByteConverter.FromUInt64(Delta, extras);
2121
if (Initial.HasValue) ByteConverter.FromUInt64(Initial.Value, extras.Slice(8));
2222
else Expires = 0xFFFFFFFF; //From KV RFC: When the Counter does not exist and no Initial value is provided, the Expiry needs to be all 1 bits for the operation to fail.
2323
ByteConverter.FromUInt32(Expires, extras.Slice(16));
24-
builder.Write(extras);
24+
builder.Advance(20);
2525
}
2626

2727
protected override void WriteBody(OperationBuilder builder)

‎src/Couchbase/Core/IO/Operations/Errors/GetErrorMap.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ protected override void WriteExtras(OperationBuilder builder)
1919

2020
protected override void WriteBody(OperationBuilder builder)
2121
{
22-
Span<byte> body = stackalloc byte[2];
22+
var body = builder.GetSpan(sizeof(ushort));
2323
ByteConverter.FromInt16(DefaultVersion, body);
24-
builder.Write(body);
24+
builder.Advance(sizeof(ushort));
2525
}
2626

2727
protected override void ReadExtras(ReadOnlySpan<byte> buffer)

‎src/Couchbase/Core/IO/Operations/GetL.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ internal sealed class GetL<T> : Get<T>
1010

1111
protected override void WriteExtras(OperationBuilder builder)
1212
{
13-
Span<byte> extras = stackalloc byte[4];
13+
var extras = builder.GetSpan(sizeof(uint));
1414
ByteConverter.FromUInt32(Expiry, extras);
15-
builder.Write(extras);
15+
builder.Advance(sizeof(uint));
1616
}
1717

1818
protected override void WriteBody(OperationBuilder builder)

‎src/Couchbase/Core/IO/Operations/GetMeta.cs‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,7 @@ internal sealed class GetMeta : OperationBase<MetaData>
1212

1313
protected override void WriteExtras(OperationBuilder builder)
1414
{
15-
Span<byte> extras = stackalloc byte[1];
16-
extras[0] = 0x02;
17-
builder.Write(extras);
15+
builder.WriteByte(0x02);
1816
}
1917

2018
public override MetaData GetValue()

‎src/Couchbase/Core/IO/Operations/Hello.cs‎

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -16,26 +16,16 @@ internal sealed class Hello : OperationBase<ServerFeatures[]>
1616

1717
protected override void WriteBody(OperationBuilder builder)
1818
{
19-
var contentLength = Content.Length;
20-
var bufferLength = contentLength * 2;
19+
var bufferLength = Content.Length * 2;
2120

22-
var buffer = ArrayPool<byte>.Shared.Rent(bufferLength);
23-
try
21+
var body = builder.GetSpan(bufferLength);
22+
for (var i = 0; i < Content.Length; i++)
2423
{
25-
var body = buffer.AsSpan();
26-
27-
for (var i = 0; i < contentLength; i++)
28-
{
29-
ByteConverter.FromInt16((short) Content[i], body);
30-
body = body.Slice(2);
31-
}
32-
33-
builder.Write(buffer, 0, bufferLength);
34-
}
35-
finally
36-
{
37-
ArrayPool<byte>.Shared.Return(buffer);
24+
ByteConverter.FromInt16((short) Content[i], body);
25+
body = body.Slice(2);
3826
}
27+
28+
builder.Advance(bufferLength);
3929
}
4030

4131
protected override void WriteExtras(OperationBuilder builder)

‎src/Couchbase/Core/IO/Operations/Increment.cs‎

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,25 @@ internal Increment(string bucketName, string key) : base(bucketName, key)
1616

1717
protected override void WriteExtras(OperationBuilder builder)
1818
{
19-
Span<byte> extras = stackalloc byte[20];
19+
const int extrasLength = sizeof(ulong) * 2 + sizeof(uint);
20+
21+
var extras = builder.GetSpan(extrasLength);
2022
ByteConverter.FromUInt64(Delta, extras);
21-
if (Initial.HasValue) ByteConverter.FromUInt64(Initial.Value, extras.Slice(8));
22-
else Expires = 0xFFFFFFFF; //From KV RFC: When the Counter does not exist and no Initial value is provided, the Expiry needs to be all 1 bits for the operation to fail.
23-
ByteConverter.FromUInt32(Expires, extras.Slice(16));
24-
builder.Write(extras);
23+
24+
if (Initial.HasValue)
25+
{
26+
ByteConverter.FromUInt64(Initial.Value, extras.Slice(sizeof(ulong)));
27+
}
28+
else
29+
{
30+
ByteConverter.FromUInt64(0, extras.Slice(sizeof(ulong)));
31+
32+
Expires = 0xFFFFFFFF; //From KV RFC: When the Counter does not exist and no Initial value is provided, the Expiry needs to be all 1 bits for the operation to fail.
33+
}
34+
35+
ByteConverter.FromUInt32(Expires, extras.Slice(sizeof(ulong) * 2));
36+
37+
builder.Advance(extrasLength);
2538
}
2639

2740
protected override void WriteBody(OperationBuilder builder)

‎src/Couchbase/Core/IO/Operations/MutationOperationBase'.cs‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,7 @@ protected override void WriteFramingExtras(OperationBuilder builder)
4040
{
4141
if (PreserveTtl)
4242
{
43-
Span<byte> preserveTtlByte = stackalloc byte[1];
44-
preserveTtlByte[0] = 5 << 4;
45-
builder.Write(preserveTtlByte);
43+
builder.WriteByte(5 << 4);
4644
}
4745

4846
if (DurabilityLevel == DurabilityLevel.None)
@@ -51,17 +49,17 @@ protected override void WriteFramingExtras(OperationBuilder builder)
5149
}
5250

5351
// TODO: omit timeout bytes if no timeout provided
54-
Span<byte> bytes = stackalloc byte[2];
5552

56-
var framingExtra = new FramingExtraInfo(RequestFramingExtraType.DurabilityRequirements, (byte) (bytes.Length - 1));
53+
var framingExtra = new FramingExtraInfo(RequestFramingExtraType.DurabilityRequirements, length: 1);
54+
var bytes = builder.GetSpan(framingExtra.Length + 1);
5755
bytes[0] = framingExtra.Byte;
5856
bytes[1] = (byte) DurabilityLevel;
5957

6058
// TODO: improve timeout, coerce to 1500ms, etc
6159
//var timeout = DurabilityTimeout.HasValue ? DurabilityTimeout.Value.TotalMilliseconds : 0;
6260
//Converter.FromUInt16((ushort)timeout, bytes, 2);
6361

64-
builder.Write(bytes);
62+
builder.Advance(framingExtra.Length + 1);
6563
}
6664
}
6765
}

‎src/Couchbase/Core/IO/Operations/MutationOperationBase.cs‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,11 @@ protected override void WriteFramingExtras(OperationBuilder builder)
4242
}
4343

4444
// TODO: omit timeout bytes if no timeout provided
45-
Span<byte> bytes = stackalloc byte[4];
4645

47-
var framingExtra = new FramingExtraInfo(RequestFramingExtraType.DurabilityRequirements, (byte) (bytes.Length - 1));
48-
bytes[0] = (byte) (framingExtra.Byte | (byte) 0x03);
46+
var framingExtra = new FramingExtraInfo(RequestFramingExtraType.DurabilityRequirements, length: 3);
47+
48+
var bytes = builder.GetSpan(framingExtra.Length + 1);
49+
bytes[0] = framingExtra.Byte;
4950
bytes[1] = (byte) DurabilityLevel;
5051

5152
var userTimeout = DurabilityTimeout.Value.TotalMilliseconds;
@@ -65,7 +66,7 @@ protected override void WriteFramingExtras(OperationBuilder builder)
6566
}
6667

6768
ByteConverter.FromUInt16(deadline, bytes);
68-
builder.Write(bytes);
69+
builder.Advance(framingExtra.Length + 1);
6970
}
7071
}
7172
}

0 commit comments

Comments
 (0)