Unnecessary GC in Multiplayer Tools & Unity Transport
@NoelStephensUnity is already working on this.
Since Aug 23, 2024.
Assessment
This issue has not been assessed yet.
Description
Description
Using 2.0.0-exp2, I've noticed that there's some GC as soon as Multiplayer Tools package is added.
The profiler indicated this begins in the Unity Transport class of NGO itself, so I locally imported Netcode for Gameobjects 2.0.0-exp2 & Multiplayer Tool packages.
The issue happens in two primary spots that I can see so far:
Issue 1: UnityTransport.ExtractNetworkMetrics under #if MULTIPLAYER_TOOLS_1_0_0_PRE_7
At: com.unity.netcode.gameobjects\Runtime\Transports\UTP\UnityTransport.cs
The line that causes garbage allocations seems to be var ngoConnectionIds = NetworkManager.ConnectedClients.Keys;
This seems to be unnecessary for NGO 2.0.0 and up, because NetworkManager.ConnectedClientsIds (a list as opposed to dictionary) is available and now exposed to clients as well as servers, and can be iterated without GC alloc using the count and index access.
Issue 2: Ngo1Adapter.RefreshClientIds
At: com.unity.multiplayer.tools\Adapters\Ngo1\Ngo1Adapter.cs
Granted, the name implies that NGO 2.0.0 and up would get its own adapter, eventually, I still think this is worth reporting.
This one also drops a clue that the package based itself explicitly on the fact that NGO1 limited access to connected client IDs and the multiplayer tools package was hacking access to them, understandable through this comment // NetworkManager.ConnectedClientsIds is only available on the server.
The faulty line is with using foreach (var clientId in m_NetworkManager.ConnectedClientsIds), and further down with foreach (var clientId in m_NetworkManager.SpawnManager.OwnershipToObjectsTable.Keys)
Once again, can be swapped to Count and index iterations. Can probably be unified for NGO 2.0.0 and up as well since Distributed Authority would not make use of IsServer, and both sides have access to ConnectedClientIds anyways.
Reproduce Steps
- In a new project, import NGO 2.0.0-exp2, Unity Transport, and Multiplayer Tools packages.
- Create a new scene
- Add a network manager, make it use unity's transport
- Add any way to begin hosting
- Open the profiler, and enter playmode
- Witness that UnityTransport.cs is allocating memory every frame
- Witness that NGO1Adapter is allocating memory every frame
Actual Outcome
The two classes allocate memory every frame
Expected Outcome
The two classes don't allocate memory every frame (or at all - It is entirely possible to reach a stable 0GC alloc with NGO~)
Environment
- OS: Windows 10
- Unity Version: 6000.0.0b13
- Netcode Version: 2.0.0-exp2
P.S Is there any proper place to report issues regarding the Multiplayer Tools pacakage? since its not part of this repository, but I couldn't find any official public repo for it specifically.
P.P.S Thank you very much for the frequent responses to the issues! I'm loving the activity visible around the Multiplayer Packages and hoping to help!
- Dominant language
- C#
- Stars
- 2.3k
- Forks
- 461
- Avg merge
- 3d 16h
- Merged PRs (30d)
- 20
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Unity-Technologies/com.unity.netcode.gameobjects
-
stat:import type:bug
Difficulty 4/5 3-5 days Newbie friendliness 68/100
-
stat:reply-needed type:support
Difficulty 4/5 3-5 days Newbie friendliness 55/100
Unity-Technologies/com.unity.netcode.gameobjects#4095 · 10 comments ·
-
stat:awaiting-triage stat:Investigating type:bug
Unity-Technologies/com.unity.netcode.gameobjects#3912 · 5 comments · 1 assignee ·
-
Tracking type:feature-2.x
Difficulty 5/5 Over a week Newbie friendliness 35/100
Unity-Technologies/com.unity.netcode.gameobjects#3870 · 5 comments ·
-
Tracking type:feature
Difficulty 4/5 3-5 days Newbie friendliness 48/100
Unity-Technologies/com.unity.netcode.gameobjects#3830 · 7 comments ·
All issues in Unity-Technologies/com.unity.netcode.gameobjects
Similar issues
-
type/automation type/tech-debt
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
t/bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
ci-failure-cause test-failure
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
area:auth FE mvp P3
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
klasolsson81/jobbliggaren#1788 ·