feat: Adds a memory mirrored ring buffer for networking. (#1533)
## Breaking Changes
Incoming packet registration signature has changed to:
```cs
delegate* void OnReceiveCallback(NetState state, SpanReader reader, int packetLength);
IncomingPackets.Register(int packetID, int length, bool ingame, OnReceiveCallback onReceive);
```
For example, an incoming packet handler signature would now look like this:
```cs
public static void SomeIncomingPacket(NetState state, SpanReader reader, int packetLength)
{
// Parse the data
}
```
## Summary
Updates the network Pipe class to use a mirrored memory technique. This technique involves mapping the same physical memory to two contiguous virtual memory spaces so the byte buffer appears duplicated. This allows writing to a double-sized array to wrap around without the need for the `CircularBuffer` classes.
In practice this allows us to use `Span<byte>` as if the buffer was a regular array.
### Bug Fixes
- [X] Fixes bad fixed length string parsing
This commit is contained in:
parent
629a5008c3
commit
10a69bf754
83 changed files with 958 additions and 2432 deletions
|
|
@ -1,103 +0,0 @@
|
|||
using System;
|
||||
using System.IO;
|
||||
using System.Text;
|
||||
using Server.Network;
|
||||
using Xunit;
|
||||
|
||||
namespace Server.Tests.Network
|
||||
{
|
||||
public class CircularBufferReaderTests
|
||||
{
|
||||
[Theory]
|
||||
[InlineData("Test String", "us-ascii", false, -1, 1024, 1024, 0)]
|
||||
[InlineData("Test String", "utf-8", false, -1, 1024, 1024, 0)]
|
||||
[InlineData("Test String", "utf-16BE", false, -1, 1024, 1024, 0)]
|
||||
[InlineData("Test String", "utf-16", false, -1, 1024, 1024, 0)]
|
||||
[InlineData("Test String", "us-ascii", false, -1, 1024, 1024, 1030)]
|
||||
[InlineData("Test String", "utf-8", false, -1, 1024, 1024, 1030)]
|
||||
[InlineData("Test String", "utf-16BE", false, -1, 1024, 1024, 1030)]
|
||||
[InlineData("Test String", "utf-16", false, -1, 1024, 1024, 1030)]
|
||||
[InlineData("Test String", "us-ascii", false, -1, 1024, 1024, 1020)]
|
||||
[InlineData("Test String", "utf-8", false, -1, 1024, 1024, 1020)]
|
||||
[InlineData("Test String", "utf-16BE", false, -1, 1024, 1024, 1020)]
|
||||
[InlineData("Test String", "utf-16", false, -1, 1024, 1024, 1020)]
|
||||
[InlineData("Test String", "us-ascii", false, 8, 1024, 1024, 0)]
|
||||
[InlineData("Test String", "utf-8", false, 8, 1024, 1024, 0)]
|
||||
[InlineData("Test String", "utf-16BE", false, 8, 1024, 1024, 0)]
|
||||
[InlineData("Test String", "utf-16", false, 8, 1024, 1024, 0)]
|
||||
[InlineData("Test String", "us-ascii", false, 8, 1024, 1024, 1030)]
|
||||
[InlineData("Test String", "utf-8", false, 8, 1024, 1024, 1030)]
|
||||
[InlineData("Test String", "utf-16BE", false, 8, 1024, 1024, 1030)]
|
||||
[InlineData("Test String", "utf-16", false, 8, 1024, 1024, 1030)]
|
||||
[InlineData("Test String", "us-ascii", false, 8, 1024, 1024, 1020)]
|
||||
[InlineData("Test String", "utf-8", false, 8, 1024, 1024, 1020)]
|
||||
[InlineData("Test String", "utf-16BE", false, 8, 1024, 1024, 1020)]
|
||||
[InlineData("Test String", "utf-16", false, 8, 1024, 1024, 1020)]
|
||||
[InlineData("Test String", "us-ascii", false, 20, 1024, 1024, 0)]
|
||||
[InlineData("Test String", "utf-8", false, 20, 1024, 1024, 0)]
|
||||
[InlineData("Test String", "utf-16BE", false, 20, 1024, 1024, 0)]
|
||||
[InlineData("Test String", "utf-16", false, 20, 1024, 1024, 0)]
|
||||
[InlineData("Test String", "us-ascii", false, 20, 1024, 1024, 1030)]
|
||||
[InlineData("Test String", "utf-8", false, 20, 1024, 1024, 1030)]
|
||||
[InlineData("Test String", "utf-16BE", false, 20, 1024, 1024, 1030)]
|
||||
[InlineData("Test String", "utf-16", false, 20, 1024, 1024, 1030)]
|
||||
[InlineData("Test String", "us-ascii", false, 20, 1024, 1024, 1020)]
|
||||
[InlineData("Test String", "utf-8", false, 20, 1024, 1024, 1020)]
|
||||
[InlineData("Test String", "utf-16BE", false, 20, 1024, 1024, 1020)]
|
||||
[InlineData("Test String", "utf-16", false, 20, 1024, 1024, 1020)]
|
||||
[InlineData("测试", "utf-8", true, -1, 1024, 1024, 0)]
|
||||
public void TestReadString(
|
||||
string value,
|
||||
string encodingStr,
|
||||
bool isSafe,
|
||||
int fixedLength,
|
||||
int firstSize,
|
||||
int secondSize,
|
||||
int offset
|
||||
)
|
||||
{
|
||||
Span<byte> buffer = stackalloc byte[firstSize + secondSize];
|
||||
buffer.Clear();
|
||||
|
||||
var encoding = EncodingHelpers.GetEncoding(encodingStr);
|
||||
|
||||
var strLength = fixedLength > -1 ? Math.Min(value.Length, fixedLength) : value.Length;
|
||||
var chars = value.AsSpan(0, strLength);
|
||||
|
||||
encoding.GetBytes(chars, buffer[offset..]);
|
||||
|
||||
var reader = new CircularBufferReader(buffer[..firstSize], buffer[firstSize..]);
|
||||
reader.Seek(offset, SeekOrigin.Begin);
|
||||
|
||||
var actual = reader.ReadString(encoding, isSafe, fixedLength);
|
||||
|
||||
Assert.Equal(value[..strLength], actual);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void TestReadStringBetween()
|
||||
{
|
||||
Span<byte> expected = stackalloc byte[19];
|
||||
expected[0] = 0x1;
|
||||
expected[1] = 0x1;
|
||||
expected[2] = 0x1;
|
||||
expected[3] = 0x1;
|
||||
Encoding.ASCII.GetBytes("TestString", expected[4..14]);
|
||||
expected[14] = 0x0; // Null
|
||||
expected[15] = 0x2;
|
||||
expected[16] = 0x2;
|
||||
expected[17] = 0x2;
|
||||
expected[18] = 0x2;
|
||||
|
||||
var reader = new CircularBufferReader(expected, stackalloc byte[0]);
|
||||
|
||||
var num1 = reader.ReadInt32();
|
||||
var str = reader.ReadAscii();
|
||||
var num2 = reader.ReadInt32();
|
||||
|
||||
Assert.Equal(0x01010101, num1);
|
||||
Assert.Equal("TestString", str);
|
||||
Assert.Equal(0x02020202, num2);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1,82 +0,0 @@
|
|||
using System;
|
||||
using System.Buffers;
|
||||
using System.IO;
|
||||
using Xunit;
|
||||
|
||||
namespace Server.Tests.Buffers
|
||||
{
|
||||
public class CircularBufferWriterTests
|
||||
{
|
||||
[Theory]
|
||||
[InlineData("Test String", "us-ascii", -1, 1024, 1024, 0)]
|
||||
[InlineData("Test String", "utf-8", -1, 1024, 1024, 0)]
|
||||
[InlineData("Test String", "utf-16BE", -1, 1024, 1024, 0)]
|
||||
[InlineData("Test String", "utf-16", -1, 1024, 1024, 0)]
|
||||
[InlineData("Test String", "us-ascii", -1, 1024, 1024, 1030)]
|
||||
[InlineData("Test String", "utf-8", -1, 1024, 1024, 1030)]
|
||||
[InlineData("Test String", "utf-16BE", -1, 1024, 1024, 1030)]
|
||||
[InlineData("Test String", "utf-16", -1, 1024, 1024, 1030)]
|
||||
[InlineData("Test String", "us-ascii", -1, 1024, 1024, 1020)]
|
||||
[InlineData("Test String", "utf-8", -1, 1024, 1024, 1020)]
|
||||
[InlineData("Test String", "utf-16BE", -1, 1024, 1024, 1020)]
|
||||
[InlineData("Test String", "utf-16", -1, 1024, 1024, 1020)]
|
||||
[InlineData("Test String", "us-ascii", 8, 1024, 1024, 0)]
|
||||
[InlineData("Test String", "utf-16BE", 8, 1024, 1024, 0)]
|
||||
[InlineData("Test String", "utf-16", 8, 1024, 1024, 0)]
|
||||
[InlineData("Test String", "us-ascii", 8, 1024, 1024, 1030)]
|
||||
[InlineData("Test String", "utf-16BE", 8, 1024, 1024, 1030)]
|
||||
[InlineData("Test String", "utf-16", 8, 1024, 1024, 1030)]
|
||||
[InlineData("Test String", "us-ascii", 8, 1024, 1024, 1020)]
|
||||
[InlineData("Test String", "utf-16BE", 8, 1024, 1024, 1020)]
|
||||
[InlineData("Test String", "utf-16", 8, 1024, 1024, 1020)]
|
||||
[InlineData("Test String", "us-ascii", 20, 1024, 1024, 0)]
|
||||
[InlineData("Test String", "utf-16BE", 20, 1024, 1024, 0)]
|
||||
[InlineData("Test String", "utf-16", 20, 1024, 1024, 0)]
|
||||
[InlineData("Test String", "us-ascii", 20, 1024, 1024, 1030)]
|
||||
[InlineData("Test String", "utf-16BE", 20, 1024, 1024, 1030)]
|
||||
[InlineData("Test String", "utf-16", 20, 1024, 1024, 1030)]
|
||||
[InlineData("Test String", "us-ascii", 20, 1024, 1024, 1020)]
|
||||
[InlineData("Test String", "utf-16BE", 20, 1024, 1024, 1020)]
|
||||
[InlineData("Test String", "utf-16", 20, 1024, 1024, 1020)]
|
||||
public void TestWriteString(
|
||||
string value,
|
||||
string encodingStr,
|
||||
int fixedLength,
|
||||
int firstSize,
|
||||
int secondSize,
|
||||
int offset
|
||||
)
|
||||
{
|
||||
Span<byte> buffer = stackalloc byte[firstSize + secondSize];
|
||||
buffer.Clear();
|
||||
|
||||
var encoding = EncodingHelpers.GetEncoding(encodingStr);
|
||||
var strLength = fixedLength > -1 ? Math.Min(value.Length, fixedLength) : value.Length;
|
||||
var chars = value.AsSpan(0, strLength);
|
||||
|
||||
var writer = new CircularBufferWriter(buffer[..firstSize], buffer[firstSize..]);
|
||||
writer.Seek(offset, SeekOrigin.Begin);
|
||||
writer.WriteString(chars, encoding);
|
||||
|
||||
if (offset > 0)
|
||||
{
|
||||
Span<byte> testEmpty = stackalloc byte[offset];
|
||||
testEmpty.Clear();
|
||||
AssertThat.Equal(buffer[..offset], testEmpty);
|
||||
}
|
||||
|
||||
Span<byte> expectedStr = stackalloc byte[encoding.GetByteCount(chars)];
|
||||
encoding.GetBytes(chars, expectedStr[..]);
|
||||
|
||||
AssertThat.Equal(buffer.Slice(offset, expectedStr.Length), expectedStr);
|
||||
offset += expectedStr.Length;
|
||||
|
||||
if (offset < buffer.Length)
|
||||
{
|
||||
Span<byte> testEmpty = stackalloc byte[buffer.Length - offset];
|
||||
testEmpty.Clear();
|
||||
AssertThat.Equal(buffer[offset..], testEmpty);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue