Add lua_getowner for fast access to owner resource (#2146)

Pirulax · botder · web-flow · commit 3eb0bf699511 · 2021-04-07T14:13:56.000+02:00
* Implement add `owner` field to Lua for faster owner resource access

* Refactor CanUseFunction server side to use lua_getowner

* Set CLuaMain* as owner instead of the resource.

* Rename: lua_getowner =&gt; lua_getmtasaowner. And global_State::owner =&gt; mtasaowner

* Introduce lua_getownercluamain and lua_getownerresource to LuaCommon.h

* Retrun a reference instead of pointer

* Update Server/mods/deathmatch/logic/luadefs/CLuaDefs.cpp

Co-authored-by: Marek Kulik &lt;me@botder.com&gt;

* Rename argument owner -&gt; mtasaowner

Co-authored-by: Marek Kulik &lt;me@botder.com&gt;
diff --git a/Client/mods/deathmatch/logic/lua/CLuaMain.cpp b/Client/mods/deathmatch/logic/lua/CLuaMain.cpp
@@ -143,7 +143,7 @@ void CLuaMain::InitVM()
     assert(!m_luaVM);
 
     // Create a new VM
-    m_luaVM = lua_open();
+    m_luaVM = lua_open(this);
     m_pLuaManager->OnLuaMainOpenVM(this, m_luaVM);
 
     // Set the instruction count hook
diff --git a/Client/mods/deathmatch/logic/lua/LuaCommon.cpp b/Client/mods/deathmatch/logic/lua/LuaCommon.cpp
@@ -192,6 +192,16 @@ void lua_pushmatrix(lua_State* luaVM, const CMatrix& matrix)
     lua_addtotalbytes(luaVM, LUA_GC_EXTRA_BYTES);
 }
 
+CLuaMain& lua_getownercluamain(lua_State* L)
+{
+    return *static_cast<class CLuaMain*>(lua_getmtasaowner(L));
+}
+
+CResource& lua_getownerresource(lua_State* L)
+{
+    return *lua_getownercluamain(L).GetResource();
+}
+
 // Just do a type check vs LUA_TNONE before calling this, or bant
 const char* lua_makestring(lua_State* luaVM, int iArgument)
 {
diff --git a/Client/mods/deathmatch/logic/lua/LuaCommon.h b/Client/mods/deathmatch/logic/lua/LuaCommon.h
@@ -78,6 +78,9 @@ void lua_classmetamethod(lua_State* luaVM, const char* szName, lua_CFunction fn)
 
 const char* lua_makestring(lua_State* luaVM, int iArgument);
 
+class CLuaMain& lua_getownercluamain(lua_State* L);
+class CResource& lua_getownerresource(lua_State* L);
+
 // Lua debug info for logging
 enum
 {
diff --git a/Server/mods/deathmatch/logic/lua/CLuaMain.cpp b/Server/mods/deathmatch/logic/lua/CLuaMain.cpp
@@ -172,7 +172,7 @@ void CLuaMain::InitVM()
     assert(!m_luaVM);
 
     // Create a new VM
-    m_luaVM = lua_open();
+    m_luaVM = lua_open(this);
     m_pLuaManager->OnLuaMainOpenVM(this, m_luaVM);
 
     // Set the instruction count hook
diff --git a/Server/mods/deathmatch/logic/lua/LuaCommon.cpp b/Server/mods/deathmatch/logic/lua/LuaCommon.cpp
@@ -274,6 +274,16 @@ void lua_pushmatrix(lua_State* luaVM, const CMatrix& matrix)
     lua_addtotalbytes(luaVM, LUA_GC_EXTRA_BYTES);
 }
 
+CLuaMain& lua_getownercluamain(lua_State* L)
+{
+    return *static_cast<class CLuaMain*>(lua_getmtasaowner(L));
+}
+
+CResource& lua_getownerresource(lua_State* L)
+{
+    return *lua_getownercluamain(L).GetResource();
+}
+
 // Just do a type check vs LUA_TNONE before calling this, or bant
 const char* lua_makestring(lua_State* luaVM, int iArgument)
 {
diff --git a/Server/mods/deathmatch/logic/lua/LuaCommon.h b/Server/mods/deathmatch/logic/lua/LuaCommon.h
@@ -45,6 +45,9 @@ void lua_pushvector(lua_State* luaVM, const CVector& vector);
 void lua_pushvector(lua_State* luaVM, const CVector4D& vector);
 void lua_pushmatrix(lua_State* luaVM, const CMatrix& matrix);
 
+class CLuaMain& lua_getownercluamain(lua_State* L);
+class CResource& lua_getownerresource(lua_State* L);
+
 // Converts any type to string
 const char* lua_makestring(lua_State* luaVM, int iArgument);
 
diff --git a/Server/mods/deathmatch/logic/luadefs/CLuaDefs.cpp b/Server/mods/deathmatch/logic/luadefs/CLuaDefs.cpp
@@ -10,6 +10,7 @@
  *****************************************************************************/
 
 #include "StdInc.h"
+#include "lua/LuaCommon.h"
 extern uint g_uiNetSentByteCounter;
 
 namespace
@@ -113,20 +114,18 @@ int CLuaDefs::CanUseFunction(lua_CFunction f, lua_State* luaVM)
     {
         return true;
     }
-
+    
     // Get associated resource
-    CResource* pResource = m_pResourceManager->GetResourceFromLuaState(luaVM);
-    if (!pResource)
-        return true;
+    CResource& resource{ lua_getownerresource(luaVM) };
 
     // Update execution time check
-    pResource->GetVirtualMachine()->CheckExecutionTime();
+    resource.GetVirtualMachine()->CheckExecutionTime();
 
     // Check function right cache in resource
     bool bAllowed;
 
     // Check cached ACL rights
-    if (pResource->CheckFunctionRightCache(f, &bAllowed))
+    if (resource.CheckFunctionRightCache(f, &bAllowed))
     {
         // If in cache, and not allowed, do warning here
         if (!bAllowed)
@@ -168,7 +167,7 @@ int CLuaDefs::CanUseFunction(lua_CFunction f, lua_State* luaVM)
             }
         }
         // Update cache in resource
-        pResource->UpdateFunctionRightCache(f, bAllowed);
+        resource.UpdateFunctionRightCache(f, bAllowed);
     }
 
     if (!g_pGame->GetDebugHookManager()->OnPreFunction(f, luaVM, bAllowed))
