• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

OISF / suricata / 22553492142

01 Mar 2026 09:48PM UTC coverage: 70.74% (-2.9%) from 73.687%
22553492142

Pull #14920

github

web-flow
Merge e15a765bc into 90823fa90
Pull Request #14920: draft: rust based configuration file parser and loader - v4

38209 of 77306 branches covered (49.43%)

Branch coverage included in aggregate %.

533 of 779 new or added lines in 5 files covered. (68.42%)

11924 existing lines in 491 files now uncovered.

252429 of 333548 relevant lines covered (75.68%)

2403268.06 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

79.85
/src/detect-engine-loader.c
1
/* Copyright (C) 2021-2023 Open Information Security Foundation
2
 *
3
 * You can copy, redistribute or modify this Program under the terms of
4
 * the GNU General Public License version 2 as published by the Free
5
 * Software Foundation.
6
 *
7
 * This program is distributed in the hope that it will be useful,
8
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10
 * GNU General Public License for more details.
11
 *
12
 * You should have received a copy of the GNU General Public License
13
 * version 2 along with this program; if not, write to the Free Software
14
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
15
 * 02110-1301, USA.
16
 */
17

18
/**
19
 * \file
20
 *
21
 * \author Victor Julien <victor@inliniac.net>
22
 */
23

24
#include "suricata-common.h"
25
#include "suricata.h"
26
#include "conf.h"
27
#include "detect.h"
28
#include "detect-parse.h"
29

30
#include "runmodes.h"
31
#include "threads.h"
32
#include "threadvars.h"
33
#include "tm-threads.h"
34
#include "queue.h"
35

36
#include "detect-engine.h"
37
#include "detect-engine-loader.h"
38
#include "detect-engine-build.h"
39
#include "detect-engine-analyzer.h"
40
#include "detect-engine-mpm.h"
41
#include "detect-engine-sigorder.h"
42

43
#include "util-detect.h"
44
#include "util-threshold-config.h"
45
#include "util-path.h"
46

47
#include "rust.h"
48

49
#ifdef HAVE_GLOB_H
50
#include <glob.h>
51
#endif
52

53
extern int rule_reload;
54
extern int engine_analysis;
55
static bool fp_engine_analysis_set = false;
56
bool rule_engine_analysis_set = false;
57

58
static char *DetectLoadCompleteSigPathWithKey(
59
        const DetectEngineCtx *de_ctx, const char *default_key, const char *sig_file)
60
{
103✔
61
    const char *defaultpath = NULL;
103✔
62
    char *path = NULL;
103✔
63
    char varname[128];
103✔
64

65
    if (sig_file == NULL) {
103!
66
        SCLogError("invalid sig_file argument - NULL");
×
67
        return NULL;
×
68
    }
×
69

70
    /* If we have a configuration prefix, only use it if the primary configuration node
71
     * is not marked as final, as that means it was provided on the command line with
72
     * a --set. */
73
    SCConfNode *default_rule_path = SCConfGetNode(default_key);
103✔
74
    if ((!default_rule_path || !default_rule_path->final) && strlen(de_ctx->config_prefix) > 0) {
103✔
75
        snprintf(varname, sizeof(varname), "%s.%s", de_ctx->config_prefix, default_key);
12✔
76
        default_rule_path = SCConfGetNode(varname);
12✔
77
    }
12✔
78
    if (default_rule_path) {
103✔
79
        defaultpath = default_rule_path->val;
64✔
80
    }
64✔
81

82
    /* Path not specified */
83
    if (PathIsRelative(sig_file)) {
103!
84
        if (defaultpath) {
103✔
85
            path = PathMergeAlloc(defaultpath, sig_file);
64✔
86
            if (unlikely(path == NULL))
64!
87
                return NULL;
×
88
        } else {
75✔
89
            path = SCStrdup(sig_file);
39✔
90
            if (unlikely(path == NULL))
39!
91
                return NULL;
×
92
        }
39✔
93
    } else {
103✔
UNCOV
94
        path = SCStrdup(sig_file);
×
UNCOV
95
        if (unlikely(path == NULL))
×
96
            return NULL;
×
UNCOV
97
    }
×
98
    return path;
103✔
99
}
103✔
100

101
/**
102
 *  \brief Create the path if default-rule-path was specified
103
 *  \param sig_file The name of the file
104
 *  \retval str Pointer to the string path + sig_file
105
 */
106
char *DetectLoadCompleteSigPath(const DetectEngineCtx *de_ctx, const char *sig_file)
107
{
102✔
108
    return DetectLoadCompleteSigPathWithKey(de_ctx, "default-rule-path", sig_file);
102✔
109
}
102✔
110

