oss/luanti
oss/luanti
1
0
Fork 0
mirror of https://github.com/luanti-org/luanti.git synced 2025-09-30 19:22:14 +00:00
Code Wiki Activity

Builtin profiler: Capture Tracy zones; And small improvements (#16479)

Browse source 
* Feature: Use the builtin profiler to automatically make zones for mod callback functions.
* Doc: Basic doc for builtin profiler, and better `/profiler` chatcommand help.
* Fix: `register_functions` (table of callback register function names), and `entity_instrumentation` is no longer outdated.
* Fix: Builtin profiler output is no longer printed to debug.txt or to file in world with translation escapes.
* Fix: Entity callback name generation used `obj_def.label` (normally non-existing field), now it uses the entity name.
* Small code improvements, like use of new `Settings.get_bool` with default.
This commit is contained in:
DS 2025-09-08 18:27:26 +02:00 • committed by GitHub
parent c9d4c33174
commit 69497200f9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
7 changed files with 171 additions and 92 deletions
Download patch file Download diff file Expand all files Collapse all files

25
builtin/profiler/init.lua
View file

@ -4,18 +4,10 @@
local S = core.get_translator("__builtin")
local function get_bool_default(name, default)
local val = core.settings:get_bool(name)
if val == nil then
return default
end
return val
end
local profiler_path = core.get_builtin_path().."profiler"..DIR_DELIM
local profiler = {}
local sampler = assert(loadfile(profiler_path .. "sampling.lua"))(profiler)
local instrumentation = assert(loadfile(profiler_path .. "instrumentation.lua"))(profiler, sampler, get_bool_default)
local instrumentation = assert(loadfile(profiler_path .. "instrumentation.lua"))(profiler, sampler)
local reporter = dofile(profiler_path .. "reporter.lua")
profiler.instrument = instrumentation.instrument
@ -24,14 +16,17 @@ profiler.instrument = instrumentation.instrument
-- Is called later, after `core.register_chatcommand` was set up.
--
function profiler.init_chatcommand()
local instrument_profiler = get_bool_default("instrument.profiler", false)
local instrument_profiler = core.settings:get_bool("instrument.profiler", false)
if instrument_profiler then
instrumentation.init_chatcommand()
end
local param_usage = S("print [<filter>] | dump [<filter>] | save [<format> [<filter>]] | reset")
core.register_chatcommand("profiler", {
description = S("Handle the profiler and profiling data"),
description = S("Handle the profiler and profiling data. "
.. "Can output to chat (print), action log (dump), or file in world (save). "
.. "Format can be one of txt, csv, lua, json, json_pretty (structures may be subject to change). "
.. "Filter is a lua pattern used to limit output to matching mod names."),
params = param_usage,
privs = { server=true },
func = function(name, param)
@ -39,10 +34,10 @@ function profiler.init_chatcommand()
local args = arg0 and string.split(arg0, " ")
if command == "dump" then
core.log("action", reporter.print(sampler.profile, arg0))
core.log("action", reporter.print(sampler.profile, arg0, false))
return true, S("Statistics written to action log.")
elseif command == "print" then
return true, reporter.print(sampler.profile, arg0)
return true, reporter.print(sampler.profile, arg0, true)
elseif command == "save" then
return reporter.save(sampler.profile, args[1] or "txt", args[2])
elseif command == "reset" then
@ -50,9 +45,7 @@ function profiler.init_chatcommand()
return true, S("Statistics were reset.")
end
return false,
S("Usage: @1", param_usage) .. "\n" ..
S("Format can be one of txt, csv, lua, json, json_pretty (structures may be subject to change).")
return false
end
})