23374838686

Committed 21 Mar 2026 07:29AM UTC coverage: 59.341% (-20.0%) from 79.315%

Build # 23374838686

Build Type

Pull #15075

github

Committed by

web-flow

Commit Message

Merge 90b4e834f into 6587e363a

Pull Request Pull Request #15075: Stack 8001 v16.4

Run Details

38 of 70 new or added lines in 10 files covered. (54.29%)

34165 existing lines in 563 files now uncovered.

119621 of 201584 relevant lines covered (59.34%)

650666.92 hits per line

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

85.71

/src/tm-modules.h

/* Copyright (C) 2007-2024 Open Information Security Foundation
 *
 * You can copy, redistribute or modify this Program under the terms of
 * the GNU General Public License version 2 as published by the Free
 * Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * version 2 along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */

/**
 * \file
 *
 * \author Victor Julien <victor@inliniac.net>
 */

#ifndef SURICATA_TM_MODULES_H
#define SURICATA_TM_MODULES_H

#include "tm-threads-common.h"
#include "threadvars.h"
#include "decode.h"

/* thread flags */
#define TM_FLAG_RECEIVE_TM      0x01
#define TM_FLAG_DECODE_TM       0x02
#define TM_FLAG_FLOWWORKER_TM   0x04
#define TM_FLAG_VERDICT_TM      0x08
#define TM_FLAG_MANAGEMENT_TM   0x10
#define TM_FLAG_COMMAND_TM      0x20

/* all packet modules combined */
#define TM_FLAG_PACKET_ALL                                                                         \
    (TM_FLAG_RECEIVE_TM | TM_FLAG_DECODE_TM | TM_FLAG_FLOWWORKER_TM | TM_FLAG_VERDICT_TM)

typedef TmEcode (*ThreadInitFunc)(ThreadVars *, const void *, void **);
typedef TmEcode (*ThreadDeinitFunc)(ThreadVars *, void *);
typedef void (*ThreadExitPrintStatsFunc)(ThreadVars *, void *);

typedef struct TmModule_ {
    const char *name;

    /** thread handling */
    TmEcode (*ThreadInit)(ThreadVars *, const void *, void **);
    void (*ThreadExitPrintStats)(ThreadVars *, void *);
    TmEcode (*ThreadDeinit)(ThreadVars *, void *);

    /** the packet processing function */
    TmEcode (*Func)(ThreadVars *, Packet *, void *);

    TmEcode (*PktAcqLoop)(ThreadVars *, void *, void *);

    /** terminates the capture loop in PktAcqLoop */
    TmEcode (*PktAcqBreakLoop)(ThreadVars *, void *);

    /** does a thread still have tasks to complete before it can be killed?
     *  \retval bool
     *  \param tv threadvars
     *  \param thread_data thread module thread data (e.g. FlowWorkerThreadData for FlowWorker) */
    bool (*ThreadBusy)(ThreadVars *tv, void *thread_data);

    TmEcode (*Management)(ThreadVars *, void *);

    /** global Init/DeInit */
    TmEcode (*Init)(void);
    TmEcode (*DeInit)(void);
#ifdef UNITTESTS
    void (*RegisterTests)(void);
#endif
    uint8_t cap_flags; /**< Flags to indicate the capability requirement of
                           the given TmModule */
    /* Other flags used by the module */
    uint8_t flags;
} TmModule;

extern TmModule tmm_modules[TMM_SIZE];

/**
 * Structure that output modules use to maintain private data.
 */
typedef struct OutputCtx_ {

    /** Pointer to data private to the output. */
    void *data;

    /** Pointer to a cleanup function. */
    void (*DeInit)(struct OutputCtx_ *);

    TAILQ_HEAD(, OutputModule_) submodules;
} OutputCtx;

TmModule *TmModuleGetByName(const char *name);
TmModule *TmModuleGetById(int id);
int TmModuleGetIDForTM(TmModule *tm);
TmEcode TmModuleRegister(char *name, int (*module_func)(ThreadVars *, Packet *, void *));
void TmModuleDebugList(void);
void TmModuleRegisterTests(void);
#ifdef PROFILING
const char * TmModuleTmmIdToString(TmmId id);
#endif
void TmModuleRunInit(void);
void TmModuleRunDeInit(void);

