dev: improve netdebug, fix missing imgui PopStyleVar

blattersturm · blattersturm · commit 4ce17071cbba · 2019-06-01T08:49:57.000+02:00
diff --git a/code/components/debug-net/src/NetDebug.cpp b/code/components/debug-net/src/NetDebug.cpp
@@ -28,6 +28,64 @@ const int g_netOverlayHeight = 300;
 const int g_netOverlaySampleSize = 200; // milliseconds per sample frame
 const int g_netOverlaySampleCount = 150;
 
+class RageHashList
+{
+public:
+	template<int Size>
+	RageHashList(const char* (&list)[Size])
+	{
+		for (int i = 0; i < Size; i++)
+		{
+			m_lookupList.insert({ HashRageString(list[i]), list[i] });
+		}
+	}
+
+	inline std::string LookupHash(uint32_t hash)
+	{
+		auto it = m_lookupList.find(hash);
+
+		if (it != m_lookupList.end())
+		{
+			return std::string(it->second);
+		}
+
+		return fmt::sprintf("0x%08x", hash);
+	}
+
+private:
+	std::map<uint32_t, std::string_view> m_lookupList;
+};
+
+static const char* g_knownPackets[]
+{
+	"msgConVars",
+	"msgEnd",
+	"msgEntityCreate",
+	"msgNetGameEvent",
+	"msgObjectIds",
+	"msgPackedAcks",
+	"msgPackedClones",
+	"msgPaymentRequest",
+	"msgRequestObjectIds",
+	"msgResStart",
+	"msgResStop",
+	"msgRoute",
+	"msgRpcEntityCreation",
+	"msgRpcNative",
+	"msgServerCommand",
+	"msgServerEvent",
+	"msgTimeSync",
+	"msgTimeSyncReq",
+	"msgWorldGrid",
+	"msgFrame",
+	"msgIHost",
+	"gameStateAck",
+	"msgNetEvent",
+	"msgServerEvent",
+};
+
+static RageHashList g_hashes{ g_knownPackets };
+
 class NetOverlayMetricSink : public INetMetricSink
 {
 public:
@@ -45,9 +103,9 @@ class NetOverlayMetricSink : public INetMetricSink
 
 	virtual void OnRouteDelayResult(int msec) override;
 
-	virtual void OnIncomingCommand(uint32_t type, size_t size) override;
+	virtual void OnIncomingCommand(uint32_t type, size_t size, bool reliable) override;
 
-	virtual void OnOutgoingCommand(uint32_t type, size_t size) override;
+	virtual void OnOutgoingCommand(uint32_t type, size_t size, bool reliable) override;
 
 	virtual void OverrideBandwidthStats(uint32_t in, uint32_t out) override;
 
@@ -93,6 +151,10 @@ class NetOverlayMetricSink : public INetMetricSink
 
 	std::mutex m_metricMutex;
 
+	std::map<uint32_t, bool> m_incomingReliable;
+
+	std::map<uint32_t, bool> m_outgoingReliable;
+
 	std::map<uint32_t, size_t> m_incomingMetrics;
 
 	std::map<uint32_t, size_t> m_outgoingMetrics;
@@ -204,13 +266,16 @@ NetOverlayMetricSink::NetOverlayMetricSink()
 				static bool showIncoming = true;
 				static bool showOutgoing = true;
 
-				auto showList = [](const decltype(m_lastIncomingMetrics)& list)
+				auto showList = [](const decltype(m_lastIncomingMetrics)& list, const decltype(m_incomingReliable)& reliable)
 				{
-					ImGui::Columns(2);
+					ImGui::Columns(3);
 
 					for (auto& entry : list)
 					{
-						ImGui::Text("0x%08x", entry.first);
+						ImGui::Text("%s", (reliable.find(entry.first)->second ? "R" : "U"));
+						ImGui::NextColumn();
+
+						ImGui::Text("%s", g_hashes.LookupHash(entry.first));
 						ImGui::NextColumn();
 
 						ImGui::Text("%d B", entry.second);
@@ -222,12 +287,12 @@ NetOverlayMetricSink::NetOverlayMetricSink()
 
 				if (ImGui::CollapsingHeader("Incoming", &showIncoming))
 				{
-					showList(m_lastIncomingMetrics);
+					showList(m_lastIncomingMetrics, m_incomingReliable);
 				}
 
 				if (ImGui::CollapsingHeader("Outgoing", &showOutgoing))
 				{
-					showList(m_lastOutgoingMetrics);
+					showList(m_lastOutgoingMetrics, m_outgoingReliable);
 				}
 			}
 
@@ -293,16 +358,18 @@ void NetOverlayMetricSink::OnRouteDelayResult(int msec)
 	m_inRouteDelayMax = *std::max_element(m_inRouteDelaySamplesArchive, m_inRouteDelaySamplesArchive + _countof(m_inRouteDelaySamplesArchive));
 }
 
-void NetOverlayMetricSink::OnIncomingCommand(uint32_t type, size_t size)
+void NetOverlayMetricSink::OnIncomingCommand(uint32_t type, size_t size, bool reliable)
 {
 	std::unique_lock<std::mutex> lock(m_metricMutex);
 	m_incomingMetrics[type] += size;
+	m_incomingReliable[type] = reliable;
 }
 
-void NetOverlayMetricSink::OnOutgoingCommand(uint32_t type, size_t size)
+void NetOverlayMetricSink::OnOutgoingCommand(uint32_t type, size_t size, bool reliable)
 {
 	std::unique_lock<std::mutex> lock(m_metricMutex);
 	m_outgoingMetrics[type] += size;
+	m_outgoingReliable[type] = reliable;
 }
 
 // log data if enabled
@@ -407,14 +474,16 @@ void NetOverlayMetricSink::DrawGraph()
 	{
 		"Routed Messages",
 		"Reliables",
-		"Misc"
+		"Misc",
+		"Overhead"
 	};
 
 	static const ImColor colors[NET_PACKET_SUB_MAX] =
 	{
 		GetColorIndex(0),
 		GetColorIndex(1),
-		GetColorIndex(2)
+		GetColorIndex(2),
+		GetColorIndex(3)
 	};
 
 	struct DataContext
@@ -426,12 +495,14 @@ void NetOverlayMetricSink::DrawGraph()
 	auto data0 = DataContext{ m_metrics, NET_PACKET_SUB_ROUTED_MESSAGES };
 	auto data1 = DataContext{ m_metrics, NET_PACKET_SUB_RELIABLES };
 	auto data2 = DataContext{ m_metrics, NET_PACKET_SUB_MISC };
+	auto data3 = DataContext{ m_metrics, NET_PACKET_SUB_OVERHEAD };
 
 	const void* datas[NET_PACKET_SUB_MAX] =
 	{
 		&data0,
 		&data1,
-		&data2
+		&data2,
+		&data3
 	};
 
 	ImGui::PlotMultiLines("Net Bw", NET_PACKET_SUB_MAX, names, colors, [](const void* cxt, int idx) -> float
diff --git a/code/components/devtools-five/src/DrawFPS.cpp b/code/components/devtools-five/src/DrawFPS.cpp
@@ -67,6 +67,7 @@ static InitFunction initFunction([]()
 			}
 		}
 
+		ImGui::PopStyleVar();
 		ImGui::End();
 	});
 });
