Skip to content
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

Jump to bottom

feat(Profiling): marker for shallow profiling within NetworkLoop #3939

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

feat(Profiling): marker for shallow profiling within NetworkLoop #3939

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
2a992e6
feat(Profiling): NetworkLoop sampling instead of "UpdateFunction.Invoke"
miwarnec Oct 31, 2024
4ec2744
NetworkServer markers
miwarnec Oct 31, 2024
62ba668
NetworkClient markers
miwarnec Oct 31, 2024
0b165ff
better
miwarnec Oct 31, 2024
aefde5c
better
miwarnec Oct 31, 2024
b31fe9e
server: more
miwarnec Oct 31, 2024
69d9aa2
client: more
miwarnec Oct 31, 2024
4bebec8
per NI WIP
miwarnec Oct 31, 2024
bf4f0b5
nonalloc
miwarnec Oct 31, 2024
ed58604
client measure transport
miwarnec Oct 31, 2024
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
18 changes: 18 additions & 0 deletions Assets/Mirror/Core/NetworkClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
using System.Linq;
using Mirror.RemoteCalls;
using UnityEngine;
using UnityEngine.Profiling;

namespace Mirror
{
Expand Down Expand Up @@ -1500,8 +1501,11 @@ internal static void ChangeOwner(NetworkIdentity identity, ChangeOwnerMessage me
internal static void NetworkEarlyUpdate()
{
// process all incoming messages first before updating the world
// profiling marker for shallow profiling to show more than "UpdateFunction.Invoke
Profiler.BeginSample("NetworkClient: Transport Processing");
if (Transport.active != null)
Transport.active.ClientEarlyUpdate();
Profiler.EndSample();

// time snapshot interpolation
UpdateTimeInterpolation();
Expand Down Expand Up @@ -1532,7 +1536,10 @@ internal static void NetworkLateUpdate()
bool sendIntervalElapsed = AccurateInterval.Elapsed(NetworkTime.localTime, sendInterval, ref lastSendTime);
if (!Application.isPlaying || sendIntervalElapsed)
{
// profiling marker for shallow profiling to show more than "UpdateFunction.Invoke
Profiler.BeginSample("NetworkClient: Broadcast");
Broadcast();
Profiler.EndSample();
}

UpdateConnectionQuality();
Expand Down Expand Up @@ -1589,8 +1596,11 @@ void UpdateConnectionQuality()
}

// process all outgoing messages after updating the world
// profiling marker for shallow profiling to show more than "UpdateFunction.Invoke
Profiler.BeginSample("NetworkClient: Transport Flush");
if (Transport.active != null)
Transport.active.ClientLateUpdate();
Profiler.EndSample();
}

// broadcast ///////////////////////////////////////////////////////////
Expand Down Expand Up @@ -1628,7 +1638,11 @@ static void BroadcastToServer()
{
// get serialization for this entity viewed by this connection
// (if anything was serialized this time)
// profiling marker for shallow profiling to show more than "UpdateFunction.Invoke
Profiler.BeginSample("BroadcastToServer: SerializeClient");
identity.SerializeClient(writer);
Profiler.EndSample();

if (writer.Position > 0)
{
// send state update message
Expand All @@ -1637,7 +1651,11 @@ static void BroadcastToServer()
netId = identity.netId,
payload = writer.ToArraySegment()
};

// profiling marker for shallow profiling to show more than "UpdateFunction.Invoke
Profiler.BeginSample("BroadcastToServer: Flush");
Send(message);
Profiler.EndSample();
}
}
}
Expand Down
17 changes: 17 additions & 0 deletions Assets/Mirror/Core/NetworkIdentity.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
using System.Runtime.CompilerServices;
using Mirror.RemoteCalls;
using UnityEngine;
using UnityEngine.Profiling;
using UnityEngine.Serialization;

#if UNITY_EDITOR
Expand Down Expand Up @@ -224,6 +225,9 @@ internal set
static readonly Dictionary<ulong, NetworkIdentity> sceneIds =
new Dictionary<ulong, NetworkIdentity>();

// profiling: cache the serialization string to avoid runtime allocations
string profilingSerializationTag = $"NetworkIdentity: Serialize"; // set to {name} in Awake

// Helper function to handle Command/Rpc
internal void HandleRemoteCall(byte componentIndex, ushort functionHash, RemoteCallType remoteCallType, NetworkReader reader, NetworkConnectionToClient senderConnection = null)
{
Expand Down Expand Up @@ -332,6 +336,9 @@ void ValidateComponents()
// internal so we can call it during unit tests too.
internal void Awake()
{
// cache profiling string to avoid runtime allocations
profilingSerializationTag = $"NetworkIdentity: Serialize {name}";

// initialize NetworkBehaviour components.
// Awake() is called immediately after initialization.
// no one can overwrite it because NetworkIdentity is sealed.
Expand Down Expand Up @@ -936,6 +943,9 @@ internal static bool IsDirty(ulong mask, int index)
// check ownerWritten/observersWritten to know if anything was written
internal void SerializeServer(bool initialState, NetworkWriter ownerWriter, NetworkWriter observersWriter)
{
// profiling marker for shallow profiling to show more than "UpdateFunction.Invoke
Profiler.BeginSample($"NetworkIdentity: Serialize {name}"); // TODO nonalloc

// ensure NetworkBehaviours are valid before usage
ValidateComponents();
NetworkBehaviour[] components = NetworkBehaviours;
Expand Down Expand Up @@ -1004,11 +1014,16 @@ internal void SerializeServer(bool initialState, NetworkWriter ownerWriter, Netw
}
}
}

Profiler.EndSample();
}

