refactor: master packets as structs

Every MASTER service packet is now an LUBitStream struct (docs/PacketArchitecture.md,
PR 14) and the master server's switch is a dispatch map (PacketDispatcher), as are the
master handlers of the world, chat and dashboard servers.

- dNet/MasterPackets.h: RequestZoneTransfer, RequestZoneTransferResponse, ServerInfo,
  RequestSessionKey, SetSessionKey, SessionKeyResponse, NewSessionAlert, PlayerAdded /
  PlayerRemoved, CreatePrivateZone, RequestPrivateZone (passwords still cut to 50
  characters when read), WorldReady, WorldReadyInfo (WORLD_READY to the dashboard),
  PrepZone, Shutdown, ShutdownResponse, WorldShutDown (SHUTDOWN_RESPONSE to the
  dashboard), ShutdownUniverse, AffirmTransferRequest/Response, RequestServerList,
  ServerListResponse, DashboardShutdown, ConfigReload, InstanceShutdown. The Send*
  functions are gone; MasterPackets::SendToMaster(msg) and SendTo(sysAddr, msg) send a
  struct.
- The dashboard and instance migration structs (PlayerAction, DataChanged, Dashboard
  messages, MessageCapture, InstanceMigration) are LUBitStreams of the MASTER service now
  and moved to dNet/master/, included by MasterPackets.h. Their payloads are unchanged;
  master forwards them by re-serializing the struct instead of copying raw bytes.
- InstanceManager, ZoneInstanceManager, MigrationCoordinator, dServer (server info, zone
  transfer response), auth (SET_SESSION_KEY), the world (session keys, player added and
  removed, world ready, shutdown response, affirmations, prep zone, shutdown universe) and
  the dashboard (server list, instance shutdown, config reload, announcements, player
  actions, message capture) send and read structs.
- The login stamps are a `stamps` field of RequestZoneTransfer and
  RequestZoneTransferResponse (read leniently as before: a message without them reads as
  empty); master adds its stamps in the REQUEST_ZONE_TRANSFER handler and when it answers,
  as it did.
- InstanceManager::GetInstanceBySysAddr takes a const address.

Verified: tests/dGameTests/dNetTests/Legacy/MasterPacketsLegacy.h is a verbatim copy of
the old writers and readers; MasterPacketsTests requires identical bytes for a grid of
inputs, checks the old readers read what the structs write, round trips and truncation,
hand written golden packets, that zone transfers without stamps still read, that the dashboard/migration structs write what
"header + Serialize" wrote, and that the dispatcher drops truncated packets. No wire
bytes changed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
Aaron Kimbrell
2026-09-26 23:34:47 -05:00
parent 796fd1b941
commit 5a9a3e380b
54 changed files with 2275 additions and 1248 deletions

View File

