Skip to content

perf: Improve RPC bulking and delegate alloc fix #357

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TwoTenPvP merged 3 commits into from
Aug 26, 2020
Merged

perf: Improve RPC bulking and delegate alloc fix #357

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8e31242
perf: Bulk serialized client rpcs
TwoTenPvP Aug 26, 2020
36d3090
fix: Compilation problems
TwoTenPvP Aug 26, 2020
1623065
perf: Fixed delegate alloc on incoming message
TwoTenPvP Aug 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 13 additions & 49 deletions MLAPI/Core/NetworkedBehaviour.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1258,48 +1258,20 @@ internal void SendClientRPCPerformance(ulong hash, List<ulong> clientIds, Strea

stream.CopyFrom(messageStream);

if (clientIds == null)
if (IsHost)
{
for (int i = 0; i < NetworkingManager.Singleton.ConnectedClientsList.Count; i++)
if (this.NetworkedObject.observers.Contains(NetworkingManager.Singleton.LocalClientId))
{
if (!this.NetworkedObject.observers.Contains(NetworkingManager.Singleton.ConnectedClientsList[i].ClientId))
{
if (NetworkLog.CurrentLogLevel <= LogLevel.Developer) NetworkLog.LogWarning("Silently suppressed ClientRPC because a target in the bulk list was not an observer");
continue;
}

if (IsHost && NetworkingManager.Singleton.ConnectedClientsList[i].ClientId == NetworkingManager.Singleton.LocalClientId)
{
messageStream.Position = 0;
InvokeClientRPCLocal(hash, NetworkingManager.Singleton.LocalClientId, messageStream);
}
else
{
InternalMessageSender.Send(NetworkingManager.Singleton.ConnectedClientsList[i].ClientId, MLAPIConstants.MLAPI_CLIENT_RPC, string.IsNullOrEmpty(channel) ? "MLAPI_DEFAULT_MESSAGE" : channel, stream, security, null);
}
messageStream.Position = 0;
InvokeClientRPCLocal(hash, NetworkingManager.Singleton.LocalClientId, messageStream);
}
}
else
{
for (int i = 0; i < clientIds.Count; i++)
else
{
if (!this.NetworkedObject.observers.Contains(clientIds[i]))
{
if (NetworkLog.CurrentLogLevel <= LogLevel.Normal) NetworkLog.LogWarning("Cannot send ClientRPC to client without visibility to the object");
continue;
}

if (IsHost && clientIds[i] == NetworkingManager.Singleton.LocalClientId)
{
messageStream.Position = 0;
InvokeClientRPCLocal(hash, NetworkingManager.Singleton.LocalClientId, messageStream);
}
else
{
InternalMessageSender.Send(clientIds[i], MLAPIConstants.MLAPI_CLIENT_RPC, string.IsNullOrEmpty(channel) ? "MLAPI_DEFAULT_MESSAGE" : channel, stream, security, null);
}
if (NetworkLog.CurrentLogLevel <= LogLevel.Developer) NetworkLog.LogWarning("Silently suppressed ClientRPC because a connected client was not an observer");
}
}

InternalMessageSender.Send(MLAPIConstants.MLAPI_CLIENT_RPC, string.IsNullOrEmpty(channel) ? "MLAPI_DEFAULT_MESSAGE" : channel, clientIds, stream, security, this.NetworkedObject);
}
}
}
Expand All @@ -1324,28 +1296,20 @@ internal void SendClientRPCPerformance(ulong hash, Stream messageStream, ulong c
stream.CopyFrom(messageStream);


for (int i = 0; i < NetworkingManager.Singleton.ConnectedClientsList.Count; i++)
if (IsHost && NetworkingManager.Singleton.LocalClientId != clientIdToIgnore)
{
if (NetworkingManager.Singleton.ConnectedClientsList[i].ClientId == clientIdToIgnore)
continue;

if (!this.NetworkedObject.observers.Contains(NetworkingManager.Singleton.ConnectedClientsList[i].ClientId))
{
if (NetworkLog.CurrentLogLevel <= LogLevel.Developer) NetworkLog.LogWarning("Silently suppressed ClientRPC because a connected client was not an observer");
continue;
}


if (IsHost && NetworkingManager.Singleton.ConnectedClientsList[i].ClientId == NetworkingManager.Singleton.LocalClientId)
if (this.NetworkedObject.observers.Contains(NetworkingManager.Singleton.LocalClientId))
{
messageStream.Position = 0;
InvokeClientRPCLocal(hash, NetworkingManager.Singleton.LocalClientId, messageStream);
}
else
{
InternalMessageSender.Send(NetworkingManager.Singleton.ConnectedClientsList[i].ClientId, MLAPIConstants.MLAPI_CLIENT_RPC, string.IsNullOrEmpty(channel) ? "MLAPI_DEFAULT_MESSAGE" : channel, stream, security, null);
if (NetworkLog.CurrentLogLevel <= LogLevel.Developer) NetworkLog.LogWarning("Silently suppressed ClientRPC because a connected client was not an observer");
}
}

InternalMessageSender.Send(MLAPIConstants.MLAPI_CLIENT_RPC, string.IsNullOrEmpty(channel) ? "MLAPI_DEFAULT_MESSAGE" : channel, clientIdToIgnore, stream, security, this.NetworkedObject);
}
}
}
Expand Down
85 changes: 58 additions & 27 deletions MLAPI/Core/NetworkingManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -938,29 +938,6 @@ internal void HandleIncomingData(ulong clientId, string channelName, ArraySegmen
return;
}