111
/**
112
 *  \brief Load a file with signatures
113
 *  \param de_ctx Pointer to the detection engine context
114
 *  \param sig_file Filename to load signatures from
115
 *  \param goodsigs_tot Will store number of valid signatures in the file
116
 *  \param badsigs_tot Will store number of invalid signatures in the file
117
 *  \retval 0 on success, -1 on error
118
 */
119
static int DetectLoadSigFile(DetectEngineCtx *de_ctx, const char *sig_file, int *goodsigs,
120
        int *badsigs, int *skippedsigs, const bool firewall_rule)
121
{
1,781✔
122
    int good = 0, bad = 0, skipped = 0;
1,781✔
123
    char line[DETECT_MAX_RULE_SIZE] = "";
1,781✔
124
    size_t offset = 0;
1,781✔
125
    int lineno = 0, multiline = 0;
1,781✔
126

127
    (*goodsigs) = 0;
1,781✔
128
    (*badsigs) = 0;
1,781✔
129
    (*skippedsigs) = 0;
1,781✔
130

131
    FILE *fp = fopen(sig_file, "r");
1,781✔
132
    if (fp == NULL) {
1,781!
133
        SCLogError("opening rule file %s:"
×
134
                   " %s.",
×
135
                sig_file, strerror(errno));
×
136
        return -1;
×
137
    }
×
138

139
    while (1) {
183,803!
140
        /* help clang to understand offset can't get > sizeof(line), so the argument to
141
         * fgets can't get negative. */
142
        BUG_ON(offset >= sizeof(line));
183,795!
143
        char *res = fgets(line + offset, (int)(sizeof(line) - offset), fp);
183,795✔
144
        if (res == NULL)
183,795✔
145
            break;
1,773✔
146

147
        lineno++;
182,022✔
148
        size_t len = strlen(line);
182,022✔
149

150
        /* ignore comments and empty lines */
151
        if (line[0] == '\n' || line [0] == '\r' || line[0] == ' ' || line[0] == '#' || line[0] == '\t')
182,022!
152
            continue;
71,810✔
153

154
        /* Check for multiline rules. */
155
        while (len > 0 && isspace((unsigned char)line[--len]));
220,367!
156
        if (line[len] == '\\') {
110,212✔
157
            multiline++;
413✔
158
            offset = len;
413✔
159
            if (offset < sizeof(line) - 1) {
413!
160
                /* We have room for more. */
161
                continue;
413✔
162
            }
413✔
163
            /* No more room in line buffer, continue, rule will fail
164
             * to parse. */
165
        }
413✔
166

167
        /* Check if we have a trailing newline, and remove it */
168
        len = strlen(line);
109,799✔
169
        if (len > 0 && (line[len - 1] == '\n' || line[len - 1] == '\r')) {
109,799!
170
            line[len - 1] = '\0';
109,740✔
171
        }
109,740✔
172

173
        /* Reset offset. */
174
        offset = 0;
109,799✔
175

176
        de_ctx->rule_file = sig_file;
109,799✔
177
        de_ctx->rule_line = lineno - multiline;
109,799✔
178

179
        Signature *sig = NULL;
109,799✔
180
        if (firewall_rule)
109,799✔
181
            sig = DetectFirewallRuleAppendNew(de_ctx, line);
259✔
182
        else
109,540✔
183
            sig = DetectEngineAppendSig(de_ctx, line);
109,540✔
184
        if (sig != NULL) {
109,799✔
185
            if (rule_engine_analysis_set || fp_engine_analysis_set) {
109,586!
186
                if (fp_engine_analysis_set) {
418✔
187
                    EngineAnalysisFP(de_ctx, sig, line);
398✔
188
                }
398✔
189
                if (rule_engine_analysis_set) {
418!
190
                    EngineAnalysisRules(de_ctx, sig, line);
418✔
191
                }
418✔
192
            }
418✔
193
            SCLogDebug("signature %"PRIu32" loaded", sig->id);
109,586!
194
            good++;
109,586✔
195
        } else {
109,586✔
196
            if (!de_ctx->sigerror_silent) {
213✔
197
                SCLogError("error parsing signature \"%s\" from "
115✔
198
                           "file %s at line %" PRId32 "",
115✔
199
                        line, sig_file, lineno - multiline);
115✔
200

201
                if (!SigStringAppend(&de_ctx->sig_stat, sig_file, line, de_ctx->sigerror, (lineno - multiline))) {
115!
202
                    SCLogError("Error adding sig \"%s\" from "
×
203
                               "file %s at line %" PRId32 "",
×
204
                            line, sig_file, lineno - multiline);
×
205
                }
×
206
                if (de_ctx->sigerror) {
115✔
207
                    de_ctx->sigerror = NULL;
2✔
208
                }
2✔
209
            }
115✔
210
            if (rule_engine_analysis_set) {
213✔
211
                EngineAnalysisRulesFailure(de_ctx, line, sig_file, lineno - multiline);
34✔
212
            }
34✔
213
            if (!de_ctx->sigerror_ok) {
213✔
214
                bad++;
116✔
215
            }
116✔
216
            if (de_ctx->sigerror_requires) {
213✔
217
                SCLogInfo("Skipping signature due to missing requirements: %s from file %s at line "
21✔
218
                          "%" PRId32,
21✔
219
                        line, sig_file, lineno - multiline);
21✔
220
                skipped++;
21✔
221
            }
21✔
222
        }
213✔
223
        multiline = 0;
109,799✔
224
    }
109,799✔
225
    fclose(fp);
1,781✔
226

227
    *goodsigs = good;
1,781✔
228
    *badsigs = bad;
1,781✔
229
    *skippedsigs = skipped;
1,781✔
230
    return 0;
1,781✔
231
}
1,781✔
232

