Change CScriptNetPropManager cache to enable reading more values

Author: samisalreadytaken

sp/src/game/shared/mapbase/vscript_singletons.cpp

@@ -128,27 +128,22 @@ class CScriptNetPropManager
 	typedef SendTable NetTable;
 	typedef ServerClass NetworkClass;
 
-	NetworkClass *GetNetworkClass( CBaseEntity* p ) { return p->GetServerClass(); }
-	NetTable *GetNetTable( NetworkClass* p ) { return p->m_pTable; }
+	static NetworkClass *GetNetworkClass( CBaseEntity *p ) { return p->GetServerClass(); }
+	static NetTable *GetNetTable( NetworkClass *p ) { return p->m_pTable; }
 
-	void NetworkStateChanged( CBaseEntity* p, int o ) { p->NetworkProp()->NetworkStateChanged( o ); }
+	static void NetworkStateChanged( CBaseEntity *p, int o ) { p->NetworkProp()->NetworkStateChanged( o ); }
 #else
 	typedef RecvProp NetProp;
 	typedef RecvTable NetTable;
 	typedef ClientClass NetworkClass;
 
-	NetworkClass *GetNetworkClass( CBaseEntity* p ) { return p->GetClientClass(); }
-	NetTable *GetNetTable( NetworkClass* p ) { return p->m_pRecvTable; }
+	static NetworkClass *GetNetworkClass( CBaseEntity *p ) { return p->GetClientClass(); }
+	static NetTable *GetNetTable( NetworkClass *p ) { return p->m_pRecvTable; }
 
-	void NetworkStateChanged( CBaseEntity*, int ) {}
+	static void NetworkStateChanged( CBaseEntity*, int ) {}
 #endif
 
-	int GetClassID( CBaseEntity *p )
-	{
-		return GetNetworkClass( p )->m_ClassID;
-	}
-
-	int GetIntPropSize( NetProp *pProp )
+	static int GetIntPropSize( NetProp *pProp )
 	{
 		Assert( pProp->GetType() == DPT_Int );
 
@@ -181,12 +176,12 @@ class CScriptNetPropManager
 #endif
 	}
 
-	bool IsEHandle( NetProp *pProp )
+	static bool IsEHandle( NetProp *pProp )
 	{
 		return ( pProp->GetProxyFn() == DataTableProxy_EHandle );
 	}
 
-	bool IsUtlVector( NetProp *pProp )
+	static bool IsUtlVector( NetProp *pProp )
 	{
 #ifdef GAME_DLL
 		SendVarProxyFn proxy = pProp->GetProxyFn();
@@ -257,10 +252,9 @@ class CScriptNetPropManager
 		// element size in bytes
 		unsigned int elemsize : VARINFO_ELEMSIZE_BITS;
 
-		// Following are only used in integer netprops to handle unsigned and size casting
+		// Only used in integer netprops to handle unsigned and size casting
 		unsigned int isUnsigned : 1;
 		unsigned int isNotNetworked : 1;
-
 		unsigned int isGameRules : 1;
 
 		int GetOffset( int index )
@@ -269,35 +263,87 @@ class CScriptNetPropManager
 		}
 	};
 
+	struct varsource_t
+	{
+		void *source;
+		varinfo_t info;
+	};
+
+	struct vardictelem_t
+	{
+		CCopyableUtlVector< varsource_t > sources;
+	};
+
 	// Wrapper to be able to set case sensitive comparator in node insertion
-	class vardict_t : public CUtlDict< varinfo_t >
+	class vardict_t : public CUtlDict< vardictelem_t >
 	{
 	public:
-		vardict_t() : CUtlDict< varinfo_t >( k_eDictCompareTypeCaseSensitive ) {}
+		vardict_t() : CUtlDict< vardictelem_t >( k_eDictCompareTypeCaseSensitive ) {}
 	};
 
