X-Git-Url: https://git.saurik.com/redis.git/blobdiff_plain/15108778d5dde69edd61dfe11372b071339ad108..4ab8695d537eff1dbc554bf3ab1896495311deda:/src/scripting.c diff --git a/src/scripting.c b/src/scripting.c index 1f441ae4..1503c3c9 100644 --- a/src/scripting.c +++ b/src/scripting.c @@ -128,7 +128,7 @@ void luaPushError(lua_State *lua, char *error) { lua_settable(lua,-3); } -int luaRedisCommand(lua_State *lua) { +int luaRedisGenericCommand(lua_State *lua, int raise_error) { int j, argc = lua_gettop(lua); struct redisCommand *cmd; robj **argv; @@ -187,6 +187,7 @@ int luaRedisCommand(lua_State *lua) { } if (cmd->flags & REDIS_CMD_RANDOM) server.lua_random_dirty = 1; + if (cmd->flags & REDIS_CMD_WRITE) server.lua_write_dirty = 1; /* Run the command */ cmd->proc(c); @@ -205,6 +206,7 @@ int luaRedisCommand(lua_State *lua) { reply = sdscatlen(reply,o->ptr,sdslen(o->ptr)); listDelNode(c->reply,listFirst(c->reply)); } + if (raise_error && reply[0] != '-') raise_error = 0; redisProtocolToLuaType(lua,reply); sdsfree(reply); @@ -215,9 +217,25 @@ cleanup: decrRefCount(c->argv[j]); zfree(c->argv); + if (raise_error) { + /* If we are here we should have an error in the stack, in the + * form of a table with an "err" field. Extract the string to + * return the plain error. */ + lua_pushstring(lua,"err"); + lua_gettable(lua,-2); + return lua_error(lua); + } return 1; } +int luaRedisCallCommand(lua_State *lua) { + return luaRedisGenericCommand(lua,1); +} + +int luaRedisPCallCommand(lua_State *lua) { + return luaRedisGenericCommand(lua,0); +} + int luaLogCommand(lua_State *lua) { int j, argc = lua_gettop(lua); int level; @@ -256,11 +274,24 @@ int luaLogCommand(lua_State *lua) { void luaMaskCountHook(lua_State *lua, lua_Debug *ar) { long long elapsed; REDIS_NOTUSED(ar); + REDIS_NOTUSED(lua); elapsed = (ustime()/1000) - server.lua_time_start; - if (elapsed >= server.lua_time_limit) { - redisLog(REDIS_NOTICE,"Lua script aborted for max execution time after %lld milliseconds of running time.",elapsed); - lua_pushstring(lua,"Script aborted for max execution time."); + if (elapsed >= server.lua_time_limit && server.lua_timedout == 0) { + redisLog(REDIS_WARNING,"Lua slow script detected: still in execution after %lld milliseconds. You can try killing the script using the SCRIPT KILL command.",elapsed); + server.lua_timedout = 1; + /* Once the script timeouts we reenter the event loop to permit others + * to call SCRIPT KILL or SHUTDOWN NOSAVE if needed. For this reason + * we need to mask the client executing the script from the event loop. + * If we don't do that the client may disconnect and could no longer be + * here when the EVAL command will return. */ + aeDeleteFileEvent(server.el, server.lua_caller->fd, AE_READABLE); + } + if (server.lua_timedout) + aeProcessEvents(server.el, AE_FILE_EVENTS|AE_DONT_WAIT); + if (server.lua_kill) { + redisLog(REDIS_WARNING,"Lua script killed by user with SCRIPT KILL."); + lua_pushstring(lua,"Script killed by user with SCRIPT KILL..."); lua_error(lua); } } @@ -287,6 +318,10 @@ void luaLoadLibraries(lua_State *lua) { #endif } +/* Initialize the scripting environment. + * It is possible to call this function to reset the scripting environment + * assuming that we call scriptingRelease() before. + * See scriptingReset() for more information. */ void scriptingInit(void) { lua_State *lua = lua_open(); luaLoadLibraries(lua); @@ -301,7 +336,12 @@ void scriptingInit(void) { /* redis.call */ lua_pushstring(lua,"call"); - lua_pushcfunction(lua,luaRedisCommand); + lua_pushcfunction(lua,luaRedisCallCommand); + lua_settable(lua,-3); + + /* redis.pcall */ + lua_pushstring(lua,"pcall"); + lua_pushcfunction(lua,luaRedisPCallCommand); lua_settable(lua,-3); /* redis.log and log levels. */ @@ -342,13 +382,29 @@ void scriptingInit(void) { lua_setglobal(lua,"math"); /* Create the (non connected) client that we use to execute Redis commands - * inside the Lua interpreter */ - server.lua_client = createClient(-1); - server.lua_client->flags |= REDIS_LUA_CLIENT; + * inside the Lua interpreter. + * Note: there is no need to create it again when this function is called + * by scriptingReset(). */ + if (server.lua_client == NULL) { + server.lua_client = createClient(-1); + server.lua_client->flags |= REDIS_LUA_CLIENT; + } server.lua = lua; } +/* Release resources related to Lua scripting. + * This function is used in order to reset the scripting environment. */ +void scriptingRelease(void) { + dictRelease(server.lua_scripts); + lua_close(server.lua); +} + +void scriptingReset(void) { + scriptingRelease(); + scriptingInit(); +} + /* Hash the scripit into a SHA1 digest. We use this as Lua function name. * Digest should point to a 41 bytes buffer: 40 for SHA1 converted into an * hexadecimal number, plus 1 byte for null term. */ @@ -446,6 +502,51 @@ void luaSetGlobalArray(lua_State *lua, char *var, robj **elev, int elec) { lua_setglobal(lua,var); } +/* Define a lua function with the specified function name and body. + * The function name musts be a 2 characters long string, since all the + * functions we defined in the Lua context are in the form: + * + * f_ + * + * On success REDIS_OK is returned, and nothing is left on the Lua stack. + * On error REDIS_ERR is returned and an appropriate error is set in the + * client context. */ +int luaCreateFunction(redisClient *c, lua_State *lua, char *funcname, robj *body) { + sds funcdef = sdsempty(); + + funcdef = sdscat(funcdef,"function "); + funcdef = sdscatlen(funcdef,funcname,42); + funcdef = sdscatlen(funcdef," ()\n",4); + funcdef = sdscatlen(funcdef,body->ptr,sdslen(body->ptr)); + funcdef = sdscatlen(funcdef,"\nend\n",5); + + if (luaL_loadbuffer(lua,funcdef,sdslen(funcdef),"func definition")) { + addReplyErrorFormat(c,"Error compiling script (new function): %s\n", + lua_tostring(lua,-1)); + lua_pop(lua,1); + sdsfree(funcdef); + return REDIS_ERR; + } + sdsfree(funcdef); + if (lua_pcall(lua,0,0,0)) { + addReplyErrorFormat(c,"Error running script (new function): %s\n", + lua_tostring(lua,-1)); + lua_pop(lua,1); + return REDIS_ERR; + } + + /* We also save a SHA1 -> Original script map in a dictionary + * so that we can replicate / write in the AOF all the + * EVALSHA commands as EVAL using the original script. */ + { + int retval = dictAdd(server.lua_scripts, + sdsnewlen(funcname+2,40),body); + redisAssertWithInfo(c,NULL,retval == DICT_OK); + incrRefCount(body); + } + return REDIS_OK; +} + void evalGenericCommand(redisClient *c, int evalsha) { lua_State *lua = server.lua; char funcname[43]; @@ -464,6 +565,7 @@ void evalGenericCommand(redisClient *c, int evalsha) { * Thanks to this flag we'll raise an error every time a write command * is called after a random command was used. */ server.lua_random_dirty = 0; + server.lua_write_dirty = 0; /* Get the number of arguments that are keys */ if (getLongLongFromObjectOrReply(c,c->argv[2],&numkeys,NULL) != REDIS_OK) @@ -490,53 +592,21 @@ void evalGenericCommand(redisClient *c, int evalsha) { funcname[42] = '\0'; } + /* Try to lookup the Lua function */ lua_getglobal(lua, funcname); if (lua_isnil(lua,1)) { - sds funcdef; - + lua_pop(lua,1); /* remove the nil from the stack */ /* Function not defined... let's define it if we have the * body of the funciton. If this is an EVALSHA call we can just * return an error. */ if (evalsha) { addReply(c, shared.noscripterr); - lua_pop(lua,1); /* remove the nil from the stack */ - return; - } - funcdef = sdsempty(); - - lua_pop(lua,1); /* remove the nil from the stack */ - funcdef = sdscat(funcdef,"function "); - funcdef = sdscatlen(funcdef,funcname,42); - funcdef = sdscatlen(funcdef," ()\n",4); - funcdef = sdscatlen(funcdef,c->argv[1]->ptr,sdslen(c->argv[1]->ptr)); - funcdef = sdscatlen(funcdef,"\nend\n",5); - /* printf("Defining:\n%s\n",funcdef); */ - - if (luaL_loadbuffer(lua,funcdef,sdslen(funcdef),"func definition")) { - addReplyErrorFormat(c,"Error compiling script (new function): %s\n", - lua_tostring(lua,-1)); - lua_pop(lua,1); - sdsfree(funcdef); - return; - } - sdsfree(funcdef); - if (lua_pcall(lua,0,0,0)) { - addReplyErrorFormat(c,"Error running script (new function): %s\n", - lua_tostring(lua,-1)); - lua_pop(lua,1); return; } + if (luaCreateFunction(c,lua,funcname,c->argv[1]) == REDIS_ERR) return; + /* Now the following is guaranteed to return non nil */ lua_getglobal(lua, funcname); - - /* We also save a SHA1 -> Original script map in a dictionary - * so that we can replicate / write in the AOF all the - * EVALSHA commands as EVAL using the original script. */ - { - int retval = dictAdd(server.lua_scripts, - sdsnewlen(funcname+2,40),c->argv[1]); - redisAssertWithInfo(c,NULL,retval == DICT_OK); - incrRefCount(c->argv[1]); - } + redisAssert(!lua_isnil(lua,1)); } /* Populate the argv and keys table accordingly to the arguments that @@ -551,9 +621,8 @@ void evalGenericCommand(redisClient *c, int evalsha) { * is running for too much time. * We set the hook only if the time limit is enabled as the hook will * make the Lua script execution slower. */ - if (server.lua_time_limit > 0) { + if (server.lua_time_limit > 0 && server.masterhost == NULL) { lua_sethook(lua,luaMaskCountHook,LUA_MASKCOUNT,100000); - server.lua_time_start = ustime()/1000; } else { lua_sethook(lua,luaMaskCountHook,0,0); } @@ -561,7 +630,18 @@ void evalGenericCommand(redisClient *c, int evalsha) { /* At this point whatever this script was never seen before or if it was * already defined, we can call it. We have zero arguments and expect * a single return value. */ + server.lua_caller = c; + server.lua_time_start = ustime()/1000; + server.lua_kill = 0; if (lua_pcall(lua,0,1,0)) { + if (server.lua_timedout) { + server.lua_timedout = 0; + /* Restore the readable handler that was unregistered when the + * script timeout was detected. */ + aeCreateFileEvent(server.el,c->fd,AE_READABLE, + readQueryFromClient,c); + } + server.lua_caller = NULL; selectDb(c,server.lua_client->db->id); /* set DB ID from Lua client */ addReplyErrorFormat(c,"Error running script (call to %s): %s\n", funcname, lua_tostring(lua,-1)); @@ -569,6 +649,8 @@ void evalGenericCommand(redisClient *c, int evalsha) { lua_gc(lua,LUA_GCCOLLECT,0); return; } + server.lua_timedout = 0; + server.lua_caller = NULL; selectDb(c,server.lua_client->db->id); /* set DB ID from Lua client */ luaReplyToRedisReply(c,lua); lua_gc(lua,LUA_GCSTEP,1); @@ -647,3 +729,53 @@ int redis_math_randomseed (lua_State *L) { redisSrand48(luaL_checkint(L, 1)); return 0; } + +/* --------------------------------------------------------------------------- + * SCRIPT command for script environment introspection and control + * ------------------------------------------------------------------------- */ + +void scriptCommand(redisClient *c) { + if (c->argc == 2 && !strcasecmp(c->argv[1]->ptr,"flush")) { + scriptingReset(); + addReply(c,shared.ok); + server.dirty++; /* Replicating this command is a good idea. */ + } else if (c->argc >= 2 && !strcasecmp(c->argv[1]->ptr,"exists")) { + int j; + + addReplyMultiBulkLen(c, c->argc-2); + for (j = 2; j < c->argc; j++) { + if (dictFind(server.lua_scripts,c->argv[j]->ptr)) + addReply(c,shared.cone); + else + addReply(c,shared.czero); + } + } else if (c->argc == 3 && !strcasecmp(c->argv[1]->ptr,"load")) { + char funcname[43]; + sds sha; + + funcname[0] = 'f'; + funcname[1] = '_'; + hashScript(funcname+2,c->argv[2]->ptr,sdslen(c->argv[2]->ptr)); + sha = sdsnewlen(funcname+2,40); + if (dictFind(server.lua_scripts,sha) == NULL) { + if (luaCreateFunction(c,server.lua,funcname,c->argv[2]) + == REDIS_ERR) { + sdsfree(sha); + return; + } + } + addReplyBulkCBuffer(c,funcname+2,40); + sdsfree(sha); + } else if (c->argc == 2 && !strcasecmp(c->argv[1]->ptr,"kill")) { + if (server.lua_caller == NULL) { + addReplyError(c,"No scripts in execution right now."); + } else if (server.lua_write_dirty) { + addReplyError(c, "Sorry the script already executed write commands against the dataset. You can either wait the script termination or kill the server in an hard way using the SHUTDOWN NOSAVE command."); + } else { + server.lua_kill = 1; + addReply(c,shared.ok); + } + } else { + addReplyError(c, "Unknown SCRIPT subcommand or wrong # of args."); + } +}