您最多选择25个主题
主题必须以中文或者字母或数字开头,可以包含连字符 (-),并且长度不得超过35个字符
237 行
12 KiB
237 行
12 KiB
using System;
|
|
using System.Collections.Generic;
|
|
using Unity.Collections;
|
|
|
|
namespace Unity.Netcode
|
|
{
|
|
/// <summary>
|
|
/// This particular struct is a little weird because it doesn't actually contain the data
|
|
/// it's serializing. Instead, it contains references to the data it needs to do the
|
|
/// serialization. This is due to the generally amorphous nature of network variable
|
|
/// deltas, since they're all driven by custom virtual method overloads.
|
|
/// </summary>
|
|
internal struct NetworkVariableDeltaMessage : INetworkMessage
|
|
{
|
|
public int Version => 0;
|
|
|
|
public ulong NetworkObjectId;
|
|
public ushort NetworkBehaviourIndex;
|
|
|
|
public HashSet<int> DeliveryMappedNetworkVariableIndex;
|
|
public ulong TargetClientId;
|
|
public NetworkBehaviour NetworkBehaviour;
|
|
|
|
private FastBufferReader m_ReceivedNetworkVariableData;
|
|
|
|
public void Serialize(FastBufferWriter writer, int targetVersion)
|
|
{
|
|
if (!writer.TryBeginWrite(FastBufferWriter.GetWriteSize(NetworkObjectId) + FastBufferWriter.GetWriteSize(NetworkBehaviourIndex)))
|
|
{
|
|
throw new OverflowException($"Not enough space in the buffer to write {nameof(NetworkVariableDeltaMessage)}");
|
|
}
|
|
|
|
BytePacker.WriteValueBitPacked(writer, NetworkObjectId);
|
|
BytePacker.WriteValueBitPacked(writer, NetworkBehaviourIndex);
|
|
|
|
for (int i = 0; i < NetworkBehaviour.NetworkVariableFields.Count; i++)
|
|
{
|
|
if (!DeliveryMappedNetworkVariableIndex.Contains(i))
|
|
{
|
|
// This var does not belong to the currently iterating delivery group.
|
|
if (NetworkBehaviour.NetworkManager.NetworkConfig.EnsureNetworkVariableLengthSafety)
|
|
{
|
|
BytePacker.WriteValueBitPacked(writer, (ushort)0);
|
|
}
|
|
else
|
|
{
|
|
writer.WriteValueSafe(false);
|
|
}
|
|
|
|
continue;
|
|
}
|
|
|
|
var startingSize = writer.Length;
|
|
var networkVariable = NetworkBehaviour.NetworkVariableFields[i];
|
|
var shouldWrite = networkVariable.IsDirty() &&
|
|
networkVariable.CanClientRead(TargetClientId) &&
|
|
(NetworkBehaviour.NetworkManager.IsServer || networkVariable.CanClientWrite(NetworkBehaviour.NetworkManager.LocalClientId));
|
|
|
|
// Prevent the server from writing to the client that owns a given NetworkVariable
|
|
// Allowing the write would send an old value to the client and cause jitter
|
|
if (networkVariable.WritePerm == NetworkVariableWritePermission.Owner &&
|
|
networkVariable.OwnerClientId() == TargetClientId)
|
|
{
|
|
shouldWrite = false;
|
|
}
|
|
|
|
if (NetworkBehaviour.NetworkManager.NetworkConfig.EnsureNetworkVariableLengthSafety)
|
|
{
|
|
if (!shouldWrite)
|
|
{
|
|
BytePacker.WriteValueBitPacked(writer, (ushort)0);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
writer.WriteValueSafe(shouldWrite);
|
|
}
|
|
|
|
if (shouldWrite)
|
|
{
|
|
if (NetworkBehaviour.NetworkManager.NetworkConfig.EnsureNetworkVariableLengthSafety)
|
|
{
|
|
var tempWriter = new FastBufferWriter(MessagingSystem.NON_FRAGMENTED_MESSAGE_MAX_SIZE, Allocator.Temp, MessagingSystem.FRAGMENTED_MESSAGE_MAX_SIZE);
|
|
NetworkBehaviour.NetworkVariableFields[i].WriteDelta(tempWriter);
|
|
BytePacker.WriteValueBitPacked(writer, tempWriter.Length);
|
|
|
|
if (!writer.TryBeginWrite(tempWriter.Length))
|
|
{
|
|
throw new OverflowException($"Not enough space in the buffer to write {nameof(NetworkVariableDeltaMessage)}");
|
|
}
|
|
|
|
tempWriter.CopyTo(writer);
|
|
}
|
|
else
|
|
{
|
|
networkVariable.WriteDelta(writer);
|
|
}
|
|
|
|
if (!NetworkBehaviour.NetworkVariableIndexesToResetSet.Contains(i))
|
|
{
|
|
NetworkBehaviour.NetworkVariableIndexesToResetSet.Add(i);
|
|
NetworkBehaviour.NetworkVariableIndexesToReset.Add(i);
|
|
}
|
|
|
|
NetworkBehaviour.NetworkManager.NetworkMetrics.TrackNetworkVariableDeltaSent(
|
|
TargetClientId,
|
|
NetworkBehaviour.NetworkObject,
|
|
networkVariable.Name,
|
|
NetworkBehaviour.__getTypeName(),
|
|
writer.Length - startingSize);
|
|
}
|
|
}
|
|
}
|
|
|
|
public bool Deserialize(FastBufferReader reader, ref NetworkContext context, int receivedMessageVersion)
|
|
{
|
|
ByteUnpacker.ReadValueBitPacked(reader, out NetworkObjectId);
|
|
ByteUnpacker.ReadValueBitPacked(reader, out NetworkBehaviourIndex);
|
|
|
|
m_ReceivedNetworkVariableData = reader;
|
|
|
|
return true;
|
|
}
|
|
|
|
public void Handle(ref NetworkContext context)
|
|
{
|
|
var networkManager = (NetworkManager)context.SystemOwner;
|
|
|
|
if (networkManager.SpawnManager.SpawnedObjects.TryGetValue(NetworkObjectId, out NetworkObject networkObject))
|
|
{
|
|
var networkBehaviour = networkObject.GetNetworkBehaviourAtOrderIndex(NetworkBehaviourIndex);
|
|
|
|
if (networkBehaviour == null)
|
|
{
|
|
if (NetworkLog.CurrentLogLevel <= LogLevel.Normal)
|
|
{
|
|
NetworkLog.LogWarning($"Network variable delta message received for a non-existent behaviour. {nameof(NetworkObjectId)}: {NetworkObjectId}, {nameof(NetworkBehaviourIndex)}: {NetworkBehaviourIndex}");
|
|
}
|
|
}
|
|
else
|
|
{
|
|
for (int i = 0; i < networkBehaviour.NetworkVariableFields.Count; i++)
|
|
{
|
|
int varSize = 0;
|
|
if (networkManager.NetworkConfig.EnsureNetworkVariableLengthSafety)
|
|
{
|
|
ByteUnpacker.ReadValueBitPacked(m_ReceivedNetworkVariableData, out varSize);
|
|
|
|
if (varSize == 0)
|
|
{
|
|
continue;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
m_ReceivedNetworkVariableData.ReadValueSafe(out bool deltaExists);
|
|
if (!deltaExists)
|
|
{
|
|
continue;
|
|
}
|
|
}
|
|
|
|
var networkVariable = networkBehaviour.NetworkVariableFields[i];
|
|
|
|
if (networkManager.IsServer && !networkVariable.CanClientWrite(context.SenderId))
|
|
{
|
|
// we are choosing not to fire an exception here, because otherwise a malicious client could use this to crash the server
|
|
if (networkManager.NetworkConfig.EnsureNetworkVariableLengthSafety)
|
|
{
|
|
if (NetworkLog.CurrentLogLevel <= LogLevel.Developer)
|
|
{
|
|
NetworkLog.LogWarning($"Client wrote to {typeof(NetworkVariable<>).Name} without permission. => {nameof(NetworkObjectId)}: {NetworkObjectId} - {nameof(NetworkObject.GetNetworkBehaviourOrderIndex)}(): {networkObject.GetNetworkBehaviourOrderIndex(networkBehaviour)} - VariableIndex: {i}");
|
|
NetworkLog.LogError($"[{networkVariable.GetType().Name}]");
|
|
}
|
|
|
|
m_ReceivedNetworkVariableData.Seek(m_ReceivedNetworkVariableData.Position + varSize);
|
|
continue;
|
|
}
|
|
|
|
//This client wrote somewhere they are not allowed. This is critical
|
|
//We can't just skip this field. Because we don't actually know how to dummy read
|
|
//That is, we don't know how many bytes to skip. Because the interface doesn't have a
|
|
//Read that gives us the value. Only a Read that applies the value straight away
|
|
//A dummy read COULD be added to the interface for this situation, but it's just being too nice.
|
|
//This is after all a developer fault. A critical error should be fine.
|
|
// - TwoTen
|
|
if (NetworkLog.CurrentLogLevel <= LogLevel.Developer)
|
|
{
|
|
NetworkLog.LogError($"Client wrote to {typeof(NetworkVariable<>).Name} without permission. No more variables can be read. This is critical. => {nameof(NetworkObjectId)}: {NetworkObjectId} - {nameof(NetworkObject.GetNetworkBehaviourOrderIndex)}(): {networkObject.GetNetworkBehaviourOrderIndex(networkBehaviour)} - VariableIndex: {i}");
|
|
NetworkLog.LogError($"[{networkVariable.GetType().Name}]");
|
|
}
|
|
|
|
return;
|
|
}
|
|
int readStartPos = m_ReceivedNetworkVariableData.Position;
|
|
|
|
networkVariable.ReadDelta(m_ReceivedNetworkVariableData, networkManager.IsServer);
|
|
|
|
networkManager.NetworkMetrics.TrackNetworkVariableDeltaReceived(
|
|
context.SenderId,
|
|
networkObject,
|
|
networkVariable.Name,
|
|
networkBehaviour.__getTypeName(),
|
|
context.MessageSize);
|
|
|
|
|
|
if (networkManager.NetworkConfig.EnsureNetworkVariableLengthSafety)
|
|
{
|
|
if (m_ReceivedNetworkVariableData.Position > (readStartPos + varSize))
|
|
{
|
|
if (NetworkLog.CurrentLogLevel <= LogLevel.Normal)
|
|
{
|
|
NetworkLog.LogWarning($"Var delta read too far. {m_ReceivedNetworkVariableData.Position - (readStartPos + varSize)} bytes. => {nameof(NetworkObjectId)}: {NetworkObjectId} - {nameof(NetworkObject.GetNetworkBehaviourOrderIndex)}(): {networkObject.GetNetworkBehaviourOrderIndex(networkBehaviour)} - VariableIndex: {i}");
|
|
}
|
|
|
|
m_ReceivedNetworkVariableData.Seek(readStartPos + varSize);
|
|
}
|
|
else if (m_ReceivedNetworkVariableData.Position < (readStartPos + varSize))
|
|
{
|
|
if (NetworkLog.CurrentLogLevel <= LogLevel.Normal)
|
|
{
|
|
NetworkLog.LogWarning($"Var delta read too little. {readStartPos + varSize - m_ReceivedNetworkVariableData.Position} bytes. => {nameof(NetworkObjectId)}: {NetworkObjectId} - {nameof(NetworkObject.GetNetworkBehaviourOrderIndex)}(): {networkObject.GetNetworkBehaviourOrderIndex(networkBehaviour)} - VariableIndex: {i}");
|
|
}
|
|
|
|
m_ReceivedNetworkVariableData.Seek(readStartPos + varSize);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
else
|
|
{
|
|
networkManager.DeferredMessageManager.DeferMessage(IDeferredMessageManager.TriggerType.OnSpawn, NetworkObjectId, m_ReceivedNetworkVariableData, ref context);
|
|
}
|
|
}
|
|
}
|
|
}
|