233
/**
234
 *  \brief Expands wildcards and reads signatures from each matching file
235
 *  \param de_ctx Pointer to the detection engine context
236
 *  \param sig_file Filename (or pattern) holding signatures
237
 *  \retval -1 on error
238
 */
239
static int ProcessSigFiles(DetectEngineCtx *de_ctx, char *pattern, SigFileLoaderStat *st,
240
        int *good_sigs, int *bad_sigs, int *skipped_sigs)
241
{
1,735✔
242
    int r = 0;
1,735✔
243

244
    if (pattern == NULL) {
1,735!
245
        SCLogError("opening rule file null");
×
246
        return -1;
×
247
    }
×
248

249
#ifdef HAVE_GLOB_H
1,735✔
250
    glob_t files;
1,735✔
251
    r = glob(pattern, 0, NULL, &files);
1,735✔
252

253
    if (r == GLOB_NOMATCH) {
1,735!
254
        SCLogWarning("No rule files match the pattern %s", pattern);
1✔
255
        ++(st->bad_files);
1✔
256
        ++(st->total_files);
1✔
257
        return -1;
1✔
258
    } else if (r != 0) {
1,735!
259
        SCLogError("error expanding template %s: %s", pattern, strerror(errno));
×
260
        return -1;
×
261
    }
×
262

263
    for (size_t i = 0; i < (size_t)files.gl_pathc; i++) {
3,468✔
264
        char *fname = files.gl_pathv[i];
1,734✔
265
        if (strcmp("/dev/null", fname) == 0)
1,734!
UNCOV
266
            continue;
×
267
#else
268
        char *fname = pattern;
269
        if (strcmp("/dev/null", fname) == 0)
270
            return 0;
271
#endif
272
        if (strlen(de_ctx->config_prefix) > 0) {
1,734✔
273
            SCLogConfig("tenant id %d: Loading rule file: %s", de_ctx->tenant_id, fname);
12✔
274
        } else {
1,722✔
275
            SCLogConfig("Loading rule file: %s", fname);
1,722✔
276
        }
1,722✔
277
        r = DetectLoadSigFile(de_ctx, fname, good_sigs, bad_sigs, skipped_sigs, false);
1,734✔
278
        if (r < 0) {
1,734!
279
            ++(st->bad_files);
×
280
        }
×
281

282
        ++(st->total_files);
1,734✔
283

284
        st->good_sigs_total += *good_sigs;
1,734✔
285
        st->bad_sigs_total += *bad_sigs;
1,734✔
286
        st->skipped_sigs_total += *skipped_sigs;
1,734✔
287

288
#ifdef HAVE_GLOB_H
1,734✔
289
    }
1,734✔
290
    globfree(&files);
1,734✔
291
#endif
1,734✔
292
    return r;
1,734✔
293
}
1,735✔
294

