Separate hook start methods, simple generic start with defaults. Declare separate start methods in script export.

Author: Neloreck

src/xrScriptEngine/ScriptEngineScript.cpp

@@ -183,6 +183,14 @@ SCRIPT_EXPORT(CScriptEngine, (),
         {
             GEnv.ScriptEngine->m_profiler->start(hook_type);
         }),
+        def("start_sampling_mode", +[](u32 sampling_interval)
+        {
+            GEnv.ScriptEngine->m_profiler->startSamplingMode(sampling_interval);
+        }),
+        def("start_hook_mode", +[](u32 stack_depth)
+        {
+            GEnv.ScriptEngine->m_profiler->startHookMode(stack_depth);
+        }),
         def("stop", +[]()
         {
             GEnv.ScriptEngine->m_profiler->stop();

src/xrScriptEngine/script_profiler.cpp

@@ -7,11 +7,10 @@ CScriptProfiler::CScriptProfiler(CScriptEngine* engine)
     R_ASSERT(engine != NULL);
 
     m_engine = engine;
-
     m_active = false;
     m_profiler_type = CScriptProfilerType::None;
 	m_sampling_profile_interval = PROFILE_SAMPLING_INTERVAL_DEFAULT;
-    m_hook_profile_level = PROFILE_HOOK_LEVEL_DEFAULT;
+    m_hook_profile_depth = PROFILE_HOOK_DEPTH_DEFAULT;
 
     if (strstr(Core.Params, ARGUMENT_PROFILER_DEFAULT))
         start();
@@ -28,63 +27,88 @@ CScriptProfiler::~CScriptProfiler()
 
 void CScriptProfiler::start(CScriptProfilerType profiler_type)
 {
-    if (m_active)
+    switch (profiler_type)
     {
-        Msg("[P] Tried to start already active profiler, operation ignored");
-        return;
+	case CScriptProfilerType::Hook:
+		startHookMode(PROFILE_HOOK_DEPTH_DEFAULT);
+    	return;
+    case CScriptProfilerType::Sampling:
+		startSamplingMode(PROFILE_SAMPLING_INTERVAL_DEFAULT);
+	    return;
+    case CScriptProfilerType::None:
+		Msg("[P] Tried to start none type profiler");
+	    return;
+    default: NODEFAULT;
     }
+}
 
-    if (profiler_type == CScriptProfilerType::None)
+void CScriptProfiler::startHookMode(u32 stack_depth)
+{
+    if (m_active)
     {
-        Msg("[P] Tried to start none type profiler");
+        Msg("[P] Tried to start already active profiler, operation ignored");
         return;
     }
 
     if (!lua())
     {
-    	Msg("[P] Activating profiler on lua engine start, waiting init");
+    	Msg("[P] Activating hook profiler on lua engine start, waiting init");
 
-		m_profiler_type = profiler_type;
+		m_profiler_type = CScriptProfilerType::Hook;
 		m_active = true;
 
         return;
     }
 
-    switch (profiler_type)
+    clamp(stack_depth, 0u, PROFILE_SAMPLING_INTERVAL_MAX);
+
+    if (!attachLuaHook())
     {
-	case CScriptProfilerType::Hook:
-   		if (!attachLuaHook())
-        {
-        	Msg("[P] Cannot start scripts hook profiler, hook was not set properly");
-			return;
-        }
+        Msg("[P] Cannot start scripts hook profiler, hook was not set properly");
+		return;
+    }
 
-    	Msg("[P] Starting scripts hook profiler");
+    Msg("[P] Starting scripts hook profiler, depth: %d", stack_depth);
 
-        m_hook_profiling_portions.clear();
-		m_profiler_type = profiler_type;
-	    m_active = true;
+    m_hook_profile_depth = stack_depth;
+    m_hook_profiling_portions.clear();
+	m_profiler_type = CScriptProfilerType::Hook;
+	m_active = true;
+}
 
-    	return;
-    case CScriptProfilerType::Sampling:
+void CScriptProfiler::startSamplingMode(u32 sampling_interval)
+{
+    if (m_active)
     {
-        if (!luaIsJitProfilerDefined(lua()))
-        {
-        	Msg("[P] Cannot start scripts sampling profiler, jit.profiler module is not defined");
-			return;
-        }
+        Msg("[P] Tried to start already active profiler, operation ignored");
+        return;
+    }
 
-    	Msg("[P] Starting scripts sampling profiler, interval: %d", m_sampling_profile_interval);
-        luaJitSamplingProfilerAttach(this, m_sampling_profile_interval);
+    if (!lua())
+    {
+    	Msg("[P] Activating sampling profiler on lua engine start, waiting init");
 
-        m_profiler_type = profiler_type;
+		m_profiler_type = CScriptProfilerType::Sampling;
 		m_active = true;
 
-	    return;
+        return;
     }
 
-    default:  NODEFAULT;
+    if (!luaIsJitProfilerDefined(lua()))
+    {
+        Msg("[P] Cannot start scripts sampling profiler, jit.profiler module is not defined");
+		return;
     }
+
+    clamp(sampling_interval, 1u, PROFILE_SAMPLING_INTERVAL_MAX);
+
+    Msg("[P] Starting scripts sampling profiler, interval: %d", sampling_interval);
+
+    luaJitSamplingProfilerAttach(this, sampling_interval);
+
+    m_sampling_profile_interval = sampling_interval;
+	m_profiler_type = CScriptProfilerType::Sampling;
+	m_active = true;
 }
 
 void CScriptProfiler::stop()
@@ -380,8 +404,11 @@ void CScriptProfiler::onLuaHookCall(lua_State* L, lua_Debug* dbg)
     lua_Debug parent_stack_info;
     lua_Debug stack_info;
 
+    // todo: Implement dynamic depth.
+    // todo: Implement dynamic depth.
+
     // Check higher level of stack.
-    if (m_hook_profile_level > 0)
+    if (m_hook_profile_depth > 0)
     {
         if (!lua_getstack(L, 1, &parent_stack_info))
         {
@@ -401,15 +428,15 @@ void CScriptProfiler::onLuaHookCall(lua_State* L, lua_Debug* dbg)
     string512 buffer;
 
     auto name = stack_info.name ? stack_info.name : "?";
-    auto parent_name = m_hook_profile_level > 0 && parent_stack_info.name ? parent_stack_info.name : "?";
+    auto parent_name = m_hook_profile_depth > 0 && parent_stack_info.name ? parent_stack_info.name : "?";
     auto short_src = stack_info.short_src;
     auto line_defined = stack_info.linedefined;
 
     if (!stack_info.name && line_defined == 0)
         name = "lua-script-body";
 
     // Include date from higher stack levels.
-    if (m_hook_profile_level > 0)
+    if (m_hook_profile_depth > 0)
         xr_sprintf(buffer, "%s [%d] - %s @ %s", name, line_defined, parent_name, short_src);
     else
         xr_sprintf(buffer, "%s [%d] @ %s", name, line_defined, parent_name, short_src);
@@ -511,7 +538,7 @@ void CScriptProfiler::luaJitSamplingProfilerAttach(CScriptProfiler* profiler, u3
     xr_itoa(interval, buffer + 3, 10);
 
     luaJitProfilerStart(
-        profiler->lua(), "fli",
+        profiler->lua(), buffer,
         [](void* data, lua_State* L, int samples, int vmstate) {
             CScriptProfiler* profiler = static_cast<CScriptProfiler*>(data);
             string2048 buffer;

src/xrScriptEngine/script_profiler.hpp

@@ -76,25 +76,26 @@ class XRSCRIPTENGINE_API CScriptProfiler
     using Duration = Clock::duration;
 
 private:
+    // List of commnad line args for startup profuler attach:
     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_HOOK_DEPTH_DEFAULT = 1;
+    static const u32 PROFILE_HOOK_DEPTH_MAX = 1;
     static const u32 PROFILE_SAMPLING_INTERVAL_DEFAULT = 10;
     static const u32 PROFILE_SAMPLING_INTERVAL_MAX = 1000;
 
     CScriptEngine* m_engine;
-
-    bool m_active;
     CScriptProfilerType m_profiler_type;
+    bool m_active;
 
     /*
-     * Profiling level - number of stacks to check before each function call.
+     * Profiling depth - number of stacks to summarise function call trace.
      * Helps validating results of same functions called from different places vs totals by specific function.
      */
-	u32 m_hook_profile_level;
+	u32 m_hook_profile_depth;
     /*
      * Sampling interval for JIT based profiler.
      * Value should be set in ms and defaults to 10ms.
@@ -110,6 +111,8 @@ class XRSCRIPTENGINE_API CScriptProfiler
     bool isActive() const { return m_active; };
 
 	void start(CScriptProfilerType profiler_type = CScriptProfilerType::Hook);
+    void startSamplingMode(u32 sampling_interval);
+    void startHookMode(u32 stack_depth);
     void stop();
     void reset();