ModernUO/Projects/UOContent.Tests/Tests/Multis/Boats/BoatPacketTests.cs
Kamron Batman 3c0d6cb9d6
feat: Upgrades networking to use io_uring. (#2315)
> [!IMPORTANT]
> **Breaking Changes**
> - DecodePacket and EncodePacket delegates replaced with IClientEncryption interface
> - NetState.Connection (Socket) replaced with internal RingSocket management
> - NetState.RecvPipe and NetState.SendPipe removed (buffers managed internally)

## Summary

Upgrades the networking stack from PollGroup-based I/O to io_uring, significantly improving I/O performance on Linux.
This also adds native client encryption support for encrypted UO clients.

## Major Changes

io_uring Networking Architecture
- Replaced PollGroup with IORingGroup for async socket I/O operations
- Removed Pipe.cs (mirrored ring buffer) and TcpServer.cs in favor of RingSocketManager
- Added NetState.Network.cs - centralized network infrastructure handling accept, recv, send, and disconnect
completions
- Added SocketHelper.cs - platform-specific socket utilities for raw socket handle operations (getpeername,
getsockname)
- Buffer management now handled by RingSocketManager with configurable slab allocation

### Client Encryption Support
- Added full encryption stack in Network/Encryption/:
  - EncryptionConfig.cs - configurable encryption modes (None, Unencrypted, Encrypted, Both)
  - EncryptionManager.cs - encryption detection and initialization for login/game packets
  - LoginEncryption.cs - handles login packet encryption with version-derived keys
  - GameEncryption.cs - handles game server encryption using Twofish
  - TwofishEngine.cs - optimized Twofish block cipher implementation
  - LoginKeys.cs - encryption key table for client versions
  - IClientEncryption.cs - interface for client encryption implementations

### NetState Improvements
- Replaced Socket Connection with RingSocket _socket for managed socket lifecycle
- Changed from GCHandle polling to event-based completion processing
- Disconnect handling now properly waits for pending sends to flush
- Simplified connecting socket management using lazy queue removal

### Configuration
- New settings: network.encryptionMode and network.encryptionDebug
- Encryption mode flags: Unencrypted, Encrypted, or Both

### Dependencies
- Replaced PollGroup NuGet package with IORingGroup
- Linux requires liburing-dev / liburing-devel package

### Test plan

- Verify server starts and accepts connections on Linux with io_uring
- Verify server starts and accepts connections on Windows (fallback to IOCP)
- Test unencrypted client connections (ClassicUO with encryption disabled)
- Test encrypted client connections if available
- Verify graceful disconnect flushes pending data
- Confirm CI builds pass on all target platforms
2026-02-01 16:02:32 -08:00

136 lines
4 KiB
C#

using System.Collections.Generic;
using System.Linq;
using Server;
using Server.Collections;
using Server.Multis;
using Server.Multis.Boats;
using Server.Network;
using Server.Tests;
using Server.Tests.Network;
using Xunit;
namespace UOContent.Tests;
[Collection("Sequential UOContent Tests")]
public class BoatPacketTests
{
[Theory]
[InlineData(Direction.West, 10, 100, 200)]
public void TestMoveBoatHS(Direction d, int speed, int xOffset, int yOffset)
{
var item1 = new Item((Serial)0x1000)
{
ItemID = 0x13B9,
Location = new Point3D(11, 21, 16),
Map = Map.Felucca,
Visible = true
};
var item2 = new Item((Serial)0x2000)
{
ItemID = 0x13B9,
Location = new Point3D(100, 200, 16),
Map = Map.Felucca,
Visible = true
};
var beholder = new MockedMobile((Serial)0x100);
beholder.DefaultMobileInit();
beholder.Location = new Point3D(10, 20, 15);
beholder.Map = Map.Felucca;
beholder.CanSeeEntities.Add(item1);
using var list = PooledRefList<IEntity>.Create();
list.Add(beholder);
list.Add(item1);
var notContained = new List<IEntity> { item2 };
var boat = new TestBoat((Serial)0x3000, notContained)
{
Location = new Point3D(10, 20, 15),
Facing = Direction.Right,
Map = Map.Felucca
};
beholder.CanSeeEntities.Add(boat);
using var ns = PacketTestUtilities.CreateTestNetState();
ns.ProtocolChanges = ProtocolChanges.HighSeas;
var expected = new MoveBoatHS(beholder, boat, d, speed, list, xOffset, yOffset).Compile();
ns.SendMoveBoatHS(boat, list, d, speed, xOffset, yOffset);
var result = ns.SendBuffer.GetReadSpan();
AssertThat.Equal(result, expected);
}
[Fact]
public void TestDisplayBoatHS()
{
var item1 = new Item((Serial)0x1000)
{
ItemID = 0x13B9,
Location = new Point3D(11, 21, 16),
Map = Map.Felucca
};
var item2 = new Item((Serial)0x2000)
{
ItemID = 0x13B9,
Location = new Point3D(100, 200, 16),
Map = Map.Felucca
};
var beholder = new MockedMobile((Serial)0x100);
beholder.DefaultMobileInit();
beholder.Location = new Point3D(10, 20, 15);
beholder.Map = Map.Felucca;
beholder.CanSeeEntities.Add(item1);
var notContained = new List<IEntity> { item2 };
var boat = new TestBoat((Serial)0x3000, notContained)
{
Location = new Point3D(10, 20, 15),
Facing = Direction.Right,
Map = Map.Felucca
};
beholder.CanSeeEntities.Add(boat);
using var ns = PacketTestUtilities.CreateTestNetState();
ns.ProtocolChanges = ProtocolChanges.HighSeas;
var expected = new DisplayBoatHS(beholder, boat).Compile();
ns.SendDisplayBoatHS(beholder, boat);
var result = ns.SendBuffer.GetReadSpan();
AssertThat.Equal(result, expected);
}
private class TestBoat : BaseBoat
{
private readonly List<IEntity> _notContainedList;
public TestBoat(Serial serial, List<IEntity> notContainedList) : base(serial) => _notContainedList = notContainedList;
public override MultiComponentList Components { get; } = new(new List<MultiTileEntry>());
public override bool Contains(int x, int y) => !_notContainedList.Any(e => e.X == x && e.Y == y);
public override MovingEntitiesEnumerable GetMovingEntities(bool includeBoat = false) =>
new(this, true, new Rectangle2D(new Point2D(9, 19), new Point2D(13, 22)));
}
private class MockedMobile : Mobile
{
public HashSet<IEntity> CanSeeEntities = new();
public MockedMobile(Serial serial) : base(serial)
{
}
public override bool CanSee(Mobile m) => m == this;
public override bool CanSee(Item i) => CanSeeEntities.Contains(i);
}
}