295
static int LoadFirewallRuleFiles(DetectEngineCtx *de_ctx)
296
{
47✔
297
    if (de_ctx->firewall_rule_file_exclusive) {
47✔
298
        int32_t good_sigs = 0;
46✔
299
        int32_t bad_sigs = 0;
46✔
300
        int32_t skipped_sigs = 0;
46✔
301

302
        SCLogDebug("fw: rule file full path \"%s\"", de_ctx->firewall_rule_file_exclusive);
46!
303

304
        int ret = DetectLoadSigFile(de_ctx, de_ctx->firewall_rule_file_exclusive, &good_sigs,
46✔
305
                &bad_sigs, &skipped_sigs, true);
46✔
306

307
        /* for now be as strict as possible */
308
        if (ret != 0 || bad_sigs != 0 || skipped_sigs != 0) {
46!
309
            /* Some rules failed to load, just exit as
310
             * errors would have already been logged. */
311
            exit(EXIT_FAILURE);
×
312
        }
×
313

314
        if (good_sigs == 0) {
46!
315
            SCLogNotice("fw: No rules loaded from %s.", de_ctx->firewall_rule_file_exclusive);
×
316
        } else {
46✔
317
            SCLogNotice("fw: %d rules loaded from %s.", good_sigs,
46✔
318
                    de_ctx->firewall_rule_file_exclusive);
46✔
319
            de_ctx->sig_stat.good_sigs_total += good_sigs;
46✔
320
        }
46✔
321

322
        return 0;
46✔
323
    }
46✔
324

325
    SCConfNode *default_fw_rule_path = SCConfGetNode("firewall.rule-path");
1✔
326
    if (default_fw_rule_path == NULL) {
1!
327
        SCLogNotice("fw: firewall.rule-path not defined, skip loading firewall rules");
×
328
        return 0;
×
329
    }
×
330
    SCConfNode *rule_files = SCConfGetNode("firewall.rule-files");
1✔
331
    if (rule_files == NULL) {
1!
332
        SCLogNotice("fw: firewall.rule-files not defined, skip loading firewall rules");
×
333
        return 0;
×
334
    }
×
335

336
    SCConfNode *file = NULL;
1✔
337
    TAILQ_FOREACH (file, &rule_files->head, next) {
1✔
338
        int32_t good_sigs = 0;
1✔
339
        int32_t bad_sigs = 0;
1✔
340
        int32_t skipped_sigs = 0;
1✔
341

342
        char *sfile = DetectLoadCompleteSigPathWithKey(de_ctx, "firewall.rule-path", file->val);
1✔
343
        SCLogNotice("fw: rule file full path \"%s\"", sfile);
1✔
344

345
        int ret = DetectLoadSigFile(de_ctx, sfile, &good_sigs, &bad_sigs, &skipped_sigs, true);
1✔
346
        SCFree(sfile);
1✔
347

348
        /* for now be as strict as possible */
349
        if (ret != 0 || bad_sigs != 0 || skipped_sigs != 0) {
1!
350
            /* Some rules failed to load, just exit as
351
             * errors would have already been logged. */
352
            exit(EXIT_FAILURE);
×
353
        }
×
354

355
        if (good_sigs == 0) {
1!
356
            SCLogNotice("fw: No rules loaded from %s.", file->val);
×
357
        } else {
1✔
358
            SCLogNotice("fw: %d rules loaded from %s.", good_sigs, file->val);
1✔
359
            de_ctx->sig_stat.good_sigs_total += good_sigs;
1✔
360
        }
1✔
361
    }
1✔
362
    return 0;
1✔
363
}
1✔
364

365
/**
366
 *  \brief Load signatures
367
 *  \param de_ctx Pointer to the detection engine context
368
 *  \param sig_file Filename (or pattern) holding signatures
369
 *  \param sig_file_exclusive File passed in 'sig_file' should be loaded exclusively.
370
 *  \retval -1 on error
371
 */
