mirror of
https://github.com/Bubberstation/Bubberstation.git
synced 2025-12-25 17:12:12 +00:00
* Removes logging each lua function called on the dm side of things. (#83483) ## About The Pull Request As the title says. This should significantly improve the performance of running lua scripts. ## Why It's Good For The Game There is a lot of performance overhead in logging each individual function called by a lua script as can be seen in the following screenshot: This is a test done on a local server where I run the `zombie_controller.lua` script that can be found on the auxlua-cookbook repository with a lot of AI zombies spawned in.   Logging these calls is not necessary as it doesn't provide any real information to anyone looking for bad actors. Lua scripts are already logged when ran and they can be examined to spot if the script being run is done so in bad faith. --------- Co-authored-by: Watermelon914 <3052169-Watermelon914@ users.noreply.gitlab.com> * Removes logging each lua function called on the dm side of things. --------- Co-authored-by: Watermelon914 <37270891+Watermelon914@users.noreply.github.com> Co-authored-by: Watermelon914 <3052169-Watermelon914@ users.noreply.gitlab.com>
195 lines
6.6 KiB
Plaintext
195 lines
6.6 KiB
Plaintext
#define MAX_LOG_REPEAT_LOOKBACK 5
|
|
|
|
GLOBAL_VAR_INIT(IsLuaCall, FALSE)
|
|
GLOBAL_PROTECT(IsLuaCall)
|
|
|
|
GLOBAL_DATUM(lua_usr, /mob)
|
|
GLOBAL_PROTECT(lua_usr)
|
|
|
|
/datum/lua_state
|
|
var/name
|
|
|
|
/// The internal ID of the lua state stored in auxlua's global map
|
|
var/internal_id
|
|
|
|
/// A log of every return, yield, and error for each chunk execution and function call
|
|
var/list/log = list()
|
|
|
|
/// A list of all the variables in the state's environment
|
|
var/list/globals = list()
|
|
|
|
/// A list in which to store datums and lists instantiated in lua, ensuring that they don't get garbage collected
|
|
var/list/references = list()
|
|
|
|
/// Ckey of the last user who ran a script on this lua state.
|
|
var/ckey_last_runner = ""
|
|
|
|
/// Whether the timer.lua script has been included into this lua context state.
|
|
var/timer_enabled = FALSE
|
|
|
|
/// Callbacks that need to be ran on next tick
|
|
var/list/functions_to_execute = list()
|
|
|
|
/datum/lua_state/vv_edit_var(var_name, var_value)
|
|
. = ..()
|
|
if(var_name == NAMEOF(src, internal_id))
|
|
return FALSE
|
|
|
|
/datum/lua_state/New(_name)
|
|
if(SSlua.initialized != TRUE)
|
|
qdel(src)
|
|
return
|
|
name = _name
|
|
internal_id = __lua_new_state()
|
|
|
|
/datum/lua_state/proc/check_if_slept(result)
|
|
if(result["status"] == "sleeping")
|
|
SSlua.sleeps += src
|
|
|
|
/datum/lua_state/proc/log_result(result, verbose = TRUE)
|
|
if(!islist(result))
|
|
return
|
|
if(!verbose && result["status"] != "errored" && result["status"] != "bad return" \
|
|
&& !(result["name"] == "input" && (result["status"] == "finished" || length(result["param"]))))
|
|
return
|
|
var/append_to_log = TRUE
|
|
var/index_of_log
|
|
if(log.len)
|
|
for(var/index in log.len to max(log.len - MAX_LOG_REPEAT_LOOKBACK, 1) step -1)
|
|
var/list/entry = log[index]
|
|
if(entry["status"] == result["status"] \
|
|
&& entry["chunk"] == result["chunk"] \
|
|
&& entry["name"] == result["name"] \
|
|
&& ((entry["param"] == result["param"]) || deep_compare_list(entry["param"], result["param"])))
|
|
if(!entry["repeats"])
|
|
entry["repeats"] = 0
|
|
index_of_log = index
|
|
entry["repeats"]++
|
|
append_to_log = FALSE
|
|
break
|
|
if(append_to_log)
|
|
if(islist(result["param"]))
|
|
result["param"] = weakrefify_list(encode_text_and_nulls(result["param"]))
|
|
log += list(result)
|
|
index_of_log = log.len
|
|
INVOKE_ASYNC(src, TYPE_PROC_REF(/datum/lua_state, update_editors))
|
|
return index_of_log
|
|
|
|
/datum/lua_state/proc/load_script(script)
|
|
GLOB.IsLuaCall = TRUE
|
|
var/tmp_usr = GLOB.lua_usr
|
|
GLOB.lua_usr = usr
|
|
var/result = __lua_load(internal_id, script)
|
|
GLOB.IsLuaCall = FALSE
|
|
GLOB.lua_usr = tmp_usr
|
|
|
|
// Internal errors unrelated to the code being executed are returned as text rather than lists
|
|
if(isnull(result))
|
|
result = list("status" = "errored", "param" = "__lua_load returned null (it may have runtimed - check the runtime logs)", "name" = "input")
|
|
if(istext(result))
|
|
result = list("status" = "errored", "param" = result, "name" = "input")
|
|
result["chunk"] = script
|
|
check_if_slept(result)
|
|
|
|
log_lua("[key_name(usr)] executed the following lua code:\n<code>[script]</code>")
|
|
|
|
return result
|
|
|
|
/datum/lua_state/process(seconds_per_tick)
|
|
if(timer_enabled)
|
|
var/result = call_function("__Timer_timer_process", seconds_per_tick)
|
|
log_result(result, verbose = FALSE)
|
|
for(var/function as anything in functions_to_execute)
|
|
result = call_function(list("__Timer_callbacks", function))
|
|
log_result(result, verbose = FALSE)
|
|
functions_to_execute.Cut()
|
|
|
|
/datum/lua_state/proc/call_function(function, ...)
|
|
var/call_args = length(args) > 1 ? args.Copy(2) : list()
|
|
if(islist(function))
|
|
var/list/new_function_path = list()
|
|
for(var/path_element in function)
|
|
new_function_path += path_element
|
|
function = new_function_path
|
|
|
|
var/tmp_usr = GLOB.lua_usr
|
|
GLOB.lua_usr = usr
|
|
GLOB.IsLuaCall = TRUE
|
|
var/result = __lua_call(internal_id, function, call_args)
|
|
GLOB.IsLuaCall = FALSE
|
|
GLOB.lua_usr = tmp_usr
|
|
|
|
if(isnull(result))
|
|
result = list("status" = "errored", "param" = "__lua_call returned null (it may have runtimed - check the runtime logs)", "name" = islist(function) ? jointext(function, ".") : function)
|
|
if(istext(result))
|
|
result = list("status" = "errored", "param" = result, "name" = islist(function) ? jointext(function, ".") : function)
|
|
check_if_slept(result)
|
|
return result
|
|
|
|
/datum/lua_state/proc/call_function_return_first(function, ...)
|
|
var/list/result = call_function(arglist(args))
|
|
log_result(result, verbose = FALSE)
|
|
if(length(result))
|
|
if(islist(result["param"]) && length(result["param"]))
|
|
return result["param"][1]
|
|
|
|
/datum/lua_state/proc/awaken()
|
|
GLOB.IsLuaCall = TRUE
|
|
var/result = __lua_awaken(internal_id)
|
|
GLOB.IsLuaCall = FALSE
|
|
|
|
if(isnull(result))
|
|
result = list("status" = "errored", "param" = "__lua_awaken returned null (it may have runtimed - check the runtime logs)", "name" = "An attempted awaken")
|
|
if(istext(result))
|
|
result = list("status" = "errored", "param" = result, "name" = "An attempted awaken")
|
|
check_if_slept(result)
|
|
return result
|
|
|
|
/// Prefer calling SSlua.queue_resume over directly calling this
|
|
/datum/lua_state/proc/resume(index, ...)
|
|
var/call_args = length(args) > 1 ? args.Copy(2) : list()
|
|
var/msg = "[key_name(usr)] resumed a lua coroutine with arguments: [english_list(call_args)]"
|
|
log_lua(msg)
|
|
|
|
GLOB.IsLuaCall = TRUE
|
|
var/result = __lua_resume(internal_id, index, call_args)
|
|
GLOB.IsLuaCall = FALSE
|
|
|
|
if(isnull(result))
|
|
result = list("status" = "errored", "param" = "__lua_resume returned null (it may have runtimed - check the runtime logs)", "name" = "An attempted resume")
|
|
if(istext(result))
|
|
result = list("status" = "errored", "param" = result, "name" = "An attempted resume")
|
|
check_if_slept(result)
|
|
return result
|
|
|
|
/datum/lua_state/proc/get_globals()
|
|
globals = weakrefify_list(encode_text_and_nulls(__lua_get_globals(internal_id)))
|
|
|
|
/datum/lua_state/proc/get_tasks()
|
|
return __lua_get_tasks(internal_id)
|
|
|
|
/datum/lua_state/proc/kill_task(task_info)
|
|
__lua_kill_task(internal_id, task_info)
|
|
|
|
/datum/lua_state/proc/update_editors()
|
|
var/list/editor_list = LAZYACCESS(SSlua.editors, text_ref(src))
|
|
if(editor_list)
|
|
for(var/datum/lua_editor/editor as anything in editor_list)
|
|
SStgui.update_uis(editor)
|
|
|
|
/// Called by lua scripts when they add an atom to var/list/references so that it gets cleared up on delete.
|
|
/datum/lua_state/proc/clear_on_delete(datum/to_clear)
|
|
RegisterSignal(to_clear, COMSIG_QDELETING, PROC_REF(on_delete))
|
|
|
|
/// Called by lua scripts when an atom they've added should soft delete and this state should stop tracking it.
|
|
/// Needs to unregister all signals.
|
|
/datum/lua_state/proc/let_soft_delete(datum/to_clear)
|
|
UnregisterSignal(to_clear, COMSIG_QDELETING, PROC_REF(on_delete))
|
|
references -= to_clear
|
|
|
|
/datum/lua_state/proc/on_delete(datum/to_clear)
|
|
SIGNAL_HANDLER
|
|
references -= to_clear
|
|
|
|
#undef MAX_LOG_REPEAT_LOOKBACK
|