void bufferCallback(ulong networkId)
{
if (!allowBuffer)
{
// This is to prevent recursive buffering
if (NetworkLog.CurrentLogLevel <= LogLevel.Error) NetworkLog.LogError("A message of type " + MLAPIConstants.MESSAGE_NAMES[messageType] + " was recursivley buffered. It has been dropped.");
return;
}

if (!NetworkConfig.EnableMessageBuffering)
{
throw new InvalidOperationException("Cannot buffer with buffering disabled.");
}

if (IsServer)
{
throw new InvalidOperationException("Cannot buffer on server.");
}

BufferManager.BufferMessageForNetworkId(networkId, clientId, channelName, receiveTime, data);
}

#region INTERNAL MESSAGE

switch (messageType)
Expand Down Expand Up @@ -993,10 +970,26 @@ void bufferCallback(ulong networkId)
if (IsClient) InternalMessageHandler.HandleTimeSync(clientId, messageStream, receiveTime);
break;
case MLAPIConstants.MLAPI_NETWORKED_VAR_DELTA:
InternalMessageHandler.HandleNetworkedVarDelta(clientId, messageStream, bufferCallback);
InternalMessageHandler.HandleNetworkedVarDelta(clientId, messageStream, BufferCallback, new PreBufferPreset()
{
AllowBuffer = allowBuffer,
ChannelName = channelName,
ClientId = clientId,
Data = data,
MessageType = messageType,
ReceiveTime = receiveTime
});
break;
case MLAPIConstants.MLAPI_NETWORKED_VAR_UPDATE:
InternalMessageHandler.HandleNetworkedVarUpdate(clientId, messageStream, bufferCallback);
InternalMessageHandler.HandleNetworkedVarUpdate(clientId, messageStream, BufferCallback, new PreBufferPreset()
{
AllowBuffer = allowBuffer,
ChannelName = channelName,
ClientId = clientId,
Data = data,
MessageType = messageType,
ReceiveTime = receiveTime
});
break;
case MLAPIConstants.MLAPI_SERVER_RPC:
if (IsServer) InternalMessageHandler.HandleServerRPC(clientId, messageStream);
Expand All @@ -1008,10 +1001,26 @@ void bufferCallback(ulong networkId)
if (IsClient) InternalMessageHandler.HandleServerRPCResponse(clientId, messageStream);
break;
case MLAPIConstants.MLAPI_CLIENT_RPC:
if (IsClient) InternalMessageHandler.HandleClientRPC(clientId, messageStream, bufferCallback);
if (IsClient) InternalMessageHandler.HandleClientRPC(clientId, messageStream, BufferCallback, new PreBufferPreset()
{
AllowBuffer = allowBuffer,
ChannelName = channelName,
ClientId = clientId,
Data = data,
MessageType = messageType,
ReceiveTime = receiveTime
});
break;
case MLAPIConstants.MLAPI_CLIENT_RPC_REQUEST:
if (IsClient) InternalMessageHandler.HandleClientRPCRequest(clientId, messageStream, channelName, security, bufferCallback);
if (IsClient) InternalMessageHandler.HandleClientRPCRequest(clientId, messageStream, channelName, security, BufferCallback, new PreBufferPreset()
{
AllowBuffer = allowBuffer,
ChannelName = channelName,
ClientId = clientId,
Data = data,
MessageType = messageType,
ReceiveTime = receiveTime
});
break;
case MLAPIConstants.MLAPI_CLIENT_RPC_RESPONSE:
if (IsServer) InternalMessageHandler.HandleClientRPCResponse(clientId, messageStream);
Expand Down Expand Up @@ -1052,6 +1061,28 @@ void bufferCallback(ulong networkId)
}
}

