Fixed memory leak when changing player model

ccw808 · ccw808 · commit e747d5780099 · 2015-05-31T14:39:01.000+01:00
Conflicts:
	MTA10/mods/deathmatch/logic/CClientGame.cpp
	MTA10/mods/deathmatch/logic/CClientGame.h
diff --git a/MTA10/core/CModelCacheManager.cpp b/MTA10/core/CModelCacheManager.cpp
@@ -39,6 +39,7 @@ class CModelCacheManagerImpl : public CModelCacheManager
     // CModelCacheManager interface
     virtual void                DoPulse                             ( void );
     virtual void                GetStats                            ( SModelCacheStats& outStats );
+    virtual bool                UnloadModel                         ( ushort usModelId );
     virtual void                OnRestreamModel                     ( ushort usModelId );
     virtual void                OnClientClose                       ( void );
     virtual void                UpdatePedModelCaching               ( const std::map < ushort, float >& newNeedCacheList );
@@ -479,6 +480,32 @@ void CModelCacheManagerImpl::SubModelRefCount ( ushort usModelId )
 }
 
 
+///////////////////////////////////////////////////////////////
+//
+// CModelCacheManagerImpl::UnloadModel
+//
+// Remove model and associated txd from memory
+//
+///////////////////////////////////////////////////////////////
+bool CModelCacheManagerImpl::UnloadModel ( ushort usModelId )
+{
+    // Stream out usages in the client module
+    CClientBase* pClientBase = CModManager::GetSingleton().GetCurrentMod();
+    if ( pClientBase )
+        pClientBase->RestreamModel( usModelId );
+
+    // Uncache usages here
+    OnRestreamModel( usModelId );
+
+    // Ensure model and txd are removed
+    CModelInfo* pModelInfo = m_pGame->GetModelInfo( usModelId );
+    if ( pModelInfo )
+        return pModelInfo->ForceUnload();
+
+    return false;
+}
+
+
 ///////////////////////////////////////////////////////////////
 //
 // CModelCacheManagerImpl::OnRestreamModel
diff --git a/MTA10/core/CModelCacheManager.h b/MTA10/core/CModelCacheManager.h
@@ -18,6 +18,7 @@ class CModelCacheManager
     // CModelCacheManager interface
     virtual void                DoPulse                             ( void ) = 0;
     virtual void                GetStats                            ( SModelCacheStats& outStats ) = 0;
+    virtual bool                UnloadModel                         ( ushort usModelId ) = 0;
     virtual void                OnRestreamModel                     ( ushort usModelId ) = 0;
     virtual void                OnClientClose                       ( void ) = 0;
     virtual void                UpdatePedModelCaching               ( const std::map < ushort, float >& newNeedCacheList ) = 0;
diff --git a/MTA10/game_sa/CModelInfoSA.cpp b/MTA10/game_sa/CModelInfoSA.cpp
@@ -758,8 +758,6 @@ int CModelInfoSA::GetRefCount ()
 
 void CModelInfoSA::RemoveRef ( bool bRemoveExtraGTARef )
 {
-    assert ( m_dwReferences > 0 );
-
     // Decrement the references
     if ( m_dwReferences > 0 )
         m_dwReferences--;
@@ -1383,4 +1381,50 @@ void CModelInfoSA::ResetSupportedUpgrades ( void )
 eModelInfoType CModelInfoSA::GetModelType(void)
 {
     return ((eModelInfoType(*)(void))m_pInterface->VFTBL->GetModelType)();
-}
+}
+
+//////////////////////////////////////////////////////////////////////////////////////////
+//
+// CModelInfoSA::ForceUnload
+//
+// 1. Unload the dff from memory
+// 2. Unload the associated txd from memory
+// 3. Cross fingers
+//
+// Why do we do this?
+// Player model adds (seemingly) unnecessary refs
+// (Will crash if anything is actually using the model or txd)
+//
+// Won't work if there is a custom model replacement
+//
+// Returns true if model was unloaded
+//
+//////////////////////////////////////////////////////////////////////////////////////////
+bool CModelInfoSA::ForceUnload( void )
+{
+    CBaseModelInfoSAInterface* pModelInfoSAInterface = GetInterface();
+
+    // Need to have at least one ref to delete pRwObject
+    if ( pModelInfoSAInterface->usNumberOfRefs == 0 && pModelInfoSAInterface->pRwObject != NULL  )
+    {
+        pModelInfoSAInterface->usNumberOfRefs++;
+    }
+
+    // Keep removing refs from the model until is it gone
+    uint uiLimit = 100;
+    while( pModelInfoSAInterface->usNumberOfRefs > 0 && uiLimit-- )
+    {
+        RemoveRef();
+    }
+
+    // Did it work?
+    if ( pModelInfoSAInterface->usNumberOfRefs > 0 || pModelInfoSAInterface->pRwObject != NULL )
+        return false;
+
+    // If success, then remove txd
+    ushort usTxdId = GetTextureDictionaryID();
+    if ( usTxdId )
+        pGame->GetRenderWare()->TxdForceUnload( usTxdId, true );
+
+    return true;
+}
diff --git a/MTA10/game_sa/CModelInfoSA.h b/MTA10/game_sa/CModelInfoSA.h
@@ -322,6 +322,7 @@ class CModelInfoSA : public CModelInfo
     void                            ModelAddRef             ( EModelRequestType requestType, const char* szTag );
     int                             GetRefCount             ( void );
     void                            RemoveRef               ( bool bRemoveExtraGTARef = false );