372
int SigLoadSignatures(DetectEngineCtx *de_ctx, char *sig_file, bool sig_file_exclusive)
373
{
1,776✔
374
    SCEnter();
1,776✔
375

376
    SCConfNode *rule_files;
1,776✔
377
    SCConfNode *file = NULL;
1,776✔
378
    SigFileLoaderStat *sig_stat = &de_ctx->sig_stat;
1,776✔
379
    int ret = 0;
1,776✔
380
    char *sfile = NULL;
1,776✔
381
    char varname[128] = "rule-files";
1,776✔
382
    int good_sigs = 0;
1,776✔
383
    int bad_sigs = 0;
1,776✔
384
    int skipped_sigs = 0;
1,776✔
385

386
    if (strlen(de_ctx->config_prefix) > 0) {
1,776✔
387
        snprintf(varname, sizeof(varname), "%s.rule-files", de_ctx->config_prefix);
12✔
388
    }
12✔
389

390
    if (SCRunmodeGet() == RUNMODE_ENGINE_ANALYSIS) {
1,776✔
391
        SetupEngineAnalysis(de_ctx, &fp_engine_analysis_set, &rule_engine_analysis_set);
109✔
392
    }
109✔
393

394
    if (EngineModeIsFirewall() || de_ctx->firewall_rule_file_exclusive) {
1,776!
395
        if (LoadFirewallRuleFiles(de_ctx) < 0) {
47!
396
            if (de_ctx->failure_fatal) {
×
397
                exit(EXIT_FAILURE);
×
398
            }
×
399
            ret = -1;
×
400
            goto end;
×
401
        }
×
402

403
        /* skip regular rules if we used a exclusive firewall rule file */
404
        if (!sig_file_exclusive && de_ctx->firewall_rule_file_exclusive) {
47!
405
            ret = 0;
41✔
406
            goto skip_regular_rules;
41✔
407
        }
41✔
408
    }
47✔
409

410
    /* ok, let's load signature files from the general config */
411
    if (!(sig_file != NULL && sig_file_exclusive)) {
1,735!
412
        rule_files = SCConfGetNode(varname);
14✔
413
        if (rule_files != NULL) {
14!
414
            if (!SCConfNodeIsSequence(rule_files)) {
14!
415
                SCLogWarning("Invalid rule-files configuration section: "
×
416
                             "expected a list of filenames.");
×
417
            } else {
14✔
418
                TAILQ_FOREACH(file, &rule_files->head, next) {
14✔
419
                    sfile = DetectLoadCompleteSigPath(de_ctx, file->val);
14✔
420
                    good_sigs = bad_sigs = skipped_sigs = 0;
14✔
421
                    ret = ProcessSigFiles(
14✔
422
                            de_ctx, sfile, sig_stat, &good_sigs, &bad_sigs, &skipped_sigs);
14✔
423
                    SCFree(sfile);
14✔
424

425
                    if (de_ctx->failure_fatal && ret != 0) {
14!
426
                        /* Some rules failed to load, just exit as
427
                         * errors would have already been logged. */
428
                        exit(EXIT_FAILURE);
×
429
                    }
×
430

431
                    if (good_sigs == 0) {
14✔
432
                        SCLogConfig("No rules loaded from %s.", file->val);
2✔
433
                    }
2✔
434
                }
14✔
435
            }
14✔
436
        }
14✔
437
    }
14✔
438

439
    /* If a Signature file is specified from command-line, parse it too */
440
    if (sig_file != NULL) {
1,735✔
441
        ret = ProcessSigFiles(de_ctx, sig_file, sig_stat, &good_sigs, &bad_sigs, &skipped_sigs);
1,721✔
442

443
        if (ret != 0) {
1,721!
UNCOV
444
            if (de_ctx->failure_fatal) {
×
445
                exit(EXIT_FAILURE);
×
446
            }
×
UNCOV
447
        }
×
448

449
        if (good_sigs == 0) {
1,721✔
450
            SCLogConfig("No rules loaded from %s", sig_file);
73✔
451
        }
73✔
452
    }
1,721✔
453

454
skip_regular_rules:
1,768✔
455
    /* now we should have signatures to work with */
456
    if (sig_stat->good_sigs_total <= 0) {
1,768✔
457
        if (sig_stat->total_files > 0) {
74!
458
            SCLogWarning(
74✔
459
                    "%d rule files specified, but no rules were loaded!", sig_stat->total_files);
74✔
460
        } else {
74✔
UNCOV
461
            SCLogInfo("No signatures supplied.");
×
UNCOV
462
            goto end;
×
UNCOV
463
        }
×
464
    } else {
1,695✔
465
        /* we report the total of files and rules successfully loaded and failed */
466
        if (strlen(de_ctx->config_prefix) > 0) {
1,694✔
467
            SCLogInfo("tenant id %d:  %" PRId32 " rule files processed. %" PRId32
12✔
468
                      " rules successfully loaded, %" PRId32 " rules failed, %" PRId32
12✔
469
                      " rules skipped",
12✔
470
                    de_ctx->tenant_id, sig_stat->total_files, sig_stat->good_sigs_total,
12✔
471
                    sig_stat->bad_sigs_total, sig_stat->skipped_sigs_total);
12✔
472
        } else {
1,682✔
473
            SCLogInfo("%" PRId32 " rule files processed. %" PRId32
1,682✔
474
                      " rules successfully loaded, %" PRId32 " rules failed, %" PRId32
1,682✔
475
                      " rules skipped",
1,682✔
476
                    sig_stat->total_files, sig_stat->good_sigs_total, sig_stat->bad_sigs_total,
1,682✔
477
                    sig_stat->skipped_sigs_total);
1,682✔
478
        }
1,682✔
479
        if (de_ctx->requirements != NULL && sig_stat->skipped_sigs_total > 0) {
1,694✔
480
            SCDetectRequiresStatusLog(de_ctx->requirements, PROG_VER,
2✔
481
                    strlen(de_ctx->config_prefix) > 0 ? de_ctx->tenant_id : 0);
2!
482
        }
2✔
483
    }
1,694✔
484

485
    if ((sig_stat->bad_sigs_total || sig_stat->bad_files) && de_ctx->failure_fatal) {
1,768!
486
        ret = -1;
42✔
487
        goto end;
42✔
488
    }
42✔
489

490
    SCSigRegisterSignatureOrderingFuncs(de_ctx);
1,726✔
491
    SCSigOrderSignatures(de_ctx);
1,726✔
492
    SCSigSignatureOrderingModuleCleanup(de_ctx);
1,726✔
493

494
    if (SCThresholdConfInitContext(de_ctx) < 0) {
1,726✔
495
        ret = -1;
1✔
496
        goto end;
1✔
497
    }
1✔
498

499
    /* Setup the signature group lookup structure and pattern matchers */
500
    if (SigGroupBuild(de_ctx) < 0)
1,725!
501
        goto end;
×
502

503
    ret = 0;
1,725✔
504

505
 end:
1,768✔
506
    gettimeofday(&de_ctx->last_reload, NULL);
1,768✔
507
    if (SCRunmodeGet() == RUNMODE_ENGINE_ANALYSIS) {
1,768✔
508
        CleanupEngineAnalysis(de_ctx);
108✔
509
    }
108✔
510

511
    DetectParseDupSigHashFree(de_ctx);
1,768✔
512
    SCReturnInt(ret);
1,768✔
513
}
1,725✔
514