private void BufferCallback(ulong networkId, PreBufferPreset preset)
{
if (!preset.AllowBuffer)
{
// This is to prevent recursive buffering
if (NetworkLog.CurrentLogLevel <= LogLevel.Error) NetworkLog.LogError("A message of type " + MLAPIConstants.MESSAGE_NAMES[preset.MessageType] + " was recursivley buffered. It has been dropped.");
return;
}

if (!NetworkConfig.EnableMessageBuffering)
{
throw new InvalidOperationException("Cannot buffer with buffering disabled.");
}

if (IsServer)
{
throw new InvalidOperationException("Cannot buffer on server.");
}

BufferManager.BufferMessageForNetworkId(networkId, preset.ClientId, preset.ChannelName, preset.ReceiveTime, preset.Data);
}

/// <summary>
/// Disconnects the remote client.
/// </summary>
Expand Down
13 changes: 13 additions & 0 deletions MLAPI/Messaging/Buffering/PreBufferPreset.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
using System;
namespace MLAPI.Messaging.Buffering
{
internal struct PreBufferPreset
{
public byte MessageType;
public bool AllowBuffer;
public ulong ClientId;
public string ChannelName;
public float ReceiveTime;
public ArraySegment<byte> Data;
}
}
16 changes: 8 additions & 8 deletions MLAPI/Messaging/InternalMessageHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -497,7 +497,7 @@ internal static void HandleTimeSync(ulong clientId, Stream stream, float receive
}
}

internal static void HandleNetworkedVarDelta(ulong clientId, Stream stream, Action<ulong> bufferCallback)
internal static void HandleNetworkedVarDelta(ulong clientId, Stream stream, Action<ulong, PreBufferPreset> bufferCallback, PreBufferPreset bufferPreset)
{
if (!NetworkingManager.Singleton.NetworkConfig.EnableNetworkedVar)
{
Expand Down Expand Up @@ -530,12 +530,12 @@ internal static void HandleNetworkedVarDelta(ulong clientId, Stream stream, Acti
else
{
if (NetworkLog.CurrentLogLevel <= LogLevel.Normal) NetworkLog.LogWarning("NetworkedVarDelta message recieved for a non existant object with id: " + networkId + ". This delta will be buffered and might be recovered.");
bufferCallback(networkId);
bufferCallback(networkId, bufferPreset);
}
}
}

internal static void HandleNetworkedVarUpdate(ulong clientId, Stream stream, Action<ulong> bufferCallback)
internal static void HandleNetworkedVarUpdate(ulong clientId, Stream stream, Action<ulong, PreBufferPreset> bufferCallback, PreBufferPreset bufferPreset)
{
if (!NetworkingManager.Singleton.NetworkConfig.EnableNetworkedVar)
{
Expand Down Expand Up @@ -568,7 +568,7 @@ internal static void HandleNetworkedVarUpdate(ulong clientId, Stream stream, Act
else
{
if (NetworkLog.CurrentLogLevel <= LogLevel.Normal) NetworkLog.LogWarning("NetworkedVarUpdate message recieved for a non existant object with id: " + networkId + ". This delta will be buffered and might be recovered.");
bufferCallback(networkId);
bufferCallback(networkId, bufferPreset);
}
}
}
Expand Down Expand Up @@ -689,7 +689,7 @@ internal static void HandleServerRPCResponse(ulong clientId, Stream stream)
}
}

