[Feature] Add 'composites' debug module

diff --git a/src/libserver/cfg_rcl.c b/src/libserver/cfg_rcl.c
index a41b391a03d668e1a3f56f3c69519f7268b12819..f2256f55cb80b56a199782f51d21bbef4be57cd7 100644 (file)
--- a/src/libserver/cfg_rcl.c
+++ b/src/libserver/cfg_rcl.c
@@ -1438,6 +1438,7 @@ rspamd_rcl_composite_handler (rspamd_mempool_t *pool,
        composite->expr = expr;
        composite->id = g_hash_table_size (cfg->composite_symbols);
        composite->str_expr = composite_expression;
+       composite->sym = composite_name;
 
        val = ucl_object_lookup (obj, "score");
        if (val != NULL && ucl_object_todouble_safe (val, &score)) {

diff --git a/src/libserver/composites.c b/src/libserver/composites.c
index 25ee4681174d8ab73cde86a98e4533ea1d82c41e..e824ef8d42df69ed3124c512818d998168949bb5 100644 (file)
--- a/src/libserver/composites.c
+++ b/src/libserver/composites.c
@@ -21,6 +21,23 @@
 #include "filter.h"
 #include "composites.h"
 
+#define msg_err_composites(...) rspamd_default_log_function (G_LOG_LEVEL_CRITICAL, \
+        "composites", task->task_pool->tag.uid, \
+        G_STRFUNC, \
+        __VA_ARGS__)
+#define msg_warn_composites(...)   rspamd_default_log_function (G_LOG_LEVEL_WARNING, \
+        "composites", task->task_pool->tag.uid, \
+        G_STRFUNC, \
+        __VA_ARGS__)
+#define msg_info_composites(...)   rspamd_default_log_function (G_LOG_LEVEL_INFO, \
+        "composites", task->task_pool->tag.uid, \
+        G_STRFUNC, \
+        __VA_ARGS__)
+#define msg_debug_composites(...)  rspamd_default_log_function (G_LOG_LEVEL_DEBUG, \
+        "composites", task->task_pool->tag.uid, \
+        G_STRFUNC, \
+        __VA_ARGS__)
+
 struct composites_data {
        struct rspamd_task *task;
        struct rspamd_composite *composite;
@@ -97,12 +114,21 @@ rspamd_composite_process_single_symbol (struct composites_data *cd,
        struct rspamd_symbol_result *ms = NULL;
        gdouble rc = 0;
        struct rspamd_composite *ncomp;
+       struct rspamd_task *task = cd->task;
 
        if ((ms = g_hash_table_lookup (cd->metric_res->symbols, sym)) == NULL) {
+               msg_debug_composites ("not found symbol %s in composite %s", sym,
+                               cd->composite->sym);
                if ((ncomp =
                                g_hash_table_lookup (cd->task->cfg->composite_symbols,
                                                sym)) != NULL) {
+
+                       msg_debug_composites ("symbol %s for composite %s is another composite",
+                                       sym, cd->composite->sym);
+
                        if (isclr (cd->checked, ncomp->id * 2)) {
+                               msg_debug_composites ("composite dependency %s for %s is not checked",
+                                               sym, cd->composite->sym);
                                /* Set checked for this symbol to avoid cyclic references */
                                setbit (cd->checked, cd->composite->id * 2);
                                rc = rspamd_process_expression (ncomp->expr,
@@ -128,6 +154,8 @@ rspamd_composite_process_single_symbol (struct composites_data *cd,
        }
 
        if (ms) {
+               msg_debug_composites ("found symbol %s in composite %s, weight: %.3f",
+                               sym, cd->composite->sym, ms->score);
                if (ms->score == 0) {
                        rc = 0.001; /* Distinguish from 0 */
                }
@@ -150,6 +178,7 @@ rspamd_composite_expr_process (gpointer input, rspamd_expression_atom_t *atom)
        struct rspamd_symbol_result *ms = NULL;
        struct rspamd_symbols_group *gr;
        struct rspamd_symbol *sdef;
+       struct rspamd_task *task = cd->task;
        GHashTableIter it;
        gpointer k, v;
        gdouble rc = 0;
@@ -169,6 +198,9 @@ rspamd_composite_expr_process (gpointer input, rspamd_expression_atom_t *atom)
                        }
                }
 
+               msg_debug_composites ("composite %s is already checked, result: %.2f",
+                               cd->composite->sym, rc);
+
                return rc;
        }
 
@@ -252,9 +284,7 @@ rspamd_composite_expr_process (gpointer input, rspamd_expression_atom_t *atom)
 
                if (rd == NULL) {
                        DL_APPEND (rd, nrd);
-                       g_hash_table_insert (cd->symbols_to_remove,
-                                                       (gpointer)ms->name,
-                                                       rd);
+                       g_hash_table_insert (cd->symbols_to_remove, (gpointer)ms->name, rd);
                }
                else {
                        DL_APPEND (rd, nrd);
@@ -285,19 +315,25 @@ composites_foreach_callback (gpointer key, gpointer value, void *data)
 {
        struct composites_data *cd = data;
        struct rspamd_composite *comp = value;
+       struct rspamd_task *task;
        gdouble rc;
 
        cd->composite = comp;
+       task = cd->task;
 
        if (!isset (cd->checked, cd->composite->id * 2)) {
                if (rspamd_symbols_cache_is_checked (cd->task, cd->task->cfg->cache,
                                key)) {
+                       msg_debug_composites ("composite %s is checked in symcache but not "
+                                       "in composites bitfield", cd->composite->sym);
                        setbit (cd->checked, comp->id * 2);
                        clrbit (cd->checked, comp->id * 2 + 1);
                }
                else {
                        if (g_hash_table_lookup (cd->metric_res->symbols, key) != NULL) {
                                /* Already set, no need to check */
+                               msg_debug_composites ("composite %s is already in metric "
+                                               "in composites bitfield", cd->composite->sym);
                                setbit (cd->checked, comp->id * 2);
                                clrbit (cd->checked, comp->id * 2 + 1);
 
@@ -327,12 +363,15 @@ static void
 composites_remove_symbols (gpointer key, gpointer value, gpointer data)
 {
        struct composites_data *cd = data;
+       struct rspamd_task *task;
        struct symbol_remove_data *rd = value, *cur;
        gboolean skip = FALSE, has_valid_op = FALSE,
                        want_remove_score = TRUE, want_remove_symbol = TRUE,
                        want_forced = FALSE;
        GNode *par;
 
+       task = cd->task;
+
        DL_FOREACH (rd, cur) {
                if (!isset (cd->checked, cur->comp->id * 2 + 1)) {
                        continue;
@@ -382,9 +421,12 @@ composites_remove_symbols (gpointer key, gpointer value, gpointer data)
        if (has_valid_op) {
                if (want_remove_symbol || want_forced) {
                        g_hash_table_remove (cd->metric_res->symbols, key);
+                       msg_debug_composites ("remove symbol %s", key);
                }
 
                if (want_remove_score || want_forced) {
+                       msg_debug_composites ("remove symbol weight for %s (was %.2f)",
+                                       key, rd->ms->score);
                        cd->metric_res->score -= rd->ms->score;
                        rd->ms->score = 0.0;
                }

diff --git a/src/libserver/composites.h b/src/libserver/composites.h
index 6baa13c14ad98a3067bbd8e2e681a056e662a7b4..a72effdf296bd0707b2e16ca16d70cdd2fec2cc0 100644 (file)
--- a/src/libserver/composites.h
+++ b/src/libserver/composites.h
@@ -38,6 +38,7 @@ enum rspamd_composite_policy {
  */
 struct rspamd_composite {
        const gchar *str_expr;
+       const gchar *sym;
        struct rspamd_expression *expr;
        gint id;
        enum rspamd_composite_policy policy;

diff --git a/src/lua/lua_config.c b/src/lua/lua_config.c
index 4679b4ede91167b1ab1afcda1522490ea38ab238..cd33b219eb936b7db65575771f0ca6a2a3b11000 100644 (file)
--- a/src/lua/lua_config.c
+++ b/src/lua/lua_config.c
@@ -1968,6 +1968,7 @@ lua_config_add_composite (lua_State * L)
                                composite->id = g_hash_table_size (cfg->composite_symbols);
                                composite->str_expr = rspamd_mempool_strdup (cfg->cfg_pool,
                                                expr_str);
+                               composite->sym = name;
                                g_hash_table_insert (cfg->composite_symbols,
                                                (gpointer)name,
                                                composite);