@@ -2,109 +2,274 @@
#include "BitStream.h"
#include "dCommonVars.h"
#include "dServer.h"
#include "Game.h"
#include "ServiceType.h"
#include "MessageType/Master.h"
#include "BitStreamUtils.h"
#include <algorithm>
#include <string>
void MasterPackets::SendZoneTransferRequest(dServer* server, uint64_t requestID, bool mythranShift, uint32_t zoneID, uint32_t cloneID, const Stamps& stamps) {
RakNet::BitStream bitStream;
BitStreamUtils::WriteHeader(bitStream, ServiceType::MASTER, MessageType::Master::REQUEST_ZONE_TRANSFER);
bitStream.Write(requestID);
bitStream.Write<uint8_t>(mythranShift);
bitStream.Write(zoneID);
bitStream.Write(cloneID);
stamps.Serialize(bitStream);
server->SendToMaster(bitStream);
namespace {
// u32 length and 1 byte per character. A longer string is cut to maxLength when read (the rest is skipped).
bool ReadCappedString(RakNet::BitStream& bitStream, std::string& value, const uint32_t maxLength) {
uint32_t length{};
VALIDATE_READ(bitStream.Read(length));
value.resize(std::min(length, maxLength));
return value.empty() || bitStream.ReadBits(reinterpret_cast<unsigned char*>(value.data()), BYTES_TO_BITS(value.size()), true);
}
}
void MasterPackets::SendZoneCreatePrivate(dServer* server, uint32_t zoneID, uint32_t cloneID, const std::string& password) {
void MasterPackets::SendToMaster(const LUBitStream& msg, dServer* server) {
RakNet::BitStream bitStream;
BitStreamUtils::WriteHeader(bitStream, ServiceType::MASTER, MessageType::Master::CREATE_PRIVATE_ZONE);
msg.WritePacket(bitStream);
(server ? server : Game::server)->SendToMaster(bitStream);
}
bitStream.Write(zoneID);
bitStream.Write(cloneID);
void MasterPackets::SendTo(const SystemAddress& sysAddr, const LUBitStream& msg) {
RakNet::BitStream bitStream;
msg.WritePacket(bitStream);
Game::server->Send(bitStream, sysAddr, false);
}
bitStream.Write<uint32_t>(password.size());
for (auto character : password) {
bitStream.Write<char>(character);
namespace MasterPackets {
void RequestZoneTransfer::Serialize(RakNet::BitStream& bitStream) const {
bitStream.Write(requestID);
bitStream.Write(mythranShift);
bitStream.Write(zoneID);
bitStream.Write(cloneID);
stamps.Serialize(bitStream);
}
server->SendToMaster(bitStream);
}
void MasterPackets::SendZoneRequestPrivate(dServer* server, uint64_t requestID, bool mythranShift, const std::string& password) {
RakNet::BitStream bitStream;
BitStreamUtils::WriteHeader(bitStream, ServiceType::MASTER, MessageType::Master::REQUEST_PRIVATE_ZONE);
bitStream.Write(requestID);
bitStream.Write<uint8_t>(mythranShift);
bitStream.Write<uint32_t>(password.size());
for (auto character : password) {
bitStream.Write<char>(character);
bool RequestZoneTransfer::Deserialize(RakNet::BitStream& bitStream) {
VALIDATE_READ(bitStream.Read(requestID));
VALIDATE_READ(bitStream.Read(mythranShift));
VALIDATE_READ(bitStream.Read(zoneID));
VALIDATE_READ(bitStream.Read(cloneID));
if (!stamps.Deserialize(bitStream)) stamps = {};
return true;
}
server->SendToMaster(bitStream);
}
void MasterPackets::SendWorldReady(dServer* server, LWOMAPID zoneId, LWOINSTANCEID instanceId) {
RakNet::BitStream bitStream;
BitStreamUtils::WriteHeader(bitStream, ServiceType::MASTER, MessageType::Master::WORLD_READY);
bitStream.Write(zoneId);
bitStream.Write(instanceId);
server->SendToMaster(bitStream);
}
void MasterPackets::SendZoneTransferResponse(dServer* server, const SystemAddress& sysAddr, uint64_t requestID, bool mythranShift, uint32_t zoneID, uint32_t zoneInstance, uint32_t zoneClone, const std::string& serverIP, uint32_t serverPort, const Stamps& stamps) {
RakNet::BitStream bitStream;
BitStreamUtils::WriteHeader(bitStream, ServiceType::MASTER, MessageType::Master::REQUEST_ZONE_TRANSFER_RESPONSE);
bitStream.Write(requestID);
bitStream.Write<uint8_t>(mythranShift);
bitStream.Write(zoneID);
bitStream.Write(zoneInstance);
bitStream.Write(zoneClone);
bitStream.Write<uint16_t>(serverPort);
bitStream.Write(LUString(serverIP, 255));
stamps.Serialize(bitStream);
server->Send(bitStream, sysAddr, false);
}
void MasterPackets::HandleServerInfo(Packet* packet) {
RakNet::BitStream inStream(packet->data, packet->length, false);
uint64_t header{};
inStream.Read(header);
uint32_t theirPort = 0;
uint32_t theirZoneID = 0;
uint32_t theirInstanceID = 0;
LUString theirIP;
inStream.Read(theirPort);
inStream.Read(theirZoneID);
inStream.Read(theirInstanceID);
inStream.Read(theirIP);
//TODO: Actually mark this server as an available server in the manager
}
void MasterPackets::SendServerInfo(dServer* server, Packet* packet) {
LOG("SendServerInfo called for server type %i", static_cast<int>(server->GetServerType()));
RakNet::BitStream bitStream;
BitStreamUtils::WriteHeader(bitStream, ServiceType::MASTER, MessageType::Master::SERVER_INFO);
bitStream.Write(server->GetPort());
bitStream.Write(server->GetZoneID());
bitStream.Write(server->GetInstanceID());
bitStream.Write(server->GetServerType());
bitStream.Write(LUString(server->GetIP()));
server->SendToMaster(bitStream);
void RequestZoneTransferResponse::Serialize(RakNet::BitStream& bitStream) const {
bitStream.Write(requestID);
bitStream.Write(mythranShift);
bitStream.Write(zoneID);
bitStream.Write(zoneInstance);
bitStream.Write(zoneClone);
bitStream.Write(serverPort);
bitStream.Write(serverIP);
stamps.Serialize(bitStream);
}
bool RequestZoneTransferResponse::Deserialize(RakNet::BitStream& bitStream) {
VALIDATE_READ(bitStream.Read(requestID));
VALIDATE_READ(bitStream.Read(mythranShift));
VALIDATE_READ(bitStream.Read(zoneID));
VALIDATE_READ(bitStream.Read(zoneInstance));
VALIDATE_READ(bitStream.Read(zoneClone));
VALIDATE_READ(bitStream.Read(serverPort));
VALIDATE_READ(bitStream.Read(serverIP));
if (!stamps.Deserialize(bitStream)) stamps = {};
return true;
}
void ServerInfo::Serialize(RakNet::BitStream& bitStream) const {
bitStream.Write(port);
bitStream.Write(zoneID);
bitStream.Write(instanceID);
bitStream.Write(serverType);
bitStream.Write(ip);
}
bool ServerInfo::Deserialize(RakNet::BitStream& bitStream) {
VALIDATE_READ(bitStream.Read(port));
VALIDATE_READ(bitStream.Read(zoneID));
VALIDATE_READ(bitStream.Read(instanceID));
VALIDATE_READ(bitStream.Read(serverType));
VALIDATE_READ(bitStream.Read(ip));
return true;
}
void RequestSessionKey::Serialize(RakNet::BitStream& bitStream) const {
bitStream.Write(username);
}
bool RequestSessionKey::Deserialize(RakNet::BitStream& bitStream) {
VALIDATE_READ(bitStream.Read(username));
return true;
}
void SetSessionKey::Serialize(RakNet::BitStream& bitStream) const {
bitStream.Write(sessionKey);
bitStream.Write(username);
}
bool SetSessionKey::Deserialize(RakNet::BitStream& bitStream) {
VALIDATE_READ(bitStream.Read(sessionKey));
VALIDATE_READ(bitStream.Read(username));
return true;
}
void SessionKeyResponse::Serialize(RakNet::BitStream& bitStream) const {
bitStream.Write(sessionKey);
bitStream.Write(username);
}
bool SessionKeyResponse::Deserialize(RakNet::BitStream& bitStream) {
VALIDATE_READ(bitStream.Read(sessionKey));
VALIDATE_READ(bitStream.Read(username));
return true;
}
void NewSessionAlert::Serialize(RakNet::BitStream& bitStream) const {
bitStream.Write(sessionKey);
bitStream.Write(username);
}
bool NewSessionAlert::Deserialize(RakNet::BitStream& bitStream) {
VALIDATE_READ(bitStream.Read(sessionKey));
VALIDATE_READ(bitStream.Read(username));
return true;
}
void PlayerCountChange::Serialize(RakNet::BitStream& bitStream) const {
bitStream.Write(zoneID);
bitStream.Write(instanceID);
}
bool PlayerCountChange::Deserialize(RakNet::BitStream& bitStream) {
VALIDATE_READ(bitStream.Read(zoneID));
VALIDATE_READ(bitStream.Read(instanceID));
return true;
}
void CreatePrivateZone::Serialize(RakNet::BitStream& bitStream) const {
bitStream.Write(zoneID);
bitStream.Write(cloneID);
BitStreamUtils::WriteLengthPrefixed<uint32_t>(bitStream, password);
}
bool CreatePrivateZone::Deserialize(RakNet::BitStream& bitStream) {
VALIDATE_READ(bitStream.Read(zoneID));
VALIDATE_READ(bitStream.Read(cloneID));
VALIDATE_READ(ReadCappedString(bitStream, password, MAX_PASSWORD_LENGTH));
return true;
}
void RequestPrivateZone::Serialize(RakNet::BitStream& bitStream) const {
bitStream.Write(requestID);
bitStream.Write(mythranShift);
BitStreamUtils::WriteLengthPrefixed<uint32_t>(bitStream, password);
}
bool RequestPrivateZone::Deserialize(RakNet::BitStream& bitStream) {
VALIDATE_READ(bitStream.Read(requestID));
VALIDATE_READ(bitStream.Read(mythranShift));
VALIDATE_READ(ReadCappedString(bitStream, password, MAX_PASSWORD_LENGTH));
return true;
}
void WorldReady::Serialize(RakNet::BitStream& bitStream) const {
bitStream.Write(zoneID);
bitStream.Write(instanceID);
}
bool WorldReady::Deserialize(RakNet::BitStream& bitStream) {
VALIDATE_READ(bitStream.Read(zoneID));
VALIDATE_READ(bitStream.Read(instanceID));
return true;
}
void WorldReadyInfo::Serialize(RakNet::BitStream& bitStream) const {
bitStream.Write(zoneID);
bitStream.Write(instanceID);
bitStream.Write(cloneID);
bitStream.Write(ip);
bitStream.Write(port);
bitStream.Write(isPrivate);
}
bool WorldReadyInfo::Deserialize(RakNet::BitStream& bitStream) {
VALIDATE_READ(bitStream.Read(zoneID));
VALIDATE_READ(bitStream.Read(instanceID));
VALIDATE_READ(bitStream.Read(cloneID));
VALIDATE_READ(bitStream.Read(ip));
VALIDATE_READ(bitStream.Read(port));
VALIDATE_READ(bitStream.Read(isPrivate));
return true;
}
void PrepZone::Serialize(RakNet::BitStream& bitStream) const {
bitStream.Write(zoneID);
}
bool PrepZone::Deserialize(RakNet::BitStream& bitStream) {
VALIDATE_READ(bitStream.Read(zoneID));
return true;
}
void WorldShutDown::Serialize(RakNet::BitStream& bitStream) const {
bitStream.Write(zoneID);
bitStream.Write(instanceID);
}
bool WorldShutDown::Deserialize(RakNet::BitStream& bitStream) {
VALIDATE_READ(bitStream.Read(zoneID));
VALIDATE_READ(bitStream.Read(instanceID));
return true;
}
void AffirmTransfer::Serialize(RakNet::BitStream& bitStream) const {
bitStream.Write(requestID);
}
bool AffirmTransfer::Deserialize(RakNet::BitStream& bitStream) {
VALIDATE_READ(bitStream.Read(requestID));
return true;
}
void ServerListResponse::Serialize(RakNet::BitStream& bitStream) const {
bitStream.Write(authOnline);
bitStream.Write(chatOnline);
bitStream.Write<uint32_t>(instances.size());
for (const auto& instance : instances) {
bitStream.Write(instance.mapID);
bitStream.Write(instance.instanceID);
bitStream.Write(instance.cloneID);
bitStream.Write(instance.players);
bitStream.Write(instance.ip);
bitStream.Write(instance.port);
bitStream.Write(instance.isPrivate);
}
}
bool ServerListResponse::Deserialize(RakNet::BitStream& bitStream) {
VALIDATE_READ(bitStream.Read(authOnline));
VALIDATE_READ(bitStream.Read(chatOnline));
uint32_t count{};
VALIDATE_READ(bitStream.Read(count));
if (count > MAX_INSTANCES) return false;
instances.resize(count);
for (auto& instance : instances) {
VALIDATE_READ(bitStream.Read(instance.mapID));
VALIDATE_READ(bitStream.Read(instance.instanceID));
VALIDATE_READ(bitStream.Read(instance.cloneID));
VALIDATE_READ(bitStream.Read(instance.players));
VALIDATE_READ(bitStream.Read(instance.ip));
VALIDATE_READ(bitStream.Read(instance.port));
VALIDATE_READ(bitStream.Read(instance.isPrivate));
}
return true;
}
void InstanceShutdown::Serialize(RakNet::BitStream& bitStream) const {
bitStream.Write(zoneID);
bitStream.Write(instanceID);
}
bool InstanceShutdown::Deserialize(RakNet::BitStream& bitStream) {
VALIDATE_READ(bitStream.Read(zoneID));
VALIDATE_READ(bitStream.Read(instanceID));
return true;
}
}