diff --git a/code/components/net/include/INetMetricSink.h b/code/components/net/include/INetMetricSink.h
@@ -28,9 +28,9 @@ class INetMetricSink : public fwRefCountable
 
 	virtual void OnRouteDelayResult(int msec) = 0;
 
-	virtual void OnIncomingCommand(uint32_t type, size_t size) = 0;
+	virtual void OnIncomingCommand(uint32_t type, size_t size, bool reliable = false) = 0;
 
-	virtual void OnOutgoingCommand(uint32_t type, size_t size) = 0;
+	virtual void OnOutgoingCommand(uint32_t type, size_t size, bool reliable = false) = 0;
 
 	virtual void OverrideBandwidthStats(uint32_t in, uint32_t out) = 0;
 };
@@ -40,6 +40,7 @@ enum NetPacketSubComponent
 	NET_PACKET_SUB_ROUTED_MESSAGES,
 	NET_PACKET_SUB_RELIABLES,
 	NET_PACKET_SUB_MISC,
+	NET_PACKET_SUB_OVERHEAD,
 	NET_PACKET_SUB_MAX
 };
 
diff --git a/code/components/net/src/NetLibraryImplV2.cpp b/code/components/net/src/NetLibraryImplV2.cpp
@@ -37,7 +37,7 @@ class NetLibraryImplV2 : public NetLibraryImplBase
 	virtual bool IsDisconnected() override;
 
 private:
-	void ProcessPacket(const uint8_t* data, size_t size);
+	void ProcessPacket(const uint8_t* data, size_t size, NetPacketMetrics& metrics, ENetPacketFlag flags);
 
 private:
 	std::string m_connectData;
@@ -122,7 +122,7 @@ void NetLibraryImplV2::SendReliableCommand(uint32_t type, const char* buffer, si
 		enet_peer_send(m_serverPeer, 0, packet);
 	}
 
-	m_base->GetMetricSink()->OnOutgoingCommand(type, length);
+	m_base->GetMetricSink()->OnOutgoingCommand(type, length, true);
 }
 
 void NetLibraryImplV2::SendData(const NetAddress& netAddress, const char* data, size_t length)
