[LUA] Adding C++ profiler for lua scripts. #1771
Open
+1,228
−23
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Please, consider using LuaJIT's built-in profiler: |
|
@Xottab-DUTY sounds better |
|
@Xottab-DUTY |
The suggestion is to use it here, on the C++ side. |
|
@Xottab-DUTY Will try to add simplistic variant with luajit mode to compare it / switch in runtime. I think it will not be too complex if we just print some stats here. Later something similar to https://github.com/cdsama/LuaProfiler/blob/master/lua_profiler.cpp can be considered, but still need some R&D to understand if I can build traces correctly here.
|
Xottab-DUTY
reviewed
Jan 14, 2025
| u64 total_count = 0; | ||
| u64 total_duration = 0; | ||
|
|
||
| std::vector<decltype(m_profiling_portions)::iterator> entries; |
There was a problem hiding this comment.
Always use xr_vector.
If the data isn't too big, you can even use buffer_vector with xr_alloca (there are examples in the code base).
Suggested change
| std::vector<decltype(m_profiling_portions)::iterator> entries; | |
| xr_vector<decltype(m_profiling_portions)::iterator> entries; |
There was a problem hiding this comment.
For me it was 3-4k records in average. I believe it will be <10k pointers almost always
| @@ -153,6 +154,8 @@ class XRSCRIPTENGINE_API CScriptEngine | |||
| } | |||
|
|
|||
| public: | |||
| CScriptProfiler* m_profiler; | |||
There was a problem hiding this comment.
We already have included script_profiler.hpp above. Why a pointer? It's better to place the instance here I think.
There was a problem hiding this comment.
After checking sampling variant seems like it still has to be a pointer or complex logics inside profiler. Ideally only one profiler should exist and work with scripts contexts while we have few script engines (global singleton + shaders compiling one?)
Xottab-DUTY
added
Enhancement
SDK
Lua
Developer Experience
Xottab-DUTY
reviewed
Jan 14, 2025
github-actions
bot
added
the
Game assets
Neloreck
force-pushed
the
dev-lua-profiler
branch
from
9902f58 to
d3d5aa3
Compare
|
Example report console log with hook profiler: |
|
Exported hook profiler data (trimmed, 4460 lines in the file): |
|
Console reported log for sampling profiler: |
|
Sampling profiler report example is above. Also I found out that we have tracy integration and tracy methods allow to track down specific zones. Will explore it as separate part in my project (I can try override AST nodes building from typescript to lua and add zones absolutely everywhere behind some building flag). |
…ch hook by default, use original logics for script engine, add attach methods. Update profiler exports, add profiler type global variables. Add profiler type separation / additional methods for hook/jit based profiling. Separate env vars for different profiling.
…c naming for class members.
…are separate start methods in script export.
…ify logics flow. Configurable report saving methods. lua_profiler_status console command.
… const expressions for lua profiler commands.
Neloreck
force-pushed
the
dev-lua-profiler
branch
from
99838b5 to
ee02f2a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Since lua profiler from
profiler.scriptcannot be revived, adding c++ based profiler. For not it is draft with basic POC part, will try to improve it based on other existing implementations. Will add more details in description over time.Changes
New command line arguments
-lua_profilerstart game with default lua scripts profiler (hook variant right now)-lua_hook_profilerstart game with hook based scripts profiler-lua_sampling_profilerstart game with hook based scripts profilerNew console commands
lua_profiler_status- print profiler type/statuslua_profiler_start- start profiler in default mode (or provide type as argument)lua_profiler_start_hook_mode- start profiler in hook mdoeua_profiler_start_sampling_mode- start in sampling mode with 10ms interval (or provide as argument)lua_profiler_stop- stop profilerlua_profiler_reset- reset profiler datalua_profiler_log- log 128 profiler entries (or provide count as argument)lua_profiler_save- save profiling report in a separate .perf/.log fileNew Lua exports
PROFILER_TYPE_NONE- constant with profiler none typePROFILER_TYPE_HOOK- constant with profiler hook typePROFILER_TYPE_SAMPLING- constant with profiler sampling typeprofiler.is_active- whether profiler is active nowprofiler.get_type- currently active profiler typeprofiler.start- start profiler (default)profiler.start_sampling_mode- start profiler in sampling modeprofiler.start_hook_mode- start profiler in hook modeprofiler.stop- stop profilerprofiler.reset- reset profiler dataprofiler.log_report- log profiling reportprofiler.save_report- save profiling reportTesting
Links