/* * STATE.CPP * * Lua tools to support Lanes. */ /* =============================================================================== Copyright (C) 2002-10 Asko Kauppi 2011-24 benoit Germain Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. =============================================================================== */ #include "state.h" #include "intercopycontext.h" #include "lane.h" #include "lanes.h" #include "tools.h" #include "universe.h" // ################################################################################################# /*---=== Serialize require ===--- */ //--- // [val,...]= new_require( ... ) // // Call 'old_require' but only one lane at a time. // // Upvalues: [1]: original 'require' function // [[nodiscard]] static int luaG_new_require(lua_State* L_) { int const _args{ lua_gettop(L_) }; // L_: args Universe* const _U{ universe_get(L_) }; // char const* modname = luaL_checkstring(L_, 1); STACK_GROW(L_, 1); lua_pushvalue(L_, lua_upvalueindex(1)); // L_: args require lua_insert(L_, 1); // L_: require args // Using 'lua_pcall()' to catch errors; otherwise a failing 'require' would // leave us locked, blocking any future 'require' calls from other lanes. _U->requireMutex.lock(); // starting with Lua 5.4, require may return a second optional value, so we need LUA_MULTRET int _rc{ lua_pcall(L_, _args, LUA_MULTRET, 0 /*errfunc*/) }; // L_: err|result(s) _U->requireMutex.unlock(); // the required module (or an error message) is left on the stack as returned value by original require function if (_rc != LUA_OK) { // LUA_ERRRUN / LUA_ERRMEM ? raise_lua_error(L_); } // should be 1 for Lua <= 5.3, 1 or 2 starting with Lua 5.4 return lua_gettop(L_); // L_: result(s) } // ################################################################################################# /* * Serialize calls to 'require', if it exists */ void serialize_require(DEBUGSPEW_PARAM_COMMA(Universe* U_) lua_State* L_) { STACK_GROW(L_, 1); STACK_CHECK_START_REL(L_, 0); DEBUGSPEW_CODE(fprintf(stderr, INDENT_BEGIN "serializing require()\n" INDENT_END(U_))); // Check 'require' is there and not already wrapped; if not, do nothing // lua_getglobal(L_, "require"); if (lua_isfunction(L_, -1) && lua_tocfunction(L_, -1) != luaG_new_require) { // [-1]: original 'require' function lua_pushcclosure(L_, luaG_new_require, 1 /*upvalues*/); lua_setglobal(L_, "require"); } else { // [-1]: nil lua_pop(L_, 1); } STACK_CHECK(L_, 0); } // ################################################################################################# /*---=== luaG_newstate ===---*/ [[nodiscard]] static int require_lanes_core(lua_State* L_) { // leaves a copy of 'lanes.core' module table on the stack luaL_requiref(L_, kLanesCoreLibName, luaopen_lanes_core, 0); return 1; } // ################################################################################################# namespace global { static luaL_Reg const sLibs[] = { { "base", nullptr }, // ignore "base" (already acquired it) #if LUA_VERSION_NUM >= 502 #ifdef luaopen_bit32 { LUA_BITLIBNAME, luaopen_bit32 }, #endif { LUA_COLIBNAME, luaopen_coroutine }, // Lua 5.2: coroutine is no longer a part of base! #else // LUA_VERSION_NUM { LUA_COLIBNAME, nullptr }, // Lua 5.1: part of base package #endif // LUA_VERSION_NUM { LUA_DBLIBNAME, luaopen_debug }, #ifndef PLATFORM_XBOX // no os/io libs on xbox { LUA_IOLIBNAME, luaopen_io }, { LUA_OSLIBNAME, luaopen_os }, #endif // PLATFORM_XBOX { LUA_LOADLIBNAME, luaopen_package }, { LUA_MATHLIBNAME, luaopen_math }, { LUA_STRLIBNAME, luaopen_string }, { LUA_TABLIBNAME, luaopen_table }, #if LUA_VERSION_NUM >= 503 { LUA_UTF8LIBNAME, luaopen_utf8 }, #endif #if LUAJIT_FLAVOR() != 0 // building against LuaJIT headers, add some LuaJIT-specific libs { LUA_BITLIBNAME, luaopen_bit }, { LUA_FFILIBNAME, luaopen_ffi }, { LUA_JITLIBNAME, luaopen_jit }, #endif // LUAJIT_FLAVOR() { kLanesCoreLibName, require_lanes_core } // So that we can open it like any base library (possible since we have access to the init function) }; } // namespace global // ################################################################################################# static void open1lib(DEBUGSPEW_PARAM_COMMA(Universe* U_) lua_State* L_, char const* name_, size_t len_) { for (luaL_Reg const& _entry : global::sLibs) { if (strncmp(name_, _entry.name, len_) == 0) { lua_CFunction const _libfunc{ _entry.func }; if (!_libfunc) { continue; } name_ = _entry.name; // note that the provided name_ doesn't necessarily ends with '\0', hence len_ DEBUGSPEW_CODE(fprintf(stderr, INDENT_BEGIN "opening %.*s library\n" INDENT_END(U_), (int) len_, name_)); STACK_CHECK_START_REL(L_, 0); // open the library as if through require(), and create a global as well if necessary (the library table is left on the stack) bool const isLanesCore{ _libfunc == require_lanes_core }; // don't want to create a global for "lanes.core" luaL_requiref(L_, name_, _libfunc, !isLanesCore); // L_: {lib} // lanes.core doesn't declare a global, so scan it here and now if (isLanesCore) { populate_func_lookup_table(L_, -1, name_); } lua_pop(L_, 1); // L_: STACK_CHECK(L_, 0); break; } } } // ################################################################################################# template static inline void open1lib(DEBUGSPEW_PARAM_COMMA(Universe* U_) lua_State* L_, char const (&name_)[N]) { open1lib(DEBUGSPEW_PARAM_COMMA(U_) L_, name_, N - 1); } // ################################################################################################# // just like lua_xmove, args are (from, to) static void copy_one_time_settings(Universe* U_, SourceState L1_, DestState L2_) { DEBUGSPEW_CODE(DebugSpewIndentScope _scope{ U_ }); STACK_GROW(L1_, 2); STACK_CHECK_START_REL(L1_, 0); STACK_CHECK_START_REL(L2_, 0); DEBUGSPEW_CODE(fprintf(stderr, INDENT_BEGIN "copy_one_time_settings()\n" INDENT_END(U_))); kConfigRegKey.pushValue(L1_); // L1_: config // copy settings from from source to destination registry InterCopyContext _c{ U_, L2_, L1_, {}, {}, {}, {}, {} }; if (_c.inter_move(1) != InterCopyResult::Success) { // L1_: L2_: config raise_luaL_error(L1_, "failed to copy settings when loading " kLanesCoreLibName); } // set L2:_R[kConfigRegKey] = settings kConfigRegKey.setValue(L2_, [](lua_State* L_) { lua_insert(L_, -2); }); // L1_: L2_: config STACK_CHECK(L2_, 0); STACK_CHECK(L1_, 0); } // ################################################################################################# void InitializeOnStateCreate(Universe* U_, lua_State* L_) { STACK_CHECK_START_REL(L_, 1); // L_: settings lua_getfield(L_, -1, "on_state_create"); // L_: settings on_state_create|nil if (!lua_isnil(L_, -1)) { // store C function pointer in an internal variable U_->onStateCreateFunc = lua_tocfunction(L_, -1); // L_: settings on_state_create if (U_->onStateCreateFunc != nullptr) { // make sure the function doesn't have upvalues char const* _upname{ lua_getupvalue(L_, -1, 1) }; // L_: settings on_state_create upval? if (_upname != nullptr) { // should be "" for C functions with upvalues if any raise_luaL_error(L_, "on_state_create shouldn't have upvalues"); } // remove this C function from the config table so that it doesn't cause problems // when we transfer the config table in newly created Lua states lua_pushnil(L_); // L_: settings on_state_create nil lua_setfield(L_, -3, "on_state_create"); // L_: settings on_state_create } else { // optim: store marker saying we have such a function in the config table U_->onStateCreateFunc = reinterpret_cast(InitializeOnStateCreate); } } lua_pop(L_, 1); // L_: settings STACK_CHECK(L_, 1); } // ################################################################################################# lua_State* create_state([[maybe_unused]] Universe* U_, lua_State* from_) { lua_State* _L; #if LUAJIT_FLAVOR() == 64 // for some reason, LuaJIT 64 bits does not support creating a state with lua_newstate... _L = luaL_newstate(); #else // LUAJIT_FLAVOR() == 64 if (U_->provideAllocator != nullptr) { // we have a function we can call to obtain an allocator lua_pushcclosure(from_, U_->provideAllocator, 0); lua_call(from_, 0, 1); { AllocatorDefinition* const def{ lua_tofulluserdata(from_, -1) }; _L = lua_newstate(def->allocF, def->allocUD); } lua_pop(from_, 1); } else { // reuse the allocator provided when the master state was created _L = lua_newstate(U_->protectedAllocator.allocF, U_->protectedAllocator.allocUD); } #endif // LUAJIT_FLAVOR() == 64 if (_L == nullptr) { raise_luaL_error(from_, "luaG_newstate() failed while creating state; out of memory"); } return _L; } // ################################################################################################# void CallOnStateCreate(Universe* U_, lua_State* L_, lua_State* from_, LookupMode mode_) { if (U_->onStateCreateFunc != nullptr) { STACK_CHECK_START_REL(L_, 0); DEBUGSPEW_CODE(fprintf(stderr, INDENT_BEGIN "calling on_state_create()\n" INDENT_END(U_))); if (U_->onStateCreateFunc != reinterpret_cast(InitializeOnStateCreate)) { // C function: recreate a closure in the new state, bypassing the lookup scheme lua_pushcfunction(L_, U_->onStateCreateFunc); // on_state_create() } else { // Lua function located in the config table, copied when we opened "lanes.core" if (mode_ != LookupMode::LaneBody) { // if attempting to call in a keeper state, do nothing because the function doesn't exist there // this doesn't count as an error though STACK_CHECK(L_, 0); return; } kConfigRegKey.pushValue(L_); // L_: {} STACK_CHECK(L_, 1); lua_getfield(L_, -1, "on_state_create"); // L_: {} on_state_create() lua_remove(L_, -2); // L_: on_state_create() } STACK_CHECK(L_, 1); // capture error and raise it in caller state if (lua_pcall(L_, 0, 0, 0) != LUA_OK) { raise_luaL_error(from_, "on_state_create failed: \"%s\"", lua_isstring(L_, -1) ? lua_tostring(L_, -1) : lua_typename(L_, lua_type(L_, -1))); } STACK_CHECK(L_, 0); } } // ################################################################################################# /* * Like 'luaL_openlibs()' but allows the set of libraries be selected * * nullptr no libraries, not even base * "" base library only * "io,string" named libraries * "*" all libraries * * Base ("unpack", "print" etc.) is always added, unless 'libs' is nullptr. * * *NOT* called for keeper states! * */ lua_State* luaG_newstate(Universe* U_, SourceState from_, char const* libs_) { DestState const _L{ create_state(U_, from_) }; STACK_GROW(_L, 2); STACK_CHECK_START_ABS(_L, 0); // copy the universe as a light userdata (only the master state holds the full userdata) // that way, if Lanes is required in this new state, we'll know we are part of this universe universe_store(_L, U_); STACK_CHECK(_L, 0); // we'll need this every time we transfer some C function from/to this state kLookupRegKey.setValue(_L, [](lua_State* L_) { lua_newtable(L_); }); STACK_CHECK(_L, 0); // neither libs (not even 'base') nor special init func: we are done if (libs_ == nullptr && U_->onStateCreateFunc == nullptr) { DEBUGSPEW_CODE(fprintf(stderr, INDENT_BEGIN "luaG_newstate(nullptr)\n" INDENT_END(U_))); return _L; } DEBUGSPEW_CODE(fprintf(stderr, INDENT_BEGIN "luaG_newstate()\n" INDENT_END(U_))); DEBUGSPEW_CODE(DebugSpewIndentScope _scope{ U_ }); // copy settings (for example because it may contain a Lua on_state_create function) copy_one_time_settings(U_, from_, _L); // 'lua.c' stops GC during initialization so perhaps it is a good idea. :) lua_gc(_L, LUA_GCSTOP, 0); // Anything causes 'base' to be taken in if (libs_ != nullptr) { // special "*" case (mainly to help with LuaJIT compatibility) // as we are called from luaopen_lanes_core() already, and that would deadlock if (libs_[0] == '*' && libs_[1] == 0) { DEBUGSPEW_CODE(fprintf(stderr, INDENT_BEGIN "opening ALL standard libraries\n" INDENT_END(U_))); luaL_openlibs(_L); // don't forget lanes.core for regular lane states open1lib(DEBUGSPEW_PARAM_COMMA(U_) _L, kLanesCoreLibName); libs_ = nullptr; // done with libs } else { DEBUGSPEW_CODE(fprintf(stderr, INDENT_BEGIN "opening base library\n" INDENT_END(U_))); #if LUA_VERSION_NUM >= 502 // open base library the same way as in luaL_openlibs() luaL_requiref(_L, LUA_GNAME, luaopen_base, 1); lua_pop(_L, 1); #else // LUA_VERSION_NUM lua_pushcfunction(_L, luaopen_base); lua_pushstring(_L, ""); lua_call(_L, 1, 0); #endif // LUA_VERSION_NUM } } STACK_CHECK(_L, 0); // scan all libraries, open them one by one if (libs_) { unsigned int len{ 0 }; for (char const* p{ libs_ }; *p; p += len) { // skip delimiters ('.' can be part of name for "lanes.core") while (*p && !isalnum(*p) && *p != '.') ++p; // skip name len = 0; while (isalnum(p[len]) || p[len] == '.') ++len; // open library open1lib(DEBUGSPEW_PARAM_COMMA(U_) _L, p, len); } } lua_gc(_L, LUA_GCRESTART, 0); serialize_require(DEBUGSPEW_PARAM_COMMA(U_) _L); // call this after the base libraries are loaded and GC is restarted // will raise an error in from_ in case of problem CallOnStateCreate(U_, _L, from_, LookupMode::LaneBody); STACK_CHECK(_L, 0); // after all this, register everything we find in our name<->function database lua_pushglobaltable(_L); // Lua 5.2 no longer has LUA_GLOBALSINDEX: we must push globals table on the stack STACK_CHECK(_L, 1); populate_func_lookup_table(_L, -1, nullptr); #if 1 && USE_DEBUG_SPEW() // dump the lookup database contents kLookupRegKey.pushValue(_L); // L: {} lua_pushnil(_L); // L: {} nil while (lua_next(_L, -2)) { // L: {} k v lua_getglobal(_L, "print"); // L: {} k v print int const indent{ U_->debugspewIndentDepth.load(std::memory_order_relaxed) }; lua_pushlstring(_L, DebugSpewIndentScope::debugspew_indent, indent); // L: {} k v print " " lua_pushvalue(_L, -4); // L: {} k v print " " k lua_pushvalue(_L, -4); // L: {} k v print " " k v lua_call(_L, 3, 0); // L: {} k v lua_pop(_L, 1); // L: {} k } lua_pop(_L, 1); // L: {} #endif // USE_DEBUG_SPEW() lua_pop(_L, 1); STACK_CHECK(_L, 0); return _L; }