@@ -164,6 +164,7 @@ void NetLibraryImplV2::Flush()
 void NetLibraryImplV2::RunFrame()
 {
 	uint32_t inDataSize = 0;
+	NetPacketMetrics inMetrics;
 
 	ENetEvent event;
 
@@ -183,7 +184,7 @@ void NetLibraryImplV2::RunFrame()
 		}
 		case ENET_EVENT_TYPE_RECEIVE:
 		{
-			ProcessPacket(event.packet->data, event.packet->dataLength);
+			ProcessPacket(event.packet->data, event.packet->dataLength, inMetrics, (ENetPacketFlag)event.packet->flags);
 			inDataSize += event.packet->dataLength;
 
 			enet_packet_destroy(event.packet);
@@ -224,7 +225,7 @@ void NetLibraryImplV2::RunFrame()
 
 			enet_peer_send(m_serverPeer, 1, enet_packet_create(msg.GetBuffer(), msg.GetCurLength(), ENET_PACKET_FLAG_UNSEQUENCED));
 
-			m_base->GetMetricSink()->OnOutgoingCommand(0xE938445B, packet.payload.size() + 4);
+			m_base->GetMetricSink()->OnOutgoingCommand(0xE938445B, packet.payload.size() + 4, false);
 			m_base->GetMetricSink()->OnOutgoingRoutePackets(1);
 		}
 
@@ -244,18 +245,18 @@ void NetLibraryImplV2::RunFrame()
 		// update received metrics
 		if (m_host->totalReceivedData != 0)
 		{
-			for (uint32_t i = 0; i < m_host->totalReceivedPackets; ++i)
-			{
-				NetPacketMetrics m;
-				m.AddElementSize(NET_PACKET_SUB_MISC, inDataSize);
+			// actually: overhead
+			inMetrics.AddElementSize(NET_PACKET_SUB_OVERHEAD, m_host->totalReceivedData - inDataSize);
 
-				// actually: overhead
-				m.AddElementSize(NET_PACKET_SUB_RELIABLES, m_host->totalReceivedData - inDataSize);
+			m_base->GetMetricSink()->OnIncomingPacket(inMetrics);
 
-				m_base->GetMetricSink()->OnIncomingPacket(m);
+			m_host->totalReceivedData = 0;
+			inDataSize = 0;
 
-				m_host->totalReceivedData = 0;
-				inDataSize = 0;
+			for (uint32_t i = 1; i < m_host->totalReceivedPackets; ++i)
+			{
+				NetPacketMetrics m;
+				m_base->GetMetricSink()->OnIncomingPacket(m);
 			}
 
 			m_base->AddReceiveTick();
@@ -297,7 +298,7 @@ void NetLibraryImplV2::SendConnect(const std::string& connectData)
 #endif
 }
 
-void NetLibraryImplV2::ProcessPacket(const uint8_t* data, size_t size)
+void NetLibraryImplV2::ProcessPacket(const uint8_t* data, size_t size, NetPacketMetrics& metrics, ENetPacketFlag flags)
 {
 	NetBuffer msg((char*)data, size);
 	uint32_t msgType = msg.Read<uint32_t>();
@@ -358,9 +359,9 @@ void NetLibraryImplV2::ProcessPacket(const uint8_t* data, size_t size)
 		return;
 	}
 
-	m_base->GetMetricSink()->OnIncomingCommand(msgType, size);
+	m_base->GetMetricSink()->OnIncomingCommand(msgType, size, (flags & ENET_PACKET_FLAG_RELIABLE) != 0);
 
-	if (msgType == 0xE938445B) // 'msgRoute'
+	if (msgType == HashRageString("msgRoute")) // 'msgRoute'
 	{
 		uint16_t netID = msg.Read<uint16_t>();
 		uint16_t rlength = msg.Read<uint16_t>();
@@ -377,9 +378,26 @@ void NetLibraryImplV2::ProcessPacket(const uint8_t* data, size_t size)
 
 		// add to metrics
 		m_base->GetMetricSink()->OnIncomingRoutePackets(1);
+
+		// add as routed message
+		metrics.AddElementSize(NET_PACKET_SUB_ROUTED_MESSAGES, size);
 	}
-	else if (msgType != 0xCA569E63) // reliable command
+	else if (msgType != HashRageString("msgEnd")) // reliable command
 	{
+		auto subType = NET_PACKET_SUB_MISC;
+
+		// cloning data is considered routing
+		if (msgType == HashRageString("msgPackedAcks") || msgType == HashRageString("msgPackedClones"))
+		{
+			subType = NET_PACKET_SUB_ROUTED_MESSAGES;
+		}
+		else if (flags & ENET_PACKET_FLAG_RELIABLE)
+		{
+			subType = NET_PACKET_SUB_RELIABLES;
+		}
+
+		metrics.AddElementSize(subType, size);
+
 		size_t reliableSize = size - 4;
 
 		std::vector<char> reliableBuf(reliableSize);

Original file line number	Diff line number	Diff line change
`@@ -67,6 +67,7 @@ static InitFunction initFunction([]()`
`67`	`67`	`}`
`68`	`68`	`}`
`69`	`69`
	`70`	`+ ImGui::PopStyleVar();`
`70`	`71`	`ImGui::End();`
`71`	`72`	`});`
`72`	`73`	`});`