ModernUO/Projects/UOContent/Network/Packets/IncomingPlayerPackets.cs
Kamron Batman 547c2ea0fa
fix: Fixes tick count wrap-around in movement throttle, and eliminates more allocations in NetState (#2603)
## Summary

Removes the per-tick allocation in the movement throttle, fixes tick-count wrap-around bugs in the throttle and RTT probe state, and trims per-connection allocations and dead fields in `NetState`.

## Movement throttle

- **No more per-tick `List<NetState>` snapshot.** `ProcessAllQueues()` iterates the `HashSet` directly and removes drained or disconnected states in place. `HashSet<T>.Remove` does not invalidate enumerators on .NET Core 3.0+ (verified on 10.0.11); only inserting a *new* member does, and the only `Add` is in the packet handler, which never nests with `Slice()`. The eager `Remove` calls in `RejectAndReset`, `ClearQueue`, and `ProcessMovementQueue` are gone; membership is reconciled once per tick from `_hasQueuedMovements`.
- **Debug logging** is now gated solely by the per-connection `NetState.MovementLogging` flag. The global `movementThrottle.debugLogging` setting is removed.
- **New settings**: `movementThrottle.maxRttBonus`, `movementThrottle.maxChainGap`, and `movementThrottle.speedHackNotificationCooldown` were fields with no config binding.

## Tick-count wrap-around

All comparisons are now in subtraction form and no tick field uses zero as a sentinel:

- `now < _nextMovementTime` in the queue drain loop → `now - _nextMovementTime < 0`.
- `_lastMovementRecordTime > 0`, `_lastSpeedHackNotification`, `_rttProbeTime > 0`, and `_nextRttProbe == 0` sentinels replaced with `_hasMovementRecord`, `_speedHackNotified`, `_rttProbePending`, and a seeded `_nextRttProbe`.
- `_lastQueueDepthCheck` and `_movementWindowStart` are seeded from `Core.TickCount` at construction and on reset instead of zero.

User-visible effects of the old code: on hosts with pass-through counters (GCP) movement history never recorded and speed hack detection was silently off; on every host, staff speed hack notifications were suppressed until `Core.TickCount` exceeded the five-minute cooldown.

## NetState

- `Instances` returns `HashSet<NetState>` again so engine-internal `foreach` uses the struct enumerator instead of boxing through `IReadOnlySet<T>`.
- Removed `_sustainedQueueDepth` (declared and zeroed since #2266, never read), `_lastRtt` (now derived as `LastRtt` from the newest history slot), and `_rttProbeTimestampHiRes` (only fed one debug log line). 20 bytes per connection.
- `HuePickers`, `Menus`, and `Trades` are lazily created instead of allocating three lists per connection, including every login-server connection that dies on shard select. `Trades` is released when it empties. All helpers and the `HuePickerResponse` / `MenuResponse` handlers are null-tolerant; the trade cancel loops keep their `i < Count` guards because `SecureTrade.Cancel()` runs virtual item hooks that can re-enter the same list.

## Testing

- `dotnet build -c Release` clean.
- All MovementThrottle tests pass (27), plus the Trade / Menu / HuePicker / NetState tests (32).
2026-09-01 20:25:20 -07:00

506 lines
14 KiB
C#

/*************************************************************************
* ModernUO *
* Copyright 2019-2026 - ModernUO Development Team *
* Email: hi@modernuo.com *
* File: IncomingPlayerPackets.cs *
* *
* This program is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*************************************************************************/
using System.Buffers;
using CommunityToolkit.HighPerformance;
using Server.Engines.Help;
using Server.Engines.MLQuests;
using Server.Engines.Virtues;
using Server.Guilds;
using Server.Items;
using Server.Misc;
using Server.Mobiles;
namespace Server.Network;
public static class IncomingPlayerPackets
{
public static unsafe void Configure()
{
IncomingPackets.Register(0x01, 5, false, &Disconnect);
IncomingPackets.Register(0x05, 5, true, &AttackReq);
IncomingPackets.Register(0x12, 0, true, &TextCommand);
IncomingPackets.Register(0x22, 3, true, &Resynchronize);
IncomingPackets.Register(0x2C, 2, true, &DeathStatusResponse);
IncomingPackets.Register(0x34, 10, true, &MobileQuery);
IncomingPackets.Register(0x3A, 0, true, &ChangeSkillLock);
IncomingPackets.Register(0x72, 5, true, &SetWarMode);
IncomingPackets.Register(0x73, 2, false, &PingReq);
IncomingPackets.Register(0x7D, 13, true, &MenuResponse);
IncomingPackets.Register(0x95, 9, true, &HuePickerResponse);
IncomingPackets.Register(0x9A, 0, true, &AsciiPromptResponse);
IncomingPackets.Register(0x9B, 258, true, &HelpRequest);
IncomingPackets.Register(0xA4, 149, false, &SystemInfo);
IncomingPackets.Register(0xA7, 4, true, &RequestScrollWindow);
IncomingPackets.Register(0xC2, 0, true, &UnicodePromptResponse);
IncomingPackets.Register(0xC8, 2, true, &SetUpdateRange);
IncomingPackets.Register(0xD0, 0, true, &ConfigurationFile);
IncomingPackets.Register(0xD1, 2, true, &LogoutReq);
IncomingPackets.Register(0xD7, 0, true, &EncodedCommand);
IncomingPackets.Register(0xF4, 0, false, &CrashReport);
IncomingPackets.RegisterEncoded(0x28, true, &GuildGumpRequest);
IncomingPackets.RegisterEncoded(0x32, true, &QuestGumpRequest);
}
public static void DeathStatusResponse(NetState state, SpanReader reader)
{
// Ignored
}
public static void RequestScrollWindow(NetState state, SpanReader reader)
{
int lastTip = reader.ReadInt16();
int type = reader.ReadByte();
}
public static void AttackReq(NetState state, SpanReader reader)
{
var from = state.Mobile;
if (from == null)
{
return;
}
var m = World.FindMobile((Serial)reader.ReadUInt32());
if (m != null)
{
from.Attack(m);
}
}
public static void HuePickerResponse(NetState state, SpanReader reader)
{
var serial = reader.ReadUInt32();
reader.ReadInt16(); // Item ID
var hue = Utility.ClipDyedHue(reader.ReadInt16() & 0x3FFF);
if (state.HuePickers == null)
{
return;
}
for (var i = 0; i < state.HuePickers.Count; i++)
{
var huePicker = state.HuePickers[i];
if (huePicker.Serial == serial)
{
state.RemoveHuePicker(huePicker);
huePicker.OnResponse(hue);
break;
}
}
}
public static void SystemInfo(NetState state, SpanReader reader)
{
int v1 = reader.ReadByte();
int v2 = reader.ReadUInt16();
int v3 = reader.ReadByte();
var s1 = reader.ReadAscii(32);
var s2 = reader.ReadAscii(32);
var s3 = reader.ReadAscii(32);
var s4 = reader.ReadAscii(32);
int v4 = reader.ReadUInt16();
int v5 = reader.ReadUInt16();
var v6 = reader.ReadInt32();
var v7 = reader.ReadInt32();
var v8 = reader.ReadInt32();
}
public static void TextCommand(NetState state, SpanReader reader)
{
var from = state.Mobile;
if (from == null)
{
return;
}
int type = reader.ReadByte();
var command = reader.ReadAscii();
switch (type)
{
case 0xC7: // Animate
{
Animations.AnimateRequest(from, command);
break;
}
case 0x24: // Use skill
{
var tokenizer = command.Tokenize(' ');
if (!tokenizer.MoveNext() || !int.TryParse(tokenizer.Current, out var skillIndex))
{
break;
}
Skills.UseSkill(from, skillIndex);
break;
}
case 0x43: // Open spellbook
{
if (!int.TryParse(command, out var booktype))
{
booktype = 1;
}
Spellbook.OpenSpellbookRequest(from, booktype);
break;
}
case 0x27: // Cast spell from book
{
var tokenizer = command.Tokenize(' ');
var spellID = (tokenizer.MoveNext() ? Utility.ToInt32(tokenizer.Current) : 0) - 1;
var serial = tokenizer.MoveNext() ? (Serial)Utility.ToUInt32(tokenizer.Current) : Serial.MinusOne;
Spellbook.CastSpellRequest(from, spellID, World.FindItem(serial));
break;
}
case 0x58: // Open door
{
BaseDoor.OpenDoorMacroUsed(from);
break;
}
case 0x56: // Cast spell from macro
{
var spellID = Utility.ToInt32(command) - 1;
Spellbook.CastSpellRequest(from, spellID, null);
break;
}
case 0xF4: // Invoke virtues from macro
{
var virtueID = Utility.ToInt32(command) - 1;
VirtueGump.RequestVirtueMacro((PlayerMobile)from, virtueID);
break;
}
case 0x2F: // Old scroll double click
{
/*
* This command is still sent for items 0xEF3 - 0xEF9
*
* Command is one of three, depending on the item ID of the scroll:
* - [scroll serial]
* - [scroll serial] [target serial]
* - [scroll serial] [x] [y] [z]
*/
break;
}
default:
{
state.LogInfo($"Unknown text-command type 0x{state:X2}: {type} ({command})");
break;
}
}
}
public static void AsciiPromptResponse(NetState state, SpanReader reader)
{
var from = state.Mobile;
if (from == null)
{
return;
}
var serial = reader.ReadUInt32();
var prompt = reader.ReadInt32();
var type = reader.ReadInt32();
var text = reader.ReadLatin1Safe();
if (text.Length > 128)
{
return;
}
var p = from.Prompt;
if (p?.Serial == serial && p.Serial == prompt)
{
from.Prompt = null;
if (type == 0)
{
p.OnCancel(from);
}
else
{
p.OnResponse(from, text);
}
}
}
public static void UnicodePromptResponse(NetState state, SpanReader reader)
{
var from = state.Mobile;
if (from == null)
{
return;
}
var serial = reader.ReadUInt32();
var prompt = reader.ReadInt32();
var type = reader.ReadInt32();
var lang = reader.ReadAscii(4);
var text = reader.ReadLittleUniSafe();
if (text.Length > 128)
{
return;
}
var p = from.Prompt;
if (p?.Serial == serial && p.Serial == prompt)
{
from.Prompt = null;
if (type == 0)
{
p.OnCancel(from);
}
else
{
p.OnResponse(from, text);
}
}
}
public static void MenuResponse(NetState state, SpanReader reader)
{
var serial = reader.ReadUInt32();
reader.ReadInt16(); // menu id
int index = reader.ReadInt16();
reader.ReadInt16(); // item id
reader.ReadInt16(); // hue
index -= 1; // convert from 1-based to 0-based
if (state.Menus == null)
{
return;
}
for (var i = 0; i < state.Menus.Count; i++)
{
var menu = state.Menus[i];
if ((uint)menu.Serial != serial)
{
continue;
}
state.RemoveMenu(menu);
if (index >= 0 && index < menu.EntryLength)
{
menu.OnResponse(state, index);
}
else
{
menu.OnCancel(state);
}
break;
}
}
public static void Disconnect(NetState state, SpanReader reader)
{
var minusOne = reader.ReadInt32();
}
public static void ConfigurationFile(NetState state, SpanReader reader)
{
}
public static void LogoutReq(NetState state, SpanReader reader)
{
state.SendLogoutAck();
}
public static void ChangeSkillLock(NetState state, SpanReader reader)
{
var s = state.Mobile.Skills[reader.ReadInt16()];
s?.SetLockNoRelay((SkillLock)reader.ReadByte());
}
public static void HelpRequest(NetState state, SpanReader reader)
{
HelpGump.HelpRequest(state.Mobile);
}
public static void SetWarMode(NetState state, SpanReader reader)
{
state.Mobile?.DelayChangeWarmode(reader.ReadBoolean());
}
// TODO: Throttle/make this more safe
public static void Resynchronize(NetState state, SpanReader reader)
{
var from = state.Mobile;
if (from == null)
{
return;
}
state.SendMobileUpdate(from);
state.SendMobileIncoming(from, from);
from.SendEverything();
state.ResetMovementState();
}
public static void PingReq(NetState state, SpanReader reader)
{
state.SendPingAck(reader.ReadByte());
}
public static void SetUpdateRange(NetState state, SpanReader reader)
{
state.SendChangeUpdateRange(18);
}
public static void MobileQuery(NetState state, SpanReader reader)
{
var from = state.Mobile;
if (from == null)
{
return;
}
reader.ReadInt32(); // 0xEDEDEDED
int type = reader.ReadByte();
var m = World.FindMobile((Serial)reader.ReadUInt32());
if (m == null)
{
return;
}
switch (type)
{
case 0x04: // Stats
{
m.OnStatsQuery(from);
break;
}
case 0x05:
{
m.OnSkillsQuery(from);
break;
}
default:
{
state.Trace(reader.Buffer);
break;
}
}
}
public static void CrashReport(NetState state, SpanReader reader)
{
var clientMaj = reader.ReadByte();
var clientMin = reader.ReadByte();
var clientRev = reader.ReadByte();
var clientPat = reader.ReadByte();
var x = reader.ReadUInt16();
var y = reader.ReadUInt16();
var z = reader.ReadSByte();
var map = reader.ReadByte();
var account = reader.ReadAscii(32);
var character = reader.ReadAscii(32);
var ip = reader.ReadAscii(15);
var unk1 = reader.ReadInt32();
var exception = reader.ReadInt32();
var process = reader.ReadAscii(100);
var report = reader.ReadAscii(100);
reader.ReadByte(); // 0x00
var offset = reader.ReadInt32();
int count = reader.ReadByte();
for (var i = 0; i < count; i++)
{
var address = reader.ReadInt32();
}
}
public static void GuildGumpRequest(NetState state, IEntity e, EncodedReader reader)
{
Guild.GuildGumpRequest(state.Mobile);
}
public static void QuestGumpRequest(NetState state, IEntity e, EncodedReader reader)
{
MLQuestSystem.QuestGumpRequest(state.Mobile);
}
public static unsafe void EncodedCommand(NetState state, SpanReader reader)
{
var e = World.FindEntity((Serial)reader.ReadUInt32());
int packetId = reader.ReadUInt16();
// We will add support if this is ever a real thing.
if (packetId > 0xFF)
{
var reason = $"Sent unsupported encoded packet (0xD7x{packetId:X4}";
state.LogInfo(reason);
state.Disconnect(reason);
}
var ph = IncomingPackets.GetEncodedHandler(packetId);
if (ph == null)
{
state.Trace(reader.Buffer);
return;
}
if (ph.Ingame && state.Mobile == null)
{
var reason = $"Sent in-game packet (0xD7x{packetId:X4}) before being attached to a mobile.";
state.LogInfo(reason);
state.Disconnect(reason);
}
else if (ph.Ingame && state.Mobile.Deleted)
{
state.Disconnect($"Sent in-game packet(0xD7x{packetId:X4}) but mobile is deleted.");
}
else
{
ph.OnReceive(state, e, new EncodedReader(reader));
}
}
}