Named Messages: Don't allocate a byte array whenever you send a message
Maintainer thường phản hồi trong vòng 3 ngày
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức phù hợp với người mới
- 38/100
- Loại issue
- Tính năng
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Đình trệ
- Lĩnh vực
- networking, performance
Hướng nghiên cứu
Bắt đầu bằng cách đọc Runtime/Hashing/XXHash.cs và Runtime/Messaging/CustomMessageManager.cs, đặc biệt là đường dẫn gọi SendNamedMessage và phần cấp phát được ghi nhận tại các dòng đã báo cáo. Dùng profiler để tái hiện việc cấp phát khi gửi message có tên, sau đó xác định cách tránh việc này trong khi vẫn giữ nguyên hành vi hash 32-bit và 64-bit khi kích thước hash được cấu hình thay đổi. Công việc được xem là hoàn tất khi các lần gửi có tên không còn cấp phát mảng byte của tên và hành vi hiện có vẫn được các bài kiểm thử khả dụng bao phủ.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Is your feature request related to a problem? Please describe.
Named Messages are a great way to send custom messages that are not tied to a specific game object and/or are more dynamic than standard RPC calls. However, the only way to send these messages (via CustomMessagingManager.SendNamedMessage) is by providing a string which gets then hashed using XXHash.Hash32 or XXHash.Hash64 which then calls Encoding.UTF8.GetBytes(text). This function always allocates a new byte array, containing the string. As far as I can see, there is no other possible way to send a named message.
Describe the solution you'd like
I see two possible solutions:
- Don't use
Encoding.UTF8.GetBytes(text)and instead use one of the overloads where you can specify an existingbyte[]or Span. This would allow the use of a pre-alloced buffer (e.g. from a temp alloced NativeArray or an array pool). - Add a function overload where I can provide the hash myself (and provide a way to obtain this hash). This would work similar to e.g.
Animator.StringToHashorShader.PropertyToID. However, the HashSize can be 4 bytes or 8 bytes (depending onNetworkManager.NetworkConfig.RpcHashSize) and can even change during the runtime (at least,CustomMessageManagersupports this case). Therefore it might be a bit confusing to the user which hash (with which data type) they have to use in this case - unless theGetHashfunction returns a struct which contains both hashes...which might be a bit weird as well.
Describe alternatives you've considered
- I can use unnamed messages and just re-implement the logic from named messages, using the solution described above.
Additional context
Example GC Alloc from the profiler:
Size: 41
Call Stack:
mscorlib.dll!System.Text::Encoding.GetBytes()
Unity.Netcode.Runtime.dll!Unity.Netcode::XXHash.Hash32() ./Library/PackageCache/[email protected]/Runtime/Hashing/XXHash.cs:218
Unity.Netcode.Runtime.dll!Unity.Netcode::CustomMessagingManager.SendNamedMessage() ./Library/PackageCache/[email protected]/Runtime/Messaging/CustomMessageManager.cs:296
Unity.Netcode.Runtime.dll!Unity.Netcode::CustomMessagingManager.SendNamedMessageToAll() ./Library/PackageCache/[email protected]/Runtime/Messaging/CustomMessageManager.cs:236
I wouldn't say this is a huge problem (though it depends on how many messages are being sent and how long their name is), and unnamed messages are an easy workaround. However, most of this package seems to focus on allocating as little as possible, and I think that fixing this problem here shouldn't be too hard (otherwise just ignore this issue).
Thanks for your work on this amazing package, I really enjoy using it! I can also provide a PR with a fix mentioned above if you would like me to, I just didn't want to submit something unwanted.
- Ngôn ngữ chính
- C#
- Star
- 2.3k
- Fork
- 465
- Merge trung bình
- 3 ngày 12 giờ
- Pull request đã merge (30 ngày)
- 39
Chuẩn bị môi trường
- Không có Dockerfile hay tệp Docker Compose
- Có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của Unity-Technologies/com.unity.netcode.gameobjects
-
TimeSyncMessage is sent reliably, so a late one resets the client clock backwards and stalls its NetworkTransformsCó thể đã có người làm @reginaldalfret đã nhận 8 ngày trước. Đang mở
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 52/100
Unity-Technologies/com.unity.netcode.gameobjects#4249 ·
Maintainer thường phản hồi trong vòng 3 ngày
-
NetworkTransform: half-float base update dropped as out of order when UseUnreliableDeltas is on, so later deltas decode ~2 m offCó thể đã có người làm @NoelStephensUnity đã nhận 8 ngày trước. Đang mởport:3.x-completed priority:medium stat:imported type:bug
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 57/100
Unity-Technologies/com.unity.netcode.gameobjects#4248 ·
Maintainer thường phản hồi trong vòng 3 ngày
-
Tracking type:feature-2.x
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 35/100
Unity-Technologies/com.unity.netcode.gameobjects#3870 · 5 bình luận ·
Maintainer thường phản hồi trong vòng 3 ngày
-
Please error, or at least warn, when a managed type is included in INetworkSerializeByMemcpyĐang mởTracking type:feature
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 48/100
Unity-Technologies/com.unity.netcode.gameobjects#3830 · 7 bình luận ·
Maintainer thường phản hồi trong vòng 3 ngày
-
priority:medium stat:imported type:feature type:feature-2.x
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 42/100
Unity-Technologies/com.unity.netcode.gameobjects#3706 · 5 bình luận ·
Maintainer thường phản hồi trong vòng 3 ngày
Tất cả issue của Unity-Technologies/com.unity.netcode.gameobjects
Issue tương tự
-
hand-to-AI
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
CactuseSecurity/firewall-orchestrator#5803 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Typed MINID rejects numeric thresholds with a leading plus sign accepted by Redis and ValkeyĐang mởbug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 74/100
Maintainer thường phản hồi trong vòng 1 ngày
-
DXF with empty names failsĐang mởbug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
Maintainer thường phản hồi trong vòng 3 ngày
-
bug python
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 88/100
ilia-sokolov/OfficeAgent.NET#89 ·
Maintainer thường phản hồi trong vòng 13 ngày