From: Eric Leblond <el@stamus-networks.com>
Date: Mon, 23 Aug 2021 19:29:24 +0000 (+0200)
Subject: profiling: let 'ruleset-profile' send message
X-Git-Tag: suricata-7.0.0-rc2~146
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=df88ef0249c1eb04bbb1b17d2d0ce08ee23e61f9;p=thirdparty%2Fsuricata.git

profiling: let 'ruleset-profile' send message

Let's send the profile output as an answer on the Unix socket.
---

diff --git a/src/unix-manager.c b/src/unix-manager.c
index 7f43a9a6ea..0afff751e9 100644
--- a/src/unix-manager.c
+++ b/src/unix-manager.c
@@ -784,12 +784,15 @@ static TmEcode UnixManagerRulesetStatsCommand(json_t *cmd,
 static TmEcode UnixManagerRulesetProfileCommand(json_t *cmd, json_t *server_msg, void *data)
 {
     SCEnter();
-    TmEcode retval;
     DetectEngineCtx *de_ctx = DetectEngineGetCurrent();
 
-    retval = SCProfileRuleTriggerDump(de_ctx);
-    json_object_set_new(server_msg, "message", json_string("OK"));
-    SCReturnInt(retval);
+    json_t *js = SCProfileRuleTriggerDump(de_ctx);
+    if (js == NULL) {
+        json_object_set_new(server_msg, "message", json_string("NOK"));
+        SCReturnInt(TM_ECODE_FAILED);
+    }
+    json_object_set_new(server_msg, "message", js);
+    SCReturnInt(TM_ECODE_OK);
 }
 #endif
 
diff --git a/src/util-profiling-rules.c b/src/util-profiling-rules.c
index 12c370bfe6..ded04c33ce 100644
--- a/src/util-profiling-rules.c
+++ b/src/util-profiling-rules.c
@@ -261,21 +261,21 @@ SCProfileSummarySortByMaxTicks(const void *a, const void *b)
         return s0->max > s1->max ? -1 : 1;
 }
 
-static void DumpJson(FILE *fp, SCProfileSummary *summary,
-        uint32_t count, uint64_t total_ticks,
-        const char *sort_desc)
+static json_t *BuildJson(
+        SCProfileSummary *summary, uint32_t count, uint64_t total_ticks, const char *sort_desc)
 {
+
     char timebuf[64];
     uint32_t i;
     struct timeval tval;
 
     json_t *js = json_object();
     if (js == NULL)
-        return;
+        return js;
     json_t *jsa = json_array();
     if (jsa == NULL) {
         json_decref(js);
-        return;
+        return js;
     }
 
     gettimeofday(&tval, NULL);
@@ -312,7 +312,15 @@ static void DumpJson(FILE *fp, SCProfileSummary *summary,
         }
     }
     json_object_set_new(js, "rules", jsa);
+    return js;
+}
 
