]> git.saurik.com Git - redis.git/blame - src/scripting.c
Protect globals access in Lua scripting.
[redis.git] / src / scripting.c
CommitLineData
7585836e 1#include "redis.h"
2#include "sha1.h"
e108bab0 3#include "rand.h"
7585836e 4
5#include <lua.h>
6#include <lauxlib.h>
7#include <lualib.h>
7229d60d 8#include <ctype.h>
e108bab0 9#include <math.h>
7585836e 10
532e0f5d 11char *redisProtocolToLuaType_Int(lua_State *lua, char *reply);
12char *redisProtocolToLuaType_Bulk(lua_State *lua, char *reply);
13char *redisProtocolToLuaType_Status(lua_State *lua, char *reply);
3791000f 14char *redisProtocolToLuaType_Error(lua_State *lua, char *reply);
15char *redisProtocolToLuaType_MultiBulk(lua_State *lua, char *reply);
e108bab0 16int redis_math_random (lua_State *L);
17int redis_math_randomseed (lua_State *L);
52ae8af8 18void sha1hex(char *digest, char *script, size_t len);
532e0f5d 19
20/* Take a Redis reply in the Redis protocol format and convert it into a
21 * Lua type. Thanks to this function, and the introduction of not connected
22 * clients, it is trvial to implement the redis() lua function.
23 *
24 * Basically we take the arguments, execute the Redis command in the context
25 * of a non connected client, then take the generated reply and convert it
26 * into a suitable Lua type. With this trick the scripting feature does not
27 * need the introduction of a full Redis internals API. Basically the script
28 * is like a normal client that bypasses all the slow I/O paths.
29 *
30 * Note: in this function we do not do any sanity check as the reply is
548efd91 31 * generated by Redis directly. This allows us to go faster.
532e0f5d 32 * The reply string can be altered during the parsing as it is discared
33 * after the conversion is completed.
34 *
35 * Errors are returned as a table with a single 'err' field set to the
36 * error string.
37 */
38
39char *redisProtocolToLuaType(lua_State *lua, char* reply) {
40 char *p = reply;
41
42 switch(*p) {
43 case ':':
44 p = redisProtocolToLuaType_Int(lua,reply);
45 break;
46 case '$':
47 p = redisProtocolToLuaType_Bulk(lua,reply);
48 break;
49 case '+':
50 p = redisProtocolToLuaType_Status(lua,reply);
51 break;
3791000f 52 case '-':
53 p = redisProtocolToLuaType_Error(lua,reply);
54 break;
55 case '*':
56 p = redisProtocolToLuaType_MultiBulk(lua,reply);
57 break;
532e0f5d 58 }
59 return p;
60}
61
62char *redisProtocolToLuaType_Int(lua_State *lua, char *reply) {
63 char *p = strchr(reply+1,'\r');
64 long long value;
65
66 string2ll(reply+1,p-reply-1,&value);
67 lua_pushnumber(lua,(lua_Number)value);
68 return p+2;
69}
70
71char *redisProtocolToLuaType_Bulk(lua_State *lua, char *reply) {
72 char *p = strchr(reply+1,'\r');
73 long long bulklen;
74
75 string2ll(reply+1,p-reply-1,&bulklen);
379789cc 76 if (bulklen == -1) {
82c6b825 77 lua_pushboolean(lua,0);
532e0f5d 78 return p+2;
79 } else {
80 lua_pushlstring(lua,p+2,bulklen);
81 return p+2+bulklen+2;
82 }
83}
84
85char *redisProtocolToLuaType_Status(lua_State *lua, char *reply) {
86 char *p = strchr(reply+1,'\r');
87
0d916763 88 lua_newtable(lua);
89 lua_pushstring(lua,"ok");
532e0f5d 90 lua_pushlstring(lua,reply+1,p-reply-1);
0d916763 91 lua_settable(lua,-3);
532e0f5d 92 return p+2;
93}
94
3791000f 95char *redisProtocolToLuaType_Error(lua_State *lua, char *reply) {
96 char *p = strchr(reply+1,'\r');
97
98 lua_newtable(lua);
99 lua_pushstring(lua,"err");
100 lua_pushlstring(lua,reply+1,p-reply-1);
101 lua_settable(lua,-3);
102 return p+2;
103}
104
105char *redisProtocolToLuaType_MultiBulk(lua_State *lua, char *reply) {
106 char *p = strchr(reply+1,'\r');
107 long long mbulklen;
108 int j = 0;
109
3791000f 110 string2ll(reply+1,p-reply-1,&mbulklen);
111 p += 2;
112 if (mbulklen == -1) {
82c6b825 113 lua_pushboolean(lua,0);
3791000f 114 return p;
115 }
3791000f 116 lua_newtable(lua);
117 for (j = 0; j < mbulklen; j++) {
10a6da7a 118 lua_pushnumber(lua,j+1);
3791000f 119 p = redisProtocolToLuaType(lua,p);
120 lua_settable(lua,-3);
121 }
122 return p;
123}
124
379789cc 125void luaPushError(lua_State *lua, char *error) {
126 lua_newtable(lua);
127 lua_pushstring(lua,"err");
128 lua_pushstring(lua, error);
129 lua_settable(lua,-3);
130}
131
548efd91 132/* Sort the array currently in the stack. We do this to make the output
133 * of commands like KEYS or SMEMBERS something deterministic when called
134 * from Lua (to play well with AOf/replication).
135 *
136 * The array is sorted using table.sort itself, and assuming all the
137 * list elements are strings. */
138void luaSortArray(lua_State *lua) {
139 /* Initial Stack: array */
140 lua_getglobal(lua,"table");
141 lua_pushstring(lua,"sort");
142 lua_gettable(lua,-2); /* Stack: array, table, table.sort */
143 lua_pushvalue(lua,-3); /* Stack: array, table, table.sort, array */
2c861050 144 if (lua_pcall(lua,1,0,0)) {
145 /* Stack: array, table, error */
146
147 /* We are not interested in the error, we assume that the problem is
148 * that there are 'false' elements inside the array, so we try
149 * again with a slower function but able to handle this case, that
150 * is: table.sort(table, __redis__compare_helper) */
151 lua_pop(lua,1); /* Stack: array, table */
152 lua_pushstring(lua,"sort"); /* Stack: array, table, sort */
153 lua_gettable(lua,-2); /* Stack: array, table, table.sort */
154 lua_pushvalue(lua,-3); /* Stack: array, table, table.sort, array */
155 lua_getglobal(lua,"__redis__compare_helper");
156 /* Stack: array, table, table.sort, array, __redis__compare_helper */
157 lua_call(lua,2,0);
158 }
159 /* Stack: array (sorted), table */
548efd91 160 lua_pop(lua,1); /* Stack: array (sorted) */
161}
162
9ed32ba0 163int luaRedisGenericCommand(lua_State *lua, int raise_error) {
0f1d64ca 164 int j, argc = lua_gettop(lua);
165 struct redisCommand *cmd;
166 robj **argv;
167 redisClient *c = server.lua_client;
168 sds reply;
169
532e0f5d 170 /* Build the arguments vector */
0f1d64ca 171 argv = zmalloc(sizeof(robj*)*argc);
379789cc 172 for (j = 0; j < argc; j++) {
173 if (!lua_isstring(lua,j+1)) break;
532e0f5d 174 argv[j] = createStringObject((char*)lua_tostring(lua,j+1),
175 lua_strlen(lua,j+1));
379789cc 176 }
177
178 /* Check if one of the arguments passed by the Lua script
179 * is not a string or an integer (lua_isstring() return true for
180 * integers as well). */
181 if (j != argc) {
182 j--;
183 while (j >= 0) {
184 decrRefCount(argv[j]);
185 j--;
186 }
187 zfree(argv);
188 luaPushError(lua,
189 "Lua redis() command arguments must be strings or integers");
190 return 1;
191 }
0f1d64ca 192
15ef6053 193 /* Setup our fake client for command execution */
194 c->argv = argv;
195 c->argc = argc;
196
0f1d64ca 197 /* Command lookup */
198 cmd = lookupCommand(argv[0]->ptr);
3791000f 199 if (!cmd || ((cmd->arity > 0 && cmd->arity != argc) ||
200 (argc < -cmd->arity)))
201 {
3791000f 202 if (cmd)
379789cc 203 luaPushError(lua,
3791000f 204 "Wrong number of args calling Redis command From Lua script");
205 else
379789cc 206 luaPushError(lua,"Unknown Redis command called from Lua script");
15ef6053 207 goto cleanup;
0f1d64ca 208 }
532e0f5d 209
f3fd419f 210 /* There are commands that are not allowed inside scripts. */
15ef6053 211 if (cmd->flags & REDIS_CMD_NOSCRIPT) {
212 luaPushError(lua, "This Redis command is not allowed from scripts");
213 goto cleanup;
214 }
215
f3fd419f 216 /* Write commands are forbidden against read-only slaves, or if a
217 * command marked as non-deterministic was already called in the context
218 * of this script. */
219 if (cmd->flags & REDIS_CMD_WRITE) {
220 if (server.lua_random_dirty) {
221 luaPushError(lua,
222 "Write commands not allowed after non deterministic commands");
223 goto cleanup;
224 } else if (server.masterhost && server.repl_slave_ro &&
225 !(server.lua_caller->flags & REDIS_MASTER))
226 {
227 luaPushError(lua, shared.roslaveerr->ptr);
228 goto cleanup;
229 } else if (server.stop_writes_on_bgsave_err &&
230 server.saveparamslen > 0 &&
231 server.lastbgsave_status == REDIS_ERR)
232 {
233 luaPushError(lua, shared.bgsaveerr->ptr);
234 goto cleanup;
235 }
236 }
237
238 /* If we reached the memory limit configured via maxmemory, commands that
239 * could enlarge the memory usage are not allowed, but only if this is the
240 * first write in the context of this script, otherwise we can't stop
241 * in the middle. */
242 if (server.maxmemory && server.lua_write_dirty == 0 &&
243 (cmd->flags & REDIS_CMD_DENYOOM))
244 {
245 if (freeMemoryIfNeeded() == REDIS_ERR) {
246 luaPushError(lua, shared.oomerr->ptr);
247 goto cleanup;
248 }
9f772cc2 249 }
250
251 if (cmd->flags & REDIS_CMD_RANDOM) server.lua_random_dirty = 1;
4ab8695d 252 if (cmd->flags & REDIS_CMD_WRITE) server.lua_write_dirty = 1;
9f772cc2 253
15ef6053 254 /* Run the command */
ce8b772b 255 c->cmd = cmd;
256 call(c,REDIS_CALL_SLOWLOG | REDIS_CALL_STATS);
0f1d64ca 257
258 /* Convert the result of the Redis command into a suitable Lua type.
259 * The first thing we need is to create a single string from the client
260 * output buffers. */
261 reply = sdsempty();
262 if (c->bufpos) {
7156f43c 263 reply = sdscatlen(reply,c->buf,c->bufpos);
0f1d64ca 264 c->bufpos = 0;
265 }
266 while(listLength(c->reply)) {
267 robj *o = listNodeValue(listFirst(c->reply));
268
09ab5591 269 reply = sdscatlen(reply,o->ptr,sdslen(o->ptr));
0f1d64ca 270 listDelNode(c->reply,listFirst(c->reply));
271 }
9ed32ba0 272 if (raise_error && reply[0] != '-') raise_error = 0;
532e0f5d 273 redisProtocolToLuaType(lua,reply);
548efd91 274 /* Sort the output array if needed, assuming it is a non-null multi bulk
275 * reply as expected. */
276 if ((cmd->flags & REDIS_CMD_SORT_FOR_SCRIPT) &&
277 (reply[0] == '*' && reply[1] != '-')) {
2c861050 278 /* Skip this step if command is SORT but output was already sorted */
279 if (cmd->proc != sortCommand || server.sort_dontsort)
280 luaSortArray(lua);
548efd91 281 }
7156f43c 282 sdsfree(reply);
0f1d64ca 283
15ef6053 284cleanup:
0f1d64ca 285 /* Clean up. Command code may have changed argv/argc so we use the
286 * argv/argc of the client instead of the local variables. */
287 for (j = 0; j < c->argc; j++)
288 decrRefCount(c->argv[j]);
289 zfree(c->argv);
290
9ed32ba0 291 if (raise_error) {
292 /* If we are here we should have an error in the stack, in the
293 * form of a table with an "err" field. Extract the string to
294 * return the plain error. */
295 lua_pushstring(lua,"err");
296 lua_gettable(lua,-2);
297 return lua_error(lua);
298 }
0f1d64ca 299 return 1;
300}
301
9ed32ba0 302int luaRedisCallCommand(lua_State *lua) {
303 return luaRedisGenericCommand(lua,1);
304}
305
306int luaRedisPCallCommand(lua_State *lua) {
307 return luaRedisGenericCommand(lua,0);
308}
309
52ae8af8
NF
310/* This adds redis.sha1hex(string) to Lua scripts using the same hashing
311 * function used for sha1ing lua scripts. */
312int luaRedisSha1hexCommand(lua_State *lua) {
313 int argc = lua_gettop(lua);
314 char digest[41];
315 size_t len;
316 char *s;
317
318 if (argc != 1) {
319 luaPushError(lua, "wrong number of arguments");
320 return 1;
321 }
322
323 s = (char*)lua_tolstring(lua,1,&len);
324 sha1hex(digest,s,len);
325 lua_pushstring(lua,digest);
326 return 1;
327}
328
288f811f 329int luaLogCommand(lua_State *lua) {
330 int j, argc = lua_gettop(lua);
331 int level;
332 sds log;
333
334 if (argc < 2) {
335 luaPushError(lua, "redis.log() requires two arguments or more.");
336 return 1;
337 } else if (!lua_isnumber(lua,-argc)) {
e927a246 338 luaPushError(lua, "First argument must be a number (log level).");
288f811f 339 return 1;
340 }
341 level = lua_tonumber(lua,-argc);
e927a246 342 if (level < REDIS_DEBUG || level > REDIS_WARNING) {
288f811f 343 luaPushError(lua, "Invalid debug level.");
344 return 1;
345 }
346
347 /* Glue together all the arguments */
348 log = sdsempty();
349 for (j = 1; j < argc; j++) {
350 size_t len;
351 char *s;
352
353 s = (char*)lua_tolstring(lua,(-argc)+j,&len);
354 if (s) {
355 if (j != 1) log = sdscatlen(log," ",1);
356 log = sdscatlen(log,s,len);
357 }
358 }
359 redisLogRaw(level,log);
360 sdsfree(log);
361 return 0;
362}
363
eeffcf38 364void luaMaskCountHook(lua_State *lua, lua_Debug *ar) {
365 long long elapsed;
366 REDIS_NOTUSED(ar);
115e3ff3 367 REDIS_NOTUSED(lua);
eeffcf38 368
eeffcf38 369 elapsed = (ustime()/1000) - server.lua_time_start;
115e3ff3 370 if (elapsed >= server.lua_time_limit && server.lua_timedout == 0) {
4ab8695d 371 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);
115e3ff3 372 server.lua_timedout = 1;
4ab8695d 373 /* Once the script timeouts we reenter the event loop to permit others
374 * to call SCRIPT KILL or SHUTDOWN NOSAVE if needed. For this reason
375 * we need to mask the client executing the script from the event loop.
376 * If we don't do that the client may disconnect and could no longer be
377 * here when the EVAL command will return. */
378 aeDeleteFileEvent(server.el, server.lua_caller->fd, AE_READABLE);
eeffcf38 379 }
115e3ff3 380 if (server.lua_timedout)
381 aeProcessEvents(server.el, AE_FILE_EVENTS|AE_DONT_WAIT);
4ab8695d 382 if (server.lua_kill) {
383 redisLog(REDIS_WARNING,"Lua script killed by user with SCRIPT KILL.");
384 lua_pushstring(lua,"Script killed by user with SCRIPT KILL...");
385 lua_error(lua);
386 }
eeffcf38 387}
388
002d5626 389void luaLoadLib(lua_State *lua, const char *libname, lua_CFunction luafunc) {
390 lua_pushcfunction(lua, luafunc);
391 lua_pushstring(lua, libname);
392 lua_call(lua, 1, 0);
393}
394
15108778 395LUALIB_API int (luaopen_cjson) (lua_State *L);
2f75bbab 396LUALIB_API int (luaopen_struct) (lua_State *L);
63505e0b 397LUALIB_API int (luaopen_cmsgpack) (lua_State *L);
15108778 398
002d5626 399void luaLoadLibraries(lua_State *lua) {
400 luaLoadLib(lua, "", luaopen_base);
401 luaLoadLib(lua, LUA_TABLIBNAME, luaopen_table);
402 luaLoadLib(lua, LUA_STRLIBNAME, luaopen_string);
403 luaLoadLib(lua, LUA_MATHLIBNAME, luaopen_math);
404 luaLoadLib(lua, LUA_DBLIBNAME, luaopen_debug);
2f75bbab 405 luaLoadLib(lua, "cjson", luaopen_cjson);
406 luaLoadLib(lua, "struct", luaopen_struct);
63505e0b 407 luaLoadLib(lua, "cmsgpack", luaopen_cmsgpack);
002d5626 408
409#if 0 /* Stuff that we don't load currently, for sandboxing concerns. */
410 luaLoadLib(lua, LUA_LOADLIBNAME, luaopen_package);
411 luaLoadLib(lua, LUA_OSLIBNAME, luaopen_os);
412#endif
413}
414
0cdecca1 415void scriptingProtectGlobals(lua_State *lua) {
416 char *s[26];
417 sds code = sdsempty();
418 int j;
419
420 /* strict.lua from: http://metalua.luaforge.net/src/lib/strict.lua.html */
421 s[0]="local mt = getmetatable(_G)\n";
422 s[1]="if mt == nil then\n";
423 s[2]=" mt = {}\n";
424 s[3]=" setmetatable(_G, mt)\n";
425 s[4]="end\n";
426 s[5]="__STRICT = true\n";
427 s[6]="mt.__declared = {}\n";
428 s[7]="mt.__newindex = function (t, n, v)\n";
429 s[8]=" if __STRICT and not mt.__declared[n] and debug.getinfo(2) then\n";
430 s[9]=" local w = debug.getinfo(2, \"S\").what\n";
431 s[10]=" if w ~= \"main\" and w ~= \"C\" then\n";
432 s[11]=" error(\"assign to undeclared global var '\"..n..\"'\", 2)\n";
433 s[12]=" end\n";
434 s[13]=" mt.__declared[n] = true\n";
435 s[14]=" end\n";
436 s[15]=" rawset(t, n, v)\n";
437 s[16]="end\n";
438 s[17]="mt.__index = function (t, n)\n";
439 s[18]=" if debug.getinfo(2) and not mt.__declared[n] and debug.getinfo(2, \"S\").what ~= \"C\" then\n";
440 s[19]=" error(\"global var '\"..n..\"' is not declared\", 2)\n";
441 s[20]=" end\n";
442 s[21]=" return rawget(t, n)\n";
443 s[22]="end\n";
444 s[23]="function global(...)\n";
445 s[24]=" for _, v in ipairs{...} do mt.__declared[v] = true end\n";
446 s[25]="end\n";
447
448 for (j = 0; j < 26; j++) code = sdscatlen(code,s[j],strlen(s[j]));
449 luaL_loadbuffer(lua,code,sdslen(code),"strict_lua");
450 lua_pcall(lua,0,0,0);
451 sdsfree(code);
452}
453
070e3945 454/* Initialize the scripting environment.
455 * It is possible to call this function to reset the scripting environment
456 * assuming that we call scriptingRelease() before.
457 * See scriptingReset() for more information. */
7585836e 458void scriptingInit(void) {
459 lua_State *lua = lua_open();
002d5626 460 luaLoadLibraries(lua);
0f1d64ca 461
4dd444bb 462 /* Initialize a dictionary we use to map SHAs to scripts.
463 * This is useful for replication, as we need to replicate EVALSHA
464 * as EVAL, so we need to remember the associated script. */
465 server.lua_scripts = dictCreate(&dbDictType,NULL);
466
288f811f 467 /* Register the redis commands table and fields */
468 lua_newtable(lua);
469
470 /* redis.call */
471 lua_pushstring(lua,"call");
9ed32ba0 472 lua_pushcfunction(lua,luaRedisCallCommand);
473 lua_settable(lua,-3);
474
475 /* redis.pcall */
476 lua_pushstring(lua,"pcall");
477 lua_pushcfunction(lua,luaRedisPCallCommand);
288f811f 478 lua_settable(lua,-3);
479
480 /* redis.log and log levels. */
481 lua_pushstring(lua,"log");
482 lua_pushcfunction(lua,luaLogCommand);
483 lua_settable(lua,-3);
484
485 lua_pushstring(lua,"LOG_DEBUG");
486 lua_pushnumber(lua,REDIS_DEBUG);
487 lua_settable(lua,-3);
488
489 lua_pushstring(lua,"LOG_VERBOSE");
490 lua_pushnumber(lua,REDIS_VERBOSE);
491 lua_settable(lua,-3);
492
493 lua_pushstring(lua,"LOG_NOTICE");
494 lua_pushnumber(lua,REDIS_NOTICE);
495 lua_settable(lua,-3);
496
497 lua_pushstring(lua,"LOG_WARNING");
498 lua_pushnumber(lua,REDIS_WARNING);
499 lua_settable(lua,-3);
500
52ae8af8
NF
501 /* redis.sha1hex */
502 lua_pushstring(lua, "sha1hex");
503 lua_pushcfunction(lua, luaRedisSha1hexCommand);
504 lua_settable(lua, -3);
505
288f811f 506 /* Finally set the table as 'redis' global var. */
00b7541b 507 lua_setglobal(lua,"redis");
0f1d64ca 508
e108bab0 509 /* Replace math.random and math.randomseed with our implementations. */
510 lua_getglobal(lua,"math");
511
512 lua_pushstring(lua,"random");
513 lua_pushcfunction(lua,redis_math_random);
514 lua_settable(lua,-3);
515
516 lua_pushstring(lua,"randomseed");
517 lua_pushcfunction(lua,redis_math_randomseed);
518 lua_settable(lua,-3);
519
520 lua_setglobal(lua,"math");
521
2c861050 522 /* Add a helper funciton that we use to sort the multi bulk output of non
523 * deterministic commands, when containing 'false' elements. */
524 {
525 char *compare_func = "function __redis__compare_helper(a,b)\n"
526 " if a == false then a = '' end\n"
527 " if b == false then b = '' end\n"
528 " return a<b\n"
529 "end\n";
530 luaL_loadbuffer(lua,compare_func,strlen(compare_func),"cmp_func_def");
531 lua_pcall(lua,0,0,0);
532 }
533
0f1d64ca 534 /* Create the (non connected) client that we use to execute Redis commands
070e3945 535 * inside the Lua interpreter.
536 * Note: there is no need to create it again when this function is called
537 * by scriptingReset(). */
538 if (server.lua_client == NULL) {
539 server.lua_client = createClient(-1);
540 server.lua_client->flags |= REDIS_LUA_CLIENT;
541 }
0f1d64ca 542
0cdecca1 543 /* Lua beginners ofter don't use "local", this is likely to introduce
544 * subtle bugs in their code. To prevent problems we protect accesses
545 * to global variables. */
546 scriptingProtectGlobals(lua);
547
7585836e 548 server.lua = lua;
549}
550
070e3945 551/* Release resources related to Lua scripting.
552 * This function is used in order to reset the scripting environment. */
553void scriptingRelease(void) {
554 dictRelease(server.lua_scripts);
555 lua_close(server.lua);
556}
557
558void scriptingReset(void) {
559 scriptingRelease();
560 scriptingInit();
561}
562
52ae8af8
NF
563/* Perform the SHA1 of the input string. We use this both for hasing script
564 * bodies in order to obtain the Lua function name, and in the implementation
565 * of redis.sha1().
566 *
567 * 'digest' should point to a 41 bytes buffer: 40 for SHA1 converted into an
7585836e 568 * hexadecimal number, plus 1 byte for null term. */
52ae8af8 569void sha1hex(char *digest, char *script, size_t len) {
7585836e 570 SHA1_CTX ctx;
571 unsigned char hash[20];
572 char *cset = "0123456789abcdef";
573 int j;
574
575 SHA1Init(&ctx);
576 SHA1Update(&ctx,(unsigned char*)script,len);
577 SHA1Final(hash,&ctx);
578
579 for (j = 0; j < 20; j++) {
580 digest[j*2] = cset[((hash[j]&0xF0)>>4)];
581 digest[j*2+1] = cset[(hash[j]&0xF)];
582 }
583 digest[40] = '\0';
584}
585
586void luaReplyToRedisReply(redisClient *c, lua_State *lua) {
82c6b825 587 int t = lua_type(lua,-1);
7585836e 588
589 switch(t) {
590 case LUA_TSTRING:
82c6b825 591 addReplyBulkCBuffer(c,(char*)lua_tostring(lua,-1),lua_strlen(lua,-1));
7585836e 592 break;
593 case LUA_TBOOLEAN:
82c6b825 594 addReply(c,lua_toboolean(lua,-1) ? shared.cone : shared.nullbulk);
7585836e 595 break;
596 case LUA_TNUMBER:
82c6b825 597 addReplyLongLong(c,(long long)lua_tonumber(lua,-1));
7585836e 598 break;
532e0f5d 599 case LUA_TTABLE:
0d916763 600 /* We need to check if it is an array, an error, or a status reply.
601 * Error are returned as a single element table with 'err' field.
602 * Status replies are returned as single elment table with 'ok' field */
532e0f5d 603 lua_pushstring(lua,"err");
604 lua_gettable(lua,-2);
605 t = lua_type(lua,-1);
606 if (t == LUA_TSTRING) {
3bb818df 607 sds err = sdsnew(lua_tostring(lua,-1));
608 sdsmapchars(err,"\r\n"," ",2);
609 addReplySds(c,sdscatprintf(sdsempty(),"-%s\r\n",err));
610 sdsfree(err);
0d916763 611 lua_pop(lua,2);
612 return;
613 }
614
615 lua_pop(lua,1);
616 lua_pushstring(lua,"ok");
617 lua_gettable(lua,-2);
618 t = lua_type(lua,-1);
619 if (t == LUA_TSTRING) {
3bb818df 620 sds ok = sdsnew(lua_tostring(lua,-1));
621 sdsmapchars(ok,"\r\n"," ",2);
622 addReplySds(c,sdscatprintf(sdsempty(),"+%s\r\n",ok));
623 sdsfree(ok);
532e0f5d 624 lua_pop(lua,1);
625 } else {
626 void *replylen = addDeferredMultiBulkLength(c);
627 int j = 1, mbulklen = 0;
628
0d916763 629 lua_pop(lua,1); /* Discard the 'ok' field value we popped */
532e0f5d 630 while(1) {
631 lua_pushnumber(lua,j++);
632 lua_gettable(lua,-2);
633 t = lua_type(lua,-1);
634 if (t == LUA_TNIL) {
635 lua_pop(lua,1);
636 break;
532e0f5d 637 }
82c6b825 638 luaReplyToRedisReply(c, lua);
639 mbulklen++;
532e0f5d 640 }
641 setDeferredMultiBulkLength(c,replylen,mbulklen);
642 }
643 break;
7585836e 644 default:
645 addReply(c,shared.nullbulk);
646 }
647 lua_pop(lua,1);
648}
649
4ae5b5e1 650/* Set an array of Redis String Objects as a Lua array (table) stored into a
651 * global variable. */
652void luaSetGlobalArray(lua_State *lua, char *var, robj **elev, int elec) {
653 int j;
654
655 lua_newtable(lua);
656 for (j = 0; j < elec; j++) {
657 lua_pushlstring(lua,(char*)elev[j]->ptr,sdslen(elev[j]->ptr));
658 lua_rawseti(lua,-2,j+1);
659 }
660 lua_setglobal(lua,var);
661}
662
a9b07ac4 663/* Define a lua function with the specified function name and body.
664 * The function name musts be a 2 characters long string, since all the
665 * functions we defined in the Lua context are in the form:
666 *
667 * f_<hex sha1 sum>
668 *
669 * On success REDIS_OK is returned, and nothing is left on the Lua stack.
670 * On error REDIS_ERR is returned and an appropriate error is set in the
671 * client context. */
672int luaCreateFunction(redisClient *c, lua_State *lua, char *funcname, robj *body) {
673 sds funcdef = sdsempty();
674
a9b07ac4 675 funcdef = sdscat(funcdef,"function ");
676 funcdef = sdscatlen(funcdef,funcname,42);
4d776dba 677 funcdef = sdscatlen(funcdef,"() ",3);
a9b07ac4 678 funcdef = sdscatlen(funcdef,body->ptr,sdslen(body->ptr));
4d776dba 679 funcdef = sdscatlen(funcdef," end",4);
a9b07ac4 680
681 if (luaL_loadbuffer(lua,funcdef,sdslen(funcdef),"func definition")) {
682 addReplyErrorFormat(c,"Error compiling script (new function): %s\n",
683 lua_tostring(lua,-1));
684 lua_pop(lua,1);
685 sdsfree(funcdef);
686 return REDIS_ERR;
687 }
688 sdsfree(funcdef);
689 if (lua_pcall(lua,0,0,0)) {
690 addReplyErrorFormat(c,"Error running script (new function): %s\n",
691 lua_tostring(lua,-1));
692 lua_pop(lua,1);
693 return REDIS_ERR;
694 }
695
696 /* We also save a SHA1 -> Original script map in a dictionary
697 * so that we can replicate / write in the AOF all the
698 * EVALSHA commands as EVAL using the original script. */
699 {
700 int retval = dictAdd(server.lua_scripts,
701 sdsnewlen(funcname+2,40),body);
702 redisAssertWithInfo(c,NULL,retval == DICT_OK);
703 incrRefCount(body);
704 }
705 return REDIS_OK;
706}
707
7229d60d 708void evalGenericCommand(redisClient *c, int evalsha) {
7585836e 709 lua_State *lua = server.lua;
710 char funcname[43];
4ae5b5e1 711 long long numkeys;
712
e108bab0 713 /* We want the same PRNG sequence at every call so that our PRNG is
714 * not affected by external state. */
715 redisSrand48(0);
716
9f772cc2 717 /* We set this flag to zero to remember that so far no random command
718 * was called. This way we can allow the user to call commands like
719 * SRANDMEMBER or RANDOMKEY from Lua scripts as far as no write command
720 * is called (otherwise the replication and AOF would end with non
721 * deterministic sequences).
722 *
723 * Thanks to this flag we'll raise an error every time a write command
724 * is called after a random command was used. */
725 server.lua_random_dirty = 0;
4ab8695d 726 server.lua_write_dirty = 0;
9f772cc2 727
4ae5b5e1 728 /* Get the number of arguments that are keys */
729 if (getLongLongFromObjectOrReply(c,c->argv[2],&numkeys,NULL) != REDIS_OK)
730 return;
731 if (numkeys > (c->argc - 3)) {
732 addReplyError(c,"Number of keys can't be greater than number of args");
733 return;
734 }
7585836e 735
736 /* We obtain the script SHA1, then check if this function is already
737 * defined into the Lua state */
738 funcname[0] = 'f';
739 funcname[1] = '_';
7229d60d 740 if (!evalsha) {
741 /* Hash the code if this is an EVAL call */
52ae8af8 742 sha1hex(funcname+2,c->argv[1]->ptr,sdslen(c->argv[1]->ptr));
7229d60d 743 } else {
744 /* We already have the SHA if it is a EVALSHA */
745 int j;
746 char *sha = c->argv[1]->ptr;
747
748 for (j = 0; j < 40; j++)
749 funcname[j+2] = tolower(sha[j]);
750 funcname[42] = '\0';
751 }
752
a9b07ac4 753 /* Try to lookup the Lua function */
7585836e 754 lua_getglobal(lua, funcname);
755 if (lua_isnil(lua,1)) {
e8c993f0 756 lua_pop(lua,1); /* remove the nil from the stack */
7229d60d 757 /* Function not defined... let's define it if we have the
758 * body of the funciton. If this is an EVALSHA call we can just
759 * return an error. */
760 if (evalsha) {
761 addReply(c, shared.noscripterr);
7229d60d 762 return;
763 }
a9b07ac4 764 if (luaCreateFunction(c,lua,funcname,c->argv[1]) == REDIS_ERR) return;
765 /* Now the following is guaranteed to return non nil */
7585836e 766 lua_getglobal(lua, funcname);
a9b07ac4 767 redisAssert(!lua_isnil(lua,1));
7585836e 768 }
4ae5b5e1 769
770 /* Populate the argv and keys table accordingly to the arguments that
771 * EVAL received. */
772 luaSetGlobalArray(lua,"KEYS",c->argv+3,numkeys);
773 luaSetGlobalArray(lua,"ARGV",c->argv+3+numkeys,c->argc-3-numkeys);
c2a7dd85 774
775 /* Select the right DB in the context of the Lua client */
776 selectDb(server.lua_client,c->db->id);
7585836e 777
da386cdf 778 /* Set an hook in order to be able to stop the script execution if it
779 * is running for too much time.
780 * We set the hook only if the time limit is enabled as the hook will
781 * make the Lua script execution slower. */
115e3ff3 782 if (server.lua_time_limit > 0 && server.masterhost == NULL) {
da386cdf 783 lua_sethook(lua,luaMaskCountHook,LUA_MASKCOUNT,100000);
da386cdf 784 } else {
785 lua_sethook(lua,luaMaskCountHook,0,0);
786 }
787
7585836e 788 /* At this point whatever this script was never seen before or if it was
789 * already defined, we can call it. We have zero arguments and expect
790 * a single return value. */
4ab8695d 791 server.lua_caller = c;
792 server.lua_time_start = ustime()/1000;
793 server.lua_kill = 0;
7585836e 794 if (lua_pcall(lua,0,1,0)) {
4ab8695d 795 if (server.lua_timedout) {
796 server.lua_timedout = 0;
797 /* Restore the readable handler that was unregistered when the
798 * script timeout was detected. */
799 aeCreateFileEvent(server.el,c->fd,AE_READABLE,
800 readQueryFromClient,c);
801 }
802 server.lua_caller = NULL;
c2a7dd85 803 selectDb(c,server.lua_client->db->id); /* set DB ID from Lua client */
7585836e 804 addReplyErrorFormat(c,"Error running script (call to %s): %s\n",
805 funcname, lua_tostring(lua,-1));
806 lua_pop(lua,1);
40531be0 807 lua_gc(lua,LUA_GCCOLLECT,0);
7585836e 808 return;
809 }
115e3ff3 810 server.lua_timedout = 0;
4ab8695d 811 server.lua_caller = NULL;
c2a7dd85 812 selectDb(c,server.lua_client->db->id); /* set DB ID from Lua client */
7585836e 813 luaReplyToRedisReply(c,lua);
40531be0 814 lua_gc(lua,LUA_GCSTEP,1);
4dd444bb 815
816 /* If we have slaves attached we want to replicate this command as
817 * EVAL instead of EVALSHA. We do this also in the AOF as currently there
818 * is no easy way to propagate a command in a different way in the AOF
819 * and in the replication link.
820 *
821 * IMPROVEMENT POSSIBLE:
822 * 1) Replicate this command as EVALSHA in the AOF.
823 * 2) Remember what slave already received a given script, and replicate
824 * the EVALSHA against this slaves when possible.
825 */
826 if (evalsha) {
827 robj *script = dictFetchValue(server.lua_scripts,c->argv[1]->ptr);
828
eab0e26e 829 redisAssertWithInfo(c,NULL,script != NULL);
4dd444bb 830 rewriteClientCommandArgument(c,0,
831 resetRefCount(createStringObject("EVAL",4)));
832 rewriteClientCommandArgument(c,1,script);
833 }
7585836e 834}
7229d60d 835
836void evalCommand(redisClient *c) {
837 evalGenericCommand(c,0);
838}
839
840void evalShaCommand(redisClient *c) {
841 if (sdslen(c->argv[1]->ptr) != 40) {
842 /* We know that a match is not possible if the provided SHA is
843 * not the right length. So we return an error ASAP, this way
844 * evalGenericCommand() can be implemented without string length
845 * sanity check */
846 addReply(c, shared.noscripterr);
847 return;
848 }
849 evalGenericCommand(c,1);
850}
e108bab0 851
852/* We replace math.random() with our implementation that is not affected
853 * by specific libc random() implementations and will output the same sequence
854 * (for the same seed) in every arch. */
855
856/* The following implementation is the one shipped with Lua itself but with
857 * rand() replaced by redisLrand48(). */
858int redis_math_random (lua_State *L) {
859 /* the `%' avoids the (rare) case of r==1, and is needed also because on
860 some systems (SunOS!) `rand()' may return a value larger than RAND_MAX */
861 lua_Number r = (lua_Number)(redisLrand48()%REDIS_LRAND48_MAX) /
862 (lua_Number)REDIS_LRAND48_MAX;
863 switch (lua_gettop(L)) { /* check number of arguments */
864 case 0: { /* no arguments */
865 lua_pushnumber(L, r); /* Number between 0 and 1 */
866 break;
867 }
868 case 1: { /* only upper limit */
869 int u = luaL_checkint(L, 1);
870 luaL_argcheck(L, 1<=u, 1, "interval is empty");
871 lua_pushnumber(L, floor(r*u)+1); /* int between 1 and `u' */
872 break;
873 }
874 case 2: { /* lower and upper limits */
875 int l = luaL_checkint(L, 1);
876 int u = luaL_checkint(L, 2);
877 luaL_argcheck(L, l<=u, 2, "interval is empty");
878 lua_pushnumber(L, floor(r*(u-l+1))+l); /* int between `l' and `u' */
879 break;
880 }
881 default: return luaL_error(L, "wrong number of arguments");
882 }
883 return 1;
884}
885
886int redis_math_randomseed (lua_State *L) {
887 redisSrand48(luaL_checkint(L, 1));
888 return 0;
889}
070e3945 890
891/* ---------------------------------------------------------------------------
892 * SCRIPT command for script environment introspection and control
893 * ------------------------------------------------------------------------- */
894
895void scriptCommand(redisClient *c) {
896 if (c->argc == 2 && !strcasecmp(c->argv[1]->ptr,"flush")) {
897 scriptingReset();
898 addReply(c,shared.ok);
899 server.dirty++; /* Replicating this command is a good idea. */
900 } else if (c->argc >= 2 && !strcasecmp(c->argv[1]->ptr,"exists")) {
901 int j;
902
903 addReplyMultiBulkLen(c, c->argc-2);
904 for (j = 2; j < c->argc; j++) {
905 if (dictFind(server.lua_scripts,c->argv[j]->ptr))
906 addReply(c,shared.cone);
907 else
908 addReply(c,shared.czero);
909 }
a9b07ac4 910 } else if (c->argc == 3 && !strcasecmp(c->argv[1]->ptr,"load")) {
a9b07ac4 911 char funcname[43];
e8c993f0 912 sds sha;
a9b07ac4 913
914 funcname[0] = 'f';
915 funcname[1] = '_';
52ae8af8 916 sha1hex(funcname+2,c->argv[2]->ptr,sdslen(c->argv[2]->ptr));
e8c993f0 917 sha = sdsnewlen(funcname+2,40);
918 if (dictFind(server.lua_scripts,sha) == NULL) {
919 if (luaCreateFunction(c,server.lua,funcname,c->argv[2])
920 == REDIS_ERR) {
921 sdsfree(sha);
922 return;
923 }
924 }
e5abf6ef 925 addReplyBulkCBuffer(c,funcname+2,40);
e8c993f0 926 sdsfree(sha);
4ab8695d 927 } else if (c->argc == 2 && !strcasecmp(c->argv[1]->ptr,"kill")) {
928 if (server.lua_caller == NULL) {
929 addReplyError(c,"No scripts in execution right now.");
930 } else if (server.lua_write_dirty) {
931 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.");
932 } else {
933 server.lua_kill = 1;
934 addReply(c,shared.ok);
935 }
070e3945 936 } else {
937 addReplyError(c, "Unknown SCRIPT subcommand or wrong # of args.");
938 }
939}