diff --git a/vendor/lua/src/lapi.c b/vendor/lua/src/lapi.c
@@ -1139,4 +1139,10 @@ LUA_API void lua_addtotalbytes(lua_State *L, int n)
 LUA_API int lua_ncallresult(lua_State *L)
 {
     return L->nexpectedresults;
-}
+}
+
+// MTA Addition to access `owner` value
+LUA_API void *lua_getmtasaowner(lua_State* L)
+{
+    return G(L)->mtasaowner;
+}
diff --git a/vendor/lua/src/lauxlib.c b/vendor/lua/src/lauxlib.c
@@ -644,8 +644,8 @@ static int panic (lua_State *L) {
 }
 
 
-LUALIB_API lua_State *luaL_newstate (void) {
-  lua_State *L = lua_newstate(l_alloc, NULL);
+LUALIB_API lua_State *luaL_newstate (void* mtasaowner) {
+  lua_State *L = lua_newstate(l_alloc, NULL, mtasaowner);
   if (L) lua_atpanic(L, &panic);
   return L;
 }
diff --git a/vendor/lua/src/lauxlib.h b/vendor/lua/src/lauxlib.h
@@ -79,7 +79,7 @@ LUALIB_API int (luaL_loadbuffer) (lua_State *L, const char *buff, size_t sz,
                                   const char *name);
 LUALIB_API int (luaL_loadstring) (lua_State *L, const char *s);
 
-LUALIB_API lua_State *(luaL_newstate) (void);
+LUALIB_API lua_State *(luaL_newstate) (void *mtasaowner);
 
 
 LUALIB_API const char *(luaL_gsub) (lua_State *L, const char *s, const char *p,
diff --git a/vendor/lua/src/lstate.c b/vendor/lua/src/lstate.c
@@ -140,7 +140,7 @@ void luaE_freethread (lua_State *L, lua_State *L1) {
 }
 
 
-LUA_API lua_State *lua_newstate (lua_Alloc f, void *ud) {
+LUA_API lua_State *lua_newstate (lua_Alloc f, void *ud, void *mtasaowner) {
   int i;
   lua_State *L;
   global_State *g;
@@ -156,6 +156,7 @@ LUA_API lua_State *lua_newstate (lua_Alloc f, void *ud) {
   preinit_state(L, g);
   g->frealloc = f;
   g->ud = ud;
+  g->mtasaowner = mtasaowner;
   g->mainthread = L;
   g->uvhead.u.l.prev = &g->uvhead;
   g->uvhead.u.l.next = &g->uvhead;
@@ -222,4 +223,3 @@ LUA_API lua_State* lua_getmainstate (lua_State *L) {
     }
     return L;
 }
-
diff --git a/vendor/lua/src/lstate.h b/vendor/lua/src/lstate.h
@@ -91,6 +91,9 @@ typedef struct global_State {
   UpVal uvhead;  /* head of double-linked list of all open upvalues */
   struct Table *mt[NUM_TAGS];  /* metatables for basic types */
   TString *tmname[TM_N];  /* array with tag-method names */
+
+  /* MTA Specific stuff */
+  void *mtasaowner;  /* pointer to this state's CLuaMain */
 } global_State;
 
 
diff --git a/vendor/lua/src/lua.h b/vendor/lua/src/lua.h
@@ -56,6 +56,7 @@ typedef int (*lua_CFunction) (lua_State *L);
 */
 typedef int (*lua_PreCallHook) ( lua_CFunction f, lua_State* L );
 LUA_API void lua_registerPreCallHook ( lua_PreCallHook f );
+
 typedef void (*lua_PostCallHook) ( lua_CFunction f, lua_State* L );
 LUA_API void lua_registerPostCallHook ( lua_PostCallHook f );
 
@@ -118,7 +119,7 @@ typedef LUA_INTEGER lua_Integer;
 /*
 ** state manipulation
 */
-LUA_API lua_State *(lua_newstate) (lua_Alloc f, void *ud);
+LUA_API lua_State *(lua_newstate) (lua_Alloc f, void *ud, void *mtasaowner);
 LUA_API void       (lua_close) (lua_State *L);
 LUA_API lua_State *(lua_newthread) (lua_State *L);
 
@@ -127,6 +128,7 @@ LUA_API lua_CFunction (lua_atpanic) (lua_State *L, lua_CFunction panicf);
 // MTA Specific functions.
 // ChrML: Added function to get the main state from a lua state that is a coroutine
 LUA_API lua_State* (lua_getmainstate) (lua_State* L);
+LUA_API void *lua_getmtasaowner(lua_State* L);
 
 /*
 ** basic stack manipulation
@@ -306,7 +308,7 @@ LUA_API void lua_setallocf (lua_State *L, lua_Alloc f, void *ud);
 ** compatibility macros and functions
 */
 
-#define lua_open()	luaL_newstate()
+#define lua_open(mtasaowner)	    luaL_newstate(mtasaowner)
 
 #define lua_getregistry(L)	lua_pushvalue(L, LUA_REGISTRYINDEX)
 

Original file line number	Diff line number	Diff line change
`@@ -78,6 +78,9 @@ void lua_classmetamethod(lua_State* luaVM, const char* szName, lua_CFunction fn)`
`78`	`78`
`79`	`79`	`const char* lua_makestring(lua_State* luaVM, int iArgument);`
`80`	`80`
	`81`	`+class CLuaMain& lua_getownercluamain(lua_State* L);`
	`82`	`+class CResource& lua_getownerresource(lua_State* L);`
	`83`	`+`
`81`	`84`	`// Lua debug info for logging`
`82`	`85`	`enum`
`83`	`86`	`{`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@`
`10`	`10`	`*****************************************************************************/`
`11`	`11`
`12`	`12`	`#include "StdInc.h"`
	`13`	`+#include "lua/LuaCommon.h"`
`13`	`14`	`extern uint g_uiNetSentByteCounter;`
`14`	`15`
`15`	`16`	`namespace`
`@@ -113,20 +114,18 @@ int CLuaDefs::CanUseFunction(lua_CFunction f, lua_State* luaVM)`
`113`	`114`	`{`
`114`	`115`	`return true;`
`115`	`116`	`}`
`116`		`-`
	`117`	`+`
`117`	`118`	`// Get associated resource`
`118`		`- CResource* pResource = m_pResourceManager->GetResourceFromLuaState(luaVM);`
`119`		`- if (!pResource)`
`120`		`- return true;`
	`119`	`+ CResource& resource{ lua_getownerresource(luaVM) };`
`121`	`120`
`122`	`121`	`// Update execution time check`
`123`		`- pResource->GetVirtualMachine()->CheckExecutionTime();`
	`122`	`+ resource.GetVirtualMachine()->CheckExecutionTime();`
`124`	`123`
`125`	`124`	`// Check function right cache in resource`
`126`	`125`	`bool bAllowed;`
`127`	`126`
`128`	`127`	`// Check cached ACL rights`
`129`		`- if (pResource->CheckFunctionRightCache(f, &bAllowed))`
	`128`	`+ if (resource.CheckFunctionRightCache(f, &bAllowed))`
`130`	`129`	`{`
`131`	`130`	`// If in cache, and not allowed, do warning here`
`132`	`131`	`if (!bAllowed)`
`@@ -168,7 +167,7 @@ int CLuaDefs::CanUseFunction(lua_CFunction f, lua_State* luaVM)`
`168`	`167`	`}`
`169`	`168`	`}`
`170`	`169`	`// Update cache in resource`
`171`		`- pResource->UpdateFunctionRightCache(f, bAllowed);`
	`170`	`+ resource.UpdateFunctionRightCache(f, bAllowed);`
`172`	`171`	`}`
`173`	`172`
`174`	`173`	`if (!g_pGame->GetDebugHookManager()->OnPreFunction(f, luaVM, bAllowed))`
Original file line number	Diff line number	Diff line change
`@@ -644,8 +644,8 @@ static int panic (lua_State *L) {`
`644`	`644`	`}`
`645`	`645`
`646`	`646`
`647`		`-LUALIB_API lua_State *luaL_newstate (void) {`
`648`		`- lua_State *L = lua_newstate(l_alloc, NULL);`
	`647`	`+LUALIB_API lua_State luaL_newstate (void mtasaowner) {`
	`648`	`+ lua_State *L = lua_newstate(l_alloc, NULL, mtasaowner);`
`649`	`649`	`if (L) lua_atpanic(L, &panic);`
`650`	`650`	`return L;`
`651`	`651`	`}`