// Copyright (c) 2012-2022 Wojciech Figat. All rights reserved. #include "NetworkReplicator.h" #include "NetworkClient.h" #include "NetworkManager.h" #include "NetworkInternal.h" #include "NetworkStream.h" #include "INetworkSerializable.h" #include "NetworkMessage.h" #include "NetworkPeer.h" #include "NetworkChannelType.h" #include "NetworkEvent.h" #include "Engine/Core/Log.h" #include "Engine/Core/Collections/HashSet.h" #include "Engine/Core/Collections/Dictionary.h" #include "Engine/Platform/CriticalSection.h" #include "Engine/Engine/EngineService.h" #include "Engine/Level/Actor.h" #include "Engine/Level/SceneObject.h" #include "Engine/Level/Prefabs/Prefab.h" #include "Engine/Level/Prefabs/PrefabManager.h" #include "Engine/Profiler/ProfilerCPU.h" #include "Engine/Scripting/Script.h" #include "Engine/Scripting/Scripting.h" #include "Engine/Scripting/ScriptingObjectReference.h" #include "Engine/Threading/Threading.h" #include "Engine/Threading/ThreadLocal.h" // Enables verbose logging for Network Replicator actions (dev-only) #define NETWORK_REPLICATOR_DEBUG_LOG 1 #if NETWORK_REPLICATOR_DEBUG_LOG #define NETWORK_REPLICATOR_LOG(messageType, format, ...) LOG(messageType, format, ##__VA_ARGS__) #else #define NETWORK_REPLICATOR_LOG(messageType, format, ...) #endif PACK_STRUCT(struct NetworkMessageObjectReplicate { NetworkMessageIDs ID = NetworkMessageIDs::ObjectReplicate; uint32 OwnerFrame; Guid ObjectId; // TODO: introduce networked-ids to synchronize unique ids as ushort (less data over network) Guid ParentId; char ObjectTypeName[128]; // TODO: introduce networked-name to synchronize unique names as ushort (less data over network) uint16 DataSize; }); PACK_STRUCT(struct NetworkMessageObjectSpawn { NetworkMessageIDs ID = NetworkMessageIDs::ObjectSpawn; Guid ObjectId; Guid ParentId; Guid PrefabId; Guid PrefabObjectID; uint32 OwnerClientId; char ObjectTypeName[128]; // TODO: introduce networked-name to synchronize unique names as ushort (less data over network) }); PACK_STRUCT(struct NetworkMessageObjectDespawn { NetworkMessageIDs ID = NetworkMessageIDs::ObjectDespawn; Guid ObjectId; }); PACK_STRUCT(struct NetworkMessageObjectRole { NetworkMessageIDs ID = NetworkMessageIDs::ObjectRole; Guid ObjectId; uint32 OwnerClientId; }); struct NetworkReplicatedObject { ScriptingObjectReference Object; Guid ObjectId; Guid ParentId; uint32 OwnerClientId; uint32 LastOwnerFrame = 0; NetworkObjectRole Role; uint8 Spawned = false; #if NETWORK_REPLICATOR_DEBUG_LOG uint8 InvalidTypeWarn = false; #endif bool operator==(const NetworkReplicatedObject& other) const { return Object == other.Object; } bool operator==(const ScriptingObject* other) const { return Object == other; } bool operator==(const Guid& other) const { return ObjectId == other; } String ToString() const { return ObjectId.ToString(); } }; inline uint32 GetHash(const NetworkReplicatedObject& key) { return GetHash(key.ObjectId); } struct Serializer { NetworkReplicator::SerializeFunc Methods[2]; void* Tags[2]; }; namespace { CriticalSection ObjectsLock; HashSet Objects; Array> SpawnQueue; Array DespawnQueue; Dictionary IdsRemappingTable; NetworkStream* CachedWriteStream = nullptr; NetworkStream* CachedReadStream = nullptr; Array NewClients; Array CachedTargets; Dictionary SerializersTable; } class NetworkReplicationService : public EngineService { public: NetworkReplicationService() : EngineService(TEXT("Network Replication"), 1100) { } void Dispose() override; }; void NetworkReplicationService::Dispose() { NetworkInternal::NetworkReplicatorClear(); } NetworkReplicationService NetworkReplicationServiceInstance; void INetworkSerializable_Serialize(void* instance, NetworkStream* stream, void* tag) { ((INetworkSerializable*)instance)->Serialize(stream); } void INetworkSerializable_Deserialize(void* instance, NetworkStream* stream, void* tag) { ((INetworkSerializable*)instance)->Deserialize(stream); } NetworkReplicatedObject* ResolveObject(Guid objectId) { auto it = Objects.Find(objectId); if (it != Objects.End()) return &it->Item; IdsRemappingTable.TryGet(objectId, objectId); it = Objects.Find(objectId); return it != Objects.End() ? &it->Item : nullptr; } NetworkReplicatedObject* ResolveObject(Guid objectId, Guid parentId, char objectTypeName[128]) { // Lookup object NetworkReplicatedObject* obj = ResolveObject(objectId); if (obj) return obj; // Try to find the object within the same parent (eg. spawned locally on both client and server) IdsRemappingTable.TryGet(parentId, parentId); const ScriptingTypeHandle objectType = Scripting::FindScriptingType(StringAnsiView(objectTypeName)); if (!objectType) return nullptr; for (auto& e : Objects) { auto& item = e.Item; const ScriptingObject* obj = item.Object.Get(); if (item.LastOwnerFrame == 0 && item.ParentId == parentId && obj && obj->GetTypeHandle() == objectType) { // Boost future lookups by using indirection NETWORK_REPLICATOR_LOG(Info, "[NetworkReplicator] Remap object ID={} into object {}:{}", objectId, item.ToString(), obj->GetType().ToString()); IdsRemappingTable.Add(objectId, item.ObjectId); return &item; } } return nullptr; } void SendObjectSpawnMessage(const NetworkReplicatedObject& item, ScriptingObject* obj) { NetworkMessageObjectSpawn msgData; msgData.ObjectId = item.ObjectId; msgData.ParentId = item.ParentId; const bool isClient = NetworkManager::IsClient(); if (isClient) { // Remap local client object ids into server ids IdsRemappingTable.KeyOf(msgData.ObjectId, &msgData.ObjectId); IdsRemappingTable.KeyOf(msgData.ParentId, &msgData.ParentId); } msgData.PrefabId = Guid::Empty; msgData.PrefabObjectID = Guid::Empty; auto* objScene = ScriptingObject::Cast(obj); if (objScene && objScene->HasPrefabLink()) { msgData.PrefabId = objScene->GetPrefabID(); msgData.PrefabObjectID = objScene->GetPrefabObjectID(); } msgData.OwnerClientId = item.OwnerClientId; const StringAnsiView& objectTypeName = obj->GetType().Fullname; Platform::MemoryCopy(msgData.ObjectTypeName, objectTypeName.Get(), objectTypeName.Length()); msgData.ObjectTypeName[objectTypeName.Length()] = 0; auto* peer = NetworkManager::Peer; NetworkMessage msg = peer->BeginSendMessage(); msg.WriteStructure(msgData); if (isClient) peer->EndSendMessage(NetworkChannelType::ReliableOrdered, msg); else peer->EndSendMessage(NetworkChannelType::ReliableOrdered, msg, CachedTargets); } void SendObjectRoleMessage(const NetworkReplicatedObject& item, const NetworkClient* excludedClient = nullptr) { NetworkMessageObjectRole msgData; msgData.ObjectId = item.ObjectId; msgData.OwnerClientId = item.OwnerClientId; auto peer = NetworkManager::Peer; NetworkMessage msg = peer->BeginSendMessage(); msg.WriteStructure(msgData); if (NetworkManager::IsClient()) { NetworkManager::Peer->EndSendMessage(NetworkChannelType::ReliableOrdered, msg); } else { CachedTargets.Clear(); for (const NetworkClient* client : NetworkManager::Clients) { if (client->State == NetworkConnectionState::Connected && client != excludedClient) CachedTargets.Add(client->Connection); } peer->EndSendMessage(NetworkChannelType::ReliableOrdered, msg, CachedTargets); } } FORCE_INLINE void DeleteNetworkObject(ScriptingObject* obj) { if (obj->Is