From 027775ff22993b03886f3bcc002e9c257ad09c02 Mon Sep 17 00:00:00 2001
From: Sergey Kaplun <skaplun@tarantool.org>
Date: Fri, 18 Jun 2021 18:28:30 +0300
Subject: [PATCH] lua: refactor port_lua_do_dump and encode_lua_call
The old code flow was the following:
1) `struct port_lua` given to `port_lua_do_dump()` has Lua stack with
arguments to encode to MessagePack.
2) The main coroutine `tarantool_L` is used to call `encode_lua_call()`
or `encode_lua_call_16`() via `lua_cpcall()`.
3) Objects on port coroutine are encoded via `luamp_encode()` or
`luamp_encode_call16()`.
4) This encoding may raise an error on unprotected `port->L` coroutine.
This coroutine has no protected frame on it and this call should fail
in pure Lua.
Calling anything on unprotected coroutine is not allowed in Lua [1]:
| If an error happens outside any protected environment, Lua calls a
| panic function
Lua 5.1 sets protection only for specific lua_State [2] and calls a
panic function if we raise an error on unprotected lua_State [3].
Nevertheless, no panic occurs now due to two facts:
* The first one is LuaJIT's support of C++ exception handling [4] that
allows to raise an error in Lua and catch it in C++ or vice versa. But
documentation still doesn't allow raising errors on unprotected
coroutines (at least we must use try-catch block).
* The second one is the patch made in LuaJIT to restore currently
executed coroutine, when C function or fast function raises an
error [5][6] (see the related issue here [7][8]).
For these reasons, when an error occurs, the unwinder searches and finds
the C-protected stack frame from the `lua_cpcall()` for `tarantool_L`
coroutine and unwinds until that point (without aforementioned patches
LuaJIT just calls a panic function and exits).
If an error is raised, and `lua_cpcall()` returns not `LUA_OK`, then the
error from `port->L` coroutine is converted into a Tarantool error and a
diagnostic is set.
Such auxiliary usage of `tarantool_L` is not idiomatic for Lua.
Internal unwinder used on M1 is not such flexible, so such misuse leads
to panic call. Also the `tarantool_L` usage is redundant. So this patch
drops it and uses only port coroutine instead with `lua_pcall()`.
Functions to encode are saved to the `LUA_REGISTRY` table to
reduce GC pressure, like it is done for other handlers [9].
[1]: https://www.lua.org/manual/5.2/manual.html#4.6
[2]: https://www.lua.org/source/5.1/lstate.h.html#lua_State
[3]: https://www.lua.org/source/5.1/ldo.c.html#luaD_throw
[4]: https://luajit.org/extensions.html#exceptions
[5]: https://github.com/tarantool/luajit/commit/ed412cd9f55fe87fd32a69c86e1732690fc5c1b0
[6]: https://github.com/tarantool/luajit/commit/97699d9ee2467389b6aea21a098e38aff3469b5f
[7]: https://github.com/tarantool/tarantool/issues/1516
[8]: https://www.freelists.org/post/luajit/Issue-with-PCALL-in-21
[9]: https://github.com/tarantool/tarantool/commit/e88c0d21ab765d4c53bed2437c49d77b3ffe4216
Closes #6248
Closes #4617
Reviewed-by: Vladislav Shpilevoy <v.shpilevoy@tarantool.org>
Reviewed-by: Igor Munkin <imun@tarantool.org>
Signed-off-by: Igor Munkin <imun@tarantool.org>
---
src/box/lua/call.c | 71 ++++++++++++++++++++++++++++++++++++----------
1 file changed, 56 insertions(+), 15 deletions(-)
diff --git a/src/box/lua/call.c b/src/box/lua/call.c
index d42b54d42c..8c53336e65 100644
--- a/src/box/lua/call.c
+++ b/src/box/lua/call.c
@@ -61,6 +61,8 @@
enum handlers {
HANDLER_CALL,
HANDLER_CALL_BY_REF,
+ HANDLER_ENCODE_CALL,
+ HANDLER_ENCODE_CALL_16,
HANDLER_EVAL,
HANDLER_MAX,
};
@@ -401,11 +403,26 @@ struct encode_lua_ctx {
struct mpstream *stream;
};
+/**
+ * Encode call results to msgpack from Lua stack.
+ * Lua stack has the following structure -- the last element is
+ * lightuserdata pointer to encode_lua_ctx, all other values are
+ * arguments to process.
+ * The function encodes all given Lua objects to msgpack stream
+ * from context, sets port's size and returns no value on the Lua
+ * stack.
+ * XXX: This function *MUST* be called under lua_pcall(), because
+ * luamp_encode() may raise an error.
+ */
static int
encode_lua_call(lua_State *L)
{
+ assert(lua_islightuserdata(L, -1));
struct encode_lua_ctx *ctx =
- (struct encode_lua_ctx *) lua_topointer(L, 1);
+ (struct encode_lua_ctx *) lua_topointer(L, -1);
+ assert(ctx->port->L == L);
+ /* Delete ctx from the stack. */
+ lua_pop(L, 1);
/*
* Add all elements from Lua stack to the buffer.
*
@@ -414,33 +431,48 @@ encode_lua_call(lua_State *L)
struct luaL_serializer *cfg = luaL_msgpack_default;
const struct serializer_opts *opts =
¤t_session()->meta.serializer_opts;
- int size = lua_gettop(ctx->port->L);
+ const int size = lua_gettop(L);
for (int i = 1; i <= size; ++i)
- luamp_encode(ctx->port->L, cfg, opts, ctx->stream, i);
+ luamp_encode(L, cfg, opts, ctx->stream, i);
ctx->port->size = size;
mpstream_flush(ctx->stream);
return 0;
}
+/**
+ * Encode call_16 results to msgpack from Lua stack.
+ * Lua stack has the following structure -- the last element is
+ * lightuserdata pointer to encode_lua_ctx, all other values are
+ * arguments to process.
+ * The function encodes all given Lua objects to msgpack stream
+ * from context, sets port's size and returns no value on the Lua
+ * stack.
+ * XXX: This function *MUST* be called under lua_pcall(), because
+ * luamp_encode() may raise an error.
+ */
static int
encode_lua_call_16(lua_State *L)
{
+ assert(lua_islightuserdata(L, -1));
struct encode_lua_ctx *ctx =
- (struct encode_lua_ctx *) lua_topointer(L, 1);
+ (struct encode_lua_ctx *) lua_topointer(L, -1);
+ assert(ctx->port->L == L);
+ /* Delete ctx from the stack. */
+ lua_pop(L, 1);
/*
* Add all elements from Lua stack to the buffer.
*
* TODO: forbid explicit yield from __serialize or __index here
*/
struct luaL_serializer *cfg = luaL_msgpack_default;
- ctx->port->size = luamp_encode_call_16(ctx->port->L, cfg, ctx->stream);
+ ctx->port->size = luamp_encode_call_16(L, cfg, ctx->stream);
mpstream_flush(ctx->stream);
return 0;
}
static inline int
port_lua_do_dump(struct port *base, struct mpstream *stream,
- lua_CFunction handler)
+ enum handlers handler)
{
struct port_lua *port = (struct port_lua *) base;
assert(port->vtab == &port_lua_vtab);
@@ -451,13 +483,20 @@ port_lua_do_dump(struct port *base, struct mpstream *stream,
struct encode_lua_ctx ctx;
ctx.port = port;
ctx.stream = stream;
- struct lua_State *L = tarantool_L;
- int top = lua_gettop(L);
- if (lua_cpcall(L, handler, &ctx) != 0) {
- luaT_toerror(port->L);
+ lua_State *L = port->L;
+ /*
+ * At the moment Lua stack holds only values to encode.
+ * Insert corresponding encoder to the bottom and push
+ * encode context as lightuserdata to the top.
+ */
+ const int size = lua_gettop(L);
+ lua_rawgeti(L, LUA_REGISTRYINDEX, execute_lua_refs[handler]);
+ assert(lua_isfunction(L, -1) && lua_iscfunction(L, -1));
+ lua_insert(L, 1);
+ lua_pushlightuserdata(L, &ctx);
+ /* nargs -- all arguments + lightuserdata. */
+ if (luaT_call(L, size + 1, 0) != 0)
return -1;
- }
- lua_settop(L, top);
return port->size;
}
@@ -468,7 +507,7 @@ port_lua_dump(struct port *base, struct obuf *out)
struct mpstream stream;
mpstream_init(&stream, out, obuf_reserve_cb, obuf_alloc_cb,
luamp_error, port->L);
- return port_lua_do_dump(base, &stream, encode_lua_call);
+ return port_lua_do_dump(base, &stream, HANDLER_ENCODE_CALL);
}
static int
@@ -478,7 +517,7 @@ port_lua_dump_16(struct port *base, struct obuf *out)
struct mpstream stream;
mpstream_init(&stream, out, obuf_reserve_cb, obuf_alloc_cb,
luamp_error, port->L);
- return port_lua_do_dump(base, &stream, encode_lua_call_16);
+ return port_lua_do_dump(base, &stream, HANDLER_ENCODE_CALL_16);
}
static void
@@ -502,7 +541,7 @@ port_lua_get_msgpack(struct port *base, uint32_t *size)
mpstream_init(&stream, region, region_reserve_cb, region_alloc_cb,
luamp_error, port->L);
mpstream_encode_array(&stream, lua_gettop(port->L));
- int rc = port_lua_do_dump(base, &stream, encode_lua_call);
+ int rc = port_lua_do_dump(base, &stream, HANDLER_ENCODE_CALL);
if (rc < 0) {
region_truncate(region, region_svp);
return NULL;
@@ -1049,6 +1088,8 @@ box_lua_call_init(struct lua_State *L)
lua_CFunction handles[] = {
[HANDLER_CALL] = execute_lua_call,
[HANDLER_CALL_BY_REF] = execute_lua_call_by_ref,
+ [HANDLER_ENCODE_CALL] = encode_lua_call,
+ [HANDLER_ENCODE_CALL_16] = encode_lua_call_16,
[HANDLER_EVAL] = execute_lua_eval,
};
--
GitLab