Added option to collect Lua garbage until timeout expires (#1047)

The new console commands are lua_gc_method and lua_gc_timeout.
Also, added LuaJIT memory and time consumption display in rs_stats

Author: eagleivg

Externals/LuaJIT

@@ -567,10 +567,8 @@ void CLevel::OnFrame()
         }
         else
             m_level_sound_manager->Update();
-    }
-    // defer LUA-GC-STEP
-    if (!GEnv.isDedicatedServer)
-    {
+
+        // defer LUA-GC-STEP
         if (g_mt_config.test(mtLUA_GC))
         {
             Device.seqParallel.push_back(fastdelegate::FastDelegate0<>(this, &CLevel::script_gc));
@@ -588,11 +586,35 @@ void CLevel::OnFrame()
 }
 
 int psLUA_GCSTEP = 100; // 10
+int psLUA_GCTIMEOUT = 1000;
+
+u32 ps_lua_gc_method = 1;
 
 void CLevel::script_gc()
 {
     ZoneScoped;
-    lua_gc(GEnv.ScriptEngine->lua(), LUA_GCSTEP, psLUA_GCSTEP);
+    AIStats.LuaGC.Begin();
+
+    switch (ps_lua_gc_method)
+    {
+    case 0:
+        break;
+
+    case 2:
+        if (lua_gc(GEnv.ScriptEngine->lua(), LUA_GCTIMEOUT, psLUA_GCTIMEOUT) >= 0)
+            break;
+        // LUA_GCTIMEOUT is unsupported, fallback to LUA_GCSTEP
+        [[fallthrough]];
+
+    default:
+        ps_lua_gc_method = 1;
+
+    case 1:
+        lua_gc(GEnv.ScriptEngine->lua(), LUA_GCSTEP, psLUA_GCSTEP);
+        break;
+    }
+
+    AIStats.LuaGC.End();
 }
 
 #ifdef DEBUG_PRECISE_PATH
@@ -795,6 +817,7 @@ void CLevel::DumpStatistics(IGameFont& font, IPerformanceAlert* alert)
     font.OutNext("AI vision:    %2.2fms, %d", AIStats.Vis.result, AIStats.Vis.count);
     font.OutNext("- query:      %2.2fms", AIStats.VisQuery.result);
     font.OutNext("- rayCast:    %2.2fms", AIStats.VisRayTests.result);
+    font.OutNext("LUA GC:       %d Kb, %2.2fms", lua_gc(GEnv.ScriptEngine->lua(), LUA_GCCOUNT, 0), AIStats.LuaGC.result);
     AIStats.FrameStart();
 }
 

src/xrGame/Level.cpp

@@ -71,6 +71,7 @@ class CLevel : public IGame_Level, public IPureClient
         CStatTimer Vis; // visibility detection - total
         CStatTimer VisQuery; // visibility detection - portal traversal and frustum culling
         CStatTimer VisRayTests; // visibility detection - ray casting
+        CStatTimer LuaGC; // LuaJIT Garbage collector
 
         AIStatistics() { FrameStart(); }
         void FrameStart()
@@ -82,6 +83,7 @@ class CLevel : public IGame_Level, public IPureClient
             Vis.FrameStart();
             VisQuery.FrameStart();
             VisRayTests.FrameStart();
+            LuaGC.FrameStart();
         }
 
         void FrameEnd()
@@ -93,6 +95,7 @@ class CLevel : public IGame_Level, public IPureClient
             Vis.FrameEnd();
             VisQuery.FrameEnd();
             VisRayTests.FrameEnd();
+            LuaGC.FrameEnd();
         }
     };
     AIStatistics AIStats;

src/xrGame/Level.h

@@ -75,6 +75,8 @@ ENGINE_API
 extern float psHUD_FOV;
 extern float psSqueezeVelocity;
 extern int psLUA_GCSTEP;
+extern int psLUA_GCTIMEOUT;
+extern u32 ps_lua_gc_method;
 extern int g_auto_ammo_unload;
 
 extern int x_m_x;
@@ -147,6 +149,15 @@ enum E_COMMON_FLAGS
     flAiUseTorchDynamicLights = 1
 };
 
+const xr_token lua_gc_method_token[] =
+{
+    { "gc_disable", 0 },
+    { "gc_step", 1 },
+    { "gc_timeout", 2 },
+    { "gc_full", 3 },
+    { nullptr, -1 }
+};
+
 CUIOptConCom g_OptConCom;
 
 static void full_memory_stats()
@@ -1452,6 +1463,35 @@ class CCC_TimeFactor : public IConsole_Command
 
 #endif // MASTER_GOLD
 
+class CCC_LuaGCMethod : public CCC_Token
+{
+public:
+    CCC_LuaGCMethod(pcstr name) : CCC_Token(name, &ps_lua_gc_method, lua_gc_method_token) {}
+
+    void Execute(pcstr args) override
+    {
+        const auto prev = *value;
+        CCC_Token::Execute(args);
+
+        switch (*value)
+        {
+        case 0:
+            lua_gc(GEnv.ScriptEngine->lua(), LUA_GCSTOP, 0);
+            break;
+        case 1:
+        case 2:
+            if (prev == 0)
+                lua_gc(GEnv.ScriptEngine->lua(), LUA_GCRESTART, 0);
+            break;
+        case 3:
+            // Perform a full garbage collection cycle and return to previous strategy.
+            lua_gc(GEnv.ScriptEngine->lua(), LUA_GCCOLLECT, 0);
+            *value = prev;
+            break;
+        }
+    }
+};
+
 #include "GamePersistent.h"
 
 class CCC_MainMenu : public IConsole_Command
@@ -2077,8 +2117,11 @@ void CCC_RegisterCommands()
     CMD3(CCC_Mask, "lua_debug", &g_LuaDebug, 1);
 #endif // MASTER_GOLD
 
-#ifdef DEBUG
+    CMD1(CCC_LuaGCMethod, "lua_gc_method");
     CMD4(CCC_Integer, "lua_gcstep", &psLUA_GCSTEP, 1, 1000);
+    CMD4(CCC_Integer, "lua_gc_timeout", &psLUA_GCTIMEOUT, 1000, 16000);
+
+#ifdef DEBUG
     CMD3(CCC_Mask, "ai_debug", &psAI_Flags, aiDebug);
     CMD3(CCC_Mask, "ai_dbg_brain", &psAI_Flags, aiBrain);
     CMD3(CCC_Mask, "ai_dbg_motion", &psAI_Flags, aiMotion);