// serialize components into writer on the client.
internal void SerializeClient(NetworkWriter writer)
{
// profiling marker for shallow profiling to show more than "UpdateFunction.Invoke
Profiler.BeginSample($"NetworkIdentity: Serialize {name}"); // TODO nonalloc

// ensure NetworkBehaviours are valid before usage
ValidateComponents();
NetworkBehaviour[] components = NetworkBehaviours;
Expand Down Expand Up @@ -1061,6 +1076,8 @@ internal void SerializeClient(NetworkWriter writer)
}
}
}

Profiler.EndSample();
}

// deserialize components from the client on the server.
Expand Down
11 changes: 11 additions & 0 deletions Assets/Mirror/Core/NetworkLoop.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
using UnityEngine;
using UnityEngine.LowLevel;
using UnityEngine.PlayerLoop;
using UnityEngine.Profiling;

namespace Mirror
{
Expand Down Expand Up @@ -187,12 +188,17 @@ static void NetworkEarlyUpdate()
// however, we only want to call NetworkServer/Client in play mode.
if (!Application.isPlaying) return;

// profiling marker for shallow profiling to show more than "UpdateFunction.Invoke"
Profiler.BeginSample("NetworkEarlyUpdate");

NetworkTime.EarlyUpdate();
//Debug.Log($"NetworkEarlyUpdate {Time.time}");
NetworkServer.NetworkEarlyUpdate();
NetworkClient.NetworkEarlyUpdate();
// invoke event after mirror has done it's early updating.
OnEarlyUpdate?.Invoke();

Profiler.EndSample();
}

static void NetworkLateUpdate()
Expand All @@ -201,11 +207,16 @@ static void NetworkLateUpdate()
// however, we only want to call NetworkServer/Client in play mode.
if (!Application.isPlaying) return;

// profiling marker for shallow profiling to show more than "UpdateFunction.Invoke"
Profiler.BeginSample("NetworkLateUpdate");

//Debug.Log($"NetworkLateUpdate {Time.time}");
// invoke event before mirror does its final late updating.
OnLateUpdate?.Invoke();
NetworkServer.NetworkLateUpdate();
NetworkClient.NetworkLateUpdate();

Profiler.EndSample();
}
}
}
27 changes: 27 additions & 0 deletions Assets/Mirror/Core/NetworkServer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
using System.Linq;
using Mirror.RemoteCalls;
using UnityEngine;
using UnityEngine.Profiling;

namespace Mirror
{
Expand Down Expand Up @@ -1928,15 +1929,23 @@ static void BroadcastToConnection(NetworkConnectionToClient connection)
{
// get serialization for this entity viewed by this connection
// (if anything was serialized this time)
// profiling marker for shallow profiling to show more than "UpdateFunction.Invoke
Profiler.BeginSample("BroadcastToConnection: SerializeForConnection");
NetworkWriter serialization = SerializeForConnection(identity, connection);
Profiler.EndSample();

if (serialization != null)
{
EntityStateMessage message = new EntityStateMessage
{
netId = identity.netId,
payload = serialization.ToArraySegment()
};

// profiling marker for shallow profiling to show more than "UpdateFunction.Invoke
Profiler.BeginSample("BroadcastToConnection: Send");
connection.Send(message);
Profiler.EndSample();
}
}
// spawned list should have no null entries because we
Expand Down Expand Up @@ -2017,7 +2026,10 @@ static void Broadcast()
}

// update connection to flush out batched messages
// profiling marker for shallow profiling to show more than "UpdateFunction.Invoke
Profiler.BeginSample("Broadcast: Flush");
connection.Update();
Profiler.EndSample();
}
}

Expand All @@ -2034,12 +2046,19 @@ internal static void NetworkEarlyUpdate()
}

// process all incoming messages first before updating the world
// profiling marker for shallow profiling to show more than "UpdateFunction.Invoke
Profiler.BeginSample("NetworkServer: Transport Processing");
if (Transport.active != null)
Transport.active.ServerEarlyUpdate();
Profiler.EndSample();


// step each connection's local time interpolation in early update.
// profiling marker for shallow profiling to show more than "UpdateFunction.Invoke
Profiler.BeginSample("NetworkServer: Connections Time Update");
foreach (NetworkConnectionToClient connection in connections.Values)
connection.UpdateTimeInterpolation();
Profiler.EndSample();

if (active) earlyUpdateDuration.End();
}
Expand Down Expand Up @@ -2068,13 +2087,21 @@ internal static void NetworkLateUpdate()
// Unity 2019 doesn't have Time.timeAsDouble yet
bool sendIntervalElapsed = AccurateInterval.Elapsed(NetworkTime.localTime, sendInterval, ref lastSendTime);
if (!Application.isPlaying || sendIntervalElapsed)
{
// profiling marker for shallow profiling to show more than "UpdateFunction.Invoke
Profiler.BeginSample("NetworkServer: Broadcast");
Broadcast();
Profiler.EndSample();
}
}

// process all outgoing messages after updating the world
// (even if not active. still want to process disconnects etc.)
// profiling marker for shallow profiling to show more than "UpdateFunction.Invoke
Profiler.BeginSample("NetworkServer: Transport Flush");
if (Transport.active != null)
Transport.active.ServerLateUpdate();
Profiler.EndSample();

// measure actual tick rate every second.
if (active)
Expand Down