internal static void HandleClientRPC(ulong clientId, Stream stream, Action<ulong> bufferCallback)
internal static void HandleClientRPC(ulong clientId, Stream stream, Action<ulong, PreBufferPreset> bufferCallback, PreBufferPreset bufferPreset)
{
using (PooledBitReader reader = PooledBitReader.Get(stream))
{
Expand Down Expand Up @@ -717,12 +717,12 @@ internal static void HandleClientRPC(ulong clientId, Stream stream, Action<ulong
else
{
if (NetworkLog.CurrentLogLevel <= LogLevel.Normal) NetworkLog.LogWarning("ClientRPC message recieved for a non existant object with id: " + networkId + ". This message will be buffered and might be recovered.");
bufferCallback(networkId);
bufferCallback(networkId, bufferPreset);
}
}
}

internal static void HandleClientRPCRequest(ulong clientId, Stream stream, string channelName, SecuritySendFlags security, Action<ulong> bufferCallback)
internal static void HandleClientRPCRequest(ulong clientId, Stream stream, string channelName, SecuritySendFlags security, Action<ulong, PreBufferPreset> bufferCallback, PreBufferPreset bufferPreset)
{
using (PooledBitReader reader = PooledBitReader.Get(stream))
{
Expand Down Expand Up @@ -762,7 +762,7 @@ internal static void HandleClientRPCRequest(ulong clientId, Stream stream, strin
else
{
if (NetworkLog.CurrentLogLevel <= LogLevel.Normal) NetworkLog.LogWarning("ClientRPCRequest message recieved for a non existant object with id: " + networkId + ". This message will be buffered and might be recovered.");
bufferCallback(networkId);
bufferCallback(networkId, bufferPreset);
}
}
}
Expand Down
44 changes: 44 additions & 0 deletions MLAPI/Messaging/InternalMessageSender.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using System;
using System.Collections.Generic;
using MLAPI.Configuration;
using MLAPI.Internal;
using MLAPI.Logging;
Expand Down Expand Up @@ -70,6 +71,49 @@ internal static void Send(byte messageType, string channelName, BitStream messag
}
}

internal static void Send(byte messageType, string channelName, List<ulong> clientIds, BitStream messageStream, SecuritySendFlags flags, NetworkedObject targetObject)
{
if (clientIds == null)
{
Send(messageType, channelName, messageStream, flags, targetObject);
return;
}

bool encrypted = ((flags & SecuritySendFlags.Encrypted) == SecuritySendFlags.Encrypted) && NetworkingManager.Singleton.NetworkConfig.EnableEncryption;
bool authenticated = ((flags & SecuritySendFlags.Authenticated) == SecuritySendFlags.Authenticated) && NetworkingManager.Singleton.NetworkConfig.EnableEncryption;

if (authenticated || encrypted)
{
for (int i = 0; i < clientIds.Count; i++)
{
Send(clientIds[i], messageType, channelName, messageStream, flags, targetObject);
}
}
else
{
messageStream.PadStream();

using (BitStream stream = MessagePacker.WrapMessage(messageType, 0, messageStream, flags))
{
NetworkProfiler.StartEvent(TickType.Send, (uint)stream.Length, channelName, MLAPIConstants.MESSAGE_NAMES[messageType]);
for (int i = 0; i < clientIds.Count; i++)
{
if (NetworkingManager.Singleton.IsServer && clientIds[i] == NetworkingManager.Singleton.ServerClientId)
continue;

if (targetObject != null && !targetObject.observers.Contains(clientIds[i]))
{
if (NetworkLog.CurrentLogLevel <= LogLevel.Developer) NetworkLog.LogWarning("Silently suppressed send(all) call because it was directed to an object without visibility");
continue;
}

NetworkingManager.Singleton.NetworkConfig.NetworkTransport.Send(clientIds[i], new ArraySegment<byte>(stream.GetBuffer(), 0, (int)stream.Length), channelName);
}
NetworkProfiler.EndEvent();
}
}
}

internal static void Send(byte messageType, string channelName, ulong clientIdToIgnore, BitStream messageStream, SecuritySendFlags flags, NetworkedObject targetObject)
{
bool encrypted = ((flags & SecuritySendFlags.Encrypted) == SecuritySendFlags.Encrypted) && NetworkingManager.Singleton.NetworkConfig.EnableEncryption;
Expand Down