✨ feat(TSG-11154): 增加script运行时间限制

2 files changed, 147 insertions, 7 deletions

diff --git a/src/tsg_lua_func.cpp b/src/tsg_lua_func.cpp
index 09d5ba0..2255033 100644
--- a/src/tsg_lua_func.cpp
+++ b/src/tsg_lua_func.cpp
@@ -9,6 +9,7 @@ extern "C"
 #include<stdlib.h>
 #include<string.h>
 #include<setjmp.h>
+#include<time.h>
 #include "lualib.h"
 #include "luajit.h"
 #include "lauxlib.h"
@@ -115,6 +116,13 @@ struct lua_private_info_t
     char lua_name[1024];
     void *userdata;
     int errcode;
+    int tsg_lua_mode;
+#define TSG_LUA_JIT_ON 0
+#define TSG_LUA_JIT_OFF 1
+    long time_now;
+    long time_limit;
+    bool is_expired;    //not return error from C, when the script was ran in C and time out, 
+                        // keep this status and not return error until the script run in LUA
 };
 
 //static jmp_buf lua_exception[TSG_MAX_LUA_ID];
@@ -140,6 +148,13 @@ static exec_error_massage_t exec_error[] =
     {"attempt to call global", "(a nil value)"},        /* ERR_SCRIPT_CALL_GLOBAL_BUT_NIL */
 };
 