+    bool                            ForceUnload             ( void );
 
     // CVehicleModelInfo specific
     short                           GetAvailableVehicleMod  ( unsigned short usSlot );
diff --git a/MTA10/game_sa/CRenderWareSA.cpp b/MTA10/game_sa/CRenderWareSA.cpp
@@ -636,6 +636,54 @@ bool CRenderWareSA::RwTexDictionaryContainsTexture ( RwTexDictionary* pTXD, RwTe
 }
 
 
+////////////////////////////////////////////////////////////////
+//
+// CRenderWareSA::TxdForceUnload
+//
+// 1. Unload txd from memory
+// 2. Cross fingers
+//
+// Why do we do this?
+// Player model adds (seemingly) unnecessary refs
+// (Will crash if anything is actually using the txd)
+//
+// No idea what will happen if there is a custom txd replacement
+//
+////////////////////////////////////////////////////////////////
+void CRenderWareSA::TxdForceUnload( ushort usTxdId, bool bDestroyTextures )
+{
+    RwTexDictionary* pTxd = CTxdStore_GetTxd( usTxdId );
+    if ( !pTxd )
+        return;
+
+    // We can abandon the textures instead of destroy. It might be safer, but will cause a memory leak
+    if ( bDestroyTextures )
+    {
+        // Unref the textures
+        std::vector < RwTexture* > textureList;
+        pGame->GetRenderWareSA()->GetTxdTextures( textureList, pTxd );
+        for ( std::vector < RwTexture* > ::iterator iter = textureList.begin() ; iter != textureList.end() ; iter++ )
+        {
+            RwTexture* pTexture = *iter;
+            while( pTexture->refs > 1 )
+                RwTextureDestroy( pTexture );
+            RwTextureDestroy( pTexture );
+        }
+    }
+
+    // Need to have at least one ref for RemoveRef to work correctly
+    if ( CTxdStore_GetNumRefs( usTxdId ) == 0 )
+    {
+        CTxdStore_AddRef( usTxdId );
+    }
+
+    while( CTxdStore_GetNumRefs( usTxdId ) > 0 )
+    {
+        CTxdStore_RemoveRef( usTxdId );
+    }
+}
+
+
 ////////////////////////////////////////////////////////////////
 //
 // CRenderWareSA::GetTXDIDForModelID
diff --git a/MTA10/game_sa/CRenderWareSA.h b/MTA10/game_sa/CRenderWareSA.h
@@ -106,6 +106,7 @@ class CRenderWareSA : public CRenderWare
     void                RemoveClientEntityRefs      ( CClientEntityBase* pClientEntity );
     void                RemoveShaderRefs            ( CSHADERDUMMY* pShaderItem );
     bool                RightSizeTxd                ( const SString& strInTxdFilename, const SString& strOutTxdFilename, uint uiSizeLimit );
+    void                TxdForceUnload              ( ushort usTxdId, bool bDestroyTextures );
 
     // CRenderWareSA methods
     RwTexture*          RightSizeTexture            ( RwTexture* pTexture, uint uiSizeLimit );