#endif /* SURICATA_TM_MODULES_H */

1	/* Copyright (C) 2007-2024 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	#ifndef SURICATA_TM_MODULES_H
25	#define SURICATA_TM_MODULES_H
26
27	#include "tm-threads-common.h"
28	#include "threadvars.h"
29	#include "decode.h"
30
31	/* thread flags */
32	#define TM_FLAG_RECEIVE_TM 0x01	22✔
33	#define TM_FLAG_DECODE_TM 0x02	796,735✔
34	#define TM_FLAG_FLOWWORKER_TM 0x04	35,439✔
35	#define TM_FLAG_VERDICT_TM 0x08	6✔
36	#define TM_FLAG_MANAGEMENT_TM 0x10	4✔
37	#define TM_FLAG_COMMAND_TM 0x20	2✔
38
39	/* all packet modules combined */
40	#define TM_FLAG_PACKET_ALL \
UNCOV 41	(TM_FLAG_RECEIVE_TM \| TM_FLAG_DECODE_TM \| TM_FLAG_FLOWWORKER_TM \| TM_FLAG_VERDICT_TM)	×
42
43	typedef TmEcode (ThreadInitFunc)(ThreadVars , const void , void *);
44	typedef TmEcode (ThreadDeinitFunc)(ThreadVars , void *);
45	typedef void (ThreadExitPrintStatsFunc)(ThreadVars , void *);
46
47	typedef struct TmModule_ {
48	const char *name;
49
50	/** thread handling */
51	TmEcode (ThreadInit)(ThreadVars , const void , void *);
52	void (ThreadExitPrintStats)(ThreadVars , void *);
53	TmEcode (ThreadDeinit)(ThreadVars , void *);
54
55	/** the packet processing function */
56	TmEcode (Func)(ThreadVars , Packet , void );
57
58	TmEcode (PktAcqLoop)(ThreadVars , void , void );
59
60	/** terminates the capture loop in PktAcqLoop */
61	TmEcode (PktAcqBreakLoop)(ThreadVars , void *);
62
63	/** does a thread still have tasks to complete before it can be killed?
64	* \retval bool
65	* \param tv threadvars
66	* \param thread_data thread module thread data (e.g. FlowWorkerThreadData for FlowWorker) */
67	bool (ThreadBusy)(ThreadVars tv, void *thread_data);
68
69	TmEcode (Management)(ThreadVars , void *);
70
71	/** global Init/DeInit */
72	TmEcode (*Init)(void);
73	TmEcode (*DeInit)(void);
74	#ifdef UNITTESTS
75	void (*RegisterTests)(void);
76	#endif
77	uint8_t cap_flags; /**< Flags to indicate the capability requirement of
78	the given TmModule */
79	/* Other flags used by the module */
80	uint8_t flags;
81	} TmModule;
82
83	extern TmModule tmm_modules[TMM_SIZE];
84
85	/**
86	* Structure that output modules use to maintain private data.
87	*/
88	typedef struct OutputCtx_ {
89
90	/** Pointer to data private to the output. */
91	void *data;
92
93	/** Pointer to a cleanup function. */
94	void (DeInit)(struct OutputCtx_ );
95
96	TAILQ_HEAD(, OutputModule_) submodules;
97	} OutputCtx;
98
99	TmModule TmModuleGetByName(const char name);
100	TmModule *TmModuleGetById(int id);
101	int TmModuleGetIDForTM(TmModule *tm);
102	TmEcode TmModuleRegister(char name, int (module_func)(ThreadVars , Packet , void *));
103	void TmModuleDebugList(void);
104	void TmModuleRegisterTests(void);
105	#ifdef PROFILING
106	const char * TmModuleTmmIdToString(TmmId id);
107	#endif
108	void TmModuleRunInit(void);
109	void TmModuleRunDeInit(void);
110
111	#endif /* SURICATA_TM_MODULES_H */

OISF / suricata / 23374838686

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

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