commit a0f332d: [Rework] Move lua_worker to a dedicated unit
Vsevolod Stakhov
vsevolod at highsecure.ru
Fri May 3 15:00:06 UTC 2019
Author: Vsevolod Stakhov
Date: 2019-05-03 15:56:30 +0100
URL: https://github.com/rspamd/rspamd/commit/a0f332db7a9d85bc29245bda42660fb35e27366b (HEAD -> master)
[Rework] Move lua_worker to a dedicated unit
---
src/lua/CMakeLists.txt | 3 +-
src/lua/lua_common.c | 587 +---------------------------------------------
src/lua/lua_common.h | 1 +
src/lua/lua_worker.c | 615 +++++++++++++++++++++++++++++++++++++++++++++++++
4 files changed, 619 insertions(+), 587 deletions(-)
diff --git a/src/lua/CMakeLists.txt b/src/lua/CMakeLists.txt
index 4e20008c6..c3f1a84c1 100644
--- a/src/lua/CMakeLists.txt
+++ b/src/lua/CMakeLists.txt
@@ -29,6 +29,7 @@ SET(LUASRC ${CMAKE_CURRENT_SOURCE_DIR}/lua_common.c
${CMAKE_CURRENT_SOURCE_DIR}/lua_thread_pool.c
${CMAKE_CURRENT_SOURCE_DIR}/lua_dns.c
${CMAKE_CURRENT_SOURCE_DIR}/lua_udp.c
- ${CMAKE_CURRENT_SOURCE_DIR}/lua_text.c)
+ ${CMAKE_CURRENT_SOURCE_DIR}/lua_text.c
+ ${CMAKE_CURRENT_SOURCE_DIR}/lua_worker.c)
SET(RSPAMD_LUA ${LUASRC} PARENT_SCOPE)
\ No newline at end of file
diff --git a/src/lua/lua_common.c b/src/lua/lua_common.c
index 63f898574..f1ed7bb3b 100644
--- a/src/lua/lua_common.c
+++ b/src/lua/lua_common.c
@@ -17,9 +17,7 @@
#include "lptree.h"
#include "utlist.h"
#include "unix-std.h"
-#include "worker_util.h"
#include "ottery.h"
-#include "rspamd_control.h"
#include "lua_thread_pool.h"
#include "libstat/stat_api.h"
#include "libserver/rspamd_control.h"
@@ -40,27 +38,6 @@ const luaL_reg null_reg[] = {
{NULL, NULL}
};
-
-LUA_FUNCTION_DEF (worker, get_name);
-LUA_FUNCTION_DEF (worker, get_stat);
-LUA_FUNCTION_DEF (worker, get_index);
-LUA_FUNCTION_DEF (worker, get_pid);
-LUA_FUNCTION_DEF (worker, is_scanner);
-LUA_FUNCTION_DEF (worker, is_primary_controller);
-LUA_FUNCTION_DEF (worker, spawn_process);
-
-const luaL_reg worker_reg[] = {
- LUA_INTERFACE_DEF (worker, get_name),
- LUA_INTERFACE_DEF (worker, get_stat),
- LUA_INTERFACE_DEF (worker, get_index),
- LUA_INTERFACE_DEF (worker, get_pid),
- LUA_INTERFACE_DEF (worker, spawn_process),
- LUA_INTERFACE_DEF (worker, is_scanner),
- LUA_INTERFACE_DEF (worker, is_primary_controller),
- {"__tostring", rspamd_lua_class_tostring},
- {NULL, NULL}
-};
-
static const char rspamd_modules_state_global[] = "rspamd_plugins_state";
static GQuark
@@ -955,6 +932,7 @@ rspamd_lua_init (bool wipe_mem)
luaopen_cryptobox (L);
luaopen_dns (L);
luaopen_udp (L);
+ luaopen_worker (L);
luaL_newmetatable (L, "rspamd{ev_base}");
lua_pushstring (L, "class");
@@ -968,7 +946,6 @@ rspamd_lua_init (bool wipe_mem)
lua_rawset (L, -3);
lua_pop (L, 1);
- rspamd_lua_new_class (L, "rspamd{worker}", worker_reg);
rspamd_lua_add_preload (L, "lpeg", luaopen_lpeg);
luaopen_ucl (L);
rspamd_lua_add_preload (L, "ucl", luaopen_ucl);
@@ -1905,568 +1882,6 @@ rspamd_lua_run_postloads_error (struct thread_entry *thread, int ret, const char
}
-static struct rspamd_worker *
-lua_check_worker (lua_State *L, gint pos)
-{
- void *ud = rspamd_lua_check_udata (L, pos, "rspamd{worker}");
- luaL_argcheck (L, ud != NULL, pos, "'worker' expected");
- return ud ? *((struct rspamd_worker **)ud) : NULL;
-}
-
-static gint
-lua_worker_get_stat (lua_State *L)
-{
- struct rspamd_worker *w = lua_check_worker (L, 1);
-
- if (w) {
- rspamd_mempool_stat_t mem_st;
- struct rspamd_stat *stat, stat_copy;
- ucl_object_t *top, *sub;
- gint i;
- guint64 spam = 0, ham = 0;
-
- memset (&mem_st, 0, sizeof (mem_st));
- rspamd_mempool_stat (&mem_st);
- memcpy (&stat_copy, w->srv->stat, sizeof (stat_copy));
- stat = &stat_copy;
- top = ucl_object_typed_new (UCL_OBJECT);
- ucl_object_insert_key (top, ucl_object_fromint (
- stat->messages_scanned), "scanned", 0, false);
- ucl_object_insert_key (top, ucl_object_fromint (
- stat->messages_learned), "learned", 0, false);
- if (stat->messages_scanned > 0) {
- sub = ucl_object_typed_new (UCL_OBJECT);
- for (i = METRIC_ACTION_REJECT; i <= METRIC_ACTION_NOACTION; i++) {
- ucl_object_insert_key (sub,
- ucl_object_fromint (stat->actions_stat[i]),
- rspamd_action_to_str (i), 0, false);
- if (i < METRIC_ACTION_GREYLIST) {
- spam += stat->actions_stat[i];
- }
- else {
- ham += stat->actions_stat[i];
- }
- }
- ucl_object_insert_key (top, sub, "actions", 0, false);
- }
- else {
- sub = ucl_object_typed_new (UCL_OBJECT);
- for (i = METRIC_ACTION_REJECT; i <= METRIC_ACTION_NOACTION; i++) {
- ucl_object_insert_key (sub,
- 0,
- rspamd_action_to_str (i), 0, false);
- }
- ucl_object_insert_key (top, sub, "actions", 0, false);
- }
- ucl_object_insert_key (top, ucl_object_fromint (
- spam), "spam_count", 0, false);
- ucl_object_insert_key (top, ucl_object_fromint (
- ham), "ham_count", 0, false);
- ucl_object_insert_key (top,
- ucl_object_fromint (stat->connections_count), "connections", 0, false);
- ucl_object_insert_key (top,
- ucl_object_fromint (stat->control_connections_count),
- "control_connections", 0, false);
- ucl_object_insert_key (top,
- ucl_object_fromint (mem_st.pools_allocated), "pools_allocated", 0,
- false);
- ucl_object_insert_key (top,
- ucl_object_fromint (mem_st.pools_freed), "pools_freed", 0, false);
- ucl_object_insert_key (top,
- ucl_object_fromint (mem_st.bytes_allocated), "bytes_allocated", 0,
- false);
- ucl_object_insert_key (top,
- ucl_object_fromint (
- mem_st.chunks_allocated), "chunks_allocated", 0, false);
- ucl_object_insert_key (top,
- ucl_object_fromint (mem_st.shared_chunks_allocated),
- "shared_chunks_allocated", 0, false);
- ucl_object_insert_key (top,
- ucl_object_fromint (mem_st.chunks_freed), "chunks_freed", 0, false);
- ucl_object_insert_key (top,
- ucl_object_fromint (
- mem_st.oversized_chunks), "chunks_oversized", 0, false);
-
- ucl_object_push_lua (L, top, true);
- ucl_object_unref (top);
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
-}
-
-static gint
-lua_worker_get_name (lua_State *L)
-{
- struct rspamd_worker *w = lua_check_worker (L, 1);
-
- if (w) {
- lua_pushstring (L, g_quark_to_string (w->type));
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
-}
-
-static gint
-lua_worker_get_index (lua_State *L)
-{
- struct rspamd_worker *w = lua_check_worker (L, 1);
-
- if (w) {
- lua_pushinteger (L, w->index);
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
-}
-
-static gint
-lua_worker_get_pid (lua_State *L)
-{
- struct rspamd_worker *w = lua_check_worker (L, 1);
-
- if (w) {
- lua_pushinteger (L, w->pid);
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
-}
-
-
-static gint
-lua_worker_is_scanner (lua_State *L)
-{
- struct rspamd_worker *w = lua_check_worker (L, 1);
-
- if (w) {
- lua_pushboolean (L, rspamd_worker_is_scanner (w));
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
-}
-
-static gint
-lua_worker_is_primary_controller (lua_State *L)
-{
- struct rspamd_worker *w = lua_check_worker (L, 1);
-
- if (w) {
- lua_pushboolean (L, rspamd_worker_is_primary_controller (w));
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
-}
-
-struct rspamd_lua_process_cbdata {
- gint sp[2];
- gint func_cbref;
- gint cb_cbref;
- gboolean replied;
- gboolean is_error;
- pid_t cpid;
- lua_State *L;
- guint64 sz;
- GString *io_buf;
- GString *out_buf;
- goffset out_pos;
- struct rspamd_worker *wrk;
- struct event_base *ev_base;
- struct event ev;
-};
-
-static void
-rspamd_lua_execute_lua_subprocess (lua_State *L,
- struct rspamd_lua_process_cbdata *cbdata)
-{
- gint err_idx, r;
- GString *tb;
- guint64 wlen = 0;
- const gchar *ret;
- gsize retlen;
-
- lua_pushcfunction (L, &rspamd_lua_traceback);
- err_idx = lua_gettop (L);
-
- lua_rawgeti (L, LUA_REGISTRYINDEX, cbdata->func_cbref);
-
- if (lua_pcall (L, 0, 1, err_idx) != 0) {
- tb = lua_touserdata (L, -1);
- msg_err ("call to subprocess failed: %v", tb);
- /* Indicate error */
- wlen = (1ULL << 63) + tb->len;
-
- r = write (cbdata->sp[1], &wlen, sizeof (wlen));
- if (r == -1) {
- msg_err ("write failed: %s", strerror (errno));
- }
-
- r = write (cbdata->sp[1], tb->str, tb->len);
- if (r == -1) {
- msg_err ("write failed: %s", strerror (errno));
- }
- g_string_free (tb, TRUE);
-
- lua_pop (L, 1);
- }
- else {
- ret = lua_tolstring (L, -1, &retlen);
- wlen = retlen;
-
- r = write (cbdata->sp[1], &wlen, sizeof (wlen));
- if (r == -1) {
- msg_err ("write failed: %s", strerror (errno));
- }
-
- r = write (cbdata->sp[1], ret, retlen);
- if (r == -1) {
- msg_err ("write failed: %s", strerror (errno));
- }
- }
-
- lua_pop (L, 1); /* Error function */
-}
-
-static void
-rspamd_lua_call_on_complete (lua_State *L,
- struct rspamd_lua_process_cbdata *cbdata,
- const gchar *err_msg,
- const gchar *data, gsize datalen)
-{
- gint err_idx;
- GString *tb;
-
- lua_pushcfunction (L, &rspamd_lua_traceback);
- err_idx = lua_gettop (L);
-
- lua_rawgeti (L, LUA_REGISTRYINDEX, cbdata->cb_cbref);
-
- if (err_msg) {
- lua_pushstring (L, err_msg);
- }
- else {
- lua_pushnil (L);
- }
-
- if (data) {
- lua_pushlstring (L, data, datalen);
- }
- else {
- lua_pushnil (L);
- }
-
- if (lua_pcall (L, 2, 0, err_idx) != 0) {
- tb = lua_touserdata (L, -1);
- msg_err ("call to subprocess callback script failed: %v", tb);
- lua_pop (L, 1);
- }
-
- lua_pop (L, 1); /* Error function */
-}
-
-static gboolean
-rspamd_lua_cld_handler (struct rspamd_worker_signal_handler *sigh, void *ud)
-{
- struct rspamd_lua_process_cbdata *cbdata = ud;
- struct rspamd_srv_command srv_cmd;
- lua_State *L;
- pid_t died;
- gint res = 0;
-
- /* Are we called by a correct children ? */
- died = waitpid (cbdata->cpid, &res, WNOHANG);
-
- if (died <= 0) {
- /* Wait more */
- return TRUE;
- }
-
- L = cbdata->L;
- msg_info ("handled SIGCHLD from %p", cbdata->cpid);
-
- if (!cbdata->replied) {
- /* We still need to call on_complete callback */
- rspamd_lua_call_on_complete (cbdata->L, cbdata,
- "Worker has died without reply", NULL, 0);
- event_del (&cbdata->ev);
- }
-
- /* Free structures */
- close (cbdata->sp[0]);
- luaL_unref (L, LUA_REGISTRYINDEX, cbdata->func_cbref);
- luaL_unref (L, LUA_REGISTRYINDEX, cbdata->cb_cbref);
- g_string_free (cbdata->io_buf, TRUE);
-
- if (cbdata->out_buf) {
- g_string_free (cbdata->out_buf, TRUE);
- }
-
- /* Notify main */
- memset (&srv_cmd, 0, sizeof (srv_cmd));
- srv_cmd.type = RSPAMD_SRV_ON_FORK;
- srv_cmd.cmd.on_fork.state = child_dead;
- srv_cmd.cmd.on_fork.cpid = cbdata->cpid;
- srv_cmd.cmd.on_fork.ppid = getpid ();
- rspamd_srv_send_command (cbdata->wrk, cbdata->ev_base, &srv_cmd, -1,
- NULL, NULL);
- g_free (cbdata);
-
- /* We are done with this SIGCHLD */
- return FALSE;
-}
-
-static void
-rspamd_lua_subprocess_io (gint fd, short what, gpointer ud)
-{
- struct rspamd_lua_process_cbdata *cbdata = ud;
- gssize r;
-
- if (cbdata->sz == (guint64)-1) {
- guint64 sz;
-
- /* We read size of reply + flags first */
- r = read (cbdata->sp[0], cbdata->io_buf->str + cbdata->io_buf->len,
- sizeof (guint64) - cbdata->io_buf->len);
-
- if (r == 0) {
- rspamd_lua_call_on_complete (cbdata->L, cbdata,
- "Unexpected EOF", NULL, 0);
- event_del (&cbdata->ev);
- cbdata->replied = TRUE;
- kill (cbdata->cpid, SIGTERM);
-
- return;
- }
- else if (r == -1) {
- if (errno == EAGAIN || errno == EINTR) {
- return;
- }
- else {
- rspamd_lua_call_on_complete (cbdata->L, cbdata,
- strerror (errno), NULL, 0);
- event_del (&cbdata->ev);
- cbdata->replied = TRUE;
- kill (cbdata->cpid, SIGTERM);
-
- return;
- }
- }
-
- cbdata->io_buf->len += r;
-
- if (cbdata->io_buf->len == sizeof (guint64)) {
- memcpy ((guchar *)&sz, cbdata->io_buf->str, sizeof (sz));
-
- if (sz & (1ULL << 63)) {
- cbdata->is_error = TRUE;
- sz &= ~(1ULL << 63);
- }
-
- cbdata->io_buf->len = 0;
- cbdata->sz = sz;
- g_string_set_size (cbdata->io_buf, sz + 1);
- cbdata->io_buf->len = 0;
- }
- }
- else {
- /* Read data */
- r = read (cbdata->sp[0], cbdata->io_buf->str + cbdata->io_buf->len,
- cbdata->sz - cbdata->io_buf->len);
-
- if (r == 0) {
- rspamd_lua_call_on_complete (cbdata->L, cbdata,
- "Unexpected EOF", NULL, 0);
- event_del (&cbdata->ev);
- cbdata->replied = TRUE;
- kill (cbdata->cpid, SIGTERM);
-
- return;
- }
- else if (r == -1) {
- if (errno == EAGAIN || errno == EINTR) {
- return;
- }
- else {
- rspamd_lua_call_on_complete (cbdata->L, cbdata,
- strerror (errno), NULL, 0);
- event_del (&cbdata->ev);
- cbdata->replied = TRUE;
- kill (cbdata->cpid, SIGTERM);
-
- return;
- }
- }
-
- cbdata->io_buf->len += r;
-
- if (cbdata->io_buf->len == cbdata->sz) {
- gchar rep[4];
-
- /* Finished reading data */
- if (cbdata->is_error) {
- cbdata->io_buf->str[cbdata->io_buf->len] = '\0';
- rspamd_lua_call_on_complete (cbdata->L, cbdata,
- cbdata->io_buf->str, NULL, 0);
- }
- else {
- rspamd_lua_call_on_complete (cbdata->L, cbdata,
- NULL, cbdata->io_buf->str, cbdata->io_buf->len);
- }
-
- event_del (&cbdata->ev);
- cbdata->replied = TRUE;
-
- /* Write reply to the child */
- rspamd_socket_blocking (cbdata->sp[0]);
- memset (rep, 0, sizeof (rep));
- (void)write (cbdata->sp[0], rep, sizeof (rep));
- }
- }
-}
-
-static gint
-lua_worker_spawn_process (lua_State *L)
-{
- struct rspamd_worker *w = lua_check_worker (L, 1);
- struct rspamd_lua_process_cbdata *cbdata;
- struct rspamd_abstract_worker_ctx *actx;
- struct rspamd_srv_command srv_cmd;
- const gchar *cmdline = NULL, *input = NULL;
- gsize inputlen = 0;
- pid_t pid;
- GError *err = NULL;
- gint func_cbref, cb_cbref;
-
- if (!rspamd_lua_parse_table_arguments (L, 2, &err,
- "func=F;exec=S;stdin=V;*on_complete=F", &func_cbref,
- &cmdline, &inputlen, &input, &cb_cbref)) {
- msg_err ("cannot get parameters list: %e", err);
-
- if (err) {
- g_error_free (err);
- }
-
- return 0;
- }
-
- cbdata = g_malloc0 (sizeof (*cbdata));
- cbdata->cb_cbref = cb_cbref;
- cbdata->func_cbref = func_cbref;
-
- if (input) {
- cbdata->out_buf = g_string_new_len (input, inputlen);
- cbdata->out_pos = 0;
- }
-
- if (rspamd_socketpair (cbdata->sp, TRUE) == -1) {
- msg_err ("cannot spawn socketpair: %s", strerror (errno));
- luaL_unref (L, LUA_REGISTRYINDEX, cbdata->func_cbref);
- luaL_unref (L, LUA_REGISTRYINDEX, cbdata->cb_cbref);
- g_free (cbdata);
-
- return 0;
- }
-
- actx = w->ctx;
- cbdata->wrk = w;
- cbdata->L = L;
- cbdata->ev_base = actx->ev_base;
- cbdata->sz = (guint64)-1;
-
- pid = fork ();
-
- if (pid == -1) {
- msg_err ("cannot spawn process: %s", strerror (errno));
- close (cbdata->sp[0]);
- close (cbdata->sp[1]);
- luaL_unref (L, LUA_REGISTRYINDEX, cbdata->func_cbref);
- luaL_unref (L, LUA_REGISTRYINDEX, cbdata->cb_cbref);
- g_free (cbdata);
-
- return 0;
- }
- else if (pid == 0) {
- /* Child */
- gint rc;
- gchar inbuf[4];
-
- rspamd_log_update_pid (w->cf->type, w->srv->logger);
- rc = ottery_init (w->srv->cfg->libs_ctx->ottery_cfg);
-
- if (rc != OTTERY_ERR_NONE) {
- msg_err ("cannot initialize PRNG: %d", rc);
- abort ();
- }
- rspamd_random_seed_fast ();
-#ifdef HAVE_EVUTIL_RNG_INIT
- evutil_secure_rng_init ();
-#endif
-
- close (cbdata->sp[0]);
- /* Here we assume that we can block on writing results */
- rspamd_socket_blocking (cbdata->sp[1]);
- event_reinit (cbdata->ev_base);
- g_hash_table_remove_all (w->signal_events);
- rspamd_worker_unblock_signals ();
- rspamd_lua_execute_lua_subprocess (L, cbdata);
-
- /* Wait for parent to reply and exit */
- rc = read (cbdata->sp[1], inbuf, sizeof (inbuf));
-
- if (memcmp (inbuf, "\0\0\0\0", 4) == 0) {
- exit (EXIT_SUCCESS);
- }
- else {
- msg_err ("got invalid reply from parent");
-
- exit (EXIT_FAILURE);
- }
-
- }
-
- cbdata->cpid = pid;
- cbdata->io_buf = g_string_sized_new (8);
- /* Notify main */
- memset (&srv_cmd, 0, sizeof (srv_cmd));
- srv_cmd.type = RSPAMD_SRV_ON_FORK;
- srv_cmd.cmd.on_fork.state = child_create;
- srv_cmd.cmd.on_fork.cpid = pid;
- srv_cmd.cmd.on_fork.ppid = getpid ();
- rspamd_srv_send_command (w, cbdata->ev_base, &srv_cmd, -1, NULL, NULL);
-
- close (cbdata->sp[1]);
- rspamd_socket_nonblocking (cbdata->sp[0]);
- /* Parent */
- rspamd_worker_set_signal_handler (SIGCHLD, w, cbdata->ev_base,
- rspamd_lua_cld_handler,
- cbdata);
-
- /* Add result pipe waiting */
- event_set (&cbdata->ev, cbdata->sp[0], EV_READ | EV_PERSIST,
- rspamd_lua_subprocess_io, cbdata);
- event_base_set (cbdata->ev_base, &cbdata->ev);
- /* TODO: maybe add timeout? */
- event_add (&cbdata->ev, NULL);
-
- return 0;
-}
-
-
struct rspamd_lua_ref_cbdata {
lua_State *L;
gint cbref;
diff --git a/src/lua/lua_common.h b/src/lua/lua_common.h
index a755bb90f..0745d2ac3 100644
--- a/src/lua/lua_common.h
+++ b/src/lua/lua_common.h
@@ -284,6 +284,7 @@ void luaopen_sqlite3 (lua_State *L);
void luaopen_cryptobox (lua_State *L);
void luaopen_dns (lua_State *L);
void luaopen_udp (lua_State * L);
+void luaopen_worker (lua_State * L);
void rspamd_lua_dostring (const gchar *line);
diff --git a/src/lua/lua_worker.c b/src/lua/lua_worker.c
new file mode 100644
index 000000000..2b56ca392
--- /dev/null
+++ b/src/lua/lua_worker.c
@@ -0,0 +1,615 @@
+/*-
+ * Copyright 2019 Vsevolod Stakhov
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "lua_common.h"
+#include "unix-std.h"
+#include "worker_util.h"
+#include "rspamd_control.h"
+#include "ottery.h"
+
+/***
+ * @module rspamd_worker
+ * This module provides methods to access worker related functions in various
+ * places, such as periodic events or on_load events.
+ */
+
*** OUTPUT TRUNCATED, 588 LINES SKIPPED ***
More information about the Commits
mailing list