diff --git a/MTA10/game_sa/gamesa_renderware.h b/MTA10/game_sa/gamesa_renderware.h
@@ -196,6 +196,7 @@ typedef bool                (__cdecl *CTxdStore_LoadTxd_t)              (unsigne
 typedef void                (__cdecl *CTxdStore_RemoveTxd_t)            (unsigned int id);
 typedef void                (__cdecl *CTxdStore_RemoveRef_t)            (unsigned int id);
 typedef void                (__cdecl *CTxdStore_AddRef_t)               (unsigned int id);
+typedef int                 (__cdecl *CTxdStore_GetNumRefs_t)           (unsigned int id);
 typedef RwTexDictionary*    (__cdecl *CTxdStore_GetTxd_t)               (unsigned int id);
 typedef RwTexture*          (__cdecl *CClothesBuilder_CopyTexture_t)    (RwTexture *texture);
 
@@ -210,6 +211,7 @@ RWFUNC ( CTxdStore_GetTxd_t              CTxdStore_GetTxd                , (CTxd
 RWFUNC ( CTxdStore_RemoveTxd_t           CTxdStore_RemoveTxd             , (CTxdStore_RemoveTxd_t)           0xDEAD )
 RWFUNC ( CTxdStore_RemoveRef_t           CTxdStore_RemoveRef             , (CTxdStore_RemoveRef_t)           0xDEAD )
 RWFUNC ( CTxdStore_AddRef_t              CTxdStore_AddRef                , (CTxdStore_AddRef_t)              0xDEAD )
+RWFUNC ( CTxdStore_GetNumRefs_t          CTxdStore_GetNumRefs            , (CTxdStore_GetNumRefs_t)          0xDEAD )
 RWFUNC ( CClothesBuilder_CopyTexture_t   CClothesBuilder_CopyTexture     , (CClothesBuilder_CopyTexture_t)   0xDEAD )
 
 /*****************************************************************************/
diff --git a/MTA10/game_sa/gamesa_renderware.hpp b/MTA10/game_sa/gamesa_renderware.hpp
@@ -98,6 +98,7 @@ void InitRwFunctions( eGameVersion version )
             CTxdStore_RemoveTxd                 = (CTxdStore_RemoveTxd_t)                   0x00731E90;
             CTxdStore_RemoveRef                 = (CTxdStore_RemoveRef_t)                   0x00731A30;
             CTxdStore_AddRef                    = (CTxdStore_AddRef_t)                      0x00731A00; 
+            CTxdStore_GetNumRefs                = (CTxdStore_GetNumRefs_t)                  0x00731AA0; 
             CClothesBuilder_CopyTexture         = (CClothesBuilder_CopyTexture_t)           0x005A5730;
 
             break;
@@ -187,6 +188,7 @@ void InitRwFunctions( eGameVersion version )
             CTxdStore_RemoveTxd                 = (CTxdStore_RemoveTxd_t)                   0x00731E90;
             CTxdStore_RemoveRef                 = (CTxdStore_RemoveRef_t)                   0x00731A30;
             CTxdStore_AddRef                    = (CTxdStore_AddRef_t)                      0x00731A00;
+            CTxdStore_GetNumRefs                = (CTxdStore_GetNumRefs_t)                  0x00731AA0;
             CClothesBuilder_CopyTexture         = (CClothesBuilder_CopyTexture_t)           0x005A5730;
 
             break;
diff --git a/MTA10/mods/deathmatch/CClient.cpp b/MTA10/mods/deathmatch/CClient.cpp
@@ -268,6 +268,15 @@ bool CClient::ProcessCommand ( const char* szCommandLine )
 }
 
 
+void CClient::RestreamModel ( unsigned short usModel )
+{
+    if ( g_pClientGame )
+    {
+        g_pClientGame->RestreamModel( usModel );
+    }
+}
+
+
 bool CClient::HandleException ( CExceptionInformation* pExceptionInformation )
 {
     #ifndef MTA_DEBUG
diff --git a/MTA10/mods/deathmatch/CClient.h b/MTA10/mods/deathmatch/CClient.h
@@ -30,6 +30,7 @@ class CClient : public CClientBase
     void        PreHUDRenderExecutionHandler    ( bool bDidUnminimize, bool bDidRecreateRenderTargets );
     void        PostFrameExecutionHandler       ( void );
     void        IdleHandler                     ( void );
+    void        RestreamModel                   ( unsigned short usModel );
 
     bool        ProcessCommand                  ( const char* szCommandLine );
     //bool        ProcessInput                    ( CInputMessage* pInputMessage );
diff --git a/MTA10/mods/deathmatch/logic/CClientGame.cpp b/MTA10/mods/deathmatch/logic/CClientGame.cpp
@@ -6570,3 +6570,47 @@ void CClientGame::SetFileCacheRoot ( void )
             AddReportLog( 7413, SString( "CClientGame::SetFileCacheRoot - Change shared from '%s' to '%s'", *strFileCachePath, *m_strFileCacheRoot ) );
     }
 }
+
+void CClientGame::RestreamModel ( unsigned short usModel )
+{
+    // Is this a vehicle ID?
+    if ( CClientVehicleManager::IsValidModel ( usModel ) )
+    {
+        // Stream the vehicles of that model out so we have no
+        // loaded when we do the restore. The streamer will
+        // eventually stream them back in with async loading.
+        m_pManager->GetVehicleManager ()->RestreamVehicles ( usModel );
+    }
+
+    // Is this an object ID?
+    else if ( CClientObjectManager::IsValidModel ( usModel ) )
+    {
+        if ( CClientPedManager::IsValidWeaponModel ( usModel ) )
+        {
+            // Stream the weapon of that model out so we have no
+            // loaded when we do the restore. The streamer will
+            // eventually stream them back in with async loading.
+            m_pManager->GetPedManager ()->RestreamWeapon ( usModel );
+            m_pManager->GetPickupManager ()->RestreamPickups ( usModel );
+        }
+        // Stream the objects of that model out so we have no
+        // loaded when we do the restore. The streamer will
+        // eventually stream them back in with async loading.
+        m_pManager->GetObjectManager ()->RestreamObjects ( usModel );
+        g_pGame->GetModelInfo ( usModel )->RestreamIPL ();
+    }
+    // Is this an ped ID?
+    else if ( CClientPlayerManager::IsValidModel ( usModel ) )
+    {
+        // Stream the ped of that model out so we have no
+        // loaded when we do the restore. The streamer will
+        // eventually stream them back in with async loading.
+        m_pManager->GetPedManager ()->RestreamPeds ( usModel );
+    }
+    else
+
+    // 'Restream' upgrades after model replacement to propagate visual changes with immediate effect
+    if ( CClientObjectManager::IsValidModel ( usModel ) && CVehicleUpgrades::IsUpgrade ( usModel ) )
+        m_pManager->GetVehicleManager ()->RestreamVehicleUpgrades ( usModel );
+
+}
diff --git a/MTA10/mods/deathmatch/logic/CClientGame.h b/MTA10/mods/deathmatch/logic/CClientGame.h
@@ -433,6 +433,8 @@ class CClientGame
     void                                ChangeFloatPrecision            ( bool bHigh );
     bool                                IsHighFloatPrecision            ( void ) const;
 
+    void                                RestreamModel                   ( unsigned short usModel );
+
 private:
 
     // CGUI Callbacks
diff --git a/MTA10/sdk/core/CClientBase.h b/MTA10/sdk/core/CClientBase.h
@@ -25,6 +25,7 @@ class CClientBase
     virtual void    PreHUDRenderExecutionHandler ( bool bDidUnminimize, bool bDidRecreateRenderTargets ) = 0;
     virtual void    PostFrameExecutionHandler   ( void ) = 0;
     virtual void    IdleHandler                 ( void ) = 0;
+    virtual void    RestreamModel               ( unsigned short usModel ) = 0;
 
     virtual bool    ProcessCommand              ( const char* szCommandLine ) = 0;
     //virtual bool    ProcessInput                ( CInputMessage* pInputMessage ) = 0  *TODO*
diff --git a/MTA10/sdk/game/CModelInfo.h b/MTA10/sdk/game/CModelInfo.h
@@ -135,6 +135,7 @@ class CModelInfo
     virtual void            ModelAddRef             ( EModelRequestType requestType, const char* szTag/* = NULL*/ ) = 0;
     virtual void            RemoveRef               ( bool bRemoveExtraGTARef = false ) = 0;
     virtual int             GetRefCount             () = 0;
+    virtual bool            ForceUnload             ( void ) = 0;
 
     virtual float           GetDistanceFromCentreOfMassToBaseOfModel () = 0;
 
diff --git a/MTA10/sdk/game/CRenderWare.h b/MTA10/sdk/game/CRenderWare.h
@@ -97,6 +97,7 @@ class CRenderWare {
     virtual void                RemoveShaderRefs            ( CSHADERDUMMY* pShaderItem ) = 0;
     virtual RwFrame *           GetFrameFromName            ( RpClump * pRoot, SString strName ) = 0;
     virtual bool                RightSizeTxd                ( const SString& strInTxdFilename, const SString& strOutTxdFilename, uint uiSizeLimit ) = 0;
+    virtual void                TxdForceUnload              ( ushort usTxdId, bool bDestroyTextures ) = 0;
 };
 
 

Original file line number	Diff line number	Diff line change
`@@ -268,6 +268,15 @@ bool CClient::ProcessCommand ( const char* szCommandLine )`
`268`	`268`	`}`
`269`	`269`
`270`	`270`
	`271`	`+void CClient::RestreamModel ( unsigned short usModel )`
	`272`	`+{`
	`273`	`+ if ( g_pClientGame )`
	`274`	`+ {`
	`275`	`+ g_pClientGame->RestreamModel( usModel );`
	`276`	`+ }`
	`277`	`+}`
	`278`	`+`
	`279`	`+`
`271`	`280`	`bool CClient::HandleException ( CExceptionInformation* pExceptionInformation )`
`272`	`281`	`{`
`273`	`282`	`#ifndef MTA_DEBUG`