-	// NOTE: This is lazy and inefficient.
-	// Simply map highest level class id to unique caches.
-	CUtlVector< int > m_EntMap;
-	CUtlVector< vardict_t > m_VarDicts;
+	// Different entities can have unique network tables while sharing data maps,
+	// or unique data maps while sharing network tables (e.g. server only entities).
+	// The cache needs to be able to differentiate the source of the variable info
+	// while being quick to access.
+	//
+	// While storing the origin table (e.g. DT_BaseEntity for DT_HL2_Player->m_vecOrigin)
+	// keeps the cache size small, it would have runtime impact from
+	// checking base tables and pointer chasing.
+	// Instead, store the highest level table identifiers even if they are identical to
+	// existing variables. (e.g.
+	// storing DT_HL2_Player and DT_PhysicsProp for the variable DT_BaseEntity->m_vecOrigin)
+	//
+	// Fetching varinfo from cache now does one sorted string lookup (RB tree)
+	// and 2 pointer comparisons for each class type that was fetched for that variable name
+	// (practically a very low number because NetProps is used more often for unique variables than not).
+	//
+	// This is a quick, not well thought out solution
+	vardict_t m_VarDicts;
 
-	varinfo_t *CacheNew( CBaseEntity *pEnt, const char *szProp, bool bNetworked )
+	static varsource_t *CacheFind( CBaseEntity *pEnt, vardictelem_t *pElem )
 	{
-		int idx = m_EntMap.Find( GetClassID( pEnt ) );
-		if ( idx == m_EntMap.InvalidIndex() )
+		NetTable *pNetTable = GetNetTable( GetNetworkClass( pEnt ) );
+		datamap_t *pDataMap = pEnt->GetDataDescMap();
+#ifdef CLIENT_DLL
+		datamap_t *pPredMap = pEnt->GetPredDescMap();
+#endif
+
+		FOR_EACH_VEC( pElem->sources, i )
 		{
-			// Vector indices are kept in parallel as a workaround for encapsulating maps
-			idx = m_EntMap.AddToTail( GetClassID( pEnt ) );
-			m_VarDicts.AddToTail();
+			varsource_t *pSrc = &pElem->sources.Element( i );
+
+			if ( pSrc->source == pNetTable )
+				return pSrc;
+
+			if ( pSrc->source == pDataMap )
+				return pSrc;
+#ifdef CLIENT_DLL
+			if ( pSrc->source == pPredMap )
+				return pSrc;
+#endif
 		}
 
-		vardict_t &dict = m_VarDicts.Element( idx );
+		return NULL;
+	}
 
