Const expressions for args. Use interval param in sampling profiler.

Author: Neloreck

src/xrScriptEngine/script_profiler.cpp

@@ -9,18 +9,22 @@ CScriptProfiler::CScriptProfiler(CScriptEngine* engine)
     m_engine = engine;
 
     m_active = false;
-    m_hook_profile_level = 1;
     m_profiler_type = CScriptProfilerType::None;
+	m_sampling_profile_interval = PROFILE_SAMPLING_INTERVAL_DEFAULT;
+    m_hook_profile_level = PROFILE_HOOK_LEVEL_DEFAULT;
 
-    if (strstr(Core.Params, "-lua_profiler"))
+    if (strstr(Core.Params, ARGUMENT_PROFILER_DEFAULT))
         start();
-	else if (strstr(Core.Params, "-lua_hook_profiler"))
+	else if (strstr(Core.Params, ARGUMENT_PROFILER_HOOK))
     	start(CScriptProfilerType::Hook);
-    else if (strstr(Core.Params, "-lua_sampling_profiler"))
+    else if (strstr(Core.Params, ARGUMENT_PROFILER_SAMPLING))
         start(CScriptProfilerType::Sampling);
 }
 
-CScriptProfiler::~CScriptProfiler() {}
+CScriptProfiler::~CScriptProfiler()
+{
+    m_engine = nullptr;
+}
 
 void CScriptProfiler::start(CScriptProfilerType profiler_type)
 {
@@ -70,8 +74,8 @@ void CScriptProfiler::start(CScriptProfilerType profiler_type)
 			return;
         }
 
-    	Msg("[P] Starting scripts sampling profiler");
-        luaJitSamplingProfilerAttach(this);
+    	Msg("[P] Starting scripts sampling profiler, interval: %d", m_sampling_profile_interval);
+        luaJitSamplingProfilerAttach(this, m_sampling_profile_interval);
 
         m_profiler_type = profiler_type;
 		m_active = true;
@@ -254,13 +258,60 @@ void CScriptProfiler::logSamplingReport()
 
 void CScriptProfiler::saveReport()
 {
-    Log("[P] Saving profiler report");
+	switch (m_profiler_type)
+    {
+        case CScriptProfilerType::Hook:
+            return saveHookReport();
+        case CScriptProfilerType::Sampling:
+            return saveSamplingReport();
+        default:
+            Msg("[P] No active profiling data to save report");
+            return;
+    }
+}
+
+void CScriptProfiler::saveHookReport()
+{
+    if (m_hook_profiling_portions.empty())
+	{
+        Msg("[P] Nothing to report for hook profiler, data is missing");
+        return;
+    }
+
+    Log("[P] Saving hook profiler report");
 
     // todo;
     // todo;
     // todo;
 }
 
+void CScriptProfiler::saveSamplingReport()
+{
+	if (m_sampling_profiling_log.empty())
+	{
+        Msg("[P] Nothing to report for sampling profiler, data is missing");
+        return;
+    }
+
+    string_path log_file_name;
+    strconcat(sizeof(log_file_name), log_file_name, Core.ApplicationName, "_", Core.UserName, "_sampling_profile.perf");
+    FS.update_path(log_file_name, "$logs$", log_file_name);
+
+    Msg("[P] Saving sampling report to %s", log_file_name);
+
+    IWriter* F = FS.w_open(log_file_name);
+
+    if (F)
+    {
+        for (auto &it : m_sampling_profiling_log)
+        {
+            F->w_string(*it);
+        }
+
+        FS.w_close(F);
+    }
+}
+
 /*
 * @returns whether profiling lua hook was/is attached to current VM context
 */
@@ -284,10 +335,6 @@ void CScriptProfiler::onDispose(lua_State* L)
 
 void CScriptProfiler::onReinit(lua_State* L)
 {
-	// todo: Should we get old ref and detach profiler / hook?
-	// todo: Should we get old ref and detach profiler / hook?
-	// todo: Should we get old ref and detach profiler / hook?
-
     if (!m_active)
     	return;
 
@@ -315,13 +362,13 @@ void CScriptProfiler::onReinit(lua_State* L)
 			return;
         }
 
