diff --git a/src/box/box.cc b/src/box/box.cc
index ae7f471cd9d5b4eb92132ea1e18e5f6420ea6373..8892d0f0e3e41f19b2650e92d71186b374ca79a3 100644
--- a/src/box/box.cc
+++ b/src/box/box.cc
@@ -80,6 +80,8 @@ static char status[64] = "unknown";
/** box.stat rmean */
struct rmean *rmean_box;
+struct rlist box_on_shutdown = RLIST_HEAD_INITIALIZER(box_on_shutdown);
+
static void title(const char *new_status)
{
snprintf(status, sizeof(status), "%s", new_status);
diff --git a/src/box/box.h b/src/box/box.h
index 6c6c319fc53cdcc3d41e6ae796ad9c88b5f6abb2..53d88ab7176241d720c01a69ce34e99ab1ee98ef 100644
--- a/src/box/box.h
+++ b/src/box/box.h
@@ -64,6 +64,9 @@ struct vclock;
*/
extern const struct vclock *box_vclock;
+/** Invoked on box shutdown. */
+extern struct rlist box_on_shutdown;
+
/*
* Initialize box library
* @throws C++ exception
diff --git a/src/box/lua/ctl.c b/src/box/lua/ctl.c
index 9a105ed5c26b5869b76a0c4f6078b60cf7095310..7010be1387d0b4707d9a0afd643041113628a164 100644
--- a/src/box/lua/ctl.c
+++ b/src/box/lua/ctl.c
@@ -37,6 +37,7 @@
#include <lualib.h>
#include "lua/utils.h"
+#include "lua/trigger.h"
#include "box/box.h"
@@ -64,9 +65,16 @@ lbox_ctl_wait_rw(struct lua_State *L)
return 0;
}
+static int
+lbox_ctl_on_shutdown(struct lua_State *L)
+{
+ return lbox_trigger_reset(L, 2, &box_on_shutdown, NULL, NULL);
+}
+
static const struct luaL_Reg lbox_ctl_lib[] = {
{"wait_ro", lbox_ctl_wait_ro},
{"wait_rw", lbox_ctl_wait_rw},
+ {"on_shutdown", lbox_ctl_on_shutdown},
{NULL, NULL}
};
diff --git a/src/lua/trigger.c b/src/lua/trigger.c
index 2c2ede212141aecfc412b293929ef3d849323712..ec4d8aab334de6895890b61374f76be3cf950567 100644
--- a/src/lua/trigger.c
+++ b/src/lua/trigger.c
@@ -91,7 +91,10 @@ lbox_trigger_run(struct trigger *ptr, void *event)
}
int top = lua_gettop(L);
lua_rawgeti(L, LUA_REGISTRYINDEX, trigger->ref);
- int nargs = trigger->push_event(L, event);
+ int nargs = 0;
+ if (trigger->push_event != NULL) {
+ nargs = trigger->push_event(L, event);
+ }
if (luaT_call(L, nargs, LUA_MULTRET)) {
luaL_unref(tarantool_L, LUA_REGISTRYINDEX, coro_ref);
diag_raise();
diff --git a/src/main.cc b/src/main.cc
index 993355ac40d5d3215e90ae6acd94a60893a79c5c..a3d96843d649e6ccda304c3ed0f79e50b0f70844 100644
--- a/src/main.cc
+++ b/src/main.cc
@@ -89,6 +89,13 @@ static const int ev_sig_count = sizeof(ev_sigs)/sizeof(*ev_sigs);
static double start_time;
+/** A preallocated fiber to run on_shutdown triggers. */
+static struct fiber *on_shutdown_fiber = NULL;
+/** A flag restricting repeated execution of tarantool_exit(). */
+static bool is_shutting_down = false;
+/** A trigger which will break the event loop on shutdown. */
+static struct trigger break_loop_trigger;
+
double
tarantool_uptime(void)
{
@@ -119,9 +126,33 @@ sig_checkpoint(ev_loop * /* loop */, struct ev_signal * /* w */,
fiber_wakeup(f);
}
+static int
+on_shutdown_f(va_list ap)
+{
+ (void) ap;
+ trigger_run(&box_on_shutdown, NULL);
+ return 0;
+}
+
+static void
+tarantool_exit(void)
+{
+ if (is_shutting_down) {
+ /*
+ * We are already running on_shutdown triggers,
+ * and will exit as soon as they'll finish.
+ * Do not execute them twice.
+ */
+ return;
+ }
+ is_shutting_down = true;
+ fiber_call(on_shutdown_fiber);
+}
+
static void
signal_cb(ev_loop *loop, struct ev_signal *w, int revents)
{
+ (void) loop;
(void) w;
(void) revents;
@@ -135,8 +166,7 @@ signal_cb(ev_loop *loop, struct ev_signal *w, int revents)
if (pid_file)
say_crit("got signal %d - %s", w->signum, strsignal(w->signum));
start_loop = false;
- /* Terminate the main event loop */
- ev_break(loop, EVBREAK_ALL);
+ tarantool_exit();
}
static void
@@ -628,6 +658,12 @@ print_help(const char *program)
puts("to see online documentation, submit bugs or contribute a patch.");
}
+static void
+break_loop(struct trigger *, void *)
+{
+ ev_break(loop(), EVBREAK_ALL);
+}
+
int
main(int argc, char **argv)
{
@@ -751,6 +787,26 @@ main(int argc, char **argv)
try {
box_init();
box_lua_init(tarantool_L);
+ /*
+ * Reserve a fiber to run on_shutdown triggers.
+ * Make sure the fiber is non-cancellable so that
+ * it doesn't get woken up from Lua unintentionally.
+ */
+ struct fiber_attr attr;
+ fiber_attr_create(&attr);
+ attr.flags &= ~FIBER_IS_CANCELLABLE;
+ on_shutdown_fiber = fiber_new_ex("on_shutdown",
+ &attr,
+ on_shutdown_f);
+ if (on_shutdown_fiber == NULL)
+ diag_raise();
+ /*
+ * Register a on_shutdown trigger which will break the
+ * main event loop. The trigger will be the last to run
+ * since it's the first one we register.
+ */
+ trigger_create(&break_loop_trigger, break_loop, NULL, NULL);
+ trigger_add(&box_on_shutdown, &break_loop_trigger);
/* main core cleanup routine */
atexit(tarantool_free);
diff --git a/test/box/misc.result b/test/box/misc.result
index c3cabcc8aa3a6104f0f3681d5009647d399b2171..6912915c161bb74708e5e14e7bdf547597acc002 100644
--- a/test/box/misc.result
+++ b/test/box/misc.result
@@ -1249,3 +1249,75 @@ box.cfg{too_long_threshold = too_long_threshold}
s:drop()
---
...
+--
+-- gh-1607: on_shutdown triggers.
+--
+f = function() print('on_shutdown 1') end
+---
+...
+g = function() print('on_shutdown 2') end
+---
+...
+h = function() print('on_shutdown 3') end
+---
+...
+-- Check that on_shutdown triggers may yield
+-- and perform some complicated actions.
+fiber = require('fiber')
+---
+...
+test_run:cmd("setopt delimiter ';'")
+---
+- true
+...
+trig = function()
+ fiber.sleep(0.01)
+ fiber.yield()
+ box.schema.space.create("shutdown")
+ box.space.shutdown:create_index("pk")
+ box.space.shutdown:insert{1,2,3}
+ print('on_shutdown 4')
+end;
+---
+...
+test_run:cmd("setopt delimiter ''");
+---
+- true
+...
+_ = box.ctl.on_shutdown(f)
+---
+...
+_ = box.ctl.on_shutdown(g)
+---
+...
+-- Check that replacing triggers works
+_ = box.ctl.on_shutdown(h, g)
+---
+...
+_ = box.ctl.on_shutdown(trig)
+---
+...
+test_run:cmd('restart server default')
+test_run:grep_log('default', 'on_shutdown 1', nil, {noreset=true})
+---
+- on_shutdown 1
+...
+test_run:grep_log('default', 'on_shutdown 2', nil, {noreset=true})
+---
+- null
+...
+test_run:grep_log('default', 'on_shutdown 3', nil, {noreset=true})
+---
+- on_shutdown 3
+...
+test_run:grep_log('default', 'on_shutdown 4', nil, {noreset=true})
+---
+- on_shutdown 4
+...
+box.space.shutdown:select{}
+---
+- - [1, 2, 3]
+...
+box.space.shutdown:drop()
+---
+...
diff --git a/test/box/misc.test.lua b/test/box/misc.test.lua
index cc6cb34fb2eacd9b35ec87b9b0e0aee5164e3b51..f1c9d8e8cbbbcda7a27111180bb2cd8e41b66e27 100644
--- a/test/box/misc.test.lua
+++ b/test/box/misc.test.lua
@@ -352,3 +352,35 @@ rows == expected_rows
lsn == expected_lsn
box.cfg{too_long_threshold = too_long_threshold}
s:drop()
+
+--
+-- gh-1607: on_shutdown triggers.
+--
+f = function() print('on_shutdown 1') end
+g = function() print('on_shutdown 2') end
+h = function() print('on_shutdown 3') end
+-- Check that on_shutdown triggers may yield
+-- and perform some complicated actions.
+fiber = require('fiber')
+test_run:cmd("setopt delimiter ';'")
+trig = function()
+ fiber.sleep(0.01)
+ fiber.yield()
+ box.schema.space.create("shutdown")
+ box.space.shutdown:create_index("pk")
+ box.space.shutdown:insert{1,2,3}
+ print('on_shutdown 4')
+end;
+test_run:cmd("setopt delimiter ''");
+_ = box.ctl.on_shutdown(f)
+_ = box.ctl.on_shutdown(g)
+-- Check that replacing triggers works
+_ = box.ctl.on_shutdown(h, g)
+_ = box.ctl.on_shutdown(trig)
+test_run:cmd('restart server default')
+test_run:grep_log('default', 'on_shutdown 1', nil, {noreset=true})
+test_run:grep_log('default', 'on_shutdown 2', nil, {noreset=true})
+test_run:grep_log('default', 'on_shutdown 3', nil, {noreset=true})
+test_run:grep_log('default', 'on_shutdown 4', nil, {noreset=true})
+box.space.shutdown:select{}
+box.space.shutdown:drop()