+static long mstime()
+{
+    struct timespec now;
+    clock_gettime(CLOCK_MONOTONIC, &now);
+    return now.tv_sec * 1000 + now.tv_nsec/1000000;
+}
+
 static void debuginfo(const char *info, const char *file, size_t line) 
 {   
 #ifdef TSG_LUA_DEBUG    
@@ -703,6 +718,10 @@ int tsg_lua_exec_file(tsg_lua_handle L, const char *script, const char *in, size
 
     if (setjmp(*lua_exception) == 0)
     {
+        if (lua_info->time_limit > 0)
+        {
+            lua_info->time_now = mstime();
+        }
         if (lua_pcall(L, 0, LUA_MULTRET, 0))
         {
             err = lua_tostring(L, -1);
@@ -712,6 +731,10 @@ int tsg_lua_exec_file(tsg_lua_handle L, const char *script, const char *in, size
                 if ((strstr(err, exec_error[i].err_info1)) && (strstr(err, exec_error[i].err_info2))) 
                     return ERR_SCRIPT_EXEC_ERROR - (i + 1);
             }
+            if (strcmp(err, "Lua script killed by time out.") == 0)
+            {
+                return ERR_SCRIPT_TIMEOUT; 
+            }
             return ERR_SCRIPT_EXEC_ERROR;
         }
         int num = lua_gettop(L);
@@ -932,6 +955,10 @@ int tsg_lua_exec(tsg_lua_handle L, const char *script, size_t script_len, const
     lua_settop(L, 1);
     if (setjmp(*lua_exception) == 0)
     {
+        if (lua_info->time_limit > 0)
+        {
+            lua_info->time_now = mstime();
+        }
         if (lua_pcall(L, 0, LUA_MULTRET, 0))
         {
             err = lua_tostring(L, -1);
@@ -941,6 +968,10 @@ int tsg_lua_exec(tsg_lua_handle L, const char *script, size_t script_len, const
                 if ((strstr(err, exec_error[i].err_info1)) && (strstr(err, exec_error[i].err_info2))) 
                     return ERR_SCRIPT_EXEC_ERROR - (i + 1);
             }
+            if (strcmp(err, "Lua script killed by time out.") == 0)
+            {
+                return ERR_SCRIPT_TIMEOUT; 
+            }
             return ERR_SCRIPT_EXEC_ERROR;
         }
         int num = lua_gettop(L);
@@ -1329,6 +1360,10 @@ int tsg_lua_cache_exec(tsg_lua_handle L, size_t script_id, const char *in, size_
 
     if (setjmp(*lua_exception) == 0)
     {
+        if (lua_info->time_limit > 0)
+        {
+            lua_info->time_now = mstime();
+        }
         if (lua_pcall(L, 0, LUA_MULTRET, 0))
         {
             const char *err = lua_tostring(L, -1);
@@ -1338,6 +1373,10 @@ int tsg_lua_cache_exec(tsg_lua_handle L, size_t script_id, const char *in, size_
                 if ((strstr(err, exec_error[i].err_info1)) && (strstr(err, exec_error[i].err_info2))) 
                     return ERR_SCRIPT_EXEC_ERROR - (i + 1);
             }
+            if (strcmp(err, "Lua script killed by time out.") == 0)
+            {
+                return ERR_SCRIPT_TIMEOUT; 
+            }
             return ERR_SCRIPT_EXEC_ERROR;
         }
         int num = lua_gettop(L);
@@ -1690,7 +1729,7 @@ int lua_script_context_free(tsg_lua_handle L, struct lua_script_context_t *conte
     return 0;
 }
 
-int lua_cache_exec(tsg_lua_handle L, size_t script_id, struct lua_data_t in, void *userdata, lua_script_context context, struct lua_arg_t *outvalue)
+int lua_cache_exec(tsg_lua_handle L, size_t script_id, struct lua_data_t in, void *userdata, lua_script_context context, size_t timeout_ms, struct lua_arg_t *outvalue)
 {
     if (L == NULL)
     {
@@ -1718,10 +1757,19 @@ int lua_cache_exec(tsg_lua_handle L, size_t script_id, struct lua_data_t in, voi
         lua_settop(L, 0);
     }
 
+    if (timeout_ms > 0)
+    {
+        lua_set_script_timeout(L, timeout_ms);
+    }
+    else
+    {
+        luaJIT_setmode(L, 0, LUAJIT_MODE_ENGINE | LUAJIT_MODE_ON);
+    }
+
     return tsg_lua_cache_exec(L, script_id, in.data, in.len, outvalue->str, &outvalue->len, &outvalue->type);
 }
 
-int lua_exec(tsg_lua_handle L, struct lua_data_t script, struct lua_data_t in, void *userdata, lua_script_context context, struct lua_arg_t *outvalue)
+int lua_exec(tsg_lua_handle L, struct lua_data_t script, struct lua_data_t in, void *userdata, lua_script_context context, size_t timeout_ms, struct lua_arg_t *outvalue)
 {
     if (L == NULL)
     {
@@ -1749,10 +1797,19 @@ int lua_exec(tsg_lua_handle L, struct lua_data_t script, struct lua_data_t in, v
         lua_settop(L, 0);
     }
 
+    if (timeout_ms > 0)
+    {
+        lua_set_script_timeout(L, timeout_ms);
+    }
+    else
+    {
+        luaJIT_setmode(L, 0, LUAJIT_MODE_ENGINE | LUAJIT_MODE_ON);
+    }
+
     return tsg_lua_exec(L, script.data, script.len,  in.data, in.len, outvalue->str, &outvalue->len, &outvalue->type);
 }
 
-int lua_exec_file(tsg_lua_handle L, const char *script, struct lua_data_t in, void *userdata, lua_script_context context, struct lua_arg_t *outvalue)
+int lua_exec_file(tsg_lua_handle L, const char *script, struct lua_data_t in, void *userdata, lua_script_context context, size_t timeout_ms, struct lua_arg_t *outvalue)
 {
     if (L == NULL)
     {
@@ -1780,6 +1837,15 @@ int lua_exec_file(tsg_lua_handle L, const char *script, struct lua_data_t in, vo
         lua_settop(L, 0);
     }
 
+    if (timeout_ms > 0)
+    {
+        lua_set_script_timeout(L, timeout_ms);
+    }
+    else
+    {
+        luaJIT_setmode(L, 0, LUAJIT_MODE_ENGINE | LUAJIT_MODE_ON);
+    }
+
     return tsg_lua_exec_file(L, script, in.data, in.len, outvalue->str, &outvalue->len, &outvalue->type);
 }
 
@@ -1808,4 +1874,72 @@ int lua_remove_cmd(tsg_lua_handle L, const char *cmd)
     lua_settop(L, 0);
 
     return 0;
+}
+
+static void luaMaskCountHook(tsg_lua_handle L, lua_Debug *ar)
+{
+    struct lua_private_info_t *lua_info = (struct lua_private_info_t *)lua_getexdata(L);
+
+    if (lua_info->is_expired == true)
+    {
+        if (ar->what && memcmp(ar->what, "C", 1) == 0)
+        {
+            return;
+        }
+        else
+        {
+            lua_pushstring(L, "Lua script killed by time out.");
+            lua_error(L);
+            return;
+        }
+    }
+
+    long elapsed = mstime() - lua_info->time_now;
+    if ( lua_info->time_limit > 0 && elapsed > lua_info->time_limit)
+    {
+        //printf("elasped:%ld\n", elapsed);
+        if (ar->what && memcmp(ar->what, "C", 1) == 0)
+        {
+            lua_info->is_expired = true;
+            // reset the interval to a shorter time
+            int hook_granularity = lua_info->time_limit * 1000000 / 1000; //about time_limt / 1000
+            lua_sethook(L, luaMaskCountHook, LUA_MASKCOUNT, hook_granularity);
+        }
+        else
+        {
+            lua_pushstring(L, "Lua script killed by time out.");
+            lua_error(L);
+        }
+    }
+}
+
+int lua_set_script_timeout(tsg_lua_handle L, int ms)
+{
+    if (L == NULL || ms < 0)
+    {
+        return ERR_PARAMETER;
+    }
+
+    struct lua_private_info_t *lua_info = (struct lua_private_info_t *)lua_getexdata(L);
+    if (lua_info == NULL)
+    {
+        return ERR_LUA_PRIVATE_INFO_IS_NIL;
+    }
+
+    lua_info->time_limit = ms;
+    if (ms == 0)
+    {
+        lua_info->tsg_lua_mode = TSG_LUA_JIT_ON;
+        luaJIT_setmode(L, 0, LUAJIT_MODE_ENGINE | LUAJIT_MODE_ON);
+    }
+    else
+    {
+        lua_info->tsg_lua_mode = TSG_LUA_JIT_OFF;
+        luaJIT_setmode(L, 0, LUAJIT_MODE_ENGINE | LUAJIT_MODE_OFF);
+    }
+
+    int hook_granularity = ms * 1000000 / 20; //about ms / 20
+    lua_sethook(L, luaMaskCountHook, LUA_MASKCOUNT, hook_granularity);
+
+    return 0;
 }
\ No newline at end of file
diff --git a/src/tsg_lua_interface.h b/src/tsg_lua_interface.h
index 7e2c250..8e370d7 100644
--- a/src/tsg_lua_interface.h
+++ b/src/tsg_lua_interface.h
@@ -86,7 +86,8 @@ enum err_value
     ERR_PARAMETER                               = -38,      /* Paramter error */
     ERR_LUA_PRIVATE_INFO_IS_NIL                 = -39,      /* The private info of lua is nil */
     ERR_LUA_SET_CONTEXT_FAILED                  = -40,      /* lua malloc context failed */
-    ERR_UNKNOWN                                 = -41,      /* Unkown */
+    ERR_SCRIPT_TIMEOUT                          = -41,      /* Time out */
+    ERR_UNKNOWN                                 = -42,      /* Unkown */
     ERR_RETUNR_NIL                              = 1,        /* Script run successed, but return a nil value*/
     ERR_RETURN_TYPE_NOT_MATCH_EXPECT            = 2,        /* Script run successed，but the type of return value does not match expection */
 };
@@ -203,9 +204,10 @@ int lua_script_context_free(tsg_lua_handle L, lua_script_context context);
  *                    struct lua_data_t in          data waiting to be handled
  *                    void *userdata                can get the userdata with lua_get_userdata(L)
  *                    lua_script_context context    Can accessed with lua-name.context in lua script
+ *                    size_t timeout_ms             Maximum time to run the script.if timeout_ms > 0, jit.off; timeout_ms == 0, jit.on, not expired.
  * output:            struct lua_arg_t *outvalue    Requires input of an expected type that is not NIL, the type of the result that will be output after the call is complete
  * return value:      int                           successed, return 0; failed, return error code */
-int lua_cache_exec(tsg_lua_handle L, size_t script_id, struct lua_data_t in, void *userdata, lua_script_context context, struct lua_arg_t *outvalue);
+int lua_cache_exec(tsg_lua_handle L, size_t script_id, struct lua_data_t in, void *userdata, lua_script_context context, size_t timeout_ms, struct lua_arg_t *outvalue);
 
 /* function name:     lua_exec   
  * input:             tsg_lua_handle L              a virtual machine
@@ -213,9 +215,10 @@ int lua_cache_exec(tsg_lua_handle L, size_t script_id, struct lua_data_t in, voi
  *                    struct lua_data_t in          data waiting to be handled
  *                    void *userdata                can get the userdata with lua_get_userdata(L)
  *                    lua_script_context context    Can accessed with lua-name.context in lua script
+ *                    size_t timeout_ms             Maximum time to run the script.if timeout_ms > 0, jit.off; timeout_ms == 0, jit.on, not expired.
  * output:            struct lua_arg_t *outvalue    Requires input of an expected type that is not NIL, the type of the result that will be output after the call is complete
  * return value:      int                           successed, return 0; failed, return error code */
-int lua_exec(tsg_lua_handle L, struct lua_data_t script, struct lua_data_t in, void *userdata, lua_script_context context, struct lua_arg_t *outvalue);
+int lua_exec(tsg_lua_handle L, struct lua_data_t script, struct lua_data_t in, void *userdata, lua_script_context context, size_t timeout_ms, struct lua_arg_t *outvalue);
 
 /* function name:     lua_exec_file   
  * input:             tsg_lua_handle L              a virtual machine
@@ -223,9 +226,10 @@ int lua_exec(tsg_lua_handle L, struct lua_data_t script, struct lua_data_t in, v
  *                    struct lua_data_t in          data waiting to be handled
  *                    void *userdata                can get the userdata with lua_get_userdata(L)
  *                    lua_script_context context    Can accessed with lua-name.context in lua script
+ *                    size_t timeout_ms             Maximum time to run the script.if timeout_ms > 0, jit.off; timeout_ms == 0, jit.on, not expired.
  * output:            struct lua_arg_t *outvalue    Requires input of an expected type that is not NIL, the type of the result that will be output after the call is complete
  * return value:      int                           successed, return 0; failed, return error code */
-int lua_exec_file(tsg_lua_handle L, const char *script, struct lua_data_t in, void *userdata, lua_script_context context, struct lua_arg_t *outvalue);
+int lua_exec_file(tsg_lua_handle L, const char *script, struct lua_data_t in, void *userdata, lua_script_context context, size_t timeout_ms, struct lua_arg_t *outvalue);
 
 /* function name：      tsg_lua_vm_create
  * input:               char *name          the name of virtual machine, default: "TSG"
@@ -235,4 +239,6 @@ tsg_lua_handle tsg_lua_vm_create_with_name(const char *name);
 int lua_get_error_code(tsg_lua_handle L);
 
 int lua_remove_cmd(tsg_lua_handle L, const char *cmd);
+
+int lua_set_script_timeout(tsg_lua_handle L, int second);
 #endif