oss/luanti
oss/luanti
1
0
Fork 0
mirror of https://github.com/luanti-org/luanti.git synced 2025-06-27 16:36:03 +00:00
Code Wiki Activity

Fix segfault in deprecation logging due to tail call, log by default (#10174)

Browse source
This commit is contained in:
rubenwardy 2020-10-31 18:19:23 +00:00 • committed by GitHub
parent 2dff3dd03f
commit 89dd05fdf3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 71 additions and 80 deletions
Download patch file Download diff file Expand all files Collapse all files

61
src/script/lua_api/l_base.cpp
View file

@ -100,32 +100,21 @@ bool ModApiBase::registerFunction(lua_State *L, const char *name,
return true;
}
std::unordered_map<std::string, luaL_Reg> ModApiBase::m_deprecated_wrappers;
bool ModApiBase::m_error_deprecated_calls = false;
int ModApiBase::l_deprecated_function(lua_State *L)
int ModApiBase::l_deprecated_function(lua_State *L, const char *good, const char *bad, lua_CFunction func)
{
thread_local std::vector<u64> deprecated_logged;
DeprecatedHandlingMode dep_mode = get_deprecated_handling_mode();
if (dep_mode == DeprecatedHandlingMode::Ignore)
return func(L);
u64 start_time = porting::getTimeUs();
lua_Debug ar;
// Get function name for lookup
FATAL_ERROR_IF(!lua_getstack(L, 0, &ar), "lua_getstack() failed");
FATAL_ERROR_IF(!lua_getinfo(L, "n", &ar), "lua_getinfo() failed");
// Combine name with line and script backtrace
// Get caller name with line and script backtrace
FATAL_ERROR_IF(!lua_getstack(L, 1, &ar), "lua_getstack() failed");
FATAL_ERROR_IF(!lua_getinfo(L, "Sl", &ar), "lua_getinfo() failed");
// Get parent class to get the wrappers map
luaL_checktype(L, 1, LUA_TUSERDATA);
void *ud = lua_touserdata(L, 1);
ModApiBase *o = *(ModApiBase**)ud;
// New function and new function name
auto it = o->m_deprecated_wrappers.find(ar.name);
// Get backtrace and hash it to reduce the warning flood
std::string backtrace = ar.short_src;
backtrace.append(":").append(std::to_string(ar.currentline));
@ -135,46 +124,16 @@ int ModApiBase::l_deprecated_function(lua_State *L)
== deprecated_logged.end()) {
deprecated_logged.emplace_back(hash);
warningstream << "Call to deprecated function '" << ar.name << "', please use '"
<< it->second.name << "' at " << backtrace << std::endl;
warningstream << "Call to deprecated function '" << bad << "', please use '"
<< good << "' at " << backtrace << std::endl;
if (m_error_deprecated_calls)
if (dep_mode == DeprecatedHandlingMode::Error)
script_error(L, LUA_ERRRUN, NULL, NULL);
}
u64 end_time = porting::getTimeUs();
g_profiler->avg("l_deprecated_function", end_time - start_time);
return it->second.func(L);
return func(L);
}
void ModApiBase::markAliasDeprecated(luaL_Reg *reg)
{
std::string value = g_settings->get("deprecated_lua_api_handling");
m_error_deprecated_calls = value == "error";
if (!m_error_deprecated_calls && value != "log")
return;
const char *last_name = nullptr;
lua_CFunction last_func = nullptr;
// ! Null termination !
while (reg->func) {
if (last_func == reg->func) {
// Duplicate found
luaL_Reg original_reg;
// Do not inline struct. Breaks MSVC or is error-prone
original_reg.name = last_name;
original_reg.func = reg->func;
m_deprecated_wrappers.emplace(
std::pair<std::string, luaL_Reg>(reg->name, original_reg));
reg->func = l_deprecated_function;
} else {
last_func = reg->func;
last_name = reg->name;
}
++reg;
}
}