-		idx = dict.Find( szProp );
-		if ( idx == dict.InvalidIndex() )
-			idx = dict.Insert( szProp );
+	varinfo_t *CacheNew( CBaseEntity *pEnt, const char *szProp, void *pSource, bool bNetworked )
+	{
+		int idx = m_VarDicts.Find( szProp );
+		if ( idx == m_VarDicts.InvalidIndex() )
+			idx = m_VarDicts.Insert( szProp );
+
+		vardictelem_t *pElem = &m_VarDicts.Element( idx );
+		varsource_t *pSrc = CacheFind( pEnt, pElem );
 
-		varinfo_t *pInfo = &dict.Element( idx );
+		if ( !pSrc )
+		{
+			idx = pElem->sources.AddToTail();
+			pSrc = &pElem->sources.Element( idx );
+		}
+
+		pSrc->source = pSource;
+
+		varinfo_t *pInfo = &pSrc->info;
 		V_memset( pInfo, 0, sizeof( varinfo_t ) );
 
 		pInfo->isNotNetworked = !bNetworked;
@@ -311,17 +357,17 @@ class CScriptNetPropManager
 
 	varinfo_t* CacheFetch( CBaseEntity *pEnt, const char *szProp )
 	{
-		int idx = m_EntMap.Find( GetClassID( pEnt ) );
-		if ( idx == m_EntMap.InvalidIndex() )
-			return NULL;
+		int idx = m_VarDicts.Find( szProp );
+		if ( idx != m_VarDicts.InvalidIndex() )
+		{
+			vardictelem_t *pElem = &m_VarDicts.Element( idx );
+			varsource_t *pSrc = CacheFind( pEnt, pElem );
 
-		vardict_t &dict = m_VarDicts.Element( idx );
-		idx = dict.Find( szProp );
-		if ( idx == dict.InvalidIndex() )
-			return NULL;
+			if ( pSrc )
+				return &pSrc->info;
+		}
 
-		varinfo_t *pInfo = &dict.Element( idx );
-		return pInfo;
+		return NULL;
 	}
 
 public:
@@ -332,7 +378,6 @@ class CScriptNetPropManager
 
 	void PurgeCache()
 	{
-		m_EntMap.Purge();
 		m_VarDicts.Purge();
 	}
 
@@ -497,7 +542,7 @@ class CScriptNetPropManager
 		{
 
 #define SetVarInfo()\
-				varinfo_t *pInfo = CacheNew( pEnt, szProp, true );\
+				varinfo_t *pInfo = CacheNew( pEnt, szProp, (void*)pTable, true );\
 				Assert( pProp->GetElementStride() <= VARINFO_ELEMSIZE_MAX );\
 				pInfo->elemsize = pProp->GetElementStride();\
 				Assert( pProp->GetNumElements() > 0 && pProp->GetNumElements() <= VARINFO_ARRAYSIZE_MAX );\
@@ -644,7 +689,7 @@ class CScriptNetPropManager
 				{
 					if ( IsEHandle( pProp ) )
 					{
-						varinfo_t *pInfo = CacheNew( pEnt, szProp, true );
+						varinfo_t *pInfo = CacheNew( pEnt, szProp, (void*)pTable, true );
 						pInfo->elemsize = sizeof(int);
 						Assert( pArray->GetNumProps() > 0 && pArray->GetNumProps() <= VARINFO_ARRAYSIZE_MAX );
 						pInfo->arraysize = pArray->GetNumProps();
@@ -661,7 +706,7 @@ class CScriptNetPropManager
 						if ( size == 0 )
 							break;
 #endif
-						varinfo_t *pInfo = CacheNew( pEnt, szProp, true );
+						varinfo_t *pInfo = CacheNew( pEnt, szProp, (void*)pTable, true );
 
 						if ( pArray->GetNumProps() > 1 )
 						{
@@ -683,7 +728,7 @@ class CScriptNetPropManager
 				}
 				case DPT_Float:
 				{
-					varinfo_t *pInfo = CacheNew( pEnt, szProp, true );
+					varinfo_t *pInfo = CacheNew( pEnt, szProp, (void*)pTable, true );
 					pInfo->elemsize = sizeof(float);
 					Assert( pArray->GetNumProps() > 0 && pArray->GetNumProps() <= VARINFO_ARRAYSIZE_MAX );
 					pInfo->arraysize = pArray->GetNumProps();
@@ -693,7 +738,7 @@ class CScriptNetPropManager
 				}
 				case DPT_Vector:
 				{
-					varinfo_t *pInfo = CacheNew( pEnt, szProp, true );
+					varinfo_t *pInfo = CacheNew( pEnt, szProp, (void*)pTable, true );
 					pInfo->elemsize = sizeof(float)*3;
 					Assert( pArray->GetNumProps() > 0 && pArray->GetNumProps() <= VARINFO_ARRAYSIZE_MAX );
 					pInfo->arraysize = pArray->GetNumProps();
@@ -703,7 +748,7 @@ class CScriptNetPropManager
 				}
 				case DPT_VectorXY:
 				{
-					varinfo_t *pInfo = CacheNew( pEnt, szProp, true );
+					varinfo_t *pInfo = CacheNew( pEnt, szProp, (void*)pTable, true );
 					pInfo->elemsize = sizeof(float)*2;
 					Assert( pArray->GetNumProps() > 0 && pArray->GetNumProps() <= VARINFO_ARRAYSIZE_MAX );
 					pInfo->arraysize = pArray->GetNumProps();
@@ -829,7 +874,7 @@ class CScriptNetPropManager
 			}
 
 #define SetVarInfo()\
-				varinfo_t *pInfo = CacheNew( pEnt, szProp, false );\
+				varinfo_t *pInfo = CacheNew( pEnt, szProp, (void*)map, false );\
 				Assert( pField->fieldSizeInBytes / pField->fieldSize <= VARINFO_ELEMSIZE_MAX );\
 				pInfo->elemsize = pField->fieldSizeInBytes / pField->fieldSize;\
 				Assert( pField->fieldSize > 0 && pField->fieldSize <= VARINFO_ARRAYSIZE_MAX );\
@@ -973,7 +1018,7 @@ class CScriptNetPropManager
 							return NULL;
 					}
 
-					varinfo_t *pInfo = CacheNew( pEnt, szProp, false );
+					varinfo_t *pInfo = CacheNew( pEnt, szProp, (void*)map, false );
 					pInfo->arraysize = 1;
 					pInfo->offset = offset;
 					pInfo->datatype = datatype;