+static void DumpJson(FILE *fp, SCProfileSummary *summary, uint32_t count, uint64_t total_ticks,
+        const char *sort_desc)
+{
+    json_t *js = BuildJson(summary, count, total_ticks, sort_desc);
+    if (unlikely(js == NULL))
+        return;
     char *js_s = json_dumps(js,
             JSON_PRESERVE_ORDER|JSON_COMPACT|JSON_ENSURE_ASCII|
             JSON_ESCAPE_SLASH);
@@ -391,31 +399,32 @@ static void DumpText(FILE *fp, SCProfileSummary *summary,
  *
  * \param de_ctx The active DetectEngineCtx, used to get at the loaded rules.
  */
-static void
-SCProfilingRuleDump(SCProfileDetectCtx *rules_ctx)
+static void *SCProfilingRuleDump(SCProfileDetectCtx *rules_ctx, int file_output)
 {
     uint32_t i;
-    FILE *fp;
+    FILE *fp = NULL;
 
     if (rules_ctx == NULL)
-        return;
+        return NULL;
 
-    if (profiling_output_to_file == 1) {
-        fp = fopen(profiling_file_name, profiling_file_mode);
+    if (file_output != 0) {
+        if (profiling_output_to_file == 1) {
+            fp = fopen(profiling_file_name, profiling_file_mode);
 
-        if (fp == NULL) {
-            SCLogError("failed to open %s: %s", profiling_file_name, strerror(errno));
-            return;
+            if (fp == NULL) {
+                SCLogError("failed to open %s: %s", profiling_file_name, strerror(errno));
+                return NULL;
+            }
+        } else {
+            fp = stdout;
         }
-    } else {
-       fp = stdout;
     }
 
     int summary_size = sizeof(SCProfileSummary) * rules_ctx->size;
     SCProfileSummary *summary = SCMalloc(summary_size);
     if (unlikely(summary == NULL)) {
         SCLogError("Error allocating memory for profiling summary");
-        return;
+        return NULL;
     }
 
     uint32_t count = rules_ctx->size;
@@ -493,17 +502,26 @@ SCProfilingRuleDump(SCProfileDetectCtx *rules_ctx)
                 break;
         }
         if (profiling_rule_json) {
-            DumpJson(fp, summary, count, total_ticks, sort_desc);
+            if (file_output != 1) {
+                json_t *js = BuildJson(summary, count, total_ticks, sort_desc);
+                SCFree(summary);
+                return js;
+            } else {
+                DumpJson(fp, summary, count, total_ticks, sort_desc);
+            }
         } else {
             DumpText(fp, summary, count, total_ticks, sort_desc);
         }
         order++;
     }
 
-    if (fp != stdout)
-        fclose(fp);
+    if (file_output != 0) {
+        if (fp != stdout)
+            fclose(fp);
+    }
     SCFree(summary);
     SCLogPerf("Done dumping profiling data.");
+    return NULL;
 }
 
 /**
@@ -559,7 +577,7 @@ static SCProfileDetectCtx *SCProfilingRuleInitCtx(void)
 void SCProfilingRuleDestroyCtx(SCProfileDetectCtx *ctx)
 {
     if (ctx != NULL) {
-        SCProfilingRuleDump(ctx);
+        SCProfilingRuleDump(ctx, 1);
         if (ctx->data != NULL)
             SCFree(ctx->data);
         pthread_mutex_destroy(&ctx->data_m);
@@ -668,10 +686,9 @@ SCProfilingRuleInitCounters(DetectEngineCtx *de_ctx)
     SCLogPerf("Registered %"PRIu32" rule profiling counters.", count);
 }
 
-int SCProfileRuleTriggerDump(DetectEngineCtx *de_ctx)
+json_t *SCProfileRuleTriggerDump(DetectEngineCtx *de_ctx)
 {
-    SCProfilingRuleDump(de_ctx->profile_ctx);
-    return TM_ECODE_OK;
+    return SCProfilingRuleDump(de_ctx->profile_ctx, 0);
 }
 
 #endif /* PROFILING */
diff --git a/src/util-profiling.h b/src/util-profiling.h
index 76c57ba09a..918f4d637a 100644
--- a/src/util-profiling.h
+++ b/src/util-profiling.h
@@ -400,7 +400,7 @@ void SCProfilingRuleUpdateCounter(DetectEngineThreadCtx *, uint16_t, uint64_t, i
 void SCProfilingRuleThreadSetup(struct SCProfileDetectCtx_ *, DetectEngineThreadCtx *);
 void SCProfilingRuleThreadCleanup(DetectEngineThreadCtx *);
 int SCProfileRuleStart(Packet *p);
-int SCProfileRuleTriggerDump(DetectEngineCtx *de_ctx);
+json_t *SCProfileRuleTriggerDump(DetectEngineCtx *de_ctx);
 void SCProfilingRuleThreatAggregate(DetectEngineThreadCtx *det_ctx);
 
 #define RULE_PROFILING_START(p)                                                                    \