1 | /* |
2 | * Copyright (c) 2009-2021, Redis Ltd. |
3 | * All rights reserved. |
4 | * |
5 | * Redistribution and use in source and binary forms, with or without |
6 | * modification, are permitted provided that the following conditions are met: |
7 | * |
8 | * * Redistributions of source code must retain the above copyright notice, |
9 | * this list of conditions and the following disclaimer. |
10 | * * Redistributions in binary form must reproduce the above copyright |
11 | * notice, this list of conditions and the following disclaimer in the |
12 | * documentation and/or other materials provided with the distribution. |
13 | * * Neither the name of Redis nor the names of its contributors may be used |
14 | * to endorse or promote products derived from this software without |
15 | * specific prior written permission. |
16 | * |
17 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
18 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
19 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
20 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE |
21 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
22 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
23 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
24 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
25 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
26 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
27 | * POSSIBILITY OF SUCH DAMAGE. |
28 | */ |
29 | |
30 | #ifndef __SCRIPT_LUA_H_ |
31 | #define __SCRIPT_LUA_H_ |
32 | |
33 | /* |
34 | * script_lua.c unit provides shared functionality between |
35 | * eval.c and function_lua.c. Functionality provided: |
36 | * |
37 | * * Execute Lua code, assuming that the code is located on |
38 | * the top of the Lua stack. In addition, parsing the execution |
39 | * result and convert it to the resp and reply ot the client. |
40 | * |
41 | * * Run Redis commands from within the Lua code (Including |
42 | * parsing the reply and create a Lua object out of it). |
43 | * |
44 | * * Register Redis API to the Lua interpreter. Only shared |
45 | * API are registered (API that is only relevant on eval.c |
46 | * (like debugging) are registered on eval.c). |
47 | * |
48 | * Uses script.c for interaction back with Redis. |
49 | */ |
50 | |
51 | #include "server.h" |
52 | #include "script.h" |
53 | #include <lua.h> |
54 | #include <lauxlib.h> |
55 | #include <lualib.h> |
56 | |
57 | #define REGISTRY_RUN_CTX_NAME "__RUN_CTX__" |
58 | #define REGISTRY_SET_GLOBALS_PROTECTION_NAME "__GLOBAL_PROTECTION__" |
59 | #define REDIS_API_NAME "redis" |
60 | |
61 | typedef struct errorInfo { |
62 | sds msg; |
63 | sds source; |
64 | sds line; |
65 | int ignore_err_stats_update; |
66 | }errorInfo; |
67 | |
68 | void luaRegisterRedisAPI(lua_State* lua); |
69 | sds luaGetStringSds(lua_State *lua, int index); |
70 | void luaRegisterGlobalProtectionFunction(lua_State *lua); |
71 | void luaSetErrorMetatable(lua_State *lua); |
72 | void luaSetAllowListProtection(lua_State *lua); |
73 | void luaSetTableProtectionRecursively(lua_State *lua); |
74 | void luaRegisterLogFunction(lua_State* lua); |
75 | void luaRegisterVersion(lua_State* lua); |
76 | void luaPushErrorBuff(lua_State *lua, sds err_buff); |
77 | void luaPushError(lua_State *lua, const char *error); |
78 | int luaError(lua_State *lua); |
79 | void luaSaveOnRegistry(lua_State* lua, const char* name, void* ptr); |
80 | void* luaGetFromRegistry(lua_State* lua, const char* name); |
81 | void luaCallFunction(scriptRunCtx* r_ctx, lua_State *lua, robj** keys, size_t nkeys, robj** args, size_t nargs, int debug_enabled); |
82 | void (lua_State *lua, errorInfo *err_info); |
83 | void luaErrorInformationDiscard(errorInfo *err_info); |
84 | unsigned long luaMemory(lua_State *lua); |
85 | |
86 | |
87 | #endif /* __SCRIPT_LUA_H_ */ |
88 | |