515
#define NLOADERS 4
3✔
516
static DetectLoaderControl *loaders = NULL;
517
static int cur_loader = 0;
518
static void TmThreadWakeupDetectLoaderThreads(void);
519
static int num_loaders = NLOADERS;
520

521
/** \param loader -1 for auto select
522
 *  \retval loader_id or negative in case of error */
523
int DetectLoaderQueueTask(int loader_id, LoaderFunc Func, void *func_ctx, LoaderFreeFunc FreeFunc)
524
{
12✔
525
    if (loader_id == -1) {
12!
526
        loader_id = cur_loader;
12✔
527
        cur_loader++;
12✔
528
        if (cur_loader >= num_loaders)
12✔
529
            cur_loader = 0;
3✔
530
    }
12✔
531
    if (loader_id >= num_loaders || loader_id < 0) {
12!
532
        return -ERANGE;
×
533
    }
×
534

535
    DetectLoaderControl *loader = &loaders[loader_id];
12✔
536

537
    DetectLoaderTask *t = SCCalloc(1, sizeof(*t));
12✔
538
    if (t == NULL)
12!
539
        return -ENOMEM;
×
540

541
    t->Func = Func;
12✔
542
    t->ctx = func_ctx;
12✔
543
    t->FreeFunc = FreeFunc;
12✔
544

545
    SCMutexLock(&loader->m);
12✔
546
    TAILQ_INSERT_TAIL(&loader->task_list, t, next);
12!
547
    SCMutexUnlock(&loader->m);
12✔
548

549
    TmThreadWakeupDetectLoaderThreads();
12✔
550

551
    SCLogDebug("%d %p %p", loader_id, Func, func_ctx);
12!
552
    return loader_id;
12✔
553
}
12✔
554

555
/** \brief wait for loader tasks to complete
556
 *  \retval result 0 for ok, -1 for errors */
557
int DetectLoadersSync(void)
558
{
3✔
559
    SCLogDebug("waiting");
3!
560
    int errors = 0;
3✔
561
    for (int i = 0; i < num_loaders; i++) {
15✔
562
        bool done = false;
12✔
563

564
        DetectLoaderControl *loader = &loaders[i];
12✔
565
        while (!done) {
207,272✔
566
            SCMutexLock(&loader->m);
207,260✔
567
            if (TAILQ_EMPTY(&loader->task_list)) {
207,260✔
568
                done = true;
12✔
569
            }
12✔
570
            SCMutexUnlock(&loader->m);
207,260✔
571
            if (!done) {
207,260✔
572
                /* nudge thread in case it's sleeping */
573
                SCCtrlMutexLock(loader->tv->ctrl_mutex);
207,248✔
574
                pthread_cond_broadcast(loader->tv->ctrl_cond);
207,248✔
575
                SCCtrlMutexUnlock(loader->tv->ctrl_mutex);
207,248✔
576
            }
207,248✔
577
        }
207,260✔
578
        SCMutexLock(&loader->m);
12✔
579
        if (loader->result != 0) {
12!
580
            errors++;
×
581
            loader->result = 0;
×
582
        }
×
583
        SCMutexUnlock(&loader->m);
12✔
584
    }
12✔
585
    if (errors) {
3!
586
        SCLogError("%d loaders reported errors", errors);
×
587
        return -1;
×
588
    }
×
589
    SCLogDebug("done");
3!
590
    return 0;
3✔
591
}
3✔
592