-    	Msg("[P] Re-init scripts sampling profiler, attach handler");
-        luaJitSamplingProfilerAttach(this);
+        Msg("[P] Re-init scripts sampling profiler - attach handler, interval: %d", m_sampling_profile_interval);
+		luaJitSamplingProfilerAttach(this, m_sampling_profile_interval);
 
 	    return;
     }
 
-    default:  NODEFAULT;
+    default: NODEFAULT;
     }
 }
 
@@ -458,8 +505,11 @@ bool CScriptProfiler::luaIsJitProfilerDefined(lua_State* L)
 * Attach sampling profiling hooks.
 * With provided period report samples and store information in profiler for further reporting.
 */
-void CScriptProfiler::luaJitSamplingProfilerAttach(CScriptProfiler* profiler)
+void CScriptProfiler::luaJitSamplingProfilerAttach(CScriptProfiler* profiler, u32 interval)
 {
+	string32 buffer = "fli";
+    xr_itoa(interval, buffer + 3, 10);
+
     luaJitProfilerStart(
         profiler->lua(), "fli",
         [](void* data, lua_State* L, int samples, int vmstate) {

src/xrScriptEngine/script_profiler.hpp

@@ -76,22 +76,30 @@ class XRSCRIPTENGINE_API CScriptProfiler
     using Duration = Clock::duration;
 
 private:
+    constexpr static cpcstr ARGUMENT_PROFILER_DEFAULT = "-lua_profiler";
+    constexpr static cpcstr ARGUMENT_PROFILER_HOOK = "-lua_hook_profiler";
+    constexpr static cpcstr ARGUMENT_PROFILER_SAMPLING = "-lua_sampling_profiler";
+
     static const u32 PROFILE_ENTRIES_LOG_LIMIT = 128;
+    static const u32 PROFILE_HOOK_LEVEL_DEFAULT = 1;
+    static const u32 PROFILE_SAMPLING_INTERVAL_DEFAULT = 10;
+    static const u32 PROFILE_SAMPLING_INTERVAL_MAX = 1000;
 
     CScriptEngine* m_engine;
 
     bool m_active;
-
-    // todo: Add period parameter for sampling profiler.
-
-    // Profiling level - number of stacks to check before each function call.
-    // Helps validating results of same functions called from different places vs totals by specific function.
- 	// todo: Handle level / provide level properly.
-	u8 m_hook_profile_level;
     CScriptProfilerType m_profiler_type;
-    // todo: Profiler-type specific naming for containers.
-    // todo: Profiler-type specific naming for containers.
-    // todo: Profiler-type specific naming for containers.
+
+    /*
+     * Profiling level - number of stacks to check before each function call.
+     * Helps validating results of same functions called from different places vs totals by specific function.
+     */
+	u32 m_hook_profile_level;
+    /*
+     * Sampling interval for JIT based profiler.
+     * Value should be set in ms and defaults to 10ms.
+     */
+	u32 m_sampling_profile_interval;
     xr_unordered_map<shared_str, CScriptProfilerHookPortion> m_hook_profiling_portions;
     xr_vector<shared_str> m_sampling_profiling_log;
 
@@ -109,20 +117,20 @@ class XRSCRIPTENGINE_API CScriptProfiler
     void logHookReport();
     void logSamplingReport();
     void saveReport();
-    // todo: Save sampling report.
-    // todo: Save hook.
+    void saveHookReport();
+    void saveSamplingReport();
 
-    bool attachLuaHook();
    	void onReinit(lua_State* L);
 	void onDispose(lua_State* L);
     void onLuaHookCall(lua_State* L, lua_Debug* dbg);
 
 private:
     lua_State* lua() const;
+    bool attachLuaHook();
 
-    static int luaMemoryUsed(lua_State* L);
+   	static int luaMemoryUsed(lua_State* L);
     static bool luaIsJitProfilerDefined(lua_State* L);
-    static void luaJitSamplingProfilerAttach(CScriptProfiler* profiler);
+    static void luaJitSamplingProfilerAttach(CScriptProfiler* profiler, u32 interval);
     static void luaJitProfilerStart(lua_State* L, cpcstr mode, luaJIT_profile_callback callback, void* data);
     static void luaJitProfilerStop(lua_State* L);
     static std::pair<cpcstr, size_t> luaJitProfilerDump(lua_State* L, cpcstr format, int depth);