593
static void DetectLoaderInit(DetectLoaderControl *loader)
594
{
12✔
595
    memset(loader, 0x00, sizeof(*loader));
12✔
596
    SCMutexInit(&loader->m, NULL);
12✔
597
    TAILQ_INIT(&loader->task_list);
12!
598
}
12✔
599

600
void DetectLoadersInit(void)
601
{
3✔
602
    intmax_t setting = NLOADERS;
3✔
603
    (void)SCConfGetInt("multi-detect.loaders", &setting);
3✔
604

605
    if (setting < 1 || setting > 1024) {
3!
606
        FatalError("invalid multi-detect.loaders setting %" PRIdMAX, setting);
×
607
    }
×
608

609
    num_loaders = (int32_t)setting;
3✔
610
    SCLogInfo("using %d detect loader threads", num_loaders);
3✔
611

612
    BUG_ON(loaders != NULL);
3!
613
    loaders = SCCalloc(num_loaders, sizeof(DetectLoaderControl));
3✔
614
    BUG_ON(loaders == NULL);
3!
615

616
    for (int i = 0; i < num_loaders; i++) {
15✔
617
        DetectLoaderInit(&loaders[i]);
12✔
618
    }
12✔
619
}
3✔
620

621
/**
622
 * \brief Unpauses all threads present in tv_root
623
 */
624
static void TmThreadWakeupDetectLoaderThreads(void)
625
{
12✔
626
    SCMutexLock(&tv_root_lock);
12✔
627
    for (int i = 0; i < TVT_MAX; i++) {
48✔
628
        ThreadVars *tv = tv_root[i];
36✔
629
        while (tv != NULL) {
84✔
630
            if (strncmp(tv->name,"DL#",3) == 0) {
48!
631
                BUG_ON(tv->ctrl_cond == NULL);
48!
632
                SCCtrlMutexLock(tv->ctrl_mutex);
48✔
633
                pthread_cond_broadcast(tv->ctrl_cond);
48✔
634
                SCCtrlMutexUnlock(tv->ctrl_mutex);
48✔
635
            }
48✔
636
            tv = tv->next;
48✔
637
        }
48✔
638
    }
36✔
639
    SCMutexUnlock(&tv_root_lock);
12✔
640
}
12✔
641

642
/**
643
 * \brief Unpauses all threads present in tv_root
644
 */
645
void TmThreadContinueDetectLoaderThreads(void)
646
{
3✔
647
    SCMutexLock(&tv_root_lock);
3✔
648
    for (int i = 0; i < TVT_MAX; i++) {
12✔
649
        ThreadVars *tv = tv_root[i];
9✔
650
        while (tv != NULL) {
21✔
651
            if (strncmp(tv->name,"DL#",3) == 0)
12!
652
                TmThreadContinue(tv);
12✔
653

654
            tv = tv->next;
12✔
655
        }
12✔
656
    }
9✔
657
    SCMutexUnlock(&tv_root_lock);
3✔
658
}
3✔
659

660
SC_ATOMIC_DECLARE(int, detect_loader_cnt);
661

662
typedef struct DetectLoaderThreadData_ {
663
    uint32_t instance;
664
} DetectLoaderThreadData;
665

666
static TmEcode DetectLoaderThreadInit(ThreadVars *t, const void *initdata, void **data)
667
{
12✔
668
    DetectLoaderThreadData *ftd = SCCalloc(1, sizeof(DetectLoaderThreadData));
12✔
669
    if (ftd == NULL)
12!
670
        return TM_ECODE_FAILED;
×
671

672
    ftd->instance = SC_ATOMIC_ADD(detect_loader_cnt, 1); /* id's start at 0 */
12✔
673
    SCLogDebug("detect loader instance %u", ftd->instance);
12!
674

675
    /* pass thread data back to caller */
676
    *data = ftd;
12✔
677

678
    DetectLoaderControl *loader = &loaders[ftd->instance];
12✔
679
    loader->tv = t;
12✔
680

681
    return TM_ECODE_OK;
12✔
682
}
12✔
683

684
static TmEcode DetectLoaderThreadDeinit(ThreadVars *t, void *data)
685
{
4✔
686
    SCFree(data);
4✔
687
    return TM_ECODE_OK;
4✔
688
}
4✔
689

690

691
static TmEcode DetectLoader(ThreadVars *th_v, void *thread_data)
692
{
12✔
693
    DetectLoaderThreadData *ftd = (DetectLoaderThreadData *)thread_data;
12✔
694
    BUG_ON(ftd == NULL);
12!
695

696
    TmThreadsSetFlag(th_v, THV_INIT_DONE | THV_RUNNING);
12✔
697
    SCLogDebug("loader thread started");
12!
698
    bool run = TmThreadsWaitForUnpause(th_v);
12✔
699
    while (run) {
29✔
700
        /* see if we have tasks */
701

702
        DetectLoaderControl *loader = &loaders[ftd->instance];
17✔
703
        SCMutexLock(&loader->m);
17✔
704

705
        DetectLoaderTask *task = NULL, *tmptask = NULL;
17✔
706
        TAILQ_FOREACH_SAFE(task, &loader->task_list, next, tmptask) {
17✔
707
            int r = task->Func(task->ctx, ftd->instance);
12✔
708
            loader->result |= r;
12✔
709
            TAILQ_REMOVE(&loader->task_list, task, next);
12!
710
            task->FreeFunc(task->ctx);
12✔
711
            SCFree(task);
12✔
712
        }
12✔
713

714
        SCMutexUnlock(&loader->m);
17✔
715

716
        /* just wait until someone wakes us up */
717
        SCCtrlMutexLock(th_v->ctrl_mutex);
17✔
718
        int rc = 0;
17✔
719
        while (rc == 0) {
37✔
720
            if (TmThreadsCheckFlag(th_v, THV_KILL)) {
29✔
721
                run = false;
4✔
722
                break;
4✔
723
            }
4✔
724
            SCMutexLock(&loader->m);
25✔
725
            bool has_work = loader->task_list.tqh_first != NULL;
25✔
726
            SCMutexUnlock(&loader->m);
25✔
727
            if (has_work)
25✔
728
                break;
5✔
729

730
            rc = SCCtrlCondWait(th_v->ctrl_cond, th_v->ctrl_mutex);
20✔
731
        }
20✔
732
        SCCtrlMutexUnlock(th_v->ctrl_mutex);
17✔
733

734
        SCLogDebug("woke up...");
17!
735
    }
17✔
736

737
    TmThreadsSetFlag(th_v, THV_RUNNING_DONE);
12✔
738
    TmThreadWaitForFlag(th_v, THV_DEINIT);
12✔
739
    TmThreadsSetFlag(th_v, THV_CLOSED);
12✔
740

741
    return TM_ECODE_OK;
12✔
742
}
12✔
743

744
/** \brief spawn the detect loader manager thread */
745
void DetectLoaderThreadSpawn(void)
746
{
3✔
747
    for (int i = 0; i < num_loaders; i++) {
15✔
748
        char name[TM_THREAD_NAME_MAX];
12✔
749
        snprintf(name, sizeof(name), "%s#%02d", thread_name_detect_loader, i+1);
12✔
750

751
        ThreadVars *tv_loader = TmThreadCreateCmdThreadByName(name, "DetectLoader", 1);
12✔
752
        if (tv_loader == NULL) {
12!
753
            FatalError("failed to create thread %s", name);
×
754
        }
×
755
        if (TmThreadSpawn(tv_loader) != TM_ECODE_OK) {
12!
756
            FatalError("failed to create spawn %s", name);
×
757
        }
×
758
    }
12✔
759
}
3✔
760

761
void TmModuleDetectLoaderRegister (void)
762
{
3✔
763
    tmm_modules[TMM_DETECTLOADER].name = "DetectLoader";
3✔
764
    tmm_modules[TMM_DETECTLOADER].ThreadInit = DetectLoaderThreadInit;
3✔
765
    tmm_modules[TMM_DETECTLOADER].ThreadDeinit = DetectLoaderThreadDeinit;
3✔
766
    tmm_modules[TMM_DETECTLOADER].Management = DetectLoader;
3✔
767
    tmm_modules[TMM_DETECTLOADER].cap_flags = 0;
3✔
768
    tmm_modules[TMM_DETECTLOADER].flags = TM_FLAG_MANAGEMENT_TM;
3✔
769
    SCLogDebug("%s registered", tmm_modules[TMM_DETECTLOADER].name);
3!
770

771
    SC_ATOMIC_INIT(detect_loader_cnt);
3✔
772
}
3✔
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc